12199391122

Committed 06 Dec 2024 01:10PM UTC coverage: 49.807% (-9.1%) from 58.933%

Build # 12199391122

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #9337 from Guayaba221/patch-1

chore: fix typo in ruby.md

Run Details

100137 of 201051 relevant lines covered (49.81%)

2.07 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

78.57

/routing/missioncontrol_store.go

package routing

import (
        "bytes"
        "container/list"
        "encoding/binary"
        "fmt"
        "io"
        "sync"
        "time"

        "github.com/lightningnetwork/lnd/kvdb"
        "github.com/lightningnetwork/lnd/lnwire"
        "github.com/lightningnetwork/lnd/tlv"
)

var (
        // resultsKey is the fixed key under which the attempt results are
        // stored.
        resultsKey = []byte("missioncontrol-results")

        // Big endian is the preferred byte order, due to cursor scans over
        // integer keys iterating in order.
        byteOrder = binary.BigEndian
)

// missionControlDB is an interface that defines the database methods that a
// single missionControlStore has access to. It allows the missionControlStore
// to be unaware of the overall DB structure and restricts its access to the DB
// by only providing it the bucket that it needs to care about.
type missionControlDB interface {
        // update can be used to perform reads and writes on the given bucket.
        update(f func(bkt kvdb.RwBucket) error, reset func()) error

        // view can be used to perform reads on the given bucket.
        view(f func(bkt kvdb.RBucket) error, reset func()) error

        // purge will delete all the contents in this store.
        purge() error
}

// missionControlStore is a bolt db based implementation of a mission control
// store. It stores the raw payment attempt data from which the internal mission
// controls state can be rederived on startup. This allows the mission control
// internal data structure to be changed without requiring a database migration.
// Also changes to mission control parameters can be applied to historical data.
// Finally, it enables importing raw data from an external source.
type missionControlStore struct {
        done chan struct{}
        wg   sync.WaitGroup
        db   missionControlDB

        // TODO(yy): Remove the usage of sync.Cond - we are better off using
        // channes than a Cond as suggested in the official godoc.
        //
        // queueCond is signalled when items are put into the queue.
        queueCond *sync.Cond

        // queue stores all pending payment results not yet added to the store.
        // Access is protected by the queueCond.L mutex.
        queue *list.List

        // keys holds the stored MC store item keys in the order of storage.
        // We use this list when adding/deleting items from the database to
        // avoid cursor use which may be slow in the remote DB case.
        keys *list.List

        // keysMap holds the stored MC store item keys. We use this map to check
        // if a new payment result has already been stored.
        keysMap map[string]struct{}

        // maxRecords is the maximum amount of records we will store in the db.
        maxRecords int

        // flushInterval is the configured interval we use to store new results
        // and delete outdated ones from the db.
        flushInterval time.Duration
}

func newMissionControlStore(db missionControlDB, maxRecords int,
        flushInterval time.Duration) (*missionControlStore, error) {

        var (
                keys    *list.List
                keysMap map[string]struct{}
        )

        // Create buckets if not yet existing.
        err := db.update(func(resultsBucket kvdb.RwBucket) error {
                // Collect all keys to be able to quickly calculate the
                // difference when updating the DB state.
                c := resultsBucket.ReadCursor()
                for k, _ := c.First(); k != nil; k, _ = c.Next() {
                        keys.PushBack(string(k))
                        keysMap[string(k)] = struct{}{}
                }

                return nil
        }, func() {
                keys = list.New()
                keysMap = make(map[string]struct{})
        })
        if err != nil {
                return nil, err
        }

        log.Infof("Loaded %d mission control entries", len(keysMap))

        return &missionControlStore{
                done:          make(chan struct{}),
                db:            db,
                queueCond:     sync.NewCond(&sync.Mutex{}),
                queue:         list.New(),
                keys:          keys,
                keysMap:       keysMap,
                maxRecords:    maxRecords,
                flushInterval: flushInterval,
        }, nil
}

// clear removes all results from the db.
func (b *missionControlStore) clear() error {
        b.queueCond.L.Lock()
        defer b.queueCond.L.Unlock()

        if err := b.db.purge(); err != nil {
                return err
        }

        b.queue = list.New()

        return nil
}

// fetchAll returns all results currently stored in the database.
func (b *missionControlStore) fetchAll() ([]*paymentResult, error) {
        var results []*paymentResult

        err := b.db.view(func(resultBucket kvdb.RBucket) error {
                results = make([]*paymentResult, 0)

                return resultBucket.ForEach(func(k, v []byte) error {
                        result, err := deserializeResult(k, v)
                        if err != nil {
                                return err
                        }

                        results = append(results, result)

                        return nil
                })

        }, func() {
                results = nil
        })
        if err != nil {
                return nil, err
        }

        return results, nil
}

