9915780197

Committed 13 Jul 2024 12:30AM UTC coverage: 49.268% (-9.1%) from 58.413%

Build # 9915780197

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #8653 from ProofOfKeags/fn-prim

DynComms [0/n]: `fn` package additions

Run Details

92837 of 188433 relevant lines covered (49.27%)

1.55 hits per line

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

72.41

/routing/missioncontrol_state.go

package routing

import (
        "time"

        "github.com/lightningnetwork/lnd/routing/route"
)

// missionControlState is an object that manages the internal mission control
// state. Note that it isn't thread safe and synchronization needs to be
// enforced externally.
type missionControlState struct {
        // lastPairResult tracks the last payment result (on a pair basis) for
        // each transited node. This is a multi-layer map that allows us to look
        // up the failure history of all connected channels (node pairs) for a
        // particular node.
        lastPairResult map[route.Vertex]NodeResults

        // lastSecondChance tracks the last time a second chance was granted for
        // a directed node pair.
        lastSecondChance map[DirectedNodePair]time.Time

        // minFailureRelaxInterval is the minimum time that must have passed
        // since the previously recorded failure before the failure amount may
        // be raised.
        minFailureRelaxInterval time.Duration
}

// newMissionControlState instantiates a new mission control state object.
func newMissionControlState(
        minFailureRelaxInterval time.Duration) *missionControlState {

        return &missionControlState{
                lastPairResult:          make(map[route.Vertex]NodeResults),
                lastSecondChance:        make(map[DirectedNodePair]time.Time),
                minFailureRelaxInterval: minFailureRelaxInterval,
        }
}

// getLastPairResult returns the current state for connections to the given node.
func (m *missionControlState) getLastPairResult(node route.Vertex) (NodeResults,
        bool) {

        result, ok := m.lastPairResult[node]
        return result, ok
}

// ResetHistory resets the history of MissionControl returning it to a state as
// if no payment attempts have been made.
func (m *missionControlState) resetHistory() {
        m.lastPairResult = make(map[route.Vertex]NodeResults)
        m.lastSecondChance = make(map[DirectedNodePair]time.Time)
}

// setLastPairResult stores a result for a node pair.
func (m *missionControlState) setLastPairResult(fromNode, toNode route.Vertex,
        timestamp time.Time, result *pairResult, force bool) {

        nodePairs, ok := m.lastPairResult[fromNode]
        if !ok {
                nodePairs = make(NodeResults)
                m.lastPairResult[fromNode] = nodePairs
        }

        current := nodePairs[toNode]

        // Apply the new result to the existing data for this pair. If there is
        // no existing data, apply it to the default values for TimedPairResult.
        if result.success {
                successAmt := result.amt
                current.SuccessTime = timestamp

                // Only update the success amount if this amount is higher. This
                // prevents the success range from shrinking when there is no
                // reason to do so. For example: small amount probes shouldn't
                // affect a previous success for a much larger amount.
                if force || successAmt > current.SuccessAmt {
                        current.SuccessAmt = successAmt
                }

                // If the success amount goes into the failure range, move the
                // failure range up. Future attempts up to the success amount
                // are likely to succeed. We don't want to clear the failure
                // completely, because we haven't learnt much for amounts above
                // the current success amount.
                if force || (!current.FailTime.IsZero() &&
                        successAmt >= current.FailAmt) {

                        current.FailAmt = successAmt + 1
                }
        } else {
                // For failures we always want to update both the amount and the
                // time. Those need to relate to the same result, because the
                // time is used to gradually diminish the penalty for that
                // specific result. Updating the timestamp but not the amount
                // could cause a failure for a lower amount (a more severe
                // condition) to be revived as if it just happened.
                failAmt := result.amt

                // Drop result if it would increase the failure amount too soon
                // after a previous failure. This can happen if htlc results
                // come in out of order. This check makes it easier for payment
                // processes to converge to a final state.
                failInterval := timestamp.Sub(current.FailTime)
                if !force && failAmt > current.FailAmt &&
                        failInterval < m.minFailureRelaxInterval {

                        log.Debugf("Ignoring higher amount failure within min "+
                                "failure relaxation interval: prev_fail_amt=%v, "+
                                "fail_amt=%v, interval=%v",
                                current.FailAmt, failAmt, failInterval)

                        return
                }

                current.FailTime = timestamp
                current.FailAmt = failAmt

                switch {
                // The failure amount is set to zero when the failure is
                // amount-independent, meaning that the attempt would have
                // failed regardless of the amount. This should also reset the
                // success amount to zero.
                case failAmt == 0:
                        current.SuccessAmt = 0

                // If the failure range goes into the success range, move the
                // success range down.
                case failAmt <= current.SuccessAmt:
                        current.SuccessAmt = failAmt - 1
                }
        }

        log.Debugf("Setting %v->%v range to [%v-%v]",
                fromNode, toNode, current.SuccessAmt, current.FailAmt)

        nodePairs[toNode] = current
}

