blob: a9fcca5ade972cfc22f1a5d996321cead3475327 [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"
Colin Cross6ff51382015-12-17 16:39:19 -080030
Colin Cross98be1bb2019-12-13 20:41:13 -080031 "github.com/google/blueprint"
Colin Crosse87040b2017-12-11 15:52:26 -080032 "github.com/google/blueprint/bootstrap"
Colin Cross98be1bb2019-12-13 20:41:13 -080033 "github.com/google/blueprint/pathtools"
Colin Cross6ff51382015-12-17 16:39:19 -080034 "github.com/google/blueprint/proptools"
Colin Cross9d34f352019-11-22 16:03:51 -080035
36 "android/soong/android/soongconfig"
Liz Kammer09f947d2021-05-12 14:51:49 -040037 "android/soong/bazel"
Colin Cross77cdcfd2021-03-12 11:28:25 -080038 "android/soong/remoteexec"
Liz Kammer72beb342022-02-03 08:42:10 -050039 "android/soong/starlark_fmt"
Colin Cross3f40fa42015-01-30 17:27:36 -080040)
41
Jingwen Chenc711fec2020-11-22 23:52:50 -050042// Bool re-exports proptools.Bool for the android package.
Colin Cross6ff51382015-12-17 16:39:19 -080043var Bool = proptools.Bool
Jingwen Chenc711fec2020-11-22 23:52:50 -050044
45// String re-exports proptools.String for the android package.
Jack He8cc71432016-12-08 15:45:07 -080046var String = proptools.String
Jingwen Chenc711fec2020-11-22 23:52:50 -050047
48// StringDefault re-exports proptools.StringDefault for the android package.
Jeongik Cha219141c2020-08-06 23:00:37 +090049var StringDefault = proptools.StringDefault
Jiyong Park6a927c42020-01-21 02:03:43 +090050
Jingwen Chenc711fec2020-11-22 23:52:50 -050051// FutureApiLevelInt is a placeholder constant for unreleased API levels.
Dan Albert0b176c82020-07-23 16:43:25 -070052const FutureApiLevelInt = 10000
53
Spandan Das15da5882023-03-02 23:36:39 +000054// PrivateApiLevel represents the api level of SdkSpecPrivate (sdk_version: "")
55// This api_level exists to differentiate user-provided "" from "current" sdk_version
56// The differentiation is necessary to enable different validation rules for these two possible values.
57var PrivateApiLevel = ApiLevel{
58 value: "current", // The value is current since aidl expects `current` as the default (TestAidlFlagsWithMinSdkVersion)
59 number: FutureApiLevelInt + 1, // This is used to differentiate it from FutureApiLevel
60 isPreview: true,
61}
62
Jingwen Chenc711fec2020-11-22 23:52:50 -050063// FutureApiLevel represents unreleased API levels.
Dan Albert0b176c82020-07-23 16:43:25 -070064var FutureApiLevel = ApiLevel{
65 value: "current",
66 number: FutureApiLevelInt,
67 isPreview: true,
68}
Colin Cross6ff51382015-12-17 16:39:19 -080069
Jingwen Chenc4d91bc2020-11-24 22:59:26 -050070// The product variables file name, containing product config from Kati.
Dan Willemsen87b17d12015-07-14 00:39:06 -070071const productVariablesFileName = "soong.variables"
Colin Cross3f40fa42015-01-30 17:27:36 -080072
Colin Cross9272ade2016-08-17 15:24:12 -070073// A Config object represents the entire build configuration for Android.
Colin Crossc3c0a492015-04-10 15:43:55 -070074type Config struct {
75 *config
76}
77
Chris Parsonsad876012022-08-20 14:48:32 -040078type SoongBuildMode int
79
Sasha Smundakaf5ca922022-12-12 21:23:34 -080080type CmdArgs struct {
81 bootstrap.Args
Kiyoung Kima37d9ba2023-04-19 13:13:45 +090082 RunGoTests bool
83 OutDir string
84 SoongOutDir string
85 SoongVariables string
Sasha Smundakaf5ca922022-12-12 21:23:34 -080086
87 SymlinkForestMarker string
88 Bp2buildMarker string
89 BazelQueryViewDir string
Sasha Smundakaf5ca922022-12-12 21:23:34 -080090 ModuleGraphFile string
91 ModuleActionsFile string
92 DocFile string
93
LaMont Jones52a72432023-03-09 18:19:35 +000094 MultitreeBuild bool
95
Sasha Smundakaf5ca922022-12-12 21:23:34 -080096 BazelMode bool
Sasha Smundakaf5ca922022-12-12 21:23:34 -080097 BazelModeStaging bool
98 BazelForceEnabledModules string
Chris Parsons9402ca82023-02-23 17:28:06 -050099
100 UseBazelProxy bool
Jihoon Kang1bff0342023-01-17 20:40:22 +0000101
Jihoon Kang2a929ad2023-06-08 19:02:07 +0000102 BuildFromSourceStub bool
MarkDacekf47e1422023-04-19 16:47:36 +0000103
104 EnsureAllowlistIntegrity bool
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800105}
106
Chris Parsonsad876012022-08-20 14:48:32 -0400107// Build modes that soong_build can run as.
108const (
109 // Don't use bazel at all during module analysis.
110 AnalysisNoBazel SoongBuildMode = iota
111
Lukacs T. Berkic541cd22022-10-26 07:26:50 +0000112 // Symlink fores mode: merge two directory trees into a symlink forest
113 SymlinkForest
114
Chris Parsonsad876012022-08-20 14:48:32 -0400115 // Bp2build mode: Generate BUILD files from blueprint files and exit.
116 Bp2build
117
118 // Generate BUILD files which faithfully represent the dependency graph of
119 // blueprint modules. Individual BUILD targets will not, however, faitfhully
120 // express build semantics.
121 GenerateQueryView
122
123 // Create a JSON representation of the module graph and exit.
124 GenerateModuleGraph
125
126 // Generate a documentation file for module type definitions and exit.
127 GenerateDocFile
128
MarkDacekb78465d2022-10-18 20:10:16 +0000129 // Use bazel during analysis of a few allowlisted build modules. The allowlist
130 // is considered "staging, as these are modules being prepared to be released
131 // into prod mode shortly after.
132 BazelStagingMode
133
Chris Parsonsad876012022-08-20 14:48:32 -0400134 // Use bazel during analysis of build modules from an allowlist carefully
135 // curated by the build team to be proven stable.
Chris Parsonsad876012022-08-20 14:48:32 -0400136 BazelProdMode
137)
138
Lukacs T. Berkib078ade2021-08-31 10:42:08 +0200139// SoongOutDir returns the build output directory for the configuration.
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200140func (c Config) SoongOutDir() string {
141 return c.soongOutDir
Jeff Gastonefc1b412017-03-29 17:29:06 -0700142}
143
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200144func (c Config) OutDir() string {
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200145 return c.outDir
Lukacs T. Berki89e9a162021-03-12 08:31:32 +0100146}
147
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200148func (c Config) RunGoTests() bool {
149 return c.runGoTests
150}
151
Lukacs T. Berki5f6cb1d2021-03-17 15:03:14 +0100152func (c Config) DebugCompilation() bool {
153 return false // Never compile Go code in the main build for debugging
154}
155
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200156func (c Config) Subninjas() []string {
157 return []string{}
158}
159
160func (c Config) PrimaryBuilderInvocations() []bootstrap.PrimaryBuilderInvocation {
161 return []bootstrap.PrimaryBuilderInvocation{}
162}
163
Paul Duffin74135582022-10-06 11:01:59 +0100164// RunningInsideUnitTest returns true if this code is being run as part of a Soong unit test.
165func (c Config) RunningInsideUnitTest() bool {
166 return c.config.TestProductVariables != nil
167}
168
Pratyushfaec4db2023-07-20 11:19:04 +0000169// DisableHiddenApiChecks returns true if hiddenapi checks have been disabled.
Alyssa Ketpreechasawat7daf2782023-11-01 13:58:39 +0000170// For 'eng' target variant hiddenapi checks are disabled by default for performance optimisation,
Pratyushfaec4db2023-07-20 11:19:04 +0000171// but can be enabled by setting environment variable ENABLE_HIDDENAPI_FLAGS=true.
172// For other target variants hiddenapi check are enabled by default but can be disabled by
173// setting environment variable UNSAFE_DISABLE_HIDDENAPI_FLAGS=true.
174// If both ENABLE_HIDDENAPI_FLAGS=true and UNSAFE_DISABLE_HIDDENAPI_FLAGS=true, then
175// ENABLE_HIDDENAPI_FLAGS=true will be triggered and hiddenapi checks will be considered enabled.
176func (c Config) DisableHiddenApiChecks() bool {
177 return !c.IsEnvTrue("ENABLE_HIDDENAPI_FLAGS") &&
178 (c.IsEnvTrue("UNSAFE_DISABLE_HIDDENAPI_FLAGS") ||
Alyssa Ketpreechasawat7daf2782023-11-01 13:58:39 +0000179 Bool(c.productVariables.Eng))
180}
181
182// DisableVerifyOverlaps returns true if verify_overlaps is skipped.
183// Mismatch in version of apexes and module SDK is required for mainline prebuilts to work in
184// trunk stable.
185// Thus, verify_overlaps is disabled when RELEASE_DEFAULT_MODULE_BUILD_FROM_SOURCE is set to false.
186// TODO(b/308174018): Re-enable verify_overlaps for both builr from source/mainline prebuilts.
187func (c Config) DisableVerifyOverlaps() bool {
188 return c.IsEnvTrue("DISABLE_VERIFY_OVERLAPS") || !c.ReleaseDefaultModuleBuildFromSource()
Pratyushfaec4db2023-07-20 11:19:04 +0000189}
190
Juan Yescas05d4d902023-04-07 10:35:35 -0700191// MaxPageSizeSupported returns the max page size supported by the device. This
192// value will define the ELF segment alignment for binaries (executables and
193// shared libraries).
194func (c Config) MaxPageSizeSupported() string {
195 return String(c.config.productVariables.DeviceMaxPageSizeSupported)
196}
197
Juan Yescas01065602023-08-09 08:34:37 -0700198// PageSizeAgnostic returns true when AOSP is page size agnostic,
199// othersise it returns false.
200func (c Config) PageSizeAgnostic() bool {
201 return Bool(c.config.productVariables.DevicePageSizeAgnostic)
202}
203
Joe Onoratofee845a2023-05-09 08:14:14 -0700204// The release version passed to aconfig, derived from RELEASE_VERSION
205func (c Config) ReleaseVersion() string {
206 return c.config.productVariables.ReleaseVersion
207}
208
Yu Liu2cc802a2023-09-05 17:19:45 -0700209// The aconfig value set passed to aconfig, derived from RELEASE_VERSION
Yu Liueebb2592023-10-12 20:31:27 -0700210func (c Config) ReleaseAconfigValueSets() []string {
Yu Liu2cc802a2023-09-05 17:19:45 -0700211 // This logic to handle both Soong module name and bazel target is temporary in order to
Yu Liu855cfc22023-09-14 15:10:03 -0700212 // provide backward compatibility where aosp and internal both have the release
Yu Liu2cc802a2023-09-05 17:19:45 -0700213 // aconfig value set but can't be updated at the same time to use bazel target
Yu Liueebb2592023-10-12 20:31:27 -0700214 var valueSets []string
215 for _, valueSet := range c.config.productVariables.ReleaseAconfigValueSets {
216 value := strings.Split(valueSet, ":")
217 valueLen := len(value)
218 if valueLen > 2 {
219 // This shouldn't happen as this should be either a module name or a bazel target path.
220 panic(fmt.Errorf("config file: invalid value for release aconfig value sets: %s", valueSet))
221 }
222 if valueLen > 0 {
223 valueSets = append(valueSets, value[valueLen-1])
224 }
Yu Liu2cc802a2023-09-05 17:19:45 -0700225 }
Yu Liueebb2592023-10-12 20:31:27 -0700226 return valueSets
Joe Onoratofee845a2023-05-09 08:14:14 -0700227}
228
Zhi Dou3f65a412023-08-10 21:47:40 +0000229// The flag default permission value passed to aconfig
230// derived from RELEASE_ACONFIG_FLAG_DEFAULT_PERMISSION
231func (c Config) ReleaseAconfigFlagDefaultPermission() string {
232 return c.config.productVariables.ReleaseAconfigFlagDefaultPermission
233}
234
Alyssa Ketpreechasawat34ab8792023-10-06 07:01:22 +0000235// The flag indicating behavior for the tree wrt building modules or using prebuilts
236// derived from RELEASE_DEFAULT_MODULE_BUILD_FROM_SOURCE
237func (c Config) ReleaseDefaultModuleBuildFromSource() bool {
238 return c.config.productVariables.ReleaseDefaultModuleBuildFromSource == nil ||
239 Bool(c.config.productVariables.ReleaseDefaultModuleBuildFromSource)
240}
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
Jingwen Chenc711fec2020-11-22 23:52:50 -0500261 // A specialized context object for Bazel/Soong mixed builds and migration
262 // purposes.
Chris Parsonsf3c96ef2020-09-29 02:23:17 -0400263 BazelContext BazelContext
264
Dan Willemsen87b17d12015-07-14 00:39:06 -0700265 ProductVariablesFileName string
266
Colin Cross0c66bc62021-07-20 09:47:41 -0700267 // BuildOS stores the OsType for the OS that the build is running on.
268 BuildOS OsType
269
270 // BuildArch stores the ArchType for the CPU that the build is running on.
271 BuildArch ArchType
272
Jaewoong Jung642916f2020-10-09 17:25:15 -0700273 Targets map[OsType][]Target
274 BuildOSTarget Target // the Target for tools run on the build machine
275 BuildOSCommonTarget Target // the Target for common (java) tools run on the build machine
276 AndroidCommonTarget Target // the Target for common modules for the Android device
277 AndroidFirstDeviceTarget Target // the first Target for modules for the Android device
Dan Willemsen218f6562015-07-08 18:13:11 -0700278
Jingwen Chenc711fec2020-11-22 23:52:50 -0500279 // multilibConflicts for an ArchType is true if there is earlier configured
280 // device architecture with the same multilib value.
Colin Cross3b19f5d2019-09-17 14:45:31 -0700281 multilibConflicts map[ArchType]bool
282
Colin Cross9272ade2016-08-17 15:24:12 -0700283 deviceConfig *deviceConfig
284
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200285 outDir string // The output directory (usually out/)
286 soongOutDir string
Chris Parsons8f232a22020-06-23 17:37:05 -0400287 moduleListFile string // the path to the file which lists blueprint files to parse.
Colin Crossc1e86a32015-04-15 12:33:28 -0700288
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +0200289 runGoTests bool
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200290
Colin Cross6ccbc912017-10-10 23:07:38 -0700291 env map[string]string
Dan Willemsene7680ba2015-09-11 17:06:19 -0700292 envLock sync.Mutex
293 envDeps map[string]string
294 envFrozen bool
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800295
Jingwen Chencda22c92020-11-23 00:22:30 -0500296 // Changes behavior based on whether Kati runs after soong_build, or if soong_build
297 // runs standalone.
298 katiEnabled bool
Colin Cross1e7d3702016-08-24 15:25:47 -0700299
Colin Cross32616ed2017-09-05 21:56:44 -0700300 captureBuild bool // true for tests, saves build parameters for each module
301 ignoreEnvironment bool // true for tests, returns empty from all Getenv calls
Colin Crosscec81712017-07-13 14:43:27 -0700302
Colin Cross98be1bb2019-12-13 20:41:13 -0800303 fs pathtools.FileSystem
304 mockBpList string
305
Chris Parsonsad876012022-08-20 14:48:32 -0400306 BuildMode SoongBuildMode
Cole Faust324a92e2022-08-23 15:29:05 -0700307 Bp2buildPackageConfig Bp2BuildConversionAllowlist
Jingwen Chen01812022021-11-19 14:29:43 +0000308 Bp2buildSoongConfigDefinitions soongconfig.Bp2BuildSoongConfigDefinitions
Jingwen Chen12b4c272021-03-10 02:05:59 -0500309
LaMont Jones52a72432023-03-09 18:19:35 +0000310 // If MultitreeBuild is true then this is one inner tree of a multitree
311 // build directed by the multitree orchestrator.
312 MultitreeBuild bool
313
Colin Cross5e6a7972020-06-07 16:56:32 -0700314 // If testAllowNonExistentPaths is true then PathForSource and PathForModuleSrc won't error
315 // in tests when a path doesn't exist.
Pedro Loureiro5d190cc2021-02-15 15:41:33 +0000316 TestAllowNonExistentPaths bool
Colin Cross5e6a7972020-06-07 16:56:32 -0700317
Jingwen Chenc711fec2020-11-22 23:52:50 -0500318 // The list of files that when changed, must invalidate soong_build to
319 // regenerate build.ninja.
Colin Cross12129292020-10-29 18:23:58 -0700320 ninjaFileDepsSet sync.Map
321
Colin Cross9272ade2016-08-17 15:24:12 -0700322 OncePer
MarkDacekff851b82022-04-21 18:33:17 +0000323
Chris Parsonsad876012022-08-20 14:48:32 -0400324 // These fields are only used for metrics collection. A module should be added
325 // to these maps only if its implementation supports Bazel handling in mixed
326 // builds. A module being in the "enabled" list indicates that there is a
327 // variant of that module for which bazel-handling actually took place.
328 // A module being in the "disabled" list indicates that there is a variant of
329 // that module for which bazel-handling was denied.
MarkDacekff851b82022-04-21 18:33:17 +0000330 mixedBuildsLock sync.Mutex
331 mixedBuildEnabledModules map[string]struct{}
332 mixedBuildDisabledModules map[string]struct{}
MarkDacekd06db5d2022-11-29 00:47:59 +0000333
334 // These are modules to be built with Bazel beyond the allowlisted/build-mode
335 // specified modules. They are passed via the command-line flag
336 // "--bazel-force-enabled-modules"
337 bazelForceEnabledModules map[string]struct{}
Chris Parsons9402ca82023-02-23 17:28:06 -0500338
Chris Parsons8152a942023-06-06 16:17:50 +0000339 // Names of Bazel targets as defined by BUILD files in the source tree,
340 // keyed by the directory in which they are defined.
341 bazelTargetsByDir map[string][]string
342
Chris Parsons9402ca82023-02-23 17:28:06 -0500343 // If true, for any requests to Bazel, communicate with a Bazel proxy using
344 // unix sockets, instead of spawning Bazel as a subprocess.
345 UseBazelProxy bool
Jihoon Kang1bff0342023-01-17 20:40:22 +0000346
Jihoon Kang2a929ad2023-06-08 19:02:07 +0000347 // If buildFromSourceStub is true then the Java API stubs are
348 // built from the source Java files, not the signature text files.
349 buildFromSourceStub bool
MarkDacekf47e1422023-04-19 16:47:36 +0000350
351 // If ensureAllowlistIntegrity is true, then the presence of any allowlisted
352 // modules that aren't mixed-built for at least one variant will cause a build
353 // failure
354 ensureAllowlistIntegrity bool
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000355
356 // List of Api libraries that contribute to Api surfaces.
357 apiLibraries map[string]struct{}
Colin Cross9272ade2016-08-17 15:24:12 -0700358}
359
360type deviceConfig struct {
Dan Willemsen00269f22017-07-06 16:59:48 -0700361 config *config
Colin Cross9272ade2016-08-17 15:24:12 -0700362 OncePer
Colin Cross3f40fa42015-01-30 17:27:36 -0800363}
364
Colin Cross485e5722015-08-27 13:28:01 -0700365type jsonConfigurable interface {
Colin Cross27385972015-09-18 10:57:10 -0700366 SetDefaultConfig()
Colin Cross485e5722015-08-27 13:28:01 -0700367}
Colin Cross3f40fa42015-01-30 17:27:36 -0800368
Colin Cross485e5722015-08-27 13:28:01 -0700369func loadConfig(config *config) error {
Colin Cross988414c2020-01-11 01:11:46 +0000370 return loadFromConfigFile(&config.productVariables, absolutePath(config.ProductVariablesFileName))
Colin Cross485e5722015-08-27 13:28:01 -0700371}
372
Jingwen Chenc711fec2020-11-22 23:52:50 -0500373// loadFromConfigFile loads and decodes configuration options from a JSON file
374// in the current working directory.
Cole Faustf8231dd2023-04-21 17:37:11 -0700375func loadFromConfigFile(configurable *ProductVariables, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800376 // Try to open the file
Colin Cross485e5722015-08-27 13:28:01 -0700377 configFileReader, err := os.Open(filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800378 defer configFileReader.Close()
379 if os.IsNotExist(err) {
380 // Need to create a file, so that blueprint & ninja don't get in
381 // a dependency tracking loop.
382 // Make a file-configurable-options with defaults, write it out using
383 // a json writer.
Colin Cross27385972015-09-18 10:57:10 -0700384 configurable.SetDefaultConfig()
385 err = saveToConfigFile(configurable, filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800386 if err != nil {
387 return err
388 }
Colin Cross15cd21a2018-02-27 11:26:02 -0800389 } else if err != nil {
390 return fmt.Errorf("config file: could not open %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800391 } else {
392 // Make a decoder for it
393 jsonDecoder := json.NewDecoder(configFileReader)
Colin Cross485e5722015-08-27 13:28:01 -0700394 err = jsonDecoder.Decode(configurable)
Colin Cross3f40fa42015-01-30 17:27:36 -0800395 if err != nil {
Colin Cross15cd21a2018-02-27 11:26:02 -0800396 return fmt.Errorf("config file: %s did not parse correctly: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800397 }
398 }
399
Liz Kammer09f947d2021-05-12 14:51:49 -0400400 if Bool(configurable.GcovCoverage) && Bool(configurable.ClangCoverage) {
401 return fmt.Errorf("GcovCoverage and ClangCoverage cannot both be set")
402 }
403
404 configurable.Native_coverage = proptools.BoolPtr(
405 Bool(configurable.GcovCoverage) ||
406 Bool(configurable.ClangCoverage))
407
Yuntao Xu402e9b02021-08-09 15:44:44 -0700408 // when Platform_sdk_final is true (or PLATFORM_VERSION_CODENAME is REL), use Platform_sdk_version;
409 // if false (pre-released version, for example), use Platform_sdk_codename.
410 if Bool(configurable.Platform_sdk_final) {
411 if configurable.Platform_sdk_version != nil {
412 configurable.Platform_sdk_version_or_codename =
413 proptools.StringPtr(strconv.Itoa(*(configurable.Platform_sdk_version)))
414 } else {
415 return fmt.Errorf("Platform_sdk_version cannot be pointed by a NULL pointer")
416 }
417 } else {
418 configurable.Platform_sdk_version_or_codename =
419 proptools.StringPtr(String(configurable.Platform_sdk_codename))
420 }
421
Liz Kammer09f947d2021-05-12 14:51:49 -0400422 return saveToBazelConfigFile(configurable, filepath.Dir(filename))
Colin Cross3f40fa42015-01-30 17:27:36 -0800423}
424
Colin Crossd8f20142016-11-03 09:43:26 -0700425// atomically writes the config file in case two copies of soong_build are running simultaneously
426// (for example, docs generation and ninja manifest generation)
Cole Faustf8231dd2023-04-21 17:37:11 -0700427func saveToConfigFile(config *ProductVariables, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800428 data, err := json.MarshalIndent(&config, "", " ")
429 if err != nil {
430 return fmt.Errorf("cannot marshal config data: %s", err.Error())
431 }
432
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800433 f, err := os.CreateTemp(filepath.Dir(filename), "config")
Colin Cross3f40fa42015-01-30 17:27:36 -0800434 if err != nil {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500435 return fmt.Errorf("cannot create empty config file %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800436 }
Colin Crossd8f20142016-11-03 09:43:26 -0700437 defer os.Remove(f.Name())
438 defer f.Close()
Colin Cross3f40fa42015-01-30 17:27:36 -0800439
Colin Crossd8f20142016-11-03 09:43:26 -0700440 _, err = f.Write(data)
Colin Cross3f40fa42015-01-30 17:27:36 -0800441 if err != nil {
Colin Cross485e5722015-08-27 13:28:01 -0700442 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
443 }
444
Colin Crossd8f20142016-11-03 09:43:26 -0700445 _, err = f.WriteString("\n")
Colin Cross485e5722015-08-27 13:28:01 -0700446 if err != nil {
447 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800448 }
449
Colin Crossd8f20142016-11-03 09:43:26 -0700450 f.Close()
451 os.Rename(f.Name(), filename)
452
Colin Cross3f40fa42015-01-30 17:27:36 -0800453 return nil
454}
455
Cole Faust87c0c332023-07-31 12:10:12 -0700456type productVariableStarlarkRepresentation struct {
457 soongType string
458 selectable bool
459 archVariant bool
460}
461
Cole Faustf8231dd2023-04-21 17:37:11 -0700462func saveToBazelConfigFile(config *ProductVariables, outDir string) error {
Liz Kammer09f947d2021-05-12 14:51:49 -0400463 dir := filepath.Join(outDir, bazel.SoongInjectionDirName, "product_config")
464 err := createDirIfNonexistent(dir, os.ModePerm)
465 if err != nil {
466 return fmt.Errorf("Could not create dir %s: %s", dir, err)
467 }
468
Cole Faust87c0c332023-07-31 12:10:12 -0700469 allProductVariablesType := reflect.TypeOf((*ProductVariables)(nil)).Elem()
470 productVariablesInfo := make(map[string]productVariableStarlarkRepresentation)
Sam Delmerico5c32bbf2022-01-20 20:15:02 +0000471 p := variableProperties{}
472 t := reflect.TypeOf(p.Product_variables)
473 for i := 0; i < t.NumField(); i++ {
474 f := t.Field(i)
Cole Faust87c0c332023-07-31 12:10:12 -0700475 archVariant := proptools.HasTag(f, "android", "arch_variant")
476 if mainProductVariablesStructField, ok := allProductVariablesType.FieldByName(f.Name); ok {
477 productVariablesInfo[f.Name] = productVariableStarlarkRepresentation{
478 soongType: stringRepresentationOfSimpleType(mainProductVariablesStructField.Type),
479 selectable: true,
480 archVariant: archVariant,
481 }
482 } else {
483 panic("Unknown variable " + f.Name)
Sam Delmerico5c32bbf2022-01-20 20:15:02 +0000484 }
485 }
486
Cole Fausteb644cf2023-04-11 13:48:17 -0700487 err = pathtools.WriteFileIfChanged(filepath.Join(dir, "product_variable_constants.bzl"), []byte(fmt.Sprintf(`
Cole Faust87c0c332023-07-31 12:10:12 -0700488# product_var_constant_info is a map of product variables to information about them. The fields are:
489# - soongType: The type of the product variable as it appears in soong's ProductVariables struct.
490# examples are string, bool, int, *bool, *string, []string, etc. This may be an overly
491# conservative estimation of the type, for example a *bool could oftentimes just be a
492# bool that defaults to false.
493# - selectable: if this product variable can be selected on in Android.bp/build files. This means
494# it's listed in the "variableProperties" soong struct. Currently all variables in
495# this list are selectable because we only need the selectable ones at the moment,
496# but the list may be expanded later.
497# - archVariant: If the variable is tagged as arch variant in the "variableProperties" struct.
498product_var_constant_info = %s
499product_var_constraints = [k for k, v in product_var_constant_info.items() if v.selectable]
500arch_variant_product_var_constraints = [k for k, v in product_var_constant_info.items() if v.selectable and v.archVariant]
501`, starlark_fmt.PrintAny(productVariablesInfo, 0))), 0644)
Cole Fausteb644cf2023-04-11 13:48:17 -0700502 if err != nil {
503 return fmt.Errorf("Could not write .bzl config file %s", err)
504 }
Chris Parsons0008cf82023-02-03 18:45:43 -0500505 err = pathtools.WriteFileIfChanged(filepath.Join(dir, "BUILD"),
506 []byte(bazel.GeneratedBazelFileWarning), 0644)
Liz Kammer09f947d2021-05-12 14:51:49 -0400507 if err != nil {
508 return fmt.Errorf("Could not write BUILD config file %s", err)
509 }
510
511 return nil
512}
513
Cole Faust87c0c332023-07-31 12:10:12 -0700514func stringRepresentationOfSimpleType(ty reflect.Type) string {
515 switch ty.Kind() {
516 case reflect.String:
517 return "string"
518 case reflect.Bool:
519 return "bool"
520 case reflect.Int:
521 return "int"
522 case reflect.Slice:
523 return "[]" + stringRepresentationOfSimpleType(ty.Elem())
524 case reflect.Pointer:
525 return "*" + stringRepresentationOfSimpleType(ty.Elem())
526 default:
527 panic("unimplemented type: " + ty.Kind().String())
528 }
529}
530
Colin Cross988414c2020-01-11 01:11:46 +0000531// NullConfig returns a mostly empty Config for use by standalone tools like dexpreopt_gen that
532// use the android package.
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200533func NullConfig(outDir, soongOutDir string) Config {
Colin Cross988414c2020-01-11 01:11:46 +0000534 return Config{
535 config: &config{
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200536 outDir: outDir,
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200537 soongOutDir: soongOutDir,
538 fs: pathtools.OsFs,
Colin Cross988414c2020-01-11 01:11:46 +0000539 },
540 }
541}
542
Jingwen Chenc711fec2020-11-22 23:52:50 -0500543// NewConfig creates a new Config object. The srcDir argument specifies the path
544// to the root source directory. It also loads the config file, if found.
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800545func NewConfig(cmdArgs CmdArgs, availableEnv map[string]string) (Config, error) {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500546 // Make a config with default options.
Colin Cross9272ade2016-08-17 15:24:12 -0700547 config := &config{
Kiyoung Kima37d9ba2023-04-19 13:13:45 +0900548 ProductVariablesFileName: cmdArgs.SoongVariables,
Dan Willemsen87b17d12015-07-14 00:39:06 -0700549
Lukacs T. Berki53b2f362021-04-12 14:04:24 +0200550 env: availableEnv,
Colin Cross6ccbc912017-10-10 23:07:38 -0700551
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800552 outDir: cmdArgs.OutDir,
553 soongOutDir: cmdArgs.SoongOutDir,
554 runGoTests: cmdArgs.RunGoTests,
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +0200555 multilibConflicts: make(map[ArchType]bool),
Colin Cross98be1bb2019-12-13 20:41:13 -0800556
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800557 moduleListFile: cmdArgs.ModuleListFile,
MarkDacekff851b82022-04-21 18:33:17 +0000558 fs: pathtools.NewOsFs(absSrcDir),
559 mixedBuildDisabledModules: make(map[string]struct{}),
560 mixedBuildEnabledModules: make(map[string]struct{}),
MarkDacekd06db5d2022-11-29 00:47:59 +0000561 bazelForceEnabledModules: make(map[string]struct{}),
Chris Parsons9402ca82023-02-23 17:28:06 -0500562
LaMont Jones52a72432023-03-09 18:19:35 +0000563 MultitreeBuild: cmdArgs.MultitreeBuild,
564 UseBazelProxy: cmdArgs.UseBazelProxy,
Jihoon Kang1bff0342023-01-17 20:40:22 +0000565
Jihoon Kang2a929ad2023-06-08 19:02:07 +0000566 buildFromSourceStub: cmdArgs.BuildFromSourceStub,
Colin Cross68f55102015-03-25 14:43:57 -0700567 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800568
Dan Willemsen00269f22017-07-06 16:59:48 -0700569 config.deviceConfig = &deviceConfig{
Colin Cross9272ade2016-08-17 15:24:12 -0700570 config: config,
571 }
572
Liz Kammer7941b302020-07-28 13:27:34 -0700573 // Soundness check of the build and source directories. This won't catch strange
574 // configurations with symlinks, but at least checks the obvious case.
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800575 absBuildDir, err := filepath.Abs(cmdArgs.SoongOutDir)
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700576 if err != nil {
577 return Config{}, err
578 }
579
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200580 absSrcDir, err := filepath.Abs(".")
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700581 if err != nil {
582 return Config{}, err
583 }
584
585 if strings.HasPrefix(absSrcDir, absBuildDir) {
586 return Config{}, fmt.Errorf("Build dir must not contain source directory")
587 }
588
Colin Cross3f40fa42015-01-30 17:27:36 -0800589 // Load any configurable options from the configuration file
Colin Cross9272ade2016-08-17 15:24:12 -0700590 err = loadConfig(config)
Colin Cross3f40fa42015-01-30 17:27:36 -0800591 if err != nil {
Colin Crossc3c0a492015-04-10 15:43:55 -0700592 return Config{}, err
Colin Cross3f40fa42015-01-30 17:27:36 -0800593 }
594
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800595 KatiEnabledMarkerFile := filepath.Join(cmdArgs.SoongOutDir, ".soong.kati_enabled")
Jingwen Chencda22c92020-11-23 00:22:30 -0500596 if _, err := os.Stat(absolutePath(KatiEnabledMarkerFile)); err == nil {
597 config.katiEnabled = true
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800598 }
599
Colin Cross0c66bc62021-07-20 09:47:41 -0700600 determineBuildOS(config)
601
Jingwen Chenc711fec2020-11-22 23:52:50 -0500602 // Sets up the map of target OSes to the finer grained compilation targets
603 // that are configured from the product variables.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700604 targets, err := decodeTargetProductVariables(config)
Dan Willemsen218f6562015-07-08 18:13:11 -0700605 if err != nil {
606 return Config{}, err
607 }
608
Paul Duffin1356d8c2020-02-25 19:26:33 +0000609 // Make the CommonOS OsType available for all products.
610 targets[CommonOS] = []Target{commonTargetMap[CommonOS.Name]}
611
Dan Albert4098deb2016-10-19 14:04:41 -0700612 var archConfig []archConfig
Jingwen Chenc4d91bc2020-11-24 22:59:26 -0500613 if config.NdkAbis() {
Dan Albert4098deb2016-10-19 14:04:41 -0700614 archConfig = getNdkAbisConfig()
Martin Stjernholmc1ecc432019-11-15 15:00:31 +0000615 } else if config.AmlAbis() {
616 archConfig = getAmlAbisConfig()
Dan Albert4098deb2016-10-19 14:04:41 -0700617 }
618
619 if archConfig != nil {
Liz Kammerb7f33662022-02-28 14:16:16 -0500620 androidTargets, err := decodeAndroidArchSettings(archConfig)
Dan Willemsen322acaf2016-01-12 23:07:05 -0800621 if err != nil {
622 return Config{}, err
623 }
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700624 targets[Android] = androidTargets
Dan Willemsen322acaf2016-01-12 23:07:05 -0800625 }
626
Colin Cross3b19f5d2019-09-17 14:45:31 -0700627 multilib := make(map[string]bool)
628 for _, target := range targets[Android] {
629 if seen := multilib[target.Arch.ArchType.Multilib]; seen {
630 config.multilibConflicts[target.Arch.ArchType] = true
631 }
632 multilib[target.Arch.ArchType.Multilib] = true
633 }
634
Jingwen Chenc711fec2020-11-22 23:52:50 -0500635 // Map of OS to compilation targets.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700636 config.Targets = targets
Jingwen Chenc711fec2020-11-22 23:52:50 -0500637
638 // Compilation targets for host tools.
Colin Cross0c66bc62021-07-20 09:47:41 -0700639 config.BuildOSTarget = config.Targets[config.BuildOS][0]
640 config.BuildOSCommonTarget = getCommonTargets(config.Targets[config.BuildOS])[0]
Jingwen Chenc711fec2020-11-22 23:52:50 -0500641
642 // Compilation targets for Android.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700643 if len(config.Targets[Android]) > 0 {
644 config.AndroidCommonTarget = getCommonTargets(config.Targets[Android])[0]
Sam Delmericocc271e22022-06-01 15:45:02 +0000645 config.AndroidFirstDeviceTarget = FirstTarget(config.Targets[Android], "lib64", "lib32")[0]
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700646 }
Dan Willemsen218f6562015-07-08 18:13:11 -0700647
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500648 setBuildMode := func(arg string, mode SoongBuildMode) {
649 if arg != "" {
650 if config.BuildMode != AnalysisNoBazel {
651 fmt.Fprintf(os.Stderr, "buildMode is already set, illegal argument: %s", arg)
652 os.Exit(1)
653 }
654 config.BuildMode = mode
655 }
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800656 }
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500657 setBazelMode := func(arg bool, argName string, mode SoongBuildMode) {
658 if arg {
659 if config.BuildMode != AnalysisNoBazel {
660 fmt.Fprintf(os.Stderr, "buildMode is already set, illegal argument: %s", argName)
661 os.Exit(1)
662 }
663 config.BuildMode = mode
664 }
665 }
666 setBuildMode(cmdArgs.SymlinkForestMarker, SymlinkForest)
667 setBuildMode(cmdArgs.Bp2buildMarker, Bp2build)
668 setBuildMode(cmdArgs.BazelQueryViewDir, GenerateQueryView)
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500669 setBuildMode(cmdArgs.ModuleGraphFile, GenerateModuleGraph)
670 setBuildMode(cmdArgs.DocFile, GenerateDocFile)
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500671 setBazelMode(cmdArgs.BazelMode, "--bazel-mode", BazelProdMode)
672 setBazelMode(cmdArgs.BazelModeStaging, "--bazel-mode-staging", BazelStagingMode)
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800673
MarkDacek1de78f32023-05-02 21:00:48 +0000674 for _, module := range getForceEnabledModulesFromFlag(cmdArgs.BazelForceEnabledModules) {
MarkDacekd06db5d2022-11-29 00:47:59 +0000675 config.bazelForceEnabledModules[module] = struct{}{}
676 }
MarkDacek9c094ca2023-03-16 19:15:19 +0000677 config.BazelContext, err = NewBazelContext(config)
678 config.Bp2buildPackageConfig = GetBp2BuildAllowList()
MarkDacekd06db5d2022-11-29 00:47:59 +0000679
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000680 // TODO(b/276958307): Replace the hardcoded list to a sdk_library local prop.
681 config.apiLibraries = map[string]struct{}{
682 "android.net.ipsec.ike": {},
683 "art.module.public.api": {},
684 "conscrypt.module.public.api": {},
685 "framework-adservices": {},
686 "framework-appsearch": {},
687 "framework-bluetooth": {},
688 "framework-connectivity": {},
689 "framework-connectivity-t": {},
690 "framework-graphics": {},
Mark White387a6582023-08-06 00:20:47 +0000691 "framework-location": {},
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000692 "framework-media": {},
693 "framework-mediaprovider": {},
Roshan Pius92307ff2023-11-13 17:16:35 -0800694 "framework-nfc": {},
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000695 "framework-ondevicepersonalization": {},
Alyssa Ketpreechasawat9f634362023-11-08 16:03:53 +0000696 "framework-pdf": {},
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000697 "framework-permission": {},
698 "framework-permission-s": {},
699 "framework-scheduling": {},
700 "framework-sdkextensions": {},
701 "framework-statsd": {},
702 "framework-sdksandbox": {},
703 "framework-tethering": {},
704 "framework-uwb": {},
705 "framework-virtualization": {},
706 "framework-wifi": {},
707 "i18n.module.public.api": {},
708 }
709
Jihoon Kangc1b04d62023-11-16 19:07:04 +0000710 config.productVariables.Build_from_text_stub = boolPtr(config.BuildFromTextStub())
711
Jingwen Chenc711fec2020-11-22 23:52:50 -0500712 return Config{config}, err
713}
Colin Cross988414c2020-01-11 01:11:46 +0000714
MarkDacek1de78f32023-05-02 21:00:48 +0000715func getForceEnabledModulesFromFlag(forceEnabledFlag string) []string {
716 if forceEnabledFlag == "" {
717 return []string{}
718 }
719 return strings.Split(forceEnabledFlag, ",")
720}
721
Colin Cross98be1bb2019-12-13 20:41:13 -0800722// mockFileSystem replaces all reads with accesses to the provided map of
723// filenames to contents stored as a byte slice.
724func (c *config) mockFileSystem(bp string, fs map[string][]byte) {
725 mockFS := map[string][]byte{}
726
727 if _, exists := mockFS["Android.bp"]; !exists {
728 mockFS["Android.bp"] = []byte(bp)
729 }
730
731 for k, v := range fs {
732 mockFS[k] = v
733 }
734
735 // no module list file specified; find every file named Blueprints or Android.bp
736 pathsToParse := []string{}
737 for candidate := range mockFS {
738 base := filepath.Base(candidate)
Lukacs T. Berkib838b0a2021-09-02 11:46:24 +0200739 if base == "Android.bp" {
Colin Cross98be1bb2019-12-13 20:41:13 -0800740 pathsToParse = append(pathsToParse, candidate)
741 }
742 }
743 if len(pathsToParse) < 1 {
744 panic(fmt.Sprintf("No Blueprint or Android.bp files found in mock filesystem: %v\n", mockFS))
745 }
746 mockFS[blueprint.MockModuleListFile] = []byte(strings.Join(pathsToParse, "\n"))
747
748 c.fs = pathtools.MockFs(mockFS)
749 c.mockBpList = blueprint.MockModuleListFile
750}
751
Jason Wuff1bb312022-12-21 09:57:26 -0500752// TODO(b/265062549): Add a field to our collected (and uploaded) metrics which
753// describes a reason that we fell back to non-mixed builds.
Chris Parsonsad876012022-08-20 14:48:32 -0400754// Returns true if "Bazel builds" is enabled. In this mode, part of build
755// analysis is handled by Bazel.
756func (c *config) IsMixedBuildsEnabled() bool {
Chris Parsons428c30f2022-11-29 14:14:52 -0500757 globalMixedBuildsSupport := c.Once(OnceKey{"globalMixedBuildsSupport"}, func() interface{} {
758 if c.productVariables.DeviceArch != nil && *c.productVariables.DeviceArch == "riscv64" {
Chris Parsons428c30f2022-11-29 14:14:52 -0500759 return false
760 }
Liz Kammer36ba6b22023-06-29 10:18:39 -0400761 // Disable Bazel when Kythe is running
762 if c.EmitXrefRules() {
763 return false
764 }
Sam Delmerico5150d0d2022-11-15 17:44:44 -0500765 if c.IsEnvTrue("GLOBAL_THINLTO") {
Sam Delmerico5150d0d2022-11-15 17:44:44 -0500766 return false
767 }
Sam Delmerico5150d0d2022-11-15 17:44:44 -0500768 if len(c.productVariables.SanitizeHost) > 0 {
Sam Delmerico5150d0d2022-11-15 17:44:44 -0500769 return false
770 }
771 if len(c.productVariables.SanitizeDevice) > 0 {
Sam Delmerico5150d0d2022-11-15 17:44:44 -0500772 return false
773 }
774 if len(c.productVariables.SanitizeDeviceDiag) > 0 {
Sam Delmerico5150d0d2022-11-15 17:44:44 -0500775 return false
776 }
777 if len(c.productVariables.SanitizeDeviceArch) > 0 {
Sam Delmerico5150d0d2022-11-15 17:44:44 -0500778 return false
779 }
Chris Parsons428c30f2022-11-29 14:14:52 -0500780 return true
781 }).(bool)
782
Chris Parsons21f80272023-06-15 04:02:28 +0000783 bazelModeEnabled := c.BuildMode == BazelProdMode || c.BuildMode == BazelStagingMode
Chris Parsons428c30f2022-11-29 14:14:52 -0500784 return globalMixedBuildsSupport && bazelModeEnabled
Chris Parsonsad876012022-08-20 14:48:32 -0400785}
786
Lukacs T. Berkid1e3f1f2021-03-16 08:55:23 +0100787func (c *config) SetAllowMissingDependencies() {
788 c.productVariables.Allow_missing_dependencies = proptools.BoolPtr(true)
789}
790
Jingwen Chenc711fec2020-11-22 23:52:50 -0500791// BlueprintToolLocation returns the directory containing build system tools
792// from Blueprint, like soong_zip and merge_zips.
Lukacs T. Berkia806e412021-09-01 08:57:48 +0200793func (c *config) HostToolDir() string {
Colin Crossacfcc1f2021-10-25 15:40:32 -0700794 if c.KatiEnabled() {
795 return filepath.Join(c.outDir, "host", c.PrebuiltOS(), "bin")
796 } else {
797 return filepath.Join(c.soongOutDir, "host", c.PrebuiltOS(), "bin")
798 }
Dan Willemsenc2aa4a92016-05-26 15:13:03 -0700799}
800
Dan Willemsen60e62f02018-11-16 21:05:32 -0800801func (c *config) HostToolPath(ctx PathContext, tool string) Path {
Cole Faust3b703f32023-10-16 13:30:51 -0700802 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "bin", tool)
Colin Cross790ef352021-10-25 19:15:55 -0700803 return path
Dan Willemsen60e62f02018-11-16 21:05:32 -0800804}
805
Colin Cross790ef352021-10-25 19:15:55 -0700806func (c *config) HostJNIToolPath(ctx PathContext, lib string) Path {
Martin Stjernholm7260d062019-12-09 21:47:14 +0000807 ext := ".so"
808 if runtime.GOOS == "darwin" {
809 ext = ".dylib"
810 }
Cole Faust3b703f32023-10-16 13:30:51 -0700811 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "lib64", lib+ext)
Colin Cross790ef352021-10-25 19:15:55 -0700812 return path
Martin Stjernholm7260d062019-12-09 21:47:14 +0000813}
814
Colin Crossae5330a2021-11-03 13:31:22 -0700815func (c *config) HostJavaToolPath(ctx PathContext, tool string) Path {
Cole Faust3b703f32023-10-16 13:30:51 -0700816 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "framework", tool)
Colin Cross3e3eda62021-11-04 10:22:51 -0700817 return path
818}
819
Vinh Tran09581952023-05-16 16:03:20 -0400820func (c *config) HostCcSharedLibPath(ctx PathContext, lib string) Path {
821 libDir := "lib"
822 if ctx.Config().BuildArch.Multilib == "lib64" {
823 libDir = "lib64"
824 }
Cole Faust3b703f32023-10-16 13:30:51 -0700825 return pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, libDir, lib+".so")
Vinh Tran09581952023-05-16 16:03:20 -0400826}
827
Jingwen Chenc711fec2020-11-22 23:52:50 -0500828// PrebuiltOS returns the name of the host OS used in prebuilts directories.
Colin Cross1332b002015-04-07 17:11:30 -0700829func (c *config) PrebuiltOS() string {
Colin Cross3f40fa42015-01-30 17:27:36 -0800830 switch runtime.GOOS {
831 case "linux":
832 return "linux-x86"
833 case "darwin":
834 return "darwin-x86"
835 default:
836 panic("Unknown GOOS")
837 }
838}
839
840// GoRoot returns the path to the root directory of the Go toolchain.
Colin Cross1332b002015-04-07 17:11:30 -0700841func (c *config) GoRoot() string {
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200842 return fmt.Sprintf("prebuilts/go/%s", c.PrebuiltOS())
Colin Cross3f40fa42015-01-30 17:27:36 -0800843}
844
Jingwen Chenc711fec2020-11-22 23:52:50 -0500845// PrebuiltBuildTool returns the path to a tool in the prebuilts directory containing
846// checked-in tools, like Kati, Ninja or Toybox, for the current host OS.
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700847func (c *config) PrebuiltBuildTool(ctx PathContext, tool string) Path {
848 return PathForSource(ctx, "prebuilts/build-tools", c.PrebuiltOS(), "bin", tool)
849}
850
Jingwen Chenc711fec2020-11-22 23:52:50 -0500851// CpPreserveSymlinksFlags returns the host-specific flag for the cp(1) command
852// to preserve symlinks.
Colin Cross1332b002015-04-07 17:11:30 -0700853func (c *config) CpPreserveSymlinksFlags() string {
Colin Cross485e5722015-08-27 13:28:01 -0700854 switch runtime.GOOS {
Colin Cross3f40fa42015-01-30 17:27:36 -0800855 case "darwin":
856 return "-R"
857 case "linux":
858 return "-d"
859 default:
860 return ""
861 }
862}
Colin Cross68f55102015-03-25 14:43:57 -0700863
Colin Cross1332b002015-04-07 17:11:30 -0700864func (c *config) Getenv(key string) string {
Colin Cross68f55102015-03-25 14:43:57 -0700865 var val string
866 var exists bool
Colin Crossc1e86a32015-04-15 12:33:28 -0700867 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800868 defer c.envLock.Unlock()
869 if c.envDeps == nil {
870 c.envDeps = make(map[string]string)
871 }
Colin Cross68f55102015-03-25 14:43:57 -0700872 if val, exists = c.envDeps[key]; !exists {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700873 if c.envFrozen {
874 panic("Cannot access new environment variables after envdeps are frozen")
875 }
Colin Cross6ccbc912017-10-10 23:07:38 -0700876 val, _ = c.env[key]
Colin Cross68f55102015-03-25 14:43:57 -0700877 c.envDeps[key] = val
878 }
879 return val
880}
881
Colin Cross99d7c232016-11-23 16:52:04 -0800882func (c *config) GetenvWithDefault(key string, defaultValue string) string {
883 ret := c.Getenv(key)
884 if ret == "" {
885 return defaultValue
886 }
887 return ret
888}
889
890func (c *config) IsEnvTrue(key string) bool {
891 value := c.Getenv(key)
892 return value == "1" || value == "y" || value == "yes" || value == "on" || value == "true"
893}
894
895func (c *config) IsEnvFalse(key string) bool {
896 value := c.Getenv(key)
897 return value == "0" || value == "n" || value == "no" || value == "off" || value == "false"
898}
899
Jingwen Chenc711fec2020-11-22 23:52:50 -0500900// EnvDeps returns the environment variables this build depends on. The first
901// call to this function blocks future reads from the environment.
Colin Cross1332b002015-04-07 17:11:30 -0700902func (c *config) EnvDeps() map[string]string {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700903 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800904 defer c.envLock.Unlock()
Dan Willemsene7680ba2015-09-11 17:06:19 -0700905 c.envFrozen = true
Colin Cross68f55102015-03-25 14:43:57 -0700906 return c.envDeps
907}
Colin Cross35cec122015-04-02 14:37:16 -0700908
Jingwen Chencda22c92020-11-23 00:22:30 -0500909func (c *config) KatiEnabled() bool {
910 return c.katiEnabled
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800911}
912
Cole Faust11edf552023-10-13 11:32:14 -0700913func (c *config) ProductVariables() ProductVariables {
914 return c.productVariables
915}
916
Nan Zhang581fd212018-01-10 16:06:12 -0800917func (c *config) BuildId() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800918 return String(c.productVariables.BuildId)
Nan Zhang581fd212018-01-10 16:06:12 -0800919}
920
Jingwen Chenc711fec2020-11-22 23:52:50 -0500921// BuildNumberFile returns the path to a text file containing metadata
922// representing the current build's number.
923//
924// Rules that want to reference the build number should read from this file
925// without depending on it. They will run whenever their other dependencies
926// require them to run and get the current build number. This ensures they don't
927// rebuild on every incremental build when the build number changes.
Colin Cross2a2e0db2020-02-21 16:55:46 -0800928func (c *config) BuildNumberFile(ctx PathContext) Path {
929 return PathForOutput(ctx, String(c.productVariables.BuildNumberFile))
Nan Zhang581fd212018-01-10 16:06:12 -0800930}
931
Jingwen Chenc711fec2020-11-22 23:52:50 -0500932// DeviceName returns the name of the current device target.
Colin Cross35cec122015-04-02 14:37:16 -0700933// TODO: take an AndroidModuleContext to select the device name for multi-device builds
Colin Cross1332b002015-04-07 17:11:30 -0700934func (c *config) DeviceName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800935 return *c.productVariables.DeviceName
Colin Cross35cec122015-04-02 14:37:16 -0700936}
937
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000938// DeviceProduct returns the current product target. There could be multiple of
939// these per device type.
940//
Chris Parsonsef615e52022-08-18 22:04:11 -0400941// NOTE: Do not base conditional logic on this value. It may break product inheritance.
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000942func (c *config) DeviceProduct() string {
943 return *c.productVariables.DeviceProduct
944}
945
Cole Faustb85d1a12022-11-08 18:14:01 -0800946// HasDeviceProduct returns if the build has a product. A build will not
947// necessarily have a product when --skip-config is passed to soong, like it is
948// in prebuilts/build-tools/build-prebuilts.sh
949func (c *config) HasDeviceProduct() bool {
950 return c.productVariables.DeviceProduct != nil
951}
952
Anton Hansson53c88442019-03-18 15:53:16 +0000953func (c *config) DeviceResourceOverlays() []string {
954 return c.productVariables.DeviceResourceOverlays
955}
956
957func (c *config) ProductResourceOverlays() []string {
958 return c.productVariables.ProductResourceOverlays
Colin Cross30e076a2015-04-13 13:58:27 -0700959}
960
Colin Crossbfd347d2018-05-09 11:11:35 -0700961func (c *config) PlatformVersionName() string {
962 return String(c.productVariables.Platform_version_name)
963}
964
Dan Albert4f378d72020-07-23 17:32:15 -0700965func (c *config) PlatformSdkVersion() ApiLevel {
966 return uncheckedFinalApiLevel(*c.productVariables.Platform_sdk_version)
Colin Cross30e076a2015-04-13 13:58:27 -0700967}
968
Cole Faust37d27c42023-04-12 10:27:45 -0700969func (c *config) RawPlatformSdkVersion() *int {
970 return c.productVariables.Platform_sdk_version
971}
972
Mu-Le Lee5e047532022-07-27 02:32:03 +0000973func (c *config) PlatformSdkFinal() bool {
974 return Bool(c.productVariables.Platform_sdk_final)
975}
976
Colin Crossd09b0b62018-04-18 11:06:47 -0700977func (c *config) PlatformSdkCodename() string {
978 return String(c.productVariables.Platform_sdk_codename)
979}
980
Anton Hansson97d0bae2022-02-16 16:15:10 +0000981func (c *config) PlatformSdkExtensionVersion() int {
982 return *c.productVariables.Platform_sdk_extension_version
983}
984
985func (c *config) PlatformBaseSdkExtensionVersion() int {
986 return *c.productVariables.Platform_base_sdk_extension_version
987}
988
Colin Cross092c9da2019-04-02 22:56:43 -0700989func (c *config) PlatformSecurityPatch() string {
990 return String(c.productVariables.Platform_security_patch)
991}
992
993func (c *config) PlatformPreviewSdkVersion() string {
994 return String(c.productVariables.Platform_preview_sdk_version)
995}
996
997func (c *config) PlatformMinSupportedTargetSdkVersion() string {
998 return String(c.productVariables.Platform_min_supported_target_sdk_version)
999}
1000
1001func (c *config) PlatformBaseOS() string {
1002 return String(c.productVariables.Platform_base_os)
1003}
1004
Inseob Kim4f1f3d92022-04-25 18:23:58 +09001005func (c *config) PlatformVersionLastStable() string {
1006 return String(c.productVariables.Platform_version_last_stable)
1007}
1008
Jiyong Park37073842022-06-21 10:13:42 +09001009func (c *config) PlatformVersionKnownCodenames() string {
1010 return String(c.productVariables.Platform_version_known_codenames)
1011}
1012
Dan Albert1a246272020-07-06 14:49:35 -07001013func (c *config) MinSupportedSdkVersion() ApiLevel {
Dan Albert6bfb6bb2022-08-17 20:11:57 +00001014 return uncheckedFinalApiLevel(21)
Dan Albert1a246272020-07-06 14:49:35 -07001015}
1016
1017func (c *config) FinalApiLevels() []ApiLevel {
1018 var levels []ApiLevel
Dan Albert4f378d72020-07-23 17:32:15 -07001019 for i := 1; i <= c.PlatformSdkVersion().FinalOrFutureInt(); i++ {
Dan Albert1a246272020-07-06 14:49:35 -07001020 levels = append(levels, uncheckedFinalApiLevel(i))
1021 }
1022 return levels
1023}
1024
1025func (c *config) PreviewApiLevels() []ApiLevel {
1026 var levels []ApiLevel
Dan Albertf93ea132023-10-05 20:40:46 +00001027 i := 0
1028 for _, codename := range c.PlatformVersionActiveCodenames() {
1029 if codename == "REL" {
1030 continue
1031 }
1032
Dan Albert1a246272020-07-06 14:49:35 -07001033 levels = append(levels, ApiLevel{
1034 value: codename,
1035 number: i,
1036 isPreview: true,
1037 })
Dan Albertf93ea132023-10-05 20:40:46 +00001038 i++
Dan Albert1a246272020-07-06 14:49:35 -07001039 }
1040 return levels
1041}
1042
satayevcca4ab72021-11-30 12:33:55 +00001043func (c *config) LatestPreviewApiLevel() ApiLevel {
1044 level := NoneApiLevel
1045 for _, l := range c.PreviewApiLevels() {
1046 if l.GreaterThan(level) {
1047 level = l
1048 }
1049 }
1050 return level
1051}
1052
Dan Albert1a246272020-07-06 14:49:35 -07001053func (c *config) AllSupportedApiLevels() []ApiLevel {
1054 var levels []ApiLevel
1055 levels = append(levels, c.FinalApiLevels()...)
1056 return append(levels, c.PreviewApiLevels()...)
Dan Albertf5415d72017-08-17 16:19:59 -07001057}
1058
Jingwen Chenc711fec2020-11-22 23:52:50 -05001059// DefaultAppTargetSdk returns the API level that platform apps are targeting.
1060// This converts a codename to the exact ApiLevel it represents.
Dan Albert4f378d72020-07-23 17:32:15 -07001061func (c *config) DefaultAppTargetSdk(ctx EarlyModuleContext) ApiLevel {
Alixfb7f7b92023-03-02 19:35:02 +00001062 // This logic is replicated in starlark, if changing logic here update starlark code too
1063 // https://cs.android.com/android/platform/superproject/+/master:build/bazel/rules/common/api.bzl;l=72;drc=231c7e8c8038fd478a79eb68aa5b9f5c64e0e061
Colin Crossd09b0b62018-04-18 11:06:47 -07001064 if Bool(c.productVariables.Platform_sdk_final) {
1065 return c.PlatformSdkVersion()
Colin Crossd09b0b62018-04-18 11:06:47 -07001066 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001067 codename := c.PlatformSdkCodename()
Jiyong Park3a00e3d2023-03-27 17:39:48 +09001068 hostOnlyBuild := c.productVariables.DeviceArch == nil
Jingwen Chenc711fec2020-11-22 23:52:50 -05001069 if codename == "" {
Jiyong Park3a00e3d2023-03-27 17:39:48 +09001070 // There are some host-only builds (those are invoked by build-prebuilts.sh) which
1071 // don't set platform sdk codename. Platform sdk codename makes sense only when we
1072 // are building the platform. So we don't enforce the below panic for the host-only
1073 // builds.
1074 if hostOnlyBuild {
1075 return NoneApiLevel
1076 }
1077 panic("Platform_sdk_codename must be set")
Jingwen Chenc711fec2020-11-22 23:52:50 -05001078 }
1079 if codename == "REL" {
1080 panic("Platform_sdk_codename should not be REL when Platform_sdk_final is true")
1081 }
1082 return ApiLevelOrPanic(ctx, codename)
Colin Crossd09b0b62018-04-18 11:06:47 -07001083}
1084
Colin Cross3bc7ffa2017-11-22 16:19:37 -08001085func (c *config) AppsDefaultVersionName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001086 return String(c.productVariables.AppsDefaultVersionName)
Colin Cross3bc7ffa2017-11-22 16:19:37 -08001087}
1088
Dan Albert31384de2017-07-28 12:39:46 -07001089// Codenames that are active in the current lunch target.
1090func (c *config) PlatformVersionActiveCodenames() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001091 return c.productVariables.Platform_version_active_codenames
Dan Albert31384de2017-07-28 12:39:46 -07001092}
1093
Dan Albert8c7a9942023-03-27 20:34:01 +00001094// All unreleased codenames.
1095func (c *config) PlatformVersionAllPreviewCodenames() []string {
1096 return c.productVariables.Platform_version_all_preview_codenames
1097}
1098
Colin Crossface4e42017-10-30 17:32:15 -07001099func (c *config) ProductAAPTConfig() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001100 return c.productVariables.AAPTConfig
Colin Cross30e076a2015-04-13 13:58:27 -07001101}
1102
Colin Crossface4e42017-10-30 17:32:15 -07001103func (c *config) ProductAAPTPreferredConfig() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001104 return String(c.productVariables.AAPTPreferredConfig)
Colin Cross30e076a2015-04-13 13:58:27 -07001105}
1106
Colin Crossface4e42017-10-30 17:32:15 -07001107func (c *config) ProductAAPTCharacteristics() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001108 return String(c.productVariables.AAPTCharacteristics)
Colin Crossface4e42017-10-30 17:32:15 -07001109}
1110
1111func (c *config) ProductAAPTPrebuiltDPI() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001112 return c.productVariables.AAPTPrebuiltDPI
Colin Cross30e076a2015-04-13 13:58:27 -07001113}
1114
Dan Willemsen34cc69e2015-09-23 15:26:20 -07001115func (c *config) DefaultAppCertificateDir(ctx PathContext) SourcePath {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001116 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -08001117 if defaultCert != "" {
1118 return PathForSource(ctx, filepath.Dir(defaultCert))
Colin Cross61ae0b72017-12-01 17:16:02 -08001119 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001120 return PathForSource(ctx, "build/make/target/product/security")
Colin Cross30e076a2015-04-13 13:58:27 -07001121}
1122
Colin Crosse1731a52017-12-14 11:22:55 -08001123func (c *config) DefaultAppCertificate(ctx PathContext) (pem, key SourcePath) {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001124 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -08001125 if defaultCert != "" {
Colin Crosse1731a52017-12-14 11:22:55 -08001126 return PathForSource(ctx, defaultCert+".x509.pem"), PathForSource(ctx, defaultCert+".pk8")
Colin Cross61ae0b72017-12-01 17:16:02 -08001127 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001128 defaultDir := c.DefaultAppCertificateDir(ctx)
1129 return defaultDir.Join(ctx, "testkey.x509.pem"), defaultDir.Join(ctx, "testkey.pk8")
Colin Cross30e076a2015-04-13 13:58:27 -07001130}
Colin Cross6ff51382015-12-17 16:39:19 -08001131
Jiyong Park9335a262018-12-24 11:31:58 +09001132func (c *config) ApexKeyDir(ctx ModuleContext) SourcePath {
1133 // TODO(b/121224311): define another variable such as TARGET_APEX_KEY_OVERRIDE
1134 defaultCert := String(c.productVariables.DefaultAppCertificate)
Dan Willemsen412160e2019-04-09 21:36:26 -07001135 if defaultCert == "" || filepath.Dir(defaultCert) == "build/make/target/product/security" {
Jiyong Park9335a262018-12-24 11:31:58 +09001136 // When defaultCert is unset or is set to the testkeys path, use the APEX keys
1137 // that is under the module dir
Colin Cross07e51612019-03-05 12:46:40 -08001138 return pathForModuleSrc(ctx)
Jiyong Park9335a262018-12-24 11:31:58 +09001139 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001140 // If not, APEX keys are under the specified directory
1141 return PathForSource(ctx, filepath.Dir(defaultCert))
Jiyong Park9335a262018-12-24 11:31:58 +09001142}
1143
Inseob Kim80fa7982022-08-12 21:36:25 +09001144// Certificate for the NetworkStack sepolicy context
1145func (c *config) MainlineSepolicyDevCertificatesDir(ctx ModuleContext) SourcePath {
1146 cert := String(c.productVariables.MainlineSepolicyDevCertificates)
1147 if cert != "" {
1148 return PathForSource(ctx, cert)
1149 }
1150 return c.DefaultAppCertificateDir(ctx)
1151}
1152
Jingwen Chenc711fec2020-11-22 23:52:50 -05001153// AllowMissingDependencies configures Blueprint/Soong to not fail when modules
1154// are configured to depend on non-existent modules. Note that this does not
1155// affect missing input dependencies at the Ninja level.
Colin Cross6ff51382015-12-17 16:39:19 -08001156func (c *config) AllowMissingDependencies() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001157 return Bool(c.productVariables.Allow_missing_dependencies)
Colin Cross6ff51382015-12-17 16:39:19 -08001158}
Dan Willemsen322acaf2016-01-12 23:07:05 -08001159
Jeongik Cha816a23a2020-07-08 01:09:23 +09001160// Returns true if a full platform source tree cannot be assumed.
Colin Crossfc3674a2017-09-18 17:41:52 -07001161func (c *config) UnbundledBuild() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001162 return Bool(c.productVariables.Unbundled_build)
Colin Crossfc3674a2017-09-18 17:41:52 -07001163}
1164
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +01001165// Returns true if building apps that aren't bundled with the platform.
1166// UnbundledBuild() is always true when this is true.
1167func (c *config) UnbundledBuildApps() bool {
Cole Faust701ca252021-11-23 19:02:08 -08001168 return len(c.productVariables.Unbundled_build_apps) > 0
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +01001169}
1170
Jeongik Cha4b073cd2021-06-08 11:35:00 +09001171// Returns true if building image that aren't bundled with the platform.
1172// UnbundledBuild() is always true when this is true.
1173func (c *config) UnbundledBuildImage() bool {
1174 return Bool(c.productVariables.Unbundled_build_image)
1175}
1176
Jeongik Cha816a23a2020-07-08 01:09:23 +09001177// Returns true if building modules against prebuilt SDKs.
1178func (c *config) AlwaysUsePrebuiltSdks() bool {
1179 return Bool(c.productVariables.Always_use_prebuilt_sdks)
Colin Cross1f367bf2018-12-18 22:46:24 -08001180}
1181
Colin Cross126a25c2017-10-31 13:55:34 -07001182func (c *config) MinimizeJavaDebugInfo() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001183 return Bool(c.productVariables.MinimizeJavaDebugInfo) && !Bool(c.productVariables.Eng)
Colin Cross126a25c2017-10-31 13:55:34 -07001184}
1185
Colin Crossed064c02018-09-05 16:28:13 -07001186func (c *config) Debuggable() bool {
1187 return Bool(c.productVariables.Debuggable)
1188}
1189
Jaewoong Jung1d6eb682018-11-29 15:08:44 -08001190func (c *config) Eng() bool {
1191 return Bool(c.productVariables.Eng)
1192}
1193
Colin Crossc53c37f2021-12-08 15:42:22 -08001194// DevicePrimaryArchType returns the ArchType for the first configured device architecture, or
1195// Common if there are no device architectures.
Jiyong Park8d52f862018-07-07 18:02:07 +09001196func (c *config) DevicePrimaryArchType() ArchType {
Colin Crossc53c37f2021-12-08 15:42:22 -08001197 if androidTargets := c.Targets[Android]; len(androidTargets) > 0 {
1198 return androidTargets[0].Arch.ArchType
1199 }
1200 return Common
Jiyong Park8d52f862018-07-07 18:02:07 +09001201}
1202
Colin Cross16b23492016-01-06 14:41:07 -08001203func (c *config) SanitizeHost() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001204 return append([]string(nil), c.productVariables.SanitizeHost...)
Colin Cross16b23492016-01-06 14:41:07 -08001205}
1206
1207func (c *config) SanitizeDevice() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001208 return append([]string(nil), c.productVariables.SanitizeDevice...)
Colin Cross23ae82a2016-11-02 14:34:39 -07001209}
1210
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -07001211func (c *config) SanitizeDeviceDiag() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001212 return append([]string(nil), c.productVariables.SanitizeDeviceDiag...)
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -07001213}
1214
Colin Cross23ae82a2016-11-02 14:34:39 -07001215func (c *config) SanitizeDeviceArch() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001216 return append([]string(nil), c.productVariables.SanitizeDeviceArch...)
Colin Cross16b23492016-01-06 14:41:07 -08001217}
Colin Crossa1ad8d12016-06-01 17:09:44 -07001218
Vishwath Mohan1b017a72017-01-19 13:54:55 -08001219func (c *config) EnableCFI() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001220 if c.productVariables.EnableCFI == nil {
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -08001221 return true
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -08001222 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001223 return *c.productVariables.EnableCFI
Vishwath Mohan1b017a72017-01-19 13:54:55 -08001224}
1225
Kostya Kortchinskyd5275c82019-02-01 08:42:56 -08001226func (c *config) DisableScudo() bool {
1227 return Bool(c.productVariables.DisableScudo)
1228}
1229
Colin Crossa1ad8d12016-06-01 17:09:44 -07001230func (c *config) Android64() bool {
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001231 for _, t := range c.Targets[Android] {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001232 if t.Arch.ArchType.Multilib == "lib64" {
1233 return true
1234 }
1235 }
1236
1237 return false
1238}
Colin Cross9272ade2016-08-17 15:24:12 -07001239
Colin Cross9d45bb72016-08-29 16:14:13 -07001240func (c *config) UseGoma() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001241 return Bool(c.productVariables.UseGoma)
Colin Cross9d45bb72016-08-29 16:14:13 -07001242}
1243
Ramy Medhatbbf25672019-07-17 12:30:04 +00001244func (c *config) UseRBE() bool {
1245 return Bool(c.productVariables.UseRBE)
1246}
1247
Ramy Medhat8ea054a2020-01-27 14:19:44 -05001248func (c *config) UseRBEJAVAC() bool {
1249 return Bool(c.productVariables.UseRBEJAVAC)
1250}
1251
1252func (c *config) UseRBER8() bool {
1253 return Bool(c.productVariables.UseRBER8)
1254}
1255
1256func (c *config) UseRBED8() bool {
1257 return Bool(c.productVariables.UseRBED8)
1258}
1259
Colin Cross8b8bec32019-11-15 13:18:43 -08001260func (c *config) UseRemoteBuild() bool {
1261 return c.UseGoma() || c.UseRBE()
1262}
1263
Colin Cross66548102018-06-19 22:47:35 -07001264func (c *config) RunErrorProne() bool {
1265 return c.IsEnvTrue("RUN_ERROR_PRONE")
1266}
1267
Jingwen Chenc711fec2020-11-22 23:52:50 -05001268// XrefCorpusName returns the Kythe cross-reference corpus name.
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001269func (c *config) XrefCorpusName() string {
1270 return c.Getenv("XREF_CORPUS")
1271}
1272
Jingwen Chenc711fec2020-11-22 23:52:50 -05001273// XrefCuEncoding returns the compilation unit encoding to use for Kythe code
1274// xrefs. Can be 'json' (default), 'proto' or 'all'.
Sasha Smundak6c2d4f92020-01-09 17:34:23 -08001275func (c *config) XrefCuEncoding() string {
1276 if enc := c.Getenv("KYTHE_KZIP_ENCODING"); enc != "" {
1277 return enc
1278 }
1279 return "json"
1280}
1281
Sasha Smundakb0addaf2021-02-16 10:39:40 -08001282// XrefCuJavaSourceMax returns the maximum number of the Java source files
1283// in a single compilation unit
1284const xrefJavaSourceFileMaxDefault = "1000"
1285
1286func (c Config) XrefCuJavaSourceMax() string {
1287 v := c.Getenv("KYTHE_JAVA_SOURCE_BATCH_SIZE")
1288 if v == "" {
1289 return xrefJavaSourceFileMaxDefault
1290 }
1291 if _, err := strconv.ParseUint(v, 0, 0); err != nil {
1292 fmt.Fprintf(os.Stderr,
1293 "bad KYTHE_JAVA_SOURCE_BATCH_SIZE value: %s, will use %s",
1294 err, xrefJavaSourceFileMaxDefault)
1295 return xrefJavaSourceFileMaxDefault
1296 }
1297 return v
1298
1299}
1300
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001301func (c *config) EmitXrefRules() bool {
1302 return c.XrefCorpusName() != ""
1303}
1304
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001305func (c *config) ClangTidy() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001306 return Bool(c.productVariables.ClangTidy)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001307}
1308
1309func (c *config) TidyChecks() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001310 if c.productVariables.TidyChecks == nil {
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001311 return ""
1312 }
Dan Willemsen45133ac2018-03-09 21:22:06 -08001313 return *c.productVariables.TidyChecks
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001314}
1315
Colin Cross0f4e0d62016-07-27 10:56:55 -07001316func (c *config) LibartImgHostBaseAddress() string {
1317 return "0x60000000"
1318}
1319
1320func (c *config) LibartImgDeviceBaseAddress() string {
Elliott Hughesda3a0712020-03-06 16:55:28 -08001321 return "0x70000000"
Colin Cross0f4e0d62016-07-27 10:56:55 -07001322}
1323
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001324func (c *config) ArtUseReadBarrier() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001325 return Bool(c.productVariables.ArtUseReadBarrier)
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001326}
1327
Jingwen Chenc711fec2020-11-22 23:52:50 -05001328// Enforce Runtime Resource Overlays for a module. RROs supersede static RROs,
1329// but some modules still depend on it.
1330//
1331// More info: https://source.android.com/devices/architecture/rros
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001332func (c *config) EnforceRROForModule(name string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001333 enforceList := c.productVariables.EnforceRROTargets
Jeongik Chacee5ba92021-02-19 12:11:51 +09001334
Roland Levillainf6cc2612020-07-09 16:58:14 +01001335 if len(enforceList) > 0 {
Yo Chiang4ebd06a2019-10-01 13:13:41 +08001336 if InList("*", enforceList) {
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001337 return true
1338 }
Colin Crossa74ca042019-01-31 14:31:51 -08001339 return InList(name, enforceList)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001340 }
1341 return false
1342}
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001343func (c *config) EnforceRROExcludedOverlay(path string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001344 excluded := c.productVariables.EnforceRROExcludedOverlays
Roland Levillainf6cc2612020-07-09 16:58:14 +01001345 if len(excluded) > 0 {
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001346 return HasAnyPrefix(path, excluded)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001347 }
1348 return false
1349}
1350
1351func (c *config) ExportedNamespaces() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001352 return append([]string(nil), c.productVariables.NamespacesToExport...)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001353}
1354
Sam Delmerico98a73292023-02-21 11:50:29 -05001355func (c *config) SourceRootDirs() []string {
1356 return c.productVariables.SourceRootDirs
1357}
1358
Spandan Dasc5763832022-11-08 18:42:16 +00001359func (c *config) IncludeTags() []string {
1360 return c.productVariables.IncludeTags
1361}
1362
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001363func (c *config) HostStaticBinaries() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001364 return Bool(c.productVariables.HostStaticBinaries)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001365}
1366
Colin Cross5a0dcd52018-10-05 14:20:06 -07001367func (c *config) UncompressPrivAppDex() bool {
1368 return Bool(c.productVariables.UncompressPrivAppDex)
1369}
1370
1371func (c *config) ModulesLoadedByPrivilegedModules() []string {
1372 return c.productVariables.ModulesLoadedByPrivilegedModules
1373}
1374
Jingwen Chenc711fec2020-11-22 23:52:50 -05001375// DexpreoptGlobalConfigPath returns the path to the dexpreopt.config file in
1376// the output directory, if it was created during the product configuration
1377// phase by Kati.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001378func (c *config) DexpreoptGlobalConfigPath(ctx PathContext) OptionalPath {
Colin Cross988414c2020-01-11 01:11:46 +00001379 if c.productVariables.DexpreoptGlobalConfig == nil {
Jingwen Chenebb0b572020-11-02 00:24:57 -05001380 return OptionalPathForPath(nil)
1381 }
1382 return OptionalPathForPath(
1383 pathForBuildToolDep(ctx, *c.productVariables.DexpreoptGlobalConfig))
1384}
1385
Jingwen Chenc711fec2020-11-22 23:52:50 -05001386// DexpreoptGlobalConfig returns the raw byte contents of the dexpreopt global
1387// configuration. Since the configuration file was created by Kati during
1388// product configuration (externally of soong_build), it's not tracked, so we
1389// also manually add a Ninja file dependency on the configuration file to the
1390// rule that creates the main build.ninja file. This ensures that build.ninja is
1391// regenerated correctly if dexpreopt.config changes.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001392func (c *config) DexpreoptGlobalConfig(ctx PathContext) ([]byte, error) {
1393 path := c.DexpreoptGlobalConfigPath(ctx)
1394 if !path.Valid() {
Colin Cross988414c2020-01-11 01:11:46 +00001395 return nil, nil
1396 }
Jingwen Chenebb0b572020-11-02 00:24:57 -05001397 ctx.AddNinjaFileDeps(path.String())
Sasha Smundakaf5ca922022-12-12 21:23:34 -08001398 return os.ReadFile(absolutePath(path.String()))
Colin Cross43f08db2018-11-12 10:13:39 -08001399}
1400
Inseob Kim7b85eeb2021-03-23 20:52:24 +09001401func (c *deviceConfig) WithDexpreopt() bool {
1402 return c.config.productVariables.WithDexpreopt
1403}
1404
Colin Cross662d6142022-11-03 20:38:01 -07001405func (c *config) FrameworksBaseDirExists(ctx PathGlobContext) bool {
Colin Cross5a756a62021-03-16 16:34:46 -07001406 return ExistentPathForSource(ctx, "frameworks", "base", "Android.bp").Valid()
David Brazdil91b4e3e2019-01-23 21:04:05 +00001407}
1408
Inseob Kimae553032019-05-14 18:52:49 +09001409func (c *config) VndkSnapshotBuildArtifacts() bool {
1410 return Bool(c.productVariables.VndkSnapshotBuildArtifacts)
1411}
1412
Colin Cross3b19f5d2019-09-17 14:45:31 -07001413func (c *config) HasMultilibConflict(arch ArchType) bool {
1414 return c.multilibConflicts[arch]
1415}
1416
Sasha Smundakaf5ca922022-12-12 21:23:34 -08001417func (c *config) PrebuiltHiddenApiDir(_ PathContext) string {
Bill Peckhambae47492021-01-08 09:34:44 -08001418 return String(c.productVariables.PrebuiltHiddenApiDir)
1419}
1420
MarkDacekd06db5d2022-11-29 00:47:59 +00001421func (c *config) BazelModulesForceEnabledByFlag() map[string]struct{} {
1422 return c.bazelForceEnabledModules
1423}
1424
Kiyoung Kime623c582023-07-06 16:43:44 +09001425func (c *config) IsVndkDeprecated() bool {
1426 return !Bool(c.productVariables.KeepVndk)
1427}
1428
Justin Yun41cbb5e2023-11-29 17:58:16 +09001429func (c *config) VendorApiLevel() string {
1430 return String(c.productVariables.VendorApiLevel)
1431}
1432
Colin Cross9272ade2016-08-17 15:24:12 -07001433func (c *deviceConfig) Arches() []Arch {
1434 var arches []Arch
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001435 for _, target := range c.config.Targets[Android] {
Colin Cross9272ade2016-08-17 15:24:12 -07001436 arches = append(arches, target.Arch)
1437 }
1438 return arches
1439}
Dan Willemsend2ede872016-11-18 14:54:24 -08001440
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001441func (c *deviceConfig) BinderBitness() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001442 is32BitBinder := c.config.productVariables.Binder32bit
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001443 if is32BitBinder != nil && *is32BitBinder {
1444 return "32"
1445 }
1446 return "64"
1447}
1448
Dan Willemsen4353bc42016-12-05 17:16:02 -08001449func (c *deviceConfig) VendorPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001450 if c.config.productVariables.VendorPath != nil {
1451 return *c.config.productVariables.VendorPath
Dan Willemsen4353bc42016-12-05 17:16:02 -08001452 }
1453 return "vendor"
1454}
1455
Justin Yun71549282017-11-17 12:10:28 +09001456func (c *deviceConfig) VndkVersion() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001457 return String(c.config.productVariables.DeviceVndkVersion)
Justin Yun71549282017-11-17 12:10:28 +09001458}
1459
Jose Galmes6f843bc2020-12-11 13:36:29 -08001460func (c *deviceConfig) RecoverySnapshotVersion() string {
1461 return String(c.config.productVariables.RecoverySnapshotVersion)
1462}
1463
Jeongik Cha219141c2020-08-06 23:00:37 +09001464func (c *deviceConfig) CurrentApiLevelForVendorModules() string {
1465 return StringDefault(c.config.productVariables.DeviceCurrentApiLevelForVendorModules, "current")
1466}
1467
Justin Yun8fe12122017-12-07 17:18:15 +09001468func (c *deviceConfig) PlatformVndkVersion() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001469 return String(c.config.productVariables.Platform_vndk_version)
Justin Yun8fe12122017-12-07 17:18:15 +09001470}
1471
Justin Yun71549282017-11-17 12:10:28 +09001472func (c *deviceConfig) ExtraVndkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001473 return c.config.productVariables.ExtraVndkVersions
Dan Willemsend2ede872016-11-18 14:54:24 -08001474}
Jack He8cc71432016-12-08 15:45:07 -08001475
Vic Yangefd249e2018-11-12 20:19:56 -08001476func (c *deviceConfig) VndkUseCoreVariant() bool {
Kiyoung Kim03b6cba2023-10-06 14:12:43 +09001477 return Bool(c.config.productVariables.VndkUseCoreVariant) && Bool(c.config.productVariables.KeepVndk)
Vic Yangefd249e2018-11-12 20:19:56 -08001478}
1479
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001480func (c *deviceConfig) SystemSdkVersions() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001481 return c.config.productVariables.DeviceSystemSdkVersions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001482}
1483
1484func (c *deviceConfig) PlatformSystemSdkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001485 return c.config.productVariables.Platform_systemsdk_versions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001486}
1487
Jiyong Park2db76922017-11-08 16:03:48 +09001488func (c *deviceConfig) OdmPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001489 if c.config.productVariables.OdmPath != nil {
1490 return *c.config.productVariables.OdmPath
Jiyong Park2db76922017-11-08 16:03:48 +09001491 }
1492 return "odm"
1493}
1494
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001495func (c *deviceConfig) ProductPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001496 if c.config.productVariables.ProductPath != nil {
1497 return *c.config.productVariables.ProductPath
Jiyong Park2db76922017-11-08 16:03:48 +09001498 }
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001499 return "product"
Jiyong Park2db76922017-11-08 16:03:48 +09001500}
1501
Justin Yund5f6c822019-06-25 16:47:17 +09001502func (c *deviceConfig) SystemExtPath() string {
1503 if c.config.productVariables.SystemExtPath != nil {
1504 return *c.config.productVariables.SystemExtPath
Dario Frenifd05a742018-05-29 13:28:54 +01001505 }
Justin Yund5f6c822019-06-25 16:47:17 +09001506 return "system_ext"
Dario Frenifd05a742018-05-29 13:28:54 +01001507}
1508
Jack He8cc71432016-12-08 15:45:07 -08001509func (c *deviceConfig) BtConfigIncludeDir() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001510 return String(c.config.productVariables.BtConfigIncludeDir)
Jack He8cc71432016-12-08 15:45:07 -08001511}
Dan Willemsen581341d2017-02-09 16:16:31 -08001512
Jiyong Parkd773eb32017-07-03 13:18:12 +09001513func (c *deviceConfig) DeviceKernelHeaderDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001514 return c.config.productVariables.DeviceKernelHeaders
Jiyong Parkd773eb32017-07-03 13:18:12 +09001515}
1516
Roland Levillainada12702020-06-09 13:07:36 +01001517// JavaCoverageEnabledForPath returns whether Java code coverage is enabled for
1518// path. Coverage is enabled by default when the product variable
1519// JavaCoveragePaths is empty. If JavaCoveragePaths is not empty, coverage is
1520// enabled for any path which is part of this variable (and not part of the
1521// JavaCoverageExcludePaths product variable). Value "*" in JavaCoveragePaths
1522// represents any path.
1523func (c *deviceConfig) JavaCoverageEnabledForPath(path string) bool {
1524 coverage := false
Chris Gross2f748692020-06-24 20:36:59 +00001525 if len(c.config.productVariables.JavaCoveragePaths) == 0 ||
Roland Levillainada12702020-06-09 13:07:36 +01001526 InList("*", c.config.productVariables.JavaCoveragePaths) ||
1527 HasAnyPrefix(path, c.config.productVariables.JavaCoveragePaths) {
1528 coverage = true
1529 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001530 if coverage && len(c.config.productVariables.JavaCoverageExcludePaths) > 0 {
Roland Levillainada12702020-06-09 13:07:36 +01001531 if HasAnyPrefix(path, c.config.productVariables.JavaCoverageExcludePaths) {
1532 coverage = false
1533 }
1534 }
1535 return coverage
1536}
1537
Colin Cross1a6acd42020-06-16 17:51:46 -07001538// Returns true if gcov or clang coverage is enabled.
Dan Willemsen581341d2017-02-09 16:16:31 -08001539func (c *deviceConfig) NativeCoverageEnabled() bool {
Colin Cross1a6acd42020-06-16 17:51:46 -07001540 return Bool(c.config.productVariables.GcovCoverage) ||
1541 Bool(c.config.productVariables.ClangCoverage)
Dan Willemsen581341d2017-02-09 16:16:31 -08001542}
1543
Oliver Nguyen1382ab62019-12-06 15:22:41 -08001544func (c *deviceConfig) ClangCoverageEnabled() bool {
1545 return Bool(c.config.productVariables.ClangCoverage)
1546}
1547
Pirama Arumuga Nainarb37ae582022-01-26 22:14:32 -08001548func (c *deviceConfig) ClangCoverageContinuousMode() bool {
1549 return Bool(c.config.productVariables.ClangCoverageContinuousMode)
1550}
1551
Colin Cross1a6acd42020-06-16 17:51:46 -07001552func (c *deviceConfig) GcovCoverageEnabled() bool {
1553 return Bool(c.config.productVariables.GcovCoverage)
1554}
1555
Roland Levillain4f5297b2020-06-09 12:44:06 +01001556// NativeCoverageEnabledForPath returns whether (GCOV- or Clang-based) native
1557// code coverage is enabled for path. By default, coverage is not enabled for a
1558// given path unless it is part of the NativeCoveragePaths product variable (and
1559// not part of the NativeCoverageExcludePaths product variable). Value "*" in
1560// NativeCoveragePaths represents any path.
1561func (c *deviceConfig) NativeCoverageEnabledForPath(path string) bool {
Ryan Campbell469a18a2017-02-27 09:01:54 -08001562 coverage := false
Roland Levillainf6cc2612020-07-09 16:58:14 +01001563 if len(c.config.productVariables.NativeCoveragePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001564 if InList("*", c.config.productVariables.NativeCoveragePaths) || HasAnyPrefix(path, c.config.productVariables.NativeCoveragePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001565 coverage = true
Dan Willemsen581341d2017-02-09 16:16:31 -08001566 }
1567 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001568 if coverage && len(c.config.productVariables.NativeCoverageExcludePaths) > 0 {
Yi Kongfd07ed22023-02-16 17:42:27 +09001569 // Workaround coverage boot failure.
1570 // http://b/269981180
1571 if strings.HasPrefix(path, "external/protobuf") {
1572 coverage = false
1573 }
Roland Levillain4f5297b2020-06-09 12:44:06 +01001574 if HasAnyPrefix(path, c.config.productVariables.NativeCoverageExcludePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001575 coverage = false
Ryan Campbell469a18a2017-02-27 09:01:54 -08001576 }
1577 }
1578 return coverage
Dan Willemsen581341d2017-02-09 16:16:31 -08001579}
Ivan Lozano5f595532017-07-13 14:46:05 -07001580
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001581func (c *deviceConfig) PgoAdditionalProfileDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001582 return c.config.productVariables.PgoAdditionalProfileDirs
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001583}
1584
Vinh Tran44cb78c2023-03-09 22:07:19 -05001585// AfdoProfile returns fully qualified path associated to the given module name
1586func (c *deviceConfig) AfdoProfile(name string) (*string, error) {
1587 for _, afdoProfile := range c.config.productVariables.AfdoProfiles {
1588 split := strings.Split(afdoProfile, ":")
1589 if len(split) != 3 {
1590 return nil, fmt.Errorf("AFDO_PROFILES has invalid value: %s. "+
1591 "The expected format is <module>:<fully-qualified-path-to-fdo_profile>", afdoProfile)
1592 }
1593 if split[0] == name {
1594 return proptools.StringPtr(strings.Join([]string{split[1], split[2]}, ":")), nil
1595 }
1596 }
1597 return nil, nil
1598}
1599
Tri Vo35a51432018-03-25 20:00:00 -07001600func (c *deviceConfig) VendorSepolicyDirs() []string {
1601 return c.config.productVariables.BoardVendorSepolicyDirs
1602}
1603
1604func (c *deviceConfig) OdmSepolicyDirs() []string {
1605 return c.config.productVariables.BoardOdmSepolicyDirs
1606}
1607
Felixa20a8752020-05-17 18:28:35 +02001608func (c *deviceConfig) SystemExtPublicSepolicyDirs() []string {
1609 return c.config.productVariables.SystemExtPublicSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001610}
1611
Felixa20a8752020-05-17 18:28:35 +02001612func (c *deviceConfig) SystemExtPrivateSepolicyDirs() []string {
1613 return c.config.productVariables.SystemExtPrivateSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001614}
1615
Inseob Kim0866b002019-04-15 20:21:29 +09001616func (c *deviceConfig) SepolicyM4Defs() []string {
1617 return c.config.productVariables.BoardSepolicyM4Defs
1618}
1619
Jiyong Park7f67f482019-01-05 12:57:48 +09001620func (c *deviceConfig) OverrideManifestPackageNameFor(name string) (manifestName string, overridden bool) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001621 return findOverrideValue(c.config.productVariables.ManifestPackageNameOverrides, name,
1622 "invalid override rule %q in PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES should be <module_name>:<manifest_name>")
1623}
1624
1625func (c *deviceConfig) OverrideCertificateFor(name string) (certificatePath string, overridden bool) {
Jaewoong Jungacb6db32019-02-28 16:22:30 +00001626 return findOverrideValue(c.config.productVariables.CertificateOverrides, name,
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001627 "invalid override rule %q in PRODUCT_CERTIFICATE_OVERRIDES should be <module_name>:<certificate_module_name>")
1628}
1629
Jaewoong Jung9d22a912019-01-23 16:27:47 -08001630func (c *deviceConfig) OverridePackageNameFor(name string) string {
1631 newName, overridden := findOverrideValue(
1632 c.config.productVariables.PackageNameOverrides,
1633 name,
1634 "invalid override rule %q in PRODUCT_PACKAGE_NAME_OVERRIDES should be <module_name>:<package_name>")
1635 if overridden {
1636 return newName
1637 }
1638 return name
1639}
1640
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001641func findOverrideValue(overrides []string, name string, errorMsg string) (newValue string, overridden bool) {
Jiyong Park7f67f482019-01-05 12:57:48 +09001642 if overrides == nil || len(overrides) == 0 {
1643 return "", false
1644 }
1645 for _, o := range overrides {
1646 split := strings.Split(o, ":")
1647 if len(split) != 2 {
1648 // This shouldn't happen as this is first checked in make, but just in case.
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001649 panic(fmt.Errorf(errorMsg, o))
Jiyong Park7f67f482019-01-05 12:57:48 +09001650 }
1651 if matchPattern(split[0], name) {
1652 return substPattern(split[0], split[1], name), true
1653 }
1654 }
1655 return "", false
1656}
1657
Albert Martineefabcf2022-03-21 20:11:16 +00001658func (c *deviceConfig) ApexGlobalMinSdkVersionOverride() string {
1659 return String(c.config.productVariables.ApexGlobalMinSdkVersionOverride)
1660}
1661
Ivan Lozano5f595532017-07-13 14:46:05 -07001662func (c *config) IntegerOverflowDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001663 if len(c.productVariables.IntegerOverflowExcludePaths) == 0 {
Ivan Lozano5f595532017-07-13 14:46:05 -07001664 return false
1665 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001666 return HasAnyPrefix(path, c.productVariables.IntegerOverflowExcludePaths)
Ivan Lozano5f595532017-07-13 14:46:05 -07001667}
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001668
1669func (c *config) CFIDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001670 if len(c.productVariables.CFIExcludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001671 return false
1672 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001673 return HasAnyPrefix(path, c.productVariables.CFIExcludePaths)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001674}
1675
1676func (c *config) CFIEnabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001677 if len(c.productVariables.CFIIncludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001678 return false
1679 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001680 return HasAnyPrefix(path, c.productVariables.CFIIncludePaths) && !c.CFIDisabledForPath(path)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001681}
Colin Crosse15ddaf2017-12-04 11:24:31 -08001682
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001683func (c *config) MemtagHeapDisabledForPath(path string) bool {
1684 if len(c.productVariables.MemtagHeapExcludePaths) == 0 {
1685 return false
1686 }
1687 return HasAnyPrefix(path, c.productVariables.MemtagHeapExcludePaths)
1688}
1689
1690func (c *config) MemtagHeapAsyncEnabledForPath(path string) bool {
1691 if len(c.productVariables.MemtagHeapAsyncIncludePaths) == 0 {
1692 return false
1693 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001694 return HasAnyPrefix(path, c.productVariables.MemtagHeapAsyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001695}
1696
1697func (c *config) MemtagHeapSyncEnabledForPath(path string) bool {
1698 if len(c.productVariables.MemtagHeapSyncIncludePaths) == 0 {
1699 return false
1700 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001701 return HasAnyPrefix(path, c.productVariables.MemtagHeapSyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001702}
1703
Tomislav Novakf734f002023-08-22 10:51:44 -07001704func (c *config) HWASanDisabledForPath(path string) bool {
1705 if len(c.productVariables.HWASanExcludePaths) == 0 {
1706 return false
1707 }
1708 return HasAnyPrefix(path, c.productVariables.HWASanExcludePaths)
1709}
1710
Hang Lua98aab92023-03-17 13:17:22 +08001711func (c *config) HWASanEnabledForPath(path string) bool {
1712 if len(c.productVariables.HWASanIncludePaths) == 0 {
1713 return false
1714 }
Tomislav Novakf734f002023-08-22 10:51:44 -07001715 return HasAnyPrefix(path, c.productVariables.HWASanIncludePaths) && !c.HWASanDisabledForPath(path)
Hang Lua98aab92023-03-17 13:17:22 +08001716}
1717
Dan Willemsen0fe78662018-03-26 12:41:18 -07001718func (c *config) VendorConfig(name string) VendorConfig {
Colin Cross9d34f352019-11-22 16:03:51 -08001719 return soongconfig.Config(c.productVariables.VendorVars[name])
Dan Willemsen0fe78662018-03-26 12:41:18 -07001720}
1721
Colin Cross395f2cf2018-10-24 16:10:32 -07001722func (c *config) NdkAbis() bool {
1723 return Bool(c.productVariables.Ndk_abis)
1724}
1725
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001726func (c *config) AmlAbis() bool {
1727 return Bool(c.productVariables.Aml_abis)
1728}
1729
Jiyong Park4da07972021-01-05 21:01:11 +09001730func (c *config) ForceApexSymlinkOptimization() bool {
1731 return Bool(c.productVariables.ForceApexSymlinkOptimization)
1732}
1733
Sasha Smundakfe9a5b82022-07-27 14:51:45 -07001734func (c *config) ApexCompressionEnabled() bool {
1735 return Bool(c.productVariables.CompressedApex) && !c.UnbundledBuildApps()
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +00001736}
1737
Dennis Shene2ed70c2023-01-11 14:15:43 +00001738func (c *config) ApexTrimEnabled() bool {
1739 return Bool(c.productVariables.TrimmedApex)
1740}
1741
Jeongik Chac9464142019-01-07 12:07:27 +09001742func (c *config) EnforceSystemCertificate() bool {
1743 return Bool(c.productVariables.EnforceSystemCertificate)
1744}
1745
Colin Cross440e0d02020-06-11 11:32:11 -07001746func (c *config) EnforceSystemCertificateAllowList() []string {
1747 return c.productVariables.EnforceSystemCertificateAllowList
Jeongik Chac9464142019-01-07 12:07:27 +09001748}
1749
Jeongik Cha2cc570d2019-10-29 15:44:45 +09001750func (c *config) EnforceProductPartitionInterface() bool {
1751 return Bool(c.productVariables.EnforceProductPartitionInterface)
1752}
1753
JaeMan Parkff715562020-10-19 17:25:58 +09001754func (c *config) EnforceInterPartitionJavaSdkLibrary() bool {
1755 return Bool(c.productVariables.EnforceInterPartitionJavaSdkLibrary)
1756}
1757
1758func (c *config) InterPartitionJavaLibraryAllowList() []string {
1759 return c.productVariables.InterPartitionJavaLibraryAllowList
1760}
1761
Colin Crossf24a22a2019-01-31 14:12:44 -08001762func (c *config) ProductHiddenAPIStubs() []string {
1763 return c.productVariables.ProductHiddenAPIStubs
Colin Cross8faf8fc2019-01-16 15:15:52 -08001764}
1765
Colin Crossf24a22a2019-01-31 14:12:44 -08001766func (c *config) ProductHiddenAPIStubsSystem() []string {
1767 return c.productVariables.ProductHiddenAPIStubsSystem
Colin Cross8faf8fc2019-01-16 15:15:52 -08001768}
1769
Colin Crossf24a22a2019-01-31 14:12:44 -08001770func (c *config) ProductHiddenAPIStubsTest() []string {
1771 return c.productVariables.ProductHiddenAPIStubsTest
Colin Cross8faf8fc2019-01-16 15:15:52 -08001772}
Dan Willemsen71c74602019-04-10 12:27:35 -07001773
Dan Willemsen54879d12019-04-18 10:08:46 -07001774func (c *deviceConfig) TargetFSConfigGen() []string {
Dan Willemsen71c74602019-04-10 12:27:35 -07001775 return c.config.productVariables.TargetFSConfigGen
1776}
Inseob Kim0866b002019-04-15 20:21:29 +09001777
1778func (c *config) ProductPublicSepolicyDirs() []string {
1779 return c.productVariables.ProductPublicSepolicyDirs
1780}
1781
1782func (c *config) ProductPrivateSepolicyDirs() []string {
1783 return c.productVariables.ProductPrivateSepolicyDirs
1784}
1785
Inseob Kim5eb7ee92022-04-27 10:30:34 +09001786func (c *config) TargetMultitreeUpdateMeta() bool {
1787 return c.productVariables.MultitreeUpdateMeta
1788}
1789
Inseob Kim1f086e22019-05-09 13:29:15 +09001790func (c *deviceConfig) DeviceArch() string {
1791 return String(c.config.productVariables.DeviceArch)
1792}
1793
1794func (c *deviceConfig) DeviceArchVariant() string {
1795 return String(c.config.productVariables.DeviceArchVariant)
1796}
1797
1798func (c *deviceConfig) DeviceSecondaryArch() string {
1799 return String(c.config.productVariables.DeviceSecondaryArch)
1800}
1801
1802func (c *deviceConfig) DeviceSecondaryArchVariant() string {
1803 return String(c.config.productVariables.DeviceSecondaryArchVariant)
1804}
Yifan Hong82db7352020-01-21 16:12:26 -08001805
1806func (c *deviceConfig) BoardUsesRecoveryAsBoot() bool {
1807 return Bool(c.config.productVariables.BoardUsesRecoveryAsBoot)
1808}
Yifan Hong97365ee2020-07-29 09:51:57 -07001809
1810func (c *deviceConfig) BoardKernelBinaries() []string {
1811 return c.config.productVariables.BoardKernelBinaries
1812}
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001813
Yifan Hong42bef8d2020-08-05 14:36:09 -07001814func (c *deviceConfig) BoardKernelModuleInterfaceVersions() []string {
1815 return c.config.productVariables.BoardKernelModuleInterfaceVersions
1816}
1817
Yifan Hongdd8dacc2020-10-21 15:40:17 -07001818func (c *deviceConfig) BoardMoveRecoveryResourcesToVendorBoot() bool {
1819 return Bool(c.config.productVariables.BoardMoveRecoveryResourcesToVendorBoot)
1820}
1821
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001822func (c *deviceConfig) PlatformSepolicyVersion() string {
1823 return String(c.config.productVariables.PlatformSepolicyVersion)
1824}
1825
Inseob Kima10ef272021-09-15 03:04:53 +00001826func (c *deviceConfig) TotSepolicyVersion() string {
1827 return String(c.config.productVariables.TotSepolicyVersion)
1828}
1829
Inseob Kim843f6642022-01-07 09:11:23 +09001830func (c *deviceConfig) PlatformSepolicyCompatVersions() []string {
1831 return c.config.productVariables.PlatformSepolicyCompatVersions
1832}
1833
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001834func (c *deviceConfig) BoardSepolicyVers() string {
Inseob Kim0c4eec82021-03-22 22:33:40 +09001835 if ver := String(c.config.productVariables.BoardSepolicyVers); ver != "" {
1836 return ver
1837 }
1838 return c.PlatformSepolicyVersion()
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001839}
1840
Inseob Kim1a0afcc2022-02-14 23:10:51 +09001841func (c *deviceConfig) SystemExtSepolicyPrebuiltApiDir() string {
1842 return String(c.config.productVariables.SystemExtSepolicyPrebuiltApiDir)
1843}
1844
1845func (c *deviceConfig) ProductSepolicyPrebuiltApiDir() string {
1846 return String(c.config.productVariables.ProductSepolicyPrebuiltApiDir)
1847}
1848
1849func (c *deviceConfig) IsPartnerTrebleSepolicyTestEnabled() bool {
1850 return c.SystemExtSepolicyPrebuiltApiDir() != "" || c.ProductSepolicyPrebuiltApiDir() != ""
1851}
1852
Inseob Kim7cf14652021-01-06 23:06:52 +09001853func (c *deviceConfig) DirectedVendorSnapshot() bool {
1854 return c.config.productVariables.DirectedVendorSnapshot
1855}
1856
1857func (c *deviceConfig) VendorSnapshotModules() map[string]bool {
1858 return c.config.productVariables.VendorSnapshotModules
1859}
1860
Jose Galmes4c6895e2021-02-09 07:44:30 -08001861func (c *deviceConfig) DirectedRecoverySnapshot() bool {
1862 return c.config.productVariables.DirectedRecoverySnapshot
1863}
1864
1865func (c *deviceConfig) RecoverySnapshotModules() map[string]bool {
1866 return c.config.productVariables.RecoverySnapshotModules
1867}
1868
Justin DeMartino383bfb32021-02-24 10:49:43 -08001869func createDirsMap(previous map[string]bool, dirs []string) (map[string]bool, error) {
1870 var ret = make(map[string]bool)
1871 for _, dir := range dirs {
1872 clean := filepath.Clean(dir)
1873 if previous[clean] || ret[clean] {
1874 return nil, fmt.Errorf("Duplicate entry %s", dir)
1875 }
1876 ret[clean] = true
1877 }
1878 return ret, nil
1879}
1880
1881func (c *deviceConfig) createDirsMapOnce(onceKey OnceKey, previous map[string]bool, dirs []string) map[string]bool {
1882 dirMap := c.Once(onceKey, func() interface{} {
1883 ret, err := createDirsMap(previous, dirs)
1884 if err != nil {
1885 panic(fmt.Errorf("%s: %w", onceKey.key, err))
1886 }
1887 return ret
1888 })
1889 if dirMap == nil {
1890 return nil
1891 }
1892 return dirMap.(map[string]bool)
1893}
1894
1895var vendorSnapshotDirsExcludedKey = NewOnceKey("VendorSnapshotDirsExcludedMap")
1896
1897func (c *deviceConfig) VendorSnapshotDirsExcludedMap() map[string]bool {
1898 return c.createDirsMapOnce(vendorSnapshotDirsExcludedKey, nil,
1899 c.config.productVariables.VendorSnapshotDirsExcluded)
1900}
1901
1902var vendorSnapshotDirsIncludedKey = NewOnceKey("VendorSnapshotDirsIncludedMap")
1903
1904func (c *deviceConfig) VendorSnapshotDirsIncludedMap() map[string]bool {
1905 excludedMap := c.VendorSnapshotDirsExcludedMap()
1906 return c.createDirsMapOnce(vendorSnapshotDirsIncludedKey, excludedMap,
1907 c.config.productVariables.VendorSnapshotDirsIncluded)
1908}
1909
1910var recoverySnapshotDirsExcludedKey = NewOnceKey("RecoverySnapshotDirsExcludedMap")
1911
1912func (c *deviceConfig) RecoverySnapshotDirsExcludedMap() map[string]bool {
1913 return c.createDirsMapOnce(recoverySnapshotDirsExcludedKey, nil,
1914 c.config.productVariables.RecoverySnapshotDirsExcluded)
1915}
1916
1917var recoverySnapshotDirsIncludedKey = NewOnceKey("RecoverySnapshotDirsIncludedMap")
1918
1919func (c *deviceConfig) RecoverySnapshotDirsIncludedMap() map[string]bool {
1920 excludedMap := c.RecoverySnapshotDirsExcludedMap()
1921 return c.createDirsMapOnce(recoverySnapshotDirsIncludedKey, excludedMap,
1922 c.config.productVariables.RecoverySnapshotDirsIncluded)
1923}
1924
Rob Seymour925aa092021-08-10 20:42:03 +00001925func (c *deviceConfig) HostFakeSnapshotEnabled() bool {
1926 return c.config.productVariables.HostFakeSnapshotEnabled
1927}
1928
Inseob Kim60c32f02020-12-21 22:53:05 +09001929func (c *deviceConfig) ShippingApiLevel() ApiLevel {
1930 if c.config.productVariables.ShippingApiLevel == nil {
1931 return NoneApiLevel
1932 }
1933 apiLevel, _ := strconv.Atoi(*c.config.productVariables.ShippingApiLevel)
1934 return uncheckedFinalApiLevel(apiLevel)
1935}
1936
Liz Kammer33cc80e2023-05-18 18:20:28 +00001937func (c *deviceConfig) BuildBrokenPluginValidation() []string {
1938 return c.config.productVariables.BuildBrokenPluginValidation
1939}
1940
Alix Espinoef47e542022-09-14 19:10:51 +00001941func (c *deviceConfig) BuildBrokenClangAsFlags() bool {
1942 return c.config.productVariables.BuildBrokenClangAsFlags
1943}
1944
1945func (c *deviceConfig) BuildBrokenClangCFlags() bool {
1946 return c.config.productVariables.BuildBrokenClangCFlags
1947}
1948
Alixb5f6d9e2022-04-20 23:00:58 +00001949func (c *deviceConfig) BuildBrokenClangProperty() bool {
1950 return c.config.productVariables.BuildBrokenClangProperty
1951}
1952
Inseob Kim67e5add192021-03-17 18:05:33 +09001953func (c *deviceConfig) BuildBrokenEnforceSyspropOwner() bool {
1954 return c.config.productVariables.BuildBrokenEnforceSyspropOwner
1955}
1956
1957func (c *deviceConfig) BuildBrokenTrebleSyspropNeverallow() bool {
1958 return c.config.productVariables.BuildBrokenTrebleSyspropNeverallow
1959}
1960
Cole Faustedc4c502022-09-09 19:39:25 -07001961func (c *deviceConfig) BuildBrokenUsesSoongPython2Modules() bool {
1962 return c.config.productVariables.BuildBrokenUsesSoongPython2Modules
1963}
1964
Hridya Valsaraju5a5c7d52021-04-02 16:45:24 -07001965func (c *deviceConfig) BuildDebugfsRestrictionsEnabled() bool {
1966 return c.config.productVariables.BuildDebugfsRestrictionsEnabled
1967}
1968
Inseob Kim0cac7b42021-02-03 18:16:46 +09001969func (c *deviceConfig) BuildBrokenVendorPropertyNamespace() bool {
1970 return c.config.productVariables.BuildBrokenVendorPropertyNamespace
1971}
1972
Liz Kammer619be462022-01-28 15:13:39 -05001973func (c *deviceConfig) BuildBrokenInputDir(name string) bool {
1974 return InList(name, c.config.productVariables.BuildBrokenInputDirModules)
1975}
1976
Jiakai Zhang48203e32023-06-02 23:42:21 +01001977func (c *config) BuildWarningBadOptionalUsesLibsAllowlist() []string {
1978 return c.productVariables.BuildWarningBadOptionalUsesLibsAllowlist
1979}
1980
Yu Liu6a7940c2023-05-09 17:12:22 -07001981func (c *deviceConfig) GenruleSandboxing() bool {
1982 return Bool(c.config.productVariables.GenruleSandboxing)
Vinh Tran140d5882022-06-10 14:23:27 -04001983}
1984
Inseob Kim67e5add192021-03-17 18:05:33 +09001985func (c *deviceConfig) RequiresInsecureExecmemForSwiftshader() bool {
1986 return c.config.productVariables.RequiresInsecureExecmemForSwiftshader
1987}
1988
Devin Moorec381e102023-07-06 22:03:58 +00001989func (c *deviceConfig) Release_aidl_use_unfrozen() bool {
1990 return Bool(c.config.productVariables.Release_aidl_use_unfrozen)
1991}
1992
Inseob Kim67e5add192021-03-17 18:05:33 +09001993func (c *config) SelinuxIgnoreNeverallows() bool {
1994 return c.productVariables.SelinuxIgnoreNeverallows
1995}
1996
Inseob Kima10ef272021-09-15 03:04:53 +00001997func (c *deviceConfig) SepolicyFreezeTestExtraDirs() []string {
1998 return c.config.productVariables.SepolicyFreezeTestExtraDirs
1999}
2000
2001func (c *deviceConfig) SepolicyFreezeTestExtraPrebuiltDirs() []string {
2002 return c.config.productVariables.SepolicyFreezeTestExtraPrebuiltDirs
2003}
2004
Jiyong Parkd163d4d2021-10-12 16:47:43 +09002005func (c *deviceConfig) GenerateAidlNdkPlatformBackend() bool {
2006 return c.config.productVariables.GenerateAidlNdkPlatformBackend
2007}
2008
Christopher Ferris98f10222022-07-13 23:16:52 -07002009func (c *config) IgnorePrefer32OnDevice() bool {
2010 return c.productVariables.IgnorePrefer32OnDevice
2011}
2012
Ulya Trafimovich249386a2020-07-01 14:31:13 +01002013func (c *config) BootJars() []string {
2014 return c.Once(earlyBootJarsKey, func() interface{} {
Paul Duffin69d1fb12020-10-23 21:14:20 +01002015 list := c.productVariables.BootJars.CopyOfJars()
satayevd604b212021-07-21 14:23:52 +01002016 return append(list, c.productVariables.ApexBootJars.CopyOfJars()...)
Ulya Trafimovich249386a2020-07-01 14:31:13 +01002017 }).([]string)
2018}
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002019
satayevd604b212021-07-21 14:23:52 +01002020func (c *config) NonApexBootJars() ConfiguredJarList {
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002021 return c.productVariables.BootJars
2022}
2023
satayevd604b212021-07-21 14:23:52 +01002024func (c *config) ApexBootJars() ConfiguredJarList {
2025 return c.productVariables.ApexBootJars
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002026}
Colin Cross77cdcfd2021-03-12 11:28:25 -08002027
2028func (c *config) RBEWrapper() string {
2029 return c.GetenvWithDefault("RBE_WRAPPER", remoteexec.DefaultWrapperPath)
2030}
Colin Cross9b698b62021-12-22 09:55:32 -08002031
2032// UseHostMusl returns true if the host target has been configured to build against musl libc.
2033func (c *config) UseHostMusl() bool {
2034 return Bool(c.productVariables.HostMusl)
2035}
MarkDacekff851b82022-04-21 18:33:17 +00002036
MarkDacekf47e1422023-04-19 16:47:36 +00002037func (c *config) GetMixedBuildsEnabledModules() map[string]struct{} {
2038 return c.mixedBuildEnabledModules
2039}
2040
MarkDacek6f6b9622023-05-02 16:28:55 +00002041func (c *config) GetMixedBuildsDisabledModules() map[string]struct{} {
2042 return c.mixedBuildDisabledModules
2043}
2044
Chris Parsonsf874e462022-05-10 13:50:12 -04002045func (c *config) LogMixedBuild(ctx BaseModuleContext, useBazel bool) {
MarkDacekff851b82022-04-21 18:33:17 +00002046 moduleName := ctx.Module().Name()
2047 c.mixedBuildsLock.Lock()
2048 defer c.mixedBuildsLock.Unlock()
2049 if useBazel {
2050 c.mixedBuildEnabledModules[moduleName] = struct{}{}
2051 } else {
2052 c.mixedBuildDisabledModules[moduleName] = struct{}{}
2053 }
2054}
Spandan Das9e93d3d2023-03-08 05:47:29 +00002055
Chris Parsons0c4de1f2023-09-21 20:36:35 +00002056func (c *config) HasBazelBuildTargetInSource(dir string, target string) bool {
2057 for _, existingTarget := range c.bazelTargetsByDir[dir] {
2058 if target == existingTarget {
Chris Parsons8152a942023-06-06 16:17:50 +00002059 return true
2060 }
2061 }
2062 return false
2063}
2064
2065func (c *config) SetBazelBuildFileTargets(bazelTargetsByDir map[string][]string) {
2066 c.bazelTargetsByDir = bazelTargetsByDir
2067}
2068
Spandan Das9e93d3d2023-03-08 05:47:29 +00002069// ApiSurfaces directory returns the source path inside the api_surfaces repo
2070// (relative to workspace root).
2071func (c *config) ApiSurfacesDir(s ApiSurface, version string) string {
2072 return filepath.Join(
2073 "build",
2074 "bazel",
2075 "api_surfaces",
2076 s.String(),
2077 version)
2078}
Jihoon Kang1bff0342023-01-17 20:40:22 +00002079
Jihoon Kang1975d3e2023-10-16 23:24:11 +00002080func (c *config) JavaCoverageEnabled() bool {
2081 return c.IsEnvTrue("EMMA_INSTRUMENT") || c.IsEnvTrue("EMMA_INSTRUMENT_STATIC") || c.IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK")
2082}
2083
Jihoon Kangc1b04d62023-11-16 19:07:04 +00002084func (c *deviceConfig) BuildFromSourceStub() bool {
2085 return Bool(c.config.productVariables.BuildFromSourceStub)
2086}
2087
Jihoon Kang1bff0342023-01-17 20:40:22 +00002088func (c *config) BuildFromTextStub() bool {
Jihoon Kang1975d3e2023-10-16 23:24:11 +00002089 // TODO: b/302320354 - Remove the coverage build specific logic once the
2090 // robust solution for handling native properties in from-text stub build
2091 // is implemented.
Jihoon Kangc1b04d62023-11-16 19:07:04 +00002092 return !c.buildFromSourceStub &&
2093 !c.JavaCoverageEnabled() &&
2094 !c.deviceConfig.BuildFromSourceStub()
Jihoon Kang1bff0342023-01-17 20:40:22 +00002095}
Spandan Das4deab282023-03-30 17:06:32 +00002096
2097func (c *config) SetBuildFromTextStub(b bool) {
Jihoon Kang2a929ad2023-06-08 19:02:07 +00002098 c.buildFromSourceStub = !b
Jihoon Kangcbcad7c2023-06-01 22:31:52 +00002099 c.productVariables.Build_from_text_stub = boolPtr(b)
Spandan Das4deab282023-03-30 17:06:32 +00002100}
Jihoon Kang1c92c3e2023-03-23 17:44:51 +00002101
MarkDacek9c094ca2023-03-16 19:15:19 +00002102func (c *config) AddForceEnabledModules(forceEnabled []string) {
2103 for _, forceEnabledModule := range forceEnabled {
2104 c.bazelForceEnabledModules[forceEnabledModule] = struct{}{}
2105 }
2106}
Jihoon Kang1c92c3e2023-03-23 17:44:51 +00002107
2108func (c *config) SetApiLibraries(libs []string) {
2109 c.apiLibraries = make(map[string]struct{})
2110 for _, lib := range libs {
2111 c.apiLibraries[lib] = struct{}{}
2112 }
2113}
2114
2115func (c *config) GetApiLibraries() map[string]struct{} {
2116 return c.apiLibraries
2117}
Inseob Kim5bac3b62023-08-25 21:29:46 +09002118
Liz Kammere1b39a52023-09-18 14:32:18 -04002119// Bp2buildMode indicates whether the config is for bp2build mode of Soong
2120func (c *config) Bp2buildMode() bool {
2121 return c.BuildMode == Bp2build
2122}
2123
Inseob Kim5bac3b62023-08-25 21:29:46 +09002124func (c *deviceConfig) CheckVendorSeappViolations() bool {
2125 return Bool(c.config.productVariables.CheckVendorSeappViolations)
2126}
Jihoon Kangcfbc4072023-09-20 01:02:18 +00002127
2128func (c *deviceConfig) NextReleaseHideFlaggedApi() bool {
2129 return Bool(c.config.productVariables.NextReleaseHideFlaggedApi)
2130}
Jihoon Kangf3aa3222023-09-26 22:32:08 +00002131
2132func (c *deviceConfig) ReleaseExposeFlaggedApi() bool {
2133 return Bool(c.config.productVariables.Release_expose_flagged_api)
2134}
Jihoon Kangc8313892023-09-20 00:54:47 +00002135
2136func (c *deviceConfig) HideFlaggedApis() bool {
2137 return c.NextReleaseHideFlaggedApi() && !c.ReleaseExposeFlaggedApi()
2138}
Inseob Kime4e85d52023-10-25 23:53:58 +09002139
2140func (c *config) GetBuildFlag(name string) (string, bool) {
2141 val, ok := c.productVariables.BuildFlags[name]
2142 return val, ok
2143}
Spandan Dase3fcb412023-10-26 20:48:02 +00002144
2145var (
2146 mainlineApexContributionBuildFlags = []string{
2147 "RELEASE_APEX_CONTRIBUTIONS_ADSERVICES",
2148 "RELEASE_APEX_CONTRIBUTIONS_APPSEARCH",
2149 "RELEASE_APEX_CONTRIBUTIONS_ART",
2150 "RELEASE_APEX_CONTRIBUTIONS_BLUETOOTH",
2151 "RELEASE_APEX_CONTRIBUTIONS_CONFIGINFRASTRUCTURE",
2152 "RELEASE_APEX_CONTRIBUTIONS_CONNECTIVITY",
2153 "RELEASE_APEX_CONTRIBUTIONS_CONSCRYPT",
2154 "RELEASE_APEX_CONTRIBUTIONS_CRASHRECOVERY",
2155 "RELEASE_APEX_CONTRIBUTIONS_DEVICELOCK",
2156 "RELEASE_APEX_CONTRIBUTIONS_HEALTHFITNESS",
2157 "RELEASE_APEX_CONTRIBUTIONS_IPSEC",
2158 "RELEASE_APEX_CONTRIBUTIONS_MEDIA",
2159 "RELEASE_APEX_CONTRIBUTIONS_MEDIAPROVIDER",
2160 "RELEASE_APEX_CONTRIBUTIONS_ONDEVICEPERSONALIZATION",
2161 "RELEASE_APEX_CONTRIBUTIONS_PERMISSION",
2162 "RELEASE_APEX_CONTRIBUTIONS_REMOTEKEYPROVISIONING",
2163 "RELEASE_APEX_CONTRIBUTIONS_SCHEDULING",
2164 "RELEASE_APEX_CONTRIBUTIONS_SDKEXTENSIONS",
2165 "RELEASE_APEX_CONTRIBUTIONS_STATSD",
2166 "RELEASE_APEX_CONTRIBUTIONS_UWB",
2167 "RELEASE_APEX_CONTRIBUTIONS_WIFI",
2168 }
2169)
2170
2171// Returns the list of _selected_ apex_contributions
2172// Each mainline module will have one entry in the list
2173func (c *config) AllApexContributions() []string {
2174 ret := []string{}
2175 for _, f := range mainlineApexContributionBuildFlags {
2176 if val, exists := c.GetBuildFlag(f); exists && val != "" {
2177 ret = append(ret, val)
2178 }
2179 }
2180 return ret
2181}