// serializeResult serializes a payment result and returns a key and value byte
// slice to insert into the bucket.
func serializeResult(rp *paymentResult) ([]byte, []byte, error) {
        recordProducers := []tlv.RecordProducer{
                &rp.timeFwd,
                &rp.timeReply,
                &rp.route,
        }

        rp.failure.WhenSome(
                func(failure tlv.RecordT[tlv.TlvType3, paymentFailure]) {
                        recordProducers = append(recordProducers, &failure)
                },
        )

        // Compose key that identifies this result.
        key := getResultKey(rp)

        var buff bytes.Buffer
        err := lnwire.EncodeRecordsTo(
                &buff, lnwire.ProduceRecordsSorted(recordProducers...),
        )
        if err != nil {
                return nil, nil, err
        }

        return key, buff.Bytes(), err
}

// deserializeResult deserializes a payment result.
func deserializeResult(k, v []byte) (*paymentResult, error) {
        // Parse payment id.
        result := paymentResult{
                id: byteOrder.Uint64(k[8:]),
        }

        failure := tlv.ZeroRecordT[tlv.TlvType3, paymentFailure]()
        recordProducers := []tlv.RecordProducer{
                &result.timeFwd,
                &result.timeReply,
                &result.route,
                &failure,
        }

        r := bytes.NewReader(v)
        typeMap, err := lnwire.DecodeRecords(
                r, lnwire.ProduceRecordsSorted(recordProducers...)...,
        )
        if err != nil {
                return nil, err
        }

        if _, ok := typeMap[result.failure.TlvType()]; ok {
                result.failure = tlv.SomeRecordT(failure)
        }

        return &result, nil
}

// serializeRoute serializes a mcRoute and writes the resulting bytes to the
// given io.Writer.
func serializeRoute(w io.Writer, r *mcRoute) error {
        records := lnwire.ProduceRecordsSorted(
                &r.sourcePubKey,
                &r.totalAmount,
                &r.hops,
        )

        return lnwire.EncodeRecordsTo(w, records)
}

// deserializeRoute deserializes the mcRoute from the given io.Reader.
func deserializeRoute(r io.Reader) (*mcRoute, error) {
        var rt mcRoute
        records := lnwire.ProduceRecordsSorted(
                &rt.sourcePubKey,
                &rt.totalAmount,
                &rt.hops,
        )

        _, err := lnwire.DecodeRecords(r, records...)
        if err != nil {
                return nil, err
        }

        return &rt, nil
}

// deserializeHop deserializes the mcHop from the given io.Reader.
func deserializeHop(r io.Reader) (*mcHop, error) {
        var (
                h        mcHop
                blinding = tlv.ZeroRecordT[tlv.TlvType3, lnwire.TrueBoolean]()
                custom   = tlv.ZeroRecordT[tlv.TlvType4, lnwire.TrueBoolean]()
        )
        records := lnwire.ProduceRecordsSorted(
                &h.channelID,
                &h.pubKeyBytes,
                &h.amtToFwd,
                &blinding,
                &custom,
        )

        typeMap, err := lnwire.DecodeRecords(r, records...)
        if err != nil {
                return nil, err
        }

        if _, ok := typeMap[h.hasBlindingPoint.TlvType()]; ok {
                h.hasBlindingPoint = tlv.SomeRecordT(blinding)
        }

        if _, ok := typeMap[h.hasCustomRecords.TlvType()]; ok {
                h.hasCustomRecords = tlv.SomeRecordT(custom)
        }

        return &h, nil
}

// serializeHop serializes a mcHop and writes the resulting bytes to the given
// io.Writer.
func serializeHop(w io.Writer, h *mcHop) error {
        recordProducers := []tlv.RecordProducer{
                &h.channelID,
                &h.pubKeyBytes,
                &h.amtToFwd,
        }

        h.hasBlindingPoint.WhenSome(func(
                hasBlinding tlv.RecordT[tlv.TlvType3, lnwire.TrueBoolean]) {

                recordProducers = append(recordProducers, &hasBlinding)
        })

        h.hasCustomRecords.WhenSome(func(
                hasCustom tlv.RecordT[tlv.TlvType4, lnwire.TrueBoolean]) {

                recordProducers = append(recordProducers, &hasCustom)
        })

        return lnwire.EncodeRecordsTo(
                w, lnwire.ProduceRecordsSorted(recordProducers...),
        )
}

// AddResult adds a new result to the db.
func (b *missionControlStore) AddResult(rp *paymentResult) {
        b.queueCond.L.Lock()
        b.queue.PushBack(rp)
        b.queueCond.L.Unlock()

        b.queueCond.Signal()
}

// stop stops the store ticker goroutine.
func (b *missionControlStore) stop() {
        close(b.done)

        b.queueCond.Signal()

        b.wg.Wait()
}

