13423774416

Committed 19 Feb 2025 10:39PM UTC coverage: 49.338% (-9.5%) from 58.794%

Build # 13423774416

Build Type

Pull #9484

github

Committed by

Abdulkbk

Commit Message

lnutils: add createdir util function

This utility function replaces repetitive logic patterns
throughout LND.

Pull Request Pull Request #9484: lnutils: add createDir util function

Run Details

0 of 13 new or added lines in 1 file covered. (0.0%)

27149 existing lines in 431 files now uncovered.

100732 of 204168 relevant lines covered (49.34%)

1.54 hits per line

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

77.08

/graph/db/graph_cache.go

package graphdb

import (
        "fmt"
        "sync"

        "github.com/btcsuite/btcd/btcutil"
        "github.com/lightningnetwork/lnd/graph/db/models"
        "github.com/lightningnetwork/lnd/kvdb"
        "github.com/lightningnetwork/lnd/lnwire"
        "github.com/lightningnetwork/lnd/routing/route"
)

// GraphCacheNode is an interface for all the information the cache needs to know
// about a lightning node.
type GraphCacheNode interface {
        // PubKey is the node's public identity key.
        PubKey() route.Vertex

        // Features returns the node's p2p features.
        Features() *lnwire.FeatureVector

        // ForEachChannel iterates through all channels of a given node,
        // executing the passed callback with an edge info structure and the
        // policies of each end of the channel. The first edge policy is the
        // outgoing edge *to* the connecting node, while the second is the
        // incoming edge *from* the connecting node. If the callback returns an
        // error, then the iteration is halted with the error propagated back up
        // to the caller.
        ForEachChannel(kvdb.RTx,
                func(kvdb.RTx, *models.ChannelEdgeInfo,
                        *models.ChannelEdgePolicy,
                        *models.ChannelEdgePolicy) error) error
}

// DirectedChannel is a type that stores the channel information as seen from
// one side of the channel.
type DirectedChannel struct {
        // ChannelID is the unique identifier of this channel.
        ChannelID uint64

        // IsNode1 indicates if this is the node with the smaller public key.
        IsNode1 bool

        // OtherNode is the public key of the node on the other end of this
        // channel.
        OtherNode route.Vertex

        // Capacity is the announced capacity of this channel in satoshis.
        Capacity btcutil.Amount

        // OutPolicySet is a boolean that indicates whether the node has an
        // outgoing policy set. For pathfinding only the existence of the policy
        // is important to know, not the actual content.
        OutPolicySet bool

        // InPolicy is the incoming policy *from* the other node to this node.
        // In path finding, we're walking backward from the destination to the
        // source, so we're always interested in the edge that arrives to us
        // from the other node.
        InPolicy *models.CachedEdgePolicy

        // Inbound fees of this node.
        InboundFee lnwire.Fee
}

// DeepCopy creates a deep copy of the channel, including the incoming policy.
func (c *DirectedChannel) DeepCopy() *DirectedChannel {
        channelCopy := *c

        if channelCopy.InPolicy != nil {
                inPolicyCopy := *channelCopy.InPolicy
                channelCopy.InPolicy = &inPolicyCopy

                // The fields for the ToNode can be overwritten by the path
                // finding algorithm, which is why we need a deep copy in the
                // first place. So we always start out with nil values, just to
                // be sure they don't contain any old data.
                channelCopy.InPolicy.ToNodePubKey = nil
                channelCopy.InPolicy.ToNodeFeatures = nil
        }

        return &channelCopy
}

// GraphCache is a type that holds a minimal set of information of the public
// channel graph that can be used for pathfinding.
type GraphCache struct {
        nodeChannels map[route.Vertex]map[uint64]*DirectedChannel
        nodeFeatures map[route.Vertex]*lnwire.FeatureVector

        mtx sync.RWMutex
}

// NewGraphCache creates a new graphCache.
func NewGraphCache(preAllocNumNodes int) *GraphCache {
        return &GraphCache{
                nodeChannels: make(
                        map[route.Vertex]map[uint64]*DirectedChannel,
                        // A channel connects two nodes, so we can look it up
                        // from both sides, meaning we get double the number of
                        // entries.
                        preAllocNumNodes*2,
                ),
                nodeFeatures: make(
                        map[route.Vertex]*lnwire.FeatureVector,
                        preAllocNumNodes,
                ),
        }
}

