reader.go

   1 package torrent
   2
   3 import (
   4         "errors"
   5         "io"
   6         "log"
   7         "os"
   8         "sync"
   9
  10         "github.com/anacrolix/missinggo"
  11         "golang.org/x/net/context"
  12 )
  13
  14 // Piece range by piece index, [begin, end).
  15 type pieceRange struct {
  16         begin, end int
  17 }
  18
  19 // Accesses Torrent data via a Client. Reads block until the data is
  20 // available. Seeks and readahead also drive Client behaviour.
  21 type Reader struct {
  22         t          *Torrent
  23         responsive bool
  24         // Ensure operations that change the position are exclusive, like Read()
  25         // and Seek().
  26         opMu sync.Mutex
  27
  28         // Required when modifying pos and readahead, or reading them without
  29         // opMu.
  30         mu        sync.Locker
  31         pos       int64
  32         readahead int64
  33         // The cached piece range this reader wants downloaded. The zero value
  34         // corresponds to nothing. We cache this so that changes can be detected,
  35         // and bubbled up to the Torrent only as required.
  36         pieces pieceRange
  37 }
  38
  39 var _ io.ReadCloser = &Reader{}
  40
  41 // Don't wait for pieces to complete and be verified. Read calls return as
  42 // soon as they can when the underlying chunks become available.
  43 func (r *Reader) SetResponsive() {
  44         r.responsive = true
  45 }
  46
  47 // Disable responsive mode.
  48 func (r *Reader) SetNonResponsive() {
  49         r.responsive = false
  50 }
  51
  52 // Configure the number of bytes ahead of a read that should also be
  53 // prioritized in preparation for further reads.
  54 func (r *Reader) SetReadahead(readahead int64) {
  55         r.mu.Lock()
  56         r.readahead = readahead
  57         r.mu.Unlock()
  58         r.t.cl.mu.Lock()
  59         defer r.t.cl.mu.Unlock()
  60         r.posChanged()
  61 }
  62
  63 // Return reader's current position.
  64 func (r *Reader) CurrentPos() int64 {
  65         return r.pos
  66 }
  67
  68 func (r *Reader) readable(off int64) (ret bool) {
  69         if r.t.closed.IsSet() {
  70                 return true
  71         }
  72         req, ok := r.t.offsetRequest(off)
  73         if !ok {
  74                 panic(off)
  75         }
  76         if r.responsive {
  77                 return r.t.haveChunk(req)
  78         }
  79         return r.t.pieceComplete(int(req.Index))
  80 }
  81
  82 // How many bytes are available to read. Max is the most we could require.
  83 func (r *Reader) available(off, max int64) (ret int64) {
  84         for max > 0 {
  85                 req, ok := r.t.offsetRequest(off)
  86                 if !ok {
  87                         break
  88                 }
  89                 if !r.t.haveChunk(req) {
  90                         break
  91                 }
  92                 len1 := int64(req.Length) - (off - r.t.requestOffset(req))
  93                 max -= len1
  94                 ret += len1
  95                 off += len1
  96         }
  97         // Ensure that ret hasn't exceeded our original max.
  98         if max < 0 {
  99                 ret += max
 100         }
 101         return
 102 }
 103
 104 func (r *Reader) tickleClient() {
 105         r.t.readersChanged()
 106 }
 107
 108 func (r *Reader) waitReadable(off int64) {
 109         // We may have been sent back here because we were told we could read but
 110         // it failed.
 111         r.t.cl.event.Wait()
 112 }
 113
 114 // Calculates the pieces this reader wants downloaded, ignoring the cached
 115 // value at r.pieces.
 116 func (r *Reader) piecesUncached() (ret pieceRange) {
 117         ra := r.readahead
 118         if ra < 1 {
 119                 ra = 1
 120         }
 121         ret.begin, ret.end = r.t.byteRegionPieces(r.pos, ra)
 122         return
 123 }
 124
 125 func (r *Reader) Read(b []byte) (n int, err error) {
 126         return r.ReadContext(b, context.Background())
 127 }
 128
 129 func (r *Reader) ReadContext(b []byte, ctx context.Context) (n int, err error) {
 130         // This is set under the Client lock if the Context is canceled.
 131         var ctxErr error
 132         if ctx.Done() != nil {
 133                 ctx, cancel := context.WithCancel(ctx)
 134                 // Abort the goroutine when the function returns.
 135                 defer cancel()
 136                 go func() {
 137                         <-ctx.Done()
 138                         r.t.cl.mu.Lock()
 139                         ctxErr = ctx.Err()
 140                         r.t.cl.event.Broadcast()
 141                         r.t.cl.mu.Unlock()
 142                 }()
 143         }
 144         // Hmmm, if a Read gets stuck, this means you can't change position for
 145         // other purposes. That seems reasonable, but unusual.
 146         r.opMu.Lock()
 147         defer r.opMu.Unlock()
 148         for len(b) != 0 {
 149                 var n1 int
 150                 n1, err = r.readOnceAt(b, r.pos, &ctxErr)
 151                 if n1 == 0 {
 152                         if err == nil {
 153                                 panic("expected error")
 154                         }
 155                         break
 156                 }
 157                 b = b[n1:]
 158                 n += n1
 159                 r.mu.Lock()
 160                 r.pos += int64(n1)
 161                 r.posChanged()
 162                 r.mu.Unlock()
 163         }
 164         if r.pos >= r.t.length {
 165                 err = io.EOF
 166         } else if err == io.EOF {
 167                 err = io.ErrUnexpectedEOF
 168         }
 169         return
 170 }
 171
 172 // Wait until some data should be available to read. Tickles the client if it
 173 // isn't. Returns how much should be readable without blocking.
 174 func (r *Reader) waitAvailable(pos, wanted int64, ctxErr *error) (avail int64) {
 175         r.t.cl.mu.Lock()
 176         defer r.t.cl.mu.Unlock()
 177         for !r.readable(pos) && *ctxErr == nil {
 178                 r.waitReadable(pos)
 179         }
 180         return r.available(pos, wanted)
 181 }
 182
 183 // Performs at most one successful read to torrent storage.
 184 func (r *Reader) readOnceAt(b []byte, pos int64, ctxErr *error) (n int, err error) {
 185         if pos >= r.t.length {
 186                 err = io.EOF
 187                 return
 188         }
 189         for {
 190                 avail := r.waitAvailable(pos, int64(len(b)), ctxErr)
 191                 if avail == 0 {
 192                         if r.t.closed.IsSet() {
 193                                 err = errors.New("torrent closed")
 194                                 return
 195                         }
 196                         if *ctxErr != nil {
 197                                 err = *ctxErr
 198                                 return
 199                         }
 200                 }
 201                 b1 := b[:avail]
 202                 pi := int(pos / r.t.Info().PieceLength)
 203                 ip := r.t.Info().Piece(pi)
 204                 po := pos % r.t.Info().PieceLength
 205                 missinggo.LimitLen(&b1, ip.Length()-po)
 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 os.SEEK_SET:
 244                 r.pos = off
 245         case os.SEEK_CUR:
 246                 r.pos += off
 247         case os.SEEK_END:
 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 }
 257
 258 func (r *Reader) Torrent() *Torrent {
 259         return r.t
 260 }