Skip to content

Commit 6373532

Browse files
committed
rework fuzz testing to be smith based
-- On the standard library side: The `input: []const u8` parameter of functions passed to `testing.fuzz` has changed to `smith: *testing.Smith`. `Smith` is used to generate values from libfuzzer or input bytes generated by libfuzzer. `Smith` contains the following base methods: * `value` as a generic method for generating any type * `eos` for generating end-of-stream markers. Provides the additional guarantee `true` will eventually by provided. * `bytes` for filling a byte array. * `slice` for filling part of a buffer and providing the length. `Smith.Weight` is used for giving value ranges a higher probability of being selected. By default, every value has a weight of zero (i.e. they will not be selected). Weights can only apply to values that fit within a u64. The above functions have corresponding ones that accept weights. Additionally, the following functions are provided: * `baselineWeights` which provides a set of weights containing every possible value of a type. * `eosSimpleWeighted` for unique weights for `true` and `false` * `valueRangeAtMost` and `valueRangeLessThan` for weighing only a range of values. -- On the libfuzzer and abi side: --- Uids These are u32s which are used to classify requested values. This solves the problem of a mutation causing a new value to be requested and shifting all future values; for example: 1. An initial input contains the values 1, 2, 3 which are interpreted as a, b, and c respectively by the test. 2. The 1 is mutated to a 4 which causes the test to request an extra value interpreted as d. The input is now 4, 2, 3, 5 (new value) which the test corresponds to a, d, b, c; however, b and c no longer correspond to their original values. Uids contain a hash component and type component. The hash component is currently determined in `Smith` by taking a hash of the calling `@returnAddress()` or via an argument in the corresponding `WithHash` functions. The type component is used extensively in libfuzzer with its hashmaps. --- Mutations At the start of a cycle (a run), a random number of values to mutate is selected with less being exponentially more likely. The indexes of the values are selected from a selected uid with a logarithmic bias to uids with more values. Mutations may change a single values, several consecutive values in a uid, or several consecutive values in the uid-independent order they were requested. They may generate random values, mutate from previous ones, or copy from other values in the same uid from the same input or spliced from another. For integers, mutations from previous ones currently only generates random values. For bytes, mutations from previous mix new random data and previous bytes with a set number of mutations. --- Passive Minimization A different approach has been taken for minimizing inputs: instead of trying a fixed set of mutations when a fresh input is found, the input is instead simply added to the corpus and removed when it is no longer valuable. The quality of an input is measured based off how many unique pcs it hit and how many values it needed from the fuzzer. It is tracked which inputs hold the best qualities for each pc for hitting the minimum and maximum unique pcs while needing the least values. Once all an input's qualities have been superseded for the pcs it hit, it is removed from the corpus. -- Comparison to byte-based smith A byte-based smith would be much more inefficient and complex than this solution. It would be unable to solve the shifting problem that Uids do. It is unable to provide values from the fuzzer past end-of-stream. Even with feedback, it would be unable to act on dynamic weights which have proven essential with the updated tests (e.g. to constrain values to a range). -- Test updates All the standard library tests have been updated to use the new smith interface. For `Deque`, an ad hoc allocator was written to improve performance and remove reliance on heap allocation. `TokenSmith` has been added to aid in testing Ast and help inform decisions on the smith interface.
1 parent c0139ac commit 6373532

File tree

17 files changed

+3274
-1477
lines changed

17 files changed

+3274
-1477
lines changed

lib/compiler/test_runner.zig

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,7 @@ var fuzz_amount_or_instance: u64 = undefined;
370370

371371
pub fn fuzz(
372372
context: anytype,
373-
comptime testOne: fn (context: @TypeOf(context), []const u8) anyerror!void,
373+
comptime testOne: fn (context: @TypeOf(context), *std.testing.Smith) anyerror!void,
374374
options: testing.FuzzInputOptions,
375375
) anyerror!void {
376376
// Prevent this function from confusing the fuzzer by omitting its own code
@@ -397,12 +397,12 @@ pub fn fuzz(
397397
const global = struct {
398398
var ctx: @TypeOf(context) = undefined;
399399

400-
fn test_one(input: fuzz_abi.Slice) callconv(.c) void {
400+
fn test_one() callconv(.c) void {
401401
@disableInstrumentation();
402402
testing.allocator_instance = .{};
403403
defer if (testing.allocator_instance.deinit() == .leak) std.process.exit(1);
404404
log_err_count = 0;
405-
testOne(ctx, input.toSlice()) catch |err| switch (err) {
405+
testOne(ctx, @constCast(&testing.Smith{ .in = null })) catch |err| switch (err) {
406406
error.SkipZigTest => return,
407407
else => {
408408
std.debug.lockStdErr();
@@ -422,24 +422,24 @@ pub fn fuzz(
422422
const prev_allocator_state = testing.allocator_instance;
423423
testing.allocator_instance = .{};
424424
defer testing.allocator_instance = prev_allocator_state;
425-
426425
global.ctx = context;
427-
fuzz_abi.fuzzer_init_test(&global.test_one, .fromSlice(builtin.test_functions[fuzz_test_index].name));
428426

427+
fuzz_abi.fuzzer_set_test(&global.test_one, .fromSlice(builtin.test_functions[fuzz_test_index].name));
429428
for (options.corpus) |elem|
430429
fuzz_abi.fuzzer_new_input(.fromSlice(elem));
431-
432430
fuzz_abi.fuzzer_main(fuzz_mode, fuzz_amount_or_instance);
433431
return;
434432
}
435433

436434
// When the unit test executable is not built in fuzz mode, only run the
437435
// provided corpus.
438436
for (options.corpus) |input| {
439-
try testOne(context, input);
437+
var smith: testing.Smith = .{ .in = input };
438+
try testOne(context, &smith);
440439
}
441440

442441
// In case there is no provided corpus, also use an empty
443442
// string as a smoke test.
444-
try testOne(context, "");
443+
var smith: testing.Smith = .{ .in = "" };
444+
try testOne(context, &smith);
445445
}

0 commit comments

Comments
 (0)