// Stats returns statistics about the current cache size.
func (c *GraphCache) Stats() string {
        c.mtx.RLock()
        defer c.mtx.RUnlock()

        numChannels := 0
        for node := range c.nodeChannels {
                numChannels += len(c.nodeChannels[node])
        }
        return fmt.Sprintf("num_node_features=%d, num_nodes=%d, "+
                "num_channels=%d", len(c.nodeFeatures), len(c.nodeChannels),
                numChannels)
}

// AddNodeFeatures adds a graph node and its features to the cache.
func (c *GraphCache) AddNodeFeatures(node GraphCacheNode) {
        nodePubKey := node.PubKey()

        // Only hold the lock for a short time. The `ForEachChannel()` below is
        // possibly slow as it has to go to the backend, so we can unlock
        // between the calls. And the AddChannel() method will acquire its own
        // lock anyway.
        c.mtx.Lock()
        c.nodeFeatures[nodePubKey] = node.Features()
        c.mtx.Unlock()
}

// AddNode adds a graph node, including all the (directed) channels of that
// node.
func (c *GraphCache) AddNode(tx kvdb.RTx, node GraphCacheNode) error {
        c.AddNodeFeatures(node)

        return node.ForEachChannel(
                tx, func(tx kvdb.RTx, info *models.ChannelEdgeInfo,
                        outPolicy *models.ChannelEdgePolicy,
                        inPolicy *models.ChannelEdgePolicy) error {

                        c.AddChannel(info, outPolicy, inPolicy)

                        return nil
                },
        )
}

// AddChannel adds a non-directed channel, meaning that the order of policy 1
// and policy 2 does not matter, the directionality is extracted from the info
// and policy flags automatically. The policy will be set as the outgoing policy
// on one node and the incoming policy on the peer's side.
func (c *GraphCache) AddChannel(info *models.ChannelEdgeInfo,
        policy1 *models.ChannelEdgePolicy, policy2 *models.ChannelEdgePolicy) {

        if info == nil {
                return
        }

        if policy1 != nil && policy1.IsDisabled() &&
                policy2 != nil && policy2.IsDisabled() {

                return
        }

        // Create the edge entry for both nodes.
        c.mtx.Lock()
        c.updateOrAddEdge(info.NodeKey1Bytes, &DirectedChannel{
                ChannelID: info.ChannelID,
                IsNode1:   true,
                OtherNode: info.NodeKey2Bytes,
                Capacity:  info.Capacity,
        })
        c.updateOrAddEdge(info.NodeKey2Bytes, &DirectedChannel{
                ChannelID: info.ChannelID,
                IsNode1:   false,
                OtherNode: info.NodeKey1Bytes,
                Capacity:  info.Capacity,
        })
        c.mtx.Unlock()

        // The policy's node is always the to_node. So if policy 1 has to_node
        // of node 2 then we have the policy 1 as seen from node 1.
        if policy1 != nil {
                fromNode, toNode := info.NodeKey1Bytes, info.NodeKey2Bytes
                if policy1.ToNode != info.NodeKey2Bytes {
                        fromNode, toNode = toNode, fromNode
                }
                isEdge1 := policy1.ChannelFlags&lnwire.ChanUpdateDirection == 0
                c.UpdatePolicy(policy1, fromNode, toNode, isEdge1)
        }
        if policy2 != nil {
                fromNode, toNode := info.NodeKey2Bytes, info.NodeKey1Bytes
                if policy2.ToNode != info.NodeKey1Bytes {
                        fromNode, toNode = toNode, fromNode
                }
                isEdge1 := policy2.ChannelFlags&lnwire.ChanUpdateDirection == 0
                c.UpdatePolicy(policy2, fromNode, toNode, isEdge1)
        }
}

// updateOrAddEdge makes sure the edge information for a node is either updated
// if it already exists or is added to that node's list of channels.
func (c *GraphCache) updateOrAddEdge(node route.Vertex, edge *DirectedChannel) {
        if len(c.nodeChannels[node]) == 0 {
                c.nodeChannels[node] = make(map[uint64]*DirectedChannel)
        }

        c.nodeChannels[node][edge.ChannelID] = edge
}

