blob: f430b72155d5e804cce2953abe9c7397a65b4d1e [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
Jingwen Chenc711fec2020-11-22 23:52:50 -050017// This is the primary location to write and read all configuration values and
18// product variables necessary for soong_build's operation.
19
Colin Cross3f40fa42015-01-30 17:27:36 -080020import (
Cole Faust082c5f32022-08-04 15:49:20 -070021 "bytes"
Colin Cross3f40fa42015-01-30 17:27:36 -080022 "encoding/json"
23 "fmt"
Colin Crossd8f20142016-11-03 09:43:26 -070024 "io/ioutil"
Colin Cross3f40fa42015-01-30 17:27:36 -080025 "os"
Colin Cross35cec122015-04-02 14:37:16 -070026 "path/filepath"
Sam Delmerico5c32bbf2022-01-20 20:15:02 +000027 "reflect"
Colin Cross3f40fa42015-01-30 17:27:36 -080028 "runtime"
Inseob Kim60c32f02020-12-21 22:53:05 +090029 "strconv"
Dan Willemsen34cc69e2015-09-23 15:26:20 -070030 "strings"
Colin Crossc1e86a32015-04-15 12:33:28 -070031 "sync"
Colin Cross6ff51382015-12-17 16:39:19 -080032
Colin Cross98be1bb2019-12-13 20:41:13 -080033 "github.com/google/blueprint"
Colin Crosse87040b2017-12-11 15:52:26 -080034 "github.com/google/blueprint/bootstrap"
Colin Cross98be1bb2019-12-13 20:41:13 -080035 "github.com/google/blueprint/pathtools"
Colin Cross6ff51382015-12-17 16:39:19 -080036 "github.com/google/blueprint/proptools"
Colin Cross9d34f352019-11-22 16:03:51 -080037
38 "android/soong/android/soongconfig"
Liz Kammer09f947d2021-05-12 14:51:49 -040039 "android/soong/bazel"
Colin Cross77cdcfd2021-03-12 11:28:25 -080040 "android/soong/remoteexec"
Liz Kammer72beb342022-02-03 08:42:10 -050041 "android/soong/starlark_fmt"
Colin Cross3f40fa42015-01-30 17:27:36 -080042)
43
Jingwen Chenc711fec2020-11-22 23:52:50 -050044// Bool re-exports proptools.Bool for the android package.
Colin Cross6ff51382015-12-17 16:39:19 -080045var Bool = proptools.Bool
Jingwen Chenc711fec2020-11-22 23:52:50 -050046
47// String re-exports proptools.String for the android package.
Jack He8cc71432016-12-08 15:45:07 -080048var String = proptools.String
Jingwen Chenc711fec2020-11-22 23:52:50 -050049
50// StringDefault re-exports proptools.StringDefault for the android package.
Jeongik Cha219141c2020-08-06 23:00:37 +090051var StringDefault = proptools.StringDefault
Jiyong Park6a927c42020-01-21 02:03:43 +090052
Jingwen Chenc711fec2020-11-22 23:52:50 -050053// FutureApiLevelInt is a placeholder constant for unreleased API levels.
Dan Albert0b176c82020-07-23 16:43:25 -070054const FutureApiLevelInt = 10000
55
Jingwen Chenc711fec2020-11-22 23:52:50 -050056// FutureApiLevel represents unreleased API levels.
Dan Albert0b176c82020-07-23 16:43:25 -070057var FutureApiLevel = ApiLevel{
58 value: "current",
59 number: FutureApiLevelInt,
60 isPreview: true,
61}
Colin Cross6ff51382015-12-17 16:39:19 -080062
Jingwen Chenc4d91bc2020-11-24 22:59:26 -050063// The product variables file name, containing product config from Kati.
Dan Willemsen87b17d12015-07-14 00:39:06 -070064const productVariablesFileName = "soong.variables"
Colin Cross3f40fa42015-01-30 17:27:36 -080065
Colin Cross9272ade2016-08-17 15:24:12 -070066// A Config object represents the entire build configuration for Android.
Colin Crossc3c0a492015-04-10 15:43:55 -070067type Config struct {
68 *config
69}
70
Chris Parsonsad876012022-08-20 14:48:32 -040071type SoongBuildMode int
72
73// Build modes that soong_build can run as.
74const (
75 // Don't use bazel at all during module analysis.
76 AnalysisNoBazel SoongBuildMode = iota
77
Lukacs T. Berkic541cd22022-10-26 07:26:50 +000078 // Symlink fores mode: merge two directory trees into a symlink forest
79 SymlinkForest
80
Chris Parsonsad876012022-08-20 14:48:32 -040081 // Bp2build mode: Generate BUILD files from blueprint files and exit.
82 Bp2build
83
84 // Generate BUILD files which faithfully represent the dependency graph of
85 // blueprint modules. Individual BUILD targets will not, however, faitfhully
86 // express build semantics.
87 GenerateQueryView
88
Spandan Das5af0bd32022-09-28 20:43:08 +000089 // Generate BUILD files for API contributions to API surfaces
90 ApiBp2build
91
Chris Parsonsad876012022-08-20 14:48:32 -040092 // Create a JSON representation of the module graph and exit.
93 GenerateModuleGraph
94
95 // Generate a documentation file for module type definitions and exit.
96 GenerateDocFile
97
98 // Use bazel during analysis of many allowlisted build modules. The allowlist
99 // is considered a "developer mode" allowlist, as some modules may be
100 // allowlisted on an experimental basis.
101 BazelDevMode
102
MarkDacekb78465d2022-10-18 20:10:16 +0000103 // Use bazel during analysis of a few allowlisted build modules. The allowlist
104 // is considered "staging, as these are modules being prepared to be released
105 // into prod mode shortly after.
106 BazelStagingMode
107
Chris Parsonsad876012022-08-20 14:48:32 -0400108 // Use bazel during analysis of build modules from an allowlist carefully
109 // curated by the build team to be proven stable.
Chris Parsonsad876012022-08-20 14:48:32 -0400110 BazelProdMode
111)
112
Lukacs T. Berkib078ade2021-08-31 10:42:08 +0200113// SoongOutDir returns the build output directory for the configuration.
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200114func (c Config) SoongOutDir() string {
115 return c.soongOutDir
Jeff Gastonefc1b412017-03-29 17:29:06 -0700116}
117
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200118func (c Config) OutDir() string {
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200119 return c.outDir
Lukacs T. Berki89e9a162021-03-12 08:31:32 +0100120}
121
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200122func (c Config) RunGoTests() bool {
123 return c.runGoTests
124}
125
Lukacs T. Berki5f6cb1d2021-03-17 15:03:14 +0100126func (c Config) DebugCompilation() bool {
127 return false // Never compile Go code in the main build for debugging
128}
129
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200130func (c Config) Subninjas() []string {
131 return []string{}
132}
133
134func (c Config) PrimaryBuilderInvocations() []bootstrap.PrimaryBuilderInvocation {
135 return []bootstrap.PrimaryBuilderInvocation{}
136}
137
Paul Duffin74135582022-10-06 11:01:59 +0100138// RunningInsideUnitTest returns true if this code is being run as part of a Soong unit test.
139func (c Config) RunningInsideUnitTest() bool {
140 return c.config.TestProductVariables != nil
141}
142
Jingwen Chenc711fec2020-11-22 23:52:50 -0500143// A DeviceConfig object represents the configuration for a particular device
144// being built. For now there will only be one of these, but in the future there
145// may be multiple devices being built.
Colin Cross9272ade2016-08-17 15:24:12 -0700146type DeviceConfig struct {
147 *deviceConfig
148}
149
Jingwen Chenc711fec2020-11-22 23:52:50 -0500150// VendorConfig represents the configuration for vendor-specific behavior.
Colin Cross9d34f352019-11-22 16:03:51 -0800151type VendorConfig soongconfig.SoongConfig
Dan Willemsen0fe78662018-03-26 12:41:18 -0700152
Jingwen Chenc711fec2020-11-22 23:52:50 -0500153// Definition of general build configuration for soong_build. Some of these
Jingwen Chenc4d91bc2020-11-24 22:59:26 -0500154// product configuration values are read from Kati-generated soong.variables.
Colin Cross1332b002015-04-07 17:11:30 -0700155type config struct {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500156 // Options configurable with soong.variables
Dan Willemsen45133ac2018-03-09 21:22:06 -0800157 productVariables productVariables
Colin Cross3f40fa42015-01-30 17:27:36 -0800158
Dan Willemsen674dc7f2018-03-12 18:06:05 -0700159 // Only available on configs created by TestConfig
160 TestProductVariables *productVariables
161
Jingwen Chenc711fec2020-11-22 23:52:50 -0500162 // A specialized context object for Bazel/Soong mixed builds and migration
163 // purposes.
Chris Parsonsf3c96ef2020-09-29 02:23:17 -0400164 BazelContext BazelContext
165
Dan Willemsen87b17d12015-07-14 00:39:06 -0700166 ProductVariablesFileName string
167
Colin Cross0c66bc62021-07-20 09:47:41 -0700168 // BuildOS stores the OsType for the OS that the build is running on.
169 BuildOS OsType
170
171 // BuildArch stores the ArchType for the CPU that the build is running on.
172 BuildArch ArchType
173
Jaewoong Jung642916f2020-10-09 17:25:15 -0700174 Targets map[OsType][]Target
175 BuildOSTarget Target // the Target for tools run on the build machine
176 BuildOSCommonTarget Target // the Target for common (java) tools run on the build machine
177 AndroidCommonTarget Target // the Target for common modules for the Android device
178 AndroidFirstDeviceTarget Target // the first Target for modules for the Android device
Dan Willemsen218f6562015-07-08 18:13:11 -0700179
Jingwen Chenc711fec2020-11-22 23:52:50 -0500180 // multilibConflicts for an ArchType is true if there is earlier configured
181 // device architecture with the same multilib value.
Colin Cross3b19f5d2019-09-17 14:45:31 -0700182 multilibConflicts map[ArchType]bool
183
Colin Cross9272ade2016-08-17 15:24:12 -0700184 deviceConfig *deviceConfig
185
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200186 outDir string // The output directory (usually out/)
187 soongOutDir string
Chris Parsons8f232a22020-06-23 17:37:05 -0400188 moduleListFile string // the path to the file which lists blueprint files to parse.
Colin Crossc1e86a32015-04-15 12:33:28 -0700189
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +0200190 runGoTests bool
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200191
Colin Cross6ccbc912017-10-10 23:07:38 -0700192 env map[string]string
Dan Willemsene7680ba2015-09-11 17:06:19 -0700193 envLock sync.Mutex
194 envDeps map[string]string
195 envFrozen bool
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800196
Jingwen Chencda22c92020-11-23 00:22:30 -0500197 // Changes behavior based on whether Kati runs after soong_build, or if soong_build
198 // runs standalone.
199 katiEnabled bool
Colin Cross1e7d3702016-08-24 15:25:47 -0700200
Colin Cross32616ed2017-09-05 21:56:44 -0700201 captureBuild bool // true for tests, saves build parameters for each module
202 ignoreEnvironment bool // true for tests, returns empty from all Getenv calls
Colin Crosscec81712017-07-13 14:43:27 -0700203
Colin Cross98be1bb2019-12-13 20:41:13 -0800204 fs pathtools.FileSystem
205 mockBpList string
206
Chris Parsonsad876012022-08-20 14:48:32 -0400207 BuildMode SoongBuildMode
Cole Faust324a92e2022-08-23 15:29:05 -0700208 Bp2buildPackageConfig Bp2BuildConversionAllowlist
Jingwen Chen01812022021-11-19 14:29:43 +0000209 Bp2buildSoongConfigDefinitions soongconfig.Bp2BuildSoongConfigDefinitions
Jingwen Chen12b4c272021-03-10 02:05:59 -0500210
Colin Cross5e6a7972020-06-07 16:56:32 -0700211 // If testAllowNonExistentPaths is true then PathForSource and PathForModuleSrc won't error
212 // in tests when a path doesn't exist.
Pedro Loureiro5d190cc2021-02-15 15:41:33 +0000213 TestAllowNonExistentPaths bool
Colin Cross5e6a7972020-06-07 16:56:32 -0700214
Jingwen Chenc711fec2020-11-22 23:52:50 -0500215 // The list of files that when changed, must invalidate soong_build to
216 // regenerate build.ninja.
Colin Cross12129292020-10-29 18:23:58 -0700217 ninjaFileDepsSet sync.Map
218
Colin Cross9272ade2016-08-17 15:24:12 -0700219 OncePer
MarkDacekff851b82022-04-21 18:33:17 +0000220
Chris Parsonsad876012022-08-20 14:48:32 -0400221 // These fields are only used for metrics collection. A module should be added
222 // to these maps only if its implementation supports Bazel handling in mixed
223 // builds. A module being in the "enabled" list indicates that there is a
224 // variant of that module for which bazel-handling actually took place.
225 // A module being in the "disabled" list indicates that there is a variant of
226 // that module for which bazel-handling was denied.
MarkDacekff851b82022-04-21 18:33:17 +0000227 mixedBuildsLock sync.Mutex
228 mixedBuildEnabledModules map[string]struct{}
229 mixedBuildDisabledModules map[string]struct{}
Colin Cross9272ade2016-08-17 15:24:12 -0700230}
231
232type deviceConfig struct {
Dan Willemsen00269f22017-07-06 16:59:48 -0700233 config *config
Colin Cross9272ade2016-08-17 15:24:12 -0700234 OncePer
Colin Cross3f40fa42015-01-30 17:27:36 -0800235}
236
Colin Cross485e5722015-08-27 13:28:01 -0700237type jsonConfigurable interface {
Colin Cross27385972015-09-18 10:57:10 -0700238 SetDefaultConfig()
Colin Cross485e5722015-08-27 13:28:01 -0700239}
Colin Cross3f40fa42015-01-30 17:27:36 -0800240
Colin Cross485e5722015-08-27 13:28:01 -0700241func loadConfig(config *config) error {
Colin Cross988414c2020-01-11 01:11:46 +0000242 return loadFromConfigFile(&config.productVariables, absolutePath(config.ProductVariablesFileName))
Colin Cross485e5722015-08-27 13:28:01 -0700243}
244
Jingwen Chenc711fec2020-11-22 23:52:50 -0500245// loadFromConfigFile loads and decodes configuration options from a JSON file
246// in the current working directory.
Liz Kammer09f947d2021-05-12 14:51:49 -0400247func loadFromConfigFile(configurable *productVariables, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800248 // Try to open the file
Colin Cross485e5722015-08-27 13:28:01 -0700249 configFileReader, err := os.Open(filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800250 defer configFileReader.Close()
251 if os.IsNotExist(err) {
252 // Need to create a file, so that blueprint & ninja don't get in
253 // a dependency tracking loop.
254 // Make a file-configurable-options with defaults, write it out using
255 // a json writer.
Colin Cross27385972015-09-18 10:57:10 -0700256 configurable.SetDefaultConfig()
257 err = saveToConfigFile(configurable, filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800258 if err != nil {
259 return err
260 }
Colin Cross15cd21a2018-02-27 11:26:02 -0800261 } else if err != nil {
262 return fmt.Errorf("config file: could not open %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800263 } else {
264 // Make a decoder for it
265 jsonDecoder := json.NewDecoder(configFileReader)
Colin Cross485e5722015-08-27 13:28:01 -0700266 err = jsonDecoder.Decode(configurable)
Colin Cross3f40fa42015-01-30 17:27:36 -0800267 if err != nil {
Colin Cross15cd21a2018-02-27 11:26:02 -0800268 return fmt.Errorf("config file: %s did not parse correctly: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800269 }
270 }
271
Liz Kammer09f947d2021-05-12 14:51:49 -0400272 if Bool(configurable.GcovCoverage) && Bool(configurable.ClangCoverage) {
273 return fmt.Errorf("GcovCoverage and ClangCoverage cannot both be set")
274 }
275
276 configurable.Native_coverage = proptools.BoolPtr(
277 Bool(configurable.GcovCoverage) ||
278 Bool(configurable.ClangCoverage))
279
Yuntao Xu402e9b02021-08-09 15:44:44 -0700280 // when Platform_sdk_final is true (or PLATFORM_VERSION_CODENAME is REL), use Platform_sdk_version;
281 // if false (pre-released version, for example), use Platform_sdk_codename.
282 if Bool(configurable.Platform_sdk_final) {
283 if configurable.Platform_sdk_version != nil {
284 configurable.Platform_sdk_version_or_codename =
285 proptools.StringPtr(strconv.Itoa(*(configurable.Platform_sdk_version)))
286 } else {
287 return fmt.Errorf("Platform_sdk_version cannot be pointed by a NULL pointer")
288 }
289 } else {
290 configurable.Platform_sdk_version_or_codename =
291 proptools.StringPtr(String(configurable.Platform_sdk_codename))
292 }
293
Liz Kammer09f947d2021-05-12 14:51:49 -0400294 return saveToBazelConfigFile(configurable, filepath.Dir(filename))
Colin Cross3f40fa42015-01-30 17:27:36 -0800295}
296
Colin Crossd8f20142016-11-03 09:43:26 -0700297// atomically writes the config file in case two copies of soong_build are running simultaneously
298// (for example, docs generation and ninja manifest generation)
Liz Kammer09f947d2021-05-12 14:51:49 -0400299func saveToConfigFile(config *productVariables, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800300 data, err := json.MarshalIndent(&config, "", " ")
301 if err != nil {
302 return fmt.Errorf("cannot marshal config data: %s", err.Error())
303 }
304
Colin Crossd8f20142016-11-03 09:43:26 -0700305 f, err := ioutil.TempFile(filepath.Dir(filename), "config")
Colin Cross3f40fa42015-01-30 17:27:36 -0800306 if err != nil {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500307 return fmt.Errorf("cannot create empty config file %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800308 }
Colin Crossd8f20142016-11-03 09:43:26 -0700309 defer os.Remove(f.Name())
310 defer f.Close()
Colin Cross3f40fa42015-01-30 17:27:36 -0800311
Colin Crossd8f20142016-11-03 09:43:26 -0700312 _, err = f.Write(data)
Colin Cross3f40fa42015-01-30 17:27:36 -0800313 if err != nil {
Colin Cross485e5722015-08-27 13:28:01 -0700314 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
315 }
316
Colin Crossd8f20142016-11-03 09:43:26 -0700317 _, err = f.WriteString("\n")
Colin Cross485e5722015-08-27 13:28:01 -0700318 if err != nil {
319 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800320 }
321
Colin Crossd8f20142016-11-03 09:43:26 -0700322 f.Close()
323 os.Rename(f.Name(), filename)
324
Colin Cross3f40fa42015-01-30 17:27:36 -0800325 return nil
326}
327
Liz Kammer09f947d2021-05-12 14:51:49 -0400328func saveToBazelConfigFile(config *productVariables, outDir string) error {
329 dir := filepath.Join(outDir, bazel.SoongInjectionDirName, "product_config")
330 err := createDirIfNonexistent(dir, os.ModePerm)
331 if err != nil {
332 return fmt.Errorf("Could not create dir %s: %s", dir, err)
333 }
334
Sam Delmerico5c32bbf2022-01-20 20:15:02 +0000335 nonArchVariantProductVariables := []string{}
336 archVariantProductVariables := []string{}
337 p := variableProperties{}
338 t := reflect.TypeOf(p.Product_variables)
339 for i := 0; i < t.NumField(); i++ {
340 f := t.Field(i)
341 nonArchVariantProductVariables = append(nonArchVariantProductVariables, strings.ToLower(f.Name))
342 if proptools.HasTag(f, "android", "arch_variant") {
343 archVariantProductVariables = append(archVariantProductVariables, strings.ToLower(f.Name))
344 }
345 }
346
Liz Kammer72beb342022-02-03 08:42:10 -0500347 nonArchVariantProductVariablesJson := starlark_fmt.PrintStringList(nonArchVariantProductVariables, 0)
Sam Delmerico5c32bbf2022-01-20 20:15:02 +0000348 if err != nil {
349 return fmt.Errorf("cannot marshal product variable data: %s", err.Error())
350 }
351
Liz Kammer72beb342022-02-03 08:42:10 -0500352 archVariantProductVariablesJson := starlark_fmt.PrintStringList(archVariantProductVariables, 0)
Sam Delmerico5c32bbf2022-01-20 20:15:02 +0000353 if err != nil {
354 return fmt.Errorf("cannot marshal arch variant product variable data: %s", err.Error())
355 }
356
357 configJson, err := json.MarshalIndent(&config, "", " ")
Liz Kammer09f947d2021-05-12 14:51:49 -0400358 if err != nil {
359 return fmt.Errorf("cannot marshal config data: %s", err.Error())
360 }
Cole Faust082c5f32022-08-04 15:49:20 -0700361 // The backslashes need to be escaped because this text is going to be put
362 // inside a Starlark string literal.
363 configJson = bytes.ReplaceAll(configJson, []byte("\\"), []byte("\\\\"))
Liz Kammer09f947d2021-05-12 14:51:49 -0400364
365 bzl := []string{
366 bazel.GeneratedBazelFileWarning,
Sam Delmerico5c32bbf2022-01-20 20:15:02 +0000367 fmt.Sprintf(`_product_vars = json.decode("""%s""")`, configJson),
368 fmt.Sprintf(`_product_var_constraints = %s`, nonArchVariantProductVariablesJson),
369 fmt.Sprintf(`_arch_variant_product_var_constraints = %s`, archVariantProductVariablesJson),
370 "\n", `
371product_vars = _product_vars
372product_var_constraints = _product_var_constraints
373arch_variant_product_var_constraints = _arch_variant_product_var_constraints
374`,
Liz Kammer09f947d2021-05-12 14:51:49 -0400375 }
Cole Faust082c5f32022-08-04 15:49:20 -0700376 err = os.WriteFile(filepath.Join(dir, "product_variables.bzl"), []byte(strings.Join(bzl, "\n")), 0644)
Liz Kammer09f947d2021-05-12 14:51:49 -0400377 if err != nil {
378 return fmt.Errorf("Could not write .bzl config file %s", err)
379 }
Cole Faust082c5f32022-08-04 15:49:20 -0700380 err = os.WriteFile(filepath.Join(dir, "BUILD"), []byte(bazel.GeneratedBazelFileWarning), 0644)
Liz Kammer09f947d2021-05-12 14:51:49 -0400381 if err != nil {
382 return fmt.Errorf("Could not write BUILD config file %s", err)
383 }
384
385 return nil
386}
387
Colin Cross988414c2020-01-11 01:11:46 +0000388// NullConfig returns a mostly empty Config for use by standalone tools like dexpreopt_gen that
389// use the android package.
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200390func NullConfig(outDir, soongOutDir string) Config {
Colin Cross988414c2020-01-11 01:11:46 +0000391 return Config{
392 config: &config{
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200393 outDir: outDir,
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200394 soongOutDir: soongOutDir,
395 fs: pathtools.OsFs,
Colin Cross988414c2020-01-11 01:11:46 +0000396 },
397 }
398}
399
Jingwen Chenc711fec2020-11-22 23:52:50 -0500400// NewConfig creates a new Config object. The srcDir argument specifies the path
401// to the root source directory. It also loads the config file, if found.
Chris Parsonsad876012022-08-20 14:48:32 -0400402func NewConfig(moduleListFile string, buildMode SoongBuildMode, runGoTests bool, outDir, soongOutDir string, availableEnv map[string]string) (Config, error) {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500403 // Make a config with default options.
Colin Cross9272ade2016-08-17 15:24:12 -0700404 config := &config{
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200405 ProductVariablesFileName: filepath.Join(soongOutDir, productVariablesFileName),
Dan Willemsen87b17d12015-07-14 00:39:06 -0700406
Lukacs T. Berki53b2f362021-04-12 14:04:24 +0200407 env: availableEnv,
Colin Cross6ccbc912017-10-10 23:07:38 -0700408
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +0200409 outDir: outDir,
410 soongOutDir: soongOutDir,
411 runGoTests: runGoTests,
412 multilibConflicts: make(map[ArchType]bool),
Colin Cross98be1bb2019-12-13 20:41:13 -0800413
MarkDacekff851b82022-04-21 18:33:17 +0000414 moduleListFile: moduleListFile,
415 fs: pathtools.NewOsFs(absSrcDir),
416 mixedBuildDisabledModules: make(map[string]struct{}),
417 mixedBuildEnabledModules: make(map[string]struct{}),
Colin Cross68f55102015-03-25 14:43:57 -0700418 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800419
Dan Willemsen00269f22017-07-06 16:59:48 -0700420 config.deviceConfig = &deviceConfig{
Colin Cross9272ade2016-08-17 15:24:12 -0700421 config: config,
422 }
423
Liz Kammer7941b302020-07-28 13:27:34 -0700424 // Soundness check of the build and source directories. This won't catch strange
425 // configurations with symlinks, but at least checks the obvious case.
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200426 absBuildDir, err := filepath.Abs(soongOutDir)
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700427 if err != nil {
428 return Config{}, err
429 }
430
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200431 absSrcDir, err := filepath.Abs(".")
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700432 if err != nil {
433 return Config{}, err
434 }
435
436 if strings.HasPrefix(absSrcDir, absBuildDir) {
437 return Config{}, fmt.Errorf("Build dir must not contain source directory")
438 }
439
Colin Cross3f40fa42015-01-30 17:27:36 -0800440 // Load any configurable options from the configuration file
Colin Cross9272ade2016-08-17 15:24:12 -0700441 err = loadConfig(config)
Colin Cross3f40fa42015-01-30 17:27:36 -0800442 if err != nil {
Colin Crossc3c0a492015-04-10 15:43:55 -0700443 return Config{}, err
Colin Cross3f40fa42015-01-30 17:27:36 -0800444 }
445
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200446 KatiEnabledMarkerFile := filepath.Join(soongOutDir, ".soong.kati_enabled")
Jingwen Chencda22c92020-11-23 00:22:30 -0500447 if _, err := os.Stat(absolutePath(KatiEnabledMarkerFile)); err == nil {
448 config.katiEnabled = true
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800449 }
450
Colin Cross0c66bc62021-07-20 09:47:41 -0700451 determineBuildOS(config)
452
Jingwen Chenc711fec2020-11-22 23:52:50 -0500453 // Sets up the map of target OSes to the finer grained compilation targets
454 // that are configured from the product variables.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700455 targets, err := decodeTargetProductVariables(config)
Dan Willemsen218f6562015-07-08 18:13:11 -0700456 if err != nil {
457 return Config{}, err
458 }
459
Paul Duffin1356d8c2020-02-25 19:26:33 +0000460 // Make the CommonOS OsType available for all products.
461 targets[CommonOS] = []Target{commonTargetMap[CommonOS.Name]}
462
Dan Albert4098deb2016-10-19 14:04:41 -0700463 var archConfig []archConfig
Jingwen Chenc4d91bc2020-11-24 22:59:26 -0500464 if config.NdkAbis() {
Dan Albert4098deb2016-10-19 14:04:41 -0700465 archConfig = getNdkAbisConfig()
Martin Stjernholmc1ecc432019-11-15 15:00:31 +0000466 } else if config.AmlAbis() {
467 archConfig = getAmlAbisConfig()
Dan Albert4098deb2016-10-19 14:04:41 -0700468 }
469
470 if archConfig != nil {
Liz Kammerb7f33662022-02-28 14:16:16 -0500471 androidTargets, err := decodeAndroidArchSettings(archConfig)
Dan Willemsen322acaf2016-01-12 23:07:05 -0800472 if err != nil {
473 return Config{}, err
474 }
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700475 targets[Android] = androidTargets
Dan Willemsen322acaf2016-01-12 23:07:05 -0800476 }
477
Colin Cross3b19f5d2019-09-17 14:45:31 -0700478 multilib := make(map[string]bool)
479 for _, target := range targets[Android] {
480 if seen := multilib[target.Arch.ArchType.Multilib]; seen {
481 config.multilibConflicts[target.Arch.ArchType] = true
482 }
483 multilib[target.Arch.ArchType.Multilib] = true
484 }
485
Jingwen Chenc711fec2020-11-22 23:52:50 -0500486 // Map of OS to compilation targets.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700487 config.Targets = targets
Jingwen Chenc711fec2020-11-22 23:52:50 -0500488
489 // Compilation targets for host tools.
Colin Cross0c66bc62021-07-20 09:47:41 -0700490 config.BuildOSTarget = config.Targets[config.BuildOS][0]
491 config.BuildOSCommonTarget = getCommonTargets(config.Targets[config.BuildOS])[0]
Jingwen Chenc711fec2020-11-22 23:52:50 -0500492
493 // Compilation targets for Android.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700494 if len(config.Targets[Android]) > 0 {
495 config.AndroidCommonTarget = getCommonTargets(config.Targets[Android])[0]
Sam Delmericocc271e22022-06-01 15:45:02 +0000496 config.AndroidFirstDeviceTarget = FirstTarget(config.Targets[Android], "lib64", "lib32")[0]
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700497 }
Dan Willemsen218f6562015-07-08 18:13:11 -0700498
Chris Parsonsad876012022-08-20 14:48:32 -0400499 config.BuildMode = buildMode
Chris Parsonsf3c96ef2020-09-29 02:23:17 -0400500 config.BazelContext, err = NewBazelContext(config)
Cole Faust324a92e2022-08-23 15:29:05 -0700501 config.Bp2buildPackageConfig = GetBp2BuildAllowList()
Colin Cross3f40fa42015-01-30 17:27:36 -0800502
Jingwen Chenc711fec2020-11-22 23:52:50 -0500503 return Config{config}, err
504}
Colin Cross988414c2020-01-11 01:11:46 +0000505
Colin Cross98be1bb2019-12-13 20:41:13 -0800506// mockFileSystem replaces all reads with accesses to the provided map of
507// filenames to contents stored as a byte slice.
508func (c *config) mockFileSystem(bp string, fs map[string][]byte) {
509 mockFS := map[string][]byte{}
510
511 if _, exists := mockFS["Android.bp"]; !exists {
512 mockFS["Android.bp"] = []byte(bp)
513 }
514
515 for k, v := range fs {
516 mockFS[k] = v
517 }
518
519 // no module list file specified; find every file named Blueprints or Android.bp
520 pathsToParse := []string{}
521 for candidate := range mockFS {
522 base := filepath.Base(candidate)
Lukacs T. Berkib838b0a2021-09-02 11:46:24 +0200523 if base == "Android.bp" {
Colin Cross98be1bb2019-12-13 20:41:13 -0800524 pathsToParse = append(pathsToParse, candidate)
525 }
526 }
527 if len(pathsToParse) < 1 {
528 panic(fmt.Sprintf("No Blueprint or Android.bp files found in mock filesystem: %v\n", mockFS))
529 }
530 mockFS[blueprint.MockModuleListFile] = []byte(strings.Join(pathsToParse, "\n"))
531
532 c.fs = pathtools.MockFs(mockFS)
533 c.mockBpList = blueprint.MockModuleListFile
534}
535
Chris Parsonsad876012022-08-20 14:48:32 -0400536// Returns true if "Bazel builds" is enabled. In this mode, part of build
537// analysis is handled by Bazel.
538func (c *config) IsMixedBuildsEnabled() bool {
Chris Parsons428c30f2022-11-29 14:14:52 -0500539 globalMixedBuildsSupport := c.Once(OnceKey{"globalMixedBuildsSupport"}, func() interface{} {
540 if c.productVariables.DeviceArch != nil && *c.productVariables.DeviceArch == "riscv64" {
541 fmt.Fprintln(os.Stderr, "unsupported device arch 'riscv64' for Bazel: falling back to non-mixed build")
542 return false
543 }
Sam Delmerico5150d0d2022-11-15 17:44:44 -0500544 if c.IsEnvTrue("GLOBAL_THINLTO") {
545 fmt.Fprintln(os.Stderr, "unsupported env var GLOBAL_THINLTO for Bazel: falling back to non-mixed build")
546 return false
547 }
548 if c.IsEnvTrue("CLANG_COVERAGE") {
549 fmt.Fprintln(os.Stderr, "unsupported env var CLANG_COVERAGE for Bazel: falling back to non-mixed build")
550 return false
551 }
552 if len(c.productVariables.SanitizeHost) > 0 {
553 fmt.Fprintln(os.Stderr, "unsupported product var SanitizeHost for Bazel: falling back to non-mixed build")
554 return false
555 }
556 if len(c.productVariables.SanitizeDevice) > 0 {
557 fmt.Fprintln(os.Stderr, "unsupported product var SanitizeDevice for Bazel: falling back to non-mixed build")
558 return false
559 }
560 if len(c.productVariables.SanitizeDeviceDiag) > 0 {
561 fmt.Fprintln(os.Stderr, "unsupported product var SanitizeDeviceDiag for Bazel: falling back to non-mixed build")
562 return false
563 }
564 if len(c.productVariables.SanitizeDeviceArch) > 0 {
565 fmt.Fprintln(os.Stderr, "unsupported product var SanitizeDeviceArch for Bazel: falling back to non-mixed build")
566 return false
567 }
Chris Parsons428c30f2022-11-29 14:14:52 -0500568 return true
569 }).(bool)
570
571 bazelModeEnabled := c.BuildMode == BazelProdMode || c.BuildMode == BazelDevMode || c.BuildMode == BazelStagingMode
572 return globalMixedBuildsSupport && bazelModeEnabled
Chris Parsonsad876012022-08-20 14:48:32 -0400573}
574
Lukacs T. Berkid1e3f1f2021-03-16 08:55:23 +0100575func (c *config) SetAllowMissingDependencies() {
576 c.productVariables.Allow_missing_dependencies = proptools.BoolPtr(true)
577}
578
Jingwen Chenc711fec2020-11-22 23:52:50 -0500579// BlueprintToolLocation returns the directory containing build system tools
580// from Blueprint, like soong_zip and merge_zips.
Lukacs T. Berkia806e412021-09-01 08:57:48 +0200581func (c *config) HostToolDir() string {
Colin Crossacfcc1f2021-10-25 15:40:32 -0700582 if c.KatiEnabled() {
583 return filepath.Join(c.outDir, "host", c.PrebuiltOS(), "bin")
584 } else {
585 return filepath.Join(c.soongOutDir, "host", c.PrebuiltOS(), "bin")
586 }
Dan Willemsenc2aa4a92016-05-26 15:13:03 -0700587}
588
Dan Willemsen60e62f02018-11-16 21:05:32 -0800589func (c *config) HostToolPath(ctx PathContext, tool string) Path {
Colin Cross790ef352021-10-25 19:15:55 -0700590 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "bin", false, tool)
591 return path
Dan Willemsen60e62f02018-11-16 21:05:32 -0800592}
593
Colin Cross790ef352021-10-25 19:15:55 -0700594func (c *config) HostJNIToolPath(ctx PathContext, lib string) Path {
Martin Stjernholm7260d062019-12-09 21:47:14 +0000595 ext := ".so"
596 if runtime.GOOS == "darwin" {
597 ext = ".dylib"
598 }
Colin Cross790ef352021-10-25 19:15:55 -0700599 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "lib64", false, lib+ext)
600 return path
Martin Stjernholm7260d062019-12-09 21:47:14 +0000601}
602
Colin Crossae5330a2021-11-03 13:31:22 -0700603func (c *config) HostJavaToolPath(ctx PathContext, tool string) Path {
604 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "framework", false, tool)
Colin Cross3e3eda62021-11-04 10:22:51 -0700605 return path
606}
607
Jingwen Chenc711fec2020-11-22 23:52:50 -0500608// PrebuiltOS returns the name of the host OS used in prebuilts directories.
Colin Cross1332b002015-04-07 17:11:30 -0700609func (c *config) PrebuiltOS() string {
Colin Cross3f40fa42015-01-30 17:27:36 -0800610 switch runtime.GOOS {
611 case "linux":
612 return "linux-x86"
613 case "darwin":
614 return "darwin-x86"
615 default:
616 panic("Unknown GOOS")
617 }
618}
619
620// GoRoot returns the path to the root directory of the Go toolchain.
Colin Cross1332b002015-04-07 17:11:30 -0700621func (c *config) GoRoot() string {
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200622 return fmt.Sprintf("prebuilts/go/%s", c.PrebuiltOS())
Colin Cross3f40fa42015-01-30 17:27:36 -0800623}
624
Jingwen Chenc711fec2020-11-22 23:52:50 -0500625// PrebuiltBuildTool returns the path to a tool in the prebuilts directory containing
626// checked-in tools, like Kati, Ninja or Toybox, for the current host OS.
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700627func (c *config) PrebuiltBuildTool(ctx PathContext, tool string) Path {
628 return PathForSource(ctx, "prebuilts/build-tools", c.PrebuiltOS(), "bin", tool)
629}
630
Jingwen Chenc711fec2020-11-22 23:52:50 -0500631// CpPreserveSymlinksFlags returns the host-specific flag for the cp(1) command
632// to preserve symlinks.
Colin Cross1332b002015-04-07 17:11:30 -0700633func (c *config) CpPreserveSymlinksFlags() string {
Colin Cross485e5722015-08-27 13:28:01 -0700634 switch runtime.GOOS {
Colin Cross3f40fa42015-01-30 17:27:36 -0800635 case "darwin":
636 return "-R"
637 case "linux":
638 return "-d"
639 default:
640 return ""
641 }
642}
Colin Cross68f55102015-03-25 14:43:57 -0700643
Colin Cross1332b002015-04-07 17:11:30 -0700644func (c *config) Getenv(key string) string {
Colin Cross68f55102015-03-25 14:43:57 -0700645 var val string
646 var exists bool
Colin Crossc1e86a32015-04-15 12:33:28 -0700647 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800648 defer c.envLock.Unlock()
649 if c.envDeps == nil {
650 c.envDeps = make(map[string]string)
651 }
Colin Cross68f55102015-03-25 14:43:57 -0700652 if val, exists = c.envDeps[key]; !exists {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700653 if c.envFrozen {
654 panic("Cannot access new environment variables after envdeps are frozen")
655 }
Colin Cross6ccbc912017-10-10 23:07:38 -0700656 val, _ = c.env[key]
Colin Cross68f55102015-03-25 14:43:57 -0700657 c.envDeps[key] = val
658 }
659 return val
660}
661
Colin Cross99d7c232016-11-23 16:52:04 -0800662func (c *config) GetenvWithDefault(key string, defaultValue string) string {
663 ret := c.Getenv(key)
664 if ret == "" {
665 return defaultValue
666 }
667 return ret
668}
669
670func (c *config) IsEnvTrue(key string) bool {
671 value := c.Getenv(key)
672 return value == "1" || value == "y" || value == "yes" || value == "on" || value == "true"
673}
674
675func (c *config) IsEnvFalse(key string) bool {
676 value := c.Getenv(key)
677 return value == "0" || value == "n" || value == "no" || value == "off" || value == "false"
678}
679
Sorin Bascace720c32022-05-24 12:13:50 +0100680func (c *config) TargetsJava17() bool {
681 return c.IsEnvTrue("EXPERIMENTAL_TARGET_JAVA_VERSION_17")
682}
683
Jingwen Chenc711fec2020-11-22 23:52:50 -0500684// EnvDeps returns the environment variables this build depends on. The first
685// call to this function blocks future reads from the environment.
Colin Cross1332b002015-04-07 17:11:30 -0700686func (c *config) EnvDeps() map[string]string {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700687 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800688 defer c.envLock.Unlock()
Dan Willemsene7680ba2015-09-11 17:06:19 -0700689 c.envFrozen = true
Colin Cross68f55102015-03-25 14:43:57 -0700690 return c.envDeps
691}
Colin Cross35cec122015-04-02 14:37:16 -0700692
Jingwen Chencda22c92020-11-23 00:22:30 -0500693func (c *config) KatiEnabled() bool {
694 return c.katiEnabled
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800695}
696
Nan Zhang581fd212018-01-10 16:06:12 -0800697func (c *config) BuildId() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800698 return String(c.productVariables.BuildId)
Nan Zhang581fd212018-01-10 16:06:12 -0800699}
700
Jingwen Chenc711fec2020-11-22 23:52:50 -0500701// BuildNumberFile returns the path to a text file containing metadata
702// representing the current build's number.
703//
704// Rules that want to reference the build number should read from this file
705// without depending on it. They will run whenever their other dependencies
706// require them to run and get the current build number. This ensures they don't
707// rebuild on every incremental build when the build number changes.
Colin Cross2a2e0db2020-02-21 16:55:46 -0800708func (c *config) BuildNumberFile(ctx PathContext) Path {
709 return PathForOutput(ctx, String(c.productVariables.BuildNumberFile))
Nan Zhang581fd212018-01-10 16:06:12 -0800710}
711
Jingwen Chenc711fec2020-11-22 23:52:50 -0500712// DeviceName returns the name of the current device target.
Colin Cross35cec122015-04-02 14:37:16 -0700713// TODO: take an AndroidModuleContext to select the device name for multi-device builds
Colin Cross1332b002015-04-07 17:11:30 -0700714func (c *config) DeviceName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800715 return *c.productVariables.DeviceName
Colin Cross35cec122015-04-02 14:37:16 -0700716}
717
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000718// DeviceProduct returns the current product target. There could be multiple of
719// these per device type.
720//
Chris Parsonsef615e52022-08-18 22:04:11 -0400721// NOTE: Do not base conditional logic on this value. It may break product inheritance.
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000722func (c *config) DeviceProduct() string {
723 return *c.productVariables.DeviceProduct
724}
725
Anton Hansson53c88442019-03-18 15:53:16 +0000726func (c *config) DeviceResourceOverlays() []string {
727 return c.productVariables.DeviceResourceOverlays
728}
729
730func (c *config) ProductResourceOverlays() []string {
731 return c.productVariables.ProductResourceOverlays
Colin Cross30e076a2015-04-13 13:58:27 -0700732}
733
Colin Crossbfd347d2018-05-09 11:11:35 -0700734func (c *config) PlatformVersionName() string {
735 return String(c.productVariables.Platform_version_name)
736}
737
Dan Albert4f378d72020-07-23 17:32:15 -0700738func (c *config) PlatformSdkVersion() ApiLevel {
739 return uncheckedFinalApiLevel(*c.productVariables.Platform_sdk_version)
Colin Cross30e076a2015-04-13 13:58:27 -0700740}
741
Mu-Le Lee5e047532022-07-27 02:32:03 +0000742func (c *config) PlatformSdkFinal() bool {
743 return Bool(c.productVariables.Platform_sdk_final)
744}
745
Colin Crossd09b0b62018-04-18 11:06:47 -0700746func (c *config) PlatformSdkCodename() string {
747 return String(c.productVariables.Platform_sdk_codename)
748}
749
Anton Hansson97d0bae2022-02-16 16:15:10 +0000750func (c *config) PlatformSdkExtensionVersion() int {
751 return *c.productVariables.Platform_sdk_extension_version
752}
753
754func (c *config) PlatformBaseSdkExtensionVersion() int {
755 return *c.productVariables.Platform_base_sdk_extension_version
756}
757
Colin Cross092c9da2019-04-02 22:56:43 -0700758func (c *config) PlatformSecurityPatch() string {
759 return String(c.productVariables.Platform_security_patch)
760}
761
762func (c *config) PlatformPreviewSdkVersion() string {
763 return String(c.productVariables.Platform_preview_sdk_version)
764}
765
766func (c *config) PlatformMinSupportedTargetSdkVersion() string {
767 return String(c.productVariables.Platform_min_supported_target_sdk_version)
768}
769
770func (c *config) PlatformBaseOS() string {
771 return String(c.productVariables.Platform_base_os)
772}
773
Inseob Kim4f1f3d92022-04-25 18:23:58 +0900774func (c *config) PlatformVersionLastStable() string {
775 return String(c.productVariables.Platform_version_last_stable)
776}
777
Jiyong Park37073842022-06-21 10:13:42 +0900778func (c *config) PlatformVersionKnownCodenames() string {
779 return String(c.productVariables.Platform_version_known_codenames)
780}
781
Dan Albert1a246272020-07-06 14:49:35 -0700782func (c *config) MinSupportedSdkVersion() ApiLevel {
Dan Albert6bfb6bb2022-08-17 20:11:57 +0000783 return uncheckedFinalApiLevel(21)
Dan Albert1a246272020-07-06 14:49:35 -0700784}
785
786func (c *config) FinalApiLevels() []ApiLevel {
787 var levels []ApiLevel
Dan Albert4f378d72020-07-23 17:32:15 -0700788 for i := 1; i <= c.PlatformSdkVersion().FinalOrFutureInt(); i++ {
Dan Albert1a246272020-07-06 14:49:35 -0700789 levels = append(levels, uncheckedFinalApiLevel(i))
790 }
791 return levels
792}
793
794func (c *config) PreviewApiLevels() []ApiLevel {
795 var levels []ApiLevel
796 for i, codename := range c.PlatformVersionActiveCodenames() {
797 levels = append(levels, ApiLevel{
798 value: codename,
799 number: i,
800 isPreview: true,
801 })
802 }
803 return levels
804}
805
satayevcca4ab72021-11-30 12:33:55 +0000806func (c *config) LatestPreviewApiLevel() ApiLevel {
807 level := NoneApiLevel
808 for _, l := range c.PreviewApiLevels() {
809 if l.GreaterThan(level) {
810 level = l
811 }
812 }
813 return level
814}
815
Dan Albert1a246272020-07-06 14:49:35 -0700816func (c *config) AllSupportedApiLevels() []ApiLevel {
817 var levels []ApiLevel
818 levels = append(levels, c.FinalApiLevels()...)
819 return append(levels, c.PreviewApiLevels()...)
Dan Albertf5415d72017-08-17 16:19:59 -0700820}
821
Jingwen Chenc711fec2020-11-22 23:52:50 -0500822// DefaultAppTargetSdk returns the API level that platform apps are targeting.
823// This converts a codename to the exact ApiLevel it represents.
Dan Albert4f378d72020-07-23 17:32:15 -0700824func (c *config) DefaultAppTargetSdk(ctx EarlyModuleContext) ApiLevel {
Colin Crossd09b0b62018-04-18 11:06:47 -0700825 if Bool(c.productVariables.Platform_sdk_final) {
826 return c.PlatformSdkVersion()
Colin Crossd09b0b62018-04-18 11:06:47 -0700827 }
Jingwen Chenc711fec2020-11-22 23:52:50 -0500828 codename := c.PlatformSdkCodename()
829 if codename == "" {
830 return NoneApiLevel
831 }
832 if codename == "REL" {
833 panic("Platform_sdk_codename should not be REL when Platform_sdk_final is true")
834 }
835 return ApiLevelOrPanic(ctx, codename)
Colin Crossd09b0b62018-04-18 11:06:47 -0700836}
837
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800838func (c *config) AppsDefaultVersionName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800839 return String(c.productVariables.AppsDefaultVersionName)
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800840}
841
Dan Albert31384de2017-07-28 12:39:46 -0700842// Codenames that are active in the current lunch target.
843func (c *config) PlatformVersionActiveCodenames() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800844 return c.productVariables.Platform_version_active_codenames
Dan Albert31384de2017-07-28 12:39:46 -0700845}
846
Colin Crossface4e42017-10-30 17:32:15 -0700847func (c *config) ProductAAPTConfig() []string {
Colin Crossa74ca042019-01-31 14:31:51 -0800848 return c.productVariables.AAPTConfig
Colin Cross30e076a2015-04-13 13:58:27 -0700849}
850
Colin Crossface4e42017-10-30 17:32:15 -0700851func (c *config) ProductAAPTPreferredConfig() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800852 return String(c.productVariables.AAPTPreferredConfig)
Colin Cross30e076a2015-04-13 13:58:27 -0700853}
854
Colin Crossface4e42017-10-30 17:32:15 -0700855func (c *config) ProductAAPTCharacteristics() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800856 return String(c.productVariables.AAPTCharacteristics)
Colin Crossface4e42017-10-30 17:32:15 -0700857}
858
859func (c *config) ProductAAPTPrebuiltDPI() []string {
Colin Crossa74ca042019-01-31 14:31:51 -0800860 return c.productVariables.AAPTPrebuiltDPI
Colin Cross30e076a2015-04-13 13:58:27 -0700861}
862
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700863func (c *config) DefaultAppCertificateDir(ctx PathContext) SourcePath {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800864 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -0800865 if defaultCert != "" {
866 return PathForSource(ctx, filepath.Dir(defaultCert))
Colin Cross61ae0b72017-12-01 17:16:02 -0800867 }
Jingwen Chenc711fec2020-11-22 23:52:50 -0500868 return PathForSource(ctx, "build/make/target/product/security")
Colin Cross30e076a2015-04-13 13:58:27 -0700869}
870
Colin Crosse1731a52017-12-14 11:22:55 -0800871func (c *config) DefaultAppCertificate(ctx PathContext) (pem, key SourcePath) {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800872 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -0800873 if defaultCert != "" {
Colin Crosse1731a52017-12-14 11:22:55 -0800874 return PathForSource(ctx, defaultCert+".x509.pem"), PathForSource(ctx, defaultCert+".pk8")
Colin Cross61ae0b72017-12-01 17:16:02 -0800875 }
Jingwen Chenc711fec2020-11-22 23:52:50 -0500876 defaultDir := c.DefaultAppCertificateDir(ctx)
877 return defaultDir.Join(ctx, "testkey.x509.pem"), defaultDir.Join(ctx, "testkey.pk8")
Colin Cross30e076a2015-04-13 13:58:27 -0700878}
Colin Cross6ff51382015-12-17 16:39:19 -0800879
Jiyong Park9335a262018-12-24 11:31:58 +0900880func (c *config) ApexKeyDir(ctx ModuleContext) SourcePath {
881 // TODO(b/121224311): define another variable such as TARGET_APEX_KEY_OVERRIDE
882 defaultCert := String(c.productVariables.DefaultAppCertificate)
Dan Willemsen412160e2019-04-09 21:36:26 -0700883 if defaultCert == "" || filepath.Dir(defaultCert) == "build/make/target/product/security" {
Jiyong Park9335a262018-12-24 11:31:58 +0900884 // When defaultCert is unset or is set to the testkeys path, use the APEX keys
885 // that is under the module dir
Colin Cross07e51612019-03-05 12:46:40 -0800886 return pathForModuleSrc(ctx)
Jiyong Park9335a262018-12-24 11:31:58 +0900887 }
Jingwen Chenc711fec2020-11-22 23:52:50 -0500888 // If not, APEX keys are under the specified directory
889 return PathForSource(ctx, filepath.Dir(defaultCert))
Jiyong Park9335a262018-12-24 11:31:58 +0900890}
891
Inseob Kim80fa7982022-08-12 21:36:25 +0900892// Certificate for the NetworkStack sepolicy context
893func (c *config) MainlineSepolicyDevCertificatesDir(ctx ModuleContext) SourcePath {
894 cert := String(c.productVariables.MainlineSepolicyDevCertificates)
895 if cert != "" {
896 return PathForSource(ctx, cert)
897 }
898 return c.DefaultAppCertificateDir(ctx)
899}
900
Jingwen Chenc711fec2020-11-22 23:52:50 -0500901// AllowMissingDependencies configures Blueprint/Soong to not fail when modules
902// are configured to depend on non-existent modules. Note that this does not
903// affect missing input dependencies at the Ninja level.
Colin Cross6ff51382015-12-17 16:39:19 -0800904func (c *config) AllowMissingDependencies() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800905 return Bool(c.productVariables.Allow_missing_dependencies)
Colin Cross6ff51382015-12-17 16:39:19 -0800906}
Dan Willemsen322acaf2016-01-12 23:07:05 -0800907
Jeongik Cha816a23a2020-07-08 01:09:23 +0900908// Returns true if a full platform source tree cannot be assumed.
Colin Crossfc3674a2017-09-18 17:41:52 -0700909func (c *config) UnbundledBuild() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800910 return Bool(c.productVariables.Unbundled_build)
Colin Crossfc3674a2017-09-18 17:41:52 -0700911}
912
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +0100913// Returns true if building apps that aren't bundled with the platform.
914// UnbundledBuild() is always true when this is true.
915func (c *config) UnbundledBuildApps() bool {
Cole Faust701ca252021-11-23 19:02:08 -0800916 return len(c.productVariables.Unbundled_build_apps) > 0
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +0100917}
918
Jeongik Cha4b073cd2021-06-08 11:35:00 +0900919// Returns true if building image that aren't bundled with the platform.
920// UnbundledBuild() is always true when this is true.
921func (c *config) UnbundledBuildImage() bool {
922 return Bool(c.productVariables.Unbundled_build_image)
923}
924
Jeongik Cha816a23a2020-07-08 01:09:23 +0900925// Returns true if building modules against prebuilt SDKs.
926func (c *config) AlwaysUsePrebuiltSdks() bool {
927 return Bool(c.productVariables.Always_use_prebuilt_sdks)
Colin Cross1f367bf2018-12-18 22:46:24 -0800928}
929
Colin Cross126a25c2017-10-31 13:55:34 -0700930func (c *config) MinimizeJavaDebugInfo() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800931 return Bool(c.productVariables.MinimizeJavaDebugInfo) && !Bool(c.productVariables.Eng)
Colin Cross126a25c2017-10-31 13:55:34 -0700932}
933
Colin Crossed064c02018-09-05 16:28:13 -0700934func (c *config) Debuggable() bool {
935 return Bool(c.productVariables.Debuggable)
936}
937
Jaewoong Jung1d6eb682018-11-29 15:08:44 -0800938func (c *config) Eng() bool {
939 return Bool(c.productVariables.Eng)
940}
941
Colin Crossc53c37f2021-12-08 15:42:22 -0800942// DevicePrimaryArchType returns the ArchType for the first configured device architecture, or
943// Common if there are no device architectures.
Jiyong Park8d52f862018-07-07 18:02:07 +0900944func (c *config) DevicePrimaryArchType() ArchType {
Colin Crossc53c37f2021-12-08 15:42:22 -0800945 if androidTargets := c.Targets[Android]; len(androidTargets) > 0 {
946 return androidTargets[0].Arch.ArchType
947 }
948 return Common
Jiyong Park8d52f862018-07-07 18:02:07 +0900949}
950
Colin Cross16b23492016-01-06 14:41:07 -0800951func (c *config) SanitizeHost() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800952 return append([]string(nil), c.productVariables.SanitizeHost...)
Colin Cross16b23492016-01-06 14:41:07 -0800953}
954
955func (c *config) SanitizeDevice() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800956 return append([]string(nil), c.productVariables.SanitizeDevice...)
Colin Cross23ae82a2016-11-02 14:34:39 -0700957}
958
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700959func (c *config) SanitizeDeviceDiag() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800960 return append([]string(nil), c.productVariables.SanitizeDeviceDiag...)
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700961}
962
Colin Cross23ae82a2016-11-02 14:34:39 -0700963func (c *config) SanitizeDeviceArch() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800964 return append([]string(nil), c.productVariables.SanitizeDeviceArch...)
Colin Cross16b23492016-01-06 14:41:07 -0800965}
Colin Crossa1ad8d12016-06-01 17:09:44 -0700966
Vishwath Mohan1b017a72017-01-19 13:54:55 -0800967func (c *config) EnableCFI() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800968 if c.productVariables.EnableCFI == nil {
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -0800969 return true
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -0800970 }
Jingwen Chenc711fec2020-11-22 23:52:50 -0500971 return *c.productVariables.EnableCFI
Vishwath Mohan1b017a72017-01-19 13:54:55 -0800972}
973
Kostya Kortchinskyd5275c82019-02-01 08:42:56 -0800974func (c *config) DisableScudo() bool {
975 return Bool(c.productVariables.DisableScudo)
976}
977
Colin Crossa1ad8d12016-06-01 17:09:44 -0700978func (c *config) Android64() bool {
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700979 for _, t := range c.Targets[Android] {
Colin Crossa1ad8d12016-06-01 17:09:44 -0700980 if t.Arch.ArchType.Multilib == "lib64" {
981 return true
982 }
983 }
984
985 return false
986}
Colin Cross9272ade2016-08-17 15:24:12 -0700987
Colin Cross9d45bb72016-08-29 16:14:13 -0700988func (c *config) UseGoma() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800989 return Bool(c.productVariables.UseGoma)
Colin Cross9d45bb72016-08-29 16:14:13 -0700990}
991
Ramy Medhatbbf25672019-07-17 12:30:04 +0000992func (c *config) UseRBE() bool {
993 return Bool(c.productVariables.UseRBE)
994}
995
Ramy Medhat8ea054a2020-01-27 14:19:44 -0500996func (c *config) UseRBEJAVAC() bool {
997 return Bool(c.productVariables.UseRBEJAVAC)
998}
999
1000func (c *config) UseRBER8() bool {
1001 return Bool(c.productVariables.UseRBER8)
1002}
1003
1004func (c *config) UseRBED8() bool {
1005 return Bool(c.productVariables.UseRBED8)
1006}
1007
Colin Cross8b8bec32019-11-15 13:18:43 -08001008func (c *config) UseRemoteBuild() bool {
1009 return c.UseGoma() || c.UseRBE()
1010}
1011
Colin Cross66548102018-06-19 22:47:35 -07001012func (c *config) RunErrorProne() bool {
1013 return c.IsEnvTrue("RUN_ERROR_PRONE")
1014}
1015
Jingwen Chenc711fec2020-11-22 23:52:50 -05001016// XrefCorpusName returns the Kythe cross-reference corpus name.
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001017func (c *config) XrefCorpusName() string {
1018 return c.Getenv("XREF_CORPUS")
1019}
1020
Jingwen Chenc711fec2020-11-22 23:52:50 -05001021// XrefCuEncoding returns the compilation unit encoding to use for Kythe code
1022// xrefs. Can be 'json' (default), 'proto' or 'all'.
Sasha Smundak6c2d4f92020-01-09 17:34:23 -08001023func (c *config) XrefCuEncoding() string {
1024 if enc := c.Getenv("KYTHE_KZIP_ENCODING"); enc != "" {
1025 return enc
1026 }
1027 return "json"
1028}
1029
Sasha Smundakb0addaf2021-02-16 10:39:40 -08001030// XrefCuJavaSourceMax returns the maximum number of the Java source files
1031// in a single compilation unit
1032const xrefJavaSourceFileMaxDefault = "1000"
1033
1034func (c Config) XrefCuJavaSourceMax() string {
1035 v := c.Getenv("KYTHE_JAVA_SOURCE_BATCH_SIZE")
1036 if v == "" {
1037 return xrefJavaSourceFileMaxDefault
1038 }
1039 if _, err := strconv.ParseUint(v, 0, 0); err != nil {
1040 fmt.Fprintf(os.Stderr,
1041 "bad KYTHE_JAVA_SOURCE_BATCH_SIZE value: %s, will use %s",
1042 err, xrefJavaSourceFileMaxDefault)
1043 return xrefJavaSourceFileMaxDefault
1044 }
1045 return v
1046
1047}
1048
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001049func (c *config) EmitXrefRules() bool {
1050 return c.XrefCorpusName() != ""
1051}
1052
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001053func (c *config) ClangTidy() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001054 return Bool(c.productVariables.ClangTidy)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001055}
1056
1057func (c *config) TidyChecks() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001058 if c.productVariables.TidyChecks == nil {
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001059 return ""
1060 }
Dan Willemsen45133ac2018-03-09 21:22:06 -08001061 return *c.productVariables.TidyChecks
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001062}
1063
Colin Cross0f4e0d62016-07-27 10:56:55 -07001064func (c *config) LibartImgHostBaseAddress() string {
1065 return "0x60000000"
1066}
1067
1068func (c *config) LibartImgDeviceBaseAddress() string {
Elliott Hughesda3a0712020-03-06 16:55:28 -08001069 return "0x70000000"
Colin Cross0f4e0d62016-07-27 10:56:55 -07001070}
1071
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001072func (c *config) ArtUseReadBarrier() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001073 return Bool(c.productVariables.ArtUseReadBarrier)
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001074}
1075
Jingwen Chenc711fec2020-11-22 23:52:50 -05001076// Enforce Runtime Resource Overlays for a module. RROs supersede static RROs,
1077// but some modules still depend on it.
1078//
1079// More info: https://source.android.com/devices/architecture/rros
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001080func (c *config) EnforceRROForModule(name string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001081 enforceList := c.productVariables.EnforceRROTargets
Jeongik Chacee5ba92021-02-19 12:11:51 +09001082
Roland Levillainf6cc2612020-07-09 16:58:14 +01001083 if len(enforceList) > 0 {
Yo Chiang4ebd06a2019-10-01 13:13:41 +08001084 if InList("*", enforceList) {
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001085 return true
1086 }
Colin Crossa74ca042019-01-31 14:31:51 -08001087 return InList(name, enforceList)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001088 }
1089 return false
1090}
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001091func (c *config) EnforceRROExcludedOverlay(path string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001092 excluded := c.productVariables.EnforceRROExcludedOverlays
Roland Levillainf6cc2612020-07-09 16:58:14 +01001093 if len(excluded) > 0 {
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001094 return HasAnyPrefix(path, excluded)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001095 }
1096 return false
1097}
1098
1099func (c *config) ExportedNamespaces() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001100 return append([]string(nil), c.productVariables.NamespacesToExport...)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001101}
1102
1103func (c *config) HostStaticBinaries() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001104 return Bool(c.productVariables.HostStaticBinaries)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001105}
1106
Colin Cross5a0dcd52018-10-05 14:20:06 -07001107func (c *config) UncompressPrivAppDex() bool {
1108 return Bool(c.productVariables.UncompressPrivAppDex)
1109}
1110
1111func (c *config) ModulesLoadedByPrivilegedModules() []string {
1112 return c.productVariables.ModulesLoadedByPrivilegedModules
1113}
1114
Jingwen Chenc711fec2020-11-22 23:52:50 -05001115// DexpreoptGlobalConfigPath returns the path to the dexpreopt.config file in
1116// the output directory, if it was created during the product configuration
1117// phase by Kati.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001118func (c *config) DexpreoptGlobalConfigPath(ctx PathContext) OptionalPath {
Colin Cross988414c2020-01-11 01:11:46 +00001119 if c.productVariables.DexpreoptGlobalConfig == nil {
Jingwen Chenebb0b572020-11-02 00:24:57 -05001120 return OptionalPathForPath(nil)
1121 }
1122 return OptionalPathForPath(
1123 pathForBuildToolDep(ctx, *c.productVariables.DexpreoptGlobalConfig))
1124}
1125
Jingwen Chenc711fec2020-11-22 23:52:50 -05001126// DexpreoptGlobalConfig returns the raw byte contents of the dexpreopt global
1127// configuration. Since the configuration file was created by Kati during
1128// product configuration (externally of soong_build), it's not tracked, so we
1129// also manually add a Ninja file dependency on the configuration file to the
1130// rule that creates the main build.ninja file. This ensures that build.ninja is
1131// regenerated correctly if dexpreopt.config changes.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001132func (c *config) DexpreoptGlobalConfig(ctx PathContext) ([]byte, error) {
1133 path := c.DexpreoptGlobalConfigPath(ctx)
1134 if !path.Valid() {
Colin Cross988414c2020-01-11 01:11:46 +00001135 return nil, nil
1136 }
Jingwen Chenebb0b572020-11-02 00:24:57 -05001137 ctx.AddNinjaFileDeps(path.String())
1138 return ioutil.ReadFile(absolutePath(path.String()))
Colin Cross43f08db2018-11-12 10:13:39 -08001139}
1140
Inseob Kim7b85eeb2021-03-23 20:52:24 +09001141func (c *deviceConfig) WithDexpreopt() bool {
1142 return c.config.productVariables.WithDexpreopt
1143}
1144
Colin Cross662d6142022-11-03 20:38:01 -07001145func (c *config) FrameworksBaseDirExists(ctx PathGlobContext) bool {
Colin Cross5a756a62021-03-16 16:34:46 -07001146 return ExistentPathForSource(ctx, "frameworks", "base", "Android.bp").Valid()
David Brazdil91b4e3e2019-01-23 21:04:05 +00001147}
1148
Inseob Kimae553032019-05-14 18:52:49 +09001149func (c *config) VndkSnapshotBuildArtifacts() bool {
1150 return Bool(c.productVariables.VndkSnapshotBuildArtifacts)
1151}
1152
Colin Cross3b19f5d2019-09-17 14:45:31 -07001153func (c *config) HasMultilibConflict(arch ArchType) bool {
1154 return c.multilibConflicts[arch]
1155}
1156
Bill Peckhambae47492021-01-08 09:34:44 -08001157func (c *config) PrebuiltHiddenApiDir(ctx PathContext) string {
1158 return String(c.productVariables.PrebuiltHiddenApiDir)
1159}
1160
Colin Cross9272ade2016-08-17 15:24:12 -07001161func (c *deviceConfig) Arches() []Arch {
1162 var arches []Arch
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001163 for _, target := range c.config.Targets[Android] {
Colin Cross9272ade2016-08-17 15:24:12 -07001164 arches = append(arches, target.Arch)
1165 }
1166 return arches
1167}
Dan Willemsend2ede872016-11-18 14:54:24 -08001168
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001169func (c *deviceConfig) BinderBitness() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001170 is32BitBinder := c.config.productVariables.Binder32bit
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001171 if is32BitBinder != nil && *is32BitBinder {
1172 return "32"
1173 }
1174 return "64"
1175}
1176
Dan Willemsen4353bc42016-12-05 17:16:02 -08001177func (c *deviceConfig) VendorPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001178 if c.config.productVariables.VendorPath != nil {
1179 return *c.config.productVariables.VendorPath
Dan Willemsen4353bc42016-12-05 17:16:02 -08001180 }
1181 return "vendor"
1182}
1183
Justin Yun71549282017-11-17 12:10:28 +09001184func (c *deviceConfig) VndkVersion() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001185 return String(c.config.productVariables.DeviceVndkVersion)
Justin Yun71549282017-11-17 12:10:28 +09001186}
1187
Jose Galmes6f843bc2020-12-11 13:36:29 -08001188func (c *deviceConfig) RecoverySnapshotVersion() string {
1189 return String(c.config.productVariables.RecoverySnapshotVersion)
1190}
1191
Jeongik Cha219141c2020-08-06 23:00:37 +09001192func (c *deviceConfig) CurrentApiLevelForVendorModules() string {
1193 return StringDefault(c.config.productVariables.DeviceCurrentApiLevelForVendorModules, "current")
1194}
1195
Justin Yun8fe12122017-12-07 17:18:15 +09001196func (c *deviceConfig) PlatformVndkVersion() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001197 return String(c.config.productVariables.Platform_vndk_version)
Justin Yun8fe12122017-12-07 17:18:15 +09001198}
1199
Justin Yun5f7f7e82019-11-18 19:52:14 +09001200func (c *deviceConfig) ProductVndkVersion() string {
1201 return String(c.config.productVariables.ProductVndkVersion)
1202}
1203
Justin Yun71549282017-11-17 12:10:28 +09001204func (c *deviceConfig) ExtraVndkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001205 return c.config.productVariables.ExtraVndkVersions
Dan Willemsend2ede872016-11-18 14:54:24 -08001206}
Jack He8cc71432016-12-08 15:45:07 -08001207
Vic Yangefd249e2018-11-12 20:19:56 -08001208func (c *deviceConfig) VndkUseCoreVariant() bool {
1209 return Bool(c.config.productVariables.VndkUseCoreVariant)
1210}
1211
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001212func (c *deviceConfig) SystemSdkVersions() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001213 return c.config.productVariables.DeviceSystemSdkVersions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001214}
1215
1216func (c *deviceConfig) PlatformSystemSdkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001217 return c.config.productVariables.Platform_systemsdk_versions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001218}
1219
Jiyong Park2db76922017-11-08 16:03:48 +09001220func (c *deviceConfig) OdmPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001221 if c.config.productVariables.OdmPath != nil {
1222 return *c.config.productVariables.OdmPath
Jiyong Park2db76922017-11-08 16:03:48 +09001223 }
1224 return "odm"
1225}
1226
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001227func (c *deviceConfig) ProductPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001228 if c.config.productVariables.ProductPath != nil {
1229 return *c.config.productVariables.ProductPath
Jiyong Park2db76922017-11-08 16:03:48 +09001230 }
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001231 return "product"
Jiyong Park2db76922017-11-08 16:03:48 +09001232}
1233
Justin Yund5f6c822019-06-25 16:47:17 +09001234func (c *deviceConfig) SystemExtPath() string {
1235 if c.config.productVariables.SystemExtPath != nil {
1236 return *c.config.productVariables.SystemExtPath
Dario Frenifd05a742018-05-29 13:28:54 +01001237 }
Justin Yund5f6c822019-06-25 16:47:17 +09001238 return "system_ext"
Dario Frenifd05a742018-05-29 13:28:54 +01001239}
1240
Jack He8cc71432016-12-08 15:45:07 -08001241func (c *deviceConfig) BtConfigIncludeDir() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001242 return String(c.config.productVariables.BtConfigIncludeDir)
Jack He8cc71432016-12-08 15:45:07 -08001243}
Dan Willemsen581341d2017-02-09 16:16:31 -08001244
Jiyong Parkd773eb32017-07-03 13:18:12 +09001245func (c *deviceConfig) DeviceKernelHeaderDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001246 return c.config.productVariables.DeviceKernelHeaders
Jiyong Parkd773eb32017-07-03 13:18:12 +09001247}
1248
Roland Levillainada12702020-06-09 13:07:36 +01001249// JavaCoverageEnabledForPath returns whether Java code coverage is enabled for
1250// path. Coverage is enabled by default when the product variable
1251// JavaCoveragePaths is empty. If JavaCoveragePaths is not empty, coverage is
1252// enabled for any path which is part of this variable (and not part of the
1253// JavaCoverageExcludePaths product variable). Value "*" in JavaCoveragePaths
1254// represents any path.
1255func (c *deviceConfig) JavaCoverageEnabledForPath(path string) bool {
1256 coverage := false
Chris Gross2f748692020-06-24 20:36:59 +00001257 if len(c.config.productVariables.JavaCoveragePaths) == 0 ||
Roland Levillainada12702020-06-09 13:07:36 +01001258 InList("*", c.config.productVariables.JavaCoveragePaths) ||
1259 HasAnyPrefix(path, c.config.productVariables.JavaCoveragePaths) {
1260 coverage = true
1261 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001262 if coverage && len(c.config.productVariables.JavaCoverageExcludePaths) > 0 {
Roland Levillainada12702020-06-09 13:07:36 +01001263 if HasAnyPrefix(path, c.config.productVariables.JavaCoverageExcludePaths) {
1264 coverage = false
1265 }
1266 }
1267 return coverage
1268}
1269
Colin Cross1a6acd42020-06-16 17:51:46 -07001270// Returns true if gcov or clang coverage is enabled.
Dan Willemsen581341d2017-02-09 16:16:31 -08001271func (c *deviceConfig) NativeCoverageEnabled() bool {
Colin Cross1a6acd42020-06-16 17:51:46 -07001272 return Bool(c.config.productVariables.GcovCoverage) ||
1273 Bool(c.config.productVariables.ClangCoverage)
Dan Willemsen581341d2017-02-09 16:16:31 -08001274}
1275
Oliver Nguyen1382ab62019-12-06 15:22:41 -08001276func (c *deviceConfig) ClangCoverageEnabled() bool {
1277 return Bool(c.config.productVariables.ClangCoverage)
1278}
1279
Pirama Arumuga Nainarb37ae582022-01-26 22:14:32 -08001280func (c *deviceConfig) ClangCoverageContinuousMode() bool {
1281 return Bool(c.config.productVariables.ClangCoverageContinuousMode)
1282}
1283
Colin Cross1a6acd42020-06-16 17:51:46 -07001284func (c *deviceConfig) GcovCoverageEnabled() bool {
1285 return Bool(c.config.productVariables.GcovCoverage)
1286}
1287
Roland Levillain4f5297b2020-06-09 12:44:06 +01001288// NativeCoverageEnabledForPath returns whether (GCOV- or Clang-based) native
1289// code coverage is enabled for path. By default, coverage is not enabled for a
1290// given path unless it is part of the NativeCoveragePaths product variable (and
1291// not part of the NativeCoverageExcludePaths product variable). Value "*" in
1292// NativeCoveragePaths represents any path.
1293func (c *deviceConfig) NativeCoverageEnabledForPath(path string) bool {
Ryan Campbell469a18a2017-02-27 09:01:54 -08001294 coverage := false
Roland Levillainf6cc2612020-07-09 16:58:14 +01001295 if len(c.config.productVariables.NativeCoveragePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001296 if InList("*", c.config.productVariables.NativeCoveragePaths) || HasAnyPrefix(path, c.config.productVariables.NativeCoveragePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001297 coverage = true
Dan Willemsen581341d2017-02-09 16:16:31 -08001298 }
1299 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001300 if coverage && len(c.config.productVariables.NativeCoverageExcludePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001301 if HasAnyPrefix(path, c.config.productVariables.NativeCoverageExcludePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001302 coverage = false
Ryan Campbell469a18a2017-02-27 09:01:54 -08001303 }
1304 }
1305 return coverage
Dan Willemsen581341d2017-02-09 16:16:31 -08001306}
Ivan Lozano5f595532017-07-13 14:46:05 -07001307
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001308func (c *deviceConfig) PgoAdditionalProfileDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001309 return c.config.productVariables.PgoAdditionalProfileDirs
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001310}
1311
Tri Vo35a51432018-03-25 20:00:00 -07001312func (c *deviceConfig) VendorSepolicyDirs() []string {
1313 return c.config.productVariables.BoardVendorSepolicyDirs
1314}
1315
1316func (c *deviceConfig) OdmSepolicyDirs() []string {
1317 return c.config.productVariables.BoardOdmSepolicyDirs
1318}
1319
Felixa20a8752020-05-17 18:28:35 +02001320func (c *deviceConfig) SystemExtPublicSepolicyDirs() []string {
1321 return c.config.productVariables.SystemExtPublicSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001322}
1323
Felixa20a8752020-05-17 18:28:35 +02001324func (c *deviceConfig) SystemExtPrivateSepolicyDirs() []string {
1325 return c.config.productVariables.SystemExtPrivateSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001326}
1327
Inseob Kim0866b002019-04-15 20:21:29 +09001328func (c *deviceConfig) SepolicyM4Defs() []string {
1329 return c.config.productVariables.BoardSepolicyM4Defs
1330}
1331
Jiyong Park7f67f482019-01-05 12:57:48 +09001332func (c *deviceConfig) OverrideManifestPackageNameFor(name string) (manifestName string, overridden bool) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001333 return findOverrideValue(c.config.productVariables.ManifestPackageNameOverrides, name,
1334 "invalid override rule %q in PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES should be <module_name>:<manifest_name>")
1335}
1336
1337func (c *deviceConfig) OverrideCertificateFor(name string) (certificatePath string, overridden bool) {
Jaewoong Jungacb6db32019-02-28 16:22:30 +00001338 return findOverrideValue(c.config.productVariables.CertificateOverrides, name,
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001339 "invalid override rule %q in PRODUCT_CERTIFICATE_OVERRIDES should be <module_name>:<certificate_module_name>")
1340}
1341
Jaewoong Jung9d22a912019-01-23 16:27:47 -08001342func (c *deviceConfig) OverridePackageNameFor(name string) string {
1343 newName, overridden := findOverrideValue(
1344 c.config.productVariables.PackageNameOverrides,
1345 name,
1346 "invalid override rule %q in PRODUCT_PACKAGE_NAME_OVERRIDES should be <module_name>:<package_name>")
1347 if overridden {
1348 return newName
1349 }
1350 return name
1351}
1352
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001353func findOverrideValue(overrides []string, name string, errorMsg string) (newValue string, overridden bool) {
Jiyong Park7f67f482019-01-05 12:57:48 +09001354 if overrides == nil || len(overrides) == 0 {
1355 return "", false
1356 }
1357 for _, o := range overrides {
1358 split := strings.Split(o, ":")
1359 if len(split) != 2 {
1360 // This shouldn't happen as this is first checked in make, but just in case.
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001361 panic(fmt.Errorf(errorMsg, o))
Jiyong Park7f67f482019-01-05 12:57:48 +09001362 }
1363 if matchPattern(split[0], name) {
1364 return substPattern(split[0], split[1], name), true
1365 }
1366 }
1367 return "", false
1368}
1369
Albert Martineefabcf2022-03-21 20:11:16 +00001370func (c *deviceConfig) ApexGlobalMinSdkVersionOverride() string {
1371 return String(c.config.productVariables.ApexGlobalMinSdkVersionOverride)
1372}
1373
Ivan Lozano5f595532017-07-13 14:46:05 -07001374func (c *config) IntegerOverflowDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001375 if len(c.productVariables.IntegerOverflowExcludePaths) == 0 {
Ivan Lozano5f595532017-07-13 14:46:05 -07001376 return false
1377 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001378 return HasAnyPrefix(path, c.productVariables.IntegerOverflowExcludePaths)
Ivan Lozano5f595532017-07-13 14:46:05 -07001379}
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001380
1381func (c *config) CFIDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001382 if len(c.productVariables.CFIExcludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001383 return false
1384 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001385 return HasAnyPrefix(path, c.productVariables.CFIExcludePaths)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001386}
1387
1388func (c *config) CFIEnabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001389 if len(c.productVariables.CFIIncludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001390 return false
1391 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001392 return HasAnyPrefix(path, c.productVariables.CFIIncludePaths) && !c.CFIDisabledForPath(path)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001393}
Colin Crosse15ddaf2017-12-04 11:24:31 -08001394
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001395func (c *config) MemtagHeapDisabledForPath(path string) bool {
1396 if len(c.productVariables.MemtagHeapExcludePaths) == 0 {
1397 return false
1398 }
1399 return HasAnyPrefix(path, c.productVariables.MemtagHeapExcludePaths)
1400}
1401
1402func (c *config) MemtagHeapAsyncEnabledForPath(path string) bool {
1403 if len(c.productVariables.MemtagHeapAsyncIncludePaths) == 0 {
1404 return false
1405 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001406 return HasAnyPrefix(path, c.productVariables.MemtagHeapAsyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001407}
1408
1409func (c *config) MemtagHeapSyncEnabledForPath(path string) bool {
1410 if len(c.productVariables.MemtagHeapSyncIncludePaths) == 0 {
1411 return false
1412 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001413 return HasAnyPrefix(path, c.productVariables.MemtagHeapSyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001414}
1415
Dan Willemsen0fe78662018-03-26 12:41:18 -07001416func (c *config) VendorConfig(name string) VendorConfig {
Colin Cross9d34f352019-11-22 16:03:51 -08001417 return soongconfig.Config(c.productVariables.VendorVars[name])
Dan Willemsen0fe78662018-03-26 12:41:18 -07001418}
1419
Colin Cross395f2cf2018-10-24 16:10:32 -07001420func (c *config) NdkAbis() bool {
1421 return Bool(c.productVariables.Ndk_abis)
1422}
1423
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001424func (c *config) AmlAbis() bool {
1425 return Bool(c.productVariables.Aml_abis)
1426}
1427
Jiyong Park8fd61922018-11-08 02:50:25 +09001428func (c *config) FlattenApex() bool {
Roland Levillaina3863212019-08-12 19:56:16 +01001429 return Bool(c.productVariables.Flatten_apex)
Jiyong Park8fd61922018-11-08 02:50:25 +09001430}
1431
Jiyong Park4da07972021-01-05 21:01:11 +09001432func (c *config) ForceApexSymlinkOptimization() bool {
1433 return Bool(c.productVariables.ForceApexSymlinkOptimization)
1434}
1435
Sasha Smundakfe9a5b82022-07-27 14:51:45 -07001436func (c *config) ApexCompressionEnabled() bool {
1437 return Bool(c.productVariables.CompressedApex) && !c.UnbundledBuildApps()
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +00001438}
1439
Jeongik Chac9464142019-01-07 12:07:27 +09001440func (c *config) EnforceSystemCertificate() bool {
1441 return Bool(c.productVariables.EnforceSystemCertificate)
1442}
1443
Colin Cross440e0d02020-06-11 11:32:11 -07001444func (c *config) EnforceSystemCertificateAllowList() []string {
1445 return c.productVariables.EnforceSystemCertificateAllowList
Jeongik Chac9464142019-01-07 12:07:27 +09001446}
1447
Jeongik Cha2cc570d2019-10-29 15:44:45 +09001448func (c *config) EnforceProductPartitionInterface() bool {
1449 return Bool(c.productVariables.EnforceProductPartitionInterface)
1450}
1451
JaeMan Parkff715562020-10-19 17:25:58 +09001452func (c *config) EnforceInterPartitionJavaSdkLibrary() bool {
1453 return Bool(c.productVariables.EnforceInterPartitionJavaSdkLibrary)
1454}
1455
1456func (c *config) InterPartitionJavaLibraryAllowList() []string {
1457 return c.productVariables.InterPartitionJavaLibraryAllowList
1458}
1459
Jooyung Han3ab2c3e2019-12-05 16:27:44 +09001460func (c *config) InstallExtraFlattenedApexes() bool {
1461 return Bool(c.productVariables.InstallExtraFlattenedApexes)
1462}
1463
Colin Crossf24a22a2019-01-31 14:12:44 -08001464func (c *config) ProductHiddenAPIStubs() []string {
1465 return c.productVariables.ProductHiddenAPIStubs
Colin Cross8faf8fc2019-01-16 15:15:52 -08001466}
1467
Colin Crossf24a22a2019-01-31 14:12:44 -08001468func (c *config) ProductHiddenAPIStubsSystem() []string {
1469 return c.productVariables.ProductHiddenAPIStubsSystem
Colin Cross8faf8fc2019-01-16 15:15:52 -08001470}
1471
Colin Crossf24a22a2019-01-31 14:12:44 -08001472func (c *config) ProductHiddenAPIStubsTest() []string {
1473 return c.productVariables.ProductHiddenAPIStubsTest
Colin Cross8faf8fc2019-01-16 15:15:52 -08001474}
Dan Willemsen71c74602019-04-10 12:27:35 -07001475
Dan Willemsen54879d12019-04-18 10:08:46 -07001476func (c *deviceConfig) TargetFSConfigGen() []string {
Dan Willemsen71c74602019-04-10 12:27:35 -07001477 return c.config.productVariables.TargetFSConfigGen
1478}
Inseob Kim0866b002019-04-15 20:21:29 +09001479
1480func (c *config) ProductPublicSepolicyDirs() []string {
1481 return c.productVariables.ProductPublicSepolicyDirs
1482}
1483
1484func (c *config) ProductPrivateSepolicyDirs() []string {
1485 return c.productVariables.ProductPrivateSepolicyDirs
1486}
1487
Colin Cross50ddcc42019-05-16 12:28:22 -07001488func (c *config) MissingUsesLibraries() []string {
1489 return c.productVariables.MissingUsesLibraries
1490}
1491
Inseob Kim5eb7ee92022-04-27 10:30:34 +09001492func (c *config) TargetMultitreeUpdateMeta() bool {
1493 return c.productVariables.MultitreeUpdateMeta
1494}
1495
Inseob Kim1f086e22019-05-09 13:29:15 +09001496func (c *deviceConfig) DeviceArch() string {
1497 return String(c.config.productVariables.DeviceArch)
1498}
1499
1500func (c *deviceConfig) DeviceArchVariant() string {
1501 return String(c.config.productVariables.DeviceArchVariant)
1502}
1503
1504func (c *deviceConfig) DeviceSecondaryArch() string {
1505 return String(c.config.productVariables.DeviceSecondaryArch)
1506}
1507
1508func (c *deviceConfig) DeviceSecondaryArchVariant() string {
1509 return String(c.config.productVariables.DeviceSecondaryArchVariant)
1510}
Yifan Hong82db7352020-01-21 16:12:26 -08001511
1512func (c *deviceConfig) BoardUsesRecoveryAsBoot() bool {
1513 return Bool(c.config.productVariables.BoardUsesRecoveryAsBoot)
1514}
Yifan Hong97365ee2020-07-29 09:51:57 -07001515
1516func (c *deviceConfig) BoardKernelBinaries() []string {
1517 return c.config.productVariables.BoardKernelBinaries
1518}
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001519
Yifan Hong42bef8d2020-08-05 14:36:09 -07001520func (c *deviceConfig) BoardKernelModuleInterfaceVersions() []string {
1521 return c.config.productVariables.BoardKernelModuleInterfaceVersions
1522}
1523
Yifan Hongdd8dacc2020-10-21 15:40:17 -07001524func (c *deviceConfig) BoardMoveRecoveryResourcesToVendorBoot() bool {
1525 return Bool(c.config.productVariables.BoardMoveRecoveryResourcesToVendorBoot)
1526}
1527
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001528func (c *deviceConfig) PlatformSepolicyVersion() string {
1529 return String(c.config.productVariables.PlatformSepolicyVersion)
1530}
1531
Inseob Kima10ef272021-09-15 03:04:53 +00001532func (c *deviceConfig) TotSepolicyVersion() string {
1533 return String(c.config.productVariables.TotSepolicyVersion)
1534}
1535
Inseob Kim843f6642022-01-07 09:11:23 +09001536func (c *deviceConfig) PlatformSepolicyCompatVersions() []string {
1537 return c.config.productVariables.PlatformSepolicyCompatVersions
1538}
1539
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001540func (c *deviceConfig) BoardSepolicyVers() string {
Inseob Kim0c4eec82021-03-22 22:33:40 +09001541 if ver := String(c.config.productVariables.BoardSepolicyVers); ver != "" {
1542 return ver
1543 }
1544 return c.PlatformSepolicyVersion()
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001545}
1546
Inseob Kim14178802021-12-08 22:53:31 +09001547func (c *deviceConfig) BoardPlatVendorPolicy() []string {
1548 return c.config.productVariables.BoardPlatVendorPolicy
1549}
1550
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001551func (c *deviceConfig) BoardReqdMaskPolicy() []string {
1552 return c.config.productVariables.BoardReqdMaskPolicy
1553}
1554
Inseob Kim0f46e7c2021-12-15 22:48:14 +09001555func (c *deviceConfig) BoardSystemExtPublicPrebuiltDirs() []string {
1556 return c.config.productVariables.BoardSystemExtPublicPrebuiltDirs
1557}
1558
1559func (c *deviceConfig) BoardSystemExtPrivatePrebuiltDirs() []string {
1560 return c.config.productVariables.BoardSystemExtPrivatePrebuiltDirs
1561}
1562
1563func (c *deviceConfig) BoardProductPublicPrebuiltDirs() []string {
1564 return c.config.productVariables.BoardProductPublicPrebuiltDirs
1565}
1566
1567func (c *deviceConfig) BoardProductPrivatePrebuiltDirs() []string {
1568 return c.config.productVariables.BoardProductPrivatePrebuiltDirs
1569}
1570
Inseob Kim1a0afcc2022-02-14 23:10:51 +09001571func (c *deviceConfig) SystemExtSepolicyPrebuiltApiDir() string {
1572 return String(c.config.productVariables.SystemExtSepolicyPrebuiltApiDir)
1573}
1574
1575func (c *deviceConfig) ProductSepolicyPrebuiltApiDir() string {
1576 return String(c.config.productVariables.ProductSepolicyPrebuiltApiDir)
1577}
1578
1579func (c *deviceConfig) IsPartnerTrebleSepolicyTestEnabled() bool {
1580 return c.SystemExtSepolicyPrebuiltApiDir() != "" || c.ProductSepolicyPrebuiltApiDir() != ""
1581}
1582
Inseob Kim7cf14652021-01-06 23:06:52 +09001583func (c *deviceConfig) DirectedVendorSnapshot() bool {
1584 return c.config.productVariables.DirectedVendorSnapshot
1585}
1586
1587func (c *deviceConfig) VendorSnapshotModules() map[string]bool {
1588 return c.config.productVariables.VendorSnapshotModules
1589}
1590
Jose Galmes4c6895e2021-02-09 07:44:30 -08001591func (c *deviceConfig) DirectedRecoverySnapshot() bool {
1592 return c.config.productVariables.DirectedRecoverySnapshot
1593}
1594
1595func (c *deviceConfig) RecoverySnapshotModules() map[string]bool {
1596 return c.config.productVariables.RecoverySnapshotModules
1597}
1598
Justin DeMartino383bfb32021-02-24 10:49:43 -08001599func createDirsMap(previous map[string]bool, dirs []string) (map[string]bool, error) {
1600 var ret = make(map[string]bool)
1601 for _, dir := range dirs {
1602 clean := filepath.Clean(dir)
1603 if previous[clean] || ret[clean] {
1604 return nil, fmt.Errorf("Duplicate entry %s", dir)
1605 }
1606 ret[clean] = true
1607 }
1608 return ret, nil
1609}
1610
1611func (c *deviceConfig) createDirsMapOnce(onceKey OnceKey, previous map[string]bool, dirs []string) map[string]bool {
1612 dirMap := c.Once(onceKey, func() interface{} {
1613 ret, err := createDirsMap(previous, dirs)
1614 if err != nil {
1615 panic(fmt.Errorf("%s: %w", onceKey.key, err))
1616 }
1617 return ret
1618 })
1619 if dirMap == nil {
1620 return nil
1621 }
1622 return dirMap.(map[string]bool)
1623}
1624
1625var vendorSnapshotDirsExcludedKey = NewOnceKey("VendorSnapshotDirsExcludedMap")
1626
1627func (c *deviceConfig) VendorSnapshotDirsExcludedMap() map[string]bool {
1628 return c.createDirsMapOnce(vendorSnapshotDirsExcludedKey, nil,
1629 c.config.productVariables.VendorSnapshotDirsExcluded)
1630}
1631
1632var vendorSnapshotDirsIncludedKey = NewOnceKey("VendorSnapshotDirsIncludedMap")
1633
1634func (c *deviceConfig) VendorSnapshotDirsIncludedMap() map[string]bool {
1635 excludedMap := c.VendorSnapshotDirsExcludedMap()
1636 return c.createDirsMapOnce(vendorSnapshotDirsIncludedKey, excludedMap,
1637 c.config.productVariables.VendorSnapshotDirsIncluded)
1638}
1639
1640var recoverySnapshotDirsExcludedKey = NewOnceKey("RecoverySnapshotDirsExcludedMap")
1641
1642func (c *deviceConfig) RecoverySnapshotDirsExcludedMap() map[string]bool {
1643 return c.createDirsMapOnce(recoverySnapshotDirsExcludedKey, nil,
1644 c.config.productVariables.RecoverySnapshotDirsExcluded)
1645}
1646
1647var recoverySnapshotDirsIncludedKey = NewOnceKey("RecoverySnapshotDirsIncludedMap")
1648
1649func (c *deviceConfig) RecoverySnapshotDirsIncludedMap() map[string]bool {
1650 excludedMap := c.RecoverySnapshotDirsExcludedMap()
1651 return c.createDirsMapOnce(recoverySnapshotDirsIncludedKey, excludedMap,
1652 c.config.productVariables.RecoverySnapshotDirsIncluded)
1653}
1654
Rob Seymour925aa092021-08-10 20:42:03 +00001655func (c *deviceConfig) HostFakeSnapshotEnabled() bool {
1656 return c.config.productVariables.HostFakeSnapshotEnabled
1657}
1658
Inseob Kim60c32f02020-12-21 22:53:05 +09001659func (c *deviceConfig) ShippingApiLevel() ApiLevel {
1660 if c.config.productVariables.ShippingApiLevel == nil {
1661 return NoneApiLevel
1662 }
1663 apiLevel, _ := strconv.Atoi(*c.config.productVariables.ShippingApiLevel)
1664 return uncheckedFinalApiLevel(apiLevel)
1665}
1666
Alix Espinoef47e542022-09-14 19:10:51 +00001667func (c *deviceConfig) BuildBrokenClangAsFlags() bool {
1668 return c.config.productVariables.BuildBrokenClangAsFlags
1669}
1670
1671func (c *deviceConfig) BuildBrokenClangCFlags() bool {
1672 return c.config.productVariables.BuildBrokenClangCFlags
1673}
1674
Alixb5f6d9e2022-04-20 23:00:58 +00001675func (c *deviceConfig) BuildBrokenClangProperty() bool {
1676 return c.config.productVariables.BuildBrokenClangProperty
1677}
1678
Inseob Kim67e5add2021-03-17 18:05:33 +09001679func (c *deviceConfig) BuildBrokenEnforceSyspropOwner() bool {
1680 return c.config.productVariables.BuildBrokenEnforceSyspropOwner
1681}
1682
1683func (c *deviceConfig) BuildBrokenTrebleSyspropNeverallow() bool {
1684 return c.config.productVariables.BuildBrokenTrebleSyspropNeverallow
1685}
1686
Hridya Valsaraju5a5c7d52021-04-02 16:45:24 -07001687func (c *deviceConfig) BuildDebugfsRestrictionsEnabled() bool {
1688 return c.config.productVariables.BuildDebugfsRestrictionsEnabled
1689}
1690
Inseob Kim0cac7b42021-02-03 18:16:46 +09001691func (c *deviceConfig) BuildBrokenVendorPropertyNamespace() bool {
1692 return c.config.productVariables.BuildBrokenVendorPropertyNamespace
1693}
1694
Liz Kammer619be462022-01-28 15:13:39 -05001695func (c *deviceConfig) BuildBrokenInputDir(name string) bool {
1696 return InList(name, c.config.productVariables.BuildBrokenInputDirModules)
1697}
1698
Vinh Tran140d5882022-06-10 14:23:27 -04001699func (c *deviceConfig) BuildBrokenDepfile() bool {
1700 return Bool(c.config.productVariables.BuildBrokenDepfile)
1701}
1702
Inseob Kim67e5add2021-03-17 18:05:33 +09001703func (c *deviceConfig) RequiresInsecureExecmemForSwiftshader() bool {
1704 return c.config.productVariables.RequiresInsecureExecmemForSwiftshader
1705}
1706
1707func (c *config) SelinuxIgnoreNeverallows() bool {
1708 return c.productVariables.SelinuxIgnoreNeverallows
1709}
1710
1711func (c *deviceConfig) SepolicySplit() bool {
1712 return c.config.productVariables.SepolicySplit
1713}
1714
Inseob Kima10ef272021-09-15 03:04:53 +00001715func (c *deviceConfig) SepolicyFreezeTestExtraDirs() []string {
1716 return c.config.productVariables.SepolicyFreezeTestExtraDirs
1717}
1718
1719func (c *deviceConfig) SepolicyFreezeTestExtraPrebuiltDirs() []string {
1720 return c.config.productVariables.SepolicyFreezeTestExtraPrebuiltDirs
1721}
1722
Jiyong Parkd163d4d2021-10-12 16:47:43 +09001723func (c *deviceConfig) GenerateAidlNdkPlatformBackend() bool {
1724 return c.config.productVariables.GenerateAidlNdkPlatformBackend
1725}
1726
Christopher Ferris98f10222022-07-13 23:16:52 -07001727func (c *config) IgnorePrefer32OnDevice() bool {
1728 return c.productVariables.IgnorePrefer32OnDevice
1729}
1730
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001731func (c *config) BootJars() []string {
1732 return c.Once(earlyBootJarsKey, func() interface{} {
Paul Duffin69d1fb12020-10-23 21:14:20 +01001733 list := c.productVariables.BootJars.CopyOfJars()
satayevd604b212021-07-21 14:23:52 +01001734 return append(list, c.productVariables.ApexBootJars.CopyOfJars()...)
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001735 }).([]string)
1736}
Paul Duffin9a89a2a2020-10-28 19:20:06 +00001737
satayevd604b212021-07-21 14:23:52 +01001738func (c *config) NonApexBootJars() ConfiguredJarList {
Paul Duffin9a89a2a2020-10-28 19:20:06 +00001739 return c.productVariables.BootJars
1740}
1741
satayevd604b212021-07-21 14:23:52 +01001742func (c *config) ApexBootJars() ConfiguredJarList {
1743 return c.productVariables.ApexBootJars
Paul Duffin9a89a2a2020-10-28 19:20:06 +00001744}
Colin Cross77cdcfd2021-03-12 11:28:25 -08001745
1746func (c *config) RBEWrapper() string {
1747 return c.GetenvWithDefault("RBE_WRAPPER", remoteexec.DefaultWrapperPath)
1748}
Colin Cross9b698b62021-12-22 09:55:32 -08001749
1750// UseHostMusl returns true if the host target has been configured to build against musl libc.
1751func (c *config) UseHostMusl() bool {
1752 return Bool(c.productVariables.HostMusl)
1753}
MarkDacekff851b82022-04-21 18:33:17 +00001754
Chris Parsonsf874e462022-05-10 13:50:12 -04001755func (c *config) LogMixedBuild(ctx BaseModuleContext, useBazel bool) {
MarkDacekff851b82022-04-21 18:33:17 +00001756 moduleName := ctx.Module().Name()
1757 c.mixedBuildsLock.Lock()
1758 defer c.mixedBuildsLock.Unlock()
1759 if useBazel {
1760 c.mixedBuildEnabledModules[moduleName] = struct{}{}
1761 } else {
1762 c.mixedBuildDisabledModules[moduleName] = struct{}{}
1763 }
1764}