11166428937

Committed 03 Oct 2024 05:07PM UTC coverage: 58.738% (-0.08%) from 58.817%

Build # 11166428937

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #8960 from lightningnetwork/0-19-staging-rebased

[custom channels 5/5]: merge custom channel staging branch into master

Run Details

657 of 875 new or added lines in 29 files covered. (75.09%)

260 existing lines in 20 files now uncovered.

130540 of 222243 relevant lines covered (58.74%)

28084.43 hits per line

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

85.61

/peer/ping_manager.go

package peer

import (
        "errors"
        "fmt"
        "sync"
        "sync/atomic"
        "time"

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

// PingManagerConfig is a structure containing various parameters that govern
// how the PingManager behaves.
type PingManagerConfig struct {
        // NewPingPayload is a closure that returns the payload to be packaged
        // in the Ping message.
        NewPingPayload func() []byte

        // NewPongSize is a closure that returns a random value between
        // [0, lnwire.MaxPongBytes]. This random value helps to more effectively
        // pair Pong messages with Ping.
        NewPongSize func() uint16

        // IntervalDuration is the Duration between attempted pings.
        IntervalDuration time.Duration

        // TimeoutDuration is the Duration we wait before declaring a ping
        // attempt failed.
        TimeoutDuration time.Duration

        // SendPing is a closure that is responsible for sending the Ping
        // message out to our peer
        SendPing func(ping *lnwire.Ping)

        // OnPongFailure is a closure that is responsible for executing the
        // logic when a Pong message is either late or does not match our
        // expectations for that Pong
        OnPongFailure func(error)
}

// PingManager is a structure that is designed to manage the internal state
// of the ping pong lifecycle with the remote peer. We assume there is only one
// ping outstanding at once.
//
// NOTE: This structure MUST be initialized with NewPingManager.
type PingManager struct {
        cfg *PingManagerConfig

        // pingTime is a rough estimate of the RTT (round-trip-time) between us
        // and the connected peer.
        // To be used atomically.
        // TODO(roasbeef): also use a WMA or EMA?
        pingTime atomic.Pointer[time.Duration]

        // pingLastSend is the time when we sent our last ping message.
        // To be used atomically.
        pingLastSend *time.Time

        // outstandingPongSize is the current size of the requested pong
        // payload.  This value can only validly range from [0,65531]. Any
        // value < 0 is interpreted as if there is no outstanding ping message.
        outstandingPongSize int32

        // pingTicker is a pointer to a Ticker that fires on every ping
        // interval.
        pingTicker *time.Ticker

        // pingTimeout is a Timer that will fire when we want to time out a
        // ping
        pingTimeout *time.Timer

        // pongChan is the channel on which the pingManager will write Pong
        // messages it is evaluating
        pongChan chan *lnwire.Pong

        started sync.Once
        stopped sync.Once

        quit chan struct{}
        wg   sync.WaitGroup
}

// NewPingManager constructs a pingManager in a valid state. It must be started
// before it does anything useful, though.
func NewPingManager(cfg *PingManagerConfig) *PingManager {
        m := PingManager{
                cfg:                 cfg,
                outstandingPongSize: -1,
                pongChan:            make(chan *lnwire.Pong, 1),
                quit:                make(chan struct{}),
        }

        return &m
}

// Start launches the primary goroutine that is owned by the pingManager.
func (m *PingManager) Start() error {
        var err error
        m.started.Do(func() {
                m.pingTicker = time.NewTicker(m.cfg.IntervalDuration)
                m.pingTimeout = time.NewTimer(0)

                m.wg.Add(1)
                go m.pingHandler()
        })

        return err
}

// pingHandler is the main goroutine responsible for enforcing the ping/pong
// protocol.
func (m *PingManager) pingHandler() {
        defer m.wg.Done()
        defer m.pingTimeout.Stop()

        // Ensure that the pingTimeout channel is empty.
        if !m.pingTimeout.Stop() {
                <-m.pingTimeout.C
        }

        for {
                select {
                case <-m.pingTicker.C:
                        // If this occurs it means that the new ping cycle has
                        // begun while there is still an outstanding ping
                        // awaiting a pong response.  This should never occur,
                        // but if it does, it implies a timeout.
                        if m.outstandingPongSize >= 0 {
                                e := errors.New("impossible: new ping" +
                                        "in unclean state",
                                )
                                m.cfg.OnPongFailure(e)

                                return
                        }

                        pongSize := m.cfg.NewPongSize()
                        ping := &lnwire.Ping{
                                NumPongBytes: pongSize,
                                PaddingBytes: m.cfg.NewPingPayload(),
                        }

                        // Set up our bookkeeping for the new Ping.
                        if err := m.setPingState(pongSize); err != nil {
                                m.cfg.OnPongFailure(err)

                                return
                        }

                        m.cfg.SendPing(ping)

                case <-m.pingTimeout.C:
                        m.resetPingState()

                        e := errors.New("timeout while waiting for " +
                                "pong response",
                        )

                        m.cfg.OnPongFailure(e)

                        return

                case pong := <-m.pongChan:
                        pongSize := int32(len(pong.PongBytes))

                        // Save off values we are about to override when we
                        // call resetPingState.
                        expected := m.outstandingPongSize
                        lastPing := m.pingLastSend

                        m.resetPingState()

                        // If the pong we receive doesn't match the ping we
                        // sent out, then we fail out.
                        if pongSize != expected {
                                e := errors.New("pong response does " +
                                        "not match expected size",
                                )

                                m.cfg.OnPongFailure(e)

                                return
                        }

                        // Compute RTT of ping and save that for future
                        // querying.
                        if lastPing != nil {
                                rtt := time.Since(*lastPing)
                                m.pingTime.Store(&rtt)
                        }

                case <-m.quit:
                        return
                }
        }
}

// Stop interrupts the goroutines that the PingManager owns.
func (m *PingManager) Stop() {
        if m.pingTicker == nil {
                return
        }

        m.stopped.Do(func() {
                close(m.quit)
                m.wg.Wait()

                m.pingTicker.Stop()
                m.pingTimeout.Stop()
        })
}

// setPingState is a private method to keep track of all of the fields we need
// to set when we send out a Ping.
func (m *PingManager) setPingState(pongSize uint16) error {
        t := time.Now()
        m.pingLastSend = &t
        m.outstandingPongSize = int32(pongSize)
        if m.pingTimeout.Reset(m.cfg.TimeoutDuration) {
                return fmt.Errorf(
                        "impossible: ping timeout reset when already active",
                )
        }

        return nil
}

// resetPingState is a private method that resets all of the bookkeeping that
// is tracking a currently outstanding Ping.
func (m *PingManager) resetPingState() {
        m.pingLastSend = nil
        m.outstandingPongSize = -1
        if !m.pingTimeout.Stop() {
                select {
                case <-m.pingTimeout.C:
                default:
                }
        }
}

// GetPingTimeMicroSeconds reports back the RTT calculated by the pingManager.
func (m *PingManager) GetPingTimeMicroSeconds() int64 {
        rtt := m.pingTime.Load()

        if rtt == nil {
                return -1
        }

        return rtt.Microseconds()
}

// ReceivedPong is called to evaluate a Pong message against the expectations
// we have for it. It will cause the PingManager to invoke the supplied
// OnPongFailure function if the Pong argument supplied violates expectations.
func (m *PingManager) ReceivedPong(msg *lnwire.Pong) {
        select {
        case m.pongChan <- msg:
        case <-m.quit:
        }
}

1	package peer
2
3	import (
4	"errors"
5	"fmt"
6	"sync"
7	"sync/atomic"
8	"time"
9
10	"github.com/lightningnetwork/lnd/lnwire"
11	)
12
13	// PingManagerConfig is a structure containing various parameters that govern
14	// how the PingManager behaves.
15	type PingManagerConfig struct {
16	// NewPingPayload is a closure that returns the payload to be packaged
17	// in the Ping message.
18	NewPingPayload func() []byte
19
20	// NewPongSize is a closure that returns a random value between
21	// [0, lnwire.MaxPongBytes]. This random value helps to more effectively
22	// pair Pong messages with Ping.
23	NewPongSize func() uint16
24
25	// IntervalDuration is the Duration between attempted pings.
26	IntervalDuration time.Duration
27
28	// TimeoutDuration is the Duration we wait before declaring a ping
29	// attempt failed.
30	TimeoutDuration time.Duration
31
32	// SendPing is a closure that is responsible for sending the Ping
33	// message out to our peer
34	SendPing func(ping *lnwire.Ping)
35
36	// OnPongFailure is a closure that is responsible for executing the
37	// logic when a Pong message is either late or does not match our
38	// expectations for that Pong
39	OnPongFailure func(error)
40	}
41
42	// PingManager is a structure that is designed to manage the internal state
43	// of the ping pong lifecycle with the remote peer. We assume there is only one
44	// ping outstanding at once.
45	//
46	// NOTE: This structure MUST be initialized with NewPingManager.
47	type PingManager struct {
48	cfg *PingManagerConfig
49
50	// pingTime is a rough estimate of the RTT (round-trip-time) between us
51	// and the connected peer.
52	// To be used atomically.
53	// TODO(roasbeef): also use a WMA or EMA?
54	pingTime atomic.Pointer[time.Duration]
55
56	// pingLastSend is the time when we sent our last ping message.
57	// To be used atomically.
58	pingLastSend *time.Time
59
60	// outstandingPongSize is the current size of the requested pong
61	// payload. This value can only validly range from [0,65531]. Any
62	// value < 0 is interpreted as if there is no outstanding ping message.
63	outstandingPongSize int32
64
65	// pingTicker is a pointer to a Ticker that fires on every ping
66	// interval.
67	pingTicker *time.Ticker
68
69	// pingTimeout is a Timer that will fire when we want to time out a
70	// ping
71	pingTimeout *time.Timer
72
73	// pongChan is the channel on which the pingManager will write Pong
74	// messages it is evaluating
75	pongChan chan *lnwire.Pong
76
77	started sync.Once
78	stopped sync.Once
79
80	quit chan struct{}
81	wg sync.WaitGroup
82	}
83
84	// NewPingManager constructs a pingManager in a valid state. It must be started
85	// before it does anything useful, though.
86	func NewPingManager(cfg PingManagerConfig) PingManager {	31✔
87	m := PingManager{	31✔
88	cfg: cfg,	31✔
89	outstandingPongSize: -1,	31✔
90	pongChan: make(chan *lnwire.Pong, 1),	31✔
91	quit: make(chan struct{}),	31✔
92	}	31✔
93		31✔
94	return &m	31✔
95	}	31✔
96
97	// Start launches the primary goroutine that is owned by the pingManager.
98	func (m *PingManager) Start() error {	9✔
99	var err error	9✔
100	m.started.Do(func() {	18✔
101	m.pingTicker = time.NewTicker(m.cfg.IntervalDuration)	9✔
102	m.pingTimeout = time.NewTimer(0)	9✔
103		9✔
104	m.wg.Add(1)	9✔
105	go m.pingHandler()	9✔
106	})	9✔
107
108	return err	9✔
109	}
110
111	// pingHandler is the main goroutine responsible for enforcing the ping/pong
112	// protocol.
113	func (m *PingManager) pingHandler() {	9✔
114	defer m.wg.Done()	9✔
115	defer m.pingTimeout.Stop()	9✔
116		9✔
117	// Ensure that the pingTimeout channel is empty.	9✔
118	if !m.pingTimeout.Stop() {	18✔
119	<-m.pingTimeout.C	9✔
120	}	9✔
121
122	for {	22✔
123	select {	13✔
124	case <-m.pingTicker.C:	5✔
125	// If this occurs it means that the new ping cycle has	5✔
126	// begun while there is still an outstanding ping	5✔
127	// awaiting a pong response. This should never occur,	5✔
128	// but if it does, it implies a timeout.	5✔
129	if m.outstandingPongSize >= 0 {	5✔
130	e := errors.New("impossible: new ping" +	×
131	"in unclean state",	×
132	)	×
133	m.cfg.OnPongFailure(e)	×
134		×
135	return	×
136	}	×
137
138	pongSize := m.cfg.NewPongSize()	5✔
139	ping := &lnwire.Ping{	5✔
140	NumPongBytes: pongSize,	5✔
141	PaddingBytes: m.cfg.NewPingPayload(),	5✔
142	}	5✔
143		5✔
144	// Set up our bookkeeping for the new Ping.	5✔
145	if err := m.setPingState(pongSize); err != nil {	5✔
146	m.cfg.OnPongFailure(err)	×
147		×
148	return	×
149	}	×
150
151	m.cfg.SendPing(ping)	5✔
152
153	case <-m.pingTimeout.C:	1✔
154	m.resetPingState()	1✔
155		1✔
156	e := errors.New("timeout while waiting for " +	1✔
157	"pong response",	1✔
158	)	1✔
159		1✔
160	m.cfg.OnPongFailure(e)	1✔
161		1✔
162	return	1✔
163
164	case pong := <-m.pongChan:	4✔
165	pongSize := int32(len(pong.PongBytes))	4✔
166		4✔
167	// Save off values we are about to override when we	4✔
168	// call resetPingState.	4✔
169	expected := m.outstandingPongSize	4✔
170	lastPing := m.pingLastSend	4✔
171		4✔
172	m.resetPingState()	4✔
173		4✔
174	// If the pong we receive doesn't match the ping we	4✔
175	// sent out, then we fail out.	4✔
176	if pongSize != expected {	5✔
177	e := errors.New("pong response does " +	1✔
178	"not match expected size",	1✔
179	)	1✔
180		1✔
181	m.cfg.OnPongFailure(e)	1✔
182		1✔
183	return	1✔
184	}	1✔
185
186	// Compute RTT of ping and save that for future
187	// querying.
188	if lastPing != nil {	6✔
189	rtt := time.Since(*lastPing)	3✔
190	m.pingTime.Store(&rtt)	3✔
191	}	3✔
192
193	case <-m.quit:	4✔
194	return	4✔
195	}
196	}
197	}
198
199	// Stop interrupts the goroutines that the PingManager owns.
200	func (m *PingManager) Stop() {	6✔
201	if m.pingTicker == nil {	6✔
UNCOV 202	return	×
UNCOV 203	}	×
204
205	m.stopped.Do(func() {	12✔
206	close(m.quit)	6✔
207	m.wg.Wait()	6✔
208		6✔
209	m.pingTicker.Stop()	6✔
210	m.pingTimeout.Stop()	6✔
211	})	6✔
212	}
213
214	// setPingState is a private method to keep track of all of the fields we need
215	// to set when we send out a Ping.
216	func (m *PingManager) setPingState(pongSize uint16) error {	5✔
217	t := time.Now()	5✔
218	m.pingLastSend = &t	5✔
219	m.outstandingPongSize = int32(pongSize)	5✔
220	if m.pingTimeout.Reset(m.cfg.TimeoutDuration) {	5✔
221	return fmt.Errorf(	×
222	"impossible: ping timeout reset when already active",	×
223	)	×
224	}	×
225
226	return nil	5✔
227	}
228
229	// resetPingState is a private method that resets all of the bookkeeping that
230	// is tracking a currently outstanding Ping.
231	func (m *PingManager) resetPingState() {	5✔
232	m.pingLastSend = nil	5✔
233	m.outstandingPongSize = -1	5✔
234	if !m.pingTimeout.Stop() {	6✔
235	select {	1✔
236	case <-m.pingTimeout.C:	×
237	default:	1✔
238	}
239	}
240	}
241
242	// GetPingTimeMicroSeconds reports back the RTT calculated by the pingManager.
243	func (m *PingManager) GetPingTimeMicroSeconds() int64 {	3✔
244	rtt := m.pingTime.Load()	3✔
245		3✔
246	if rtt == nil {	6✔
247	return -1	3✔
248	}	3✔
249
250	return rtt.Microseconds()	1✔
251	}
252
253	// ReceivedPong is called to evaluate a Pong message against the expectations
254	// we have for it. It will cause the PingManager to invoke the supplied
255	// OnPongFailure function if the Pong argument supplied violates expectations.
256	func (m PingManager) ReceivedPong(msg lnwire.Pong) {	5✔
257	select {	5✔
258	case m.pongChan <- msg:	5✔
259	case <-m.quit:	×
260	}
261	}

lightningnetwork / lnd / 11166428937

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