// setAllFail stores a fail result for all known connections to and from the
// given node.
func (m *missionControlState) setAllFail(node route.Vertex,
        timestamp time.Time) {

        for fromNode, nodePairs := range m.lastPairResult {
                for toNode := range nodePairs {
                        if fromNode == node || toNode == node {
                                nodePairs[toNode] = TimedPairResult{
                                        FailTime: timestamp,
                                }
                        }
                }
        }
}

// requestSecondChance checks whether the node fromNode can have a second chance
// at providing a channel update for its channel with toNode.
func (m *missionControlState) requestSecondChance(timestamp time.Time,
        fromNode, toNode route.Vertex) bool {

        // Look up previous second chance time.
        pair := DirectedNodePair{
                From: fromNode,
                To:   toNode,
        }
        lastSecondChance, ok := m.lastSecondChance[pair]

        // If the channel hasn't already be given a second chance or its last
        // second chance was long ago, we give it another chance.
        if !ok || timestamp.Sub(lastSecondChance) > minSecondChanceInterval {
                m.lastSecondChance[pair] = timestamp

                log.Debugf("Second chance granted for %v->%v", fromNode, toNode)

                return true
        }

        // Otherwise penalize the channel, because we don't allow channel
        // updates that are that frequent. This is to prevent nodes from keeping
        // us busy by continuously sending new channel updates.
        log.Debugf("Second chance denied for %v->%v, remaining interval: %v",
                fromNode, toNode, timestamp.Sub(lastSecondChance))

        return false
}

// GetHistorySnapshot takes a snapshot from the current mission control state
// and actual probability estimates.
func (m *missionControlState) getSnapshot() *MissionControlSnapshot {
        log.Debugf("Requesting history snapshot from mission control: "+
                "pair_result_count=%v", len(m.lastPairResult))

        pairs := make([]MissionControlPairSnapshot, 0, len(m.lastPairResult))

        for fromNode, fromPairs := range m.lastPairResult {
                for toNode, result := range fromPairs {
                        pair := NewDirectedNodePair(fromNode, toNode)

                        pairSnapshot := MissionControlPairSnapshot{
                                Pair:            pair,
                                TimedPairResult: result,
                        }

                        pairs = append(pairs, pairSnapshot)
                }
        }

        snapshot := MissionControlSnapshot{
                Pairs: pairs,
        }

        return &snapshot
}

// importSnapshot takes an existing snapshot and merges it with our current
// state if the result provided are fresher than our current results. It returns
// the number of pairs that were used.
func (m *missionControlState) importSnapshot(snapshot *MissionControlSnapshot,
        force bool) int {

        var imported int

        for _, pair := range snapshot.Pairs {
                fromNode := pair.Pair.From
                toNode := pair.Pair.To

                results, found := m.getLastPairResult(fromNode)
                if !found {
                        results = make(map[route.Vertex]TimedPairResult)
                }

                lastResult := results[toNode]

                failResult := failPairResult(pair.FailAmt)
                imported += m.importResult(
                        lastResult.FailTime, pair.FailTime, failResult,
                        fromNode, toNode, force,
                )

                successResult := successPairResult(pair.SuccessAmt)
                imported += m.importResult(
                        lastResult.SuccessTime, pair.SuccessTime, successResult,
                        fromNode, toNode, force,
                )
        }

        return imported
}

