aboutsummaryrefslogtreecommitdiffstats
path: root/syz-hub/state/state.go
blob: 6564050acfa6c17ad5cb5081256a307b916264ae (plain)
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
// Copyright 2016 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 state

import (
	"fmt"
	"io/ioutil"
	"os"
	"path/filepath"
	"sort"
	"strconv"
	"time"

	"github.com/google/syzkaller/db"
	. "github.com/google/syzkaller/log"
	"github.com/google/syzkaller/pkg/hash"
	"github.com/google/syzkaller/prog"
)

// State holds all internal syz-hub state including corpus and information about managers.
// It is persisted to and can be restored from a directory.
type State struct {
	seq      uint64
	dir      string
	Corpus   *db.DB
	Managers map[string]*Manager
}

// Manager represents one syz-manager instance.
type Manager struct {
	name      string
	seq       uint64
	dir       string
	Connected time.Time
	Added     int
	Deleted   int
	New       int
	Calls     map[string]struct{}
	Corpus    *db.DB
}

// Make creates State and initializes it from dir.
func Make(dir string) (*State, error) {
	st := &State{
		dir:      dir,
		Managers: make(map[string]*Manager),
	}

	os.MkdirAll(st.dir, 0750)
	var err error
	Logf(0, "reading corpus...")
	st.Corpus, err = db.Open(filepath.Join(st.dir, "corpus.db"))
	if err != nil {
		Fatalf("failed to open corpus database: %v", err)
	}
	Logf(0, "read %v programs", len(st.Corpus.Records))
	for key, rec := range st.Corpus.Records {
		if _, err := prog.CallSet(rec.Val); err != nil {
			Logf(0, "bad file in corpus: can't parse call set: %v", err)
			st.Corpus.Delete(key)
			continue
		}
		if sig := hash.Hash(rec.Val); sig.String() != key {
			Logf(0, "bad file in corpus: hash %v, want hash %v", key, sig.String())
			st.Corpus.Delete(key)
			continue
		}
		if st.seq < rec.Seq {
			st.seq = rec.Seq
		}
	}
	if err := st.Corpus.Flush(); err != nil {
		Fatalf("failed to flush corpus database: %v", err)
	}

	managersDir := filepath.Join(st.dir, "manager")
	os.MkdirAll(managersDir, 0700)
	managers, err := ioutil.ReadDir(managersDir)
	if err != nil {
		return nil, fmt.Errorf("failed to read %v dir: %v", managersDir, err)
	}
	for _, manager := range managers {
		mgr := &Manager{
			name: manager.Name(),
		}
		st.Managers[mgr.name] = mgr
		mgr.dir = filepath.Join(managersDir, mgr.name)
		seqStr, _ := ioutil.ReadFile(filepath.Join(mgr.dir, "seq"))
		mgr.seq, _ = strconv.ParseUint(string(seqStr), 10, 64)
		if st.seq < mgr.seq {
			st.seq = mgr.seq
		}
		Logf(0, "reading %v corpus...", mgr.name)
		mgr.Corpus, err = db.Open(filepath.Join(mgr.dir, "corpus.db"))
		if err != nil {
			return nil, fmt.Errorf("failed to open manager corpus database %v: %v", mgr.dir, err)
		}
		Logf(0, "read %v programs", len(mgr.Corpus.Records))
	}
	Logf(0, "purging corpus...")
	st.purgeCorpus()
	Logf(0, "done, %v programs", len(st.Corpus.Records))

	return st, err
}

func (st *State) Connect(name string, fresh bool, calls []string, corpus [][]byte) error {
	mgr := st.Managers[name]
	if mgr == nil {
		mgr = new(Manager)
		st.Managers[name] = mgr
		mgr.dir = filepath.Join(st.dir, "manager", name)
		os.MkdirAll(mgr.dir, 0700)
	}
	mgr.Connected = time.Now()
	if fresh {
		mgr.seq = 0
	}
	writeFile(filepath.Join(mgr.dir, "seq"), []byte(fmt.Sprint(mgr.seq)))

	mgr.Calls = make(map[string]struct{})
	for _, c := range calls {
		mgr.Calls[c] = struct{}{}
	}

	corpusFile := filepath.Join(mgr.dir, "corpus.db")
	os.Remove(corpusFile)
	var err error
	mgr.Corpus, err = db.Open(corpusFile)
	if err != nil {
		Logf(0, "failed to open corpus database: %v", err)
		return err
	}
	st.addInputs(mgr, corpus)
	st.purgeCorpus()
	return nil
}

