blob: 4f6f9838c2170d347bf2c671ecd5542a43168492 [file] [log] [blame]
Jihoon Kangf2c53982024-10-09 17:32:52 +00001// Copyright (C) 2024 The Android Open Source Project
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 filesystem
16
17import (
Jihoon Kang0a6315b2025-01-30 01:14:49 +000018 "fmt"
Spandan Das258c08f2025-01-08 23:30:45 +000019 "strings"
Cole Faustb55a41c2025-01-09 16:53:58 -080020 "sync/atomic"
Spandan Das258c08f2025-01-08 23:30:45 +000021
Jihoon Kangf2c53982024-10-09 17:32:52 +000022 "android/soong/android"
23
24 "github.com/google/blueprint"
25 "github.com/google/blueprint/proptools"
26)
27
28type PartitionNameProperties struct {
Cole Faust2bdc5e52025-01-10 10:29:36 -080029 // Name of the super partition filesystem module
30 Super_partition_name *string
Jihoon Kange7e3ec82025-01-02 21:29:14 +000031 // Name of the boot partition filesystem module
Jihoon Kangf2c53982024-10-09 17:32:52 +000032 Boot_partition_name *string
Jihoon Kange7e3ec82025-01-02 21:29:14 +000033 // Name of the vendor boot partition filesystem module
34 Vendor_boot_partition_name *string
35 // Name of the init boot partition filesystem module
36 Init_boot_partition_name *string
37 // Name of the system partition filesystem module
Jihoon Kangf2c53982024-10-09 17:32:52 +000038 System_partition_name *string
Jihoon Kange7e3ec82025-01-02 21:29:14 +000039 // Name of the system_ext partition filesystem module
Jihoon Kangf2c53982024-10-09 17:32:52 +000040 System_ext_partition_name *string
Jihoon Kange7e3ec82025-01-02 21:29:14 +000041 // Name of the product partition filesystem module
Jihoon Kangf2c53982024-10-09 17:32:52 +000042 Product_partition_name *string
Jihoon Kange7e3ec82025-01-02 21:29:14 +000043 // Name of the vendor partition filesystem module
Jihoon Kangf2c53982024-10-09 17:32:52 +000044 Vendor_partition_name *string
Jihoon Kange7e3ec82025-01-02 21:29:14 +000045 // Name of the odm partition filesystem module
Spandan Dasc5717162024-11-01 18:33:57 +000046 Odm_partition_name *string
Jihoon Kange7e3ec82025-01-02 21:29:14 +000047 // Name of the recovery partition filesystem module
48 Recovery_partition_name *string
Cole Faust3552eb62024-11-06 18:07:26 -080049 // The vbmeta partition and its "chained" partitions
50 Vbmeta_partitions []string
Jihoon Kange7e3ec82025-01-02 21:29:14 +000051 // Name of the userdata partition filesystem module
mrziwang23ba8762024-11-07 16:21:53 -080052 Userdata_partition_name *string
Spandan Dasa0394002025-01-07 18:38:34 +000053 // Name of the system_dlkm partition filesystem module
54 System_dlkm_partition_name *string
55 // Name of the vendor_dlkm partition filesystem module
56 Vendor_dlkm_partition_name *string
57 // Name of the odm_dlkm partition filesystem module
58 Odm_dlkm_partition_name *string
Jihoon Kangf2c53982024-10-09 17:32:52 +000059}
60
Jihoon Kang3be17162025-01-09 20:51:54 +000061type DeviceProperties struct {
62 // Path to the prebuilt bootloader that would be copied to PRODUCT_OUT
63 Bootloader *string `android:"path"`
Spandan Dase51ff952025-01-09 18:11:59 +000064 // Path to android-info.txt file containing board specific info.
65 Android_info *string `android:"path"`
Cole Faust11fda332025-01-14 16:47:19 -080066 // If this is the "main" android_device target for the build, i.e. the one that gets built
67 // when running a plain `m` command. Currently, this is the autogenerated android_device module
68 // in soong-only builds, but in the future when we check in android_device modules, the main
69 // one will be determined based on the lunch product. TODO: Figure out how to make this
70 // blueprint:"mutated" and still set it from filesystem_creator
71 Main_device *bool
Spandan Das29d44882025-01-15 21:12:36 +000072
Spandan Das00948072025-02-12 19:36:03 +000073 Ab_ota_updater *bool
74 Ab_ota_partitions []string
75 Ab_ota_keys []string
76 Ab_ota_postinstall_config []string
Spandan Das75955b12025-02-13 22:12:52 +000077
Spandan Das37240d92025-02-14 00:18:41 +000078 Ramdisk_node_list *string `android:"path"`
79 Releasetools_extension *string `android:"path"`
Jihoon Kang3be17162025-01-09 20:51:54 +000080}
81
Jihoon Kangf2c53982024-10-09 17:32:52 +000082type androidDevice struct {
83 android.ModuleBase
84
85 partitionProps PartitionNameProperties
Jihoon Kang3be17162025-01-09 20:51:54 +000086
87 deviceProps DeviceProperties
Cole Fausta472a6f2025-02-10 16:10:04 -080088
89 allImagesZip android.Path
Jihoon Kangf2c53982024-10-09 17:32:52 +000090}
91
92func AndroidDeviceFactory() android.Module {
93 module := &androidDevice{}
Jihoon Kang3be17162025-01-09 20:51:54 +000094 module.AddProperties(&module.partitionProps, &module.deviceProps)
Cole Faust341d5f12025-01-07 15:32:38 -080095 android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibFirst)
Jihoon Kangf2c53982024-10-09 17:32:52 +000096 return module
97}
98
Cole Faust11fda332025-01-14 16:47:19 -080099var numMainAndroidDevicesOnceKey android.OnceKey = android.NewOnceKey("num_auto_generated_anroid_devices")
Cole Faustb55a41c2025-01-09 16:53:58 -0800100
Jihoon Kangf2c53982024-10-09 17:32:52 +0000101type partitionDepTagType struct {
102 blueprint.BaseDependencyTag
103}
104
Cole Faust2bdc5e52025-01-10 10:29:36 -0800105type superPartitionDepTagType struct {
106 blueprint.BaseDependencyTag
107}
Spandan Das29d44882025-01-15 21:12:36 +0000108type targetFilesMetadataDepTagType struct {
109 blueprint.BaseDependencyTag
110}
Cole Faust2bdc5e52025-01-10 10:29:36 -0800111
112var superPartitionDepTag superPartitionDepTagType
Jihoon Kangf2c53982024-10-09 17:32:52 +0000113var filesystemDepTag partitionDepTagType
Spandan Das29d44882025-01-15 21:12:36 +0000114var targetFilesMetadataDepTag targetFilesMetadataDepTagType
Jihoon Kangf2c53982024-10-09 17:32:52 +0000115
116func (a *androidDevice) DepsMutator(ctx android.BottomUpMutatorContext) {
117 addDependencyIfDefined := func(dep *string) {
118 if dep != nil {
Cole Faust341d5f12025-01-07 15:32:38 -0800119 ctx.AddDependency(ctx.Module(), filesystemDepTag, proptools.String(dep))
Jihoon Kangf2c53982024-10-09 17:32:52 +0000120 }
121 }
122
Cole Faust2bdc5e52025-01-10 10:29:36 -0800123 if a.partitionProps.Super_partition_name != nil {
124 ctx.AddDependency(ctx.Module(), superPartitionDepTag, *a.partitionProps.Super_partition_name)
125 }
Jihoon Kangf2c53982024-10-09 17:32:52 +0000126 addDependencyIfDefined(a.partitionProps.Boot_partition_name)
Jihoon Kang9e087002025-01-08 19:12:23 +0000127 addDependencyIfDefined(a.partitionProps.Init_boot_partition_name)
Spandan Dasef200ac2025-01-08 01:42:45 +0000128 addDependencyIfDefined(a.partitionProps.Vendor_boot_partition_name)
Jihoon Kangf2c53982024-10-09 17:32:52 +0000129 addDependencyIfDefined(a.partitionProps.System_partition_name)
130 addDependencyIfDefined(a.partitionProps.System_ext_partition_name)
131 addDependencyIfDefined(a.partitionProps.Product_partition_name)
132 addDependencyIfDefined(a.partitionProps.Vendor_partition_name)
Spandan Dasc5717162024-11-01 18:33:57 +0000133 addDependencyIfDefined(a.partitionProps.Odm_partition_name)
mrziwang23ba8762024-11-07 16:21:53 -0800134 addDependencyIfDefined(a.partitionProps.Userdata_partition_name)
Spandan Dasa0394002025-01-07 18:38:34 +0000135 addDependencyIfDefined(a.partitionProps.System_dlkm_partition_name)
136 addDependencyIfDefined(a.partitionProps.Vendor_dlkm_partition_name)
137 addDependencyIfDefined(a.partitionProps.Odm_dlkm_partition_name)
Spandan Dasef200ac2025-01-08 01:42:45 +0000138 addDependencyIfDefined(a.partitionProps.Recovery_partition_name)
Cole Faust3552eb62024-11-06 18:07:26 -0800139 for _, vbmetaPartition := range a.partitionProps.Vbmeta_partitions {
140 ctx.AddDependency(ctx.Module(), filesystemDepTag, vbmetaPartition)
141 }
Spandan Das29d44882025-01-15 21:12:36 +0000142 a.addDepsForTargetFilesMetadata(ctx)
143}
144
145func (a *androidDevice) addDepsForTargetFilesMetadata(ctx android.BottomUpMutatorContext) {
146 ctx.AddFarVariationDependencies(ctx.Config().BuildOSTarget.Variations(), targetFilesMetadataDepTag, "liblz4") // host variant
Jihoon Kangf2c53982024-10-09 17:32:52 +0000147}
148
Cole Faust11fda332025-01-14 16:47:19 -0800149func (a *androidDevice) GenerateAndroidBuildActions(ctx android.ModuleContext) {
150 if proptools.Bool(a.deviceProps.Main_device) {
151 numMainAndroidDevices := ctx.Config().Once(numMainAndroidDevicesOnceKey, func() interface{} {
152 return &atomic.Int32{}
153 }).(*atomic.Int32)
154 total := numMainAndroidDevices.Add(1)
155 if total > 1 {
156 // There should only be 1 main android_device module. That one will be
157 // made the default thing to build in soong-only builds.
158 ctx.ModuleErrorf("There cannot be more than 1 main android_device module")
159 }
Jihoon Kang3be17162025-01-09 20:51:54 +0000160 }
161
Spandan Das5ef1a9c2025-02-11 18:50:17 +0000162 a.buildTargetFilesZip(ctx)
mrziwang2fd33a72025-01-08 12:22:08 -0800163 var deps []android.Path
Cole Faust2bdc5e52025-01-10 10:29:36 -0800164 if proptools.String(a.partitionProps.Super_partition_name) != "" {
Cole Faust19eb09d2025-01-14 13:27:00 -0800165 superImage := ctx.GetDirectDepProxyWithTag(*a.partitionProps.Super_partition_name, superPartitionDepTag)
Cole Faust2bdc5e52025-01-10 10:29:36 -0800166 if info, ok := android.OtherModuleProvider(ctx, superImage, SuperImageProvider); ok {
167 assertUnset := func(prop *string, propName string) {
168 if prop != nil && *prop != "" {
169 ctx.PropertyErrorf(propName, "Cannot be set because it's already part of the super image")
170 }
171 }
172 for _, subPartitionType := range android.SortedKeys(info.SubImageInfo) {
173 switch subPartitionType {
174 case "system":
175 assertUnset(a.partitionProps.System_partition_name, "system_partition_name")
176 case "system_ext":
177 assertUnset(a.partitionProps.System_ext_partition_name, "system_ext_partition_name")
178 case "system_dlkm":
179 assertUnset(a.partitionProps.System_dlkm_partition_name, "system_dlkm_partition_name")
180 case "system_other":
181 // TODO
182 case "product":
183 assertUnset(a.partitionProps.Product_partition_name, "product_partition_name")
184 case "vendor":
185 assertUnset(a.partitionProps.Vendor_partition_name, "vendor_partition_name")
186 case "vendor_dlkm":
187 assertUnset(a.partitionProps.Vendor_dlkm_partition_name, "vendor_dlkm_partition_name")
188 case "odm":
189 assertUnset(a.partitionProps.Odm_partition_name, "odm_partition_name")
190 case "odm_dlkm":
191 assertUnset(a.partitionProps.Odm_dlkm_partition_name, "odm_dlkm_partition_name")
192 default:
193 ctx.ModuleErrorf("Unsupported sub-partition of super partition: %q", subPartitionType)
194 }
195 }
196
197 deps = append(deps, info.SuperImage)
198 } else {
199 ctx.ModuleErrorf("Expected super image dep to provide SuperImageProvider")
200 }
201 }
Cole Faust19eb09d2025-01-14 13:27:00 -0800202 ctx.VisitDirectDepsProxyWithTag(filesystemDepTag, func(m android.ModuleProxy) {
mrziwang2fd33a72025-01-08 12:22:08 -0800203 imageOutput, ok := android.OtherModuleProvider(ctx, m, android.OutputFilesProvider)
204 if !ok {
205 ctx.ModuleErrorf("Partition module %s doesn't set OutputfilesProvider", m.Name())
206 }
207 if len(imageOutput.DefaultOutputFiles) != 1 {
208 ctx.ModuleErrorf("Partition module %s should provide exact 1 output file", m.Name())
209 }
210 deps = append(deps, imageOutput.DefaultOutputFiles[0])
211 })
Jihoon Kang3be17162025-01-09 20:51:54 +0000212
Cole Fausta472a6f2025-02-10 16:10:04 -0800213 allImagesZip := android.PathForModuleOut(ctx, "all_images.zip")
214 allImagesZipBuilder := android.NewRuleBuilder(pctx, ctx)
215 cmd := allImagesZipBuilder.Command().BuiltTool("soong_zip").Flag("--sort_entries")
216 for _, dep := range deps {
217 cmd.FlagWithArg("-e ", dep.Base())
218 cmd.FlagWithInput("-f ", dep)
219 }
220 cmd.FlagWithOutput("-o ", allImagesZip)
221 allImagesZipBuilder.Build("soong_all_images_zip", "all_images.zip")
222 a.allImagesZip = allImagesZip
223
Cole Faustb55a41c2025-01-09 16:53:58 -0800224 allImagesStamp := android.PathForModuleOut(ctx, "all_images_stamp")
Cole Faust11fda332025-01-14 16:47:19 -0800225 var validations android.Paths
226 if !ctx.Config().KatiEnabled() && proptools.Bool(a.deviceProps.Main_device) {
Cole Faustb55a41c2025-01-09 16:53:58 -0800227 // In soong-only builds, build this module by default.
228 // This is the analogue to this make code:
229 // https://cs.android.com/android/platform/superproject/main/+/main:build/make/core/main.mk;l=1396;drc=6595459cdd8164a6008335f6372c9f97b9094060
230 ctx.Phony("droidcore-unbundled", allImagesStamp)
Cole Faust11fda332025-01-14 16:47:19 -0800231
Cole Faust19fbb072025-01-30 18:19:29 -0800232 deps = append(deps, a.copyFilesToProductOutForSoongOnly(ctx))
Cole Faustb55a41c2025-01-09 16:53:58 -0800233 }
Cole Faust11fda332025-01-14 16:47:19 -0800234
235 ctx.Build(pctx, android.BuildParams{
236 Rule: android.Touch,
237 Output: allImagesStamp,
238 Implicits: deps,
239 Validations: validations,
240 })
241
242 // Checkbuilding it causes soong to make a phony, so you can say `m <module name>`
243 ctx.CheckbuildFile(allImagesStamp)
Jihoon Kang0a6315b2025-01-30 01:14:49 +0000244
245 a.setVbmetaPhonyTargets(ctx)
Jihoon Kangf67b7de2025-02-12 01:01:09 +0000246
247 a.distFiles(ctx)
248}
249
250func (a *androidDevice) distFiles(ctx android.ModuleContext) {
251 if !ctx.Config().KatiEnabled() {
252 if proptools.Bool(a.deviceProps.Main_device) {
253 fsInfoMap := a.getFsInfos(ctx)
254 for _, partition := range android.SortedKeys(fsInfoMap) {
255 fsInfo := fsInfoMap[partition]
256 if fsInfo.InstalledFiles.Json != nil {
257 ctx.DistForGoal("droidcore-unbundled", fsInfo.InstalledFiles.Json)
258 }
259 if fsInfo.InstalledFiles.Txt != nil {
260 ctx.DistForGoal("droidcore-unbundled", fsInfo.InstalledFiles.Txt)
261 }
262 }
263 }
264 }
265
Cole Faust44080412024-12-20 14:17:07 -0800266}
Jihoon Kangf2c53982024-10-09 17:32:52 +0000267
Cole Fausta472a6f2025-02-10 16:10:04 -0800268func (a *androidDevice) MakeVars(ctx android.MakeVarsModuleContext) {
269 if proptools.Bool(a.deviceProps.Main_device) {
270 ctx.StrictRaw("SOONG_ONLY_ALL_IMAGES_ZIP", a.allImagesZip.String())
271 }
272}
273
Spandan Dasef775742025-01-13 22:17:40 +0000274// Helper structs for target_files.zip creation
Spandan Dasef200ac2025-01-08 01:42:45 +0000275type targetFilesZipCopy struct {
276 srcModule *string
277 destSubdir string
278}
279
Spandan Dasef775742025-01-13 22:17:40 +0000280type targetFilesystemZipCopy struct {
281 fsInfo FilesystemInfo
282 destSubdir string
283}
284
Cole Faust44080412024-12-20 14:17:07 -0800285func (a *androidDevice) buildTargetFilesZip(ctx android.ModuleContext) {
286 targetFilesDir := android.PathForModuleOut(ctx, "target_files_dir")
287 targetFilesZip := android.PathForModuleOut(ctx, "target_files.zip")
288
289 builder := android.NewRuleBuilder(pctx, ctx)
290 builder.Command().Textf("rm -rf %s", targetFilesDir.String())
291 builder.Command().Textf("mkdir -p %s", targetFilesDir.String())
Spandan Dasef200ac2025-01-08 01:42:45 +0000292 toCopy := []targetFilesZipCopy{
293 targetFilesZipCopy{a.partitionProps.System_partition_name, "SYSTEM"},
294 targetFilesZipCopy{a.partitionProps.System_ext_partition_name, "SYSTEM_EXT"},
295 targetFilesZipCopy{a.partitionProps.Product_partition_name, "PRODUCT"},
296 targetFilesZipCopy{a.partitionProps.Vendor_partition_name, "VENDOR"},
297 targetFilesZipCopy{a.partitionProps.Odm_partition_name, "ODM"},
298 targetFilesZipCopy{a.partitionProps.System_dlkm_partition_name, "SYSTEM_DLKM"},
299 targetFilesZipCopy{a.partitionProps.Vendor_dlkm_partition_name, "VENDOR_DLKM"},
300 targetFilesZipCopy{a.partitionProps.Odm_dlkm_partition_name, "ODM_DLKM"},
301 targetFilesZipCopy{a.partitionProps.Init_boot_partition_name, "BOOT/RAMDISK"},
302 targetFilesZipCopy{a.partitionProps.Init_boot_partition_name, "INIT_BOOT/RAMDISK"},
303 targetFilesZipCopy{a.partitionProps.Vendor_boot_partition_name, "VENDOR_BOOT/RAMDISK"},
Spandan Das25649f52025-01-07 18:09:22 +0000304 }
Spandan Dasef200ac2025-01-08 01:42:45 +0000305
Spandan Dasef775742025-01-13 22:17:40 +0000306 filesystemsToCopy := []targetFilesystemZipCopy{}
Spandan Dasef200ac2025-01-08 01:42:45 +0000307 for _, zipCopy := range toCopy {
308 if zipCopy.srcModule == nil {
Spandan Das25649f52025-01-07 18:09:22 +0000309 continue
310 }
Spandan Dasef775742025-01-13 22:17:40 +0000311 filesystemsToCopy = append(
312 filesystemsToCopy,
313 targetFilesystemZipCopy{a.getFilesystemInfo(ctx, *zipCopy.srcModule), zipCopy.destSubdir},
314 )
315 }
316 // Get additional filesystems from super_partition dependency
317 if a.partitionProps.Super_partition_name != nil {
Cole Faust19eb09d2025-01-14 13:27:00 -0800318 superPartition := ctx.GetDirectDepProxyWithTag(*a.partitionProps.Super_partition_name, superPartitionDepTag)
Spandan Dasef775742025-01-13 22:17:40 +0000319 if info, ok := android.OtherModuleProvider(ctx, superPartition, SuperImageProvider); ok {
320 for _, partition := range android.SortedStringKeys(info.SubImageInfo) {
321 filesystemsToCopy = append(
322 filesystemsToCopy,
323 targetFilesystemZipCopy{info.SubImageInfo[partition], strings.ToUpper(partition)},
324 )
325 }
326 } else {
327 ctx.ModuleErrorf("Super partition %s does set SuperImageProvider\n", superPartition.Name())
328 }
329 }
330
331 for _, toCopy := range filesystemsToCopy {
332 rootDirString := toCopy.fsInfo.RootDir.String()
333 if toCopy.destSubdir == "SYSTEM" {
Spandan Dasef200ac2025-01-08 01:42:45 +0000334 rootDirString = rootDirString + "/system"
335 }
Spandan Dasef775742025-01-13 22:17:40 +0000336 builder.Command().Textf("mkdir -p %s/%s", targetFilesDir.String(), toCopy.destSubdir)
Cole Faust44080412024-12-20 14:17:07 -0800337 builder.Command().
338 BuiltTool("acp").
Spandan Dasef775742025-01-13 22:17:40 +0000339 Textf("-rd %s/. %s/%s", rootDirString, targetFilesDir, toCopy.destSubdir).
340 Implicit(toCopy.fsInfo.Output) // so that the staging dir is built
Cole Faustb36763e2025-02-18 15:21:44 -0800341 for _, extraRootDir := range toCopy.fsInfo.ExtraRootDirs {
342 builder.Command().
343 BuiltTool("acp").
344 Textf("-rd %s/. %s/%s", extraRootDir, targetFilesDir, toCopy.destSubdir).
345 Implicit(toCopy.fsInfo.Output) // so that the staging dir is built
346 }
Spandan Dasef200ac2025-01-08 01:42:45 +0000347
Spandan Dasef775742025-01-13 22:17:40 +0000348 if toCopy.destSubdir == "SYSTEM" {
Spandan Das3ec6d062025-01-09 19:37:47 +0000349 // Create the ROOT partition in target_files.zip
Spandan Dasef775742025-01-13 22:17:40 +0000350 builder.Command().Textf("rsync --links --exclude=system/* %s/ -r %s/ROOT", toCopy.fsInfo.RootDir, targetFilesDir.String())
Spandan Das3ec6d062025-01-09 19:37:47 +0000351 }
Cole Faust44080412024-12-20 14:17:07 -0800352 }
Spandan Das9b17df22025-01-08 23:30:45 +0000353 // Copy cmdline, kernel etc. files of boot images
Spandan Das258c08f2025-01-08 23:30:45 +0000354 if a.partitionProps.Vendor_boot_partition_name != nil {
Cole Faust19eb09d2025-01-14 13:27:00 -0800355 bootImg := ctx.GetDirectDepProxyWithTag(proptools.String(a.partitionProps.Vendor_boot_partition_name), filesystemDepTag)
Spandan Das258c08f2025-01-08 23:30:45 +0000356 bootImgInfo, _ := android.OtherModuleProvider(ctx, bootImg, BootimgInfoProvider)
Spandan Das9b17df22025-01-08 23:30:45 +0000357 builder.Command().Textf("echo %s > %s/VENDOR_BOOT/cmdline", proptools.ShellEscape(strings.Join(bootImgInfo.Cmdline, " ")), targetFilesDir)
358 builder.Command().Textf("echo %s > %s/VENDOR_BOOT/vendor_cmdline", proptools.ShellEscape(strings.Join(bootImgInfo.Cmdline, " ")), targetFilesDir)
359 if bootImgInfo.Dtb != nil {
Spandan Dasfed3d042025-01-13 21:38:47 +0000360 builder.Command().Textf("cp ").Input(bootImgInfo.Dtb).Textf(" %s/VENDOR_BOOT/dtb", targetFilesDir)
Spandan Das9b17df22025-01-08 23:30:45 +0000361 }
Spandan Das23511372025-01-08 23:30:45 +0000362 if bootImgInfo.Bootconfig != nil {
Spandan Dasfed3d042025-01-13 21:38:47 +0000363 builder.Command().Textf("cp ").Input(bootImgInfo.Bootconfig).Textf(" %s/VENDOR_BOOT/vendor_bootconfig", targetFilesDir)
Spandan Das23511372025-01-08 23:30:45 +0000364 }
Spandan Das258c08f2025-01-08 23:30:45 +0000365 }
366 if a.partitionProps.Boot_partition_name != nil {
Cole Faust19eb09d2025-01-14 13:27:00 -0800367 bootImg := ctx.GetDirectDepProxyWithTag(proptools.String(a.partitionProps.Boot_partition_name), filesystemDepTag)
Spandan Das258c08f2025-01-08 23:30:45 +0000368 bootImgInfo, _ := android.OtherModuleProvider(ctx, bootImg, BootimgInfoProvider)
Spandan Das9b17df22025-01-08 23:30:45 +0000369 builder.Command().Textf("echo %s > %s/BOOT/cmdline", proptools.ShellEscape(strings.Join(bootImgInfo.Cmdline, " ")), targetFilesDir)
370 if bootImgInfo.Dtb != nil {
Spandan Dasfed3d042025-01-13 21:38:47 +0000371 builder.Command().Textf("cp ").Input(bootImgInfo.Dtb).Textf(" %s/BOOT/dtb", targetFilesDir)
Spandan Das9b17df22025-01-08 23:30:45 +0000372 }
373 if bootImgInfo.Kernel != nil {
Spandan Dasfed3d042025-01-13 21:38:47 +0000374 builder.Command().Textf("cp ").Input(bootImgInfo.Kernel).Textf(" %s/BOOT/kernel", targetFilesDir)
Spandan Das9b17df22025-01-08 23:30:45 +0000375 // Even though kernel is not used to build vendor_boot, copy the kernel to VENDOR_BOOT to match the behavior of make packaging.
Spandan Dasfed3d042025-01-13 21:38:47 +0000376 builder.Command().Textf("cp ").Input(bootImgInfo.Kernel).Textf(" %s/VENDOR_BOOT/kernel", targetFilesDir)
Spandan Das9b17df22025-01-08 23:30:45 +0000377 }
Spandan Das23511372025-01-08 23:30:45 +0000378 if bootImgInfo.Bootconfig != nil {
Spandan Dasfed3d042025-01-13 21:38:47 +0000379 builder.Command().Textf("cp ").Input(bootImgInfo.Bootconfig).Textf(" %s/BOOT/bootconfig", targetFilesDir)
Spandan Das23511372025-01-08 23:30:45 +0000380 }
Spandan Das258c08f2025-01-08 23:30:45 +0000381 }
382
Spandan Dase51ff952025-01-09 18:11:59 +0000383 if a.deviceProps.Android_info != nil {
384 builder.Command().Textf("mkdir -p %s/OTA", targetFilesDir)
Cole Faust11fda332025-01-14 16:47:19 -0800385 builder.Command().Textf("cp ").Input(android.PathForModuleSrc(ctx, *a.deviceProps.Android_info)).Textf(" %s/OTA/android-info.txt", targetFilesDir)
Spandan Dase51ff952025-01-09 18:11:59 +0000386 }
387
Spandan Das0036fa32025-01-10 23:40:45 +0000388 a.copyImagesToTargetZip(ctx, builder, targetFilesDir)
Spandan Das29d44882025-01-15 21:12:36 +0000389 a.copyMetadataToTargetZip(ctx, builder, targetFilesDir)
Spandan Das0036fa32025-01-10 23:40:45 +0000390
Cole Faust44080412024-12-20 14:17:07 -0800391 builder.Command().
392 BuiltTool("soong_zip").
393 Text("-d").
394 FlagWithOutput("-o ", targetFilesZip).
395 FlagWithArg("-C ", targetFilesDir.String()).
396 FlagWithArg("-D ", targetFilesDir.String()).
397 Text("-sha256")
398 builder.Build("target_files_"+ctx.ModuleName(), "Build target_files.zip")
399}
400
Spandan Das0036fa32025-01-10 23:40:45 +0000401func (a *androidDevice) copyImagesToTargetZip(ctx android.ModuleContext, builder *android.RuleBuilder, targetFilesDir android.WritablePath) {
402 // Create an IMAGES/ subdirectory
403 builder.Command().Textf("mkdir -p %s/IMAGES", targetFilesDir.String())
404 if a.deviceProps.Bootloader != nil {
405 builder.Command().Textf("cp ").Input(android.PathForModuleSrc(ctx, proptools.String(a.deviceProps.Bootloader))).Textf(" %s/IMAGES/bootloader", targetFilesDir.String())
406 }
407 // Copy the filesystem ,boot and vbmeta img files to IMAGES/
408 ctx.VisitDirectDepsProxyWithTag(filesystemDepTag, func(child android.ModuleProxy) {
Spandan Dasa9db76d2025-01-14 01:34:43 +0000409 if strings.Contains(child.Name(), "recovery") {
410 return // skip recovery.img to match the make packaging behavior
411 }
Spandan Dasef775742025-01-13 22:17:40 +0000412 if info, ok := android.OtherModuleProvider(ctx, child, BootimgInfoProvider); ok {
413 // Check Boot img first so that the boot.img is copied and not its dep ramdisk.img
Spandan Das0036fa32025-01-10 23:40:45 +0000414 builder.Command().Textf("cp ").Input(info.Output).Textf(" %s/IMAGES/", targetFilesDir.String())
Spandan Dasef775742025-01-13 22:17:40 +0000415 } else if info, ok := android.OtherModuleProvider(ctx, child, FilesystemProvider); ok {
Spandan Das0036fa32025-01-10 23:40:45 +0000416 builder.Command().Textf("cp ").Input(info.Output).Textf(" %s/IMAGES/", targetFilesDir.String())
417 } else if info, ok := android.OtherModuleProvider(ctx, child, vbmetaPartitionProvider); ok {
418 builder.Command().Textf("cp ").Input(info.Output).Textf(" %s/IMAGES/", targetFilesDir.String())
419 } else {
420 ctx.ModuleErrorf("Module %s does not provide an .img file output for target_files.zip", child.Name())
421 }
422 })
Spandan Dasef775742025-01-13 22:17:40 +0000423
424 if a.partitionProps.Super_partition_name != nil {
Cole Faust19eb09d2025-01-14 13:27:00 -0800425 superPartition := ctx.GetDirectDepProxyWithTag(*a.partitionProps.Super_partition_name, superPartitionDepTag)
Spandan Dasef775742025-01-13 22:17:40 +0000426 if info, ok := android.OtherModuleProvider(ctx, superPartition, SuperImageProvider); ok {
Cole Faust19eb09d2025-01-14 13:27:00 -0800427 for _, partition := range android.SortedKeys(info.SubImageInfo) {
Spandan Das7a42d1c2025-02-12 01:32:21 +0000428 if info.SubImageInfo[partition].OutputHermetic != nil {
429 builder.Command().Textf("cp ").Input(info.SubImageInfo[partition].OutputHermetic).Textf(" %s/IMAGES/", targetFilesDir.String())
430 }
431 if info.SubImageInfo[partition].MapFile != nil {
432 builder.Command().Textf("cp ").Input(info.SubImageInfo[partition].MapFile).Textf(" %s/IMAGES/", targetFilesDir.String())
433 }
Spandan Dasef775742025-01-13 22:17:40 +0000434 }
435 } else {
436 ctx.ModuleErrorf("Super partition %s does set SuperImageProvider\n", superPartition.Name())
437 }
438 }
Spandan Das0036fa32025-01-10 23:40:45 +0000439}
440
Spandan Das29d44882025-01-15 21:12:36 +0000441func (a *androidDevice) copyMetadataToTargetZip(ctx android.ModuleContext, builder *android.RuleBuilder, targetFilesDir android.WritablePath) {
442 // Create a META/ subdirectory
443 builder.Command().Textf("mkdir -p %s/META", targetFilesDir.String())
444 if proptools.Bool(a.deviceProps.Ab_ota_updater) {
445 ctx.VisitDirectDepsProxyWithTag(targetFilesMetadataDepTag, func(child android.ModuleProxy) {
446 info, _ := android.OtherModuleProvider(ctx, child, android.OutputFilesProvider)
447 builder.Command().Textf("cp").Inputs(info.DefaultOutputFiles).Textf(" %s/META/", targetFilesDir.String())
448 })
Spandan Dasb5f40cf2025-02-12 19:36:03 +0000449 builder.Command().Textf("cp").Input(android.PathForSource(ctx, "external/zucchini/version_info.h")).Textf(" %s/META/zucchini_config.txt", targetFilesDir.String())
450 builder.Command().Textf("cp").Input(android.PathForSource(ctx, "system/update_engine/update_engine.conf")).Textf(" %s/META/update_engine_config.txt", targetFilesDir.String())
451 if a.getFsInfos(ctx)["system"].ErofsCompressHints != nil {
452 builder.Command().Textf("cp").Input(a.getFsInfos(ctx)["system"].ErofsCompressHints).Textf(" %s/META/erofs_default_compress_hints.txt", targetFilesDir.String())
453 }
454 // ab_partitions.txt
455 abPartitionsSorted := android.SortedUniqueStrings(a.deviceProps.Ab_ota_partitions)
456 abPartitionsSortedString := proptools.ShellEscape(strings.Join(abPartitionsSorted, "\\n"))
457 builder.Command().Textf("echo -e").Flag(abPartitionsSortedString).Textf(" > %s/META/ab_partitions.txt", targetFilesDir.String())
Spandan Das35b78742025-02-12 19:36:03 +0000458 // otakeys.txt
459 abOtaKeysSorted := android.SortedUniqueStrings(a.deviceProps.Ab_ota_keys)
460 abOtaKeysSortedString := proptools.ShellEscape(strings.Join(abOtaKeysSorted, "\\n"))
461 builder.Command().Textf("echo -e").Flag(abOtaKeysSortedString).Textf(" > %s/META/otakeys.txt", targetFilesDir.String())
Spandan Das00948072025-02-12 19:36:03 +0000462 // postinstall_config.txt
463 abOtaPostInstallConfigString := proptools.ShellEscape(strings.Join(a.deviceProps.Ab_ota_postinstall_config, "\\n"))
464 builder.Command().Textf("echo -e").Flag(abOtaPostInstallConfigString).Textf(" > %s/META/postinstall_config.txt", targetFilesDir.String())
Spandan Dasf12ff9b2025-02-12 22:27:43 +0000465 // selinuxfc
466 if a.getFsInfos(ctx)["system"].SelinuxFc != nil {
467 builder.Command().Textf("cp").Input(a.getFsInfos(ctx)["system"].SelinuxFc).Textf(" %s/META/file_contexts.bin", targetFilesDir.String())
468 }
Spandan Dasd71af182025-02-12 18:03:29 +0000469 }
Spandan Dasdd262fb2025-02-13 00:15:59 +0000470 // Copy $partition_filesystem_config.txt
471 fsInfos := a.getFsInfos(ctx)
472 for _, partition := range android.SortedKeys(fsInfos) {
473 if fsInfos[partition].FilesystemConfig == nil {
474 continue
475 }
476 if android.InList(partition, []string{"userdata"}) {
477 continue
478 }
479 builder.Command().Textf("cp").Input(fsInfos[partition].FilesystemConfig).Textf(" %s/META/%s", targetFilesDir.String(), a.filesystemConfigNameForTargetFiles(partition))
480 }
Spandan Das75955b12025-02-13 22:12:52 +0000481 // Copy ramdisk_node_list
Spandan Das37240d92025-02-14 00:18:41 +0000482 if ramdiskNodeList := android.PathForModuleSrc(ctx, proptools.String(a.deviceProps.Ramdisk_node_list)); ramdiskNodeList != nil {
483 builder.Command().Textf("cp").Input(ramdiskNodeList).Textf(" %s/META/", targetFilesDir.String())
484 }
485 // Copy releasetools.py
486 if releaseTools := android.PathForModuleSrc(ctx, proptools.String(a.deviceProps.Releasetools_extension)); releaseTools != nil {
487 builder.Command().Textf("cp").Input(releaseTools).Textf(" %s/META/", targetFilesDir.String())
488 }
Spandan Dasdd262fb2025-02-13 00:15:59 +0000489}
490
491// Filenames for the partition specific fs_config files.
492// Hardcode the ramdisk files to their boot image prefix
493func (a *androidDevice) filesystemConfigNameForTargetFiles(partition string) string {
494 name := partition + "_filesystem_config.txt"
495 if partition == "system" {
496 name = "filesystem_config.txt"
497 } else if partition == "ramdisk" {
498 name = "init_boot_filesystem_config.txt"
499 }
500 return name
Spandan Das29d44882025-01-15 21:12:36 +0000501}
502
Cole Faust44080412024-12-20 14:17:07 -0800503func (a *androidDevice) getFilesystemInfo(ctx android.ModuleContext, depName string) FilesystemInfo {
Cole Faust19eb09d2025-01-14 13:27:00 -0800504 fsMod := ctx.GetDirectDepProxyWithTag(depName, filesystemDepTag)
Cole Faust44080412024-12-20 14:17:07 -0800505 fsInfo, ok := android.OtherModuleProvider(ctx, fsMod, FilesystemProvider)
506 if !ok {
507 ctx.ModuleErrorf("Expected dependency %s to be a filesystem", depName)
508 }
509 return fsInfo
Jihoon Kangf2c53982024-10-09 17:32:52 +0000510}
Jihoon Kang0a6315b2025-01-30 01:14:49 +0000511
512func (a *androidDevice) setVbmetaPhonyTargets(ctx android.ModuleContext) {
513 if !proptools.Bool(a.deviceProps.Main_device) {
514 return
515 }
516
517 if !ctx.Config().KatiEnabled() {
518 for _, vbmetaPartitionName := range a.partitionProps.Vbmeta_partitions {
519 img := ctx.GetDirectDepProxyWithTag(vbmetaPartitionName, filesystemDepTag)
520 if provider, ok := android.OtherModuleProvider(ctx, img, vbmetaPartitionProvider); ok {
521 // make generates `vbmetasystemimage` phony target instead of `vbmeta_systemimage` phony target.
522 partitionName := strings.ReplaceAll(provider.Name, "_", "")
523 ctx.Phony(fmt.Sprintf("%simage", partitionName), provider.Output)
524 }
525 }
526 }
527}