1// Copyright 2023 Google Inc. All rights reserved.
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 aconfig
16
17import (
18	"android/soong/android"
19
20	"github.com/google/blueprint"
21)
22
23var (
24	pctx = android.NewPackageContext("android/soong/aconfig")
25
26	// For aconfig_declarations: Generate cache file
27	aconfigRule = pctx.AndroidStaticRule("aconfig",
28		blueprint.RuleParams{
29			Command: `${aconfig} create-cache` +
30				` --package ${package}` +
31				` ${container}` +
32				` ${declarations}` +
33				` ${values}` +
34				` ${default-permission}` +
35				` --cache ${out}.tmp` +
36				` && ( if cmp -s ${out}.tmp ${out} ; then rm ${out}.tmp ; else mv ${out}.tmp ${out} ; fi )`,
37			//				` --build-id ${release_version}` +
38			CommandDeps: []string{
39				"${aconfig}",
40			},
41			Restat: true,
42		}, "release_version", "package", "container", "declarations", "values", "default-permission")
43
44	// For create-device-config-sysprops: Generate aconfig flag value map text file
45	aconfigTextRule = pctx.AndroidStaticRule("aconfig_text",
46		blueprint.RuleParams{
47			Command: `${aconfig} dump-cache --dedup --format='{fully_qualified_name}={state:bool}'` +
48				` --cache ${in}` +
49				` --out ${out}.tmp` +
50				` && ( if cmp -s ${out}.tmp ${out} ; then rm ${out}.tmp ; else mv ${out}.tmp ${out} ; fi )`,
51			CommandDeps: []string{
52				"${aconfig}",
53			},
54			Restat: true,
55		})
56
57	// For all_aconfig_declarations: Combine all parsed_flags proto files
58	AllDeclarationsRule = pctx.AndroidStaticRule("All_aconfig_declarations_dump",
59		blueprint.RuleParams{
60			Command: `${aconfig} dump-cache --dedup --format protobuf --out ${out} ${cache_files}`,
61			CommandDeps: []string{
62				"${aconfig}",
63			},
64		}, "cache_files")
65	AllDeclarationsRuleTextProto = pctx.AndroidStaticRule("All_aconfig_declarations_dump_textproto",
66		blueprint.RuleParams{
67			Command: `${aconfig} dump-cache --dedup --format textproto --out ${out} ${cache_files}`,
68			CommandDeps: []string{
69				"${aconfig}",
70			},
71		}, "cache_files")
72
73	CreateStorageRule = pctx.AndroidStaticRule("aconfig_create_storage",
74		blueprint.RuleParams{
75			Command: `${aconfig} create-storage --container ${container} --file ${file_type} --out ${out} ${cache_files}`,
76			CommandDeps: []string{
77				"${aconfig}",
78			},
79		}, "container", "file_type", "cache_files")
80
81	// For exported_java_aconfig_library: Generate a JAR from all
82	// java_aconfig_libraries to be consumed by apps built outside the
83	// platform
84	exportedJavaRule = pctx.AndroidStaticRule("exported_java_aconfig_library",
85		// For each aconfig cache file, if the cache contains any
86		// exported flags, generate Java flag lookup code for the
87		// exported flags (only). Finally collect all generated code
88		// into the ${out} JAR file.
89		blueprint.RuleParams{
90			Command: `rm -rf ${out}.tmp` +
91				`&& for cache in ${cache_files}; do ` +
92				`  if [ -n "$$(${aconfig} dump-cache --dedup --cache $$cache --filter=is_exported:true --format='{fully_qualified_name}')" ]; then ` +
93				`    ${aconfig} create-java-lib --cache $$cache --mode=exported --out ${out}.tmp; ` +
94				`  fi ` +
95				`done` +
96				`&& $soong_zip -write_if_changed -jar -o ${out} -C ${out}.tmp -D ${out}.tmp` +
97				`&& rm -rf ${out}.tmp`,
98			CommandDeps: []string{
99				"$aconfig",
100				"$soong_zip",
101			},
102		}, "cache_files")
103)
104
105func init() {
106	RegisterBuildComponents(android.InitRegistrationContext)
107	pctx.HostBinToolVariable("aconfig", "aconfig")
108	pctx.HostBinToolVariable("soong_zip", "soong_zip")
109}
110
111func RegisterBuildComponents(ctx android.RegistrationContext) {
112	ctx.RegisterModuleType("aconfig_declarations", DeclarationsFactory)
113	ctx.RegisterModuleType("aconfig_values", ValuesFactory)
114	ctx.RegisterModuleType("aconfig_value_set", ValueSetFactory)
115	ctx.RegisterParallelSingletonType("all_aconfig_declarations", AllAconfigDeclarationsFactory)
116	ctx.RegisterParallelSingletonType("exported_java_aconfig_library", ExportedJavaDeclarationsLibraryFactory)
117}
118