History

inferno-chromium 832d367b37 Update README.md		2016-11-30 08:26:02 -08:00
..
Dockerfile	[infra] adding zip package, it is needed for corpuses	2016-11-18 20:52:41 -08:00
README.md	Update README.md	2016-11-30 08:26:02 -08:00
compile	silencing pushd	2016-11-18 16:46:04 -08:00
coverage_report	folding coverage into base-libfuzzer since target images is where sources are	2016-11-03 20:13:29 -07:00
just_run	[infra] use $src, $out and $work in build scripts instead of /src, /out, /work (#88 )	2016-11-18 11:16:38 -08:00
reproduce	[infra] reproduce command (#53 )	2016-10-26 08:28:38 -07:00
run	setting path in just_run	2016-11-02 16:33:21 -07:00
srcmap	[infra] use $src, $out and $work in build scripts instead of /src, /out, /work (#88 )	2016-11-18 11:16:38 -08:00

README.md

base-libfuzzer

Abstract base image for libfuzzer builders.

Every project image supports multiple commands that can be invoked through docker after the image is built:

docker run --rm -ti ossfuzz/$project <command> <arguments...>

Supported Commands

Command	Description
`compile` (default)	build all fuzz targets
`reproduce <fuzzer_name> <fuzzer_options>`	build all fuzz targets and run specified one with testcase `/testcase` and given options.
`run <fuzzer_name> <fuzzer_options...>`	build all fuzz targets and run specified one with given options.
`/bin/bash`	drop into shell, execute `compile` script to start build.

Examples

Reproduce using latest OSS-Fuzz build:

docker run --rm -ti -v $testcase_file:/testcase ossfuzz/$project reproduce $fuzzer

Reproduce using local source checkout:

  docker run --rm -ti -v $local_source_checkout_dir:/src/$project \
                      -v $testcase_file:/testcase ossfuzz/$project reproduce $fuzzer

Image Files Layout

Location	Description
`/out/` (`$OUT`)	Directory to store build artifacts (fuzz targets, dictionaries, options files, seed corpus archives).
`/src/` (`$SRC`)	Directory to checkout source files
`/work/`(`$WORK`)	Directory for storing intermediate files
`/usr/lib/libfuzzer.a`	Location of prebuilt libFuzzer library that needs to be linked into all fuzz targets (`-lfuzzer`).

While files layout is fixed within a container, $SRC, $OUT, $WORK are provided to be able to write retargetable scripts.

Compiler Flags

You must use special compiler flags to build your project and fuzz targets. These flags are provided in following environment variables:

Env Variable	Description
`$CC`	The C compiler binary.
`$CXX`, `$CCC`	The C++ compiler binary.
`$CFLAGS`	C compiler flags.
`$CXXFLAGS`	C++ compiler flags.

Most well-crafted build scripts will automatically use these variables. If not, pass them manually to the build tool.

Child Image Interface

Sources

Child image has to checkout all sources that it needs to compile fuzz targets into $SRC directory. When the image is executed, a directory could be mounted on top of these with local checkouts using docker run -v $HOME/my_project:/src/my_project ....

Other Required Files

Following files have to be added by child images:

File Location	Description
`$SRC/build.sh`	build script to build the project and its fuzz targets