blob: f6a813b6bfdfc98a95005faace4680457d55367b [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
Vilas Bhatb3d2d222023-12-04 22:51:20 +0000198// NoBionicPageSizeMacro returns true when AOSP is page size agnostic.
199// This means that the bionic's macro PAGE_SIZE won't be defined.
200// Returns false when AOSP is NOT page size agnostic.
201// This means that bionic's macro PAGE_SIZE is defined.
202func (c Config) NoBionicPageSizeMacro() bool {
203 return Bool(c.config.productVariables.DeviceNoBionicPageSizeMacro)
Juan Yescas01065602023-08-09 08:34:37 -0700204}
205
Joe Onoratofee845a2023-05-09 08:14:14 -0700206// The release version passed to aconfig, derived from RELEASE_VERSION
207func (c Config) ReleaseVersion() string {
208 return c.config.productVariables.ReleaseVersion
209}
210
Yu Liu2cc802a2023-09-05 17:19:45 -0700211// The aconfig value set passed to aconfig, derived from RELEASE_VERSION
Yu Liueebb2592023-10-12 20:31:27 -0700212func (c Config) ReleaseAconfigValueSets() []string {
Yu Liu95572ff2023-12-07 16:38:45 -0800213 return c.config.productVariables.ReleaseAconfigValueSets
Joe Onoratofee845a2023-05-09 08:14:14 -0700214}
215
Zhi Dou3f65a412023-08-10 21:47:40 +0000216// The flag default permission value passed to aconfig
217// derived from RELEASE_ACONFIG_FLAG_DEFAULT_PERMISSION
218func (c Config) ReleaseAconfigFlagDefaultPermission() string {
219 return c.config.productVariables.ReleaseAconfigFlagDefaultPermission
220}
221
Alyssa Ketpreechasawat34ab8792023-10-06 07:01:22 +0000222// The flag indicating behavior for the tree wrt building modules or using prebuilts
223// derived from RELEASE_DEFAULT_MODULE_BUILD_FROM_SOURCE
224func (c Config) ReleaseDefaultModuleBuildFromSource() bool {
225 return c.config.productVariables.ReleaseDefaultModuleBuildFromSource == nil ||
226 Bool(c.config.productVariables.ReleaseDefaultModuleBuildFromSource)
227}
228
Aleksei Vetrov146e9822023-11-24 19:54:26 +0000229// Enables ABI monitoring of NDK libraries
230func (c Config) ReleaseNdkAbiMonitored() bool {
231 return c.config.productVariables.GetBuildFlagBool("RELEASE_NDK_ABI_MONITORED")
232}
233
Jingwen Chenc711fec2020-11-22 23:52:50 -0500234// A DeviceConfig object represents the configuration for a particular device
235// being built. For now there will only be one of these, but in the future there
236// may be multiple devices being built.
Colin Cross9272ade2016-08-17 15:24:12 -0700237type DeviceConfig struct {
238 *deviceConfig
239}
240
Jingwen Chenc711fec2020-11-22 23:52:50 -0500241// VendorConfig represents the configuration for vendor-specific behavior.
Colin Cross9d34f352019-11-22 16:03:51 -0800242type VendorConfig soongconfig.SoongConfig
Dan Willemsen0fe78662018-03-26 12:41:18 -0700243
Jingwen Chenc711fec2020-11-22 23:52:50 -0500244// Definition of general build configuration for soong_build. Some of these
Jingwen Chenc4d91bc2020-11-24 22:59:26 -0500245// product configuration values are read from Kati-generated soong.variables.
Colin Cross1332b002015-04-07 17:11:30 -0700246type config struct {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500247 // Options configurable with soong.variables
Cole Faustf8231dd2023-04-21 17:37:11 -0700248 productVariables ProductVariables
Colin Cross3f40fa42015-01-30 17:27:36 -0800249
Dan Willemsen674dc7f2018-03-12 18:06:05 -0700250 // Only available on configs created by TestConfig
Cole Faustf8231dd2023-04-21 17:37:11 -0700251 TestProductVariables *ProductVariables
Dan Willemsen674dc7f2018-03-12 18:06:05 -0700252
Jingwen Chenc711fec2020-11-22 23:52:50 -0500253 // A specialized context object for Bazel/Soong mixed builds and migration
254 // purposes.
Chris Parsonsf3c96ef2020-09-29 02:23:17 -0400255 BazelContext BazelContext
256
Dan Willemsen87b17d12015-07-14 00:39:06 -0700257 ProductVariablesFileName string
258
Colin Cross0c66bc62021-07-20 09:47:41 -0700259 // BuildOS stores the OsType for the OS that the build is running on.
260 BuildOS OsType
261
262 // BuildArch stores the ArchType for the CPU that the build is running on.
263 BuildArch ArchType
264
Jaewoong Jung642916f2020-10-09 17:25:15 -0700265 Targets map[OsType][]Target
266 BuildOSTarget Target // the Target for tools run on the build machine
267 BuildOSCommonTarget Target // the Target for common (java) tools run on the build machine
268 AndroidCommonTarget Target // the Target for common modules for the Android device
269 AndroidFirstDeviceTarget Target // the first Target for modules for the Android device
Dan Willemsen218f6562015-07-08 18:13:11 -0700270
Jingwen Chenc711fec2020-11-22 23:52:50 -0500271 // multilibConflicts for an ArchType is true if there is earlier configured
272 // device architecture with the same multilib value.
Colin Cross3b19f5d2019-09-17 14:45:31 -0700273 multilibConflicts map[ArchType]bool
274
Colin Cross9272ade2016-08-17 15:24:12 -0700275 deviceConfig *deviceConfig
276
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200277 outDir string // The output directory (usually out/)
278 soongOutDir string
Chris Parsons8f232a22020-06-23 17:37:05 -0400279 moduleListFile string // the path to the file which lists blueprint files to parse.
Colin Crossc1e86a32015-04-15 12:33:28 -0700280
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +0200281 runGoTests bool
Lukacs T. Berkiea1a31c2021-09-02 09:58:09 +0200282
Colin Cross6ccbc912017-10-10 23:07:38 -0700283 env map[string]string
Dan Willemsene7680ba2015-09-11 17:06:19 -0700284 envLock sync.Mutex
285 envDeps map[string]string
286 envFrozen bool
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800287
Jingwen Chencda22c92020-11-23 00:22:30 -0500288 // Changes behavior based on whether Kati runs after soong_build, or if soong_build
289 // runs standalone.
290 katiEnabled bool
Colin Cross1e7d3702016-08-24 15:25:47 -0700291
Colin Cross32616ed2017-09-05 21:56:44 -0700292 captureBuild bool // true for tests, saves build parameters for each module
293 ignoreEnvironment bool // true for tests, returns empty from all Getenv calls
Colin Crosscec81712017-07-13 14:43:27 -0700294
Colin Cross98be1bb2019-12-13 20:41:13 -0800295 fs pathtools.FileSystem
296 mockBpList string
297
Chris Parsonsad876012022-08-20 14:48:32 -0400298 BuildMode SoongBuildMode
Cole Faust324a92e2022-08-23 15:29:05 -0700299 Bp2buildPackageConfig Bp2BuildConversionAllowlist
Jingwen Chen01812022021-11-19 14:29:43 +0000300 Bp2buildSoongConfigDefinitions soongconfig.Bp2BuildSoongConfigDefinitions
Jingwen Chen12b4c272021-03-10 02:05:59 -0500301
LaMont Jones52a72432023-03-09 18:19:35 +0000302 // If MultitreeBuild is true then this is one inner tree of a multitree
303 // build directed by the multitree orchestrator.
304 MultitreeBuild bool
305
Colin Cross5e6a7972020-06-07 16:56:32 -0700306 // If testAllowNonExistentPaths is true then PathForSource and PathForModuleSrc won't error
307 // in tests when a path doesn't exist.
Pedro Loureiro5d190cc2021-02-15 15:41:33 +0000308 TestAllowNonExistentPaths bool
Colin Cross5e6a7972020-06-07 16:56:32 -0700309
Jingwen Chenc711fec2020-11-22 23:52:50 -0500310 // The list of files that when changed, must invalidate soong_build to
311 // regenerate build.ninja.
Colin Cross12129292020-10-29 18:23:58 -0700312 ninjaFileDepsSet sync.Map
313
Colin Cross9272ade2016-08-17 15:24:12 -0700314 OncePer
MarkDacekff851b82022-04-21 18:33:17 +0000315
Chris Parsonsad876012022-08-20 14:48:32 -0400316 // These fields are only used for metrics collection. A module should be added
317 // to these maps only if its implementation supports Bazel handling in mixed
318 // builds. A module being in the "enabled" list indicates that there is a
319 // variant of that module for which bazel-handling actually took place.
320 // A module being in the "disabled" list indicates that there is a variant of
321 // that module for which bazel-handling was denied.
MarkDacekff851b82022-04-21 18:33:17 +0000322 mixedBuildsLock sync.Mutex
323 mixedBuildEnabledModules map[string]struct{}
324 mixedBuildDisabledModules map[string]struct{}
MarkDacekd06db5d2022-11-29 00:47:59 +0000325
326 // These are modules to be built with Bazel beyond the allowlisted/build-mode
327 // specified modules. They are passed via the command-line flag
328 // "--bazel-force-enabled-modules"
329 bazelForceEnabledModules map[string]struct{}
Chris Parsons9402ca82023-02-23 17:28:06 -0500330
Chris Parsons8152a942023-06-06 16:17:50 +0000331 // Names of Bazel targets as defined by BUILD files in the source tree,
332 // keyed by the directory in which they are defined.
333 bazelTargetsByDir map[string][]string
334
Chris Parsons9402ca82023-02-23 17:28:06 -0500335 // If true, for any requests to Bazel, communicate with a Bazel proxy using
336 // unix sockets, instead of spawning Bazel as a subprocess.
337 UseBazelProxy bool
Jihoon Kang1bff0342023-01-17 20:40:22 +0000338
Jihoon Kang2a929ad2023-06-08 19:02:07 +0000339 // If buildFromSourceStub is true then the Java API stubs are
340 // built from the source Java files, not the signature text files.
341 buildFromSourceStub bool
MarkDacekf47e1422023-04-19 16:47:36 +0000342
343 // If ensureAllowlistIntegrity is true, then the presence of any allowlisted
344 // modules that aren't mixed-built for at least one variant will cause a build
345 // failure
346 ensureAllowlistIntegrity bool
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000347
348 // List of Api libraries that contribute to Api surfaces.
349 apiLibraries map[string]struct{}
Colin Cross9272ade2016-08-17 15:24:12 -0700350}
351
352type deviceConfig struct {
Dan Willemsen00269f22017-07-06 16:59:48 -0700353 config *config
Colin Cross9272ade2016-08-17 15:24:12 -0700354 OncePer
Colin Cross3f40fa42015-01-30 17:27:36 -0800355}
356
Colin Cross485e5722015-08-27 13:28:01 -0700357type jsonConfigurable interface {
Colin Cross27385972015-09-18 10:57:10 -0700358 SetDefaultConfig()
Colin Cross485e5722015-08-27 13:28:01 -0700359}
Colin Cross3f40fa42015-01-30 17:27:36 -0800360
Colin Cross485e5722015-08-27 13:28:01 -0700361func loadConfig(config *config) error {
Colin Cross988414c2020-01-11 01:11:46 +0000362 return loadFromConfigFile(&config.productVariables, absolutePath(config.ProductVariablesFileName))
Colin Cross485e5722015-08-27 13:28:01 -0700363}
364
Jingwen Chenc711fec2020-11-22 23:52:50 -0500365// loadFromConfigFile loads and decodes configuration options from a JSON file
366// in the current working directory.
Cole Faustf8231dd2023-04-21 17:37:11 -0700367func loadFromConfigFile(configurable *ProductVariables, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800368 // Try to open the file
Colin Cross485e5722015-08-27 13:28:01 -0700369 configFileReader, err := os.Open(filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800370 defer configFileReader.Close()
371 if os.IsNotExist(err) {
372 // Need to create a file, so that blueprint & ninja don't get in
373 // a dependency tracking loop.
374 // Make a file-configurable-options with defaults, write it out using
375 // a json writer.
Colin Cross27385972015-09-18 10:57:10 -0700376 configurable.SetDefaultConfig()
377 err = saveToConfigFile(configurable, filename)
Colin Cross3f40fa42015-01-30 17:27:36 -0800378 if err != nil {
379 return err
380 }
Colin Cross15cd21a2018-02-27 11:26:02 -0800381 } else if err != nil {
382 return fmt.Errorf("config file: could not open %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800383 } else {
384 // Make a decoder for it
385 jsonDecoder := json.NewDecoder(configFileReader)
Colin Cross485e5722015-08-27 13:28:01 -0700386 err = jsonDecoder.Decode(configurable)
Colin Cross3f40fa42015-01-30 17:27:36 -0800387 if err != nil {
Colin Cross15cd21a2018-02-27 11:26:02 -0800388 return fmt.Errorf("config file: %s did not parse correctly: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800389 }
390 }
391
Liz Kammer09f947d2021-05-12 14:51:49 -0400392 if Bool(configurable.GcovCoverage) && Bool(configurable.ClangCoverage) {
393 return fmt.Errorf("GcovCoverage and ClangCoverage cannot both be set")
394 }
395
396 configurable.Native_coverage = proptools.BoolPtr(
397 Bool(configurable.GcovCoverage) ||
398 Bool(configurable.ClangCoverage))
399
Yuntao Xu402e9b02021-08-09 15:44:44 -0700400 // when Platform_sdk_final is true (or PLATFORM_VERSION_CODENAME is REL), use Platform_sdk_version;
401 // if false (pre-released version, for example), use Platform_sdk_codename.
402 if Bool(configurable.Platform_sdk_final) {
403 if configurable.Platform_sdk_version != nil {
404 configurable.Platform_sdk_version_or_codename =
405 proptools.StringPtr(strconv.Itoa(*(configurable.Platform_sdk_version)))
406 } else {
407 return fmt.Errorf("Platform_sdk_version cannot be pointed by a NULL pointer")
408 }
409 } else {
410 configurable.Platform_sdk_version_or_codename =
411 proptools.StringPtr(String(configurable.Platform_sdk_codename))
412 }
413
Liz Kammer09f947d2021-05-12 14:51:49 -0400414 return saveToBazelConfigFile(configurable, filepath.Dir(filename))
Colin Cross3f40fa42015-01-30 17:27:36 -0800415}
416
Colin Crossd8f20142016-11-03 09:43:26 -0700417// atomically writes the config file in case two copies of soong_build are running simultaneously
418// (for example, docs generation and ninja manifest generation)
Cole Faustf8231dd2023-04-21 17:37:11 -0700419func saveToConfigFile(config *ProductVariables, filename string) error {
Colin Cross3f40fa42015-01-30 17:27:36 -0800420 data, err := json.MarshalIndent(&config, "", " ")
421 if err != nil {
422 return fmt.Errorf("cannot marshal config data: %s", err.Error())
423 }
424
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800425 f, err := os.CreateTemp(filepath.Dir(filename), "config")
Colin Cross3f40fa42015-01-30 17:27:36 -0800426 if err != nil {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500427 return fmt.Errorf("cannot create empty config file %s: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800428 }
Colin Crossd8f20142016-11-03 09:43:26 -0700429 defer os.Remove(f.Name())
430 defer f.Close()
Colin Cross3f40fa42015-01-30 17:27:36 -0800431
Colin Crossd8f20142016-11-03 09:43:26 -0700432 _, err = f.Write(data)
Colin Cross3f40fa42015-01-30 17:27:36 -0800433 if err != nil {
Colin Cross485e5722015-08-27 13:28:01 -0700434 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
435 }
436
Colin Crossd8f20142016-11-03 09:43:26 -0700437 _, err = f.WriteString("\n")
Colin Cross485e5722015-08-27 13:28:01 -0700438 if err != nil {
439 return fmt.Errorf("default config file: %s could not be written: %s", filename, err.Error())
Colin Cross3f40fa42015-01-30 17:27:36 -0800440 }
441
Colin Crossd8f20142016-11-03 09:43:26 -0700442 f.Close()
443 os.Rename(f.Name(), filename)
444
Colin Cross3f40fa42015-01-30 17:27:36 -0800445 return nil
446}
447
Cole Faust87c0c332023-07-31 12:10:12 -0700448type productVariableStarlarkRepresentation struct {
449 soongType string
450 selectable bool
451 archVariant bool
452}
453
Cole Faustf8231dd2023-04-21 17:37:11 -0700454func saveToBazelConfigFile(config *ProductVariables, outDir string) error {
Liz Kammer09f947d2021-05-12 14:51:49 -0400455 dir := filepath.Join(outDir, bazel.SoongInjectionDirName, "product_config")
456 err := createDirIfNonexistent(dir, os.ModePerm)
457 if err != nil {
458 return fmt.Errorf("Could not create dir %s: %s", dir, err)
459 }
460
Cole Faust87c0c332023-07-31 12:10:12 -0700461 allProductVariablesType := reflect.TypeOf((*ProductVariables)(nil)).Elem()
462 productVariablesInfo := make(map[string]productVariableStarlarkRepresentation)
Sam Delmerico5c32bbf2022-01-20 20:15:02 +0000463 p := variableProperties{}
464 t := reflect.TypeOf(p.Product_variables)
465 for i := 0; i < t.NumField(); i++ {
466 f := t.Field(i)
Cole Faust87c0c332023-07-31 12:10:12 -0700467 archVariant := proptools.HasTag(f, "android", "arch_variant")
468 if mainProductVariablesStructField, ok := allProductVariablesType.FieldByName(f.Name); ok {
469 productVariablesInfo[f.Name] = productVariableStarlarkRepresentation{
470 soongType: stringRepresentationOfSimpleType(mainProductVariablesStructField.Type),
471 selectable: true,
472 archVariant: archVariant,
473 }
474 } else {
475 panic("Unknown variable " + f.Name)
Sam Delmerico5c32bbf2022-01-20 20:15:02 +0000476 }
477 }
478
Cole Fausteb644cf2023-04-11 13:48:17 -0700479 err = pathtools.WriteFileIfChanged(filepath.Join(dir, "product_variable_constants.bzl"), []byte(fmt.Sprintf(`
Cole Faust87c0c332023-07-31 12:10:12 -0700480# product_var_constant_info is a map of product variables to information about them. The fields are:
481# - soongType: The type of the product variable as it appears in soong's ProductVariables struct.
482# examples are string, bool, int, *bool, *string, []string, etc. This may be an overly
483# conservative estimation of the type, for example a *bool could oftentimes just be a
484# bool that defaults to false.
485# - selectable: if this product variable can be selected on in Android.bp/build files. This means
486# it's listed in the "variableProperties" soong struct. Currently all variables in
487# this list are selectable because we only need the selectable ones at the moment,
488# but the list may be expanded later.
489# - archVariant: If the variable is tagged as arch variant in the "variableProperties" struct.
490product_var_constant_info = %s
491product_var_constraints = [k for k, v in product_var_constant_info.items() if v.selectable]
492arch_variant_product_var_constraints = [k for k, v in product_var_constant_info.items() if v.selectable and v.archVariant]
493`, starlark_fmt.PrintAny(productVariablesInfo, 0))), 0644)
Cole Fausteb644cf2023-04-11 13:48:17 -0700494 if err != nil {
495 return fmt.Errorf("Could not write .bzl config file %s", err)
496 }
Chris Parsons0008cf82023-02-03 18:45:43 -0500497 err = pathtools.WriteFileIfChanged(filepath.Join(dir, "BUILD"),
498 []byte(bazel.GeneratedBazelFileWarning), 0644)
Liz Kammer09f947d2021-05-12 14:51:49 -0400499 if err != nil {
500 return fmt.Errorf("Could not write BUILD config file %s", err)
501 }
502
503 return nil
504}
505
Cole Faust87c0c332023-07-31 12:10:12 -0700506func stringRepresentationOfSimpleType(ty reflect.Type) string {
507 switch ty.Kind() {
508 case reflect.String:
509 return "string"
510 case reflect.Bool:
511 return "bool"
512 case reflect.Int:
513 return "int"
514 case reflect.Slice:
515 return "[]" + stringRepresentationOfSimpleType(ty.Elem())
516 case reflect.Pointer:
517 return "*" + stringRepresentationOfSimpleType(ty.Elem())
518 default:
519 panic("unimplemented type: " + ty.Kind().String())
520 }
521}
522
Colin Cross988414c2020-01-11 01:11:46 +0000523// NullConfig returns a mostly empty Config for use by standalone tools like dexpreopt_gen that
524// use the android package.
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200525func NullConfig(outDir, soongOutDir string) Config {
Colin Cross988414c2020-01-11 01:11:46 +0000526 return Config{
527 config: &config{
Lukacs T. Berkid6cee7e2021-09-01 16:25:51 +0200528 outDir: outDir,
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200529 soongOutDir: soongOutDir,
530 fs: pathtools.OsFs,
Colin Cross988414c2020-01-11 01:11:46 +0000531 },
532 }
533}
534
Jingwen Chenc711fec2020-11-22 23:52:50 -0500535// NewConfig creates a new Config object. The srcDir argument specifies the path
536// to the root source directory. It also loads the config file, if found.
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800537func NewConfig(cmdArgs CmdArgs, availableEnv map[string]string) (Config, error) {
Jingwen Chenc711fec2020-11-22 23:52:50 -0500538 // Make a config with default options.
Colin Cross9272ade2016-08-17 15:24:12 -0700539 config := &config{
Kiyoung Kima37d9ba2023-04-19 13:13:45 +0900540 ProductVariablesFileName: cmdArgs.SoongVariables,
Dan Willemsen87b17d12015-07-14 00:39:06 -0700541
Lukacs T. Berki53b2f362021-04-12 14:04:24 +0200542 env: availableEnv,
Colin Cross6ccbc912017-10-10 23:07:38 -0700543
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800544 outDir: cmdArgs.OutDir,
545 soongOutDir: cmdArgs.SoongOutDir,
546 runGoTests: cmdArgs.RunGoTests,
Lukacs T. Berkie1df43f2021-09-08 15:31:14 +0200547 multilibConflicts: make(map[ArchType]bool),
Colin Cross98be1bb2019-12-13 20:41:13 -0800548
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800549 moduleListFile: cmdArgs.ModuleListFile,
MarkDacekff851b82022-04-21 18:33:17 +0000550 fs: pathtools.NewOsFs(absSrcDir),
551 mixedBuildDisabledModules: make(map[string]struct{}),
552 mixedBuildEnabledModules: make(map[string]struct{}),
MarkDacekd06db5d2022-11-29 00:47:59 +0000553 bazelForceEnabledModules: make(map[string]struct{}),
Chris Parsons9402ca82023-02-23 17:28:06 -0500554
LaMont Jones52a72432023-03-09 18:19:35 +0000555 MultitreeBuild: cmdArgs.MultitreeBuild,
556 UseBazelProxy: cmdArgs.UseBazelProxy,
Jihoon Kang1bff0342023-01-17 20:40:22 +0000557
Jihoon Kang2a929ad2023-06-08 19:02:07 +0000558 buildFromSourceStub: cmdArgs.BuildFromSourceStub,
Colin Cross68f55102015-03-25 14:43:57 -0700559 }
Colin Cross3f40fa42015-01-30 17:27:36 -0800560
Dan Willemsen00269f22017-07-06 16:59:48 -0700561 config.deviceConfig = &deviceConfig{
Colin Cross9272ade2016-08-17 15:24:12 -0700562 config: config,
563 }
564
Liz Kammer7941b302020-07-28 13:27:34 -0700565 // Soundness check of the build and source directories. This won't catch strange
566 // configurations with symlinks, but at least checks the obvious case.
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800567 absBuildDir, err := filepath.Abs(cmdArgs.SoongOutDir)
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700568 if err != nil {
569 return Config{}, err
570 }
571
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200572 absSrcDir, err := filepath.Abs(".")
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700573 if err != nil {
574 return Config{}, err
575 }
576
577 if strings.HasPrefix(absSrcDir, absBuildDir) {
578 return Config{}, fmt.Errorf("Build dir must not contain source directory")
579 }
580
Colin Cross3f40fa42015-01-30 17:27:36 -0800581 // Load any configurable options from the configuration file
Colin Cross9272ade2016-08-17 15:24:12 -0700582 err = loadConfig(config)
Colin Cross3f40fa42015-01-30 17:27:36 -0800583 if err != nil {
Colin Crossc3c0a492015-04-10 15:43:55 -0700584 return Config{}, err
Colin Cross3f40fa42015-01-30 17:27:36 -0800585 }
586
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800587 KatiEnabledMarkerFile := filepath.Join(cmdArgs.SoongOutDir, ".soong.kati_enabled")
Jingwen Chencda22c92020-11-23 00:22:30 -0500588 if _, err := os.Stat(absolutePath(KatiEnabledMarkerFile)); err == nil {
589 config.katiEnabled = true
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800590 }
591
Colin Cross0c66bc62021-07-20 09:47:41 -0700592 determineBuildOS(config)
593
Jingwen Chenc711fec2020-11-22 23:52:50 -0500594 // Sets up the map of target OSes to the finer grained compilation targets
595 // that are configured from the product variables.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700596 targets, err := decodeTargetProductVariables(config)
Dan Willemsen218f6562015-07-08 18:13:11 -0700597 if err != nil {
598 return Config{}, err
599 }
600
Paul Duffin1356d8c2020-02-25 19:26:33 +0000601 // Make the CommonOS OsType available for all products.
602 targets[CommonOS] = []Target{commonTargetMap[CommonOS.Name]}
603
Dan Albert4098deb2016-10-19 14:04:41 -0700604 var archConfig []archConfig
Jingwen Chenc4d91bc2020-11-24 22:59:26 -0500605 if config.NdkAbis() {
Dan Albert4098deb2016-10-19 14:04:41 -0700606 archConfig = getNdkAbisConfig()
Martin Stjernholmc1ecc432019-11-15 15:00:31 +0000607 } else if config.AmlAbis() {
608 archConfig = getAmlAbisConfig()
Dan Albert4098deb2016-10-19 14:04:41 -0700609 }
610
611 if archConfig != nil {
Liz Kammerb7f33662022-02-28 14:16:16 -0500612 androidTargets, err := decodeAndroidArchSettings(archConfig)
Dan Willemsen322acaf2016-01-12 23:07:05 -0800613 if err != nil {
614 return Config{}, err
615 }
Dan Willemsen0ef639b2018-10-10 17:02:29 -0700616 targets[Android] = androidTargets
Dan Willemsen322acaf2016-01-12 23:07:05 -0800617 }
618
Colin Cross3b19f5d2019-09-17 14:45:31 -0700619 multilib := make(map[string]bool)
620 for _, target := range targets[Android] {
621 if seen := multilib[target.Arch.ArchType.Multilib]; seen {
622 config.multilibConflicts[target.Arch.ArchType] = true
623 }
624 multilib[target.Arch.ArchType.Multilib] = true
625 }
626
Jingwen Chenc711fec2020-11-22 23:52:50 -0500627 // Map of OS to compilation targets.
Colin Crossa1ad8d12016-06-01 17:09:44 -0700628 config.Targets = targets
Jingwen Chenc711fec2020-11-22 23:52:50 -0500629
630 // Compilation targets for host tools.
Colin Cross0c66bc62021-07-20 09:47:41 -0700631 config.BuildOSTarget = config.Targets[config.BuildOS][0]
632 config.BuildOSCommonTarget = getCommonTargets(config.Targets[config.BuildOS])[0]
Jingwen Chenc711fec2020-11-22 23:52:50 -0500633
634 // Compilation targets for Android.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700635 if len(config.Targets[Android]) > 0 {
636 config.AndroidCommonTarget = getCommonTargets(config.Targets[Android])[0]
Sam Delmericocc271e22022-06-01 15:45:02 +0000637 config.AndroidFirstDeviceTarget = FirstTarget(config.Targets[Android], "lib64", "lib32")[0]
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700638 }
Dan Willemsen218f6562015-07-08 18:13:11 -0700639
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500640 setBuildMode := func(arg string, mode SoongBuildMode) {
641 if arg != "" {
642 if config.BuildMode != AnalysisNoBazel {
643 fmt.Fprintf(os.Stderr, "buildMode is already set, illegal argument: %s", arg)
644 os.Exit(1)
645 }
646 config.BuildMode = mode
647 }
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800648 }
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500649 setBazelMode := func(arg bool, argName string, mode SoongBuildMode) {
650 if arg {
651 if config.BuildMode != AnalysisNoBazel {
652 fmt.Fprintf(os.Stderr, "buildMode is already set, illegal argument: %s", argName)
653 os.Exit(1)
654 }
655 config.BuildMode = mode
656 }
657 }
658 setBuildMode(cmdArgs.SymlinkForestMarker, SymlinkForest)
659 setBuildMode(cmdArgs.Bp2buildMarker, Bp2build)
660 setBuildMode(cmdArgs.BazelQueryViewDir, GenerateQueryView)
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500661 setBuildMode(cmdArgs.ModuleGraphFile, GenerateModuleGraph)
662 setBuildMode(cmdArgs.DocFile, GenerateDocFile)
Usta Shresthacae3bfa2022-12-21 11:44:26 -0500663 setBazelMode(cmdArgs.BazelMode, "--bazel-mode", BazelProdMode)
664 setBazelMode(cmdArgs.BazelModeStaging, "--bazel-mode-staging", BazelStagingMode)
Sasha Smundakaf5ca922022-12-12 21:23:34 -0800665
MarkDacek1de78f32023-05-02 21:00:48 +0000666 for _, module := range getForceEnabledModulesFromFlag(cmdArgs.BazelForceEnabledModules) {
MarkDacekd06db5d2022-11-29 00:47:59 +0000667 config.bazelForceEnabledModules[module] = struct{}{}
668 }
MarkDacek9c094ca2023-03-16 19:15:19 +0000669 config.BazelContext, err = NewBazelContext(config)
670 config.Bp2buildPackageConfig = GetBp2BuildAllowList()
MarkDacekd06db5d2022-11-29 00:47:59 +0000671
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000672 // TODO(b/276958307): Replace the hardcoded list to a sdk_library local prop.
673 config.apiLibraries = map[string]struct{}{
674 "android.net.ipsec.ike": {},
675 "art.module.public.api": {},
676 "conscrypt.module.public.api": {},
677 "framework-adservices": {},
678 "framework-appsearch": {},
679 "framework-bluetooth": {},
680 "framework-connectivity": {},
681 "framework-connectivity-t": {},
682 "framework-graphics": {},
Mark White387a6582023-08-06 00:20:47 +0000683 "framework-location": {},
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000684 "framework-media": {},
685 "framework-mediaprovider": {},
Roshan Pius92307ff2023-11-13 17:16:35 -0800686 "framework-nfc": {},
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000687 "framework-ondevicepersonalization": {},
Alyssa Ketpreechasawat9f634362023-11-08 16:03:53 +0000688 "framework-pdf": {},
Jihoon Kang1c92c3e2023-03-23 17:44:51 +0000689 "framework-permission": {},
690 "framework-permission-s": {},
691 "framework-scheduling": {},
692 "framework-sdkextensions": {},
693 "framework-statsd": {},
694 "framework-sdksandbox": {},
695 "framework-tethering": {},
696 "framework-uwb": {},
697 "framework-virtualization": {},
698 "framework-wifi": {},
699 "i18n.module.public.api": {},
700 }
701
Jihoon Kangc1b04d62023-11-16 19:07:04 +0000702 config.productVariables.Build_from_text_stub = boolPtr(config.BuildFromTextStub())
703
Jingwen Chenc711fec2020-11-22 23:52:50 -0500704 return Config{config}, err
705}
Colin Cross988414c2020-01-11 01:11:46 +0000706
MarkDacek1de78f32023-05-02 21:00:48 +0000707func getForceEnabledModulesFromFlag(forceEnabledFlag string) []string {
708 if forceEnabledFlag == "" {
709 return []string{}
710 }
711 return strings.Split(forceEnabledFlag, ",")
712}
713
Colin Cross98be1bb2019-12-13 20:41:13 -0800714// mockFileSystem replaces all reads with accesses to the provided map of
715// filenames to contents stored as a byte slice.
716func (c *config) mockFileSystem(bp string, fs map[string][]byte) {
717 mockFS := map[string][]byte{}
718
719 if _, exists := mockFS["Android.bp"]; !exists {
720 mockFS["Android.bp"] = []byte(bp)
721 }
722
723 for k, v := range fs {
724 mockFS[k] = v
725 }
726
727 // no module list file specified; find every file named Blueprints or Android.bp
728 pathsToParse := []string{}
729 for candidate := range mockFS {
730 base := filepath.Base(candidate)
Lukacs T. Berkib838b0a2021-09-02 11:46:24 +0200731 if base == "Android.bp" {
Colin Cross98be1bb2019-12-13 20:41:13 -0800732 pathsToParse = append(pathsToParse, candidate)
733 }
734 }
735 if len(pathsToParse) < 1 {
736 panic(fmt.Sprintf("No Blueprint or Android.bp files found in mock filesystem: %v\n", mockFS))
737 }
738 mockFS[blueprint.MockModuleListFile] = []byte(strings.Join(pathsToParse, "\n"))
739
740 c.fs = pathtools.MockFs(mockFS)
741 c.mockBpList = blueprint.MockModuleListFile
742}
743
Jason Wuff1bb312022-12-21 09:57:26 -0500744// TODO(b/265062549): Add a field to our collected (and uploaded) metrics which
745// describes a reason that we fell back to non-mixed builds.
Chris Parsonsad876012022-08-20 14:48:32 -0400746// Returns true if "Bazel builds" is enabled. In this mode, part of build
747// analysis is handled by Bazel.
748func (c *config) IsMixedBuildsEnabled() bool {
Chris Parsons428c30f2022-11-29 14:14:52 -0500749 globalMixedBuildsSupport := c.Once(OnceKey{"globalMixedBuildsSupport"}, func() interface{} {
750 if c.productVariables.DeviceArch != nil && *c.productVariables.DeviceArch == "riscv64" {
Chris Parsons428c30f2022-11-29 14:14:52 -0500751 return false
752 }
Liz Kammer36ba6b22023-06-29 10:18:39 -0400753 // Disable Bazel when Kythe is running
754 if c.EmitXrefRules() {
755 return false
756 }
Sam Delmerico5150d0d2022-11-15 17:44:44 -0500757 if c.IsEnvTrue("GLOBAL_THINLTO") {
Sam Delmerico5150d0d2022-11-15 17:44:44 -0500758 return false
759 }
Sam Delmerico5150d0d2022-11-15 17:44:44 -0500760 if len(c.productVariables.SanitizeHost) > 0 {
Sam Delmerico5150d0d2022-11-15 17:44:44 -0500761 return false
762 }
763 if len(c.productVariables.SanitizeDevice) > 0 {
Sam Delmerico5150d0d2022-11-15 17:44:44 -0500764 return false
765 }
766 if len(c.productVariables.SanitizeDeviceDiag) > 0 {
Sam Delmerico5150d0d2022-11-15 17:44:44 -0500767 return false
768 }
769 if len(c.productVariables.SanitizeDeviceArch) > 0 {
Sam Delmerico5150d0d2022-11-15 17:44:44 -0500770 return false
771 }
Chris Parsons428c30f2022-11-29 14:14:52 -0500772 return true
773 }).(bool)
774
Chris Parsons21f80272023-06-15 04:02:28 +0000775 bazelModeEnabled := c.BuildMode == BazelProdMode || c.BuildMode == BazelStagingMode
Chris Parsons428c30f2022-11-29 14:14:52 -0500776 return globalMixedBuildsSupport && bazelModeEnabled
Chris Parsonsad876012022-08-20 14:48:32 -0400777}
778
Lukacs T. Berkid1e3f1f2021-03-16 08:55:23 +0100779func (c *config) SetAllowMissingDependencies() {
780 c.productVariables.Allow_missing_dependencies = proptools.BoolPtr(true)
781}
782
Jingwen Chenc711fec2020-11-22 23:52:50 -0500783// BlueprintToolLocation returns the directory containing build system tools
784// from Blueprint, like soong_zip and merge_zips.
Lukacs T. Berkia806e412021-09-01 08:57:48 +0200785func (c *config) HostToolDir() string {
Colin Crossacfcc1f2021-10-25 15:40:32 -0700786 if c.KatiEnabled() {
787 return filepath.Join(c.outDir, "host", c.PrebuiltOS(), "bin")
788 } else {
789 return filepath.Join(c.soongOutDir, "host", c.PrebuiltOS(), "bin")
790 }
Dan Willemsenc2aa4a92016-05-26 15:13:03 -0700791}
792
Dan Willemsen60e62f02018-11-16 21:05:32 -0800793func (c *config) HostToolPath(ctx PathContext, tool string) Path {
Cole Faust3b703f32023-10-16 13:30:51 -0700794 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "bin", tool)
Colin Cross790ef352021-10-25 19:15:55 -0700795 return path
Dan Willemsen60e62f02018-11-16 21:05:32 -0800796}
797
Colin Cross790ef352021-10-25 19:15:55 -0700798func (c *config) HostJNIToolPath(ctx PathContext, lib string) Path {
Martin Stjernholm7260d062019-12-09 21:47:14 +0000799 ext := ".so"
800 if runtime.GOOS == "darwin" {
801 ext = ".dylib"
802 }
Cole Faust3b703f32023-10-16 13:30:51 -0700803 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "lib64", lib+ext)
Colin Cross790ef352021-10-25 19:15:55 -0700804 return path
Martin Stjernholm7260d062019-12-09 21:47:14 +0000805}
806
Colin Crossae5330a2021-11-03 13:31:22 -0700807func (c *config) HostJavaToolPath(ctx PathContext, tool string) Path {
Cole Faust3b703f32023-10-16 13:30:51 -0700808 path := pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, "framework", tool)
Colin Cross3e3eda62021-11-04 10:22:51 -0700809 return path
810}
811
Vinh Tran09581952023-05-16 16:03:20 -0400812func (c *config) HostCcSharedLibPath(ctx PathContext, lib string) Path {
813 libDir := "lib"
814 if ctx.Config().BuildArch.Multilib == "lib64" {
815 libDir = "lib64"
816 }
Cole Faust3b703f32023-10-16 13:30:51 -0700817 return pathForInstall(ctx, ctx.Config().BuildOS, ctx.Config().BuildArch, libDir, lib+".so")
Vinh Tran09581952023-05-16 16:03:20 -0400818}
819
Jingwen Chenc711fec2020-11-22 23:52:50 -0500820// PrebuiltOS returns the name of the host OS used in prebuilts directories.
Colin Cross1332b002015-04-07 17:11:30 -0700821func (c *config) PrebuiltOS() string {
Colin Cross3f40fa42015-01-30 17:27:36 -0800822 switch runtime.GOOS {
823 case "linux":
824 return "linux-x86"
825 case "darwin":
826 return "darwin-x86"
827 default:
828 panic("Unknown GOOS")
829 }
830}
831
832// GoRoot returns the path to the root directory of the Go toolchain.
Colin Cross1332b002015-04-07 17:11:30 -0700833func (c *config) GoRoot() string {
Lukacs T. Berkif7e36d82021-08-16 17:05:09 +0200834 return fmt.Sprintf("prebuilts/go/%s", c.PrebuiltOS())
Colin Cross3f40fa42015-01-30 17:27:36 -0800835}
836
Jingwen Chenc711fec2020-11-22 23:52:50 -0500837// PrebuiltBuildTool returns the path to a tool in the prebuilts directory containing
838// checked-in tools, like Kati, Ninja or Toybox, for the current host OS.
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700839func (c *config) PrebuiltBuildTool(ctx PathContext, tool string) Path {
840 return PathForSource(ctx, "prebuilts/build-tools", c.PrebuiltOS(), "bin", tool)
841}
842
Jingwen Chenc711fec2020-11-22 23:52:50 -0500843// CpPreserveSymlinksFlags returns the host-specific flag for the cp(1) command
844// to preserve symlinks.
Colin Cross1332b002015-04-07 17:11:30 -0700845func (c *config) CpPreserveSymlinksFlags() string {
Colin Cross485e5722015-08-27 13:28:01 -0700846 switch runtime.GOOS {
Colin Cross3f40fa42015-01-30 17:27:36 -0800847 case "darwin":
848 return "-R"
849 case "linux":
850 return "-d"
851 default:
852 return ""
853 }
854}
Colin Cross68f55102015-03-25 14:43:57 -0700855
Colin Cross1332b002015-04-07 17:11:30 -0700856func (c *config) Getenv(key string) string {
Colin Cross68f55102015-03-25 14:43:57 -0700857 var val string
858 var exists bool
Colin Crossc1e86a32015-04-15 12:33:28 -0700859 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800860 defer c.envLock.Unlock()
861 if c.envDeps == nil {
862 c.envDeps = make(map[string]string)
863 }
Colin Cross68f55102015-03-25 14:43:57 -0700864 if val, exists = c.envDeps[key]; !exists {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700865 if c.envFrozen {
866 panic("Cannot access new environment variables after envdeps are frozen")
867 }
Colin Cross6ccbc912017-10-10 23:07:38 -0700868 val, _ = c.env[key]
Colin Cross68f55102015-03-25 14:43:57 -0700869 c.envDeps[key] = val
870 }
871 return val
872}
873
Colin Cross99d7c232016-11-23 16:52:04 -0800874func (c *config) GetenvWithDefault(key string, defaultValue string) string {
875 ret := c.Getenv(key)
876 if ret == "" {
877 return defaultValue
878 }
879 return ret
880}
881
882func (c *config) IsEnvTrue(key string) bool {
883 value := c.Getenv(key)
884 return value == "1" || value == "y" || value == "yes" || value == "on" || value == "true"
885}
886
887func (c *config) IsEnvFalse(key string) bool {
888 value := c.Getenv(key)
889 return value == "0" || value == "n" || value == "no" || value == "off" || value == "false"
890}
891
Jingwen Chenc711fec2020-11-22 23:52:50 -0500892// EnvDeps returns the environment variables this build depends on. The first
893// call to this function blocks future reads from the environment.
Colin Cross1332b002015-04-07 17:11:30 -0700894func (c *config) EnvDeps() map[string]string {
Dan Willemsene7680ba2015-09-11 17:06:19 -0700895 c.envLock.Lock()
Colin Crossc0d58b42017-02-06 15:40:41 -0800896 defer c.envLock.Unlock()
Dan Willemsene7680ba2015-09-11 17:06:19 -0700897 c.envFrozen = true
Colin Cross68f55102015-03-25 14:43:57 -0700898 return c.envDeps
899}
Colin Cross35cec122015-04-02 14:37:16 -0700900
Jingwen Chencda22c92020-11-23 00:22:30 -0500901func (c *config) KatiEnabled() bool {
902 return c.katiEnabled
Dan Willemsen5ba07e82015-12-11 13:51:06 -0800903}
904
Cole Faust11edf552023-10-13 11:32:14 -0700905func (c *config) ProductVariables() ProductVariables {
906 return c.productVariables
907}
908
Nan Zhang581fd212018-01-10 16:06:12 -0800909func (c *config) BuildId() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800910 return String(c.productVariables.BuildId)
Nan Zhang581fd212018-01-10 16:06:12 -0800911}
912
Jingwen Chenc711fec2020-11-22 23:52:50 -0500913// BuildNumberFile returns the path to a text file containing metadata
914// representing the current build's number.
915//
916// Rules that want to reference the build number should read from this file
917// without depending on it. They will run whenever their other dependencies
918// require them to run and get the current build number. This ensures they don't
919// rebuild on every incremental build when the build number changes.
Colin Cross2a2e0db2020-02-21 16:55:46 -0800920func (c *config) BuildNumberFile(ctx PathContext) Path {
921 return PathForOutput(ctx, String(c.productVariables.BuildNumberFile))
Nan Zhang581fd212018-01-10 16:06:12 -0800922}
923
Jingwen Chenc711fec2020-11-22 23:52:50 -0500924// DeviceName returns the name of the current device target.
Colin Cross35cec122015-04-02 14:37:16 -0700925// TODO: take an AndroidModuleContext to select the device name for multi-device builds
Colin Cross1332b002015-04-07 17:11:30 -0700926func (c *config) DeviceName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -0800927 return *c.productVariables.DeviceName
Colin Cross35cec122015-04-02 14:37:16 -0700928}
929
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000930// DeviceProduct returns the current product target. There could be multiple of
931// these per device type.
932//
Chris Parsonsef615e52022-08-18 22:04:11 -0400933// NOTE: Do not base conditional logic on this value. It may break product inheritance.
Trevor Radcliffe90727f42022-03-21 19:34:02 +0000934func (c *config) DeviceProduct() string {
935 return *c.productVariables.DeviceProduct
936}
937
Cole Faustb85d1a12022-11-08 18:14:01 -0800938// HasDeviceProduct returns if the build has a product. A build will not
939// necessarily have a product when --skip-config is passed to soong, like it is
940// in prebuilts/build-tools/build-prebuilts.sh
941func (c *config) HasDeviceProduct() bool {
942 return c.productVariables.DeviceProduct != nil
943}
944
Anton Hansson53c88442019-03-18 15:53:16 +0000945func (c *config) DeviceResourceOverlays() []string {
946 return c.productVariables.DeviceResourceOverlays
947}
948
949func (c *config) ProductResourceOverlays() []string {
950 return c.productVariables.ProductResourceOverlays
Colin Cross30e076a2015-04-13 13:58:27 -0700951}
952
Colin Crossbfd347d2018-05-09 11:11:35 -0700953func (c *config) PlatformVersionName() string {
954 return String(c.productVariables.Platform_version_name)
955}
956
Dan Albert4f378d72020-07-23 17:32:15 -0700957func (c *config) PlatformSdkVersion() ApiLevel {
958 return uncheckedFinalApiLevel(*c.productVariables.Platform_sdk_version)
Colin Cross30e076a2015-04-13 13:58:27 -0700959}
960
Cole Faust37d27c42023-04-12 10:27:45 -0700961func (c *config) RawPlatformSdkVersion() *int {
962 return c.productVariables.Platform_sdk_version
963}
964
Mu-Le Lee5e047532022-07-27 02:32:03 +0000965func (c *config) PlatformSdkFinal() bool {
966 return Bool(c.productVariables.Platform_sdk_final)
967}
968
Colin Crossd09b0b62018-04-18 11:06:47 -0700969func (c *config) PlatformSdkCodename() string {
970 return String(c.productVariables.Platform_sdk_codename)
971}
972
Anton Hansson97d0bae2022-02-16 16:15:10 +0000973func (c *config) PlatformSdkExtensionVersion() int {
974 return *c.productVariables.Platform_sdk_extension_version
975}
976
977func (c *config) PlatformBaseSdkExtensionVersion() int {
978 return *c.productVariables.Platform_base_sdk_extension_version
979}
980
Colin Cross092c9da2019-04-02 22:56:43 -0700981func (c *config) PlatformSecurityPatch() string {
982 return String(c.productVariables.Platform_security_patch)
983}
984
985func (c *config) PlatformPreviewSdkVersion() string {
986 return String(c.productVariables.Platform_preview_sdk_version)
987}
988
989func (c *config) PlatformMinSupportedTargetSdkVersion() string {
990 return String(c.productVariables.Platform_min_supported_target_sdk_version)
991}
992
993func (c *config) PlatformBaseOS() string {
994 return String(c.productVariables.Platform_base_os)
995}
996
Inseob Kim4f1f3d92022-04-25 18:23:58 +0900997func (c *config) PlatformVersionLastStable() string {
998 return String(c.productVariables.Platform_version_last_stable)
999}
1000
Jiyong Park37073842022-06-21 10:13:42 +09001001func (c *config) PlatformVersionKnownCodenames() string {
1002 return String(c.productVariables.Platform_version_known_codenames)
1003}
1004
Dan Albert1a246272020-07-06 14:49:35 -07001005func (c *config) MinSupportedSdkVersion() ApiLevel {
Dan Albert6bfb6bb2022-08-17 20:11:57 +00001006 return uncheckedFinalApiLevel(21)
Dan Albert1a246272020-07-06 14:49:35 -07001007}
1008
1009func (c *config) FinalApiLevels() []ApiLevel {
1010 var levels []ApiLevel
Dan Albert4f378d72020-07-23 17:32:15 -07001011 for i := 1; i <= c.PlatformSdkVersion().FinalOrFutureInt(); i++ {
Dan Albert1a246272020-07-06 14:49:35 -07001012 levels = append(levels, uncheckedFinalApiLevel(i))
1013 }
1014 return levels
1015}
1016
1017func (c *config) PreviewApiLevels() []ApiLevel {
1018 var levels []ApiLevel
Dan Albertf93ea132023-10-05 20:40:46 +00001019 i := 0
1020 for _, codename := range c.PlatformVersionActiveCodenames() {
1021 if codename == "REL" {
1022 continue
1023 }
1024
Dan Albert1a246272020-07-06 14:49:35 -07001025 levels = append(levels, ApiLevel{
1026 value: codename,
1027 number: i,
1028 isPreview: true,
1029 })
Dan Albertf93ea132023-10-05 20:40:46 +00001030 i++
Dan Albert1a246272020-07-06 14:49:35 -07001031 }
1032 return levels
1033}
1034
satayevcca4ab72021-11-30 12:33:55 +00001035func (c *config) LatestPreviewApiLevel() ApiLevel {
1036 level := NoneApiLevel
1037 for _, l := range c.PreviewApiLevels() {
1038 if l.GreaterThan(level) {
1039 level = l
1040 }
1041 }
1042 return level
1043}
1044
Dan Albert1a246272020-07-06 14:49:35 -07001045func (c *config) AllSupportedApiLevels() []ApiLevel {
1046 var levels []ApiLevel
1047 levels = append(levels, c.FinalApiLevels()...)
1048 return append(levels, c.PreviewApiLevels()...)
Dan Albertf5415d72017-08-17 16:19:59 -07001049}
1050
Jingwen Chenc711fec2020-11-22 23:52:50 -05001051// DefaultAppTargetSdk returns the API level that platform apps are targeting.
1052// This converts a codename to the exact ApiLevel it represents.
Dan Albert4f378d72020-07-23 17:32:15 -07001053func (c *config) DefaultAppTargetSdk(ctx EarlyModuleContext) ApiLevel {
Alixfb7f7b92023-03-02 19:35:02 +00001054 // This logic is replicated in starlark, if changing logic here update starlark code too
1055 // 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 -07001056 if Bool(c.productVariables.Platform_sdk_final) {
1057 return c.PlatformSdkVersion()
Colin Crossd09b0b62018-04-18 11:06:47 -07001058 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001059 codename := c.PlatformSdkCodename()
Jiyong Park3a00e3d2023-03-27 17:39:48 +09001060 hostOnlyBuild := c.productVariables.DeviceArch == nil
Jingwen Chenc711fec2020-11-22 23:52:50 -05001061 if codename == "" {
Jiyong Park3a00e3d2023-03-27 17:39:48 +09001062 // There are some host-only builds (those are invoked by build-prebuilts.sh) which
1063 // don't set platform sdk codename. Platform sdk codename makes sense only when we
1064 // are building the platform. So we don't enforce the below panic for the host-only
1065 // builds.
1066 if hostOnlyBuild {
1067 return NoneApiLevel
1068 }
1069 panic("Platform_sdk_codename must be set")
Jingwen Chenc711fec2020-11-22 23:52:50 -05001070 }
1071 if codename == "REL" {
1072 panic("Platform_sdk_codename should not be REL when Platform_sdk_final is true")
1073 }
1074 return ApiLevelOrPanic(ctx, codename)
Colin Crossd09b0b62018-04-18 11:06:47 -07001075}
1076
Colin Cross3bc7ffa2017-11-22 16:19:37 -08001077func (c *config) AppsDefaultVersionName() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001078 return String(c.productVariables.AppsDefaultVersionName)
Colin Cross3bc7ffa2017-11-22 16:19:37 -08001079}
1080
Dan Albert31384de2017-07-28 12:39:46 -07001081// Codenames that are active in the current lunch target.
1082func (c *config) PlatformVersionActiveCodenames() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001083 return c.productVariables.Platform_version_active_codenames
Dan Albert31384de2017-07-28 12:39:46 -07001084}
1085
Dan Albert8c7a9942023-03-27 20:34:01 +00001086// All unreleased codenames.
1087func (c *config) PlatformVersionAllPreviewCodenames() []string {
1088 return c.productVariables.Platform_version_all_preview_codenames
1089}
1090
Colin Crossface4e42017-10-30 17:32:15 -07001091func (c *config) ProductAAPTConfig() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001092 return c.productVariables.AAPTConfig
Colin Cross30e076a2015-04-13 13:58:27 -07001093}
1094
Colin Crossface4e42017-10-30 17:32:15 -07001095func (c *config) ProductAAPTPreferredConfig() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001096 return String(c.productVariables.AAPTPreferredConfig)
Colin Cross30e076a2015-04-13 13:58:27 -07001097}
1098
Colin Crossface4e42017-10-30 17:32:15 -07001099func (c *config) ProductAAPTCharacteristics() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001100 return String(c.productVariables.AAPTCharacteristics)
Colin Crossface4e42017-10-30 17:32:15 -07001101}
1102
1103func (c *config) ProductAAPTPrebuiltDPI() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001104 return c.productVariables.AAPTPrebuiltDPI
Colin Cross30e076a2015-04-13 13:58:27 -07001105}
1106
Dan Willemsen34cc69e2015-09-23 15:26:20 -07001107func (c *config) DefaultAppCertificateDir(ctx PathContext) SourcePath {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001108 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -08001109 if defaultCert != "" {
1110 return PathForSource(ctx, filepath.Dir(defaultCert))
Colin Cross61ae0b72017-12-01 17:16:02 -08001111 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001112 return PathForSource(ctx, "build/make/target/product/security")
Colin Cross30e076a2015-04-13 13:58:27 -07001113}
1114
Colin Crosse1731a52017-12-14 11:22:55 -08001115func (c *config) DefaultAppCertificate(ctx PathContext) (pem, key SourcePath) {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001116 defaultCert := String(c.productVariables.DefaultAppCertificate)
Colin Cross61ae0b72017-12-01 17:16:02 -08001117 if defaultCert != "" {
Colin Crosse1731a52017-12-14 11:22:55 -08001118 return PathForSource(ctx, defaultCert+".x509.pem"), PathForSource(ctx, defaultCert+".pk8")
Colin Cross61ae0b72017-12-01 17:16:02 -08001119 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001120 defaultDir := c.DefaultAppCertificateDir(ctx)
1121 return defaultDir.Join(ctx, "testkey.x509.pem"), defaultDir.Join(ctx, "testkey.pk8")
Colin Cross30e076a2015-04-13 13:58:27 -07001122}
Colin Cross6ff51382015-12-17 16:39:19 -08001123
Jiyong Park9335a262018-12-24 11:31:58 +09001124func (c *config) ApexKeyDir(ctx ModuleContext) SourcePath {
1125 // TODO(b/121224311): define another variable such as TARGET_APEX_KEY_OVERRIDE
1126 defaultCert := String(c.productVariables.DefaultAppCertificate)
Dan Willemsen412160e2019-04-09 21:36:26 -07001127 if defaultCert == "" || filepath.Dir(defaultCert) == "build/make/target/product/security" {
Jiyong Park9335a262018-12-24 11:31:58 +09001128 // When defaultCert is unset or is set to the testkeys path, use the APEX keys
1129 // that is under the module dir
Colin Cross07e51612019-03-05 12:46:40 -08001130 return pathForModuleSrc(ctx)
Jiyong Park9335a262018-12-24 11:31:58 +09001131 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001132 // If not, APEX keys are under the specified directory
1133 return PathForSource(ctx, filepath.Dir(defaultCert))
Jiyong Park9335a262018-12-24 11:31:58 +09001134}
1135
Inseob Kim80fa7982022-08-12 21:36:25 +09001136// Certificate for the NetworkStack sepolicy context
1137func (c *config) MainlineSepolicyDevCertificatesDir(ctx ModuleContext) SourcePath {
1138 cert := String(c.productVariables.MainlineSepolicyDevCertificates)
1139 if cert != "" {
1140 return PathForSource(ctx, cert)
1141 }
1142 return c.DefaultAppCertificateDir(ctx)
1143}
1144
Jingwen Chenc711fec2020-11-22 23:52:50 -05001145// AllowMissingDependencies configures Blueprint/Soong to not fail when modules
1146// are configured to depend on non-existent modules. Note that this does not
1147// affect missing input dependencies at the Ninja level.
Colin Cross6ff51382015-12-17 16:39:19 -08001148func (c *config) AllowMissingDependencies() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001149 return Bool(c.productVariables.Allow_missing_dependencies)
Colin Cross6ff51382015-12-17 16:39:19 -08001150}
Dan Willemsen322acaf2016-01-12 23:07:05 -08001151
Jeongik Cha816a23a2020-07-08 01:09:23 +09001152// Returns true if a full platform source tree cannot be assumed.
Colin Crossfc3674a2017-09-18 17:41:52 -07001153func (c *config) UnbundledBuild() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001154 return Bool(c.productVariables.Unbundled_build)
Colin Crossfc3674a2017-09-18 17:41:52 -07001155}
1156
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +01001157// Returns true if building apps that aren't bundled with the platform.
1158// UnbundledBuild() is always true when this is true.
1159func (c *config) UnbundledBuildApps() bool {
Cole Faust701ca252021-11-23 19:02:08 -08001160 return len(c.productVariables.Unbundled_build_apps) > 0
Martin Stjernholmfd9eb4b2020-06-17 01:13:15 +01001161}
1162
Jeongik Cha4b073cd2021-06-08 11:35:00 +09001163// Returns true if building image that aren't bundled with the platform.
1164// UnbundledBuild() is always true when this is true.
1165func (c *config) UnbundledBuildImage() bool {
1166 return Bool(c.productVariables.Unbundled_build_image)
1167}
1168
Jeongik Cha816a23a2020-07-08 01:09:23 +09001169// Returns true if building modules against prebuilt SDKs.
1170func (c *config) AlwaysUsePrebuiltSdks() bool {
1171 return Bool(c.productVariables.Always_use_prebuilt_sdks)
Colin Cross1f367bf2018-12-18 22:46:24 -08001172}
1173
Colin Cross126a25c2017-10-31 13:55:34 -07001174func (c *config) MinimizeJavaDebugInfo() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001175 return Bool(c.productVariables.MinimizeJavaDebugInfo) && !Bool(c.productVariables.Eng)
Colin Cross126a25c2017-10-31 13:55:34 -07001176}
1177
Colin Crossed064c02018-09-05 16:28:13 -07001178func (c *config) Debuggable() bool {
1179 return Bool(c.productVariables.Debuggable)
1180}
1181
Jaewoong Jung1d6eb682018-11-29 15:08:44 -08001182func (c *config) Eng() bool {
1183 return Bool(c.productVariables.Eng)
1184}
1185
Colin Crossc53c37f2021-12-08 15:42:22 -08001186// DevicePrimaryArchType returns the ArchType for the first configured device architecture, or
1187// Common if there are no device architectures.
Jiyong Park8d52f862018-07-07 18:02:07 +09001188func (c *config) DevicePrimaryArchType() ArchType {
Colin Crossc53c37f2021-12-08 15:42:22 -08001189 if androidTargets := c.Targets[Android]; len(androidTargets) > 0 {
1190 return androidTargets[0].Arch.ArchType
1191 }
1192 return Common
Jiyong Park8d52f862018-07-07 18:02:07 +09001193}
1194
Colin Cross16b23492016-01-06 14:41:07 -08001195func (c *config) SanitizeHost() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001196 return append([]string(nil), c.productVariables.SanitizeHost...)
Colin Cross16b23492016-01-06 14:41:07 -08001197}
1198
1199func (c *config) SanitizeDevice() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001200 return append([]string(nil), c.productVariables.SanitizeDevice...)
Colin Cross23ae82a2016-11-02 14:34:39 -07001201}
1202
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -07001203func (c *config) SanitizeDeviceDiag() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001204 return append([]string(nil), c.productVariables.SanitizeDeviceDiag...)
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -07001205}
1206
Colin Cross23ae82a2016-11-02 14:34:39 -07001207func (c *config) SanitizeDeviceArch() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001208 return append([]string(nil), c.productVariables.SanitizeDeviceArch...)
Colin Cross16b23492016-01-06 14:41:07 -08001209}
Colin Crossa1ad8d12016-06-01 17:09:44 -07001210
Vishwath Mohan1b017a72017-01-19 13:54:55 -08001211func (c *config) EnableCFI() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001212 if c.productVariables.EnableCFI == nil {
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -08001213 return true
Vishwath Mohanc32c3eb2017-01-24 14:20:54 -08001214 }
Jingwen Chenc711fec2020-11-22 23:52:50 -05001215 return *c.productVariables.EnableCFI
Vishwath Mohan1b017a72017-01-19 13:54:55 -08001216}
1217
Kostya Kortchinskyd5275c82019-02-01 08:42:56 -08001218func (c *config) DisableScudo() bool {
1219 return Bool(c.productVariables.DisableScudo)
1220}
1221
Colin Crossa1ad8d12016-06-01 17:09:44 -07001222func (c *config) Android64() bool {
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001223 for _, t := range c.Targets[Android] {
Colin Crossa1ad8d12016-06-01 17:09:44 -07001224 if t.Arch.ArchType.Multilib == "lib64" {
1225 return true
1226 }
1227 }
1228
1229 return false
1230}
Colin Cross9272ade2016-08-17 15:24:12 -07001231
Colin Cross9d45bb72016-08-29 16:14:13 -07001232func (c *config) UseGoma() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001233 return Bool(c.productVariables.UseGoma)
Colin Cross9d45bb72016-08-29 16:14:13 -07001234}
1235
Ramy Medhatbbf25672019-07-17 12:30:04 +00001236func (c *config) UseRBE() bool {
1237 return Bool(c.productVariables.UseRBE)
1238}
1239
Ramy Medhat8ea054a2020-01-27 14:19:44 -05001240func (c *config) UseRBEJAVAC() bool {
1241 return Bool(c.productVariables.UseRBEJAVAC)
1242}
1243
1244func (c *config) UseRBER8() bool {
1245 return Bool(c.productVariables.UseRBER8)
1246}
1247
1248func (c *config) UseRBED8() bool {
1249 return Bool(c.productVariables.UseRBED8)
1250}
1251
Colin Cross8b8bec32019-11-15 13:18:43 -08001252func (c *config) UseRemoteBuild() bool {
1253 return c.UseGoma() || c.UseRBE()
1254}
1255
Colin Cross66548102018-06-19 22:47:35 -07001256func (c *config) RunErrorProne() bool {
1257 return c.IsEnvTrue("RUN_ERROR_PRONE")
1258}
1259
Jingwen Chenc711fec2020-11-22 23:52:50 -05001260// XrefCorpusName returns the Kythe cross-reference corpus name.
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001261func (c *config) XrefCorpusName() string {
1262 return c.Getenv("XREF_CORPUS")
1263}
1264
Jingwen Chenc711fec2020-11-22 23:52:50 -05001265// XrefCuEncoding returns the compilation unit encoding to use for Kythe code
1266// xrefs. Can be 'json' (default), 'proto' or 'all'.
Sasha Smundak6c2d4f92020-01-09 17:34:23 -08001267func (c *config) XrefCuEncoding() string {
1268 if enc := c.Getenv("KYTHE_KZIP_ENCODING"); enc != "" {
1269 return enc
1270 }
1271 return "json"
1272}
1273
Sasha Smundakb0addaf2021-02-16 10:39:40 -08001274// XrefCuJavaSourceMax returns the maximum number of the Java source files
1275// in a single compilation unit
1276const xrefJavaSourceFileMaxDefault = "1000"
1277
1278func (c Config) XrefCuJavaSourceMax() string {
1279 v := c.Getenv("KYTHE_JAVA_SOURCE_BATCH_SIZE")
1280 if v == "" {
1281 return xrefJavaSourceFileMaxDefault
1282 }
1283 if _, err := strconv.ParseUint(v, 0, 0); err != nil {
1284 fmt.Fprintf(os.Stderr,
1285 "bad KYTHE_JAVA_SOURCE_BATCH_SIZE value: %s, will use %s",
1286 err, xrefJavaSourceFileMaxDefault)
1287 return xrefJavaSourceFileMaxDefault
1288 }
1289 return v
1290
1291}
1292
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001293func (c *config) EmitXrefRules() bool {
1294 return c.XrefCorpusName() != ""
1295}
1296
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001297func (c *config) ClangTidy() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001298 return Bool(c.productVariables.ClangTidy)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001299}
1300
1301func (c *config) TidyChecks() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001302 if c.productVariables.TidyChecks == nil {
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001303 return ""
1304 }
Dan Willemsen45133ac2018-03-09 21:22:06 -08001305 return *c.productVariables.TidyChecks
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001306}
1307
Colin Cross0f4e0d62016-07-27 10:56:55 -07001308func (c *config) LibartImgHostBaseAddress() string {
1309 return "0x60000000"
1310}
1311
1312func (c *config) LibartImgDeviceBaseAddress() string {
Elliott Hughesda3a0712020-03-06 16:55:28 -08001313 return "0x70000000"
Colin Cross0f4e0d62016-07-27 10:56:55 -07001314}
1315
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001316func (c *config) ArtUseReadBarrier() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001317 return Bool(c.productVariables.ArtUseReadBarrier)
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -08001318}
1319
Jingwen Chenc711fec2020-11-22 23:52:50 -05001320// Enforce Runtime Resource Overlays for a module. RROs supersede static RROs,
1321// but some modules still depend on it.
1322//
1323// More info: https://source.android.com/devices/architecture/rros
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001324func (c *config) EnforceRROForModule(name string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001325 enforceList := c.productVariables.EnforceRROTargets
Jeongik Chacee5ba92021-02-19 12:11:51 +09001326
Roland Levillainf6cc2612020-07-09 16:58:14 +01001327 if len(enforceList) > 0 {
Yo Chiang4ebd06a2019-10-01 13:13:41 +08001328 if InList("*", enforceList) {
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001329 return true
1330 }
Colin Crossa74ca042019-01-31 14:31:51 -08001331 return InList(name, enforceList)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001332 }
1333 return false
1334}
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001335func (c *config) EnforceRROExcludedOverlay(path string) bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001336 excluded := c.productVariables.EnforceRROExcludedOverlays
Roland Levillainf6cc2612020-07-09 16:58:14 +01001337 if len(excluded) > 0 {
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001338 return HasAnyPrefix(path, excluded)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001339 }
1340 return false
1341}
1342
1343func (c *config) ExportedNamespaces() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001344 return append([]string(nil), c.productVariables.NamespacesToExport...)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001345}
1346
Sam Delmerico98a73292023-02-21 11:50:29 -05001347func (c *config) SourceRootDirs() []string {
1348 return c.productVariables.SourceRootDirs
1349}
1350
Spandan Dasc5763832022-11-08 18:42:16 +00001351func (c *config) IncludeTags() []string {
1352 return c.productVariables.IncludeTags
1353}
1354
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001355func (c *config) HostStaticBinaries() bool {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001356 return Bool(c.productVariables.HostStaticBinaries)
Dan Willemsen3fb1fae2018-03-12 15:30:26 -07001357}
1358
Colin Cross5a0dcd52018-10-05 14:20:06 -07001359func (c *config) UncompressPrivAppDex() bool {
1360 return Bool(c.productVariables.UncompressPrivAppDex)
1361}
1362
1363func (c *config) ModulesLoadedByPrivilegedModules() []string {
1364 return c.productVariables.ModulesLoadedByPrivilegedModules
1365}
1366
Jingwen Chenc711fec2020-11-22 23:52:50 -05001367// DexpreoptGlobalConfigPath returns the path to the dexpreopt.config file in
1368// the output directory, if it was created during the product configuration
1369// phase by Kati.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001370func (c *config) DexpreoptGlobalConfigPath(ctx PathContext) OptionalPath {
Colin Cross988414c2020-01-11 01:11:46 +00001371 if c.productVariables.DexpreoptGlobalConfig == nil {
Jingwen Chenebb0b572020-11-02 00:24:57 -05001372 return OptionalPathForPath(nil)
1373 }
1374 return OptionalPathForPath(
1375 pathForBuildToolDep(ctx, *c.productVariables.DexpreoptGlobalConfig))
1376}
1377
Jingwen Chenc711fec2020-11-22 23:52:50 -05001378// DexpreoptGlobalConfig returns the raw byte contents of the dexpreopt global
1379// configuration. Since the configuration file was created by Kati during
1380// product configuration (externally of soong_build), it's not tracked, so we
1381// also manually add a Ninja file dependency on the configuration file to the
1382// rule that creates the main build.ninja file. This ensures that build.ninja is
1383// regenerated correctly if dexpreopt.config changes.
Jingwen Chenebb0b572020-11-02 00:24:57 -05001384func (c *config) DexpreoptGlobalConfig(ctx PathContext) ([]byte, error) {
1385 path := c.DexpreoptGlobalConfigPath(ctx)
1386 if !path.Valid() {
Colin Cross988414c2020-01-11 01:11:46 +00001387 return nil, nil
1388 }
Jingwen Chenebb0b572020-11-02 00:24:57 -05001389 ctx.AddNinjaFileDeps(path.String())
Sasha Smundakaf5ca922022-12-12 21:23:34 -08001390 return os.ReadFile(absolutePath(path.String()))
Colin Cross43f08db2018-11-12 10:13:39 -08001391}
1392
Inseob Kim7b85eeb2021-03-23 20:52:24 +09001393func (c *deviceConfig) WithDexpreopt() bool {
1394 return c.config.productVariables.WithDexpreopt
1395}
1396
Colin Cross662d6142022-11-03 20:38:01 -07001397func (c *config) FrameworksBaseDirExists(ctx PathGlobContext) bool {
Colin Cross5a756a62021-03-16 16:34:46 -07001398 return ExistentPathForSource(ctx, "frameworks", "base", "Android.bp").Valid()
David Brazdil91b4e3e2019-01-23 21:04:05 +00001399}
1400
Inseob Kimae553032019-05-14 18:52:49 +09001401func (c *config) VndkSnapshotBuildArtifacts() bool {
1402 return Bool(c.productVariables.VndkSnapshotBuildArtifacts)
1403}
1404
Colin Cross3b19f5d2019-09-17 14:45:31 -07001405func (c *config) HasMultilibConflict(arch ArchType) bool {
1406 return c.multilibConflicts[arch]
1407}
1408
Sasha Smundakaf5ca922022-12-12 21:23:34 -08001409func (c *config) PrebuiltHiddenApiDir(_ PathContext) string {
Bill Peckhambae47492021-01-08 09:34:44 -08001410 return String(c.productVariables.PrebuiltHiddenApiDir)
1411}
1412
MarkDacekd06db5d2022-11-29 00:47:59 +00001413func (c *config) BazelModulesForceEnabledByFlag() map[string]struct{} {
1414 return c.bazelForceEnabledModules
1415}
1416
Kiyoung Kime623c582023-07-06 16:43:44 +09001417func (c *config) IsVndkDeprecated() bool {
1418 return !Bool(c.productVariables.KeepVndk)
1419}
1420
Justin Yun41cbb5e2023-11-29 17:58:16 +09001421func (c *config) VendorApiLevel() string {
1422 return String(c.productVariables.VendorApiLevel)
1423}
1424
Colin Cross9272ade2016-08-17 15:24:12 -07001425func (c *deviceConfig) Arches() []Arch {
1426 var arches []Arch
Dan Willemsen0ef639b2018-10-10 17:02:29 -07001427 for _, target := range c.config.Targets[Android] {
Colin Cross9272ade2016-08-17 15:24:12 -07001428 arches = append(arches, target.Arch)
1429 }
1430 return arches
1431}
Dan Willemsend2ede872016-11-18 14:54:24 -08001432
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001433func (c *deviceConfig) BinderBitness() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001434 is32BitBinder := c.config.productVariables.Binder32bit
Jayant Chowdhary34ce67d2018-03-08 11:00:50 -08001435 if is32BitBinder != nil && *is32BitBinder {
1436 return "32"
1437 }
1438 return "64"
1439}
1440
Dan Willemsen4353bc42016-12-05 17:16:02 -08001441func (c *deviceConfig) VendorPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001442 if c.config.productVariables.VendorPath != nil {
1443 return *c.config.productVariables.VendorPath
Dan Willemsen4353bc42016-12-05 17:16:02 -08001444 }
1445 return "vendor"
1446}
1447
Justin Yun71549282017-11-17 12:10:28 +09001448func (c *deviceConfig) VndkVersion() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001449 return String(c.config.productVariables.DeviceVndkVersion)
Justin Yun71549282017-11-17 12:10:28 +09001450}
1451
Jose Galmes6f843bc2020-12-11 13:36:29 -08001452func (c *deviceConfig) RecoverySnapshotVersion() string {
1453 return String(c.config.productVariables.RecoverySnapshotVersion)
1454}
1455
Jeongik Cha219141c2020-08-06 23:00:37 +09001456func (c *deviceConfig) CurrentApiLevelForVendorModules() string {
1457 return StringDefault(c.config.productVariables.DeviceCurrentApiLevelForVendorModules, "current")
1458}
1459
Justin Yun8fe12122017-12-07 17:18:15 +09001460func (c *deviceConfig) PlatformVndkVersion() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001461 return String(c.config.productVariables.Platform_vndk_version)
Justin Yun8fe12122017-12-07 17:18:15 +09001462}
1463
Justin Yun71549282017-11-17 12:10:28 +09001464func (c *deviceConfig) ExtraVndkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001465 return c.config.productVariables.ExtraVndkVersions
Dan Willemsend2ede872016-11-18 14:54:24 -08001466}
Jack He8cc71432016-12-08 15:45:07 -08001467
Vic Yangefd249e2018-11-12 20:19:56 -08001468func (c *deviceConfig) VndkUseCoreVariant() bool {
Kiyoung Kim03b6cba2023-10-06 14:12:43 +09001469 return Bool(c.config.productVariables.VndkUseCoreVariant) && Bool(c.config.productVariables.KeepVndk)
Vic Yangefd249e2018-11-12 20:19:56 -08001470}
1471
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001472func (c *deviceConfig) SystemSdkVersions() []string {
Colin Crossa74ca042019-01-31 14:31:51 -08001473 return c.config.productVariables.DeviceSystemSdkVersions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001474}
1475
1476func (c *deviceConfig) PlatformSystemSdkVersions() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001477 return c.config.productVariables.Platform_systemsdk_versions
Jiyong Park1a5d7b12018-01-15 15:05:10 +09001478}
1479
Jiyong Park2db76922017-11-08 16:03:48 +09001480func (c *deviceConfig) OdmPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001481 if c.config.productVariables.OdmPath != nil {
1482 return *c.config.productVariables.OdmPath
Jiyong Park2db76922017-11-08 16:03:48 +09001483 }
1484 return "odm"
1485}
1486
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001487func (c *deviceConfig) ProductPath() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001488 if c.config.productVariables.ProductPath != nil {
1489 return *c.config.productVariables.ProductPath
Jiyong Park2db76922017-11-08 16:03:48 +09001490 }
Jaekyun Seok5cfbfbb2018-01-10 19:00:15 +09001491 return "product"
Jiyong Park2db76922017-11-08 16:03:48 +09001492}
1493
Justin Yund5f6c822019-06-25 16:47:17 +09001494func (c *deviceConfig) SystemExtPath() string {
1495 if c.config.productVariables.SystemExtPath != nil {
1496 return *c.config.productVariables.SystemExtPath
Dario Frenifd05a742018-05-29 13:28:54 +01001497 }
Justin Yund5f6c822019-06-25 16:47:17 +09001498 return "system_ext"
Dario Frenifd05a742018-05-29 13:28:54 +01001499}
1500
Jack He8cc71432016-12-08 15:45:07 -08001501func (c *deviceConfig) BtConfigIncludeDir() string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001502 return String(c.config.productVariables.BtConfigIncludeDir)
Jack He8cc71432016-12-08 15:45:07 -08001503}
Dan Willemsen581341d2017-02-09 16:16:31 -08001504
Jiyong Parkd773eb32017-07-03 13:18:12 +09001505func (c *deviceConfig) DeviceKernelHeaderDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001506 return c.config.productVariables.DeviceKernelHeaders
Jiyong Parkd773eb32017-07-03 13:18:12 +09001507}
1508
Roland Levillainada12702020-06-09 13:07:36 +01001509// JavaCoverageEnabledForPath returns whether Java code coverage is enabled for
1510// path. Coverage is enabled by default when the product variable
1511// JavaCoveragePaths is empty. If JavaCoveragePaths is not empty, coverage is
1512// enabled for any path which is part of this variable (and not part of the
1513// JavaCoverageExcludePaths product variable). Value "*" in JavaCoveragePaths
1514// represents any path.
1515func (c *deviceConfig) JavaCoverageEnabledForPath(path string) bool {
1516 coverage := false
Chris Gross2f748692020-06-24 20:36:59 +00001517 if len(c.config.productVariables.JavaCoveragePaths) == 0 ||
Roland Levillainada12702020-06-09 13:07:36 +01001518 InList("*", c.config.productVariables.JavaCoveragePaths) ||
1519 HasAnyPrefix(path, c.config.productVariables.JavaCoveragePaths) {
1520 coverage = true
1521 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001522 if coverage && len(c.config.productVariables.JavaCoverageExcludePaths) > 0 {
Roland Levillainada12702020-06-09 13:07:36 +01001523 if HasAnyPrefix(path, c.config.productVariables.JavaCoverageExcludePaths) {
1524 coverage = false
1525 }
1526 }
1527 return coverage
1528}
1529
Colin Cross1a6acd42020-06-16 17:51:46 -07001530// Returns true if gcov or clang coverage is enabled.
Dan Willemsen581341d2017-02-09 16:16:31 -08001531func (c *deviceConfig) NativeCoverageEnabled() bool {
Colin Cross1a6acd42020-06-16 17:51:46 -07001532 return Bool(c.config.productVariables.GcovCoverage) ||
1533 Bool(c.config.productVariables.ClangCoverage)
Dan Willemsen581341d2017-02-09 16:16:31 -08001534}
1535
Oliver Nguyen1382ab62019-12-06 15:22:41 -08001536func (c *deviceConfig) ClangCoverageEnabled() bool {
1537 return Bool(c.config.productVariables.ClangCoverage)
1538}
1539
Pirama Arumuga Nainarb37ae582022-01-26 22:14:32 -08001540func (c *deviceConfig) ClangCoverageContinuousMode() bool {
1541 return Bool(c.config.productVariables.ClangCoverageContinuousMode)
1542}
1543
Colin Cross1a6acd42020-06-16 17:51:46 -07001544func (c *deviceConfig) GcovCoverageEnabled() bool {
1545 return Bool(c.config.productVariables.GcovCoverage)
1546}
1547
Roland Levillain4f5297b2020-06-09 12:44:06 +01001548// NativeCoverageEnabledForPath returns whether (GCOV- or Clang-based) native
1549// code coverage is enabled for path. By default, coverage is not enabled for a
1550// given path unless it is part of the NativeCoveragePaths product variable (and
1551// not part of the NativeCoverageExcludePaths product variable). Value "*" in
1552// NativeCoveragePaths represents any path.
1553func (c *deviceConfig) NativeCoverageEnabledForPath(path string) bool {
Ryan Campbell469a18a2017-02-27 09:01:54 -08001554 coverage := false
Roland Levillainf6cc2612020-07-09 16:58:14 +01001555 if len(c.config.productVariables.NativeCoveragePaths) > 0 {
Roland Levillain4f5297b2020-06-09 12:44:06 +01001556 if InList("*", c.config.productVariables.NativeCoveragePaths) || HasAnyPrefix(path, c.config.productVariables.NativeCoveragePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001557 coverage = true
Dan Willemsen581341d2017-02-09 16:16:31 -08001558 }
1559 }
Roland Levillainf6cc2612020-07-09 16:58:14 +01001560 if coverage && len(c.config.productVariables.NativeCoverageExcludePaths) > 0 {
Yi Kongfd07ed22023-02-16 17:42:27 +09001561 // Workaround coverage boot failure.
1562 // http://b/269981180
1563 if strings.HasPrefix(path, "external/protobuf") {
1564 coverage = false
1565 }
Roland Levillain4f5297b2020-06-09 12:44:06 +01001566 if HasAnyPrefix(path, c.config.productVariables.NativeCoverageExcludePaths) {
Ivan Lozano5f595532017-07-13 14:46:05 -07001567 coverage = false
Ryan Campbell469a18a2017-02-27 09:01:54 -08001568 }
1569 }
1570 return coverage
Dan Willemsen581341d2017-02-09 16:16:31 -08001571}
Ivan Lozano5f595532017-07-13 14:46:05 -07001572
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001573func (c *deviceConfig) PgoAdditionalProfileDirs() []string {
Dan Willemsen45133ac2018-03-09 21:22:06 -08001574 return c.config.productVariables.PgoAdditionalProfileDirs
Pirama Arumuga Nainar49540802018-01-29 23:11:42 -08001575}
1576
Vinh Tran44cb78c2023-03-09 22:07:19 -05001577// AfdoProfile returns fully qualified path associated to the given module name
1578func (c *deviceConfig) AfdoProfile(name string) (*string, error) {
1579 for _, afdoProfile := range c.config.productVariables.AfdoProfiles {
1580 split := strings.Split(afdoProfile, ":")
1581 if len(split) != 3 {
1582 return nil, fmt.Errorf("AFDO_PROFILES has invalid value: %s. "+
1583 "The expected format is <module>:<fully-qualified-path-to-fdo_profile>", afdoProfile)
1584 }
1585 if split[0] == name {
1586 return proptools.StringPtr(strings.Join([]string{split[1], split[2]}, ":")), nil
1587 }
1588 }
1589 return nil, nil
1590}
1591
Tri Vo35a51432018-03-25 20:00:00 -07001592func (c *deviceConfig) VendorSepolicyDirs() []string {
1593 return c.config.productVariables.BoardVendorSepolicyDirs
1594}
1595
1596func (c *deviceConfig) OdmSepolicyDirs() []string {
1597 return c.config.productVariables.BoardOdmSepolicyDirs
1598}
1599
Felixa20a8752020-05-17 18:28:35 +02001600func (c *deviceConfig) SystemExtPublicSepolicyDirs() []string {
1601 return c.config.productVariables.SystemExtPublicSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001602}
1603
Felixa20a8752020-05-17 18:28:35 +02001604func (c *deviceConfig) SystemExtPrivateSepolicyDirs() []string {
1605 return c.config.productVariables.SystemExtPrivateSepolicyDirs
Tri Vo35a51432018-03-25 20:00:00 -07001606}
1607
Inseob Kim0866b002019-04-15 20:21:29 +09001608func (c *deviceConfig) SepolicyM4Defs() []string {
1609 return c.config.productVariables.BoardSepolicyM4Defs
1610}
1611
Jiyong Park7f67f482019-01-05 12:57:48 +09001612func (c *deviceConfig) OverrideManifestPackageNameFor(name string) (manifestName string, overridden bool) {
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001613 return findOverrideValue(c.config.productVariables.ManifestPackageNameOverrides, name,
1614 "invalid override rule %q in PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES should be <module_name>:<manifest_name>")
1615}
1616
1617func (c *deviceConfig) OverrideCertificateFor(name string) (certificatePath string, overridden bool) {
Jaewoong Jungacb6db32019-02-28 16:22:30 +00001618 return findOverrideValue(c.config.productVariables.CertificateOverrides, name,
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001619 "invalid override rule %q in PRODUCT_CERTIFICATE_OVERRIDES should be <module_name>:<certificate_module_name>")
1620}
1621
Jaewoong Jung9d22a912019-01-23 16:27:47 -08001622func (c *deviceConfig) OverridePackageNameFor(name string) string {
1623 newName, overridden := findOverrideValue(
1624 c.config.productVariables.PackageNameOverrides,
1625 name,
1626 "invalid override rule %q in PRODUCT_PACKAGE_NAME_OVERRIDES should be <module_name>:<package_name>")
1627 if overridden {
1628 return newName
1629 }
1630 return name
1631}
1632
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001633func findOverrideValue(overrides []string, name string, errorMsg string) (newValue string, overridden bool) {
Jiyong Park7f67f482019-01-05 12:57:48 +09001634 if overrides == nil || len(overrides) == 0 {
1635 return "", false
1636 }
1637 for _, o := range overrides {
1638 split := strings.Split(o, ":")
1639 if len(split) != 2 {
1640 // This shouldn't happen as this is first checked in make, but just in case.
Jaewoong Jung2ad817c2019-01-18 14:27:16 -08001641 panic(fmt.Errorf(errorMsg, o))
Jiyong Park7f67f482019-01-05 12:57:48 +09001642 }
1643 if matchPattern(split[0], name) {
1644 return substPattern(split[0], split[1], name), true
1645 }
1646 }
1647 return "", false
1648}
1649
Albert Martineefabcf2022-03-21 20:11:16 +00001650func (c *deviceConfig) ApexGlobalMinSdkVersionOverride() string {
1651 return String(c.config.productVariables.ApexGlobalMinSdkVersionOverride)
1652}
1653
Ivan Lozano5f595532017-07-13 14:46:05 -07001654func (c *config) IntegerOverflowDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001655 if len(c.productVariables.IntegerOverflowExcludePaths) == 0 {
Ivan Lozano5f595532017-07-13 14:46:05 -07001656 return false
1657 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001658 return HasAnyPrefix(path, c.productVariables.IntegerOverflowExcludePaths)
Ivan Lozano5f595532017-07-13 14:46:05 -07001659}
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001660
1661func (c *config) CFIDisabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001662 if len(c.productVariables.CFIExcludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001663 return false
1664 }
Jaewoong Jung3aff5782020-02-11 07:54:35 -08001665 return HasAnyPrefix(path, c.productVariables.CFIExcludePaths)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001666}
1667
1668func (c *config) CFIEnabledForPath(path string) bool {
Roland Levillainf6cc2612020-07-09 16:58:14 +01001669 if len(c.productVariables.CFIIncludePaths) == 0 {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001670 return false
1671 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001672 return HasAnyPrefix(path, c.productVariables.CFIIncludePaths) && !c.CFIDisabledForPath(path)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -07001673}
Colin Crosse15ddaf2017-12-04 11:24:31 -08001674
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001675func (c *config) MemtagHeapDisabledForPath(path string) bool {
1676 if len(c.productVariables.MemtagHeapExcludePaths) == 0 {
1677 return false
1678 }
1679 return HasAnyPrefix(path, c.productVariables.MemtagHeapExcludePaths)
1680}
1681
1682func (c *config) MemtagHeapAsyncEnabledForPath(path string) bool {
1683 if len(c.productVariables.MemtagHeapAsyncIncludePaths) == 0 {
1684 return false
1685 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001686 return HasAnyPrefix(path, c.productVariables.MemtagHeapAsyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001687}
1688
1689func (c *config) MemtagHeapSyncEnabledForPath(path string) bool {
1690 if len(c.productVariables.MemtagHeapSyncIncludePaths) == 0 {
1691 return false
1692 }
Evgenii Stepanov779b64e2021-04-09 14:33:10 -07001693 return HasAnyPrefix(path, c.productVariables.MemtagHeapSyncIncludePaths) && !c.MemtagHeapDisabledForPath(path)
Evgenii Stepanov4beaa0c2021-01-05 16:41:26 -08001694}
1695
Tomislav Novakf734f002023-08-22 10:51:44 -07001696func (c *config) HWASanDisabledForPath(path string) bool {
1697 if len(c.productVariables.HWASanExcludePaths) == 0 {
1698 return false
1699 }
1700 return HasAnyPrefix(path, c.productVariables.HWASanExcludePaths)
1701}
1702
Hang Lua98aab92023-03-17 13:17:22 +08001703func (c *config) HWASanEnabledForPath(path string) bool {
1704 if len(c.productVariables.HWASanIncludePaths) == 0 {
1705 return false
1706 }
Tomislav Novakf734f002023-08-22 10:51:44 -07001707 return HasAnyPrefix(path, c.productVariables.HWASanIncludePaths) && !c.HWASanDisabledForPath(path)
Hang Lua98aab92023-03-17 13:17:22 +08001708}
1709
Dan Willemsen0fe78662018-03-26 12:41:18 -07001710func (c *config) VendorConfig(name string) VendorConfig {
Colin Cross9d34f352019-11-22 16:03:51 -08001711 return soongconfig.Config(c.productVariables.VendorVars[name])
Dan Willemsen0fe78662018-03-26 12:41:18 -07001712}
1713
Colin Cross395f2cf2018-10-24 16:10:32 -07001714func (c *config) NdkAbis() bool {
1715 return Bool(c.productVariables.Ndk_abis)
1716}
1717
Martin Stjernholmc1ecc432019-11-15 15:00:31 +00001718func (c *config) AmlAbis() bool {
1719 return Bool(c.productVariables.Aml_abis)
1720}
1721
Jiyong Park4da07972021-01-05 21:01:11 +09001722func (c *config) ForceApexSymlinkOptimization() bool {
1723 return Bool(c.productVariables.ForceApexSymlinkOptimization)
1724}
1725
Sasha Smundakfe9a5b82022-07-27 14:51:45 -07001726func (c *config) ApexCompressionEnabled() bool {
1727 return Bool(c.productVariables.CompressedApex) && !c.UnbundledBuildApps()
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +00001728}
1729
Dennis Shene2ed70c2023-01-11 14:15:43 +00001730func (c *config) ApexTrimEnabled() bool {
1731 return Bool(c.productVariables.TrimmedApex)
1732}
1733
Jeongik Chac9464142019-01-07 12:07:27 +09001734func (c *config) EnforceSystemCertificate() bool {
1735 return Bool(c.productVariables.EnforceSystemCertificate)
1736}
1737
Colin Cross440e0d02020-06-11 11:32:11 -07001738func (c *config) EnforceSystemCertificateAllowList() []string {
1739 return c.productVariables.EnforceSystemCertificateAllowList
Jeongik Chac9464142019-01-07 12:07:27 +09001740}
1741
Jeongik Cha2cc570d2019-10-29 15:44:45 +09001742func (c *config) EnforceProductPartitionInterface() bool {
1743 return Bool(c.productVariables.EnforceProductPartitionInterface)
1744}
1745
JaeMan Parkff715562020-10-19 17:25:58 +09001746func (c *config) EnforceInterPartitionJavaSdkLibrary() bool {
1747 return Bool(c.productVariables.EnforceInterPartitionJavaSdkLibrary)
1748}
1749
1750func (c *config) InterPartitionJavaLibraryAllowList() []string {
1751 return c.productVariables.InterPartitionJavaLibraryAllowList
1752}
1753
Colin Crossf24a22a2019-01-31 14:12:44 -08001754func (c *config) ProductHiddenAPIStubs() []string {
1755 return c.productVariables.ProductHiddenAPIStubs
Colin Cross8faf8fc2019-01-16 15:15:52 -08001756}
1757
Colin Crossf24a22a2019-01-31 14:12:44 -08001758func (c *config) ProductHiddenAPIStubsSystem() []string {
1759 return c.productVariables.ProductHiddenAPIStubsSystem
Colin Cross8faf8fc2019-01-16 15:15:52 -08001760}
1761
Colin Crossf24a22a2019-01-31 14:12:44 -08001762func (c *config) ProductHiddenAPIStubsTest() []string {
1763 return c.productVariables.ProductHiddenAPIStubsTest
Colin Cross8faf8fc2019-01-16 15:15:52 -08001764}
Dan Willemsen71c74602019-04-10 12:27:35 -07001765
Dan Willemsen54879d12019-04-18 10:08:46 -07001766func (c *deviceConfig) TargetFSConfigGen() []string {
Dan Willemsen71c74602019-04-10 12:27:35 -07001767 return c.config.productVariables.TargetFSConfigGen
1768}
Inseob Kim0866b002019-04-15 20:21:29 +09001769
1770func (c *config) ProductPublicSepolicyDirs() []string {
1771 return c.productVariables.ProductPublicSepolicyDirs
1772}
1773
1774func (c *config) ProductPrivateSepolicyDirs() []string {
1775 return c.productVariables.ProductPrivateSepolicyDirs
1776}
1777
Inseob Kim5eb7ee92022-04-27 10:30:34 +09001778func (c *config) TargetMultitreeUpdateMeta() bool {
1779 return c.productVariables.MultitreeUpdateMeta
1780}
1781
Inseob Kim1f086e22019-05-09 13:29:15 +09001782func (c *deviceConfig) DeviceArch() string {
1783 return String(c.config.productVariables.DeviceArch)
1784}
1785
1786func (c *deviceConfig) DeviceArchVariant() string {
1787 return String(c.config.productVariables.DeviceArchVariant)
1788}
1789
1790func (c *deviceConfig) DeviceSecondaryArch() string {
1791 return String(c.config.productVariables.DeviceSecondaryArch)
1792}
1793
1794func (c *deviceConfig) DeviceSecondaryArchVariant() string {
1795 return String(c.config.productVariables.DeviceSecondaryArchVariant)
1796}
Yifan Hong82db7352020-01-21 16:12:26 -08001797
1798func (c *deviceConfig) BoardUsesRecoveryAsBoot() bool {
1799 return Bool(c.config.productVariables.BoardUsesRecoveryAsBoot)
1800}
Yifan Hong97365ee2020-07-29 09:51:57 -07001801
1802func (c *deviceConfig) BoardKernelBinaries() []string {
1803 return c.config.productVariables.BoardKernelBinaries
1804}
Ulya Trafimovich249386a2020-07-01 14:31:13 +01001805
Yifan Hong42bef8d2020-08-05 14:36:09 -07001806func (c *deviceConfig) BoardKernelModuleInterfaceVersions() []string {
1807 return c.config.productVariables.BoardKernelModuleInterfaceVersions
1808}
1809
Yifan Hongdd8dacc2020-10-21 15:40:17 -07001810func (c *deviceConfig) BoardMoveRecoveryResourcesToVendorBoot() bool {
1811 return Bool(c.config.productVariables.BoardMoveRecoveryResourcesToVendorBoot)
1812}
1813
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001814func (c *deviceConfig) PlatformSepolicyVersion() string {
1815 return String(c.config.productVariables.PlatformSepolicyVersion)
1816}
1817
Inseob Kima10ef272021-09-15 03:04:53 +00001818func (c *deviceConfig) TotSepolicyVersion() string {
1819 return String(c.config.productVariables.TotSepolicyVersion)
1820}
1821
Inseob Kim843f6642022-01-07 09:11:23 +09001822func (c *deviceConfig) PlatformSepolicyCompatVersions() []string {
1823 return c.config.productVariables.PlatformSepolicyCompatVersions
1824}
1825
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001826func (c *deviceConfig) BoardSepolicyVers() string {
Inseob Kim0c4eec82021-03-22 22:33:40 +09001827 if ver := String(c.config.productVariables.BoardSepolicyVers); ver != "" {
1828 return ver
1829 }
1830 return c.PlatformSepolicyVersion()
Inseob Kim16ebd5a2020-12-09 23:08:17 +09001831}
1832
Inseob Kim1a0afcc2022-02-14 23:10:51 +09001833func (c *deviceConfig) SystemExtSepolicyPrebuiltApiDir() string {
1834 return String(c.config.productVariables.SystemExtSepolicyPrebuiltApiDir)
1835}
1836
1837func (c *deviceConfig) ProductSepolicyPrebuiltApiDir() string {
1838 return String(c.config.productVariables.ProductSepolicyPrebuiltApiDir)
1839}
1840
1841func (c *deviceConfig) IsPartnerTrebleSepolicyTestEnabled() bool {
1842 return c.SystemExtSepolicyPrebuiltApiDir() != "" || c.ProductSepolicyPrebuiltApiDir() != ""
1843}
1844
Inseob Kim7cf14652021-01-06 23:06:52 +09001845func (c *deviceConfig) DirectedVendorSnapshot() bool {
1846 return c.config.productVariables.DirectedVendorSnapshot
1847}
1848
1849func (c *deviceConfig) VendorSnapshotModules() map[string]bool {
1850 return c.config.productVariables.VendorSnapshotModules
1851}
1852
Jose Galmes4c6895e2021-02-09 07:44:30 -08001853func (c *deviceConfig) DirectedRecoverySnapshot() bool {
1854 return c.config.productVariables.DirectedRecoverySnapshot
1855}
1856
1857func (c *deviceConfig) RecoverySnapshotModules() map[string]bool {
1858 return c.config.productVariables.RecoverySnapshotModules
1859}
1860
Justin DeMartino383bfb32021-02-24 10:49:43 -08001861func createDirsMap(previous map[string]bool, dirs []string) (map[string]bool, error) {
1862 var ret = make(map[string]bool)
1863 for _, dir := range dirs {
1864 clean := filepath.Clean(dir)
1865 if previous[clean] || ret[clean] {
1866 return nil, fmt.Errorf("Duplicate entry %s", dir)
1867 }
1868 ret[clean] = true
1869 }
1870 return ret, nil
1871}
1872
1873func (c *deviceConfig) createDirsMapOnce(onceKey OnceKey, previous map[string]bool, dirs []string) map[string]bool {
1874 dirMap := c.Once(onceKey, func() interface{} {
1875 ret, err := createDirsMap(previous, dirs)
1876 if err != nil {
1877 panic(fmt.Errorf("%s: %w", onceKey.key, err))
1878 }
1879 return ret
1880 })
1881 if dirMap == nil {
1882 return nil
1883 }
1884 return dirMap.(map[string]bool)
1885}
1886
1887var vendorSnapshotDirsExcludedKey = NewOnceKey("VendorSnapshotDirsExcludedMap")
1888
1889func (c *deviceConfig) VendorSnapshotDirsExcludedMap() map[string]bool {
1890 return c.createDirsMapOnce(vendorSnapshotDirsExcludedKey, nil,
1891 c.config.productVariables.VendorSnapshotDirsExcluded)
1892}
1893
1894var vendorSnapshotDirsIncludedKey = NewOnceKey("VendorSnapshotDirsIncludedMap")
1895
1896func (c *deviceConfig) VendorSnapshotDirsIncludedMap() map[string]bool {
1897 excludedMap := c.VendorSnapshotDirsExcludedMap()
1898 return c.createDirsMapOnce(vendorSnapshotDirsIncludedKey, excludedMap,
1899 c.config.productVariables.VendorSnapshotDirsIncluded)
1900}
1901
1902var recoverySnapshotDirsExcludedKey = NewOnceKey("RecoverySnapshotDirsExcludedMap")
1903
1904func (c *deviceConfig) RecoverySnapshotDirsExcludedMap() map[string]bool {
1905 return c.createDirsMapOnce(recoverySnapshotDirsExcludedKey, nil,
1906 c.config.productVariables.RecoverySnapshotDirsExcluded)
1907}
1908
1909var recoverySnapshotDirsIncludedKey = NewOnceKey("RecoverySnapshotDirsIncludedMap")
1910
1911func (c *deviceConfig) RecoverySnapshotDirsIncludedMap() map[string]bool {
1912 excludedMap := c.RecoverySnapshotDirsExcludedMap()
1913 return c.createDirsMapOnce(recoverySnapshotDirsIncludedKey, excludedMap,
1914 c.config.productVariables.RecoverySnapshotDirsIncluded)
1915}
1916
Rob Seymour925aa092021-08-10 20:42:03 +00001917func (c *deviceConfig) HostFakeSnapshotEnabled() bool {
1918 return c.config.productVariables.HostFakeSnapshotEnabled
1919}
1920
Inseob Kim60c32f02020-12-21 22:53:05 +09001921func (c *deviceConfig) ShippingApiLevel() ApiLevel {
1922 if c.config.productVariables.ShippingApiLevel == nil {
1923 return NoneApiLevel
1924 }
1925 apiLevel, _ := strconv.Atoi(*c.config.productVariables.ShippingApiLevel)
1926 return uncheckedFinalApiLevel(apiLevel)
1927}
1928
Liz Kammer33cc80e2023-05-18 18:20:28 +00001929func (c *deviceConfig) BuildBrokenPluginValidation() []string {
1930 return c.config.productVariables.BuildBrokenPluginValidation
1931}
1932
Alix Espinoef47e542022-09-14 19:10:51 +00001933func (c *deviceConfig) BuildBrokenClangAsFlags() bool {
1934 return c.config.productVariables.BuildBrokenClangAsFlags
1935}
1936
1937func (c *deviceConfig) BuildBrokenClangCFlags() bool {
1938 return c.config.productVariables.BuildBrokenClangCFlags
1939}
1940
Alixb5f6d9e2022-04-20 23:00:58 +00001941func (c *deviceConfig) BuildBrokenClangProperty() bool {
1942 return c.config.productVariables.BuildBrokenClangProperty
1943}
1944
Inseob Kim67e5add192021-03-17 18:05:33 +09001945func (c *deviceConfig) BuildBrokenEnforceSyspropOwner() bool {
1946 return c.config.productVariables.BuildBrokenEnforceSyspropOwner
1947}
1948
1949func (c *deviceConfig) BuildBrokenTrebleSyspropNeverallow() bool {
1950 return c.config.productVariables.BuildBrokenTrebleSyspropNeverallow
1951}
1952
Cole Faustedc4c502022-09-09 19:39:25 -07001953func (c *deviceConfig) BuildBrokenUsesSoongPython2Modules() bool {
1954 return c.config.productVariables.BuildBrokenUsesSoongPython2Modules
1955}
1956
Hridya Valsaraju5a5c7d52021-04-02 16:45:24 -07001957func (c *deviceConfig) BuildDebugfsRestrictionsEnabled() bool {
1958 return c.config.productVariables.BuildDebugfsRestrictionsEnabled
1959}
1960
Inseob Kim0cac7b42021-02-03 18:16:46 +09001961func (c *deviceConfig) BuildBrokenVendorPropertyNamespace() bool {
1962 return c.config.productVariables.BuildBrokenVendorPropertyNamespace
1963}
1964
Liz Kammer619be462022-01-28 15:13:39 -05001965func (c *deviceConfig) BuildBrokenInputDir(name string) bool {
1966 return InList(name, c.config.productVariables.BuildBrokenInputDirModules)
1967}
1968
Jiakai Zhang48203e32023-06-02 23:42:21 +01001969func (c *config) BuildWarningBadOptionalUsesLibsAllowlist() []string {
1970 return c.productVariables.BuildWarningBadOptionalUsesLibsAllowlist
1971}
1972
Yu Liu6a7940c2023-05-09 17:12:22 -07001973func (c *deviceConfig) GenruleSandboxing() bool {
1974 return Bool(c.config.productVariables.GenruleSandboxing)
Vinh Tran140d5882022-06-10 14:23:27 -04001975}
1976
Inseob Kim67e5add192021-03-17 18:05:33 +09001977func (c *deviceConfig) RequiresInsecureExecmemForSwiftshader() bool {
1978 return c.config.productVariables.RequiresInsecureExecmemForSwiftshader
1979}
1980
Devin Moorec381e102023-07-06 22:03:58 +00001981func (c *deviceConfig) Release_aidl_use_unfrozen() bool {
1982 return Bool(c.config.productVariables.Release_aidl_use_unfrozen)
1983}
1984
Inseob Kim67e5add192021-03-17 18:05:33 +09001985func (c *config) SelinuxIgnoreNeverallows() bool {
1986 return c.productVariables.SelinuxIgnoreNeverallows
1987}
1988
Inseob Kima10ef272021-09-15 03:04:53 +00001989func (c *deviceConfig) SepolicyFreezeTestExtraDirs() []string {
1990 return c.config.productVariables.SepolicyFreezeTestExtraDirs
1991}
1992
1993func (c *deviceConfig) SepolicyFreezeTestExtraPrebuiltDirs() []string {
1994 return c.config.productVariables.SepolicyFreezeTestExtraPrebuiltDirs
1995}
1996
Jiyong Parkd163d4d2021-10-12 16:47:43 +09001997func (c *deviceConfig) GenerateAidlNdkPlatformBackend() bool {
1998 return c.config.productVariables.GenerateAidlNdkPlatformBackend
1999}
2000
Christopher Ferris98f10222022-07-13 23:16:52 -07002001func (c *config) IgnorePrefer32OnDevice() bool {
2002 return c.productVariables.IgnorePrefer32OnDevice
2003}
2004
Ulya Trafimovich249386a2020-07-01 14:31:13 +01002005func (c *config) BootJars() []string {
2006 return c.Once(earlyBootJarsKey, func() interface{} {
Paul Duffin69d1fb12020-10-23 21:14:20 +01002007 list := c.productVariables.BootJars.CopyOfJars()
satayevd604b212021-07-21 14:23:52 +01002008 return append(list, c.productVariables.ApexBootJars.CopyOfJars()...)
Ulya Trafimovich249386a2020-07-01 14:31:13 +01002009 }).([]string)
2010}
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002011
satayevd604b212021-07-21 14:23:52 +01002012func (c *config) NonApexBootJars() ConfiguredJarList {
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002013 return c.productVariables.BootJars
2014}
2015
satayevd604b212021-07-21 14:23:52 +01002016func (c *config) ApexBootJars() ConfiguredJarList {
2017 return c.productVariables.ApexBootJars
Paul Duffin9a89a2a2020-10-28 19:20:06 +00002018}
Colin Cross77cdcfd2021-03-12 11:28:25 -08002019
2020func (c *config) RBEWrapper() string {
2021 return c.GetenvWithDefault("RBE_WRAPPER", remoteexec.DefaultWrapperPath)
2022}
Colin Cross9b698b62021-12-22 09:55:32 -08002023
2024// UseHostMusl returns true if the host target has been configured to build against musl libc.
2025func (c *config) UseHostMusl() bool {
2026 return Bool(c.productVariables.HostMusl)
2027}
MarkDacekff851b82022-04-21 18:33:17 +00002028
MarkDacekf47e1422023-04-19 16:47:36 +00002029func (c *config) GetMixedBuildsEnabledModules() map[string]struct{} {
2030 return c.mixedBuildEnabledModules
2031}
2032
MarkDacek6f6b9622023-05-02 16:28:55 +00002033func (c *config) GetMixedBuildsDisabledModules() map[string]struct{} {
2034 return c.mixedBuildDisabledModules
2035}
2036
Chris Parsonsf874e462022-05-10 13:50:12 -04002037func (c *config) LogMixedBuild(ctx BaseModuleContext, useBazel bool) {
MarkDacekff851b82022-04-21 18:33:17 +00002038 moduleName := ctx.Module().Name()
2039 c.mixedBuildsLock.Lock()
2040 defer c.mixedBuildsLock.Unlock()
2041 if useBazel {
2042 c.mixedBuildEnabledModules[moduleName] = struct{}{}
2043 } else {
2044 c.mixedBuildDisabledModules[moduleName] = struct{}{}
2045 }
2046}
Spandan Das9e93d3d2023-03-08 05:47:29 +00002047
Chris Parsons0c4de1f2023-09-21 20:36:35 +00002048func (c *config) HasBazelBuildTargetInSource(dir string, target string) bool {
2049 for _, existingTarget := range c.bazelTargetsByDir[dir] {
2050 if target == existingTarget {
Chris Parsons8152a942023-06-06 16:17:50 +00002051 return true
2052 }
2053 }
2054 return false
2055}
2056
2057func (c *config) SetBazelBuildFileTargets(bazelTargetsByDir map[string][]string) {
2058 c.bazelTargetsByDir = bazelTargetsByDir
2059}
2060
Spandan Das9e93d3d2023-03-08 05:47:29 +00002061// ApiSurfaces directory returns the source path inside the api_surfaces repo
2062// (relative to workspace root).
2063func (c *config) ApiSurfacesDir(s ApiSurface, version string) string {
2064 return filepath.Join(
2065 "build",
2066 "bazel",
2067 "api_surfaces",
2068 s.String(),
2069 version)
2070}
Jihoon Kang1bff0342023-01-17 20:40:22 +00002071
Jihoon Kang1975d3e2023-10-16 23:24:11 +00002072func (c *config) JavaCoverageEnabled() bool {
2073 return c.IsEnvTrue("EMMA_INSTRUMENT") || c.IsEnvTrue("EMMA_INSTRUMENT_STATIC") || c.IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK")
2074}
2075
Jihoon Kangc1b04d62023-11-16 19:07:04 +00002076func (c *deviceConfig) BuildFromSourceStub() bool {
2077 return Bool(c.config.productVariables.BuildFromSourceStub)
2078}
2079
Jihoon Kang1bff0342023-01-17 20:40:22 +00002080func (c *config) BuildFromTextStub() bool {
Jihoon Kang1975d3e2023-10-16 23:24:11 +00002081 // TODO: b/302320354 - Remove the coverage build specific logic once the
2082 // robust solution for handling native properties in from-text stub build
2083 // is implemented.
Jihoon Kangc1b04d62023-11-16 19:07:04 +00002084 return !c.buildFromSourceStub &&
2085 !c.JavaCoverageEnabled() &&
2086 !c.deviceConfig.BuildFromSourceStub()
Jihoon Kang1bff0342023-01-17 20:40:22 +00002087}
Spandan Das4deab282023-03-30 17:06:32 +00002088
2089func (c *config) SetBuildFromTextStub(b bool) {
Jihoon Kang2a929ad2023-06-08 19:02:07 +00002090 c.buildFromSourceStub = !b
Jihoon Kangcbcad7c2023-06-01 22:31:52 +00002091 c.productVariables.Build_from_text_stub = boolPtr(b)
Spandan Das4deab282023-03-30 17:06:32 +00002092}
Jihoon Kang1c92c3e2023-03-23 17:44:51 +00002093
MarkDacek9c094ca2023-03-16 19:15:19 +00002094func (c *config) AddForceEnabledModules(forceEnabled []string) {
2095 for _, forceEnabledModule := range forceEnabled {
2096 c.bazelForceEnabledModules[forceEnabledModule] = struct{}{}
2097 }
2098}
Jihoon Kang1c92c3e2023-03-23 17:44:51 +00002099
2100func (c *config) SetApiLibraries(libs []string) {
2101 c.apiLibraries = make(map[string]struct{})
2102 for _, lib := range libs {
2103 c.apiLibraries[lib] = struct{}{}
2104 }
2105}
2106
2107func (c *config) GetApiLibraries() map[string]struct{} {
2108 return c.apiLibraries
2109}
Inseob Kim5bac3b62023-08-25 21:29:46 +09002110
Liz Kammere1b39a52023-09-18 14:32:18 -04002111// Bp2buildMode indicates whether the config is for bp2build mode of Soong
2112func (c *config) Bp2buildMode() bool {
2113 return c.BuildMode == Bp2build
2114}
2115
Inseob Kim5bac3b62023-08-25 21:29:46 +09002116func (c *deviceConfig) CheckVendorSeappViolations() bool {
2117 return Bool(c.config.productVariables.CheckVendorSeappViolations)
2118}
Jihoon Kangcfbc4072023-09-20 01:02:18 +00002119
2120func (c *deviceConfig) NextReleaseHideFlaggedApi() bool {
2121 return Bool(c.config.productVariables.NextReleaseHideFlaggedApi)
2122}
Jihoon Kangf3aa3222023-09-26 22:32:08 +00002123
2124func (c *deviceConfig) ReleaseExposeFlaggedApi() bool {
2125 return Bool(c.config.productVariables.Release_expose_flagged_api)
2126}
Jihoon Kangc8313892023-09-20 00:54:47 +00002127
2128func (c *deviceConfig) HideFlaggedApis() bool {
2129 return c.NextReleaseHideFlaggedApi() && !c.ReleaseExposeFlaggedApi()
2130}
Inseob Kime4e85d52023-10-25 23:53:58 +09002131
2132func (c *config) GetBuildFlag(name string) (string, bool) {
2133 val, ok := c.productVariables.BuildFlags[name]
2134 return val, ok
2135}
Spandan Dase3fcb412023-10-26 20:48:02 +00002136
2137var (
2138 mainlineApexContributionBuildFlags = []string{
2139 "RELEASE_APEX_CONTRIBUTIONS_ADSERVICES",
2140 "RELEASE_APEX_CONTRIBUTIONS_APPSEARCH",
2141 "RELEASE_APEX_CONTRIBUTIONS_ART",
2142 "RELEASE_APEX_CONTRIBUTIONS_BLUETOOTH",
2143 "RELEASE_APEX_CONTRIBUTIONS_CONFIGINFRASTRUCTURE",
2144 "RELEASE_APEX_CONTRIBUTIONS_CONNECTIVITY",
2145 "RELEASE_APEX_CONTRIBUTIONS_CONSCRYPT",
2146 "RELEASE_APEX_CONTRIBUTIONS_CRASHRECOVERY",
2147 "RELEASE_APEX_CONTRIBUTIONS_DEVICELOCK",
2148 "RELEASE_APEX_CONTRIBUTIONS_HEALTHFITNESS",
2149 "RELEASE_APEX_CONTRIBUTIONS_IPSEC",
2150 "RELEASE_APEX_CONTRIBUTIONS_MEDIA",
2151 "RELEASE_APEX_CONTRIBUTIONS_MEDIAPROVIDER",
2152 "RELEASE_APEX_CONTRIBUTIONS_ONDEVICEPERSONALIZATION",
2153 "RELEASE_APEX_CONTRIBUTIONS_PERMISSION",
2154 "RELEASE_APEX_CONTRIBUTIONS_REMOTEKEYPROVISIONING",
2155 "RELEASE_APEX_CONTRIBUTIONS_SCHEDULING",
2156 "RELEASE_APEX_CONTRIBUTIONS_SDKEXTENSIONS",
2157 "RELEASE_APEX_CONTRIBUTIONS_STATSD",
2158 "RELEASE_APEX_CONTRIBUTIONS_UWB",
2159 "RELEASE_APEX_CONTRIBUTIONS_WIFI",
2160 }
2161)
2162
2163// Returns the list of _selected_ apex_contributions
2164// Each mainline module will have one entry in the list
2165func (c *config) AllApexContributions() []string {
2166 ret := []string{}
2167 for _, f := range mainlineApexContributionBuildFlags {
2168 if val, exists := c.GetBuildFlag(f); exists && val != "" {
2169 ret = append(ret, val)
2170 }
2171 }
2172 return ret
2173}