blob: 6948461661e73e153a035620ba6cc0319fbda4e2 [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
Juan Yescas05d4d902023-04-07 10:35:35 -0700176// MaxPageSizeSupported returns the max page size supported by the device. This
177// value will define the ELF segment alignment for binaries (executables and
178// shared libraries).
179func (c Config) MaxPageSizeSupported() string {
180 return String(c.config.productVariables.DeviceMaxPageSizeSupported)
181}
182
Vilas Bhatb3d2d222023-12-04 22:51:20 +0000183// NoBionicPageSizeMacro returns true when AOSP is page size agnostic.
184// This means that the bionic's macro PAGE_SIZE won't be defined.
185// Returns false when AOSP is NOT page size agnostic.
186// This means that bionic's macro PAGE_SIZE is defined.
187func (c Config) NoBionicPageSizeMacro() bool {
188 return Bool(c.config.productVariables.DeviceNoBionicPageSizeMacro)
Juan Yescas01065602023-08-09 08:34:37 -0700189}
190
Joe Onoratofee845a2023-05-09 08:14:14 -0700191// The release version passed to aconfig, derived from RELEASE_VERSION
192func (c Config) ReleaseVersion() string {
193 return c.config.productVariables.ReleaseVersion
194}
195
Yu Liu2cc802a2023-09-05 17:19:45 -0700196// The aconfig value set passed to aconfig, derived from RELEASE_VERSION
Yu Liueebb2592023-10-12 20:31:27 -0700197func (c Config) ReleaseAconfigValueSets() []string {
Yu Liu95572ff2023-12-07 16:38:45 -0800198 return c.config.productVariables.ReleaseAconfigValueSets
Joe Onoratofee845a2023-05-09 08:14:14 -0700199}
200
Zhi Dou3f65a412023-08-10 21:47:40 +0000201// The flag default permission value passed to aconfig
202// derived from RELEASE_ACONFIG_FLAG_DEFAULT_PERMISSION
203func (c Config) ReleaseAconfigFlagDefaultPermission() string {
204 return c.config.productVariables.ReleaseAconfigFlagDefaultPermission
205}
206
Alyssa Ketpreechasawat34ab8792023-10-06 07:01:22 +0000207// The flag indicating behavior for the tree wrt building modules or using prebuilts
208// derived from RELEASE_DEFAULT_MODULE_BUILD_FROM_SOURCE
209func (c Config) ReleaseDefaultModuleBuildFromSource() bool {
210 return c.config.productVariables.ReleaseDefaultModuleBuildFromSource == nil ||
211 Bool(c.config.productVariables.ReleaseDefaultModuleBuildFromSource)
212}
213
Spandan Das07145102024-03-18 23:25:30 +0000214func (c Config) ReleaseDisableVerifyOverlaps() bool {
215 return c.config.productVariables.GetBuildFlagBool("RELEASE_DISABLE_VERIFY_OVERLAPS_CHECK")
216}
217
Jihoon Kang59198152024-02-06 22:43:18 +0000218// Enables flagged apis annotated with READ_WRITE aconfig flags to be included in the stubs
219// and hiddenapi flags so that they are accessible at runtime
220func (c Config) ReleaseExportRuntimeApis() bool {
Jihoon Kang35349462024-02-22 19:52:46 +0000221 return Bool(c.config.productVariables.ExportRuntimeApis)
Jihoon Kang59198152024-02-06 22:43:18 +0000222}
223
Aleksei Vetrov146e9822023-11-24 19:54:26 +0000224// Enables ABI monitoring of NDK libraries
225func (c Config) ReleaseNdkAbiMonitored() bool {
226 return c.config.productVariables.GetBuildFlagBool("RELEASE_NDK_ABI_MONITORED")
227}
228
Ted Bauer10fff942024-04-29 19:30:23 +0000229// Enable read flag from new storage, for C/C++
230func (c Config) ReleaseReadFromNewStorageCc() bool {
231 return c.config.productVariables.GetBuildFlagBool("RELEASE_READ_FROM_NEW_STORAGE_CC")
232}
233
Jihoon Kangbd093452023-12-26 19:08:01 +0000234func (c Config) ReleaseHiddenApiExportableStubs() bool {
Jihoon Kangb36fc542024-02-22 19:35:26 +0000235 return c.config.productVariables.GetBuildFlagBool("RELEASE_HIDDEN_API_EXPORTABLE_STUBS") ||
236 Bool(c.config.productVariables.HiddenapiExportableStubs)
Jihoon Kangbd093452023-12-26 19:08:01 +0000237}
238
Dennis Shen58378c92024-04-03 19:26:36 +0000239// Enable read flag from new storage
240func (c Config) ReleaseReadFromNewStorage() bool {
241 return c.config.productVariables.GetBuildFlagBool("RELEASE_READ_FROM_NEW_STORAGE")
242}
243
Jingwen Chenc711fec2020-11-22 23:52:50 -0500244// A DeviceConfig object represents the configuration for a particular device
245// being built. For now there will only be one of these, but in the future there
246// may be multiple devices being built.
Colin Cross9272ade2016-08-17 15:24:12 -0700247type DeviceConfig struct {
248 *deviceConfig
249}
250
Jingwen Chenc711fec2020-11-22 23:52:50 -0500251// VendorConfig represents the configuration for vendor-specific behavior.
Colin Cross9d34f352019-11-22 16:03:51 -0800252type VendorConfig soongconfig.SoongConfig
Dan Willemsen0fe78662018-03-26 12:41:18 -0700253
Jingwen Chenc711fec2020-11-22 23:52:50 -0500254// Definition of general build configuration for soong_build. Some of these
Jingwen Chenc4d91bc2020-11-24 22:59:26 -0500255// product configuration values are read from Kati-generated soong.variables.
Colin Cross1332b002015-04-07 17:11:30 -0700256type config struct {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500257 // Options configurable with soong.variables
Cole Faustf8231dd2023-04-21 17:37:11 -0700258 productVariables ProductVariables
Colin Cross3f40fa42015-01-30 17:27:36 -0800259
Dan Willemsen674dc7f2018-03-12 18:06:05 -0700260 // Only available on configs created by TestConfig
Cole Faustf8231dd2023-04-21 17:37:11 -0700261 TestProductVariables *ProductVariables
Dan Willemsen674dc7f2018-03-12 18:06:05 -0700262
Dan Willemsen87b17d12015-07-14 00:39:06 -0700263 ProductVariablesFileName string
264
Colin Cross0c66bc62021-07-20 09:47:41 -0700265 // BuildOS stores the OsType for the OS that the build is running on.
266 BuildOS OsType
267
268 // BuildArch stores the ArchType for the CPU that the build is running on.
269 BuildArch ArchType
270
Jaewoong Jung642916f2020-10-09 17:25:15 -0700271 Targets map[OsType][]Target
272 BuildOSTarget Target // the Target for tools run on the build machine
273 BuildOSCommonTarget Target // the Target for common (java) tools run on the build machine
274 AndroidCommonTarget Target // the Target for common modules for the Android device
275 AndroidFirstDeviceTarget Target // the first Target for modules for the Android device
Dan Willemsen218f6562015-07-08 18:13:11 -0700276
Jingwen Chenc711fec2020-11-22 23:52:50 -0500277 // multilibConflicts for an ArchType is true if there is earlier configured
278 // device architecture with the same multilib value.
Colin Cross3b19f5d2019-09-17 14:45:31 -0700279 multilibConflicts map[ArchType]bool
280
Colin Cross9272ade2016-08-17 15:24:12 -0700281 deviceConfig *deviceConfig
282
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200283 outDir string // The output directory (usually out/)
284 soongOutDir string
Chris Parsons8f232a22020-06-23 17:37:05 -0400285 moduleListFile string // the path to the file which lists blueprint files to parse.
Colin Crossc1e86a32015-04-15 12:33:28 -0700286
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +0200287 runGoTests bool
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200288
Colin Cross6ccbc912017-10-10 23:07:38 -0700289 env map[string]string
Dan Willemsene7680ba2015-09-11 17:06:19 -0700290 envLock sync.Mutex
291 envDeps map[string]string
292 envFrozen bool
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800293
Jingwen Chencda22c92020-11-23 00:22:30 -0500294 // Changes behavior based on whether Kati runs after soong_build, or if soong_build
295 // runs standalone.
296 katiEnabled bool
Colin Cross1e7d3702016-08-24 15:25:47 -0700297
Colin Cross32616ed2017-09-05 21:56:44 -0700298 captureBuild bool // true for tests, saves build parameters for each module
299 ignoreEnvironment bool // true for tests, returns empty from all Getenv calls
Colin Crosscec81712017-07-13 14:43:27 -0700300
Colin Cross98be1bb2019-12-13 20:41:13 -0800301 fs pathtools.FileSystem
302 mockBpList string
303
Colin Crossb63d7b32023-12-07 16:54:51 -0800304 BuildMode SoongBuildMode
Jingwen Chen12b4c272021-03-10 02:05:59 -0500305
Colin Cross5e6a7972020-06-07 16:56:32 -0700306 // If testAllowNonExistentPaths is true then PathForSource and PathForModuleSrc won't error
307 // in tests when a path doesn't exist.
Pedro Loureiro5d190cc2021-02-15 15:41:33 +0000308 TestAllowNonExistentPaths bool
Colin Cross5e6a7972020-06-07 16:56:32 -0700309
Jingwen Chenc711fec2020-11-22 23:52:50 -0500310 // The list of files that when changed, must invalidate soong_build to
311 // regenerate build.ninja.
Colin Cross12129292020-10-29 18:23:58 -0700312 ninjaFileDepsSet sync.Map
313
Colin Cross9272ade2016-08-17 15:24:12 -0700314 OncePer
MarkDacekff851b82022-04-21 18:33:17 +0000315
Jihoon Kang2a929ad2023-06-08 19:02:07 +0000316 // If buildFromSourceStub is true then the Java API stubs are
317 // built from the source Java files, not the signature text files.
318 buildFromSourceStub bool
MarkDacekf47e1422023-04-19 16:47:36 +0000319
320 // If ensureAllowlistIntegrity is true, then the presence of any allowlisted
321 // modules that aren't mixed-built for at least one variant will cause a build
322 // failure
323 ensureAllowlistIntegrity bool
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000324
325 // List of Api libraries that contribute to Api surfaces.
326 apiLibraries map[string]struct{}
Colin Cross9272ade2016-08-17 15:24:12 -0700327}
328
329type deviceConfig struct {
Dan Willemsen00269f22017-07-06 16:59:48 -0700330 config *config
Colin Cross9272ade2016-08-17 15:24:12 -0700331 OncePer
Colin Cross3f40fa42015-01-30 17:27:36 -0800332}
333
Colin Cross485e5722015-08-27 13:28:01 -0700334type jsonConfigurable interface {
Colin Cross27385972015-09-18 10:57:10 -0700335 SetDefaultConfig()
Colin Cross485e5722015-08-27 13:28:01 -0700336}
Colin Cross3f40fa42015-01-30 17:27:36 -0800337
Colin Cross485e5722015-08-27 13:28:01 -0700338func loadConfig(config *config) error {
Colin Cross988414c2020-01-11 01:11:46 +0000339 return loadFromConfigFile(&config.productVariables, absolutePath(config.ProductVariablesFileName))
Colin Cross485e5722015-08-27 13:28:01 -0700340}
341
Cole Faustd92430e2024-02-07 01:02:04 +0000342// Checks if the string is a valid go identifier. This is equivalent to blueprint's definition
343// of an identifier, so it will match the same identifiers as those that can be used in bp files.
344func isGoIdentifier(ident string) bool {
345 for i, r := range ident {
346 valid := r == '_' || unicode.IsLetter(r) || unicode.IsDigit(r) && i > 0
347 if !valid {
348 return false
349 }
350 }
351 return len(ident) > 0
352}
353
Jingwen Chenc711fec2020-11-22 23:52:50 -0500354// loadFromConfigFile loads and decodes configuration options from a JSON file
355// in the current working directory.
Cole Faustf8231dd2023-04-21 17:37:11 -0700356func loadFromConfigFile(configurable *ProductVariables, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800357 // Try to open the file
Colin Cross485e5722015-08-27 13:28:01 -0700358 configFileReader, err := os.Open(filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800359 defer configFileReader.Close()
360 if os.IsNotExist(err) {
361 // Need to create a file, so that blueprint & ninja don't get in
362 // a dependency tracking loop.
363 // Make a file-configurable-options with defaults, write it out using
364 // a json writer.
Colin Cross27385972015-09-18 10:57:10 -0700365 configurable.SetDefaultConfig()
366 err = saveToConfigFile(configurable, filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800367 if err != nil {
368 return err
369 }
Colin Cross15cd21a2018-02-27 11:26:02 -0800370 } else if err != nil {
371 return fmt.Errorf("config file: could not open %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800372 } else {
373 // Make a decoder for it
374 jsonDecoder := json.NewDecoder(configFileReader)
Cole Fauste1129b82024-06-04 11:10:11 -0700375 jsonDecoder.DisallowUnknownFields()
Colin Cross485e5722015-08-27 13:28:01 -0700376 err = jsonDecoder.Decode(configurable)
Colin Cross3f40fa42015-01-30 17:27:36 -0800377 if err != nil {
Colin Cross15cd21a2018-02-27 11:26:02 -0800378 return fmt.Errorf("config file: %s did not parse correctly: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800379 }
380 }
381
Liz Kammer09f947d2021-05-12 14:51:49 -0400382 if Bool(configurable.GcovCoverage) && Bool(configurable.ClangCoverage) {
383 return fmt.Errorf("GcovCoverage and ClangCoverage cannot both be set")
384 }
385
386 configurable.Native_coverage = proptools.BoolPtr(
387 Bool(configurable.GcovCoverage) ||
388 Bool(configurable.ClangCoverage))
389
Cole Faustd92430e2024-02-07 01:02:04 +0000390 // The go scanner's definition of identifiers is c-style identifiers, but allowing unicode's
391 // definition of letters and digits. This is the same scanner that blueprint uses, so it
392 // will allow the same identifiers as are valid in bp files.
393 for namespace := range configurable.VendorVars {
394 if !isGoIdentifier(namespace) {
395 return fmt.Errorf("soong config namespaces must be valid identifiers: %q", namespace)
396 }
397 for variable := range configurable.VendorVars[namespace] {
398 if !isGoIdentifier(variable) {
399 return fmt.Errorf("soong config variables must be valid identifiers: %q", variable)
400 }
401 }
402 }
403
Yuntao Xu402e9b02021-08-09 15:44:44 -0700404 // when Platform_sdk_final is true (or PLATFORM_VERSION_CODENAME is REL), use Platform_sdk_version;
405 // if false (pre-released version, for example), use Platform_sdk_codename.
406 if Bool(configurable.Platform_sdk_final) {
407 if configurable.Platform_sdk_version != nil {
408 configurable.Platform_sdk_version_or_codename =
409 proptools.StringPtr(strconv.Itoa(*(configurable.Platform_sdk_version)))
410 } else {
411 return fmt.Errorf("Platform_sdk_version cannot be pointed by a NULL pointer")
412 }
413 } else {
414 configurable.Platform_sdk_version_or_codename =
415 proptools.StringPtr(String(configurable.Platform_sdk_codename))
416 }
417
Cole Faustad186492024-06-14 14:13:54 -0700418 return nil
Colin Cross3f40fa42015-01-30 17:27:36 -0800419}
420
Colin Crossd8f20142016-11-03 09:43:26 -0700421// atomically writes the config file in case two copies of soong_build are running simultaneously
422// (for example, docs generation and ninja manifest generation)
Cole Faustf8231dd2023-04-21 17:37:11 -0700423func saveToConfigFile(config *ProductVariables, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800424 data, err := json.MarshalIndent(&config, "", " ")
425 if err != nil {
426 return fmt.Errorf("cannot marshal config data: %s", err.Error())
427 }
428
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800429 f, err := os.CreateTemp(filepath.Dir(filename), "config")
Colin Cross3f40fa42015-01-30 17:27:36 -0800430 if err != nil {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500431 return fmt.Errorf("cannot create empty config file %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800432 }
Colin Crossd8f20142016-11-03 09:43:26 -0700433 defer os.Remove(f.Name())
434 defer f.Close()
Colin Cross3f40fa42015-01-30 17:27:36 -0800435
Colin Crossd8f20142016-11-03 09:43:26 -0700436 _, err = f.Write(data)
Colin Cross3f40fa42015-01-30 17:27:36 -0800437 if err != nil {
Colin Cross485e5722015-08-27 13:28:01 -0700438 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
439 }
440
Colin Crossd8f20142016-11-03 09:43:26 -0700441 _, err = f.WriteString("\n")
Colin Cross485e5722015-08-27 13:28:01 -0700442 if err != nil {
443 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800444 }
445
Colin Crossd8f20142016-11-03 09:43:26 -0700446 f.Close()
447 os.Rename(f.Name(), filename)
448
Colin Cross3f40fa42015-01-30 17:27:36 -0800449 return nil
450}
451
Colin Cross988414c2020-01-11 01:11:46 +0000452// NullConfig returns a mostly empty Config for use by standalone tools like dexpreopt_gen that
453// use the android package.
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200454func NullConfig(outDir, soongOutDir string) Config {
Colin Cross988414c2020-01-11 01:11:46 +0000455 return Config{
456 config: &config{
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200457 outDir: outDir,
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200458 soongOutDir: soongOutDir,
459 fs: pathtools.OsFs,
Colin Cross988414c2020-01-11 01:11:46 +0000460 },
461 }
462}
463
Jingwen Chenc711fec2020-11-22 23:52:50 -0500464// NewConfig creates a new Config object. The srcDir argument specifies the path
465// to the root source directory. It also loads the config file, if found.
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800466func NewConfig(cmdArgs CmdArgs, availableEnv map[string]string) (Config, error) {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500467 // Make a config with default options.
Colin Cross9272ade2016-08-17 15:24:12 -0700468 config := &config{
Kiyoung Kima37d9ba2023-04-19 13:13:45 +0900469 ProductVariablesFileName: cmdArgs.SoongVariables,
Dan Willemsen87b17d12015-07-14 00:39:06 -0700470
Lukacs T. Berki53b2f362021-04-12 14:04:24 +0200471 env: availableEnv,
Colin Cross6ccbc912017-10-10 23:07:38 -0700472
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800473 outDir: cmdArgs.OutDir,
474 soongOutDir: cmdArgs.SoongOutDir,
475 runGoTests: cmdArgs.RunGoTests,
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +0200476 multilibConflicts: make(map[ArchType]bool),
Colin Cross98be1bb2019-12-13 20:41:13 -0800477
Colin Crossb63d7b32023-12-07 16:54:51 -0800478 moduleListFile: cmdArgs.ModuleListFile,
479 fs: pathtools.NewOsFs(absSrcDir),
Chris Parsons9402ca82023-02-23 17:28:06 -0500480
Jihoon Kang2a929ad2023-06-08 19:02:07 +0000481 buildFromSourceStub: cmdArgs.BuildFromSourceStub,
Colin Cross68f55102015-03-25 14:43:57 -0700482 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800483
Dan Willemsen00269f22017-07-06 16:59:48 -0700484 config.deviceConfig = &deviceConfig{
Colin Cross9272ade2016-08-17 15:24:12 -0700485 config: config,
486 }
487
Liz Kammer7941b302020-07-28 13:27:34 -0700488 // Soundness check of the build and source directories. This won't catch strange
489 // configurations with symlinks, but at least checks the obvious case.
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800490 absBuildDir, err := filepath.Abs(cmdArgs.SoongOutDir)
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700491 if err != nil {
492 return Config{}, err
493 }
494
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200495 absSrcDir, err := filepath.Abs(".")
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700496 if err != nil {
497 return Config{}, err
498 }
499
500 if strings.HasPrefix(absSrcDir, absBuildDir) {
501 return Config{}, fmt.Errorf("Build dir must not contain source directory")
502 }
503
Colin Cross3f40fa42015-01-30 17:27:36 -0800504 // Load any configurable options from the configuration file
Colin Cross9272ade2016-08-17 15:24:12 -0700505 err = loadConfig(config)
Colin Cross3f40fa42015-01-30 17:27:36 -0800506 if err != nil {
Colin Crossc3c0a492015-04-10 15:43:55 -0700507 return Config{}, err
Colin Cross3f40fa42015-01-30 17:27:36 -0800508 }
509
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800510 KatiEnabledMarkerFile := filepath.Join(cmdArgs.SoongOutDir, ".soong.kati_enabled")
Jingwen Chencda22c92020-11-23 00:22:30 -0500511 if _, err := os.Stat(absolutePath(KatiEnabledMarkerFile)); err == nil {
512 config.katiEnabled = true
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800513 }
514
Colin Cross0c66bc62021-07-20 09:47:41 -0700515 determineBuildOS(config)
516
Jingwen Chenc711fec2020-11-22 23:52:50 -0500517 // Sets up the map of target OSes to the finer grained compilation targets
518 // that are configured from the product variables.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700519 targets, err := decodeTargetProductVariables(config)
Dan Willemsen218f6562015-07-08 18:13:11 -0700520 if err != nil {
521 return Config{}, err
522 }
523
Paul Duffin1356d8c2020-02-25 19:26:33 +0000524 // Make the CommonOS OsType available for all products.
525 targets[CommonOS] = []Target{commonTargetMap[CommonOS.Name]}
526
Dan Albert4098deb2016-10-19 14:04:41 -0700527 var archConfig []archConfig
Jingwen Chenc4d91bc2020-11-24 22:59:26 -0500528 if config.NdkAbis() {
Dan Albert4098deb2016-10-19 14:04:41 -0700529 archConfig = getNdkAbisConfig()
Martin Stjernholmc1ecc432019-11-15 15:00:31 +0000530 } else if config.AmlAbis() {
531 archConfig = getAmlAbisConfig()
Dan Albert4098deb2016-10-19 14:04:41 -0700532 }
533
534 if archConfig != nil {
Liz Kammerb7f33662022-02-28 14:16:16 -0500535 androidTargets, err := decodeAndroidArchSettings(archConfig)
Dan Willemsen322acaf2016-01-12 23:07:05 -0800536 if err != nil {
537 return Config{}, err
538 }
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700539 targets[Android] = androidTargets
Dan Willemsen322acaf2016-01-12 23:07:05 -0800540 }
541
Colin Cross3b19f5d2019-09-17 14:45:31 -0700542 multilib := make(map[string]bool)
543 for _, target := range targets[Android] {
544 if seen := multilib[target.Arch.ArchType.Multilib]; seen {
545 config.multilibConflicts[target.Arch.ArchType] = true
546 }
547 multilib[target.Arch.ArchType.Multilib] = true
548 }
549
Jingwen Chenc711fec2020-11-22 23:52:50 -0500550 // Map of OS to compilation targets.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700551 config.Targets = targets
Jingwen Chenc711fec2020-11-22 23:52:50 -0500552
553 // Compilation targets for host tools.
Colin Cross0c66bc62021-07-20 09:47:41 -0700554 config.BuildOSTarget = config.Targets[config.BuildOS][0]
555 config.BuildOSCommonTarget = getCommonTargets(config.Targets[config.BuildOS])[0]
Jingwen Chenc711fec2020-11-22 23:52:50 -0500556
557 // Compilation targets for Android.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700558 if len(config.Targets[Android]) > 0 {
559 config.AndroidCommonTarget = getCommonTargets(config.Targets[Android])[0]
Sam Delmericocc271e22022-06-01 15:45:02 +0000560 config.AndroidFirstDeviceTarget = FirstTarget(config.Targets[Android], "lib64", "lib32")[0]
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700561 }
Dan Willemsen218f6562015-07-08 18:13:11 -0700562
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500563 setBuildMode := func(arg string, mode SoongBuildMode) {
564 if arg != "" {
565 if config.BuildMode != AnalysisNoBazel {
566 fmt.Fprintf(os.Stderr, "buildMode is already set, illegal argument: %s", arg)
567 os.Exit(1)
568 }
569 config.BuildMode = mode
570 }
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800571 }
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500572 setBuildMode(cmdArgs.BazelQueryViewDir, GenerateQueryView)
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500573 setBuildMode(cmdArgs.ModuleGraphFile, GenerateModuleGraph)
574 setBuildMode(cmdArgs.DocFile, GenerateDocFile)
MarkDacekd06db5d2022-11-29 00:47:59 +0000575
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000576 // TODO(b/276958307): Replace the hardcoded list to a sdk_library local prop.
577 config.apiLibraries = map[string]struct{}{
578 "android.net.ipsec.ike": {},
579 "art.module.public.api": {},
580 "conscrypt.module.public.api": {},
581 "framework-adservices": {},
582 "framework-appsearch": {},
583 "framework-bluetooth": {},
Jihoon Kang480943f2023-05-19 06:02:08 +0000584 "framework-configinfrastructure": {},
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000585 "framework-connectivity": {},
586 "framework-connectivity-t": {},
Jihoon Kang480943f2023-05-19 06:02:08 +0000587 "framework-devicelock": {},
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000588 "framework-graphics": {},
Jihoon Kang480943f2023-05-19 06:02:08 +0000589 "framework-healthfitness": {},
Mark White387a6582023-08-06 00:20:47 +0000590 "framework-location": {},
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000591 "framework-media": {},
592 "framework-mediaprovider": {},
Roshan Pius92307ff2023-11-13 17:16:35 -0800593 "framework-nfc": {},
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000594 "framework-ondevicepersonalization": {},
Alyssa Ketpreechasawat9f634362023-11-08 16:03:53 +0000595 "framework-pdf": {},
Nishant Panwar0ce94652024-02-10 09:02:15 +0000596 "framework-pdf-v": {},
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000597 "framework-permission": {},
598 "framework-permission-s": {},
599 "framework-scheduling": {},
600 "framework-sdkextensions": {},
601 "framework-statsd": {},
602 "framework-sdksandbox": {},
603 "framework-tethering": {},
604 "framework-uwb": {},
605 "framework-virtualization": {},
606 "framework-wifi": {},
607 "i18n.module.public.api": {},
608 }
609
Jihoon Kangc1b04d62023-11-16 19:07:04 +0000610 config.productVariables.Build_from_text_stub = boolPtr(config.BuildFromTextStub())
611
Jingwen Chenc711fec2020-11-22 23:52:50 -0500612 return Config{config}, err
613}
Colin Cross988414c2020-01-11 01:11:46 +0000614
Colin Cross98be1bb2019-12-13 20:41:13 -0800615// mockFileSystem replaces all reads with accesses to the provided map of
616// filenames to contents stored as a byte slice.
617func (c *config) mockFileSystem(bp string, fs map[string][]byte) {
618 mockFS := map[string][]byte{}
619
620 if _, exists := mockFS["Android.bp"]; !exists {
621 mockFS["Android.bp"] = []byte(bp)
622 }
623
624 for k, v := range fs {
625 mockFS[k] = v
626 }
627
628 // no module list file specified; find every file named Blueprints or Android.bp
629 pathsToParse := []string{}
630 for candidate := range mockFS {
631 base := filepath.Base(candidate)
Lukacs T. Berkib838b0a2021-09-02 11:46:24 +0200632 if base == "Android.bp" {
Colin Cross98be1bb2019-12-13 20:41:13 -0800633 pathsToParse = append(pathsToParse, candidate)
634 }
635 }
636 if len(pathsToParse) < 1 {
637 panic(fmt.Sprintf("No Blueprint or Android.bp files found in mock filesystem: %v\n", mockFS))
638 }
639 mockFS[blueprint.MockModuleListFile] = []byte(strings.Join(pathsToParse, "\n"))
640
641 c.fs = pathtools.MockFs(mockFS)
642 c.mockBpList = blueprint.MockModuleListFile
643}
644
Lukacs T. Berkid1e3f1f2021-03-16 08:55:23 +0100645func (c *config) SetAllowMissingDependencies() {
646 c.productVariables.Allow_missing_dependencies = proptools.BoolPtr(true)
647}
648
Jingwen Chenc711fec2020-11-22 23:52:50 -0500649// BlueprintToolLocation returns the directory containing build system tools
650// from Blueprint, like soong_zip and merge_zips.
Lukacs T. Berkia806e412021-09-01 08:57:48 +0200651func (c *config) HostToolDir() string {
Colin Crossacfcc1f2021-10-25 15:40:32 -0700652 if c.KatiEnabled() {
653 return filepath.Join(c.outDir, "host", c.PrebuiltOS(), "bin")
654 } else {
655 return filepath.Join(c.soongOutDir, "host", c.PrebuiltOS(), "bin")
656 }
Dan Willemsenc2aa4a92016-05-26 15:13:03 -0700657}
658
Dan Willemsen60e62f02018-11-16 21:05:32 -0800659func (c *config) HostToolPath(ctx PathContext, tool string) Path {
Cole Faust3b703f32023-10-16 13:30:51 -0700660 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "bin", tool)
Colin Cross790ef352021-10-25 19:15:55 -0700661 return path
Dan Willemsen60e62f02018-11-16 21:05:32 -0800662}
663
Colin Cross790ef352021-10-25 19:15:55 -0700664func (c *config) HostJNIToolPath(ctx PathContext, lib string) Path {
Martin Stjernholm7260d062019-12-09 21:47:14 +0000665 ext := ".so"
666 if runtime.GOOS == "darwin" {
667 ext = ".dylib"
668 }
Cole Faust3b703f32023-10-16 13:30:51 -0700669 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "lib64", lib+ext)
Colin Cross790ef352021-10-25 19:15:55 -0700670 return path
Martin Stjernholm7260d062019-12-09 21:47:14 +0000671}
672
Colin Crossae5330a2021-11-03 13:31:22 -0700673func (c *config) HostJavaToolPath(ctx PathContext, tool string) Path {
Cole Faust3b703f32023-10-16 13:30:51 -0700674 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "framework", tool)
Colin Cross3e3eda62021-11-04 10:22:51 -0700675 return path
676}
677
Vinh Tran09581952023-05-16 16:03:20 -0400678func (c *config) HostCcSharedLibPath(ctx PathContext, lib string) Path {
679 libDir := "lib"
680 if ctx.Config().BuildArch.Multilib == "lib64" {
681 libDir = "lib64"
682 }
Cole Faust3b703f32023-10-16 13:30:51 -0700683 return pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, libDir, lib+".so")
Vinh Tran09581952023-05-16 16:03:20 -0400684}
685
Jingwen Chenc711fec2020-11-22 23:52:50 -0500686// PrebuiltOS returns the name of the host OS used in prebuilts directories.
Colin Cross1332b002015-04-07 17:11:30 -0700687func (c *config) PrebuiltOS() string {
Colin Cross3f40fa42015-01-30 17:27:36 -0800688 switch runtime.GOOS {
689 case "linux":
690 return "linux-x86"
691 case "darwin":
692 return "darwin-x86"
693 default:
694 panic("Unknown GOOS")
695 }
696}
697
698// GoRoot returns the path to the root directory of the Go toolchain.
Colin Cross1332b002015-04-07 17:11:30 -0700699func (c *config) GoRoot() string {
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200700 return fmt.Sprintf("prebuilts/go/%s", c.PrebuiltOS())
Colin Cross3f40fa42015-01-30 17:27:36 -0800701}
702
Jingwen Chenc711fec2020-11-22 23:52:50 -0500703// PrebuiltBuildTool returns the path to a tool in the prebuilts directory containing
704// checked-in tools, like Kati, Ninja or Toybox, for the current host OS.
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700705func (c *config) PrebuiltBuildTool(ctx PathContext, tool string) Path {
706 return PathForSource(ctx, "prebuilts/build-tools", c.PrebuiltOS(), "bin", tool)
707}
708
Jingwen Chenc711fec2020-11-22 23:52:50 -0500709// CpPreserveSymlinksFlags returns the host-specific flag for the cp(1) command
710// to preserve symlinks.
Colin Cross1332b002015-04-07 17:11:30 -0700711func (c *config) CpPreserveSymlinksFlags() string {
Colin Cross485e5722015-08-27 13:28:01 -0700712 switch runtime.GOOS {
Colin Cross3f40fa42015-01-30 17:27:36 -0800713 case "darwin":
714 return "-R"
715 case "linux":
716 return "-d"
717 default:
718 return ""
719 }
720}
Colin Cross68f55102015-03-25 14:43:57 -0700721
Colin Cross1332b002015-04-07 17:11:30 -0700722func (c *config) Getenv(key string) string {
Colin Cross68f55102015-03-25 14:43:57 -0700723 var val string
724 var exists bool
Colin Crossc1e86a32015-04-15 12:33:28 -0700725 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800726 defer c.envLock.Unlock()
727 if c.envDeps == nil {
728 c.envDeps = make(map[string]string)
729 }
Colin Cross68f55102015-03-25 14:43:57 -0700730 if val, exists = c.envDeps[key]; !exists {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700731 if c.envFrozen {
732 panic("Cannot access new environment variables after envdeps are frozen")
733 }
Colin Cross6ccbc912017-10-10 23:07:38 -0700734 val, _ = c.env[key]
Colin Cross68f55102015-03-25 14:43:57 -0700735 c.envDeps[key] = val
736 }
737 return val
738}
739
Colin Cross99d7c232016-11-23 16:52:04 -0800740func (c *config) GetenvWithDefault(key string, defaultValue string) string {
741 ret := c.Getenv(key)
742 if ret == "" {
743 return defaultValue
744 }
745 return ret
746}
747
748func (c *config) IsEnvTrue(key string) bool {
AdityaK19384102024-05-01 13:51:25 -0700749 value := strings.ToLower(c.Getenv(key))
Colin Cross99d7c232016-11-23 16:52:04 -0800750 return value == "1" || value == "y" || value == "yes" || value == "on" || value == "true"
751}
752
753func (c *config) IsEnvFalse(key string) bool {
AdityaK19384102024-05-01 13:51:25 -0700754 value := strings.ToLower(c.Getenv(key))
Colin Cross99d7c232016-11-23 16:52:04 -0800755 return value == "0" || value == "n" || value == "no" || value == "off" || value == "false"
756}
757
Sorin Basca253f8c02024-05-23 10:28:24 +0100758func (c *config) TargetsJava21() bool {
759 return c.IsEnvTrue("EXPERIMENTAL_TARGET_JAVA_VERSION_21")
760}
761
Jingwen Chenc711fec2020-11-22 23:52:50 -0500762// EnvDeps returns the environment variables this build depends on. The first
763// call to this function blocks future reads from the environment.
Colin Cross1332b002015-04-07 17:11:30 -0700764func (c *config) EnvDeps() map[string]string {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700765 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800766 defer c.envLock.Unlock()
Dan Willemsene7680ba2015-09-11 17:06:19 -0700767 c.envFrozen = true
Colin Cross68f55102015-03-25 14:43:57 -0700768 return c.envDeps
769}
Colin Cross35cec122015-04-02 14:37:16 -0700770
Jingwen Chencda22c92020-11-23 00:22:30 -0500771func (c *config) KatiEnabled() bool {
772 return c.katiEnabled
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800773}
774
Cole Faust11edf552023-10-13 11:32:14 -0700775func (c *config) ProductVariables() ProductVariables {
776 return c.productVariables
777}
778
Nan Zhang581fd212018-01-10 16:06:12 -0800779func (c *config) BuildId() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800780 return String(c.productVariables.BuildId)
Nan Zhang581fd212018-01-10 16:06:12 -0800781}
782
Inseob Kim8fa54da2024-03-19 16:48:59 +0900783func (c *config) DisplayBuildNumber() bool {
784 return Bool(c.productVariables.DisplayBuildNumber)
785}
786
Inseob Kimbac07552024-06-18 11:09:12 +0900787// BuildFingerprintFile returns the path to a text file containing metadata
788// representing the current build's fingerprint.
789//
790// Rules that want to reference the build fingerprint should read from this file
791// without depending on it. They will run whenever their other dependencies
792// require them to run and get the current build fingerprint. This ensures they
793// don't rebuild on every incremental build when the build number changes.
794func (c *config) BuildFingerprintFile(ctx PathContext) Path {
795 return PathForArbitraryOutput(ctx, "target", "product", c.DeviceName(), String(c.productVariables.BuildFingerprintFile))
796}
797
Jingwen Chenc711fec2020-11-22 23:52:50 -0500798// BuildNumberFile returns the path to a text file containing metadata
799// representing the current build's number.
800//
801// Rules that want to reference the build number should read from this file
802// without depending on it. They will run whenever their other dependencies
803// require them to run and get the current build number. This ensures they don't
804// rebuild on every incremental build when the build number changes.
Colin Cross2a2e0db2020-02-21 16:55:46 -0800805func (c *config) BuildNumberFile(ctx PathContext) Path {
806 return PathForOutput(ctx, String(c.productVariables.BuildNumberFile))
Nan Zhang581fd212018-01-10 16:06:12 -0800807}
808
Inseob Kim8fa54da2024-03-19 16:48:59 +0900809// BuildHostnameFile returns the path to a text file containing metadata
810// representing the current build's host name.
811func (c *config) BuildHostnameFile(ctx PathContext) Path {
812 return PathForOutput(ctx, String(c.productVariables.BuildHostnameFile))
813}
814
815// BuildThumbprintFile returns the path to a text file containing metadata
816// representing the current build's thumbprint.
817//
818// Rules that want to reference the build thumbprint should read from this file
819// without depending on it. They will run whenever their other dependencies
820// require them to run and get the current build thumbprint. This ensures they
821// don't rebuild on every incremental build when the build thumbprint changes.
822func (c *config) BuildThumbprintFile(ctx PathContext) Path {
823 return PathForArbitraryOutput(ctx, "target", "product", c.DeviceName(), String(c.productVariables.BuildThumbprintFile))
824}
825
Jingwen Chenc711fec2020-11-22 23:52:50 -0500826// DeviceName returns the name of the current device target.
Colin Cross35cec122015-04-02 14:37:16 -0700827// TODO: take an AndroidModuleContext to select the device name for multi-device builds
Colin Cross1332b002015-04-07 17:11:30 -0700828func (c *config) DeviceName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800829 return *c.productVariables.DeviceName
Colin Cross35cec122015-04-02 14:37:16 -0700830}
831
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000832// DeviceProduct returns the current product target. There could be multiple of
833// these per device type.
834//
Chris Parsonsef615e52022-08-18 22:04:11 -0400835// NOTE: Do not base conditional logic on this value. It may break product inheritance.
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000836func (c *config) DeviceProduct() string {
837 return *c.productVariables.DeviceProduct
838}
839
Cole Faustb85d1a12022-11-08 18:14:01 -0800840// HasDeviceProduct returns if the build has a product. A build will not
841// necessarily have a product when --skip-config is passed to soong, like it is
842// in prebuilts/build-tools/build-prebuilts.sh
843func (c *config) HasDeviceProduct() bool {
844 return c.productVariables.DeviceProduct != nil
845}
846
Inseob Kim8fa54da2024-03-19 16:48:59 +0900847func (c *config) DeviceAbi() []string {
848 return c.productVariables.DeviceAbi
849}
850
Anton Hansson53c88442019-03-18 15:53:16 +0000851func (c *config) DeviceResourceOverlays() []string {
852 return c.productVariables.DeviceResourceOverlays
853}
854
855func (c *config) ProductResourceOverlays() []string {
856 return c.productVariables.ProductResourceOverlays
Colin Cross30e076a2015-04-13 13:58:27 -0700857}
858
Inseob Kim8fa54da2024-03-19 16:48:59 +0900859func (c *config) PlatformDisplayVersionName() string {
860 return String(c.productVariables.Platform_display_version_name)
861}
862
Colin Crossbfd347d2018-05-09 11:11:35 -0700863func (c *config) PlatformVersionName() string {
864 return String(c.productVariables.Platform_version_name)
865}
866
Dan Albert4f378d72020-07-23 17:32:15 -0700867func (c *config) PlatformSdkVersion() ApiLevel {
868 return uncheckedFinalApiLevel(*c.productVariables.Platform_sdk_version)
Colin Cross30e076a2015-04-13 13:58:27 -0700869}
870
Cole Faust37d27c42023-04-12 10:27:45 -0700871func (c *config) RawPlatformSdkVersion() *int {
872 return c.productVariables.Platform_sdk_version
873}
874
Mu-Le Lee5e047532022-07-27 02:32:03 +0000875func (c *config) PlatformSdkFinal() bool {
876 return Bool(c.productVariables.Platform_sdk_final)
877}
878
Colin Crossd09b0b62018-04-18 11:06:47 -0700879func (c *config) PlatformSdkCodename() string {
880 return String(c.productVariables.Platform_sdk_codename)
881}
882
Anton Hansson97d0bae2022-02-16 16:15:10 +0000883func (c *config) PlatformSdkExtensionVersion() int {
884 return *c.productVariables.Platform_sdk_extension_version
885}
886
887func (c *config) PlatformBaseSdkExtensionVersion() int {
888 return *c.productVariables.Platform_base_sdk_extension_version
889}
890
Colin Cross092c9da2019-04-02 22:56:43 -0700891func (c *config) PlatformSecurityPatch() string {
892 return String(c.productVariables.Platform_security_patch)
893}
894
895func (c *config) PlatformPreviewSdkVersion() string {
896 return String(c.productVariables.Platform_preview_sdk_version)
897}
898
899func (c *config) PlatformMinSupportedTargetSdkVersion() string {
Linus Tufvessonba270c52024-04-12 13:06:22 +0200900 var val, ok = c.productVariables.BuildFlags["RELEASE_PLATFORM_MIN_SUPPORTED_TARGET_SDK_VERSION"]
901 if !ok {
902 return ""
903 }
904 return val
Colin Cross092c9da2019-04-02 22:56:43 -0700905}
906
907func (c *config) PlatformBaseOS() string {
908 return String(c.productVariables.Platform_base_os)
909}
910
Inseob Kim4f1f3d92022-04-25 18:23:58 +0900911func (c *config) PlatformVersionLastStable() string {
912 return String(c.productVariables.Platform_version_last_stable)
913}
914
Jiyong Park37073842022-06-21 10:13:42 +0900915func (c *config) PlatformVersionKnownCodenames() string {
916 return String(c.productVariables.Platform_version_known_codenames)
917}
918
Dan Albert1a246272020-07-06 14:49:35 -0700919func (c *config) MinSupportedSdkVersion() ApiLevel {
Dan Albert6bfb6bb2022-08-17 20:11:57 +0000920 return uncheckedFinalApiLevel(21)
Dan Albert1a246272020-07-06 14:49:35 -0700921}
922
923func (c *config) FinalApiLevels() []ApiLevel {
924 var levels []ApiLevel
Dan Albert4f378d72020-07-23 17:32:15 -0700925 for i := 1; i <= c.PlatformSdkVersion().FinalOrFutureInt(); i++ {
Dan Albert1a246272020-07-06 14:49:35 -0700926 levels = append(levels, uncheckedFinalApiLevel(i))
927 }
928 return levels
929}
930
931func (c *config) PreviewApiLevels() []ApiLevel {
932 var levels []ApiLevel
Dan Albertf93ea132023-10-05 20:40:46 +0000933 i := 0
934 for _, codename := range c.PlatformVersionActiveCodenames() {
935 if codename == "REL" {
936 continue
937 }
938
Dan Albert1a246272020-07-06 14:49:35 -0700939 levels = append(levels, ApiLevel{
940 value: codename,
941 number: i,
942 isPreview: true,
943 })
Dan Albertf93ea132023-10-05 20:40:46 +0000944 i++
Dan Albert1a246272020-07-06 14:49:35 -0700945 }
946 return levels
947}
948
satayevcca4ab72021-11-30 12:33:55 +0000949func (c *config) LatestPreviewApiLevel() ApiLevel {
950 level := NoneApiLevel
951 for _, l := range c.PreviewApiLevels() {
952 if l.GreaterThan(level) {
953 level = l
954 }
955 }
956 return level
957}
958
Dan Albert1a246272020-07-06 14:49:35 -0700959func (c *config) AllSupportedApiLevels() []ApiLevel {
960 var levels []ApiLevel
961 levels = append(levels, c.FinalApiLevels()...)
962 return append(levels, c.PreviewApiLevels()...)
Dan Albertf5415d72017-08-17 16:19:59 -0700963}
964
Jingwen Chenc711fec2020-11-22 23:52:50 -0500965// DefaultAppTargetSdk returns the API level that platform apps are targeting.
966// This converts a codename to the exact ApiLevel it represents.
Dan Albert4f378d72020-07-23 17:32:15 -0700967func (c *config) DefaultAppTargetSdk(ctx EarlyModuleContext) ApiLevel {
Colin Crossd09b0b62018-04-18 11:06:47 -0700968 if Bool(c.productVariables.Platform_sdk_final) {
969 return c.PlatformSdkVersion()
Colin Crossd09b0b62018-04-18 11:06:47 -0700970 }
Jingwen Chenc711fec2020-11-22 23:52:50 -0500971 codename := c.PlatformSdkCodename()
Jiyong Park3a00e3d2023-03-27 17:39:48 +0900972 hostOnlyBuild := c.productVariables.DeviceArch == nil
Jingwen Chenc711fec2020-11-22 23:52:50 -0500973 if codename == "" {
Jiyong Park3a00e3d2023-03-27 17:39:48 +0900974 // There are some host-only builds (those are invoked by build-prebuilts.sh) which
975 // don't set platform sdk codename. Platform sdk codename makes sense only when we
976 // are building the platform. So we don't enforce the below panic for the host-only
977 // builds.
978 if hostOnlyBuild {
979 return NoneApiLevel
980 }
981 panic("Platform_sdk_codename must be set")
Jingwen Chenc711fec2020-11-22 23:52:50 -0500982 }
983 if codename == "REL" {
984 panic("Platform_sdk_codename should not be REL when Platform_sdk_final is true")
985 }
986 return ApiLevelOrPanic(ctx, codename)
Colin Crossd09b0b62018-04-18 11:06:47 -0700987}
988
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800989func (c *config) AppsDefaultVersionName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800990 return String(c.productVariables.AppsDefaultVersionName)
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800991}
992
Dan Albert31384de2017-07-28 12:39:46 -0700993// Codenames that are active in the current lunch target.
994func (c *config) PlatformVersionActiveCodenames() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800995 return c.productVariables.Platform_version_active_codenames
Dan Albert31384de2017-07-28 12:39:46 -0700996}
997
Dan Albert8c7a9942023-03-27 20:34:01 +0000998// All unreleased codenames.
999func (c *config) PlatformVersionAllPreviewCodenames() []string {
1000 return c.productVariables.Platform_version_all_preview_codenames
1001}
1002
Colin Crossface4e42017-10-30 17:32:15 -07001003func (c *config) ProductAAPTConfig() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001004 return c.productVariables.AAPTConfig
Colin Cross30e076a2015-04-13 13:58:27 -07001005}
1006
Colin Crossface4e42017-10-30 17:32:15 -07001007func (c *config) ProductAAPTPreferredConfig() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001008 return String(c.productVariables.AAPTPreferredConfig)
Colin Cross30e076a2015-04-13 13:58:27 -07001009}
1010
Colin Crossface4e42017-10-30 17:32:15 -07001011func (c *config) ProductAAPTCharacteristics() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001012 return String(c.productVariables.AAPTCharacteristics)
Colin Crossface4e42017-10-30 17:32:15 -07001013}
1014
1015func (c *config) ProductAAPTPrebuiltDPI() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001016 return c.productVariables.AAPTPrebuiltDPI
Colin Cross30e076a2015-04-13 13:58:27 -07001017}
1018
Dan Willemsen34cc69e2015-09-23 15:26:20 -07001019func (c *config) DefaultAppCertificateDir(ctx PathContext) SourcePath {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001020 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -08001021 if defaultCert != "" {
1022 return PathForSource(ctx, filepath.Dir(defaultCert))
Colin Cross61ae0b72017-12-01 17:16:02 -08001023 }
Inseob Kim8fa54da2024-03-19 16:48:59 +09001024 return PathForSource(ctx, testKeyDir)
Colin Cross30e076a2015-04-13 13:58:27 -07001025}
1026
Colin Crosse1731a52017-12-14 11:22:55 -08001027func (c *config) DefaultAppCertificate(ctx PathContext) (pem, key SourcePath) {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001028 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -08001029 if defaultCert != "" {
Colin Crosse1731a52017-12-14 11:22:55 -08001030 return PathForSource(ctx, defaultCert+".x509.pem"), PathForSource(ctx, defaultCert+".pk8")
Colin Cross61ae0b72017-12-01 17:16:02 -08001031 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001032 defaultDir := c.DefaultAppCertificateDir(ctx)
1033 return defaultDir.Join(ctx, "testkey.x509.pem"), defaultDir.Join(ctx, "testkey.pk8")
Colin Cross30e076a2015-04-13 13:58:27 -07001034}
Colin Cross6ff51382015-12-17 16:39:19 -08001035
Inseob Kim8fa54da2024-03-19 16:48:59 +09001036func (c *config) BuildKeys() string {
1037 defaultCert := String(c.productVariables.DefaultAppCertificate)
1038 if defaultCert == "" || defaultCert == filepath.Join(testKeyDir, "testkey") {
1039 return "test-keys"
1040 }
1041 return "dev-keys"
1042}
1043
Jiyong Park9335a262018-12-24 11:31:58 +09001044func (c *config) ApexKeyDir(ctx ModuleContext) SourcePath {
1045 // TODO(b/121224311): define another variable such as TARGET_APEX_KEY_OVERRIDE
1046 defaultCert := String(c.productVariables.DefaultAppCertificate)
Inseob Kim8fa54da2024-03-19 16:48:59 +09001047 if defaultCert == "" || filepath.Dir(defaultCert) == testKeyDir {
Jiyong Park9335a262018-12-24 11:31:58 +09001048 // When defaultCert is unset or is set to the testkeys path, use the APEX keys
1049 // that is under the module dir
Colin Cross07e51612019-03-05 12:46:40 -08001050 return pathForModuleSrc(ctx)
Jiyong Park9335a262018-12-24 11:31:58 +09001051 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001052 // If not, APEX keys are under the specified directory
1053 return PathForSource(ctx, filepath.Dir(defaultCert))
Jiyong Park9335a262018-12-24 11:31:58 +09001054}
1055
Inseob Kim80fa7982022-08-12 21:36:25 +09001056// Certificate for the NetworkStack sepolicy context
1057func (c *config) MainlineSepolicyDevCertificatesDir(ctx ModuleContext) SourcePath {
1058 cert := String(c.productVariables.MainlineSepolicyDevCertificates)
1059 if cert != "" {
1060 return PathForSource(ctx, cert)
1061 }
1062 return c.DefaultAppCertificateDir(ctx)
1063}
1064
Jingwen Chenc711fec2020-11-22 23:52:50 -05001065// AllowMissingDependencies configures Blueprint/Soong to not fail when modules
1066// are configured to depend on non-existent modules. Note that this does not
1067// affect missing input dependencies at the Ninja level.
Colin Cross6ff51382015-12-17 16:39:19 -08001068func (c *config) AllowMissingDependencies() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001069 return Bool(c.productVariables.Allow_missing_dependencies)
Colin Cross6ff51382015-12-17 16:39:19 -08001070}
Dan Willemsen322acaf2016-01-12 23:07:05 -08001071
Jeongik Cha816a23a2020-07-08 01:09:23 +09001072// Returns true if a full platform source tree cannot be assumed.
Colin Crossfc3674a2017-09-18 17:41:52 -07001073func (c *config) UnbundledBuild() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001074 return Bool(c.productVariables.Unbundled_build)
Colin Crossfc3674a2017-09-18 17:41:52 -07001075}
1076
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +01001077// Returns true if building apps that aren't bundled with the platform.
1078// UnbundledBuild() is always true when this is true.
1079func (c *config) UnbundledBuildApps() bool {
Cole Faust701ca252021-11-23 19:02:08 -08001080 return len(c.productVariables.Unbundled_build_apps) > 0
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +01001081}
1082
Jeongik Cha4b073cd2021-06-08 11:35:00 +09001083// Returns true if building image that aren't bundled with the platform.
1084// UnbundledBuild() is always true when this is true.
1085func (c *config) UnbundledBuildImage() bool {
1086 return Bool(c.productVariables.Unbundled_build_image)
1087}
1088
Jeongik Cha816a23a2020-07-08 01:09:23 +09001089// Returns true if building modules against prebuilt SDKs.
1090func (c *config) AlwaysUsePrebuiltSdks() bool {
1091 return Bool(c.productVariables.Always_use_prebuilt_sdks)
Colin Cross1f367bf2018-12-18 22:46:24 -08001092}
1093
Colin Cross126a25c2017-10-31 13:55:34 -07001094func (c *config) MinimizeJavaDebugInfo() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001095 return Bool(c.productVariables.MinimizeJavaDebugInfo) && !Bool(c.productVariables.Eng)
Colin Cross126a25c2017-10-31 13:55:34 -07001096}
1097
Colin Crossed064c02018-09-05 16:28:13 -07001098func (c *config) Debuggable() bool {
1099 return Bool(c.productVariables.Debuggable)
1100}
1101
Jaewoong Jung1d6eb682018-11-29 15:08:44 -08001102func (c *config) Eng() bool {
1103 return Bool(c.productVariables.Eng)
1104}
1105
Inseob Kim8fa54da2024-03-19 16:48:59 +09001106func (c *config) BuildType() string {
1107 return String(c.productVariables.BuildType)
1108}
1109
Colin Crossc53c37f2021-12-08 15:42:22 -08001110// DevicePrimaryArchType returns the ArchType for the first configured device architecture, or
1111// Common if there are no device architectures.
Jiyong Park8d52f862018-07-07 18:02:07 +09001112func (c *config) DevicePrimaryArchType() ArchType {
Colin Crossc53c37f2021-12-08 15:42:22 -08001113 if androidTargets := c.Targets[Android]; len(androidTargets) > 0 {
1114 return androidTargets[0].Arch.ArchType
1115 }
1116 return Common
Jiyong Park8d52f862018-07-07 18:02:07 +09001117}
1118
Colin Cross16b23492016-01-06 14:41:07 -08001119func (c *config) SanitizeHost() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001120 return append([]string(nil), c.productVariables.SanitizeHost...)
Colin Cross16b23492016-01-06 14:41:07 -08001121}
1122
1123func (c *config) SanitizeDevice() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001124 return append([]string(nil), c.productVariables.SanitizeDevice...)
Colin Cross23ae82a2016-11-02 14:34:39 -07001125}
1126
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -07001127func (c *config) SanitizeDeviceDiag() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001128 return append([]string(nil), c.productVariables.SanitizeDeviceDiag...)
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -07001129}
1130
Colin Cross23ae82a2016-11-02 14:34:39 -07001131func (c *config) SanitizeDeviceArch() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001132 return append([]string(nil), c.productVariables.SanitizeDeviceArch...)
Colin Cross16b23492016-01-06 14:41:07 -08001133}
Colin Crossa1ad8d12016-06-01 17:09:44 -07001134
Vishwath Mohan1b017a72017-01-19 13:54:55 -08001135func (c *config) EnableCFI() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001136 if c.productVariables.EnableCFI == nil {
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -08001137 return true
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -08001138 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001139 return *c.productVariables.EnableCFI
Vishwath Mohan1b017a72017-01-19 13:54:55 -08001140}
1141
Kostya Kortchinskyd5275c82019-02-01 08:42:56 -08001142func (c *config) DisableScudo() bool {
1143 return Bool(c.productVariables.DisableScudo)
1144}
1145
Colin Crossa1ad8d12016-06-01 17:09:44 -07001146func (c *config) Android64() bool {
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001147 for _, t := range c.Targets[Android] {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001148 if t.Arch.ArchType.Multilib == "lib64" {
1149 return true
1150 }
1151 }
1152
1153 return false
1154}
Colin Cross9272ade2016-08-17 15:24:12 -07001155
Colin Cross9d45bb72016-08-29 16:14:13 -07001156func (c *config) UseGoma() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001157 return Bool(c.productVariables.UseGoma)
Colin Cross9d45bb72016-08-29 16:14:13 -07001158}
1159
Ramy Medhatbbf25672019-07-17 12:30:04 +00001160func (c *config) UseRBE() bool {
1161 return Bool(c.productVariables.UseRBE)
1162}
1163
Ramy Medhat8ea054a2020-01-27 14:19:44 -05001164func (c *config) UseRBEJAVAC() bool {
1165 return Bool(c.productVariables.UseRBEJAVAC)
1166}
1167
1168func (c *config) UseRBER8() bool {
1169 return Bool(c.productVariables.UseRBER8)
1170}
1171
1172func (c *config) UseRBED8() bool {
1173 return Bool(c.productVariables.UseRBED8)
1174}
1175
Colin Cross8b8bec32019-11-15 13:18:43 -08001176func (c *config) UseRemoteBuild() bool {
1177 return c.UseGoma() || c.UseRBE()
1178}
1179
Colin Cross66548102018-06-19 22:47:35 -07001180func (c *config) RunErrorProne() bool {
1181 return c.IsEnvTrue("RUN_ERROR_PRONE")
1182}
1183
Jingwen Chenc711fec2020-11-22 23:52:50 -05001184// XrefCorpusName returns the Kythe cross-reference corpus name.
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001185func (c *config) XrefCorpusName() string {
1186 return c.Getenv("XREF_CORPUS")
1187}
1188
Jingwen Chenc711fec2020-11-22 23:52:50 -05001189// XrefCuEncoding returns the compilation unit encoding to use for Kythe code
1190// xrefs. Can be 'json' (default), 'proto' or 'all'.
Sasha Smundak6c2d4f92020-01-09 17:34:23 -08001191func (c *config) XrefCuEncoding() string {
1192 if enc := c.Getenv("KYTHE_KZIP_ENCODING"); enc != "" {
1193 return enc
1194 }
1195 return "json"
1196}
1197
Sasha Smundakb0addaf2021-02-16 10:39:40 -08001198// XrefCuJavaSourceMax returns the maximum number of the Java source files
1199// in a single compilation unit
1200const xrefJavaSourceFileMaxDefault = "1000"
1201
1202func (c Config) XrefCuJavaSourceMax() string {
1203 v := c.Getenv("KYTHE_JAVA_SOURCE_BATCH_SIZE")
1204 if v == "" {
1205 return xrefJavaSourceFileMaxDefault
1206 }
1207 if _, err := strconv.ParseUint(v, 0, 0); err != nil {
1208 fmt.Fprintf(os.Stderr,
1209 "bad KYTHE_JAVA_SOURCE_BATCH_SIZE value: %s, will use %s",
1210 err, xrefJavaSourceFileMaxDefault)
1211 return xrefJavaSourceFileMaxDefault
1212 }
1213 return v
1214
1215}
1216
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001217func (c *config) EmitXrefRules() bool {
1218 return c.XrefCorpusName() != ""
1219}
1220
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001221func (c *config) ClangTidy() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001222 return Bool(c.productVariables.ClangTidy)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001223}
1224
1225func (c *config) TidyChecks() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001226 if c.productVariables.TidyChecks == nil {
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001227 return ""
1228 }
Dan Willemsen45133ac2018-03-09 21:22:06 -08001229 return *c.productVariables.TidyChecks
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001230}
1231
Colin Cross0f4e0d62016-07-27 10:56:55 -07001232func (c *config) LibartImgHostBaseAddress() string {
1233 return "0x60000000"
1234}
1235
1236func (c *config) LibartImgDeviceBaseAddress() string {
Elliott Hughesda3a0712020-03-06 16:55:28 -08001237 return "0x70000000"
Colin Cross0f4e0d62016-07-27 10:56:55 -07001238}
1239
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001240func (c *config) ArtUseReadBarrier() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001241 return Bool(c.productVariables.ArtUseReadBarrier)
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001242}
1243
Jingwen Chenc711fec2020-11-22 23:52:50 -05001244// Enforce Runtime Resource Overlays for a module. RROs supersede static RROs,
1245// but some modules still depend on it.
1246//
1247// More info: https://source.android.com/devices/architecture/rros
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001248func (c *config) EnforceRROForModule(name string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001249 enforceList := c.productVariables.EnforceRROTargets
Jeongik Chacee5ba92021-02-19 12:11:51 +09001250
Roland Levillainf6cc2612020-07-09 16:58:14 +01001251 if len(enforceList) > 0 {
Yo Chiang4ebd06a2019-10-01 13:13:41 +08001252 if InList("*", enforceList) {
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001253 return true
1254 }
Colin Crossa74ca042019-01-31 14:31:51 -08001255 return InList(name, enforceList)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001256 }
1257 return false
1258}
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001259func (c *config) EnforceRROExcludedOverlay(path string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001260 excluded := c.productVariables.EnforceRROExcludedOverlays
Roland Levillainf6cc2612020-07-09 16:58:14 +01001261 if len(excluded) > 0 {
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001262 return HasAnyPrefix(path, excluded)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001263 }
1264 return false
1265}
1266
1267func (c *config) ExportedNamespaces() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001268 return append([]string(nil), c.productVariables.NamespacesToExport...)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001269}
1270
Sam Delmerico98a73292023-02-21 11:50:29 -05001271func (c *config) SourceRootDirs() []string {
1272 return c.productVariables.SourceRootDirs
1273}
1274
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001275func (c *config) HostStaticBinaries() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001276 return Bool(c.productVariables.HostStaticBinaries)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001277}
1278
Colin Cross5a0dcd52018-10-05 14:20:06 -07001279func (c *config) UncompressPrivAppDex() bool {
1280 return Bool(c.productVariables.UncompressPrivAppDex)
1281}
1282
1283func (c *config) ModulesLoadedByPrivilegedModules() []string {
1284 return c.productVariables.ModulesLoadedByPrivilegedModules
1285}
1286
Jingwen Chenc711fec2020-11-22 23:52:50 -05001287// DexpreoptGlobalConfigPath returns the path to the dexpreopt.config file in
1288// the output directory, if it was created during the product configuration
1289// phase by Kati.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001290func (c *config) DexpreoptGlobalConfigPath(ctx PathContext) OptionalPath {
Colin Cross988414c2020-01-11 01:11:46 +00001291 if c.productVariables.DexpreoptGlobalConfig == nil {
Jingwen Chenebb0b572020-11-02 00:24:57 -05001292 return OptionalPathForPath(nil)
1293 }
1294 return OptionalPathForPath(
1295 pathForBuildToolDep(ctx, *c.productVariables.DexpreoptGlobalConfig))
1296}
1297
Jingwen Chenc711fec2020-11-22 23:52:50 -05001298// DexpreoptGlobalConfig returns the raw byte contents of the dexpreopt global
1299// configuration. Since the configuration file was created by Kati during
1300// product configuration (externally of soong_build), it's not tracked, so we
1301// also manually add a Ninja file dependency on the configuration file to the
1302// rule that creates the main build.ninja file. This ensures that build.ninja is
1303// regenerated correctly if dexpreopt.config changes.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001304func (c *config) DexpreoptGlobalConfig(ctx PathContext) ([]byte, error) {
1305 path := c.DexpreoptGlobalConfigPath(ctx)
1306 if !path.Valid() {
Colin Cross988414c2020-01-11 01:11:46 +00001307 return nil, nil
1308 }
Jingwen Chenebb0b572020-11-02 00:24:57 -05001309 ctx.AddNinjaFileDeps(path.String())
Sasha Smundakaf5ca922022-12-12 21:23:34 -08001310 return os.ReadFile(absolutePath(path.String()))
Colin Cross43f08db2018-11-12 10:13:39 -08001311}
1312
Inseob Kim7b85eeb2021-03-23 20:52:24 +09001313func (c *deviceConfig) WithDexpreopt() bool {
1314 return c.config.productVariables.WithDexpreopt
1315}
1316
Colin Cross662d6142022-11-03 20:38:01 -07001317func (c *config) FrameworksBaseDirExists(ctx PathGlobContext) bool {
Colin Cross5a756a62021-03-16 16:34:46 -07001318 return ExistentPathForSource(ctx, "frameworks", "base", "Android.bp").Valid()
David Brazdil91b4e3e2019-01-23 21:04:05 +00001319}
1320
Inseob Kimae553032019-05-14 18:52:49 +09001321func (c *config) VndkSnapshotBuildArtifacts() bool {
1322 return Bool(c.productVariables.VndkSnapshotBuildArtifacts)
1323}
1324
Colin Cross3b19f5d2019-09-17 14:45:31 -07001325func (c *config) HasMultilibConflict(arch ArchType) bool {
1326 return c.multilibConflicts[arch]
1327}
1328
Sasha Smundakaf5ca922022-12-12 21:23:34 -08001329func (c *config) PrebuiltHiddenApiDir(_ PathContext) string {
Bill Peckhambae47492021-01-08 09:34:44 -08001330 return String(c.productVariables.PrebuiltHiddenApiDir)
1331}
1332
Justin Yun41cbb5e2023-11-29 17:58:16 +09001333func (c *config) VendorApiLevel() string {
1334 return String(c.productVariables.VendorApiLevel)
1335}
1336
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001337func (c *config) PrevVendorApiLevel() string {
1338 vendorApiLevel, err := strconv.Atoi(c.VendorApiLevel())
1339 if err != nil {
1340 panic(fmt.Errorf("Cannot parse vendor API level %s to an integer: %s",
1341 c.VendorApiLevel(), err))
1342 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001343 // The version before trunk stable is 34.
1344 if vendorApiLevel == 202404 {
1345 return "34"
1346 }
Hsin-Yi Chen890e7722024-03-05 15:56:44 +08001347 if vendorApiLevel >= 1 && vendorApiLevel <= 34 {
1348 return strconv.Itoa(vendorApiLevel - 1)
1349 }
1350 if vendorApiLevel < 202404 || vendorApiLevel%100 != 4 {
1351 panic("Unknown vendor API level " + c.VendorApiLevel())
1352 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001353 return strconv.Itoa(vendorApiLevel - 100)
1354}
1355
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001356func IsTrunkStableVendorApiLevel(level string) bool {
1357 levelInt, err := strconv.Atoi(level)
1358 return err == nil && levelInt >= 202404
1359}
1360
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001361func (c *config) VendorApiLevelFrozen() bool {
1362 return c.productVariables.GetBuildFlagBool("RELEASE_BOARD_API_LEVEL_FROZEN")
1363}
1364
Colin Cross9272ade2016-08-17 15:24:12 -07001365func (c *deviceConfig) Arches() []Arch {
1366 var arches []Arch
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001367 for _, target := range c.config.Targets[Android] {
Colin Cross9272ade2016-08-17 15:24:12 -07001368 arches = append(arches, target.Arch)
1369 }
1370 return arches
1371}
Dan Willemsend2ede872016-11-18 14:54:24 -08001372
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001373func (c *deviceConfig) BinderBitness() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001374 is32BitBinder := c.config.productVariables.Binder32bit
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001375 if is32BitBinder != nil && *is32BitBinder {
1376 return "32"
1377 }
1378 return "64"
1379}
1380
Dan Willemsen4353bc42016-12-05 17:16:02 -08001381func (c *deviceConfig) VendorPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001382 if c.config.productVariables.VendorPath != nil {
1383 return *c.config.productVariables.VendorPath
Dan Willemsen4353bc42016-12-05 17:16:02 -08001384 }
1385 return "vendor"
1386}
1387
Jose Galmes6f843bc2020-12-11 13:36:29 -08001388func (c *deviceConfig) RecoverySnapshotVersion() string {
1389 return String(c.config.productVariables.RecoverySnapshotVersion)
1390}
1391
Jeongik Cha219141c2020-08-06 23:00:37 +09001392func (c *deviceConfig) CurrentApiLevelForVendorModules() string {
1393 return StringDefault(c.config.productVariables.DeviceCurrentApiLevelForVendorModules, "current")
1394}
1395
Justin Yun71549282017-11-17 12:10:28 +09001396func (c *deviceConfig) ExtraVndkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001397 return c.config.productVariables.ExtraVndkVersions
Dan Willemsend2ede872016-11-18 14:54:24 -08001398}
Jack He8cc71432016-12-08 15:45:07 -08001399
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001400func (c *deviceConfig) SystemSdkVersions() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001401 return c.config.productVariables.DeviceSystemSdkVersions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001402}
1403
1404func (c *deviceConfig) PlatformSystemSdkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001405 return c.config.productVariables.Platform_systemsdk_versions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001406}
1407
Jiyong Park2db76922017-11-08 16:03:48 +09001408func (c *deviceConfig) OdmPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001409 if c.config.productVariables.OdmPath != nil {
1410 return *c.config.productVariables.OdmPath
Jiyong Park2db76922017-11-08 16:03:48 +09001411 }
1412 return "odm"
1413}
1414
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001415func (c *deviceConfig) ProductPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001416 if c.config.productVariables.ProductPath != nil {
1417 return *c.config.productVariables.ProductPath
Jiyong Park2db76922017-11-08 16:03:48 +09001418 }
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001419 return "product"
Jiyong Park2db76922017-11-08 16:03:48 +09001420}
1421
Justin Yund5f6c822019-06-25 16:47:17 +09001422func (c *deviceConfig) SystemExtPath() string {
1423 if c.config.productVariables.SystemExtPath != nil {
1424 return *c.config.productVariables.SystemExtPath
Dario Frenifd05a742018-05-29 13:28:54 +01001425 }
Justin Yund5f6c822019-06-25 16:47:17 +09001426 return "system_ext"
Dario Frenifd05a742018-05-29 13:28:54 +01001427}
1428
Jack He8cc71432016-12-08 15:45:07 -08001429func (c *deviceConfig) BtConfigIncludeDir() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001430 return String(c.config.productVariables.BtConfigIncludeDir)
Jack He8cc71432016-12-08 15:45:07 -08001431}
Dan Willemsen581341d2017-02-09 16:16:31 -08001432
Jiyong Parkd773eb32017-07-03 13:18:12 +09001433func (c *deviceConfig) DeviceKernelHeaderDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001434 return c.config.productVariables.DeviceKernelHeaders
Jiyong Parkd773eb32017-07-03 13:18:12 +09001435}
1436
Roland Levillainada12702020-06-09 13:07:36 +01001437// JavaCoverageEnabledForPath returns whether Java code coverage is enabled for
1438// path. Coverage is enabled by default when the product variable
1439// JavaCoveragePaths is empty. If JavaCoveragePaths is not empty, coverage is
1440// enabled for any path which is part of this variable (and not part of the
1441// JavaCoverageExcludePaths product variable). Value "*" in JavaCoveragePaths
1442// represents any path.
1443func (c *deviceConfig) JavaCoverageEnabledForPath(path string) bool {
1444 coverage := false
Chris Gross2f748692020-06-24 20:36:59 +00001445 if len(c.config.productVariables.JavaCoveragePaths) == 0 ||
Roland Levillainada12702020-06-09 13:07:36 +01001446 InList("*", c.config.productVariables.JavaCoveragePaths) ||
1447 HasAnyPrefix(path, c.config.productVariables.JavaCoveragePaths) {
1448 coverage = true
1449 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001450 if coverage && len(c.config.productVariables.JavaCoverageExcludePaths) > 0 {
Roland Levillainada12702020-06-09 13:07:36 +01001451 if HasAnyPrefix(path, c.config.productVariables.JavaCoverageExcludePaths) {
1452 coverage = false
1453 }
1454 }
1455 return coverage
1456}
1457
Colin Cross1a6acd42020-06-16 17:51:46 -07001458// Returns true if gcov or clang coverage is enabled.
Dan Willemsen581341d2017-02-09 16:16:31 -08001459func (c *deviceConfig) NativeCoverageEnabled() bool {
Colin Cross1a6acd42020-06-16 17:51:46 -07001460 return Bool(c.config.productVariables.GcovCoverage) ||
1461 Bool(c.config.productVariables.ClangCoverage)
Dan Willemsen581341d2017-02-09 16:16:31 -08001462}
1463
Oliver Nguyen1382ab62019-12-06 15:22:41 -08001464func (c *deviceConfig) ClangCoverageEnabled() bool {
1465 return Bool(c.config.productVariables.ClangCoverage)
1466}
1467
Pirama Arumuga Nainarb37ae582022-01-26 22:14:32 -08001468func (c *deviceConfig) ClangCoverageContinuousMode() bool {
1469 return Bool(c.config.productVariables.ClangCoverageContinuousMode)
1470}
1471
Colin Cross1a6acd42020-06-16 17:51:46 -07001472func (c *deviceConfig) GcovCoverageEnabled() bool {
1473 return Bool(c.config.productVariables.GcovCoverage)
1474}
1475
Roland Levillain4f5297b2020-06-09 12:44:06 +01001476// NativeCoverageEnabledForPath returns whether (GCOV- or Clang-based) native
1477// code coverage is enabled for path. By default, coverage is not enabled for a
1478// given path unless it is part of the NativeCoveragePaths product variable (and
1479// not part of the NativeCoverageExcludePaths product variable). Value "*" in
1480// NativeCoveragePaths represents any path.
1481func (c *deviceConfig) NativeCoverageEnabledForPath(path string) bool {
Ryan Campbell469a18a2017-02-27 09:01:54 -08001482 coverage := false
Roland Levillainf6cc2612020-07-09 16:58:14 +01001483 if len(c.config.productVariables.NativeCoveragePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001484 if InList("*", c.config.productVariables.NativeCoveragePaths) || HasAnyPrefix(path, c.config.productVariables.NativeCoveragePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001485 coverage = true
Dan Willemsen581341d2017-02-09 16:16:31 -08001486 }
1487 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001488 if coverage && len(c.config.productVariables.NativeCoverageExcludePaths) > 0 {
Yi Kongfd07ed22023-02-16 17:42:27 +09001489 // Workaround coverage boot failure.
1490 // http://b/269981180
1491 if strings.HasPrefix(path, "external/protobuf") {
1492 coverage = false
1493 }
Roland Levillain4f5297b2020-06-09 12:44:06 +01001494 if HasAnyPrefix(path, c.config.productVariables.NativeCoverageExcludePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001495 coverage = false
Ryan Campbell469a18a2017-02-27 09:01:54 -08001496 }
1497 }
1498 return coverage
Dan Willemsen581341d2017-02-09 16:16:31 -08001499}
Ivan Lozano5f595532017-07-13 14:46:05 -07001500
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001501func (c *deviceConfig) PgoAdditionalProfileDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001502 return c.config.productVariables.PgoAdditionalProfileDirs
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001503}
1504
Vinh Tran44cb78c2023-03-09 22:07:19 -05001505// AfdoProfile returns fully qualified path associated to the given module name
Colin Crossd38feb02024-01-23 16:38:06 -08001506func (c *deviceConfig) AfdoProfile(name string) (string, error) {
Vinh Tran44cb78c2023-03-09 22:07:19 -05001507 for _, afdoProfile := range c.config.productVariables.AfdoProfiles {
1508 split := strings.Split(afdoProfile, ":")
1509 if len(split) != 3 {
Colin Crossd38feb02024-01-23 16:38:06 -08001510 return "", fmt.Errorf("AFDO_PROFILES has invalid value: %s. "+
Vinh Tran44cb78c2023-03-09 22:07:19 -05001511 "The expected format is <module>:<fully-qualified-path-to-fdo_profile>", afdoProfile)
1512 }
1513 if split[0] == name {
Colin Crossd38feb02024-01-23 16:38:06 -08001514 return strings.Join([]string{split[1], split[2]}, ":"), nil
Vinh Tran44cb78c2023-03-09 22:07:19 -05001515 }
1516 }
Colin Crossd38feb02024-01-23 16:38:06 -08001517 return "", nil
Vinh Tran44cb78c2023-03-09 22:07:19 -05001518}
1519
Tri Vo35a51432018-03-25 20:00:00 -07001520func (c *deviceConfig) VendorSepolicyDirs() []string {
1521 return c.config.productVariables.BoardVendorSepolicyDirs
1522}
1523
1524func (c *deviceConfig) OdmSepolicyDirs() []string {
1525 return c.config.productVariables.BoardOdmSepolicyDirs
1526}
1527
Felixa20a8752020-05-17 18:28:35 +02001528func (c *deviceConfig) SystemExtPublicSepolicyDirs() []string {
1529 return c.config.productVariables.SystemExtPublicSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001530}
1531
Felixa20a8752020-05-17 18:28:35 +02001532func (c *deviceConfig) SystemExtPrivateSepolicyDirs() []string {
1533 return c.config.productVariables.SystemExtPrivateSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001534}
1535
Inseob Kim0866b002019-04-15 20:21:29 +09001536func (c *deviceConfig) SepolicyM4Defs() []string {
1537 return c.config.productVariables.BoardSepolicyM4Defs
1538}
1539
Jiyong Park7f67f482019-01-05 12:57:48 +09001540func (c *deviceConfig) OverrideManifestPackageNameFor(name string) (manifestName string, overridden bool) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001541 return findOverrideValue(c.config.productVariables.ManifestPackageNameOverrides, name,
1542 "invalid override rule %q in PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES should be <module_name>:<manifest_name>")
1543}
1544
1545func (c *deviceConfig) OverrideCertificateFor(name string) (certificatePath string, overridden bool) {
Jaewoong Jungacb6db32019-02-28 16:22:30 +00001546 return findOverrideValue(c.config.productVariables.CertificateOverrides, name,
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001547 "invalid override rule %q in PRODUCT_CERTIFICATE_OVERRIDES should be <module_name>:<certificate_module_name>")
1548}
1549
Jaewoong Jung9d22a912019-01-23 16:27:47 -08001550func (c *deviceConfig) OverridePackageNameFor(name string) string {
1551 newName, overridden := findOverrideValue(
1552 c.config.productVariables.PackageNameOverrides,
1553 name,
1554 "invalid override rule %q in PRODUCT_PACKAGE_NAME_OVERRIDES should be <module_name>:<package_name>")
1555 if overridden {
1556 return newName
1557 }
1558 return name
1559}
1560
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001561func findOverrideValue(overrides []string, name string, errorMsg string) (newValue string, overridden bool) {
Jiyong Park7f67f482019-01-05 12:57:48 +09001562 if overrides == nil || len(overrides) == 0 {
1563 return "", false
1564 }
1565 for _, o := range overrides {
1566 split := strings.Split(o, ":")
1567 if len(split) != 2 {
1568 // This shouldn't happen as this is first checked in make, but just in case.
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001569 panic(fmt.Errorf(errorMsg, o))
Jiyong Park7f67f482019-01-05 12:57:48 +09001570 }
1571 if matchPattern(split[0], name) {
1572 return substPattern(split[0], split[1], name), true
1573 }
1574 }
1575 return "", false
1576}
1577
Albert Martineefabcf2022-03-21 20:11:16 +00001578func (c *deviceConfig) ApexGlobalMinSdkVersionOverride() string {
1579 return String(c.config.productVariables.ApexGlobalMinSdkVersionOverride)
1580}
1581
Ivan Lozano5f595532017-07-13 14:46:05 -07001582func (c *config) IntegerOverflowDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001583 if len(c.productVariables.IntegerOverflowExcludePaths) == 0 {
Ivan Lozano5f595532017-07-13 14:46:05 -07001584 return false
1585 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001586 return HasAnyPrefix(path, c.productVariables.IntegerOverflowExcludePaths)
Ivan Lozano5f595532017-07-13 14:46:05 -07001587}
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001588
1589func (c *config) CFIDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001590 if len(c.productVariables.CFIExcludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001591 return false
1592 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001593 return HasAnyPrefix(path, c.productVariables.CFIExcludePaths)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001594}
1595
1596func (c *config) CFIEnabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001597 if len(c.productVariables.CFIIncludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001598 return false
1599 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001600 return HasAnyPrefix(path, c.productVariables.CFIIncludePaths) && !c.CFIDisabledForPath(path)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001601}
Colin Crosse15ddaf2017-12-04 11:24:31 -08001602
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001603func (c *config) MemtagHeapDisabledForPath(path string) bool {
1604 if len(c.productVariables.MemtagHeapExcludePaths) == 0 {
1605 return false
1606 }
1607 return HasAnyPrefix(path, c.productVariables.MemtagHeapExcludePaths)
1608}
1609
1610func (c *config) MemtagHeapAsyncEnabledForPath(path string) bool {
1611 if len(c.productVariables.MemtagHeapAsyncIncludePaths) == 0 {
1612 return false
1613 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001614 return HasAnyPrefix(path, c.productVariables.MemtagHeapAsyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001615}
1616
1617func (c *config) MemtagHeapSyncEnabledForPath(path string) bool {
1618 if len(c.productVariables.MemtagHeapSyncIncludePaths) == 0 {
1619 return false
1620 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001621 return HasAnyPrefix(path, c.productVariables.MemtagHeapSyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001622}
1623
Tomislav Novakf734f002023-08-22 10:51:44 -07001624func (c *config) HWASanDisabledForPath(path string) bool {
1625 if len(c.productVariables.HWASanExcludePaths) == 0 {
1626 return false
1627 }
1628 return HasAnyPrefix(path, c.productVariables.HWASanExcludePaths)
1629}
1630
Hang Lua98aab92023-03-17 13:17:22 +08001631func (c *config) HWASanEnabledForPath(path string) bool {
1632 if len(c.productVariables.HWASanIncludePaths) == 0 {
1633 return false
1634 }
Tomislav Novakf734f002023-08-22 10:51:44 -07001635 return HasAnyPrefix(path, c.productVariables.HWASanIncludePaths) && !c.HWASanDisabledForPath(path)
Hang Lua98aab92023-03-17 13:17:22 +08001636}
1637
Dan Willemsen0fe78662018-03-26 12:41:18 -07001638func (c *config) VendorConfig(name string) VendorConfig {
Colin Cross9d34f352019-11-22 16:03:51 -08001639 return soongconfig.Config(c.productVariables.VendorVars[name])
Dan Willemsen0fe78662018-03-26 12:41:18 -07001640}
1641
Colin Cross395f2cf2018-10-24 16:10:32 -07001642func (c *config) NdkAbis() bool {
1643 return Bool(c.productVariables.Ndk_abis)
1644}
1645
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001646func (c *config) AmlAbis() bool {
1647 return Bool(c.productVariables.Aml_abis)
1648}
1649
Jiyong Park4da07972021-01-05 21:01:11 +09001650func (c *config) ForceApexSymlinkOptimization() bool {
1651 return Bool(c.productVariables.ForceApexSymlinkOptimization)
1652}
1653
Sasha Smundakfe9a5b82022-07-27 14:51:45 -07001654func (c *config) ApexCompressionEnabled() bool {
1655 return Bool(c.productVariables.CompressedApex) && !c.UnbundledBuildApps()
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +00001656}
1657
Dennis Shene2ed70c2023-01-11 14:15:43 +00001658func (c *config) ApexTrimEnabled() bool {
1659 return Bool(c.productVariables.TrimmedApex)
1660}
1661
Jeongik Chac9464142019-01-07 12:07:27 +09001662func (c *config) EnforceSystemCertificate() bool {
1663 return Bool(c.productVariables.EnforceSystemCertificate)
1664}
1665
Colin Cross440e0d02020-06-11 11:32:11 -07001666func (c *config) EnforceSystemCertificateAllowList() []string {
1667 return c.productVariables.EnforceSystemCertificateAllowList
Jeongik Chac9464142019-01-07 12:07:27 +09001668}
1669
Jeongik Cha2cc570d2019-10-29 15:44:45 +09001670func (c *config) EnforceProductPartitionInterface() bool {
1671 return Bool(c.productVariables.EnforceProductPartitionInterface)
1672}
1673
JaeMan Parkff715562020-10-19 17:25:58 +09001674func (c *config) EnforceInterPartitionJavaSdkLibrary() bool {
1675 return Bool(c.productVariables.EnforceInterPartitionJavaSdkLibrary)
1676}
1677
1678func (c *config) InterPartitionJavaLibraryAllowList() []string {
1679 return c.productVariables.InterPartitionJavaLibraryAllowList
1680}
1681
Colin Crossf24a22a2019-01-31 14:12:44 -08001682func (c *config) ProductHiddenAPIStubs() []string {
1683 return c.productVariables.ProductHiddenAPIStubs
Colin Cross8faf8fc2019-01-16 15:15:52 -08001684}
1685
Colin Crossf24a22a2019-01-31 14:12:44 -08001686func (c *config) ProductHiddenAPIStubsSystem() []string {
1687 return c.productVariables.ProductHiddenAPIStubsSystem
Colin Cross8faf8fc2019-01-16 15:15:52 -08001688}
1689
Colin Crossf24a22a2019-01-31 14:12:44 -08001690func (c *config) ProductHiddenAPIStubsTest() []string {
1691 return c.productVariables.ProductHiddenAPIStubsTest
Colin Cross8faf8fc2019-01-16 15:15:52 -08001692}
Dan Willemsen71c74602019-04-10 12:27:35 -07001693
Dan Willemsen54879d12019-04-18 10:08:46 -07001694func (c *deviceConfig) TargetFSConfigGen() []string {
Dan Willemsen71c74602019-04-10 12:27:35 -07001695 return c.config.productVariables.TargetFSConfigGen
1696}
Inseob Kim0866b002019-04-15 20:21:29 +09001697
1698func (c *config) ProductPublicSepolicyDirs() []string {
1699 return c.productVariables.ProductPublicSepolicyDirs
1700}
1701
1702func (c *config) ProductPrivateSepolicyDirs() []string {
1703 return c.productVariables.ProductPrivateSepolicyDirs
1704}
1705
Inseob Kim5eb7ee92022-04-27 10:30:34 +09001706func (c *config) TargetMultitreeUpdateMeta() bool {
1707 return c.productVariables.MultitreeUpdateMeta
1708}
1709
Inseob Kim1f086e22019-05-09 13:29:15 +09001710func (c *deviceConfig) DeviceArch() string {
1711 return String(c.config.productVariables.DeviceArch)
1712}
1713
1714func (c *deviceConfig) DeviceArchVariant() string {
1715 return String(c.config.productVariables.DeviceArchVariant)
1716}
1717
1718func (c *deviceConfig) DeviceSecondaryArch() string {
1719 return String(c.config.productVariables.DeviceSecondaryArch)
1720}
1721
1722func (c *deviceConfig) DeviceSecondaryArchVariant() string {
1723 return String(c.config.productVariables.DeviceSecondaryArchVariant)
1724}
Yifan Hong82db7352020-01-21 16:12:26 -08001725
1726func (c *deviceConfig) BoardUsesRecoveryAsBoot() bool {
1727 return Bool(c.config.productVariables.BoardUsesRecoveryAsBoot)
1728}
Yifan Hong97365ee2020-07-29 09:51:57 -07001729
1730func (c *deviceConfig) BoardKernelBinaries() []string {
1731 return c.config.productVariables.BoardKernelBinaries
1732}
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001733
Yifan Hong42bef8d2020-08-05 14:36:09 -07001734func (c *deviceConfig) BoardKernelModuleInterfaceVersions() []string {
1735 return c.config.productVariables.BoardKernelModuleInterfaceVersions
1736}
1737
Yifan Hongdd8dacc2020-10-21 15:40:17 -07001738func (c *deviceConfig) BoardMoveRecoveryResourcesToVendorBoot() bool {
1739 return Bool(c.config.productVariables.BoardMoveRecoveryResourcesToVendorBoot)
1740}
1741
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001742func (c *deviceConfig) PlatformSepolicyVersion() string {
1743 return String(c.config.productVariables.PlatformSepolicyVersion)
1744}
1745
Inseob Kim843f6642022-01-07 09:11:23 +09001746func (c *deviceConfig) PlatformSepolicyCompatVersions() []string {
1747 return c.config.productVariables.PlatformSepolicyCompatVersions
1748}
1749
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001750func (c *deviceConfig) BoardSepolicyVers() string {
Inseob Kim0c4eec82021-03-22 22:33:40 +09001751 if ver := String(c.config.productVariables.BoardSepolicyVers); ver != "" {
1752 return ver
1753 }
1754 return c.PlatformSepolicyVersion()
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001755}
1756
Inseob Kim1a0afcc2022-02-14 23:10:51 +09001757func (c *deviceConfig) SystemExtSepolicyPrebuiltApiDir() string {
1758 return String(c.config.productVariables.SystemExtSepolicyPrebuiltApiDir)
1759}
1760
1761func (c *deviceConfig) ProductSepolicyPrebuiltApiDir() string {
1762 return String(c.config.productVariables.ProductSepolicyPrebuiltApiDir)
1763}
1764
1765func (c *deviceConfig) IsPartnerTrebleSepolicyTestEnabled() bool {
1766 return c.SystemExtSepolicyPrebuiltApiDir() != "" || c.ProductSepolicyPrebuiltApiDir() != ""
1767}
1768
Inseob Kim7cf14652021-01-06 23:06:52 +09001769func (c *deviceConfig) DirectedVendorSnapshot() bool {
1770 return c.config.productVariables.DirectedVendorSnapshot
1771}
1772
1773func (c *deviceConfig) VendorSnapshotModules() map[string]bool {
1774 return c.config.productVariables.VendorSnapshotModules
1775}
1776
Jose Galmes4c6895e2021-02-09 07:44:30 -08001777func (c *deviceConfig) DirectedRecoverySnapshot() bool {
1778 return c.config.productVariables.DirectedRecoverySnapshot
1779}
1780
1781func (c *deviceConfig) RecoverySnapshotModules() map[string]bool {
1782 return c.config.productVariables.RecoverySnapshotModules
1783}
1784
Justin DeMartino383bfb32021-02-24 10:49:43 -08001785func createDirsMap(previous map[string]bool, dirs []string) (map[string]bool, error) {
1786 var ret = make(map[string]bool)
1787 for _, dir := range dirs {
1788 clean := filepath.Clean(dir)
1789 if previous[clean] || ret[clean] {
1790 return nil, fmt.Errorf("Duplicate entry %s", dir)
1791 }
1792 ret[clean] = true
1793 }
1794 return ret, nil
1795}
1796
1797func (c *deviceConfig) createDirsMapOnce(onceKey OnceKey, previous map[string]bool, dirs []string) map[string]bool {
1798 dirMap := c.Once(onceKey, func() interface{} {
1799 ret, err := createDirsMap(previous, dirs)
1800 if err != nil {
1801 panic(fmt.Errorf("%s: %w", onceKey.key, err))
1802 }
1803 return ret
1804 })
1805 if dirMap == nil {
1806 return nil
1807 }
1808 return dirMap.(map[string]bool)
1809}
1810
1811var vendorSnapshotDirsExcludedKey = NewOnceKey("VendorSnapshotDirsExcludedMap")
1812
1813func (c *deviceConfig) VendorSnapshotDirsExcludedMap() map[string]bool {
1814 return c.createDirsMapOnce(vendorSnapshotDirsExcludedKey, nil,
1815 c.config.productVariables.VendorSnapshotDirsExcluded)
1816}
1817
1818var vendorSnapshotDirsIncludedKey = NewOnceKey("VendorSnapshotDirsIncludedMap")
1819
1820func (c *deviceConfig) VendorSnapshotDirsIncludedMap() map[string]bool {
1821 excludedMap := c.VendorSnapshotDirsExcludedMap()
1822 return c.createDirsMapOnce(vendorSnapshotDirsIncludedKey, excludedMap,
1823 c.config.productVariables.VendorSnapshotDirsIncluded)
1824}
1825
1826var recoverySnapshotDirsExcludedKey = NewOnceKey("RecoverySnapshotDirsExcludedMap")
1827
1828func (c *deviceConfig) RecoverySnapshotDirsExcludedMap() map[string]bool {
1829 return c.createDirsMapOnce(recoverySnapshotDirsExcludedKey, nil,
1830 c.config.productVariables.RecoverySnapshotDirsExcluded)
1831}
1832
1833var recoverySnapshotDirsIncludedKey = NewOnceKey("RecoverySnapshotDirsIncludedMap")
1834
1835func (c *deviceConfig) RecoverySnapshotDirsIncludedMap() map[string]bool {
1836 excludedMap := c.RecoverySnapshotDirsExcludedMap()
1837 return c.createDirsMapOnce(recoverySnapshotDirsIncludedKey, excludedMap,
1838 c.config.productVariables.RecoverySnapshotDirsIncluded)
1839}
1840
Rob Seymour925aa092021-08-10 20:42:03 +00001841func (c *deviceConfig) HostFakeSnapshotEnabled() bool {
1842 return c.config.productVariables.HostFakeSnapshotEnabled
1843}
1844
Inseob Kim60c32f02020-12-21 22:53:05 +09001845func (c *deviceConfig) ShippingApiLevel() ApiLevel {
Steven Morelanda48df2b2024-06-03 22:29:38 +00001846 if c.config.productVariables.Shipping_api_level == nil {
Inseob Kim60c32f02020-12-21 22:53:05 +09001847 return NoneApiLevel
1848 }
Steven Morelanda48df2b2024-06-03 22:29:38 +00001849 apiLevel, _ := strconv.Atoi(*c.config.productVariables.Shipping_api_level)
Inseob Kim60c32f02020-12-21 22:53:05 +09001850 return uncheckedFinalApiLevel(apiLevel)
1851}
1852
Liz Kammer33cc80e2023-05-18 18:20:28 +00001853func (c *deviceConfig) BuildBrokenPluginValidation() []string {
1854 return c.config.productVariables.BuildBrokenPluginValidation
1855}
1856
Alix Espinoef47e542022-09-14 19:10:51 +00001857func (c *deviceConfig) BuildBrokenClangAsFlags() bool {
1858 return c.config.productVariables.BuildBrokenClangAsFlags
1859}
1860
1861func (c *deviceConfig) BuildBrokenClangCFlags() bool {
1862 return c.config.productVariables.BuildBrokenClangCFlags
1863}
1864
Alixb5f6d9e2022-04-20 23:00:58 +00001865func (c *deviceConfig) BuildBrokenClangProperty() bool {
1866 return c.config.productVariables.BuildBrokenClangProperty
1867}
1868
Inseob Kim67e5add192021-03-17 18:05:33 +09001869func (c *deviceConfig) BuildBrokenEnforceSyspropOwner() bool {
1870 return c.config.productVariables.BuildBrokenEnforceSyspropOwner
1871}
1872
1873func (c *deviceConfig) BuildBrokenTrebleSyspropNeverallow() bool {
1874 return c.config.productVariables.BuildBrokenTrebleSyspropNeverallow
1875}
1876
Cole Faustedc4c502022-09-09 19:39:25 -07001877func (c *deviceConfig) BuildBrokenUsesSoongPython2Modules() bool {
1878 return c.config.productVariables.BuildBrokenUsesSoongPython2Modules
1879}
1880
Hridya Valsaraju5a5c7d52021-04-02 16:45:24 -07001881func (c *deviceConfig) BuildDebugfsRestrictionsEnabled() bool {
1882 return c.config.productVariables.BuildDebugfsRestrictionsEnabled
1883}
1884
Inseob Kim0cac7b42021-02-03 18:16:46 +09001885func (c *deviceConfig) BuildBrokenVendorPropertyNamespace() bool {
1886 return c.config.productVariables.BuildBrokenVendorPropertyNamespace
1887}
1888
Liz Kammer619be462022-01-28 15:13:39 -05001889func (c *deviceConfig) BuildBrokenInputDir(name string) bool {
1890 return InList(name, c.config.productVariables.BuildBrokenInputDirModules)
1891}
1892
Jiyong Park3bb99242024-01-04 23:21:26 +00001893func (c *deviceConfig) BuildBrokenDontCheckSystemSdk() bool {
1894 return c.config.productVariables.BuildBrokenDontCheckSystemSdk
1895}
1896
Inseob Kimbac07552024-06-18 11:09:12 +09001897func (c *deviceConfig) BuildBrokenDupSysprop() bool {
1898 return c.config.productVariables.BuildBrokenDupSysprop
1899}
1900
Jiakai Zhang48203e32023-06-02 23:42:21 +01001901func (c *config) BuildWarningBadOptionalUsesLibsAllowlist() []string {
1902 return c.productVariables.BuildWarningBadOptionalUsesLibsAllowlist
1903}
1904
Yu Liu6a7940c2023-05-09 17:12:22 -07001905func (c *deviceConfig) GenruleSandboxing() bool {
1906 return Bool(c.config.productVariables.GenruleSandboxing)
Vinh Tran140d5882022-06-10 14:23:27 -04001907}
1908
Inseob Kim67e5add192021-03-17 18:05:33 +09001909func (c *deviceConfig) RequiresInsecureExecmemForSwiftshader() bool {
1910 return c.config.productVariables.RequiresInsecureExecmemForSwiftshader
1911}
1912
Devin Moorec381e102023-07-06 22:03:58 +00001913func (c *deviceConfig) Release_aidl_use_unfrozen() bool {
1914 return Bool(c.config.productVariables.Release_aidl_use_unfrozen)
1915}
1916
Inseob Kim67e5add192021-03-17 18:05:33 +09001917func (c *config) SelinuxIgnoreNeverallows() bool {
1918 return c.productVariables.SelinuxIgnoreNeverallows
1919}
1920
Inseob Kima10ef272021-09-15 03:04:53 +00001921func (c *deviceConfig) SepolicyFreezeTestExtraDirs() []string {
1922 return c.config.productVariables.SepolicyFreezeTestExtraDirs
1923}
1924
1925func (c *deviceConfig) SepolicyFreezeTestExtraPrebuiltDirs() []string {
1926 return c.config.productVariables.SepolicyFreezeTestExtraPrebuiltDirs
1927}
1928
Jiyong Parkd163d4d2021-10-12 16:47:43 +09001929func (c *deviceConfig) GenerateAidlNdkPlatformBackend() bool {
1930 return c.config.productVariables.GenerateAidlNdkPlatformBackend
1931}
1932
Yu Liu67a28422024-03-05 00:36:31 +00001933func (c *deviceConfig) AconfigContainerValidation() string {
1934 return c.config.productVariables.AconfigContainerValidation
1935}
1936
Christopher Ferris98f10222022-07-13 23:16:52 -07001937func (c *config) IgnorePrefer32OnDevice() bool {
1938 return c.productVariables.IgnorePrefer32OnDevice
1939}
1940
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001941func (c *config) BootJars() []string {
1942 return c.Once(earlyBootJarsKey, func() interface{} {
Paul Duffin69d1fb12020-10-23 21:14:20 +01001943 list := c.productVariables.BootJars.CopyOfJars()
satayevd604b212021-07-21 14:23:52 +01001944 return append(list, c.productVariables.ApexBootJars.CopyOfJars()...)
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001945 }).([]string)
1946}
Paul Duffin9a89a2a2020-10-28 19:20:06 +00001947
satayevd604b212021-07-21 14:23:52 +01001948func (c *config) NonApexBootJars() ConfiguredJarList {
Paul Duffin9a89a2a2020-10-28 19:20:06 +00001949 return c.productVariables.BootJars
1950}
1951
satayevd604b212021-07-21 14:23:52 +01001952func (c *config) ApexBootJars() ConfiguredJarList {
1953 return c.productVariables.ApexBootJars
Paul Duffin9a89a2a2020-10-28 19:20:06 +00001954}
Colin Cross77cdcfd2021-03-12 11:28:25 -08001955
1956func (c *config) RBEWrapper() string {
1957 return c.GetenvWithDefault("RBE_WRAPPER", remoteexec.DefaultWrapperPath)
1958}
Colin Cross9b698b62021-12-22 09:55:32 -08001959
1960// UseHostMusl returns true if the host target has been configured to build against musl libc.
1961func (c *config) UseHostMusl() bool {
1962 return Bool(c.productVariables.HostMusl)
1963}
MarkDacekff851b82022-04-21 18:33:17 +00001964
Spandan Das9e93d3d2023-03-08 05:47:29 +00001965// ApiSurfaces directory returns the source path inside the api_surfaces repo
1966// (relative to workspace root).
1967func (c *config) ApiSurfacesDir(s ApiSurface, version string) string {
1968 return filepath.Join(
1969 "build",
1970 "bazel",
1971 "api_surfaces",
1972 s.String(),
1973 version)
1974}
Jihoon Kang1bff0342023-01-17 20:40:22 +00001975
Jihoon Kang1975d3e2023-10-16 23:24:11 +00001976func (c *config) JavaCoverageEnabled() bool {
1977 return c.IsEnvTrue("EMMA_INSTRUMENT") || c.IsEnvTrue("EMMA_INSTRUMENT_STATIC") || c.IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK")
1978}
1979
Jihoon Kangc1b04d62023-11-16 19:07:04 +00001980func (c *deviceConfig) BuildFromSourceStub() bool {
1981 return Bool(c.config.productVariables.BuildFromSourceStub)
1982}
1983
Jihoon Kang1bff0342023-01-17 20:40:22 +00001984func (c *config) BuildFromTextStub() bool {
Jihoon Kang1975d3e2023-10-16 23:24:11 +00001985 // TODO: b/302320354 - Remove the coverage build specific logic once the
1986 // robust solution for handling native properties in from-text stub build
1987 // is implemented.
Jihoon Kangc1b04d62023-11-16 19:07:04 +00001988 return !c.buildFromSourceStub &&
1989 !c.JavaCoverageEnabled() &&
1990 !c.deviceConfig.BuildFromSourceStub()
Jihoon Kang1bff0342023-01-17 20:40:22 +00001991}
Spandan Das4deab282023-03-30 17:06:32 +00001992
1993func (c *config) SetBuildFromTextStub(b bool) {
Jihoon Kang2a929ad2023-06-08 19:02:07 +00001994 c.buildFromSourceStub = !b
Jihoon Kangcbcad7c2023-06-01 22:31:52 +00001995 c.productVariables.Build_from_text_stub = boolPtr(b)
Spandan Das4deab282023-03-30 17:06:32 +00001996}
Jihoon Kang1c92c3e2023-03-23 17:44:51 +00001997
Jihoon Kang1c92c3e2023-03-23 17:44:51 +00001998func (c *config) SetApiLibraries(libs []string) {
1999 c.apiLibraries = make(map[string]struct{})
2000 for _, lib := range libs {
2001 c.apiLibraries[lib] = struct{}{}
2002 }
2003}
2004
2005func (c *config) GetApiLibraries() map[string]struct{} {
2006 return c.apiLibraries
2007}
Inseob Kim5bac3b62023-08-25 21:29:46 +09002008
2009func (c *deviceConfig) CheckVendorSeappViolations() bool {
2010 return Bool(c.config.productVariables.CheckVendorSeappViolations)
2011}
Jihoon Kangcfbc4072023-09-20 01:02:18 +00002012
Inseob Kime4e85d52023-10-25 23:53:58 +09002013func (c *config) GetBuildFlag(name string) (string, bool) {
2014 val, ok := c.productVariables.BuildFlags[name]
2015 return val, ok
2016}
Spandan Dase3fcb412023-10-26 20:48:02 +00002017
Colin Cross8f1b0332024-01-25 13:39:06 -08002018func (c *config) UseResourceProcessorByDefault() bool {
2019 return c.productVariables.GetBuildFlagBool("RELEASE_USE_RESOURCE_PROCESSOR_BY_DEFAULT")
2020}
2021
Spandan Dase3fcb412023-10-26 20:48:02 +00002022var (
Spandan Das56866c52024-08-01 00:51:20 +00002023 mainlineApexContributionBuildFlagsToApexNames = map[string]string{
2024 "RELEASE_APEX_CONTRIBUTIONS_ADBD": "com.android.adbd",
2025 "RELEASE_APEX_CONTRIBUTIONS_ADSERVICES": "com.android.adservices",
2026 "RELEASE_APEX_CONTRIBUTIONS_APPSEARCH": "com.android.appsearch",
2027 "RELEASE_APEX_CONTRIBUTIONS_ART": "com.android.art",
2028 "RELEASE_APEX_CONTRIBUTIONS_BLUETOOTH": "com.android.btservices",
2029 "RELEASE_APEX_CONTRIBUTIONS_CAPTIVEPORTALLOGIN": "",
2030 "RELEASE_APEX_CONTRIBUTIONS_CELLBROADCAST": "com.android.cellbroadcast",
2031 "RELEASE_APEX_CONTRIBUTIONS_CONFIGINFRASTRUCTURE": "com.android.configinfrastructure",
2032 "RELEASE_APEX_CONTRIBUTIONS_CONNECTIVITY": "com.android.tethering",
2033 "RELEASE_APEX_CONTRIBUTIONS_CONSCRYPT": "com.android.conscrypt",
2034 "RELEASE_APEX_CONTRIBUTIONS_CRASHRECOVERY": "",
2035 "RELEASE_APEX_CONTRIBUTIONS_DEVICELOCK": "com.android.devicelock",
2036 "RELEASE_APEX_CONTRIBUTIONS_DOCUMENTSUIGOOGLE": "",
2037 "RELEASE_APEX_CONTRIBUTIONS_EXTSERVICES": "com.android.extservices",
2038 "RELEASE_APEX_CONTRIBUTIONS_HEALTHFITNESS": "com.android.healthfitness",
2039 "RELEASE_APEX_CONTRIBUTIONS_IPSEC": "com.android.ipsec",
2040 "RELEASE_APEX_CONTRIBUTIONS_MEDIA": "com.android.media",
2041 "RELEASE_APEX_CONTRIBUTIONS_MEDIAPROVIDER": "com.android.mediaprovider",
2042 "RELEASE_APEX_CONTRIBUTIONS_MODULE_METADATA": "",
2043 "RELEASE_APEX_CONTRIBUTIONS_NETWORKSTACKGOOGLE": "",
2044 "RELEASE_APEX_CONTRIBUTIONS_NEURALNETWORKS": "com.android.neuralnetworks",
2045 "RELEASE_APEX_CONTRIBUTIONS_ONDEVICEPERSONALIZATION": "com.android.ondevicepersonalization",
2046 "RELEASE_APEX_CONTRIBUTIONS_PERMISSION": "com.android.permission",
2047 "RELEASE_APEX_CONTRIBUTIONS_PRIMARY_LIBS": "",
2048 "RELEASE_APEX_CONTRIBUTIONS_REMOTEKEYPROVISIONING": "com.android.rkpd",
2049 "RELEASE_APEX_CONTRIBUTIONS_RESOLV": "com.android.resolv",
2050 "RELEASE_APEX_CONTRIBUTIONS_SCHEDULING": "com.android.scheduling",
2051 "RELEASE_APEX_CONTRIBUTIONS_SDKEXTENSIONS": "com.android.sdkext",
2052 "RELEASE_APEX_CONTRIBUTIONS_SWCODEC": "com.android.media.swcodec",
2053 "RELEASE_APEX_CONTRIBUTIONS_STATSD": "com.android.os.statsd",
2054 "RELEASE_APEX_CONTRIBUTIONS_TELEMETRY_TVP": "",
2055 "RELEASE_APEX_CONTRIBUTIONS_TZDATA": "com.android.tzdata",
2056 "RELEASE_APEX_CONTRIBUTIONS_UWB": "com.android.uwb",
2057 "RELEASE_APEX_CONTRIBUTIONS_WIFI": "com.android.wifi",
Spandan Dase3fcb412023-10-26 20:48:02 +00002058 }
2059)
2060
2061// Returns the list of _selected_ apex_contributions
2062// Each mainline module will have one entry in the list
2063func (c *config) AllApexContributions() []string {
2064 ret := []string{}
Spandan Das56866c52024-08-01 00:51:20 +00002065 for _, f := range SortedKeys(mainlineApexContributionBuildFlagsToApexNames) {
Spandan Dase3fcb412023-10-26 20:48:02 +00002066 if val, exists := c.GetBuildFlag(f); exists && val != "" {
2067 ret = append(ret, val)
2068 }
2069 }
2070 return ret
2071}
Spandan Das8ab28dd2024-02-17 03:31:45 +00002072
Spandan Das56866c52024-08-01 00:51:20 +00002073func (c *config) AllMainlineApexNames() []string {
2074 return SortedStringValues(mainlineApexContributionBuildFlagsToApexNames)
2075}
2076
Spandan Das4017d702024-03-08 04:20:15 +00002077func (c *config) BuildIgnoreApexContributionContents() *bool {
Spandan Das8ab28dd2024-02-17 03:31:45 +00002078 return c.productVariables.BuildIgnoreApexContributionContents
2079}
Inseob Kim8fa54da2024-03-19 16:48:59 +09002080
2081func (c *config) ProductLocales() []string {
2082 return c.productVariables.ProductLocales
2083}
2084
2085func (c *config) ProductDefaultWifiChannels() []string {
2086 return c.productVariables.ProductDefaultWifiChannels
2087}
2088
2089func (c *config) BoardUseVbmetaDigestInFingerprint() bool {
2090 return Bool(c.productVariables.BoardUseVbmetaDigestInFingerprint)
2091}
2092
2093func (c *config) OemProperties() []string {
2094 return c.productVariables.OemProperties
2095}
Kiyoung Kim9f2f0e72024-07-08 11:02:23 +09002096
2097func (c *config) UseDebugArt() bool {
2098 if c.productVariables.ArtTargetIncludeDebugBuild != nil {
2099 return Bool(c.productVariables.ArtTargetIncludeDebugBuild)
2100 }
2101
2102 return Bool(c.productVariables.Eng)
2103}