func (m *missionControlState) importResult(currentTs, importedTs time.Time,
        importedResult pairResult, fromNode, toNode route.Vertex,
        force bool) int {

        if !force && currentTs.After(importedTs) {
                log.Debugf("Not setting pair result for %v->%v (%v) "+
                        "success=%v, timestamp %v older than last result %v",
                        fromNode, toNode, importedResult.amt,
                        importedResult.success, importedTs, currentTs)

                return 0
        }

        m.setLastPairResult(
                fromNode, toNode, importedTs, &importedResult, force,
        )

        return 1
}

1	package routing
2
3	import (
4	"time"
5
6	"github.com/lightningnetwork/lnd/routing/route"
7	)
8
9	// missionControlState is an object that manages the internal mission control
10	// state. Note that it isn't thread safe and synchronization needs to be
11	// enforced externally.
12	type missionControlState struct {
13	// lastPairResult tracks the last payment result (on a pair basis) for
14	// each transited node. This is a multi-layer map that allows us to look
15	// up the failure history of all connected channels (node pairs) for a
16	// particular node.
17	lastPairResult map[route.Vertex]NodeResults
18
19	// lastSecondChance tracks the last time a second chance was granted for
20	// a directed node pair.
21	lastSecondChance map[DirectedNodePair]time.Time
22
23	// minFailureRelaxInterval is the minimum time that must have passed
24	// since the previously recorded failure before the failure amount may
25	// be raised.
26	minFailureRelaxInterval time.Duration
27	}
28
29	// newMissionControlState instantiates a new mission control state object.
30	func newMissionControlState(
31	minFailureRelaxInterval time.Duration) *missionControlState {	3✔
32		3✔
33	return &missionControlState{	3✔
34	lastPairResult: make(map[route.Vertex]NodeResults),	3✔
35	lastSecondChance: make(map[DirectedNodePair]time.Time),	3✔
36	minFailureRelaxInterval: minFailureRelaxInterval,	3✔
37	}	3✔
38	}	3✔
39
40	// getLastPairResult returns the current state for connections to the given node.
41	func (m *missionControlState) getLastPairResult(node route.Vertex) (NodeResults,
42	bool) {	3✔
43		3✔
44	result, ok := m.lastPairResult[node]	3✔
45	return result, ok	3✔
46	}	3✔
47
48	// ResetHistory resets the history of MissionControl returning it to a state as
49	// if no payment attempts have been made.
50	func (m *missionControlState) resetHistory() {	3✔
51	m.lastPairResult = make(map[route.Vertex]NodeResults)	3✔
52	m.lastSecondChance = make(map[DirectedNodePair]time.Time)	3✔
53	}	3✔
54
55	// setLastPairResult stores a result for a node pair.
56	func (m *missionControlState) setLastPairResult(fromNode, toNode route.Vertex,
57	timestamp time.Time, result *pairResult, force bool) {	3✔
58		3✔
59	nodePairs, ok := m.lastPairResult[fromNode]	3✔
60	if !ok {	6✔
61	nodePairs = make(NodeResults)	3✔
62	m.lastPairResult[fromNode] = nodePairs	3✔
63	}	3✔
64
65	current := nodePairs[toNode]	3✔
66		3✔
67	// Apply the new result to the existing data for this pair. If there is	3✔
68	// no existing data, apply it to the default values for TimedPairResult.	3✔
69	if result.success {	6✔
70	successAmt := result.amt	3✔
71	current.SuccessTime = timestamp	3✔
72		3✔
73	// Only update the success amount if this amount is higher. This	3✔
74	// prevents the success range from shrinking when there is no	3✔
75	// reason to do so. For example: small amount probes shouldn't	3✔
76	// affect a previous success for a much larger amount.	3✔
77	if force \|\| successAmt > current.SuccessAmt {	6✔
78	current.SuccessAmt = successAmt	3✔
79	}	3✔
80
81	// If the success amount goes into the failure range, move the
82	// failure range up. Future attempts up to the success amount
83	// are likely to succeed. We don't want to clear the failure
84	// completely, because we haven't learnt much for amounts above
85	// the current success amount.
86	if force \|\| (!current.FailTime.IsZero() &&	3✔
87	successAmt >= current.FailAmt) {	6✔
88		3✔
89	current.FailAmt = successAmt + 1	3✔
90	}	3✔
91	} else {	3✔
92	// For failures we always want to update both the amount and the	3✔
93	// time. Those need to relate to the same result, because the	3✔
94	// time is used to gradually diminish the penalty for that	3✔
95	// specific result. Updating the timestamp but not the amount	3✔
96	// could cause a failure for a lower amount (a more severe	3✔
97	// condition) to be revived as if it just happened.	3✔
98	failAmt := result.amt	3✔
99		3✔
100	// Drop result if it would increase the failure amount too soon	3✔
101	// after a previous failure. This can happen if htlc results	3✔
102	// come in out of order. This check makes it easier for payment	3✔
103	// processes to converge to a final state.	3✔
104	failInterval := timestamp.Sub(current.FailTime)	3✔
105	if !force && failAmt > current.FailAmt &&	3✔
106	failInterval < m.minFailureRelaxInterval {	3✔
107		×
108	log.Debugf("Ignoring higher amount failure within min "+	×
109	"failure relaxation interval: prev_fail_amt=%v, "+	×
110	"fail_amt=%v, interval=%v",	×
111	current.FailAmt, failAmt, failInterval)	×
112		×
113	return	×
114	}	×
115
116	current.FailTime = timestamp	3✔
117	current.FailAmt = failAmt	3✔
118		3✔
119	switch {	3✔
120	// The failure amount is set to zero when the failure is
121	// amount-independent, meaning that the attempt would have
122	// failed regardless of the amount. This should also reset the
123	// success amount to zero.
124	case failAmt == 0:	3✔
125	current.SuccessAmt = 0	3✔
126
127	// If the failure range goes into the success range, move the
128	// success range down.
129	case failAmt <= current.SuccessAmt:	×
130	current.SuccessAmt = failAmt - 1	×
131	}
132	}
133
134	log.Debugf("Setting %v->%v range to [%v-%v]",	3✔
135	fromNode, toNode, current.SuccessAmt, current.FailAmt)	3✔
136		3✔
137	nodePairs[toNode] = current	3✔
138	}
139
140	// setAllFail stores a fail result for all known connections to and from the
141	// given node.
142	func (m *missionControlState) setAllFail(node route.Vertex,
143	timestamp time.Time) {	×
144		×
145	for fromNode, nodePairs := range m.lastPairResult {	×
146	for toNode := range nodePairs {	×
147	if fromNode == node \|\| toNode == node {	×
148	nodePairs[toNode] = TimedPairResult{	×
149	FailTime: timestamp,	×
150	}	×
151	}	×
152	}
153	}
154	}
155
156	// requestSecondChance checks whether the node fromNode can have a second chance
157	// at providing a channel update for its channel with toNode.
158	func (m *missionControlState) requestSecondChance(timestamp time.Time,
159	fromNode, toNode route.Vertex) bool {	3✔
160		3✔
161	// Look up previous second chance time.	3✔
162	pair := DirectedNodePair{	3✔
163	From: fromNode,	3✔
164	To: toNode,	3✔
165	}	3✔
166	lastSecondChance, ok := m.lastSecondChance[pair]	3✔
167		3✔
168	// If the channel hasn't already be given a second chance or its last	3✔
169	// second chance was long ago, we give it another chance.	3✔
170	if !ok \|\| timestamp.Sub(lastSecondChance) > minSecondChanceInterval {	6✔
171	m.lastSecondChance[pair] = timestamp	3✔
172		3✔
173	log.Debugf("Second chance granted for %v->%v", fromNode, toNode)	3✔
174		3✔
175	return true	3✔
176	}	3✔
177
178	// Otherwise penalize the channel, because we don't allow channel
179	// updates that are that frequent. This is to prevent nodes from keeping
180	// us busy by continuously sending new channel updates.
181	log.Debugf("Second chance denied for %v->%v, remaining interval: %v",	3✔
182	fromNode, toNode, timestamp.Sub(lastSecondChance))	3✔
183		3✔
184	return false	3✔
185	}
186
187	// GetHistorySnapshot takes a snapshot from the current mission control state
188	// and actual probability estimates.
189	func (m missionControlState) getSnapshot() MissionControlSnapshot {	×
190	log.Debugf("Requesting history snapshot from mission control: "+	×
191	"pair_result_count=%v", len(m.lastPairResult))	×
192		×
193	pairs := make([]MissionControlPairSnapshot, 0, len(m.lastPairResult))	×
194		×
195	for fromNode, fromPairs := range m.lastPairResult {	×
196	for toNode, result := range fromPairs {	×
197	pair := NewDirectedNodePair(fromNode, toNode)	×
198		×
199	pairSnapshot := MissionControlPairSnapshot{	×
200	Pair: pair,	×
201	TimedPairResult: result,	×
202	}	×
203		×
204	pairs = append(pairs, pairSnapshot)	×
205	}	×
206	}
207
208	snapshot := MissionControlSnapshot{	×
209	Pairs: pairs,	×
210	}	×
211		×
212	return &snapshot	×
213	}
214
215	// importSnapshot takes an existing snapshot and merges it with our current
216	// state if the result provided are fresher than our current results. It returns
217	// the number of pairs that were used.
218	func (m missionControlState) importSnapshot(snapshot MissionControlSnapshot,
219	force bool) int {	3✔
220		3✔
221	var imported int	3✔
222		3✔
223	for _, pair := range snapshot.Pairs {	6✔
224	fromNode := pair.Pair.From	3✔
225	toNode := pair.Pair.To	3✔
226		3✔
227	results, found := m.getLastPairResult(fromNode)	3✔
228	if !found {	6✔
229	results = make(map[route.Vertex]TimedPairResult)	3✔
230	}	3✔
231
232	lastResult := results[toNode]	3✔
233		3✔
234	failResult := failPairResult(pair.FailAmt)	3✔
235	imported += m.importResult(	3✔
236	lastResult.FailTime, pair.FailTime, failResult,	3✔
237	fromNode, toNode, force,	3✔
238	)	3✔
239		3✔
240	successResult := successPairResult(pair.SuccessAmt)	3✔
241	imported += m.importResult(	3✔
242	lastResult.SuccessTime, pair.SuccessTime, successResult,	3✔
243	fromNode, toNode, force,	3✔
244	)	3✔
245	}
246
247	return imported	3✔
248	}
249
250	func (m *missionControlState) importResult(currentTs, importedTs time.Time,
251	importedResult pairResult, fromNode, toNode route.Vertex,
252	force bool) int {	3✔
253		3✔
254	if !force && currentTs.After(importedTs) {	3✔
255	log.Debugf("Not setting pair result for %v->%v (%v) "+	×
256	"success=%v, timestamp %v older than last result %v",	×
257	fromNode, toNode, importedResult.amt,	×
258	importedResult.success, importedTs, currentTs)	×
259		×
260	return 0	×
261	}	×
262
263	m.setLastPairResult(	3✔
264	fromNode, toNode, importedTs, &importedResult, force,	3✔
265	)	3✔
266		3✔
267	return 1	3✔
268	}

lightningnetwork / lnd / 9915780197

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