diff --git a/Android.bp b/Android.bp index 2c0ef4740..c58bee090 100644 --- a/Android.bp +++ b/Android.bp @@ -136,3 +136,8 @@ buildinfo_prop { all_apex_contributions { name: "all_apex_contributions", } + +product_config { + name: "product_config", + visibility: ["//visibility:private"], +} diff --git a/android/Android.bp b/android/Android.bp index 9ce8cdcd2..21ef59f6d 100644 --- a/android/Android.bp +++ b/android/Android.bp @@ -83,6 +83,7 @@ bootstrap_go_package { "plugin.go", "prebuilt.go", "prebuilt_build_tool.go", + "product_config.go", "proto.go", "provider.go", "raw_files.go", diff --git a/android/product_config.go b/android/product_config.go new file mode 100644 index 000000000..20b29a7c4 --- /dev/null +++ b/android/product_config.go @@ -0,0 +1,58 @@ +// 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 "github.com/google/blueprint/proptools" + +func init() { + ctx := InitRegistrationContext + ctx.RegisterModuleType("product_config", productConfigFactory) +} + +type productConfigModule struct { + ModuleBase +} + +func (p *productConfigModule) GenerateAndroidBuildActions(ctx ModuleContext) { + if ctx.ModuleName() != "product_config" || ctx.ModuleDir() != "build/soong" { + ctx.ModuleErrorf("There can only be one product_config module in build/soong") + return + } + outputFilePath := PathForModuleOut(ctx, p.Name()+".json").OutputPath + + // DeviceProduct can be null so calling ctx.Config().DeviceProduct() may cause null dereference + targetProduct := proptools.String(ctx.Config().config.productVariables.DeviceProduct) + if targetProduct != "" { + targetProduct += "." + } + soongVariablesPath := PathForOutput(ctx, "soong."+targetProduct+"variables") + extraVariablesPath := PathForOutput(ctx, "soong."+targetProduct+"extra.variables") + + rule := NewRuleBuilder(pctx, ctx) + rule.Command().BuiltTool("merge_json"). + Output(outputFilePath). + Input(soongVariablesPath). + Input(extraVariablesPath). + rule.Build("product_config.json", "building product_config.json") + + ctx.SetOutputFiles(Paths{outputFilePath}, "") +} + +// product_config module exports product variables and extra variables as a JSON file. +func productConfigFactory() Module { + module := &productConfigModule{} + InitAndroidModule(module) + return module +} diff --git a/scripts/Android.bp b/scripts/Android.bp index 80cd93579..57766edba 100644 --- a/scripts/Android.bp +++ b/scripts/Android.bp @@ -291,6 +291,14 @@ python_binary_host { ], } +python_binary_host { + name: "merge_json", + main: "merge_json.py", + srcs: [ + "merge_json.py", + ], +} + python_binary_host { name: "buildinfo", main: "buildinfo.py", diff --git a/scripts/merge_json.py b/scripts/merge_json.py new file mode 100644 index 000000000..7e2f6eb51 --- /dev/null +++ b/scripts/merge_json.py @@ -0,0 +1,62 @@ +#!/usr/bin/env python +# +# Copyright 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. +# +"""A tool for merging two or more JSON files.""" + +import argparse +import logging +import json +import sys + +def parse_args(): + """Parse commandline arguments.""" + + parser = argparse.ArgumentParser() + parser.add_argument("output", help="output JSON file", type=argparse.FileType("w")) + parser.add_argument("input", help="input JSON files", nargs="+", type=argparse.FileType("r")) + return parser.parse_args() + +def main(): + """Program entry point.""" + args = parse_args() + merged_dict = {} + has_error = False + logger = logging.getLogger(__name__) + + for json_file in args.input: + try: + data = json.load(json_file) + except json.JSONDecodeError as e: + logger.error(f"Error parsing JSON in file: {json_file.name}. Reason: {e}") + has_error = True + continue + + for key, value in data.items(): + if key not in merged_dict: + merged_dict[key] = value + elif merged_dict[key] == value: + logger.warning(f"Duplicate key '{key}' with identical values found.") + else: + logger.error(f"Conflicting values for key '{key}': {merged_dict[key]} != {value}") + has_error = True + + if has_error: + sys.exit(1) + + json.dump(merged_dict, args.output) + +if __name__ == "__main__": + main() diff --git a/ui/build/config.go b/ui/build/config.go index feded1c85..a217d4844 100644 --- a/ui/build/config.go +++ b/ui/build/config.go @@ -1488,6 +1488,15 @@ func (c *configImpl) SoongVarsFile() string { } } +func (c *configImpl) SoongExtraVarsFile() string { + targetProduct, err := c.TargetProductOrErr() + if err != nil { + return filepath.Join(c.SoongOutDir(), "soong.extra.variables") + } else { + return filepath.Join(c.SoongOutDir(), "soong."+targetProduct+".extra.variables") + } +} + func (c *configImpl) SoongNinjaFile() string { targetProduct, err := c.TargetProductOrErr() if err != nil { diff --git a/ui/build/soong.go b/ui/build/soong.go index 2f3150d03..99474d99d 100644 --- a/ui/build/soong.go +++ b/ui/build/soong.go @@ -694,6 +694,7 @@ func runSoong(ctx Context, config Config) { } } distFile(ctx, config, config.SoongVarsFile(), "soong") + distFile(ctx, config, config.SoongExtraVarsFile(), "soong") if !config.SkipKati() { distGzipFile(ctx, config, config.SoongAndroidMk(), "soong") diff --git a/ui/build/test_build.go b/ui/build/test_build.go index 24ad08284..687ad6f61 100644 --- a/ui/build/test_build.go +++ b/ui/build/test_build.go @@ -64,7 +64,8 @@ func testForDanglingRules(ctx Context, config Config) { outDir := config.OutDir() modulePathsDir := filepath.Join(outDir, ".module_paths") rawFilesDir := filepath.Join(outDir, "soong", "raw") - variablesFilePath := filepath.Join(outDir, "soong", "soong.variables") + variablesFilePath := config.SoongVarsFile() + extraVariablesFilePath := config.SoongExtraVarsFile() // dexpreopt.config is an input to the soong_docs action, which runs the // soong_build primary builder. However, this file is created from $(shell) @@ -95,6 +96,7 @@ func testForDanglingRules(ctx Context, config Config) { if strings.HasPrefix(line, modulePathsDir) || strings.HasPrefix(line, rawFilesDir) || line == variablesFilePath || + line == extraVariablesFilePath || line == dexpreoptConfigFilePath || line == buildDatetimeFilePath || line == bpglob ||