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
|
package tracepoints
import (
"fmt"
"os"
"path/filepath"
"reflect"
"regexp"
"runtime"
"sort"
"strings"
"testing"
)
var docListItemRE = regexp.MustCompile("`([^`]+)`")
func TestSyscallTracingPlanFamiliesStayInSyncWithGeneratedMap(t *testing.T) {
doc, err := readSyscallTracingPlan()
if err != nil {
t.Fatalf("read syscall tracing plan: %v", err)
}
documented, err := parseDocListSection(doc, "## Traced Syscalls by Family")
if err != nil {
t.Fatalf("parse family section: %v", err)
}
generated := groupSyscallsByValue(syscallFamilies)
assertGroupedEqual(t, "family", documented, generated)
}
func TestSyscallTracingPlanKindsStayInSyncWithGeneratedMap(t *testing.T) {
doc, err := readSyscallTracingPlan()
if err != nil {
t.Fatalf("read syscall tracing plan: %v", err)
}
documented, err := parseDocListSection(doc, "## Traced Syscalls by TracepointKind")
if err != nil {
t.Fatalf("parse kind section: %v", err)
}
generated := groupSyscallsByValue(syscallKinds)
assertGroupedEqual(t, "kind", documented, generated)
}
func readSyscallTracingPlan() (string, error) {
_, filename, _, ok := runtime.Caller(0)
if !ok {
return "", fmt.Errorf("runtime.Caller failed")
}
repoRoot := filepath.Clean(filepath.Join(filepath.Dir(filename), "..", ".."))
content, err := os.ReadFile(filepath.Join(repoRoot, "docs", "syscall-tracing-plan.md"))
if err != nil {
return "", err
}
return string(content), nil
}
func parseDocListSection(doc, heading string) (map[string][]string, error) {
lines := strings.Split(doc, "\n")
start := -1
for i, line := range lines {
if strings.TrimSpace(line) == heading {
start = i + 1
break
}
}
if start == -1 {
return nil, fmt.Errorf("heading %q not found", heading)
}
out := map[string][]string{}
for i := start; i < len(lines); i++ {
line := strings.TrimSpace(lines[i])
if strings.HasPrefix(line, "## ") {
break
}
if !strings.HasPrefix(line, "- ") {
continue
}
label, syscalls, err := parseDocBullet(line)
if err != nil {
return nil, err
}
out[label] = normalizeValues(syscalls)
}
if len(out) == 0 {
return nil, fmt.Errorf("heading %q had no bullet rows", heading)
}
return out, nil
}
func parseDocBullet(line string) (string, []string, error) {
entry := strings.TrimSpace(strings.TrimPrefix(line, "- "))
colon := strings.Index(entry, ":")
if colon <= 0 {
return "", nil, fmt.Errorf("invalid list entry %q", line)
}
label := strings.TrimSpace(entry[:colon])
if label == "" {
return "", nil, fmt.Errorf("missing label in %q", line)
}
matches := docListItemRE.FindAllStringSubmatch(entry[colon+1:], -1)
if len(matches) == 0 {
return "", nil, fmt.Errorf("no syscall list in %q", line)
}
items := make([]string, 0, len(matches))
for _, match := range matches {
items = append(items, match[1])
}
return label, items, nil
}
func groupSyscallsByValue(values map[string]string) map[string][]string {
grouped := map[string][]string{}
for syscall, value := range values {
grouped[value] = append(grouped[value], syscall)
}
for key, syscalls := range grouped {
grouped[key] = normalizeValues(syscalls)
}
return grouped
}
func normalizeValues(values []string) []string {
uniq := map[string]struct{}{}
for _, value := range values {
uniq[value] = struct{}{}
}
out := make([]string, 0, len(uniq))
for value := range uniq {
out = append(out, value)
}
sort.Strings(out)
return out
}
func assertGroupedEqual(t *testing.T, section string, documented, generated map[string][]string) {
t.Helper()
docKeys := mapKeys(documented)
genKeys := mapKeys(generated)
if !reflect.DeepEqual(docKeys, genKeys) {
t.Fatalf("%s groups mismatch: documented=%v generated=%v", section, docKeys, genKeys)
}
for _, key := range genKeys {
if !reflect.DeepEqual(documented[key], generated[key]) {
t.Fatalf("%s %q mismatch:\ndocumented=%v\ngenerated=%v", section, key, documented[key], generated[key])
}
}
}
func mapKeys(m map[string][]string) []string {
out := make([]string, 0, len(m))
for key := range m {
out = append(out, key)
}
sort.Strings(out)
return out
}
|
