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
|
// 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 filesystem
import (
"strings"
"sync/atomic"
"android/soong/android"
"github.com/google/blueprint"
"github.com/google/blueprint/proptools"
)
type PartitionNameProperties struct {
// Name of the boot partition filesystem module
Boot_partition_name *string
// Name of the vendor boot partition filesystem module
Vendor_boot_partition_name *string
// Name of the init boot partition filesystem module
Init_boot_partition_name *string
// Name of the system partition filesystem module
System_partition_name *string
// Name of the system_ext partition filesystem module
System_ext_partition_name *string
// Name of the product partition filesystem module
Product_partition_name *string
// Name of the vendor partition filesystem module
Vendor_partition_name *string
// Name of the odm partition filesystem module
Odm_partition_name *string
// Name of the recovery partition filesystem module
Recovery_partition_name *string
// The vbmeta partition and its "chained" partitions
Vbmeta_partitions []string
// Name of the userdata partition filesystem module
Userdata_partition_name *string
// Name of the system_dlkm partition filesystem module
System_dlkm_partition_name *string
// Name of the vendor_dlkm partition filesystem module
Vendor_dlkm_partition_name *string
// Name of the odm_dlkm partition filesystem module
Odm_dlkm_partition_name *string
}
type DeviceProperties struct {
// Path to the prebuilt bootloader that would be copied to PRODUCT_OUT
Bootloader *string `android:"path"`
// Path to android-info.txt file containing board specific info.
Android_info *string `android:"path"`
}
type androidDevice struct {
android.ModuleBase
partitionProps PartitionNameProperties
deviceProps DeviceProperties
// copyToProductOutTimestamp for copying necessary files to PRODUCT_OUT
copyToProductOutTimestamp android.WritablePath
}
func AndroidDeviceFactory() android.Module {
module := &androidDevice{}
module.AddProperties(&module.partitionProps, &module.deviceProps)
android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibFirst)
return module
}
var numAutogeneratedAndroidDevicesOnceKey android.OnceKey = android.NewOnceKey("num_auto_generated_anroid_devices")
type partitionDepTagType struct {
blueprint.BaseDependencyTag
}
var filesystemDepTag partitionDepTagType
func (a *androidDevice) DepsMutator(ctx android.BottomUpMutatorContext) {
addDependencyIfDefined := func(dep *string) {
if dep != nil {
ctx.AddDependency(ctx.Module(), filesystemDepTag, proptools.String(dep))
}
}
addDependencyIfDefined(a.partitionProps.Boot_partition_name)
addDependencyIfDefined(a.partitionProps.Init_boot_partition_name)
addDependencyIfDefined(a.partitionProps.Vendor_boot_partition_name)
addDependencyIfDefined(a.partitionProps.System_partition_name)
addDependencyIfDefined(a.partitionProps.System_ext_partition_name)
addDependencyIfDefined(a.partitionProps.Product_partition_name)
addDependencyIfDefined(a.partitionProps.Vendor_partition_name)
addDependencyIfDefined(a.partitionProps.Odm_partition_name)
addDependencyIfDefined(a.partitionProps.Userdata_partition_name)
addDependencyIfDefined(a.partitionProps.System_dlkm_partition_name)
addDependencyIfDefined(a.partitionProps.Vendor_dlkm_partition_name)
addDependencyIfDefined(a.partitionProps.Odm_dlkm_partition_name)
addDependencyIfDefined(a.partitionProps.Recovery_partition_name)
for _, vbmetaPartition := range a.partitionProps.Vbmeta_partitions {
ctx.AddDependency(ctx.Module(), filesystemDepTag, vbmetaPartition)
}
}
func (a *androidDevice) copyToProductOut(ctx android.ModuleContext, builder *android.RuleBuilder, src android.Path, dest string) {
destPath := android.PathForModuleInPartitionInstall(ctx, "").Join(ctx, dest)
builder.Command().Text("rsync").Flag("-a").Flag("--checksum").Input(src).Text(destPath.String())
}
func (a *androidDevice) copyFilesToProductOut(ctx android.ModuleContext) {
a.copyToProductOutTimestamp = android.PathForModuleOut(ctx, "timestamp")
builder := android.NewRuleBuilder(pctx, ctx)
builder.Command().Text("touch").Output(a.copyToProductOutTimestamp)
// List all individual files to be copied to PRODUCT_OUT here
if a.deviceProps.Bootloader != nil {
a.copyToProductOut(ctx, builder, android.PathForModuleSrc(ctx, proptools.String(a.deviceProps.Bootloader)), "bootloader")
}
builder.Build("copy_to_product_out", "Copy files to PRODUCT_OUT")
}
func (a *androidDevice) GenerateAndroidBuildActions(ctx android.ModuleContext) {
a.buildTargetFilesZip(ctx)
var deps []android.Path
ctx.VisitDirectDepsWithTag(filesystemDepTag, func(m android.Module) {
imageOutput, ok := android.OtherModuleProvider(ctx, m, android.OutputFilesProvider)
if !ok {
ctx.ModuleErrorf("Partition module %s doesn't set OutputfilesProvider", m.Name())
}
if len(imageOutput.DefaultOutputFiles) != 1 {
ctx.ModuleErrorf("Partition module %s should provide exact 1 output file", m.Name())
}
deps = append(deps, imageOutput.DefaultOutputFiles[0])
})
a.copyFilesToProductOut(ctx)
allImagesStamp := android.PathForModuleOut(ctx, "all_images_stamp")
ctx.Build(pctx, android.BuildParams{
Rule: android.Touch,
Output: allImagesStamp,
Implicits: deps,
Validation: a.copyToProductOutTimestamp,
})
ctx.SetOutputFiles(android.Paths{allImagesStamp}, "")
ctx.CheckbuildFile(allImagesStamp)
if ctx.OtherModuleIsAutoGenerated(ctx.Module()) {
numAutogeneratedAndroidDevices := ctx.Config().Once(numAutogeneratedAndroidDevicesOnceKey, func() interface{} {
return &atomic.Int32{}
}).(*atomic.Int32)
total := numAutogeneratedAndroidDevices.Add(1)
if total > 1 {
// There should only be 1 autogenerated android_device module. That one will be
// made the default thing to build in soong-only builds.
ctx.ModuleErrorf("There cannot be more than 1 autogenerated android_device module")
}
}
if !ctx.Config().KatiEnabled() && ctx.OtherModuleIsAutoGenerated(ctx.Module()) {
// In soong-only builds, build this module by default.
// This is the analogue to this make code:
// https://cs.android.com/android/platform/superproject/main/+/main:build/make/core/main.mk;l=1396;drc=6595459cdd8164a6008335f6372c9f97b9094060
ctx.Phony("droidcore-unbundled", allImagesStamp)
}
}
type targetFilesZipCopy struct {
srcModule *string
destSubdir string
}
func (a *androidDevice) buildTargetFilesZip(ctx android.ModuleContext) {
targetFilesDir := android.PathForModuleOut(ctx, "target_files_dir")
targetFilesZip := android.PathForModuleOut(ctx, "target_files.zip")
builder := android.NewRuleBuilder(pctx, ctx)
builder.Command().Textf("rm -rf %s", targetFilesDir.String())
builder.Command().Textf("mkdir -p %s", targetFilesDir.String())
toCopy := []targetFilesZipCopy{
targetFilesZipCopy{a.partitionProps.System_partition_name, "SYSTEM"},
targetFilesZipCopy{a.partitionProps.System_ext_partition_name, "SYSTEM_EXT"},
targetFilesZipCopy{a.partitionProps.Product_partition_name, "PRODUCT"},
targetFilesZipCopy{a.partitionProps.Vendor_partition_name, "VENDOR"},
targetFilesZipCopy{a.partitionProps.Odm_partition_name, "ODM"},
targetFilesZipCopy{a.partitionProps.System_dlkm_partition_name, "SYSTEM_DLKM"},
targetFilesZipCopy{a.partitionProps.Vendor_dlkm_partition_name, "VENDOR_DLKM"},
targetFilesZipCopy{a.partitionProps.Odm_dlkm_partition_name, "ODM_DLKM"},
targetFilesZipCopy{a.partitionProps.Init_boot_partition_name, "BOOT/RAMDISK"},
targetFilesZipCopy{a.partitionProps.Init_boot_partition_name, "INIT_BOOT/RAMDISK"},
targetFilesZipCopy{a.partitionProps.Vendor_boot_partition_name, "VENDOR_BOOT/RAMDISK"},
}
// TODO: Handle cases where recovery files are copied to BOOT/ or RECOVERY/
// https://cs.android.com/android/platform/superproject/main/+/main:build/make/core/Makefile;l=6211-6219?q=core%2FMakefile&ss=android%2Fplatform%2Fsuperproject%2Fmain
if ctx.DeviceConfig().BoardMoveRecoveryResourcesToVendorBoot() {
toCopy = append(toCopy, targetFilesZipCopy{a.partitionProps.Recovery_partition_name, "VENDOR_BOOT/RAMDISK"})
}
// Create an IMAGES/ subdirectory
builder.Command().Textf("mkdir -p %s/IMAGES/", targetFilesDir.String())
if a.deviceProps.Bootloader != nil {
builder.Command().Textf("cp ").Input(android.PathForModuleSrc(ctx, proptools.String(a.deviceProps.Bootloader))).Textf(" %s/IMAGES/bootloader", targetFilesDir.String())
}
for _, zipCopy := range toCopy {
if zipCopy.srcModule == nil {
continue
}
fsInfo := a.getFilesystemInfo(ctx, *zipCopy.srcModule)
subdir := zipCopy.destSubdir
rootDirString := fsInfo.RootDir.String()
if subdir == "SYSTEM" {
rootDirString = rootDirString + "/system"
}
builder.Command().Textf("mkdir -p %s/%s", targetFilesDir.String(), subdir)
builder.Command().
BuiltTool("acp").
Textf("-rd %s/. %s/%s", rootDirString, targetFilesDir, subdir).
Implicit(fsInfo.Output) // so that the staging dir is built
if subdir == "SYSTEM" {
// Create the ROOT partition in target_files.zip
builder.Command().Textf("rsync --links --exclude=system/* %s/ -r %s/ROOT", fsInfo.RootDir, targetFilesDir.String())
}
builder.Command().Textf("cp %s %s/IMAGES/", fsInfo.Output, targetFilesDir.String())
}
// Copy cmdline, kernel etc. files of boot images
if a.partitionProps.Vendor_boot_partition_name != nil {
bootImg := ctx.GetDirectDepWithTag(proptools.String(a.partitionProps.Vendor_boot_partition_name), filesystemDepTag)
bootImgInfo, _ := android.OtherModuleProvider(ctx, bootImg, BootimgInfoProvider)
builder.Command().Textf("echo %s > %s/VENDOR_BOOT/cmdline", proptools.ShellEscape(strings.Join(bootImgInfo.Cmdline, " ")), targetFilesDir)
builder.Command().Textf("echo %s > %s/VENDOR_BOOT/vendor_cmdline", proptools.ShellEscape(strings.Join(bootImgInfo.Cmdline, " ")), targetFilesDir)
if bootImgInfo.Dtb != nil {
builder.Command().Textf("cp %s %s/VENDOR_BOOT/dtb", bootImgInfo.Dtb, targetFilesDir)
}
if bootImgInfo.Bootconfig != nil {
builder.Command().Textf("cp %s %s/VENDOR_BOOT/vendor_bootconfig", bootImgInfo.Bootconfig, targetFilesDir)
}
}
if a.partitionProps.Boot_partition_name != nil {
bootImg := ctx.GetDirectDepWithTag(proptools.String(a.partitionProps.Boot_partition_name), filesystemDepTag)
bootImgInfo, _ := android.OtherModuleProvider(ctx, bootImg, BootimgInfoProvider)
builder.Command().Textf("echo %s > %s/BOOT/cmdline", proptools.ShellEscape(strings.Join(bootImgInfo.Cmdline, " ")), targetFilesDir)
if bootImgInfo.Dtb != nil {
builder.Command().Textf("cp %s %s/BOOT/dtb", bootImgInfo.Dtb, targetFilesDir)
}
if bootImgInfo.Kernel != nil {
builder.Command().Textf("cp %s %s/BOOT/kernel", bootImgInfo.Kernel, targetFilesDir)
// Even though kernel is not used to build vendor_boot, copy the kernel to VENDOR_BOOT to match the behavior of make packaging.
builder.Command().Textf("cp %s %s/VENDOR_BOOT/kernel", bootImgInfo.Kernel, targetFilesDir)
}
if bootImgInfo.Bootconfig != nil {
builder.Command().Textf("cp %s %s/BOOT/bootconfig", bootImgInfo.Bootconfig, targetFilesDir)
}
}
if a.deviceProps.Android_info != nil {
builder.Command().Textf("mkdir -p %s/OTA", targetFilesDir)
builder.Command().Textf("cp %s %s/OTA/android-info.txt", android.PathForModuleSrc(ctx, proptools.String(a.deviceProps.Android_info)), targetFilesDir)
}
builder.Command().
BuiltTool("soong_zip").
Text("-d").
FlagWithOutput("-o ", targetFilesZip).
FlagWithArg("-C ", targetFilesDir.String()).
FlagWithArg("-D ", targetFilesDir.String()).
Text("-sha256")
builder.Build("target_files_"+ctx.ModuleName(), "Build target_files.zip")
}
func (a *androidDevice) getFilesystemInfo(ctx android.ModuleContext, depName string) FilesystemInfo {
fsMod := ctx.GetDirectDepWithTag(depName, filesystemDepTag)
fsInfo, ok := android.OtherModuleProvider(ctx, fsMod, FilesystemProvider)
if !ok {
ctx.ModuleErrorf("Expected dependency %s to be a filesystem", depName)
}
return fsInfo
}
|