blob: 4de019c28af12f8a80594a2cb2cbd4600cff71e8 [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 (
Nan Zhang2e6a4ff2018-02-14 13:27:26 -080018 "io/ioutil"
Dan Willemsenc2af0be2017-01-20 14:10:01 -080019 "log"
20 "os"
Dan Willemsen1e704462016-08-21 15:17:17 -070021 "path/filepath"
22 "runtime"
23 "strconv"
24 "strings"
Nan Zhang2e6a4ff2018-02-14 13:27:26 -080025 "time"
Jeff Gastonefc1b412017-03-29 17:29:06 -070026
27 "android/soong/shared"
Dan Willemsen1e704462016-08-21 15:17:17 -070028)
29
30type Config struct{ *configImpl }
31
32type configImpl struct {
33 // From the environment
34 arguments []string
35 goma bool
36 environ *Environment
Dan Willemsen2d31a442018-10-20 21:33:41 -070037 distDir string
Dan Willemsen1e704462016-08-21 15:17:17 -070038
39 // From the arguments
Colin Cross37193492017-11-16 17:55:00 -080040 parallel int
41 keepGoing int
42 verbose bool
43 checkbuild bool
44 dist bool
45 skipMake bool
Dan Willemsen1e704462016-08-21 15:17:17 -070046
47 // From the product config
Dan Willemsen6ab79db2018-05-02 00:06:28 -070048 katiArgs []string
49 ninjaArgs []string
50 katiSuffix string
51 targetDevice string
52 targetDeviceDir string
Dan Willemsen3d60b112018-04-04 22:25:56 -070053
Dan Willemsend8aa39d2018-08-27 15:01:03 -070054 pdkBuild bool
55
Dan Willemsen60977462019-04-18 09:40:15 -070056 brokenDupRules bool
57 brokenUsesNetwork bool
Dan Willemsen18490112018-05-25 16:30:04 -070058
59 pathReplaced bool
Dan Willemsen1e704462016-08-21 15:17:17 -070060}
61
Dan Willemsenc2af0be2017-01-20 14:10:01 -080062const srcDirFileCheck = "build/soong/root.bp"
63
Patrice Arruda9450d0b2019-07-08 11:06:46 -070064var buildFiles = []string{"Android.mk", "Android.bp"}
65
Patrice Arruda13848222019-04-22 17:12:02 -070066type BuildAction uint
67
68const (
69 // Builds all of the modules and their dependencies of a specified directory, relative to the root
70 // directory of the source tree.
71 BUILD_MODULES_IN_A_DIRECTORY BuildAction = iota
72
73 // Builds all of the modules and their dependencies of a list of specified directories. All specified
74 // directories are relative to the root directory of the source tree.
75 BUILD_MODULES_IN_DIRECTORIES
Patrice Arruda39282062019-06-20 16:35:12 -070076
77 // Build a list of specified modules. If none was specified, simply build the whole source tree.
78 BUILD_MODULES
Patrice Arruda13848222019-04-22 17:12:02 -070079)
80
81// checkTopDir validates that the current directory is at the root directory of the source tree.
82func checkTopDir(ctx Context) {
83 if _, err := os.Stat(srcDirFileCheck); err != nil {
84 if os.IsNotExist(err) {
85 ctx.Fatalf("Current working directory must be the source tree. %q not found.", srcDirFileCheck)
86 }
87 ctx.Fatalln("Error verifying tree state:", err)
88 }
89}
90
Dan Willemsen1e704462016-08-21 15:17:17 -070091func NewConfig(ctx Context, args ...string) Config {
92 ret := &configImpl{
93 environ: OsEnvironment(),
94 }
95
Dan Willemsen9b587492017-07-10 22:13:00 -070096 // Sane default matching ninja
97 ret.parallel = runtime.NumCPU() + 2
98 ret.keepGoing = 1
99
100 ret.parseArgs(ctx, args)
101
Dan Willemsen0c3919e2017-03-02 15:49:10 -0800102 // Make sure OUT_DIR is set appropriately
Dan Willemsen02f3add2017-05-12 13:50:19 -0700103 if outDir, ok := ret.environ.Get("OUT_DIR"); ok {
104 ret.environ.Set("OUT_DIR", filepath.Clean(outDir))
105 } else {
Dan Willemsen0c3919e2017-03-02 15:49:10 -0800106 outDir := "out"
107 if baseDir, ok := ret.environ.Get("OUT_DIR_COMMON_BASE"); ok {
108 if wd, err := os.Getwd(); err != nil {
109 ctx.Fatalln("Failed to get working directory:", err)
110 } else {
111 outDir = filepath.Join(baseDir, filepath.Base(wd))
112 }
113 }
114 ret.environ.Set("OUT_DIR", outDir)
115 }
116
Dan Willemsen2d31a442018-10-20 21:33:41 -0700117 if distDir, ok := ret.environ.Get("DIST_DIR"); ok {
118 ret.distDir = filepath.Clean(distDir)
119 } else {
120 ret.distDir = filepath.Join(ret.OutDir(), "dist")
121 }
Dan Willemsend50e89f2018-10-16 17:49:25 -0700122
Dan Willemsen1e704462016-08-21 15:17:17 -0700123 ret.environ.Unset(
124 // We're already using it
125 "USE_SOONG_UI",
126
127 // We should never use GOROOT/GOPATH from the shell environment
128 "GOROOT",
129 "GOPATH",
130
131 // These should only come from Soong, not the environment.
132 "CLANG",
133 "CLANG_CXX",
134 "CCC_CC",
135 "CCC_CXX",
136
137 // Used by the goma compiler wrapper, but should only be set by
138 // gomacc
139 "GOMACC_PATH",
Dan Willemsen0c3919e2017-03-02 15:49:10 -0800140
141 // We handle this above
142 "OUT_DIR_COMMON_BASE",
Dan Willemsen68a09852017-04-18 13:56:57 -0700143
Dan Willemsen2d31a442018-10-20 21:33:41 -0700144 // This is handled above too, and set for individual commands later
145 "DIST_DIR",
146
Dan Willemsen68a09852017-04-18 13:56:57 -0700147 // Variables that have caused problems in the past
Dan Willemsenebfe33a2018-05-01 10:07:50 -0700148 "CDPATH",
Dan Willemsen68a09852017-04-18 13:56:57 -0700149 "DISPLAY",
150 "GREP_OPTIONS",
Dan Willemsenebfe33a2018-05-01 10:07:50 -0700151 "NDK_ROOT",
Dan Willemsen00fcb262018-08-15 15:35:38 -0700152 "POSIXLY_CORRECT",
Dan Willemsenc40e10b2017-07-11 14:30:00 -0700153
154 // Drop make flags
155 "MAKEFLAGS",
156 "MAKELEVEL",
157 "MFLAGS",
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700158
159 // Set in envsetup.sh, reset in makefiles
160 "ANDROID_JAVA_TOOLCHAIN",
Colin Cross7f09c402018-07-11 14:49:31 -0700161
162 // Set by envsetup.sh, but shouldn't be used inside the build because envsetup.sh is optional
163 "ANDROID_BUILD_TOP",
164 "ANDROID_HOST_OUT",
165 "ANDROID_PRODUCT_OUT",
166 "ANDROID_HOST_OUT_TESTCASES",
167 "ANDROID_TARGET_OUT_TESTCASES",
168 "ANDROID_TOOLCHAIN",
169 "ANDROID_TOOLCHAIN_2ND_ARCH",
170 "ANDROID_DEV_SCRIPTS",
171 "ANDROID_EMULATOR_PREBUILTS",
172 "ANDROID_PRE_BUILD_PATHS",
Dan Willemsenf99915f2018-10-25 22:04:42 -0700173
174 // Only set in multiproduct_kati after config generation
175 "EMPTY_NINJA_FILE",
Dan Willemsen1e704462016-08-21 15:17:17 -0700176 )
177
178 // Tell python not to spam the source tree with .pyc files.
179 ret.environ.Set("PYTHONDONTWRITEBYTECODE", "1")
180
Dan Willemsen32a669b2018-03-08 19:42:00 -0800181 ret.environ.Set("TMPDIR", absPath(ctx, ret.TempDir()))
182
Dan Willemsenc2af0be2017-01-20 14:10:01 -0800183 // Precondition: the current directory is the top of the source tree
Patrice Arruda13848222019-04-22 17:12:02 -0700184 checkTopDir(ctx)
Dan Willemsenc2af0be2017-01-20 14:10:01 -0800185
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700186 if srcDir := absPath(ctx, "."); strings.ContainsRune(srcDir, ' ') {
187 log.Println("You are building in a directory whose absolute path contains a space character:")
188 log.Println()
189 log.Printf("%q\n", srcDir)
190 log.Println()
191 log.Fatalln("Directory names containing spaces are not supported")
Dan Willemsendb8457c2017-05-12 16:38:17 -0700192 }
193
194 if outDir := ret.OutDir(); strings.ContainsRune(outDir, ' ') {
195 log.Println("The absolute path of your output directory ($OUT_DIR) contains a space character:")
196 log.Println()
197 log.Printf("%q\n", outDir)
198 log.Println()
199 log.Fatalln("Directory names containing spaces are not supported")
200 }
201
202 if distDir := ret.DistDir(); strings.ContainsRune(distDir, ' ') {
203 log.Println("The absolute path of your dist directory ($DIST_DIR) contains a space character:")
204 log.Println()
205 log.Printf("%q\n", distDir)
206 log.Println()
207 log.Fatalln("Directory names containing spaces are not supported")
208 }
209
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700210 // Configure Java-related variables, including adding it to $PATH
Tobias Thierere59aeff2017-12-20 22:40:39 +0000211 java8Home := filepath.Join("prebuilts/jdk/jdk8", ret.HostPrebuiltTag())
212 java9Home := filepath.Join("prebuilts/jdk/jdk9", ret.HostPrebuiltTag())
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700213 javaHome := func() string {
214 if override, ok := ret.environ.Get("OVERRIDE_ANDROID_JAVA_HOME"); ok {
215 return override
216 }
Colin Cross997262f2018-06-19 22:49:39 -0700217 return java9Home
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700218 }()
219 absJavaHome := absPath(ctx, javaHome)
220
Dan Willemsened869522018-01-08 14:58:46 -0800221 ret.configureLocale(ctx)
222
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700223 newPath := []string{filepath.Join(absJavaHome, "bin")}
224 if path, ok := ret.environ.Get("PATH"); ok && path != "" {
225 newPath = append(newPath, path)
226 }
227 ret.environ.Unset("OVERRIDE_ANDROID_JAVA_HOME")
228 ret.environ.Set("JAVA_HOME", absJavaHome)
229 ret.environ.Set("ANDROID_JAVA_HOME", javaHome)
Tobias Thierere59aeff2017-12-20 22:40:39 +0000230 ret.environ.Set("ANDROID_JAVA8_HOME", java8Home)
231 ret.environ.Set("ANDROID_JAVA9_HOME", java9Home)
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700232 ret.environ.Set("PATH", strings.Join(newPath, string(filepath.ListSeparator)))
233
Nan Zhang2e6a4ff2018-02-14 13:27:26 -0800234 outDir := ret.OutDir()
235 buildDateTimeFile := filepath.Join(outDir, "build_date.txt")
236 var content string
237 if buildDateTime, ok := ret.environ.Get("BUILD_DATETIME"); ok && buildDateTime != "" {
238 content = buildDateTime
239 } else {
240 content = strconv.FormatInt(time.Now().Unix(), 10)
241 }
Nan Zhang17f27672018-12-12 16:01:49 -0800242 if ctx.Metrics != nil {
243 ctx.Metrics.SetBuildDateTime(content)
244 }
Nan Zhang2e6a4ff2018-02-14 13:27:26 -0800245 err := ioutil.WriteFile(buildDateTimeFile, []byte(content), 0777)
246 if err != nil {
247 ctx.Fatalln("Failed to write BUILD_DATETIME to file:", err)
248 }
249 ret.environ.Set("BUILD_DATETIME_FILE", buildDateTimeFile)
250
Dan Willemsen9b587492017-07-10 22:13:00 -0700251 return Config{ret}
252}
253
Patrice Arruda13848222019-04-22 17:12:02 -0700254// NewBuildActionConfig returns a build configuration based on the build action. The arguments are
255// processed based on the build action and extracts any arguments that belongs to the build action.
256func NewBuildActionConfig(action BuildAction, dir string, buildDependencies bool, ctx Context, args ...string) Config {
257 return NewConfig(ctx, getConfigArgs(action, dir, buildDependencies, ctx, args)...)
258}
259
260// getConfigArgs processes the command arguments based on the build action and creates a set of new
261// arguments to be accepted by Config.
262func getConfigArgs(action BuildAction, dir string, buildDependencies bool, ctx Context, args []string) []string {
263 // The next block of code verifies that the current directory is the root directory of the source
264 // tree. It then finds the relative path of dir based on the root directory of the source tree
265 // and verify that dir is inside of the source tree.
266 checkTopDir(ctx)
267 topDir, err := os.Getwd()
268 if err != nil {
269 ctx.Fatalf("Error retrieving top directory: %v", err)
270 }
Patrice Arrudababa9a92019-07-03 10:47:34 -0700271 dir, err = filepath.EvalSymlinks(dir)
272 if err != nil {
273 ctx.Fatalf("Unable to evaluate symlink of %s: %v", dir, err)
274 }
Patrice Arruda13848222019-04-22 17:12:02 -0700275 dir, err = filepath.Abs(dir)
276 if err != nil {
277 ctx.Fatalf("Unable to find absolute path %s: %v", dir, err)
278 }
279 relDir, err := filepath.Rel(topDir, dir)
280 if err != nil {
281 ctx.Fatalf("Unable to find relative path %s of %s: %v", relDir, topDir, err)
282 }
283 // If there are ".." in the path, it's not in the source tree.
284 if strings.Contains(relDir, "..") {
285 ctx.Fatalf("Directory %s is not under the source tree %s", dir, topDir)
286 }
287
288 configArgs := args[:]
289
290 // If the arguments contains GET-INSTALL-PATH, change the target name prefix from MODULES-IN- to
291 // GET-INSTALL-PATH-IN- to extract the installation path instead of building the modules.
292 targetNamePrefix := "MODULES-IN-"
293 if inList("GET-INSTALL-PATH", configArgs) {
294 targetNamePrefix = "GET-INSTALL-PATH-IN-"
295 configArgs = removeFromList("GET-INSTALL-PATH", configArgs)
296 }
297
298 var buildFiles []string
299 var targets []string
300
301 switch action {
Patrice Arruda39282062019-06-20 16:35:12 -0700302 case BUILD_MODULES:
303 // No additional processing is required when building a list of specific modules or all modules.
Patrice Arruda13848222019-04-22 17:12:02 -0700304 case BUILD_MODULES_IN_A_DIRECTORY:
305 // If dir is the root source tree, all the modules are built of the source tree are built so
306 // no need to find the build file.
307 if topDir == dir {
308 break
309 }
310 // Find the build file from the directory where the build action was triggered by traversing up
311 // the source tree. If a blank build filename is returned, simply use the directory where the build
312 // action was invoked.
313 buildFile := findBuildFile(ctx, relDir)
314 if buildFile == "" {
315 buildFile = filepath.Join(relDir, "Android.mk")
316 }
317 buildFiles = []string{buildFile}
318 targets = []string{convertToTarget(filepath.Dir(buildFile), targetNamePrefix)}
319 case BUILD_MODULES_IN_DIRECTORIES:
320 newConfigArgs, dirs := splitArgs(configArgs)
321 configArgs = newConfigArgs
322 targets, buildFiles = getTargetsFromDirs(ctx, relDir, dirs, targetNamePrefix)
323 }
324
325 // This is to support building modules without building their dependencies. Soon, this will be
326 // deprecated.
327 if !buildDependencies && len(buildFiles) > 0 {
328 if err := os.Setenv("ONE_SHOT_MAKEFILE", strings.Join(buildFiles, " ")); err != nil {
329 ctx.Fatalf("Unable to set ONE_SHOT_MAKEFILE environment variable: %v", err)
330 }
331 }
332
333 // Tidy only override all other specified targets.
334 tidyOnly := os.Getenv("WITH_TIDY_ONLY")
335 if tidyOnly == "true" || tidyOnly == "1" {
336 configArgs = append(configArgs, "tidy_only")
337 } else {
338 configArgs = append(configArgs, targets...)
339 }
340
341 return configArgs
342}
343
344// convertToTarget replaces "/" to "-" in dir and pre-append the targetNamePrefix to the target name.
345func convertToTarget(dir string, targetNamePrefix string) string {
346 return targetNamePrefix + strings.ReplaceAll(dir, "/", "-")
347}
348
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700349// hasBuildFile returns true if dir contains an Android build file.
350func hasBuildFile(ctx Context, dir string) bool {
351 for _, buildFile := range buildFiles {
352 _, err := os.Stat(filepath.Join(dir, buildFile))
353 if err == nil {
354 return true
355 }
356 if !os.IsNotExist(err) {
357 ctx.Fatalf("Error retrieving the build file stats: %v", err)
358 }
359 }
360 return false
361}
362
Patrice Arruda13848222019-04-22 17:12:02 -0700363// findBuildFile finds a build file (makefile or blueprint file) by looking at dir first. If not
364// found, go up one level and repeat again until one is found and the path of that build file
365// relative to the root directory of the source tree is returned. The returned filename of build
366// file is "Android.mk". If one was not found, a blank string is returned.
367func findBuildFile(ctx Context, dir string) string {
368 // If the string is empty, assume it is top directory of the source tree.
369 if dir == "" {
370 return ""
371 }
372
373 for ; dir != "."; dir = filepath.Dir(dir) {
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700374 if hasBuildFile(ctx, dir) {
375 return filepath.Join(dir, "Android.mk")
Patrice Arruda13848222019-04-22 17:12:02 -0700376 }
377 }
378
379 return ""
380}
381
382// splitArgs iterates over the arguments list and splits into two lists: arguments and directories.
383func splitArgs(args []string) (newArgs []string, dirs []string) {
384 specialArgs := map[string]bool{
385 "showcommands": true,
386 "snod": true,
387 "dist": true,
388 "checkbuild": true,
389 }
390
391 newArgs = []string{}
392 dirs = []string{}
393
394 for _, arg := range args {
395 // It's a dash argument if it starts with "-" or it's a key=value pair, it's not a directory.
396 if strings.IndexRune(arg, '-') == 0 || strings.IndexRune(arg, '=') != -1 {
397 newArgs = append(newArgs, arg)
398 continue
399 }
400
401 if _, ok := specialArgs[arg]; ok {
402 newArgs = append(newArgs, arg)
403 continue
404 }
405
406 dirs = append(dirs, arg)
407 }
408
409 return newArgs, dirs
410}
411
412// getTargetsFromDirs iterates over the dirs list and creates a list of targets to build. If a
413// directory from the dirs list does not exist, a fatal error is raised. relDir is related to the
414// source root tree where the build action command was invoked. Each directory is validated if the
415// build file can be found and follows the format "dir1:target1,target2,...". Target is optional.
416func getTargetsFromDirs(ctx Context, relDir string, dirs []string, targetNamePrefix string) (targets []string, buildFiles []string) {
417 for _, dir := range dirs {
418 // The directory may have specified specific modules to build. ":" is the separator to separate
419 // the directory and the list of modules.
420 s := strings.Split(dir, ":")
421 l := len(s)
422 if l > 2 { // more than one ":" was specified.
423 ctx.Fatalf("%s not in proper directory:target1,target2,... format (\":\" was specified more than once)", dir)
424 }
425
426 dir = filepath.Join(relDir, s[0])
427 if _, err := os.Stat(dir); err != nil {
428 ctx.Fatalf("couldn't find directory %s", dir)
429 }
430
431 // Verify that if there are any targets specified after ":". Each target is separated by ",".
432 var newTargets []string
433 if l == 2 && s[1] != "" {
434 newTargets = strings.Split(s[1], ",")
435 if inList("", newTargets) {
436 ctx.Fatalf("%s not in proper directory:target1,target2,... format", dir)
437 }
438 }
439
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700440 // If there are specified targets to build in dir, an android build file must exist for the one
441 // shot build. For the non-targets case, find the appropriate build file and build all the
442 // modules in dir (or the closest one in the dir path).
Patrice Arruda13848222019-04-22 17:12:02 -0700443 if len(newTargets) > 0 {
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700444 if !hasBuildFile(ctx, dir) {
Patrice Arruda13848222019-04-22 17:12:02 -0700445 ctx.Fatalf("Couldn't locate a build file from %s directory", dir)
446 }
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700447 buildFiles = append(buildFiles, filepath.Join(dir, "Android.mk"))
Patrice Arruda13848222019-04-22 17:12:02 -0700448 } else {
Patrice Arruda9450d0b2019-07-08 11:06:46 -0700449 buildFile := findBuildFile(ctx, dir)
450 if buildFile == "" {
451 ctx.Fatalf("Build file not found for %s directory", dir)
452 }
453 newTargets = []string{convertToTarget(filepath.Dir(buildFile), targetNamePrefix)}
454 buildFiles = append(buildFiles, buildFile)
Patrice Arruda13848222019-04-22 17:12:02 -0700455 }
456
Patrice Arruda13848222019-04-22 17:12:02 -0700457 targets = append(targets, newTargets...)
458 }
459
460 return targets, buildFiles
461}
462
Dan Willemsen9b587492017-07-10 22:13:00 -0700463func (c *configImpl) parseArgs(ctx Context, args []string) {
464 for i := 0; i < len(args); i++ {
465 arg := strings.TrimSpace(args[i])
Dan Willemsen1e704462016-08-21 15:17:17 -0700466 if arg == "--make-mode" {
Dan Willemsen1e704462016-08-21 15:17:17 -0700467 } else if arg == "showcommands" {
Dan Willemsen9b587492017-07-10 22:13:00 -0700468 c.verbose = true
Dan Willemsene0879fc2017-08-04 15:06:27 -0700469 } else if arg == "--skip-make" {
470 c.skipMake = true
Dan Willemsen6ac63ef2017-10-17 20:35:34 -0700471 } else if len(arg) > 0 && arg[0] == '-' {
Dan Willemsen9b587492017-07-10 22:13:00 -0700472 parseArgNum := func(def int) int {
473 if len(arg) > 2 {
474 p, err := strconv.ParseUint(arg[2:], 10, 31)
475 if err != nil {
476 ctx.Fatalf("Failed to parse %q: %v", arg, err)
477 }
478 return int(p)
479 } else if i+1 < len(args) {
480 p, err := strconv.ParseUint(args[i+1], 10, 31)
481 if err == nil {
482 i++
483 return int(p)
484 }
485 }
486 return def
487 }
488
Dan Willemsen6ac63ef2017-10-17 20:35:34 -0700489 if len(arg) > 1 && arg[1] == 'j' {
Dan Willemsen9b587492017-07-10 22:13:00 -0700490 c.parallel = parseArgNum(c.parallel)
Dan Willemsen6ac63ef2017-10-17 20:35:34 -0700491 } else if len(arg) > 1 && arg[1] == 'k' {
Dan Willemsen9b587492017-07-10 22:13:00 -0700492 c.keepGoing = parseArgNum(0)
Dan Willemsen1e704462016-08-21 15:17:17 -0700493 } else {
494 ctx.Fatalln("Unknown option:", arg)
495 }
Dan Willemsen091525e2017-07-11 14:17:50 -0700496 } else if k, v, ok := decodeKeyValue(arg); ok && len(k) > 0 {
497 c.environ.Set(k, v)
Dan Willemsen2d31a442018-10-20 21:33:41 -0700498 } else if arg == "dist" {
499 c.dist = true
Dan Willemsen1e704462016-08-21 15:17:17 -0700500 } else {
Dan Willemsen2d31a442018-10-20 21:33:41 -0700501 if arg == "checkbuild" {
Colin Cross37193492017-11-16 17:55:00 -0800502 c.checkbuild = true
Dan Willemsene0879fc2017-08-04 15:06:27 -0700503 }
Dan Willemsen9b587492017-07-10 22:13:00 -0700504 c.arguments = append(c.arguments, arg)
Dan Willemsen1e704462016-08-21 15:17:17 -0700505 }
506 }
Dan Willemsen1e704462016-08-21 15:17:17 -0700507}
508
Dan Willemsened869522018-01-08 14:58:46 -0800509func (c *configImpl) configureLocale(ctx Context) {
510 cmd := Command(ctx, Config{c}, "locale", "locale", "-a")
511 output, err := cmd.Output()
512
513 var locales []string
514 if err == nil {
515 locales = strings.Split(string(output), "\n")
516 } else {
517 // If we're unable to list the locales, let's assume en_US.UTF-8
518 locales = []string{"en_US.UTF-8"}
519 ctx.Verbosef("Failed to list locales (%q), falling back to %q", err, locales)
520 }
521
522 // gettext uses LANGUAGE, which is passed directly through
523
524 // For LANG and LC_*, only preserve the evaluated version of
525 // LC_MESSAGES
526 user_lang := ""
527 if lc_all, ok := c.environ.Get("LC_ALL"); ok {
528 user_lang = lc_all
529 } else if lc_messages, ok := c.environ.Get("LC_MESSAGES"); ok {
530 user_lang = lc_messages
531 } else if lang, ok := c.environ.Get("LANG"); ok {
532 user_lang = lang
533 }
534
535 c.environ.UnsetWithPrefix("LC_")
536
537 if user_lang != "" {
538 c.environ.Set("LC_MESSAGES", user_lang)
539 }
540
541 // The for LANG, use C.UTF-8 if it exists (Debian currently, proposed
542 // for others)
543 if inList("C.UTF-8", locales) {
544 c.environ.Set("LANG", "C.UTF-8")
Aaron Klingd236e0e2018-08-07 19:21:36 -0500545 } else if inList("C.utf8", locales) {
546 // These normalize to the same thing
547 c.environ.Set("LANG", "C.UTF-8")
Dan Willemsened869522018-01-08 14:58:46 -0800548 } else if inList("en_US.UTF-8", locales) {
549 c.environ.Set("LANG", "en_US.UTF-8")
550 } else if inList("en_US.utf8", locales) {
551 // These normalize to the same thing
552 c.environ.Set("LANG", "en_US.UTF-8")
553 } else {
554 ctx.Fatalln("System doesn't support either C.UTF-8 or en_US.UTF-8")
555 }
556}
557
Dan Willemsen1e704462016-08-21 15:17:17 -0700558// Lunch configures the environment for a specific product similarly to the
559// `lunch` bash function.
560func (c *configImpl) Lunch(ctx Context, product, variant string) {
561 if variant != "eng" && variant != "userdebug" && variant != "user" {
562 ctx.Fatalf("Invalid variant %q. Must be one of 'user', 'userdebug' or 'eng'", variant)
563 }
564
565 c.environ.Set("TARGET_PRODUCT", product)
566 c.environ.Set("TARGET_BUILD_VARIANT", variant)
567 c.environ.Set("TARGET_BUILD_TYPE", "release")
568 c.environ.Unset("TARGET_BUILD_APPS")
569}
570
571// Tapas configures the environment to build one or more unbundled apps,
572// similarly to the `tapas` bash function.
573func (c *configImpl) Tapas(ctx Context, apps []string, arch, variant string) {
574 if len(apps) == 0 {
575 apps = []string{"all"}
576 }
577 if variant == "" {
578 variant = "eng"
579 }
580
581 if variant != "eng" && variant != "userdebug" && variant != "user" {
582 ctx.Fatalf("Invalid variant %q. Must be one of 'user', 'userdebug' or 'eng'", variant)
583 }
584
585 var product string
586 switch arch {
Dan Willemsen1e704462016-08-21 15:17:17 -0700587 case "arm", "":
588 product = "aosp_arm"
589 case "arm64":
590 product = "aosm_arm64"
591 case "mips":
592 product = "aosp_mips"
593 case "mips64":
594 product = "aosp_mips64"
595 case "x86":
596 product = "aosp_x86"
597 case "x86_64":
598 product = "aosp_x86_64"
599 default:
600 ctx.Fatalf("Invalid architecture: %q", arch)
601 }
602
603 c.environ.Set("TARGET_PRODUCT", product)
604 c.environ.Set("TARGET_BUILD_VARIANT", variant)
605 c.environ.Set("TARGET_BUILD_TYPE", "release")
606 c.environ.Set("TARGET_BUILD_APPS", strings.Join(apps, " "))
607}
608
609func (c *configImpl) Environment() *Environment {
610 return c.environ
611}
612
613func (c *configImpl) Arguments() []string {
614 return c.arguments
615}
616
617func (c *configImpl) OutDir() string {
618 if outDir, ok := c.environ.Get("OUT_DIR"); ok {
Dan Willemsen25a56182018-08-31 20:25:32 -0700619 return filepath.Clean(outDir)
Dan Willemsen1e704462016-08-21 15:17:17 -0700620 }
621 return "out"
622}
623
Dan Willemsen8a073a82017-02-04 17:30:44 -0800624func (c *configImpl) DistDir() string {
Dan Willemsen2d31a442018-10-20 21:33:41 -0700625 return c.distDir
Dan Willemsen8a073a82017-02-04 17:30:44 -0800626}
627
Dan Willemsen1e704462016-08-21 15:17:17 -0700628func (c *configImpl) NinjaArgs() []string {
Dan Willemsene0879fc2017-08-04 15:06:27 -0700629 if c.skipMake {
630 return c.arguments
631 }
Dan Willemsen1e704462016-08-21 15:17:17 -0700632 return c.ninjaArgs
633}
634
635func (c *configImpl) SoongOutDir() string {
636 return filepath.Join(c.OutDir(), "soong")
637}
638
Jeff Gastonefc1b412017-03-29 17:29:06 -0700639func (c *configImpl) TempDir() string {
640 return shared.TempDirForOutDir(c.SoongOutDir())
641}
642
Jeff Gastonb64fc1c2017-08-04 12:30:12 -0700643func (c *configImpl) FileListDir() string {
644 return filepath.Join(c.OutDir(), ".module_paths")
645}
646
Dan Willemsen1e704462016-08-21 15:17:17 -0700647func (c *configImpl) KatiSuffix() string {
648 if c.katiSuffix != "" {
649 return c.katiSuffix
650 }
651 panic("SetKatiSuffix has not been called")
652}
653
Colin Cross37193492017-11-16 17:55:00 -0800654// Checkbuild returns true if "checkbuild" was one of the build goals, which means that the
655// user is interested in additional checks at the expense of build time.
656func (c *configImpl) Checkbuild() bool {
657 return c.checkbuild
658}
659
Dan Willemsen8a073a82017-02-04 17:30:44 -0800660func (c *configImpl) Dist() bool {
661 return c.dist
662}
663
Dan Willemsen1e704462016-08-21 15:17:17 -0700664func (c *configImpl) IsVerbose() bool {
665 return c.verbose
666}
667
Dan Willemsene0879fc2017-08-04 15:06:27 -0700668func (c *configImpl) SkipMake() bool {
669 return c.skipMake
670}
671
Dan Willemsen1e704462016-08-21 15:17:17 -0700672func (c *configImpl) TargetProduct() string {
673 if v, ok := c.environ.Get("TARGET_PRODUCT"); ok {
674 return v
675 }
676 panic("TARGET_PRODUCT is not defined")
677}
678
Dan Willemsen02781d52017-05-12 19:28:13 -0700679func (c *configImpl) TargetDevice() string {
680 return c.targetDevice
681}
682
683func (c *configImpl) SetTargetDevice(device string) {
684 c.targetDevice = device
685}
686
687func (c *configImpl) TargetBuildVariant() string {
688 if v, ok := c.environ.Get("TARGET_BUILD_VARIANT"); ok {
689 return v
690 }
691 panic("TARGET_BUILD_VARIANT is not defined")
692}
693
Dan Willemsen1e704462016-08-21 15:17:17 -0700694func (c *configImpl) KatiArgs() []string {
695 return c.katiArgs
696}
697
698func (c *configImpl) Parallel() int {
699 return c.parallel
700}
701
702func (c *configImpl) UseGoma() bool {
703 if v, ok := c.environ.Get("USE_GOMA"); ok {
704 v = strings.TrimSpace(v)
705 if v != "" && v != "false" {
706 return true
707 }
708 }
709 return false
710}
711
Yoshisato Yanagisawa2cb0e5d2019-01-10 10:14:16 +0900712func (c *configImpl) StartGoma() bool {
713 if !c.UseGoma() {
714 return false
715 }
716
717 if v, ok := c.environ.Get("NOSTART_GOMA"); ok {
718 v = strings.TrimSpace(v)
719 if v != "" && v != "false" {
720 return false
721 }
722 }
723 return true
724}
725
Dan Willemsen1e704462016-08-21 15:17:17 -0700726// RemoteParallel controls how many remote jobs (i.e., commands which contain
Jeff Gastonefc1b412017-03-29 17:29:06 -0700727// gomacc) are run in parallel. Note the parallelism of all other jobs is
Dan Willemsen1e704462016-08-21 15:17:17 -0700728// still limited by Parallel()
729func (c *configImpl) RemoteParallel() int {
730 if v, ok := c.environ.Get("NINJA_REMOTE_NUM_JOBS"); ok {
731 if i, err := strconv.Atoi(v); err == nil {
732 return i
733 }
734 }
735 return 500
736}
737
738func (c *configImpl) SetKatiArgs(args []string) {
739 c.katiArgs = args
740}
741
742func (c *configImpl) SetNinjaArgs(args []string) {
743 c.ninjaArgs = args
744}
745
746func (c *configImpl) SetKatiSuffix(suffix string) {
747 c.katiSuffix = suffix
748}
749
Dan Willemsene0879fc2017-08-04 15:06:27 -0700750func (c *configImpl) LastKatiSuffixFile() string {
751 return filepath.Join(c.OutDir(), "last_kati_suffix")
752}
753
754func (c *configImpl) HasKatiSuffix() bool {
755 return c.katiSuffix != ""
756}
757
Dan Willemsen1e704462016-08-21 15:17:17 -0700758func (c *configImpl) KatiEnvFile() string {
759 return filepath.Join(c.OutDir(), "env"+c.KatiSuffix()+".sh")
760}
761
Dan Willemsen29971232018-09-26 14:58:30 -0700762func (c *configImpl) KatiBuildNinjaFile() string {
763 return filepath.Join(c.OutDir(), "build"+c.KatiSuffix()+katiBuildSuffix+".ninja")
Dan Willemsen1e704462016-08-21 15:17:17 -0700764}
765
Dan Willemsenfb1271a2018-09-26 15:00:42 -0700766func (c *configImpl) KatiPackageNinjaFile() string {
767 return filepath.Join(c.OutDir(), "build"+c.KatiSuffix()+katiPackageSuffix+".ninja")
768}
769
Dan Willemsen1e704462016-08-21 15:17:17 -0700770func (c *configImpl) SoongNinjaFile() string {
771 return filepath.Join(c.SoongOutDir(), "build.ninja")
772}
773
774func (c *configImpl) CombinedNinjaFile() string {
Dan Willemsene0879fc2017-08-04 15:06:27 -0700775 if c.katiSuffix == "" {
776 return filepath.Join(c.OutDir(), "combined.ninja")
777 }
Dan Willemsen1e704462016-08-21 15:17:17 -0700778 return filepath.Join(c.OutDir(), "combined"+c.KatiSuffix()+".ninja")
779}
780
781func (c *configImpl) SoongAndroidMk() string {
782 return filepath.Join(c.SoongOutDir(), "Android-"+c.TargetProduct()+".mk")
783}
784
785func (c *configImpl) SoongMakeVarsMk() string {
786 return filepath.Join(c.SoongOutDir(), "make_vars-"+c.TargetProduct()+".mk")
787}
788
Dan Willemsenf052f782017-05-18 15:29:04 -0700789func (c *configImpl) ProductOut() string {
Dan Willemsen4dc4e142017-09-08 14:35:43 -0700790 return filepath.Join(c.OutDir(), "target", "product", c.TargetDevice())
Dan Willemsenf052f782017-05-18 15:29:04 -0700791}
792
Dan Willemsen02781d52017-05-12 19:28:13 -0700793func (c *configImpl) DevicePreviousProductConfig() string {
Dan Willemsenf052f782017-05-18 15:29:04 -0700794 return filepath.Join(c.ProductOut(), "previous_build_config.mk")
795}
796
Dan Willemsenfb1271a2018-09-26 15:00:42 -0700797func (c *configImpl) KatiPackageMkDir() string {
798 return filepath.Join(c.ProductOut(), "obj", "CONFIG", "kati_packaging")
799}
800
Dan Willemsenf052f782017-05-18 15:29:04 -0700801func (c *configImpl) hostOutRoot() string {
Dan Willemsen4dc4e142017-09-08 14:35:43 -0700802 return filepath.Join(c.OutDir(), "host")
Dan Willemsenf052f782017-05-18 15:29:04 -0700803}
804
805func (c *configImpl) HostOut() string {
806 return filepath.Join(c.hostOutRoot(), c.HostPrebuiltTag())
807}
808
809// This probably needs to be multi-valued, so not exporting it for now
810func (c *configImpl) hostCrossOut() string {
811 if runtime.GOOS == "linux" {
812 return filepath.Join(c.hostOutRoot(), "windows-x86")
813 } else {
814 return ""
815 }
Dan Willemsen02781d52017-05-12 19:28:13 -0700816}
817
Dan Willemsen1e704462016-08-21 15:17:17 -0700818func (c *configImpl) HostPrebuiltTag() string {
819 if runtime.GOOS == "linux" {
820 return "linux-x86"
821 } else if runtime.GOOS == "darwin" {
822 return "darwin-x86"
823 } else {
824 panic("Unsupported OS")
825 }
826}
Dan Willemsenf173d592017-04-27 14:28:00 -0700827
Dan Willemsen8122bd52017-10-12 20:20:41 -0700828func (c *configImpl) PrebuiltBuildTool(name string) string {
Dan Willemsenf173d592017-04-27 14:28:00 -0700829 if v, ok := c.environ.Get("SANITIZE_HOST"); ok {
830 if sanitize := strings.Fields(v); inList("address", sanitize) {
Dan Willemsen8122bd52017-10-12 20:20:41 -0700831 asan := filepath.Join("prebuilts/build-tools", c.HostPrebuiltTag(), "asan/bin", name)
832 if _, err := os.Stat(asan); err == nil {
833 return asan
834 }
Dan Willemsenf173d592017-04-27 14:28:00 -0700835 }
836 }
837 return filepath.Join("prebuilts/build-tools", c.HostPrebuiltTag(), "bin", name)
838}
Dan Willemsen3d60b112018-04-04 22:25:56 -0700839
840func (c *configImpl) SetBuildBrokenDupRules(val bool) {
841 c.brokenDupRules = val
842}
843
844func (c *configImpl) BuildBrokenDupRules() bool {
845 return c.brokenDupRules
846}
Dan Willemsen6ab79db2018-05-02 00:06:28 -0700847
Dan Willemsen25e6f092019-04-09 10:22:43 -0700848func (c *configImpl) SetBuildBrokenUsesNetwork(val bool) {
849 c.brokenUsesNetwork = val
850}
851
852func (c *configImpl) BuildBrokenUsesNetwork() bool {
853 return c.brokenUsesNetwork
854}
855
Dan Willemsen6ab79db2018-05-02 00:06:28 -0700856func (c *configImpl) SetTargetDeviceDir(dir string) {
857 c.targetDeviceDir = dir
858}
859
860func (c *configImpl) TargetDeviceDir() string {
861 return c.targetDeviceDir
862}
Dan Willemsenfa42f3c2018-06-15 21:54:47 -0700863
864func (c *configImpl) SetPdkBuild(pdk bool) {
865 c.pdkBuild = pdk
866}
867
868func (c *configImpl) IsPdkBuild() bool {
869 return c.pdkBuild
870}