gitlab.com/SkynetLabs/skyd@v1.6.9/skymodules/renter/proto/downloader.go

package proto

import (
	"net"
	"strings"
	"sync"
	"time"

	"gitlab.com/NebulousLabs/errors"

	"gitlab.com/NebulousLabs/encoding"
	"gitlab.com/SkynetLabs/skyd/skymodules"
	"go.sia.tech/siad/crypto"
	"go.sia.tech/siad/modules"
	"go.sia.tech/siad/types"
)

// A Downloader retrieves sectors by calling the download RPC on a host.
// Downloaders are NOT thread- safe; calls to Sector must be serialized.
type Downloader struct {
	closeChan   chan struct{}
	conn        net.Conn
	contractID  types.FileContractID
	contractSet *ContractSet
	deps        modules.Dependencies
	hdb         hostDB
	host        skymodules.HostDBEntry
	once        sync.Once

	height types.BlockHeight
}

// Download retrieves the requested sector data and revises the underlying
// contract to pay the host proportionally to the data retrieved.
func (hd *Downloader) Download(root crypto.Hash, offset, length uint32) (_ skymodules.RenterContract, _ []byte, err error) {
	// Reset deadline when finished.
	defer extendDeadline(hd.conn, time.Hour) // TODO: Constant.

	if uint64(offset)+uint64(length) > modules.SectorSize {
		return skymodules.RenterContract{}, nil, errors.New("illegal offset and/or length")
	}

	// Acquire the contract.
	// TODO: why not just lock the SafeContract directly?
	sc, haveContract := hd.contractSet.Acquire(hd.contractID)
	if !haveContract {
		return skymodules.RenterContract{}, nil, errors.New("contract not present in contract set")
	}
	defer hd.contractSet.Return(sc)
	contract := sc.header // for convenience

	// calculate price
	sectorPrice := hd.host.DownloadBandwidthPrice.Mul64(modules.SectorSize)
	if contract.RenterFunds().Cmp(sectorPrice) < 0 {
		return skymodules.RenterContract{}, nil, errors.New("contract has insufficient funds to support download")
	}
	// To mitigate small errors (e.g. differing block heights), fudge the
	// price and collateral by 0.2%.
	sectorPrice = sectorPrice.MulFloat(1 + hostPriceLeeway)

	// create the download revision
	rev, err := newDownloadRevision(contract.LastRevision(), sectorPrice)
	if err != nil {
		return skymodules.RenterContract{}, nil, errors.AddContext(err, "Error creating new download revision")
	}

	// initiate download by confirming host settings
	extendDeadline(hd.conn, modules.NegotiateSettingsTime)
	if err := startDownload(hd.conn, hd.host); err != nil {
		return skymodules.RenterContract{}, nil, err
	}

	// record the change we are about to make to the contract. If we lose power
	// mid-revision, this allows us to restore either the pre-revision or
	// post-revision contract.
	walTxn, err := sc.managedRecordDownloadIntent(rev, sectorPrice)
	if err != nil {
		return skymodules.RenterContract{}, nil, err
	}

	// send download action
	extendDeadline(hd.conn, 2*time.Minute) // TODO: Constant.
	err = encoding.WriteObject(hd.conn, []modules.DownloadAction{{
		MerkleRoot: root,
		Offset:     0,
		Length:     modules.SectorSize,
	}})
	if err != nil {
		return skymodules.RenterContract{}, nil, err
	}

	// Increase Successful/Failed interactions accordingly
	defer func() {
		// Ignore ErrStopResponse and closed network connecton errors since
		// they are not considered a failed interaction with the host.
		if err != nil && !errors.Contains(err, modules.ErrStopResponse) && !strings.Contains(err.Error(), "use of closed network connection") {
			hd.hdb.IncrementFailedInteractions(contract.HostPublicKey())
			err = errors.Extend(err, skymodules.ErrHostFault)
		} else {
			hd.hdb.IncrementSuccessfulInteractions(contract.HostPublicKey())
		}
	}()

	// Disrupt before sending the signed revision to the host.
	if hd.deps.Disrupt("InterruptDownloadBeforeSendingRevision") {
		return skymodules.RenterContract{}, nil,
			errors.New("InterruptDownloadBeforeSendingRevision disrupt")
	}

	// send the revision to the host for approval
	extendDeadline(hd.conn, connTimeout)
	signedTxn, err := negotiateRevision(hd.conn, rev, contract.SecretKey, hd.height)
	if errors.Contains(err, modules.ErrStopResponse) {
		// If the host wants to stop communicating after this iteration, close
		// our connection; this will cause the next download to fail. However,
		// we must delay closing until we've finished downloading the sector.
		defer func() {
			err = errors.Compose(err, hd.conn.Close())
		}()
	} else if err != nil {
		return skymodules.RenterContract{}, nil, err
	}

	// Disrupt after sending the signed revision to the host.
	if hd.deps.Disrupt("InterruptDownloadAfterSendingRevision") {
		return skymodules.RenterContract{}, nil,
			errors.New("InterruptDownloadAfterSendingRevision disrupt")
	}

	// read sector data, completing one iteration of the download loop
	extendDeadline(hd.conn, modules.NegotiateDownloadTime)
	var sectors [][]byte
	if err := encoding.ReadObject(hd.conn, &sectors, modules.SectorSize+16); err != nil {
		return skymodules.RenterContract{}, nil, err
	} else if len(sectors) != 1 {
		return skymodules.RenterContract{}, nil, errors.New("host did not send enough sectors")
	}
	sector := sectors[0]
	if uint64(len(sector)) != modules.SectorSize {
		return skymodules.RenterContract{}, nil, errors.New("host did not send enough sector data")
	} else if crypto.MerkleRoot(sector) != root {
		return skymodules.RenterContract{}, nil, errors.New("host sent bad sector data")
	}

	// update contract and metrics
	if err := sc.managedCommitDownload(walTxn, signedTxn, sectorPrice); err != nil {
		return skymodules.RenterContract{}, nil, err
	}

	// return the subset of requested data
	return sc.Metadata(), sector[offset:][:length], nil
}

