blob: bba4c0d245e56f5db41abeda77216df77fd268c8 [file] [log] [blame]
Inseob Kim4f1f3d92022-04-25 18:23:58 +09001// Copyright 2022 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
15package android
16
17import (
Inseob Kim4f1f3d92022-04-25 18:23:58 +090018 "github.com/google/blueprint/proptools"
19)
20
21func init() {
22 ctx := InitRegistrationContext
Cole Fausta700d7f2024-06-06 14:49:23 -070023 ctx.RegisterModuleType("buildinfo_prop", buildinfoPropFactory)
Inseob Kim4f1f3d92022-04-25 18:23:58 +090024}
25
26type buildinfoPropProperties struct {
27 // Whether this module is directly installable to one of the partitions. Default: true.
28 Installable *bool
Inseob Kim1d914822024-06-11 11:00:30 +090029
30 Product_config *string `android:"path"`
Inseob Kim4f1f3d92022-04-25 18:23:58 +090031}
32
33type buildinfoPropModule struct {
Cole Fausta700d7f2024-06-06 14:49:23 -070034 ModuleBase
Inseob Kim4f1f3d92022-04-25 18:23:58 +090035
36 properties buildinfoPropProperties
37
38 outputFilePath OutputPath
39 installPath InstallPath
40}
41
Inseob Kim4f1f3d92022-04-25 18:23:58 +090042func (p *buildinfoPropModule) installable() bool {
43 return proptools.BoolDefault(p.properties.Installable, true)
44}
45
Inseob Kim8fa54da2024-03-19 16:48:59 +090046func shouldAddBuildThumbprint(config Config) bool {
47 knownOemProperties := []string{
48 "ro.product.brand",
49 "ro.product.name",
50 "ro.product.device",
51 }
52
53 for _, knownProp := range knownOemProperties {
54 if InList(knownProp, config.OemProperties()) {
55 return true
56 }
57 }
58 return false
59}
60
Inseob Kim4f1f3d92022-04-25 18:23:58 +090061func (p *buildinfoPropModule) GenerateAndroidBuildActions(ctx ModuleContext) {
Cole Fausta700d7f2024-06-06 14:49:23 -070062 if ctx.ModuleName() != "buildinfo.prop" || ctx.ModuleDir() != "build/soong" {
63 ctx.ModuleErrorf("There can only be one buildinfo_prop module in build/soong")
64 return
65 }
Inseob Kim4f1f3d92022-04-25 18:23:58 +090066 p.outputFilePath = PathForModuleOut(ctx, p.Name()).OutputPath
mrziwang9429e032024-07-01 11:42:28 -070067 ctx.SetOutputFiles(Paths{p.outputFilePath}, "")
68
Inseob Kim4f1f3d92022-04-25 18:23:58 +090069 if !ctx.Config().KatiEnabled() {
70 WriteFileRule(ctx, p.outputFilePath, "# no buildinfo.prop if kati is disabled")
71 return
72 }
73
Inseob Kim8fa54da2024-03-19 16:48:59 +090074 rule := NewRuleBuilder(pctx, ctx)
Inseob Kim4f1f3d92022-04-25 18:23:58 +090075
76 config := ctx.Config()
77
Inseob Kim8fa54da2024-03-19 16:48:59 +090078 cmd := rule.Command().BuiltTool("buildinfo")
Inseob Kim4f1f3d92022-04-25 18:23:58 +090079
Inseob Kim8fa54da2024-03-19 16:48:59 +090080 cmd.FlagWithInput("--build-hostname-file=", config.BuildHostnameFile(ctx))
Cole Faust89b4d182024-06-06 14:39:32 -070081 // Note: depending on BuildNumberFile will cause the build.prop file to be rebuilt
82 // every build, but that's intentional.
83 cmd.FlagWithInput("--build-number-file=", config.BuildNumberFile(ctx))
Inseob Kim2da72af2024-06-18 11:09:12 +090084 // Export build thumbprint only if the product has specified at least one oem fingerprint property
85 // b/17888863
Inseob Kim8fa54da2024-03-19 16:48:59 +090086 if shouldAddBuildThumbprint(config) {
Cole Faust89b4d182024-06-06 14:39:32 -070087 // In the previous make implementation, a dependency was not added on the thumbprint file
Inseob Kim8fa54da2024-03-19 16:48:59 +090088 cmd.FlagWithArg("--build-thumbprint-file=", config.BuildThumbprintFile(ctx).String())
89 }
Inseob Kim8fa54da2024-03-19 16:48:59 +090090 cmd.FlagWithArg("--build-username=", config.Getenv("BUILD_USERNAME"))
Cole Faust89b4d182024-06-06 14:39:32 -070091 // Technically we should also have a dependency on BUILD_DATETIME_FILE,
92 // but it can be either an absolute or relative path, which is hard to turn into
93 // a Path object. So just rely on the BuildNumberFile always changing to cause
94 // us to rebuild.
Inseob Kim8fa54da2024-03-19 16:48:59 +090095 cmd.FlagWithArg("--date-file=", ctx.Config().Getenv("BUILD_DATETIME_FILE"))
Inseob Kim8fa54da2024-03-19 16:48:59 +090096 cmd.FlagWithInput("--platform-preview-sdk-fingerprint-file=", ApiFingerprintPath(ctx))
Inseob Kim1d914822024-06-11 11:00:30 +090097 cmd.FlagWithInput("--product-config=", PathForModuleSrc(ctx, proptools.String(p.properties.Product_config)))
Inseob Kim8fa54da2024-03-19 16:48:59 +090098 cmd.FlagWithOutput("--out=", p.outputFilePath)
99
100 rule.Build(ctx.ModuleName(), "generating buildinfo props")
Inseob Kim4f1f3d92022-04-25 18:23:58 +0900101
102 if !p.installable() {
103 p.SkipInstall()
104 }
105
106 p.installPath = PathForModuleInstall(ctx)
107 ctx.InstallFile(p.installPath, p.Name(), p.outputFilePath)
108}
109
Inseob Kim4f1f3d92022-04-25 18:23:58 +0900110func (p *buildinfoPropModule) AndroidMkEntries() []AndroidMkEntries {
Cole Fausta700d7f2024-06-06 14:49:23 -0700111 return []AndroidMkEntries{{
Inseob Kim4f1f3d92022-04-25 18:23:58 +0900112 Class: "ETC",
113 OutputFile: OptionalPathForPath(p.outputFilePath),
114 ExtraEntries: []AndroidMkExtraEntriesFunc{
115 func(ctx AndroidMkExtraEntriesContext, entries *AndroidMkEntries) {
116 entries.SetString("LOCAL_MODULE_PATH", p.installPath.String())
117 entries.SetString("LOCAL_INSTALLED_MODULE_STEM", p.outputFilePath.Base())
118 entries.SetBoolIfTrue("LOCAL_UNINSTALLABLE_MODULE", !p.installable())
119 },
120 },
121 }}
122}
123
124// buildinfo_prop module generates a build.prop file, which contains a set of common
125// system/build.prop properties, such as ro.build.version.*. Not all properties are implemented;
126// currently this module is only for microdroid.
Cole Fausta700d7f2024-06-06 14:49:23 -0700127func buildinfoPropFactory() Module {
Inseob Kim4f1f3d92022-04-25 18:23:58 +0900128 module := &buildinfoPropModule{}
129 module.AddProperties(&module.properties)
130 InitAndroidModule(module)
131 return module
132}