123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304 |
- // Copyright (C) 2021 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 (
- "fmt"
- "strconv"
- "strings"
- "github.com/google/blueprint"
- "github.com/google/blueprint/proptools"
- "android/soong/android"
- )
- func init() {
- android.RegisterModuleType("bootimg", bootimgFactory)
- }
- type bootimg struct {
- android.ModuleBase
- properties bootimgProperties
- output android.OutputPath
- installDir android.InstallPath
- }
- type bootimgProperties struct {
- // Set the name of the output. Defaults to <module_name>.img.
- Stem *string
- // Path to the linux kernel prebuilt file
- Kernel_prebuilt *string `android:"arch_variant,path"`
- // Filesystem module that is used as ramdisk
- Ramdisk_module *string
- // Path to the device tree blob (DTB) prebuilt file to add to this boot image
- Dtb_prebuilt *string `android:"arch_variant,path"`
- // Header version number. Must be set to one of the version numbers that are currently
- // supported. Refer to
- // https://source.android.com/devices/bootloader/boot-image-header
- Header_version *string
- // Determines if this image is for the vendor_boot partition. Default is false. Refer to
- // https://source.android.com/devices/bootloader/partitions/vendor-boot-partitions
- Vendor_boot *bool
- // Optional kernel commandline arguments
- Cmdline []string `android:"arch_variant"`
- // File that contains bootconfig parameters. This can be set only when `vendor_boot` is true
- // and `header_version` is greater than or equal to 4.
- Bootconfig *string `android:"arch_variant,path"`
- // When set to true, sign the image with avbtool. Default is false.
- Use_avb *bool
- // Name of the partition stored in vbmeta desc. Defaults to the name of this module.
- Partition_name *string
- // Path to the private key that avbtool will use to sign this filesystem image.
- // TODO(jiyong): allow apex_key to be specified here
- Avb_private_key *string `android:"path"`
- // Hash and signing algorithm for avbtool. Default is SHA256_RSA4096.
- Avb_algorithm *string
- }
- // bootimg is the image for the boot partition. It consists of header, kernel, ramdisk, and dtb.
- func bootimgFactory() android.Module {
- module := &bootimg{}
- module.AddProperties(&module.properties)
- android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibFirst)
- return module
- }
- type bootimgDep struct {
- blueprint.BaseDependencyTag
- kind string
- }
- var bootimgRamdiskDep = bootimgDep{kind: "ramdisk"}
- func (b *bootimg) DepsMutator(ctx android.BottomUpMutatorContext) {
- ramdisk := proptools.String(b.properties.Ramdisk_module)
- if ramdisk != "" {
- ctx.AddDependency(ctx.Module(), bootimgRamdiskDep, ramdisk)
- }
- }
- func (b *bootimg) installFileName() string {
- return proptools.StringDefault(b.properties.Stem, b.BaseModuleName()+".img")
- }
- func (b *bootimg) partitionName() string {
- return proptools.StringDefault(b.properties.Partition_name, b.BaseModuleName())
- }
- func (b *bootimg) GenerateAndroidBuildActions(ctx android.ModuleContext) {
- vendor := proptools.Bool(b.properties.Vendor_boot)
- unsignedOutput := b.buildBootImage(ctx, vendor)
- if proptools.Bool(b.properties.Use_avb) {
- b.output = b.signImage(ctx, unsignedOutput)
- } else {
- b.output = unsignedOutput
- }
- b.installDir = android.PathForModuleInstall(ctx, "etc")
- ctx.InstallFile(b.installDir, b.installFileName(), b.output)
- }
- func (b *bootimg) buildBootImage(ctx android.ModuleContext, vendor bool) android.OutputPath {
- output := android.PathForModuleOut(ctx, "unsigned", b.installFileName()).OutputPath
- builder := android.NewRuleBuilder(pctx, ctx)
- cmd := builder.Command().BuiltTool("mkbootimg")
- kernel := proptools.String(b.properties.Kernel_prebuilt)
- if vendor && kernel != "" {
- ctx.PropertyErrorf("kernel_prebuilt", "vendor_boot partition can't have kernel")
- return output
- }
- if !vendor && kernel == "" {
- ctx.PropertyErrorf("kernel_prebuilt", "boot partition must have kernel")
- return output
- }
- if kernel != "" {
- cmd.FlagWithInput("--kernel ", android.PathForModuleSrc(ctx, kernel))
- }
- dtbName := proptools.String(b.properties.Dtb_prebuilt)
- if dtbName != "" {
- dtb := android.PathForModuleSrc(ctx, dtbName)
- cmd.FlagWithInput("--dtb ", dtb)
- }
- cmdline := strings.Join(b.properties.Cmdline, " ")
- if cmdline != "" {
- flag := "--cmdline "
- if vendor {
- flag = "--vendor_cmdline "
- }
- cmd.FlagWithArg(flag, proptools.ShellEscapeIncludingSpaces(cmdline))
- }
- headerVersion := proptools.String(b.properties.Header_version)
- if headerVersion == "" {
- ctx.PropertyErrorf("header_version", "must be set")
- return output
- }
- verNum, err := strconv.Atoi(headerVersion)
- if err != nil {
- ctx.PropertyErrorf("header_version", "%q is not a number", headerVersion)
- return output
- }
- if verNum < 3 {
- ctx.PropertyErrorf("header_version", "must be 3 or higher for vendor_boot")
- return output
- }
- cmd.FlagWithArg("--header_version ", headerVersion)
- ramdiskName := proptools.String(b.properties.Ramdisk_module)
- if ramdiskName != "" {
- ramdisk := ctx.GetDirectDepWithTag(ramdiskName, bootimgRamdiskDep)
- if filesystem, ok := ramdisk.(*filesystem); ok {
- flag := "--ramdisk "
- if vendor {
- flag = "--vendor_ramdisk "
- }
- cmd.FlagWithInput(flag, filesystem.OutputPath())
- } else {
- ctx.PropertyErrorf("ramdisk", "%q is not android_filesystem module", ramdisk.Name())
- return output
- }
- }
- bootconfig := proptools.String(b.properties.Bootconfig)
- if bootconfig != "" {
- if !vendor {
- ctx.PropertyErrorf("bootconfig", "requires vendor_boot: true")
- return output
- }
- if verNum < 4 {
- ctx.PropertyErrorf("bootconfig", "requires header_version: 4 or later")
- return output
- }
- cmd.FlagWithInput("--vendor_bootconfig ", android.PathForModuleSrc(ctx, bootconfig))
- }
- flag := "--output "
- if vendor {
- flag = "--vendor_boot "
- }
- cmd.FlagWithOutput(flag, output)
- builder.Build("build_bootimg", fmt.Sprintf("Creating %s", b.BaseModuleName()))
- return output
- }
- func (b *bootimg) signImage(ctx android.ModuleContext, unsignedImage android.OutputPath) android.OutputPath {
- propFile, toolDeps := b.buildPropFile(ctx)
- output := android.PathForModuleOut(ctx, b.installFileName()).OutputPath
- builder := android.NewRuleBuilder(pctx, ctx)
- builder.Command().Text("cp").Input(unsignedImage).Output(output)
- builder.Command().BuiltTool("verity_utils").
- Input(propFile).
- Implicits(toolDeps).
- Output(output)
- builder.Build("sign_bootimg", fmt.Sprintf("Signing %s", b.BaseModuleName()))
- return output
- }
- // Calculates avb_salt from some input for deterministic output.
- func (b *bootimg) salt() string {
- var input []string
- input = append(input, b.properties.Cmdline...)
- input = append(input, proptools.StringDefault(b.properties.Partition_name, b.Name()))
- input = append(input, proptools.String(b.properties.Header_version))
- return sha1sum(input)
- }
- func (b *bootimg) buildPropFile(ctx android.ModuleContext) (propFile android.OutputPath, toolDeps android.Paths) {
- var sb strings.Builder
- var deps android.Paths
- addStr := func(name string, value string) {
- fmt.Fprintf(&sb, "%s=%s\n", name, value)
- }
- addPath := func(name string, path android.Path) {
- addStr(name, path.String())
- deps = append(deps, path)
- }
- addStr("avb_hash_enable", "true")
- addPath("avb_avbtool", ctx.Config().HostToolPath(ctx, "avbtool"))
- algorithm := proptools.StringDefault(b.properties.Avb_algorithm, "SHA256_RSA4096")
- addStr("avb_algorithm", algorithm)
- key := android.PathForModuleSrc(ctx, proptools.String(b.properties.Avb_private_key))
- addPath("avb_key_path", key)
- addStr("avb_add_hash_footer_args", "") // TODO(jiyong): add --rollback_index
- partitionName := proptools.StringDefault(b.properties.Partition_name, b.Name())
- addStr("partition_name", partitionName)
- addStr("avb_salt", b.salt())
- propFile = android.PathForModuleOut(ctx, "prop").OutputPath
- android.WriteFileRule(ctx, propFile, sb.String())
- return propFile, deps
- }
- var _ android.AndroidMkEntriesProvider = (*bootimg)(nil)
- // Implements android.AndroidMkEntriesProvider
- func (b *bootimg) AndroidMkEntries() []android.AndroidMkEntries {
- return []android.AndroidMkEntries{android.AndroidMkEntries{
- Class: "ETC",
- OutputFile: android.OptionalPathForPath(b.output),
- ExtraEntries: []android.AndroidMkExtraEntriesFunc{
- func(ctx android.AndroidMkExtraEntriesContext, entries *android.AndroidMkEntries) {
- entries.SetString("LOCAL_MODULE_PATH", b.installDir.String())
- entries.SetString("LOCAL_INSTALLED_MODULE_STEM", b.installFileName())
- },
- },
- }}
- }
- var _ Filesystem = (*bootimg)(nil)
- func (b *bootimg) OutputPath() android.Path {
- return b.output
- }
- func (b *bootimg) SignedOutputPath() android.Path {
- if proptools.Bool(b.properties.Use_avb) {
- return b.OutputPath()
- }
- return nil
- }
- var _ android.OutputFileProducer = (*bootimg)(nil)
- // Implements android.OutputFileProducer
- func (b *bootimg) OutputFiles(tag string) (android.Paths, error) {
- if tag == "" {
- return []android.Path{b.output}, nil
- }
- return nil, fmt.Errorf("unsupported module reference tag %q", tag)
- }
|