// shutdown terminates the revision loop and signals the goroutine spawned in
// NewDownloader to return.
func (hd *Downloader) shutdown() {
	extendDeadline(hd.conn, modules.NegotiateSettingsTime)
	// don't care about these errors
	_, _ = verifySettings(hd.conn, hd.host)
	_ = modules.WriteNegotiationStop(hd.conn)
	close(hd.closeChan)
}

// Close cleanly terminates the download loop with the host and closes the
// connection.
func (hd *Downloader) Close() error {
	// using once ensures that Close is idempotent
	hd.once.Do(hd.shutdown)
	return hd.conn.Close()
}

// NewDownloader initiates the download request loop with a host, and returns a
// Downloader.
func (cs *ContractSet) NewDownloader(host skymodules.HostDBEntry, id types.FileContractID, currentHeight types.BlockHeight, hdb hostDB, cancel <-chan struct{}) (_ *Downloader, err error) {
	sc, ok := cs.Acquire(id)
	if !ok {
		return nil, errors.New("invalid contract")
	}
	defer cs.Return(sc)
	contract := sc.header

	// check that contract has enough value to support a download
	sectorPrice := host.DownloadBandwidthPrice.Mul64(modules.SectorSize)
	if contract.RenterFunds().Cmp(sectorPrice) < 0 {
		return nil, errors.New("contract has insufficient funds to support download")
	}

	// Increase Successful/Failed interactions accordingly
	defer func() {
		// A revision mismatch might not be the host's fault.
		if err != nil && !IsRevisionMismatch(err) {
			hdb.IncrementFailedInteractions(contract.HostPublicKey())
			err = errors.Extend(err, skymodules.ErrHostFault)
		} else if err == nil {
			hdb.IncrementSuccessfulInteractions(contract.HostPublicKey())
		}
	}()

	conn, closeChan, err := initiateRevisionLoop(host, sc, modules.RPCDownload, cancel, cs.staticRL)
	if err != nil {
		return nil, errors.AddContext(err, "failed to initiate revision loop")
	}
	// if we succeeded, we can safely discard the unappliedTxns
	if err := sc.clearUnappliedTxns(); err != nil {
		return nil, errors.AddContext(err, "failed to clear unapplied txns")
	}

	// the host is now ready to accept revisions
	return &Downloader{
		contractID:  id,
		contractSet: cs,
		host:        host,
		conn:        conn,
		closeChan:   closeChan,
		deps:        cs.staticDeps,
		hdb:         hdb,

		height: currentHeight,
	}, nil
}