Track and remove dynamic implicit dependencies

Due to `deps_loaded_` being reset to false unconditionally
in Edge::Reset(), every incremental build reloaded dependencies
from the deps log or dep files, and added them back to the
build graph. This resulted in massive and un-necessary
duplications. For example, for a large Fuchsia build plan,
every no-op incremental build would add 200 to 300 MiB of
memory to the RSS of the persistent server process!

This patch fixes the situation by doing the following:

- Do not reset `deps_loaded_` in Edge::Reset(), i.e. the
  dependency information recorded in each Edge stays
  there and will not be reloaded by default.

- Add `static_implicit_deps_` and `static_implicit_outs_`
  fields to track the number of implicit dependencies
  that were added to a given Edge, through the deps log,
  depfile or dyndep loading. And implement a new
  Edge::RemoveDynamicImplicitDeps() method to remove
  them when needed.

+ Add a unit-test to verify that this mechanism works
  properly.

This patch has three benefits:

- It fixes the correctness issue from bug 135792
  (verified with a new unit-test).

- It fixes the memory leak from bug 135951
  (verified manually, the RSS is stable after two
  no-op builds, and only increases very
  slightly between the first build and the second
  one).

- It speeds up dependency scanning for the next
  incremental build significantly (2s -> 1.5s)
  because it no longer needs to reload *all*
  recorded dependencies from the log on each
  edge it visits.

+ Add new dyndep-related unit-test to check the behavior of
  the new code.

Fuchsia-Topic: persistent-mode
Original-Change-Id: Iadcdbb64e28815bcec71edc530c829fcfb3ff20f
Change-Id: I067a53703d65c42d639572e59988b991608dc46c
Reviewed-on: https://fuchsia-review.googlesource.com/c/third_party/github.com/ninja-build/ninja/+/1071416
Reviewed-by: David Fang <fangism@google.com>
6 files changed
tree: 0cf6098d5c628590435418c150d5f910ce79af7b
  1. .github/
  2. doc/
  3. misc/
  4. src/
  5. windows/
  6. .clang-format
  7. .clang-tidy
  8. .editorconfig
  9. .gitignore
  10. appveyor.yml
  11. CMakeLists.txt
  12. configure.py
  13. CONTRIBUTING.md
  14. COPYING
  15. README.fuchsia
  16. README.md
  17. RELEASING.md
README.md

Ninja

Ninja is a small build system with a focus on speed. https://ninja-build.org/

See the manual or doc/manual.asciidoc included in the distribution for background and more details.

Binaries for Linux, Mac and Windows are available on GitHub. Run ./ninja -h for Ninja help.

Installation is not necessary because the only required file is the resulting ninja binary. However, to enable features like Bash completion and Emacs and Vim editing modes, some files in misc/ must be copied to appropriate locations.

If you're interested in making changes to Ninja, read CONTRIBUTING.md first.

Building Ninja itself

You can either build Ninja via the custom generator script written in Python or via CMake. For more details see the wiki.

Python

./configure.py --bootstrap

This will generate the ninja binary and a build.ninja file you can now use to build Ninja with itself.

If you have a GoogleTest source directory, you can build the tests by passing its path with --gtest-source-dir=PATH option, or the GTEST_SOURCE_DIR environment variable, e.g.:

./configure.py --bootstrap --gtest-source-dir=/path/to/googletest
./ninja all     # build ninja_test and other auxiliary binaries
./ninja_test`   # run the unit-test suite.

Use the CMake build below if you want to use a preinstalled binary version of the library.

CMake

cmake -Bbuild-cmake
cmake --build build-cmake

The ninja binary will now be inside the build-cmake directory (you can choose any other name you like).

To run the unit tests:

./build-cmake/ninja_test

Generating documentation

Ninja Manual

You must have asciidoc and xsltproc in your PATH, then do:

./configure.py
ninja manual doc/manual.pdf

Which will generate doc/manual.html.

To generate the PDF version of the manual, you must have dblatext in your PATH then do:

./configure.py    # only if you didn't do it previously.
ninja doc/manual.pdf

Which will generate doc/manual.pdf.

Doxygen documentation

If you have doxygen installed, you can build documentation extracted from C++ declarations and comments to help you navigate the code. Note that Ninja is a standalone executable, not a library, so there is no public API, all details exposed here are internal.

./configure.py   # if needed
ninja doxygen

Then open doc/doxygen/html/index.html in a browser to look at it.