blob: e87a4ac2a0c808fffd7c9afce543774912ece14c [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 Cross9272ade2016-08-17 15:24:12 -0700129 OncePer
130}
131
132type deviceConfig struct {
Dan Willemsen00269f22017-07-06 16:59:48 -0700133 config *config
Colin Cross9272ade2016-08-17 15:24:12 -0700134 OncePer
Colin Cross3f40fa42015-01-30 17:27:36 -0800135}
136
Colin Cross485e5722015-08-27 13:28:01 -0700137type jsonConfigurable interface {
Colin Cross27385972015-09-18 10:57:10 -0700138 SetDefaultConfig()
Colin Cross485e5722015-08-27 13:28:01 -0700139}
Colin Cross3f40fa42015-01-30 17:27:36 -0800140
Colin Cross485e5722015-08-27 13:28:01 -0700141func loadConfig(config *config) error {
Colin Cross988414c2020-01-11 01:11:46 +0000142 err := loadFromConfigFile(&config.FileConfigurableOptions, absolutePath(config.ConfigFileName))
Colin Cross485e5722015-08-27 13:28:01 -0700143 if err != nil {
144 return err
145 }
146
Colin Cross988414c2020-01-11 01:11:46 +0000147 return loadFromConfigFile(&config.productVariables, absolutePath(config.ProductVariablesFileName))
Colin Cross485e5722015-08-27 13:28:01 -0700148}
149
150// loads configuration options from a JSON file in the cwd.
151func loadFromConfigFile(configurable jsonConfigurable, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800152 // Try to open the file
Colin Cross485e5722015-08-27 13:28:01 -0700153 configFileReader, err := os.Open(filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800154 defer configFileReader.Close()
155 if os.IsNotExist(err) {
156 // Need to create a file, so that blueprint & ninja don't get in
157 // a dependency tracking loop.
158 // Make a file-configurable-options with defaults, write it out using
159 // a json writer.
Colin Cross27385972015-09-18 10:57:10 -0700160 configurable.SetDefaultConfig()
161 err = saveToConfigFile(configurable, filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800162 if err != nil {
163 return err
164 }
Colin Cross15cd21a2018-02-27 11:26:02 -0800165 } else if err != nil {
166 return fmt.Errorf("config file: could not open %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800167 } else {
168 // Make a decoder for it
169 jsonDecoder := json.NewDecoder(configFileReader)
Colin Cross485e5722015-08-27 13:28:01 -0700170 err = jsonDecoder.Decode(configurable)
Colin Cross3f40fa42015-01-30 17:27:36 -0800171 if err != nil {
Colin Cross15cd21a2018-02-27 11:26:02 -0800172 return fmt.Errorf("config file: %s did not parse correctly: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800173 }
174 }
175
Colin Cross3f40fa42015-01-30 17:27:36 -0800176 // No error
177 return nil
178}
179
Colin Crossd8f20142016-11-03 09:43:26 -0700180// atomically writes the config file in case two copies of soong_build are running simultaneously
181// (for example, docs generation and ninja manifest generation)
Colin Cross485e5722015-08-27 13:28:01 -0700182func saveToConfigFile(config jsonConfigurable, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800183 data, err := json.MarshalIndent(&config, "", " ")
184 if err != nil {
185 return fmt.Errorf("cannot marshal config data: %s", err.Error())
186 }
187
Colin Crossd8f20142016-11-03 09:43:26 -0700188 f, err := ioutil.TempFile(filepath.Dir(filename), "config")
Colin Cross3f40fa42015-01-30 17:27:36 -0800189 if err != nil {
Colin Cross485e5722015-08-27 13:28:01 -0700190 return fmt.Errorf("cannot create empty config file %s: %s\n", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800191 }
Colin Crossd8f20142016-11-03 09:43:26 -0700192 defer os.Remove(f.Name())
193 defer f.Close()
Colin Cross3f40fa42015-01-30 17:27:36 -0800194
Colin Crossd8f20142016-11-03 09:43:26 -0700195 _, err = f.Write(data)
Colin Cross3f40fa42015-01-30 17:27:36 -0800196 if err != nil {
Colin Cross485e5722015-08-27 13:28:01 -0700197 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
198 }
199
Colin Crossd8f20142016-11-03 09:43:26 -0700200 _, err = f.WriteString("\n")
Colin Cross485e5722015-08-27 13:28:01 -0700201 if err != nil {
202 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800203 }
204
Colin Crossd8f20142016-11-03 09:43:26 -0700205 f.Close()
206 os.Rename(f.Name(), filename)
207
Colin Cross3f40fa42015-01-30 17:27:36 -0800208 return nil
209}
210
Colin Cross988414c2020-01-11 01:11:46 +0000211// NullConfig returns a mostly empty Config for use by standalone tools like dexpreopt_gen that
212// use the android package.
213func NullConfig(buildDir string) Config {
214 return Config{
215 config: &config{
216 buildDir: buildDir,
217 fs: pathtools.OsFs,
218 },
219 }
220}
221
Colin Crossce75d2c2016-10-06 16:12:58 -0700222// TestConfig returns a Config object suitable for using for tests
Colin Cross98be1bb2019-12-13 20:41:13 -0800223func TestConfig(buildDir string, env map[string]string, bp string, fs map[string][]byte) Config {
Colin Cross9c6241f2019-04-22 15:51:26 -0700224 envCopy := make(map[string]string)
225 for k, v := range env {
226 envCopy[k] = v
227 }
228
229 // Copy the real PATH value to the test environment, it's needed by HostSystemTool() used in x86_darwin_host.go
230 envCopy["PATH"] = originalEnv["PATH"]
231
Dan Willemsen00269f22017-07-06 16:59:48 -0700232 config := &config{
Dan Willemsen45133ac2018-03-09 21:22:06 -0800233 productVariables: productVariables{
Dan Albert4f378d72020-07-23 17:32:15 -0700234 DeviceName: stringPtr("test_device"),
235 Platform_sdk_version: intPtr(30),
236 Platform_sdk_codename: stringPtr("S"),
237 Platform_version_active_codenames: []string{"S"},
238 DeviceSystemSdkVersions: []string{"14", "15"},
239 Platform_systemsdk_versions: []string{"29", "30"},
240 AAPTConfig: []string{"normal", "large", "xlarge", "hdpi", "xhdpi", "xxhdpi"},
241 AAPTPreferredConfig: stringPtr("xhdpi"),
242 AAPTCharacteristics: stringPtr("nosdcard"),
243 AAPTPrebuiltDPI: []string{"xhdpi", "xxhdpi"},
244 UncompressPrivAppDex: boolPtr(true),
Dan Willemsen00269f22017-07-06 16:59:48 -0700245 },
246
Colin Cross6ccbc912017-10-10 23:07:38 -0700247 buildDir: buildDir,
248 captureBuild: true,
Colin Cross9c6241f2019-04-22 15:51:26 -0700249 env: envCopy,
Colin Cross5e6a7972020-06-07 16:56:32 -0700250
251 // Set testAllowNonExistentPaths so that test contexts don't need to specify every path
252 // passed to PathForSource or PathForModuleSrc.
253 testAllowNonExistentPaths: true,
Chris Parsonsf3c96ef2020-09-29 02:23:17 -0400254
255 BazelContext: noopBazelContext{},
Dan Willemsen00269f22017-07-06 16:59:48 -0700256 }
257 config.deviceConfig = &deviceConfig{
258 config: config,
259 }
Dan Willemsen45133ac2018-03-09 21:22:06 -0800260 config.TestProductVariables = &config.productVariables
Dan Willemsen00269f22017-07-06 16:59:48 -0700261
Colin Cross98be1bb2019-12-13 20:41:13 -0800262 config.mockFileSystem(bp, fs)
263
Colin Cross1369cdb2017-09-29 17:58:17 -0700264 if err := config.fromEnv(); err != nil {
265 panic(err)
266 }
267
Dan Willemsen00269f22017-07-06 16:59:48 -0700268 return Config{config}
Colin Crossce75d2c2016-10-06 16:12:58 -0700269}
270
Colin Cross98be1bb2019-12-13 20:41:13 -0800271func TestArchConfigNativeBridge(buildDir string, env map[string]string, bp string, fs map[string][]byte) Config {
272 testConfig := TestArchConfig(buildDir, env, bp, fs)
dimitry1f33e402019-03-26 12:39:31 +0100273 config := testConfig.config
274
Colin Cross0d99f7c2019-05-14 16:01:24 -0700275 config.Targets[Android] = []Target{
Jiyong Park1613e552020-09-14 19:43:17 +0900276 {Android, Arch{ArchType: X86_64, ArchVariant: "silvermont", Abi: []string{"arm64-v8a"}}, NativeBridgeDisabled, "", "", false},
277 {Android, Arch{ArchType: X86, ArchVariant: "silvermont", Abi: []string{"armeabi-v7a"}}, NativeBridgeDisabled, "", "", false},
278 {Android, Arch{ArchType: Arm64, ArchVariant: "armv8-a", Abi: []string{"arm64-v8a"}}, NativeBridgeEnabled, "x86_64", "arm64", false},
279 {Android, Arch{ArchType: Arm, ArchVariant: "armv7-a-neon", Abi: []string{"armeabi-v7a"}}, NativeBridgeEnabled, "x86", "arm", false},
dimitry1f33e402019-03-26 12:39:31 +0100280 }
281
282 return testConfig
283}
284
Colin Cross98be1bb2019-12-13 20:41:13 -0800285func TestArchConfigFuchsia(buildDir string, env map[string]string, bp string, fs map[string][]byte) Config {
286 testConfig := TestConfig(buildDir, env, bp, fs)
Doug Hornc32c6b02019-01-17 14:44:05 -0800287 config := testConfig.config
288
289 config.Targets = map[OsType][]Target{
290 Fuchsia: []Target{
Jiyong Park1613e552020-09-14 19:43:17 +0900291 {Fuchsia, Arch{ArchType: Arm64, ArchVariant: "", Abi: []string{"arm64-v8a"}}, NativeBridgeDisabled, "", "", false},
Doug Hornc32c6b02019-01-17 14:44:05 -0800292 },
293 BuildOs: []Target{
Jiyong Park1613e552020-09-14 19:43:17 +0900294 {BuildOs, Arch{ArchType: X86_64}, NativeBridgeDisabled, "", "", false},
Doug Hornc32c6b02019-01-17 14:44:05 -0800295 },
296 }
297
298 return testConfig
299}
300
Colin Crossae4c6182017-09-15 17:33:55 -0700301// TestConfig returns a Config object suitable for using for tests that need to run the arch mutator
Colin Cross98be1bb2019-12-13 20:41:13 -0800302func TestArchConfig(buildDir string, env map[string]string, bp string, fs map[string][]byte) Config {
303 testConfig := TestConfig(buildDir, env, bp, fs)
Colin Crossae4c6182017-09-15 17:33:55 -0700304 config := testConfig.config
305
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700306 config.Targets = map[OsType][]Target{
307 Android: []Target{
Jiyong Park1613e552020-09-14 19:43:17 +0900308 {Android, Arch{ArchType: Arm64, ArchVariant: "armv8-a", Abi: []string{"arm64-v8a"}}, NativeBridgeDisabled, "", "", false},
309 {Android, Arch{ArchType: Arm, ArchVariant: "armv7-a-neon", Abi: []string{"armeabi-v7a"}}, NativeBridgeDisabled, "", "", false},
Colin Crossae4c6182017-09-15 17:33:55 -0700310 },
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700311 BuildOs: []Target{
Jiyong Park1613e552020-09-14 19:43:17 +0900312 {BuildOs, Arch{ArchType: X86_64}, NativeBridgeDisabled, "", "", false},
313 {BuildOs, Arch{ArchType: X86}, NativeBridgeDisabled, "", "", false},
Colin Crossae4c6182017-09-15 17:33:55 -0700314 },
315 }
316
Colin Cross0d99f7c2019-05-14 16:01:24 -0700317 if runtime.GOOS == "darwin" {
318 config.Targets[BuildOs] = config.Targets[BuildOs][:1]
319 }
320
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700321 config.BuildOSTarget = config.Targets[BuildOs][0]
322 config.BuildOSCommonTarget = getCommonTargets(config.Targets[BuildOs])[0]
323 config.AndroidCommonTarget = getCommonTargets(config.Targets[Android])[0]
Jaewoong Jung642916f2020-10-09 17:25:15 -0700324 config.AndroidFirstDeviceTarget = firstTarget(config.Targets[Android], "lib64", "lib32")[0]
Inseob Kim1f086e22019-05-09 13:29:15 +0900325 config.TestProductVariables.DeviceArch = proptools.StringPtr("arm64")
326 config.TestProductVariables.DeviceArchVariant = proptools.StringPtr("armv8-a")
327 config.TestProductVariables.DeviceSecondaryArch = proptools.StringPtr("arm")
328 config.TestProductVariables.DeviceSecondaryArchVariant = proptools.StringPtr("armv7-a-neon")
Colin Cross2a076922018-10-04 23:28:25 -0700329
Colin Crossae4c6182017-09-15 17:33:55 -0700330 return testConfig
331}
332
Chris Parsonsf3c96ef2020-09-29 02:23:17 -0400333// Returns a config object which is "reset" for another bootstrap run.
334// Only per-run data is reset. Data which needs to persist across multiple
335// runs in the same program execution is carried over (such as Bazel context
336// or environment deps).
337func ConfigForAdditionalRun(c Config) (Config, error) {
338 newConfig, err := NewConfig(c.srcDir, c.buildDir, c.moduleListFile)
339 if err != nil {
340 return Config{}, err
341 }
342 newConfig.BazelContext = c.BazelContext
343 newConfig.envDeps = c.envDeps
344 return newConfig, nil
345}
346
Colin Cross3f40fa42015-01-30 17:27:36 -0800347// New creates a new Config object. The srcDir argument specifies the path to
348// the root source directory. It also loads the config file, if found.
Chris Parsons8f232a22020-06-23 17:37:05 -0400349func NewConfig(srcDir, buildDir string, moduleListFile string) (Config, error) {
Colin Cross3f40fa42015-01-30 17:27:36 -0800350 // Make a config with default options
Colin Cross9272ade2016-08-17 15:24:12 -0700351 config := &config{
352 ConfigFileName: filepath.Join(buildDir, configFileName),
353 ProductVariablesFileName: filepath.Join(buildDir, productVariablesFileName),
Dan Willemsen87b17d12015-07-14 00:39:06 -0700354
Colin Cross6ccbc912017-10-10 23:07:38 -0700355 env: originalEnv,
356
Colin Cross3b19f5d2019-09-17 14:45:31 -0700357 srcDir: srcDir,
358 buildDir: buildDir,
359 multilibConflicts: make(map[ArchType]bool),
Colin Cross98be1bb2019-12-13 20:41:13 -0800360
Chris Parsons8f232a22020-06-23 17:37:05 -0400361 moduleListFile: moduleListFile,
362 fs: pathtools.NewOsFs(absSrcDir),
Colin Cross68f55102015-03-25 14:43:57 -0700363 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800364
Dan Willemsen00269f22017-07-06 16:59:48 -0700365 config.deviceConfig = &deviceConfig{
Colin Cross9272ade2016-08-17 15:24:12 -0700366 config: config,
367 }
368
Liz Kammer7941b302020-07-28 13:27:34 -0700369 // Soundness check of the build and source directories. This won't catch strange
370 // configurations with symlinks, but at least checks the obvious case.
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700371 absBuildDir, err := filepath.Abs(buildDir)
372 if err != nil {
373 return Config{}, err
374 }
375
376 absSrcDir, err := filepath.Abs(srcDir)
377 if err != nil {
378 return Config{}, err
379 }
380
381 if strings.HasPrefix(absSrcDir, absBuildDir) {
382 return Config{}, fmt.Errorf("Build dir must not contain source directory")
383 }
384
Colin Cross3f40fa42015-01-30 17:27:36 -0800385 // Load any configurable options from the configuration file
Colin Cross9272ade2016-08-17 15:24:12 -0700386 err = loadConfig(config)
Colin Cross3f40fa42015-01-30 17:27:36 -0800387 if err != nil {
Colin Crossc3c0a492015-04-10 15:43:55 -0700388 return Config{}, err
Colin Cross3f40fa42015-01-30 17:27:36 -0800389 }
390
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800391 inMakeFile := filepath.Join(buildDir, ".soong.in_make")
Colin Cross988414c2020-01-11 01:11:46 +0000392 if _, err := os.Stat(absolutePath(inMakeFile)); err == nil {
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800393 config.inMake = true
394 }
395
Colin Crossa1ad8d12016-06-01 17:09:44 -0700396 targets, err := decodeTargetProductVariables(config)
Dan Willemsen218f6562015-07-08 18:13:11 -0700397 if err != nil {
398 return Config{}, err
399 }
400
Paul Duffin1356d8c2020-02-25 19:26:33 +0000401 // Make the CommonOS OsType available for all products.
402 targets[CommonOS] = []Target{commonTargetMap[CommonOS.Name]}
403
Dan Albert4098deb2016-10-19 14:04:41 -0700404 var archConfig []archConfig
Dan Willemsen322acaf2016-01-12 23:07:05 -0800405 if Bool(config.Mega_device) {
Dan Albert4098deb2016-10-19 14:04:41 -0700406 archConfig = getMegaDeviceConfig()
Colin Cross395f2cf2018-10-24 16:10:32 -0700407 } else if config.NdkAbis() {
Dan Albert4098deb2016-10-19 14:04:41 -0700408 archConfig = getNdkAbisConfig()
Martin Stjernholmc1ecc432019-11-15 15:00:31 +0000409 } else if config.AmlAbis() {
410 archConfig = getAmlAbisConfig()
Dan Albert4098deb2016-10-19 14:04:41 -0700411 }
412
413 if archConfig != nil {
Dan Willemsen01a3c252019-01-11 19:02:16 -0800414 androidTargets, err := decodeArchSettings(Android, archConfig)
Dan Willemsen322acaf2016-01-12 23:07:05 -0800415 if err != nil {
416 return Config{}, err
417 }
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700418 targets[Android] = androidTargets
Dan Willemsen322acaf2016-01-12 23:07:05 -0800419 }
420
Colin Cross3b19f5d2019-09-17 14:45:31 -0700421 multilib := make(map[string]bool)
422 for _, target := range targets[Android] {
423 if seen := multilib[target.Arch.ArchType.Multilib]; seen {
424 config.multilibConflicts[target.Arch.ArchType] = true
425 }
426 multilib[target.Arch.ArchType.Multilib] = true
427 }
428
Colin Crossa1ad8d12016-06-01 17:09:44 -0700429 config.Targets = targets
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700430 config.BuildOSTarget = config.Targets[BuildOs][0]
431 config.BuildOSCommonTarget = getCommonTargets(config.Targets[BuildOs])[0]
432 if len(config.Targets[Android]) > 0 {
433 config.AndroidCommonTarget = getCommonTargets(config.Targets[Android])[0]
Jaewoong Jung642916f2020-10-09 17:25:15 -0700434 config.AndroidFirstDeviceTarget = firstTarget(config.Targets[Android], "lib64", "lib32")[0]
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700435 }
Dan Willemsen218f6562015-07-08 18:13:11 -0700436
Colin Cross1369cdb2017-09-29 17:58:17 -0700437 if err := config.fromEnv(); err != nil {
438 return Config{}, err
439 }
440
Colin Cross1a6acd42020-06-16 17:51:46 -0700441 if Bool(config.productVariables.GcovCoverage) && Bool(config.productVariables.ClangCoverage) {
442 return Config{}, fmt.Errorf("GcovCoverage and ClangCoverage cannot both be set")
443 }
444
445 config.productVariables.Native_coverage = proptools.BoolPtr(
446 Bool(config.productVariables.GcovCoverage) ||
447 Bool(config.productVariables.ClangCoverage))
448
Chris Parsonsf3c96ef2020-09-29 02:23:17 -0400449 config.BazelContext, err = NewBazelContext(config)
450 if err != nil {
451 return Config{}, err
452 }
Colin Cross9272ade2016-08-17 15:24:12 -0700453 return Config{config}, nil
Colin Cross3f40fa42015-01-30 17:27:36 -0800454}
455
Colin Cross988414c2020-01-11 01:11:46 +0000456var TestConfigOsFs = map[string][]byte{}
457
Colin Cross98be1bb2019-12-13 20:41:13 -0800458// mockFileSystem replaces all reads with accesses to the provided map of
459// filenames to contents stored as a byte slice.
460func (c *config) mockFileSystem(bp string, fs map[string][]byte) {
461 mockFS := map[string][]byte{}
462
463 if _, exists := mockFS["Android.bp"]; !exists {
464 mockFS["Android.bp"] = []byte(bp)
465 }
466
467 for k, v := range fs {
468 mockFS[k] = v
469 }
470
471 // no module list file specified; find every file named Blueprints or Android.bp
472 pathsToParse := []string{}
473 for candidate := range mockFS {
474 base := filepath.Base(candidate)
475 if base == "Blueprints" || base == "Android.bp" {
476 pathsToParse = append(pathsToParse, candidate)
477 }
478 }
479 if len(pathsToParse) < 1 {
480 panic(fmt.Sprintf("No Blueprint or Android.bp files found in mock filesystem: %v\n", mockFS))
481 }
482 mockFS[blueprint.MockModuleListFile] = []byte(strings.Join(pathsToParse, "\n"))
483
484 c.fs = pathtools.MockFs(mockFS)
485 c.mockBpList = blueprint.MockModuleListFile
486}
487
Colin Cross1369cdb2017-09-29 17:58:17 -0700488func (c *config) fromEnv() error {
Pete Gillin0c2143e2019-05-02 15:32:11 +0100489 switch c.Getenv("EXPERIMENTAL_JAVA_LANGUAGE_LEVEL_9") {
Pete Gillin1b3370f2019-10-01 13:57:31 +0100490 case "", "true":
Pete Gillina1c9e9d2019-10-17 14:52:07 +0100491 // Do nothing
Colin Cross1369cdb2017-09-29 17:58:17 -0700492 default:
Pete Gillina1c9e9d2019-10-17 14:52:07 +0100493 return fmt.Errorf("The environment variable EXPERIMENTAL_JAVA_LANGUAGE_LEVEL_9 is no longer supported. Java language level 9 is now the global default.")
Colin Cross1369cdb2017-09-29 17:58:17 -0700494 }
495
496 return nil
497}
498
Colin Crosse87040b2017-12-11 15:52:26 -0800499func (c *config) StopBefore() bootstrap.StopBefore {
500 return c.stopBefore
Dan Willemsen218f6562015-07-08 18:13:11 -0700501}
502
Colin Crosse87040b2017-12-11 15:52:26 -0800503func (c *config) SetStopBefore(stopBefore bootstrap.StopBefore) {
504 c.stopBefore = stopBefore
505}
506
507var _ bootstrap.ConfigStopBefore = (*config)(nil)
508
Dan Willemsenc2aa4a92016-05-26 15:13:03 -0700509func (c *config) BlueprintToolLocation() string {
510 return filepath.Join(c.buildDir, "host", c.PrebuiltOS(), "bin")
511}
512
Colin Crosse87040b2017-12-11 15:52:26 -0800513var _ bootstrap.ConfigBlueprintToolLocation = (*config)(nil)
514
Dan Willemsen60e62f02018-11-16 21:05:32 -0800515func (c *config) HostToolPath(ctx PathContext, tool string) Path {
516 return PathForOutput(ctx, "host", c.PrebuiltOS(), "bin", tool)
517}
518
Martin Stjernholm7260d062019-12-09 21:47:14 +0000519func (c *config) HostJNIToolPath(ctx PathContext, path string) Path {
520 ext := ".so"
521 if runtime.GOOS == "darwin" {
522 ext = ".dylib"
523 }
524 return PathForOutput(ctx, "host", c.PrebuiltOS(), "lib64", path+ext)
525}
526
527func (c *config) HostJavaToolPath(ctx PathContext, path string) Path {
528 return PathForOutput(ctx, "host", c.PrebuiltOS(), "framework", path)
529}
530
Dan Willemsen66068722017-05-08 21:15:59 +0000531// HostSystemTool looks for non-hermetic tools from the system we're running on.
532// Generally shouldn't be used, but useful to find the XCode SDK, etc.
533func (c *config) HostSystemTool(name string) string {
534 for _, dir := range filepath.SplitList(c.Getenv("PATH")) {
535 path := filepath.Join(dir, name)
536 if s, err := os.Stat(path); err != nil {
537 continue
538 } else if m := s.Mode(); !s.IsDir() && m&0111 != 0 {
539 return path
540 }
541 }
542 return name
543}
544
Colin Cross3f40fa42015-01-30 17:27:36 -0800545// PrebuiltOS returns the name of the host OS used in prebuilts directories
Colin Cross1332b002015-04-07 17:11:30 -0700546func (c *config) PrebuiltOS() string {
Colin Cross3f40fa42015-01-30 17:27:36 -0800547 switch runtime.GOOS {
548 case "linux":
549 return "linux-x86"
550 case "darwin":
551 return "darwin-x86"
552 default:
553 panic("Unknown GOOS")
554 }
555}
556
557// GoRoot returns the path to the root directory of the Go toolchain.
Colin Cross1332b002015-04-07 17:11:30 -0700558func (c *config) GoRoot() string {
Colin Cross3f40fa42015-01-30 17:27:36 -0800559 return fmt.Sprintf("%s/prebuilts/go/%s", c.srcDir, c.PrebuiltOS())
560}
561
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700562func (c *config) PrebuiltBuildTool(ctx PathContext, tool string) Path {
563 return PathForSource(ctx, "prebuilts/build-tools", c.PrebuiltOS(), "bin", tool)
564}
565
Colin Cross1332b002015-04-07 17:11:30 -0700566func (c *config) CpPreserveSymlinksFlags() string {
Colin Cross485e5722015-08-27 13:28:01 -0700567 switch runtime.GOOS {
Colin Cross3f40fa42015-01-30 17:27:36 -0800568 case "darwin":
569 return "-R"
570 case "linux":
571 return "-d"
572 default:
573 return ""
574 }
575}
Colin Cross68f55102015-03-25 14:43:57 -0700576
Colin Cross1332b002015-04-07 17:11:30 -0700577func (c *config) Getenv(key string) string {
Colin Cross68f55102015-03-25 14:43:57 -0700578 var val string
579 var exists bool
Colin Crossc1e86a32015-04-15 12:33:28 -0700580 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800581 defer c.envLock.Unlock()
582 if c.envDeps == nil {
583 c.envDeps = make(map[string]string)
584 }
Colin Cross68f55102015-03-25 14:43:57 -0700585 if val, exists = c.envDeps[key]; !exists {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700586 if c.envFrozen {
587 panic("Cannot access new environment variables after envdeps are frozen")
588 }
Colin Cross6ccbc912017-10-10 23:07:38 -0700589 val, _ = c.env[key]
Colin Cross68f55102015-03-25 14:43:57 -0700590 c.envDeps[key] = val
591 }
592 return val
593}
594
Colin Cross99d7c232016-11-23 16:52:04 -0800595func (c *config) GetenvWithDefault(key string, defaultValue string) string {
596 ret := c.Getenv(key)
597 if ret == "" {
598 return defaultValue
599 }
600 return ret
601}
602
603func (c *config) IsEnvTrue(key string) bool {
604 value := c.Getenv(key)
605 return value == "1" || value == "y" || value == "yes" || value == "on" || value == "true"
606}
607
608func (c *config) IsEnvFalse(key string) bool {
609 value := c.Getenv(key)
610 return value == "0" || value == "n" || value == "no" || value == "off" || value == "false"
611}
612
Colin Cross1332b002015-04-07 17:11:30 -0700613func (c *config) EnvDeps() map[string]string {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700614 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800615 defer c.envLock.Unlock()
Dan Willemsene7680ba2015-09-11 17:06:19 -0700616 c.envFrozen = true
Colin Cross68f55102015-03-25 14:43:57 -0700617 return c.envDeps
618}
Colin Cross35cec122015-04-02 14:37:16 -0700619
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800620func (c *config) EmbeddedInMake() bool {
621 return c.inMake
622}
623
Nan Zhang581fd212018-01-10 16:06:12 -0800624func (c *config) BuildId() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800625 return String(c.productVariables.BuildId)
Nan Zhang581fd212018-01-10 16:06:12 -0800626}
627
Colin Cross2a2e0db2020-02-21 16:55:46 -0800628func (c *config) BuildNumberFile(ctx PathContext) Path {
629 return PathForOutput(ctx, String(c.productVariables.BuildNumberFile))
Nan Zhang581fd212018-01-10 16:06:12 -0800630}
631
Colin Cross35cec122015-04-02 14:37:16 -0700632// DeviceName returns the name of the current device target
633// TODO: take an AndroidModuleContext to select the device name for multi-device builds
Colin Cross1332b002015-04-07 17:11:30 -0700634func (c *config) DeviceName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800635 return *c.productVariables.DeviceName
Colin Cross35cec122015-04-02 14:37:16 -0700636}
637
Anton Hansson53c88442019-03-18 15:53:16 +0000638func (c *config) DeviceResourceOverlays() []string {
639 return c.productVariables.DeviceResourceOverlays
640}
641
642func (c *config) ProductResourceOverlays() []string {
643 return c.productVariables.ProductResourceOverlays
Colin Cross30e076a2015-04-13 13:58:27 -0700644}
645
Colin Crossbfd347d2018-05-09 11:11:35 -0700646func (c *config) PlatformVersionName() string {
647 return String(c.productVariables.Platform_version_name)
648}
649
Dan Albert4f378d72020-07-23 17:32:15 -0700650func (c *config) PlatformSdkVersion() ApiLevel {
651 return uncheckedFinalApiLevel(*c.productVariables.Platform_sdk_version)
Colin Cross30e076a2015-04-13 13:58:27 -0700652}
653
Colin Crossd09b0b62018-04-18 11:06:47 -0700654func (c *config) PlatformSdkCodename() string {
655 return String(c.productVariables.Platform_sdk_codename)
656}
657
Colin Cross092c9da2019-04-02 22:56:43 -0700658func (c *config) PlatformSecurityPatch() string {
659 return String(c.productVariables.Platform_security_patch)
660}
661
662func (c *config) PlatformPreviewSdkVersion() string {
663 return String(c.productVariables.Platform_preview_sdk_version)
664}
665
666func (c *config) PlatformMinSupportedTargetSdkVersion() string {
667 return String(c.productVariables.Platform_min_supported_target_sdk_version)
668}
669
670func (c *config) PlatformBaseOS() string {
671 return String(c.productVariables.Platform_base_os)
672}
673
Dan Albert1a246272020-07-06 14:49:35 -0700674func (c *config) MinSupportedSdkVersion() ApiLevel {
675 return uncheckedFinalApiLevel(16)
676}
677
678func (c *config) FinalApiLevels() []ApiLevel {
679 var levels []ApiLevel
Dan Albert4f378d72020-07-23 17:32:15 -0700680 for i := 1; i <= c.PlatformSdkVersion().FinalOrFutureInt(); i++ {
Dan Albert1a246272020-07-06 14:49:35 -0700681 levels = append(levels, uncheckedFinalApiLevel(i))
682 }
683 return levels
684}
685
686func (c *config) PreviewApiLevels() []ApiLevel {
687 var levels []ApiLevel
688 for i, codename := range c.PlatformVersionActiveCodenames() {
689 levels = append(levels, ApiLevel{
690 value: codename,
691 number: i,
692 isPreview: true,
693 })
694 }
695 return levels
696}
697
698func (c *config) AllSupportedApiLevels() []ApiLevel {
699 var levels []ApiLevel
700 levels = append(levels, c.FinalApiLevels()...)
701 return append(levels, c.PreviewApiLevels()...)
Dan Albertf5415d72017-08-17 16:19:59 -0700702}
703
Dan Albert4f378d72020-07-23 17:32:15 -0700704func (c *config) DefaultAppTargetSdk(ctx EarlyModuleContext) ApiLevel {
Colin Crossd09b0b62018-04-18 11:06:47 -0700705 if Bool(c.productVariables.Platform_sdk_final) {
706 return c.PlatformSdkVersion()
707 } else {
Dan Albert4f378d72020-07-23 17:32:15 -0700708 codename := c.PlatformSdkCodename()
709 if codename == "" {
710 return NoneApiLevel
711 }
712 if codename == "REL" {
713 panic("Platform_sdk_codename should not be REL when Platform_sdk_final is true")
714 }
715 return ApiLevelOrPanic(ctx, codename)
Colin Crossd09b0b62018-04-18 11:06:47 -0700716 }
717}
718
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800719func (c *config) AppsDefaultVersionName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800720 return String(c.productVariables.AppsDefaultVersionName)
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800721}
722
Dan Albert31384de2017-07-28 12:39:46 -0700723// Codenames that are active in the current lunch target.
724func (c *config) PlatformVersionActiveCodenames() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800725 return c.productVariables.Platform_version_active_codenames
Dan Albert31384de2017-07-28 12:39:46 -0700726}
727
Colin Crossface4e42017-10-30 17:32:15 -0700728func (c *config) ProductAAPTConfig() []string {
Colin Crossa74ca042019-01-31 14:31:51 -0800729 return c.productVariables.AAPTConfig
Colin Cross30e076a2015-04-13 13:58:27 -0700730}
731
Colin Crossface4e42017-10-30 17:32:15 -0700732func (c *config) ProductAAPTPreferredConfig() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800733 return String(c.productVariables.AAPTPreferredConfig)
Colin Cross30e076a2015-04-13 13:58:27 -0700734}
735
Colin Crossface4e42017-10-30 17:32:15 -0700736func (c *config) ProductAAPTCharacteristics() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800737 return String(c.productVariables.AAPTCharacteristics)
Colin Crossface4e42017-10-30 17:32:15 -0700738}
739
740func (c *config) ProductAAPTPrebuiltDPI() []string {
Colin Crossa74ca042019-01-31 14:31:51 -0800741 return c.productVariables.AAPTPrebuiltDPI
Colin Cross30e076a2015-04-13 13:58:27 -0700742}
743
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700744func (c *config) DefaultAppCertificateDir(ctx PathContext) SourcePath {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800745 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -0800746 if defaultCert != "" {
747 return PathForSource(ctx, filepath.Dir(defaultCert))
748 } else {
Dan Willemsen412160e2019-04-09 21:36:26 -0700749 return PathForSource(ctx, "build/make/target/product/security")
Colin Cross61ae0b72017-12-01 17:16:02 -0800750 }
Colin Cross30e076a2015-04-13 13:58:27 -0700751}
752
Colin Crosse1731a52017-12-14 11:22:55 -0800753func (c *config) DefaultAppCertificate(ctx PathContext) (pem, key SourcePath) {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800754 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -0800755 if defaultCert != "" {
Colin Crosse1731a52017-12-14 11:22:55 -0800756 return PathForSource(ctx, defaultCert+".x509.pem"), PathForSource(ctx, defaultCert+".pk8")
Colin Cross61ae0b72017-12-01 17:16:02 -0800757 } else {
Colin Crosse1731a52017-12-14 11:22:55 -0800758 defaultDir := c.DefaultAppCertificateDir(ctx)
759 return defaultDir.Join(ctx, "testkey.x509.pem"), defaultDir.Join(ctx, "testkey.pk8")
Colin Cross61ae0b72017-12-01 17:16:02 -0800760 }
Colin Cross30e076a2015-04-13 13:58:27 -0700761}
Colin Cross6ff51382015-12-17 16:39:19 -0800762
Jiyong Park9335a262018-12-24 11:31:58 +0900763func (c *config) ApexKeyDir(ctx ModuleContext) SourcePath {
764 // TODO(b/121224311): define another variable such as TARGET_APEX_KEY_OVERRIDE
765 defaultCert := String(c.productVariables.DefaultAppCertificate)
Dan Willemsen412160e2019-04-09 21:36:26 -0700766 if defaultCert == "" || filepath.Dir(defaultCert) == "build/make/target/product/security" {
Jiyong Park9335a262018-12-24 11:31:58 +0900767 // When defaultCert is unset or is set to the testkeys path, use the APEX keys
768 // that is under the module dir
Colin Cross07e51612019-03-05 12:46:40 -0800769 return pathForModuleSrc(ctx)
Jiyong Park9335a262018-12-24 11:31:58 +0900770 } else {
771 // If not, APEX keys are under the specified directory
772 return PathForSource(ctx, filepath.Dir(defaultCert))
773 }
774}
775
Colin Cross6ff51382015-12-17 16:39:19 -0800776func (c *config) AllowMissingDependencies() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800777 return Bool(c.productVariables.Allow_missing_dependencies)
Colin Cross6ff51382015-12-17 16:39:19 -0800778}
Dan Willemsen322acaf2016-01-12 23:07:05 -0800779
Jeongik Cha816a23a2020-07-08 01:09:23 +0900780// Returns true if a full platform source tree cannot be assumed.
Colin Crossfc3674a2017-09-18 17:41:52 -0700781func (c *config) UnbundledBuild() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800782 return Bool(c.productVariables.Unbundled_build)
Colin Crossfc3674a2017-09-18 17:41:52 -0700783}
784
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +0100785// Returns true if building apps that aren't bundled with the platform.
786// UnbundledBuild() is always true when this is true.
787func (c *config) UnbundledBuildApps() bool {
788 return Bool(c.productVariables.Unbundled_build_apps)
789}
790
Jeongik Cha816a23a2020-07-08 01:09:23 +0900791// Returns true if building modules against prebuilt SDKs.
792func (c *config) AlwaysUsePrebuiltSdks() bool {
793 return Bool(c.productVariables.Always_use_prebuilt_sdks)
Colin Cross1f367bf2018-12-18 22:46:24 -0800794}
795
Paul Duffin9a89a2a2020-10-28 19:20:06 +0000796// Returns true if the boot jars check should be skipped.
797func (c *config) SkipBootJarsCheck() bool {
798 return Bool(c.productVariables.Skip_boot_jars_check)
799}
800
Doug Horn21b94272019-01-16 12:06:11 -0800801func (c *config) Fuchsia() bool {
802 return Bool(c.productVariables.Fuchsia)
803}
804
Colin Cross126a25c2017-10-31 13:55:34 -0700805func (c *config) MinimizeJavaDebugInfo() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800806 return Bool(c.productVariables.MinimizeJavaDebugInfo) && !Bool(c.productVariables.Eng)
Colin Cross126a25c2017-10-31 13:55:34 -0700807}
808
Colin Crossed064c02018-09-05 16:28:13 -0700809func (c *config) Debuggable() bool {
810 return Bool(c.productVariables.Debuggable)
811}
812
Jaewoong Jung1d6eb682018-11-29 15:08:44 -0800813func (c *config) Eng() bool {
814 return Bool(c.productVariables.Eng)
815}
816
Jiyong Park8d52f862018-07-07 18:02:07 +0900817func (c *config) DevicePrimaryArchType() ArchType {
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700818 return c.Targets[Android][0].Arch.ArchType
Jiyong Park8d52f862018-07-07 18:02:07 +0900819}
820
Colin Cross893d8162017-04-26 17:34:03 -0700821func (c *config) SkipMegaDeviceInstall(path string) bool {
822 return Bool(c.Mega_device) &&
823 strings.HasPrefix(path, filepath.Join(c.buildDir, "target", "product"))
Dan Willemsen322acaf2016-01-12 23:07:05 -0800824}
Colin Cross16b23492016-01-06 14:41:07 -0800825
826func (c *config) SanitizeHost() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800827 return append([]string(nil), c.productVariables.SanitizeHost...)
Colin Cross16b23492016-01-06 14:41:07 -0800828}
829
830func (c *config) SanitizeDevice() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800831 return append([]string(nil), c.productVariables.SanitizeDevice...)
Colin Cross23ae82a2016-11-02 14:34:39 -0700832}
833
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700834func (c *config) SanitizeDeviceDiag() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800835 return append([]string(nil), c.productVariables.SanitizeDeviceDiag...)
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700836}
837
Colin Cross23ae82a2016-11-02 14:34:39 -0700838func (c *config) SanitizeDeviceArch() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800839 return append([]string(nil), c.productVariables.SanitizeDeviceArch...)
Colin Cross16b23492016-01-06 14:41:07 -0800840}
Colin Crossa1ad8d12016-06-01 17:09:44 -0700841
Vishwath Mohan1b017a72017-01-19 13:54:55 -0800842func (c *config) EnableCFI() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800843 if c.productVariables.EnableCFI == nil {
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -0800844 return true
845 } else {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800846 return *c.productVariables.EnableCFI
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -0800847 }
Vishwath Mohan1b017a72017-01-19 13:54:55 -0800848}
849
Kostya Kortchinskyd5275c82019-02-01 08:42:56 -0800850func (c *config) DisableScudo() bool {
851 return Bool(c.productVariables.DisableScudo)
852}
853
Colin Crossa1ad8d12016-06-01 17:09:44 -0700854func (c *config) Android64() bool {
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700855 for _, t := range c.Targets[Android] {
Colin Crossa1ad8d12016-06-01 17:09:44 -0700856 if t.Arch.ArchType.Multilib == "lib64" {
857 return true
858 }
859 }
860
861 return false
862}
Colin Cross9272ade2016-08-17 15:24:12 -0700863
Colin Cross9d45bb72016-08-29 16:14:13 -0700864func (c *config) UseGoma() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800865 return Bool(c.productVariables.UseGoma)
Colin Cross9d45bb72016-08-29 16:14:13 -0700866}
867
Ramy Medhatbbf25672019-07-17 12:30:04 +0000868func (c *config) UseRBE() bool {
869 return Bool(c.productVariables.UseRBE)
870}
871
Ramy Medhat8ea054a2020-01-27 14:19:44 -0500872func (c *config) UseRBEJAVAC() bool {
873 return Bool(c.productVariables.UseRBEJAVAC)
874}
875
876func (c *config) UseRBER8() bool {
877 return Bool(c.productVariables.UseRBER8)
878}
879
880func (c *config) UseRBED8() bool {
881 return Bool(c.productVariables.UseRBED8)
882}
883
Colin Cross8b8bec32019-11-15 13:18:43 -0800884func (c *config) UseRemoteBuild() bool {
885 return c.UseGoma() || c.UseRBE()
886}
887
Colin Cross66548102018-06-19 22:47:35 -0700888func (c *config) RunErrorProne() bool {
889 return c.IsEnvTrue("RUN_ERROR_PRONE")
890}
891
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800892func (c *config) XrefCorpusName() string {
893 return c.Getenv("XREF_CORPUS")
894}
895
Sasha Smundak6c2d4f92020-01-09 17:34:23 -0800896// Returns Compilation Unit encoding to use. Can be 'json' (default), 'proto' or 'all'.
897func (c *config) XrefCuEncoding() string {
898 if enc := c.Getenv("KYTHE_KZIP_ENCODING"); enc != "" {
899 return enc
900 }
901 return "json"
902}
903
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800904func (c *config) EmitXrefRules() bool {
905 return c.XrefCorpusName() != ""
906}
907
Dan Willemsena03cf6d2016-09-26 15:45:04 -0700908func (c *config) ClangTidy() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800909 return Bool(c.productVariables.ClangTidy)
Dan Willemsena03cf6d2016-09-26 15:45:04 -0700910}
911
912func (c *config) TidyChecks() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800913 if c.productVariables.TidyChecks == nil {
Dan Willemsena03cf6d2016-09-26 15:45:04 -0700914 return ""
915 }
Dan Willemsen45133ac2018-03-09 21:22:06 -0800916 return *c.productVariables.TidyChecks
Dan Willemsena03cf6d2016-09-26 15:45:04 -0700917}
918
Colin Cross0f4e0d62016-07-27 10:56:55 -0700919func (c *config) LibartImgHostBaseAddress() string {
920 return "0x60000000"
921}
922
923func (c *config) LibartImgDeviceBaseAddress() string {
Elliott Hughesda3a0712020-03-06 16:55:28 -0800924 return "0x70000000"
Colin Cross0f4e0d62016-07-27 10:56:55 -0700925}
926
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -0800927func (c *config) ArtUseReadBarrier() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800928 return Bool(c.productVariables.ArtUseReadBarrier)
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -0800929}
930
Dan Willemsen3fb1fae2018-03-12 15:30:26 -0700931func (c *config) EnforceRROForModule(name string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800932 enforceList := c.productVariables.EnforceRROTargets
Jeongik Chab9b13272020-03-09 12:37:05 +0900933 // TODO(b/150820813) Some modules depend on static overlay, remove this after eliminating the dependency.
934 exemptedList := c.productVariables.EnforceRROExemptedTargets
Roland Levillainf6cc2612020-07-09 16:58:14 +0100935 if len(exemptedList) > 0 {
Jeongik Chab9b13272020-03-09 12:37:05 +0900936 if InList(name, exemptedList) {
937 return false
938 }
939 }
Roland Levillainf6cc2612020-07-09 16:58:14 +0100940 if len(enforceList) > 0 {
Yo Chiang4ebd06a2019-10-01 13:13:41 +0800941 if InList("*", enforceList) {
Dan Willemsen3fb1fae2018-03-12 15:30:26 -0700942 return true
943 }
Colin Crossa74ca042019-01-31 14:31:51 -0800944 return InList(name, enforceList)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -0700945 }
946 return false
947}
948
Jaewoong Jungc779cd42020-10-06 18:56:10 -0700949func (c *config) EnforceRROExemptedForModule(name string) bool {
950 return InList(name, c.productVariables.EnforceRROExemptedTargets)
951}
952
Dan Willemsen3fb1fae2018-03-12 15:30:26 -0700953func (c *config) EnforceRROExcludedOverlay(path string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800954 excluded := c.productVariables.EnforceRROExcludedOverlays
Roland Levillainf6cc2612020-07-09 16:58:14 +0100955 if len(excluded) > 0 {
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800956 return HasAnyPrefix(path, excluded)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -0700957 }
958 return false
959}
960
961func (c *config) ExportedNamespaces() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800962 return append([]string(nil), c.productVariables.NamespacesToExport...)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -0700963}
964
965func (c *config) HostStaticBinaries() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800966 return Bool(c.productVariables.HostStaticBinaries)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -0700967}
968
Colin Cross5a0dcd52018-10-05 14:20:06 -0700969func (c *config) UncompressPrivAppDex() bool {
970 return Bool(c.productVariables.UncompressPrivAppDex)
971}
972
973func (c *config) ModulesLoadedByPrivilegedModules() []string {
974 return c.productVariables.ModulesLoadedByPrivilegedModules
975}
976
Jingwen Chenebb0b572020-11-02 00:24:57 -0500977func (c *config) DexpreoptGlobalConfigPath(ctx PathContext) OptionalPath {
Colin Cross988414c2020-01-11 01:11:46 +0000978 if c.productVariables.DexpreoptGlobalConfig == nil {
Jingwen Chenebb0b572020-11-02 00:24:57 -0500979 return OptionalPathForPath(nil)
980 }
981 return OptionalPathForPath(
982 pathForBuildToolDep(ctx, *c.productVariables.DexpreoptGlobalConfig))
983}
984
985func (c *config) DexpreoptGlobalConfig(ctx PathContext) ([]byte, error) {
986 path := c.DexpreoptGlobalConfigPath(ctx)
987 if !path.Valid() {
Colin Cross988414c2020-01-11 01:11:46 +0000988 return nil, nil
989 }
Jingwen Chenebb0b572020-11-02 00:24:57 -0500990 ctx.AddNinjaFileDeps(path.String())
991 return ioutil.ReadFile(absolutePath(path.String()))
Colin Cross43f08db2018-11-12 10:13:39 -0800992}
993
David Brazdil91b4e3e2019-01-23 21:04:05 +0000994func (c *config) FrameworksBaseDirExists(ctx PathContext) bool {
995 return ExistentPathForSource(ctx, "frameworks", "base").Valid()
996}
997
Inseob Kimae553032019-05-14 18:52:49 +0900998func (c *config) VndkSnapshotBuildArtifacts() bool {
999 return Bool(c.productVariables.VndkSnapshotBuildArtifacts)
1000}
1001
Colin Cross3b19f5d2019-09-17 14:45:31 -07001002func (c *config) HasMultilibConflict(arch ArchType) bool {
1003 return c.multilibConflicts[arch]
1004}
1005
Colin Cross9272ade2016-08-17 15:24:12 -07001006func (c *deviceConfig) Arches() []Arch {
1007 var arches []Arch
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001008 for _, target := range c.config.Targets[Android] {
Colin Cross9272ade2016-08-17 15:24:12 -07001009 arches = append(arches, target.Arch)
1010 }
1011 return arches
1012}
Dan Willemsend2ede872016-11-18 14:54:24 -08001013
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001014func (c *deviceConfig) BinderBitness() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001015 is32BitBinder := c.config.productVariables.Binder32bit
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001016 if is32BitBinder != nil && *is32BitBinder {
1017 return "32"
1018 }
1019 return "64"
1020}
1021
Dan Willemsen4353bc42016-12-05 17:16:02 -08001022func (c *deviceConfig) VendorPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001023 if c.config.productVariables.VendorPath != nil {
1024 return *c.config.productVariables.VendorPath
Dan Willemsen4353bc42016-12-05 17:16:02 -08001025 }
1026 return "vendor"
1027}
1028
Justin Yun71549282017-11-17 12:10:28 +09001029func (c *deviceConfig) VndkVersion() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001030 return String(c.config.productVariables.DeviceVndkVersion)
Justin Yun71549282017-11-17 12:10:28 +09001031}
1032
Jeongik Cha219141c2020-08-06 23:00:37 +09001033func (c *deviceConfig) CurrentApiLevelForVendorModules() string {
1034 return StringDefault(c.config.productVariables.DeviceCurrentApiLevelForVendorModules, "current")
1035}
1036
Justin Yun8fe12122017-12-07 17:18:15 +09001037func (c *deviceConfig) PlatformVndkVersion() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001038 return String(c.config.productVariables.Platform_vndk_version)
Justin Yun8fe12122017-12-07 17:18:15 +09001039}
1040
Justin Yun5f7f7e82019-11-18 19:52:14 +09001041func (c *deviceConfig) ProductVndkVersion() string {
1042 return String(c.config.productVariables.ProductVndkVersion)
1043}
1044
Justin Yun71549282017-11-17 12:10:28 +09001045func (c *deviceConfig) ExtraVndkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001046 return c.config.productVariables.ExtraVndkVersions
Dan Willemsend2ede872016-11-18 14:54:24 -08001047}
Jack He8cc71432016-12-08 15:45:07 -08001048
Vic Yangefd249e2018-11-12 20:19:56 -08001049func (c *deviceConfig) VndkUseCoreVariant() bool {
1050 return Bool(c.config.productVariables.VndkUseCoreVariant)
1051}
1052
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001053func (c *deviceConfig) SystemSdkVersions() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001054 return c.config.productVariables.DeviceSystemSdkVersions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001055}
1056
1057func (c *deviceConfig) PlatformSystemSdkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001058 return c.config.productVariables.Platform_systemsdk_versions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001059}
1060
Jiyong Park2db76922017-11-08 16:03:48 +09001061func (c *deviceConfig) OdmPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001062 if c.config.productVariables.OdmPath != nil {
1063 return *c.config.productVariables.OdmPath
Jiyong Park2db76922017-11-08 16:03:48 +09001064 }
1065 return "odm"
1066}
1067
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001068func (c *deviceConfig) ProductPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001069 if c.config.productVariables.ProductPath != nil {
1070 return *c.config.productVariables.ProductPath
Jiyong Park2db76922017-11-08 16:03:48 +09001071 }
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001072 return "product"
Jiyong Park2db76922017-11-08 16:03:48 +09001073}
1074
Justin Yund5f6c822019-06-25 16:47:17 +09001075func (c *deviceConfig) SystemExtPath() string {
1076 if c.config.productVariables.SystemExtPath != nil {
1077 return *c.config.productVariables.SystemExtPath
Dario Frenifd05a742018-05-29 13:28:54 +01001078 }
Justin Yund5f6c822019-06-25 16:47:17 +09001079 return "system_ext"
Dario Frenifd05a742018-05-29 13:28:54 +01001080}
1081
Jack He8cc71432016-12-08 15:45:07 -08001082func (c *deviceConfig) BtConfigIncludeDir() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001083 return String(c.config.productVariables.BtConfigIncludeDir)
Jack He8cc71432016-12-08 15:45:07 -08001084}
Dan Willemsen581341d2017-02-09 16:16:31 -08001085
Jiyong Parkd773eb32017-07-03 13:18:12 +09001086func (c *deviceConfig) DeviceKernelHeaderDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001087 return c.config.productVariables.DeviceKernelHeaders
Jiyong Parkd773eb32017-07-03 13:18:12 +09001088}
1089
Yi Kongceb5b762020-03-20 15:22:27 +08001090func (c *deviceConfig) SamplingPGO() bool {
1091 return Bool(c.config.productVariables.SamplingPGO)
1092}
1093
Roland Levillainada12702020-06-09 13:07:36 +01001094// JavaCoverageEnabledForPath returns whether Java code coverage is enabled for
1095// path. Coverage is enabled by default when the product variable
1096// JavaCoveragePaths is empty. If JavaCoveragePaths is not empty, coverage is
1097// enabled for any path which is part of this variable (and not part of the
1098// JavaCoverageExcludePaths product variable). Value "*" in JavaCoveragePaths
1099// represents any path.
1100func (c *deviceConfig) JavaCoverageEnabledForPath(path string) bool {
1101 coverage := false
Chris Gross2f748692020-06-24 20:36:59 +00001102 if len(c.config.productVariables.JavaCoveragePaths) == 0 ||
Roland Levillainada12702020-06-09 13:07:36 +01001103 InList("*", c.config.productVariables.JavaCoveragePaths) ||
1104 HasAnyPrefix(path, c.config.productVariables.JavaCoveragePaths) {
1105 coverage = true
1106 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001107 if coverage && len(c.config.productVariables.JavaCoverageExcludePaths) > 0 {
Roland Levillainada12702020-06-09 13:07:36 +01001108 if HasAnyPrefix(path, c.config.productVariables.JavaCoverageExcludePaths) {
1109 coverage = false
1110 }
1111 }
1112 return coverage
1113}
1114
Colin Cross1a6acd42020-06-16 17:51:46 -07001115// Returns true if gcov or clang coverage is enabled.
Dan Willemsen581341d2017-02-09 16:16:31 -08001116func (c *deviceConfig) NativeCoverageEnabled() bool {
Colin Cross1a6acd42020-06-16 17:51:46 -07001117 return Bool(c.config.productVariables.GcovCoverage) ||
1118 Bool(c.config.productVariables.ClangCoverage)
Dan Willemsen581341d2017-02-09 16:16:31 -08001119}
1120
Oliver Nguyen1382ab62019-12-06 15:22:41 -08001121func (c *deviceConfig) ClangCoverageEnabled() bool {
1122 return Bool(c.config.productVariables.ClangCoverage)
1123}
1124
Colin Cross1a6acd42020-06-16 17:51:46 -07001125func (c *deviceConfig) GcovCoverageEnabled() bool {
1126 return Bool(c.config.productVariables.GcovCoverage)
1127}
1128
Roland Levillain4f5297b2020-06-09 12:44:06 +01001129// NativeCoverageEnabledForPath returns whether (GCOV- or Clang-based) native
1130// code coverage is enabled for path. By default, coverage is not enabled for a
1131// given path unless it is part of the NativeCoveragePaths product variable (and
1132// not part of the NativeCoverageExcludePaths product variable). Value "*" in
1133// NativeCoveragePaths represents any path.
1134func (c *deviceConfig) NativeCoverageEnabledForPath(path string) bool {
Ryan Campbell469a18a2017-02-27 09:01:54 -08001135 coverage := false
Roland Levillainf6cc2612020-07-09 16:58:14 +01001136 if len(c.config.productVariables.NativeCoveragePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001137 if InList("*", c.config.productVariables.NativeCoveragePaths) || HasAnyPrefix(path, c.config.productVariables.NativeCoveragePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001138 coverage = true
Dan Willemsen581341d2017-02-09 16:16:31 -08001139 }
1140 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001141 if coverage && len(c.config.productVariables.NativeCoverageExcludePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001142 if HasAnyPrefix(path, c.config.productVariables.NativeCoverageExcludePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001143 coverage = false
Ryan Campbell469a18a2017-02-27 09:01:54 -08001144 }
1145 }
1146 return coverage
Dan Willemsen581341d2017-02-09 16:16:31 -08001147}
Ivan Lozano5f595532017-07-13 14:46:05 -07001148
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001149func (c *deviceConfig) PgoAdditionalProfileDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001150 return c.config.productVariables.PgoAdditionalProfileDirs
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001151}
1152
Tri Vo35a51432018-03-25 20:00:00 -07001153func (c *deviceConfig) VendorSepolicyDirs() []string {
1154 return c.config.productVariables.BoardVendorSepolicyDirs
1155}
1156
1157func (c *deviceConfig) OdmSepolicyDirs() []string {
1158 return c.config.productVariables.BoardOdmSepolicyDirs
1159}
1160
Felixa20a8752020-05-17 18:28:35 +02001161func (c *deviceConfig) SystemExtPublicSepolicyDirs() []string {
1162 return c.config.productVariables.SystemExtPublicSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001163}
1164
Felixa20a8752020-05-17 18:28:35 +02001165func (c *deviceConfig) SystemExtPrivateSepolicyDirs() []string {
1166 return c.config.productVariables.SystemExtPrivateSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001167}
1168
Inseob Kim0866b002019-04-15 20:21:29 +09001169func (c *deviceConfig) SepolicyM4Defs() []string {
1170 return c.config.productVariables.BoardSepolicyM4Defs
1171}
1172
Jiyong Park7f67f482019-01-05 12:57:48 +09001173func (c *deviceConfig) OverrideManifestPackageNameFor(name string) (manifestName string, overridden bool) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001174 return findOverrideValue(c.config.productVariables.ManifestPackageNameOverrides, name,
1175 "invalid override rule %q in PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES should be <module_name>:<manifest_name>")
1176}
1177
1178func (c *deviceConfig) OverrideCertificateFor(name string) (certificatePath string, overridden bool) {
Jaewoong Jungacb6db32019-02-28 16:22:30 +00001179 return findOverrideValue(c.config.productVariables.CertificateOverrides, name,
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001180 "invalid override rule %q in PRODUCT_CERTIFICATE_OVERRIDES should be <module_name>:<certificate_module_name>")
1181}
1182
Jaewoong Jung9d22a912019-01-23 16:27:47 -08001183func (c *deviceConfig) OverridePackageNameFor(name string) string {
1184 newName, overridden := findOverrideValue(
1185 c.config.productVariables.PackageNameOverrides,
1186 name,
1187 "invalid override rule %q in PRODUCT_PACKAGE_NAME_OVERRIDES should be <module_name>:<package_name>")
1188 if overridden {
1189 return newName
1190 }
1191 return name
1192}
1193
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001194func findOverrideValue(overrides []string, name string, errorMsg string) (newValue string, overridden bool) {
Jiyong Park7f67f482019-01-05 12:57:48 +09001195 if overrides == nil || len(overrides) == 0 {
1196 return "", false
1197 }
1198 for _, o := range overrides {
1199 split := strings.Split(o, ":")
1200 if len(split) != 2 {
1201 // This shouldn't happen as this is first checked in make, but just in case.
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001202 panic(fmt.Errorf(errorMsg, o))
Jiyong Park7f67f482019-01-05 12:57:48 +09001203 }
1204 if matchPattern(split[0], name) {
1205 return substPattern(split[0], split[1], name), true
1206 }
1207 }
1208 return "", false
1209}
1210
Ivan Lozano5f595532017-07-13 14:46:05 -07001211func (c *config) IntegerOverflowDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001212 if len(c.productVariables.IntegerOverflowExcludePaths) == 0 {
Ivan Lozano5f595532017-07-13 14:46:05 -07001213 return false
1214 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001215 return HasAnyPrefix(path, c.productVariables.IntegerOverflowExcludePaths)
Ivan Lozano5f595532017-07-13 14:46:05 -07001216}
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001217
1218func (c *config) CFIDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001219 if len(c.productVariables.CFIExcludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001220 return false
1221 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001222 return HasAnyPrefix(path, c.productVariables.CFIExcludePaths)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001223}
1224
1225func (c *config) CFIEnabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001226 if len(c.productVariables.CFIIncludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001227 return false
1228 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001229 return HasAnyPrefix(path, c.productVariables.CFIIncludePaths)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001230}
Colin Crosse15ddaf2017-12-04 11:24:31 -08001231
Dan Willemsen0fe78662018-03-26 12:41:18 -07001232func (c *config) VendorConfig(name string) VendorConfig {
Colin Cross9d34f352019-11-22 16:03:51 -08001233 return soongconfig.Config(c.productVariables.VendorVars[name])
Dan Willemsen0fe78662018-03-26 12:41:18 -07001234}
1235
Colin Cross395f2cf2018-10-24 16:10:32 -07001236func (c *config) NdkAbis() bool {
1237 return Bool(c.productVariables.Ndk_abis)
1238}
1239
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001240func (c *config) AmlAbis() bool {
1241 return Bool(c.productVariables.Aml_abis)
1242}
1243
Dan Albert23d37e02018-11-28 08:30:10 -08001244func (c *config) ExcludeDraftNdkApis() bool {
1245 return Bool(c.productVariables.Exclude_draft_ndk_apis)
1246}
1247
Jiyong Park8fd61922018-11-08 02:50:25 +09001248func (c *config) FlattenApex() bool {
Roland Levillaina3863212019-08-12 19:56:16 +01001249 return Bool(c.productVariables.Flatten_apex)
Jiyong Park8fd61922018-11-08 02:50:25 +09001250}
1251
Jeongik Chac9464142019-01-07 12:07:27 +09001252func (c *config) EnforceSystemCertificate() bool {
1253 return Bool(c.productVariables.EnforceSystemCertificate)
1254}
1255
Colin Cross440e0d02020-06-11 11:32:11 -07001256func (c *config) EnforceSystemCertificateAllowList() []string {
1257 return c.productVariables.EnforceSystemCertificateAllowList
Jeongik Chac9464142019-01-07 12:07:27 +09001258}
1259
Jeongik Cha2cc570d2019-10-29 15:44:45 +09001260func (c *config) EnforceProductPartitionInterface() bool {
1261 return Bool(c.productVariables.EnforceProductPartitionInterface)
1262}
1263
Jooyung Han3ab2c3e2019-12-05 16:27:44 +09001264func (c *config) InstallExtraFlattenedApexes() bool {
1265 return Bool(c.productVariables.InstallExtraFlattenedApexes)
1266}
1267
Colin Crossf24a22a2019-01-31 14:12:44 -08001268func (c *config) ProductHiddenAPIStubs() []string {
1269 return c.productVariables.ProductHiddenAPIStubs
Colin Cross8faf8fc2019-01-16 15:15:52 -08001270}
1271
Colin Crossf24a22a2019-01-31 14:12:44 -08001272func (c *config) ProductHiddenAPIStubsSystem() []string {
1273 return c.productVariables.ProductHiddenAPIStubsSystem
Colin Cross8faf8fc2019-01-16 15:15:52 -08001274}
1275
Colin Crossf24a22a2019-01-31 14:12:44 -08001276func (c *config) ProductHiddenAPIStubsTest() []string {
1277 return c.productVariables.ProductHiddenAPIStubsTest
Colin Cross8faf8fc2019-01-16 15:15:52 -08001278}
Dan Willemsen71c74602019-04-10 12:27:35 -07001279
Dan Willemsen54879d12019-04-18 10:08:46 -07001280func (c *deviceConfig) TargetFSConfigGen() []string {
Dan Willemsen71c74602019-04-10 12:27:35 -07001281 return c.config.productVariables.TargetFSConfigGen
1282}
Inseob Kim0866b002019-04-15 20:21:29 +09001283
1284func (c *config) ProductPublicSepolicyDirs() []string {
1285 return c.productVariables.ProductPublicSepolicyDirs
1286}
1287
1288func (c *config) ProductPrivateSepolicyDirs() []string {
1289 return c.productVariables.ProductPrivateSepolicyDirs
1290}
1291
1292func (c *config) ProductCompatibleProperty() bool {
1293 return Bool(c.productVariables.ProductCompatibleProperty)
1294}
Inseob Kim1f086e22019-05-09 13:29:15 +09001295
Colin Cross50ddcc42019-05-16 12:28:22 -07001296func (c *config) MissingUsesLibraries() []string {
1297 return c.productVariables.MissingUsesLibraries
1298}
1299
Inseob Kim1f086e22019-05-09 13:29:15 +09001300func (c *deviceConfig) DeviceArch() string {
1301 return String(c.config.productVariables.DeviceArch)
1302}
1303
1304func (c *deviceConfig) DeviceArchVariant() string {
1305 return String(c.config.productVariables.DeviceArchVariant)
1306}
1307
1308func (c *deviceConfig) DeviceSecondaryArch() string {
1309 return String(c.config.productVariables.DeviceSecondaryArch)
1310}
1311
1312func (c *deviceConfig) DeviceSecondaryArchVariant() string {
1313 return String(c.config.productVariables.DeviceSecondaryArchVariant)
1314}
Yifan Hong82db7352020-01-21 16:12:26 -08001315
1316func (c *deviceConfig) BoardUsesRecoveryAsBoot() bool {
1317 return Bool(c.config.productVariables.BoardUsesRecoveryAsBoot)
1318}
Yifan Hong97365ee2020-07-29 09:51:57 -07001319
1320func (c *deviceConfig) BoardKernelBinaries() []string {
1321 return c.config.productVariables.BoardKernelBinaries
1322}
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001323
Yifan Hong42bef8d2020-08-05 14:36:09 -07001324func (c *deviceConfig) BoardKernelModuleInterfaceVersions() []string {
1325 return c.config.productVariables.BoardKernelModuleInterfaceVersions
1326}
1327
Yifan Hongdd8dacc2020-10-21 15:40:17 -07001328func (c *deviceConfig) BoardMoveRecoveryResourcesToVendorBoot() bool {
1329 return Bool(c.config.productVariables.BoardMoveRecoveryResourcesToVendorBoot)
1330}
1331
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001332// The ConfiguredJarList struct provides methods for handling a list of (apex, jar) pairs.
1333// Such lists are used in the build system for things like bootclasspath jars or system server jars.
1334// The apex part is either an apex name, or a special names "platform" or "system_ext". Jar is a
1335// module name. The pairs come from Make product variables as a list of colon-separated strings.
1336//
1337// Examples:
1338// - "com.android.art:core-oj"
1339// - "platform:framework"
1340// - "system_ext:foo"
1341//
1342type ConfiguredJarList struct {
1343 apexes []string // A list of apex components.
1344 jars []string // A list of jar components.
1345}
1346
1347// The length of the list.
1348func (l *ConfiguredJarList) Len() int {
1349 return len(l.jars)
1350}
1351
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001352// Jar component of idx-th pair on the list.
1353func (l *ConfiguredJarList) Jar(idx int) string {
1354 return l.jars[idx]
1355}
1356
Paul Duffin9a89a2a2020-10-28 19:20:06 +00001357// Apex component of idx-th pair on the list.
1358func (l *ConfiguredJarList) Apex(idx int) string {
1359 return l.apexes[idx]
1360}
1361
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001362// If the list contains a pair with the given jar.
1363func (l *ConfiguredJarList) ContainsJar(jar string) bool {
1364 return InList(jar, l.jars)
1365}
1366
1367// If the list contains the given (apex, jar) pair.
1368func (l *ConfiguredJarList) containsApexJarPair(apex, jar string) bool {
1369 for i := 0; i < l.Len(); i++ {
Paul Duffin1e8c6072020-10-23 18:28:55 +01001370 if apex == l.apexes[i] && jar == l.jars[i] {
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001371 return true
1372 }
1373 }
1374 return false
1375}
1376
1377// Index of the first pair with the given jar on the list, or -1 if none.
1378func (l *ConfiguredJarList) IndexOfJar(jar string) int {
1379 return IndexList(jar, l.jars)
1380}
1381
Paul Duffin7d584e92020-10-23 18:26:03 +01001382func copyAndAppend(list []string, item string) []string {
1383 // Create the result list to be 1 longer than the input.
1384 result := make([]string, len(list)+1)
1385
1386 // Copy the whole input list into the result.
1387 count := copy(result, list)
1388
1389 // Insert the extra item at the end.
1390 result[count] = item
1391
1392 return result
1393}
1394
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001395// Append an (apex, jar) pair to the list.
Paul Duffin7d584e92020-10-23 18:26:03 +01001396func (l *ConfiguredJarList) Append(apex string, jar string) ConfiguredJarList {
1397 // Create a copy of the backing arrays before appending to avoid sharing backing
1398 // arrays that are mutated across instances.
1399 apexes := copyAndAppend(l.apexes, apex)
1400 jars := copyAndAppend(l.jars, jar)
1401
1402 return ConfiguredJarList{apexes, jars}
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001403}
1404
1405// Filter out sublist.
Paul Duffin7d584e92020-10-23 18:26:03 +01001406func (l *ConfiguredJarList) RemoveList(list ConfiguredJarList) ConfiguredJarList {
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001407 apexes := make([]string, 0, l.Len())
1408 jars := make([]string, 0, l.Len())
1409
1410 for i, jar := range l.jars {
Paul Duffin1e8c6072020-10-23 18:28:55 +01001411 apex := l.apexes[i]
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001412 if !list.containsApexJarPair(apex, jar) {
1413 apexes = append(apexes, apex)
1414 jars = append(jars, jar)
1415 }
1416 }
1417
Paul Duffin7d584e92020-10-23 18:26:03 +01001418 return ConfiguredJarList{apexes, jars}
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001419}
1420
1421// A copy of the list of strings containing jar components.
1422func (l *ConfiguredJarList) CopyOfJars() []string {
1423 return CopyOf(l.jars)
1424}
1425
1426// A copy of the list of strings with colon-separated (apex, jar) pairs.
1427func (l *ConfiguredJarList) CopyOfApexJarPairs() []string {
1428 pairs := make([]string, 0, l.Len())
1429
1430 for i, jar := range l.jars {
Paul Duffin1e8c6072020-10-23 18:28:55 +01001431 apex := l.apexes[i]
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001432 pairs = append(pairs, apex+":"+jar)
1433 }
1434
1435 return pairs
1436}
1437
1438// A list of build paths based on the given directory prefix.
1439func (l *ConfiguredJarList) BuildPaths(ctx PathContext, dir OutputPath) WritablePaths {
1440 paths := make(WritablePaths, l.Len())
1441 for i, jar := range l.jars {
1442 paths[i] = dir.Join(ctx, ModuleStem(jar)+".jar")
1443 }
1444 return paths
1445}
1446
Paul Duffin69d1fb12020-10-23 21:14:20 +01001447// Called when loading configuration from JSON into a configuration structure.
1448func (l *ConfiguredJarList) UnmarshalJSON(b []byte) error {
1449 // Try and unmarshal into a []string each item of which contains a pair
1450 // <apex>:<jar>.
1451 var list []string
1452 err := json.Unmarshal(b, &list)
1453 if err != nil {
1454 // Did not work so return
1455 return err
1456 }
1457
1458 apexes, jars, err := splitListOfPairsIntoPairOfLists(list)
1459 if err != nil {
1460 return err
1461 }
1462 l.apexes = apexes
1463 l.jars = jars
1464 return nil
1465}
1466
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001467func ModuleStem(module string) string {
1468 // b/139391334: the stem of framework-minus-apex is framework. This is hard coded here until we
1469 // find a good way to query the stem of a module before any other mutators are run.
1470 if module == "framework-minus-apex" {
1471 return "framework"
1472 }
1473 return module
1474}
1475
1476// A list of on-device paths.
1477func (l *ConfiguredJarList) DevicePaths(cfg Config, ostype OsType) []string {
1478 paths := make([]string, l.Len())
1479 for i, jar := range l.jars {
1480 apex := l.apexes[i]
1481 name := ModuleStem(jar) + ".jar"
1482
1483 var subdir string
1484 if apex == "platform" {
1485 subdir = "system/framework"
1486 } else if apex == "system_ext" {
1487 subdir = "system_ext/framework"
1488 } else {
1489 subdir = filepath.Join("apex", apex, "javalib")
1490 }
1491
1492 if ostype.Class == Host {
1493 paths[i] = filepath.Join(cfg.Getenv("OUT_DIR"), "host", cfg.PrebuiltOS(), subdir, name)
1494 } else {
1495 paths[i] = filepath.Join("/", subdir, name)
1496 }
1497 }
1498 return paths
1499}
1500
Paul Duffin7d584e92020-10-23 18:26:03 +01001501func (l *ConfiguredJarList) String() string {
1502 var pairs []string
1503 for i := 0; i < l.Len(); i++ {
1504 pairs = append(pairs, l.apexes[i]+":"+l.jars[i])
1505 }
1506 return strings.Join(pairs, ",")
1507}
1508
Paul Duffin01416602020-10-23 21:04:03 +01001509func splitListOfPairsIntoPairOfLists(list []string) ([]string, []string, error) {
1510 // Now we need to populate this list by splitting each item in the slice of
1511 // pairs and appending them to the appropriate list of apexes or jars.
1512 apexes := make([]string, len(list))
1513 jars := make([]string, len(list))
1514
1515 for i, apexjar := range list {
1516 apex, jar, err := splitConfiguredJarPair(apexjar)
1517 if err != nil {
1518 return nil, nil, err
1519 }
1520 apexes[i] = apex
1521 jars[i] = jar
1522 }
1523
1524 return apexes, jars, nil
1525}
1526
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001527// Expected format for apexJarValue = <apex name>:<jar name>
Paul Duffin01416602020-10-23 21:04:03 +01001528func splitConfiguredJarPair(str string) (string, string, error) {
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001529 pair := strings.SplitN(str, ":", 2)
1530 if len(pair) == 2 {
Paul Duffin01416602020-10-23 21:04:03 +01001531 return pair[0], pair[1], nil
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001532 } else {
Paul Duffin01416602020-10-23 21:04:03 +01001533 return "error-apex", "error-jar", fmt.Errorf("malformed (apex, jar) pair: '%s', expected format: <apex>:<jar>", str)
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001534 }
1535}
1536
Paul Duffine10dfa42020-10-23 21:23:44 +01001537func CreateTestConfiguredJarList(list []string) ConfiguredJarList {
Paul Duffin01416602020-10-23 21:04:03 +01001538 apexes, jars, err := splitListOfPairsIntoPairOfLists(list)
1539 if err != nil {
Paul Duffine10dfa42020-10-23 21:23:44 +01001540 panic(err)
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001541 }
1542
Paul Duffin01416602020-10-23 21:04:03 +01001543 return ConfiguredJarList{apexes, jars}
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001544}
1545
1546func EmptyConfiguredJarList() ConfiguredJarList {
1547 return ConfiguredJarList{}
1548}
1549
1550var earlyBootJarsKey = NewOnceKey("earlyBootJars")
1551
1552func (c *config) BootJars() []string {
1553 return c.Once(earlyBootJarsKey, func() interface{} {
Paul Duffin69d1fb12020-10-23 21:14:20 +01001554 list := c.productVariables.BootJars.CopyOfJars()
1555 list = append(list, c.productVariables.UpdatableBootJars.CopyOfJars()...)
1556 return list
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001557 }).([]string)
1558}
Paul Duffin9a89a2a2020-10-28 19:20:06 +00001559
1560func (c *config) NonUpdatableBootJars() ConfiguredJarList {
1561 return c.productVariables.BootJars
1562}
1563
1564func (c *config) UpdatableBootJars() ConfiguredJarList {
1565 return c.productVariables.UpdatableBootJars
1566}