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