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
|
package generate
import (
"fmt"
"strings"
)
func generateBPFHandler(tp GeneratedTracepoint) string {
f := tp.Format
isEnter := strings.Split(f.Name, "_")[1] == "enter"
// Use the kernel's actual tracepoint context structs (syscall_trace_enter/exit)
// rather than the BTF-emitted trace_event_raw_sys_enter/exit aliases. On RHEL 9
// kernels (5.14 with the rt-merge backport that added preempt_lazy_count to
// trace_entry) the two diverge: trace_event_raw_sys_* grows by 8 bytes and
// the args/ret offsets shift, but the real context handed to the BPF program
// is still syscall_trace_*. Reading via the wider alias trips the verifier's
// max_ctx_offset check and the attach fails with EACCES. The two structs are
// identical on non-RHEL kernels, so this is a no-op everywhere else.
ctxStruct := "syscall_trace_exit"
if isEnter {
ctxStruct = "syscall_trace_enter"
}
eventStruct := eventStructName(tp.Classification.Kind)
comment := fmt.Sprintf("%s (kind=%s)", eventStruct, tp.Classification.Kind.MetadataName())
if tp.Classification.Kind == KindRet {
comment = fmt.Sprintf("%s (%s) (kind=%s)", eventStruct, ClassifyRet(f.Name), tp.Classification.Kind.MetadataName())
}
eventTypeConst := eventTypeConstant(tp.Classification.Kind, isEnter)
extra := generateExtra(tp, isEnter)
// Derive the explicit enter trace ID constant for exit handlers so the
// generated ior_on_syscall_exit call does not rely on numeric adjacency
// between kernel-assigned enter/exit IDs.
enterName := enterConstForHandler(f.Name, isEnter)
// Noreturn syscalls (exit, exit_group, rt_sigreturn) get a special enter
// hook that skips the syscall_enter_state_map write. Their exit handler is
// suppressed (see codegen.go), so nothing would ever clear a recorded
// enter-state entry; recording it would only leak stale per-tid entries in
// the bounded map.
noreturn := isEnter && isNoreturnSyscall(syscallName(f.Name))
return renderHandler(f.Name, ctxStruct, eventStruct, comment, eventTypeConst, extra, isEnter, noreturn, enterName)
}
// enterConstForHandler returns the C #define constant name for the
// corresponding enter tracepoint. For enter handlers it returns
// strings.ToUpper(name) directly; for exit handlers it replaces "EXIT"
// with "ENTER" so the generated code passes the explicit enter ID.
func enterConstForHandler(name string, isEnter bool) string {
upper := strings.ToUpper(name)
if isEnter {
return upper
}
return strings.Replace(upper, "SYS_EXIT_", "SYS_ENTER_", 1)
}
func renderHandler(name, ctxStruct, eventStruct, comment, eventTypeConst, extra string, isEnter, noreturn bool, enterName string) string {
var b strings.Builder
fmt.Fprintf(&b, "/// %s is a struct %s\n", name, comment)
fmt.Fprintf(&b, "SEC(\"tracepoint/syscalls/%s\")\n", name)
fmt.Fprintf(&b, "int handle_%s(struct %s *ctx) {\n", strings.ToLower(name), ctxStruct)
b.WriteString(" __u32 pid, tid;\n")
b.WriteString(" if (filter(&pid, &tid))\n")
b.WriteString(" return 0;\n")
b.WriteString("\n")
if isEnter && noreturn {
// Noreturn enter: only the sampling decision, no enter-state write. The
// syscall never returns, so its exit handler is suppressed and nothing
// would ever look up or delete a recorded enter-state entry. Skipping
// the write avoids leaking stale per-tid entries in the bounded
// syscall_enter_state_map; the enter null_event is still emitted below.
fmt.Fprintf(&b, " if (!ior_on_noreturn_syscall_enter(%s))\n", strings.ToUpper(name))
b.WriteString(" return 0;\n")
} else if isEnter {
fmt.Fprintf(&b, " if (!ior_on_syscall_enter(tid, %s))\n", strings.ToUpper(name))
b.WriteString(" return 0;\n")
} else {
fmt.Fprintf(&b, " if (!ior_on_syscall_exit(tid, %s, ctx->ret))\n", enterName)
b.WriteString(" return 0;\n")
}
b.WriteString("\n")
fmt.Fprintf(&b, " struct %s *ev = bpf_ringbuf_reserve(&event_map, sizeof(struct %s), 0);\n", eventStruct, eventStruct)
b.WriteString(" if (!ev)\n")
b.WriteString(" return 0;\n")
b.WriteString("\n")
fmt.Fprintf(&b, " ev->event_type = %s;\n", eventTypeConst)
fmt.Fprintf(&b, " ev->trace_id = %s;\n", strings.ToUpper(name))
b.WriteString(" ev->pid = pid;\n")
b.WriteString(" ev->tid = tid;\n")
b.WriteString(" ev->time = bpf_ktime_get_boot_ns();\n")
if extra != "" {
b.WriteString(extra)
}
b.WriteString("\n")
b.WriteString(" bpf_ringbuf_submit(ev, 0);\n")
b.WriteString(" return 0;\n")
b.WriteString("}\n")
return b.String()
}
// extraEmitter produces the kind-specific C body lines for a tracepoint handler.
// Each TracepointKind that needs extra fields registers an emitter in
// extraEmitters. Kinds not registered (or explicitly mapped to nil) emit nothing.
type extraEmitter func(tp GeneratedTracepoint, isEnter bool) string
// extraEmitters maps each TracepointKind to its emitter function.
// Adding a new kind requires only a new entry here plus, if needed, a new
// table-driven helper — no switch statement needs to grow.
var extraEmitters = map[TracepointKind]extraEmitter{
KindFd: func(tp GeneratedTracepoint, _ bool) string { return generateExtraFd(tp.Format) },
KindDup3: func(_ GeneratedTracepoint, _ bool) string { return generateExtraDup3() },
KindOpenByHandleAt: func(_ GeneratedTracepoint, _ bool) string { return generateExtraOpenByHandleAt() },
KindSocket: func(_ GeneratedTracepoint, _ bool) string { return generateExtraSocket() },
KindSocketpair: func(_ GeneratedTracepoint, isEnter bool) string { return generateExtraSocketpair(isEnter) },
KindAccept: func(_ GeneratedTracepoint, isEnter bool) string { return generateExtraAccept(isEnter) },
KindPipe: func(tp GeneratedTracepoint, isEnter bool) string { return generateExtraPipe(tp.Format, isEnter) },
KindEventfd: func(tp GeneratedTracepoint, isEnter bool) string { return generateExtraEventfd(tp.Format, isEnter) },
KindPidfd: func(tp GeneratedTracepoint, isEnter bool) string { return generateExtraEventfd(tp.Format, isEnter) },
KindEpollCtl: func(_ GeneratedTracepoint, _ bool) string { return generateExtraEpollCtl() },
KindTwoFd: func(tp GeneratedTracepoint, _ bool) string { return generateExtraTwoFd(tp.Format.Name) },
KindPoll: func(tp GeneratedTracepoint, _ bool) string { return generateExtraPoll(tp.Format.Name) },
KindMem: func(tp GeneratedTracepoint, _ bool) string { return generateExtraMem(tp.Format.Name) },
KindSleep: func(tp GeneratedTracepoint, _ bool) string { return generateExtraSleep(tp.Format.Name) },
KindKeyctl: func(tp GeneratedTracepoint, _ bool) string { return generateExtraKeyctl(tp.Format.Name) },
KindPtrace: func(_ GeneratedTracepoint, _ bool) string { return generateExtraPtrace() },
KindPerfOpen: func(_ GeneratedTracepoint, _ bool) string { return generateExtraPerfOpen() },
KindOpen: func(tp GeneratedTracepoint, _ bool) string { return generateExtraOpen(tp.Format) },
KindMqOpen: func(tp GeneratedTracepoint, _ bool) string { return generateExtraMqOpen(tp.Format) },
KindExec: func(tp GeneratedTracepoint, _ bool) string { return generateExtraExec(tp.Format) },
KindPathname: func(tp GeneratedTracepoint, _ bool) string { return generateExtraPathname(tp, tp.Format) },
KindName: func(tp GeneratedTracepoint, _ bool) string { return generateExtraName(tp.Format) },
KindFcntl: func(tp GeneratedTracepoint, _ bool) string { return generateExtraFcntl(tp.Format) },
KindRet: func(tp GeneratedTracepoint, _ bool) string { return generateExtraRet(tp.Format) },
// KindNull emits no extra fields — absence from the map means empty output.
}
// generateExtra returns the kind-specific C body lines for a tracepoint handler
// by looking up the emitter registered in extraEmitters. Kinds without a
// registered emitter (e.g. KindNull) produce an empty string.
func generateExtra(tp GeneratedTracepoint, isEnter bool) string {
if emit, ok := extraEmitters[tp.Classification.Kind]; ok {
return emit(tp, isEnter)
}
return ""
}
// generateExtraRet emits the ret/ret_type capture for exit-side ret events.
func generateExtraRet(f *Format) string {
return fmt.Sprintf(" ev->ret = ctx->ret;\n ev->ret_type = %s;\n", ClassifyRet(f.Name))
}
// generateExtraDup3 emits fd and flags from fixed argument positions.
func generateExtraDup3() string {
return " ev->fd = (__s32)ctx->args[0];\n ev->flags = (__s32)ctx->args[2];\n"
}
// generateExtraOpenByHandleAt emits flags from argument position 2.
func generateExtraOpenByHandleAt() string {
return " ev->flags = (__s32)ctx->args[2];\n"
}
// generateExtraFd returns the fd-capture lines for fd-family events.
func generateExtraFd(f *Format) string {
if f.Name == "sys_enter_pidfd_getfd" {
return " ev->fd = (__s32)ctx->args[0];\n"
}
fdIdx := f.FieldNumber("fd")
if fdIdx >= 0 {
return fmt.Sprintf(" ev->fd = (__s32)ctx->args[%d];\n", fdIdx)
}
return " ev->fd = (__s32)ctx->args[0];\n"
}
// generateExtraOpen returns the filename/comm/flags capture lines for open-family events.
func generateExtraOpen(f *Format) string {
return generateExtraOpenWithFields(f, "filename", "flags")
}
func generateExtraMqOpen(f *Format) string {
return generateExtraOpenWithFields(f, "u_name", "oflag")
}
func generateExtraExec(f *Format) string {
filenameIdx := f.FieldNumber("filename")
dirfdIdx := f.FieldNumber("dfd")
if dirfdIdx < 0 {
dirfdIdx = f.FieldNumber("fd")
}
if dirfdIdx < 0 {
dirfdIdx = f.FieldNumber("dirfd")
}
flagsIdx := f.FieldNumber("flags")
if filenameIdx < 0 {
filenameIdx = 0
}
var b strings.Builder
b.WriteString(" __builtin_memset(&(ev->filename), 0, sizeof(ev->filename) + sizeof(ev->comm));\n")
fmt.Fprintf(&b, " bpf_probe_read_user_str(ev->filename, sizeof(ev->filename), (void *)ctx->args[%d]);\n", filenameIdx)
b.WriteString(" bpf_get_current_comm(&ev->comm, sizeof(ev->comm));\n")
if dirfdIdx > -1 {
fmt.Fprintf(&b, " ev->dirfd = (__s32)ctx->args[%d];\n", dirfdIdx)
} else if f.Name == "sys_enter_execveat" {
b.WriteString(" ev->dirfd = (__s32)ctx->args[0];\n")
} else {
b.WriteString(" ev->dirfd = -1;\n")
}
if flagsIdx > -1 {
fmt.Fprintf(&b, " ev->flags = (__s32)ctx->args[%d];\n", flagsIdx)
} else {
b.WriteString(" ev->flags = 0;\n")
}
return b.String()
}
func generateExtraOpenWithFields(f *Format, pathnameField, flagsField string) string {
filenameIdx := f.FieldNumber(pathnameField)
flagsIdx := f.FieldNumber(flagsField)
var b strings.Builder
b.WriteString(" __builtin_memset(&(ev->filename), 0, sizeof(ev->filename) + sizeof(ev->comm));\n")
fmt.Fprintf(&b, " bpf_probe_read_user_str(ev->filename, sizeof(ev->filename), (void *)ctx->args[%d]);\n", filenameIdx)
b.WriteString(" bpf_get_current_comm(&ev->comm, sizeof(ev->comm));\n")
if flagsIdx > -1 {
fmt.Fprintf(&b, " ev->flags = ctx->args[%d];\n", flagsIdx)
} else {
b.WriteString(" ev->flags = -1; // Probably OK\n")
}
return b.String()
}
// generateExtraPathname returns the pathname capture lines for path-family events.
func generateExtraPathname(tp GeneratedTracepoint, f *Format) string {
fieldName := tp.Classification.PathnameField
fieldIdx := f.FieldNumber(fieldName)
var b strings.Builder
b.WriteString(" __builtin_memset(&(ev->pathname), 0, sizeof(ev->pathname));\n")
fmt.Fprintf(&b, " bpf_probe_read_user_str(ev->pathname, sizeof(ev->pathname), (void*)ctx->args[%d]);\n", fieldIdx)
return b.String()
}
// generateExtraName returns the oldname/newname capture lines for rename/link-family events.
func generateExtraName(f *Format) string {
oldIdx := f.FieldNumber("oldname")
newIdx := f.FieldNumber("newname")
var b strings.Builder
b.WriteString(" __builtin_memset(&(ev->oldname), 0, sizeof(ev->oldname) + sizeof(ev->newname));\n")
fmt.Fprintf(&b, " bpf_probe_read_user_str(ev->oldname, sizeof(ev->oldname), (void*)ctx->args[%d]);\n", oldIdx)
fmt.Fprintf(&b, " bpf_probe_read_user_str(ev->newname, sizeof(ev->newname), (void*)ctx->args[%d]);\n", newIdx)
return b.String()
}
// generateExtraFcntl returns the fd/cmd/arg capture lines for fcntl events.
func generateExtraFcntl(f *Format) string {
fdIdx := f.FieldNumber("fd")
cmdIdx := f.FieldNumber("cmd")
argIdx := f.FieldNumber("arg")
return fmt.Sprintf(
" ev->fd = ctx->args[%d];\n ev->cmd = ctx->args[%d];\n ev->arg = ctx->args[%d];\n",
fdIdx, cmdIdx, argIdx,
)
}
func generateExtraSocket() string {
return " ev->family = (__s32)ctx->args[0];\n ev->type = (__s32)ctx->args[1];\n ev->protocol = (__s32)ctx->args[2];\n"
}
func generateExtraSocketpair(isEnter bool) string {
if isEnter {
return " struct socketpair_ctx pending;\n pending.usockvec = ctx->args[3];\n pending.family = (__s32)ctx->args[0];\n pending.type = (__s32)ctx->args[1];\n pending.protocol = (__s32)ctx->args[2];\n bpf_map_update_elem(&socketpair_ctx_map, &tid, &pending, BPF_ANY);\n ev->family = pending.family;\n ev->type = pending.type;\n ev->protocol = pending.protocol;\n ev->sv0 = -1;\n ev->sv1 = -1;\n ev->ret = 0;\n"
}
return " __s32 family = -1;\n __s32 type = -1;\n __s32 protocol = -1;\n __s32 sv0 = -1;\n __s32 sv1 = -1;\n struct socketpair_ctx *pending = bpf_map_lookup_elem(&socketpair_ctx_map, &tid);\n if (pending) {\n family = pending->family;\n type = pending->type;\n protocol = pending->protocol;\n if (ctx->ret == 0 && pending->usockvec != 0) {\n int sv[2];\n if (bpf_probe_read_user(&sv, sizeof(sv), (void *)pending->usockvec) == 0) {\n sv0 = (__s32)sv[0];\n sv1 = (__s32)sv[1];\n }\n }\n bpf_map_delete_elem(&socketpair_ctx_map, &tid);\n }\n ev->family = family;\n ev->type = type;\n ev->protocol = protocol;\n ev->sv0 = sv0;\n ev->sv1 = sv1;\n ev->ret = ctx->ret;\n"
}
func generateExtraAccept(isEnter bool) string {
if isEnter {
return " ev->fd = (__s32)ctx->args[0];\n ev->ret = -1;\n"
}
return " ev->fd = -1;\n ev->ret = ctx->ret;\n"
}
func generateExtraPipe(f *Format, isEnter bool) string {
if isEnter {
flagsExpr := "0"
if f.Name == "sys_enter_pipe2" {
flagsExpr = "(__s32)ctx->args[1]"
}
return " struct pipe_ctx pending;\n pending.upipefd = ctx->args[0];\n pending.flags = " + flagsExpr + ";\n bpf_map_update_elem(&pipe_ctx_map, &tid, &pending, BPF_ANY);\n ev->flags = pending.flags;\n ev->fd0 = -1;\n ev->fd1 = -1;\n ev->ret = 0;\n"
}
return " __s32 flags = 0;\n __s32 fd0 = -1;\n __s32 fd1 = -1;\n struct pipe_ctx *pending = bpf_map_lookup_elem(&pipe_ctx_map, &tid);\n if (pending) {\n flags = pending->flags;\n if (ctx->ret == 0 && pending->upipefd != 0) {\n int pipefd[2];\n if (bpf_probe_read_user(&pipefd, sizeof(pipefd), (void *)pending->upipefd) == 0) {\n fd0 = (__s32)pipefd[0];\n fd1 = (__s32)pipefd[1];\n }\n }\n bpf_map_delete_elem(&pipe_ctx_map, &tid);\n }\n ev->flags = flags;\n ev->fd0 = fd0;\n ev->fd1 = fd1;\n ev->ret = ctx->ret;\n"
}
// eventfdFlagsExpr maps eventfd-family enter syscall names to the C expression
// that captures the flags argument. Syscalls not listed here default to "0".
// To add a new eventfd-like syscall, register its flags expression below.
var eventfdFlagsExpr = map[string]string{
"sys_enter_epoll_create": "0", // epoll_create(size) has no flags argument
"sys_enter_epoll_create1": "(__s32)ctx->args[0]",
"sys_enter_inotify_init1": "(__s32)ctx->args[0]",
"sys_enter_fanotify_init": "(__s32)ctx->args[0]",
"sys_enter_landlock_create_ruleset": "(__s32)ctx->args[2]",
"sys_enter_eventfd2": "(__s32)ctx->args[1]",
"sys_enter_memfd_create": "(__s32)ctx->args[1]",
"sys_enter_memfd_secret": "(__s32)ctx->args[0]",
"sys_enter_userfaultfd": "(__s32)ctx->args[0]",
"sys_enter_signalfd4": "(__s32)ctx->args[3]",
"sys_enter_timerfd_create": "(__s32)ctx->args[1]",
"sys_enter_pidfd_open": "(__s32)ctx->args[1]", // pidfd_open(pid, flags): flags at args[1]
"sys_enter_fsmount": "(__s32)ctx->args[1]",
"sys_enter_fsopen": "(__s32)ctx->args[1]",
}
// generateExtraEventfd emits the enter/exit body for eventfd-family syscalls.
// Enter: reads the flags expression from eventfdFlagsExpr (defaults to "0"),
// stashes it in eventfd_flags_map, and sets ev->ret = -1.
// Exit: retrieves the stashed flags from the map and captures ctx->ret.
func generateExtraEventfd(f *Format, isEnter bool) string {
if isEnter {
flagsExpr := eventfdFlagsExpr[f.Name] // empty string if not found
if flagsExpr == "" {
flagsExpr = "0"
}
return " __s32 flags = " + flagsExpr + ";\n bpf_map_update_elem(&eventfd_flags_map, &tid, &flags, BPF_ANY);\n ev->flags = flags;\n ev->ret = -1;\n"
}
return " __s32 flags = 0;\n __s32 *pending = bpf_map_lookup_elem(&eventfd_flags_map, &tid);\n if (pending) {\n flags = *pending;\n bpf_map_delete_elem(&eventfd_flags_map, &tid);\n }\n ev->flags = flags;\n ev->ret = ctx->ret;\n"
}
func generateExtraEpollCtl() string {
return " ev->epfd = (__s32)ctx->args[0];\n ev->op = (__s32)ctx->args[1];\n ev->fd = (__s32)ctx->args[2];\n ev->events = 0;\n if (ctx->args[3] != 0) {\n __u32 user_events = 0;\n if (bpf_probe_read_user(&user_events, sizeof(user_events), (void *)ctx->args[3]) == 0) {\n ev->events = user_events;\n }\n }\n"
}
// twoFdFieldSpec describes argument positions for a two-fd syscall.
// Each expression is a C snippet for the corresponding event field.
type twoFdFieldSpec struct {
fdA string // expression for ev->fd_a
fdB string // expression for ev->fd_b
extra string // expression for ev->extra
}
// twoFdOverrides maps syscall names that deviate from the default argument
// layout (args[0], args[1], args[2]). To add a new two-fd syscall with
// non-standard positions, register it here.
var twoFdOverrides = map[string]twoFdFieldSpec{
"sys_enter_move_mount": {fdA: "(__s32)ctx->args[0]", fdB: "(__s32)ctx->args[2]", extra: "(__u64)ctx->args[4]"},
"sys_enter_kcmp": {fdA: "(__s32)ctx->args[3]", fdB: "(__s32)ctx->args[4]", extra: "(__u64)ctx->args[2]"},
}
// twoFdDefault is the fallback for two-fd syscalls not in twoFdOverrides.
var twoFdDefault = twoFdFieldSpec{
fdA: "(__s32)ctx->args[0]",
fdB: "(__s32)ctx->args[1]",
extra: "(__u64)ctx->args[2]",
}
// generateExtraTwoFd emits the three-field body for two-fd syscalls.
// Syscalls with non-standard argument positions are in twoFdOverrides;
// all others use twoFdDefault.
func generateExtraTwoFd(name string) string {
spec, ok := twoFdOverrides[name]
if !ok {
spec = twoFdDefault
}
return fmt.Sprintf(" ev->fd_a = %s;\n ev->fd_b = %s;\n ev->extra = %s;\n",
spec.fdA, spec.fdB, spec.extra)
}
// pollTimeoutStyle describes how the poll-family syscall captures its timeout.
type pollTimeoutStyle int
const (
// pollTimeoutNone means no known timeout capture; emit defaults.
pollTimeoutNone pollTimeoutStyle = iota
// pollTimeoutMillis means the timeout is an __s32 millisecond value.
pollTimeoutMillis
// pollTimeoutTimespec means the timeout is a pointer to a timespec struct.
pollTimeoutTimespec
// pollTimeoutTimeval means the timeout is a pointer to a timeval struct.
pollTimeoutTimeval
)
// pollFieldSpec describes argument positions and timeout style for a poll
// syscall. nfdsArgIdx is the ctx->args index for nfds; timeoutArgIdx is the
// index for the timeout argument.
type pollFieldSpec struct {
nfdsArgIdx int
timeoutArgIdx int
timeoutStyle pollTimeoutStyle
}
// pollOverrides maps poll-family syscall names to their argument layout.
// To add a new poll variant, register it here instead of editing a switch.
var pollOverrides = map[string]pollFieldSpec{
"sys_enter_poll": {nfdsArgIdx: 1, timeoutArgIdx: 2, timeoutStyle: pollTimeoutMillis},
"sys_enter_ppoll": {nfdsArgIdx: 1, timeoutArgIdx: 2, timeoutStyle: pollTimeoutTimespec},
"sys_enter_select": {nfdsArgIdx: 0, timeoutArgIdx: 4, timeoutStyle: pollTimeoutTimeval},
"sys_enter_pselect6": {nfdsArgIdx: 0, timeoutArgIdx: 4, timeoutStyle: pollTimeoutTimespec},
}
// generateExtraPoll emits the nfds/timeout_ns capture body for poll-family
// syscalls. Unregistered names get sensible defaults (-1, -1).
func generateExtraPoll(name string) string {
spec, ok := pollOverrides[name]
if !ok {
return " ev->nfds = -1;\n ev->timeout_ns = -1;\n"
}
var b strings.Builder
fmt.Fprintf(&b, " ev->nfds = (__s32)ctx->args[%d];\n", spec.nfdsArgIdx)
b.WriteString(" ev->timeout_ns = -1;\n")
b.WriteString(pollTimeoutBody(spec.timeoutArgIdx, spec.timeoutStyle))
return b.String()
}
// pollTimeoutBody returns the C snippet that reads the timeout from the
// specified argument index using the given style (millis, timespec, timeval).
func pollTimeoutBody(argIdx int, style pollTimeoutStyle) string {
switch style {
case pollTimeoutMillis:
return fmt.Sprintf(
" __s32 timeout_ms = (__s32)ctx->args[%d];\n"+
" if (timeout_ms >= 0) {\n"+
" ev->timeout_ns = ((__s64)timeout_ms) * 1000000LL;\n"+
" }\n", argIdx)
case pollTimeoutTimespec:
return fmt.Sprintf(
" if (ctx->args[%d] != 0) {\n"+
" struct __ior_timespec {\n"+
" __s64 tv_sec;\n"+
" __s64 tv_nsec;\n"+
" } ts = {};\n"+
" if (bpf_probe_read_user(&ts, sizeof(ts), (void *)ctx->args[%d]) == 0) {\n"+
" ev->timeout_ns = ts.tv_sec * 1000000000LL + ts.tv_nsec;\n"+
" }\n"+
" }\n", argIdx, argIdx)
case pollTimeoutTimeval:
return fmt.Sprintf(
" if (ctx->args[%d] != 0) {\n"+
" struct __ior_timeval {\n"+
" __s64 tv_sec;\n"+
" __s64 tv_usec;\n"+
" } tv = {};\n"+
" if (bpf_probe_read_user(&tv, sizeof(tv), (void *)ctx->args[%d]) == 0) {\n"+
" ev->timeout_ns = tv.tv_sec * 1000000000LL + tv.tv_usec * 1000LL;\n"+
" }\n"+
" }\n", argIdx, argIdx)
default:
return ""
}
}
// memFieldSpec describes the four fields captured for a memory syscall.
// Each expression is a C snippet; empty means the field defaults to "0".
// To add a new memory syscall, register it in memFieldOverrides below.
type memFieldSpec struct {
addr string // expression for ev->addr (default "0")
length string // expression for ev->length (default "0")
length2 string // expression for ev->length2 (default "0")
flags string // expression for ev->flags (default "0")
}
// memFieldOverrides maps syscall names to per-field C expressions.
// Only syscalls whose arguments differ from all-zeros need an entry;
// the default (unregistered) case emits all zeroes.
var memFieldOverrides = map[string]memFieldSpec{
"sys_enter_mprotect": {addr: "(__u64)ctx->args[0]", length: "(__u64)ctx->args[1]", flags: "(__u64)ctx->args[2]"},
"sys_enter_madvise": {addr: "(__u64)ctx->args[0]", length: "(__u64)ctx->args[1]", flags: "(__u64)ctx->args[2]"},
"sys_enter_pkey_mprotect": {addr: "(__u64)ctx->args[0]", length: "(__u64)ctx->args[1]", length2: "(__u64)ctx->args[3]", flags: "(__u64)ctx->args[2]"},
"sys_enter_brk": {addr: "(__u64)ctx->args[0]"},
"sys_enter_munmap": {addr: "(__u64)ctx->args[0]", length: "(__u64)ctx->args[1]"},
"sys_enter_mremap": {addr: "(__u64)ctx->args[0]", length: "(__u64)ctx->args[1]", length2: "(__u64)ctx->args[2]", flags: "(__u64)ctx->args[3]"},
"sys_enter_mincore": {addr: "(__u64)ctx->args[0]", length: "(__u64)ctx->args[1]"},
"sys_enter_remap_file_pages": {addr: "(__u64)ctx->args[0]", length: "(__u64)ctx->args[1]", length2: "(__u64)ctx->args[3]", flags: "(__u64)ctx->args[4]"},
"sys_enter_mlock": {addr: "(__u64)ctx->args[0]", length: "(__u64)ctx->args[1]"},
"sys_enter_mlock2": {addr: "(__u64)ctx->args[0]", length: "(__u64)ctx->args[1]", flags: "(__u64)ctx->args[2]"},
"sys_enter_munlock": {addr: "(__u64)ctx->args[0]", length: "(__u64)ctx->args[1]"},
"sys_enter_mseal": {addr: "(__u64)ctx->args[0]", length: "(__u64)ctx->args[1]", flags: "(__u64)ctx->args[2]"},
"sys_enter_map_shadow_stack": {addr: "(__u64)ctx->args[0]", length: "(__u64)ctx->args[1]", flags: "(__u64)ctx->args[2]"},
}
// generateExtraMem emits the four-field memory event body from memFieldOverrides.
// Unregistered syscalls get all-zero defaults.
func generateExtraMem(name string) string {
spec := memFieldOverrides[name] // zero-value memFieldSpec if not found
return fmt.Sprintf(" ev->addr = %s;\n ev->length = %s;\n ev->length2 = %s;\n ev->flags = %s;\n",
memExpr(spec.addr), memExpr(spec.length), memExpr(spec.length2), memExpr(spec.flags))
}
// memExpr returns expr if non-empty, otherwise the literal "0".
func memExpr(expr string) string {
if expr == "" {
return "0"
}
return expr
}
// sleepSpec describes how a sleep-family syscall exposes its requested sleep
// duration.
//
// - ptr is the C expression pointing at the user-space timespec struct.
// - flagsArg is the C expression for the flags argument that may carry
// TIMER_ABSTIME; it is empty for syscalls whose request is always relative.
type sleepSpec struct {
ptr string
flagsArg string
}
// sleepTimespecPtr maps sleep-family syscall names to their timespec pointer and
// (where applicable) flags-argument expressions. Syscalls not listed default to
// ptr "0" (no pointer), which makes the generated code skip the probe_read_user
// call. To add a new sleep-like syscall, register it here.
//
// nanosleep(const struct timespec *req, struct timespec *rem) is ALWAYS a
// relative sleep, so it has no flagsArg. clock_nanosleep(clockid_t clockid,
// int flags, const struct timespec *request, struct timespec *remain) takes a
// flags argument: when flags & TIMER_ABSTIME is set, *request is an ABSOLUTE
// wakeup time against clockid, not a relative duration — see generateExtraSleep.
var sleepTimespecPtr = map[string]sleepSpec{
"sys_enter_nanosleep": {ptr: "ctx->args[0]"},
"sys_enter_clock_nanosleep": {ptr: "ctx->args[2]", flagsArg: "ctx->args[1]"},
}
// timerAbstimeFlag is the Linux TIMER_ABSTIME flag value (uapi/linux/time.h).
// When set in clock_nanosleep's flags argument, the request timespec is an
// absolute wakeup time rather than a relative duration.
const timerAbstimeFlag = "1 /* TIMER_ABSTIME */"
// generateExtraSleep emits the requested_ns capture body for sleep-family
// syscalls. The timespec pointer (and optional flags) expression come from
// sleepTimespecPtr.
//
// requested_ns defaults to the -1 sentinel (the same value used for a
// null/unreadable timespec pointer). For relative sleeps we overwrite it with
// tv_sec*1e9 + tv_nsec. For an absolute sleep (clock_nanosleep with
// TIMER_ABSTIME set) the request timespec is an absolute clock value, NOT a
// duration; computing tv_sec*1e9 + tv_nsec there would export a bogus
// multi-decade "sleep duration". Deriving the true relative duration would
// require reading the current time of the (variable) clockid in BPF, which is
// racy and clock-dependent. Instead we leave the -1 sentinel so downstream
// consumers (CSV/parquet/stream) report "unknown" rather than a misleading
// value.
func generateExtraSleep(name string) string {
spec := sleepTimespecPtr[name] // zero value (ptr "") if not found
ptrExpr := spec.ptr
if ptrExpr == "" {
ptrExpr = "0"
}
compute := " ev->requested_ns = ts.tv_sec * 1000000000LL + ts.tv_nsec;\n"
if spec.flagsArg != "" {
// Absolute sleeps keep the -1 sentinel; only relative sleeps get a
// computed duration.
compute = " if ((" + spec.flagsArg + " & " + timerAbstimeFlag + ") == 0) {\n" +
" ev->requested_ns = ts.tv_sec * 1000000000LL + ts.tv_nsec;\n" +
" }\n"
}
return " ev->requested_ns = -1;\n if (" + ptrExpr + " != 0) {\n struct __ior_timespec {\n __s64 tv_sec;\n __s64 tv_nsec;\n } ts = {};\n if (bpf_probe_read_user(&ts, sizeof(ts), (void *)" + ptrExpr + ") == 0) {\n" + compute + " }\n }\n"
}
// keyctlFieldSpec describes the three fields captured for keyctl-family syscalls.
// Each expression is a C snippet; empty means the field defaults to "0".
type keyctlFieldSpec struct {
option string // expression for ev->option (default "0")
keySerial string // expression for ev->key_serial (default "0")
value string // expression for ev->value (default "0")
}
// keyctlOverrides maps keyctl-family syscall names to their per-field C
// expressions. To add a new keyctl variant, register it here.
var keyctlOverrides = map[string]keyctlFieldSpec{
"sys_enter_keyctl": {option: "(__s32)ctx->args[0]", keySerial: "(__s32)ctx->args[1]", value: "(__u64)ctx->args[2]"},
"sys_enter_add_key": {option: "-1", keySerial: "(__s32)ctx->args[4]", value: "(__u64)ctx->args[3]"},
"sys_enter_request_key": {option: "-2", keySerial: "(__s32)ctx->args[3]"},
}
// generateExtraKeyctl emits the three-field body for keyctl-family syscalls.
// Unregistered syscalls get all-zero defaults.
func generateExtraKeyctl(name string) string {
spec := keyctlOverrides[name] // zero-value keyctlFieldSpec if not found
return fmt.Sprintf(" ev->option = %s;\n ev->key_serial = %s;\n ev->value = %s;\n",
memExpr(spec.option), memExpr(spec.keySerial), memExpr(spec.value))
}
func generateExtraPtrace() string {
return " ev->request = (__s64)ctx->args[0];\n ev->target_pid = (__s32)ctx->args[1];\n ev->data = (__u64)ctx->args[3];\n"
}
func generateExtraPerfOpen() string {
return " ev->attr_type = 0;\n ev->attr_size = 0;\n ev->config = 0;\n if (ctx->args[0] != 0) {\n struct __ior_perf_event_attr {\n __u32 type;\n __u32 size;\n __u64 config;\n } attr = {};\n if (bpf_probe_read_user(&attr, sizeof(attr), (void *)ctx->args[0]) == 0) {\n ev->attr_type = attr.type;\n ev->attr_size = attr.size;\n ev->config = attr.config;\n }\n }\n ev->target_pid = (__s32)ctx->args[1];\n ev->cpu = (__s32)ctx->args[2];\n ev->group_fd = (__s32)ctx->args[3];\n ev->flags = (__u32)ctx->args[4];\n"
}
// eventStructName returns the C struct name for a TracepointKind. The mapping
// is driven by kindRegistry so adding a new kind only requires a registry entry.
func eventStructName(kind TracepointKind) string {
return lookupKind(kind).structName
}
func eventTypeConstant(kind TracepointKind, isEnter bool) string {
prefix := "EXIT_"
if isEnter {
prefix = "ENTER_"
}
return prefix + strings.ToUpper(eventStructName(kind))
}
|