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
|
package flags
import (
"flag"
"fmt"
"os"
"regexp"
"slices"
"strings"
"sync"
"sync/atomic"
"time"
)
var (
singleton = Flags{
TUIExportEnable: true,
}
once sync.Once
parseErr error
pidFilter atomic.Int64
tidFilter atomic.Int64
tuiExportEnable atomic.Bool
)
func init() {
pidFilter.Store(-1)
tidFilter.Store(-1)
tuiExportEnable.Store(true)
}
var (
validCollapsedFields = []string{
"path",
"comm",
"tracepoint",
"pid",
"tid",
"flags",
}
validCollapsedCounts = []string{
"count",
"duration",
"durationToPrev",
"bytes",
}
)
type Flags struct {
PidFilter int
TidFilter int
EventMapSize int
CommFilter string
PathFilter string
PprofEnable bool
Duration int
// Tracepints flags
TracepointsToAttach []*regexp.Regexp
TracepointsToExclude []*regexp.Regexp
// Flamegraph flags
PlainMode bool
FlamegraphEnable bool
LiveFlamegraph bool
LiveInterval time.Duration
FlamegraphName string
TUIExportEnable bool
// To convert ior data into native SVG format
IorDataFile string
CollapsedFields []string
CountField string
}
func Get() Flags {
out := singleton
out.PidFilter = int(pidFilter.Load())
out.TidFilter = int(tidFilter.Load())
out.TUIExportEnable = tuiExportEnable.Load()
return out
}
// SetPidFilter updates the active PID filter used for subsequent tracing runs.
func SetPidFilter(pid int) {
pidFilter.Store(int64(pid))
}
// SetTidFilter updates the active TID filter used for subsequent tracing runs.
func SetTidFilter(tid int) {
tidFilter.Store(int64(tid))
}
// SetTUIExportEnable toggles TUI snapshot export file writing.
func SetTUIExportEnable(enabled bool) {
tuiExportEnable.Store(enabled)
}
func Parse() error {
once.Do(func() {
parseErr = parse()
})
return parseErr
}
func parse() error {
flag.IntVar(&singleton.PidFilter, "pid", -1, "Filter for processes ID")
flag.IntVar(&singleton.TidFilter, "tid", -1, "Filter for thread ID")
flag.IntVar(&singleton.EventMapSize, "mapSize", 4096*16, "BPF FD event ring buffer map size")
flag.IntVar(&singleton.Duration, "duration", 60, "Probe duration in seconds")
flag.StringVar(&singleton.CommFilter, "comm", "", "Command to filter for")
flag.StringVar(&singleton.PathFilter, "path", "", "Path to filter for")
flag.BoolVar(&singleton.PprofEnable, "pprof", false, "Enable profiling")
tracepointsToAttach := flag.String("tps", "", "Comma separated list regexes for tracepoints to load")
tracepointsToExclude := flag.String("tpsExclude", "", "Comma separated list regexes for tracepoints to exclude")
flag.BoolVar(&singleton.PlainMode, "plain", false, "Enable plain CSV output mode (disable TUI)")
flag.BoolVar(&singleton.FlamegraphEnable, "flamegraph", false, "Enable flamegraph builder")
flag.BoolVar(&singleton.LiveFlamegraph, "live", false, "Enable live flamegraph mode")
flag.DurationVar(&singleton.LiveInterval, "live-interval", 200*time.Millisecond, "Live flamegraph refresh interval")
flag.StringVar(&singleton.FlamegraphName, "name", "default", "Name of the flamegraph, used to generate the SVG file")
flag.BoolVar(&singleton.TUIExportEnable, "tuiExport", true, "Enable writing TUI snapshot export files")
flag.StringVar(&singleton.IorDataFile, "ior", "", "IOR data file to convert into native SVG flamegraph")
fields := flag.String("fields", "",
fmt.Sprintf("Comma separated list of fields to collapse, valid are: %v", validCollapsedFields))
flag.StringVar(&singleton.CountField, "count", "count",
fmt.Sprintf("Count field to collapse, valid are: %v", validCollapsedCounts))
if err := flag.CommandLine.Parse(os.Args[1:]); err != nil {
return err
}
pidFilter.Store(int64(singleton.PidFilter))
tidFilter.Store(int64(singleton.TidFilter))
tuiExportEnable.Store(singleton.TUIExportEnable)
var err error
singleton.TracepointsToAttach, err = extractTracepointFlags(*tracepointsToAttach)
if err != nil {
return err
}
singleton.TracepointsToExclude, err = extractTracepointFlags(*tracepointsToExclude)
if err != nil {
return err
}
// Keep this list empty by default.
// As of February 23, 2026, open_by_handle_at and name_to_handle_at were
// re-evaluated on newer kernels and do not require CO-RE-based exclusions.
// If future kernels regress, add targeted exclusions here.
if *fields == "" {
singleton.CollapsedFields = []string{"comm", "path", "tracepoint"}
} else {
singleton.CollapsedFields = strings.Split(*fields, ",")
}
for _, field := range singleton.CollapsedFields {
if !slices.Contains(validCollapsedFields, field) {
return fmt.Errorf("invalid field for collapse: %s", field)
}
}
if !slices.Contains(validCollapsedCounts, singleton.CountField) {
return fmt.Errorf("invalid count field: %s", singleton.CountField)
}
return nil
}
func extractTracepointFlags(tracepoints string) (regexes []*regexp.Regexp, err error) {
if len(tracepoints) == 0 {
return regexes, nil
}
for _, name := range strings.Split(tracepoints, ",") {
re, err := regexp.Compile(name)
if err != nil {
return nil, fmt.Errorf("unable to compile regex %q: %w", name, err)
}
regexes = append(regexes, re)
}
return regexes, nil
}
func (flags Flags) ShouldIAttachTracepoint(tracepointName string) bool {
for _, re := range flags.TracepointsToExclude {
if re.MatchString(tracepointName) {
return false
}
}
if len(flags.TracepointsToAttach) == 0 {
return true
}
for _, re := range flags.TracepointsToAttach {
if re.MatchString(tracepointName) {
return true
}
}
return false
}
|