reader.go

   1 package torrent
   2
   3 import (
   4         "context"
   5         "errors"
   6         "fmt"
   7         "io"
   8         "sync"
   9
  10         "github.com/anacrolix/log"
  11         "github.com/anacrolix/missinggo/v2"
  12 )
  13
  14 // Accesses Torrent data via a Client. Reads block until the data is available. Seeks and readahead
  15 // also drive Client behaviour.
  16 type Reader interface {
  17         io.ReadSeekCloser
  18         missinggo.ReadContexter
  19         // Configure the number of bytes ahead of a read that should also be prioritized in preparation
  20         // for further reads.
  21         SetReadahead(int64)
  22         // Don't wait for pieces to complete and be verified. Read calls return as soon as they can when
  23         // the underlying chunks become available.
  24         SetResponsive()
  25 }
  26
  27 // Piece range by piece index, [begin, end).
  28 type pieceRange struct {
  29         begin, end pieceIndex
  30 }
  31
  32 type reader struct {
  33         t          *Torrent
  34         responsive bool
  35         // Adjust the read/seek window to handle Readers locked to File extents and the like.
  36         offset, length int64
  37
  38         // Required when modifying pos and readahead, or reading them without opMu.
  39         mu  sync.Locker
  40         pos int64
  41         // Reads have been initiated since the last seek. This is used to prevent readahead occuring
  42         // after a seek or with a new reader at the starting position.
  43         reading   bool
  44         readahead int64
  45         // Function to dynamically calculate readahead. If nil, readahead is static.
  46         readaheadFunc func() int64
  47         // Position that reads have continued contiguously from.
  48         contiguousReadStartPos int64
  49         // The cached piece range this reader wants downloaded. The zero value corresponds to nothing.
  50         // We cache this so that changes can be detected, and bubbled up to the Torrent only as
  51         // required.
  52         pieces pieceRange
  53 }
  54
  55 var _ io.ReadSeekCloser = (*reader)(nil)
  56
  57 func (r *reader) SetResponsive() {
  58         r.responsive = true
  59         r.t.cl.event.Broadcast()
  60 }
  61
  62 // Disable responsive mode. TODO: Remove?
  63 func (r *reader) SetNonResponsive() {
  64         r.responsive = false
  65         r.t.cl.event.Broadcast()
  66 }
  67
  68 func (r *reader) SetReadahead(readahead int64) {
  69         r.mu.Lock()
  70         defer r.mu.Unlock()
  71         r.readahead = readahead
  72         r.readaheadFunc = nil
  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 // Calculates the pieces this reader wants downloaded, ignoring the cached value at r.pieces.
 103 func (r *reader) piecesUncached() (ret pieceRange) {
 104         ra := r.readahead
 105         if r.readaheadFunc != nil {
 106                 ra = r.readaheadFunc()
 107         }
 108         if ra < 1 {
 109                 // Needs to be at least 1, because [x, x) means we don't want
 110                 // anything.
 111                 ra = 1
 112         }
 113         if !r.reading {
 114                 ra = 0
 115         }
 116         if ra > r.length-r.pos {
 117                 ra = r.length - r.pos
 118         }
 119         ret.begin, ret.end = r.t.byteRegionPieces(r.torrentOffset(r.pos), ra)
 120         return
 121 }
 122
 123 func (r *reader) Read(b []byte) (n int, err error) {
 124         return r.ReadContext(context.Background(), b)
 125 }
 126
 127 func (r *reader) ReadContext(ctx context.Context, b []byte) (n int, err error) {
 128         if len(b) > 0 {
 129                 r.reading = true
 130                 // TODO: Rework reader piece priorities so we don't have to push updates in to the Client
 131                 // and take the lock here.
 132                 r.mu.Lock()
 133                 r.posChanged()
 134                 r.mu.Unlock()
 135         }
 136         n, err = r.readOnceAt(ctx, b, r.pos)
 137         if n == 0 {
 138                 if err == nil && len(b) > 0 {
 139                         panic("expected error")
 140                 } else {
 141                         return
 142                 }
 143         }
 144
 145         r.mu.Lock()
 146         r.pos += int64(n)
 147         r.posChanged()
 148         r.mu.Unlock()
 149         if r.pos >= r.length {
 150                 err = io.EOF
 151         } else if err == io.EOF {
 152                 err = io.ErrUnexpectedEOF
 153         }
 154         return
 155 }
 156
 157 var closedChan = make(chan struct{})
 158
 159 func init() {
 160         close(closedChan)
 161 }
 162
 163 // Wait until some data should be available to read. Tickles the client if it isn't. Returns how
 164 // much should be readable without blocking.
 165 func (r *reader) waitAvailable(ctx context.Context, pos, wanted int64, wait bool) (avail int64, err error) {
 166         t := r.t
 167         for {
 168                 r.t.cl.rLock()
 169                 avail = r.available(pos, wanted)
 170                 readerCond := t.piece(int((r.offset + pos) / t.info.PieceLength)).readerCond.Signaled()
 171                 r.t.cl.rUnlock()
 172                 if avail != 0 {
 173                         return
 174                 }
 175                 var dontWait <-chan struct{}
 176                 if !wait || wanted == 0 {
 177                         dontWait = closedChan
 178                 }
 179                 select {
 180                 case <-r.t.closed.Done():
 181                         err = errors.New("torrent closed")
 182                         return
 183                 case <-ctx.Done():
 184                         err = ctx.Err()
 185                         return
 186                 case <-r.t.dataDownloadDisallowed.On():
 187                         err = errors.New("torrent data downloading disabled")
 188                 case <-r.t.networkingEnabled.Off():
 189                         err = errors.New("torrent networking disabled")
 190                         return
 191                 case <-dontWait:
 192                         return
 193                 case <-readerCond:
 194                 }
 195         }
 196 }
 197
 198 // Adds the reader's torrent offset to the reader object offset (for example the reader might be
 199 // constrainted to a particular file within the torrent).
 200 func (r *reader) torrentOffset(readerPos int64) int64 {
 201         return r.offset + readerPos
 202 }
 203
 204 // Performs at most one successful read to torrent storage.
 205 func (r *reader) readOnceAt(ctx context.Context, b []byte, pos int64) (n int, err error) {
 206         if pos >= r.length {
 207                 err = io.EOF
 208                 return
 209         }
 210         for {
 211                 var avail int64
 212                 avail, err = r.waitAvailable(ctx, pos, int64(len(b)), n == 0)
 213                 if avail == 0 {
 214                         return
 215                 }
 216                 firstPieceIndex := pieceIndex(r.torrentOffset(pos) / r.t.info.PieceLength)
 217                 firstPieceOffset := r.torrentOffset(pos) % r.t.info.PieceLength
 218                 b1 := missinggo.LimitLen(b, avail)
 219                 n, err = r.t.readAt(b1, r.torrentOffset(pos))
 220                 if n != 0 {
 221                         err = nil
 222                         return
 223                 }
 224                 r.t.cl.lock()
 225                 // TODO: Just reset pieces in the readahead window. This might help
 226                 // prevent thrashing with small caches and file and piece priorities.
 227                 r.log(log.Fstr("error reading torrent %s piece %d offset %d, %d bytes: %v",
 228                         r.t.infoHash.HexString(), firstPieceIndex, firstPieceOffset, len(b1), err))
 229                 if !r.t.updatePieceCompletion(firstPieceIndex) {
 230                         r.log(log.Fstr("piece %d completion unchanged", firstPieceIndex))
 231                 }
 232                 // Update the rest of the piece completions in the readahead window, without alerting to
 233                 // changes (since only the first piece, the one above, could have generated the read error
 234                 // we're currently handling).
 235                 if r.pieces.begin != firstPieceIndex {
 236                         panic(fmt.Sprint(r.pieces.begin, firstPieceIndex))
 237                 }
 238                 for index := r.pieces.begin + 1; index < r.pieces.end; index++ {
 239                         r.t.updatePieceCompletion(index)
 240                 }
 241                 r.t.cl.unlock()
 242         }
 243 }
 244
 245 // Hodor
 246 func (r *reader) Close() error {
 247         r.t.cl.lock()
 248         defer r.t.cl.unlock()
 249         r.t.deleteReader(r)
 250         return nil
 251 }
 252
 253 func (r *reader) posChanged() {
 254         to := r.piecesUncached()
 255         from := r.pieces
 256         if to == from {
 257                 return
 258         }
 259         r.pieces = to
 260         // log.Printf("reader pos changed %v->%v", from, to)
 261         r.t.readerPosChanged(from, to)
 262 }
 263
 264 func (r *reader) Seek(off int64, whence int) (newPos int64, err error) {
 265         r.mu.Lock()
 266         defer r.mu.Unlock()
 267         newPos, err = func() (int64, error) {
 268                 switch whence {
 269                 case io.SeekStart:
 270                         return off, err
 271                 case io.SeekCurrent:
 272                         return r.pos + off, nil
 273                 case io.SeekEnd:
 274                         return r.length + off, nil
 275                 default:
 276                         return r.pos, errors.New("bad whence")
 277                 }
 278         }()
 279         if err != nil {
 280                 return
 281         }
 282         if newPos == r.pos {
 283                 return
 284         }
 285         r.reading = false
 286         r.pos = newPos
 287         r.contiguousReadStartPos = newPos
 288
 289         r.posChanged()
 290         return
 291 }
 292
 293 func (r *reader) log(m log.Msg) {
 294         r.t.logger.Log(m.Skip(1))
 295 }
 296
 297 // Implementation inspired by https://news.ycombinator.com/item?id=27019613.
 298 func (r *reader) defaultReadaheadFunc() int64 {
 299         return r.pos - r.contiguousReadStartPos
 300 }