Most of the code other than testcase generation is written in Python: restarting the program when it exits or crashes, noticing evidence of new bugs from the program's output, reducing testcases, and identifying when regressions were introduced.
Some parts of the fuzzer will only activate if the Python scripts can find your mozilla-central tree:
mkdir -p ~/trees/ hg clone https://hg.mozilla.org/mozilla-central/ ~/trees/mozilla-central/
Some parts of the harness assume a clean Mercurial clone of the mozilla trees. There is insufficient testing with Git for now - please file an issue if you hit problems with Git repositories of mozilla trees.
If you want to use these scripts to compile SpiderMonkey or Firefox, install the usual prerequisites for building Firefox or building SpiderMonkey. There are additional requirements for building with Address Sanitizer.
After the addition of FuzzManager support, you will need to first install the pip packages listed in requirements.txt of FuzzManager.
Here's a guide to pip and virtualenv.
Windows (only 64-bit supported)
- Install MozillaBuild (Using compileShell for SpiderMonkey requires at least version 2.2.0) to get an msys shell.
- Install Git for Windows to get Git for Windows in order to clone these funfuzz repositories. (32-bit works best for now)
- Install Debugging Tools for Windows to get cdb.exe and thus stacks from crashes.
- Make sure you install at least Microsoft Visual Studio 2015 (Community Edition is recommended) as per the build instructions above in the Setup section.
start-shell-msvc2015.batto get a MSYS shell. Do not use the MSYS shell that comes with Git for Windows. You can use Git by calling its absolute path, e.g.
/c/Program\ Files\ \(x86\)/Git/bin/git.exe.
- Run the batch file with administrator privileges to get gflags analysis working correctly.
On Mac OS X 10.9, you must first install a newer version of unzip than the one that comes with the OS. (Old versions hit an error on large zip files, such as the "mac64.tests.zip" file that downloadBuild.py grabs.)
brew install homebrew/dupes/unzip brew link --force unzip
If you encounter problems accessing the compiler, try re-running this command:
especially after updating major/minor OS versions. This sometimes manifests on Mac OS X Combo updates.
Install LLVM via Homebrew, to get llvm-symbolizer needed for symbolizing ASan crash stacks.
brew install llvm
To ensure your core dumps don't get mixed up when multiple instances crash at the same time, run:
echo -n 1 | sudo tee /proc/sys/kernel/core_uses_pid
- Install 32-bit libraries to compile 32-bit binaries:
sudo apt-get install lib32z1 gcc-multilib g++-multilib
- Fedora: (Fedora is known to work, however the exact library names are unknown for now.)
** Note that parts of the code which contain
if isLinux and float(platform.linux_distribution()) > 15.04might fail on Fedora, as they assume Ubuntu's versioning scheme. Patches welcome.
- Install gdb:
sudo apt-get install gdb
- Fedora: Please ensure that all development packages are installed (see
rpm -qa "*devel"), and run
yum install gdb
- Install clang for clang/ASan builds:
sudo apt-get install clang
To run all of the domfuzz and js fuzzers which test builds every 8 hours:
python -u funfuzz/loopBot.py -b "--random" --target-time 28800 | tee ~/log-loopBotPy.txt
To run only the js fuzzers which compiles shells with random configurations every 8 hours and tests them:
python -u funfuzz/loopBot.py -b "--random" -t "js" --target-time 28800 | tee ~/log-loopBotPy.txt
To test a patch (assuming patch is in ~/patch.diff) against a specific branch (assuming Mercurial mozilla-inbound is in ~/trees/mozilla-inbound), using a debug 64-bit deterministic shell configuration, every 8 hours:
python -u funfuzz/loopBot.py -b "--enable-debug --enable-more-deterministic -R ~/trees/mozilla-inbound -P ~/patch.diff" -t "js" --target-time 28800 | tee ~/log-loopBotPy.txt
In js mode, loopBot.py makes use of:
- compareJIT (if testing deterministic builds)
- randorderfuzz (included in jsfunfuzz, if tests are present in the mozilla repository)
- autoBisect (if the mozilla repository is present).
FuzzManager support got landed, so you will also need to create a ~/.fuzzmanagerconf file, similar to:
[Main] serverhost = <your hostname> serverport = <your port> serverproto = https serverauthtoken = <if any> sigdir = /Users/<your username>/sigcache/ tool = jsfunfuzz
Replace anything between "<" and ">" with your desired parameters.
Q: What platforms does funfuzz run on?
A: compileShell has been tested on:
- Windows 7 and Windows Server 2012 R2, with MozillaBuild 2.2.0
- Windows 10 seems to work fine with MozillaBuild 2.2.0 and some funfuzz fixes that have landed, but needs more testing
- Mac OS X 10.11
- Ubuntu 15.10 and later (best supported on 16.04 LTS)
- Ubuntu (and variants) on ARM ODROID boards are also known to work.
Fedora Linux has not been tested extensively and there may be a few bugs along the way.
The following operating systems are old/less common and while they may still work, be prepared to expect issues along the way:
- Windows Vista / Windows 8 / Windows 8.1
- Mac OS X 10.10
- Ubuntu Linux 14.04 LTS, 15.04 and prior
Support for the following operating systems have been removed:
- Windows XP
- Mac OS X 10.6 through 10.9
Q: What version of Python does funfuzz require?
A: We recommend the Python 2.7.x series. There is no support for Python3 yet.