blob: a18cb8be8f8c0698d15a3741001047a7ee2a8578 [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"
Sam Delmerico5c32bbf2022-01-20 20:15:02 +000025 "reflect"
Colin Cross3f40fa42015-01-30 17:27:36 -080026 "runtime"
Inseob Kim60c32f02020-12-21 22:53:05 +090027 "strconv"
Dan Willemsen34cc69e2015-09-23 15:26:20 -070028 "strings"
Colin Crossc1e86a32015-04-15 12:33:28 -070029 "sync"
Cole Faustd92430e2024-02-07 01:02:04 +000030 "unicode"
Colin Cross6ff51382015-12-17 16:39:19 -080031
Yu Liu67a28422024-03-05 00:36:31 +000032 "android/soong/shared"
33
Colin Cross98be1bb2019-12-13 20:41:13 -080034 "github.com/google/blueprint"
Colin Crosse87040b2017-12-11 15:52:26 -080035 "github.com/google/blueprint/bootstrap"
Colin Cross98be1bb2019-12-13 20:41:13 -080036 "github.com/google/blueprint/pathtools"
Colin Cross6ff51382015-12-17 16:39:19 -080037 "github.com/google/blueprint/proptools"
Colin Cross9d34f352019-11-22 16:03:51 -080038
39 "android/soong/android/soongconfig"
Liz Kammer09f947d2021-05-12 14:51:49 -040040 "android/soong/bazel"
Colin Cross77cdcfd2021-03-12 11:28:25 -080041 "android/soong/remoteexec"
Liz Kammer72beb342022-02-03 08:42:10 -050042 "android/soong/starlark_fmt"
Colin Cross3f40fa42015-01-30 17:27:36 -080043)
44
Jingwen Chenc711fec2020-11-22 23:52:50 -050045// Bool re-exports proptools.Bool for the android package.
Colin Cross6ff51382015-12-17 16:39:19 -080046var Bool = proptools.Bool
Jingwen Chenc711fec2020-11-22 23:52:50 -050047
48// String re-exports proptools.String for the android package.
Jack He8cc71432016-12-08 15:45:07 -080049var String = proptools.String
Jingwen Chenc711fec2020-11-22 23:52:50 -050050
51// StringDefault re-exports proptools.StringDefault for the android package.
Jeongik Cha219141c2020-08-06 23:00:37 +090052var StringDefault = proptools.StringDefault
Jiyong Park6a927c42020-01-21 02:03:43 +090053
Jingwen Chenc711fec2020-11-22 23:52:50 -050054// FutureApiLevelInt is a placeholder constant for unreleased API levels.
Dan Albert0b176c82020-07-23 16:43:25 -070055const FutureApiLevelInt = 10000
56
Spandan Das15da5882023-03-02 23:36:39 +000057// PrivateApiLevel represents the api level of SdkSpecPrivate (sdk_version: "")
58// This api_level exists to differentiate user-provided "" from "current" sdk_version
59// The differentiation is necessary to enable different validation rules for these two possible values.
60var PrivateApiLevel = ApiLevel{
61 value: "current", // The value is current since aidl expects `current` as the default (TestAidlFlagsWithMinSdkVersion)
62 number: FutureApiLevelInt + 1, // This is used to differentiate it from FutureApiLevel
63 isPreview: true,
64}
65
Jingwen Chenc711fec2020-11-22 23:52:50 -050066// FutureApiLevel represents unreleased API levels.
Dan Albert0b176c82020-07-23 16:43:25 -070067var FutureApiLevel = ApiLevel{
68 value: "current",
69 number: FutureApiLevelInt,
70 isPreview: true,
71}
Colin Cross6ff51382015-12-17 16:39:19 -080072
Jingwen Chenc4d91bc2020-11-24 22:59:26 -050073// The product variables file name, containing product config from Kati.
Dan Willemsen87b17d12015-07-14 00:39:06 -070074const productVariablesFileName = "soong.variables"
Colin Cross3f40fa42015-01-30 17:27:36 -080075
Colin Cross9272ade2016-08-17 15:24:12 -070076// A Config object represents the entire build configuration for Android.
Colin Crossc3c0a492015-04-10 15:43:55 -070077type Config struct {
78 *config
79}
80
Chris Parsonsad876012022-08-20 14:48:32 -040081type SoongBuildMode int
82
Sasha Smundakaf5ca922022-12-12 21:23:34 -080083type CmdArgs struct {
84 bootstrap.Args
Kiyoung Kima37d9ba2023-04-19 13:13:45 +090085 RunGoTests bool
86 OutDir string
87 SoongOutDir string
88 SoongVariables string
Sasha Smundakaf5ca922022-12-12 21:23:34 -080089
Colin Crossb63d7b32023-12-07 16:54:51 -080090 BazelQueryViewDir string
91 ModuleGraphFile string
92 ModuleActionsFile string
93 DocFile string
Sasha Smundakaf5ca922022-12-12 21:23:34 -080094
Jihoon Kang2a929ad2023-06-08 19:02:07 +000095 BuildFromSourceStub bool
MarkDacekf47e1422023-04-19 16:47:36 +000096
97 EnsureAllowlistIntegrity bool
Sasha Smundakaf5ca922022-12-12 21:23:34 -080098}
99
Chris Parsonsad876012022-08-20 14:48:32 -0400100// Build modes that soong_build can run as.
101const (
102 // Don't use bazel at all during module analysis.
103 AnalysisNoBazel SoongBuildMode = iota
104
Chris Parsonsad876012022-08-20 14:48:32 -0400105 // Generate BUILD files which faithfully represent the dependency graph of
106 // blueprint modules. Individual BUILD targets will not, however, faitfhully
107 // express build semantics.
108 GenerateQueryView
109
110 // Create a JSON representation of the module graph and exit.
111 GenerateModuleGraph
112
113 // Generate a documentation file for module type definitions and exit.
114 GenerateDocFile
Chris Parsonsad876012022-08-20 14:48:32 -0400115)
116
Inseob Kim8fa54da2024-03-19 16:48:59 +0900117const testKeyDir = "build/make/target/product/security"
118
Lukacs T. Berkib078ade2021-08-31 10:42:08 +0200119// SoongOutDir returns the build output directory for the configuration.
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200120func (c Config) SoongOutDir() string {
121 return c.soongOutDir
Jeff Gastonefc1b412017-03-29 17:29:06 -0700122}
123
Colin Cross31a67452023-11-02 16:57:08 -0700124// tempDir returns the path to out/soong/.temp, which is cleared at the beginning of every build.
125func (c Config) tempDir() string {
126 return shared.TempDirForOutDir(c.soongOutDir)
127}
128
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200129func (c Config) OutDir() string {
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200130 return c.outDir
Lukacs T. Berki89e9a162021-03-12 08:31:32 +0100131}
132
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200133func (c Config) RunGoTests() bool {
134 return c.runGoTests
135}
136
Lukacs T. Berki5f6cb1d2021-03-17 15:03:14 +0100137func (c Config) DebugCompilation() bool {
138 return false // Never compile Go code in the main build for debugging
139}
140
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200141func (c Config) Subninjas() []string {
142 return []string{}
143}
144
145func (c Config) PrimaryBuilderInvocations() []bootstrap.PrimaryBuilderInvocation {
146 return []bootstrap.PrimaryBuilderInvocation{}
147}
148
Paul Duffin74135582022-10-06 11:01:59 +0100149// RunningInsideUnitTest returns true if this code is being run as part of a Soong unit test.
150func (c Config) RunningInsideUnitTest() bool {
151 return c.config.TestProductVariables != nil
152}
153
Pratyushfaec4db2023-07-20 11:19:04 +0000154// DisableHiddenApiChecks returns true if hiddenapi checks have been disabled.
Alyssa Ketpreechasawat7daf2782023-11-01 13:58:39 +0000155// For 'eng' target variant hiddenapi checks are disabled by default for performance optimisation,
Pratyushfaec4db2023-07-20 11:19:04 +0000156// but can be enabled by setting environment variable ENABLE_HIDDENAPI_FLAGS=true.
157// For other target variants hiddenapi check are enabled by default but can be disabled by
158// setting environment variable UNSAFE_DISABLE_HIDDENAPI_FLAGS=true.
159// If both ENABLE_HIDDENAPI_FLAGS=true and UNSAFE_DISABLE_HIDDENAPI_FLAGS=true, then
160// ENABLE_HIDDENAPI_FLAGS=true will be triggered and hiddenapi checks will be considered enabled.
161func (c Config) DisableHiddenApiChecks() bool {
162 return !c.IsEnvTrue("ENABLE_HIDDENAPI_FLAGS") &&
163 (c.IsEnvTrue("UNSAFE_DISABLE_HIDDENAPI_FLAGS") ||
Alyssa Ketpreechasawat7daf2782023-11-01 13:58:39 +0000164 Bool(c.productVariables.Eng))
165}
166
167// DisableVerifyOverlaps returns true if verify_overlaps is skipped.
168// Mismatch in version of apexes and module SDK is required for mainline prebuilts to work in
169// trunk stable.
170// Thus, verify_overlaps is disabled when RELEASE_DEFAULT_MODULE_BUILD_FROM_SOURCE is set to false.
171// TODO(b/308174018): Re-enable verify_overlaps for both builr from source/mainline prebuilts.
172func (c Config) DisableVerifyOverlaps() bool {
Spandan Das07145102024-03-18 23:25:30 +0000173 if c.IsEnvFalse("DISABLE_VERIFY_OVERLAPS") && c.ReleaseDisableVerifyOverlaps() {
174 panic("The current release configuration does not support verify_overlaps. DISABLE_VERIFY_OVERLAPS cannot be set to false")
175 }
176 return c.IsEnvTrue("DISABLE_VERIFY_OVERLAPS") || c.ReleaseDisableVerifyOverlaps() || !c.ReleaseDefaultModuleBuildFromSource()
Pratyushfaec4db2023-07-20 11:19:04 +0000177}
178
Juan Yescas05d4d902023-04-07 10:35:35 -0700179// MaxPageSizeSupported returns the max page size supported by the device. This
180// value will define the ELF segment alignment for binaries (executables and
181// shared libraries).
182func (c Config) MaxPageSizeSupported() string {
183 return String(c.config.productVariables.DeviceMaxPageSizeSupported)
184}
185
Vilas Bhatb3d2d222023-12-04 22:51:20 +0000186// NoBionicPageSizeMacro returns true when AOSP is page size agnostic.
187// This means that the bionic's macro PAGE_SIZE won't be defined.
188// Returns false when AOSP is NOT page size agnostic.
189// This means that bionic's macro PAGE_SIZE is defined.
190func (c Config) NoBionicPageSizeMacro() bool {
191 return Bool(c.config.productVariables.DeviceNoBionicPageSizeMacro)
Juan Yescas01065602023-08-09 08:34:37 -0700192}
193
Joe Onoratofee845a2023-05-09 08:14:14 -0700194// The release version passed to aconfig, derived from RELEASE_VERSION
195func (c Config) ReleaseVersion() string {
196 return c.config.productVariables.ReleaseVersion
197}
198
Yu Liu2cc802a2023-09-05 17:19:45 -0700199// The aconfig value set passed to aconfig, derived from RELEASE_VERSION
Yu Liueebb2592023-10-12 20:31:27 -0700200func (c Config) ReleaseAconfigValueSets() []string {
Yu Liu95572ff2023-12-07 16:38:45 -0800201 return c.config.productVariables.ReleaseAconfigValueSets
Joe Onoratofee845a2023-05-09 08:14:14 -0700202}
203
Zhi Dou3f65a412023-08-10 21:47:40 +0000204// The flag default permission value passed to aconfig
205// derived from RELEASE_ACONFIG_FLAG_DEFAULT_PERMISSION
206func (c Config) ReleaseAconfigFlagDefaultPermission() string {
207 return c.config.productVariables.ReleaseAconfigFlagDefaultPermission
208}
209
Alyssa Ketpreechasawat34ab8792023-10-06 07:01:22 +0000210// The flag indicating behavior for the tree wrt building modules or using prebuilts
211// derived from RELEASE_DEFAULT_MODULE_BUILD_FROM_SOURCE
212func (c Config) ReleaseDefaultModuleBuildFromSource() bool {
213 return c.config.productVariables.ReleaseDefaultModuleBuildFromSource == nil ||
214 Bool(c.config.productVariables.ReleaseDefaultModuleBuildFromSource)
215}
216
Spandan Das07145102024-03-18 23:25:30 +0000217func (c Config) ReleaseDisableVerifyOverlaps() bool {
218 return c.config.productVariables.GetBuildFlagBool("RELEASE_DISABLE_VERIFY_OVERLAPS_CHECK")
219}
220
Jihoon Kang59198152024-02-06 22:43:18 +0000221// Enables flagged apis annotated with READ_WRITE aconfig flags to be included in the stubs
222// and hiddenapi flags so that they are accessible at runtime
223func (c Config) ReleaseExportRuntimeApis() bool {
Jihoon Kang35349462024-02-22 19:52:46 +0000224 return Bool(c.config.productVariables.ExportRuntimeApis)
Jihoon Kang59198152024-02-06 22:43:18 +0000225}
226
Aleksei Vetrov146e9822023-11-24 19:54:26 +0000227// Enables ABI monitoring of NDK libraries
228func (c Config) ReleaseNdkAbiMonitored() bool {
229 return c.config.productVariables.GetBuildFlagBool("RELEASE_NDK_ABI_MONITORED")
230}
231
Ted Bauer10fff942024-04-29 19:30:23 +0000232// Enable read flag from new storage, for C/C++
233func (c Config) ReleaseReadFromNewStorageCc() bool {
234 return c.config.productVariables.GetBuildFlagBool("RELEASE_READ_FROM_NEW_STORAGE_CC")
235}
236
Jihoon Kangbd093452023-12-26 19:08:01 +0000237func (c Config) ReleaseHiddenApiExportableStubs() bool {
Jihoon Kangb36fc542024-02-22 19:35:26 +0000238 return c.config.productVariables.GetBuildFlagBool("RELEASE_HIDDEN_API_EXPORTABLE_STUBS") ||
239 Bool(c.config.productVariables.HiddenapiExportableStubs)
Jihoon Kangbd093452023-12-26 19:08:01 +0000240}
241
Jingwen Chenc711fec2020-11-22 23:52:50 -0500242// A DeviceConfig object represents the configuration for a particular device
243// being built. For now there will only be one of these, but in the future there
244// may be multiple devices being built.
Colin Cross9272ade2016-08-17 15:24:12 -0700245type DeviceConfig struct {
246 *deviceConfig
247}
248
Jingwen Chenc711fec2020-11-22 23:52:50 -0500249// VendorConfig represents the configuration for vendor-specific behavior.
Colin Cross9d34f352019-11-22 16:03:51 -0800250type VendorConfig soongconfig.SoongConfig
Dan Willemsen0fe78662018-03-26 12:41:18 -0700251
Jingwen Chenc711fec2020-11-22 23:52:50 -0500252// Definition of general build configuration for soong_build. Some of these
Jingwen Chenc4d91bc2020-11-24 22:59:26 -0500253// product configuration values are read from Kati-generated soong.variables.
Colin Cross1332b002015-04-07 17:11:30 -0700254type config struct {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500255 // Options configurable with soong.variables
Cole Faustf8231dd2023-04-21 17:37:11 -0700256 productVariables ProductVariables
Colin Cross3f40fa42015-01-30 17:27:36 -0800257
Dan Willemsen674dc7f2018-03-12 18:06:05 -0700258 // Only available on configs created by TestConfig
Cole Faustf8231dd2023-04-21 17:37:11 -0700259 TestProductVariables *ProductVariables
Dan Willemsen674dc7f2018-03-12 18:06:05 -0700260
Dan Willemsen87b17d12015-07-14 00:39:06 -0700261 ProductVariablesFileName string
262
Colin Cross0c66bc62021-07-20 09:47:41 -0700263 // BuildOS stores the OsType for the OS that the build is running on.
264 BuildOS OsType
265
266 // BuildArch stores the ArchType for the CPU that the build is running on.
267 BuildArch ArchType
268
Jaewoong Jung642916f2020-10-09 17:25:15 -0700269 Targets map[OsType][]Target
270 BuildOSTarget Target // the Target for tools run on the build machine
271 BuildOSCommonTarget Target // the Target for common (java) tools run on the build machine
272 AndroidCommonTarget Target // the Target for common modules for the Android device
273 AndroidFirstDeviceTarget Target // the first Target for modules for the Android device
Dan Willemsen218f6562015-07-08 18:13:11 -0700274
Jingwen Chenc711fec2020-11-22 23:52:50 -0500275 // multilibConflicts for an ArchType is true if there is earlier configured
276 // device architecture with the same multilib value.
Colin Cross3b19f5d2019-09-17 14:45:31 -0700277 multilibConflicts map[ArchType]bool
278
Colin Cross9272ade2016-08-17 15:24:12 -0700279 deviceConfig *deviceConfig
280
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200281 outDir string // The output directory (usually out/)
282 soongOutDir string
Chris Parsons8f232a22020-06-23 17:37:05 -0400283 moduleListFile string // the path to the file which lists blueprint files to parse.
Colin Crossc1e86a32015-04-15 12:33:28 -0700284
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +0200285 runGoTests bool
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200286
Colin Cross6ccbc912017-10-10 23:07:38 -0700287 env map[string]string
Dan Willemsene7680ba2015-09-11 17:06:19 -0700288 envLock sync.Mutex
289 envDeps map[string]string
290 envFrozen bool
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800291
Jingwen Chencda22c92020-11-23 00:22:30 -0500292 // Changes behavior based on whether Kati runs after soong_build, or if soong_build
293 // runs standalone.
294 katiEnabled bool
Colin Cross1e7d3702016-08-24 15:25:47 -0700295
Colin Cross32616ed2017-09-05 21:56:44 -0700296 captureBuild bool // true for tests, saves build parameters for each module
297 ignoreEnvironment bool // true for tests, returns empty from all Getenv calls
Colin Crosscec81712017-07-13 14:43:27 -0700298
Colin Cross98be1bb2019-12-13 20:41:13 -0800299 fs pathtools.FileSystem
300 mockBpList string
301
Colin Crossb63d7b32023-12-07 16:54:51 -0800302 BuildMode SoongBuildMode
Jingwen Chen12b4c272021-03-10 02:05:59 -0500303
Colin Cross5e6a7972020-06-07 16:56:32 -0700304 // If testAllowNonExistentPaths is true then PathForSource and PathForModuleSrc won't error
305 // in tests when a path doesn't exist.
Pedro Loureiro5d190cc2021-02-15 15:41:33 +0000306 TestAllowNonExistentPaths bool
Colin Cross5e6a7972020-06-07 16:56:32 -0700307
Jingwen Chenc711fec2020-11-22 23:52:50 -0500308 // The list of files that when changed, must invalidate soong_build to
309 // regenerate build.ninja.
Colin Cross12129292020-10-29 18:23:58 -0700310 ninjaFileDepsSet sync.Map
311
Colin Cross9272ade2016-08-17 15:24:12 -0700312 OncePer
MarkDacekff851b82022-04-21 18:33:17 +0000313
Jihoon Kang2a929ad2023-06-08 19:02:07 +0000314 // If buildFromSourceStub is true then the Java API stubs are
315 // built from the source Java files, not the signature text files.
316 buildFromSourceStub bool
MarkDacekf47e1422023-04-19 16:47:36 +0000317
318 // If ensureAllowlistIntegrity is true, then the presence of any allowlisted
319 // modules that aren't mixed-built for at least one variant will cause a build
320 // failure
321 ensureAllowlistIntegrity bool
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000322
323 // List of Api libraries that contribute to Api surfaces.
324 apiLibraries map[string]struct{}
Colin Cross9272ade2016-08-17 15:24:12 -0700325}
326
327type deviceConfig struct {
Dan Willemsen00269f22017-07-06 16:59:48 -0700328 config *config
Colin Cross9272ade2016-08-17 15:24:12 -0700329 OncePer
Colin Cross3f40fa42015-01-30 17:27:36 -0800330}
331
Colin Cross485e5722015-08-27 13:28:01 -0700332type jsonConfigurable interface {
Colin Cross27385972015-09-18 10:57:10 -0700333 SetDefaultConfig()
Colin Cross485e5722015-08-27 13:28:01 -0700334}
Colin Cross3f40fa42015-01-30 17:27:36 -0800335
Colin Cross485e5722015-08-27 13:28:01 -0700336func loadConfig(config *config) error {
Colin Cross988414c2020-01-11 01:11:46 +0000337 return loadFromConfigFile(&config.productVariables, absolutePath(config.ProductVariablesFileName))
Colin Cross485e5722015-08-27 13:28:01 -0700338}
339
Cole Faustd92430e2024-02-07 01:02:04 +0000340// Checks if the string is a valid go identifier. This is equivalent to blueprint's definition
341// of an identifier, so it will match the same identifiers as those that can be used in bp files.
342func isGoIdentifier(ident string) bool {
343 for i, r := range ident {
344 valid := r == '_' || unicode.IsLetter(r) || unicode.IsDigit(r) && i > 0
345 if !valid {
346 return false
347 }
348 }
349 return len(ident) > 0
350}
351
Jingwen Chenc711fec2020-11-22 23:52:50 -0500352// loadFromConfigFile loads and decodes configuration options from a JSON file
353// in the current working directory.
Cole Faustf8231dd2023-04-21 17:37:11 -0700354func loadFromConfigFile(configurable *ProductVariables, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800355 // Try to open the file
Colin Cross485e5722015-08-27 13:28:01 -0700356 configFileReader, err := os.Open(filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800357 defer configFileReader.Close()
358 if os.IsNotExist(err) {
359 // Need to create a file, so that blueprint & ninja don't get in
360 // a dependency tracking loop.
361 // Make a file-configurable-options with defaults, write it out using
362 // a json writer.
Colin Cross27385972015-09-18 10:57:10 -0700363 configurable.SetDefaultConfig()
364 err = saveToConfigFile(configurable, filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800365 if err != nil {
366 return err
367 }
Colin Cross15cd21a2018-02-27 11:26:02 -0800368 } else if err != nil {
369 return fmt.Errorf("config file: could not open %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800370 } else {
371 // Make a decoder for it
372 jsonDecoder := json.NewDecoder(configFileReader)
Cole Fauste1129b82024-06-04 11:10:11 -0700373 jsonDecoder.DisallowUnknownFields()
Colin Cross485e5722015-08-27 13:28:01 -0700374 err = jsonDecoder.Decode(configurable)
Colin Cross3f40fa42015-01-30 17:27:36 -0800375 if err != nil {
Colin Cross15cd21a2018-02-27 11:26:02 -0800376 return fmt.Errorf("config file: %s did not parse correctly: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800377 }
378 }
379
Liz Kammer09f947d2021-05-12 14:51:49 -0400380 if Bool(configurable.GcovCoverage) && Bool(configurable.ClangCoverage) {
381 return fmt.Errorf("GcovCoverage and ClangCoverage cannot both be set")
382 }
383
384 configurable.Native_coverage = proptools.BoolPtr(
385 Bool(configurable.GcovCoverage) ||
386 Bool(configurable.ClangCoverage))
387
Cole Faustd92430e2024-02-07 01:02:04 +0000388 // The go scanner's definition of identifiers is c-style identifiers, but allowing unicode's
389 // definition of letters and digits. This is the same scanner that blueprint uses, so it
390 // will allow the same identifiers as are valid in bp files.
391 for namespace := range configurable.VendorVars {
392 if !isGoIdentifier(namespace) {
393 return fmt.Errorf("soong config namespaces must be valid identifiers: %q", namespace)
394 }
395 for variable := range configurable.VendorVars[namespace] {
396 if !isGoIdentifier(variable) {
397 return fmt.Errorf("soong config variables must be valid identifiers: %q", variable)
398 }
399 }
400 }
401
Yuntao Xu402e9b02021-08-09 15:44:44 -0700402 // when Platform_sdk_final is true (or PLATFORM_VERSION_CODENAME is REL), use Platform_sdk_version;
403 // if false (pre-released version, for example), use Platform_sdk_codename.
404 if Bool(configurable.Platform_sdk_final) {
405 if configurable.Platform_sdk_version != nil {
406 configurable.Platform_sdk_version_or_codename =
407 proptools.StringPtr(strconv.Itoa(*(configurable.Platform_sdk_version)))
408 } else {
409 return fmt.Errorf("Platform_sdk_version cannot be pointed by a NULL pointer")
410 }
411 } else {
412 configurable.Platform_sdk_version_or_codename =
413 proptools.StringPtr(String(configurable.Platform_sdk_codename))
414 }
415
Liz Kammer09f947d2021-05-12 14:51:49 -0400416 return saveToBazelConfigFile(configurable, filepath.Dir(filename))
Colin Cross3f40fa42015-01-30 17:27:36 -0800417}
418
Colin Crossd8f20142016-11-03 09:43:26 -0700419// atomically writes the config file in case two copies of soong_build are running simultaneously
420// (for example, docs generation and ninja manifest generation)
Cole Faustf8231dd2023-04-21 17:37:11 -0700421func saveToConfigFile(config *ProductVariables, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800422 data, err := json.MarshalIndent(&config, "", " ")
423 if err != nil {
424 return fmt.Errorf("cannot marshal config data: %s", err.Error())
425 }
426
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800427 f, err := os.CreateTemp(filepath.Dir(filename), "config")
Colin Cross3f40fa42015-01-30 17:27:36 -0800428 if err != nil {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500429 return fmt.Errorf("cannot create empty config file %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800430 }
Colin Crossd8f20142016-11-03 09:43:26 -0700431 defer os.Remove(f.Name())
432 defer f.Close()
Colin Cross3f40fa42015-01-30 17:27:36 -0800433
Colin Crossd8f20142016-11-03 09:43:26 -0700434 _, err = f.Write(data)
Colin Cross3f40fa42015-01-30 17:27:36 -0800435 if err != nil {
Colin Cross485e5722015-08-27 13:28:01 -0700436 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
437 }
438
Colin Crossd8f20142016-11-03 09:43:26 -0700439 _, err = f.WriteString("\n")
Colin Cross485e5722015-08-27 13:28:01 -0700440 if err != nil {
441 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800442 }
443
Colin Crossd8f20142016-11-03 09:43:26 -0700444 f.Close()
445 os.Rename(f.Name(), filename)
446
Colin Cross3f40fa42015-01-30 17:27:36 -0800447 return nil
448}
449
Cole Faust87c0c332023-07-31 12:10:12 -0700450type productVariableStarlarkRepresentation struct {
451 soongType string
452 selectable bool
453 archVariant bool
454}
455
Cole Faustf8231dd2023-04-21 17:37:11 -0700456func saveToBazelConfigFile(config *ProductVariables, outDir string) error {
Liz Kammer09f947d2021-05-12 14:51:49 -0400457 dir := filepath.Join(outDir, bazel.SoongInjectionDirName, "product_config")
458 err := createDirIfNonexistent(dir, os.ModePerm)
459 if err != nil {
460 return fmt.Errorf("Could not create dir %s: %s", dir, err)
461 }
462
Cole Faust87c0c332023-07-31 12:10:12 -0700463 allProductVariablesType := reflect.TypeOf((*ProductVariables)(nil)).Elem()
464 productVariablesInfo := make(map[string]productVariableStarlarkRepresentation)
Sam Delmerico5c32bbf2022-01-20 20:15:02 +0000465 p := variableProperties{}
466 t := reflect.TypeOf(p.Product_variables)
467 for i := 0; i < t.NumField(); i++ {
468 f := t.Field(i)
Cole Faust87c0c332023-07-31 12:10:12 -0700469 archVariant := proptools.HasTag(f, "android", "arch_variant")
470 if mainProductVariablesStructField, ok := allProductVariablesType.FieldByName(f.Name); ok {
471 productVariablesInfo[f.Name] = productVariableStarlarkRepresentation{
472 soongType: stringRepresentationOfSimpleType(mainProductVariablesStructField.Type),
473 selectable: true,
474 archVariant: archVariant,
475 }
476 } else {
477 panic("Unknown variable " + f.Name)
Sam Delmerico5c32bbf2022-01-20 20:15:02 +0000478 }
479 }
480
Cole Fausteb644cf2023-04-11 13:48:17 -0700481 err = pathtools.WriteFileIfChanged(filepath.Join(dir, "product_variable_constants.bzl"), []byte(fmt.Sprintf(`
Cole Faust87c0c332023-07-31 12:10:12 -0700482# product_var_constant_info is a map of product variables to information about them. The fields are:
483# - soongType: The type of the product variable as it appears in soong's ProductVariables struct.
484# examples are string, bool, int, *bool, *string, []string, etc. This may be an overly
485# conservative estimation of the type, for example a *bool could oftentimes just be a
486# bool that defaults to false.
487# - selectable: if this product variable can be selected on in Android.bp/build files. This means
488# it's listed in the "variableProperties" soong struct. Currently all variables in
489# this list are selectable because we only need the selectable ones at the moment,
490# but the list may be expanded later.
491# - archVariant: If the variable is tagged as arch variant in the "variableProperties" struct.
492product_var_constant_info = %s
493product_var_constraints = [k for k, v in product_var_constant_info.items() if v.selectable]
494arch_variant_product_var_constraints = [k for k, v in product_var_constant_info.items() if v.selectable and v.archVariant]
495`, starlark_fmt.PrintAny(productVariablesInfo, 0))), 0644)
Cole Fausteb644cf2023-04-11 13:48:17 -0700496 if err != nil {
497 return fmt.Errorf("Could not write .bzl config file %s", err)
498 }
Chris Parsons0008cf82023-02-03 18:45:43 -0500499 err = pathtools.WriteFileIfChanged(filepath.Join(dir, "BUILD"),
500 []byte(bazel.GeneratedBazelFileWarning), 0644)
Liz Kammer09f947d2021-05-12 14:51:49 -0400501 if err != nil {
502 return fmt.Errorf("Could not write BUILD config file %s", err)
503 }
504
505 return nil
506}
507
Cole Faust87c0c332023-07-31 12:10:12 -0700508func stringRepresentationOfSimpleType(ty reflect.Type) string {
509 switch ty.Kind() {
510 case reflect.String:
511 return "string"
512 case reflect.Bool:
513 return "bool"
514 case reflect.Int:
515 return "int"
516 case reflect.Slice:
517 return "[]" + stringRepresentationOfSimpleType(ty.Elem())
518 case reflect.Pointer:
519 return "*" + stringRepresentationOfSimpleType(ty.Elem())
520 default:
521 panic("unimplemented type: " + ty.Kind().String())
522 }
523}
524
Colin Cross988414c2020-01-11 01:11:46 +0000525// NullConfig returns a mostly empty Config for use by standalone tools like dexpreopt_gen that
526// use the android package.
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200527func NullConfig(outDir, soongOutDir string) Config {
Colin Cross988414c2020-01-11 01:11:46 +0000528 return Config{
529 config: &config{
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200530 outDir: outDir,
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200531 soongOutDir: soongOutDir,
532 fs: pathtools.OsFs,
Colin Cross988414c2020-01-11 01:11:46 +0000533 },
534 }
535}
536
Jingwen Chenc711fec2020-11-22 23:52:50 -0500537// NewConfig creates a new Config object. The srcDir argument specifies the path
538// to the root source directory. It also loads the config file, if found.
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800539func NewConfig(cmdArgs CmdArgs, availableEnv map[string]string) (Config, error) {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500540 // Make a config with default options.
Colin Cross9272ade2016-08-17 15:24:12 -0700541 config := &config{
Kiyoung Kima37d9ba2023-04-19 13:13:45 +0900542 ProductVariablesFileName: cmdArgs.SoongVariables,
Dan Willemsen87b17d12015-07-14 00:39:06 -0700543
Lukacs T. Berki53b2f362021-04-12 14:04:24 +0200544 env: availableEnv,
Colin Cross6ccbc912017-10-10 23:07:38 -0700545
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800546 outDir: cmdArgs.OutDir,
547 soongOutDir: cmdArgs.SoongOutDir,
548 runGoTests: cmdArgs.RunGoTests,
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +0200549 multilibConflicts: make(map[ArchType]bool),
Colin Cross98be1bb2019-12-13 20:41:13 -0800550
Colin Crossb63d7b32023-12-07 16:54:51 -0800551 moduleListFile: cmdArgs.ModuleListFile,
552 fs: pathtools.NewOsFs(absSrcDir),
Chris Parsons9402ca82023-02-23 17:28:06 -0500553
Jihoon Kang2a929ad2023-06-08 19:02:07 +0000554 buildFromSourceStub: cmdArgs.BuildFromSourceStub,
Colin Cross68f55102015-03-25 14:43:57 -0700555 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800556
Dan Willemsen00269f22017-07-06 16:59:48 -0700557 config.deviceConfig = &deviceConfig{
Colin Cross9272ade2016-08-17 15:24:12 -0700558 config: config,
559 }
560
Liz Kammer7941b302020-07-28 13:27:34 -0700561 // Soundness check of the build and source directories. This won't catch strange
562 // configurations with symlinks, but at least checks the obvious case.
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800563 absBuildDir, err := filepath.Abs(cmdArgs.SoongOutDir)
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700564 if err != nil {
565 return Config{}, err
566 }
567
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200568 absSrcDir, err := filepath.Abs(".")
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700569 if err != nil {
570 return Config{}, err
571 }
572
573 if strings.HasPrefix(absSrcDir, absBuildDir) {
574 return Config{}, fmt.Errorf("Build dir must not contain source directory")
575 }
576
Colin Cross3f40fa42015-01-30 17:27:36 -0800577 // Load any configurable options from the configuration file
Colin Cross9272ade2016-08-17 15:24:12 -0700578 err = loadConfig(config)
Colin Cross3f40fa42015-01-30 17:27:36 -0800579 if err != nil {
Colin Crossc3c0a492015-04-10 15:43:55 -0700580 return Config{}, err
Colin Cross3f40fa42015-01-30 17:27:36 -0800581 }
582
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800583 KatiEnabledMarkerFile := filepath.Join(cmdArgs.SoongOutDir, ".soong.kati_enabled")
Jingwen Chencda22c92020-11-23 00:22:30 -0500584 if _, err := os.Stat(absolutePath(KatiEnabledMarkerFile)); err == nil {
585 config.katiEnabled = true
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800586 }
587
Colin Cross0c66bc62021-07-20 09:47:41 -0700588 determineBuildOS(config)
589
Jingwen Chenc711fec2020-11-22 23:52:50 -0500590 // Sets up the map of target OSes to the finer grained compilation targets
591 // that are configured from the product variables.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700592 targets, err := decodeTargetProductVariables(config)
Dan Willemsen218f6562015-07-08 18:13:11 -0700593 if err != nil {
594 return Config{}, err
595 }
596
Paul Duffin1356d8c2020-02-25 19:26:33 +0000597 // Make the CommonOS OsType available for all products.
598 targets[CommonOS] = []Target{commonTargetMap[CommonOS.Name]}
599
Dan Albert4098deb2016-10-19 14:04:41 -0700600 var archConfig []archConfig
Jingwen Chenc4d91bc2020-11-24 22:59:26 -0500601 if config.NdkAbis() {
Dan Albert4098deb2016-10-19 14:04:41 -0700602 archConfig = getNdkAbisConfig()
Martin Stjernholmc1ecc432019-11-15 15:00:31 +0000603 } else if config.AmlAbis() {
604 archConfig = getAmlAbisConfig()
Dan Albert4098deb2016-10-19 14:04:41 -0700605 }
606
607 if archConfig != nil {
Liz Kammerb7f33662022-02-28 14:16:16 -0500608 androidTargets, err := decodeAndroidArchSettings(archConfig)
Dan Willemsen322acaf2016-01-12 23:07:05 -0800609 if err != nil {
610 return Config{}, err
611 }
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700612 targets[Android] = androidTargets
Dan Willemsen322acaf2016-01-12 23:07:05 -0800613 }
614
Colin Cross3b19f5d2019-09-17 14:45:31 -0700615 multilib := make(map[string]bool)
616 for _, target := range targets[Android] {
617 if seen := multilib[target.Arch.ArchType.Multilib]; seen {
618 config.multilibConflicts[target.Arch.ArchType] = true
619 }
620 multilib[target.Arch.ArchType.Multilib] = true
621 }
622
Jingwen Chenc711fec2020-11-22 23:52:50 -0500623 // Map of OS to compilation targets.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700624 config.Targets = targets
Jingwen Chenc711fec2020-11-22 23:52:50 -0500625
626 // Compilation targets for host tools.
Colin Cross0c66bc62021-07-20 09:47:41 -0700627 config.BuildOSTarget = config.Targets[config.BuildOS][0]
628 config.BuildOSCommonTarget = getCommonTargets(config.Targets[config.BuildOS])[0]
Jingwen Chenc711fec2020-11-22 23:52:50 -0500629
630 // Compilation targets for Android.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700631 if len(config.Targets[Android]) > 0 {
632 config.AndroidCommonTarget = getCommonTargets(config.Targets[Android])[0]
Sam Delmericocc271e22022-06-01 15:45:02 +0000633 config.AndroidFirstDeviceTarget = FirstTarget(config.Targets[Android], "lib64", "lib32")[0]
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700634 }
Dan Willemsen218f6562015-07-08 18:13:11 -0700635
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500636 setBuildMode := func(arg string, mode SoongBuildMode) {
637 if arg != "" {
638 if config.BuildMode != AnalysisNoBazel {
639 fmt.Fprintf(os.Stderr, "buildMode is already set, illegal argument: %s", arg)
640 os.Exit(1)
641 }
642 config.BuildMode = mode
643 }
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800644 }
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500645 setBuildMode(cmdArgs.BazelQueryViewDir, GenerateQueryView)
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500646 setBuildMode(cmdArgs.ModuleGraphFile, GenerateModuleGraph)
647 setBuildMode(cmdArgs.DocFile, GenerateDocFile)
MarkDacekd06db5d2022-11-29 00:47:59 +0000648
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000649 // TODO(b/276958307): Replace the hardcoded list to a sdk_library local prop.
650 config.apiLibraries = map[string]struct{}{
651 "android.net.ipsec.ike": {},
652 "art.module.public.api": {},
653 "conscrypt.module.public.api": {},
654 "framework-adservices": {},
655 "framework-appsearch": {},
656 "framework-bluetooth": {},
Jihoon Kang480943f2023-05-19 06:02:08 +0000657 "framework-configinfrastructure": {},
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000658 "framework-connectivity": {},
659 "framework-connectivity-t": {},
Jihoon Kang480943f2023-05-19 06:02:08 +0000660 "framework-devicelock": {},
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000661 "framework-graphics": {},
Jihoon Kang480943f2023-05-19 06:02:08 +0000662 "framework-healthfitness": {},
Mark White387a6582023-08-06 00:20:47 +0000663 "framework-location": {},
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000664 "framework-media": {},
665 "framework-mediaprovider": {},
Roshan Pius92307ff2023-11-13 17:16:35 -0800666 "framework-nfc": {},
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000667 "framework-ondevicepersonalization": {},
Alyssa Ketpreechasawat9f634362023-11-08 16:03:53 +0000668 "framework-pdf": {},
Nishant Panwar0ce94652024-02-10 09:02:15 +0000669 "framework-pdf-v": {},
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000670 "framework-permission": {},
671 "framework-permission-s": {},
672 "framework-scheduling": {},
673 "framework-sdkextensions": {},
674 "framework-statsd": {},
675 "framework-sdksandbox": {},
676 "framework-tethering": {},
677 "framework-uwb": {},
678 "framework-virtualization": {},
679 "framework-wifi": {},
680 "i18n.module.public.api": {},
681 }
682
Jihoon Kangc1b04d62023-11-16 19:07:04 +0000683 config.productVariables.Build_from_text_stub = boolPtr(config.BuildFromTextStub())
684
Jingwen Chenc711fec2020-11-22 23:52:50 -0500685 return Config{config}, err
686}
Colin Cross988414c2020-01-11 01:11:46 +0000687
Colin Cross98be1bb2019-12-13 20:41:13 -0800688// mockFileSystem replaces all reads with accesses to the provided map of
689// filenames to contents stored as a byte slice.
690func (c *config) mockFileSystem(bp string, fs map[string][]byte) {
691 mockFS := map[string][]byte{}
692
693 if _, exists := mockFS["Android.bp"]; !exists {
694 mockFS["Android.bp"] = []byte(bp)
695 }
696
697 for k, v := range fs {
698 mockFS[k] = v
699 }
700
701 // no module list file specified; find every file named Blueprints or Android.bp
702 pathsToParse := []string{}
703 for candidate := range mockFS {
704 base := filepath.Base(candidate)
Lukacs T. Berkib838b0a2021-09-02 11:46:24 +0200705 if base == "Android.bp" {
Colin Cross98be1bb2019-12-13 20:41:13 -0800706 pathsToParse = append(pathsToParse, candidate)
707 }
708 }
709 if len(pathsToParse) < 1 {
710 panic(fmt.Sprintf("No Blueprint or Android.bp files found in mock filesystem: %v\n", mockFS))
711 }
712 mockFS[blueprint.MockModuleListFile] = []byte(strings.Join(pathsToParse, "\n"))
713
714 c.fs = pathtools.MockFs(mockFS)
715 c.mockBpList = blueprint.MockModuleListFile
716}
717
Lukacs T. Berkid1e3f1f2021-03-16 08:55:23 +0100718func (c *config) SetAllowMissingDependencies() {
719 c.productVariables.Allow_missing_dependencies = proptools.BoolPtr(true)
720}
721
Jingwen Chenc711fec2020-11-22 23:52:50 -0500722// BlueprintToolLocation returns the directory containing build system tools
723// from Blueprint, like soong_zip and merge_zips.
Lukacs T. Berkia806e412021-09-01 08:57:48 +0200724func (c *config) HostToolDir() string {
Colin Crossacfcc1f2021-10-25 15:40:32 -0700725 if c.KatiEnabled() {
726 return filepath.Join(c.outDir, "host", c.PrebuiltOS(), "bin")
727 } else {
728 return filepath.Join(c.soongOutDir, "host", c.PrebuiltOS(), "bin")
729 }
Dan Willemsenc2aa4a92016-05-26 15:13:03 -0700730}
731
Dan Willemsen60e62f02018-11-16 21:05:32 -0800732func (c *config) HostToolPath(ctx PathContext, tool string) Path {
Cole Faust3b703f32023-10-16 13:30:51 -0700733 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "bin", tool)
Colin Cross790ef352021-10-25 19:15:55 -0700734 return path
Dan Willemsen60e62f02018-11-16 21:05:32 -0800735}
736
Colin Cross790ef352021-10-25 19:15:55 -0700737func (c *config) HostJNIToolPath(ctx PathContext, lib string) Path {
Martin Stjernholm7260d062019-12-09 21:47:14 +0000738 ext := ".so"
739 if runtime.GOOS == "darwin" {
740 ext = ".dylib"
741 }
Cole Faust3b703f32023-10-16 13:30:51 -0700742 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "lib64", lib+ext)
Colin Cross790ef352021-10-25 19:15:55 -0700743 return path
Martin Stjernholm7260d062019-12-09 21:47:14 +0000744}
745
Colin Crossae5330a2021-11-03 13:31:22 -0700746func (c *config) HostJavaToolPath(ctx PathContext, tool string) Path {
Cole Faust3b703f32023-10-16 13:30:51 -0700747 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "framework", tool)
Colin Cross3e3eda62021-11-04 10:22:51 -0700748 return path
749}
750
Vinh Tran09581952023-05-16 16:03:20 -0400751func (c *config) HostCcSharedLibPath(ctx PathContext, lib string) Path {
752 libDir := "lib"
753 if ctx.Config().BuildArch.Multilib == "lib64" {
754 libDir = "lib64"
755 }
Cole Faust3b703f32023-10-16 13:30:51 -0700756 return pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, libDir, lib+".so")
Vinh Tran09581952023-05-16 16:03:20 -0400757}
758
Jingwen Chenc711fec2020-11-22 23:52:50 -0500759// PrebuiltOS returns the name of the host OS used in prebuilts directories.
Colin Cross1332b002015-04-07 17:11:30 -0700760func (c *config) PrebuiltOS() string {
Colin Cross3f40fa42015-01-30 17:27:36 -0800761 switch runtime.GOOS {
762 case "linux":
763 return "linux-x86"
764 case "darwin":
765 return "darwin-x86"
766 default:
767 panic("Unknown GOOS")
768 }
769}
770
771// GoRoot returns the path to the root directory of the Go toolchain.
Colin Cross1332b002015-04-07 17:11:30 -0700772func (c *config) GoRoot() string {
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200773 return fmt.Sprintf("prebuilts/go/%s", c.PrebuiltOS())
Colin Cross3f40fa42015-01-30 17:27:36 -0800774}
775
Jingwen Chenc711fec2020-11-22 23:52:50 -0500776// PrebuiltBuildTool returns the path to a tool in the prebuilts directory containing
777// checked-in tools, like Kati, Ninja or Toybox, for the current host OS.
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700778func (c *config) PrebuiltBuildTool(ctx PathContext, tool string) Path {
779 return PathForSource(ctx, "prebuilts/build-tools", c.PrebuiltOS(), "bin", tool)
780}
781
Jingwen Chenc711fec2020-11-22 23:52:50 -0500782// CpPreserveSymlinksFlags returns the host-specific flag for the cp(1) command
783// to preserve symlinks.
Colin Cross1332b002015-04-07 17:11:30 -0700784func (c *config) CpPreserveSymlinksFlags() string {
Colin Cross485e5722015-08-27 13:28:01 -0700785 switch runtime.GOOS {
Colin Cross3f40fa42015-01-30 17:27:36 -0800786 case "darwin":
787 return "-R"
788 case "linux":
789 return "-d"
790 default:
791 return ""
792 }
793}
Colin Cross68f55102015-03-25 14:43:57 -0700794
Colin Cross1332b002015-04-07 17:11:30 -0700795func (c *config) Getenv(key string) string {
Colin Cross68f55102015-03-25 14:43:57 -0700796 var val string
797 var exists bool
Colin Crossc1e86a32015-04-15 12:33:28 -0700798 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800799 defer c.envLock.Unlock()
800 if c.envDeps == nil {
801 c.envDeps = make(map[string]string)
802 }
Colin Cross68f55102015-03-25 14:43:57 -0700803 if val, exists = c.envDeps[key]; !exists {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700804 if c.envFrozen {
805 panic("Cannot access new environment variables after envdeps are frozen")
806 }
Colin Cross6ccbc912017-10-10 23:07:38 -0700807 val, _ = c.env[key]
Colin Cross68f55102015-03-25 14:43:57 -0700808 c.envDeps[key] = val
809 }
810 return val
811}
812
Colin Cross99d7c232016-11-23 16:52:04 -0800813func (c *config) GetenvWithDefault(key string, defaultValue string) string {
814 ret := c.Getenv(key)
815 if ret == "" {
816 return defaultValue
817 }
818 return ret
819}
820
821func (c *config) IsEnvTrue(key string) bool {
AdityaK19384102024-05-01 13:51:25 -0700822 value := strings.ToLower(c.Getenv(key))
Colin Cross99d7c232016-11-23 16:52:04 -0800823 return value == "1" || value == "y" || value == "yes" || value == "on" || value == "true"
824}
825
826func (c *config) IsEnvFalse(key string) bool {
AdityaK19384102024-05-01 13:51:25 -0700827 value := strings.ToLower(c.Getenv(key))
Colin Cross99d7c232016-11-23 16:52:04 -0800828 return value == "0" || value == "n" || value == "no" || value == "off" || value == "false"
829}
830
Sorin Basca253f8c02024-05-23 10:28:24 +0100831func (c *config) TargetsJava21() bool {
832 return c.IsEnvTrue("EXPERIMENTAL_TARGET_JAVA_VERSION_21")
833}
834
Jingwen Chenc711fec2020-11-22 23:52:50 -0500835// EnvDeps returns the environment variables this build depends on. The first
836// call to this function blocks future reads from the environment.
Colin Cross1332b002015-04-07 17:11:30 -0700837func (c *config) EnvDeps() map[string]string {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700838 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800839 defer c.envLock.Unlock()
Dan Willemsene7680ba2015-09-11 17:06:19 -0700840 c.envFrozen = true
Colin Cross68f55102015-03-25 14:43:57 -0700841 return c.envDeps
842}
Colin Cross35cec122015-04-02 14:37:16 -0700843
Jingwen Chencda22c92020-11-23 00:22:30 -0500844func (c *config) KatiEnabled() bool {
845 return c.katiEnabled
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800846}
847
Cole Faust11edf552023-10-13 11:32:14 -0700848func (c *config) ProductVariables() ProductVariables {
849 return c.productVariables
850}
851
Nan Zhang581fd212018-01-10 16:06:12 -0800852func (c *config) BuildId() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800853 return String(c.productVariables.BuildId)
Nan Zhang581fd212018-01-10 16:06:12 -0800854}
855
Inseob Kim8fa54da2024-03-19 16:48:59 +0900856func (c *config) DisplayBuildNumber() bool {
857 return Bool(c.productVariables.DisplayBuildNumber)
858}
859
Jingwen Chenc711fec2020-11-22 23:52:50 -0500860// BuildNumberFile returns the path to a text file containing metadata
861// representing the current build's number.
862//
863// Rules that want to reference the build number should read from this file
864// without depending on it. They will run whenever their other dependencies
865// require them to run and get the current build number. This ensures they don't
866// rebuild on every incremental build when the build number changes.
Colin Cross2a2e0db2020-02-21 16:55:46 -0800867func (c *config) BuildNumberFile(ctx PathContext) Path {
868 return PathForOutput(ctx, String(c.productVariables.BuildNumberFile))
Nan Zhang581fd212018-01-10 16:06:12 -0800869}
870
Inseob Kim8fa54da2024-03-19 16:48:59 +0900871// BuildHostnameFile returns the path to a text file containing metadata
872// representing the current build's host name.
873func (c *config) BuildHostnameFile(ctx PathContext) Path {
874 return PathForOutput(ctx, String(c.productVariables.BuildHostnameFile))
875}
876
877// BuildThumbprintFile returns the path to a text file containing metadata
878// representing the current build's thumbprint.
879//
880// Rules that want to reference the build thumbprint should read from this file
881// without depending on it. They will run whenever their other dependencies
882// require them to run and get the current build thumbprint. This ensures they
883// don't rebuild on every incremental build when the build thumbprint changes.
884func (c *config) BuildThumbprintFile(ctx PathContext) Path {
885 return PathForArbitraryOutput(ctx, "target", "product", c.DeviceName(), String(c.productVariables.BuildThumbprintFile))
886}
887
Jingwen Chenc711fec2020-11-22 23:52:50 -0500888// DeviceName returns the name of the current device target.
Colin Cross35cec122015-04-02 14:37:16 -0700889// TODO: take an AndroidModuleContext to select the device name for multi-device builds
Colin Cross1332b002015-04-07 17:11:30 -0700890func (c *config) DeviceName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800891 return *c.productVariables.DeviceName
Colin Cross35cec122015-04-02 14:37:16 -0700892}
893
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000894// DeviceProduct returns the current product target. There could be multiple of
895// these per device type.
896//
Chris Parsonsef615e52022-08-18 22:04:11 -0400897// NOTE: Do not base conditional logic on this value. It may break product inheritance.
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000898func (c *config) DeviceProduct() string {
899 return *c.productVariables.DeviceProduct
900}
901
Cole Faustb85d1a12022-11-08 18:14:01 -0800902// HasDeviceProduct returns if the build has a product. A build will not
903// necessarily have a product when --skip-config is passed to soong, like it is
904// in prebuilts/build-tools/build-prebuilts.sh
905func (c *config) HasDeviceProduct() bool {
906 return c.productVariables.DeviceProduct != nil
907}
908
Inseob Kim8fa54da2024-03-19 16:48:59 +0900909func (c *config) DeviceAbi() []string {
910 return c.productVariables.DeviceAbi
911}
912
Anton Hansson53c88442019-03-18 15:53:16 +0000913func (c *config) DeviceResourceOverlays() []string {
914 return c.productVariables.DeviceResourceOverlays
915}
916
917func (c *config) ProductResourceOverlays() []string {
918 return c.productVariables.ProductResourceOverlays
Colin Cross30e076a2015-04-13 13:58:27 -0700919}
920
Inseob Kim8fa54da2024-03-19 16:48:59 +0900921func (c *config) PlatformDisplayVersionName() string {
922 return String(c.productVariables.Platform_display_version_name)
923}
924
Colin Crossbfd347d2018-05-09 11:11:35 -0700925func (c *config) PlatformVersionName() string {
926 return String(c.productVariables.Platform_version_name)
927}
928
Dan Albert4f378d72020-07-23 17:32:15 -0700929func (c *config) PlatformSdkVersion() ApiLevel {
930 return uncheckedFinalApiLevel(*c.productVariables.Platform_sdk_version)
Colin Cross30e076a2015-04-13 13:58:27 -0700931}
932
Cole Faust37d27c42023-04-12 10:27:45 -0700933func (c *config) RawPlatformSdkVersion() *int {
934 return c.productVariables.Platform_sdk_version
935}
936
Mu-Le Lee5e047532022-07-27 02:32:03 +0000937func (c *config) PlatformSdkFinal() bool {
938 return Bool(c.productVariables.Platform_sdk_final)
939}
940
Colin Crossd09b0b62018-04-18 11:06:47 -0700941func (c *config) PlatformSdkCodename() string {
942 return String(c.productVariables.Platform_sdk_codename)
943}
944
Anton Hansson97d0bae2022-02-16 16:15:10 +0000945func (c *config) PlatformSdkExtensionVersion() int {
946 return *c.productVariables.Platform_sdk_extension_version
947}
948
949func (c *config) PlatformBaseSdkExtensionVersion() int {
950 return *c.productVariables.Platform_base_sdk_extension_version
951}
952
Colin Cross092c9da2019-04-02 22:56:43 -0700953func (c *config) PlatformSecurityPatch() string {
954 return String(c.productVariables.Platform_security_patch)
955}
956
957func (c *config) PlatformPreviewSdkVersion() string {
958 return String(c.productVariables.Platform_preview_sdk_version)
959}
960
961func (c *config) PlatformMinSupportedTargetSdkVersion() string {
Linus Tufvessonba270c52024-04-12 13:06:22 +0200962 var val, ok = c.productVariables.BuildFlags["RELEASE_PLATFORM_MIN_SUPPORTED_TARGET_SDK_VERSION"]
963 if !ok {
964 return ""
965 }
966 return val
Colin Cross092c9da2019-04-02 22:56:43 -0700967}
968
969func (c *config) PlatformBaseOS() string {
970 return String(c.productVariables.Platform_base_os)
971}
972
Inseob Kim4f1f3d92022-04-25 18:23:58 +0900973func (c *config) PlatformVersionLastStable() string {
974 return String(c.productVariables.Platform_version_last_stable)
975}
976
Jiyong Park37073842022-06-21 10:13:42 +0900977func (c *config) PlatformVersionKnownCodenames() string {
978 return String(c.productVariables.Platform_version_known_codenames)
979}
980
Dan Albert1a246272020-07-06 14:49:35 -0700981func (c *config) MinSupportedSdkVersion() ApiLevel {
Dan Albert6bfb6bb2022-08-17 20:11:57 +0000982 return uncheckedFinalApiLevel(21)
Dan Albert1a246272020-07-06 14:49:35 -0700983}
984
985func (c *config) FinalApiLevels() []ApiLevel {
986 var levels []ApiLevel
Dan Albert4f378d72020-07-23 17:32:15 -0700987 for i := 1; i <= c.PlatformSdkVersion().FinalOrFutureInt(); i++ {
Dan Albert1a246272020-07-06 14:49:35 -0700988 levels = append(levels, uncheckedFinalApiLevel(i))
989 }
990 return levels
991}
992
993func (c *config) PreviewApiLevels() []ApiLevel {
994 var levels []ApiLevel
Dan Albertf93ea132023-10-05 20:40:46 +0000995 i := 0
996 for _, codename := range c.PlatformVersionActiveCodenames() {
997 if codename == "REL" {
998 continue
999 }
1000
Dan Albert1a246272020-07-06 14:49:35 -07001001 levels = append(levels, ApiLevel{
1002 value: codename,
1003 number: i,
1004 isPreview: true,
1005 })
Dan Albertf93ea132023-10-05 20:40:46 +00001006 i++
Dan Albert1a246272020-07-06 14:49:35 -07001007 }
1008 return levels
1009}
1010
satayevcca4ab72021-11-30 12:33:55 +00001011func (c *config) LatestPreviewApiLevel() ApiLevel {
1012 level := NoneApiLevel
1013 for _, l := range c.PreviewApiLevels() {
1014 if l.GreaterThan(level) {
1015 level = l
1016 }
1017 }
1018 return level
1019}
1020
Dan Albert1a246272020-07-06 14:49:35 -07001021func (c *config) AllSupportedApiLevels() []ApiLevel {
1022 var levels []ApiLevel
1023 levels = append(levels, c.FinalApiLevels()...)
1024 return append(levels, c.PreviewApiLevels()...)
Dan Albertf5415d72017-08-17 16:19:59 -07001025}
1026
Jingwen Chenc711fec2020-11-22 23:52:50 -05001027// DefaultAppTargetSdk returns the API level that platform apps are targeting.
1028// This converts a codename to the exact ApiLevel it represents.
Dan Albert4f378d72020-07-23 17:32:15 -07001029func (c *config) DefaultAppTargetSdk(ctx EarlyModuleContext) ApiLevel {
Colin Crossd09b0b62018-04-18 11:06:47 -07001030 if Bool(c.productVariables.Platform_sdk_final) {
1031 return c.PlatformSdkVersion()
Colin Crossd09b0b62018-04-18 11:06:47 -07001032 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001033 codename := c.PlatformSdkCodename()
Jiyong Park3a00e3d2023-03-27 17:39:48 +09001034 hostOnlyBuild := c.productVariables.DeviceArch == nil
Jingwen Chenc711fec2020-11-22 23:52:50 -05001035 if codename == "" {
Jiyong Park3a00e3d2023-03-27 17:39:48 +09001036 // There are some host-only builds (those are invoked by build-prebuilts.sh) which
1037 // don't set platform sdk codename. Platform sdk codename makes sense only when we
1038 // are building the platform. So we don't enforce the below panic for the host-only
1039 // builds.
1040 if hostOnlyBuild {
1041 return NoneApiLevel
1042 }
1043 panic("Platform_sdk_codename must be set")
Jingwen Chenc711fec2020-11-22 23:52:50 -05001044 }
1045 if codename == "REL" {
1046 panic("Platform_sdk_codename should not be REL when Platform_sdk_final is true")
1047 }
1048 return ApiLevelOrPanic(ctx, codename)
Colin Crossd09b0b62018-04-18 11:06:47 -07001049}
1050
Colin Cross3bc7ffa2017-11-22 16:19:37 -08001051func (c *config) AppsDefaultVersionName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001052 return String(c.productVariables.AppsDefaultVersionName)
Colin Cross3bc7ffa2017-11-22 16:19:37 -08001053}
1054
Dan Albert31384de2017-07-28 12:39:46 -07001055// Codenames that are active in the current lunch target.
1056func (c *config) PlatformVersionActiveCodenames() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001057 return c.productVariables.Platform_version_active_codenames
Dan Albert31384de2017-07-28 12:39:46 -07001058}
1059
Dan Albert8c7a9942023-03-27 20:34:01 +00001060// All unreleased codenames.
1061func (c *config) PlatformVersionAllPreviewCodenames() []string {
1062 return c.productVariables.Platform_version_all_preview_codenames
1063}
1064
Colin Crossface4e42017-10-30 17:32:15 -07001065func (c *config) ProductAAPTConfig() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001066 return c.productVariables.AAPTConfig
Colin Cross30e076a2015-04-13 13:58:27 -07001067}
1068
Colin Crossface4e42017-10-30 17:32:15 -07001069func (c *config) ProductAAPTPreferredConfig() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001070 return String(c.productVariables.AAPTPreferredConfig)
Colin Cross30e076a2015-04-13 13:58:27 -07001071}
1072
Colin Crossface4e42017-10-30 17:32:15 -07001073func (c *config) ProductAAPTCharacteristics() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001074 return String(c.productVariables.AAPTCharacteristics)
Colin Crossface4e42017-10-30 17:32:15 -07001075}
1076
1077func (c *config) ProductAAPTPrebuiltDPI() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001078 return c.productVariables.AAPTPrebuiltDPI
Colin Cross30e076a2015-04-13 13:58:27 -07001079}
1080
Dan Willemsen34cc69e2015-09-23 15:26:20 -07001081func (c *config) DefaultAppCertificateDir(ctx PathContext) SourcePath {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001082 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -08001083 if defaultCert != "" {
1084 return PathForSource(ctx, filepath.Dir(defaultCert))
Colin Cross61ae0b72017-12-01 17:16:02 -08001085 }
Inseob Kim8fa54da2024-03-19 16:48:59 +09001086 return PathForSource(ctx, testKeyDir)
Colin Cross30e076a2015-04-13 13:58:27 -07001087}
1088
Colin Crosse1731a52017-12-14 11:22:55 -08001089func (c *config) DefaultAppCertificate(ctx PathContext) (pem, key SourcePath) {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001090 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -08001091 if defaultCert != "" {
Colin Crosse1731a52017-12-14 11:22:55 -08001092 return PathForSource(ctx, defaultCert+".x509.pem"), PathForSource(ctx, defaultCert+".pk8")
Colin Cross61ae0b72017-12-01 17:16:02 -08001093 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001094 defaultDir := c.DefaultAppCertificateDir(ctx)
1095 return defaultDir.Join(ctx, "testkey.x509.pem"), defaultDir.Join(ctx, "testkey.pk8")
Colin Cross30e076a2015-04-13 13:58:27 -07001096}
Colin Cross6ff51382015-12-17 16:39:19 -08001097
Inseob Kim8fa54da2024-03-19 16:48:59 +09001098func (c *config) BuildKeys() string {
1099 defaultCert := String(c.productVariables.DefaultAppCertificate)
1100 if defaultCert == "" || defaultCert == filepath.Join(testKeyDir, "testkey") {
1101 return "test-keys"
1102 }
1103 return "dev-keys"
1104}
1105
Jiyong Park9335a262018-12-24 11:31:58 +09001106func (c *config) ApexKeyDir(ctx ModuleContext) SourcePath {
1107 // TODO(b/121224311): define another variable such as TARGET_APEX_KEY_OVERRIDE
1108 defaultCert := String(c.productVariables.DefaultAppCertificate)
Inseob Kim8fa54da2024-03-19 16:48:59 +09001109 if defaultCert == "" || filepath.Dir(defaultCert) == testKeyDir {
Jiyong Park9335a262018-12-24 11:31:58 +09001110 // When defaultCert is unset or is set to the testkeys path, use the APEX keys
1111 // that is under the module dir
Colin Cross07e51612019-03-05 12:46:40 -08001112 return pathForModuleSrc(ctx)
Jiyong Park9335a262018-12-24 11:31:58 +09001113 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001114 // If not, APEX keys are under the specified directory
1115 return PathForSource(ctx, filepath.Dir(defaultCert))
Jiyong Park9335a262018-12-24 11:31:58 +09001116}
1117
Inseob Kim80fa7982022-08-12 21:36:25 +09001118// Certificate for the NetworkStack sepolicy context
1119func (c *config) MainlineSepolicyDevCertificatesDir(ctx ModuleContext) SourcePath {
1120 cert := String(c.productVariables.MainlineSepolicyDevCertificates)
1121 if cert != "" {
1122 return PathForSource(ctx, cert)
1123 }
1124 return c.DefaultAppCertificateDir(ctx)
1125}
1126
Jingwen Chenc711fec2020-11-22 23:52:50 -05001127// AllowMissingDependencies configures Blueprint/Soong to not fail when modules
1128// are configured to depend on non-existent modules. Note that this does not
1129// affect missing input dependencies at the Ninja level.
Colin Cross6ff51382015-12-17 16:39:19 -08001130func (c *config) AllowMissingDependencies() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001131 return Bool(c.productVariables.Allow_missing_dependencies)
Colin Cross6ff51382015-12-17 16:39:19 -08001132}
Dan Willemsen322acaf2016-01-12 23:07:05 -08001133
Jeongik Cha816a23a2020-07-08 01:09:23 +09001134// Returns true if a full platform source tree cannot be assumed.
Colin Crossfc3674a2017-09-18 17:41:52 -07001135func (c *config) UnbundledBuild() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001136 return Bool(c.productVariables.Unbundled_build)
Colin Crossfc3674a2017-09-18 17:41:52 -07001137}
1138
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +01001139// Returns true if building apps that aren't bundled with the platform.
1140// UnbundledBuild() is always true when this is true.
1141func (c *config) UnbundledBuildApps() bool {
Cole Faust701ca252021-11-23 19:02:08 -08001142 return len(c.productVariables.Unbundled_build_apps) > 0
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +01001143}
1144
Jeongik Cha4b073cd2021-06-08 11:35:00 +09001145// Returns true if building image that aren't bundled with the platform.
1146// UnbundledBuild() is always true when this is true.
1147func (c *config) UnbundledBuildImage() bool {
1148 return Bool(c.productVariables.Unbundled_build_image)
1149}
1150
Jeongik Cha816a23a2020-07-08 01:09:23 +09001151// Returns true if building modules against prebuilt SDKs.
1152func (c *config) AlwaysUsePrebuiltSdks() bool {
1153 return Bool(c.productVariables.Always_use_prebuilt_sdks)
Colin Cross1f367bf2018-12-18 22:46:24 -08001154}
1155
Colin Cross126a25c2017-10-31 13:55:34 -07001156func (c *config) MinimizeJavaDebugInfo() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001157 return Bool(c.productVariables.MinimizeJavaDebugInfo) && !Bool(c.productVariables.Eng)
Colin Cross126a25c2017-10-31 13:55:34 -07001158}
1159
Colin Crossed064c02018-09-05 16:28:13 -07001160func (c *config) Debuggable() bool {
1161 return Bool(c.productVariables.Debuggable)
1162}
1163
Jaewoong Jung1d6eb682018-11-29 15:08:44 -08001164func (c *config) Eng() bool {
1165 return Bool(c.productVariables.Eng)
1166}
1167
Inseob Kim8fa54da2024-03-19 16:48:59 +09001168func (c *config) BuildType() string {
1169 return String(c.productVariables.BuildType)
1170}
1171
Colin Crossc53c37f2021-12-08 15:42:22 -08001172// DevicePrimaryArchType returns the ArchType for the first configured device architecture, or
1173// Common if there are no device architectures.
Jiyong Park8d52f862018-07-07 18:02:07 +09001174func (c *config) DevicePrimaryArchType() ArchType {
Colin Crossc53c37f2021-12-08 15:42:22 -08001175 if androidTargets := c.Targets[Android]; len(androidTargets) > 0 {
1176 return androidTargets[0].Arch.ArchType
1177 }
1178 return Common
Jiyong Park8d52f862018-07-07 18:02:07 +09001179}
1180
Colin Cross16b23492016-01-06 14:41:07 -08001181func (c *config) SanitizeHost() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001182 return append([]string(nil), c.productVariables.SanitizeHost...)
Colin Cross16b23492016-01-06 14:41:07 -08001183}
1184
1185func (c *config) SanitizeDevice() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001186 return append([]string(nil), c.productVariables.SanitizeDevice...)
Colin Cross23ae82a2016-11-02 14:34:39 -07001187}
1188
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -07001189func (c *config) SanitizeDeviceDiag() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001190 return append([]string(nil), c.productVariables.SanitizeDeviceDiag...)
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -07001191}
1192
Colin Cross23ae82a2016-11-02 14:34:39 -07001193func (c *config) SanitizeDeviceArch() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001194 return append([]string(nil), c.productVariables.SanitizeDeviceArch...)
Colin Cross16b23492016-01-06 14:41:07 -08001195}
Colin Crossa1ad8d12016-06-01 17:09:44 -07001196
Vishwath Mohan1b017a72017-01-19 13:54:55 -08001197func (c *config) EnableCFI() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001198 if c.productVariables.EnableCFI == nil {
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -08001199 return true
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -08001200 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001201 return *c.productVariables.EnableCFI
Vishwath Mohan1b017a72017-01-19 13:54:55 -08001202}
1203
Kostya Kortchinskyd5275c82019-02-01 08:42:56 -08001204func (c *config) DisableScudo() bool {
1205 return Bool(c.productVariables.DisableScudo)
1206}
1207
Colin Crossa1ad8d12016-06-01 17:09:44 -07001208func (c *config) Android64() bool {
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001209 for _, t := range c.Targets[Android] {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001210 if t.Arch.ArchType.Multilib == "lib64" {
1211 return true
1212 }
1213 }
1214
1215 return false
1216}
Colin Cross9272ade2016-08-17 15:24:12 -07001217
Colin Cross9d45bb72016-08-29 16:14:13 -07001218func (c *config) UseGoma() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001219 return Bool(c.productVariables.UseGoma)
Colin Cross9d45bb72016-08-29 16:14:13 -07001220}
1221
Ramy Medhatbbf25672019-07-17 12:30:04 +00001222func (c *config) UseRBE() bool {
1223 return Bool(c.productVariables.UseRBE)
1224}
1225
Ramy Medhat8ea054a2020-01-27 14:19:44 -05001226func (c *config) UseRBEJAVAC() bool {
1227 return Bool(c.productVariables.UseRBEJAVAC)
1228}
1229
1230func (c *config) UseRBER8() bool {
1231 return Bool(c.productVariables.UseRBER8)
1232}
1233
1234func (c *config) UseRBED8() bool {
1235 return Bool(c.productVariables.UseRBED8)
1236}
1237
Colin Cross8b8bec32019-11-15 13:18:43 -08001238func (c *config) UseRemoteBuild() bool {
1239 return c.UseGoma() || c.UseRBE()
1240}
1241
Colin Cross66548102018-06-19 22:47:35 -07001242func (c *config) RunErrorProne() bool {
1243 return c.IsEnvTrue("RUN_ERROR_PRONE")
1244}
1245
Jingwen Chenc711fec2020-11-22 23:52:50 -05001246// XrefCorpusName returns the Kythe cross-reference corpus name.
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001247func (c *config) XrefCorpusName() string {
1248 return c.Getenv("XREF_CORPUS")
1249}
1250
Jingwen Chenc711fec2020-11-22 23:52:50 -05001251// XrefCuEncoding returns the compilation unit encoding to use for Kythe code
1252// xrefs. Can be 'json' (default), 'proto' or 'all'.
Sasha Smundak6c2d4f92020-01-09 17:34:23 -08001253func (c *config) XrefCuEncoding() string {
1254 if enc := c.Getenv("KYTHE_KZIP_ENCODING"); enc != "" {
1255 return enc
1256 }
1257 return "json"
1258}
1259
Sasha Smundakb0addaf2021-02-16 10:39:40 -08001260// XrefCuJavaSourceMax returns the maximum number of the Java source files
1261// in a single compilation unit
1262const xrefJavaSourceFileMaxDefault = "1000"
1263
1264func (c Config) XrefCuJavaSourceMax() string {
1265 v := c.Getenv("KYTHE_JAVA_SOURCE_BATCH_SIZE")
1266 if v == "" {
1267 return xrefJavaSourceFileMaxDefault
1268 }
1269 if _, err := strconv.ParseUint(v, 0, 0); err != nil {
1270 fmt.Fprintf(os.Stderr,
1271 "bad KYTHE_JAVA_SOURCE_BATCH_SIZE value: %s, will use %s",
1272 err, xrefJavaSourceFileMaxDefault)
1273 return xrefJavaSourceFileMaxDefault
1274 }
1275 return v
1276
1277}
1278
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001279func (c *config) EmitXrefRules() bool {
1280 return c.XrefCorpusName() != ""
1281}
1282
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001283func (c *config) ClangTidy() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001284 return Bool(c.productVariables.ClangTidy)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001285}
1286
1287func (c *config) TidyChecks() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001288 if c.productVariables.TidyChecks == nil {
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001289 return ""
1290 }
Dan Willemsen45133ac2018-03-09 21:22:06 -08001291 return *c.productVariables.TidyChecks
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001292}
1293
Colin Cross0f4e0d62016-07-27 10:56:55 -07001294func (c *config) LibartImgHostBaseAddress() string {
1295 return "0x60000000"
1296}
1297
1298func (c *config) LibartImgDeviceBaseAddress() string {
Elliott Hughesda3a0712020-03-06 16:55:28 -08001299 return "0x70000000"
Colin Cross0f4e0d62016-07-27 10:56:55 -07001300}
1301
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001302func (c *config) ArtUseReadBarrier() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001303 return Bool(c.productVariables.ArtUseReadBarrier)
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001304}
1305
Jingwen Chenc711fec2020-11-22 23:52:50 -05001306// Enforce Runtime Resource Overlays for a module. RROs supersede static RROs,
1307// but some modules still depend on it.
1308//
1309// More info: https://source.android.com/devices/architecture/rros
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001310func (c *config) EnforceRROForModule(name string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001311 enforceList := c.productVariables.EnforceRROTargets
Jeongik Chacee5ba92021-02-19 12:11:51 +09001312
Roland Levillainf6cc2612020-07-09 16:58:14 +01001313 if len(enforceList) > 0 {
Yo Chiang4ebd06a2019-10-01 13:13:41 +08001314 if InList("*", enforceList) {
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001315 return true
1316 }
Colin Crossa74ca042019-01-31 14:31:51 -08001317 return InList(name, enforceList)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001318 }
1319 return false
1320}
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001321func (c *config) EnforceRROExcludedOverlay(path string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001322 excluded := c.productVariables.EnforceRROExcludedOverlays
Roland Levillainf6cc2612020-07-09 16:58:14 +01001323 if len(excluded) > 0 {
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001324 return HasAnyPrefix(path, excluded)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001325 }
1326 return false
1327}
1328
1329func (c *config) ExportedNamespaces() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001330 return append([]string(nil), c.productVariables.NamespacesToExport...)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001331}
1332
Sam Delmerico98a73292023-02-21 11:50:29 -05001333func (c *config) SourceRootDirs() []string {
1334 return c.productVariables.SourceRootDirs
1335}
1336
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001337func (c *config) HostStaticBinaries() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001338 return Bool(c.productVariables.HostStaticBinaries)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001339}
1340
Colin Cross5a0dcd52018-10-05 14:20:06 -07001341func (c *config) UncompressPrivAppDex() bool {
1342 return Bool(c.productVariables.UncompressPrivAppDex)
1343}
1344
1345func (c *config) ModulesLoadedByPrivilegedModules() []string {
1346 return c.productVariables.ModulesLoadedByPrivilegedModules
1347}
1348
Jingwen Chenc711fec2020-11-22 23:52:50 -05001349// DexpreoptGlobalConfigPath returns the path to the dexpreopt.config file in
1350// the output directory, if it was created during the product configuration
1351// phase by Kati.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001352func (c *config) DexpreoptGlobalConfigPath(ctx PathContext) OptionalPath {
Colin Cross988414c2020-01-11 01:11:46 +00001353 if c.productVariables.DexpreoptGlobalConfig == nil {
Jingwen Chenebb0b572020-11-02 00:24:57 -05001354 return OptionalPathForPath(nil)
1355 }
1356 return OptionalPathForPath(
1357 pathForBuildToolDep(ctx, *c.productVariables.DexpreoptGlobalConfig))
1358}
1359
Jingwen Chenc711fec2020-11-22 23:52:50 -05001360// DexpreoptGlobalConfig returns the raw byte contents of the dexpreopt global
1361// configuration. Since the configuration file was created by Kati during
1362// product configuration (externally of soong_build), it's not tracked, so we
1363// also manually add a Ninja file dependency on the configuration file to the
1364// rule that creates the main build.ninja file. This ensures that build.ninja is
1365// regenerated correctly if dexpreopt.config changes.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001366func (c *config) DexpreoptGlobalConfig(ctx PathContext) ([]byte, error) {
1367 path := c.DexpreoptGlobalConfigPath(ctx)
1368 if !path.Valid() {
Colin Cross988414c2020-01-11 01:11:46 +00001369 return nil, nil
1370 }
Jingwen Chenebb0b572020-11-02 00:24:57 -05001371 ctx.AddNinjaFileDeps(path.String())
Sasha Smundakaf5ca922022-12-12 21:23:34 -08001372 return os.ReadFile(absolutePath(path.String()))
Colin Cross43f08db2018-11-12 10:13:39 -08001373}
1374
Inseob Kim7b85eeb2021-03-23 20:52:24 +09001375func (c *deviceConfig) WithDexpreopt() bool {
1376 return c.config.productVariables.WithDexpreopt
1377}
1378
Colin Cross662d6142022-11-03 20:38:01 -07001379func (c *config) FrameworksBaseDirExists(ctx PathGlobContext) bool {
Colin Cross5a756a62021-03-16 16:34:46 -07001380 return ExistentPathForSource(ctx, "frameworks", "base", "Android.bp").Valid()
David Brazdil91b4e3e2019-01-23 21:04:05 +00001381}
1382
Inseob Kimae553032019-05-14 18:52:49 +09001383func (c *config) VndkSnapshotBuildArtifacts() bool {
1384 return Bool(c.productVariables.VndkSnapshotBuildArtifacts)
1385}
1386
Colin Cross3b19f5d2019-09-17 14:45:31 -07001387func (c *config) HasMultilibConflict(arch ArchType) bool {
1388 return c.multilibConflicts[arch]
1389}
1390
Sasha Smundakaf5ca922022-12-12 21:23:34 -08001391func (c *config) PrebuiltHiddenApiDir(_ PathContext) string {
Bill Peckhambae47492021-01-08 09:34:44 -08001392 return String(c.productVariables.PrebuiltHiddenApiDir)
1393}
1394
Kiyoung Kime623c582023-07-06 16:43:44 +09001395func (c *config) IsVndkDeprecated() bool {
1396 return !Bool(c.productVariables.KeepVndk)
1397}
1398
Justin Yun41cbb5e2023-11-29 17:58:16 +09001399func (c *config) VendorApiLevel() string {
1400 return String(c.productVariables.VendorApiLevel)
1401}
1402
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001403func (c *config) PrevVendorApiLevel() string {
1404 vendorApiLevel, err := strconv.Atoi(c.VendorApiLevel())
1405 if err != nil {
1406 panic(fmt.Errorf("Cannot parse vendor API level %s to an integer: %s",
1407 c.VendorApiLevel(), err))
1408 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001409 // The version before trunk stable is 34.
1410 if vendorApiLevel == 202404 {
1411 return "34"
1412 }
Hsin-Yi Chen890e7722024-03-05 15:56:44 +08001413 if vendorApiLevel >= 1 && vendorApiLevel <= 34 {
1414 return strconv.Itoa(vendorApiLevel - 1)
1415 }
1416 if vendorApiLevel < 202404 || vendorApiLevel%100 != 4 {
1417 panic("Unknown vendor API level " + c.VendorApiLevel())
1418 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001419 return strconv.Itoa(vendorApiLevel - 100)
1420}
1421
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001422func IsTrunkStableVendorApiLevel(level string) bool {
1423 levelInt, err := strconv.Atoi(level)
1424 return err == nil && levelInt >= 202404
1425}
1426
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001427func (c *config) VendorApiLevelFrozen() bool {
1428 return c.productVariables.GetBuildFlagBool("RELEASE_BOARD_API_LEVEL_FROZEN")
1429}
1430
Colin Cross9272ade2016-08-17 15:24:12 -07001431func (c *deviceConfig) Arches() []Arch {
1432 var arches []Arch
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001433 for _, target := range c.config.Targets[Android] {
Colin Cross9272ade2016-08-17 15:24:12 -07001434 arches = append(arches, target.Arch)
1435 }
1436 return arches
1437}
Dan Willemsend2ede872016-11-18 14:54:24 -08001438
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001439func (c *deviceConfig) BinderBitness() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001440 is32BitBinder := c.config.productVariables.Binder32bit
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001441 if is32BitBinder != nil && *is32BitBinder {
1442 return "32"
1443 }
1444 return "64"
1445}
1446
Dan Willemsen4353bc42016-12-05 17:16:02 -08001447func (c *deviceConfig) VendorPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001448 if c.config.productVariables.VendorPath != nil {
1449 return *c.config.productVariables.VendorPath
Dan Willemsen4353bc42016-12-05 17:16:02 -08001450 }
1451 return "vendor"
1452}
1453
Jose Galmes6f843bc2020-12-11 13:36:29 -08001454func (c *deviceConfig) RecoverySnapshotVersion() string {
1455 return String(c.config.productVariables.RecoverySnapshotVersion)
1456}
1457
Jeongik Cha219141c2020-08-06 23:00:37 +09001458func (c *deviceConfig) CurrentApiLevelForVendorModules() string {
1459 return StringDefault(c.config.productVariables.DeviceCurrentApiLevelForVendorModules, "current")
1460}
1461
Justin Yun71549282017-11-17 12:10:28 +09001462func (c *deviceConfig) ExtraVndkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001463 return c.config.productVariables.ExtraVndkVersions
Dan Willemsend2ede872016-11-18 14:54:24 -08001464}
Jack He8cc71432016-12-08 15:45:07 -08001465
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001466func (c *deviceConfig) SystemSdkVersions() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001467 return c.config.productVariables.DeviceSystemSdkVersions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001468}
1469
1470func (c *deviceConfig) PlatformSystemSdkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001471 return c.config.productVariables.Platform_systemsdk_versions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001472}
1473
Jiyong Park2db76922017-11-08 16:03:48 +09001474func (c *deviceConfig) OdmPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001475 if c.config.productVariables.OdmPath != nil {
1476 return *c.config.productVariables.OdmPath
Jiyong Park2db76922017-11-08 16:03:48 +09001477 }
1478 return "odm"
1479}
1480
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001481func (c *deviceConfig) ProductPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001482 if c.config.productVariables.ProductPath != nil {
1483 return *c.config.productVariables.ProductPath
Jiyong Park2db76922017-11-08 16:03:48 +09001484 }
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001485 return "product"
Jiyong Park2db76922017-11-08 16:03:48 +09001486}
1487
Justin Yund5f6c822019-06-25 16:47:17 +09001488func (c *deviceConfig) SystemExtPath() string {
1489 if c.config.productVariables.SystemExtPath != nil {
1490 return *c.config.productVariables.SystemExtPath
Dario Frenifd05a742018-05-29 13:28:54 +01001491 }
Justin Yund5f6c822019-06-25 16:47:17 +09001492 return "system_ext"
Dario Frenifd05a742018-05-29 13:28:54 +01001493}
1494
Jack He8cc71432016-12-08 15:45:07 -08001495func (c *deviceConfig) BtConfigIncludeDir() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001496 return String(c.config.productVariables.BtConfigIncludeDir)
Jack He8cc71432016-12-08 15:45:07 -08001497}
Dan Willemsen581341d2017-02-09 16:16:31 -08001498
Jiyong Parkd773eb32017-07-03 13:18:12 +09001499func (c *deviceConfig) DeviceKernelHeaderDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001500 return c.config.productVariables.DeviceKernelHeaders
Jiyong Parkd773eb32017-07-03 13:18:12 +09001501}
1502
Roland Levillainada12702020-06-09 13:07:36 +01001503// JavaCoverageEnabledForPath returns whether Java code coverage is enabled for
1504// path. Coverage is enabled by default when the product variable
1505// JavaCoveragePaths is empty. If JavaCoveragePaths is not empty, coverage is
1506// enabled for any path which is part of this variable (and not part of the
1507// JavaCoverageExcludePaths product variable). Value "*" in JavaCoveragePaths
1508// represents any path.
1509func (c *deviceConfig) JavaCoverageEnabledForPath(path string) bool {
1510 coverage := false
Chris Gross2f748692020-06-24 20:36:59 +00001511 if len(c.config.productVariables.JavaCoveragePaths) == 0 ||
Roland Levillainada12702020-06-09 13:07:36 +01001512 InList("*", c.config.productVariables.JavaCoveragePaths) ||
1513 HasAnyPrefix(path, c.config.productVariables.JavaCoveragePaths) {
1514 coverage = true
1515 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001516 if coverage && len(c.config.productVariables.JavaCoverageExcludePaths) > 0 {
Roland Levillainada12702020-06-09 13:07:36 +01001517 if HasAnyPrefix(path, c.config.productVariables.JavaCoverageExcludePaths) {
1518 coverage = false
1519 }
1520 }
1521 return coverage
1522}
1523
Colin Cross1a6acd42020-06-16 17:51:46 -07001524// Returns true if gcov or clang coverage is enabled.
Dan Willemsen581341d2017-02-09 16:16:31 -08001525func (c *deviceConfig) NativeCoverageEnabled() bool {
Colin Cross1a6acd42020-06-16 17:51:46 -07001526 return Bool(c.config.productVariables.GcovCoverage) ||
1527 Bool(c.config.productVariables.ClangCoverage)
Dan Willemsen581341d2017-02-09 16:16:31 -08001528}
1529
Oliver Nguyen1382ab62019-12-06 15:22:41 -08001530func (c *deviceConfig) ClangCoverageEnabled() bool {
1531 return Bool(c.config.productVariables.ClangCoverage)
1532}
1533
Pirama Arumuga Nainarb37ae582022-01-26 22:14:32 -08001534func (c *deviceConfig) ClangCoverageContinuousMode() bool {
1535 return Bool(c.config.productVariables.ClangCoverageContinuousMode)
1536}
1537
Colin Cross1a6acd42020-06-16 17:51:46 -07001538func (c *deviceConfig) GcovCoverageEnabled() bool {
1539 return Bool(c.config.productVariables.GcovCoverage)
1540}
1541
Roland Levillain4f5297b2020-06-09 12:44:06 +01001542// NativeCoverageEnabledForPath returns whether (GCOV- or Clang-based) native
1543// code coverage is enabled for path. By default, coverage is not enabled for a
1544// given path unless it is part of the NativeCoveragePaths product variable (and
1545// not part of the NativeCoverageExcludePaths product variable). Value "*" in
1546// NativeCoveragePaths represents any path.
1547func (c *deviceConfig) NativeCoverageEnabledForPath(path string) bool {
Ryan Campbell469a18a2017-02-27 09:01:54 -08001548 coverage := false
Roland Levillainf6cc2612020-07-09 16:58:14 +01001549 if len(c.config.productVariables.NativeCoveragePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001550 if InList("*", c.config.productVariables.NativeCoveragePaths) || HasAnyPrefix(path, c.config.productVariables.NativeCoveragePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001551 coverage = true
Dan Willemsen581341d2017-02-09 16:16:31 -08001552 }
1553 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001554 if coverage && len(c.config.productVariables.NativeCoverageExcludePaths) > 0 {
Yi Kongfd07ed22023-02-16 17:42:27 +09001555 // Workaround coverage boot failure.
1556 // http://b/269981180
1557 if strings.HasPrefix(path, "external/protobuf") {
1558 coverage = false
1559 }
Roland Levillain4f5297b2020-06-09 12:44:06 +01001560 if HasAnyPrefix(path, c.config.productVariables.NativeCoverageExcludePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001561 coverage = false
Ryan Campbell469a18a2017-02-27 09:01:54 -08001562 }
1563 }
1564 return coverage
Dan Willemsen581341d2017-02-09 16:16:31 -08001565}
Ivan Lozano5f595532017-07-13 14:46:05 -07001566
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001567func (c *deviceConfig) PgoAdditionalProfileDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001568 return c.config.productVariables.PgoAdditionalProfileDirs
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001569}
1570
Vinh Tran44cb78c2023-03-09 22:07:19 -05001571// AfdoProfile returns fully qualified path associated to the given module name
Colin Crossd38feb02024-01-23 16:38:06 -08001572func (c *deviceConfig) AfdoProfile(name string) (string, error) {
Vinh Tran44cb78c2023-03-09 22:07:19 -05001573 for _, afdoProfile := range c.config.productVariables.AfdoProfiles {
1574 split := strings.Split(afdoProfile, ":")
1575 if len(split) != 3 {
Colin Crossd38feb02024-01-23 16:38:06 -08001576 return "", fmt.Errorf("AFDO_PROFILES has invalid value: %s. "+
Vinh Tran44cb78c2023-03-09 22:07:19 -05001577 "The expected format is <module>:<fully-qualified-path-to-fdo_profile>", afdoProfile)
1578 }
1579 if split[0] == name {
Colin Crossd38feb02024-01-23 16:38:06 -08001580 return strings.Join([]string{split[1], split[2]}, ":"), nil
Vinh Tran44cb78c2023-03-09 22:07:19 -05001581 }
1582 }
Colin Crossd38feb02024-01-23 16:38:06 -08001583 return "", nil
Vinh Tran44cb78c2023-03-09 22:07:19 -05001584}
1585
Tri Vo35a51432018-03-25 20:00:00 -07001586func (c *deviceConfig) VendorSepolicyDirs() []string {
1587 return c.config.productVariables.BoardVendorSepolicyDirs
1588}
1589
1590func (c *deviceConfig) OdmSepolicyDirs() []string {
1591 return c.config.productVariables.BoardOdmSepolicyDirs
1592}
1593
Felixa20a8752020-05-17 18:28:35 +02001594func (c *deviceConfig) SystemExtPublicSepolicyDirs() []string {
1595 return c.config.productVariables.SystemExtPublicSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001596}
1597
Felixa20a8752020-05-17 18:28:35 +02001598func (c *deviceConfig) SystemExtPrivateSepolicyDirs() []string {
1599 return c.config.productVariables.SystemExtPrivateSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001600}
1601
Inseob Kim0866b002019-04-15 20:21:29 +09001602func (c *deviceConfig) SepolicyM4Defs() []string {
1603 return c.config.productVariables.BoardSepolicyM4Defs
1604}
1605
Jiyong Park7f67f482019-01-05 12:57:48 +09001606func (c *deviceConfig) OverrideManifestPackageNameFor(name string) (manifestName string, overridden bool) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001607 return findOverrideValue(c.config.productVariables.ManifestPackageNameOverrides, name,
1608 "invalid override rule %q in PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES should be <module_name>:<manifest_name>")
1609}
1610
1611func (c *deviceConfig) OverrideCertificateFor(name string) (certificatePath string, overridden bool) {
Jaewoong Jungacb6db32019-02-28 16:22:30 +00001612 return findOverrideValue(c.config.productVariables.CertificateOverrides, name,
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001613 "invalid override rule %q in PRODUCT_CERTIFICATE_OVERRIDES should be <module_name>:<certificate_module_name>")
1614}
1615
Jaewoong Jung9d22a912019-01-23 16:27:47 -08001616func (c *deviceConfig) OverridePackageNameFor(name string) string {
1617 newName, overridden := findOverrideValue(
1618 c.config.productVariables.PackageNameOverrides,
1619 name,
1620 "invalid override rule %q in PRODUCT_PACKAGE_NAME_OVERRIDES should be <module_name>:<package_name>")
1621 if overridden {
1622 return newName
1623 }
1624 return name
1625}
1626
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001627func findOverrideValue(overrides []string, name string, errorMsg string) (newValue string, overridden bool) {
Jiyong Park7f67f482019-01-05 12:57:48 +09001628 if overrides == nil || len(overrides) == 0 {
1629 return "", false
1630 }
1631 for _, o := range overrides {
1632 split := strings.Split(o, ":")
1633 if len(split) != 2 {
1634 // This shouldn't happen as this is first checked in make, but just in case.
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001635 panic(fmt.Errorf(errorMsg, o))
Jiyong Park7f67f482019-01-05 12:57:48 +09001636 }
1637 if matchPattern(split[0], name) {
1638 return substPattern(split[0], split[1], name), true
1639 }
1640 }
1641 return "", false
1642}
1643
Albert Martineefabcf2022-03-21 20:11:16 +00001644func (c *deviceConfig) ApexGlobalMinSdkVersionOverride() string {
1645 return String(c.config.productVariables.ApexGlobalMinSdkVersionOverride)
1646}
1647
Ivan Lozano5f595532017-07-13 14:46:05 -07001648func (c *config) IntegerOverflowDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001649 if len(c.productVariables.IntegerOverflowExcludePaths) == 0 {
Ivan Lozano5f595532017-07-13 14:46:05 -07001650 return false
1651 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001652 return HasAnyPrefix(path, c.productVariables.IntegerOverflowExcludePaths)
Ivan Lozano5f595532017-07-13 14:46:05 -07001653}
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001654
1655func (c *config) CFIDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001656 if len(c.productVariables.CFIExcludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001657 return false
1658 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001659 return HasAnyPrefix(path, c.productVariables.CFIExcludePaths)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001660}
1661
1662func (c *config) CFIEnabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001663 if len(c.productVariables.CFIIncludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001664 return false
1665 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001666 return HasAnyPrefix(path, c.productVariables.CFIIncludePaths) && !c.CFIDisabledForPath(path)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001667}
Colin Crosse15ddaf2017-12-04 11:24:31 -08001668
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001669func (c *config) MemtagHeapDisabledForPath(path string) bool {
1670 if len(c.productVariables.MemtagHeapExcludePaths) == 0 {
1671 return false
1672 }
1673 return HasAnyPrefix(path, c.productVariables.MemtagHeapExcludePaths)
1674}
1675
1676func (c *config) MemtagHeapAsyncEnabledForPath(path string) bool {
1677 if len(c.productVariables.MemtagHeapAsyncIncludePaths) == 0 {
1678 return false
1679 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001680 return HasAnyPrefix(path, c.productVariables.MemtagHeapAsyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001681}
1682
1683func (c *config) MemtagHeapSyncEnabledForPath(path string) bool {
1684 if len(c.productVariables.MemtagHeapSyncIncludePaths) == 0 {
1685 return false
1686 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001687 return HasAnyPrefix(path, c.productVariables.MemtagHeapSyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001688}
1689
Tomislav Novakf734f002023-08-22 10:51:44 -07001690func (c *config) HWASanDisabledForPath(path string) bool {
1691 if len(c.productVariables.HWASanExcludePaths) == 0 {
1692 return false
1693 }
1694 return HasAnyPrefix(path, c.productVariables.HWASanExcludePaths)
1695}
1696
Hang Lua98aab92023-03-17 13:17:22 +08001697func (c *config) HWASanEnabledForPath(path string) bool {
1698 if len(c.productVariables.HWASanIncludePaths) == 0 {
1699 return false
1700 }
Tomislav Novakf734f002023-08-22 10:51:44 -07001701 return HasAnyPrefix(path, c.productVariables.HWASanIncludePaths) && !c.HWASanDisabledForPath(path)
Hang Lua98aab92023-03-17 13:17:22 +08001702}
1703
Dan Willemsen0fe78662018-03-26 12:41:18 -07001704func (c *config) VendorConfig(name string) VendorConfig {
Colin Cross9d34f352019-11-22 16:03:51 -08001705 return soongconfig.Config(c.productVariables.VendorVars[name])
Dan Willemsen0fe78662018-03-26 12:41:18 -07001706}
1707
Colin Cross395f2cf2018-10-24 16:10:32 -07001708func (c *config) NdkAbis() bool {
1709 return Bool(c.productVariables.Ndk_abis)
1710}
1711
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001712func (c *config) AmlAbis() bool {
1713 return Bool(c.productVariables.Aml_abis)
1714}
1715
Jiyong Park4da07972021-01-05 21:01:11 +09001716func (c *config) ForceApexSymlinkOptimization() bool {
1717 return Bool(c.productVariables.ForceApexSymlinkOptimization)
1718}
1719
Sasha Smundakfe9a5b82022-07-27 14:51:45 -07001720func (c *config) ApexCompressionEnabled() bool {
1721 return Bool(c.productVariables.CompressedApex) && !c.UnbundledBuildApps()
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +00001722}
1723
Dennis Shene2ed70c2023-01-11 14:15:43 +00001724func (c *config) ApexTrimEnabled() bool {
1725 return Bool(c.productVariables.TrimmedApex)
1726}
1727
Jeongik Chac9464142019-01-07 12:07:27 +09001728func (c *config) EnforceSystemCertificate() bool {
1729 return Bool(c.productVariables.EnforceSystemCertificate)
1730}
1731
Colin Cross440e0d02020-06-11 11:32:11 -07001732func (c *config) EnforceSystemCertificateAllowList() []string {
1733 return c.productVariables.EnforceSystemCertificateAllowList
Jeongik Chac9464142019-01-07 12:07:27 +09001734}
1735
Jeongik Cha2cc570d2019-10-29 15:44:45 +09001736func (c *config) EnforceProductPartitionInterface() bool {
1737 return Bool(c.productVariables.EnforceProductPartitionInterface)
1738}
1739
JaeMan Parkff715562020-10-19 17:25:58 +09001740func (c *config) EnforceInterPartitionJavaSdkLibrary() bool {
1741 return Bool(c.productVariables.EnforceInterPartitionJavaSdkLibrary)
1742}
1743
1744func (c *config) InterPartitionJavaLibraryAllowList() []string {
1745 return c.productVariables.InterPartitionJavaLibraryAllowList
1746}
1747
Colin Crossf24a22a2019-01-31 14:12:44 -08001748func (c *config) ProductHiddenAPIStubs() []string {
1749 return c.productVariables.ProductHiddenAPIStubs
Colin Cross8faf8fc2019-01-16 15:15:52 -08001750}
1751
Colin Crossf24a22a2019-01-31 14:12:44 -08001752func (c *config) ProductHiddenAPIStubsSystem() []string {
1753 return c.productVariables.ProductHiddenAPIStubsSystem
Colin Cross8faf8fc2019-01-16 15:15:52 -08001754}
1755
Colin Crossf24a22a2019-01-31 14:12:44 -08001756func (c *config) ProductHiddenAPIStubsTest() []string {
1757 return c.productVariables.ProductHiddenAPIStubsTest
Colin Cross8faf8fc2019-01-16 15:15:52 -08001758}
Dan Willemsen71c74602019-04-10 12:27:35 -07001759
Dan Willemsen54879d12019-04-18 10:08:46 -07001760func (c *deviceConfig) TargetFSConfigGen() []string {
Dan Willemsen71c74602019-04-10 12:27:35 -07001761 return c.config.productVariables.TargetFSConfigGen
1762}
Inseob Kim0866b002019-04-15 20:21:29 +09001763
1764func (c *config) ProductPublicSepolicyDirs() []string {
1765 return c.productVariables.ProductPublicSepolicyDirs
1766}
1767
1768func (c *config) ProductPrivateSepolicyDirs() []string {
1769 return c.productVariables.ProductPrivateSepolicyDirs
1770}
1771
Inseob Kim5eb7ee92022-04-27 10:30:34 +09001772func (c *config) TargetMultitreeUpdateMeta() bool {
1773 return c.productVariables.MultitreeUpdateMeta
1774}
1775
Inseob Kim1f086e22019-05-09 13:29:15 +09001776func (c *deviceConfig) DeviceArch() string {
1777 return String(c.config.productVariables.DeviceArch)
1778}
1779
1780func (c *deviceConfig) DeviceArchVariant() string {
1781 return String(c.config.productVariables.DeviceArchVariant)
1782}
1783
1784func (c *deviceConfig) DeviceSecondaryArch() string {
1785 return String(c.config.productVariables.DeviceSecondaryArch)
1786}
1787
1788func (c *deviceConfig) DeviceSecondaryArchVariant() string {
1789 return String(c.config.productVariables.DeviceSecondaryArchVariant)
1790}
Yifan Hong82db7352020-01-21 16:12:26 -08001791
1792func (c *deviceConfig) BoardUsesRecoveryAsBoot() bool {
1793 return Bool(c.config.productVariables.BoardUsesRecoveryAsBoot)
1794}
Yifan Hong97365ee2020-07-29 09:51:57 -07001795
1796func (c *deviceConfig) BoardKernelBinaries() []string {
1797 return c.config.productVariables.BoardKernelBinaries
1798}
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001799
Yifan Hong42bef8d2020-08-05 14:36:09 -07001800func (c *deviceConfig) BoardKernelModuleInterfaceVersions() []string {
1801 return c.config.productVariables.BoardKernelModuleInterfaceVersions
1802}
1803
Yifan Hongdd8dacc2020-10-21 15:40:17 -07001804func (c *deviceConfig) BoardMoveRecoveryResourcesToVendorBoot() bool {
1805 return Bool(c.config.productVariables.BoardMoveRecoveryResourcesToVendorBoot)
1806}
1807
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001808func (c *deviceConfig) PlatformSepolicyVersion() string {
1809 return String(c.config.productVariables.PlatformSepolicyVersion)
1810}
1811
Inseob Kim843f6642022-01-07 09:11:23 +09001812func (c *deviceConfig) PlatformSepolicyCompatVersions() []string {
1813 return c.config.productVariables.PlatformSepolicyCompatVersions
1814}
1815
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001816func (c *deviceConfig) BoardSepolicyVers() string {
Inseob Kim0c4eec82021-03-22 22:33:40 +09001817 if ver := String(c.config.productVariables.BoardSepolicyVers); ver != "" {
1818 return ver
1819 }
1820 return c.PlatformSepolicyVersion()
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001821}
1822
Inseob Kim1a0afcc2022-02-14 23:10:51 +09001823func (c *deviceConfig) SystemExtSepolicyPrebuiltApiDir() string {
1824 return String(c.config.productVariables.SystemExtSepolicyPrebuiltApiDir)
1825}
1826
1827func (c *deviceConfig) ProductSepolicyPrebuiltApiDir() string {
1828 return String(c.config.productVariables.ProductSepolicyPrebuiltApiDir)
1829}
1830
1831func (c *deviceConfig) IsPartnerTrebleSepolicyTestEnabled() bool {
1832 return c.SystemExtSepolicyPrebuiltApiDir() != "" || c.ProductSepolicyPrebuiltApiDir() != ""
1833}
1834
Inseob Kim7cf14652021-01-06 23:06:52 +09001835func (c *deviceConfig) DirectedVendorSnapshot() bool {
1836 return c.config.productVariables.DirectedVendorSnapshot
1837}
1838
1839func (c *deviceConfig) VendorSnapshotModules() map[string]bool {
1840 return c.config.productVariables.VendorSnapshotModules
1841}
1842
Jose Galmes4c6895e2021-02-09 07:44:30 -08001843func (c *deviceConfig) DirectedRecoverySnapshot() bool {
1844 return c.config.productVariables.DirectedRecoverySnapshot
1845}
1846
1847func (c *deviceConfig) RecoverySnapshotModules() map[string]bool {
1848 return c.config.productVariables.RecoverySnapshotModules
1849}
1850
Justin DeMartino383bfb32021-02-24 10:49:43 -08001851func createDirsMap(previous map[string]bool, dirs []string) (map[string]bool, error) {
1852 var ret = make(map[string]bool)
1853 for _, dir := range dirs {
1854 clean := filepath.Clean(dir)
1855 if previous[clean] || ret[clean] {
1856 return nil, fmt.Errorf("Duplicate entry %s", dir)
1857 }
1858 ret[clean] = true
1859 }
1860 return ret, nil
1861}
1862
1863func (c *deviceConfig) createDirsMapOnce(onceKey OnceKey, previous map[string]bool, dirs []string) map[string]bool {
1864 dirMap := c.Once(onceKey, func() interface{} {
1865 ret, err := createDirsMap(previous, dirs)
1866 if err != nil {
1867 panic(fmt.Errorf("%s: %w", onceKey.key, err))
1868 }
1869 return ret
1870 })
1871 if dirMap == nil {
1872 return nil
1873 }
1874 return dirMap.(map[string]bool)
1875}
1876
1877var vendorSnapshotDirsExcludedKey = NewOnceKey("VendorSnapshotDirsExcludedMap")
1878
1879func (c *deviceConfig) VendorSnapshotDirsExcludedMap() map[string]bool {
1880 return c.createDirsMapOnce(vendorSnapshotDirsExcludedKey, nil,
1881 c.config.productVariables.VendorSnapshotDirsExcluded)
1882}
1883
1884var vendorSnapshotDirsIncludedKey = NewOnceKey("VendorSnapshotDirsIncludedMap")
1885
1886func (c *deviceConfig) VendorSnapshotDirsIncludedMap() map[string]bool {
1887 excludedMap := c.VendorSnapshotDirsExcludedMap()
1888 return c.createDirsMapOnce(vendorSnapshotDirsIncludedKey, excludedMap,
1889 c.config.productVariables.VendorSnapshotDirsIncluded)
1890}
1891
1892var recoverySnapshotDirsExcludedKey = NewOnceKey("RecoverySnapshotDirsExcludedMap")
1893
1894func (c *deviceConfig) RecoverySnapshotDirsExcludedMap() map[string]bool {
1895 return c.createDirsMapOnce(recoverySnapshotDirsExcludedKey, nil,
1896 c.config.productVariables.RecoverySnapshotDirsExcluded)
1897}
1898
1899var recoverySnapshotDirsIncludedKey = NewOnceKey("RecoverySnapshotDirsIncludedMap")
1900
1901func (c *deviceConfig) RecoverySnapshotDirsIncludedMap() map[string]bool {
1902 excludedMap := c.RecoverySnapshotDirsExcludedMap()
1903 return c.createDirsMapOnce(recoverySnapshotDirsIncludedKey, excludedMap,
1904 c.config.productVariables.RecoverySnapshotDirsIncluded)
1905}
1906
Rob Seymour925aa092021-08-10 20:42:03 +00001907func (c *deviceConfig) HostFakeSnapshotEnabled() bool {
1908 return c.config.productVariables.HostFakeSnapshotEnabled
1909}
1910
Inseob Kim60c32f02020-12-21 22:53:05 +09001911func (c *deviceConfig) ShippingApiLevel() ApiLevel {
Steven Morelanda48df2b2024-06-03 22:29:38 +00001912 if c.config.productVariables.Shipping_api_level == nil {
Inseob Kim60c32f02020-12-21 22:53:05 +09001913 return NoneApiLevel
1914 }
Steven Morelanda48df2b2024-06-03 22:29:38 +00001915 apiLevel, _ := strconv.Atoi(*c.config.productVariables.Shipping_api_level)
Inseob Kim60c32f02020-12-21 22:53:05 +09001916 return uncheckedFinalApiLevel(apiLevel)
1917}
1918
Liz Kammer33cc80e2023-05-18 18:20:28 +00001919func (c *deviceConfig) BuildBrokenPluginValidation() []string {
1920 return c.config.productVariables.BuildBrokenPluginValidation
1921}
1922
Alix Espinoef47e542022-09-14 19:10:51 +00001923func (c *deviceConfig) BuildBrokenClangAsFlags() bool {
1924 return c.config.productVariables.BuildBrokenClangAsFlags
1925}
1926
1927func (c *deviceConfig) BuildBrokenClangCFlags() bool {
1928 return c.config.productVariables.BuildBrokenClangCFlags
1929}
1930
Alixb5f6d9e2022-04-20 23:00:58 +00001931func (c *deviceConfig) BuildBrokenClangProperty() bool {
1932 return c.config.productVariables.BuildBrokenClangProperty
1933}
1934
Inseob Kim67e5add192021-03-17 18:05:33 +09001935func (c *deviceConfig) BuildBrokenEnforceSyspropOwner() bool {
1936 return c.config.productVariables.BuildBrokenEnforceSyspropOwner
1937}
1938
1939func (c *deviceConfig) BuildBrokenTrebleSyspropNeverallow() bool {
1940 return c.config.productVariables.BuildBrokenTrebleSyspropNeverallow
1941}
1942
Cole Faustedc4c502022-09-09 19:39:25 -07001943func (c *deviceConfig) BuildBrokenUsesSoongPython2Modules() bool {
1944 return c.config.productVariables.BuildBrokenUsesSoongPython2Modules
1945}
1946
Hridya Valsaraju5a5c7d52021-04-02 16:45:24 -07001947func (c *deviceConfig) BuildDebugfsRestrictionsEnabled() bool {
1948 return c.config.productVariables.BuildDebugfsRestrictionsEnabled
1949}
1950
Inseob Kim0cac7b42021-02-03 18:16:46 +09001951func (c *deviceConfig) BuildBrokenVendorPropertyNamespace() bool {
1952 return c.config.productVariables.BuildBrokenVendorPropertyNamespace
1953}
1954
Liz Kammer619be462022-01-28 15:13:39 -05001955func (c *deviceConfig) BuildBrokenInputDir(name string) bool {
1956 return InList(name, c.config.productVariables.BuildBrokenInputDirModules)
1957}
1958
Jiyong Park3bb99242024-01-04 23:21:26 +00001959func (c *deviceConfig) BuildBrokenDontCheckSystemSdk() bool {
1960 return c.config.productVariables.BuildBrokenDontCheckSystemSdk
1961}
1962
Jiakai Zhang48203e32023-06-02 23:42:21 +01001963func (c *config) BuildWarningBadOptionalUsesLibsAllowlist() []string {
1964 return c.productVariables.BuildWarningBadOptionalUsesLibsAllowlist
1965}
1966
Yu Liu6a7940c2023-05-09 17:12:22 -07001967func (c *deviceConfig) GenruleSandboxing() bool {
1968 return Bool(c.config.productVariables.GenruleSandboxing)
Vinh Tran140d5882022-06-10 14:23:27 -04001969}
1970
Inseob Kim67e5add192021-03-17 18:05:33 +09001971func (c *deviceConfig) RequiresInsecureExecmemForSwiftshader() bool {
1972 return c.config.productVariables.RequiresInsecureExecmemForSwiftshader
1973}
1974
Devin Moorec381e102023-07-06 22:03:58 +00001975func (c *deviceConfig) Release_aidl_use_unfrozen() bool {
1976 return Bool(c.config.productVariables.Release_aidl_use_unfrozen)
1977}
1978
Inseob Kim67e5add192021-03-17 18:05:33 +09001979func (c *config) SelinuxIgnoreNeverallows() bool {
1980 return c.productVariables.SelinuxIgnoreNeverallows
1981}
1982
Inseob Kima10ef272021-09-15 03:04:53 +00001983func (c *deviceConfig) SepolicyFreezeTestExtraDirs() []string {
1984 return c.config.productVariables.SepolicyFreezeTestExtraDirs
1985}
1986
1987func (c *deviceConfig) SepolicyFreezeTestExtraPrebuiltDirs() []string {
1988 return c.config.productVariables.SepolicyFreezeTestExtraPrebuiltDirs
1989}
1990
Jiyong Parkd163d4d2021-10-12 16:47:43 +09001991func (c *deviceConfig) GenerateAidlNdkPlatformBackend() bool {
1992 return c.config.productVariables.GenerateAidlNdkPlatformBackend
1993}
1994
Yu Liu67a28422024-03-05 00:36:31 +00001995func (c *deviceConfig) AconfigContainerValidation() string {
1996 return c.config.productVariables.AconfigContainerValidation
1997}
1998
Christopher Ferris98f10222022-07-13 23:16:52 -07001999func (c *config) IgnorePrefer32OnDevice() bool {
2000 return c.productVariables.IgnorePrefer32OnDevice
2001}
2002
Ulya Trafimovich249386a2020-07-01 14:31:13 +01002003func (c *config) BootJars() []string {
2004 return c.Once(earlyBootJarsKey, func() interface{} {
Paul Duffin69d1fb12020-10-23 21:14:20 +01002005 list := c.productVariables.BootJars.CopyOfJars()
satayevd604b212021-07-21 14:23:52 +01002006 return append(list, c.productVariables.ApexBootJars.CopyOfJars()...)
Ulya Trafimovich249386a2020-07-01 14:31:13 +01002007 }).([]string)
2008}
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002009
satayevd604b212021-07-21 14:23:52 +01002010func (c *config) NonApexBootJars() ConfiguredJarList {
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002011 return c.productVariables.BootJars
2012}
2013
satayevd604b212021-07-21 14:23:52 +01002014func (c *config) ApexBootJars() ConfiguredJarList {
2015 return c.productVariables.ApexBootJars
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002016}
Colin Cross77cdcfd2021-03-12 11:28:25 -08002017
2018func (c *config) RBEWrapper() string {
2019 return c.GetenvWithDefault("RBE_WRAPPER", remoteexec.DefaultWrapperPath)
2020}
Colin Cross9b698b62021-12-22 09:55:32 -08002021
2022// UseHostMusl returns true if the host target has been configured to build against musl libc.
2023func (c *config) UseHostMusl() bool {
2024 return Bool(c.productVariables.HostMusl)
2025}
MarkDacekff851b82022-04-21 18:33:17 +00002026
Spandan Das9e93d3d2023-03-08 05:47:29 +00002027// ApiSurfaces directory returns the source path inside the api_surfaces repo
2028// (relative to workspace root).
2029func (c *config) ApiSurfacesDir(s ApiSurface, version string) string {
2030 return filepath.Join(
2031 "build",
2032 "bazel",
2033 "api_surfaces",
2034 s.String(),
2035 version)
2036}
Jihoon Kang1bff0342023-01-17 20:40:22 +00002037
Jihoon Kang1975d3e2023-10-16 23:24:11 +00002038func (c *config) JavaCoverageEnabled() bool {
2039 return c.IsEnvTrue("EMMA_INSTRUMENT") || c.IsEnvTrue("EMMA_INSTRUMENT_STATIC") || c.IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK")
2040}
2041
Jihoon Kangc1b04d62023-11-16 19:07:04 +00002042func (c *deviceConfig) BuildFromSourceStub() bool {
2043 return Bool(c.config.productVariables.BuildFromSourceStub)
2044}
2045
Jihoon Kang1bff0342023-01-17 20:40:22 +00002046func (c *config) BuildFromTextStub() bool {
Jihoon Kang1975d3e2023-10-16 23:24:11 +00002047 // TODO: b/302320354 - Remove the coverage build specific logic once the
2048 // robust solution for handling native properties in from-text stub build
2049 // is implemented.
Jihoon Kangc1b04d62023-11-16 19:07:04 +00002050 return !c.buildFromSourceStub &&
2051 !c.JavaCoverageEnabled() &&
2052 !c.deviceConfig.BuildFromSourceStub()
Jihoon Kang1bff0342023-01-17 20:40:22 +00002053}
Spandan Das4deab282023-03-30 17:06:32 +00002054
2055func (c *config) SetBuildFromTextStub(b bool) {
Jihoon Kang2a929ad2023-06-08 19:02:07 +00002056 c.buildFromSourceStub = !b
Jihoon Kangcbcad7c2023-06-01 22:31:52 +00002057 c.productVariables.Build_from_text_stub = boolPtr(b)
Spandan Das4deab282023-03-30 17:06:32 +00002058}
Jihoon Kang1c92c3e2023-03-23 17:44:51 +00002059
Jihoon Kang1c92c3e2023-03-23 17:44:51 +00002060func (c *config) SetApiLibraries(libs []string) {
2061 c.apiLibraries = make(map[string]struct{})
2062 for _, lib := range libs {
2063 c.apiLibraries[lib] = struct{}{}
2064 }
2065}
2066
2067func (c *config) GetApiLibraries() map[string]struct{} {
2068 return c.apiLibraries
2069}
Inseob Kim5bac3b62023-08-25 21:29:46 +09002070
2071func (c *deviceConfig) CheckVendorSeappViolations() bool {
2072 return Bool(c.config.productVariables.CheckVendorSeappViolations)
2073}
Jihoon Kangcfbc4072023-09-20 01:02:18 +00002074
Inseob Kime4e85d52023-10-25 23:53:58 +09002075func (c *config) GetBuildFlag(name string) (string, bool) {
2076 val, ok := c.productVariables.BuildFlags[name]
2077 return val, ok
2078}
Spandan Dase3fcb412023-10-26 20:48:02 +00002079
Colin Cross8f1b0332024-01-25 13:39:06 -08002080func (c *config) UseResourceProcessorByDefault() bool {
2081 return c.productVariables.GetBuildFlagBool("RELEASE_USE_RESOURCE_PROCESSOR_BY_DEFAULT")
2082}
2083
Spandan Dase3fcb412023-10-26 20:48:02 +00002084var (
2085 mainlineApexContributionBuildFlags = []string{
Spandan Das06c64f02024-02-28 18:37:20 +00002086 "RELEASE_APEX_CONTRIBUTIONS_ADBD",
Spandan Dase3fcb412023-10-26 20:48:02 +00002087 "RELEASE_APEX_CONTRIBUTIONS_ADSERVICES",
2088 "RELEASE_APEX_CONTRIBUTIONS_APPSEARCH",
2089 "RELEASE_APEX_CONTRIBUTIONS_ART",
2090 "RELEASE_APEX_CONTRIBUTIONS_BLUETOOTH",
Spandan Das06c64f02024-02-28 18:37:20 +00002091 "RELEASE_APEX_CONTRIBUTIONS_CAPTIVEPORTALLOGIN",
2092 "RELEASE_APEX_CONTRIBUTIONS_CELLBROADCAST",
Spandan Dase3fcb412023-10-26 20:48:02 +00002093 "RELEASE_APEX_CONTRIBUTIONS_CONFIGINFRASTRUCTURE",
2094 "RELEASE_APEX_CONTRIBUTIONS_CONNECTIVITY",
2095 "RELEASE_APEX_CONTRIBUTIONS_CONSCRYPT",
2096 "RELEASE_APEX_CONTRIBUTIONS_CRASHRECOVERY",
2097 "RELEASE_APEX_CONTRIBUTIONS_DEVICELOCK",
Spandan Das06c64f02024-02-28 18:37:20 +00002098 "RELEASE_APEX_CONTRIBUTIONS_DOCUMENTSUIGOOGLE",
2099 "RELEASE_APEX_CONTRIBUTIONS_EXTSERVICES",
Spandan Dase3fcb412023-10-26 20:48:02 +00002100 "RELEASE_APEX_CONTRIBUTIONS_HEALTHFITNESS",
2101 "RELEASE_APEX_CONTRIBUTIONS_IPSEC",
2102 "RELEASE_APEX_CONTRIBUTIONS_MEDIA",
2103 "RELEASE_APEX_CONTRIBUTIONS_MEDIAPROVIDER",
Spandan Dasdab69e12024-04-30 18:14:49 +00002104 "RELEASE_APEX_CONTRIBUTIONS_MODULE_METADATA",
Spandan Das06c64f02024-02-28 18:37:20 +00002105 "RELEASE_APEX_CONTRIBUTIONS_NETWORKSTACKGOOGLE",
2106 "RELEASE_APEX_CONTRIBUTIONS_NEURALNETWORKS",
Spandan Dase3fcb412023-10-26 20:48:02 +00002107 "RELEASE_APEX_CONTRIBUTIONS_ONDEVICEPERSONALIZATION",
2108 "RELEASE_APEX_CONTRIBUTIONS_PERMISSION",
Pedro Loureiro57b1b682024-05-09 13:18:15 +00002109 "RELEASE_APEX_CONTRIBUTIONS_PRIMARY_LIBS",
Spandan Dase3fcb412023-10-26 20:48:02 +00002110 "RELEASE_APEX_CONTRIBUTIONS_REMOTEKEYPROVISIONING",
Spandan Das06c64f02024-02-28 18:37:20 +00002111 "RELEASE_APEX_CONTRIBUTIONS_RESOLV",
Spandan Dase3fcb412023-10-26 20:48:02 +00002112 "RELEASE_APEX_CONTRIBUTIONS_SCHEDULING",
2113 "RELEASE_APEX_CONTRIBUTIONS_SDKEXTENSIONS",
Spandan Das06c64f02024-02-28 18:37:20 +00002114 "RELEASE_APEX_CONTRIBUTIONS_SWCODEC",
Spandan Dase3fcb412023-10-26 20:48:02 +00002115 "RELEASE_APEX_CONTRIBUTIONS_STATSD",
Alyssa Ketpreechasawatdcda1c82024-05-30 19:27:48 +00002116 "RELEASE_APEX_CONTRIBUTIONS_TELEMETRY_TVP",
Spandan Das06c64f02024-02-28 18:37:20 +00002117 "RELEASE_APEX_CONTRIBUTIONS_TZDATA",
Spandan Dase3fcb412023-10-26 20:48:02 +00002118 "RELEASE_APEX_CONTRIBUTIONS_UWB",
2119 "RELEASE_APEX_CONTRIBUTIONS_WIFI",
2120 }
2121)
2122
2123// Returns the list of _selected_ apex_contributions
2124// Each mainline module will have one entry in the list
2125func (c *config) AllApexContributions() []string {
2126 ret := []string{}
2127 for _, f := range mainlineApexContributionBuildFlags {
2128 if val, exists := c.GetBuildFlag(f); exists && val != "" {
2129 ret = append(ret, val)
2130 }
2131 }
2132 return ret
2133}
Spandan Das8ab28dd2024-02-17 03:31:45 +00002134
Spandan Das0d24ade2024-03-08 04:20:15 +00002135func (c *config) BuildIgnoreApexContributionContents() *bool {
Spandan Das8ab28dd2024-02-17 03:31:45 +00002136 return c.productVariables.BuildIgnoreApexContributionContents
2137}
Inseob Kim8fa54da2024-03-19 16:48:59 +09002138
2139func (c *config) ProductLocales() []string {
2140 return c.productVariables.ProductLocales
2141}
2142
2143func (c *config) ProductDefaultWifiChannels() []string {
2144 return c.productVariables.ProductDefaultWifiChannels
2145}
2146
2147func (c *config) BoardUseVbmetaDigestInFingerprint() bool {
2148 return Bool(c.productVariables.BoardUseVbmetaDigestInFingerprint)
2149}
2150
2151func (c *config) OemProperties() []string {
2152 return c.productVariables.OemProperties
2153}