blob: 9c7f5586a2ddfedbb1abc254147d05cbeb901bab [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 (
48 rbeRandPrefix int
49)
50
51func init() {
52 rand.Seed(time.Now().UnixNano())
53 rbeRandPrefix = rand.Intn(1000)
54}
55
Dan Willemsen1e704462016-08-21 15:17:17 -070056type Config struct{ *configImpl }
57
58type configImpl struct {
Lukacs T. Berkia1b93722021-09-02 17:23:06 +020059 // Some targets that are implemented in soong_build
60 // (bp2build, json-module-graph) are not here and have their own bits below.
Colin Cross28f527c2019-11-26 16:19:04 -080061 arguments []string
62 goma bool
63 environ *Environment
64 distDir string
65 buildDateTime string
MarkDacek6614d9c2022-12-07 21:57:38 +000066 logsPrefix string
Dan Willemsen1e704462016-08-21 15:17:17 -070067
68 // From the arguments
MarkDacekd0e7cd32022-12-02 22:22:40 +000069 parallel int
70 keepGoing int
71 verbose bool
72 checkbuild bool
73 dist bool
74 jsonModuleGraph bool
75 apiBp2build bool // Generate BUILD files for Soong modules that contribute APIs
76 bp2build bool
77 queryview bool
78 reportMkMetrics bool // Collect and report mk2bp migration progress metrics.
79 soongDocs bool
LaMont Jones52a72432023-03-09 18:19:35 +000080 multitreeBuild bool // This is a multitree build.
MarkDacekd0e7cd32022-12-02 22:22:40 +000081 skipConfig bool
82 skipKati bool
83 skipKatiNinja bool
84 skipSoong bool
85 skipNinja bool
86 skipSoongTests bool
87 searchApiDir bool // Scan the Android.bp files generated in out/api_surfaces
88 skipMetricsUpload bool
MarkDacek6614d9c2022-12-07 21:57:38 +000089 buildStartedTime int64 // For metrics-upload-only - manually specify a build-started time
Dan Willemsen1e704462016-08-21 15:17:17 -070090
91 // From the product config
Dan Willemsen6ab79db2018-05-02 00:06:28 -070092 katiArgs []string
93 ninjaArgs []string
94 katiSuffix string
95 targetDevice string
96 targetDeviceDir string
Spandan Dasa3639e62021-05-25 19:14:02 +000097 sandboxConfig *SandboxConfig
Dan Willemsen3d60b112018-04-04 22:25:56 -070098
Dan Willemsen2bb82d02019-12-27 09:35:42 -080099 // Autodetected
100 totalRAM uint64
101
Dan Willemsene3336352020-01-02 19:10:38 -0800102 brokenDupRules bool
103 brokenUsesNetwork bool
104 brokenNinjaEnvVars []string
Dan Willemsen18490112018-05-25 16:30:04 -0700105
106 pathReplaced bool
Rupert Shuttleworth3c9f5ac2020-12-10 11:32:38 +0000107
MarkDacekb78465d2022-10-18 20:10:16 +0000108 bazelProdMode bool
109 bazelDevMode bool
110 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
119 includeTags []string
Dan Willemsen1e704462016-08-21 15:17:17 -0700120}
121
Dan Willemsenc2af0be2017-01-20 14:10:01 -0800122const srcDirFileCheck = "build/soong/root.bp"
123
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700124var buildFiles = []string{"Android.mk", "Android.bp"}
125
Patrice Arruda13848222019-04-22 17:12:02 -0700126type BuildAction uint
127
128const (
129 // Builds all of the modules and their dependencies of a specified directory, relative to the root
130 // directory of the source tree.
131 BUILD_MODULES_IN_A_DIRECTORY BuildAction = iota
132
133 // Builds all of the modules and their dependencies of a list of specified directories. All specified
134 // directories are relative to the root directory of the source tree.
135 BUILD_MODULES_IN_DIRECTORIES
Patrice Arruda39282062019-06-20 16:35:12 -0700136
137 // Build a list of specified modules. If none was specified, simply build the whole source tree.
138 BUILD_MODULES
Patrice Arruda13848222019-04-22 17:12:02 -0700139)
140
141// checkTopDir validates that the current directory is at the root directory of the source tree.
142func checkTopDir(ctx Context) {
143 if _, err := os.Stat(srcDirFileCheck); err != nil {
144 if os.IsNotExist(err) {
145 ctx.Fatalf("Current working directory must be the source tree. %q not found.", srcDirFileCheck)
146 }
147 ctx.Fatalln("Error verifying tree state:", err)
148 }
149}
150
Kousik Kumarc8818332023-01-16 16:33:05 +0000151// fetchEnvConfig optionally fetches a configuration file that can then subsequently be
152// loaded into Soong environment to control certain aspects of build behavior (e.g., enabling RBE).
153// If a configuration file already exists on disk, the fetch is run in the background
154// so as to NOT block the rest of the build execution.
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500155func fetchEnvConfig(ctx Context, config *configImpl, envConfigName string) error {
David Goldsmith62243a32022-04-08 13:42:04 +0000156 configName := envConfigName + "." + jsonSuffix
Kousik Kumarc75e1292022-07-07 02:20:51 +0000157 expConfigFetcher := &smpb.ExpConfigFetcher{Filename: &configName}
David Goldsmith62243a32022-04-08 13:42:04 +0000158 defer func() {
159 ctx.Metrics.ExpConfigFetcher(expConfigFetcher)
160 }()
Kousik Kumarc75e1292022-07-07 02:20:51 +0000161 if !config.GoogleProdCredsExist() {
162 status := smpb.ExpConfigFetcher_MISSING_GCERT
163 expConfigFetcher.Status = &status
164 return nil
165 }
David Goldsmith62243a32022-04-08 13:42:04 +0000166
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500167 s, err := os.Stat(configFetcher)
168 if err != nil {
169 if os.IsNotExist(err) {
170 return nil
171 }
172 return err
173 }
174 if s.Mode()&0111 == 0 {
David Goldsmith62243a32022-04-08 13:42:04 +0000175 status := smpb.ExpConfigFetcher_ERROR
176 expConfigFetcher.Status = &status
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500177 return fmt.Errorf("configuration fetcher binary %v is not executable: %v", configFetcher, s.Mode())
178 }
179
Kousik Kumarc8818332023-01-16 16:33:05 +0000180 configExists := false
181 outConfigFilePath := filepath.Join(config.OutDir(), configName)
182 if _, err := os.Stat(outConfigFilePath); err == nil {
183 configExists = true
184 }
185
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500186 tCtx, cancel := context.WithTimeout(ctx, envConfigFetchTimeout)
David Goldsmith62243a32022-04-08 13:42:04 +0000187 fetchStart := time.Now()
188 cmd := exec.CommandContext(tCtx, configFetcher, "-output_config_dir", config.OutDir(),
189 "-output_config_name", configName)
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500190 if err := cmd.Start(); err != nil {
David Goldsmith62243a32022-04-08 13:42:04 +0000191 status := smpb.ExpConfigFetcher_ERROR
192 expConfigFetcher.Status = &status
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500193 return err
194 }
195
Kousik Kumarc8818332023-01-16 16:33:05 +0000196 fetchCfg := func() error {
197 if err := cmd.Wait(); err != nil {
198 status := smpb.ExpConfigFetcher_ERROR
199 expConfigFetcher.Status = &status
200 return err
201 }
202 fetchEnd := time.Now()
203 expConfigFetcher.Micros = proto.Uint64(uint64(fetchEnd.Sub(fetchStart).Microseconds()))
204 expConfigFetcher.Filename = proto.String(outConfigFilePath)
205
206 if _, err := os.Stat(outConfigFilePath); err != nil {
207 status := smpb.ExpConfigFetcher_NO_CONFIG
208 expConfigFetcher.Status = &status
209 return err
210 }
David Goldsmith62243a32022-04-08 13:42:04 +0000211 status := smpb.ExpConfigFetcher_CONFIG
212 expConfigFetcher.Status = &status
Kousik Kumarc8818332023-01-16 16:33:05 +0000213 return nil
David Goldsmith62243a32022-04-08 13:42:04 +0000214 }
Kousik Kumarc8818332023-01-16 16:33:05 +0000215
216 // If a config file does not exist, wait for the config file to be fetched. Otherwise
217 // fetch the config file in the background and return immediately.
218 if !configExists {
219 defer cancel()
220 return fetchCfg()
221 }
222
223 go func() {
224 defer cancel()
225 if err := fetchCfg(); err != nil {
226 ctx.Verbosef("Failed to fetch config file %v: %v\n", configName, err)
227 }
228 }()
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500229 return nil
230}
231
MarkDacek7901e582023-01-09 19:48:01 +0000232func loadEnvConfig(ctx Context, config *configImpl, bc string) error {
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500233 if bc == "" {
234 return nil
235 }
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500236
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500237 configDirs := []string{
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500238 config.OutDir(),
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500239 os.Getenv("ANDROID_BUILD_ENVIRONMENT_CONFIG_DIR"),
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500240 envConfigDir,
241 }
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500242 for _, dir := range configDirs {
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500243 cfgFile := filepath.Join(os.Getenv("TOP"), dir, fmt.Sprintf("%s.%s", bc, jsonSuffix))
244 envVarsJSON, err := ioutil.ReadFile(cfgFile)
245 if err != nil {
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500246 continue
247 }
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500248 ctx.Verbosef("Loading config file %v\n", cfgFile)
249 var envVars map[string]map[string]string
250 if err := json.Unmarshal(envVarsJSON, &envVars); err != nil {
251 fmt.Fprintf(os.Stderr, "Env vars config file %s did not parse correctly: %s", cfgFile, err.Error())
252 continue
253 }
254 for k, v := range envVars["env"] {
255 if os.Getenv(k) != "" {
256 continue
257 }
258 config.environ.Set(k, v)
259 }
260 ctx.Verbosef("Finished loading config file %v\n", cfgFile)
261 break
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500262 }
Kousik Kumar84bd5bf2022-01-26 23:32:22 -0500263
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500264 return nil
265}
266
Chris Parsonsb6e96902022-10-31 20:08:45 -0400267func defaultBazelProdMode(cfg *configImpl) bool {
MarkDacekd06db5d2022-11-29 00:47:59 +0000268 // Environment flag to disable Bazel for users which experience
Chris Parsonsb6e96902022-10-31 20:08:45 -0400269 // broken bazel-handled builds, or significant performance regressions.
270 if cfg.IsBazelMixedBuildForceDisabled() {
271 return false
272 }
273 // Darwin-host builds are currently untested with Bazel.
274 if runtime.GOOS == "darwin" {
275 return false
276 }
Chris Parsons035e03a2022-11-01 14:25:45 -0400277 return true
Chris Parsonsb6e96902022-10-31 20:08:45 -0400278}
279
MarkDacek6614d9c2022-12-07 21:57:38 +0000280func UploadOnlyConfig(ctx Context, _ ...string) Config {
281 ret := &configImpl{
282 environ: OsEnvironment(),
283 sandboxConfig: &SandboxConfig{},
284 }
MarkDacek7901e582023-01-09 19:48:01 +0000285 srcDir := absPath(ctx, ".")
286 bc := os.Getenv("ANDROID_BUILD_ENVIRONMENT_CONFIG")
287 if err := loadEnvConfig(ctx, ret, bc); err != nil {
288 ctx.Fatalln("Failed to parse env config files: %v", err)
289 }
290 ret.metricsUploader = GetMetricsUploader(srcDir, ret.environ)
MarkDacek6614d9c2022-12-07 21:57:38 +0000291 return Config{ret}
292}
293
Dan Willemsen1e704462016-08-21 15:17:17 -0700294func NewConfig(ctx Context, args ...string) Config {
295 ret := &configImpl{
Spandan Dasa3639e62021-05-25 19:14:02 +0000296 environ: OsEnvironment(),
297 sandboxConfig: &SandboxConfig{},
Dan Willemsen1e704462016-08-21 15:17:17 -0700298 }
299
Patrice Arruda90109172020-07-28 18:07:27 +0000300 // Default matching ninja
Dan Willemsen9b587492017-07-10 22:13:00 -0700301 ret.parallel = runtime.NumCPU() + 2
302 ret.keepGoing = 1
303
Dan Willemsen2bb82d02019-12-27 09:35:42 -0800304 ret.totalRAM = detectTotalRAM(ctx)
Dan Willemsen9b587492017-07-10 22:13:00 -0700305 ret.parseArgs(ctx, args)
Dan Willemsen0c3919e2017-03-02 15:49:10 -0800306 // Make sure OUT_DIR is set appropriately
Dan Willemsen02f3add2017-05-12 13:50:19 -0700307 if outDir, ok := ret.environ.Get("OUT_DIR"); ok {
308 ret.environ.Set("OUT_DIR", filepath.Clean(outDir))
309 } else {
Dan Willemsen0c3919e2017-03-02 15:49:10 -0800310 outDir := "out"
311 if baseDir, ok := ret.environ.Get("OUT_DIR_COMMON_BASE"); ok {
312 if wd, err := os.Getwd(); err != nil {
313 ctx.Fatalln("Failed to get working directory:", err)
314 } else {
315 outDir = filepath.Join(baseDir, filepath.Base(wd))
316 }
317 }
318 ret.environ.Set("OUT_DIR", outDir)
319 }
320
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500321 // loadEnvConfig needs to know what the OUT_DIR is, so it should
322 // be called after we determine the appropriate out directory.
MarkDacek7901e582023-01-09 19:48:01 +0000323 bc := os.Getenv("ANDROID_BUILD_ENVIRONMENT_CONFIG")
324
325 if bc != "" {
326 if err := fetchEnvConfig(ctx, ret, bc); err != nil {
327 ctx.Verbosef("Failed to fetch config file: %v\n", err)
Kousik Kumarc8818332023-01-16 16:33:05 +0000328 }
329 if err := loadEnvConfig(ctx, ret, bc); err != nil {
MarkDacek7901e582023-01-09 19:48:01 +0000330 ctx.Fatalln("Failed to parse env config files: %v", err)
331 }
Kousik Kumar3ff037e2022-01-25 22:11:01 -0500332 }
333
Dan Willemsen2d31a442018-10-20 21:33:41 -0700334 if distDir, ok := ret.environ.Get("DIST_DIR"); ok {
335 ret.distDir = filepath.Clean(distDir)
336 } else {
337 ret.distDir = filepath.Join(ret.OutDir(), "dist")
338 }
Dan Willemsend50e89f2018-10-16 17:49:25 -0700339
Spandan Das05063612021-06-25 01:39:04 +0000340 if srcDirIsWritable, ok := ret.environ.Get("BUILD_BROKEN_SRC_DIR_IS_WRITABLE"); ok {
341 ret.sandboxConfig.SetSrcDirIsRO(srcDirIsWritable == "false")
342 }
343
Dan Willemsen1e704462016-08-21 15:17:17 -0700344 ret.environ.Unset(
345 // We're already using it
346 "USE_SOONG_UI",
347
348 // We should never use GOROOT/GOPATH from the shell environment
349 "GOROOT",
350 "GOPATH",
351
352 // These should only come from Soong, not the environment.
353 "CLANG",
354 "CLANG_CXX",
355 "CCC_CC",
356 "CCC_CXX",
357
358 // Used by the goma compiler wrapper, but should only be set by
359 // gomacc
360 "GOMACC_PATH",
Dan Willemsen0c3919e2017-03-02 15:49:10 -0800361
362 // We handle this above
363 "OUT_DIR_COMMON_BASE",
Dan Willemsen68a09852017-04-18 13:56:57 -0700364
Dan Willemsen2d31a442018-10-20 21:33:41 -0700365 // This is handled above too, and set for individual commands later
366 "DIST_DIR",
367
Dan Willemsen68a09852017-04-18 13:56:57 -0700368 // Variables that have caused problems in the past
Dan Willemsen1c504d92019-11-18 19:13:53 +0000369 "BASH_ENV",
Dan Willemsenebfe33a2018-05-01 10:07:50 -0700370 "CDPATH",
Dan Willemsen68a09852017-04-18 13:56:57 -0700371 "DISPLAY",
372 "GREP_OPTIONS",
Nathan Egge7b067fb2023-02-17 17:54:31 +0000373 "JAVAC",
Dan Willemsenebfe33a2018-05-01 10:07:50 -0700374 "NDK_ROOT",
Dan Willemsen00fcb262018-08-15 15:35:38 -0700375 "POSIXLY_CORRECT",
Dan Willemsenc40e10b2017-07-11 14:30:00 -0700376
377 // Drop make flags
378 "MAKEFLAGS",
379 "MAKELEVEL",
380 "MFLAGS",
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700381
382 // Set in envsetup.sh, reset in makefiles
383 "ANDROID_JAVA_TOOLCHAIN",
Colin Cross7f09c402018-07-11 14:49:31 -0700384
385 // Set by envsetup.sh, but shouldn't be used inside the build because envsetup.sh is optional
386 "ANDROID_BUILD_TOP",
387 "ANDROID_HOST_OUT",
388 "ANDROID_PRODUCT_OUT",
389 "ANDROID_HOST_OUT_TESTCASES",
390 "ANDROID_TARGET_OUT_TESTCASES",
391 "ANDROID_TOOLCHAIN",
392 "ANDROID_TOOLCHAIN_2ND_ARCH",
393 "ANDROID_DEV_SCRIPTS",
394 "ANDROID_EMULATOR_PREBUILTS",
395 "ANDROID_PRE_BUILD_PATHS",
Dan Willemsen1e704462016-08-21 15:17:17 -0700396 )
397
Kousik Kumarb328f6d2020-10-19 01:45:46 -0400398 if ret.UseGoma() || ret.ForceUseGoma() {
399 ctx.Println("Goma for Android has been deprecated and replaced with RBE. See go/rbe_for_android for instructions on how to use RBE.")
400 ctx.Fatalln("USE_GOMA / FORCE_USE_GOMA flag is no longer supported.")
Kousik Kumarec478642020-09-21 13:39:24 -0400401 }
402
Dan Willemsen1e704462016-08-21 15:17:17 -0700403 // Tell python not to spam the source tree with .pyc files.
404 ret.environ.Set("PYTHONDONTWRITEBYTECODE", "1")
405
Ramy Medhatca1e44c2020-07-16 12:18:37 -0400406 tmpDir := absPath(ctx, ret.TempDir())
407 ret.environ.Set("TMPDIR", tmpDir)
Dan Willemsen32a669b2018-03-08 19:42:00 -0800408
Dan Willemsen70c1ff82019-08-21 14:56:13 -0700409 // Always set ASAN_SYMBOLIZER_PATH so that ASAN-based tools can symbolize any crashes
410 symbolizerPath := filepath.Join("prebuilts/clang/host", ret.HostPrebuiltTag(),
411 "llvm-binutils-stable/llvm-symbolizer")
412 ret.environ.Set("ASAN_SYMBOLIZER_PATH", absPath(ctx, symbolizerPath))
413
Dan Willemsenc2af0be2017-01-20 14:10:01 -0800414 // Precondition: the current directory is the top of the source tree
Patrice Arruda13848222019-04-22 17:12:02 -0700415 checkTopDir(ctx)
Dan Willemsenc2af0be2017-01-20 14:10:01 -0800416
Yu Liu6e13b402021-07-27 14:29:06 -0700417 srcDir := absPath(ctx, ".")
418 if strings.ContainsRune(srcDir, ' ') {
Colin Cross1f6faeb2019-09-23 15:52:40 -0700419 ctx.Println("You are building in a directory whose absolute path contains a space character:")
420 ctx.Println()
421 ctx.Printf("%q\n", srcDir)
422 ctx.Println()
423 ctx.Fatalln("Directory names containing spaces are not supported")
Dan Willemsendb8457c2017-05-12 16:38:17 -0700424 }
425
Yu Liu6e13b402021-07-27 14:29:06 -0700426 ret.metricsUploader = GetMetricsUploader(srcDir, ret.environ)
427
Dan Willemsendb8457c2017-05-12 16:38:17 -0700428 if outDir := ret.OutDir(); strings.ContainsRune(outDir, ' ') {
Colin Cross1f6faeb2019-09-23 15:52:40 -0700429 ctx.Println("The absolute path of your output directory ($OUT_DIR) contains a space character:")
430 ctx.Println()
431 ctx.Printf("%q\n", outDir)
432 ctx.Println()
433 ctx.Fatalln("Directory names containing spaces are not supported")
Dan Willemsendb8457c2017-05-12 16:38:17 -0700434 }
435
Rupert Shuttleworth3c9f5ac2020-12-10 11:32:38 +0000436 if distDir := ret.RealDistDir(); strings.ContainsRune(distDir, ' ') {
Colin Cross1f6faeb2019-09-23 15:52:40 -0700437 ctx.Println("The absolute path of your dist directory ($DIST_DIR) contains a space character:")
438 ctx.Println()
439 ctx.Printf("%q\n", distDir)
440 ctx.Println()
441 ctx.Fatalln("Directory names containing spaces are not supported")
Dan Willemsendb8457c2017-05-12 16:38:17 -0700442 }
443
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700444 // Configure Java-related variables, including adding it to $PATH
Tobias Thierere59aeff2017-12-20 22:40:39 +0000445 java8Home := filepath.Join("prebuilts/jdk/jdk8", ret.HostPrebuiltTag())
446 java9Home := filepath.Join("prebuilts/jdk/jdk9", ret.HostPrebuiltTag())
Pete Gillin1f52e932019-10-09 17:10:08 +0100447 java11Home := filepath.Join("prebuilts/jdk/jdk11", ret.HostPrebuiltTag())
Colin Cross59c1e6a2022-03-04 13:37:19 -0800448 java17Home := filepath.Join("prebuilts/jdk/jdk17", ret.HostPrebuiltTag())
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700449 javaHome := func() string {
450 if override, ok := ret.environ.Get("OVERRIDE_ANDROID_JAVA_HOME"); ok {
451 return override
452 }
Pete Gillina7a3d642019-11-07 18:58:42 +0000453 if toolchain11, ok := ret.environ.Get("EXPERIMENTAL_USE_OPENJDK11_TOOLCHAIN"); ok && toolchain11 != "true" {
454 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 +0100455 }
Sorin Basca7e094b32022-10-05 08:20:12 +0000456 if toolchain17, ok := ret.environ.Get("EXPERIMENTAL_USE_OPENJDK17_TOOLCHAIN"); ok && toolchain17 != "true" {
457 ctx.Fatalln("The environment variable EXPERIMENTAL_USE_OPENJDK17_TOOLCHAIN is no longer supported. An OpenJDK 17 toolchain is now the global default.")
458 }
459 return java17Home
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700460 }()
461 absJavaHome := absPath(ctx, javaHome)
462
Dan Willemsened869522018-01-08 14:58:46 -0800463 ret.configureLocale(ctx)
464
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700465 newPath := []string{filepath.Join(absJavaHome, "bin")}
466 if path, ok := ret.environ.Get("PATH"); ok && path != "" {
467 newPath = append(newPath, path)
468 }
Pete Gillin1f52e932019-10-09 17:10:08 +0100469
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700470 ret.environ.Unset("OVERRIDE_ANDROID_JAVA_HOME")
471 ret.environ.Set("JAVA_HOME", absJavaHome)
472 ret.environ.Set("ANDROID_JAVA_HOME", javaHome)
Tobias Thierere59aeff2017-12-20 22:40:39 +0000473 ret.environ.Set("ANDROID_JAVA8_HOME", java8Home)
474 ret.environ.Set("ANDROID_JAVA9_HOME", java9Home)
Pete Gillin1f52e932019-10-09 17:10:08 +0100475 ret.environ.Set("ANDROID_JAVA11_HOME", java11Home)
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700476 ret.environ.Set("PATH", strings.Join(newPath, string(filepath.ListSeparator)))
477
LaMont Jones52a72432023-03-09 18:19:35 +0000478 if ret.MultitreeBuild() {
479 ret.environ.Set("MULTITREE_BUILD", "true")
480 }
481
Nan Zhang2e6a4ff2018-02-14 13:27:26 -0800482 outDir := ret.OutDir()
483 buildDateTimeFile := filepath.Join(outDir, "build_date.txt")
Nan Zhang2e6a4ff2018-02-14 13:27:26 -0800484 if buildDateTime, ok := ret.environ.Get("BUILD_DATETIME"); ok && buildDateTime != "" {
Colin Cross28f527c2019-11-26 16:19:04 -0800485 ret.buildDateTime = buildDateTime
Nan Zhang2e6a4ff2018-02-14 13:27:26 -0800486 } else {
Colin Cross28f527c2019-11-26 16:19:04 -0800487 ret.buildDateTime = strconv.FormatInt(time.Now().Unix(), 10)
Nan Zhang2e6a4ff2018-02-14 13:27:26 -0800488 }
Colin Cross28f527c2019-11-26 16:19:04 -0800489
Nan Zhang2e6a4ff2018-02-14 13:27:26 -0800490 ret.environ.Set("BUILD_DATETIME_FILE", buildDateTimeFile)
491
Ramy Medhatca1e44c2020-07-16 12:18:37 -0400492 if ret.UseRBE() {
Ramy Medhat0fc67eb2020-08-12 01:26:23 -0400493 for k, v := range getRBEVars(ctx, Config{ret}) {
Ramy Medhatca1e44c2020-07-16 12:18:37 -0400494 ret.environ.Set(k, v)
495 }
496 }
497
Patrice Arruda83842d72020-12-08 19:42:08 +0000498 bpd := ret.BazelMetricsDir()
Patrice Arrudaaf880da2020-11-13 08:41:26 -0800499 if err := os.RemoveAll(bpd); err != nil {
500 ctx.Fatalf("Unable to remove bazel profile directory %q: %v", bpd, err)
501 }
Rupert Shuttleworth3c9f5ac2020-12-10 11:32:38 +0000502
Patrice Arruda96850362020-08-11 20:41:11 +0000503 c := Config{ret}
504 storeConfigMetrics(ctx, c)
505 return c
Dan Willemsen9b587492017-07-10 22:13:00 -0700506}
507
Patrice Arruda13848222019-04-22 17:12:02 -0700508// NewBuildActionConfig returns a build configuration based on the build action. The arguments are
509// processed based on the build action and extracts any arguments that belongs to the build action.
Dan Willemsence41e942019-07-29 23:39:30 -0700510func NewBuildActionConfig(action BuildAction, dir string, ctx Context, args ...string) Config {
511 return NewConfig(ctx, getConfigArgs(action, dir, ctx, args)...)
Patrice Arruda13848222019-04-22 17:12:02 -0700512}
513
Patrice Arruda96850362020-08-11 20:41:11 +0000514// storeConfigMetrics selects a set of configuration information and store in
515// the metrics system for further analysis.
516func storeConfigMetrics(ctx Context, config Config) {
517 if ctx.Metrics == nil {
518 return
519 }
520
Liz Kammerca9cb2e2021-07-14 15:29:57 -0400521 ctx.Metrics.BuildConfig(buildConfig(config))
Patrice Arruda3edfd482020-10-13 23:58:41 +0000522
523 s := &smpb.SystemResourceInfo{
524 TotalPhysicalMemory: proto.Uint64(config.TotalRAM()),
525 AvailableCpus: proto.Int32(int32(runtime.NumCPU())),
526 }
527 ctx.Metrics.SystemResourceInfo(s)
Patrice Arruda96850362020-08-11 20:41:11 +0000528}
529
Liz Kammerca9cb2e2021-07-14 15:29:57 -0400530func buildConfig(config Config) *smpb.BuildConfig {
Yu Liue737a992021-10-04 13:21:41 -0700531 c := &smpb.BuildConfig{
Romain Jobredeaux0a7529b2022-10-26 12:56:41 -0400532 ForceUseGoma: proto.Bool(config.ForceUseGoma()),
533 UseGoma: proto.Bool(config.UseGoma()),
534 UseRbe: proto.Bool(config.UseRBE()),
535 BazelMixedBuild: proto.Bool(config.BazelBuildEnabled()),
536 ForceDisableBazelMixedBuild: proto.Bool(config.IsBazelMixedBuildForceDisabled()),
Liz Kammerca9cb2e2021-07-14 15:29:57 -0400537 }
Yu Liue737a992021-10-04 13:21:41 -0700538 c.Targets = append(c.Targets, config.arguments...)
539
540 return c
Liz Kammerca9cb2e2021-07-14 15:29:57 -0400541}
542
Patrice Arruda13848222019-04-22 17:12:02 -0700543// getConfigArgs processes the command arguments based on the build action and creates a set of new
544// arguments to be accepted by Config.
Dan Willemsence41e942019-07-29 23:39:30 -0700545func getConfigArgs(action BuildAction, dir string, ctx Context, args []string) []string {
Patrice Arruda13848222019-04-22 17:12:02 -0700546 // The next block of code verifies that the current directory is the root directory of the source
547 // tree. It then finds the relative path of dir based on the root directory of the source tree
548 // and verify that dir is inside of the source tree.
549 checkTopDir(ctx)
550 topDir, err := os.Getwd()
551 if err != nil {
552 ctx.Fatalf("Error retrieving top directory: %v", err)
553 }
Patrice Arrudababa9a92019-07-03 10:47:34 -0700554 dir, err = filepath.EvalSymlinks(dir)
555 if err != nil {
556 ctx.Fatalf("Unable to evaluate symlink of %s: %v", dir, err)
557 }
Patrice Arruda13848222019-04-22 17:12:02 -0700558 dir, err = filepath.Abs(dir)
559 if err != nil {
560 ctx.Fatalf("Unable to find absolute path %s: %v", dir, err)
561 }
562 relDir, err := filepath.Rel(topDir, dir)
563 if err != nil {
564 ctx.Fatalf("Unable to find relative path %s of %s: %v", relDir, topDir, err)
565 }
566 // If there are ".." in the path, it's not in the source tree.
567 if strings.Contains(relDir, "..") {
568 ctx.Fatalf("Directory %s is not under the source tree %s", dir, topDir)
569 }
570
571 configArgs := args[:]
572
573 // If the arguments contains GET-INSTALL-PATH, change the target name prefix from MODULES-IN- to
574 // GET-INSTALL-PATH-IN- to extract the installation path instead of building the modules.
575 targetNamePrefix := "MODULES-IN-"
576 if inList("GET-INSTALL-PATH", configArgs) {
577 targetNamePrefix = "GET-INSTALL-PATH-IN-"
578 configArgs = removeFromList("GET-INSTALL-PATH", configArgs)
579 }
580
Patrice Arruda13848222019-04-22 17:12:02 -0700581 var targets []string
582
583 switch action {
Patrice Arruda39282062019-06-20 16:35:12 -0700584 case BUILD_MODULES:
585 // No additional processing is required when building a list of specific modules or all modules.
Patrice Arruda13848222019-04-22 17:12:02 -0700586 case BUILD_MODULES_IN_A_DIRECTORY:
587 // If dir is the root source tree, all the modules are built of the source tree are built so
588 // no need to find the build file.
589 if topDir == dir {
590 break
591 }
Patrice Arruda0dcf27f2019-07-08 17:03:33 -0700592
Patrice Arruda13848222019-04-22 17:12:02 -0700593 buildFile := findBuildFile(ctx, relDir)
594 if buildFile == "" {
Patrice Arruda0dcf27f2019-07-08 17:03:33 -0700595 ctx.Fatalf("Build file not found for %s directory", relDir)
Patrice Arruda13848222019-04-22 17:12:02 -0700596 }
Patrice Arruda13848222019-04-22 17:12:02 -0700597 targets = []string{convertToTarget(filepath.Dir(buildFile), targetNamePrefix)}
598 case BUILD_MODULES_IN_DIRECTORIES:
599 newConfigArgs, dirs := splitArgs(configArgs)
600 configArgs = newConfigArgs
Dan Willemsence41e942019-07-29 23:39:30 -0700601 targets = getTargetsFromDirs(ctx, relDir, dirs, targetNamePrefix)
Patrice Arruda13848222019-04-22 17:12:02 -0700602 }
603
604 // Tidy only override all other specified targets.
605 tidyOnly := os.Getenv("WITH_TIDY_ONLY")
606 if tidyOnly == "true" || tidyOnly == "1" {
607 configArgs = append(configArgs, "tidy_only")
608 } else {
609 configArgs = append(configArgs, targets...)
610 }
611
612 return configArgs
613}
614
615// convertToTarget replaces "/" to "-" in dir and pre-append the targetNamePrefix to the target name.
616func convertToTarget(dir string, targetNamePrefix string) string {
617 return targetNamePrefix + strings.ReplaceAll(dir, "/", "-")
618}
619
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700620// hasBuildFile returns true if dir contains an Android build file.
621func hasBuildFile(ctx Context, dir string) bool {
622 for _, buildFile := range buildFiles {
623 _, err := os.Stat(filepath.Join(dir, buildFile))
624 if err == nil {
625 return true
626 }
627 if !os.IsNotExist(err) {
628 ctx.Fatalf("Error retrieving the build file stats: %v", err)
629 }
630 }
631 return false
632}
633
Patrice Arruda0dcf27f2019-07-08 17:03:33 -0700634// findBuildFile finds a build file (makefile or blueprint file) by looking if there is a build file
635// in the current and any sub directory of dir. If a build file is not found, traverse the path
636// up by one directory and repeat again until either a build file is found or reached to the root
637// source tree. The returned filename of build file is "Android.mk". If one was not found, a blank
638// string is returned.
Patrice Arruda13848222019-04-22 17:12:02 -0700639func findBuildFile(ctx Context, dir string) string {
Patrice Arruda0dcf27f2019-07-08 17:03:33 -0700640 // If the string is empty or ".", assume it is top directory of the source tree.
641 if dir == "" || dir == "." {
Patrice Arruda13848222019-04-22 17:12:02 -0700642 return ""
643 }
644
Patrice Arruda0dcf27f2019-07-08 17:03:33 -0700645 found := false
646 for buildDir := dir; buildDir != "."; buildDir = filepath.Dir(buildDir) {
647 err := filepath.Walk(buildDir, func(path string, info os.FileInfo, err error) error {
648 if err != nil {
649 return err
650 }
651 if found {
652 return filepath.SkipDir
653 }
654 if info.IsDir() {
655 return nil
656 }
657 for _, buildFile := range buildFiles {
658 if info.Name() == buildFile {
659 found = true
660 return filepath.SkipDir
661 }
662 }
663 return nil
664 })
665 if err != nil {
666 ctx.Fatalf("Error finding Android build file: %v", err)
667 }
668
669 if found {
670 return filepath.Join(buildDir, "Android.mk")
Patrice Arruda13848222019-04-22 17:12:02 -0700671 }
672 }
673
674 return ""
675}
676
677// splitArgs iterates over the arguments list and splits into two lists: arguments and directories.
678func splitArgs(args []string) (newArgs []string, dirs []string) {
679 specialArgs := map[string]bool{
680 "showcommands": true,
681 "snod": true,
682 "dist": true,
683 "checkbuild": true,
684 }
685
686 newArgs = []string{}
687 dirs = []string{}
688
689 for _, arg := range args {
690 // It's a dash argument if it starts with "-" or it's a key=value pair, it's not a directory.
691 if strings.IndexRune(arg, '-') == 0 || strings.IndexRune(arg, '=') != -1 {
692 newArgs = append(newArgs, arg)
693 continue
694 }
695
696 if _, ok := specialArgs[arg]; ok {
697 newArgs = append(newArgs, arg)
698 continue
699 }
700
701 dirs = append(dirs, arg)
702 }
703
704 return newArgs, dirs
705}
706
707// getTargetsFromDirs iterates over the dirs list and creates a list of targets to build. If a
708// directory from the dirs list does not exist, a fatal error is raised. relDir is related to the
709// source root tree where the build action command was invoked. Each directory is validated if the
710// build file can be found and follows the format "dir1:target1,target2,...". Target is optional.
Dan Willemsence41e942019-07-29 23:39:30 -0700711func getTargetsFromDirs(ctx Context, relDir string, dirs []string, targetNamePrefix string) (targets []string) {
Patrice Arruda13848222019-04-22 17:12:02 -0700712 for _, dir := range dirs {
713 // The directory may have specified specific modules to build. ":" is the separator to separate
714 // the directory and the list of modules.
715 s := strings.Split(dir, ":")
716 l := len(s)
717 if l > 2 { // more than one ":" was specified.
718 ctx.Fatalf("%s not in proper directory:target1,target2,... format (\":\" was specified more than once)", dir)
719 }
720
721 dir = filepath.Join(relDir, s[0])
722 if _, err := os.Stat(dir); err != nil {
723 ctx.Fatalf("couldn't find directory %s", dir)
724 }
725
726 // Verify that if there are any targets specified after ":". Each target is separated by ",".
727 var newTargets []string
728 if l == 2 && s[1] != "" {
729 newTargets = strings.Split(s[1], ",")
730 if inList("", newTargets) {
731 ctx.Fatalf("%s not in proper directory:target1,target2,... format", dir)
732 }
733 }
734
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700735 // If there are specified targets to build in dir, an android build file must exist for the one
736 // shot build. For the non-targets case, find the appropriate build file and build all the
737 // modules in dir (or the closest one in the dir path).
Patrice Arruda13848222019-04-22 17:12:02 -0700738 if len(newTargets) > 0 {
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700739 if !hasBuildFile(ctx, dir) {
Patrice Arruda13848222019-04-22 17:12:02 -0700740 ctx.Fatalf("Couldn't locate a build file from %s directory", dir)
741 }
742 } else {
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700743 buildFile := findBuildFile(ctx, dir)
744 if buildFile == "" {
745 ctx.Fatalf("Build file not found for %s directory", dir)
746 }
747 newTargets = []string{convertToTarget(filepath.Dir(buildFile), targetNamePrefix)}
Patrice Arruda13848222019-04-22 17:12:02 -0700748 }
749
Patrice Arruda13848222019-04-22 17:12:02 -0700750 targets = append(targets, newTargets...)
751 }
752
Dan Willemsence41e942019-07-29 23:39:30 -0700753 return targets
Patrice Arruda13848222019-04-22 17:12:02 -0700754}
755
Dan Willemsen9b587492017-07-10 22:13:00 -0700756func (c *configImpl) parseArgs(ctx Context, args []string) {
757 for i := 0; i < len(args); i++ {
758 arg := strings.TrimSpace(args[i])
Anton Hansson5a7861a2021-06-04 10:09:01 +0100759 if arg == "showcommands" {
Dan Willemsen9b587492017-07-10 22:13:00 -0700760 c.verbose = true
Lukacs T. Berkicef87b62021-08-10 15:01:13 +0200761 } else if arg == "--empty-ninja-file" {
762 c.emptyNinjaFile = true
Lukacs T. Berkid1e3f1f2021-03-16 08:55:23 +0100763 } else if arg == "--skip-ninja" {
764 c.skipNinja = true
Dan Willemsene0879fc2017-08-04 15:06:27 -0700765 } else if arg == "--skip-make" {
Colin Cross30e444b2021-06-18 11:26:19 -0700766 // TODO(ccross): deprecate this, it has confusing behaviors. It doesn't run kati,
767 // but it does run a Kati ninja file if the .kati_enabled marker file was created
768 // by a previous build.
Anton Hansson5e5c48b2020-11-27 12:35:20 +0000769 c.skipConfig = true
770 c.skipKati = true
771 } else if arg == "--skip-kati" {
Anton Hansson0b55bdb2021-06-04 10:08:08 +0100772 // TODO: remove --skip-kati once module builds have been migrated to --song-only
Anton Hansson5e5c48b2020-11-27 12:35:20 +0000773 c.skipKati = true
Anton Hansson0b55bdb2021-06-04 10:08:08 +0100774 } else if arg == "--soong-only" {
775 c.skipKati = true
776 c.skipKatiNinja = true
Lukacs T. Berkicef87b62021-08-10 15:01:13 +0200777 } else if arg == "--config-only" {
778 c.skipKati = true
779 c.skipKatiNinja = true
780 c.skipSoong = true
Colin Cross30e444b2021-06-18 11:26:19 -0700781 } else if arg == "--skip-config" {
782 c.skipConfig = true
Colin Cross00a8a3f2020-10-29 14:08:31 -0700783 } else if arg == "--skip-soong-tests" {
784 c.skipSoongTests = true
MarkDacekd0e7cd32022-12-02 22:22:40 +0000785 } else if arg == "--skip-metrics-upload" {
786 c.skipMetricsUpload = true
Chris Parsons53f68ae2022-03-03 12:01:40 -0500787 } else if arg == "--mk-metrics" {
788 c.reportMkMetrics = true
LaMont Jones52a72432023-03-09 18:19:35 +0000789 } else if arg == "--multitree-build" {
790 c.multitreeBuild = true
Chris Parsonsef615e52022-08-18 22:04:11 -0400791 } else if arg == "--bazel-mode" {
792 c.bazelProdMode = true
793 } else if arg == "--bazel-mode-dev" {
794 c.bazelDevMode = true
MarkDacekb78465d2022-10-18 20:10:16 +0000795 } else if arg == "--bazel-mode-staging" {
796 c.bazelStagingMode = true
Spandan Das394aa322022-11-03 17:02:10 +0000797 } else if arg == "--search-api-dir" {
798 c.searchApiDir = true
MarkDacekb96561e2022-12-02 04:34:43 +0000799 } else if strings.HasPrefix(arg, "--build-command=") {
800 buildCmd := strings.TrimPrefix(arg, "--build-command=")
801 // remove quotations
802 buildCmd = strings.TrimPrefix(buildCmd, "\"")
803 buildCmd = strings.TrimSuffix(buildCmd, "\"")
804 ctx.Metrics.SetBuildCommand([]string{buildCmd})
MarkDacekd06db5d2022-11-29 00:47:59 +0000805 } else if strings.HasPrefix(arg, "--bazel-force-enabled-modules=") {
806 c.bazelForceEnabledModules = strings.TrimPrefix(arg, "--bazel-force-enabled-modules=")
MarkDacek6614d9c2022-12-07 21:57:38 +0000807 } else if strings.HasPrefix(arg, "--build-started-time-unix-millis=") {
808 buildTimeStr := strings.TrimPrefix(arg, "--build-started-time-unix-millis=")
809 val, err := strconv.ParseInt(buildTimeStr, 10, 64)
810 if err == nil {
811 c.buildStartedTime = val
812 } else {
813 ctx.Fatalf("Error parsing build-time-started-unix-millis", err)
814 }
Dan Willemsen6ac63ef2017-10-17 20:35:34 -0700815 } else if len(arg) > 0 && arg[0] == '-' {
Dan Willemsen9b587492017-07-10 22:13:00 -0700816 parseArgNum := func(def int) int {
817 if len(arg) > 2 {
818 p, err := strconv.ParseUint(arg[2:], 10, 31)
819 if err != nil {
820 ctx.Fatalf("Failed to parse %q: %v", arg, err)
821 }
822 return int(p)
823 } else if i+1 < len(args) {
824 p, err := strconv.ParseUint(args[i+1], 10, 31)
825 if err == nil {
826 i++
827 return int(p)
828 }
829 }
830 return def
831 }
832
Dan Willemsen6ac63ef2017-10-17 20:35:34 -0700833 if len(arg) > 1 && arg[1] == 'j' {
Dan Willemsen9b587492017-07-10 22:13:00 -0700834 c.parallel = parseArgNum(c.parallel)
Dan Willemsen6ac63ef2017-10-17 20:35:34 -0700835 } else if len(arg) > 1 && arg[1] == 'k' {
Dan Willemsen9b587492017-07-10 22:13:00 -0700836 c.keepGoing = parseArgNum(0)
Dan Willemsen1e704462016-08-21 15:17:17 -0700837 } else {
838 ctx.Fatalln("Unknown option:", arg)
839 }
Dan Willemsen091525e2017-07-11 14:17:50 -0700840 } else if k, v, ok := decodeKeyValue(arg); ok && len(k) > 0 {
Dan Willemsen6dfe30a2018-09-10 12:41:10 -0700841 if k == "OUT_DIR" {
842 ctx.Fatalln("OUT_DIR may only be set in the environment, not as a command line option.")
843 }
Dan Willemsen091525e2017-07-11 14:17:50 -0700844 c.environ.Set(k, v)
Dan Willemsen2d31a442018-10-20 21:33:41 -0700845 } else if arg == "dist" {
846 c.dist = true
Lukacs T. Berkia1b93722021-09-02 17:23:06 +0200847 } else if arg == "json-module-graph" {
848 c.jsonModuleGraph = true
849 } else if arg == "bp2build" {
850 c.bp2build = true
Spandan Das5af0bd32022-09-28 20:43:08 +0000851 } else if arg == "api_bp2build" {
852 c.apiBp2build = true
Lukacs T. Berki3a821692021-09-06 17:08:02 +0200853 } else if arg == "queryview" {
854 c.queryview = true
Lukacs T. Berkic6012f32021-09-06 18:31:46 +0200855 } else if arg == "soong_docs" {
856 c.soongDocs = true
Dan Willemsen1e704462016-08-21 15:17:17 -0700857 } else {
Dan Willemsen2d31a442018-10-20 21:33:41 -0700858 if arg == "checkbuild" {
Colin Cross37193492017-11-16 17:55:00 -0800859 c.checkbuild = true
Dan Willemsene0879fc2017-08-04 15:06:27 -0700860 }
Dan Willemsen9b587492017-07-10 22:13:00 -0700861 c.arguments = append(c.arguments, arg)
Dan Willemsen1e704462016-08-21 15:17:17 -0700862 }
863 }
Chris Parsonsb6e96902022-10-31 20:08:45 -0400864 if (!c.bazelProdMode) && (!c.bazelDevMode) && (!c.bazelStagingMode) {
865 c.bazelProdMode = defaultBazelProdMode(c)
866 }
Dan Willemsen1e704462016-08-21 15:17:17 -0700867}
868
Dan Willemsened869522018-01-08 14:58:46 -0800869func (c *configImpl) configureLocale(ctx Context) {
870 cmd := Command(ctx, Config{c}, "locale", "locale", "-a")
871 output, err := cmd.Output()
872
873 var locales []string
874 if err == nil {
875 locales = strings.Split(string(output), "\n")
876 } else {
877 // If we're unable to list the locales, let's assume en_US.UTF-8
878 locales = []string{"en_US.UTF-8"}
879 ctx.Verbosef("Failed to list locales (%q), falling back to %q", err, locales)
880 }
881
882 // gettext uses LANGUAGE, which is passed directly through
883
884 // For LANG and LC_*, only preserve the evaluated version of
885 // LC_MESSAGES
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800886 userLang := ""
Dan Willemsened869522018-01-08 14:58:46 -0800887 if lc_all, ok := c.environ.Get("LC_ALL"); ok {
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800888 userLang = lc_all
Dan Willemsened869522018-01-08 14:58:46 -0800889 } else if lc_messages, ok := c.environ.Get("LC_MESSAGES"); ok {
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800890 userLang = lc_messages
Dan Willemsened869522018-01-08 14:58:46 -0800891 } else if lang, ok := c.environ.Get("LANG"); ok {
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800892 userLang = lang
Dan Willemsened869522018-01-08 14:58:46 -0800893 }
894
895 c.environ.UnsetWithPrefix("LC_")
896
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800897 if userLang != "" {
898 c.environ.Set("LC_MESSAGES", userLang)
Dan Willemsened869522018-01-08 14:58:46 -0800899 }
900
901 // The for LANG, use C.UTF-8 if it exists (Debian currently, proposed
902 // for others)
903 if inList("C.UTF-8", locales) {
904 c.environ.Set("LANG", "C.UTF-8")
Aaron Klingd236e0e2018-08-07 19:21:36 -0500905 } else if inList("C.utf8", locales) {
906 // These normalize to the same thing
907 c.environ.Set("LANG", "C.UTF-8")
Dan Willemsened869522018-01-08 14:58:46 -0800908 } else if inList("en_US.UTF-8", locales) {
909 c.environ.Set("LANG", "en_US.UTF-8")
910 } else if inList("en_US.utf8", locales) {
911 // These normalize to the same thing
912 c.environ.Set("LANG", "en_US.UTF-8")
913 } else {
914 ctx.Fatalln("System doesn't support either C.UTF-8 or en_US.UTF-8")
915 }
916}
917
Dan Willemsen1e704462016-08-21 15:17:17 -0700918func (c *configImpl) Environment() *Environment {
919 return c.environ
920}
921
922func (c *configImpl) Arguments() []string {
923 return c.arguments
924}
925
Lukacs T. Berkia1b93722021-09-02 17:23:06 +0200926func (c *configImpl) SoongBuildInvocationNeeded() bool {
Lukacs T. Berkia1b93722021-09-02 17:23:06 +0200927 if len(c.Arguments()) > 0 {
928 // Explicit targets requested that are not special targets like b2pbuild
929 // or the JSON module graph
930 return true
931 }
932
Spandan Das5af0bd32022-09-28 20:43:08 +0000933 if !c.JsonModuleGraph() && !c.Bp2Build() && !c.Queryview() && !c.SoongDocs() && !c.ApiBp2build() {
Lukacs T. Berkia1b93722021-09-02 17:23:06 +0200934 // Command line was empty, the default Ninja target is built
935 return true
936 }
937
Liz Kammer88677422021-12-15 15:03:19 -0500938 // bp2build + dist may be used to dist bp2build logs but does not require SoongBuildInvocation
939 if c.Dist() && !c.Bp2Build() {
940 return true
941 }
942
Lukacs T. Berkia1b93722021-09-02 17:23:06 +0200943 // build.ninja doesn't need to be generated
944 return false
945}
946
Dan Willemsen1e704462016-08-21 15:17:17 -0700947func (c *configImpl) OutDir() string {
948 if outDir, ok := c.environ.Get("OUT_DIR"); ok {
Patrice Arruda19bd53e2019-07-08 17:26:47 -0700949 return outDir
Dan Willemsen1e704462016-08-21 15:17:17 -0700950 }
951 return "out"
952}
953
Dan Willemsen8a073a82017-02-04 17:30:44 -0800954func (c *configImpl) DistDir() string {
Chris Parsons19ab9a42022-08-30 13:15:04 -0400955 return c.distDir
Rupert Shuttleworth3c9f5ac2020-12-10 11:32:38 +0000956}
957
958func (c *configImpl) RealDistDir() string {
Dan Willemsen2d31a442018-10-20 21:33:41 -0700959 return c.distDir
Dan Willemsen8a073a82017-02-04 17:30:44 -0800960}
961
Dan Willemsen1e704462016-08-21 15:17:17 -0700962func (c *configImpl) NinjaArgs() []string {
Anton Hansson5e5c48b2020-11-27 12:35:20 +0000963 if c.skipKati {
Dan Willemsene0879fc2017-08-04 15:06:27 -0700964 return c.arguments
965 }
Dan Willemsen1e704462016-08-21 15:17:17 -0700966 return c.ninjaArgs
967}
968
Jingwen Chen7c6089a2020-11-02 02:56:20 -0500969func (c *configImpl) BazelOutDir() string {
970 return filepath.Join(c.OutDir(), "bazel")
971}
972
Liz Kammer2af5ea82022-11-11 14:21:03 -0500973func (c *configImpl) bazelOutputBase() string {
974 return filepath.Join(c.BazelOutDir(), "output")
975}
976
Dan Willemsen1e704462016-08-21 15:17:17 -0700977func (c *configImpl) SoongOutDir() string {
978 return filepath.Join(c.OutDir(), "soong")
979}
980
Spandan Das394aa322022-11-03 17:02:10 +0000981func (c *configImpl) ApiSurfacesOutDir() string {
982 return filepath.Join(c.OutDir(), "api_surfaces")
983}
984
Lukacs T. Berkia806e412021-09-01 08:57:48 +0200985func (c *configImpl) PrebuiltOS() string {
986 switch runtime.GOOS {
987 case "linux":
988 return "linux-x86"
989 case "darwin":
990 return "darwin-x86"
991 default:
992 panic("Unknown GOOS")
993 }
994}
Lukacs T. Berki90b43342021-11-02 14:42:04 +0100995
Lukacs T. Berkia806e412021-09-01 08:57:48 +0200996func (c *configImpl) HostToolDir() string {
Colin Crossacfcc1f2021-10-25 15:40:32 -0700997 if c.SkipKatiNinja() {
998 return filepath.Join(c.SoongOutDir(), "host", c.PrebuiltOS(), "bin")
999 } else {
1000 return filepath.Join(c.OutDir(), "host", c.PrebuiltOS(), "bin")
1001 }
Lukacs T. Berkia806e412021-09-01 08:57:48 +02001002}
1003
Lukacs T. Berki89fcdcb2021-09-07 09:10:33 +02001004func (c *configImpl) NamedGlobFile(name string) string {
Lukacs T. Berki90b43342021-11-02 14:42:04 +01001005 return shared.JoinPath(c.SoongOutDir(), "globs-"+name+".ninja")
Lukacs T. Berki89fcdcb2021-09-07 09:10:33 +02001006}
1007
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +02001008func (c *configImpl) UsedEnvFile(tag string) string {
1009 return shared.JoinPath(c.SoongOutDir(), usedEnvFile+"."+tag)
1010}
1011
Lukacs T. Berkic541cd22022-10-26 07:26:50 +00001012func (c *configImpl) Bp2BuildFilesMarkerFile() string {
1013 return shared.JoinPath(c.SoongOutDir(), "bp2build_files_marker")
1014}
1015
1016func (c *configImpl) Bp2BuildWorkspaceMarkerFile() string {
Lukacs T. Berki90b43342021-11-02 14:42:04 +01001017 return shared.JoinPath(c.SoongOutDir(), "bp2build_workspace_marker")
Lukacs T. Berki56ebaf32021-08-12 14:03:55 +02001018}
1019
Lukacs T. Berkic6012f32021-09-06 18:31:46 +02001020func (c *configImpl) SoongDocsHtml() string {
1021 return shared.JoinPath(c.SoongOutDir(), "docs/soong_build.html")
1022}
1023
Lukacs T. Berki3a821692021-09-06 17:08:02 +02001024func (c *configImpl) QueryviewMarkerFile() string {
1025 return shared.JoinPath(c.SoongOutDir(), "queryview.marker")
1026}
1027
Spandan Das5af0bd32022-09-28 20:43:08 +00001028func (c *configImpl) ApiBp2buildMarkerFile() string {
1029 return shared.JoinPath(c.SoongOutDir(), "api_bp2build.marker")
1030}
1031
Lukacs T. Berkie571dc32021-08-25 14:14:13 +02001032func (c *configImpl) ModuleGraphFile() string {
1033 return shared.JoinPath(c.SoongOutDir(), "module-graph.json")
1034}
1035
kgui67007242022-01-25 13:50:25 +08001036func (c *configImpl) ModuleActionsFile() string {
1037 return shared.JoinPath(c.SoongOutDir(), "module-actions.json")
1038}
1039
Jeff Gastonefc1b412017-03-29 17:29:06 -07001040func (c *configImpl) TempDir() string {
1041 return shared.TempDirForOutDir(c.SoongOutDir())
1042}
1043
Jeff Gastonb64fc1c2017-08-04 12:30:12 -07001044func (c *configImpl) FileListDir() string {
1045 return filepath.Join(c.OutDir(), ".module_paths")
1046}
1047
Dan Willemsen1e704462016-08-21 15:17:17 -07001048func (c *configImpl) KatiSuffix() string {
1049 if c.katiSuffix != "" {
1050 return c.katiSuffix
1051 }
1052 panic("SetKatiSuffix has not been called")
1053}
1054
Colin Cross37193492017-11-16 17:55:00 -08001055// Checkbuild returns true if "checkbuild" was one of the build goals, which means that the
1056// user is interested in additional checks at the expense of build time.
1057func (c *configImpl) Checkbuild() bool {
1058 return c.checkbuild
1059}
1060
Dan Willemsen8a073a82017-02-04 17:30:44 -08001061func (c *configImpl) Dist() bool {
1062 return c.dist
1063}
1064
Lukacs T. Berkia1b93722021-09-02 17:23:06 +02001065func (c *configImpl) JsonModuleGraph() bool {
1066 return c.jsonModuleGraph
1067}
1068
1069func (c *configImpl) Bp2Build() bool {
1070 return c.bp2build
1071}
1072
Spandan Das5af0bd32022-09-28 20:43:08 +00001073func (c *configImpl) ApiBp2build() bool {
1074 return c.apiBp2build
1075}
1076
Lukacs T. Berki3a821692021-09-06 17:08:02 +02001077func (c *configImpl) Queryview() bool {
1078 return c.queryview
1079}
1080
Lukacs T. Berkic6012f32021-09-06 18:31:46 +02001081func (c *configImpl) SoongDocs() bool {
1082 return c.soongDocs
1083}
1084
Dan Willemsen1e704462016-08-21 15:17:17 -07001085func (c *configImpl) IsVerbose() bool {
1086 return c.verbose
1087}
1088
LaMont Jones52a72432023-03-09 18:19:35 +00001089func (c *configImpl) MultitreeBuild() bool {
1090 return c.multitreeBuild
1091}
1092
Anton Hansson5e5c48b2020-11-27 12:35:20 +00001093func (c *configImpl) SkipKati() bool {
1094 return c.skipKati
1095}
1096
Anton Hansson0b55bdb2021-06-04 10:08:08 +01001097func (c *configImpl) SkipKatiNinja() bool {
1098 return c.skipKatiNinja
1099}
1100
Lukacs T. Berkicef87b62021-08-10 15:01:13 +02001101func (c *configImpl) SkipSoong() bool {
1102 return c.skipSoong
1103}
1104
Lukacs T. Berkid1e3f1f2021-03-16 08:55:23 +01001105func (c *configImpl) SkipNinja() bool {
1106 return c.skipNinja
1107}
1108
Anton Hansson5a7861a2021-06-04 10:09:01 +01001109func (c *configImpl) SetSkipNinja(v bool) {
1110 c.skipNinja = v
1111}
1112
Anton Hansson5e5c48b2020-11-27 12:35:20 +00001113func (c *configImpl) SkipConfig() bool {
1114 return c.skipConfig
Dan Willemsene0879fc2017-08-04 15:06:27 -07001115}
1116
Dan Willemsen1e704462016-08-21 15:17:17 -07001117func (c *configImpl) TargetProduct() string {
1118 if v, ok := c.environ.Get("TARGET_PRODUCT"); ok {
1119 return v
1120 }
1121 panic("TARGET_PRODUCT is not defined")
1122}
1123
Dan Willemsen02781d52017-05-12 19:28:13 -07001124func (c *configImpl) TargetDevice() string {
1125 return c.targetDevice
1126}
1127
1128func (c *configImpl) SetTargetDevice(device string) {
1129 c.targetDevice = device
1130}
1131
1132func (c *configImpl) TargetBuildVariant() string {
1133 if v, ok := c.environ.Get("TARGET_BUILD_VARIANT"); ok {
1134 return v
1135 }
1136 panic("TARGET_BUILD_VARIANT is not defined")
1137}
1138
Dan Willemsen1e704462016-08-21 15:17:17 -07001139func (c *configImpl) KatiArgs() []string {
1140 return c.katiArgs
1141}
1142
1143func (c *configImpl) Parallel() int {
1144 return c.parallel
1145}
1146
Spandan Dasc5763832022-11-08 18:42:16 +00001147func (c *configImpl) GetIncludeTags() []string {
1148 return c.includeTags
1149}
1150
1151func (c *configImpl) SetIncludeTags(i []string) {
1152 c.includeTags = i
1153}
1154
MarkDacek6614d9c2022-12-07 21:57:38 +00001155func (c *configImpl) GetLogsPrefix() string {
1156 return c.logsPrefix
1157}
1158
1159func (c *configImpl) SetLogsPrefix(prefix string) {
1160 c.logsPrefix = prefix
1161}
1162
Colin Cross8b8bec32019-11-15 13:18:43 -08001163func (c *configImpl) HighmemParallel() int {
1164 if i, ok := c.environ.GetInt("NINJA_HIGHMEM_NUM_JOBS"); ok {
1165 return i
1166 }
1167
1168 const minMemPerHighmemProcess = 8 * 1024 * 1024 * 1024
1169 parallel := c.Parallel()
1170 if c.UseRemoteBuild() {
1171 // Ninja doesn't support nested pools, and when remote builds are enabled the total ninja parallelism
1172 // is set very high (i.e. 500). Using a large value here would cause the total number of running jobs
1173 // to be the sum of the sizes of the local and highmem pools, which will cause extra CPU contention.
1174 // Return 1/16th of the size of the local pool, rounding up.
1175 return (parallel + 15) / 16
1176 } else if c.totalRAM == 0 {
1177 // Couldn't detect the total RAM, don't restrict highmem processes.
1178 return parallel
Dan Willemsen570a2922020-05-26 23:02:29 -07001179 } else if c.totalRAM <= 16*1024*1024*1024 {
1180 // Less than 16GB of ram, restrict to 1 highmem processes
1181 return 1
Colin Cross8b8bec32019-11-15 13:18:43 -08001182 } else if c.totalRAM <= 32*1024*1024*1024 {
1183 // Less than 32GB of ram, restrict to 2 highmem processes
1184 return 2
1185 } else if p := int(c.totalRAM / minMemPerHighmemProcess); p < parallel {
1186 // If less than 8GB total RAM per process, reduce the number of highmem processes
1187 return p
1188 }
1189 // No restriction on highmem processes
1190 return parallel
1191}
1192
Dan Willemsen2bb82d02019-12-27 09:35:42 -08001193func (c *configImpl) TotalRAM() uint64 {
1194 return c.totalRAM
1195}
1196
Kousik Kumarec478642020-09-21 13:39:24 -04001197// ForceUseGoma determines whether we should override Goma deprecation
1198// and use Goma for the current build or not.
1199func (c *configImpl) ForceUseGoma() bool {
1200 if v, ok := c.environ.Get("FORCE_USE_GOMA"); ok {
1201 v = strings.TrimSpace(v)
1202 if v != "" && v != "false" {
1203 return true
1204 }
1205 }
1206 return false
1207}
1208
Dan Willemsen1e704462016-08-21 15:17:17 -07001209func (c *configImpl) UseGoma() bool {
1210 if v, ok := c.environ.Get("USE_GOMA"); ok {
1211 v = strings.TrimSpace(v)
1212 if v != "" && v != "false" {
1213 return true
1214 }
1215 }
1216 return false
1217}
1218
Yoshisato Yanagisawa2cb0e5d2019-01-10 10:14:16 +09001219func (c *configImpl) StartGoma() bool {
1220 if !c.UseGoma() {
1221 return false
1222 }
1223
1224 if v, ok := c.environ.Get("NOSTART_GOMA"); ok {
1225 v = strings.TrimSpace(v)
1226 if v != "" && v != "false" {
1227 return false
1228 }
1229 }
1230 return true
1231}
1232
Ramy Medhatbbf25672019-07-17 12:30:04 +00001233func (c *configImpl) UseRBE() bool {
Kousik Kumar3ff037e2022-01-25 22:11:01 -05001234 if v, ok := c.Environment().Get("USE_RBE"); ok {
Ramy Medhatbbf25672019-07-17 12:30:04 +00001235 v = strings.TrimSpace(v)
1236 if v != "" && v != "false" {
1237 return true
1238 }
1239 }
1240 return false
1241}
1242
Chris Parsonsef615e52022-08-18 22:04:11 -04001243func (c *configImpl) BazelBuildEnabled() bool {
MarkDacekb78465d2022-10-18 20:10:16 +00001244 return c.bazelProdMode || c.bazelDevMode || c.bazelStagingMode
Chris Parsonsec1a3dc2021-04-20 15:32:07 -04001245}
1246
Ramy Medhatbbf25672019-07-17 12:30:04 +00001247func (c *configImpl) StartRBE() bool {
1248 if !c.UseRBE() {
1249 return false
1250 }
1251
1252 if v, ok := c.environ.Get("NOSTART_RBE"); ok {
1253 v = strings.TrimSpace(v)
1254 if v != "" && v != "false" {
1255 return false
1256 }
1257 }
1258 return true
1259}
1260
Kousik Kumar4c180ad2022-05-27 07:48:37 -04001261func (c *configImpl) rbeProxyLogsDir() string {
1262 for _, f := range []string{"RBE_proxy_log_dir", "FLAG_output_dir"} {
Kousik Kumar0d15a722020-09-23 02:54:11 -04001263 if v, ok := c.environ.Get(f); ok {
1264 return v
1265 }
1266 }
Kousik Kumar4c180ad2022-05-27 07:48:37 -04001267 buildTmpDir := shared.TempDirForOutDir(c.SoongOutDir())
1268 return filepath.Join(buildTmpDir, "rbe")
Ramy Medhat0fc67eb2020-08-12 01:26:23 -04001269}
1270
Kousik Kumar4c180ad2022-05-27 07:48:37 -04001271func (c *configImpl) shouldCleanupRBELogsDir() bool {
1272 // Perform a log directory cleanup only when the log directory
1273 // is auto created by the build rather than user-specified.
1274 for _, f := range []string{"RBE_proxy_log_dir", "FLAG_output_dir"} {
1275 if _, ok := c.environ.Get(f); ok {
1276 return false
Patrice Arruda62f1bf22020-07-07 12:48:26 +00001277 }
1278 }
Kousik Kumar4c180ad2022-05-27 07:48:37 -04001279 return true
Ramy Medhat0fc67eb2020-08-12 01:26:23 -04001280}
1281
1282func (c *configImpl) rbeExecRoot() string {
1283 for _, f := range []string{"RBE_exec_root", "FLAG_exec_root"} {
1284 if v, ok := c.environ.Get(f); ok {
1285 return v
1286 }
1287 }
1288 wd, err := os.Getwd()
1289 if err != nil {
1290 return ""
1291 }
1292 return wd
1293}
1294
1295func (c *configImpl) rbeDir() string {
1296 if v, ok := c.environ.Get("RBE_DIR"); ok {
1297 return v
1298 }
1299 return "prebuilts/remoteexecution-client/live/"
1300}
1301
1302func (c *configImpl) rbeReproxy() string {
1303 for _, f := range []string{"RBE_re_proxy", "FLAG_re_proxy"} {
1304 if v, ok := c.environ.Get(f); ok {
1305 return v
1306 }
1307 }
1308 return filepath.Join(c.rbeDir(), "reproxy")
1309}
1310
1311func (c *configImpl) rbeAuth() (string, string) {
Kousik Kumar93d192c2022-03-18 01:39:56 -04001312 credFlags := []string{
1313 "use_application_default_credentials",
1314 "use_gce_credentials",
1315 "credential_file",
1316 "use_google_prod_creds",
1317 }
Ramy Medhat0fc67eb2020-08-12 01:26:23 -04001318 for _, cf := range credFlags {
1319 for _, f := range []string{"RBE_" + cf, "FLAG_" + cf} {
1320 if v, ok := c.environ.Get(f); ok {
1321 v = strings.TrimSpace(v)
1322 if v != "" && v != "false" && v != "0" {
1323 return "RBE_" + cf, v
1324 }
1325 }
1326 }
1327 }
1328 return "RBE_use_application_default_credentials", "true"
Patrice Arruda62f1bf22020-07-07 12:48:26 +00001329}
1330
Kousik Kumar4c180ad2022-05-27 07:48:37 -04001331func (c *configImpl) rbeSockAddr(dir string) (string, error) {
1332 maxNameLen := len(syscall.RawSockaddrUnix{}.Path)
1333 base := fmt.Sprintf("reproxy_%v.sock", rbeRandPrefix)
1334
1335 name := filepath.Join(dir, base)
1336 if len(name) < maxNameLen {
1337 return name, nil
1338 }
1339
1340 name = filepath.Join("/tmp", base)
1341 if len(name) < maxNameLen {
1342 return name, nil
1343 }
1344
1345 return "", fmt.Errorf("cannot generate a proxy socket address shorter than the limit of %v", maxNameLen)
1346}
1347
Kousik Kumar7bc78192022-04-27 14:52:56 -04001348// IsGooglerEnvironment returns true if the current build is running
1349// on a Google developer machine and false otherwise.
1350func (c *configImpl) IsGooglerEnvironment() bool {
1351 cf := "ANDROID_BUILD_ENVIRONMENT_CONFIG"
1352 if v, ok := c.environ.Get(cf); ok {
1353 return v == "googler"
1354 }
1355 return false
1356}
1357
1358// GoogleProdCredsExist determine whether credentials exist on the
1359// Googler machine to use remote execution.
1360func (c *configImpl) GoogleProdCredsExist() bool {
1361 if _, err := exec.Command("/usr/bin/prodcertstatus", "--simple_output", "--nocheck_loas").Output(); err != nil {
1362 return false
1363 }
1364 return true
1365}
1366
1367// UseRemoteBuild indicates whether to use a remote build acceleration system
1368// to speed up the build.
Colin Cross9016b912019-11-11 14:57:42 -08001369func (c *configImpl) UseRemoteBuild() bool {
1370 return c.UseGoma() || c.UseRBE()
1371}
1372
Kousik Kumar7bc78192022-04-27 14:52:56 -04001373// StubbyExists checks whether the stubby binary exists on the machine running
1374// the build.
1375func (c *configImpl) StubbyExists() bool {
1376 if _, err := exec.LookPath("stubby"); err != nil {
1377 return false
1378 }
1379 return true
1380}
1381
Dan Willemsen1e704462016-08-21 15:17:17 -07001382// RemoteParallel controls how many remote jobs (i.e., commands which contain
Jeff Gastonefc1b412017-03-29 17:29:06 -07001383// gomacc) are run in parallel. Note the parallelism of all other jobs is
Dan Willemsen1e704462016-08-21 15:17:17 -07001384// still limited by Parallel()
1385func (c *configImpl) RemoteParallel() int {
Colin Cross8b8bec32019-11-15 13:18:43 -08001386 if !c.UseRemoteBuild() {
1387 return 0
1388 }
1389 if i, ok := c.environ.GetInt("NINJA_REMOTE_NUM_JOBS"); ok {
1390 return i
Dan Willemsen1e704462016-08-21 15:17:17 -07001391 }
1392 return 500
1393}
1394
1395func (c *configImpl) SetKatiArgs(args []string) {
1396 c.katiArgs = args
1397}
1398
1399func (c *configImpl) SetNinjaArgs(args []string) {
1400 c.ninjaArgs = args
1401}
1402
1403func (c *configImpl) SetKatiSuffix(suffix string) {
1404 c.katiSuffix = suffix
1405}
1406
Dan Willemsene0879fc2017-08-04 15:06:27 -07001407func (c *configImpl) LastKatiSuffixFile() string {
1408 return filepath.Join(c.OutDir(), "last_kati_suffix")
1409}
1410
1411func (c *configImpl) HasKatiSuffix() bool {
1412 return c.katiSuffix != ""
1413}
1414
Dan Willemsen1e704462016-08-21 15:17:17 -07001415func (c *configImpl) KatiEnvFile() string {
1416 return filepath.Join(c.OutDir(), "env"+c.KatiSuffix()+".sh")
1417}
1418
Dan Willemsen29971232018-09-26 14:58:30 -07001419func (c *configImpl) KatiBuildNinjaFile() string {
1420 return filepath.Join(c.OutDir(), "build"+c.KatiSuffix()+katiBuildSuffix+".ninja")
Dan Willemsen1e704462016-08-21 15:17:17 -07001421}
1422
Dan Willemsenfb1271a2018-09-26 15:00:42 -07001423func (c *configImpl) KatiPackageNinjaFile() string {
1424 return filepath.Join(c.OutDir(), "build"+c.KatiSuffix()+katiPackageSuffix+".ninja")
1425}
1426
Jihoon Kang9f4f8a32022-08-16 00:57:30 +00001427func (c *configImpl) SoongVarsFile() string {
1428 return filepath.Join(c.SoongOutDir(), "soong.variables")
1429}
1430
Dan Willemsen1e704462016-08-21 15:17:17 -07001431func (c *configImpl) SoongNinjaFile() string {
1432 return filepath.Join(c.SoongOutDir(), "build.ninja")
1433}
1434
1435func (c *configImpl) CombinedNinjaFile() string {
Dan Willemsene0879fc2017-08-04 15:06:27 -07001436 if c.katiSuffix == "" {
1437 return filepath.Join(c.OutDir(), "combined.ninja")
1438 }
Dan Willemsen1e704462016-08-21 15:17:17 -07001439 return filepath.Join(c.OutDir(), "combined"+c.KatiSuffix()+".ninja")
1440}
1441
1442func (c *configImpl) SoongAndroidMk() string {
1443 return filepath.Join(c.SoongOutDir(), "Android-"+c.TargetProduct()+".mk")
1444}
1445
1446func (c *configImpl) SoongMakeVarsMk() string {
1447 return filepath.Join(c.SoongOutDir(), "make_vars-"+c.TargetProduct()+".mk")
1448}
1449
Dan Willemsenf052f782017-05-18 15:29:04 -07001450func (c *configImpl) ProductOut() string {
Dan Willemsen4dc4e142017-09-08 14:35:43 -07001451 return filepath.Join(c.OutDir(), "target", "product", c.TargetDevice())
Dan Willemsenf052f782017-05-18 15:29:04 -07001452}
1453
Dan Willemsen02781d52017-05-12 19:28:13 -07001454func (c *configImpl) DevicePreviousProductConfig() string {
Dan Willemsenf052f782017-05-18 15:29:04 -07001455 return filepath.Join(c.ProductOut(), "previous_build_config.mk")
1456}
1457
Dan Willemsenfb1271a2018-09-26 15:00:42 -07001458func (c *configImpl) KatiPackageMkDir() string {
1459 return filepath.Join(c.ProductOut(), "obj", "CONFIG", "kati_packaging")
1460}
1461
Dan Willemsenf052f782017-05-18 15:29:04 -07001462func (c *configImpl) hostOutRoot() string {
Dan Willemsen4dc4e142017-09-08 14:35:43 -07001463 return filepath.Join(c.OutDir(), "host")
Dan Willemsenf052f782017-05-18 15:29:04 -07001464}
1465
1466func (c *configImpl) HostOut() string {
1467 return filepath.Join(c.hostOutRoot(), c.HostPrebuiltTag())
1468}
1469
1470// This probably needs to be multi-valued, so not exporting it for now
1471func (c *configImpl) hostCrossOut() string {
1472 if runtime.GOOS == "linux" {
1473 return filepath.Join(c.hostOutRoot(), "windows-x86")
1474 } else {
1475 return ""
1476 }
Dan Willemsen02781d52017-05-12 19:28:13 -07001477}
1478
Dan Willemsen1e704462016-08-21 15:17:17 -07001479func (c *configImpl) HostPrebuiltTag() string {
1480 if runtime.GOOS == "linux" {
1481 return "linux-x86"
1482 } else if runtime.GOOS == "darwin" {
1483 return "darwin-x86"
1484 } else {
1485 panic("Unsupported OS")
1486 }
1487}
Dan Willemsenf173d592017-04-27 14:28:00 -07001488
Dan Willemsen8122bd52017-10-12 20:20:41 -07001489func (c *configImpl) PrebuiltBuildTool(name string) string {
Dan Willemsenf173d592017-04-27 14:28:00 -07001490 if v, ok := c.environ.Get("SANITIZE_HOST"); ok {
1491 if sanitize := strings.Fields(v); inList("address", sanitize) {
Dan Willemsen8122bd52017-10-12 20:20:41 -07001492 asan := filepath.Join("prebuilts/build-tools", c.HostPrebuiltTag(), "asan/bin", name)
1493 if _, err := os.Stat(asan); err == nil {
1494 return asan
1495 }
Dan Willemsenf173d592017-04-27 14:28:00 -07001496 }
1497 }
1498 return filepath.Join("prebuilts/build-tools", c.HostPrebuiltTag(), "bin", name)
1499}
Dan Willemsen3d60b112018-04-04 22:25:56 -07001500
1501func (c *configImpl) SetBuildBrokenDupRules(val bool) {
1502 c.brokenDupRules = val
1503}
1504
1505func (c *configImpl) BuildBrokenDupRules() bool {
1506 return c.brokenDupRules
1507}
Dan Willemsen6ab79db2018-05-02 00:06:28 -07001508
Dan Willemsen25e6f092019-04-09 10:22:43 -07001509func (c *configImpl) SetBuildBrokenUsesNetwork(val bool) {
1510 c.brokenUsesNetwork = val
1511}
1512
1513func (c *configImpl) BuildBrokenUsesNetwork() bool {
1514 return c.brokenUsesNetwork
1515}
1516
Dan Willemsene3336352020-01-02 19:10:38 -08001517func (c *configImpl) SetBuildBrokenNinjaUsesEnvVars(val []string) {
1518 c.brokenNinjaEnvVars = val
1519}
1520
1521func (c *configImpl) BuildBrokenNinjaUsesEnvVars() []string {
1522 return c.brokenNinjaEnvVars
1523}
1524
Dan Willemsen6ab79db2018-05-02 00:06:28 -07001525func (c *configImpl) SetTargetDeviceDir(dir string) {
1526 c.targetDeviceDir = dir
1527}
1528
1529func (c *configImpl) TargetDeviceDir() string {
1530 return c.targetDeviceDir
1531}
Dan Willemsenfa42f3c2018-06-15 21:54:47 -07001532
Patrice Arruda219eef32020-06-01 17:29:30 +00001533func (c *configImpl) BuildDateTime() string {
1534 return c.buildDateTime
1535}
1536
1537func (c *configImpl) MetricsUploaderApp() string {
Yu Liu6e13b402021-07-27 14:29:06 -07001538 return c.metricsUploader
Patrice Arruda219eef32020-06-01 17:29:30 +00001539}
Patrice Arruda83842d72020-12-08 19:42:08 +00001540
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux947fdbf2021-11-10 09:55:20 -05001541// LogsDir returns the absolute path to the logs directory where build log and
1542// metrics files are located. By default, the logs directory is the out
Patrice Arruda83842d72020-12-08 19:42:08 +00001543// directory. If the argument dist is specified, the logs directory
1544// is <dist_dir>/logs.
1545func (c *configImpl) LogsDir() string {
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux947fdbf2021-11-10 09:55:20 -05001546 dir := c.OutDir()
Patrice Arruda83842d72020-12-08 19:42:08 +00001547 if c.Dist() {
Rupert Shuttleworth3c9f5ac2020-12-10 11:32:38 +00001548 // 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 -05001549 dir = filepath.Join(c.RealDistDir(), "logs")
Patrice Arruda83842d72020-12-08 19:42:08 +00001550 }
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux947fdbf2021-11-10 09:55:20 -05001551 absDir, err := filepath.Abs(dir)
1552 if err != nil {
1553 fmt.Fprintf(os.Stderr, "\nError making log dir '%s' absolute: %s\n", dir, err.Error())
1554 os.Exit(1)
1555 }
1556 return absDir
Patrice Arruda83842d72020-12-08 19:42:08 +00001557}
1558
1559// BazelMetricsDir returns the <logs dir>/bazel_metrics directory
1560// where the bazel profiles are located.
1561func (c *configImpl) BazelMetricsDir() string {
1562 return filepath.Join(c.LogsDir(), "bazel_metrics")
1563}
Colin Crossf3bdbcb2021-06-01 11:43:55 -07001564
Chris Parsons53f68ae2022-03-03 12:01:40 -05001565// MkFileMetrics returns the file path for make-related metrics.
1566func (c *configImpl) MkMetrics() string {
1567 return filepath.Join(c.LogsDir(), "mk_metrics.pb")
1568}
1569
Colin Crossf3bdbcb2021-06-01 11:43:55 -07001570func (c *configImpl) SetEmptyNinjaFile(v bool) {
1571 c.emptyNinjaFile = v
1572}
1573
1574func (c *configImpl) EmptyNinjaFile() bool {
1575 return c.emptyNinjaFile
1576}
Yu Liu6e13b402021-07-27 14:29:06 -07001577
Romain Jobredeaux0a7529b2022-10-26 12:56:41 -04001578func (c *configImpl) IsBazelMixedBuildForceDisabled() bool {
1579 return c.Environment().IsEnvTrue("BUILD_BROKEN_DISABLE_BAZEL")
1580}
1581
Chris Parsons9402ca82023-02-23 17:28:06 -05001582func (c *configImpl) IsPersistentBazelEnabled() bool {
1583 return c.Environment().IsEnvTrue("USE_PERSISTENT_BAZEL")
1584}
1585
MarkDacekd06db5d2022-11-29 00:47:59 +00001586func (c *configImpl) BazelModulesForceEnabledByFlag() string {
1587 return c.bazelForceEnabledModules
1588}
1589
MarkDacekd0e7cd32022-12-02 22:22:40 +00001590func (c *configImpl) SkipMetricsUpload() bool {
1591 return c.skipMetricsUpload
1592}
1593
MarkDacek6614d9c2022-12-07 21:57:38 +00001594// Returns a Time object if one was passed via a command-line flag.
1595// Otherwise returns the passed default.
1596func (c *configImpl) BuildStartedTimeOrDefault(defaultTime time.Time) time.Time {
1597 if c.buildStartedTime == 0 {
1598 return defaultTime
1599 }
1600 return time.UnixMilli(c.buildStartedTime)
1601}
1602
Yu Liu6e13b402021-07-27 14:29:06 -07001603func GetMetricsUploader(topDir string, env *Environment) string {
1604 if p, ok := env.Get("METRICS_UPLOADER"); ok {
1605 metricsUploader := filepath.Join(topDir, p)
1606 if _, err := os.Stat(metricsUploader); err == nil {
1607 return metricsUploader
1608 }
1609 }
1610
1611 return ""
1612}