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
|
// Copyright 2024 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"
"context"
"errors"
"flag"
"fmt"
"github.com/google/syzkaller/pkg/debugtracer"
"github.com/google/syzkaller/pkg/osutil"
"github.com/google/syzkaller/syz-cluster/pkg/api"
"github.com/google/syzkaller/syz-cluster/pkg/app"
"github.com/google/syzkaller/syz-cluster/pkg/triage"
)
var (
flagSession = flag.String("session", "", "session ID")
flagRepo = flag.String("repository", "", "path to a kernel checkout")
flagVerdict = flag.String("verdict", "", "where to save the verdict")
)
func main() {
flag.Parse()
if *flagSession == "" || *flagRepo == "" {
// TODO: abort the whole workflow, no sense to retry. Alert the error.
app.Fatalf("--session and --repo must be set")
}
client := app.DefaultClient()
repo, err := triage.NewGitTreeOps(*flagRepo, true)
if err != nil {
app.Fatalf("failed to initialize the repository: %v", err)
}
ctx := context.Background()
output := new(bytes.Buffer)
tracer := &debugtracer.GenericTracer{WithTime: true, TraceWriter: output}
triager := &seriesTriager{
DebugTracer: tracer,
client: client,
ops: repo,
}
verdict, err := triager.GetVerdict(ctx, *flagSession)
if err != nil {
app.Fatalf("failed to get the verdict: %v", err)
}
err = client.UploadTriageResult(ctx, *flagSession, &api.UploadTriageResultReq{
SkipReason: verdict.SkipReason,
Log: output.Bytes(),
})
if err != nil {
app.Fatalf("failed to upload triage results: %v", err)
}
if *flagVerdict != "" {
osutil.WriteJSON(*flagVerdict, verdict)
}
// TODO:
// 1. It might be that the kernel builds/boots for one arch and does not build for another.
// 2. What if controller does not reply? Let Argo just restart the step.
}
type seriesTriager struct {
debugtracer.DebugTracer
client *api.Client
ops *triage.GitTreeOps
}
func (triager *seriesTriager) GetVerdict(ctx context.Context, sessionID string) (*api.TriageResult, error) {
series, err := triager.client.GetSessionSeries(ctx, sessionID)
if err != nil {
// TODO: the workflow step must be retried.
return nil, fmt.Errorf("failed to query series: %w", err)
}
treesResp, err := triager.client.GetTrees(ctx)
if err != nil {
return nil, fmt.Errorf("failed to query trees: %w", err)
}
selectedTrees := triage.SelectTrees(series, treesResp.Trees)
if len(selectedTrees) == 0 {
return &api.TriageResult{
SkipReason: "no suitable base kernel trees found",
}, nil
}
fuzzConfigs := triage.MergeKernelFuzzConfigs(triage.SelectFuzzConfigs(series, treesResp.FuzzTargets))
if len(fuzzConfigs) == 0 {
return &api.TriageResult{
SkipReason: "no suitable fuzz configs found",
}, nil
}
ret := &api.TriageResult{}
for _, campaign := range fuzzConfigs {
fuzzTask, err := triager.prepareFuzzingTask(ctx, series, selectedTrees, campaign)
var skipErr *SkipTriageError
if errors.As(err, &skipErr) {
ret.SkipReason = skipErr.Reason.Error()
continue
} else if err != nil {
return nil, err
}
ret.Fuzz = append(ret.Fuzz, fuzzTask)
}
if len(ret.Fuzz) > 0 {
// If we have prepared at least one fuzzing task, the series was not skipped.
ret.SkipReason = ""
}
return ret, nil
}
func (triager *seriesTriager) prepareFuzzingTask(ctx context.Context, series *api.Series, trees []*api.Tree,
target *triage.MergedFuzzConfig) (*api.FuzzTask, error) {
result, err := triager.selectFromBlobs(series, trees)
if err != nil {
return nil, fmt.Errorf("selection by blob failed: %w", err)
}
if result == nil {
result, err = triager.selectFromList(ctx, series, trees, target)
if err != nil {
return nil, fmt.Errorf("selection from the list failed: %w", err)
}
}
if result != nil {
triager.Log("continuing with %+v", result)
base := api.BuildRequest{
TreeName: result.Tree.Name,
TreeURL: result.Tree.URL,
ConfigName: target.KernelConfig,
CommitHash: result.Commit,
Arch: result.Arch,
}
fuzz := &api.FuzzTask{
Base: base,
Patched: base,
FuzzConfig: *target.FuzzConfig,
}
fuzz.Patched.SeriesID = series.ID
return fuzz, nil
}
return nil, SkipError("no base commit found")
}
type SelectResult struct {
Tree *api.Tree
Commit string
Arch string
}
// For now, only amd64 fuzzing is supported.
const fuzzArch = "amd64"
func (triager *seriesTriager) selectFromBlobs(series *api.Series, trees []*api.Tree) (*SelectResult, error) {
triager.Log("attempting to guess the base commit by blob hashes")
var diff []byte
for _, patch := range series.Patches {
diff = append(diff, patch.Body...)
diff = append(diff, '\n')
}
base, err := triager.ops.BaseForDiff(diff, triager.DebugTracer)
if err != nil {
return nil, err
} else if base == nil {
triager.Log("no candidate base commit is found")
return nil, nil
}
for _, branch := range base.Branches {
tree := triage.TreeFromBranch(trees, branch)
if tree != nil {
return &SelectResult{
Tree: tree,
Commit: base.Hash,
Arch: fuzzArch,
}, nil
}
}
triager.Log("cannot identify the tree from %q", base.Branches)
return nil, nil
}
func (triager *seriesTriager) selectFromList(ctx context.Context, series *api.Series, trees []*api.Tree,
target *triage.MergedFuzzConfig) (*SelectResult, error) {
skipErr := SkipError("empty tree list")
for _, tree := range trees {
triager.Log("considering tree %q", tree.Name)
lastBuild, err := triager.client.LastBuild(ctx, &api.LastBuildReq{
Arch: fuzzArch,
ConfigName: target.KernelConfig,
TreeName: tree.Name,
Status: api.BuildSuccess,
})
if err != nil {
// TODO: the workflow step must be retried.
return nil, fmt.Errorf("failed to query the last build for %q: %w", tree.Name, err)
}
triager.Log("%q's last build: %q", tree.Name, lastBuild)
selector := triage.NewCommitSelector(triager.ops, triager.DebugTracer)
result, err := selector.Select(series, tree, lastBuild)
if err != nil {
// TODO: the workflow step must be retried.
return nil, fmt.Errorf("failed to run the commit selector for %q: %w", tree.Name, err)
} else if result.Commit == "" {
// If we fail to find a suitable commit for all the trees, return an error just about the first one.
if skipErr == nil {
skipErr = SkipError("failed to find a base commit: " + result.Reason)
}
triager.Log("failed to find a base commit for %q", tree.Name)
continue
}
triager.Log("result: %s", result.Commit)
return &SelectResult{
Tree: tree,
Commit: result.Commit,
Arch: fuzzArch,
}, nil
}
return nil, skipErr
}
type SkipTriageError struct {
Reason error
}
func SkipError(reason string) *SkipTriageError {
return &SkipTriageError{Reason: errors.New(reason)}
}
func (e *SkipTriageError) Error() string {
return fmt.Sprintf("series must be skipped: %s", e.Reason)
}
func (e *SkipTriageError) Unwrap() error {
return e.Reason
}
|
