blob: 00d5e2c6a95f25dd3b683dff7fabed74c3478062 [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
Marybeth Fairc8c74d62024-12-04 14:22:40 -0500292func (c Config) ReleaseFingerprintAconfigPackages() bool {
293 return c.config.productVariables.GetBuildFlagBool("RELEASE_FINGERPRINT_ACONFIG_PACKAGES")
294}
295
Jingwen Chenc711fec2020-11-22 23:52:50 -0500296// A DeviceConfig object represents the configuration for a particular device
297// being built. For now there will only be one of these, but in the future there
298// may be multiple devices being built.
Colin Cross9272ade2016-08-17 15:24:12 -0700299type DeviceConfig struct {
300 *deviceConfig
301}
302
Jingwen Chenc711fec2020-11-22 23:52:50 -0500303// VendorConfig represents the configuration for vendor-specific behavior.
Colin Cross9d34f352019-11-22 16:03:51 -0800304type VendorConfig soongconfig.SoongConfig
Dan Willemsen0fe78662018-03-26 12:41:18 -0700305
Jingwen Chenc711fec2020-11-22 23:52:50 -0500306// Definition of general build configuration for soong_build. Some of these
Jingwen Chenc4d91bc2020-11-24 22:59:26 -0500307// product configuration values are read from Kati-generated soong.variables.
Colin Cross1332b002015-04-07 17:11:30 -0700308type config struct {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500309 // Options configurable with soong.variables
Cole Faustf8231dd2023-04-21 17:37:11 -0700310 productVariables ProductVariables
Colin Cross3f40fa42015-01-30 17:27:36 -0800311
Dan Willemsen674dc7f2018-03-12 18:06:05 -0700312 // Only available on configs created by TestConfig
Cole Faustf8231dd2023-04-21 17:37:11 -0700313 TestProductVariables *ProductVariables
Dan Willemsen674dc7f2018-03-12 18:06:05 -0700314
Dan Willemsen87b17d12015-07-14 00:39:06 -0700315 ProductVariablesFileName string
316
Colin Cross0c66bc62021-07-20 09:47:41 -0700317 // BuildOS stores the OsType for the OS that the build is running on.
318 BuildOS OsType
319
320 // BuildArch stores the ArchType for the CPU that the build is running on.
321 BuildArch ArchType
322
Jaewoong Jung642916f2020-10-09 17:25:15 -0700323 Targets map[OsType][]Target
324 BuildOSTarget Target // the Target for tools run on the build machine
325 BuildOSCommonTarget Target // the Target for common (java) tools run on the build machine
326 AndroidCommonTarget Target // the Target for common modules for the Android device
327 AndroidFirstDeviceTarget Target // the first Target for modules for the Android device
Dan Willemsen218f6562015-07-08 18:13:11 -0700328
LaMont Jones99f18962024-10-17 11:50:44 -0700329 // Flags for Partial Compile, derived from SOONG_PARTIAL_COMPILE.
330 partialCompileFlags partialCompileFlags
331
Jingwen Chenc711fec2020-11-22 23:52:50 -0500332 // multilibConflicts for an ArchType is true if there is earlier configured
333 // device architecture with the same multilib value.
Colin Cross3b19f5d2019-09-17 14:45:31 -0700334 multilibConflicts map[ArchType]bool
335
Colin Cross9272ade2016-08-17 15:24:12 -0700336 deviceConfig *deviceConfig
337
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200338 outDir string // The output directory (usually out/)
339 soongOutDir string
Chris Parsons8f232a22020-06-23 17:37:05 -0400340 moduleListFile string // the path to the file which lists blueprint files to parse.
Colin Crossc1e86a32015-04-15 12:33:28 -0700341
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +0200342 runGoTests bool
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200343
Colin Cross6ccbc912017-10-10 23:07:38 -0700344 env map[string]string
Dan Willemsene7680ba2015-09-11 17:06:19 -0700345 envLock sync.Mutex
346 envDeps map[string]string
347 envFrozen bool
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800348
Jingwen Chencda22c92020-11-23 00:22:30 -0500349 // Changes behavior based on whether Kati runs after soong_build, or if soong_build
350 // runs standalone.
351 katiEnabled bool
Colin Cross1e7d3702016-08-24 15:25:47 -0700352
Colin Cross32616ed2017-09-05 21:56:44 -0700353 captureBuild bool // true for tests, saves build parameters for each module
354 ignoreEnvironment bool // true for tests, returns empty from all Getenv calls
Colin Crosscec81712017-07-13 14:43:27 -0700355
Colin Cross98be1bb2019-12-13 20:41:13 -0800356 fs pathtools.FileSystem
357 mockBpList string
358
Colin Crossb63d7b32023-12-07 16:54:51 -0800359 BuildMode SoongBuildMode
Jingwen Chen12b4c272021-03-10 02:05:59 -0500360
Colin Cross5e6a7972020-06-07 16:56:32 -0700361 // If testAllowNonExistentPaths is true then PathForSource and PathForModuleSrc won't error
362 // in tests when a path doesn't exist.
Pedro Loureiro5d190cc2021-02-15 15:41:33 +0000363 TestAllowNonExistentPaths bool
Colin Cross5e6a7972020-06-07 16:56:32 -0700364
Jingwen Chenc711fec2020-11-22 23:52:50 -0500365 // The list of files that when changed, must invalidate soong_build to
366 // regenerate build.ninja.
Colin Cross12129292020-10-29 18:23:58 -0700367 ninjaFileDepsSet sync.Map
368
Colin Cross9272ade2016-08-17 15:24:12 -0700369 OncePer
MarkDacekff851b82022-04-21 18:33:17 +0000370
Jihoon Kang2a929ad2023-06-08 19:02:07 +0000371 // If buildFromSourceStub is true then the Java API stubs are
372 // built from the source Java files, not the signature text files.
373 buildFromSourceStub bool
MarkDacekf47e1422023-04-19 16:47:36 +0000374
375 // If ensureAllowlistIntegrity is true, then the presence of any allowlisted
376 // modules that aren't mixed-built for at least one variant will cause a build
377 // failure
378 ensureAllowlistIntegrity bool
Colin Cross9272ade2016-08-17 15:24:12 -0700379}
380
LaMont Jones99f18962024-10-17 11:50:44 -0700381type partialCompileFlags struct {
382 // Is partial compilation enabled at all?
383 enabled bool
384
385 // Whether to use d8 instead of r8
386 use_d8 bool
387
388 // Add others as needed.
389}
390
Colin Cross9272ade2016-08-17 15:24:12 -0700391type deviceConfig struct {
Dan Willemsen00269f22017-07-06 16:59:48 -0700392 config *config
Colin Cross9272ade2016-08-17 15:24:12 -0700393 OncePer
Colin Cross3f40fa42015-01-30 17:27:36 -0800394}
395
Colin Cross485e5722015-08-27 13:28:01 -0700396type jsonConfigurable interface {
Colin Cross27385972015-09-18 10:57:10 -0700397 SetDefaultConfig()
Colin Cross485e5722015-08-27 13:28:01 -0700398}
Colin Cross3f40fa42015-01-30 17:27:36 -0800399
LaMont Jones99f18962024-10-17 11:50:44 -0700400// Parse SOONG_PARTIAL_COMPILE.
401//
402// SOONG_PARTIAL_COMPILE determines which features are enabled or disabled in
403// rule generation. Changing this environment variable causes reanalysis.
404//
405// SOONG_USE_PARTIAL_COMPILE determines whether or not we **use** PARTIAL_COMPILE.
406// Rule generation must support both cases, since changing it does not cause
407// reanalysis.
408//
409// The user-facing documentation shows:
410//
411// - empty or not set: "The current default state"
412// - "true" or "on": enable all stable partial compile features.
413// - "false" or "off": disable partial compile completely.
414//
415// What we actually allow is a comma separated list of tokens, whose first
416// character may be "+" (enable) or "-" (disable). If neither is present, "+"
417// is assumed. For example, "on,+use_d8" will enable partial compilation, and
418// additionally set the use_d8 flag (regardless of whether it is opt-in or
419// opt-out).
420//
421// To add a new feature to the list, add the field in the struct
422// `partialCompileFlags` above, and then add the name of the field in the
423// switch statement below.
LaMont Jones66e65862024-10-30 10:43:17 -0700424var defaultPartialCompileFlags = partialCompileFlags{
425 // Set any opt-out flags here. Opt-in flags are off by default.
426 enabled: false,
427}
428
429func (c *config) parsePartialCompileFlags(isEngBuild bool) (partialCompileFlags, error) {
430 if !isEngBuild {
431 return partialCompileFlags{}, nil
LaMont Jonesbef36af2024-10-30 01:03:28 +0000432 }
LaMont Jones99f18962024-10-17 11:50:44 -0700433 value := c.Getenv("SOONG_PARTIAL_COMPILE")
LaMont Jones99f18962024-10-17 11:50:44 -0700434 if value == "" {
LaMont Jones66e65862024-10-30 10:43:17 -0700435 return defaultPartialCompileFlags, nil
LaMont Jones99f18962024-10-17 11:50:44 -0700436 }
437
LaMont Jones66e65862024-10-30 10:43:17 -0700438 ret := defaultPartialCompileFlags
LaMont Jones99f18962024-10-17 11:50:44 -0700439 tokens := strings.Split(strings.ToLower(value), ",")
440 makeVal := func(state string, defaultValue bool) bool {
441 switch state {
442 case "":
443 return defaultValue
444 case "-":
445 return false
446 case "+":
447 return true
448 }
449 return false
450 }
451 for _, tok := range tokens {
452 var state string
453 if len(tok) == 0 {
454 continue
455 }
456 switch tok[0:1] {
457 case "":
458 // Ignore empty tokens.
459 continue
460 case "-", "+":
461 state = tok[0:1]
462 tok = tok[1:]
463 default:
464 // Treat `feature` as `+feature`.
465 state = "+"
466 }
467 switch tok {
468 case "true":
LaMont Jones66e65862024-10-30 10:43:17 -0700469 ret = defaultPartialCompileFlags
LaMont Jones99f18962024-10-17 11:50:44 -0700470 ret.enabled = true
471 case "false":
472 // Set everything to false.
473 ret = partialCompileFlags{}
474 case "enabled":
LaMont Jones66e65862024-10-30 10:43:17 -0700475 ret.enabled = makeVal(state, defaultPartialCompileFlags.enabled)
LaMont Jones99f18962024-10-17 11:50:44 -0700476 case "use_d8":
LaMont Jones66e65862024-10-30 10:43:17 -0700477 ret.use_d8 = makeVal(state, defaultPartialCompileFlags.use_d8)
LaMont Jones99f18962024-10-17 11:50:44 -0700478 default:
LaMont Jones66e65862024-10-30 10:43:17 -0700479 return partialCompileFlags{}, fmt.Errorf("Unknown SOONG_PARTIAL_COMPILE value: %v", tok)
LaMont Jones99f18962024-10-17 11:50:44 -0700480 }
481 }
482 return ret, nil
483}
484
Colin Cross485e5722015-08-27 13:28:01 -0700485func loadConfig(config *config) error {
Colin Cross988414c2020-01-11 01:11:46 +0000486 return loadFromConfigFile(&config.productVariables, absolutePath(config.ProductVariablesFileName))
Colin Cross485e5722015-08-27 13:28:01 -0700487}
488
Cole Faustd92430e2024-02-07 01:02:04 +0000489// Checks if the string is a valid go identifier. This is equivalent to blueprint's definition
490// of an identifier, so it will match the same identifiers as those that can be used in bp files.
491func isGoIdentifier(ident string) bool {
492 for i, r := range ident {
493 valid := r == '_' || unicode.IsLetter(r) || unicode.IsDigit(r) && i > 0
494 if !valid {
495 return false
496 }
497 }
498 return len(ident) > 0
499}
500
Jingwen Chenc711fec2020-11-22 23:52:50 -0500501// loadFromConfigFile loads and decodes configuration options from a JSON file
502// in the current working directory.
Cole Faustf8231dd2023-04-21 17:37:11 -0700503func loadFromConfigFile(configurable *ProductVariables, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800504 // Try to open the file
Colin Cross485e5722015-08-27 13:28:01 -0700505 configFileReader, err := os.Open(filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800506 defer configFileReader.Close()
507 if os.IsNotExist(err) {
508 // Need to create a file, so that blueprint & ninja don't get in
509 // a dependency tracking loop.
510 // Make a file-configurable-options with defaults, write it out using
511 // a json writer.
Colin Cross27385972015-09-18 10:57:10 -0700512 configurable.SetDefaultConfig()
513 err = saveToConfigFile(configurable, filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800514 if err != nil {
515 return err
516 }
Colin Cross15cd21a2018-02-27 11:26:02 -0800517 } else if err != nil {
518 return fmt.Errorf("config file: could not open %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800519 } else {
520 // Make a decoder for it
521 jsonDecoder := json.NewDecoder(configFileReader)
Cole Fauste1129b82024-06-04 11:10:11 -0700522 jsonDecoder.DisallowUnknownFields()
Colin Cross485e5722015-08-27 13:28:01 -0700523 err = jsonDecoder.Decode(configurable)
Colin Cross3f40fa42015-01-30 17:27:36 -0800524 if err != nil {
Colin Cross15cd21a2018-02-27 11:26:02 -0800525 return fmt.Errorf("config file: %s did not parse correctly: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800526 }
527 }
528
Liz Kammer09f947d2021-05-12 14:51:49 -0400529 if Bool(configurable.GcovCoverage) && Bool(configurable.ClangCoverage) {
530 return fmt.Errorf("GcovCoverage and ClangCoverage cannot both be set")
531 }
532
533 configurable.Native_coverage = proptools.BoolPtr(
534 Bool(configurable.GcovCoverage) ||
535 Bool(configurable.ClangCoverage))
536
Cole Faustd92430e2024-02-07 01:02:04 +0000537 // The go scanner's definition of identifiers is c-style identifiers, but allowing unicode's
538 // definition of letters and digits. This is the same scanner that blueprint uses, so it
539 // will allow the same identifiers as are valid in bp files.
540 for namespace := range configurable.VendorVars {
541 if !isGoIdentifier(namespace) {
542 return fmt.Errorf("soong config namespaces must be valid identifiers: %q", namespace)
543 }
544 for variable := range configurable.VendorVars[namespace] {
545 if !isGoIdentifier(variable) {
546 return fmt.Errorf("soong config variables must be valid identifiers: %q", variable)
547 }
548 }
549 }
550
Yuntao Xu402e9b02021-08-09 15:44:44 -0700551 // when Platform_sdk_final is true (or PLATFORM_VERSION_CODENAME is REL), use Platform_sdk_version;
552 // if false (pre-released version, for example), use Platform_sdk_codename.
553 if Bool(configurable.Platform_sdk_final) {
554 if configurable.Platform_sdk_version != nil {
555 configurable.Platform_sdk_version_or_codename =
556 proptools.StringPtr(strconv.Itoa(*(configurable.Platform_sdk_version)))
557 } else {
558 return fmt.Errorf("Platform_sdk_version cannot be pointed by a NULL pointer")
559 }
560 } else {
561 configurable.Platform_sdk_version_or_codename =
562 proptools.StringPtr(String(configurable.Platform_sdk_codename))
563 }
564
Cole Faustad186492024-06-14 14:13:54 -0700565 return nil
Colin Cross3f40fa42015-01-30 17:27:36 -0800566}
567
Colin Crossd8f20142016-11-03 09:43:26 -0700568// atomically writes the config file in case two copies of soong_build are running simultaneously
569// (for example, docs generation and ninja manifest generation)
Cole Faustf8231dd2023-04-21 17:37:11 -0700570func saveToConfigFile(config *ProductVariables, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800571 data, err := json.MarshalIndent(&config, "", " ")
572 if err != nil {
573 return fmt.Errorf("cannot marshal config data: %s", err.Error())
574 }
575
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800576 f, err := os.CreateTemp(filepath.Dir(filename), "config")
Colin Cross3f40fa42015-01-30 17:27:36 -0800577 if err != nil {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500578 return fmt.Errorf("cannot create empty config file %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800579 }
Colin Crossd8f20142016-11-03 09:43:26 -0700580 defer os.Remove(f.Name())
581 defer f.Close()
Colin Cross3f40fa42015-01-30 17:27:36 -0800582
Colin Crossd8f20142016-11-03 09:43:26 -0700583 _, err = f.Write(data)
Colin Cross3f40fa42015-01-30 17:27:36 -0800584 if err != nil {
Colin Cross485e5722015-08-27 13:28:01 -0700585 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
586 }
587
Colin Crossd8f20142016-11-03 09:43:26 -0700588 _, err = f.WriteString("\n")
Colin Cross485e5722015-08-27 13:28:01 -0700589 if err != nil {
590 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800591 }
592
Colin Crossd8f20142016-11-03 09:43:26 -0700593 f.Close()
594 os.Rename(f.Name(), filename)
595
Colin Cross3f40fa42015-01-30 17:27:36 -0800596 return nil
597}
598
Colin Cross988414c2020-01-11 01:11:46 +0000599// NullConfig returns a mostly empty Config for use by standalone tools like dexpreopt_gen that
600// use the android package.
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200601func NullConfig(outDir, soongOutDir string) Config {
Colin Cross988414c2020-01-11 01:11:46 +0000602 return Config{
603 config: &config{
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200604 outDir: outDir,
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200605 soongOutDir: soongOutDir,
606 fs: pathtools.OsFs,
Colin Cross988414c2020-01-11 01:11:46 +0000607 },
608 }
609}
610
Jingwen Chenc711fec2020-11-22 23:52:50 -0500611// NewConfig creates a new Config object. The srcDir argument specifies the path
612// to the root source directory. It also loads the config file, if found.
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800613func NewConfig(cmdArgs CmdArgs, availableEnv map[string]string) (Config, error) {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500614 // Make a config with default options.
Colin Cross9272ade2016-08-17 15:24:12 -0700615 config := &config{
Kiyoung Kima37d9ba2023-04-19 13:13:45 +0900616 ProductVariablesFileName: cmdArgs.SoongVariables,
Dan Willemsen87b17d12015-07-14 00:39:06 -0700617
Lukacs T. Berki53b2f362021-04-12 14:04:24 +0200618 env: availableEnv,
Colin Cross6ccbc912017-10-10 23:07:38 -0700619
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800620 outDir: cmdArgs.OutDir,
621 soongOutDir: cmdArgs.SoongOutDir,
622 runGoTests: cmdArgs.RunGoTests,
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +0200623 multilibConflicts: make(map[ArchType]bool),
Colin Cross98be1bb2019-12-13 20:41:13 -0800624
Colin Crossb63d7b32023-12-07 16:54:51 -0800625 moduleListFile: cmdArgs.ModuleListFile,
626 fs: pathtools.NewOsFs(absSrcDir),
Chris Parsons9402ca82023-02-23 17:28:06 -0500627
Jihoon Kang2a929ad2023-06-08 19:02:07 +0000628 buildFromSourceStub: cmdArgs.BuildFromSourceStub,
Colin Cross68f55102015-03-25 14:43:57 -0700629 }
LaMont Jones66e65862024-10-30 10:43:17 -0700630 variant, ok := os.LookupEnv("TARGET_BUILD_VARIANT")
631 isEngBuild := !ok || variant == "eng"
Colin Cross3f40fa42015-01-30 17:27:36 -0800632
Dan Willemsen00269f22017-07-06 16:59:48 -0700633 config.deviceConfig = &deviceConfig{
Colin Cross9272ade2016-08-17 15:24:12 -0700634 config: config,
635 }
636
Liz Kammer7941b302020-07-28 13:27:34 -0700637 // Soundness check of the build and source directories. This won't catch strange
638 // configurations with symlinks, but at least checks the obvious case.
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800639 absBuildDir, err := filepath.Abs(cmdArgs.SoongOutDir)
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700640 if err != nil {
641 return Config{}, err
642 }
643
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200644 absSrcDir, err := filepath.Abs(".")
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700645 if err != nil {
646 return Config{}, err
647 }
648
649 if strings.HasPrefix(absSrcDir, absBuildDir) {
650 return Config{}, fmt.Errorf("Build dir must not contain source directory")
651 }
652
Colin Cross3f40fa42015-01-30 17:27:36 -0800653 // Load any configurable options from the configuration file
Colin Cross9272ade2016-08-17 15:24:12 -0700654 err = loadConfig(config)
Colin Cross3f40fa42015-01-30 17:27:36 -0800655 if err != nil {
Colin Crossc3c0a492015-04-10 15:43:55 -0700656 return Config{}, err
Colin Cross3f40fa42015-01-30 17:27:36 -0800657 }
658
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800659 KatiEnabledMarkerFile := filepath.Join(cmdArgs.SoongOutDir, ".soong.kati_enabled")
Jingwen Chencda22c92020-11-23 00:22:30 -0500660 if _, err := os.Stat(absolutePath(KatiEnabledMarkerFile)); err == nil {
661 config.katiEnabled = true
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800662 }
663
Colin Cross0c66bc62021-07-20 09:47:41 -0700664 determineBuildOS(config)
665
Jingwen Chenc711fec2020-11-22 23:52:50 -0500666 // Sets up the map of target OSes to the finer grained compilation targets
667 // that are configured from the product variables.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700668 targets, err := decodeTargetProductVariables(config)
Dan Willemsen218f6562015-07-08 18:13:11 -0700669 if err != nil {
670 return Config{}, err
671 }
672
LaMont Jones66e65862024-10-30 10:43:17 -0700673 config.partialCompileFlags, err = config.parsePartialCompileFlags(isEngBuild)
LaMont Jones99f18962024-10-17 11:50:44 -0700674 if err != nil {
675 return Config{}, err
676 }
677
Paul Duffin1356d8c2020-02-25 19:26:33 +0000678 // Make the CommonOS OsType available for all products.
679 targets[CommonOS] = []Target{commonTargetMap[CommonOS.Name]}
680
Dan Albert4098deb2016-10-19 14:04:41 -0700681 var archConfig []archConfig
Jingwen Chenc4d91bc2020-11-24 22:59:26 -0500682 if config.NdkAbis() {
Dan Albert4098deb2016-10-19 14:04:41 -0700683 archConfig = getNdkAbisConfig()
Martin Stjernholmc1ecc432019-11-15 15:00:31 +0000684 } else if config.AmlAbis() {
685 archConfig = getAmlAbisConfig()
Dan Albert4098deb2016-10-19 14:04:41 -0700686 }
687
688 if archConfig != nil {
Liz Kammerb7f33662022-02-28 14:16:16 -0500689 androidTargets, err := decodeAndroidArchSettings(archConfig)
Dan Willemsen322acaf2016-01-12 23:07:05 -0800690 if err != nil {
691 return Config{}, err
692 }
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700693 targets[Android] = androidTargets
Dan Willemsen322acaf2016-01-12 23:07:05 -0800694 }
695
Colin Cross3b19f5d2019-09-17 14:45:31 -0700696 multilib := make(map[string]bool)
697 for _, target := range targets[Android] {
698 if seen := multilib[target.Arch.ArchType.Multilib]; seen {
699 config.multilibConflicts[target.Arch.ArchType] = true
700 }
701 multilib[target.Arch.ArchType.Multilib] = true
702 }
703
Jingwen Chenc711fec2020-11-22 23:52:50 -0500704 // Map of OS to compilation targets.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700705 config.Targets = targets
Jingwen Chenc711fec2020-11-22 23:52:50 -0500706
707 // Compilation targets for host tools.
Colin Cross0c66bc62021-07-20 09:47:41 -0700708 config.BuildOSTarget = config.Targets[config.BuildOS][0]
709 config.BuildOSCommonTarget = getCommonTargets(config.Targets[config.BuildOS])[0]
Jingwen Chenc711fec2020-11-22 23:52:50 -0500710
711 // Compilation targets for Android.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700712 if len(config.Targets[Android]) > 0 {
713 config.AndroidCommonTarget = getCommonTargets(config.Targets[Android])[0]
Sam Delmericocc271e22022-06-01 15:45:02 +0000714 config.AndroidFirstDeviceTarget = FirstTarget(config.Targets[Android], "lib64", "lib32")[0]
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700715 }
Dan Willemsen218f6562015-07-08 18:13:11 -0700716
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500717 setBuildMode := func(arg string, mode SoongBuildMode) {
718 if arg != "" {
719 if config.BuildMode != AnalysisNoBazel {
720 fmt.Fprintf(os.Stderr, "buildMode is already set, illegal argument: %s", arg)
721 os.Exit(1)
722 }
723 config.BuildMode = mode
724 }
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800725 }
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500726 setBuildMode(cmdArgs.ModuleGraphFile, GenerateModuleGraph)
727 setBuildMode(cmdArgs.DocFile, GenerateDocFile)
MarkDacekd06db5d2022-11-29 00:47:59 +0000728
Jihoon Kangc1b04d62023-11-16 19:07:04 +0000729 config.productVariables.Build_from_text_stub = boolPtr(config.BuildFromTextStub())
730
Jingwen Chenc711fec2020-11-22 23:52:50 -0500731 return Config{config}, err
732}
Colin Cross988414c2020-01-11 01:11:46 +0000733
Colin Cross98be1bb2019-12-13 20:41:13 -0800734// mockFileSystem replaces all reads with accesses to the provided map of
735// filenames to contents stored as a byte slice.
736func (c *config) mockFileSystem(bp string, fs map[string][]byte) {
737 mockFS := map[string][]byte{}
738
739 if _, exists := mockFS["Android.bp"]; !exists {
740 mockFS["Android.bp"] = []byte(bp)
741 }
742
743 for k, v := range fs {
744 mockFS[k] = v
745 }
746
747 // no module list file specified; find every file named Blueprints or Android.bp
748 pathsToParse := []string{}
749 for candidate := range mockFS {
750 base := filepath.Base(candidate)
Lukacs T. Berkib838b0a2021-09-02 11:46:24 +0200751 if base == "Android.bp" {
Colin Cross98be1bb2019-12-13 20:41:13 -0800752 pathsToParse = append(pathsToParse, candidate)
753 }
754 }
755 if len(pathsToParse) < 1 {
756 panic(fmt.Sprintf("No Blueprint or Android.bp files found in mock filesystem: %v\n", mockFS))
757 }
758 mockFS[blueprint.MockModuleListFile] = []byte(strings.Join(pathsToParse, "\n"))
759
760 c.fs = pathtools.MockFs(mockFS)
761 c.mockBpList = blueprint.MockModuleListFile
762}
763
Lukacs T. Berkid1e3f1f2021-03-16 08:55:23 +0100764func (c *config) SetAllowMissingDependencies() {
765 c.productVariables.Allow_missing_dependencies = proptools.BoolPtr(true)
766}
767
Jingwen Chenc711fec2020-11-22 23:52:50 -0500768// BlueprintToolLocation returns the directory containing build system tools
769// from Blueprint, like soong_zip and merge_zips.
Lukacs T. Berkia806e412021-09-01 08:57:48 +0200770func (c *config) HostToolDir() string {
Colin Crossacfcc1f2021-10-25 15:40:32 -0700771 if c.KatiEnabled() {
772 return filepath.Join(c.outDir, "host", c.PrebuiltOS(), "bin")
773 } else {
774 return filepath.Join(c.soongOutDir, "host", c.PrebuiltOS(), "bin")
775 }
Dan Willemsenc2aa4a92016-05-26 15:13:03 -0700776}
777
Dan Willemsen60e62f02018-11-16 21:05:32 -0800778func (c *config) HostToolPath(ctx PathContext, tool string) Path {
Cole Faust3b703f32023-10-16 13:30:51 -0700779 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "bin", tool)
Colin Cross790ef352021-10-25 19:15:55 -0700780 return path
Dan Willemsen60e62f02018-11-16 21:05:32 -0800781}
782
Colin Cross790ef352021-10-25 19:15:55 -0700783func (c *config) HostJNIToolPath(ctx PathContext, lib string) Path {
Martin Stjernholm7260d062019-12-09 21:47:14 +0000784 ext := ".so"
785 if runtime.GOOS == "darwin" {
786 ext = ".dylib"
787 }
Cole Faust3b703f32023-10-16 13:30:51 -0700788 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "lib64", lib+ext)
Colin Cross790ef352021-10-25 19:15:55 -0700789 return path
Martin Stjernholm7260d062019-12-09 21:47:14 +0000790}
791
Colin Crossae5330a2021-11-03 13:31:22 -0700792func (c *config) HostJavaToolPath(ctx PathContext, tool string) Path {
Cole Faust3b703f32023-10-16 13:30:51 -0700793 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "framework", tool)
Colin Cross3e3eda62021-11-04 10:22:51 -0700794 return path
795}
796
Vinh Tran09581952023-05-16 16:03:20 -0400797func (c *config) HostCcSharedLibPath(ctx PathContext, lib string) Path {
798 libDir := "lib"
799 if ctx.Config().BuildArch.Multilib == "lib64" {
800 libDir = "lib64"
801 }
Cole Faust3b703f32023-10-16 13:30:51 -0700802 return pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, libDir, lib+".so")
Vinh Tran09581952023-05-16 16:03:20 -0400803}
804
Jingwen Chenc711fec2020-11-22 23:52:50 -0500805// PrebuiltOS returns the name of the host OS used in prebuilts directories.
Colin Cross1332b002015-04-07 17:11:30 -0700806func (c *config) PrebuiltOS() string {
Colin Cross3f40fa42015-01-30 17:27:36 -0800807 switch runtime.GOOS {
808 case "linux":
809 return "linux-x86"
810 case "darwin":
811 return "darwin-x86"
812 default:
813 panic("Unknown GOOS")
814 }
815}
816
817// GoRoot returns the path to the root directory of the Go toolchain.
Colin Cross1332b002015-04-07 17:11:30 -0700818func (c *config) GoRoot() string {
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200819 return fmt.Sprintf("prebuilts/go/%s", c.PrebuiltOS())
Colin Cross3f40fa42015-01-30 17:27:36 -0800820}
821
Jingwen Chenc711fec2020-11-22 23:52:50 -0500822// PrebuiltBuildTool returns the path to a tool in the prebuilts directory containing
823// checked-in tools, like Kati, Ninja or Toybox, for the current host OS.
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700824func (c *config) PrebuiltBuildTool(ctx PathContext, tool string) Path {
825 return PathForSource(ctx, "prebuilts/build-tools", c.PrebuiltOS(), "bin", tool)
826}
827
Jingwen Chenc711fec2020-11-22 23:52:50 -0500828// CpPreserveSymlinksFlags returns the host-specific flag for the cp(1) command
829// to preserve symlinks.
Colin Cross1332b002015-04-07 17:11:30 -0700830func (c *config) CpPreserveSymlinksFlags() string {
Colin Cross485e5722015-08-27 13:28:01 -0700831 switch runtime.GOOS {
Colin Cross3f40fa42015-01-30 17:27:36 -0800832 case "darwin":
833 return "-R"
834 case "linux":
835 return "-d"
836 default:
837 return ""
838 }
839}
Colin Cross68f55102015-03-25 14:43:57 -0700840
Colin Cross1332b002015-04-07 17:11:30 -0700841func (c *config) Getenv(key string) string {
Colin Cross68f55102015-03-25 14:43:57 -0700842 var val string
843 var exists bool
Colin Crossc1e86a32015-04-15 12:33:28 -0700844 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800845 defer c.envLock.Unlock()
846 if c.envDeps == nil {
847 c.envDeps = make(map[string]string)
848 }
Colin Cross68f55102015-03-25 14:43:57 -0700849 if val, exists = c.envDeps[key]; !exists {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700850 if c.envFrozen {
851 panic("Cannot access new environment variables after envdeps are frozen")
852 }
Colin Cross6ccbc912017-10-10 23:07:38 -0700853 val, _ = c.env[key]
Colin Cross68f55102015-03-25 14:43:57 -0700854 c.envDeps[key] = val
855 }
856 return val
857}
858
Colin Cross99d7c232016-11-23 16:52:04 -0800859func (c *config) GetenvWithDefault(key string, defaultValue string) string {
860 ret := c.Getenv(key)
861 if ret == "" {
862 return defaultValue
863 }
864 return ret
865}
866
867func (c *config) IsEnvTrue(key string) bool {
AdityaK19384102024-05-01 13:51:25 -0700868 value := strings.ToLower(c.Getenv(key))
Colin Cross99d7c232016-11-23 16:52:04 -0800869 return value == "1" || value == "y" || value == "yes" || value == "on" || value == "true"
870}
871
872func (c *config) IsEnvFalse(key string) bool {
AdityaK19384102024-05-01 13:51:25 -0700873 value := strings.ToLower(c.Getenv(key))
Colin Cross99d7c232016-11-23 16:52:04 -0800874 return value == "0" || value == "n" || value == "no" || value == "off" || value == "false"
875}
876
Sorin Basca253f8c02024-05-23 10:28:24 +0100877func (c *config) TargetsJava21() bool {
Sorin Basca37cc2712024-10-16 10:25:36 +0100878 return c.productVariables.GetBuildFlagBool("RELEASE_TARGET_JAVA_21")
Sorin Basca253f8c02024-05-23 10:28:24 +0100879}
880
Jingwen Chenc711fec2020-11-22 23:52:50 -0500881// EnvDeps returns the environment variables this build depends on. The first
882// call to this function blocks future reads from the environment.
Colin Cross1332b002015-04-07 17:11:30 -0700883func (c *config) EnvDeps() map[string]string {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700884 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800885 defer c.envLock.Unlock()
Dan Willemsene7680ba2015-09-11 17:06:19 -0700886 c.envFrozen = true
Colin Cross68f55102015-03-25 14:43:57 -0700887 return c.envDeps
888}
Colin Cross35cec122015-04-02 14:37:16 -0700889
Jingwen Chencda22c92020-11-23 00:22:30 -0500890func (c *config) KatiEnabled() bool {
891 return c.katiEnabled
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800892}
893
Cole Faust11edf552023-10-13 11:32:14 -0700894func (c *config) ProductVariables() ProductVariables {
895 return c.productVariables
896}
897
Nan Zhang581fd212018-01-10 16:06:12 -0800898func (c *config) BuildId() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800899 return String(c.productVariables.BuildId)
Nan Zhang581fd212018-01-10 16:06:12 -0800900}
901
Inseob Kim8fa54da2024-03-19 16:48:59 +0900902func (c *config) DisplayBuildNumber() bool {
903 return Bool(c.productVariables.DisplayBuildNumber)
904}
905
Inseob Kim2da72af2024-06-18 11:09:12 +0900906// BuildFingerprintFile returns the path to a text file containing metadata
907// representing the current build's fingerprint.
908//
909// Rules that want to reference the build fingerprint should read from this file
910// without depending on it. They will run whenever their other dependencies
911// require them to run and get the current build fingerprint. This ensures they
912// don't rebuild on every incremental build when the build number changes.
913func (c *config) BuildFingerprintFile(ctx PathContext) Path {
914 return PathForArbitraryOutput(ctx, "target", "product", c.DeviceName(), String(c.productVariables.BuildFingerprintFile))
915}
916
Jingwen Chenc711fec2020-11-22 23:52:50 -0500917// BuildNumberFile returns the path to a text file containing metadata
918// representing the current build's number.
919//
920// Rules that want to reference the build number should read from this file
921// without depending on it. They will run whenever their other dependencies
922// require them to run and get the current build number. This ensures they don't
923// rebuild on every incremental build when the build number changes.
Colin Cross2a2e0db2020-02-21 16:55:46 -0800924func (c *config) BuildNumberFile(ctx PathContext) Path {
925 return PathForOutput(ctx, String(c.productVariables.BuildNumberFile))
Nan Zhang581fd212018-01-10 16:06:12 -0800926}
927
Inseob Kim8fa54da2024-03-19 16:48:59 +0900928// BuildHostnameFile returns the path to a text file containing metadata
929// representing the current build's host name.
930func (c *config) BuildHostnameFile(ctx PathContext) Path {
931 return PathForOutput(ctx, String(c.productVariables.BuildHostnameFile))
932}
933
934// BuildThumbprintFile returns the path to a text file containing metadata
935// representing the current build's thumbprint.
936//
937// Rules that want to reference the build thumbprint should read from this file
938// without depending on it. They will run whenever their other dependencies
939// require them to run and get the current build thumbprint. This ensures they
940// don't rebuild on every incremental build when the build thumbprint changes.
941func (c *config) BuildThumbprintFile(ctx PathContext) Path {
942 return PathForArbitraryOutput(ctx, "target", "product", c.DeviceName(), String(c.productVariables.BuildThumbprintFile))
943}
944
Jingwen Chenc711fec2020-11-22 23:52:50 -0500945// DeviceName returns the name of the current device target.
Colin Cross35cec122015-04-02 14:37:16 -0700946// TODO: take an AndroidModuleContext to select the device name for multi-device builds
Colin Cross1332b002015-04-07 17:11:30 -0700947func (c *config) DeviceName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800948 return *c.productVariables.DeviceName
Colin Cross35cec122015-04-02 14:37:16 -0700949}
950
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000951// DeviceProduct returns the current product target. There could be multiple of
952// these per device type.
953//
Chris Parsonsef615e52022-08-18 22:04:11 -0400954// NOTE: Do not base conditional logic on this value. It may break product inheritance.
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000955func (c *config) DeviceProduct() string {
956 return *c.productVariables.DeviceProduct
957}
958
Cole Faustb85d1a12022-11-08 18:14:01 -0800959// HasDeviceProduct returns if the build has a product. A build will not
960// necessarily have a product when --skip-config is passed to soong, like it is
961// in prebuilts/build-tools/build-prebuilts.sh
962func (c *config) HasDeviceProduct() bool {
963 return c.productVariables.DeviceProduct != nil
964}
965
Inseob Kim8fa54da2024-03-19 16:48:59 +0900966func (c *config) DeviceAbi() []string {
967 return c.productVariables.DeviceAbi
968}
969
Anton Hansson53c88442019-03-18 15:53:16 +0000970func (c *config) DeviceResourceOverlays() []string {
971 return c.productVariables.DeviceResourceOverlays
972}
973
974func (c *config) ProductResourceOverlays() []string {
975 return c.productVariables.ProductResourceOverlays
Colin Cross30e076a2015-04-13 13:58:27 -0700976}
977
Inseob Kim8fa54da2024-03-19 16:48:59 +0900978func (c *config) PlatformDisplayVersionName() string {
979 return String(c.productVariables.Platform_display_version_name)
980}
981
Colin Crossbfd347d2018-05-09 11:11:35 -0700982func (c *config) PlatformVersionName() string {
983 return String(c.productVariables.Platform_version_name)
984}
985
Dan Albert4f378d72020-07-23 17:32:15 -0700986func (c *config) PlatformSdkVersion() ApiLevel {
987 return uncheckedFinalApiLevel(*c.productVariables.Platform_sdk_version)
Colin Cross30e076a2015-04-13 13:58:27 -0700988}
989
Cole Faust37d27c42023-04-12 10:27:45 -0700990func (c *config) RawPlatformSdkVersion() *int {
991 return c.productVariables.Platform_sdk_version
992}
993
Mu-Le Lee5e047532022-07-27 02:32:03 +0000994func (c *config) PlatformSdkFinal() bool {
995 return Bool(c.productVariables.Platform_sdk_final)
996}
997
Colin Crossd09b0b62018-04-18 11:06:47 -0700998func (c *config) PlatformSdkCodename() string {
999 return String(c.productVariables.Platform_sdk_codename)
1000}
1001
Anton Hansson97d0bae2022-02-16 16:15:10 +00001002func (c *config) PlatformSdkExtensionVersion() int {
1003 return *c.productVariables.Platform_sdk_extension_version
1004}
1005
1006func (c *config) PlatformBaseSdkExtensionVersion() int {
1007 return *c.productVariables.Platform_base_sdk_extension_version
1008}
1009
Colin Cross092c9da2019-04-02 22:56:43 -07001010func (c *config) PlatformSecurityPatch() string {
1011 return String(c.productVariables.Platform_security_patch)
1012}
1013
1014func (c *config) PlatformPreviewSdkVersion() string {
1015 return String(c.productVariables.Platform_preview_sdk_version)
1016}
1017
1018func (c *config) PlatformMinSupportedTargetSdkVersion() string {
Linus Tufvessonba270c52024-04-12 13:06:22 +02001019 var val, ok = c.productVariables.BuildFlags["RELEASE_PLATFORM_MIN_SUPPORTED_TARGET_SDK_VERSION"]
1020 if !ok {
1021 return ""
1022 }
1023 return val
Colin Cross092c9da2019-04-02 22:56:43 -07001024}
1025
1026func (c *config) PlatformBaseOS() string {
1027 return String(c.productVariables.Platform_base_os)
1028}
1029
Inseob Kim4f1f3d92022-04-25 18:23:58 +09001030func (c *config) PlatformVersionLastStable() string {
1031 return String(c.productVariables.Platform_version_last_stable)
1032}
1033
Jiyong Park37073842022-06-21 10:13:42 +09001034func (c *config) PlatformVersionKnownCodenames() string {
1035 return String(c.productVariables.Platform_version_known_codenames)
1036}
1037
Dan Albert1a246272020-07-06 14:49:35 -07001038func (c *config) MinSupportedSdkVersion() ApiLevel {
Dan Albert6bfb6bb2022-08-17 20:11:57 +00001039 return uncheckedFinalApiLevel(21)
Dan Albert1a246272020-07-06 14:49:35 -07001040}
1041
1042func (c *config) FinalApiLevels() []ApiLevel {
1043 var levels []ApiLevel
Dan Albert4f378d72020-07-23 17:32:15 -07001044 for i := 1; i <= c.PlatformSdkVersion().FinalOrFutureInt(); i++ {
Dan Albert1a246272020-07-06 14:49:35 -07001045 levels = append(levels, uncheckedFinalApiLevel(i))
1046 }
1047 return levels
1048}
1049
1050func (c *config) PreviewApiLevels() []ApiLevel {
1051 var levels []ApiLevel
Dan Albertf93ea132023-10-05 20:40:46 +00001052 i := 0
1053 for _, codename := range c.PlatformVersionActiveCodenames() {
1054 if codename == "REL" {
1055 continue
1056 }
1057
Dan Albert1a246272020-07-06 14:49:35 -07001058 levels = append(levels, ApiLevel{
1059 value: codename,
1060 number: i,
1061 isPreview: true,
1062 })
Dan Albertf93ea132023-10-05 20:40:46 +00001063 i++
Dan Albert1a246272020-07-06 14:49:35 -07001064 }
1065 return levels
1066}
1067
satayevcca4ab72021-11-30 12:33:55 +00001068func (c *config) LatestPreviewApiLevel() ApiLevel {
1069 level := NoneApiLevel
1070 for _, l := range c.PreviewApiLevels() {
1071 if l.GreaterThan(level) {
1072 level = l
1073 }
1074 }
1075 return level
1076}
1077
Dan Albert1a246272020-07-06 14:49:35 -07001078func (c *config) AllSupportedApiLevels() []ApiLevel {
1079 var levels []ApiLevel
1080 levels = append(levels, c.FinalApiLevels()...)
1081 return append(levels, c.PreviewApiLevels()...)
Dan Albertf5415d72017-08-17 16:19:59 -07001082}
1083
Jingwen Chenc711fec2020-11-22 23:52:50 -05001084// DefaultAppTargetSdk returns the API level that platform apps are targeting.
1085// This converts a codename to the exact ApiLevel it represents.
Dan Albert4f378d72020-07-23 17:32:15 -07001086func (c *config) DefaultAppTargetSdk(ctx EarlyModuleContext) ApiLevel {
Colin Crossd09b0b62018-04-18 11:06:47 -07001087 if Bool(c.productVariables.Platform_sdk_final) {
1088 return c.PlatformSdkVersion()
Colin Crossd09b0b62018-04-18 11:06:47 -07001089 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001090 codename := c.PlatformSdkCodename()
Jiyong Park3a00e3d2023-03-27 17:39:48 +09001091 hostOnlyBuild := c.productVariables.DeviceArch == nil
Jingwen Chenc711fec2020-11-22 23:52:50 -05001092 if codename == "" {
Jiyong Park3a00e3d2023-03-27 17:39:48 +09001093 // There are some host-only builds (those are invoked by build-prebuilts.sh) which
1094 // don't set platform sdk codename. Platform sdk codename makes sense only when we
1095 // are building the platform. So we don't enforce the below panic for the host-only
1096 // builds.
1097 if hostOnlyBuild {
1098 return NoneApiLevel
1099 }
1100 panic("Platform_sdk_codename must be set")
Jingwen Chenc711fec2020-11-22 23:52:50 -05001101 }
1102 if codename == "REL" {
1103 panic("Platform_sdk_codename should not be REL when Platform_sdk_final is true")
1104 }
1105 return ApiLevelOrPanic(ctx, codename)
Colin Crossd09b0b62018-04-18 11:06:47 -07001106}
1107
LaMont Jones99f18962024-10-17 11:50:44 -07001108func (c *config) PartialCompileFlags() partialCompileFlags {
1109 return c.partialCompileFlags
1110}
1111
Colin Cross3bc7ffa2017-11-22 16:19:37 -08001112func (c *config) AppsDefaultVersionName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001113 return String(c.productVariables.AppsDefaultVersionName)
Colin Cross3bc7ffa2017-11-22 16:19:37 -08001114}
1115
Dan Albert31384de2017-07-28 12:39:46 -07001116// Codenames that are active in the current lunch target.
1117func (c *config) PlatformVersionActiveCodenames() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001118 return c.productVariables.Platform_version_active_codenames
Dan Albert31384de2017-07-28 12:39:46 -07001119}
1120
Dan Albert8c7a9942023-03-27 20:34:01 +00001121// All unreleased codenames.
1122func (c *config) PlatformVersionAllPreviewCodenames() []string {
1123 return c.productVariables.Platform_version_all_preview_codenames
1124}
1125
Colin Crossface4e42017-10-30 17:32:15 -07001126func (c *config) ProductAAPTConfig() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001127 return c.productVariables.AAPTConfig
Colin Cross30e076a2015-04-13 13:58:27 -07001128}
1129
Colin Crossface4e42017-10-30 17:32:15 -07001130func (c *config) ProductAAPTPreferredConfig() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001131 return String(c.productVariables.AAPTPreferredConfig)
Colin Cross30e076a2015-04-13 13:58:27 -07001132}
1133
Colin Crossface4e42017-10-30 17:32:15 -07001134func (c *config) ProductAAPTCharacteristics() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001135 return String(c.productVariables.AAPTCharacteristics)
Colin Crossface4e42017-10-30 17:32:15 -07001136}
1137
1138func (c *config) ProductAAPTPrebuiltDPI() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001139 return c.productVariables.AAPTPrebuiltDPI
Colin Cross30e076a2015-04-13 13:58:27 -07001140}
1141
Dan Willemsen34cc69e2015-09-23 15:26:20 -07001142func (c *config) DefaultAppCertificateDir(ctx PathContext) SourcePath {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001143 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -08001144 if defaultCert != "" {
1145 return PathForSource(ctx, filepath.Dir(defaultCert))
Colin Cross61ae0b72017-12-01 17:16:02 -08001146 }
Inseob Kim8fa54da2024-03-19 16:48:59 +09001147 return PathForSource(ctx, testKeyDir)
Colin Cross30e076a2015-04-13 13:58:27 -07001148}
1149
Colin Crosse1731a52017-12-14 11:22:55 -08001150func (c *config) DefaultAppCertificate(ctx PathContext) (pem, key SourcePath) {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001151 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -08001152 if defaultCert != "" {
Colin Crosse1731a52017-12-14 11:22:55 -08001153 return PathForSource(ctx, defaultCert+".x509.pem"), PathForSource(ctx, defaultCert+".pk8")
Colin Cross61ae0b72017-12-01 17:16:02 -08001154 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001155 defaultDir := c.DefaultAppCertificateDir(ctx)
1156 return defaultDir.Join(ctx, "testkey.x509.pem"), defaultDir.Join(ctx, "testkey.pk8")
Colin Cross30e076a2015-04-13 13:58:27 -07001157}
Colin Cross6ff51382015-12-17 16:39:19 -08001158
Justin Yun635e7882024-07-04 14:50:57 +09001159func (c *config) ExtraOtaKeys(ctx PathContext, recovery bool) []SourcePath {
1160 var otaKeys []string
1161 if recovery {
1162 otaKeys = c.productVariables.ExtraOtaRecoveryKeys
1163 } else {
1164 otaKeys = c.productVariables.ExtraOtaKeys
1165 }
1166
1167 otaPaths := make([]SourcePath, len(otaKeys))
1168 for i, key := range otaKeys {
1169 otaPaths[i] = PathForSource(ctx, key+".x509.pem")
1170 }
1171
1172 return otaPaths
1173}
1174
Inseob Kim8fa54da2024-03-19 16:48:59 +09001175func (c *config) BuildKeys() string {
1176 defaultCert := String(c.productVariables.DefaultAppCertificate)
1177 if defaultCert == "" || defaultCert == filepath.Join(testKeyDir, "testkey") {
1178 return "test-keys"
1179 }
1180 return "dev-keys"
1181}
1182
Jiyong Park9335a262018-12-24 11:31:58 +09001183func (c *config) ApexKeyDir(ctx ModuleContext) SourcePath {
1184 // TODO(b/121224311): define another variable such as TARGET_APEX_KEY_OVERRIDE
1185 defaultCert := String(c.productVariables.DefaultAppCertificate)
Inseob Kim8fa54da2024-03-19 16:48:59 +09001186 if defaultCert == "" || filepath.Dir(defaultCert) == testKeyDir {
Jiyong Park9335a262018-12-24 11:31:58 +09001187 // When defaultCert is unset or is set to the testkeys path, use the APEX keys
1188 // that is under the module dir
Colin Cross07e51612019-03-05 12:46:40 -08001189 return pathForModuleSrc(ctx)
Jiyong Park9335a262018-12-24 11:31:58 +09001190 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001191 // If not, APEX keys are under the specified directory
1192 return PathForSource(ctx, filepath.Dir(defaultCert))
Jiyong Park9335a262018-12-24 11:31:58 +09001193}
1194
Inseob Kim80fa7982022-08-12 21:36:25 +09001195// Certificate for the NetworkStack sepolicy context
1196func (c *config) MainlineSepolicyDevCertificatesDir(ctx ModuleContext) SourcePath {
1197 cert := String(c.productVariables.MainlineSepolicyDevCertificates)
1198 if cert != "" {
1199 return PathForSource(ctx, cert)
1200 }
1201 return c.DefaultAppCertificateDir(ctx)
1202}
1203
Jingwen Chenc711fec2020-11-22 23:52:50 -05001204// AllowMissingDependencies configures Blueprint/Soong to not fail when modules
1205// are configured to depend on non-existent modules. Note that this does not
1206// affect missing input dependencies at the Ninja level.
Colin Cross6ff51382015-12-17 16:39:19 -08001207func (c *config) AllowMissingDependencies() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001208 return Bool(c.productVariables.Allow_missing_dependencies)
Colin Cross6ff51382015-12-17 16:39:19 -08001209}
Dan Willemsen322acaf2016-01-12 23:07:05 -08001210
Jeongik Cha816a23a2020-07-08 01:09:23 +09001211// Returns true if a full platform source tree cannot be assumed.
Colin Crossfc3674a2017-09-18 17:41:52 -07001212func (c *config) UnbundledBuild() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001213 return Bool(c.productVariables.Unbundled_build)
Colin Crossfc3674a2017-09-18 17:41:52 -07001214}
1215
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +01001216// Returns true if building apps that aren't bundled with the platform.
1217// UnbundledBuild() is always true when this is true.
1218func (c *config) UnbundledBuildApps() bool {
Cole Faust701ca252021-11-23 19:02:08 -08001219 return len(c.productVariables.Unbundled_build_apps) > 0
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +01001220}
1221
Jeongik Cha4b073cd2021-06-08 11:35:00 +09001222// Returns true if building image that aren't bundled with the platform.
1223// UnbundledBuild() is always true when this is true.
1224func (c *config) UnbundledBuildImage() bool {
1225 return Bool(c.productVariables.Unbundled_build_image)
1226}
1227
Jeongik Cha816a23a2020-07-08 01:09:23 +09001228// Returns true if building modules against prebuilt SDKs.
1229func (c *config) AlwaysUsePrebuiltSdks() bool {
1230 return Bool(c.productVariables.Always_use_prebuilt_sdks)
Colin Cross1f367bf2018-12-18 22:46:24 -08001231}
1232
Colin Cross126a25c2017-10-31 13:55:34 -07001233func (c *config) MinimizeJavaDebugInfo() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001234 return Bool(c.productVariables.MinimizeJavaDebugInfo) && !Bool(c.productVariables.Eng)
Colin Cross126a25c2017-10-31 13:55:34 -07001235}
1236
Colin Crossed064c02018-09-05 16:28:13 -07001237func (c *config) Debuggable() bool {
1238 return Bool(c.productVariables.Debuggable)
1239}
1240
Jaewoong Jung1d6eb682018-11-29 15:08:44 -08001241func (c *config) Eng() bool {
1242 return Bool(c.productVariables.Eng)
1243}
1244
Inseob Kim8fa54da2024-03-19 16:48:59 +09001245func (c *config) BuildType() string {
1246 return String(c.productVariables.BuildType)
1247}
1248
Colin Crossc53c37f2021-12-08 15:42:22 -08001249// DevicePrimaryArchType returns the ArchType for the first configured device architecture, or
1250// Common if there are no device architectures.
Jiyong Park8d52f862018-07-07 18:02:07 +09001251func (c *config) DevicePrimaryArchType() ArchType {
Colin Crossc53c37f2021-12-08 15:42:22 -08001252 if androidTargets := c.Targets[Android]; len(androidTargets) > 0 {
1253 return androidTargets[0].Arch.ArchType
1254 }
1255 return Common
Jiyong Park8d52f862018-07-07 18:02:07 +09001256}
1257
Colin Cross16b23492016-01-06 14:41:07 -08001258func (c *config) SanitizeHost() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001259 return append([]string(nil), c.productVariables.SanitizeHost...)
Colin Cross16b23492016-01-06 14:41:07 -08001260}
1261
1262func (c *config) SanitizeDevice() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001263 return append([]string(nil), c.productVariables.SanitizeDevice...)
Colin Cross23ae82a2016-11-02 14:34:39 -07001264}
1265
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -07001266func (c *config) SanitizeDeviceDiag() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001267 return append([]string(nil), c.productVariables.SanitizeDeviceDiag...)
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -07001268}
1269
Colin Cross23ae82a2016-11-02 14:34:39 -07001270func (c *config) SanitizeDeviceArch() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001271 return append([]string(nil), c.productVariables.SanitizeDeviceArch...)
Colin Cross16b23492016-01-06 14:41:07 -08001272}
Colin Crossa1ad8d12016-06-01 17:09:44 -07001273
Vishwath Mohan1b017a72017-01-19 13:54:55 -08001274func (c *config) EnableCFI() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001275 if c.productVariables.EnableCFI == nil {
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -08001276 return true
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -08001277 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001278 return *c.productVariables.EnableCFI
Vishwath Mohan1b017a72017-01-19 13:54:55 -08001279}
1280
Kostya Kortchinskyd5275c82019-02-01 08:42:56 -08001281func (c *config) DisableScudo() bool {
1282 return Bool(c.productVariables.DisableScudo)
1283}
1284
Colin Crossa1ad8d12016-06-01 17:09:44 -07001285func (c *config) Android64() bool {
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001286 for _, t := range c.Targets[Android] {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001287 if t.Arch.ArchType.Multilib == "lib64" {
1288 return true
1289 }
1290 }
1291
1292 return false
1293}
Colin Cross9272ade2016-08-17 15:24:12 -07001294
Colin Cross9d45bb72016-08-29 16:14:13 -07001295func (c *config) UseGoma() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001296 return Bool(c.productVariables.UseGoma)
Colin Cross9d45bb72016-08-29 16:14:13 -07001297}
1298
Taylor Santiago3c16e612024-05-30 14:41:31 -07001299func (c *config) UseABFS() bool {
1300 return Bool(c.productVariables.UseABFS)
1301}
1302
Ramy Medhatbbf25672019-07-17 12:30:04 +00001303func (c *config) UseRBE() bool {
1304 return Bool(c.productVariables.UseRBE)
1305}
1306
Ramy Medhat8ea054a2020-01-27 14:19:44 -05001307func (c *config) UseRBEJAVAC() bool {
1308 return Bool(c.productVariables.UseRBEJAVAC)
1309}
1310
1311func (c *config) UseRBER8() bool {
1312 return Bool(c.productVariables.UseRBER8)
1313}
1314
1315func (c *config) UseRBED8() bool {
1316 return Bool(c.productVariables.UseRBED8)
1317}
1318
Colin Cross8b8bec32019-11-15 13:18:43 -08001319func (c *config) UseRemoteBuild() bool {
1320 return c.UseGoma() || c.UseRBE()
1321}
1322
Colin Cross66548102018-06-19 22:47:35 -07001323func (c *config) RunErrorProne() bool {
Cole Faust30d2b192024-12-18 13:32:07 -08001324 return c.IsEnvTrue("RUN_ERROR_PRONE") || c.RunErrorProneInline()
Colin Cross66548102018-06-19 22:47:35 -07001325}
1326
Cole Faust30d2b192024-12-18 13:32:07 -08001327// Returns if the errorprone build should be run "inline", that is, using errorprone as part
1328// of the main javac compilation instead of its own separate compilation. This is good for CI
1329// but bad for local development, because if you toggle errorprone+inline on/off it will repeatedly
1330// clobber java files from the old configuration.
Cole Faustf3240f42024-12-11 16:49:18 -08001331func (c *config) RunErrorProneInline() bool {
Cole Faust30d2b192024-12-18 13:32:07 -08001332 value := strings.ToLower(c.Getenv("RUN_ERROR_PRONE"))
1333 return c.IsEnvTrue("RUN_ERROR_PRONE_INLINE") || value == "inline"
Cole Faustf3240f42024-12-11 16:49:18 -08001334}
1335
Jingwen Chenc711fec2020-11-22 23:52:50 -05001336// XrefCorpusName returns the Kythe cross-reference corpus name.
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001337func (c *config) XrefCorpusName() string {
1338 return c.Getenv("XREF_CORPUS")
1339}
1340
Jingwen Chenc711fec2020-11-22 23:52:50 -05001341// XrefCuEncoding returns the compilation unit encoding to use for Kythe code
1342// xrefs. Can be 'json' (default), 'proto' or 'all'.
Sasha Smundak6c2d4f92020-01-09 17:34:23 -08001343func (c *config) XrefCuEncoding() string {
1344 if enc := c.Getenv("KYTHE_KZIP_ENCODING"); enc != "" {
1345 return enc
1346 }
1347 return "json"
1348}
1349
Sasha Smundakb0addaf2021-02-16 10:39:40 -08001350// XrefCuJavaSourceMax returns the maximum number of the Java source files
1351// in a single compilation unit
1352const xrefJavaSourceFileMaxDefault = "1000"
1353
1354func (c Config) XrefCuJavaSourceMax() string {
1355 v := c.Getenv("KYTHE_JAVA_SOURCE_BATCH_SIZE")
1356 if v == "" {
1357 return xrefJavaSourceFileMaxDefault
1358 }
1359 if _, err := strconv.ParseUint(v, 0, 0); err != nil {
1360 fmt.Fprintf(os.Stderr,
1361 "bad KYTHE_JAVA_SOURCE_BATCH_SIZE value: %s, will use %s",
1362 err, xrefJavaSourceFileMaxDefault)
1363 return xrefJavaSourceFileMaxDefault
1364 }
1365 return v
1366
1367}
1368
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001369func (c *config) EmitXrefRules() bool {
1370 return c.XrefCorpusName() != ""
1371}
1372
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001373func (c *config) ClangTidy() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001374 return Bool(c.productVariables.ClangTidy)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001375}
1376
1377func (c *config) TidyChecks() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001378 if c.productVariables.TidyChecks == nil {
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001379 return ""
1380 }
Dan Willemsen45133ac2018-03-09 21:22:06 -08001381 return *c.productVariables.TidyChecks
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001382}
1383
Colin Cross0f4e0d62016-07-27 10:56:55 -07001384func (c *config) LibartImgHostBaseAddress() string {
David Srbeckya4f336b2024-09-04 16:06:56 +01001385 return "0x70000000"
Colin Cross0f4e0d62016-07-27 10:56:55 -07001386}
1387
1388func (c *config) LibartImgDeviceBaseAddress() string {
Elliott Hughesda3a0712020-03-06 16:55:28 -08001389 return "0x70000000"
Colin Cross0f4e0d62016-07-27 10:56:55 -07001390}
1391
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001392func (c *config) ArtUseReadBarrier() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001393 return Bool(c.productVariables.ArtUseReadBarrier)
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001394}
1395
Jingwen Chenc711fec2020-11-22 23:52:50 -05001396// Enforce Runtime Resource Overlays for a module. RROs supersede static RROs,
1397// but some modules still depend on it.
1398//
1399// More info: https://source.android.com/devices/architecture/rros
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001400func (c *config) EnforceRROForModule(name string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001401 enforceList := c.productVariables.EnforceRROTargets
Jeongik Chacee5ba92021-02-19 12:11:51 +09001402
Roland Levillainf6cc2612020-07-09 16:58:14 +01001403 if len(enforceList) > 0 {
Yo Chiang4ebd06a2019-10-01 13:13:41 +08001404 if InList("*", enforceList) {
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001405 return true
1406 }
Colin Crossa74ca042019-01-31 14:31:51 -08001407 return InList(name, enforceList)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001408 }
1409 return false
1410}
Colin Crossc4441622024-09-18 14:55:49 -07001411
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001412func (c *config) EnforceRROExcludedOverlay(path string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001413 excluded := c.productVariables.EnforceRROExcludedOverlays
Roland Levillainf6cc2612020-07-09 16:58:14 +01001414 if len(excluded) > 0 {
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001415 return HasAnyPrefix(path, excluded)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001416 }
1417 return false
1418}
1419
Colin Crossc4441622024-09-18 14:55:49 -07001420func (c *config) EnforceRROGlobally() bool {
1421 enforceList := c.productVariables.EnforceRROTargets
1422 return InList("*", enforceList)
1423}
1424
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001425func (c *config) ExportedNamespaces() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001426 return append([]string(nil), c.productVariables.NamespacesToExport...)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001427}
1428
Sam Delmerico98a73292023-02-21 11:50:29 -05001429func (c *config) SourceRootDirs() []string {
1430 return c.productVariables.SourceRootDirs
1431}
1432
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001433func (c *config) HostStaticBinaries() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001434 return Bool(c.productVariables.HostStaticBinaries)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001435}
1436
Colin Cross5a0dcd52018-10-05 14:20:06 -07001437func (c *config) UncompressPrivAppDex() bool {
1438 return Bool(c.productVariables.UncompressPrivAppDex)
1439}
1440
1441func (c *config) ModulesLoadedByPrivilegedModules() []string {
1442 return c.productVariables.ModulesLoadedByPrivilegedModules
1443}
1444
Jingwen Chenc711fec2020-11-22 23:52:50 -05001445// DexpreoptGlobalConfigPath returns the path to the dexpreopt.config file in
1446// the output directory, if it was created during the product configuration
1447// phase by Kati.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001448func (c *config) DexpreoptGlobalConfigPath(ctx PathContext) OptionalPath {
Colin Cross988414c2020-01-11 01:11:46 +00001449 if c.productVariables.DexpreoptGlobalConfig == nil {
Jingwen Chenebb0b572020-11-02 00:24:57 -05001450 return OptionalPathForPath(nil)
1451 }
1452 return OptionalPathForPath(
1453 pathForBuildToolDep(ctx, *c.productVariables.DexpreoptGlobalConfig))
1454}
1455
Jingwen Chenc711fec2020-11-22 23:52:50 -05001456// DexpreoptGlobalConfig returns the raw byte contents of the dexpreopt global
1457// configuration. Since the configuration file was created by Kati during
1458// product configuration (externally of soong_build), it's not tracked, so we
1459// also manually add a Ninja file dependency on the configuration file to the
1460// rule that creates the main build.ninja file. This ensures that build.ninja is
1461// regenerated correctly if dexpreopt.config changes.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001462func (c *config) DexpreoptGlobalConfig(ctx PathContext) ([]byte, error) {
1463 path := c.DexpreoptGlobalConfigPath(ctx)
1464 if !path.Valid() {
Colin Cross988414c2020-01-11 01:11:46 +00001465 return nil, nil
1466 }
Jingwen Chenebb0b572020-11-02 00:24:57 -05001467 ctx.AddNinjaFileDeps(path.String())
Sasha Smundakaf5ca922022-12-12 21:23:34 -08001468 return os.ReadFile(absolutePath(path.String()))
Colin Cross43f08db2018-11-12 10:13:39 -08001469}
1470
Inseob Kim7b85eeb2021-03-23 20:52:24 +09001471func (c *deviceConfig) WithDexpreopt() bool {
1472 return c.config.productVariables.WithDexpreopt
1473}
1474
Colin Cross662d6142022-11-03 20:38:01 -07001475func (c *config) FrameworksBaseDirExists(ctx PathGlobContext) bool {
Colin Cross5a756a62021-03-16 16:34:46 -07001476 return ExistentPathForSource(ctx, "frameworks", "base", "Android.bp").Valid()
David Brazdil91b4e3e2019-01-23 21:04:05 +00001477}
1478
Colin Cross3b19f5d2019-09-17 14:45:31 -07001479func (c *config) HasMultilibConflict(arch ArchType) bool {
1480 return c.multilibConflicts[arch]
1481}
1482
Sasha Smundakaf5ca922022-12-12 21:23:34 -08001483func (c *config) PrebuiltHiddenApiDir(_ PathContext) string {
Bill Peckhambae47492021-01-08 09:34:44 -08001484 return String(c.productVariables.PrebuiltHiddenApiDir)
1485}
1486
Justin Yun41cbb5e2023-11-29 17:58:16 +09001487func (c *config) VendorApiLevel() string {
1488 return String(c.productVariables.VendorApiLevel)
1489}
1490
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001491func (c *config) PrevVendorApiLevel() string {
1492 vendorApiLevel, err := strconv.Atoi(c.VendorApiLevel())
1493 if err != nil {
1494 panic(fmt.Errorf("Cannot parse vendor API level %s to an integer: %s",
1495 c.VendorApiLevel(), err))
1496 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001497 // The version before trunk stable is 34.
1498 if vendorApiLevel == 202404 {
1499 return "34"
1500 }
Hsin-Yi Chen890e7722024-03-05 15:56:44 +08001501 if vendorApiLevel >= 1 && vendorApiLevel <= 34 {
1502 return strconv.Itoa(vendorApiLevel - 1)
1503 }
1504 if vendorApiLevel < 202404 || vendorApiLevel%100 != 4 {
1505 panic("Unknown vendor API level " + c.VendorApiLevel())
1506 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001507 return strconv.Itoa(vendorApiLevel - 100)
1508}
1509
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001510func IsTrunkStableVendorApiLevel(level string) bool {
1511 levelInt, err := strconv.Atoi(level)
1512 return err == nil && levelInt >= 202404
1513}
1514
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001515func (c *config) VendorApiLevelFrozen() bool {
1516 return c.productVariables.GetBuildFlagBool("RELEASE_BOARD_API_LEVEL_FROZEN")
1517}
1518
Colin Cross9272ade2016-08-17 15:24:12 -07001519func (c *deviceConfig) Arches() []Arch {
1520 var arches []Arch
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001521 for _, target := range c.config.Targets[Android] {
Colin Cross9272ade2016-08-17 15:24:12 -07001522 arches = append(arches, target.Arch)
1523 }
1524 return arches
1525}
Dan Willemsend2ede872016-11-18 14:54:24 -08001526
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001527func (c *deviceConfig) BinderBitness() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001528 is32BitBinder := c.config.productVariables.Binder32bit
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001529 if is32BitBinder != nil && *is32BitBinder {
1530 return "32"
1531 }
1532 return "64"
1533}
1534
Jihoon Kang3216c982024-12-02 19:42:20 +00001535func (c *deviceConfig) RecoveryPath() string {
1536 if c.config.productVariables.RecoveryPath != nil {
1537 return *c.config.productVariables.RecoveryPath
1538 }
1539 return "recovery"
1540}
1541
Dan Willemsen4353bc42016-12-05 17:16:02 -08001542func (c *deviceConfig) VendorPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001543 if c.config.productVariables.VendorPath != nil {
1544 return *c.config.productVariables.VendorPath
Dan Willemsen4353bc42016-12-05 17:16:02 -08001545 }
1546 return "vendor"
1547}
1548
Wei Li59586252024-11-04 09:25:54 -08001549func (c *deviceConfig) VendorDlkmPath() string {
1550 if c.config.productVariables.VendorDlkmPath != nil {
1551 return *c.config.productVariables.VendorDlkmPath
1552 }
1553 return "vendor_dlkm"
1554}
1555
Spandan Dase3b65312024-10-22 00:27:27 +00001556func (c *deviceConfig) BuildingVendorImage() bool {
1557 return proptools.Bool(c.config.productVariables.BuildingVendorImage)
1558}
1559
Jeongik Cha219141c2020-08-06 23:00:37 +09001560func (c *deviceConfig) CurrentApiLevelForVendorModules() string {
1561 return StringDefault(c.config.productVariables.DeviceCurrentApiLevelForVendorModules, "current")
1562}
1563
Justin Yun71549282017-11-17 12:10:28 +09001564func (c *deviceConfig) ExtraVndkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001565 return c.config.productVariables.ExtraVndkVersions
Dan Willemsend2ede872016-11-18 14:54:24 -08001566}
Jack He8cc71432016-12-08 15:45:07 -08001567
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001568func (c *deviceConfig) SystemSdkVersions() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001569 return c.config.productVariables.DeviceSystemSdkVersions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001570}
1571
1572func (c *deviceConfig) PlatformSystemSdkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001573 return c.config.productVariables.Platform_systemsdk_versions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001574}
1575
Jiyong Park2db76922017-11-08 16:03:48 +09001576func (c *deviceConfig) OdmPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001577 if c.config.productVariables.OdmPath != nil {
1578 return *c.config.productVariables.OdmPath
Jiyong Park2db76922017-11-08 16:03:48 +09001579 }
1580 return "odm"
1581}
1582
Spandan Dasc5717162024-11-01 18:33:57 +00001583func (c *deviceConfig) BuildingOdmImage() bool {
1584 return proptools.Bool(c.config.productVariables.BuildingOdmImage)
1585}
1586
Wei Li59586252024-11-04 09:25:54 -08001587func (c *deviceConfig) OdmDlkmPath() string {
1588 if c.config.productVariables.OdmDlkmPath != nil {
1589 return *c.config.productVariables.OdmDlkmPath
1590 }
1591 return "odm_dlkm"
1592}
1593
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001594func (c *deviceConfig) ProductPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001595 if c.config.productVariables.ProductPath != nil {
1596 return *c.config.productVariables.ProductPath
Jiyong Park2db76922017-11-08 16:03:48 +09001597 }
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001598 return "product"
Jiyong Park2db76922017-11-08 16:03:48 +09001599}
1600
Jihoon Kang6dd13b62024-10-22 23:21:02 +00001601func (c *deviceConfig) BuildingProductImage() bool {
1602 return proptools.Bool(c.config.productVariables.BuildingProductImage)
1603}
1604
Justin Yund5f6c822019-06-25 16:47:17 +09001605func (c *deviceConfig) SystemExtPath() string {
1606 if c.config.productVariables.SystemExtPath != nil {
1607 return *c.config.productVariables.SystemExtPath
Dario Frenifd05a742018-05-29 13:28:54 +01001608 }
Justin Yund5f6c822019-06-25 16:47:17 +09001609 return "system_ext"
Dario Frenifd05a742018-05-29 13:28:54 +01001610}
1611
Wei Li59586252024-11-04 09:25:54 -08001612func (c *deviceConfig) SystemDlkmPath() string {
1613 if c.config.productVariables.SystemDlkmPath != nil {
1614 return *c.config.productVariables.SystemDlkmPath
1615 }
1616 return "system_dlkm"
1617}
1618
1619func (c *deviceConfig) OemPath() string {
1620 if c.config.productVariables.OemPath != nil {
1621 return *c.config.productVariables.OemPath
1622 }
1623 return "oem"
1624}
1625
mrziwang23ba8762024-11-07 16:21:53 -08001626func (c *deviceConfig) UserdataPath() string {
1627 if c.config.productVariables.UserdataPath != nil {
1628 return *c.config.productVariables.UserdataPath
1629 }
1630 return "data"
1631}
1632
1633func (c *deviceConfig) BuildingUserdataImage() bool {
1634 return proptools.Bool(c.config.productVariables.BuildingUserdataImage)
1635}
1636
Jihoon Kang3216c982024-12-02 19:42:20 +00001637func (c *deviceConfig) BuildingRecoveryImage() bool {
1638 return proptools.Bool(c.config.productVariables.BuildingRecoveryImage)
1639}
1640
Jack He8cc71432016-12-08 15:45:07 -08001641func (c *deviceConfig) BtConfigIncludeDir() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001642 return String(c.config.productVariables.BtConfigIncludeDir)
Jack He8cc71432016-12-08 15:45:07 -08001643}
Dan Willemsen581341d2017-02-09 16:16:31 -08001644
Jiyong Parkd773eb32017-07-03 13:18:12 +09001645func (c *deviceConfig) DeviceKernelHeaderDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001646 return c.config.productVariables.DeviceKernelHeaders
Jiyong Parkd773eb32017-07-03 13:18:12 +09001647}
1648
Roland Levillainada12702020-06-09 13:07:36 +01001649// JavaCoverageEnabledForPath returns whether Java code coverage is enabled for
1650// path. Coverage is enabled by default when the product variable
1651// JavaCoveragePaths is empty. If JavaCoveragePaths is not empty, coverage is
1652// enabled for any path which is part of this variable (and not part of the
1653// JavaCoverageExcludePaths product variable). Value "*" in JavaCoveragePaths
1654// represents any path.
1655func (c *deviceConfig) JavaCoverageEnabledForPath(path string) bool {
1656 coverage := false
Chris Gross2f748692020-06-24 20:36:59 +00001657 if len(c.config.productVariables.JavaCoveragePaths) == 0 ||
Roland Levillainada12702020-06-09 13:07:36 +01001658 InList("*", c.config.productVariables.JavaCoveragePaths) ||
1659 HasAnyPrefix(path, c.config.productVariables.JavaCoveragePaths) {
1660 coverage = true
1661 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001662 if coverage && len(c.config.productVariables.JavaCoverageExcludePaths) > 0 {
Roland Levillainada12702020-06-09 13:07:36 +01001663 if HasAnyPrefix(path, c.config.productVariables.JavaCoverageExcludePaths) {
1664 coverage = false
1665 }
1666 }
1667 return coverage
1668}
1669
Colin Cross1a6acd42020-06-16 17:51:46 -07001670// Returns true if gcov or clang coverage is enabled.
Dan Willemsen581341d2017-02-09 16:16:31 -08001671func (c *deviceConfig) NativeCoverageEnabled() bool {
Colin Cross1a6acd42020-06-16 17:51:46 -07001672 return Bool(c.config.productVariables.GcovCoverage) ||
1673 Bool(c.config.productVariables.ClangCoverage)
Dan Willemsen581341d2017-02-09 16:16:31 -08001674}
1675
Oliver Nguyen1382ab62019-12-06 15:22:41 -08001676func (c *deviceConfig) ClangCoverageEnabled() bool {
1677 return Bool(c.config.productVariables.ClangCoverage)
1678}
1679
Pirama Arumuga Nainarb37ae582022-01-26 22:14:32 -08001680func (c *deviceConfig) ClangCoverageContinuousMode() bool {
1681 return Bool(c.config.productVariables.ClangCoverageContinuousMode)
1682}
1683
Colin Cross1a6acd42020-06-16 17:51:46 -07001684func (c *deviceConfig) GcovCoverageEnabled() bool {
1685 return Bool(c.config.productVariables.GcovCoverage)
1686}
1687
Roland Levillain4f5297b2020-06-09 12:44:06 +01001688// NativeCoverageEnabledForPath returns whether (GCOV- or Clang-based) native
1689// code coverage is enabled for path. By default, coverage is not enabled for a
1690// given path unless it is part of the NativeCoveragePaths product variable (and
1691// not part of the NativeCoverageExcludePaths product variable). Value "*" in
1692// NativeCoveragePaths represents any path.
1693func (c *deviceConfig) NativeCoverageEnabledForPath(path string) bool {
Ryan Campbell469a18a2017-02-27 09:01:54 -08001694 coverage := false
Roland Levillainf6cc2612020-07-09 16:58:14 +01001695 if len(c.config.productVariables.NativeCoveragePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001696 if InList("*", c.config.productVariables.NativeCoveragePaths) || HasAnyPrefix(path, c.config.productVariables.NativeCoveragePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001697 coverage = true
Dan Willemsen581341d2017-02-09 16:16:31 -08001698 }
1699 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001700 if coverage && len(c.config.productVariables.NativeCoverageExcludePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001701 if HasAnyPrefix(path, c.config.productVariables.NativeCoverageExcludePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001702 coverage = false
Ryan Campbell469a18a2017-02-27 09:01:54 -08001703 }
1704 }
1705 return coverage
Dan Willemsen581341d2017-02-09 16:16:31 -08001706}
Ivan Lozano5f595532017-07-13 14:46:05 -07001707
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001708func (c *deviceConfig) PgoAdditionalProfileDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001709 return c.config.productVariables.PgoAdditionalProfileDirs
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001710}
1711
Vinh Tran44cb78c2023-03-09 22:07:19 -05001712// AfdoProfile returns fully qualified path associated to the given module name
Colin Crossd38feb02024-01-23 16:38:06 -08001713func (c *deviceConfig) AfdoProfile(name string) (string, error) {
Vinh Tran44cb78c2023-03-09 22:07:19 -05001714 for _, afdoProfile := range c.config.productVariables.AfdoProfiles {
1715 split := strings.Split(afdoProfile, ":")
1716 if len(split) != 3 {
Colin Crossd38feb02024-01-23 16:38:06 -08001717 return "", fmt.Errorf("AFDO_PROFILES has invalid value: %s. "+
Vinh Tran44cb78c2023-03-09 22:07:19 -05001718 "The expected format is <module>:<fully-qualified-path-to-fdo_profile>", afdoProfile)
1719 }
1720 if split[0] == name {
Colin Crossd38feb02024-01-23 16:38:06 -08001721 return strings.Join([]string{split[1], split[2]}, ":"), nil
Vinh Tran44cb78c2023-03-09 22:07:19 -05001722 }
1723 }
Colin Crossd38feb02024-01-23 16:38:06 -08001724 return "", nil
Vinh Tran44cb78c2023-03-09 22:07:19 -05001725}
1726
Tri Vo35a51432018-03-25 20:00:00 -07001727func (c *deviceConfig) VendorSepolicyDirs() []string {
1728 return c.config.productVariables.BoardVendorSepolicyDirs
1729}
1730
1731func (c *deviceConfig) OdmSepolicyDirs() []string {
1732 return c.config.productVariables.BoardOdmSepolicyDirs
1733}
1734
Felixa20a8752020-05-17 18:28:35 +02001735func (c *deviceConfig) SystemExtPublicSepolicyDirs() []string {
1736 return c.config.productVariables.SystemExtPublicSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001737}
1738
Felixa20a8752020-05-17 18:28:35 +02001739func (c *deviceConfig) SystemExtPrivateSepolicyDirs() []string {
1740 return c.config.productVariables.SystemExtPrivateSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001741}
1742
Inseob Kim0866b002019-04-15 20:21:29 +09001743func (c *deviceConfig) SepolicyM4Defs() []string {
1744 return c.config.productVariables.BoardSepolicyM4Defs
1745}
1746
Jiyong Park7f67f482019-01-05 12:57:48 +09001747func (c *deviceConfig) OverrideManifestPackageNameFor(name string) (manifestName string, overridden bool) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001748 return findOverrideValue(c.config.productVariables.ManifestPackageNameOverrides, name,
1749 "invalid override rule %q in PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES should be <module_name>:<manifest_name>")
1750}
1751
1752func (c *deviceConfig) OverrideCertificateFor(name string) (certificatePath string, overridden bool) {
Jaewoong Jungacb6db32019-02-28 16:22:30 +00001753 return findOverrideValue(c.config.productVariables.CertificateOverrides, name,
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001754 "invalid override rule %q in PRODUCT_CERTIFICATE_OVERRIDES should be <module_name>:<certificate_module_name>")
1755}
1756
Jaewoong Jung9d22a912019-01-23 16:27:47 -08001757func (c *deviceConfig) OverridePackageNameFor(name string) string {
1758 newName, overridden := findOverrideValue(
1759 c.config.productVariables.PackageNameOverrides,
1760 name,
1761 "invalid override rule %q in PRODUCT_PACKAGE_NAME_OVERRIDES should be <module_name>:<package_name>")
1762 if overridden {
1763 return newName
1764 }
1765 return name
1766}
1767
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001768func findOverrideValue(overrides []string, name string, errorMsg string) (newValue string, overridden bool) {
Jiyong Park7f67f482019-01-05 12:57:48 +09001769 if overrides == nil || len(overrides) == 0 {
1770 return "", false
1771 }
1772 for _, o := range overrides {
1773 split := strings.Split(o, ":")
1774 if len(split) != 2 {
1775 // This shouldn't happen as this is first checked in make, but just in case.
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001776 panic(fmt.Errorf(errorMsg, o))
Jiyong Park7f67f482019-01-05 12:57:48 +09001777 }
1778 if matchPattern(split[0], name) {
1779 return substPattern(split[0], split[1], name), true
1780 }
1781 }
1782 return "", false
1783}
1784
Albert Martineefabcf2022-03-21 20:11:16 +00001785func (c *deviceConfig) ApexGlobalMinSdkVersionOverride() string {
1786 return String(c.config.productVariables.ApexGlobalMinSdkVersionOverride)
1787}
1788
Ivan Lozano5f595532017-07-13 14:46:05 -07001789func (c *config) IntegerOverflowDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001790 if len(c.productVariables.IntegerOverflowExcludePaths) == 0 {
Ivan Lozano5f595532017-07-13 14:46:05 -07001791 return false
1792 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001793 return HasAnyPrefix(path, c.productVariables.IntegerOverflowExcludePaths)
Ivan Lozano5f595532017-07-13 14:46:05 -07001794}
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001795
1796func (c *config) CFIDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001797 if len(c.productVariables.CFIExcludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001798 return false
1799 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001800 return HasAnyPrefix(path, c.productVariables.CFIExcludePaths)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001801}
1802
1803func (c *config) CFIEnabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001804 if len(c.productVariables.CFIIncludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001805 return false
1806 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001807 return HasAnyPrefix(path, c.productVariables.CFIIncludePaths) && !c.CFIDisabledForPath(path)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001808}
Colin Crosse15ddaf2017-12-04 11:24:31 -08001809
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001810func (c *config) MemtagHeapDisabledForPath(path string) bool {
1811 if len(c.productVariables.MemtagHeapExcludePaths) == 0 {
1812 return false
1813 }
1814 return HasAnyPrefix(path, c.productVariables.MemtagHeapExcludePaths)
1815}
1816
1817func (c *config) MemtagHeapAsyncEnabledForPath(path string) bool {
1818 if len(c.productVariables.MemtagHeapAsyncIncludePaths) == 0 {
1819 return false
1820 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001821 return HasAnyPrefix(path, c.productVariables.MemtagHeapAsyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001822}
1823
1824func (c *config) MemtagHeapSyncEnabledForPath(path string) bool {
1825 if len(c.productVariables.MemtagHeapSyncIncludePaths) == 0 {
1826 return false
1827 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001828 return HasAnyPrefix(path, c.productVariables.MemtagHeapSyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001829}
1830
Tomislav Novakf734f002023-08-22 10:51:44 -07001831func (c *config) HWASanDisabledForPath(path string) bool {
1832 if len(c.productVariables.HWASanExcludePaths) == 0 {
1833 return false
1834 }
1835 return HasAnyPrefix(path, c.productVariables.HWASanExcludePaths)
1836}
1837
Hang Lua98aab92023-03-17 13:17:22 +08001838func (c *config) HWASanEnabledForPath(path string) bool {
1839 if len(c.productVariables.HWASanIncludePaths) == 0 {
1840 return false
1841 }
Tomislav Novakf734f002023-08-22 10:51:44 -07001842 return HasAnyPrefix(path, c.productVariables.HWASanIncludePaths) && !c.HWASanDisabledForPath(path)
Hang Lua98aab92023-03-17 13:17:22 +08001843}
1844
Dan Willemsen0fe78662018-03-26 12:41:18 -07001845func (c *config) VendorConfig(name string) VendorConfig {
Colin Cross9d34f352019-11-22 16:03:51 -08001846 return soongconfig.Config(c.productVariables.VendorVars[name])
Dan Willemsen0fe78662018-03-26 12:41:18 -07001847}
1848
Colin Cross395f2cf2018-10-24 16:10:32 -07001849func (c *config) NdkAbis() bool {
1850 return Bool(c.productVariables.Ndk_abis)
1851}
1852
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001853func (c *config) AmlAbis() bool {
1854 return Bool(c.productVariables.Aml_abis)
1855}
1856
Jiyong Park4da07972021-01-05 21:01:11 +09001857func (c *config) ForceApexSymlinkOptimization() bool {
1858 return Bool(c.productVariables.ForceApexSymlinkOptimization)
1859}
1860
Sasha Smundakfe9a5b82022-07-27 14:51:45 -07001861func (c *config) ApexCompressionEnabled() bool {
1862 return Bool(c.productVariables.CompressedApex) && !c.UnbundledBuildApps()
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +00001863}
1864
Jooyung Han920809a2024-11-15 12:50:50 +09001865func (c *config) DefaultApexPayloadType() string {
1866 return StringDefault(c.productVariables.DefaultApexPayloadType, "ext4")
1867}
1868
Justin Yun2cc42502024-09-11 14:10:20 +09001869func (c *config) UseSoongSystemImage() bool {
1870 return Bool(c.productVariables.UseSoongSystemImage)
1871}
1872
1873func (c *config) SoongDefinedSystemImage() string {
1874 if c.UseSoongSystemImage() {
1875 return String(c.productVariables.ProductSoongDefinedSystemImage)
1876 }
1877 return ""
1878}
1879
Jeongik Chac9464142019-01-07 12:07:27 +09001880func (c *config) EnforceSystemCertificate() bool {
1881 return Bool(c.productVariables.EnforceSystemCertificate)
1882}
1883
Colin Cross440e0d02020-06-11 11:32:11 -07001884func (c *config) EnforceSystemCertificateAllowList() []string {
1885 return c.productVariables.EnforceSystemCertificateAllowList
Jeongik Chac9464142019-01-07 12:07:27 +09001886}
1887
Jeongik Cha2cc570d2019-10-29 15:44:45 +09001888func (c *config) EnforceProductPartitionInterface() bool {
1889 return Bool(c.productVariables.EnforceProductPartitionInterface)
1890}
1891
Colin Crossf24a22a2019-01-31 14:12:44 -08001892func (c *config) ProductHiddenAPIStubs() []string {
1893 return c.productVariables.ProductHiddenAPIStubs
Colin Cross8faf8fc2019-01-16 15:15:52 -08001894}
1895
Colin Crossf24a22a2019-01-31 14:12:44 -08001896func (c *config) ProductHiddenAPIStubsSystem() []string {
1897 return c.productVariables.ProductHiddenAPIStubsSystem
Colin Cross8faf8fc2019-01-16 15:15:52 -08001898}
1899
Colin Crossf24a22a2019-01-31 14:12:44 -08001900func (c *config) ProductHiddenAPIStubsTest() []string {
1901 return c.productVariables.ProductHiddenAPIStubsTest
Colin Cross8faf8fc2019-01-16 15:15:52 -08001902}
Dan Willemsen71c74602019-04-10 12:27:35 -07001903
Dan Willemsen54879d12019-04-18 10:08:46 -07001904func (c *deviceConfig) TargetFSConfigGen() []string {
Dan Willemsen71c74602019-04-10 12:27:35 -07001905 return c.config.productVariables.TargetFSConfigGen
1906}
Inseob Kim0866b002019-04-15 20:21:29 +09001907
1908func (c *config) ProductPublicSepolicyDirs() []string {
1909 return c.productVariables.ProductPublicSepolicyDirs
1910}
1911
1912func (c *config) ProductPrivateSepolicyDirs() []string {
1913 return c.productVariables.ProductPrivateSepolicyDirs
1914}
1915
Inseob Kim5eb7ee92022-04-27 10:30:34 +09001916func (c *config) TargetMultitreeUpdateMeta() bool {
1917 return c.productVariables.MultitreeUpdateMeta
1918}
1919
Inseob Kim1f086e22019-05-09 13:29:15 +09001920func (c *deviceConfig) DeviceArch() string {
1921 return String(c.config.productVariables.DeviceArch)
1922}
1923
1924func (c *deviceConfig) DeviceArchVariant() string {
1925 return String(c.config.productVariables.DeviceArchVariant)
1926}
1927
1928func (c *deviceConfig) DeviceSecondaryArch() string {
1929 return String(c.config.productVariables.DeviceSecondaryArch)
1930}
1931
1932func (c *deviceConfig) DeviceSecondaryArchVariant() string {
1933 return String(c.config.productVariables.DeviceSecondaryArchVariant)
1934}
Yifan Hong82db7352020-01-21 16:12:26 -08001935
1936func (c *deviceConfig) BoardUsesRecoveryAsBoot() bool {
1937 return Bool(c.config.productVariables.BoardUsesRecoveryAsBoot)
1938}
Yifan Hong97365ee2020-07-29 09:51:57 -07001939
1940func (c *deviceConfig) BoardKernelBinaries() []string {
1941 return c.config.productVariables.BoardKernelBinaries
1942}
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001943
Yifan Hong42bef8d2020-08-05 14:36:09 -07001944func (c *deviceConfig) BoardKernelModuleInterfaceVersions() []string {
1945 return c.config.productVariables.BoardKernelModuleInterfaceVersions
1946}
1947
Yifan Hongdd8dacc2020-10-21 15:40:17 -07001948func (c *deviceConfig) BoardMoveRecoveryResourcesToVendorBoot() bool {
1949 return Bool(c.config.productVariables.BoardMoveRecoveryResourcesToVendorBoot)
1950}
1951
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001952func (c *deviceConfig) PlatformSepolicyVersion() string {
1953 return String(c.config.productVariables.PlatformSepolicyVersion)
1954}
1955
Inseob Kim843f6642022-01-07 09:11:23 +09001956func (c *deviceConfig) PlatformSepolicyCompatVersions() []string {
1957 return c.config.productVariables.PlatformSepolicyCompatVersions
1958}
1959
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001960func (c *deviceConfig) BoardSepolicyVers() string {
Inseob Kim0c4eec82021-03-22 22:33:40 +09001961 if ver := String(c.config.productVariables.BoardSepolicyVers); ver != "" {
1962 return ver
1963 }
1964 return c.PlatformSepolicyVersion()
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001965}
1966
Inseob Kim1a0afcc2022-02-14 23:10:51 +09001967func (c *deviceConfig) SystemExtSepolicyPrebuiltApiDir() string {
1968 return String(c.config.productVariables.SystemExtSepolicyPrebuiltApiDir)
1969}
1970
1971func (c *deviceConfig) ProductSepolicyPrebuiltApiDir() string {
1972 return String(c.config.productVariables.ProductSepolicyPrebuiltApiDir)
1973}
1974
1975func (c *deviceConfig) IsPartnerTrebleSepolicyTestEnabled() bool {
1976 return c.SystemExtSepolicyPrebuiltApiDir() != "" || c.ProductSepolicyPrebuiltApiDir() != ""
1977}
1978
Justin DeMartino383bfb32021-02-24 10:49:43 -08001979func createDirsMap(previous map[string]bool, dirs []string) (map[string]bool, error) {
1980 var ret = make(map[string]bool)
1981 for _, dir := range dirs {
1982 clean := filepath.Clean(dir)
1983 if previous[clean] || ret[clean] {
1984 return nil, fmt.Errorf("Duplicate entry %s", dir)
1985 }
1986 ret[clean] = true
1987 }
1988 return ret, nil
1989}
1990
1991func (c *deviceConfig) createDirsMapOnce(onceKey OnceKey, previous map[string]bool, dirs []string) map[string]bool {
1992 dirMap := c.Once(onceKey, func() interface{} {
1993 ret, err := createDirsMap(previous, dirs)
1994 if err != nil {
1995 panic(fmt.Errorf("%s: %w", onceKey.key, err))
1996 }
1997 return ret
1998 })
1999 if dirMap == nil {
2000 return nil
2001 }
2002 return dirMap.(map[string]bool)
2003}
2004
Inseob Kim60c32f02020-12-21 22:53:05 +09002005func (c *deviceConfig) ShippingApiLevel() ApiLevel {
Steven Morelanda48df2b2024-06-03 22:29:38 +00002006 if c.config.productVariables.Shipping_api_level == nil {
Inseob Kim60c32f02020-12-21 22:53:05 +09002007 return NoneApiLevel
2008 }
Steven Morelanda48df2b2024-06-03 22:29:38 +00002009 apiLevel, _ := strconv.Atoi(*c.config.productVariables.Shipping_api_level)
Inseob Kim60c32f02020-12-21 22:53:05 +09002010 return uncheckedFinalApiLevel(apiLevel)
2011}
2012
Liz Kammer33cc80e2023-05-18 18:20:28 +00002013func (c *deviceConfig) BuildBrokenPluginValidation() []string {
2014 return c.config.productVariables.BuildBrokenPluginValidation
2015}
2016
Alix Espinoef47e542022-09-14 19:10:51 +00002017func (c *deviceConfig) BuildBrokenClangAsFlags() bool {
2018 return c.config.productVariables.BuildBrokenClangAsFlags
2019}
2020
2021func (c *deviceConfig) BuildBrokenClangCFlags() bool {
2022 return c.config.productVariables.BuildBrokenClangCFlags
2023}
2024
Alixb5f6d9e2022-04-20 23:00:58 +00002025func (c *deviceConfig) BuildBrokenClangProperty() bool {
2026 return c.config.productVariables.BuildBrokenClangProperty
2027}
2028
Inseob Kim67e5add192021-03-17 18:05:33 +09002029func (c *deviceConfig) BuildBrokenEnforceSyspropOwner() bool {
2030 return c.config.productVariables.BuildBrokenEnforceSyspropOwner
2031}
2032
2033func (c *deviceConfig) BuildBrokenTrebleSyspropNeverallow() bool {
2034 return c.config.productVariables.BuildBrokenTrebleSyspropNeverallow
2035}
2036
Hridya Valsaraju5a5c7d52021-04-02 16:45:24 -07002037func (c *deviceConfig) BuildDebugfsRestrictionsEnabled() bool {
2038 return c.config.productVariables.BuildDebugfsRestrictionsEnabled
2039}
2040
Inseob Kim0cac7b42021-02-03 18:16:46 +09002041func (c *deviceConfig) BuildBrokenVendorPropertyNamespace() bool {
2042 return c.config.productVariables.BuildBrokenVendorPropertyNamespace
2043}
2044
Liz Kammer619be462022-01-28 15:13:39 -05002045func (c *deviceConfig) BuildBrokenInputDir(name string) bool {
2046 return InList(name, c.config.productVariables.BuildBrokenInputDirModules)
2047}
2048
Jiyong Park3bb99242024-01-04 23:21:26 +00002049func (c *deviceConfig) BuildBrokenDontCheckSystemSdk() bool {
2050 return c.config.productVariables.BuildBrokenDontCheckSystemSdk
2051}
2052
Inseob Kim2da72af2024-06-18 11:09:12 +09002053func (c *deviceConfig) BuildBrokenDupSysprop() bool {
2054 return c.config.productVariables.BuildBrokenDupSysprop
2055}
2056
Jiakai Zhang48203e32023-06-02 23:42:21 +01002057func (c *config) BuildWarningBadOptionalUsesLibsAllowlist() []string {
2058 return c.productVariables.BuildWarningBadOptionalUsesLibsAllowlist
2059}
2060
Yu Liu6a7940c2023-05-09 17:12:22 -07002061func (c *deviceConfig) GenruleSandboxing() bool {
2062 return Bool(c.config.productVariables.GenruleSandboxing)
Vinh Tran140d5882022-06-10 14:23:27 -04002063}
2064
Inseob Kim67e5add192021-03-17 18:05:33 +09002065func (c *deviceConfig) RequiresInsecureExecmemForSwiftshader() bool {
2066 return c.config.productVariables.RequiresInsecureExecmemForSwiftshader
2067}
2068
Devin Moorec381e102023-07-06 22:03:58 +00002069func (c *deviceConfig) Release_aidl_use_unfrozen() bool {
2070 return Bool(c.config.productVariables.Release_aidl_use_unfrozen)
2071}
2072
Inseob Kim67e5add192021-03-17 18:05:33 +09002073func (c *config) SelinuxIgnoreNeverallows() bool {
2074 return c.productVariables.SelinuxIgnoreNeverallows
2075}
2076
Inseob Kima10ef272021-09-15 03:04:53 +00002077func (c *deviceConfig) SepolicyFreezeTestExtraDirs() []string {
2078 return c.config.productVariables.SepolicyFreezeTestExtraDirs
2079}
2080
2081func (c *deviceConfig) SepolicyFreezeTestExtraPrebuiltDirs() []string {
2082 return c.config.productVariables.SepolicyFreezeTestExtraPrebuiltDirs
2083}
2084
Jiyong Parkd163d4d2021-10-12 16:47:43 +09002085func (c *deviceConfig) GenerateAidlNdkPlatformBackend() bool {
2086 return c.config.productVariables.GenerateAidlNdkPlatformBackend
2087}
2088
Yu Liu67a28422024-03-05 00:36:31 +00002089func (c *deviceConfig) AconfigContainerValidation() string {
2090 return c.config.productVariables.AconfigContainerValidation
2091}
2092
Christopher Ferris98f10222022-07-13 23:16:52 -07002093func (c *config) IgnorePrefer32OnDevice() bool {
2094 return c.productVariables.IgnorePrefer32OnDevice
2095}
2096
Ulya Trafimovich249386a2020-07-01 14:31:13 +01002097func (c *config) BootJars() []string {
2098 return c.Once(earlyBootJarsKey, func() interface{} {
Paul Duffin69d1fb12020-10-23 21:14:20 +01002099 list := c.productVariables.BootJars.CopyOfJars()
satayevd604b212021-07-21 14:23:52 +01002100 return append(list, c.productVariables.ApexBootJars.CopyOfJars()...)
Ulya Trafimovich249386a2020-07-01 14:31:13 +01002101 }).([]string)
2102}
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002103
satayevd604b212021-07-21 14:23:52 +01002104func (c *config) NonApexBootJars() ConfiguredJarList {
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002105 return c.productVariables.BootJars
2106}
2107
satayevd604b212021-07-21 14:23:52 +01002108func (c *config) ApexBootJars() ConfiguredJarList {
2109 return c.productVariables.ApexBootJars
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002110}
Colin Cross77cdcfd2021-03-12 11:28:25 -08002111
2112func (c *config) RBEWrapper() string {
2113 return c.GetenvWithDefault("RBE_WRAPPER", remoteexec.DefaultWrapperPath)
2114}
Colin Cross9b698b62021-12-22 09:55:32 -08002115
2116// UseHostMusl returns true if the host target has been configured to build against musl libc.
2117func (c *config) UseHostMusl() bool {
2118 return Bool(c.productVariables.HostMusl)
2119}
MarkDacekff851b82022-04-21 18:33:17 +00002120
Spandan Das9e93d3d2023-03-08 05:47:29 +00002121// ApiSurfaces directory returns the source path inside the api_surfaces repo
2122// (relative to workspace root).
2123func (c *config) ApiSurfacesDir(s ApiSurface, version string) string {
2124 return filepath.Join(
2125 "build",
2126 "bazel",
2127 "api_surfaces",
2128 s.String(),
2129 version)
2130}
Jihoon Kang1bff0342023-01-17 20:40:22 +00002131
Jihoon Kang1975d3e2023-10-16 23:24:11 +00002132func (c *config) JavaCoverageEnabled() bool {
2133 return c.IsEnvTrue("EMMA_INSTRUMENT") || c.IsEnvTrue("EMMA_INSTRUMENT_STATIC") || c.IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK")
2134}
2135
Jihoon Kangc1b04d62023-11-16 19:07:04 +00002136func (c *deviceConfig) BuildFromSourceStub() bool {
2137 return Bool(c.config.productVariables.BuildFromSourceStub)
2138}
2139
Jihoon Kang1bff0342023-01-17 20:40:22 +00002140func (c *config) BuildFromTextStub() bool {
Jihoon Kang1975d3e2023-10-16 23:24:11 +00002141 // TODO: b/302320354 - Remove the coverage build specific logic once the
2142 // robust solution for handling native properties in from-text stub build
2143 // is implemented.
Jihoon Kangc1b04d62023-11-16 19:07:04 +00002144 return !c.buildFromSourceStub &&
2145 !c.JavaCoverageEnabled() &&
2146 !c.deviceConfig.BuildFromSourceStub()
Jihoon Kang1bff0342023-01-17 20:40:22 +00002147}
Spandan Das4deab282023-03-30 17:06:32 +00002148
2149func (c *config) SetBuildFromTextStub(b bool) {
Jihoon Kang2a929ad2023-06-08 19:02:07 +00002150 c.buildFromSourceStub = !b
Jihoon Kangcbcad7c2023-06-01 22:31:52 +00002151 c.productVariables.Build_from_text_stub = boolPtr(b)
Spandan Das4deab282023-03-30 17:06:32 +00002152}
Jihoon Kang1c92c3e2023-03-23 17:44:51 +00002153
Inseob Kim5bac3b62023-08-25 21:29:46 +09002154func (c *deviceConfig) CheckVendorSeappViolations() bool {
2155 return Bool(c.config.productVariables.CheckVendorSeappViolations)
2156}
Jihoon Kangcfbc4072023-09-20 01:02:18 +00002157
Inseob Kime4e85d52023-10-25 23:53:58 +09002158func (c *config) GetBuildFlag(name string) (string, bool) {
2159 val, ok := c.productVariables.BuildFlags[name]
2160 return val, ok
2161}
Spandan Dase3fcb412023-10-26 20:48:02 +00002162
Rico Winda7b38592024-08-26 12:10:44 +02002163func (c *config) UseOptimizedResourceShrinkingByDefault() bool {
2164 return c.productVariables.GetBuildFlagBool("RELEASE_USE_OPTIMIZED_RESOURCE_SHRINKING_BY_DEFAULT")
2165}
2166
Colin Cross8f1b0332024-01-25 13:39:06 -08002167func (c *config) UseResourceProcessorByDefault() bool {
2168 return c.productVariables.GetBuildFlagBool("RELEASE_USE_RESOURCE_PROCESSOR_BY_DEFAULT")
2169}
2170
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002171func (c *config) UseTransitiveJarsInClasspath() bool {
2172 return c.productVariables.GetBuildFlagBool("RELEASE_USE_TRANSITIVE_JARS_IN_CLASSPATH")
2173}
2174
Christoffer Adamsenb81fc912024-12-17 14:30:47 +01002175func (c *config) UseR8StoreStoreFenceConstructorInlining() bool {
2176 return c.productVariables.GetBuildFlagBool("RELEASE_R8_STORE_STORE_FENCE_CONSTRUCTOR_INLINING")
2177}
2178
David Srbecky55b46b02024-11-26 17:16:16 +00002179func (c *config) UseDexV41() bool {
2180 return c.productVariables.GetBuildFlagBool("RELEASE_USE_DEX_V41")
2181}
2182
Spandan Dase3fcb412023-10-26 20:48:02 +00002183var (
Spandan Das85bd4622024-08-01 00:51:20 +00002184 mainlineApexContributionBuildFlagsToApexNames = map[string]string{
2185 "RELEASE_APEX_CONTRIBUTIONS_ADBD": "com.android.adbd",
2186 "RELEASE_APEX_CONTRIBUTIONS_ADSERVICES": "com.android.adservices",
2187 "RELEASE_APEX_CONTRIBUTIONS_APPSEARCH": "com.android.appsearch",
2188 "RELEASE_APEX_CONTRIBUTIONS_ART": "com.android.art",
2189 "RELEASE_APEX_CONTRIBUTIONS_BLUETOOTH": "com.android.btservices",
2190 "RELEASE_APEX_CONTRIBUTIONS_CAPTIVEPORTALLOGIN": "",
2191 "RELEASE_APEX_CONTRIBUTIONS_CELLBROADCAST": "com.android.cellbroadcast",
2192 "RELEASE_APEX_CONTRIBUTIONS_CONFIGINFRASTRUCTURE": "com.android.configinfrastructure",
2193 "RELEASE_APEX_CONTRIBUTIONS_CONNECTIVITY": "com.android.tethering",
2194 "RELEASE_APEX_CONTRIBUTIONS_CONSCRYPT": "com.android.conscrypt",
2195 "RELEASE_APEX_CONTRIBUTIONS_CRASHRECOVERY": "",
2196 "RELEASE_APEX_CONTRIBUTIONS_DEVICELOCK": "com.android.devicelock",
2197 "RELEASE_APEX_CONTRIBUTIONS_DOCUMENTSUIGOOGLE": "",
2198 "RELEASE_APEX_CONTRIBUTIONS_EXTSERVICES": "com.android.extservices",
2199 "RELEASE_APEX_CONTRIBUTIONS_HEALTHFITNESS": "com.android.healthfitness",
2200 "RELEASE_APEX_CONTRIBUTIONS_IPSEC": "com.android.ipsec",
2201 "RELEASE_APEX_CONTRIBUTIONS_MEDIA": "com.android.media",
2202 "RELEASE_APEX_CONTRIBUTIONS_MEDIAPROVIDER": "com.android.mediaprovider",
2203 "RELEASE_APEX_CONTRIBUTIONS_MODULE_METADATA": "",
2204 "RELEASE_APEX_CONTRIBUTIONS_NETWORKSTACKGOOGLE": "",
2205 "RELEASE_APEX_CONTRIBUTIONS_NEURALNETWORKS": "com.android.neuralnetworks",
2206 "RELEASE_APEX_CONTRIBUTIONS_ONDEVICEPERSONALIZATION": "com.android.ondevicepersonalization",
2207 "RELEASE_APEX_CONTRIBUTIONS_PERMISSION": "com.android.permission",
2208 "RELEASE_APEX_CONTRIBUTIONS_PRIMARY_LIBS": "",
2209 "RELEASE_APEX_CONTRIBUTIONS_REMOTEKEYPROVISIONING": "com.android.rkpd",
2210 "RELEASE_APEX_CONTRIBUTIONS_RESOLV": "com.android.resolv",
2211 "RELEASE_APEX_CONTRIBUTIONS_SCHEDULING": "com.android.scheduling",
2212 "RELEASE_APEX_CONTRIBUTIONS_SDKEXTENSIONS": "com.android.sdkext",
2213 "RELEASE_APEX_CONTRIBUTIONS_SWCODEC": "com.android.media.swcodec",
2214 "RELEASE_APEX_CONTRIBUTIONS_STATSD": "com.android.os.statsd",
2215 "RELEASE_APEX_CONTRIBUTIONS_TELEMETRY_TVP": "",
2216 "RELEASE_APEX_CONTRIBUTIONS_TZDATA": "com.android.tzdata",
2217 "RELEASE_APEX_CONTRIBUTIONS_UWB": "com.android.uwb",
2218 "RELEASE_APEX_CONTRIBUTIONS_WIFI": "com.android.wifi",
Spandan Dase3fcb412023-10-26 20:48:02 +00002219 }
2220)
2221
2222// Returns the list of _selected_ apex_contributions
2223// Each mainline module will have one entry in the list
2224func (c *config) AllApexContributions() []string {
2225 ret := []string{}
Spandan Das85bd4622024-08-01 00:51:20 +00002226 for _, f := range SortedKeys(mainlineApexContributionBuildFlagsToApexNames) {
Spandan Dase3fcb412023-10-26 20:48:02 +00002227 if val, exists := c.GetBuildFlag(f); exists && val != "" {
2228 ret = append(ret, val)
2229 }
2230 }
2231 return ret
2232}
Spandan Das8ab28dd2024-02-17 03:31:45 +00002233
Spandan Das85bd4622024-08-01 00:51:20 +00002234func (c *config) AllMainlineApexNames() []string {
2235 return SortedStringValues(mainlineApexContributionBuildFlagsToApexNames)
2236}
2237
Spandan Das0d24ade2024-03-08 04:20:15 +00002238func (c *config) BuildIgnoreApexContributionContents() *bool {
Spandan Das8ab28dd2024-02-17 03:31:45 +00002239 return c.productVariables.BuildIgnoreApexContributionContents
2240}
Inseob Kim8fa54da2024-03-19 16:48:59 +09002241
2242func (c *config) ProductLocales() []string {
2243 return c.productVariables.ProductLocales
2244}
2245
2246func (c *config) ProductDefaultWifiChannels() []string {
2247 return c.productVariables.ProductDefaultWifiChannels
2248}
2249
2250func (c *config) BoardUseVbmetaDigestInFingerprint() bool {
2251 return Bool(c.productVariables.BoardUseVbmetaDigestInFingerprint)
2252}
2253
2254func (c *config) OemProperties() []string {
2255 return c.productVariables.OemProperties
2256}
Kiyoung Kim881e4652024-07-08 11:02:23 +09002257
2258func (c *config) UseDebugArt() bool {
2259 if c.productVariables.ArtTargetIncludeDebugBuild != nil {
2260 return Bool(c.productVariables.ArtTargetIncludeDebugBuild)
2261 }
2262
2263 return Bool(c.productVariables.Eng)
2264}
Inseob Kimd8538e52024-07-31 02:00:41 +00002265
2266func (c *config) SystemPropFiles(ctx PathContext) Paths {
2267 return PathsForSource(ctx, c.productVariables.SystemPropFiles)
2268}
Inseob Kim6bd92d52024-07-31 02:01:03 +00002269
Inseob Kimacf91742024-08-05 12:51:05 +09002270func (c *config) SystemExtPropFiles(ctx PathContext) Paths {
2271 return PathsForSource(ctx, c.productVariables.SystemExtPropFiles)
2272}
2273
Inseob Kim01d4f8b2024-08-08 17:47:14 +09002274func (c *config) ProductPropFiles(ctx PathContext) Paths {
2275 return PathsForSource(ctx, c.productVariables.ProductPropFiles)
2276}
2277
Inseob Kim9a22c7e2024-08-26 15:58:09 +09002278func (c *config) OdmPropFiles(ctx PathContext) Paths {
2279 return PathsForSource(ctx, c.productVariables.OdmPropFiles)
2280}
2281
Spandan Das859cdef2024-10-25 21:06:18 +00002282func (c *config) VendorPropFiles(ctx PathContext) Paths {
2283 return PathsForSource(ctx, c.productVariables.VendorPropFiles)
2284}
2285
Nouby Mohamed8609a552024-09-04 22:19:51 +00002286func (c *config) ExtraAllowedDepsTxt() string {
2287 return String(c.productVariables.ExtraAllowedDepsTxt)
2288}
2289
Inseob Kim6bd92d52024-07-31 02:01:03 +00002290func (c *config) EnableUffdGc() string {
2291 return String(c.productVariables.EnableUffdGc)
2292}
Bill Yang3b3aac02024-09-05 09:22:09 +00002293
2294func (c *config) DeviceFrameworkCompatibilityMatrixFile() []string {
2295 return c.productVariables.DeviceFrameworkCompatibilityMatrixFile
2296}
2297
2298func (c *config) DeviceProductCompatibilityMatrixFile() []string {
2299 return c.productVariables.DeviceProductCompatibilityMatrixFile
2300}
2301
2302func (c *config) BoardAvbEnable() bool {
2303 return Bool(c.productVariables.BoardAvbEnable)
2304}
2305
2306func (c *config) BoardAvbSystemAddHashtreeFooterArgs() []string {
2307 return c.productVariables.BoardAvbSystemAddHashtreeFooterArgs
2308}
Spandan Das950deca2024-10-01 18:35:23 +00002309
2310// Returns true if RELEASE_INSTALL_APEX_SYSTEMSERVER_DEXPREOPT_SAME_PARTITION is set to true.
2311// If true, dexpreopt files of apex system server jars will be installed in the same partition as the parent apex.
2312// If false, all these files will be installed in /system partition.
2313func (c Config) InstallApexSystemServerDexpreoptSamePartition() bool {
2314 return c.config.productVariables.GetBuildFlagBool("RELEASE_INSTALL_APEX_SYSTEMSERVER_DEXPREOPT_SAME_PARTITION")
2315}
Bill Yang42816dc2024-10-07 10:02:31 +00002316
2317func (c *config) DeviceMatrixFile() []string {
2318 return c.productVariables.DeviceMatrixFile
2319}
2320
2321func (c *config) ProductManifestFiles() []string {
2322 return c.productVariables.ProductManifestFiles
2323}
2324
2325func (c *config) SystemManifestFile() []string {
2326 return c.productVariables.SystemManifestFile
2327}
2328
2329func (c *config) SystemExtManifestFiles() []string {
2330 return c.productVariables.SystemExtManifestFiles
2331}
Bill Yang7ab86602024-11-01 03:08:47 +00002332
2333func (c *config) DeviceManifestFiles() []string {
2334 return c.productVariables.DeviceManifestFiles
2335}
2336
2337func (c *config) OdmManifestFiles() []string {
2338 return c.productVariables.OdmManifestFiles
2339}