blob: 1739b01e1f62366f4e742948f0eea254bb028fa1 [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 Jones66e65862024-10-30 10:43:17 -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) {
422 if !isEngBuild {
423 return partialCompileFlags{}, nil
LaMont Jonesbef36af2024-10-30 01:03:28 +0000424 }
LaMont Jones99f18962024-10-17 11:50:44 -0700425 value := c.Getenv("SOONG_PARTIAL_COMPILE")
LaMont Jones99f18962024-10-17 11:50:44 -0700426 if value == "" {
LaMont Jones66e65862024-10-30 10:43:17 -0700427 return defaultPartialCompileFlags, nil
LaMont Jones99f18962024-10-17 11:50:44 -0700428 }
429
LaMont Jones66e65862024-10-30 10:43:17 -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 Jones66e65862024-10-30 10:43:17 -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 Jones66e65862024-10-30 10:43:17 -0700467 ret.enabled = makeVal(state, defaultPartialCompileFlags.enabled)
LaMont Jones99f18962024-10-17 11:50:44 -0700468 case "use_d8":
LaMont Jones66e65862024-10-30 10:43:17 -0700469 ret.use_d8 = makeVal(state, defaultPartialCompileFlags.use_d8)
LaMont Jones99f18962024-10-17 11:50:44 -0700470 default:
LaMont Jones66e65862024-10-30 10:43:17 -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 Jones66e65862024-10-30 10:43:17 -0700622 variant, ok := os.LookupEnv("TARGET_BUILD_VARIANT")
623 isEngBuild := !ok || variant == "eng"
Colin Cross3f40fa42015-01-30 17:27:36 -0800624
Dan Willemsen00269f22017-07-06 16:59:48 -0700625 config.deviceConfig = &deviceConfig{
Colin Cross9272ade2016-08-17 15:24:12 -0700626 config: config,
627 }
628
Liz Kammer7941b302020-07-28 13:27:34 -0700629 // Soundness check of the build and source directories. This won't catch strange
630 // configurations with symlinks, but at least checks the obvious case.
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800631 absBuildDir, err := filepath.Abs(cmdArgs.SoongOutDir)
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700632 if err != nil {
633 return Config{}, err
634 }
635
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200636 absSrcDir, err := filepath.Abs(".")
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700637 if err != nil {
638 return Config{}, err
639 }
640
641 if strings.HasPrefix(absSrcDir, absBuildDir) {
642 return Config{}, fmt.Errorf("Build dir must not contain source directory")
643 }
644
Colin Cross3f40fa42015-01-30 17:27:36 -0800645 // Load any configurable options from the configuration file
Colin Cross9272ade2016-08-17 15:24:12 -0700646 err = loadConfig(config)
Colin Cross3f40fa42015-01-30 17:27:36 -0800647 if err != nil {
Colin Crossc3c0a492015-04-10 15:43:55 -0700648 return Config{}, err
Colin Cross3f40fa42015-01-30 17:27:36 -0800649 }
650
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800651 KatiEnabledMarkerFile := filepath.Join(cmdArgs.SoongOutDir, ".soong.kati_enabled")
Jingwen Chencda22c92020-11-23 00:22:30 -0500652 if _, err := os.Stat(absolutePath(KatiEnabledMarkerFile)); err == nil {
653 config.katiEnabled = true
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800654 }
655
Colin Cross0c66bc62021-07-20 09:47:41 -0700656 determineBuildOS(config)
657
Jingwen Chenc711fec2020-11-22 23:52:50 -0500658 // Sets up the map of target OSes to the finer grained compilation targets
659 // that are configured from the product variables.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700660 targets, err := decodeTargetProductVariables(config)
Dan Willemsen218f6562015-07-08 18:13:11 -0700661 if err != nil {
662 return Config{}, err
663 }
664
LaMont Jones66e65862024-10-30 10:43:17 -0700665 config.partialCompileFlags, err = config.parsePartialCompileFlags(isEngBuild)
LaMont Jones99f18962024-10-17 11:50:44 -0700666 if err != nil {
667 return Config{}, err
668 }
669
Paul Duffin1356d8c2020-02-25 19:26:33 +0000670 // Make the CommonOS OsType available for all products.
671 targets[CommonOS] = []Target{commonTargetMap[CommonOS.Name]}
672
Dan Albert4098deb2016-10-19 14:04:41 -0700673 var archConfig []archConfig
Jingwen Chenc4d91bc2020-11-24 22:59:26 -0500674 if config.NdkAbis() {
Dan Albert4098deb2016-10-19 14:04:41 -0700675 archConfig = getNdkAbisConfig()
Martin Stjernholmc1ecc432019-11-15 15:00:31 +0000676 } else if config.AmlAbis() {
677 archConfig = getAmlAbisConfig()
Dan Albert4098deb2016-10-19 14:04:41 -0700678 }
679
680 if archConfig != nil {
Liz Kammerb7f33662022-02-28 14:16:16 -0500681 androidTargets, err := decodeAndroidArchSettings(archConfig)
Dan Willemsen322acaf2016-01-12 23:07:05 -0800682 if err != nil {
683 return Config{}, err
684 }
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700685 targets[Android] = androidTargets
Dan Willemsen322acaf2016-01-12 23:07:05 -0800686 }
687
Colin Cross3b19f5d2019-09-17 14:45:31 -0700688 multilib := make(map[string]bool)
689 for _, target := range targets[Android] {
690 if seen := multilib[target.Arch.ArchType.Multilib]; seen {
691 config.multilibConflicts[target.Arch.ArchType] = true
692 }
693 multilib[target.Arch.ArchType.Multilib] = true
694 }
695
Jingwen Chenc711fec2020-11-22 23:52:50 -0500696 // Map of OS to compilation targets.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700697 config.Targets = targets
Jingwen Chenc711fec2020-11-22 23:52:50 -0500698
699 // Compilation targets for host tools.
Colin Cross0c66bc62021-07-20 09:47:41 -0700700 config.BuildOSTarget = config.Targets[config.BuildOS][0]
701 config.BuildOSCommonTarget = getCommonTargets(config.Targets[config.BuildOS])[0]
Jingwen Chenc711fec2020-11-22 23:52:50 -0500702
703 // Compilation targets for Android.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700704 if len(config.Targets[Android]) > 0 {
705 config.AndroidCommonTarget = getCommonTargets(config.Targets[Android])[0]
Sam Delmericocc271e22022-06-01 15:45:02 +0000706 config.AndroidFirstDeviceTarget = FirstTarget(config.Targets[Android], "lib64", "lib32")[0]
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700707 }
Dan Willemsen218f6562015-07-08 18:13:11 -0700708
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500709 setBuildMode := func(arg string, mode SoongBuildMode) {
710 if arg != "" {
711 if config.BuildMode != AnalysisNoBazel {
712 fmt.Fprintf(os.Stderr, "buildMode is already set, illegal argument: %s", arg)
713 os.Exit(1)
714 }
715 config.BuildMode = mode
716 }
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800717 }
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500718 setBuildMode(cmdArgs.ModuleGraphFile, GenerateModuleGraph)
719 setBuildMode(cmdArgs.DocFile, GenerateDocFile)
MarkDacekd06db5d2022-11-29 00:47:59 +0000720
Jihoon Kangc1b04d62023-11-16 19:07:04 +0000721 config.productVariables.Build_from_text_stub = boolPtr(config.BuildFromTextStub())
722
Jingwen Chenc711fec2020-11-22 23:52:50 -0500723 return Config{config}, err
724}
Colin Cross988414c2020-01-11 01:11:46 +0000725
Colin Cross98be1bb2019-12-13 20:41:13 -0800726// mockFileSystem replaces all reads with accesses to the provided map of
727// filenames to contents stored as a byte slice.
728func (c *config) mockFileSystem(bp string, fs map[string][]byte) {
729 mockFS := map[string][]byte{}
730
731 if _, exists := mockFS["Android.bp"]; !exists {
732 mockFS["Android.bp"] = []byte(bp)
733 }
734
735 for k, v := range fs {
736 mockFS[k] = v
737 }
738
739 // no module list file specified; find every file named Blueprints or Android.bp
740 pathsToParse := []string{}
741 for candidate := range mockFS {
742 base := filepath.Base(candidate)
Lukacs T. Berkib838b0a2021-09-02 11:46:24 +0200743 if base == "Android.bp" {
Colin Cross98be1bb2019-12-13 20:41:13 -0800744 pathsToParse = append(pathsToParse, candidate)
745 }
746 }
747 if len(pathsToParse) < 1 {
748 panic(fmt.Sprintf("No Blueprint or Android.bp files found in mock filesystem: %v\n", mockFS))
749 }
750 mockFS[blueprint.MockModuleListFile] = []byte(strings.Join(pathsToParse, "\n"))
751
752 c.fs = pathtools.MockFs(mockFS)
753 c.mockBpList = blueprint.MockModuleListFile
754}
755
Lukacs T. Berkid1e3f1f2021-03-16 08:55:23 +0100756func (c *config) SetAllowMissingDependencies() {
757 c.productVariables.Allow_missing_dependencies = proptools.BoolPtr(true)
758}
759
Jingwen Chenc711fec2020-11-22 23:52:50 -0500760// BlueprintToolLocation returns the directory containing build system tools
761// from Blueprint, like soong_zip and merge_zips.
Lukacs T. Berkia806e412021-09-01 08:57:48 +0200762func (c *config) HostToolDir() string {
Colin Crossacfcc1f2021-10-25 15:40:32 -0700763 if c.KatiEnabled() {
764 return filepath.Join(c.outDir, "host", c.PrebuiltOS(), "bin")
765 } else {
766 return filepath.Join(c.soongOutDir, "host", c.PrebuiltOS(), "bin")
767 }
Dan Willemsenc2aa4a92016-05-26 15:13:03 -0700768}
769
Dan Willemsen60e62f02018-11-16 21:05:32 -0800770func (c *config) HostToolPath(ctx PathContext, tool string) Path {
Cole Faust3b703f32023-10-16 13:30:51 -0700771 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "bin", tool)
Colin Cross790ef352021-10-25 19:15:55 -0700772 return path
Dan Willemsen60e62f02018-11-16 21:05:32 -0800773}
774
Colin Cross790ef352021-10-25 19:15:55 -0700775func (c *config) HostJNIToolPath(ctx PathContext, lib string) Path {
Martin Stjernholm7260d062019-12-09 21:47:14 +0000776 ext := ".so"
777 if runtime.GOOS == "darwin" {
778 ext = ".dylib"
779 }
Cole Faust3b703f32023-10-16 13:30:51 -0700780 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "lib64", lib+ext)
Colin Cross790ef352021-10-25 19:15:55 -0700781 return path
Martin Stjernholm7260d062019-12-09 21:47:14 +0000782}
783
Colin Crossae5330a2021-11-03 13:31:22 -0700784func (c *config) HostJavaToolPath(ctx PathContext, tool string) Path {
Cole Faust3b703f32023-10-16 13:30:51 -0700785 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "framework", tool)
Colin Cross3e3eda62021-11-04 10:22:51 -0700786 return path
787}
788
Vinh Tran09581952023-05-16 16:03:20 -0400789func (c *config) HostCcSharedLibPath(ctx PathContext, lib string) Path {
790 libDir := "lib"
791 if ctx.Config().BuildArch.Multilib == "lib64" {
792 libDir = "lib64"
793 }
Cole Faust3b703f32023-10-16 13:30:51 -0700794 return pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, libDir, lib+".so")
Vinh Tran09581952023-05-16 16:03:20 -0400795}
796
Jingwen Chenc711fec2020-11-22 23:52:50 -0500797// PrebuiltOS returns the name of the host OS used in prebuilts directories.
Colin Cross1332b002015-04-07 17:11:30 -0700798func (c *config) PrebuiltOS() string {
Colin Cross3f40fa42015-01-30 17:27:36 -0800799 switch runtime.GOOS {
800 case "linux":
801 return "linux-x86"
802 case "darwin":
803 return "darwin-x86"
804 default:
805 panic("Unknown GOOS")
806 }
807}
808
809// GoRoot returns the path to the root directory of the Go toolchain.
Colin Cross1332b002015-04-07 17:11:30 -0700810func (c *config) GoRoot() string {
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200811 return fmt.Sprintf("prebuilts/go/%s", c.PrebuiltOS())
Colin Cross3f40fa42015-01-30 17:27:36 -0800812}
813
Jingwen Chenc711fec2020-11-22 23:52:50 -0500814// PrebuiltBuildTool returns the path to a tool in the prebuilts directory containing
815// checked-in tools, like Kati, Ninja or Toybox, for the current host OS.
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700816func (c *config) PrebuiltBuildTool(ctx PathContext, tool string) Path {
817 return PathForSource(ctx, "prebuilts/build-tools", c.PrebuiltOS(), "bin", tool)
818}
819
Jingwen Chenc711fec2020-11-22 23:52:50 -0500820// CpPreserveSymlinksFlags returns the host-specific flag for the cp(1) command
821// to preserve symlinks.
Colin Cross1332b002015-04-07 17:11:30 -0700822func (c *config) CpPreserveSymlinksFlags() string {
Colin Cross485e5722015-08-27 13:28:01 -0700823 switch runtime.GOOS {
Colin Cross3f40fa42015-01-30 17:27:36 -0800824 case "darwin":
825 return "-R"
826 case "linux":
827 return "-d"
828 default:
829 return ""
830 }
831}
Colin Cross68f55102015-03-25 14:43:57 -0700832
Colin Cross1332b002015-04-07 17:11:30 -0700833func (c *config) Getenv(key string) string {
Colin Cross68f55102015-03-25 14:43:57 -0700834 var val string
835 var exists bool
Colin Crossc1e86a32015-04-15 12:33:28 -0700836 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800837 defer c.envLock.Unlock()
838 if c.envDeps == nil {
839 c.envDeps = make(map[string]string)
840 }
Colin Cross68f55102015-03-25 14:43:57 -0700841 if val, exists = c.envDeps[key]; !exists {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700842 if c.envFrozen {
843 panic("Cannot access new environment variables after envdeps are frozen")
844 }
Colin Cross6ccbc912017-10-10 23:07:38 -0700845 val, _ = c.env[key]
Colin Cross68f55102015-03-25 14:43:57 -0700846 c.envDeps[key] = val
847 }
848 return val
849}
850
Colin Cross99d7c232016-11-23 16:52:04 -0800851func (c *config) GetenvWithDefault(key string, defaultValue string) string {
852 ret := c.Getenv(key)
853 if ret == "" {
854 return defaultValue
855 }
856 return ret
857}
858
859func (c *config) IsEnvTrue(key string) bool {
AdityaK19384102024-05-01 13:51:25 -0700860 value := strings.ToLower(c.Getenv(key))
Colin Cross99d7c232016-11-23 16:52:04 -0800861 return value == "1" || value == "y" || value == "yes" || value == "on" || value == "true"
862}
863
864func (c *config) IsEnvFalse(key string) bool {
AdityaK19384102024-05-01 13:51:25 -0700865 value := strings.ToLower(c.Getenv(key))
Colin Cross99d7c232016-11-23 16:52:04 -0800866 return value == "0" || value == "n" || value == "no" || value == "off" || value == "false"
867}
868
Sorin Basca253f8c02024-05-23 10:28:24 +0100869func (c *config) TargetsJava21() bool {
870 return c.IsEnvTrue("EXPERIMENTAL_TARGET_JAVA_VERSION_21")
871}
872
Jingwen Chenc711fec2020-11-22 23:52:50 -0500873// EnvDeps returns the environment variables this build depends on. The first
874// call to this function blocks future reads from the environment.
Colin Cross1332b002015-04-07 17:11:30 -0700875func (c *config) EnvDeps() map[string]string {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700876 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800877 defer c.envLock.Unlock()
Dan Willemsene7680ba2015-09-11 17:06:19 -0700878 c.envFrozen = true
Colin Cross68f55102015-03-25 14:43:57 -0700879 return c.envDeps
880}
Colin Cross35cec122015-04-02 14:37:16 -0700881
Jingwen Chencda22c92020-11-23 00:22:30 -0500882func (c *config) KatiEnabled() bool {
883 return c.katiEnabled
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800884}
885
Cole Faust11edf552023-10-13 11:32:14 -0700886func (c *config) ProductVariables() ProductVariables {
887 return c.productVariables
888}
889
Nan Zhang581fd212018-01-10 16:06:12 -0800890func (c *config) BuildId() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800891 return String(c.productVariables.BuildId)
Nan Zhang581fd212018-01-10 16:06:12 -0800892}
893
Inseob Kim8fa54da2024-03-19 16:48:59 +0900894func (c *config) DisplayBuildNumber() bool {
895 return Bool(c.productVariables.DisplayBuildNumber)
896}
897
Inseob Kim2da72af2024-06-18 11:09:12 +0900898// BuildFingerprintFile returns the path to a text file containing metadata
899// representing the current build's fingerprint.
900//
901// Rules that want to reference the build fingerprint should read from this file
902// without depending on it. They will run whenever their other dependencies
903// require them to run and get the current build fingerprint. This ensures they
904// don't rebuild on every incremental build when the build number changes.
905func (c *config) BuildFingerprintFile(ctx PathContext) Path {
906 return PathForArbitraryOutput(ctx, "target", "product", c.DeviceName(), String(c.productVariables.BuildFingerprintFile))
907}
908
Jingwen Chenc711fec2020-11-22 23:52:50 -0500909// BuildNumberFile returns the path to a text file containing metadata
910// representing the current build's number.
911//
912// Rules that want to reference the build number should read from this file
913// without depending on it. They will run whenever their other dependencies
914// require them to run and get the current build number. This ensures they don't
915// rebuild on every incremental build when the build number changes.
Colin Cross2a2e0db2020-02-21 16:55:46 -0800916func (c *config) BuildNumberFile(ctx PathContext) Path {
917 return PathForOutput(ctx, String(c.productVariables.BuildNumberFile))
Nan Zhang581fd212018-01-10 16:06:12 -0800918}
919
Inseob Kim8fa54da2024-03-19 16:48:59 +0900920// BuildHostnameFile returns the path to a text file containing metadata
921// representing the current build's host name.
922func (c *config) BuildHostnameFile(ctx PathContext) Path {
923 return PathForOutput(ctx, String(c.productVariables.BuildHostnameFile))
924}
925
926// BuildThumbprintFile returns the path to a text file containing metadata
927// representing the current build's thumbprint.
928//
929// Rules that want to reference the build thumbprint should read from this file
930// without depending on it. They will run whenever their other dependencies
931// require them to run and get the current build thumbprint. This ensures they
932// don't rebuild on every incremental build when the build thumbprint changes.
933func (c *config) BuildThumbprintFile(ctx PathContext) Path {
934 return PathForArbitraryOutput(ctx, "target", "product", c.DeviceName(), String(c.productVariables.BuildThumbprintFile))
935}
936
Jingwen Chenc711fec2020-11-22 23:52:50 -0500937// DeviceName returns the name of the current device target.
Colin Cross35cec122015-04-02 14:37:16 -0700938// TODO: take an AndroidModuleContext to select the device name for multi-device builds
Colin Cross1332b002015-04-07 17:11:30 -0700939func (c *config) DeviceName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800940 return *c.productVariables.DeviceName
Colin Cross35cec122015-04-02 14:37:16 -0700941}
942
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000943// DeviceProduct returns the current product target. There could be multiple of
944// these per device type.
945//
Chris Parsonsef615e52022-08-18 22:04:11 -0400946// NOTE: Do not base conditional logic on this value. It may break product inheritance.
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000947func (c *config) DeviceProduct() string {
948 return *c.productVariables.DeviceProduct
949}
950
Cole Faustb85d1a12022-11-08 18:14:01 -0800951// HasDeviceProduct returns if the build has a product. A build will not
952// necessarily have a product when --skip-config is passed to soong, like it is
953// in prebuilts/build-tools/build-prebuilts.sh
954func (c *config) HasDeviceProduct() bool {
955 return c.productVariables.DeviceProduct != nil
956}
957
Inseob Kim8fa54da2024-03-19 16:48:59 +0900958func (c *config) DeviceAbi() []string {
959 return c.productVariables.DeviceAbi
960}
961
Anton Hansson53c88442019-03-18 15:53:16 +0000962func (c *config) DeviceResourceOverlays() []string {
963 return c.productVariables.DeviceResourceOverlays
964}
965
966func (c *config) ProductResourceOverlays() []string {
967 return c.productVariables.ProductResourceOverlays
Colin Cross30e076a2015-04-13 13:58:27 -0700968}
969
Inseob Kim8fa54da2024-03-19 16:48:59 +0900970func (c *config) PlatformDisplayVersionName() string {
971 return String(c.productVariables.Platform_display_version_name)
972}
973
Colin Crossbfd347d2018-05-09 11:11:35 -0700974func (c *config) PlatformVersionName() string {
975 return String(c.productVariables.Platform_version_name)
976}
977
Dan Albert4f378d72020-07-23 17:32:15 -0700978func (c *config) PlatformSdkVersion() ApiLevel {
979 return uncheckedFinalApiLevel(*c.productVariables.Platform_sdk_version)
Colin Cross30e076a2015-04-13 13:58:27 -0700980}
981
Cole Faust37d27c42023-04-12 10:27:45 -0700982func (c *config) RawPlatformSdkVersion() *int {
983 return c.productVariables.Platform_sdk_version
984}
985
Mu-Le Lee5e047532022-07-27 02:32:03 +0000986func (c *config) PlatformSdkFinal() bool {
987 return Bool(c.productVariables.Platform_sdk_final)
988}
989
Colin Crossd09b0b62018-04-18 11:06:47 -0700990func (c *config) PlatformSdkCodename() string {
991 return String(c.productVariables.Platform_sdk_codename)
992}
993
Anton Hansson97d0bae2022-02-16 16:15:10 +0000994func (c *config) PlatformSdkExtensionVersion() int {
995 return *c.productVariables.Platform_sdk_extension_version
996}
997
998func (c *config) PlatformBaseSdkExtensionVersion() int {
999 return *c.productVariables.Platform_base_sdk_extension_version
1000}
1001
Colin Cross092c9da2019-04-02 22:56:43 -07001002func (c *config) PlatformSecurityPatch() string {
1003 return String(c.productVariables.Platform_security_patch)
1004}
1005
1006func (c *config) PlatformPreviewSdkVersion() string {
1007 return String(c.productVariables.Platform_preview_sdk_version)
1008}
1009
1010func (c *config) PlatformMinSupportedTargetSdkVersion() string {
Linus Tufvessonba270c52024-04-12 13:06:22 +02001011 var val, ok = c.productVariables.BuildFlags["RELEASE_PLATFORM_MIN_SUPPORTED_TARGET_SDK_VERSION"]
1012 if !ok {
1013 return ""
1014 }
1015 return val
Colin Cross092c9da2019-04-02 22:56:43 -07001016}
1017
1018func (c *config) PlatformBaseOS() string {
1019 return String(c.productVariables.Platform_base_os)
1020}
1021
Inseob Kim4f1f3d92022-04-25 18:23:58 +09001022func (c *config) PlatformVersionLastStable() string {
1023 return String(c.productVariables.Platform_version_last_stable)
1024}
1025
Jiyong Park37073842022-06-21 10:13:42 +09001026func (c *config) PlatformVersionKnownCodenames() string {
1027 return String(c.productVariables.Platform_version_known_codenames)
1028}
1029
Dan Albert1a246272020-07-06 14:49:35 -07001030func (c *config) MinSupportedSdkVersion() ApiLevel {
Dan Albert6bfb6bb2022-08-17 20:11:57 +00001031 return uncheckedFinalApiLevel(21)
Dan Albert1a246272020-07-06 14:49:35 -07001032}
1033
1034func (c *config) FinalApiLevels() []ApiLevel {
1035 var levels []ApiLevel
Dan Albert4f378d72020-07-23 17:32:15 -07001036 for i := 1; i <= c.PlatformSdkVersion().FinalOrFutureInt(); i++ {
Dan Albert1a246272020-07-06 14:49:35 -07001037 levels = append(levels, uncheckedFinalApiLevel(i))
1038 }
1039 return levels
1040}
1041
1042func (c *config) PreviewApiLevels() []ApiLevel {
1043 var levels []ApiLevel
Dan Albertf93ea132023-10-05 20:40:46 +00001044 i := 0
1045 for _, codename := range c.PlatformVersionActiveCodenames() {
1046 if codename == "REL" {
1047 continue
1048 }
1049
Dan Albert1a246272020-07-06 14:49:35 -07001050 levels = append(levels, ApiLevel{
1051 value: codename,
1052 number: i,
1053 isPreview: true,
1054 })
Dan Albertf93ea132023-10-05 20:40:46 +00001055 i++
Dan Albert1a246272020-07-06 14:49:35 -07001056 }
1057 return levels
1058}
1059
satayevcca4ab72021-11-30 12:33:55 +00001060func (c *config) LatestPreviewApiLevel() ApiLevel {
1061 level := NoneApiLevel
1062 for _, l := range c.PreviewApiLevels() {
1063 if l.GreaterThan(level) {
1064 level = l
1065 }
1066 }
1067 return level
1068}
1069
Dan Albert1a246272020-07-06 14:49:35 -07001070func (c *config) AllSupportedApiLevels() []ApiLevel {
1071 var levels []ApiLevel
1072 levels = append(levels, c.FinalApiLevels()...)
1073 return append(levels, c.PreviewApiLevels()...)
Dan Albertf5415d72017-08-17 16:19:59 -07001074}
1075
Jingwen Chenc711fec2020-11-22 23:52:50 -05001076// DefaultAppTargetSdk returns the API level that platform apps are targeting.
1077// This converts a codename to the exact ApiLevel it represents.
Dan Albert4f378d72020-07-23 17:32:15 -07001078func (c *config) DefaultAppTargetSdk(ctx EarlyModuleContext) ApiLevel {
Colin Crossd09b0b62018-04-18 11:06:47 -07001079 if Bool(c.productVariables.Platform_sdk_final) {
1080 return c.PlatformSdkVersion()
Colin Crossd09b0b62018-04-18 11:06:47 -07001081 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001082 codename := c.PlatformSdkCodename()
Jiyong Park3a00e3d2023-03-27 17:39:48 +09001083 hostOnlyBuild := c.productVariables.DeviceArch == nil
Jingwen Chenc711fec2020-11-22 23:52:50 -05001084 if codename == "" {
Jiyong Park3a00e3d2023-03-27 17:39:48 +09001085 // There are some host-only builds (those are invoked by build-prebuilts.sh) which
1086 // don't set platform sdk codename. Platform sdk codename makes sense only when we
1087 // are building the platform. So we don't enforce the below panic for the host-only
1088 // builds.
1089 if hostOnlyBuild {
1090 return NoneApiLevel
1091 }
1092 panic("Platform_sdk_codename must be set")
Jingwen Chenc711fec2020-11-22 23:52:50 -05001093 }
1094 if codename == "REL" {
1095 panic("Platform_sdk_codename should not be REL when Platform_sdk_final is true")
1096 }
1097 return ApiLevelOrPanic(ctx, codename)
Colin Crossd09b0b62018-04-18 11:06:47 -07001098}
1099
LaMont Jones99f18962024-10-17 11:50:44 -07001100func (c *config) PartialCompileFlags() partialCompileFlags {
1101 return c.partialCompileFlags
1102}
1103
Colin Cross3bc7ffa2017-11-22 16:19:37 -08001104func (c *config) AppsDefaultVersionName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001105 return String(c.productVariables.AppsDefaultVersionName)
Colin Cross3bc7ffa2017-11-22 16:19:37 -08001106}
1107
Dan Albert31384de2017-07-28 12:39:46 -07001108// Codenames that are active in the current lunch target.
1109func (c *config) PlatformVersionActiveCodenames() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001110 return c.productVariables.Platform_version_active_codenames
Dan Albert31384de2017-07-28 12:39:46 -07001111}
1112
Dan Albert8c7a9942023-03-27 20:34:01 +00001113// All unreleased codenames.
1114func (c *config) PlatformVersionAllPreviewCodenames() []string {
1115 return c.productVariables.Platform_version_all_preview_codenames
1116}
1117
Colin Crossface4e42017-10-30 17:32:15 -07001118func (c *config) ProductAAPTConfig() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001119 return c.productVariables.AAPTConfig
Colin Cross30e076a2015-04-13 13:58:27 -07001120}
1121
Colin Crossface4e42017-10-30 17:32:15 -07001122func (c *config) ProductAAPTPreferredConfig() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001123 return String(c.productVariables.AAPTPreferredConfig)
Colin Cross30e076a2015-04-13 13:58:27 -07001124}
1125
Colin Crossface4e42017-10-30 17:32:15 -07001126func (c *config) ProductAAPTCharacteristics() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001127 return String(c.productVariables.AAPTCharacteristics)
Colin Crossface4e42017-10-30 17:32:15 -07001128}
1129
1130func (c *config) ProductAAPTPrebuiltDPI() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001131 return c.productVariables.AAPTPrebuiltDPI
Colin Cross30e076a2015-04-13 13:58:27 -07001132}
1133
Dan Willemsen34cc69e2015-09-23 15:26:20 -07001134func (c *config) DefaultAppCertificateDir(ctx PathContext) SourcePath {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001135 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -08001136 if defaultCert != "" {
1137 return PathForSource(ctx, filepath.Dir(defaultCert))
Colin Cross61ae0b72017-12-01 17:16:02 -08001138 }
Inseob Kim8fa54da2024-03-19 16:48:59 +09001139 return PathForSource(ctx, testKeyDir)
Colin Cross30e076a2015-04-13 13:58:27 -07001140}
1141
Colin Crosse1731a52017-12-14 11:22:55 -08001142func (c *config) DefaultAppCertificate(ctx PathContext) (pem, key SourcePath) {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001143 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -08001144 if defaultCert != "" {
Colin Crosse1731a52017-12-14 11:22:55 -08001145 return PathForSource(ctx, defaultCert+".x509.pem"), PathForSource(ctx, defaultCert+".pk8")
Colin Cross61ae0b72017-12-01 17:16:02 -08001146 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001147 defaultDir := c.DefaultAppCertificateDir(ctx)
1148 return defaultDir.Join(ctx, "testkey.x509.pem"), defaultDir.Join(ctx, "testkey.pk8")
Colin Cross30e076a2015-04-13 13:58:27 -07001149}
Colin Cross6ff51382015-12-17 16:39:19 -08001150
Justin Yun635e7882024-07-04 14:50:57 +09001151func (c *config) ExtraOtaKeys(ctx PathContext, recovery bool) []SourcePath {
1152 var otaKeys []string
1153 if recovery {
1154 otaKeys = c.productVariables.ExtraOtaRecoveryKeys
1155 } else {
1156 otaKeys = c.productVariables.ExtraOtaKeys
1157 }
1158
1159 otaPaths := make([]SourcePath, len(otaKeys))
1160 for i, key := range otaKeys {
1161 otaPaths[i] = PathForSource(ctx, key+".x509.pem")
1162 }
1163
1164 return otaPaths
1165}
1166
Inseob Kim8fa54da2024-03-19 16:48:59 +09001167func (c *config) BuildKeys() string {
1168 defaultCert := String(c.productVariables.DefaultAppCertificate)
1169 if defaultCert == "" || defaultCert == filepath.Join(testKeyDir, "testkey") {
1170 return "test-keys"
1171 }
1172 return "dev-keys"
1173}
1174
Jiyong Park9335a262018-12-24 11:31:58 +09001175func (c *config) ApexKeyDir(ctx ModuleContext) SourcePath {
1176 // TODO(b/121224311): define another variable such as TARGET_APEX_KEY_OVERRIDE
1177 defaultCert := String(c.productVariables.DefaultAppCertificate)
Inseob Kim8fa54da2024-03-19 16:48:59 +09001178 if defaultCert == "" || filepath.Dir(defaultCert) == testKeyDir {
Jiyong Park9335a262018-12-24 11:31:58 +09001179 // When defaultCert is unset or is set to the testkeys path, use the APEX keys
1180 // that is under the module dir
Colin Cross07e51612019-03-05 12:46:40 -08001181 return pathForModuleSrc(ctx)
Jiyong Park9335a262018-12-24 11:31:58 +09001182 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001183 // If not, APEX keys are under the specified directory
1184 return PathForSource(ctx, filepath.Dir(defaultCert))
Jiyong Park9335a262018-12-24 11:31:58 +09001185}
1186
Inseob Kim80fa7982022-08-12 21:36:25 +09001187// Certificate for the NetworkStack sepolicy context
1188func (c *config) MainlineSepolicyDevCertificatesDir(ctx ModuleContext) SourcePath {
1189 cert := String(c.productVariables.MainlineSepolicyDevCertificates)
1190 if cert != "" {
1191 return PathForSource(ctx, cert)
1192 }
1193 return c.DefaultAppCertificateDir(ctx)
1194}
1195
Jingwen Chenc711fec2020-11-22 23:52:50 -05001196// AllowMissingDependencies configures Blueprint/Soong to not fail when modules
1197// are configured to depend on non-existent modules. Note that this does not
1198// affect missing input dependencies at the Ninja level.
Colin Cross6ff51382015-12-17 16:39:19 -08001199func (c *config) AllowMissingDependencies() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001200 return Bool(c.productVariables.Allow_missing_dependencies)
Colin Cross6ff51382015-12-17 16:39:19 -08001201}
Dan Willemsen322acaf2016-01-12 23:07:05 -08001202
Jeongik Cha816a23a2020-07-08 01:09:23 +09001203// Returns true if a full platform source tree cannot be assumed.
Colin Crossfc3674a2017-09-18 17:41:52 -07001204func (c *config) UnbundledBuild() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001205 return Bool(c.productVariables.Unbundled_build)
Colin Crossfc3674a2017-09-18 17:41:52 -07001206}
1207
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +01001208// Returns true if building apps that aren't bundled with the platform.
1209// UnbundledBuild() is always true when this is true.
1210func (c *config) UnbundledBuildApps() bool {
Cole Faust701ca252021-11-23 19:02:08 -08001211 return len(c.productVariables.Unbundled_build_apps) > 0
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +01001212}
1213
Jeongik Cha4b073cd2021-06-08 11:35:00 +09001214// Returns true if building image that aren't bundled with the platform.
1215// UnbundledBuild() is always true when this is true.
1216func (c *config) UnbundledBuildImage() bool {
1217 return Bool(c.productVariables.Unbundled_build_image)
1218}
1219
Jeongik Cha816a23a2020-07-08 01:09:23 +09001220// Returns true if building modules against prebuilt SDKs.
1221func (c *config) AlwaysUsePrebuiltSdks() bool {
1222 return Bool(c.productVariables.Always_use_prebuilt_sdks)
Colin Cross1f367bf2018-12-18 22:46:24 -08001223}
1224
Colin Cross126a25c2017-10-31 13:55:34 -07001225func (c *config) MinimizeJavaDebugInfo() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001226 return Bool(c.productVariables.MinimizeJavaDebugInfo) && !Bool(c.productVariables.Eng)
Colin Cross126a25c2017-10-31 13:55:34 -07001227}
1228
Colin Crossed064c02018-09-05 16:28:13 -07001229func (c *config) Debuggable() bool {
1230 return Bool(c.productVariables.Debuggable)
1231}
1232
Jaewoong Jung1d6eb682018-11-29 15:08:44 -08001233func (c *config) Eng() bool {
1234 return Bool(c.productVariables.Eng)
1235}
1236
Inseob Kim8fa54da2024-03-19 16:48:59 +09001237func (c *config) BuildType() string {
1238 return String(c.productVariables.BuildType)
1239}
1240
Colin Crossc53c37f2021-12-08 15:42:22 -08001241// DevicePrimaryArchType returns the ArchType for the first configured device architecture, or
1242// Common if there are no device architectures.
Jiyong Park8d52f862018-07-07 18:02:07 +09001243func (c *config) DevicePrimaryArchType() ArchType {
Colin Crossc53c37f2021-12-08 15:42:22 -08001244 if androidTargets := c.Targets[Android]; len(androidTargets) > 0 {
1245 return androidTargets[0].Arch.ArchType
1246 }
1247 return Common
Jiyong Park8d52f862018-07-07 18:02:07 +09001248}
1249
Colin Cross16b23492016-01-06 14:41:07 -08001250func (c *config) SanitizeHost() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001251 return append([]string(nil), c.productVariables.SanitizeHost...)
Colin Cross16b23492016-01-06 14:41:07 -08001252}
1253
1254func (c *config) SanitizeDevice() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001255 return append([]string(nil), c.productVariables.SanitizeDevice...)
Colin Cross23ae82a2016-11-02 14:34:39 -07001256}
1257
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -07001258func (c *config) SanitizeDeviceDiag() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001259 return append([]string(nil), c.productVariables.SanitizeDeviceDiag...)
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -07001260}
1261
Colin Cross23ae82a2016-11-02 14:34:39 -07001262func (c *config) SanitizeDeviceArch() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001263 return append([]string(nil), c.productVariables.SanitizeDeviceArch...)
Colin Cross16b23492016-01-06 14:41:07 -08001264}
Colin Crossa1ad8d12016-06-01 17:09:44 -07001265
Vishwath Mohan1b017a72017-01-19 13:54:55 -08001266func (c *config) EnableCFI() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001267 if c.productVariables.EnableCFI == nil {
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -08001268 return true
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -08001269 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001270 return *c.productVariables.EnableCFI
Vishwath Mohan1b017a72017-01-19 13:54:55 -08001271}
1272
Kostya Kortchinskyd5275c82019-02-01 08:42:56 -08001273func (c *config) DisableScudo() bool {
1274 return Bool(c.productVariables.DisableScudo)
1275}
1276
Colin Crossa1ad8d12016-06-01 17:09:44 -07001277func (c *config) Android64() bool {
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001278 for _, t := range c.Targets[Android] {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001279 if t.Arch.ArchType.Multilib == "lib64" {
1280 return true
1281 }
1282 }
1283
1284 return false
1285}
Colin Cross9272ade2016-08-17 15:24:12 -07001286
Colin Cross9d45bb72016-08-29 16:14:13 -07001287func (c *config) UseGoma() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001288 return Bool(c.productVariables.UseGoma)
Colin Cross9d45bb72016-08-29 16:14:13 -07001289}
1290
Taylor Santiago3c16e612024-05-30 14:41:31 -07001291func (c *config) UseABFS() bool {
1292 return Bool(c.productVariables.UseABFS)
1293}
1294
Ramy Medhatbbf25672019-07-17 12:30:04 +00001295func (c *config) UseRBE() bool {
1296 return Bool(c.productVariables.UseRBE)
1297}
1298
Ramy Medhat8ea054a2020-01-27 14:19:44 -05001299func (c *config) UseRBEJAVAC() bool {
1300 return Bool(c.productVariables.UseRBEJAVAC)
1301}
1302
1303func (c *config) UseRBER8() bool {
1304 return Bool(c.productVariables.UseRBER8)
1305}
1306
1307func (c *config) UseRBED8() bool {
1308 return Bool(c.productVariables.UseRBED8)
1309}
1310
Colin Cross8b8bec32019-11-15 13:18:43 -08001311func (c *config) UseRemoteBuild() bool {
1312 return c.UseGoma() || c.UseRBE()
1313}
1314
Colin Cross66548102018-06-19 22:47:35 -07001315func (c *config) RunErrorProne() bool {
1316 return c.IsEnvTrue("RUN_ERROR_PRONE")
1317}
1318
Jingwen Chenc711fec2020-11-22 23:52:50 -05001319// XrefCorpusName returns the Kythe cross-reference corpus name.
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001320func (c *config) XrefCorpusName() string {
1321 return c.Getenv("XREF_CORPUS")
1322}
1323
Jingwen Chenc711fec2020-11-22 23:52:50 -05001324// XrefCuEncoding returns the compilation unit encoding to use for Kythe code
1325// xrefs. Can be 'json' (default), 'proto' or 'all'.
Sasha Smundak6c2d4f92020-01-09 17:34:23 -08001326func (c *config) XrefCuEncoding() string {
1327 if enc := c.Getenv("KYTHE_KZIP_ENCODING"); enc != "" {
1328 return enc
1329 }
1330 return "json"
1331}
1332
Sasha Smundakb0addaf2021-02-16 10:39:40 -08001333// XrefCuJavaSourceMax returns the maximum number of the Java source files
1334// in a single compilation unit
1335const xrefJavaSourceFileMaxDefault = "1000"
1336
1337func (c Config) XrefCuJavaSourceMax() string {
1338 v := c.Getenv("KYTHE_JAVA_SOURCE_BATCH_SIZE")
1339 if v == "" {
1340 return xrefJavaSourceFileMaxDefault
1341 }
1342 if _, err := strconv.ParseUint(v, 0, 0); err != nil {
1343 fmt.Fprintf(os.Stderr,
1344 "bad KYTHE_JAVA_SOURCE_BATCH_SIZE value: %s, will use %s",
1345 err, xrefJavaSourceFileMaxDefault)
1346 return xrefJavaSourceFileMaxDefault
1347 }
1348 return v
1349
1350}
1351
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001352func (c *config) EmitXrefRules() bool {
1353 return c.XrefCorpusName() != ""
1354}
1355
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001356func (c *config) ClangTidy() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001357 return Bool(c.productVariables.ClangTidy)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001358}
1359
1360func (c *config) TidyChecks() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001361 if c.productVariables.TidyChecks == nil {
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001362 return ""
1363 }
Dan Willemsen45133ac2018-03-09 21:22:06 -08001364 return *c.productVariables.TidyChecks
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001365}
1366
Colin Cross0f4e0d62016-07-27 10:56:55 -07001367func (c *config) LibartImgHostBaseAddress() string {
David Srbeckya4f336b2024-09-04 16:06:56 +01001368 return "0x70000000"
Colin Cross0f4e0d62016-07-27 10:56:55 -07001369}
1370
1371func (c *config) LibartImgDeviceBaseAddress() string {
Elliott Hughesda3a0712020-03-06 16:55:28 -08001372 return "0x70000000"
Colin Cross0f4e0d62016-07-27 10:56:55 -07001373}
1374
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001375func (c *config) ArtUseReadBarrier() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001376 return Bool(c.productVariables.ArtUseReadBarrier)
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001377}
1378
Jingwen Chenc711fec2020-11-22 23:52:50 -05001379// Enforce Runtime Resource Overlays for a module. RROs supersede static RROs,
1380// but some modules still depend on it.
1381//
1382// More info: https://source.android.com/devices/architecture/rros
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001383func (c *config) EnforceRROForModule(name string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001384 enforceList := c.productVariables.EnforceRROTargets
Jeongik Chacee5ba92021-02-19 12:11:51 +09001385
Roland Levillainf6cc2612020-07-09 16:58:14 +01001386 if len(enforceList) > 0 {
Yo Chiang4ebd06a2019-10-01 13:13:41 +08001387 if InList("*", enforceList) {
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001388 return true
1389 }
Colin Crossa74ca042019-01-31 14:31:51 -08001390 return InList(name, enforceList)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001391 }
1392 return false
1393}
Colin Crossc4441622024-09-18 14:55:49 -07001394
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001395func (c *config) EnforceRROExcludedOverlay(path string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001396 excluded := c.productVariables.EnforceRROExcludedOverlays
Roland Levillainf6cc2612020-07-09 16:58:14 +01001397 if len(excluded) > 0 {
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001398 return HasAnyPrefix(path, excluded)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001399 }
1400 return false
1401}
1402
Colin Crossc4441622024-09-18 14:55:49 -07001403func (c *config) EnforceRROGlobally() bool {
1404 enforceList := c.productVariables.EnforceRROTargets
1405 return InList("*", enforceList)
1406}
1407
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001408func (c *config) ExportedNamespaces() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001409 return append([]string(nil), c.productVariables.NamespacesToExport...)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001410}
1411
Sam Delmerico98a73292023-02-21 11:50:29 -05001412func (c *config) SourceRootDirs() []string {
1413 return c.productVariables.SourceRootDirs
1414}
1415
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001416func (c *config) HostStaticBinaries() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001417 return Bool(c.productVariables.HostStaticBinaries)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001418}
1419
Colin Cross5a0dcd52018-10-05 14:20:06 -07001420func (c *config) UncompressPrivAppDex() bool {
1421 return Bool(c.productVariables.UncompressPrivAppDex)
1422}
1423
1424func (c *config) ModulesLoadedByPrivilegedModules() []string {
1425 return c.productVariables.ModulesLoadedByPrivilegedModules
1426}
1427
Jingwen Chenc711fec2020-11-22 23:52:50 -05001428// DexpreoptGlobalConfigPath returns the path to the dexpreopt.config file in
1429// the output directory, if it was created during the product configuration
1430// phase by Kati.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001431func (c *config) DexpreoptGlobalConfigPath(ctx PathContext) OptionalPath {
Colin Cross988414c2020-01-11 01:11:46 +00001432 if c.productVariables.DexpreoptGlobalConfig == nil {
Jingwen Chenebb0b572020-11-02 00:24:57 -05001433 return OptionalPathForPath(nil)
1434 }
1435 return OptionalPathForPath(
1436 pathForBuildToolDep(ctx, *c.productVariables.DexpreoptGlobalConfig))
1437}
1438
Jingwen Chenc711fec2020-11-22 23:52:50 -05001439// DexpreoptGlobalConfig returns the raw byte contents of the dexpreopt global
1440// configuration. Since the configuration file was created by Kati during
1441// product configuration (externally of soong_build), it's not tracked, so we
1442// also manually add a Ninja file dependency on the configuration file to the
1443// rule that creates the main build.ninja file. This ensures that build.ninja is
1444// regenerated correctly if dexpreopt.config changes.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001445func (c *config) DexpreoptGlobalConfig(ctx PathContext) ([]byte, error) {
1446 path := c.DexpreoptGlobalConfigPath(ctx)
1447 if !path.Valid() {
Colin Cross988414c2020-01-11 01:11:46 +00001448 return nil, nil
1449 }
Jingwen Chenebb0b572020-11-02 00:24:57 -05001450 ctx.AddNinjaFileDeps(path.String())
Sasha Smundakaf5ca922022-12-12 21:23:34 -08001451 return os.ReadFile(absolutePath(path.String()))
Colin Cross43f08db2018-11-12 10:13:39 -08001452}
1453
Inseob Kim7b85eeb2021-03-23 20:52:24 +09001454func (c *deviceConfig) WithDexpreopt() bool {
1455 return c.config.productVariables.WithDexpreopt
1456}
1457
Colin Cross662d6142022-11-03 20:38:01 -07001458func (c *config) FrameworksBaseDirExists(ctx PathGlobContext) bool {
Colin Cross5a756a62021-03-16 16:34:46 -07001459 return ExistentPathForSource(ctx, "frameworks", "base", "Android.bp").Valid()
David Brazdil91b4e3e2019-01-23 21:04:05 +00001460}
1461
Colin Cross3b19f5d2019-09-17 14:45:31 -07001462func (c *config) HasMultilibConflict(arch ArchType) bool {
1463 return c.multilibConflicts[arch]
1464}
1465
Sasha Smundakaf5ca922022-12-12 21:23:34 -08001466func (c *config) PrebuiltHiddenApiDir(_ PathContext) string {
Bill Peckhambae47492021-01-08 09:34:44 -08001467 return String(c.productVariables.PrebuiltHiddenApiDir)
1468}
1469
Justin Yun41cbb5e2023-11-29 17:58:16 +09001470func (c *config) VendorApiLevel() string {
1471 return String(c.productVariables.VendorApiLevel)
1472}
1473
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001474func (c *config) PrevVendorApiLevel() string {
1475 vendorApiLevel, err := strconv.Atoi(c.VendorApiLevel())
1476 if err != nil {
1477 panic(fmt.Errorf("Cannot parse vendor API level %s to an integer: %s",
1478 c.VendorApiLevel(), err))
1479 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001480 // The version before trunk stable is 34.
1481 if vendorApiLevel == 202404 {
1482 return "34"
1483 }
Hsin-Yi Chen890e7722024-03-05 15:56:44 +08001484 if vendorApiLevel >= 1 && vendorApiLevel <= 34 {
1485 return strconv.Itoa(vendorApiLevel - 1)
1486 }
1487 if vendorApiLevel < 202404 || vendorApiLevel%100 != 4 {
1488 panic("Unknown vendor API level " + c.VendorApiLevel())
1489 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001490 return strconv.Itoa(vendorApiLevel - 100)
1491}
1492
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001493func IsTrunkStableVendorApiLevel(level string) bool {
1494 levelInt, err := strconv.Atoi(level)
1495 return err == nil && levelInt >= 202404
1496}
1497
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001498func (c *config) VendorApiLevelFrozen() bool {
1499 return c.productVariables.GetBuildFlagBool("RELEASE_BOARD_API_LEVEL_FROZEN")
1500}
1501
Colin Cross9272ade2016-08-17 15:24:12 -07001502func (c *deviceConfig) Arches() []Arch {
1503 var arches []Arch
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001504 for _, target := range c.config.Targets[Android] {
Colin Cross9272ade2016-08-17 15:24:12 -07001505 arches = append(arches, target.Arch)
1506 }
1507 return arches
1508}
Dan Willemsend2ede872016-11-18 14:54:24 -08001509
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001510func (c *deviceConfig) BinderBitness() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001511 is32BitBinder := c.config.productVariables.Binder32bit
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001512 if is32BitBinder != nil && *is32BitBinder {
1513 return "32"
1514 }
1515 return "64"
1516}
1517
Dan Willemsen4353bc42016-12-05 17:16:02 -08001518func (c *deviceConfig) VendorPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001519 if c.config.productVariables.VendorPath != nil {
1520 return *c.config.productVariables.VendorPath
Dan Willemsen4353bc42016-12-05 17:16:02 -08001521 }
1522 return "vendor"
1523}
1524
Spandan Dase3b65312024-10-22 00:27:27 +00001525func (c *deviceConfig) BuildingVendorImage() bool {
1526 return proptools.Bool(c.config.productVariables.BuildingVendorImage)
1527}
1528
Jeongik Cha219141c2020-08-06 23:00:37 +09001529func (c *deviceConfig) CurrentApiLevelForVendorModules() string {
1530 return StringDefault(c.config.productVariables.DeviceCurrentApiLevelForVendorModules, "current")
1531}
1532
Justin Yun71549282017-11-17 12:10:28 +09001533func (c *deviceConfig) ExtraVndkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001534 return c.config.productVariables.ExtraVndkVersions
Dan Willemsend2ede872016-11-18 14:54:24 -08001535}
Jack He8cc71432016-12-08 15:45:07 -08001536
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001537func (c *deviceConfig) SystemSdkVersions() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001538 return c.config.productVariables.DeviceSystemSdkVersions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001539}
1540
1541func (c *deviceConfig) PlatformSystemSdkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001542 return c.config.productVariables.Platform_systemsdk_versions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001543}
1544
Jiyong Park2db76922017-11-08 16:03:48 +09001545func (c *deviceConfig) OdmPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001546 if c.config.productVariables.OdmPath != nil {
1547 return *c.config.productVariables.OdmPath
Jiyong Park2db76922017-11-08 16:03:48 +09001548 }
1549 return "odm"
1550}
1551
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001552func (c *deviceConfig) ProductPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001553 if c.config.productVariables.ProductPath != nil {
1554 return *c.config.productVariables.ProductPath
Jiyong Park2db76922017-11-08 16:03:48 +09001555 }
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001556 return "product"
Jiyong Park2db76922017-11-08 16:03:48 +09001557}
1558
Jihoon Kang6dd13b62024-10-22 23:21:02 +00001559func (c *deviceConfig) BuildingProductImage() bool {
1560 return proptools.Bool(c.config.productVariables.BuildingProductImage)
1561}
1562
Justin Yund5f6c822019-06-25 16:47:17 +09001563func (c *deviceConfig) SystemExtPath() string {
1564 if c.config.productVariables.SystemExtPath != nil {
1565 return *c.config.productVariables.SystemExtPath
Dario Frenifd05a742018-05-29 13:28:54 +01001566 }
Justin Yund5f6c822019-06-25 16:47:17 +09001567 return "system_ext"
Dario Frenifd05a742018-05-29 13:28:54 +01001568}
1569
Jack He8cc71432016-12-08 15:45:07 -08001570func (c *deviceConfig) BtConfigIncludeDir() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001571 return String(c.config.productVariables.BtConfigIncludeDir)
Jack He8cc71432016-12-08 15:45:07 -08001572}
Dan Willemsen581341d2017-02-09 16:16:31 -08001573
Jiyong Parkd773eb32017-07-03 13:18:12 +09001574func (c *deviceConfig) DeviceKernelHeaderDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001575 return c.config.productVariables.DeviceKernelHeaders
Jiyong Parkd773eb32017-07-03 13:18:12 +09001576}
1577
Roland Levillainada12702020-06-09 13:07:36 +01001578// JavaCoverageEnabledForPath returns whether Java code coverage is enabled for
1579// path. Coverage is enabled by default when the product variable
1580// JavaCoveragePaths is empty. If JavaCoveragePaths is not empty, coverage is
1581// enabled for any path which is part of this variable (and not part of the
1582// JavaCoverageExcludePaths product variable). Value "*" in JavaCoveragePaths
1583// represents any path.
1584func (c *deviceConfig) JavaCoverageEnabledForPath(path string) bool {
1585 coverage := false
Chris Gross2f748692020-06-24 20:36:59 +00001586 if len(c.config.productVariables.JavaCoveragePaths) == 0 ||
Roland Levillainada12702020-06-09 13:07:36 +01001587 InList("*", c.config.productVariables.JavaCoveragePaths) ||
1588 HasAnyPrefix(path, c.config.productVariables.JavaCoveragePaths) {
1589 coverage = true
1590 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001591 if coverage && len(c.config.productVariables.JavaCoverageExcludePaths) > 0 {
Roland Levillainada12702020-06-09 13:07:36 +01001592 if HasAnyPrefix(path, c.config.productVariables.JavaCoverageExcludePaths) {
1593 coverage = false
1594 }
1595 }
1596 return coverage
1597}
1598
Colin Cross1a6acd42020-06-16 17:51:46 -07001599// Returns true if gcov or clang coverage is enabled.
Dan Willemsen581341d2017-02-09 16:16:31 -08001600func (c *deviceConfig) NativeCoverageEnabled() bool {
Colin Cross1a6acd42020-06-16 17:51:46 -07001601 return Bool(c.config.productVariables.GcovCoverage) ||
1602 Bool(c.config.productVariables.ClangCoverage)
Dan Willemsen581341d2017-02-09 16:16:31 -08001603}
1604
Oliver Nguyen1382ab62019-12-06 15:22:41 -08001605func (c *deviceConfig) ClangCoverageEnabled() bool {
1606 return Bool(c.config.productVariables.ClangCoverage)
1607}
1608
Pirama Arumuga Nainarb37ae582022-01-26 22:14:32 -08001609func (c *deviceConfig) ClangCoverageContinuousMode() bool {
1610 return Bool(c.config.productVariables.ClangCoverageContinuousMode)
1611}
1612
Colin Cross1a6acd42020-06-16 17:51:46 -07001613func (c *deviceConfig) GcovCoverageEnabled() bool {
1614 return Bool(c.config.productVariables.GcovCoverage)
1615}
1616
Roland Levillain4f5297b2020-06-09 12:44:06 +01001617// NativeCoverageEnabledForPath returns whether (GCOV- or Clang-based) native
1618// code coverage is enabled for path. By default, coverage is not enabled for a
1619// given path unless it is part of the NativeCoveragePaths product variable (and
1620// not part of the NativeCoverageExcludePaths product variable). Value "*" in
1621// NativeCoveragePaths represents any path.
1622func (c *deviceConfig) NativeCoverageEnabledForPath(path string) bool {
Ryan Campbell469a18a2017-02-27 09:01:54 -08001623 coverage := false
Roland Levillainf6cc2612020-07-09 16:58:14 +01001624 if len(c.config.productVariables.NativeCoveragePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001625 if InList("*", c.config.productVariables.NativeCoveragePaths) || HasAnyPrefix(path, c.config.productVariables.NativeCoveragePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001626 coverage = true
Dan Willemsen581341d2017-02-09 16:16:31 -08001627 }
1628 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001629 if coverage && len(c.config.productVariables.NativeCoverageExcludePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001630 if HasAnyPrefix(path, c.config.productVariables.NativeCoverageExcludePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001631 coverage = false
Ryan Campbell469a18a2017-02-27 09:01:54 -08001632 }
1633 }
1634 return coverage
Dan Willemsen581341d2017-02-09 16:16:31 -08001635}
Ivan Lozano5f595532017-07-13 14:46:05 -07001636
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001637func (c *deviceConfig) PgoAdditionalProfileDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001638 return c.config.productVariables.PgoAdditionalProfileDirs
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001639}
1640
Vinh Tran44cb78c2023-03-09 22:07:19 -05001641// AfdoProfile returns fully qualified path associated to the given module name
Colin Crossd38feb02024-01-23 16:38:06 -08001642func (c *deviceConfig) AfdoProfile(name string) (string, error) {
Vinh Tran44cb78c2023-03-09 22:07:19 -05001643 for _, afdoProfile := range c.config.productVariables.AfdoProfiles {
1644 split := strings.Split(afdoProfile, ":")
1645 if len(split) != 3 {
Colin Crossd38feb02024-01-23 16:38:06 -08001646 return "", fmt.Errorf("AFDO_PROFILES has invalid value: %s. "+
Vinh Tran44cb78c2023-03-09 22:07:19 -05001647 "The expected format is <module>:<fully-qualified-path-to-fdo_profile>", afdoProfile)
1648 }
1649 if split[0] == name {
Colin Crossd38feb02024-01-23 16:38:06 -08001650 return strings.Join([]string{split[1], split[2]}, ":"), nil
Vinh Tran44cb78c2023-03-09 22:07:19 -05001651 }
1652 }
Colin Crossd38feb02024-01-23 16:38:06 -08001653 return "", nil
Vinh Tran44cb78c2023-03-09 22:07:19 -05001654}
1655
Tri Vo35a51432018-03-25 20:00:00 -07001656func (c *deviceConfig) VendorSepolicyDirs() []string {
1657 return c.config.productVariables.BoardVendorSepolicyDirs
1658}
1659
1660func (c *deviceConfig) OdmSepolicyDirs() []string {
1661 return c.config.productVariables.BoardOdmSepolicyDirs
1662}
1663
Felixa20a8752020-05-17 18:28:35 +02001664func (c *deviceConfig) SystemExtPublicSepolicyDirs() []string {
1665 return c.config.productVariables.SystemExtPublicSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001666}
1667
Felixa20a8752020-05-17 18:28:35 +02001668func (c *deviceConfig) SystemExtPrivateSepolicyDirs() []string {
1669 return c.config.productVariables.SystemExtPrivateSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001670}
1671
Inseob Kim0866b002019-04-15 20:21:29 +09001672func (c *deviceConfig) SepolicyM4Defs() []string {
1673 return c.config.productVariables.BoardSepolicyM4Defs
1674}
1675
Jiyong Park7f67f482019-01-05 12:57:48 +09001676func (c *deviceConfig) OverrideManifestPackageNameFor(name string) (manifestName string, overridden bool) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001677 return findOverrideValue(c.config.productVariables.ManifestPackageNameOverrides, name,
1678 "invalid override rule %q in PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES should be <module_name>:<manifest_name>")
1679}
1680
1681func (c *deviceConfig) OverrideCertificateFor(name string) (certificatePath string, overridden bool) {
Jaewoong Jungacb6db32019-02-28 16:22:30 +00001682 return findOverrideValue(c.config.productVariables.CertificateOverrides, name,
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001683 "invalid override rule %q in PRODUCT_CERTIFICATE_OVERRIDES should be <module_name>:<certificate_module_name>")
1684}
1685
Jaewoong Jung9d22a912019-01-23 16:27:47 -08001686func (c *deviceConfig) OverridePackageNameFor(name string) string {
1687 newName, overridden := findOverrideValue(
1688 c.config.productVariables.PackageNameOverrides,
1689 name,
1690 "invalid override rule %q in PRODUCT_PACKAGE_NAME_OVERRIDES should be <module_name>:<package_name>")
1691 if overridden {
1692 return newName
1693 }
1694 return name
1695}
1696
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001697func findOverrideValue(overrides []string, name string, errorMsg string) (newValue string, overridden bool) {
Jiyong Park7f67f482019-01-05 12:57:48 +09001698 if overrides == nil || len(overrides) == 0 {
1699 return "", false
1700 }
1701 for _, o := range overrides {
1702 split := strings.Split(o, ":")
1703 if len(split) != 2 {
1704 // This shouldn't happen as this is first checked in make, but just in case.
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001705 panic(fmt.Errorf(errorMsg, o))
Jiyong Park7f67f482019-01-05 12:57:48 +09001706 }
1707 if matchPattern(split[0], name) {
1708 return substPattern(split[0], split[1], name), true
1709 }
1710 }
1711 return "", false
1712}
1713
Albert Martineefabcf2022-03-21 20:11:16 +00001714func (c *deviceConfig) ApexGlobalMinSdkVersionOverride() string {
1715 return String(c.config.productVariables.ApexGlobalMinSdkVersionOverride)
1716}
1717
Ivan Lozano5f595532017-07-13 14:46:05 -07001718func (c *config) IntegerOverflowDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001719 if len(c.productVariables.IntegerOverflowExcludePaths) == 0 {
Ivan Lozano5f595532017-07-13 14:46:05 -07001720 return false
1721 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001722 return HasAnyPrefix(path, c.productVariables.IntegerOverflowExcludePaths)
Ivan Lozano5f595532017-07-13 14:46:05 -07001723}
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001724
1725func (c *config) CFIDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001726 if len(c.productVariables.CFIExcludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001727 return false
1728 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001729 return HasAnyPrefix(path, c.productVariables.CFIExcludePaths)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001730}
1731
1732func (c *config) CFIEnabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001733 if len(c.productVariables.CFIIncludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001734 return false
1735 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001736 return HasAnyPrefix(path, c.productVariables.CFIIncludePaths) && !c.CFIDisabledForPath(path)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001737}
Colin Crosse15ddaf2017-12-04 11:24:31 -08001738
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001739func (c *config) MemtagHeapDisabledForPath(path string) bool {
1740 if len(c.productVariables.MemtagHeapExcludePaths) == 0 {
1741 return false
1742 }
1743 return HasAnyPrefix(path, c.productVariables.MemtagHeapExcludePaths)
1744}
1745
1746func (c *config) MemtagHeapAsyncEnabledForPath(path string) bool {
1747 if len(c.productVariables.MemtagHeapAsyncIncludePaths) == 0 {
1748 return false
1749 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001750 return HasAnyPrefix(path, c.productVariables.MemtagHeapAsyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001751}
1752
1753func (c *config) MemtagHeapSyncEnabledForPath(path string) bool {
1754 if len(c.productVariables.MemtagHeapSyncIncludePaths) == 0 {
1755 return false
1756 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001757 return HasAnyPrefix(path, c.productVariables.MemtagHeapSyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001758}
1759
Tomislav Novakf734f002023-08-22 10:51:44 -07001760func (c *config) HWASanDisabledForPath(path string) bool {
1761 if len(c.productVariables.HWASanExcludePaths) == 0 {
1762 return false
1763 }
1764 return HasAnyPrefix(path, c.productVariables.HWASanExcludePaths)
1765}
1766
Hang Lua98aab92023-03-17 13:17:22 +08001767func (c *config) HWASanEnabledForPath(path string) bool {
1768 if len(c.productVariables.HWASanIncludePaths) == 0 {
1769 return false
1770 }
Tomislav Novakf734f002023-08-22 10:51:44 -07001771 return HasAnyPrefix(path, c.productVariables.HWASanIncludePaths) && !c.HWASanDisabledForPath(path)
Hang Lua98aab92023-03-17 13:17:22 +08001772}
1773
Dan Willemsen0fe78662018-03-26 12:41:18 -07001774func (c *config) VendorConfig(name string) VendorConfig {
Colin Cross9d34f352019-11-22 16:03:51 -08001775 return soongconfig.Config(c.productVariables.VendorVars[name])
Dan Willemsen0fe78662018-03-26 12:41:18 -07001776}
1777
Colin Cross395f2cf2018-10-24 16:10:32 -07001778func (c *config) NdkAbis() bool {
1779 return Bool(c.productVariables.Ndk_abis)
1780}
1781
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001782func (c *config) AmlAbis() bool {
1783 return Bool(c.productVariables.Aml_abis)
1784}
1785
Jiyong Park4da07972021-01-05 21:01:11 +09001786func (c *config) ForceApexSymlinkOptimization() bool {
1787 return Bool(c.productVariables.ForceApexSymlinkOptimization)
1788}
1789
Sasha Smundakfe9a5b82022-07-27 14:51:45 -07001790func (c *config) ApexCompressionEnabled() bool {
1791 return Bool(c.productVariables.CompressedApex) && !c.UnbundledBuildApps()
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +00001792}
1793
Dennis Shene2ed70c2023-01-11 14:15:43 +00001794func (c *config) ApexTrimEnabled() bool {
1795 return Bool(c.productVariables.TrimmedApex)
1796}
1797
Justin Yun2cc42502024-09-11 14:10:20 +09001798func (c *config) UseSoongSystemImage() bool {
1799 return Bool(c.productVariables.UseSoongSystemImage)
1800}
1801
1802func (c *config) SoongDefinedSystemImage() string {
1803 if c.UseSoongSystemImage() {
1804 return String(c.productVariables.ProductSoongDefinedSystemImage)
1805 }
1806 return ""
1807}
1808
Jeongik Chac9464142019-01-07 12:07:27 +09001809func (c *config) EnforceSystemCertificate() bool {
1810 return Bool(c.productVariables.EnforceSystemCertificate)
1811}
1812
Colin Cross440e0d02020-06-11 11:32:11 -07001813func (c *config) EnforceSystemCertificateAllowList() []string {
1814 return c.productVariables.EnforceSystemCertificateAllowList
Jeongik Chac9464142019-01-07 12:07:27 +09001815}
1816
Jeongik Cha2cc570d2019-10-29 15:44:45 +09001817func (c *config) EnforceProductPartitionInterface() bool {
1818 return Bool(c.productVariables.EnforceProductPartitionInterface)
1819}
1820
Colin Crossf24a22a2019-01-31 14:12:44 -08001821func (c *config) ProductHiddenAPIStubs() []string {
1822 return c.productVariables.ProductHiddenAPIStubs
Colin Cross8faf8fc2019-01-16 15:15:52 -08001823}
1824
Colin Crossf24a22a2019-01-31 14:12:44 -08001825func (c *config) ProductHiddenAPIStubsSystem() []string {
1826 return c.productVariables.ProductHiddenAPIStubsSystem
Colin Cross8faf8fc2019-01-16 15:15:52 -08001827}
1828
Colin Crossf24a22a2019-01-31 14:12:44 -08001829func (c *config) ProductHiddenAPIStubsTest() []string {
1830 return c.productVariables.ProductHiddenAPIStubsTest
Colin Cross8faf8fc2019-01-16 15:15:52 -08001831}
Dan Willemsen71c74602019-04-10 12:27:35 -07001832
Dan Willemsen54879d12019-04-18 10:08:46 -07001833func (c *deviceConfig) TargetFSConfigGen() []string {
Dan Willemsen71c74602019-04-10 12:27:35 -07001834 return c.config.productVariables.TargetFSConfigGen
1835}
Inseob Kim0866b002019-04-15 20:21:29 +09001836
1837func (c *config) ProductPublicSepolicyDirs() []string {
1838 return c.productVariables.ProductPublicSepolicyDirs
1839}
1840
1841func (c *config) ProductPrivateSepolicyDirs() []string {
1842 return c.productVariables.ProductPrivateSepolicyDirs
1843}
1844
Inseob Kim5eb7ee92022-04-27 10:30:34 +09001845func (c *config) TargetMultitreeUpdateMeta() bool {
1846 return c.productVariables.MultitreeUpdateMeta
1847}
1848
Inseob Kim1f086e22019-05-09 13:29:15 +09001849func (c *deviceConfig) DeviceArch() string {
1850 return String(c.config.productVariables.DeviceArch)
1851}
1852
1853func (c *deviceConfig) DeviceArchVariant() string {
1854 return String(c.config.productVariables.DeviceArchVariant)
1855}
1856
1857func (c *deviceConfig) DeviceSecondaryArch() string {
1858 return String(c.config.productVariables.DeviceSecondaryArch)
1859}
1860
1861func (c *deviceConfig) DeviceSecondaryArchVariant() string {
1862 return String(c.config.productVariables.DeviceSecondaryArchVariant)
1863}
Yifan Hong82db7352020-01-21 16:12:26 -08001864
1865func (c *deviceConfig) BoardUsesRecoveryAsBoot() bool {
1866 return Bool(c.config.productVariables.BoardUsesRecoveryAsBoot)
1867}
Yifan Hong97365ee2020-07-29 09:51:57 -07001868
1869func (c *deviceConfig) BoardKernelBinaries() []string {
1870 return c.config.productVariables.BoardKernelBinaries
1871}
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001872
Yifan Hong42bef8d2020-08-05 14:36:09 -07001873func (c *deviceConfig) BoardKernelModuleInterfaceVersions() []string {
1874 return c.config.productVariables.BoardKernelModuleInterfaceVersions
1875}
1876
Yifan Hongdd8dacc2020-10-21 15:40:17 -07001877func (c *deviceConfig) BoardMoveRecoveryResourcesToVendorBoot() bool {
1878 return Bool(c.config.productVariables.BoardMoveRecoveryResourcesToVendorBoot)
1879}
1880
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001881func (c *deviceConfig) PlatformSepolicyVersion() string {
1882 return String(c.config.productVariables.PlatformSepolicyVersion)
1883}
1884
Inseob Kim843f6642022-01-07 09:11:23 +09001885func (c *deviceConfig) PlatformSepolicyCompatVersions() []string {
1886 return c.config.productVariables.PlatformSepolicyCompatVersions
1887}
1888
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001889func (c *deviceConfig) BoardSepolicyVers() string {
Inseob Kim0c4eec82021-03-22 22:33:40 +09001890 if ver := String(c.config.productVariables.BoardSepolicyVers); ver != "" {
1891 return ver
1892 }
1893 return c.PlatformSepolicyVersion()
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001894}
1895
Inseob Kim1a0afcc2022-02-14 23:10:51 +09001896func (c *deviceConfig) SystemExtSepolicyPrebuiltApiDir() string {
1897 return String(c.config.productVariables.SystemExtSepolicyPrebuiltApiDir)
1898}
1899
1900func (c *deviceConfig) ProductSepolicyPrebuiltApiDir() string {
1901 return String(c.config.productVariables.ProductSepolicyPrebuiltApiDir)
1902}
1903
1904func (c *deviceConfig) IsPartnerTrebleSepolicyTestEnabled() bool {
1905 return c.SystemExtSepolicyPrebuiltApiDir() != "" || c.ProductSepolicyPrebuiltApiDir() != ""
1906}
1907
Justin DeMartino383bfb32021-02-24 10:49:43 -08001908func createDirsMap(previous map[string]bool, dirs []string) (map[string]bool, error) {
1909 var ret = make(map[string]bool)
1910 for _, dir := range dirs {
1911 clean := filepath.Clean(dir)
1912 if previous[clean] || ret[clean] {
1913 return nil, fmt.Errorf("Duplicate entry %s", dir)
1914 }
1915 ret[clean] = true
1916 }
1917 return ret, nil
1918}
1919
1920func (c *deviceConfig) createDirsMapOnce(onceKey OnceKey, previous map[string]bool, dirs []string) map[string]bool {
1921 dirMap := c.Once(onceKey, func() interface{} {
1922 ret, err := createDirsMap(previous, dirs)
1923 if err != nil {
1924 panic(fmt.Errorf("%s: %w", onceKey.key, err))
1925 }
1926 return ret
1927 })
1928 if dirMap == nil {
1929 return nil
1930 }
1931 return dirMap.(map[string]bool)
1932}
1933
Inseob Kim60c32f02020-12-21 22:53:05 +09001934func (c *deviceConfig) ShippingApiLevel() ApiLevel {
Steven Morelanda48df2b2024-06-03 22:29:38 +00001935 if c.config.productVariables.Shipping_api_level == nil {
Inseob Kim60c32f02020-12-21 22:53:05 +09001936 return NoneApiLevel
1937 }
Steven Morelanda48df2b2024-06-03 22:29:38 +00001938 apiLevel, _ := strconv.Atoi(*c.config.productVariables.Shipping_api_level)
Inseob Kim60c32f02020-12-21 22:53:05 +09001939 return uncheckedFinalApiLevel(apiLevel)
1940}
1941
Liz Kammer33cc80e2023-05-18 18:20:28 +00001942func (c *deviceConfig) BuildBrokenPluginValidation() []string {
1943 return c.config.productVariables.BuildBrokenPluginValidation
1944}
1945
Alix Espinoef47e542022-09-14 19:10:51 +00001946func (c *deviceConfig) BuildBrokenClangAsFlags() bool {
1947 return c.config.productVariables.BuildBrokenClangAsFlags
1948}
1949
1950func (c *deviceConfig) BuildBrokenClangCFlags() bool {
1951 return c.config.productVariables.BuildBrokenClangCFlags
1952}
1953
Alixb5f6d9e2022-04-20 23:00:58 +00001954func (c *deviceConfig) BuildBrokenClangProperty() bool {
1955 return c.config.productVariables.BuildBrokenClangProperty
1956}
1957
Inseob Kim67e5add192021-03-17 18:05:33 +09001958func (c *deviceConfig) BuildBrokenEnforceSyspropOwner() bool {
1959 return c.config.productVariables.BuildBrokenEnforceSyspropOwner
1960}
1961
1962func (c *deviceConfig) BuildBrokenTrebleSyspropNeverallow() bool {
1963 return c.config.productVariables.BuildBrokenTrebleSyspropNeverallow
1964}
1965
Hridya Valsaraju5a5c7d52021-04-02 16:45:24 -07001966func (c *deviceConfig) BuildDebugfsRestrictionsEnabled() bool {
1967 return c.config.productVariables.BuildDebugfsRestrictionsEnabled
1968}
1969
Inseob Kim0cac7b42021-02-03 18:16:46 +09001970func (c *deviceConfig) BuildBrokenVendorPropertyNamespace() bool {
1971 return c.config.productVariables.BuildBrokenVendorPropertyNamespace
1972}
1973
Liz Kammer619be462022-01-28 15:13:39 -05001974func (c *deviceConfig) BuildBrokenInputDir(name string) bool {
1975 return InList(name, c.config.productVariables.BuildBrokenInputDirModules)
1976}
1977
Jiyong Park3bb99242024-01-04 23:21:26 +00001978func (c *deviceConfig) BuildBrokenDontCheckSystemSdk() bool {
1979 return c.config.productVariables.BuildBrokenDontCheckSystemSdk
1980}
1981
Inseob Kim2da72af2024-06-18 11:09:12 +09001982func (c *deviceConfig) BuildBrokenDupSysprop() bool {
1983 return c.config.productVariables.BuildBrokenDupSysprop
1984}
1985
Jiakai Zhang48203e32023-06-02 23:42:21 +01001986func (c *config) BuildWarningBadOptionalUsesLibsAllowlist() []string {
1987 return c.productVariables.BuildWarningBadOptionalUsesLibsAllowlist
1988}
1989
Yu Liu6a7940c2023-05-09 17:12:22 -07001990func (c *deviceConfig) GenruleSandboxing() bool {
1991 return Bool(c.config.productVariables.GenruleSandboxing)
Vinh Tran140d5882022-06-10 14:23:27 -04001992}
1993
Inseob Kim67e5add192021-03-17 18:05:33 +09001994func (c *deviceConfig) RequiresInsecureExecmemForSwiftshader() bool {
1995 return c.config.productVariables.RequiresInsecureExecmemForSwiftshader
1996}
1997
Devin Moorec381e102023-07-06 22:03:58 +00001998func (c *deviceConfig) Release_aidl_use_unfrozen() bool {
1999 return Bool(c.config.productVariables.Release_aidl_use_unfrozen)
2000}
2001
Inseob Kim67e5add192021-03-17 18:05:33 +09002002func (c *config) SelinuxIgnoreNeverallows() bool {
2003 return c.productVariables.SelinuxIgnoreNeverallows
2004}
2005
Inseob Kima10ef272021-09-15 03:04:53 +00002006func (c *deviceConfig) SepolicyFreezeTestExtraDirs() []string {
2007 return c.config.productVariables.SepolicyFreezeTestExtraDirs
2008}
2009
2010func (c *deviceConfig) SepolicyFreezeTestExtraPrebuiltDirs() []string {
2011 return c.config.productVariables.SepolicyFreezeTestExtraPrebuiltDirs
2012}
2013
Jiyong Parkd163d4d2021-10-12 16:47:43 +09002014func (c *deviceConfig) GenerateAidlNdkPlatformBackend() bool {
2015 return c.config.productVariables.GenerateAidlNdkPlatformBackend
2016}
2017
Yu Liu67a28422024-03-05 00:36:31 +00002018func (c *deviceConfig) AconfigContainerValidation() string {
2019 return c.config.productVariables.AconfigContainerValidation
2020}
2021
Christopher Ferris98f10222022-07-13 23:16:52 -07002022func (c *config) IgnorePrefer32OnDevice() bool {
2023 return c.productVariables.IgnorePrefer32OnDevice
2024}
2025
Ulya Trafimovich249386a2020-07-01 14:31:13 +01002026func (c *config) BootJars() []string {
2027 return c.Once(earlyBootJarsKey, func() interface{} {
Paul Duffin69d1fb12020-10-23 21:14:20 +01002028 list := c.productVariables.BootJars.CopyOfJars()
satayevd604b212021-07-21 14:23:52 +01002029 return append(list, c.productVariables.ApexBootJars.CopyOfJars()...)
Ulya Trafimovich249386a2020-07-01 14:31:13 +01002030 }).([]string)
2031}
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002032
satayevd604b212021-07-21 14:23:52 +01002033func (c *config) NonApexBootJars() ConfiguredJarList {
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002034 return c.productVariables.BootJars
2035}
2036
satayevd604b212021-07-21 14:23:52 +01002037func (c *config) ApexBootJars() ConfiguredJarList {
2038 return c.productVariables.ApexBootJars
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002039}
Colin Cross77cdcfd2021-03-12 11:28:25 -08002040
2041func (c *config) RBEWrapper() string {
2042 return c.GetenvWithDefault("RBE_WRAPPER", remoteexec.DefaultWrapperPath)
2043}
Colin Cross9b698b62021-12-22 09:55:32 -08002044
2045// UseHostMusl returns true if the host target has been configured to build against musl libc.
2046func (c *config) UseHostMusl() bool {
2047 return Bool(c.productVariables.HostMusl)
2048}
MarkDacekff851b82022-04-21 18:33:17 +00002049
Spandan Das9e93d3d2023-03-08 05:47:29 +00002050// ApiSurfaces directory returns the source path inside the api_surfaces repo
2051// (relative to workspace root).
2052func (c *config) ApiSurfacesDir(s ApiSurface, version string) string {
2053 return filepath.Join(
2054 "build",
2055 "bazel",
2056 "api_surfaces",
2057 s.String(),
2058 version)
2059}
Jihoon Kang1bff0342023-01-17 20:40:22 +00002060
Jihoon Kang1975d3e2023-10-16 23:24:11 +00002061func (c *config) JavaCoverageEnabled() bool {
2062 return c.IsEnvTrue("EMMA_INSTRUMENT") || c.IsEnvTrue("EMMA_INSTRUMENT_STATIC") || c.IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK")
2063}
2064
Jihoon Kangc1b04d62023-11-16 19:07:04 +00002065func (c *deviceConfig) BuildFromSourceStub() bool {
2066 return Bool(c.config.productVariables.BuildFromSourceStub)
2067}
2068
Jihoon Kang1bff0342023-01-17 20:40:22 +00002069func (c *config) BuildFromTextStub() bool {
Jihoon Kang1975d3e2023-10-16 23:24:11 +00002070 // TODO: b/302320354 - Remove the coverage build specific logic once the
2071 // robust solution for handling native properties in from-text stub build
2072 // is implemented.
Jihoon Kangc1b04d62023-11-16 19:07:04 +00002073 return !c.buildFromSourceStub &&
2074 !c.JavaCoverageEnabled() &&
2075 !c.deviceConfig.BuildFromSourceStub()
Jihoon Kang1bff0342023-01-17 20:40:22 +00002076}
Spandan Das4deab282023-03-30 17:06:32 +00002077
2078func (c *config) SetBuildFromTextStub(b bool) {
Jihoon Kang2a929ad2023-06-08 19:02:07 +00002079 c.buildFromSourceStub = !b
Jihoon Kangcbcad7c2023-06-01 22:31:52 +00002080 c.productVariables.Build_from_text_stub = boolPtr(b)
Spandan Das4deab282023-03-30 17:06:32 +00002081}
Jihoon Kang1c92c3e2023-03-23 17:44:51 +00002082
Inseob Kim5bac3b62023-08-25 21:29:46 +09002083func (c *deviceConfig) CheckVendorSeappViolations() bool {
2084 return Bool(c.config.productVariables.CheckVendorSeappViolations)
2085}
Jihoon Kangcfbc4072023-09-20 01:02:18 +00002086
Inseob Kime4e85d52023-10-25 23:53:58 +09002087func (c *config) GetBuildFlag(name string) (string, bool) {
2088 val, ok := c.productVariables.BuildFlags[name]
2089 return val, ok
2090}
Spandan Dase3fcb412023-10-26 20:48:02 +00002091
Rico Winda7b38592024-08-26 12:10:44 +02002092func (c *config) UseOptimizedResourceShrinkingByDefault() bool {
2093 return c.productVariables.GetBuildFlagBool("RELEASE_USE_OPTIMIZED_RESOURCE_SHRINKING_BY_DEFAULT")
2094}
2095
Colin Cross8f1b0332024-01-25 13:39:06 -08002096func (c *config) UseResourceProcessorByDefault() bool {
2097 return c.productVariables.GetBuildFlagBool("RELEASE_USE_RESOURCE_PROCESSOR_BY_DEFAULT")
2098}
2099
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002100func (c *config) UseTransitiveJarsInClasspath() bool {
2101 return c.productVariables.GetBuildFlagBool("RELEASE_USE_TRANSITIVE_JARS_IN_CLASSPATH")
2102}
2103
Spandan Dase3fcb412023-10-26 20:48:02 +00002104var (
Spandan Das85bd4622024-08-01 00:51:20 +00002105 mainlineApexContributionBuildFlagsToApexNames = map[string]string{
2106 "RELEASE_APEX_CONTRIBUTIONS_ADBD": "com.android.adbd",
2107 "RELEASE_APEX_CONTRIBUTIONS_ADSERVICES": "com.android.adservices",
2108 "RELEASE_APEX_CONTRIBUTIONS_APPSEARCH": "com.android.appsearch",
2109 "RELEASE_APEX_CONTRIBUTIONS_ART": "com.android.art",
2110 "RELEASE_APEX_CONTRIBUTIONS_BLUETOOTH": "com.android.btservices",
2111 "RELEASE_APEX_CONTRIBUTIONS_CAPTIVEPORTALLOGIN": "",
2112 "RELEASE_APEX_CONTRIBUTIONS_CELLBROADCAST": "com.android.cellbroadcast",
2113 "RELEASE_APEX_CONTRIBUTIONS_CONFIGINFRASTRUCTURE": "com.android.configinfrastructure",
2114 "RELEASE_APEX_CONTRIBUTIONS_CONNECTIVITY": "com.android.tethering",
2115 "RELEASE_APEX_CONTRIBUTIONS_CONSCRYPT": "com.android.conscrypt",
2116 "RELEASE_APEX_CONTRIBUTIONS_CRASHRECOVERY": "",
2117 "RELEASE_APEX_CONTRIBUTIONS_DEVICELOCK": "com.android.devicelock",
2118 "RELEASE_APEX_CONTRIBUTIONS_DOCUMENTSUIGOOGLE": "",
2119 "RELEASE_APEX_CONTRIBUTIONS_EXTSERVICES": "com.android.extservices",
2120 "RELEASE_APEX_CONTRIBUTIONS_HEALTHFITNESS": "com.android.healthfitness",
2121 "RELEASE_APEX_CONTRIBUTIONS_IPSEC": "com.android.ipsec",
2122 "RELEASE_APEX_CONTRIBUTIONS_MEDIA": "com.android.media",
2123 "RELEASE_APEX_CONTRIBUTIONS_MEDIAPROVIDER": "com.android.mediaprovider",
2124 "RELEASE_APEX_CONTRIBUTIONS_MODULE_METADATA": "",
2125 "RELEASE_APEX_CONTRIBUTIONS_NETWORKSTACKGOOGLE": "",
2126 "RELEASE_APEX_CONTRIBUTIONS_NEURALNETWORKS": "com.android.neuralnetworks",
2127 "RELEASE_APEX_CONTRIBUTIONS_ONDEVICEPERSONALIZATION": "com.android.ondevicepersonalization",
2128 "RELEASE_APEX_CONTRIBUTIONS_PERMISSION": "com.android.permission",
2129 "RELEASE_APEX_CONTRIBUTIONS_PRIMARY_LIBS": "",
2130 "RELEASE_APEX_CONTRIBUTIONS_REMOTEKEYPROVISIONING": "com.android.rkpd",
2131 "RELEASE_APEX_CONTRIBUTIONS_RESOLV": "com.android.resolv",
2132 "RELEASE_APEX_CONTRIBUTIONS_SCHEDULING": "com.android.scheduling",
2133 "RELEASE_APEX_CONTRIBUTIONS_SDKEXTENSIONS": "com.android.sdkext",
2134 "RELEASE_APEX_CONTRIBUTIONS_SWCODEC": "com.android.media.swcodec",
2135 "RELEASE_APEX_CONTRIBUTIONS_STATSD": "com.android.os.statsd",
2136 "RELEASE_APEX_CONTRIBUTIONS_TELEMETRY_TVP": "",
2137 "RELEASE_APEX_CONTRIBUTIONS_TZDATA": "com.android.tzdata",
2138 "RELEASE_APEX_CONTRIBUTIONS_UWB": "com.android.uwb",
2139 "RELEASE_APEX_CONTRIBUTIONS_WIFI": "com.android.wifi",
Spandan Dase3fcb412023-10-26 20:48:02 +00002140 }
2141)
2142
2143// Returns the list of _selected_ apex_contributions
2144// Each mainline module will have one entry in the list
2145func (c *config) AllApexContributions() []string {
2146 ret := []string{}
Spandan Das85bd4622024-08-01 00:51:20 +00002147 for _, f := range SortedKeys(mainlineApexContributionBuildFlagsToApexNames) {
Spandan Dase3fcb412023-10-26 20:48:02 +00002148 if val, exists := c.GetBuildFlag(f); exists && val != "" {
2149 ret = append(ret, val)
2150 }
2151 }
2152 return ret
2153}
Spandan Das8ab28dd2024-02-17 03:31:45 +00002154
Spandan Das85bd4622024-08-01 00:51:20 +00002155func (c *config) AllMainlineApexNames() []string {
2156 return SortedStringValues(mainlineApexContributionBuildFlagsToApexNames)
2157}
2158
Spandan Das0d24ade2024-03-08 04:20:15 +00002159func (c *config) BuildIgnoreApexContributionContents() *bool {
Spandan Das8ab28dd2024-02-17 03:31:45 +00002160 return c.productVariables.BuildIgnoreApexContributionContents
2161}
Inseob Kim8fa54da2024-03-19 16:48:59 +09002162
2163func (c *config) ProductLocales() []string {
2164 return c.productVariables.ProductLocales
2165}
2166
2167func (c *config) ProductDefaultWifiChannels() []string {
2168 return c.productVariables.ProductDefaultWifiChannels
2169}
2170
2171func (c *config) BoardUseVbmetaDigestInFingerprint() bool {
2172 return Bool(c.productVariables.BoardUseVbmetaDigestInFingerprint)
2173}
2174
2175func (c *config) OemProperties() []string {
2176 return c.productVariables.OemProperties
2177}
Kiyoung Kim881e4652024-07-08 11:02:23 +09002178
2179func (c *config) UseDebugArt() bool {
2180 if c.productVariables.ArtTargetIncludeDebugBuild != nil {
2181 return Bool(c.productVariables.ArtTargetIncludeDebugBuild)
2182 }
2183
2184 return Bool(c.productVariables.Eng)
2185}
Inseob Kimd8538e52024-07-31 02:00:41 +00002186
2187func (c *config) SystemPropFiles(ctx PathContext) Paths {
2188 return PathsForSource(ctx, c.productVariables.SystemPropFiles)
2189}
Inseob Kim6bd92d52024-07-31 02:01:03 +00002190
Inseob Kimacf91742024-08-05 12:51:05 +09002191func (c *config) SystemExtPropFiles(ctx PathContext) Paths {
2192 return PathsForSource(ctx, c.productVariables.SystemExtPropFiles)
2193}
2194
Inseob Kim01d4f8b2024-08-08 17:47:14 +09002195func (c *config) ProductPropFiles(ctx PathContext) Paths {
2196 return PathsForSource(ctx, c.productVariables.ProductPropFiles)
2197}
2198
Inseob Kim9a22c7e2024-08-26 15:58:09 +09002199func (c *config) OdmPropFiles(ctx PathContext) Paths {
2200 return PathsForSource(ctx, c.productVariables.OdmPropFiles)
2201}
2202
Spandan Das859cdef2024-10-25 21:06:18 +00002203func (c *config) VendorPropFiles(ctx PathContext) Paths {
2204 return PathsForSource(ctx, c.productVariables.VendorPropFiles)
2205}
2206
Nouby Mohamed8609a552024-09-04 22:19:51 +00002207func (c *config) ExtraAllowedDepsTxt() string {
2208 return String(c.productVariables.ExtraAllowedDepsTxt)
2209}
2210
Inseob Kim6bd92d52024-07-31 02:01:03 +00002211func (c *config) EnableUffdGc() string {
2212 return String(c.productVariables.EnableUffdGc)
2213}
Bill Yang3b3aac02024-09-05 09:22:09 +00002214
2215func (c *config) DeviceFrameworkCompatibilityMatrixFile() []string {
2216 return c.productVariables.DeviceFrameworkCompatibilityMatrixFile
2217}
2218
2219func (c *config) DeviceProductCompatibilityMatrixFile() []string {
2220 return c.productVariables.DeviceProductCompatibilityMatrixFile
2221}
2222
2223func (c *config) BoardAvbEnable() bool {
2224 return Bool(c.productVariables.BoardAvbEnable)
2225}
2226
2227func (c *config) BoardAvbSystemAddHashtreeFooterArgs() []string {
2228 return c.productVariables.BoardAvbSystemAddHashtreeFooterArgs
2229}
Spandan Das950deca2024-10-01 18:35:23 +00002230
2231// Returns true if RELEASE_INSTALL_APEX_SYSTEMSERVER_DEXPREOPT_SAME_PARTITION is set to true.
2232// If true, dexpreopt files of apex system server jars will be installed in the same partition as the parent apex.
2233// If false, all these files will be installed in /system partition.
2234func (c Config) InstallApexSystemServerDexpreoptSamePartition() bool {
2235 return c.config.productVariables.GetBuildFlagBool("RELEASE_INSTALL_APEX_SYSTEMSERVER_DEXPREOPT_SAME_PARTITION")
2236}