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.
 144         var ctxErr error
 145         if ctx.Done() != nil {
 146                 ctx, cancel := context.WithCancel(ctx)
 147                 // Abort the goroutine when the function returns.
 148                 defer cancel()
 149                 go func() {
 150                         <-ctx.Done()
 151                         r.t.cl.lock()
 152                         ctxErr = ctx.Err()
 153                         r.t.tickleReaders()
 154                         r.t.cl.unlock()
 155                 }()
 156         }
 157         // Hmmm, if a Read gets stuck, this means you can't change position for
 158         // other purposes. That seems reasonable, but unusual.
 159         r.opMu.Lock()
 160         defer r.opMu.Unlock()
 161         for len(b) != 0 {
 162                 var n1 int
 163                 n1, err = r.readOnceAt(b, r.pos, &ctxErr)
 164                 if n1 == 0 {
 165                         if err == nil {
 166                                 panic("expected error")
 167                         }
 168                         break
 169                 }
 170                 b = b[n1:]
 171                 n += n1
 172                 r.mu.Lock()
 173                 r.pos += int64(n1)
 174                 r.posChanged()
 175                 r.mu.Unlock()
 176         }
 177         if r.pos >= r.length {
 178                 err = io.EOF
 179         } else if err == io.EOF {
 180                 err = io.ErrUnexpectedEOF
 181         }
 182         return
 183 }
 184
 185 // Wait until some data should be available to read. Tickles the client if it
 186 // isn't. Returns how much should be readable without blocking.
 187 func (r *reader) waitAvailable(pos, wanted int64, ctxErr *error) (avail int64, err error) {
 188         r.t.cl.lock()
 189         defer r.t.cl.unlock()
 190         for {
 191                 avail = r.available(pos, wanted)
 192                 if avail != 0 {
 193                         return
 194                 }
 195                 if r.t.closed.IsSet() {
 196                         err = errors.New("torrent closed")
 197                         return
 198                 }
 199                 if *ctxErr != nil {
 200                         err = *ctxErr
 201                         return
 202                 }
 203                 r.waitReadable(pos)
 204         }
 205 }
 206
 207 // Adds the reader's torrent offset to the reader object offset (for example the reader might be
 208 // constrainted to a particular file within the torrent).
 209 func (r *reader) torrentOffset(readerPos int64) int64 {
 210         return r.offset + readerPos
 211 }
 212
 213 // Performs at most one successful read to torrent storage.
 214 func (r *reader) readOnceAt(b []byte, pos int64, ctxErr *error) (n int, err error) {
 215         if pos >= r.length {
 216                 err = io.EOF
 217                 return
 218         }
 219         for {
 220                 var avail int64
 221                 avail, err = r.waitAvailable(pos, int64(len(b)), ctxErr)
 222                 if avail == 0 {
 223                         return
 224                 }
 225                 firstPieceIndex := pieceIndex(r.torrentOffset(pos) / r.t.info.PieceLength)
 226                 firstPieceOffset := r.torrentOffset(pos) % r.t.info.PieceLength
 227                 b1 := missinggo.LimitLen(b, avail)
 228                 n, err = r.t.readAt(b1, r.torrentOffset(pos))
 229                 if n != 0 {
 230                         err = nil
 231                         return
 232                 }
 233                 r.t.cl.lock()
 234                 // TODO: Just reset pieces in the readahead window. This might help
 235                 // prevent thrashing with small caches and file and piece priorities.
 236                 r.log(log.Fstr("error reading torrent %s piece %d offset %d, %d bytes: %v",
 237                         r.t.infoHash.HexString(), firstPieceIndex, firstPieceOffset, len(b1), err))
 238                 if !r.t.updatePieceCompletion(firstPieceIndex) {
 239                         r.log(log.Fstr("piece %d completion unchanged", firstPieceIndex))
 240                 }
 241                 r.t.cl.unlock()
 242         }
 243 }
 244
 245 func (r *reader) Close() error {
 246         r.t.cl.lock()
 247         defer r.t.cl.unlock()
 248         r.t.deleteReader(r)
 249         return nil
 250 }
 251
 252 func (r *reader) posChanged() {
 253         to := r.piecesUncached()
 254         from := r.pieces
 255         if to == from {
 256                 return
 257         }
 258         r.pieces = to
 259         // log.Printf("reader pos changed %v->%v", from, to)
 260         r.t.readerPosChanged(from, to)
 261 }
 262
 263 func (r *reader) Seek(off int64, whence int) (ret int64, err error) {
 264         r.opMu.Lock()
 265         defer r.opMu.Unlock()
 266
 267         r.mu.Lock()
 268         defer r.mu.Unlock()
 269         switch whence {
 270         case io.SeekStart:
 271                 r.pos = off
 272         case io.SeekCurrent:
 273                 r.pos += off
 274         case io.SeekEnd:
 275                 r.pos = r.length + off
 276         default:
 277                 err = errors.New("bad whence")
 278         }
 279         ret = r.pos
 280
 281         r.posChanged()
 282         return
 283 }
 284
 285 func (r *reader) log(m log.Msg) {
 286         r.t.logger.Log(m.Skip(1))
 287 }