blob: 686e861ff1b7318f84f25061d6132332d1bb42f1 [file] [log] [blame]
Colin Cross3f40fa42015-01-30 17:27:36 -08001// Copyright 2015 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
Colin Cross635c3b02016-05-18 15:37:25 -070015package android
Colin Cross3f40fa42015-01-30 17:27:36 -080016
Jingwen Chenc711fec2020-11-22 23:52:50 -050017// This is the primary location to write and read all configuration values and
18// product variables necessary for soong_build's operation.
19
Colin Cross3f40fa42015-01-30 17:27:36 -080020import (
Colin Cross3f40fa42015-01-30 17:27:36 -080021 "encoding/json"
22 "fmt"
23 "os"
Colin Cross35cec122015-04-02 14:37:16 -070024 "path/filepath"
Colin Cross3f40fa42015-01-30 17:27:36 -080025 "runtime"
Inseob Kim60c32f02020-12-21 22:53:05 +090026 "strconv"
Dan Willemsen34cc69e2015-09-23 15:26:20 -070027 "strings"
Colin Crossc1e86a32015-04-15 12:33:28 -070028 "sync"
Cole Faustd92430e2024-02-07 01:02:04 +000029 "unicode"
Colin Cross6ff51382015-12-17 16:39:19 -080030
Yu Liu67a28422024-03-05 00:36:31 +000031 "android/soong/shared"
32
Colin Cross98be1bb2019-12-13 20:41:13 -080033 "github.com/google/blueprint"
Colin Crosse87040b2017-12-11 15:52:26 -080034 "github.com/google/blueprint/bootstrap"
Colin Cross98be1bb2019-12-13 20:41:13 -080035 "github.com/google/blueprint/pathtools"
Colin Cross6ff51382015-12-17 16:39:19 -080036 "github.com/google/blueprint/proptools"
Colin Cross9d34f352019-11-22 16:03:51 -080037
38 "android/soong/android/soongconfig"
Colin Cross77cdcfd2021-03-12 11:28:25 -080039 "android/soong/remoteexec"
Colin Cross3f40fa42015-01-30 17:27:36 -080040)
41
Jingwen Chenc711fec2020-11-22 23:52:50 -050042// Bool re-exports proptools.Bool for the android package.
Colin Cross6ff51382015-12-17 16:39:19 -080043var Bool = proptools.Bool
Jingwen Chenc711fec2020-11-22 23:52:50 -050044
45// String re-exports proptools.String for the android package.
Jack He8cc71432016-12-08 15:45:07 -080046var String = proptools.String
Jingwen Chenc711fec2020-11-22 23:52:50 -050047
48// StringDefault re-exports proptools.StringDefault for the android package.
Jeongik Cha219141c2020-08-06 23:00:37 +090049var StringDefault = proptools.StringDefault
Jiyong Park6a927c42020-01-21 02:03:43 +090050
Jingwen Chenc711fec2020-11-22 23:52:50 -050051// FutureApiLevelInt is a placeholder constant for unreleased API levels.
Dan Albert0b176c82020-07-23 16:43:25 -070052const FutureApiLevelInt = 10000
53
Spandan Das15da5882023-03-02 23:36:39 +000054// PrivateApiLevel represents the api level of SdkSpecPrivate (sdk_version: "")
55// This api_level exists to differentiate user-provided "" from "current" sdk_version
56// The differentiation is necessary to enable different validation rules for these two possible values.
57var PrivateApiLevel = ApiLevel{
58 value: "current", // The value is current since aidl expects `current` as the default (TestAidlFlagsWithMinSdkVersion)
59 number: FutureApiLevelInt + 1, // This is used to differentiate it from FutureApiLevel
60 isPreview: true,
61}
62
Jingwen Chenc711fec2020-11-22 23:52:50 -050063// FutureApiLevel represents unreleased API levels.
Dan Albert0b176c82020-07-23 16:43:25 -070064var FutureApiLevel = ApiLevel{
65 value: "current",
66 number: FutureApiLevelInt,
67 isPreview: true,
68}
Colin Cross6ff51382015-12-17 16:39:19 -080069
Jingwen Chenc4d91bc2020-11-24 22:59:26 -050070// The product variables file name, containing product config from Kati.
Dan Willemsen87b17d12015-07-14 00:39:06 -070071const productVariablesFileName = "soong.variables"
Colin Cross3f40fa42015-01-30 17:27:36 -080072
Colin Cross9272ade2016-08-17 15:24:12 -070073// A Config object represents the entire build configuration for Android.
Colin Crossc3c0a492015-04-10 15:43:55 -070074type Config struct {
75 *config
76}
77
Chris Parsonsad876012022-08-20 14:48:32 -040078type SoongBuildMode int
79
Sasha Smundakaf5ca922022-12-12 21:23:34 -080080type CmdArgs struct {
81 bootstrap.Args
Kiyoung Kima37d9ba2023-04-19 13:13:45 +090082 RunGoTests bool
83 OutDir string
84 SoongOutDir string
85 SoongVariables string
Sasha Smundakaf5ca922022-12-12 21:23:34 -080086
Colin Crossb63d7b32023-12-07 16:54:51 -080087 BazelQueryViewDir string
88 ModuleGraphFile string
89 ModuleActionsFile string
90 DocFile string
Sasha Smundakaf5ca922022-12-12 21:23:34 -080091
Jihoon Kang2a929ad2023-06-08 19:02:07 +000092 BuildFromSourceStub bool
MarkDacekf47e1422023-04-19 16:47:36 +000093
94 EnsureAllowlistIntegrity bool
Sasha Smundakaf5ca922022-12-12 21:23:34 -080095}
96
Chris Parsonsad876012022-08-20 14:48:32 -040097// Build modes that soong_build can run as.
98const (
99 // Don't use bazel at all during module analysis.
100 AnalysisNoBazel SoongBuildMode = iota
101
Chris Parsonsad876012022-08-20 14:48:32 -0400102 // Generate BUILD files which faithfully represent the dependency graph of
103 // blueprint modules. Individual BUILD targets will not, however, faitfhully
104 // express build semantics.
105 GenerateQueryView
106
107 // Create a JSON representation of the module graph and exit.
108 GenerateModuleGraph
109
110 // Generate a documentation file for module type definitions and exit.
111 GenerateDocFile
Chris Parsonsad876012022-08-20 14:48:32 -0400112)
113
Inseob Kim8fa54da2024-03-19 16:48:59 +0900114const testKeyDir = "build/make/target/product/security"
115
Lukacs T. Berkib078ade2021-08-31 10:42:08 +0200116// SoongOutDir returns the build output directory for the configuration.
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200117func (c Config) SoongOutDir() string {
118 return c.soongOutDir
Jeff Gastonefc1b412017-03-29 17:29:06 -0700119}
120
Colin Cross31a67452023-11-02 16:57:08 -0700121// tempDir returns the path to out/soong/.temp, which is cleared at the beginning of every build.
122func (c Config) tempDir() string {
123 return shared.TempDirForOutDir(c.soongOutDir)
124}
125
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200126func (c Config) OutDir() string {
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200127 return c.outDir
Lukacs T. Berki89e9a162021-03-12 08:31:32 +0100128}
129
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200130func (c Config) RunGoTests() bool {
131 return c.runGoTests
132}
133
Lukacs T. Berki5f6cb1d2021-03-17 15:03:14 +0100134func (c Config) DebugCompilation() bool {
135 return false // Never compile Go code in the main build for debugging
136}
137
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200138func (c Config) Subninjas() []string {
139 return []string{}
140}
141
142func (c Config) PrimaryBuilderInvocations() []bootstrap.PrimaryBuilderInvocation {
143 return []bootstrap.PrimaryBuilderInvocation{}
144}
145
Paul Duffin74135582022-10-06 11:01:59 +0100146// RunningInsideUnitTest returns true if this code is being run as part of a Soong unit test.
147func (c Config) RunningInsideUnitTest() bool {
148 return c.config.TestProductVariables != nil
149}
150
Pratyushfaec4db2023-07-20 11:19:04 +0000151// DisableHiddenApiChecks returns true if hiddenapi checks have been disabled.
Alyssa Ketpreechasawat7daf2782023-11-01 13:58:39 +0000152// For 'eng' target variant hiddenapi checks are disabled by default for performance optimisation,
Pratyushfaec4db2023-07-20 11:19:04 +0000153// but can be enabled by setting environment variable ENABLE_HIDDENAPI_FLAGS=true.
154// For other target variants hiddenapi check are enabled by default but can be disabled by
155// setting environment variable UNSAFE_DISABLE_HIDDENAPI_FLAGS=true.
156// If both ENABLE_HIDDENAPI_FLAGS=true and UNSAFE_DISABLE_HIDDENAPI_FLAGS=true, then
157// ENABLE_HIDDENAPI_FLAGS=true will be triggered and hiddenapi checks will be considered enabled.
158func (c Config) DisableHiddenApiChecks() bool {
159 return !c.IsEnvTrue("ENABLE_HIDDENAPI_FLAGS") &&
160 (c.IsEnvTrue("UNSAFE_DISABLE_HIDDENAPI_FLAGS") ||
Alyssa Ketpreechasawat7daf2782023-11-01 13:58:39 +0000161 Bool(c.productVariables.Eng))
162}
163
164// DisableVerifyOverlaps returns true if verify_overlaps is skipped.
165// Mismatch in version of apexes and module SDK is required for mainline prebuilts to work in
166// trunk stable.
167// Thus, verify_overlaps is disabled when RELEASE_DEFAULT_MODULE_BUILD_FROM_SOURCE is set to false.
168// TODO(b/308174018): Re-enable verify_overlaps for both builr from source/mainline prebuilts.
169func (c Config) DisableVerifyOverlaps() bool {
Spandan Das07145102024-03-18 23:25:30 +0000170 if c.IsEnvFalse("DISABLE_VERIFY_OVERLAPS") && c.ReleaseDisableVerifyOverlaps() {
171 panic("The current release configuration does not support verify_overlaps. DISABLE_VERIFY_OVERLAPS cannot be set to false")
172 }
173 return c.IsEnvTrue("DISABLE_VERIFY_OVERLAPS") || c.ReleaseDisableVerifyOverlaps() || !c.ReleaseDefaultModuleBuildFromSource()
Pratyushfaec4db2023-07-20 11:19:04 +0000174}
175
Qing Shen713c5422024-08-23 04:09:18 +0000176func (c Config) CoverageSuffix() string {
177 if v := c.IsEnvTrue("EMMA_INSTRUMENT"); v {
178 return "coverage."
179 }
180 return ""
181}
182
Juan Yescas05d4d902023-04-07 10:35:35 -0700183// MaxPageSizeSupported returns the max page size supported by the device. This
184// value will define the ELF segment alignment for binaries (executables and
185// shared libraries).
186func (c Config) MaxPageSizeSupported() string {
187 return String(c.config.productVariables.DeviceMaxPageSizeSupported)
188}
189
Vilas Bhatb3d2d222023-12-04 22:51:20 +0000190// NoBionicPageSizeMacro returns true when AOSP is page size agnostic.
191// This means that the bionic's macro PAGE_SIZE won't be defined.
192// Returns false when AOSP is NOT page size agnostic.
193// This means that bionic's macro PAGE_SIZE is defined.
194func (c Config) NoBionicPageSizeMacro() bool {
195 return Bool(c.config.productVariables.DeviceNoBionicPageSizeMacro)
Juan Yescas01065602023-08-09 08:34:37 -0700196}
197
Joe Onoratofee845a2023-05-09 08:14:14 -0700198// The release version passed to aconfig, derived from RELEASE_VERSION
199func (c Config) ReleaseVersion() string {
200 return c.config.productVariables.ReleaseVersion
201}
202
Yu Liu2cc802a2023-09-05 17:19:45 -0700203// The aconfig value set passed to aconfig, derived from RELEASE_VERSION
Yu Liueebb2592023-10-12 20:31:27 -0700204func (c Config) ReleaseAconfigValueSets() []string {
Yu Liu95572ff2023-12-07 16:38:45 -0800205 return c.config.productVariables.ReleaseAconfigValueSets
Joe Onoratofee845a2023-05-09 08:14:14 -0700206}
207
LaMont Jones21d04d92024-06-11 11:28:54 -0700208func (c Config) ReleaseAconfigExtraReleaseConfigs() []string {
209 result := []string{}
210 if val, ok := c.config.productVariables.BuildFlags["RELEASE_ACONFIG_EXTRA_RELEASE_CONFIGS"]; ok {
211 if len(val) > 0 {
212 // Remove any duplicates from the list.
213 found := make(map[string]bool)
214 for _, k := range strings.Split(val, " ") {
215 if !found[k] {
216 found[k] = true
217 result = append(result, k)
218 }
219 }
220 }
221 }
222 return result
223}
224
225func (c Config) ReleaseAconfigExtraReleaseConfigsValueSets() map[string][]string {
226 result := make(map[string][]string)
227 for _, rcName := range c.ReleaseAconfigExtraReleaseConfigs() {
228 if value, ok := c.config.productVariables.BuildFlags["RELEASE_ACONFIG_VALUE_SETS_"+rcName]; ok {
229 result[rcName] = strings.Split(value, " ")
230 }
231 }
232 return result
233}
234
Zhi Dou3f65a412023-08-10 21:47:40 +0000235// The flag default permission value passed to aconfig
236// derived from RELEASE_ACONFIG_FLAG_DEFAULT_PERMISSION
237func (c Config) ReleaseAconfigFlagDefaultPermission() string {
238 return c.config.productVariables.ReleaseAconfigFlagDefaultPermission
239}
240
Yi Kong76e99ad2024-09-18 18:43:26 +0000241// Enable object size sanitizer
242func (c Config) ReleaseBuildObjectSizeSanitizer() bool {
243 return c.config.productVariables.GetBuildFlagBool("RELEASE_BUILD_OBJECT_SIZE_SANITIZER")
244}
245
Alyssa Ketpreechasawat34ab8792023-10-06 07:01:22 +0000246// The flag indicating behavior for the tree wrt building modules or using prebuilts
247// derived from RELEASE_DEFAULT_MODULE_BUILD_FROM_SOURCE
248func (c Config) ReleaseDefaultModuleBuildFromSource() bool {
249 return c.config.productVariables.ReleaseDefaultModuleBuildFromSource == nil ||
250 Bool(c.config.productVariables.ReleaseDefaultModuleBuildFromSource)
251}
252
Alyssa Ketpreechasawat3a6eced2024-08-22 15:09:16 +0000253func (c Config) ReleaseDefaultUpdatableModuleVersion() string {
254 if val, exists := c.GetBuildFlag("RELEASE_DEFAULT_UPDATABLE_MODULE_VERSION"); exists {
255 return val
256 }
257 panic("RELEASE_DEFAULT_UPDATABLE_MODULE_VERSION is missing from build flags.")
258}
259
Spandan Das07145102024-03-18 23:25:30 +0000260func (c Config) ReleaseDisableVerifyOverlaps() bool {
261 return c.config.productVariables.GetBuildFlagBool("RELEASE_DISABLE_VERIFY_OVERLAPS_CHECK")
262}
263
Jihoon Kang59198152024-02-06 22:43:18 +0000264// Enables flagged apis annotated with READ_WRITE aconfig flags to be included in the stubs
265// and hiddenapi flags so that they are accessible at runtime
266func (c Config) ReleaseExportRuntimeApis() bool {
Jihoon Kang35349462024-02-22 19:52:46 +0000267 return Bool(c.config.productVariables.ExportRuntimeApis)
Jihoon Kang59198152024-02-06 22:43:18 +0000268}
269
Aleksei Vetrov146e9822023-11-24 19:54:26 +0000270// Enables ABI monitoring of NDK libraries
271func (c Config) ReleaseNdkAbiMonitored() bool {
272 return c.config.productVariables.GetBuildFlagBool("RELEASE_NDK_ABI_MONITORED")
273}
274
Ted Bauer10fff942024-04-29 19:30:23 +0000275// Enable read flag from new storage, for C/C++
276func (c Config) ReleaseReadFromNewStorageCc() bool {
277 return c.config.productVariables.GetBuildFlagBool("RELEASE_READ_FROM_NEW_STORAGE_CC")
278}
279
Jihoon Kangbd093452023-12-26 19:08:01 +0000280func (c Config) ReleaseHiddenApiExportableStubs() bool {
Jihoon Kangb36fc542024-02-22 19:35:26 +0000281 return c.config.productVariables.GetBuildFlagBool("RELEASE_HIDDEN_API_EXPORTABLE_STUBS") ||
282 Bool(c.config.productVariables.HiddenapiExportableStubs)
Jihoon Kangbd093452023-12-26 19:08:01 +0000283}
284
Dennis Shen58378c92024-04-03 19:26:36 +0000285// Enable read flag from new storage
286func (c Config) ReleaseReadFromNewStorage() bool {
287 return c.config.productVariables.GetBuildFlagBool("RELEASE_READ_FROM_NEW_STORAGE")
288}
289
Spandan Das3d9b69e2024-10-07 19:03:45 +0000290func (c Config) ReleaseCreateAconfigStorageFile() bool {
291 return c.config.productVariables.GetBuildFlagBool("RELEASE_CREATE_ACONFIG_STORAGE_FILE")
292}
293
Jingwen Chenc711fec2020-11-22 23:52:50 -0500294// A DeviceConfig object represents the configuration for a particular device
295// being built. For now there will only be one of these, but in the future there
296// may be multiple devices being built.
Colin Cross9272ade2016-08-17 15:24:12 -0700297type DeviceConfig struct {
298 *deviceConfig
299}
300
Jingwen Chenc711fec2020-11-22 23:52:50 -0500301// VendorConfig represents the configuration for vendor-specific behavior.
Colin Cross9d34f352019-11-22 16:03:51 -0800302type VendorConfig soongconfig.SoongConfig
Dan Willemsen0fe78662018-03-26 12:41:18 -0700303
Jingwen Chenc711fec2020-11-22 23:52:50 -0500304// Definition of general build configuration for soong_build. Some of these
Jingwen Chenc4d91bc2020-11-24 22:59:26 -0500305// product configuration values are read from Kati-generated soong.variables.
Colin Cross1332b002015-04-07 17:11:30 -0700306type config struct {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500307 // Options configurable with soong.variables
Cole Faustf8231dd2023-04-21 17:37:11 -0700308 productVariables ProductVariables
Colin Cross3f40fa42015-01-30 17:27:36 -0800309
Dan Willemsen674dc7f2018-03-12 18:06:05 -0700310 // Only available on configs created by TestConfig
Cole Faustf8231dd2023-04-21 17:37:11 -0700311 TestProductVariables *ProductVariables
Dan Willemsen674dc7f2018-03-12 18:06:05 -0700312
Dan Willemsen87b17d12015-07-14 00:39:06 -0700313 ProductVariablesFileName string
314
Colin Cross0c66bc62021-07-20 09:47:41 -0700315 // BuildOS stores the OsType for the OS that the build is running on.
316 BuildOS OsType
317
318 // BuildArch stores the ArchType for the CPU that the build is running on.
319 BuildArch ArchType
320
Jaewoong Jung642916f2020-10-09 17:25:15 -0700321 Targets map[OsType][]Target
322 BuildOSTarget Target // the Target for tools run on the build machine
323 BuildOSCommonTarget Target // the Target for common (java) tools run on the build machine
324 AndroidCommonTarget Target // the Target for common modules for the Android device
325 AndroidFirstDeviceTarget Target // the first Target for modules for the Android device
Dan Willemsen218f6562015-07-08 18:13:11 -0700326
LaMont Jones99f18962024-10-17 11:50:44 -0700327 // Flags for Partial Compile, derived from SOONG_PARTIAL_COMPILE.
328 partialCompileFlags partialCompileFlags
329
Jingwen Chenc711fec2020-11-22 23:52:50 -0500330 // multilibConflicts for an ArchType is true if there is earlier configured
331 // device architecture with the same multilib value.
Colin Cross3b19f5d2019-09-17 14:45:31 -0700332 multilibConflicts map[ArchType]bool
333
Colin Cross9272ade2016-08-17 15:24:12 -0700334 deviceConfig *deviceConfig
335
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200336 outDir string // The output directory (usually out/)
337 soongOutDir string
Chris Parsons8f232a22020-06-23 17:37:05 -0400338 moduleListFile string // the path to the file which lists blueprint files to parse.
Colin Crossc1e86a32015-04-15 12:33:28 -0700339
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +0200340 runGoTests bool
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200341
Colin Cross6ccbc912017-10-10 23:07:38 -0700342 env map[string]string
Dan Willemsene7680ba2015-09-11 17:06:19 -0700343 envLock sync.Mutex
344 envDeps map[string]string
345 envFrozen bool
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800346
Jingwen Chencda22c92020-11-23 00:22:30 -0500347 // Changes behavior based on whether Kati runs after soong_build, or if soong_build
348 // runs standalone.
349 katiEnabled bool
Colin Cross1e7d3702016-08-24 15:25:47 -0700350
Colin Cross32616ed2017-09-05 21:56:44 -0700351 captureBuild bool // true for tests, saves build parameters for each module
352 ignoreEnvironment bool // true for tests, returns empty from all Getenv calls
Colin Crosscec81712017-07-13 14:43:27 -0700353
Colin Cross98be1bb2019-12-13 20:41:13 -0800354 fs pathtools.FileSystem
355 mockBpList string
356
Colin Crossb63d7b32023-12-07 16:54:51 -0800357 BuildMode SoongBuildMode
Jingwen Chen12b4c272021-03-10 02:05:59 -0500358
Colin Cross5e6a7972020-06-07 16:56:32 -0700359 // If testAllowNonExistentPaths is true then PathForSource and PathForModuleSrc won't error
360 // in tests when a path doesn't exist.
Pedro Loureiro5d190cc2021-02-15 15:41:33 +0000361 TestAllowNonExistentPaths bool
Colin Cross5e6a7972020-06-07 16:56:32 -0700362
Jingwen Chenc711fec2020-11-22 23:52:50 -0500363 // The list of files that when changed, must invalidate soong_build to
364 // regenerate build.ninja.
Colin Cross12129292020-10-29 18:23:58 -0700365 ninjaFileDepsSet sync.Map
366
Colin Cross9272ade2016-08-17 15:24:12 -0700367 OncePer
MarkDacekff851b82022-04-21 18:33:17 +0000368
Jihoon Kang2a929ad2023-06-08 19:02:07 +0000369 // If buildFromSourceStub is true then the Java API stubs are
370 // built from the source Java files, not the signature text files.
371 buildFromSourceStub bool
MarkDacekf47e1422023-04-19 16:47:36 +0000372
373 // If ensureAllowlistIntegrity is true, then the presence of any allowlisted
374 // modules that aren't mixed-built for at least one variant will cause a build
375 // failure
376 ensureAllowlistIntegrity bool
Colin Cross9272ade2016-08-17 15:24:12 -0700377}
378
LaMont Jones99f18962024-10-17 11:50:44 -0700379type partialCompileFlags struct {
380 // Is partial compilation enabled at all?
381 enabled bool
382
383 // Whether to use d8 instead of r8
384 use_d8 bool
385
386 // Add others as needed.
387}
388
Colin Cross9272ade2016-08-17 15:24:12 -0700389type deviceConfig struct {
Dan Willemsen00269f22017-07-06 16:59:48 -0700390 config *config
Colin Cross9272ade2016-08-17 15:24:12 -0700391 OncePer
Colin Cross3f40fa42015-01-30 17:27:36 -0800392}
393
Colin Cross485e5722015-08-27 13:28:01 -0700394type jsonConfigurable interface {
Colin Cross27385972015-09-18 10:57:10 -0700395 SetDefaultConfig()
Colin Cross485e5722015-08-27 13:28:01 -0700396}
Colin Cross3f40fa42015-01-30 17:27:36 -0800397
LaMont Jones99f18962024-10-17 11:50:44 -0700398// Parse SOONG_PARTIAL_COMPILE.
399//
400// SOONG_PARTIAL_COMPILE determines which features are enabled or disabled in
401// rule generation. Changing this environment variable causes reanalysis.
402//
403// SOONG_USE_PARTIAL_COMPILE determines whether or not we **use** PARTIAL_COMPILE.
404// Rule generation must support both cases, since changing it does not cause
405// reanalysis.
406//
407// The user-facing documentation shows:
408//
409// - empty or not set: "The current default state"
410// - "true" or "on": enable all stable partial compile features.
411// - "false" or "off": disable partial compile completely.
412//
413// What we actually allow is a comma separated list of tokens, whose first
414// character may be "+" (enable) or "-" (disable). If neither is present, "+"
415// is assumed. For example, "on,+use_d8" will enable partial compilation, and
416// additionally set the use_d8 flag (regardless of whether it is opt-in or
417// opt-out).
418//
419// To add a new feature to the list, add the field in the struct
420// `partialCompileFlags` above, and then add the name of the field in the
421// switch statement below.
422func (c *config) parsePartialCompileFlags() (partialCompileFlags, error) {
423 defaultFlags := partialCompileFlags{
424 // Set any opt-out flags here. Opt-in flags are off by default.
425 enabled: false,
426 }
427 value := c.Getenv("SOONG_PARTIAL_COMPILE")
428
429 if value == "" {
430 return defaultFlags, nil
431 }
432
433 ret := defaultFlags
434 tokens := strings.Split(strings.ToLower(value), ",")
435 makeVal := func(state string, defaultValue bool) bool {
436 switch state {
437 case "":
438 return defaultValue
439 case "-":
440 return false
441 case "+":
442 return true
443 }
444 return false
445 }
446 for _, tok := range tokens {
447 var state string
448 if len(tok) == 0 {
449 continue
450 }
451 switch tok[0:1] {
452 case "":
453 // Ignore empty tokens.
454 continue
455 case "-", "+":
456 state = tok[0:1]
457 tok = tok[1:]
458 default:
459 // Treat `feature` as `+feature`.
460 state = "+"
461 }
462 switch tok {
463 case "true":
464 ret = defaultFlags
465 ret.enabled = true
466 case "false":
467 // Set everything to false.
468 ret = partialCompileFlags{}
469 case "enabled":
470 ret.enabled = makeVal(state, defaultFlags.enabled)
471 case "use_d8":
472 ret.use_d8 = makeVal(state, defaultFlags.use_d8)
473 default:
474 return partialCompileFlags{}, fmt.Errorf("Unknown SOONG_PARTIAL_COMPILE value: %v", value)
475 }
476 }
477 return ret, nil
478}
479
Colin Cross485e5722015-08-27 13:28:01 -0700480func loadConfig(config *config) error {
Colin Cross988414c2020-01-11 01:11:46 +0000481 return loadFromConfigFile(&config.productVariables, absolutePath(config.ProductVariablesFileName))
Colin Cross485e5722015-08-27 13:28:01 -0700482}
483
Cole Faustd92430e2024-02-07 01:02:04 +0000484// Checks if the string is a valid go identifier. This is equivalent to blueprint's definition
485// of an identifier, so it will match the same identifiers as those that can be used in bp files.
486func isGoIdentifier(ident string) bool {
487 for i, r := range ident {
488 valid := r == '_' || unicode.IsLetter(r) || unicode.IsDigit(r) && i > 0
489 if !valid {
490 return false
491 }
492 }
493 return len(ident) > 0
494}
495
Jingwen Chenc711fec2020-11-22 23:52:50 -0500496// loadFromConfigFile loads and decodes configuration options from a JSON file
497// in the current working directory.
Cole Faustf8231dd2023-04-21 17:37:11 -0700498func loadFromConfigFile(configurable *ProductVariables, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800499 // Try to open the file
Colin Cross485e5722015-08-27 13:28:01 -0700500 configFileReader, err := os.Open(filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800501 defer configFileReader.Close()
502 if os.IsNotExist(err) {
503 // Need to create a file, so that blueprint & ninja don't get in
504 // a dependency tracking loop.
505 // Make a file-configurable-options with defaults, write it out using
506 // a json writer.
Colin Cross27385972015-09-18 10:57:10 -0700507 configurable.SetDefaultConfig()
508 err = saveToConfigFile(configurable, filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800509 if err != nil {
510 return err
511 }
Colin Cross15cd21a2018-02-27 11:26:02 -0800512 } else if err != nil {
513 return fmt.Errorf("config file: could not open %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800514 } else {
515 // Make a decoder for it
516 jsonDecoder := json.NewDecoder(configFileReader)
Cole Fauste1129b82024-06-04 11:10:11 -0700517 jsonDecoder.DisallowUnknownFields()
Colin Cross485e5722015-08-27 13:28:01 -0700518 err = jsonDecoder.Decode(configurable)
Colin Cross3f40fa42015-01-30 17:27:36 -0800519 if err != nil {
Colin Cross15cd21a2018-02-27 11:26:02 -0800520 return fmt.Errorf("config file: %s did not parse correctly: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800521 }
522 }
523
Liz Kammer09f947d2021-05-12 14:51:49 -0400524 if Bool(configurable.GcovCoverage) && Bool(configurable.ClangCoverage) {
525 return fmt.Errorf("GcovCoverage and ClangCoverage cannot both be set")
526 }
527
528 configurable.Native_coverage = proptools.BoolPtr(
529 Bool(configurable.GcovCoverage) ||
530 Bool(configurable.ClangCoverage))
531
Cole Faustd92430e2024-02-07 01:02:04 +0000532 // The go scanner's definition of identifiers is c-style identifiers, but allowing unicode's
533 // definition of letters and digits. This is the same scanner that blueprint uses, so it
534 // will allow the same identifiers as are valid in bp files.
535 for namespace := range configurable.VendorVars {
536 if !isGoIdentifier(namespace) {
537 return fmt.Errorf("soong config namespaces must be valid identifiers: %q", namespace)
538 }
539 for variable := range configurable.VendorVars[namespace] {
540 if !isGoIdentifier(variable) {
541 return fmt.Errorf("soong config variables must be valid identifiers: %q", variable)
542 }
543 }
544 }
545
Yuntao Xu402e9b02021-08-09 15:44:44 -0700546 // when Platform_sdk_final is true (or PLATFORM_VERSION_CODENAME is REL), use Platform_sdk_version;
547 // if false (pre-released version, for example), use Platform_sdk_codename.
548 if Bool(configurable.Platform_sdk_final) {
549 if configurable.Platform_sdk_version != nil {
550 configurable.Platform_sdk_version_or_codename =
551 proptools.StringPtr(strconv.Itoa(*(configurable.Platform_sdk_version)))
552 } else {
553 return fmt.Errorf("Platform_sdk_version cannot be pointed by a NULL pointer")
554 }
555 } else {
556 configurable.Platform_sdk_version_or_codename =
557 proptools.StringPtr(String(configurable.Platform_sdk_codename))
558 }
559
Cole Faustad186492024-06-14 14:13:54 -0700560 return nil
Colin Cross3f40fa42015-01-30 17:27:36 -0800561}
562
Colin Crossd8f20142016-11-03 09:43:26 -0700563// atomically writes the config file in case two copies of soong_build are running simultaneously
564// (for example, docs generation and ninja manifest generation)
Cole Faustf8231dd2023-04-21 17:37:11 -0700565func saveToConfigFile(config *ProductVariables, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800566 data, err := json.MarshalIndent(&config, "", " ")
567 if err != nil {
568 return fmt.Errorf("cannot marshal config data: %s", err.Error())
569 }
570
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800571 f, err := os.CreateTemp(filepath.Dir(filename), "config")
Colin Cross3f40fa42015-01-30 17:27:36 -0800572 if err != nil {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500573 return fmt.Errorf("cannot create empty config file %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800574 }
Colin Crossd8f20142016-11-03 09:43:26 -0700575 defer os.Remove(f.Name())
576 defer f.Close()
Colin Cross3f40fa42015-01-30 17:27:36 -0800577
Colin Crossd8f20142016-11-03 09:43:26 -0700578 _, err = f.Write(data)
Colin Cross3f40fa42015-01-30 17:27:36 -0800579 if err != nil {
Colin Cross485e5722015-08-27 13:28:01 -0700580 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
581 }
582
Colin Crossd8f20142016-11-03 09:43:26 -0700583 _, err = f.WriteString("\n")
Colin Cross485e5722015-08-27 13:28:01 -0700584 if err != nil {
585 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800586 }
587
Colin Crossd8f20142016-11-03 09:43:26 -0700588 f.Close()
589 os.Rename(f.Name(), filename)
590
Colin Cross3f40fa42015-01-30 17:27:36 -0800591 return nil
592}
593
Colin Cross988414c2020-01-11 01:11:46 +0000594// NullConfig returns a mostly empty Config for use by standalone tools like dexpreopt_gen that
595// use the android package.
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200596func NullConfig(outDir, soongOutDir string) Config {
Colin Cross988414c2020-01-11 01:11:46 +0000597 return Config{
598 config: &config{
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200599 outDir: outDir,
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200600 soongOutDir: soongOutDir,
601 fs: pathtools.OsFs,
Colin Cross988414c2020-01-11 01:11:46 +0000602 },
603 }
604}
605
Jingwen Chenc711fec2020-11-22 23:52:50 -0500606// NewConfig creates a new Config object. The srcDir argument specifies the path
607// to the root source directory. It also loads the config file, if found.
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800608func NewConfig(cmdArgs CmdArgs, availableEnv map[string]string) (Config, error) {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500609 // Make a config with default options.
Colin Cross9272ade2016-08-17 15:24:12 -0700610 config := &config{
Kiyoung Kima37d9ba2023-04-19 13:13:45 +0900611 ProductVariablesFileName: cmdArgs.SoongVariables,
Dan Willemsen87b17d12015-07-14 00:39:06 -0700612
Lukacs T. Berki53b2f362021-04-12 14:04:24 +0200613 env: availableEnv,
Colin Cross6ccbc912017-10-10 23:07:38 -0700614
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800615 outDir: cmdArgs.OutDir,
616 soongOutDir: cmdArgs.SoongOutDir,
617 runGoTests: cmdArgs.RunGoTests,
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +0200618 multilibConflicts: make(map[ArchType]bool),
Colin Cross98be1bb2019-12-13 20:41:13 -0800619
Colin Crossb63d7b32023-12-07 16:54:51 -0800620 moduleListFile: cmdArgs.ModuleListFile,
621 fs: pathtools.NewOsFs(absSrcDir),
Chris Parsons9402ca82023-02-23 17:28:06 -0500622
Jihoon Kang2a929ad2023-06-08 19:02:07 +0000623 buildFromSourceStub: cmdArgs.BuildFromSourceStub,
Colin Cross68f55102015-03-25 14:43:57 -0700624 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800625
Dan Willemsen00269f22017-07-06 16:59:48 -0700626 config.deviceConfig = &deviceConfig{
Colin Cross9272ade2016-08-17 15:24:12 -0700627 config: config,
628 }
629
Liz Kammer7941b302020-07-28 13:27:34 -0700630 // Soundness check of the build and source directories. This won't catch strange
631 // configurations with symlinks, but at least checks the obvious case.
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800632 absBuildDir, err := filepath.Abs(cmdArgs.SoongOutDir)
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700633 if err != nil {
634 return Config{}, err
635 }
636
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200637 absSrcDir, err := filepath.Abs(".")
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700638 if err != nil {
639 return Config{}, err
640 }
641
642 if strings.HasPrefix(absSrcDir, absBuildDir) {
643 return Config{}, fmt.Errorf("Build dir must not contain source directory")
644 }
645
Colin Cross3f40fa42015-01-30 17:27:36 -0800646 // Load any configurable options from the configuration file
Colin Cross9272ade2016-08-17 15:24:12 -0700647 err = loadConfig(config)
Colin Cross3f40fa42015-01-30 17:27:36 -0800648 if err != nil {
Colin Crossc3c0a492015-04-10 15:43:55 -0700649 return Config{}, err
Colin Cross3f40fa42015-01-30 17:27:36 -0800650 }
651
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800652 KatiEnabledMarkerFile := filepath.Join(cmdArgs.SoongOutDir, ".soong.kati_enabled")
Jingwen Chencda22c92020-11-23 00:22:30 -0500653 if _, err := os.Stat(absolutePath(KatiEnabledMarkerFile)); err == nil {
654 config.katiEnabled = true
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800655 }
656
Colin Cross0c66bc62021-07-20 09:47:41 -0700657 determineBuildOS(config)
658
Jingwen Chenc711fec2020-11-22 23:52:50 -0500659 // Sets up the map of target OSes to the finer grained compilation targets
660 // that are configured from the product variables.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700661 targets, err := decodeTargetProductVariables(config)
Dan Willemsen218f6562015-07-08 18:13:11 -0700662 if err != nil {
663 return Config{}, err
664 }
665
LaMont Jones99f18962024-10-17 11:50:44 -0700666 config.partialCompileFlags, err = config.parsePartialCompileFlags()
667 if err != nil {
668 return Config{}, err
669 }
670
Paul Duffin1356d8c2020-02-25 19:26:33 +0000671 // Make the CommonOS OsType available for all products.
672 targets[CommonOS] = []Target{commonTargetMap[CommonOS.Name]}
673
Dan Albert4098deb2016-10-19 14:04:41 -0700674 var archConfig []archConfig
Jingwen Chenc4d91bc2020-11-24 22:59:26 -0500675 if config.NdkAbis() {
Dan Albert4098deb2016-10-19 14:04:41 -0700676 archConfig = getNdkAbisConfig()
Martin Stjernholmc1ecc432019-11-15 15:00:31 +0000677 } else if config.AmlAbis() {
678 archConfig = getAmlAbisConfig()
Dan Albert4098deb2016-10-19 14:04:41 -0700679 }
680
681 if archConfig != nil {
Liz Kammerb7f33662022-02-28 14:16:16 -0500682 androidTargets, err := decodeAndroidArchSettings(archConfig)
Dan Willemsen322acaf2016-01-12 23:07:05 -0800683 if err != nil {
684 return Config{}, err
685 }
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700686 targets[Android] = androidTargets
Dan Willemsen322acaf2016-01-12 23:07:05 -0800687 }
688
Colin Cross3b19f5d2019-09-17 14:45:31 -0700689 multilib := make(map[string]bool)
690 for _, target := range targets[Android] {
691 if seen := multilib[target.Arch.ArchType.Multilib]; seen {
692 config.multilibConflicts[target.Arch.ArchType] = true
693 }
694 multilib[target.Arch.ArchType.Multilib] = true
695 }
696
Jingwen Chenc711fec2020-11-22 23:52:50 -0500697 // Map of OS to compilation targets.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700698 config.Targets = targets
Jingwen Chenc711fec2020-11-22 23:52:50 -0500699
700 // Compilation targets for host tools.
Colin Cross0c66bc62021-07-20 09:47:41 -0700701 config.BuildOSTarget = config.Targets[config.BuildOS][0]
702 config.BuildOSCommonTarget = getCommonTargets(config.Targets[config.BuildOS])[0]
Jingwen Chenc711fec2020-11-22 23:52:50 -0500703
704 // Compilation targets for Android.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700705 if len(config.Targets[Android]) > 0 {
706 config.AndroidCommonTarget = getCommonTargets(config.Targets[Android])[0]
Sam Delmericocc271e22022-06-01 15:45:02 +0000707 config.AndroidFirstDeviceTarget = FirstTarget(config.Targets[Android], "lib64", "lib32")[0]
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700708 }
Dan Willemsen218f6562015-07-08 18:13:11 -0700709
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500710 setBuildMode := func(arg string, mode SoongBuildMode) {
711 if arg != "" {
712 if config.BuildMode != AnalysisNoBazel {
713 fmt.Fprintf(os.Stderr, "buildMode is already set, illegal argument: %s", arg)
714 os.Exit(1)
715 }
716 config.BuildMode = mode
717 }
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800718 }
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500719 setBuildMode(cmdArgs.BazelQueryViewDir, GenerateQueryView)
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500720 setBuildMode(cmdArgs.ModuleGraphFile, GenerateModuleGraph)
721 setBuildMode(cmdArgs.DocFile, GenerateDocFile)
MarkDacekd06db5d2022-11-29 00:47:59 +0000722
Jihoon Kangc1b04d62023-11-16 19:07:04 +0000723 config.productVariables.Build_from_text_stub = boolPtr(config.BuildFromTextStub())
724
Jingwen Chenc711fec2020-11-22 23:52:50 -0500725 return Config{config}, err
726}
Colin Cross988414c2020-01-11 01:11:46 +0000727
Colin Cross98be1bb2019-12-13 20:41:13 -0800728// mockFileSystem replaces all reads with accesses to the provided map of
729// filenames to contents stored as a byte slice.
730func (c *config) mockFileSystem(bp string, fs map[string][]byte) {
731 mockFS := map[string][]byte{}
732
733 if _, exists := mockFS["Android.bp"]; !exists {
734 mockFS["Android.bp"] = []byte(bp)
735 }
736
737 for k, v := range fs {
738 mockFS[k] = v
739 }
740
741 // no module list file specified; find every file named Blueprints or Android.bp
742 pathsToParse := []string{}
743 for candidate := range mockFS {
744 base := filepath.Base(candidate)
Lukacs T. Berkib838b0a2021-09-02 11:46:24 +0200745 if base == "Android.bp" {
Colin Cross98be1bb2019-12-13 20:41:13 -0800746 pathsToParse = append(pathsToParse, candidate)
747 }
748 }
749 if len(pathsToParse) < 1 {
750 panic(fmt.Sprintf("No Blueprint or Android.bp files found in mock filesystem: %v\n", mockFS))
751 }
752 mockFS[blueprint.MockModuleListFile] = []byte(strings.Join(pathsToParse, "\n"))
753
754 c.fs = pathtools.MockFs(mockFS)
755 c.mockBpList = blueprint.MockModuleListFile
756}
757
Lukacs T. Berkid1e3f1f2021-03-16 08:55:23 +0100758func (c *config) SetAllowMissingDependencies() {
759 c.productVariables.Allow_missing_dependencies = proptools.BoolPtr(true)
760}
761
Jingwen Chenc711fec2020-11-22 23:52:50 -0500762// BlueprintToolLocation returns the directory containing build system tools
763// from Blueprint, like soong_zip and merge_zips.
Lukacs T. Berkia806e412021-09-01 08:57:48 +0200764func (c *config) HostToolDir() string {
Colin Crossacfcc1f2021-10-25 15:40:32 -0700765 if c.KatiEnabled() {
766 return filepath.Join(c.outDir, "host", c.PrebuiltOS(), "bin")
767 } else {
768 return filepath.Join(c.soongOutDir, "host", c.PrebuiltOS(), "bin")
769 }
Dan Willemsenc2aa4a92016-05-26 15:13:03 -0700770}
771
Dan Willemsen60e62f02018-11-16 21:05:32 -0800772func (c *config) HostToolPath(ctx PathContext, tool string) Path {
Cole Faust3b703f32023-10-16 13:30:51 -0700773 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "bin", tool)
Colin Cross790ef352021-10-25 19:15:55 -0700774 return path
Dan Willemsen60e62f02018-11-16 21:05:32 -0800775}
776
Colin Cross790ef352021-10-25 19:15:55 -0700777func (c *config) HostJNIToolPath(ctx PathContext, lib string) Path {
Martin Stjernholm7260d062019-12-09 21:47:14 +0000778 ext := ".so"
779 if runtime.GOOS == "darwin" {
780 ext = ".dylib"
781 }
Cole Faust3b703f32023-10-16 13:30:51 -0700782 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "lib64", lib+ext)
Colin Cross790ef352021-10-25 19:15:55 -0700783 return path
Martin Stjernholm7260d062019-12-09 21:47:14 +0000784}
785
Colin Crossae5330a2021-11-03 13:31:22 -0700786func (c *config) HostJavaToolPath(ctx PathContext, tool string) Path {
Cole Faust3b703f32023-10-16 13:30:51 -0700787 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "framework", tool)
Colin Cross3e3eda62021-11-04 10:22:51 -0700788 return path
789}
790
Vinh Tran09581952023-05-16 16:03:20 -0400791func (c *config) HostCcSharedLibPath(ctx PathContext, lib string) Path {
792 libDir := "lib"
793 if ctx.Config().BuildArch.Multilib == "lib64" {
794 libDir = "lib64"
795 }
Cole Faust3b703f32023-10-16 13:30:51 -0700796 return pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, libDir, lib+".so")
Vinh Tran09581952023-05-16 16:03:20 -0400797}
798
Jingwen Chenc711fec2020-11-22 23:52:50 -0500799// PrebuiltOS returns the name of the host OS used in prebuilts directories.
Colin Cross1332b002015-04-07 17:11:30 -0700800func (c *config) PrebuiltOS() string {
Colin Cross3f40fa42015-01-30 17:27:36 -0800801 switch runtime.GOOS {
802 case "linux":
803 return "linux-x86"
804 case "darwin":
805 return "darwin-x86"
806 default:
807 panic("Unknown GOOS")
808 }
809}
810
811// GoRoot returns the path to the root directory of the Go toolchain.
Colin Cross1332b002015-04-07 17:11:30 -0700812func (c *config) GoRoot() string {
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200813 return fmt.Sprintf("prebuilts/go/%s", c.PrebuiltOS())
Colin Cross3f40fa42015-01-30 17:27:36 -0800814}
815
Jingwen Chenc711fec2020-11-22 23:52:50 -0500816// PrebuiltBuildTool returns the path to a tool in the prebuilts directory containing
817// checked-in tools, like Kati, Ninja or Toybox, for the current host OS.
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700818func (c *config) PrebuiltBuildTool(ctx PathContext, tool string) Path {
819 return PathForSource(ctx, "prebuilts/build-tools", c.PrebuiltOS(), "bin", tool)
820}
821
Jingwen Chenc711fec2020-11-22 23:52:50 -0500822// CpPreserveSymlinksFlags returns the host-specific flag for the cp(1) command
823// to preserve symlinks.
Colin Cross1332b002015-04-07 17:11:30 -0700824func (c *config) CpPreserveSymlinksFlags() string {
Colin Cross485e5722015-08-27 13:28:01 -0700825 switch runtime.GOOS {
Colin Cross3f40fa42015-01-30 17:27:36 -0800826 case "darwin":
827 return "-R"
828 case "linux":
829 return "-d"
830 default:
831 return ""
832 }
833}
Colin Cross68f55102015-03-25 14:43:57 -0700834
Colin Cross1332b002015-04-07 17:11:30 -0700835func (c *config) Getenv(key string) string {
Colin Cross68f55102015-03-25 14:43:57 -0700836 var val string
837 var exists bool
Colin Crossc1e86a32015-04-15 12:33:28 -0700838 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800839 defer c.envLock.Unlock()
840 if c.envDeps == nil {
841 c.envDeps = make(map[string]string)
842 }
Colin Cross68f55102015-03-25 14:43:57 -0700843 if val, exists = c.envDeps[key]; !exists {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700844 if c.envFrozen {
845 panic("Cannot access new environment variables after envdeps are frozen")
846 }
Colin Cross6ccbc912017-10-10 23:07:38 -0700847 val, _ = c.env[key]
Colin Cross68f55102015-03-25 14:43:57 -0700848 c.envDeps[key] = val
849 }
850 return val
851}
852
Colin Cross99d7c232016-11-23 16:52:04 -0800853func (c *config) GetenvWithDefault(key string, defaultValue string) string {
854 ret := c.Getenv(key)
855 if ret == "" {
856 return defaultValue
857 }
858 return ret
859}
860
861func (c *config) IsEnvTrue(key string) bool {
AdityaK19384102024-05-01 13:51:25 -0700862 value := strings.ToLower(c.Getenv(key))
Colin Cross99d7c232016-11-23 16:52:04 -0800863 return value == "1" || value == "y" || value == "yes" || value == "on" || value == "true"
864}
865
866func (c *config) IsEnvFalse(key string) bool {
AdityaK19384102024-05-01 13:51:25 -0700867 value := strings.ToLower(c.Getenv(key))
Colin Cross99d7c232016-11-23 16:52:04 -0800868 return value == "0" || value == "n" || value == "no" || value == "off" || value == "false"
869}
870
Sorin Basca253f8c02024-05-23 10:28:24 +0100871func (c *config) TargetsJava21() bool {
872 return c.IsEnvTrue("EXPERIMENTAL_TARGET_JAVA_VERSION_21")
873}
874
Jingwen Chenc711fec2020-11-22 23:52:50 -0500875// EnvDeps returns the environment variables this build depends on. The first
876// call to this function blocks future reads from the environment.
Colin Cross1332b002015-04-07 17:11:30 -0700877func (c *config) EnvDeps() map[string]string {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700878 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800879 defer c.envLock.Unlock()
Dan Willemsene7680ba2015-09-11 17:06:19 -0700880 c.envFrozen = true
Colin Cross68f55102015-03-25 14:43:57 -0700881 return c.envDeps
882}
Colin Cross35cec122015-04-02 14:37:16 -0700883
Jingwen Chencda22c92020-11-23 00:22:30 -0500884func (c *config) KatiEnabled() bool {
885 return c.katiEnabled
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800886}
887
Cole Faust11edf552023-10-13 11:32:14 -0700888func (c *config) ProductVariables() ProductVariables {
889 return c.productVariables
890}
891
Nan Zhang581fd212018-01-10 16:06:12 -0800892func (c *config) BuildId() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800893 return String(c.productVariables.BuildId)
Nan Zhang581fd212018-01-10 16:06:12 -0800894}
895
Inseob Kim8fa54da2024-03-19 16:48:59 +0900896func (c *config) DisplayBuildNumber() bool {
897 return Bool(c.productVariables.DisplayBuildNumber)
898}
899
Inseob Kim2da72af2024-06-18 11:09:12 +0900900// BuildFingerprintFile returns the path to a text file containing metadata
901// representing the current build's fingerprint.
902//
903// Rules that want to reference the build fingerprint should read from this file
904// without depending on it. They will run whenever their other dependencies
905// require them to run and get the current build fingerprint. This ensures they
906// don't rebuild on every incremental build when the build number changes.
907func (c *config) BuildFingerprintFile(ctx PathContext) Path {
908 return PathForArbitraryOutput(ctx, "target", "product", c.DeviceName(), String(c.productVariables.BuildFingerprintFile))
909}
910
Jingwen Chenc711fec2020-11-22 23:52:50 -0500911// BuildNumberFile returns the path to a text file containing metadata
912// representing the current build's number.
913//
914// Rules that want to reference the build number should read from this file
915// without depending on it. They will run whenever their other dependencies
916// require them to run and get the current build number. This ensures they don't
917// rebuild on every incremental build when the build number changes.
Colin Cross2a2e0db2020-02-21 16:55:46 -0800918func (c *config) BuildNumberFile(ctx PathContext) Path {
919 return PathForOutput(ctx, String(c.productVariables.BuildNumberFile))
Nan Zhang581fd212018-01-10 16:06:12 -0800920}
921
Inseob Kim8fa54da2024-03-19 16:48:59 +0900922// BuildHostnameFile returns the path to a text file containing metadata
923// representing the current build's host name.
924func (c *config) BuildHostnameFile(ctx PathContext) Path {
925 return PathForOutput(ctx, String(c.productVariables.BuildHostnameFile))
926}
927
928// BuildThumbprintFile returns the path to a text file containing metadata
929// representing the current build's thumbprint.
930//
931// Rules that want to reference the build thumbprint should read from this file
932// without depending on it. They will run whenever their other dependencies
933// require them to run and get the current build thumbprint. This ensures they
934// don't rebuild on every incremental build when the build thumbprint changes.
935func (c *config) BuildThumbprintFile(ctx PathContext) Path {
936 return PathForArbitraryOutput(ctx, "target", "product", c.DeviceName(), String(c.productVariables.BuildThumbprintFile))
937}
938
Jingwen Chenc711fec2020-11-22 23:52:50 -0500939// DeviceName returns the name of the current device target.
Colin Cross35cec122015-04-02 14:37:16 -0700940// TODO: take an AndroidModuleContext to select the device name for multi-device builds
Colin Cross1332b002015-04-07 17:11:30 -0700941func (c *config) DeviceName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800942 return *c.productVariables.DeviceName
Colin Cross35cec122015-04-02 14:37:16 -0700943}
944
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000945// DeviceProduct returns the current product target. There could be multiple of
946// these per device type.
947//
Chris Parsonsef615e52022-08-18 22:04:11 -0400948// NOTE: Do not base conditional logic on this value. It may break product inheritance.
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000949func (c *config) DeviceProduct() string {
950 return *c.productVariables.DeviceProduct
951}
952
Cole Faustb85d1a12022-11-08 18:14:01 -0800953// HasDeviceProduct returns if the build has a product. A build will not
954// necessarily have a product when --skip-config is passed to soong, like it is
955// in prebuilts/build-tools/build-prebuilts.sh
956func (c *config) HasDeviceProduct() bool {
957 return c.productVariables.DeviceProduct != nil
958}
959
Inseob Kim8fa54da2024-03-19 16:48:59 +0900960func (c *config) DeviceAbi() []string {
961 return c.productVariables.DeviceAbi
962}
963
Anton Hansson53c88442019-03-18 15:53:16 +0000964func (c *config) DeviceResourceOverlays() []string {
965 return c.productVariables.DeviceResourceOverlays
966}
967
968func (c *config) ProductResourceOverlays() []string {
969 return c.productVariables.ProductResourceOverlays
Colin Cross30e076a2015-04-13 13:58:27 -0700970}
971
Inseob Kim8fa54da2024-03-19 16:48:59 +0900972func (c *config) PlatformDisplayVersionName() string {
973 return String(c.productVariables.Platform_display_version_name)
974}
975
Colin Crossbfd347d2018-05-09 11:11:35 -0700976func (c *config) PlatformVersionName() string {
977 return String(c.productVariables.Platform_version_name)
978}
979
Dan Albert4f378d72020-07-23 17:32:15 -0700980func (c *config) PlatformSdkVersion() ApiLevel {
981 return uncheckedFinalApiLevel(*c.productVariables.Platform_sdk_version)
Colin Cross30e076a2015-04-13 13:58:27 -0700982}
983
Cole Faust37d27c42023-04-12 10:27:45 -0700984func (c *config) RawPlatformSdkVersion() *int {
985 return c.productVariables.Platform_sdk_version
986}
987
Mu-Le Lee5e047532022-07-27 02:32:03 +0000988func (c *config) PlatformSdkFinal() bool {
989 return Bool(c.productVariables.Platform_sdk_final)
990}
991
Colin Crossd09b0b62018-04-18 11:06:47 -0700992func (c *config) PlatformSdkCodename() string {
993 return String(c.productVariables.Platform_sdk_codename)
994}
995
Anton Hansson97d0bae2022-02-16 16:15:10 +0000996func (c *config) PlatformSdkExtensionVersion() int {
997 return *c.productVariables.Platform_sdk_extension_version
998}
999
1000func (c *config) PlatformBaseSdkExtensionVersion() int {
1001 return *c.productVariables.Platform_base_sdk_extension_version
1002}
1003
Colin Cross092c9da2019-04-02 22:56:43 -07001004func (c *config) PlatformSecurityPatch() string {
1005 return String(c.productVariables.Platform_security_patch)
1006}
1007
1008func (c *config) PlatformPreviewSdkVersion() string {
1009 return String(c.productVariables.Platform_preview_sdk_version)
1010}
1011
1012func (c *config) PlatformMinSupportedTargetSdkVersion() string {
Linus Tufvessonba270c52024-04-12 13:06:22 +02001013 var val, ok = c.productVariables.BuildFlags["RELEASE_PLATFORM_MIN_SUPPORTED_TARGET_SDK_VERSION"]
1014 if !ok {
1015 return ""
1016 }
1017 return val
Colin Cross092c9da2019-04-02 22:56:43 -07001018}
1019
1020func (c *config) PlatformBaseOS() string {
1021 return String(c.productVariables.Platform_base_os)
1022}
1023
Inseob Kim4f1f3d92022-04-25 18:23:58 +09001024func (c *config) PlatformVersionLastStable() string {
1025 return String(c.productVariables.Platform_version_last_stable)
1026}
1027
Jiyong Park37073842022-06-21 10:13:42 +09001028func (c *config) PlatformVersionKnownCodenames() string {
1029 return String(c.productVariables.Platform_version_known_codenames)
1030}
1031
Dan Albert1a246272020-07-06 14:49:35 -07001032func (c *config) MinSupportedSdkVersion() ApiLevel {
Dan Albert6bfb6bb2022-08-17 20:11:57 +00001033 return uncheckedFinalApiLevel(21)
Dan Albert1a246272020-07-06 14:49:35 -07001034}
1035
1036func (c *config) FinalApiLevels() []ApiLevel {
1037 var levels []ApiLevel
Dan Albert4f378d72020-07-23 17:32:15 -07001038 for i := 1; i <= c.PlatformSdkVersion().FinalOrFutureInt(); i++ {
Dan Albert1a246272020-07-06 14:49:35 -07001039 levels = append(levels, uncheckedFinalApiLevel(i))
1040 }
1041 return levels
1042}
1043
1044func (c *config) PreviewApiLevels() []ApiLevel {
1045 var levels []ApiLevel
Dan Albertf93ea132023-10-05 20:40:46 +00001046 i := 0
1047 for _, codename := range c.PlatformVersionActiveCodenames() {
1048 if codename == "REL" {
1049 continue
1050 }
1051
Dan Albert1a246272020-07-06 14:49:35 -07001052 levels = append(levels, ApiLevel{
1053 value: codename,
1054 number: i,
1055 isPreview: true,
1056 })
Dan Albertf93ea132023-10-05 20:40:46 +00001057 i++
Dan Albert1a246272020-07-06 14:49:35 -07001058 }
1059 return levels
1060}
1061
satayevcca4ab72021-11-30 12:33:55 +00001062func (c *config) LatestPreviewApiLevel() ApiLevel {
1063 level := NoneApiLevel
1064 for _, l := range c.PreviewApiLevels() {
1065 if l.GreaterThan(level) {
1066 level = l
1067 }
1068 }
1069 return level
1070}
1071
Dan Albert1a246272020-07-06 14:49:35 -07001072func (c *config) AllSupportedApiLevels() []ApiLevel {
1073 var levels []ApiLevel
1074 levels = append(levels, c.FinalApiLevels()...)
1075 return append(levels, c.PreviewApiLevels()...)
Dan Albertf5415d72017-08-17 16:19:59 -07001076}
1077
Jingwen Chenc711fec2020-11-22 23:52:50 -05001078// DefaultAppTargetSdk returns the API level that platform apps are targeting.
1079// This converts a codename to the exact ApiLevel it represents.
Dan Albert4f378d72020-07-23 17:32:15 -07001080func (c *config) DefaultAppTargetSdk(ctx EarlyModuleContext) ApiLevel {
Colin Crossd09b0b62018-04-18 11:06:47 -07001081 if Bool(c.productVariables.Platform_sdk_final) {
1082 return c.PlatformSdkVersion()
Colin Crossd09b0b62018-04-18 11:06:47 -07001083 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001084 codename := c.PlatformSdkCodename()
Jiyong Park3a00e3d2023-03-27 17:39:48 +09001085 hostOnlyBuild := c.productVariables.DeviceArch == nil
Jingwen Chenc711fec2020-11-22 23:52:50 -05001086 if codename == "" {
Jiyong Park3a00e3d2023-03-27 17:39:48 +09001087 // There are some host-only builds (those are invoked by build-prebuilts.sh) which
1088 // don't set platform sdk codename. Platform sdk codename makes sense only when we
1089 // are building the platform. So we don't enforce the below panic for the host-only
1090 // builds.
1091 if hostOnlyBuild {
1092 return NoneApiLevel
1093 }
1094 panic("Platform_sdk_codename must be set")
Jingwen Chenc711fec2020-11-22 23:52:50 -05001095 }
1096 if codename == "REL" {
1097 panic("Platform_sdk_codename should not be REL when Platform_sdk_final is true")
1098 }
1099 return ApiLevelOrPanic(ctx, codename)
Colin Crossd09b0b62018-04-18 11:06:47 -07001100}
1101
LaMont Jones99f18962024-10-17 11:50:44 -07001102func (c *config) PartialCompileFlags() partialCompileFlags {
1103 return c.partialCompileFlags
1104}
1105
Colin Cross3bc7ffa2017-11-22 16:19:37 -08001106func (c *config) AppsDefaultVersionName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001107 return String(c.productVariables.AppsDefaultVersionName)
Colin Cross3bc7ffa2017-11-22 16:19:37 -08001108}
1109
Dan Albert31384de2017-07-28 12:39:46 -07001110// Codenames that are active in the current lunch target.
1111func (c *config) PlatformVersionActiveCodenames() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001112 return c.productVariables.Platform_version_active_codenames
Dan Albert31384de2017-07-28 12:39:46 -07001113}
1114
Dan Albert8c7a9942023-03-27 20:34:01 +00001115// All unreleased codenames.
1116func (c *config) PlatformVersionAllPreviewCodenames() []string {
1117 return c.productVariables.Platform_version_all_preview_codenames
1118}
1119
Colin Crossface4e42017-10-30 17:32:15 -07001120func (c *config) ProductAAPTConfig() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001121 return c.productVariables.AAPTConfig
Colin Cross30e076a2015-04-13 13:58:27 -07001122}
1123
Colin Crossface4e42017-10-30 17:32:15 -07001124func (c *config) ProductAAPTPreferredConfig() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001125 return String(c.productVariables.AAPTPreferredConfig)
Colin Cross30e076a2015-04-13 13:58:27 -07001126}
1127
Colin Crossface4e42017-10-30 17:32:15 -07001128func (c *config) ProductAAPTCharacteristics() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001129 return String(c.productVariables.AAPTCharacteristics)
Colin Crossface4e42017-10-30 17:32:15 -07001130}
1131
1132func (c *config) ProductAAPTPrebuiltDPI() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001133 return c.productVariables.AAPTPrebuiltDPI
Colin Cross30e076a2015-04-13 13:58:27 -07001134}
1135
Dan Willemsen34cc69e2015-09-23 15:26:20 -07001136func (c *config) DefaultAppCertificateDir(ctx PathContext) SourcePath {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001137 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -08001138 if defaultCert != "" {
1139 return PathForSource(ctx, filepath.Dir(defaultCert))
Colin Cross61ae0b72017-12-01 17:16:02 -08001140 }
Inseob Kim8fa54da2024-03-19 16:48:59 +09001141 return PathForSource(ctx, testKeyDir)
Colin Cross30e076a2015-04-13 13:58:27 -07001142}
1143
Colin Crosse1731a52017-12-14 11:22:55 -08001144func (c *config) DefaultAppCertificate(ctx PathContext) (pem, key SourcePath) {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001145 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -08001146 if defaultCert != "" {
Colin Crosse1731a52017-12-14 11:22:55 -08001147 return PathForSource(ctx, defaultCert+".x509.pem"), PathForSource(ctx, defaultCert+".pk8")
Colin Cross61ae0b72017-12-01 17:16:02 -08001148 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001149 defaultDir := c.DefaultAppCertificateDir(ctx)
1150 return defaultDir.Join(ctx, "testkey.x509.pem"), defaultDir.Join(ctx, "testkey.pk8")
Colin Cross30e076a2015-04-13 13:58:27 -07001151}
Colin Cross6ff51382015-12-17 16:39:19 -08001152
Justin Yun635e7882024-07-04 14:50:57 +09001153func (c *config) ExtraOtaKeys(ctx PathContext, recovery bool) []SourcePath {
1154 var otaKeys []string
1155 if recovery {
1156 otaKeys = c.productVariables.ExtraOtaRecoveryKeys
1157 } else {
1158 otaKeys = c.productVariables.ExtraOtaKeys
1159 }
1160
1161 otaPaths := make([]SourcePath, len(otaKeys))
1162 for i, key := range otaKeys {
1163 otaPaths[i] = PathForSource(ctx, key+".x509.pem")
1164 }
1165
1166 return otaPaths
1167}
1168
Inseob Kim8fa54da2024-03-19 16:48:59 +09001169func (c *config) BuildKeys() string {
1170 defaultCert := String(c.productVariables.DefaultAppCertificate)
1171 if defaultCert == "" || defaultCert == filepath.Join(testKeyDir, "testkey") {
1172 return "test-keys"
1173 }
1174 return "dev-keys"
1175}
1176
Jiyong Park9335a262018-12-24 11:31:58 +09001177func (c *config) ApexKeyDir(ctx ModuleContext) SourcePath {
1178 // TODO(b/121224311): define another variable such as TARGET_APEX_KEY_OVERRIDE
1179 defaultCert := String(c.productVariables.DefaultAppCertificate)
Inseob Kim8fa54da2024-03-19 16:48:59 +09001180 if defaultCert == "" || filepath.Dir(defaultCert) == testKeyDir {
Jiyong Park9335a262018-12-24 11:31:58 +09001181 // When defaultCert is unset or is set to the testkeys path, use the APEX keys
1182 // that is under the module dir
Colin Cross07e51612019-03-05 12:46:40 -08001183 return pathForModuleSrc(ctx)
Jiyong Park9335a262018-12-24 11:31:58 +09001184 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001185 // If not, APEX keys are under the specified directory
1186 return PathForSource(ctx, filepath.Dir(defaultCert))
Jiyong Park9335a262018-12-24 11:31:58 +09001187}
1188
Inseob Kim80fa7982022-08-12 21:36:25 +09001189// Certificate for the NetworkStack sepolicy context
1190func (c *config) MainlineSepolicyDevCertificatesDir(ctx ModuleContext) SourcePath {
1191 cert := String(c.productVariables.MainlineSepolicyDevCertificates)
1192 if cert != "" {
1193 return PathForSource(ctx, cert)
1194 }
1195 return c.DefaultAppCertificateDir(ctx)
1196}
1197
Jingwen Chenc711fec2020-11-22 23:52:50 -05001198// AllowMissingDependencies configures Blueprint/Soong to not fail when modules
1199// are configured to depend on non-existent modules. Note that this does not
1200// affect missing input dependencies at the Ninja level.
Colin Cross6ff51382015-12-17 16:39:19 -08001201func (c *config) AllowMissingDependencies() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001202 return Bool(c.productVariables.Allow_missing_dependencies)
Colin Cross6ff51382015-12-17 16:39:19 -08001203}
Dan Willemsen322acaf2016-01-12 23:07:05 -08001204
Jeongik Cha816a23a2020-07-08 01:09:23 +09001205// Returns true if a full platform source tree cannot be assumed.
Colin Crossfc3674a2017-09-18 17:41:52 -07001206func (c *config) UnbundledBuild() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001207 return Bool(c.productVariables.Unbundled_build)
Colin Crossfc3674a2017-09-18 17:41:52 -07001208}
1209
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +01001210// Returns true if building apps that aren't bundled with the platform.
1211// UnbundledBuild() is always true when this is true.
1212func (c *config) UnbundledBuildApps() bool {
Cole Faust701ca252021-11-23 19:02:08 -08001213 return len(c.productVariables.Unbundled_build_apps) > 0
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +01001214}
1215
Jeongik Cha4b073cd2021-06-08 11:35:00 +09001216// Returns true if building image that aren't bundled with the platform.
1217// UnbundledBuild() is always true when this is true.
1218func (c *config) UnbundledBuildImage() bool {
1219 return Bool(c.productVariables.Unbundled_build_image)
1220}
1221
Jeongik Cha816a23a2020-07-08 01:09:23 +09001222// Returns true if building modules against prebuilt SDKs.
1223func (c *config) AlwaysUsePrebuiltSdks() bool {
1224 return Bool(c.productVariables.Always_use_prebuilt_sdks)
Colin Cross1f367bf2018-12-18 22:46:24 -08001225}
1226
Colin Cross126a25c2017-10-31 13:55:34 -07001227func (c *config) MinimizeJavaDebugInfo() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001228 return Bool(c.productVariables.MinimizeJavaDebugInfo) && !Bool(c.productVariables.Eng)
Colin Cross126a25c2017-10-31 13:55:34 -07001229}
1230
Colin Crossed064c02018-09-05 16:28:13 -07001231func (c *config) Debuggable() bool {
1232 return Bool(c.productVariables.Debuggable)
1233}
1234
Jaewoong Jung1d6eb682018-11-29 15:08:44 -08001235func (c *config) Eng() bool {
1236 return Bool(c.productVariables.Eng)
1237}
1238
Inseob Kim8fa54da2024-03-19 16:48:59 +09001239func (c *config) BuildType() string {
1240 return String(c.productVariables.BuildType)
1241}
1242
Colin Crossc53c37f2021-12-08 15:42:22 -08001243// DevicePrimaryArchType returns the ArchType for the first configured device architecture, or
1244// Common if there are no device architectures.
Jiyong Park8d52f862018-07-07 18:02:07 +09001245func (c *config) DevicePrimaryArchType() ArchType {
Colin Crossc53c37f2021-12-08 15:42:22 -08001246 if androidTargets := c.Targets[Android]; len(androidTargets) > 0 {
1247 return androidTargets[0].Arch.ArchType
1248 }
1249 return Common
Jiyong Park8d52f862018-07-07 18:02:07 +09001250}
1251
Colin Cross16b23492016-01-06 14:41:07 -08001252func (c *config) SanitizeHost() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001253 return append([]string(nil), c.productVariables.SanitizeHost...)
Colin Cross16b23492016-01-06 14:41:07 -08001254}
1255
1256func (c *config) SanitizeDevice() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001257 return append([]string(nil), c.productVariables.SanitizeDevice...)
Colin Cross23ae82a2016-11-02 14:34:39 -07001258}
1259
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -07001260func (c *config) SanitizeDeviceDiag() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001261 return append([]string(nil), c.productVariables.SanitizeDeviceDiag...)
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -07001262}
1263
Colin Cross23ae82a2016-11-02 14:34:39 -07001264func (c *config) SanitizeDeviceArch() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001265 return append([]string(nil), c.productVariables.SanitizeDeviceArch...)
Colin Cross16b23492016-01-06 14:41:07 -08001266}
Colin Crossa1ad8d12016-06-01 17:09:44 -07001267
Vishwath Mohan1b017a72017-01-19 13:54:55 -08001268func (c *config) EnableCFI() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001269 if c.productVariables.EnableCFI == nil {
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -08001270 return true
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -08001271 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001272 return *c.productVariables.EnableCFI
Vishwath Mohan1b017a72017-01-19 13:54:55 -08001273}
1274
Kostya Kortchinskyd5275c82019-02-01 08:42:56 -08001275func (c *config) DisableScudo() bool {
1276 return Bool(c.productVariables.DisableScudo)
1277}
1278
Colin Crossa1ad8d12016-06-01 17:09:44 -07001279func (c *config) Android64() bool {
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001280 for _, t := range c.Targets[Android] {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001281 if t.Arch.ArchType.Multilib == "lib64" {
1282 return true
1283 }
1284 }
1285
1286 return false
1287}
Colin Cross9272ade2016-08-17 15:24:12 -07001288
Colin Cross9d45bb72016-08-29 16:14:13 -07001289func (c *config) UseGoma() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001290 return Bool(c.productVariables.UseGoma)
Colin Cross9d45bb72016-08-29 16:14:13 -07001291}
1292
Taylor Santiago3c16e612024-05-30 14:41:31 -07001293func (c *config) UseABFS() bool {
1294 return Bool(c.productVariables.UseABFS)
1295}
1296
Ramy Medhatbbf25672019-07-17 12:30:04 +00001297func (c *config) UseRBE() bool {
1298 return Bool(c.productVariables.UseRBE)
1299}
1300
Ramy Medhat8ea054a2020-01-27 14:19:44 -05001301func (c *config) UseRBEJAVAC() bool {
1302 return Bool(c.productVariables.UseRBEJAVAC)
1303}
1304
1305func (c *config) UseRBER8() bool {
1306 return Bool(c.productVariables.UseRBER8)
1307}
1308
1309func (c *config) UseRBED8() bool {
1310 return Bool(c.productVariables.UseRBED8)
1311}
1312
Colin Cross8b8bec32019-11-15 13:18:43 -08001313func (c *config) UseRemoteBuild() bool {
1314 return c.UseGoma() || c.UseRBE()
1315}
1316
Colin Cross66548102018-06-19 22:47:35 -07001317func (c *config) RunErrorProne() bool {
1318 return c.IsEnvTrue("RUN_ERROR_PRONE")
1319}
1320
Jingwen Chenc711fec2020-11-22 23:52:50 -05001321// XrefCorpusName returns the Kythe cross-reference corpus name.
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001322func (c *config) XrefCorpusName() string {
1323 return c.Getenv("XREF_CORPUS")
1324}
1325
Jingwen Chenc711fec2020-11-22 23:52:50 -05001326// XrefCuEncoding returns the compilation unit encoding to use for Kythe code
1327// xrefs. Can be 'json' (default), 'proto' or 'all'.
Sasha Smundak6c2d4f92020-01-09 17:34:23 -08001328func (c *config) XrefCuEncoding() string {
1329 if enc := c.Getenv("KYTHE_KZIP_ENCODING"); enc != "" {
1330 return enc
1331 }
1332 return "json"
1333}
1334
Sasha Smundakb0addaf2021-02-16 10:39:40 -08001335// XrefCuJavaSourceMax returns the maximum number of the Java source files
1336// in a single compilation unit
1337const xrefJavaSourceFileMaxDefault = "1000"
1338
1339func (c Config) XrefCuJavaSourceMax() string {
1340 v := c.Getenv("KYTHE_JAVA_SOURCE_BATCH_SIZE")
1341 if v == "" {
1342 return xrefJavaSourceFileMaxDefault
1343 }
1344 if _, err := strconv.ParseUint(v, 0, 0); err != nil {
1345 fmt.Fprintf(os.Stderr,
1346 "bad KYTHE_JAVA_SOURCE_BATCH_SIZE value: %s, will use %s",
1347 err, xrefJavaSourceFileMaxDefault)
1348 return xrefJavaSourceFileMaxDefault
1349 }
1350 return v
1351
1352}
1353
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001354func (c *config) EmitXrefRules() bool {
1355 return c.XrefCorpusName() != ""
1356}
1357
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001358func (c *config) ClangTidy() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001359 return Bool(c.productVariables.ClangTidy)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001360}
1361
1362func (c *config) TidyChecks() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001363 if c.productVariables.TidyChecks == nil {
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001364 return ""
1365 }
Dan Willemsen45133ac2018-03-09 21:22:06 -08001366 return *c.productVariables.TidyChecks
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001367}
1368
Colin Cross0f4e0d62016-07-27 10:56:55 -07001369func (c *config) LibartImgHostBaseAddress() string {
David Srbeckya4f336b2024-09-04 16:06:56 +01001370 return "0x70000000"
Colin Cross0f4e0d62016-07-27 10:56:55 -07001371}
1372
1373func (c *config) LibartImgDeviceBaseAddress() string {
Elliott Hughesda3a0712020-03-06 16:55:28 -08001374 return "0x70000000"
Colin Cross0f4e0d62016-07-27 10:56:55 -07001375}
1376
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001377func (c *config) ArtUseReadBarrier() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001378 return Bool(c.productVariables.ArtUseReadBarrier)
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001379}
1380
Jingwen Chenc711fec2020-11-22 23:52:50 -05001381// Enforce Runtime Resource Overlays for a module. RROs supersede static RROs,
1382// but some modules still depend on it.
1383//
1384// More info: https://source.android.com/devices/architecture/rros
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001385func (c *config) EnforceRROForModule(name string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001386 enforceList := c.productVariables.EnforceRROTargets
Jeongik Chacee5ba92021-02-19 12:11:51 +09001387
Roland Levillainf6cc2612020-07-09 16:58:14 +01001388 if len(enforceList) > 0 {
Yo Chiang4ebd06a2019-10-01 13:13:41 +08001389 if InList("*", enforceList) {
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001390 return true
1391 }
Colin Crossa74ca042019-01-31 14:31:51 -08001392 return InList(name, enforceList)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001393 }
1394 return false
1395}
Colin Crossc4441622024-09-18 14:55:49 -07001396
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001397func (c *config) EnforceRROExcludedOverlay(path string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001398 excluded := c.productVariables.EnforceRROExcludedOverlays
Roland Levillainf6cc2612020-07-09 16:58:14 +01001399 if len(excluded) > 0 {
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001400 return HasAnyPrefix(path, excluded)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001401 }
1402 return false
1403}
1404
Colin Crossc4441622024-09-18 14:55:49 -07001405func (c *config) EnforceRROGlobally() bool {
1406 enforceList := c.productVariables.EnforceRROTargets
1407 return InList("*", enforceList)
1408}
1409
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001410func (c *config) ExportedNamespaces() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001411 return append([]string(nil), c.productVariables.NamespacesToExport...)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001412}
1413
Sam Delmerico98a73292023-02-21 11:50:29 -05001414func (c *config) SourceRootDirs() []string {
1415 return c.productVariables.SourceRootDirs
1416}
1417
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001418func (c *config) HostStaticBinaries() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001419 return Bool(c.productVariables.HostStaticBinaries)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001420}
1421
Colin Cross5a0dcd52018-10-05 14:20:06 -07001422func (c *config) UncompressPrivAppDex() bool {
1423 return Bool(c.productVariables.UncompressPrivAppDex)
1424}
1425
1426func (c *config) ModulesLoadedByPrivilegedModules() []string {
1427 return c.productVariables.ModulesLoadedByPrivilegedModules
1428}
1429
Jingwen Chenc711fec2020-11-22 23:52:50 -05001430// DexpreoptGlobalConfigPath returns the path to the dexpreopt.config file in
1431// the output directory, if it was created during the product configuration
1432// phase by Kati.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001433func (c *config) DexpreoptGlobalConfigPath(ctx PathContext) OptionalPath {
Colin Cross988414c2020-01-11 01:11:46 +00001434 if c.productVariables.DexpreoptGlobalConfig == nil {
Jingwen Chenebb0b572020-11-02 00:24:57 -05001435 return OptionalPathForPath(nil)
1436 }
1437 return OptionalPathForPath(
1438 pathForBuildToolDep(ctx, *c.productVariables.DexpreoptGlobalConfig))
1439}
1440
Jingwen Chenc711fec2020-11-22 23:52:50 -05001441// DexpreoptGlobalConfig returns the raw byte contents of the dexpreopt global
1442// configuration. Since the configuration file was created by Kati during
1443// product configuration (externally of soong_build), it's not tracked, so we
1444// also manually add a Ninja file dependency on the configuration file to the
1445// rule that creates the main build.ninja file. This ensures that build.ninja is
1446// regenerated correctly if dexpreopt.config changes.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001447func (c *config) DexpreoptGlobalConfig(ctx PathContext) ([]byte, error) {
1448 path := c.DexpreoptGlobalConfigPath(ctx)
1449 if !path.Valid() {
Colin Cross988414c2020-01-11 01:11:46 +00001450 return nil, nil
1451 }
Jingwen Chenebb0b572020-11-02 00:24:57 -05001452 ctx.AddNinjaFileDeps(path.String())
Sasha Smundakaf5ca922022-12-12 21:23:34 -08001453 return os.ReadFile(absolutePath(path.String()))
Colin Cross43f08db2018-11-12 10:13:39 -08001454}
1455
Inseob Kim7b85eeb2021-03-23 20:52:24 +09001456func (c *deviceConfig) WithDexpreopt() bool {
1457 return c.config.productVariables.WithDexpreopt
1458}
1459
Colin Cross662d6142022-11-03 20:38:01 -07001460func (c *config) FrameworksBaseDirExists(ctx PathGlobContext) bool {
Colin Cross5a756a62021-03-16 16:34:46 -07001461 return ExistentPathForSource(ctx, "frameworks", "base", "Android.bp").Valid()
David Brazdil91b4e3e2019-01-23 21:04:05 +00001462}
1463
Colin Cross3b19f5d2019-09-17 14:45:31 -07001464func (c *config) HasMultilibConflict(arch ArchType) bool {
1465 return c.multilibConflicts[arch]
1466}
1467
Sasha Smundakaf5ca922022-12-12 21:23:34 -08001468func (c *config) PrebuiltHiddenApiDir(_ PathContext) string {
Bill Peckhambae47492021-01-08 09:34:44 -08001469 return String(c.productVariables.PrebuiltHiddenApiDir)
1470}
1471
Justin Yun41cbb5e2023-11-29 17:58:16 +09001472func (c *config) VendorApiLevel() string {
1473 return String(c.productVariables.VendorApiLevel)
1474}
1475
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001476func (c *config) PrevVendorApiLevel() string {
1477 vendorApiLevel, err := strconv.Atoi(c.VendorApiLevel())
1478 if err != nil {
1479 panic(fmt.Errorf("Cannot parse vendor API level %s to an integer: %s",
1480 c.VendorApiLevel(), err))
1481 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001482 // The version before trunk stable is 34.
1483 if vendorApiLevel == 202404 {
1484 return "34"
1485 }
Hsin-Yi Chen890e7722024-03-05 15:56:44 +08001486 if vendorApiLevel >= 1 && vendorApiLevel <= 34 {
1487 return strconv.Itoa(vendorApiLevel - 1)
1488 }
1489 if vendorApiLevel < 202404 || vendorApiLevel%100 != 4 {
1490 panic("Unknown vendor API level " + c.VendorApiLevel())
1491 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001492 return strconv.Itoa(vendorApiLevel - 100)
1493}
1494
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001495func IsTrunkStableVendorApiLevel(level string) bool {
1496 levelInt, err := strconv.Atoi(level)
1497 return err == nil && levelInt >= 202404
1498}
1499
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001500func (c *config) VendorApiLevelFrozen() bool {
1501 return c.productVariables.GetBuildFlagBool("RELEASE_BOARD_API_LEVEL_FROZEN")
1502}
1503
Colin Cross9272ade2016-08-17 15:24:12 -07001504func (c *deviceConfig) Arches() []Arch {
1505 var arches []Arch
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001506 for _, target := range c.config.Targets[Android] {
Colin Cross9272ade2016-08-17 15:24:12 -07001507 arches = append(arches, target.Arch)
1508 }
1509 return arches
1510}
Dan Willemsend2ede872016-11-18 14:54:24 -08001511
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001512func (c *deviceConfig) BinderBitness() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001513 is32BitBinder := c.config.productVariables.Binder32bit
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001514 if is32BitBinder != nil && *is32BitBinder {
1515 return "32"
1516 }
1517 return "64"
1518}
1519
Dan Willemsen4353bc42016-12-05 17:16:02 -08001520func (c *deviceConfig) VendorPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001521 if c.config.productVariables.VendorPath != nil {
1522 return *c.config.productVariables.VendorPath
Dan Willemsen4353bc42016-12-05 17:16:02 -08001523 }
1524 return "vendor"
1525}
1526
Spandan Dase3b65312024-10-22 00:27:27 +00001527func (c *deviceConfig) BuildingVendorImage() bool {
1528 return proptools.Bool(c.config.productVariables.BuildingVendorImage)
1529}
1530
Jeongik Cha219141c2020-08-06 23:00:37 +09001531func (c *deviceConfig) CurrentApiLevelForVendorModules() string {
1532 return StringDefault(c.config.productVariables.DeviceCurrentApiLevelForVendorModules, "current")
1533}
1534
Justin Yun71549282017-11-17 12:10:28 +09001535func (c *deviceConfig) ExtraVndkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001536 return c.config.productVariables.ExtraVndkVersions
Dan Willemsend2ede872016-11-18 14:54:24 -08001537}
Jack He8cc71432016-12-08 15:45:07 -08001538
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001539func (c *deviceConfig) SystemSdkVersions() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001540 return c.config.productVariables.DeviceSystemSdkVersions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001541}
1542
1543func (c *deviceConfig) PlatformSystemSdkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001544 return c.config.productVariables.Platform_systemsdk_versions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001545}
1546
Jiyong Park2db76922017-11-08 16:03:48 +09001547func (c *deviceConfig) OdmPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001548 if c.config.productVariables.OdmPath != nil {
1549 return *c.config.productVariables.OdmPath
Jiyong Park2db76922017-11-08 16:03:48 +09001550 }
1551 return "odm"
1552}
1553
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001554func (c *deviceConfig) ProductPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001555 if c.config.productVariables.ProductPath != nil {
1556 return *c.config.productVariables.ProductPath
Jiyong Park2db76922017-11-08 16:03:48 +09001557 }
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001558 return "product"
Jiyong Park2db76922017-11-08 16:03:48 +09001559}
1560
Jihoon Kang6dd13b62024-10-22 23:21:02 +00001561func (c *deviceConfig) BuildingProductImage() bool {
1562 return proptools.Bool(c.config.productVariables.BuildingProductImage)
1563}
1564
Justin Yund5f6c822019-06-25 16:47:17 +09001565func (c *deviceConfig) SystemExtPath() string {
1566 if c.config.productVariables.SystemExtPath != nil {
1567 return *c.config.productVariables.SystemExtPath
Dario Frenifd05a742018-05-29 13:28:54 +01001568 }
Justin Yund5f6c822019-06-25 16:47:17 +09001569 return "system_ext"
Dario Frenifd05a742018-05-29 13:28:54 +01001570}
1571
Jack He8cc71432016-12-08 15:45:07 -08001572func (c *deviceConfig) BtConfigIncludeDir() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001573 return String(c.config.productVariables.BtConfigIncludeDir)
Jack He8cc71432016-12-08 15:45:07 -08001574}
Dan Willemsen581341d2017-02-09 16:16:31 -08001575
Jiyong Parkd773eb32017-07-03 13:18:12 +09001576func (c *deviceConfig) DeviceKernelHeaderDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001577 return c.config.productVariables.DeviceKernelHeaders
Jiyong Parkd773eb32017-07-03 13:18:12 +09001578}
1579
Roland Levillainada12702020-06-09 13:07:36 +01001580// JavaCoverageEnabledForPath returns whether Java code coverage is enabled for
1581// path. Coverage is enabled by default when the product variable
1582// JavaCoveragePaths is empty. If JavaCoveragePaths is not empty, coverage is
1583// enabled for any path which is part of this variable (and not part of the
1584// JavaCoverageExcludePaths product variable). Value "*" in JavaCoveragePaths
1585// represents any path.
1586func (c *deviceConfig) JavaCoverageEnabledForPath(path string) bool {
1587 coverage := false
Chris Gross2f748692020-06-24 20:36:59 +00001588 if len(c.config.productVariables.JavaCoveragePaths) == 0 ||
Roland Levillainada12702020-06-09 13:07:36 +01001589 InList("*", c.config.productVariables.JavaCoveragePaths) ||
1590 HasAnyPrefix(path, c.config.productVariables.JavaCoveragePaths) {
1591 coverage = true
1592 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001593 if coverage && len(c.config.productVariables.JavaCoverageExcludePaths) > 0 {
Roland Levillainada12702020-06-09 13:07:36 +01001594 if HasAnyPrefix(path, c.config.productVariables.JavaCoverageExcludePaths) {
1595 coverage = false
1596 }
1597 }
1598 return coverage
1599}
1600
Colin Cross1a6acd42020-06-16 17:51:46 -07001601// Returns true if gcov or clang coverage is enabled.
Dan Willemsen581341d2017-02-09 16:16:31 -08001602func (c *deviceConfig) NativeCoverageEnabled() bool {
Colin Cross1a6acd42020-06-16 17:51:46 -07001603 return Bool(c.config.productVariables.GcovCoverage) ||
1604 Bool(c.config.productVariables.ClangCoverage)
Dan Willemsen581341d2017-02-09 16:16:31 -08001605}
1606
Oliver Nguyen1382ab62019-12-06 15:22:41 -08001607func (c *deviceConfig) ClangCoverageEnabled() bool {
1608 return Bool(c.config.productVariables.ClangCoverage)
1609}
1610
Pirama Arumuga Nainarb37ae582022-01-26 22:14:32 -08001611func (c *deviceConfig) ClangCoverageContinuousMode() bool {
1612 return Bool(c.config.productVariables.ClangCoverageContinuousMode)
1613}
1614
Colin Cross1a6acd42020-06-16 17:51:46 -07001615func (c *deviceConfig) GcovCoverageEnabled() bool {
1616 return Bool(c.config.productVariables.GcovCoverage)
1617}
1618
Roland Levillain4f5297b2020-06-09 12:44:06 +01001619// NativeCoverageEnabledForPath returns whether (GCOV- or Clang-based) native
1620// code coverage is enabled for path. By default, coverage is not enabled for a
1621// given path unless it is part of the NativeCoveragePaths product variable (and
1622// not part of the NativeCoverageExcludePaths product variable). Value "*" in
1623// NativeCoveragePaths represents any path.
1624func (c *deviceConfig) NativeCoverageEnabledForPath(path string) bool {
Ryan Campbell469a18a2017-02-27 09:01:54 -08001625 coverage := false
Roland Levillainf6cc2612020-07-09 16:58:14 +01001626 if len(c.config.productVariables.NativeCoveragePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001627 if InList("*", c.config.productVariables.NativeCoveragePaths) || HasAnyPrefix(path, c.config.productVariables.NativeCoveragePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001628 coverage = true
Dan Willemsen581341d2017-02-09 16:16:31 -08001629 }
1630 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001631 if coverage && len(c.config.productVariables.NativeCoverageExcludePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001632 if HasAnyPrefix(path, c.config.productVariables.NativeCoverageExcludePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001633 coverage = false
Ryan Campbell469a18a2017-02-27 09:01:54 -08001634 }
1635 }
1636 return coverage
Dan Willemsen581341d2017-02-09 16:16:31 -08001637}
Ivan Lozano5f595532017-07-13 14:46:05 -07001638
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001639func (c *deviceConfig) PgoAdditionalProfileDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001640 return c.config.productVariables.PgoAdditionalProfileDirs
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001641}
1642
Vinh Tran44cb78c2023-03-09 22:07:19 -05001643// AfdoProfile returns fully qualified path associated to the given module name
Colin Crossd38feb02024-01-23 16:38:06 -08001644func (c *deviceConfig) AfdoProfile(name string) (string, error) {
Vinh Tran44cb78c2023-03-09 22:07:19 -05001645 for _, afdoProfile := range c.config.productVariables.AfdoProfiles {
1646 split := strings.Split(afdoProfile, ":")
1647 if len(split) != 3 {
Colin Crossd38feb02024-01-23 16:38:06 -08001648 return "", fmt.Errorf("AFDO_PROFILES has invalid value: %s. "+
Vinh Tran44cb78c2023-03-09 22:07:19 -05001649 "The expected format is <module>:<fully-qualified-path-to-fdo_profile>", afdoProfile)
1650 }
1651 if split[0] == name {
Colin Crossd38feb02024-01-23 16:38:06 -08001652 return strings.Join([]string{split[1], split[2]}, ":"), nil
Vinh Tran44cb78c2023-03-09 22:07:19 -05001653 }
1654 }
Colin Crossd38feb02024-01-23 16:38:06 -08001655 return "", nil
Vinh Tran44cb78c2023-03-09 22:07:19 -05001656}
1657
Tri Vo35a51432018-03-25 20:00:00 -07001658func (c *deviceConfig) VendorSepolicyDirs() []string {
1659 return c.config.productVariables.BoardVendorSepolicyDirs
1660}
1661
1662func (c *deviceConfig) OdmSepolicyDirs() []string {
1663 return c.config.productVariables.BoardOdmSepolicyDirs
1664}
1665
Felixa20a8752020-05-17 18:28:35 +02001666func (c *deviceConfig) SystemExtPublicSepolicyDirs() []string {
1667 return c.config.productVariables.SystemExtPublicSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001668}
1669
Felixa20a8752020-05-17 18:28:35 +02001670func (c *deviceConfig) SystemExtPrivateSepolicyDirs() []string {
1671 return c.config.productVariables.SystemExtPrivateSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001672}
1673
Inseob Kim0866b002019-04-15 20:21:29 +09001674func (c *deviceConfig) SepolicyM4Defs() []string {
1675 return c.config.productVariables.BoardSepolicyM4Defs
1676}
1677
Jiyong Park7f67f482019-01-05 12:57:48 +09001678func (c *deviceConfig) OverrideManifestPackageNameFor(name string) (manifestName string, overridden bool) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001679 return findOverrideValue(c.config.productVariables.ManifestPackageNameOverrides, name,
1680 "invalid override rule %q in PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES should be <module_name>:<manifest_name>")
1681}
1682
1683func (c *deviceConfig) OverrideCertificateFor(name string) (certificatePath string, overridden bool) {
Jaewoong Jungacb6db32019-02-28 16:22:30 +00001684 return findOverrideValue(c.config.productVariables.CertificateOverrides, name,
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001685 "invalid override rule %q in PRODUCT_CERTIFICATE_OVERRIDES should be <module_name>:<certificate_module_name>")
1686}
1687
Jaewoong Jung9d22a912019-01-23 16:27:47 -08001688func (c *deviceConfig) OverridePackageNameFor(name string) string {
1689 newName, overridden := findOverrideValue(
1690 c.config.productVariables.PackageNameOverrides,
1691 name,
1692 "invalid override rule %q in PRODUCT_PACKAGE_NAME_OVERRIDES should be <module_name>:<package_name>")
1693 if overridden {
1694 return newName
1695 }
1696 return name
1697}
1698
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001699func findOverrideValue(overrides []string, name string, errorMsg string) (newValue string, overridden bool) {
Jiyong Park7f67f482019-01-05 12:57:48 +09001700 if overrides == nil || len(overrides) == 0 {
1701 return "", false
1702 }
1703 for _, o := range overrides {
1704 split := strings.Split(o, ":")
1705 if len(split) != 2 {
1706 // This shouldn't happen as this is first checked in make, but just in case.
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001707 panic(fmt.Errorf(errorMsg, o))
Jiyong Park7f67f482019-01-05 12:57:48 +09001708 }
1709 if matchPattern(split[0], name) {
1710 return substPattern(split[0], split[1], name), true
1711 }
1712 }
1713 return "", false
1714}
1715
Albert Martineefabcf2022-03-21 20:11:16 +00001716func (c *deviceConfig) ApexGlobalMinSdkVersionOverride() string {
1717 return String(c.config.productVariables.ApexGlobalMinSdkVersionOverride)
1718}
1719
Ivan Lozano5f595532017-07-13 14:46:05 -07001720func (c *config) IntegerOverflowDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001721 if len(c.productVariables.IntegerOverflowExcludePaths) == 0 {
Ivan Lozano5f595532017-07-13 14:46:05 -07001722 return false
1723 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001724 return HasAnyPrefix(path, c.productVariables.IntegerOverflowExcludePaths)
Ivan Lozano5f595532017-07-13 14:46:05 -07001725}
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001726
1727func (c *config) CFIDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001728 if len(c.productVariables.CFIExcludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001729 return false
1730 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001731 return HasAnyPrefix(path, c.productVariables.CFIExcludePaths)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001732}
1733
1734func (c *config) CFIEnabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001735 if len(c.productVariables.CFIIncludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001736 return false
1737 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001738 return HasAnyPrefix(path, c.productVariables.CFIIncludePaths) && !c.CFIDisabledForPath(path)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001739}
Colin Crosse15ddaf2017-12-04 11:24:31 -08001740
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001741func (c *config) MemtagHeapDisabledForPath(path string) bool {
1742 if len(c.productVariables.MemtagHeapExcludePaths) == 0 {
1743 return false
1744 }
1745 return HasAnyPrefix(path, c.productVariables.MemtagHeapExcludePaths)
1746}
1747
1748func (c *config) MemtagHeapAsyncEnabledForPath(path string) bool {
1749 if len(c.productVariables.MemtagHeapAsyncIncludePaths) == 0 {
1750 return false
1751 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001752 return HasAnyPrefix(path, c.productVariables.MemtagHeapAsyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001753}
1754
1755func (c *config) MemtagHeapSyncEnabledForPath(path string) bool {
1756 if len(c.productVariables.MemtagHeapSyncIncludePaths) == 0 {
1757 return false
1758 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001759 return HasAnyPrefix(path, c.productVariables.MemtagHeapSyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001760}
1761
Tomislav Novakf734f002023-08-22 10:51:44 -07001762func (c *config) HWASanDisabledForPath(path string) bool {
1763 if len(c.productVariables.HWASanExcludePaths) == 0 {
1764 return false
1765 }
1766 return HasAnyPrefix(path, c.productVariables.HWASanExcludePaths)
1767}
1768
Hang Lua98aab92023-03-17 13:17:22 +08001769func (c *config) HWASanEnabledForPath(path string) bool {
1770 if len(c.productVariables.HWASanIncludePaths) == 0 {
1771 return false
1772 }
Tomislav Novakf734f002023-08-22 10:51:44 -07001773 return HasAnyPrefix(path, c.productVariables.HWASanIncludePaths) && !c.HWASanDisabledForPath(path)
Hang Lua98aab92023-03-17 13:17:22 +08001774}
1775
Dan Willemsen0fe78662018-03-26 12:41:18 -07001776func (c *config) VendorConfig(name string) VendorConfig {
Colin Cross9d34f352019-11-22 16:03:51 -08001777 return soongconfig.Config(c.productVariables.VendorVars[name])
Dan Willemsen0fe78662018-03-26 12:41:18 -07001778}
1779
Colin Cross395f2cf2018-10-24 16:10:32 -07001780func (c *config) NdkAbis() bool {
1781 return Bool(c.productVariables.Ndk_abis)
1782}
1783
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001784func (c *config) AmlAbis() bool {
1785 return Bool(c.productVariables.Aml_abis)
1786}
1787
Jiyong Park4da07972021-01-05 21:01:11 +09001788func (c *config) ForceApexSymlinkOptimization() bool {
1789 return Bool(c.productVariables.ForceApexSymlinkOptimization)
1790}
1791
Sasha Smundakfe9a5b82022-07-27 14:51:45 -07001792func (c *config) ApexCompressionEnabled() bool {
1793 return Bool(c.productVariables.CompressedApex) && !c.UnbundledBuildApps()
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +00001794}
1795
Dennis Shene2ed70c2023-01-11 14:15:43 +00001796func (c *config) ApexTrimEnabled() bool {
1797 return Bool(c.productVariables.TrimmedApex)
1798}
1799
Justin Yun2cc42502024-09-11 14:10:20 +09001800func (c *config) UseSoongSystemImage() bool {
1801 return Bool(c.productVariables.UseSoongSystemImage)
1802}
1803
1804func (c *config) SoongDefinedSystemImage() string {
1805 if c.UseSoongSystemImage() {
1806 return String(c.productVariables.ProductSoongDefinedSystemImage)
1807 }
1808 return ""
1809}
1810
Jeongik Chac9464142019-01-07 12:07:27 +09001811func (c *config) EnforceSystemCertificate() bool {
1812 return Bool(c.productVariables.EnforceSystemCertificate)
1813}
1814
Colin Cross440e0d02020-06-11 11:32:11 -07001815func (c *config) EnforceSystemCertificateAllowList() []string {
1816 return c.productVariables.EnforceSystemCertificateAllowList
Jeongik Chac9464142019-01-07 12:07:27 +09001817}
1818
Jeongik Cha2cc570d2019-10-29 15:44:45 +09001819func (c *config) EnforceProductPartitionInterface() bool {
1820 return Bool(c.productVariables.EnforceProductPartitionInterface)
1821}
1822
Colin Crossf24a22a2019-01-31 14:12:44 -08001823func (c *config) ProductHiddenAPIStubs() []string {
1824 return c.productVariables.ProductHiddenAPIStubs
Colin Cross8faf8fc2019-01-16 15:15:52 -08001825}
1826
Colin Crossf24a22a2019-01-31 14:12:44 -08001827func (c *config) ProductHiddenAPIStubsSystem() []string {
1828 return c.productVariables.ProductHiddenAPIStubsSystem
Colin Cross8faf8fc2019-01-16 15:15:52 -08001829}
1830
Colin Crossf24a22a2019-01-31 14:12:44 -08001831func (c *config) ProductHiddenAPIStubsTest() []string {
1832 return c.productVariables.ProductHiddenAPIStubsTest
Colin Cross8faf8fc2019-01-16 15:15:52 -08001833}
Dan Willemsen71c74602019-04-10 12:27:35 -07001834
Dan Willemsen54879d12019-04-18 10:08:46 -07001835func (c *deviceConfig) TargetFSConfigGen() []string {
Dan Willemsen71c74602019-04-10 12:27:35 -07001836 return c.config.productVariables.TargetFSConfigGen
1837}
Inseob Kim0866b002019-04-15 20:21:29 +09001838
1839func (c *config) ProductPublicSepolicyDirs() []string {
1840 return c.productVariables.ProductPublicSepolicyDirs
1841}
1842
1843func (c *config) ProductPrivateSepolicyDirs() []string {
1844 return c.productVariables.ProductPrivateSepolicyDirs
1845}
1846
Inseob Kim5eb7ee92022-04-27 10:30:34 +09001847func (c *config) TargetMultitreeUpdateMeta() bool {
1848 return c.productVariables.MultitreeUpdateMeta
1849}
1850
Inseob Kim1f086e22019-05-09 13:29:15 +09001851func (c *deviceConfig) DeviceArch() string {
1852 return String(c.config.productVariables.DeviceArch)
1853}
1854
1855func (c *deviceConfig) DeviceArchVariant() string {
1856 return String(c.config.productVariables.DeviceArchVariant)
1857}
1858
1859func (c *deviceConfig) DeviceSecondaryArch() string {
1860 return String(c.config.productVariables.DeviceSecondaryArch)
1861}
1862
1863func (c *deviceConfig) DeviceSecondaryArchVariant() string {
1864 return String(c.config.productVariables.DeviceSecondaryArchVariant)
1865}
Yifan Hong82db7352020-01-21 16:12:26 -08001866
1867func (c *deviceConfig) BoardUsesRecoveryAsBoot() bool {
1868 return Bool(c.config.productVariables.BoardUsesRecoveryAsBoot)
1869}
Yifan Hong97365ee2020-07-29 09:51:57 -07001870
1871func (c *deviceConfig) BoardKernelBinaries() []string {
1872 return c.config.productVariables.BoardKernelBinaries
1873}
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001874
Yifan Hong42bef8d2020-08-05 14:36:09 -07001875func (c *deviceConfig) BoardKernelModuleInterfaceVersions() []string {
1876 return c.config.productVariables.BoardKernelModuleInterfaceVersions
1877}
1878
Yifan Hongdd8dacc2020-10-21 15:40:17 -07001879func (c *deviceConfig) BoardMoveRecoveryResourcesToVendorBoot() bool {
1880 return Bool(c.config.productVariables.BoardMoveRecoveryResourcesToVendorBoot)
1881}
1882
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001883func (c *deviceConfig) PlatformSepolicyVersion() string {
1884 return String(c.config.productVariables.PlatformSepolicyVersion)
1885}
1886
Inseob Kim843f6642022-01-07 09:11:23 +09001887func (c *deviceConfig) PlatformSepolicyCompatVersions() []string {
1888 return c.config.productVariables.PlatformSepolicyCompatVersions
1889}
1890
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001891func (c *deviceConfig) BoardSepolicyVers() string {
Inseob Kim0c4eec82021-03-22 22:33:40 +09001892 if ver := String(c.config.productVariables.BoardSepolicyVers); ver != "" {
1893 return ver
1894 }
1895 return c.PlatformSepolicyVersion()
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001896}
1897
Inseob Kim1a0afcc2022-02-14 23:10:51 +09001898func (c *deviceConfig) SystemExtSepolicyPrebuiltApiDir() string {
1899 return String(c.config.productVariables.SystemExtSepolicyPrebuiltApiDir)
1900}
1901
1902func (c *deviceConfig) ProductSepolicyPrebuiltApiDir() string {
1903 return String(c.config.productVariables.ProductSepolicyPrebuiltApiDir)
1904}
1905
1906func (c *deviceConfig) IsPartnerTrebleSepolicyTestEnabled() bool {
1907 return c.SystemExtSepolicyPrebuiltApiDir() != "" || c.ProductSepolicyPrebuiltApiDir() != ""
1908}
1909
Justin DeMartino383bfb32021-02-24 10:49:43 -08001910func createDirsMap(previous map[string]bool, dirs []string) (map[string]bool, error) {
1911 var ret = make(map[string]bool)
1912 for _, dir := range dirs {
1913 clean := filepath.Clean(dir)
1914 if previous[clean] || ret[clean] {
1915 return nil, fmt.Errorf("Duplicate entry %s", dir)
1916 }
1917 ret[clean] = true
1918 }
1919 return ret, nil
1920}
1921
1922func (c *deviceConfig) createDirsMapOnce(onceKey OnceKey, previous map[string]bool, dirs []string) map[string]bool {
1923 dirMap := c.Once(onceKey, func() interface{} {
1924 ret, err := createDirsMap(previous, dirs)
1925 if err != nil {
1926 panic(fmt.Errorf("%s: %w", onceKey.key, err))
1927 }
1928 return ret
1929 })
1930 if dirMap == nil {
1931 return nil
1932 }
1933 return dirMap.(map[string]bool)
1934}
1935
Inseob Kim60c32f02020-12-21 22:53:05 +09001936func (c *deviceConfig) ShippingApiLevel() ApiLevel {
Steven Morelanda48df2b2024-06-03 22:29:38 +00001937 if c.config.productVariables.Shipping_api_level == nil {
Inseob Kim60c32f02020-12-21 22:53:05 +09001938 return NoneApiLevel
1939 }
Steven Morelanda48df2b2024-06-03 22:29:38 +00001940 apiLevel, _ := strconv.Atoi(*c.config.productVariables.Shipping_api_level)
Inseob Kim60c32f02020-12-21 22:53:05 +09001941 return uncheckedFinalApiLevel(apiLevel)
1942}
1943
Liz Kammer33cc80e2023-05-18 18:20:28 +00001944func (c *deviceConfig) BuildBrokenPluginValidation() []string {
1945 return c.config.productVariables.BuildBrokenPluginValidation
1946}
1947
Alix Espinoef47e542022-09-14 19:10:51 +00001948func (c *deviceConfig) BuildBrokenClangAsFlags() bool {
1949 return c.config.productVariables.BuildBrokenClangAsFlags
1950}
1951
1952func (c *deviceConfig) BuildBrokenClangCFlags() bool {
1953 return c.config.productVariables.BuildBrokenClangCFlags
1954}
1955
Alixb5f6d9e2022-04-20 23:00:58 +00001956func (c *deviceConfig) BuildBrokenClangProperty() bool {
1957 return c.config.productVariables.BuildBrokenClangProperty
1958}
1959
Inseob Kim67e5add192021-03-17 18:05:33 +09001960func (c *deviceConfig) BuildBrokenEnforceSyspropOwner() bool {
1961 return c.config.productVariables.BuildBrokenEnforceSyspropOwner
1962}
1963
1964func (c *deviceConfig) BuildBrokenTrebleSyspropNeverallow() bool {
1965 return c.config.productVariables.BuildBrokenTrebleSyspropNeverallow
1966}
1967
Hridya Valsaraju5a5c7d52021-04-02 16:45:24 -07001968func (c *deviceConfig) BuildDebugfsRestrictionsEnabled() bool {
1969 return c.config.productVariables.BuildDebugfsRestrictionsEnabled
1970}
1971
Inseob Kim0cac7b42021-02-03 18:16:46 +09001972func (c *deviceConfig) BuildBrokenVendorPropertyNamespace() bool {
1973 return c.config.productVariables.BuildBrokenVendorPropertyNamespace
1974}
1975
Liz Kammer619be462022-01-28 15:13:39 -05001976func (c *deviceConfig) BuildBrokenInputDir(name string) bool {
1977 return InList(name, c.config.productVariables.BuildBrokenInputDirModules)
1978}
1979
Jiyong Park3bb99242024-01-04 23:21:26 +00001980func (c *deviceConfig) BuildBrokenDontCheckSystemSdk() bool {
1981 return c.config.productVariables.BuildBrokenDontCheckSystemSdk
1982}
1983
Inseob Kim2da72af2024-06-18 11:09:12 +09001984func (c *deviceConfig) BuildBrokenDupSysprop() bool {
1985 return c.config.productVariables.BuildBrokenDupSysprop
1986}
1987
Jiakai Zhang48203e32023-06-02 23:42:21 +01001988func (c *config) BuildWarningBadOptionalUsesLibsAllowlist() []string {
1989 return c.productVariables.BuildWarningBadOptionalUsesLibsAllowlist
1990}
1991
Yu Liu6a7940c2023-05-09 17:12:22 -07001992func (c *deviceConfig) GenruleSandboxing() bool {
1993 return Bool(c.config.productVariables.GenruleSandboxing)
Vinh Tran140d5882022-06-10 14:23:27 -04001994}
1995
Inseob Kim67e5add192021-03-17 18:05:33 +09001996func (c *deviceConfig) RequiresInsecureExecmemForSwiftshader() bool {
1997 return c.config.productVariables.RequiresInsecureExecmemForSwiftshader
1998}
1999
Devin Moorec381e102023-07-06 22:03:58 +00002000func (c *deviceConfig) Release_aidl_use_unfrozen() bool {
2001 return Bool(c.config.productVariables.Release_aidl_use_unfrozen)
2002}
2003
Inseob Kim67e5add192021-03-17 18:05:33 +09002004func (c *config) SelinuxIgnoreNeverallows() bool {
2005 return c.productVariables.SelinuxIgnoreNeverallows
2006}
2007
Inseob Kima10ef272021-09-15 03:04:53 +00002008func (c *deviceConfig) SepolicyFreezeTestExtraDirs() []string {
2009 return c.config.productVariables.SepolicyFreezeTestExtraDirs
2010}
2011
2012func (c *deviceConfig) SepolicyFreezeTestExtraPrebuiltDirs() []string {
2013 return c.config.productVariables.SepolicyFreezeTestExtraPrebuiltDirs
2014}
2015
Jiyong Parkd163d4d2021-10-12 16:47:43 +09002016func (c *deviceConfig) GenerateAidlNdkPlatformBackend() bool {
2017 return c.config.productVariables.GenerateAidlNdkPlatformBackend
2018}
2019
Yu Liu67a28422024-03-05 00:36:31 +00002020func (c *deviceConfig) AconfigContainerValidation() string {
2021 return c.config.productVariables.AconfigContainerValidation
2022}
2023
Christopher Ferris98f10222022-07-13 23:16:52 -07002024func (c *config) IgnorePrefer32OnDevice() bool {
2025 return c.productVariables.IgnorePrefer32OnDevice
2026}
2027
Ulya Trafimovich249386a2020-07-01 14:31:13 +01002028func (c *config) BootJars() []string {
2029 return c.Once(earlyBootJarsKey, func() interface{} {
Paul Duffin69d1fb12020-10-23 21:14:20 +01002030 list := c.productVariables.BootJars.CopyOfJars()
satayevd604b212021-07-21 14:23:52 +01002031 return append(list, c.productVariables.ApexBootJars.CopyOfJars()...)
Ulya Trafimovich249386a2020-07-01 14:31:13 +01002032 }).([]string)
2033}
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002034
satayevd604b212021-07-21 14:23:52 +01002035func (c *config) NonApexBootJars() ConfiguredJarList {
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002036 return c.productVariables.BootJars
2037}
2038
satayevd604b212021-07-21 14:23:52 +01002039func (c *config) ApexBootJars() ConfiguredJarList {
2040 return c.productVariables.ApexBootJars
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002041}
Colin Cross77cdcfd2021-03-12 11:28:25 -08002042
2043func (c *config) RBEWrapper() string {
2044 return c.GetenvWithDefault("RBE_WRAPPER", remoteexec.DefaultWrapperPath)
2045}
Colin Cross9b698b62021-12-22 09:55:32 -08002046
2047// UseHostMusl returns true if the host target has been configured to build against musl libc.
2048func (c *config) UseHostMusl() bool {
2049 return Bool(c.productVariables.HostMusl)
2050}
MarkDacekff851b82022-04-21 18:33:17 +00002051
Spandan Das9e93d3d2023-03-08 05:47:29 +00002052// ApiSurfaces directory returns the source path inside the api_surfaces repo
2053// (relative to workspace root).
2054func (c *config) ApiSurfacesDir(s ApiSurface, version string) string {
2055 return filepath.Join(
2056 "build",
2057 "bazel",
2058 "api_surfaces",
2059 s.String(),
2060 version)
2061}
Jihoon Kang1bff0342023-01-17 20:40:22 +00002062
Jihoon Kang1975d3e2023-10-16 23:24:11 +00002063func (c *config) JavaCoverageEnabled() bool {
2064 return c.IsEnvTrue("EMMA_INSTRUMENT") || c.IsEnvTrue("EMMA_INSTRUMENT_STATIC") || c.IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK")
2065}
2066
Jihoon Kangc1b04d62023-11-16 19:07:04 +00002067func (c *deviceConfig) BuildFromSourceStub() bool {
2068 return Bool(c.config.productVariables.BuildFromSourceStub)
2069}
2070
Jihoon Kang1bff0342023-01-17 20:40:22 +00002071func (c *config) BuildFromTextStub() bool {
Jihoon Kang1975d3e2023-10-16 23:24:11 +00002072 // TODO: b/302320354 - Remove the coverage build specific logic once the
2073 // robust solution for handling native properties in from-text stub build
2074 // is implemented.
Jihoon Kangc1b04d62023-11-16 19:07:04 +00002075 return !c.buildFromSourceStub &&
2076 !c.JavaCoverageEnabled() &&
2077 !c.deviceConfig.BuildFromSourceStub()
Jihoon Kang1bff0342023-01-17 20:40:22 +00002078}
Spandan Das4deab282023-03-30 17:06:32 +00002079
2080func (c *config) SetBuildFromTextStub(b bool) {
Jihoon Kang2a929ad2023-06-08 19:02:07 +00002081 c.buildFromSourceStub = !b
Jihoon Kangcbcad7c2023-06-01 22:31:52 +00002082 c.productVariables.Build_from_text_stub = boolPtr(b)
Spandan Das4deab282023-03-30 17:06:32 +00002083}
Jihoon Kang1c92c3e2023-03-23 17:44:51 +00002084
Inseob Kim5bac3b62023-08-25 21:29:46 +09002085func (c *deviceConfig) CheckVendorSeappViolations() bool {
2086 return Bool(c.config.productVariables.CheckVendorSeappViolations)
2087}
Jihoon Kangcfbc4072023-09-20 01:02:18 +00002088
Inseob Kime4e85d52023-10-25 23:53:58 +09002089func (c *config) GetBuildFlag(name string) (string, bool) {
2090 val, ok := c.productVariables.BuildFlags[name]
2091 return val, ok
2092}
Spandan Dase3fcb412023-10-26 20:48:02 +00002093
Rico Winda7b38592024-08-26 12:10:44 +02002094func (c *config) UseOptimizedResourceShrinkingByDefault() bool {
2095 return c.productVariables.GetBuildFlagBool("RELEASE_USE_OPTIMIZED_RESOURCE_SHRINKING_BY_DEFAULT")
2096}
2097
Colin Cross8f1b0332024-01-25 13:39:06 -08002098func (c *config) UseResourceProcessorByDefault() bool {
2099 return c.productVariables.GetBuildFlagBool("RELEASE_USE_RESOURCE_PROCESSOR_BY_DEFAULT")
2100}
2101
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002102func (c *config) UseTransitiveJarsInClasspath() bool {
2103 return c.productVariables.GetBuildFlagBool("RELEASE_USE_TRANSITIVE_JARS_IN_CLASSPATH")
2104}
2105
Spandan Dase3fcb412023-10-26 20:48:02 +00002106var (
Spandan Das85bd4622024-08-01 00:51:20 +00002107 mainlineApexContributionBuildFlagsToApexNames = map[string]string{
2108 "RELEASE_APEX_CONTRIBUTIONS_ADBD": "com.android.adbd",
2109 "RELEASE_APEX_CONTRIBUTIONS_ADSERVICES": "com.android.adservices",
2110 "RELEASE_APEX_CONTRIBUTIONS_APPSEARCH": "com.android.appsearch",
2111 "RELEASE_APEX_CONTRIBUTIONS_ART": "com.android.art",
2112 "RELEASE_APEX_CONTRIBUTIONS_BLUETOOTH": "com.android.btservices",
2113 "RELEASE_APEX_CONTRIBUTIONS_CAPTIVEPORTALLOGIN": "",
2114 "RELEASE_APEX_CONTRIBUTIONS_CELLBROADCAST": "com.android.cellbroadcast",
2115 "RELEASE_APEX_CONTRIBUTIONS_CONFIGINFRASTRUCTURE": "com.android.configinfrastructure",
2116 "RELEASE_APEX_CONTRIBUTIONS_CONNECTIVITY": "com.android.tethering",
2117 "RELEASE_APEX_CONTRIBUTIONS_CONSCRYPT": "com.android.conscrypt",
2118 "RELEASE_APEX_CONTRIBUTIONS_CRASHRECOVERY": "",
2119 "RELEASE_APEX_CONTRIBUTIONS_DEVICELOCK": "com.android.devicelock",
2120 "RELEASE_APEX_CONTRIBUTIONS_DOCUMENTSUIGOOGLE": "",
2121 "RELEASE_APEX_CONTRIBUTIONS_EXTSERVICES": "com.android.extservices",
2122 "RELEASE_APEX_CONTRIBUTIONS_HEALTHFITNESS": "com.android.healthfitness",
2123 "RELEASE_APEX_CONTRIBUTIONS_IPSEC": "com.android.ipsec",
2124 "RELEASE_APEX_CONTRIBUTIONS_MEDIA": "com.android.media",
2125 "RELEASE_APEX_CONTRIBUTIONS_MEDIAPROVIDER": "com.android.mediaprovider",
2126 "RELEASE_APEX_CONTRIBUTIONS_MODULE_METADATA": "",
2127 "RELEASE_APEX_CONTRIBUTIONS_NETWORKSTACKGOOGLE": "",
2128 "RELEASE_APEX_CONTRIBUTIONS_NEURALNETWORKS": "com.android.neuralnetworks",
2129 "RELEASE_APEX_CONTRIBUTIONS_ONDEVICEPERSONALIZATION": "com.android.ondevicepersonalization",
2130 "RELEASE_APEX_CONTRIBUTIONS_PERMISSION": "com.android.permission",
2131 "RELEASE_APEX_CONTRIBUTIONS_PRIMARY_LIBS": "",
2132 "RELEASE_APEX_CONTRIBUTIONS_REMOTEKEYPROVISIONING": "com.android.rkpd",
2133 "RELEASE_APEX_CONTRIBUTIONS_RESOLV": "com.android.resolv",
2134 "RELEASE_APEX_CONTRIBUTIONS_SCHEDULING": "com.android.scheduling",
2135 "RELEASE_APEX_CONTRIBUTIONS_SDKEXTENSIONS": "com.android.sdkext",
2136 "RELEASE_APEX_CONTRIBUTIONS_SWCODEC": "com.android.media.swcodec",
2137 "RELEASE_APEX_CONTRIBUTIONS_STATSD": "com.android.os.statsd",
2138 "RELEASE_APEX_CONTRIBUTIONS_TELEMETRY_TVP": "",
2139 "RELEASE_APEX_CONTRIBUTIONS_TZDATA": "com.android.tzdata",
2140 "RELEASE_APEX_CONTRIBUTIONS_UWB": "com.android.uwb",
2141 "RELEASE_APEX_CONTRIBUTIONS_WIFI": "com.android.wifi",
Spandan Dase3fcb412023-10-26 20:48:02 +00002142 }
2143)
2144
2145// Returns the list of _selected_ apex_contributions
2146// Each mainline module will have one entry in the list
2147func (c *config) AllApexContributions() []string {
2148 ret := []string{}
Spandan Das85bd4622024-08-01 00:51:20 +00002149 for _, f := range SortedKeys(mainlineApexContributionBuildFlagsToApexNames) {
Spandan Dase3fcb412023-10-26 20:48:02 +00002150 if val, exists := c.GetBuildFlag(f); exists && val != "" {
2151 ret = append(ret, val)
2152 }
2153 }
2154 return ret
2155}
Spandan Das8ab28dd2024-02-17 03:31:45 +00002156
Spandan Das85bd4622024-08-01 00:51:20 +00002157func (c *config) AllMainlineApexNames() []string {
2158 return SortedStringValues(mainlineApexContributionBuildFlagsToApexNames)
2159}
2160
Spandan Das0d24ade2024-03-08 04:20:15 +00002161func (c *config) BuildIgnoreApexContributionContents() *bool {
Spandan Das8ab28dd2024-02-17 03:31:45 +00002162 return c.productVariables.BuildIgnoreApexContributionContents
2163}
Inseob Kim8fa54da2024-03-19 16:48:59 +09002164
2165func (c *config) ProductLocales() []string {
2166 return c.productVariables.ProductLocales
2167}
2168
2169func (c *config) ProductDefaultWifiChannels() []string {
2170 return c.productVariables.ProductDefaultWifiChannels
2171}
2172
2173func (c *config) BoardUseVbmetaDigestInFingerprint() bool {
2174 return Bool(c.productVariables.BoardUseVbmetaDigestInFingerprint)
2175}
2176
2177func (c *config) OemProperties() []string {
2178 return c.productVariables.OemProperties
2179}
Kiyoung Kim881e4652024-07-08 11:02:23 +09002180
2181func (c *config) UseDebugArt() bool {
2182 if c.productVariables.ArtTargetIncludeDebugBuild != nil {
2183 return Bool(c.productVariables.ArtTargetIncludeDebugBuild)
2184 }
2185
2186 return Bool(c.productVariables.Eng)
2187}
Inseob Kimd8538e52024-07-31 02:00:41 +00002188
2189func (c *config) SystemPropFiles(ctx PathContext) Paths {
2190 return PathsForSource(ctx, c.productVariables.SystemPropFiles)
2191}
Inseob Kim6bd92d52024-07-31 02:01:03 +00002192
Inseob Kimacf91742024-08-05 12:51:05 +09002193func (c *config) SystemExtPropFiles(ctx PathContext) Paths {
2194 return PathsForSource(ctx, c.productVariables.SystemExtPropFiles)
2195}
2196
Inseob Kim01d4f8b2024-08-08 17:47:14 +09002197func (c *config) ProductPropFiles(ctx PathContext) Paths {
2198 return PathsForSource(ctx, c.productVariables.ProductPropFiles)
2199}
2200
Inseob Kim9a22c7e2024-08-26 15:58:09 +09002201func (c *config) OdmPropFiles(ctx PathContext) Paths {
2202 return PathsForSource(ctx, c.productVariables.OdmPropFiles)
2203}
2204
Nouby Mohamed8609a552024-09-04 22:19:51 +00002205func (c *config) ExtraAllowedDepsTxt() string {
2206 return String(c.productVariables.ExtraAllowedDepsTxt)
2207}
2208
Inseob Kim6bd92d52024-07-31 02:01:03 +00002209func (c *config) EnableUffdGc() string {
2210 return String(c.productVariables.EnableUffdGc)
2211}
Bill Yang3b3aac02024-09-05 09:22:09 +00002212
2213func (c *config) DeviceFrameworkCompatibilityMatrixFile() []string {
2214 return c.productVariables.DeviceFrameworkCompatibilityMatrixFile
2215}
2216
2217func (c *config) DeviceProductCompatibilityMatrixFile() []string {
2218 return c.productVariables.DeviceProductCompatibilityMatrixFile
2219}
2220
2221func (c *config) BoardAvbEnable() bool {
2222 return Bool(c.productVariables.BoardAvbEnable)
2223}
2224
2225func (c *config) BoardAvbSystemAddHashtreeFooterArgs() []string {
2226 return c.productVariables.BoardAvbSystemAddHashtreeFooterArgs
2227}
Spandan Das950deca2024-10-01 18:35:23 +00002228
2229// Returns true if RELEASE_INSTALL_APEX_SYSTEMSERVER_DEXPREOPT_SAME_PARTITION is set to true.
2230// If true, dexpreopt files of apex system server jars will be installed in the same partition as the parent apex.
2231// If false, all these files will be installed in /system partition.
2232func (c Config) InstallApexSystemServerDexpreoptSamePartition() bool {
2233 return c.config.productVariables.GetBuildFlagBool("RELEASE_INSTALL_APEX_SYSTEMSERVER_DEXPREOPT_SAME_PARTITION")
2234}