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 }
  54
  55 // Disable responsive mode. TODO: Remove?
  56 func (r *reader) SetNonResponsive() {
  57         r.responsive = false
  58 }
  59
  60 // Configure the number of bytes ahead of a read that should also be
  61 // prioritized in preparation for further reads.
  62 func (r *reader) SetReadahead(readahead int64) {
  63         r.mu.Lock()
  64         r.readahead = readahead
  65         r.mu.Unlock()
  66         r.t.cl.mu.Lock()
  67         defer r.t.cl.mu.Unlock()
  68         r.posChanged()
  69 }
  70
  71 func (r *reader) readable(off int64) (ret bool) {
  72         if r.t.closed.IsSet() {
  73                 return true
  74         }
  75         req, ok := r.t.offsetRequest(off)
  76         if !ok {
  77                 panic(off)
  78         }
  79         if r.responsive {
  80                 return r.t.haveChunk(req)
  81         }
  82         return r.t.pieceComplete(int(req.Index))
  83 }
  84
  85 // How many bytes are available to read. Max is the most we could require.
  86 func (r *reader) available(off, max int64) (ret int64) {
  87         for max > 0 {
  88                 req, ok := r.t.offsetRequest(off)
  89                 if !ok {
  90                         break
  91                 }
  92                 if !r.t.haveChunk(req) {
  93                         break
  94                 }
  95                 len1 := int64(req.Length) - (off - r.t.requestOffset(req))
  96                 max -= len1
  97                 ret += len1
  98                 off += len1
  99         }
 100         // Ensure that ret hasn't exceeded our original max.
 101         if max < 0 {
 102                 ret += max
 103         }
 104         return
 105 }
 106
 107 func (r *reader) waitReadable(off int64) {
 108         // We may have been sent back here because we were told we could read but
 109         // it failed.
 110         r.t.cl.event.Wait()
 111 }
 112
 113 // Calculates the pieces this reader wants downloaded, ignoring the cached
 114 // value at r.pieces.
 115 func (r *reader) piecesUncached() (ret pieceRange) {
 116         ra := r.readahead
 117         if ra < 1 {
 118                 ra = 1
 119         }
 120         ret.begin, ret.end = r.t.byteRegionPieces(r.pos, ra)
 121         return
 122 }
 123
 124 func (r *reader) Read(b []byte) (n int, err error) {
 125         return r.ReadContext(context.Background(), b)
 126 }
 127
 128 func (r *reader) ReadContext(ctx context.Context, b []byte) (n int, err error) {
 129         // This is set under the Client lock if the Context is canceled.
 130         var ctxErr error
 131         if ctx.Done() != nil {
 132                 ctx, cancel := context.WithCancel(ctx)
 133                 // Abort the goroutine when the function returns.
 134                 defer cancel()
 135                 go func() {
 136                         <-ctx.Done()
 137                         r.t.cl.mu.Lock()
 138                         ctxErr = ctx.Err()
 139                         r.t.cl.event.Broadcast()
 140                         r.t.cl.mu.Unlock()
 141                 }()
 142         }
 143         // Hmmm, if a Read gets stuck, this means you can't change position for
 144         // other purposes. That seems reasonable, but unusual.
 145         r.opMu.Lock()
 146         defer r.opMu.Unlock()
 147         for len(b) != 0 {
 148                 var n1 int
 149                 n1, err = r.readOnceAt(b, r.pos, &ctxErr)
 150                 if n1 == 0 {
 151                         if err == nil {
 152                                 panic("expected error")
 153                         }
 154                         break
 155                 }
 156                 b = b[n1:]
 157                 n += n1
 158                 r.mu.Lock()
 159                 r.pos += int64(n1)
 160                 r.posChanged()
 161                 r.mu.Unlock()
 162         }
 163         if r.pos >= r.t.length {
 164                 err = io.EOF
 165         } else if err == io.EOF {
 166                 err = io.ErrUnexpectedEOF
 167         }
 168         return
 169 }
 170
 171 // Wait until some data should be available to read. Tickles the client if it
 172 // isn't. Returns how much should be readable without blocking.
 173 func (r *reader) waitAvailable(pos, wanted int64, ctxErr *error) (avail int64) {
 174         r.t.cl.mu.Lock()
 175         defer r.t.cl.mu.Unlock()
 176         for !r.readable(pos) && *ctxErr == nil {
 177                 r.waitReadable(pos)
 178         }
 179         return r.available(pos, wanted)
 180 }
 181
 182 // Performs at most one successful read to torrent storage.
 183 func (r *reader) readOnceAt(b []byte, pos int64, ctxErr *error) (n int, err error) {
 184         if pos >= r.t.length {
 185                 err = io.EOF
 186                 return
 187         }
 188         for {
 189                 avail := r.waitAvailable(pos, int64(len(b)), ctxErr)
 190                 if avail == 0 {
 191                         if r.t.closed.IsSet() {
 192                                 err = errors.New("torrent closed")
 193                                 return
 194                         }
 195                         if *ctxErr != nil {
 196                                 err = *ctxErr
 197                                 return
 198                         }
 199                 }
 200                 pi := int(pos / r.t.info.PieceLength)
 201                 ip := r.t.info.Piece(pi)
 202                 po := pos % r.t.info.PieceLength
 203                 b1 := missinggo.LimitLen(b, ip.Length()-po, avail)
 204                 n, err = r.t.readAt(b1, pos)
 205                 if n != 0 {
 206                         err = nil
 207                         return
 208                 }
 209                 r.t.cl.mu.Lock()
 210                 log.Printf("error reading torrent %q piece %d offset %d, %d bytes: %s", r.t, pi, po, len(b1), err)
 211                 r.t.updateAllPieceCompletions()
 212                 r.t.updateAllPiecePriorities()
 213                 r.t.cl.mu.Unlock()
 214         }
 215 }
 216
 217 func (r *reader) Close() error {
 218         r.t.cl.mu.Lock()
 219         defer r.t.cl.mu.Unlock()
 220         r.t.deleteReader(r)
 221         return nil
 222 }
 223
 224 func (r *reader) posChanged() {
 225         to := r.piecesUncached()
 226         from := r.pieces
 227         if to == from {
 228                 return
 229         }
 230         r.pieces = to
 231         r.t.readerPosChanged(from, to)
 232 }
 233
 234 func (r *reader) Seek(off int64, whence int) (ret int64, err error) {
 235         r.opMu.Lock()
 236         defer r.opMu.Unlock()
 237
 238         r.mu.Lock()
 239         defer r.mu.Unlock()
 240         switch whence {
 241         case io.SeekStart:
 242                 r.pos = off
 243         case io.SeekCurrent:
 244                 r.pos += off
 245         case io.SeekEnd:
 246                 r.pos = r.t.info.TotalLength() + off
 247         default:
 248                 err = errors.New("bad whence")
 249         }
 250         ret = r.pos
 251
 252         r.posChanged()
 253         return
 254 }