blob: e567e403e9c9de4144e87d05490793ba49ece069 [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 (
Dan Willemsenc2af0be2017-01-20 14:10:01 -080018 "os"
Dan Willemsen1e704462016-08-21 15:17:17 -070019 "path/filepath"
20 "runtime"
21 "strconv"
22 "strings"
Nan Zhang2e6a4ff2018-02-14 13:27:26 -080023 "time"
Jeff Gastonefc1b412017-03-29 17:29:06 -070024
25 "android/soong/shared"
Dan Willemsen1e704462016-08-21 15:17:17 -070026)
27
28type Config struct{ *configImpl }
29
30type configImpl struct {
31 // From the environment
Colin Cross28f527c2019-11-26 16:19:04 -080032 arguments []string
33 goma bool
34 environ *Environment
35 distDir string
36 buildDateTime string
Dan Willemsen1e704462016-08-21 15:17:17 -070037
38 // From the arguments
Colin Cross37193492017-11-16 17:55:00 -080039 parallel int
40 keepGoing int
41 verbose bool
42 checkbuild bool
43 dist bool
44 skipMake bool
Dan Willemsen1e704462016-08-21 15:17:17 -070045
46 // From the product config
Dan Willemsen6ab79db2018-05-02 00:06:28 -070047 katiArgs []string
48 ninjaArgs []string
49 katiSuffix string
50 targetDevice string
51 targetDeviceDir string
Dan Willemsen3d60b112018-04-04 22:25:56 -070052
Dan Willemsen2bb82d02019-12-27 09:35:42 -080053 // Autodetected
54 totalRAM uint64
55
Dan Willemsend8aa39d2018-08-27 15:01:03 -070056 pdkBuild bool
57
Dan Willemsene3336352020-01-02 19:10:38 -080058 brokenDupRules bool
59 brokenUsesNetwork bool
60 brokenNinjaEnvVars []string
Dan Willemsen18490112018-05-25 16:30:04 -070061
62 pathReplaced bool
Dan Willemsen1e704462016-08-21 15:17:17 -070063}
64
Dan Willemsenc2af0be2017-01-20 14:10:01 -080065const srcDirFileCheck = "build/soong/root.bp"
66
Patrice Arruda9450d0b2019-07-08 11:06:46 -070067var buildFiles = []string{"Android.mk", "Android.bp"}
68
Patrice Arruda13848222019-04-22 17:12:02 -070069type BuildAction uint
70
71const (
72 // Builds all of the modules and their dependencies of a specified directory, relative to the root
73 // directory of the source tree.
74 BUILD_MODULES_IN_A_DIRECTORY BuildAction = iota
75
76 // Builds all of the modules and their dependencies of a list of specified directories. All specified
77 // directories are relative to the root directory of the source tree.
78 BUILD_MODULES_IN_DIRECTORIES
Patrice Arruda39282062019-06-20 16:35:12 -070079
80 // Build a list of specified modules. If none was specified, simply build the whole source tree.
81 BUILD_MODULES
Patrice Arruda13848222019-04-22 17:12:02 -070082)
83
84// checkTopDir validates that the current directory is at the root directory of the source tree.
85func checkTopDir(ctx Context) {
86 if _, err := os.Stat(srcDirFileCheck); err != nil {
87 if os.IsNotExist(err) {
88 ctx.Fatalf("Current working directory must be the source tree. %q not found.", srcDirFileCheck)
89 }
90 ctx.Fatalln("Error verifying tree state:", err)
91 }
92}
93
Dan Willemsen1e704462016-08-21 15:17:17 -070094func NewConfig(ctx Context, args ...string) Config {
95 ret := &configImpl{
96 environ: OsEnvironment(),
97 }
98
Dan Willemsen9b587492017-07-10 22:13:00 -070099 // Sane default matching ninja
100 ret.parallel = runtime.NumCPU() + 2
101 ret.keepGoing = 1
102
Dan Willemsen2bb82d02019-12-27 09:35:42 -0800103 ret.totalRAM = detectTotalRAM(ctx)
104
Dan Willemsen9b587492017-07-10 22:13:00 -0700105 ret.parseArgs(ctx, args)
106
Dan Willemsen0c3919e2017-03-02 15:49:10 -0800107 // Make sure OUT_DIR is set appropriately
Dan Willemsen02f3add2017-05-12 13:50:19 -0700108 if outDir, ok := ret.environ.Get("OUT_DIR"); ok {
109 ret.environ.Set("OUT_DIR", filepath.Clean(outDir))
110 } else {
Dan Willemsen0c3919e2017-03-02 15:49:10 -0800111 outDir := "out"
112 if baseDir, ok := ret.environ.Get("OUT_DIR_COMMON_BASE"); ok {
113 if wd, err := os.Getwd(); err != nil {
114 ctx.Fatalln("Failed to get working directory:", err)
115 } else {
116 outDir = filepath.Join(baseDir, filepath.Base(wd))
117 }
118 }
119 ret.environ.Set("OUT_DIR", outDir)
120 }
121
Dan Willemsen2d31a442018-10-20 21:33:41 -0700122 if distDir, ok := ret.environ.Get("DIST_DIR"); ok {
123 ret.distDir = filepath.Clean(distDir)
124 } else {
125 ret.distDir = filepath.Join(ret.OutDir(), "dist")
126 }
Dan Willemsend50e89f2018-10-16 17:49:25 -0700127
Dan Willemsen1e704462016-08-21 15:17:17 -0700128 ret.environ.Unset(
129 // We're already using it
130 "USE_SOONG_UI",
131
132 // We should never use GOROOT/GOPATH from the shell environment
133 "GOROOT",
134 "GOPATH",
135
136 // These should only come from Soong, not the environment.
137 "CLANG",
138 "CLANG_CXX",
139 "CCC_CC",
140 "CCC_CXX",
141
142 // Used by the goma compiler wrapper, but should only be set by
143 // gomacc
144 "GOMACC_PATH",
Dan Willemsen0c3919e2017-03-02 15:49:10 -0800145
146 // We handle this above
147 "OUT_DIR_COMMON_BASE",
Dan Willemsen68a09852017-04-18 13:56:57 -0700148
Dan Willemsen2d31a442018-10-20 21:33:41 -0700149 // This is handled above too, and set for individual commands later
150 "DIST_DIR",
151
Dan Willemsen68a09852017-04-18 13:56:57 -0700152 // Variables that have caused problems in the past
Dan Willemsen1c504d92019-11-18 19:13:53 +0000153 "BASH_ENV",
Dan Willemsenebfe33a2018-05-01 10:07:50 -0700154 "CDPATH",
Dan Willemsen68a09852017-04-18 13:56:57 -0700155 "DISPLAY",
156 "GREP_OPTIONS",
Dan Willemsenebfe33a2018-05-01 10:07:50 -0700157 "NDK_ROOT",
Dan Willemsen00fcb262018-08-15 15:35:38 -0700158 "POSIXLY_CORRECT",
Dan Willemsenc40e10b2017-07-11 14:30:00 -0700159
160 // Drop make flags
161 "MAKEFLAGS",
162 "MAKELEVEL",
163 "MFLAGS",
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700164
165 // Set in envsetup.sh, reset in makefiles
166 "ANDROID_JAVA_TOOLCHAIN",
Colin Cross7f09c402018-07-11 14:49:31 -0700167
168 // Set by envsetup.sh, but shouldn't be used inside the build because envsetup.sh is optional
169 "ANDROID_BUILD_TOP",
170 "ANDROID_HOST_OUT",
171 "ANDROID_PRODUCT_OUT",
172 "ANDROID_HOST_OUT_TESTCASES",
173 "ANDROID_TARGET_OUT_TESTCASES",
174 "ANDROID_TOOLCHAIN",
175 "ANDROID_TOOLCHAIN_2ND_ARCH",
176 "ANDROID_DEV_SCRIPTS",
177 "ANDROID_EMULATOR_PREBUILTS",
178 "ANDROID_PRE_BUILD_PATHS",
Dan Willemsenf99915f2018-10-25 22:04:42 -0700179
180 // Only set in multiproduct_kati after config generation
181 "EMPTY_NINJA_FILE",
Dan Willemsen1e704462016-08-21 15:17:17 -0700182 )
183
184 // Tell python not to spam the source tree with .pyc files.
185 ret.environ.Set("PYTHONDONTWRITEBYTECODE", "1")
186
Dan Willemsen32a669b2018-03-08 19:42:00 -0800187 ret.environ.Set("TMPDIR", absPath(ctx, ret.TempDir()))
188
Dan Willemsen70c1ff82019-08-21 14:56:13 -0700189 // Always set ASAN_SYMBOLIZER_PATH so that ASAN-based tools can symbolize any crashes
190 symbolizerPath := filepath.Join("prebuilts/clang/host", ret.HostPrebuiltTag(),
191 "llvm-binutils-stable/llvm-symbolizer")
192 ret.environ.Set("ASAN_SYMBOLIZER_PATH", absPath(ctx, symbolizerPath))
193
Dan Willemsenc2af0be2017-01-20 14:10:01 -0800194 // Precondition: the current directory is the top of the source tree
Patrice Arruda13848222019-04-22 17:12:02 -0700195 checkTopDir(ctx)
Dan Willemsenc2af0be2017-01-20 14:10:01 -0800196
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700197 if srcDir := absPath(ctx, "."); strings.ContainsRune(srcDir, ' ') {
Colin Cross1f6faeb2019-09-23 15:52:40 -0700198 ctx.Println("You are building in a directory whose absolute path contains a space character:")
199 ctx.Println()
200 ctx.Printf("%q\n", srcDir)
201 ctx.Println()
202 ctx.Fatalln("Directory names containing spaces are not supported")
Dan Willemsendb8457c2017-05-12 16:38:17 -0700203 }
204
205 if outDir := ret.OutDir(); strings.ContainsRune(outDir, ' ') {
Colin Cross1f6faeb2019-09-23 15:52:40 -0700206 ctx.Println("The absolute path of your output directory ($OUT_DIR) contains a space character:")
207 ctx.Println()
208 ctx.Printf("%q\n", outDir)
209 ctx.Println()
210 ctx.Fatalln("Directory names containing spaces are not supported")
Dan Willemsendb8457c2017-05-12 16:38:17 -0700211 }
212
213 if distDir := ret.DistDir(); strings.ContainsRune(distDir, ' ') {
Colin Cross1f6faeb2019-09-23 15:52:40 -0700214 ctx.Println("The absolute path of your dist directory ($DIST_DIR) contains a space character:")
215 ctx.Println()
216 ctx.Printf("%q\n", distDir)
217 ctx.Println()
218 ctx.Fatalln("Directory names containing spaces are not supported")
Dan Willemsendb8457c2017-05-12 16:38:17 -0700219 }
220
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700221 // Configure Java-related variables, including adding it to $PATH
Tobias Thierere59aeff2017-12-20 22:40:39 +0000222 java8Home := filepath.Join("prebuilts/jdk/jdk8", ret.HostPrebuiltTag())
223 java9Home := filepath.Join("prebuilts/jdk/jdk9", ret.HostPrebuiltTag())
Pete Gillin1f52e932019-10-09 17:10:08 +0100224 java11Home := filepath.Join("prebuilts/jdk/jdk11", ret.HostPrebuiltTag())
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700225 javaHome := func() string {
226 if override, ok := ret.environ.Get("OVERRIDE_ANDROID_JAVA_HOME"); ok {
227 return override
228 }
Pete Gillina7a3d642019-11-07 18:58:42 +0000229 if toolchain11, ok := ret.environ.Get("EXPERIMENTAL_USE_OPENJDK11_TOOLCHAIN"); ok && toolchain11 != "true" {
230 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 +0100231 }
Pete Gillinabbcdda2019-10-28 16:15:33 +0000232 return java11Home
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700233 }()
234 absJavaHome := absPath(ctx, javaHome)
235
Dan Willemsened869522018-01-08 14:58:46 -0800236 ret.configureLocale(ctx)
237
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700238 newPath := []string{filepath.Join(absJavaHome, "bin")}
239 if path, ok := ret.environ.Get("PATH"); ok && path != "" {
240 newPath = append(newPath, path)
241 }
Pete Gillin1f52e932019-10-09 17:10:08 +0100242
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700243 ret.environ.Unset("OVERRIDE_ANDROID_JAVA_HOME")
244 ret.environ.Set("JAVA_HOME", absJavaHome)
245 ret.environ.Set("ANDROID_JAVA_HOME", javaHome)
Tobias Thierere59aeff2017-12-20 22:40:39 +0000246 ret.environ.Set("ANDROID_JAVA8_HOME", java8Home)
247 ret.environ.Set("ANDROID_JAVA9_HOME", java9Home)
Pete Gillin1f52e932019-10-09 17:10:08 +0100248 ret.environ.Set("ANDROID_JAVA11_HOME", java11Home)
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700249 ret.environ.Set("PATH", strings.Join(newPath, string(filepath.ListSeparator)))
250
Nan Zhang2e6a4ff2018-02-14 13:27:26 -0800251 outDir := ret.OutDir()
252 buildDateTimeFile := filepath.Join(outDir, "build_date.txt")
Nan Zhang2e6a4ff2018-02-14 13:27:26 -0800253 if buildDateTime, ok := ret.environ.Get("BUILD_DATETIME"); ok && buildDateTime != "" {
Colin Cross28f527c2019-11-26 16:19:04 -0800254 ret.buildDateTime = buildDateTime
Nan Zhang2e6a4ff2018-02-14 13:27:26 -0800255 } else {
Colin Cross28f527c2019-11-26 16:19:04 -0800256 ret.buildDateTime = strconv.FormatInt(time.Now().Unix(), 10)
Nan Zhang2e6a4ff2018-02-14 13:27:26 -0800257 }
Colin Cross28f527c2019-11-26 16:19:04 -0800258
Nan Zhang17f27672018-12-12 16:01:49 -0800259 if ctx.Metrics != nil {
Colin Cross28f527c2019-11-26 16:19:04 -0800260 ctx.Metrics.SetBuildDateTime(ret.buildDateTime)
Nan Zhang2e6a4ff2018-02-14 13:27:26 -0800261 }
262 ret.environ.Set("BUILD_DATETIME_FILE", buildDateTimeFile)
263
Dan Willemsen9b587492017-07-10 22:13:00 -0700264 return Config{ret}
265}
266
Patrice Arruda13848222019-04-22 17:12:02 -0700267// NewBuildActionConfig returns a build configuration based on the build action. The arguments are
268// processed based on the build action and extracts any arguments that belongs to the build action.
Dan Willemsence41e942019-07-29 23:39:30 -0700269func NewBuildActionConfig(action BuildAction, dir string, ctx Context, args ...string) Config {
270 return NewConfig(ctx, getConfigArgs(action, dir, ctx, args)...)
Patrice Arruda13848222019-04-22 17:12:02 -0700271}
272
273// getConfigArgs processes the command arguments based on the build action and creates a set of new
274// arguments to be accepted by Config.
Dan Willemsence41e942019-07-29 23:39:30 -0700275func getConfigArgs(action BuildAction, dir string, ctx Context, args []string) []string {
Patrice Arruda13848222019-04-22 17:12:02 -0700276 // The next block of code verifies that the current directory is the root directory of the source
277 // tree. It then finds the relative path of dir based on the root directory of the source tree
278 // and verify that dir is inside of the source tree.
279 checkTopDir(ctx)
280 topDir, err := os.Getwd()
281 if err != nil {
282 ctx.Fatalf("Error retrieving top directory: %v", err)
283 }
Patrice Arrudababa9a92019-07-03 10:47:34 -0700284 dir, err = filepath.EvalSymlinks(dir)
285 if err != nil {
286 ctx.Fatalf("Unable to evaluate symlink of %s: %v", dir, err)
287 }
Patrice Arruda13848222019-04-22 17:12:02 -0700288 dir, err = filepath.Abs(dir)
289 if err != nil {
290 ctx.Fatalf("Unable to find absolute path %s: %v", dir, err)
291 }
292 relDir, err := filepath.Rel(topDir, dir)
293 if err != nil {
294 ctx.Fatalf("Unable to find relative path %s of %s: %v", relDir, topDir, err)
295 }
296 // If there are ".." in the path, it's not in the source tree.
297 if strings.Contains(relDir, "..") {
298 ctx.Fatalf("Directory %s is not under the source tree %s", dir, topDir)
299 }
300
301 configArgs := args[:]
302
303 // If the arguments contains GET-INSTALL-PATH, change the target name prefix from MODULES-IN- to
304 // GET-INSTALL-PATH-IN- to extract the installation path instead of building the modules.
305 targetNamePrefix := "MODULES-IN-"
306 if inList("GET-INSTALL-PATH", configArgs) {
307 targetNamePrefix = "GET-INSTALL-PATH-IN-"
308 configArgs = removeFromList("GET-INSTALL-PATH", configArgs)
309 }
310
Patrice Arruda13848222019-04-22 17:12:02 -0700311 var targets []string
312
313 switch action {
Patrice Arruda39282062019-06-20 16:35:12 -0700314 case BUILD_MODULES:
315 // No additional processing is required when building a list of specific modules or all modules.
Patrice Arruda13848222019-04-22 17:12:02 -0700316 case BUILD_MODULES_IN_A_DIRECTORY:
317 // If dir is the root source tree, all the modules are built of the source tree are built so
318 // no need to find the build file.
319 if topDir == dir {
320 break
321 }
Patrice Arruda0dcf27f2019-07-08 17:03:33 -0700322
Patrice Arruda13848222019-04-22 17:12:02 -0700323 buildFile := findBuildFile(ctx, relDir)
324 if buildFile == "" {
Patrice Arruda0dcf27f2019-07-08 17:03:33 -0700325 ctx.Fatalf("Build file not found for %s directory", relDir)
Patrice Arruda13848222019-04-22 17:12:02 -0700326 }
Patrice Arruda13848222019-04-22 17:12:02 -0700327 targets = []string{convertToTarget(filepath.Dir(buildFile), targetNamePrefix)}
328 case BUILD_MODULES_IN_DIRECTORIES:
329 newConfigArgs, dirs := splitArgs(configArgs)
330 configArgs = newConfigArgs
Dan Willemsence41e942019-07-29 23:39:30 -0700331 targets = getTargetsFromDirs(ctx, relDir, dirs, targetNamePrefix)
Patrice Arruda13848222019-04-22 17:12:02 -0700332 }
333
334 // Tidy only override all other specified targets.
335 tidyOnly := os.Getenv("WITH_TIDY_ONLY")
336 if tidyOnly == "true" || tidyOnly == "1" {
337 configArgs = append(configArgs, "tidy_only")
338 } else {
339 configArgs = append(configArgs, targets...)
340 }
341
342 return configArgs
343}
344
345// convertToTarget replaces "/" to "-" in dir and pre-append the targetNamePrefix to the target name.
346func convertToTarget(dir string, targetNamePrefix string) string {
347 return targetNamePrefix + strings.ReplaceAll(dir, "/", "-")
348}
349
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700350// hasBuildFile returns true if dir contains an Android build file.
351func hasBuildFile(ctx Context, dir string) bool {
352 for _, buildFile := range buildFiles {
353 _, err := os.Stat(filepath.Join(dir, buildFile))
354 if err == nil {
355 return true
356 }
357 if !os.IsNotExist(err) {
358 ctx.Fatalf("Error retrieving the build file stats: %v", err)
359 }
360 }
361 return false
362}
363
Patrice Arruda0dcf27f2019-07-08 17:03:33 -0700364// findBuildFile finds a build file (makefile or blueprint file) by looking if there is a build file
365// in the current and any sub directory of dir. If a build file is not found, traverse the path
366// up by one directory and repeat again until either a build file is found or reached to the root
367// source tree. The returned filename of build file is "Android.mk". If one was not found, a blank
368// string is returned.
Patrice Arruda13848222019-04-22 17:12:02 -0700369func findBuildFile(ctx Context, dir string) string {
Patrice Arruda0dcf27f2019-07-08 17:03:33 -0700370 // If the string is empty or ".", assume it is top directory of the source tree.
371 if dir == "" || dir == "." {
Patrice Arruda13848222019-04-22 17:12:02 -0700372 return ""
373 }
374
Patrice Arruda0dcf27f2019-07-08 17:03:33 -0700375 found := false
376 for buildDir := dir; buildDir != "."; buildDir = filepath.Dir(buildDir) {
377 err := filepath.Walk(buildDir, func(path string, info os.FileInfo, err error) error {
378 if err != nil {
379 return err
380 }
381 if found {
382 return filepath.SkipDir
383 }
384 if info.IsDir() {
385 return nil
386 }
387 for _, buildFile := range buildFiles {
388 if info.Name() == buildFile {
389 found = true
390 return filepath.SkipDir
391 }
392 }
393 return nil
394 })
395 if err != nil {
396 ctx.Fatalf("Error finding Android build file: %v", err)
397 }
398
399 if found {
400 return filepath.Join(buildDir, "Android.mk")
Patrice Arruda13848222019-04-22 17:12:02 -0700401 }
402 }
403
404 return ""
405}
406
407// splitArgs iterates over the arguments list and splits into two lists: arguments and directories.
408func splitArgs(args []string) (newArgs []string, dirs []string) {
409 specialArgs := map[string]bool{
410 "showcommands": true,
411 "snod": true,
412 "dist": true,
413 "checkbuild": true,
414 }
415
416 newArgs = []string{}
417 dirs = []string{}
418
419 for _, arg := range args {
420 // It's a dash argument if it starts with "-" or it's a key=value pair, it's not a directory.
421 if strings.IndexRune(arg, '-') == 0 || strings.IndexRune(arg, '=') != -1 {
422 newArgs = append(newArgs, arg)
423 continue
424 }
425
426 if _, ok := specialArgs[arg]; ok {
427 newArgs = append(newArgs, arg)
428 continue
429 }
430
431 dirs = append(dirs, arg)
432 }
433
434 return newArgs, dirs
435}
436
437// getTargetsFromDirs iterates over the dirs list and creates a list of targets to build. If a
438// directory from the dirs list does not exist, a fatal error is raised. relDir is related to the
439// source root tree where the build action command was invoked. Each directory is validated if the
440// build file can be found and follows the format "dir1:target1,target2,...". Target is optional.
Dan Willemsence41e942019-07-29 23:39:30 -0700441func getTargetsFromDirs(ctx Context, relDir string, dirs []string, targetNamePrefix string) (targets []string) {
Patrice Arruda13848222019-04-22 17:12:02 -0700442 for _, dir := range dirs {
443 // The directory may have specified specific modules to build. ":" is the separator to separate
444 // the directory and the list of modules.
445 s := strings.Split(dir, ":")
446 l := len(s)
447 if l > 2 { // more than one ":" was specified.
448 ctx.Fatalf("%s not in proper directory:target1,target2,... format (\":\" was specified more than once)", dir)
449 }
450
451 dir = filepath.Join(relDir, s[0])
452 if _, err := os.Stat(dir); err != nil {
453 ctx.Fatalf("couldn't find directory %s", dir)
454 }
455
456 // Verify that if there are any targets specified after ":". Each target is separated by ",".
457 var newTargets []string
458 if l == 2 && s[1] != "" {
459 newTargets = strings.Split(s[1], ",")
460 if inList("", newTargets) {
461 ctx.Fatalf("%s not in proper directory:target1,target2,... format", dir)
462 }
463 }
464
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700465 // If there are specified targets to build in dir, an android build file must exist for the one
466 // shot build. For the non-targets case, find the appropriate build file and build all the
467 // modules in dir (or the closest one in the dir path).
Patrice Arruda13848222019-04-22 17:12:02 -0700468 if len(newTargets) > 0 {
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700469 if !hasBuildFile(ctx, dir) {
Patrice Arruda13848222019-04-22 17:12:02 -0700470 ctx.Fatalf("Couldn't locate a build file from %s directory", dir)
471 }
472 } else {
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700473 buildFile := findBuildFile(ctx, dir)
474 if buildFile == "" {
475 ctx.Fatalf("Build file not found for %s directory", dir)
476 }
477 newTargets = []string{convertToTarget(filepath.Dir(buildFile), targetNamePrefix)}
Patrice Arruda13848222019-04-22 17:12:02 -0700478 }
479
Patrice Arruda13848222019-04-22 17:12:02 -0700480 targets = append(targets, newTargets...)
481 }
482
Dan Willemsence41e942019-07-29 23:39:30 -0700483 return targets
Patrice Arruda13848222019-04-22 17:12:02 -0700484}
485
Dan Willemsen9b587492017-07-10 22:13:00 -0700486func (c *configImpl) parseArgs(ctx Context, args []string) {
487 for i := 0; i < len(args); i++ {
488 arg := strings.TrimSpace(args[i])
Dan Willemsen1e704462016-08-21 15:17:17 -0700489 if arg == "--make-mode" {
Dan Willemsen1e704462016-08-21 15:17:17 -0700490 } else if arg == "showcommands" {
Dan Willemsen9b587492017-07-10 22:13:00 -0700491 c.verbose = true
Dan Willemsene0879fc2017-08-04 15:06:27 -0700492 } else if arg == "--skip-make" {
493 c.skipMake = true
Dan Willemsen6ac63ef2017-10-17 20:35:34 -0700494 } else if len(arg) > 0 && arg[0] == '-' {
Dan Willemsen9b587492017-07-10 22:13:00 -0700495 parseArgNum := func(def int) int {
496 if len(arg) > 2 {
497 p, err := strconv.ParseUint(arg[2:], 10, 31)
498 if err != nil {
499 ctx.Fatalf("Failed to parse %q: %v", arg, err)
500 }
501 return int(p)
502 } else if i+1 < len(args) {
503 p, err := strconv.ParseUint(args[i+1], 10, 31)
504 if err == nil {
505 i++
506 return int(p)
507 }
508 }
509 return def
510 }
511
Dan Willemsen6ac63ef2017-10-17 20:35:34 -0700512 if len(arg) > 1 && arg[1] == 'j' {
Dan Willemsen9b587492017-07-10 22:13:00 -0700513 c.parallel = parseArgNum(c.parallel)
Dan Willemsen6ac63ef2017-10-17 20:35:34 -0700514 } else if len(arg) > 1 && arg[1] == 'k' {
Dan Willemsen9b587492017-07-10 22:13:00 -0700515 c.keepGoing = parseArgNum(0)
Dan Willemsen1e704462016-08-21 15:17:17 -0700516 } else {
517 ctx.Fatalln("Unknown option:", arg)
518 }
Dan Willemsen091525e2017-07-11 14:17:50 -0700519 } else if k, v, ok := decodeKeyValue(arg); ok && len(k) > 0 {
Dan Willemsen6dfe30a2018-09-10 12:41:10 -0700520 if k == "OUT_DIR" {
521 ctx.Fatalln("OUT_DIR may only be set in the environment, not as a command line option.")
522 }
Dan Willemsen091525e2017-07-11 14:17:50 -0700523 c.environ.Set(k, v)
Dan Willemsen2d31a442018-10-20 21:33:41 -0700524 } else if arg == "dist" {
525 c.dist = true
Dan Willemsen1e704462016-08-21 15:17:17 -0700526 } else {
Dan Willemsen2d31a442018-10-20 21:33:41 -0700527 if arg == "checkbuild" {
Colin Cross37193492017-11-16 17:55:00 -0800528 c.checkbuild = true
Dan Willemsene0879fc2017-08-04 15:06:27 -0700529 }
Dan Willemsen9b587492017-07-10 22:13:00 -0700530 c.arguments = append(c.arguments, arg)
Dan Willemsen1e704462016-08-21 15:17:17 -0700531 }
532 }
Dan Willemsen1e704462016-08-21 15:17:17 -0700533}
534
Dan Willemsened869522018-01-08 14:58:46 -0800535func (c *configImpl) configureLocale(ctx Context) {
536 cmd := Command(ctx, Config{c}, "locale", "locale", "-a")
537 output, err := cmd.Output()
538
539 var locales []string
540 if err == nil {
541 locales = strings.Split(string(output), "\n")
542 } else {
543 // If we're unable to list the locales, let's assume en_US.UTF-8
544 locales = []string{"en_US.UTF-8"}
545 ctx.Verbosef("Failed to list locales (%q), falling back to %q", err, locales)
546 }
547
548 // gettext uses LANGUAGE, which is passed directly through
549
550 // For LANG and LC_*, only preserve the evaluated version of
551 // LC_MESSAGES
552 user_lang := ""
553 if lc_all, ok := c.environ.Get("LC_ALL"); ok {
554 user_lang = lc_all
555 } else if lc_messages, ok := c.environ.Get("LC_MESSAGES"); ok {
556 user_lang = lc_messages
557 } else if lang, ok := c.environ.Get("LANG"); ok {
558 user_lang = lang
559 }
560
561 c.environ.UnsetWithPrefix("LC_")
562
563 if user_lang != "" {
564 c.environ.Set("LC_MESSAGES", user_lang)
565 }
566
567 // The for LANG, use C.UTF-8 if it exists (Debian currently, proposed
568 // for others)
569 if inList("C.UTF-8", locales) {
570 c.environ.Set("LANG", "C.UTF-8")
Aaron Klingd236e0e2018-08-07 19:21:36 -0500571 } else if inList("C.utf8", locales) {
572 // These normalize to the same thing
573 c.environ.Set("LANG", "C.UTF-8")
Dan Willemsened869522018-01-08 14:58:46 -0800574 } else if inList("en_US.UTF-8", locales) {
575 c.environ.Set("LANG", "en_US.UTF-8")
576 } else if inList("en_US.utf8", locales) {
577 // These normalize to the same thing
578 c.environ.Set("LANG", "en_US.UTF-8")
579 } else {
580 ctx.Fatalln("System doesn't support either C.UTF-8 or en_US.UTF-8")
581 }
582}
583
Dan Willemsen1e704462016-08-21 15:17:17 -0700584// Lunch configures the environment for a specific product similarly to the
585// `lunch` bash function.
586func (c *configImpl) Lunch(ctx Context, product, variant string) {
587 if variant != "eng" && variant != "userdebug" && variant != "user" {
588 ctx.Fatalf("Invalid variant %q. Must be one of 'user', 'userdebug' or 'eng'", variant)
589 }
590
591 c.environ.Set("TARGET_PRODUCT", product)
592 c.environ.Set("TARGET_BUILD_VARIANT", variant)
593 c.environ.Set("TARGET_BUILD_TYPE", "release")
594 c.environ.Unset("TARGET_BUILD_APPS")
Martin Stjernholm08802332020-06-04 17:00:01 +0100595 c.environ.Unset("TARGET_BUILD_UNBUNDLED")
Dan Willemsen1e704462016-08-21 15:17:17 -0700596}
597
598// Tapas configures the environment to build one or more unbundled apps,
599// similarly to the `tapas` bash function.
600func (c *configImpl) Tapas(ctx Context, apps []string, arch, variant string) {
601 if len(apps) == 0 {
602 apps = []string{"all"}
603 }
604 if variant == "" {
605 variant = "eng"
606 }
607
608 if variant != "eng" && variant != "userdebug" && variant != "user" {
609 ctx.Fatalf("Invalid variant %q. Must be one of 'user', 'userdebug' or 'eng'", variant)
610 }
611
612 var product string
613 switch arch {
Dan Willemsen1e704462016-08-21 15:17:17 -0700614 case "arm", "":
615 product = "aosp_arm"
616 case "arm64":
617 product = "aosm_arm64"
Dan Willemsen1e704462016-08-21 15:17:17 -0700618 case "x86":
619 product = "aosp_x86"
620 case "x86_64":
621 product = "aosp_x86_64"
622 default:
623 ctx.Fatalf("Invalid architecture: %q", arch)
624 }
625
626 c.environ.Set("TARGET_PRODUCT", product)
627 c.environ.Set("TARGET_BUILD_VARIANT", variant)
628 c.environ.Set("TARGET_BUILD_TYPE", "release")
629 c.environ.Set("TARGET_BUILD_APPS", strings.Join(apps, " "))
630}
631
632func (c *configImpl) Environment() *Environment {
633 return c.environ
634}
635
636func (c *configImpl) Arguments() []string {
637 return c.arguments
638}
639
640func (c *configImpl) OutDir() string {
641 if outDir, ok := c.environ.Get("OUT_DIR"); ok {
Patrice Arruda19bd53e2019-07-08 17:26:47 -0700642 return outDir
Dan Willemsen1e704462016-08-21 15:17:17 -0700643 }
644 return "out"
645}
646
Dan Willemsen8a073a82017-02-04 17:30:44 -0800647func (c *configImpl) DistDir() string {
Dan Willemsen2d31a442018-10-20 21:33:41 -0700648 return c.distDir
Dan Willemsen8a073a82017-02-04 17:30:44 -0800649}
650
Dan Willemsen1e704462016-08-21 15:17:17 -0700651func (c *configImpl) NinjaArgs() []string {
Dan Willemsene0879fc2017-08-04 15:06:27 -0700652 if c.skipMake {
653 return c.arguments
654 }
Dan Willemsen1e704462016-08-21 15:17:17 -0700655 return c.ninjaArgs
656}
657
658func (c *configImpl) SoongOutDir() string {
659 return filepath.Join(c.OutDir(), "soong")
660}
661
Jeff Gastonefc1b412017-03-29 17:29:06 -0700662func (c *configImpl) TempDir() string {
663 return shared.TempDirForOutDir(c.SoongOutDir())
664}
665
Jeff Gastonb64fc1c2017-08-04 12:30:12 -0700666func (c *configImpl) FileListDir() string {
667 return filepath.Join(c.OutDir(), ".module_paths")
668}
669
Dan Willemsen1e704462016-08-21 15:17:17 -0700670func (c *configImpl) KatiSuffix() string {
671 if c.katiSuffix != "" {
672 return c.katiSuffix
673 }
674 panic("SetKatiSuffix has not been called")
675}
676
Colin Cross37193492017-11-16 17:55:00 -0800677// Checkbuild returns true if "checkbuild" was one of the build goals, which means that the
678// user is interested in additional checks at the expense of build time.
679func (c *configImpl) Checkbuild() bool {
680 return c.checkbuild
681}
682
Dan Willemsen8a073a82017-02-04 17:30:44 -0800683func (c *configImpl) Dist() bool {
684 return c.dist
685}
686
Dan Willemsen1e704462016-08-21 15:17:17 -0700687func (c *configImpl) IsVerbose() bool {
688 return c.verbose
689}
690
Dan Willemsene0879fc2017-08-04 15:06:27 -0700691func (c *configImpl) SkipMake() bool {
692 return c.skipMake
693}
694
Dan Willemsen1e704462016-08-21 15:17:17 -0700695func (c *configImpl) TargetProduct() string {
696 if v, ok := c.environ.Get("TARGET_PRODUCT"); ok {
697 return v
698 }
699 panic("TARGET_PRODUCT is not defined")
700}
701
Dan Willemsen02781d52017-05-12 19:28:13 -0700702func (c *configImpl) TargetDevice() string {
703 return c.targetDevice
704}
705
706func (c *configImpl) SetTargetDevice(device string) {
707 c.targetDevice = device
708}
709
710func (c *configImpl) TargetBuildVariant() string {
711 if v, ok := c.environ.Get("TARGET_BUILD_VARIANT"); ok {
712 return v
713 }
714 panic("TARGET_BUILD_VARIANT is not defined")
715}
716
Dan Willemsen1e704462016-08-21 15:17:17 -0700717func (c *configImpl) KatiArgs() []string {
718 return c.katiArgs
719}
720
721func (c *configImpl) Parallel() int {
722 return c.parallel
723}
724
Colin Cross8b8bec32019-11-15 13:18:43 -0800725func (c *configImpl) HighmemParallel() int {
726 if i, ok := c.environ.GetInt("NINJA_HIGHMEM_NUM_JOBS"); ok {
727 return i
728 }
729
730 const minMemPerHighmemProcess = 8 * 1024 * 1024 * 1024
731 parallel := c.Parallel()
732 if c.UseRemoteBuild() {
733 // Ninja doesn't support nested pools, and when remote builds are enabled the total ninja parallelism
734 // is set very high (i.e. 500). Using a large value here would cause the total number of running jobs
735 // to be the sum of the sizes of the local and highmem pools, which will cause extra CPU contention.
736 // Return 1/16th of the size of the local pool, rounding up.
737 return (parallel + 15) / 16
738 } else if c.totalRAM == 0 {
739 // Couldn't detect the total RAM, don't restrict highmem processes.
740 return parallel
Dan Willemsen570a2922020-05-26 23:02:29 -0700741 } else if c.totalRAM <= 16*1024*1024*1024 {
742 // Less than 16GB of ram, restrict to 1 highmem processes
743 return 1
Colin Cross8b8bec32019-11-15 13:18:43 -0800744 } else if c.totalRAM <= 32*1024*1024*1024 {
745 // Less than 32GB of ram, restrict to 2 highmem processes
746 return 2
747 } else if p := int(c.totalRAM / minMemPerHighmemProcess); p < parallel {
748 // If less than 8GB total RAM per process, reduce the number of highmem processes
749 return p
750 }
751 // No restriction on highmem processes
752 return parallel
753}
754
Dan Willemsen2bb82d02019-12-27 09:35:42 -0800755func (c *configImpl) TotalRAM() uint64 {
756 return c.totalRAM
757}
758
Dan Willemsen1e704462016-08-21 15:17:17 -0700759func (c *configImpl) UseGoma() bool {
760 if v, ok := c.environ.Get("USE_GOMA"); ok {
761 v = strings.TrimSpace(v)
762 if v != "" && v != "false" {
763 return true
764 }
765 }
766 return false
767}
768
Yoshisato Yanagisawa2cb0e5d2019-01-10 10:14:16 +0900769func (c *configImpl) StartGoma() bool {
770 if !c.UseGoma() {
771 return false
772 }
773
774 if v, ok := c.environ.Get("NOSTART_GOMA"); ok {
775 v = strings.TrimSpace(v)
776 if v != "" && v != "false" {
777 return false
778 }
779 }
780 return true
781}
782
Ramy Medhatbbf25672019-07-17 12:30:04 +0000783func (c *configImpl) UseRBE() bool {
784 if v, ok := c.environ.Get("USE_RBE"); ok {
785 v = strings.TrimSpace(v)
786 if v != "" && v != "false" {
787 return true
788 }
789 }
790 return false
791}
792
793func (c *configImpl) StartRBE() bool {
794 if !c.UseRBE() {
795 return false
796 }
797
798 if v, ok := c.environ.Get("NOSTART_RBE"); ok {
799 v = strings.TrimSpace(v)
800 if v != "" && v != "false" {
801 return false
802 }
803 }
804 return true
805}
806
Patrice Arruda62f1bf22020-07-07 12:48:26 +0000807func (c *configImpl) RBEStatsOutputDir() string {
808 for _, f := range []string{"RBE_output_dir", "FLAG_output_dir"} {
809 if v, ok := c.environ.Get(f); ok {
810 return v
811 }
812 }
813 return ""
814}
815
Colin Cross9016b912019-11-11 14:57:42 -0800816func (c *configImpl) UseRemoteBuild() bool {
817 return c.UseGoma() || c.UseRBE()
818}
819
Dan Willemsen1e704462016-08-21 15:17:17 -0700820// RemoteParallel controls how many remote jobs (i.e., commands which contain
Jeff Gastonefc1b412017-03-29 17:29:06 -0700821// gomacc) are run in parallel. Note the parallelism of all other jobs is
Dan Willemsen1e704462016-08-21 15:17:17 -0700822// still limited by Parallel()
823func (c *configImpl) RemoteParallel() int {
Colin Cross8b8bec32019-11-15 13:18:43 -0800824 if !c.UseRemoteBuild() {
825 return 0
826 }
827 if i, ok := c.environ.GetInt("NINJA_REMOTE_NUM_JOBS"); ok {
828 return i
Dan Willemsen1e704462016-08-21 15:17:17 -0700829 }
830 return 500
831}
832
833func (c *configImpl) SetKatiArgs(args []string) {
834 c.katiArgs = args
835}
836
837func (c *configImpl) SetNinjaArgs(args []string) {
838 c.ninjaArgs = args
839}
840
841func (c *configImpl) SetKatiSuffix(suffix string) {
842 c.katiSuffix = suffix
843}
844
Dan Willemsene0879fc2017-08-04 15:06:27 -0700845func (c *configImpl) LastKatiSuffixFile() string {
846 return filepath.Join(c.OutDir(), "last_kati_suffix")
847}
848
849func (c *configImpl) HasKatiSuffix() bool {
850 return c.katiSuffix != ""
851}
852
Dan Willemsen1e704462016-08-21 15:17:17 -0700853func (c *configImpl) KatiEnvFile() string {
854 return filepath.Join(c.OutDir(), "env"+c.KatiSuffix()+".sh")
855}
856
Dan Willemsen29971232018-09-26 14:58:30 -0700857func (c *configImpl) KatiBuildNinjaFile() string {
858 return filepath.Join(c.OutDir(), "build"+c.KatiSuffix()+katiBuildSuffix+".ninja")
Dan Willemsen1e704462016-08-21 15:17:17 -0700859}
860
Dan Willemsenfb1271a2018-09-26 15:00:42 -0700861func (c *configImpl) KatiPackageNinjaFile() string {
862 return filepath.Join(c.OutDir(), "build"+c.KatiSuffix()+katiPackageSuffix+".ninja")
863}
864
Dan Willemsen1e704462016-08-21 15:17:17 -0700865func (c *configImpl) SoongNinjaFile() string {
866 return filepath.Join(c.SoongOutDir(), "build.ninja")
867}
868
869func (c *configImpl) CombinedNinjaFile() string {
Dan Willemsene0879fc2017-08-04 15:06:27 -0700870 if c.katiSuffix == "" {
871 return filepath.Join(c.OutDir(), "combined.ninja")
872 }
Dan Willemsen1e704462016-08-21 15:17:17 -0700873 return filepath.Join(c.OutDir(), "combined"+c.KatiSuffix()+".ninja")
874}
875
876func (c *configImpl) SoongAndroidMk() string {
877 return filepath.Join(c.SoongOutDir(), "Android-"+c.TargetProduct()+".mk")
878}
879
880func (c *configImpl) SoongMakeVarsMk() string {
881 return filepath.Join(c.SoongOutDir(), "make_vars-"+c.TargetProduct()+".mk")
882}
883
Dan Willemsenf052f782017-05-18 15:29:04 -0700884func (c *configImpl) ProductOut() string {
Dan Willemsen4dc4e142017-09-08 14:35:43 -0700885 return filepath.Join(c.OutDir(), "target", "product", c.TargetDevice())
Dan Willemsenf052f782017-05-18 15:29:04 -0700886}
887
Dan Willemsen02781d52017-05-12 19:28:13 -0700888func (c *configImpl) DevicePreviousProductConfig() string {
Dan Willemsenf052f782017-05-18 15:29:04 -0700889 return filepath.Join(c.ProductOut(), "previous_build_config.mk")
890}
891
Dan Willemsenfb1271a2018-09-26 15:00:42 -0700892func (c *configImpl) KatiPackageMkDir() string {
893 return filepath.Join(c.ProductOut(), "obj", "CONFIG", "kati_packaging")
894}
895
Dan Willemsenf052f782017-05-18 15:29:04 -0700896func (c *configImpl) hostOutRoot() string {
Dan Willemsen4dc4e142017-09-08 14:35:43 -0700897 return filepath.Join(c.OutDir(), "host")
Dan Willemsenf052f782017-05-18 15:29:04 -0700898}
899
900func (c *configImpl) HostOut() string {
901 return filepath.Join(c.hostOutRoot(), c.HostPrebuiltTag())
902}
903
904// This probably needs to be multi-valued, so not exporting it for now
905func (c *configImpl) hostCrossOut() string {
906 if runtime.GOOS == "linux" {
907 return filepath.Join(c.hostOutRoot(), "windows-x86")
908 } else {
909 return ""
910 }
Dan Willemsen02781d52017-05-12 19:28:13 -0700911}
912
Dan Willemsen1e704462016-08-21 15:17:17 -0700913func (c *configImpl) HostPrebuiltTag() string {
914 if runtime.GOOS == "linux" {
915 return "linux-x86"
916 } else if runtime.GOOS == "darwin" {
917 return "darwin-x86"
918 } else {
919 panic("Unsupported OS")
920 }
921}
Dan Willemsenf173d592017-04-27 14:28:00 -0700922
Dan Willemsen8122bd52017-10-12 20:20:41 -0700923func (c *configImpl) PrebuiltBuildTool(name string) string {
Dan Willemsenf173d592017-04-27 14:28:00 -0700924 if v, ok := c.environ.Get("SANITIZE_HOST"); ok {
925 if sanitize := strings.Fields(v); inList("address", sanitize) {
Dan Willemsen8122bd52017-10-12 20:20:41 -0700926 asan := filepath.Join("prebuilts/build-tools", c.HostPrebuiltTag(), "asan/bin", name)
927 if _, err := os.Stat(asan); err == nil {
928 return asan
929 }
Dan Willemsenf173d592017-04-27 14:28:00 -0700930 }
931 }
932 return filepath.Join("prebuilts/build-tools", c.HostPrebuiltTag(), "bin", name)
933}
Dan Willemsen3d60b112018-04-04 22:25:56 -0700934
935func (c *configImpl) SetBuildBrokenDupRules(val bool) {
936 c.brokenDupRules = val
937}
938
939func (c *configImpl) BuildBrokenDupRules() bool {
940 return c.brokenDupRules
941}
Dan Willemsen6ab79db2018-05-02 00:06:28 -0700942
Dan Willemsen25e6f092019-04-09 10:22:43 -0700943func (c *configImpl) SetBuildBrokenUsesNetwork(val bool) {
944 c.brokenUsesNetwork = val
945}
946
947func (c *configImpl) BuildBrokenUsesNetwork() bool {
948 return c.brokenUsesNetwork
949}
950
Dan Willemsene3336352020-01-02 19:10:38 -0800951func (c *configImpl) SetBuildBrokenNinjaUsesEnvVars(val []string) {
952 c.brokenNinjaEnvVars = val
953}
954
955func (c *configImpl) BuildBrokenNinjaUsesEnvVars() []string {
956 return c.brokenNinjaEnvVars
957}
958
Dan Willemsen6ab79db2018-05-02 00:06:28 -0700959func (c *configImpl) SetTargetDeviceDir(dir string) {
960 c.targetDeviceDir = dir
961}
962
963func (c *configImpl) TargetDeviceDir() string {
964 return c.targetDeviceDir
965}
Dan Willemsenfa42f3c2018-06-15 21:54:47 -0700966
967func (c *configImpl) SetPdkBuild(pdk bool) {
968 c.pdkBuild = pdk
969}
970
971func (c *configImpl) IsPdkBuild() bool {
972 return c.pdkBuild
973}
Patrice Arruda219eef32020-06-01 17:29:30 +0000974
975func (c *configImpl) BuildDateTime() string {
976 return c.buildDateTime
977}
978
979func (c *configImpl) MetricsUploaderApp() string {
980 if p, ok := c.environ.Get("ANDROID_ENABLE_METRICS_UPLOAD"); ok {
981 return p
982 }
983 return ""
984}