// UpdatePolicy updates a single policy on both the from and to node. The order
// of the from and to node is not strictly important. But we assume that a
// channel edge was added beforehand so that the directed channel struct already
// exists in the cache.
func (c *GraphCache) UpdatePolicy(policy *models.ChannelEdgePolicy, fromNode,
        toNode route.Vertex, edge1 bool) {

        // Extract inbound fee if possible and available. If there is a decoding
        // error, ignore this policy.
        var inboundFee lnwire.Fee
        _, err := policy.ExtraOpaqueData.ExtractRecords(&inboundFee)
        if err != nil {
                log.Errorf("Failed to extract records from edge policy %v: %v",
                        policy.ChannelID, err)

                return
        }

        c.mtx.Lock()
        defer c.mtx.Unlock()

        updatePolicy := func(nodeKey route.Vertex) {
                if len(c.nodeChannels[nodeKey]) == 0 {
                        log.Warnf("Node=%v not found in graph cache", nodeKey)

                        return
                }

                channel, ok := c.nodeChannels[nodeKey][policy.ChannelID]
                if !ok {
                        log.Warnf("Channel=%v not found in graph cache",
                                policy.ChannelID)

                        return
                }

                // Edge 1 is defined as the policy for the direction of node1 to
                // node2.
                switch {
                // This is node 1, and it is edge 1, so this is the outgoing
                // policy for node 1.
                case channel.IsNode1 && edge1:
                        channel.OutPolicySet = true
                        channel.InboundFee = inboundFee

                // This is node 2, and it is edge 2, so this is the outgoing
                // policy for node 2.
                case !channel.IsNode1 && !edge1:
                        channel.OutPolicySet = true
                        channel.InboundFee = inboundFee

                // The other two cases left mean it's the inbound policy for the
                // node.
                default:
                        channel.InPolicy = models.NewCachedPolicy(policy)
                }
        }

        updatePolicy(fromNode)
        updatePolicy(toNode)
}

// RemoveNode completely removes a node and all its channels (including the
// peer's side).
func (c *GraphCache) RemoveNode(node route.Vertex) {
        c.mtx.Lock()
        defer c.mtx.Unlock()

        delete(c.nodeFeatures, node)

        // First remove all channels from the other nodes' lists.
        for _, channel := range c.nodeChannels[node] {
                c.removeChannelIfFound(channel.OtherNode, channel.ChannelID)
        }

        // Then remove our whole node completely.
        delete(c.nodeChannels, node)
}

// RemoveChannel removes a single channel between two nodes.
func (c *GraphCache) RemoveChannel(node1, node2 route.Vertex, chanID uint64) {
        c.mtx.Lock()
        defer c.mtx.Unlock()

        // Remove that one channel from both sides.
        c.removeChannelIfFound(node1, chanID)
        c.removeChannelIfFound(node2, chanID)
}

// removeChannelIfFound removes a single channel from one side.
func (c *GraphCache) removeChannelIfFound(node route.Vertex, chanID uint64) {
        if len(c.nodeChannels[node]) == 0 {
                return
        }

        delete(c.nodeChannels[node], chanID)
}

// UpdateChannel updates the channel edge information for a specific edge. We
// expect the edge to already exist and be known. If it does not yet exist, this
// call is a no-op.
func (c *GraphCache) UpdateChannel(info *models.ChannelEdgeInfo) {
        c.mtx.Lock()
        defer c.mtx.Unlock()

        if len(c.nodeChannels[info.NodeKey1Bytes]) == 0 ||
                len(c.nodeChannels[info.NodeKey2Bytes]) == 0 {

                return
        }

        channel, ok := c.nodeChannels[info.NodeKey1Bytes][info.ChannelID]
        if ok {
                // We only expect to be called when the channel is already
                // known.
                channel.Capacity = info.Capacity
                channel.OtherNode = info.NodeKey2Bytes
        }

        channel, ok = c.nodeChannels[info.NodeKey2Bytes][info.ChannelID]
        if ok {
                channel.Capacity = info.Capacity
                channel.OtherNode = info.NodeKey1Bytes
        }
}

