blob: f2511e76ed230b5aa5673113161699b6dc4a44a3 [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 "log"
19 "os"
Dan Willemsen1e704462016-08-21 15:17:17 -070020 "path/filepath"
21 "runtime"
22 "strconv"
23 "strings"
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
32 arguments []string
33 goma bool
34 environ *Environment
35
36 // From the arguments
Colin Cross37193492017-11-16 17:55:00 -080037 parallel int
38 keepGoing int
39 verbose bool
40 checkbuild bool
41 dist bool
42 skipMake bool
Dan Willemsen1e704462016-08-21 15:17:17 -070043
44 // From the product config
Dan Willemsen02781d52017-05-12 19:28:13 -070045 katiArgs []string
46 ninjaArgs []string
47 katiSuffix string
48 targetDevice string
Dan Willemsen1e704462016-08-21 15:17:17 -070049}
50
Dan Willemsenc2af0be2017-01-20 14:10:01 -080051const srcDirFileCheck = "build/soong/root.bp"
52
Dan Willemsen1e704462016-08-21 15:17:17 -070053func NewConfig(ctx Context, args ...string) Config {
54 ret := &configImpl{
55 environ: OsEnvironment(),
56 }
57
Dan Willemsen9b587492017-07-10 22:13:00 -070058 // Sane default matching ninja
59 ret.parallel = runtime.NumCPU() + 2
60 ret.keepGoing = 1
61
62 ret.parseArgs(ctx, args)
63
Dan Willemsen0c3919e2017-03-02 15:49:10 -080064 // Make sure OUT_DIR is set appropriately
Dan Willemsen02f3add2017-05-12 13:50:19 -070065 if outDir, ok := ret.environ.Get("OUT_DIR"); ok {
66 ret.environ.Set("OUT_DIR", filepath.Clean(outDir))
67 } else {
Dan Willemsen0c3919e2017-03-02 15:49:10 -080068 outDir := "out"
69 if baseDir, ok := ret.environ.Get("OUT_DIR_COMMON_BASE"); ok {
70 if wd, err := os.Getwd(); err != nil {
71 ctx.Fatalln("Failed to get working directory:", err)
72 } else {
73 outDir = filepath.Join(baseDir, filepath.Base(wd))
74 }
75 }
76 ret.environ.Set("OUT_DIR", outDir)
77 }
78
Dan Willemsen1e704462016-08-21 15:17:17 -070079 ret.environ.Unset(
80 // We're already using it
81 "USE_SOONG_UI",
82
83 // We should never use GOROOT/GOPATH from the shell environment
84 "GOROOT",
85 "GOPATH",
86
87 // These should only come from Soong, not the environment.
88 "CLANG",
89 "CLANG_CXX",
90 "CCC_CC",
91 "CCC_CXX",
92
93 // Used by the goma compiler wrapper, but should only be set by
94 // gomacc
95 "GOMACC_PATH",
Dan Willemsen0c3919e2017-03-02 15:49:10 -080096
97 // We handle this above
98 "OUT_DIR_COMMON_BASE",
Dan Willemsen68a09852017-04-18 13:56:57 -070099
100 // Variables that have caused problems in the past
101 "DISPLAY",
102 "GREP_OPTIONS",
Dan Willemsenc40e10b2017-07-11 14:30:00 -0700103
104 // Drop make flags
105 "MAKEFLAGS",
106 "MAKELEVEL",
107 "MFLAGS",
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700108
109 // Set in envsetup.sh, reset in makefiles
110 "ANDROID_JAVA_TOOLCHAIN",
Dan Willemsen1e704462016-08-21 15:17:17 -0700111 )
112
113 // Tell python not to spam the source tree with .pyc files.
114 ret.environ.Set("PYTHONDONTWRITEBYTECODE", "1")
115
Dan Willemsenc2af0be2017-01-20 14:10:01 -0800116 // Precondition: the current directory is the top of the source tree
117 if _, err := os.Stat(srcDirFileCheck); err != nil {
118 if os.IsNotExist(err) {
119 log.Fatalf("Current working directory must be the source tree. %q not found", srcDirFileCheck)
120 }
121 log.Fatalln("Error verifying tree state:", err)
122 }
123
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700124 if srcDir := absPath(ctx, "."); strings.ContainsRune(srcDir, ' ') {
125 log.Println("You are building in a directory whose absolute path contains a space character:")
126 log.Println()
127 log.Printf("%q\n", srcDir)
128 log.Println()
129 log.Fatalln("Directory names containing spaces are not supported")
Dan Willemsendb8457c2017-05-12 16:38:17 -0700130 }
131
132 if outDir := ret.OutDir(); strings.ContainsRune(outDir, ' ') {
133 log.Println("The absolute path of your output directory ($OUT_DIR) contains a space character:")
134 log.Println()
135 log.Printf("%q\n", outDir)
136 log.Println()
137 log.Fatalln("Directory names containing spaces are not supported")
138 }
139
140 if distDir := ret.DistDir(); strings.ContainsRune(distDir, ' ') {
141 log.Println("The absolute path of your dist directory ($DIST_DIR) contains a space character:")
142 log.Println()
143 log.Printf("%q\n", distDir)
144 log.Println()
145 log.Fatalln("Directory names containing spaces are not supported")
146 }
147
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700148 // Configure Java-related variables, including adding it to $PATH
Tobias Thierere59aeff2017-12-20 22:40:39 +0000149 java8Home := filepath.Join("prebuilts/jdk/jdk8", ret.HostPrebuiltTag())
150 java9Home := filepath.Join("prebuilts/jdk/jdk9", ret.HostPrebuiltTag())
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700151 javaHome := func() string {
152 if override, ok := ret.environ.Get("OVERRIDE_ANDROID_JAVA_HOME"); ok {
153 return override
154 }
Tobias Thierer18099fd2017-11-17 14:14:29 +0000155 v, ok := ret.environ.Get("EXPERIMENTAL_USE_OPENJDK9")
156 if !ok {
157 v2, ok2 := ret.environ.Get("RUN_ERROR_PRONE")
158 if ok2 && (v2 == "true") {
159 v = "false"
160 } else {
161 v = "1.8"
162 }
163 }
164 if v != "false" {
Tobias Thierere59aeff2017-12-20 22:40:39 +0000165 return java9Home
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700166 }
Tobias Thierere59aeff2017-12-20 22:40:39 +0000167 return java8Home
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700168 }()
169 absJavaHome := absPath(ctx, javaHome)
170
171 newPath := []string{filepath.Join(absJavaHome, "bin")}
172 if path, ok := ret.environ.Get("PATH"); ok && path != "" {
173 newPath = append(newPath, path)
174 }
175 ret.environ.Unset("OVERRIDE_ANDROID_JAVA_HOME")
176 ret.environ.Set("JAVA_HOME", absJavaHome)
177 ret.environ.Set("ANDROID_JAVA_HOME", javaHome)
Tobias Thierere59aeff2017-12-20 22:40:39 +0000178 ret.environ.Set("ANDROID_JAVA8_HOME", java8Home)
179 ret.environ.Set("ANDROID_JAVA9_HOME", java9Home)
Dan Willemsend9e8f0a2017-10-30 13:42:06 -0700180 ret.environ.Set("PATH", strings.Join(newPath, string(filepath.ListSeparator)))
181
Dan Willemsen9b587492017-07-10 22:13:00 -0700182 return Config{ret}
183}
184
185func (c *configImpl) parseArgs(ctx Context, args []string) {
186 for i := 0; i < len(args); i++ {
187 arg := strings.TrimSpace(args[i])
Dan Willemsen1e704462016-08-21 15:17:17 -0700188 if arg == "--make-mode" {
Dan Willemsen1e704462016-08-21 15:17:17 -0700189 } else if arg == "showcommands" {
Dan Willemsen9b587492017-07-10 22:13:00 -0700190 c.verbose = true
Dan Willemsene0879fc2017-08-04 15:06:27 -0700191 } else if arg == "--skip-make" {
192 c.skipMake = true
Dan Willemsen6ac63ef2017-10-17 20:35:34 -0700193 } else if len(arg) > 0 && arg[0] == '-' {
Dan Willemsen9b587492017-07-10 22:13:00 -0700194 parseArgNum := func(def int) int {
195 if len(arg) > 2 {
196 p, err := strconv.ParseUint(arg[2:], 10, 31)
197 if err != nil {
198 ctx.Fatalf("Failed to parse %q: %v", arg, err)
199 }
200 return int(p)
201 } else if i+1 < len(args) {
202 p, err := strconv.ParseUint(args[i+1], 10, 31)
203 if err == nil {
204 i++
205 return int(p)
206 }
207 }
208 return def
209 }
210
Dan Willemsen6ac63ef2017-10-17 20:35:34 -0700211 if len(arg) > 1 && arg[1] == 'j' {
Dan Willemsen9b587492017-07-10 22:13:00 -0700212 c.parallel = parseArgNum(c.parallel)
Dan Willemsen6ac63ef2017-10-17 20:35:34 -0700213 } else if len(arg) > 1 && arg[1] == 'k' {
Dan Willemsen9b587492017-07-10 22:13:00 -0700214 c.keepGoing = parseArgNum(0)
Dan Willemsen1e704462016-08-21 15:17:17 -0700215 } else {
216 ctx.Fatalln("Unknown option:", arg)
217 }
Dan Willemsen091525e2017-07-11 14:17:50 -0700218 } else if k, v, ok := decodeKeyValue(arg); ok && len(k) > 0 {
219 c.environ.Set(k, v)
Dan Willemsen1e704462016-08-21 15:17:17 -0700220 } else {
Dan Willemsene0879fc2017-08-04 15:06:27 -0700221 if arg == "dist" {
222 c.dist = true
Colin Cross37193492017-11-16 17:55:00 -0800223 } else if arg == "checkbuild" {
224 c.checkbuild = true
Dan Willemsene0879fc2017-08-04 15:06:27 -0700225 }
Dan Willemsen9b587492017-07-10 22:13:00 -0700226 c.arguments = append(c.arguments, arg)
Dan Willemsen1e704462016-08-21 15:17:17 -0700227 }
228 }
Dan Willemsen1e704462016-08-21 15:17:17 -0700229}
230
231// Lunch configures the environment for a specific product similarly to the
232// `lunch` bash function.
233func (c *configImpl) Lunch(ctx Context, product, variant string) {
234 if variant != "eng" && variant != "userdebug" && variant != "user" {
235 ctx.Fatalf("Invalid variant %q. Must be one of 'user', 'userdebug' or 'eng'", variant)
236 }
237
238 c.environ.Set("TARGET_PRODUCT", product)
239 c.environ.Set("TARGET_BUILD_VARIANT", variant)
240 c.environ.Set("TARGET_BUILD_TYPE", "release")
241 c.environ.Unset("TARGET_BUILD_APPS")
242}
243
244// Tapas configures the environment to build one or more unbundled apps,
245// similarly to the `tapas` bash function.
246func (c *configImpl) Tapas(ctx Context, apps []string, arch, variant string) {
247 if len(apps) == 0 {
248 apps = []string{"all"}
249 }
250 if variant == "" {
251 variant = "eng"
252 }
253
254 if variant != "eng" && variant != "userdebug" && variant != "user" {
255 ctx.Fatalf("Invalid variant %q. Must be one of 'user', 'userdebug' or 'eng'", variant)
256 }
257
258 var product string
259 switch arch {
260 case "armv5":
261 product = "generic_armv5"
262 case "arm", "":
263 product = "aosp_arm"
264 case "arm64":
265 product = "aosm_arm64"
266 case "mips":
267 product = "aosp_mips"
268 case "mips64":
269 product = "aosp_mips64"
270 case "x86":
271 product = "aosp_x86"
272 case "x86_64":
273 product = "aosp_x86_64"
274 default:
275 ctx.Fatalf("Invalid architecture: %q", arch)
276 }
277
278 c.environ.Set("TARGET_PRODUCT", product)
279 c.environ.Set("TARGET_BUILD_VARIANT", variant)
280 c.environ.Set("TARGET_BUILD_TYPE", "release")
281 c.environ.Set("TARGET_BUILD_APPS", strings.Join(apps, " "))
282}
283
284func (c *configImpl) Environment() *Environment {
285 return c.environ
286}
287
288func (c *configImpl) Arguments() []string {
289 return c.arguments
290}
291
292func (c *configImpl) OutDir() string {
293 if outDir, ok := c.environ.Get("OUT_DIR"); ok {
294 return outDir
295 }
296 return "out"
297}
298
Dan Willemsen8a073a82017-02-04 17:30:44 -0800299func (c *configImpl) DistDir() string {
300 if distDir, ok := c.environ.Get("DIST_DIR"); ok {
301 return distDir
302 }
303 return filepath.Join(c.OutDir(), "dist")
304}
305
Dan Willemsen1e704462016-08-21 15:17:17 -0700306func (c *configImpl) NinjaArgs() []string {
Dan Willemsene0879fc2017-08-04 15:06:27 -0700307 if c.skipMake {
308 return c.arguments
309 }
Dan Willemsen1e704462016-08-21 15:17:17 -0700310 return c.ninjaArgs
311}
312
313func (c *configImpl) SoongOutDir() string {
314 return filepath.Join(c.OutDir(), "soong")
315}
316
Jeff Gastonefc1b412017-03-29 17:29:06 -0700317func (c *configImpl) TempDir() string {
318 return shared.TempDirForOutDir(c.SoongOutDir())
319}
320
Jeff Gastonb64fc1c2017-08-04 12:30:12 -0700321func (c *configImpl) FileListDir() string {
322 return filepath.Join(c.OutDir(), ".module_paths")
323}
324
Dan Willemsen1e704462016-08-21 15:17:17 -0700325func (c *configImpl) KatiSuffix() string {
326 if c.katiSuffix != "" {
327 return c.katiSuffix
328 }
329 panic("SetKatiSuffix has not been called")
330}
331
Colin Cross37193492017-11-16 17:55:00 -0800332// Checkbuild returns true if "checkbuild" was one of the build goals, which means that the
333// user is interested in additional checks at the expense of build time.
334func (c *configImpl) Checkbuild() bool {
335 return c.checkbuild
336}
337
Dan Willemsen8a073a82017-02-04 17:30:44 -0800338func (c *configImpl) Dist() bool {
339 return c.dist
340}
341
Dan Willemsen1e704462016-08-21 15:17:17 -0700342func (c *configImpl) IsVerbose() bool {
343 return c.verbose
344}
345
Dan Willemsene0879fc2017-08-04 15:06:27 -0700346func (c *configImpl) SkipMake() bool {
347 return c.skipMake
348}
349
Dan Willemsen1e704462016-08-21 15:17:17 -0700350func (c *configImpl) TargetProduct() string {
351 if v, ok := c.environ.Get("TARGET_PRODUCT"); ok {
352 return v
353 }
354 panic("TARGET_PRODUCT is not defined")
355}
356
Dan Willemsen02781d52017-05-12 19:28:13 -0700357func (c *configImpl) TargetDevice() string {
358 return c.targetDevice
359}
360
361func (c *configImpl) SetTargetDevice(device string) {
362 c.targetDevice = device
363}
364
365func (c *configImpl) TargetBuildVariant() string {
366 if v, ok := c.environ.Get("TARGET_BUILD_VARIANT"); ok {
367 return v
368 }
369 panic("TARGET_BUILD_VARIANT is not defined")
370}
371
Dan Willemsen1e704462016-08-21 15:17:17 -0700372func (c *configImpl) KatiArgs() []string {
373 return c.katiArgs
374}
375
376func (c *configImpl) Parallel() int {
377 return c.parallel
378}
379
380func (c *configImpl) UseGoma() bool {
381 if v, ok := c.environ.Get("USE_GOMA"); ok {
382 v = strings.TrimSpace(v)
383 if v != "" && v != "false" {
384 return true
385 }
386 }
387 return false
388}
389
390// RemoteParallel controls how many remote jobs (i.e., commands which contain
Jeff Gastonefc1b412017-03-29 17:29:06 -0700391// gomacc) are run in parallel. Note the parallelism of all other jobs is
Dan Willemsen1e704462016-08-21 15:17:17 -0700392// still limited by Parallel()
393func (c *configImpl) RemoteParallel() int {
394 if v, ok := c.environ.Get("NINJA_REMOTE_NUM_JOBS"); ok {
395 if i, err := strconv.Atoi(v); err == nil {
396 return i
397 }
398 }
399 return 500
400}
401
402func (c *configImpl) SetKatiArgs(args []string) {
403 c.katiArgs = args
404}
405
406func (c *configImpl) SetNinjaArgs(args []string) {
407 c.ninjaArgs = args
408}
409
410func (c *configImpl) SetKatiSuffix(suffix string) {
411 c.katiSuffix = suffix
412}
413
Dan Willemsene0879fc2017-08-04 15:06:27 -0700414func (c *configImpl) LastKatiSuffixFile() string {
415 return filepath.Join(c.OutDir(), "last_kati_suffix")
416}
417
418func (c *configImpl) HasKatiSuffix() bool {
419 return c.katiSuffix != ""
420}
421
Dan Willemsen1e704462016-08-21 15:17:17 -0700422func (c *configImpl) KatiEnvFile() string {
423 return filepath.Join(c.OutDir(), "env"+c.KatiSuffix()+".sh")
424}
425
426func (c *configImpl) KatiNinjaFile() string {
427 return filepath.Join(c.OutDir(), "build"+c.KatiSuffix()+".ninja")
428}
429
430func (c *configImpl) SoongNinjaFile() string {
431 return filepath.Join(c.SoongOutDir(), "build.ninja")
432}
433
434func (c *configImpl) CombinedNinjaFile() string {
Dan Willemsene0879fc2017-08-04 15:06:27 -0700435 if c.katiSuffix == "" {
436 return filepath.Join(c.OutDir(), "combined.ninja")
437 }
Dan Willemsen1e704462016-08-21 15:17:17 -0700438 return filepath.Join(c.OutDir(), "combined"+c.KatiSuffix()+".ninja")
439}
440
441func (c *configImpl) SoongAndroidMk() string {
442 return filepath.Join(c.SoongOutDir(), "Android-"+c.TargetProduct()+".mk")
443}
444
445func (c *configImpl) SoongMakeVarsMk() string {
446 return filepath.Join(c.SoongOutDir(), "make_vars-"+c.TargetProduct()+".mk")
447}
448
Dan Willemsenf052f782017-05-18 15:29:04 -0700449func (c *configImpl) ProductOut() string {
Dan Willemsen4dc4e142017-09-08 14:35:43 -0700450 return filepath.Join(c.OutDir(), "target", "product", c.TargetDevice())
Dan Willemsenf052f782017-05-18 15:29:04 -0700451}
452
Dan Willemsen02781d52017-05-12 19:28:13 -0700453func (c *configImpl) DevicePreviousProductConfig() string {
Dan Willemsenf052f782017-05-18 15:29:04 -0700454 return filepath.Join(c.ProductOut(), "previous_build_config.mk")
455}
456
457func (c *configImpl) hostOutRoot() string {
Dan Willemsen4dc4e142017-09-08 14:35:43 -0700458 return filepath.Join(c.OutDir(), "host")
Dan Willemsenf052f782017-05-18 15:29:04 -0700459}
460
461func (c *configImpl) HostOut() string {
462 return filepath.Join(c.hostOutRoot(), c.HostPrebuiltTag())
463}
464
465// This probably needs to be multi-valued, so not exporting it for now
466func (c *configImpl) hostCrossOut() string {
467 if runtime.GOOS == "linux" {
468 return filepath.Join(c.hostOutRoot(), "windows-x86")
469 } else {
470 return ""
471 }
Dan Willemsen02781d52017-05-12 19:28:13 -0700472}
473
Dan Willemsen1e704462016-08-21 15:17:17 -0700474func (c *configImpl) HostPrebuiltTag() string {
475 if runtime.GOOS == "linux" {
476 return "linux-x86"
477 } else if runtime.GOOS == "darwin" {
478 return "darwin-x86"
479 } else {
480 panic("Unsupported OS")
481 }
482}
Dan Willemsenf173d592017-04-27 14:28:00 -0700483
Dan Willemsen8122bd52017-10-12 20:20:41 -0700484func (c *configImpl) PrebuiltBuildTool(name string) string {
Dan Willemsenf173d592017-04-27 14:28:00 -0700485 if v, ok := c.environ.Get("SANITIZE_HOST"); ok {
486 if sanitize := strings.Fields(v); inList("address", sanitize) {
Dan Willemsen8122bd52017-10-12 20:20:41 -0700487 asan := filepath.Join("prebuilts/build-tools", c.HostPrebuiltTag(), "asan/bin", name)
488 if _, err := os.Stat(asan); err == nil {
489 return asan
490 }
Dan Willemsenf173d592017-04-27 14:28:00 -0700491 }
492 }
493 return filepath.Join("prebuilts/build-tools", c.HostPrebuiltTag(), "bin", name)
494}