reader.go

   1 package torrent
   2
   3 import (
   4         "context"
   5         "errors"
   6         "io"
   7         "sync"
   8
   9         "github.com/anacrolix/log"
  10         "github.com/anacrolix/missinggo"
  11 )
  12
  13 type Reader interface {
  14         io.Reader
  15         io.Seeker
  16         io.Closer
  17         missinggo.ReadContexter
  18         SetReadahead(int64)
  19         SetResponsive()
  20 }
  21
  22 // Piece range by piece index, [begin, end).
  23 type pieceRange struct {
  24         begin, end pieceIndex
  25 }
  26
  27 // Accesses Torrent data via a Client. Reads block until the data is
  28 // available. Seeks and readahead also drive Client behaviour.
  29 type reader struct {
  30         t          *Torrent
  31         responsive bool
  32         // Adjust the read/seek window to handle Readers locked to File extents
  33         // and the like.
  34         offset, length int64
  35         // Ensure operations that change the position are exclusive, like Read()
  36         // and Seek().
  37         opMu sync.Mutex
  38
  39         // Required when modifying pos and readahead, or reading them without
  40         // opMu.
  41         mu        sync.Locker
  42         pos       int64
  43         readahead int64
  44         // The cached piece range this reader wants downloaded. The zero value
  45         // corresponds to nothing. We cache this so that changes can be detected,
  46         // and bubbled up to the Torrent only as required.
  47         pieces pieceRange
  48 }
  49
  50 var _ io.ReadCloser = &reader{}
  51
  52 // Don't wait for pieces to complete and be verified. Read calls return as
  53 // soon as they can when the underlying chunks become available.
  54 func (r *reader) SetResponsive() {
  55         r.responsive = true
  56         r.t.cl.event.Broadcast()
  57 }
  58
  59 // Disable responsive mode. TODO: Remove?
  60 func (r *reader) SetNonResponsive() {
  61         r.responsive = false
  62         r.t.cl.event.Broadcast()
  63 }
  64
  65 // Configure the number of bytes ahead of a read that should also be
  66 // prioritized in preparation for further reads.
  67 func (r *reader) SetReadahead(readahead int64) {
  68         r.mu.Lock()
  69         r.readahead = readahead
  70         r.mu.Unlock()
  71         r.t.cl.lock()
  72         defer r.t.cl.unlock()
  73         r.posChanged()
  74 }
  75
  76 // How many bytes are available to read. Max is the most we could require.
  77 func (r *reader) available(off, max int64) (ret int64) {
  78         off += r.offset
  79         for max > 0 {
  80                 req, ok := r.t.offsetRequest(off)
  81                 if !ok {
  82                         break
  83                 }
  84                 if !r.responsive && !r.t.pieceComplete(pieceIndex(req.Index)) {
  85                         break
  86                 }
  87                 if !r.t.haveChunk(req) {
  88                         break
  89                 }
  90                 len1 := int64(req.Length) - (off - r.t.requestOffset(req))
  91                 max -= len1
  92                 ret += len1
  93                 off += len1
  94         }
  95         // Ensure that ret hasn't exceeded our original max.
  96         if max < 0 {
  97                 ret += max
  98         }
  99         return
 100 }
 101
 102 func (r *reader) waitReadable(off int64) {
 103         // We may have been sent back here because we were told we could read but
 104         // it failed.
 105         r.t.cl.event.Wait()
 106 }
 107
 108 // Calculates the pieces this reader wants downloaded, ignoring the cached
 109 // value at r.pieces.
 110 func (r *reader) piecesUncached() (ret pieceRange) {
 111         ra := r.readahead
 112         if ra < 1 {
 113                 // Needs to be at least 1, because [x, x) means we don't want
 114                 // anything.
 115                 ra = 1
 116         }
 117         if ra > r.length-r.pos {
 118                 ra = r.length - r.pos
 119         }
 120         ret.begin, ret.end = r.t.byteRegionPieces(r.torrentOffset(r.pos), ra)
 121         return
 122 }
 123
 124 func (r *reader) Read(b []byte) (n int, err error) {
 125         return r.ReadContext(context.Background(), b)
 126 }
 127
 128 func (r *reader) ReadContext(ctx context.Context, b []byte) (n int, err error) {
 129         // This is set under the Client lock if the Context is canceled. I think we coordinate on a
 130         // separate variable so as to avoid false negatives with race conditions due to Contexts being
 131         // synchronized.
 132         var ctxErr error
 133         if ctx.Done() != nil {
 134                 ctx, cancel := context.WithCancel(ctx)
 135                 // Abort the goroutine when the function returns.
 136                 defer cancel()
 137                 go func() {
 138                         <-ctx.Done()
 139                         r.t.cl.lock()
 140                         ctxErr = ctx.Err()
 141                         r.t.tickleReaders()
 142                         r.t.cl.unlock()
 143                 }()
 144         }
 145         // Hmmm, if a Read gets stuck, this means you can't change position for
 146         // other purposes. That seems reasonable, but unusual.
 147         r.opMu.Lock()
 148         defer r.opMu.Unlock()
 149         n, err = r.readOnceAt(b, r.pos, &ctxErr)
 150         if n == 0 {
 151                 if err == nil {
 152                         panic("expected error")
 153                 } else {
 154                         return
 155                 }
 156         }
 157
 158         r.mu.Lock()
 159         r.pos += int64(n)
 160         r.posChanged()
 161         r.mu.Unlock()
 162         if r.pos >= r.length {
 163                 err = io.EOF
 164         } else if err == io.EOF {
 165                 err = io.ErrUnexpectedEOF
 166         }
 167         return
 168 }
 169
 170 // Wait until some data should be available to read. Tickles the client if it
 171 // isn't. Returns how much should be readable without blocking.
 172 func (r *reader) waitAvailable(pos, wanted int64, ctxErr *error, wait bool) (avail int64, err error) {
 173         r.t.cl.lock()
 174         defer r.t.cl.unlock()
 175         for {
 176                 avail = r.available(pos, wanted)
 177                 if avail != 0 {
 178                         return
 179                 }
 180                 if r.t.closed.IsSet() {
 181                         err = errors.New("torrent closed")
 182                         return
 183                 }
 184                 if *ctxErr != nil {
 185                         err = *ctxErr
 186                         return
 187                 }
 188                 if r.t.dataDownloadDisallowed || !r.t.networkingEnabled {
 189                         err = errors.New("downloading disabled and data not already available")
 190                         return
 191                 }
 192                 if !wait {
 193                         return
 194                 }
 195                 r.waitReadable(pos)
 196         }
 197 }
 198
 199 // Adds the reader's torrent offset to the reader object offset (for example the reader might be
 200 // constrainted to a particular file within the torrent).
 201 func (r *reader) torrentOffset(readerPos int64) int64 {
 202         return r.offset + readerPos
 203 }
 204
 205 // Performs at most one successful read to torrent storage.
 206 func (r *reader) readOnceAt(b []byte, pos int64, ctxErr *error) (n int, err error) {
 207         if pos >= r.length {
 208                 err = io.EOF
 209                 return
 210         }
 211         for {
 212                 var avail int64
 213                 avail, err = r.waitAvailable(pos, int64(len(b)), ctxErr, n == 0)
 214                 if avail == 0 {
 215                         return
 216                 }
 217                 firstPieceIndex := pieceIndex(r.torrentOffset(pos) / r.t.info.PieceLength)
 218                 firstPieceOffset := r.torrentOffset(pos) % r.t.info.PieceLength
 219                 b1 := missinggo.LimitLen(b, avail)
 220                 n, err = r.t.readAt(b1, r.torrentOffset(pos))
 221                 if n != 0 {
 222                         err = nil
 223                         return
 224                 }
 225                 r.t.cl.lock()
 226                 // TODO: Just reset pieces in the readahead window. This might help
 227                 // prevent thrashing with small caches and file and piece priorities.
 228                 r.log(log.Fstr("error reading torrent %s piece %d offset %d, %d bytes: %v",
 229                         r.t.infoHash.HexString(), firstPieceIndex, firstPieceOffset, len(b1), err))
 230                 if !r.t.updatePieceCompletion(firstPieceIndex) {
 231                         r.log(log.Fstr("piece %d completion unchanged", firstPieceIndex))
 232                 }
 233                 r.t.cl.unlock()
 234         }
 235 }
 236
 237 func (r *reader) Close() error {
 238         r.t.cl.lock()
 239         defer r.t.cl.unlock()
 240         r.t.deleteReader(r)
 241         return nil
 242 }
 243
 244 func (r *reader) posChanged() {
 245         to := r.piecesUncached()
 246         from := r.pieces
 247         if to == from {
 248                 return
 249         }
 250         r.pieces = to
 251         // log.Printf("reader pos changed %v->%v", from, to)
 252         r.t.readerPosChanged(from, to)
 253 }
 254
 255 func (r *reader) Seek(off int64, whence int) (ret int64, err error) {
 256         r.opMu.Lock()
 257         defer r.opMu.Unlock()
 258
 259         r.mu.Lock()
 260         defer r.mu.Unlock()
 261         switch whence {
 262         case io.SeekStart:
 263                 r.pos = off
 264         case io.SeekCurrent:
 265                 r.pos += off
 266         case io.SeekEnd:
 267                 r.pos = r.length + off
 268         default:
 269                 err = errors.New("bad whence")
 270         }
 271         ret = r.pos
 272
 273         r.posChanged()
 274         return
 275 }
 276
 277 func (r *reader) log(m log.Msg) {
 278         r.t.logger.Log(m.Skip(1))
 279 }