reader.go

   1 package torrent
   2
   3 import (
   4         "errors"
   5         "io"
   6         "log"
   7         "sync"
   8
   9         "github.com/anacrolix/missinggo"
  10         "golang.org/x/net/context"
  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 int
  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         // Ensure operations that change the position are exclusive, like Read()
  33         // and Seek().
  34         opMu sync.Mutex
  35
  36         // Required when modifying pos and readahead, or reading them without
  37         // opMu.
  38         mu        sync.Locker
  39         pos       int64
  40         readahead int64
  41         // The cached piece range this reader wants downloaded. The zero value
  42         // corresponds to nothing. We cache this so that changes can be detected,
  43         // and bubbled up to the Torrent only as required.
  44         pieces pieceRange
  45 }
  46
  47 var _ io.ReadCloser = &reader{}
  48
  49 // Don't wait for pieces to complete and be verified. Read calls return as
  50 // soon as they can when the underlying chunks become available.
  51 func (r *reader) SetResponsive() {
  52         r.responsive = true
  53         r.t.cl.event.Broadcast()
  54 }
  55
  56 // Disable responsive mode. TODO: Remove?
  57 func (r *reader) SetNonResponsive() {
  58         r.responsive = false
  59         r.t.cl.event.Broadcast()
  60 }
  61
  62 // Configure the number of bytes ahead of a read that should also be
  63 // prioritized in preparation for further reads.
  64 func (r *reader) SetReadahead(readahead int64) {
  65         r.mu.Lock()
  66         r.readahead = readahead
  67         r.mu.Unlock()
  68         r.t.cl.mu.Lock()
  69         defer r.t.cl.mu.Unlock()
  70         r.posChanged()
  71 }
  72
  73 func (r *reader) readable(off int64) (ret bool) {
  74         if r.t.closed.IsSet() {
  75                 return true
  76         }
  77         req, ok := r.t.offsetRequest(off)
  78         if !ok {
  79                 panic(off)
  80         }
  81         if r.responsive {
  82                 return r.t.haveChunk(req)
  83         }
  84         return r.t.pieceComplete(int(req.Index))
  85 }
  86
  87 // How many bytes are available to read. Max is the most we could require.
  88 func (r *reader) available(off, max int64) (ret int64) {
  89         for max > 0 {
  90                 req, ok := r.t.offsetRequest(off)
  91                 if !ok {
  92                         break
  93                 }
  94                 if !r.t.haveChunk(req) {
  95                         break
  96                 }
  97                 len1 := int64(req.Length) - (off - r.t.requestOffset(req))
  98                 max -= len1
  99                 ret += len1
 100                 off += len1
 101         }
 102         // Ensure that ret hasn't exceeded our original max.
 103         if max < 0 {
 104                 ret += max
 105         }
 106         return
 107 }
 108
 109 func (r *reader) waitReadable(off int64) {
 110         // We may have been sent back here because we were told we could read but
 111         // it failed.
 112         r.t.cl.event.Wait()
 113 }
 114
 115 // Calculates the pieces this reader wants downloaded, ignoring the cached
 116 // value at r.pieces.
 117 func (r *reader) piecesUncached() (ret pieceRange) {
 118         ra := r.readahead
 119         if ra < 1 {
 120                 ra = 1
 121         }
 122         ret.begin, ret.end = r.t.byteRegionPieces(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         // This is set under the Client lock if the Context is canceled.
 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.mu.Lock()
 140                         ctxErr = ctx.Err()
 141                         r.t.cl.event.Broadcast()
 142                         r.t.cl.mu.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         for len(b) != 0 {
 150                 var n1 int
 151                 n1, err = r.readOnceAt(b, r.pos, &ctxErr)
 152                 if n1 == 0 {
 153                         if err == nil {
 154                                 panic("expected error")
 155                         }
 156                         break
 157                 }
 158                 b = b[n1:]
 159                 n += n1
 160                 r.mu.Lock()
 161                 r.pos += int64(n1)
 162                 r.posChanged()
 163                 r.mu.Unlock()
 164         }
 165         if r.pos >= r.t.length {
 166                 err = io.EOF
 167         } else if err == io.EOF {
 168                 err = io.ErrUnexpectedEOF
 169         }
 170         return
 171 }
 172
 173 // Wait until some data should be available to read. Tickles the client if it
 174 // isn't. Returns how much should be readable without blocking.
 175 func (r *reader) waitAvailable(pos, wanted int64, ctxErr *error) (avail int64) {
 176         r.t.cl.mu.Lock()
 177         defer r.t.cl.mu.Unlock()
 178         for !r.readable(pos) && *ctxErr == nil {
 179                 r.waitReadable(pos)
 180         }
 181         return r.available(pos, wanted)
 182 }
 183
 184 // Performs at most one successful read to torrent storage.
 185 func (r *reader) readOnceAt(b []byte, pos int64, ctxErr *error) (n int, err error) {
 186         if pos >= r.t.length {
 187                 err = io.EOF
 188                 return
 189         }
 190         for {
 191                 avail := r.waitAvailable(pos, int64(len(b)), ctxErr)
 192                 if avail == 0 {
 193                         if r.t.closed.IsSet() {
 194                                 err = errors.New("torrent closed")
 195                                 return
 196                         }
 197                         if *ctxErr != nil {
 198                                 err = *ctxErr
 199                                 return
 200                         }
 201                 }
 202                 pi := int(pos / r.t.info.PieceLength)
 203                 ip := r.t.info.Piece(pi)
 204                 po := pos % r.t.info.PieceLength
 205                 b1 := missinggo.LimitLen(b, ip.Length()-po, avail)
 206                 n, err = r.t.readAt(b1, pos)
 207                 if n != 0 {
 208                         err = nil
 209                         return
 210                 }
 211                 r.t.cl.mu.Lock()
 212                 log.Printf("error reading torrent %q piece %d offset %d, %d bytes: %s", r.t, pi, po, len(b1), err)
 213                 r.t.updateAllPieceCompletions()
 214                 r.t.updateAllPiecePriorities()
 215                 r.t.cl.mu.Unlock()
 216         }
 217 }
 218
 219 func (r *reader) Close() error {
 220         r.t.cl.mu.Lock()
 221         defer r.t.cl.mu.Unlock()
 222         r.t.deleteReader(r)
 223         return nil
 224 }
 225
 226 func (r *reader) posChanged() {
 227         to := r.piecesUncached()
 228         from := r.pieces
 229         if to == from {
 230                 return
 231         }
 232         r.pieces = to
 233         r.t.readerPosChanged(from, to)
 234 }
 235
 236 func (r *reader) Seek(off int64, whence int) (ret int64, err error) {
 237         r.opMu.Lock()
 238         defer r.opMu.Unlock()
 239
 240         r.mu.Lock()
 241         defer r.mu.Unlock()
 242         switch whence {
 243         case io.SeekStart:
 244                 r.pos = off
 245         case io.SeekCurrent:
 246                 r.pos += off
 247         case io.SeekEnd:
 248                 r.pos = r.t.info.TotalLength() + off
 249         default:
 250                 err = errors.New("bad whence")
 251         }
 252         ret = r.pos
 253
 254         r.posChanged()
 255         return
 256 }