diff options
| author | jonathanmetzman <31354670+jonathanmetzman@users.noreply.github.com> | 2021-08-19 20:06:12 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-08-19 20:06:12 -0700 |
| commit | 6bcbae307ca48d6176e994585acd7152447da992 (patch) | |
| tree | 617b8245291bbb2cfa868db24ff971a3616be4ed /docs | |
| parent | 17e2f96e6a47fff34092da4041da5d57f35be8cb (diff) | |
| download | oss-fuzz-6bcbae307ca48d6176e994585acd7152447da992.tar.gz | |
[Ubuntu Upgrade][docs] Say need to build msan deps manually (#6238)
* [Ubuntu Upgrade] Upgrade msan parts to reflect new reality.
All dependencies must be built with MSAN by the project.
OSS-Fuzz will not be providing any instrumented libraries.
Related: https://github.com/google/oss-fuzz/issues/6180
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/getting-started/new_project_guide.md | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/docs/getting-started/new_project_guide.md b/docs/getting-started/new_project_guide.md index d00e5d9d7..a5a34f141 100644 --- a/docs/getting-started/new_project_guide.md +++ b/docs/getting-started/new_project_guide.md @@ -122,9 +122,11 @@ sanitizers (currently ["address"](https://clang.llvm.org/docs/AddressSanitizer.h [MemorySanitizer](https://clang.llvm.org/docs/MemorySanitizer.html) ("memory") is also supported and recommended, but is not enabled by default due to the likelihood of false positives from -un-instrumented system dependencies. If you want to use "memory," first make sure your project's -runtime dependencies are listed in the OSS-Fuzz -[msan-libs-builder Dockerfile](https://github.com/google/oss-fuzz/blob/master/infra/base-images/msan-libs-builder/Dockerfile#L20). +un-instrumented system dependencies. +If you want to use "memory," please build all libraries your project needs using +MemorySanitizer. +This can be done by building them with the compiler flags provided during +MemorySanitizer builds. Then, you can opt in by adding "memory" to your list of sanitizers. If your project does not build with a particular sanitizer configuration and you need some time to fix @@ -369,9 +371,8 @@ information on code coverage generation. **Note:** Currently, we only support AddressSanitizer (address) and UndefinedBehaviorSanitizer (undefined) -configurations. MemorySanitizer is recommended, but needs to be enabled manually once you verify -that all system dependencies are -[instrumented](https://github.com/google/oss-fuzz/blob/master/infra/base-images/msan-libs-builder/Dockerfile#L20). +configurations by default. +MemorySanitizer is recommended, but needs to be enabled manually since you must build all runtime dependencies with MemorySanitizer. <b>Make sure to test each of the supported build configurations with the above commands (build_fuzzers -> run_fuzzer -> coverage).</b> |