blob: acaad60ad9229a1dd2e6e33a7a1dee0ae1ac9203 [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
Cole Faustc5bfbdd2025-01-08 13:05:40 -080086 KatiSuffix string
Sasha Smundakaf5ca922022-12-12 21:23:34 -080087
Colin Crossb63d7b32023-12-07 16:54:51 -080088 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 // Create a JSON representation of the module graph and exit.
103 GenerateModuleGraph
104
105 // Generate a documentation file for module type definitions and exit.
106 GenerateDocFile
Chris Parsonsad876012022-08-20 14:48:32 -0400107)
108
Inseob Kim8fa54da2024-03-19 16:48:59 +0900109const testKeyDir = "build/make/target/product/security"
110
Lukacs T. Berkib078ade2021-08-31 10:42:08 +0200111// SoongOutDir returns the build output directory for the configuration.
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200112func (c Config) SoongOutDir() string {
113 return c.soongOutDir
Jeff Gastonefc1b412017-03-29 17:29:06 -0700114}
115
Colin Cross31a67452023-11-02 16:57:08 -0700116// tempDir returns the path to out/soong/.temp, which is cleared at the beginning of every build.
117func (c Config) tempDir() string {
118 return shared.TempDirForOutDir(c.soongOutDir)
119}
120
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200121func (c Config) OutDir() string {
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200122 return c.outDir
Lukacs T. Berki89e9a162021-03-12 08:31:32 +0100123}
124
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200125func (c Config) RunGoTests() bool {
126 return c.runGoTests
127}
128
Lukacs T. Berki5f6cb1d2021-03-17 15:03:14 +0100129func (c Config) DebugCompilation() bool {
130 return false // Never compile Go code in the main build for debugging
131}
132
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200133func (c Config) Subninjas() []string {
134 return []string{}
135}
136
137func (c Config) PrimaryBuilderInvocations() []bootstrap.PrimaryBuilderInvocation {
138 return []bootstrap.PrimaryBuilderInvocation{}
139}
140
Paul Duffin74135582022-10-06 11:01:59 +0100141// RunningInsideUnitTest returns true if this code is being run as part of a Soong unit test.
142func (c Config) RunningInsideUnitTest() bool {
143 return c.config.TestProductVariables != nil
144}
145
Pratyushfaec4db2023-07-20 11:19:04 +0000146// DisableHiddenApiChecks returns true if hiddenapi checks have been disabled.
Alyssa Ketpreechasawat7daf2782023-11-01 13:58:39 +0000147// For 'eng' target variant hiddenapi checks are disabled by default for performance optimisation,
Pratyushfaec4db2023-07-20 11:19:04 +0000148// but can be enabled by setting environment variable ENABLE_HIDDENAPI_FLAGS=true.
149// For other target variants hiddenapi check are enabled by default but can be disabled by
150// setting environment variable UNSAFE_DISABLE_HIDDENAPI_FLAGS=true.
151// If both ENABLE_HIDDENAPI_FLAGS=true and UNSAFE_DISABLE_HIDDENAPI_FLAGS=true, then
152// ENABLE_HIDDENAPI_FLAGS=true will be triggered and hiddenapi checks will be considered enabled.
153func (c Config) DisableHiddenApiChecks() bool {
154 return !c.IsEnvTrue("ENABLE_HIDDENAPI_FLAGS") &&
155 (c.IsEnvTrue("UNSAFE_DISABLE_HIDDENAPI_FLAGS") ||
Alyssa Ketpreechasawat7daf2782023-11-01 13:58:39 +0000156 Bool(c.productVariables.Eng))
157}
158
159// DisableVerifyOverlaps returns true if verify_overlaps is skipped.
160// Mismatch in version of apexes and module SDK is required for mainline prebuilts to work in
161// trunk stable.
162// Thus, verify_overlaps is disabled when RELEASE_DEFAULT_MODULE_BUILD_FROM_SOURCE is set to false.
163// TODO(b/308174018): Re-enable verify_overlaps for both builr from source/mainline prebuilts.
164func (c Config) DisableVerifyOverlaps() bool {
Spandan Das07145102024-03-18 23:25:30 +0000165 if c.IsEnvFalse("DISABLE_VERIFY_OVERLAPS") && c.ReleaseDisableVerifyOverlaps() {
166 panic("The current release configuration does not support verify_overlaps. DISABLE_VERIFY_OVERLAPS cannot be set to false")
167 }
168 return c.IsEnvTrue("DISABLE_VERIFY_OVERLAPS") || c.ReleaseDisableVerifyOverlaps() || !c.ReleaseDefaultModuleBuildFromSource()
Pratyushfaec4db2023-07-20 11:19:04 +0000169}
170
Qing Shen713c5422024-08-23 04:09:18 +0000171func (c Config) CoverageSuffix() string {
172 if v := c.IsEnvTrue("EMMA_INSTRUMENT"); v {
173 return "coverage."
174 }
175 return ""
176}
177
Juan Yescas05d4d902023-04-07 10:35:35 -0700178// MaxPageSizeSupported returns the max page size supported by the device. This
179// value will define the ELF segment alignment for binaries (executables and
180// shared libraries).
181func (c Config) MaxPageSizeSupported() string {
182 return String(c.config.productVariables.DeviceMaxPageSizeSupported)
183}
184
Vilas Bhatb3d2d222023-12-04 22:51:20 +0000185// NoBionicPageSizeMacro returns true when AOSP is page size agnostic.
186// This means that the bionic's macro PAGE_SIZE won't be defined.
187// Returns false when AOSP is NOT page size agnostic.
188// This means that bionic's macro PAGE_SIZE is defined.
189func (c Config) NoBionicPageSizeMacro() bool {
190 return Bool(c.config.productVariables.DeviceNoBionicPageSizeMacro)
Juan Yescas01065602023-08-09 08:34:37 -0700191}
192
Joe Onoratofee845a2023-05-09 08:14:14 -0700193// The release version passed to aconfig, derived from RELEASE_VERSION
194func (c Config) ReleaseVersion() string {
195 return c.config.productVariables.ReleaseVersion
196}
197
Yu Liu2cc802a2023-09-05 17:19:45 -0700198// The aconfig value set passed to aconfig, derived from RELEASE_VERSION
Yu Liueebb2592023-10-12 20:31:27 -0700199func (c Config) ReleaseAconfigValueSets() []string {
Yu Liu95572ff2023-12-07 16:38:45 -0800200 return c.config.productVariables.ReleaseAconfigValueSets
Joe Onoratofee845a2023-05-09 08:14:14 -0700201}
202
LaMont Jones21d04d92024-06-11 11:28:54 -0700203func (c Config) ReleaseAconfigExtraReleaseConfigs() []string {
204 result := []string{}
205 if val, ok := c.config.productVariables.BuildFlags["RELEASE_ACONFIG_EXTRA_RELEASE_CONFIGS"]; ok {
206 if len(val) > 0 {
207 // Remove any duplicates from the list.
208 found := make(map[string]bool)
209 for _, k := range strings.Split(val, " ") {
210 if !found[k] {
211 found[k] = true
212 result = append(result, k)
213 }
214 }
215 }
216 }
217 return result
218}
219
220func (c Config) ReleaseAconfigExtraReleaseConfigsValueSets() map[string][]string {
221 result := make(map[string][]string)
222 for _, rcName := range c.ReleaseAconfigExtraReleaseConfigs() {
223 if value, ok := c.config.productVariables.BuildFlags["RELEASE_ACONFIG_VALUE_SETS_"+rcName]; ok {
224 result[rcName] = strings.Split(value, " ")
225 }
226 }
227 return result
228}
229
Zhi Dou3f65a412023-08-10 21:47:40 +0000230// The flag default permission value passed to aconfig
231// derived from RELEASE_ACONFIG_FLAG_DEFAULT_PERMISSION
232func (c Config) ReleaseAconfigFlagDefaultPermission() string {
233 return c.config.productVariables.ReleaseAconfigFlagDefaultPermission
234}
235
Yi Kong76e99ad2024-09-18 18:43:26 +0000236// Enable object size sanitizer
237func (c Config) ReleaseBuildObjectSizeSanitizer() bool {
238 return c.config.productVariables.GetBuildFlagBool("RELEASE_BUILD_OBJECT_SIZE_SANITIZER")
239}
240
Alyssa Ketpreechasawat34ab8792023-10-06 07:01:22 +0000241// The flag indicating behavior for the tree wrt building modules or using prebuilts
242// derived from RELEASE_DEFAULT_MODULE_BUILD_FROM_SOURCE
243func (c Config) ReleaseDefaultModuleBuildFromSource() bool {
244 return c.config.productVariables.ReleaseDefaultModuleBuildFromSource == nil ||
245 Bool(c.config.productVariables.ReleaseDefaultModuleBuildFromSource)
246}
247
Alyssa Ketpreechasawat3a6eced2024-08-22 15:09:16 +0000248func (c Config) ReleaseDefaultUpdatableModuleVersion() string {
249 if val, exists := c.GetBuildFlag("RELEASE_DEFAULT_UPDATABLE_MODULE_VERSION"); exists {
250 return val
251 }
252 panic("RELEASE_DEFAULT_UPDATABLE_MODULE_VERSION is missing from build flags.")
253}
254
Spandan Das07145102024-03-18 23:25:30 +0000255func (c Config) ReleaseDisableVerifyOverlaps() bool {
256 return c.config.productVariables.GetBuildFlagBool("RELEASE_DISABLE_VERIFY_OVERLAPS_CHECK")
257}
258
Jihoon Kang59198152024-02-06 22:43:18 +0000259// Enables flagged apis annotated with READ_WRITE aconfig flags to be included in the stubs
260// and hiddenapi flags so that they are accessible at runtime
261func (c Config) ReleaseExportRuntimeApis() bool {
Jihoon Kang35349462024-02-22 19:52:46 +0000262 return Bool(c.config.productVariables.ExportRuntimeApis)
Jihoon Kang59198152024-02-06 22:43:18 +0000263}
264
Aleksei Vetrov146e9822023-11-24 19:54:26 +0000265// Enables ABI monitoring of NDK libraries
266func (c Config) ReleaseNdkAbiMonitored() bool {
267 return c.config.productVariables.GetBuildFlagBool("RELEASE_NDK_ABI_MONITORED")
268}
269
Ted Bauer10fff942024-04-29 19:30:23 +0000270// Enable read flag from new storage, for C/C++
271func (c Config) ReleaseReadFromNewStorageCc() bool {
272 return c.config.productVariables.GetBuildFlagBool("RELEASE_READ_FROM_NEW_STORAGE_CC")
273}
274
Jihoon Kangbd093452023-12-26 19:08:01 +0000275func (c Config) ReleaseHiddenApiExportableStubs() bool {
Jihoon Kangb36fc542024-02-22 19:35:26 +0000276 return c.config.productVariables.GetBuildFlagBool("RELEASE_HIDDEN_API_EXPORTABLE_STUBS") ||
277 Bool(c.config.productVariables.HiddenapiExportableStubs)
Jihoon Kangbd093452023-12-26 19:08:01 +0000278}
279
Dennis Shen58378c92024-04-03 19:26:36 +0000280// Enable read flag from new storage
281func (c Config) ReleaseReadFromNewStorage() bool {
282 return c.config.productVariables.GetBuildFlagBool("RELEASE_READ_FROM_NEW_STORAGE")
283}
284
Spandan Das3d9b69e2024-10-07 19:03:45 +0000285func (c Config) ReleaseCreateAconfigStorageFile() bool {
286 return c.config.productVariables.GetBuildFlagBool("RELEASE_CREATE_ACONFIG_STORAGE_FILE")
287}
288
Jared Dukeeacbdfc2024-11-13 00:43:59 +0000289func (c Config) ReleaseUseSystemFeatureBuildFlags() bool {
290 return c.config.productVariables.GetBuildFlagBool("RELEASE_USE_SYSTEM_FEATURE_BUILD_FLAGS")
291}
292
Marybeth Fairc8c74d62024-12-04 14:22:40 -0500293func (c Config) ReleaseFingerprintAconfigPackages() bool {
294 return c.config.productVariables.GetBuildFlagBool("RELEASE_FINGERPRINT_ACONFIG_PACKAGES")
295}
296
Marybeth Fair51684702025-01-21 16:25:33 -0500297func (c Config) ReleaseAconfigCheckApiLevel() bool {
298 return c.config.productVariables.GetBuildFlagBool("RELEASE_ACONFIG_CHECK_API_LEVEL")
299}
300
Jingwen Chenc711fec2020-11-22 23:52:50 -0500301// A DeviceConfig object represents the configuration for a particular device
302// being built. For now there will only be one of these, but in the future there
303// may be multiple devices being built.
Colin Cross9272ade2016-08-17 15:24:12 -0700304type DeviceConfig struct {
305 *deviceConfig
306}
307
Jingwen Chenc711fec2020-11-22 23:52:50 -0500308// VendorConfig represents the configuration for vendor-specific behavior.
Colin Cross9d34f352019-11-22 16:03:51 -0800309type VendorConfig soongconfig.SoongConfig
Dan Willemsen0fe78662018-03-26 12:41:18 -0700310
Jingwen Chenc711fec2020-11-22 23:52:50 -0500311// Definition of general build configuration for soong_build. Some of these
Jingwen Chenc4d91bc2020-11-24 22:59:26 -0500312// product configuration values are read from Kati-generated soong.variables.
Colin Cross1332b002015-04-07 17:11:30 -0700313type config struct {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500314 // Options configurable with soong.variables
Cole Faustf8231dd2023-04-21 17:37:11 -0700315 productVariables ProductVariables
Colin Cross3f40fa42015-01-30 17:27:36 -0800316
Dan Willemsen674dc7f2018-03-12 18:06:05 -0700317 // Only available on configs created by TestConfig
Cole Faustf8231dd2023-04-21 17:37:11 -0700318 TestProductVariables *ProductVariables
Dan Willemsen674dc7f2018-03-12 18:06:05 -0700319
Dan Willemsen87b17d12015-07-14 00:39:06 -0700320 ProductVariablesFileName string
321
Colin Cross0c66bc62021-07-20 09:47:41 -0700322 // BuildOS stores the OsType for the OS that the build is running on.
323 BuildOS OsType
324
325 // BuildArch stores the ArchType for the CPU that the build is running on.
326 BuildArch ArchType
327
Jaewoong Jung642916f2020-10-09 17:25:15 -0700328 Targets map[OsType][]Target
329 BuildOSTarget Target // the Target for tools run on the build machine
330 BuildOSCommonTarget Target // the Target for common (java) tools run on the build machine
331 AndroidCommonTarget Target // the Target for common modules for the Android device
332 AndroidFirstDeviceTarget Target // the first Target for modules for the Android device
Dan Willemsen218f6562015-07-08 18:13:11 -0700333
LaMont Jones99f18962024-10-17 11:50:44 -0700334 // Flags for Partial Compile, derived from SOONG_PARTIAL_COMPILE.
335 partialCompileFlags partialCompileFlags
336
Jingwen Chenc711fec2020-11-22 23:52:50 -0500337 // multilibConflicts for an ArchType is true if there is earlier configured
338 // device architecture with the same multilib value.
Colin Cross3b19f5d2019-09-17 14:45:31 -0700339 multilibConflicts map[ArchType]bool
340
Colin Cross9272ade2016-08-17 15:24:12 -0700341 deviceConfig *deviceConfig
342
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200343 outDir string // The output directory (usually out/)
344 soongOutDir string
Chris Parsons8f232a22020-06-23 17:37:05 -0400345 moduleListFile string // the path to the file which lists blueprint files to parse.
Colin Crossc1e86a32015-04-15 12:33:28 -0700346
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +0200347 runGoTests bool
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200348
Colin Cross6ccbc912017-10-10 23:07:38 -0700349 env map[string]string
Dan Willemsene7680ba2015-09-11 17:06:19 -0700350 envLock sync.Mutex
351 envDeps map[string]string
352 envFrozen bool
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800353
Jingwen Chencda22c92020-11-23 00:22:30 -0500354 // Changes behavior based on whether Kati runs after soong_build, or if soong_build
355 // runs standalone.
356 katiEnabled bool
Cole Faustc5bfbdd2025-01-08 13:05:40 -0800357 katiSuffix string
Colin Cross1e7d3702016-08-24 15:25:47 -0700358
Colin Cross32616ed2017-09-05 21:56:44 -0700359 captureBuild bool // true for tests, saves build parameters for each module
360 ignoreEnvironment bool // true for tests, returns empty from all Getenv calls
Colin Crosscec81712017-07-13 14:43:27 -0700361
Colin Cross98be1bb2019-12-13 20:41:13 -0800362 fs pathtools.FileSystem
363 mockBpList string
364
Colin Crossb63d7b32023-12-07 16:54:51 -0800365 BuildMode SoongBuildMode
Jingwen Chen12b4c272021-03-10 02:05:59 -0500366
Colin Cross5e6a7972020-06-07 16:56:32 -0700367 // If testAllowNonExistentPaths is true then PathForSource and PathForModuleSrc won't error
368 // in tests when a path doesn't exist.
Pedro Loureiro5d190cc2021-02-15 15:41:33 +0000369 TestAllowNonExistentPaths bool
Colin Cross5e6a7972020-06-07 16:56:32 -0700370
Jingwen Chenc711fec2020-11-22 23:52:50 -0500371 // The list of files that when changed, must invalidate soong_build to
372 // regenerate build.ninja.
Colin Cross12129292020-10-29 18:23:58 -0700373 ninjaFileDepsSet sync.Map
374
Colin Cross9272ade2016-08-17 15:24:12 -0700375 OncePer
MarkDacekff851b82022-04-21 18:33:17 +0000376
Jihoon Kang2a929ad2023-06-08 19:02:07 +0000377 // If buildFromSourceStub is true then the Java API stubs are
378 // built from the source Java files, not the signature text files.
379 buildFromSourceStub bool
MarkDacekf47e1422023-04-19 16:47:36 +0000380
381 // If ensureAllowlistIntegrity is true, then the presence of any allowlisted
382 // modules that aren't mixed-built for at least one variant will cause a build
383 // failure
384 ensureAllowlistIntegrity bool
Colin Cross9272ade2016-08-17 15:24:12 -0700385}
386
LaMont Jones99f18962024-10-17 11:50:44 -0700387type partialCompileFlags struct {
388 // Is partial compilation enabled at all?
LaMont Jones6d8fc102025-02-10 16:23:24 -0800389 Enabled bool
LaMont Jones99f18962024-10-17 11:50:44 -0700390
391 // Whether to use d8 instead of r8
LaMont Jones6d8fc102025-02-10 16:23:24 -0800392 Use_d8 bool
LaMont Jones99f18962024-10-17 11:50:44 -0700393
394 // Add others as needed.
395}
396
Colin Cross9272ade2016-08-17 15:24:12 -0700397type deviceConfig struct {
Dan Willemsen00269f22017-07-06 16:59:48 -0700398 config *config
Colin Cross9272ade2016-08-17 15:24:12 -0700399 OncePer
Colin Cross3f40fa42015-01-30 17:27:36 -0800400}
401
Colin Cross485e5722015-08-27 13:28:01 -0700402type jsonConfigurable interface {
Colin Cross27385972015-09-18 10:57:10 -0700403 SetDefaultConfig()
Colin Cross485e5722015-08-27 13:28:01 -0700404}
Colin Cross3f40fa42015-01-30 17:27:36 -0800405
LaMont Jones99f18962024-10-17 11:50:44 -0700406// Parse SOONG_PARTIAL_COMPILE.
407//
408// SOONG_PARTIAL_COMPILE determines which features are enabled or disabled in
409// rule generation. Changing this environment variable causes reanalysis.
410//
411// SOONG_USE_PARTIAL_COMPILE determines whether or not we **use** PARTIAL_COMPILE.
412// Rule generation must support both cases, since changing it does not cause
413// reanalysis.
414//
415// The user-facing documentation shows:
416//
417// - empty or not set: "The current default state"
418// - "true" or "on": enable all stable partial compile features.
419// - "false" or "off": disable partial compile completely.
420//
421// What we actually allow is a comma separated list of tokens, whose first
422// character may be "+" (enable) or "-" (disable). If neither is present, "+"
423// is assumed. For example, "on,+use_d8" will enable partial compilation, and
424// additionally set the use_d8 flag (regardless of whether it is opt-in or
425// opt-out).
426//
427// To add a new feature to the list, add the field in the struct
428// `partialCompileFlags` above, and then add the name of the field in the
429// switch statement below.
LaMont Jones66e65862024-10-30 10:43:17 -0700430var defaultPartialCompileFlags = partialCompileFlags{
431 // Set any opt-out flags here. Opt-in flags are off by default.
LaMont Jones6d8fc102025-02-10 16:23:24 -0800432 Enabled: false,
LaMont Jones66e65862024-10-30 10:43:17 -0700433}
434
435func (c *config) parsePartialCompileFlags(isEngBuild bool) (partialCompileFlags, error) {
436 if !isEngBuild {
437 return partialCompileFlags{}, nil
LaMont Jonesbef36af2024-10-30 01:03:28 +0000438 }
LaMont Jones99f18962024-10-17 11:50:44 -0700439 value := c.Getenv("SOONG_PARTIAL_COMPILE")
LaMont Jones99f18962024-10-17 11:50:44 -0700440 if value == "" {
LaMont Jones66e65862024-10-30 10:43:17 -0700441 return defaultPartialCompileFlags, nil
LaMont Jones99f18962024-10-17 11:50:44 -0700442 }
443
LaMont Jones66e65862024-10-30 10:43:17 -0700444 ret := defaultPartialCompileFlags
LaMont Jones99f18962024-10-17 11:50:44 -0700445 tokens := strings.Split(strings.ToLower(value), ",")
446 makeVal := func(state string, defaultValue bool) bool {
447 switch state {
448 case "":
449 return defaultValue
450 case "-":
451 return false
452 case "+":
453 return true
454 }
455 return false
456 }
457 for _, tok := range tokens {
458 var state string
459 if len(tok) == 0 {
460 continue
461 }
462 switch tok[0:1] {
463 case "":
464 // Ignore empty tokens.
465 continue
466 case "-", "+":
467 state = tok[0:1]
468 tok = tok[1:]
469 default:
470 // Treat `feature` as `+feature`.
471 state = "+"
472 }
473 switch tok {
474 case "true":
LaMont Jones66e65862024-10-30 10:43:17 -0700475 ret = defaultPartialCompileFlags
LaMont Jones6d8fc102025-02-10 16:23:24 -0800476 ret.Enabled = true
LaMont Jones99f18962024-10-17 11:50:44 -0700477 case "false":
478 // Set everything to false.
479 ret = partialCompileFlags{}
480 case "enabled":
LaMont Jones6d8fc102025-02-10 16:23:24 -0800481 ret.Enabled = makeVal(state, defaultPartialCompileFlags.Enabled)
LaMont Jones99f18962024-10-17 11:50:44 -0700482 case "use_d8":
LaMont Jones6d8fc102025-02-10 16:23:24 -0800483 ret.Use_d8 = makeVal(state, defaultPartialCompileFlags.Use_d8)
LaMont Jones99f18962024-10-17 11:50:44 -0700484 default:
LaMont Jones66e65862024-10-30 10:43:17 -0700485 return partialCompileFlags{}, fmt.Errorf("Unknown SOONG_PARTIAL_COMPILE value: %v", tok)
LaMont Jones99f18962024-10-17 11:50:44 -0700486 }
487 }
488 return ret, nil
489}
490
Colin Cross485e5722015-08-27 13:28:01 -0700491func loadConfig(config *config) error {
Colin Cross988414c2020-01-11 01:11:46 +0000492 return loadFromConfigFile(&config.productVariables, absolutePath(config.ProductVariablesFileName))
Colin Cross485e5722015-08-27 13:28:01 -0700493}
494
Cole Faustd92430e2024-02-07 01:02:04 +0000495// Checks if the string is a valid go identifier. This is equivalent to blueprint's definition
496// of an identifier, so it will match the same identifiers as those that can be used in bp files.
497func isGoIdentifier(ident string) bool {
498 for i, r := range ident {
499 valid := r == '_' || unicode.IsLetter(r) || unicode.IsDigit(r) && i > 0
500 if !valid {
501 return false
502 }
503 }
504 return len(ident) > 0
505}
506
Jingwen Chenc711fec2020-11-22 23:52:50 -0500507// loadFromConfigFile loads and decodes configuration options from a JSON file
508// in the current working directory.
Cole Faustf8231dd2023-04-21 17:37:11 -0700509func loadFromConfigFile(configurable *ProductVariables, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800510 // Try to open the file
Colin Cross485e5722015-08-27 13:28:01 -0700511 configFileReader, err := os.Open(filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800512 defer configFileReader.Close()
513 if os.IsNotExist(err) {
514 // Need to create a file, so that blueprint & ninja don't get in
515 // a dependency tracking loop.
516 // Make a file-configurable-options with defaults, write it out using
517 // a json writer.
Colin Cross27385972015-09-18 10:57:10 -0700518 configurable.SetDefaultConfig()
519 err = saveToConfigFile(configurable, filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800520 if err != nil {
521 return err
522 }
Colin Cross15cd21a2018-02-27 11:26:02 -0800523 } else if err != nil {
524 return fmt.Errorf("config file: could not open %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800525 } else {
526 // Make a decoder for it
527 jsonDecoder := json.NewDecoder(configFileReader)
Cole Fauste1129b82024-06-04 11:10:11 -0700528 jsonDecoder.DisallowUnknownFields()
Colin Cross485e5722015-08-27 13:28:01 -0700529 err = jsonDecoder.Decode(configurable)
Colin Cross3f40fa42015-01-30 17:27:36 -0800530 if err != nil {
Colin Cross15cd21a2018-02-27 11:26:02 -0800531 return fmt.Errorf("config file: %s did not parse correctly: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800532 }
533 }
534
Liz Kammer09f947d2021-05-12 14:51:49 -0400535 if Bool(configurable.GcovCoverage) && Bool(configurable.ClangCoverage) {
536 return fmt.Errorf("GcovCoverage and ClangCoverage cannot both be set")
537 }
538
539 configurable.Native_coverage = proptools.BoolPtr(
540 Bool(configurable.GcovCoverage) ||
541 Bool(configurable.ClangCoverage))
542
Cole Faustd92430e2024-02-07 01:02:04 +0000543 // The go scanner's definition of identifiers is c-style identifiers, but allowing unicode's
544 // definition of letters and digits. This is the same scanner that blueprint uses, so it
545 // will allow the same identifiers as are valid in bp files.
546 for namespace := range configurable.VendorVars {
547 if !isGoIdentifier(namespace) {
548 return fmt.Errorf("soong config namespaces must be valid identifiers: %q", namespace)
549 }
550 for variable := range configurable.VendorVars[namespace] {
551 if !isGoIdentifier(variable) {
552 return fmt.Errorf("soong config variables must be valid identifiers: %q", variable)
553 }
554 }
555 }
556
Yuntao Xu402e9b02021-08-09 15:44:44 -0700557 // when Platform_sdk_final is true (or PLATFORM_VERSION_CODENAME is REL), use Platform_sdk_version;
558 // if false (pre-released version, for example), use Platform_sdk_codename.
559 if Bool(configurable.Platform_sdk_final) {
560 if configurable.Platform_sdk_version != nil {
561 configurable.Platform_sdk_version_or_codename =
562 proptools.StringPtr(strconv.Itoa(*(configurable.Platform_sdk_version)))
563 } else {
564 return fmt.Errorf("Platform_sdk_version cannot be pointed by a NULL pointer")
565 }
566 } else {
567 configurable.Platform_sdk_version_or_codename =
568 proptools.StringPtr(String(configurable.Platform_sdk_codename))
569 }
570
Cole Faustad186492024-06-14 14:13:54 -0700571 return nil
Colin Cross3f40fa42015-01-30 17:27:36 -0800572}
573
Colin Crossd8f20142016-11-03 09:43:26 -0700574// atomically writes the config file in case two copies of soong_build are running simultaneously
575// (for example, docs generation and ninja manifest generation)
Cole Faustf8231dd2023-04-21 17:37:11 -0700576func saveToConfigFile(config *ProductVariables, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800577 data, err := json.MarshalIndent(&config, "", " ")
578 if err != nil {
579 return fmt.Errorf("cannot marshal config data: %s", err.Error())
580 }
581
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800582 f, err := os.CreateTemp(filepath.Dir(filename), "config")
Colin Cross3f40fa42015-01-30 17:27:36 -0800583 if err != nil {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500584 return fmt.Errorf("cannot create empty config file %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800585 }
Colin Crossd8f20142016-11-03 09:43:26 -0700586 defer os.Remove(f.Name())
587 defer f.Close()
Colin Cross3f40fa42015-01-30 17:27:36 -0800588
Colin Crossd8f20142016-11-03 09:43:26 -0700589 _, err = f.Write(data)
Colin Cross3f40fa42015-01-30 17:27:36 -0800590 if err != nil {
Colin Cross485e5722015-08-27 13:28:01 -0700591 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
592 }
593
Colin Crossd8f20142016-11-03 09:43:26 -0700594 _, err = f.WriteString("\n")
Colin Cross485e5722015-08-27 13:28:01 -0700595 if err != nil {
596 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800597 }
598
Colin Crossd8f20142016-11-03 09:43:26 -0700599 f.Close()
600 os.Rename(f.Name(), filename)
601
Colin Cross3f40fa42015-01-30 17:27:36 -0800602 return nil
603}
604
Colin Cross988414c2020-01-11 01:11:46 +0000605// NullConfig returns a mostly empty Config for use by standalone tools like dexpreopt_gen that
606// use the android package.
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200607func NullConfig(outDir, soongOutDir string) Config {
Colin Cross988414c2020-01-11 01:11:46 +0000608 return Config{
609 config: &config{
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200610 outDir: outDir,
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200611 soongOutDir: soongOutDir,
612 fs: pathtools.OsFs,
Colin Cross988414c2020-01-11 01:11:46 +0000613 },
614 }
615}
616
Jingwen Chenc711fec2020-11-22 23:52:50 -0500617// NewConfig creates a new Config object. The srcDir argument specifies the path
618// to the root source directory. It also loads the config file, if found.
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800619func NewConfig(cmdArgs CmdArgs, availableEnv map[string]string) (Config, error) {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500620 // Make a config with default options.
Colin Cross9272ade2016-08-17 15:24:12 -0700621 config := &config{
Kiyoung Kima37d9ba2023-04-19 13:13:45 +0900622 ProductVariablesFileName: cmdArgs.SoongVariables,
Dan Willemsen87b17d12015-07-14 00:39:06 -0700623
Lukacs T. Berki53b2f362021-04-12 14:04:24 +0200624 env: availableEnv,
Colin Cross6ccbc912017-10-10 23:07:38 -0700625
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800626 outDir: cmdArgs.OutDir,
627 soongOutDir: cmdArgs.SoongOutDir,
628 runGoTests: cmdArgs.RunGoTests,
Cole Faustc5bfbdd2025-01-08 13:05:40 -0800629 katiSuffix: cmdArgs.KatiSuffix,
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +0200630 multilibConflicts: make(map[ArchType]bool),
Colin Cross98be1bb2019-12-13 20:41:13 -0800631
Colin Crossb63d7b32023-12-07 16:54:51 -0800632 moduleListFile: cmdArgs.ModuleListFile,
633 fs: pathtools.NewOsFs(absSrcDir),
Chris Parsons9402ca82023-02-23 17:28:06 -0500634
Jihoon Kang2a929ad2023-06-08 19:02:07 +0000635 buildFromSourceStub: cmdArgs.BuildFromSourceStub,
Colin Cross68f55102015-03-25 14:43:57 -0700636 }
LaMont Jones66e65862024-10-30 10:43:17 -0700637 variant, ok := os.LookupEnv("TARGET_BUILD_VARIANT")
638 isEngBuild := !ok || variant == "eng"
Colin Cross3f40fa42015-01-30 17:27:36 -0800639
Dan Willemsen00269f22017-07-06 16:59:48 -0700640 config.deviceConfig = &deviceConfig{
Colin Cross9272ade2016-08-17 15:24:12 -0700641 config: config,
642 }
643
Liz Kammer7941b302020-07-28 13:27:34 -0700644 // Soundness check of the build and source directories. This won't catch strange
645 // configurations with symlinks, but at least checks the obvious case.
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800646 absBuildDir, err := filepath.Abs(cmdArgs.SoongOutDir)
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700647 if err != nil {
648 return Config{}, err
649 }
650
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200651 absSrcDir, err := filepath.Abs(".")
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700652 if err != nil {
653 return Config{}, err
654 }
655
656 if strings.HasPrefix(absSrcDir, absBuildDir) {
657 return Config{}, fmt.Errorf("Build dir must not contain source directory")
658 }
659
Colin Cross3f40fa42015-01-30 17:27:36 -0800660 // Load any configurable options from the configuration file
Colin Cross9272ade2016-08-17 15:24:12 -0700661 err = loadConfig(config)
Colin Cross3f40fa42015-01-30 17:27:36 -0800662 if err != nil {
Colin Crossc3c0a492015-04-10 15:43:55 -0700663 return Config{}, err
Colin Cross3f40fa42015-01-30 17:27:36 -0800664 }
665
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800666 KatiEnabledMarkerFile := filepath.Join(cmdArgs.SoongOutDir, ".soong.kati_enabled")
Jingwen Chencda22c92020-11-23 00:22:30 -0500667 if _, err := os.Stat(absolutePath(KatiEnabledMarkerFile)); err == nil {
668 config.katiEnabled = true
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800669 }
670
Colin Cross0c66bc62021-07-20 09:47:41 -0700671 determineBuildOS(config)
672
Jingwen Chenc711fec2020-11-22 23:52:50 -0500673 // Sets up the map of target OSes to the finer grained compilation targets
674 // that are configured from the product variables.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700675 targets, err := decodeTargetProductVariables(config)
Dan Willemsen218f6562015-07-08 18:13:11 -0700676 if err != nil {
677 return Config{}, err
678 }
679
LaMont Jones66e65862024-10-30 10:43:17 -0700680 config.partialCompileFlags, err = config.parsePartialCompileFlags(isEngBuild)
LaMont Jones99f18962024-10-17 11:50:44 -0700681 if err != nil {
682 return Config{}, err
683 }
684
Paul Duffin1356d8c2020-02-25 19:26:33 +0000685 // Make the CommonOS OsType available for all products.
686 targets[CommonOS] = []Target{commonTargetMap[CommonOS.Name]}
687
Dan Albert4098deb2016-10-19 14:04:41 -0700688 var archConfig []archConfig
Jingwen Chenc4d91bc2020-11-24 22:59:26 -0500689 if config.NdkAbis() {
Dan Albert4098deb2016-10-19 14:04:41 -0700690 archConfig = getNdkAbisConfig()
Martin Stjernholmc1ecc432019-11-15 15:00:31 +0000691 } else if config.AmlAbis() {
692 archConfig = getAmlAbisConfig()
Dan Albert4098deb2016-10-19 14:04:41 -0700693 }
694
695 if archConfig != nil {
Liz Kammerb7f33662022-02-28 14:16:16 -0500696 androidTargets, err := decodeAndroidArchSettings(archConfig)
Dan Willemsen322acaf2016-01-12 23:07:05 -0800697 if err != nil {
698 return Config{}, err
699 }
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700700 targets[Android] = androidTargets
Dan Willemsen322acaf2016-01-12 23:07:05 -0800701 }
702
Colin Cross3b19f5d2019-09-17 14:45:31 -0700703 multilib := make(map[string]bool)
704 for _, target := range targets[Android] {
705 if seen := multilib[target.Arch.ArchType.Multilib]; seen {
706 config.multilibConflicts[target.Arch.ArchType] = true
707 }
708 multilib[target.Arch.ArchType.Multilib] = true
709 }
710
Jingwen Chenc711fec2020-11-22 23:52:50 -0500711 // Map of OS to compilation targets.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700712 config.Targets = targets
Jingwen Chenc711fec2020-11-22 23:52:50 -0500713
714 // Compilation targets for host tools.
Colin Cross0c66bc62021-07-20 09:47:41 -0700715 config.BuildOSTarget = config.Targets[config.BuildOS][0]
716 config.BuildOSCommonTarget = getCommonTargets(config.Targets[config.BuildOS])[0]
Jingwen Chenc711fec2020-11-22 23:52:50 -0500717
718 // Compilation targets for Android.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700719 if len(config.Targets[Android]) > 0 {
720 config.AndroidCommonTarget = getCommonTargets(config.Targets[Android])[0]
Sam Delmericocc271e22022-06-01 15:45:02 +0000721 config.AndroidFirstDeviceTarget = FirstTarget(config.Targets[Android], "lib64", "lib32")[0]
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700722 }
Dan Willemsen218f6562015-07-08 18:13:11 -0700723
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500724 setBuildMode := func(arg string, mode SoongBuildMode) {
725 if arg != "" {
726 if config.BuildMode != AnalysisNoBazel {
727 fmt.Fprintf(os.Stderr, "buildMode is already set, illegal argument: %s", arg)
728 os.Exit(1)
729 }
730 config.BuildMode = mode
731 }
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800732 }
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500733 setBuildMode(cmdArgs.ModuleGraphFile, GenerateModuleGraph)
734 setBuildMode(cmdArgs.DocFile, GenerateDocFile)
MarkDacekd06db5d2022-11-29 00:47:59 +0000735
Jihoon Kangc1b04d62023-11-16 19:07:04 +0000736 config.productVariables.Build_from_text_stub = boolPtr(config.BuildFromTextStub())
737
Jingwen Chenc711fec2020-11-22 23:52:50 -0500738 return Config{config}, err
739}
Colin Cross988414c2020-01-11 01:11:46 +0000740
Colin Cross98be1bb2019-12-13 20:41:13 -0800741// mockFileSystem replaces all reads with accesses to the provided map of
742// filenames to contents stored as a byte slice.
743func (c *config) mockFileSystem(bp string, fs map[string][]byte) {
744 mockFS := map[string][]byte{}
745
746 if _, exists := mockFS["Android.bp"]; !exists {
747 mockFS["Android.bp"] = []byte(bp)
748 }
749
750 for k, v := range fs {
751 mockFS[k] = v
752 }
753
754 // no module list file specified; find every file named Blueprints or Android.bp
755 pathsToParse := []string{}
756 for candidate := range mockFS {
757 base := filepath.Base(candidate)
Lukacs T. Berkib838b0a2021-09-02 11:46:24 +0200758 if base == "Android.bp" {
Colin Cross98be1bb2019-12-13 20:41:13 -0800759 pathsToParse = append(pathsToParse, candidate)
760 }
761 }
762 if len(pathsToParse) < 1 {
763 panic(fmt.Sprintf("No Blueprint or Android.bp files found in mock filesystem: %v\n", mockFS))
764 }
765 mockFS[blueprint.MockModuleListFile] = []byte(strings.Join(pathsToParse, "\n"))
766
767 c.fs = pathtools.MockFs(mockFS)
768 c.mockBpList = blueprint.MockModuleListFile
769}
770
Lukacs T. Berkid1e3f1f2021-03-16 08:55:23 +0100771func (c *config) SetAllowMissingDependencies() {
772 c.productVariables.Allow_missing_dependencies = proptools.BoolPtr(true)
773}
774
Jingwen Chenc711fec2020-11-22 23:52:50 -0500775// BlueprintToolLocation returns the directory containing build system tools
776// from Blueprint, like soong_zip and merge_zips.
Lukacs T. Berkia806e412021-09-01 08:57:48 +0200777func (c *config) HostToolDir() string {
Cole Faust2e40ad92025-01-06 16:29:47 -0800778 return filepath.Join(c.outDir, "host", c.PrebuiltOS(), "bin")
Dan Willemsenc2aa4a92016-05-26 15:13:03 -0700779}
780
Dan Willemsen60e62f02018-11-16 21:05:32 -0800781func (c *config) HostToolPath(ctx PathContext, tool string) Path {
Cole Faust3b703f32023-10-16 13:30:51 -0700782 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "bin", tool)
Colin Cross790ef352021-10-25 19:15:55 -0700783 return path
Dan Willemsen60e62f02018-11-16 21:05:32 -0800784}
785
Colin Cross790ef352021-10-25 19:15:55 -0700786func (c *config) HostJNIToolPath(ctx PathContext, lib string) Path {
Martin Stjernholm7260d062019-12-09 21:47:14 +0000787 ext := ".so"
788 if runtime.GOOS == "darwin" {
789 ext = ".dylib"
790 }
Cole Faust3b703f32023-10-16 13:30:51 -0700791 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "lib64", lib+ext)
Colin Cross790ef352021-10-25 19:15:55 -0700792 return path
Martin Stjernholm7260d062019-12-09 21:47:14 +0000793}
794
Colin Crossae5330a2021-11-03 13:31:22 -0700795func (c *config) HostJavaToolPath(ctx PathContext, tool string) Path {
Cole Faust3b703f32023-10-16 13:30:51 -0700796 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "framework", tool)
Colin Cross3e3eda62021-11-04 10:22:51 -0700797 return path
798}
799
Vinh Tran09581952023-05-16 16:03:20 -0400800func (c *config) HostCcSharedLibPath(ctx PathContext, lib string) Path {
801 libDir := "lib"
802 if ctx.Config().BuildArch.Multilib == "lib64" {
803 libDir = "lib64"
804 }
Cole Faust3b703f32023-10-16 13:30:51 -0700805 return pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, libDir, lib+".so")
Vinh Tran09581952023-05-16 16:03:20 -0400806}
807
Jingwen Chenc711fec2020-11-22 23:52:50 -0500808// PrebuiltOS returns the name of the host OS used in prebuilts directories.
Colin Cross1332b002015-04-07 17:11:30 -0700809func (c *config) PrebuiltOS() string {
Colin Cross3f40fa42015-01-30 17:27:36 -0800810 switch runtime.GOOS {
811 case "linux":
812 return "linux-x86"
813 case "darwin":
814 return "darwin-x86"
815 default:
816 panic("Unknown GOOS")
817 }
818}
819
820// GoRoot returns the path to the root directory of the Go toolchain.
Colin Cross1332b002015-04-07 17:11:30 -0700821func (c *config) GoRoot() string {
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200822 return fmt.Sprintf("prebuilts/go/%s", c.PrebuiltOS())
Colin Cross3f40fa42015-01-30 17:27:36 -0800823}
824
Jingwen Chenc711fec2020-11-22 23:52:50 -0500825// PrebuiltBuildTool returns the path to a tool in the prebuilts directory containing
826// checked-in tools, like Kati, Ninja or Toybox, for the current host OS.
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700827func (c *config) PrebuiltBuildTool(ctx PathContext, tool string) Path {
828 return PathForSource(ctx, "prebuilts/build-tools", c.PrebuiltOS(), "bin", tool)
829}
830
Jingwen Chenc711fec2020-11-22 23:52:50 -0500831// CpPreserveSymlinksFlags returns the host-specific flag for the cp(1) command
832// to preserve symlinks.
Colin Cross1332b002015-04-07 17:11:30 -0700833func (c *config) CpPreserveSymlinksFlags() string {
Colin Cross485e5722015-08-27 13:28:01 -0700834 switch runtime.GOOS {
Colin Cross3f40fa42015-01-30 17:27:36 -0800835 case "darwin":
836 return "-R"
837 case "linux":
838 return "-d"
839 default:
840 return ""
841 }
842}
Colin Cross68f55102015-03-25 14:43:57 -0700843
Colin Cross1332b002015-04-07 17:11:30 -0700844func (c *config) Getenv(key string) string {
Colin Cross68f55102015-03-25 14:43:57 -0700845 var val string
846 var exists bool
Colin Crossc1e86a32015-04-15 12:33:28 -0700847 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800848 defer c.envLock.Unlock()
849 if c.envDeps == nil {
850 c.envDeps = make(map[string]string)
851 }
Colin Cross68f55102015-03-25 14:43:57 -0700852 if val, exists = c.envDeps[key]; !exists {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700853 if c.envFrozen {
854 panic("Cannot access new environment variables after envdeps are frozen")
855 }
Colin Cross6ccbc912017-10-10 23:07:38 -0700856 val, _ = c.env[key]
Colin Cross68f55102015-03-25 14:43:57 -0700857 c.envDeps[key] = val
858 }
859 return val
860}
861
Colin Cross99d7c232016-11-23 16:52:04 -0800862func (c *config) GetenvWithDefault(key string, defaultValue string) string {
863 ret := c.Getenv(key)
864 if ret == "" {
865 return defaultValue
866 }
867 return ret
868}
869
870func (c *config) IsEnvTrue(key string) bool {
AdityaK19384102024-05-01 13:51:25 -0700871 value := strings.ToLower(c.Getenv(key))
Colin Cross99d7c232016-11-23 16:52:04 -0800872 return value == "1" || value == "y" || value == "yes" || value == "on" || value == "true"
873}
874
875func (c *config) IsEnvFalse(key string) bool {
AdityaK19384102024-05-01 13:51:25 -0700876 value := strings.ToLower(c.Getenv(key))
Colin Cross99d7c232016-11-23 16:52:04 -0800877 return value == "0" || value == "n" || value == "no" || value == "off" || value == "false"
878}
879
Sorin Basca253f8c02024-05-23 10:28:24 +0100880func (c *config) TargetsJava21() bool {
Sorin Basca37cc2712024-10-16 10:25:36 +0100881 return c.productVariables.GetBuildFlagBool("RELEASE_TARGET_JAVA_21")
Sorin Basca253f8c02024-05-23 10:28:24 +0100882}
883
Jingwen Chenc711fec2020-11-22 23:52:50 -0500884// EnvDeps returns the environment variables this build depends on. The first
885// call to this function blocks future reads from the environment.
Colin Cross1332b002015-04-07 17:11:30 -0700886func (c *config) EnvDeps() map[string]string {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700887 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800888 defer c.envLock.Unlock()
Dan Willemsene7680ba2015-09-11 17:06:19 -0700889 c.envFrozen = true
Colin Cross68f55102015-03-25 14:43:57 -0700890 return c.envDeps
891}
Colin Cross35cec122015-04-02 14:37:16 -0700892
Jingwen Chencda22c92020-11-23 00:22:30 -0500893func (c *config) KatiEnabled() bool {
894 return c.katiEnabled
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800895}
896
Cole Faust11edf552023-10-13 11:32:14 -0700897func (c *config) ProductVariables() ProductVariables {
898 return c.productVariables
899}
900
Nan Zhang581fd212018-01-10 16:06:12 -0800901func (c *config) BuildId() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800902 return String(c.productVariables.BuildId)
Nan Zhang581fd212018-01-10 16:06:12 -0800903}
904
Inseob Kim8fa54da2024-03-19 16:48:59 +0900905func (c *config) DisplayBuildNumber() bool {
906 return Bool(c.productVariables.DisplayBuildNumber)
907}
908
Inseob Kim2da72af2024-06-18 11:09:12 +0900909// BuildFingerprintFile returns the path to a text file containing metadata
910// representing the current build's fingerprint.
911//
912// Rules that want to reference the build fingerprint should read from this file
913// without depending on it. They will run whenever their other dependencies
914// require them to run and get the current build fingerprint. This ensures they
915// don't rebuild on every incremental build when the build number changes.
916func (c *config) BuildFingerprintFile(ctx PathContext) Path {
917 return PathForArbitraryOutput(ctx, "target", "product", c.DeviceName(), String(c.productVariables.BuildFingerprintFile))
918}
919
Jingwen Chenc711fec2020-11-22 23:52:50 -0500920// BuildNumberFile returns the path to a text file containing metadata
921// representing the current build's number.
922//
923// Rules that want to reference the build number should read from this file
924// without depending on it. They will run whenever their other dependencies
925// require them to run and get the current build number. This ensures they don't
926// rebuild on every incremental build when the build number changes.
Colin Cross2a2e0db2020-02-21 16:55:46 -0800927func (c *config) BuildNumberFile(ctx PathContext) Path {
928 return PathForOutput(ctx, String(c.productVariables.BuildNumberFile))
Nan Zhang581fd212018-01-10 16:06:12 -0800929}
930
Inseob Kim8fa54da2024-03-19 16:48:59 +0900931// BuildHostnameFile returns the path to a text file containing metadata
932// representing the current build's host name.
933func (c *config) BuildHostnameFile(ctx PathContext) Path {
934 return PathForOutput(ctx, String(c.productVariables.BuildHostnameFile))
935}
936
937// BuildThumbprintFile returns the path to a text file containing metadata
938// representing the current build's thumbprint.
939//
940// Rules that want to reference the build thumbprint should read from this file
941// without depending on it. They will run whenever their other dependencies
942// require them to run and get the current build thumbprint. This ensures they
943// don't rebuild on every incremental build when the build thumbprint changes.
944func (c *config) BuildThumbprintFile(ctx PathContext) Path {
945 return PathForArbitraryOutput(ctx, "target", "product", c.DeviceName(), String(c.productVariables.BuildThumbprintFile))
946}
947
Jingwen Chenc711fec2020-11-22 23:52:50 -0500948// DeviceName returns the name of the current device target.
Colin Cross35cec122015-04-02 14:37:16 -0700949// TODO: take an AndroidModuleContext to select the device name for multi-device builds
Colin Cross1332b002015-04-07 17:11:30 -0700950func (c *config) DeviceName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800951 return *c.productVariables.DeviceName
Colin Cross35cec122015-04-02 14:37:16 -0700952}
953
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000954// DeviceProduct returns the current product target. There could be multiple of
955// these per device type.
956//
Chris Parsonsef615e52022-08-18 22:04:11 -0400957// NOTE: Do not base conditional logic on this value. It may break product inheritance.
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000958func (c *config) DeviceProduct() string {
959 return *c.productVariables.DeviceProduct
960}
961
Cole Faustb85d1a12022-11-08 18:14:01 -0800962// HasDeviceProduct returns if the build has a product. A build will not
963// necessarily have a product when --skip-config is passed to soong, like it is
964// in prebuilts/build-tools/build-prebuilts.sh
965func (c *config) HasDeviceProduct() bool {
966 return c.productVariables.DeviceProduct != nil
967}
968
Inseob Kim8fa54da2024-03-19 16:48:59 +0900969func (c *config) DeviceAbi() []string {
970 return c.productVariables.DeviceAbi
971}
972
Anton Hansson53c88442019-03-18 15:53:16 +0000973func (c *config) DeviceResourceOverlays() []string {
974 return c.productVariables.DeviceResourceOverlays
975}
976
977func (c *config) ProductResourceOverlays() []string {
978 return c.productVariables.ProductResourceOverlays
Colin Cross30e076a2015-04-13 13:58:27 -0700979}
980
Inseob Kim8fa54da2024-03-19 16:48:59 +0900981func (c *config) PlatformDisplayVersionName() string {
982 return String(c.productVariables.Platform_display_version_name)
983}
984
Colin Crossbfd347d2018-05-09 11:11:35 -0700985func (c *config) PlatformVersionName() string {
986 return String(c.productVariables.Platform_version_name)
987}
988
Dan Albert4f378d72020-07-23 17:32:15 -0700989func (c *config) PlatformSdkVersion() ApiLevel {
990 return uncheckedFinalApiLevel(*c.productVariables.Platform_sdk_version)
Colin Cross30e076a2015-04-13 13:58:27 -0700991}
992
Cole Faust37d27c42023-04-12 10:27:45 -0700993func (c *config) RawPlatformSdkVersion() *int {
994 return c.productVariables.Platform_sdk_version
995}
996
Mu-Le Lee5e047532022-07-27 02:32:03 +0000997func (c *config) PlatformSdkFinal() bool {
998 return Bool(c.productVariables.Platform_sdk_final)
999}
1000
Colin Crossd09b0b62018-04-18 11:06:47 -07001001func (c *config) PlatformSdkCodename() string {
1002 return String(c.productVariables.Platform_sdk_codename)
1003}
1004
Anton Hansson97d0bae2022-02-16 16:15:10 +00001005func (c *config) PlatformSdkExtensionVersion() int {
1006 return *c.productVariables.Platform_sdk_extension_version
1007}
1008
1009func (c *config) PlatformBaseSdkExtensionVersion() int {
1010 return *c.productVariables.Platform_base_sdk_extension_version
1011}
1012
Colin Cross092c9da2019-04-02 22:56:43 -07001013func (c *config) PlatformSecurityPatch() string {
1014 return String(c.productVariables.Platform_security_patch)
1015}
1016
1017func (c *config) PlatformPreviewSdkVersion() string {
1018 return String(c.productVariables.Platform_preview_sdk_version)
1019}
1020
1021func (c *config) PlatformMinSupportedTargetSdkVersion() string {
Linus Tufvessonba270c52024-04-12 13:06:22 +02001022 var val, ok = c.productVariables.BuildFlags["RELEASE_PLATFORM_MIN_SUPPORTED_TARGET_SDK_VERSION"]
1023 if !ok {
1024 return ""
1025 }
1026 return val
Colin Cross092c9da2019-04-02 22:56:43 -07001027}
1028
1029func (c *config) PlatformBaseOS() string {
1030 return String(c.productVariables.Platform_base_os)
1031}
1032
Inseob Kim4f1f3d92022-04-25 18:23:58 +09001033func (c *config) PlatformVersionLastStable() string {
1034 return String(c.productVariables.Platform_version_last_stable)
1035}
1036
Jiyong Park37073842022-06-21 10:13:42 +09001037func (c *config) PlatformVersionKnownCodenames() string {
1038 return String(c.productVariables.Platform_version_known_codenames)
1039}
1040
Dan Albert1a246272020-07-06 14:49:35 -07001041func (c *config) MinSupportedSdkVersion() ApiLevel {
Dan Albert6bfb6bb2022-08-17 20:11:57 +00001042 return uncheckedFinalApiLevel(21)
Dan Albert1a246272020-07-06 14:49:35 -07001043}
1044
1045func (c *config) FinalApiLevels() []ApiLevel {
1046 var levels []ApiLevel
Dan Albert4f378d72020-07-23 17:32:15 -07001047 for i := 1; i <= c.PlatformSdkVersion().FinalOrFutureInt(); i++ {
Dan Albert1a246272020-07-06 14:49:35 -07001048 levels = append(levels, uncheckedFinalApiLevel(i))
1049 }
1050 return levels
1051}
1052
1053func (c *config) PreviewApiLevels() []ApiLevel {
1054 var levels []ApiLevel
Dan Albertf93ea132023-10-05 20:40:46 +00001055 i := 0
1056 for _, codename := range c.PlatformVersionActiveCodenames() {
1057 if codename == "REL" {
1058 continue
1059 }
1060
Dan Albert1a246272020-07-06 14:49:35 -07001061 levels = append(levels, ApiLevel{
1062 value: codename,
1063 number: i,
1064 isPreview: true,
1065 })
Dan Albertf93ea132023-10-05 20:40:46 +00001066 i++
Dan Albert1a246272020-07-06 14:49:35 -07001067 }
1068 return levels
1069}
1070
satayevcca4ab72021-11-30 12:33:55 +00001071func (c *config) LatestPreviewApiLevel() ApiLevel {
1072 level := NoneApiLevel
1073 for _, l := range c.PreviewApiLevels() {
1074 if l.GreaterThan(level) {
1075 level = l
1076 }
1077 }
1078 return level
1079}
1080
Dan Albert1a246272020-07-06 14:49:35 -07001081func (c *config) AllSupportedApiLevels() []ApiLevel {
1082 var levels []ApiLevel
1083 levels = append(levels, c.FinalApiLevels()...)
1084 return append(levels, c.PreviewApiLevels()...)
Dan Albertf5415d72017-08-17 16:19:59 -07001085}
1086
Jingwen Chenc711fec2020-11-22 23:52:50 -05001087// DefaultAppTargetSdk returns the API level that platform apps are targeting.
1088// This converts a codename to the exact ApiLevel it represents.
Dan Albert4f378d72020-07-23 17:32:15 -07001089func (c *config) DefaultAppTargetSdk(ctx EarlyModuleContext) ApiLevel {
Colin Crossd09b0b62018-04-18 11:06:47 -07001090 if Bool(c.productVariables.Platform_sdk_final) {
1091 return c.PlatformSdkVersion()
Colin Crossd09b0b62018-04-18 11:06:47 -07001092 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001093 codename := c.PlatformSdkCodename()
Jiyong Park3a00e3d2023-03-27 17:39:48 +09001094 hostOnlyBuild := c.productVariables.DeviceArch == nil
Jingwen Chenc711fec2020-11-22 23:52:50 -05001095 if codename == "" {
Jiyong Park3a00e3d2023-03-27 17:39:48 +09001096 // There are some host-only builds (those are invoked by build-prebuilts.sh) which
1097 // don't set platform sdk codename. Platform sdk codename makes sense only when we
1098 // are building the platform. So we don't enforce the below panic for the host-only
1099 // builds.
1100 if hostOnlyBuild {
1101 return NoneApiLevel
1102 }
1103 panic("Platform_sdk_codename must be set")
Jingwen Chenc711fec2020-11-22 23:52:50 -05001104 }
1105 if codename == "REL" {
1106 panic("Platform_sdk_codename should not be REL when Platform_sdk_final is true")
1107 }
1108 return ApiLevelOrPanic(ctx, codename)
Colin Crossd09b0b62018-04-18 11:06:47 -07001109}
1110
LaMont Jones99f18962024-10-17 11:50:44 -07001111func (c *config) PartialCompileFlags() partialCompileFlags {
1112 return c.partialCompileFlags
1113}
1114
Colin Cross3bc7ffa2017-11-22 16:19:37 -08001115func (c *config) AppsDefaultVersionName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001116 return String(c.productVariables.AppsDefaultVersionName)
Colin Cross3bc7ffa2017-11-22 16:19:37 -08001117}
1118
Dan Albert31384de2017-07-28 12:39:46 -07001119// Codenames that are active in the current lunch target.
1120func (c *config) PlatformVersionActiveCodenames() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001121 return c.productVariables.Platform_version_active_codenames
Dan Albert31384de2017-07-28 12:39:46 -07001122}
1123
Dan Albert8c7a9942023-03-27 20:34:01 +00001124// All unreleased codenames.
1125func (c *config) PlatformVersionAllPreviewCodenames() []string {
1126 return c.productVariables.Platform_version_all_preview_codenames
1127}
1128
Colin Crossface4e42017-10-30 17:32:15 -07001129func (c *config) ProductAAPTConfig() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001130 return c.productVariables.AAPTConfig
Colin Cross30e076a2015-04-13 13:58:27 -07001131}
1132
Colin Crossface4e42017-10-30 17:32:15 -07001133func (c *config) ProductAAPTPreferredConfig() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001134 return String(c.productVariables.AAPTPreferredConfig)
Colin Cross30e076a2015-04-13 13:58:27 -07001135}
1136
Colin Crossface4e42017-10-30 17:32:15 -07001137func (c *config) ProductAAPTCharacteristics() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001138 return String(c.productVariables.AAPTCharacteristics)
Colin Crossface4e42017-10-30 17:32:15 -07001139}
1140
1141func (c *config) ProductAAPTPrebuiltDPI() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001142 return c.productVariables.AAPTPrebuiltDPI
Colin Cross30e076a2015-04-13 13:58:27 -07001143}
1144
Dan Willemsen34cc69e2015-09-23 15:26:20 -07001145func (c *config) DefaultAppCertificateDir(ctx PathContext) SourcePath {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001146 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -08001147 if defaultCert != "" {
1148 return PathForSource(ctx, filepath.Dir(defaultCert))
Colin Cross61ae0b72017-12-01 17:16:02 -08001149 }
Inseob Kim8fa54da2024-03-19 16:48:59 +09001150 return PathForSource(ctx, testKeyDir)
Colin Cross30e076a2015-04-13 13:58:27 -07001151}
1152
Colin Crosse1731a52017-12-14 11:22:55 -08001153func (c *config) DefaultAppCertificate(ctx PathContext) (pem, key SourcePath) {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001154 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -08001155 if defaultCert != "" {
Colin Crosse1731a52017-12-14 11:22:55 -08001156 return PathForSource(ctx, defaultCert+".x509.pem"), PathForSource(ctx, defaultCert+".pk8")
Colin Cross61ae0b72017-12-01 17:16:02 -08001157 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001158 defaultDir := c.DefaultAppCertificateDir(ctx)
1159 return defaultDir.Join(ctx, "testkey.x509.pem"), defaultDir.Join(ctx, "testkey.pk8")
Colin Cross30e076a2015-04-13 13:58:27 -07001160}
Colin Cross6ff51382015-12-17 16:39:19 -08001161
Justin Yun635e7882024-07-04 14:50:57 +09001162func (c *config) ExtraOtaKeys(ctx PathContext, recovery bool) []SourcePath {
1163 var otaKeys []string
1164 if recovery {
1165 otaKeys = c.productVariables.ExtraOtaRecoveryKeys
1166 } else {
1167 otaKeys = c.productVariables.ExtraOtaKeys
1168 }
1169
1170 otaPaths := make([]SourcePath, len(otaKeys))
1171 for i, key := range otaKeys {
1172 otaPaths[i] = PathForSource(ctx, key+".x509.pem")
1173 }
1174
1175 return otaPaths
1176}
1177
Inseob Kim8fa54da2024-03-19 16:48:59 +09001178func (c *config) BuildKeys() string {
1179 defaultCert := String(c.productVariables.DefaultAppCertificate)
1180 if defaultCert == "" || defaultCert == filepath.Join(testKeyDir, "testkey") {
1181 return "test-keys"
1182 }
1183 return "dev-keys"
1184}
1185
Jiyong Park9335a262018-12-24 11:31:58 +09001186func (c *config) ApexKeyDir(ctx ModuleContext) SourcePath {
1187 // TODO(b/121224311): define another variable such as TARGET_APEX_KEY_OVERRIDE
1188 defaultCert := String(c.productVariables.DefaultAppCertificate)
Inseob Kim8fa54da2024-03-19 16:48:59 +09001189 if defaultCert == "" || filepath.Dir(defaultCert) == testKeyDir {
Jiyong Park9335a262018-12-24 11:31:58 +09001190 // When defaultCert is unset or is set to the testkeys path, use the APEX keys
1191 // that is under the module dir
Colin Cross07e51612019-03-05 12:46:40 -08001192 return pathForModuleSrc(ctx)
Jiyong Park9335a262018-12-24 11:31:58 +09001193 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001194 // If not, APEX keys are under the specified directory
1195 return PathForSource(ctx, filepath.Dir(defaultCert))
Jiyong Park9335a262018-12-24 11:31:58 +09001196}
1197
Inseob Kim80fa7982022-08-12 21:36:25 +09001198// Certificate for the NetworkStack sepolicy context
1199func (c *config) MainlineSepolicyDevCertificatesDir(ctx ModuleContext) SourcePath {
1200 cert := String(c.productVariables.MainlineSepolicyDevCertificates)
1201 if cert != "" {
1202 return PathForSource(ctx, cert)
1203 }
1204 return c.DefaultAppCertificateDir(ctx)
1205}
1206
Jingwen Chenc711fec2020-11-22 23:52:50 -05001207// AllowMissingDependencies configures Blueprint/Soong to not fail when modules
1208// are configured to depend on non-existent modules. Note that this does not
1209// affect missing input dependencies at the Ninja level.
Colin Cross6ff51382015-12-17 16:39:19 -08001210func (c *config) AllowMissingDependencies() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001211 return Bool(c.productVariables.Allow_missing_dependencies)
Colin Cross6ff51382015-12-17 16:39:19 -08001212}
Dan Willemsen322acaf2016-01-12 23:07:05 -08001213
Jeongik Cha816a23a2020-07-08 01:09:23 +09001214// Returns true if a full platform source tree cannot be assumed.
Colin Crossfc3674a2017-09-18 17:41:52 -07001215func (c *config) UnbundledBuild() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001216 return Bool(c.productVariables.Unbundled_build)
Colin Crossfc3674a2017-09-18 17:41:52 -07001217}
1218
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +01001219// Returns true if building apps that aren't bundled with the platform.
1220// UnbundledBuild() is always true when this is true.
1221func (c *config) UnbundledBuildApps() bool {
Cole Faust701ca252021-11-23 19:02:08 -08001222 return len(c.productVariables.Unbundled_build_apps) > 0
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +01001223}
1224
Jeongik Cha4b073cd2021-06-08 11:35:00 +09001225// Returns true if building image that aren't bundled with the platform.
1226// UnbundledBuild() is always true when this is true.
1227func (c *config) UnbundledBuildImage() bool {
1228 return Bool(c.productVariables.Unbundled_build_image)
1229}
1230
Jeongik Cha816a23a2020-07-08 01:09:23 +09001231// Returns true if building modules against prebuilt SDKs.
1232func (c *config) AlwaysUsePrebuiltSdks() bool {
1233 return Bool(c.productVariables.Always_use_prebuilt_sdks)
Colin Cross1f367bf2018-12-18 22:46:24 -08001234}
1235
Colin Cross126a25c2017-10-31 13:55:34 -07001236func (c *config) MinimizeJavaDebugInfo() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001237 return Bool(c.productVariables.MinimizeJavaDebugInfo) && !Bool(c.productVariables.Eng)
Colin Cross126a25c2017-10-31 13:55:34 -07001238}
1239
Colin Crossed064c02018-09-05 16:28:13 -07001240func (c *config) Debuggable() bool {
1241 return Bool(c.productVariables.Debuggable)
1242}
1243
Jaewoong Jung1d6eb682018-11-29 15:08:44 -08001244func (c *config) Eng() bool {
1245 return Bool(c.productVariables.Eng)
1246}
1247
Inseob Kim8fa54da2024-03-19 16:48:59 +09001248func (c *config) BuildType() string {
1249 return String(c.productVariables.BuildType)
1250}
1251
Colin Crossc53c37f2021-12-08 15:42:22 -08001252// DevicePrimaryArchType returns the ArchType for the first configured device architecture, or
1253// Common if there are no device architectures.
Jiyong Park8d52f862018-07-07 18:02:07 +09001254func (c *config) DevicePrimaryArchType() ArchType {
Colin Crossc53c37f2021-12-08 15:42:22 -08001255 if androidTargets := c.Targets[Android]; len(androidTargets) > 0 {
1256 return androidTargets[0].Arch.ArchType
1257 }
1258 return Common
Jiyong Park8d52f862018-07-07 18:02:07 +09001259}
1260
Colin Cross16b23492016-01-06 14:41:07 -08001261func (c *config) SanitizeHost() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001262 return append([]string(nil), c.productVariables.SanitizeHost...)
Colin Cross16b23492016-01-06 14:41:07 -08001263}
1264
1265func (c *config) SanitizeDevice() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001266 return append([]string(nil), c.productVariables.SanitizeDevice...)
Colin Cross23ae82a2016-11-02 14:34:39 -07001267}
1268
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -07001269func (c *config) SanitizeDeviceDiag() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001270 return append([]string(nil), c.productVariables.SanitizeDeviceDiag...)
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -07001271}
1272
Colin Cross23ae82a2016-11-02 14:34:39 -07001273func (c *config) SanitizeDeviceArch() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001274 return append([]string(nil), c.productVariables.SanitizeDeviceArch...)
Colin Cross16b23492016-01-06 14:41:07 -08001275}
Colin Crossa1ad8d12016-06-01 17:09:44 -07001276
Vishwath Mohan1b017a72017-01-19 13:54:55 -08001277func (c *config) EnableCFI() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001278 if c.productVariables.EnableCFI == nil {
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -08001279 return true
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -08001280 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001281 return *c.productVariables.EnableCFI
Vishwath Mohan1b017a72017-01-19 13:54:55 -08001282}
1283
Kostya Kortchinskyd5275c82019-02-01 08:42:56 -08001284func (c *config) DisableScudo() bool {
1285 return Bool(c.productVariables.DisableScudo)
1286}
1287
Colin Crossa1ad8d12016-06-01 17:09:44 -07001288func (c *config) Android64() bool {
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001289 for _, t := range c.Targets[Android] {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001290 if t.Arch.ArchType.Multilib == "lib64" {
1291 return true
1292 }
1293 }
1294
1295 return false
1296}
Colin Cross9272ade2016-08-17 15:24:12 -07001297
Colin Cross9d45bb72016-08-29 16:14:13 -07001298func (c *config) UseGoma() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001299 return Bool(c.productVariables.UseGoma)
Colin Cross9d45bb72016-08-29 16:14:13 -07001300}
1301
Taylor Santiago3c16e612024-05-30 14:41:31 -07001302func (c *config) UseABFS() bool {
1303 return Bool(c.productVariables.UseABFS)
1304}
1305
Ramy Medhatbbf25672019-07-17 12:30:04 +00001306func (c *config) UseRBE() bool {
1307 return Bool(c.productVariables.UseRBE)
1308}
1309
Ramy Medhat8ea054a2020-01-27 14:19:44 -05001310func (c *config) UseRBEJAVAC() bool {
1311 return Bool(c.productVariables.UseRBEJAVAC)
1312}
1313
1314func (c *config) UseRBER8() bool {
1315 return Bool(c.productVariables.UseRBER8)
1316}
1317
1318func (c *config) UseRBED8() bool {
1319 return Bool(c.productVariables.UseRBED8)
1320}
1321
Colin Cross8b8bec32019-11-15 13:18:43 -08001322func (c *config) UseRemoteBuild() bool {
1323 return c.UseGoma() || c.UseRBE()
1324}
1325
Colin Cross66548102018-06-19 22:47:35 -07001326func (c *config) RunErrorProne() bool {
Cole Faust30d2b192024-12-18 13:32:07 -08001327 return c.IsEnvTrue("RUN_ERROR_PRONE") || c.RunErrorProneInline()
Colin Cross66548102018-06-19 22:47:35 -07001328}
1329
Cole Faust30d2b192024-12-18 13:32:07 -08001330// Returns if the errorprone build should be run "inline", that is, using errorprone as part
1331// of the main javac compilation instead of its own separate compilation. This is good for CI
1332// but bad for local development, because if you toggle errorprone+inline on/off it will repeatedly
1333// clobber java files from the old configuration.
Cole Faustf3240f42024-12-11 16:49:18 -08001334func (c *config) RunErrorProneInline() bool {
Cole Faust30d2b192024-12-18 13:32:07 -08001335 value := strings.ToLower(c.Getenv("RUN_ERROR_PRONE"))
1336 return c.IsEnvTrue("RUN_ERROR_PRONE_INLINE") || value == "inline"
Cole Faustf3240f42024-12-11 16:49:18 -08001337}
1338
Jingwen Chenc711fec2020-11-22 23:52:50 -05001339// XrefCorpusName returns the Kythe cross-reference corpus name.
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001340func (c *config) XrefCorpusName() string {
1341 return c.Getenv("XREF_CORPUS")
1342}
1343
Jingwen Chenc711fec2020-11-22 23:52:50 -05001344// XrefCuEncoding returns the compilation unit encoding to use for Kythe code
1345// xrefs. Can be 'json' (default), 'proto' or 'all'.
Sasha Smundak6c2d4f92020-01-09 17:34:23 -08001346func (c *config) XrefCuEncoding() string {
1347 if enc := c.Getenv("KYTHE_KZIP_ENCODING"); enc != "" {
1348 return enc
1349 }
1350 return "json"
1351}
1352
Sasha Smundakb0addaf2021-02-16 10:39:40 -08001353// XrefCuJavaSourceMax returns the maximum number of the Java source files
1354// in a single compilation unit
1355const xrefJavaSourceFileMaxDefault = "1000"
1356
1357func (c Config) XrefCuJavaSourceMax() string {
1358 v := c.Getenv("KYTHE_JAVA_SOURCE_BATCH_SIZE")
1359 if v == "" {
1360 return xrefJavaSourceFileMaxDefault
1361 }
1362 if _, err := strconv.ParseUint(v, 0, 0); err != nil {
1363 fmt.Fprintf(os.Stderr,
1364 "bad KYTHE_JAVA_SOURCE_BATCH_SIZE value: %s, will use %s",
1365 err, xrefJavaSourceFileMaxDefault)
1366 return xrefJavaSourceFileMaxDefault
1367 }
1368 return v
1369
1370}
1371
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001372func (c *config) EmitXrefRules() bool {
1373 return c.XrefCorpusName() != ""
1374}
1375
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001376func (c *config) ClangTidy() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001377 return Bool(c.productVariables.ClangTidy)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001378}
1379
1380func (c *config) TidyChecks() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001381 if c.productVariables.TidyChecks == nil {
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001382 return ""
1383 }
Dan Willemsen45133ac2018-03-09 21:22:06 -08001384 return *c.productVariables.TidyChecks
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001385}
1386
Colin Cross0f4e0d62016-07-27 10:56:55 -07001387func (c *config) LibartImgHostBaseAddress() string {
David Srbeckya4f336b2024-09-04 16:06:56 +01001388 return "0x70000000"
Colin Cross0f4e0d62016-07-27 10:56:55 -07001389}
1390
1391func (c *config) LibartImgDeviceBaseAddress() string {
Elliott Hughesda3a0712020-03-06 16:55:28 -08001392 return "0x70000000"
Colin Cross0f4e0d62016-07-27 10:56:55 -07001393}
1394
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001395func (c *config) ArtUseReadBarrier() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001396 return Bool(c.productVariables.ArtUseReadBarrier)
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001397}
1398
Jingwen Chenc711fec2020-11-22 23:52:50 -05001399// Enforce Runtime Resource Overlays for a module. RROs supersede static RROs,
1400// but some modules still depend on it.
1401//
1402// More info: https://source.android.com/devices/architecture/rros
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001403func (c *config) EnforceRROForModule(name string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001404 enforceList := c.productVariables.EnforceRROTargets
Jeongik Chacee5ba92021-02-19 12:11:51 +09001405
Roland Levillainf6cc2612020-07-09 16:58:14 +01001406 if len(enforceList) > 0 {
Yo Chiang4ebd06a2019-10-01 13:13:41 +08001407 if InList("*", enforceList) {
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001408 return true
1409 }
Colin Crossa74ca042019-01-31 14:31:51 -08001410 return InList(name, enforceList)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001411 }
1412 return false
1413}
Colin Crossc4441622024-09-18 14:55:49 -07001414
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001415func (c *config) EnforceRROExcludedOverlay(path string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001416 excluded := c.productVariables.EnforceRROExcludedOverlays
Roland Levillainf6cc2612020-07-09 16:58:14 +01001417 if len(excluded) > 0 {
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001418 return HasAnyPrefix(path, excluded)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001419 }
1420 return false
1421}
1422
Colin Crossc4441622024-09-18 14:55:49 -07001423func (c *config) EnforceRROGlobally() bool {
1424 enforceList := c.productVariables.EnforceRROTargets
1425 return InList("*", enforceList)
1426}
1427
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001428func (c *config) ExportedNamespaces() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001429 return append([]string(nil), c.productVariables.NamespacesToExport...)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001430}
1431
Sam Delmerico98a73292023-02-21 11:50:29 -05001432func (c *config) SourceRootDirs() []string {
1433 return c.productVariables.SourceRootDirs
1434}
1435
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001436func (c *config) HostStaticBinaries() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001437 return Bool(c.productVariables.HostStaticBinaries)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001438}
1439
Colin Cross5a0dcd52018-10-05 14:20:06 -07001440func (c *config) UncompressPrivAppDex() bool {
1441 return Bool(c.productVariables.UncompressPrivAppDex)
1442}
1443
1444func (c *config) ModulesLoadedByPrivilegedModules() []string {
1445 return c.productVariables.ModulesLoadedByPrivilegedModules
1446}
1447
Jingwen Chenc711fec2020-11-22 23:52:50 -05001448// DexpreoptGlobalConfigPath returns the path to the dexpreopt.config file in
1449// the output directory, if it was created during the product configuration
1450// phase by Kati.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001451func (c *config) DexpreoptGlobalConfigPath(ctx PathContext) OptionalPath {
Colin Cross988414c2020-01-11 01:11:46 +00001452 if c.productVariables.DexpreoptGlobalConfig == nil {
Jingwen Chenebb0b572020-11-02 00:24:57 -05001453 return OptionalPathForPath(nil)
1454 }
1455 return OptionalPathForPath(
1456 pathForBuildToolDep(ctx, *c.productVariables.DexpreoptGlobalConfig))
1457}
1458
Jingwen Chenc711fec2020-11-22 23:52:50 -05001459// DexpreoptGlobalConfig returns the raw byte contents of the dexpreopt global
1460// configuration. Since the configuration file was created by Kati during
1461// product configuration (externally of soong_build), it's not tracked, so we
1462// also manually add a Ninja file dependency on the configuration file to the
1463// rule that creates the main build.ninja file. This ensures that build.ninja is
1464// regenerated correctly if dexpreopt.config changes.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001465func (c *config) DexpreoptGlobalConfig(ctx PathContext) ([]byte, error) {
1466 path := c.DexpreoptGlobalConfigPath(ctx)
1467 if !path.Valid() {
Colin Cross988414c2020-01-11 01:11:46 +00001468 return nil, nil
1469 }
Jingwen Chenebb0b572020-11-02 00:24:57 -05001470 ctx.AddNinjaFileDeps(path.String())
Sasha Smundakaf5ca922022-12-12 21:23:34 -08001471 return os.ReadFile(absolutePath(path.String()))
Colin Cross43f08db2018-11-12 10:13:39 -08001472}
1473
Inseob Kim7b85eeb2021-03-23 20:52:24 +09001474func (c *deviceConfig) WithDexpreopt() bool {
1475 return c.config.productVariables.WithDexpreopt
1476}
1477
Colin Cross662d6142022-11-03 20:38:01 -07001478func (c *config) FrameworksBaseDirExists(ctx PathGlobContext) bool {
Colin Cross5a756a62021-03-16 16:34:46 -07001479 return ExistentPathForSource(ctx, "frameworks", "base", "Android.bp").Valid()
David Brazdil91b4e3e2019-01-23 21:04:05 +00001480}
1481
Colin Cross3b19f5d2019-09-17 14:45:31 -07001482func (c *config) HasMultilibConflict(arch ArchType) bool {
1483 return c.multilibConflicts[arch]
1484}
1485
Sasha Smundakaf5ca922022-12-12 21:23:34 -08001486func (c *config) PrebuiltHiddenApiDir(_ PathContext) string {
Bill Peckhambae47492021-01-08 09:34:44 -08001487 return String(c.productVariables.PrebuiltHiddenApiDir)
1488}
1489
Justin Yun41cbb5e2023-11-29 17:58:16 +09001490func (c *config) VendorApiLevel() string {
1491 return String(c.productVariables.VendorApiLevel)
1492}
1493
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001494func (c *config) PrevVendorApiLevel() string {
1495 vendorApiLevel, err := strconv.Atoi(c.VendorApiLevel())
1496 if err != nil {
1497 panic(fmt.Errorf("Cannot parse vendor API level %s to an integer: %s",
1498 c.VendorApiLevel(), err))
1499 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001500 // The version before trunk stable is 34.
1501 if vendorApiLevel == 202404 {
1502 return "34"
1503 }
Hsin-Yi Chen890e7722024-03-05 15:56:44 +08001504 if vendorApiLevel >= 1 && vendorApiLevel <= 34 {
1505 return strconv.Itoa(vendorApiLevel - 1)
1506 }
1507 if vendorApiLevel < 202404 || vendorApiLevel%100 != 4 {
1508 panic("Unknown vendor API level " + c.VendorApiLevel())
1509 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001510 return strconv.Itoa(vendorApiLevel - 100)
1511}
1512
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001513func IsTrunkStableVendorApiLevel(level string) bool {
1514 levelInt, err := strconv.Atoi(level)
1515 return err == nil && levelInt >= 202404
1516}
1517
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001518func (c *config) VendorApiLevelFrozen() bool {
1519 return c.productVariables.GetBuildFlagBool("RELEASE_BOARD_API_LEVEL_FROZEN")
1520}
1521
Cole Faustc5bfbdd2025-01-08 13:05:40 -08001522func (c *config) katiPackageMkDir() string {
1523 return filepath.Join(c.soongOutDir, "kati_packaging"+c.katiSuffix)
1524}
1525
Colin Cross9272ade2016-08-17 15:24:12 -07001526func (c *deviceConfig) Arches() []Arch {
1527 var arches []Arch
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001528 for _, target := range c.config.Targets[Android] {
Colin Cross9272ade2016-08-17 15:24:12 -07001529 arches = append(arches, target.Arch)
1530 }
1531 return arches
1532}
Dan Willemsend2ede872016-11-18 14:54:24 -08001533
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001534func (c *deviceConfig) BinderBitness() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001535 is32BitBinder := c.config.productVariables.Binder32bit
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001536 if is32BitBinder != nil && *is32BitBinder {
1537 return "32"
1538 }
1539 return "64"
1540}
1541
Jihoon Kang3216c982024-12-02 19:42:20 +00001542func (c *deviceConfig) RecoveryPath() string {
1543 if c.config.productVariables.RecoveryPath != nil {
1544 return *c.config.productVariables.RecoveryPath
1545 }
1546 return "recovery"
1547}
1548
Dan Willemsen4353bc42016-12-05 17:16:02 -08001549func (c *deviceConfig) VendorPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001550 if c.config.productVariables.VendorPath != nil {
1551 return *c.config.productVariables.VendorPath
Dan Willemsen4353bc42016-12-05 17:16:02 -08001552 }
1553 return "vendor"
1554}
1555
Wei Li59586252024-11-04 09:25:54 -08001556func (c *deviceConfig) VendorDlkmPath() string {
1557 if c.config.productVariables.VendorDlkmPath != nil {
1558 return *c.config.productVariables.VendorDlkmPath
1559 }
1560 return "vendor_dlkm"
1561}
1562
Spandan Dase3b65312024-10-22 00:27:27 +00001563func (c *deviceConfig) BuildingVendorImage() bool {
1564 return proptools.Bool(c.config.productVariables.BuildingVendorImage)
1565}
1566
Jeongik Cha219141c2020-08-06 23:00:37 +09001567func (c *deviceConfig) CurrentApiLevelForVendorModules() string {
1568 return StringDefault(c.config.productVariables.DeviceCurrentApiLevelForVendorModules, "current")
1569}
1570
Justin Yun71549282017-11-17 12:10:28 +09001571func (c *deviceConfig) ExtraVndkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001572 return c.config.productVariables.ExtraVndkVersions
Dan Willemsend2ede872016-11-18 14:54:24 -08001573}
Jack He8cc71432016-12-08 15:45:07 -08001574
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001575func (c *deviceConfig) SystemSdkVersions() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001576 return c.config.productVariables.DeviceSystemSdkVersions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001577}
1578
1579func (c *deviceConfig) PlatformSystemSdkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001580 return c.config.productVariables.Platform_systemsdk_versions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001581}
1582
Jiyong Park2db76922017-11-08 16:03:48 +09001583func (c *deviceConfig) OdmPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001584 if c.config.productVariables.OdmPath != nil {
1585 return *c.config.productVariables.OdmPath
Jiyong Park2db76922017-11-08 16:03:48 +09001586 }
1587 return "odm"
1588}
1589
Spandan Dasc5717162024-11-01 18:33:57 +00001590func (c *deviceConfig) BuildingOdmImage() bool {
1591 return proptools.Bool(c.config.productVariables.BuildingOdmImage)
1592}
1593
Wei Li59586252024-11-04 09:25:54 -08001594func (c *deviceConfig) OdmDlkmPath() string {
1595 if c.config.productVariables.OdmDlkmPath != nil {
1596 return *c.config.productVariables.OdmDlkmPath
1597 }
1598 return "odm_dlkm"
1599}
1600
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001601func (c *deviceConfig) ProductPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001602 if c.config.productVariables.ProductPath != nil {
1603 return *c.config.productVariables.ProductPath
Jiyong Park2db76922017-11-08 16:03:48 +09001604 }
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001605 return "product"
Jiyong Park2db76922017-11-08 16:03:48 +09001606}
1607
Jihoon Kang6dd13b62024-10-22 23:21:02 +00001608func (c *deviceConfig) BuildingProductImage() bool {
1609 return proptools.Bool(c.config.productVariables.BuildingProductImage)
1610}
1611
Justin Yund5f6c822019-06-25 16:47:17 +09001612func (c *deviceConfig) SystemExtPath() string {
1613 if c.config.productVariables.SystemExtPath != nil {
1614 return *c.config.productVariables.SystemExtPath
Dario Frenifd05a742018-05-29 13:28:54 +01001615 }
Justin Yund5f6c822019-06-25 16:47:17 +09001616 return "system_ext"
Dario Frenifd05a742018-05-29 13:28:54 +01001617}
1618
Wei Li59586252024-11-04 09:25:54 -08001619func (c *deviceConfig) SystemDlkmPath() string {
1620 if c.config.productVariables.SystemDlkmPath != nil {
1621 return *c.config.productVariables.SystemDlkmPath
1622 }
1623 return "system_dlkm"
1624}
1625
1626func (c *deviceConfig) OemPath() string {
1627 if c.config.productVariables.OemPath != nil {
1628 return *c.config.productVariables.OemPath
1629 }
1630 return "oem"
1631}
1632
mrziwang23ba8762024-11-07 16:21:53 -08001633func (c *deviceConfig) UserdataPath() string {
1634 if c.config.productVariables.UserdataPath != nil {
1635 return *c.config.productVariables.UserdataPath
1636 }
1637 return "data"
1638}
1639
1640func (c *deviceConfig) BuildingUserdataImage() bool {
1641 return proptools.Bool(c.config.productVariables.BuildingUserdataImage)
1642}
1643
Jihoon Kang3216c982024-12-02 19:42:20 +00001644func (c *deviceConfig) BuildingRecoveryImage() bool {
1645 return proptools.Bool(c.config.productVariables.BuildingRecoveryImage)
1646}
1647
Jack He8cc71432016-12-08 15:45:07 -08001648func (c *deviceConfig) BtConfigIncludeDir() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001649 return String(c.config.productVariables.BtConfigIncludeDir)
Jack He8cc71432016-12-08 15:45:07 -08001650}
Dan Willemsen581341d2017-02-09 16:16:31 -08001651
Jiyong Parkd773eb32017-07-03 13:18:12 +09001652func (c *deviceConfig) DeviceKernelHeaderDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001653 return c.config.productVariables.DeviceKernelHeaders
Jiyong Parkd773eb32017-07-03 13:18:12 +09001654}
1655
Roland Levillainada12702020-06-09 13:07:36 +01001656// JavaCoverageEnabledForPath returns whether Java code coverage is enabled for
1657// path. Coverage is enabled by default when the product variable
1658// JavaCoveragePaths is empty. If JavaCoveragePaths is not empty, coverage is
1659// enabled for any path which is part of this variable (and not part of the
1660// JavaCoverageExcludePaths product variable). Value "*" in JavaCoveragePaths
1661// represents any path.
1662func (c *deviceConfig) JavaCoverageEnabledForPath(path string) bool {
1663 coverage := false
Chris Gross2f748692020-06-24 20:36:59 +00001664 if len(c.config.productVariables.JavaCoveragePaths) == 0 ||
Roland Levillainada12702020-06-09 13:07:36 +01001665 InList("*", c.config.productVariables.JavaCoveragePaths) ||
1666 HasAnyPrefix(path, c.config.productVariables.JavaCoveragePaths) {
1667 coverage = true
1668 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001669 if coverage && len(c.config.productVariables.JavaCoverageExcludePaths) > 0 {
Roland Levillainada12702020-06-09 13:07:36 +01001670 if HasAnyPrefix(path, c.config.productVariables.JavaCoverageExcludePaths) {
1671 coverage = false
1672 }
1673 }
1674 return coverage
1675}
1676
Colin Cross1a6acd42020-06-16 17:51:46 -07001677// Returns true if gcov or clang coverage is enabled.
Dan Willemsen581341d2017-02-09 16:16:31 -08001678func (c *deviceConfig) NativeCoverageEnabled() bool {
Colin Cross1a6acd42020-06-16 17:51:46 -07001679 return Bool(c.config.productVariables.GcovCoverage) ||
1680 Bool(c.config.productVariables.ClangCoverage)
Dan Willemsen581341d2017-02-09 16:16:31 -08001681}
1682
Oliver Nguyen1382ab62019-12-06 15:22:41 -08001683func (c *deviceConfig) ClangCoverageEnabled() bool {
1684 return Bool(c.config.productVariables.ClangCoverage)
1685}
1686
Pirama Arumuga Nainarb37ae582022-01-26 22:14:32 -08001687func (c *deviceConfig) ClangCoverageContinuousMode() bool {
1688 return Bool(c.config.productVariables.ClangCoverageContinuousMode)
1689}
1690
Colin Cross1a6acd42020-06-16 17:51:46 -07001691func (c *deviceConfig) GcovCoverageEnabled() bool {
1692 return Bool(c.config.productVariables.GcovCoverage)
1693}
1694
Roland Levillain4f5297b2020-06-09 12:44:06 +01001695// NativeCoverageEnabledForPath returns whether (GCOV- or Clang-based) native
1696// code coverage is enabled for path. By default, coverage is not enabled for a
1697// given path unless it is part of the NativeCoveragePaths product variable (and
1698// not part of the NativeCoverageExcludePaths product variable). Value "*" in
1699// NativeCoveragePaths represents any path.
1700func (c *deviceConfig) NativeCoverageEnabledForPath(path string) bool {
Ryan Campbell469a18a2017-02-27 09:01:54 -08001701 coverage := false
Roland Levillainf6cc2612020-07-09 16:58:14 +01001702 if len(c.config.productVariables.NativeCoveragePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001703 if InList("*", c.config.productVariables.NativeCoveragePaths) || HasAnyPrefix(path, c.config.productVariables.NativeCoveragePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001704 coverage = true
Dan Willemsen581341d2017-02-09 16:16:31 -08001705 }
1706 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001707 if coverage && len(c.config.productVariables.NativeCoverageExcludePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001708 if HasAnyPrefix(path, c.config.productVariables.NativeCoverageExcludePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001709 coverage = false
Ryan Campbell469a18a2017-02-27 09:01:54 -08001710 }
1711 }
1712 return coverage
Dan Willemsen581341d2017-02-09 16:16:31 -08001713}
Ivan Lozano5f595532017-07-13 14:46:05 -07001714
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001715func (c *deviceConfig) PgoAdditionalProfileDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001716 return c.config.productVariables.PgoAdditionalProfileDirs
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001717}
1718
Vinh Tran44cb78c2023-03-09 22:07:19 -05001719// AfdoProfile returns fully qualified path associated to the given module name
Colin Crossd38feb02024-01-23 16:38:06 -08001720func (c *deviceConfig) AfdoProfile(name string) (string, error) {
Vinh Tran44cb78c2023-03-09 22:07:19 -05001721 for _, afdoProfile := range c.config.productVariables.AfdoProfiles {
1722 split := strings.Split(afdoProfile, ":")
1723 if len(split) != 3 {
Colin Crossd38feb02024-01-23 16:38:06 -08001724 return "", fmt.Errorf("AFDO_PROFILES has invalid value: %s. "+
Vinh Tran44cb78c2023-03-09 22:07:19 -05001725 "The expected format is <module>:<fully-qualified-path-to-fdo_profile>", afdoProfile)
1726 }
1727 if split[0] == name {
Colin Crossd38feb02024-01-23 16:38:06 -08001728 return strings.Join([]string{split[1], split[2]}, ":"), nil
Vinh Tran44cb78c2023-03-09 22:07:19 -05001729 }
1730 }
Colin Crossd38feb02024-01-23 16:38:06 -08001731 return "", nil
Vinh Tran44cb78c2023-03-09 22:07:19 -05001732}
1733
Tri Vo35a51432018-03-25 20:00:00 -07001734func (c *deviceConfig) VendorSepolicyDirs() []string {
1735 return c.config.productVariables.BoardVendorSepolicyDirs
1736}
1737
1738func (c *deviceConfig) OdmSepolicyDirs() []string {
1739 return c.config.productVariables.BoardOdmSepolicyDirs
1740}
1741
Felixa20a8752020-05-17 18:28:35 +02001742func (c *deviceConfig) SystemExtPublicSepolicyDirs() []string {
1743 return c.config.productVariables.SystemExtPublicSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001744}
1745
Felixa20a8752020-05-17 18:28:35 +02001746func (c *deviceConfig) SystemExtPrivateSepolicyDirs() []string {
1747 return c.config.productVariables.SystemExtPrivateSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001748}
1749
Inseob Kim0866b002019-04-15 20:21:29 +09001750func (c *deviceConfig) SepolicyM4Defs() []string {
1751 return c.config.productVariables.BoardSepolicyM4Defs
1752}
1753
Jiyong Park7f67f482019-01-05 12:57:48 +09001754func (c *deviceConfig) OverrideManifestPackageNameFor(name string) (manifestName string, overridden bool) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001755 return findOverrideValue(c.config.productVariables.ManifestPackageNameOverrides, name,
1756 "invalid override rule %q in PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES should be <module_name>:<manifest_name>")
1757}
1758
1759func (c *deviceConfig) OverrideCertificateFor(name string) (certificatePath string, overridden bool) {
Jaewoong Jungacb6db32019-02-28 16:22:30 +00001760 return findOverrideValue(c.config.productVariables.CertificateOverrides, name,
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001761 "invalid override rule %q in PRODUCT_CERTIFICATE_OVERRIDES should be <module_name>:<certificate_module_name>")
1762}
1763
Jaewoong Jung9d22a912019-01-23 16:27:47 -08001764func (c *deviceConfig) OverridePackageNameFor(name string) string {
1765 newName, overridden := findOverrideValue(
1766 c.config.productVariables.PackageNameOverrides,
1767 name,
1768 "invalid override rule %q in PRODUCT_PACKAGE_NAME_OVERRIDES should be <module_name>:<package_name>")
1769 if overridden {
1770 return newName
1771 }
1772 return name
1773}
1774
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001775func findOverrideValue(overrides []string, name string, errorMsg string) (newValue string, overridden bool) {
Jiyong Park7f67f482019-01-05 12:57:48 +09001776 if overrides == nil || len(overrides) == 0 {
1777 return "", false
1778 }
1779 for _, o := range overrides {
1780 split := strings.Split(o, ":")
1781 if len(split) != 2 {
1782 // This shouldn't happen as this is first checked in make, but just in case.
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001783 panic(fmt.Errorf(errorMsg, o))
Jiyong Park7f67f482019-01-05 12:57:48 +09001784 }
1785 if matchPattern(split[0], name) {
1786 return substPattern(split[0], split[1], name), true
1787 }
1788 }
1789 return "", false
1790}
1791
Albert Martineefabcf2022-03-21 20:11:16 +00001792func (c *deviceConfig) ApexGlobalMinSdkVersionOverride() string {
1793 return String(c.config.productVariables.ApexGlobalMinSdkVersionOverride)
1794}
1795
Ivan Lozano5f595532017-07-13 14:46:05 -07001796func (c *config) IntegerOverflowDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001797 if len(c.productVariables.IntegerOverflowExcludePaths) == 0 {
Ivan Lozano5f595532017-07-13 14:46:05 -07001798 return false
1799 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001800 return HasAnyPrefix(path, c.productVariables.IntegerOverflowExcludePaths)
Ivan Lozano5f595532017-07-13 14:46:05 -07001801}
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001802
1803func (c *config) CFIDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001804 if len(c.productVariables.CFIExcludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001805 return false
1806 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001807 return HasAnyPrefix(path, c.productVariables.CFIExcludePaths)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001808}
1809
1810func (c *config) CFIEnabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001811 if len(c.productVariables.CFIIncludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001812 return false
1813 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001814 return HasAnyPrefix(path, c.productVariables.CFIIncludePaths) && !c.CFIDisabledForPath(path)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001815}
Colin Crosse15ddaf2017-12-04 11:24:31 -08001816
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001817func (c *config) MemtagHeapDisabledForPath(path string) bool {
1818 if len(c.productVariables.MemtagHeapExcludePaths) == 0 {
1819 return false
1820 }
1821 return HasAnyPrefix(path, c.productVariables.MemtagHeapExcludePaths)
1822}
1823
1824func (c *config) MemtagHeapAsyncEnabledForPath(path string) bool {
1825 if len(c.productVariables.MemtagHeapAsyncIncludePaths) == 0 {
1826 return false
1827 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001828 return HasAnyPrefix(path, c.productVariables.MemtagHeapAsyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001829}
1830
1831func (c *config) MemtagHeapSyncEnabledForPath(path string) bool {
1832 if len(c.productVariables.MemtagHeapSyncIncludePaths) == 0 {
1833 return false
1834 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001835 return HasAnyPrefix(path, c.productVariables.MemtagHeapSyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001836}
1837
Tomislav Novakf734f002023-08-22 10:51:44 -07001838func (c *config) HWASanDisabledForPath(path string) bool {
1839 if len(c.productVariables.HWASanExcludePaths) == 0 {
1840 return false
1841 }
1842 return HasAnyPrefix(path, c.productVariables.HWASanExcludePaths)
1843}
1844
Hang Lua98aab92023-03-17 13:17:22 +08001845func (c *config) HWASanEnabledForPath(path string) bool {
1846 if len(c.productVariables.HWASanIncludePaths) == 0 {
1847 return false
1848 }
Tomislav Novakf734f002023-08-22 10:51:44 -07001849 return HasAnyPrefix(path, c.productVariables.HWASanIncludePaths) && !c.HWASanDisabledForPath(path)
Hang Lua98aab92023-03-17 13:17:22 +08001850}
1851
Dan Willemsen0fe78662018-03-26 12:41:18 -07001852func (c *config) VendorConfig(name string) VendorConfig {
Colin Cross9d34f352019-11-22 16:03:51 -08001853 return soongconfig.Config(c.productVariables.VendorVars[name])
Dan Willemsen0fe78662018-03-26 12:41:18 -07001854}
1855
Colin Cross395f2cf2018-10-24 16:10:32 -07001856func (c *config) NdkAbis() bool {
1857 return Bool(c.productVariables.Ndk_abis)
1858}
1859
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001860func (c *config) AmlAbis() bool {
1861 return Bool(c.productVariables.Aml_abis)
1862}
1863
Jiyong Park4da07972021-01-05 21:01:11 +09001864func (c *config) ForceApexSymlinkOptimization() bool {
1865 return Bool(c.productVariables.ForceApexSymlinkOptimization)
1866}
1867
Sasha Smundakfe9a5b82022-07-27 14:51:45 -07001868func (c *config) ApexCompressionEnabled() bool {
1869 return Bool(c.productVariables.CompressedApex) && !c.UnbundledBuildApps()
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +00001870}
1871
Jooyung Han920809a2024-11-15 12:50:50 +09001872func (c *config) DefaultApexPayloadType() string {
1873 return StringDefault(c.productVariables.DefaultApexPayloadType, "ext4")
1874}
1875
Justin Yun2cc42502024-09-11 14:10:20 +09001876func (c *config) UseSoongSystemImage() bool {
1877 return Bool(c.productVariables.UseSoongSystemImage)
1878}
1879
1880func (c *config) SoongDefinedSystemImage() string {
1881 if c.UseSoongSystemImage() {
1882 return String(c.productVariables.ProductSoongDefinedSystemImage)
1883 }
1884 return ""
1885}
1886
Jeongik Chac9464142019-01-07 12:07:27 +09001887func (c *config) EnforceSystemCertificate() bool {
1888 return Bool(c.productVariables.EnforceSystemCertificate)
1889}
1890
Colin Cross440e0d02020-06-11 11:32:11 -07001891func (c *config) EnforceSystemCertificateAllowList() []string {
1892 return c.productVariables.EnforceSystemCertificateAllowList
Jeongik Chac9464142019-01-07 12:07:27 +09001893}
1894
Jeongik Cha2cc570d2019-10-29 15:44:45 +09001895func (c *config) EnforceProductPartitionInterface() bool {
1896 return Bool(c.productVariables.EnforceProductPartitionInterface)
1897}
1898
Colin Crossf24a22a2019-01-31 14:12:44 -08001899func (c *config) ProductHiddenAPIStubs() []string {
1900 return c.productVariables.ProductHiddenAPIStubs
Colin Cross8faf8fc2019-01-16 15:15:52 -08001901}
1902
Colin Crossf24a22a2019-01-31 14:12:44 -08001903func (c *config) ProductHiddenAPIStubsSystem() []string {
1904 return c.productVariables.ProductHiddenAPIStubsSystem
Colin Cross8faf8fc2019-01-16 15:15:52 -08001905}
1906
Colin Crossf24a22a2019-01-31 14:12:44 -08001907func (c *config) ProductHiddenAPIStubsTest() []string {
1908 return c.productVariables.ProductHiddenAPIStubsTest
Colin Cross8faf8fc2019-01-16 15:15:52 -08001909}
Dan Willemsen71c74602019-04-10 12:27:35 -07001910
Dan Willemsen54879d12019-04-18 10:08:46 -07001911func (c *deviceConfig) TargetFSConfigGen() []string {
Dan Willemsen71c74602019-04-10 12:27:35 -07001912 return c.config.productVariables.TargetFSConfigGen
1913}
Inseob Kim0866b002019-04-15 20:21:29 +09001914
1915func (c *config) ProductPublicSepolicyDirs() []string {
1916 return c.productVariables.ProductPublicSepolicyDirs
1917}
1918
1919func (c *config) ProductPrivateSepolicyDirs() []string {
1920 return c.productVariables.ProductPrivateSepolicyDirs
1921}
1922
Inseob Kim5eb7ee92022-04-27 10:30:34 +09001923func (c *config) TargetMultitreeUpdateMeta() bool {
1924 return c.productVariables.MultitreeUpdateMeta
1925}
1926
Inseob Kim1f086e22019-05-09 13:29:15 +09001927func (c *deviceConfig) DeviceArch() string {
1928 return String(c.config.productVariables.DeviceArch)
1929}
1930
1931func (c *deviceConfig) DeviceArchVariant() string {
1932 return String(c.config.productVariables.DeviceArchVariant)
1933}
1934
1935func (c *deviceConfig) DeviceSecondaryArch() string {
1936 return String(c.config.productVariables.DeviceSecondaryArch)
1937}
1938
1939func (c *deviceConfig) DeviceSecondaryArchVariant() string {
1940 return String(c.config.productVariables.DeviceSecondaryArchVariant)
1941}
Yifan Hong82db7352020-01-21 16:12:26 -08001942
1943func (c *deviceConfig) BoardUsesRecoveryAsBoot() bool {
1944 return Bool(c.config.productVariables.BoardUsesRecoveryAsBoot)
1945}
Yifan Hong97365ee2020-07-29 09:51:57 -07001946
1947func (c *deviceConfig) BoardKernelBinaries() []string {
1948 return c.config.productVariables.BoardKernelBinaries
1949}
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001950
Yifan Hong42bef8d2020-08-05 14:36:09 -07001951func (c *deviceConfig) BoardKernelModuleInterfaceVersions() []string {
1952 return c.config.productVariables.BoardKernelModuleInterfaceVersions
1953}
1954
Yifan Hongdd8dacc2020-10-21 15:40:17 -07001955func (c *deviceConfig) BoardMoveRecoveryResourcesToVendorBoot() bool {
1956 return Bool(c.config.productVariables.BoardMoveRecoveryResourcesToVendorBoot)
1957}
1958
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001959func (c *deviceConfig) PlatformSepolicyVersion() string {
1960 return String(c.config.productVariables.PlatformSepolicyVersion)
1961}
1962
Inseob Kim843f6642022-01-07 09:11:23 +09001963func (c *deviceConfig) PlatformSepolicyCompatVersions() []string {
1964 return c.config.productVariables.PlatformSepolicyCompatVersions
1965}
1966
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001967func (c *deviceConfig) BoardSepolicyVers() string {
Inseob Kim0c4eec82021-03-22 22:33:40 +09001968 if ver := String(c.config.productVariables.BoardSepolicyVers); ver != "" {
1969 return ver
1970 }
1971 return c.PlatformSepolicyVersion()
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001972}
1973
Inseob Kim1a0afcc2022-02-14 23:10:51 +09001974func (c *deviceConfig) SystemExtSepolicyPrebuiltApiDir() string {
1975 return String(c.config.productVariables.SystemExtSepolicyPrebuiltApiDir)
1976}
1977
1978func (c *deviceConfig) ProductSepolicyPrebuiltApiDir() string {
1979 return String(c.config.productVariables.ProductSepolicyPrebuiltApiDir)
1980}
1981
1982func (c *deviceConfig) IsPartnerTrebleSepolicyTestEnabled() bool {
1983 return c.SystemExtSepolicyPrebuiltApiDir() != "" || c.ProductSepolicyPrebuiltApiDir() != ""
1984}
1985
Justin DeMartino383bfb32021-02-24 10:49:43 -08001986func createDirsMap(previous map[string]bool, dirs []string) (map[string]bool, error) {
1987 var ret = make(map[string]bool)
1988 for _, dir := range dirs {
1989 clean := filepath.Clean(dir)
1990 if previous[clean] || ret[clean] {
1991 return nil, fmt.Errorf("Duplicate entry %s", dir)
1992 }
1993 ret[clean] = true
1994 }
1995 return ret, nil
1996}
1997
1998func (c *deviceConfig) createDirsMapOnce(onceKey OnceKey, previous map[string]bool, dirs []string) map[string]bool {
1999 dirMap := c.Once(onceKey, func() interface{} {
2000 ret, err := createDirsMap(previous, dirs)
2001 if err != nil {
2002 panic(fmt.Errorf("%s: %w", onceKey.key, err))
2003 }
2004 return ret
2005 })
2006 if dirMap == nil {
2007 return nil
2008 }
2009 return dirMap.(map[string]bool)
2010}
2011
Inseob Kim60c32f02020-12-21 22:53:05 +09002012func (c *deviceConfig) ShippingApiLevel() ApiLevel {
Steven Morelanda48df2b2024-06-03 22:29:38 +00002013 if c.config.productVariables.Shipping_api_level == nil {
Inseob Kim60c32f02020-12-21 22:53:05 +09002014 return NoneApiLevel
2015 }
Steven Morelanda48df2b2024-06-03 22:29:38 +00002016 apiLevel, _ := strconv.Atoi(*c.config.productVariables.Shipping_api_level)
Inseob Kim60c32f02020-12-21 22:53:05 +09002017 return uncheckedFinalApiLevel(apiLevel)
2018}
2019
Liz Kammer33cc80e2023-05-18 18:20:28 +00002020func (c *deviceConfig) BuildBrokenPluginValidation() []string {
2021 return c.config.productVariables.BuildBrokenPluginValidation
2022}
2023
Alix Espinoef47e542022-09-14 19:10:51 +00002024func (c *deviceConfig) BuildBrokenClangAsFlags() bool {
2025 return c.config.productVariables.BuildBrokenClangAsFlags
2026}
2027
2028func (c *deviceConfig) BuildBrokenClangCFlags() bool {
2029 return c.config.productVariables.BuildBrokenClangCFlags
2030}
2031
Alixb5f6d9e2022-04-20 23:00:58 +00002032func (c *deviceConfig) BuildBrokenClangProperty() bool {
2033 return c.config.productVariables.BuildBrokenClangProperty
2034}
2035
Inseob Kim67e5add192021-03-17 18:05:33 +09002036func (c *deviceConfig) BuildBrokenEnforceSyspropOwner() bool {
2037 return c.config.productVariables.BuildBrokenEnforceSyspropOwner
2038}
2039
2040func (c *deviceConfig) BuildBrokenTrebleSyspropNeverallow() bool {
2041 return c.config.productVariables.BuildBrokenTrebleSyspropNeverallow
2042}
2043
Hridya Valsaraju5a5c7d52021-04-02 16:45:24 -07002044func (c *deviceConfig) BuildDebugfsRestrictionsEnabled() bool {
2045 return c.config.productVariables.BuildDebugfsRestrictionsEnabled
2046}
2047
Inseob Kim0cac7b42021-02-03 18:16:46 +09002048func (c *deviceConfig) BuildBrokenVendorPropertyNamespace() bool {
2049 return c.config.productVariables.BuildBrokenVendorPropertyNamespace
2050}
2051
Liz Kammer619be462022-01-28 15:13:39 -05002052func (c *deviceConfig) BuildBrokenInputDir(name string) bool {
2053 return InList(name, c.config.productVariables.BuildBrokenInputDirModules)
2054}
2055
Jiyong Park3bb99242024-01-04 23:21:26 +00002056func (c *deviceConfig) BuildBrokenDontCheckSystemSdk() bool {
2057 return c.config.productVariables.BuildBrokenDontCheckSystemSdk
2058}
2059
Inseob Kim2da72af2024-06-18 11:09:12 +09002060func (c *deviceConfig) BuildBrokenDupSysprop() bool {
2061 return c.config.productVariables.BuildBrokenDupSysprop
2062}
2063
Jiakai Zhang48203e32023-06-02 23:42:21 +01002064func (c *config) BuildWarningBadOptionalUsesLibsAllowlist() []string {
2065 return c.productVariables.BuildWarningBadOptionalUsesLibsAllowlist
2066}
2067
Yu Liu6a7940c2023-05-09 17:12:22 -07002068func (c *deviceConfig) GenruleSandboxing() bool {
2069 return Bool(c.config.productVariables.GenruleSandboxing)
Vinh Tran140d5882022-06-10 14:23:27 -04002070}
2071
Inseob Kim67e5add192021-03-17 18:05:33 +09002072func (c *deviceConfig) RequiresInsecureExecmemForSwiftshader() bool {
2073 return c.config.productVariables.RequiresInsecureExecmemForSwiftshader
2074}
2075
Devin Moorec381e102023-07-06 22:03:58 +00002076func (c *deviceConfig) Release_aidl_use_unfrozen() bool {
2077 return Bool(c.config.productVariables.Release_aidl_use_unfrozen)
2078}
2079
Inseob Kim67e5add192021-03-17 18:05:33 +09002080func (c *config) SelinuxIgnoreNeverallows() bool {
2081 return c.productVariables.SelinuxIgnoreNeverallows
2082}
2083
Inseob Kima10ef272021-09-15 03:04:53 +00002084func (c *deviceConfig) SepolicyFreezeTestExtraDirs() []string {
2085 return c.config.productVariables.SepolicyFreezeTestExtraDirs
2086}
2087
2088func (c *deviceConfig) SepolicyFreezeTestExtraPrebuiltDirs() []string {
2089 return c.config.productVariables.SepolicyFreezeTestExtraPrebuiltDirs
2090}
2091
Jiyong Parkd163d4d2021-10-12 16:47:43 +09002092func (c *deviceConfig) GenerateAidlNdkPlatformBackend() bool {
2093 return c.config.productVariables.GenerateAidlNdkPlatformBackend
2094}
2095
Yu Liu67a28422024-03-05 00:36:31 +00002096func (c *deviceConfig) AconfigContainerValidation() string {
2097 return c.config.productVariables.AconfigContainerValidation
2098}
2099
Christopher Ferris98f10222022-07-13 23:16:52 -07002100func (c *config) IgnorePrefer32OnDevice() bool {
2101 return c.productVariables.IgnorePrefer32OnDevice
2102}
2103
Ulya Trafimovich249386a2020-07-01 14:31:13 +01002104func (c *config) BootJars() []string {
2105 return c.Once(earlyBootJarsKey, func() interface{} {
Paul Duffin69d1fb12020-10-23 21:14:20 +01002106 list := c.productVariables.BootJars.CopyOfJars()
satayevd604b212021-07-21 14:23:52 +01002107 return append(list, c.productVariables.ApexBootJars.CopyOfJars()...)
Ulya Trafimovich249386a2020-07-01 14:31:13 +01002108 }).([]string)
2109}
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002110
satayevd604b212021-07-21 14:23:52 +01002111func (c *config) NonApexBootJars() ConfiguredJarList {
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002112 return c.productVariables.BootJars
2113}
2114
satayevd604b212021-07-21 14:23:52 +01002115func (c *config) ApexBootJars() ConfiguredJarList {
2116 return c.productVariables.ApexBootJars
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002117}
Colin Cross77cdcfd2021-03-12 11:28:25 -08002118
2119func (c *config) RBEWrapper() string {
2120 return c.GetenvWithDefault("RBE_WRAPPER", remoteexec.DefaultWrapperPath)
2121}
Colin Cross9b698b62021-12-22 09:55:32 -08002122
2123// UseHostMusl returns true if the host target has been configured to build against musl libc.
2124func (c *config) UseHostMusl() bool {
2125 return Bool(c.productVariables.HostMusl)
2126}
MarkDacekff851b82022-04-21 18:33:17 +00002127
Spandan Das9e93d3d2023-03-08 05:47:29 +00002128// ApiSurfaces directory returns the source path inside the api_surfaces repo
2129// (relative to workspace root).
2130func (c *config) ApiSurfacesDir(s ApiSurface, version string) string {
2131 return filepath.Join(
2132 "build",
2133 "bazel",
2134 "api_surfaces",
2135 s.String(),
2136 version)
2137}
Jihoon Kang1bff0342023-01-17 20:40:22 +00002138
Jihoon Kang1975d3e2023-10-16 23:24:11 +00002139func (c *config) JavaCoverageEnabled() bool {
2140 return c.IsEnvTrue("EMMA_INSTRUMENT") || c.IsEnvTrue("EMMA_INSTRUMENT_STATIC") || c.IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK")
2141}
2142
Jihoon Kangc1b04d62023-11-16 19:07:04 +00002143func (c *deviceConfig) BuildFromSourceStub() bool {
2144 return Bool(c.config.productVariables.BuildFromSourceStub)
2145}
2146
Jihoon Kang1bff0342023-01-17 20:40:22 +00002147func (c *config) BuildFromTextStub() bool {
Jihoon Kang1975d3e2023-10-16 23:24:11 +00002148 // TODO: b/302320354 - Remove the coverage build specific logic once the
2149 // robust solution for handling native properties in from-text stub build
2150 // is implemented.
Jihoon Kangc1b04d62023-11-16 19:07:04 +00002151 return !c.buildFromSourceStub &&
2152 !c.JavaCoverageEnabled() &&
2153 !c.deviceConfig.BuildFromSourceStub()
Jihoon Kang1bff0342023-01-17 20:40:22 +00002154}
Spandan Das4deab282023-03-30 17:06:32 +00002155
2156func (c *config) SetBuildFromTextStub(b bool) {
Jihoon Kang2a929ad2023-06-08 19:02:07 +00002157 c.buildFromSourceStub = !b
Jihoon Kangcbcad7c2023-06-01 22:31:52 +00002158 c.productVariables.Build_from_text_stub = boolPtr(b)
Spandan Das4deab282023-03-30 17:06:32 +00002159}
Jihoon Kang1c92c3e2023-03-23 17:44:51 +00002160
Inseob Kim5bac3b62023-08-25 21:29:46 +09002161func (c *deviceConfig) CheckVendorSeappViolations() bool {
2162 return Bool(c.config.productVariables.CheckVendorSeappViolations)
2163}
Jihoon Kangcfbc4072023-09-20 01:02:18 +00002164
Inseob Kime4e85d52023-10-25 23:53:58 +09002165func (c *config) GetBuildFlag(name string) (string, bool) {
2166 val, ok := c.productVariables.BuildFlags[name]
2167 return val, ok
2168}
Spandan Dase3fcb412023-10-26 20:48:02 +00002169
Rico Winda7b38592024-08-26 12:10:44 +02002170func (c *config) UseOptimizedResourceShrinkingByDefault() bool {
2171 return c.productVariables.GetBuildFlagBool("RELEASE_USE_OPTIMIZED_RESOURCE_SHRINKING_BY_DEFAULT")
2172}
2173
Colin Cross8f1b0332024-01-25 13:39:06 -08002174func (c *config) UseResourceProcessorByDefault() bool {
2175 return c.productVariables.GetBuildFlagBool("RELEASE_USE_RESOURCE_PROCESSOR_BY_DEFAULT")
2176}
2177
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002178func (c *config) UseTransitiveJarsInClasspath() bool {
2179 return c.productVariables.GetBuildFlagBool("RELEASE_USE_TRANSITIVE_JARS_IN_CLASSPATH")
2180}
2181
Christoffer Adamsenf4f4aa62025-01-14 09:15:11 +01002182func (c *config) UseR8FullModeByDefault() bool {
2183 return c.productVariables.GetBuildFlagBool("RELEASE_R8_FULL_MODE_BY_DEFAULT")
2184}
2185
Christoffer Adamsen8ec5f612025-01-09 11:05:11 +01002186func (c *config) UseR8OnlyRuntimeVisibleAnnotations() bool {
2187 return c.productVariables.GetBuildFlagBool("RELEASE_R8_ONLY_RUNTIME_VISIBLE_ANNOTATIONS")
2188}
2189
Christoffer Adamsenb81fc912024-12-17 14:30:47 +01002190func (c *config) UseR8StoreStoreFenceConstructorInlining() bool {
2191 return c.productVariables.GetBuildFlagBool("RELEASE_R8_STORE_STORE_FENCE_CONSTRUCTOR_INLINING")
2192}
2193
David Srbecky55b46b02024-11-26 17:16:16 +00002194func (c *config) UseDexV41() bool {
2195 return c.productVariables.GetBuildFlagBool("RELEASE_USE_DEX_V41")
2196}
2197
Spandan Dase3fcb412023-10-26 20:48:02 +00002198var (
Spandan Das85bd4622024-08-01 00:51:20 +00002199 mainlineApexContributionBuildFlagsToApexNames = map[string]string{
2200 "RELEASE_APEX_CONTRIBUTIONS_ADBD": "com.android.adbd",
2201 "RELEASE_APEX_CONTRIBUTIONS_ADSERVICES": "com.android.adservices",
2202 "RELEASE_APEX_CONTRIBUTIONS_APPSEARCH": "com.android.appsearch",
2203 "RELEASE_APEX_CONTRIBUTIONS_ART": "com.android.art",
William Escande9d41acd2024-12-18 18:56:34 -08002204 "RELEASE_APEX_CONTRIBUTIONS_BLUETOOTH": "com.android.bt",
Spandan Das85bd4622024-08-01 00:51:20 +00002205 "RELEASE_APEX_CONTRIBUTIONS_CAPTIVEPORTALLOGIN": "",
2206 "RELEASE_APEX_CONTRIBUTIONS_CELLBROADCAST": "com.android.cellbroadcast",
2207 "RELEASE_APEX_CONTRIBUTIONS_CONFIGINFRASTRUCTURE": "com.android.configinfrastructure",
2208 "RELEASE_APEX_CONTRIBUTIONS_CONNECTIVITY": "com.android.tethering",
2209 "RELEASE_APEX_CONTRIBUTIONS_CONSCRYPT": "com.android.conscrypt",
Manish Singh0171a1d2025-01-16 07:05:53 -08002210 "RELEASE_APEX_CONTRIBUTIONS_CRASHRECOVERY": "com.android.crashrecovery",
Spandan Das85bd4622024-08-01 00:51:20 +00002211 "RELEASE_APEX_CONTRIBUTIONS_DEVICELOCK": "com.android.devicelock",
2212 "RELEASE_APEX_CONTRIBUTIONS_DOCUMENTSUIGOOGLE": "",
2213 "RELEASE_APEX_CONTRIBUTIONS_EXTSERVICES": "com.android.extservices",
2214 "RELEASE_APEX_CONTRIBUTIONS_HEALTHFITNESS": "com.android.healthfitness",
2215 "RELEASE_APEX_CONTRIBUTIONS_IPSEC": "com.android.ipsec",
2216 "RELEASE_APEX_CONTRIBUTIONS_MEDIA": "com.android.media",
2217 "RELEASE_APEX_CONTRIBUTIONS_MEDIAPROVIDER": "com.android.mediaprovider",
2218 "RELEASE_APEX_CONTRIBUTIONS_MODULE_METADATA": "",
2219 "RELEASE_APEX_CONTRIBUTIONS_NETWORKSTACKGOOGLE": "",
2220 "RELEASE_APEX_CONTRIBUTIONS_NEURALNETWORKS": "com.android.neuralnetworks",
Manish Singh0171a1d2025-01-16 07:05:53 -08002221 "RELEASE_APEX_CONTRIBUTIONS_NFC": "com.android.nfcservices",
Spandan Das85bd4622024-08-01 00:51:20 +00002222 "RELEASE_APEX_CONTRIBUTIONS_ONDEVICEPERSONALIZATION": "com.android.ondevicepersonalization",
2223 "RELEASE_APEX_CONTRIBUTIONS_PERMISSION": "com.android.permission",
2224 "RELEASE_APEX_CONTRIBUTIONS_PRIMARY_LIBS": "",
Manish Singh0171a1d2025-01-16 07:05:53 -08002225 "RELEASE_APEX_CONTRIBUTIONS_PROFILING": "com.android.profiling",
Spandan Das85bd4622024-08-01 00:51:20 +00002226 "RELEASE_APEX_CONTRIBUTIONS_REMOTEKEYPROVISIONING": "com.android.rkpd",
2227 "RELEASE_APEX_CONTRIBUTIONS_RESOLV": "com.android.resolv",
2228 "RELEASE_APEX_CONTRIBUTIONS_SCHEDULING": "com.android.scheduling",
2229 "RELEASE_APEX_CONTRIBUTIONS_SDKEXTENSIONS": "com.android.sdkext",
2230 "RELEASE_APEX_CONTRIBUTIONS_SWCODEC": "com.android.media.swcodec",
2231 "RELEASE_APEX_CONTRIBUTIONS_STATSD": "com.android.os.statsd",
2232 "RELEASE_APEX_CONTRIBUTIONS_TELEMETRY_TVP": "",
2233 "RELEASE_APEX_CONTRIBUTIONS_TZDATA": "com.android.tzdata",
Manish Singh0171a1d2025-01-16 07:05:53 -08002234 "RELEASE_APEX_CONTRIBUTIONS_UPROBESTATS": "com.android.uprobestats",
Spandan Das85bd4622024-08-01 00:51:20 +00002235 "RELEASE_APEX_CONTRIBUTIONS_UWB": "com.android.uwb",
2236 "RELEASE_APEX_CONTRIBUTIONS_WIFI": "com.android.wifi",
Spandan Dase3fcb412023-10-26 20:48:02 +00002237 }
2238)
2239
2240// Returns the list of _selected_ apex_contributions
2241// Each mainline module will have one entry in the list
2242func (c *config) AllApexContributions() []string {
2243 ret := []string{}
Spandan Das85bd4622024-08-01 00:51:20 +00002244 for _, f := range SortedKeys(mainlineApexContributionBuildFlagsToApexNames) {
Spandan Dase3fcb412023-10-26 20:48:02 +00002245 if val, exists := c.GetBuildFlag(f); exists && val != "" {
2246 ret = append(ret, val)
2247 }
2248 }
2249 return ret
2250}
Spandan Das8ab28dd2024-02-17 03:31:45 +00002251
Spandan Das85bd4622024-08-01 00:51:20 +00002252func (c *config) AllMainlineApexNames() []string {
2253 return SortedStringValues(mainlineApexContributionBuildFlagsToApexNames)
2254}
2255
Spandan Das0d24ade2024-03-08 04:20:15 +00002256func (c *config) BuildIgnoreApexContributionContents() *bool {
Spandan Das8ab28dd2024-02-17 03:31:45 +00002257 return c.productVariables.BuildIgnoreApexContributionContents
2258}
Inseob Kim8fa54da2024-03-19 16:48:59 +09002259
2260func (c *config) ProductLocales() []string {
2261 return c.productVariables.ProductLocales
2262}
2263
2264func (c *config) ProductDefaultWifiChannels() []string {
2265 return c.productVariables.ProductDefaultWifiChannels
2266}
2267
2268func (c *config) BoardUseVbmetaDigestInFingerprint() bool {
2269 return Bool(c.productVariables.BoardUseVbmetaDigestInFingerprint)
2270}
2271
2272func (c *config) OemProperties() []string {
2273 return c.productVariables.OemProperties
2274}
Kiyoung Kim881e4652024-07-08 11:02:23 +09002275
2276func (c *config) UseDebugArt() bool {
2277 if c.productVariables.ArtTargetIncludeDebugBuild != nil {
2278 return Bool(c.productVariables.ArtTargetIncludeDebugBuild)
2279 }
2280
2281 return Bool(c.productVariables.Eng)
2282}
Inseob Kimd8538e52024-07-31 02:00:41 +00002283
2284func (c *config) SystemPropFiles(ctx PathContext) Paths {
2285 return PathsForSource(ctx, c.productVariables.SystemPropFiles)
2286}
Inseob Kim6bd92d52024-07-31 02:01:03 +00002287
Inseob Kimacf91742024-08-05 12:51:05 +09002288func (c *config) SystemExtPropFiles(ctx PathContext) Paths {
2289 return PathsForSource(ctx, c.productVariables.SystemExtPropFiles)
2290}
2291
Inseob Kim01d4f8b2024-08-08 17:47:14 +09002292func (c *config) ProductPropFiles(ctx PathContext) Paths {
2293 return PathsForSource(ctx, c.productVariables.ProductPropFiles)
2294}
2295
Inseob Kim9a22c7e2024-08-26 15:58:09 +09002296func (c *config) OdmPropFiles(ctx PathContext) Paths {
2297 return PathsForSource(ctx, c.productVariables.OdmPropFiles)
2298}
2299
Spandan Das859cdef2024-10-25 21:06:18 +00002300func (c *config) VendorPropFiles(ctx PathContext) Paths {
2301 return PathsForSource(ctx, c.productVariables.VendorPropFiles)
2302}
2303
Inseob Kim6bd92d52024-07-31 02:01:03 +00002304func (c *config) EnableUffdGc() string {
2305 return String(c.productVariables.EnableUffdGc)
2306}
Bill Yang3b3aac02024-09-05 09:22:09 +00002307
2308func (c *config) DeviceFrameworkCompatibilityMatrixFile() []string {
2309 return c.productVariables.DeviceFrameworkCompatibilityMatrixFile
2310}
2311
2312func (c *config) DeviceProductCompatibilityMatrixFile() []string {
2313 return c.productVariables.DeviceProductCompatibilityMatrixFile
2314}
2315
2316func (c *config) BoardAvbEnable() bool {
2317 return Bool(c.productVariables.BoardAvbEnable)
2318}
2319
2320func (c *config) BoardAvbSystemAddHashtreeFooterArgs() []string {
2321 return c.productVariables.BoardAvbSystemAddHashtreeFooterArgs
2322}
Spandan Das950deca2024-10-01 18:35:23 +00002323
2324// Returns true if RELEASE_INSTALL_APEX_SYSTEMSERVER_DEXPREOPT_SAME_PARTITION is set to true.
2325// If true, dexpreopt files of apex system server jars will be installed in the same partition as the parent apex.
2326// If false, all these files will be installed in /system partition.
2327func (c Config) InstallApexSystemServerDexpreoptSamePartition() bool {
2328 return c.config.productVariables.GetBuildFlagBool("RELEASE_INSTALL_APEX_SYSTEMSERVER_DEXPREOPT_SAME_PARTITION")
2329}
Bill Yang42816dc2024-10-07 10:02:31 +00002330
2331func (c *config) DeviceMatrixFile() []string {
2332 return c.productVariables.DeviceMatrixFile
2333}
2334
2335func (c *config) ProductManifestFiles() []string {
2336 return c.productVariables.ProductManifestFiles
2337}
2338
2339func (c *config) SystemManifestFile() []string {
2340 return c.productVariables.SystemManifestFile
2341}
2342
2343func (c *config) SystemExtManifestFiles() []string {
2344 return c.productVariables.SystemExtManifestFiles
2345}
Bill Yang7ab86602024-11-01 03:08:47 +00002346
2347func (c *config) DeviceManifestFiles() []string {
2348 return c.productVariables.DeviceManifestFiles
2349}
2350
2351func (c *config) OdmManifestFiles() []string {
2352 return c.productVariables.OdmManifestFiles
2353}