blob: f312e2223b13fd97970058f8c1ed73f87b9d4163 [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 (
Colin Cross3f40fa42015-01-30 17:27:36 -080021 "encoding/json"
22 "fmt"
23 "os"
Colin Cross35cec122015-04-02 14:37:16 -070024 "path/filepath"
Sam Delmerico5c32bbf2022-01-20 20:15:02 +000025 "reflect"
Colin Cross3f40fa42015-01-30 17:27:36 -080026 "runtime"
Inseob Kim60c32f02020-12-21 22:53:05 +090027 "strconv"
Dan Willemsen34cc69e2015-09-23 15:26:20 -070028 "strings"
Colin Crossc1e86a32015-04-15 12:33:28 -070029 "sync"
Cole Faustd92430e2024-02-07 01:02:04 +000030 "unicode"
Colin Cross6ff51382015-12-17 16:39:19 -080031
Yu Liu67a28422024-03-05 00:36:31 +000032 "android/soong/shared"
33
Colin Cross98be1bb2019-12-13 20:41:13 -080034 "github.com/google/blueprint"
Colin Crosse87040b2017-12-11 15:52:26 -080035 "github.com/google/blueprint/bootstrap"
Colin Cross98be1bb2019-12-13 20:41:13 -080036 "github.com/google/blueprint/pathtools"
Colin Cross6ff51382015-12-17 16:39:19 -080037 "github.com/google/blueprint/proptools"
Colin Cross9d34f352019-11-22 16:03:51 -080038
39 "android/soong/android/soongconfig"
Liz Kammer09f947d2021-05-12 14:51:49 -040040 "android/soong/bazel"
Colin Cross77cdcfd2021-03-12 11:28:25 -080041 "android/soong/remoteexec"
Liz Kammer72beb342022-02-03 08:42:10 -050042 "android/soong/starlark_fmt"
Colin Cross3f40fa42015-01-30 17:27:36 -080043)
44
Jingwen Chenc711fec2020-11-22 23:52:50 -050045// Bool re-exports proptools.Bool for the android package.
Colin Cross6ff51382015-12-17 16:39:19 -080046var Bool = proptools.Bool
Jingwen Chenc711fec2020-11-22 23:52:50 -050047
48// String re-exports proptools.String for the android package.
Jack He8cc71432016-12-08 15:45:07 -080049var String = proptools.String
Jingwen Chenc711fec2020-11-22 23:52:50 -050050
51// StringDefault re-exports proptools.StringDefault for the android package.
Jeongik Cha219141c2020-08-06 23:00:37 +090052var StringDefault = proptools.StringDefault
Jiyong Park6a927c42020-01-21 02:03:43 +090053
Jingwen Chenc711fec2020-11-22 23:52:50 -050054// FutureApiLevelInt is a placeholder constant for unreleased API levels.
Dan Albert0b176c82020-07-23 16:43:25 -070055const FutureApiLevelInt = 10000
56
Spandan Das15da5882023-03-02 23:36:39 +000057// PrivateApiLevel represents the api level of SdkSpecPrivate (sdk_version: "")
58// This api_level exists to differentiate user-provided "" from "current" sdk_version
59// The differentiation is necessary to enable different validation rules for these two possible values.
60var PrivateApiLevel = ApiLevel{
61 value: "current", // The value is current since aidl expects `current` as the default (TestAidlFlagsWithMinSdkVersion)
62 number: FutureApiLevelInt + 1, // This is used to differentiate it from FutureApiLevel
63 isPreview: true,
64}
65
Jingwen Chenc711fec2020-11-22 23:52:50 -050066// FutureApiLevel represents unreleased API levels.
Dan Albert0b176c82020-07-23 16:43:25 -070067var FutureApiLevel = ApiLevel{
68 value: "current",
69 number: FutureApiLevelInt,
70 isPreview: true,
71}
Colin Cross6ff51382015-12-17 16:39:19 -080072
Jingwen Chenc4d91bc2020-11-24 22:59:26 -050073// The product variables file name, containing product config from Kati.
Dan Willemsen87b17d12015-07-14 00:39:06 -070074const productVariablesFileName = "soong.variables"
Colin Cross3f40fa42015-01-30 17:27:36 -080075
Colin Cross9272ade2016-08-17 15:24:12 -070076// A Config object represents the entire build configuration for Android.
Colin Crossc3c0a492015-04-10 15:43:55 -070077type Config struct {
78 *config
79}
80
Chris Parsonsad876012022-08-20 14:48:32 -040081type SoongBuildMode int
82
Sasha Smundakaf5ca922022-12-12 21:23:34 -080083type CmdArgs struct {
84 bootstrap.Args
Kiyoung Kima37d9ba2023-04-19 13:13:45 +090085 RunGoTests bool
86 OutDir string
87 SoongOutDir string
88 SoongVariables string
Sasha Smundakaf5ca922022-12-12 21:23:34 -080089
Colin Crossb63d7b32023-12-07 16:54:51 -080090 BazelQueryViewDir string
91 ModuleGraphFile string
92 ModuleActionsFile string
93 DocFile string
Sasha Smundakaf5ca922022-12-12 21:23:34 -080094
Jihoon Kang2a929ad2023-06-08 19:02:07 +000095 BuildFromSourceStub bool
MarkDacekf47e1422023-04-19 16:47:36 +000096
97 EnsureAllowlistIntegrity bool
Sasha Smundakaf5ca922022-12-12 21:23:34 -080098}
99
Chris Parsonsad876012022-08-20 14:48:32 -0400100// Build modes that soong_build can run as.
101const (
102 // Don't use bazel at all during module analysis.
103 AnalysisNoBazel SoongBuildMode = iota
104
Chris Parsonsad876012022-08-20 14:48:32 -0400105 // Generate BUILD files which faithfully represent the dependency graph of
106 // blueprint modules. Individual BUILD targets will not, however, faitfhully
107 // express build semantics.
108 GenerateQueryView
109
110 // Create a JSON representation of the module graph and exit.
111 GenerateModuleGraph
112
113 // Generate a documentation file for module type definitions and exit.
114 GenerateDocFile
Chris Parsonsad876012022-08-20 14:48:32 -0400115)
116
Inseob Kim8fa54da2024-03-19 16:48:59 +0900117const testKeyDir = "build/make/target/product/security"
118
Lukacs T. Berkib078ade2021-08-31 10:42:08 +0200119// SoongOutDir returns the build output directory for the configuration.
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200120func (c Config) SoongOutDir() string {
121 return c.soongOutDir
Jeff Gastonefc1b412017-03-29 17:29:06 -0700122}
123
Colin Cross31a67452023-11-02 16:57:08 -0700124// tempDir returns the path to out/soong/.temp, which is cleared at the beginning of every build.
125func (c Config) tempDir() string {
126 return shared.TempDirForOutDir(c.soongOutDir)
127}
128
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200129func (c Config) OutDir() string {
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200130 return c.outDir
Lukacs T. Berki89e9a162021-03-12 08:31:32 +0100131}
132
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200133func (c Config) RunGoTests() bool {
134 return c.runGoTests
135}
136
Lukacs T. Berki5f6cb1d2021-03-17 15:03:14 +0100137func (c Config) DebugCompilation() bool {
138 return false // Never compile Go code in the main build for debugging
139}
140
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200141func (c Config) Subninjas() []string {
142 return []string{}
143}
144
145func (c Config) PrimaryBuilderInvocations() []bootstrap.PrimaryBuilderInvocation {
146 return []bootstrap.PrimaryBuilderInvocation{}
147}
148
Paul Duffin74135582022-10-06 11:01:59 +0100149// RunningInsideUnitTest returns true if this code is being run as part of a Soong unit test.
150func (c Config) RunningInsideUnitTest() bool {
151 return c.config.TestProductVariables != nil
152}
153
Pratyushfaec4db2023-07-20 11:19:04 +0000154// DisableHiddenApiChecks returns true if hiddenapi checks have been disabled.
Alyssa Ketpreechasawat7daf2782023-11-01 13:58:39 +0000155// For 'eng' target variant hiddenapi checks are disabled by default for performance optimisation,
Pratyushfaec4db2023-07-20 11:19:04 +0000156// but can be enabled by setting environment variable ENABLE_HIDDENAPI_FLAGS=true.
157// For other target variants hiddenapi check are enabled by default but can be disabled by
158// setting environment variable UNSAFE_DISABLE_HIDDENAPI_FLAGS=true.
159// If both ENABLE_HIDDENAPI_FLAGS=true and UNSAFE_DISABLE_HIDDENAPI_FLAGS=true, then
160// ENABLE_HIDDENAPI_FLAGS=true will be triggered and hiddenapi checks will be considered enabled.
161func (c Config) DisableHiddenApiChecks() bool {
162 return !c.IsEnvTrue("ENABLE_HIDDENAPI_FLAGS") &&
163 (c.IsEnvTrue("UNSAFE_DISABLE_HIDDENAPI_FLAGS") ||
Alyssa Ketpreechasawat7daf2782023-11-01 13:58:39 +0000164 Bool(c.productVariables.Eng))
165}
166
167// DisableVerifyOverlaps returns true if verify_overlaps is skipped.
168// Mismatch in version of apexes and module SDK is required for mainline prebuilts to work in
169// trunk stable.
170// Thus, verify_overlaps is disabled when RELEASE_DEFAULT_MODULE_BUILD_FROM_SOURCE is set to false.
171// TODO(b/308174018): Re-enable verify_overlaps for both builr from source/mainline prebuilts.
172func (c Config) DisableVerifyOverlaps() bool {
Spandan Das07145102024-03-18 23:25:30 +0000173 if c.IsEnvFalse("DISABLE_VERIFY_OVERLAPS") && c.ReleaseDisableVerifyOverlaps() {
174 panic("The current release configuration does not support verify_overlaps. DISABLE_VERIFY_OVERLAPS cannot be set to false")
175 }
176 return c.IsEnvTrue("DISABLE_VERIFY_OVERLAPS") || c.ReleaseDisableVerifyOverlaps() || !c.ReleaseDefaultModuleBuildFromSource()
Pratyushfaec4db2023-07-20 11:19:04 +0000177}
178
Juan Yescas05d4d902023-04-07 10:35:35 -0700179// MaxPageSizeSupported returns the max page size supported by the device. This
180// value will define the ELF segment alignment for binaries (executables and
181// shared libraries).
182func (c Config) MaxPageSizeSupported() string {
183 return String(c.config.productVariables.DeviceMaxPageSizeSupported)
184}
185
Vilas Bhatb3d2d222023-12-04 22:51:20 +0000186// NoBionicPageSizeMacro returns true when AOSP is page size agnostic.
187// This means that the bionic's macro PAGE_SIZE won't be defined.
188// Returns false when AOSP is NOT page size agnostic.
189// This means that bionic's macro PAGE_SIZE is defined.
190func (c Config) NoBionicPageSizeMacro() bool {
191 return Bool(c.config.productVariables.DeviceNoBionicPageSizeMacro)
Juan Yescas01065602023-08-09 08:34:37 -0700192}
193
Joe Onoratofee845a2023-05-09 08:14:14 -0700194// The release version passed to aconfig, derived from RELEASE_VERSION
195func (c Config) ReleaseVersion() string {
196 return c.config.productVariables.ReleaseVersion
197}
198
Yu Liu2cc802a2023-09-05 17:19:45 -0700199// The aconfig value set passed to aconfig, derived from RELEASE_VERSION
Yu Liueebb2592023-10-12 20:31:27 -0700200func (c Config) ReleaseAconfigValueSets() []string {
Yu Liu95572ff2023-12-07 16:38:45 -0800201 return c.config.productVariables.ReleaseAconfigValueSets
Joe Onoratofee845a2023-05-09 08:14:14 -0700202}
203
Zhi Dou3f65a412023-08-10 21:47:40 +0000204// The flag default permission value passed to aconfig
205// derived from RELEASE_ACONFIG_FLAG_DEFAULT_PERMISSION
206func (c Config) ReleaseAconfigFlagDefaultPermission() string {
207 return c.config.productVariables.ReleaseAconfigFlagDefaultPermission
208}
209
Alyssa Ketpreechasawat34ab8792023-10-06 07:01:22 +0000210// The flag indicating behavior for the tree wrt building modules or using prebuilts
211// derived from RELEASE_DEFAULT_MODULE_BUILD_FROM_SOURCE
212func (c Config) ReleaseDefaultModuleBuildFromSource() bool {
213 return c.config.productVariables.ReleaseDefaultModuleBuildFromSource == nil ||
214 Bool(c.config.productVariables.ReleaseDefaultModuleBuildFromSource)
215}
216
Spandan Das07145102024-03-18 23:25:30 +0000217func (c Config) ReleaseDisableVerifyOverlaps() bool {
218 return c.config.productVariables.GetBuildFlagBool("RELEASE_DISABLE_VERIFY_OVERLAPS_CHECK")
219}
220
Jihoon Kang59198152024-02-06 22:43:18 +0000221// Enables flagged apis annotated with READ_WRITE aconfig flags to be included in the stubs
222// and hiddenapi flags so that they are accessible at runtime
223func (c Config) ReleaseExportRuntimeApis() bool {
Jihoon Kang35349462024-02-22 19:52:46 +0000224 return Bool(c.config.productVariables.ExportRuntimeApis)
Jihoon Kang59198152024-02-06 22:43:18 +0000225}
226
Aleksei Vetrov146e9822023-11-24 19:54:26 +0000227// Enables ABI monitoring of NDK libraries
228func (c Config) ReleaseNdkAbiMonitored() bool {
229 return c.config.productVariables.GetBuildFlagBool("RELEASE_NDK_ABI_MONITORED")
230}
231
Jihoon Kangbd093452023-12-26 19:08:01 +0000232func (c Config) ReleaseHiddenApiExportableStubs() bool {
Jihoon Kangb36fc542024-02-22 19:35:26 +0000233 return c.config.productVariables.GetBuildFlagBool("RELEASE_HIDDEN_API_EXPORTABLE_STUBS") ||
234 Bool(c.config.productVariables.HiddenapiExportableStubs)
Jihoon Kangbd093452023-12-26 19:08:01 +0000235}
236
Jingwen Chenc711fec2020-11-22 23:52:50 -0500237// A DeviceConfig object represents the configuration for a particular device
238// being built. For now there will only be one of these, but in the future there
239// may be multiple devices being built.
Colin Cross9272ade2016-08-17 15:24:12 -0700240type DeviceConfig struct {
241 *deviceConfig
242}
243
Jingwen Chenc711fec2020-11-22 23:52:50 -0500244// VendorConfig represents the configuration for vendor-specific behavior.
Colin Cross9d34f352019-11-22 16:03:51 -0800245type VendorConfig soongconfig.SoongConfig
Dan Willemsen0fe78662018-03-26 12:41:18 -0700246
Jingwen Chenc711fec2020-11-22 23:52:50 -0500247// Definition of general build configuration for soong_build. Some of these
Jingwen Chenc4d91bc2020-11-24 22:59:26 -0500248// product configuration values are read from Kati-generated soong.variables.
Colin Cross1332b002015-04-07 17:11:30 -0700249type config struct {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500250 // Options configurable with soong.variables
Cole Faustf8231dd2023-04-21 17:37:11 -0700251 productVariables ProductVariables
Colin Cross3f40fa42015-01-30 17:27:36 -0800252
Dan Willemsen674dc7f2018-03-12 18:06:05 -0700253 // Only available on configs created by TestConfig
Cole Faustf8231dd2023-04-21 17:37:11 -0700254 TestProductVariables *ProductVariables
Dan Willemsen674dc7f2018-03-12 18:06:05 -0700255
Dan Willemsen87b17d12015-07-14 00:39:06 -0700256 ProductVariablesFileName string
257
Colin Cross0c66bc62021-07-20 09:47:41 -0700258 // BuildOS stores the OsType for the OS that the build is running on.
259 BuildOS OsType
260
261 // BuildArch stores the ArchType for the CPU that the build is running on.
262 BuildArch ArchType
263
Jaewoong Jung642916f2020-10-09 17:25:15 -0700264 Targets map[OsType][]Target
265 BuildOSTarget Target // the Target for tools run on the build machine
266 BuildOSCommonTarget Target // the Target for common (java) tools run on the build machine
267 AndroidCommonTarget Target // the Target for common modules for the Android device
268 AndroidFirstDeviceTarget Target // the first Target for modules for the Android device
Dan Willemsen218f6562015-07-08 18:13:11 -0700269
Jingwen Chenc711fec2020-11-22 23:52:50 -0500270 // multilibConflicts for an ArchType is true if there is earlier configured
271 // device architecture with the same multilib value.
Colin Cross3b19f5d2019-09-17 14:45:31 -0700272 multilibConflicts map[ArchType]bool
273
Colin Cross9272ade2016-08-17 15:24:12 -0700274 deviceConfig *deviceConfig
275
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200276 outDir string // The output directory (usually out/)
277 soongOutDir string
Chris Parsons8f232a22020-06-23 17:37:05 -0400278 moduleListFile string // the path to the file which lists blueprint files to parse.
Colin Crossc1e86a32015-04-15 12:33:28 -0700279
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +0200280 runGoTests bool
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200281
Colin Cross6ccbc912017-10-10 23:07:38 -0700282 env map[string]string
Dan Willemsene7680ba2015-09-11 17:06:19 -0700283 envLock sync.Mutex
284 envDeps map[string]string
285 envFrozen bool
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800286
Jingwen Chencda22c92020-11-23 00:22:30 -0500287 // Changes behavior based on whether Kati runs after soong_build, or if soong_build
288 // runs standalone.
289 katiEnabled bool
Colin Cross1e7d3702016-08-24 15:25:47 -0700290
Colin Cross32616ed2017-09-05 21:56:44 -0700291 captureBuild bool // true for tests, saves build parameters for each module
292 ignoreEnvironment bool // true for tests, returns empty from all Getenv calls
Colin Crosscec81712017-07-13 14:43:27 -0700293
Colin Cross98be1bb2019-12-13 20:41:13 -0800294 fs pathtools.FileSystem
295 mockBpList string
296
Colin Crossb63d7b32023-12-07 16:54:51 -0800297 BuildMode SoongBuildMode
Jingwen Chen12b4c272021-03-10 02:05:59 -0500298
Colin Cross5e6a7972020-06-07 16:56:32 -0700299 // If testAllowNonExistentPaths is true then PathForSource and PathForModuleSrc won't error
300 // in tests when a path doesn't exist.
Pedro Loureiro5d190cc2021-02-15 15:41:33 +0000301 TestAllowNonExistentPaths bool
Colin Cross5e6a7972020-06-07 16:56:32 -0700302
Jingwen Chenc711fec2020-11-22 23:52:50 -0500303 // The list of files that when changed, must invalidate soong_build to
304 // regenerate build.ninja.
Colin Cross12129292020-10-29 18:23:58 -0700305 ninjaFileDepsSet sync.Map
306
Colin Cross9272ade2016-08-17 15:24:12 -0700307 OncePer
MarkDacekff851b82022-04-21 18:33:17 +0000308
Jihoon Kang2a929ad2023-06-08 19:02:07 +0000309 // If buildFromSourceStub is true then the Java API stubs are
310 // built from the source Java files, not the signature text files.
311 buildFromSourceStub bool
MarkDacekf47e1422023-04-19 16:47:36 +0000312
313 // If ensureAllowlistIntegrity is true, then the presence of any allowlisted
314 // modules that aren't mixed-built for at least one variant will cause a build
315 // failure
316 ensureAllowlistIntegrity bool
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000317
318 // List of Api libraries that contribute to Api surfaces.
319 apiLibraries map[string]struct{}
Colin Cross9272ade2016-08-17 15:24:12 -0700320}
321
322type deviceConfig struct {
Dan Willemsen00269f22017-07-06 16:59:48 -0700323 config *config
Colin Cross9272ade2016-08-17 15:24:12 -0700324 OncePer
Colin Cross3f40fa42015-01-30 17:27:36 -0800325}
326
Colin Cross485e5722015-08-27 13:28:01 -0700327type jsonConfigurable interface {
Colin Cross27385972015-09-18 10:57:10 -0700328 SetDefaultConfig()
Colin Cross485e5722015-08-27 13:28:01 -0700329}
Colin Cross3f40fa42015-01-30 17:27:36 -0800330
Colin Cross485e5722015-08-27 13:28:01 -0700331func loadConfig(config *config) error {
Colin Cross988414c2020-01-11 01:11:46 +0000332 return loadFromConfigFile(&config.productVariables, absolutePath(config.ProductVariablesFileName))
Colin Cross485e5722015-08-27 13:28:01 -0700333}
334
Cole Faustd92430e2024-02-07 01:02:04 +0000335// Checks if the string is a valid go identifier. This is equivalent to blueprint's definition
336// of an identifier, so it will match the same identifiers as those that can be used in bp files.
337func isGoIdentifier(ident string) bool {
338 for i, r := range ident {
339 valid := r == '_' || unicode.IsLetter(r) || unicode.IsDigit(r) && i > 0
340 if !valid {
341 return false
342 }
343 }
344 return len(ident) > 0
345}
346
Jingwen Chenc711fec2020-11-22 23:52:50 -0500347// loadFromConfigFile loads and decodes configuration options from a JSON file
348// in the current working directory.
Cole Faustf8231dd2023-04-21 17:37:11 -0700349func loadFromConfigFile(configurable *ProductVariables, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800350 // Try to open the file
Colin Cross485e5722015-08-27 13:28:01 -0700351 configFileReader, err := os.Open(filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800352 defer configFileReader.Close()
353 if os.IsNotExist(err) {
354 // Need to create a file, so that blueprint & ninja don't get in
355 // a dependency tracking loop.
356 // Make a file-configurable-options with defaults, write it out using
357 // a json writer.
Colin Cross27385972015-09-18 10:57:10 -0700358 configurable.SetDefaultConfig()
359 err = saveToConfigFile(configurable, filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800360 if err != nil {
361 return err
362 }
Colin Cross15cd21a2018-02-27 11:26:02 -0800363 } else if err != nil {
364 return fmt.Errorf("config file: could not open %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800365 } else {
366 // Make a decoder for it
367 jsonDecoder := json.NewDecoder(configFileReader)
Colin Cross485e5722015-08-27 13:28:01 -0700368 err = jsonDecoder.Decode(configurable)
Colin Cross3f40fa42015-01-30 17:27:36 -0800369 if err != nil {
Colin Cross15cd21a2018-02-27 11:26:02 -0800370 return fmt.Errorf("config file: %s did not parse correctly: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800371 }
372 }
373
Liz Kammer09f947d2021-05-12 14:51:49 -0400374 if Bool(configurable.GcovCoverage) && Bool(configurable.ClangCoverage) {
375 return fmt.Errorf("GcovCoverage and ClangCoverage cannot both be set")
376 }
377
378 configurable.Native_coverage = proptools.BoolPtr(
379 Bool(configurable.GcovCoverage) ||
380 Bool(configurable.ClangCoverage))
381
Cole Faustd92430e2024-02-07 01:02:04 +0000382 // The go scanner's definition of identifiers is c-style identifiers, but allowing unicode's
383 // definition of letters and digits. This is the same scanner that blueprint uses, so it
384 // will allow the same identifiers as are valid in bp files.
385 for namespace := range configurable.VendorVars {
386 if !isGoIdentifier(namespace) {
387 return fmt.Errorf("soong config namespaces must be valid identifiers: %q", namespace)
388 }
389 for variable := range configurable.VendorVars[namespace] {
390 if !isGoIdentifier(variable) {
391 return fmt.Errorf("soong config variables must be valid identifiers: %q", variable)
392 }
393 }
394 }
395
Yuntao Xu402e9b02021-08-09 15:44:44 -0700396 // when Platform_sdk_final is true (or PLATFORM_VERSION_CODENAME is REL), use Platform_sdk_version;
397 // if false (pre-released version, for example), use Platform_sdk_codename.
398 if Bool(configurable.Platform_sdk_final) {
399 if configurable.Platform_sdk_version != nil {
400 configurable.Platform_sdk_version_or_codename =
401 proptools.StringPtr(strconv.Itoa(*(configurable.Platform_sdk_version)))
402 } else {
403 return fmt.Errorf("Platform_sdk_version cannot be pointed by a NULL pointer")
404 }
405 } else {
406 configurable.Platform_sdk_version_or_codename =
407 proptools.StringPtr(String(configurable.Platform_sdk_codename))
408 }
409
Liz Kammer09f947d2021-05-12 14:51:49 -0400410 return saveToBazelConfigFile(configurable, filepath.Dir(filename))
Colin Cross3f40fa42015-01-30 17:27:36 -0800411}
412
Colin Crossd8f20142016-11-03 09:43:26 -0700413// atomically writes the config file in case two copies of soong_build are running simultaneously
414// (for example, docs generation and ninja manifest generation)
Cole Faustf8231dd2023-04-21 17:37:11 -0700415func saveToConfigFile(config *ProductVariables, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800416 data, err := json.MarshalIndent(&config, "", " ")
417 if err != nil {
418 return fmt.Errorf("cannot marshal config data: %s", err.Error())
419 }
420
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800421 f, err := os.CreateTemp(filepath.Dir(filename), "config")
Colin Cross3f40fa42015-01-30 17:27:36 -0800422 if err != nil {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500423 return fmt.Errorf("cannot create empty config file %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800424 }
Colin Crossd8f20142016-11-03 09:43:26 -0700425 defer os.Remove(f.Name())
426 defer f.Close()
Colin Cross3f40fa42015-01-30 17:27:36 -0800427
Colin Crossd8f20142016-11-03 09:43:26 -0700428 _, err = f.Write(data)
Colin Cross3f40fa42015-01-30 17:27:36 -0800429 if err != nil {
Colin Cross485e5722015-08-27 13:28:01 -0700430 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
431 }
432
Colin Crossd8f20142016-11-03 09:43:26 -0700433 _, err = f.WriteString("\n")
Colin Cross485e5722015-08-27 13:28:01 -0700434 if err != nil {
435 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800436 }
437
Colin Crossd8f20142016-11-03 09:43:26 -0700438 f.Close()
439 os.Rename(f.Name(), filename)
440
Colin Cross3f40fa42015-01-30 17:27:36 -0800441 return nil
442}
443
Cole Faust87c0c332023-07-31 12:10:12 -0700444type productVariableStarlarkRepresentation struct {
445 soongType string
446 selectable bool
447 archVariant bool
448}
449
Cole Faustf8231dd2023-04-21 17:37:11 -0700450func saveToBazelConfigFile(config *ProductVariables, outDir string) error {
Liz Kammer09f947d2021-05-12 14:51:49 -0400451 dir := filepath.Join(outDir, bazel.SoongInjectionDirName, "product_config")
452 err := createDirIfNonexistent(dir, os.ModePerm)
453 if err != nil {
454 return fmt.Errorf("Could not create dir %s: %s", dir, err)
455 }
456
Cole Faust87c0c332023-07-31 12:10:12 -0700457 allProductVariablesType := reflect.TypeOf((*ProductVariables)(nil)).Elem()
458 productVariablesInfo := make(map[string]productVariableStarlarkRepresentation)
Sam Delmerico5c32bbf2022-01-20 20:15:02 +0000459 p := variableProperties{}
460 t := reflect.TypeOf(p.Product_variables)
461 for i := 0; i < t.NumField(); i++ {
462 f := t.Field(i)
Cole Faust87c0c332023-07-31 12:10:12 -0700463 archVariant := proptools.HasTag(f, "android", "arch_variant")
464 if mainProductVariablesStructField, ok := allProductVariablesType.FieldByName(f.Name); ok {
465 productVariablesInfo[f.Name] = productVariableStarlarkRepresentation{
466 soongType: stringRepresentationOfSimpleType(mainProductVariablesStructField.Type),
467 selectable: true,
468 archVariant: archVariant,
469 }
470 } else {
471 panic("Unknown variable " + f.Name)
Sam Delmerico5c32bbf2022-01-20 20:15:02 +0000472 }
473 }
474
Cole Fausteb644cf2023-04-11 13:48:17 -0700475 err = pathtools.WriteFileIfChanged(filepath.Join(dir, "product_variable_constants.bzl"), []byte(fmt.Sprintf(`
Cole Faust87c0c332023-07-31 12:10:12 -0700476# product_var_constant_info is a map of product variables to information about them. The fields are:
477# - soongType: The type of the product variable as it appears in soong's ProductVariables struct.
478# examples are string, bool, int, *bool, *string, []string, etc. This may be an overly
479# conservative estimation of the type, for example a *bool could oftentimes just be a
480# bool that defaults to false.
481# - selectable: if this product variable can be selected on in Android.bp/build files. This means
482# it's listed in the "variableProperties" soong struct. Currently all variables in
483# this list are selectable because we only need the selectable ones at the moment,
484# but the list may be expanded later.
485# - archVariant: If the variable is tagged as arch variant in the "variableProperties" struct.
486product_var_constant_info = %s
487product_var_constraints = [k for k, v in product_var_constant_info.items() if v.selectable]
488arch_variant_product_var_constraints = [k for k, v in product_var_constant_info.items() if v.selectable and v.archVariant]
489`, starlark_fmt.PrintAny(productVariablesInfo, 0))), 0644)
Cole Fausteb644cf2023-04-11 13:48:17 -0700490 if err != nil {
491 return fmt.Errorf("Could not write .bzl config file %s", err)
492 }
Chris Parsons0008cf82023-02-03 18:45:43 -0500493 err = pathtools.WriteFileIfChanged(filepath.Join(dir, "BUILD"),
494 []byte(bazel.GeneratedBazelFileWarning), 0644)
Liz Kammer09f947d2021-05-12 14:51:49 -0400495 if err != nil {
496 return fmt.Errorf("Could not write BUILD config file %s", err)
497 }
498
499 return nil
500}
501
Cole Faust87c0c332023-07-31 12:10:12 -0700502func stringRepresentationOfSimpleType(ty reflect.Type) string {
503 switch ty.Kind() {
504 case reflect.String:
505 return "string"
506 case reflect.Bool:
507 return "bool"
508 case reflect.Int:
509 return "int"
510 case reflect.Slice:
511 return "[]" + stringRepresentationOfSimpleType(ty.Elem())
512 case reflect.Pointer:
513 return "*" + stringRepresentationOfSimpleType(ty.Elem())
514 default:
515 panic("unimplemented type: " + ty.Kind().String())
516 }
517}
518
Colin Cross988414c2020-01-11 01:11:46 +0000519// NullConfig returns a mostly empty Config for use by standalone tools like dexpreopt_gen that
520// use the android package.
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200521func NullConfig(outDir, soongOutDir string) Config {
Colin Cross988414c2020-01-11 01:11:46 +0000522 return Config{
523 config: &config{
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200524 outDir: outDir,
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200525 soongOutDir: soongOutDir,
526 fs: pathtools.OsFs,
Colin Cross988414c2020-01-11 01:11:46 +0000527 },
528 }
529}
530
Jingwen Chenc711fec2020-11-22 23:52:50 -0500531// NewConfig creates a new Config object. The srcDir argument specifies the path
532// to the root source directory. It also loads the config file, if found.
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800533func NewConfig(cmdArgs CmdArgs, availableEnv map[string]string) (Config, error) {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500534 // Make a config with default options.
Colin Cross9272ade2016-08-17 15:24:12 -0700535 config := &config{
Kiyoung Kima37d9ba2023-04-19 13:13:45 +0900536 ProductVariablesFileName: cmdArgs.SoongVariables,
Dan Willemsen87b17d12015-07-14 00:39:06 -0700537
Lukacs T. Berki53b2f362021-04-12 14:04:24 +0200538 env: availableEnv,
Colin Cross6ccbc912017-10-10 23:07:38 -0700539
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800540 outDir: cmdArgs.OutDir,
541 soongOutDir: cmdArgs.SoongOutDir,
542 runGoTests: cmdArgs.RunGoTests,
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +0200543 multilibConflicts: make(map[ArchType]bool),
Colin Cross98be1bb2019-12-13 20:41:13 -0800544
Colin Crossb63d7b32023-12-07 16:54:51 -0800545 moduleListFile: cmdArgs.ModuleListFile,
546 fs: pathtools.NewOsFs(absSrcDir),
Chris Parsons9402ca82023-02-23 17:28:06 -0500547
Jihoon Kang2a929ad2023-06-08 19:02:07 +0000548 buildFromSourceStub: cmdArgs.BuildFromSourceStub,
Colin Cross68f55102015-03-25 14:43:57 -0700549 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800550
Dan Willemsen00269f22017-07-06 16:59:48 -0700551 config.deviceConfig = &deviceConfig{
Colin Cross9272ade2016-08-17 15:24:12 -0700552 config: config,
553 }
554
Liz Kammer7941b302020-07-28 13:27:34 -0700555 // Soundness check of the build and source directories. This won't catch strange
556 // configurations with symlinks, but at least checks the obvious case.
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800557 absBuildDir, err := filepath.Abs(cmdArgs.SoongOutDir)
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700558 if err != nil {
559 return Config{}, err
560 }
561
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200562 absSrcDir, err := filepath.Abs(".")
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700563 if err != nil {
564 return Config{}, err
565 }
566
567 if strings.HasPrefix(absSrcDir, absBuildDir) {
568 return Config{}, fmt.Errorf("Build dir must not contain source directory")
569 }
570
Colin Cross3f40fa42015-01-30 17:27:36 -0800571 // Load any configurable options from the configuration file
Colin Cross9272ade2016-08-17 15:24:12 -0700572 err = loadConfig(config)
Colin Cross3f40fa42015-01-30 17:27:36 -0800573 if err != nil {
Colin Crossc3c0a492015-04-10 15:43:55 -0700574 return Config{}, err
Colin Cross3f40fa42015-01-30 17:27:36 -0800575 }
576
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800577 KatiEnabledMarkerFile := filepath.Join(cmdArgs.SoongOutDir, ".soong.kati_enabled")
Jingwen Chencda22c92020-11-23 00:22:30 -0500578 if _, err := os.Stat(absolutePath(KatiEnabledMarkerFile)); err == nil {
579 config.katiEnabled = true
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800580 }
581
Colin Cross0c66bc62021-07-20 09:47:41 -0700582 determineBuildOS(config)
583
Jingwen Chenc711fec2020-11-22 23:52:50 -0500584 // Sets up the map of target OSes to the finer grained compilation targets
585 // that are configured from the product variables.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700586 targets, err := decodeTargetProductVariables(config)
Dan Willemsen218f6562015-07-08 18:13:11 -0700587 if err != nil {
588 return Config{}, err
589 }
590
Paul Duffin1356d8c2020-02-25 19:26:33 +0000591 // Make the CommonOS OsType available for all products.
592 targets[CommonOS] = []Target{commonTargetMap[CommonOS.Name]}
593
Dan Albert4098deb2016-10-19 14:04:41 -0700594 var archConfig []archConfig
Jingwen Chenc4d91bc2020-11-24 22:59:26 -0500595 if config.NdkAbis() {
Dan Albert4098deb2016-10-19 14:04:41 -0700596 archConfig = getNdkAbisConfig()
Martin Stjernholmc1ecc432019-11-15 15:00:31 +0000597 } else if config.AmlAbis() {
598 archConfig = getAmlAbisConfig()
Dan Albert4098deb2016-10-19 14:04:41 -0700599 }
600
601 if archConfig != nil {
Liz Kammerb7f33662022-02-28 14:16:16 -0500602 androidTargets, err := decodeAndroidArchSettings(archConfig)
Dan Willemsen322acaf2016-01-12 23:07:05 -0800603 if err != nil {
604 return Config{}, err
605 }
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700606 targets[Android] = androidTargets
Dan Willemsen322acaf2016-01-12 23:07:05 -0800607 }
608
Colin Cross3b19f5d2019-09-17 14:45:31 -0700609 multilib := make(map[string]bool)
610 for _, target := range targets[Android] {
611 if seen := multilib[target.Arch.ArchType.Multilib]; seen {
612 config.multilibConflicts[target.Arch.ArchType] = true
613 }
614 multilib[target.Arch.ArchType.Multilib] = true
615 }
616
Jingwen Chenc711fec2020-11-22 23:52:50 -0500617 // Map of OS to compilation targets.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700618 config.Targets = targets
Jingwen Chenc711fec2020-11-22 23:52:50 -0500619
620 // Compilation targets for host tools.
Colin Cross0c66bc62021-07-20 09:47:41 -0700621 config.BuildOSTarget = config.Targets[config.BuildOS][0]
622 config.BuildOSCommonTarget = getCommonTargets(config.Targets[config.BuildOS])[0]
Jingwen Chenc711fec2020-11-22 23:52:50 -0500623
624 // Compilation targets for Android.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700625 if len(config.Targets[Android]) > 0 {
626 config.AndroidCommonTarget = getCommonTargets(config.Targets[Android])[0]
Sam Delmericocc271e22022-06-01 15:45:02 +0000627 config.AndroidFirstDeviceTarget = FirstTarget(config.Targets[Android], "lib64", "lib32")[0]
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700628 }
Dan Willemsen218f6562015-07-08 18:13:11 -0700629
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500630 setBuildMode := func(arg string, mode SoongBuildMode) {
631 if arg != "" {
632 if config.BuildMode != AnalysisNoBazel {
633 fmt.Fprintf(os.Stderr, "buildMode is already set, illegal argument: %s", arg)
634 os.Exit(1)
635 }
636 config.BuildMode = mode
637 }
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800638 }
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500639 setBuildMode(cmdArgs.BazelQueryViewDir, GenerateQueryView)
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500640 setBuildMode(cmdArgs.ModuleGraphFile, GenerateModuleGraph)
641 setBuildMode(cmdArgs.DocFile, GenerateDocFile)
MarkDacekd06db5d2022-11-29 00:47:59 +0000642
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000643 // TODO(b/276958307): Replace the hardcoded list to a sdk_library local prop.
644 config.apiLibraries = map[string]struct{}{
645 "android.net.ipsec.ike": {},
646 "art.module.public.api": {},
647 "conscrypt.module.public.api": {},
648 "framework-adservices": {},
649 "framework-appsearch": {},
650 "framework-bluetooth": {},
Jihoon Kang480943f2023-05-19 06:02:08 +0000651 "framework-configinfrastructure": {},
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000652 "framework-connectivity": {},
653 "framework-connectivity-t": {},
Jihoon Kang480943f2023-05-19 06:02:08 +0000654 "framework-devicelock": {},
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000655 "framework-graphics": {},
Jihoon Kang480943f2023-05-19 06:02:08 +0000656 "framework-healthfitness": {},
Mark White387a6582023-08-06 00:20:47 +0000657 "framework-location": {},
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000658 "framework-media": {},
659 "framework-mediaprovider": {},
Roshan Pius92307ff2023-11-13 17:16:35 -0800660 "framework-nfc": {},
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000661 "framework-ondevicepersonalization": {},
Alyssa Ketpreechasawat9f634362023-11-08 16:03:53 +0000662 "framework-pdf": {},
Nishant Panwar0ce94652024-02-10 09:02:15 +0000663 "framework-pdf-v": {},
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000664 "framework-permission": {},
665 "framework-permission-s": {},
666 "framework-scheduling": {},
667 "framework-sdkextensions": {},
668 "framework-statsd": {},
669 "framework-sdksandbox": {},
670 "framework-tethering": {},
671 "framework-uwb": {},
672 "framework-virtualization": {},
673 "framework-wifi": {},
674 "i18n.module.public.api": {},
675 }
676
Jihoon Kangc1b04d62023-11-16 19:07:04 +0000677 config.productVariables.Build_from_text_stub = boolPtr(config.BuildFromTextStub())
678
Jingwen Chenc711fec2020-11-22 23:52:50 -0500679 return Config{config}, err
680}
Colin Cross988414c2020-01-11 01:11:46 +0000681
Colin Cross98be1bb2019-12-13 20:41:13 -0800682// mockFileSystem replaces all reads with accesses to the provided map of
683// filenames to contents stored as a byte slice.
684func (c *config) mockFileSystem(bp string, fs map[string][]byte) {
685 mockFS := map[string][]byte{}
686
687 if _, exists := mockFS["Android.bp"]; !exists {
688 mockFS["Android.bp"] = []byte(bp)
689 }
690
691 for k, v := range fs {
692 mockFS[k] = v
693 }
694
695 // no module list file specified; find every file named Blueprints or Android.bp
696 pathsToParse := []string{}
697 for candidate := range mockFS {
698 base := filepath.Base(candidate)
Lukacs T. Berkib838b0a2021-09-02 11:46:24 +0200699 if base == "Android.bp" {
Colin Cross98be1bb2019-12-13 20:41:13 -0800700 pathsToParse = append(pathsToParse, candidate)
701 }
702 }
703 if len(pathsToParse) < 1 {
704 panic(fmt.Sprintf("No Blueprint or Android.bp files found in mock filesystem: %v\n", mockFS))
705 }
706 mockFS[blueprint.MockModuleListFile] = []byte(strings.Join(pathsToParse, "\n"))
707
708 c.fs = pathtools.MockFs(mockFS)
709 c.mockBpList = blueprint.MockModuleListFile
710}
711
Lukacs T. Berkid1e3f1f2021-03-16 08:55:23 +0100712func (c *config) SetAllowMissingDependencies() {
713 c.productVariables.Allow_missing_dependencies = proptools.BoolPtr(true)
714}
715
Jingwen Chenc711fec2020-11-22 23:52:50 -0500716// BlueprintToolLocation returns the directory containing build system tools
717// from Blueprint, like soong_zip and merge_zips.
Lukacs T. Berkia806e412021-09-01 08:57:48 +0200718func (c *config) HostToolDir() string {
Colin Crossacfcc1f2021-10-25 15:40:32 -0700719 if c.KatiEnabled() {
720 return filepath.Join(c.outDir, "host", c.PrebuiltOS(), "bin")
721 } else {
722 return filepath.Join(c.soongOutDir, "host", c.PrebuiltOS(), "bin")
723 }
Dan Willemsenc2aa4a92016-05-26 15:13:03 -0700724}
725
Dan Willemsen60e62f02018-11-16 21:05:32 -0800726func (c *config) HostToolPath(ctx PathContext, tool string) Path {
Cole Faust3b703f32023-10-16 13:30:51 -0700727 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "bin", tool)
Colin Cross790ef352021-10-25 19:15:55 -0700728 return path
Dan Willemsen60e62f02018-11-16 21:05:32 -0800729}
730
Colin Cross790ef352021-10-25 19:15:55 -0700731func (c *config) HostJNIToolPath(ctx PathContext, lib string) Path {
Martin Stjernholm7260d062019-12-09 21:47:14 +0000732 ext := ".so"
733 if runtime.GOOS == "darwin" {
734 ext = ".dylib"
735 }
Cole Faust3b703f32023-10-16 13:30:51 -0700736 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "lib64", lib+ext)
Colin Cross790ef352021-10-25 19:15:55 -0700737 return path
Martin Stjernholm7260d062019-12-09 21:47:14 +0000738}
739
Colin Crossae5330a2021-11-03 13:31:22 -0700740func (c *config) HostJavaToolPath(ctx PathContext, tool string) Path {
Cole Faust3b703f32023-10-16 13:30:51 -0700741 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "framework", tool)
Colin Cross3e3eda62021-11-04 10:22:51 -0700742 return path
743}
744
Vinh Tran09581952023-05-16 16:03:20 -0400745func (c *config) HostCcSharedLibPath(ctx PathContext, lib string) Path {
746 libDir := "lib"
747 if ctx.Config().BuildArch.Multilib == "lib64" {
748 libDir = "lib64"
749 }
Cole Faust3b703f32023-10-16 13:30:51 -0700750 return pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, libDir, lib+".so")
Vinh Tran09581952023-05-16 16:03:20 -0400751}
752
Jingwen Chenc711fec2020-11-22 23:52:50 -0500753// PrebuiltOS returns the name of the host OS used in prebuilts directories.
Colin Cross1332b002015-04-07 17:11:30 -0700754func (c *config) PrebuiltOS() string {
Colin Cross3f40fa42015-01-30 17:27:36 -0800755 switch runtime.GOOS {
756 case "linux":
757 return "linux-x86"
758 case "darwin":
759 return "darwin-x86"
760 default:
761 panic("Unknown GOOS")
762 }
763}
764
765// GoRoot returns the path to the root directory of the Go toolchain.
Colin Cross1332b002015-04-07 17:11:30 -0700766func (c *config) GoRoot() string {
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200767 return fmt.Sprintf("prebuilts/go/%s", c.PrebuiltOS())
Colin Cross3f40fa42015-01-30 17:27:36 -0800768}
769
Jingwen Chenc711fec2020-11-22 23:52:50 -0500770// PrebuiltBuildTool returns the path to a tool in the prebuilts directory containing
771// checked-in tools, like Kati, Ninja or Toybox, for the current host OS.
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700772func (c *config) PrebuiltBuildTool(ctx PathContext, tool string) Path {
773 return PathForSource(ctx, "prebuilts/build-tools", c.PrebuiltOS(), "bin", tool)
774}
775
Jingwen Chenc711fec2020-11-22 23:52:50 -0500776// CpPreserveSymlinksFlags returns the host-specific flag for the cp(1) command
777// to preserve symlinks.
Colin Cross1332b002015-04-07 17:11:30 -0700778func (c *config) CpPreserveSymlinksFlags() string {
Colin Cross485e5722015-08-27 13:28:01 -0700779 switch runtime.GOOS {
Colin Cross3f40fa42015-01-30 17:27:36 -0800780 case "darwin":
781 return "-R"
782 case "linux":
783 return "-d"
784 default:
785 return ""
786 }
787}
Colin Cross68f55102015-03-25 14:43:57 -0700788
Colin Cross1332b002015-04-07 17:11:30 -0700789func (c *config) Getenv(key string) string {
Colin Cross68f55102015-03-25 14:43:57 -0700790 var val string
791 var exists bool
Colin Crossc1e86a32015-04-15 12:33:28 -0700792 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800793 defer c.envLock.Unlock()
794 if c.envDeps == nil {
795 c.envDeps = make(map[string]string)
796 }
Colin Cross68f55102015-03-25 14:43:57 -0700797 if val, exists = c.envDeps[key]; !exists {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700798 if c.envFrozen {
799 panic("Cannot access new environment variables after envdeps are frozen")
800 }
Colin Cross6ccbc912017-10-10 23:07:38 -0700801 val, _ = c.env[key]
Colin Cross68f55102015-03-25 14:43:57 -0700802 c.envDeps[key] = val
803 }
804 return val
805}
806
Colin Cross99d7c232016-11-23 16:52:04 -0800807func (c *config) GetenvWithDefault(key string, defaultValue string) string {
808 ret := c.Getenv(key)
809 if ret == "" {
810 return defaultValue
811 }
812 return ret
813}
814
815func (c *config) IsEnvTrue(key string) bool {
816 value := c.Getenv(key)
817 return value == "1" || value == "y" || value == "yes" || value == "on" || value == "true"
818}
819
820func (c *config) IsEnvFalse(key string) bool {
821 value := c.Getenv(key)
822 return value == "0" || value == "n" || value == "no" || value == "off" || value == "false"
823}
824
Jingwen Chenc711fec2020-11-22 23:52:50 -0500825// EnvDeps returns the environment variables this build depends on. The first
826// call to this function blocks future reads from the environment.
Colin Cross1332b002015-04-07 17:11:30 -0700827func (c *config) EnvDeps() map[string]string {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700828 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800829 defer c.envLock.Unlock()
Dan Willemsene7680ba2015-09-11 17:06:19 -0700830 c.envFrozen = true
Colin Cross68f55102015-03-25 14:43:57 -0700831 return c.envDeps
832}
Colin Cross35cec122015-04-02 14:37:16 -0700833
Jingwen Chencda22c92020-11-23 00:22:30 -0500834func (c *config) KatiEnabled() bool {
835 return c.katiEnabled
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800836}
837
Cole Faust11edf552023-10-13 11:32:14 -0700838func (c *config) ProductVariables() ProductVariables {
839 return c.productVariables
840}
841
Nan Zhang581fd212018-01-10 16:06:12 -0800842func (c *config) BuildId() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800843 return String(c.productVariables.BuildId)
Nan Zhang581fd212018-01-10 16:06:12 -0800844}
845
Inseob Kim8fa54da2024-03-19 16:48:59 +0900846func (c *config) DisplayBuildNumber() bool {
847 return Bool(c.productVariables.DisplayBuildNumber)
848}
849
Jingwen Chenc711fec2020-11-22 23:52:50 -0500850// BuildNumberFile returns the path to a text file containing metadata
851// representing the current build's number.
852//
853// Rules that want to reference the build number should read from this file
854// without depending on it. They will run whenever their other dependencies
855// require them to run and get the current build number. This ensures they don't
856// rebuild on every incremental build when the build number changes.
Colin Cross2a2e0db2020-02-21 16:55:46 -0800857func (c *config) BuildNumberFile(ctx PathContext) Path {
858 return PathForOutput(ctx, String(c.productVariables.BuildNumberFile))
Nan Zhang581fd212018-01-10 16:06:12 -0800859}
860
Inseob Kim8fa54da2024-03-19 16:48:59 +0900861// BuildHostnameFile returns the path to a text file containing metadata
862// representing the current build's host name.
863func (c *config) BuildHostnameFile(ctx PathContext) Path {
864 return PathForOutput(ctx, String(c.productVariables.BuildHostnameFile))
865}
866
867// BuildThumbprintFile returns the path to a text file containing metadata
868// representing the current build's thumbprint.
869//
870// Rules that want to reference the build thumbprint should read from this file
871// without depending on it. They will run whenever their other dependencies
872// require them to run and get the current build thumbprint. This ensures they
873// don't rebuild on every incremental build when the build thumbprint changes.
874func (c *config) BuildThumbprintFile(ctx PathContext) Path {
875 return PathForArbitraryOutput(ctx, "target", "product", c.DeviceName(), String(c.productVariables.BuildThumbprintFile))
876}
877
Jingwen Chenc711fec2020-11-22 23:52:50 -0500878// DeviceName returns the name of the current device target.
Colin Cross35cec122015-04-02 14:37:16 -0700879// TODO: take an AndroidModuleContext to select the device name for multi-device builds
Colin Cross1332b002015-04-07 17:11:30 -0700880func (c *config) DeviceName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800881 return *c.productVariables.DeviceName
Colin Cross35cec122015-04-02 14:37:16 -0700882}
883
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000884// DeviceProduct returns the current product target. There could be multiple of
885// these per device type.
886//
Chris Parsonsef615e52022-08-18 22:04:11 -0400887// NOTE: Do not base conditional logic on this value. It may break product inheritance.
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000888func (c *config) DeviceProduct() string {
889 return *c.productVariables.DeviceProduct
890}
891
Cole Faustb85d1a12022-11-08 18:14:01 -0800892// HasDeviceProduct returns if the build has a product. A build will not
893// necessarily have a product when --skip-config is passed to soong, like it is
894// in prebuilts/build-tools/build-prebuilts.sh
895func (c *config) HasDeviceProduct() bool {
896 return c.productVariables.DeviceProduct != nil
897}
898
Inseob Kim8fa54da2024-03-19 16:48:59 +0900899func (c *config) DeviceAbi() []string {
900 return c.productVariables.DeviceAbi
901}
902
Anton Hansson53c88442019-03-18 15:53:16 +0000903func (c *config) DeviceResourceOverlays() []string {
904 return c.productVariables.DeviceResourceOverlays
905}
906
907func (c *config) ProductResourceOverlays() []string {
908 return c.productVariables.ProductResourceOverlays
Colin Cross30e076a2015-04-13 13:58:27 -0700909}
910
Inseob Kim8fa54da2024-03-19 16:48:59 +0900911func (c *config) PlatformDisplayVersionName() string {
912 return String(c.productVariables.Platform_display_version_name)
913}
914
Colin Crossbfd347d2018-05-09 11:11:35 -0700915func (c *config) PlatformVersionName() string {
916 return String(c.productVariables.Platform_version_name)
917}
918
Dan Albert4f378d72020-07-23 17:32:15 -0700919func (c *config) PlatformSdkVersion() ApiLevel {
920 return uncheckedFinalApiLevel(*c.productVariables.Platform_sdk_version)
Colin Cross30e076a2015-04-13 13:58:27 -0700921}
922
Cole Faust37d27c42023-04-12 10:27:45 -0700923func (c *config) RawPlatformSdkVersion() *int {
924 return c.productVariables.Platform_sdk_version
925}
926
Mu-Le Lee5e047532022-07-27 02:32:03 +0000927func (c *config) PlatformSdkFinal() bool {
928 return Bool(c.productVariables.Platform_sdk_final)
929}
930
Colin Crossd09b0b62018-04-18 11:06:47 -0700931func (c *config) PlatformSdkCodename() string {
932 return String(c.productVariables.Platform_sdk_codename)
933}
934
Anton Hansson97d0bae2022-02-16 16:15:10 +0000935func (c *config) PlatformSdkExtensionVersion() int {
936 return *c.productVariables.Platform_sdk_extension_version
937}
938
939func (c *config) PlatformBaseSdkExtensionVersion() int {
940 return *c.productVariables.Platform_base_sdk_extension_version
941}
942
Colin Cross092c9da2019-04-02 22:56:43 -0700943func (c *config) PlatformSecurityPatch() string {
944 return String(c.productVariables.Platform_security_patch)
945}
946
947func (c *config) PlatformPreviewSdkVersion() string {
948 return String(c.productVariables.Platform_preview_sdk_version)
949}
950
951func (c *config) PlatformMinSupportedTargetSdkVersion() string {
952 return String(c.productVariables.Platform_min_supported_target_sdk_version)
953}
954
955func (c *config) PlatformBaseOS() string {
956 return String(c.productVariables.Platform_base_os)
957}
958
Inseob Kim4f1f3d92022-04-25 18:23:58 +0900959func (c *config) PlatformVersionLastStable() string {
960 return String(c.productVariables.Platform_version_last_stable)
961}
962
Jiyong Park37073842022-06-21 10:13:42 +0900963func (c *config) PlatformVersionKnownCodenames() string {
964 return String(c.productVariables.Platform_version_known_codenames)
965}
966
Dan Albert1a246272020-07-06 14:49:35 -0700967func (c *config) MinSupportedSdkVersion() ApiLevel {
Dan Albert6bfb6bb2022-08-17 20:11:57 +0000968 return uncheckedFinalApiLevel(21)
Dan Albert1a246272020-07-06 14:49:35 -0700969}
970
971func (c *config) FinalApiLevels() []ApiLevel {
972 var levels []ApiLevel
Dan Albert4f378d72020-07-23 17:32:15 -0700973 for i := 1; i <= c.PlatformSdkVersion().FinalOrFutureInt(); i++ {
Dan Albert1a246272020-07-06 14:49:35 -0700974 levels = append(levels, uncheckedFinalApiLevel(i))
975 }
976 return levels
977}
978
979func (c *config) PreviewApiLevels() []ApiLevel {
980 var levels []ApiLevel
Dan Albertf93ea132023-10-05 20:40:46 +0000981 i := 0
982 for _, codename := range c.PlatformVersionActiveCodenames() {
983 if codename == "REL" {
984 continue
985 }
986
Dan Albert1a246272020-07-06 14:49:35 -0700987 levels = append(levels, ApiLevel{
988 value: codename,
989 number: i,
990 isPreview: true,
991 })
Dan Albertf93ea132023-10-05 20:40:46 +0000992 i++
Dan Albert1a246272020-07-06 14:49:35 -0700993 }
994 return levels
995}
996
satayevcca4ab72021-11-30 12:33:55 +0000997func (c *config) LatestPreviewApiLevel() ApiLevel {
998 level := NoneApiLevel
999 for _, l := range c.PreviewApiLevels() {
1000 if l.GreaterThan(level) {
1001 level = l
1002 }
1003 }
1004 return level
1005}
1006
Dan Albert1a246272020-07-06 14:49:35 -07001007func (c *config) AllSupportedApiLevels() []ApiLevel {
1008 var levels []ApiLevel
1009 levels = append(levels, c.FinalApiLevels()...)
1010 return append(levels, c.PreviewApiLevels()...)
Dan Albertf5415d72017-08-17 16:19:59 -07001011}
1012
Jingwen Chenc711fec2020-11-22 23:52:50 -05001013// DefaultAppTargetSdk returns the API level that platform apps are targeting.
1014// This converts a codename to the exact ApiLevel it represents.
Dan Albert4f378d72020-07-23 17:32:15 -07001015func (c *config) DefaultAppTargetSdk(ctx EarlyModuleContext) ApiLevel {
Colin Crossd09b0b62018-04-18 11:06:47 -07001016 if Bool(c.productVariables.Platform_sdk_final) {
1017 return c.PlatformSdkVersion()
Colin Crossd09b0b62018-04-18 11:06:47 -07001018 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001019 codename := c.PlatformSdkCodename()
Jiyong Park3a00e3d2023-03-27 17:39:48 +09001020 hostOnlyBuild := c.productVariables.DeviceArch == nil
Jingwen Chenc711fec2020-11-22 23:52:50 -05001021 if codename == "" {
Jiyong Park3a00e3d2023-03-27 17:39:48 +09001022 // There are some host-only builds (those are invoked by build-prebuilts.sh) which
1023 // don't set platform sdk codename. Platform sdk codename makes sense only when we
1024 // are building the platform. So we don't enforce the below panic for the host-only
1025 // builds.
1026 if hostOnlyBuild {
1027 return NoneApiLevel
1028 }
1029 panic("Platform_sdk_codename must be set")
Jingwen Chenc711fec2020-11-22 23:52:50 -05001030 }
1031 if codename == "REL" {
1032 panic("Platform_sdk_codename should not be REL when Platform_sdk_final is true")
1033 }
1034 return ApiLevelOrPanic(ctx, codename)
Colin Crossd09b0b62018-04-18 11:06:47 -07001035}
1036
Colin Cross3bc7ffa2017-11-22 16:19:37 -08001037func (c *config) AppsDefaultVersionName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001038 return String(c.productVariables.AppsDefaultVersionName)
Colin Cross3bc7ffa2017-11-22 16:19:37 -08001039}
1040
Dan Albert31384de2017-07-28 12:39:46 -07001041// Codenames that are active in the current lunch target.
1042func (c *config) PlatformVersionActiveCodenames() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001043 return c.productVariables.Platform_version_active_codenames
Dan Albert31384de2017-07-28 12:39:46 -07001044}
1045
Dan Albert8c7a9942023-03-27 20:34:01 +00001046// All unreleased codenames.
1047func (c *config) PlatformVersionAllPreviewCodenames() []string {
1048 return c.productVariables.Platform_version_all_preview_codenames
1049}
1050
Colin Crossface4e42017-10-30 17:32:15 -07001051func (c *config) ProductAAPTConfig() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001052 return c.productVariables.AAPTConfig
Colin Cross30e076a2015-04-13 13:58:27 -07001053}
1054
Colin Crossface4e42017-10-30 17:32:15 -07001055func (c *config) ProductAAPTPreferredConfig() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001056 return String(c.productVariables.AAPTPreferredConfig)
Colin Cross30e076a2015-04-13 13:58:27 -07001057}
1058
Colin Crossface4e42017-10-30 17:32:15 -07001059func (c *config) ProductAAPTCharacteristics() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001060 return String(c.productVariables.AAPTCharacteristics)
Colin Crossface4e42017-10-30 17:32:15 -07001061}
1062
1063func (c *config) ProductAAPTPrebuiltDPI() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001064 return c.productVariables.AAPTPrebuiltDPI
Colin Cross30e076a2015-04-13 13:58:27 -07001065}
1066
Dan Willemsen34cc69e2015-09-23 15:26:20 -07001067func (c *config) DefaultAppCertificateDir(ctx PathContext) SourcePath {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001068 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -08001069 if defaultCert != "" {
1070 return PathForSource(ctx, filepath.Dir(defaultCert))
Colin Cross61ae0b72017-12-01 17:16:02 -08001071 }
Inseob Kim8fa54da2024-03-19 16:48:59 +09001072 return PathForSource(ctx, testKeyDir)
Colin Cross30e076a2015-04-13 13:58:27 -07001073}
1074
Colin Crosse1731a52017-12-14 11:22:55 -08001075func (c *config) DefaultAppCertificate(ctx PathContext) (pem, key SourcePath) {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001076 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -08001077 if defaultCert != "" {
Colin Crosse1731a52017-12-14 11:22:55 -08001078 return PathForSource(ctx, defaultCert+".x509.pem"), PathForSource(ctx, defaultCert+".pk8")
Colin Cross61ae0b72017-12-01 17:16:02 -08001079 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001080 defaultDir := c.DefaultAppCertificateDir(ctx)
1081 return defaultDir.Join(ctx, "testkey.x509.pem"), defaultDir.Join(ctx, "testkey.pk8")
Colin Cross30e076a2015-04-13 13:58:27 -07001082}
Colin Cross6ff51382015-12-17 16:39:19 -08001083
Inseob Kim8fa54da2024-03-19 16:48:59 +09001084func (c *config) BuildKeys() string {
1085 defaultCert := String(c.productVariables.DefaultAppCertificate)
1086 if defaultCert == "" || defaultCert == filepath.Join(testKeyDir, "testkey") {
1087 return "test-keys"
1088 }
1089 return "dev-keys"
1090}
1091
Jiyong Park9335a262018-12-24 11:31:58 +09001092func (c *config) ApexKeyDir(ctx ModuleContext) SourcePath {
1093 // TODO(b/121224311): define another variable such as TARGET_APEX_KEY_OVERRIDE
1094 defaultCert := String(c.productVariables.DefaultAppCertificate)
Inseob Kim8fa54da2024-03-19 16:48:59 +09001095 if defaultCert == "" || filepath.Dir(defaultCert) == testKeyDir {
Jiyong Park9335a262018-12-24 11:31:58 +09001096 // When defaultCert is unset or is set to the testkeys path, use the APEX keys
1097 // that is under the module dir
Colin Cross07e51612019-03-05 12:46:40 -08001098 return pathForModuleSrc(ctx)
Jiyong Park9335a262018-12-24 11:31:58 +09001099 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001100 // If not, APEX keys are under the specified directory
1101 return PathForSource(ctx, filepath.Dir(defaultCert))
Jiyong Park9335a262018-12-24 11:31:58 +09001102}
1103
Inseob Kim80fa7982022-08-12 21:36:25 +09001104// Certificate for the NetworkStack sepolicy context
1105func (c *config) MainlineSepolicyDevCertificatesDir(ctx ModuleContext) SourcePath {
1106 cert := String(c.productVariables.MainlineSepolicyDevCertificates)
1107 if cert != "" {
1108 return PathForSource(ctx, cert)
1109 }
1110 return c.DefaultAppCertificateDir(ctx)
1111}
1112
Jingwen Chenc711fec2020-11-22 23:52:50 -05001113// AllowMissingDependencies configures Blueprint/Soong to not fail when modules
1114// are configured to depend on non-existent modules. Note that this does not
1115// affect missing input dependencies at the Ninja level.
Colin Cross6ff51382015-12-17 16:39:19 -08001116func (c *config) AllowMissingDependencies() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001117 return Bool(c.productVariables.Allow_missing_dependencies)
Colin Cross6ff51382015-12-17 16:39:19 -08001118}
Dan Willemsen322acaf2016-01-12 23:07:05 -08001119
Jeongik Cha816a23a2020-07-08 01:09:23 +09001120// Returns true if a full platform source tree cannot be assumed.
Colin Crossfc3674a2017-09-18 17:41:52 -07001121func (c *config) UnbundledBuild() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001122 return Bool(c.productVariables.Unbundled_build)
Colin Crossfc3674a2017-09-18 17:41:52 -07001123}
1124
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +01001125// Returns true if building apps that aren't bundled with the platform.
1126// UnbundledBuild() is always true when this is true.
1127func (c *config) UnbundledBuildApps() bool {
Cole Faust701ca252021-11-23 19:02:08 -08001128 return len(c.productVariables.Unbundled_build_apps) > 0
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +01001129}
1130
Jeongik Cha4b073cd2021-06-08 11:35:00 +09001131// Returns true if building image that aren't bundled with the platform.
1132// UnbundledBuild() is always true when this is true.
1133func (c *config) UnbundledBuildImage() bool {
1134 return Bool(c.productVariables.Unbundled_build_image)
1135}
1136
Jeongik Cha816a23a2020-07-08 01:09:23 +09001137// Returns true if building modules against prebuilt SDKs.
1138func (c *config) AlwaysUsePrebuiltSdks() bool {
1139 return Bool(c.productVariables.Always_use_prebuilt_sdks)
Colin Cross1f367bf2018-12-18 22:46:24 -08001140}
1141
Colin Cross126a25c2017-10-31 13:55:34 -07001142func (c *config) MinimizeJavaDebugInfo() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001143 return Bool(c.productVariables.MinimizeJavaDebugInfo) && !Bool(c.productVariables.Eng)
Colin Cross126a25c2017-10-31 13:55:34 -07001144}
1145
Colin Crossed064c02018-09-05 16:28:13 -07001146func (c *config) Debuggable() bool {
1147 return Bool(c.productVariables.Debuggable)
1148}
1149
Jaewoong Jung1d6eb682018-11-29 15:08:44 -08001150func (c *config) Eng() bool {
1151 return Bool(c.productVariables.Eng)
1152}
1153
Inseob Kim8fa54da2024-03-19 16:48:59 +09001154func (c *config) BuildType() string {
1155 return String(c.productVariables.BuildType)
1156}
1157
Colin Crossc53c37f2021-12-08 15:42:22 -08001158// DevicePrimaryArchType returns the ArchType for the first configured device architecture, or
1159// Common if there are no device architectures.
Jiyong Park8d52f862018-07-07 18:02:07 +09001160func (c *config) DevicePrimaryArchType() ArchType {
Colin Crossc53c37f2021-12-08 15:42:22 -08001161 if androidTargets := c.Targets[Android]; len(androidTargets) > 0 {
1162 return androidTargets[0].Arch.ArchType
1163 }
1164 return Common
Jiyong Park8d52f862018-07-07 18:02:07 +09001165}
1166
Colin Cross16b23492016-01-06 14:41:07 -08001167func (c *config) SanitizeHost() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001168 return append([]string(nil), c.productVariables.SanitizeHost...)
Colin Cross16b23492016-01-06 14:41:07 -08001169}
1170
1171func (c *config) SanitizeDevice() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001172 return append([]string(nil), c.productVariables.SanitizeDevice...)
Colin Cross23ae82a2016-11-02 14:34:39 -07001173}
1174
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -07001175func (c *config) SanitizeDeviceDiag() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001176 return append([]string(nil), c.productVariables.SanitizeDeviceDiag...)
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -07001177}
1178
Colin Cross23ae82a2016-11-02 14:34:39 -07001179func (c *config) SanitizeDeviceArch() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001180 return append([]string(nil), c.productVariables.SanitizeDeviceArch...)
Colin Cross16b23492016-01-06 14:41:07 -08001181}
Colin Crossa1ad8d12016-06-01 17:09:44 -07001182
Vishwath Mohan1b017a72017-01-19 13:54:55 -08001183func (c *config) EnableCFI() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001184 if c.productVariables.EnableCFI == nil {
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -08001185 return true
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -08001186 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001187 return *c.productVariables.EnableCFI
Vishwath Mohan1b017a72017-01-19 13:54:55 -08001188}
1189
Kostya Kortchinskyd5275c82019-02-01 08:42:56 -08001190func (c *config) DisableScudo() bool {
1191 return Bool(c.productVariables.DisableScudo)
1192}
1193
Colin Crossa1ad8d12016-06-01 17:09:44 -07001194func (c *config) Android64() bool {
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001195 for _, t := range c.Targets[Android] {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001196 if t.Arch.ArchType.Multilib == "lib64" {
1197 return true
1198 }
1199 }
1200
1201 return false
1202}
Colin Cross9272ade2016-08-17 15:24:12 -07001203
Colin Cross9d45bb72016-08-29 16:14:13 -07001204func (c *config) UseGoma() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001205 return Bool(c.productVariables.UseGoma)
Colin Cross9d45bb72016-08-29 16:14:13 -07001206}
1207
Ramy Medhatbbf25672019-07-17 12:30:04 +00001208func (c *config) UseRBE() bool {
1209 return Bool(c.productVariables.UseRBE)
1210}
1211
Ramy Medhat8ea054a2020-01-27 14:19:44 -05001212func (c *config) UseRBEJAVAC() bool {
1213 return Bool(c.productVariables.UseRBEJAVAC)
1214}
1215
1216func (c *config) UseRBER8() bool {
1217 return Bool(c.productVariables.UseRBER8)
1218}
1219
1220func (c *config) UseRBED8() bool {
1221 return Bool(c.productVariables.UseRBED8)
1222}
1223
Colin Cross8b8bec32019-11-15 13:18:43 -08001224func (c *config) UseRemoteBuild() bool {
1225 return c.UseGoma() || c.UseRBE()
1226}
1227
Colin Cross66548102018-06-19 22:47:35 -07001228func (c *config) RunErrorProne() bool {
1229 return c.IsEnvTrue("RUN_ERROR_PRONE")
1230}
1231
Jingwen Chenc711fec2020-11-22 23:52:50 -05001232// XrefCorpusName returns the Kythe cross-reference corpus name.
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001233func (c *config) XrefCorpusName() string {
1234 return c.Getenv("XREF_CORPUS")
1235}
1236
Jingwen Chenc711fec2020-11-22 23:52:50 -05001237// XrefCuEncoding returns the compilation unit encoding to use for Kythe code
1238// xrefs. Can be 'json' (default), 'proto' or 'all'.
Sasha Smundak6c2d4f92020-01-09 17:34:23 -08001239func (c *config) XrefCuEncoding() string {
1240 if enc := c.Getenv("KYTHE_KZIP_ENCODING"); enc != "" {
1241 return enc
1242 }
1243 return "json"
1244}
1245
Sasha Smundakb0addaf2021-02-16 10:39:40 -08001246// XrefCuJavaSourceMax returns the maximum number of the Java source files
1247// in a single compilation unit
1248const xrefJavaSourceFileMaxDefault = "1000"
1249
1250func (c Config) XrefCuJavaSourceMax() string {
1251 v := c.Getenv("KYTHE_JAVA_SOURCE_BATCH_SIZE")
1252 if v == "" {
1253 return xrefJavaSourceFileMaxDefault
1254 }
1255 if _, err := strconv.ParseUint(v, 0, 0); err != nil {
1256 fmt.Fprintf(os.Stderr,
1257 "bad KYTHE_JAVA_SOURCE_BATCH_SIZE value: %s, will use %s",
1258 err, xrefJavaSourceFileMaxDefault)
1259 return xrefJavaSourceFileMaxDefault
1260 }
1261 return v
1262
1263}
1264
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001265func (c *config) EmitXrefRules() bool {
1266 return c.XrefCorpusName() != ""
1267}
1268
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001269func (c *config) ClangTidy() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001270 return Bool(c.productVariables.ClangTidy)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001271}
1272
1273func (c *config) TidyChecks() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001274 if c.productVariables.TidyChecks == nil {
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001275 return ""
1276 }
Dan Willemsen45133ac2018-03-09 21:22:06 -08001277 return *c.productVariables.TidyChecks
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001278}
1279
Colin Cross0f4e0d62016-07-27 10:56:55 -07001280func (c *config) LibartImgHostBaseAddress() string {
1281 return "0x60000000"
1282}
1283
1284func (c *config) LibartImgDeviceBaseAddress() string {
Elliott Hughesda3a0712020-03-06 16:55:28 -08001285 return "0x70000000"
Colin Cross0f4e0d62016-07-27 10:56:55 -07001286}
1287
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001288func (c *config) ArtUseReadBarrier() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001289 return Bool(c.productVariables.ArtUseReadBarrier)
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001290}
1291
Jingwen Chenc711fec2020-11-22 23:52:50 -05001292// Enforce Runtime Resource Overlays for a module. RROs supersede static RROs,
1293// but some modules still depend on it.
1294//
1295// More info: https://source.android.com/devices/architecture/rros
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001296func (c *config) EnforceRROForModule(name string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001297 enforceList := c.productVariables.EnforceRROTargets
Jeongik Chacee5ba92021-02-19 12:11:51 +09001298
Roland Levillainf6cc2612020-07-09 16:58:14 +01001299 if len(enforceList) > 0 {
Yo Chiang4ebd06a2019-10-01 13:13:41 +08001300 if InList("*", enforceList) {
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001301 return true
1302 }
Colin Crossa74ca042019-01-31 14:31:51 -08001303 return InList(name, enforceList)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001304 }
1305 return false
1306}
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001307func (c *config) EnforceRROExcludedOverlay(path string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001308 excluded := c.productVariables.EnforceRROExcludedOverlays
Roland Levillainf6cc2612020-07-09 16:58:14 +01001309 if len(excluded) > 0 {
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001310 return HasAnyPrefix(path, excluded)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001311 }
1312 return false
1313}
1314
1315func (c *config) ExportedNamespaces() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001316 return append([]string(nil), c.productVariables.NamespacesToExport...)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001317}
1318
Sam Delmerico98a73292023-02-21 11:50:29 -05001319func (c *config) SourceRootDirs() []string {
1320 return c.productVariables.SourceRootDirs
1321}
1322
Spandan Dasc5763832022-11-08 18:42:16 +00001323func (c *config) IncludeTags() []string {
1324 return c.productVariables.IncludeTags
1325}
1326
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001327func (c *config) HostStaticBinaries() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001328 return Bool(c.productVariables.HostStaticBinaries)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001329}
1330
Colin Cross5a0dcd52018-10-05 14:20:06 -07001331func (c *config) UncompressPrivAppDex() bool {
1332 return Bool(c.productVariables.UncompressPrivAppDex)
1333}
1334
1335func (c *config) ModulesLoadedByPrivilegedModules() []string {
1336 return c.productVariables.ModulesLoadedByPrivilegedModules
1337}
1338
Jingwen Chenc711fec2020-11-22 23:52:50 -05001339// DexpreoptGlobalConfigPath returns the path to the dexpreopt.config file in
1340// the output directory, if it was created during the product configuration
1341// phase by Kati.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001342func (c *config) DexpreoptGlobalConfigPath(ctx PathContext) OptionalPath {
Colin Cross988414c2020-01-11 01:11:46 +00001343 if c.productVariables.DexpreoptGlobalConfig == nil {
Jingwen Chenebb0b572020-11-02 00:24:57 -05001344 return OptionalPathForPath(nil)
1345 }
1346 return OptionalPathForPath(
1347 pathForBuildToolDep(ctx, *c.productVariables.DexpreoptGlobalConfig))
1348}
1349
Jingwen Chenc711fec2020-11-22 23:52:50 -05001350// DexpreoptGlobalConfig returns the raw byte contents of the dexpreopt global
1351// configuration. Since the configuration file was created by Kati during
1352// product configuration (externally of soong_build), it's not tracked, so we
1353// also manually add a Ninja file dependency on the configuration file to the
1354// rule that creates the main build.ninja file. This ensures that build.ninja is
1355// regenerated correctly if dexpreopt.config changes.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001356func (c *config) DexpreoptGlobalConfig(ctx PathContext) ([]byte, error) {
1357 path := c.DexpreoptGlobalConfigPath(ctx)
1358 if !path.Valid() {
Colin Cross988414c2020-01-11 01:11:46 +00001359 return nil, nil
1360 }
Jingwen Chenebb0b572020-11-02 00:24:57 -05001361 ctx.AddNinjaFileDeps(path.String())
Sasha Smundakaf5ca922022-12-12 21:23:34 -08001362 return os.ReadFile(absolutePath(path.String()))
Colin Cross43f08db2018-11-12 10:13:39 -08001363}
1364
Inseob Kim7b85eeb2021-03-23 20:52:24 +09001365func (c *deviceConfig) WithDexpreopt() bool {
1366 return c.config.productVariables.WithDexpreopt
1367}
1368
Colin Cross662d6142022-11-03 20:38:01 -07001369func (c *config) FrameworksBaseDirExists(ctx PathGlobContext) bool {
Colin Cross5a756a62021-03-16 16:34:46 -07001370 return ExistentPathForSource(ctx, "frameworks", "base", "Android.bp").Valid()
David Brazdil91b4e3e2019-01-23 21:04:05 +00001371}
1372
Inseob Kimae553032019-05-14 18:52:49 +09001373func (c *config) VndkSnapshotBuildArtifacts() bool {
1374 return Bool(c.productVariables.VndkSnapshotBuildArtifacts)
1375}
1376
Colin Cross3b19f5d2019-09-17 14:45:31 -07001377func (c *config) HasMultilibConflict(arch ArchType) bool {
1378 return c.multilibConflicts[arch]
1379}
1380
Sasha Smundakaf5ca922022-12-12 21:23:34 -08001381func (c *config) PrebuiltHiddenApiDir(_ PathContext) string {
Bill Peckhambae47492021-01-08 09:34:44 -08001382 return String(c.productVariables.PrebuiltHiddenApiDir)
1383}
1384
Kiyoung Kime623c582023-07-06 16:43:44 +09001385func (c *config) IsVndkDeprecated() bool {
1386 return !Bool(c.productVariables.KeepVndk)
1387}
1388
Justin Yun41cbb5e2023-11-29 17:58:16 +09001389func (c *config) VendorApiLevel() string {
1390 return String(c.productVariables.VendorApiLevel)
1391}
1392
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001393func (c *config) PrevVendorApiLevel() string {
1394 vendorApiLevel, err := strconv.Atoi(c.VendorApiLevel())
1395 if err != nil {
1396 panic(fmt.Errorf("Cannot parse vendor API level %s to an integer: %s",
1397 c.VendorApiLevel(), err))
1398 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001399 // The version before trunk stable is 34.
1400 if vendorApiLevel == 202404 {
1401 return "34"
1402 }
Hsin-Yi Chen890e7722024-03-05 15:56:44 +08001403 if vendorApiLevel >= 1 && vendorApiLevel <= 34 {
1404 return strconv.Itoa(vendorApiLevel - 1)
1405 }
1406 if vendorApiLevel < 202404 || vendorApiLevel%100 != 4 {
1407 panic("Unknown vendor API level " + c.VendorApiLevel())
1408 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001409 return strconv.Itoa(vendorApiLevel - 100)
1410}
1411
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001412func (c *config) VendorApiLevelFrozen() bool {
1413 return c.productVariables.GetBuildFlagBool("RELEASE_BOARD_API_LEVEL_FROZEN")
1414}
1415
Colin Cross9272ade2016-08-17 15:24:12 -07001416func (c *deviceConfig) Arches() []Arch {
1417 var arches []Arch
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001418 for _, target := range c.config.Targets[Android] {
Colin Cross9272ade2016-08-17 15:24:12 -07001419 arches = append(arches, target.Arch)
1420 }
1421 return arches
1422}
Dan Willemsend2ede872016-11-18 14:54:24 -08001423
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001424func (c *deviceConfig) BinderBitness() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001425 is32BitBinder := c.config.productVariables.Binder32bit
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001426 if is32BitBinder != nil && *is32BitBinder {
1427 return "32"
1428 }
1429 return "64"
1430}
1431
Dan Willemsen4353bc42016-12-05 17:16:02 -08001432func (c *deviceConfig) VendorPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001433 if c.config.productVariables.VendorPath != nil {
1434 return *c.config.productVariables.VendorPath
Dan Willemsen4353bc42016-12-05 17:16:02 -08001435 }
1436 return "vendor"
1437}
1438
Justin Yun71549282017-11-17 12:10:28 +09001439func (c *deviceConfig) VndkVersion() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001440 return String(c.config.productVariables.DeviceVndkVersion)
Justin Yun71549282017-11-17 12:10:28 +09001441}
1442
Jose Galmes6f843bc2020-12-11 13:36:29 -08001443func (c *deviceConfig) RecoverySnapshotVersion() string {
1444 return String(c.config.productVariables.RecoverySnapshotVersion)
1445}
1446
Jeongik Cha219141c2020-08-06 23:00:37 +09001447func (c *deviceConfig) CurrentApiLevelForVendorModules() string {
1448 return StringDefault(c.config.productVariables.DeviceCurrentApiLevelForVendorModules, "current")
1449}
1450
Justin Yun8fe12122017-12-07 17:18:15 +09001451func (c *deviceConfig) PlatformVndkVersion() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001452 return String(c.config.productVariables.Platform_vndk_version)
Justin Yun8fe12122017-12-07 17:18:15 +09001453}
1454
Justin Yun71549282017-11-17 12:10:28 +09001455func (c *deviceConfig) ExtraVndkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001456 return c.config.productVariables.ExtraVndkVersions
Dan Willemsend2ede872016-11-18 14:54:24 -08001457}
Jack He8cc71432016-12-08 15:45:07 -08001458
Vic Yangefd249e2018-11-12 20:19:56 -08001459func (c *deviceConfig) VndkUseCoreVariant() bool {
Kiyoung Kim03b6cba2023-10-06 14:12:43 +09001460 return Bool(c.config.productVariables.VndkUseCoreVariant) && Bool(c.config.productVariables.KeepVndk)
Vic Yangefd249e2018-11-12 20:19:56 -08001461}
1462
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001463func (c *deviceConfig) SystemSdkVersions() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001464 return c.config.productVariables.DeviceSystemSdkVersions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001465}
1466
1467func (c *deviceConfig) PlatformSystemSdkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001468 return c.config.productVariables.Platform_systemsdk_versions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001469}
1470
Jiyong Park2db76922017-11-08 16:03:48 +09001471func (c *deviceConfig) OdmPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001472 if c.config.productVariables.OdmPath != nil {
1473 return *c.config.productVariables.OdmPath
Jiyong Park2db76922017-11-08 16:03:48 +09001474 }
1475 return "odm"
1476}
1477
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001478func (c *deviceConfig) ProductPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001479 if c.config.productVariables.ProductPath != nil {
1480 return *c.config.productVariables.ProductPath
Jiyong Park2db76922017-11-08 16:03:48 +09001481 }
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001482 return "product"
Jiyong Park2db76922017-11-08 16:03:48 +09001483}
1484
Justin Yund5f6c822019-06-25 16:47:17 +09001485func (c *deviceConfig) SystemExtPath() string {
1486 if c.config.productVariables.SystemExtPath != nil {
1487 return *c.config.productVariables.SystemExtPath
Dario Frenifd05a742018-05-29 13:28:54 +01001488 }
Justin Yund5f6c822019-06-25 16:47:17 +09001489 return "system_ext"
Dario Frenifd05a742018-05-29 13:28:54 +01001490}
1491
Jack He8cc71432016-12-08 15:45:07 -08001492func (c *deviceConfig) BtConfigIncludeDir() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001493 return String(c.config.productVariables.BtConfigIncludeDir)
Jack He8cc71432016-12-08 15:45:07 -08001494}
Dan Willemsen581341d2017-02-09 16:16:31 -08001495
Jiyong Parkd773eb32017-07-03 13:18:12 +09001496func (c *deviceConfig) DeviceKernelHeaderDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001497 return c.config.productVariables.DeviceKernelHeaders
Jiyong Parkd773eb32017-07-03 13:18:12 +09001498}
1499
Roland Levillainada12702020-06-09 13:07:36 +01001500// JavaCoverageEnabledForPath returns whether Java code coverage is enabled for
1501// path. Coverage is enabled by default when the product variable
1502// JavaCoveragePaths is empty. If JavaCoveragePaths is not empty, coverage is
1503// enabled for any path which is part of this variable (and not part of the
1504// JavaCoverageExcludePaths product variable). Value "*" in JavaCoveragePaths
1505// represents any path.
1506func (c *deviceConfig) JavaCoverageEnabledForPath(path string) bool {
1507 coverage := false
Chris Gross2f748692020-06-24 20:36:59 +00001508 if len(c.config.productVariables.JavaCoveragePaths) == 0 ||
Roland Levillainada12702020-06-09 13:07:36 +01001509 InList("*", c.config.productVariables.JavaCoveragePaths) ||
1510 HasAnyPrefix(path, c.config.productVariables.JavaCoveragePaths) {
1511 coverage = true
1512 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001513 if coverage && len(c.config.productVariables.JavaCoverageExcludePaths) > 0 {
Roland Levillainada12702020-06-09 13:07:36 +01001514 if HasAnyPrefix(path, c.config.productVariables.JavaCoverageExcludePaths) {
1515 coverage = false
1516 }
1517 }
1518 return coverage
1519}
1520
Colin Cross1a6acd42020-06-16 17:51:46 -07001521// Returns true if gcov or clang coverage is enabled.
Dan Willemsen581341d2017-02-09 16:16:31 -08001522func (c *deviceConfig) NativeCoverageEnabled() bool {
Colin Cross1a6acd42020-06-16 17:51:46 -07001523 return Bool(c.config.productVariables.GcovCoverage) ||
1524 Bool(c.config.productVariables.ClangCoverage)
Dan Willemsen581341d2017-02-09 16:16:31 -08001525}
1526
Oliver Nguyen1382ab62019-12-06 15:22:41 -08001527func (c *deviceConfig) ClangCoverageEnabled() bool {
1528 return Bool(c.config.productVariables.ClangCoverage)
1529}
1530
Pirama Arumuga Nainarb37ae582022-01-26 22:14:32 -08001531func (c *deviceConfig) ClangCoverageContinuousMode() bool {
1532 return Bool(c.config.productVariables.ClangCoverageContinuousMode)
1533}
1534
Colin Cross1a6acd42020-06-16 17:51:46 -07001535func (c *deviceConfig) GcovCoverageEnabled() bool {
1536 return Bool(c.config.productVariables.GcovCoverage)
1537}
1538
Roland Levillain4f5297b2020-06-09 12:44:06 +01001539// NativeCoverageEnabledForPath returns whether (GCOV- or Clang-based) native
1540// code coverage is enabled for path. By default, coverage is not enabled for a
1541// given path unless it is part of the NativeCoveragePaths product variable (and
1542// not part of the NativeCoverageExcludePaths product variable). Value "*" in
1543// NativeCoveragePaths represents any path.
1544func (c *deviceConfig) NativeCoverageEnabledForPath(path string) bool {
Ryan Campbell469a18a2017-02-27 09:01:54 -08001545 coverage := false
Roland Levillainf6cc2612020-07-09 16:58:14 +01001546 if len(c.config.productVariables.NativeCoveragePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001547 if InList("*", c.config.productVariables.NativeCoveragePaths) || HasAnyPrefix(path, c.config.productVariables.NativeCoveragePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001548 coverage = true
Dan Willemsen581341d2017-02-09 16:16:31 -08001549 }
1550 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001551 if coverage && len(c.config.productVariables.NativeCoverageExcludePaths) > 0 {
Yi Kongfd07ed22023-02-16 17:42:27 +09001552 // Workaround coverage boot failure.
1553 // http://b/269981180
1554 if strings.HasPrefix(path, "external/protobuf") {
1555 coverage = false
1556 }
Roland Levillain4f5297b2020-06-09 12:44:06 +01001557 if HasAnyPrefix(path, c.config.productVariables.NativeCoverageExcludePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001558 coverage = false
Ryan Campbell469a18a2017-02-27 09:01:54 -08001559 }
1560 }
1561 return coverage
Dan Willemsen581341d2017-02-09 16:16:31 -08001562}
Ivan Lozano5f595532017-07-13 14:46:05 -07001563
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001564func (c *deviceConfig) PgoAdditionalProfileDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001565 return c.config.productVariables.PgoAdditionalProfileDirs
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001566}
1567
Vinh Tran44cb78c2023-03-09 22:07:19 -05001568// AfdoProfile returns fully qualified path associated to the given module name
Colin Crossd38feb02024-01-23 16:38:06 -08001569func (c *deviceConfig) AfdoProfile(name string) (string, error) {
Vinh Tran44cb78c2023-03-09 22:07:19 -05001570 for _, afdoProfile := range c.config.productVariables.AfdoProfiles {
1571 split := strings.Split(afdoProfile, ":")
1572 if len(split) != 3 {
Colin Crossd38feb02024-01-23 16:38:06 -08001573 return "", fmt.Errorf("AFDO_PROFILES has invalid value: %s. "+
Vinh Tran44cb78c2023-03-09 22:07:19 -05001574 "The expected format is <module>:<fully-qualified-path-to-fdo_profile>", afdoProfile)
1575 }
1576 if split[0] == name {
Colin Crossd38feb02024-01-23 16:38:06 -08001577 return strings.Join([]string{split[1], split[2]}, ":"), nil
Vinh Tran44cb78c2023-03-09 22:07:19 -05001578 }
1579 }
Colin Crossd38feb02024-01-23 16:38:06 -08001580 return "", nil
Vinh Tran44cb78c2023-03-09 22:07:19 -05001581}
1582
Tri Vo35a51432018-03-25 20:00:00 -07001583func (c *deviceConfig) VendorSepolicyDirs() []string {
1584 return c.config.productVariables.BoardVendorSepolicyDirs
1585}
1586
1587func (c *deviceConfig) OdmSepolicyDirs() []string {
1588 return c.config.productVariables.BoardOdmSepolicyDirs
1589}
1590
Felixa20a8752020-05-17 18:28:35 +02001591func (c *deviceConfig) SystemExtPublicSepolicyDirs() []string {
1592 return c.config.productVariables.SystemExtPublicSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001593}
1594
Felixa20a8752020-05-17 18:28:35 +02001595func (c *deviceConfig) SystemExtPrivateSepolicyDirs() []string {
1596 return c.config.productVariables.SystemExtPrivateSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001597}
1598
Inseob Kim0866b002019-04-15 20:21:29 +09001599func (c *deviceConfig) SepolicyM4Defs() []string {
1600 return c.config.productVariables.BoardSepolicyM4Defs
1601}
1602
Jiyong Park7f67f482019-01-05 12:57:48 +09001603func (c *deviceConfig) OverrideManifestPackageNameFor(name string) (manifestName string, overridden bool) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001604 return findOverrideValue(c.config.productVariables.ManifestPackageNameOverrides, name,
1605 "invalid override rule %q in PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES should be <module_name>:<manifest_name>")
1606}
1607
1608func (c *deviceConfig) OverrideCertificateFor(name string) (certificatePath string, overridden bool) {
Jaewoong Jungacb6db32019-02-28 16:22:30 +00001609 return findOverrideValue(c.config.productVariables.CertificateOverrides, name,
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001610 "invalid override rule %q in PRODUCT_CERTIFICATE_OVERRIDES should be <module_name>:<certificate_module_name>")
1611}
1612
Jaewoong Jung9d22a912019-01-23 16:27:47 -08001613func (c *deviceConfig) OverridePackageNameFor(name string) string {
1614 newName, overridden := findOverrideValue(
1615 c.config.productVariables.PackageNameOverrides,
1616 name,
1617 "invalid override rule %q in PRODUCT_PACKAGE_NAME_OVERRIDES should be <module_name>:<package_name>")
1618 if overridden {
1619 return newName
1620 }
1621 return name
1622}
1623
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001624func findOverrideValue(overrides []string, name string, errorMsg string) (newValue string, overridden bool) {
Jiyong Park7f67f482019-01-05 12:57:48 +09001625 if overrides == nil || len(overrides) == 0 {
1626 return "", false
1627 }
1628 for _, o := range overrides {
1629 split := strings.Split(o, ":")
1630 if len(split) != 2 {
1631 // This shouldn't happen as this is first checked in make, but just in case.
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001632 panic(fmt.Errorf(errorMsg, o))
Jiyong Park7f67f482019-01-05 12:57:48 +09001633 }
1634 if matchPattern(split[0], name) {
1635 return substPattern(split[0], split[1], name), true
1636 }
1637 }
1638 return "", false
1639}
1640
Albert Martineefabcf2022-03-21 20:11:16 +00001641func (c *deviceConfig) ApexGlobalMinSdkVersionOverride() string {
1642 return String(c.config.productVariables.ApexGlobalMinSdkVersionOverride)
1643}
1644
Ivan Lozano5f595532017-07-13 14:46:05 -07001645func (c *config) IntegerOverflowDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001646 if len(c.productVariables.IntegerOverflowExcludePaths) == 0 {
Ivan Lozano5f595532017-07-13 14:46:05 -07001647 return false
1648 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001649 return HasAnyPrefix(path, c.productVariables.IntegerOverflowExcludePaths)
Ivan Lozano5f595532017-07-13 14:46:05 -07001650}
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001651
1652func (c *config) CFIDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001653 if len(c.productVariables.CFIExcludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001654 return false
1655 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001656 return HasAnyPrefix(path, c.productVariables.CFIExcludePaths)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001657}
1658
1659func (c *config) CFIEnabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001660 if len(c.productVariables.CFIIncludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001661 return false
1662 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001663 return HasAnyPrefix(path, c.productVariables.CFIIncludePaths) && !c.CFIDisabledForPath(path)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001664}
Colin Crosse15ddaf2017-12-04 11:24:31 -08001665
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001666func (c *config) MemtagHeapDisabledForPath(path string) bool {
1667 if len(c.productVariables.MemtagHeapExcludePaths) == 0 {
1668 return false
1669 }
1670 return HasAnyPrefix(path, c.productVariables.MemtagHeapExcludePaths)
1671}
1672
1673func (c *config) MemtagHeapAsyncEnabledForPath(path string) bool {
1674 if len(c.productVariables.MemtagHeapAsyncIncludePaths) == 0 {
1675 return false
1676 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001677 return HasAnyPrefix(path, c.productVariables.MemtagHeapAsyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001678}
1679
1680func (c *config) MemtagHeapSyncEnabledForPath(path string) bool {
1681 if len(c.productVariables.MemtagHeapSyncIncludePaths) == 0 {
1682 return false
1683 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001684 return HasAnyPrefix(path, c.productVariables.MemtagHeapSyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001685}
1686
Tomislav Novakf734f002023-08-22 10:51:44 -07001687func (c *config) HWASanDisabledForPath(path string) bool {
1688 if len(c.productVariables.HWASanExcludePaths) == 0 {
1689 return false
1690 }
1691 return HasAnyPrefix(path, c.productVariables.HWASanExcludePaths)
1692}
1693
Hang Lua98aab92023-03-17 13:17:22 +08001694func (c *config) HWASanEnabledForPath(path string) bool {
1695 if len(c.productVariables.HWASanIncludePaths) == 0 {
1696 return false
1697 }
Tomislav Novakf734f002023-08-22 10:51:44 -07001698 return HasAnyPrefix(path, c.productVariables.HWASanIncludePaths) && !c.HWASanDisabledForPath(path)
Hang Lua98aab92023-03-17 13:17:22 +08001699}
1700
Dan Willemsen0fe78662018-03-26 12:41:18 -07001701func (c *config) VendorConfig(name string) VendorConfig {
Colin Cross9d34f352019-11-22 16:03:51 -08001702 return soongconfig.Config(c.productVariables.VendorVars[name])
Dan Willemsen0fe78662018-03-26 12:41:18 -07001703}
1704
Colin Cross395f2cf2018-10-24 16:10:32 -07001705func (c *config) NdkAbis() bool {
1706 return Bool(c.productVariables.Ndk_abis)
1707}
1708
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001709func (c *config) AmlAbis() bool {
1710 return Bool(c.productVariables.Aml_abis)
1711}
1712
Jiyong Park4da07972021-01-05 21:01:11 +09001713func (c *config) ForceApexSymlinkOptimization() bool {
1714 return Bool(c.productVariables.ForceApexSymlinkOptimization)
1715}
1716
Sasha Smundakfe9a5b82022-07-27 14:51:45 -07001717func (c *config) ApexCompressionEnabled() bool {
1718 return Bool(c.productVariables.CompressedApex) && !c.UnbundledBuildApps()
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +00001719}
1720
Dennis Shene2ed70c2023-01-11 14:15:43 +00001721func (c *config) ApexTrimEnabled() bool {
1722 return Bool(c.productVariables.TrimmedApex)
1723}
1724
Jeongik Chac9464142019-01-07 12:07:27 +09001725func (c *config) EnforceSystemCertificate() bool {
1726 return Bool(c.productVariables.EnforceSystemCertificate)
1727}
1728
Colin Cross440e0d02020-06-11 11:32:11 -07001729func (c *config) EnforceSystemCertificateAllowList() []string {
1730 return c.productVariables.EnforceSystemCertificateAllowList
Jeongik Chac9464142019-01-07 12:07:27 +09001731}
1732
Jeongik Cha2cc570d2019-10-29 15:44:45 +09001733func (c *config) EnforceProductPartitionInterface() bool {
1734 return Bool(c.productVariables.EnforceProductPartitionInterface)
1735}
1736
JaeMan Parkff715562020-10-19 17:25:58 +09001737func (c *config) EnforceInterPartitionJavaSdkLibrary() bool {
1738 return Bool(c.productVariables.EnforceInterPartitionJavaSdkLibrary)
1739}
1740
1741func (c *config) InterPartitionJavaLibraryAllowList() []string {
1742 return c.productVariables.InterPartitionJavaLibraryAllowList
1743}
1744
Colin Crossf24a22a2019-01-31 14:12:44 -08001745func (c *config) ProductHiddenAPIStubs() []string {
1746 return c.productVariables.ProductHiddenAPIStubs
Colin Cross8faf8fc2019-01-16 15:15:52 -08001747}
1748
Colin Crossf24a22a2019-01-31 14:12:44 -08001749func (c *config) ProductHiddenAPIStubsSystem() []string {
1750 return c.productVariables.ProductHiddenAPIStubsSystem
Colin Cross8faf8fc2019-01-16 15:15:52 -08001751}
1752
Colin Crossf24a22a2019-01-31 14:12:44 -08001753func (c *config) ProductHiddenAPIStubsTest() []string {
1754 return c.productVariables.ProductHiddenAPIStubsTest
Colin Cross8faf8fc2019-01-16 15:15:52 -08001755}
Dan Willemsen71c74602019-04-10 12:27:35 -07001756
Dan Willemsen54879d12019-04-18 10:08:46 -07001757func (c *deviceConfig) TargetFSConfigGen() []string {
Dan Willemsen71c74602019-04-10 12:27:35 -07001758 return c.config.productVariables.TargetFSConfigGen
1759}
Inseob Kim0866b002019-04-15 20:21:29 +09001760
1761func (c *config) ProductPublicSepolicyDirs() []string {
1762 return c.productVariables.ProductPublicSepolicyDirs
1763}
1764
1765func (c *config) ProductPrivateSepolicyDirs() []string {
1766 return c.productVariables.ProductPrivateSepolicyDirs
1767}
1768
Inseob Kim5eb7ee92022-04-27 10:30:34 +09001769func (c *config) TargetMultitreeUpdateMeta() bool {
1770 return c.productVariables.MultitreeUpdateMeta
1771}
1772
Inseob Kim1f086e22019-05-09 13:29:15 +09001773func (c *deviceConfig) DeviceArch() string {
1774 return String(c.config.productVariables.DeviceArch)
1775}
1776
1777func (c *deviceConfig) DeviceArchVariant() string {
1778 return String(c.config.productVariables.DeviceArchVariant)
1779}
1780
1781func (c *deviceConfig) DeviceSecondaryArch() string {
1782 return String(c.config.productVariables.DeviceSecondaryArch)
1783}
1784
1785func (c *deviceConfig) DeviceSecondaryArchVariant() string {
1786 return String(c.config.productVariables.DeviceSecondaryArchVariant)
1787}
Yifan Hong82db7352020-01-21 16:12:26 -08001788
1789func (c *deviceConfig) BoardUsesRecoveryAsBoot() bool {
1790 return Bool(c.config.productVariables.BoardUsesRecoveryAsBoot)
1791}
Yifan Hong97365ee2020-07-29 09:51:57 -07001792
1793func (c *deviceConfig) BoardKernelBinaries() []string {
1794 return c.config.productVariables.BoardKernelBinaries
1795}
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001796
Yifan Hong42bef8d2020-08-05 14:36:09 -07001797func (c *deviceConfig) BoardKernelModuleInterfaceVersions() []string {
1798 return c.config.productVariables.BoardKernelModuleInterfaceVersions
1799}
1800
Yifan Hongdd8dacc2020-10-21 15:40:17 -07001801func (c *deviceConfig) BoardMoveRecoveryResourcesToVendorBoot() bool {
1802 return Bool(c.config.productVariables.BoardMoveRecoveryResourcesToVendorBoot)
1803}
1804
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001805func (c *deviceConfig) PlatformSepolicyVersion() string {
1806 return String(c.config.productVariables.PlatformSepolicyVersion)
1807}
1808
Inseob Kim843f6642022-01-07 09:11:23 +09001809func (c *deviceConfig) PlatformSepolicyCompatVersions() []string {
1810 return c.config.productVariables.PlatformSepolicyCompatVersions
1811}
1812
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001813func (c *deviceConfig) BoardSepolicyVers() string {
Inseob Kim0c4eec82021-03-22 22:33:40 +09001814 if ver := String(c.config.productVariables.BoardSepolicyVers); ver != "" {
1815 return ver
1816 }
1817 return c.PlatformSepolicyVersion()
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001818}
1819
Inseob Kim1a0afcc2022-02-14 23:10:51 +09001820func (c *deviceConfig) SystemExtSepolicyPrebuiltApiDir() string {
1821 return String(c.config.productVariables.SystemExtSepolicyPrebuiltApiDir)
1822}
1823
1824func (c *deviceConfig) ProductSepolicyPrebuiltApiDir() string {
1825 return String(c.config.productVariables.ProductSepolicyPrebuiltApiDir)
1826}
1827
1828func (c *deviceConfig) IsPartnerTrebleSepolicyTestEnabled() bool {
1829 return c.SystemExtSepolicyPrebuiltApiDir() != "" || c.ProductSepolicyPrebuiltApiDir() != ""
1830}
1831
Inseob Kim7cf14652021-01-06 23:06:52 +09001832func (c *deviceConfig) DirectedVendorSnapshot() bool {
1833 return c.config.productVariables.DirectedVendorSnapshot
1834}
1835
1836func (c *deviceConfig) VendorSnapshotModules() map[string]bool {
1837 return c.config.productVariables.VendorSnapshotModules
1838}
1839
Jose Galmes4c6895e2021-02-09 07:44:30 -08001840func (c *deviceConfig) DirectedRecoverySnapshot() bool {
1841 return c.config.productVariables.DirectedRecoverySnapshot
1842}
1843
1844func (c *deviceConfig) RecoverySnapshotModules() map[string]bool {
1845 return c.config.productVariables.RecoverySnapshotModules
1846}
1847
Justin DeMartino383bfb32021-02-24 10:49:43 -08001848func createDirsMap(previous map[string]bool, dirs []string) (map[string]bool, error) {
1849 var ret = make(map[string]bool)
1850 for _, dir := range dirs {
1851 clean := filepath.Clean(dir)
1852 if previous[clean] || ret[clean] {
1853 return nil, fmt.Errorf("Duplicate entry %s", dir)
1854 }
1855 ret[clean] = true
1856 }
1857 return ret, nil
1858}
1859
1860func (c *deviceConfig) createDirsMapOnce(onceKey OnceKey, previous map[string]bool, dirs []string) map[string]bool {
1861 dirMap := c.Once(onceKey, func() interface{} {
1862 ret, err := createDirsMap(previous, dirs)
1863 if err != nil {
1864 panic(fmt.Errorf("%s: %w", onceKey.key, err))
1865 }
1866 return ret
1867 })
1868 if dirMap == nil {
1869 return nil
1870 }
1871 return dirMap.(map[string]bool)
1872}
1873
1874var vendorSnapshotDirsExcludedKey = NewOnceKey("VendorSnapshotDirsExcludedMap")
1875
1876func (c *deviceConfig) VendorSnapshotDirsExcludedMap() map[string]bool {
1877 return c.createDirsMapOnce(vendorSnapshotDirsExcludedKey, nil,
1878 c.config.productVariables.VendorSnapshotDirsExcluded)
1879}
1880
1881var vendorSnapshotDirsIncludedKey = NewOnceKey("VendorSnapshotDirsIncludedMap")
1882
1883func (c *deviceConfig) VendorSnapshotDirsIncludedMap() map[string]bool {
1884 excludedMap := c.VendorSnapshotDirsExcludedMap()
1885 return c.createDirsMapOnce(vendorSnapshotDirsIncludedKey, excludedMap,
1886 c.config.productVariables.VendorSnapshotDirsIncluded)
1887}
1888
1889var recoverySnapshotDirsExcludedKey = NewOnceKey("RecoverySnapshotDirsExcludedMap")
1890
1891func (c *deviceConfig) RecoverySnapshotDirsExcludedMap() map[string]bool {
1892 return c.createDirsMapOnce(recoverySnapshotDirsExcludedKey, nil,
1893 c.config.productVariables.RecoverySnapshotDirsExcluded)
1894}
1895
1896var recoverySnapshotDirsIncludedKey = NewOnceKey("RecoverySnapshotDirsIncludedMap")
1897
1898func (c *deviceConfig) RecoverySnapshotDirsIncludedMap() map[string]bool {
1899 excludedMap := c.RecoverySnapshotDirsExcludedMap()
1900 return c.createDirsMapOnce(recoverySnapshotDirsIncludedKey, excludedMap,
1901 c.config.productVariables.RecoverySnapshotDirsIncluded)
1902}
1903
Rob Seymour925aa092021-08-10 20:42:03 +00001904func (c *deviceConfig) HostFakeSnapshotEnabled() bool {
1905 return c.config.productVariables.HostFakeSnapshotEnabled
1906}
1907
Inseob Kim60c32f02020-12-21 22:53:05 +09001908func (c *deviceConfig) ShippingApiLevel() ApiLevel {
1909 if c.config.productVariables.ShippingApiLevel == nil {
1910 return NoneApiLevel
1911 }
1912 apiLevel, _ := strconv.Atoi(*c.config.productVariables.ShippingApiLevel)
1913 return uncheckedFinalApiLevel(apiLevel)
1914}
1915
Liz Kammer33cc80e2023-05-18 18:20:28 +00001916func (c *deviceConfig) BuildBrokenPluginValidation() []string {
1917 return c.config.productVariables.BuildBrokenPluginValidation
1918}
1919
Alix Espinoef47e542022-09-14 19:10:51 +00001920func (c *deviceConfig) BuildBrokenClangAsFlags() bool {
1921 return c.config.productVariables.BuildBrokenClangAsFlags
1922}
1923
1924func (c *deviceConfig) BuildBrokenClangCFlags() bool {
1925 return c.config.productVariables.BuildBrokenClangCFlags
1926}
1927
Alixb5f6d9e2022-04-20 23:00:58 +00001928func (c *deviceConfig) BuildBrokenClangProperty() bool {
1929 return c.config.productVariables.BuildBrokenClangProperty
1930}
1931
Inseob Kim67e5add192021-03-17 18:05:33 +09001932func (c *deviceConfig) BuildBrokenEnforceSyspropOwner() bool {
1933 return c.config.productVariables.BuildBrokenEnforceSyspropOwner
1934}
1935
1936func (c *deviceConfig) BuildBrokenTrebleSyspropNeverallow() bool {
1937 return c.config.productVariables.BuildBrokenTrebleSyspropNeverallow
1938}
1939
Cole Faustedc4c502022-09-09 19:39:25 -07001940func (c *deviceConfig) BuildBrokenUsesSoongPython2Modules() bool {
1941 return c.config.productVariables.BuildBrokenUsesSoongPython2Modules
1942}
1943
Hridya Valsaraju5a5c7d52021-04-02 16:45:24 -07001944func (c *deviceConfig) BuildDebugfsRestrictionsEnabled() bool {
1945 return c.config.productVariables.BuildDebugfsRestrictionsEnabled
1946}
1947
Inseob Kim0cac7b42021-02-03 18:16:46 +09001948func (c *deviceConfig) BuildBrokenVendorPropertyNamespace() bool {
1949 return c.config.productVariables.BuildBrokenVendorPropertyNamespace
1950}
1951
Liz Kammer619be462022-01-28 15:13:39 -05001952func (c *deviceConfig) BuildBrokenInputDir(name string) bool {
1953 return InList(name, c.config.productVariables.BuildBrokenInputDirModules)
1954}
1955
Jiyong Park3bb99242024-01-04 23:21:26 +00001956func (c *deviceConfig) BuildBrokenDontCheckSystemSdk() bool {
1957 return c.config.productVariables.BuildBrokenDontCheckSystemSdk
1958}
1959
Jiakai Zhang48203e32023-06-02 23:42:21 +01001960func (c *config) BuildWarningBadOptionalUsesLibsAllowlist() []string {
1961 return c.productVariables.BuildWarningBadOptionalUsesLibsAllowlist
1962}
1963
Yu Liu6a7940c2023-05-09 17:12:22 -07001964func (c *deviceConfig) GenruleSandboxing() bool {
1965 return Bool(c.config.productVariables.GenruleSandboxing)
Vinh Tran140d5882022-06-10 14:23:27 -04001966}
1967
Inseob Kim67e5add192021-03-17 18:05:33 +09001968func (c *deviceConfig) RequiresInsecureExecmemForSwiftshader() bool {
1969 return c.config.productVariables.RequiresInsecureExecmemForSwiftshader
1970}
1971
Devin Moorec381e102023-07-06 22:03:58 +00001972func (c *deviceConfig) Release_aidl_use_unfrozen() bool {
1973 return Bool(c.config.productVariables.Release_aidl_use_unfrozen)
1974}
1975
Inseob Kim67e5add192021-03-17 18:05:33 +09001976func (c *config) SelinuxIgnoreNeverallows() bool {
1977 return c.productVariables.SelinuxIgnoreNeverallows
1978}
1979
Inseob Kima10ef272021-09-15 03:04:53 +00001980func (c *deviceConfig) SepolicyFreezeTestExtraDirs() []string {
1981 return c.config.productVariables.SepolicyFreezeTestExtraDirs
1982}
1983
1984func (c *deviceConfig) SepolicyFreezeTestExtraPrebuiltDirs() []string {
1985 return c.config.productVariables.SepolicyFreezeTestExtraPrebuiltDirs
1986}
1987
Jiyong Parkd163d4d2021-10-12 16:47:43 +09001988func (c *deviceConfig) GenerateAidlNdkPlatformBackend() bool {
1989 return c.config.productVariables.GenerateAidlNdkPlatformBackend
1990}
1991
Yu Liu67a28422024-03-05 00:36:31 +00001992func (c *deviceConfig) AconfigContainerValidation() string {
1993 return c.config.productVariables.AconfigContainerValidation
1994}
1995
Christopher Ferris98f10222022-07-13 23:16:52 -07001996func (c *config) IgnorePrefer32OnDevice() bool {
1997 return c.productVariables.IgnorePrefer32OnDevice
1998}
1999
Ulya Trafimovich249386a2020-07-01 14:31:13 +01002000func (c *config) BootJars() []string {
2001 return c.Once(earlyBootJarsKey, func() interface{} {
Paul Duffin69d1fb12020-10-23 21:14:20 +01002002 list := c.productVariables.BootJars.CopyOfJars()
satayevd604b212021-07-21 14:23:52 +01002003 return append(list, c.productVariables.ApexBootJars.CopyOfJars()...)
Ulya Trafimovich249386a2020-07-01 14:31:13 +01002004 }).([]string)
2005}
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002006
satayevd604b212021-07-21 14:23:52 +01002007func (c *config) NonApexBootJars() ConfiguredJarList {
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002008 return c.productVariables.BootJars
2009}
2010
satayevd604b212021-07-21 14:23:52 +01002011func (c *config) ApexBootJars() ConfiguredJarList {
2012 return c.productVariables.ApexBootJars
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002013}
Colin Cross77cdcfd2021-03-12 11:28:25 -08002014
2015func (c *config) RBEWrapper() string {
2016 return c.GetenvWithDefault("RBE_WRAPPER", remoteexec.DefaultWrapperPath)
2017}
Colin Cross9b698b62021-12-22 09:55:32 -08002018
2019// UseHostMusl returns true if the host target has been configured to build against musl libc.
2020func (c *config) UseHostMusl() bool {
2021 return Bool(c.productVariables.HostMusl)
2022}
MarkDacekff851b82022-04-21 18:33:17 +00002023
Spandan Das9e93d3d2023-03-08 05:47:29 +00002024// ApiSurfaces directory returns the source path inside the api_surfaces repo
2025// (relative to workspace root).
2026func (c *config) ApiSurfacesDir(s ApiSurface, version string) string {
2027 return filepath.Join(
2028 "build",
2029 "bazel",
2030 "api_surfaces",
2031 s.String(),
2032 version)
2033}
Jihoon Kang1bff0342023-01-17 20:40:22 +00002034
Jihoon Kang1975d3e2023-10-16 23:24:11 +00002035func (c *config) JavaCoverageEnabled() bool {
2036 return c.IsEnvTrue("EMMA_INSTRUMENT") || c.IsEnvTrue("EMMA_INSTRUMENT_STATIC") || c.IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK")
2037}
2038
Jihoon Kangc1b04d62023-11-16 19:07:04 +00002039func (c *deviceConfig) BuildFromSourceStub() bool {
2040 return Bool(c.config.productVariables.BuildFromSourceStub)
2041}
2042
Jihoon Kang1bff0342023-01-17 20:40:22 +00002043func (c *config) BuildFromTextStub() bool {
Jihoon Kang1975d3e2023-10-16 23:24:11 +00002044 // TODO: b/302320354 - Remove the coverage build specific logic once the
2045 // robust solution for handling native properties in from-text stub build
2046 // is implemented.
Jihoon Kangc1b04d62023-11-16 19:07:04 +00002047 return !c.buildFromSourceStub &&
2048 !c.JavaCoverageEnabled() &&
2049 !c.deviceConfig.BuildFromSourceStub()
Jihoon Kang1bff0342023-01-17 20:40:22 +00002050}
Spandan Das4deab282023-03-30 17:06:32 +00002051
2052func (c *config) SetBuildFromTextStub(b bool) {
Jihoon Kang2a929ad2023-06-08 19:02:07 +00002053 c.buildFromSourceStub = !b
Jihoon Kangcbcad7c2023-06-01 22:31:52 +00002054 c.productVariables.Build_from_text_stub = boolPtr(b)
Spandan Das4deab282023-03-30 17:06:32 +00002055}
Jihoon Kang1c92c3e2023-03-23 17:44:51 +00002056
Jihoon Kang1c92c3e2023-03-23 17:44:51 +00002057func (c *config) SetApiLibraries(libs []string) {
2058 c.apiLibraries = make(map[string]struct{})
2059 for _, lib := range libs {
2060 c.apiLibraries[lib] = struct{}{}
2061 }
2062}
2063
2064func (c *config) GetApiLibraries() map[string]struct{} {
2065 return c.apiLibraries
2066}
Inseob Kim5bac3b62023-08-25 21:29:46 +09002067
2068func (c *deviceConfig) CheckVendorSeappViolations() bool {
2069 return Bool(c.config.productVariables.CheckVendorSeappViolations)
2070}
Jihoon Kangcfbc4072023-09-20 01:02:18 +00002071
Inseob Kime4e85d52023-10-25 23:53:58 +09002072func (c *config) GetBuildFlag(name string) (string, bool) {
2073 val, ok := c.productVariables.BuildFlags[name]
2074 return val, ok
2075}
Spandan Dase3fcb412023-10-26 20:48:02 +00002076
Colin Cross8f1b0332024-01-25 13:39:06 -08002077func (c *config) UseResourceProcessorByDefault() bool {
2078 return c.productVariables.GetBuildFlagBool("RELEASE_USE_RESOURCE_PROCESSOR_BY_DEFAULT")
2079}
2080
Spandan Dase3fcb412023-10-26 20:48:02 +00002081var (
2082 mainlineApexContributionBuildFlags = []string{
Spandan Das06c64f02024-02-28 18:37:20 +00002083 "RELEASE_APEX_CONTRIBUTIONS_ADBD",
Spandan Dase3fcb412023-10-26 20:48:02 +00002084 "RELEASE_APEX_CONTRIBUTIONS_ADSERVICES",
2085 "RELEASE_APEX_CONTRIBUTIONS_APPSEARCH",
2086 "RELEASE_APEX_CONTRIBUTIONS_ART",
2087 "RELEASE_APEX_CONTRIBUTIONS_BLUETOOTH",
Spandan Das06c64f02024-02-28 18:37:20 +00002088 "RELEASE_APEX_CONTRIBUTIONS_CAPTIVEPORTALLOGIN",
2089 "RELEASE_APEX_CONTRIBUTIONS_CELLBROADCAST",
Spandan Dase3fcb412023-10-26 20:48:02 +00002090 "RELEASE_APEX_CONTRIBUTIONS_CONFIGINFRASTRUCTURE",
2091 "RELEASE_APEX_CONTRIBUTIONS_CONNECTIVITY",
2092 "RELEASE_APEX_CONTRIBUTIONS_CONSCRYPT",
2093 "RELEASE_APEX_CONTRIBUTIONS_CRASHRECOVERY",
2094 "RELEASE_APEX_CONTRIBUTIONS_DEVICELOCK",
Spandan Das06c64f02024-02-28 18:37:20 +00002095 "RELEASE_APEX_CONTRIBUTIONS_DOCUMENTSUIGOOGLE",
2096 "RELEASE_APEX_CONTRIBUTIONS_EXTSERVICES",
Spandan Dase3fcb412023-10-26 20:48:02 +00002097 "RELEASE_APEX_CONTRIBUTIONS_HEALTHFITNESS",
2098 "RELEASE_APEX_CONTRIBUTIONS_IPSEC",
2099 "RELEASE_APEX_CONTRIBUTIONS_MEDIA",
2100 "RELEASE_APEX_CONTRIBUTIONS_MEDIAPROVIDER",
Spandan Das06c64f02024-02-28 18:37:20 +00002101 "RELEASE_APEX_CONTRIBUTIONS_NETWORKSTACKGOOGLE",
2102 "RELEASE_APEX_CONTRIBUTIONS_NEURALNETWORKS",
Spandan Dase3fcb412023-10-26 20:48:02 +00002103 "RELEASE_APEX_CONTRIBUTIONS_ONDEVICEPERSONALIZATION",
2104 "RELEASE_APEX_CONTRIBUTIONS_PERMISSION",
2105 "RELEASE_APEX_CONTRIBUTIONS_REMOTEKEYPROVISIONING",
Spandan Das06c64f02024-02-28 18:37:20 +00002106 "RELEASE_APEX_CONTRIBUTIONS_RESOLV",
Spandan Dase3fcb412023-10-26 20:48:02 +00002107 "RELEASE_APEX_CONTRIBUTIONS_SCHEDULING",
2108 "RELEASE_APEX_CONTRIBUTIONS_SDKEXTENSIONS",
Spandan Das06c64f02024-02-28 18:37:20 +00002109 "RELEASE_APEX_CONTRIBUTIONS_SWCODEC",
Spandan Dase3fcb412023-10-26 20:48:02 +00002110 "RELEASE_APEX_CONTRIBUTIONS_STATSD",
Spandan Das06c64f02024-02-28 18:37:20 +00002111 "RELEASE_APEX_CONTRIBUTIONS_TZDATA",
Spandan Dase3fcb412023-10-26 20:48:02 +00002112 "RELEASE_APEX_CONTRIBUTIONS_UWB",
2113 "RELEASE_APEX_CONTRIBUTIONS_WIFI",
2114 }
2115)
2116
2117// Returns the list of _selected_ apex_contributions
2118// Each mainline module will have one entry in the list
2119func (c *config) AllApexContributions() []string {
2120 ret := []string{}
2121 for _, f := range mainlineApexContributionBuildFlags {
2122 if val, exists := c.GetBuildFlag(f); exists && val != "" {
2123 ret = append(ret, val)
2124 }
2125 }
2126 return ret
2127}
Spandan Das8ab28dd2024-02-17 03:31:45 +00002128
Spandan Das0d24ade2024-03-08 04:20:15 +00002129func (c *config) BuildIgnoreApexContributionContents() *bool {
Spandan Das8ab28dd2024-02-17 03:31:45 +00002130 return c.productVariables.BuildIgnoreApexContributionContents
2131}
Inseob Kim8fa54da2024-03-19 16:48:59 +09002132
2133func (c *config) ProductLocales() []string {
2134 return c.productVariables.ProductLocales
2135}
2136
2137func (c *config) ProductDefaultWifiChannels() []string {
2138 return c.productVariables.ProductDefaultWifiChannels
2139}
2140
2141func (c *config) BoardUseVbmetaDigestInFingerprint() bool {
2142 return Bool(c.productVariables.BoardUseVbmetaDigestInFingerprint)
2143}
2144
2145func (c *config) OemProperties() []string {
2146 return c.productVariables.OemProperties
2147}