package torrent
import (
- "math/rand"
+ "fmt"
"sync"
- "github.com/bradfitz/iter"
+ "github.com/anacrolix/chansync"
+ "github.com/anacrolix/missinggo/v2/bitmap"
+ "github.com/anacrolix/torrent/metainfo"
pp "github.com/anacrolix/torrent/peer_protocol"
+ "github.com/anacrolix/torrent/storage"
)
-// Piece priority describes the importance of obtaining a particular piece.
-
-type piecePriority byte
+type Piece struct {
+ // The completed piece SHA1 hash, from the metainfo "pieces" field.
+ hash *metainfo.Hash
+ t *Torrent
+ index pieceIndex
+ files []*File
-func (me *piecePriority) Raise(maybe piecePriority) {
- if maybe > *me {
- *me = maybe
- }
-}
+ readerCond chansync.BroadcastCond
-const (
- PiecePriorityNone piecePriority = iota // Not wanted.
- PiecePriorityNormal // Wanted.
- PiecePriorityReadahead // May be required soon.
- PiecePriorityNext // Succeeds a piece where a read occurred.
- PiecePriorityNow // A read occurred in this piece.
-)
+ numVerifies int64
+ hashing bool
+ marking bool
+ storageCompletionOk bool
-type piece struct {
- // The completed piece SHA1 hash, from the metainfo "pieces" field.
- Hash pieceSum
- // Chunks we've written to since the last check. The chunk offset and
- // length can be determined by the request chunkSize in use.
- DirtyChunks []bool
- Hashing bool
- QueuedForHash bool
- EverHashed bool
- PublicPieceState PieceState
+ publicPieceState PieceState
priority piecePriority
+ // Availability adjustment for this piece relative to len(Torrent.connsWithAllPieces). This is
+ // incremented for any piece a peer has when a peer has a piece, Torrent.haveInfo is true, and
+ // the Peer isn't recorded in Torrent.connsWithAllPieces.
+ relativeAvailability int
+ // This can be locked when the Client lock is taken, but probably not vice versa.
pendingWritesMutex sync.Mutex
pendingWrites int
noPendingWrites sync.Cond
+
+ // Connections that have written data to this piece since its last check.
+ // This can include connections that have closed.
+ dirtiers map[*Peer]struct{}
}
-func (p *piece) pendingChunk(cs chunkSpec, chunkSize pp.Integer) bool {
- ci := chunkIndex(cs, chunkSize)
- if ci >= len(p.DirtyChunks) {
- return true
- }
- return !p.DirtyChunks[ci]
+func (p *Piece) String() string {
+ return fmt.Sprintf("%s/%d", p.t.infoHash.HexString(), p.index)
}
-func (p *piece) numDirtyChunks() (ret int) {
- for _, dirty := range p.DirtyChunks {
- if dirty {
- ret++
- }
- }
- return
+func (p *Piece) Info() metainfo.Piece {
+ return p.t.info.Piece(int(p.index))
}
-func (p *piece) unpendChunkIndex(i int) {
- for i >= len(p.DirtyChunks) {
- p.DirtyChunks = append(p.DirtyChunks, false)
- }
- p.DirtyChunks[i] = true
+func (p *Piece) Storage() storage.Piece {
+ return p.t.storage.Piece(p.Info())
}
-func (p *piece) pendChunkIndex(i int) {
- if i >= len(p.DirtyChunks) {
- return
+func (p *Piece) Flush() {
+ if p.t.storage.Flush != nil {
+ _ = p.t.storage.Flush()
}
- p.DirtyChunks[i] = false
}
-func chunkIndexSpec(index int, pieceLength, chunkSize pp.Integer) chunkSpec {
- ret := chunkSpec{pp.Integer(index) * chunkSize, chunkSize}
- if ret.Begin+ret.Length > pieceLength {
- ret.Length = pieceLength - ret.Begin
- }
- return ret
+func (p *Piece) pendingChunkIndex(chunkIndex chunkIndexType) bool {
+ return !p.chunkIndexDirty(chunkIndex)
}
-func (p *piece) shuffledPendingChunkSpecs(t *torrent, piece int) (css []chunkSpec) {
- // defer func() {
- // log.Println(piece, css)
- // }()
- numPending := t.pieceNumPendingChunks(piece)
- if numPending == 0 {
- return
- }
- css = make([]chunkSpec, 0, numPending)
- for ci := range iter.N(t.pieceNumChunks(piece)) {
- if ci >= len(p.DirtyChunks) || !p.DirtyChunks[ci] {
- css = append(css, t.chunkIndexSpec(ci, piece))
- }
- }
- if len(css) <= 1 {
- return
- }
- for i := range css {
- j := rand.Intn(i + 1)
- css[i], css[j] = css[j], css[i]
- }
- return
+func (p *Piece) pendingChunk(cs ChunkSpec, chunkSize pp.Integer) bool {
+ return p.pendingChunkIndex(chunkIndexFromChunkSpec(cs, chunkSize))
}
-func (p *piece) incrementPendingWrites() {
+func (p *Piece) hasDirtyChunks() bool {
+ return p.numDirtyChunks() != 0
+}
+
+func (p *Piece) numDirtyChunks() chunkIndexType {
+ return chunkIndexType(roaringBitmapRangeCardinality[RequestIndex](
+ &p.t.dirtyChunks,
+ p.requestIndexOffset(),
+ p.t.pieceRequestIndexOffset(p.index+1)))
+}
+
+func (p *Piece) unpendChunkIndex(i chunkIndexType) {
+ p.t.dirtyChunks.Add(p.requestIndexOffset() + i)
+ p.t.updatePieceRequestOrder(p.index)
+ p.readerCond.Broadcast()
+}
+
+func (p *Piece) pendChunkIndex(i RequestIndex) {
+ p.t.dirtyChunks.Remove(p.requestIndexOffset() + i)
+ p.t.updatePieceRequestOrder(p.index)
+}
+
+func (p *Piece) numChunks() chunkIndexType {
+ return p.t.pieceNumChunks(p.index)
+}
+
+func (p *Piece) incrementPendingWrites() {
p.pendingWritesMutex.Lock()
p.pendingWrites++
p.pendingWritesMutex.Unlock()
}
-func (p *piece) decrementPendingWrites() {
+func (p *Piece) decrementPendingWrites() {
p.pendingWritesMutex.Lock()
if p.pendingWrites == 0 {
panic("assertion")
p.pendingWritesMutex.Unlock()
}
-func (p *piece) waitNoPendingWrites() {
+func (p *Piece) waitNoPendingWrites() {
p.pendingWritesMutex.Lock()
for p.pendingWrites != 0 {
p.noPendingWrites.Wait()
}
p.pendingWritesMutex.Unlock()
}
+
+func (p *Piece) chunkIndexDirty(chunk chunkIndexType) bool {
+ return p.t.dirtyChunks.Contains(p.requestIndexOffset() + chunk)
+}
+
+func (p *Piece) chunkIndexSpec(chunk chunkIndexType) ChunkSpec {
+ return chunkIndexSpec(pp.Integer(chunk), p.length(), p.chunkSize())
+}
+
+func (p *Piece) numDirtyBytes() (ret pp.Integer) {
+ // defer func() {
+ // if ret > p.length() {
+ // panic("too many dirty bytes")
+ // }
+ // }()
+ numRegularDirtyChunks := p.numDirtyChunks()
+ if p.chunkIndexDirty(p.numChunks() - 1) {
+ numRegularDirtyChunks--
+ ret += p.chunkIndexSpec(p.lastChunkIndex()).Length
+ }
+ ret += pp.Integer(numRegularDirtyChunks) * p.chunkSize()
+ return
+}
+
+func (p *Piece) length() pp.Integer {
+ return p.t.pieceLength(p.index)
+}
+
+func (p *Piece) chunkSize() pp.Integer {
+ return p.t.chunkSize
+}
+
+func (p *Piece) lastChunkIndex() chunkIndexType {
+ return p.numChunks() - 1
+}
+
+func (p *Piece) bytesLeft() (ret pp.Integer) {
+ if p.t.pieceComplete(p.index) {
+ return 0
+ }
+ return p.length() - p.numDirtyBytes()
+}
+
+// Forces the piece data to be rehashed.
+func (p *Piece) VerifyData() {
+ p.t.cl.lock()
+ defer p.t.cl.unlock()
+ target := p.numVerifies + 1
+ if p.hashing {
+ target++
+ }
+ // log.Printf("target: %d", target)
+ p.t.queuePieceCheck(p.index)
+ for {
+ // log.Printf("got %d verifies", p.numVerifies)
+ if p.numVerifies >= target {
+ break
+ }
+ p.t.cl.event.Wait()
+ }
+ // log.Print("done")
+}
+
+func (p *Piece) queuedForHash() bool {
+ return p.t.piecesQueuedForHash.Get(bitmap.BitIndex(p.index))
+}
+
+func (p *Piece) torrentBeginOffset() int64 {
+ return int64(p.index) * p.t.info.PieceLength
+}
+
+func (p *Piece) torrentEndOffset() int64 {
+ return p.torrentBeginOffset() + int64(p.length())
+}
+
+func (p *Piece) SetPriority(prio piecePriority) {
+ p.t.cl.lock()
+ defer p.t.cl.unlock()
+ p.priority = prio
+ p.t.updatePiecePriority(p.index, "Piece.SetPriority")
+}
+
+func (p *Piece) purePriority() (ret piecePriority) {
+ for _, f := range p.files {
+ ret.Raise(f.prio)
+ }
+ if p.t.readerNowPieces().Contains(bitmap.BitIndex(p.index)) {
+ ret.Raise(PiecePriorityNow)
+ }
+ // if t._readerNowPieces.Contains(piece - 1) {
+ // return PiecePriorityNext
+ // }
+ if p.t.readerReadaheadPieces().Contains(bitmap.BitIndex(p.index)) {
+ ret.Raise(PiecePriorityReadahead)
+ }
+ ret.Raise(p.priority)
+ return
+}
+
+func (p *Piece) uncachedPriority() (ret piecePriority) {
+ if p.hashing || p.marking || p.t.pieceComplete(p.index) || p.queuedForHash() {
+ return PiecePriorityNone
+ }
+ return p.purePriority()
+}
+
+// Tells the Client to refetch the completion status from storage, updating priority etc. if
+// necessary. Might be useful if you know the state of the piece data has changed externally.
+func (p *Piece) UpdateCompletion() {
+ p.t.cl.lock()
+ defer p.t.cl.unlock()
+ p.t.updatePieceCompletion(p.index)
+}
+
+func (p *Piece) completion() (ret storage.Completion) {
+ ret.Complete = p.t.pieceComplete(p.index)
+ ret.Ok = p.storageCompletionOk
+ return
+}
+
+func (p *Piece) allChunksDirty() bool {
+ return p.numDirtyChunks() == p.numChunks()
+}
+
+func (p *Piece) State() PieceState {
+ return p.t.PieceState(p.index)
+}
+
+func (p *Piece) requestIndexOffset() RequestIndex {
+ return p.t.pieceRequestIndexOffset(p.index)
+}
+
+func (p *Piece) availability() int {
+ return len(p.t.connsWithAllPieces) + p.relativeAvailability
+}