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 func (r *reader) readable(off int64) (ret bool) {
  77         if r.t.closed.IsSet() {
  78                 return true
  79         }
  80         req, ok := r.t.offsetRequest(r.torrentOffset(off))
  81         if !ok {
  82                 panic(off)
  83         }
  84         if r.responsive {
  85                 return r.t.haveChunk(req)
  86         }
  87         return r.t.pieceComplete(pieceIndex(req.Index))
  88 }
  89
  90 // How many bytes are available to read. Max is the most we could require.
  91 func (r *reader) available(off, max int64) (ret int64) {
  92         off += r.offset
  93         for max > 0 {
  94                 req, ok := r.t.offsetRequest(off)
  95                 if !ok {
  96                         break
  97                 }
  98                 if !r.responsive && !r.t.pieceComplete(pieceIndex(req.Index)) {
  99                         break
 100                 }
 101                 if !r.t.haveChunk(req) {
 102                         break
 103                 }
 104                 len1 := int64(req.Length) - (off - r.t.requestOffset(req))
 105                 max -= len1
 106                 ret += len1
 107                 off += len1
 108         }
 109         // Ensure that ret hasn't exceeded our original max.
 110         if max < 0 {
 111                 ret += max
 112         }
 113         return
 114 }
 115
 116 func (r *reader) waitReadable(off int64) {
 117         // We may have been sent back here because we were told we could read but
 118         // it failed.
 119         r.t.cl.event.Wait()
 120 }
 121
 122 // Calculates the pieces this reader wants downloaded, ignoring the cached
 123 // value at r.pieces.
 124 func (r *reader) piecesUncached() (ret pieceRange) {
 125         ra := r.readahead
 126         if ra < 1 {
 127                 // Needs to be at least 1, because [x, x) means we don't want
 128                 // anything.
 129                 ra = 1
 130         }
 131         if ra > r.length-r.pos {
 132                 ra = r.length - r.pos
 133         }
 134         ret.begin, ret.end = r.t.byteRegionPieces(r.torrentOffset(r.pos), ra)
 135         return
 136 }
 137
 138 func (r *reader) Read(b []byte) (n int, err error) {
 139         return r.ReadContext(context.Background(), b)
 140 }
 141
 142 func (r *reader) ReadContext(ctx context.Context, b []byte) (n int, err error) {
 143         // This is set under the Client lock if the Context is canceled. I think we coordinate on a
 144         // separate variable so as to avoid false negatives with race conditions due to Contexts being
 145         // synchronized.
 146         var ctxErr error
 147         if ctx.Done() != nil {
 148                 ctx, cancel := context.WithCancel(ctx)
 149                 // Abort the goroutine when the function returns.
 150                 defer cancel()
 151                 go func() {
 152                         <-ctx.Done()
 153                         r.t.cl.lock()
 154                         ctxErr = ctx.Err()
 155                         r.t.tickleReaders()
 156                         r.t.cl.unlock()
 157                 }()
 158         }
 159         // Hmmm, if a Read gets stuck, this means you can't change position for
 160         // other purposes. That seems reasonable, but unusual.
 161         r.opMu.Lock()
 162         defer r.opMu.Unlock()
 163         n, err = r.readOnceAt(b, r.pos, &ctxErr)
 164         if n == 0 {
 165                 if err == nil {
 166                         panic("expected error")
 167                 } else {
 168                         return
 169                 }
 170         }
 171
 172         r.mu.Lock()
 173         r.pos += int64(n)
 174         r.posChanged()
 175         r.mu.Unlock()
 176         if r.pos >= r.length {
 177                 err = io.EOF
 178         } else if err == io.EOF {
 179                 err = io.ErrUnexpectedEOF
 180         }
 181         return
 182 }
 183
 184 // Wait until some data should be available to read. Tickles the client if it
 185 // isn't. Returns how much should be readable without blocking.
 186 func (r *reader) waitAvailable(pos, wanted int64, ctxErr *error, wait bool) (avail int64, err error) {
 187         r.t.cl.lock()
 188         defer r.t.cl.unlock()
 189         for {
 190                 avail = r.available(pos, wanted)
 191                 if avail != 0 {
 192                         return
 193                 }
 194                 if r.t.closed.IsSet() {
 195                         err = errors.New("torrent closed")
 196                         return
 197                 }
 198                 if *ctxErr != nil {
 199                         err = *ctxErr
 200                         return
 201                 }
 202                 if !wait {
 203                         return
 204                 }
 205                 r.waitReadable(pos)
 206         }
 207 }
 208
 209 // Adds the reader's torrent offset to the reader object offset (for example the reader might be
 210 // constrainted to a particular file within the torrent).
 211 func (r *reader) torrentOffset(readerPos int64) int64 {
 212         return r.offset + readerPos
 213 }
 214
 215 // Performs at most one successful read to torrent storage.
 216 func (r *reader) readOnceAt(b []byte, pos int64, ctxErr *error) (n int, err error) {
 217         if pos >= r.length {
 218                 err = io.EOF
 219                 return
 220         }
 221         for {
 222                 var avail int64
 223                 avail, err = r.waitAvailable(pos, int64(len(b)), ctxErr, n == 0)
 224                 if avail == 0 {
 225                         return
 226                 }
 227                 firstPieceIndex := pieceIndex(r.torrentOffset(pos) / r.t.info.PieceLength)
 228                 firstPieceOffset := r.torrentOffset(pos) % r.t.info.PieceLength
 229                 b1 := missinggo.LimitLen(b, avail)
 230                 n, err = r.t.readAt(b1, r.torrentOffset(pos))
 231                 if n != 0 {
 232                         err = nil
 233                         return
 234                 }
 235                 r.t.cl.lock()
 236                 // TODO: Just reset pieces in the readahead window. This might help
 237                 // prevent thrashing with small caches and file and piece priorities.
 238                 r.log(log.Fstr("error reading torrent %s piece %d offset %d, %d bytes: %v",
 239                         r.t.infoHash.HexString(), firstPieceIndex, firstPieceOffset, len(b1), err))
 240                 if !r.t.updatePieceCompletion(firstPieceIndex) {
 241                         r.log(log.Fstr("piece %d completion unchanged", firstPieceIndex))
 242                 }
 243                 r.t.cl.unlock()
 244         }
 245 }
 246
 247 func (r *reader) Close() error {
 248         r.t.cl.lock()
 249         defer r.t.cl.unlock()
 250         r.t.deleteReader(r)
 251         return nil
 252 }
 253
 254 func (r *reader) posChanged() {
 255         to := r.piecesUncached()
 256         from := r.pieces
 257         if to == from {
 258                 return
 259         }
 260         r.pieces = to
 261         // log.Printf("reader pos changed %v->%v", from, to)
 262         r.t.readerPosChanged(from, to)
 263 }
 264
 265 func (r *reader) Seek(off int64, whence int) (ret int64, err error) {
 266         r.opMu.Lock()
 267         defer r.opMu.Unlock()
 268
 269         r.mu.Lock()
 270         defer r.mu.Unlock()
 271         switch whence {
 272         case io.SeekStart:
 273                 r.pos = off
 274         case io.SeekCurrent:
 275                 r.pos += off
 276         case io.SeekEnd:
 277                 r.pos = r.length + off
 278         default:
 279                 err = errors.New("bad whence")
 280         }
 281         ret = r.pos
 282
 283         r.posChanged()
 284         return
 285 }
 286
 287 func (r *reader) log(m log.Msg) {
 288         r.t.logger.Log(m.Skip(1))
 289 }