// run runs the MC store ticker goroutine.
func (b *missionControlStore) run() {
        b.wg.Add(1)

        go func() {
                defer b.wg.Done()

                timer := time.NewTimer(b.flushInterval)

                // Immediately stop the timer. It will be started once new
                // items are added to the store. As the doc for time.Timer
                // states, every call to Stop() done on a timer that is not
                // known to have been fired needs to be checked and the timer's
                // channel needs to be drained appropriately. This could happen
                // if the flushInterval is very small (e.g. 1 nanosecond).
                if !timer.Stop() {
                        select {
                        case <-timer.C:
                        case <-b.done:
                                log.Debugf("Stopping mission control store")
                        }
                }

                for {
                        // Wait for the queue to not be empty.
                        b.queueCond.L.Lock()
                        for b.queue.Front() == nil {
                                // To make sure we can properly stop, we must
                                // read the `done` channel first before
                                // attempting to call `Wait()`. This is due to
                                // the fact when `Signal` is called before the
                                // `Wait` call, the `Wait` call will block
                                // indefinitely.
                                //
                                // TODO(yy): replace this with channels.
                                select {
                                case <-b.done:
                                        b.queueCond.L.Unlock()

                                        return
                                default:
                                }

                                b.queueCond.Wait()
                        }
                        b.queueCond.L.Unlock()

                        // Restart the timer.
                        timer.Reset(b.flushInterval)

                        select {
                        case <-timer.C:
                                if err := b.storeResults(); err != nil {
                                        log.Errorf("Failed to update mission "+
                                                "control store: %v", err)
                                }

                        case <-b.done:
                                // Release the timer's resources.
                                if !timer.Stop() {
                                        select {
                                        case <-timer.C:
                                        case <-b.done:
                                                log.Debugf("Mission control " +
                                                        "store stopped")
                                        }
                                }
                                return
                        }
                }
        }()
}

// storeResults stores all accumulated results.
func (b *missionControlStore) storeResults() error {
        // We copy a reference to the queue and clear the original queue to be
        // able to release the lock.
        b.queueCond.L.Lock()
        l := b.queue

        if l.Len() == 0 {
                b.queueCond.L.Unlock()

                return nil
        }
        b.queue = list.New()
        b.queueCond.L.Unlock()

        var (
                newKeys    map[string]struct{}
                delKeys    []string
                storeCount int
                pruneCount int
        )

        // Create a deduped list of new entries.
        newKeys = make(map[string]struct{}, l.Len())
        for e := l.Front(); e != nil; e = e.Next() {
                pr, ok := e.Value.(*paymentResult)
                if !ok {
                        return fmt.Errorf("wrong type %T (not *paymentResult)",
                                e.Value)
                }
                key := string(getResultKey(pr))
                if _, ok := b.keysMap[key]; ok {
                        l.Remove(e)
                        continue
                }
                if _, ok := newKeys[key]; ok {
                        l.Remove(e)
                        continue
                }
                newKeys[key] = struct{}{}
        }

        // Create a list of entries to delete.
        toDelete := b.keys.Len() + len(newKeys) - b.maxRecords
        if b.maxRecords > 0 && toDelete > 0 {
                delKeys = make([]string, 0, toDelete)

                // Delete as many as needed from old keys.
                for e := b.keys.Front(); len(delKeys) < toDelete && e != nil; {
                        key, ok := e.Value.(string)
                        if !ok {
                                return fmt.Errorf("wrong type %T (not string)",
                                        e.Value)
                        }
                        delKeys = append(delKeys, key)
                        e = e.Next()
                }

                // If more deletions are needed, simply do not add from the
                // list of new keys.
                for e := l.Front(); len(delKeys) < toDelete && e != nil; {
                        toDelete--
                        pr, ok := e.Value.(*paymentResult)
                        if !ok {
                                return fmt.Errorf("wrong type %T (not "+
                                        "*paymentResult )", e.Value)
                        }
                        key := string(getResultKey(pr))
                        delete(newKeys, key)
                        l.Remove(e)
                        e = l.Front()
                }
        }

        err := b.db.update(func(bucket kvdb.RwBucket) error {
                for e := l.Front(); e != nil; e = e.Next() {
                        pr, ok := e.Value.(*paymentResult)
                        if !ok {
                                return fmt.Errorf("wrong type %T (not "+
                                        "*paymentResult)", e.Value)
                        }

                        // Serialize result into key and value byte slices.
                        k, v, err := serializeResult(pr)
                        if err != nil {
                                return err
                        }

                        // Put into results bucket.
                        if err := bucket.Put(k, v); err != nil {
                                return err
                        }

                        storeCount++
                }

                // Prune oldest entries.
                for _, key := range delKeys {
                        if err := bucket.Delete([]byte(key)); err != nil {
                                return err
                        }
                        pruneCount++
                }

                return nil
        }, func() {
                storeCount, pruneCount = 0, 0
        })

        if err != nil {
                return err
        }

        log.Debugf("Stored mission control results: %d added, %d deleted",
                storeCount, pruneCount)

        // DB Update was successful, update the in-memory cache.
        for _, key := range delKeys {
                delete(b.keysMap, key)
                b.keys.Remove(b.keys.Front())
        }
        for e := l.Front(); e != nil; e = e.Next() {
                pr, ok := e.Value.(*paymentResult)
                if !ok {
                        return fmt.Errorf("wrong type %T (not *paymentResult)",
                                e.Value)
                }
                key := string(getResultKey(pr))
                b.keys.PushBack(key)
        }

        return nil
}

