blob: a2bf53336fb406fef7b8127f6e6a5b4e6854a1a7 [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"
Colin Cross3f40fa42015-01-30 17:27:36 -080025 "runtime"
Inseob Kim60c32f02020-12-21 22:53:05 +090026 "strconv"
Dan Willemsen34cc69e2015-09-23 15:26:20 -070027 "strings"
Colin Crossc1e86a32015-04-15 12:33:28 -070028 "sync"
Cole Faustd92430e2024-02-07 01:02:04 +000029 "unicode"
Colin Cross6ff51382015-12-17 16:39:19 -080030
Yu Liu67a28422024-03-05 00:36:31 +000031 "android/soong/shared"
32
Colin Cross98be1bb2019-12-13 20:41:13 -080033 "github.com/google/blueprint"
Colin Crosse87040b2017-12-11 15:52:26 -080034 "github.com/google/blueprint/bootstrap"
Colin Cross98be1bb2019-12-13 20:41:13 -080035 "github.com/google/blueprint/pathtools"
Colin Cross6ff51382015-12-17 16:39:19 -080036 "github.com/google/blueprint/proptools"
Colin Cross9d34f352019-11-22 16:03:51 -080037
38 "android/soong/android/soongconfig"
Colin Cross77cdcfd2021-03-12 11:28:25 -080039 "android/soong/remoteexec"
Colin Cross3f40fa42015-01-30 17:27:36 -080040)
41
Jingwen Chenc711fec2020-11-22 23:52:50 -050042// Bool re-exports proptools.Bool for the android package.
Colin Cross6ff51382015-12-17 16:39:19 -080043var Bool = proptools.Bool
Jingwen Chenc711fec2020-11-22 23:52:50 -050044
45// String re-exports proptools.String for the android package.
Jack He8cc71432016-12-08 15:45:07 -080046var String = proptools.String
Jingwen Chenc711fec2020-11-22 23:52:50 -050047
48// StringDefault re-exports proptools.StringDefault for the android package.
Jeongik Cha219141c2020-08-06 23:00:37 +090049var StringDefault = proptools.StringDefault
Jiyong Park6a927c42020-01-21 02:03:43 +090050
Jingwen Chenc711fec2020-11-22 23:52:50 -050051// FutureApiLevelInt is a placeholder constant for unreleased API levels.
Dan Albert0b176c82020-07-23 16:43:25 -070052const FutureApiLevelInt = 10000
53
Spandan Das15da5882023-03-02 23:36:39 +000054// PrivateApiLevel represents the api level of SdkSpecPrivate (sdk_version: "")
55// This api_level exists to differentiate user-provided "" from "current" sdk_version
56// The differentiation is necessary to enable different validation rules for these two possible values.
57var PrivateApiLevel = ApiLevel{
58 value: "current", // The value is current since aidl expects `current` as the default (TestAidlFlagsWithMinSdkVersion)
59 number: FutureApiLevelInt + 1, // This is used to differentiate it from FutureApiLevel
60 isPreview: true,
61}
62
Jingwen Chenc711fec2020-11-22 23:52:50 -050063// FutureApiLevel represents unreleased API levels.
Dan Albert0b176c82020-07-23 16:43:25 -070064var FutureApiLevel = ApiLevel{
65 value: "current",
66 number: FutureApiLevelInt,
67 isPreview: true,
68}
Colin Cross6ff51382015-12-17 16:39:19 -080069
Jingwen Chenc4d91bc2020-11-24 22:59:26 -050070// The product variables file name, containing product config from Kati.
Dan Willemsen87b17d12015-07-14 00:39:06 -070071const productVariablesFileName = "soong.variables"
Colin Cross3f40fa42015-01-30 17:27:36 -080072
Colin Cross9272ade2016-08-17 15:24:12 -070073// A Config object represents the entire build configuration for Android.
Colin Crossc3c0a492015-04-10 15:43:55 -070074type Config struct {
75 *config
76}
77
Chris Parsonsad876012022-08-20 14:48:32 -040078type SoongBuildMode int
79
Sasha Smundakaf5ca922022-12-12 21:23:34 -080080type CmdArgs struct {
81 bootstrap.Args
Kiyoung Kima37d9ba2023-04-19 13:13:45 +090082 RunGoTests bool
83 OutDir string
84 SoongOutDir string
85 SoongVariables string
Sasha Smundakaf5ca922022-12-12 21:23:34 -080086
Colin Crossb63d7b32023-12-07 16:54:51 -080087 BazelQueryViewDir string
88 ModuleGraphFile string
89 ModuleActionsFile string
90 DocFile string
Sasha Smundakaf5ca922022-12-12 21:23:34 -080091
Jihoon Kang2a929ad2023-06-08 19:02:07 +000092 BuildFromSourceStub bool
MarkDacekf47e1422023-04-19 16:47:36 +000093
94 EnsureAllowlistIntegrity bool
Sasha Smundakaf5ca922022-12-12 21:23:34 -080095}
96
Chris Parsonsad876012022-08-20 14:48:32 -040097// Build modes that soong_build can run as.
98const (
99 // Don't use bazel at all during module analysis.
100 AnalysisNoBazel SoongBuildMode = iota
101
Chris Parsonsad876012022-08-20 14:48:32 -0400102 // Generate BUILD files which faithfully represent the dependency graph of
103 // blueprint modules. Individual BUILD targets will not, however, faitfhully
104 // express build semantics.
105 GenerateQueryView
106
107 // Create a JSON representation of the module graph and exit.
108 GenerateModuleGraph
109
110 // Generate a documentation file for module type definitions and exit.
111 GenerateDocFile
Chris Parsonsad876012022-08-20 14:48:32 -0400112)
113
Inseob Kim8fa54da2024-03-19 16:48:59 +0900114const testKeyDir = "build/make/target/product/security"
115
Lukacs T. Berkib078ade2021-08-31 10:42:08 +0200116// SoongOutDir returns the build output directory for the configuration.
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200117func (c Config) SoongOutDir() string {
118 return c.soongOutDir
Jeff Gastonefc1b412017-03-29 17:29:06 -0700119}
120
Colin Cross31a67452023-11-02 16:57:08 -0700121// tempDir returns the path to out/soong/.temp, which is cleared at the beginning of every build.
122func (c Config) tempDir() string {
123 return shared.TempDirForOutDir(c.soongOutDir)
124}
125
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200126func (c Config) OutDir() string {
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200127 return c.outDir
Lukacs T. Berki89e9a162021-03-12 08:31:32 +0100128}
129
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200130func (c Config) RunGoTests() bool {
131 return c.runGoTests
132}
133
Lukacs T. Berki5f6cb1d2021-03-17 15:03:14 +0100134func (c Config) DebugCompilation() bool {
135 return false // Never compile Go code in the main build for debugging
136}
137
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200138func (c Config) Subninjas() []string {
139 return []string{}
140}
141
142func (c Config) PrimaryBuilderInvocations() []bootstrap.PrimaryBuilderInvocation {
143 return []bootstrap.PrimaryBuilderInvocation{}
144}
145
Paul Duffin74135582022-10-06 11:01:59 +0100146// RunningInsideUnitTest returns true if this code is being run as part of a Soong unit test.
147func (c Config) RunningInsideUnitTest() bool {
148 return c.config.TestProductVariables != nil
149}
150
Pratyushfaec4db2023-07-20 11:19:04 +0000151// DisableHiddenApiChecks returns true if hiddenapi checks have been disabled.
Alyssa Ketpreechasawat7daf2782023-11-01 13:58:39 +0000152// For 'eng' target variant hiddenapi checks are disabled by default for performance optimisation,
Pratyushfaec4db2023-07-20 11:19:04 +0000153// but can be enabled by setting environment variable ENABLE_HIDDENAPI_FLAGS=true.
154// For other target variants hiddenapi check are enabled by default but can be disabled by
155// setting environment variable UNSAFE_DISABLE_HIDDENAPI_FLAGS=true.
156// If both ENABLE_HIDDENAPI_FLAGS=true and UNSAFE_DISABLE_HIDDENAPI_FLAGS=true, then
157// ENABLE_HIDDENAPI_FLAGS=true will be triggered and hiddenapi checks will be considered enabled.
158func (c Config) DisableHiddenApiChecks() bool {
159 return !c.IsEnvTrue("ENABLE_HIDDENAPI_FLAGS") &&
160 (c.IsEnvTrue("UNSAFE_DISABLE_HIDDENAPI_FLAGS") ||
Alyssa Ketpreechasawat7daf2782023-11-01 13:58:39 +0000161 Bool(c.productVariables.Eng))
162}
163
164// DisableVerifyOverlaps returns true if verify_overlaps is skipped.
165// Mismatch in version of apexes and module SDK is required for mainline prebuilts to work in
166// trunk stable.
167// Thus, verify_overlaps is disabled when RELEASE_DEFAULT_MODULE_BUILD_FROM_SOURCE is set to false.
168// TODO(b/308174018): Re-enable verify_overlaps for both builr from source/mainline prebuilts.
169func (c Config) DisableVerifyOverlaps() bool {
Spandan Das07145102024-03-18 23:25:30 +0000170 if c.IsEnvFalse("DISABLE_VERIFY_OVERLAPS") && c.ReleaseDisableVerifyOverlaps() {
171 panic("The current release configuration does not support verify_overlaps. DISABLE_VERIFY_OVERLAPS cannot be set to false")
172 }
173 return c.IsEnvTrue("DISABLE_VERIFY_OVERLAPS") || c.ReleaseDisableVerifyOverlaps() || !c.ReleaseDefaultModuleBuildFromSource()
Pratyushfaec4db2023-07-20 11:19:04 +0000174}
175
Qing Shen713c5422024-08-23 04:09:18 +0000176func (c Config) CoverageSuffix() string {
177 if v := c.IsEnvTrue("EMMA_INSTRUMENT"); v {
178 return "coverage."
179 }
180 return ""
181}
182
Juan Yescas05d4d902023-04-07 10:35:35 -0700183// MaxPageSizeSupported returns the max page size supported by the device. This
184// value will define the ELF segment alignment for binaries (executables and
185// shared libraries).
186func (c Config) MaxPageSizeSupported() string {
187 return String(c.config.productVariables.DeviceMaxPageSizeSupported)
188}
189
Vilas Bhatb3d2d222023-12-04 22:51:20 +0000190// NoBionicPageSizeMacro returns true when AOSP is page size agnostic.
191// This means that the bionic's macro PAGE_SIZE won't be defined.
192// Returns false when AOSP is NOT page size agnostic.
193// This means that bionic's macro PAGE_SIZE is defined.
194func (c Config) NoBionicPageSizeMacro() bool {
195 return Bool(c.config.productVariables.DeviceNoBionicPageSizeMacro)
Juan Yescas01065602023-08-09 08:34:37 -0700196}
197
Joe Onoratofee845a2023-05-09 08:14:14 -0700198// The release version passed to aconfig, derived from RELEASE_VERSION
199func (c Config) ReleaseVersion() string {
200 return c.config.productVariables.ReleaseVersion
201}
202
Yu Liu2cc802a2023-09-05 17:19:45 -0700203// The aconfig value set passed to aconfig, derived from RELEASE_VERSION
Yu Liueebb2592023-10-12 20:31:27 -0700204func (c Config) ReleaseAconfigValueSets() []string {
Yu Liu95572ff2023-12-07 16:38:45 -0800205 return c.config.productVariables.ReleaseAconfigValueSets
Joe Onoratofee845a2023-05-09 08:14:14 -0700206}
207
LaMont Jones21d04d92024-06-11 11:28:54 -0700208func (c Config) ReleaseAconfigExtraReleaseConfigs() []string {
209 result := []string{}
210 if val, ok := c.config.productVariables.BuildFlags["RELEASE_ACONFIG_EXTRA_RELEASE_CONFIGS"]; ok {
211 if len(val) > 0 {
212 // Remove any duplicates from the list.
213 found := make(map[string]bool)
214 for _, k := range strings.Split(val, " ") {
215 if !found[k] {
216 found[k] = true
217 result = append(result, k)
218 }
219 }
220 }
221 }
222 return result
223}
224
225func (c Config) ReleaseAconfigExtraReleaseConfigsValueSets() map[string][]string {
226 result := make(map[string][]string)
227 for _, rcName := range c.ReleaseAconfigExtraReleaseConfigs() {
228 if value, ok := c.config.productVariables.BuildFlags["RELEASE_ACONFIG_VALUE_SETS_"+rcName]; ok {
229 result[rcName] = strings.Split(value, " ")
230 }
231 }
232 return result
233}
234
Zhi Dou3f65a412023-08-10 21:47:40 +0000235// The flag default permission value passed to aconfig
236// derived from RELEASE_ACONFIG_FLAG_DEFAULT_PERMISSION
237func (c Config) ReleaseAconfigFlagDefaultPermission() string {
238 return c.config.productVariables.ReleaseAconfigFlagDefaultPermission
239}
240
Yi Kong76e99ad2024-09-18 18:43:26 +0000241// Enable object size sanitizer
242func (c Config) ReleaseBuildObjectSizeSanitizer() bool {
243 return c.config.productVariables.GetBuildFlagBool("RELEASE_BUILD_OBJECT_SIZE_SANITIZER")
244}
245
Alyssa Ketpreechasawat34ab8792023-10-06 07:01:22 +0000246// The flag indicating behavior for the tree wrt building modules or using prebuilts
247// derived from RELEASE_DEFAULT_MODULE_BUILD_FROM_SOURCE
248func (c Config) ReleaseDefaultModuleBuildFromSource() bool {
249 return c.config.productVariables.ReleaseDefaultModuleBuildFromSource == nil ||
250 Bool(c.config.productVariables.ReleaseDefaultModuleBuildFromSource)
251}
252
Alyssa Ketpreechasawat3a6eced2024-08-22 15:09:16 +0000253func (c Config) ReleaseDefaultUpdatableModuleVersion() string {
254 if val, exists := c.GetBuildFlag("RELEASE_DEFAULT_UPDATABLE_MODULE_VERSION"); exists {
255 return val
256 }
257 panic("RELEASE_DEFAULT_UPDATABLE_MODULE_VERSION is missing from build flags.")
258}
259
Spandan Das07145102024-03-18 23:25:30 +0000260func (c Config) ReleaseDisableVerifyOverlaps() bool {
261 return c.config.productVariables.GetBuildFlagBool("RELEASE_DISABLE_VERIFY_OVERLAPS_CHECK")
262}
263
Jihoon Kang59198152024-02-06 22:43:18 +0000264// Enables flagged apis annotated with READ_WRITE aconfig flags to be included in the stubs
265// and hiddenapi flags so that they are accessible at runtime
266func (c Config) ReleaseExportRuntimeApis() bool {
Jihoon Kang35349462024-02-22 19:52:46 +0000267 return Bool(c.config.productVariables.ExportRuntimeApis)
Jihoon Kang59198152024-02-06 22:43:18 +0000268}
269
Aleksei Vetrov146e9822023-11-24 19:54:26 +0000270// Enables ABI monitoring of NDK libraries
271func (c Config) ReleaseNdkAbiMonitored() bool {
272 return c.config.productVariables.GetBuildFlagBool("RELEASE_NDK_ABI_MONITORED")
273}
274
Ted Bauer10fff942024-04-29 19:30:23 +0000275// Enable read flag from new storage, for C/C++
276func (c Config) ReleaseReadFromNewStorageCc() bool {
277 return c.config.productVariables.GetBuildFlagBool("RELEASE_READ_FROM_NEW_STORAGE_CC")
278}
279
Jihoon Kangbd093452023-12-26 19:08:01 +0000280func (c Config) ReleaseHiddenApiExportableStubs() bool {
Jihoon Kangb36fc542024-02-22 19:35:26 +0000281 return c.config.productVariables.GetBuildFlagBool("RELEASE_HIDDEN_API_EXPORTABLE_STUBS") ||
282 Bool(c.config.productVariables.HiddenapiExportableStubs)
Jihoon Kangbd093452023-12-26 19:08:01 +0000283}
284
Dennis Shen58378c92024-04-03 19:26:36 +0000285// Enable read flag from new storage
286func (c Config) ReleaseReadFromNewStorage() bool {
287 return c.config.productVariables.GetBuildFlagBool("RELEASE_READ_FROM_NEW_STORAGE")
288}
289
Spandan Das3d9b69e2024-10-07 19:03:45 +0000290func (c Config) ReleaseCreateAconfigStorageFile() bool {
291 return c.config.productVariables.GetBuildFlagBool("RELEASE_CREATE_ACONFIG_STORAGE_FILE")
292}
293
Jingwen Chenc711fec2020-11-22 23:52:50 -0500294// A DeviceConfig object represents the configuration for a particular device
295// being built. For now there will only be one of these, but in the future there
296// may be multiple devices being built.
Colin Cross9272ade2016-08-17 15:24:12 -0700297type DeviceConfig struct {
298 *deviceConfig
299}
300
Jingwen Chenc711fec2020-11-22 23:52:50 -0500301// VendorConfig represents the configuration for vendor-specific behavior.
Colin Cross9d34f352019-11-22 16:03:51 -0800302type VendorConfig soongconfig.SoongConfig
Dan Willemsen0fe78662018-03-26 12:41:18 -0700303
Jingwen Chenc711fec2020-11-22 23:52:50 -0500304// Definition of general build configuration for soong_build. Some of these
Jingwen Chenc4d91bc2020-11-24 22:59:26 -0500305// product configuration values are read from Kati-generated soong.variables.
Colin Cross1332b002015-04-07 17:11:30 -0700306type config struct {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500307 // Options configurable with soong.variables
Cole Faustf8231dd2023-04-21 17:37:11 -0700308 productVariables ProductVariables
Colin Cross3f40fa42015-01-30 17:27:36 -0800309
Dan Willemsen674dc7f2018-03-12 18:06:05 -0700310 // Only available on configs created by TestConfig
Cole Faustf8231dd2023-04-21 17:37:11 -0700311 TestProductVariables *ProductVariables
Dan Willemsen674dc7f2018-03-12 18:06:05 -0700312
Dan Willemsen87b17d12015-07-14 00:39:06 -0700313 ProductVariablesFileName string
314
Colin Cross0c66bc62021-07-20 09:47:41 -0700315 // BuildOS stores the OsType for the OS that the build is running on.
316 BuildOS OsType
317
318 // BuildArch stores the ArchType for the CPU that the build is running on.
319 BuildArch ArchType
320
Jaewoong Jung642916f2020-10-09 17:25:15 -0700321 Targets map[OsType][]Target
322 BuildOSTarget Target // the Target for tools run on the build machine
323 BuildOSCommonTarget Target // the Target for common (java) tools run on the build machine
324 AndroidCommonTarget Target // the Target for common modules for the Android device
325 AndroidFirstDeviceTarget Target // the first Target for modules for the Android device
Dan Willemsen218f6562015-07-08 18:13:11 -0700326
Jingwen Chenc711fec2020-11-22 23:52:50 -0500327 // multilibConflicts for an ArchType is true if there is earlier configured
328 // device architecture with the same multilib value.
Colin Cross3b19f5d2019-09-17 14:45:31 -0700329 multilibConflicts map[ArchType]bool
330
Colin Cross9272ade2016-08-17 15:24:12 -0700331 deviceConfig *deviceConfig
332
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200333 outDir string // The output directory (usually out/)
334 soongOutDir string
Chris Parsons8f232a22020-06-23 17:37:05 -0400335 moduleListFile string // the path to the file which lists blueprint files to parse.
Colin Crossc1e86a32015-04-15 12:33:28 -0700336
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +0200337 runGoTests bool
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200338
Colin Cross6ccbc912017-10-10 23:07:38 -0700339 env map[string]string
Dan Willemsene7680ba2015-09-11 17:06:19 -0700340 envLock sync.Mutex
341 envDeps map[string]string
342 envFrozen bool
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800343
Jingwen Chencda22c92020-11-23 00:22:30 -0500344 // Changes behavior based on whether Kati runs after soong_build, or if soong_build
345 // runs standalone.
346 katiEnabled bool
Colin Cross1e7d3702016-08-24 15:25:47 -0700347
Colin Cross32616ed2017-09-05 21:56:44 -0700348 captureBuild bool // true for tests, saves build parameters for each module
349 ignoreEnvironment bool // true for tests, returns empty from all Getenv calls
Colin Crosscec81712017-07-13 14:43:27 -0700350
Colin Cross98be1bb2019-12-13 20:41:13 -0800351 fs pathtools.FileSystem
352 mockBpList string
353
Colin Crossb63d7b32023-12-07 16:54:51 -0800354 BuildMode SoongBuildMode
Jingwen Chen12b4c272021-03-10 02:05:59 -0500355
Colin Cross5e6a7972020-06-07 16:56:32 -0700356 // If testAllowNonExistentPaths is true then PathForSource and PathForModuleSrc won't error
357 // in tests when a path doesn't exist.
Pedro Loureiro5d190cc2021-02-15 15:41:33 +0000358 TestAllowNonExistentPaths bool
Colin Cross5e6a7972020-06-07 16:56:32 -0700359
Jingwen Chenc711fec2020-11-22 23:52:50 -0500360 // The list of files that when changed, must invalidate soong_build to
361 // regenerate build.ninja.
Colin Cross12129292020-10-29 18:23:58 -0700362 ninjaFileDepsSet sync.Map
363
Colin Cross9272ade2016-08-17 15:24:12 -0700364 OncePer
MarkDacekff851b82022-04-21 18:33:17 +0000365
Jihoon Kang2a929ad2023-06-08 19:02:07 +0000366 // If buildFromSourceStub is true then the Java API stubs are
367 // built from the source Java files, not the signature text files.
368 buildFromSourceStub bool
MarkDacekf47e1422023-04-19 16:47:36 +0000369
370 // If ensureAllowlistIntegrity is true, then the presence of any allowlisted
371 // modules that aren't mixed-built for at least one variant will cause a build
372 // failure
373 ensureAllowlistIntegrity bool
Colin Cross9272ade2016-08-17 15:24:12 -0700374}
375
376type deviceConfig struct {
Dan Willemsen00269f22017-07-06 16:59:48 -0700377 config *config
Colin Cross9272ade2016-08-17 15:24:12 -0700378 OncePer
Colin Cross3f40fa42015-01-30 17:27:36 -0800379}
380
Colin Cross485e5722015-08-27 13:28:01 -0700381type jsonConfigurable interface {
Colin Cross27385972015-09-18 10:57:10 -0700382 SetDefaultConfig()
Colin Cross485e5722015-08-27 13:28:01 -0700383}
Colin Cross3f40fa42015-01-30 17:27:36 -0800384
Colin Cross485e5722015-08-27 13:28:01 -0700385func loadConfig(config *config) error {
Colin Cross988414c2020-01-11 01:11:46 +0000386 return loadFromConfigFile(&config.productVariables, absolutePath(config.ProductVariablesFileName))
Colin Cross485e5722015-08-27 13:28:01 -0700387}
388
Cole Faustd92430e2024-02-07 01:02:04 +0000389// Checks if the string is a valid go identifier. This is equivalent to blueprint's definition
390// of an identifier, so it will match the same identifiers as those that can be used in bp files.
391func isGoIdentifier(ident string) bool {
392 for i, r := range ident {
393 valid := r == '_' || unicode.IsLetter(r) || unicode.IsDigit(r) && i > 0
394 if !valid {
395 return false
396 }
397 }
398 return len(ident) > 0
399}
400
Jingwen Chenc711fec2020-11-22 23:52:50 -0500401// loadFromConfigFile loads and decodes configuration options from a JSON file
402// in the current working directory.
Cole Faustf8231dd2023-04-21 17:37:11 -0700403func loadFromConfigFile(configurable *ProductVariables, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800404 // Try to open the file
Colin Cross485e5722015-08-27 13:28:01 -0700405 configFileReader, err := os.Open(filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800406 defer configFileReader.Close()
407 if os.IsNotExist(err) {
408 // Need to create a file, so that blueprint & ninja don't get in
409 // a dependency tracking loop.
410 // Make a file-configurable-options with defaults, write it out using
411 // a json writer.
Colin Cross27385972015-09-18 10:57:10 -0700412 configurable.SetDefaultConfig()
413 err = saveToConfigFile(configurable, filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800414 if err != nil {
415 return err
416 }
Colin Cross15cd21a2018-02-27 11:26:02 -0800417 } else if err != nil {
418 return fmt.Errorf("config file: could not open %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800419 } else {
420 // Make a decoder for it
421 jsonDecoder := json.NewDecoder(configFileReader)
Cole Fauste1129b82024-06-04 11:10:11 -0700422 jsonDecoder.DisallowUnknownFields()
Colin Cross485e5722015-08-27 13:28:01 -0700423 err = jsonDecoder.Decode(configurable)
Colin Cross3f40fa42015-01-30 17:27:36 -0800424 if err != nil {
Colin Cross15cd21a2018-02-27 11:26:02 -0800425 return fmt.Errorf("config file: %s did not parse correctly: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800426 }
427 }
428
Liz Kammer09f947d2021-05-12 14:51:49 -0400429 if Bool(configurable.GcovCoverage) && Bool(configurable.ClangCoverage) {
430 return fmt.Errorf("GcovCoverage and ClangCoverage cannot both be set")
431 }
432
433 configurable.Native_coverage = proptools.BoolPtr(
434 Bool(configurable.GcovCoverage) ||
435 Bool(configurable.ClangCoverage))
436
Cole Faustd92430e2024-02-07 01:02:04 +0000437 // The go scanner's definition of identifiers is c-style identifiers, but allowing unicode's
438 // definition of letters and digits. This is the same scanner that blueprint uses, so it
439 // will allow the same identifiers as are valid in bp files.
440 for namespace := range configurable.VendorVars {
441 if !isGoIdentifier(namespace) {
442 return fmt.Errorf("soong config namespaces must be valid identifiers: %q", namespace)
443 }
444 for variable := range configurable.VendorVars[namespace] {
445 if !isGoIdentifier(variable) {
446 return fmt.Errorf("soong config variables must be valid identifiers: %q", variable)
447 }
448 }
449 }
450
Yuntao Xu402e9b02021-08-09 15:44:44 -0700451 // when Platform_sdk_final is true (or PLATFORM_VERSION_CODENAME is REL), use Platform_sdk_version;
452 // if false (pre-released version, for example), use Platform_sdk_codename.
453 if Bool(configurable.Platform_sdk_final) {
454 if configurable.Platform_sdk_version != nil {
455 configurable.Platform_sdk_version_or_codename =
456 proptools.StringPtr(strconv.Itoa(*(configurable.Platform_sdk_version)))
457 } else {
458 return fmt.Errorf("Platform_sdk_version cannot be pointed by a NULL pointer")
459 }
460 } else {
461 configurable.Platform_sdk_version_or_codename =
462 proptools.StringPtr(String(configurable.Platform_sdk_codename))
463 }
464
Cole Faustad186492024-06-14 14:13:54 -0700465 return nil
Colin Cross3f40fa42015-01-30 17:27:36 -0800466}
467
Colin Crossd8f20142016-11-03 09:43:26 -0700468// atomically writes the config file in case two copies of soong_build are running simultaneously
469// (for example, docs generation and ninja manifest generation)
Cole Faustf8231dd2023-04-21 17:37:11 -0700470func saveToConfigFile(config *ProductVariables, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800471 data, err := json.MarshalIndent(&config, "", " ")
472 if err != nil {
473 return fmt.Errorf("cannot marshal config data: %s", err.Error())
474 }
475
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800476 f, err := os.CreateTemp(filepath.Dir(filename), "config")
Colin Cross3f40fa42015-01-30 17:27:36 -0800477 if err != nil {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500478 return fmt.Errorf("cannot create empty config file %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800479 }
Colin Crossd8f20142016-11-03 09:43:26 -0700480 defer os.Remove(f.Name())
481 defer f.Close()
Colin Cross3f40fa42015-01-30 17:27:36 -0800482
Colin Crossd8f20142016-11-03 09:43:26 -0700483 _, err = f.Write(data)
Colin Cross3f40fa42015-01-30 17:27:36 -0800484 if err != nil {
Colin Cross485e5722015-08-27 13:28:01 -0700485 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
486 }
487
Colin Crossd8f20142016-11-03 09:43:26 -0700488 _, err = f.WriteString("\n")
Colin Cross485e5722015-08-27 13:28:01 -0700489 if err != nil {
490 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800491 }
492
Colin Crossd8f20142016-11-03 09:43:26 -0700493 f.Close()
494 os.Rename(f.Name(), filename)
495
Colin Cross3f40fa42015-01-30 17:27:36 -0800496 return nil
497}
498
Colin Cross988414c2020-01-11 01:11:46 +0000499// NullConfig returns a mostly empty Config for use by standalone tools like dexpreopt_gen that
500// use the android package.
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200501func NullConfig(outDir, soongOutDir string) Config {
Colin Cross988414c2020-01-11 01:11:46 +0000502 return Config{
503 config: &config{
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200504 outDir: outDir,
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200505 soongOutDir: soongOutDir,
506 fs: pathtools.OsFs,
Colin Cross988414c2020-01-11 01:11:46 +0000507 },
508 }
509}
510
Jingwen Chenc711fec2020-11-22 23:52:50 -0500511// NewConfig creates a new Config object. The srcDir argument specifies the path
512// to the root source directory. It also loads the config file, if found.
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800513func NewConfig(cmdArgs CmdArgs, availableEnv map[string]string) (Config, error) {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500514 // Make a config with default options.
Colin Cross9272ade2016-08-17 15:24:12 -0700515 config := &config{
Kiyoung Kima37d9ba2023-04-19 13:13:45 +0900516 ProductVariablesFileName: cmdArgs.SoongVariables,
Dan Willemsen87b17d12015-07-14 00:39:06 -0700517
Lukacs T. Berki53b2f362021-04-12 14:04:24 +0200518 env: availableEnv,
Colin Cross6ccbc912017-10-10 23:07:38 -0700519
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800520 outDir: cmdArgs.OutDir,
521 soongOutDir: cmdArgs.SoongOutDir,
522 runGoTests: cmdArgs.RunGoTests,
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +0200523 multilibConflicts: make(map[ArchType]bool),
Colin Cross98be1bb2019-12-13 20:41:13 -0800524
Colin Crossb63d7b32023-12-07 16:54:51 -0800525 moduleListFile: cmdArgs.ModuleListFile,
526 fs: pathtools.NewOsFs(absSrcDir),
Chris Parsons9402ca82023-02-23 17:28:06 -0500527
Jihoon Kang2a929ad2023-06-08 19:02:07 +0000528 buildFromSourceStub: cmdArgs.BuildFromSourceStub,
Colin Cross68f55102015-03-25 14:43:57 -0700529 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800530
Dan Willemsen00269f22017-07-06 16:59:48 -0700531 config.deviceConfig = &deviceConfig{
Colin Cross9272ade2016-08-17 15:24:12 -0700532 config: config,
533 }
534
Liz Kammer7941b302020-07-28 13:27:34 -0700535 // Soundness check of the build and source directories. This won't catch strange
536 // configurations with symlinks, but at least checks the obvious case.
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800537 absBuildDir, err := filepath.Abs(cmdArgs.SoongOutDir)
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700538 if err != nil {
539 return Config{}, err
540 }
541
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200542 absSrcDir, err := filepath.Abs(".")
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700543 if err != nil {
544 return Config{}, err
545 }
546
547 if strings.HasPrefix(absSrcDir, absBuildDir) {
548 return Config{}, fmt.Errorf("Build dir must not contain source directory")
549 }
550
Colin Cross3f40fa42015-01-30 17:27:36 -0800551 // Load any configurable options from the configuration file
Colin Cross9272ade2016-08-17 15:24:12 -0700552 err = loadConfig(config)
Colin Cross3f40fa42015-01-30 17:27:36 -0800553 if err != nil {
Colin Crossc3c0a492015-04-10 15:43:55 -0700554 return Config{}, err
Colin Cross3f40fa42015-01-30 17:27:36 -0800555 }
556
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800557 KatiEnabledMarkerFile := filepath.Join(cmdArgs.SoongOutDir, ".soong.kati_enabled")
Jingwen Chencda22c92020-11-23 00:22:30 -0500558 if _, err := os.Stat(absolutePath(KatiEnabledMarkerFile)); err == nil {
559 config.katiEnabled = true
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800560 }
561
Colin Cross0c66bc62021-07-20 09:47:41 -0700562 determineBuildOS(config)
563
Jingwen Chenc711fec2020-11-22 23:52:50 -0500564 // Sets up the map of target OSes to the finer grained compilation targets
565 // that are configured from the product variables.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700566 targets, err := decodeTargetProductVariables(config)
Dan Willemsen218f6562015-07-08 18:13:11 -0700567 if err != nil {
568 return Config{}, err
569 }
570
Paul Duffin1356d8c2020-02-25 19:26:33 +0000571 // Make the CommonOS OsType available for all products.
572 targets[CommonOS] = []Target{commonTargetMap[CommonOS.Name]}
573
Dan Albert4098deb2016-10-19 14:04:41 -0700574 var archConfig []archConfig
Jingwen Chenc4d91bc2020-11-24 22:59:26 -0500575 if config.NdkAbis() {
Dan Albert4098deb2016-10-19 14:04:41 -0700576 archConfig = getNdkAbisConfig()
Martin Stjernholmc1ecc432019-11-15 15:00:31 +0000577 } else if config.AmlAbis() {
578 archConfig = getAmlAbisConfig()
Dan Albert4098deb2016-10-19 14:04:41 -0700579 }
580
581 if archConfig != nil {
Liz Kammerb7f33662022-02-28 14:16:16 -0500582 androidTargets, err := decodeAndroidArchSettings(archConfig)
Dan Willemsen322acaf2016-01-12 23:07:05 -0800583 if err != nil {
584 return Config{}, err
585 }
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700586 targets[Android] = androidTargets
Dan Willemsen322acaf2016-01-12 23:07:05 -0800587 }
588
Colin Cross3b19f5d2019-09-17 14:45:31 -0700589 multilib := make(map[string]bool)
590 for _, target := range targets[Android] {
591 if seen := multilib[target.Arch.ArchType.Multilib]; seen {
592 config.multilibConflicts[target.Arch.ArchType] = true
593 }
594 multilib[target.Arch.ArchType.Multilib] = true
595 }
596
Jingwen Chenc711fec2020-11-22 23:52:50 -0500597 // Map of OS to compilation targets.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700598 config.Targets = targets
Jingwen Chenc711fec2020-11-22 23:52:50 -0500599
600 // Compilation targets for host tools.
Colin Cross0c66bc62021-07-20 09:47:41 -0700601 config.BuildOSTarget = config.Targets[config.BuildOS][0]
602 config.BuildOSCommonTarget = getCommonTargets(config.Targets[config.BuildOS])[0]
Jingwen Chenc711fec2020-11-22 23:52:50 -0500603
604 // Compilation targets for Android.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700605 if len(config.Targets[Android]) > 0 {
606 config.AndroidCommonTarget = getCommonTargets(config.Targets[Android])[0]
Sam Delmericocc271e22022-06-01 15:45:02 +0000607 config.AndroidFirstDeviceTarget = FirstTarget(config.Targets[Android], "lib64", "lib32")[0]
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700608 }
Dan Willemsen218f6562015-07-08 18:13:11 -0700609
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500610 setBuildMode := func(arg string, mode SoongBuildMode) {
611 if arg != "" {
612 if config.BuildMode != AnalysisNoBazel {
613 fmt.Fprintf(os.Stderr, "buildMode is already set, illegal argument: %s", arg)
614 os.Exit(1)
615 }
616 config.BuildMode = mode
617 }
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800618 }
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500619 setBuildMode(cmdArgs.BazelQueryViewDir, GenerateQueryView)
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500620 setBuildMode(cmdArgs.ModuleGraphFile, GenerateModuleGraph)
621 setBuildMode(cmdArgs.DocFile, GenerateDocFile)
MarkDacekd06db5d2022-11-29 00:47:59 +0000622
Jihoon Kangc1b04d62023-11-16 19:07:04 +0000623 config.productVariables.Build_from_text_stub = boolPtr(config.BuildFromTextStub())
624
Jingwen Chenc711fec2020-11-22 23:52:50 -0500625 return Config{config}, err
626}
Colin Cross988414c2020-01-11 01:11:46 +0000627
Colin Cross98be1bb2019-12-13 20:41:13 -0800628// mockFileSystem replaces all reads with accesses to the provided map of
629// filenames to contents stored as a byte slice.
630func (c *config) mockFileSystem(bp string, fs map[string][]byte) {
631 mockFS := map[string][]byte{}
632
633 if _, exists := mockFS["Android.bp"]; !exists {
634 mockFS["Android.bp"] = []byte(bp)
635 }
636
637 for k, v := range fs {
638 mockFS[k] = v
639 }
640
641 // no module list file specified; find every file named Blueprints or Android.bp
642 pathsToParse := []string{}
643 for candidate := range mockFS {
644 base := filepath.Base(candidate)
Lukacs T. Berkib838b0a2021-09-02 11:46:24 +0200645 if base == "Android.bp" {
Colin Cross98be1bb2019-12-13 20:41:13 -0800646 pathsToParse = append(pathsToParse, candidate)
647 }
648 }
649 if len(pathsToParse) < 1 {
650 panic(fmt.Sprintf("No Blueprint or Android.bp files found in mock filesystem: %v\n", mockFS))
651 }
652 mockFS[blueprint.MockModuleListFile] = []byte(strings.Join(pathsToParse, "\n"))
653
654 c.fs = pathtools.MockFs(mockFS)
655 c.mockBpList = blueprint.MockModuleListFile
656}
657
Lukacs T. Berkid1e3f1f2021-03-16 08:55:23 +0100658func (c *config) SetAllowMissingDependencies() {
659 c.productVariables.Allow_missing_dependencies = proptools.BoolPtr(true)
660}
661
Jingwen Chenc711fec2020-11-22 23:52:50 -0500662// BlueprintToolLocation returns the directory containing build system tools
663// from Blueprint, like soong_zip and merge_zips.
Lukacs T. Berkia806e412021-09-01 08:57:48 +0200664func (c *config) HostToolDir() string {
Colin Crossacfcc1f2021-10-25 15:40:32 -0700665 if c.KatiEnabled() {
666 return filepath.Join(c.outDir, "host", c.PrebuiltOS(), "bin")
667 } else {
668 return filepath.Join(c.soongOutDir, "host", c.PrebuiltOS(), "bin")
669 }
Dan Willemsenc2aa4a92016-05-26 15:13:03 -0700670}
671
Dan Willemsen60e62f02018-11-16 21:05:32 -0800672func (c *config) HostToolPath(ctx PathContext, tool string) Path {
Cole Faust3b703f32023-10-16 13:30:51 -0700673 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "bin", tool)
Colin Cross790ef352021-10-25 19:15:55 -0700674 return path
Dan Willemsen60e62f02018-11-16 21:05:32 -0800675}
676
Colin Cross790ef352021-10-25 19:15:55 -0700677func (c *config) HostJNIToolPath(ctx PathContext, lib string) Path {
Martin Stjernholm7260d062019-12-09 21:47:14 +0000678 ext := ".so"
679 if runtime.GOOS == "darwin" {
680 ext = ".dylib"
681 }
Cole Faust3b703f32023-10-16 13:30:51 -0700682 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "lib64", lib+ext)
Colin Cross790ef352021-10-25 19:15:55 -0700683 return path
Martin Stjernholm7260d062019-12-09 21:47:14 +0000684}
685
Colin Crossae5330a2021-11-03 13:31:22 -0700686func (c *config) HostJavaToolPath(ctx PathContext, tool string) Path {
Cole Faust3b703f32023-10-16 13:30:51 -0700687 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "framework", tool)
Colin Cross3e3eda62021-11-04 10:22:51 -0700688 return path
689}
690
Vinh Tran09581952023-05-16 16:03:20 -0400691func (c *config) HostCcSharedLibPath(ctx PathContext, lib string) Path {
692 libDir := "lib"
693 if ctx.Config().BuildArch.Multilib == "lib64" {
694 libDir = "lib64"
695 }
Cole Faust3b703f32023-10-16 13:30:51 -0700696 return pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, libDir, lib+".so")
Vinh Tran09581952023-05-16 16:03:20 -0400697}
698
Jingwen Chenc711fec2020-11-22 23:52:50 -0500699// PrebuiltOS returns the name of the host OS used in prebuilts directories.
Colin Cross1332b002015-04-07 17:11:30 -0700700func (c *config) PrebuiltOS() string {
Colin Cross3f40fa42015-01-30 17:27:36 -0800701 switch runtime.GOOS {
702 case "linux":
703 return "linux-x86"
704 case "darwin":
705 return "darwin-x86"
706 default:
707 panic("Unknown GOOS")
708 }
709}
710
711// GoRoot returns the path to the root directory of the Go toolchain.
Colin Cross1332b002015-04-07 17:11:30 -0700712func (c *config) GoRoot() string {
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200713 return fmt.Sprintf("prebuilts/go/%s", c.PrebuiltOS())
Colin Cross3f40fa42015-01-30 17:27:36 -0800714}
715
Jingwen Chenc711fec2020-11-22 23:52:50 -0500716// PrebuiltBuildTool returns the path to a tool in the prebuilts directory containing
717// checked-in tools, like Kati, Ninja or Toybox, for the current host OS.
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700718func (c *config) PrebuiltBuildTool(ctx PathContext, tool string) Path {
719 return PathForSource(ctx, "prebuilts/build-tools", c.PrebuiltOS(), "bin", tool)
720}
721
Jingwen Chenc711fec2020-11-22 23:52:50 -0500722// CpPreserveSymlinksFlags returns the host-specific flag for the cp(1) command
723// to preserve symlinks.
Colin Cross1332b002015-04-07 17:11:30 -0700724func (c *config) CpPreserveSymlinksFlags() string {
Colin Cross485e5722015-08-27 13:28:01 -0700725 switch runtime.GOOS {
Colin Cross3f40fa42015-01-30 17:27:36 -0800726 case "darwin":
727 return "-R"
728 case "linux":
729 return "-d"
730 default:
731 return ""
732 }
733}
Colin Cross68f55102015-03-25 14:43:57 -0700734
Colin Cross1332b002015-04-07 17:11:30 -0700735func (c *config) Getenv(key string) string {
Colin Cross68f55102015-03-25 14:43:57 -0700736 var val string
737 var exists bool
Colin Crossc1e86a32015-04-15 12:33:28 -0700738 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800739 defer c.envLock.Unlock()
740 if c.envDeps == nil {
741 c.envDeps = make(map[string]string)
742 }
Colin Cross68f55102015-03-25 14:43:57 -0700743 if val, exists = c.envDeps[key]; !exists {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700744 if c.envFrozen {
745 panic("Cannot access new environment variables after envdeps are frozen")
746 }
Colin Cross6ccbc912017-10-10 23:07:38 -0700747 val, _ = c.env[key]
Colin Cross68f55102015-03-25 14:43:57 -0700748 c.envDeps[key] = val
749 }
750 return val
751}
752
Colin Cross99d7c232016-11-23 16:52:04 -0800753func (c *config) GetenvWithDefault(key string, defaultValue string) string {
754 ret := c.Getenv(key)
755 if ret == "" {
756 return defaultValue
757 }
758 return ret
759}
760
761func (c *config) IsEnvTrue(key string) bool {
AdityaK19384102024-05-01 13:51:25 -0700762 value := strings.ToLower(c.Getenv(key))
Colin Cross99d7c232016-11-23 16:52:04 -0800763 return value == "1" || value == "y" || value == "yes" || value == "on" || value == "true"
764}
765
766func (c *config) IsEnvFalse(key string) bool {
AdityaK19384102024-05-01 13:51:25 -0700767 value := strings.ToLower(c.Getenv(key))
Colin Cross99d7c232016-11-23 16:52:04 -0800768 return value == "0" || value == "n" || value == "no" || value == "off" || value == "false"
769}
770
Sorin Basca253f8c02024-05-23 10:28:24 +0100771func (c *config) TargetsJava21() bool {
772 return c.IsEnvTrue("EXPERIMENTAL_TARGET_JAVA_VERSION_21")
773}
774
Jingwen Chenc711fec2020-11-22 23:52:50 -0500775// EnvDeps returns the environment variables this build depends on. The first
776// call to this function blocks future reads from the environment.
Colin Cross1332b002015-04-07 17:11:30 -0700777func (c *config) EnvDeps() map[string]string {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700778 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800779 defer c.envLock.Unlock()
Dan Willemsene7680ba2015-09-11 17:06:19 -0700780 c.envFrozen = true
Colin Cross68f55102015-03-25 14:43:57 -0700781 return c.envDeps
782}
Colin Cross35cec122015-04-02 14:37:16 -0700783
Jingwen Chencda22c92020-11-23 00:22:30 -0500784func (c *config) KatiEnabled() bool {
785 return c.katiEnabled
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800786}
787
Cole Faust11edf552023-10-13 11:32:14 -0700788func (c *config) ProductVariables() ProductVariables {
789 return c.productVariables
790}
791
Nan Zhang581fd212018-01-10 16:06:12 -0800792func (c *config) BuildId() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800793 return String(c.productVariables.BuildId)
Nan Zhang581fd212018-01-10 16:06:12 -0800794}
795
Inseob Kim8fa54da2024-03-19 16:48:59 +0900796func (c *config) DisplayBuildNumber() bool {
797 return Bool(c.productVariables.DisplayBuildNumber)
798}
799
Inseob Kim2da72af2024-06-18 11:09:12 +0900800// BuildFingerprintFile returns the path to a text file containing metadata
801// representing the current build's fingerprint.
802//
803// Rules that want to reference the build fingerprint should read from this file
804// without depending on it. They will run whenever their other dependencies
805// require them to run and get the current build fingerprint. This ensures they
806// don't rebuild on every incremental build when the build number changes.
807func (c *config) BuildFingerprintFile(ctx PathContext) Path {
808 return PathForArbitraryOutput(ctx, "target", "product", c.DeviceName(), String(c.productVariables.BuildFingerprintFile))
809}
810
Jingwen Chenc711fec2020-11-22 23:52:50 -0500811// BuildNumberFile returns the path to a text file containing metadata
812// representing the current build's number.
813//
814// Rules that want to reference the build number should read from this file
815// without depending on it. They will run whenever their other dependencies
816// require them to run and get the current build number. This ensures they don't
817// rebuild on every incremental build when the build number changes.
Colin Cross2a2e0db2020-02-21 16:55:46 -0800818func (c *config) BuildNumberFile(ctx PathContext) Path {
819 return PathForOutput(ctx, String(c.productVariables.BuildNumberFile))
Nan Zhang581fd212018-01-10 16:06:12 -0800820}
821
Inseob Kim8fa54da2024-03-19 16:48:59 +0900822// BuildHostnameFile returns the path to a text file containing metadata
823// representing the current build's host name.
824func (c *config) BuildHostnameFile(ctx PathContext) Path {
825 return PathForOutput(ctx, String(c.productVariables.BuildHostnameFile))
826}
827
828// BuildThumbprintFile returns the path to a text file containing metadata
829// representing the current build's thumbprint.
830//
831// Rules that want to reference the build thumbprint should read from this file
832// without depending on it. They will run whenever their other dependencies
833// require them to run and get the current build thumbprint. This ensures they
834// don't rebuild on every incremental build when the build thumbprint changes.
835func (c *config) BuildThumbprintFile(ctx PathContext) Path {
836 return PathForArbitraryOutput(ctx, "target", "product", c.DeviceName(), String(c.productVariables.BuildThumbprintFile))
837}
838
Jingwen Chenc711fec2020-11-22 23:52:50 -0500839// DeviceName returns the name of the current device target.
Colin Cross35cec122015-04-02 14:37:16 -0700840// TODO: take an AndroidModuleContext to select the device name for multi-device builds
Colin Cross1332b002015-04-07 17:11:30 -0700841func (c *config) DeviceName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800842 return *c.productVariables.DeviceName
Colin Cross35cec122015-04-02 14:37:16 -0700843}
844
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000845// DeviceProduct returns the current product target. There could be multiple of
846// these per device type.
847//
Chris Parsonsef615e52022-08-18 22:04:11 -0400848// NOTE: Do not base conditional logic on this value. It may break product inheritance.
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000849func (c *config) DeviceProduct() string {
850 return *c.productVariables.DeviceProduct
851}
852
Cole Faustb85d1a12022-11-08 18:14:01 -0800853// HasDeviceProduct returns if the build has a product. A build will not
854// necessarily have a product when --skip-config is passed to soong, like it is
855// in prebuilts/build-tools/build-prebuilts.sh
856func (c *config) HasDeviceProduct() bool {
857 return c.productVariables.DeviceProduct != nil
858}
859
Inseob Kim8fa54da2024-03-19 16:48:59 +0900860func (c *config) DeviceAbi() []string {
861 return c.productVariables.DeviceAbi
862}
863
Anton Hansson53c88442019-03-18 15:53:16 +0000864func (c *config) DeviceResourceOverlays() []string {
865 return c.productVariables.DeviceResourceOverlays
866}
867
868func (c *config) ProductResourceOverlays() []string {
869 return c.productVariables.ProductResourceOverlays
Colin Cross30e076a2015-04-13 13:58:27 -0700870}
871
Inseob Kim8fa54da2024-03-19 16:48:59 +0900872func (c *config) PlatformDisplayVersionName() string {
873 return String(c.productVariables.Platform_display_version_name)
874}
875
Colin Crossbfd347d2018-05-09 11:11:35 -0700876func (c *config) PlatformVersionName() string {
877 return String(c.productVariables.Platform_version_name)
878}
879
Dan Albert4f378d72020-07-23 17:32:15 -0700880func (c *config) PlatformSdkVersion() ApiLevel {
881 return uncheckedFinalApiLevel(*c.productVariables.Platform_sdk_version)
Colin Cross30e076a2015-04-13 13:58:27 -0700882}
883
Cole Faust37d27c42023-04-12 10:27:45 -0700884func (c *config) RawPlatformSdkVersion() *int {
885 return c.productVariables.Platform_sdk_version
886}
887
Mu-Le Lee5e047532022-07-27 02:32:03 +0000888func (c *config) PlatformSdkFinal() bool {
889 return Bool(c.productVariables.Platform_sdk_final)
890}
891
Colin Crossd09b0b62018-04-18 11:06:47 -0700892func (c *config) PlatformSdkCodename() string {
893 return String(c.productVariables.Platform_sdk_codename)
894}
895
Anton Hansson97d0bae2022-02-16 16:15:10 +0000896func (c *config) PlatformSdkExtensionVersion() int {
897 return *c.productVariables.Platform_sdk_extension_version
898}
899
900func (c *config) PlatformBaseSdkExtensionVersion() int {
901 return *c.productVariables.Platform_base_sdk_extension_version
902}
903
Colin Cross092c9da2019-04-02 22:56:43 -0700904func (c *config) PlatformSecurityPatch() string {
905 return String(c.productVariables.Platform_security_patch)
906}
907
908func (c *config) PlatformPreviewSdkVersion() string {
909 return String(c.productVariables.Platform_preview_sdk_version)
910}
911
912func (c *config) PlatformMinSupportedTargetSdkVersion() string {
Linus Tufvessonba270c52024-04-12 13:06:22 +0200913 var val, ok = c.productVariables.BuildFlags["RELEASE_PLATFORM_MIN_SUPPORTED_TARGET_SDK_VERSION"]
914 if !ok {
915 return ""
916 }
917 return val
Colin Cross092c9da2019-04-02 22:56:43 -0700918}
919
920func (c *config) PlatformBaseOS() string {
921 return String(c.productVariables.Platform_base_os)
922}
923
Inseob Kim4f1f3d92022-04-25 18:23:58 +0900924func (c *config) PlatformVersionLastStable() string {
925 return String(c.productVariables.Platform_version_last_stable)
926}
927
Jiyong Park37073842022-06-21 10:13:42 +0900928func (c *config) PlatformVersionKnownCodenames() string {
929 return String(c.productVariables.Platform_version_known_codenames)
930}
931
Dan Albert1a246272020-07-06 14:49:35 -0700932func (c *config) MinSupportedSdkVersion() ApiLevel {
Dan Albert6bfb6bb2022-08-17 20:11:57 +0000933 return uncheckedFinalApiLevel(21)
Dan Albert1a246272020-07-06 14:49:35 -0700934}
935
936func (c *config) FinalApiLevels() []ApiLevel {
937 var levels []ApiLevel
Dan Albert4f378d72020-07-23 17:32:15 -0700938 for i := 1; i <= c.PlatformSdkVersion().FinalOrFutureInt(); i++ {
Dan Albert1a246272020-07-06 14:49:35 -0700939 levels = append(levels, uncheckedFinalApiLevel(i))
940 }
941 return levels
942}
943
944func (c *config) PreviewApiLevels() []ApiLevel {
945 var levels []ApiLevel
Dan Albertf93ea132023-10-05 20:40:46 +0000946 i := 0
947 for _, codename := range c.PlatformVersionActiveCodenames() {
948 if codename == "REL" {
949 continue
950 }
951
Dan Albert1a246272020-07-06 14:49:35 -0700952 levels = append(levels, ApiLevel{
953 value: codename,
954 number: i,
955 isPreview: true,
956 })
Dan Albertf93ea132023-10-05 20:40:46 +0000957 i++
Dan Albert1a246272020-07-06 14:49:35 -0700958 }
959 return levels
960}
961
satayevcca4ab72021-11-30 12:33:55 +0000962func (c *config) LatestPreviewApiLevel() ApiLevel {
963 level := NoneApiLevel
964 for _, l := range c.PreviewApiLevels() {
965 if l.GreaterThan(level) {
966 level = l
967 }
968 }
969 return level
970}
971
Dan Albert1a246272020-07-06 14:49:35 -0700972func (c *config) AllSupportedApiLevels() []ApiLevel {
973 var levels []ApiLevel
974 levels = append(levels, c.FinalApiLevels()...)
975 return append(levels, c.PreviewApiLevels()...)
Dan Albertf5415d72017-08-17 16:19:59 -0700976}
977
Jingwen Chenc711fec2020-11-22 23:52:50 -0500978// DefaultAppTargetSdk returns the API level that platform apps are targeting.
979// This converts a codename to the exact ApiLevel it represents.
Dan Albert4f378d72020-07-23 17:32:15 -0700980func (c *config) DefaultAppTargetSdk(ctx EarlyModuleContext) ApiLevel {
Colin Crossd09b0b62018-04-18 11:06:47 -0700981 if Bool(c.productVariables.Platform_sdk_final) {
982 return c.PlatformSdkVersion()
Colin Crossd09b0b62018-04-18 11:06:47 -0700983 }
Jingwen Chenc711fec2020-11-22 23:52:50 -0500984 codename := c.PlatformSdkCodename()
Jiyong Park3a00e3d2023-03-27 17:39:48 +0900985 hostOnlyBuild := c.productVariables.DeviceArch == nil
Jingwen Chenc711fec2020-11-22 23:52:50 -0500986 if codename == "" {
Jiyong Park3a00e3d2023-03-27 17:39:48 +0900987 // There are some host-only builds (those are invoked by build-prebuilts.sh) which
988 // don't set platform sdk codename. Platform sdk codename makes sense only when we
989 // are building the platform. So we don't enforce the below panic for the host-only
990 // builds.
991 if hostOnlyBuild {
992 return NoneApiLevel
993 }
994 panic("Platform_sdk_codename must be set")
Jingwen Chenc711fec2020-11-22 23:52:50 -0500995 }
996 if codename == "REL" {
997 panic("Platform_sdk_codename should not be REL when Platform_sdk_final is true")
998 }
999 return ApiLevelOrPanic(ctx, codename)
Colin Crossd09b0b62018-04-18 11:06:47 -07001000}
1001
Colin Cross3bc7ffa2017-11-22 16:19:37 -08001002func (c *config) AppsDefaultVersionName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001003 return String(c.productVariables.AppsDefaultVersionName)
Colin Cross3bc7ffa2017-11-22 16:19:37 -08001004}
1005
Dan Albert31384de2017-07-28 12:39:46 -07001006// Codenames that are active in the current lunch target.
1007func (c *config) PlatformVersionActiveCodenames() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001008 return c.productVariables.Platform_version_active_codenames
Dan Albert31384de2017-07-28 12:39:46 -07001009}
1010
Dan Albert8c7a9942023-03-27 20:34:01 +00001011// All unreleased codenames.
1012func (c *config) PlatformVersionAllPreviewCodenames() []string {
1013 return c.productVariables.Platform_version_all_preview_codenames
1014}
1015
Colin Crossface4e42017-10-30 17:32:15 -07001016func (c *config) ProductAAPTConfig() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001017 return c.productVariables.AAPTConfig
Colin Cross30e076a2015-04-13 13:58:27 -07001018}
1019
Colin Crossface4e42017-10-30 17:32:15 -07001020func (c *config) ProductAAPTPreferredConfig() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001021 return String(c.productVariables.AAPTPreferredConfig)
Colin Cross30e076a2015-04-13 13:58:27 -07001022}
1023
Colin Crossface4e42017-10-30 17:32:15 -07001024func (c *config) ProductAAPTCharacteristics() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001025 return String(c.productVariables.AAPTCharacteristics)
Colin Crossface4e42017-10-30 17:32:15 -07001026}
1027
1028func (c *config) ProductAAPTPrebuiltDPI() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001029 return c.productVariables.AAPTPrebuiltDPI
Colin Cross30e076a2015-04-13 13:58:27 -07001030}
1031
Dan Willemsen34cc69e2015-09-23 15:26:20 -07001032func (c *config) DefaultAppCertificateDir(ctx PathContext) SourcePath {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001033 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -08001034 if defaultCert != "" {
1035 return PathForSource(ctx, filepath.Dir(defaultCert))
Colin Cross61ae0b72017-12-01 17:16:02 -08001036 }
Inseob Kim8fa54da2024-03-19 16:48:59 +09001037 return PathForSource(ctx, testKeyDir)
Colin Cross30e076a2015-04-13 13:58:27 -07001038}
1039
Colin Crosse1731a52017-12-14 11:22:55 -08001040func (c *config) DefaultAppCertificate(ctx PathContext) (pem, key SourcePath) {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001041 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -08001042 if defaultCert != "" {
Colin Crosse1731a52017-12-14 11:22:55 -08001043 return PathForSource(ctx, defaultCert+".x509.pem"), PathForSource(ctx, defaultCert+".pk8")
Colin Cross61ae0b72017-12-01 17:16:02 -08001044 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001045 defaultDir := c.DefaultAppCertificateDir(ctx)
1046 return defaultDir.Join(ctx, "testkey.x509.pem"), defaultDir.Join(ctx, "testkey.pk8")
Colin Cross30e076a2015-04-13 13:58:27 -07001047}
Colin Cross6ff51382015-12-17 16:39:19 -08001048
Justin Yun635e7882024-07-04 14:50:57 +09001049func (c *config) ExtraOtaKeys(ctx PathContext, recovery bool) []SourcePath {
1050 var otaKeys []string
1051 if recovery {
1052 otaKeys = c.productVariables.ExtraOtaRecoveryKeys
1053 } else {
1054 otaKeys = c.productVariables.ExtraOtaKeys
1055 }
1056
1057 otaPaths := make([]SourcePath, len(otaKeys))
1058 for i, key := range otaKeys {
1059 otaPaths[i] = PathForSource(ctx, key+".x509.pem")
1060 }
1061
1062 return otaPaths
1063}
1064
Inseob Kim8fa54da2024-03-19 16:48:59 +09001065func (c *config) BuildKeys() string {
1066 defaultCert := String(c.productVariables.DefaultAppCertificate)
1067 if defaultCert == "" || defaultCert == filepath.Join(testKeyDir, "testkey") {
1068 return "test-keys"
1069 }
1070 return "dev-keys"
1071}
1072
Jiyong Park9335a262018-12-24 11:31:58 +09001073func (c *config) ApexKeyDir(ctx ModuleContext) SourcePath {
1074 // TODO(b/121224311): define another variable such as TARGET_APEX_KEY_OVERRIDE
1075 defaultCert := String(c.productVariables.DefaultAppCertificate)
Inseob Kim8fa54da2024-03-19 16:48:59 +09001076 if defaultCert == "" || filepath.Dir(defaultCert) == testKeyDir {
Jiyong Park9335a262018-12-24 11:31:58 +09001077 // When defaultCert is unset or is set to the testkeys path, use the APEX keys
1078 // that is under the module dir
Colin Cross07e51612019-03-05 12:46:40 -08001079 return pathForModuleSrc(ctx)
Jiyong Park9335a262018-12-24 11:31:58 +09001080 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001081 // If not, APEX keys are under the specified directory
1082 return PathForSource(ctx, filepath.Dir(defaultCert))
Jiyong Park9335a262018-12-24 11:31:58 +09001083}
1084
Inseob Kim80fa7982022-08-12 21:36:25 +09001085// Certificate for the NetworkStack sepolicy context
1086func (c *config) MainlineSepolicyDevCertificatesDir(ctx ModuleContext) SourcePath {
1087 cert := String(c.productVariables.MainlineSepolicyDevCertificates)
1088 if cert != "" {
1089 return PathForSource(ctx, cert)
1090 }
1091 return c.DefaultAppCertificateDir(ctx)
1092}
1093
Jingwen Chenc711fec2020-11-22 23:52:50 -05001094// AllowMissingDependencies configures Blueprint/Soong to not fail when modules
1095// are configured to depend on non-existent modules. Note that this does not
1096// affect missing input dependencies at the Ninja level.
Colin Cross6ff51382015-12-17 16:39:19 -08001097func (c *config) AllowMissingDependencies() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001098 return Bool(c.productVariables.Allow_missing_dependencies)
Colin Cross6ff51382015-12-17 16:39:19 -08001099}
Dan Willemsen322acaf2016-01-12 23:07:05 -08001100
Jeongik Cha816a23a2020-07-08 01:09:23 +09001101// Returns true if a full platform source tree cannot be assumed.
Colin Crossfc3674a2017-09-18 17:41:52 -07001102func (c *config) UnbundledBuild() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001103 return Bool(c.productVariables.Unbundled_build)
Colin Crossfc3674a2017-09-18 17:41:52 -07001104}
1105
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +01001106// Returns true if building apps that aren't bundled with the platform.
1107// UnbundledBuild() is always true when this is true.
1108func (c *config) UnbundledBuildApps() bool {
Cole Faust701ca252021-11-23 19:02:08 -08001109 return len(c.productVariables.Unbundled_build_apps) > 0
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +01001110}
1111
Jeongik Cha4b073cd2021-06-08 11:35:00 +09001112// Returns true if building image that aren't bundled with the platform.
1113// UnbundledBuild() is always true when this is true.
1114func (c *config) UnbundledBuildImage() bool {
1115 return Bool(c.productVariables.Unbundled_build_image)
1116}
1117
Jeongik Cha816a23a2020-07-08 01:09:23 +09001118// Returns true if building modules against prebuilt SDKs.
1119func (c *config) AlwaysUsePrebuiltSdks() bool {
1120 return Bool(c.productVariables.Always_use_prebuilt_sdks)
Colin Cross1f367bf2018-12-18 22:46:24 -08001121}
1122
Colin Cross126a25c2017-10-31 13:55:34 -07001123func (c *config) MinimizeJavaDebugInfo() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001124 return Bool(c.productVariables.MinimizeJavaDebugInfo) && !Bool(c.productVariables.Eng)
Colin Cross126a25c2017-10-31 13:55:34 -07001125}
1126
Colin Crossed064c02018-09-05 16:28:13 -07001127func (c *config) Debuggable() bool {
1128 return Bool(c.productVariables.Debuggable)
1129}
1130
Jaewoong Jung1d6eb682018-11-29 15:08:44 -08001131func (c *config) Eng() bool {
1132 return Bool(c.productVariables.Eng)
1133}
1134
Inseob Kim8fa54da2024-03-19 16:48:59 +09001135func (c *config) BuildType() string {
1136 return String(c.productVariables.BuildType)
1137}
1138
Colin Crossc53c37f2021-12-08 15:42:22 -08001139// DevicePrimaryArchType returns the ArchType for the first configured device architecture, or
1140// Common if there are no device architectures.
Jiyong Park8d52f862018-07-07 18:02:07 +09001141func (c *config) DevicePrimaryArchType() ArchType {
Colin Crossc53c37f2021-12-08 15:42:22 -08001142 if androidTargets := c.Targets[Android]; len(androidTargets) > 0 {
1143 return androidTargets[0].Arch.ArchType
1144 }
1145 return Common
Jiyong Park8d52f862018-07-07 18:02:07 +09001146}
1147
Colin Cross16b23492016-01-06 14:41:07 -08001148func (c *config) SanitizeHost() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001149 return append([]string(nil), c.productVariables.SanitizeHost...)
Colin Cross16b23492016-01-06 14:41:07 -08001150}
1151
1152func (c *config) SanitizeDevice() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001153 return append([]string(nil), c.productVariables.SanitizeDevice...)
Colin Cross23ae82a2016-11-02 14:34:39 -07001154}
1155
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -07001156func (c *config) SanitizeDeviceDiag() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001157 return append([]string(nil), c.productVariables.SanitizeDeviceDiag...)
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -07001158}
1159
Colin Cross23ae82a2016-11-02 14:34:39 -07001160func (c *config) SanitizeDeviceArch() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001161 return append([]string(nil), c.productVariables.SanitizeDeviceArch...)
Colin Cross16b23492016-01-06 14:41:07 -08001162}
Colin Crossa1ad8d12016-06-01 17:09:44 -07001163
Vishwath Mohan1b017a72017-01-19 13:54:55 -08001164func (c *config) EnableCFI() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001165 if c.productVariables.EnableCFI == nil {
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -08001166 return true
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -08001167 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001168 return *c.productVariables.EnableCFI
Vishwath Mohan1b017a72017-01-19 13:54:55 -08001169}
1170
Kostya Kortchinskyd5275c82019-02-01 08:42:56 -08001171func (c *config) DisableScudo() bool {
1172 return Bool(c.productVariables.DisableScudo)
1173}
1174
Colin Crossa1ad8d12016-06-01 17:09:44 -07001175func (c *config) Android64() bool {
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001176 for _, t := range c.Targets[Android] {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001177 if t.Arch.ArchType.Multilib == "lib64" {
1178 return true
1179 }
1180 }
1181
1182 return false
1183}
Colin Cross9272ade2016-08-17 15:24:12 -07001184
Colin Cross9d45bb72016-08-29 16:14:13 -07001185func (c *config) UseGoma() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001186 return Bool(c.productVariables.UseGoma)
Colin Cross9d45bb72016-08-29 16:14:13 -07001187}
1188
Taylor Santiago3c16e612024-05-30 14:41:31 -07001189func (c *config) UseABFS() bool {
1190 return Bool(c.productVariables.UseABFS)
1191}
1192
Ramy Medhatbbf25672019-07-17 12:30:04 +00001193func (c *config) UseRBE() bool {
1194 return Bool(c.productVariables.UseRBE)
1195}
1196
Ramy Medhat8ea054a2020-01-27 14:19:44 -05001197func (c *config) UseRBEJAVAC() bool {
1198 return Bool(c.productVariables.UseRBEJAVAC)
1199}
1200
1201func (c *config) UseRBER8() bool {
1202 return Bool(c.productVariables.UseRBER8)
1203}
1204
1205func (c *config) UseRBED8() bool {
1206 return Bool(c.productVariables.UseRBED8)
1207}
1208
Colin Cross8b8bec32019-11-15 13:18:43 -08001209func (c *config) UseRemoteBuild() bool {
1210 return c.UseGoma() || c.UseRBE()
1211}
1212
Colin Cross66548102018-06-19 22:47:35 -07001213func (c *config) RunErrorProne() bool {
1214 return c.IsEnvTrue("RUN_ERROR_PRONE")
1215}
1216
Jingwen Chenc711fec2020-11-22 23:52:50 -05001217// XrefCorpusName returns the Kythe cross-reference corpus name.
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001218func (c *config) XrefCorpusName() string {
1219 return c.Getenv("XREF_CORPUS")
1220}
1221
Jingwen Chenc711fec2020-11-22 23:52:50 -05001222// XrefCuEncoding returns the compilation unit encoding to use for Kythe code
1223// xrefs. Can be 'json' (default), 'proto' or 'all'.
Sasha Smundak6c2d4f92020-01-09 17:34:23 -08001224func (c *config) XrefCuEncoding() string {
1225 if enc := c.Getenv("KYTHE_KZIP_ENCODING"); enc != "" {
1226 return enc
1227 }
1228 return "json"
1229}
1230
Sasha Smundakb0addaf2021-02-16 10:39:40 -08001231// XrefCuJavaSourceMax returns the maximum number of the Java source files
1232// in a single compilation unit
1233const xrefJavaSourceFileMaxDefault = "1000"
1234
1235func (c Config) XrefCuJavaSourceMax() string {
1236 v := c.Getenv("KYTHE_JAVA_SOURCE_BATCH_SIZE")
1237 if v == "" {
1238 return xrefJavaSourceFileMaxDefault
1239 }
1240 if _, err := strconv.ParseUint(v, 0, 0); err != nil {
1241 fmt.Fprintf(os.Stderr,
1242 "bad KYTHE_JAVA_SOURCE_BATCH_SIZE value: %s, will use %s",
1243 err, xrefJavaSourceFileMaxDefault)
1244 return xrefJavaSourceFileMaxDefault
1245 }
1246 return v
1247
1248}
1249
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001250func (c *config) EmitXrefRules() bool {
1251 return c.XrefCorpusName() != ""
1252}
1253
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001254func (c *config) ClangTidy() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001255 return Bool(c.productVariables.ClangTidy)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001256}
1257
1258func (c *config) TidyChecks() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001259 if c.productVariables.TidyChecks == nil {
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001260 return ""
1261 }
Dan Willemsen45133ac2018-03-09 21:22:06 -08001262 return *c.productVariables.TidyChecks
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001263}
1264
Colin Cross0f4e0d62016-07-27 10:56:55 -07001265func (c *config) LibartImgHostBaseAddress() string {
David Srbeckya4f336b2024-09-04 16:06:56 +01001266 return "0x70000000"
Colin Cross0f4e0d62016-07-27 10:56:55 -07001267}
1268
1269func (c *config) LibartImgDeviceBaseAddress() string {
Elliott Hughesda3a0712020-03-06 16:55:28 -08001270 return "0x70000000"
Colin Cross0f4e0d62016-07-27 10:56:55 -07001271}
1272
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001273func (c *config) ArtUseReadBarrier() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001274 return Bool(c.productVariables.ArtUseReadBarrier)
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001275}
1276
Jingwen Chenc711fec2020-11-22 23:52:50 -05001277// Enforce Runtime Resource Overlays for a module. RROs supersede static RROs,
1278// but some modules still depend on it.
1279//
1280// More info: https://source.android.com/devices/architecture/rros
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001281func (c *config) EnforceRROForModule(name string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001282 enforceList := c.productVariables.EnforceRROTargets
Jeongik Chacee5ba92021-02-19 12:11:51 +09001283
Roland Levillainf6cc2612020-07-09 16:58:14 +01001284 if len(enforceList) > 0 {
Yo Chiang4ebd06a2019-10-01 13:13:41 +08001285 if InList("*", enforceList) {
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001286 return true
1287 }
Colin Crossa74ca042019-01-31 14:31:51 -08001288 return InList(name, enforceList)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001289 }
1290 return false
1291}
Colin Crossc4441622024-09-18 14:55:49 -07001292
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001293func (c *config) EnforceRROExcludedOverlay(path string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001294 excluded := c.productVariables.EnforceRROExcludedOverlays
Roland Levillainf6cc2612020-07-09 16:58:14 +01001295 if len(excluded) > 0 {
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001296 return HasAnyPrefix(path, excluded)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001297 }
1298 return false
1299}
1300
Colin Crossc4441622024-09-18 14:55:49 -07001301func (c *config) EnforceRROGlobally() bool {
1302 enforceList := c.productVariables.EnforceRROTargets
1303 return InList("*", enforceList)
1304}
1305
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001306func (c *config) ExportedNamespaces() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001307 return append([]string(nil), c.productVariables.NamespacesToExport...)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001308}
1309
Sam Delmerico98a73292023-02-21 11:50:29 -05001310func (c *config) SourceRootDirs() []string {
1311 return c.productVariables.SourceRootDirs
1312}
1313
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001314func (c *config) HostStaticBinaries() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001315 return Bool(c.productVariables.HostStaticBinaries)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001316}
1317
Colin Cross5a0dcd52018-10-05 14:20:06 -07001318func (c *config) UncompressPrivAppDex() bool {
1319 return Bool(c.productVariables.UncompressPrivAppDex)
1320}
1321
1322func (c *config) ModulesLoadedByPrivilegedModules() []string {
1323 return c.productVariables.ModulesLoadedByPrivilegedModules
1324}
1325
Jingwen Chenc711fec2020-11-22 23:52:50 -05001326// DexpreoptGlobalConfigPath returns the path to the dexpreopt.config file in
1327// the output directory, if it was created during the product configuration
1328// phase by Kati.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001329func (c *config) DexpreoptGlobalConfigPath(ctx PathContext) OptionalPath {
Colin Cross988414c2020-01-11 01:11:46 +00001330 if c.productVariables.DexpreoptGlobalConfig == nil {
Jingwen Chenebb0b572020-11-02 00:24:57 -05001331 return OptionalPathForPath(nil)
1332 }
1333 return OptionalPathForPath(
1334 pathForBuildToolDep(ctx, *c.productVariables.DexpreoptGlobalConfig))
1335}
1336
Jingwen Chenc711fec2020-11-22 23:52:50 -05001337// DexpreoptGlobalConfig returns the raw byte contents of the dexpreopt global
1338// configuration. Since the configuration file was created by Kati during
1339// product configuration (externally of soong_build), it's not tracked, so we
1340// also manually add a Ninja file dependency on the configuration file to the
1341// rule that creates the main build.ninja file. This ensures that build.ninja is
1342// regenerated correctly if dexpreopt.config changes.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001343func (c *config) DexpreoptGlobalConfig(ctx PathContext) ([]byte, error) {
1344 path := c.DexpreoptGlobalConfigPath(ctx)
1345 if !path.Valid() {
Colin Cross988414c2020-01-11 01:11:46 +00001346 return nil, nil
1347 }
Jingwen Chenebb0b572020-11-02 00:24:57 -05001348 ctx.AddNinjaFileDeps(path.String())
Sasha Smundakaf5ca922022-12-12 21:23:34 -08001349 return os.ReadFile(absolutePath(path.String()))
Colin Cross43f08db2018-11-12 10:13:39 -08001350}
1351
Inseob Kim7b85eeb2021-03-23 20:52:24 +09001352func (c *deviceConfig) WithDexpreopt() bool {
1353 return c.config.productVariables.WithDexpreopt
1354}
1355
Colin Cross662d6142022-11-03 20:38:01 -07001356func (c *config) FrameworksBaseDirExists(ctx PathGlobContext) bool {
Colin Cross5a756a62021-03-16 16:34:46 -07001357 return ExistentPathForSource(ctx, "frameworks", "base", "Android.bp").Valid()
David Brazdil91b4e3e2019-01-23 21:04:05 +00001358}
1359
Colin Cross3b19f5d2019-09-17 14:45:31 -07001360func (c *config) HasMultilibConflict(arch ArchType) bool {
1361 return c.multilibConflicts[arch]
1362}
1363
Sasha Smundakaf5ca922022-12-12 21:23:34 -08001364func (c *config) PrebuiltHiddenApiDir(_ PathContext) string {
Bill Peckhambae47492021-01-08 09:34:44 -08001365 return String(c.productVariables.PrebuiltHiddenApiDir)
1366}
1367
Justin Yun41cbb5e2023-11-29 17:58:16 +09001368func (c *config) VendorApiLevel() string {
1369 return String(c.productVariables.VendorApiLevel)
1370}
1371
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001372func (c *config) PrevVendorApiLevel() string {
1373 vendorApiLevel, err := strconv.Atoi(c.VendorApiLevel())
1374 if err != nil {
1375 panic(fmt.Errorf("Cannot parse vendor API level %s to an integer: %s",
1376 c.VendorApiLevel(), err))
1377 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001378 // The version before trunk stable is 34.
1379 if vendorApiLevel == 202404 {
1380 return "34"
1381 }
Hsin-Yi Chen890e7722024-03-05 15:56:44 +08001382 if vendorApiLevel >= 1 && vendorApiLevel <= 34 {
1383 return strconv.Itoa(vendorApiLevel - 1)
1384 }
1385 if vendorApiLevel < 202404 || vendorApiLevel%100 != 4 {
1386 panic("Unknown vendor API level " + c.VendorApiLevel())
1387 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001388 return strconv.Itoa(vendorApiLevel - 100)
1389}
1390
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001391func IsTrunkStableVendorApiLevel(level string) bool {
1392 levelInt, err := strconv.Atoi(level)
1393 return err == nil && levelInt >= 202404
1394}
1395
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001396func (c *config) VendorApiLevelFrozen() bool {
1397 return c.productVariables.GetBuildFlagBool("RELEASE_BOARD_API_LEVEL_FROZEN")
1398}
1399
Colin Cross9272ade2016-08-17 15:24:12 -07001400func (c *deviceConfig) Arches() []Arch {
1401 var arches []Arch
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001402 for _, target := range c.config.Targets[Android] {
Colin Cross9272ade2016-08-17 15:24:12 -07001403 arches = append(arches, target.Arch)
1404 }
1405 return arches
1406}
Dan Willemsend2ede872016-11-18 14:54:24 -08001407
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001408func (c *deviceConfig) BinderBitness() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001409 is32BitBinder := c.config.productVariables.Binder32bit
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001410 if is32BitBinder != nil && *is32BitBinder {
1411 return "32"
1412 }
1413 return "64"
1414}
1415
Dan Willemsen4353bc42016-12-05 17:16:02 -08001416func (c *deviceConfig) VendorPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001417 if c.config.productVariables.VendorPath != nil {
1418 return *c.config.productVariables.VendorPath
Dan Willemsen4353bc42016-12-05 17:16:02 -08001419 }
1420 return "vendor"
1421}
1422
Jeongik Cha219141c2020-08-06 23:00:37 +09001423func (c *deviceConfig) CurrentApiLevelForVendorModules() string {
1424 return StringDefault(c.config.productVariables.DeviceCurrentApiLevelForVendorModules, "current")
1425}
1426
Justin Yun71549282017-11-17 12:10:28 +09001427func (c *deviceConfig) ExtraVndkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001428 return c.config.productVariables.ExtraVndkVersions
Dan Willemsend2ede872016-11-18 14:54:24 -08001429}
Jack He8cc71432016-12-08 15:45:07 -08001430
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001431func (c *deviceConfig) SystemSdkVersions() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001432 return c.config.productVariables.DeviceSystemSdkVersions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001433}
1434
1435func (c *deviceConfig) PlatformSystemSdkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001436 return c.config.productVariables.Platform_systemsdk_versions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001437}
1438
Jiyong Park2db76922017-11-08 16:03:48 +09001439func (c *deviceConfig) OdmPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001440 if c.config.productVariables.OdmPath != nil {
1441 return *c.config.productVariables.OdmPath
Jiyong Park2db76922017-11-08 16:03:48 +09001442 }
1443 return "odm"
1444}
1445
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001446func (c *deviceConfig) ProductPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001447 if c.config.productVariables.ProductPath != nil {
1448 return *c.config.productVariables.ProductPath
Jiyong Park2db76922017-11-08 16:03:48 +09001449 }
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001450 return "product"
Jiyong Park2db76922017-11-08 16:03:48 +09001451}
1452
Justin Yund5f6c822019-06-25 16:47:17 +09001453func (c *deviceConfig) SystemExtPath() string {
1454 if c.config.productVariables.SystemExtPath != nil {
1455 return *c.config.productVariables.SystemExtPath
Dario Frenifd05a742018-05-29 13:28:54 +01001456 }
Justin Yund5f6c822019-06-25 16:47:17 +09001457 return "system_ext"
Dario Frenifd05a742018-05-29 13:28:54 +01001458}
1459
Jack He8cc71432016-12-08 15:45:07 -08001460func (c *deviceConfig) BtConfigIncludeDir() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001461 return String(c.config.productVariables.BtConfigIncludeDir)
Jack He8cc71432016-12-08 15:45:07 -08001462}
Dan Willemsen581341d2017-02-09 16:16:31 -08001463
Jiyong Parkd773eb32017-07-03 13:18:12 +09001464func (c *deviceConfig) DeviceKernelHeaderDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001465 return c.config.productVariables.DeviceKernelHeaders
Jiyong Parkd773eb32017-07-03 13:18:12 +09001466}
1467
Roland Levillainada12702020-06-09 13:07:36 +01001468// JavaCoverageEnabledForPath returns whether Java code coverage is enabled for
1469// path. Coverage is enabled by default when the product variable
1470// JavaCoveragePaths is empty. If JavaCoveragePaths is not empty, coverage is
1471// enabled for any path which is part of this variable (and not part of the
1472// JavaCoverageExcludePaths product variable). Value "*" in JavaCoveragePaths
1473// represents any path.
1474func (c *deviceConfig) JavaCoverageEnabledForPath(path string) bool {
1475 coverage := false
Chris Gross2f748692020-06-24 20:36:59 +00001476 if len(c.config.productVariables.JavaCoveragePaths) == 0 ||
Roland Levillainada12702020-06-09 13:07:36 +01001477 InList("*", c.config.productVariables.JavaCoveragePaths) ||
1478 HasAnyPrefix(path, c.config.productVariables.JavaCoveragePaths) {
1479 coverage = true
1480 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001481 if coverage && len(c.config.productVariables.JavaCoverageExcludePaths) > 0 {
Roland Levillainada12702020-06-09 13:07:36 +01001482 if HasAnyPrefix(path, c.config.productVariables.JavaCoverageExcludePaths) {
1483 coverage = false
1484 }
1485 }
1486 return coverage
1487}
1488
Colin Cross1a6acd42020-06-16 17:51:46 -07001489// Returns true if gcov or clang coverage is enabled.
Dan Willemsen581341d2017-02-09 16:16:31 -08001490func (c *deviceConfig) NativeCoverageEnabled() bool {
Colin Cross1a6acd42020-06-16 17:51:46 -07001491 return Bool(c.config.productVariables.GcovCoverage) ||
1492 Bool(c.config.productVariables.ClangCoverage)
Dan Willemsen581341d2017-02-09 16:16:31 -08001493}
1494
Oliver Nguyen1382ab62019-12-06 15:22:41 -08001495func (c *deviceConfig) ClangCoverageEnabled() bool {
1496 return Bool(c.config.productVariables.ClangCoverage)
1497}
1498
Pirama Arumuga Nainarb37ae582022-01-26 22:14:32 -08001499func (c *deviceConfig) ClangCoverageContinuousMode() bool {
1500 return Bool(c.config.productVariables.ClangCoverageContinuousMode)
1501}
1502
Colin Cross1a6acd42020-06-16 17:51:46 -07001503func (c *deviceConfig) GcovCoverageEnabled() bool {
1504 return Bool(c.config.productVariables.GcovCoverage)
1505}
1506
Roland Levillain4f5297b2020-06-09 12:44:06 +01001507// NativeCoverageEnabledForPath returns whether (GCOV- or Clang-based) native
1508// code coverage is enabled for path. By default, coverage is not enabled for a
1509// given path unless it is part of the NativeCoveragePaths product variable (and
1510// not part of the NativeCoverageExcludePaths product variable). Value "*" in
1511// NativeCoveragePaths represents any path.
1512func (c *deviceConfig) NativeCoverageEnabledForPath(path string) bool {
Ryan Campbell469a18a2017-02-27 09:01:54 -08001513 coverage := false
Roland Levillainf6cc2612020-07-09 16:58:14 +01001514 if len(c.config.productVariables.NativeCoveragePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001515 if InList("*", c.config.productVariables.NativeCoveragePaths) || HasAnyPrefix(path, c.config.productVariables.NativeCoveragePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001516 coverage = true
Dan Willemsen581341d2017-02-09 16:16:31 -08001517 }
1518 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001519 if coverage && len(c.config.productVariables.NativeCoverageExcludePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001520 if HasAnyPrefix(path, c.config.productVariables.NativeCoverageExcludePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001521 coverage = false
Ryan Campbell469a18a2017-02-27 09:01:54 -08001522 }
1523 }
1524 return coverage
Dan Willemsen581341d2017-02-09 16:16:31 -08001525}
Ivan Lozano5f595532017-07-13 14:46:05 -07001526
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001527func (c *deviceConfig) PgoAdditionalProfileDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001528 return c.config.productVariables.PgoAdditionalProfileDirs
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001529}
1530
Vinh Tran44cb78c2023-03-09 22:07:19 -05001531// AfdoProfile returns fully qualified path associated to the given module name
Colin Crossd38feb02024-01-23 16:38:06 -08001532func (c *deviceConfig) AfdoProfile(name string) (string, error) {
Vinh Tran44cb78c2023-03-09 22:07:19 -05001533 for _, afdoProfile := range c.config.productVariables.AfdoProfiles {
1534 split := strings.Split(afdoProfile, ":")
1535 if len(split) != 3 {
Colin Crossd38feb02024-01-23 16:38:06 -08001536 return "", fmt.Errorf("AFDO_PROFILES has invalid value: %s. "+
Vinh Tran44cb78c2023-03-09 22:07:19 -05001537 "The expected format is <module>:<fully-qualified-path-to-fdo_profile>", afdoProfile)
1538 }
1539 if split[0] == name {
Colin Crossd38feb02024-01-23 16:38:06 -08001540 return strings.Join([]string{split[1], split[2]}, ":"), nil
Vinh Tran44cb78c2023-03-09 22:07:19 -05001541 }
1542 }
Colin Crossd38feb02024-01-23 16:38:06 -08001543 return "", nil
Vinh Tran44cb78c2023-03-09 22:07:19 -05001544}
1545
Tri Vo35a51432018-03-25 20:00:00 -07001546func (c *deviceConfig) VendorSepolicyDirs() []string {
1547 return c.config.productVariables.BoardVendorSepolicyDirs
1548}
1549
1550func (c *deviceConfig) OdmSepolicyDirs() []string {
1551 return c.config.productVariables.BoardOdmSepolicyDirs
1552}
1553
Felixa20a8752020-05-17 18:28:35 +02001554func (c *deviceConfig) SystemExtPublicSepolicyDirs() []string {
1555 return c.config.productVariables.SystemExtPublicSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001556}
1557
Felixa20a8752020-05-17 18:28:35 +02001558func (c *deviceConfig) SystemExtPrivateSepolicyDirs() []string {
1559 return c.config.productVariables.SystemExtPrivateSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001560}
1561
Inseob Kim0866b002019-04-15 20:21:29 +09001562func (c *deviceConfig) SepolicyM4Defs() []string {
1563 return c.config.productVariables.BoardSepolicyM4Defs
1564}
1565
Jiyong Park7f67f482019-01-05 12:57:48 +09001566func (c *deviceConfig) OverrideManifestPackageNameFor(name string) (manifestName string, overridden bool) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001567 return findOverrideValue(c.config.productVariables.ManifestPackageNameOverrides, name,
1568 "invalid override rule %q in PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES should be <module_name>:<manifest_name>")
1569}
1570
1571func (c *deviceConfig) OverrideCertificateFor(name string) (certificatePath string, overridden bool) {
Jaewoong Jungacb6db32019-02-28 16:22:30 +00001572 return findOverrideValue(c.config.productVariables.CertificateOverrides, name,
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001573 "invalid override rule %q in PRODUCT_CERTIFICATE_OVERRIDES should be <module_name>:<certificate_module_name>")
1574}
1575
Jaewoong Jung9d22a912019-01-23 16:27:47 -08001576func (c *deviceConfig) OverridePackageNameFor(name string) string {
1577 newName, overridden := findOverrideValue(
1578 c.config.productVariables.PackageNameOverrides,
1579 name,
1580 "invalid override rule %q in PRODUCT_PACKAGE_NAME_OVERRIDES should be <module_name>:<package_name>")
1581 if overridden {
1582 return newName
1583 }
1584 return name
1585}
1586
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001587func findOverrideValue(overrides []string, name string, errorMsg string) (newValue string, overridden bool) {
Jiyong Park7f67f482019-01-05 12:57:48 +09001588 if overrides == nil || len(overrides) == 0 {
1589 return "", false
1590 }
1591 for _, o := range overrides {
1592 split := strings.Split(o, ":")
1593 if len(split) != 2 {
1594 // This shouldn't happen as this is first checked in make, but just in case.
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001595 panic(fmt.Errorf(errorMsg, o))
Jiyong Park7f67f482019-01-05 12:57:48 +09001596 }
1597 if matchPattern(split[0], name) {
1598 return substPattern(split[0], split[1], name), true
1599 }
1600 }
1601 return "", false
1602}
1603
Albert Martineefabcf2022-03-21 20:11:16 +00001604func (c *deviceConfig) ApexGlobalMinSdkVersionOverride() string {
1605 return String(c.config.productVariables.ApexGlobalMinSdkVersionOverride)
1606}
1607
Ivan Lozano5f595532017-07-13 14:46:05 -07001608func (c *config) IntegerOverflowDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001609 if len(c.productVariables.IntegerOverflowExcludePaths) == 0 {
Ivan Lozano5f595532017-07-13 14:46:05 -07001610 return false
1611 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001612 return HasAnyPrefix(path, c.productVariables.IntegerOverflowExcludePaths)
Ivan Lozano5f595532017-07-13 14:46:05 -07001613}
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001614
1615func (c *config) CFIDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001616 if len(c.productVariables.CFIExcludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001617 return false
1618 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001619 return HasAnyPrefix(path, c.productVariables.CFIExcludePaths)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001620}
1621
1622func (c *config) CFIEnabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001623 if len(c.productVariables.CFIIncludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001624 return false
1625 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001626 return HasAnyPrefix(path, c.productVariables.CFIIncludePaths) && !c.CFIDisabledForPath(path)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001627}
Colin Crosse15ddaf2017-12-04 11:24:31 -08001628
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001629func (c *config) MemtagHeapDisabledForPath(path string) bool {
1630 if len(c.productVariables.MemtagHeapExcludePaths) == 0 {
1631 return false
1632 }
1633 return HasAnyPrefix(path, c.productVariables.MemtagHeapExcludePaths)
1634}
1635
1636func (c *config) MemtagHeapAsyncEnabledForPath(path string) bool {
1637 if len(c.productVariables.MemtagHeapAsyncIncludePaths) == 0 {
1638 return false
1639 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001640 return HasAnyPrefix(path, c.productVariables.MemtagHeapAsyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001641}
1642
1643func (c *config) MemtagHeapSyncEnabledForPath(path string) bool {
1644 if len(c.productVariables.MemtagHeapSyncIncludePaths) == 0 {
1645 return false
1646 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001647 return HasAnyPrefix(path, c.productVariables.MemtagHeapSyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001648}
1649
Tomislav Novakf734f002023-08-22 10:51:44 -07001650func (c *config) HWASanDisabledForPath(path string) bool {
1651 if len(c.productVariables.HWASanExcludePaths) == 0 {
1652 return false
1653 }
1654 return HasAnyPrefix(path, c.productVariables.HWASanExcludePaths)
1655}
1656
Hang Lua98aab92023-03-17 13:17:22 +08001657func (c *config) HWASanEnabledForPath(path string) bool {
1658 if len(c.productVariables.HWASanIncludePaths) == 0 {
1659 return false
1660 }
Tomislav Novakf734f002023-08-22 10:51:44 -07001661 return HasAnyPrefix(path, c.productVariables.HWASanIncludePaths) && !c.HWASanDisabledForPath(path)
Hang Lua98aab92023-03-17 13:17:22 +08001662}
1663
Dan Willemsen0fe78662018-03-26 12:41:18 -07001664func (c *config) VendorConfig(name string) VendorConfig {
Colin Cross9d34f352019-11-22 16:03:51 -08001665 return soongconfig.Config(c.productVariables.VendorVars[name])
Dan Willemsen0fe78662018-03-26 12:41:18 -07001666}
1667
Colin Cross395f2cf2018-10-24 16:10:32 -07001668func (c *config) NdkAbis() bool {
1669 return Bool(c.productVariables.Ndk_abis)
1670}
1671
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001672func (c *config) AmlAbis() bool {
1673 return Bool(c.productVariables.Aml_abis)
1674}
1675
Jiyong Park4da07972021-01-05 21:01:11 +09001676func (c *config) ForceApexSymlinkOptimization() bool {
1677 return Bool(c.productVariables.ForceApexSymlinkOptimization)
1678}
1679
Sasha Smundakfe9a5b82022-07-27 14:51:45 -07001680func (c *config) ApexCompressionEnabled() bool {
1681 return Bool(c.productVariables.CompressedApex) && !c.UnbundledBuildApps()
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +00001682}
1683
Dennis Shene2ed70c2023-01-11 14:15:43 +00001684func (c *config) ApexTrimEnabled() bool {
1685 return Bool(c.productVariables.TrimmedApex)
1686}
1687
Justin Yun2cc42502024-09-11 14:10:20 +09001688func (c *config) UseSoongSystemImage() bool {
1689 return Bool(c.productVariables.UseSoongSystemImage)
1690}
1691
1692func (c *config) SoongDefinedSystemImage() string {
1693 if c.UseSoongSystemImage() {
1694 return String(c.productVariables.ProductSoongDefinedSystemImage)
1695 }
1696 return ""
1697}
1698
Jeongik Chac9464142019-01-07 12:07:27 +09001699func (c *config) EnforceSystemCertificate() bool {
1700 return Bool(c.productVariables.EnforceSystemCertificate)
1701}
1702
Colin Cross440e0d02020-06-11 11:32:11 -07001703func (c *config) EnforceSystemCertificateAllowList() []string {
1704 return c.productVariables.EnforceSystemCertificateAllowList
Jeongik Chac9464142019-01-07 12:07:27 +09001705}
1706
Jeongik Cha2cc570d2019-10-29 15:44:45 +09001707func (c *config) EnforceProductPartitionInterface() bool {
1708 return Bool(c.productVariables.EnforceProductPartitionInterface)
1709}
1710
Colin Crossf24a22a2019-01-31 14:12:44 -08001711func (c *config) ProductHiddenAPIStubs() []string {
1712 return c.productVariables.ProductHiddenAPIStubs
Colin Cross8faf8fc2019-01-16 15:15:52 -08001713}
1714
Colin Crossf24a22a2019-01-31 14:12:44 -08001715func (c *config) ProductHiddenAPIStubsSystem() []string {
1716 return c.productVariables.ProductHiddenAPIStubsSystem
Colin Cross8faf8fc2019-01-16 15:15:52 -08001717}
1718
Colin Crossf24a22a2019-01-31 14:12:44 -08001719func (c *config) ProductHiddenAPIStubsTest() []string {
1720 return c.productVariables.ProductHiddenAPIStubsTest
Colin Cross8faf8fc2019-01-16 15:15:52 -08001721}
Dan Willemsen71c74602019-04-10 12:27:35 -07001722
Dan Willemsen54879d12019-04-18 10:08:46 -07001723func (c *deviceConfig) TargetFSConfigGen() []string {
Dan Willemsen71c74602019-04-10 12:27:35 -07001724 return c.config.productVariables.TargetFSConfigGen
1725}
Inseob Kim0866b002019-04-15 20:21:29 +09001726
1727func (c *config) ProductPublicSepolicyDirs() []string {
1728 return c.productVariables.ProductPublicSepolicyDirs
1729}
1730
1731func (c *config) ProductPrivateSepolicyDirs() []string {
1732 return c.productVariables.ProductPrivateSepolicyDirs
1733}
1734
Inseob Kim5eb7ee92022-04-27 10:30:34 +09001735func (c *config) TargetMultitreeUpdateMeta() bool {
1736 return c.productVariables.MultitreeUpdateMeta
1737}
1738
Inseob Kim1f086e22019-05-09 13:29:15 +09001739func (c *deviceConfig) DeviceArch() string {
1740 return String(c.config.productVariables.DeviceArch)
1741}
1742
1743func (c *deviceConfig) DeviceArchVariant() string {
1744 return String(c.config.productVariables.DeviceArchVariant)
1745}
1746
1747func (c *deviceConfig) DeviceSecondaryArch() string {
1748 return String(c.config.productVariables.DeviceSecondaryArch)
1749}
1750
1751func (c *deviceConfig) DeviceSecondaryArchVariant() string {
1752 return String(c.config.productVariables.DeviceSecondaryArchVariant)
1753}
Yifan Hong82db7352020-01-21 16:12:26 -08001754
1755func (c *deviceConfig) BoardUsesRecoveryAsBoot() bool {
1756 return Bool(c.config.productVariables.BoardUsesRecoveryAsBoot)
1757}
Yifan Hong97365ee2020-07-29 09:51:57 -07001758
1759func (c *deviceConfig) BoardKernelBinaries() []string {
1760 return c.config.productVariables.BoardKernelBinaries
1761}
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001762
Yifan Hong42bef8d2020-08-05 14:36:09 -07001763func (c *deviceConfig) BoardKernelModuleInterfaceVersions() []string {
1764 return c.config.productVariables.BoardKernelModuleInterfaceVersions
1765}
1766
Yifan Hongdd8dacc2020-10-21 15:40:17 -07001767func (c *deviceConfig) BoardMoveRecoveryResourcesToVendorBoot() bool {
1768 return Bool(c.config.productVariables.BoardMoveRecoveryResourcesToVendorBoot)
1769}
1770
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001771func (c *deviceConfig) PlatformSepolicyVersion() string {
1772 return String(c.config.productVariables.PlatformSepolicyVersion)
1773}
1774
Inseob Kim843f6642022-01-07 09:11:23 +09001775func (c *deviceConfig) PlatformSepolicyCompatVersions() []string {
1776 return c.config.productVariables.PlatformSepolicyCompatVersions
1777}
1778
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001779func (c *deviceConfig) BoardSepolicyVers() string {
Inseob Kim0c4eec82021-03-22 22:33:40 +09001780 if ver := String(c.config.productVariables.BoardSepolicyVers); ver != "" {
1781 return ver
1782 }
1783 return c.PlatformSepolicyVersion()
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001784}
1785
Inseob Kim1a0afcc2022-02-14 23:10:51 +09001786func (c *deviceConfig) SystemExtSepolicyPrebuiltApiDir() string {
1787 return String(c.config.productVariables.SystemExtSepolicyPrebuiltApiDir)
1788}
1789
1790func (c *deviceConfig) ProductSepolicyPrebuiltApiDir() string {
1791 return String(c.config.productVariables.ProductSepolicyPrebuiltApiDir)
1792}
1793
1794func (c *deviceConfig) IsPartnerTrebleSepolicyTestEnabled() bool {
1795 return c.SystemExtSepolicyPrebuiltApiDir() != "" || c.ProductSepolicyPrebuiltApiDir() != ""
1796}
1797
Justin DeMartino383bfb32021-02-24 10:49:43 -08001798func createDirsMap(previous map[string]bool, dirs []string) (map[string]bool, error) {
1799 var ret = make(map[string]bool)
1800 for _, dir := range dirs {
1801 clean := filepath.Clean(dir)
1802 if previous[clean] || ret[clean] {
1803 return nil, fmt.Errorf("Duplicate entry %s", dir)
1804 }
1805 ret[clean] = true
1806 }
1807 return ret, nil
1808}
1809
1810func (c *deviceConfig) createDirsMapOnce(onceKey OnceKey, previous map[string]bool, dirs []string) map[string]bool {
1811 dirMap := c.Once(onceKey, func() interface{} {
1812 ret, err := createDirsMap(previous, dirs)
1813 if err != nil {
1814 panic(fmt.Errorf("%s: %w", onceKey.key, err))
1815 }
1816 return ret
1817 })
1818 if dirMap == nil {
1819 return nil
1820 }
1821 return dirMap.(map[string]bool)
1822}
1823
Inseob Kim60c32f02020-12-21 22:53:05 +09001824func (c *deviceConfig) ShippingApiLevel() ApiLevel {
Steven Morelanda48df2b2024-06-03 22:29:38 +00001825 if c.config.productVariables.Shipping_api_level == nil {
Inseob Kim60c32f02020-12-21 22:53:05 +09001826 return NoneApiLevel
1827 }
Steven Morelanda48df2b2024-06-03 22:29:38 +00001828 apiLevel, _ := strconv.Atoi(*c.config.productVariables.Shipping_api_level)
Inseob Kim60c32f02020-12-21 22:53:05 +09001829 return uncheckedFinalApiLevel(apiLevel)
1830}
1831
Liz Kammer33cc80e2023-05-18 18:20:28 +00001832func (c *deviceConfig) BuildBrokenPluginValidation() []string {
1833 return c.config.productVariables.BuildBrokenPluginValidation
1834}
1835
Alix Espinoef47e542022-09-14 19:10:51 +00001836func (c *deviceConfig) BuildBrokenClangAsFlags() bool {
1837 return c.config.productVariables.BuildBrokenClangAsFlags
1838}
1839
1840func (c *deviceConfig) BuildBrokenClangCFlags() bool {
1841 return c.config.productVariables.BuildBrokenClangCFlags
1842}
1843
Alixb5f6d9e2022-04-20 23:00:58 +00001844func (c *deviceConfig) BuildBrokenClangProperty() bool {
1845 return c.config.productVariables.BuildBrokenClangProperty
1846}
1847
Inseob Kim67e5add192021-03-17 18:05:33 +09001848func (c *deviceConfig) BuildBrokenEnforceSyspropOwner() bool {
1849 return c.config.productVariables.BuildBrokenEnforceSyspropOwner
1850}
1851
1852func (c *deviceConfig) BuildBrokenTrebleSyspropNeverallow() bool {
1853 return c.config.productVariables.BuildBrokenTrebleSyspropNeverallow
1854}
1855
Hridya Valsaraju5a5c7d52021-04-02 16:45:24 -07001856func (c *deviceConfig) BuildDebugfsRestrictionsEnabled() bool {
1857 return c.config.productVariables.BuildDebugfsRestrictionsEnabled
1858}
1859
Inseob Kim0cac7b42021-02-03 18:16:46 +09001860func (c *deviceConfig) BuildBrokenVendorPropertyNamespace() bool {
1861 return c.config.productVariables.BuildBrokenVendorPropertyNamespace
1862}
1863
Liz Kammer619be462022-01-28 15:13:39 -05001864func (c *deviceConfig) BuildBrokenInputDir(name string) bool {
1865 return InList(name, c.config.productVariables.BuildBrokenInputDirModules)
1866}
1867
Jiyong Park3bb99242024-01-04 23:21:26 +00001868func (c *deviceConfig) BuildBrokenDontCheckSystemSdk() bool {
1869 return c.config.productVariables.BuildBrokenDontCheckSystemSdk
1870}
1871
Inseob Kim2da72af2024-06-18 11:09:12 +09001872func (c *deviceConfig) BuildBrokenDupSysprop() bool {
1873 return c.config.productVariables.BuildBrokenDupSysprop
1874}
1875
Jiakai Zhang48203e32023-06-02 23:42:21 +01001876func (c *config) BuildWarningBadOptionalUsesLibsAllowlist() []string {
1877 return c.productVariables.BuildWarningBadOptionalUsesLibsAllowlist
1878}
1879
Yu Liu6a7940c2023-05-09 17:12:22 -07001880func (c *deviceConfig) GenruleSandboxing() bool {
1881 return Bool(c.config.productVariables.GenruleSandboxing)
Vinh Tran140d5882022-06-10 14:23:27 -04001882}
1883
Inseob Kim67e5add192021-03-17 18:05:33 +09001884func (c *deviceConfig) RequiresInsecureExecmemForSwiftshader() bool {
1885 return c.config.productVariables.RequiresInsecureExecmemForSwiftshader
1886}
1887
Devin Moorec381e102023-07-06 22:03:58 +00001888func (c *deviceConfig) Release_aidl_use_unfrozen() bool {
1889 return Bool(c.config.productVariables.Release_aidl_use_unfrozen)
1890}
1891
Inseob Kim67e5add192021-03-17 18:05:33 +09001892func (c *config) SelinuxIgnoreNeverallows() bool {
1893 return c.productVariables.SelinuxIgnoreNeverallows
1894}
1895
Inseob Kima10ef272021-09-15 03:04:53 +00001896func (c *deviceConfig) SepolicyFreezeTestExtraDirs() []string {
1897 return c.config.productVariables.SepolicyFreezeTestExtraDirs
1898}
1899
1900func (c *deviceConfig) SepolicyFreezeTestExtraPrebuiltDirs() []string {
1901 return c.config.productVariables.SepolicyFreezeTestExtraPrebuiltDirs
1902}
1903
Jiyong Parkd163d4d2021-10-12 16:47:43 +09001904func (c *deviceConfig) GenerateAidlNdkPlatformBackend() bool {
1905 return c.config.productVariables.GenerateAidlNdkPlatformBackend
1906}
1907
Yu Liu67a28422024-03-05 00:36:31 +00001908func (c *deviceConfig) AconfigContainerValidation() string {
1909 return c.config.productVariables.AconfigContainerValidation
1910}
1911
Christopher Ferris98f10222022-07-13 23:16:52 -07001912func (c *config) IgnorePrefer32OnDevice() bool {
1913 return c.productVariables.IgnorePrefer32OnDevice
1914}
1915
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001916func (c *config) BootJars() []string {
1917 return c.Once(earlyBootJarsKey, func() interface{} {
Paul Duffin69d1fb12020-10-23 21:14:20 +01001918 list := c.productVariables.BootJars.CopyOfJars()
satayevd604b212021-07-21 14:23:52 +01001919 return append(list, c.productVariables.ApexBootJars.CopyOfJars()...)
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001920 }).([]string)
1921}
Paul Duffin9a89a2a2020-10-28 19:20:06 +00001922
satayevd604b212021-07-21 14:23:52 +01001923func (c *config) NonApexBootJars() ConfiguredJarList {
Paul Duffin9a89a2a2020-10-28 19:20:06 +00001924 return c.productVariables.BootJars
1925}
1926
satayevd604b212021-07-21 14:23:52 +01001927func (c *config) ApexBootJars() ConfiguredJarList {
1928 return c.productVariables.ApexBootJars
Paul Duffin9a89a2a2020-10-28 19:20:06 +00001929}
Colin Cross77cdcfd2021-03-12 11:28:25 -08001930
1931func (c *config) RBEWrapper() string {
1932 return c.GetenvWithDefault("RBE_WRAPPER", remoteexec.DefaultWrapperPath)
1933}
Colin Cross9b698b62021-12-22 09:55:32 -08001934
1935// UseHostMusl returns true if the host target has been configured to build against musl libc.
1936func (c *config) UseHostMusl() bool {
1937 return Bool(c.productVariables.HostMusl)
1938}
MarkDacekff851b82022-04-21 18:33:17 +00001939
Spandan Das9e93d3d2023-03-08 05:47:29 +00001940// ApiSurfaces directory returns the source path inside the api_surfaces repo
1941// (relative to workspace root).
1942func (c *config) ApiSurfacesDir(s ApiSurface, version string) string {
1943 return filepath.Join(
1944 "build",
1945 "bazel",
1946 "api_surfaces",
1947 s.String(),
1948 version)
1949}
Jihoon Kang1bff0342023-01-17 20:40:22 +00001950
Jihoon Kang1975d3e2023-10-16 23:24:11 +00001951func (c *config) JavaCoverageEnabled() bool {
1952 return c.IsEnvTrue("EMMA_INSTRUMENT") || c.IsEnvTrue("EMMA_INSTRUMENT_STATIC") || c.IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK")
1953}
1954
Jihoon Kangc1b04d62023-11-16 19:07:04 +00001955func (c *deviceConfig) BuildFromSourceStub() bool {
1956 return Bool(c.config.productVariables.BuildFromSourceStub)
1957}
1958
Jihoon Kang1bff0342023-01-17 20:40:22 +00001959func (c *config) BuildFromTextStub() bool {
Jihoon Kang1975d3e2023-10-16 23:24:11 +00001960 // TODO: b/302320354 - Remove the coverage build specific logic once the
1961 // robust solution for handling native properties in from-text stub build
1962 // is implemented.
Jihoon Kangc1b04d62023-11-16 19:07:04 +00001963 return !c.buildFromSourceStub &&
1964 !c.JavaCoverageEnabled() &&
1965 !c.deviceConfig.BuildFromSourceStub()
Jihoon Kang1bff0342023-01-17 20:40:22 +00001966}
Spandan Das4deab282023-03-30 17:06:32 +00001967
1968func (c *config) SetBuildFromTextStub(b bool) {
Jihoon Kang2a929ad2023-06-08 19:02:07 +00001969 c.buildFromSourceStub = !b
Jihoon Kangcbcad7c2023-06-01 22:31:52 +00001970 c.productVariables.Build_from_text_stub = boolPtr(b)
Spandan Das4deab282023-03-30 17:06:32 +00001971}
Jihoon Kang1c92c3e2023-03-23 17:44:51 +00001972
Inseob Kim5bac3b62023-08-25 21:29:46 +09001973func (c *deviceConfig) CheckVendorSeappViolations() bool {
1974 return Bool(c.config.productVariables.CheckVendorSeappViolations)
1975}
Jihoon Kangcfbc4072023-09-20 01:02:18 +00001976
Inseob Kime4e85d52023-10-25 23:53:58 +09001977func (c *config) GetBuildFlag(name string) (string, bool) {
1978 val, ok := c.productVariables.BuildFlags[name]
1979 return val, ok
1980}
Spandan Dase3fcb412023-10-26 20:48:02 +00001981
Rico Winda7b38592024-08-26 12:10:44 +02001982func (c *config) UseOptimizedResourceShrinkingByDefault() bool {
1983 return c.productVariables.GetBuildFlagBool("RELEASE_USE_OPTIMIZED_RESOURCE_SHRINKING_BY_DEFAULT")
1984}
1985
Colin Cross8f1b0332024-01-25 13:39:06 -08001986func (c *config) UseResourceProcessorByDefault() bool {
1987 return c.productVariables.GetBuildFlagBool("RELEASE_USE_RESOURCE_PROCESSOR_BY_DEFAULT")
1988}
1989
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001990func (c *config) UseTransitiveJarsInClasspath() bool {
1991 return c.productVariables.GetBuildFlagBool("RELEASE_USE_TRANSITIVE_JARS_IN_CLASSPATH")
1992}
1993
Spandan Dase3fcb412023-10-26 20:48:02 +00001994var (
Spandan Das85bd4622024-08-01 00:51:20 +00001995 mainlineApexContributionBuildFlagsToApexNames = map[string]string{
1996 "RELEASE_APEX_CONTRIBUTIONS_ADBD": "com.android.adbd",
1997 "RELEASE_APEX_CONTRIBUTIONS_ADSERVICES": "com.android.adservices",
1998 "RELEASE_APEX_CONTRIBUTIONS_APPSEARCH": "com.android.appsearch",
1999 "RELEASE_APEX_CONTRIBUTIONS_ART": "com.android.art",
2000 "RELEASE_APEX_CONTRIBUTIONS_BLUETOOTH": "com.android.btservices",
2001 "RELEASE_APEX_CONTRIBUTIONS_CAPTIVEPORTALLOGIN": "",
2002 "RELEASE_APEX_CONTRIBUTIONS_CELLBROADCAST": "com.android.cellbroadcast",
2003 "RELEASE_APEX_CONTRIBUTIONS_CONFIGINFRASTRUCTURE": "com.android.configinfrastructure",
2004 "RELEASE_APEX_CONTRIBUTIONS_CONNECTIVITY": "com.android.tethering",
2005 "RELEASE_APEX_CONTRIBUTIONS_CONSCRYPT": "com.android.conscrypt",
2006 "RELEASE_APEX_CONTRIBUTIONS_CRASHRECOVERY": "",
2007 "RELEASE_APEX_CONTRIBUTIONS_DEVICELOCK": "com.android.devicelock",
2008 "RELEASE_APEX_CONTRIBUTIONS_DOCUMENTSUIGOOGLE": "",
2009 "RELEASE_APEX_CONTRIBUTIONS_EXTSERVICES": "com.android.extservices",
2010 "RELEASE_APEX_CONTRIBUTIONS_HEALTHFITNESS": "com.android.healthfitness",
2011 "RELEASE_APEX_CONTRIBUTIONS_IPSEC": "com.android.ipsec",
2012 "RELEASE_APEX_CONTRIBUTIONS_MEDIA": "com.android.media",
2013 "RELEASE_APEX_CONTRIBUTIONS_MEDIAPROVIDER": "com.android.mediaprovider",
2014 "RELEASE_APEX_CONTRIBUTIONS_MODULE_METADATA": "",
2015 "RELEASE_APEX_CONTRIBUTIONS_NETWORKSTACKGOOGLE": "",
2016 "RELEASE_APEX_CONTRIBUTIONS_NEURALNETWORKS": "com.android.neuralnetworks",
2017 "RELEASE_APEX_CONTRIBUTIONS_ONDEVICEPERSONALIZATION": "com.android.ondevicepersonalization",
2018 "RELEASE_APEX_CONTRIBUTIONS_PERMISSION": "com.android.permission",
2019 "RELEASE_APEX_CONTRIBUTIONS_PRIMARY_LIBS": "",
2020 "RELEASE_APEX_CONTRIBUTIONS_REMOTEKEYPROVISIONING": "com.android.rkpd",
2021 "RELEASE_APEX_CONTRIBUTIONS_RESOLV": "com.android.resolv",
2022 "RELEASE_APEX_CONTRIBUTIONS_SCHEDULING": "com.android.scheduling",
2023 "RELEASE_APEX_CONTRIBUTIONS_SDKEXTENSIONS": "com.android.sdkext",
2024 "RELEASE_APEX_CONTRIBUTIONS_SWCODEC": "com.android.media.swcodec",
2025 "RELEASE_APEX_CONTRIBUTIONS_STATSD": "com.android.os.statsd",
2026 "RELEASE_APEX_CONTRIBUTIONS_TELEMETRY_TVP": "",
2027 "RELEASE_APEX_CONTRIBUTIONS_TZDATA": "com.android.tzdata",
2028 "RELEASE_APEX_CONTRIBUTIONS_UWB": "com.android.uwb",
2029 "RELEASE_APEX_CONTRIBUTIONS_WIFI": "com.android.wifi",
Spandan Dase3fcb412023-10-26 20:48:02 +00002030 }
2031)
2032
2033// Returns the list of _selected_ apex_contributions
2034// Each mainline module will have one entry in the list
2035func (c *config) AllApexContributions() []string {
2036 ret := []string{}
Spandan Das85bd4622024-08-01 00:51:20 +00002037 for _, f := range SortedKeys(mainlineApexContributionBuildFlagsToApexNames) {
Spandan Dase3fcb412023-10-26 20:48:02 +00002038 if val, exists := c.GetBuildFlag(f); exists && val != "" {
2039 ret = append(ret, val)
2040 }
2041 }
2042 return ret
2043}
Spandan Das8ab28dd2024-02-17 03:31:45 +00002044
Spandan Das85bd4622024-08-01 00:51:20 +00002045func (c *config) AllMainlineApexNames() []string {
2046 return SortedStringValues(mainlineApexContributionBuildFlagsToApexNames)
2047}
2048
Spandan Das0d24ade2024-03-08 04:20:15 +00002049func (c *config) BuildIgnoreApexContributionContents() *bool {
Spandan Das8ab28dd2024-02-17 03:31:45 +00002050 return c.productVariables.BuildIgnoreApexContributionContents
2051}
Inseob Kim8fa54da2024-03-19 16:48:59 +09002052
2053func (c *config) ProductLocales() []string {
2054 return c.productVariables.ProductLocales
2055}
2056
2057func (c *config) ProductDefaultWifiChannels() []string {
2058 return c.productVariables.ProductDefaultWifiChannels
2059}
2060
2061func (c *config) BoardUseVbmetaDigestInFingerprint() bool {
2062 return Bool(c.productVariables.BoardUseVbmetaDigestInFingerprint)
2063}
2064
2065func (c *config) OemProperties() []string {
2066 return c.productVariables.OemProperties
2067}
Kiyoung Kim881e4652024-07-08 11:02:23 +09002068
2069func (c *config) UseDebugArt() bool {
2070 if c.productVariables.ArtTargetIncludeDebugBuild != nil {
2071 return Bool(c.productVariables.ArtTargetIncludeDebugBuild)
2072 }
2073
2074 return Bool(c.productVariables.Eng)
2075}
Inseob Kimd8538e52024-07-31 02:00:41 +00002076
2077func (c *config) SystemPropFiles(ctx PathContext) Paths {
2078 return PathsForSource(ctx, c.productVariables.SystemPropFiles)
2079}
Inseob Kim6bd92d52024-07-31 02:01:03 +00002080
Inseob Kimacf91742024-08-05 12:51:05 +09002081func (c *config) SystemExtPropFiles(ctx PathContext) Paths {
2082 return PathsForSource(ctx, c.productVariables.SystemExtPropFiles)
2083}
2084
Inseob Kim01d4f8b2024-08-08 17:47:14 +09002085func (c *config) ProductPropFiles(ctx PathContext) Paths {
2086 return PathsForSource(ctx, c.productVariables.ProductPropFiles)
2087}
2088
Inseob Kim9a22c7e2024-08-26 15:58:09 +09002089func (c *config) OdmPropFiles(ctx PathContext) Paths {
2090 return PathsForSource(ctx, c.productVariables.OdmPropFiles)
2091}
2092
Inseob Kim6bd92d52024-07-31 02:01:03 +00002093func (c *config) EnableUffdGc() string {
2094 return String(c.productVariables.EnableUffdGc)
2095}
Bill Yang3b3aac02024-09-05 09:22:09 +00002096
2097func (c *config) DeviceFrameworkCompatibilityMatrixFile() []string {
2098 return c.productVariables.DeviceFrameworkCompatibilityMatrixFile
2099}
2100
2101func (c *config) DeviceProductCompatibilityMatrixFile() []string {
2102 return c.productVariables.DeviceProductCompatibilityMatrixFile
2103}
2104
2105func (c *config) BoardAvbEnable() bool {
2106 return Bool(c.productVariables.BoardAvbEnable)
2107}
2108
2109func (c *config) BoardAvbSystemAddHashtreeFooterArgs() []string {
2110 return c.productVariables.BoardAvbSystemAddHashtreeFooterArgs
2111}
Spandan Das950deca2024-10-01 18:35:23 +00002112
2113// Returns true if RELEASE_INSTALL_APEX_SYSTEMSERVER_DEXPREOPT_SAME_PARTITION is set to true.
2114// If true, dexpreopt files of apex system server jars will be installed in the same partition as the parent apex.
2115// If false, all these files will be installed in /system partition.
2116func (c Config) InstallApexSystemServerDexpreoptSamePartition() bool {
2117 return c.config.productVariables.GetBuildFlagBool("RELEASE_INSTALL_APEX_SYSTEMSERVER_DEXPREOPT_SAME_PARTITION")
2118}