blob: 7c226ddc29cf3eef7572cb797f1061442f964601 [file] [log] [blame]
Dan Willemsen1e704462016-08-21 15:17:17 -07001// Copyright 2017 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package build
16
17import (
Kousik Kumar84bd5bf2022-01-26 23:32:22 -050018 "context"
Kousik Kumar3ff037e2022-01-25 22:11:01 -050019 "encoding/json"
Ramy Medhat0fc67eb2020-08-12 01:26:23 -040020 "fmt"
Kousik Kumar3ff037e2022-01-25 22:11:01 -050021 "io/ioutil"
Kousik Kumar4c180ad2022-05-27 07:48:37 -040022 "math/rand"
Dan Willemsenc2af0be2017-01-20 14:10:01 -080023 "os"
Kousik Kumar84bd5bf2022-01-26 23:32:22 -050024 "os/exec"
Dan Willemsen1e704462016-08-21 15:17:17 -070025 "path/filepath"
26 "runtime"
27 "strconv"
28 "strings"
Kousik Kumar4c180ad2022-05-27 07:48:37 -040029 "syscall"
Nan Zhang2e6a4ff2018-02-14 13:27:26 -080030 "time"
Jeff Gastonefc1b412017-03-29 17:29:06 -070031
32 "android/soong/shared"
Kousik Kumarec478642020-09-21 13:39:24 -040033
Dan Willemsen4591b642021-05-24 14:24:12 -070034 "google.golang.org/protobuf/proto"
Patrice Arruda96850362020-08-11 20:41:11 +000035
36 smpb "android/soong/ui/metrics/metrics_proto"
Dan Willemsen1e704462016-08-21 15:17:17 -070037)
38
Kousik Kumar3ff037e2022-01-25 22:11:01 -050039const (
Chris Parsons53f68ae2022-03-03 12:01:40 -050040 envConfigDir = "vendor/google/tools/soong_config"
41 jsonSuffix = "json"
Kousik Kumar84bd5bf2022-01-26 23:32:22 -050042
Chris Parsons53f68ae2022-03-03 12:01:40 -050043 configFetcher = "vendor/google/tools/soong/expconfigfetcher"
Kousik Kumar84bd5bf2022-01-26 23:32:22 -050044 envConfigFetchTimeout = 10 * time.Second
Kousik Kumar3ff037e2022-01-25 22:11:01 -050045)
46
Kousik Kumar4c180ad2022-05-27 07:48:37 -040047var (
Kevin Dagostino096ab2f2023-03-03 19:47:17 +000048 rbeRandPrefix int
49 googleProdCredsExistCache bool
Kousik Kumar4c180ad2022-05-27 07:48:37 -040050)
51
52func init() {
53 rand.Seed(time.Now().UnixNano())
54 rbeRandPrefix = rand.Intn(1000)
55}
56
Dan Willemsen1e704462016-08-21 15:17:17 -070057type Config struct{ *configImpl }
58
59type configImpl struct {
Lukacs T. Berkia1b93722021-09-02 17:23:06 +020060 // Some targets that are implemented in soong_build
61 // (bp2build, json-module-graph) are not here and have their own bits below.
Colin Cross28f527c2019-11-26 16:19:04 -080062 arguments []string
63 goma bool
64 environ *Environment
65 distDir string
66 buildDateTime string
MarkDacek6614d9c2022-12-07 21:57:38 +000067 logsPrefix string
Dan Willemsen1e704462016-08-21 15:17:17 -070068
69 // From the arguments
MarkDacekd0e7cd32022-12-02 22:22:40 +000070 parallel int
71 keepGoing int
72 verbose bool
73 checkbuild bool
74 dist bool
75 jsonModuleGraph bool
76 apiBp2build bool // Generate BUILD files for Soong modules that contribute APIs
77 bp2build bool
78 queryview bool
79 reportMkMetrics bool // Collect and report mk2bp migration progress metrics.
80 soongDocs bool
LaMont Jones52a72432023-03-09 18:19:35 +000081 multitreeBuild bool // This is a multitree build.
MarkDacekd0e7cd32022-12-02 22:22:40 +000082 skipConfig bool
83 skipKati bool
84 skipKatiNinja bool
85 skipSoong bool
86 skipNinja bool
87 skipSoongTests bool
88 searchApiDir bool // Scan the Android.bp files generated in out/api_surfaces
89 skipMetricsUpload bool
MarkDacek6614d9c2022-12-07 21:57:38 +000090 buildStartedTime int64 // For metrics-upload-only - manually specify a build-started time
Jihoon Kang1bff0342023-01-17 20:40:22 +000091 buildFromTextStub bool
Dan Willemsen1e704462016-08-21 15:17:17 -070092
93 // From the product config
Dan Willemsen6ab79db2018-05-02 00:06:28 -070094 katiArgs []string
95 ninjaArgs []string
96 katiSuffix string
97 targetDevice string
98 targetDeviceDir string
Spandan Dasa3639e62021-05-25 19:14:02 +000099 sandboxConfig *SandboxConfig
Dan Willemsen3d60b112018-04-04 22:25:56 -0700100
Dan Willemsen2bb82d02019-12-27 09:35:42 -0800101 // Autodetected
102 totalRAM uint64
103
Dan Willemsene3336352020-01-02 19:10:38 -0800104 brokenDupRules bool
105 brokenUsesNetwork bool
106 brokenNinjaEnvVars []string
Dan Willemsen18490112018-05-25 16:30:04 -0700107
108 pathReplaced bool
Rupert Shuttleworth3c9f5ac2020-12-10 11:32:38 +0000109
MarkDacekb78465d2022-10-18 20:10:16 +0000110 bazelProdMode bool
111 bazelDevMode bool
112 bazelStagingMode bool
Rupert Shuttleworth3c9f5ac2020-12-10 11:32:38 +0000113
Colin Crossf3bdbcb2021-06-01 11:43:55 -0700114 // Set by multiproduct_kati
115 emptyNinjaFile bool
Yu Liu6e13b402021-07-27 14:29:06 -0700116
117 metricsUploader string
MarkDacekd06db5d2022-11-29 00:47:59 +0000118
119 bazelForceEnabledModules string
Spandan Dasc5763832022-11-08 18:42:16 +0000120
121 includeTags []string
Jeongik Cha0cf44d52023-03-15 00:10:45 +0900122
123 // Data source to write ninja weight list
124 ninjaWeightListSource NinjaWeightListSource
Dan Willemsen1e704462016-08-21 15:17:17 -0700125}
126
Jeongik Cha0cf44d52023-03-15 00:10:45 +0900127type NinjaWeightListSource uint
128
129const (
130 // ninja doesn't use weight list.
131 NOT_USED NinjaWeightListSource = iota
132 // ninja uses weight list based on previous builds by ninja log
133 NINJA_LOG
134 // ninja thinks every task has the same weight.
135 EVENLY_DISTRIBUTED
136)
Dan Willemsenc2af0be2017-01-20 14:10:01 -0800137const srcDirFileCheck = "build/soong/root.bp"
138
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700139var buildFiles = []string{"Android.mk", "Android.bp"}
140
Patrice Arruda13848222019-04-22 17:12:02 -0700141type BuildAction uint
142
143const (
144 // Builds all of the modules and their dependencies of a specified directory, relative to the root
145 // directory of the source tree.
146 BUILD_MODULES_IN_A_DIRECTORY BuildAction = iota
147
148 // Builds all of the modules and their dependencies of a list of specified directories. All specified
149 // directories are relative to the root directory of the source tree.
150 BUILD_MODULES_IN_DIRECTORIES
Patrice Arruda39282062019-06-20 16:35:12 -0700151
152 // Build a list of specified modules. If none was specified, simply build the whole source tree.
153 BUILD_MODULES
Patrice Arruda13848222019-04-22 17:12:02 -0700154)
155
156// checkTopDir validates that the current directory is at the root directory of the source tree.
157func checkTopDir(ctx Context) {
158 if _, err := os.Stat(srcDirFileCheck); err != nil {
159 if os.IsNotExist(err) {
160 ctx.Fatalf("Current working directory must be the source tree. %q not found.", srcDirFileCheck)
161 }
162 ctx.Fatalln("Error verifying tree state:", err)
163 }
164}
165
Kousik Kumarc8818332023-01-16 16:33:05 +0000166// fetchEnvConfig optionally fetches a configuration file that can then subsequently be
167// loaded into Soong environment to control certain aspects of build behavior (e.g., enabling RBE).
168// If a configuration file already exists on disk, the fetch is run in the background
169// so as to NOT block the rest of the build execution.
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500170func fetchEnvConfig(ctx Context, config *configImpl, envConfigName string) error {
David Goldsmith62243a32022-04-08 13:42:04 +0000171 configName := envConfigName + "." + jsonSuffix
Kousik Kumarc75e1292022-07-07 02:20:51 +0000172 expConfigFetcher := &smpb.ExpConfigFetcher{Filename: &configName}
David Goldsmith62243a32022-04-08 13:42:04 +0000173 defer func() {
174 ctx.Metrics.ExpConfigFetcher(expConfigFetcher)
175 }()
Kousik Kumarc75e1292022-07-07 02:20:51 +0000176 if !config.GoogleProdCredsExist() {
177 status := smpb.ExpConfigFetcher_MISSING_GCERT
178 expConfigFetcher.Status = &status
179 return nil
180 }
David Goldsmith62243a32022-04-08 13:42:04 +0000181
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500182 s, err := os.Stat(configFetcher)
183 if err != nil {
184 if os.IsNotExist(err) {
185 return nil
186 }
187 return err
188 }
189 if s.Mode()&0111 == 0 {
David Goldsmith62243a32022-04-08 13:42:04 +0000190 status := smpb.ExpConfigFetcher_ERROR
191 expConfigFetcher.Status = &status
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500192 return fmt.Errorf("configuration fetcher binary %v is not executable: %v", configFetcher, s.Mode())
193 }
194
Kousik Kumarc8818332023-01-16 16:33:05 +0000195 configExists := false
196 outConfigFilePath := filepath.Join(config.OutDir(), configName)
197 if _, err := os.Stat(outConfigFilePath); err == nil {
198 configExists = true
199 }
200
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500201 tCtx, cancel := context.WithTimeout(ctx, envConfigFetchTimeout)
David Goldsmith62243a32022-04-08 13:42:04 +0000202 fetchStart := time.Now()
203 cmd := exec.CommandContext(tCtx, configFetcher, "-output_config_dir", config.OutDir(),
204 "-output_config_name", configName)
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500205 if err := cmd.Start(); err != nil {
David Goldsmith62243a32022-04-08 13:42:04 +0000206 status := smpb.ExpConfigFetcher_ERROR
207 expConfigFetcher.Status = &status
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500208 return err
209 }
210
Kousik Kumarc8818332023-01-16 16:33:05 +0000211 fetchCfg := func() error {
212 if err := cmd.Wait(); err != nil {
213 status := smpb.ExpConfigFetcher_ERROR
214 expConfigFetcher.Status = &status
215 return err
216 }
217 fetchEnd := time.Now()
218 expConfigFetcher.Micros = proto.Uint64(uint64(fetchEnd.Sub(fetchStart).Microseconds()))
219 expConfigFetcher.Filename = proto.String(outConfigFilePath)
220
221 if _, err := os.Stat(outConfigFilePath); err != nil {
222 status := smpb.ExpConfigFetcher_NO_CONFIG
223 expConfigFetcher.Status = &status
224 return err
225 }
David Goldsmith62243a32022-04-08 13:42:04 +0000226 status := smpb.ExpConfigFetcher_CONFIG
227 expConfigFetcher.Status = &status
Kousik Kumarc8818332023-01-16 16:33:05 +0000228 return nil
David Goldsmith62243a32022-04-08 13:42:04 +0000229 }
Kousik Kumarc8818332023-01-16 16:33:05 +0000230
231 // If a config file does not exist, wait for the config file to be fetched. Otherwise
232 // fetch the config file in the background and return immediately.
233 if !configExists {
234 defer cancel()
235 return fetchCfg()
236 }
237
238 go func() {
239 defer cancel()
240 if err := fetchCfg(); err != nil {
241 ctx.Verbosef("Failed to fetch config file %v: %v\n", configName, err)
242 }
243 }()
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500244 return nil
245}
246
MarkDacek7901e582023-01-09 19:48:01 +0000247func loadEnvConfig(ctx Context, config *configImpl, bc string) error {
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500248 if bc == "" {
249 return nil
250 }
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500251
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500252 configDirs := []string{
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500253 config.OutDir(),
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500254 os.Getenv("ANDROID_BUILD_ENVIRONMENT_CONFIG_DIR"),
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500255 envConfigDir,
256 }
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500257 for _, dir := range configDirs {
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500258 cfgFile := filepath.Join(os.Getenv("TOP"), dir, fmt.Sprintf("%s.%s", bc, jsonSuffix))
259 envVarsJSON, err := ioutil.ReadFile(cfgFile)
260 if err != nil {
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500261 continue
262 }
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500263 ctx.Verbosef("Loading config file %v\n", cfgFile)
264 var envVars map[string]map[string]string
265 if err := json.Unmarshal(envVarsJSON, &envVars); err != nil {
266 fmt.Fprintf(os.Stderr, "Env vars config file %s did not parse correctly: %s", cfgFile, err.Error())
267 continue
268 }
269 for k, v := range envVars["env"] {
270 if os.Getenv(k) != "" {
271 continue
272 }
273 config.environ.Set(k, v)
274 }
275 ctx.Verbosef("Finished loading config file %v\n", cfgFile)
276 break
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500277 }
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500278
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500279 return nil
280}
281
Chris Parsonsb6e96902022-10-31 20:08:45 -0400282func defaultBazelProdMode(cfg *configImpl) bool {
MarkDacekd06db5d2022-11-29 00:47:59 +0000283 // Environment flag to disable Bazel for users which experience
Chris Parsonsb6e96902022-10-31 20:08:45 -0400284 // broken bazel-handled builds, or significant performance regressions.
285 if cfg.IsBazelMixedBuildForceDisabled() {
286 return false
287 }
288 // Darwin-host builds are currently untested with Bazel.
289 if runtime.GOOS == "darwin" {
290 return false
291 }
Chris Parsons035e03a2022-11-01 14:25:45 -0400292 return true
Chris Parsonsb6e96902022-10-31 20:08:45 -0400293}
294
MarkDacek6614d9c2022-12-07 21:57:38 +0000295func UploadOnlyConfig(ctx Context, _ ...string) Config {
296 ret := &configImpl{
297 environ: OsEnvironment(),
298 sandboxConfig: &SandboxConfig{},
299 }
MarkDacek7901e582023-01-09 19:48:01 +0000300 srcDir := absPath(ctx, ".")
301 bc := os.Getenv("ANDROID_BUILD_ENVIRONMENT_CONFIG")
302 if err := loadEnvConfig(ctx, ret, bc); err != nil {
303 ctx.Fatalln("Failed to parse env config files: %v", err)
304 }
305 ret.metricsUploader = GetMetricsUploader(srcDir, ret.environ)
MarkDacek6614d9c2022-12-07 21:57:38 +0000306 return Config{ret}
307}
308
Dan Willemsen1e704462016-08-21 15:17:17 -0700309func NewConfig(ctx Context, args ...string) Config {
310 ret := &configImpl{
Spandan Dasa3639e62021-05-25 19:14:02 +0000311 environ: OsEnvironment(),
312 sandboxConfig: &SandboxConfig{},
Dan Willemsen1e704462016-08-21 15:17:17 -0700313 }
314
Patrice Arruda90109172020-07-28 18:07:27 +0000315 // Default matching ninja
Dan Willemsen9b587492017-07-10 22:13:00 -0700316 ret.parallel = runtime.NumCPU() + 2
317 ret.keepGoing = 1
318
Dan Willemsen2bb82d02019-12-27 09:35:42 -0800319 ret.totalRAM = detectTotalRAM(ctx)
Dan Willemsen9b587492017-07-10 22:13:00 -0700320 ret.parseArgs(ctx, args)
Dan Willemsen0c3919e2017-03-02 15:49:10 -0800321 // Make sure OUT_DIR is set appropriately
Dan Willemsen02f3add2017-05-12 13:50:19 -0700322 if outDir, ok := ret.environ.Get("OUT_DIR"); ok {
323 ret.environ.Set("OUT_DIR", filepath.Clean(outDir))
324 } else {
Dan Willemsen0c3919e2017-03-02 15:49:10 -0800325 outDir := "out"
326 if baseDir, ok := ret.environ.Get("OUT_DIR_COMMON_BASE"); ok {
327 if wd, err := os.Getwd(); err != nil {
328 ctx.Fatalln("Failed to get working directory:", err)
329 } else {
330 outDir = filepath.Join(baseDir, filepath.Base(wd))
331 }
332 }
333 ret.environ.Set("OUT_DIR", outDir)
334 }
335
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500336 // loadEnvConfig needs to know what the OUT_DIR is, so it should
337 // be called after we determine the appropriate out directory.
MarkDacek7901e582023-01-09 19:48:01 +0000338 bc := os.Getenv("ANDROID_BUILD_ENVIRONMENT_CONFIG")
339
340 if bc != "" {
341 if err := fetchEnvConfig(ctx, ret, bc); err != nil {
342 ctx.Verbosef("Failed to fetch config file: %v\n", err)
Kousik Kumarc8818332023-01-16 16:33:05 +0000343 }
344 if err := loadEnvConfig(ctx, ret, bc); err != nil {
MarkDacek7901e582023-01-09 19:48:01 +0000345 ctx.Fatalln("Failed to parse env config files: %v", err)
346 }
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500347 }
348
Dan Willemsen2d31a442018-10-20 21:33:41 -0700349 if distDir, ok := ret.environ.Get("DIST_DIR"); ok {
350 ret.distDir = filepath.Clean(distDir)
351 } else {
352 ret.distDir = filepath.Join(ret.OutDir(), "dist")
353 }
Dan Willemsend50e89f2018-10-16 17:49:25 -0700354
Spandan Das05063612021-06-25 01:39:04 +0000355 if srcDirIsWritable, ok := ret.environ.Get("BUILD_BROKEN_SRC_DIR_IS_WRITABLE"); ok {
356 ret.sandboxConfig.SetSrcDirIsRO(srcDirIsWritable == "false")
357 }
358
Dan Willemsen1e704462016-08-21 15:17:17 -0700359 ret.environ.Unset(
360 // We're already using it
361 "USE_SOONG_UI",
362
363 // We should never use GOROOT/GOPATH from the shell environment
364 "GOROOT",
365 "GOPATH",
366
367 // These should only come from Soong, not the environment.
368 "CLANG",
369 "CLANG_CXX",
370 "CCC_CC",
371 "CCC_CXX",
372
373 // Used by the goma compiler wrapper, but should only be set by
374 // gomacc
375 "GOMACC_PATH",
Dan Willemsen0c3919e2017-03-02 15:49:10 -0800376
377 // We handle this above
378 "OUT_DIR_COMMON_BASE",
Dan Willemsen68a09852017-04-18 13:56:57 -0700379
Dan Willemsen2d31a442018-10-20 21:33:41 -0700380 // This is handled above too, and set for individual commands later
381 "DIST_DIR",
382
Dan Willemsen68a09852017-04-18 13:56:57 -0700383 // Variables that have caused problems in the past
Dan Willemsen1c504d92019-11-18 19:13:53 +0000384 "BASH_ENV",
Dan Willemsenebfe33a2018-05-01 10:07:50 -0700385 "CDPATH",
Dan Willemsen68a09852017-04-18 13:56:57 -0700386 "DISPLAY",
387 "GREP_OPTIONS",
Nathan Egge7b067fb2023-02-17 17:54:31 +0000388 "JAVAC",
Dan Willemsenebfe33a2018-05-01 10:07:50 -0700389 "NDK_ROOT",
Dan Willemsen00fcb262018-08-15 15:35:38 -0700390 "POSIXLY_CORRECT",
Dan Willemsenc40e10b2017-07-11 14:30:00 -0700391
392 // Drop make flags
393 "MAKEFLAGS",
394 "MAKELEVEL",
395 "MFLAGS",
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700396
397 // Set in envsetup.sh, reset in makefiles
398 "ANDROID_JAVA_TOOLCHAIN",
Colin Cross7f09c402018-07-11 14:49:31 -0700399
400 // Set by envsetup.sh, but shouldn't be used inside the build because envsetup.sh is optional
401 "ANDROID_BUILD_TOP",
402 "ANDROID_HOST_OUT",
403 "ANDROID_PRODUCT_OUT",
404 "ANDROID_HOST_OUT_TESTCASES",
405 "ANDROID_TARGET_OUT_TESTCASES",
406 "ANDROID_TOOLCHAIN",
407 "ANDROID_TOOLCHAIN_2ND_ARCH",
408 "ANDROID_DEV_SCRIPTS",
409 "ANDROID_EMULATOR_PREBUILTS",
410 "ANDROID_PRE_BUILD_PATHS",
Dan Willemsen1e704462016-08-21 15:17:17 -0700411 )
412
Kousik Kumarb328f6d2020-10-19 01:45:46 -0400413 if ret.UseGoma() || ret.ForceUseGoma() {
414 ctx.Println("Goma for Android has been deprecated and replaced with RBE. See go/rbe_for_android for instructions on how to use RBE.")
415 ctx.Fatalln("USE_GOMA / FORCE_USE_GOMA flag is no longer supported.")
Kousik Kumarec478642020-09-21 13:39:24 -0400416 }
417
Dan Willemsen1e704462016-08-21 15:17:17 -0700418 // Tell python not to spam the source tree with .pyc files.
419 ret.environ.Set("PYTHONDONTWRITEBYTECODE", "1")
420
Ramy Medhatca1e44c2020-07-16 12:18:37 -0400421 tmpDir := absPath(ctx, ret.TempDir())
422 ret.environ.Set("TMPDIR", tmpDir)
Dan Willemsen32a669b2018-03-08 19:42:00 -0800423
Dan Willemsen70c1ff82019-08-21 14:56:13 -0700424 // Always set ASAN_SYMBOLIZER_PATH so that ASAN-based tools can symbolize any crashes
425 symbolizerPath := filepath.Join("prebuilts/clang/host", ret.HostPrebuiltTag(),
426 "llvm-binutils-stable/llvm-symbolizer")
427 ret.environ.Set("ASAN_SYMBOLIZER_PATH", absPath(ctx, symbolizerPath))
428
Dan Willemsenc2af0be2017-01-20 14:10:01 -0800429 // Precondition: the current directory is the top of the source tree
Patrice Arruda13848222019-04-22 17:12:02 -0700430 checkTopDir(ctx)
Dan Willemsenc2af0be2017-01-20 14:10:01 -0800431
Yu Liu6e13b402021-07-27 14:29:06 -0700432 srcDir := absPath(ctx, ".")
433 if strings.ContainsRune(srcDir, ' ') {
Colin Cross1f6faeb2019-09-23 15:52:40 -0700434 ctx.Println("You are building in a directory whose absolute path contains a space character:")
435 ctx.Println()
436 ctx.Printf("%q\n", srcDir)
437 ctx.Println()
438 ctx.Fatalln("Directory names containing spaces are not supported")
Dan Willemsendb8457c2017-05-12 16:38:17 -0700439 }
440
Yu Liu6e13b402021-07-27 14:29:06 -0700441 ret.metricsUploader = GetMetricsUploader(srcDir, ret.environ)
442
Dan Willemsendb8457c2017-05-12 16:38:17 -0700443 if outDir := ret.OutDir(); strings.ContainsRune(outDir, ' ') {
Colin Cross1f6faeb2019-09-23 15:52:40 -0700444 ctx.Println("The absolute path of your output directory ($OUT_DIR) contains a space character:")
445 ctx.Println()
446 ctx.Printf("%q\n", outDir)
447 ctx.Println()
448 ctx.Fatalln("Directory names containing spaces are not supported")
Dan Willemsendb8457c2017-05-12 16:38:17 -0700449 }
450
Rupert Shuttleworth3c9f5ac2020-12-10 11:32:38 +0000451 if distDir := ret.RealDistDir(); strings.ContainsRune(distDir, ' ') {
Colin Cross1f6faeb2019-09-23 15:52:40 -0700452 ctx.Println("The absolute path of your dist directory ($DIST_DIR) contains a space character:")
453 ctx.Println()
454 ctx.Printf("%q\n", distDir)
455 ctx.Println()
456 ctx.Fatalln("Directory names containing spaces are not supported")
Dan Willemsendb8457c2017-05-12 16:38:17 -0700457 }
458
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700459 // Configure Java-related variables, including adding it to $PATH
Tobias Thierere59aeff2017-12-20 22:40:39 +0000460 java8Home := filepath.Join("prebuilts/jdk/jdk8", ret.HostPrebuiltTag())
461 java9Home := filepath.Join("prebuilts/jdk/jdk9", ret.HostPrebuiltTag())
Pete Gillin1f52e932019-10-09 17:10:08 +0100462 java11Home := filepath.Join("prebuilts/jdk/jdk11", ret.HostPrebuiltTag())
Colin Cross59c1e6a2022-03-04 13:37:19 -0800463 java17Home := filepath.Join("prebuilts/jdk/jdk17", ret.HostPrebuiltTag())
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700464 javaHome := func() string {
465 if override, ok := ret.environ.Get("OVERRIDE_ANDROID_JAVA_HOME"); ok {
466 return override
467 }
Pete Gillina7a3d642019-11-07 18:58:42 +0000468 if toolchain11, ok := ret.environ.Get("EXPERIMENTAL_USE_OPENJDK11_TOOLCHAIN"); ok && toolchain11 != "true" {
469 ctx.Fatalln("The environment variable EXPERIMENTAL_USE_OPENJDK11_TOOLCHAIN is no longer supported. An OpenJDK 11 toolchain is now the global default.")
Pete Gillin1f52e932019-10-09 17:10:08 +0100470 }
Sorin Basca7e094b32022-10-05 08:20:12 +0000471 if toolchain17, ok := ret.environ.Get("EXPERIMENTAL_USE_OPENJDK17_TOOLCHAIN"); ok && toolchain17 != "true" {
472 ctx.Fatalln("The environment variable EXPERIMENTAL_USE_OPENJDK17_TOOLCHAIN is no longer supported. An OpenJDK 17 toolchain is now the global default.")
473 }
474 return java17Home
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700475 }()
476 absJavaHome := absPath(ctx, javaHome)
477
Dan Willemsened869522018-01-08 14:58:46 -0800478 ret.configureLocale(ctx)
479
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700480 newPath := []string{filepath.Join(absJavaHome, "bin")}
481 if path, ok := ret.environ.Get("PATH"); ok && path != "" {
482 newPath = append(newPath, path)
483 }
Pete Gillin1f52e932019-10-09 17:10:08 +0100484
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700485 ret.environ.Unset("OVERRIDE_ANDROID_JAVA_HOME")
486 ret.environ.Set("JAVA_HOME", absJavaHome)
487 ret.environ.Set("ANDROID_JAVA_HOME", javaHome)
Tobias Thierere59aeff2017-12-20 22:40:39 +0000488 ret.environ.Set("ANDROID_JAVA8_HOME", java8Home)
489 ret.environ.Set("ANDROID_JAVA9_HOME", java9Home)
Pete Gillin1f52e932019-10-09 17:10:08 +0100490 ret.environ.Set("ANDROID_JAVA11_HOME", java11Home)
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700491 ret.environ.Set("PATH", strings.Join(newPath, string(filepath.ListSeparator)))
492
LaMont Jones52a72432023-03-09 18:19:35 +0000493 if ret.MultitreeBuild() {
494 ret.environ.Set("MULTITREE_BUILD", "true")
495 }
496
Nan Zhang2e6a4ff2018-02-14 13:27:26 -0800497 outDir := ret.OutDir()
498 buildDateTimeFile := filepath.Join(outDir, "build_date.txt")
Nan Zhang2e6a4ff2018-02-14 13:27:26 -0800499 if buildDateTime, ok := ret.environ.Get("BUILD_DATETIME"); ok && buildDateTime != "" {
Colin Cross28f527c2019-11-26 16:19:04 -0800500 ret.buildDateTime = buildDateTime
Nan Zhang2e6a4ff2018-02-14 13:27:26 -0800501 } else {
Colin Cross28f527c2019-11-26 16:19:04 -0800502 ret.buildDateTime = strconv.FormatInt(time.Now().Unix(), 10)
Nan Zhang2e6a4ff2018-02-14 13:27:26 -0800503 }
Colin Cross28f527c2019-11-26 16:19:04 -0800504
Nan Zhang2e6a4ff2018-02-14 13:27:26 -0800505 ret.environ.Set("BUILD_DATETIME_FILE", buildDateTimeFile)
506
Ramy Medhatca1e44c2020-07-16 12:18:37 -0400507 if ret.UseRBE() {
Ramy Medhat0fc67eb2020-08-12 01:26:23 -0400508 for k, v := range getRBEVars(ctx, Config{ret}) {
Ramy Medhatca1e44c2020-07-16 12:18:37 -0400509 ret.environ.Set(k, v)
510 }
511 }
512
Jihoon Kang1bff0342023-01-17 20:40:22 +0000513 if ret.BuildFromTextStub() {
514 // TODO(b/271443071): support hidden api check for from-text stub build
515 ret.environ.Set("UNSAFE_DISABLE_HIDDENAPI_FLAGS", "true")
516 }
517
Patrice Arruda83842d72020-12-08 19:42:08 +0000518 bpd := ret.BazelMetricsDir()
Patrice Arrudaaf880da2020-11-13 08:41:26 -0800519 if err := os.RemoveAll(bpd); err != nil {
520 ctx.Fatalf("Unable to remove bazel profile directory %q: %v", bpd, err)
521 }
Rupert Shuttleworth3c9f5ac2020-12-10 11:32:38 +0000522
Patrice Arruda96850362020-08-11 20:41:11 +0000523 c := Config{ret}
524 storeConfigMetrics(ctx, c)
525 return c
Dan Willemsen9b587492017-07-10 22:13:00 -0700526}
527
Patrice Arruda13848222019-04-22 17:12:02 -0700528// NewBuildActionConfig returns a build configuration based on the build action. The arguments are
529// processed based on the build action and extracts any arguments that belongs to the build action.
Dan Willemsence41e942019-07-29 23:39:30 -0700530func NewBuildActionConfig(action BuildAction, dir string, ctx Context, args ...string) Config {
531 return NewConfig(ctx, getConfigArgs(action, dir, ctx, args)...)
Patrice Arruda13848222019-04-22 17:12:02 -0700532}
533
Patrice Arruda96850362020-08-11 20:41:11 +0000534// storeConfigMetrics selects a set of configuration information and store in
535// the metrics system for further analysis.
536func storeConfigMetrics(ctx Context, config Config) {
537 if ctx.Metrics == nil {
538 return
539 }
540
Liz Kammerca9cb2e2021-07-14 15:29:57 -0400541 ctx.Metrics.BuildConfig(buildConfig(config))
Patrice Arruda3edfd482020-10-13 23:58:41 +0000542
543 s := &smpb.SystemResourceInfo{
544 TotalPhysicalMemory: proto.Uint64(config.TotalRAM()),
545 AvailableCpus: proto.Int32(int32(runtime.NumCPU())),
546 }
547 ctx.Metrics.SystemResourceInfo(s)
Patrice Arruda96850362020-08-11 20:41:11 +0000548}
549
Jeongik Cha8d63d562023-03-17 03:52:13 +0900550func getNinjaWeightListSourceInMetric(s NinjaWeightListSource) *smpb.BuildConfig_NinjaWeightListSource {
Jeongik Cha0cf44d52023-03-15 00:10:45 +0900551 switch s {
552 case NINJA_LOG:
Jeongik Cha8d63d562023-03-17 03:52:13 +0900553 return smpb.BuildConfig_NINJA_LOG.Enum()
Jeongik Cha0cf44d52023-03-15 00:10:45 +0900554 case EVENLY_DISTRIBUTED:
Jeongik Cha8d63d562023-03-17 03:52:13 +0900555 return smpb.BuildConfig_EVENLY_DISTRIBUTED.Enum()
Jeongik Cha0cf44d52023-03-15 00:10:45 +0900556 default:
Jeongik Cha8d63d562023-03-17 03:52:13 +0900557 return smpb.BuildConfig_NOT_USED.Enum()
Jeongik Cha0cf44d52023-03-15 00:10:45 +0900558 }
559}
560
Liz Kammerca9cb2e2021-07-14 15:29:57 -0400561func buildConfig(config Config) *smpb.BuildConfig {
Yu Liue737a992021-10-04 13:21:41 -0700562 c := &smpb.BuildConfig{
Romain Jobredeaux0a7529b2022-10-26 12:56:41 -0400563 ForceUseGoma: proto.Bool(config.ForceUseGoma()),
564 UseGoma: proto.Bool(config.UseGoma()),
565 UseRbe: proto.Bool(config.UseRBE()),
566 BazelMixedBuild: proto.Bool(config.BazelBuildEnabled()),
567 ForceDisableBazelMixedBuild: proto.Bool(config.IsBazelMixedBuildForceDisabled()),
Jeongik Cha0cf44d52023-03-15 00:10:45 +0900568 NinjaWeightListSource: getNinjaWeightListSourceInMetric(config.NinjaWeightListSource()),
Liz Kammerca9cb2e2021-07-14 15:29:57 -0400569 }
Yu Liue737a992021-10-04 13:21:41 -0700570 c.Targets = append(c.Targets, config.arguments...)
571
572 return c
Liz Kammerca9cb2e2021-07-14 15:29:57 -0400573}
574
Patrice Arruda13848222019-04-22 17:12:02 -0700575// getConfigArgs processes the command arguments based on the build action and creates a set of new
576// arguments to be accepted by Config.
Dan Willemsence41e942019-07-29 23:39:30 -0700577func getConfigArgs(action BuildAction, dir string, ctx Context, args []string) []string {
Patrice Arruda13848222019-04-22 17:12:02 -0700578 // The next block of code verifies that the current directory is the root directory of the source
579 // tree. It then finds the relative path of dir based on the root directory of the source tree
580 // and verify that dir is inside of the source tree.
581 checkTopDir(ctx)
582 topDir, err := os.Getwd()
583 if err != nil {
584 ctx.Fatalf("Error retrieving top directory: %v", err)
585 }
Patrice Arrudababa9a92019-07-03 10:47:34 -0700586 dir, err = filepath.EvalSymlinks(dir)
587 if err != nil {
588 ctx.Fatalf("Unable to evaluate symlink of %s: %v", dir, err)
589 }
Patrice Arruda13848222019-04-22 17:12:02 -0700590 dir, err = filepath.Abs(dir)
591 if err != nil {
592 ctx.Fatalf("Unable to find absolute path %s: %v", dir, err)
593 }
594 relDir, err := filepath.Rel(topDir, dir)
595 if err != nil {
596 ctx.Fatalf("Unable to find relative path %s of %s: %v", relDir, topDir, err)
597 }
598 // If there are ".." in the path, it's not in the source tree.
599 if strings.Contains(relDir, "..") {
600 ctx.Fatalf("Directory %s is not under the source tree %s", dir, topDir)
601 }
602
603 configArgs := args[:]
604
605 // If the arguments contains GET-INSTALL-PATH, change the target name prefix from MODULES-IN- to
606 // GET-INSTALL-PATH-IN- to extract the installation path instead of building the modules.
607 targetNamePrefix := "MODULES-IN-"
608 if inList("GET-INSTALL-PATH", configArgs) {
609 targetNamePrefix = "GET-INSTALL-PATH-IN-"
610 configArgs = removeFromList("GET-INSTALL-PATH", configArgs)
611 }
612
Patrice Arruda13848222019-04-22 17:12:02 -0700613 var targets []string
614
615 switch action {
Patrice Arruda39282062019-06-20 16:35:12 -0700616 case BUILD_MODULES:
617 // No additional processing is required when building a list of specific modules or all modules.
Patrice Arruda13848222019-04-22 17:12:02 -0700618 case BUILD_MODULES_IN_A_DIRECTORY:
619 // If dir is the root source tree, all the modules are built of the source tree are built so
620 // no need to find the build file.
621 if topDir == dir {
622 break
623 }
Patrice Arruda0dcf27f2019-07-08 17:03:33 -0700624
Patrice Arruda13848222019-04-22 17:12:02 -0700625 buildFile := findBuildFile(ctx, relDir)
626 if buildFile == "" {
Patrice Arruda0dcf27f2019-07-08 17:03:33 -0700627 ctx.Fatalf("Build file not found for %s directory", relDir)
Patrice Arruda13848222019-04-22 17:12:02 -0700628 }
Patrice Arruda13848222019-04-22 17:12:02 -0700629 targets = []string{convertToTarget(filepath.Dir(buildFile), targetNamePrefix)}
630 case BUILD_MODULES_IN_DIRECTORIES:
631 newConfigArgs, dirs := splitArgs(configArgs)
632 configArgs = newConfigArgs
Dan Willemsence41e942019-07-29 23:39:30 -0700633 targets = getTargetsFromDirs(ctx, relDir, dirs, targetNamePrefix)
Patrice Arruda13848222019-04-22 17:12:02 -0700634 }
635
636 // Tidy only override all other specified targets.
637 tidyOnly := os.Getenv("WITH_TIDY_ONLY")
638 if tidyOnly == "true" || tidyOnly == "1" {
639 configArgs = append(configArgs, "tidy_only")
640 } else {
641 configArgs = append(configArgs, targets...)
642 }
643
644 return configArgs
645}
646
647// convertToTarget replaces "/" to "-" in dir and pre-append the targetNamePrefix to the target name.
648func convertToTarget(dir string, targetNamePrefix string) string {
649 return targetNamePrefix + strings.ReplaceAll(dir, "/", "-")
650}
651
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700652// hasBuildFile returns true if dir contains an Android build file.
653func hasBuildFile(ctx Context, dir string) bool {
654 for _, buildFile := range buildFiles {
655 _, err := os.Stat(filepath.Join(dir, buildFile))
656 if err == nil {
657 return true
658 }
659 if !os.IsNotExist(err) {
660 ctx.Fatalf("Error retrieving the build file stats: %v", err)
661 }
662 }
663 return false
664}
665
Patrice Arruda0dcf27f2019-07-08 17:03:33 -0700666// findBuildFile finds a build file (makefile or blueprint file) by looking if there is a build file
667// in the current and any sub directory of dir. If a build file is not found, traverse the path
668// up by one directory and repeat again until either a build file is found or reached to the root
669// source tree. The returned filename of build file is "Android.mk". If one was not found, a blank
670// string is returned.
Patrice Arruda13848222019-04-22 17:12:02 -0700671func findBuildFile(ctx Context, dir string) string {
Patrice Arruda0dcf27f2019-07-08 17:03:33 -0700672 // If the string is empty or ".", assume it is top directory of the source tree.
673 if dir == "" || dir == "." {
Patrice Arruda13848222019-04-22 17:12:02 -0700674 return ""
675 }
676
Patrice Arruda0dcf27f2019-07-08 17:03:33 -0700677 found := false
678 for buildDir := dir; buildDir != "."; buildDir = filepath.Dir(buildDir) {
679 err := filepath.Walk(buildDir, func(path string, info os.FileInfo, err error) error {
680 if err != nil {
681 return err
682 }
683 if found {
684 return filepath.SkipDir
685 }
686 if info.IsDir() {
687 return nil
688 }
689 for _, buildFile := range buildFiles {
690 if info.Name() == buildFile {
691 found = true
692 return filepath.SkipDir
693 }
694 }
695 return nil
696 })
697 if err != nil {
698 ctx.Fatalf("Error finding Android build file: %v", err)
699 }
700
701 if found {
702 return filepath.Join(buildDir, "Android.mk")
Patrice Arruda13848222019-04-22 17:12:02 -0700703 }
704 }
705
706 return ""
707}
708
709// splitArgs iterates over the arguments list and splits into two lists: arguments and directories.
710func splitArgs(args []string) (newArgs []string, dirs []string) {
711 specialArgs := map[string]bool{
712 "showcommands": true,
713 "snod": true,
714 "dist": true,
715 "checkbuild": true,
716 }
717
718 newArgs = []string{}
719 dirs = []string{}
720
721 for _, arg := range args {
722 // It's a dash argument if it starts with "-" or it's a key=value pair, it's not a directory.
723 if strings.IndexRune(arg, '-') == 0 || strings.IndexRune(arg, '=') != -1 {
724 newArgs = append(newArgs, arg)
725 continue
726 }
727
728 if _, ok := specialArgs[arg]; ok {
729 newArgs = append(newArgs, arg)
730 continue
731 }
732
733 dirs = append(dirs, arg)
734 }
735
736 return newArgs, dirs
737}
738
739// getTargetsFromDirs iterates over the dirs list and creates a list of targets to build. If a
740// directory from the dirs list does not exist, a fatal error is raised. relDir is related to the
741// source root tree where the build action command was invoked. Each directory is validated if the
742// build file can be found and follows the format "dir1:target1,target2,...". Target is optional.
Dan Willemsence41e942019-07-29 23:39:30 -0700743func getTargetsFromDirs(ctx Context, relDir string, dirs []string, targetNamePrefix string) (targets []string) {
Patrice Arruda13848222019-04-22 17:12:02 -0700744 for _, dir := range dirs {
745 // The directory may have specified specific modules to build. ":" is the separator to separate
746 // the directory and the list of modules.
747 s := strings.Split(dir, ":")
748 l := len(s)
749 if l > 2 { // more than one ":" was specified.
750 ctx.Fatalf("%s not in proper directory:target1,target2,... format (\":\" was specified more than once)", dir)
751 }
752
753 dir = filepath.Join(relDir, s[0])
754 if _, err := os.Stat(dir); err != nil {
755 ctx.Fatalf("couldn't find directory %s", dir)
756 }
757
758 // Verify that if there are any targets specified after ":". Each target is separated by ",".
759 var newTargets []string
760 if l == 2 && s[1] != "" {
761 newTargets = strings.Split(s[1], ",")
762 if inList("", newTargets) {
763 ctx.Fatalf("%s not in proper directory:target1,target2,... format", dir)
764 }
765 }
766
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700767 // If there are specified targets to build in dir, an android build file must exist for the one
768 // shot build. For the non-targets case, find the appropriate build file and build all the
769 // modules in dir (or the closest one in the dir path).
Patrice Arruda13848222019-04-22 17:12:02 -0700770 if len(newTargets) > 0 {
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700771 if !hasBuildFile(ctx, dir) {
Patrice Arruda13848222019-04-22 17:12:02 -0700772 ctx.Fatalf("Couldn't locate a build file from %s directory", dir)
773 }
774 } else {
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700775 buildFile := findBuildFile(ctx, dir)
776 if buildFile == "" {
777 ctx.Fatalf("Build file not found for %s directory", dir)
778 }
779 newTargets = []string{convertToTarget(filepath.Dir(buildFile), targetNamePrefix)}
Patrice Arruda13848222019-04-22 17:12:02 -0700780 }
781
Patrice Arruda13848222019-04-22 17:12:02 -0700782 targets = append(targets, newTargets...)
783 }
784
Dan Willemsence41e942019-07-29 23:39:30 -0700785 return targets
Patrice Arruda13848222019-04-22 17:12:02 -0700786}
787
Dan Willemsen9b587492017-07-10 22:13:00 -0700788func (c *configImpl) parseArgs(ctx Context, args []string) {
789 for i := 0; i < len(args); i++ {
790 arg := strings.TrimSpace(args[i])
Anton Hansson5a7861a2021-06-04 10:09:01 +0100791 if arg == "showcommands" {
Dan Willemsen9b587492017-07-10 22:13:00 -0700792 c.verbose = true
Lukacs T. Berkicef87b62021-08-10 15:01:13 +0200793 } else if arg == "--empty-ninja-file" {
794 c.emptyNinjaFile = true
Lukacs T. Berkid1e3f1f2021-03-16 08:55:23 +0100795 } else if arg == "--skip-ninja" {
796 c.skipNinja = true
Dan Willemsene0879fc2017-08-04 15:06:27 -0700797 } else if arg == "--skip-make" {
Colin Cross30e444b2021-06-18 11:26:19 -0700798 // TODO(ccross): deprecate this, it has confusing behaviors. It doesn't run kati,
799 // but it does run a Kati ninja file if the .kati_enabled marker file was created
800 // by a previous build.
Anton Hansson5e5c48b2020-11-27 12:35:20 +0000801 c.skipConfig = true
802 c.skipKati = true
803 } else if arg == "--skip-kati" {
Anton Hansson0b55bdb2021-06-04 10:08:08 +0100804 // TODO: remove --skip-kati once module builds have been migrated to --song-only
Anton Hansson5e5c48b2020-11-27 12:35:20 +0000805 c.skipKati = true
Anton Hansson0b55bdb2021-06-04 10:08:08 +0100806 } else if arg == "--soong-only" {
807 c.skipKati = true
808 c.skipKatiNinja = true
Lukacs T. Berkicef87b62021-08-10 15:01:13 +0200809 } else if arg == "--config-only" {
810 c.skipKati = true
811 c.skipKatiNinja = true
812 c.skipSoong = true
Colin Cross30e444b2021-06-18 11:26:19 -0700813 } else if arg == "--skip-config" {
814 c.skipConfig = true
Colin Cross00a8a3f2020-10-29 14:08:31 -0700815 } else if arg == "--skip-soong-tests" {
816 c.skipSoongTests = true
MarkDacekd0e7cd32022-12-02 22:22:40 +0000817 } else if arg == "--skip-metrics-upload" {
818 c.skipMetricsUpload = true
Chris Parsons53f68ae2022-03-03 12:01:40 -0500819 } else if arg == "--mk-metrics" {
820 c.reportMkMetrics = true
LaMont Jones52a72432023-03-09 18:19:35 +0000821 } else if arg == "--multitree-build" {
822 c.multitreeBuild = true
Chris Parsonsef615e52022-08-18 22:04:11 -0400823 } else if arg == "--bazel-mode" {
824 c.bazelProdMode = true
825 } else if arg == "--bazel-mode-dev" {
826 c.bazelDevMode = true
MarkDacekb78465d2022-10-18 20:10:16 +0000827 } else if arg == "--bazel-mode-staging" {
828 c.bazelStagingMode = true
Spandan Das394aa322022-11-03 17:02:10 +0000829 } else if arg == "--search-api-dir" {
830 c.searchApiDir = true
Jeongik Cha0cf44d52023-03-15 00:10:45 +0900831 } else if strings.HasPrefix(arg, "--ninja_weight_source=") {
832 source := strings.TrimPrefix(arg, "--ninja_weight_source=")
833 if source == "ninja_log" {
834 c.ninjaWeightListSource = NINJA_LOG
835 } else if source == "evenly_distributed" {
836 c.ninjaWeightListSource = EVENLY_DISTRIBUTED
837 } else if source == "not_used" {
838 c.ninjaWeightListSource = NOT_USED
839 } else {
840 ctx.Fatalf("unknown option for ninja_weight_source: %s", source)
841 }
Jihoon Kang1bff0342023-01-17 20:40:22 +0000842 } else if arg == "--build-from-text-stub" {
843 c.buildFromTextStub = true
MarkDacekb96561e2022-12-02 04:34:43 +0000844 } else if strings.HasPrefix(arg, "--build-command=") {
845 buildCmd := strings.TrimPrefix(arg, "--build-command=")
846 // remove quotations
847 buildCmd = strings.TrimPrefix(buildCmd, "\"")
848 buildCmd = strings.TrimSuffix(buildCmd, "\"")
849 ctx.Metrics.SetBuildCommand([]string{buildCmd})
MarkDacekd06db5d2022-11-29 00:47:59 +0000850 } else if strings.HasPrefix(arg, "--bazel-force-enabled-modules=") {
851 c.bazelForceEnabledModules = strings.TrimPrefix(arg, "--bazel-force-enabled-modules=")
MarkDacek6614d9c2022-12-07 21:57:38 +0000852 } else if strings.HasPrefix(arg, "--build-started-time-unix-millis=") {
853 buildTimeStr := strings.TrimPrefix(arg, "--build-started-time-unix-millis=")
854 val, err := strconv.ParseInt(buildTimeStr, 10, 64)
855 if err == nil {
856 c.buildStartedTime = val
857 } else {
858 ctx.Fatalf("Error parsing build-time-started-unix-millis", err)
859 }
Dan Willemsen6ac63ef2017-10-17 20:35:34 -0700860 } else if len(arg) > 0 && arg[0] == '-' {
Dan Willemsen9b587492017-07-10 22:13:00 -0700861 parseArgNum := func(def int) int {
862 if len(arg) > 2 {
863 p, err := strconv.ParseUint(arg[2:], 10, 31)
864 if err != nil {
865 ctx.Fatalf("Failed to parse %q: %v", arg, err)
866 }
867 return int(p)
868 } else if i+1 < len(args) {
869 p, err := strconv.ParseUint(args[i+1], 10, 31)
870 if err == nil {
871 i++
872 return int(p)
873 }
874 }
875 return def
876 }
877
Dan Willemsen6ac63ef2017-10-17 20:35:34 -0700878 if len(arg) > 1 && arg[1] == 'j' {
Dan Willemsen9b587492017-07-10 22:13:00 -0700879 c.parallel = parseArgNum(c.parallel)
Dan Willemsen6ac63ef2017-10-17 20:35:34 -0700880 } else if len(arg) > 1 && arg[1] == 'k' {
Dan Willemsen9b587492017-07-10 22:13:00 -0700881 c.keepGoing = parseArgNum(0)
Dan Willemsen1e704462016-08-21 15:17:17 -0700882 } else {
883 ctx.Fatalln("Unknown option:", arg)
884 }
Dan Willemsen091525e2017-07-11 14:17:50 -0700885 } else if k, v, ok := decodeKeyValue(arg); ok && len(k) > 0 {
Dan Willemsen6dfe30a2018-09-10 12:41:10 -0700886 if k == "OUT_DIR" {
887 ctx.Fatalln("OUT_DIR may only be set in the environment, not as a command line option.")
888 }
Dan Willemsen091525e2017-07-11 14:17:50 -0700889 c.environ.Set(k, v)
Dan Willemsen2d31a442018-10-20 21:33:41 -0700890 } else if arg == "dist" {
891 c.dist = true
Lukacs T. Berkia1b93722021-09-02 17:23:06 +0200892 } else if arg == "json-module-graph" {
893 c.jsonModuleGraph = true
894 } else if arg == "bp2build" {
895 c.bp2build = true
Spandan Das5af0bd32022-09-28 20:43:08 +0000896 } else if arg == "api_bp2build" {
897 c.apiBp2build = true
Lukacs T. Berki3a821692021-09-06 17:08:02 +0200898 } else if arg == "queryview" {
899 c.queryview = true
Lukacs T. Berkic6012f32021-09-06 18:31:46 +0200900 } else if arg == "soong_docs" {
901 c.soongDocs = true
Dan Willemsen1e704462016-08-21 15:17:17 -0700902 } else {
Dan Willemsen2d31a442018-10-20 21:33:41 -0700903 if arg == "checkbuild" {
Colin Cross37193492017-11-16 17:55:00 -0800904 c.checkbuild = true
Dan Willemsene0879fc2017-08-04 15:06:27 -0700905 }
Dan Willemsen9b587492017-07-10 22:13:00 -0700906 c.arguments = append(c.arguments, arg)
Dan Willemsen1e704462016-08-21 15:17:17 -0700907 }
908 }
Chris Parsonsb6e96902022-10-31 20:08:45 -0400909 if (!c.bazelProdMode) && (!c.bazelDevMode) && (!c.bazelStagingMode) {
910 c.bazelProdMode = defaultBazelProdMode(c)
911 }
Dan Willemsen1e704462016-08-21 15:17:17 -0700912}
913
Dan Willemsened869522018-01-08 14:58:46 -0800914func (c *configImpl) configureLocale(ctx Context) {
915 cmd := Command(ctx, Config{c}, "locale", "locale", "-a")
916 output, err := cmd.Output()
917
918 var locales []string
919 if err == nil {
920 locales = strings.Split(string(output), "\n")
921 } else {
922 // If we're unable to list the locales, let's assume en_US.UTF-8
923 locales = []string{"en_US.UTF-8"}
924 ctx.Verbosef("Failed to list locales (%q), falling back to %q", err, locales)
925 }
926
927 // gettext uses LANGUAGE, which is passed directly through
928
929 // For LANG and LC_*, only preserve the evaluated version of
930 // LC_MESSAGES
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800931 userLang := ""
Dan Willemsened869522018-01-08 14:58:46 -0800932 if lc_all, ok := c.environ.Get("LC_ALL"); ok {
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800933 userLang = lc_all
Dan Willemsened869522018-01-08 14:58:46 -0800934 } else if lc_messages, ok := c.environ.Get("LC_MESSAGES"); ok {
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800935 userLang = lc_messages
Dan Willemsened869522018-01-08 14:58:46 -0800936 } else if lang, ok := c.environ.Get("LANG"); ok {
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800937 userLang = lang
Dan Willemsened869522018-01-08 14:58:46 -0800938 }
939
940 c.environ.UnsetWithPrefix("LC_")
941
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800942 if userLang != "" {
943 c.environ.Set("LC_MESSAGES", userLang)
Dan Willemsened869522018-01-08 14:58:46 -0800944 }
945
946 // The for LANG, use C.UTF-8 if it exists (Debian currently, proposed
947 // for others)
948 if inList("C.UTF-8", locales) {
949 c.environ.Set("LANG", "C.UTF-8")
Aaron Klingd236e0e2018-08-07 19:21:36 -0500950 } else if inList("C.utf8", locales) {
951 // These normalize to the same thing
952 c.environ.Set("LANG", "C.UTF-8")
Dan Willemsened869522018-01-08 14:58:46 -0800953 } else if inList("en_US.UTF-8", locales) {
954 c.environ.Set("LANG", "en_US.UTF-8")
955 } else if inList("en_US.utf8", locales) {
956 // These normalize to the same thing
957 c.environ.Set("LANG", "en_US.UTF-8")
958 } else {
959 ctx.Fatalln("System doesn't support either C.UTF-8 or en_US.UTF-8")
960 }
961}
962
Dan Willemsen1e704462016-08-21 15:17:17 -0700963func (c *configImpl) Environment() *Environment {
964 return c.environ
965}
966
967func (c *configImpl) Arguments() []string {
968 return c.arguments
969}
970
Lukacs T. Berkia1b93722021-09-02 17:23:06 +0200971func (c *configImpl) SoongBuildInvocationNeeded() bool {
Lukacs T. Berkia1b93722021-09-02 17:23:06 +0200972 if len(c.Arguments()) > 0 {
973 // Explicit targets requested that are not special targets like b2pbuild
974 // or the JSON module graph
975 return true
976 }
977
Spandan Das5af0bd32022-09-28 20:43:08 +0000978 if !c.JsonModuleGraph() && !c.Bp2Build() && !c.Queryview() && !c.SoongDocs() && !c.ApiBp2build() {
Lukacs T. Berkia1b93722021-09-02 17:23:06 +0200979 // Command line was empty, the default Ninja target is built
980 return true
981 }
982
Liz Kammer88677422021-12-15 15:03:19 -0500983 // bp2build + dist may be used to dist bp2build logs but does not require SoongBuildInvocation
984 if c.Dist() && !c.Bp2Build() {
985 return true
986 }
987
Lukacs T. Berkia1b93722021-09-02 17:23:06 +0200988 // build.ninja doesn't need to be generated
989 return false
990}
991
Dan Willemsen1e704462016-08-21 15:17:17 -0700992func (c *configImpl) OutDir() string {
993 if outDir, ok := c.environ.Get("OUT_DIR"); ok {
Patrice Arruda19bd53e2019-07-08 17:26:47 -0700994 return outDir
Dan Willemsen1e704462016-08-21 15:17:17 -0700995 }
996 return "out"
997}
998
Dan Willemsen8a073a82017-02-04 17:30:44 -0800999func (c *configImpl) DistDir() string {
Chris Parsons19ab9a42022-08-30 13:15:04 -04001000 return c.distDir
Rupert Shuttleworth3c9f5ac2020-12-10 11:32:38 +00001001}
1002
1003func (c *configImpl) RealDistDir() string {
Dan Willemsen2d31a442018-10-20 21:33:41 -07001004 return c.distDir
Dan Willemsen8a073a82017-02-04 17:30:44 -08001005}
1006
Dan Willemsen1e704462016-08-21 15:17:17 -07001007func (c *configImpl) NinjaArgs() []string {
Anton Hansson5e5c48b2020-11-27 12:35:20 +00001008 if c.skipKati {
Dan Willemsene0879fc2017-08-04 15:06:27 -07001009 return c.arguments
1010 }
Dan Willemsen1e704462016-08-21 15:17:17 -07001011 return c.ninjaArgs
1012}
1013
Jingwen Chen7c6089a2020-11-02 02:56:20 -05001014func (c *configImpl) BazelOutDir() string {
1015 return filepath.Join(c.OutDir(), "bazel")
1016}
1017
Liz Kammer2af5ea82022-11-11 14:21:03 -05001018func (c *configImpl) bazelOutputBase() string {
1019 return filepath.Join(c.BazelOutDir(), "output")
1020}
1021
Dan Willemsen1e704462016-08-21 15:17:17 -07001022func (c *configImpl) SoongOutDir() string {
1023 return filepath.Join(c.OutDir(), "soong")
1024}
1025
Spandan Das394aa322022-11-03 17:02:10 +00001026func (c *configImpl) ApiSurfacesOutDir() string {
1027 return filepath.Join(c.OutDir(), "api_surfaces")
1028}
1029
Lukacs T. Berkia806e412021-09-01 08:57:48 +02001030func (c *configImpl) PrebuiltOS() string {
1031 switch runtime.GOOS {
1032 case "linux":
1033 return "linux-x86"
1034 case "darwin":
1035 return "darwin-x86"
1036 default:
1037 panic("Unknown GOOS")
1038 }
1039}
Lukacs T. Berki90b43342021-11-02 14:42:04 +01001040
Lukacs T. Berkia806e412021-09-01 08:57:48 +02001041func (c *configImpl) HostToolDir() string {
Colin Crossacfcc1f2021-10-25 15:40:32 -07001042 if c.SkipKatiNinja() {
1043 return filepath.Join(c.SoongOutDir(), "host", c.PrebuiltOS(), "bin")
1044 } else {
1045 return filepath.Join(c.OutDir(), "host", c.PrebuiltOS(), "bin")
1046 }
Lukacs T. Berkia806e412021-09-01 08:57:48 +02001047}
1048
Lukacs T. Berki89fcdcb2021-09-07 09:10:33 +02001049func (c *configImpl) NamedGlobFile(name string) string {
Lukacs T. Berki90b43342021-11-02 14:42:04 +01001050 return shared.JoinPath(c.SoongOutDir(), "globs-"+name+".ninja")
Lukacs T. Berki89fcdcb2021-09-07 09:10:33 +02001051}
1052
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +02001053func (c *configImpl) UsedEnvFile(tag string) string {
1054 return shared.JoinPath(c.SoongOutDir(), usedEnvFile+"."+tag)
1055}
1056
Lukacs T. Berkic541cd22022-10-26 07:26:50 +00001057func (c *configImpl) Bp2BuildFilesMarkerFile() string {
1058 return shared.JoinPath(c.SoongOutDir(), "bp2build_files_marker")
1059}
1060
1061func (c *configImpl) Bp2BuildWorkspaceMarkerFile() string {
Lukacs T. Berki90b43342021-11-02 14:42:04 +01001062 return shared.JoinPath(c.SoongOutDir(), "bp2build_workspace_marker")
Lukacs T. Berki56ebaf32021-08-12 14:03:55 +02001063}
1064
Lukacs T. Berkic6012f32021-09-06 18:31:46 +02001065func (c *configImpl) SoongDocsHtml() string {
1066 return shared.JoinPath(c.SoongOutDir(), "docs/soong_build.html")
1067}
1068
Lukacs T. Berki3a821692021-09-06 17:08:02 +02001069func (c *configImpl) QueryviewMarkerFile() string {
1070 return shared.JoinPath(c.SoongOutDir(), "queryview.marker")
1071}
1072
Spandan Das5af0bd32022-09-28 20:43:08 +00001073func (c *configImpl) ApiBp2buildMarkerFile() string {
1074 return shared.JoinPath(c.SoongOutDir(), "api_bp2build.marker")
1075}
1076
Lukacs T. Berkie571dc32021-08-25 14:14:13 +02001077func (c *configImpl) ModuleGraphFile() string {
1078 return shared.JoinPath(c.SoongOutDir(), "module-graph.json")
1079}
1080
kgui67007242022-01-25 13:50:25 +08001081func (c *configImpl) ModuleActionsFile() string {
1082 return shared.JoinPath(c.SoongOutDir(), "module-actions.json")
1083}
1084
Jeff Gastonefc1b412017-03-29 17:29:06 -07001085func (c *configImpl) TempDir() string {
1086 return shared.TempDirForOutDir(c.SoongOutDir())
1087}
1088
Jeff Gastonb64fc1c2017-08-04 12:30:12 -07001089func (c *configImpl) FileListDir() string {
1090 return filepath.Join(c.OutDir(), ".module_paths")
1091}
1092
Dan Willemsen1e704462016-08-21 15:17:17 -07001093func (c *configImpl) KatiSuffix() string {
1094 if c.katiSuffix != "" {
1095 return c.katiSuffix
1096 }
1097 panic("SetKatiSuffix has not been called")
1098}
1099
Colin Cross37193492017-11-16 17:55:00 -08001100// Checkbuild returns true if "checkbuild" was one of the build goals, which means that the
1101// user is interested in additional checks at the expense of build time.
1102func (c *configImpl) Checkbuild() bool {
1103 return c.checkbuild
1104}
1105
Dan Willemsen8a073a82017-02-04 17:30:44 -08001106func (c *configImpl) Dist() bool {
1107 return c.dist
1108}
1109
Lukacs T. Berkia1b93722021-09-02 17:23:06 +02001110func (c *configImpl) JsonModuleGraph() bool {
1111 return c.jsonModuleGraph
1112}
1113
1114func (c *configImpl) Bp2Build() bool {
1115 return c.bp2build
1116}
1117
Spandan Das5af0bd32022-09-28 20:43:08 +00001118func (c *configImpl) ApiBp2build() bool {
1119 return c.apiBp2build
1120}
1121
Lukacs T. Berki3a821692021-09-06 17:08:02 +02001122func (c *configImpl) Queryview() bool {
1123 return c.queryview
1124}
1125
Lukacs T. Berkic6012f32021-09-06 18:31:46 +02001126func (c *configImpl) SoongDocs() bool {
1127 return c.soongDocs
1128}
1129
Dan Willemsen1e704462016-08-21 15:17:17 -07001130func (c *configImpl) IsVerbose() bool {
1131 return c.verbose
1132}
1133
LaMont Jones52a72432023-03-09 18:19:35 +00001134func (c *configImpl) MultitreeBuild() bool {
1135 return c.multitreeBuild
1136}
1137
Jeongik Cha0cf44d52023-03-15 00:10:45 +09001138func (c *configImpl) NinjaWeightListSource() NinjaWeightListSource {
1139 return c.ninjaWeightListSource
1140}
1141
Anton Hansson5e5c48b2020-11-27 12:35:20 +00001142func (c *configImpl) SkipKati() bool {
1143 return c.skipKati
1144}
1145
Anton Hansson0b55bdb2021-06-04 10:08:08 +01001146func (c *configImpl) SkipKatiNinja() bool {
1147 return c.skipKatiNinja
1148}
1149
Lukacs T. Berkicef87b62021-08-10 15:01:13 +02001150func (c *configImpl) SkipSoong() bool {
1151 return c.skipSoong
1152}
1153
Lukacs T. Berkid1e3f1f2021-03-16 08:55:23 +01001154func (c *configImpl) SkipNinja() bool {
1155 return c.skipNinja
1156}
1157
Anton Hansson5a7861a2021-06-04 10:09:01 +01001158func (c *configImpl) SetSkipNinja(v bool) {
1159 c.skipNinja = v
1160}
1161
Anton Hansson5e5c48b2020-11-27 12:35:20 +00001162func (c *configImpl) SkipConfig() bool {
1163 return c.skipConfig
Dan Willemsene0879fc2017-08-04 15:06:27 -07001164}
1165
Jihoon Kang1bff0342023-01-17 20:40:22 +00001166func (c *configImpl) BuildFromTextStub() bool {
1167 return c.buildFromTextStub
1168}
1169
Dan Willemsen1e704462016-08-21 15:17:17 -07001170func (c *configImpl) TargetProduct() string {
1171 if v, ok := c.environ.Get("TARGET_PRODUCT"); ok {
1172 return v
1173 }
1174 panic("TARGET_PRODUCT is not defined")
1175}
1176
Dan Willemsen02781d52017-05-12 19:28:13 -07001177func (c *configImpl) TargetDevice() string {
1178 return c.targetDevice
1179}
1180
1181func (c *configImpl) SetTargetDevice(device string) {
1182 c.targetDevice = device
1183}
1184
1185func (c *configImpl) TargetBuildVariant() string {
1186 if v, ok := c.environ.Get("TARGET_BUILD_VARIANT"); ok {
1187 return v
1188 }
1189 panic("TARGET_BUILD_VARIANT is not defined")
1190}
1191
Dan Willemsen1e704462016-08-21 15:17:17 -07001192func (c *configImpl) KatiArgs() []string {
1193 return c.katiArgs
1194}
1195
1196func (c *configImpl) Parallel() int {
1197 return c.parallel
1198}
1199
Spandan Dasc5763832022-11-08 18:42:16 +00001200func (c *configImpl) GetIncludeTags() []string {
1201 return c.includeTags
1202}
1203
1204func (c *configImpl) SetIncludeTags(i []string) {
1205 c.includeTags = i
1206}
1207
MarkDacek6614d9c2022-12-07 21:57:38 +00001208func (c *configImpl) GetLogsPrefix() string {
1209 return c.logsPrefix
1210}
1211
1212func (c *configImpl) SetLogsPrefix(prefix string) {
1213 c.logsPrefix = prefix
1214}
1215
Colin Cross8b8bec32019-11-15 13:18:43 -08001216func (c *configImpl) HighmemParallel() int {
1217 if i, ok := c.environ.GetInt("NINJA_HIGHMEM_NUM_JOBS"); ok {
1218 return i
1219 }
1220
1221 const minMemPerHighmemProcess = 8 * 1024 * 1024 * 1024
1222 parallel := c.Parallel()
1223 if c.UseRemoteBuild() {
1224 // Ninja doesn't support nested pools, and when remote builds are enabled the total ninja parallelism
1225 // is set very high (i.e. 500). Using a large value here would cause the total number of running jobs
1226 // to be the sum of the sizes of the local and highmem pools, which will cause extra CPU contention.
1227 // Return 1/16th of the size of the local pool, rounding up.
1228 return (parallel + 15) / 16
1229 } else if c.totalRAM == 0 {
1230 // Couldn't detect the total RAM, don't restrict highmem processes.
1231 return parallel
Dan Willemsen570a2922020-05-26 23:02:29 -07001232 } else if c.totalRAM <= 16*1024*1024*1024 {
1233 // Less than 16GB of ram, restrict to 1 highmem processes
1234 return 1
Colin Cross8b8bec32019-11-15 13:18:43 -08001235 } else if c.totalRAM <= 32*1024*1024*1024 {
1236 // Less than 32GB of ram, restrict to 2 highmem processes
1237 return 2
1238 } else if p := int(c.totalRAM / minMemPerHighmemProcess); p < parallel {
1239 // If less than 8GB total RAM per process, reduce the number of highmem processes
1240 return p
1241 }
1242 // No restriction on highmem processes
1243 return parallel
1244}
1245
Dan Willemsen2bb82d02019-12-27 09:35:42 -08001246func (c *configImpl) TotalRAM() uint64 {
1247 return c.totalRAM
1248}
1249
Kousik Kumarec478642020-09-21 13:39:24 -04001250// ForceUseGoma determines whether we should override Goma deprecation
1251// and use Goma for the current build or not.
1252func (c *configImpl) ForceUseGoma() bool {
1253 if v, ok := c.environ.Get("FORCE_USE_GOMA"); ok {
1254 v = strings.TrimSpace(v)
1255 if v != "" && v != "false" {
1256 return true
1257 }
1258 }
1259 return false
1260}
1261
Dan Willemsen1e704462016-08-21 15:17:17 -07001262func (c *configImpl) UseGoma() bool {
1263 if v, ok := c.environ.Get("USE_GOMA"); ok {
1264 v = strings.TrimSpace(v)
1265 if v != "" && v != "false" {
1266 return true
1267 }
1268 }
1269 return false
1270}
1271
Yoshisato Yanagisawa2cb0e5d2019-01-10 10:14:16 +09001272func (c *configImpl) StartGoma() bool {
1273 if !c.UseGoma() {
1274 return false
1275 }
1276
1277 if v, ok := c.environ.Get("NOSTART_GOMA"); ok {
1278 v = strings.TrimSpace(v)
1279 if v != "" && v != "false" {
1280 return false
1281 }
1282 }
1283 return true
1284}
1285
Ramy Medhatbbf25672019-07-17 12:30:04 +00001286func (c *configImpl) UseRBE() bool {
Kousik Kumar3ff037e2022-01-25 22:11:01 -05001287 if v, ok := c.Environment().Get("USE_RBE"); ok {
Ramy Medhatbbf25672019-07-17 12:30:04 +00001288 v = strings.TrimSpace(v)
1289 if v != "" && v != "false" {
1290 return true
1291 }
1292 }
1293 return false
1294}
1295
Chris Parsonsef615e52022-08-18 22:04:11 -04001296func (c *configImpl) BazelBuildEnabled() bool {
MarkDacekb78465d2022-10-18 20:10:16 +00001297 return c.bazelProdMode || c.bazelDevMode || c.bazelStagingMode
Chris Parsonsec1a3dc2021-04-20 15:32:07 -04001298}
1299
Ramy Medhatbbf25672019-07-17 12:30:04 +00001300func (c *configImpl) StartRBE() bool {
1301 if !c.UseRBE() {
1302 return false
1303 }
1304
1305 if v, ok := c.environ.Get("NOSTART_RBE"); ok {
1306 v = strings.TrimSpace(v)
1307 if v != "" && v != "false" {
1308 return false
1309 }
1310 }
1311 return true
1312}
1313
Kousik Kumar4c180ad2022-05-27 07:48:37 -04001314func (c *configImpl) rbeProxyLogsDir() string {
1315 for _, f := range []string{"RBE_proxy_log_dir", "FLAG_output_dir"} {
Kousik Kumar0d15a722020-09-23 02:54:11 -04001316 if v, ok := c.environ.Get(f); ok {
1317 return v
1318 }
1319 }
Kousik Kumar4c180ad2022-05-27 07:48:37 -04001320 buildTmpDir := shared.TempDirForOutDir(c.SoongOutDir())
1321 return filepath.Join(buildTmpDir, "rbe")
Ramy Medhat0fc67eb2020-08-12 01:26:23 -04001322}
1323
Kousik Kumar4c180ad2022-05-27 07:48:37 -04001324func (c *configImpl) shouldCleanupRBELogsDir() bool {
1325 // Perform a log directory cleanup only when the log directory
1326 // is auto created by the build rather than user-specified.
1327 for _, f := range []string{"RBE_proxy_log_dir", "FLAG_output_dir"} {
1328 if _, ok := c.environ.Get(f); ok {
1329 return false
Patrice Arruda62f1bf22020-07-07 12:48:26 +00001330 }
1331 }
Kousik Kumar4c180ad2022-05-27 07:48:37 -04001332 return true
Ramy Medhat0fc67eb2020-08-12 01:26:23 -04001333}
1334
1335func (c *configImpl) rbeExecRoot() string {
1336 for _, f := range []string{"RBE_exec_root", "FLAG_exec_root"} {
1337 if v, ok := c.environ.Get(f); ok {
1338 return v
1339 }
1340 }
1341 wd, err := os.Getwd()
1342 if err != nil {
1343 return ""
1344 }
1345 return wd
1346}
1347
1348func (c *configImpl) rbeDir() string {
1349 if v, ok := c.environ.Get("RBE_DIR"); ok {
1350 return v
1351 }
1352 return "prebuilts/remoteexecution-client/live/"
1353}
1354
1355func (c *configImpl) rbeReproxy() string {
1356 for _, f := range []string{"RBE_re_proxy", "FLAG_re_proxy"} {
1357 if v, ok := c.environ.Get(f); ok {
1358 return v
1359 }
1360 }
1361 return filepath.Join(c.rbeDir(), "reproxy")
1362}
1363
1364func (c *configImpl) rbeAuth() (string, string) {
Kousik Kumar93d192c2022-03-18 01:39:56 -04001365 credFlags := []string{
1366 "use_application_default_credentials",
1367 "use_gce_credentials",
1368 "credential_file",
1369 "use_google_prod_creds",
1370 }
Ramy Medhat0fc67eb2020-08-12 01:26:23 -04001371 for _, cf := range credFlags {
1372 for _, f := range []string{"RBE_" + cf, "FLAG_" + cf} {
1373 if v, ok := c.environ.Get(f); ok {
1374 v = strings.TrimSpace(v)
1375 if v != "" && v != "false" && v != "0" {
1376 return "RBE_" + cf, v
1377 }
1378 }
1379 }
1380 }
1381 return "RBE_use_application_default_credentials", "true"
Patrice Arruda62f1bf22020-07-07 12:48:26 +00001382}
1383
Kousik Kumar4c180ad2022-05-27 07:48:37 -04001384func (c *configImpl) rbeSockAddr(dir string) (string, error) {
1385 maxNameLen := len(syscall.RawSockaddrUnix{}.Path)
1386 base := fmt.Sprintf("reproxy_%v.sock", rbeRandPrefix)
1387
1388 name := filepath.Join(dir, base)
1389 if len(name) < maxNameLen {
1390 return name, nil
1391 }
1392
1393 name = filepath.Join("/tmp", base)
1394 if len(name) < maxNameLen {
1395 return name, nil
1396 }
1397
1398 return "", fmt.Errorf("cannot generate a proxy socket address shorter than the limit of %v", maxNameLen)
1399}
1400
Kousik Kumar7bc78192022-04-27 14:52:56 -04001401// IsGooglerEnvironment returns true if the current build is running
1402// on a Google developer machine and false otherwise.
1403func (c *configImpl) IsGooglerEnvironment() bool {
1404 cf := "ANDROID_BUILD_ENVIRONMENT_CONFIG"
1405 if v, ok := c.environ.Get(cf); ok {
1406 return v == "googler"
1407 }
1408 return false
1409}
1410
1411// GoogleProdCredsExist determine whether credentials exist on the
1412// Googler machine to use remote execution.
1413func (c *configImpl) GoogleProdCredsExist() bool {
Kevin Dagostino096ab2f2023-03-03 19:47:17 +00001414 if googleProdCredsExistCache {
1415 return googleProdCredsExistCache
1416 }
Kousik Kumar7bc78192022-04-27 14:52:56 -04001417 if _, err := exec.Command("/usr/bin/prodcertstatus", "--simple_output", "--nocheck_loas").Output(); err != nil {
1418 return false
1419 }
Kevin Dagostino096ab2f2023-03-03 19:47:17 +00001420 googleProdCredsExistCache = true
Kousik Kumar7bc78192022-04-27 14:52:56 -04001421 return true
1422}
1423
1424// UseRemoteBuild indicates whether to use a remote build acceleration system
1425// to speed up the build.
Colin Cross9016b912019-11-11 14:57:42 -08001426func (c *configImpl) UseRemoteBuild() bool {
1427 return c.UseGoma() || c.UseRBE()
1428}
1429
Kousik Kumar7bc78192022-04-27 14:52:56 -04001430// StubbyExists checks whether the stubby binary exists on the machine running
1431// the build.
1432func (c *configImpl) StubbyExists() bool {
1433 if _, err := exec.LookPath("stubby"); err != nil {
1434 return false
1435 }
1436 return true
1437}
1438
Dan Willemsen1e704462016-08-21 15:17:17 -07001439// RemoteParallel controls how many remote jobs (i.e., commands which contain
Jeff Gastonefc1b412017-03-29 17:29:06 -07001440// gomacc) are run in parallel. Note the parallelism of all other jobs is
Dan Willemsen1e704462016-08-21 15:17:17 -07001441// still limited by Parallel()
1442func (c *configImpl) RemoteParallel() int {
Colin Cross8b8bec32019-11-15 13:18:43 -08001443 if !c.UseRemoteBuild() {
1444 return 0
1445 }
1446 if i, ok := c.environ.GetInt("NINJA_REMOTE_NUM_JOBS"); ok {
1447 return i
Dan Willemsen1e704462016-08-21 15:17:17 -07001448 }
1449 return 500
1450}
1451
1452func (c *configImpl) SetKatiArgs(args []string) {
1453 c.katiArgs = args
1454}
1455
1456func (c *configImpl) SetNinjaArgs(args []string) {
1457 c.ninjaArgs = args
1458}
1459
1460func (c *configImpl) SetKatiSuffix(suffix string) {
1461 c.katiSuffix = suffix
1462}
1463
Dan Willemsene0879fc2017-08-04 15:06:27 -07001464func (c *configImpl) LastKatiSuffixFile() string {
1465 return filepath.Join(c.OutDir(), "last_kati_suffix")
1466}
1467
1468func (c *configImpl) HasKatiSuffix() bool {
1469 return c.katiSuffix != ""
1470}
1471
Dan Willemsen1e704462016-08-21 15:17:17 -07001472func (c *configImpl) KatiEnvFile() string {
1473 return filepath.Join(c.OutDir(), "env"+c.KatiSuffix()+".sh")
1474}
1475
Dan Willemsen29971232018-09-26 14:58:30 -07001476func (c *configImpl) KatiBuildNinjaFile() string {
1477 return filepath.Join(c.OutDir(), "build"+c.KatiSuffix()+katiBuildSuffix+".ninja")
Dan Willemsen1e704462016-08-21 15:17:17 -07001478}
1479
Dan Willemsenfb1271a2018-09-26 15:00:42 -07001480func (c *configImpl) KatiPackageNinjaFile() string {
1481 return filepath.Join(c.OutDir(), "build"+c.KatiSuffix()+katiPackageSuffix+".ninja")
1482}
1483
Jihoon Kang9f4f8a32022-08-16 00:57:30 +00001484func (c *configImpl) SoongVarsFile() string {
1485 return filepath.Join(c.SoongOutDir(), "soong.variables")
1486}
1487
Dan Willemsen1e704462016-08-21 15:17:17 -07001488func (c *configImpl) SoongNinjaFile() string {
1489 return filepath.Join(c.SoongOutDir(), "build.ninja")
1490}
1491
1492func (c *configImpl) CombinedNinjaFile() string {
Dan Willemsene0879fc2017-08-04 15:06:27 -07001493 if c.katiSuffix == "" {
1494 return filepath.Join(c.OutDir(), "combined.ninja")
1495 }
Dan Willemsen1e704462016-08-21 15:17:17 -07001496 return filepath.Join(c.OutDir(), "combined"+c.KatiSuffix()+".ninja")
1497}
1498
1499func (c *configImpl) SoongAndroidMk() string {
1500 return filepath.Join(c.SoongOutDir(), "Android-"+c.TargetProduct()+".mk")
1501}
1502
1503func (c *configImpl) SoongMakeVarsMk() string {
1504 return filepath.Join(c.SoongOutDir(), "make_vars-"+c.TargetProduct()+".mk")
1505}
1506
Dan Willemsenf052f782017-05-18 15:29:04 -07001507func (c *configImpl) ProductOut() string {
Dan Willemsen4dc4e142017-09-08 14:35:43 -07001508 return filepath.Join(c.OutDir(), "target", "product", c.TargetDevice())
Dan Willemsenf052f782017-05-18 15:29:04 -07001509}
1510
Dan Willemsen02781d52017-05-12 19:28:13 -07001511func (c *configImpl) DevicePreviousProductConfig() string {
Dan Willemsenf052f782017-05-18 15:29:04 -07001512 return filepath.Join(c.ProductOut(), "previous_build_config.mk")
1513}
1514
Dan Willemsenfb1271a2018-09-26 15:00:42 -07001515func (c *configImpl) KatiPackageMkDir() string {
1516 return filepath.Join(c.ProductOut(), "obj", "CONFIG", "kati_packaging")
1517}
1518
Dan Willemsenf052f782017-05-18 15:29:04 -07001519func (c *configImpl) hostOutRoot() string {
Dan Willemsen4dc4e142017-09-08 14:35:43 -07001520 return filepath.Join(c.OutDir(), "host")
Dan Willemsenf052f782017-05-18 15:29:04 -07001521}
1522
1523func (c *configImpl) HostOut() string {
1524 return filepath.Join(c.hostOutRoot(), c.HostPrebuiltTag())
1525}
1526
1527// This probably needs to be multi-valued, so not exporting it for now
1528func (c *configImpl) hostCrossOut() string {
1529 if runtime.GOOS == "linux" {
1530 return filepath.Join(c.hostOutRoot(), "windows-x86")
1531 } else {
1532 return ""
1533 }
Dan Willemsen02781d52017-05-12 19:28:13 -07001534}
1535
Dan Willemsen1e704462016-08-21 15:17:17 -07001536func (c *configImpl) HostPrebuiltTag() string {
1537 if runtime.GOOS == "linux" {
1538 return "linux-x86"
1539 } else if runtime.GOOS == "darwin" {
1540 return "darwin-x86"
1541 } else {
1542 panic("Unsupported OS")
1543 }
1544}
Dan Willemsenf173d592017-04-27 14:28:00 -07001545
Dan Willemsen8122bd52017-10-12 20:20:41 -07001546func (c *configImpl) PrebuiltBuildTool(name string) string {
Dan Willemsenf173d592017-04-27 14:28:00 -07001547 if v, ok := c.environ.Get("SANITIZE_HOST"); ok {
1548 if sanitize := strings.Fields(v); inList("address", sanitize) {
Dan Willemsen8122bd52017-10-12 20:20:41 -07001549 asan := filepath.Join("prebuilts/build-tools", c.HostPrebuiltTag(), "asan/bin", name)
1550 if _, err := os.Stat(asan); err == nil {
1551 return asan
1552 }
Dan Willemsenf173d592017-04-27 14:28:00 -07001553 }
1554 }
1555 return filepath.Join("prebuilts/build-tools", c.HostPrebuiltTag(), "bin", name)
1556}
Dan Willemsen3d60b112018-04-04 22:25:56 -07001557
1558func (c *configImpl) SetBuildBrokenDupRules(val bool) {
1559 c.brokenDupRules = val
1560}
1561
1562func (c *configImpl) BuildBrokenDupRules() bool {
1563 return c.brokenDupRules
1564}
Dan Willemsen6ab79db2018-05-02 00:06:28 -07001565
Dan Willemsen25e6f092019-04-09 10:22:43 -07001566func (c *configImpl) SetBuildBrokenUsesNetwork(val bool) {
1567 c.brokenUsesNetwork = val
1568}
1569
1570func (c *configImpl) BuildBrokenUsesNetwork() bool {
1571 return c.brokenUsesNetwork
1572}
1573
Dan Willemsene3336352020-01-02 19:10:38 -08001574func (c *configImpl) SetBuildBrokenNinjaUsesEnvVars(val []string) {
1575 c.brokenNinjaEnvVars = val
1576}
1577
1578func (c *configImpl) BuildBrokenNinjaUsesEnvVars() []string {
1579 return c.brokenNinjaEnvVars
1580}
1581
Dan Willemsen6ab79db2018-05-02 00:06:28 -07001582func (c *configImpl) SetTargetDeviceDir(dir string) {
1583 c.targetDeviceDir = dir
1584}
1585
1586func (c *configImpl) TargetDeviceDir() string {
1587 return c.targetDeviceDir
1588}
Dan Willemsenfa42f3c2018-06-15 21:54:47 -07001589
Patrice Arruda219eef32020-06-01 17:29:30 +00001590func (c *configImpl) BuildDateTime() string {
1591 return c.buildDateTime
1592}
1593
1594func (c *configImpl) MetricsUploaderApp() string {
Yu Liu6e13b402021-07-27 14:29:06 -07001595 return c.metricsUploader
Patrice Arruda219eef32020-06-01 17:29:30 +00001596}
Patrice Arruda83842d72020-12-08 19:42:08 +00001597
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux947fdbf2021-11-10 09:55:20 -05001598// LogsDir returns the absolute path to the logs directory where build log and
1599// metrics files are located. By default, the logs directory is the out
Patrice Arruda83842d72020-12-08 19:42:08 +00001600// directory. If the argument dist is specified, the logs directory
1601// is <dist_dir>/logs.
1602func (c *configImpl) LogsDir() string {
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux947fdbf2021-11-10 09:55:20 -05001603 dir := c.OutDir()
Patrice Arruda83842d72020-12-08 19:42:08 +00001604 if c.Dist() {
Rupert Shuttleworth3c9f5ac2020-12-10 11:32:38 +00001605 // Always write logs to the real dist dir, even if Bazel is using a rigged dist dir for other files
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux947fdbf2021-11-10 09:55:20 -05001606 dir = filepath.Join(c.RealDistDir(), "logs")
Patrice Arruda83842d72020-12-08 19:42:08 +00001607 }
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux947fdbf2021-11-10 09:55:20 -05001608 absDir, err := filepath.Abs(dir)
1609 if err != nil {
1610 fmt.Fprintf(os.Stderr, "\nError making log dir '%s' absolute: %s\n", dir, err.Error())
1611 os.Exit(1)
1612 }
1613 return absDir
Patrice Arruda83842d72020-12-08 19:42:08 +00001614}
1615
1616// BazelMetricsDir returns the <logs dir>/bazel_metrics directory
1617// where the bazel profiles are located.
1618func (c *configImpl) BazelMetricsDir() string {
1619 return filepath.Join(c.LogsDir(), "bazel_metrics")
1620}
Colin Crossf3bdbcb2021-06-01 11:43:55 -07001621
Chris Parsons53f68ae2022-03-03 12:01:40 -05001622// MkFileMetrics returns the file path for make-related metrics.
1623func (c *configImpl) MkMetrics() string {
1624 return filepath.Join(c.LogsDir(), "mk_metrics.pb")
1625}
1626
Colin Crossf3bdbcb2021-06-01 11:43:55 -07001627func (c *configImpl) SetEmptyNinjaFile(v bool) {
1628 c.emptyNinjaFile = v
1629}
1630
1631func (c *configImpl) EmptyNinjaFile() bool {
1632 return c.emptyNinjaFile
1633}
Yu Liu6e13b402021-07-27 14:29:06 -07001634
Romain Jobredeaux0a7529b2022-10-26 12:56:41 -04001635func (c *configImpl) IsBazelMixedBuildForceDisabled() bool {
1636 return c.Environment().IsEnvTrue("BUILD_BROKEN_DISABLE_BAZEL")
1637}
1638
Chris Parsons9402ca82023-02-23 17:28:06 -05001639func (c *configImpl) IsPersistentBazelEnabled() bool {
1640 return c.Environment().IsEnvTrue("USE_PERSISTENT_BAZEL")
1641}
1642
MarkDacekd06db5d2022-11-29 00:47:59 +00001643func (c *configImpl) BazelModulesForceEnabledByFlag() string {
1644 return c.bazelForceEnabledModules
1645}
1646
MarkDacekd0e7cd32022-12-02 22:22:40 +00001647func (c *configImpl) SkipMetricsUpload() bool {
1648 return c.skipMetricsUpload
1649}
1650
MarkDacek6614d9c2022-12-07 21:57:38 +00001651// Returns a Time object if one was passed via a command-line flag.
1652// Otherwise returns the passed default.
1653func (c *configImpl) BuildStartedTimeOrDefault(defaultTime time.Time) time.Time {
1654 if c.buildStartedTime == 0 {
1655 return defaultTime
1656 }
1657 return time.UnixMilli(c.buildStartedTime)
1658}
1659
Yu Liu6e13b402021-07-27 14:29:06 -07001660func GetMetricsUploader(topDir string, env *Environment) string {
1661 if p, ok := env.Get("METRICS_UPLOADER"); ok {
1662 metricsUploader := filepath.Join(topDir, p)
1663 if _, err := os.Stat(metricsUploader); err == nil {
1664 return metricsUploader
1665 }
1666 }
1667
1668 return ""
1669}