func (st *State) Sync(name string, add [][]byte, del []string) ([][]byte, int, error) {
	mgr := st.Managers[name]
	if mgr == nil || mgr.Connected.IsZero() {
		return nil, 0, fmt.Errorf("unconnected manager %v", name)
	}
	if len(del) != 0 {
		for _, sig := range del {
			mgr.Corpus.Delete(sig)
		}
		if err := mgr.Corpus.Flush(); err != nil {
			Logf(0, "failed to flush corpus database: %v", err)
		}
		st.purgeCorpus()
	}
	st.addInputs(mgr, add)
	inputs, more, err := st.pendingInputs(mgr)
	mgr.Added += len(add)
	mgr.Deleted += len(del)
	mgr.New += len(inputs)
	return inputs, more, err
}

func (st *State) pendingInputs(mgr *Manager) ([][]byte, int, error) {
	if mgr.seq == st.seq {
		return nil, 0, nil
	}
	var records []db.Record
	for key, rec := range st.Corpus.Records {
		if mgr.seq >= rec.Seq {
			continue
		}
		if _, ok := mgr.Corpus.Records[key]; ok {
			continue
		}
		calls, err := prog.CallSet(rec.Val)
		if err != nil {
			return nil, 0, fmt.Errorf("failed to extract call set: %v\nprogram: %s", err, rec.Val)
		}
		if !managerSupportsAllCalls(mgr.Calls, calls) {
			continue
		}
		records = append(records, rec)
	}
	maxSeq := st.seq
	more := 0
	// Send at most that many records (rounded up to next seq number).
	const maxRecords = 1000
	if len(records) > maxRecords {
		sort.Sort(recordSeqSorter(records))
		pos := maxRecords
		maxSeq = records[pos].Seq
		for pos+1 < len(records) && records[pos+1].Seq == maxSeq {
			pos++
		}
		pos++
		more = len(records) - pos
		records = records[:pos]
	}
	inputs := make([][]byte, len(records))
	for i, rec := range records {
		inputs[i] = rec.Val
	}
	mgr.seq = maxSeq
	writeFile(filepath.Join(mgr.dir, "seq"), []byte(fmt.Sprint(mgr.seq)))
	return inputs, more, nil
}

func (st *State) addInputs(mgr *Manager, inputs [][]byte) {
	if len(inputs) == 0 {
		return
	}
	st.seq++
	for _, input := range inputs {
		st.addInput(mgr, input)
	}
	if err := mgr.Corpus.Flush(); err != nil {
		Logf(0, "failed to flush corpus database: %v", err)
	}
	if err := st.Corpus.Flush(); err != nil {
		Logf(0, "failed to flush corpus database: %v", err)
	}
}

func (st *State) addInput(mgr *Manager, input []byte) {
	if _, err := prog.CallSet(input); err != nil {
		Logf(0, "manager %v: failed to extract call set: %v, program:\n%v", mgr.name, err, string(input))
		return
	}
	sig := hash.String(input)
	mgr.Corpus.Save(sig, nil, 0)
	if _, ok := st.Corpus.Records[sig]; !ok {
		st.Corpus.Save(sig, input, st.seq)
	}
}

func writeFile(name string, data []byte) {
	if err := ioutil.WriteFile(name, data, 0600); err != nil {
		Logf(0, "failed to write file %v: %v", name, err)
	}
}

func (st *State) purgeCorpus() {
	used := make(map[string]bool)
	for _, mgr := range st.Managers {
		for sig := range mgr.Corpus.Records {
			used[sig] = true
		}
	}
	for key := range st.Corpus.Records {
		if used[key] {
			continue
		}
		st.Corpus.Delete(key)
	}
	if err := st.Corpus.Flush(); err != nil {
		Logf(0, "failed to flush corpus database: %v", err)
	}
}

func managerSupportsAllCalls(mgr, prog map[string]struct{}) bool {
	for c := range prog {
		if _, ok := mgr[c]; !ok {
			return false
		}
	}
	return true
}

type recordSeqSorter []db.Record

func (a recordSeqSorter) Len() int {
	return len(a)
}

func (a recordSeqSorter) Less(i, j int) bool {
	return a[i].Seq < a[j].Seq
}

func (a recordSeqSorter) Swap(i, j int) {
	a[i], a[j] = a[j], a[i]
}