blob: 2fc611168ff91d84df0d7f6aafe26123670d9950 [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 ModuleGraphFile string
88 ModuleActionsFile string
89 DocFile string
Sasha Smundakaf5ca922022-12-12 21:23:34 -080090
Jihoon Kang2a929ad2023-06-08 19:02:07 +000091 BuildFromSourceStub bool
MarkDacekf47e1422023-04-19 16:47:36 +000092
93 EnsureAllowlistIntegrity bool
Sasha Smundakaf5ca922022-12-12 21:23:34 -080094}
95
Chris Parsonsad876012022-08-20 14:48:32 -040096// Build modes that soong_build can run as.
97const (
98 // Don't use bazel at all during module analysis.
99 AnalysisNoBazel SoongBuildMode = iota
100
Chris Parsonsad876012022-08-20 14:48:32 -0400101 // Create a JSON representation of the module graph and exit.
102 GenerateModuleGraph
103
104 // Generate a documentation file for module type definitions and exit.
105 GenerateDocFile
Chris Parsonsad876012022-08-20 14:48:32 -0400106)
107
Inseob Kim8fa54da2024-03-19 16:48:59 +0900108const testKeyDir = "build/make/target/product/security"
109
Lukacs T. Berkib078ade2021-08-31 10:42:08 +0200110// SoongOutDir returns the build output directory for the configuration.
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200111func (c Config) SoongOutDir() string {
112 return c.soongOutDir
Jeff Gastonefc1b412017-03-29 17:29:06 -0700113}
114
Colin Cross31a67452023-11-02 16:57:08 -0700115// tempDir returns the path to out/soong/.temp, which is cleared at the beginning of every build.
116func (c Config) tempDir() string {
117 return shared.TempDirForOutDir(c.soongOutDir)
118}
119
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200120func (c Config) OutDir() string {
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200121 return c.outDir
Lukacs T. Berki89e9a162021-03-12 08:31:32 +0100122}
123
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200124func (c Config) RunGoTests() bool {
125 return c.runGoTests
126}
127
Lukacs T. Berki5f6cb1d2021-03-17 15:03:14 +0100128func (c Config) DebugCompilation() bool {
129 return false // Never compile Go code in the main build for debugging
130}
131
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200132func (c Config) Subninjas() []string {
133 return []string{}
134}
135
136func (c Config) PrimaryBuilderInvocations() []bootstrap.PrimaryBuilderInvocation {
137 return []bootstrap.PrimaryBuilderInvocation{}
138}
139
Paul Duffin74135582022-10-06 11:01:59 +0100140// RunningInsideUnitTest returns true if this code is being run as part of a Soong unit test.
141func (c Config) RunningInsideUnitTest() bool {
142 return c.config.TestProductVariables != nil
143}
144
Pratyushfaec4db2023-07-20 11:19:04 +0000145// DisableHiddenApiChecks returns true if hiddenapi checks have been disabled.
Alyssa Ketpreechasawat7daf2782023-11-01 13:58:39 +0000146// For 'eng' target variant hiddenapi checks are disabled by default for performance optimisation,
Pratyushfaec4db2023-07-20 11:19:04 +0000147// but can be enabled by setting environment variable ENABLE_HIDDENAPI_FLAGS=true.
148// For other target variants hiddenapi check are enabled by default but can be disabled by
149// setting environment variable UNSAFE_DISABLE_HIDDENAPI_FLAGS=true.
150// If both ENABLE_HIDDENAPI_FLAGS=true and UNSAFE_DISABLE_HIDDENAPI_FLAGS=true, then
151// ENABLE_HIDDENAPI_FLAGS=true will be triggered and hiddenapi checks will be considered enabled.
152func (c Config) DisableHiddenApiChecks() bool {
153 return !c.IsEnvTrue("ENABLE_HIDDENAPI_FLAGS") &&
154 (c.IsEnvTrue("UNSAFE_DISABLE_HIDDENAPI_FLAGS") ||
Alyssa Ketpreechasawat7daf2782023-11-01 13:58:39 +0000155 Bool(c.productVariables.Eng))
156}
157
158// DisableVerifyOverlaps returns true if verify_overlaps is skipped.
159// Mismatch in version of apexes and module SDK is required for mainline prebuilts to work in
160// trunk stable.
161// Thus, verify_overlaps is disabled when RELEASE_DEFAULT_MODULE_BUILD_FROM_SOURCE is set to false.
162// TODO(b/308174018): Re-enable verify_overlaps for both builr from source/mainline prebuilts.
163func (c Config) DisableVerifyOverlaps() bool {
Spandan Das07145102024-03-18 23:25:30 +0000164 if c.IsEnvFalse("DISABLE_VERIFY_OVERLAPS") && c.ReleaseDisableVerifyOverlaps() {
165 panic("The current release configuration does not support verify_overlaps. DISABLE_VERIFY_OVERLAPS cannot be set to false")
166 }
167 return c.IsEnvTrue("DISABLE_VERIFY_OVERLAPS") || c.ReleaseDisableVerifyOverlaps() || !c.ReleaseDefaultModuleBuildFromSource()
Pratyushfaec4db2023-07-20 11:19:04 +0000168}
169
Qing Shen713c5422024-08-23 04:09:18 +0000170func (c Config) CoverageSuffix() string {
171 if v := c.IsEnvTrue("EMMA_INSTRUMENT"); v {
172 return "coverage."
173 }
174 return ""
175}
176
Juan Yescas05d4d902023-04-07 10:35:35 -0700177// MaxPageSizeSupported returns the max page size supported by the device. This
178// value will define the ELF segment alignment for binaries (executables and
179// shared libraries).
180func (c Config) MaxPageSizeSupported() string {
181 return String(c.config.productVariables.DeviceMaxPageSizeSupported)
182}
183
Vilas Bhatb3d2d222023-12-04 22:51:20 +0000184// NoBionicPageSizeMacro returns true when AOSP is page size agnostic.
185// This means that the bionic's macro PAGE_SIZE won't be defined.
186// Returns false when AOSP is NOT page size agnostic.
187// This means that bionic's macro PAGE_SIZE is defined.
188func (c Config) NoBionicPageSizeMacro() bool {
189 return Bool(c.config.productVariables.DeviceNoBionicPageSizeMacro)
Juan Yescas01065602023-08-09 08:34:37 -0700190}
191
Joe Onoratofee845a2023-05-09 08:14:14 -0700192// The release version passed to aconfig, derived from RELEASE_VERSION
193func (c Config) ReleaseVersion() string {
194 return c.config.productVariables.ReleaseVersion
195}
196
Yu Liu2cc802a2023-09-05 17:19:45 -0700197// The aconfig value set passed to aconfig, derived from RELEASE_VERSION
Yu Liueebb2592023-10-12 20:31:27 -0700198func (c Config) ReleaseAconfigValueSets() []string {
Yu Liu95572ff2023-12-07 16:38:45 -0800199 return c.config.productVariables.ReleaseAconfigValueSets
Joe Onoratofee845a2023-05-09 08:14:14 -0700200}
201
LaMont Jones21d04d92024-06-11 11:28:54 -0700202func (c Config) ReleaseAconfigExtraReleaseConfigs() []string {
203 result := []string{}
204 if val, ok := c.config.productVariables.BuildFlags["RELEASE_ACONFIG_EXTRA_RELEASE_CONFIGS"]; ok {
205 if len(val) > 0 {
206 // Remove any duplicates from the list.
207 found := make(map[string]bool)
208 for _, k := range strings.Split(val, " ") {
209 if !found[k] {
210 found[k] = true
211 result = append(result, k)
212 }
213 }
214 }
215 }
216 return result
217}
218
219func (c Config) ReleaseAconfigExtraReleaseConfigsValueSets() map[string][]string {
220 result := make(map[string][]string)
221 for _, rcName := range c.ReleaseAconfigExtraReleaseConfigs() {
222 if value, ok := c.config.productVariables.BuildFlags["RELEASE_ACONFIG_VALUE_SETS_"+rcName]; ok {
223 result[rcName] = strings.Split(value, " ")
224 }
225 }
226 return result
227}
228
Zhi Dou3f65a412023-08-10 21:47:40 +0000229// The flag default permission value passed to aconfig
230// derived from RELEASE_ACONFIG_FLAG_DEFAULT_PERMISSION
231func (c Config) ReleaseAconfigFlagDefaultPermission() string {
232 return c.config.productVariables.ReleaseAconfigFlagDefaultPermission
233}
234
Yi Kong76e99ad2024-09-18 18:43:26 +0000235// Enable object size sanitizer
236func (c Config) ReleaseBuildObjectSizeSanitizer() bool {
237 return c.config.productVariables.GetBuildFlagBool("RELEASE_BUILD_OBJECT_SIZE_SANITIZER")
238}
239
Alyssa Ketpreechasawat34ab8792023-10-06 07:01:22 +0000240// The flag indicating behavior for the tree wrt building modules or using prebuilts
241// derived from RELEASE_DEFAULT_MODULE_BUILD_FROM_SOURCE
242func (c Config) ReleaseDefaultModuleBuildFromSource() bool {
243 return c.config.productVariables.ReleaseDefaultModuleBuildFromSource == nil ||
244 Bool(c.config.productVariables.ReleaseDefaultModuleBuildFromSource)
245}
246
Alyssa Ketpreechasawat3a6eced2024-08-22 15:09:16 +0000247func (c Config) ReleaseDefaultUpdatableModuleVersion() string {
248 if val, exists := c.GetBuildFlag("RELEASE_DEFAULT_UPDATABLE_MODULE_VERSION"); exists {
249 return val
250 }
251 panic("RELEASE_DEFAULT_UPDATABLE_MODULE_VERSION is missing from build flags.")
252}
253
Spandan Das07145102024-03-18 23:25:30 +0000254func (c Config) ReleaseDisableVerifyOverlaps() bool {
255 return c.config.productVariables.GetBuildFlagBool("RELEASE_DISABLE_VERIFY_OVERLAPS_CHECK")
256}
257
Jihoon Kang59198152024-02-06 22:43:18 +0000258// Enables flagged apis annotated with READ_WRITE aconfig flags to be included in the stubs
259// and hiddenapi flags so that they are accessible at runtime
260func (c Config) ReleaseExportRuntimeApis() bool {
Jihoon Kang35349462024-02-22 19:52:46 +0000261 return Bool(c.config.productVariables.ExportRuntimeApis)
Jihoon Kang59198152024-02-06 22:43:18 +0000262}
263
Aleksei Vetrov146e9822023-11-24 19:54:26 +0000264// Enables ABI monitoring of NDK libraries
265func (c Config) ReleaseNdkAbiMonitored() bool {
266 return c.config.productVariables.GetBuildFlagBool("RELEASE_NDK_ABI_MONITORED")
267}
268
Ted Bauer10fff942024-04-29 19:30:23 +0000269// Enable read flag from new storage, for C/C++
270func (c Config) ReleaseReadFromNewStorageCc() bool {
271 return c.config.productVariables.GetBuildFlagBool("RELEASE_READ_FROM_NEW_STORAGE_CC")
272}
273
Jihoon Kangbd093452023-12-26 19:08:01 +0000274func (c Config) ReleaseHiddenApiExportableStubs() bool {
Jihoon Kangb36fc542024-02-22 19:35:26 +0000275 return c.config.productVariables.GetBuildFlagBool("RELEASE_HIDDEN_API_EXPORTABLE_STUBS") ||
276 Bool(c.config.productVariables.HiddenapiExportableStubs)
Jihoon Kangbd093452023-12-26 19:08:01 +0000277}
278
Dennis Shen58378c92024-04-03 19:26:36 +0000279// Enable read flag from new storage
280func (c Config) ReleaseReadFromNewStorage() bool {
281 return c.config.productVariables.GetBuildFlagBool("RELEASE_READ_FROM_NEW_STORAGE")
282}
283
Spandan Das3d9b69e2024-10-07 19:03:45 +0000284func (c Config) ReleaseCreateAconfigStorageFile() bool {
285 return c.config.productVariables.GetBuildFlagBool("RELEASE_CREATE_ACONFIG_STORAGE_FILE")
286}
287
Jingwen Chenc711fec2020-11-22 23:52:50 -0500288// A DeviceConfig object represents the configuration for a particular device
289// being built. For now there will only be one of these, but in the future there
290// may be multiple devices being built.
Colin Cross9272ade2016-08-17 15:24:12 -0700291type DeviceConfig struct {
292 *deviceConfig
293}
294
Jingwen Chenc711fec2020-11-22 23:52:50 -0500295// VendorConfig represents the configuration for vendor-specific behavior.
Colin Cross9d34f352019-11-22 16:03:51 -0800296type VendorConfig soongconfig.SoongConfig
Dan Willemsen0fe78662018-03-26 12:41:18 -0700297
Jingwen Chenc711fec2020-11-22 23:52:50 -0500298// Definition of general build configuration for soong_build. Some of these
Jingwen Chenc4d91bc2020-11-24 22:59:26 -0500299// product configuration values are read from Kati-generated soong.variables.
Colin Cross1332b002015-04-07 17:11:30 -0700300type config struct {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500301 // Options configurable with soong.variables
Cole Faustf8231dd2023-04-21 17:37:11 -0700302 productVariables ProductVariables
Colin Cross3f40fa42015-01-30 17:27:36 -0800303
Dan Willemsen674dc7f2018-03-12 18:06:05 -0700304 // Only available on configs created by TestConfig
Cole Faustf8231dd2023-04-21 17:37:11 -0700305 TestProductVariables *ProductVariables
Dan Willemsen674dc7f2018-03-12 18:06:05 -0700306
Dan Willemsen87b17d12015-07-14 00:39:06 -0700307 ProductVariablesFileName string
308
Colin Cross0c66bc62021-07-20 09:47:41 -0700309 // BuildOS stores the OsType for the OS that the build is running on.
310 BuildOS OsType
311
312 // BuildArch stores the ArchType for the CPU that the build is running on.
313 BuildArch ArchType
314
Jaewoong Jung642916f2020-10-09 17:25:15 -0700315 Targets map[OsType][]Target
316 BuildOSTarget Target // the Target for tools run on the build machine
317 BuildOSCommonTarget Target // the Target for common (java) tools run on the build machine
318 AndroidCommonTarget Target // the Target for common modules for the Android device
319 AndroidFirstDeviceTarget Target // the first Target for modules for the Android device
Dan Willemsen218f6562015-07-08 18:13:11 -0700320
LaMont Jones99f18962024-10-17 11:50:44 -0700321 // Flags for Partial Compile, derived from SOONG_PARTIAL_COMPILE.
322 partialCompileFlags partialCompileFlags
323
Jingwen Chenc711fec2020-11-22 23:52:50 -0500324 // multilibConflicts for an ArchType is true if there is earlier configured
325 // device architecture with the same multilib value.
Colin Cross3b19f5d2019-09-17 14:45:31 -0700326 multilibConflicts map[ArchType]bool
327
Colin Cross9272ade2016-08-17 15:24:12 -0700328 deviceConfig *deviceConfig
329
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200330 outDir string // The output directory (usually out/)
331 soongOutDir string
Chris Parsons8f232a22020-06-23 17:37:05 -0400332 moduleListFile string // the path to the file which lists blueprint files to parse.
Colin Crossc1e86a32015-04-15 12:33:28 -0700333
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +0200334 runGoTests bool
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200335
Colin Cross6ccbc912017-10-10 23:07:38 -0700336 env map[string]string
Dan Willemsene7680ba2015-09-11 17:06:19 -0700337 envLock sync.Mutex
338 envDeps map[string]string
339 envFrozen bool
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800340
Jingwen Chencda22c92020-11-23 00:22:30 -0500341 // Changes behavior based on whether Kati runs after soong_build, or if soong_build
342 // runs standalone.
343 katiEnabled bool
Colin Cross1e7d3702016-08-24 15:25:47 -0700344
Colin Cross32616ed2017-09-05 21:56:44 -0700345 captureBuild bool // true for tests, saves build parameters for each module
346 ignoreEnvironment bool // true for tests, returns empty from all Getenv calls
Colin Crosscec81712017-07-13 14:43:27 -0700347
Colin Cross98be1bb2019-12-13 20:41:13 -0800348 fs pathtools.FileSystem
349 mockBpList string
350
Colin Crossb63d7b32023-12-07 16:54:51 -0800351 BuildMode SoongBuildMode
Jingwen Chen12b4c272021-03-10 02:05:59 -0500352
Colin Cross5e6a7972020-06-07 16:56:32 -0700353 // If testAllowNonExistentPaths is true then PathForSource and PathForModuleSrc won't error
354 // in tests when a path doesn't exist.
Pedro Loureiro5d190cc2021-02-15 15:41:33 +0000355 TestAllowNonExistentPaths bool
Colin Cross5e6a7972020-06-07 16:56:32 -0700356
Jingwen Chenc711fec2020-11-22 23:52:50 -0500357 // The list of files that when changed, must invalidate soong_build to
358 // regenerate build.ninja.
Colin Cross12129292020-10-29 18:23:58 -0700359 ninjaFileDepsSet sync.Map
360
Colin Cross9272ade2016-08-17 15:24:12 -0700361 OncePer
MarkDacekff851b82022-04-21 18:33:17 +0000362
Jihoon Kang2a929ad2023-06-08 19:02:07 +0000363 // If buildFromSourceStub is true then the Java API stubs are
364 // built from the source Java files, not the signature text files.
365 buildFromSourceStub bool
MarkDacekf47e1422023-04-19 16:47:36 +0000366
367 // If ensureAllowlistIntegrity is true, then the presence of any allowlisted
368 // modules that aren't mixed-built for at least one variant will cause a build
369 // failure
370 ensureAllowlistIntegrity bool
Colin Cross9272ade2016-08-17 15:24:12 -0700371}
372
LaMont Jones99f18962024-10-17 11:50:44 -0700373type partialCompileFlags struct {
374 // Is partial compilation enabled at all?
375 enabled bool
376
377 // Whether to use d8 instead of r8
378 use_d8 bool
379
380 // Add others as needed.
381}
382
Colin Cross9272ade2016-08-17 15:24:12 -0700383type deviceConfig struct {
Dan Willemsen00269f22017-07-06 16:59:48 -0700384 config *config
Colin Cross9272ade2016-08-17 15:24:12 -0700385 OncePer
Colin Cross3f40fa42015-01-30 17:27:36 -0800386}
387
Colin Cross485e5722015-08-27 13:28:01 -0700388type jsonConfigurable interface {
Colin Cross27385972015-09-18 10:57:10 -0700389 SetDefaultConfig()
Colin Cross485e5722015-08-27 13:28:01 -0700390}
Colin Cross3f40fa42015-01-30 17:27:36 -0800391
LaMont Jones99f18962024-10-17 11:50:44 -0700392// Parse SOONG_PARTIAL_COMPILE.
393//
394// SOONG_PARTIAL_COMPILE determines which features are enabled or disabled in
395// rule generation. Changing this environment variable causes reanalysis.
396//
397// SOONG_USE_PARTIAL_COMPILE determines whether or not we **use** PARTIAL_COMPILE.
398// Rule generation must support both cases, since changing it does not cause
399// reanalysis.
400//
401// The user-facing documentation shows:
402//
403// - empty or not set: "The current default state"
404// - "true" or "on": enable all stable partial compile features.
405// - "false" or "off": disable partial compile completely.
406//
407// What we actually allow is a comma separated list of tokens, whose first
408// character may be "+" (enable) or "-" (disable). If neither is present, "+"
409// is assumed. For example, "on,+use_d8" will enable partial compilation, and
410// additionally set the use_d8 flag (regardless of whether it is opt-in or
411// opt-out).
412//
413// To add a new feature to the list, add the field in the struct
414// `partialCompileFlags` above, and then add the name of the field in the
415// switch statement below.
LaMont Jones768b00f2024-10-21 12:36:03 -0700416var defaultPartialCompileFlags = partialCompileFlags{
417 // Set any opt-out flags here. Opt-in flags are off by default.
418 enabled: false,
419}
420
421func (c *config) parsePartialCompileFlags(isEngBuild bool) (partialCompileFlags, error) {
LaMont Jones99f18962024-10-17 11:50:44 -0700422 value := c.Getenv("SOONG_PARTIAL_COMPILE")
LaMont Jones768b00f2024-10-21 12:36:03 -0700423 if !isEngBuild {
424 return partialCompileFlags{}, nil
425 }
LaMont Jones99f18962024-10-17 11:50:44 -0700426 if value == "" {
LaMont Jones768b00f2024-10-21 12:36:03 -0700427 return defaultPartialCompileFlags, nil
LaMont Jones99f18962024-10-17 11:50:44 -0700428 }
429
LaMont Jones768b00f2024-10-21 12:36:03 -0700430 ret := defaultPartialCompileFlags
LaMont Jones99f18962024-10-17 11:50:44 -0700431 tokens := strings.Split(strings.ToLower(value), ",")
432 makeVal := func(state string, defaultValue bool) bool {
433 switch state {
434 case "":
435 return defaultValue
436 case "-":
437 return false
438 case "+":
439 return true
440 }
441 return false
442 }
443 for _, tok := range tokens {
444 var state string
445 if len(tok) == 0 {
446 continue
447 }
448 switch tok[0:1] {
449 case "":
450 // Ignore empty tokens.
451 continue
452 case "-", "+":
453 state = tok[0:1]
454 tok = tok[1:]
455 default:
456 // Treat `feature` as `+feature`.
457 state = "+"
458 }
459 switch tok {
460 case "true":
LaMont Jones768b00f2024-10-21 12:36:03 -0700461 ret = defaultPartialCompileFlags
LaMont Jones99f18962024-10-17 11:50:44 -0700462 ret.enabled = true
463 case "false":
464 // Set everything to false.
465 ret = partialCompileFlags{}
466 case "enabled":
LaMont Jones768b00f2024-10-21 12:36:03 -0700467 ret.enabled = makeVal(state, defaultPartialCompileFlags.enabled)
LaMont Jones99f18962024-10-17 11:50:44 -0700468 case "use_d8":
LaMont Jones768b00f2024-10-21 12:36:03 -0700469 ret.use_d8 = makeVal(state, defaultPartialCompileFlags.use_d8)
LaMont Jones99f18962024-10-17 11:50:44 -0700470 default:
LaMont Jones768b00f2024-10-21 12:36:03 -0700471 return partialCompileFlags{}, fmt.Errorf("Unknown SOONG_PARTIAL_COMPILE value: %v", tok)
LaMont Jones99f18962024-10-17 11:50:44 -0700472 }
473 }
474 return ret, nil
475}
476
Colin Cross485e5722015-08-27 13:28:01 -0700477func loadConfig(config *config) error {
Colin Cross988414c2020-01-11 01:11:46 +0000478 return loadFromConfigFile(&config.productVariables, absolutePath(config.ProductVariablesFileName))
Colin Cross485e5722015-08-27 13:28:01 -0700479}
480
Cole Faustd92430e2024-02-07 01:02:04 +0000481// Checks if the string is a valid go identifier. This is equivalent to blueprint's definition
482// of an identifier, so it will match the same identifiers as those that can be used in bp files.
483func isGoIdentifier(ident string) bool {
484 for i, r := range ident {
485 valid := r == '_' || unicode.IsLetter(r) || unicode.IsDigit(r) && i > 0
486 if !valid {
487 return false
488 }
489 }
490 return len(ident) > 0
491}
492
Jingwen Chenc711fec2020-11-22 23:52:50 -0500493// loadFromConfigFile loads and decodes configuration options from a JSON file
494// in the current working directory.
Cole Faustf8231dd2023-04-21 17:37:11 -0700495func loadFromConfigFile(configurable *ProductVariables, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800496 // Try to open the file
Colin Cross485e5722015-08-27 13:28:01 -0700497 configFileReader, err := os.Open(filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800498 defer configFileReader.Close()
499 if os.IsNotExist(err) {
500 // Need to create a file, so that blueprint & ninja don't get in
501 // a dependency tracking loop.
502 // Make a file-configurable-options with defaults, write it out using
503 // a json writer.
Colin Cross27385972015-09-18 10:57:10 -0700504 configurable.SetDefaultConfig()
505 err = saveToConfigFile(configurable, filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800506 if err != nil {
507 return err
508 }
Colin Cross15cd21a2018-02-27 11:26:02 -0800509 } else if err != nil {
510 return fmt.Errorf("config file: could not open %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800511 } else {
512 // Make a decoder for it
513 jsonDecoder := json.NewDecoder(configFileReader)
Cole Fauste1129b82024-06-04 11:10:11 -0700514 jsonDecoder.DisallowUnknownFields()
Colin Cross485e5722015-08-27 13:28:01 -0700515 err = jsonDecoder.Decode(configurable)
Colin Cross3f40fa42015-01-30 17:27:36 -0800516 if err != nil {
Colin Cross15cd21a2018-02-27 11:26:02 -0800517 return fmt.Errorf("config file: %s did not parse correctly: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800518 }
519 }
520
Liz Kammer09f947d2021-05-12 14:51:49 -0400521 if Bool(configurable.GcovCoverage) && Bool(configurable.ClangCoverage) {
522 return fmt.Errorf("GcovCoverage and ClangCoverage cannot both be set")
523 }
524
525 configurable.Native_coverage = proptools.BoolPtr(
526 Bool(configurable.GcovCoverage) ||
527 Bool(configurable.ClangCoverage))
528
Cole Faustd92430e2024-02-07 01:02:04 +0000529 // The go scanner's definition of identifiers is c-style identifiers, but allowing unicode's
530 // definition of letters and digits. This is the same scanner that blueprint uses, so it
531 // will allow the same identifiers as are valid in bp files.
532 for namespace := range configurable.VendorVars {
533 if !isGoIdentifier(namespace) {
534 return fmt.Errorf("soong config namespaces must be valid identifiers: %q", namespace)
535 }
536 for variable := range configurable.VendorVars[namespace] {
537 if !isGoIdentifier(variable) {
538 return fmt.Errorf("soong config variables must be valid identifiers: %q", variable)
539 }
540 }
541 }
542
Yuntao Xu402e9b02021-08-09 15:44:44 -0700543 // when Platform_sdk_final is true (or PLATFORM_VERSION_CODENAME is REL), use Platform_sdk_version;
544 // if false (pre-released version, for example), use Platform_sdk_codename.
545 if Bool(configurable.Platform_sdk_final) {
546 if configurable.Platform_sdk_version != nil {
547 configurable.Platform_sdk_version_or_codename =
548 proptools.StringPtr(strconv.Itoa(*(configurable.Platform_sdk_version)))
549 } else {
550 return fmt.Errorf("Platform_sdk_version cannot be pointed by a NULL pointer")
551 }
552 } else {
553 configurable.Platform_sdk_version_or_codename =
554 proptools.StringPtr(String(configurable.Platform_sdk_codename))
555 }
556
Cole Faustad186492024-06-14 14:13:54 -0700557 return nil
Colin Cross3f40fa42015-01-30 17:27:36 -0800558}
559
Colin Crossd8f20142016-11-03 09:43:26 -0700560// atomically writes the config file in case two copies of soong_build are running simultaneously
561// (for example, docs generation and ninja manifest generation)
Cole Faustf8231dd2023-04-21 17:37:11 -0700562func saveToConfigFile(config *ProductVariables, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800563 data, err := json.MarshalIndent(&config, "", " ")
564 if err != nil {
565 return fmt.Errorf("cannot marshal config data: %s", err.Error())
566 }
567
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800568 f, err := os.CreateTemp(filepath.Dir(filename), "config")
Colin Cross3f40fa42015-01-30 17:27:36 -0800569 if err != nil {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500570 return fmt.Errorf("cannot create empty config file %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800571 }
Colin Crossd8f20142016-11-03 09:43:26 -0700572 defer os.Remove(f.Name())
573 defer f.Close()
Colin Cross3f40fa42015-01-30 17:27:36 -0800574
Colin Crossd8f20142016-11-03 09:43:26 -0700575 _, err = f.Write(data)
Colin Cross3f40fa42015-01-30 17:27:36 -0800576 if err != nil {
Colin Cross485e5722015-08-27 13:28:01 -0700577 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
578 }
579
Colin Crossd8f20142016-11-03 09:43:26 -0700580 _, err = f.WriteString("\n")
Colin Cross485e5722015-08-27 13:28:01 -0700581 if err != nil {
582 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800583 }
584
Colin Crossd8f20142016-11-03 09:43:26 -0700585 f.Close()
586 os.Rename(f.Name(), filename)
587
Colin Cross3f40fa42015-01-30 17:27:36 -0800588 return nil
589}
590
Colin Cross988414c2020-01-11 01:11:46 +0000591// NullConfig returns a mostly empty Config for use by standalone tools like dexpreopt_gen that
592// use the android package.
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200593func NullConfig(outDir, soongOutDir string) Config {
Colin Cross988414c2020-01-11 01:11:46 +0000594 return Config{
595 config: &config{
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200596 outDir: outDir,
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200597 soongOutDir: soongOutDir,
598 fs: pathtools.OsFs,
Colin Cross988414c2020-01-11 01:11:46 +0000599 },
600 }
601}
602
Jingwen Chenc711fec2020-11-22 23:52:50 -0500603// NewConfig creates a new Config object. The srcDir argument specifies the path
604// to the root source directory. It also loads the config file, if found.
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800605func NewConfig(cmdArgs CmdArgs, availableEnv map[string]string) (Config, error) {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500606 // Make a config with default options.
Colin Cross9272ade2016-08-17 15:24:12 -0700607 config := &config{
Kiyoung Kima37d9ba2023-04-19 13:13:45 +0900608 ProductVariablesFileName: cmdArgs.SoongVariables,
Dan Willemsen87b17d12015-07-14 00:39:06 -0700609
Lukacs T. Berki53b2f362021-04-12 14:04:24 +0200610 env: availableEnv,
Colin Cross6ccbc912017-10-10 23:07:38 -0700611
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800612 outDir: cmdArgs.OutDir,
613 soongOutDir: cmdArgs.SoongOutDir,
614 runGoTests: cmdArgs.RunGoTests,
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +0200615 multilibConflicts: make(map[ArchType]bool),
Colin Cross98be1bb2019-12-13 20:41:13 -0800616
Colin Crossb63d7b32023-12-07 16:54:51 -0800617 moduleListFile: cmdArgs.ModuleListFile,
618 fs: pathtools.NewOsFs(absSrcDir),
Chris Parsons9402ca82023-02-23 17:28:06 -0500619
Jihoon Kang2a929ad2023-06-08 19:02:07 +0000620 buildFromSourceStub: cmdArgs.BuildFromSourceStub,
Colin Cross68f55102015-03-25 14:43:57 -0700621 }
LaMont Jones768b00f2024-10-21 12:36:03 -0700622 variant, ok := os.LookupEnv("TARGET_BUILD_VARIANT")
623 isEngBuild := !ok || variant == "eng"
624
625 if isEngBuild {
626 // Partial Compile is only supported on eng builds.
627 config.env["SOONG_PARTIAL_COMPILE"] = "false"
628 config.env["SOONG_USE_PARTIAL_COMPILE"] = ""
629 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800630
Dan Willemsen00269f22017-07-06 16:59:48 -0700631 config.deviceConfig = &deviceConfig{
Colin Cross9272ade2016-08-17 15:24:12 -0700632 config: config,
633 }
634
Liz Kammer7941b302020-07-28 13:27:34 -0700635 // Soundness check of the build and source directories. This won't catch strange
636 // configurations with symlinks, but at least checks the obvious case.
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800637 absBuildDir, err := filepath.Abs(cmdArgs.SoongOutDir)
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700638 if err != nil {
639 return Config{}, err
640 }
641
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200642 absSrcDir, err := filepath.Abs(".")
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700643 if err != nil {
644 return Config{}, err
645 }
646
647 if strings.HasPrefix(absSrcDir, absBuildDir) {
648 return Config{}, fmt.Errorf("Build dir must not contain source directory")
649 }
650
Colin Cross3f40fa42015-01-30 17:27:36 -0800651 // Load any configurable options from the configuration file
Colin Cross9272ade2016-08-17 15:24:12 -0700652 err = loadConfig(config)
Colin Cross3f40fa42015-01-30 17:27:36 -0800653 if err != nil {
Colin Crossc3c0a492015-04-10 15:43:55 -0700654 return Config{}, err
Colin Cross3f40fa42015-01-30 17:27:36 -0800655 }
656
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800657 KatiEnabledMarkerFile := filepath.Join(cmdArgs.SoongOutDir, ".soong.kati_enabled")
Jingwen Chencda22c92020-11-23 00:22:30 -0500658 if _, err := os.Stat(absolutePath(KatiEnabledMarkerFile)); err == nil {
659 config.katiEnabled = true
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800660 }
661
Colin Cross0c66bc62021-07-20 09:47:41 -0700662 determineBuildOS(config)
663
Jingwen Chenc711fec2020-11-22 23:52:50 -0500664 // Sets up the map of target OSes to the finer grained compilation targets
665 // that are configured from the product variables.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700666 targets, err := decodeTargetProductVariables(config)
Dan Willemsen218f6562015-07-08 18:13:11 -0700667 if err != nil {
668 return Config{}, err
669 }
670
LaMont Jones768b00f2024-10-21 12:36:03 -0700671 config.partialCompileFlags, err = config.parsePartialCompileFlags(isEngBuild)
LaMont Jones99f18962024-10-17 11:50:44 -0700672 if err != nil {
673 return Config{}, err
674 }
675
Paul Duffin1356d8c2020-02-25 19:26:33 +0000676 // Make the CommonOS OsType available for all products.
677 targets[CommonOS] = []Target{commonTargetMap[CommonOS.Name]}
678
Dan Albert4098deb2016-10-19 14:04:41 -0700679 var archConfig []archConfig
Jingwen Chenc4d91bc2020-11-24 22:59:26 -0500680 if config.NdkAbis() {
Dan Albert4098deb2016-10-19 14:04:41 -0700681 archConfig = getNdkAbisConfig()
Martin Stjernholmc1ecc432019-11-15 15:00:31 +0000682 } else if config.AmlAbis() {
683 archConfig = getAmlAbisConfig()
Dan Albert4098deb2016-10-19 14:04:41 -0700684 }
685
686 if archConfig != nil {
Liz Kammerb7f33662022-02-28 14:16:16 -0500687 androidTargets, err := decodeAndroidArchSettings(archConfig)
Dan Willemsen322acaf2016-01-12 23:07:05 -0800688 if err != nil {
689 return Config{}, err
690 }
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700691 targets[Android] = androidTargets
Dan Willemsen322acaf2016-01-12 23:07:05 -0800692 }
693
Colin Cross3b19f5d2019-09-17 14:45:31 -0700694 multilib := make(map[string]bool)
695 for _, target := range targets[Android] {
696 if seen := multilib[target.Arch.ArchType.Multilib]; seen {
697 config.multilibConflicts[target.Arch.ArchType] = true
698 }
699 multilib[target.Arch.ArchType.Multilib] = true
700 }
701
Jingwen Chenc711fec2020-11-22 23:52:50 -0500702 // Map of OS to compilation targets.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700703 config.Targets = targets
Jingwen Chenc711fec2020-11-22 23:52:50 -0500704
705 // Compilation targets for host tools.
Colin Cross0c66bc62021-07-20 09:47:41 -0700706 config.BuildOSTarget = config.Targets[config.BuildOS][0]
707 config.BuildOSCommonTarget = getCommonTargets(config.Targets[config.BuildOS])[0]
Jingwen Chenc711fec2020-11-22 23:52:50 -0500708
709 // Compilation targets for Android.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700710 if len(config.Targets[Android]) > 0 {
711 config.AndroidCommonTarget = getCommonTargets(config.Targets[Android])[0]
Sam Delmericocc271e22022-06-01 15:45:02 +0000712 config.AndroidFirstDeviceTarget = FirstTarget(config.Targets[Android], "lib64", "lib32")[0]
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700713 }
Dan Willemsen218f6562015-07-08 18:13:11 -0700714
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500715 setBuildMode := func(arg string, mode SoongBuildMode) {
716 if arg != "" {
717 if config.BuildMode != AnalysisNoBazel {
718 fmt.Fprintf(os.Stderr, "buildMode is already set, illegal argument: %s", arg)
719 os.Exit(1)
720 }
721 config.BuildMode = mode
722 }
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800723 }
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500724 setBuildMode(cmdArgs.ModuleGraphFile, GenerateModuleGraph)
725 setBuildMode(cmdArgs.DocFile, GenerateDocFile)
MarkDacekd06db5d2022-11-29 00:47:59 +0000726
Jihoon Kangc1b04d62023-11-16 19:07:04 +0000727 config.productVariables.Build_from_text_stub = boolPtr(config.BuildFromTextStub())
728
Jingwen Chenc711fec2020-11-22 23:52:50 -0500729 return Config{config}, err
730}
Colin Cross988414c2020-01-11 01:11:46 +0000731
Colin Cross98be1bb2019-12-13 20:41:13 -0800732// mockFileSystem replaces all reads with accesses to the provided map of
733// filenames to contents stored as a byte slice.
734func (c *config) mockFileSystem(bp string, fs map[string][]byte) {
735 mockFS := map[string][]byte{}
736
737 if _, exists := mockFS["Android.bp"]; !exists {
738 mockFS["Android.bp"] = []byte(bp)
739 }
740
741 for k, v := range fs {
742 mockFS[k] = v
743 }
744
745 // no module list file specified; find every file named Blueprints or Android.bp
746 pathsToParse := []string{}
747 for candidate := range mockFS {
748 base := filepath.Base(candidate)
Lukacs T. Berkib838b0a2021-09-02 11:46:24 +0200749 if base == "Android.bp" {
Colin Cross98be1bb2019-12-13 20:41:13 -0800750 pathsToParse = append(pathsToParse, candidate)
751 }
752 }
753 if len(pathsToParse) < 1 {
754 panic(fmt.Sprintf("No Blueprint or Android.bp files found in mock filesystem: %v\n", mockFS))
755 }
756 mockFS[blueprint.MockModuleListFile] = []byte(strings.Join(pathsToParse, "\n"))
757
758 c.fs = pathtools.MockFs(mockFS)
759 c.mockBpList = blueprint.MockModuleListFile
760}
761
Lukacs T. Berkid1e3f1f2021-03-16 08:55:23 +0100762func (c *config) SetAllowMissingDependencies() {
763 c.productVariables.Allow_missing_dependencies = proptools.BoolPtr(true)
764}
765
Jingwen Chenc711fec2020-11-22 23:52:50 -0500766// BlueprintToolLocation returns the directory containing build system tools
767// from Blueprint, like soong_zip and merge_zips.
Lukacs T. Berkia806e412021-09-01 08:57:48 +0200768func (c *config) HostToolDir() string {
Colin Crossacfcc1f2021-10-25 15:40:32 -0700769 if c.KatiEnabled() {
770 return filepath.Join(c.outDir, "host", c.PrebuiltOS(), "bin")
771 } else {
772 return filepath.Join(c.soongOutDir, "host", c.PrebuiltOS(), "bin")
773 }
Dan Willemsenc2aa4a92016-05-26 15:13:03 -0700774}
775
Dan Willemsen60e62f02018-11-16 21:05:32 -0800776func (c *config) HostToolPath(ctx PathContext, tool string) Path {
Cole Faust3b703f32023-10-16 13:30:51 -0700777 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "bin", tool)
Colin Cross790ef352021-10-25 19:15:55 -0700778 return path
Dan Willemsen60e62f02018-11-16 21:05:32 -0800779}
780
Colin Cross790ef352021-10-25 19:15:55 -0700781func (c *config) HostJNIToolPath(ctx PathContext, lib string) Path {
Martin Stjernholm7260d062019-12-09 21:47:14 +0000782 ext := ".so"
783 if runtime.GOOS == "darwin" {
784 ext = ".dylib"
785 }
Cole Faust3b703f32023-10-16 13:30:51 -0700786 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "lib64", lib+ext)
Colin Cross790ef352021-10-25 19:15:55 -0700787 return path
Martin Stjernholm7260d062019-12-09 21:47:14 +0000788}
789
Colin Crossae5330a2021-11-03 13:31:22 -0700790func (c *config) HostJavaToolPath(ctx PathContext, tool string) Path {
Cole Faust3b703f32023-10-16 13:30:51 -0700791 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "framework", tool)
Colin Cross3e3eda62021-11-04 10:22:51 -0700792 return path
793}
794
Vinh Tran09581952023-05-16 16:03:20 -0400795func (c *config) HostCcSharedLibPath(ctx PathContext, lib string) Path {
796 libDir := "lib"
797 if ctx.Config().BuildArch.Multilib == "lib64" {
798 libDir = "lib64"
799 }
Cole Faust3b703f32023-10-16 13:30:51 -0700800 return pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, libDir, lib+".so")
Vinh Tran09581952023-05-16 16:03:20 -0400801}
802
Jingwen Chenc711fec2020-11-22 23:52:50 -0500803// PrebuiltOS returns the name of the host OS used in prebuilts directories.
Colin Cross1332b002015-04-07 17:11:30 -0700804func (c *config) PrebuiltOS() string {
Colin Cross3f40fa42015-01-30 17:27:36 -0800805 switch runtime.GOOS {
806 case "linux":
807 return "linux-x86"
808 case "darwin":
809 return "darwin-x86"
810 default:
811 panic("Unknown GOOS")
812 }
813}
814
815// GoRoot returns the path to the root directory of the Go toolchain.
Colin Cross1332b002015-04-07 17:11:30 -0700816func (c *config) GoRoot() string {
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200817 return fmt.Sprintf("prebuilts/go/%s", c.PrebuiltOS())
Colin Cross3f40fa42015-01-30 17:27:36 -0800818}
819
Jingwen Chenc711fec2020-11-22 23:52:50 -0500820// PrebuiltBuildTool returns the path to a tool in the prebuilts directory containing
821// checked-in tools, like Kati, Ninja or Toybox, for the current host OS.
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700822func (c *config) PrebuiltBuildTool(ctx PathContext, tool string) Path {
823 return PathForSource(ctx, "prebuilts/build-tools", c.PrebuiltOS(), "bin", tool)
824}
825
Jingwen Chenc711fec2020-11-22 23:52:50 -0500826// CpPreserveSymlinksFlags returns the host-specific flag for the cp(1) command
827// to preserve symlinks.
Colin Cross1332b002015-04-07 17:11:30 -0700828func (c *config) CpPreserveSymlinksFlags() string {
Colin Cross485e5722015-08-27 13:28:01 -0700829 switch runtime.GOOS {
Colin Cross3f40fa42015-01-30 17:27:36 -0800830 case "darwin":
831 return "-R"
832 case "linux":
833 return "-d"
834 default:
835 return ""
836 }
837}
Colin Cross68f55102015-03-25 14:43:57 -0700838
Colin Cross1332b002015-04-07 17:11:30 -0700839func (c *config) Getenv(key string) string {
Colin Cross68f55102015-03-25 14:43:57 -0700840 var val string
841 var exists bool
Colin Crossc1e86a32015-04-15 12:33:28 -0700842 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800843 defer c.envLock.Unlock()
844 if c.envDeps == nil {
845 c.envDeps = make(map[string]string)
846 }
Colin Cross68f55102015-03-25 14:43:57 -0700847 if val, exists = c.envDeps[key]; !exists {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700848 if c.envFrozen {
849 panic("Cannot access new environment variables after envdeps are frozen")
850 }
Colin Cross6ccbc912017-10-10 23:07:38 -0700851 val, _ = c.env[key]
Colin Cross68f55102015-03-25 14:43:57 -0700852 c.envDeps[key] = val
853 }
854 return val
855}
856
Colin Cross99d7c232016-11-23 16:52:04 -0800857func (c *config) GetenvWithDefault(key string, defaultValue string) string {
858 ret := c.Getenv(key)
859 if ret == "" {
860 return defaultValue
861 }
862 return ret
863}
864
865func (c *config) IsEnvTrue(key string) bool {
AdityaK19384102024-05-01 13:51:25 -0700866 value := strings.ToLower(c.Getenv(key))
Colin Cross99d7c232016-11-23 16:52:04 -0800867 return value == "1" || value == "y" || value == "yes" || value == "on" || value == "true"
868}
869
870func (c *config) IsEnvFalse(key string) bool {
AdityaK19384102024-05-01 13:51:25 -0700871 value := strings.ToLower(c.Getenv(key))
Colin Cross99d7c232016-11-23 16:52:04 -0800872 return value == "0" || value == "n" || value == "no" || value == "off" || value == "false"
873}
874
Sorin Basca253f8c02024-05-23 10:28:24 +0100875func (c *config) TargetsJava21() bool {
876 return c.IsEnvTrue("EXPERIMENTAL_TARGET_JAVA_VERSION_21")
877}
878
Jingwen Chenc711fec2020-11-22 23:52:50 -0500879// EnvDeps returns the environment variables this build depends on. The first
880// call to this function blocks future reads from the environment.
Colin Cross1332b002015-04-07 17:11:30 -0700881func (c *config) EnvDeps() map[string]string {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700882 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800883 defer c.envLock.Unlock()
Dan Willemsene7680ba2015-09-11 17:06:19 -0700884 c.envFrozen = true
Colin Cross68f55102015-03-25 14:43:57 -0700885 return c.envDeps
886}
Colin Cross35cec122015-04-02 14:37:16 -0700887
Jingwen Chencda22c92020-11-23 00:22:30 -0500888func (c *config) KatiEnabled() bool {
889 return c.katiEnabled
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800890}
891
Cole Faust11edf552023-10-13 11:32:14 -0700892func (c *config) ProductVariables() ProductVariables {
893 return c.productVariables
894}
895
Nan Zhang581fd212018-01-10 16:06:12 -0800896func (c *config) BuildId() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800897 return String(c.productVariables.BuildId)
Nan Zhang581fd212018-01-10 16:06:12 -0800898}
899
Inseob Kim8fa54da2024-03-19 16:48:59 +0900900func (c *config) DisplayBuildNumber() bool {
901 return Bool(c.productVariables.DisplayBuildNumber)
902}
903
Inseob Kim2da72af2024-06-18 11:09:12 +0900904// BuildFingerprintFile returns the path to a text file containing metadata
905// representing the current build's fingerprint.
906//
907// Rules that want to reference the build fingerprint should read from this file
908// without depending on it. They will run whenever their other dependencies
909// require them to run and get the current build fingerprint. This ensures they
910// don't rebuild on every incremental build when the build number changes.
911func (c *config) BuildFingerprintFile(ctx PathContext) Path {
912 return PathForArbitraryOutput(ctx, "target", "product", c.DeviceName(), String(c.productVariables.BuildFingerprintFile))
913}
914
Jingwen Chenc711fec2020-11-22 23:52:50 -0500915// BuildNumberFile returns the path to a text file containing metadata
916// representing the current build's number.
917//
918// Rules that want to reference the build number should read from this file
919// without depending on it. They will run whenever their other dependencies
920// require them to run and get the current build number. This ensures they don't
921// rebuild on every incremental build when the build number changes.
Colin Cross2a2e0db2020-02-21 16:55:46 -0800922func (c *config) BuildNumberFile(ctx PathContext) Path {
923 return PathForOutput(ctx, String(c.productVariables.BuildNumberFile))
Nan Zhang581fd212018-01-10 16:06:12 -0800924}
925
Inseob Kim8fa54da2024-03-19 16:48:59 +0900926// BuildHostnameFile returns the path to a text file containing metadata
927// representing the current build's host name.
928func (c *config) BuildHostnameFile(ctx PathContext) Path {
929 return PathForOutput(ctx, String(c.productVariables.BuildHostnameFile))
930}
931
932// BuildThumbprintFile returns the path to a text file containing metadata
933// representing the current build's thumbprint.
934//
935// Rules that want to reference the build thumbprint should read from this file
936// without depending on it. They will run whenever their other dependencies
937// require them to run and get the current build thumbprint. This ensures they
938// don't rebuild on every incremental build when the build thumbprint changes.
939func (c *config) BuildThumbprintFile(ctx PathContext) Path {
940 return PathForArbitraryOutput(ctx, "target", "product", c.DeviceName(), String(c.productVariables.BuildThumbprintFile))
941}
942
Jingwen Chenc711fec2020-11-22 23:52:50 -0500943// DeviceName returns the name of the current device target.
Colin Cross35cec122015-04-02 14:37:16 -0700944// TODO: take an AndroidModuleContext to select the device name for multi-device builds
Colin Cross1332b002015-04-07 17:11:30 -0700945func (c *config) DeviceName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800946 return *c.productVariables.DeviceName
Colin Cross35cec122015-04-02 14:37:16 -0700947}
948
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000949// DeviceProduct returns the current product target. There could be multiple of
950// these per device type.
951//
Chris Parsonsef615e52022-08-18 22:04:11 -0400952// NOTE: Do not base conditional logic on this value. It may break product inheritance.
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000953func (c *config) DeviceProduct() string {
954 return *c.productVariables.DeviceProduct
955}
956
Cole Faustb85d1a12022-11-08 18:14:01 -0800957// HasDeviceProduct returns if the build has a product. A build will not
958// necessarily have a product when --skip-config is passed to soong, like it is
959// in prebuilts/build-tools/build-prebuilts.sh
960func (c *config) HasDeviceProduct() bool {
961 return c.productVariables.DeviceProduct != nil
962}
963
Inseob Kim8fa54da2024-03-19 16:48:59 +0900964func (c *config) DeviceAbi() []string {
965 return c.productVariables.DeviceAbi
966}
967
Anton Hansson53c88442019-03-18 15:53:16 +0000968func (c *config) DeviceResourceOverlays() []string {
969 return c.productVariables.DeviceResourceOverlays
970}
971
972func (c *config) ProductResourceOverlays() []string {
973 return c.productVariables.ProductResourceOverlays
Colin Cross30e076a2015-04-13 13:58:27 -0700974}
975
Inseob Kim8fa54da2024-03-19 16:48:59 +0900976func (c *config) PlatformDisplayVersionName() string {
977 return String(c.productVariables.Platform_display_version_name)
978}
979
Colin Crossbfd347d2018-05-09 11:11:35 -0700980func (c *config) PlatformVersionName() string {
981 return String(c.productVariables.Platform_version_name)
982}
983
Dan Albert4f378d72020-07-23 17:32:15 -0700984func (c *config) PlatformSdkVersion() ApiLevel {
985 return uncheckedFinalApiLevel(*c.productVariables.Platform_sdk_version)
Colin Cross30e076a2015-04-13 13:58:27 -0700986}
987
Cole Faust37d27c42023-04-12 10:27:45 -0700988func (c *config) RawPlatformSdkVersion() *int {
989 return c.productVariables.Platform_sdk_version
990}
991
Mu-Le Lee5e047532022-07-27 02:32:03 +0000992func (c *config) PlatformSdkFinal() bool {
993 return Bool(c.productVariables.Platform_sdk_final)
994}
995
Colin Crossd09b0b62018-04-18 11:06:47 -0700996func (c *config) PlatformSdkCodename() string {
997 return String(c.productVariables.Platform_sdk_codename)
998}
999
Anton Hansson97d0bae2022-02-16 16:15:10 +00001000func (c *config) PlatformSdkExtensionVersion() int {
1001 return *c.productVariables.Platform_sdk_extension_version
1002}
1003
1004func (c *config) PlatformBaseSdkExtensionVersion() int {
1005 return *c.productVariables.Platform_base_sdk_extension_version
1006}
1007
Colin Cross092c9da2019-04-02 22:56:43 -07001008func (c *config) PlatformSecurityPatch() string {
1009 return String(c.productVariables.Platform_security_patch)
1010}
1011
1012func (c *config) PlatformPreviewSdkVersion() string {
1013 return String(c.productVariables.Platform_preview_sdk_version)
1014}
1015
1016func (c *config) PlatformMinSupportedTargetSdkVersion() string {
Linus Tufvessonba270c52024-04-12 13:06:22 +02001017 var val, ok = c.productVariables.BuildFlags["RELEASE_PLATFORM_MIN_SUPPORTED_TARGET_SDK_VERSION"]
1018 if !ok {
1019 return ""
1020 }
1021 return val
Colin Cross092c9da2019-04-02 22:56:43 -07001022}
1023
1024func (c *config) PlatformBaseOS() string {
1025 return String(c.productVariables.Platform_base_os)
1026}
1027
Inseob Kim4f1f3d92022-04-25 18:23:58 +09001028func (c *config) PlatformVersionLastStable() string {
1029 return String(c.productVariables.Platform_version_last_stable)
1030}
1031
Jiyong Park37073842022-06-21 10:13:42 +09001032func (c *config) PlatformVersionKnownCodenames() string {
1033 return String(c.productVariables.Platform_version_known_codenames)
1034}
1035
Dan Albert1a246272020-07-06 14:49:35 -07001036func (c *config) MinSupportedSdkVersion() ApiLevel {
Dan Albert6bfb6bb2022-08-17 20:11:57 +00001037 return uncheckedFinalApiLevel(21)
Dan Albert1a246272020-07-06 14:49:35 -07001038}
1039
1040func (c *config) FinalApiLevels() []ApiLevel {
1041 var levels []ApiLevel
Dan Albert4f378d72020-07-23 17:32:15 -07001042 for i := 1; i <= c.PlatformSdkVersion().FinalOrFutureInt(); i++ {
Dan Albert1a246272020-07-06 14:49:35 -07001043 levels = append(levels, uncheckedFinalApiLevel(i))
1044 }
1045 return levels
1046}
1047
1048func (c *config) PreviewApiLevels() []ApiLevel {
1049 var levels []ApiLevel
Dan Albertf93ea132023-10-05 20:40:46 +00001050 i := 0
1051 for _, codename := range c.PlatformVersionActiveCodenames() {
1052 if codename == "REL" {
1053 continue
1054 }
1055
Dan Albert1a246272020-07-06 14:49:35 -07001056 levels = append(levels, ApiLevel{
1057 value: codename,
1058 number: i,
1059 isPreview: true,
1060 })
Dan Albertf93ea132023-10-05 20:40:46 +00001061 i++
Dan Albert1a246272020-07-06 14:49:35 -07001062 }
1063 return levels
1064}
1065
satayevcca4ab72021-11-30 12:33:55 +00001066func (c *config) LatestPreviewApiLevel() ApiLevel {
1067 level := NoneApiLevel
1068 for _, l := range c.PreviewApiLevels() {
1069 if l.GreaterThan(level) {
1070 level = l
1071 }
1072 }
1073 return level
1074}
1075
Dan Albert1a246272020-07-06 14:49:35 -07001076func (c *config) AllSupportedApiLevels() []ApiLevel {
1077 var levels []ApiLevel
1078 levels = append(levels, c.FinalApiLevels()...)
1079 return append(levels, c.PreviewApiLevels()...)
Dan Albertf5415d72017-08-17 16:19:59 -07001080}
1081
Jingwen Chenc711fec2020-11-22 23:52:50 -05001082// DefaultAppTargetSdk returns the API level that platform apps are targeting.
1083// This converts a codename to the exact ApiLevel it represents.
Dan Albert4f378d72020-07-23 17:32:15 -07001084func (c *config) DefaultAppTargetSdk(ctx EarlyModuleContext) ApiLevel {
Colin Crossd09b0b62018-04-18 11:06:47 -07001085 if Bool(c.productVariables.Platform_sdk_final) {
1086 return c.PlatformSdkVersion()
Colin Crossd09b0b62018-04-18 11:06:47 -07001087 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001088 codename := c.PlatformSdkCodename()
Jiyong Park3a00e3d2023-03-27 17:39:48 +09001089 hostOnlyBuild := c.productVariables.DeviceArch == nil
Jingwen Chenc711fec2020-11-22 23:52:50 -05001090 if codename == "" {
Jiyong Park3a00e3d2023-03-27 17:39:48 +09001091 // There are some host-only builds (those are invoked by build-prebuilts.sh) which
1092 // don't set platform sdk codename. Platform sdk codename makes sense only when we
1093 // are building the platform. So we don't enforce the below panic for the host-only
1094 // builds.
1095 if hostOnlyBuild {
1096 return NoneApiLevel
1097 }
1098 panic("Platform_sdk_codename must be set")
Jingwen Chenc711fec2020-11-22 23:52:50 -05001099 }
1100 if codename == "REL" {
1101 panic("Platform_sdk_codename should not be REL when Platform_sdk_final is true")
1102 }
1103 return ApiLevelOrPanic(ctx, codename)
Colin Crossd09b0b62018-04-18 11:06:47 -07001104}
1105
LaMont Jones99f18962024-10-17 11:50:44 -07001106func (c *config) PartialCompileFlags() partialCompileFlags {
1107 return c.partialCompileFlags
1108}
1109
Colin Cross3bc7ffa2017-11-22 16:19:37 -08001110func (c *config) AppsDefaultVersionName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001111 return String(c.productVariables.AppsDefaultVersionName)
Colin Cross3bc7ffa2017-11-22 16:19:37 -08001112}
1113
Dan Albert31384de2017-07-28 12:39:46 -07001114// Codenames that are active in the current lunch target.
1115func (c *config) PlatformVersionActiveCodenames() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001116 return c.productVariables.Platform_version_active_codenames
Dan Albert31384de2017-07-28 12:39:46 -07001117}
1118
Dan Albert8c7a9942023-03-27 20:34:01 +00001119// All unreleased codenames.
1120func (c *config) PlatformVersionAllPreviewCodenames() []string {
1121 return c.productVariables.Platform_version_all_preview_codenames
1122}
1123
Colin Crossface4e42017-10-30 17:32:15 -07001124func (c *config) ProductAAPTConfig() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001125 return c.productVariables.AAPTConfig
Colin Cross30e076a2015-04-13 13:58:27 -07001126}
1127
Colin Crossface4e42017-10-30 17:32:15 -07001128func (c *config) ProductAAPTPreferredConfig() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001129 return String(c.productVariables.AAPTPreferredConfig)
Colin Cross30e076a2015-04-13 13:58:27 -07001130}
1131
Colin Crossface4e42017-10-30 17:32:15 -07001132func (c *config) ProductAAPTCharacteristics() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001133 return String(c.productVariables.AAPTCharacteristics)
Colin Crossface4e42017-10-30 17:32:15 -07001134}
1135
1136func (c *config) ProductAAPTPrebuiltDPI() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001137 return c.productVariables.AAPTPrebuiltDPI
Colin Cross30e076a2015-04-13 13:58:27 -07001138}
1139
Dan Willemsen34cc69e2015-09-23 15:26:20 -07001140func (c *config) DefaultAppCertificateDir(ctx PathContext) SourcePath {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001141 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -08001142 if defaultCert != "" {
1143 return PathForSource(ctx, filepath.Dir(defaultCert))
Colin Cross61ae0b72017-12-01 17:16:02 -08001144 }
Inseob Kim8fa54da2024-03-19 16:48:59 +09001145 return PathForSource(ctx, testKeyDir)
Colin Cross30e076a2015-04-13 13:58:27 -07001146}
1147
Colin Crosse1731a52017-12-14 11:22:55 -08001148func (c *config) DefaultAppCertificate(ctx PathContext) (pem, key SourcePath) {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001149 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -08001150 if defaultCert != "" {
Colin Crosse1731a52017-12-14 11:22:55 -08001151 return PathForSource(ctx, defaultCert+".x509.pem"), PathForSource(ctx, defaultCert+".pk8")
Colin Cross61ae0b72017-12-01 17:16:02 -08001152 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001153 defaultDir := c.DefaultAppCertificateDir(ctx)
1154 return defaultDir.Join(ctx, "testkey.x509.pem"), defaultDir.Join(ctx, "testkey.pk8")
Colin Cross30e076a2015-04-13 13:58:27 -07001155}
Colin Cross6ff51382015-12-17 16:39:19 -08001156
Justin Yun635e7882024-07-04 14:50:57 +09001157func (c *config) ExtraOtaKeys(ctx PathContext, recovery bool) []SourcePath {
1158 var otaKeys []string
1159 if recovery {
1160 otaKeys = c.productVariables.ExtraOtaRecoveryKeys
1161 } else {
1162 otaKeys = c.productVariables.ExtraOtaKeys
1163 }
1164
1165 otaPaths := make([]SourcePath, len(otaKeys))
1166 for i, key := range otaKeys {
1167 otaPaths[i] = PathForSource(ctx, key+".x509.pem")
1168 }
1169
1170 return otaPaths
1171}
1172
Inseob Kim8fa54da2024-03-19 16:48:59 +09001173func (c *config) BuildKeys() string {
1174 defaultCert := String(c.productVariables.DefaultAppCertificate)
1175 if defaultCert == "" || defaultCert == filepath.Join(testKeyDir, "testkey") {
1176 return "test-keys"
1177 }
1178 return "dev-keys"
1179}
1180
Jiyong Park9335a262018-12-24 11:31:58 +09001181func (c *config) ApexKeyDir(ctx ModuleContext) SourcePath {
1182 // TODO(b/121224311): define another variable such as TARGET_APEX_KEY_OVERRIDE
1183 defaultCert := String(c.productVariables.DefaultAppCertificate)
Inseob Kim8fa54da2024-03-19 16:48:59 +09001184 if defaultCert == "" || filepath.Dir(defaultCert) == testKeyDir {
Jiyong Park9335a262018-12-24 11:31:58 +09001185 // When defaultCert is unset or is set to the testkeys path, use the APEX keys
1186 // that is under the module dir
Colin Cross07e51612019-03-05 12:46:40 -08001187 return pathForModuleSrc(ctx)
Jiyong Park9335a262018-12-24 11:31:58 +09001188 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001189 // If not, APEX keys are under the specified directory
1190 return PathForSource(ctx, filepath.Dir(defaultCert))
Jiyong Park9335a262018-12-24 11:31:58 +09001191}
1192
Inseob Kim80fa7982022-08-12 21:36:25 +09001193// Certificate for the NetworkStack sepolicy context
1194func (c *config) MainlineSepolicyDevCertificatesDir(ctx ModuleContext) SourcePath {
1195 cert := String(c.productVariables.MainlineSepolicyDevCertificates)
1196 if cert != "" {
1197 return PathForSource(ctx, cert)
1198 }
1199 return c.DefaultAppCertificateDir(ctx)
1200}
1201
Jingwen Chenc711fec2020-11-22 23:52:50 -05001202// AllowMissingDependencies configures Blueprint/Soong to not fail when modules
1203// are configured to depend on non-existent modules. Note that this does not
1204// affect missing input dependencies at the Ninja level.
Colin Cross6ff51382015-12-17 16:39:19 -08001205func (c *config) AllowMissingDependencies() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001206 return Bool(c.productVariables.Allow_missing_dependencies)
Colin Cross6ff51382015-12-17 16:39:19 -08001207}
Dan Willemsen322acaf2016-01-12 23:07:05 -08001208
Jeongik Cha816a23a2020-07-08 01:09:23 +09001209// Returns true if a full platform source tree cannot be assumed.
Colin Crossfc3674a2017-09-18 17:41:52 -07001210func (c *config) UnbundledBuild() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001211 return Bool(c.productVariables.Unbundled_build)
Colin Crossfc3674a2017-09-18 17:41:52 -07001212}
1213
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +01001214// Returns true if building apps that aren't bundled with the platform.
1215// UnbundledBuild() is always true when this is true.
1216func (c *config) UnbundledBuildApps() bool {
Cole Faust701ca252021-11-23 19:02:08 -08001217 return len(c.productVariables.Unbundled_build_apps) > 0
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +01001218}
1219
Jeongik Cha4b073cd2021-06-08 11:35:00 +09001220// Returns true if building image that aren't bundled with the platform.
1221// UnbundledBuild() is always true when this is true.
1222func (c *config) UnbundledBuildImage() bool {
1223 return Bool(c.productVariables.Unbundled_build_image)
1224}
1225
Jeongik Cha816a23a2020-07-08 01:09:23 +09001226// Returns true if building modules against prebuilt SDKs.
1227func (c *config) AlwaysUsePrebuiltSdks() bool {
1228 return Bool(c.productVariables.Always_use_prebuilt_sdks)
Colin Cross1f367bf2018-12-18 22:46:24 -08001229}
1230
Colin Cross126a25c2017-10-31 13:55:34 -07001231func (c *config) MinimizeJavaDebugInfo() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001232 return Bool(c.productVariables.MinimizeJavaDebugInfo) && !Bool(c.productVariables.Eng)
Colin Cross126a25c2017-10-31 13:55:34 -07001233}
1234
Colin Crossed064c02018-09-05 16:28:13 -07001235func (c *config) Debuggable() bool {
1236 return Bool(c.productVariables.Debuggable)
1237}
1238
Jaewoong Jung1d6eb682018-11-29 15:08:44 -08001239func (c *config) Eng() bool {
1240 return Bool(c.productVariables.Eng)
1241}
1242
Inseob Kim8fa54da2024-03-19 16:48:59 +09001243func (c *config) BuildType() string {
1244 return String(c.productVariables.BuildType)
1245}
1246
Colin Crossc53c37f2021-12-08 15:42:22 -08001247// DevicePrimaryArchType returns the ArchType for the first configured device architecture, or
1248// Common if there are no device architectures.
Jiyong Park8d52f862018-07-07 18:02:07 +09001249func (c *config) DevicePrimaryArchType() ArchType {
Colin Crossc53c37f2021-12-08 15:42:22 -08001250 if androidTargets := c.Targets[Android]; len(androidTargets) > 0 {
1251 return androidTargets[0].Arch.ArchType
1252 }
1253 return Common
Jiyong Park8d52f862018-07-07 18:02:07 +09001254}
1255
Colin Cross16b23492016-01-06 14:41:07 -08001256func (c *config) SanitizeHost() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001257 return append([]string(nil), c.productVariables.SanitizeHost...)
Colin Cross16b23492016-01-06 14:41:07 -08001258}
1259
1260func (c *config) SanitizeDevice() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001261 return append([]string(nil), c.productVariables.SanitizeDevice...)
Colin Cross23ae82a2016-11-02 14:34:39 -07001262}
1263
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -07001264func (c *config) SanitizeDeviceDiag() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001265 return append([]string(nil), c.productVariables.SanitizeDeviceDiag...)
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -07001266}
1267
Colin Cross23ae82a2016-11-02 14:34:39 -07001268func (c *config) SanitizeDeviceArch() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001269 return append([]string(nil), c.productVariables.SanitizeDeviceArch...)
Colin Cross16b23492016-01-06 14:41:07 -08001270}
Colin Crossa1ad8d12016-06-01 17:09:44 -07001271
Vishwath Mohan1b017a72017-01-19 13:54:55 -08001272func (c *config) EnableCFI() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001273 if c.productVariables.EnableCFI == nil {
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -08001274 return true
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -08001275 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001276 return *c.productVariables.EnableCFI
Vishwath Mohan1b017a72017-01-19 13:54:55 -08001277}
1278
Kostya Kortchinskyd5275c82019-02-01 08:42:56 -08001279func (c *config) DisableScudo() bool {
1280 return Bool(c.productVariables.DisableScudo)
1281}
1282
Colin Crossa1ad8d12016-06-01 17:09:44 -07001283func (c *config) Android64() bool {
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001284 for _, t := range c.Targets[Android] {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001285 if t.Arch.ArchType.Multilib == "lib64" {
1286 return true
1287 }
1288 }
1289
1290 return false
1291}
Colin Cross9272ade2016-08-17 15:24:12 -07001292
Colin Cross9d45bb72016-08-29 16:14:13 -07001293func (c *config) UseGoma() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001294 return Bool(c.productVariables.UseGoma)
Colin Cross9d45bb72016-08-29 16:14:13 -07001295}
1296
Taylor Santiago3c16e612024-05-30 14:41:31 -07001297func (c *config) UseABFS() bool {
1298 return Bool(c.productVariables.UseABFS)
1299}
1300
Ramy Medhatbbf25672019-07-17 12:30:04 +00001301func (c *config) UseRBE() bool {
1302 return Bool(c.productVariables.UseRBE)
1303}
1304
Ramy Medhat8ea054a2020-01-27 14:19:44 -05001305func (c *config) UseRBEJAVAC() bool {
1306 return Bool(c.productVariables.UseRBEJAVAC)
1307}
1308
1309func (c *config) UseRBER8() bool {
1310 return Bool(c.productVariables.UseRBER8)
1311}
1312
1313func (c *config) UseRBED8() bool {
1314 return Bool(c.productVariables.UseRBED8)
1315}
1316
Colin Cross8b8bec32019-11-15 13:18:43 -08001317func (c *config) UseRemoteBuild() bool {
1318 return c.UseGoma() || c.UseRBE()
1319}
1320
Colin Cross66548102018-06-19 22:47:35 -07001321func (c *config) RunErrorProne() bool {
1322 return c.IsEnvTrue("RUN_ERROR_PRONE")
1323}
1324
Jingwen Chenc711fec2020-11-22 23:52:50 -05001325// XrefCorpusName returns the Kythe cross-reference corpus name.
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001326func (c *config) XrefCorpusName() string {
1327 return c.Getenv("XREF_CORPUS")
1328}
1329
Jingwen Chenc711fec2020-11-22 23:52:50 -05001330// XrefCuEncoding returns the compilation unit encoding to use for Kythe code
1331// xrefs. Can be 'json' (default), 'proto' or 'all'.
Sasha Smundak6c2d4f92020-01-09 17:34:23 -08001332func (c *config) XrefCuEncoding() string {
1333 if enc := c.Getenv("KYTHE_KZIP_ENCODING"); enc != "" {
1334 return enc
1335 }
1336 return "json"
1337}
1338
Sasha Smundakb0addaf2021-02-16 10:39:40 -08001339// XrefCuJavaSourceMax returns the maximum number of the Java source files
1340// in a single compilation unit
1341const xrefJavaSourceFileMaxDefault = "1000"
1342
1343func (c Config) XrefCuJavaSourceMax() string {
1344 v := c.Getenv("KYTHE_JAVA_SOURCE_BATCH_SIZE")
1345 if v == "" {
1346 return xrefJavaSourceFileMaxDefault
1347 }
1348 if _, err := strconv.ParseUint(v, 0, 0); err != nil {
1349 fmt.Fprintf(os.Stderr,
1350 "bad KYTHE_JAVA_SOURCE_BATCH_SIZE value: %s, will use %s",
1351 err, xrefJavaSourceFileMaxDefault)
1352 return xrefJavaSourceFileMaxDefault
1353 }
1354 return v
1355
1356}
1357
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001358func (c *config) EmitXrefRules() bool {
1359 return c.XrefCorpusName() != ""
1360}
1361
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001362func (c *config) ClangTidy() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001363 return Bool(c.productVariables.ClangTidy)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001364}
1365
1366func (c *config) TidyChecks() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001367 if c.productVariables.TidyChecks == nil {
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001368 return ""
1369 }
Dan Willemsen45133ac2018-03-09 21:22:06 -08001370 return *c.productVariables.TidyChecks
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001371}
1372
Colin Cross0f4e0d62016-07-27 10:56:55 -07001373func (c *config) LibartImgHostBaseAddress() string {
David Srbeckya4f336b2024-09-04 16:06:56 +01001374 return "0x70000000"
Colin Cross0f4e0d62016-07-27 10:56:55 -07001375}
1376
1377func (c *config) LibartImgDeviceBaseAddress() string {
Elliott Hughesda3a0712020-03-06 16:55:28 -08001378 return "0x70000000"
Colin Cross0f4e0d62016-07-27 10:56:55 -07001379}
1380
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001381func (c *config) ArtUseReadBarrier() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001382 return Bool(c.productVariables.ArtUseReadBarrier)
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001383}
1384
Jingwen Chenc711fec2020-11-22 23:52:50 -05001385// Enforce Runtime Resource Overlays for a module. RROs supersede static RROs,
1386// but some modules still depend on it.
1387//
1388// More info: https://source.android.com/devices/architecture/rros
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001389func (c *config) EnforceRROForModule(name string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001390 enforceList := c.productVariables.EnforceRROTargets
Jeongik Chacee5ba92021-02-19 12:11:51 +09001391
Roland Levillainf6cc2612020-07-09 16:58:14 +01001392 if len(enforceList) > 0 {
Yo Chiang4ebd06a2019-10-01 13:13:41 +08001393 if InList("*", enforceList) {
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001394 return true
1395 }
Colin Crossa74ca042019-01-31 14:31:51 -08001396 return InList(name, enforceList)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001397 }
1398 return false
1399}
Colin Crossc4441622024-09-18 14:55:49 -07001400
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001401func (c *config) EnforceRROExcludedOverlay(path string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001402 excluded := c.productVariables.EnforceRROExcludedOverlays
Roland Levillainf6cc2612020-07-09 16:58:14 +01001403 if len(excluded) > 0 {
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001404 return HasAnyPrefix(path, excluded)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001405 }
1406 return false
1407}
1408
Colin Crossc4441622024-09-18 14:55:49 -07001409func (c *config) EnforceRROGlobally() bool {
1410 enforceList := c.productVariables.EnforceRROTargets
1411 return InList("*", enforceList)
1412}
1413
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001414func (c *config) ExportedNamespaces() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001415 return append([]string(nil), c.productVariables.NamespacesToExport...)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001416}
1417
Sam Delmerico98a73292023-02-21 11:50:29 -05001418func (c *config) SourceRootDirs() []string {
1419 return c.productVariables.SourceRootDirs
1420}
1421
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001422func (c *config) HostStaticBinaries() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001423 return Bool(c.productVariables.HostStaticBinaries)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001424}
1425
Colin Cross5a0dcd52018-10-05 14:20:06 -07001426func (c *config) UncompressPrivAppDex() bool {
1427 return Bool(c.productVariables.UncompressPrivAppDex)
1428}
1429
1430func (c *config) ModulesLoadedByPrivilegedModules() []string {
1431 return c.productVariables.ModulesLoadedByPrivilegedModules
1432}
1433
Jingwen Chenc711fec2020-11-22 23:52:50 -05001434// DexpreoptGlobalConfigPath returns the path to the dexpreopt.config file in
1435// the output directory, if it was created during the product configuration
1436// phase by Kati.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001437func (c *config) DexpreoptGlobalConfigPath(ctx PathContext) OptionalPath {
Colin Cross988414c2020-01-11 01:11:46 +00001438 if c.productVariables.DexpreoptGlobalConfig == nil {
Jingwen Chenebb0b572020-11-02 00:24:57 -05001439 return OptionalPathForPath(nil)
1440 }
1441 return OptionalPathForPath(
1442 pathForBuildToolDep(ctx, *c.productVariables.DexpreoptGlobalConfig))
1443}
1444
Jingwen Chenc711fec2020-11-22 23:52:50 -05001445// DexpreoptGlobalConfig returns the raw byte contents of the dexpreopt global
1446// configuration. Since the configuration file was created by Kati during
1447// product configuration (externally of soong_build), it's not tracked, so we
1448// also manually add a Ninja file dependency on the configuration file to the
1449// rule that creates the main build.ninja file. This ensures that build.ninja is
1450// regenerated correctly if dexpreopt.config changes.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001451func (c *config) DexpreoptGlobalConfig(ctx PathContext) ([]byte, error) {
1452 path := c.DexpreoptGlobalConfigPath(ctx)
1453 if !path.Valid() {
Colin Cross988414c2020-01-11 01:11:46 +00001454 return nil, nil
1455 }
Jingwen Chenebb0b572020-11-02 00:24:57 -05001456 ctx.AddNinjaFileDeps(path.String())
Sasha Smundakaf5ca922022-12-12 21:23:34 -08001457 return os.ReadFile(absolutePath(path.String()))
Colin Cross43f08db2018-11-12 10:13:39 -08001458}
1459
Inseob Kim7b85eeb2021-03-23 20:52:24 +09001460func (c *deviceConfig) WithDexpreopt() bool {
1461 return c.config.productVariables.WithDexpreopt
1462}
1463
Colin Cross662d6142022-11-03 20:38:01 -07001464func (c *config) FrameworksBaseDirExists(ctx PathGlobContext) bool {
Colin Cross5a756a62021-03-16 16:34:46 -07001465 return ExistentPathForSource(ctx, "frameworks", "base", "Android.bp").Valid()
David Brazdil91b4e3e2019-01-23 21:04:05 +00001466}
1467
Colin Cross3b19f5d2019-09-17 14:45:31 -07001468func (c *config) HasMultilibConflict(arch ArchType) bool {
1469 return c.multilibConflicts[arch]
1470}
1471
Sasha Smundakaf5ca922022-12-12 21:23:34 -08001472func (c *config) PrebuiltHiddenApiDir(_ PathContext) string {
Bill Peckhambae47492021-01-08 09:34:44 -08001473 return String(c.productVariables.PrebuiltHiddenApiDir)
1474}
1475
Justin Yun41cbb5e2023-11-29 17:58:16 +09001476func (c *config) VendorApiLevel() string {
1477 return String(c.productVariables.VendorApiLevel)
1478}
1479
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001480func (c *config) PrevVendorApiLevel() string {
1481 vendorApiLevel, err := strconv.Atoi(c.VendorApiLevel())
1482 if err != nil {
1483 panic(fmt.Errorf("Cannot parse vendor API level %s to an integer: %s",
1484 c.VendorApiLevel(), err))
1485 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001486 // The version before trunk stable is 34.
1487 if vendorApiLevel == 202404 {
1488 return "34"
1489 }
Hsin-Yi Chen890e7722024-03-05 15:56:44 +08001490 if vendorApiLevel >= 1 && vendorApiLevel <= 34 {
1491 return strconv.Itoa(vendorApiLevel - 1)
1492 }
1493 if vendorApiLevel < 202404 || vendorApiLevel%100 != 4 {
1494 panic("Unknown vendor API level " + c.VendorApiLevel())
1495 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001496 return strconv.Itoa(vendorApiLevel - 100)
1497}
1498
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001499func IsTrunkStableVendorApiLevel(level string) bool {
1500 levelInt, err := strconv.Atoi(level)
1501 return err == nil && levelInt >= 202404
1502}
1503
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001504func (c *config) VendorApiLevelFrozen() bool {
1505 return c.productVariables.GetBuildFlagBool("RELEASE_BOARD_API_LEVEL_FROZEN")
1506}
1507
Colin Cross9272ade2016-08-17 15:24:12 -07001508func (c *deviceConfig) Arches() []Arch {
1509 var arches []Arch
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001510 for _, target := range c.config.Targets[Android] {
Colin Cross9272ade2016-08-17 15:24:12 -07001511 arches = append(arches, target.Arch)
1512 }
1513 return arches
1514}
Dan Willemsend2ede872016-11-18 14:54:24 -08001515
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001516func (c *deviceConfig) BinderBitness() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001517 is32BitBinder := c.config.productVariables.Binder32bit
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001518 if is32BitBinder != nil && *is32BitBinder {
1519 return "32"
1520 }
1521 return "64"
1522}
1523
Dan Willemsen4353bc42016-12-05 17:16:02 -08001524func (c *deviceConfig) VendorPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001525 if c.config.productVariables.VendorPath != nil {
1526 return *c.config.productVariables.VendorPath
Dan Willemsen4353bc42016-12-05 17:16:02 -08001527 }
1528 return "vendor"
1529}
1530
Spandan Dase3b65312024-10-22 00:27:27 +00001531func (c *deviceConfig) BuildingVendorImage() bool {
1532 return proptools.Bool(c.config.productVariables.BuildingVendorImage)
1533}
1534
Jeongik Cha219141c2020-08-06 23:00:37 +09001535func (c *deviceConfig) CurrentApiLevelForVendorModules() string {
1536 return StringDefault(c.config.productVariables.DeviceCurrentApiLevelForVendorModules, "current")
1537}
1538
Justin Yun71549282017-11-17 12:10:28 +09001539func (c *deviceConfig) ExtraVndkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001540 return c.config.productVariables.ExtraVndkVersions
Dan Willemsend2ede872016-11-18 14:54:24 -08001541}
Jack He8cc71432016-12-08 15:45:07 -08001542
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001543func (c *deviceConfig) SystemSdkVersions() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001544 return c.config.productVariables.DeviceSystemSdkVersions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001545}
1546
1547func (c *deviceConfig) PlatformSystemSdkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001548 return c.config.productVariables.Platform_systemsdk_versions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001549}
1550
Jiyong Park2db76922017-11-08 16:03:48 +09001551func (c *deviceConfig) OdmPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001552 if c.config.productVariables.OdmPath != nil {
1553 return *c.config.productVariables.OdmPath
Jiyong Park2db76922017-11-08 16:03:48 +09001554 }
1555 return "odm"
1556}
1557
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001558func (c *deviceConfig) ProductPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001559 if c.config.productVariables.ProductPath != nil {
1560 return *c.config.productVariables.ProductPath
Jiyong Park2db76922017-11-08 16:03:48 +09001561 }
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001562 return "product"
Jiyong Park2db76922017-11-08 16:03:48 +09001563}
1564
Jihoon Kang6dd13b62024-10-22 23:21:02 +00001565func (c *deviceConfig) BuildingProductImage() bool {
1566 return proptools.Bool(c.config.productVariables.BuildingProductImage)
1567}
1568
Justin Yund5f6c822019-06-25 16:47:17 +09001569func (c *deviceConfig) SystemExtPath() string {
1570 if c.config.productVariables.SystemExtPath != nil {
1571 return *c.config.productVariables.SystemExtPath
Dario Frenifd05a742018-05-29 13:28:54 +01001572 }
Justin Yund5f6c822019-06-25 16:47:17 +09001573 return "system_ext"
Dario Frenifd05a742018-05-29 13:28:54 +01001574}
1575
Jack He8cc71432016-12-08 15:45:07 -08001576func (c *deviceConfig) BtConfigIncludeDir() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001577 return String(c.config.productVariables.BtConfigIncludeDir)
Jack He8cc71432016-12-08 15:45:07 -08001578}
Dan Willemsen581341d2017-02-09 16:16:31 -08001579
Jiyong Parkd773eb32017-07-03 13:18:12 +09001580func (c *deviceConfig) DeviceKernelHeaderDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001581 return c.config.productVariables.DeviceKernelHeaders
Jiyong Parkd773eb32017-07-03 13:18:12 +09001582}
1583
Roland Levillainada12702020-06-09 13:07:36 +01001584// JavaCoverageEnabledForPath returns whether Java code coverage is enabled for
1585// path. Coverage is enabled by default when the product variable
1586// JavaCoveragePaths is empty. If JavaCoveragePaths is not empty, coverage is
1587// enabled for any path which is part of this variable (and not part of the
1588// JavaCoverageExcludePaths product variable). Value "*" in JavaCoveragePaths
1589// represents any path.
1590func (c *deviceConfig) JavaCoverageEnabledForPath(path string) bool {
1591 coverage := false
Chris Gross2f748692020-06-24 20:36:59 +00001592 if len(c.config.productVariables.JavaCoveragePaths) == 0 ||
Roland Levillainada12702020-06-09 13:07:36 +01001593 InList("*", c.config.productVariables.JavaCoveragePaths) ||
1594 HasAnyPrefix(path, c.config.productVariables.JavaCoveragePaths) {
1595 coverage = true
1596 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001597 if coverage && len(c.config.productVariables.JavaCoverageExcludePaths) > 0 {
Roland Levillainada12702020-06-09 13:07:36 +01001598 if HasAnyPrefix(path, c.config.productVariables.JavaCoverageExcludePaths) {
1599 coverage = false
1600 }
1601 }
1602 return coverage
1603}
1604
Colin Cross1a6acd42020-06-16 17:51:46 -07001605// Returns true if gcov or clang coverage is enabled.
Dan Willemsen581341d2017-02-09 16:16:31 -08001606func (c *deviceConfig) NativeCoverageEnabled() bool {
Colin Cross1a6acd42020-06-16 17:51:46 -07001607 return Bool(c.config.productVariables.GcovCoverage) ||
1608 Bool(c.config.productVariables.ClangCoverage)
Dan Willemsen581341d2017-02-09 16:16:31 -08001609}
1610
Oliver Nguyen1382ab62019-12-06 15:22:41 -08001611func (c *deviceConfig) ClangCoverageEnabled() bool {
1612 return Bool(c.config.productVariables.ClangCoverage)
1613}
1614
Pirama Arumuga Nainarb37ae582022-01-26 22:14:32 -08001615func (c *deviceConfig) ClangCoverageContinuousMode() bool {
1616 return Bool(c.config.productVariables.ClangCoverageContinuousMode)
1617}
1618
Colin Cross1a6acd42020-06-16 17:51:46 -07001619func (c *deviceConfig) GcovCoverageEnabled() bool {
1620 return Bool(c.config.productVariables.GcovCoverage)
1621}
1622
Roland Levillain4f5297b2020-06-09 12:44:06 +01001623// NativeCoverageEnabledForPath returns whether (GCOV- or Clang-based) native
1624// code coverage is enabled for path. By default, coverage is not enabled for a
1625// given path unless it is part of the NativeCoveragePaths product variable (and
1626// not part of the NativeCoverageExcludePaths product variable). Value "*" in
1627// NativeCoveragePaths represents any path.
1628func (c *deviceConfig) NativeCoverageEnabledForPath(path string) bool {
Ryan Campbell469a18a2017-02-27 09:01:54 -08001629 coverage := false
Roland Levillainf6cc2612020-07-09 16:58:14 +01001630 if len(c.config.productVariables.NativeCoveragePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001631 if InList("*", c.config.productVariables.NativeCoveragePaths) || HasAnyPrefix(path, c.config.productVariables.NativeCoveragePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001632 coverage = true
Dan Willemsen581341d2017-02-09 16:16:31 -08001633 }
1634 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001635 if coverage && len(c.config.productVariables.NativeCoverageExcludePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001636 if HasAnyPrefix(path, c.config.productVariables.NativeCoverageExcludePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001637 coverage = false
Ryan Campbell469a18a2017-02-27 09:01:54 -08001638 }
1639 }
1640 return coverage
Dan Willemsen581341d2017-02-09 16:16:31 -08001641}
Ivan Lozano5f595532017-07-13 14:46:05 -07001642
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001643func (c *deviceConfig) PgoAdditionalProfileDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001644 return c.config.productVariables.PgoAdditionalProfileDirs
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001645}
1646
Vinh Tran44cb78c2023-03-09 22:07:19 -05001647// AfdoProfile returns fully qualified path associated to the given module name
Colin Crossd38feb02024-01-23 16:38:06 -08001648func (c *deviceConfig) AfdoProfile(name string) (string, error) {
Vinh Tran44cb78c2023-03-09 22:07:19 -05001649 for _, afdoProfile := range c.config.productVariables.AfdoProfiles {
1650 split := strings.Split(afdoProfile, ":")
1651 if len(split) != 3 {
Colin Crossd38feb02024-01-23 16:38:06 -08001652 return "", fmt.Errorf("AFDO_PROFILES has invalid value: %s. "+
Vinh Tran44cb78c2023-03-09 22:07:19 -05001653 "The expected format is <module>:<fully-qualified-path-to-fdo_profile>", afdoProfile)
1654 }
1655 if split[0] == name {
Colin Crossd38feb02024-01-23 16:38:06 -08001656 return strings.Join([]string{split[1], split[2]}, ":"), nil
Vinh Tran44cb78c2023-03-09 22:07:19 -05001657 }
1658 }
Colin Crossd38feb02024-01-23 16:38:06 -08001659 return "", nil
Vinh Tran44cb78c2023-03-09 22:07:19 -05001660}
1661
Tri Vo35a51432018-03-25 20:00:00 -07001662func (c *deviceConfig) VendorSepolicyDirs() []string {
1663 return c.config.productVariables.BoardVendorSepolicyDirs
1664}
1665
1666func (c *deviceConfig) OdmSepolicyDirs() []string {
1667 return c.config.productVariables.BoardOdmSepolicyDirs
1668}
1669
Felixa20a8752020-05-17 18:28:35 +02001670func (c *deviceConfig) SystemExtPublicSepolicyDirs() []string {
1671 return c.config.productVariables.SystemExtPublicSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001672}
1673
Felixa20a8752020-05-17 18:28:35 +02001674func (c *deviceConfig) SystemExtPrivateSepolicyDirs() []string {
1675 return c.config.productVariables.SystemExtPrivateSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001676}
1677
Inseob Kim0866b002019-04-15 20:21:29 +09001678func (c *deviceConfig) SepolicyM4Defs() []string {
1679 return c.config.productVariables.BoardSepolicyM4Defs
1680}
1681
Jiyong Park7f67f482019-01-05 12:57:48 +09001682func (c *deviceConfig) OverrideManifestPackageNameFor(name string) (manifestName string, overridden bool) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001683 return findOverrideValue(c.config.productVariables.ManifestPackageNameOverrides, name,
1684 "invalid override rule %q in PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES should be <module_name>:<manifest_name>")
1685}
1686
1687func (c *deviceConfig) OverrideCertificateFor(name string) (certificatePath string, overridden bool) {
Jaewoong Jungacb6db32019-02-28 16:22:30 +00001688 return findOverrideValue(c.config.productVariables.CertificateOverrides, name,
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001689 "invalid override rule %q in PRODUCT_CERTIFICATE_OVERRIDES should be <module_name>:<certificate_module_name>")
1690}
1691
Jaewoong Jung9d22a912019-01-23 16:27:47 -08001692func (c *deviceConfig) OverridePackageNameFor(name string) string {
1693 newName, overridden := findOverrideValue(
1694 c.config.productVariables.PackageNameOverrides,
1695 name,
1696 "invalid override rule %q in PRODUCT_PACKAGE_NAME_OVERRIDES should be <module_name>:<package_name>")
1697 if overridden {
1698 return newName
1699 }
1700 return name
1701}
1702
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001703func findOverrideValue(overrides []string, name string, errorMsg string) (newValue string, overridden bool) {
Jiyong Park7f67f482019-01-05 12:57:48 +09001704 if overrides == nil || len(overrides) == 0 {
1705 return "", false
1706 }
1707 for _, o := range overrides {
1708 split := strings.Split(o, ":")
1709 if len(split) != 2 {
1710 // This shouldn't happen as this is first checked in make, but just in case.
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001711 panic(fmt.Errorf(errorMsg, o))
Jiyong Park7f67f482019-01-05 12:57:48 +09001712 }
1713 if matchPattern(split[0], name) {
1714 return substPattern(split[0], split[1], name), true
1715 }
1716 }
1717 return "", false
1718}
1719
Albert Martineefabcf2022-03-21 20:11:16 +00001720func (c *deviceConfig) ApexGlobalMinSdkVersionOverride() string {
1721 return String(c.config.productVariables.ApexGlobalMinSdkVersionOverride)
1722}
1723
Ivan Lozano5f595532017-07-13 14:46:05 -07001724func (c *config) IntegerOverflowDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001725 if len(c.productVariables.IntegerOverflowExcludePaths) == 0 {
Ivan Lozano5f595532017-07-13 14:46:05 -07001726 return false
1727 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001728 return HasAnyPrefix(path, c.productVariables.IntegerOverflowExcludePaths)
Ivan Lozano5f595532017-07-13 14:46:05 -07001729}
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001730
1731func (c *config) CFIDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001732 if len(c.productVariables.CFIExcludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001733 return false
1734 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001735 return HasAnyPrefix(path, c.productVariables.CFIExcludePaths)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001736}
1737
1738func (c *config) CFIEnabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001739 if len(c.productVariables.CFIIncludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001740 return false
1741 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001742 return HasAnyPrefix(path, c.productVariables.CFIIncludePaths) && !c.CFIDisabledForPath(path)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001743}
Colin Crosse15ddaf2017-12-04 11:24:31 -08001744
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001745func (c *config) MemtagHeapDisabledForPath(path string) bool {
1746 if len(c.productVariables.MemtagHeapExcludePaths) == 0 {
1747 return false
1748 }
1749 return HasAnyPrefix(path, c.productVariables.MemtagHeapExcludePaths)
1750}
1751
1752func (c *config) MemtagHeapAsyncEnabledForPath(path string) bool {
1753 if len(c.productVariables.MemtagHeapAsyncIncludePaths) == 0 {
1754 return false
1755 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001756 return HasAnyPrefix(path, c.productVariables.MemtagHeapAsyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001757}
1758
1759func (c *config) MemtagHeapSyncEnabledForPath(path string) bool {
1760 if len(c.productVariables.MemtagHeapSyncIncludePaths) == 0 {
1761 return false
1762 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001763 return HasAnyPrefix(path, c.productVariables.MemtagHeapSyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001764}
1765
Tomislav Novakf734f002023-08-22 10:51:44 -07001766func (c *config) HWASanDisabledForPath(path string) bool {
1767 if len(c.productVariables.HWASanExcludePaths) == 0 {
1768 return false
1769 }
1770 return HasAnyPrefix(path, c.productVariables.HWASanExcludePaths)
1771}
1772
Hang Lua98aab92023-03-17 13:17:22 +08001773func (c *config) HWASanEnabledForPath(path string) bool {
1774 if len(c.productVariables.HWASanIncludePaths) == 0 {
1775 return false
1776 }
Tomislav Novakf734f002023-08-22 10:51:44 -07001777 return HasAnyPrefix(path, c.productVariables.HWASanIncludePaths) && !c.HWASanDisabledForPath(path)
Hang Lua98aab92023-03-17 13:17:22 +08001778}
1779
Dan Willemsen0fe78662018-03-26 12:41:18 -07001780func (c *config) VendorConfig(name string) VendorConfig {
Colin Cross9d34f352019-11-22 16:03:51 -08001781 return soongconfig.Config(c.productVariables.VendorVars[name])
Dan Willemsen0fe78662018-03-26 12:41:18 -07001782}
1783
Colin Cross395f2cf2018-10-24 16:10:32 -07001784func (c *config) NdkAbis() bool {
1785 return Bool(c.productVariables.Ndk_abis)
1786}
1787
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001788func (c *config) AmlAbis() bool {
1789 return Bool(c.productVariables.Aml_abis)
1790}
1791
Jiyong Park4da07972021-01-05 21:01:11 +09001792func (c *config) ForceApexSymlinkOptimization() bool {
1793 return Bool(c.productVariables.ForceApexSymlinkOptimization)
1794}
1795
Sasha Smundakfe9a5b82022-07-27 14:51:45 -07001796func (c *config) ApexCompressionEnabled() bool {
1797 return Bool(c.productVariables.CompressedApex) && !c.UnbundledBuildApps()
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +00001798}
1799
Dennis Shene2ed70c2023-01-11 14:15:43 +00001800func (c *config) ApexTrimEnabled() bool {
1801 return Bool(c.productVariables.TrimmedApex)
1802}
1803
Justin Yun2cc42502024-09-11 14:10:20 +09001804func (c *config) UseSoongSystemImage() bool {
1805 return Bool(c.productVariables.UseSoongSystemImage)
1806}
1807
1808func (c *config) SoongDefinedSystemImage() string {
1809 if c.UseSoongSystemImage() {
1810 return String(c.productVariables.ProductSoongDefinedSystemImage)
1811 }
1812 return ""
1813}
1814
Jeongik Chac9464142019-01-07 12:07:27 +09001815func (c *config) EnforceSystemCertificate() bool {
1816 return Bool(c.productVariables.EnforceSystemCertificate)
1817}
1818
Colin Cross440e0d02020-06-11 11:32:11 -07001819func (c *config) EnforceSystemCertificateAllowList() []string {
1820 return c.productVariables.EnforceSystemCertificateAllowList
Jeongik Chac9464142019-01-07 12:07:27 +09001821}
1822
Jeongik Cha2cc570d2019-10-29 15:44:45 +09001823func (c *config) EnforceProductPartitionInterface() bool {
1824 return Bool(c.productVariables.EnforceProductPartitionInterface)
1825}
1826
Colin Crossf24a22a2019-01-31 14:12:44 -08001827func (c *config) ProductHiddenAPIStubs() []string {
1828 return c.productVariables.ProductHiddenAPIStubs
Colin Cross8faf8fc2019-01-16 15:15:52 -08001829}
1830
Colin Crossf24a22a2019-01-31 14:12:44 -08001831func (c *config) ProductHiddenAPIStubsSystem() []string {
1832 return c.productVariables.ProductHiddenAPIStubsSystem
Colin Cross8faf8fc2019-01-16 15:15:52 -08001833}
1834
Colin Crossf24a22a2019-01-31 14:12:44 -08001835func (c *config) ProductHiddenAPIStubsTest() []string {
1836 return c.productVariables.ProductHiddenAPIStubsTest
Colin Cross8faf8fc2019-01-16 15:15:52 -08001837}
Dan Willemsen71c74602019-04-10 12:27:35 -07001838
Dan Willemsen54879d12019-04-18 10:08:46 -07001839func (c *deviceConfig) TargetFSConfigGen() []string {
Dan Willemsen71c74602019-04-10 12:27:35 -07001840 return c.config.productVariables.TargetFSConfigGen
1841}
Inseob Kim0866b002019-04-15 20:21:29 +09001842
1843func (c *config) ProductPublicSepolicyDirs() []string {
1844 return c.productVariables.ProductPublicSepolicyDirs
1845}
1846
1847func (c *config) ProductPrivateSepolicyDirs() []string {
1848 return c.productVariables.ProductPrivateSepolicyDirs
1849}
1850
Inseob Kim5eb7ee92022-04-27 10:30:34 +09001851func (c *config) TargetMultitreeUpdateMeta() bool {
1852 return c.productVariables.MultitreeUpdateMeta
1853}
1854
Inseob Kim1f086e22019-05-09 13:29:15 +09001855func (c *deviceConfig) DeviceArch() string {
1856 return String(c.config.productVariables.DeviceArch)
1857}
1858
1859func (c *deviceConfig) DeviceArchVariant() string {
1860 return String(c.config.productVariables.DeviceArchVariant)
1861}
1862
1863func (c *deviceConfig) DeviceSecondaryArch() string {
1864 return String(c.config.productVariables.DeviceSecondaryArch)
1865}
1866
1867func (c *deviceConfig) DeviceSecondaryArchVariant() string {
1868 return String(c.config.productVariables.DeviceSecondaryArchVariant)
1869}
Yifan Hong82db7352020-01-21 16:12:26 -08001870
1871func (c *deviceConfig) BoardUsesRecoveryAsBoot() bool {
1872 return Bool(c.config.productVariables.BoardUsesRecoveryAsBoot)
1873}
Yifan Hong97365ee2020-07-29 09:51:57 -07001874
1875func (c *deviceConfig) BoardKernelBinaries() []string {
1876 return c.config.productVariables.BoardKernelBinaries
1877}
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001878
Yifan Hong42bef8d2020-08-05 14:36:09 -07001879func (c *deviceConfig) BoardKernelModuleInterfaceVersions() []string {
1880 return c.config.productVariables.BoardKernelModuleInterfaceVersions
1881}
1882
Yifan Hongdd8dacc2020-10-21 15:40:17 -07001883func (c *deviceConfig) BoardMoveRecoveryResourcesToVendorBoot() bool {
1884 return Bool(c.config.productVariables.BoardMoveRecoveryResourcesToVendorBoot)
1885}
1886
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001887func (c *deviceConfig) PlatformSepolicyVersion() string {
1888 return String(c.config.productVariables.PlatformSepolicyVersion)
1889}
1890
Inseob Kim843f6642022-01-07 09:11:23 +09001891func (c *deviceConfig) PlatformSepolicyCompatVersions() []string {
1892 return c.config.productVariables.PlatformSepolicyCompatVersions
1893}
1894
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001895func (c *deviceConfig) BoardSepolicyVers() string {
Inseob Kim0c4eec82021-03-22 22:33:40 +09001896 if ver := String(c.config.productVariables.BoardSepolicyVers); ver != "" {
1897 return ver
1898 }
1899 return c.PlatformSepolicyVersion()
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001900}
1901
Inseob Kim1a0afcc2022-02-14 23:10:51 +09001902func (c *deviceConfig) SystemExtSepolicyPrebuiltApiDir() string {
1903 return String(c.config.productVariables.SystemExtSepolicyPrebuiltApiDir)
1904}
1905
1906func (c *deviceConfig) ProductSepolicyPrebuiltApiDir() string {
1907 return String(c.config.productVariables.ProductSepolicyPrebuiltApiDir)
1908}
1909
1910func (c *deviceConfig) IsPartnerTrebleSepolicyTestEnabled() bool {
1911 return c.SystemExtSepolicyPrebuiltApiDir() != "" || c.ProductSepolicyPrebuiltApiDir() != ""
1912}
1913
Justin DeMartino383bfb32021-02-24 10:49:43 -08001914func createDirsMap(previous map[string]bool, dirs []string) (map[string]bool, error) {
1915 var ret = make(map[string]bool)
1916 for _, dir := range dirs {
1917 clean := filepath.Clean(dir)
1918 if previous[clean] || ret[clean] {
1919 return nil, fmt.Errorf("Duplicate entry %s", dir)
1920 }
1921 ret[clean] = true
1922 }
1923 return ret, nil
1924}
1925
1926func (c *deviceConfig) createDirsMapOnce(onceKey OnceKey, previous map[string]bool, dirs []string) map[string]bool {
1927 dirMap := c.Once(onceKey, func() interface{} {
1928 ret, err := createDirsMap(previous, dirs)
1929 if err != nil {
1930 panic(fmt.Errorf("%s: %w", onceKey.key, err))
1931 }
1932 return ret
1933 })
1934 if dirMap == nil {
1935 return nil
1936 }
1937 return dirMap.(map[string]bool)
1938}
1939
Inseob Kim60c32f02020-12-21 22:53:05 +09001940func (c *deviceConfig) ShippingApiLevel() ApiLevel {
Steven Morelanda48df2b2024-06-03 22:29:38 +00001941 if c.config.productVariables.Shipping_api_level == nil {
Inseob Kim60c32f02020-12-21 22:53:05 +09001942 return NoneApiLevel
1943 }
Steven Morelanda48df2b2024-06-03 22:29:38 +00001944 apiLevel, _ := strconv.Atoi(*c.config.productVariables.Shipping_api_level)
Inseob Kim60c32f02020-12-21 22:53:05 +09001945 return uncheckedFinalApiLevel(apiLevel)
1946}
1947
Liz Kammer33cc80e2023-05-18 18:20:28 +00001948func (c *deviceConfig) BuildBrokenPluginValidation() []string {
1949 return c.config.productVariables.BuildBrokenPluginValidation
1950}
1951
Alix Espinoef47e542022-09-14 19:10:51 +00001952func (c *deviceConfig) BuildBrokenClangAsFlags() bool {
1953 return c.config.productVariables.BuildBrokenClangAsFlags
1954}
1955
1956func (c *deviceConfig) BuildBrokenClangCFlags() bool {
1957 return c.config.productVariables.BuildBrokenClangCFlags
1958}
1959
Alixb5f6d9e2022-04-20 23:00:58 +00001960func (c *deviceConfig) BuildBrokenClangProperty() bool {
1961 return c.config.productVariables.BuildBrokenClangProperty
1962}
1963
Inseob Kim67e5add192021-03-17 18:05:33 +09001964func (c *deviceConfig) BuildBrokenEnforceSyspropOwner() bool {
1965 return c.config.productVariables.BuildBrokenEnforceSyspropOwner
1966}
1967
1968func (c *deviceConfig) BuildBrokenTrebleSyspropNeverallow() bool {
1969 return c.config.productVariables.BuildBrokenTrebleSyspropNeverallow
1970}
1971
Hridya Valsaraju5a5c7d52021-04-02 16:45:24 -07001972func (c *deviceConfig) BuildDebugfsRestrictionsEnabled() bool {
1973 return c.config.productVariables.BuildDebugfsRestrictionsEnabled
1974}
1975
Inseob Kim0cac7b42021-02-03 18:16:46 +09001976func (c *deviceConfig) BuildBrokenVendorPropertyNamespace() bool {
1977 return c.config.productVariables.BuildBrokenVendorPropertyNamespace
1978}
1979
Liz Kammer619be462022-01-28 15:13:39 -05001980func (c *deviceConfig) BuildBrokenInputDir(name string) bool {
1981 return InList(name, c.config.productVariables.BuildBrokenInputDirModules)
1982}
1983
Jiyong Park3bb99242024-01-04 23:21:26 +00001984func (c *deviceConfig) BuildBrokenDontCheckSystemSdk() bool {
1985 return c.config.productVariables.BuildBrokenDontCheckSystemSdk
1986}
1987
Inseob Kim2da72af2024-06-18 11:09:12 +09001988func (c *deviceConfig) BuildBrokenDupSysprop() bool {
1989 return c.config.productVariables.BuildBrokenDupSysprop
1990}
1991
Jiakai Zhang48203e32023-06-02 23:42:21 +01001992func (c *config) BuildWarningBadOptionalUsesLibsAllowlist() []string {
1993 return c.productVariables.BuildWarningBadOptionalUsesLibsAllowlist
1994}
1995
Yu Liu6a7940c2023-05-09 17:12:22 -07001996func (c *deviceConfig) GenruleSandboxing() bool {
1997 return Bool(c.config.productVariables.GenruleSandboxing)
Vinh Tran140d5882022-06-10 14:23:27 -04001998}
1999
Inseob Kim67e5add192021-03-17 18:05:33 +09002000func (c *deviceConfig) RequiresInsecureExecmemForSwiftshader() bool {
2001 return c.config.productVariables.RequiresInsecureExecmemForSwiftshader
2002}
2003
Devin Moorec381e102023-07-06 22:03:58 +00002004func (c *deviceConfig) Release_aidl_use_unfrozen() bool {
2005 return Bool(c.config.productVariables.Release_aidl_use_unfrozen)
2006}
2007
Inseob Kim67e5add192021-03-17 18:05:33 +09002008func (c *config) SelinuxIgnoreNeverallows() bool {
2009 return c.productVariables.SelinuxIgnoreNeverallows
2010}
2011
Inseob Kima10ef272021-09-15 03:04:53 +00002012func (c *deviceConfig) SepolicyFreezeTestExtraDirs() []string {
2013 return c.config.productVariables.SepolicyFreezeTestExtraDirs
2014}
2015
2016func (c *deviceConfig) SepolicyFreezeTestExtraPrebuiltDirs() []string {
2017 return c.config.productVariables.SepolicyFreezeTestExtraPrebuiltDirs
2018}
2019
Jiyong Parkd163d4d2021-10-12 16:47:43 +09002020func (c *deviceConfig) GenerateAidlNdkPlatformBackend() bool {
2021 return c.config.productVariables.GenerateAidlNdkPlatformBackend
2022}
2023
Yu Liu67a28422024-03-05 00:36:31 +00002024func (c *deviceConfig) AconfigContainerValidation() string {
2025 return c.config.productVariables.AconfigContainerValidation
2026}
2027
Christopher Ferris98f10222022-07-13 23:16:52 -07002028func (c *config) IgnorePrefer32OnDevice() bool {
2029 return c.productVariables.IgnorePrefer32OnDevice
2030}
2031
Ulya Trafimovich249386a2020-07-01 14:31:13 +01002032func (c *config) BootJars() []string {
2033 return c.Once(earlyBootJarsKey, func() interface{} {
Paul Duffin69d1fb12020-10-23 21:14:20 +01002034 list := c.productVariables.BootJars.CopyOfJars()
satayevd604b212021-07-21 14:23:52 +01002035 return append(list, c.productVariables.ApexBootJars.CopyOfJars()...)
Ulya Trafimovich249386a2020-07-01 14:31:13 +01002036 }).([]string)
2037}
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002038
satayevd604b212021-07-21 14:23:52 +01002039func (c *config) NonApexBootJars() ConfiguredJarList {
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002040 return c.productVariables.BootJars
2041}
2042
satayevd604b212021-07-21 14:23:52 +01002043func (c *config) ApexBootJars() ConfiguredJarList {
2044 return c.productVariables.ApexBootJars
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002045}
Colin Cross77cdcfd2021-03-12 11:28:25 -08002046
2047func (c *config) RBEWrapper() string {
2048 return c.GetenvWithDefault("RBE_WRAPPER", remoteexec.DefaultWrapperPath)
2049}
Colin Cross9b698b62021-12-22 09:55:32 -08002050
2051// UseHostMusl returns true if the host target has been configured to build against musl libc.
2052func (c *config) UseHostMusl() bool {
2053 return Bool(c.productVariables.HostMusl)
2054}
MarkDacekff851b82022-04-21 18:33:17 +00002055
Spandan Das9e93d3d2023-03-08 05:47:29 +00002056// ApiSurfaces directory returns the source path inside the api_surfaces repo
2057// (relative to workspace root).
2058func (c *config) ApiSurfacesDir(s ApiSurface, version string) string {
2059 return filepath.Join(
2060 "build",
2061 "bazel",
2062 "api_surfaces",
2063 s.String(),
2064 version)
2065}
Jihoon Kang1bff0342023-01-17 20:40:22 +00002066
Jihoon Kang1975d3e2023-10-16 23:24:11 +00002067func (c *config) JavaCoverageEnabled() bool {
2068 return c.IsEnvTrue("EMMA_INSTRUMENT") || c.IsEnvTrue("EMMA_INSTRUMENT_STATIC") || c.IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK")
2069}
2070
Jihoon Kangc1b04d62023-11-16 19:07:04 +00002071func (c *deviceConfig) BuildFromSourceStub() bool {
2072 return Bool(c.config.productVariables.BuildFromSourceStub)
2073}
2074
Jihoon Kang1bff0342023-01-17 20:40:22 +00002075func (c *config) BuildFromTextStub() bool {
Jihoon Kang1975d3e2023-10-16 23:24:11 +00002076 // TODO: b/302320354 - Remove the coverage build specific logic once the
2077 // robust solution for handling native properties in from-text stub build
2078 // is implemented.
Jihoon Kangc1b04d62023-11-16 19:07:04 +00002079 return !c.buildFromSourceStub &&
2080 !c.JavaCoverageEnabled() &&
2081 !c.deviceConfig.BuildFromSourceStub()
Jihoon Kang1bff0342023-01-17 20:40:22 +00002082}
Spandan Das4deab282023-03-30 17:06:32 +00002083
2084func (c *config) SetBuildFromTextStub(b bool) {
Jihoon Kang2a929ad2023-06-08 19:02:07 +00002085 c.buildFromSourceStub = !b
Jihoon Kangcbcad7c2023-06-01 22:31:52 +00002086 c.productVariables.Build_from_text_stub = boolPtr(b)
Spandan Das4deab282023-03-30 17:06:32 +00002087}
Jihoon Kang1c92c3e2023-03-23 17:44:51 +00002088
Inseob Kim5bac3b62023-08-25 21:29:46 +09002089func (c *deviceConfig) CheckVendorSeappViolations() bool {
2090 return Bool(c.config.productVariables.CheckVendorSeappViolations)
2091}
Jihoon Kangcfbc4072023-09-20 01:02:18 +00002092
Inseob Kime4e85d52023-10-25 23:53:58 +09002093func (c *config) GetBuildFlag(name string) (string, bool) {
2094 val, ok := c.productVariables.BuildFlags[name]
2095 return val, ok
2096}
Spandan Dase3fcb412023-10-26 20:48:02 +00002097
Rico Winda7b38592024-08-26 12:10:44 +02002098func (c *config) UseOptimizedResourceShrinkingByDefault() bool {
2099 return c.productVariables.GetBuildFlagBool("RELEASE_USE_OPTIMIZED_RESOURCE_SHRINKING_BY_DEFAULT")
2100}
2101
Colin Cross8f1b0332024-01-25 13:39:06 -08002102func (c *config) UseResourceProcessorByDefault() bool {
2103 return c.productVariables.GetBuildFlagBool("RELEASE_USE_RESOURCE_PROCESSOR_BY_DEFAULT")
2104}
2105
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002106func (c *config) UseTransitiveJarsInClasspath() bool {
2107 return c.productVariables.GetBuildFlagBool("RELEASE_USE_TRANSITIVE_JARS_IN_CLASSPATH")
2108}
2109
Spandan Dase3fcb412023-10-26 20:48:02 +00002110var (
Spandan Das85bd4622024-08-01 00:51:20 +00002111 mainlineApexContributionBuildFlagsToApexNames = map[string]string{
2112 "RELEASE_APEX_CONTRIBUTIONS_ADBD": "com.android.adbd",
2113 "RELEASE_APEX_CONTRIBUTIONS_ADSERVICES": "com.android.adservices",
2114 "RELEASE_APEX_CONTRIBUTIONS_APPSEARCH": "com.android.appsearch",
2115 "RELEASE_APEX_CONTRIBUTIONS_ART": "com.android.art",
2116 "RELEASE_APEX_CONTRIBUTIONS_BLUETOOTH": "com.android.btservices",
2117 "RELEASE_APEX_CONTRIBUTIONS_CAPTIVEPORTALLOGIN": "",
2118 "RELEASE_APEX_CONTRIBUTIONS_CELLBROADCAST": "com.android.cellbroadcast",
2119 "RELEASE_APEX_CONTRIBUTIONS_CONFIGINFRASTRUCTURE": "com.android.configinfrastructure",
2120 "RELEASE_APEX_CONTRIBUTIONS_CONNECTIVITY": "com.android.tethering",
2121 "RELEASE_APEX_CONTRIBUTIONS_CONSCRYPT": "com.android.conscrypt",
2122 "RELEASE_APEX_CONTRIBUTIONS_CRASHRECOVERY": "",
2123 "RELEASE_APEX_CONTRIBUTIONS_DEVICELOCK": "com.android.devicelock",
2124 "RELEASE_APEX_CONTRIBUTIONS_DOCUMENTSUIGOOGLE": "",
2125 "RELEASE_APEX_CONTRIBUTIONS_EXTSERVICES": "com.android.extservices",
2126 "RELEASE_APEX_CONTRIBUTIONS_HEALTHFITNESS": "com.android.healthfitness",
2127 "RELEASE_APEX_CONTRIBUTIONS_IPSEC": "com.android.ipsec",
2128 "RELEASE_APEX_CONTRIBUTIONS_MEDIA": "com.android.media",
2129 "RELEASE_APEX_CONTRIBUTIONS_MEDIAPROVIDER": "com.android.mediaprovider",
2130 "RELEASE_APEX_CONTRIBUTIONS_MODULE_METADATA": "",
2131 "RELEASE_APEX_CONTRIBUTIONS_NETWORKSTACKGOOGLE": "",
2132 "RELEASE_APEX_CONTRIBUTIONS_NEURALNETWORKS": "com.android.neuralnetworks",
2133 "RELEASE_APEX_CONTRIBUTIONS_ONDEVICEPERSONALIZATION": "com.android.ondevicepersonalization",
2134 "RELEASE_APEX_CONTRIBUTIONS_PERMISSION": "com.android.permission",
2135 "RELEASE_APEX_CONTRIBUTIONS_PRIMARY_LIBS": "",
2136 "RELEASE_APEX_CONTRIBUTIONS_REMOTEKEYPROVISIONING": "com.android.rkpd",
2137 "RELEASE_APEX_CONTRIBUTIONS_RESOLV": "com.android.resolv",
2138 "RELEASE_APEX_CONTRIBUTIONS_SCHEDULING": "com.android.scheduling",
2139 "RELEASE_APEX_CONTRIBUTIONS_SDKEXTENSIONS": "com.android.sdkext",
2140 "RELEASE_APEX_CONTRIBUTIONS_SWCODEC": "com.android.media.swcodec",
2141 "RELEASE_APEX_CONTRIBUTIONS_STATSD": "com.android.os.statsd",
2142 "RELEASE_APEX_CONTRIBUTIONS_TELEMETRY_TVP": "",
2143 "RELEASE_APEX_CONTRIBUTIONS_TZDATA": "com.android.tzdata",
2144 "RELEASE_APEX_CONTRIBUTIONS_UWB": "com.android.uwb",
2145 "RELEASE_APEX_CONTRIBUTIONS_WIFI": "com.android.wifi",
Spandan Dase3fcb412023-10-26 20:48:02 +00002146 }
2147)
2148
2149// Returns the list of _selected_ apex_contributions
2150// Each mainline module will have one entry in the list
2151func (c *config) AllApexContributions() []string {
2152 ret := []string{}
Spandan Das85bd4622024-08-01 00:51:20 +00002153 for _, f := range SortedKeys(mainlineApexContributionBuildFlagsToApexNames) {
Spandan Dase3fcb412023-10-26 20:48:02 +00002154 if val, exists := c.GetBuildFlag(f); exists && val != "" {
2155 ret = append(ret, val)
2156 }
2157 }
2158 return ret
2159}
Spandan Das8ab28dd2024-02-17 03:31:45 +00002160
Spandan Das85bd4622024-08-01 00:51:20 +00002161func (c *config) AllMainlineApexNames() []string {
2162 return SortedStringValues(mainlineApexContributionBuildFlagsToApexNames)
2163}
2164
Spandan Das0d24ade2024-03-08 04:20:15 +00002165func (c *config) BuildIgnoreApexContributionContents() *bool {
Spandan Das8ab28dd2024-02-17 03:31:45 +00002166 return c.productVariables.BuildIgnoreApexContributionContents
2167}
Inseob Kim8fa54da2024-03-19 16:48:59 +09002168
2169func (c *config) ProductLocales() []string {
2170 return c.productVariables.ProductLocales
2171}
2172
2173func (c *config) ProductDefaultWifiChannels() []string {
2174 return c.productVariables.ProductDefaultWifiChannels
2175}
2176
2177func (c *config) BoardUseVbmetaDigestInFingerprint() bool {
2178 return Bool(c.productVariables.BoardUseVbmetaDigestInFingerprint)
2179}
2180
2181func (c *config) OemProperties() []string {
2182 return c.productVariables.OemProperties
2183}
Kiyoung Kim881e4652024-07-08 11:02:23 +09002184
2185func (c *config) UseDebugArt() bool {
2186 if c.productVariables.ArtTargetIncludeDebugBuild != nil {
2187 return Bool(c.productVariables.ArtTargetIncludeDebugBuild)
2188 }
2189
2190 return Bool(c.productVariables.Eng)
2191}
Inseob Kimd8538e52024-07-31 02:00:41 +00002192
2193func (c *config) SystemPropFiles(ctx PathContext) Paths {
2194 return PathsForSource(ctx, c.productVariables.SystemPropFiles)
2195}
Inseob Kim6bd92d52024-07-31 02:01:03 +00002196
Inseob Kimacf91742024-08-05 12:51:05 +09002197func (c *config) SystemExtPropFiles(ctx PathContext) Paths {
2198 return PathsForSource(ctx, c.productVariables.SystemExtPropFiles)
2199}
2200
Inseob Kim01d4f8b2024-08-08 17:47:14 +09002201func (c *config) ProductPropFiles(ctx PathContext) Paths {
2202 return PathsForSource(ctx, c.productVariables.ProductPropFiles)
2203}
2204
Inseob Kim9a22c7e2024-08-26 15:58:09 +09002205func (c *config) OdmPropFiles(ctx PathContext) Paths {
2206 return PathsForSource(ctx, c.productVariables.OdmPropFiles)
2207}
2208
Spandan Das859cdef2024-10-25 21:06:18 +00002209func (c *config) VendorPropFiles(ctx PathContext) Paths {
2210 return PathsForSource(ctx, c.productVariables.VendorPropFiles)
2211}
2212
Nouby Mohamed8609a552024-09-04 22:19:51 +00002213func (c *config) ExtraAllowedDepsTxt() string {
2214 return String(c.productVariables.ExtraAllowedDepsTxt)
2215}
2216
Inseob Kim6bd92d52024-07-31 02:01:03 +00002217func (c *config) EnableUffdGc() string {
2218 return String(c.productVariables.EnableUffdGc)
2219}
Bill Yang3b3aac02024-09-05 09:22:09 +00002220
2221func (c *config) DeviceFrameworkCompatibilityMatrixFile() []string {
2222 return c.productVariables.DeviceFrameworkCompatibilityMatrixFile
2223}
2224
2225func (c *config) DeviceProductCompatibilityMatrixFile() []string {
2226 return c.productVariables.DeviceProductCompatibilityMatrixFile
2227}
2228
2229func (c *config) BoardAvbEnable() bool {
2230 return Bool(c.productVariables.BoardAvbEnable)
2231}
2232
2233func (c *config) BoardAvbSystemAddHashtreeFooterArgs() []string {
2234 return c.productVariables.BoardAvbSystemAddHashtreeFooterArgs
2235}
Spandan Das950deca2024-10-01 18:35:23 +00002236
2237// Returns true if RELEASE_INSTALL_APEX_SYSTEMSERVER_DEXPREOPT_SAME_PARTITION is set to true.
2238// If true, dexpreopt files of apex system server jars will be installed in the same partition as the parent apex.
2239// If false, all these files will be installed in /system partition.
2240func (c Config) InstallApexSystemServerDexpreoptSamePartition() bool {
2241 return c.config.productVariables.GetBuildFlagBool("RELEASE_INSTALL_APEX_SYSTEMSERVER_DEXPREOPT_SAME_PARTITION")
2242}