// getChannels returns a copy of the passed node's channels or nil if there
// isn't any.
func (c *GraphCache) getChannels(node route.Vertex) []*DirectedChannel {
        c.mtx.RLock()
        defer c.mtx.RUnlock()

        channels, ok := c.nodeChannels[node]
        if !ok {
                return nil
        }

        features, ok := c.nodeFeatures[node]
        if !ok {
                // If the features were set to nil explicitly, that's fine here.
                // The router will overwrite the features of the destination
                // node with those found in the invoice if necessary. But if we
                // didn't yet get a node announcement we want to mimic the
                // behavior of the old DB based code that would always set an
                // empty feature vector instead of leaving it nil.
                features = lnwire.EmptyFeatureVector()
        }

        toNodeCallback := func() route.Vertex {
                return node
        }

        i := 0
        channelsCopy := make([]*DirectedChannel, len(channels))
        for _, channel := range channels {
                // We need to copy the channel and policy to avoid it being
                // updated in the cache if the path finding algorithm sets
                // fields on it (currently only the ToNodeFeatures of the
                // policy).
                channelCopy := channel.DeepCopy()
                if channelCopy.InPolicy != nil {
                        channelCopy.InPolicy.ToNodePubKey = toNodeCallback
                        channelCopy.InPolicy.ToNodeFeatures = features
                }

                channelsCopy[i] = channelCopy
                i++
        }

        return channelsCopy
}

// ForEachChannel invokes the given callback for each channel of the given node.
func (c *GraphCache) ForEachChannel(node route.Vertex,
        cb func(channel *DirectedChannel) error) error {

        // Obtain a copy of the node's channels. We need do this in order to
        // avoid deadlocks caused by interaction with the graph cache, channel
        // state and the graph database from multiple goroutines. This snapshot
        // is only used for path finding where being stale is acceptable since
        // the real world graph and our representation may always become
        // slightly out of sync for a short time and the actual channel state
        // is stored separately.
        channels := c.getChannels(node)
        for _, channel := range channels {
                if err := cb(channel); err != nil {
                        return err
                }
        }

        return nil
}

// ForEachNode iterates over the adjacency list of the graph, executing the
// call back for each node and the set of channels that emanate from the given
// node.
//
// NOTE: This method should be considered _read only_, the channels or nodes
// passed in MUST NOT be modified.
func (c *GraphCache) ForEachNode(cb func(node route.Vertex,
        channels map[uint64]*DirectedChannel) error) error {

        c.mtx.RLock()
        defer c.mtx.RUnlock()

        for node, channels := range c.nodeChannels {
                // We don't make a copy here since this is a read-only RPC
                // call. We also don't need the node features either for this
                // call.
                if err := cb(node, channels); err != nil {
                        return err
                }
        }

        return nil
}

// GetFeatures returns the features of the node with the given ID. If no
// features are known for the node, an empty feature vector is returned.
func (c *GraphCache) GetFeatures(node route.Vertex) *lnwire.FeatureVector {
        c.mtx.RLock()
        defer c.mtx.RUnlock()

        features, ok := c.nodeFeatures[node]
        if !ok || features == nil {
                // The router expects the features to never be nil, so we return
                // an empty feature set instead.
                return lnwire.EmptyFeatureVector()
        }

        return features
}

