flow_tx_test.go 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602
  1. //go:build linux && !android && !e2e_testing
  2. package nebula
  3. import (
  4. "fmt"
  5. "net/netip"
  6. "os"
  7. "os/exec"
  8. "slices"
  9. "sync"
  10. "testing"
  11. "time"
  12. "github.com/flynn/noise"
  13. "github.com/rcrowley/go-metrics"
  14. "github.com/slackhq/nebula/config"
  15. "github.com/slackhq/nebula/cpupick"
  16. "github.com/slackhq/nebula/firewall"
  17. "github.com/slackhq/nebula/header"
  18. "github.com/slackhq/nebula/noiseutil"
  19. "github.com/slackhq/nebula/overlay/batch"
  20. "github.com/slackhq/nebula/overlay/tio"
  21. "github.com/slackhq/nebula/test"
  22. "github.com/slackhq/nebula/udp"
  23. "github.com/slackhq/nebula/util"
  24. "github.com/stretchr/testify/require"
  25. "go.uber.org/goleak"
  26. "golang.org/x/sys/unix"
  27. )
  28. // TestReservedEncryptionMatchesInline encrypts a batch with counters reserved up front: the receiver accepts every
  29. // segment, in order.
  30. func TestReservedEncryptionMatchesInline(t *testing.T) {
  31. sender, receiver := newFlowTestPair(t, noise.CipherChaChaPoly, stagedConfig{})
  32. packets, want := flowTestBatches(1, 3, 3, 9)
  33. r := txReserver{f: sender.f}
  34. items := r.collect(nil, packets[0], &firewall.ParsedPacket{}, make([]byte, mtu), 0, nil)
  35. require.Equal(t, uint64(len(want)), r.tunnels[0].n)
  36. sb := batch.NewSendBatch(sender.conn, 128, 65536)
  37. for _, it := range r.reserve(items) {
  38. sender.f.encryptTxItem(&it, make([]byte, 12), sb)
  39. }
  40. sender.f.flushSendBatch(sb, 0)
  41. require.Equal(t, want, decryptWire(t, receiver, sender.conn.captured()))
  42. }
  43. // TestSegmentCount checks tio.Packet.SegmentCount predicts exactly the segments tio.SegmentSuperpacket cuts, odd tails included.
  44. func TestSegmentCount(t *testing.T) {
  45. require.Equal(t, 1, tio.Packet{Bytes: make([]byte, 60)}.SegmentCount())
  46. for _, segs := range []int{1, 2, 3, 45} {
  47. for _, tail := range []int{0, 1, flowTestMSS - 1} {
  48. pkt := flowTCPSuperpacket(0, 0, segs)
  49. pkt.Bytes = pkt.Bytes[:len(pkt.Bytes)-tail]
  50. pkt.GSO = tio.GSOInfo{Size: flowTestMSS, HdrLen: 40, CsumStart: 20, Proto: tio.GSOProtoTCP}
  51. want, got := pkt.SegmentCount(), 0
  52. require.NoError(t, tio.SegmentSuperpacket(pkt, func([]byte) error { got++; return nil }))
  53. require.Equal(t, want, got, "segs %d tail %d", segs, tail)
  54. }
  55. }
  56. }
  57. // TestFlowStagedTXOrderAndCounters runs the staged transmit pipeline with shuffled workers and a slow socket, so the
  58. // sender lags and the reader runs into backpressure, then fails the tun read with batches in flight: the wire must
  59. // carry every segment once, in tun read order, under strictly increasing counters that were each reserved exactly
  60. // once, and the read error is still reported.
  61. func TestFlowStagedTXOrderAndCounters(t *testing.T) {
  62. defer goleak.VerifyNone(t, goleak.IgnoreCurrent())
  63. for _, cipher := range []noise.CipherFunc{noiseutil.CipherAESGCM, noise.CipherChaChaPoly} {
  64. t.Run(cipher.CipherName(), func(t *testing.T) {
  65. if cipher.CipherName() == noiseutil.CipherAESGCM.CipherName() && noiseutil.EncryptLockNeeded {
  66. t.Skip("AES-GCM requires encryption in nonce order")
  67. }
  68. sender, receiver := newFlowTestPair(t, cipher, stagedOn(4))
  69. delayCrypto(sender, func(n uint64) {
  70. if n%54 == 0 {
  71. time.Sleep(time.Millisecond)
  72. }
  73. })
  74. // Far slower than the reader, even under the race detector
  75. sender.conn.delay = 8 * time.Millisecond
  76. batches, want := flowTestBatches(60, 6, 3, 9)
  77. start := sender.hostinfo.ConnectionState.messageCounter.Load()
  78. tx := metrics.GetOrRegisterCounter("flow.tx.batches", nil)
  79. tx0 := tx.Count()
  80. sender.f.listenIn(newFlowBatchQueue(batches), 0)
  81. require.Equal(t, int64(len(batches)), tx.Count()-tx0, "every batch uses the ordered sender")
  82. require.Equal(t, want, decryptWire(t, receiver, sender.conn.captured()), "wire order must match tun read order")
  83. require.Equal(t, start+uint64(len(want)), sender.hostinfo.ConnectionState.messageCounter.Load())
  84. require.NotNil(t, sender.f.fatalErr.Load())
  85. })
  86. }
  87. }
  88. // TestFlowStagedTXCloseInFlight closes the interface and tun while batches are in flight, 20 times over.
  89. func TestFlowStagedTXCloseInFlight(t *testing.T) {
  90. defer goleak.VerifyNone(t, goleak.IgnoreCurrent())
  91. for range 20 {
  92. sender, _ := newFlowTestPair(t, noise.CipherChaChaPoly, stagedOn(3))
  93. sender.conn.delay = time.Millisecond
  94. batches, _ := flowTestBatches(400, 4, 2, 8)
  95. q := newFlowBatchQueue(batches)
  96. done := make(chan struct{})
  97. go func() { sender.f.listenIn(q, 0); close(done) }()
  98. require.Eventually(t, func() bool { return q.reads.Load() > 5 }, 5*time.Second, 100*time.Microsecond)
  99. sender.f.closed.Store(true)
  100. require.NoError(t, q.Close())
  101. <-done
  102. }
  103. }
  104. // TestFlowStagedTXExhausted drops every batch of a tunnel whose counter runs out, like inline sends do.
  105. func TestFlowStagedTXExhausted(t *testing.T) {
  106. defer goleak.VerifyNone(t, goleak.IgnoreCurrent())
  107. sender, _ := newFlowTestPair(t, noise.CipherChaChaPoly, stagedOn(2))
  108. ci := sender.hostinfo.ConnectionState
  109. ci.messageCounter.Store(RejectAfterMessages - 3)
  110. sender.f.listenIn(newFlowBatchQueue([][]tio.Packet{{flowTCPSuperpacket(0, 0, 10)}, {flowTCPSuperpacket(0, 1, 2)}}), 0)
  111. require.Empty(t, sender.conn.captured())
  112. require.Equal(t, RejectAfterMessages, ci.messageCounter.Load())
  113. require.Equal(t, int64(12), sender.f.messageMetrics.txExhausted.Count())
  114. require.Zero(t, ci.txBudget.state.Load())
  115. }
  116. // TestFlowStagedTXRelay sends staged batches, and an empty read, through a relay: outer and inner layers both verify,
  117. // in order, and go to the relay.
  118. // With a tiny MSS, the middle superpacket alone exceeds the tunnels' whole credit: it must be split, not admitted as an
  119. // unbounded lone batch, with either replay window.
  120. func TestFlowStagedTXRelay(t *testing.T) {
  121. defer goleak.VerifyNone(t, goleak.IgnoreCurrent())
  122. for _, window := range budgetWindows {
  123. t.Run(fmt.Sprintf("window=%d", window), func(t *testing.T) {
  124. sender, receiver := newFlowTestPair(t, noise.CipherChaChaPoly, stagedOn(2))
  125. sender.hostinfo.ConnectionState.window = NewBits(window)
  126. receiver.hostinfo.ConnectionState.window = NewBits(window)
  127. relayRemote, relayHI, relayPeer := addTestRelay(t, sender, window)
  128. batches, want := flowTestBatches(2, 3, 1, 6)
  129. var payload []byte
  130. large := flowTCPSuperpacket(0, 9, 45)
  131. large.GSO.Size = 1
  132. payload = append([]byte(nil), large.Bytes[40:]...)
  133. batches = [][]tio.Packet{batches[0], {large}, batches[1]}
  134. sender.f.listenIn(newFlowBatchQueue(append(batches, nil)), 0)
  135. wire := sender.conn.captured()
  136. require.Len(t, wire, len(want)+len(payload))
  137. var got []decodedSeg
  138. var tiny []byte
  139. var lastOuter, lastInner uint64
  140. for i, pkt := range wire {
  141. require.Equal(t, relayRemote, sender.conn.addrs[i])
  142. h := &header.H{}
  143. require.NoError(t, h.Parse(pkt))
  144. require.Greater(t, h.MessageCounter, lastOuter)
  145. lastOuter = h.MessageCounter
  146. require.NoError(t, relayPeer.VerifyRelay(nil, h.MessageCounter, pkt, make([]byte, 12)))
  147. pkt = pkt[header.Len : len(pkt)-16]
  148. require.NoError(t, h.Parse(pkt))
  149. require.Greater(t, h.MessageCounter, lastInner)
  150. lastInner = h.MessageCounter
  151. plain, err := receiver.hostinfo.ConnectionState.Decrypt(receiver.f.l, h.MessageCounter, pkt, make([]byte, 12))
  152. require.NoError(t, err)
  153. if len(plain) == 41 {
  154. tiny = append(tiny, plain[40])
  155. } else {
  156. got = append(got, decodeSeg(plain[40:]))
  157. }
  158. }
  159. require.Equal(t, want, got)
  160. require.Equal(t, payload, tiny)
  161. require.Zero(t, sender.hostinfo.ConnectionState.txBudget.state.Load())
  162. require.Zero(t, relayHI.ConnectionState.txBudget.state.Load())
  163. })
  164. }
  165. }
  166. // addTestRelay makes sender reach its peer only through a relay tunnel with replay windows of window. It returns the
  167. // relay's underlay address, its hostinfo and the relay's side of the tunnel.
  168. func addTestRelay(t testing.TB, sender *flowTestPeer, window uint64) (netip.AddrPort, *HostInfo, *ConnectionState) {
  169. relayInit, relayResp := runTestHandshake(t)
  170. relayCI, err := newConnectionStateFromResult(relayInit)
  171. require.NoError(t, err)
  172. relayPeer, err := newConnectionStateFromResult(relayResp)
  173. require.NoError(t, err)
  174. relayCI.window, relayPeer.window = NewBits(window), NewBits(window)
  175. relayAddr := netip.MustParseAddr("10.0.0.3")
  176. relayRemote := netip.MustParseAddrPort("192.0.2.3:4242")
  177. relay := &Relay{Type: TerminalType, State: Established, LocalIndex: 5, RemoteIndex: 6, PeerAddr: flowTestRemote}
  178. relayHI := &HostInfo{
  179. vpnAddrs: []netip.Addr{relayAddr},
  180. ConnectionState: relayCI,
  181. relayState: RelayState{
  182. relayForByAddr: map[netip.Addr]*Relay{flowTestRemote: relay},
  183. relayForByIdx: map[uint32]*Relay{relay.LocalIndex: relay},
  184. },
  185. }
  186. relayHI.remote.Store(&relayRemote)
  187. sender.f.hostMap.Hosts[relayAddr] = relayHI
  188. sender.hostinfo.remote.Store(&netip.AddrPort{})
  189. sender.hostinfo.relayState.relays = []netip.Addr{relayAddr}
  190. return relayRemote, relayHI, relayPeer
  191. }
  192. // affinityQueue makes every read start with an idle pipeline: before each read it waits until conn has sent what was
  193. // read before, recording how many sends that took, then samples the reader's actual thread affinity.
  194. type affinityQueue struct {
  195. *flowBatchQueue
  196. conn *affinityConn
  197. sent int
  198. boundaries []int
  199. masks []unix.CPUSet
  200. }
  201. func (q *affinityQueue) Read() ([]tio.Packet, error) {
  202. if n := q.reads.Load(); n > 0 {
  203. for _, p := range q.batches[n-1] {
  204. q.sent += p.SegmentCount()
  205. }
  206. }
  207. q.boundaries = append(q.boundaries, q.conn.waitFor(q.sent))
  208. q.masks = append(q.masks, threadMask())
  209. return q.flowBatchQueue.Read()
  210. }
  211. // affinityConn captures every send, sampling the sending thread's actual affinity in each WriteBatch.
  212. type affinityConn struct {
  213. flowCaptureConn
  214. masks []unix.CPUSet
  215. }
  216. func (c *affinityConn) WriteBatch(p [][]byte, addrs []netip.AddrPort) (int, error) {
  217. mask := threadMask()
  218. c.mu.Lock()
  219. c.masks = append(c.masks, mask)
  220. c.mu.Unlock()
  221. return c.flowCaptureConn.WriteBatch(p, addrs)
  222. }
  223. // waitFor waits until n packets were sent and returns how many WriteBatch calls that took.
  224. func (c *affinityConn) waitFor(n int) int {
  225. for len(c.captured()) < n {
  226. time.Sleep(50 * time.Microsecond)
  227. }
  228. c.mu.Lock()
  229. defer c.mu.Unlock()
  230. return len(c.masks)
  231. }
  232. func threadMask() unix.CPUSet {
  233. var mask unix.CPUSet
  234. if err := unix.SchedGetaffinity(0, &mask); err != nil {
  235. panic(err)
  236. }
  237. return mask
  238. }
  239. // requireFlowCPU checks every mask is just cpu, or with cpu -1, the whole allowed set.
  240. func requireFlowCPU(t *testing.T, masks []unix.CPUSet, cpu int, allowed []int) {
  241. t.Helper()
  242. require.NotEmpty(t, masks)
  243. for _, mask := range masks {
  244. if cpu >= 0 {
  245. require.Equal(t, 1, mask.Count())
  246. require.True(t, mask.IsSet(cpu), "expected CPU %d", cpu)
  247. continue
  248. }
  249. require.Equal(t, len(allowed), mask.Count())
  250. for _, c := range allowed {
  251. require.True(t, mask.IsSet(c))
  252. }
  253. }
  254. }
  255. // TestFlowStagedTXAffinity sends large, small and large reads, each from an idle pipeline, and checks the order on the
  256. // wire and where the reader and each send actually ran, for every CPU placement, with one routine and with several. A
  257. // staged sender is only pinned to an explicit entry other than its reader's CPU, and inline sends stay on the reader.
  258. // With the threshold, only the small read goes inline.
  259. // The reader only reads again once its earlier reads are on the wire, so this also checks the sender never waits for
  260. // the reader. Pinning threads changes the process, so the test runs in a child.
  261. func TestFlowStagedTXAffinity(t *testing.T) {
  262. if os.Getenv("NEBULA_FLOW_AFFINITY_TEST") != "1" {
  263. cmd := exec.Command(os.Args[0], "-test.run=^TestFlowStagedTXAffinity$")
  264. cmd.Env = append(os.Environ(), "NEBULA_FLOW_AFFINITY_TEST=1")
  265. out, err := cmd.CombinedOutput()
  266. require.NoError(t, err, "%s", out)
  267. return
  268. }
  269. allowed, err := util.AllowedCPUs()
  270. require.NoError(t, err)
  271. for _, placement := range []string{"fallback", "automatic", "explicit", "explicit-single"} {
  272. for _, pin := range []bool{false, true} {
  273. for _, sc := range sendPaths() {
  274. for _, routines := range []int{1, 2} {
  275. t.Run(fmt.Sprintf("%s/pin=%t/%s/routines=%d", placement, pin, stagedName(sc), routines), func(t *testing.T) {
  276. if pin && len(allowed) < 2 {
  277. t.Skip("requires at least two allowed CPUs")
  278. }
  279. if sc.inlineBelow > 0 {
  280. // Switch on every read that wants the other mode, so the small read goes inline between
  281. // staged ones
  282. sc.gateHold = 1
  283. }
  284. sender, receiver := newFlowTestPair(t, noise.CipherChaChaPoly, sc)
  285. f := sender.f
  286. f.pinThreads, f.routines = pin, routines
  287. switch placement {
  288. case "automatic":
  289. f.defaultCpuAffinity = cpupick.Default(routines, 4242, nil)
  290. case "explicit":
  291. f.cpuAffinity = []int{allowed[len(allowed)-1], allowed[0]}
  292. case "explicit-single":
  293. f.cpuAffinity = allowed[len(allowed)-1:]
  294. }
  295. readerCPU, sendCPU := -1, -1
  296. if pin {
  297. readerCPU = f.threadCPU(0)
  298. sendCPU = readerCPU
  299. if sc.tx {
  300. // Never the reader's CPU, and no automatic choice: unpinned unless an explicit entry fits
  301. sendCPU = -1
  302. if placement == "explicit" {
  303. sendCPU = f.cpuAffinity[1]
  304. }
  305. }
  306. }
  307. smallCPU := sendCPU
  308. if sc.inlineBelow > 0 {
  309. smallCPU = readerCPU
  310. }
  311. conn := &affinityConn{}
  312. f.writers = []udp.Conn{conn}
  313. batches, want := flowTestBatches(3, 8, 1, 45)
  314. batches[1] = batches[1][:1]
  315. want = append(want[:405], want[720:]...)
  316. q := &affinityQueue{flowBatchQueue: newFlowBatchQueue(batches), conn: conn}
  317. inline := metrics.GetOrRegisterCounter("flow.tx.inline", nil)
  318. inline0 := inline.Count()
  319. f.listenIn(q, 0)
  320. require.Equal(t, want, decryptWire(t, receiver, conn.captured()))
  321. if sc.inlineBelow > 0 {
  322. require.Equal(t, int64(1), inline.Count()-inline0)
  323. }
  324. b := q.boundaries
  325. requireFlowCPU(t, q.masks, readerCPU, allowed)
  326. requireFlowCPU(t, conn.masks[:b[1]], sendCPU, allowed)
  327. requireFlowCPU(t, conn.masks[b[1]:b[2]], smallCPU, allowed)
  328. requireFlowCPU(t, conn.masks[b[2]:], sendCPU, allowed)
  329. })
  330. }
  331. }
  332. }
  333. }
  334. }
  335. // sendPaths is inline, staged and, with the threshold, adaptive transmit.
  336. func sendPaths() []stagedConfig {
  337. return []stagedConfig{{}, stagedOn(2), adaptive(2)}
  338. }
  339. // requireAccepted checks the receiver accepts every packet of wire in the order given. With several readers the wire
  340. // order differs from counter order, but every packet must still authenticate and fit within the replay window.
  341. func requireAccepted(t *testing.T, receiver *flowTestPeer, wire [][]byte) {
  342. t.Helper()
  343. for _, pkt := range wire {
  344. h := &header.H{}
  345. require.NoError(t, h.Parse(pkt))
  346. _, err := receiver.hostinfo.ConnectionState.Decrypt(receiver.f.l, h.MessageCounter, pkt, make([]byte, 12))
  347. require.NoError(t, err, "counter %d", h.MessageCounter)
  348. }
  349. }
  350. // slowConn delays every WriteBatch, then writes to the shared capture.
  351. type slowConn struct {
  352. *flowCaptureConn
  353. delay time.Duration
  354. }
  355. func (c slowConn) WriteBatch(bufs [][]byte, addrs []netip.AddrPort) (int, error) {
  356. time.Sleep(c.delay)
  357. return c.flowCaptureConn.WriteBatch(bufs, addrs)
  358. }
  359. // TestFlowTXBudgetManyReaders saturates one tunnel from eight readers, one of them on a slow socket that lets the
  360. // others overtake it, alongside a burst of unreserved control messages: in the order they reach the wire, every packet
  361. // is accepted by the receiver's replay window, so none was sent twice or displaced past the window.
  362. func TestFlowTXBudgetManyReaders(t *testing.T) {
  363. defer goleak.VerifyNone(t, goleak.IgnoreCurrent())
  364. for _, window := range budgetWindows {
  365. t.Run(fmt.Sprintf("window=%d", window), func(t *testing.T) {
  366. sender, receiver := newFlowTestPair(t, noise.CipherChaChaPoly, stagedOn(3))
  367. ci := sender.hostinfo.ConnectionState
  368. ci.window = NewBits(window)
  369. receiver.hostinfo.ConnectionState.window = NewBits(window)
  370. sender.f.routines = 8
  371. sender.f.writers = append([]udp.Conn{slowConn{sender.conn, 4 * time.Millisecond}}, slices.Repeat(sender.f.writers, 8)...)
  372. start := ci.messageCounter.Load()
  373. var wg sync.WaitGroup
  374. for q := range 8 {
  375. wg.Go(func() {
  376. batches, _ := flowTestBatches(28, 8, 2, 45)
  377. p := newStagedTx(sender.f, newFlowBatchQueue(nil), q)
  378. defer p.close()
  379. for _, packets := range batches {
  380. p.send(packets)
  381. }
  382. })
  383. }
  384. // A bounded burst of unreserved control messages uses the documented margin, on writer 8
  385. wg.Go(func() {
  386. for range 128 {
  387. sender.f.sendNoMetrics(header.Test, header.TestRequest, ci, sender.hostinfo, flowTestUnder, []byte("x"), make([]byte, 12), make([]byte, mtu), 8)
  388. time.Sleep(100 * time.Microsecond)
  389. }
  390. })
  391. wg.Wait()
  392. require.Zero(t, ci.txBudget.state.Load())
  393. wire := sender.conn.captured()
  394. require.Len(t, wire, 8*28*360+128)
  395. require.Equal(t, start+uint64(len(wire)), ci.messageCounter.Load())
  396. requireAccepted(t, receiver, wire)
  397. })
  398. }
  399. }
  400. // TestFlowStagedTXInlineOnlyWhenEmpty: a small read behind a staged batch still in flight must not go inline before
  401. // that batch is on the wire, it would overtake it.
  402. func TestFlowStagedTXInlineOnlyWhenEmpty(t *testing.T) {
  403. defer goleak.VerifyNone(t, goleak.IgnoreCurrent())
  404. sc := adaptive(2)
  405. sc.inlineBelow, sc.gateHold = 4, 1
  406. sender, receiver := newFlowTestPair(t, noise.CipherChaChaPoly, sc)
  407. p := newStagedTx(sender.f, newFlowBatchQueue(nil), 0)
  408. block := make(chan struct{})
  409. delayCrypto(sender, func(uint64) { <-block })
  410. batches, want := flowTestBatches(1, 4, 1, 3)
  411. p.send(batches[0][:3]) // switches to fanout, its worker is blocked
  412. require.Equal(t, 1, p.inFlight)
  413. unblock := time.AfterFunc(20*time.Millisecond, func() { close(block) })
  414. defer unblock.Stop()
  415. p.send(batches[0][3:]) // switches to inline, which waits for the staged batch first
  416. require.Zero(t, p.inFlight)
  417. p.close()
  418. require.Equal(t, want, decryptWire(t, receiver, sender.conn.captured()))
  419. }
  420. // TestFlowStagedTXInlineBelowZero: with inline_below 0 an idle reader never sends a batch itself, in either
  421. // direction: every read goes through the workers and the ordered sender or writer.
  422. func TestFlowStagedTXInlineBelowZero(t *testing.T) {
  423. defer goleak.VerifyNone(t, goleak.IgnoreCurrent())
  424. l := test.NewLogger()
  425. c := config.NewC(l)
  426. c.Settings = map[string]any{"tun": map[string]any{"staged": map[string]any{"workers": 2, "inline_below": 0}}}
  427. sc := parseStagedConfig(c, l)
  428. if !sc.tx {
  429. t.Skip("transmit stays inline in this build")
  430. }
  431. sender, receiver := newFlowTestPair(t, noise.CipherChaChaPoly, sc)
  432. batches, want := flowTestBatches(20, 2, 1, 4)
  433. txInline := metrics.GetOrRegisterCounter("flow.tx.inline", nil)
  434. tx := metrics.GetOrRegisterCounter("flow.tx.batches", nil)
  435. rxInline := metrics.GetOrRegisterCounter("flow.rx.inline", nil)
  436. txInline0, tx0, rxInline0, rx0 := txInline.Count(), tx.Count(), rxInline.Count(), rxBatches.Count()
  437. sender.f.listenIn(newFlowBatchQueue(batches), 0)
  438. wire := sender.conn.captured()
  439. require.Equal(t, want, decryptWire(t, receiver, wire))
  440. require.Zero(t, txInline.Count()-txInline0)
  441. require.Equal(t, int64(len(batches)), tx.Count()-tx0)
  442. receiver.receive(&rxConn{wire: wire, sizes: []int{1, 2, 4}})
  443. require.Equal(t, want, receiver.tun.segments(t))
  444. require.Zero(t, rxInline.Count()-rxInline0)
  445. require.Positive(t, rxBatches.Count()-rx0)
  446. }
  447. // TestFlowStagedTXDisabled: with tx false the reader never builds a staged pipeline, even on a queue that could hand
  448. // off its batches. Receive stays staged.
  449. func TestFlowStagedTXDisabled(t *testing.T) {
  450. defer goleak.VerifyNone(t, goleak.IgnoreCurrent())
  451. l := test.NewLogger()
  452. c := config.NewC(l)
  453. c.Settings = map[string]any{"tun": map[string]any{"staged": map[string]any{"workers": 2, "tx": false}}}
  454. sc := parseStagedConfig(c, l)
  455. require.False(t, sc.tx)
  456. require.True(t, sc.rx)
  457. sender, receiver := newFlowTestPair(t, noise.CipherChaChaPoly, sc)
  458. batches, want := flowTestBatches(4, 8, 1, 45)
  459. tx := metrics.GetOrRegisterCounter("flow.tx.batches", nil)
  460. txInline := metrics.GetOrRegisterCounter("flow.tx.inline", nil)
  461. tx0, txInline0, rx0 := tx.Count(), txInline.Count(), rxBatches.Count()
  462. q := &swapCountQueue{flowBatchQueue: newFlowBatchQueue(batches)}
  463. sender.f.listenIn(q, 0)
  464. wire := sender.conn.captured()
  465. require.Equal(t, want, decryptWire(t, receiver, wire))
  466. require.Zero(t, q.swaps, "newStagedTx always takes the queue's buffer, so it never ran")
  467. require.Equal(t, tx0, tx.Count())
  468. require.Equal(t, txInline0, txInline.Count())
  469. receiver.receive(&rxConn{wire: wire, batchLen: 512})
  470. require.Equal(t, want, receiver.tun.segments(t))
  471. require.Greater(t, rxBatches.Count(), rx0)
  472. }
  473. // swapCountQueue counts SwapRxBuf calls.
  474. type swapCountQueue struct {
  475. *flowBatchQueue
  476. swaps int
  477. }
  478. func (q *swapCountQueue) SwapRxBuf(buf []byte) []byte {
  479. q.swaps++
  480. return q.flowBatchQueue.SwapRxBuf(buf)
  481. }
  482. // TestFlowStagedTXAdaptiveBudget: a fast reader's adaptive sends must stop spending credit until another reader's
  483. // earlier reservation reaches the wire.
  484. func TestFlowStagedTXAdaptiveBudget(t *testing.T) {
  485. for _, shape := range []struct {
  486. name string
  487. packets, segments int
  488. }{
  489. {"single", 1, 1}, {"batch", 8, 30},
  490. } {
  491. t.Run(shape.name, func(t *testing.T) {
  492. defer goleak.VerifyNone(t, goleak.IgnoreCurrent())
  493. sc := adaptive(2)
  494. // p0's large read must go to the workers at once, p1 stays inline
  495. sc.gateHold = 1
  496. sender, receiver := newFlowTestPair(t, noise.CipherChaChaPoly, sc)
  497. sender.f.routines = 2
  498. sender.f.writers = []udp.Conn{sender.conn, sender.conn}
  499. ci := sender.hostinfo.ConnectionState
  500. start := ci.messageCounter.Load()
  501. entered, unblock := make(chan struct{}), make(chan struct{})
  502. delayCrypto(sender, func(n uint64) {
  503. if n == start+1 {
  504. close(entered)
  505. <-unblock
  506. }
  507. })
  508. p0 := newStagedTx(sender.f, newFlowBatchQueue(nil), 0)
  509. p1 := newStagedTx(sender.f, newFlowBatchQueue(nil), 1)
  510. defer p0.close()
  511. defer p1.close()
  512. var release sync.Once
  513. defer release.Do(func() { close(unblock) })
  514. large, _ := flowTestBatches(1, 8, 1, 45)
  515. p0.send(large[0])
  516. <-entered
  517. perBatch := shape.packets * shape.segments
  518. small, _ := flowTestBatches(9600/perBatch, shape.packets, 1, shape.segments)
  519. fits := int(ci.txBudgetLimit()-360) / perBatch
  520. for _, packets := range small[:fits] {
  521. p1.send(packets)
  522. }
  523. require.Equal(t, uint64(360+fits*perBatch), (ci.txBudget.state.Load()>>24)&txBudgetMask, "inline sends must spend shared credit")
  524. done := make(chan struct{})
  525. go func() {
  526. defer close(done)
  527. for _, packets := range small[fits:] {
  528. p1.send(packets)
  529. }
  530. }()
  531. select {
  532. case <-done:
  533. t.Error("adaptive reader bypassed outstanding credit")
  534. case <-time.After(50 * time.Millisecond):
  535. }
  536. require.LessOrEqual(t, ci.messageCounter.Load()-start, ci.txBudgetLimit())
  537. release.Do(func() { close(unblock) })
  538. <-done
  539. p0.drain()
  540. p1.drain()
  541. wire := sender.conn.captured()
  542. require.Len(t, wire, 360+40*240)
  543. requireAccepted(t, receiver, wire)
  544. require.Zero(t, ci.txBudget.state.Load())
  545. })
  546. }
  547. }
  548. // BenchmarkFlowStagedTX runs reads of eight 45-segment superpackets through listenIn into a socket that discards
  549. // them, inline and staged.
  550. func BenchmarkFlowStagedTX(b *testing.B) {
  551. for _, cipher := range []noise.CipherFunc{noiseutil.CipherAESGCM, noise.CipherChaChaPoly} {
  552. for _, sc := range []stagedConfig{{}, stagedOn(4)} {
  553. b.Run(cipher.CipherName()+"/"+stagedName(sc), func(b *testing.B) {
  554. if sc.tx && cipher.CipherName() == noiseutil.CipherAESGCM.CipherName() && noiseutil.EncryptLockNeeded {
  555. b.Skip("AES-GCM requires encryption in nonce order")
  556. }
  557. sender, _ := newFlowTestPair(b, cipher, sc)
  558. sender.f.writers = []udp.Conn{udp.NoopConn{}}
  559. batch, _ := flowTestBatches(1, 8, 4, 45)
  560. batches := make([][]tio.Packet, b.N)
  561. for i := range batches {
  562. batches[i] = batch[0]
  563. }
  564. b.SetBytes(int64(8 * 45 * flowTestMSS))
  565. b.ReportAllocs()
  566. b.ResetTimer()
  567. sender.f.listenIn(newFlowBatchQueue(batches), 0)
  568. })
  569. }
  570. }
  571. }