upstream/mercurial-mirror Files · contrib/fuzz/README.rst

fuzz: new fuzzer for cext/manifest.c...

fuzz: new fuzzer for cext/manifest.c This is a bit messy, because lazymanifest is tightly coupled to the cpython API for performance reasons. As a result, we have to build a whole Python without pymalloc (so ASAN can help us out) and link against that. Then we have to use an embedded Python interpreter. We could manually drive the lazymanifest in C from that point, but experimentally just using PyEval_EvalCode isn't really any slower so we may as well do that and write the innermost guts of the fuzzer in Python. Leak detection is currently disabled for this fuzzer because there are a few global-lifetime things in our extensions that we more or less intentionally leak and I didn't want to take the detour to work around that for now. This should not be pushed to our repo until https://github.com/google/oss-fuzz/pull/1853 is merged, as this depends on having the Python tarball around. Differential Revision: https://phab.mercurial-scm.org/D4879

Augie Fackler - - Load All Authors

File last commit:

r36716:e437de38 default


                r40089:8c692a6b

default

Download file

             README.rst
        
                    26 lines
            
             | 894 B
            
                | text/x-rst
            
             |
                RstLexer
            
             / contrib / fuzz / README.rst
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Augie Fackler
    
fuzz: add a quick README to try and document how to test new fuzzers...

              r36698
            
      How to add fuzzers (partially cribbed from oss-fuzz[0]):

        1) git clone https://github.com/google/oss-fuzz

        2) cd oss-fuzz

        3) python infra/helper.py build_image mercurial

        4) docker run --cap-add=SYS_PTRACE -it -v $HG_REPO_PATH:/hg-new \

               gcr.io/oss-fuzz/mercurial bash

        5) cd /src

        6) rm -r mercurial

        7) ln -s /hg-new mercurial

        8) cd mercurial

        9) compile

        Augie Fackler
    
fuzz: add some more docs about building/running fuzzers...

              r36716
            
        10) ls $OUT

      Step 9 is literally running the command "compile", which is part of

      the docker container. Once you have that working, you can build the

      fuzzers like this (in the oss-fuzz repo):

      python infra/helper.py build_fuzzers --sanitizer address mercurial $HG_REPO_PATH

      (you can also say "memory", "undefined" or "coverage" for

      sanitizer). Then run the built fuzzers like this:

      python infra/helper.py run_fuzzer mercurial -- $FUZZER

        Augie Fackler
    
fuzz: add a quick README to try and document how to test new fuzzers...

              r36698
            
      0: https://github.com/google/oss-fuzz/blob/master/docs/new_project_guide.md

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

Augie Fackler fuzz: add a quick README to try and document how to test new fuzzers...	r36698	How to add fuzzers (partially cribbed from oss-fuzz[0]):

		1) git clone https://github.com/google/oss-fuzz
		2) cd oss-fuzz
		3) python infra/helper.py build_image mercurial
		4) docker run --cap-add=SYS_PTRACE -it -v $HG_REPO_PATH:/hg-new \
		gcr.io/oss-fuzz/mercurial bash
		5) cd /src
		6) rm -r mercurial
		7) ln -s /hg-new mercurial
		8) cd mercurial
		9) compile
Augie Fackler fuzz: add some more docs about building/running fuzzers...	r36716	10) ls $OUT

		Step 9 is literally running the command "compile", which is part of
		the docker container. Once you have that working, you can build the
		fuzzers like this (in the oss-fuzz repo):

		python infra/helper.py build_fuzzers --sanitizer address mercurial $HG_REPO_PATH

		(you can also say "memory", "undefined" or "coverage" for
		sanitizer). Then run the built fuzzers like this:

		python infra/helper.py run_fuzzer mercurial -- $FUZZER
Augie Fackler fuzz: add a quick README to try and document how to test new fuzzers...	r36698
		0: https://github.com/google/oss-fuzz/blob/master/docs/new_project_guide.md