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
|
// Copyright 2023 syzkaller project authors. All rights reserved.
// Use of this source code is governed by Apache 2 LICENSE that can be found in the LICENSE file.
package main
import (
"bytes"
"fmt"
"go/format"
"regexp"
"slices"
"sort"
"strings"
"text/template"
"unicode"
"github.com/google/syzkaller/pkg/serializer"
"github.com/google/syzkaller/pkg/subsystem"
"github.com/google/syzkaller/pkg/vcs"
)
func generateSubsystemsFile(name string, list []*subsystem.Subsystem, commit *vcs.Commit,
debugInfo *subsystem.DebugInfo) ([]byte, error) {
// Set names first -- we'll need them for filling in the Parents array.
objToName := map[*subsystem.Subsystem]string{}
for _, entry := range list {
varName := getVarName(entry)
if varName == "" {
return nil, fmt.Errorf("failed to get a var name for %#v", entry.Name)
}
objToName[entry] = varName
}
// Prepare the template data.
vars := &templateVars{
Name: name,
CommitInfo: fmt.Sprintf(`Commit %s, "%.32s"`, commit.Hash, commit.Title),
Version: commit.Date.Year()*10000 + int(commit.Date.Month())*100 + commit.Date.Day(),
Hierarchy: hierarchyList(list),
}
for _, entry := range list {
varName := objToName[entry]
// The serializer does not understand parent references and just prints all the
// nested structures.
// Therefore we call it separately for the fields it can understand.
parents := []parentInfo{}
for _, p := range entry.Parents {
parents = append(parents, parentInfo{
Name: objToName[p],
Comment: debugInfo.ParentChildComment[p][entry],
})
}
slices.SortFunc(parents, func(a, b parentInfo) int {
return strings.Compare(a.Name, b.Name)
})
subsystem := &templateSubsystem{
VarName: varName,
Name: serializer.WriteString(entry.Name),
PathRules: serializer.WriteString(entry.PathRules),
Parents: parents,
NoReminders: entry.NoReminders,
NoIndirectCc: entry.NoIndirectCc,
}
// Some of the records are mostly empty.
if len(entry.Maintainers) > 0 {
sort.Strings(entry.Maintainers)
subsystem.Maintainers = serializer.WriteString(entry.Maintainers)
}
if len(entry.Syscalls) > 0 {
subsystem.Syscalls = serializer.WriteString(entry.Syscalls)
}
if len(entry.Lists) > 0 {
subsystem.Lists = serializer.WriteString(entry.Lists)
}
vars.List = append(vars.List, subsystem)
}
tmpl, err := template.New("source").Parse(fileTemplate)
if err != nil {
return nil, err
}
var b bytes.Buffer
if err = tmpl.Execute(&b, vars); err != nil {
return nil, err
}
return format.Source(b.Bytes())
}
func getVarName(entry *subsystem.Subsystem) string {
varName := makeVarRegexp.ReplaceAllString(strings.ToLower(entry.Name), "")
if varName == "" {
return ""
}
if unicode.IsDigit(rune(varName[0])) {
return "_" + varName
}
return varName
}
func hierarchyList(list []*subsystem.Subsystem) []string {
children := map[*subsystem.Subsystem][]*subsystem.Subsystem{}
for _, entry := range list {
for _, p := range entry.Parents {
children[p] = append(children[p], entry)
}
}
ret := []string{}
var dfs func(*subsystem.Subsystem, string)
dfs = func(entry *subsystem.Subsystem, prefix string) {
ret = append(ret, fmt.Sprintf("%s- %s", prefix, entry.Name))
for _, child := range children[entry] {
dfs(child, prefix+" ")
}
}
for _, entity := range list {
if len(entity.Parents) == 0 {
dfs(entity, "")
}
}
return ret
}
var makeVarRegexp = regexp.MustCompile(`[^\w]|^([^a-z0-9]+)`)
type templateSubsystem struct {
VarName string
Name string
Syscalls string
PathRules string
Lists string
Maintainers string
Parents []parentInfo
NoReminders bool
NoIndirectCc bool
}
type parentInfo struct {
Name string
Comment string
}
type templateVars struct {
Name string
Version int
CommitInfo string
List []*templateSubsystem
Hierarchy []string
}
const fileTemplate = `// Code generated by the syz-query-subsystems tool. DO NOT EDIT.
{{- if .CommitInfo}}
// {{.CommitInfo}}
{{- end}}
package lists
import . "github.com/google/syzkaller/pkg/subsystem"
func init() {
RegisterList("{{.Name}}", subsystems_{{.Name}}(), {{.Version}})
}
// The subsystem list:
{{- range .Hierarchy}}
// {{.}}
{{- end}}
func subsystems_{{.Name}}() []*Subsystem{
var {{range $i, $item := .List}}
{{- if gt $i 0}}, {{end}}
{{- .VarName}}
{{- end}} Subsystem
{{range .List}}
{{.VarName}} = Subsystem{
Name: {{.Name}},
{{- if .Syscalls}}
Syscalls: {{.Syscalls}},
{{- end}}
{{- if .Lists}}
Lists: {{.Lists}},
{{- end}}
{{- if .Maintainers}}
Maintainers: {{.Maintainers}},
{{- end}}
{{- if .Parents}}
Parents: []*Subsystem{
{{- range .Parents}}
{{- if .Comment}}
// {{.Comment}}
{{- end}}
&{{.Name}},
{{end -}}
},
{{- end}}
PathRules: {{.PathRules}},
{{- if .NoReminders}}
NoReminders: true,
{{- end}}
{{- if .NoIndirectCc}}
NoIndirectCc: true,
{{- end}}
}
{{end}}
return []*Subsystem{
{{range .List}} &{{.VarName}}, {{- end}}
}
}
`
|
