-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement GNU jobserver posix client support
The core principle of a jobserver is simple: Before starting a new job (edge in ninja-speak), a token must be acquired from an external entity as approval. Once a job is finished, the token must be returned to signal a free thread. In the case of GNU Make, this external entity is the parent process which has executed ninja and is managing the load capacity for all subprocesses which it has spawned. Introducing client support for this model allows ninja to give load capacity management to this parent process, allowing it to control the number of subprocesses that ninja spawns at any given time. This functionality is desirable when ninja is used as part of a bigger build, such as builds with Yocto/OpenEmbedded, Openwrt/Linux, Buildroot and Android. Here, multiple compile jobs are executed in parallel in order to maximize cpu utilization, but if each compile job uses all available cores, the system is overloaded. This implementation instantiates the client in real_main() and passes references to the class into other classes. All tokens are returned whenever the CommandRunner aborts, and the current number of tokens compared to the current number of running subprocesses controls the available load capacity, used to determine how many new tokens to attempt to acquire in order to start another job for each loop to find work. Calls to functions are excluded from Windows builds pending Windows-specific support for the jobserver. Co-authored-by: Martin Hundebøll <martin@geanix.com> Co-developed-by: Martin Hundebøll <martin@geanix.com> Signed-off-by: Martin Hundebøll <martin@geanix.com> Signed-off-by: Michael Pratt <mcpratt@pm.me>
- Loading branch information
Showing
8 changed files
with
340 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,160 @@ | ||
| // Copyright 2024 Google Inc. All Rights Reserved. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| #include "jobserver.h" | ||
|
|
||
| #include <fcntl.h> | ||
| #include <unistd.h> | ||
|
|
||
| #include <cassert> | ||
| #include <cstring> | ||
|
|
||
| #include "util.h" | ||
|
|
||
| Jobserver::Jobserver() { | ||
| assert(rfd_ < 0); | ||
| assert(wfd_ < 0); | ||
|
|
||
| // Return early if no makeflags are passed in the environment | ||
| char* makeflags = std::getenv("MAKEFLAGS"); | ||
| if (makeflags == nullptr) { | ||
| return; | ||
| } | ||
|
|
||
| // Tokenize string to characters in flag_, then words in flags_ | ||
| while (flag_char_ < strlen(makeflags)) { | ||
| while (flag_char_ < strlen(makeflags) && | ||
| !isblank(static_cast<unsigned char>(makeflags[flag_char_]))) { | ||
| flag_.push_back(static_cast<unsigned char>(makeflags[flag_char_])); | ||
| flag_char_++; | ||
| } | ||
|
|
||
| if (flag_.size() > 0) | ||
| flags_.push_back(flag_); | ||
|
|
||
| flag_.clear(); | ||
| flag_char_++; | ||
| } | ||
|
|
||
| // Search for --jobserver-auth | ||
| for (size_t n = 0; n < flags_.size(); n++) | ||
| if (flags_[n].find(AUTH_KEY) == 0) | ||
| flag_ = flags_[n].substr(strlen(AUTH_KEY)); | ||
|
|
||
| // Fallback to --jobserver-fds | ||
| if (flag_.empty()) | ||
| for (size_t n = 0; n < flags_.size(); n++) | ||
| if (flags_[n].find(FDS_KEY) == 0) | ||
| flag_ = flags_[n].substr(strlen(FDS_KEY)); | ||
|
|
||
| jobserver_name_.assign(flag_); | ||
|
|
||
| const char* jobserver = jobserver_name_.c_str(); | ||
|
|
||
| // Return early if the flag's value is empty | ||
| if (jobserver_name_.empty()) { | ||
| Warning("invalid jobserver value: '%s'", jobserver); | ||
| return; | ||
| } | ||
|
|
||
| jobserver_fifo_ = jobserver_name_.find(FIFO_KEY) == 0 ? true : false; | ||
|
|
||
| // Return early if jobserver type is unknown (neither fifo nor pipe) | ||
| if (!jobserver_fifo_ && sscanf(jobserver, "%d,%d", &rfd_, &wfd_) != 2) { | ||
| Warning("invalid jobserver value: '%s'", jobserver); | ||
| return; | ||
| } | ||
|
|
||
| if (jobserver_fifo_) { | ||
| rfd_ = open(jobserver + strlen(FIFO_KEY), O_RDONLY | O_NONBLOCK); | ||
| wfd_ = open(jobserver + strlen(FIFO_KEY), O_WRONLY); | ||
| } | ||
|
|
||
| if (rfd_ == -1 || wfd_ == -1) | ||
| Fatal("failed to open jobserver: %s: %s", | ||
| jobserver, errno ? strerror(errno) : "Bad file descriptor"); | ||
| else if (rfd_ >= 0 && wfd_ >= 0) | ||
| Info("using jobserver: %s", jobserver); | ||
| else | ||
| Fatal("Make provided an invalid pipe: %s (mark the command as recursive)", | ||
| jobserver); | ||
|
|
||
| // Signal that we have initialized but do not have a token yet | ||
| token_count_ = -1; | ||
| } | ||
|
|
||
| Jobserver::~Jobserver() { | ||
| Clear(); | ||
|
|
||
| if (rfd_ >= 0) | ||
| close(rfd_); | ||
| if (wfd_ >= 0) | ||
| close(wfd_); | ||
|
|
||
| rfd_ = -1; | ||
| wfd_ = -1; | ||
| } | ||
|
|
||
| bool Jobserver::Enabled() const { | ||
| return rfd_ >= 0 && wfd_ >= 0; | ||
| } | ||
|
|
||
| int Jobserver::Tokens() const { | ||
| return token_count_; | ||
| } | ||
|
|
||
| bool Jobserver::Acquire() { | ||
| // The first token is implicitly handed to a process | ||
| if (token_count_ <= 0) { | ||
| token_count_ = 1; | ||
| return true; | ||
| } | ||
|
|
||
| char token; | ||
| int ret = read(rfd_, &token, 1); | ||
| if (ret < 0 && errno != EAGAIN && errno != EWOULDBLOCK) { | ||
| if (!jobserver_fifo_) | ||
| Warning("Make closed the pipe: %d (mark the command as recursive)", rfd_); | ||
| Fatal("failed to read token from jobserver: %d: %s", rfd_, strerror(errno)); | ||
| } | ||
|
|
||
| if (ret > 0) | ||
| token_count_++; | ||
|
|
||
| return ret > 0; | ||
| } | ||
|
|
||
| void Jobserver::Release() { | ||
| if (token_count_ < 0) | ||
| token_count_ = 0; | ||
| if (token_count_ > 0) | ||
| token_count_--; | ||
|
|
||
| // The first token is implicitly handed to a process | ||
| if (token_count_ == 0) | ||
| return; | ||
|
|
||
| char token = '+'; | ||
| int ret = write(wfd_, &token, 1); | ||
| if (ret != 1) { | ||
| if (!jobserver_fifo_) | ||
| Warning("Make closed the pipe: %d (mark the command as recursive)", wfd_); | ||
| Fatal("failed to return token to jobserver: %d: %s", wfd_, strerror(errno)); | ||
| } | ||
| } | ||
|
|
||
| void Jobserver::Clear() { | ||
| while (token_count_) | ||
| Release(); | ||
| } |
Oops, something went wrong.