blob: cb604a6540e962d7e8ea6e04456072b130dba75a [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
Jared Dukeeacbdfc2024-11-13 00:43:59 +0000288func (c Config) ReleaseUseSystemFeatureBuildFlags() bool {
289 return c.config.productVariables.GetBuildFlagBool("RELEASE_USE_SYSTEM_FEATURE_BUILD_FLAGS")
290}
291
Jingwen Chenc711fec2020-11-22 23:52:50 -0500292// A DeviceConfig object represents the configuration for a particular device
293// being built. For now there will only be one of these, but in the future there
294// may be multiple devices being built.
Colin Cross9272ade2016-08-17 15:24:12 -0700295type DeviceConfig struct {
296 *deviceConfig
297}
298
Jingwen Chenc711fec2020-11-22 23:52:50 -0500299// VendorConfig represents the configuration for vendor-specific behavior.
Colin Cross9d34f352019-11-22 16:03:51 -0800300type VendorConfig soongconfig.SoongConfig
Dan Willemsen0fe78662018-03-26 12:41:18 -0700301
Jingwen Chenc711fec2020-11-22 23:52:50 -0500302// Definition of general build configuration for soong_build. Some of these
Jingwen Chenc4d91bc2020-11-24 22:59:26 -0500303// product configuration values are read from Kati-generated soong.variables.
Colin Cross1332b002015-04-07 17:11:30 -0700304type config struct {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500305 // Options configurable with soong.variables
Cole Faustf8231dd2023-04-21 17:37:11 -0700306 productVariables ProductVariables
Colin Cross3f40fa42015-01-30 17:27:36 -0800307
Dan Willemsen674dc7f2018-03-12 18:06:05 -0700308 // Only available on configs created by TestConfig
Cole Faustf8231dd2023-04-21 17:37:11 -0700309 TestProductVariables *ProductVariables
Dan Willemsen674dc7f2018-03-12 18:06:05 -0700310
Dan Willemsen87b17d12015-07-14 00:39:06 -0700311 ProductVariablesFileName string
312
Colin Cross0c66bc62021-07-20 09:47:41 -0700313 // BuildOS stores the OsType for the OS that the build is running on.
314 BuildOS OsType
315
316 // BuildArch stores the ArchType for the CPU that the build is running on.
317 BuildArch ArchType
318
Jaewoong Jung642916f2020-10-09 17:25:15 -0700319 Targets map[OsType][]Target
320 BuildOSTarget Target // the Target for tools run on the build machine
321 BuildOSCommonTarget Target // the Target for common (java) tools run on the build machine
322 AndroidCommonTarget Target // the Target for common modules for the Android device
323 AndroidFirstDeviceTarget Target // the first Target for modules for the Android device
Dan Willemsen218f6562015-07-08 18:13:11 -0700324
LaMont Jones99f18962024-10-17 11:50:44 -0700325 // Flags for Partial Compile, derived from SOONG_PARTIAL_COMPILE.
326 partialCompileFlags partialCompileFlags
327
Jingwen Chenc711fec2020-11-22 23:52:50 -0500328 // multilibConflicts for an ArchType is true if there is earlier configured
329 // device architecture with the same multilib value.
Colin Cross3b19f5d2019-09-17 14:45:31 -0700330 multilibConflicts map[ArchType]bool
331
Colin Cross9272ade2016-08-17 15:24:12 -0700332 deviceConfig *deviceConfig
333
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200334 outDir string // The output directory (usually out/)
335 soongOutDir string
Chris Parsons8f232a22020-06-23 17:37:05 -0400336 moduleListFile string // the path to the file which lists blueprint files to parse.
Colin Crossc1e86a32015-04-15 12:33:28 -0700337
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +0200338 runGoTests bool
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200339
Colin Cross6ccbc912017-10-10 23:07:38 -0700340 env map[string]string
Dan Willemsene7680ba2015-09-11 17:06:19 -0700341 envLock sync.Mutex
342 envDeps map[string]string
343 envFrozen bool
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800344
Jingwen Chencda22c92020-11-23 00:22:30 -0500345 // Changes behavior based on whether Kati runs after soong_build, or if soong_build
346 // runs standalone.
347 katiEnabled bool
Colin Cross1e7d3702016-08-24 15:25:47 -0700348
Colin Cross32616ed2017-09-05 21:56:44 -0700349 captureBuild bool // true for tests, saves build parameters for each module
350 ignoreEnvironment bool // true for tests, returns empty from all Getenv calls
Colin Crosscec81712017-07-13 14:43:27 -0700351
Colin Cross98be1bb2019-12-13 20:41:13 -0800352 fs pathtools.FileSystem
353 mockBpList string
354
Colin Crossb63d7b32023-12-07 16:54:51 -0800355 BuildMode SoongBuildMode
Jingwen Chen12b4c272021-03-10 02:05:59 -0500356
Colin Cross5e6a7972020-06-07 16:56:32 -0700357 // If testAllowNonExistentPaths is true then PathForSource and PathForModuleSrc won't error
358 // in tests when a path doesn't exist.
Pedro Loureiro5d190cc2021-02-15 15:41:33 +0000359 TestAllowNonExistentPaths bool
Colin Cross5e6a7972020-06-07 16:56:32 -0700360
Jingwen Chenc711fec2020-11-22 23:52:50 -0500361 // The list of files that when changed, must invalidate soong_build to
362 // regenerate build.ninja.
Colin Cross12129292020-10-29 18:23:58 -0700363 ninjaFileDepsSet sync.Map
364
Colin Cross9272ade2016-08-17 15:24:12 -0700365 OncePer
MarkDacekff851b82022-04-21 18:33:17 +0000366
Jihoon Kang2a929ad2023-06-08 19:02:07 +0000367 // If buildFromSourceStub is true then the Java API stubs are
368 // built from the source Java files, not the signature text files.
369 buildFromSourceStub bool
MarkDacekf47e1422023-04-19 16:47:36 +0000370
371 // If ensureAllowlistIntegrity is true, then the presence of any allowlisted
372 // modules that aren't mixed-built for at least one variant will cause a build
373 // failure
374 ensureAllowlistIntegrity bool
Colin Cross9272ade2016-08-17 15:24:12 -0700375}
376
LaMont Jones99f18962024-10-17 11:50:44 -0700377type partialCompileFlags struct {
378 // Is partial compilation enabled at all?
379 enabled bool
380
381 // Whether to use d8 instead of r8
382 use_d8 bool
383
384 // Add others as needed.
385}
386
Colin Cross9272ade2016-08-17 15:24:12 -0700387type deviceConfig struct {
Dan Willemsen00269f22017-07-06 16:59:48 -0700388 config *config
Colin Cross9272ade2016-08-17 15:24:12 -0700389 OncePer
Colin Cross3f40fa42015-01-30 17:27:36 -0800390}
391
Colin Cross485e5722015-08-27 13:28:01 -0700392type jsonConfigurable interface {
Colin Cross27385972015-09-18 10:57:10 -0700393 SetDefaultConfig()
Colin Cross485e5722015-08-27 13:28:01 -0700394}
Colin Cross3f40fa42015-01-30 17:27:36 -0800395
LaMont Jones99f18962024-10-17 11:50:44 -0700396// Parse SOONG_PARTIAL_COMPILE.
397//
398// SOONG_PARTIAL_COMPILE determines which features are enabled or disabled in
399// rule generation. Changing this environment variable causes reanalysis.
400//
401// SOONG_USE_PARTIAL_COMPILE determines whether or not we **use** PARTIAL_COMPILE.
402// Rule generation must support both cases, since changing it does not cause
403// reanalysis.
404//
405// The user-facing documentation shows:
406//
407// - empty or not set: "The current default state"
408// - "true" or "on": enable all stable partial compile features.
409// - "false" or "off": disable partial compile completely.
410//
411// What we actually allow is a comma separated list of tokens, whose first
412// character may be "+" (enable) or "-" (disable). If neither is present, "+"
413// is assumed. For example, "on,+use_d8" will enable partial compilation, and
414// additionally set the use_d8 flag (regardless of whether it is opt-in or
415// opt-out).
416//
417// To add a new feature to the list, add the field in the struct
418// `partialCompileFlags` above, and then add the name of the field in the
419// switch statement below.
LaMont Jones66e65862024-10-30 10:43:17 -0700420var defaultPartialCompileFlags = partialCompileFlags{
421 // Set any opt-out flags here. Opt-in flags are off by default.
422 enabled: false,
423}
424
425func (c *config) parsePartialCompileFlags(isEngBuild bool) (partialCompileFlags, error) {
426 if !isEngBuild {
427 return partialCompileFlags{}, nil
LaMont Jonesbef36af2024-10-30 01:03:28 +0000428 }
LaMont Jones99f18962024-10-17 11:50:44 -0700429 value := c.Getenv("SOONG_PARTIAL_COMPILE")
LaMont Jones99f18962024-10-17 11:50:44 -0700430 if value == "" {
LaMont Jones66e65862024-10-30 10:43:17 -0700431 return defaultPartialCompileFlags, nil
LaMont Jones99f18962024-10-17 11:50:44 -0700432 }
433
LaMont Jones66e65862024-10-30 10:43:17 -0700434 ret := defaultPartialCompileFlags
LaMont Jones99f18962024-10-17 11:50:44 -0700435 tokens := strings.Split(strings.ToLower(value), ",")
436 makeVal := func(state string, defaultValue bool) bool {
437 switch state {
438 case "":
439 return defaultValue
440 case "-":
441 return false
442 case "+":
443 return true
444 }
445 return false
446 }
447 for _, tok := range tokens {
448 var state string
449 if len(tok) == 0 {
450 continue
451 }
452 switch tok[0:1] {
453 case "":
454 // Ignore empty tokens.
455 continue
456 case "-", "+":
457 state = tok[0:1]
458 tok = tok[1:]
459 default:
460 // Treat `feature` as `+feature`.
461 state = "+"
462 }
463 switch tok {
464 case "true":
LaMont Jones66e65862024-10-30 10:43:17 -0700465 ret = defaultPartialCompileFlags
LaMont Jones99f18962024-10-17 11:50:44 -0700466 ret.enabled = true
467 case "false":
468 // Set everything to false.
469 ret = partialCompileFlags{}
470 case "enabled":
LaMont Jones66e65862024-10-30 10:43:17 -0700471 ret.enabled = makeVal(state, defaultPartialCompileFlags.enabled)
LaMont Jones99f18962024-10-17 11:50:44 -0700472 case "use_d8":
LaMont Jones66e65862024-10-30 10:43:17 -0700473 ret.use_d8 = makeVal(state, defaultPartialCompileFlags.use_d8)
LaMont Jones99f18962024-10-17 11:50:44 -0700474 default:
LaMont Jones66e65862024-10-30 10:43:17 -0700475 return partialCompileFlags{}, fmt.Errorf("Unknown SOONG_PARTIAL_COMPILE value: %v", tok)
LaMont Jones99f18962024-10-17 11:50:44 -0700476 }
477 }
478 return ret, nil
479}
480
Colin Cross485e5722015-08-27 13:28:01 -0700481func loadConfig(config *config) error {
Colin Cross988414c2020-01-11 01:11:46 +0000482 return loadFromConfigFile(&config.productVariables, absolutePath(config.ProductVariablesFileName))
Colin Cross485e5722015-08-27 13:28:01 -0700483}
484
Cole Faustd92430e2024-02-07 01:02:04 +0000485// Checks if the string is a valid go identifier. This is equivalent to blueprint's definition
486// of an identifier, so it will match the same identifiers as those that can be used in bp files.
487func isGoIdentifier(ident string) bool {
488 for i, r := range ident {
489 valid := r == '_' || unicode.IsLetter(r) || unicode.IsDigit(r) && i > 0
490 if !valid {
491 return false
492 }
493 }
494 return len(ident) > 0
495}
496
Jingwen Chenc711fec2020-11-22 23:52:50 -0500497// loadFromConfigFile loads and decodes configuration options from a JSON file
498// in the current working directory.
Cole Faustf8231dd2023-04-21 17:37:11 -0700499func loadFromConfigFile(configurable *ProductVariables, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800500 // Try to open the file
Colin Cross485e5722015-08-27 13:28:01 -0700501 configFileReader, err := os.Open(filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800502 defer configFileReader.Close()
503 if os.IsNotExist(err) {
504 // Need to create a file, so that blueprint & ninja don't get in
505 // a dependency tracking loop.
506 // Make a file-configurable-options with defaults, write it out using
507 // a json writer.
Colin Cross27385972015-09-18 10:57:10 -0700508 configurable.SetDefaultConfig()
509 err = saveToConfigFile(configurable, filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800510 if err != nil {
511 return err
512 }
Colin Cross15cd21a2018-02-27 11:26:02 -0800513 } else if err != nil {
514 return fmt.Errorf("config file: could not open %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800515 } else {
516 // Make a decoder for it
517 jsonDecoder := json.NewDecoder(configFileReader)
Cole Fauste1129b82024-06-04 11:10:11 -0700518 jsonDecoder.DisallowUnknownFields()
Colin Cross485e5722015-08-27 13:28:01 -0700519 err = jsonDecoder.Decode(configurable)
Colin Cross3f40fa42015-01-30 17:27:36 -0800520 if err != nil {
Colin Cross15cd21a2018-02-27 11:26:02 -0800521 return fmt.Errorf("config file: %s did not parse correctly: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800522 }
523 }
524
Liz Kammer09f947d2021-05-12 14:51:49 -0400525 if Bool(configurable.GcovCoverage) && Bool(configurable.ClangCoverage) {
526 return fmt.Errorf("GcovCoverage and ClangCoverage cannot both be set")
527 }
528
529 configurable.Native_coverage = proptools.BoolPtr(
530 Bool(configurable.GcovCoverage) ||
531 Bool(configurable.ClangCoverage))
532
Cole Faustd92430e2024-02-07 01:02:04 +0000533 // The go scanner's definition of identifiers is c-style identifiers, but allowing unicode's
534 // definition of letters and digits. This is the same scanner that blueprint uses, so it
535 // will allow the same identifiers as are valid in bp files.
536 for namespace := range configurable.VendorVars {
537 if !isGoIdentifier(namespace) {
538 return fmt.Errorf("soong config namespaces must be valid identifiers: %q", namespace)
539 }
540 for variable := range configurable.VendorVars[namespace] {
541 if !isGoIdentifier(variable) {
542 return fmt.Errorf("soong config variables must be valid identifiers: %q", variable)
543 }
544 }
545 }
546
Yuntao Xu402e9b02021-08-09 15:44:44 -0700547 // when Platform_sdk_final is true (or PLATFORM_VERSION_CODENAME is REL), use Platform_sdk_version;
548 // if false (pre-released version, for example), use Platform_sdk_codename.
549 if Bool(configurable.Platform_sdk_final) {
550 if configurable.Platform_sdk_version != nil {
551 configurable.Platform_sdk_version_or_codename =
552 proptools.StringPtr(strconv.Itoa(*(configurable.Platform_sdk_version)))
553 } else {
554 return fmt.Errorf("Platform_sdk_version cannot be pointed by a NULL pointer")
555 }
556 } else {
557 configurable.Platform_sdk_version_or_codename =
558 proptools.StringPtr(String(configurable.Platform_sdk_codename))
559 }
560
Cole Faustad186492024-06-14 14:13:54 -0700561 return nil
Colin Cross3f40fa42015-01-30 17:27:36 -0800562}
563
Colin Crossd8f20142016-11-03 09:43:26 -0700564// atomically writes the config file in case two copies of soong_build are running simultaneously
565// (for example, docs generation and ninja manifest generation)
Cole Faustf8231dd2023-04-21 17:37:11 -0700566func saveToConfigFile(config *ProductVariables, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800567 data, err := json.MarshalIndent(&config, "", " ")
568 if err != nil {
569 return fmt.Errorf("cannot marshal config data: %s", err.Error())
570 }
571
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800572 f, err := os.CreateTemp(filepath.Dir(filename), "config")
Colin Cross3f40fa42015-01-30 17:27:36 -0800573 if err != nil {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500574 return fmt.Errorf("cannot create empty config file %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800575 }
Colin Crossd8f20142016-11-03 09:43:26 -0700576 defer os.Remove(f.Name())
577 defer f.Close()
Colin Cross3f40fa42015-01-30 17:27:36 -0800578
Colin Crossd8f20142016-11-03 09:43:26 -0700579 _, err = f.Write(data)
Colin Cross3f40fa42015-01-30 17:27:36 -0800580 if err != nil {
Colin Cross485e5722015-08-27 13:28:01 -0700581 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
582 }
583
Colin Crossd8f20142016-11-03 09:43:26 -0700584 _, err = f.WriteString("\n")
Colin Cross485e5722015-08-27 13:28:01 -0700585 if err != nil {
586 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800587 }
588
Colin Crossd8f20142016-11-03 09:43:26 -0700589 f.Close()
590 os.Rename(f.Name(), filename)
591
Colin Cross3f40fa42015-01-30 17:27:36 -0800592 return nil
593}
594
Colin Cross988414c2020-01-11 01:11:46 +0000595// NullConfig returns a mostly empty Config for use by standalone tools like dexpreopt_gen that
596// use the android package.
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200597func NullConfig(outDir, soongOutDir string) Config {
Colin Cross988414c2020-01-11 01:11:46 +0000598 return Config{
599 config: &config{
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200600 outDir: outDir,
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200601 soongOutDir: soongOutDir,
602 fs: pathtools.OsFs,
Colin Cross988414c2020-01-11 01:11:46 +0000603 },
604 }
605}
606
Jingwen Chenc711fec2020-11-22 23:52:50 -0500607// NewConfig creates a new Config object. The srcDir argument specifies the path
608// to the root source directory. It also loads the config file, if found.
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800609func NewConfig(cmdArgs CmdArgs, availableEnv map[string]string) (Config, error) {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500610 // Make a config with default options.
Colin Cross9272ade2016-08-17 15:24:12 -0700611 config := &config{
Kiyoung Kima37d9ba2023-04-19 13:13:45 +0900612 ProductVariablesFileName: cmdArgs.SoongVariables,
Dan Willemsen87b17d12015-07-14 00:39:06 -0700613
Lukacs T. Berki53b2f362021-04-12 14:04:24 +0200614 env: availableEnv,
Colin Cross6ccbc912017-10-10 23:07:38 -0700615
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800616 outDir: cmdArgs.OutDir,
617 soongOutDir: cmdArgs.SoongOutDir,
618 runGoTests: cmdArgs.RunGoTests,
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +0200619 multilibConflicts: make(map[ArchType]bool),
Colin Cross98be1bb2019-12-13 20:41:13 -0800620
Colin Crossb63d7b32023-12-07 16:54:51 -0800621 moduleListFile: cmdArgs.ModuleListFile,
622 fs: pathtools.NewOsFs(absSrcDir),
Chris Parsons9402ca82023-02-23 17:28:06 -0500623
Jihoon Kang2a929ad2023-06-08 19:02:07 +0000624 buildFromSourceStub: cmdArgs.BuildFromSourceStub,
Colin Cross68f55102015-03-25 14:43:57 -0700625 }
LaMont Jones66e65862024-10-30 10:43:17 -0700626 variant, ok := os.LookupEnv("TARGET_BUILD_VARIANT")
627 isEngBuild := !ok || variant == "eng"
Colin Cross3f40fa42015-01-30 17:27:36 -0800628
Dan Willemsen00269f22017-07-06 16:59:48 -0700629 config.deviceConfig = &deviceConfig{
Colin Cross9272ade2016-08-17 15:24:12 -0700630 config: config,
631 }
632
Liz Kammer7941b302020-07-28 13:27:34 -0700633 // Soundness check of the build and source directories. This won't catch strange
634 // configurations with symlinks, but at least checks the obvious case.
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800635 absBuildDir, err := filepath.Abs(cmdArgs.SoongOutDir)
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700636 if err != nil {
637 return Config{}, err
638 }
639
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200640 absSrcDir, err := filepath.Abs(".")
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700641 if err != nil {
642 return Config{}, err
643 }
644
645 if strings.HasPrefix(absSrcDir, absBuildDir) {
646 return Config{}, fmt.Errorf("Build dir must not contain source directory")
647 }
648
Colin Cross3f40fa42015-01-30 17:27:36 -0800649 // Load any configurable options from the configuration file
Colin Cross9272ade2016-08-17 15:24:12 -0700650 err = loadConfig(config)
Colin Cross3f40fa42015-01-30 17:27:36 -0800651 if err != nil {
Colin Crossc3c0a492015-04-10 15:43:55 -0700652 return Config{}, err
Colin Cross3f40fa42015-01-30 17:27:36 -0800653 }
654
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800655 KatiEnabledMarkerFile := filepath.Join(cmdArgs.SoongOutDir, ".soong.kati_enabled")
Jingwen Chencda22c92020-11-23 00:22:30 -0500656 if _, err := os.Stat(absolutePath(KatiEnabledMarkerFile)); err == nil {
657 config.katiEnabled = true
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800658 }
659
Colin Cross0c66bc62021-07-20 09:47:41 -0700660 determineBuildOS(config)
661
Jingwen Chenc711fec2020-11-22 23:52:50 -0500662 // Sets up the map of target OSes to the finer grained compilation targets
663 // that are configured from the product variables.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700664 targets, err := decodeTargetProductVariables(config)
Dan Willemsen218f6562015-07-08 18:13:11 -0700665 if err != nil {
666 return Config{}, err
667 }
668
LaMont Jones66e65862024-10-30 10:43:17 -0700669 config.partialCompileFlags, err = config.parsePartialCompileFlags(isEngBuild)
LaMont Jones99f18962024-10-17 11:50:44 -0700670 if err != nil {
671 return Config{}, err
672 }
673
Paul Duffin1356d8c2020-02-25 19:26:33 +0000674 // Make the CommonOS OsType available for all products.
675 targets[CommonOS] = []Target{commonTargetMap[CommonOS.Name]}
676
Dan Albert4098deb2016-10-19 14:04:41 -0700677 var archConfig []archConfig
Jingwen Chenc4d91bc2020-11-24 22:59:26 -0500678 if config.NdkAbis() {
Dan Albert4098deb2016-10-19 14:04:41 -0700679 archConfig = getNdkAbisConfig()
Martin Stjernholmc1ecc432019-11-15 15:00:31 +0000680 } else if config.AmlAbis() {
681 archConfig = getAmlAbisConfig()
Dan Albert4098deb2016-10-19 14:04:41 -0700682 }
683
684 if archConfig != nil {
Liz Kammerb7f33662022-02-28 14:16:16 -0500685 androidTargets, err := decodeAndroidArchSettings(archConfig)
Dan Willemsen322acaf2016-01-12 23:07:05 -0800686 if err != nil {
687 return Config{}, err
688 }
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700689 targets[Android] = androidTargets
Dan Willemsen322acaf2016-01-12 23:07:05 -0800690 }
691
Colin Cross3b19f5d2019-09-17 14:45:31 -0700692 multilib := make(map[string]bool)
693 for _, target := range targets[Android] {
694 if seen := multilib[target.Arch.ArchType.Multilib]; seen {
695 config.multilibConflicts[target.Arch.ArchType] = true
696 }
697 multilib[target.Arch.ArchType.Multilib] = true
698 }
699
Jingwen Chenc711fec2020-11-22 23:52:50 -0500700 // Map of OS to compilation targets.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700701 config.Targets = targets
Jingwen Chenc711fec2020-11-22 23:52:50 -0500702
703 // Compilation targets for host tools.
Colin Cross0c66bc62021-07-20 09:47:41 -0700704 config.BuildOSTarget = config.Targets[config.BuildOS][0]
705 config.BuildOSCommonTarget = getCommonTargets(config.Targets[config.BuildOS])[0]
Jingwen Chenc711fec2020-11-22 23:52:50 -0500706
707 // Compilation targets for Android.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700708 if len(config.Targets[Android]) > 0 {
709 config.AndroidCommonTarget = getCommonTargets(config.Targets[Android])[0]
Sam Delmericocc271e22022-06-01 15:45:02 +0000710 config.AndroidFirstDeviceTarget = FirstTarget(config.Targets[Android], "lib64", "lib32")[0]
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700711 }
Dan Willemsen218f6562015-07-08 18:13:11 -0700712
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500713 setBuildMode := func(arg string, mode SoongBuildMode) {
714 if arg != "" {
715 if config.BuildMode != AnalysisNoBazel {
716 fmt.Fprintf(os.Stderr, "buildMode is already set, illegal argument: %s", arg)
717 os.Exit(1)
718 }
719 config.BuildMode = mode
720 }
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800721 }
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500722 setBuildMode(cmdArgs.ModuleGraphFile, GenerateModuleGraph)
723 setBuildMode(cmdArgs.DocFile, GenerateDocFile)
MarkDacekd06db5d2022-11-29 00:47:59 +0000724
Jihoon Kangc1b04d62023-11-16 19:07:04 +0000725 config.productVariables.Build_from_text_stub = boolPtr(config.BuildFromTextStub())
726
Jingwen Chenc711fec2020-11-22 23:52:50 -0500727 return Config{config}, err
728}
Colin Cross988414c2020-01-11 01:11:46 +0000729
Colin Cross98be1bb2019-12-13 20:41:13 -0800730// mockFileSystem replaces all reads with accesses to the provided map of
731// filenames to contents stored as a byte slice.
732func (c *config) mockFileSystem(bp string, fs map[string][]byte) {
733 mockFS := map[string][]byte{}
734
735 if _, exists := mockFS["Android.bp"]; !exists {
736 mockFS["Android.bp"] = []byte(bp)
737 }
738
739 for k, v := range fs {
740 mockFS[k] = v
741 }
742
743 // no module list file specified; find every file named Blueprints or Android.bp
744 pathsToParse := []string{}
745 for candidate := range mockFS {
746 base := filepath.Base(candidate)
Lukacs T. Berkib838b0a2021-09-02 11:46:24 +0200747 if base == "Android.bp" {
Colin Cross98be1bb2019-12-13 20:41:13 -0800748 pathsToParse = append(pathsToParse, candidate)
749 }
750 }
751 if len(pathsToParse) < 1 {
752 panic(fmt.Sprintf("No Blueprint or Android.bp files found in mock filesystem: %v\n", mockFS))
753 }
754 mockFS[blueprint.MockModuleListFile] = []byte(strings.Join(pathsToParse, "\n"))
755
756 c.fs = pathtools.MockFs(mockFS)
757 c.mockBpList = blueprint.MockModuleListFile
758}
759
Lukacs T. Berkid1e3f1f2021-03-16 08:55:23 +0100760func (c *config) SetAllowMissingDependencies() {
761 c.productVariables.Allow_missing_dependencies = proptools.BoolPtr(true)
762}
763
Jingwen Chenc711fec2020-11-22 23:52:50 -0500764// BlueprintToolLocation returns the directory containing build system tools
765// from Blueprint, like soong_zip and merge_zips.
Lukacs T. Berkia806e412021-09-01 08:57:48 +0200766func (c *config) HostToolDir() string {
Colin Crossacfcc1f2021-10-25 15:40:32 -0700767 if c.KatiEnabled() {
768 return filepath.Join(c.outDir, "host", c.PrebuiltOS(), "bin")
769 } else {
770 return filepath.Join(c.soongOutDir, "host", c.PrebuiltOS(), "bin")
771 }
Dan Willemsenc2aa4a92016-05-26 15:13:03 -0700772}
773
Dan Willemsen60e62f02018-11-16 21:05:32 -0800774func (c *config) HostToolPath(ctx PathContext, tool string) Path {
Cole Faust3b703f32023-10-16 13:30:51 -0700775 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "bin", tool)
Colin Cross790ef352021-10-25 19:15:55 -0700776 return path
Dan Willemsen60e62f02018-11-16 21:05:32 -0800777}
778
Colin Cross790ef352021-10-25 19:15:55 -0700779func (c *config) HostJNIToolPath(ctx PathContext, lib string) Path {
Martin Stjernholm7260d062019-12-09 21:47:14 +0000780 ext := ".so"
781 if runtime.GOOS == "darwin" {
782 ext = ".dylib"
783 }
Cole Faust3b703f32023-10-16 13:30:51 -0700784 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "lib64", lib+ext)
Colin Cross790ef352021-10-25 19:15:55 -0700785 return path
Martin Stjernholm7260d062019-12-09 21:47:14 +0000786}
787
Colin Crossae5330a2021-11-03 13:31:22 -0700788func (c *config) HostJavaToolPath(ctx PathContext, tool string) Path {
Cole Faust3b703f32023-10-16 13:30:51 -0700789 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "framework", tool)
Colin Cross3e3eda62021-11-04 10:22:51 -0700790 return path
791}
792
Vinh Tran09581952023-05-16 16:03:20 -0400793func (c *config) HostCcSharedLibPath(ctx PathContext, lib string) Path {
794 libDir := "lib"
795 if ctx.Config().BuildArch.Multilib == "lib64" {
796 libDir = "lib64"
797 }
Cole Faust3b703f32023-10-16 13:30:51 -0700798 return pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, libDir, lib+".so")
Vinh Tran09581952023-05-16 16:03:20 -0400799}
800
Jingwen Chenc711fec2020-11-22 23:52:50 -0500801// PrebuiltOS returns the name of the host OS used in prebuilts directories.
Colin Cross1332b002015-04-07 17:11:30 -0700802func (c *config) PrebuiltOS() string {
Colin Cross3f40fa42015-01-30 17:27:36 -0800803 switch runtime.GOOS {
804 case "linux":
805 return "linux-x86"
806 case "darwin":
807 return "darwin-x86"
808 default:
809 panic("Unknown GOOS")
810 }
811}
812
813// GoRoot returns the path to the root directory of the Go toolchain.
Colin Cross1332b002015-04-07 17:11:30 -0700814func (c *config) GoRoot() string {
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200815 return fmt.Sprintf("prebuilts/go/%s", c.PrebuiltOS())
Colin Cross3f40fa42015-01-30 17:27:36 -0800816}
817
Jingwen Chenc711fec2020-11-22 23:52:50 -0500818// PrebuiltBuildTool returns the path to a tool in the prebuilts directory containing
819// checked-in tools, like Kati, Ninja or Toybox, for the current host OS.
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700820func (c *config) PrebuiltBuildTool(ctx PathContext, tool string) Path {
821 return PathForSource(ctx, "prebuilts/build-tools", c.PrebuiltOS(), "bin", tool)
822}
823
Jingwen Chenc711fec2020-11-22 23:52:50 -0500824// CpPreserveSymlinksFlags returns the host-specific flag for the cp(1) command
825// to preserve symlinks.
Colin Cross1332b002015-04-07 17:11:30 -0700826func (c *config) CpPreserveSymlinksFlags() string {
Colin Cross485e5722015-08-27 13:28:01 -0700827 switch runtime.GOOS {
Colin Cross3f40fa42015-01-30 17:27:36 -0800828 case "darwin":
829 return "-R"
830 case "linux":
831 return "-d"
832 default:
833 return ""
834 }
835}
Colin Cross68f55102015-03-25 14:43:57 -0700836
Colin Cross1332b002015-04-07 17:11:30 -0700837func (c *config) Getenv(key string) string {
Colin Cross68f55102015-03-25 14:43:57 -0700838 var val string
839 var exists bool
Colin Crossc1e86a32015-04-15 12:33:28 -0700840 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800841 defer c.envLock.Unlock()
842 if c.envDeps == nil {
843 c.envDeps = make(map[string]string)
844 }
Colin Cross68f55102015-03-25 14:43:57 -0700845 if val, exists = c.envDeps[key]; !exists {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700846 if c.envFrozen {
847 panic("Cannot access new environment variables after envdeps are frozen")
848 }
Colin Cross6ccbc912017-10-10 23:07:38 -0700849 val, _ = c.env[key]
Colin Cross68f55102015-03-25 14:43:57 -0700850 c.envDeps[key] = val
851 }
852 return val
853}
854
Colin Cross99d7c232016-11-23 16:52:04 -0800855func (c *config) GetenvWithDefault(key string, defaultValue string) string {
856 ret := c.Getenv(key)
857 if ret == "" {
858 return defaultValue
859 }
860 return ret
861}
862
863func (c *config) IsEnvTrue(key string) bool {
AdityaK19384102024-05-01 13:51:25 -0700864 value := strings.ToLower(c.Getenv(key))
Colin Cross99d7c232016-11-23 16:52:04 -0800865 return value == "1" || value == "y" || value == "yes" || value == "on" || value == "true"
866}
867
868func (c *config) IsEnvFalse(key string) bool {
AdityaK19384102024-05-01 13:51:25 -0700869 value := strings.ToLower(c.Getenv(key))
Colin Cross99d7c232016-11-23 16:52:04 -0800870 return value == "0" || value == "n" || value == "no" || value == "off" || value == "false"
871}
872
Sorin Basca253f8c02024-05-23 10:28:24 +0100873func (c *config) TargetsJava21() bool {
Sorin Basca37cc2712024-10-16 10:25:36 +0100874 return c.productVariables.GetBuildFlagBool("RELEASE_TARGET_JAVA_21")
Sorin Basca253f8c02024-05-23 10:28:24 +0100875}
876
Jingwen Chenc711fec2020-11-22 23:52:50 -0500877// EnvDeps returns the environment variables this build depends on. The first
878// call to this function blocks future reads from the environment.
Colin Cross1332b002015-04-07 17:11:30 -0700879func (c *config) EnvDeps() map[string]string {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700880 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800881 defer c.envLock.Unlock()
Dan Willemsene7680ba2015-09-11 17:06:19 -0700882 c.envFrozen = true
Colin Cross68f55102015-03-25 14:43:57 -0700883 return c.envDeps
884}
Colin Cross35cec122015-04-02 14:37:16 -0700885
Jingwen Chencda22c92020-11-23 00:22:30 -0500886func (c *config) KatiEnabled() bool {
887 return c.katiEnabled
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800888}
889
Cole Faust11edf552023-10-13 11:32:14 -0700890func (c *config) ProductVariables() ProductVariables {
891 return c.productVariables
892}
893
Nan Zhang581fd212018-01-10 16:06:12 -0800894func (c *config) BuildId() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800895 return String(c.productVariables.BuildId)
Nan Zhang581fd212018-01-10 16:06:12 -0800896}
897
Inseob Kim8fa54da2024-03-19 16:48:59 +0900898func (c *config) DisplayBuildNumber() bool {
899 return Bool(c.productVariables.DisplayBuildNumber)
900}
901
Inseob Kim2da72af2024-06-18 11:09:12 +0900902// BuildFingerprintFile returns the path to a text file containing metadata
903// representing the current build's fingerprint.
904//
905// Rules that want to reference the build fingerprint should read from this file
906// without depending on it. They will run whenever their other dependencies
907// require them to run and get the current build fingerprint. This ensures they
908// don't rebuild on every incremental build when the build number changes.
909func (c *config) BuildFingerprintFile(ctx PathContext) Path {
910 return PathForArbitraryOutput(ctx, "target", "product", c.DeviceName(), String(c.productVariables.BuildFingerprintFile))
911}
912
Jingwen Chenc711fec2020-11-22 23:52:50 -0500913// BuildNumberFile returns the path to a text file containing metadata
914// representing the current build's number.
915//
916// Rules that want to reference the build number should read from this file
917// without depending on it. They will run whenever their other dependencies
918// require them to run and get the current build number. This ensures they don't
919// rebuild on every incremental build when the build number changes.
Colin Cross2a2e0db2020-02-21 16:55:46 -0800920func (c *config) BuildNumberFile(ctx PathContext) Path {
921 return PathForOutput(ctx, String(c.productVariables.BuildNumberFile))
Nan Zhang581fd212018-01-10 16:06:12 -0800922}
923
Inseob Kim8fa54da2024-03-19 16:48:59 +0900924// BuildHostnameFile returns the path to a text file containing metadata
925// representing the current build's host name.
926func (c *config) BuildHostnameFile(ctx PathContext) Path {
927 return PathForOutput(ctx, String(c.productVariables.BuildHostnameFile))
928}
929
930// BuildThumbprintFile returns the path to a text file containing metadata
931// representing the current build's thumbprint.
932//
933// Rules that want to reference the build thumbprint should read from this file
934// without depending on it. They will run whenever their other dependencies
935// require them to run and get the current build thumbprint. This ensures they
936// don't rebuild on every incremental build when the build thumbprint changes.
937func (c *config) BuildThumbprintFile(ctx PathContext) Path {
938 return PathForArbitraryOutput(ctx, "target", "product", c.DeviceName(), String(c.productVariables.BuildThumbprintFile))
939}
940
Jingwen Chenc711fec2020-11-22 23:52:50 -0500941// DeviceName returns the name of the current device target.
Colin Cross35cec122015-04-02 14:37:16 -0700942// TODO: take an AndroidModuleContext to select the device name for multi-device builds
Colin Cross1332b002015-04-07 17:11:30 -0700943func (c *config) DeviceName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800944 return *c.productVariables.DeviceName
Colin Cross35cec122015-04-02 14:37:16 -0700945}
946
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000947// DeviceProduct returns the current product target. There could be multiple of
948// these per device type.
949//
Chris Parsonsef615e52022-08-18 22:04:11 -0400950// NOTE: Do not base conditional logic on this value. It may break product inheritance.
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000951func (c *config) DeviceProduct() string {
952 return *c.productVariables.DeviceProduct
953}
954
Cole Faustb85d1a12022-11-08 18:14:01 -0800955// HasDeviceProduct returns if the build has a product. A build will not
956// necessarily have a product when --skip-config is passed to soong, like it is
957// in prebuilts/build-tools/build-prebuilts.sh
958func (c *config) HasDeviceProduct() bool {
959 return c.productVariables.DeviceProduct != nil
960}
961
Inseob Kim8fa54da2024-03-19 16:48:59 +0900962func (c *config) DeviceAbi() []string {
963 return c.productVariables.DeviceAbi
964}
965
Anton Hansson53c88442019-03-18 15:53:16 +0000966func (c *config) DeviceResourceOverlays() []string {
967 return c.productVariables.DeviceResourceOverlays
968}
969
970func (c *config) ProductResourceOverlays() []string {
971 return c.productVariables.ProductResourceOverlays
Colin Cross30e076a2015-04-13 13:58:27 -0700972}
973
Inseob Kim8fa54da2024-03-19 16:48:59 +0900974func (c *config) PlatformDisplayVersionName() string {
975 return String(c.productVariables.Platform_display_version_name)
976}
977
Colin Crossbfd347d2018-05-09 11:11:35 -0700978func (c *config) PlatformVersionName() string {
979 return String(c.productVariables.Platform_version_name)
980}
981
Dan Albert4f378d72020-07-23 17:32:15 -0700982func (c *config) PlatformSdkVersion() ApiLevel {
983 return uncheckedFinalApiLevel(*c.productVariables.Platform_sdk_version)
Colin Cross30e076a2015-04-13 13:58:27 -0700984}
985
Cole Faust37d27c42023-04-12 10:27:45 -0700986func (c *config) RawPlatformSdkVersion() *int {
987 return c.productVariables.Platform_sdk_version
988}
989
Mu-Le Lee5e047532022-07-27 02:32:03 +0000990func (c *config) PlatformSdkFinal() bool {
991 return Bool(c.productVariables.Platform_sdk_final)
992}
993
Colin Crossd09b0b62018-04-18 11:06:47 -0700994func (c *config) PlatformSdkCodename() string {
995 return String(c.productVariables.Platform_sdk_codename)
996}
997
Anton Hansson97d0bae2022-02-16 16:15:10 +0000998func (c *config) PlatformSdkExtensionVersion() int {
999 return *c.productVariables.Platform_sdk_extension_version
1000}
1001
1002func (c *config) PlatformBaseSdkExtensionVersion() int {
1003 return *c.productVariables.Platform_base_sdk_extension_version
1004}
1005
Colin Cross092c9da2019-04-02 22:56:43 -07001006func (c *config) PlatformSecurityPatch() string {
1007 return String(c.productVariables.Platform_security_patch)
1008}
1009
1010func (c *config) PlatformPreviewSdkVersion() string {
1011 return String(c.productVariables.Platform_preview_sdk_version)
1012}
1013
1014func (c *config) PlatformMinSupportedTargetSdkVersion() string {
Linus Tufvessonba270c52024-04-12 13:06:22 +02001015 var val, ok = c.productVariables.BuildFlags["RELEASE_PLATFORM_MIN_SUPPORTED_TARGET_SDK_VERSION"]
1016 if !ok {
1017 return ""
1018 }
1019 return val
Colin Cross092c9da2019-04-02 22:56:43 -07001020}
1021
1022func (c *config) PlatformBaseOS() string {
1023 return String(c.productVariables.Platform_base_os)
1024}
1025
Inseob Kim4f1f3d92022-04-25 18:23:58 +09001026func (c *config) PlatformVersionLastStable() string {
1027 return String(c.productVariables.Platform_version_last_stable)
1028}
1029
Jiyong Park37073842022-06-21 10:13:42 +09001030func (c *config) PlatformVersionKnownCodenames() string {
1031 return String(c.productVariables.Platform_version_known_codenames)
1032}
1033
Dan Albert1a246272020-07-06 14:49:35 -07001034func (c *config) MinSupportedSdkVersion() ApiLevel {
Dan Albert6bfb6bb2022-08-17 20:11:57 +00001035 return uncheckedFinalApiLevel(21)
Dan Albert1a246272020-07-06 14:49:35 -07001036}
1037
1038func (c *config) FinalApiLevels() []ApiLevel {
1039 var levels []ApiLevel
Dan Albert4f378d72020-07-23 17:32:15 -07001040 for i := 1; i <= c.PlatformSdkVersion().FinalOrFutureInt(); i++ {
Dan Albert1a246272020-07-06 14:49:35 -07001041 levels = append(levels, uncheckedFinalApiLevel(i))
1042 }
1043 return levels
1044}
1045
1046func (c *config) PreviewApiLevels() []ApiLevel {
1047 var levels []ApiLevel
Dan Albertf93ea132023-10-05 20:40:46 +00001048 i := 0
1049 for _, codename := range c.PlatformVersionActiveCodenames() {
1050 if codename == "REL" {
1051 continue
1052 }
1053
Dan Albert1a246272020-07-06 14:49:35 -07001054 levels = append(levels, ApiLevel{
1055 value: codename,
1056 number: i,
1057 isPreview: true,
1058 })
Dan Albertf93ea132023-10-05 20:40:46 +00001059 i++
Dan Albert1a246272020-07-06 14:49:35 -07001060 }
1061 return levels
1062}
1063
satayevcca4ab72021-11-30 12:33:55 +00001064func (c *config) LatestPreviewApiLevel() ApiLevel {
1065 level := NoneApiLevel
1066 for _, l := range c.PreviewApiLevels() {
1067 if l.GreaterThan(level) {
1068 level = l
1069 }
1070 }
1071 return level
1072}
1073
Dan Albert1a246272020-07-06 14:49:35 -07001074func (c *config) AllSupportedApiLevels() []ApiLevel {
1075 var levels []ApiLevel
1076 levels = append(levels, c.FinalApiLevels()...)
1077 return append(levels, c.PreviewApiLevels()...)
Dan Albertf5415d72017-08-17 16:19:59 -07001078}
1079
Jingwen Chenc711fec2020-11-22 23:52:50 -05001080// DefaultAppTargetSdk returns the API level that platform apps are targeting.
1081// This converts a codename to the exact ApiLevel it represents.
Dan Albert4f378d72020-07-23 17:32:15 -07001082func (c *config) DefaultAppTargetSdk(ctx EarlyModuleContext) ApiLevel {
Colin Crossd09b0b62018-04-18 11:06:47 -07001083 if Bool(c.productVariables.Platform_sdk_final) {
1084 return c.PlatformSdkVersion()
Colin Crossd09b0b62018-04-18 11:06:47 -07001085 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001086 codename := c.PlatformSdkCodename()
Jiyong Park3a00e3d2023-03-27 17:39:48 +09001087 hostOnlyBuild := c.productVariables.DeviceArch == nil
Jingwen Chenc711fec2020-11-22 23:52:50 -05001088 if codename == "" {
Jiyong Park3a00e3d2023-03-27 17:39:48 +09001089 // There are some host-only builds (those are invoked by build-prebuilts.sh) which
1090 // don't set platform sdk codename. Platform sdk codename makes sense only when we
1091 // are building the platform. So we don't enforce the below panic for the host-only
1092 // builds.
1093 if hostOnlyBuild {
1094 return NoneApiLevel
1095 }
1096 panic("Platform_sdk_codename must be set")
Jingwen Chenc711fec2020-11-22 23:52:50 -05001097 }
1098 if codename == "REL" {
1099 panic("Platform_sdk_codename should not be REL when Platform_sdk_final is true")
1100 }
1101 return ApiLevelOrPanic(ctx, codename)
Colin Crossd09b0b62018-04-18 11:06:47 -07001102}
1103
LaMont Jones99f18962024-10-17 11:50:44 -07001104func (c *config) PartialCompileFlags() partialCompileFlags {
1105 return c.partialCompileFlags
1106}
1107
Colin Cross3bc7ffa2017-11-22 16:19:37 -08001108func (c *config) AppsDefaultVersionName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001109 return String(c.productVariables.AppsDefaultVersionName)
Colin Cross3bc7ffa2017-11-22 16:19:37 -08001110}
1111
Dan Albert31384de2017-07-28 12:39:46 -07001112// Codenames that are active in the current lunch target.
1113func (c *config) PlatformVersionActiveCodenames() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001114 return c.productVariables.Platform_version_active_codenames
Dan Albert31384de2017-07-28 12:39:46 -07001115}
1116
Dan Albert8c7a9942023-03-27 20:34:01 +00001117// All unreleased codenames.
1118func (c *config) PlatformVersionAllPreviewCodenames() []string {
1119 return c.productVariables.Platform_version_all_preview_codenames
1120}
1121
Colin Crossface4e42017-10-30 17:32:15 -07001122func (c *config) ProductAAPTConfig() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001123 return c.productVariables.AAPTConfig
Colin Cross30e076a2015-04-13 13:58:27 -07001124}
1125
Colin Crossface4e42017-10-30 17:32:15 -07001126func (c *config) ProductAAPTPreferredConfig() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001127 return String(c.productVariables.AAPTPreferredConfig)
Colin Cross30e076a2015-04-13 13:58:27 -07001128}
1129
Colin Crossface4e42017-10-30 17:32:15 -07001130func (c *config) ProductAAPTCharacteristics() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001131 return String(c.productVariables.AAPTCharacteristics)
Colin Crossface4e42017-10-30 17:32:15 -07001132}
1133
1134func (c *config) ProductAAPTPrebuiltDPI() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001135 return c.productVariables.AAPTPrebuiltDPI
Colin Cross30e076a2015-04-13 13:58:27 -07001136}
1137
Dan Willemsen34cc69e2015-09-23 15:26:20 -07001138func (c *config) DefaultAppCertificateDir(ctx PathContext) SourcePath {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001139 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -08001140 if defaultCert != "" {
1141 return PathForSource(ctx, filepath.Dir(defaultCert))
Colin Cross61ae0b72017-12-01 17:16:02 -08001142 }
Inseob Kim8fa54da2024-03-19 16:48:59 +09001143 return PathForSource(ctx, testKeyDir)
Colin Cross30e076a2015-04-13 13:58:27 -07001144}
1145
Colin Crosse1731a52017-12-14 11:22:55 -08001146func (c *config) DefaultAppCertificate(ctx PathContext) (pem, key SourcePath) {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001147 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -08001148 if defaultCert != "" {
Colin Crosse1731a52017-12-14 11:22:55 -08001149 return PathForSource(ctx, defaultCert+".x509.pem"), PathForSource(ctx, defaultCert+".pk8")
Colin Cross61ae0b72017-12-01 17:16:02 -08001150 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001151 defaultDir := c.DefaultAppCertificateDir(ctx)
1152 return defaultDir.Join(ctx, "testkey.x509.pem"), defaultDir.Join(ctx, "testkey.pk8")
Colin Cross30e076a2015-04-13 13:58:27 -07001153}
Colin Cross6ff51382015-12-17 16:39:19 -08001154
Justin Yun635e7882024-07-04 14:50:57 +09001155func (c *config) ExtraOtaKeys(ctx PathContext, recovery bool) []SourcePath {
1156 var otaKeys []string
1157 if recovery {
1158 otaKeys = c.productVariables.ExtraOtaRecoveryKeys
1159 } else {
1160 otaKeys = c.productVariables.ExtraOtaKeys
1161 }
1162
1163 otaPaths := make([]SourcePath, len(otaKeys))
1164 for i, key := range otaKeys {
1165 otaPaths[i] = PathForSource(ctx, key+".x509.pem")
1166 }
1167
1168 return otaPaths
1169}
1170
Inseob Kim8fa54da2024-03-19 16:48:59 +09001171func (c *config) BuildKeys() string {
1172 defaultCert := String(c.productVariables.DefaultAppCertificate)
1173 if defaultCert == "" || defaultCert == filepath.Join(testKeyDir, "testkey") {
1174 return "test-keys"
1175 }
1176 return "dev-keys"
1177}
1178
Jiyong Park9335a262018-12-24 11:31:58 +09001179func (c *config) ApexKeyDir(ctx ModuleContext) SourcePath {
1180 // TODO(b/121224311): define another variable such as TARGET_APEX_KEY_OVERRIDE
1181 defaultCert := String(c.productVariables.DefaultAppCertificate)
Inseob Kim8fa54da2024-03-19 16:48:59 +09001182 if defaultCert == "" || filepath.Dir(defaultCert) == testKeyDir {
Jiyong Park9335a262018-12-24 11:31:58 +09001183 // When defaultCert is unset or is set to the testkeys path, use the APEX keys
1184 // that is under the module dir
Colin Cross07e51612019-03-05 12:46:40 -08001185 return pathForModuleSrc(ctx)
Jiyong Park9335a262018-12-24 11:31:58 +09001186 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001187 // If not, APEX keys are under the specified directory
1188 return PathForSource(ctx, filepath.Dir(defaultCert))
Jiyong Park9335a262018-12-24 11:31:58 +09001189}
1190
Inseob Kim80fa7982022-08-12 21:36:25 +09001191// Certificate for the NetworkStack sepolicy context
1192func (c *config) MainlineSepolicyDevCertificatesDir(ctx ModuleContext) SourcePath {
1193 cert := String(c.productVariables.MainlineSepolicyDevCertificates)
1194 if cert != "" {
1195 return PathForSource(ctx, cert)
1196 }
1197 return c.DefaultAppCertificateDir(ctx)
1198}
1199
Jingwen Chenc711fec2020-11-22 23:52:50 -05001200// AllowMissingDependencies configures Blueprint/Soong to not fail when modules
1201// are configured to depend on non-existent modules. Note that this does not
1202// affect missing input dependencies at the Ninja level.
Colin Cross6ff51382015-12-17 16:39:19 -08001203func (c *config) AllowMissingDependencies() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001204 return Bool(c.productVariables.Allow_missing_dependencies)
Colin Cross6ff51382015-12-17 16:39:19 -08001205}
Dan Willemsen322acaf2016-01-12 23:07:05 -08001206
Jeongik Cha816a23a2020-07-08 01:09:23 +09001207// Returns true if a full platform source tree cannot be assumed.
Colin Crossfc3674a2017-09-18 17:41:52 -07001208func (c *config) UnbundledBuild() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001209 return Bool(c.productVariables.Unbundled_build)
Colin Crossfc3674a2017-09-18 17:41:52 -07001210}
1211
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +01001212// Returns true if building apps that aren't bundled with the platform.
1213// UnbundledBuild() is always true when this is true.
1214func (c *config) UnbundledBuildApps() bool {
Cole Faust701ca252021-11-23 19:02:08 -08001215 return len(c.productVariables.Unbundled_build_apps) > 0
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +01001216}
1217
Jeongik Cha4b073cd2021-06-08 11:35:00 +09001218// Returns true if building image that aren't bundled with the platform.
1219// UnbundledBuild() is always true when this is true.
1220func (c *config) UnbundledBuildImage() bool {
1221 return Bool(c.productVariables.Unbundled_build_image)
1222}
1223
Jeongik Cha816a23a2020-07-08 01:09:23 +09001224// Returns true if building modules against prebuilt SDKs.
1225func (c *config) AlwaysUsePrebuiltSdks() bool {
1226 return Bool(c.productVariables.Always_use_prebuilt_sdks)
Colin Cross1f367bf2018-12-18 22:46:24 -08001227}
1228
Colin Cross126a25c2017-10-31 13:55:34 -07001229func (c *config) MinimizeJavaDebugInfo() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001230 return Bool(c.productVariables.MinimizeJavaDebugInfo) && !Bool(c.productVariables.Eng)
Colin Cross126a25c2017-10-31 13:55:34 -07001231}
1232
Colin Crossed064c02018-09-05 16:28:13 -07001233func (c *config) Debuggable() bool {
1234 return Bool(c.productVariables.Debuggable)
1235}
1236
Jaewoong Jung1d6eb682018-11-29 15:08:44 -08001237func (c *config) Eng() bool {
1238 return Bool(c.productVariables.Eng)
1239}
1240
Inseob Kim8fa54da2024-03-19 16:48:59 +09001241func (c *config) BuildType() string {
1242 return String(c.productVariables.BuildType)
1243}
1244
Colin Crossc53c37f2021-12-08 15:42:22 -08001245// DevicePrimaryArchType returns the ArchType for the first configured device architecture, or
1246// Common if there are no device architectures.
Jiyong Park8d52f862018-07-07 18:02:07 +09001247func (c *config) DevicePrimaryArchType() ArchType {
Colin Crossc53c37f2021-12-08 15:42:22 -08001248 if androidTargets := c.Targets[Android]; len(androidTargets) > 0 {
1249 return androidTargets[0].Arch.ArchType
1250 }
1251 return Common
Jiyong Park8d52f862018-07-07 18:02:07 +09001252}
1253
Colin Cross16b23492016-01-06 14:41:07 -08001254func (c *config) SanitizeHost() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001255 return append([]string(nil), c.productVariables.SanitizeHost...)
Colin Cross16b23492016-01-06 14:41:07 -08001256}
1257
1258func (c *config) SanitizeDevice() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001259 return append([]string(nil), c.productVariables.SanitizeDevice...)
Colin Cross23ae82a2016-11-02 14:34:39 -07001260}
1261
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -07001262func (c *config) SanitizeDeviceDiag() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001263 return append([]string(nil), c.productVariables.SanitizeDeviceDiag...)
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -07001264}
1265
Colin Cross23ae82a2016-11-02 14:34:39 -07001266func (c *config) SanitizeDeviceArch() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001267 return append([]string(nil), c.productVariables.SanitizeDeviceArch...)
Colin Cross16b23492016-01-06 14:41:07 -08001268}
Colin Crossa1ad8d12016-06-01 17:09:44 -07001269
Vishwath Mohan1b017a72017-01-19 13:54:55 -08001270func (c *config) EnableCFI() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001271 if c.productVariables.EnableCFI == nil {
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -08001272 return true
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -08001273 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001274 return *c.productVariables.EnableCFI
Vishwath Mohan1b017a72017-01-19 13:54:55 -08001275}
1276
Kostya Kortchinskyd5275c82019-02-01 08:42:56 -08001277func (c *config) DisableScudo() bool {
1278 return Bool(c.productVariables.DisableScudo)
1279}
1280
Colin Crossa1ad8d12016-06-01 17:09:44 -07001281func (c *config) Android64() bool {
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001282 for _, t := range c.Targets[Android] {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001283 if t.Arch.ArchType.Multilib == "lib64" {
1284 return true
1285 }
1286 }
1287
1288 return false
1289}
Colin Cross9272ade2016-08-17 15:24:12 -07001290
Colin Cross9d45bb72016-08-29 16:14:13 -07001291func (c *config) UseGoma() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001292 return Bool(c.productVariables.UseGoma)
Colin Cross9d45bb72016-08-29 16:14:13 -07001293}
1294
Taylor Santiago3c16e612024-05-30 14:41:31 -07001295func (c *config) UseABFS() bool {
1296 return Bool(c.productVariables.UseABFS)
1297}
1298
Ramy Medhatbbf25672019-07-17 12:30:04 +00001299func (c *config) UseRBE() bool {
1300 return Bool(c.productVariables.UseRBE)
1301}
1302
Ramy Medhat8ea054a2020-01-27 14:19:44 -05001303func (c *config) UseRBEJAVAC() bool {
1304 return Bool(c.productVariables.UseRBEJAVAC)
1305}
1306
1307func (c *config) UseRBER8() bool {
1308 return Bool(c.productVariables.UseRBER8)
1309}
1310
1311func (c *config) UseRBED8() bool {
1312 return Bool(c.productVariables.UseRBED8)
1313}
1314
Colin Cross8b8bec32019-11-15 13:18:43 -08001315func (c *config) UseRemoteBuild() bool {
1316 return c.UseGoma() || c.UseRBE()
1317}
1318
Colin Cross66548102018-06-19 22:47:35 -07001319func (c *config) RunErrorProne() bool {
1320 return c.IsEnvTrue("RUN_ERROR_PRONE")
1321}
1322
Jingwen Chenc711fec2020-11-22 23:52:50 -05001323// XrefCorpusName returns the Kythe cross-reference corpus name.
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001324func (c *config) XrefCorpusName() string {
1325 return c.Getenv("XREF_CORPUS")
1326}
1327
Jingwen Chenc711fec2020-11-22 23:52:50 -05001328// XrefCuEncoding returns the compilation unit encoding to use for Kythe code
1329// xrefs. Can be 'json' (default), 'proto' or 'all'.
Sasha Smundak6c2d4f92020-01-09 17:34:23 -08001330func (c *config) XrefCuEncoding() string {
1331 if enc := c.Getenv("KYTHE_KZIP_ENCODING"); enc != "" {
1332 return enc
1333 }
1334 return "json"
1335}
1336
Sasha Smundakb0addaf2021-02-16 10:39:40 -08001337// XrefCuJavaSourceMax returns the maximum number of the Java source files
1338// in a single compilation unit
1339const xrefJavaSourceFileMaxDefault = "1000"
1340
1341func (c Config) XrefCuJavaSourceMax() string {
1342 v := c.Getenv("KYTHE_JAVA_SOURCE_BATCH_SIZE")
1343 if v == "" {
1344 return xrefJavaSourceFileMaxDefault
1345 }
1346 if _, err := strconv.ParseUint(v, 0, 0); err != nil {
1347 fmt.Fprintf(os.Stderr,
1348 "bad KYTHE_JAVA_SOURCE_BATCH_SIZE value: %s, will use %s",
1349 err, xrefJavaSourceFileMaxDefault)
1350 return xrefJavaSourceFileMaxDefault
1351 }
1352 return v
1353
1354}
1355
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001356func (c *config) EmitXrefRules() bool {
1357 return c.XrefCorpusName() != ""
1358}
1359
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001360func (c *config) ClangTidy() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001361 return Bool(c.productVariables.ClangTidy)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001362}
1363
1364func (c *config) TidyChecks() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001365 if c.productVariables.TidyChecks == nil {
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001366 return ""
1367 }
Dan Willemsen45133ac2018-03-09 21:22:06 -08001368 return *c.productVariables.TidyChecks
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001369}
1370
Colin Cross0f4e0d62016-07-27 10:56:55 -07001371func (c *config) LibartImgHostBaseAddress() string {
David Srbeckya4f336b2024-09-04 16:06:56 +01001372 return "0x70000000"
Colin Cross0f4e0d62016-07-27 10:56:55 -07001373}
1374
1375func (c *config) LibartImgDeviceBaseAddress() string {
Elliott Hughesda3a0712020-03-06 16:55:28 -08001376 return "0x70000000"
Colin Cross0f4e0d62016-07-27 10:56:55 -07001377}
1378
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001379func (c *config) ArtUseReadBarrier() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001380 return Bool(c.productVariables.ArtUseReadBarrier)
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001381}
1382
Jingwen Chenc711fec2020-11-22 23:52:50 -05001383// Enforce Runtime Resource Overlays for a module. RROs supersede static RROs,
1384// but some modules still depend on it.
1385//
1386// More info: https://source.android.com/devices/architecture/rros
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001387func (c *config) EnforceRROForModule(name string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001388 enforceList := c.productVariables.EnforceRROTargets
Jeongik Chacee5ba92021-02-19 12:11:51 +09001389
Roland Levillainf6cc2612020-07-09 16:58:14 +01001390 if len(enforceList) > 0 {
Yo Chiang4ebd06a2019-10-01 13:13:41 +08001391 if InList("*", enforceList) {
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001392 return true
1393 }
Colin Crossa74ca042019-01-31 14:31:51 -08001394 return InList(name, enforceList)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001395 }
1396 return false
1397}
Colin Crossc4441622024-09-18 14:55:49 -07001398
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001399func (c *config) EnforceRROExcludedOverlay(path string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001400 excluded := c.productVariables.EnforceRROExcludedOverlays
Roland Levillainf6cc2612020-07-09 16:58:14 +01001401 if len(excluded) > 0 {
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001402 return HasAnyPrefix(path, excluded)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001403 }
1404 return false
1405}
1406
Colin Crossc4441622024-09-18 14:55:49 -07001407func (c *config) EnforceRROGlobally() bool {
1408 enforceList := c.productVariables.EnforceRROTargets
1409 return InList("*", enforceList)
1410}
1411
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001412func (c *config) ExportedNamespaces() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001413 return append([]string(nil), c.productVariables.NamespacesToExport...)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001414}
1415
Sam Delmerico98a73292023-02-21 11:50:29 -05001416func (c *config) SourceRootDirs() []string {
1417 return c.productVariables.SourceRootDirs
1418}
1419
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001420func (c *config) HostStaticBinaries() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001421 return Bool(c.productVariables.HostStaticBinaries)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001422}
1423
Colin Cross5a0dcd52018-10-05 14:20:06 -07001424func (c *config) UncompressPrivAppDex() bool {
1425 return Bool(c.productVariables.UncompressPrivAppDex)
1426}
1427
1428func (c *config) ModulesLoadedByPrivilegedModules() []string {
1429 return c.productVariables.ModulesLoadedByPrivilegedModules
1430}
1431
Jingwen Chenc711fec2020-11-22 23:52:50 -05001432// DexpreoptGlobalConfigPath returns the path to the dexpreopt.config file in
1433// the output directory, if it was created during the product configuration
1434// phase by Kati.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001435func (c *config) DexpreoptGlobalConfigPath(ctx PathContext) OptionalPath {
Colin Cross988414c2020-01-11 01:11:46 +00001436 if c.productVariables.DexpreoptGlobalConfig == nil {
Jingwen Chenebb0b572020-11-02 00:24:57 -05001437 return OptionalPathForPath(nil)
1438 }
1439 return OptionalPathForPath(
1440 pathForBuildToolDep(ctx, *c.productVariables.DexpreoptGlobalConfig))
1441}
1442
Jingwen Chenc711fec2020-11-22 23:52:50 -05001443// DexpreoptGlobalConfig returns the raw byte contents of the dexpreopt global
1444// configuration. Since the configuration file was created by Kati during
1445// product configuration (externally of soong_build), it's not tracked, so we
1446// also manually add a Ninja file dependency on the configuration file to the
1447// rule that creates the main build.ninja file. This ensures that build.ninja is
1448// regenerated correctly if dexpreopt.config changes.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001449func (c *config) DexpreoptGlobalConfig(ctx PathContext) ([]byte, error) {
1450 path := c.DexpreoptGlobalConfigPath(ctx)
1451 if !path.Valid() {
Colin Cross988414c2020-01-11 01:11:46 +00001452 return nil, nil
1453 }
Jingwen Chenebb0b572020-11-02 00:24:57 -05001454 ctx.AddNinjaFileDeps(path.String())
Sasha Smundakaf5ca922022-12-12 21:23:34 -08001455 return os.ReadFile(absolutePath(path.String()))
Colin Cross43f08db2018-11-12 10:13:39 -08001456}
1457
Inseob Kim7b85eeb2021-03-23 20:52:24 +09001458func (c *deviceConfig) WithDexpreopt() bool {
1459 return c.config.productVariables.WithDexpreopt
1460}
1461
Colin Cross662d6142022-11-03 20:38:01 -07001462func (c *config) FrameworksBaseDirExists(ctx PathGlobContext) bool {
Colin Cross5a756a62021-03-16 16:34:46 -07001463 return ExistentPathForSource(ctx, "frameworks", "base", "Android.bp").Valid()
David Brazdil91b4e3e2019-01-23 21:04:05 +00001464}
1465
Colin Cross3b19f5d2019-09-17 14:45:31 -07001466func (c *config) HasMultilibConflict(arch ArchType) bool {
1467 return c.multilibConflicts[arch]
1468}
1469
Sasha Smundakaf5ca922022-12-12 21:23:34 -08001470func (c *config) PrebuiltHiddenApiDir(_ PathContext) string {
Bill Peckhambae47492021-01-08 09:34:44 -08001471 return String(c.productVariables.PrebuiltHiddenApiDir)
1472}
1473
Justin Yun41cbb5e2023-11-29 17:58:16 +09001474func (c *config) VendorApiLevel() string {
1475 return String(c.productVariables.VendorApiLevel)
1476}
1477
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001478func (c *config) PrevVendorApiLevel() string {
1479 vendorApiLevel, err := strconv.Atoi(c.VendorApiLevel())
1480 if err != nil {
1481 panic(fmt.Errorf("Cannot parse vendor API level %s to an integer: %s",
1482 c.VendorApiLevel(), err))
1483 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001484 // The version before trunk stable is 34.
1485 if vendorApiLevel == 202404 {
1486 return "34"
1487 }
Hsin-Yi Chen890e7722024-03-05 15:56:44 +08001488 if vendorApiLevel >= 1 && vendorApiLevel <= 34 {
1489 return strconv.Itoa(vendorApiLevel - 1)
1490 }
1491 if vendorApiLevel < 202404 || vendorApiLevel%100 != 4 {
1492 panic("Unknown vendor API level " + c.VendorApiLevel())
1493 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001494 return strconv.Itoa(vendorApiLevel - 100)
1495}
1496
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001497func IsTrunkStableVendorApiLevel(level string) bool {
1498 levelInt, err := strconv.Atoi(level)
1499 return err == nil && levelInt >= 202404
1500}
1501
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001502func (c *config) VendorApiLevelFrozen() bool {
1503 return c.productVariables.GetBuildFlagBool("RELEASE_BOARD_API_LEVEL_FROZEN")
1504}
1505
Colin Cross9272ade2016-08-17 15:24:12 -07001506func (c *deviceConfig) Arches() []Arch {
1507 var arches []Arch
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001508 for _, target := range c.config.Targets[Android] {
Colin Cross9272ade2016-08-17 15:24:12 -07001509 arches = append(arches, target.Arch)
1510 }
1511 return arches
1512}
Dan Willemsend2ede872016-11-18 14:54:24 -08001513
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001514func (c *deviceConfig) BinderBitness() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001515 is32BitBinder := c.config.productVariables.Binder32bit
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001516 if is32BitBinder != nil && *is32BitBinder {
1517 return "32"
1518 }
1519 return "64"
1520}
1521
Dan Willemsen4353bc42016-12-05 17:16:02 -08001522func (c *deviceConfig) VendorPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001523 if c.config.productVariables.VendorPath != nil {
1524 return *c.config.productVariables.VendorPath
Dan Willemsen4353bc42016-12-05 17:16:02 -08001525 }
1526 return "vendor"
1527}
1528
Wei Li59586252024-11-04 09:25:54 -08001529func (c *deviceConfig) VendorDlkmPath() string {
1530 if c.config.productVariables.VendorDlkmPath != nil {
1531 return *c.config.productVariables.VendorDlkmPath
1532 }
1533 return "vendor_dlkm"
1534}
1535
Spandan Dase3b65312024-10-22 00:27:27 +00001536func (c *deviceConfig) BuildingVendorImage() bool {
1537 return proptools.Bool(c.config.productVariables.BuildingVendorImage)
1538}
1539
Jeongik Cha219141c2020-08-06 23:00:37 +09001540func (c *deviceConfig) CurrentApiLevelForVendorModules() string {
1541 return StringDefault(c.config.productVariables.DeviceCurrentApiLevelForVendorModules, "current")
1542}
1543
Justin Yun71549282017-11-17 12:10:28 +09001544func (c *deviceConfig) ExtraVndkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001545 return c.config.productVariables.ExtraVndkVersions
Dan Willemsend2ede872016-11-18 14:54:24 -08001546}
Jack He8cc71432016-12-08 15:45:07 -08001547
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001548func (c *deviceConfig) SystemSdkVersions() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001549 return c.config.productVariables.DeviceSystemSdkVersions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001550}
1551
1552func (c *deviceConfig) PlatformSystemSdkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001553 return c.config.productVariables.Platform_systemsdk_versions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001554}
1555
Jiyong Park2db76922017-11-08 16:03:48 +09001556func (c *deviceConfig) OdmPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001557 if c.config.productVariables.OdmPath != nil {
1558 return *c.config.productVariables.OdmPath
Jiyong Park2db76922017-11-08 16:03:48 +09001559 }
1560 return "odm"
1561}
1562
Spandan Dasc5717162024-11-01 18:33:57 +00001563func (c *deviceConfig) BuildingOdmImage() bool {
1564 return proptools.Bool(c.config.productVariables.BuildingOdmImage)
1565}
1566
Wei Li59586252024-11-04 09:25:54 -08001567func (c *deviceConfig) OdmDlkmPath() string {
1568 if c.config.productVariables.OdmDlkmPath != nil {
1569 return *c.config.productVariables.OdmDlkmPath
1570 }
1571 return "odm_dlkm"
1572}
1573
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001574func (c *deviceConfig) ProductPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001575 if c.config.productVariables.ProductPath != nil {
1576 return *c.config.productVariables.ProductPath
Jiyong Park2db76922017-11-08 16:03:48 +09001577 }
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001578 return "product"
Jiyong Park2db76922017-11-08 16:03:48 +09001579}
1580
Jihoon Kang6dd13b62024-10-22 23:21:02 +00001581func (c *deviceConfig) BuildingProductImage() bool {
1582 return proptools.Bool(c.config.productVariables.BuildingProductImage)
1583}
1584
Justin Yund5f6c822019-06-25 16:47:17 +09001585func (c *deviceConfig) SystemExtPath() string {
1586 if c.config.productVariables.SystemExtPath != nil {
1587 return *c.config.productVariables.SystemExtPath
Dario Frenifd05a742018-05-29 13:28:54 +01001588 }
Justin Yund5f6c822019-06-25 16:47:17 +09001589 return "system_ext"
Dario Frenifd05a742018-05-29 13:28:54 +01001590}
1591
Wei Li59586252024-11-04 09:25:54 -08001592func (c *deviceConfig) SystemDlkmPath() string {
1593 if c.config.productVariables.SystemDlkmPath != nil {
1594 return *c.config.productVariables.SystemDlkmPath
1595 }
1596 return "system_dlkm"
1597}
1598
1599func (c *deviceConfig) OemPath() string {
1600 if c.config.productVariables.OemPath != nil {
1601 return *c.config.productVariables.OemPath
1602 }
1603 return "oem"
1604}
1605
mrziwang23ba8762024-11-07 16:21:53 -08001606func (c *deviceConfig) UserdataPath() string {
1607 if c.config.productVariables.UserdataPath != nil {
1608 return *c.config.productVariables.UserdataPath
1609 }
1610 return "data"
1611}
1612
1613func (c *deviceConfig) BuildingUserdataImage() bool {
1614 return proptools.Bool(c.config.productVariables.BuildingUserdataImage)
1615}
1616
Jack He8cc71432016-12-08 15:45:07 -08001617func (c *deviceConfig) BtConfigIncludeDir() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001618 return String(c.config.productVariables.BtConfigIncludeDir)
Jack He8cc71432016-12-08 15:45:07 -08001619}
Dan Willemsen581341d2017-02-09 16:16:31 -08001620
Jiyong Parkd773eb32017-07-03 13:18:12 +09001621func (c *deviceConfig) DeviceKernelHeaderDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001622 return c.config.productVariables.DeviceKernelHeaders
Jiyong Parkd773eb32017-07-03 13:18:12 +09001623}
1624
Roland Levillainada12702020-06-09 13:07:36 +01001625// JavaCoverageEnabledForPath returns whether Java code coverage is enabled for
1626// path. Coverage is enabled by default when the product variable
1627// JavaCoveragePaths is empty. If JavaCoveragePaths is not empty, coverage is
1628// enabled for any path which is part of this variable (and not part of the
1629// JavaCoverageExcludePaths product variable). Value "*" in JavaCoveragePaths
1630// represents any path.
1631func (c *deviceConfig) JavaCoverageEnabledForPath(path string) bool {
1632 coverage := false
Chris Gross2f748692020-06-24 20:36:59 +00001633 if len(c.config.productVariables.JavaCoveragePaths) == 0 ||
Roland Levillainada12702020-06-09 13:07:36 +01001634 InList("*", c.config.productVariables.JavaCoveragePaths) ||
1635 HasAnyPrefix(path, c.config.productVariables.JavaCoveragePaths) {
1636 coverage = true
1637 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001638 if coverage && len(c.config.productVariables.JavaCoverageExcludePaths) > 0 {
Roland Levillainada12702020-06-09 13:07:36 +01001639 if HasAnyPrefix(path, c.config.productVariables.JavaCoverageExcludePaths) {
1640 coverage = false
1641 }
1642 }
1643 return coverage
1644}
1645
Colin Cross1a6acd42020-06-16 17:51:46 -07001646// Returns true if gcov or clang coverage is enabled.
Dan Willemsen581341d2017-02-09 16:16:31 -08001647func (c *deviceConfig) NativeCoverageEnabled() bool {
Colin Cross1a6acd42020-06-16 17:51:46 -07001648 return Bool(c.config.productVariables.GcovCoverage) ||
1649 Bool(c.config.productVariables.ClangCoverage)
Dan Willemsen581341d2017-02-09 16:16:31 -08001650}
1651
Oliver Nguyen1382ab62019-12-06 15:22:41 -08001652func (c *deviceConfig) ClangCoverageEnabled() bool {
1653 return Bool(c.config.productVariables.ClangCoverage)
1654}
1655
Pirama Arumuga Nainarb37ae582022-01-26 22:14:32 -08001656func (c *deviceConfig) ClangCoverageContinuousMode() bool {
1657 return Bool(c.config.productVariables.ClangCoverageContinuousMode)
1658}
1659
Colin Cross1a6acd42020-06-16 17:51:46 -07001660func (c *deviceConfig) GcovCoverageEnabled() bool {
1661 return Bool(c.config.productVariables.GcovCoverage)
1662}
1663
Roland Levillain4f5297b2020-06-09 12:44:06 +01001664// NativeCoverageEnabledForPath returns whether (GCOV- or Clang-based) native
1665// code coverage is enabled for path. By default, coverage is not enabled for a
1666// given path unless it is part of the NativeCoveragePaths product variable (and
1667// not part of the NativeCoverageExcludePaths product variable). Value "*" in
1668// NativeCoveragePaths represents any path.
1669func (c *deviceConfig) NativeCoverageEnabledForPath(path string) bool {
Ryan Campbell469a18a2017-02-27 09:01:54 -08001670 coverage := false
Roland Levillainf6cc2612020-07-09 16:58:14 +01001671 if len(c.config.productVariables.NativeCoveragePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001672 if InList("*", c.config.productVariables.NativeCoveragePaths) || HasAnyPrefix(path, c.config.productVariables.NativeCoveragePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001673 coverage = true
Dan Willemsen581341d2017-02-09 16:16:31 -08001674 }
1675 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001676 if coverage && len(c.config.productVariables.NativeCoverageExcludePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001677 if HasAnyPrefix(path, c.config.productVariables.NativeCoverageExcludePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001678 coverage = false
Ryan Campbell469a18a2017-02-27 09:01:54 -08001679 }
1680 }
1681 return coverage
Dan Willemsen581341d2017-02-09 16:16:31 -08001682}
Ivan Lozano5f595532017-07-13 14:46:05 -07001683
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001684func (c *deviceConfig) PgoAdditionalProfileDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001685 return c.config.productVariables.PgoAdditionalProfileDirs
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001686}
1687
Vinh Tran44cb78c2023-03-09 22:07:19 -05001688// AfdoProfile returns fully qualified path associated to the given module name
Colin Crossd38feb02024-01-23 16:38:06 -08001689func (c *deviceConfig) AfdoProfile(name string) (string, error) {
Vinh Tran44cb78c2023-03-09 22:07:19 -05001690 for _, afdoProfile := range c.config.productVariables.AfdoProfiles {
1691 split := strings.Split(afdoProfile, ":")
1692 if len(split) != 3 {
Colin Crossd38feb02024-01-23 16:38:06 -08001693 return "", fmt.Errorf("AFDO_PROFILES has invalid value: %s. "+
Vinh Tran44cb78c2023-03-09 22:07:19 -05001694 "The expected format is <module>:<fully-qualified-path-to-fdo_profile>", afdoProfile)
1695 }
1696 if split[0] == name {
Colin Crossd38feb02024-01-23 16:38:06 -08001697 return strings.Join([]string{split[1], split[2]}, ":"), nil
Vinh Tran44cb78c2023-03-09 22:07:19 -05001698 }
1699 }
Colin Crossd38feb02024-01-23 16:38:06 -08001700 return "", nil
Vinh Tran44cb78c2023-03-09 22:07:19 -05001701}
1702
Tri Vo35a51432018-03-25 20:00:00 -07001703func (c *deviceConfig) VendorSepolicyDirs() []string {
1704 return c.config.productVariables.BoardVendorSepolicyDirs
1705}
1706
1707func (c *deviceConfig) OdmSepolicyDirs() []string {
1708 return c.config.productVariables.BoardOdmSepolicyDirs
1709}
1710
Felixa20a8752020-05-17 18:28:35 +02001711func (c *deviceConfig) SystemExtPublicSepolicyDirs() []string {
1712 return c.config.productVariables.SystemExtPublicSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001713}
1714
Felixa20a8752020-05-17 18:28:35 +02001715func (c *deviceConfig) SystemExtPrivateSepolicyDirs() []string {
1716 return c.config.productVariables.SystemExtPrivateSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001717}
1718
Inseob Kim0866b002019-04-15 20:21:29 +09001719func (c *deviceConfig) SepolicyM4Defs() []string {
1720 return c.config.productVariables.BoardSepolicyM4Defs
1721}
1722
Jiyong Park7f67f482019-01-05 12:57:48 +09001723func (c *deviceConfig) OverrideManifestPackageNameFor(name string) (manifestName string, overridden bool) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001724 return findOverrideValue(c.config.productVariables.ManifestPackageNameOverrides, name,
1725 "invalid override rule %q in PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES should be <module_name>:<manifest_name>")
1726}
1727
1728func (c *deviceConfig) OverrideCertificateFor(name string) (certificatePath string, overridden bool) {
Jaewoong Jungacb6db32019-02-28 16:22:30 +00001729 return findOverrideValue(c.config.productVariables.CertificateOverrides, name,
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001730 "invalid override rule %q in PRODUCT_CERTIFICATE_OVERRIDES should be <module_name>:<certificate_module_name>")
1731}
1732
Jaewoong Jung9d22a912019-01-23 16:27:47 -08001733func (c *deviceConfig) OverridePackageNameFor(name string) string {
1734 newName, overridden := findOverrideValue(
1735 c.config.productVariables.PackageNameOverrides,
1736 name,
1737 "invalid override rule %q in PRODUCT_PACKAGE_NAME_OVERRIDES should be <module_name>:<package_name>")
1738 if overridden {
1739 return newName
1740 }
1741 return name
1742}
1743
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001744func findOverrideValue(overrides []string, name string, errorMsg string) (newValue string, overridden bool) {
Jiyong Park7f67f482019-01-05 12:57:48 +09001745 if overrides == nil || len(overrides) == 0 {
1746 return "", false
1747 }
1748 for _, o := range overrides {
1749 split := strings.Split(o, ":")
1750 if len(split) != 2 {
1751 // This shouldn't happen as this is first checked in make, but just in case.
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001752 panic(fmt.Errorf(errorMsg, o))
Jiyong Park7f67f482019-01-05 12:57:48 +09001753 }
1754 if matchPattern(split[0], name) {
1755 return substPattern(split[0], split[1], name), true
1756 }
1757 }
1758 return "", false
1759}
1760
Albert Martineefabcf2022-03-21 20:11:16 +00001761func (c *deviceConfig) ApexGlobalMinSdkVersionOverride() string {
1762 return String(c.config.productVariables.ApexGlobalMinSdkVersionOverride)
1763}
1764
Ivan Lozano5f595532017-07-13 14:46:05 -07001765func (c *config) IntegerOverflowDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001766 if len(c.productVariables.IntegerOverflowExcludePaths) == 0 {
Ivan Lozano5f595532017-07-13 14:46:05 -07001767 return false
1768 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001769 return HasAnyPrefix(path, c.productVariables.IntegerOverflowExcludePaths)
Ivan Lozano5f595532017-07-13 14:46:05 -07001770}
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001771
1772func (c *config) CFIDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001773 if len(c.productVariables.CFIExcludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001774 return false
1775 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001776 return HasAnyPrefix(path, c.productVariables.CFIExcludePaths)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001777}
1778
1779func (c *config) CFIEnabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001780 if len(c.productVariables.CFIIncludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001781 return false
1782 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001783 return HasAnyPrefix(path, c.productVariables.CFIIncludePaths) && !c.CFIDisabledForPath(path)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001784}
Colin Crosse15ddaf2017-12-04 11:24:31 -08001785
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001786func (c *config) MemtagHeapDisabledForPath(path string) bool {
1787 if len(c.productVariables.MemtagHeapExcludePaths) == 0 {
1788 return false
1789 }
1790 return HasAnyPrefix(path, c.productVariables.MemtagHeapExcludePaths)
1791}
1792
1793func (c *config) MemtagHeapAsyncEnabledForPath(path string) bool {
1794 if len(c.productVariables.MemtagHeapAsyncIncludePaths) == 0 {
1795 return false
1796 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001797 return HasAnyPrefix(path, c.productVariables.MemtagHeapAsyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001798}
1799
1800func (c *config) MemtagHeapSyncEnabledForPath(path string) bool {
1801 if len(c.productVariables.MemtagHeapSyncIncludePaths) == 0 {
1802 return false
1803 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001804 return HasAnyPrefix(path, c.productVariables.MemtagHeapSyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001805}
1806
Tomislav Novakf734f002023-08-22 10:51:44 -07001807func (c *config) HWASanDisabledForPath(path string) bool {
1808 if len(c.productVariables.HWASanExcludePaths) == 0 {
1809 return false
1810 }
1811 return HasAnyPrefix(path, c.productVariables.HWASanExcludePaths)
1812}
1813
Hang Lua98aab92023-03-17 13:17:22 +08001814func (c *config) HWASanEnabledForPath(path string) bool {
1815 if len(c.productVariables.HWASanIncludePaths) == 0 {
1816 return false
1817 }
Tomislav Novakf734f002023-08-22 10:51:44 -07001818 return HasAnyPrefix(path, c.productVariables.HWASanIncludePaths) && !c.HWASanDisabledForPath(path)
Hang Lua98aab92023-03-17 13:17:22 +08001819}
1820
Dan Willemsen0fe78662018-03-26 12:41:18 -07001821func (c *config) VendorConfig(name string) VendorConfig {
Colin Cross9d34f352019-11-22 16:03:51 -08001822 return soongconfig.Config(c.productVariables.VendorVars[name])
Dan Willemsen0fe78662018-03-26 12:41:18 -07001823}
1824
Colin Cross395f2cf2018-10-24 16:10:32 -07001825func (c *config) NdkAbis() bool {
1826 return Bool(c.productVariables.Ndk_abis)
1827}
1828
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001829func (c *config) AmlAbis() bool {
1830 return Bool(c.productVariables.Aml_abis)
1831}
1832
Jiyong Park4da07972021-01-05 21:01:11 +09001833func (c *config) ForceApexSymlinkOptimization() bool {
1834 return Bool(c.productVariables.ForceApexSymlinkOptimization)
1835}
1836
Sasha Smundakfe9a5b82022-07-27 14:51:45 -07001837func (c *config) ApexCompressionEnabled() bool {
1838 return Bool(c.productVariables.CompressedApex) && !c.UnbundledBuildApps()
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +00001839}
1840
Jooyung Han920809a2024-11-15 12:50:50 +09001841func (c *config) DefaultApexPayloadType() string {
1842 return StringDefault(c.productVariables.DefaultApexPayloadType, "ext4")
1843}
1844
Justin Yun2cc42502024-09-11 14:10:20 +09001845func (c *config) UseSoongSystemImage() bool {
1846 return Bool(c.productVariables.UseSoongSystemImage)
1847}
1848
1849func (c *config) SoongDefinedSystemImage() string {
1850 if c.UseSoongSystemImage() {
1851 return String(c.productVariables.ProductSoongDefinedSystemImage)
1852 }
1853 return ""
1854}
1855
Jeongik Chac9464142019-01-07 12:07:27 +09001856func (c *config) EnforceSystemCertificate() bool {
1857 return Bool(c.productVariables.EnforceSystemCertificate)
1858}
1859
Colin Cross440e0d02020-06-11 11:32:11 -07001860func (c *config) EnforceSystemCertificateAllowList() []string {
1861 return c.productVariables.EnforceSystemCertificateAllowList
Jeongik Chac9464142019-01-07 12:07:27 +09001862}
1863
Jeongik Cha2cc570d2019-10-29 15:44:45 +09001864func (c *config) EnforceProductPartitionInterface() bool {
1865 return Bool(c.productVariables.EnforceProductPartitionInterface)
1866}
1867
Colin Crossf24a22a2019-01-31 14:12:44 -08001868func (c *config) ProductHiddenAPIStubs() []string {
1869 return c.productVariables.ProductHiddenAPIStubs
Colin Cross8faf8fc2019-01-16 15:15:52 -08001870}
1871
Colin Crossf24a22a2019-01-31 14:12:44 -08001872func (c *config) ProductHiddenAPIStubsSystem() []string {
1873 return c.productVariables.ProductHiddenAPIStubsSystem
Colin Cross8faf8fc2019-01-16 15:15:52 -08001874}
1875
Colin Crossf24a22a2019-01-31 14:12:44 -08001876func (c *config) ProductHiddenAPIStubsTest() []string {
1877 return c.productVariables.ProductHiddenAPIStubsTest
Colin Cross8faf8fc2019-01-16 15:15:52 -08001878}
Dan Willemsen71c74602019-04-10 12:27:35 -07001879
Dan Willemsen54879d12019-04-18 10:08:46 -07001880func (c *deviceConfig) TargetFSConfigGen() []string {
Dan Willemsen71c74602019-04-10 12:27:35 -07001881 return c.config.productVariables.TargetFSConfigGen
1882}
Inseob Kim0866b002019-04-15 20:21:29 +09001883
1884func (c *config) ProductPublicSepolicyDirs() []string {
1885 return c.productVariables.ProductPublicSepolicyDirs
1886}
1887
1888func (c *config) ProductPrivateSepolicyDirs() []string {
1889 return c.productVariables.ProductPrivateSepolicyDirs
1890}
1891
Inseob Kim5eb7ee92022-04-27 10:30:34 +09001892func (c *config) TargetMultitreeUpdateMeta() bool {
1893 return c.productVariables.MultitreeUpdateMeta
1894}
1895
Inseob Kim1f086e22019-05-09 13:29:15 +09001896func (c *deviceConfig) DeviceArch() string {
1897 return String(c.config.productVariables.DeviceArch)
1898}
1899
1900func (c *deviceConfig) DeviceArchVariant() string {
1901 return String(c.config.productVariables.DeviceArchVariant)
1902}
1903
1904func (c *deviceConfig) DeviceSecondaryArch() string {
1905 return String(c.config.productVariables.DeviceSecondaryArch)
1906}
1907
1908func (c *deviceConfig) DeviceSecondaryArchVariant() string {
1909 return String(c.config.productVariables.DeviceSecondaryArchVariant)
1910}
Yifan Hong82db7352020-01-21 16:12:26 -08001911
1912func (c *deviceConfig) BoardUsesRecoveryAsBoot() bool {
1913 return Bool(c.config.productVariables.BoardUsesRecoveryAsBoot)
1914}
Yifan Hong97365ee2020-07-29 09:51:57 -07001915
1916func (c *deviceConfig) BoardKernelBinaries() []string {
1917 return c.config.productVariables.BoardKernelBinaries
1918}
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001919
Yifan Hong42bef8d2020-08-05 14:36:09 -07001920func (c *deviceConfig) BoardKernelModuleInterfaceVersions() []string {
1921 return c.config.productVariables.BoardKernelModuleInterfaceVersions
1922}
1923
Yifan Hongdd8dacc2020-10-21 15:40:17 -07001924func (c *deviceConfig) BoardMoveRecoveryResourcesToVendorBoot() bool {
1925 return Bool(c.config.productVariables.BoardMoveRecoveryResourcesToVendorBoot)
1926}
1927
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001928func (c *deviceConfig) PlatformSepolicyVersion() string {
1929 return String(c.config.productVariables.PlatformSepolicyVersion)
1930}
1931
Inseob Kim843f6642022-01-07 09:11:23 +09001932func (c *deviceConfig) PlatformSepolicyCompatVersions() []string {
1933 return c.config.productVariables.PlatformSepolicyCompatVersions
1934}
1935
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001936func (c *deviceConfig) BoardSepolicyVers() string {
Inseob Kim0c4eec82021-03-22 22:33:40 +09001937 if ver := String(c.config.productVariables.BoardSepolicyVers); ver != "" {
1938 return ver
1939 }
1940 return c.PlatformSepolicyVersion()
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001941}
1942
Inseob Kim1a0afcc2022-02-14 23:10:51 +09001943func (c *deviceConfig) SystemExtSepolicyPrebuiltApiDir() string {
1944 return String(c.config.productVariables.SystemExtSepolicyPrebuiltApiDir)
1945}
1946
1947func (c *deviceConfig) ProductSepolicyPrebuiltApiDir() string {
1948 return String(c.config.productVariables.ProductSepolicyPrebuiltApiDir)
1949}
1950
1951func (c *deviceConfig) IsPartnerTrebleSepolicyTestEnabled() bool {
1952 return c.SystemExtSepolicyPrebuiltApiDir() != "" || c.ProductSepolicyPrebuiltApiDir() != ""
1953}
1954
Justin DeMartino383bfb32021-02-24 10:49:43 -08001955func createDirsMap(previous map[string]bool, dirs []string) (map[string]bool, error) {
1956 var ret = make(map[string]bool)
1957 for _, dir := range dirs {
1958 clean := filepath.Clean(dir)
1959 if previous[clean] || ret[clean] {
1960 return nil, fmt.Errorf("Duplicate entry %s", dir)
1961 }
1962 ret[clean] = true
1963 }
1964 return ret, nil
1965}
1966
1967func (c *deviceConfig) createDirsMapOnce(onceKey OnceKey, previous map[string]bool, dirs []string) map[string]bool {
1968 dirMap := c.Once(onceKey, func() interface{} {
1969 ret, err := createDirsMap(previous, dirs)
1970 if err != nil {
1971 panic(fmt.Errorf("%s: %w", onceKey.key, err))
1972 }
1973 return ret
1974 })
1975 if dirMap == nil {
1976 return nil
1977 }
1978 return dirMap.(map[string]bool)
1979}
1980
Inseob Kim60c32f02020-12-21 22:53:05 +09001981func (c *deviceConfig) ShippingApiLevel() ApiLevel {
Steven Morelanda48df2b2024-06-03 22:29:38 +00001982 if c.config.productVariables.Shipping_api_level == nil {
Inseob Kim60c32f02020-12-21 22:53:05 +09001983 return NoneApiLevel
1984 }
Steven Morelanda48df2b2024-06-03 22:29:38 +00001985 apiLevel, _ := strconv.Atoi(*c.config.productVariables.Shipping_api_level)
Inseob Kim60c32f02020-12-21 22:53:05 +09001986 return uncheckedFinalApiLevel(apiLevel)
1987}
1988
Liz Kammer33cc80e2023-05-18 18:20:28 +00001989func (c *deviceConfig) BuildBrokenPluginValidation() []string {
1990 return c.config.productVariables.BuildBrokenPluginValidation
1991}
1992
Alix Espinoef47e542022-09-14 19:10:51 +00001993func (c *deviceConfig) BuildBrokenClangAsFlags() bool {
1994 return c.config.productVariables.BuildBrokenClangAsFlags
1995}
1996
1997func (c *deviceConfig) BuildBrokenClangCFlags() bool {
1998 return c.config.productVariables.BuildBrokenClangCFlags
1999}
2000
Alixb5f6d9e2022-04-20 23:00:58 +00002001func (c *deviceConfig) BuildBrokenClangProperty() bool {
2002 return c.config.productVariables.BuildBrokenClangProperty
2003}
2004
Inseob Kim67e5add192021-03-17 18:05:33 +09002005func (c *deviceConfig) BuildBrokenEnforceSyspropOwner() bool {
2006 return c.config.productVariables.BuildBrokenEnforceSyspropOwner
2007}
2008
2009func (c *deviceConfig) BuildBrokenTrebleSyspropNeverallow() bool {
2010 return c.config.productVariables.BuildBrokenTrebleSyspropNeverallow
2011}
2012
Hridya Valsaraju5a5c7d52021-04-02 16:45:24 -07002013func (c *deviceConfig) BuildDebugfsRestrictionsEnabled() bool {
2014 return c.config.productVariables.BuildDebugfsRestrictionsEnabled
2015}
2016
Inseob Kim0cac7b42021-02-03 18:16:46 +09002017func (c *deviceConfig) BuildBrokenVendorPropertyNamespace() bool {
2018 return c.config.productVariables.BuildBrokenVendorPropertyNamespace
2019}
2020
Liz Kammer619be462022-01-28 15:13:39 -05002021func (c *deviceConfig) BuildBrokenInputDir(name string) bool {
2022 return InList(name, c.config.productVariables.BuildBrokenInputDirModules)
2023}
2024
Jiyong Park3bb99242024-01-04 23:21:26 +00002025func (c *deviceConfig) BuildBrokenDontCheckSystemSdk() bool {
2026 return c.config.productVariables.BuildBrokenDontCheckSystemSdk
2027}
2028
Inseob Kim2da72af2024-06-18 11:09:12 +09002029func (c *deviceConfig) BuildBrokenDupSysprop() bool {
2030 return c.config.productVariables.BuildBrokenDupSysprop
2031}
2032
Jiakai Zhang48203e32023-06-02 23:42:21 +01002033func (c *config) BuildWarningBadOptionalUsesLibsAllowlist() []string {
2034 return c.productVariables.BuildWarningBadOptionalUsesLibsAllowlist
2035}
2036
Yu Liu6a7940c2023-05-09 17:12:22 -07002037func (c *deviceConfig) GenruleSandboxing() bool {
2038 return Bool(c.config.productVariables.GenruleSandboxing)
Vinh Tran140d5882022-06-10 14:23:27 -04002039}
2040
Inseob Kim67e5add192021-03-17 18:05:33 +09002041func (c *deviceConfig) RequiresInsecureExecmemForSwiftshader() bool {
2042 return c.config.productVariables.RequiresInsecureExecmemForSwiftshader
2043}
2044
Devin Moorec381e102023-07-06 22:03:58 +00002045func (c *deviceConfig) Release_aidl_use_unfrozen() bool {
2046 return Bool(c.config.productVariables.Release_aidl_use_unfrozen)
2047}
2048
Inseob Kim67e5add192021-03-17 18:05:33 +09002049func (c *config) SelinuxIgnoreNeverallows() bool {
2050 return c.productVariables.SelinuxIgnoreNeverallows
2051}
2052
Inseob Kima10ef272021-09-15 03:04:53 +00002053func (c *deviceConfig) SepolicyFreezeTestExtraDirs() []string {
2054 return c.config.productVariables.SepolicyFreezeTestExtraDirs
2055}
2056
2057func (c *deviceConfig) SepolicyFreezeTestExtraPrebuiltDirs() []string {
2058 return c.config.productVariables.SepolicyFreezeTestExtraPrebuiltDirs
2059}
2060
Jiyong Parkd163d4d2021-10-12 16:47:43 +09002061func (c *deviceConfig) GenerateAidlNdkPlatformBackend() bool {
2062 return c.config.productVariables.GenerateAidlNdkPlatformBackend
2063}
2064
Yu Liu67a28422024-03-05 00:36:31 +00002065func (c *deviceConfig) AconfigContainerValidation() string {
2066 return c.config.productVariables.AconfigContainerValidation
2067}
2068
Christopher Ferris98f10222022-07-13 23:16:52 -07002069func (c *config) IgnorePrefer32OnDevice() bool {
2070 return c.productVariables.IgnorePrefer32OnDevice
2071}
2072
Ulya Trafimovich249386a2020-07-01 14:31:13 +01002073func (c *config) BootJars() []string {
2074 return c.Once(earlyBootJarsKey, func() interface{} {
Paul Duffin69d1fb12020-10-23 21:14:20 +01002075 list := c.productVariables.BootJars.CopyOfJars()
satayevd604b212021-07-21 14:23:52 +01002076 return append(list, c.productVariables.ApexBootJars.CopyOfJars()...)
Ulya Trafimovich249386a2020-07-01 14:31:13 +01002077 }).([]string)
2078}
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002079
satayevd604b212021-07-21 14:23:52 +01002080func (c *config) NonApexBootJars() ConfiguredJarList {
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002081 return c.productVariables.BootJars
2082}
2083
satayevd604b212021-07-21 14:23:52 +01002084func (c *config) ApexBootJars() ConfiguredJarList {
2085 return c.productVariables.ApexBootJars
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002086}
Colin Cross77cdcfd2021-03-12 11:28:25 -08002087
2088func (c *config) RBEWrapper() string {
2089 return c.GetenvWithDefault("RBE_WRAPPER", remoteexec.DefaultWrapperPath)
2090}
Colin Cross9b698b62021-12-22 09:55:32 -08002091
2092// UseHostMusl returns true if the host target has been configured to build against musl libc.
2093func (c *config) UseHostMusl() bool {
2094 return Bool(c.productVariables.HostMusl)
2095}
MarkDacekff851b82022-04-21 18:33:17 +00002096
Spandan Das9e93d3d2023-03-08 05:47:29 +00002097// ApiSurfaces directory returns the source path inside the api_surfaces repo
2098// (relative to workspace root).
2099func (c *config) ApiSurfacesDir(s ApiSurface, version string) string {
2100 return filepath.Join(
2101 "build",
2102 "bazel",
2103 "api_surfaces",
2104 s.String(),
2105 version)
2106}
Jihoon Kang1bff0342023-01-17 20:40:22 +00002107
Jihoon Kang1975d3e2023-10-16 23:24:11 +00002108func (c *config) JavaCoverageEnabled() bool {
2109 return c.IsEnvTrue("EMMA_INSTRUMENT") || c.IsEnvTrue("EMMA_INSTRUMENT_STATIC") || c.IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK")
2110}
2111
Jihoon Kangc1b04d62023-11-16 19:07:04 +00002112func (c *deviceConfig) BuildFromSourceStub() bool {
2113 return Bool(c.config.productVariables.BuildFromSourceStub)
2114}
2115
Jihoon Kang1bff0342023-01-17 20:40:22 +00002116func (c *config) BuildFromTextStub() bool {
Jihoon Kang1975d3e2023-10-16 23:24:11 +00002117 // TODO: b/302320354 - Remove the coverage build specific logic once the
2118 // robust solution for handling native properties in from-text stub build
2119 // is implemented.
Jihoon Kangc1b04d62023-11-16 19:07:04 +00002120 return !c.buildFromSourceStub &&
2121 !c.JavaCoverageEnabled() &&
2122 !c.deviceConfig.BuildFromSourceStub()
Jihoon Kang1bff0342023-01-17 20:40:22 +00002123}
Spandan Das4deab282023-03-30 17:06:32 +00002124
2125func (c *config) SetBuildFromTextStub(b bool) {
Jihoon Kang2a929ad2023-06-08 19:02:07 +00002126 c.buildFromSourceStub = !b
Jihoon Kangcbcad7c2023-06-01 22:31:52 +00002127 c.productVariables.Build_from_text_stub = boolPtr(b)
Spandan Das4deab282023-03-30 17:06:32 +00002128}
Jihoon Kang1c92c3e2023-03-23 17:44:51 +00002129
Inseob Kim5bac3b62023-08-25 21:29:46 +09002130func (c *deviceConfig) CheckVendorSeappViolations() bool {
2131 return Bool(c.config.productVariables.CheckVendorSeappViolations)
2132}
Jihoon Kangcfbc4072023-09-20 01:02:18 +00002133
Inseob Kime4e85d52023-10-25 23:53:58 +09002134func (c *config) GetBuildFlag(name string) (string, bool) {
2135 val, ok := c.productVariables.BuildFlags[name]
2136 return val, ok
2137}
Spandan Dase3fcb412023-10-26 20:48:02 +00002138
Rico Winda7b38592024-08-26 12:10:44 +02002139func (c *config) UseOptimizedResourceShrinkingByDefault() bool {
2140 return c.productVariables.GetBuildFlagBool("RELEASE_USE_OPTIMIZED_RESOURCE_SHRINKING_BY_DEFAULT")
2141}
2142
Colin Cross8f1b0332024-01-25 13:39:06 -08002143func (c *config) UseResourceProcessorByDefault() bool {
2144 return c.productVariables.GetBuildFlagBool("RELEASE_USE_RESOURCE_PROCESSOR_BY_DEFAULT")
2145}
2146
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002147func (c *config) UseTransitiveJarsInClasspath() bool {
2148 return c.productVariables.GetBuildFlagBool("RELEASE_USE_TRANSITIVE_JARS_IN_CLASSPATH")
2149}
2150
David Srbecky55b46b02024-11-26 17:16:16 +00002151func (c *config) UseDexV41() bool {
2152 return c.productVariables.GetBuildFlagBool("RELEASE_USE_DEX_V41")
2153}
2154
Spandan Dase3fcb412023-10-26 20:48:02 +00002155var (
Spandan Das85bd4622024-08-01 00:51:20 +00002156 mainlineApexContributionBuildFlagsToApexNames = map[string]string{
2157 "RELEASE_APEX_CONTRIBUTIONS_ADBD": "com.android.adbd",
2158 "RELEASE_APEX_CONTRIBUTIONS_ADSERVICES": "com.android.adservices",
2159 "RELEASE_APEX_CONTRIBUTIONS_APPSEARCH": "com.android.appsearch",
2160 "RELEASE_APEX_CONTRIBUTIONS_ART": "com.android.art",
2161 "RELEASE_APEX_CONTRIBUTIONS_BLUETOOTH": "com.android.btservices",
2162 "RELEASE_APEX_CONTRIBUTIONS_CAPTIVEPORTALLOGIN": "",
2163 "RELEASE_APEX_CONTRIBUTIONS_CELLBROADCAST": "com.android.cellbroadcast",
2164 "RELEASE_APEX_CONTRIBUTIONS_CONFIGINFRASTRUCTURE": "com.android.configinfrastructure",
2165 "RELEASE_APEX_CONTRIBUTIONS_CONNECTIVITY": "com.android.tethering",
2166 "RELEASE_APEX_CONTRIBUTIONS_CONSCRYPT": "com.android.conscrypt",
2167 "RELEASE_APEX_CONTRIBUTIONS_CRASHRECOVERY": "",
2168 "RELEASE_APEX_CONTRIBUTIONS_DEVICELOCK": "com.android.devicelock",
2169 "RELEASE_APEX_CONTRIBUTIONS_DOCUMENTSUIGOOGLE": "",
2170 "RELEASE_APEX_CONTRIBUTIONS_EXTSERVICES": "com.android.extservices",
2171 "RELEASE_APEX_CONTRIBUTIONS_HEALTHFITNESS": "com.android.healthfitness",
2172 "RELEASE_APEX_CONTRIBUTIONS_IPSEC": "com.android.ipsec",
2173 "RELEASE_APEX_CONTRIBUTIONS_MEDIA": "com.android.media",
2174 "RELEASE_APEX_CONTRIBUTIONS_MEDIAPROVIDER": "com.android.mediaprovider",
2175 "RELEASE_APEX_CONTRIBUTIONS_MODULE_METADATA": "",
2176 "RELEASE_APEX_CONTRIBUTIONS_NETWORKSTACKGOOGLE": "",
2177 "RELEASE_APEX_CONTRIBUTIONS_NEURALNETWORKS": "com.android.neuralnetworks",
2178 "RELEASE_APEX_CONTRIBUTIONS_ONDEVICEPERSONALIZATION": "com.android.ondevicepersonalization",
2179 "RELEASE_APEX_CONTRIBUTIONS_PERMISSION": "com.android.permission",
2180 "RELEASE_APEX_CONTRIBUTIONS_PRIMARY_LIBS": "",
2181 "RELEASE_APEX_CONTRIBUTIONS_REMOTEKEYPROVISIONING": "com.android.rkpd",
2182 "RELEASE_APEX_CONTRIBUTIONS_RESOLV": "com.android.resolv",
2183 "RELEASE_APEX_CONTRIBUTIONS_SCHEDULING": "com.android.scheduling",
2184 "RELEASE_APEX_CONTRIBUTIONS_SDKEXTENSIONS": "com.android.sdkext",
2185 "RELEASE_APEX_CONTRIBUTIONS_SWCODEC": "com.android.media.swcodec",
2186 "RELEASE_APEX_CONTRIBUTIONS_STATSD": "com.android.os.statsd",
2187 "RELEASE_APEX_CONTRIBUTIONS_TELEMETRY_TVP": "",
2188 "RELEASE_APEX_CONTRIBUTIONS_TZDATA": "com.android.tzdata",
2189 "RELEASE_APEX_CONTRIBUTIONS_UWB": "com.android.uwb",
2190 "RELEASE_APEX_CONTRIBUTIONS_WIFI": "com.android.wifi",
Spandan Dase3fcb412023-10-26 20:48:02 +00002191 }
2192)
2193
2194// Returns the list of _selected_ apex_contributions
2195// Each mainline module will have one entry in the list
2196func (c *config) AllApexContributions() []string {
2197 ret := []string{}
Spandan Das85bd4622024-08-01 00:51:20 +00002198 for _, f := range SortedKeys(mainlineApexContributionBuildFlagsToApexNames) {
Spandan Dase3fcb412023-10-26 20:48:02 +00002199 if val, exists := c.GetBuildFlag(f); exists && val != "" {
2200 ret = append(ret, val)
2201 }
2202 }
2203 return ret
2204}
Spandan Das8ab28dd2024-02-17 03:31:45 +00002205
Spandan Das85bd4622024-08-01 00:51:20 +00002206func (c *config) AllMainlineApexNames() []string {
2207 return SortedStringValues(mainlineApexContributionBuildFlagsToApexNames)
2208}
2209
Spandan Das0d24ade2024-03-08 04:20:15 +00002210func (c *config) BuildIgnoreApexContributionContents() *bool {
Spandan Das8ab28dd2024-02-17 03:31:45 +00002211 return c.productVariables.BuildIgnoreApexContributionContents
2212}
Inseob Kim8fa54da2024-03-19 16:48:59 +09002213
2214func (c *config) ProductLocales() []string {
2215 return c.productVariables.ProductLocales
2216}
2217
2218func (c *config) ProductDefaultWifiChannels() []string {
2219 return c.productVariables.ProductDefaultWifiChannels
2220}
2221
2222func (c *config) BoardUseVbmetaDigestInFingerprint() bool {
2223 return Bool(c.productVariables.BoardUseVbmetaDigestInFingerprint)
2224}
2225
2226func (c *config) OemProperties() []string {
2227 return c.productVariables.OemProperties
2228}
Kiyoung Kim881e4652024-07-08 11:02:23 +09002229
2230func (c *config) UseDebugArt() bool {
2231 if c.productVariables.ArtTargetIncludeDebugBuild != nil {
2232 return Bool(c.productVariables.ArtTargetIncludeDebugBuild)
2233 }
2234
2235 return Bool(c.productVariables.Eng)
2236}
Inseob Kimd8538e52024-07-31 02:00:41 +00002237
2238func (c *config) SystemPropFiles(ctx PathContext) Paths {
2239 return PathsForSource(ctx, c.productVariables.SystemPropFiles)
2240}
Inseob Kim6bd92d52024-07-31 02:01:03 +00002241
Inseob Kimacf91742024-08-05 12:51:05 +09002242func (c *config) SystemExtPropFiles(ctx PathContext) Paths {
2243 return PathsForSource(ctx, c.productVariables.SystemExtPropFiles)
2244}
2245
Inseob Kim01d4f8b2024-08-08 17:47:14 +09002246func (c *config) ProductPropFiles(ctx PathContext) Paths {
2247 return PathsForSource(ctx, c.productVariables.ProductPropFiles)
2248}
2249
Inseob Kim9a22c7e2024-08-26 15:58:09 +09002250func (c *config) OdmPropFiles(ctx PathContext) Paths {
2251 return PathsForSource(ctx, c.productVariables.OdmPropFiles)
2252}
2253
Spandan Das859cdef2024-10-25 21:06:18 +00002254func (c *config) VendorPropFiles(ctx PathContext) Paths {
2255 return PathsForSource(ctx, c.productVariables.VendorPropFiles)
2256}
2257
Nouby Mohamed8609a552024-09-04 22:19:51 +00002258func (c *config) ExtraAllowedDepsTxt() string {
2259 return String(c.productVariables.ExtraAllowedDepsTxt)
2260}
2261
Inseob Kim6bd92d52024-07-31 02:01:03 +00002262func (c *config) EnableUffdGc() string {
2263 return String(c.productVariables.EnableUffdGc)
2264}
Bill Yang3b3aac02024-09-05 09:22:09 +00002265
2266func (c *config) DeviceFrameworkCompatibilityMatrixFile() []string {
2267 return c.productVariables.DeviceFrameworkCompatibilityMatrixFile
2268}
2269
2270func (c *config) DeviceProductCompatibilityMatrixFile() []string {
2271 return c.productVariables.DeviceProductCompatibilityMatrixFile
2272}
2273
2274func (c *config) BoardAvbEnable() bool {
2275 return Bool(c.productVariables.BoardAvbEnable)
2276}
2277
2278func (c *config) BoardAvbSystemAddHashtreeFooterArgs() []string {
2279 return c.productVariables.BoardAvbSystemAddHashtreeFooterArgs
2280}
Spandan Das950deca2024-10-01 18:35:23 +00002281
2282// Returns true if RELEASE_INSTALL_APEX_SYSTEMSERVER_DEXPREOPT_SAME_PARTITION is set to true.
2283// If true, dexpreopt files of apex system server jars will be installed in the same partition as the parent apex.
2284// If false, all these files will be installed in /system partition.
2285func (c Config) InstallApexSystemServerDexpreoptSamePartition() bool {
2286 return c.config.productVariables.GetBuildFlagBool("RELEASE_INSTALL_APEX_SYSTEMSERVER_DEXPREOPT_SAME_PARTITION")
2287}
Bill Yang42816dc2024-10-07 10:02:31 +00002288
2289func (c *config) DeviceMatrixFile() []string {
2290 return c.productVariables.DeviceMatrixFile
2291}
2292
2293func (c *config) ProductManifestFiles() []string {
2294 return c.productVariables.ProductManifestFiles
2295}
2296
2297func (c *config) SystemManifestFile() []string {
2298 return c.productVariables.SystemManifestFile
2299}
2300
2301func (c *config) SystemExtManifestFiles() []string {
2302 return c.productVariables.SystemExtManifestFiles
2303}
Bill Yang7ab86602024-11-01 03:08:47 +00002304
2305func (c *config) DeviceManifestFiles() []string {
2306 return c.productVariables.DeviceManifestFiles
2307}
2308
2309func (c *config) OdmManifestFiles() []string {
2310 return c.productVariables.OdmManifestFiles
2311}