blob: 676a0e72216d3bf97cedea77d706424c1dc2884f [file] [log] [blame]
Colin Crossf24a22a2019-01-31 14:12:44 -08001// Copyright 2019 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 java
16
17import (
Paul Duffind3c15132021-04-21 22:12:35 +010018 "strings"
19
Colin Crossf24a22a2019-01-31 14:12:44 -080020 "android/soong/android"
21)
22
23func init() {
Paul Duffin01289a22021-02-04 17:49:33 +000024 RegisterHiddenApiSingletonComponents(android.InitRegistrationContext)
25}
26
27func RegisterHiddenApiSingletonComponents(ctx android.RegistrationContext) {
28 ctx.RegisterSingletonType("hiddenapi", hiddenAPISingletonFactory)
Colin Crossf24a22a2019-01-31 14:12:44 -080029}
30
Paul Duffin175947f2021-03-12 21:44:02 +000031var PrepareForTestWithHiddenApiBuildComponents = android.FixtureRegisterWithContext(RegisterHiddenApiSingletonComponents)
32
Colin Crossf24a22a2019-01-31 14:12:44 -080033type hiddenAPISingletonPathsStruct struct {
Paul Duffinff774a02021-01-29 12:53:15 +000034 // The path to the CSV file that contains the flags that will be encoded into the dex boot jars.
35 //
36 // It is created by the generate_hiddenapi_lists.py tool that is passed the stubFlags along with
37 // a number of additional files that are used to augment the information in the stubFlags with
38 // manually curated data.
39 flags android.OutputPath
40
41 // The path to the CSV index file that contains mappings from Java signature to source location
42 // information for all Java elements annotated with the UnsupportedAppUsage annotation in the
43 // source of all the boot jars.
44 //
45 // It is created by the merge_csv tool which merges all the hiddenAPI.indexCSVPath files that have
46 // been created by the rest of the build. That includes the index files generated for
47 // <x>-hiddenapi modules.
48 index android.OutputPath
49
50 // The path to the CSV metadata file that contains mappings from Java signature to the value of
51 // properties specified on UnsupportedAppUsage annotations in the source of all the boot jars.
52 //
53 // It is created by the merge_csv tool which merges all the hiddenAPI.metadataCSVPath files that
54 // have been created by the rest of the build. That includes the metadata files generated for
55 // <x>-hiddenapi modules.
56 metadata android.OutputPath
57
58 // The path to the CSV metadata file that contains mappings from Java signature to flags obtained
59 // from the public, system and test API stubs.
60 //
61 // This is created by the hiddenapi tool which is given dex files for the public, system and test
62 // API stubs (including product specific stubs) along with dex boot jars, so does not include
63 // <x>-hiddenapi modules. For each API surface (i.e. public, system, test) it records which
64 // members in the dex boot jars match a member in the dex stub jars for that API surface and then
65 // outputs a file containing the signatures of all members in the dex boot jars along with the
66 // flags that indicate which API surface it belongs, if any.
67 //
68 // e.g. a dex member that matches a member in the public dex stubs would have flags
69 // "public-api,system-api,test-api" set (as system and test are both supersets of public). A dex
70 // member that didn't match a member in any of the dex stubs is still output it just has an empty
71 // set of flags.
72 //
73 // The notion of matching is quite complex, it is not restricted to just exact matching but also
74 // follows the Java inheritance rules. e.g. if a method is public then all overriding/implementing
75 // methods are also public. If an interface method is public and a class inherits an
76 // implementation of that method from a super class then that super class method is also public.
77 // That ensures that any method that can be called directly by an App through a public method is
78 // visible to that App.
79 //
80 // Propagating the visibility of members across the inheritance hierarchy at build time will cause
81 // problems when modularizing and unbundling as it that propagation can cross module boundaries.
82 // e.g. Say that a private framework class implements a public interface and inherits an
83 // implementation of one of its methods from a core platform ART class. In that case the ART
84 // implementation method needs to be marked as public which requires the build to have access to
85 // the framework implementation classes at build time. The work to rectify this is being tracked
86 // at http://b/178693149.
87 //
88 // This file (or at least those items marked as being in the public-api) is used by hiddenapi when
89 // creating the metadata and flags for the individual modules in order to perform consistency
90 // checks and filter out bridge methods that are part of the public API. The latter relies on the
91 // propagation of visibility across the inheritance hierarchy.
Artur Satayevb5df8a02020-02-19 16:39:59 +000092 stubFlags android.OutputPath
Colin Crossf24a22a2019-01-31 14:12:44 -080093}
94
95var hiddenAPISingletonPathsKey = android.NewOnceKey("hiddenAPISingletonPathsKey")
96
97// hiddenAPISingletonPaths creates all the paths for singleton files the first time it is called, which may be
98// from a ModuleContext that needs to reference a file that will be created by a singleton rule that hasn't
99// yet been created.
100func hiddenAPISingletonPaths(ctx android.PathContext) hiddenAPISingletonPathsStruct {
101 return ctx.Config().Once(hiddenAPISingletonPathsKey, func() interface{} {
Paul Duffin6a766452021-04-12 14:15:22 +0100102 // Make the paths relative to the out/soong/hiddenapi directory instead of to the out/soong/
103 // directory. This ensures that if they are used as java_resources they do not end up in a
104 // hiddenapi directory in the resulting APK.
105 hiddenapiDir := android.PathForOutput(ctx, "hiddenapi")
Colin Crossf24a22a2019-01-31 14:12:44 -0800106 return hiddenAPISingletonPathsStruct{
Paul Duffin6a766452021-04-12 14:15:22 +0100107 flags: hiddenapiDir.Join(ctx, "hiddenapi-flags.csv"),
108 index: hiddenapiDir.Join(ctx, "hiddenapi-index.csv"),
109 metadata: hiddenapiDir.Join(ctx, "hiddenapi-unsupported.csv"),
110 stubFlags: hiddenapiDir.Join(ctx, "hiddenapi-stub-flags.txt"),
Colin Crossf24a22a2019-01-31 14:12:44 -0800111 }
112 }).(hiddenAPISingletonPathsStruct)
113}
114
Colin Crossf24a22a2019-01-31 14:12:44 -0800115func hiddenAPISingletonFactory() android.Singleton {
Colin Crossed023ec2019-02-19 12:38:45 -0800116 return &hiddenAPISingleton{}
Colin Crossf24a22a2019-01-31 14:12:44 -0800117}
118
Colin Crossed023ec2019-02-19 12:38:45 -0800119type hiddenAPISingleton struct {
Paul Duffin85dee5d2021-04-13 00:14:38 +0100120 flags android.Path
Colin Crossed023ec2019-02-19 12:38:45 -0800121}
Colin Crossf24a22a2019-01-31 14:12:44 -0800122
123// hiddenAPI singleton rules
Colin Crossed023ec2019-02-19 12:38:45 -0800124func (h *hiddenAPISingleton) GenerateBuildActions(ctx android.SingletonContext) {
Colin Crossf24a22a2019-01-31 14:12:44 -0800125 // Don't run any hiddenapi rules if UNSAFE_DISABLE_HIDDENAPI_FLAGS=true
126 if ctx.Config().IsEnvTrue("UNSAFE_DISABLE_HIDDENAPI_FLAGS") {
127 return
128 }
129
Bill Peckhambae47492021-01-08 09:34:44 -0800130 // If there is a prebuilt hiddenapi dir, generate rules to use the
131 // files within. Generally, we build the hiddenapi files from source
132 // during the build, ensuring consistency. It's possible, in a split
133 // build (framework and vendor) scenario, for the vendor build to use
134 // prebuilt hiddenapi files from the framework build. In this scenario,
135 // the framework and vendor builds must use the same source to ensure
136 // consistency.
137
138 if ctx.Config().PrebuiltHiddenApiDir(ctx) != "" {
139 h.flags = prebuiltFlagsRule(ctx)
Paul Duffin22c74312021-04-12 16:39:39 +0100140 prebuiltIndexRule(ctx)
Bill Peckhambae47492021-01-08 09:34:44 -0800141 return
142 }
143
Colin Crossf24a22a2019-01-31 14:12:44 -0800144 // These rules depend on files located in frameworks/base, skip them if running in a tree that doesn't have them.
Jiyong Park09cb6292019-07-15 15:29:23 +0900145 if ctx.Config().FrameworksBaseDirExists(ctx) {
Colin Crossed023ec2019-02-19 12:38:45 -0800146 h.flags = flagsRule(ctx)
Colin Crossf24a22a2019-01-31 14:12:44 -0800147 } else {
Colin Crossed023ec2019-02-19 12:38:45 -0800148 h.flags = emptyFlagsRule(ctx)
149 }
150}
151
Paul Duffindd63d6d2021-02-03 18:34:00 +0000152// Checks to see whether the supplied module variant is in the list of boot jars.
153//
Paul Duffin7ebebfd2021-04-27 19:36:57 +0100154// TODO(b/179354495): Avoid having to perform this type of check.
Paul Duffin82b3fcf2021-02-12 15:42:46 +0000155func isModuleInConfiguredList(ctx android.BaseModuleContext, module android.Module, configuredBootJars android.ConfiguredJarList) bool {
156 name := ctx.OtherModuleName(module)
Paul Duffindd63d6d2021-02-03 18:34:00 +0000157
158 // Strip a prebuilt_ prefix so that this can match a prebuilt module that has not been renamed.
159 name = android.RemoveOptionalPrebuiltPrefix(name)
160
161 // Ignore any module that is not listed in the boot image configuration.
162 index := configuredBootJars.IndexOfJar(name)
163 if index == -1 {
164 return false
165 }
166
167 // It is an error if the module is not an ApexModule.
168 if _, ok := module.(android.ApexModule); !ok {
Paul Duffind6894ca2021-04-27 15:23:28 +0100169 ctx.ModuleErrorf("%s is configured in boot jars but does not support being added to an apex", ctx.OtherModuleName(module))
Paul Duffindd63d6d2021-02-03 18:34:00 +0000170 return false
171 }
172
Paul Duffin82b3fcf2021-02-12 15:42:46 +0000173 apexInfo := ctx.OtherModuleProvider(module, android.ApexInfoProvider).(android.ApexInfo)
Paul Duffindd63d6d2021-02-03 18:34:00 +0000174
175 // Now match the apex part of the boot image configuration.
176 requiredApex := configuredBootJars.Apex(index)
Paul Duffin110b0ad2021-04-27 14:36:08 +0100177 if requiredApex == "platform" || requiredApex == "system_ext" {
Paul Duffindd63d6d2021-02-03 18:34:00 +0000178 if len(apexInfo.InApexes) != 0 {
179 // A platform variant is required but this is for an apex so ignore it.
180 return false
181 }
182 } else if !apexInfo.InApexByBaseName(requiredApex) {
183 // An apex variant for a specific apex is required but this is the wrong apex.
184 return false
185 }
186
187 return true
188}
189
Bill Peckhambae47492021-01-08 09:34:44 -0800190func prebuiltFlagsRule(ctx android.SingletonContext) android.Path {
191 outputPath := hiddenAPISingletonPaths(ctx).flags
192 inputPath := android.PathForSource(ctx, ctx.Config().PrebuiltHiddenApiDir(ctx), "hiddenapi-flags.csv")
193
194 ctx.Build(pctx, android.BuildParams{
195 Rule: android.Cp,
196 Output: outputPath,
197 Input: inputPath,
198 })
199
200 return outputPath
201}
202
Paul Duffin22c74312021-04-12 16:39:39 +0100203func prebuiltIndexRule(ctx android.SingletonContext) {
204 outputPath := hiddenAPISingletonPaths(ctx).index
205 inputPath := android.PathForSource(ctx, ctx.Config().PrebuiltHiddenApiDir(ctx), "hiddenapi-index.csv")
206
207 ctx.Build(pctx, android.BuildParams{
208 Rule: android.Cp,
209 Output: outputPath,
210 Input: inputPath,
211 })
212}
213
Paul Duffin702210b2021-04-08 20:12:41 +0100214// flagsRule is a placeholder that simply returns the location of the file, the generation of the
215// ninja rules is done in generateHiddenAPIBuildActions.
Colin Crossed023ec2019-02-19 12:38:45 -0800216func flagsRule(ctx android.SingletonContext) android.Path {
Colin Crossf24a22a2019-01-31 14:12:44 -0800217 outputPath := hiddenAPISingletonPaths(ctx).flags
Paul Duffinc6bb7cf2021-04-08 17:49:27 +0100218 return outputPath
219}
220
Colin Crossf24a22a2019-01-31 14:12:44 -0800221// emptyFlagsRule creates a rule to build an empty hiddenapi-flags.csv, which is needed by master-art-host builds that
222// have a partial manifest without frameworks/base but still need to build a boot image.
Colin Crossed023ec2019-02-19 12:38:45 -0800223func emptyFlagsRule(ctx android.SingletonContext) android.Path {
Colin Crossf1a035e2020-11-16 17:32:30 -0800224 rule := android.NewRuleBuilder(pctx, ctx)
Colin Crossf24a22a2019-01-31 14:12:44 -0800225
226 outputPath := hiddenAPISingletonPaths(ctx).flags
227
Colin Cross69f59a32019-02-15 10:39:37 -0800228 rule.Command().Text("rm").Flag("-f").Output(outputPath)
229 rule.Command().Text("touch").Output(outputPath)
Colin Crossf24a22a2019-01-31 14:12:44 -0800230
Colin Crossf1a035e2020-11-16 17:32:30 -0800231 rule.Build("emptyHiddenAPIFlagsFile", "empty hiddenapi flags")
Colin Crossed023ec2019-02-19 12:38:45 -0800232
233 return outputPath
Colin Crossf24a22a2019-01-31 14:12:44 -0800234}
235
Paul Duffind3c15132021-04-21 22:12:35 +0100236// tempPathForRestat creates a path of the same type as the supplied type but with a name of
237// <path>.tmp.
238//
239// e.g. If path is an OutputPath for out/soong/hiddenapi/hiddenapi-flags.csv then this will return
240// an OutputPath for out/soong/hiddenapi/hiddenapi-flags.csv.tmp
241func tempPathForRestat(ctx android.PathContext, path android.WritablePath) android.WritablePath {
242 extWithoutLeadingDot := strings.TrimPrefix(path.Ext(), ".")
243 return path.ReplaceExtension(ctx, extWithoutLeadingDot+".tmp")
244}
245
Colin Crossf24a22a2019-01-31 14:12:44 -0800246// commitChangeForRestat adds a command to a rule that updates outputPath from tempPath if they are different. It
247// also marks the rule as restat and marks the tempPath as a temporary file that should not be considered an output of
248// the rule.
249func commitChangeForRestat(rule *android.RuleBuilder, tempPath, outputPath android.WritablePath) {
250 rule.Restat()
Colin Cross69f59a32019-02-15 10:39:37 -0800251 rule.Temporary(tempPath)
Colin Crossf24a22a2019-01-31 14:12:44 -0800252 rule.Command().
253 Text("(").
254 Text("if").
Colin Cross69f59a32019-02-15 10:39:37 -0800255 Text("cmp -s").Input(tempPath).Output(outputPath).Text(";").
Colin Crossf24a22a2019-01-31 14:12:44 -0800256 Text("then").
Colin Cross69f59a32019-02-15 10:39:37 -0800257 Text("rm").Input(tempPath).Text(";").
Colin Crossf24a22a2019-01-31 14:12:44 -0800258 Text("else").
Colin Cross69f59a32019-02-15 10:39:37 -0800259 Text("mv").Input(tempPath).Output(outputPath).Text(";").
Colin Crossf24a22a2019-01-31 14:12:44 -0800260 Text("fi").
261 Text(")")
262}