1	package graphdb
2
3	import (
4	"fmt"
5	"sync"
6
7	"github.com/btcsuite/btcd/btcutil"
8	"github.com/lightningnetwork/lnd/graph/db/models"
9	"github.com/lightningnetwork/lnd/kvdb"
10	"github.com/lightningnetwork/lnd/lnwire"
11	"github.com/lightningnetwork/lnd/routing/route"
12	)
13
14	// GraphCacheNode is an interface for all the information the cache needs to know
15	// about a lightning node.
16	type GraphCacheNode interface {
17	// PubKey is the node's public identity key.
18	PubKey() route.Vertex
19
20	// Features returns the node's p2p features.
21	Features() *lnwire.FeatureVector
22
23	// ForEachChannel iterates through all channels of a given node,
24	// executing the passed callback with an edge info structure and the
25	// policies of each end of the channel. The first edge policy is the
26	// outgoing edge to the connecting node, while the second is the
27	// incoming edge from the connecting node. If the callback returns an
28	// error, then the iteration is halted with the error propagated back up
29	// to the caller.
30	ForEachChannel(kvdb.RTx,
31	func(kvdb.RTx, *models.ChannelEdgeInfo,
32	*models.ChannelEdgePolicy,
33	*models.ChannelEdgePolicy) error) error
34	}
35
36	// DirectedChannel is a type that stores the channel information as seen from
37	// one side of the channel.
38	type DirectedChannel struct {
39	// ChannelID is the unique identifier of this channel.
40	ChannelID uint64
41
42	// IsNode1 indicates if this is the node with the smaller public key.
43	IsNode1 bool
44
45	// OtherNode is the public key of the node on the other end of this	3✔
46	// channel.	3✔
47	OtherNode route.Vertex	3✔
48		6✔
49	// Capacity is the announced capacity of this channel in satoshis.	3✔
50	Capacity btcutil.Amount	3✔
51		3✔
52	// OutPolicySet is a boolean that indicates whether the node has an	3✔
53	// outgoing policy set. For pathfinding only the existence of the policy	3✔
54	// is important to know, not the actual content.	3✔
55	OutPolicySet bool	3✔
56		3✔
57	// InPolicy is the incoming policy from the other node to this node.	3✔
58	// In path finding, we're walking backward from the destination to the	3✔
59	// source, so we're always interested in the edge that arrives to us
60	// from the other node.	3✔
61	InPolicy *models.CachedEdgePolicy
62
63	// Inbound fees of this node.
64	InboundFee lnwire.Fee
65	}
66
67	// DeepCopy creates a deep copy of the channel, including the incoming policy.
68	func (c DirectedChannel) DeepCopy() DirectedChannel {
69	channelCopy := *c
70
71	if channelCopy.InPolicy != nil {
72	inPolicyCopy := *channelCopy.InPolicy
73	channelCopy.InPolicy = &inPolicyCopy	3✔
74		3✔
75	// The fields for the ToNode can be overwritten by the path	3✔
76	// finding algorithm, which is why we need a deep copy in the	3✔
77	// first place. So we always start out with nil values, just to	3✔
78	// be sure they don't contain any old data.	3✔
79	channelCopy.InPolicy.ToNodePubKey = nil	3✔
80	channelCopy.InPolicy.ToNodeFeatures = nil	3✔
81	}	3✔
82		3✔
83	return &channelCopy	3✔
84	}	3✔
85		3✔
86	// GraphCache is a type that holds a minimal set of information of the public	3✔
87	// channel graph that can be used for pathfinding.	3✔
88	type GraphCache struct {
89	nodeChannels map[route.Vertex]map[uint64]*DirectedChannel
90	nodeFeatures map[route.Vertex]*lnwire.FeatureVector	3✔
91		3✔
92	mtx sync.RWMutex	3✔
93	}	3✔
94		3✔
95	// NewGraphCache creates a new graphCache.	6✔
96	func NewGraphCache(preAllocNumNodes int) *GraphCache {	3✔
97	return &GraphCache{	3✔
98	nodeChannels: make(	3✔
99	map[route.Vertex]map[uint64]*DirectedChannel,	3✔
100	// A channel connects two nodes, so we can look it up	3✔
101	// from both sides, meaning we get double the number of
102	// entries.
103	preAllocNumNodes*2,
104	),
105	nodeFeatures: make(	3✔
106	map[route.Vertex]*lnwire.FeatureVector,	3✔
107	preAllocNumNodes,	3✔
108	),	3✔
109	}	3✔
110	}	3✔
111		3✔
112	// Stats returns statistics about the current cache size.
113	func (c *GraphCache) Stats() string {
114	c.mtx.RLock()
115	defer c.mtx.RUnlock()
116
117	numChannels := 0
118	for node := range c.nodeChannels {	3✔
119	numChannels += len(c.nodeChannels[node])	3✔
120	}	3✔
121	return fmt.Sprintf("num_node_features=%d, num_nodes=%d, "+	×
122	"num_channels=%d", len(c.nodeFeatures), len(c.nodeChannels),	×
123	numChannels)
124	}	3✔
125		6✔
126	// AddNodeFeatures adds a graph node and its features to the cache.	3✔
127	func (c *GraphCache) AddNodeFeatures(node GraphCacheNode) {	3✔
128	nodePubKey := node.PubKey()	3✔
129
130	// Only hold the lock for a short time. The `ForEachChannel()` below is
131	// possibly slow as it has to go to the backend, so we can unlock	3✔
132	// between the calls. And the AddChannel() method will acquire its own	3✔
133	// lock anyway.	3✔
134	c.mtx.Lock()	3✔
135	c.nodeFeatures[nodePubKey] = node.Features()	3✔
136	c.mtx.Unlock()	3✔
137	}	3✔
138		3✔
139	// AddNode adds a graph node, including all the (directed) channels of that	3✔
140	// node.	3✔
141	func (c *GraphCache) AddNode(tx kvdb.RTx, node GraphCacheNode) error {	3✔
142	c.AddNodeFeatures(node)	3✔
143		3✔
144	return node.ForEachChannel(	3✔
145	tx, func(tx kvdb.RTx, info *models.ChannelEdgeInfo,	3✔
146	outPolicy *models.ChannelEdgePolicy,	3✔
147	inPolicy *models.ChannelEdgePolicy) error {	3✔
148		6✔
149	c.AddChannel(info, outPolicy, inPolicy)	3✔
150		3✔
UNCOV 151	return nil	×
UNCOV 152	},	×
153	)	3✔
154	}	3✔
155
156	// AddChannel adds a non-directed channel, meaning that the order of policy 1	6✔
157	// and policy 2 does not matter, the directionality is extracted from the info	3✔
158	// and policy flags automatically. The policy will be set as the outgoing policy	3✔
UNCOV 159	// on one node and the incoming policy on the peer's side.	×
UNCOV 160	func (c GraphCache) AddChannel(info models.ChannelEdgeInfo,	×
161	policy1 models.ChannelEdgePolicy, policy2 models.ChannelEdgePolicy) {	3✔
162		3✔
163	if info == nil {
164	return
165	}
166
167	if policy1 != nil && policy1.IsDisabled() &&
168	policy2 != nil && policy2.IsDisabled() {	3✔
169		6✔
170	return	3✔
171	}	3✔
172
173	// Create the edge entry for both nodes.	3✔
174	c.mtx.Lock()
175	c.updateOrAddEdge(info.NodeKey1Bytes, &DirectedChannel{
176	ChannelID: info.ChannelID,
177	IsNode1: true,
178	OtherNode: info.NodeKey2Bytes,
179	Capacity: info.Capacity,
180	})
181	c.updateOrAddEdge(info.NodeKey2Bytes, &DirectedChannel{	3✔
182	ChannelID: info.ChannelID,	3✔
183	IsNode1: false,	3✔
184	OtherNode: info.NodeKey1Bytes,	3✔
185	Capacity: info.Capacity,	3✔
186	})	3✔
187	c.mtx.Unlock()	3✔
188		×
189	// The policy's node is always the to_node. So if policy 1 has to_node	×
190	// of node 2 then we have the policy 1 as seen from node 1.	×
191	if policy1 != nil {	×
192	fromNode, toNode := info.NodeKey1Bytes, info.NodeKey2Bytes	×
193	if policy1.ToNode != info.NodeKey2Bytes {
194	fromNode, toNode = toNode, fromNode	3✔
195	}	3✔
196	isEdge1 := policy1.ChannelFlags&lnwire.ChanUpdateDirection == 0	3✔
197	c.UpdatePolicy(policy1, fromNode, toNode, isEdge1)	6✔
198	}	3✔
199	if policy2 != nil {	×
200	fromNode, toNode := info.NodeKey2Bytes, info.NodeKey1Bytes	×
201	if policy2.ToNode != info.NodeKey1Bytes {	×
202	fromNode, toNode = toNode, fromNode	×
203	}
204	isEdge1 := policy2.ChannelFlags&lnwire.ChanUpdateDirection == 0	3✔
205	c.UpdatePolicy(policy2, fromNode, toNode, isEdge1)	3✔
206	}	×
207	}	×
208		×
209	// updateOrAddEdge makes sure the edge information for a node is either updated	×
210	// if it already exists or is added to that node's list of channels.	×
211	func (c GraphCache) updateOrAddEdge(node route.Vertex, edge DirectedChannel) {
212	if len(c.nodeChannels[node]) == 0 {
213	c.nodeChannels[node] = make(map[uint64]*DirectedChannel)
214	}	3✔
215
216	c.nodeChannels[node][edge.ChannelID] = edge
217	}	3✔
218		3✔
219	// UpdatePolicy updates a single policy on both the from and to node. The order	3✔
220	// of the from and to node is not strictly important. But we assume that a
221	// channel edge was added beforehand so that the directed channel struct already
222	// exists in the cache.
223	func (c GraphCache) UpdatePolicy(policy models.ChannelEdgePolicy, fromNode,	3✔
224	toNode route.Vertex, edge1 bool) {	3✔
225		3✔
226	// Extract inbound fee if possible and available. If there is a decoding
227	// error, ignore this policy.
228	var inboundFee lnwire.Fee
229	_, err := policy.ExtraOpaqueData.ExtractRecords(&inboundFee)	3✔
230	if err != nil {	3✔
231	log.Errorf("Failed to extract records from edge policy %v: %v",
232	policy.ChannelID, err)
233
234	return	3✔
235	}	3✔
236
237	c.mtx.Lock()
238	defer c.mtx.Unlock()
239
240	updatePolicy := func(nodeKey route.Vertex) {	3✔
241	if len(c.nodeChannels[nodeKey]) == 0 {	3✔
242	log.Warnf("Node=%v not found in graph cache", nodeKey)	3✔
243		3✔
244	return	3✔
245	}	3✔
246		3✔
247	channel, ok := c.nodeChannels[nodeKey][policy.ChannelID]	3✔
248	if !ok {	×
249	log.Warnf("Channel=%v not found in graph cache",	×
250	policy.ChannelID)
251
252	return	3✔
253	}
254
255	// Edge 1 is defined as the policy for the direction of node1 to
256	// node2.	3✔
257	switch {	3✔
258	// This is node 1, and it is edge 1, so this is the outgoing	3✔
259	// policy for node 1.	3✔
260	case channel.IsNode1 && edge1:	3✔
261	channel.OutPolicySet = true	3✔
262	channel.InboundFee = inboundFee	3✔
263		3✔
264	// This is node 2, and it is edge 2, so this is the outgoing
265	// policy for node 2.
266	case !channel.IsNode1 && !edge1:	3✔
267	channel.OutPolicySet = true	6✔
268	channel.InboundFee = inboundFee	3✔
269		3✔
270	// The other two cases left mean it's the inbound policy for the
271	// node.	3✔
272	default:
273	channel.InPolicy = models.NewCachedPolicy(policy)
274	}
275	}
276
277	updatePolicy(fromNode)	×
278	updatePolicy(toNode)	×
279	}	×
280		×
281	// RemoveNode completely removes a node and all its channels (including the	×
282	// peer's side).	×
283	func (c *GraphCache) RemoveNode(node route.Vertex) {	×
284	c.mtx.Lock()	×
285	defer c.mtx.Unlock()	×
286
287	delete(c.nodeFeatures, node)	×
288		×
289	// First remove all channels from the other nodes' lists.	×
290	for _, channel := range c.nodeChannels[node] {	×
291	c.removeChannelIfFound(channel.OtherNode, channel.ChannelID)	×
292	}	×
293		×
294	// Then remove our whole node completely.
295	delete(c.nodeChannels, node)	×
296	}	×
297		×
298	// RemoveChannel removes a single channel between two nodes.	×
299	func (c *GraphCache) RemoveChannel(node1, node2 route.Vertex, chanID uint64) {	×
300	c.mtx.Lock()
301	defer c.mtx.Unlock()
302
303	// Remove that one channel from both sides.
304	c.removeChannelIfFound(node1, chanID)	3✔
305	c.removeChannelIfFound(node2, chanID)	3✔
306	}	3✔
307		3✔
308	// removeChannelIfFound removes a single channel from one side.	3✔
309	func (c *GraphCache) removeChannelIfFound(node route.Vertex, chanID uint64) {	6✔
310	if len(c.nodeChannels[node]) == 0 {	3✔
311	return	3✔
312	}
313		3✔
314	delete(c.nodeChannels[node], chanID)	6✔
315	}	3✔
316		3✔
317	// UpdateChannel updates the channel edge information for a specific edge. We	3✔
318	// expect the edge to already exist and be known. If it does not yet exist, this	3✔
319	// call is a no-op.	3✔
320	func (c GraphCache) UpdateChannel(info models.ChannelEdgeInfo) {	3✔
321	c.mtx.Lock()	3✔
322	defer c.mtx.Unlock()	3✔
323
324	if len(c.nodeChannels[info.NodeKey1Bytes]) == 0 \|\|	6✔
325	len(c.nodeChannels[info.NodeKey2Bytes]) == 0 {	3✔
326		3✔
327	return
328	}	3✔
329		3✔
330	channel, ok := c.nodeChannels[info.NodeKey1Bytes][info.ChannelID]	6✔
331	if ok {	3✔
332	// We only expect to be called when the channel is already	3✔
333	// known.	3✔
334	channel.Capacity = info.Capacity	3✔
335	channel.OtherNode = info.NodeKey2Bytes	3✔
336	}	6✔
337		3✔
338	channel, ok = c.nodeChannels[info.NodeKey2Bytes][info.ChannelID]	3✔
339	if ok {	3✔
340	channel.Capacity = info.Capacity
341	channel.OtherNode = info.NodeKey1Bytes	3✔
342	}	3✔
343	}
344
345	// getChannels returns a copy of the passed node's channels or nil if there	3✔
346	// isn't any.
347	func (c GraphCache) getChannels(node route.Vertex) []DirectedChannel {
348	c.mtx.RLock()
349	defer c.mtx.RUnlock()
350		3✔
351	channels, ok := c.nodeChannels[node]	3✔
352	if !ok {	3✔
353	return nil	3✔
354	}	3✔
355		3✔
356	features, ok := c.nodeFeatures[node]	3✔
357	if !ok {	3✔
358	// If the features were set to nil explicitly, that's fine here.	3✔
359	// The router will overwrite the features of the destination	3✔
360	// node with those found in the invoice if necessary. But if we	6✔
361	// didn't yet get a node announcement we want to mimic the	3✔
362	// behavior of the old DB based code that would always set an	×
363	// empty feature vector instead of leaving it nil.	×
364	features = lnwire.EmptyFeatureVector()
365	}
366		3✔
367	toNodeCallback := func() route.Vertex {
368	return node
369	}
370
371	i := 0
372	channelsCopy := make([]*DirectedChannel, len(channels))
373	for _, channel := range channels {
374	// We need to copy the channel and policy to avoid it being
375	// updated in the cache if the path finding algorithm sets
UNCOV 376	// fields on it (currently only the ToNodeFeatures of the	×
UNCOV 377	// policy).	×
UNCOV 378	channelCopy := channel.DeepCopy()	×
UNCOV 379	if channelCopy.InPolicy != nil {	×
UNCOV 380	channelCopy.InPolicy.ToNodePubKey = toNodeCallback	×
UNCOV 381	channelCopy.InPolicy.ToNodeFeatures = features	×
UNCOV 382	}	×
UNCOV 383		×
UNCOV 384	channelsCopy[i] = channelCopy	×
UNCOV 385	i++	×
386	}	×
387		×
388	return channelsCopy
389	}
UNCOV 390		×
391	// ForEachChannel invokes the given callback for each channel of the given node.
392	func (c *GraphCache) ForEachChannel(node route.Vertex,
393	cb func(channel *DirectedChannel) error) error {
394
395	// Obtain a copy of the node's channels. We need do this in order to	3✔
396	// avoid deadlocks caused by interaction with the graph cache, channel	3✔
397	// state and the graph database from multiple goroutines. This snapshot	3✔
398	// is only used for path finding where being stale is acceptable since	3✔
399	// the real world graph and our representation may always become	3✔
400	// slightly out of sync for a short time and the actual channel state	6✔
401	// is stored separately.	3✔
402	channels := c.getChannels(node)	3✔
403	for _, channel := range channels {	3✔
404	if err := cb(channel); err != nil {	3✔
405	return err
406	}	3✔
407	}
408
409	return nil
410	}
411
412	// ForEachNode iterates over the adjacency list of the graph, executing the
413	// call back for each node and the set of channels that emanate from the given
414	// node.
415	//
416	// NOTE: This method should be considered _read only_, the channels or nodes
417	// passed in MUST NOT be modified.
418	func (c *GraphCache) ForEachNode(cb func(node route.Vertex,
419	channels map[uint64]*DirectedChannel) error) error {
420
421	c.mtx.RLock()
422	defer c.mtx.RUnlock()
423
424	for node, channels := range c.nodeChannels {
425	// We don't make a copy here since this is a read-only RPC
426	// call. We also don't need the node features either for this
427	// call.
428	if err := cb(node, channels); err != nil {
429	return err
430	}
431	}
432
433	return nil
434	}
435
436	// GetFeatures returns the features of the node with the given ID. If no
437	// features are known for the node, an empty feature vector is returned.
438	func (c GraphCache) GetFeatures(node route.Vertex) lnwire.FeatureVector {
439	c.mtx.RLock()
440	defer c.mtx.RUnlock()
441
442	features, ok := c.nodeFeatures[node]
443	if !ok \|\| features == nil {
444	// The router expects the features to never be nil, so we return
445	// an empty feature set instead.
446	return lnwire.EmptyFeatureVector()
447	}
448
449	return features
450	}

lightningnetwork / lnd / 13423774416

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