blob: a398cbce2728b478a3fb26995f880bb9991b686c [file] [log] [blame]
Inseob Kimc0907f12019-02-08 21:00:45 +09001// Copyright (C) 2019 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
Inseob Kim07def122020-11-23 14:43:02 +090015// sysprop package defines a module named sysprop_library that can implement sysprop as API
16// See https://source.android.com/devices/architecture/sysprops-apis for details
Inseob Kimc0907f12019-02-08 21:00:45 +090017package sysprop
18
19import (
Inseob Kim42882742019-07-30 17:55:33 +090020 "fmt"
21 "io"
Inseob Kimc9770d62021-01-15 18:04:20 +090022 "os"
Inseob Kim42882742019-07-30 17:55:33 +090023 "path"
Andrew Walbrana5deb732024-02-15 13:39:46 +000024 "strings"
Inseob Kim628d7ef2020-03-21 03:38:32 +090025 "sync"
Colin Crossf8b860a2019-04-16 14:43:28 -070026
Inseob Kimc0907f12019-02-08 21:00:45 +090027 "github.com/google/blueprint"
28 "github.com/google/blueprint/proptools"
Inseob Kim42882742019-07-30 17:55:33 +090029
30 "android/soong/android"
31 "android/soong/cc"
32 "android/soong/java"
Andrew Walbrana5deb732024-02-15 13:39:46 +000033 "android/soong/rust"
Inseob Kimc0907f12019-02-08 21:00:45 +090034)
35
36type dependencyTag struct {
37 blueprint.BaseDependencyTag
38 name string
39}
40
Inseob Kim988f53c2019-09-16 15:59:01 +090041type syspropGenProperties struct {
Colin Cross75ce9ec2021-02-26 16:20:32 -080042 Srcs []string `android:"path"`
43 Scope string
44 Name *string
45 Check_api *string
Inseob Kim988f53c2019-09-16 15:59:01 +090046}
47
48type syspropJavaGenRule struct {
49 android.ModuleBase
50
51 properties syspropGenProperties
Inseob Kim988f53c2019-09-16 15:59:01 +090052}
53
Andrew Walbrana5deb732024-02-15 13:39:46 +000054type syspropRustGenRule struct {
Andrew Walbranacd75d22024-03-12 17:27:29 +000055 *rust.BaseSourceProvider
Andrew Walbrana5deb732024-02-15 13:39:46 +000056
Andrew Walbranacd75d22024-03-12 17:27:29 +000057 properties rustLibraryProperties
Andrew Walbrana5deb732024-02-15 13:39:46 +000058}
59
Andrew Walbranacd75d22024-03-12 17:27:29 +000060var _ rust.SourceProvider = (*syspropRustGenRule)(nil)
Inseob Kim988f53c2019-09-16 15:59:01 +090061
62var (
63 syspropJava = pctx.AndroidStaticRule("syspropJava",
64 blueprint.RuleParams{
65 Command: `rm -rf $out.tmp && mkdir -p $out.tmp && ` +
66 `$syspropJavaCmd --scope $scope --java-output-dir $out.tmp $in && ` +
67 `$soongZipCmd -jar -o $out -C $out.tmp -D $out.tmp && rm -rf $out.tmp`,
68 CommandDeps: []string{
69 "$syspropJavaCmd",
70 "$soongZipCmd",
71 },
72 }, "scope")
Andrew Walbrana5deb732024-02-15 13:39:46 +000073 syspropRust = pctx.AndroidStaticRule("syspropRust",
74 blueprint.RuleParams{
75 Command: `rm -rf $out_dir && mkdir -p $out_dir && ` +
76 `$syspropRustCmd --scope $scope --rust-output-dir $out_dir $in`,
77 CommandDeps: []string{
78 "$syspropRustCmd",
79 },
80 }, "scope", "out_dir")
Inseob Kim988f53c2019-09-16 15:59:01 +090081)
82
83func init() {
84 pctx.HostBinToolVariable("soongZipCmd", "soong_zip")
85 pctx.HostBinToolVariable("syspropJavaCmd", "sysprop_java")
Andrew Walbrana5deb732024-02-15 13:39:46 +000086 pctx.HostBinToolVariable("syspropRustCmd", "sysprop_rust")
Inseob Kim988f53c2019-09-16 15:59:01 +090087}
88
Inseob Kim07def122020-11-23 14:43:02 +090089// syspropJavaGenRule module generates srcjar containing generated java APIs.
90// It also depends on check api rule, so api check has to pass to use sysprop_library.
Inseob Kim988f53c2019-09-16 15:59:01 +090091func (g *syspropJavaGenRule) GenerateAndroidBuildActions(ctx android.ModuleContext) {
92 var checkApiFileTimeStamp android.WritablePath
93
94 ctx.VisitDirectDeps(func(dep android.Module) {
95 if m, ok := dep.(*syspropLibrary); ok {
96 checkApiFileTimeStamp = m.checkApiFileTimeStamp
97 }
98 })
99
mrziwangba2a4602024-06-11 14:39:15 -0700100 var genSrcjars android.Paths
Inseob Kim988f53c2019-09-16 15:59:01 +0900101 for _, syspropFile := range android.PathsForModuleSrc(ctx, g.properties.Srcs) {
102 srcJarFile := android.GenPathWithExt(ctx, "sysprop", syspropFile, "srcjar")
103
104 ctx.Build(pctx, android.BuildParams{
105 Rule: syspropJava,
106 Description: "sysprop_java " + syspropFile.Rel(),
107 Output: srcJarFile,
108 Input: syspropFile,
109 Implicit: checkApiFileTimeStamp,
110 Args: map[string]string{
111 "scope": g.properties.Scope,
112 },
113 })
114
mrziwangba2a4602024-06-11 14:39:15 -0700115 genSrcjars = append(genSrcjars, srcJarFile)
Inseob Kim988f53c2019-09-16 15:59:01 +0900116 }
mrziwangba2a4602024-06-11 14:39:15 -0700117
118 ctx.SetOutputFiles(genSrcjars, "")
Inseob Kim988f53c2019-09-16 15:59:01 +0900119}
120
Colin Cross75ce9ec2021-02-26 16:20:32 -0800121func (g *syspropJavaGenRule) DepsMutator(ctx android.BottomUpMutatorContext) {
122 // Add a dependency from the stubs to sysprop library so that the generator rule can depend on
123 // the check API rule of the sysprop library.
124 ctx.AddFarVariationDependencies(nil, nil, proptools.String(g.properties.Check_api))
125}
126
Inseob Kim988f53c2019-09-16 15:59:01 +0900127func syspropJavaGenFactory() android.Module {
128 g := &syspropJavaGenRule{}
129 g.AddProperties(&g.properties)
130 android.InitAndroidModule(g)
131 return g
132}
133
Andrew Walbrana5deb732024-02-15 13:39:46 +0000134// syspropRustGenRule module generates rust source files containing generated rust APIs.
135// It also depends on check api rule, so api check has to pass to use sysprop_library.
Andrew Walbranacd75d22024-03-12 17:27:29 +0000136func (g *syspropRustGenRule) GenerateSource(ctx rust.ModuleContext, deps rust.PathDeps) android.Path {
Andrew Walbrana5deb732024-02-15 13:39:46 +0000137 var checkApiFileTimeStamp android.WritablePath
138
139 ctx.VisitDirectDeps(func(dep android.Module) {
140 if m, ok := dep.(*syspropLibrary); ok {
141 checkApiFileTimeStamp = m.checkApiFileTimeStamp
142 }
143 })
144
Andrew Walbranacd75d22024-03-12 17:27:29 +0000145 outputDir := android.PathForModuleOut(ctx, "src")
146 libFile := outputDir.Join(ctx, "lib.rs")
147 g.BaseSourceProvider.OutputFiles = append(g.BaseSourceProvider.OutputFiles, libFile)
148 libFileLines := []string{"//! Autogenerated system property accessors."}
149
150 for _, syspropFile := range android.PathsForModuleSrc(ctx, g.properties.Sysprop_srcs) {
151 moduleName := syspropPathToRustModule(syspropFile)
152 moduleDir := outputDir.Join(ctx, moduleName)
153 modulePath := moduleDir.Join(ctx, "mod.rs")
Andrew Walbrana5deb732024-02-15 13:39:46 +0000154
155 ctx.Build(pctx, android.BuildParams{
156 Rule: syspropRust,
157 Description: "sysprop_rust " + syspropFile.Rel(),
Andrew Walbranacd75d22024-03-12 17:27:29 +0000158 Output: modulePath,
Andrew Walbrana5deb732024-02-15 13:39:46 +0000159 Input: syspropFile,
160 Implicit: checkApiFileTimeStamp,
161 Args: map[string]string{
162 "scope": g.properties.Scope,
Andrew Walbranacd75d22024-03-12 17:27:29 +0000163 "out_dir": moduleDir.String(),
Andrew Walbrana5deb732024-02-15 13:39:46 +0000164 },
165 })
166
Andrew Walbranacd75d22024-03-12 17:27:29 +0000167 g.BaseSourceProvider.OutputFiles = append(g.BaseSourceProvider.OutputFiles, modulePath)
168 libFileLines = append(libFileLines, fmt.Sprintf("pub mod %s;", moduleName))
Andrew Walbrana5deb732024-02-15 13:39:46 +0000169 }
Andrew Walbranacd75d22024-03-12 17:27:29 +0000170
171 libFileSource := strings.Join(libFileLines, "\n")
172 android.WriteFileRule(ctx, libFile, libFileSource)
173
174 return libFile
175}
176
177func (g *syspropRustGenRule) SourceProviderProps() []interface{} {
178 return append(g.BaseSourceProvider.SourceProviderProps(), &g.Properties)
179}
180
181// syspropPathToRustModule takes a path to a .sysprop file and returns the name to use for the
182// corresponding Rust module.
183func syspropPathToRustModule(syspropFilename android.Path) string {
184 filenameBase := strings.TrimSuffix(syspropFilename.Base(), ".sysprop")
185 return strings.ToLower(filenameBase)
Andrew Walbrana5deb732024-02-15 13:39:46 +0000186}
187
188func (g *syspropRustGenRule) DepsMutator(ctx android.BottomUpMutatorContext) {
189 // Add a dependency from the stubs to sysprop library so that the generator rule can depend on
190 // the check API rule of the sysprop library.
191 ctx.AddFarVariationDependencies(nil, nil, proptools.String(g.properties.Check_api))
192}
193
Andrew Walbrana5deb732024-02-15 13:39:46 +0000194func syspropRustGenFactory() android.Module {
Andrew Walbranacd75d22024-03-12 17:27:29 +0000195 g := &syspropRustGenRule{
196 BaseSourceProvider: rust.NewSourceProvider(),
197 }
198 sourceProvider := rust.NewSourceProviderModule(android.DeviceSupported, g, false, false)
199 sourceProvider.AddProperties(&g.properties)
200 return sourceProvider.Init()
Andrew Walbrana5deb732024-02-15 13:39:46 +0000201}
202
Inseob Kimc0907f12019-02-08 21:00:45 +0900203type syspropLibrary struct {
Inseob Kim42882742019-07-30 17:55:33 +0900204 android.ModuleBase
Paul Duffin7b3de8f2020-03-30 18:00:25 +0100205 android.ApexModuleBase
Inseob Kimc0907f12019-02-08 21:00:45 +0900206
Inseob Kim42882742019-07-30 17:55:33 +0900207 properties syspropLibraryProperties
208
209 checkApiFileTimeStamp android.WritablePath
Inseob Kimc9770d62021-01-15 18:04:20 +0900210 latestApiFile android.OptionalPath
211 currentApiFile android.OptionalPath
Inseob Kim42882742019-07-30 17:55:33 +0900212 dumpedApiFile android.WritablePath
Inseob Kimc0907f12019-02-08 21:00:45 +0900213}
214
215type syspropLibraryProperties struct {
216 // Determine who owns this sysprop library. Possible values are
217 // "Platform", "Vendor", or "Odm"
218 Property_owner string
Inseob Kimf63c2fb2019-03-05 14:22:30 +0900219
220 // list of package names that will be documented and publicized as API
221 Api_packages []string
Inseob Kimc0907f12019-02-08 21:00:45 +0900222
Inseob Kim42882742019-07-30 17:55:33 +0900223 // If set to true, allow this module to be dexed and installed on devices.
224 Installable *bool
225
Inseob Kim9da1f812021-06-14 12:03:59 +0900226 // Make this module available when building for ramdisk
227 Ramdisk_available *bool
228
Shintaro Kawamurac7d0f0a2025-02-13 19:43:28 +0900229 // Make this module available when building for vendor ramdisk
230 Vendor_ramdisk_available *bool
231
Inseob Kim42882742019-07-30 17:55:33 +0900232 // Make this module available when building for recovery
Jiyong Park854a9442019-02-26 10:27:13 +0900233 Recovery_available *bool
Inseob Kim42882742019-07-30 17:55:33 +0900234
235 // Make this module available when building for vendor
236 Vendor_available *bool
237
Justin Yun63e9ec72020-10-29 16:49:43 +0900238 // Make this module available when building for product
239 Product_available *bool
240
Inseob Kim42882742019-07-30 17:55:33 +0900241 // list of .sysprop files which defines the properties.
242 Srcs []string `android:"path"`
Inseob Kimac1e9862019-12-09 18:15:47 +0900243
Inseob Kim89db15d2020-02-03 18:06:46 +0900244 // If set to true, build a variant of the module for the host. Defaults to false.
245 Host_supported *bool
246
Jooyung Han379660c2020-04-21 15:24:00 +0900247 Cpp struct {
248 // Minimum sdk version that the artifact should support when it runs as part of mainline modules(APEX).
249 // Forwarded to cc_library.min_sdk_version
250 Min_sdk_version *string
Steven Morelandc43a4ac2023-10-24 21:49:18 +0000251
252 // C compiler flags used to build library
253 Cflags []string
254
255 // Linker flags used to build binary
256 Ldflags []string
Jooyung Han379660c2020-04-21 15:24:00 +0900257 }
Jiyong Park5e914b22021-03-08 10:09:52 +0900258
259 Java struct {
260 // Minimum sdk version that the artifact should support when it runs as part of mainline modules(APEX).
261 // Forwarded to java_library.min_sdk_version
262 Min_sdk_version *string
263 }
Andrew Walbrana5deb732024-02-15 13:39:46 +0000264
265 Rust struct {
266 // Minimum sdk version that the artifact should support when it runs as part of mainline modules(APEX).
267 // Forwarded to rust_library.min_sdk_version
268 Min_sdk_version *string
269 }
Inseob Kimc0907f12019-02-08 21:00:45 +0900270}
271
272var (
Inseob Kim42882742019-07-30 17:55:33 +0900273 pctx = android.NewPackageContext("android/soong/sysprop")
Inseob Kimc0907f12019-02-08 21:00:45 +0900274 syspropCcTag = dependencyTag{name: "syspropCc"}
Inseob Kim628d7ef2020-03-21 03:38:32 +0900275
276 syspropLibrariesKey = android.NewOnceKey("syspropLibraries")
277 syspropLibrariesLock sync.Mutex
Inseob Kimc0907f12019-02-08 21:00:45 +0900278)
279
Inseob Kim07def122020-11-23 14:43:02 +0900280// List of sysprop_library used by property_contexts to perform type check.
Inseob Kim628d7ef2020-03-21 03:38:32 +0900281func syspropLibraries(config android.Config) *[]string {
282 return config.Once(syspropLibrariesKey, func() interface{} {
283 return &[]string{}
284 }).(*[]string)
285}
286
287func SyspropLibraries(config android.Config) []string {
288 return append([]string{}, *syspropLibraries(config)...)
289}
290
Inseob Kimc0907f12019-02-08 21:00:45 +0900291func init() {
Paul Duffin6e3ce722021-03-18 00:20:11 +0000292 registerSyspropBuildComponents(android.InitRegistrationContext)
293}
294
295func registerSyspropBuildComponents(ctx android.RegistrationContext) {
296 ctx.RegisterModuleType("sysprop_library", syspropLibraryFactory)
Inseob Kimc0907f12019-02-08 21:00:45 +0900297}
298
Inseob Kim42882742019-07-30 17:55:33 +0900299func (m *syspropLibrary) Name() string {
300 return m.BaseModuleName() + "_sysprop_library"
Inseob Kimc0907f12019-02-08 21:00:45 +0900301}
302
Inseob Kimac1e9862019-12-09 18:15:47 +0900303func (m *syspropLibrary) Owner() string {
304 return m.properties.Property_owner
305}
306
Inseob Kim07def122020-11-23 14:43:02 +0900307func (m *syspropLibrary) CcImplementationModuleName() string {
Inseob Kim42882742019-07-30 17:55:33 +0900308 return "lib" + m.BaseModuleName()
309}
310
Colin Cross75ce9ec2021-02-26 16:20:32 -0800311func (m *syspropLibrary) javaPublicStubName() string {
312 return m.BaseModuleName() + "_public"
Inseob Kimac1e9862019-12-09 18:15:47 +0900313}
314
Inseob Kim988f53c2019-09-16 15:59:01 +0900315func (m *syspropLibrary) javaGenModuleName() string {
316 return m.BaseModuleName() + "_java_gen"
317}
318
Inseob Kimac1e9862019-12-09 18:15:47 +0900319func (m *syspropLibrary) javaGenPublicStubName() string {
320 return m.BaseModuleName() + "_java_gen_public"
321}
322
Andrew Walbrana5deb732024-02-15 13:39:46 +0000323func (m *syspropLibrary) rustGenStubName() string {
324 return "lib" + m.rustCrateName() + "_rust"
325}
326
327func (m *syspropLibrary) rustCrateName() string {
328 moduleName := strings.ToLower(m.BaseModuleName())
329 moduleName = strings.ReplaceAll(moduleName, "-", "_")
330 moduleName = strings.ReplaceAll(moduleName, ".", "_")
331 return moduleName
332}
333
Inseob Kim42882742019-07-30 17:55:33 +0900334func (m *syspropLibrary) BaseModuleName() string {
335 return m.ModuleBase.Name()
336}
337
Inseob Kimc9770d62021-01-15 18:04:20 +0900338func (m *syspropLibrary) CurrentSyspropApiFile() android.OptionalPath {
Inseob Kim628d7ef2020-03-21 03:38:32 +0900339 return m.currentApiFile
340}
341
Inseob Kim07def122020-11-23 14:43:02 +0900342// GenerateAndroidBuildActions of sysprop_library handles API dump and API check.
343// generated java_library will depend on these API files.
Inseob Kim42882742019-07-30 17:55:33 +0900344func (m *syspropLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Inseob Kim988f53c2019-09-16 15:59:01 +0900345 baseModuleName := m.BaseModuleName()
Aditya Choudhary26df39f2023-11-29 16:42:42 +0000346 srcs := android.PathsForModuleSrc(ctx, m.properties.Srcs)
347 for _, syspropFile := range srcs {
Inseob Kim988f53c2019-09-16 15:59:01 +0900348 if syspropFile.Ext() != ".sysprop" {
349 ctx.PropertyErrorf("srcs", "srcs contains non-sysprop file %q", syspropFile.String())
350 }
351 }
352
353 if ctx.Failed() {
354 return
355 }
356
Inseob Kimc9770d62021-01-15 18:04:20 +0900357 apiDirectoryPath := path.Join(ctx.ModuleDir(), "api")
358 currentApiFilePath := path.Join(apiDirectoryPath, baseModuleName+"-current.txt")
359 latestApiFilePath := path.Join(apiDirectoryPath, baseModuleName+"-latest.txt")
360 m.currentApiFile = android.ExistentPathForSource(ctx, currentApiFilePath)
361 m.latestApiFile = android.ExistentPathForSource(ctx, latestApiFilePath)
Inseob Kim42882742019-07-30 17:55:33 +0900362
363 // dump API rule
Colin Crossf1a035e2020-11-16 17:32:30 -0800364 rule := android.NewRuleBuilder(pctx, ctx)
Inseob Kim42882742019-07-30 17:55:33 +0900365 m.dumpedApiFile = android.PathForModuleOut(ctx, "api-dump.txt")
366 rule.Command().
Colin Crossf1a035e2020-11-16 17:32:30 -0800367 BuiltTool("sysprop_api_dump").
Inseob Kim42882742019-07-30 17:55:33 +0900368 Output(m.dumpedApiFile).
Aditya Choudhary26df39f2023-11-29 16:42:42 +0000369 Inputs(srcs)
Colin Crossf1a035e2020-11-16 17:32:30 -0800370 rule.Build(baseModuleName+"_api_dump", baseModuleName+" api dump")
Inseob Kim42882742019-07-30 17:55:33 +0900371
372 // check API rule
Colin Crossf1a035e2020-11-16 17:32:30 -0800373 rule = android.NewRuleBuilder(pctx, ctx)
Inseob Kim42882742019-07-30 17:55:33 +0900374
Inseob Kimc9770d62021-01-15 18:04:20 +0900375 // We allow that the API txt files don't exist, when the sysprop_library only contains internal
376 // properties. But we have to feed current api file and latest api file to the rule builder.
377 // Currently we can't get android.Path representing the null device, so we add any existing API
378 // txt files to implicits, and then directly feed string paths, rather than calling Input(Path)
379 // method.
380 var apiFileList android.Paths
381 currentApiArgument := os.DevNull
382 if m.currentApiFile.Valid() {
383 apiFileList = append(apiFileList, m.currentApiFile.Path())
384 currentApiArgument = m.currentApiFile.String()
385 }
386
387 latestApiArgument := os.DevNull
388 if m.latestApiFile.Valid() {
389 apiFileList = append(apiFileList, m.latestApiFile.Path())
390 latestApiArgument = m.latestApiFile.String()
391 }
392
Inseob Kim07def122020-11-23 14:43:02 +0900393 // 1. compares current.txt to api-dump.txt
394 // current.txt should be identical to api-dump.txt.
Inseob Kim42882742019-07-30 17:55:33 +0900395 msg := fmt.Sprintf(`\n******************************\n`+
396 `API of sysprop_library %s doesn't match with current.txt\n`+
397 `Please update current.txt by:\n`+
Inseob Kimc9770d62021-01-15 18:04:20 +0900398 `m %s-dump-api && mkdir -p %q && rm -rf %q && cp -f %q %q\n`+
Inseob Kim988f53c2019-09-16 15:59:01 +0900399 `******************************\n`, baseModuleName, baseModuleName,
Inseob Kimc9770d62021-01-15 18:04:20 +0900400 apiDirectoryPath, currentApiFilePath, m.dumpedApiFile.String(), currentApiFilePath)
Inseob Kim42882742019-07-30 17:55:33 +0900401
402 rule.Command().
403 Text("( cmp").Flag("-s").
404 Input(m.dumpedApiFile).
Inseob Kimc9770d62021-01-15 18:04:20 +0900405 Text(currentApiArgument).
Inseob Kim42882742019-07-30 17:55:33 +0900406 Text("|| ( echo").Flag("-e").
407 Flag(`"` + msg + `"`).
408 Text("; exit 38) )")
409
Inseob Kim07def122020-11-23 14:43:02 +0900410 // 2. compares current.txt to latest.txt (frozen API)
411 // current.txt should be compatible with latest.txt
Inseob Kim42882742019-07-30 17:55:33 +0900412 msg = fmt.Sprintf(`\n******************************\n`+
413 `API of sysprop_library %s doesn't match with latest version\n`+
414 `Please fix the breakage and rebuild.\n`+
Inseob Kim988f53c2019-09-16 15:59:01 +0900415 `******************************\n`, baseModuleName)
Inseob Kim42882742019-07-30 17:55:33 +0900416
417 rule.Command().
418 Text("( ").
Colin Crossf1a035e2020-11-16 17:32:30 -0800419 BuiltTool("sysprop_api_checker").
Inseob Kimc9770d62021-01-15 18:04:20 +0900420 Text(latestApiArgument).
421 Text(currentApiArgument).
Inseob Kim42882742019-07-30 17:55:33 +0900422 Text(" || ( echo").Flag("-e").
423 Flag(`"` + msg + `"`).
Inseob Kimc9770d62021-01-15 18:04:20 +0900424 Text("; exit 38) )").
425 Implicits(apiFileList)
Inseob Kim42882742019-07-30 17:55:33 +0900426
427 m.checkApiFileTimeStamp = android.PathForModuleOut(ctx, "check_api.timestamp")
428
429 rule.Command().
430 Text("touch").
431 Output(m.checkApiFileTimeStamp)
432
Colin Crossf1a035e2020-11-16 17:32:30 -0800433 rule.Build(baseModuleName+"_check_api", baseModuleName+" check api")
Inseob Kim42882742019-07-30 17:55:33 +0900434}
435
436func (m *syspropLibrary) AndroidMk() android.AndroidMkData {
437 return android.AndroidMkData{
438 Custom: func(w io.Writer, name, prefix, moduleDir string, data android.AndroidMkData) {
439 // sysprop_library module itself is defined as a FAKE module to perform API check.
440 // Actual implementation libraries are created on LoadHookMutator
Sasha Smundak5c4729d2022-12-01 10:49:23 -0800441 fmt.Fprintln(w, "\ninclude $(CLEAR_VARS)", " # sysprop.syspropLibrary")
442 fmt.Fprintln(w, "LOCAL_MODULE :=", m.Name())
Inseob Kim42882742019-07-30 17:55:33 +0900443 fmt.Fprintf(w, "LOCAL_MODULE_CLASS := FAKE\n")
444 fmt.Fprintf(w, "LOCAL_MODULE_TAGS := optional\n")
LaMont Jonesb5099382024-01-10 23:42:36 +0000445 // AconfigUpdateAndroidMkData may have added elements to Extra. Process them here.
446 for _, extra := range data.Extra {
447 extra(w, nil)
448 }
Inseob Kim42882742019-07-30 17:55:33 +0900449 fmt.Fprintf(w, "include $(BUILD_SYSTEM)/base_rules.mk\n\n")
450 fmt.Fprintf(w, "$(LOCAL_BUILT_MODULE): %s\n", m.checkApiFileTimeStamp.String())
451 fmt.Fprintf(w, "\ttouch $@\n\n")
Inseob Kim988f53c2019-09-16 15:59:01 +0900452 fmt.Fprintf(w, ".PHONY: %s-check-api %s-dump-api\n\n", name, name)
453
454 // dump API rule
455 fmt.Fprintf(w, "%s-dump-api: %s\n\n", name, m.dumpedApiFile.String())
Inseob Kim42882742019-07-30 17:55:33 +0900456
457 // check API rule
458 fmt.Fprintf(w, "%s-check-api: %s\n\n", name, m.checkApiFileTimeStamp.String())
Inseob Kim42882742019-07-30 17:55:33 +0900459 }}
460}
461
Jiyong Park45bf82e2020-12-15 22:29:02 +0900462var _ android.ApexModule = (*syspropLibrary)(nil)
463
464// Implements android.ApexModule
Yu Liudf0b8392025-02-12 18:27:03 +0000465func (m *syspropLibrary) MinSdkVersionSupported(ctx android.BaseModuleContext) android.ApiLevel {
466 return android.MinApiLevel
Jooyung Han749dc692020-04-15 11:03:39 +0900467}
468
Inseob Kim42882742019-07-30 17:55:33 +0900469// sysprop_library creates schematized APIs from sysprop description files (.sysprop).
470// Both Java and C++ modules can link against sysprop_library, and API stability check
471// against latest APIs (see build/soong/scripts/freeze-sysprop-api-files.sh)
Trevor Radcliffed82e8f62022-06-08 16:16:31 +0000472// is performed. Note that the generated C++ module has its name prefixed with
473// `lib`, and it is this module that should be depended on from other C++
474// modules; i.e., if the sysprop_library module is named `foo`, C++ modules
475// should depend on `libfoo`.
Inseob Kimc0907f12019-02-08 21:00:45 +0900476func syspropLibraryFactory() android.Module {
477 m := &syspropLibrary{}
478
479 m.AddProperties(
Inseob Kim42882742019-07-30 17:55:33 +0900480 &m.properties,
Inseob Kimc0907f12019-02-08 21:00:45 +0900481 )
Inseob Kim42882742019-07-30 17:55:33 +0900482 android.InitAndroidModule(m)
Paul Duffin7b3de8f2020-03-30 18:00:25 +0100483 android.InitApexModule(m)
Inseob Kimc0907f12019-02-08 21:00:45 +0900484 android.AddLoadHook(m, func(ctx android.LoadHookContext) { syspropLibraryHook(ctx, m) })
Inseob Kimc0907f12019-02-08 21:00:45 +0900485 return m
486}
487
Inseob Kimac1e9862019-12-09 18:15:47 +0900488type ccLibraryProperties struct {
489 Name *string
490 Srcs []string
491 Soc_specific *bool
492 Device_specific *bool
493 Product_specific *bool
494 Sysprop struct {
495 Platform *bool
496 }
Inseob Kim89db15d2020-02-03 18:06:46 +0900497 Target struct {
498 Android struct {
499 Header_libs []string
500 Shared_libs []string
501 }
502 Host struct {
503 Static_libs []string
504 }
505 }
Shintaro Kawamurac7d0f0a2025-02-13 19:43:28 +0900506 Required []string
507 Recovery *bool
508 Recovery_available *bool
509 Vendor_available *bool
510 Product_available *bool
511 Ramdisk_available *bool
512 Vendor_ramdisk_available *bool
513 Host_supported *bool
514 Apex_available []string
515 Min_sdk_version *string
516 Cflags []string
517 Ldflags []string
Inseob Kimac1e9862019-12-09 18:15:47 +0900518}
519
520type javaLibraryProperties struct {
Colin Cross75ce9ec2021-02-26 16:20:32 -0800521 Name *string
522 Srcs []string
523 Soc_specific *bool
524 Device_specific *bool
525 Product_specific *bool
526 Required []string
527 Sdk_version *string
528 Installable *bool
529 Libs []string
530 Stem *string
531 SyspropPublicStub string
Jiyong Park5e914b22021-03-08 10:09:52 +0900532 Apex_available []string
533 Min_sdk_version *string
Inseob Kimac1e9862019-12-09 18:15:47 +0900534}
535
Andrew Walbrana5deb732024-02-15 13:39:46 +0000536type rustLibraryProperties struct {
537 Name *string
Andrew Walbranacd75d22024-03-12 17:27:29 +0000538 Sysprop_srcs []string `android:"path"`
539 Scope string
540 Check_api *string
Andrew Walbrana5deb732024-02-15 13:39:46 +0000541 Srcs []string
542 Installable *bool
543 Crate_name string
544 Rustlibs []string
545 Vendor_available *bool
546 Product_available *bool
547 Apex_available []string
548 Min_sdk_version *string
549}
550
Inseob Kimc0907f12019-02-08 21:00:45 +0900551func syspropLibraryHook(ctx android.LoadHookContext, m *syspropLibrary) {
Inseob Kim42882742019-07-30 17:55:33 +0900552 if len(m.properties.Srcs) == 0 {
Inseob Kim6e93ac92019-03-21 17:43:49 +0900553 ctx.PropertyErrorf("srcs", "sysprop_library must specify srcs")
554 }
555
Inseob Kimac1e9862019-12-09 18:15:47 +0900556 // ctx's Platform or Specific functions represent where this sysprop_library installed.
557 installedInSystem := ctx.Platform() || ctx.SystemExtSpecific()
558 installedInVendorOrOdm := ctx.SocSpecific() || ctx.DeviceSpecific()
Inseob Kimfe612182020-10-20 16:29:55 +0900559 installedInProduct := ctx.ProductSpecific()
Inseob Kimac1e9862019-12-09 18:15:47 +0900560 isOwnerPlatform := false
Inseob Kim07def122020-11-23 14:43:02 +0900561 var javaSyspropStub string
Inseob Kimfe612182020-10-20 16:29:55 +0900562
Inseob Kim07def122020-11-23 14:43:02 +0900563 // javaSyspropStub contains stub libraries used by generated APIs, instead of framework stub.
564 // This is to make sysprop_library link against core_current.
Inseob Kimfe612182020-10-20 16:29:55 +0900565 if installedInVendorOrOdm {
Inseob Kim07def122020-11-23 14:43:02 +0900566 javaSyspropStub = "sysprop-library-stub-vendor"
Inseob Kimfe612182020-10-20 16:29:55 +0900567 } else if installedInProduct {
Inseob Kim07def122020-11-23 14:43:02 +0900568 javaSyspropStub = "sysprop-library-stub-product"
Inseob Kimfe612182020-10-20 16:29:55 +0900569 } else {
Inseob Kim07def122020-11-23 14:43:02 +0900570 javaSyspropStub = "sysprop-library-stub-platform"
Inseob Kimfe612182020-10-20 16:29:55 +0900571 }
Inseob Kimc0907f12019-02-08 21:00:45 +0900572
Inseob Kimac1e9862019-12-09 18:15:47 +0900573 switch m.Owner() {
Inseob Kimc0907f12019-02-08 21:00:45 +0900574 case "Platform":
575 // Every partition can access platform-defined properties
Inseob Kimac1e9862019-12-09 18:15:47 +0900576 isOwnerPlatform = true
Inseob Kimc0907f12019-02-08 21:00:45 +0900577 case "Vendor":
578 // System can't access vendor's properties
Inseob Kimac1e9862019-12-09 18:15:47 +0900579 if installedInSystem {
Inseob Kimc0907f12019-02-08 21:00:45 +0900580 ctx.ModuleErrorf("None of soc_specific, device_specific, product_specific is true. " +
581 "System can't access sysprop_library owned by Vendor")
582 }
583 case "Odm":
584 // Only vendor can access Odm-defined properties
Inseob Kimac1e9862019-12-09 18:15:47 +0900585 if !installedInVendorOrOdm {
Inseob Kimc0907f12019-02-08 21:00:45 +0900586 ctx.ModuleErrorf("Neither soc_speicifc nor device_specific is true. " +
587 "Odm-defined properties should be accessed only in Vendor or Odm")
588 }
589 default:
590 ctx.PropertyErrorf("property_owner",
Inseob Kimac1e9862019-12-09 18:15:47 +0900591 "Unknown value %s: must be one of Platform, Vendor or Odm", m.Owner())
Inseob Kimc0907f12019-02-08 21:00:45 +0900592 }
593
Inseob Kim07def122020-11-23 14:43:02 +0900594 // Generate a C++ implementation library.
595 // cc_library can receive *.sysprop files as their srcs, generating sources itself.
Inseob Kimac1e9862019-12-09 18:15:47 +0900596 ccProps := ccLibraryProperties{}
Inseob Kim07def122020-11-23 14:43:02 +0900597 ccProps.Name = proptools.StringPtr(m.CcImplementationModuleName())
Inseob Kim42882742019-07-30 17:55:33 +0900598 ccProps.Srcs = m.properties.Srcs
Inseob Kimac1e9862019-12-09 18:15:47 +0900599 ccProps.Soc_specific = proptools.BoolPtr(ctx.SocSpecific())
600 ccProps.Device_specific = proptools.BoolPtr(ctx.DeviceSpecific())
601 ccProps.Product_specific = proptools.BoolPtr(ctx.ProductSpecific())
602 ccProps.Sysprop.Platform = proptools.BoolPtr(isOwnerPlatform)
Inseob Kim89db15d2020-02-03 18:06:46 +0900603 ccProps.Target.Android.Header_libs = []string{"libbase_headers"}
604 ccProps.Target.Android.Shared_libs = []string{"liblog"}
605 ccProps.Target.Host.Static_libs = []string{"libbase", "liblog"}
Inseob Kim42882742019-07-30 17:55:33 +0900606 ccProps.Recovery_available = m.properties.Recovery_available
607 ccProps.Vendor_available = m.properties.Vendor_available
Justin Yun63e9ec72020-10-29 16:49:43 +0900608 ccProps.Product_available = m.properties.Product_available
Inseob Kim9da1f812021-06-14 12:03:59 +0900609 ccProps.Ramdisk_available = m.properties.Ramdisk_available
Shintaro Kawamurac7d0f0a2025-02-13 19:43:28 +0900610 ccProps.Vendor_ramdisk_available = m.properties.Vendor_ramdisk_available
Inseob Kim89db15d2020-02-03 18:06:46 +0900611 ccProps.Host_supported = m.properties.Host_supported
Paul Duffin7b3de8f2020-03-30 18:00:25 +0100612 ccProps.Apex_available = m.ApexProperties.Apex_available
Jooyung Han379660c2020-04-21 15:24:00 +0900613 ccProps.Min_sdk_version = m.properties.Cpp.Min_sdk_version
Steven Morelandc43a4ac2023-10-24 21:49:18 +0000614 ccProps.Cflags = m.properties.Cpp.Cflags
615 ccProps.Ldflags = m.properties.Cpp.Ldflags
Colin Cross84dfc3d2019-09-25 11:33:01 -0700616 ctx.CreateModule(cc.LibraryFactory, &ccProps)
Inseob Kim42882742019-07-30 17:55:33 +0900617
Inseob Kim988f53c2019-09-16 15:59:01 +0900618 scope := "internal"
Inseob Kim988f53c2019-09-16 15:59:01 +0900619
Inseob Kimac1e9862019-12-09 18:15:47 +0900620 // We need to only use public version, if the partition where sysprop_library will be installed
621 // is different from owner.
Inseob Kimac1e9862019-12-09 18:15:47 +0900622 if ctx.ProductSpecific() {
Inseob Kim07def122020-11-23 14:43:02 +0900623 // Currently product partition can't own any sysprop_library. So product always uses public.
Inseob Kim988f53c2019-09-16 15:59:01 +0900624 scope = "public"
Inseob Kimac1e9862019-12-09 18:15:47 +0900625 } else if isOwnerPlatform && installedInVendorOrOdm {
626 // Vendor or Odm should use public version of Platform's sysprop_library.
Inseob Kim988f53c2019-09-16 15:59:01 +0900627 scope = "public"
628 }
629
Inseob Kim07def122020-11-23 14:43:02 +0900630 // Generate a Java implementation library.
631 // Contrast to C++, syspropJavaGenRule module will generate srcjar and the srcjar will be fed
632 // to Java implementation library.
Inseob Kimac1e9862019-12-09 18:15:47 +0900633 ctx.CreateModule(syspropJavaGenFactory, &syspropGenProperties{
Colin Cross75ce9ec2021-02-26 16:20:32 -0800634 Srcs: m.properties.Srcs,
635 Scope: scope,
636 Name: proptools.StringPtr(m.javaGenModuleName()),
637 Check_api: proptools.StringPtr(ctx.ModuleName()),
Inseob Kimac1e9862019-12-09 18:15:47 +0900638 })
639
640 // if platform sysprop_library is installed in /system or /system-ext, we regard it as an API
641 // and allow any modules (even from different partition) to link against the sysprop_library.
642 // To do that, we create a public stub and expose it to modules with sdk_version: system_*.
Colin Cross75ce9ec2021-02-26 16:20:32 -0800643 var publicStub string
Inseob Kimac1e9862019-12-09 18:15:47 +0900644 if isOwnerPlatform && installedInSystem {
Colin Cross75ce9ec2021-02-26 16:20:32 -0800645 publicStub = m.javaPublicStubName()
646 }
647
648 ctx.CreateModule(java.LibraryFactory, &javaLibraryProperties{
649 Name: proptools.StringPtr(m.BaseModuleName()),
650 Srcs: []string{":" + m.javaGenModuleName()},
651 Soc_specific: proptools.BoolPtr(ctx.SocSpecific()),
652 Device_specific: proptools.BoolPtr(ctx.DeviceSpecific()),
653 Product_specific: proptools.BoolPtr(ctx.ProductSpecific()),
654 Installable: m.properties.Installable,
655 Sdk_version: proptools.StringPtr("core_current"),
656 Libs: []string{javaSyspropStub},
657 SyspropPublicStub: publicStub,
Jiyong Park5e914b22021-03-08 10:09:52 +0900658 Apex_available: m.ApexProperties.Apex_available,
659 Min_sdk_version: m.properties.Java.Min_sdk_version,
Colin Cross75ce9ec2021-02-26 16:20:32 -0800660 })
661
662 if publicStub != "" {
Inseob Kimac1e9862019-12-09 18:15:47 +0900663 ctx.CreateModule(syspropJavaGenFactory, &syspropGenProperties{
Colin Cross75ce9ec2021-02-26 16:20:32 -0800664 Srcs: m.properties.Srcs,
665 Scope: "public",
666 Name: proptools.StringPtr(m.javaGenPublicStubName()),
667 Check_api: proptools.StringPtr(ctx.ModuleName()),
Inseob Kimac1e9862019-12-09 18:15:47 +0900668 })
669
670 ctx.CreateModule(java.LibraryFactory, &javaLibraryProperties{
Colin Cross75ce9ec2021-02-26 16:20:32 -0800671 Name: proptools.StringPtr(publicStub),
Inseob Kimac1e9862019-12-09 18:15:47 +0900672 Srcs: []string{":" + m.javaGenPublicStubName()},
673 Installable: proptools.BoolPtr(false),
674 Sdk_version: proptools.StringPtr("core_current"),
Inseob Kim07def122020-11-23 14:43:02 +0900675 Libs: []string{javaSyspropStub},
Inseob Kimac1e9862019-12-09 18:15:47 +0900676 Stem: proptools.StringPtr(m.BaseModuleName()),
677 })
Inseob Kim988f53c2019-09-16 15:59:01 +0900678 }
Inseob Kim628d7ef2020-03-21 03:38:32 +0900679
Andrew Walbrana5deb732024-02-15 13:39:46 +0000680 // Generate a Rust implementation library.
Andrew Walbrana5deb732024-02-15 13:39:46 +0000681 rustProps := rustLibraryProperties{
Andrew Walbranacd75d22024-03-12 17:27:29 +0000682 Name: proptools.StringPtr(m.rustGenStubName()),
683 Sysprop_srcs: m.properties.Srcs,
684 Scope: scope,
685 Check_api: proptools.StringPtr(ctx.ModuleName()),
Ivan Lozanoa6e92bd2024-12-12 16:52:17 +0000686 Installable: m.properties.Installable,
Andrew Walbranacd75d22024-03-12 17:27:29 +0000687 Crate_name: m.rustCrateName(),
Andrew Walbrana5deb732024-02-15 13:39:46 +0000688 Rustlibs: []string{
Andrew Walbranacd75d22024-03-12 17:27:29 +0000689 "liblog_rust",
Andrew Walbrana5deb732024-02-15 13:39:46 +0000690 "librustutils",
691 },
692 Vendor_available: m.properties.Vendor_available,
693 Product_available: m.properties.Product_available,
694 Apex_available: m.ApexProperties.Apex_available,
695 Min_sdk_version: proptools.StringPtr("29"),
696 }
Andrew Walbranacd75d22024-03-12 17:27:29 +0000697 ctx.CreateModule(syspropRustGenFactory, &rustProps)
Andrew Walbrana5deb732024-02-15 13:39:46 +0000698
Inseob Kim07def122020-11-23 14:43:02 +0900699 // syspropLibraries will be used by property_contexts to check types.
700 // Record absolute paths of sysprop_library to prevent soong_namespace problem.
Inseob Kim69cf09e2020-05-04 19:28:25 +0900701 if m.ExportedToMake() {
702 syspropLibrariesLock.Lock()
703 defer syspropLibrariesLock.Unlock()
Inseob Kim628d7ef2020-03-21 03:38:32 +0900704
Inseob Kim69cf09e2020-05-04 19:28:25 +0900705 libraries := syspropLibraries(ctx.Config())
706 *libraries = append(*libraries, "//"+ctx.ModuleDir()+":"+ctx.ModuleName())
707 }
Inseob Kimc0907f12019-02-08 21:00:45 +0900708}