blob: 084d28d8327a94ce346db1b23592fccb43cd1c07 [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 Kumar3ff037e2022-01-25 22:11:01 -050018 "encoding/json"
Jeongik Chaa87506f2023-06-01 23:16:41 +090019 "errors"
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 Kumar3ff037e2022-01-25 22:11:01 -050042)
43
Kousik Kumar4c180ad2022-05-27 07:48:37 -040044var (
Kevin Dagostino096ab2f2023-03-03 19:47:17 +000045 rbeRandPrefix int
46 googleProdCredsExistCache bool
Kousik Kumar4c180ad2022-05-27 07:48:37 -040047)
48
49func init() {
50 rand.Seed(time.Now().UnixNano())
51 rbeRandPrefix = rand.Intn(1000)
52}
53
Dan Willemsen1e704462016-08-21 15:17:17 -070054type Config struct{ *configImpl }
55
56type configImpl struct {
Lukacs T. Berkia1b93722021-09-02 17:23:06 +020057 // Some targets that are implemented in soong_build
58 // (bp2build, json-module-graph) are not here and have their own bits below.
Colin Cross28f527c2019-11-26 16:19:04 -080059 arguments []string
60 goma bool
61 environ *Environment
62 distDir string
63 buildDateTime string
MarkDacek6614d9c2022-12-07 21:57:38 +000064 logsPrefix string
Dan Willemsen1e704462016-08-21 15:17:17 -070065
66 // From the arguments
MarkDacekf47e1422023-04-19 16:47:36 +000067 parallel int
68 keepGoing int
69 verbose bool
70 checkbuild bool
71 dist bool
72 jsonModuleGraph bool
MarkDacekf47e1422023-04-19 16:47:36 +000073 bp2build bool
74 queryview bool
75 reportMkMetrics bool // Collect and report mk2bp migration progress metrics.
76 soongDocs bool
77 multitreeBuild bool // This is a multitree build.
78 skipConfig bool
79 skipKati bool
80 skipKatiNinja bool
81 skipSoong bool
82 skipNinja bool
83 skipSoongTests bool
84 searchApiDir bool // Scan the Android.bp files generated in out/api_surfaces
85 skipMetricsUpload bool
86 buildStartedTime int64 // For metrics-upload-only - manually specify a build-started time
87 buildFromTextStub bool
MarkDacek396491e2023-06-14 19:41:18 +000088 ensureAllowlistIntegrity bool // For CI builds - make sure modules are mixed-built
89 bazelExitCode int32 // For b runs - necessary for updating NonZeroExit
90 besId string // For b runs, to identify the BuildEventService logs
Dan Willemsen1e704462016-08-21 15:17:17 -070091
92 // From the product config
Dan Willemsen6ab79db2018-05-02 00:06:28 -070093 katiArgs []string
94 ninjaArgs []string
95 katiSuffix string
96 targetDevice string
97 targetDeviceDir string
Spandan Dasa3639e62021-05-25 19:14:02 +000098 sandboxConfig *SandboxConfig
Dan Willemsen3d60b112018-04-04 22:25:56 -070099
Dan Willemsen2bb82d02019-12-27 09:35:42 -0800100 // Autodetected
101 totalRAM uint64
102
Dan Willemsene3336352020-01-02 19:10:38 -0800103 brokenDupRules bool
104 brokenUsesNetwork bool
105 brokenNinjaEnvVars []string
Dan Willemsen18490112018-05-25 16:30:04 -0700106
107 pathReplaced bool
Rupert Shuttleworth3c9f5ac2020-12-10 11:32:38 +0000108
MarkDacekb78465d2022-10-18 20:10:16 +0000109 bazelProdMode bool
MarkDacekb78465d2022-10-18 20:10:16 +0000110 bazelStagingMode bool
Rupert Shuttleworth3c9f5ac2020-12-10 11:32:38 +0000111
Colin Crossf3bdbcb2021-06-01 11:43:55 -0700112 // Set by multiproduct_kati
113 emptyNinjaFile bool
Yu Liu6e13b402021-07-27 14:29:06 -0700114
115 metricsUploader string
MarkDacekd06db5d2022-11-29 00:47:59 +0000116
117 bazelForceEnabledModules string
Spandan Dasc5763832022-11-08 18:42:16 +0000118
Sam Delmerico98a73292023-02-21 11:50:29 -0500119 includeTags []string
120 sourceRootDirs []string
Jeongik Cha0cf44d52023-03-15 00:10:45 +0900121
122 // Data source to write ninja weight list
123 ninjaWeightListSource NinjaWeightListSource
Dan Willemsen1e704462016-08-21 15:17:17 -0700124}
125
Jeongik Cha0cf44d52023-03-15 00:10:45 +0900126type NinjaWeightListSource uint
127
128const (
129 // ninja doesn't use weight list.
130 NOT_USED NinjaWeightListSource = iota
131 // ninja uses weight list based on previous builds by ninja log
132 NINJA_LOG
133 // ninja thinks every task has the same weight.
134 EVENLY_DISTRIBUTED
Jeongik Cha518f3ea2023-03-19 00:12:39 +0900135 // ninja uses an external custom weight list
136 EXTERNAL_FILE
Jeongik Chae114e602023-03-19 00:12:39 +0900137 // ninja uses a prioritized module list from Soong
138 HINT_FROM_SOONG
Jeongik Chaa87506f2023-06-01 23:16:41 +0900139 // If ninja log exists, use NINJA_LOG, if not, use HINT_FROM_SOONG instead.
140 // We can assume it is an incremental build if ninja log exists.
141 DEFAULT
Jeongik Cha0cf44d52023-03-15 00:10:45 +0900142)
Dan Willemsenc2af0be2017-01-20 14:10:01 -0800143const srcDirFileCheck = "build/soong/root.bp"
144
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700145var buildFiles = []string{"Android.mk", "Android.bp"}
146
Patrice Arruda13848222019-04-22 17:12:02 -0700147type BuildAction uint
148
149const (
150 // Builds all of the modules and their dependencies of a specified directory, relative to the root
151 // directory of the source tree.
152 BUILD_MODULES_IN_A_DIRECTORY BuildAction = iota
153
154 // Builds all of the modules and their dependencies of a list of specified directories. All specified
155 // directories are relative to the root directory of the source tree.
156 BUILD_MODULES_IN_DIRECTORIES
Patrice Arruda39282062019-06-20 16:35:12 -0700157
158 // Build a list of specified modules. If none was specified, simply build the whole source tree.
159 BUILD_MODULES
Patrice Arruda13848222019-04-22 17:12:02 -0700160)
161
162// checkTopDir validates that the current directory is at the root directory of the source tree.
163func checkTopDir(ctx Context) {
164 if _, err := os.Stat(srcDirFileCheck); err != nil {
165 if os.IsNotExist(err) {
166 ctx.Fatalf("Current working directory must be the source tree. %q not found.", srcDirFileCheck)
167 }
168 ctx.Fatalln("Error verifying tree state:", err)
169 }
170}
171
MarkDacek7901e582023-01-09 19:48:01 +0000172func loadEnvConfig(ctx Context, config *configImpl, bc string) error {
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500173 if bc == "" {
174 return nil
175 }
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500176
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500177 configDirs := []string{
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500178 config.OutDir(),
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500179 os.Getenv("ANDROID_BUILD_ENVIRONMENT_CONFIG_DIR"),
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500180 envConfigDir,
181 }
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500182 for _, dir := range configDirs {
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500183 cfgFile := filepath.Join(os.Getenv("TOP"), dir, fmt.Sprintf("%s.%s", bc, jsonSuffix))
184 envVarsJSON, err := ioutil.ReadFile(cfgFile)
185 if err != nil {
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500186 continue
187 }
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500188 ctx.Verbosef("Loading config file %v\n", cfgFile)
189 var envVars map[string]map[string]string
190 if err := json.Unmarshal(envVarsJSON, &envVars); err != nil {
191 fmt.Fprintf(os.Stderr, "Env vars config file %s did not parse correctly: %s", cfgFile, err.Error())
192 continue
193 }
194 for k, v := range envVars["env"] {
195 if os.Getenv(k) != "" {
196 continue
197 }
198 config.environ.Set(k, v)
199 }
200 ctx.Verbosef("Finished loading config file %v\n", cfgFile)
201 break
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500202 }
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500203
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500204 return nil
205}
206
Chris Parsonsb6e96902022-10-31 20:08:45 -0400207func defaultBazelProdMode(cfg *configImpl) bool {
MarkDacekd06db5d2022-11-29 00:47:59 +0000208 // Environment flag to disable Bazel for users which experience
Chris Parsonsb6e96902022-10-31 20:08:45 -0400209 // broken bazel-handled builds, or significant performance regressions.
210 if cfg.IsBazelMixedBuildForceDisabled() {
211 return false
212 }
213 // Darwin-host builds are currently untested with Bazel.
214 if runtime.GOOS == "darwin" {
215 return false
216 }
Chris Parsons035e03a2022-11-01 14:25:45 -0400217 return true
Chris Parsonsb6e96902022-10-31 20:08:45 -0400218}
219
MarkDacekd33c2fd2023-05-04 20:40:04 +0000220func UploadOnlyConfig(ctx Context, args ...string) Config {
MarkDacek6614d9c2022-12-07 21:57:38 +0000221 ret := &configImpl{
222 environ: OsEnvironment(),
223 sandboxConfig: &SandboxConfig{},
224 }
MarkDacekd33c2fd2023-05-04 20:40:04 +0000225 ret.parseArgs(ctx, args)
MarkDacek7901e582023-01-09 19:48:01 +0000226 srcDir := absPath(ctx, ".")
227 bc := os.Getenv("ANDROID_BUILD_ENVIRONMENT_CONFIG")
228 if err := loadEnvConfig(ctx, ret, bc); err != nil {
229 ctx.Fatalln("Failed to parse env config files: %v", err)
230 }
231 ret.metricsUploader = GetMetricsUploader(srcDir, ret.environ)
MarkDacek6614d9c2022-12-07 21:57:38 +0000232 return Config{ret}
233}
234
Dan Willemsen1e704462016-08-21 15:17:17 -0700235func NewConfig(ctx Context, args ...string) Config {
236 ret := &configImpl{
Jeongik Chaf2ecf762023-05-19 14:03:45 +0900237 environ: OsEnvironment(),
238 sandboxConfig: &SandboxConfig{},
Jeongik Chaa87506f2023-06-01 23:16:41 +0900239 ninjaWeightListSource: DEFAULT,
Dan Willemsen1e704462016-08-21 15:17:17 -0700240 }
241
Patrice Arruda90109172020-07-28 18:07:27 +0000242 // Default matching ninja
Dan Willemsen9b587492017-07-10 22:13:00 -0700243 ret.parallel = runtime.NumCPU() + 2
244 ret.keepGoing = 1
245
Dan Willemsen2bb82d02019-12-27 09:35:42 -0800246 ret.totalRAM = detectTotalRAM(ctx)
Dan Willemsen9b587492017-07-10 22:13:00 -0700247 ret.parseArgs(ctx, args)
Jeongik Chae114e602023-03-19 00:12:39 +0900248
249 if ret.ninjaWeightListSource == HINT_FROM_SOONG {
Jeongik Chaa87506f2023-06-01 23:16:41 +0900250 ret.environ.Set("SOONG_GENERATES_NINJA_HINT", "always")
251 } else if ret.ninjaWeightListSource == DEFAULT {
252 defaultNinjaWeightListSource := NINJA_LOG
253 if _, err := os.Stat(filepath.Join(ret.OutDir(), ninjaLogFileName)); errors.Is(err, os.ErrNotExist) {
254 ctx.Verboseln("$OUT/.ninja_log doesn't exist, use HINT_FROM_SOONG instead")
255 defaultNinjaWeightListSource = HINT_FROM_SOONG
256 } else {
257 ctx.Verboseln("$OUT/.ninja_log exist, use NINJA_LOG")
258 }
259 ret.ninjaWeightListSource = defaultNinjaWeightListSource
260 // soong_build generates ninja hint depending on ninja log existence.
261 // Set it "depend" to avoid soong re-run due to env variable change.
262 ret.environ.Set("SOONG_GENERATES_NINJA_HINT", "depend")
Jeongik Chae114e602023-03-19 00:12:39 +0900263 }
Jeongik Chaa87506f2023-06-01 23:16:41 +0900264
Dan Willemsen0c3919e2017-03-02 15:49:10 -0800265 // Make sure OUT_DIR is set appropriately
Dan Willemsen02f3add2017-05-12 13:50:19 -0700266 if outDir, ok := ret.environ.Get("OUT_DIR"); ok {
267 ret.environ.Set("OUT_DIR", filepath.Clean(outDir))
268 } else {
Dan Willemsen0c3919e2017-03-02 15:49:10 -0800269 outDir := "out"
270 if baseDir, ok := ret.environ.Get("OUT_DIR_COMMON_BASE"); ok {
271 if wd, err := os.Getwd(); err != nil {
272 ctx.Fatalln("Failed to get working directory:", err)
273 } else {
274 outDir = filepath.Join(baseDir, filepath.Base(wd))
275 }
276 }
277 ret.environ.Set("OUT_DIR", outDir)
278 }
279
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500280 // loadEnvConfig needs to know what the OUT_DIR is, so it should
281 // be called after we determine the appropriate out directory.
MarkDacek7901e582023-01-09 19:48:01 +0000282 bc := os.Getenv("ANDROID_BUILD_ENVIRONMENT_CONFIG")
283
284 if bc != "" {
Kousik Kumarc8818332023-01-16 16:33:05 +0000285 if err := loadEnvConfig(ctx, ret, bc); err != nil {
MarkDacek7901e582023-01-09 19:48:01 +0000286 ctx.Fatalln("Failed to parse env config files: %v", err)
287 }
Kousik Kumar6d1e3482023-07-24 03:44:16 +0000288 if !ret.canSupportRBE() {
289 // Explicitly set USE_RBE env variable to false when we cannot run
290 // an RBE build to avoid ninja local execution pool issues.
291 ret.environ.Set("USE_RBE", "false")
292 }
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500293 }
294
Dan Willemsen2d31a442018-10-20 21:33:41 -0700295 if distDir, ok := ret.environ.Get("DIST_DIR"); ok {
296 ret.distDir = filepath.Clean(distDir)
297 } else {
298 ret.distDir = filepath.Join(ret.OutDir(), "dist")
299 }
Dan Willemsend50e89f2018-10-16 17:49:25 -0700300
Spandan Das05063612021-06-25 01:39:04 +0000301 if srcDirIsWritable, ok := ret.environ.Get("BUILD_BROKEN_SRC_DIR_IS_WRITABLE"); ok {
302 ret.sandboxConfig.SetSrcDirIsRO(srcDirIsWritable == "false")
303 }
304
Dan Willemsen1e704462016-08-21 15:17:17 -0700305 ret.environ.Unset(
306 // We're already using it
307 "USE_SOONG_UI",
308
309 // We should never use GOROOT/GOPATH from the shell environment
310 "GOROOT",
311 "GOPATH",
312
313 // These should only come from Soong, not the environment.
314 "CLANG",
315 "CLANG_CXX",
316 "CCC_CC",
317 "CCC_CXX",
318
319 // Used by the goma compiler wrapper, but should only be set by
320 // gomacc
321 "GOMACC_PATH",
Dan Willemsen0c3919e2017-03-02 15:49:10 -0800322
323 // We handle this above
324 "OUT_DIR_COMMON_BASE",
Dan Willemsen68a09852017-04-18 13:56:57 -0700325
Dan Willemsen2d31a442018-10-20 21:33:41 -0700326 // This is handled above too, and set for individual commands later
327 "DIST_DIR",
328
Dan Willemsen68a09852017-04-18 13:56:57 -0700329 // Variables that have caused problems in the past
Dan Willemsen1c504d92019-11-18 19:13:53 +0000330 "BASH_ENV",
Dan Willemsenebfe33a2018-05-01 10:07:50 -0700331 "CDPATH",
Dan Willemsen68a09852017-04-18 13:56:57 -0700332 "DISPLAY",
333 "GREP_OPTIONS",
Nathan Egge7b067fb2023-02-17 17:54:31 +0000334 "JAVAC",
Dan Willemsenebfe33a2018-05-01 10:07:50 -0700335 "NDK_ROOT",
Dan Willemsen00fcb262018-08-15 15:35:38 -0700336 "POSIXLY_CORRECT",
Dan Willemsenc40e10b2017-07-11 14:30:00 -0700337
338 // Drop make flags
339 "MAKEFLAGS",
340 "MAKELEVEL",
341 "MFLAGS",
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700342
343 // Set in envsetup.sh, reset in makefiles
344 "ANDROID_JAVA_TOOLCHAIN",
Colin Cross7f09c402018-07-11 14:49:31 -0700345
346 // Set by envsetup.sh, but shouldn't be used inside the build because envsetup.sh is optional
347 "ANDROID_BUILD_TOP",
348 "ANDROID_HOST_OUT",
349 "ANDROID_PRODUCT_OUT",
350 "ANDROID_HOST_OUT_TESTCASES",
351 "ANDROID_TARGET_OUT_TESTCASES",
352 "ANDROID_TOOLCHAIN",
353 "ANDROID_TOOLCHAIN_2ND_ARCH",
354 "ANDROID_DEV_SCRIPTS",
355 "ANDROID_EMULATOR_PREBUILTS",
356 "ANDROID_PRE_BUILD_PATHS",
Dan Willemsen1e704462016-08-21 15:17:17 -0700357 )
358
Kousik Kumarb328f6d2020-10-19 01:45:46 -0400359 if ret.UseGoma() || ret.ForceUseGoma() {
360 ctx.Println("Goma for Android has been deprecated and replaced with RBE. See go/rbe_for_android for instructions on how to use RBE.")
361 ctx.Fatalln("USE_GOMA / FORCE_USE_GOMA flag is no longer supported.")
Kousik Kumarec478642020-09-21 13:39:24 -0400362 }
363
Dan Willemsen1e704462016-08-21 15:17:17 -0700364 // Tell python not to spam the source tree with .pyc files.
365 ret.environ.Set("PYTHONDONTWRITEBYTECODE", "1")
366
Ramy Medhatca1e44c2020-07-16 12:18:37 -0400367 tmpDir := absPath(ctx, ret.TempDir())
368 ret.environ.Set("TMPDIR", tmpDir)
Dan Willemsen32a669b2018-03-08 19:42:00 -0800369
Dan Willemsen70c1ff82019-08-21 14:56:13 -0700370 // Always set ASAN_SYMBOLIZER_PATH so that ASAN-based tools can symbolize any crashes
371 symbolizerPath := filepath.Join("prebuilts/clang/host", ret.HostPrebuiltTag(),
372 "llvm-binutils-stable/llvm-symbolizer")
373 ret.environ.Set("ASAN_SYMBOLIZER_PATH", absPath(ctx, symbolizerPath))
374
Dan Willemsenc2af0be2017-01-20 14:10:01 -0800375 // Precondition: the current directory is the top of the source tree
Patrice Arruda13848222019-04-22 17:12:02 -0700376 checkTopDir(ctx)
Dan Willemsenc2af0be2017-01-20 14:10:01 -0800377
Yu Liu6e13b402021-07-27 14:29:06 -0700378 srcDir := absPath(ctx, ".")
379 if strings.ContainsRune(srcDir, ' ') {
Colin Cross1f6faeb2019-09-23 15:52:40 -0700380 ctx.Println("You are building in a directory whose absolute path contains a space character:")
381 ctx.Println()
382 ctx.Printf("%q\n", srcDir)
383 ctx.Println()
384 ctx.Fatalln("Directory names containing spaces are not supported")
Dan Willemsendb8457c2017-05-12 16:38:17 -0700385 }
386
Yu Liu6e13b402021-07-27 14:29:06 -0700387 ret.metricsUploader = GetMetricsUploader(srcDir, ret.environ)
388
Dan Willemsendb8457c2017-05-12 16:38:17 -0700389 if outDir := ret.OutDir(); strings.ContainsRune(outDir, ' ') {
Colin Cross1f6faeb2019-09-23 15:52:40 -0700390 ctx.Println("The absolute path of your output directory ($OUT_DIR) contains a space character:")
391 ctx.Println()
392 ctx.Printf("%q\n", outDir)
393 ctx.Println()
394 ctx.Fatalln("Directory names containing spaces are not supported")
Dan Willemsendb8457c2017-05-12 16:38:17 -0700395 }
396
Rupert Shuttleworth3c9f5ac2020-12-10 11:32:38 +0000397 if distDir := ret.RealDistDir(); strings.ContainsRune(distDir, ' ') {
Colin Cross1f6faeb2019-09-23 15:52:40 -0700398 ctx.Println("The absolute path of your dist directory ($DIST_DIR) contains a space character:")
399 ctx.Println()
400 ctx.Printf("%q\n", distDir)
401 ctx.Println()
402 ctx.Fatalln("Directory names containing spaces are not supported")
Dan Willemsendb8457c2017-05-12 16:38:17 -0700403 }
404
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700405 // Configure Java-related variables, including adding it to $PATH
Tobias Thierere59aeff2017-12-20 22:40:39 +0000406 java8Home := filepath.Join("prebuilts/jdk/jdk8", ret.HostPrebuiltTag())
407 java9Home := filepath.Join("prebuilts/jdk/jdk9", ret.HostPrebuiltTag())
Pete Gillin1f52e932019-10-09 17:10:08 +0100408 java11Home := filepath.Join("prebuilts/jdk/jdk11", ret.HostPrebuiltTag())
Colin Cross59c1e6a2022-03-04 13:37:19 -0800409 java17Home := filepath.Join("prebuilts/jdk/jdk17", ret.HostPrebuiltTag())
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700410 javaHome := func() string {
411 if override, ok := ret.environ.Get("OVERRIDE_ANDROID_JAVA_HOME"); ok {
412 return override
413 }
Pete Gillina7a3d642019-11-07 18:58:42 +0000414 if toolchain11, ok := ret.environ.Get("EXPERIMENTAL_USE_OPENJDK11_TOOLCHAIN"); ok && toolchain11 != "true" {
415 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 +0100416 }
Sorin Basca7e094b32022-10-05 08:20:12 +0000417 if toolchain17, ok := ret.environ.Get("EXPERIMENTAL_USE_OPENJDK17_TOOLCHAIN"); ok && toolchain17 != "true" {
418 ctx.Fatalln("The environment variable EXPERIMENTAL_USE_OPENJDK17_TOOLCHAIN is no longer supported. An OpenJDK 17 toolchain is now the global default.")
419 }
420 return java17Home
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700421 }()
422 absJavaHome := absPath(ctx, javaHome)
423
Dan Willemsened869522018-01-08 14:58:46 -0800424 ret.configureLocale(ctx)
425
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700426 newPath := []string{filepath.Join(absJavaHome, "bin")}
427 if path, ok := ret.environ.Get("PATH"); ok && path != "" {
428 newPath = append(newPath, path)
429 }
Pete Gillin1f52e932019-10-09 17:10:08 +0100430
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700431 ret.environ.Unset("OVERRIDE_ANDROID_JAVA_HOME")
432 ret.environ.Set("JAVA_HOME", absJavaHome)
433 ret.environ.Set("ANDROID_JAVA_HOME", javaHome)
Tobias Thierere59aeff2017-12-20 22:40:39 +0000434 ret.environ.Set("ANDROID_JAVA8_HOME", java8Home)
435 ret.environ.Set("ANDROID_JAVA9_HOME", java9Home)
Pete Gillin1f52e932019-10-09 17:10:08 +0100436 ret.environ.Set("ANDROID_JAVA11_HOME", java11Home)
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700437 ret.environ.Set("PATH", strings.Join(newPath, string(filepath.ListSeparator)))
438
Colin Crossfe5ed4d2023-07-28 09:27:23 -0700439 // b/286885495, https://bugzilla.redhat.com/show_bug.cgi?id=2227130: some versions of Fedora include patches
440 // to unzip to enable zipbomb detection that incorrectly handle zip64 and data descriptors and fail on large
441 // zip files produced by soong_zip. Disable zipbomb detection.
442 ret.environ.Set("UNZIP_DISABLE_ZIPBOMB_DETECTION", "TRUE")
443
LaMont Jones52a72432023-03-09 18:19:35 +0000444 if ret.MultitreeBuild() {
445 ret.environ.Set("MULTITREE_BUILD", "true")
446 }
447
Nan Zhang2e6a4ff2018-02-14 13:27:26 -0800448 outDir := ret.OutDir()
449 buildDateTimeFile := filepath.Join(outDir, "build_date.txt")
Nan Zhang2e6a4ff2018-02-14 13:27:26 -0800450 if buildDateTime, ok := ret.environ.Get("BUILD_DATETIME"); ok && buildDateTime != "" {
Colin Cross28f527c2019-11-26 16:19:04 -0800451 ret.buildDateTime = buildDateTime
Nan Zhang2e6a4ff2018-02-14 13:27:26 -0800452 } else {
Colin Cross28f527c2019-11-26 16:19:04 -0800453 ret.buildDateTime = strconv.FormatInt(time.Now().Unix(), 10)
Nan Zhang2e6a4ff2018-02-14 13:27:26 -0800454 }
Colin Cross28f527c2019-11-26 16:19:04 -0800455
Nan Zhang2e6a4ff2018-02-14 13:27:26 -0800456 ret.environ.Set("BUILD_DATETIME_FILE", buildDateTimeFile)
457
Ramy Medhatca1e44c2020-07-16 12:18:37 -0400458 if ret.UseRBE() {
Ramy Medhat0fc67eb2020-08-12 01:26:23 -0400459 for k, v := range getRBEVars(ctx, Config{ret}) {
Ramy Medhatca1e44c2020-07-16 12:18:37 -0400460 ret.environ.Set(k, v)
461 }
462 }
463
Jihoon Kang1bff0342023-01-17 20:40:22 +0000464 if ret.BuildFromTextStub() {
465 // TODO(b/271443071): support hidden api check for from-text stub build
466 ret.environ.Set("UNSAFE_DISABLE_HIDDENAPI_FLAGS", "true")
467 }
468
Patrice Arruda83842d72020-12-08 19:42:08 +0000469 bpd := ret.BazelMetricsDir()
Patrice Arrudaaf880da2020-11-13 08:41:26 -0800470 if err := os.RemoveAll(bpd); err != nil {
471 ctx.Fatalf("Unable to remove bazel profile directory %q: %v", bpd, err)
472 }
Rupert Shuttleworth3c9f5ac2020-12-10 11:32:38 +0000473
Patrice Arruda96850362020-08-11 20:41:11 +0000474 c := Config{ret}
475 storeConfigMetrics(ctx, c)
476 return c
Dan Willemsen9b587492017-07-10 22:13:00 -0700477}
478
Patrice Arruda13848222019-04-22 17:12:02 -0700479// NewBuildActionConfig returns a build configuration based on the build action. The arguments are
480// processed based on the build action and extracts any arguments that belongs to the build action.
Dan Willemsence41e942019-07-29 23:39:30 -0700481func NewBuildActionConfig(action BuildAction, dir string, ctx Context, args ...string) Config {
482 return NewConfig(ctx, getConfigArgs(action, dir, ctx, args)...)
Patrice Arruda13848222019-04-22 17:12:02 -0700483}
484
Patrice Arruda96850362020-08-11 20:41:11 +0000485// storeConfigMetrics selects a set of configuration information and store in
486// the metrics system for further analysis.
487func storeConfigMetrics(ctx Context, config Config) {
488 if ctx.Metrics == nil {
489 return
490 }
491
Liz Kammerca9cb2e2021-07-14 15:29:57 -0400492 ctx.Metrics.BuildConfig(buildConfig(config))
Patrice Arruda3edfd482020-10-13 23:58:41 +0000493
494 s := &smpb.SystemResourceInfo{
495 TotalPhysicalMemory: proto.Uint64(config.TotalRAM()),
496 AvailableCpus: proto.Int32(int32(runtime.NumCPU())),
497 }
498 ctx.Metrics.SystemResourceInfo(s)
Patrice Arruda96850362020-08-11 20:41:11 +0000499}
500
Jeongik Cha8d63d562023-03-17 03:52:13 +0900501func getNinjaWeightListSourceInMetric(s NinjaWeightListSource) *smpb.BuildConfig_NinjaWeightListSource {
Jeongik Cha0cf44d52023-03-15 00:10:45 +0900502 switch s {
503 case NINJA_LOG:
Jeongik Cha8d63d562023-03-17 03:52:13 +0900504 return smpb.BuildConfig_NINJA_LOG.Enum()
Jeongik Cha0cf44d52023-03-15 00:10:45 +0900505 case EVENLY_DISTRIBUTED:
Jeongik Cha8d63d562023-03-17 03:52:13 +0900506 return smpb.BuildConfig_EVENLY_DISTRIBUTED.Enum()
Jeongik Cha518f3ea2023-03-19 00:12:39 +0900507 case EXTERNAL_FILE:
508 return smpb.BuildConfig_EXTERNAL_FILE.Enum()
Jeongik Chae114e602023-03-19 00:12:39 +0900509 case HINT_FROM_SOONG:
510 return smpb.BuildConfig_HINT_FROM_SOONG.Enum()
Jeongik Cha0cf44d52023-03-15 00:10:45 +0900511 default:
Jeongik Cha8d63d562023-03-17 03:52:13 +0900512 return smpb.BuildConfig_NOT_USED.Enum()
Jeongik Cha0cf44d52023-03-15 00:10:45 +0900513 }
514}
515
Liz Kammerca9cb2e2021-07-14 15:29:57 -0400516func buildConfig(config Config) *smpb.BuildConfig {
Yu Liue737a992021-10-04 13:21:41 -0700517 c := &smpb.BuildConfig{
Romain Jobredeaux0a7529b2022-10-26 12:56:41 -0400518 ForceUseGoma: proto.Bool(config.ForceUseGoma()),
519 UseGoma: proto.Bool(config.UseGoma()),
520 UseRbe: proto.Bool(config.UseRBE()),
521 BazelMixedBuild: proto.Bool(config.BazelBuildEnabled()),
522 ForceDisableBazelMixedBuild: proto.Bool(config.IsBazelMixedBuildForceDisabled()),
Jeongik Cha0cf44d52023-03-15 00:10:45 +0900523 NinjaWeightListSource: getNinjaWeightListSourceInMetric(config.NinjaWeightListSource()),
Liz Kammerca9cb2e2021-07-14 15:29:57 -0400524 }
Yu Liue737a992021-10-04 13:21:41 -0700525 c.Targets = append(c.Targets, config.arguments...)
526
527 return c
Liz Kammerca9cb2e2021-07-14 15:29:57 -0400528}
529
Patrice Arruda13848222019-04-22 17:12:02 -0700530// getConfigArgs processes the command arguments based on the build action and creates a set of new
531// arguments to be accepted by Config.
Dan Willemsence41e942019-07-29 23:39:30 -0700532func getConfigArgs(action BuildAction, dir string, ctx Context, args []string) []string {
Patrice Arruda13848222019-04-22 17:12:02 -0700533 // The next block of code verifies that the current directory is the root directory of the source
534 // tree. It then finds the relative path of dir based on the root directory of the source tree
535 // and verify that dir is inside of the source tree.
536 checkTopDir(ctx)
537 topDir, err := os.Getwd()
538 if err != nil {
539 ctx.Fatalf("Error retrieving top directory: %v", err)
540 }
Patrice Arrudababa9a92019-07-03 10:47:34 -0700541 dir, err = filepath.EvalSymlinks(dir)
542 if err != nil {
543 ctx.Fatalf("Unable to evaluate symlink of %s: %v", dir, err)
544 }
Patrice Arruda13848222019-04-22 17:12:02 -0700545 dir, err = filepath.Abs(dir)
546 if err != nil {
547 ctx.Fatalf("Unable to find absolute path %s: %v", dir, err)
548 }
549 relDir, err := filepath.Rel(topDir, dir)
550 if err != nil {
551 ctx.Fatalf("Unable to find relative path %s of %s: %v", relDir, topDir, err)
552 }
553 // If there are ".." in the path, it's not in the source tree.
554 if strings.Contains(relDir, "..") {
555 ctx.Fatalf("Directory %s is not under the source tree %s", dir, topDir)
556 }
557
558 configArgs := args[:]
559
560 // If the arguments contains GET-INSTALL-PATH, change the target name prefix from MODULES-IN- to
561 // GET-INSTALL-PATH-IN- to extract the installation path instead of building the modules.
562 targetNamePrefix := "MODULES-IN-"
563 if inList("GET-INSTALL-PATH", configArgs) {
564 targetNamePrefix = "GET-INSTALL-PATH-IN-"
565 configArgs = removeFromList("GET-INSTALL-PATH", configArgs)
566 }
567
Patrice Arruda13848222019-04-22 17:12:02 -0700568 var targets []string
569
570 switch action {
Patrice Arruda39282062019-06-20 16:35:12 -0700571 case BUILD_MODULES:
572 // No additional processing is required when building a list of specific modules or all modules.
Patrice Arruda13848222019-04-22 17:12:02 -0700573 case BUILD_MODULES_IN_A_DIRECTORY:
574 // If dir is the root source tree, all the modules are built of the source tree are built so
575 // no need to find the build file.
576 if topDir == dir {
577 break
578 }
Patrice Arruda0dcf27f2019-07-08 17:03:33 -0700579
Patrice Arruda13848222019-04-22 17:12:02 -0700580 buildFile := findBuildFile(ctx, relDir)
581 if buildFile == "" {
Patrice Arruda0dcf27f2019-07-08 17:03:33 -0700582 ctx.Fatalf("Build file not found for %s directory", relDir)
Patrice Arruda13848222019-04-22 17:12:02 -0700583 }
Patrice Arruda13848222019-04-22 17:12:02 -0700584 targets = []string{convertToTarget(filepath.Dir(buildFile), targetNamePrefix)}
585 case BUILD_MODULES_IN_DIRECTORIES:
586 newConfigArgs, dirs := splitArgs(configArgs)
587 configArgs = newConfigArgs
Dan Willemsence41e942019-07-29 23:39:30 -0700588 targets = getTargetsFromDirs(ctx, relDir, dirs, targetNamePrefix)
Patrice Arruda13848222019-04-22 17:12:02 -0700589 }
590
591 // Tidy only override all other specified targets.
592 tidyOnly := os.Getenv("WITH_TIDY_ONLY")
593 if tidyOnly == "true" || tidyOnly == "1" {
594 configArgs = append(configArgs, "tidy_only")
595 } else {
596 configArgs = append(configArgs, targets...)
597 }
598
599 return configArgs
600}
601
602// convertToTarget replaces "/" to "-" in dir and pre-append the targetNamePrefix to the target name.
603func convertToTarget(dir string, targetNamePrefix string) string {
604 return targetNamePrefix + strings.ReplaceAll(dir, "/", "-")
605}
606
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700607// hasBuildFile returns true if dir contains an Android build file.
608func hasBuildFile(ctx Context, dir string) bool {
609 for _, buildFile := range buildFiles {
610 _, err := os.Stat(filepath.Join(dir, buildFile))
611 if err == nil {
612 return true
613 }
614 if !os.IsNotExist(err) {
615 ctx.Fatalf("Error retrieving the build file stats: %v", err)
616 }
617 }
618 return false
619}
620
Patrice Arruda0dcf27f2019-07-08 17:03:33 -0700621// findBuildFile finds a build file (makefile or blueprint file) by looking if there is a build file
622// in the current and any sub directory of dir. If a build file is not found, traverse the path
623// up by one directory and repeat again until either a build file is found or reached to the root
624// source tree. The returned filename of build file is "Android.mk". If one was not found, a blank
625// string is returned.
Patrice Arruda13848222019-04-22 17:12:02 -0700626func findBuildFile(ctx Context, dir string) string {
Patrice Arruda0dcf27f2019-07-08 17:03:33 -0700627 // If the string is empty or ".", assume it is top directory of the source tree.
628 if dir == "" || dir == "." {
Patrice Arruda13848222019-04-22 17:12:02 -0700629 return ""
630 }
631
Patrice Arruda0dcf27f2019-07-08 17:03:33 -0700632 found := false
633 for buildDir := dir; buildDir != "."; buildDir = filepath.Dir(buildDir) {
634 err := filepath.Walk(buildDir, func(path string, info os.FileInfo, err error) error {
635 if err != nil {
636 return err
637 }
638 if found {
639 return filepath.SkipDir
640 }
641 if info.IsDir() {
642 return nil
643 }
644 for _, buildFile := range buildFiles {
645 if info.Name() == buildFile {
646 found = true
647 return filepath.SkipDir
648 }
649 }
650 return nil
651 })
652 if err != nil {
653 ctx.Fatalf("Error finding Android build file: %v", err)
654 }
655
656 if found {
657 return filepath.Join(buildDir, "Android.mk")
Patrice Arruda13848222019-04-22 17:12:02 -0700658 }
659 }
660
661 return ""
662}
663
664// splitArgs iterates over the arguments list and splits into two lists: arguments and directories.
665func splitArgs(args []string) (newArgs []string, dirs []string) {
666 specialArgs := map[string]bool{
667 "showcommands": true,
668 "snod": true,
669 "dist": true,
670 "checkbuild": true,
671 }
672
673 newArgs = []string{}
674 dirs = []string{}
675
676 for _, arg := range args {
677 // It's a dash argument if it starts with "-" or it's a key=value pair, it's not a directory.
678 if strings.IndexRune(arg, '-') == 0 || strings.IndexRune(arg, '=') != -1 {
679 newArgs = append(newArgs, arg)
680 continue
681 }
682
683 if _, ok := specialArgs[arg]; ok {
684 newArgs = append(newArgs, arg)
685 continue
686 }
687
688 dirs = append(dirs, arg)
689 }
690
691 return newArgs, dirs
692}
693
694// getTargetsFromDirs iterates over the dirs list and creates a list of targets to build. If a
695// directory from the dirs list does not exist, a fatal error is raised. relDir is related to the
696// source root tree where the build action command was invoked. Each directory is validated if the
697// build file can be found and follows the format "dir1:target1,target2,...". Target is optional.
Dan Willemsence41e942019-07-29 23:39:30 -0700698func getTargetsFromDirs(ctx Context, relDir string, dirs []string, targetNamePrefix string) (targets []string) {
Patrice Arruda13848222019-04-22 17:12:02 -0700699 for _, dir := range dirs {
700 // The directory may have specified specific modules to build. ":" is the separator to separate
701 // the directory and the list of modules.
702 s := strings.Split(dir, ":")
703 l := len(s)
704 if l > 2 { // more than one ":" was specified.
705 ctx.Fatalf("%s not in proper directory:target1,target2,... format (\":\" was specified more than once)", dir)
706 }
707
708 dir = filepath.Join(relDir, s[0])
709 if _, err := os.Stat(dir); err != nil {
710 ctx.Fatalf("couldn't find directory %s", dir)
711 }
712
713 // Verify that if there are any targets specified after ":". Each target is separated by ",".
714 var newTargets []string
715 if l == 2 && s[1] != "" {
716 newTargets = strings.Split(s[1], ",")
717 if inList("", newTargets) {
718 ctx.Fatalf("%s not in proper directory:target1,target2,... format", dir)
719 }
720 }
721
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700722 // If there are specified targets to build in dir, an android build file must exist for the one
723 // shot build. For the non-targets case, find the appropriate build file and build all the
724 // modules in dir (or the closest one in the dir path).
Patrice Arruda13848222019-04-22 17:12:02 -0700725 if len(newTargets) > 0 {
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700726 if !hasBuildFile(ctx, dir) {
Patrice Arruda13848222019-04-22 17:12:02 -0700727 ctx.Fatalf("Couldn't locate a build file from %s directory", dir)
728 }
729 } else {
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700730 buildFile := findBuildFile(ctx, dir)
731 if buildFile == "" {
732 ctx.Fatalf("Build file not found for %s directory", dir)
733 }
734 newTargets = []string{convertToTarget(filepath.Dir(buildFile), targetNamePrefix)}
Patrice Arruda13848222019-04-22 17:12:02 -0700735 }
736
Patrice Arruda13848222019-04-22 17:12:02 -0700737 targets = append(targets, newTargets...)
738 }
739
Dan Willemsence41e942019-07-29 23:39:30 -0700740 return targets
Patrice Arruda13848222019-04-22 17:12:02 -0700741}
742
Dan Willemsen9b587492017-07-10 22:13:00 -0700743func (c *configImpl) parseArgs(ctx Context, args []string) {
744 for i := 0; i < len(args); i++ {
745 arg := strings.TrimSpace(args[i])
Anton Hansson5a7861a2021-06-04 10:09:01 +0100746 if arg == "showcommands" {
Dan Willemsen9b587492017-07-10 22:13:00 -0700747 c.verbose = true
Lukacs T. Berkicef87b62021-08-10 15:01:13 +0200748 } else if arg == "--empty-ninja-file" {
749 c.emptyNinjaFile = true
Lukacs T. Berkid1e3f1f2021-03-16 08:55:23 +0100750 } else if arg == "--skip-ninja" {
751 c.skipNinja = true
Dan Willemsene0879fc2017-08-04 15:06:27 -0700752 } else if arg == "--skip-make" {
Colin Cross30e444b2021-06-18 11:26:19 -0700753 // TODO(ccross): deprecate this, it has confusing behaviors. It doesn't run kati,
754 // but it does run a Kati ninja file if the .kati_enabled marker file was created
755 // by a previous build.
Anton Hansson5e5c48b2020-11-27 12:35:20 +0000756 c.skipConfig = true
757 c.skipKati = true
Anton Hansson0b55bdb2021-06-04 10:08:08 +0100758 } else if arg == "--soong-only" {
759 c.skipKati = true
760 c.skipKatiNinja = true
Lukacs T. Berkicef87b62021-08-10 15:01:13 +0200761 } else if arg == "--config-only" {
762 c.skipKati = true
763 c.skipKatiNinja = true
764 c.skipSoong = true
Colin Cross30e444b2021-06-18 11:26:19 -0700765 } else if arg == "--skip-config" {
766 c.skipConfig = true
Colin Cross00a8a3f2020-10-29 14:08:31 -0700767 } else if arg == "--skip-soong-tests" {
768 c.skipSoongTests = true
MarkDacekd0e7cd32022-12-02 22:22:40 +0000769 } else if arg == "--skip-metrics-upload" {
770 c.skipMetricsUpload = true
Chris Parsons53f68ae2022-03-03 12:01:40 -0500771 } else if arg == "--mk-metrics" {
772 c.reportMkMetrics = true
LaMont Jones52a72432023-03-09 18:19:35 +0000773 } else if arg == "--multitree-build" {
774 c.multitreeBuild = true
Chris Parsonsef615e52022-08-18 22:04:11 -0400775 } else if arg == "--bazel-mode" {
776 c.bazelProdMode = true
MarkDacekb78465d2022-10-18 20:10:16 +0000777 } else if arg == "--bazel-mode-staging" {
778 c.bazelStagingMode = true
Spandan Das394aa322022-11-03 17:02:10 +0000779 } else if arg == "--search-api-dir" {
780 c.searchApiDir = true
Jeongik Cha0cf44d52023-03-15 00:10:45 +0900781 } else if strings.HasPrefix(arg, "--ninja_weight_source=") {
782 source := strings.TrimPrefix(arg, "--ninja_weight_source=")
783 if source == "ninja_log" {
784 c.ninjaWeightListSource = NINJA_LOG
785 } else if source == "evenly_distributed" {
786 c.ninjaWeightListSource = EVENLY_DISTRIBUTED
787 } else if source == "not_used" {
788 c.ninjaWeightListSource = NOT_USED
Jeongik Chae114e602023-03-19 00:12:39 +0900789 } else if source == "soong" {
790 c.ninjaWeightListSource = HINT_FROM_SOONG
Jeongik Cha518f3ea2023-03-19 00:12:39 +0900791 } else if strings.HasPrefix(source, "file,") {
792 c.ninjaWeightListSource = EXTERNAL_FILE
793 filePath := strings.TrimPrefix(source, "file,")
794 err := validateNinjaWeightList(filePath)
795 if err != nil {
796 ctx.Fatalf("Malformed weight list from %s: %s", filePath, err)
797 }
798 _, err = copyFile(filePath, filepath.Join(c.OutDir(), ".ninja_weight_list"))
799 if err != nil {
800 ctx.Fatalf("Error to copy ninja weight list from %s: %s", filePath, err)
801 }
Jeongik Cha0cf44d52023-03-15 00:10:45 +0900802 } else {
803 ctx.Fatalf("unknown option for ninja_weight_source: %s", source)
804 }
Jihoon Kang1bff0342023-01-17 20:40:22 +0000805 } else if arg == "--build-from-text-stub" {
806 c.buildFromTextStub = true
MarkDacekb96561e2022-12-02 04:34:43 +0000807 } else if strings.HasPrefix(arg, "--build-command=") {
808 buildCmd := strings.TrimPrefix(arg, "--build-command=")
809 // remove quotations
810 buildCmd = strings.TrimPrefix(buildCmd, "\"")
811 buildCmd = strings.TrimSuffix(buildCmd, "\"")
812 ctx.Metrics.SetBuildCommand([]string{buildCmd})
MarkDacekd06db5d2022-11-29 00:47:59 +0000813 } else if strings.HasPrefix(arg, "--bazel-force-enabled-modules=") {
814 c.bazelForceEnabledModules = strings.TrimPrefix(arg, "--bazel-force-enabled-modules=")
MarkDacek6614d9c2022-12-07 21:57:38 +0000815 } else if strings.HasPrefix(arg, "--build-started-time-unix-millis=") {
816 buildTimeStr := strings.TrimPrefix(arg, "--build-started-time-unix-millis=")
817 val, err := strconv.ParseInt(buildTimeStr, 10, 64)
818 if err == nil {
819 c.buildStartedTime = val
820 } else {
821 ctx.Fatalf("Error parsing build-time-started-unix-millis", err)
822 }
MarkDacekf47e1422023-04-19 16:47:36 +0000823 } else if arg == "--ensure-allowlist-integrity" {
824 c.ensureAllowlistIntegrity = true
MarkDacekd33c2fd2023-05-04 20:40:04 +0000825 } else if strings.HasPrefix(arg, "--bazel-exit-code=") {
826 bazelExitCodeStr := strings.TrimPrefix(arg, "--bazel-exit-code=")
827 val, err := strconv.Atoi(bazelExitCodeStr)
828 if err == nil {
829 c.bazelExitCode = int32(val)
830 } else {
831 ctx.Fatalf("Error parsing bazel-exit-code", err)
832 }
MarkDacek396491e2023-06-14 19:41:18 +0000833 } else if strings.HasPrefix(arg, "--bes-id=") {
834 c.besId = strings.TrimPrefix(arg, "--bes-id=")
Dan Willemsen6ac63ef2017-10-17 20:35:34 -0700835 } else if len(arg) > 0 && arg[0] == '-' {
Dan Willemsen9b587492017-07-10 22:13:00 -0700836 parseArgNum := func(def int) int {
837 if len(arg) > 2 {
838 p, err := strconv.ParseUint(arg[2:], 10, 31)
839 if err != nil {
840 ctx.Fatalf("Failed to parse %q: %v", arg, err)
841 }
842 return int(p)
843 } else if i+1 < len(args) {
844 p, err := strconv.ParseUint(args[i+1], 10, 31)
845 if err == nil {
846 i++
847 return int(p)
848 }
849 }
850 return def
851 }
852
Dan Willemsen6ac63ef2017-10-17 20:35:34 -0700853 if len(arg) > 1 && arg[1] == 'j' {
Dan Willemsen9b587492017-07-10 22:13:00 -0700854 c.parallel = parseArgNum(c.parallel)
Dan Willemsen6ac63ef2017-10-17 20:35:34 -0700855 } else if len(arg) > 1 && arg[1] == 'k' {
Dan Willemsen9b587492017-07-10 22:13:00 -0700856 c.keepGoing = parseArgNum(0)
Dan Willemsen1e704462016-08-21 15:17:17 -0700857 } else {
858 ctx.Fatalln("Unknown option:", arg)
859 }
Dan Willemsen091525e2017-07-11 14:17:50 -0700860 } else if k, v, ok := decodeKeyValue(arg); ok && len(k) > 0 {
Dan Willemsen6dfe30a2018-09-10 12:41:10 -0700861 if k == "OUT_DIR" {
862 ctx.Fatalln("OUT_DIR may only be set in the environment, not as a command line option.")
863 }
Dan Willemsen091525e2017-07-11 14:17:50 -0700864 c.environ.Set(k, v)
Dan Willemsen2d31a442018-10-20 21:33:41 -0700865 } else if arg == "dist" {
866 c.dist = true
Lukacs T. Berkia1b93722021-09-02 17:23:06 +0200867 } else if arg == "json-module-graph" {
868 c.jsonModuleGraph = true
869 } else if arg == "bp2build" {
870 c.bp2build = true
Lukacs T. Berki3a821692021-09-06 17:08:02 +0200871 } else if arg == "queryview" {
872 c.queryview = true
Lukacs T. Berkic6012f32021-09-06 18:31:46 +0200873 } else if arg == "soong_docs" {
874 c.soongDocs = true
Dan Willemsen1e704462016-08-21 15:17:17 -0700875 } else {
Dan Willemsen2d31a442018-10-20 21:33:41 -0700876 if arg == "checkbuild" {
Colin Cross37193492017-11-16 17:55:00 -0800877 c.checkbuild = true
Dan Willemsene0879fc2017-08-04 15:06:27 -0700878 }
Dan Willemsen9b587492017-07-10 22:13:00 -0700879 c.arguments = append(c.arguments, arg)
Dan Willemsen1e704462016-08-21 15:17:17 -0700880 }
881 }
Chris Parsons21f80272023-06-15 04:02:28 +0000882 if (!c.bazelProdMode) && (!c.bazelStagingMode) {
Chris Parsonsb6e96902022-10-31 20:08:45 -0400883 c.bazelProdMode = defaultBazelProdMode(c)
884 }
Dan Willemsen1e704462016-08-21 15:17:17 -0700885}
886
Jeongik Cha518f3ea2023-03-19 00:12:39 +0900887func validateNinjaWeightList(weightListFilePath string) (err error) {
888 data, err := os.ReadFile(weightListFilePath)
889 if err != nil {
890 return
891 }
892 lines := strings.Split(strings.TrimSpace(string(data)), "\n")
893 for _, line := range lines {
894 fields := strings.Split(line, ",")
895 if len(fields) != 2 {
896 return fmt.Errorf("wrong format, each line should have two fields, but '%s'", line)
897 }
898 _, err = strconv.Atoi(fields[1])
899 if err != nil {
900 return
901 }
902 }
903 return
904}
905
Dan Willemsened869522018-01-08 14:58:46 -0800906func (c *configImpl) configureLocale(ctx Context) {
907 cmd := Command(ctx, Config{c}, "locale", "locale", "-a")
908 output, err := cmd.Output()
909
910 var locales []string
911 if err == nil {
912 locales = strings.Split(string(output), "\n")
913 } else {
914 // If we're unable to list the locales, let's assume en_US.UTF-8
915 locales = []string{"en_US.UTF-8"}
916 ctx.Verbosef("Failed to list locales (%q), falling back to %q", err, locales)
917 }
918
919 // gettext uses LANGUAGE, which is passed directly through
920
921 // For LANG and LC_*, only preserve the evaluated version of
922 // LC_MESSAGES
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800923 userLang := ""
Dan Willemsened869522018-01-08 14:58:46 -0800924 if lc_all, ok := c.environ.Get("LC_ALL"); ok {
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800925 userLang = lc_all
Dan Willemsened869522018-01-08 14:58:46 -0800926 } else if lc_messages, ok := c.environ.Get("LC_MESSAGES"); ok {
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800927 userLang = lc_messages
Dan Willemsened869522018-01-08 14:58:46 -0800928 } else if lang, ok := c.environ.Get("LANG"); ok {
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800929 userLang = lang
Dan Willemsened869522018-01-08 14:58:46 -0800930 }
931
932 c.environ.UnsetWithPrefix("LC_")
933
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800934 if userLang != "" {
935 c.environ.Set("LC_MESSAGES", userLang)
Dan Willemsened869522018-01-08 14:58:46 -0800936 }
937
938 // The for LANG, use C.UTF-8 if it exists (Debian currently, proposed
939 // for others)
940 if inList("C.UTF-8", locales) {
941 c.environ.Set("LANG", "C.UTF-8")
Aaron Klingd236e0e2018-08-07 19:21:36 -0500942 } else if inList("C.utf8", locales) {
943 // These normalize to the same thing
944 c.environ.Set("LANG", "C.UTF-8")
Dan Willemsened869522018-01-08 14:58:46 -0800945 } else if inList("en_US.UTF-8", locales) {
946 c.environ.Set("LANG", "en_US.UTF-8")
947 } else if inList("en_US.utf8", locales) {
948 // These normalize to the same thing
949 c.environ.Set("LANG", "en_US.UTF-8")
950 } else {
951 ctx.Fatalln("System doesn't support either C.UTF-8 or en_US.UTF-8")
952 }
953}
954
Dan Willemsen1e704462016-08-21 15:17:17 -0700955func (c *configImpl) Environment() *Environment {
956 return c.environ
957}
958
959func (c *configImpl) Arguments() []string {
960 return c.arguments
961}
962
Lukacs T. Berkia1b93722021-09-02 17:23:06 +0200963func (c *configImpl) SoongBuildInvocationNeeded() bool {
Lukacs T. Berkia1b93722021-09-02 17:23:06 +0200964 if len(c.Arguments()) > 0 {
965 // Explicit targets requested that are not special targets like b2pbuild
966 // or the JSON module graph
967 return true
968 }
969
Chris Parsons73f411b2023-06-20 21:46:57 +0000970 if !c.JsonModuleGraph() && !c.Bp2Build() && !c.Queryview() && !c.SoongDocs() {
Lukacs T. Berkia1b93722021-09-02 17:23:06 +0200971 // Command line was empty, the default Ninja target is built
972 return true
973 }
974
Liz Kammer88677422021-12-15 15:03:19 -0500975 // bp2build + dist may be used to dist bp2build logs but does not require SoongBuildInvocation
976 if c.Dist() && !c.Bp2Build() {
977 return true
978 }
979
Lukacs T. Berkia1b93722021-09-02 17:23:06 +0200980 // build.ninja doesn't need to be generated
981 return false
982}
983
Dan Willemsen1e704462016-08-21 15:17:17 -0700984func (c *configImpl) OutDir() string {
985 if outDir, ok := c.environ.Get("OUT_DIR"); ok {
Patrice Arruda19bd53e2019-07-08 17:26:47 -0700986 return outDir
Dan Willemsen1e704462016-08-21 15:17:17 -0700987 }
988 return "out"
989}
990
Dan Willemsen8a073a82017-02-04 17:30:44 -0800991func (c *configImpl) DistDir() string {
Chris Parsons19ab9a42022-08-30 13:15:04 -0400992 return c.distDir
Rupert Shuttleworth3c9f5ac2020-12-10 11:32:38 +0000993}
994
995func (c *configImpl) RealDistDir() string {
Dan Willemsen2d31a442018-10-20 21:33:41 -0700996 return c.distDir
Dan Willemsen8a073a82017-02-04 17:30:44 -0800997}
998
Dan Willemsen1e704462016-08-21 15:17:17 -0700999func (c *configImpl) NinjaArgs() []string {
Anton Hansson5e5c48b2020-11-27 12:35:20 +00001000 if c.skipKati {
Dan Willemsene0879fc2017-08-04 15:06:27 -07001001 return c.arguments
1002 }
Dan Willemsen1e704462016-08-21 15:17:17 -07001003 return c.ninjaArgs
1004}
1005
Jingwen Chen7c6089a2020-11-02 02:56:20 -05001006func (c *configImpl) BazelOutDir() string {
1007 return filepath.Join(c.OutDir(), "bazel")
1008}
1009
Liz Kammer2af5ea82022-11-11 14:21:03 -05001010func (c *configImpl) bazelOutputBase() string {
1011 return filepath.Join(c.BazelOutDir(), "output")
1012}
1013
Dan Willemsen1e704462016-08-21 15:17:17 -07001014func (c *configImpl) SoongOutDir() string {
1015 return filepath.Join(c.OutDir(), "soong")
1016}
1017
Spandan Das394aa322022-11-03 17:02:10 +00001018func (c *configImpl) ApiSurfacesOutDir() string {
1019 return filepath.Join(c.OutDir(), "api_surfaces")
1020}
1021
Lukacs T. Berkia806e412021-09-01 08:57:48 +02001022func (c *configImpl) PrebuiltOS() string {
1023 switch runtime.GOOS {
1024 case "linux":
1025 return "linux-x86"
1026 case "darwin":
1027 return "darwin-x86"
1028 default:
1029 panic("Unknown GOOS")
1030 }
1031}
Lukacs T. Berki90b43342021-11-02 14:42:04 +01001032
Lukacs T. Berkia806e412021-09-01 08:57:48 +02001033func (c *configImpl) HostToolDir() string {
Colin Crossacfcc1f2021-10-25 15:40:32 -07001034 if c.SkipKatiNinja() {
1035 return filepath.Join(c.SoongOutDir(), "host", c.PrebuiltOS(), "bin")
1036 } else {
1037 return filepath.Join(c.OutDir(), "host", c.PrebuiltOS(), "bin")
1038 }
Lukacs T. Berkia806e412021-09-01 08:57:48 +02001039}
1040
Lukacs T. Berki89fcdcb2021-09-07 09:10:33 +02001041func (c *configImpl) NamedGlobFile(name string) string {
Lukacs T. Berki90b43342021-11-02 14:42:04 +01001042 return shared.JoinPath(c.SoongOutDir(), "globs-"+name+".ninja")
Lukacs T. Berki89fcdcb2021-09-07 09:10:33 +02001043}
1044
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +02001045func (c *configImpl) UsedEnvFile(tag string) string {
Kiyoung Kimeaa55a82023-06-05 16:56:49 +09001046 if v, ok := c.environ.Get("TARGET_PRODUCT"); ok {
1047 return shared.JoinPath(c.SoongOutDir(), usedEnvFile+"."+v+"."+tag)
1048 }
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +02001049 return shared.JoinPath(c.SoongOutDir(), usedEnvFile+"."+tag)
1050}
1051
Lukacs T. Berkic541cd22022-10-26 07:26:50 +00001052func (c *configImpl) Bp2BuildFilesMarkerFile() string {
1053 return shared.JoinPath(c.SoongOutDir(), "bp2build_files_marker")
1054}
1055
1056func (c *configImpl) Bp2BuildWorkspaceMarkerFile() string {
Lukacs T. Berki90b43342021-11-02 14:42:04 +01001057 return shared.JoinPath(c.SoongOutDir(), "bp2build_workspace_marker")
Lukacs T. Berki56ebaf32021-08-12 14:03:55 +02001058}
1059
Lukacs T. Berkic6012f32021-09-06 18:31:46 +02001060func (c *configImpl) SoongDocsHtml() string {
1061 return shared.JoinPath(c.SoongOutDir(), "docs/soong_build.html")
1062}
1063
Lukacs T. Berki3a821692021-09-06 17:08:02 +02001064func (c *configImpl) QueryviewMarkerFile() string {
1065 return shared.JoinPath(c.SoongOutDir(), "queryview.marker")
1066}
1067
Lukacs T. Berkie571dc32021-08-25 14:14:13 +02001068func (c *configImpl) ModuleGraphFile() string {
1069 return shared.JoinPath(c.SoongOutDir(), "module-graph.json")
1070}
1071
kgui67007242022-01-25 13:50:25 +08001072func (c *configImpl) ModuleActionsFile() string {
1073 return shared.JoinPath(c.SoongOutDir(), "module-actions.json")
1074}
1075
Jeff Gastonefc1b412017-03-29 17:29:06 -07001076func (c *configImpl) TempDir() string {
1077 return shared.TempDirForOutDir(c.SoongOutDir())
1078}
1079
Jeff Gastonb64fc1c2017-08-04 12:30:12 -07001080func (c *configImpl) FileListDir() string {
1081 return filepath.Join(c.OutDir(), ".module_paths")
1082}
1083
Dan Willemsen1e704462016-08-21 15:17:17 -07001084func (c *configImpl) KatiSuffix() string {
1085 if c.katiSuffix != "" {
1086 return c.katiSuffix
1087 }
1088 panic("SetKatiSuffix has not been called")
1089}
1090
Colin Cross37193492017-11-16 17:55:00 -08001091// Checkbuild returns true if "checkbuild" was one of the build goals, which means that the
1092// user is interested in additional checks at the expense of build time.
1093func (c *configImpl) Checkbuild() bool {
1094 return c.checkbuild
1095}
1096
Dan Willemsen8a073a82017-02-04 17:30:44 -08001097func (c *configImpl) Dist() bool {
1098 return c.dist
1099}
1100
Lukacs T. Berkia1b93722021-09-02 17:23:06 +02001101func (c *configImpl) JsonModuleGraph() bool {
1102 return c.jsonModuleGraph
1103}
1104
1105func (c *configImpl) Bp2Build() bool {
1106 return c.bp2build
1107}
1108
Lukacs T. Berki3a821692021-09-06 17:08:02 +02001109func (c *configImpl) Queryview() bool {
1110 return c.queryview
1111}
1112
Lukacs T. Berkic6012f32021-09-06 18:31:46 +02001113func (c *configImpl) SoongDocs() bool {
1114 return c.soongDocs
1115}
1116
Dan Willemsen1e704462016-08-21 15:17:17 -07001117func (c *configImpl) IsVerbose() bool {
1118 return c.verbose
1119}
1120
LaMont Jones52a72432023-03-09 18:19:35 +00001121func (c *configImpl) MultitreeBuild() bool {
1122 return c.multitreeBuild
1123}
1124
Jeongik Cha0cf44d52023-03-15 00:10:45 +09001125func (c *configImpl) NinjaWeightListSource() NinjaWeightListSource {
1126 return c.ninjaWeightListSource
1127}
1128
Anton Hansson5e5c48b2020-11-27 12:35:20 +00001129func (c *configImpl) SkipKati() bool {
1130 return c.skipKati
1131}
1132
Anton Hansson0b55bdb2021-06-04 10:08:08 +01001133func (c *configImpl) SkipKatiNinja() bool {
1134 return c.skipKatiNinja
1135}
1136
Lukacs T. Berkicef87b62021-08-10 15:01:13 +02001137func (c *configImpl) SkipSoong() bool {
1138 return c.skipSoong
1139}
1140
Lukacs T. Berkid1e3f1f2021-03-16 08:55:23 +01001141func (c *configImpl) SkipNinja() bool {
1142 return c.skipNinja
1143}
1144
Anton Hansson5a7861a2021-06-04 10:09:01 +01001145func (c *configImpl) SetSkipNinja(v bool) {
1146 c.skipNinja = v
1147}
1148
Anton Hansson5e5c48b2020-11-27 12:35:20 +00001149func (c *configImpl) SkipConfig() bool {
1150 return c.skipConfig
Dan Willemsene0879fc2017-08-04 15:06:27 -07001151}
1152
Jihoon Kang1bff0342023-01-17 20:40:22 +00001153func (c *configImpl) BuildFromTextStub() bool {
1154 return c.buildFromTextStub
1155}
1156
Dan Willemsen1e704462016-08-21 15:17:17 -07001157func (c *configImpl) TargetProduct() string {
1158 if v, ok := c.environ.Get("TARGET_PRODUCT"); ok {
1159 return v
1160 }
1161 panic("TARGET_PRODUCT is not defined")
1162}
1163
Kiyoung Kima37d9ba2023-04-19 13:13:45 +09001164func (c *configImpl) TargetProductOrErr() (string, error) {
1165 if v, ok := c.environ.Get("TARGET_PRODUCT"); ok {
1166 return v, nil
1167 }
1168 return "", fmt.Errorf("TARGET_PRODUCT is not defined")
1169}
1170
Dan Willemsen02781d52017-05-12 19:28:13 -07001171func (c *configImpl) TargetDevice() string {
1172 return c.targetDevice
1173}
1174
1175func (c *configImpl) SetTargetDevice(device string) {
1176 c.targetDevice = device
1177}
1178
1179func (c *configImpl) TargetBuildVariant() string {
1180 if v, ok := c.environ.Get("TARGET_BUILD_VARIANT"); ok {
1181 return v
1182 }
1183 panic("TARGET_BUILD_VARIANT is not defined")
1184}
1185
Dan Willemsen1e704462016-08-21 15:17:17 -07001186func (c *configImpl) KatiArgs() []string {
1187 return c.katiArgs
1188}
1189
1190func (c *configImpl) Parallel() int {
1191 return c.parallel
1192}
1193
Sam Delmerico98a73292023-02-21 11:50:29 -05001194func (c *configImpl) GetSourceRootDirs() []string {
1195 return c.sourceRootDirs
1196}
1197
1198func (c *configImpl) SetSourceRootDirs(i []string) {
1199 c.sourceRootDirs = i
1200}
1201
Spandan Dasc5763832022-11-08 18:42:16 +00001202func (c *configImpl) GetIncludeTags() []string {
1203 return c.includeTags
1204}
1205
1206func (c *configImpl) SetIncludeTags(i []string) {
1207 c.includeTags = i
1208}
1209
MarkDacek6614d9c2022-12-07 21:57:38 +00001210func (c *configImpl) GetLogsPrefix() string {
1211 return c.logsPrefix
1212}
1213
1214func (c *configImpl) SetLogsPrefix(prefix string) {
1215 c.logsPrefix = prefix
1216}
1217
Colin Cross8b8bec32019-11-15 13:18:43 -08001218func (c *configImpl) HighmemParallel() int {
1219 if i, ok := c.environ.GetInt("NINJA_HIGHMEM_NUM_JOBS"); ok {
1220 return i
1221 }
1222
1223 const minMemPerHighmemProcess = 8 * 1024 * 1024 * 1024
1224 parallel := c.Parallel()
1225 if c.UseRemoteBuild() {
1226 // Ninja doesn't support nested pools, and when remote builds are enabled the total ninja parallelism
1227 // is set very high (i.e. 500). Using a large value here would cause the total number of running jobs
1228 // to be the sum of the sizes of the local and highmem pools, which will cause extra CPU contention.
1229 // Return 1/16th of the size of the local pool, rounding up.
1230 return (parallel + 15) / 16
1231 } else if c.totalRAM == 0 {
1232 // Couldn't detect the total RAM, don't restrict highmem processes.
1233 return parallel
Dan Willemsen570a2922020-05-26 23:02:29 -07001234 } else if c.totalRAM <= 16*1024*1024*1024 {
1235 // Less than 16GB of ram, restrict to 1 highmem processes
1236 return 1
Colin Cross8b8bec32019-11-15 13:18:43 -08001237 } else if c.totalRAM <= 32*1024*1024*1024 {
1238 // Less than 32GB of ram, restrict to 2 highmem processes
1239 return 2
1240 } else if p := int(c.totalRAM / minMemPerHighmemProcess); p < parallel {
1241 // If less than 8GB total RAM per process, reduce the number of highmem processes
1242 return p
1243 }
1244 // No restriction on highmem processes
1245 return parallel
1246}
1247
Dan Willemsen2bb82d02019-12-27 09:35:42 -08001248func (c *configImpl) TotalRAM() uint64 {
1249 return c.totalRAM
1250}
1251
Kousik Kumarec478642020-09-21 13:39:24 -04001252// ForceUseGoma determines whether we should override Goma deprecation
1253// and use Goma for the current build or not.
1254func (c *configImpl) ForceUseGoma() bool {
1255 if v, ok := c.environ.Get("FORCE_USE_GOMA"); ok {
1256 v = strings.TrimSpace(v)
1257 if v != "" && v != "false" {
1258 return true
1259 }
1260 }
1261 return false
1262}
1263
Dan Willemsen1e704462016-08-21 15:17:17 -07001264func (c *configImpl) UseGoma() bool {
1265 if v, ok := c.environ.Get("USE_GOMA"); ok {
1266 v = strings.TrimSpace(v)
1267 if v != "" && v != "false" {
1268 return true
1269 }
1270 }
1271 return false
1272}
1273
Yoshisato Yanagisawa2cb0e5d2019-01-10 10:14:16 +09001274func (c *configImpl) StartGoma() bool {
1275 if !c.UseGoma() {
1276 return false
1277 }
1278
1279 if v, ok := c.environ.Get("NOSTART_GOMA"); ok {
1280 v = strings.TrimSpace(v)
1281 if v != "" && v != "false" {
1282 return false
1283 }
1284 }
1285 return true
1286}
1287
Kousik Kumar6d1e3482023-07-24 03:44:16 +00001288func (c *configImpl) canSupportRBE() bool {
1289 // Do not use RBE with prod credentials in scenarios when stubby doesn't exist, since
1290 // its unlikely that we will be able to obtain necessary creds without stubby.
1291 authType, _ := c.rbeAuth()
1292 if !c.StubbyExists() && strings.Contains(authType, "use_google_prod_creds") {
1293 return false
1294 }
1295 return true
1296}
1297
Ramy Medhatbbf25672019-07-17 12:30:04 +00001298func (c *configImpl) UseRBE() bool {
Jingwen Chend7ccde12023-06-28 07:19:26 +00001299 // These alternate modes of running Soong do not use RBE / reclient.
Chris Parsons73f411b2023-06-20 21:46:57 +00001300 if c.Bp2Build() || c.Queryview() || c.JsonModuleGraph() {
Jingwen Chend7ccde12023-06-28 07:19:26 +00001301 return false
1302 }
1303
Kousik Kumar6d1e3482023-07-24 03:44:16 +00001304 if !c.canSupportRBE() {
Kousik Kumar67ad4342023-06-06 15:09:27 -04001305 return false
1306 }
Kousik Kumar6d1e3482023-07-24 03:44:16 +00001307
Kousik Kumar3ff037e2022-01-25 22:11:01 -05001308 if v, ok := c.Environment().Get("USE_RBE"); ok {
Ramy Medhatbbf25672019-07-17 12:30:04 +00001309 v = strings.TrimSpace(v)
1310 if v != "" && v != "false" {
1311 return true
1312 }
1313 }
1314 return false
1315}
1316
Chris Parsonsef615e52022-08-18 22:04:11 -04001317func (c *configImpl) BazelBuildEnabled() bool {
Chris Parsons21f80272023-06-15 04:02:28 +00001318 return c.bazelProdMode || c.bazelStagingMode
Chris Parsonsec1a3dc2021-04-20 15:32:07 -04001319}
1320
Ramy Medhatbbf25672019-07-17 12:30:04 +00001321func (c *configImpl) StartRBE() bool {
1322 if !c.UseRBE() {
1323 return false
1324 }
1325
1326 if v, ok := c.environ.Get("NOSTART_RBE"); ok {
1327 v = strings.TrimSpace(v)
1328 if v != "" && v != "false" {
1329 return false
1330 }
1331 }
1332 return true
1333}
1334
Kousik Kumar4c180ad2022-05-27 07:48:37 -04001335func (c *configImpl) rbeProxyLogsDir() string {
1336 for _, f := range []string{"RBE_proxy_log_dir", "FLAG_output_dir"} {
Kousik Kumar0d15a722020-09-23 02:54:11 -04001337 if v, ok := c.environ.Get(f); ok {
1338 return v
1339 }
1340 }
Kousik Kumar4c180ad2022-05-27 07:48:37 -04001341 buildTmpDir := shared.TempDirForOutDir(c.SoongOutDir())
1342 return filepath.Join(buildTmpDir, "rbe")
Ramy Medhat0fc67eb2020-08-12 01:26:23 -04001343}
1344
Ramy Medhatc8f6cc22023-03-31 09:50:34 -04001345func (c *configImpl) rbeCacheDir() string {
1346 for _, f := range []string{"RBE_cache_dir", "FLAG_cache_dir"} {
1347 if v, ok := c.environ.Get(f); ok {
1348 return v
1349 }
1350 }
1351 return shared.JoinPath(c.SoongOutDir(), "rbe")
1352}
1353
Kousik Kumar4c180ad2022-05-27 07:48:37 -04001354func (c *configImpl) shouldCleanupRBELogsDir() bool {
1355 // Perform a log directory cleanup only when the log directory
1356 // is auto created by the build rather than user-specified.
1357 for _, f := range []string{"RBE_proxy_log_dir", "FLAG_output_dir"} {
1358 if _, ok := c.environ.Get(f); ok {
1359 return false
Patrice Arruda62f1bf22020-07-07 12:48:26 +00001360 }
1361 }
Kousik Kumar4c180ad2022-05-27 07:48:37 -04001362 return true
Ramy Medhat0fc67eb2020-08-12 01:26:23 -04001363}
1364
1365func (c *configImpl) rbeExecRoot() string {
1366 for _, f := range []string{"RBE_exec_root", "FLAG_exec_root"} {
1367 if v, ok := c.environ.Get(f); ok {
1368 return v
1369 }
1370 }
1371 wd, err := os.Getwd()
1372 if err != nil {
1373 return ""
1374 }
1375 return wd
1376}
1377
1378func (c *configImpl) rbeDir() string {
1379 if v, ok := c.environ.Get("RBE_DIR"); ok {
1380 return v
1381 }
1382 return "prebuilts/remoteexecution-client/live/"
1383}
1384
1385func (c *configImpl) rbeReproxy() string {
1386 for _, f := range []string{"RBE_re_proxy", "FLAG_re_proxy"} {
1387 if v, ok := c.environ.Get(f); ok {
1388 return v
1389 }
1390 }
1391 return filepath.Join(c.rbeDir(), "reproxy")
1392}
1393
1394func (c *configImpl) rbeAuth() (string, string) {
Kousik Kumar93d192c2022-03-18 01:39:56 -04001395 credFlags := []string{
1396 "use_application_default_credentials",
1397 "use_gce_credentials",
1398 "credential_file",
1399 "use_google_prod_creds",
1400 }
Ramy Medhat0fc67eb2020-08-12 01:26:23 -04001401 for _, cf := range credFlags {
1402 for _, f := range []string{"RBE_" + cf, "FLAG_" + cf} {
1403 if v, ok := c.environ.Get(f); ok {
1404 v = strings.TrimSpace(v)
1405 if v != "" && v != "false" && v != "0" {
1406 return "RBE_" + cf, v
1407 }
1408 }
1409 }
1410 }
1411 return "RBE_use_application_default_credentials", "true"
Patrice Arruda62f1bf22020-07-07 12:48:26 +00001412}
1413
Kousik Kumar4c180ad2022-05-27 07:48:37 -04001414func (c *configImpl) rbeSockAddr(dir string) (string, error) {
1415 maxNameLen := len(syscall.RawSockaddrUnix{}.Path)
1416 base := fmt.Sprintf("reproxy_%v.sock", rbeRandPrefix)
1417
1418 name := filepath.Join(dir, base)
1419 if len(name) < maxNameLen {
1420 return name, nil
1421 }
1422
1423 name = filepath.Join("/tmp", base)
1424 if len(name) < maxNameLen {
1425 return name, nil
1426 }
1427
1428 return "", fmt.Errorf("cannot generate a proxy socket address shorter than the limit of %v", maxNameLen)
1429}
1430
Kousik Kumar7bc78192022-04-27 14:52:56 -04001431// IsGooglerEnvironment returns true if the current build is running
1432// on a Google developer machine and false otherwise.
1433func (c *configImpl) IsGooglerEnvironment() bool {
1434 cf := "ANDROID_BUILD_ENVIRONMENT_CONFIG"
1435 if v, ok := c.environ.Get(cf); ok {
1436 return v == "googler"
1437 }
1438 return false
1439}
1440
1441// GoogleProdCredsExist determine whether credentials exist on the
1442// Googler machine to use remote execution.
1443func (c *configImpl) GoogleProdCredsExist() bool {
Kevin Dagostino096ab2f2023-03-03 19:47:17 +00001444 if googleProdCredsExistCache {
1445 return googleProdCredsExistCache
1446 }
andusyu0b3dc032023-06-21 17:29:32 -04001447 if _, err := exec.Command("/usr/bin/gcertstatus", "-nocheck_ssh").Output(); err != nil {
Kousik Kumar7bc78192022-04-27 14:52:56 -04001448 return false
1449 }
Kevin Dagostino096ab2f2023-03-03 19:47:17 +00001450 googleProdCredsExistCache = true
Kousik Kumar7bc78192022-04-27 14:52:56 -04001451 return true
1452}
1453
1454// UseRemoteBuild indicates whether to use a remote build acceleration system
1455// to speed up the build.
Colin Cross9016b912019-11-11 14:57:42 -08001456func (c *configImpl) UseRemoteBuild() bool {
1457 return c.UseGoma() || c.UseRBE()
1458}
1459
Kousik Kumar7bc78192022-04-27 14:52:56 -04001460// StubbyExists checks whether the stubby binary exists on the machine running
1461// the build.
1462func (c *configImpl) StubbyExists() bool {
1463 if _, err := exec.LookPath("stubby"); err != nil {
1464 return false
1465 }
1466 return true
1467}
1468
Dan Willemsen1e704462016-08-21 15:17:17 -07001469// RemoteParallel controls how many remote jobs (i.e., commands which contain
Jeff Gastonefc1b412017-03-29 17:29:06 -07001470// gomacc) are run in parallel. Note the parallelism of all other jobs is
Dan Willemsen1e704462016-08-21 15:17:17 -07001471// still limited by Parallel()
1472func (c *configImpl) RemoteParallel() int {
Colin Cross8b8bec32019-11-15 13:18:43 -08001473 if !c.UseRemoteBuild() {
1474 return 0
1475 }
1476 if i, ok := c.environ.GetInt("NINJA_REMOTE_NUM_JOBS"); ok {
1477 return i
Dan Willemsen1e704462016-08-21 15:17:17 -07001478 }
1479 return 500
1480}
1481
1482func (c *configImpl) SetKatiArgs(args []string) {
1483 c.katiArgs = args
1484}
1485
1486func (c *configImpl) SetNinjaArgs(args []string) {
1487 c.ninjaArgs = args
1488}
1489
1490func (c *configImpl) SetKatiSuffix(suffix string) {
1491 c.katiSuffix = suffix
1492}
1493
Dan Willemsene0879fc2017-08-04 15:06:27 -07001494func (c *configImpl) LastKatiSuffixFile() string {
1495 return filepath.Join(c.OutDir(), "last_kati_suffix")
1496}
1497
1498func (c *configImpl) HasKatiSuffix() bool {
1499 return c.katiSuffix != ""
1500}
1501
Dan Willemsen1e704462016-08-21 15:17:17 -07001502func (c *configImpl) KatiEnvFile() string {
1503 return filepath.Join(c.OutDir(), "env"+c.KatiSuffix()+".sh")
1504}
1505
Dan Willemsen29971232018-09-26 14:58:30 -07001506func (c *configImpl) KatiBuildNinjaFile() string {
1507 return filepath.Join(c.OutDir(), "build"+c.KatiSuffix()+katiBuildSuffix+".ninja")
Dan Willemsen1e704462016-08-21 15:17:17 -07001508}
1509
Dan Willemsenfb1271a2018-09-26 15:00:42 -07001510func (c *configImpl) KatiPackageNinjaFile() string {
1511 return filepath.Join(c.OutDir(), "build"+c.KatiSuffix()+katiPackageSuffix+".ninja")
1512}
1513
Jihoon Kang9f4f8a32022-08-16 00:57:30 +00001514func (c *configImpl) SoongVarsFile() string {
Kiyoung Kima37d9ba2023-04-19 13:13:45 +09001515 targetProduct, err := c.TargetProductOrErr()
1516 if err != nil {
1517 return filepath.Join(c.SoongOutDir(), "soong.variables")
1518 } else {
1519 return filepath.Join(c.SoongOutDir(), "soong."+targetProduct+".variables")
1520 }
Jihoon Kang9f4f8a32022-08-16 00:57:30 +00001521}
1522
Dan Willemsen1e704462016-08-21 15:17:17 -07001523func (c *configImpl) SoongNinjaFile() string {
Kiyoung Kima37d9ba2023-04-19 13:13:45 +09001524 targetProduct, err := c.TargetProductOrErr()
1525 if err != nil {
1526 return filepath.Join(c.SoongOutDir(), "build.ninja")
1527 } else {
1528 return filepath.Join(c.SoongOutDir(), "build."+targetProduct+".ninja")
1529 }
Dan Willemsen1e704462016-08-21 15:17:17 -07001530}
1531
1532func (c *configImpl) CombinedNinjaFile() string {
Dan Willemsene0879fc2017-08-04 15:06:27 -07001533 if c.katiSuffix == "" {
1534 return filepath.Join(c.OutDir(), "combined.ninja")
1535 }
Dan Willemsen1e704462016-08-21 15:17:17 -07001536 return filepath.Join(c.OutDir(), "combined"+c.KatiSuffix()+".ninja")
1537}
1538
1539func (c *configImpl) SoongAndroidMk() string {
1540 return filepath.Join(c.SoongOutDir(), "Android-"+c.TargetProduct()+".mk")
1541}
1542
1543func (c *configImpl) SoongMakeVarsMk() string {
1544 return filepath.Join(c.SoongOutDir(), "make_vars-"+c.TargetProduct()+".mk")
1545}
1546
Dan Willemsenf052f782017-05-18 15:29:04 -07001547func (c *configImpl) ProductOut() string {
Dan Willemsen4dc4e142017-09-08 14:35:43 -07001548 return filepath.Join(c.OutDir(), "target", "product", c.TargetDevice())
Dan Willemsenf052f782017-05-18 15:29:04 -07001549}
1550
Dan Willemsen02781d52017-05-12 19:28:13 -07001551func (c *configImpl) DevicePreviousProductConfig() string {
Dan Willemsenf052f782017-05-18 15:29:04 -07001552 return filepath.Join(c.ProductOut(), "previous_build_config.mk")
1553}
1554
Dan Willemsenfb1271a2018-09-26 15:00:42 -07001555func (c *configImpl) KatiPackageMkDir() string {
1556 return filepath.Join(c.ProductOut(), "obj", "CONFIG", "kati_packaging")
1557}
1558
Dan Willemsenf052f782017-05-18 15:29:04 -07001559func (c *configImpl) hostOutRoot() string {
Dan Willemsen4dc4e142017-09-08 14:35:43 -07001560 return filepath.Join(c.OutDir(), "host")
Dan Willemsenf052f782017-05-18 15:29:04 -07001561}
1562
1563func (c *configImpl) HostOut() string {
1564 return filepath.Join(c.hostOutRoot(), c.HostPrebuiltTag())
1565}
1566
1567// This probably needs to be multi-valued, so not exporting it for now
1568func (c *configImpl) hostCrossOut() string {
1569 if runtime.GOOS == "linux" {
1570 return filepath.Join(c.hostOutRoot(), "windows-x86")
1571 } else {
1572 return ""
1573 }
Dan Willemsen02781d52017-05-12 19:28:13 -07001574}
1575
Dan Willemsen1e704462016-08-21 15:17:17 -07001576func (c *configImpl) HostPrebuiltTag() string {
1577 if runtime.GOOS == "linux" {
1578 return "linux-x86"
1579 } else if runtime.GOOS == "darwin" {
1580 return "darwin-x86"
1581 } else {
1582 panic("Unsupported OS")
1583 }
1584}
Dan Willemsenf173d592017-04-27 14:28:00 -07001585
Dan Willemsen8122bd52017-10-12 20:20:41 -07001586func (c *configImpl) PrebuiltBuildTool(name string) string {
Dan Willemsenf173d592017-04-27 14:28:00 -07001587 if v, ok := c.environ.Get("SANITIZE_HOST"); ok {
1588 if sanitize := strings.Fields(v); inList("address", sanitize) {
Dan Willemsen8122bd52017-10-12 20:20:41 -07001589 asan := filepath.Join("prebuilts/build-tools", c.HostPrebuiltTag(), "asan/bin", name)
1590 if _, err := os.Stat(asan); err == nil {
1591 return asan
1592 }
Dan Willemsenf173d592017-04-27 14:28:00 -07001593 }
1594 }
1595 return filepath.Join("prebuilts/build-tools", c.HostPrebuiltTag(), "bin", name)
1596}
Dan Willemsen3d60b112018-04-04 22:25:56 -07001597
1598func (c *configImpl) SetBuildBrokenDupRules(val bool) {
1599 c.brokenDupRules = val
1600}
1601
1602func (c *configImpl) BuildBrokenDupRules() bool {
1603 return c.brokenDupRules
1604}
Dan Willemsen6ab79db2018-05-02 00:06:28 -07001605
Dan Willemsen25e6f092019-04-09 10:22:43 -07001606func (c *configImpl) SetBuildBrokenUsesNetwork(val bool) {
1607 c.brokenUsesNetwork = val
1608}
1609
1610func (c *configImpl) BuildBrokenUsesNetwork() bool {
1611 return c.brokenUsesNetwork
1612}
1613
Dan Willemsene3336352020-01-02 19:10:38 -08001614func (c *configImpl) SetBuildBrokenNinjaUsesEnvVars(val []string) {
1615 c.brokenNinjaEnvVars = val
1616}
1617
1618func (c *configImpl) BuildBrokenNinjaUsesEnvVars() []string {
1619 return c.brokenNinjaEnvVars
1620}
1621
Dan Willemsen6ab79db2018-05-02 00:06:28 -07001622func (c *configImpl) SetTargetDeviceDir(dir string) {
1623 c.targetDeviceDir = dir
1624}
1625
1626func (c *configImpl) TargetDeviceDir() string {
1627 return c.targetDeviceDir
1628}
Dan Willemsenfa42f3c2018-06-15 21:54:47 -07001629
Patrice Arruda219eef32020-06-01 17:29:30 +00001630func (c *configImpl) BuildDateTime() string {
1631 return c.buildDateTime
1632}
1633
1634func (c *configImpl) MetricsUploaderApp() string {
Yu Liu6e13b402021-07-27 14:29:06 -07001635 return c.metricsUploader
Patrice Arruda219eef32020-06-01 17:29:30 +00001636}
Patrice Arruda83842d72020-12-08 19:42:08 +00001637
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux947fdbf2021-11-10 09:55:20 -05001638// LogsDir returns the absolute path to the logs directory where build log and
1639// metrics files are located. By default, the logs directory is the out
Patrice Arruda83842d72020-12-08 19:42:08 +00001640// directory. If the argument dist is specified, the logs directory
1641// is <dist_dir>/logs.
1642func (c *configImpl) LogsDir() string {
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux947fdbf2021-11-10 09:55:20 -05001643 dir := c.OutDir()
Patrice Arruda83842d72020-12-08 19:42:08 +00001644 if c.Dist() {
Rupert Shuttleworth3c9f5ac2020-12-10 11:32:38 +00001645 // 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 -05001646 dir = filepath.Join(c.RealDistDir(), "logs")
Patrice Arruda83842d72020-12-08 19:42:08 +00001647 }
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux947fdbf2021-11-10 09:55:20 -05001648 absDir, err := filepath.Abs(dir)
1649 if err != nil {
1650 fmt.Fprintf(os.Stderr, "\nError making log dir '%s' absolute: %s\n", dir, err.Error())
1651 os.Exit(1)
1652 }
1653 return absDir
Patrice Arruda83842d72020-12-08 19:42:08 +00001654}
1655
1656// BazelMetricsDir returns the <logs dir>/bazel_metrics directory
1657// where the bazel profiles are located.
1658func (c *configImpl) BazelMetricsDir() string {
1659 return filepath.Join(c.LogsDir(), "bazel_metrics")
1660}
Colin Crossf3bdbcb2021-06-01 11:43:55 -07001661
Chris Parsons53f68ae2022-03-03 12:01:40 -05001662// MkFileMetrics returns the file path for make-related metrics.
1663func (c *configImpl) MkMetrics() string {
1664 return filepath.Join(c.LogsDir(), "mk_metrics.pb")
1665}
1666
Colin Crossf3bdbcb2021-06-01 11:43:55 -07001667func (c *configImpl) SetEmptyNinjaFile(v bool) {
1668 c.emptyNinjaFile = v
1669}
1670
1671func (c *configImpl) EmptyNinjaFile() bool {
1672 return c.emptyNinjaFile
1673}
Yu Liu6e13b402021-07-27 14:29:06 -07001674
Romain Jobredeaux0a7529b2022-10-26 12:56:41 -04001675func (c *configImpl) IsBazelMixedBuildForceDisabled() bool {
1676 return c.Environment().IsEnvTrue("BUILD_BROKEN_DISABLE_BAZEL")
1677}
1678
Chris Parsons9402ca82023-02-23 17:28:06 -05001679func (c *configImpl) IsPersistentBazelEnabled() bool {
1680 return c.Environment().IsEnvTrue("USE_PERSISTENT_BAZEL")
1681}
1682
Chris Parsonsc83398f2023-05-31 18:41:41 +00001683// GetBazeliskBazelVersion returns the Bazel version to use for this build,
1684// or the empty string if the current canonical prod Bazel should be used.
1685// This environment variable should only be set to debug the build system.
1686// The Bazel version, if set, will be passed to Bazelisk, and Bazelisk will
1687// handle downloading and invoking the correct Bazel binary.
1688func (c *configImpl) GetBazeliskBazelVersion() string {
1689 value, _ := c.Environment().Get("USE_BAZEL_VERSION")
1690 return value
1691}
1692
MarkDacekd06db5d2022-11-29 00:47:59 +00001693func (c *configImpl) BazelModulesForceEnabledByFlag() string {
1694 return c.bazelForceEnabledModules
1695}
1696
MarkDacekd0e7cd32022-12-02 22:22:40 +00001697func (c *configImpl) SkipMetricsUpload() bool {
1698 return c.skipMetricsUpload
1699}
1700
MarkDacekf47e1422023-04-19 16:47:36 +00001701func (c *configImpl) EnsureAllowlistIntegrity() bool {
1702 return c.ensureAllowlistIntegrity
1703}
1704
MarkDacek6614d9c2022-12-07 21:57:38 +00001705// Returns a Time object if one was passed via a command-line flag.
1706// Otherwise returns the passed default.
1707func (c *configImpl) BuildStartedTimeOrDefault(defaultTime time.Time) time.Time {
1708 if c.buildStartedTime == 0 {
1709 return defaultTime
1710 }
1711 return time.UnixMilli(c.buildStartedTime)
1712}
1713
MarkDacekd33c2fd2023-05-04 20:40:04 +00001714func (c *configImpl) BazelExitCode() int32 {
1715 return c.bazelExitCode
1716}
1717
Yu Liu6e13b402021-07-27 14:29:06 -07001718func GetMetricsUploader(topDir string, env *Environment) string {
1719 if p, ok := env.Get("METRICS_UPLOADER"); ok {
1720 metricsUploader := filepath.Join(topDir, p)
1721 if _, err := os.Stat(metricsUploader); err == nil {
1722 return metricsUploader
1723 }
1724 }
1725
1726 return ""
1727}