// getResultKey returns a byte slice representing a unique key for this payment
// result.
func getResultKey(rp *paymentResult) []byte {
        var keyBytes [8 + 8 + 33]byte

        // Identify records by a combination of time, payment id and sender pub
        // key. This allows importing mission control data from an external
        // source without key collisions and keeps the records sorted
        // chronologically.
        byteOrder.PutUint64(keyBytes[:], rp.timeReply.Val)
        byteOrder.PutUint64(keyBytes[8:], rp.id)
        copy(keyBytes[16:], rp.route.Val.sourcePubKey.Val[:])

        return keyBytes[:]
}

// failureMessage wraps the lnwire.FailureMessage interface such that we can
// apply a Record method and use the failureMessage in a TLV encoded type.
type failureMessage struct {
        lnwire.FailureMessage
}

// Record returns a TLV record that can be used to encode/decode a list of
// failureMessage to/from a TLV stream.
func (r *failureMessage) Record() tlv.Record {
        recordSize := func() uint64 {
                var (
                        b   bytes.Buffer
                        buf [8]byte
                )
                if err := encodeFailureMessage(&b, r, &buf); err != nil {
                        panic(err)
                }

                return uint64(len(b.Bytes()))
        }

        return tlv.MakeDynamicRecord(
                0, r, recordSize, encodeFailureMessage, decodeFailureMessage,
        )
}

func encodeFailureMessage(w io.Writer, val interface{}, _ *[8]byte) error {
        if v, ok := val.(*failureMessage); ok {
                var b bytes.Buffer
                err := lnwire.EncodeFailureMessage(&b, v.FailureMessage, 0)
                if err != nil {
                        return err
                }

                _, err = w.Write(b.Bytes())

                return err
        }

        return tlv.NewTypeForEncodingErr(val, "routing.failureMessage")
}

func decodeFailureMessage(r io.Reader, val interface{}, _ *[8]byte,
        l uint64) error {

        if v, ok := val.(*failureMessage); ok {
                msg, err := lnwire.DecodeFailureMessage(r, 0)
                if err != nil {
                        return err
                }

                *v = failureMessage{
                        FailureMessage: msg,
                }

                return nil
        }

        return tlv.NewTypeForDecodingErr(val, "routing.failureMessage", l, l)
}

