blob: 8462d0d58cbe4f23575fb293691e7d91a4ee32b5 [file] [log] [blame]
Colin Cross7f64b6d2015-07-09 13:57:48 -07001// 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 Cross7f64b6d2015-07-09 13:57:48 -070016
17import (
18 "fmt"
19 "reflect"
Dan Willemsen490fd492015-11-24 17:53:15 -080020 "runtime"
Colin Cross7f64b6d2015-07-09 13:57:48 -070021 "strings"
22
Colin Cross7f64b6d2015-07-09 13:57:48 -070023 "github.com/google/blueprint/proptools"
24)
25
26func init() {
Colin Cross1e676be2016-10-12 14:38:15 -070027 PreDepsMutators(func(ctx RegisterMutatorsContext) {
28 ctx.BottomUp("variable", variableMutator).Parallel()
29 })
Colin Cross7f64b6d2015-07-09 13:57:48 -070030}
31
32type variableProperties struct {
33 Product_variables struct {
Dan Willemsen47cf66b2015-09-16 16:48:54 -070034 Platform_sdk_version struct {
35 Asflags []string
Colin Crossceeff0f2017-05-08 13:43:00 -070036 Cflags []string
Dan Willemsen47cf66b2015-09-16 16:48:54 -070037 }
Colin Cross83163192015-12-01 16:31:16 -080038
39 // unbundled_build is a catch-all property to annotate modules that don't build in one or
40 // more unbundled branches, usually due to dependencies missing from the manifest.
41 Unbundled_build struct {
42 Enabled *bool `android:"arch_variant"`
43 } `android:"arch_variant"`
Dan Willemsen496e3952016-01-05 14:27:55 -080044
45 Brillo struct {
Dan Willemsen7b872832016-10-03 23:36:47 -070046 Cflags []string
Dan Willemsen496e3952016-01-05 14:27:55 -080047 Version_script *string `android:"arch_variant"`
48 } `android:"arch_variant"`
Dan Willemsen97cae012016-03-01 14:08:42 -080049
50 Malloc_not_svelte struct {
51 Cflags []string
52 }
Evgenii Stepanov8391efa2016-05-12 18:04:18 -070053
54 Safestack struct {
55 Cflags []string `android:"arch_variant"`
56 } `android:"arch_variant"`
Dan Willemsena6f7d152016-07-12 14:57:40 -070057
Dan Willemsen1be35382016-07-25 17:42:18 -070058 Binder32bit struct {
59 Cflags []string
60 }
Dan Willemsenfcebcd52016-09-22 14:49:10 -070061
Colin Cross0e409a22017-05-02 10:58:50 -070062 Device_uses_hwc2 struct {
63 Cflags []string
64 }
65
Colin Cross95436422017-05-04 13:57:05 -070066 Override_rs_driver struct {
67 Cflags []string
68 }
69
Steven Morelande24bc202017-05-18 15:44:02 -070070 // treble is true when a build is a Treble compliant device. This is automatically set when
71 // a build is shipped with Android O, but can be overriden. This controls such things as
72 // the sepolicy split and enabling the Treble linker namespaces.
73 Treble struct {
74 Cflags []string
75 }
76
Colin Cross6bc59ef2016-12-08 09:46:35 -080077 // debuggable is true for eng and userdebug builds, and can be used to turn on additional
78 // debugging features that don't significantly impact runtime behavior. userdebug builds
79 // are used for dogfooding and performance testing, and should be as similar to user builds
80 // as possible.
Dan Willemsenfcebcd52016-09-22 14:49:10 -070081 Debuggable struct {
Dan Willemsen7b872832016-10-03 23:36:47 -070082 Cflags []string
83 Cppflags []string
Dan Willemsenfcebcd52016-09-22 14:49:10 -070084 }
Colin Cross6bc59ef2016-12-08 09:46:35 -080085
86 // eng is true for -eng builds, and can be used to turn on additionaly heavyweight debugging
87 // features.
88 Eng struct {
89 Cflags []string
90 Cppflags []string
91 }
Colin Crossb2123aa2017-05-05 13:37:11 -070092
93 Pdk struct {
94 Enabled *bool
95 }
Colin Cross83163192015-12-01 16:31:16 -080096 } `android:"arch_variant"`
Colin Cross7f64b6d2015-07-09 13:57:48 -070097}
98
99var zeroProductVariables variableProperties
100
Colin Cross485e5722015-08-27 13:28:01 -0700101type productVariables struct {
Dan Willemsen174978c2016-05-11 00:27:49 -0700102 // Suffix to add to generated Makefiles
103 Make_suffix *string `json:",omitempty"`
104
Dan Albert30c9d6e2017-03-28 14:54:55 -0700105 Platform_sdk_version *int `json:",omitempty"`
106 Platform_version_all_codenames []string `json:",omitempty"`
Colin Cross4225f652015-09-17 14:33:42 -0700107
Dan Willemsen1d31ec32015-09-22 16:56:09 -0700108 DeviceName *string `json:",omitempty"`
Colin Cross4225f652015-09-17 14:33:42 -0700109 DeviceArch *string `json:",omitempty"`
110 DeviceArchVariant *string `json:",omitempty"`
111 DeviceCpuVariant *string `json:",omitempty"`
112 DeviceAbi *[]string `json:",omitempty"`
Dan Willemsendd0e2c32015-10-20 14:29:35 -0700113 DeviceUsesClang *bool `json:",omitempty"`
Dan Willemsend2ede872016-11-18 14:54:24 -0800114 DeviceVndkVersion *string `json:",omitempty"`
Colin Cross4225f652015-09-17 14:33:42 -0700115
116 DeviceSecondaryArch *string `json:",omitempty"`
117 DeviceSecondaryArchVariant *string `json:",omitempty"`
118 DeviceSecondaryCpuVariant *string `json:",omitempty"`
119 DeviceSecondaryAbi *[]string `json:",omitempty"`
120
121 HostArch *string `json:",omitempty"`
122 HostSecondaryArch *string `json:",omitempty"`
Dan Willemsen490fd492015-11-24 17:53:15 -0800123
124 CrossHost *string `json:",omitempty"`
125 CrossHostArch *string `json:",omitempty"`
126 CrossHostSecondaryArch *string `json:",omitempty"`
Colin Cross83163192015-12-01 16:31:16 -0800127
Dan Willemsenb5038162016-03-16 12:35:33 -0700128 Allow_missing_dependencies *bool `json:",omitempty"`
129 Unbundled_build *bool `json:",omitempty"`
130 Brillo *bool `json:",omitempty"`
131 Malloc_not_svelte *bool `json:",omitempty"`
Evgenii Stepanov8391efa2016-05-12 18:04:18 -0700132 Safestack *bool `json:",omitempty"`
Dan Willemsen36cff8b2016-05-17 16:35:02 -0700133 HostStaticBinaries *bool `json:",omitempty"`
Dan Willemsen1be35382016-07-25 17:42:18 -0700134 Binder32bit *bool `json:",omitempty"`
Colin Cross9d45bb72016-08-29 16:14:13 -0700135 UseGoma *bool `json:",omitempty"`
Dan Willemsenfcebcd52016-09-22 14:49:10 -0700136 Debuggable *bool `json:",omitempty"`
Colin Cross6bc59ef2016-12-08 09:46:35 -0800137 Eng *bool `json:",omitempty"`
Vishwath Mohan1b017a72017-01-19 13:54:55 -0800138 EnableCFI *bool `json:",omitempty"`
Colin Cross0e409a22017-05-02 10:58:50 -0700139 Device_uses_hwc2 *bool `json:",omitempty"`
Steven Morelande24bc202017-05-18 15:44:02 -0700140 Treble *bool `json:",omitempty"`
Colin Crossdab550d2017-05-25 10:18:24 -0700141 Pdk *bool `json:",omitempty"`
Colin Cross16b23492016-01-06 14:41:07 -0800142
Ivan Lozano5f595532017-07-13 14:46:05 -0700143 IntegerOverflowExcludePaths *[]string `json:",omitempty"`
144
Dan Willemsen4353bc42016-12-05 17:16:02 -0800145 VendorPath *string `json:",omitempty"`
146
Dan Willemsena03cf6d2016-09-26 15:45:04 -0700147 ClangTidy *bool `json:",omitempty"`
148 TidyChecks *string `json:",omitempty"`
149
Ryan Campbell469a18a2017-02-27 09:01:54 -0800150 NativeCoverage *bool `json:",omitempty"`
151 CoveragePaths *[]string `json:",omitempty"`
152 CoverageExcludePaths *[]string `json:",omitempty"`
Dan Willemsen581341d2017-02-09 16:16:31 -0800153
Colin Cross1e7d3702016-08-24 15:25:47 -0700154 DevicePrefer32BitExecutables *bool `json:",omitempty"`
155 HostPrefer32BitExecutables *bool `json:",omitempty"`
156
Colin Cross23ae82a2016-11-02 14:34:39 -0700157 SanitizeHost []string `json:",omitempty"`
158 SanitizeDevice []string `json:",omitempty"`
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700159 SanitizeDeviceDiag []string `json:",omitempty"`
Colin Cross23ae82a2016-11-02 14:34:39 -0700160 SanitizeDeviceArch []string `json:",omitempty"`
Hiroshi Yamauchie2a10632016-12-19 13:44:41 -0800161
162 ArtUseReadBarrier *bool `json:",omitempty"`
Jack He8cc71432016-12-08 15:45:07 -0800163
164 BtConfigIncludeDir *string `json:",omitempty"`
Colin Cross95436422017-05-04 13:57:05 -0700165
166 Override_rs_driver *string `json:",omitempty"`
Jiyong Parkd773eb32017-07-03 13:18:12 +0900167
168 DeviceKernelHeaders []string `json:",omitempty"`
Colin Crossa6bc19e2015-09-16 13:53:42 -0700169}
170
171func boolPtr(v bool) *bool {
172 return &v
Colin Cross485e5722015-08-27 13:28:01 -0700173}
174
Dan Willemsen47cf66b2015-09-16 16:48:54 -0700175func intPtr(v int) *int {
176 return &v
177}
178
Colin Cross4225f652015-09-17 14:33:42 -0700179func stringPtr(v string) *string {
180 return &v
181}
182
Colin Cross27385972015-09-18 10:57:10 -0700183func (v *productVariables) SetDefaultConfig() {
184 *v = productVariables{
Dan Albert22c0b412016-11-10 11:08:00 -0800185 Platform_sdk_version: intPtr(24),
Colin Cross4225f652015-09-17 14:33:42 -0700186 HostArch: stringPtr("x86_64"),
187 HostSecondaryArch: stringPtr("x86"),
Dan Willemsen1d31ec32015-09-22 16:56:09 -0700188 DeviceName: stringPtr("flounder"),
Colin Cross4225f652015-09-17 14:33:42 -0700189 DeviceArch: stringPtr("arm64"),
Dan Willemsena91d1272016-03-29 22:06:05 -0700190 DeviceArchVariant: stringPtr("armv8-a"),
Colin Cross4225f652015-09-17 14:33:42 -0700191 DeviceCpuVariant: stringPtr("denver64"),
192 DeviceAbi: &[]string{"arm64-v8a"},
Dan Willemsendd0e2c32015-10-20 14:29:35 -0700193 DeviceUsesClang: boolPtr(true),
Colin Cross4225f652015-09-17 14:33:42 -0700194 DeviceSecondaryArch: stringPtr("arm"),
195 DeviceSecondaryArchVariant: stringPtr("armv7-a-neon"),
Dan Willemsen1d31ec32015-09-22 16:56:09 -0700196 DeviceSecondaryCpuVariant: stringPtr("denver"),
Colin Cross4225f652015-09-17 14:33:42 -0700197 DeviceSecondaryAbi: &[]string{"armeabi-v7a"},
Dan Willemsen97cae012016-03-01 14:08:42 -0800198 Malloc_not_svelte: boolPtr(false),
Evgenii Stepanov8391efa2016-05-12 18:04:18 -0700199 Safestack: boolPtr(false),
Colin Cross485e5722015-08-27 13:28:01 -0700200 }
Dan Willemsen490fd492015-11-24 17:53:15 -0800201
202 if runtime.GOOS == "linux" {
203 v.CrossHost = stringPtr("windows")
204 v.CrossHostArch = stringPtr("x86")
Dan Willemsen07cd0512016-02-03 23:16:33 -0800205 v.CrossHostSecondaryArch = stringPtr("x86_64")
Dan Willemsen490fd492015-11-24 17:53:15 -0800206 }
Colin Cross7f64b6d2015-07-09 13:57:48 -0700207}
208
Colin Cross635c3b02016-05-18 15:37:25 -0700209func variableMutator(mctx BottomUpMutatorContext) {
210 var module Module
Colin Cross7f64b6d2015-07-09 13:57:48 -0700211 var ok bool
Colin Cross635c3b02016-05-18 15:37:25 -0700212 if module, ok = mctx.Module().(Module); !ok {
Colin Cross7f64b6d2015-07-09 13:57:48 -0700213 return
214 }
215
216 // TODO: depend on config variable, create variants, propagate variants up tree
217 a := module.base()
Colin Cross06a931b2015-10-28 17:23:31 -0700218 variableValues := reflect.ValueOf(&a.variableProperties.Product_variables).Elem()
Colin Cross7f64b6d2015-07-09 13:57:48 -0700219 zeroValues := reflect.ValueOf(zeroProductVariables.Product_variables)
220
221 for i := 0; i < variableValues.NumField(); i++ {
222 variableValue := variableValues.Field(i)
223 zeroValue := zeroValues.Field(i)
Colin Cross485e5722015-08-27 13:28:01 -0700224 name := variableValues.Type().Field(i).Name
225 property := "product_variables." + proptools.PropertyNameForField(name)
Colin Cross7f64b6d2015-07-09 13:57:48 -0700226
Colin Crossa6bc19e2015-09-16 13:53:42 -0700227 // Check that the variable was set for the product
Colin Cross485e5722015-08-27 13:28:01 -0700228 val := reflect.ValueOf(mctx.Config().(Config).ProductVariables).FieldByName(name)
Colin Crossa6bc19e2015-09-16 13:53:42 -0700229 if !val.IsValid() || val.Kind() != reflect.Ptr || val.IsNil() {
230 continue
Colin Cross7f64b6d2015-07-09 13:57:48 -0700231 }
Colin Crossa6bc19e2015-09-16 13:53:42 -0700232
233 val = val.Elem()
234
235 // For bools, check that the value is true
236 if val.Kind() == reflect.Bool && val.Bool() == false {
237 continue
238 }
239
240 // Check if any properties were set for the module
241 if reflect.DeepEqual(variableValue.Interface(), zeroValue.Interface()) {
242 continue
243 }
244
245 a.setVariableProperties(mctx, property, variableValue, val.Interface())
Colin Cross7f64b6d2015-07-09 13:57:48 -0700246 }
247}
248
Colin Cross635c3b02016-05-18 15:37:25 -0700249func (a *ModuleBase) setVariableProperties(ctx BottomUpMutatorContext,
Colin Cross7f64b6d2015-07-09 13:57:48 -0700250 prefix string, productVariablePropertyValue reflect.Value, variableValue interface{}) {
251
Colin Cross7e0eaf12017-05-05 16:16:24 -0700252 printfIntoProperties(ctx, prefix, productVariablePropertyValue, variableValue)
Colin Cross7f64b6d2015-07-09 13:57:48 -0700253
Colin Cross06a931b2015-10-28 17:23:31 -0700254 err := proptools.AppendMatchingProperties(a.generalProperties,
255 productVariablePropertyValue.Addr().Interface(), nil)
256 if err != nil {
257 if propertyErr, ok := err.(*proptools.ExtendPropertyError); ok {
258 ctx.PropertyErrorf(propertyErr.Property, "%s", propertyErr.Err.Error())
259 } else {
260 panic(err)
261 }
262 }
Colin Cross7f64b6d2015-07-09 13:57:48 -0700263}
264
Colin Cross7e0eaf12017-05-05 16:16:24 -0700265func printfIntoPropertiesError(ctx BottomUpMutatorContext, prefix string,
266 productVariablePropertyValue reflect.Value, i int, err error) {
267
268 field := productVariablePropertyValue.Type().Field(i).Name
269 property := prefix + "." + proptools.PropertyNameForField(field)
270 ctx.PropertyErrorf(property, "%s", err)
271}
272
273func printfIntoProperties(ctx BottomUpMutatorContext, prefix string,
274 productVariablePropertyValue reflect.Value, variableValue interface{}) {
275
Colin Cross7f64b6d2015-07-09 13:57:48 -0700276 for i := 0; i < productVariablePropertyValue.NumField(); i++ {
277 propertyValue := productVariablePropertyValue.Field(i)
Colin Crossdd0dbe62015-12-02 15:24:38 -0800278 kind := propertyValue.Kind()
279 if kind == reflect.Ptr {
280 if propertyValue.IsNil() {
281 continue
282 }
283 propertyValue = propertyValue.Elem()
284 }
Colin Cross7f64b6d2015-07-09 13:57:48 -0700285 switch propertyValue.Kind() {
286 case reflect.String:
Colin Cross7e0eaf12017-05-05 16:16:24 -0700287 err := printfIntoProperty(propertyValue, variableValue)
288 if err != nil {
289 printfIntoPropertiesError(ctx, prefix, productVariablePropertyValue, i, err)
290 }
Colin Cross7f64b6d2015-07-09 13:57:48 -0700291 case reflect.Slice:
292 for j := 0; j < propertyValue.Len(); j++ {
Colin Cross7e0eaf12017-05-05 16:16:24 -0700293 err := printfIntoProperty(propertyValue.Index(j), variableValue)
294 if err != nil {
295 printfIntoPropertiesError(ctx, prefix, productVariablePropertyValue, i, err)
296 }
Colin Cross7f64b6d2015-07-09 13:57:48 -0700297 }
Colin Crossdd0dbe62015-12-02 15:24:38 -0800298 case reflect.Bool:
299 // Nothing
Colin Cross7f64b6d2015-07-09 13:57:48 -0700300 case reflect.Struct:
Colin Cross7e0eaf12017-05-05 16:16:24 -0700301 printfIntoProperties(ctx, prefix, propertyValue, variableValue)
Colin Cross7f64b6d2015-07-09 13:57:48 -0700302 default:
303 panic(fmt.Errorf("unsupported field kind %q", propertyValue.Kind()))
304 }
305 }
306}
307
Colin Cross7e0eaf12017-05-05 16:16:24 -0700308func printfIntoProperty(propertyValue reflect.Value, variableValue interface{}) error {
Colin Cross7f64b6d2015-07-09 13:57:48 -0700309 s := propertyValue.String()
Colin Cross7e0eaf12017-05-05 16:16:24 -0700310
311 count := strings.Count(s, "%")
312 if count == 0 {
313 return nil
314 }
315
316 if count > 1 {
317 return fmt.Errorf("product variable properties only support a single '%%'")
318 }
319
Colin Cross7f64b6d2015-07-09 13:57:48 -0700320 if strings.Contains(s, "%d") {
321 switch v := variableValue.(type) {
322 case int:
Colin Cross7e0eaf12017-05-05 16:16:24 -0700323 // Nothing
Colin Cross7f64b6d2015-07-09 13:57:48 -0700324 case bool:
325 if v {
Colin Cross7e0eaf12017-05-05 16:16:24 -0700326 variableValue = 1
327 } else {
328 variableValue = 0
Colin Cross7f64b6d2015-07-09 13:57:48 -0700329 }
330 default:
Colin Cross7e0eaf12017-05-05 16:16:24 -0700331 return fmt.Errorf("unsupported type %T for %%d", variableValue)
Colin Cross7f64b6d2015-07-09 13:57:48 -0700332 }
Colin Cross7e0eaf12017-05-05 16:16:24 -0700333 } else if strings.Contains(s, "%s") {
334 switch variableValue.(type) {
335 case string:
336 // Nothing
337 default:
338 return fmt.Errorf("unsupported type %T for %%s", variableValue)
339 }
340 } else {
341 return fmt.Errorf("unsupported %% in product variable property")
Colin Cross7f64b6d2015-07-09 13:57:48 -0700342 }
Colin Cross7e0eaf12017-05-05 16:16:24 -0700343
344 propertyValue.Set(reflect.ValueOf(fmt.Sprintf(s, variableValue)))
345
346 return nil
Colin Cross7f64b6d2015-07-09 13:57:48 -0700347}