1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
// Copyright 2023 Google Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package aconfig
import (
"android/soong/android"
"path/filepath"
"slices"
"strconv"
"strings"
"github.com/google/blueprint"
)
type AconfigReleaseConfigValue struct {
ReleaseConfig string
Values []string `blueprint:"mutated"`
}
type DeclarationsModule struct {
android.ModuleBase
android.DefaultableModuleBase
blueprint.IncrementalModule
// Properties for "aconfig_declarations"
properties struct {
// aconfig files, relative to this Android.bp file
Srcs []string `android:"path"`
// Release config flag package
Package string
// Values for release configs / RELEASE_ACONFIG_VALUE_SETS
// The current release config is `ReleaseConfig: ""`, others
// are from RELEASE_ACONFIG_EXTRA_RELEASE_CONFIGS.
ReleaseConfigValues []AconfigReleaseConfigValue
// Container(system/system_ext/vendor/apex) that this module belongs to
Container string
// The flags will only be repackaged if this prop is true.
Exportable bool
}
}
func DeclarationsFactory() android.Module {
module := &DeclarationsModule{}
android.InitAndroidModule(module)
android.InitDefaultableModule(module)
module.AddProperties(&module.properties)
return module
}
type implicitValuesTagType struct {
blueprint.BaseDependencyTag
// The release config name for these values.
// Empty string for the actual current release config.
ReleaseConfig string
}
var implicitValuesTag = implicitValuesTagType{}
func (module *DeclarationsModule) DepsMutator(ctx android.BottomUpMutatorContext) {
// Validate Properties
if len(module.properties.Srcs) == 0 {
ctx.PropertyErrorf("srcs", "missing source files")
return
}
if len(module.properties.Package) == 0 {
ctx.PropertyErrorf("package", "missing package property")
}
if len(module.properties.Container) == 0 {
ctx.PropertyErrorf("container", "missing container property")
}
// Add a dependency on the aconfig_value_sets defined in
// RELEASE_ACONFIG_VALUE_SETS, and add any aconfig_values that
// match our package.
valuesFromConfig := ctx.Config().ReleaseAconfigValueSets()
if len(valuesFromConfig) > 0 {
ctx.AddDependency(ctx.Module(), implicitValuesTag, valuesFromConfig...)
}
for rcName, valueSets := range ctx.Config().ReleaseAconfigExtraReleaseConfigsValueSets() {
if len(valueSets) > 0 {
ctx.AddDependency(ctx.Module(), implicitValuesTagType{ReleaseConfig: rcName}, valueSets...)
}
}
}
func joinAndPrefix(prefix string, values []string) string {
var sb strings.Builder
for _, v := range values {
sb.WriteString(prefix)
sb.WriteString(v)
}
return sb.String()
}
func optionalVariable(prefix string, value string) string {
var sb strings.Builder
if value != "" {
sb.WriteString(prefix)
sb.WriteString(value)
}
return sb.String()
}
// Assemble the actual filename.
// If `rcName` is not empty, then insert "-{rcName}" into the path before the
// file extension.
func assembleFileName(rcName, path string) string {
if rcName == "" {
return path
}
dir, file := filepath.Split(path)
rcName = "-" + rcName
ext := filepath.Ext(file)
base := file[:len(file)-len(ext)]
return dir + base + rcName + ext
}
func (module *DeclarationsModule) GenerateAndroidBuildActions(ctx android.ModuleContext) {
// Determine which release configs we are processing.
//
// We always process the current release config (empty string).
// We may have been told to also create artifacts for some others.
configs := append([]string{""}, ctx.Config().ReleaseAconfigExtraReleaseConfigs()...)
slices.Sort(configs)
values := make(map[string][]string)
valuesFiles := make(map[string][]android.Path, 0)
providerData := android.AconfigReleaseDeclarationsProviderData{}
ctx.VisitDirectDeps(func(dep android.Module) {
if depData, ok := android.OtherModuleProvider(ctx, dep, valueSetProviderKey); ok {
depTag := ctx.OtherModuleDependencyTag(dep)
for _, config := range configs {
tag := implicitValuesTagType{ReleaseConfig: config}
if depTag == tag {
paths, ok := depData.AvailablePackages[module.properties.Package]
if ok {
valuesFiles[config] = append(valuesFiles[config], paths...)
for _, path := range paths {
values[config] = append(values[config], path.String())
}
}
}
}
}
})
for _, config := range configs {
module.properties.ReleaseConfigValues = append(module.properties.ReleaseConfigValues, AconfigReleaseConfigValue{
ReleaseConfig: config,
Values: values[config],
})
// Intermediate format
declarationFiles := android.PathsForModuleSrc(ctx, module.properties.Srcs)
intermediateCacheFilePath := android.PathForModuleOut(ctx, assembleFileName(config, "intermediate.pb"))
var defaultPermission string
defaultPermission = ctx.Config().ReleaseAconfigFlagDefaultPermission()
if config != "" {
if confPerm, ok := ctx.Config().GetBuildFlag("RELEASE_ACONFIG_FLAG_DEFAULT_PERMISSION_" + config); ok {
defaultPermission = confPerm
}
}
var allowReadWrite bool
if requireAllReadOnly, ok := ctx.Config().GetBuildFlag("RELEASE_ACONFIG_REQUIRE_ALL_READ_ONLY"); ok {
// The build flag (RELEASE_ACONFIG_REQUIRE_ALL_READ_ONLY) is the negation of the aconfig flag
// (allow-read-write) for historical reasons.
// Bool build flags are always "" for false, and generally "true" for true.
allowReadWrite = requireAllReadOnly == ""
}
inputFiles := make([]android.Path, len(declarationFiles))
copy(inputFiles, declarationFiles)
inputFiles = append(inputFiles, valuesFiles[config]...)
args := map[string]string{
"release_version": ctx.Config().ReleaseVersion(),
"package": module.properties.Package,
"declarations": android.JoinPathsWithPrefix(declarationFiles, "--declarations "),
"values": joinAndPrefix(" --values ", values[config]),
"default-permission": optionalVariable(" --default-permission ", defaultPermission),
"allow-read-write": optionalVariable(" --allow-read-write ", strconv.FormatBool(allowReadWrite)),
}
if len(module.properties.Container) > 0 {
args["container"] = "--container " + module.properties.Container
}
ctx.Build(pctx, android.BuildParams{
Rule: aconfigRule,
Output: intermediateCacheFilePath,
Inputs: inputFiles,
Description: "aconfig_declarations",
Args: args,
})
intermediateDumpFilePath := android.PathForModuleOut(ctx, assembleFileName(config, "intermediate.txt"))
ctx.Build(pctx, android.BuildParams{
Rule: aconfigTextRule,
Output: intermediateDumpFilePath,
Inputs: android.Paths{intermediateCacheFilePath},
Description: "aconfig_text",
})
providerData[config] = android.AconfigDeclarationsProviderData{
Package: module.properties.Package,
Container: module.properties.Container,
Exportable: module.properties.Exportable,
IntermediateCacheOutputPath: intermediateCacheFilePath,
IntermediateDumpOutputPath: intermediateDumpFilePath,
}
}
android.SetProvider(ctx, android.AconfigDeclarationsProviderKey, providerData[""])
android.SetProvider(ctx, android.AconfigReleaseDeclarationsProviderKey, providerData)
}
var _ blueprint.Incremental = &DeclarationsModule{}
|