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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
|
// Copyright (C) 2024 The Android Open Source Project
//
// 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 fsgen
import (
"fmt"
"slices"
"strings"
"sync"
"android/soong/android"
"github.com/google/blueprint/proptools"
)
func RegisterCollectFileSystemDepsMutators(ctx android.RegisterMutatorsContext) {
ctx.BottomUp("fs_collect_deps", collectDepsMutator).MutatesGlobalState()
ctx.BottomUp("fs_set_deps", setDepsMutator)
}
var fsGenStateOnceKey = android.NewOnceKey("FsGenState")
var fsGenRemoveOverridesOnceKey = android.NewOnceKey("FsGenRemoveOverrides")
// Map of partition module name to its partition that may be generated by Soong.
// Note that it is not guaranteed that all modules returned by this function are successfully
// created.
func getAllSoongGeneratedPartitionNames(config android.Config, partitions []string) map[string]string {
ret := map[string]string{}
for _, partition := range partitions {
ret[generatedModuleNameForPartition(config, partition)] = partition
}
return ret
}
type depCandidateProps struct {
Namespace string
Multilib string
Arch []android.ArchType
}
// Map of module name to depCandidateProps
type multilibDeps map[string]*depCandidateProps
// Information necessary to generate the filesystem modules, including details about their
// dependencies
type FsGenState struct {
// List of modules in `PRODUCT_PACKAGES` and `PRODUCT_PACKAGES_DEBUG`
depCandidates []string
// Map of names of partition to the information of modules to be added as deps
fsDeps map[string]*multilibDeps
// Information about the main soong-generated partitions
soongGeneratedPartitions allGeneratedPartitionData
// Mutex to protect the fsDeps
fsDepsMutex sync.Mutex
// Map of _all_ soong module names to their corresponding installation properties
moduleToInstallationProps map[string]installationProperties
// List of prebuilt_* modules that are autogenerated.
generatedPrebuiltEtcModuleNames []string
// Mapping from a path to an avb key to the name of a filegroup module that contains it
avbKeyFilegroups map[string]string
}
type installationProperties struct {
Required []string
Overrides []string
}
func defaultDepCandidateProps(config android.Config) *depCandidateProps {
return &depCandidateProps{
Namespace: ".",
Arch: []android.ArchType{config.BuildArch},
}
}
func createFsGenState(ctx android.LoadHookContext, generatedPrebuiltEtcModuleNames []string, avbpubkeyGenerated bool) *FsGenState {
return ctx.Config().Once(fsGenStateOnceKey, func() interface{} {
partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse
candidates := android.FirstUniqueStrings(android.Concat(partitionVars.ProductPackages, partitionVars.ProductPackagesDebug))
candidates = android.Concat(candidates, generatedPrebuiltEtcModuleNames)
fsGenState := FsGenState{
depCandidates: candidates,
fsDeps: map[string]*multilibDeps{
// These additional deps are added according to the cuttlefish system image bp.
"system": {
// keep-sorted start
"com.android.apex.cts.shim.v1_prebuilt": defaultDepCandidateProps(ctx.Config()),
"dex_bootjars": defaultDepCandidateProps(ctx.Config()),
"framework_compatibility_matrix.device.xml": defaultDepCandidateProps(ctx.Config()),
"init.environ.rc-soong": defaultDepCandidateProps(ctx.Config()),
"libcompiler_rt": defaultDepCandidateProps(ctx.Config()),
"libdmabufheap": defaultDepCandidateProps(ctx.Config()),
"libgsi": defaultDepCandidateProps(ctx.Config()),
"llndk.libraries.txt": defaultDepCandidateProps(ctx.Config()),
"logpersist.start": defaultDepCandidateProps(ctx.Config()),
"notice_xml_system": defaultDepCandidateProps(ctx.Config()),
"update_engine_sideload": defaultDepCandidateProps(ctx.Config()),
// keep-sorted end
},
"vendor": {
"fs_config_files_vendor": defaultDepCandidateProps(ctx.Config()),
"fs_config_dirs_vendor": defaultDepCandidateProps(ctx.Config()),
"notice_xml_vendor": defaultDepCandidateProps(ctx.Config()),
generatedModuleName(ctx.Config(), "vendor-build.prop"): defaultDepCandidateProps(ctx.Config()),
},
"odm": {
// fs_config_* files are automatically installed for all products with odm partitions.
// https://cs.android.com/android/_/android/platform/build/+/e4849e87ab660b59a6501b3928693db065ee873b:tools/fs_config/Android.mk;l=34;drc=8d6481b92c4b4e9b9f31a61545b6862090fcc14b;bpv=1;bpt=0
"fs_config_files_odm": defaultDepCandidateProps(ctx.Config()),
"fs_config_dirs_odm": defaultDepCandidateProps(ctx.Config()),
"notice_xml_odm": defaultDepCandidateProps(ctx.Config()),
},
"product": {
"notice_xml_product": defaultDepCandidateProps(ctx.Config()),
},
"system_ext": {
// VNDK apexes are automatically included.
// This hardcoded list will need to be updated if `PRODUCT_EXTRA_VNDK_VERSIONS` is updated.
// https://cs.android.com/android/_/android/platform/build/+/adba533072b00c53ac0f198c550a3cbd7a00e4cd:core/main.mk;l=984;bpv=1;bpt=0;drc=174db7b179592cf07cbfd2adb0119486fda911e7
"com.android.vndk.v30": defaultDepCandidateProps(ctx.Config()),
"com.android.vndk.v31": defaultDepCandidateProps(ctx.Config()),
"com.android.vndk.v32": defaultDepCandidateProps(ctx.Config()),
"com.android.vndk.v33": defaultDepCandidateProps(ctx.Config()),
"com.android.vndk.v34": defaultDepCandidateProps(ctx.Config()),
"notice_xml_system_ext": defaultDepCandidateProps(ctx.Config()),
},
"userdata": {},
"system_dlkm": {
// these are phony required deps of the phony fs_config_dirs_nonsystem
"fs_config_dirs_system_dlkm": defaultDepCandidateProps(ctx.Config()),
"fs_config_files_system_dlkm": defaultDepCandidateProps(ctx.Config()),
"notice_xml_system_dlkm": defaultDepCandidateProps(ctx.Config()),
// build props are automatically added to `ALL_DEFAULT_INSTALLED_MODULES`
"system_dlkm-build.prop": defaultDepCandidateProps(ctx.Config()),
},
"vendor_dlkm": {
"fs_config_dirs_vendor_dlkm": defaultDepCandidateProps(ctx.Config()),
"fs_config_files_vendor_dlkm": defaultDepCandidateProps(ctx.Config()),
"notice_xml_vendor_dlkm": defaultDepCandidateProps(ctx.Config()),
"vendor_dlkm-build.prop": defaultDepCandidateProps(ctx.Config()),
},
"odm_dlkm": {
"fs_config_dirs_odm_dlkm": defaultDepCandidateProps(ctx.Config()),
"fs_config_files_odm_dlkm": defaultDepCandidateProps(ctx.Config()),
"notice_xml_odm_dlkm": defaultDepCandidateProps(ctx.Config()),
"odm_dlkm-build.prop": defaultDepCandidateProps(ctx.Config()),
},
"ramdisk": {},
"vendor_ramdisk": {},
"recovery": {
"sepolicy.recovery": defaultDepCandidateProps(ctx.Config()),
"plat_file_contexts.recovery": defaultDepCandidateProps(ctx.Config()),
"plat_service_contexts.recovery": defaultDepCandidateProps(ctx.Config()),
"plat_property_contexts.recovery": defaultDepCandidateProps(ctx.Config()),
"system_ext_file_contexts.recovery": defaultDepCandidateProps(ctx.Config()),
"system_ext_service_contexts.recovery": defaultDepCandidateProps(ctx.Config()),
"system_ext_property_contexts.recovery": defaultDepCandidateProps(ctx.Config()),
"vendor_file_contexts.recovery": defaultDepCandidateProps(ctx.Config()),
"vendor_service_contexts.recovery": defaultDepCandidateProps(ctx.Config()),
"vendor_property_contexts.recovery": defaultDepCandidateProps(ctx.Config()),
"odm_file_contexts.recovery": defaultDepCandidateProps(ctx.Config()),
"odm_property_contexts.recovery": defaultDepCandidateProps(ctx.Config()),
"product_file_contexts.recovery": defaultDepCandidateProps(ctx.Config()),
"product_service_contexts.recovery": defaultDepCandidateProps(ctx.Config()),
"product_property_contexts.recovery": defaultDepCandidateProps(ctx.Config()),
},
},
fsDepsMutex: sync.Mutex{},
moduleToInstallationProps: map[string]installationProperties{},
generatedPrebuiltEtcModuleNames: generatedPrebuiltEtcModuleNames,
avbKeyFilegroups: map[string]string{},
}
if avbpubkeyGenerated {
(*fsGenState.fsDeps["product"])["system_other_avbpubkey"] = defaultDepCandidateProps(ctx.Config())
}
// Add common resources `prebuilt_res` module as dep of recovery partition
(*fsGenState.fsDeps["recovery"])[fmt.Sprintf("recovery-resources-common-%s", getDpi(ctx))] = defaultDepCandidateProps(ctx.Config())
(*fsGenState.fsDeps["recovery"])[getRecoveryFontModuleName(ctx)] = defaultDepCandidateProps(ctx.Config())
(*fsGenState.fsDeps["recovery"])[createRecoveryBuildProp(ctx)] = defaultDepCandidateProps(ctx.Config())
return &fsGenState
}).(*FsGenState)
}
func checkDepModuleInMultipleNamespaces(mctx android.BottomUpMutatorContext, foundDeps multilibDeps, module string, partitionName string) {
otherNamespace := mctx.Namespace().Path
if val, found := foundDeps[module]; found && otherNamespace != "." && !android.InList(val.Namespace, []string{".", otherNamespace}) {
mctx.ModuleErrorf("found in multiple namespaces(%s and %s) when including in %s partition", val.Namespace, otherNamespace, partitionName)
}
}
func appendDepIfAppropriate(mctx android.BottomUpMutatorContext, deps *multilibDeps, installPartition string) {
moduleName := mctx.ModuleName()
checkDepModuleInMultipleNamespaces(mctx, *deps, moduleName, installPartition)
if _, ok := (*deps)[moduleName]; ok {
// Prefer the namespace-specific module over the platform module
if mctx.Namespace().Path != "." {
(*deps)[moduleName].Namespace = mctx.Namespace().Path
}
(*deps)[moduleName].Arch = append((*deps)[moduleName].Arch, mctx.Module().Target().Arch.ArchType)
} else {
multilib, _ := mctx.Module().DecodeMultilib(mctx)
(*deps)[moduleName] = &depCandidateProps{
Namespace: mctx.Namespace().Path,
Multilib: multilib,
Arch: []android.ArchType{mctx.Module().Target().Arch.ArchType},
}
}
}
func collectDepsMutator(mctx android.BottomUpMutatorContext) {
m := mctx.Module()
if m.Target().Os.Class != android.Device {
return
}
fsGenState := mctx.Config().Get(fsGenStateOnceKey).(*FsGenState)
fsGenState.fsDepsMutex.Lock()
defer fsGenState.fsDepsMutex.Unlock()
if slices.Contains(fsGenState.depCandidates, mctx.ModuleName()) {
installPartition := m.PartitionTag(mctx.DeviceConfig())
// Only add the module as dependency when:
// - its enabled
// - its namespace is included in PRODUCT_SOONG_NAMESPACES
if m.Enabled(mctx) && m.ExportedToMake() {
appendDepIfAppropriate(mctx, fsGenState.fsDeps[installPartition], installPartition)
}
}
// store the map of module to (required,overrides) even if the module is not in PRODUCT_PACKAGES.
// the module might be installed transitively.
if m.Enabled(mctx) && m.ExportedToMake() {
fsGenState.moduleToInstallationProps[m.Name()] = installationProperties{
Required: m.RequiredModuleNames(mctx),
Overrides: m.Overrides(),
}
}
}
type depsStruct struct {
Deps []string
}
type multilibDepsStruct struct {
Common depsStruct
Lib32 depsStruct
Lib64 depsStruct
Both depsStruct
Prefer32 depsStruct
}
type packagingPropsStruct struct {
High_priority_deps []string
Deps []string
Multilib multilibDepsStruct
}
func fullyQualifiedModuleName(moduleName, namespace string) string {
if namespace == "." {
return moduleName
}
return fmt.Sprintf("//%s:%s", namespace, moduleName)
}
func getBitness(archTypes []android.ArchType) (ret []string) {
for _, archType := range archTypes {
if archType.Multilib == "" {
ret = append(ret, android.COMMON_VARIANT)
} else {
ret = append(ret, archType.Bitness())
}
}
return ret
}
func setDepsMutator(mctx android.BottomUpMutatorContext) {
removeOverriddenDeps(mctx)
fsGenState := mctx.Config().Get(fsGenStateOnceKey).(*FsGenState)
fsDeps := fsGenState.fsDeps
m := mctx.Module()
if partition := fsGenState.soongGeneratedPartitions.typeForName(m.Name()); partition != "" {
if fsGenState.soongGeneratedPartitions.isHandwritten(m.Name()) {
// Handwritten image, don't modify it
return
}
depsStruct := generateDepStruct(*fsDeps[partition], fsGenState.generatedPrebuiltEtcModuleNames)
if err := proptools.AppendMatchingProperties(m.GetProperties(), depsStruct, nil); err != nil {
mctx.ModuleErrorf(err.Error())
}
}
}
// removeOverriddenDeps collects PRODUCT_PACKAGES and (transitive) required deps.
// it then removes any modules which appear in `overrides` of the above list.
func removeOverriddenDeps(mctx android.BottomUpMutatorContext) {
mctx.Config().Once(fsGenRemoveOverridesOnceKey, func() interface{} {
fsGenState := mctx.Config().Get(fsGenStateOnceKey).(*FsGenState)
fsDeps := fsGenState.fsDeps
overridden := map[string]bool{}
allDeps := []string{}
// Step 1: Initialization: Append PRODUCT_PACKAGES to the queue
for _, fsDep := range fsDeps {
for depName, _ := range *fsDep {
allDeps = append(allDeps, depName)
}
}
// Step 2: Process the queue, and add required modules to the queue.
i := 0
for {
if i == len(allDeps) {
break
}
depName := allDeps[i]
for _, overrides := range fsGenState.moduleToInstallationProps[depName].Overrides {
overridden[overrides] = true
}
// add required dep to the queue.
allDeps = append(allDeps, fsGenState.moduleToInstallationProps[depName].Required...)
i += 1
}
// Step 3: Delete all the overridden modules.
for overridden, _ := range overridden {
for partition, _ := range fsDeps {
delete(*fsDeps[partition], overridden)
}
}
return nil
})
}
var HighPriorityDeps = []string{}
func isHighPriorityDep(depName string) bool {
for _, highPriorityDeps := range HighPriorityDeps {
if strings.HasPrefix(depName, highPriorityDeps) {
return true
}
}
return false
}
func generateDepStruct(deps map[string]*depCandidateProps, highPriorityDeps []string) *packagingPropsStruct {
depsStruct := packagingPropsStruct{}
for depName, depProps := range deps {
bitness := getBitness(depProps.Arch)
fullyQualifiedDepName := fullyQualifiedModuleName(depName, depProps.Namespace)
if android.InList(depName, highPriorityDeps) {
depsStruct.High_priority_deps = append(depsStruct.High_priority_deps, fullyQualifiedDepName)
} else if android.InList("32", bitness) && android.InList("64", bitness) {
// If both 32 and 64 bit variants are enabled for this module
switch depProps.Multilib {
case string(android.MultilibBoth):
depsStruct.Multilib.Both.Deps = append(depsStruct.Multilib.Both.Deps, fullyQualifiedDepName)
case string(android.MultilibCommon), string(android.MultilibFirst):
depsStruct.Deps = append(depsStruct.Deps, fullyQualifiedDepName)
case "32":
depsStruct.Multilib.Lib32.Deps = append(depsStruct.Multilib.Lib32.Deps, fullyQualifiedDepName)
case "64", "darwin_universal":
depsStruct.Multilib.Lib64.Deps = append(depsStruct.Multilib.Lib64.Deps, fullyQualifiedDepName)
case "prefer32", "first_prefer32":
depsStruct.Multilib.Prefer32.Deps = append(depsStruct.Multilib.Prefer32.Deps, fullyQualifiedDepName)
default:
depsStruct.Multilib.Both.Deps = append(depsStruct.Multilib.Both.Deps, fullyQualifiedDepName)
}
} else if android.InList("64", bitness) {
// If only 64 bit variant is enabled
depsStruct.Multilib.Lib64.Deps = append(depsStruct.Multilib.Lib64.Deps, fullyQualifiedDepName)
} else if android.InList("32", bitness) {
// If only 32 bit variant is enabled
depsStruct.Multilib.Lib32.Deps = append(depsStruct.Multilib.Lib32.Deps, fullyQualifiedDepName)
} else {
// If only common variant is enabled
depsStruct.Multilib.Common.Deps = append(depsStruct.Multilib.Common.Deps, fullyQualifiedDepName)
}
}
depsStruct.Deps = android.SortedUniqueStrings(depsStruct.Deps)
depsStruct.Multilib.Lib32.Deps = android.SortedUniqueStrings(depsStruct.Multilib.Lib32.Deps)
depsStruct.Multilib.Lib64.Deps = android.SortedUniqueStrings(depsStruct.Multilib.Lib64.Deps)
depsStruct.Multilib.Prefer32.Deps = android.SortedUniqueStrings(depsStruct.Multilib.Prefer32.Deps)
depsStruct.Multilib.Both.Deps = android.SortedUniqueStrings(depsStruct.Multilib.Both.Deps)
depsStruct.Multilib.Common.Deps = android.SortedUniqueStrings(depsStruct.Multilib.Common.Deps)
depsStruct.High_priority_deps = android.SortedUniqueStrings(depsStruct.High_priority_deps)
return &depsStruct
}
|