highperfocused/lnd
1
0
Fork 0
mirror of https://github.com/lightningnetwork/lnd.git synced 2025-05-18 15:50:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

routing: export MissionControl

Browse Source
This commit is contained in:
Johan T. Halseth 2019-05-23 20:05:30 +02:00
parent 3323800e02
commit adc4640f4f
No known key found for this signature in database
GPG Key ID: 15BAADA29DA20D26
4 changed files with 29 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
routing/missioncontrol.go
View File

@ -14,7 +14,7 @@ import (
const ( const (
// vertexDecay is the decay period of colored vertexes added to // vertexDecay is the decay period of colored vertexes added to
// missionControl. Once vertexDecay passes after an entry has been // MissionControl. Once vertexDecay passes after an entry has been
// added to the prune view, it is garbage collected. This value is // added to the prune view, it is garbage collected. This value is
// larger than edgeDecay as an edge failure typical indicates an // larger than edgeDecay as an edge failure typical indicates an
// unbalanced channel, while a vertex failure indicates a node is not // unbalanced channel, while a vertex failure indicates a node is not
@ -22,7 +22,7 @@ const (
vertexDecay = time.Duration(time.Minute * 5) vertexDecay = time.Duration(time.Minute * 5)
// edgeDecay is the decay period of colored edges added to // edgeDecay is the decay period of colored edges added to
// missionControl. Once edgeDecay passed after an entry has been added, // MissionControl. Once edgeDecay passed after an entry has been added,
// it is garbage collected. This value is smaller than vertexDecay as // it is garbage collected. This value is smaller than vertexDecay as
// an edge related failure during payment sending typically indicates // an edge related failure during payment sending typically indicates
// that a channel was unbalanced, a condition which may quickly change. // that a channel was unbalanced, a condition which may quickly change.
@ -31,11 +31,11 @@ const (
edgeDecay = time.Duration(time.Second * 5) edgeDecay = time.Duration(time.Second * 5)
) )
// missionControl contains state which summarizes the past attempts of HTLC // MissionControl contains state which summarizes the past attempts of HTLC
// routing by external callers when sending payments throughout the network. // routing by external callers when sending payments throughout the network.
// missionControl remembers the outcome of these past routing attempts (success // MissionControl remembers the outcome of these past routing attempts (success
// and failure), and is able to provide hints/guidance to future HTLC routing // and failure), and is able to provide hints/guidance to future HTLC routing
// attempts. missionControl maintains a decaying network view of the // attempts. MissionControl maintains a decaying network view of the
// edges/vertexes that should be marked as "pruned" during path finding. This // edges/vertexes that should be marked as "pruned" during path finding. This
// graph view acts as a shared memory during HTLC payment routing attempts. // graph view acts as a shared memory during HTLC payment routing attempts.
// With each execution, if an error is encountered, based on the type of error // With each execution, if an error is encountered, based on the type of error
@ -43,16 +43,16 @@ const (
// to the view. Later sending attempts will then query the view for all the // to the view. Later sending attempts will then query the view for all the
// vertexes/edges that should be ignored. Items in the view decay after a set // vertexes/edges that should be ignored. Items in the view decay after a set
// period of time, allowing the view to be dynamic w.r.t network changes. // period of time, allowing the view to be dynamic w.r.t network changes.
type missionControl struct { type MissionControl struct {
// failedEdges maps a short channel ID to be pruned, to the time that // failedEdges maps a short channel ID to be pruned, to the time that
// it was added to the prune view. Edges are added to this map if a // it was added to the prune view. Edges are added to this map if a
// caller reports to missionControl a failure localized to that edge // caller reports to MissionControl a failure localized to that edge
// when sending a payment. // when sending a payment.
failedEdges map[EdgeLocator]time.Time failedEdges map[EdgeLocator]time.Time
// failedVertexes maps a node's public key that should be pruned, to // failedVertexes maps a node's public key that should be pruned, to
// the time that it was added to the prune view. Vertexes are added to // the time that it was added to the prune view. Vertexes are added to
// this map if a caller reports to missionControl a failure localized // this map if a caller reports to MissionControl a failure localized
// to that particular vertex. // to that particular vertex.
failedVertexes map[route.Vertex]time.Time failedVertexes map[route.Vertex]time.Time
@ -70,13 +70,13 @@ type missionControl struct {
// TODO(roasbeef): also add favorable metrics for nodes // TODO(roasbeef): also add favorable metrics for nodes
} }
// newMissionControl returns a new instance of missionControl. // NewMissionControl returns a new instance of MissionControl.
// //
// TODO(roasbeef): persist memory // TODO(roasbeef): persist memory
func newMissionControl(g *channeldb.ChannelGraph, selfNode *channeldb.LightningNode, func NewMissionControl(g *channeldb.ChannelGraph, selfNode *channeldb.LightningNode,
qb func(*channeldb.ChannelEdgeInfo) lnwire.MilliSatoshi) *missionControl { qb func(*channeldb.ChannelEdgeInfo) lnwire.MilliSatoshi) *MissionControl {
return &missionControl{ return &MissionControl{
failedEdges: make(map[EdgeLocator]time.Time), failedEdges: make(map[EdgeLocator]time.Time),
failedVertexes: make(map[route.Vertex]time.Time), failedVertexes: make(map[route.Vertex]time.Time),
selfNode: selfNode, selfNode: selfNode,
@ -96,12 +96,12 @@ type graphPruneView struct {
vertexes map[route.Vertex]struct{} vertexes map[route.Vertex]struct{}
} }
// GraphPruneView returns a new graphPruneView instance which is to be // graphPruneView returns a new graphPruneView instance which is to be
// consulted during path finding. If a vertex/edge is found within the returned // consulted during path finding. If a vertex/edge is found within the returned
// prune view, it is to be ignored as a goroutine has had issues routing // prune view, it is to be ignored as a goroutine has had issues routing
// through it successfully. Within this method the main view of the // through it successfully. Within this method the main view of the
// missionControl is garbage collected as entries are detected to be "stale". // MissionControl is garbage collected as entries are detected to be "stale".
func (m *missionControl) GraphPruneView() graphPruneView { func (m *MissionControl) graphPruneView() graphPruneView {
// First, we'll grab the current time, this value will be used to // First, we'll grab the current time, this value will be used to
// determine if an entry is stale or not. // determine if an entry is stale or not.
now := time.Now() now := time.Now()
@ -154,10 +154,10 @@ func (m *missionControl) GraphPruneView() graphPruneView {
// view from Mission Control. An optional set of routing hints can be provided // view from Mission Control. An optional set of routing hints can be provided
// in order to populate additional edges to explore when finding a path to the // in order to populate additional edges to explore when finding a path to the
// payment's destination. // payment's destination.
func (m *missionControl) NewPaymentSession(routeHints [][]zpay32.HopHint, func (m *MissionControl) NewPaymentSession(routeHints [][]zpay32.HopHint,
target route.Vertex) (*paymentSession, error) { target route.Vertex) (*paymentSession, error) {
viewSnapshot := m.GraphPruneView() viewSnapshot := m.graphPruneView()
edges := make(map[route.Vertex][]*channeldb.ChannelEdgePolicy) edges := make(map[route.Vertex][]*channeldb.ChannelEdgePolicy)
@ -233,9 +233,9 @@ func (m *missionControl) NewPaymentSession(routeHints [][]zpay32.HopHint,
// NewPaymentSessionForRoute creates a new paymentSession instance that is just // NewPaymentSessionForRoute creates a new paymentSession instance that is just
// used for failure reporting to missioncontrol. // used for failure reporting to missioncontrol.
func (m *missionControl) NewPaymentSessionForRoute(preBuiltRoute *route.Route) *paymentSession { func (m *MissionControl) NewPaymentSessionForRoute(preBuiltRoute *route.Route) *paymentSession {
return &paymentSession{ return &paymentSession{
pruneViewSnapshot: m.GraphPruneView(), pruneViewSnapshot: m.graphPruneView(),
errFailedPolicyChans: make(map[EdgeLocator]struct{}), errFailedPolicyChans: make(map[EdgeLocator]struct{}),
mc: m, mc: m,
preBuiltRoute: preBuiltRoute, preBuiltRoute: preBuiltRoute,
@ -245,9 +245,9 @@ func (m *missionControl) NewPaymentSessionForRoute(preBuiltRoute *route.Route) *
// NewPaymentSessionEmpty creates a new paymentSession instance that is empty, // NewPaymentSessionEmpty creates a new paymentSession instance that is empty,
// and will be exhausted immediately. Used for failure reporting to // and will be exhausted immediately. Used for failure reporting to
// missioncontrol for resumed payment we don't want to make more attempts for. // missioncontrol for resumed payment we don't want to make more attempts for.
func (m *missionControl) NewPaymentSessionEmpty() *paymentSession { func (m *MissionControl) NewPaymentSessionEmpty() *paymentSession {
return &paymentSession{ return &paymentSession{
pruneViewSnapshot: m.GraphPruneView(), pruneViewSnapshot: m.graphPruneView(),
errFailedPolicyChans: make(map[EdgeLocator]struct{}), errFailedPolicyChans: make(map[EdgeLocator]struct{}),
mc: m, mc: m,
preBuiltRoute: &route.Route{}, preBuiltRoute: &route.Route{},
@ -290,9 +290,9 @@ func generateBandwidthHints(sourceNode *channeldb.LightningNode,
return bandwidthHints, nil return bandwidthHints, nil
} }
// ResetHistory resets the history of missionControl returning it to a state as // ResetHistory resets the history of MissionControl returning it to a state as
// if no payment attempts have been made. // if no payment attempts have been made.
func (m *missionControl) ResetHistory() { func (m *MissionControl) ResetHistory() {
m.Lock() m.Lock()
m.failedEdges = make(map[EdgeLocator]time.Time) m.failedEdges = make(map[EdgeLocator]time.Time)
m.failedVertexes = make(map[route.Vertex]time.Time) m.failedVertexes = make(map[route.Vertex]time.Time)

6
routing/payment_session.go
View File

@ -11,7 +11,7 @@ import (
// paymentSession is used during an HTLC routings session to prune the local // paymentSession is used during an HTLC routings session to prune the local
// chain view in response to failures, and also report those failures back to // chain view in response to failures, and also report those failures back to
// missionControl. The snapshot copied for this session will only ever grow, // MissionControl. The snapshot copied for this session will only ever grow,
// and will now be pruned after a decay like the main view within mission // and will now be pruned after a decay like the main view within mission
// control. We do this as we want to avoid the case where we continually try a // control. We do this as we want to avoid the case where we continually try a
// bad edge or route multiple times in a session. This can lead to an infinite // bad edge or route multiple times in a session. This can lead to an infinite
@ -30,7 +30,7 @@ type paymentSession struct {
// require pruning, but any subsequent ones do. // require pruning, but any subsequent ones do.
errFailedPolicyChans map[EdgeLocator]struct{} errFailedPolicyChans map[EdgeLocator]struct{}
mc *missionControl mc *MissionControl
preBuiltRoute *route.Route preBuiltRoute *route.Route
preBuiltRouteTried bool preBuiltRouteTried bool
@ -151,7 +151,7 @@ func (p *paymentSession) RequestRoute(payment *LightningPayment,
// Taking into account this prune view, we'll attempt to locate a path // Taking into account this prune view, we'll attempt to locate a path
// to our destination, respecting the recommendations from // to our destination, respecting the recommendations from
// missionControl. // MissionControl.
path, err := p.pathFinder( path, err := p.pathFinder(
&graphParams{ &graphParams{
graph: p.mc.graph, graph: p.mc.graph,

2
routing/payment_session_test.go
View File

@ -33,7 +33,7 @@ func TestRequestRoute(t *testing.T) {
} }
session := &paymentSession{ session := &paymentSession{
mc: &missionControl{ mc: &MissionControl{
selfNode: &channeldb.LightningNode{}, selfNode: &channeldb.LightningNode{},
}, },
pruneViewSnapshot: graphPruneView{}, pruneViewSnapshot: graphPruneView{},

4
routing/router.go
View File

@ -349,7 +349,7 @@ type ChannelRouter struct {
// Each run will then take into account this set of pruned // Each run will then take into account this set of pruned
// vertexes/edges to reduce route failure and pass on graph information // vertexes/edges to reduce route failure and pass on graph information
// gained to the next execution. // gained to the next execution.
missionControl *missionControl missionControl *MissionControl
// channelEdgeMtx is a mutex we use to make sure we process only one // channelEdgeMtx is a mutex we use to make sure we process only one
// ChannelEdgePolicy at a time for a given channelID, to ensure // ChannelEdgePolicy at a time for a given channelID, to ensure
@ -392,7 +392,7 @@ func New(cfg Config) (*ChannelRouter, error) {
quit: make(chan struct{}), quit: make(chan struct{}),
} }
r.missionControl = newMissionControl( r.missionControl = NewMissionControl(
cfg.Graph, selfNode, cfg.QueryBandwidth, cfg.Graph, selfNode, cfg.QueryBandwidth,
) )