commit 2391c94051401e211a367317fcfb2afed1801574
author David 'Digit' Turner <digit@google.com> Mon Oct 03 17:30:52 2022 +0200
committer CQ Bot <fuchsia-internal-scoped@luci-project-accounts.iam.gserviceaccount.com> Mon Jan 29 19:42:39 2024 +0000
tree cb6af1a37e93b2df5706da6946f203427ec5f699
parent 9c4e2bb9c30a55bb1afcb99d72174ca85b463726

Implement Ninja persistent mode.

This is the final CL that enables persistent mode for Ninja.
The feature is enabled by setting `NINJA_PERSISTENT_MODE=1`
in your environment, and will ensure that Ninja launches a
background persistent process for the current build directory,
if one does not exists.

This server process shuts down gracefully after 5 minutes
if no client connects to it, in order to release system
resources automatically. This delay can be changed by
setting `NINJA_PERSISTENT_TIMEOUT_SECONDS` in your
environment.

It it possible to use the new `-t server` tool, which
supports three commands:

  ninja [-C <dir>] -t server status
    Reports whether a server is running for <dir>

  ninja [-C <dir>] -t server stop
    Stops any running server serving <dir>.

  ninja [-C <dir>] -t server pid
    Return the PID of the running server, or -1 if
    there is none.

For debugging, it is possible to set `NINJA_PERSISTENT_MODE=server`
in your environment to start the server in the foreground process.
In this case, the client must be started in another terminal,
with `NINJA_PERSISTENT_MODE=1` to connect to it. Both must use
the same build directory (specified with `-C <dir>` or the working
directory if this option is not used).

Note that currently, any requests on a large build plan like
the Fuchsia one takes 1 to 2 seconds, because each query will
still need to stat() all paths in the build graph. This may be
cut down by a future patch implementing a proper timestamp cache
invalidated by inotify-based filesystem watches.

There are a number of BUGS / CAVEATS:

- Does not work on Windows at the moment due to a Win32
  technical limitation (console handles cannot be duplicated
  in other processes). A work-around will be provided in
  a future patch.

- Ninja tools that run after the build manifest is loaded
  (i.e. most of them) are always run in the client process.

Fuchsia-Topic: persistent-mode
Original-Change-Id: If07a5407596aae90b42f38ad5e72730eb5c535ce
Original-Change-Id: I965a2383609bc0f65912c72ad7944fa898c7a2a3
Original-Change-Id: Id932bd01a081d7c199604c8ed3ea9085c5dae7c1
Original-Change-Id: I02e8a6e499d9593eff20912d1dd9836b2ca2ea86
Original-Change-Id: I997f8f6a35131bcb1cf47ed71b6bbab43417d726
Original-Change-Id: I5a2306c0e4147ca1c2123cff5072772eff6b348b
Original-Change-Id: I6039620ccd8a34dada9aa082ce4f4531168edab0
Original-Change-Id: I4dab1c319234b078895c1e0f02a89d6b2a8bdd88
Original-Change-Id: I2c103e5fed54a148ba90b41fe05a0270e40ce995
Original-Change-Id: I6ba4080e090f0f10f05dafcceec054b7b73c2071
Original-Change-Id: I00752fe23bdc7f537e01fee17a43fc0f3674b6ac
Original-Change-Id: I4a6db65e250ce70eaa03922fa99bbc6cc160f009
Original-Change-Id: Iea2d5945bb8265eb982e9ab8396ad63046945655
Original-Change-Id: Iadf60f56d9217c7be0556f0d5b3b60eca98b05a6
Original-Change-Id: I9b71545c8188ed326e2b68254900cefa364d3ad9
Original-Change-Id: I6e6636af974e143d02d754f983ee8c8511fd8bab
Original-Change-Id: Id5a3fa7f2d7595a0091029996809a2049e940c63
Original-Change-Id: I7a1ff084472010433e51aa710f8800e8564fa838
Original-Change-Id: Iba02589b401c236e25c333a50a246f80ed06fcff
Original-Change-Id: Iaa7e7591f1c15a3e8341a896e4bc37ada0a1ecb7
Original-Change-Id: I071b68ffb39d89120bc93db0e2bf4fc7bc8a3230
Original-Change-Id: Ic666d6fcc8cdb684aff5d8d44e5fbc81ed9ff198
Change-Id: Ice3f5dd04410d6e3d9bf137d1ad97383260c6653
Reviewed-on: https://fuchsia-review.googlesource.com/c/third_party/github.com/ninja-build/ninja/+/981654
Commit-Queue: David Turner <digit@google.com>
Reviewed-by: David Fang <fangism@google.com>