1	package routing
2
3	import (
4	"bytes"
5	"container/list"
6	"encoding/binary"
7	"fmt"
8	"io"
9	"sync"
10	"time"
11
12	"github.com/lightningnetwork/lnd/kvdb"
13	"github.com/lightningnetwork/lnd/lnwire"
14	"github.com/lightningnetwork/lnd/tlv"
15	)
16
17	var (
18	// resultsKey is the fixed key under which the attempt results are
19	// stored.
20	resultsKey = []byte("missioncontrol-results")
21
22	// Big endian is the preferred byte order, due to cursor scans over
23	// integer keys iterating in order.
24	byteOrder = binary.BigEndian
25	)
26
27	// missionControlDB is an interface that defines the database methods that a
28	// single missionControlStore has access to. It allows the missionControlStore
29	// to be unaware of the overall DB structure and restricts its access to the DB
30	// by only providing it the bucket that it needs to care about.
31	type missionControlDB interface {
32	// update can be used to perform reads and writes on the given bucket.
33	update(f func(bkt kvdb.RwBucket) error, reset func()) error
34
35	// view can be used to perform reads on the given bucket.
36	view(f func(bkt kvdb.RBucket) error, reset func()) error
37
38	// purge will delete all the contents in this store.
39	purge() error
40	}
41
42	// missionControlStore is a bolt db based implementation of a mission control
43	// store. It stores the raw payment attempt data from which the internal mission
44	// controls state can be rederived on startup. This allows the mission control
45	// internal data structure to be changed without requiring a database migration.
46	// Also changes to mission control parameters can be applied to historical data.
47	// Finally, it enables importing raw data from an external source.
48	type missionControlStore struct {
49	done chan struct{}
50	wg sync.WaitGroup
51	db missionControlDB
52
53	// TODO(yy): Remove the usage of sync.Cond - we are better off using
54	// channes than a Cond as suggested in the official godoc.
55	//
56	// queueCond is signalled when items are put into the queue.
57	queueCond *sync.Cond
58
59	// queue stores all pending payment results not yet added to the store.
60	// Access is protected by the queueCond.L mutex.
61	queue *list.List
62
63	// keys holds the stored MC store item keys in the order of storage.
64	// We use this list when adding/deleting items from the database to
65	// avoid cursor use which may be slow in the remote DB case.
66	keys *list.List
67
68	// keysMap holds the stored MC store item keys. We use this map to check
69	// if a new payment result has already been stored.
70	keysMap map[string]struct{}
71
72	// maxRecords is the maximum amount of records we will store in the db.
73	maxRecords int
74
75	// flushInterval is the configured interval we use to store new results
76	// and delete outdated ones from the db.
77	flushInterval time.Duration
78	}
79
80	func newMissionControlStore(db missionControlDB, maxRecords int,
81	flushInterval time.Duration) (*missionControlStore, error) {	4✔
82		4✔
83	var (	4✔
84	keys *list.List	4✔
85	keysMap map[string]struct{}	4✔
86	)	4✔
87		4✔
88	// Create buckets if not yet existing.	4✔
89	err := db.update(func(resultsBucket kvdb.RwBucket) error {	8✔
90	// Collect all keys to be able to quickly calculate the	4✔
91	// difference when updating the DB state.	4✔
92	c := resultsBucket.ReadCursor()	4✔
93	for k, _ := c.First(); k != nil; k, _ = c.Next() {	8✔
94	keys.PushBack(string(k))	4✔
95	keysMap[string(k)] = struct{}{}	4✔
96	}	4✔
97
98	return nil	4✔
99	}, func() {	4✔
100	keys = list.New()	4✔
101	keysMap = make(map[string]struct{})	4✔
102	})	4✔
103	if err != nil {	4✔
104	return nil, err	×
105	}	×
106
107	log.Infof("Loaded %d mission control entries", len(keysMap))	4✔
108		4✔
109	return &missionControlStore{	4✔
110	done: make(chan struct{}),	4✔
111	db: db,	4✔
112	queueCond: sync.NewCond(&sync.Mutex{}),	4✔
113	queue: list.New(),	4✔
114	keys: keys,	4✔
115	keysMap: keysMap,	4✔
116	maxRecords: maxRecords,	4✔
117	flushInterval: flushInterval,	4✔
118	}, nil	4✔
119	}
120
121	// clear removes all results from the db.
122	func (b *missionControlStore) clear() error {	4✔
123	b.queueCond.L.Lock()	4✔
124	defer b.queueCond.L.Unlock()	4✔
125		4✔
126	if err := b.db.purge(); err != nil {	4✔
127	return err	×
128	}	×
129
130	b.queue = list.New()	4✔
131		4✔
132	return nil	4✔
133	}
134
135	// fetchAll returns all results currently stored in the database.
136	func (b missionControlStore) fetchAll() ([]paymentResult, error) {	4✔
137	var results []*paymentResult	4✔
138		4✔
139	err := b.db.view(func(resultBucket kvdb.RBucket) error {	8✔
140	results = make([]*paymentResult, 0)	4✔
141		4✔
142	return resultBucket.ForEach(func(k, v []byte) error {	8✔
143	result, err := deserializeResult(k, v)	4✔
144	if err != nil {	4✔
145	return err	×
146	}	×
147
148	results = append(results, result)	4✔
149		4✔
150	return nil	4✔
151	})
152
153	}, func() {	4✔
154	results = nil	4✔
155	})	4✔
156	if err != nil {	4✔
157	return nil, err	×
158	}	×
159
160	return results, nil	4✔
161	}
162
163	// serializeResult serializes a payment result and returns a key and value byte
164	// slice to insert into the bucket.
165	func serializeResult(rp *paymentResult) ([]byte, []byte, error) {	4✔
166	recordProducers := []tlv.RecordProducer{	4✔
167	&rp.timeFwd,	4✔
168	&rp.timeReply,	4✔
169	&rp.route,	4✔
170	}	4✔
171		4✔
172	rp.failure.WhenSome(	4✔
173	func(failure tlv.RecordT[tlv.TlvType3, paymentFailure]) {	8✔
174	recordProducers = append(recordProducers, &failure)	4✔
175	},	4✔
176	)
177
178	// Compose key that identifies this result.
179	key := getResultKey(rp)	4✔
180		4✔
181	var buff bytes.Buffer	4✔
182	err := lnwire.EncodeRecordsTo(	4✔
183	&buff, lnwire.ProduceRecordsSorted(recordProducers...),	4✔
184	)	4✔
185	if err != nil {	4✔
186	return nil, nil, err	×
187	}	×
188
189	return key, buff.Bytes(), err	4✔
190	}
191
192	// deserializeResult deserializes a payment result.
193	func deserializeResult(k, v []byte) (*paymentResult, error) {	4✔
194	// Parse payment id.	4✔
195	result := paymentResult{	4✔
196	id: byteOrder.Uint64(k[8:]),	4✔
197	}	4✔
198		4✔
199	failure := tlv.ZeroRecordT[tlv.TlvType3, paymentFailure]()	4✔
200	recordProducers := []tlv.RecordProducer{	4✔
201	&result.timeFwd,	4✔
202	&result.timeReply,	4✔
203	&result.route,	4✔
204	&failure,	4✔
205	}	4✔
206		4✔
207	r := bytes.NewReader(v)	4✔
208	typeMap, err := lnwire.DecodeRecords(	4✔
209	r, lnwire.ProduceRecordsSorted(recordProducers...)...,	4✔
210	)	4✔
211	if err != nil {	4✔
212	return nil, err	×
213	}	×
214
215	if _, ok := typeMap[result.failure.TlvType()]; ok {	8✔
216	result.failure = tlv.SomeRecordT(failure)	4✔
217	}	4✔
218
219	return &result, nil	4✔
220	}
221
222	// serializeRoute serializes a mcRoute and writes the resulting bytes to the
223	// given io.Writer.
224	func serializeRoute(w io.Writer, r *mcRoute) error {	4✔
225	records := lnwire.ProduceRecordsSorted(	4✔
226	&r.sourcePubKey,	4✔
227	&r.totalAmount,	4✔
228	&r.hops,	4✔
229	)	4✔
230		4✔
231	return lnwire.EncodeRecordsTo(w, records)	4✔
232	}	4✔
233
234	// deserializeRoute deserializes the mcRoute from the given io.Reader.
235	func deserializeRoute(r io.Reader) (*mcRoute, error) {	4✔
236	var rt mcRoute	4✔
237	records := lnwire.ProduceRecordsSorted(	4✔
238	&rt.sourcePubKey,	4✔
239	&rt.totalAmount,	4✔
240	&rt.hops,	4✔
241	)	4✔
242		4✔
243	_, err := lnwire.DecodeRecords(r, records...)	4✔
244	if err != nil {	4✔
245	return nil, err	×
246	}	×
247
248	return &rt, nil	4✔
249	}
250
251	// deserializeHop deserializes the mcHop from the given io.Reader.
252	func deserializeHop(r io.Reader) (*mcHop, error) {	4✔
253	var (	4✔
254	h mcHop	4✔
255	blinding = tlv.ZeroRecordT[tlv.TlvType3, lnwire.TrueBoolean]()	4✔
256	custom = tlv.ZeroRecordT[tlv.TlvType4, lnwire.TrueBoolean]()	4✔
257	)	4✔
258	records := lnwire.ProduceRecordsSorted(	4✔
259	&h.channelID,	4✔
260	&h.pubKeyBytes,	4✔
261	&h.amtToFwd,	4✔
262	&blinding,	4✔
263	&custom,	4✔
264	)	4✔
265		4✔
266	typeMap, err := lnwire.DecodeRecords(r, records...)	4✔
267	if err != nil {	4✔
268	return nil, err	×
269	}	×
270
271	if _, ok := typeMap[h.hasBlindingPoint.TlvType()]; ok {	8✔
272	h.hasBlindingPoint = tlv.SomeRecordT(blinding)	4✔
273	}	4✔
274
275	if _, ok := typeMap[h.hasCustomRecords.TlvType()]; ok {	8✔
276	h.hasCustomRecords = tlv.SomeRecordT(custom)	4✔
277	}	4✔
278
279	return &h, nil	4✔
280	}
281
282	// serializeHop serializes a mcHop and writes the resulting bytes to the given
283	// io.Writer.
284	func serializeHop(w io.Writer, h *mcHop) error {	4✔
285	recordProducers := []tlv.RecordProducer{	4✔
286	&h.channelID,	4✔
287	&h.pubKeyBytes,	4✔
288	&h.amtToFwd,	4✔
289	}	4✔
290		4✔
291	h.hasBlindingPoint.WhenSome(func(	4✔
292	hasBlinding tlv.RecordT[tlv.TlvType3, lnwire.TrueBoolean]) {	8✔
293		4✔
294	recordProducers = append(recordProducers, &hasBlinding)	4✔
295	})	4✔
296
297	h.hasCustomRecords.WhenSome(func(	4✔
298	hasCustom tlv.RecordT[tlv.TlvType4, lnwire.TrueBoolean]) {	8✔
299		4✔
300	recordProducers = append(recordProducers, &hasCustom)	4✔
301	})	4✔
302
303	return lnwire.EncodeRecordsTo(	4✔
304	w, lnwire.ProduceRecordsSorted(recordProducers...),	4✔
305	)	4✔
306	}
307
308	// AddResult adds a new result to the db.
309	func (b missionControlStore) AddResult(rp paymentResult) {	4✔
310	b.queueCond.L.Lock()	4✔
311	b.queue.PushBack(rp)	4✔
312	b.queueCond.L.Unlock()	4✔
313		4✔
314	b.queueCond.Signal()	4✔
315	}	4✔
316
317	// stop stops the store ticker goroutine.
318	func (b *missionControlStore) stop() {	4✔
319	close(b.done)	4✔
320		4✔
321	b.queueCond.Signal()	4✔
322		4✔
323	b.wg.Wait()	4✔
324	}	4✔
325
326	// run runs the MC store ticker goroutine.
327	func (b *missionControlStore) run() {	4✔
328	b.wg.Add(1)	4✔
329		4✔
330	go func() {	8✔
331	defer b.wg.Done()	4✔
332		4✔
333	timer := time.NewTimer(b.flushInterval)	4✔
334		4✔
335	// Immediately stop the timer. It will be started once new	4✔
336	// items are added to the store. As the doc for time.Timer	4✔
337	// states, every call to Stop() done on a timer that is not	4✔
338	// known to have been fired needs to be checked and the timer's	4✔
339	// channel needs to be drained appropriately. This could happen	4✔
340	// if the flushInterval is very small (e.g. 1 nanosecond).	4✔
341	if !timer.Stop() {	4✔
342	select {	×
343	case <-timer.C:	×
344	case <-b.done:	×
345	log.Debugf("Stopping mission control store")	×
346	}
347	}
348
349	for {	8✔
350	// Wait for the queue to not be empty.	4✔
351	b.queueCond.L.Lock()	4✔
352	for b.queue.Front() == nil {	8✔
353	// To make sure we can properly stop, we must	4✔
354	// read the `done` channel first before	4✔
355	// attempting to call `Wait()`. This is due to	4✔
356	// the fact when `Signal` is called before the	4✔
357	// `Wait` call, the `Wait` call will block	4✔
358	// indefinitely.	4✔
359	//	4✔
360	// TODO(yy): replace this with channels.	4✔
361	select {	4✔
362	case <-b.done:	4✔
363	b.queueCond.L.Unlock()	4✔
364		4✔
365	return	4✔
366	default:	4✔
367	}
368
369	b.queueCond.Wait()	4✔
370	}
371	b.queueCond.L.Unlock()	4✔
372		4✔
373	// Restart the timer.	4✔
374	timer.Reset(b.flushInterval)	4✔
375		4✔
376	select {	4✔
377	case <-timer.C:	4✔
378	if err := b.storeResults(); err != nil {	4✔
379	log.Errorf("Failed to update mission "+	×
380	"control store: %v", err)	×
381	}	×
382
383	case <-b.done:	4✔
384	// Release the timer's resources.	4✔
385	if !timer.Stop() {	4✔
386	select {	×
387	case <-timer.C:	×
388	case <-b.done:	×
389	log.Debugf("Mission control " +	×
390	"store stopped")	×
391	}
392	}
393	return	4✔
394	}
395	}
396	}()
397	}
398
399	// storeResults stores all accumulated results.
400	func (b *missionControlStore) storeResults() error {	4✔
401	// We copy a reference to the queue and clear the original queue to be	4✔
402	// able to release the lock.	4✔
403	b.queueCond.L.Lock()	4✔
404	l := b.queue	4✔
405		4✔
406	if l.Len() == 0 {	4✔
407	b.queueCond.L.Unlock()	×
408		×
409	return nil	×
410	}	×
411	b.queue = list.New()	4✔
412	b.queueCond.L.Unlock()	4✔
413		4✔
414	var (	4✔
415	newKeys map[string]struct{}	4✔
416	delKeys []string	4✔
417	storeCount int	4✔
418	pruneCount int	4✔
419	)	4✔
420		4✔
421	// Create a deduped list of new entries.	4✔
422	newKeys = make(map[string]struct{}, l.Len())	4✔
423	for e := l.Front(); e != nil; e = e.Next() {	8✔
424	pr, ok := e.Value.(*paymentResult)	4✔
425	if !ok {	4✔
426	return fmt.Errorf("wrong type %T (not *paymentResult)",	×
427	e.Value)	×
428	}	×
429	key := string(getResultKey(pr))	4✔
430	if _, ok := b.keysMap[key]; ok {	4✔
431	l.Remove(e)	×
432	continue	×
433	}
434	if _, ok := newKeys[key]; ok {	4✔
435	l.Remove(e)	×
436	continue	×
437	}
438	newKeys[key] = struct{}{}	4✔
439	}
440
441	// Create a list of entries to delete.
442	toDelete := b.keys.Len() + len(newKeys) - b.maxRecords	4✔
443	if b.maxRecords > 0 && toDelete > 0 {	4✔
444	delKeys = make([]string, 0, toDelete)	×
445		×
446	// Delete as many as needed from old keys.	×
447	for e := b.keys.Front(); len(delKeys) < toDelete && e != nil; {	×
448	key, ok := e.Value.(string)	×
449	if !ok {	×
450	return fmt.Errorf("wrong type %T (not string)",	×
451	e.Value)	×
452	}	×
453	delKeys = append(delKeys, key)	×
454	e = e.Next()	×
455	}
456
457	// If more deletions are needed, simply do not add from the
458	// list of new keys.
459	for e := l.Front(); len(delKeys) < toDelete && e != nil; {	×
460	toDelete--	×
461	pr, ok := e.Value.(*paymentResult)	×
462	if !ok {	×
463	return fmt.Errorf("wrong type %T (not "+	×
464	"*paymentResult )", e.Value)	×
465	}	×
466	key := string(getResultKey(pr))	×
467	delete(newKeys, key)	×
468	l.Remove(e)	×
469	e = l.Front()	×
470	}
471	}
472
473	err := b.db.update(func(bucket kvdb.RwBucket) error {	8✔
474	for e := l.Front(); e != nil; e = e.Next() {	8✔
475	pr, ok := e.Value.(*paymentResult)	4✔
476	if !ok {	4✔
477	return fmt.Errorf("wrong type %T (not "+	×
478	"*paymentResult)", e.Value)	×
479	}	×
480
481	// Serialize result into key and value byte slices.
482	k, v, err := serializeResult(pr)	4✔
483	if err != nil {	4✔
484	return err	×
485	}	×
486
487	// Put into results bucket.
488	if err := bucket.Put(k, v); err != nil {	4✔
489	return err	×
490	}	×
491
492	storeCount++	4✔
493	}
494
495	// Prune oldest entries.
496	for _, key := range delKeys {	4✔
497	if err := bucket.Delete([]byte(key)); err != nil {	×
498	return err	×
499	}	×
500	pruneCount++	×
501	}
502
503	return nil	4✔
504	}, func() {	4✔
505	storeCount, pruneCount = 0, 0	4✔
506	})	4✔
507
508	if err != nil {	4✔
509	return err	×
510	}	×
511
512	log.Debugf("Stored mission control results: %d added, %d deleted",	4✔
513	storeCount, pruneCount)	4✔
514		4✔
515	// DB Update was successful, update the in-memory cache.	4✔
516	for _, key := range delKeys {	4✔
517	delete(b.keysMap, key)	×
518	b.keys.Remove(b.keys.Front())	×
519	}	×
520	for e := l.Front(); e != nil; e = e.Next() {	8✔
521	pr, ok := e.Value.(*paymentResult)	4✔
522	if !ok {	4✔
523	return fmt.Errorf("wrong type %T (not *paymentResult)",	×
524	e.Value)	×
525	}	×
526	key := string(getResultKey(pr))	4✔
527	b.keys.PushBack(key)	4✔
528	}
529
530	return nil	4✔
531	}
532
533	// getResultKey returns a byte slice representing a unique key for this payment
534	// result.
535	func getResultKey(rp *paymentResult) []byte {	4✔
536	var keyBytes [8 + 8 + 33]byte	4✔
537		4✔
538	// Identify records by a combination of time, payment id and sender pub	4✔
539	// key. This allows importing mission control data from an external	4✔
540	// source without key collisions and keeps the records sorted	4✔
541	// chronologically.	4✔
542	byteOrder.PutUint64(keyBytes[:], rp.timeReply.Val)	4✔
543	byteOrder.PutUint64(keyBytes[8:], rp.id)	4✔
544	copy(keyBytes[16:], rp.route.Val.sourcePubKey.Val[:])	4✔
545		4✔
546	return keyBytes[:]	4✔
547	}	4✔
548
549	// failureMessage wraps the lnwire.FailureMessage interface such that we can
550	// apply a Record method and use the failureMessage in a TLV encoded type.
551	type failureMessage struct {
552	lnwire.FailureMessage
553	}
554
555	// Record returns a TLV record that can be used to encode/decode a list of
556	// failureMessage to/from a TLV stream.
557	func (r *failureMessage) Record() tlv.Record {	4✔
558	recordSize := func() uint64 {	8✔
559	var (	4✔
560	b bytes.Buffer	4✔
561	buf [8]byte	4✔
562	)	4✔
563	if err := encodeFailureMessage(&b, r, &buf); err != nil {	4✔
564	panic(err)	×
565	}
566
567	return uint64(len(b.Bytes()))	4✔
568	}
569
570	return tlv.MakeDynamicRecord(	4✔
571	0, r, recordSize, encodeFailureMessage, decodeFailureMessage,	4✔
572	)	4✔
573	}
574
575	func encodeFailureMessage(w io.Writer, val interface{}, _ *[8]byte) error {	4✔
576	if v, ok := val.(*failureMessage); ok {	8✔
577	var b bytes.Buffer	4✔
578	err := lnwire.EncodeFailureMessage(&b, v.FailureMessage, 0)	4✔
579	if err != nil {	4✔
580	return err	×
581	}	×
582
583	_, err = w.Write(b.Bytes())	4✔
584		4✔
585	return err	4✔
586	}
587
588	return tlv.NewTypeForEncodingErr(val, "routing.failureMessage")	×
589	}
590
591	func decodeFailureMessage(r io.Reader, val interface{}, _ *[8]byte,
592	l uint64) error {	4✔
593		4✔
594	if v, ok := val.(*failureMessage); ok {	8✔
595	msg, err := lnwire.DecodeFailureMessage(r, 0)	4✔
596	if err != nil {	4✔
597	return err	×
598	}	×
599
600	*v = failureMessage{	4✔
601	FailureMessage: msg,	4✔
602	}	4✔
603		4✔
604	return nil	4✔
605	}
606
607	return tlv.NewTypeForDecodingErr(val, "routing.failureMessage", l, l)	×
608	}

lightningnetwork / lnd / 12199391122

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous