blob: 4b2f40fd982fab99a3131abb55515400f5d20d8e [file] [log] [blame]
Colin Cross3f40fa42015-01-30 17:27:36 -08001// Copyright 2015 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
Colin Cross635c3b02016-05-18 15:37:25 -070015package android
Colin Cross3f40fa42015-01-30 17:27:36 -080016
17import (
Colin Cross3f40fa42015-01-30 17:27:36 -080018 "encoding/json"
19 "fmt"
Colin Crossd8f20142016-11-03 09:43:26 -070020 "io/ioutil"
Colin Cross3f40fa42015-01-30 17:27:36 -080021 "os"
Colin Cross35cec122015-04-02 14:37:16 -070022 "path/filepath"
Colin Cross3f40fa42015-01-30 17:27:36 -080023 "runtime"
Dan Willemsen34cc69e2015-09-23 15:26:20 -070024 "strings"
Colin Crossc1e86a32015-04-15 12:33:28 -070025 "sync"
Colin Cross6ff51382015-12-17 16:39:19 -080026
Colin Cross98be1bb2019-12-13 20:41:13 -080027 "github.com/google/blueprint"
Colin Crosse87040b2017-12-11 15:52:26 -080028 "github.com/google/blueprint/bootstrap"
Colin Cross98be1bb2019-12-13 20:41:13 -080029 "github.com/google/blueprint/pathtools"
Colin Cross6ff51382015-12-17 16:39:19 -080030 "github.com/google/blueprint/proptools"
Colin Cross9d34f352019-11-22 16:03:51 -080031
32 "android/soong/android/soongconfig"
Colin Cross3f40fa42015-01-30 17:27:36 -080033)
34
Colin Cross6ff51382015-12-17 16:39:19 -080035var Bool = proptools.Bool
Jack He8cc71432016-12-08 15:45:07 -080036var String = proptools.String
Jeongik Cha219141c2020-08-06 23:00:37 +090037var StringDefault = proptools.StringDefault
Jiyong Park6a927c42020-01-21 02:03:43 +090038
Dan Albert0b176c82020-07-23 16:43:25 -070039const FutureApiLevelInt = 10000
40
41var FutureApiLevel = ApiLevel{
42 value: "current",
43 number: FutureApiLevelInt,
44 isPreview: true,
45}
Colin Cross6ff51382015-12-17 16:39:19 -080046
Colin Cross3f40fa42015-01-30 17:27:36 -080047// The configuration file name
Dan Willemsen87b17d12015-07-14 00:39:06 -070048const configFileName = "soong.config"
49const productVariablesFileName = "soong.variables"
Colin Cross3f40fa42015-01-30 17:27:36 -080050
51// A FileConfigurableOptions contains options which can be configured by the
52// config file. These will be included in the config struct.
53type FileConfigurableOptions struct {
Jiyong Park22101982020-09-17 19:09:58 +090054 Mega_device *bool `json:",omitempty"`
55 Host_bionic *bool `json:",omitempty"`
56 Host_bionic_arm64 *bool `json:",omitempty"`
Colin Cross3f40fa42015-01-30 17:27:36 -080057}
58
Colin Cross27385972015-09-18 10:57:10 -070059func (f *FileConfigurableOptions) SetDefaultConfig() {
60 *f = FileConfigurableOptions{}
Colin Cross3f40fa42015-01-30 17:27:36 -080061}
62
Colin Cross9272ade2016-08-17 15:24:12 -070063// A Config object represents the entire build configuration for Android.
Colin Crossc3c0a492015-04-10 15:43:55 -070064type Config struct {
65 *config
66}
67
Jeff Gastonefc1b412017-03-29 17:29:06 -070068func (c Config) BuildDir() string {
69 return c.buildDir
70}
71
Colin Cross9272ade2016-08-17 15:24:12 -070072// A DeviceConfig object represents the configuration for a particular device being built. For
73// now there will only be one of these, but in the future there may be multiple devices being
74// built
75type DeviceConfig struct {
76 *deviceConfig
77}
78
Colin Cross9d34f352019-11-22 16:03:51 -080079type VendorConfig soongconfig.SoongConfig
Dan Willemsen0fe78662018-03-26 12:41:18 -070080
Colin Cross1332b002015-04-07 17:11:30 -070081type config struct {
Colin Cross3f40fa42015-01-30 17:27:36 -080082 FileConfigurableOptions
Dan Willemsen45133ac2018-03-09 21:22:06 -080083 productVariables productVariables
Colin Cross3f40fa42015-01-30 17:27:36 -080084
Dan Willemsen674dc7f2018-03-12 18:06:05 -070085 // Only available on configs created by TestConfig
86 TestProductVariables *productVariables
87
Chris Parsonsf3c96ef2020-09-29 02:23:17 -040088 BazelContext BazelContext
89
Colin Crosse87040b2017-12-11 15:52:26 -080090 PrimaryBuilder string
Dan Willemsen87b17d12015-07-14 00:39:06 -070091 ConfigFileName string
92 ProductVariablesFileName string
93
Jaewoong Jung642916f2020-10-09 17:25:15 -070094 Targets map[OsType][]Target
95 BuildOSTarget Target // the Target for tools run on the build machine
96 BuildOSCommonTarget Target // the Target for common (java) tools run on the build machine
97 AndroidCommonTarget Target // the Target for common modules for the Android device
98 AndroidFirstDeviceTarget Target // the first Target for modules for the Android device
Dan Willemsen218f6562015-07-08 18:13:11 -070099
Colin Cross3b19f5d2019-09-17 14:45:31 -0700100 // multilibConflicts for an ArchType is true if there is earlier configured device architecture with the same
101 // multilib value.
102 multilibConflicts map[ArchType]bool
103
Colin Cross9272ade2016-08-17 15:24:12 -0700104 deviceConfig *deviceConfig
105
Chris Parsons8f232a22020-06-23 17:37:05 -0400106 srcDir string // the path of the root source directory
107 buildDir string // the path of the build output directory
108 moduleListFile string // the path to the file which lists blueprint files to parse.
Colin Crossc1e86a32015-04-15 12:33:28 -0700109
Colin Cross6ccbc912017-10-10 23:07:38 -0700110 env map[string]string
Dan Willemsene7680ba2015-09-11 17:06:19 -0700111 envLock sync.Mutex
112 envDeps map[string]string
113 envFrozen bool
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800114
115 inMake bool
Colin Cross1e7d3702016-08-24 15:25:47 -0700116
Colin Cross32616ed2017-09-05 21:56:44 -0700117 captureBuild bool // true for tests, saves build parameters for each module
118 ignoreEnvironment bool // true for tests, returns empty from all Getenv calls
Colin Crosscec81712017-07-13 14:43:27 -0700119
Colin Crosse87040b2017-12-11 15:52:26 -0800120 stopBefore bootstrap.StopBefore
121
Colin Cross98be1bb2019-12-13 20:41:13 -0800122 fs pathtools.FileSystem
123 mockBpList string
124
Colin Cross5e6a7972020-06-07 16:56:32 -0700125 // If testAllowNonExistentPaths is true then PathForSource and PathForModuleSrc won't error
126 // in tests when a path doesn't exist.
127 testAllowNonExistentPaths bool
128
Colin Cross12129292020-10-29 18:23:58 -0700129 ninjaFileDepsSet sync.Map
130
Colin Cross9272ade2016-08-17 15:24:12 -0700131 OncePer
132}
133
134type deviceConfig struct {
Dan Willemsen00269f22017-07-06 16:59:48 -0700135 config *config
Colin Cross9272ade2016-08-17 15:24:12 -0700136 OncePer
Colin Cross3f40fa42015-01-30 17:27:36 -0800137}
138
Colin Cross485e5722015-08-27 13:28:01 -0700139type jsonConfigurable interface {
Colin Cross27385972015-09-18 10:57:10 -0700140 SetDefaultConfig()
Colin Cross485e5722015-08-27 13:28:01 -0700141}
Colin Cross3f40fa42015-01-30 17:27:36 -0800142
Colin Cross485e5722015-08-27 13:28:01 -0700143func loadConfig(config *config) error {
Colin Cross988414c2020-01-11 01:11:46 +0000144 err := loadFromConfigFile(&config.FileConfigurableOptions, absolutePath(config.ConfigFileName))
Colin Cross485e5722015-08-27 13:28:01 -0700145 if err != nil {
146 return err
147 }
148
Colin Cross988414c2020-01-11 01:11:46 +0000149 return loadFromConfigFile(&config.productVariables, absolutePath(config.ProductVariablesFileName))
Colin Cross485e5722015-08-27 13:28:01 -0700150}
151
152// loads configuration options from a JSON file in the cwd.
153func loadFromConfigFile(configurable jsonConfigurable, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800154 // Try to open the file
Colin Cross485e5722015-08-27 13:28:01 -0700155 configFileReader, err := os.Open(filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800156 defer configFileReader.Close()
157 if os.IsNotExist(err) {
158 // Need to create a file, so that blueprint & ninja don't get in
159 // a dependency tracking loop.
160 // Make a file-configurable-options with defaults, write it out using
161 // a json writer.
Colin Cross27385972015-09-18 10:57:10 -0700162 configurable.SetDefaultConfig()
163 err = saveToConfigFile(configurable, filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800164 if err != nil {
165 return err
166 }
Colin Cross15cd21a2018-02-27 11:26:02 -0800167 } else if err != nil {
168 return fmt.Errorf("config file: could not open %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800169 } else {
170 // Make a decoder for it
171 jsonDecoder := json.NewDecoder(configFileReader)
Colin Cross485e5722015-08-27 13:28:01 -0700172 err = jsonDecoder.Decode(configurable)
Colin Cross3f40fa42015-01-30 17:27:36 -0800173 if err != nil {
Colin Cross15cd21a2018-02-27 11:26:02 -0800174 return fmt.Errorf("config file: %s did not parse correctly: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800175 }
176 }
177
Colin Cross3f40fa42015-01-30 17:27:36 -0800178 // No error
179 return nil
180}
181
Colin Crossd8f20142016-11-03 09:43:26 -0700182// atomically writes the config file in case two copies of soong_build are running simultaneously
183// (for example, docs generation and ninja manifest generation)
Colin Cross485e5722015-08-27 13:28:01 -0700184func saveToConfigFile(config jsonConfigurable, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800185 data, err := json.MarshalIndent(&config, "", " ")
186 if err != nil {
187 return fmt.Errorf("cannot marshal config data: %s", err.Error())
188 }
189
Colin Crossd8f20142016-11-03 09:43:26 -0700190 f, err := ioutil.TempFile(filepath.Dir(filename), "config")
Colin Cross3f40fa42015-01-30 17:27:36 -0800191 if err != nil {
Colin Cross485e5722015-08-27 13:28:01 -0700192 return fmt.Errorf("cannot create empty config file %s: %s\n", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800193 }
Colin Crossd8f20142016-11-03 09:43:26 -0700194 defer os.Remove(f.Name())
195 defer f.Close()
Colin Cross3f40fa42015-01-30 17:27:36 -0800196
Colin Crossd8f20142016-11-03 09:43:26 -0700197 _, err = f.Write(data)
Colin Cross3f40fa42015-01-30 17:27:36 -0800198 if err != nil {
Colin Cross485e5722015-08-27 13:28:01 -0700199 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
200 }
201
Colin Crossd8f20142016-11-03 09:43:26 -0700202 _, err = f.WriteString("\n")
Colin Cross485e5722015-08-27 13:28:01 -0700203 if err != nil {
204 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800205 }
206
Colin Crossd8f20142016-11-03 09:43:26 -0700207 f.Close()
208 os.Rename(f.Name(), filename)
209
Colin Cross3f40fa42015-01-30 17:27:36 -0800210 return nil
211}
212
Colin Cross988414c2020-01-11 01:11:46 +0000213// NullConfig returns a mostly empty Config for use by standalone tools like dexpreopt_gen that
214// use the android package.
215func NullConfig(buildDir string) Config {
216 return Config{
217 config: &config{
218 buildDir: buildDir,
219 fs: pathtools.OsFs,
220 },
221 }
222}
223
Colin Crossce75d2c2016-10-06 16:12:58 -0700224// TestConfig returns a Config object suitable for using for tests
Colin Cross98be1bb2019-12-13 20:41:13 -0800225func TestConfig(buildDir string, env map[string]string, bp string, fs map[string][]byte) Config {
Colin Cross9c6241f2019-04-22 15:51:26 -0700226 envCopy := make(map[string]string)
227 for k, v := range env {
228 envCopy[k] = v
229 }
230
231 // Copy the real PATH value to the test environment, it's needed by HostSystemTool() used in x86_darwin_host.go
232 envCopy["PATH"] = originalEnv["PATH"]
233
Dan Willemsen00269f22017-07-06 16:59:48 -0700234 config := &config{
Dan Willemsen45133ac2018-03-09 21:22:06 -0800235 productVariables: productVariables{
Dan Albert4f378d72020-07-23 17:32:15 -0700236 DeviceName: stringPtr("test_device"),
237 Platform_sdk_version: intPtr(30),
238 Platform_sdk_codename: stringPtr("S"),
239 Platform_version_active_codenames: []string{"S"},
240 DeviceSystemSdkVersions: []string{"14", "15"},
241 Platform_systemsdk_versions: []string{"29", "30"},
242 AAPTConfig: []string{"normal", "large", "xlarge", "hdpi", "xhdpi", "xxhdpi"},
243 AAPTPreferredConfig: stringPtr("xhdpi"),
244 AAPTCharacteristics: stringPtr("nosdcard"),
245 AAPTPrebuiltDPI: []string{"xhdpi", "xxhdpi"},
246 UncompressPrivAppDex: boolPtr(true),
Dan Willemsen00269f22017-07-06 16:59:48 -0700247 },
248
Colin Cross6ccbc912017-10-10 23:07:38 -0700249 buildDir: buildDir,
250 captureBuild: true,
Colin Cross9c6241f2019-04-22 15:51:26 -0700251 env: envCopy,
Colin Cross5e6a7972020-06-07 16:56:32 -0700252
253 // Set testAllowNonExistentPaths so that test contexts don't need to specify every path
254 // passed to PathForSource or PathForModuleSrc.
255 testAllowNonExistentPaths: true,
Chris Parsonsf3c96ef2020-09-29 02:23:17 -0400256
257 BazelContext: noopBazelContext{},
Dan Willemsen00269f22017-07-06 16:59:48 -0700258 }
259 config.deviceConfig = &deviceConfig{
260 config: config,
261 }
Dan Willemsen45133ac2018-03-09 21:22:06 -0800262 config.TestProductVariables = &config.productVariables
Dan Willemsen00269f22017-07-06 16:59:48 -0700263
Colin Cross98be1bb2019-12-13 20:41:13 -0800264 config.mockFileSystem(bp, fs)
265
Dan Willemsen00269f22017-07-06 16:59:48 -0700266 return Config{config}
Colin Crossce75d2c2016-10-06 16:12:58 -0700267}
268
Colin Cross98be1bb2019-12-13 20:41:13 -0800269func TestArchConfigNativeBridge(buildDir string, env map[string]string, bp string, fs map[string][]byte) Config {
270 testConfig := TestArchConfig(buildDir, env, bp, fs)
dimitry1f33e402019-03-26 12:39:31 +0100271 config := testConfig.config
272
Colin Cross0d99f7c2019-05-14 16:01:24 -0700273 config.Targets[Android] = []Target{
Jiyong Park1613e552020-09-14 19:43:17 +0900274 {Android, Arch{ArchType: X86_64, ArchVariant: "silvermont", Abi: []string{"arm64-v8a"}}, NativeBridgeDisabled, "", "", false},
275 {Android, Arch{ArchType: X86, ArchVariant: "silvermont", Abi: []string{"armeabi-v7a"}}, NativeBridgeDisabled, "", "", false},
276 {Android, Arch{ArchType: Arm64, ArchVariant: "armv8-a", Abi: []string{"arm64-v8a"}}, NativeBridgeEnabled, "x86_64", "arm64", false},
277 {Android, Arch{ArchType: Arm, ArchVariant: "armv7-a-neon", Abi: []string{"armeabi-v7a"}}, NativeBridgeEnabled, "x86", "arm", false},
dimitry1f33e402019-03-26 12:39:31 +0100278 }
279
280 return testConfig
281}
282
Colin Cross98be1bb2019-12-13 20:41:13 -0800283func TestArchConfigFuchsia(buildDir string, env map[string]string, bp string, fs map[string][]byte) Config {
284 testConfig := TestConfig(buildDir, env, bp, fs)
Doug Hornc32c6b02019-01-17 14:44:05 -0800285 config := testConfig.config
286
287 config.Targets = map[OsType][]Target{
288 Fuchsia: []Target{
Jiyong Park1613e552020-09-14 19:43:17 +0900289 {Fuchsia, Arch{ArchType: Arm64, ArchVariant: "", Abi: []string{"arm64-v8a"}}, NativeBridgeDisabled, "", "", false},
Doug Hornc32c6b02019-01-17 14:44:05 -0800290 },
291 BuildOs: []Target{
Jiyong Park1613e552020-09-14 19:43:17 +0900292 {BuildOs, Arch{ArchType: X86_64}, NativeBridgeDisabled, "", "", false},
Doug Hornc32c6b02019-01-17 14:44:05 -0800293 },
294 }
295
296 return testConfig
297}
298
Colin Crossae4c6182017-09-15 17:33:55 -0700299// TestConfig returns a Config object suitable for using for tests that need to run the arch mutator
Colin Cross98be1bb2019-12-13 20:41:13 -0800300func TestArchConfig(buildDir string, env map[string]string, bp string, fs map[string][]byte) Config {
301 testConfig := TestConfig(buildDir, env, bp, fs)
Colin Crossae4c6182017-09-15 17:33:55 -0700302 config := testConfig.config
303
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700304 config.Targets = map[OsType][]Target{
305 Android: []Target{
Jiyong Park1613e552020-09-14 19:43:17 +0900306 {Android, Arch{ArchType: Arm64, ArchVariant: "armv8-a", Abi: []string{"arm64-v8a"}}, NativeBridgeDisabled, "", "", false},
307 {Android, Arch{ArchType: Arm, ArchVariant: "armv7-a-neon", Abi: []string{"armeabi-v7a"}}, NativeBridgeDisabled, "", "", false},
Colin Crossae4c6182017-09-15 17:33:55 -0700308 },
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700309 BuildOs: []Target{
Jiyong Park1613e552020-09-14 19:43:17 +0900310 {BuildOs, Arch{ArchType: X86_64}, NativeBridgeDisabled, "", "", false},
311 {BuildOs, Arch{ArchType: X86}, NativeBridgeDisabled, "", "", false},
Colin Crossae4c6182017-09-15 17:33:55 -0700312 },
313 }
314
Colin Cross0d99f7c2019-05-14 16:01:24 -0700315 if runtime.GOOS == "darwin" {
316 config.Targets[BuildOs] = config.Targets[BuildOs][:1]
317 }
318
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700319 config.BuildOSTarget = config.Targets[BuildOs][0]
320 config.BuildOSCommonTarget = getCommonTargets(config.Targets[BuildOs])[0]
321 config.AndroidCommonTarget = getCommonTargets(config.Targets[Android])[0]
Jaewoong Jung642916f2020-10-09 17:25:15 -0700322 config.AndroidFirstDeviceTarget = firstTarget(config.Targets[Android], "lib64", "lib32")[0]
Inseob Kim1f086e22019-05-09 13:29:15 +0900323 config.TestProductVariables.DeviceArch = proptools.StringPtr("arm64")
324 config.TestProductVariables.DeviceArchVariant = proptools.StringPtr("armv8-a")
325 config.TestProductVariables.DeviceSecondaryArch = proptools.StringPtr("arm")
326 config.TestProductVariables.DeviceSecondaryArchVariant = proptools.StringPtr("armv7-a-neon")
Colin Cross2a076922018-10-04 23:28:25 -0700327
Colin Crossae4c6182017-09-15 17:33:55 -0700328 return testConfig
329}
330
Chris Parsonsf3c96ef2020-09-29 02:23:17 -0400331// Returns a config object which is "reset" for another bootstrap run.
332// Only per-run data is reset. Data which needs to persist across multiple
333// runs in the same program execution is carried over (such as Bazel context
334// or environment deps).
335func ConfigForAdditionalRun(c Config) (Config, error) {
336 newConfig, err := NewConfig(c.srcDir, c.buildDir, c.moduleListFile)
337 if err != nil {
338 return Config{}, err
339 }
340 newConfig.BazelContext = c.BazelContext
341 newConfig.envDeps = c.envDeps
342 return newConfig, nil
343}
344
Colin Cross3f40fa42015-01-30 17:27:36 -0800345// New creates a new Config object. The srcDir argument specifies the path to
346// the root source directory. It also loads the config file, if found.
Chris Parsons8f232a22020-06-23 17:37:05 -0400347func NewConfig(srcDir, buildDir string, moduleListFile string) (Config, error) {
Colin Cross3f40fa42015-01-30 17:27:36 -0800348 // Make a config with default options
Colin Cross9272ade2016-08-17 15:24:12 -0700349 config := &config{
350 ConfigFileName: filepath.Join(buildDir, configFileName),
351 ProductVariablesFileName: filepath.Join(buildDir, productVariablesFileName),
Dan Willemsen87b17d12015-07-14 00:39:06 -0700352
Colin Cross6ccbc912017-10-10 23:07:38 -0700353 env: originalEnv,
354
Colin Cross3b19f5d2019-09-17 14:45:31 -0700355 srcDir: srcDir,
356 buildDir: buildDir,
357 multilibConflicts: make(map[ArchType]bool),
Colin Cross98be1bb2019-12-13 20:41:13 -0800358
Chris Parsons8f232a22020-06-23 17:37:05 -0400359 moduleListFile: moduleListFile,
360 fs: pathtools.NewOsFs(absSrcDir),
Colin Cross68f55102015-03-25 14:43:57 -0700361 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800362
Dan Willemsen00269f22017-07-06 16:59:48 -0700363 config.deviceConfig = &deviceConfig{
Colin Cross9272ade2016-08-17 15:24:12 -0700364 config: config,
365 }
366
Liz Kammer7941b302020-07-28 13:27:34 -0700367 // Soundness check of the build and source directories. This won't catch strange
368 // configurations with symlinks, but at least checks the obvious case.
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700369 absBuildDir, err := filepath.Abs(buildDir)
370 if err != nil {
371 return Config{}, err
372 }
373
374 absSrcDir, err := filepath.Abs(srcDir)
375 if err != nil {
376 return Config{}, err
377 }
378
379 if strings.HasPrefix(absSrcDir, absBuildDir) {
380 return Config{}, fmt.Errorf("Build dir must not contain source directory")
381 }
382
Colin Cross3f40fa42015-01-30 17:27:36 -0800383 // Load any configurable options from the configuration file
Colin Cross9272ade2016-08-17 15:24:12 -0700384 err = loadConfig(config)
Colin Cross3f40fa42015-01-30 17:27:36 -0800385 if err != nil {
Colin Crossc3c0a492015-04-10 15:43:55 -0700386 return Config{}, err
Colin Cross3f40fa42015-01-30 17:27:36 -0800387 }
388
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800389 inMakeFile := filepath.Join(buildDir, ".soong.in_make")
Colin Cross988414c2020-01-11 01:11:46 +0000390 if _, err := os.Stat(absolutePath(inMakeFile)); err == nil {
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800391 config.inMake = true
392 }
393
Colin Crossa1ad8d12016-06-01 17:09:44 -0700394 targets, err := decodeTargetProductVariables(config)
Dan Willemsen218f6562015-07-08 18:13:11 -0700395 if err != nil {
396 return Config{}, err
397 }
398
Paul Duffin1356d8c2020-02-25 19:26:33 +0000399 // Make the CommonOS OsType available for all products.
400 targets[CommonOS] = []Target{commonTargetMap[CommonOS.Name]}
401
Dan Albert4098deb2016-10-19 14:04:41 -0700402 var archConfig []archConfig
Dan Willemsen322acaf2016-01-12 23:07:05 -0800403 if Bool(config.Mega_device) {
Dan Albert4098deb2016-10-19 14:04:41 -0700404 archConfig = getMegaDeviceConfig()
Colin Cross395f2cf2018-10-24 16:10:32 -0700405 } else if config.NdkAbis() {
Dan Albert4098deb2016-10-19 14:04:41 -0700406 archConfig = getNdkAbisConfig()
Martin Stjernholmc1ecc432019-11-15 15:00:31 +0000407 } else if config.AmlAbis() {
408 archConfig = getAmlAbisConfig()
Dan Albert4098deb2016-10-19 14:04:41 -0700409 }
410
411 if archConfig != nil {
Dan Willemsen01a3c252019-01-11 19:02:16 -0800412 androidTargets, err := decodeArchSettings(Android, archConfig)
Dan Willemsen322acaf2016-01-12 23:07:05 -0800413 if err != nil {
414 return Config{}, err
415 }
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700416 targets[Android] = androidTargets
Dan Willemsen322acaf2016-01-12 23:07:05 -0800417 }
418
Colin Cross3b19f5d2019-09-17 14:45:31 -0700419 multilib := make(map[string]bool)
420 for _, target := range targets[Android] {
421 if seen := multilib[target.Arch.ArchType.Multilib]; seen {
422 config.multilibConflicts[target.Arch.ArchType] = true
423 }
424 multilib[target.Arch.ArchType.Multilib] = true
425 }
426
Colin Crossa1ad8d12016-06-01 17:09:44 -0700427 config.Targets = targets
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700428 config.BuildOSTarget = config.Targets[BuildOs][0]
429 config.BuildOSCommonTarget = getCommonTargets(config.Targets[BuildOs])[0]
430 if len(config.Targets[Android]) > 0 {
431 config.AndroidCommonTarget = getCommonTargets(config.Targets[Android])[0]
Jaewoong Jung642916f2020-10-09 17:25:15 -0700432 config.AndroidFirstDeviceTarget = firstTarget(config.Targets[Android], "lib64", "lib32")[0]
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700433 }
Dan Willemsen218f6562015-07-08 18:13:11 -0700434
Colin Cross1a6acd42020-06-16 17:51:46 -0700435 if Bool(config.productVariables.GcovCoverage) && Bool(config.productVariables.ClangCoverage) {
436 return Config{}, fmt.Errorf("GcovCoverage and ClangCoverage cannot both be set")
437 }
438
439 config.productVariables.Native_coverage = proptools.BoolPtr(
440 Bool(config.productVariables.GcovCoverage) ||
441 Bool(config.productVariables.ClangCoverage))
442
Chris Parsonsf3c96ef2020-09-29 02:23:17 -0400443 config.BazelContext, err = NewBazelContext(config)
444 if err != nil {
445 return Config{}, err
446 }
Colin Cross9272ade2016-08-17 15:24:12 -0700447 return Config{config}, nil
Colin Cross3f40fa42015-01-30 17:27:36 -0800448}
449
Colin Cross988414c2020-01-11 01:11:46 +0000450var TestConfigOsFs = map[string][]byte{}
451
Colin Cross98be1bb2019-12-13 20:41:13 -0800452// mockFileSystem replaces all reads with accesses to the provided map of
453// filenames to contents stored as a byte slice.
454func (c *config) mockFileSystem(bp string, fs map[string][]byte) {
455 mockFS := map[string][]byte{}
456
457 if _, exists := mockFS["Android.bp"]; !exists {
458 mockFS["Android.bp"] = []byte(bp)
459 }
460
461 for k, v := range fs {
462 mockFS[k] = v
463 }
464
465 // no module list file specified; find every file named Blueprints or Android.bp
466 pathsToParse := []string{}
467 for candidate := range mockFS {
468 base := filepath.Base(candidate)
469 if base == "Blueprints" || base == "Android.bp" {
470 pathsToParse = append(pathsToParse, candidate)
471 }
472 }
473 if len(pathsToParse) < 1 {
474 panic(fmt.Sprintf("No Blueprint or Android.bp files found in mock filesystem: %v\n", mockFS))
475 }
476 mockFS[blueprint.MockModuleListFile] = []byte(strings.Join(pathsToParse, "\n"))
477
478 c.fs = pathtools.MockFs(mockFS)
479 c.mockBpList = blueprint.MockModuleListFile
480}
481
Colin Crosse87040b2017-12-11 15:52:26 -0800482func (c *config) StopBefore() bootstrap.StopBefore {
483 return c.stopBefore
Dan Willemsen218f6562015-07-08 18:13:11 -0700484}
485
Colin Crosse87040b2017-12-11 15:52:26 -0800486func (c *config) SetStopBefore(stopBefore bootstrap.StopBefore) {
487 c.stopBefore = stopBefore
488}
489
490var _ bootstrap.ConfigStopBefore = (*config)(nil)
491
Dan Willemsenc2aa4a92016-05-26 15:13:03 -0700492func (c *config) BlueprintToolLocation() string {
493 return filepath.Join(c.buildDir, "host", c.PrebuiltOS(), "bin")
494}
495
Colin Crosse87040b2017-12-11 15:52:26 -0800496var _ bootstrap.ConfigBlueprintToolLocation = (*config)(nil)
497
Dan Willemsen60e62f02018-11-16 21:05:32 -0800498func (c *config) HostToolPath(ctx PathContext, tool string) Path {
499 return PathForOutput(ctx, "host", c.PrebuiltOS(), "bin", tool)
500}
501
Martin Stjernholm7260d062019-12-09 21:47:14 +0000502func (c *config) HostJNIToolPath(ctx PathContext, path string) Path {
503 ext := ".so"
504 if runtime.GOOS == "darwin" {
505 ext = ".dylib"
506 }
507 return PathForOutput(ctx, "host", c.PrebuiltOS(), "lib64", path+ext)
508}
509
510func (c *config) HostJavaToolPath(ctx PathContext, path string) Path {
511 return PathForOutput(ctx, "host", c.PrebuiltOS(), "framework", path)
512}
513
Dan Willemsen66068722017-05-08 21:15:59 +0000514// HostSystemTool looks for non-hermetic tools from the system we're running on.
515// Generally shouldn't be used, but useful to find the XCode SDK, etc.
516func (c *config) HostSystemTool(name string) string {
517 for _, dir := range filepath.SplitList(c.Getenv("PATH")) {
518 path := filepath.Join(dir, name)
519 if s, err := os.Stat(path); err != nil {
520 continue
521 } else if m := s.Mode(); !s.IsDir() && m&0111 != 0 {
522 return path
523 }
524 }
525 return name
526}
527
Colin Cross3f40fa42015-01-30 17:27:36 -0800528// PrebuiltOS returns the name of the host OS used in prebuilts directories
Colin Cross1332b002015-04-07 17:11:30 -0700529func (c *config) PrebuiltOS() string {
Colin Cross3f40fa42015-01-30 17:27:36 -0800530 switch runtime.GOOS {
531 case "linux":
532 return "linux-x86"
533 case "darwin":
534 return "darwin-x86"
535 default:
536 panic("Unknown GOOS")
537 }
538}
539
540// GoRoot returns the path to the root directory of the Go toolchain.
Colin Cross1332b002015-04-07 17:11:30 -0700541func (c *config) GoRoot() string {
Colin Cross3f40fa42015-01-30 17:27:36 -0800542 return fmt.Sprintf("%s/prebuilts/go/%s", c.srcDir, c.PrebuiltOS())
543}
544
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700545func (c *config) PrebuiltBuildTool(ctx PathContext, tool string) Path {
546 return PathForSource(ctx, "prebuilts/build-tools", c.PrebuiltOS(), "bin", tool)
547}
548
Colin Cross1332b002015-04-07 17:11:30 -0700549func (c *config) CpPreserveSymlinksFlags() string {
Colin Cross485e5722015-08-27 13:28:01 -0700550 switch runtime.GOOS {
Colin Cross3f40fa42015-01-30 17:27:36 -0800551 case "darwin":
552 return "-R"
553 case "linux":
554 return "-d"
555 default:
556 return ""
557 }
558}
Colin Cross68f55102015-03-25 14:43:57 -0700559
Colin Cross1332b002015-04-07 17:11:30 -0700560func (c *config) Getenv(key string) string {
Colin Cross68f55102015-03-25 14:43:57 -0700561 var val string
562 var exists bool
Colin Crossc1e86a32015-04-15 12:33:28 -0700563 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800564 defer c.envLock.Unlock()
565 if c.envDeps == nil {
566 c.envDeps = make(map[string]string)
567 }
Colin Cross68f55102015-03-25 14:43:57 -0700568 if val, exists = c.envDeps[key]; !exists {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700569 if c.envFrozen {
570 panic("Cannot access new environment variables after envdeps are frozen")
571 }
Colin Cross6ccbc912017-10-10 23:07:38 -0700572 val, _ = c.env[key]
Colin Cross68f55102015-03-25 14:43:57 -0700573 c.envDeps[key] = val
574 }
575 return val
576}
577
Colin Cross99d7c232016-11-23 16:52:04 -0800578func (c *config) GetenvWithDefault(key string, defaultValue string) string {
579 ret := c.Getenv(key)
580 if ret == "" {
581 return defaultValue
582 }
583 return ret
584}
585
586func (c *config) IsEnvTrue(key string) bool {
587 value := c.Getenv(key)
588 return value == "1" || value == "y" || value == "yes" || value == "on" || value == "true"
589}
590
591func (c *config) IsEnvFalse(key string) bool {
592 value := c.Getenv(key)
593 return value == "0" || value == "n" || value == "no" || value == "off" || value == "false"
594}
595
Colin Cross1332b002015-04-07 17:11:30 -0700596func (c *config) EnvDeps() map[string]string {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700597 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800598 defer c.envLock.Unlock()
Dan Willemsene7680ba2015-09-11 17:06:19 -0700599 c.envFrozen = true
Colin Cross68f55102015-03-25 14:43:57 -0700600 return c.envDeps
601}
Colin Cross35cec122015-04-02 14:37:16 -0700602
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800603func (c *config) EmbeddedInMake() bool {
604 return c.inMake
605}
606
Nan Zhang581fd212018-01-10 16:06:12 -0800607func (c *config) BuildId() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800608 return String(c.productVariables.BuildId)
Nan Zhang581fd212018-01-10 16:06:12 -0800609}
610
Colin Cross2a2e0db2020-02-21 16:55:46 -0800611func (c *config) BuildNumberFile(ctx PathContext) Path {
612 return PathForOutput(ctx, String(c.productVariables.BuildNumberFile))
Nan Zhang581fd212018-01-10 16:06:12 -0800613}
614
Colin Cross35cec122015-04-02 14:37:16 -0700615// DeviceName returns the name of the current device target
616// TODO: take an AndroidModuleContext to select the device name for multi-device builds
Colin Cross1332b002015-04-07 17:11:30 -0700617func (c *config) DeviceName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800618 return *c.productVariables.DeviceName
Colin Cross35cec122015-04-02 14:37:16 -0700619}
620
Anton Hansson53c88442019-03-18 15:53:16 +0000621func (c *config) DeviceResourceOverlays() []string {
622 return c.productVariables.DeviceResourceOverlays
623}
624
625func (c *config) ProductResourceOverlays() []string {
626 return c.productVariables.ProductResourceOverlays
Colin Cross30e076a2015-04-13 13:58:27 -0700627}
628
Colin Crossbfd347d2018-05-09 11:11:35 -0700629func (c *config) PlatformVersionName() string {
630 return String(c.productVariables.Platform_version_name)
631}
632
Dan Albert4f378d72020-07-23 17:32:15 -0700633func (c *config) PlatformSdkVersion() ApiLevel {
634 return uncheckedFinalApiLevel(*c.productVariables.Platform_sdk_version)
Colin Cross30e076a2015-04-13 13:58:27 -0700635}
636
Colin Crossd09b0b62018-04-18 11:06:47 -0700637func (c *config) PlatformSdkCodename() string {
638 return String(c.productVariables.Platform_sdk_codename)
639}
640
Colin Cross092c9da2019-04-02 22:56:43 -0700641func (c *config) PlatformSecurityPatch() string {
642 return String(c.productVariables.Platform_security_patch)
643}
644
645func (c *config) PlatformPreviewSdkVersion() string {
646 return String(c.productVariables.Platform_preview_sdk_version)
647}
648
649func (c *config) PlatformMinSupportedTargetSdkVersion() string {
650 return String(c.productVariables.Platform_min_supported_target_sdk_version)
651}
652
653func (c *config) PlatformBaseOS() string {
654 return String(c.productVariables.Platform_base_os)
655}
656
Dan Albert1a246272020-07-06 14:49:35 -0700657func (c *config) MinSupportedSdkVersion() ApiLevel {
658 return uncheckedFinalApiLevel(16)
659}
660
661func (c *config) FinalApiLevels() []ApiLevel {
662 var levels []ApiLevel
Dan Albert4f378d72020-07-23 17:32:15 -0700663 for i := 1; i <= c.PlatformSdkVersion().FinalOrFutureInt(); i++ {
Dan Albert1a246272020-07-06 14:49:35 -0700664 levels = append(levels, uncheckedFinalApiLevel(i))
665 }
666 return levels
667}
668
669func (c *config) PreviewApiLevels() []ApiLevel {
670 var levels []ApiLevel
671 for i, codename := range c.PlatformVersionActiveCodenames() {
672 levels = append(levels, ApiLevel{
673 value: codename,
674 number: i,
675 isPreview: true,
676 })
677 }
678 return levels
679}
680
681func (c *config) AllSupportedApiLevels() []ApiLevel {
682 var levels []ApiLevel
683 levels = append(levels, c.FinalApiLevels()...)
684 return append(levels, c.PreviewApiLevels()...)
Dan Albertf5415d72017-08-17 16:19:59 -0700685}
686
Dan Albert4f378d72020-07-23 17:32:15 -0700687func (c *config) DefaultAppTargetSdk(ctx EarlyModuleContext) ApiLevel {
Colin Crossd09b0b62018-04-18 11:06:47 -0700688 if Bool(c.productVariables.Platform_sdk_final) {
689 return c.PlatformSdkVersion()
690 } else {
Dan Albert4f378d72020-07-23 17:32:15 -0700691 codename := c.PlatformSdkCodename()
692 if codename == "" {
693 return NoneApiLevel
694 }
695 if codename == "REL" {
696 panic("Platform_sdk_codename should not be REL when Platform_sdk_final is true")
697 }
698 return ApiLevelOrPanic(ctx, codename)
Colin Crossd09b0b62018-04-18 11:06:47 -0700699 }
700}
701
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800702func (c *config) AppsDefaultVersionName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800703 return String(c.productVariables.AppsDefaultVersionName)
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800704}
705
Dan Albert31384de2017-07-28 12:39:46 -0700706// Codenames that are active in the current lunch target.
707func (c *config) PlatformVersionActiveCodenames() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800708 return c.productVariables.Platform_version_active_codenames
Dan Albert31384de2017-07-28 12:39:46 -0700709}
710
Colin Crossface4e42017-10-30 17:32:15 -0700711func (c *config) ProductAAPTConfig() []string {
Colin Crossa74ca042019-01-31 14:31:51 -0800712 return c.productVariables.AAPTConfig
Colin Cross30e076a2015-04-13 13:58:27 -0700713}
714
Colin Crossface4e42017-10-30 17:32:15 -0700715func (c *config) ProductAAPTPreferredConfig() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800716 return String(c.productVariables.AAPTPreferredConfig)
Colin Cross30e076a2015-04-13 13:58:27 -0700717}
718
Colin Crossface4e42017-10-30 17:32:15 -0700719func (c *config) ProductAAPTCharacteristics() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800720 return String(c.productVariables.AAPTCharacteristics)
Colin Crossface4e42017-10-30 17:32:15 -0700721}
722
723func (c *config) ProductAAPTPrebuiltDPI() []string {
Colin Crossa74ca042019-01-31 14:31:51 -0800724 return c.productVariables.AAPTPrebuiltDPI
Colin Cross30e076a2015-04-13 13:58:27 -0700725}
726
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700727func (c *config) DefaultAppCertificateDir(ctx PathContext) SourcePath {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800728 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -0800729 if defaultCert != "" {
730 return PathForSource(ctx, filepath.Dir(defaultCert))
731 } else {
Dan Willemsen412160e2019-04-09 21:36:26 -0700732 return PathForSource(ctx, "build/make/target/product/security")
Colin Cross61ae0b72017-12-01 17:16:02 -0800733 }
Colin Cross30e076a2015-04-13 13:58:27 -0700734}
735
Colin Crosse1731a52017-12-14 11:22:55 -0800736func (c *config) DefaultAppCertificate(ctx PathContext) (pem, key SourcePath) {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800737 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -0800738 if defaultCert != "" {
Colin Crosse1731a52017-12-14 11:22:55 -0800739 return PathForSource(ctx, defaultCert+".x509.pem"), PathForSource(ctx, defaultCert+".pk8")
Colin Cross61ae0b72017-12-01 17:16:02 -0800740 } else {
Colin Crosse1731a52017-12-14 11:22:55 -0800741 defaultDir := c.DefaultAppCertificateDir(ctx)
742 return defaultDir.Join(ctx, "testkey.x509.pem"), defaultDir.Join(ctx, "testkey.pk8")
Colin Cross61ae0b72017-12-01 17:16:02 -0800743 }
Colin Cross30e076a2015-04-13 13:58:27 -0700744}
Colin Cross6ff51382015-12-17 16:39:19 -0800745
Jiyong Park9335a262018-12-24 11:31:58 +0900746func (c *config) ApexKeyDir(ctx ModuleContext) SourcePath {
747 // TODO(b/121224311): define another variable such as TARGET_APEX_KEY_OVERRIDE
748 defaultCert := String(c.productVariables.DefaultAppCertificate)
Dan Willemsen412160e2019-04-09 21:36:26 -0700749 if defaultCert == "" || filepath.Dir(defaultCert) == "build/make/target/product/security" {
Jiyong Park9335a262018-12-24 11:31:58 +0900750 // When defaultCert is unset or is set to the testkeys path, use the APEX keys
751 // that is under the module dir
Colin Cross07e51612019-03-05 12:46:40 -0800752 return pathForModuleSrc(ctx)
Jiyong Park9335a262018-12-24 11:31:58 +0900753 } else {
754 // If not, APEX keys are under the specified directory
755 return PathForSource(ctx, filepath.Dir(defaultCert))
756 }
757}
758
Colin Cross6ff51382015-12-17 16:39:19 -0800759func (c *config) AllowMissingDependencies() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800760 return Bool(c.productVariables.Allow_missing_dependencies)
Colin Cross6ff51382015-12-17 16:39:19 -0800761}
Dan Willemsen322acaf2016-01-12 23:07:05 -0800762
Jeongik Cha816a23a2020-07-08 01:09:23 +0900763// Returns true if a full platform source tree cannot be assumed.
Colin Crossfc3674a2017-09-18 17:41:52 -0700764func (c *config) UnbundledBuild() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800765 return Bool(c.productVariables.Unbundled_build)
Colin Crossfc3674a2017-09-18 17:41:52 -0700766}
767
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +0100768// Returns true if building apps that aren't bundled with the platform.
769// UnbundledBuild() is always true when this is true.
770func (c *config) UnbundledBuildApps() bool {
771 return Bool(c.productVariables.Unbundled_build_apps)
772}
773
Jeongik Cha816a23a2020-07-08 01:09:23 +0900774// Returns true if building modules against prebuilt SDKs.
775func (c *config) AlwaysUsePrebuiltSdks() bool {
776 return Bool(c.productVariables.Always_use_prebuilt_sdks)
Colin Cross1f367bf2018-12-18 22:46:24 -0800777}
778
Paul Duffin9a89a2a2020-10-28 19:20:06 +0000779// Returns true if the boot jars check should be skipped.
780func (c *config) SkipBootJarsCheck() bool {
781 return Bool(c.productVariables.Skip_boot_jars_check)
782}
783
Doug Horn21b94272019-01-16 12:06:11 -0800784func (c *config) Fuchsia() bool {
785 return Bool(c.productVariables.Fuchsia)
786}
787
Colin Cross126a25c2017-10-31 13:55:34 -0700788func (c *config) MinimizeJavaDebugInfo() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800789 return Bool(c.productVariables.MinimizeJavaDebugInfo) && !Bool(c.productVariables.Eng)
Colin Cross126a25c2017-10-31 13:55:34 -0700790}
791
Colin Crossed064c02018-09-05 16:28:13 -0700792func (c *config) Debuggable() bool {
793 return Bool(c.productVariables.Debuggable)
794}
795
Jaewoong Jung1d6eb682018-11-29 15:08:44 -0800796func (c *config) Eng() bool {
797 return Bool(c.productVariables.Eng)
798}
799
Jiyong Park8d52f862018-07-07 18:02:07 +0900800func (c *config) DevicePrimaryArchType() ArchType {
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700801 return c.Targets[Android][0].Arch.ArchType
Jiyong Park8d52f862018-07-07 18:02:07 +0900802}
803
Colin Cross893d8162017-04-26 17:34:03 -0700804func (c *config) SkipMegaDeviceInstall(path string) bool {
805 return Bool(c.Mega_device) &&
806 strings.HasPrefix(path, filepath.Join(c.buildDir, "target", "product"))
Dan Willemsen322acaf2016-01-12 23:07:05 -0800807}
Colin Cross16b23492016-01-06 14:41:07 -0800808
809func (c *config) SanitizeHost() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800810 return append([]string(nil), c.productVariables.SanitizeHost...)
Colin Cross16b23492016-01-06 14:41:07 -0800811}
812
813func (c *config) SanitizeDevice() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800814 return append([]string(nil), c.productVariables.SanitizeDevice...)
Colin Cross23ae82a2016-11-02 14:34:39 -0700815}
816
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700817func (c *config) SanitizeDeviceDiag() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800818 return append([]string(nil), c.productVariables.SanitizeDeviceDiag...)
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700819}
820
Colin Cross23ae82a2016-11-02 14:34:39 -0700821func (c *config) SanitizeDeviceArch() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800822 return append([]string(nil), c.productVariables.SanitizeDeviceArch...)
Colin Cross16b23492016-01-06 14:41:07 -0800823}
Colin Crossa1ad8d12016-06-01 17:09:44 -0700824
Vishwath Mohan1b017a72017-01-19 13:54:55 -0800825func (c *config) EnableCFI() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800826 if c.productVariables.EnableCFI == nil {
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -0800827 return true
828 } else {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800829 return *c.productVariables.EnableCFI
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -0800830 }
Vishwath Mohan1b017a72017-01-19 13:54:55 -0800831}
832
Kostya Kortchinskyd5275c82019-02-01 08:42:56 -0800833func (c *config) DisableScudo() bool {
834 return Bool(c.productVariables.DisableScudo)
835}
836
Colin Crossa1ad8d12016-06-01 17:09:44 -0700837func (c *config) Android64() bool {
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700838 for _, t := range c.Targets[Android] {
Colin Crossa1ad8d12016-06-01 17:09:44 -0700839 if t.Arch.ArchType.Multilib == "lib64" {
840 return true
841 }
842 }
843
844 return false
845}
Colin Cross9272ade2016-08-17 15:24:12 -0700846
Colin Cross9d45bb72016-08-29 16:14:13 -0700847func (c *config) UseGoma() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800848 return Bool(c.productVariables.UseGoma)
Colin Cross9d45bb72016-08-29 16:14:13 -0700849}
850
Ramy Medhatbbf25672019-07-17 12:30:04 +0000851func (c *config) UseRBE() bool {
852 return Bool(c.productVariables.UseRBE)
853}
854
Ramy Medhat8ea054a2020-01-27 14:19:44 -0500855func (c *config) UseRBEJAVAC() bool {
856 return Bool(c.productVariables.UseRBEJAVAC)
857}
858
859func (c *config) UseRBER8() bool {
860 return Bool(c.productVariables.UseRBER8)
861}
862
863func (c *config) UseRBED8() bool {
864 return Bool(c.productVariables.UseRBED8)
865}
866
Colin Cross8b8bec32019-11-15 13:18:43 -0800867func (c *config) UseRemoteBuild() bool {
868 return c.UseGoma() || c.UseRBE()
869}
870
Colin Cross66548102018-06-19 22:47:35 -0700871func (c *config) RunErrorProne() bool {
872 return c.IsEnvTrue("RUN_ERROR_PRONE")
873}
874
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800875func (c *config) XrefCorpusName() string {
876 return c.Getenv("XREF_CORPUS")
877}
878
Sasha Smundak6c2d4f92020-01-09 17:34:23 -0800879// Returns Compilation Unit encoding to use. Can be 'json' (default), 'proto' or 'all'.
880func (c *config) XrefCuEncoding() string {
881 if enc := c.Getenv("KYTHE_KZIP_ENCODING"); enc != "" {
882 return enc
883 }
884 return "json"
885}
886
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800887func (c *config) EmitXrefRules() bool {
888 return c.XrefCorpusName() != ""
889}
890
Dan Willemsena03cf6d2016-09-26 15:45:04 -0700891func (c *config) ClangTidy() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800892 return Bool(c.productVariables.ClangTidy)
Dan Willemsena03cf6d2016-09-26 15:45:04 -0700893}
894
895func (c *config) TidyChecks() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800896 if c.productVariables.TidyChecks == nil {
Dan Willemsena03cf6d2016-09-26 15:45:04 -0700897 return ""
898 }
Dan Willemsen45133ac2018-03-09 21:22:06 -0800899 return *c.productVariables.TidyChecks
Dan Willemsena03cf6d2016-09-26 15:45:04 -0700900}
901
Colin Cross0f4e0d62016-07-27 10:56:55 -0700902func (c *config) LibartImgHostBaseAddress() string {
903 return "0x60000000"
904}
905
906func (c *config) LibartImgDeviceBaseAddress() string {
Elliott Hughesda3a0712020-03-06 16:55:28 -0800907 return "0x70000000"
Colin Cross0f4e0d62016-07-27 10:56:55 -0700908}
909
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -0800910func (c *config) ArtUseReadBarrier() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800911 return Bool(c.productVariables.ArtUseReadBarrier)
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -0800912}
913
Dan Willemsen3fb1fae2018-03-12 15:30:26 -0700914func (c *config) EnforceRROForModule(name string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800915 enforceList := c.productVariables.EnforceRROTargets
Jeongik Chab9b13272020-03-09 12:37:05 +0900916 // TODO(b/150820813) Some modules depend on static overlay, remove this after eliminating the dependency.
917 exemptedList := c.productVariables.EnforceRROExemptedTargets
Roland Levillainf6cc2612020-07-09 16:58:14 +0100918 if len(exemptedList) > 0 {
Jeongik Chab9b13272020-03-09 12:37:05 +0900919 if InList(name, exemptedList) {
920 return false
921 }
922 }
Roland Levillainf6cc2612020-07-09 16:58:14 +0100923 if len(enforceList) > 0 {
Yo Chiang4ebd06a2019-10-01 13:13:41 +0800924 if InList("*", enforceList) {
Dan Willemsen3fb1fae2018-03-12 15:30:26 -0700925 return true
926 }
Colin Crossa74ca042019-01-31 14:31:51 -0800927 return InList(name, enforceList)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -0700928 }
929 return false
930}
931
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700932func (c *config) EnforceRROExemptedForModule(name string) bool {
933 return InList(name, c.productVariables.EnforceRROExemptedTargets)
934}
935
Dan Willemsen3fb1fae2018-03-12 15:30:26 -0700936func (c *config) EnforceRROExcludedOverlay(path string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800937 excluded := c.productVariables.EnforceRROExcludedOverlays
Roland Levillainf6cc2612020-07-09 16:58:14 +0100938 if len(excluded) > 0 {
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800939 return HasAnyPrefix(path, excluded)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -0700940 }
941 return false
942}
943
944func (c *config) ExportedNamespaces() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800945 return append([]string(nil), c.productVariables.NamespacesToExport...)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -0700946}
947
948func (c *config) HostStaticBinaries() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800949 return Bool(c.productVariables.HostStaticBinaries)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -0700950}
951
Colin Cross5a0dcd52018-10-05 14:20:06 -0700952func (c *config) UncompressPrivAppDex() bool {
953 return Bool(c.productVariables.UncompressPrivAppDex)
954}
955
956func (c *config) ModulesLoadedByPrivilegedModules() []string {
957 return c.productVariables.ModulesLoadedByPrivilegedModules
958}
959
Jingwen Chenebb0b572020-11-02 00:24:57 -0500960func (c *config) DexpreoptGlobalConfigPath(ctx PathContext) OptionalPath {
Colin Cross988414c2020-01-11 01:11:46 +0000961 if c.productVariables.DexpreoptGlobalConfig == nil {
Jingwen Chenebb0b572020-11-02 00:24:57 -0500962 return OptionalPathForPath(nil)
963 }
964 return OptionalPathForPath(
965 pathForBuildToolDep(ctx, *c.productVariables.DexpreoptGlobalConfig))
966}
967
968func (c *config) DexpreoptGlobalConfig(ctx PathContext) ([]byte, error) {
969 path := c.DexpreoptGlobalConfigPath(ctx)
970 if !path.Valid() {
Colin Cross988414c2020-01-11 01:11:46 +0000971 return nil, nil
972 }
Jingwen Chenebb0b572020-11-02 00:24:57 -0500973 ctx.AddNinjaFileDeps(path.String())
974 return ioutil.ReadFile(absolutePath(path.String()))
Colin Cross43f08db2018-11-12 10:13:39 -0800975}
976
David Brazdil91b4e3e2019-01-23 21:04:05 +0000977func (c *config) FrameworksBaseDirExists(ctx PathContext) bool {
978 return ExistentPathForSource(ctx, "frameworks", "base").Valid()
979}
980
Inseob Kimae553032019-05-14 18:52:49 +0900981func (c *config) VndkSnapshotBuildArtifacts() bool {
982 return Bool(c.productVariables.VndkSnapshotBuildArtifacts)
983}
984
Colin Cross3b19f5d2019-09-17 14:45:31 -0700985func (c *config) HasMultilibConflict(arch ArchType) bool {
986 return c.multilibConflicts[arch]
987}
988
Colin Cross9272ade2016-08-17 15:24:12 -0700989func (c *deviceConfig) Arches() []Arch {
990 var arches []Arch
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700991 for _, target := range c.config.Targets[Android] {
Colin Cross9272ade2016-08-17 15:24:12 -0700992 arches = append(arches, target.Arch)
993 }
994 return arches
995}
Dan Willemsend2ede872016-11-18 14:54:24 -0800996
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -0800997func (c *deviceConfig) BinderBitness() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800998 is32BitBinder := c.config.productVariables.Binder32bit
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -0800999 if is32BitBinder != nil && *is32BitBinder {
1000 return "32"
1001 }
1002 return "64"
1003}
1004
Dan Willemsen4353bc42016-12-05 17:16:02 -08001005func (c *deviceConfig) VendorPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001006 if c.config.productVariables.VendorPath != nil {
1007 return *c.config.productVariables.VendorPath
Dan Willemsen4353bc42016-12-05 17:16:02 -08001008 }
1009 return "vendor"
1010}
1011
Justin Yun71549282017-11-17 12:10:28 +09001012func (c *deviceConfig) VndkVersion() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001013 return String(c.config.productVariables.DeviceVndkVersion)
Justin Yun71549282017-11-17 12:10:28 +09001014}
1015
Jeongik Cha219141c2020-08-06 23:00:37 +09001016func (c *deviceConfig) CurrentApiLevelForVendorModules() string {
1017 return StringDefault(c.config.productVariables.DeviceCurrentApiLevelForVendorModules, "current")
1018}
1019
Justin Yun8fe12122017-12-07 17:18:15 +09001020func (c *deviceConfig) PlatformVndkVersion() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001021 return String(c.config.productVariables.Platform_vndk_version)
Justin Yun8fe12122017-12-07 17:18:15 +09001022}
1023
Justin Yun5f7f7e82019-11-18 19:52:14 +09001024func (c *deviceConfig) ProductVndkVersion() string {
1025 return String(c.config.productVariables.ProductVndkVersion)
1026}
1027
Justin Yun71549282017-11-17 12:10:28 +09001028func (c *deviceConfig) ExtraVndkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001029 return c.config.productVariables.ExtraVndkVersions
Dan Willemsend2ede872016-11-18 14:54:24 -08001030}
Jack He8cc71432016-12-08 15:45:07 -08001031
Vic Yangefd249e2018-11-12 20:19:56 -08001032func (c *deviceConfig) VndkUseCoreVariant() bool {
1033 return Bool(c.config.productVariables.VndkUseCoreVariant)
1034}
1035
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001036func (c *deviceConfig) SystemSdkVersions() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001037 return c.config.productVariables.DeviceSystemSdkVersions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001038}
1039
1040func (c *deviceConfig) PlatformSystemSdkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001041 return c.config.productVariables.Platform_systemsdk_versions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001042}
1043
Jiyong Park2db76922017-11-08 16:03:48 +09001044func (c *deviceConfig) OdmPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001045 if c.config.productVariables.OdmPath != nil {
1046 return *c.config.productVariables.OdmPath
Jiyong Park2db76922017-11-08 16:03:48 +09001047 }
1048 return "odm"
1049}
1050
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001051func (c *deviceConfig) ProductPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001052 if c.config.productVariables.ProductPath != nil {
1053 return *c.config.productVariables.ProductPath
Jiyong Park2db76922017-11-08 16:03:48 +09001054 }
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001055 return "product"
Jiyong Park2db76922017-11-08 16:03:48 +09001056}
1057
Justin Yund5f6c822019-06-25 16:47:17 +09001058func (c *deviceConfig) SystemExtPath() string {
1059 if c.config.productVariables.SystemExtPath != nil {
1060 return *c.config.productVariables.SystemExtPath
Dario Frenifd05a742018-05-29 13:28:54 +01001061 }
Justin Yund5f6c822019-06-25 16:47:17 +09001062 return "system_ext"
Dario Frenifd05a742018-05-29 13:28:54 +01001063}
1064
Jack He8cc71432016-12-08 15:45:07 -08001065func (c *deviceConfig) BtConfigIncludeDir() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001066 return String(c.config.productVariables.BtConfigIncludeDir)
Jack He8cc71432016-12-08 15:45:07 -08001067}
Dan Willemsen581341d2017-02-09 16:16:31 -08001068
Jiyong Parkd773eb32017-07-03 13:18:12 +09001069func (c *deviceConfig) DeviceKernelHeaderDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001070 return c.config.productVariables.DeviceKernelHeaders
Jiyong Parkd773eb32017-07-03 13:18:12 +09001071}
1072
Yi Kongceb5b762020-03-20 15:22:27 +08001073func (c *deviceConfig) SamplingPGO() bool {
1074 return Bool(c.config.productVariables.SamplingPGO)
1075}
1076
Roland Levillainada12702020-06-09 13:07:36 +01001077// JavaCoverageEnabledForPath returns whether Java code coverage is enabled for
1078// path. Coverage is enabled by default when the product variable
1079// JavaCoveragePaths is empty. If JavaCoveragePaths is not empty, coverage is
1080// enabled for any path which is part of this variable (and not part of the
1081// JavaCoverageExcludePaths product variable). Value "*" in JavaCoveragePaths
1082// represents any path.
1083func (c *deviceConfig) JavaCoverageEnabledForPath(path string) bool {
1084 coverage := false
Chris Gross2f748692020-06-24 20:36:59 +00001085 if len(c.config.productVariables.JavaCoveragePaths) == 0 ||
Roland Levillainada12702020-06-09 13:07:36 +01001086 InList("*", c.config.productVariables.JavaCoveragePaths) ||
1087 HasAnyPrefix(path, c.config.productVariables.JavaCoveragePaths) {
1088 coverage = true
1089 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001090 if coverage && len(c.config.productVariables.JavaCoverageExcludePaths) > 0 {
Roland Levillainada12702020-06-09 13:07:36 +01001091 if HasAnyPrefix(path, c.config.productVariables.JavaCoverageExcludePaths) {
1092 coverage = false
1093 }
1094 }
1095 return coverage
1096}
1097
Colin Cross1a6acd42020-06-16 17:51:46 -07001098// Returns true if gcov or clang coverage is enabled.
Dan Willemsen581341d2017-02-09 16:16:31 -08001099func (c *deviceConfig) NativeCoverageEnabled() bool {
Colin Cross1a6acd42020-06-16 17:51:46 -07001100 return Bool(c.config.productVariables.GcovCoverage) ||
1101 Bool(c.config.productVariables.ClangCoverage)
Dan Willemsen581341d2017-02-09 16:16:31 -08001102}
1103
Oliver Nguyen1382ab62019-12-06 15:22:41 -08001104func (c *deviceConfig) ClangCoverageEnabled() bool {
1105 return Bool(c.config.productVariables.ClangCoverage)
1106}
1107
Colin Cross1a6acd42020-06-16 17:51:46 -07001108func (c *deviceConfig) GcovCoverageEnabled() bool {
1109 return Bool(c.config.productVariables.GcovCoverage)
1110}
1111
Roland Levillain4f5297b2020-06-09 12:44:06 +01001112// NativeCoverageEnabledForPath returns whether (GCOV- or Clang-based) native
1113// code coverage is enabled for path. By default, coverage is not enabled for a
1114// given path unless it is part of the NativeCoveragePaths product variable (and
1115// not part of the NativeCoverageExcludePaths product variable). Value "*" in
1116// NativeCoveragePaths represents any path.
1117func (c *deviceConfig) NativeCoverageEnabledForPath(path string) bool {
Ryan Campbell469a18a2017-02-27 09:01:54 -08001118 coverage := false
Roland Levillainf6cc2612020-07-09 16:58:14 +01001119 if len(c.config.productVariables.NativeCoveragePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001120 if InList("*", c.config.productVariables.NativeCoveragePaths) || HasAnyPrefix(path, c.config.productVariables.NativeCoveragePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001121 coverage = true
Dan Willemsen581341d2017-02-09 16:16:31 -08001122 }
1123 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001124 if coverage && len(c.config.productVariables.NativeCoverageExcludePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001125 if HasAnyPrefix(path, c.config.productVariables.NativeCoverageExcludePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001126 coverage = false
Ryan Campbell469a18a2017-02-27 09:01:54 -08001127 }
1128 }
1129 return coverage
Dan Willemsen581341d2017-02-09 16:16:31 -08001130}
Ivan Lozano5f595532017-07-13 14:46:05 -07001131
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001132func (c *deviceConfig) PgoAdditionalProfileDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001133 return c.config.productVariables.PgoAdditionalProfileDirs
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001134}
1135
Tri Vo35a51432018-03-25 20:00:00 -07001136func (c *deviceConfig) VendorSepolicyDirs() []string {
1137 return c.config.productVariables.BoardVendorSepolicyDirs
1138}
1139
1140func (c *deviceConfig) OdmSepolicyDirs() []string {
1141 return c.config.productVariables.BoardOdmSepolicyDirs
1142}
1143
Felixa20a8752020-05-17 18:28:35 +02001144func (c *deviceConfig) SystemExtPublicSepolicyDirs() []string {
1145 return c.config.productVariables.SystemExtPublicSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001146}
1147
Felixa20a8752020-05-17 18:28:35 +02001148func (c *deviceConfig) SystemExtPrivateSepolicyDirs() []string {
1149 return c.config.productVariables.SystemExtPrivateSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001150}
1151
Inseob Kim0866b002019-04-15 20:21:29 +09001152func (c *deviceConfig) SepolicyM4Defs() []string {
1153 return c.config.productVariables.BoardSepolicyM4Defs
1154}
1155
Jiyong Park7f67f482019-01-05 12:57:48 +09001156func (c *deviceConfig) OverrideManifestPackageNameFor(name string) (manifestName string, overridden bool) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001157 return findOverrideValue(c.config.productVariables.ManifestPackageNameOverrides, name,
1158 "invalid override rule %q in PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES should be <module_name>:<manifest_name>")
1159}
1160
1161func (c *deviceConfig) OverrideCertificateFor(name string) (certificatePath string, overridden bool) {
Jaewoong Jungacb6db32019-02-28 16:22:30 +00001162 return findOverrideValue(c.config.productVariables.CertificateOverrides, name,
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001163 "invalid override rule %q in PRODUCT_CERTIFICATE_OVERRIDES should be <module_name>:<certificate_module_name>")
1164}
1165
Jaewoong Jung9d22a912019-01-23 16:27:47 -08001166func (c *deviceConfig) OverridePackageNameFor(name string) string {
1167 newName, overridden := findOverrideValue(
1168 c.config.productVariables.PackageNameOverrides,
1169 name,
1170 "invalid override rule %q in PRODUCT_PACKAGE_NAME_OVERRIDES should be <module_name>:<package_name>")
1171 if overridden {
1172 return newName
1173 }
1174 return name
1175}
1176
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001177func findOverrideValue(overrides []string, name string, errorMsg string) (newValue string, overridden bool) {
Jiyong Park7f67f482019-01-05 12:57:48 +09001178 if overrides == nil || len(overrides) == 0 {
1179 return "", false
1180 }
1181 for _, o := range overrides {
1182 split := strings.Split(o, ":")
1183 if len(split) != 2 {
1184 // This shouldn't happen as this is first checked in make, but just in case.
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001185 panic(fmt.Errorf(errorMsg, o))
Jiyong Park7f67f482019-01-05 12:57:48 +09001186 }
1187 if matchPattern(split[0], name) {
1188 return substPattern(split[0], split[1], name), true
1189 }
1190 }
1191 return "", false
1192}
1193
Ivan Lozano5f595532017-07-13 14:46:05 -07001194func (c *config) IntegerOverflowDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001195 if len(c.productVariables.IntegerOverflowExcludePaths) == 0 {
Ivan Lozano5f595532017-07-13 14:46:05 -07001196 return false
1197 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001198 return HasAnyPrefix(path, c.productVariables.IntegerOverflowExcludePaths)
Ivan Lozano5f595532017-07-13 14:46:05 -07001199}
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001200
1201func (c *config) CFIDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001202 if len(c.productVariables.CFIExcludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001203 return false
1204 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001205 return HasAnyPrefix(path, c.productVariables.CFIExcludePaths)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001206}
1207
1208func (c *config) CFIEnabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001209 if len(c.productVariables.CFIIncludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001210 return false
1211 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001212 return HasAnyPrefix(path, c.productVariables.CFIIncludePaths)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001213}
Colin Crosse15ddaf2017-12-04 11:24:31 -08001214
Dan Willemsen0fe78662018-03-26 12:41:18 -07001215func (c *config) VendorConfig(name string) VendorConfig {
Colin Cross9d34f352019-11-22 16:03:51 -08001216 return soongconfig.Config(c.productVariables.VendorVars[name])
Dan Willemsen0fe78662018-03-26 12:41:18 -07001217}
1218
Colin Cross395f2cf2018-10-24 16:10:32 -07001219func (c *config) NdkAbis() bool {
1220 return Bool(c.productVariables.Ndk_abis)
1221}
1222
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001223func (c *config) AmlAbis() bool {
1224 return Bool(c.productVariables.Aml_abis)
1225}
1226
Dan Albert23d37e02018-11-28 08:30:10 -08001227func (c *config) ExcludeDraftNdkApis() bool {
1228 return Bool(c.productVariables.Exclude_draft_ndk_apis)
1229}
1230
Jiyong Park8fd61922018-11-08 02:50:25 +09001231func (c *config) FlattenApex() bool {
Roland Levillaina3863212019-08-12 19:56:16 +01001232 return Bool(c.productVariables.Flatten_apex)
Jiyong Park8fd61922018-11-08 02:50:25 +09001233}
1234
Jeongik Chac9464142019-01-07 12:07:27 +09001235func (c *config) EnforceSystemCertificate() bool {
1236 return Bool(c.productVariables.EnforceSystemCertificate)
1237}
1238
Colin Cross440e0d02020-06-11 11:32:11 -07001239func (c *config) EnforceSystemCertificateAllowList() []string {
1240 return c.productVariables.EnforceSystemCertificateAllowList
Jeongik Chac9464142019-01-07 12:07:27 +09001241}
1242
Jeongik Cha2cc570d2019-10-29 15:44:45 +09001243func (c *config) EnforceProductPartitionInterface() bool {
1244 return Bool(c.productVariables.EnforceProductPartitionInterface)
1245}
1246
Jooyung Han3ab2c3e2019-12-05 16:27:44 +09001247func (c *config) InstallExtraFlattenedApexes() bool {
1248 return Bool(c.productVariables.InstallExtraFlattenedApexes)
1249}
1250
Colin Crossf24a22a2019-01-31 14:12:44 -08001251func (c *config) ProductHiddenAPIStubs() []string {
1252 return c.productVariables.ProductHiddenAPIStubs
Colin Cross8faf8fc2019-01-16 15:15:52 -08001253}
1254
Colin Crossf24a22a2019-01-31 14:12:44 -08001255func (c *config) ProductHiddenAPIStubsSystem() []string {
1256 return c.productVariables.ProductHiddenAPIStubsSystem
Colin Cross8faf8fc2019-01-16 15:15:52 -08001257}
1258
Colin Crossf24a22a2019-01-31 14:12:44 -08001259func (c *config) ProductHiddenAPIStubsTest() []string {
1260 return c.productVariables.ProductHiddenAPIStubsTest
Colin Cross8faf8fc2019-01-16 15:15:52 -08001261}
Dan Willemsen71c74602019-04-10 12:27:35 -07001262
Dan Willemsen54879d12019-04-18 10:08:46 -07001263func (c *deviceConfig) TargetFSConfigGen() []string {
Dan Willemsen71c74602019-04-10 12:27:35 -07001264 return c.config.productVariables.TargetFSConfigGen
1265}
Inseob Kim0866b002019-04-15 20:21:29 +09001266
1267func (c *config) ProductPublicSepolicyDirs() []string {
1268 return c.productVariables.ProductPublicSepolicyDirs
1269}
1270
1271func (c *config) ProductPrivateSepolicyDirs() []string {
1272 return c.productVariables.ProductPrivateSepolicyDirs
1273}
1274
1275func (c *config) ProductCompatibleProperty() bool {
1276 return Bool(c.productVariables.ProductCompatibleProperty)
1277}
Inseob Kim1f086e22019-05-09 13:29:15 +09001278
Colin Cross50ddcc42019-05-16 12:28:22 -07001279func (c *config) MissingUsesLibraries() []string {
1280 return c.productVariables.MissingUsesLibraries
1281}
1282
Inseob Kim1f086e22019-05-09 13:29:15 +09001283func (c *deviceConfig) DeviceArch() string {
1284 return String(c.config.productVariables.DeviceArch)
1285}
1286
1287func (c *deviceConfig) DeviceArchVariant() string {
1288 return String(c.config.productVariables.DeviceArchVariant)
1289}
1290
1291func (c *deviceConfig) DeviceSecondaryArch() string {
1292 return String(c.config.productVariables.DeviceSecondaryArch)
1293}
1294
1295func (c *deviceConfig) DeviceSecondaryArchVariant() string {
1296 return String(c.config.productVariables.DeviceSecondaryArchVariant)
1297}
Yifan Hong82db7352020-01-21 16:12:26 -08001298
1299func (c *deviceConfig) BoardUsesRecoveryAsBoot() bool {
1300 return Bool(c.config.productVariables.BoardUsesRecoveryAsBoot)
1301}
Yifan Hong97365ee2020-07-29 09:51:57 -07001302
1303func (c *deviceConfig) BoardKernelBinaries() []string {
1304 return c.config.productVariables.BoardKernelBinaries
1305}
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001306
Yifan Hong42bef8d2020-08-05 14:36:09 -07001307func (c *deviceConfig) BoardKernelModuleInterfaceVersions() []string {
1308 return c.config.productVariables.BoardKernelModuleInterfaceVersions
1309}
1310
Yifan Hongdd8dacc2020-10-21 15:40:17 -07001311func (c *deviceConfig) BoardMoveRecoveryResourcesToVendorBoot() bool {
1312 return Bool(c.config.productVariables.BoardMoveRecoveryResourcesToVendorBoot)
1313}
1314
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001315// The ConfiguredJarList struct provides methods for handling a list of (apex, jar) pairs.
1316// Such lists are used in the build system for things like bootclasspath jars or system server jars.
1317// The apex part is either an apex name, or a special names "platform" or "system_ext". Jar is a
1318// module name. The pairs come from Make product variables as a list of colon-separated strings.
1319//
1320// Examples:
1321// - "com.android.art:core-oj"
1322// - "platform:framework"
1323// - "system_ext:foo"
1324//
1325type ConfiguredJarList struct {
1326 apexes []string // A list of apex components.
1327 jars []string // A list of jar components.
1328}
1329
1330// The length of the list.
1331func (l *ConfiguredJarList) Len() int {
1332 return len(l.jars)
1333}
1334
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001335// Jar component of idx-th pair on the list.
1336func (l *ConfiguredJarList) Jar(idx int) string {
1337 return l.jars[idx]
1338}
1339
Paul Duffin9a89a2a2020-10-28 19:20:06 +00001340// Apex component of idx-th pair on the list.
1341func (l *ConfiguredJarList) Apex(idx int) string {
1342 return l.apexes[idx]
1343}
1344
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001345// If the list contains a pair with the given jar.
1346func (l *ConfiguredJarList) ContainsJar(jar string) bool {
1347 return InList(jar, l.jars)
1348}
1349
1350// If the list contains the given (apex, jar) pair.
1351func (l *ConfiguredJarList) containsApexJarPair(apex, jar string) bool {
1352 for i := 0; i < l.Len(); i++ {
Paul Duffin1e8c6072020-10-23 18:28:55 +01001353 if apex == l.apexes[i] && jar == l.jars[i] {
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001354 return true
1355 }
1356 }
1357 return false
1358}
1359
1360// Index of the first pair with the given jar on the list, or -1 if none.
1361func (l *ConfiguredJarList) IndexOfJar(jar string) int {
1362 return IndexList(jar, l.jars)
1363}
1364
Paul Duffin7d584e92020-10-23 18:26:03 +01001365func copyAndAppend(list []string, item string) []string {
1366 // Create the result list to be 1 longer than the input.
1367 result := make([]string, len(list)+1)
1368
1369 // Copy the whole input list into the result.
1370 count := copy(result, list)
1371
1372 // Insert the extra item at the end.
1373 result[count] = item
1374
1375 return result
1376}
1377
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001378// Append an (apex, jar) pair to the list.
Paul Duffin7d584e92020-10-23 18:26:03 +01001379func (l *ConfiguredJarList) Append(apex string, jar string) ConfiguredJarList {
1380 // Create a copy of the backing arrays before appending to avoid sharing backing
1381 // arrays that are mutated across instances.
1382 apexes := copyAndAppend(l.apexes, apex)
1383 jars := copyAndAppend(l.jars, jar)
1384
1385 return ConfiguredJarList{apexes, jars}
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001386}
1387
1388// Filter out sublist.
Paul Duffin7d584e92020-10-23 18:26:03 +01001389func (l *ConfiguredJarList) RemoveList(list ConfiguredJarList) ConfiguredJarList {
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001390 apexes := make([]string, 0, l.Len())
1391 jars := make([]string, 0, l.Len())
1392
1393 for i, jar := range l.jars {
Paul Duffin1e8c6072020-10-23 18:28:55 +01001394 apex := l.apexes[i]
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001395 if !list.containsApexJarPair(apex, jar) {
1396 apexes = append(apexes, apex)
1397 jars = append(jars, jar)
1398 }
1399 }
1400
Paul Duffin7d584e92020-10-23 18:26:03 +01001401 return ConfiguredJarList{apexes, jars}
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001402}
1403
1404// A copy of the list of strings containing jar components.
1405func (l *ConfiguredJarList) CopyOfJars() []string {
1406 return CopyOf(l.jars)
1407}
1408
1409// A copy of the list of strings with colon-separated (apex, jar) pairs.
1410func (l *ConfiguredJarList) CopyOfApexJarPairs() []string {
1411 pairs := make([]string, 0, l.Len())
1412
1413 for i, jar := range l.jars {
Paul Duffin1e8c6072020-10-23 18:28:55 +01001414 apex := l.apexes[i]
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001415 pairs = append(pairs, apex+":"+jar)
1416 }
1417
1418 return pairs
1419}
1420
1421// A list of build paths based on the given directory prefix.
1422func (l *ConfiguredJarList) BuildPaths(ctx PathContext, dir OutputPath) WritablePaths {
1423 paths := make(WritablePaths, l.Len())
1424 for i, jar := range l.jars {
1425 paths[i] = dir.Join(ctx, ModuleStem(jar)+".jar")
1426 }
1427 return paths
1428}
1429
Paul Duffin69d1fb12020-10-23 21:14:20 +01001430// Called when loading configuration from JSON into a configuration structure.
1431func (l *ConfiguredJarList) UnmarshalJSON(b []byte) error {
1432 // Try and unmarshal into a []string each item of which contains a pair
1433 // <apex>:<jar>.
1434 var list []string
1435 err := json.Unmarshal(b, &list)
1436 if err != nil {
1437 // Did not work so return
1438 return err
1439 }
1440
1441 apexes, jars, err := splitListOfPairsIntoPairOfLists(list)
1442 if err != nil {
1443 return err
1444 }
1445 l.apexes = apexes
1446 l.jars = jars
1447 return nil
1448}
1449
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001450func ModuleStem(module string) string {
1451 // b/139391334: the stem of framework-minus-apex is framework. This is hard coded here until we
1452 // find a good way to query the stem of a module before any other mutators are run.
1453 if module == "framework-minus-apex" {
1454 return "framework"
1455 }
1456 return module
1457}
1458
1459// A list of on-device paths.
1460func (l *ConfiguredJarList) DevicePaths(cfg Config, ostype OsType) []string {
1461 paths := make([]string, l.Len())
1462 for i, jar := range l.jars {
1463 apex := l.apexes[i]
1464 name := ModuleStem(jar) + ".jar"
1465
1466 var subdir string
1467 if apex == "platform" {
1468 subdir = "system/framework"
1469 } else if apex == "system_ext" {
1470 subdir = "system_ext/framework"
1471 } else {
1472 subdir = filepath.Join("apex", apex, "javalib")
1473 }
1474
1475 if ostype.Class == Host {
1476 paths[i] = filepath.Join(cfg.Getenv("OUT_DIR"), "host", cfg.PrebuiltOS(), subdir, name)
1477 } else {
1478 paths[i] = filepath.Join("/", subdir, name)
1479 }
1480 }
1481 return paths
1482}
1483
Paul Duffin7d584e92020-10-23 18:26:03 +01001484func (l *ConfiguredJarList) String() string {
1485 var pairs []string
1486 for i := 0; i < l.Len(); i++ {
1487 pairs = append(pairs, l.apexes[i]+":"+l.jars[i])
1488 }
1489 return strings.Join(pairs, ",")
1490}
1491
Paul Duffin01416602020-10-23 21:04:03 +01001492func splitListOfPairsIntoPairOfLists(list []string) ([]string, []string, error) {
1493 // Now we need to populate this list by splitting each item in the slice of
1494 // pairs and appending them to the appropriate list of apexes or jars.
1495 apexes := make([]string, len(list))
1496 jars := make([]string, len(list))
1497
1498 for i, apexjar := range list {
1499 apex, jar, err := splitConfiguredJarPair(apexjar)
1500 if err != nil {
1501 return nil, nil, err
1502 }
1503 apexes[i] = apex
1504 jars[i] = jar
1505 }
1506
1507 return apexes, jars, nil
1508}
1509
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001510// Expected format for apexJarValue = <apex name>:<jar name>
Paul Duffin01416602020-10-23 21:04:03 +01001511func splitConfiguredJarPair(str string) (string, string, error) {
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001512 pair := strings.SplitN(str, ":", 2)
1513 if len(pair) == 2 {
Paul Duffin01416602020-10-23 21:04:03 +01001514 return pair[0], pair[1], nil
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001515 } else {
Paul Duffin01416602020-10-23 21:04:03 +01001516 return "error-apex", "error-jar", fmt.Errorf("malformed (apex, jar) pair: '%s', expected format: <apex>:<jar>", str)
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001517 }
1518}
1519
Paul Duffine10dfa42020-10-23 21:23:44 +01001520func CreateTestConfiguredJarList(list []string) ConfiguredJarList {
Paul Duffin01416602020-10-23 21:04:03 +01001521 apexes, jars, err := splitListOfPairsIntoPairOfLists(list)
1522 if err != nil {
Paul Duffine10dfa42020-10-23 21:23:44 +01001523 panic(err)
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001524 }
1525
Paul Duffin01416602020-10-23 21:04:03 +01001526 return ConfiguredJarList{apexes, jars}
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001527}
1528
1529func EmptyConfiguredJarList() ConfiguredJarList {
1530 return ConfiguredJarList{}
1531}
1532
1533var earlyBootJarsKey = NewOnceKey("earlyBootJars")
1534
1535func (c *config) BootJars() []string {
1536 return c.Once(earlyBootJarsKey, func() interface{} {
Paul Duffin69d1fb12020-10-23 21:14:20 +01001537 list := c.productVariables.BootJars.CopyOfJars()
1538 list = append(list, c.productVariables.UpdatableBootJars.CopyOfJars()...)
1539 return list
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001540 }).([]string)
1541}
Paul Duffin9a89a2a2020-10-28 19:20:06 +00001542
1543func (c *config) NonUpdatableBootJars() ConfiguredJarList {
1544 return c.productVariables.BootJars
1545}
1546
1547func (c *config) UpdatableBootJars() ConfiguredJarList {
1548 return c.productVariables.UpdatableBootJars
1549}