package torrent import ( "context" "errors" "io" "sync" "github.com/anacrolix/log" "github.com/anacrolix/missinggo" ) type Reader interface { io.Reader io.Seeker io.Closer missinggo.ReadContexter SetReadahead(int64) SetResponsive() } // Piece range by piece index, [begin, end). type pieceRange struct { begin, end pieceIndex } // Accesses Torrent data via a Client. Reads block until the data is // available. Seeks and readahead also drive Client behaviour. type reader struct { t *Torrent responsive bool // Adjust the read/seek window to handle Readers locked to File extents // and the like. offset, length int64 // Ensure operations that change the position are exclusive, like Read() // and Seek(). opMu sync.Mutex // Required when modifying pos and readahead, or reading them without // opMu. mu sync.Locker pos int64 readahead int64 // The cached piece range this reader wants downloaded. The zero value // corresponds to nothing. We cache this so that changes can be detected, // and bubbled up to the Torrent only as required. pieces pieceRange } var _ io.ReadCloser = &reader{} // Don't wait for pieces to complete and be verified. Read calls return as // soon as they can when the underlying chunks become available. func (r *reader) SetResponsive() { r.responsive = true r.t.cl.event.Broadcast() } // Disable responsive mode. TODO: Remove? func (r *reader) SetNonResponsive() { r.responsive = false r.t.cl.event.Broadcast() } // Configure the number of bytes ahead of a read that should also be // prioritized in preparation for further reads. func (r *reader) SetReadahead(readahead int64) { r.mu.Lock() r.readahead = readahead r.mu.Unlock() r.t.cl.lock() defer r.t.cl.unlock() r.posChanged() } // How many bytes are available to read. Max is the most we could require. func (r *reader) available(off, max int64) (ret int64) { off += r.offset for max > 0 { req, ok := r.t.offsetRequest(off) if !ok { break } if !r.responsive && !r.t.pieceComplete(pieceIndex(req.Index)) { break } if !r.t.haveChunk(req) { break } len1 := int64(req.Length) - (off - r.t.requestOffset(req)) max -= len1 ret += len1 off += len1 } // Ensure that ret hasn't exceeded our original max. if max < 0 { ret += max } return } func (r *reader) waitReadable(off int64) { // We may have been sent back here because we were told we could read but // it failed. r.t.cl.event.Wait() } // Calculates the pieces this reader wants downloaded, ignoring the cached // value at r.pieces. func (r *reader) piecesUncached() (ret pieceRange) { ra := r.readahead if ra < 1 { // Needs to be at least 1, because [x, x) means we don't want // anything. ra = 1 } if ra > r.length-r.pos { ra = r.length - r.pos } ret.begin, ret.end = r.t.byteRegionPieces(r.torrentOffset(r.pos), ra) return } func (r *reader) Read(b []byte) (n int, err error) { return r.ReadContext(context.Background(), b) } func (r *reader) ReadContext(ctx context.Context, b []byte) (n int, err error) { // This is set under the Client lock if the Context is canceled. I think we coordinate on a // separate variable so as to avoid false negatives with race conditions due to Contexts being // synchronized. var ctxErr error if ctx.Done() != nil { ctx, cancel := context.WithCancel(ctx) // Abort the goroutine when the function returns. defer cancel() go func() { <-ctx.Done() r.t.cl.lock() ctxErr = ctx.Err() r.t.tickleReaders() r.t.cl.unlock() }() } // Hmmm, if a Read gets stuck, this means you can't change position for // other purposes. That seems reasonable, but unusual. r.opMu.Lock() defer r.opMu.Unlock() n, err = r.readOnceAt(b, r.pos, &ctxErr) if n == 0 { if err == nil { panic("expected error") } else { return } } r.mu.Lock() r.pos += int64(n) r.posChanged() r.mu.Unlock() if r.pos >= r.length { err = io.EOF } else if err == io.EOF { err = io.ErrUnexpectedEOF } return } // Wait until some data should be available to read. Tickles the client if it // isn't. Returns how much should be readable without blocking. func (r *reader) waitAvailable(pos, wanted int64, ctxErr *error, wait bool) (avail int64, err error) { r.t.cl.lock() defer r.t.cl.unlock() for { avail = r.available(pos, wanted) if avail != 0 { return } if r.t.closed.IsSet() { err = errors.New("torrent closed") return } if *ctxErr != nil { err = *ctxErr return } if r.t.dataDownloadDisallowed || !r.t.networkingEnabled { err = errors.New("downloading disabled and data not already available") return } if !wait { return } r.waitReadable(pos) } } // Adds the reader's torrent offset to the reader object offset (for example the reader might be // constrainted to a particular file within the torrent). func (r *reader) torrentOffset(readerPos int64) int64 { return r.offset + readerPos } // Performs at most one successful read to torrent storage. func (r *reader) readOnceAt(b []byte, pos int64, ctxErr *error) (n int, err error) { if pos >= r.length { err = io.EOF return } for { var avail int64 avail, err = r.waitAvailable(pos, int64(len(b)), ctxErr, n == 0) if avail == 0 { return } firstPieceIndex := pieceIndex(r.torrentOffset(pos) / r.t.info.PieceLength) firstPieceOffset := r.torrentOffset(pos) % r.t.info.PieceLength b1 := missinggo.LimitLen(b, avail) n, err = r.t.readAt(b1, r.torrentOffset(pos)) if n != 0 { err = nil return } r.t.cl.lock() // TODO: Just reset pieces in the readahead window. This might help // prevent thrashing with small caches and file and piece priorities. r.log(log.Fstr("error reading torrent %s piece %d offset %d, %d bytes: %v", r.t.infoHash.HexString(), firstPieceIndex, firstPieceOffset, len(b1), err)) if !r.t.updatePieceCompletion(firstPieceIndex) { r.log(log.Fstr("piece %d completion unchanged", firstPieceIndex)) } r.t.cl.unlock() } } func (r *reader) Close() error { r.t.cl.lock() defer r.t.cl.unlock() r.t.deleteReader(r) return nil } func (r *reader) posChanged() { to := r.piecesUncached() from := r.pieces if to == from { return } r.pieces = to // log.Printf("reader pos changed %v->%v", from, to) r.t.readerPosChanged(from, to) } func (r *reader) Seek(off int64, whence int) (ret int64, err error) { r.opMu.Lock() defer r.opMu.Unlock() r.mu.Lock() defer r.mu.Unlock() switch whence { case io.SeekStart: r.pos = off case io.SeekCurrent: r.pos += off case io.SeekEnd: r.pos = r.length + off default: err = errors.New("bad whence") } ret = r.pos r.posChanged() return } func (r *reader) log(m log.Msg) { r.t.logger.Log(m.Skip(1)) }