summaryrefslogtreecommitdiff
path: root/internal/probemanager/manager_test.go
blob: ee436b9f066aced107d1b31d846c3fefce764ece (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
package probemanager

import (
	"errors"
	"ior/internal/tracepoints"
	"strings"
	"sync"
	"testing"
	"time"
)

type fakeLink struct {
	mu        sync.Mutex
	destroyed int
	err       error
	onDestroy func()
}

func (l *fakeLink) Destroy() error {
	l.mu.Lock()
	l.destroyed++
	onDestroy := l.onDestroy
	l.mu.Unlock()

	if onDestroy != nil {
		onDestroy()
	}
	return l.err
}

func (l *fakeLink) destroyCalls() int {
	l.mu.Lock()
	defer l.mu.Unlock()
	return l.destroyed
}

type fakeProgram struct {
	mu         sync.Mutex
	tracepoint string
	attachs    int
	link       *fakeLink
	err        error
	onAttach   func()
}

func (p *fakeProgram) AttachTracepoint(_, name string) (Link, error) {
	p.mu.Lock()
	p.tracepoint = name
	p.attachs++
	onAttach := p.onAttach
	p.mu.Unlock()

	if onAttach != nil {
		onAttach()
	}
	if p.err != nil {
		return nil, p.err
	}
	if p.link == nil {
		p.link = &fakeLink{}
	}
	return p.link, nil
}

func (p *fakeProgram) attachCalls() int {
	p.mu.Lock()
	defer p.mu.Unlock()
	return p.attachs
}

type fakeAttacher struct {
	programs map[string]*fakeProgram
	errs     map[string]error
}

func (a *fakeAttacher) GetProgram(name string) (Program, error) {
	if err, ok := a.errs[name]; ok {
		return nil, err
	}
	p, ok := a.programs[name]
	if !ok {
		return nil, errors.New("missing program")
	}
	return p, nil
}

func TestManagerAttachAllToggleAndCounts(t *testing.T) {
	attacher := &fakeAttacher{
		programs: map[string]*fakeProgram{
			"handle_sys_enter_read":  {},
			"handle_sys_exit_read":   {},
			"handle_sys_enter_write": {},
			"handle_sys_exit_write":  {},
		},
		errs: map[string]error{},
	}
	mgr := NewManager(attacher)

	err := mgr.AttachAll(func(tp string) bool { return tp == "sys_enter_read" || tp == "sys_exit_read" }, []string{
		"sys_enter_read", "sys_exit_read", "sys_enter_write", "sys_exit_write",
	}, nil)
	if err != nil {
		t.Fatalf("AttachAll returned error: %v", err)
	}

	active, total := mgr.ActiveCount()
	if active != 1 || total != 2 {
		t.Fatalf("unexpected counts active=%d total=%d", active, total)
	}

	states := mgr.States()
	if len(states) != 2 {
		t.Fatalf("expected 2 states, got %d", len(states))
	}
	if states[0].Syscall != "read" || !states[0].Active {
		t.Fatalf("expected read active first, got %+v", states[0])
	}
	if states[1].Syscall != "write" || states[1].Active {
		t.Fatalf("expected write inactive second, got %+v", states[1])
	}

	if err := mgr.Toggle("write"); err != nil {
		t.Fatalf("Toggle(write) returned error: %v", err)
	}
	active, total = mgr.ActiveCount()
	if active != 2 || total != 2 {
		t.Fatalf("unexpected counts after toggle active=%d total=%d", active, total)
	}
}

func TestManagerAttachAllWithDimensionSelectorAttachesOnlyEnabledSyscalls(t *testing.T) {
	attacher := &fakeAttacher{
		programs: map[string]*fakeProgram{
			"handle_sys_enter_openat": {},
			"handle_sys_exit_openat":  {},
			"handle_sys_enter_write":  {},
			"handle_sys_exit_write":   {},
		},
		errs: map[string]error{},
	}
	mgr := NewManager(attacher)
	selector, err := tracepoints.ParseSelectorWithDimensions("", "", tracepoints.DimensionSelectorConfig{
		TraceSyscalls: "openat",
	})
	if err != nil {
		t.Fatalf("build selector: %v", err)
	}

	err = mgr.AttachAll(selector.ShouldAttach, []string{
		"sys_enter_openat", "sys_exit_openat",
		"sys_enter_write", "sys_exit_write",
	}, nil)
	if err != nil {
		t.Fatalf("AttachAll returned error: %v", err)
	}

	if got := attacher.programs["handle_sys_enter_openat"].attachCalls(); got != 1 {
		t.Fatalf("openat enter attach calls = %d, want 1", got)
	}
	if got := attacher.programs["handle_sys_exit_openat"].attachCalls(); got != 1 {
		t.Fatalf("openat exit attach calls = %d, want 1", got)
	}
	if got := attacher.programs["handle_sys_enter_write"].attachCalls(); got != 0 {
		t.Fatalf("write enter attach calls = %d, want 0", got)
	}
	if got := attacher.programs["handle_sys_exit_write"].attachCalls(); got != 0 {
		t.Fatalf("write exit attach calls = %d, want 0", got)
	}
}

func TestManagerAttachSerializesConcurrentCalls(t *testing.T) {
	enterBlocked := make(chan struct{})
	releaseEnter := make(chan struct{})
	enter := &fakeProgram{link: &fakeLink{}}
	var enteredOnce sync.Once
	enter.onAttach = func() {
		enteredOnce.Do(func() { close(enterBlocked) })
		<-releaseEnter
	}
	exit := &fakeProgram{link: &fakeLink{}}
	attacher := &fakeAttacher{
		programs: map[string]*fakeProgram{
			"handle_sys_enter_close": enter,
			"handle_sys_exit_close":  exit,
		},
		errs: map[string]error{},
	}
	mgr := NewManager(attacher)
	mgr.Register("close", TracepointPair{Enter: "sys_enter_close", Exit: "sys_exit_close"})

	errCh1 := make(chan error, 1)
	go func() {
		errCh1 <- mgr.Attach("close")
	}()

	select {
	case <-enterBlocked:
	case <-time.After(time.Second):
		t.Fatal("first attach did not start")
	}

	// Goroutine 1 is now blocked inside AttachTracepoint for the enter probe.
	// Enter has been called exactly once; exit has not been called yet because
	// attachPair calls enter then exit sequentially.  These assertions are safe
	// without any sleep: enterBlocked being closed is a happens-before edge that
	// makes the attach-count writes visible here.
	if got := enter.attachCalls(); got != 1 {
		t.Fatalf("expected enter attach to be in flight (called once), got %d", got)
	}
	if got := exit.attachCalls(); got != 0 {
		t.Fatalf("expected exit attach to not have started while enter is blocked, got %d", got)
	}

	// Start a second concurrent Attach.  It will acquire m.mu briefly then
	// block on entry.attachMu (held by goroutine 1) before it can reach
	// AttachTracepoint.  The final count assertions below confirm it never ran
	// a second attach.
	errCh2 := make(chan error, 1)
	go func() {
		errCh2 <- mgr.Attach("close")
	}()

	close(releaseEnter)

	if err := <-errCh1; err != nil {
		t.Fatalf("first Attach returned error: %v", err)
	}
	if err := <-errCh2; err != nil {
		t.Fatalf("second Attach returned error: %v", err)
	}
	if got := enter.attachCalls(); got != 1 {
		t.Fatalf("expected enter attach to run once, got %d", got)
	}
	if got := exit.attachCalls(); got != 1 {
		t.Fatalf("expected exit attach to run once, got %d", got)
	}
	if !mgr.IsActive("close") {
		t.Fatalf("expected probe to remain active after concurrent attach calls")
	}
}

func TestManagerAttachWaitsForDetachBeforeReturning(t *testing.T) {
	enterDestroyStarted := make(chan struct{})
	releaseDestroy := make(chan struct{})
	var enterDestroyOnce sync.Once
	enter := &fakeLink{}
	enter.onDestroy = func() {
		enterDestroyOnce.Do(func() { close(enterDestroyStarted) })
		<-releaseDestroy
	}
	exit := &fakeLink{}
	enterProg := &fakeProgram{link: enter}
	exitProg := &fakeProgram{link: exit}
	attacher := &fakeAttacher{
		programs: map[string]*fakeProgram{
			"handle_sys_enter_close": enterProg,
			"handle_sys_exit_close":  exitProg,
		},
		errs: map[string]error{},
	}
	mgr := NewManager(attacher)
	if err := mgr.AttachAll(nil, []string{"sys_enter_close", "sys_exit_close"}, nil); err != nil {
		t.Fatalf("AttachAll returned error: %v", err)
	}

	detachErrCh := make(chan error, 1)
	go func() {
		detachErrCh <- mgr.Detach("close")
	}()

	select {
	case <-enterDestroyStarted:
	case <-time.After(time.Second):
		t.Fatal("detach did not start destroying the enter link")
	}

	attachErrCh := make(chan error, 1)
	go func() {
		attachErrCh <- mgr.Attach("close")
	}()

	select {
	case err := <-attachErrCh:
		t.Fatalf("Attach returned before Detach completed: %v", err)
	case <-time.After(50 * time.Millisecond):
	}

	close(releaseDestroy)

	if err := <-detachErrCh; err != nil {
		t.Fatalf("Detach returned error: %v", err)
	}
	if err := <-attachErrCh; err != nil {
		t.Fatalf("Attach returned error: %v", err)
	}
	if got := enterProg.attachCalls(); got != 2 {
		t.Fatalf("expected enter attach to run twice, got %d", got)
	}
	if got := exitProg.attachCalls(); got != 2 {
		t.Fatalf("expected exit attach to run twice, got %d", got)
	}
	if got := enter.destroyCalls(); got != 1 {
		t.Fatalf("expected enter link to be destroyed once, got %d", got)
	}
	if got := exit.destroyCalls(); got != 1 {
		t.Fatalf("expected exit link to be destroyed once, got %d", got)
	}
	if !mgr.IsActive("close") {
		t.Fatalf("expected probe to be active after detach followed by attach")
	}
}

func TestManagerCloseWaitsForDetachAndDoesNotDoubleDestroy(t *testing.T) {
	enterDestroyStarted := make(chan struct{})
	releaseDestroy := make(chan struct{})
	var enterDestroyOnce sync.Once
	enter := &fakeLink{}
	enter.onDestroy = func() {
		enterDestroyOnce.Do(func() { close(enterDestroyStarted) })
		<-releaseDestroy
	}
	exit := &fakeLink{}
	enterProg := &fakeProgram{link: enter}
	exitProg := &fakeProgram{link: exit}
	attacher := &fakeAttacher{
		programs: map[string]*fakeProgram{
			"handle_sys_enter_close": enterProg,
			"handle_sys_exit_close":  exitProg,
		},
		errs: map[string]error{},
	}
	mgr := NewManager(attacher)
	if err := mgr.AttachAll(nil, []string{"sys_enter_close", "sys_exit_close"}, nil); err != nil {
		t.Fatalf("AttachAll returned error: %v", err)
	}

	detachErrCh := make(chan error, 1)
	go func() {
		detachErrCh <- mgr.Detach("close")
	}()

	select {
	case <-enterDestroyStarted:
	case <-time.After(time.Second):
		t.Fatal("detach did not start destroying the enter link")
	}

	closeErrCh := make(chan error, 1)
	go func() {
		closeErrCh <- mgr.Close()
	}()

	select {
	case err := <-closeErrCh:
		t.Fatalf("Close returned before Detach completed: %v", err)
	case <-time.After(50 * time.Millisecond):
	}

	close(releaseDestroy)

	if err := <-detachErrCh; err != nil {
		t.Fatalf("Detach returned error: %v", err)
	}
	if err := <-closeErrCh; err != nil {
		t.Fatalf("Close returned error: %v", err)
	}
	if got := enter.destroyCalls(); got != 1 {
		t.Fatalf("expected enter link to be destroyed once, got %d", got)
	}
	if got := exit.destroyCalls(); got != 1 {
		t.Fatalf("expected exit link to be destroyed once, got %d", got)
	}
	if mgr.IsActive("close") {
		t.Fatalf("expected probe to be inactive after Close")
	}
}

func TestManagerDetachDestroysLinks(t *testing.T) {
	enter := &fakeLink{}
	exit := &fakeLink{}
	attacher := &fakeAttacher{
		programs: map[string]*fakeProgram{
			"handle_sys_enter_close": {link: enter},
			"handle_sys_exit_close":  {link: exit},
		},
		errs: map[string]error{},
	}
	mgr := NewManager(attacher)
	if err := mgr.AttachAll(nil, []string{"sys_enter_close", "sys_exit_close"}, nil); err != nil {
		t.Fatalf("AttachAll returned error: %v", err)
	}
	if err := mgr.Detach("close"); err != nil {
		t.Fatalf("Detach returned error: %v", err)
	}
	if enter.destroyed != 1 || exit.destroyed != 1 {
		t.Fatalf("expected both links destroyed once, got enter=%d exit=%d", enter.destroyed, exit.destroyed)
	}
}

func TestManagerDetachFailureKeepsActiveStateForUndetachedLink(t *testing.T) {
	enter := &fakeLink{err: errors.New("destroy failed")}
	exit := &fakeLink{}
	attacher := &fakeAttacher{
		programs: map[string]*fakeProgram{
			"handle_sys_enter_close": {link: enter},
			"handle_sys_exit_close":  {link: exit},
		},
		errs: map[string]error{},
	}
	mgr := NewManager(attacher)
	if err := mgr.AttachAll(nil, []string{"sys_enter_close", "sys_exit_close"}, nil); err != nil {
		t.Fatalf("AttachAll returned error: %v", err)
	}

	err := mgr.Detach("close")
	if err == nil {
		t.Fatalf("expected detach error")
	}
	states := mgr.States()
	if len(states) != 1 {
		t.Fatalf("expected one state, got %+v", states)
	}
	if !states[0].Active {
		t.Fatalf("expected probe to remain active when one link failed to detach")
	}
	if states[0].Error == "" {
		t.Fatalf("expected error to be recorded after detach failure")
	}
}

func TestManagerClosePreventsFurtherOperations(t *testing.T) {
	attacher := &fakeAttacher{
		programs: map[string]*fakeProgram{
			"handle_sys_enter_open": {},
			"handle_sys_exit_open":  {},
		},
		errs: map[string]error{},
	}
	mgr := NewManager(attacher)
	if err := mgr.AttachAll(nil, []string{"sys_enter_open", "sys_exit_open"}, nil); err != nil {
		t.Fatalf("AttachAll returned error: %v", err)
	}
	if err := mgr.Close(); err != nil {
		t.Fatalf("Close returned error: %v", err)
	}
	if err := mgr.Toggle("open"); err == nil {
		t.Fatalf("expected Toggle to fail after Close")
	}
}

func TestManagerAttachAllReturnsProgramError(t *testing.T) {
	attacher := &fakeAttacher{
		programs: map[string]*fakeProgram{},
		errs: map[string]error{
			"handle_sys_enter_read": errors.New("boom"),
		},
	}
	mgr := NewManager(attacher)
	err := mgr.AttachAll(nil, []string{"sys_enter_read", "sys_exit_read"}, nil)
	if err == nil {
		t.Fatalf("expected attach error")
	}
	states := mgr.States()
	if len(states) != 1 || states[0].Error == "" {
		t.Fatalf("expected state to capture attach error, got %+v", states)
	}
}

// When onAttachError is supplied, AttachAll should report each per-syscall
// failure through the callback and continue attaching the remaining probes.
// This is the path that lets a binary built on a newer kernel run on an older
// one where some tracepoints don't exist.
func TestManagerAttachAllWarnAndContinue(t *testing.T) {
	attacher := &fakeAttacher{
		programs: map[string]*fakeProgram{
			"handle_sys_enter_write": {},
			"handle_sys_exit_write":  {},
		},
		errs: map[string]error{
			"handle_sys_enter_read": errors.New("no such tracepoint"),
		},
	}
	mgr := NewManager(attacher)

	var warned []string
	warn := func(syscall string, err error) {
		warned = append(warned, syscall+":"+err.Error())
	}
	err := mgr.AttachAll(nil, []string{
		"sys_enter_read", "sys_exit_read",
		"sys_enter_write", "sys_exit_write",
	}, warn)
	if err != nil {
		t.Fatalf("AttachAll returned error despite warn callback: %v", err)
	}
	if len(warned) != 1 {
		t.Fatalf("expected exactly 1 warning, got %d (%v)", len(warned), warned)
	}
	if !strings.Contains(warned[0], "read") || !strings.Contains(warned[0], "no such tracepoint") {
		t.Fatalf("unexpected warning text: %q", warned[0])
	}
	active, total := mgr.ActiveCount()
	if active != 1 || total != 2 {
		t.Fatalf("expected write attached and read skipped, got active=%d total=%d", active, total)
	}
}

func TestManagerAttachAllPicksUpNewTracepointsOnLaterCall(t *testing.T) {
	attacher := &fakeAttacher{
		programs: map[string]*fakeProgram{
			"handle_sys_enter_read":  {},
			"handle_sys_exit_read":   {},
			"handle_sys_enter_write": {},
			"handle_sys_exit_write":  {},
		},
		errs: map[string]error{},
	}
	mgr := NewManager(attacher)

	if err := mgr.AttachAll(nil, []string{"sys_enter_read", "sys_exit_read"}, nil); err != nil {
		t.Fatalf("AttachAll(read) returned error: %v", err)
	}
	states := mgr.States()
	if len(states) != 1 || states[0].Syscall != "read" {
		t.Fatalf("expected only read after first call, got %+v", states)
	}

	if err := mgr.AttachAll(nil, []string{"sys_enter_read", "sys_exit_read", "sys_enter_write", "sys_exit_write"}, nil); err != nil {
		t.Fatalf("AttachAll(read+write) returned error: %v", err)
	}
	states = mgr.States()
	if len(states) != 2 {
		t.Fatalf("expected new syscall to appear after second call, got %+v", states)
	}
	if states[0].Syscall != "read" || states[1].Syscall != "write" {
		t.Fatalf("unexpected syscall ordering/content: %+v", states)
	}
}

func TestManagerIsActiveReflectsCurrentState(t *testing.T) {
	attacher := &fakeAttacher{
		programs: map[string]*fakeProgram{
			"handle_sys_enter_read": {},
			"handle_sys_exit_read":  {},
		},
		errs: map[string]error{},
	}
	mgr := NewManager(attacher)
	if err := mgr.AttachAll(nil, []string{"sys_enter_read", "sys_exit_read"}, nil); err != nil {
		t.Fatalf("AttachAll returned error: %v", err)
	}
	if !mgr.IsActive("read") {
		t.Fatalf("expected read to be active")
	}
	if err := mgr.Detach("read"); err != nil {
		t.Fatalf("Detach returned error: %v", err)
	}
	if mgr.IsActive("read") {
		t.Fatalf("expected read to be inactive after detach")
	}
	if mgr.IsActive("does_not_exist") {
		t.Fatalf("expected unknown syscall to be inactive")
	}
}

func TestAttachReturnsCleanupErrorsWhenManagerClosesMidAttach(t *testing.T) {
	enterDestroyErr := errors.New("enter cleanup failed")
	exitDestroyErr := errors.New("exit cleanup failed")
	enter := &fakeLink{err: enterDestroyErr}
	exit := &fakeLink{err: exitDestroyErr}

	attacher := &fakeAttacher{
		programs: map[string]*fakeProgram{
			"handle_sys_enter_close": {link: enter},
			"handle_sys_exit_close":  {link: exit},
		},
		errs: map[string]error{},
	}
	mgr := NewManager(attacher)
	attacher.programs["handle_sys_exit_close"].onAttach = func() {
		if err := mgr.Close(); err != nil {
			t.Fatalf("Close returned error during attach hook: %v", err)
		}
	}
	mgr.Register("close", TracepointPair{Enter: "sys_enter_close", Exit: "sys_exit_close"})

	err := mgr.Attach("close")
	if err == nil {
		t.Fatalf("expected attach error when manager closes mid-attach")
	}
	if !strings.Contains(err.Error(), "probe manager is closed") {
		t.Fatalf("expected close error in attach result, got %v", err)
	}
	if !errors.Is(err, enterDestroyErr) {
		t.Fatalf("expected joined enter cleanup error, got %v", err)
	}
	if !errors.Is(err, exitDestroyErr) {
		t.Fatalf("expected joined exit cleanup error, got %v", err)
	}
	if enter.destroyed != 1 || exit.destroyed != 1 {
		t.Fatalf("expected both cleanup destroys to run once, got enter=%d exit=%d", enter.destroyed, exit.destroyed)
	}
}

func TestAttachPairReturnsCleanupErrorWhenExitAttachFails(t *testing.T) {
	enterDestroyErr := errors.New("enter cleanup failed")
	exitAttachErr := errors.New("exit attach failed")
	enter := &fakeLink{err: enterDestroyErr}

	attacher := &fakeAttacher{
		programs: map[string]*fakeProgram{
			"handle_sys_enter_close": {link: enter},
			"handle_sys_exit_close":  {err: exitAttachErr},
		},
		errs: map[string]error{},
	}

	enterLink, exitLink, err := attachPair(attacher, "sys_enter_close", "sys_exit_close")
	if err == nil {
		t.Fatalf("expected attachPair error")
	}
	if enterLink != nil || exitLink != nil {
		t.Fatalf("expected failed attachPair to return nil links, got enter=%v exit=%v", enterLink, exitLink)
	}
	if !errors.Is(err, exitAttachErr) {
		t.Fatalf("expected exit attach error in result, got %v", err)
	}
	if !errors.Is(err, enterDestroyErr) {
		t.Fatalf("expected enter cleanup error in result, got %v", err)
	}
	if enter.destroyed != 1 {
		t.Fatalf("expected enter link cleanup to run once, got %d", enter.destroyed)
	}
}