android/build_prop.go - android_build_soong - Gitiles

 // Copyright 2024 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 android

 import (
 	"fmt"

 	"github.com/google/blueprint/proptools"
 )

 func init() {
 	registerBuildPropComponents(InitRegistrationContext)
 }

 func registerBuildPropComponents(ctx RegistrationContext) {
 	ctx.RegisterModuleType("build_prop", BuildPropFactory)
 	ctx.RegisterModuleType("android_info", AndroidInfoFactory)
 }

 type buildPropProperties struct {
 	// Output file name. Defaults to "build.prop"
 	Stem *string

 	// List of prop names to exclude. This affects not only common build properties but also
 	// properties in prop_files.
 	Block_list []string

 	// Files to be appended at the end of build.prop. These files are appended after
 	// post_process_props without any further checking.
 	Footer_files []string `android:"path"`

 	// Path to a JSON file containing product configs.
 	Product_config *string `android:"path"`

 	// Path to android-info.txt file containing board specific info.
 	// This is empty for build.prop of all partitions except vendor.
 	Android_info *string `android:"path"`

 	// Optional subdirectory under which this file is installed into
 	Relative_install_path *string
 }

 type buildPropModule struct {
 	ModuleBase

 	properties buildPropProperties

 	outputFilePath Path
 	installPath    InstallPath
 }

 func (p *buildPropModule) stem() string {
 	return proptools.StringDefault(p.properties.Stem, "build.prop")
 }

 func (p *buildPropModule) propFiles(ctx ModuleContext) Paths {
 	partition := p.partition(ctx.DeviceConfig())
 	if partition == "system" {
 		return ctx.Config().SystemPropFiles(ctx)
 	} else if partition == "system_ext" {
 		return ctx.Config().SystemExtPropFiles(ctx)
 	} else if partition == "product" {
 		return ctx.Config().ProductPropFiles(ctx)
 	} else if partition == "odm" {
 		return ctx.Config().OdmPropFiles(ctx)
 	} else if partition == "vendor" {
 		if p.properties.Android_info != nil {
 			androidInfo := PathForModuleSrc(ctx, proptools.String(p.properties.Android_info))
 			return append(ctx.Config().VendorPropFiles(ctx), androidInfo)
 		}
 		return ctx.Config().VendorPropFiles(ctx)
 	}
 	return nil
 }

 func shouldAddBuildThumbprint(config Config) bool {
 	knownOemProperties := []string{
 		"ro.product.brand",
 		"ro.product.name",
 		"ro.product.device",
 	}

 	for _, knownProp := range knownOemProperties {
 		if InList(knownProp, config.OemProperties()) {
 			return true
 		}
 	}
 	return false
 }

 // Can't use PartitionTag() because PartitionTag() returns the partition this module is actually
 // installed (e.g. odm module's partition tag can be either "odm" or "vendor")
 func (p *buildPropModule) partition(config DeviceConfig) string {
 	if p.SocSpecific() {
 		return "vendor"
 	} else if p.DeviceSpecific() {
 		return "odm"
 	} else if p.ProductSpecific() {
 		return "product"
 	} else if p.SystemExtSpecific() {
 		return "system_ext"
 	} else if p.InstallInSystemDlkm() {
 		return "system_dlkm"
 	} else if p.InstallInVendorDlkm() {
 		return "vendor_dlkm"
 	} else if p.InstallInOdmDlkm() {
 		return "odm_dlkm"
 	} else if p.InstallInRamdisk() {
 		// From this hardcoding in make:
 		// https://cs.android.com/android/platform/superproject/main/+/main:build/make/core/sysprop.mk;l=311;drc=274435657e4682e5cee3fffd11fb301ab32a828d
 		return "bootimage"
 	}
 	return "system"
 }

 func (p *buildPropModule) GenerateAndroidBuildActions(ctx ModuleContext) {
 	if !p.SocSpecific() && p.properties.Android_info != nil {
 		ctx.ModuleErrorf("Android_info cannot be set if build.prop is not installed in vendor partition")
 	}

 	outputFilePath := PathForModuleOut(ctx, "build.prop")

 	partition := p.partition(ctx.DeviceConfig())

 	rule := NewRuleBuilder(pctx, ctx)

 	config := ctx.Config()

 	cmd := rule.Command().BuiltTool("gen_build_prop")

 	cmd.FlagWithInput("--build-hostname-file=", config.BuildHostnameFile(ctx))
 	cmd.FlagWithInput("--build-number-file=", config.BuildNumberFile(ctx))
 	// shouldn't depend on BuildFingerprintFile and BuildThumbprintFile to prevent from rebuilding
 	// on every incremental build.
 	cmd.FlagWithArg("--build-fingerprint-file=", config.BuildFingerprintFile(ctx).String())
 	// Export build thumbprint only if the product has specified at least one oem fingerprint property
 	// b/17888863
 	if shouldAddBuildThumbprint(config) {
 		// In the previous make implementation, a dependency was not added on the thumbprint file
 		cmd.FlagWithArg("--build-thumbprint-file=", config.BuildThumbprintFile(ctx).String())
 	}
 	cmd.FlagWithArg("--build-username=", config.Getenv("BUILD_USERNAME"))
 	// shouldn't depend on BUILD_DATETIME_FILE to prevent from rebuilding on every incremental
 	// build.
 	cmd.FlagWithArg("--date-file=", ctx.Config().Getenv("BUILD_DATETIME_FILE"))
 	cmd.FlagWithInput("--platform-preview-sdk-fingerprint-file=", ApiFingerprintPath(ctx))
 	cmd.FlagWithInput("--product-config=", PathForModuleSrc(ctx, proptools.String(p.properties.Product_config)))
 	cmd.FlagWithArg("--partition=", partition)
 	cmd.FlagForEachInput("--prop-files=", p.propFiles(ctx))
 	cmd.FlagWithOutput("--out=", outputFilePath)

 	postProcessCmd := rule.Command().BuiltTool("post_process_props")
 	if ctx.DeviceConfig().BuildBrokenDupSysprop() {
 		postProcessCmd.Flag("--allow-dup")
 	}
 	postProcessCmd.FlagWithArg("--sdk-version ", config.PlatformSdkVersion().String())
 	if ctx.Config().EnableUffdGc() == "default" {
 		postProcessCmd.FlagWithInput("--kernel-version-file-for-uffd-gc ", PathForOutput(ctx, "dexpreopt/kernel_version_for_uffd_gc.txt"))
 	} else {
 		// still need to pass an empty string to kernel-version-file-for-uffd-gc
 		postProcessCmd.FlagWithArg("--kernel-version-file-for-uffd-gc ", `""`)
 	}
 	postProcessCmd.Text(outputFilePath.String())
 	postProcessCmd.Flags(p.properties.Block_list)

 	for _, footer := range p.properties.Footer_files {
 		path := PathForModuleSrc(ctx, footer)
 		rule.appendText(outputFilePath, "####################################")
 		rule.appendTextf(outputFilePath, "# Adding footer from %v", footer)
 		rule.appendTextf(outputFilePath, "# with path %v", path)
 		rule.appendText(outputFilePath, "####################################")
 		rule.Command().Text("cat").FlagWithInput("", path).FlagWithArg(">> ", outputFilePath.String())
 	}

 	rule.appendText(outputFilePath, "# end of file")

 	rule.Build(ctx.ModuleName(), "generating build.prop")

 	p.installPath = PathForModuleInstall(ctx, proptools.String(p.properties.Relative_install_path))
 	ctx.InstallFile(p.installPath, p.stem(), outputFilePath)

 	ctx.SetOutputFiles(Paths{outputFilePath}, "")
 	p.outputFilePath = outputFilePath
 }

 func (r *RuleBuilder) appendText(path ModuleOutPath, text string) {
 	r.Command().Text("echo").Text(proptools.NinjaAndShellEscape(text)).FlagWithArg(">> ", path.String())
 }

 func (r *RuleBuilder) appendTextf(path ModuleOutPath, format string, a ...any) {
 	r.appendText(path, fmt.Sprintf(format, a...))
 }

 func (p *buildPropModule) AndroidMkEntries() []AndroidMkEntries {
 	return []AndroidMkEntries{{
 		Class:      "ETC",
 		OutputFile: OptionalPathForPath(p.outputFilePath),
 		ExtraEntries: []AndroidMkExtraEntriesFunc{
 			func(ctx AndroidMkExtraEntriesContext, entries *AndroidMkEntries) {
 				entries.SetString("LOCAL_MODULE_PATH", p.installPath.String())
 				entries.SetString("LOCAL_INSTALLED_MODULE_STEM", p.outputFilePath.Base())
 			},
 		},
 	}}
 }

 // build_prop module generates {partition}/build.prop file. At first common build properties are
 // printed based on Soong config variables. And then prop_files are printed as-is. Finally,
 // post_process_props tool is run to check if the result build.prop is valid or not.
 func BuildPropFactory() Module {
 	module := &buildPropModule{}
 	module.AddProperties(&module.properties)
 	InitAndroidArchModule(module, DeviceSupported, MultilibCommon)
 	return module
 }
	// Copyright 2024 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 android

	import (
	"fmt"

	"github.com/google/blueprint/proptools"
	)

	func init() {
	registerBuildPropComponents(InitRegistrationContext)
	}

	func registerBuildPropComponents(ctx RegistrationContext) {
	ctx.RegisterModuleType("build_prop", BuildPropFactory)
	ctx.RegisterModuleType("android_info", AndroidInfoFactory)
	}

	type buildPropProperties struct {
	// Output file name. Defaults to "build.prop"
	Stem *string

	// List of prop names to exclude. This affects not only common build properties but also
	// properties in prop_files.
	Block_list []string

	// Files to be appended at the end of build.prop. These files are appended after
	// post_process_props without any further checking.
	Footer_files []string `android:"path"`

	// Path to a JSON file containing product configs.
	Product_config *string `android:"path"`

	// Path to android-info.txt file containing board specific info.
	// This is empty for build.prop of all partitions except vendor.
	Android_info *string `android:"path"`

	// Optional subdirectory under which this file is installed into
	Relative_install_path *string
	}

	type buildPropModule struct {
	ModuleBase

	properties buildPropProperties

	outputFilePath Path
	installPath InstallPath
	}

	func (p *buildPropModule) stem() string {
	return proptools.StringDefault(p.properties.Stem, "build.prop")
	}

	func (p *buildPropModule) propFiles(ctx ModuleContext) Paths {
	partition := p.partition(ctx.DeviceConfig())
	if partition == "system" {
	return ctx.Config().SystemPropFiles(ctx)
	} else if partition == "system_ext" {
	return ctx.Config().SystemExtPropFiles(ctx)
	} else if partition == "product" {
	return ctx.Config().ProductPropFiles(ctx)
	} else if partition == "odm" {
	return ctx.Config().OdmPropFiles(ctx)
	} else if partition == "vendor" {
	if p.properties.Android_info != nil {
	androidInfo := PathForModuleSrc(ctx, proptools.String(p.properties.Android_info))
	return append(ctx.Config().VendorPropFiles(ctx), androidInfo)
	}
	return ctx.Config().VendorPropFiles(ctx)
	}
	return nil
	}

	func shouldAddBuildThumbprint(config Config) bool {
	knownOemProperties := []string{
	"ro.product.brand",
	"ro.product.name",
	"ro.product.device",
	}

	for _, knownProp := range knownOemProperties {
	if InList(knownProp, config.OemProperties()) {
	return true
	}
	}
	return false
	}

	// Can't use PartitionTag() because PartitionTag() returns the partition this module is actually
	// installed (e.g. odm module's partition tag can be either "odm" or "vendor")
	func (p *buildPropModule) partition(config DeviceConfig) string {
	if p.SocSpecific() {
	return "vendor"
	} else if p.DeviceSpecific() {
	return "odm"
	} else if p.ProductSpecific() {
	return "product"
	} else if p.SystemExtSpecific() {
	return "system_ext"
	} else if p.InstallInSystemDlkm() {
	return "system_dlkm"
	} else if p.InstallInVendorDlkm() {
	return "vendor_dlkm"
	} else if p.InstallInOdmDlkm() {
	return "odm_dlkm"
	} else if p.InstallInRamdisk() {
	// From this hardcoding in make:
	// https://cs.android.com/android/platform/superproject/main/+/main:build/make/core/sysprop.mk;l=311;drc=274435657e4682e5cee3fffd11fb301ab32a828d
	return "bootimage"
	}
	return "system"
	}

	func (p *buildPropModule) GenerateAndroidBuildActions(ctx ModuleContext) {
	if !p.SocSpecific() && p.properties.Android_info != nil {
	ctx.ModuleErrorf("Android_info cannot be set if build.prop is not installed in vendor partition")
	}

	outputFilePath := PathForModuleOut(ctx, "build.prop")

	partition := p.partition(ctx.DeviceConfig())

	rule := NewRuleBuilder(pctx, ctx)

	config := ctx.Config()

	cmd := rule.Command().BuiltTool("gen_build_prop")

	cmd.FlagWithInput("--build-hostname-file=", config.BuildHostnameFile(ctx))
	cmd.FlagWithInput("--build-number-file=", config.BuildNumberFile(ctx))
	// shouldn't depend on BuildFingerprintFile and BuildThumbprintFile to prevent from rebuilding
	// on every incremental build.
	cmd.FlagWithArg("--build-fingerprint-file=", config.BuildFingerprintFile(ctx).String())
	// Export build thumbprint only if the product has specified at least one oem fingerprint property
	// b/17888863
	if shouldAddBuildThumbprint(config) {
	// In the previous make implementation, a dependency was not added on the thumbprint file
	cmd.FlagWithArg("--build-thumbprint-file=", config.BuildThumbprintFile(ctx).String())
	}
	cmd.FlagWithArg("--build-username=", config.Getenv("BUILD_USERNAME"))
	// shouldn't depend on BUILD_DATETIME_FILE to prevent from rebuilding on every incremental
	// build.
	cmd.FlagWithArg("--date-file=", ctx.Config().Getenv("BUILD_DATETIME_FILE"))
	cmd.FlagWithInput("--platform-preview-sdk-fingerprint-file=", ApiFingerprintPath(ctx))
	cmd.FlagWithInput("--product-config=", PathForModuleSrc(ctx, proptools.String(p.properties.Product_config)))
	cmd.FlagWithArg("--partition=", partition)
	cmd.FlagForEachInput("--prop-files=", p.propFiles(ctx))
	cmd.FlagWithOutput("--out=", outputFilePath)

	postProcessCmd := rule.Command().BuiltTool("post_process_props")
	if ctx.DeviceConfig().BuildBrokenDupSysprop() {
	postProcessCmd.Flag("--allow-dup")
	}
	postProcessCmd.FlagWithArg("--sdk-version ", config.PlatformSdkVersion().String())
	if ctx.Config().EnableUffdGc() == "default" {
	postProcessCmd.FlagWithInput("--kernel-version-file-for-uffd-gc ", PathForOutput(ctx, "dexpreopt/kernel_version_for_uffd_gc.txt"))
	} else {
	// still need to pass an empty string to kernel-version-file-for-uffd-gc
	postProcessCmd.FlagWithArg("--kernel-version-file-for-uffd-gc ", `""`)
	}
	postProcessCmd.Text(outputFilePath.String())
	postProcessCmd.Flags(p.properties.Block_list)

	for _, footer := range p.properties.Footer_files {
	path := PathForModuleSrc(ctx, footer)
	rule.appendText(outputFilePath, "####################################")
	rule.appendTextf(outputFilePath, "# Adding footer from %v", footer)
	rule.appendTextf(outputFilePath, "# with path %v", path)
	rule.appendText(outputFilePath, "####################################")
	rule.Command().Text("cat").FlagWithInput("", path).FlagWithArg(">> ", outputFilePath.String())
	}

	rule.appendText(outputFilePath, "# end of file")

	rule.Build(ctx.ModuleName(), "generating build.prop")

	p.installPath = PathForModuleInstall(ctx, proptools.String(p.properties.Relative_install_path))
	ctx.InstallFile(p.installPath, p.stem(), outputFilePath)

	ctx.SetOutputFiles(Paths{outputFilePath}, "")
	p.outputFilePath = outputFilePath
	}

	func (r *RuleBuilder) appendText(path ModuleOutPath, text string) {
	r.Command().Text("echo").Text(proptools.NinjaAndShellEscape(text)).FlagWithArg(">> ", path.String())
	}

	func (r *RuleBuilder) appendTextf(path ModuleOutPath, format string, a ...any) {
	r.appendText(path, fmt.Sprintf(format, a...))
	}

	func (p *buildPropModule) AndroidMkEntries() []AndroidMkEntries {
	return []AndroidMkEntries{{
	Class: "ETC",
	OutputFile: OptionalPathForPath(p.outputFilePath),
	ExtraEntries: []AndroidMkExtraEntriesFunc{
	func(ctx AndroidMkExtraEntriesContext, entries *AndroidMkEntries) {
	entries.SetString("LOCAL_MODULE_PATH", p.installPath.String())
	entries.SetString("LOCAL_INSTALLED_MODULE_STEM", p.outputFilePath.Base())
	},
	},
	}}
	}

	// build_prop module generates {partition}/build.prop file. At first common build properties are
	// printed based on Soong config variables. And then prop_files are printed as-is. Finally,
	// post_process_props tool is run to check if the result build.prop is valid or not.
	func BuildPropFactory() Module {
	module := &buildPropModule{}
	module.AddProperties(&module.properties)
	InitAndroidArchModule(module, DeviceSupported, MultilibCommon)
	return module
	}