blob: d43288b52e2328f916c77815e99b3de0c46671d8 [file] [log] [blame]
Colin Cross2fe66872015-03-30 17:20:39 -07001// Copyright 2015 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
17// This file contains the module types for compiling Java for Android, and converts the properties
Colin Cross46c9b8b2017-06-22 16:51:17 -070018// into the flags and filenames necessary to pass to the Module. The final creation of the rules
Colin Cross2fe66872015-03-30 17:20:39 -070019// is handled in builder.go
20
21import (
Colin Crossf19b9bb2018-03-26 14:42:44 -070022 "fmt"
Colin Crossfc3674a2017-09-18 17:41:52 -070023 "path/filepath"
Wei Libafb6d62021-12-10 03:14:59 -080024 "strings"
Colin Cross2fe66872015-03-30 17:20:39 -070025
Wei Libafb6d62021-12-10 03:14:59 -080026 "android/soong/bazel"
Sam Delmerico277795c2022-02-25 17:04:37 +000027 "android/soong/bazel/cquery"
Jihoon Kang0ac87c22022-11-15 19:06:14 +000028 "android/soong/remoteexec"
Sam Delmerico4e272292022-01-06 20:03:51 +000029
Colin Cross2fe66872015-03-30 17:20:39 -070030 "github.com/google/blueprint"
Colin Cross76b5f0c2017-08-29 16:02:06 -070031 "github.com/google/blueprint/proptools"
Colin Cross2fe66872015-03-30 17:20:39 -070032
Colin Cross635c3b02016-05-18 15:37:25 -070033 "android/soong/android"
Colin Crossf8d9c492021-01-26 11:01:43 -080034 "android/soong/cc"
Ulya Trafimovich31e444e2020-08-14 17:32:16 +010035 "android/soong/dexpreopt"
Colin Cross3e3e72d2017-06-22 17:20:19 -070036 "android/soong/java/config"
Colin Cross303e21f2018-08-07 16:49:25 -070037 "android/soong/tradefed"
Colin Cross2fe66872015-03-30 17:20:39 -070038)
39
Colin Cross463a90e2015-06-17 14:20:06 -070040func init() {
Paul Duffin535e0a12021-03-30 23:34:32 +010041 registerJavaBuildComponents(android.InitRegistrationContext)
Paul Duffin255f18e2019-12-13 11:22:16 +000042
Jaewoong Jungbc15e3a2021-03-10 17:02:43 -080043 RegisterJavaSdkMemberTypes()
44}
45
Paul Duffin535e0a12021-03-30 23:34:32 +010046func registerJavaBuildComponents(ctx android.RegistrationContext) {
Jaewoong Jungbc15e3a2021-03-10 17:02:43 -080047 ctx.RegisterModuleType("java_defaults", DefaultsFactory)
48
49 ctx.RegisterModuleType("java_library", LibraryFactory)
50 ctx.RegisterModuleType("java_library_static", LibraryStaticFactory)
51 ctx.RegisterModuleType("java_library_host", LibraryHostFactory)
52 ctx.RegisterModuleType("java_binary", BinaryFactory)
53 ctx.RegisterModuleType("java_binary_host", BinaryHostFactory)
54 ctx.RegisterModuleType("java_test", TestFactory)
55 ctx.RegisterModuleType("java_test_helper_library", TestHelperLibraryFactory)
56 ctx.RegisterModuleType("java_test_host", TestHostFactory)
57 ctx.RegisterModuleType("java_test_import", JavaTestImportFactory)
58 ctx.RegisterModuleType("java_import", ImportFactory)
59 ctx.RegisterModuleType("java_import_host", ImportFactoryHost)
60 ctx.RegisterModuleType("java_device_for_host", DeviceForHostFactory)
61 ctx.RegisterModuleType("java_host_for_device", HostForDeviceFactory)
62 ctx.RegisterModuleType("dex_import", DexImportFactory)
Jihoon Kang0ac87c22022-11-15 19:06:14 +000063 ctx.RegisterModuleType("java_api_library", ApiLibraryFactory)
64 ctx.RegisterModuleType("java_api_contribution", ApiContributionFactory)
Jaewoong Jungbc15e3a2021-03-10 17:02:43 -080065
Martin Stjernholm0e4cceb2021-05-13 02:38:35 +010066 // This mutator registers dependencies on dex2oat for modules that should be
67 // dexpreopted. This is done late when the final variants have been
68 // established, to not get the dependencies split into the wrong variants and
69 // to support the checks in dexpreoptDisabled().
Jaewoong Jungbc15e3a2021-03-10 17:02:43 -080070 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
71 ctx.BottomUp("dexpreopt_tool_deps", dexpreoptToolDepsMutator).Parallel()
Sam Delmerico1e3f78f2022-09-07 12:07:07 -040072 // needs access to ApexInfoProvider which is available after variant creation
73 ctx.BottomUp("jacoco_deps", jacocoDepsMutator).Parallel()
Jaewoong Jungbc15e3a2021-03-10 17:02:43 -080074 })
75
LaMont Jones0c10e4d2023-05-16 00:58:37 +000076 ctx.RegisterParallelSingletonType("logtags", LogtagsSingleton)
77 ctx.RegisterParallelSingletonType("kythe_java_extract", kytheExtractJavaFactory)
Jaewoong Jungbc15e3a2021-03-10 17:02:43 -080078}
79
80func RegisterJavaSdkMemberTypes() {
Paul Duffin255f18e2019-12-13 11:22:16 +000081 // Register sdk member types.
Paul Duffin7b81f5e2020-01-13 21:03:22 +000082 android.RegisterSdkMemberType(javaHeaderLibsSdkMemberType)
Paul Duffin2da04242021-04-23 19:43:28 +010083 android.RegisterSdkMemberType(javaLibsSdkMemberType)
84 android.RegisterSdkMemberType(javaBootLibsSdkMemberType)
Jiakai Zhangea180332021-09-26 08:58:02 +000085 android.RegisterSdkMemberType(javaSystemserverLibsSdkMemberType)
Paul Duffin2da04242021-04-23 19:43:28 +010086 android.RegisterSdkMemberType(javaTestSdkMemberType)
87}
88
89var (
90 // Supports adding java header libraries to module_exports and sdk.
91 javaHeaderLibsSdkMemberType = &librarySdkMemberType{
Paul Duffin7ed6ff82022-11-21 10:57:30 +000092 android.SdkMemberTypeBase{
Paul Duffin2da04242021-04-23 19:43:28 +010093 PropertyName: "java_header_libs",
94 SupportsSdk: true,
95 },
Paul Duffin7ed6ff82022-11-21 10:57:30 +000096 func(_ android.SdkMemberContext, j *Library) android.Path {
Paul Duffin2da04242021-04-23 19:43:28 +010097 headerJars := j.HeaderJars()
98 if len(headerJars) != 1 {
99 panic(fmt.Errorf("there must be only one header jar from %q", j.Name()))
100 }
101
102 return headerJars[0]
103 },
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000104 sdkSnapshotFilePathForJar,
105 copyEverythingToSnapshot,
Paul Duffin2da04242021-04-23 19:43:28 +0100106 }
Paul Duffin255f18e2019-12-13 11:22:16 +0000107
Paul Duffin22ff0aa2021-02-04 11:15:34 +0000108 // Export implementation classes jar as part of the sdk.
Paul Duffin2da04242021-04-23 19:43:28 +0100109 exportImplementationClassesJar = func(_ android.SdkMemberContext, j *Library) android.Path {
Paul Duffin22ff0aa2021-02-04 11:15:34 +0000110 implementationJars := j.ImplementationAndResourcesJars()
111 if len(implementationJars) != 1 {
112 panic(fmt.Errorf("there must be only one implementation jar from %q", j.Name()))
113 }
114 return implementationJars[0]
115 }
116
Paul Duffin2da04242021-04-23 19:43:28 +0100117 // Supports adding java implementation libraries to module_exports but not sdk.
118 javaLibsSdkMemberType = &librarySdkMemberType{
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000119 android.SdkMemberTypeBase{
Paul Duffinf5c0a9c2020-02-28 14:39:53 +0000120 PropertyName: "java_libs",
121 },
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000122 exportImplementationClassesJar,
123 sdkSnapshotFilePathForJar,
124 copyEverythingToSnapshot,
Paul Duffin2da04242021-04-23 19:43:28 +0100125 }
Paul Duffin1b82e6a2019-12-03 18:06:47 +0000126
Paul Duffin13648912022-07-15 13:12:35 +0000127 snapshotRequiresImplementationJar = func(ctx android.SdkMemberContext) bool {
128 // In the S build the build will break if updatable-media does not provide a full implementation
129 // jar. That issue was fixed in Tiramisu by b/229932396.
130 if ctx.IsTargetBuildBeforeTiramisu() && ctx.Name() == "updatable-media" {
131 return true
132 }
133
134 return false
135 }
136
Paul Duffin2da04242021-04-23 19:43:28 +0100137 // Supports adding java boot libraries to module_exports and sdk.
Paul Duffindb170e42020-12-08 17:48:25 +0000138 //
139 // The build has some implicit dependencies (via the boot jars configuration) on a number of
140 // modules, e.g. core-oj, apache-xml, that are part of the java boot class path and which are
141 // provided by mainline modules (e.g. art, conscrypt, runtime-i18n) but which are not otherwise
142 // used outside those mainline modules.
143 //
144 // As they are not needed outside the mainline modules adding them to the sdk/module-exports as
145 // either java_libs, or java_header_libs would end up exporting more information than was strictly
146 // necessary. The java_boot_libs property to allow those modules to be exported as part of the
147 // sdk/module_exports without exposing any unnecessary information.
Paul Duffin2da04242021-04-23 19:43:28 +0100148 javaBootLibsSdkMemberType = &librarySdkMemberType{
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000149 android.SdkMemberTypeBase{
Paul Duffindb170e42020-12-08 17:48:25 +0000150 PropertyName: "java_boot_libs",
151 SupportsSdk: true,
152 },
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000153 func(ctx android.SdkMemberContext, j *Library) android.Path {
Paul Duffin13648912022-07-15 13:12:35 +0000154 if snapshotRequiresImplementationJar(ctx) {
155 return exportImplementationClassesJar(ctx, j)
156 }
157
Paul Duffin5c211452021-07-15 12:42:44 +0100158 // Java boot libs are only provided in the SDK to provide access to their dex implementation
159 // jar for use by dexpreopting and boot jars package check. They do not need to provide an
160 // actual implementation jar but the java_import will need a file that exists so just copy an
161 // empty file. Any attempt to use that file as a jar will cause a build error.
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000162 return ctx.SnapshotBuilder().EmptyFile()
Paul Duffin5c211452021-07-15 12:42:44 +0100163 },
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000164 func(ctx android.SdkMemberContext, osPrefix, name string) string {
Paul Duffin13648912022-07-15 13:12:35 +0000165 if snapshotRequiresImplementationJar(ctx) {
166 return sdkSnapshotFilePathForJar(ctx, osPrefix, name)
167 }
168
Paul Duffin5c211452021-07-15 12:42:44 +0100169 // Create a special name for the implementation jar to try and provide some useful information
170 // to a developer that attempts to compile against this.
171 // TODO(b/175714559): Provide a proper error message in Soong not ninja.
172 return filepath.Join(osPrefix, "java_boot_libs", "snapshot", "jars", "are", "invalid", name+jarFileSuffix)
173 },
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000174 onlyCopyJarToSnapshot,
Paul Duffin2da04242021-04-23 19:43:28 +0100175 }
Paul Duffindb170e42020-12-08 17:48:25 +0000176
Jiakai Zhangea180332021-09-26 08:58:02 +0000177 // Supports adding java systemserver libraries to module_exports and sdk.
178 //
179 // The build has some implicit dependencies (via the systemserver jars configuration) on a number
180 // of modules that are part of the java systemserver classpath and which are provided by mainline
181 // modules but which are not otherwise used outside those mainline modules.
182 //
183 // As they are not needed outside the mainline modules adding them to the sdk/module-exports as
184 // either java_libs, or java_header_libs would end up exporting more information than was strictly
185 // necessary. The java_systemserver_libs property to allow those modules to be exported as part of
186 // the sdk/module_exports without exposing any unnecessary information.
187 javaSystemserverLibsSdkMemberType = &librarySdkMemberType{
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000188 android.SdkMemberTypeBase{
Jiakai Zhangea180332021-09-26 08:58:02 +0000189 PropertyName: "java_systemserver_libs",
190 SupportsSdk: true,
Paul Duffinf861df72022-07-01 15:56:06 +0000191
192 // This was only added in Tiramisu.
193 SupportedBuildReleaseSpecification: "Tiramisu+",
Jiakai Zhangea180332021-09-26 08:58:02 +0000194 },
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000195 func(ctx android.SdkMemberContext, j *Library) android.Path {
Jiakai Zhangea180332021-09-26 08:58:02 +0000196 // Java systemserver libs are only provided in the SDK to provide access to their dex
197 // implementation jar for use by dexpreopting. They do not need to provide an actual
198 // implementation jar but the java_import will need a file that exists so just copy an empty
199 // file. Any attempt to use that file as a jar will cause a build error.
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000200 return ctx.SnapshotBuilder().EmptyFile()
Jiakai Zhangea180332021-09-26 08:58:02 +0000201 },
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000202 func(_ android.SdkMemberContext, osPrefix, name string) string {
Jiakai Zhangea180332021-09-26 08:58:02 +0000203 // Create a special name for the implementation jar to try and provide some useful information
204 // to a developer that attempts to compile against this.
205 // TODO(b/175714559): Provide a proper error message in Soong not ninja.
206 return filepath.Join(osPrefix, "java_systemserver_libs", "snapshot", "jars", "are", "invalid", name+jarFileSuffix)
207 },
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000208 onlyCopyJarToSnapshot,
Jiakai Zhangea180332021-09-26 08:58:02 +0000209 }
210
Paul Duffin2da04242021-04-23 19:43:28 +0100211 // Supports adding java test libraries to module_exports but not sdk.
212 javaTestSdkMemberType = &testSdkMemberType{
Paul Duffin1b82e6a2019-12-03 18:06:47 +0000213 SdkMemberTypeBase: android.SdkMemberTypeBase{
214 PropertyName: "java_tests",
215 },
Paul Duffin2da04242021-04-23 19:43:28 +0100216 }
Zi Wangca65b402022-10-10 13:45:06 -0700217
218 // Rule for generating device binary default wrapper
219 deviceBinaryWrapper = pctx.StaticRule("deviceBinaryWrapper", blueprint.RuleParams{
220 Command: `echo -e '#!/system/bin/sh\n` +
221 `export CLASSPATH=/system/framework/$jar_name\n` +
222 `exec app_process /$partition/bin $main_class "$$@"'> ${out}`,
223 Description: "Generating device binary wrapper ${jar_name}",
224 }, "jar_name", "partition", "main_class")
Paul Duffin2da04242021-04-23 19:43:28 +0100225)
Jeongik Cha538c0d02019-07-11 15:54:27 +0900226
Colin Crossdcf71b22021-02-01 13:59:03 -0800227// JavaInfo contains information about a java module for use by modules that depend on it.
228type JavaInfo struct {
229 // HeaderJars is a list of jars that can be passed as the javac classpath in order to link
230 // against this module. If empty, ImplementationJars should be used instead.
231 HeaderJars android.Paths
232
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500233 // set of header jars for all transitive libs deps
234 TransitiveLibsHeaderJars *android.DepSet
235
236 // set of header jars for all transitive static libs deps
237 TransitiveStaticLibsHeaderJars *android.DepSet
238
Colin Crossdcf71b22021-02-01 13:59:03 -0800239 // ImplementationAndResourceJars is a list of jars that contain the implementations of classes
240 // in the module as well as any resources included in the module.
241 ImplementationAndResourcesJars android.Paths
242
243 // ImplementationJars is a list of jars that contain the implementations of classes in the
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000244 //module.
Colin Crossdcf71b22021-02-01 13:59:03 -0800245 ImplementationJars android.Paths
246
247 // ResourceJars is a list of jars that contain the resources included in the module.
248 ResourceJars android.Paths
249
250 // AidlIncludeDirs is a list of directories that should be passed to the aidl tool when
251 // depending on this module.
252 AidlIncludeDirs android.Paths
253
254 // SrcJarArgs is a list of arguments to pass to soong_zip to package the sources of this
255 // module.
256 SrcJarArgs []string
257
258 // SrcJarDeps is a list of paths to depend on when packaging the sources of this module.
259 SrcJarDeps android.Paths
260
261 // ExportedPlugins is a list of paths that should be used as annotation processors for any
262 // module that depends on this module.
263 ExportedPlugins android.Paths
264
265 // ExportedPluginClasses is a list of classes that should be run as annotation processors for
266 // any module that depends on this module.
267 ExportedPluginClasses []string
268
269 // ExportedPluginDisableTurbine is true if this module's annotation processors generate APIs,
270 // requiring disbling turbine for any modules that depend on it.
271 ExportedPluginDisableTurbine bool
272
273 // JacocoReportClassesFile is the path to a jar containing uninstrumented classes that will be
274 // instrumented by jacoco.
275 JacocoReportClassesFile android.Path
276}
277
278var JavaInfoProvider = blueprint.NewProvider(JavaInfo{})
279
Colin Cross75ce9ec2021-02-26 16:20:32 -0800280// SyspropPublicStubInfo contains info about the sysprop public stub library that corresponds to
281// the sysprop implementation library.
282type SyspropPublicStubInfo struct {
283 // JavaInfo is the JavaInfoProvider of the sysprop public stub library that corresponds to
284 // the sysprop implementation library.
285 JavaInfo JavaInfo
286}
287
288var SyspropPublicStubInfoProvider = blueprint.NewProvider(SyspropPublicStubInfo{})
289
Paul Duffin44b481b2020-06-17 16:59:43 +0100290// Methods that need to be implemented for a module that is added to apex java_libs property.
291type ApexDependency interface {
Nan Zhanged19fc32017-10-19 13:06:22 -0700292 HeaderJars() android.Paths
Paul Duffin44b481b2020-06-17 16:59:43 +0100293 ImplementationAndResourcesJars() android.Paths
294}
295
Ulya Trafimovich31e444e2020-08-14 17:32:16 +0100296// Provides build path and install path to DEX jars.
297type UsesLibraryDependency interface {
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100298 DexJarBuildPath() OptionalDexJarPath
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +0100299 DexJarInstallPath() android.Path
Ulya Trafimovichdbf31662020-12-17 12:07:54 +0000300 ClassLoaderContexts() dexpreopt.ClassLoaderContextMap
Ulya Trafimovich31e444e2020-08-14 17:32:16 +0100301}
302
Jared Duke5979b302022-12-19 21:08:39 +0000303// Provides transitive Proguard flag files to downstream DEX jars.
304type LibraryDependency interface {
305 ExportedProguardFlagFiles() android.Paths
306}
307
Jaewoong Jung26342642021-03-17 15:56:23 -0700308// TODO(jungjw): Move this to kythe.go once it's created.
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800309type xref interface {
310 XrefJavaFiles() android.Paths
311}
312
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800313func (j *Module) XrefJavaFiles() android.Paths {
314 return j.kytheFiles
315}
316
Colin Crossbe1da472017-07-07 15:59:46 -0700317type dependencyTag struct {
318 blueprint.BaseDependencyTag
319 name string
Colin Cross65cb3142021-12-10 23:05:02 +0000320
321 // True if the dependency is relinked at runtime.
322 runtimeLinked bool
Colin Crossce564252022-01-12 11:13:32 -0800323
324 // True if the dependency is a toolchain, for example an annotation processor.
325 toolchain bool
Colin Cross2fe66872015-03-30 17:20:39 -0700326}
327
Colin Crosse9fe2942020-11-10 18:12:15 -0800328// installDependencyTag is a dependency tag that is annotated to cause the installed files of the
329// dependency to be installed when the parent module is installed.
330type installDependencyTag struct {
331 blueprint.BaseDependencyTag
332 android.InstallAlwaysNeededDependencyTag
333 name string
334}
335
Colin Cross65cb3142021-12-10 23:05:02 +0000336func (d dependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
337 if d.runtimeLinked {
338 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
Colin Crossce564252022-01-12 11:13:32 -0800339 } else if d.toolchain {
340 return []android.LicenseAnnotation{android.LicenseAnnotationToolchain}
Colin Cross65cb3142021-12-10 23:05:02 +0000341 }
342 return nil
343}
344
345var _ android.LicenseAnnotationsDependencyTag = dependencyTag{}
346
Ulya Trafimovichb5218112020-10-07 15:11:32 +0100347type usesLibraryDependencyTag struct {
348 dependencyTag
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100349 sdkVersion int // SDK version in which the library appared as a standalone library.
350 optional bool // If the dependency is optional or required.
Ulya Trafimovichb5218112020-10-07 15:11:32 +0100351}
352
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100353func makeUsesLibraryDependencyTag(sdkVersion int, optional bool) usesLibraryDependencyTag {
Ulya Trafimovichb5218112020-10-07 15:11:32 +0100354 return usesLibraryDependencyTag{
Colin Cross65cb3142021-12-10 23:05:02 +0000355 dependencyTag: dependencyTag{
356 name: fmt.Sprintf("uses-library-%d", sdkVersion),
357 runtimeLinked: true,
358 },
359 sdkVersion: sdkVersion,
360 optional: optional,
Ulya Trafimovichb5218112020-10-07 15:11:32 +0100361 }
362}
363
Jiyong Park8be103b2019-11-08 15:53:48 +0900364func IsJniDepTag(depTag blueprint.DependencyTag) bool {
Colin Crossde78d132020-10-09 18:59:49 -0700365 return depTag == jniLibTag
Jiyong Park8be103b2019-11-08 15:53:48 +0900366}
367
Colin Crossbe1da472017-07-07 15:59:46 -0700368var (
Colin Cross75ce9ec2021-02-26 16:20:32 -0800369 dataNativeBinsTag = dependencyTag{name: "dataNativeBins"}
Sam Delmericob3342ce2022-01-20 21:10:28 +0000370 dataDeviceBinsTag = dependencyTag{name: "dataDeviceBins"}
Colin Cross75ce9ec2021-02-26 16:20:32 -0800371 staticLibTag = dependencyTag{name: "staticlib"}
Colin Cross65cb3142021-12-10 23:05:02 +0000372 libTag = dependencyTag{name: "javalib", runtimeLinked: true}
Liz Kammeref28a4c2022-09-23 16:50:56 -0400373 sdkLibTag = dependencyTag{name: "sdklib", runtimeLinked: true}
Colin Cross65cb3142021-12-10 23:05:02 +0000374 java9LibTag = dependencyTag{name: "java9lib", runtimeLinked: true}
Colin Crossce564252022-01-12 11:13:32 -0800375 pluginTag = dependencyTag{name: "plugin", toolchain: true}
376 errorpronePluginTag = dependencyTag{name: "errorprone-plugin", toolchain: true}
377 exportedPluginTag = dependencyTag{name: "exported-plugin", toolchain: true}
Colin Cross65cb3142021-12-10 23:05:02 +0000378 bootClasspathTag = dependencyTag{name: "bootclasspath", runtimeLinked: true}
379 systemModulesTag = dependencyTag{name: "system modules", runtimeLinked: true}
Colin Cross75ce9ec2021-02-26 16:20:32 -0800380 frameworkResTag = dependencyTag{name: "framework-res"}
Colin Cross65cb3142021-12-10 23:05:02 +0000381 kotlinStdlibTag = dependencyTag{name: "kotlin-stdlib", runtimeLinked: true}
382 kotlinAnnotationsTag = dependencyTag{name: "kotlin-annotations", runtimeLinked: true}
Colin Crossce564252022-01-12 11:13:32 -0800383 kotlinPluginTag = dependencyTag{name: "kotlin-plugin", toolchain: true}
Colin Cross75ce9ec2021-02-26 16:20:32 -0800384 proguardRaiseTag = dependencyTag{name: "proguard-raise"}
385 certificateTag = dependencyTag{name: "certificate"}
386 instrumentationForTag = dependencyTag{name: "instrumentation_for"}
Colin Crossce564252022-01-12 11:13:32 -0800387 extraLintCheckTag = dependencyTag{name: "extra-lint-check", toolchain: true}
Colin Cross65cb3142021-12-10 23:05:02 +0000388 jniLibTag = dependencyTag{name: "jnilib", runtimeLinked: true}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500389 r8LibraryJarTag = dependencyTag{name: "r8-libraryjar", runtimeLinked: true}
Colin Cross75ce9ec2021-02-26 16:20:32 -0800390 syspropPublicStubDepTag = dependencyTag{name: "sysprop public stub"}
Jihoon Kang01e522c2023-03-14 01:09:34 +0000391 javaApiContributionTag = dependencyTag{name: "java-api-contribution"}
392 depApiSrcsTag = dependencyTag{name: "dep-api-srcs"}
Colin Cross75ce9ec2021-02-26 16:20:32 -0800393 jniInstallTag = installDependencyTag{name: "jni install"}
394 binaryInstallTag = installDependencyTag{name: "binary install"}
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100395 usesLibReqTag = makeUsesLibraryDependencyTag(dexpreopt.AnySdkVersion, false)
396 usesLibOptTag = makeUsesLibraryDependencyTag(dexpreopt.AnySdkVersion, true)
397 usesLibCompat28OptTag = makeUsesLibraryDependencyTag(28, true)
398 usesLibCompat29ReqTag = makeUsesLibraryDependencyTag(29, false)
399 usesLibCompat30OptTag = makeUsesLibraryDependencyTag(30, true)
Colin Crossbe1da472017-07-07 15:59:46 -0700400)
Colin Cross2fe66872015-03-30 17:20:39 -0700401
Jiyong Park83dc74b2020-01-14 18:38:44 +0900402func IsLibDepTag(depTag blueprint.DependencyTag) bool {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400403 return depTag == libTag || depTag == sdkLibTag
Jiyong Park83dc74b2020-01-14 18:38:44 +0900404}
405
406func IsStaticLibDepTag(depTag blueprint.DependencyTag) bool {
407 return depTag == staticLibTag
408}
409
Colin Crossfc3674a2017-09-18 17:41:52 -0700410type sdkDep struct {
Pete Gilline3d44b22020-06-29 11:28:51 +0100411 useModule, useFiles, invalidVersion bool
Colin Cross47ff2522017-10-02 14:22:08 -0700412
Colin Cross6cef4812019-10-17 14:23:50 -0700413 // The modules that will be added to the bootclasspath when targeting 1.8 or lower
414 bootclasspath []string
Paul Duffine25c6442019-10-11 13:50:28 +0100415
416 // The default system modules to use. Will be an empty string if no system
417 // modules are to be used.
Colin Cross1369cdb2017-09-29 17:58:17 -0700418 systemModules string
419
Pete Gilline3d44b22020-06-29 11:28:51 +0100420 // The modules that will be added to the classpath regardless of the Java language level targeted
421 classpath []string
422
Colin Cross6cef4812019-10-17 14:23:50 -0700423 // The modules that will be added ot the classpath when targeting 1.9 or higher
Pete Gilline3d44b22020-06-29 11:28:51 +0100424 // (normally these will be on the bootclasspath when targeting 1.8 or lower)
Colin Cross6cef4812019-10-17 14:23:50 -0700425 java9Classpath []string
426
Colin Crossa97c5d32018-03-28 14:58:31 -0700427 frameworkResModule string
428
Colin Cross86a60ae2018-05-29 14:44:55 -0700429 jars android.Paths
Colin Cross3047fa22019-04-18 10:56:44 -0700430 aidl android.OptionalPath
Paul Duffin250e6192019-06-07 10:44:37 +0100431
432 noStandardLibs, noFrameworksLibs bool
433}
434
435func (s sdkDep) hasStandardLibs() bool {
436 return !s.noStandardLibs
437}
438
439func (s sdkDep) hasFrameworkLibs() bool {
440 return !s.noStandardLibs && !s.noFrameworksLibs
Colin Cross1369cdb2017-09-29 17:58:17 -0700441}
442
Colin Crossa4f08812018-10-02 22:03:40 -0700443type jniLib struct {
Colin Cross403cc152020-07-06 14:15:24 -0700444 name string
445 path android.Path
446 target android.Target
447 coverageFile android.OptionalPath
448 unstrippedFile android.Path
Jihoon Kangf78a8902022-09-01 22:47:07 +0000449 partition string
Colin Crossa4f08812018-10-02 22:03:40 -0700450}
451
Jiyong Parkf1691d22021-03-29 20:11:58 +0900452func sdkDeps(ctx android.BottomUpMutatorContext, sdkContext android.SdkContext, d dexer) {
Liz Kammerd6c31d22020-08-05 15:40:41 -0700453 sdkDep := decodeSdkDep(ctx, sdkContext)
454 if sdkDep.useModule {
455 ctx.AddVariationDependencies(nil, bootClasspathTag, sdkDep.bootclasspath...)
456 ctx.AddVariationDependencies(nil, java9LibTag, sdkDep.java9Classpath...)
Liz Kammeref28a4c2022-09-23 16:50:56 -0400457 ctx.AddVariationDependencies(nil, sdkLibTag, sdkDep.classpath...)
Liz Kammerd6c31d22020-08-05 15:40:41 -0700458 if d.effectiveOptimizeEnabled() && sdkDep.hasStandardLibs() {
Jihoon Kangb5078312023-03-29 23:25:49 +0000459 ctx.AddVariationDependencies(nil, proguardRaiseTag,
460 android.JavaApiLibraryNames(ctx.Config(), config.LegacyCorePlatformBootclasspathLibraries)...,
461 )
Liz Kammerd6c31d22020-08-05 15:40:41 -0700462 }
463 if d.effectiveOptimizeEnabled() && sdkDep.hasFrameworkLibs() {
464 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.FrameworkLibraries...)
465 }
466 }
467 if sdkDep.systemModules != "" {
468 ctx.AddVariationDependencies(nil, systemModulesTag, sdkDep.systemModules)
469 }
470}
471
Colin Cross32f676a2017-09-06 13:41:06 -0700472type deps struct {
Colin Cross9bb9bfb2022-03-17 11:12:32 -0700473 // bootClasspath is the list of jars that form the boot classpath (generally the java.* and
474 // android.* classes) for tools that still use it. javac targeting 1.9 or higher uses
475 // systemModules and java9Classpath instead.
476 bootClasspath classpath
477
478 // classpath is the list of jars that form the classpath for javac and kotlinc rules. It
479 // contains header jars for all static and non-static dependencies.
480 classpath classpath
481
482 // dexClasspath is the list of jars that form the classpath for d8 and r8 rules. It contains
483 // header jars for all non-static dependencies. Static dependencies have already been
484 // combined into the program jar.
485 dexClasspath classpath
486
487 // java9Classpath is the list of jars that will be added to the classpath when targeting
488 // 1.9 or higher. It generally contains the android.* classes, while the java.* classes
489 // are provided by systemModules.
490 java9Classpath classpath
491
Colin Cross748b2d82020-11-19 13:52:06 -0800492 processorPath classpath
493 errorProneProcessorPath classpath
494 processorClasses []string
495 staticJars android.Paths
496 staticHeaderJars android.Paths
497 staticResourceJars android.Paths
498 aidlIncludeDirs android.Paths
499 srcs android.Paths
500 srcJars android.Paths
501 systemModules *systemModules
502 aidlPreprocess android.OptionalPath
503 kotlinStdlib android.Paths
504 kotlinAnnotations android.Paths
Colin Crossa1ff7c62021-09-17 14:11:52 -0700505 kotlinPlugins android.Paths
Colin Crossbe9cdb82019-01-21 21:37:16 -0800506
507 disableTurbine bool
Colin Cross32f676a2017-09-06 13:41:06 -0700508}
Colin Cross2fe66872015-03-30 17:20:39 -0700509
Colin Cross54250902017-12-05 09:28:08 -0800510func checkProducesJars(ctx android.ModuleContext, dep android.SourceFileProducer) {
511 for _, f := range dep.Srcs() {
512 if f.Ext() != ".jar" {
513 ctx.ModuleErrorf("genrule %q must generate files ending with .jar to be used as a libs or static_libs dependency",
514 ctx.OtherModuleName(dep.(blueprint.Module)))
515 }
516 }
517}
518
Jiyong Parkf1691d22021-03-29 20:11:58 +0900519func getJavaVersion(ctx android.ModuleContext, javaVersion string, sdkContext android.SdkContext) javaVersion {
Nan Zhang357466b2018-04-17 17:38:36 -0700520 if javaVersion != "" {
Colin Cross1e743852019-10-28 11:37:20 -0700521 return normalizeJavaVersion(ctx, javaVersion)
Colin Cross17dec172020-05-14 18:05:32 -0700522 } else if ctx.Device() {
Jiyong Park92315372021-04-02 08:45:46 +0900523 return defaultJavaLanguageVersion(ctx, sdkContext.SdkVersion(ctx))
Sorin Basca384250c2023-02-02 17:56:19 +0000524 } else {
Sorin Bascabe302732023-02-15 17:52:27 +0000525 return JAVA_VERSION_17
Nan Zhang357466b2018-04-17 17:38:36 -0700526 }
Nan Zhang357466b2018-04-17 17:38:36 -0700527}
528
Jihoon Kangff878bf2022-12-22 21:26:06 +0000529// Java version for stubs generation
530func getStubsJavaVersion() javaVersion {
531 return JAVA_VERSION_8
532}
533
Colin Cross1e743852019-10-28 11:37:20 -0700534type javaVersion int
535
536const (
537 JAVA_VERSION_UNSUPPORTED = 0
538 JAVA_VERSION_6 = 6
539 JAVA_VERSION_7 = 7
540 JAVA_VERSION_8 = 8
541 JAVA_VERSION_9 = 9
Sorin Bascac0244da2021-11-26 17:26:33 +0000542 JAVA_VERSION_11 = 11
Sorin Bascace720c32022-05-24 12:13:50 +0100543 JAVA_VERSION_17 = 17
Colin Cross1e743852019-10-28 11:37:20 -0700544)
545
546func (v javaVersion) String() string {
547 switch v {
548 case JAVA_VERSION_6:
549 return "1.6"
550 case JAVA_VERSION_7:
551 return "1.7"
552 case JAVA_VERSION_8:
553 return "1.8"
554 case JAVA_VERSION_9:
555 return "1.9"
Sorin Bascac0244da2021-11-26 17:26:33 +0000556 case JAVA_VERSION_11:
557 return "11"
Sorin Bascace720c32022-05-24 12:13:50 +0100558 case JAVA_VERSION_17:
559 return "17"
Colin Cross1e743852019-10-28 11:37:20 -0700560 default:
561 return "unsupported"
562 }
563}
564
Cole Faustd96eebf2022-06-28 14:41:27 -0700565func (v javaVersion) StringForKotlinc() string {
566 // $ ./external/kotlinc/bin/kotlinc -jvm-target foo
567 // error: unknown JVM target version: foo
568 // Supported versions: 1.6, 1.8, 9, 10, 11, 12, 13, 14, 15, 16, 17
569 switch v {
570 case JAVA_VERSION_7:
571 return "1.6"
572 case JAVA_VERSION_9:
573 return "9"
574 default:
575 return v.String()
576 }
577}
578
Colin Cross1e743852019-10-28 11:37:20 -0700579// Returns true if javac targeting this version uses system modules instead of a bootclasspath.
580func (v javaVersion) usesJavaModules() bool {
581 return v >= 9
582}
583
584func normalizeJavaVersion(ctx android.BaseModuleContext, javaVersion string) javaVersion {
Pete Gillin4e8b48a2019-07-12 13:16:17 +0100585 switch javaVersion {
586 case "1.6", "6":
Colin Cross1e743852019-10-28 11:37:20 -0700587 return JAVA_VERSION_6
Pete Gillin4e8b48a2019-07-12 13:16:17 +0100588 case "1.7", "7":
Colin Cross1e743852019-10-28 11:37:20 -0700589 return JAVA_VERSION_7
Pete Gillin4e8b48a2019-07-12 13:16:17 +0100590 case "1.8", "8":
Colin Cross1e743852019-10-28 11:37:20 -0700591 return JAVA_VERSION_8
Pete Gillin4e8b48a2019-07-12 13:16:17 +0100592 case "1.9", "9":
Colin Cross1e743852019-10-28 11:37:20 -0700593 return JAVA_VERSION_9
Sorin Bascac0244da2021-11-26 17:26:33 +0000594 case "11":
595 return JAVA_VERSION_11
Sorin Bascace720c32022-05-24 12:13:50 +0100596 case "17":
Sorin Basca5938fed2022-06-22 12:53:51 +0100597 return JAVA_VERSION_17
Sorin Bascace720c32022-05-24 12:13:50 +0100598 case "10", "12", "13", "14", "15", "16":
599 ctx.PropertyErrorf("java_version", "Java language level %s is not supported", javaVersion)
Colin Cross1e743852019-10-28 11:37:20 -0700600 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +0100601 default:
602 ctx.PropertyErrorf("java_version", "Unrecognized Java language level")
Colin Cross1e743852019-10-28 11:37:20 -0700603 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +0100604 }
605}
606
Colin Cross2fe66872015-03-30 17:20:39 -0700607//
608// Java libraries (.jar file)
609//
610
Colin Crossf506d872017-07-19 15:53:04 -0700611type Library struct {
Colin Cross46c9b8b2017-06-22 16:51:17 -0700612 Module
Colin Crossf0f2e2c2019-10-15 16:36:40 -0700613
Jared Duke5979b302022-12-19 21:08:39 +0000614 exportedProguardFlagFiles android.Paths
615
Colin Crossf0f2e2c2019-10-15 16:36:40 -0700616 InstallMixin func(ctx android.ModuleContext, installPath android.Path) (extraInstallDeps android.Paths)
Colin Cross2fe66872015-03-30 17:20:39 -0700617}
618
Jared Duke5979b302022-12-19 21:08:39 +0000619var _ LibraryDependency = (*Library)(nil)
620
621func (j *Library) ExportedProguardFlagFiles() android.Paths {
622 return j.exportedProguardFlagFiles
623}
624
Jiyong Park45bf82e2020-12-15 22:29:02 +0900625var _ android.ApexModule = (*Library)(nil)
626
satayevd604b212021-07-21 14:23:52 +0100627// Provides access to the list of permitted packages from apex boot jars.
Paul Duffine739f1e2020-05-29 11:24:51 +0100628type PermittedPackagesForUpdatableBootJars interface {
629 PermittedPackagesForUpdatableBootJars() []string
630}
631
632var _ PermittedPackagesForUpdatableBootJars = (*Library)(nil)
633
634func (j *Library) PermittedPackagesForUpdatableBootJars() []string {
635 return j.properties.Permitted_packages
636}
637
Colin Cross42be7612019-02-21 18:12:14 -0800638func shouldUncompressDex(ctx android.ModuleContext, dexpreopter *dexpreopter) bool {
Ulya Trafimovichf491dde2020-01-24 12:19:45 +0000639 // Store uncompressed (and aligned) any dex files from jars in APEXes.
Colin Cross56a83212020-09-15 18:30:11 -0700640 if apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo); !apexInfo.IsForPlatform() {
Ulya Trafimovichf491dde2020-01-24 12:19:45 +0000641 return true
642 }
643
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +0000644 // Store uncompressed (and do not strip) dex files from boot class path jars.
645 if inList(ctx.ModuleName(), ctx.Config().BootJars()) {
646 return true
647 }
648
649 // Store uncompressed dex files that are preopted on /system.
Jiakai Zhang519c5c82021-09-16 06:15:39 +0000650 if !dexpreopter.dexpreoptDisabled(ctx) && (ctx.Host() || !dexpreopter.odexOnSystemOther(ctx, dexpreopter.installPath)) {
Vladimir Markoe8b00d62018-12-21 15:54:16 +0000651 return true
652 }
Colin Cross083a2aa2019-02-06 16:37:12 -0800653 if ctx.Config().UncompressPrivAppDex() &&
654 inList(ctx.ModuleName(), ctx.Config().ModulesLoadedByPrivilegedModules()) {
655 return true
656 }
657
Colin Cross2fc72f62018-12-21 12:59:54 -0800658 return false
659}
660
Jiakai Zhang22450f22021-10-11 03:05:20 +0000661// Sets `dexer.dexProperties.Uncompress_dex` to the proper value.
662func setUncompressDex(ctx android.ModuleContext, dexpreopter *dexpreopter, dexer *dexer) {
663 if dexer.dexProperties.Uncompress_dex == nil {
664 // If the value was not force-set by the user, use reasonable default based on the module.
665 dexer.dexProperties.Uncompress_dex = proptools.BoolPtr(shouldUncompressDex(ctx, dexpreopter))
666 }
667}
668
Colin Crossf506d872017-07-19 15:53:04 -0700669func (j *Library) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000670
671 j.provideHiddenAPIPropertyInfo(ctx)
672
Jiyong Park92315372021-04-02 08:45:46 +0900673 j.sdkVersion = j.SdkVersion(ctx)
674 j.minSdkVersion = j.MinSdkVersion(ctx)
satayev0a420e72021-11-29 17:25:52 +0000675 j.maxSdkVersion = j.MaxSdkVersion(ctx)
Jiyong Park92315372021-04-02 08:45:46 +0900676
Colin Cross56a83212020-09-15 18:30:11 -0700677 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
678 if !apexInfo.IsForPlatform() {
679 j.hideApexVariantFromMake = true
680 }
681
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100682 j.checkSdkVersions(ctx)
Colin Cross61df14a2021-12-01 13:04:46 -0800683 if ctx.Device() {
684 j.dexpreopter.installPath = j.dexpreopter.getInstallPath(
685 ctx, android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar"))
686 j.dexpreopter.isSDKLibrary = j.deviceProperties.IsSDKLibrary
687 setUncompressDex(ctx, &j.dexpreopter, &j.dexer)
688 j.dexpreopter.uncompressedDex = *j.dexProperties.Uncompress_dex
689 j.classLoaderContexts = j.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
690 }
Jaewoong Junga24af3b2019-05-13 09:23:20 -0700691 j.compile(ctx, nil)
Colin Crossb7a63242015-04-16 14:09:14 -0700692
bralee1fbf4402020-05-21 10:11:59 +0800693 // Collect the module directory for IDE info in java/jdeps.go.
694 j.modulePaths = append(j.modulePaths, ctx.ModuleDir())
695
Colin Cross56a83212020-09-15 18:30:11 -0700696 exclusivelyForApex := !apexInfo.IsForPlatform()
Jiyong Park7f7766d2019-07-25 22:02:35 +0900697 if (Bool(j.properties.Installable) || ctx.Host()) && !exclusivelyForApex {
Colin Crossf0f2e2c2019-10-15 16:36:40 -0700698 var extraInstallDeps android.Paths
699 if j.InstallMixin != nil {
700 extraInstallDeps = j.InstallMixin(ctx, j.outputFile)
701 }
Colin Cross1d0eb7a2021-11-03 14:08:20 -0700702 hostDexNeeded := Bool(j.deviceProperties.Hostdex) && !ctx.Host()
703 if hostDexNeeded {
Colin Cross3108ce12021-11-10 14:38:50 -0800704 j.hostdexInstallFile = ctx.InstallFile(
705 android.PathForHostDexInstall(ctx, "framework"),
Colin Cross1d0eb7a2021-11-03 14:08:20 -0700706 j.Stem()+"-hostdex.jar", j.outputFile)
707 }
708 var installDir android.InstallPath
709 if ctx.InstallInTestcases() {
710 var archDir string
711 if !ctx.Host() {
712 archDir = ctx.DeviceConfig().DeviceArch()
713 }
714 installDir = android.PathForModuleInstall(ctx, ctx.ModuleName(), archDir)
715 } else {
716 installDir = android.PathForModuleInstall(ctx, "framework")
717 }
718 j.installFile = ctx.InstallFile(installDir, j.Stem()+".jar", j.outputFile, extraInstallDeps...)
Colin Cross2c429dc2017-08-31 16:45:16 -0700719 }
Jared Duke5979b302022-12-19 21:08:39 +0000720
721 j.exportedProguardFlagFiles = append(j.exportedProguardFlagFiles,
722 android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)...)
723 ctx.VisitDirectDeps(func(m android.Module) {
724 if lib, ok := m.(LibraryDependency); ok && ctx.OtherModuleDependencyTag(m) == staticLibTag {
725 j.exportedProguardFlagFiles = append(j.exportedProguardFlagFiles, lib.ExportedProguardFlagFiles()...)
726 }
727 })
728 j.exportedProguardFlagFiles = android.FirstUniquePaths(j.exportedProguardFlagFiles)
Colin Crossb7a63242015-04-16 14:09:14 -0700729}
730
Colin Crossf506d872017-07-19 15:53:04 -0700731func (j *Library) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross46c9b8b2017-06-22 16:51:17 -0700732 j.deps(ctx)
Ulya Trafimoviche4432872021-08-18 16:57:11 +0100733 j.usesLibrary.deps(ctx, false)
Colin Cross46c9b8b2017-06-22 16:51:17 -0700734}
735
Paul Duffin0e0cf1d2019-11-12 19:39:25 +0000736const (
Paul Duffin1b82e6a2019-12-03 18:06:47 +0000737 aidlIncludeDir = "aidl"
738 javaDir = "java"
739 jarFileSuffix = ".jar"
740 testConfigSuffix = "-AndroidTest.xml"
Paul Duffin0e0cf1d2019-11-12 19:39:25 +0000741)
742
Paul Duffina0dbf432019-12-05 11:25:53 +0000743// path to the jar file of a java library. Relative to <sdk_root>/<api_dir>
Paul Duffin13648912022-07-15 13:12:35 +0000744func sdkSnapshotFilePathForJar(_ android.SdkMemberContext, osPrefix, name string) string {
Paul Duffina04c1072020-03-02 10:16:35 +0000745 return sdkSnapshotFilePathForMember(osPrefix, name, jarFileSuffix)
Paul Duffin1b82e6a2019-12-03 18:06:47 +0000746}
747
Paul Duffina04c1072020-03-02 10:16:35 +0000748func sdkSnapshotFilePathForMember(osPrefix, name string, suffix string) string {
749 return filepath.Join(javaDir, osPrefix, name+suffix)
Paul Duffin0e0cf1d2019-11-12 19:39:25 +0000750}
751
Paul Duffin13879572019-11-28 14:31:38 +0000752type librarySdkMemberType struct {
Paul Duffin255f18e2019-12-13 11:22:16 +0000753 android.SdkMemberTypeBase
Paul Duffinf5c0a9c2020-02-28 14:39:53 +0000754
755 // Function to retrieve the appropriate output jar (implementation or header) from
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000756 // the library.
Paul Duffindb170e42020-12-08 17:48:25 +0000757 jarToExportGetter func(ctx android.SdkMemberContext, j *Library) android.Path
758
759 // Function to compute the snapshot relative path to which the named library's
760 // jar should be copied.
Paul Duffin13648912022-07-15 13:12:35 +0000761 snapshotPathGetter func(ctx android.SdkMemberContext, osPrefix, name string) string
Paul Duffindb170e42020-12-08 17:48:25 +0000762
763 // True if only the jar should be copied to the snapshot, false if the jar plus any additional
764 // files like aidl files should also be copied.
765 onlyCopyJarToSnapshot bool
Paul Duffin13879572019-11-28 14:31:38 +0000766}
767
Paul Duffindb170e42020-12-08 17:48:25 +0000768const (
769 onlyCopyJarToSnapshot = true
770 copyEverythingToSnapshot = false
771)
772
Paul Duffin296701e2021-07-14 10:29:36 +0100773func (mt *librarySdkMemberType) AddDependencies(ctx android.SdkDependencyContext, dependencyTag blueprint.DependencyTag, names []string) {
774 ctx.AddVariationDependencies(nil, dependencyTag, names...)
Paul Duffin13879572019-11-28 14:31:38 +0000775}
776
777func (mt *librarySdkMemberType) IsInstance(module android.Module) bool {
778 _, ok := module.(*Library)
779 return ok
780}
781
Paul Duffin3a4eb502020-03-19 16:11:18 +0000782func (mt *librarySdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
783 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_import")
Paul Duffin14eb4672020-03-02 11:33:02 +0000784}
Paul Duffina0dbf432019-12-05 11:25:53 +0000785
Paul Duffin14eb4672020-03-02 11:33:02 +0000786func (mt *librarySdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
Paul Duffina551a1c2020-03-17 21:04:24 +0000787 return &librarySdkMemberProperties{}
Paul Duffin14eb4672020-03-02 11:33:02 +0000788}
789
790type librarySdkMemberProperties struct {
791 android.SdkMemberPropertiesBase
792
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000793 JarToExport android.Path `android:"arch_variant"`
Paul Duffina551a1c2020-03-17 21:04:24 +0000794 AidlIncludeDirs android.Paths
Paul Duffin869de142021-07-15 14:14:41 +0100795
796 // The list of permitted packages that need to be passed to the prebuilts as they are used to
797 // create the updatable-bcp-packages.txt file.
798 PermittedPackages []string
Paul Duffinbb638eb2022-11-26 13:36:38 +0000799
800 // The value of the min_sdk_version property, translated into a number where possible.
801 MinSdkVersion *string `supported_build_releases:"Tiramisu+"`
Jiakai Zhang9c4dc192023-02-09 00:09:24 +0800802
803 DexPreoptProfileGuided *bool `supported_build_releases:"UpsideDownCake+"`
Paul Duffin14eb4672020-03-02 11:33:02 +0000804}
805
Paul Duffin3a4eb502020-03-19 16:11:18 +0000806func (p *librarySdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffin13879572019-11-28 14:31:38 +0000807 j := variant.(*Library)
808
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000809 p.JarToExport = ctx.MemberType().(*librarySdkMemberType).jarToExportGetter(ctx, j)
Paul Duffindb170e42020-12-08 17:48:25 +0000810
Paul Duffina551a1c2020-03-17 21:04:24 +0000811 p.AidlIncludeDirs = j.AidlIncludeDirs()
Paul Duffin869de142021-07-15 14:14:41 +0100812
813 p.PermittedPackages = j.PermittedPackagesForUpdatableBootJars()
Paul Duffinbb638eb2022-11-26 13:36:38 +0000814
815 // If the min_sdk_version was set then add the canonical representation of the API level to the
816 // snapshot.
817 if j.deviceProperties.Min_sdk_version != nil {
Cole Faust34867402023-04-28 12:32:27 -0700818 canonical, err := android.ReplaceFinalizedCodenames(ctx.SdkModuleContext().Config(), j.minSdkVersion.String())
819 if err != nil {
820 ctx.ModuleErrorf("%s", err)
821 }
Paul Duffinbb638eb2022-11-26 13:36:38 +0000822 p.MinSdkVersion = proptools.StringPtr(canonical)
823 }
Jiakai Zhang9c4dc192023-02-09 00:09:24 +0800824
825 if j.dexpreopter.dexpreoptProperties.Dex_preopt_result.Profile_guided {
826 p.DexPreoptProfileGuided = proptools.BoolPtr(true)
827 }
Paul Duffin14eb4672020-03-02 11:33:02 +0000828}
Paul Duffin0e0cf1d2019-11-12 19:39:25 +0000829
Paul Duffin3a4eb502020-03-19 16:11:18 +0000830func (p *librarySdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffina551a1c2020-03-17 21:04:24 +0000831 builder := ctx.SnapshotBuilder()
Paul Duffin3a4eb502020-03-19 16:11:18 +0000832
Paul Duffindb170e42020-12-08 17:48:25 +0000833 memberType := ctx.MemberType().(*librarySdkMemberType)
834
Paul Duffina551a1c2020-03-17 21:04:24 +0000835 exportedJar := p.JarToExport
836 if exportedJar != nil {
Paul Duffindb170e42020-12-08 17:48:25 +0000837 // Delegate the creation of the snapshot relative path to the member type.
Paul Duffin13648912022-07-15 13:12:35 +0000838 snapshotRelativeJavaLibPath := memberType.snapshotPathGetter(ctx, p.OsPrefix(), ctx.Name())
Paul Duffindb170e42020-12-08 17:48:25 +0000839
840 // Copy the exported jar to the snapshot.
Paul Duffin14eb4672020-03-02 11:33:02 +0000841 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
842
Paul Duffina551a1c2020-03-17 21:04:24 +0000843 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
844 }
845
Paul Duffinbb638eb2022-11-26 13:36:38 +0000846 if p.MinSdkVersion != nil {
847 propertySet.AddProperty("min_sdk_version", *p.MinSdkVersion)
848 }
849
Paul Duffin869de142021-07-15 14:14:41 +0100850 if len(p.PermittedPackages) > 0 {
851 propertySet.AddProperty("permitted_packages", p.PermittedPackages)
852 }
853
Jiakai Zhang9c4dc192023-02-09 00:09:24 +0800854 dexPreoptSet := propertySet.AddPropertySet("dex_preopt")
855 if p.DexPreoptProfileGuided != nil {
856 dexPreoptSet.AddProperty("profile_guided", proptools.Bool(p.DexPreoptProfileGuided))
857 }
858
Paul Duffindb170e42020-12-08 17:48:25 +0000859 // Do not copy anything else to the snapshot.
860 if memberType.onlyCopyJarToSnapshot {
861 return
862 }
863
Paul Duffina551a1c2020-03-17 21:04:24 +0000864 aidlIncludeDirs := p.AidlIncludeDirs
865 if len(aidlIncludeDirs) != 0 {
866 sdkModuleContext := ctx.SdkModuleContext()
867 for _, dir := range aidlIncludeDirs {
Paul Duffin14eb4672020-03-02 11:33:02 +0000868 // TODO(jiyong): copy parcelable declarations only
869 aidlFiles, _ := sdkModuleContext.GlobWithDeps(dir.String()+"/**/*.aidl", nil)
870 for _, file := range aidlFiles {
871 builder.CopyToSnapshot(android.PathForSource(sdkModuleContext, file), filepath.Join(aidlIncludeDir, file))
872 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +0000873 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +0000874
Paul Duffina551a1c2020-03-17 21:04:24 +0000875 // TODO(b/151933053) - add aidl include dirs property
Paul Duffin14eb4672020-03-02 11:33:02 +0000876 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +0000877}
878
Colin Cross1b16b0e2019-02-12 14:41:32 -0800879// java_library builds and links sources into a `.jar` file for the device, and possibly for the host as well.
880//
881// By default, a java_library has a single variant that produces a `.jar` file containing `.class` files that were
882// compiled against the device bootclasspath. This jar is not suitable for installing on a device, but can be used
883// as a `static_libs` dependency of another module.
884//
885// Specifying `installable: true` will product a `.jar` file containing `classes.dex` files, suitable for installing on
886// a device.
887//
888// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
889// compiled against the host bootclasspath.
Colin Cross9ae1b922018-06-26 17:59:05 -0700890func LibraryFactory() android.Module {
891 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -0700892
Colin Crossce6734e2020-06-15 16:09:53 -0700893 module.addHostAndDeviceProperties()
Colin Cross2fe66872015-03-30 17:20:39 -0700894
Paul Duffin71b33cc2021-06-23 11:39:47 +0100895 module.initModuleAndImport(module)
Paul Duffin859fe962020-05-15 10:20:31 +0100896
Jiyong Park7f7766d2019-07-25 22:02:35 +0900897 android.InitApexModule(module)
Wei Libafb6d62021-12-10 03:14:59 -0800898 android.InitBazelModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +0900899 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross9ae1b922018-06-26 17:59:05 -0700900 return module
Colin Cross2fe66872015-03-30 17:20:39 -0700901}
902
Colin Cross1b16b0e2019-02-12 14:41:32 -0800903// java_library_static is an obsolete alias for java_library.
904func LibraryStaticFactory() android.Module {
905 return LibraryFactory()
906}
907
908// java_library_host builds and links sources into a `.jar` file for the host.
909//
910// A java_library_host has a single variant that produces a `.jar` file containing `.class` files that were
911// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -0700912func LibraryHostFactory() android.Module {
913 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -0700914
Colin Crossce6734e2020-06-15 16:09:53 -0700915 module.addHostProperties()
Colin Cross36242852017-06-23 15:06:31 -0700916
Colin Cross9ae1b922018-06-26 17:59:05 -0700917 module.Module.properties.Installable = proptools.BoolPtr(true)
918
Jiyong Park7f7766d2019-07-25 22:02:35 +0900919 android.InitApexModule(module)
Wei Libafb6d62021-12-10 03:14:59 -0800920 android.InitBazelModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +0900921 InitJavaModule(module, android.HostSupported)
Colin Cross36242852017-06-23 15:06:31 -0700922 return module
Colin Cross2fe66872015-03-30 17:20:39 -0700923}
924
925//
Colin Crossb628ea52018-08-14 16:42:33 -0700926// Java Tests
Colin Cross05638fc2018-04-09 18:40:24 -0700927//
928
Dan Shi95d19422020-08-15 12:24:26 -0700929// Test option struct.
930type TestOptions struct {
Zhenhuang Wang0ac5a432022-08-12 18:49:20 +0800931 android.CommonTestOptions
932
Dan Shi95d19422020-08-15 12:24:26 -0700933 // a list of extra test configuration files that should be installed with the module.
934 Extra_test_configs []string `android:"path,arch_variant"`
Cole Faust21680542022-12-07 18:18:37 -0800935
936 // Extra <option> tags to add to the auto generated test xml file. The "key"
937 // is optional in each of these.
938 Tradefed_options []tradefed.Option
Dan Shi95d19422020-08-15 12:24:26 -0700939}
940
Colin Cross05638fc2018-04-09 18:40:24 -0700941type testProperties struct {
Colin Cross05638fc2018-04-09 18:40:24 -0700942 // list of compatibility suites (for example "cts", "vts") that the module should be
943 // installed into.
944 Test_suites []string `android:"arch_variant"`
Julien Despreze146e392018-08-02 15:00:46 -0700945
946 // the name of the test configuration (for example "AndroidTest.xml") that should be
947 // installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -0800948 Test_config *string `android:"path,arch_variant"`
Colin Crossd96ca352018-08-10 16:06:24 -0700949
Jack He33338892018-09-19 02:21:28 -0700950 // the name of the test configuration template (for example "AndroidTestTemplate.xml") that
951 // should be installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -0800952 Test_config_template *string `android:"path,arch_variant"`
Jack He33338892018-09-19 02:21:28 -0700953
Colin Crossd96ca352018-08-10 16:06:24 -0700954 // list of files or filegroup modules that provide data that should be installed alongside
955 // the test
Jiyong Park2b0e4902021-02-16 06:52:39 +0900956 Data []string `android:"path"`
Dan Shi6ffaaa82019-09-26 11:41:36 -0700957
958 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
959 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
960 // explicitly.
961 Auto_gen_config *bool
easoncylee5bcff5d2020-04-30 14:57:06 +0800962
963 // Add parameterized mainline modules to auto generated test config. The options will be
964 // handled by TradeFed to do downloading and installing the specified modules on the device.
965 Test_mainline_modules []string
Dan Shi95d19422020-08-15 12:24:26 -0700966
967 // Test options.
968 Test_options TestOptions
Colin Crossf8d9c492021-01-26 11:01:43 -0800969
970 // Names of modules containing JNI libraries that should be installed alongside the test.
971 Jni_libs []string
Colin Crosscfb0f5e2021-09-24 15:47:17 -0700972
973 // Install the test into a folder named for the module in all test suites.
974 Per_testcase_directory *bool
Colin Cross05638fc2018-04-09 18:40:24 -0700975}
976
Liz Kammerdd849a82020-06-12 16:38:45 -0700977type hostTestProperties struct {
978 // list of native binary modules that should be installed alongside the test
979 Data_native_bins []string `android:"arch_variant"`
Sam Delmericob3342ce2022-01-20 21:10:28 +0000980
981 // list of device binary modules that should be installed alongside the test
Sam Delmericocc271e22022-06-01 15:45:02 +0000982 // This property only adds the first variant of the dependency
983 Data_device_bins_first []string `android:"arch_variant"`
984
985 // list of device binary modules that should be installed alongside the test
986 // This property adds 64bit AND 32bit variants of the dependency
987 Data_device_bins_both []string `android:"arch_variant"`
988
989 // list of device binary modules that should be installed alongside the test
990 // This property only adds 64bit variants of the dependency
991 Data_device_bins_64 []string `android:"arch_variant"`
992
993 // list of device binary modules that should be installed alongside the test
994 // This property adds 32bit variants of the dependency if available, or else
995 // defaults to the 64bit variant
996 Data_device_bins_prefer32 []string `android:"arch_variant"`
997
998 // list of device binary modules that should be installed alongside the test
999 // This property only adds 32bit variants of the dependency
1000 Data_device_bins_32 []string `android:"arch_variant"`
Liz Kammerdd849a82020-06-12 16:38:45 -07001001}
1002
Paul Duffin42df1442019-03-20 12:45:53 +00001003type testHelperLibraryProperties struct {
1004 // list of compatibility suites (for example "cts", "vts") that the module should be
1005 // installed into.
1006 Test_suites []string `android:"arch_variant"`
Colin Crosscfb0f5e2021-09-24 15:47:17 -07001007
1008 // Install the test into a folder named for the module in all test suites.
1009 Per_testcase_directory *bool
Paul Duffin42df1442019-03-20 12:45:53 +00001010}
1011
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001012type prebuiltTestProperties struct {
1013 // list of compatibility suites (for example "cts", "vts") that the module should be
1014 // installed into.
1015 Test_suites []string `android:"arch_variant"`
1016
1017 // the name of the test configuration (for example "AndroidTest.xml") that should be
1018 // installed with the module.
1019 Test_config *string `android:"path,arch_variant"`
1020}
1021
Colin Cross05638fc2018-04-09 18:40:24 -07001022type Test struct {
1023 Library
1024
1025 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07001026
Dan Shi95d19422020-08-15 12:24:26 -07001027 testConfig android.Path
1028 extraTestConfigs android.Paths
1029 data android.Paths
Colin Cross303e21f2018-08-07 16:49:25 -07001030}
1031
Liz Kammerdd849a82020-06-12 16:38:45 -07001032type TestHost struct {
1033 Test
1034
1035 testHostProperties hostTestProperties
1036}
1037
Paul Duffin42df1442019-03-20 12:45:53 +00001038type TestHelperLibrary struct {
1039 Library
1040
1041 testHelperLibraryProperties testHelperLibraryProperties
1042}
1043
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001044type JavaTestImport struct {
1045 Import
1046
1047 prebuiltTestProperties prebuiltTestProperties
1048
1049 testConfig android.Path
Liz Kammerd6c31d22020-08-05 15:40:41 -07001050 dexJarFile android.Path
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001051}
1052
Colin Cross24cc4be62021-11-03 14:09:41 -07001053func (j *Test) InstallInTestcases() bool {
1054 // Host java tests install into $(HOST_OUT_JAVA_LIBRARIES), and then are copied into
1055 // testcases by base_rules.mk.
1056 return !j.Host()
1057}
1058
1059func (j *TestHelperLibrary) InstallInTestcases() bool {
1060 return true
1061}
1062
1063func (j *JavaTestImport) InstallInTestcases() bool {
1064 return true
1065}
1066
Sam Delmericocc271e22022-06-01 15:45:02 +00001067func (j *TestHost) addDataDeviceBinsDeps(ctx android.BottomUpMutatorContext) {
1068 if len(j.testHostProperties.Data_device_bins_first) > 0 {
1069 deviceVariations := ctx.Config().AndroidFirstDeviceTarget.Variations()
1070 ctx.AddFarVariationDependencies(deviceVariations, dataDeviceBinsTag, j.testHostProperties.Data_device_bins_first...)
1071 }
1072
1073 var maybeAndroid32Target *android.Target
1074 var maybeAndroid64Target *android.Target
1075 android32TargetList := android.FirstTarget(ctx.Config().Targets[android.Android], "lib32")
1076 android64TargetList := android.FirstTarget(ctx.Config().Targets[android.Android], "lib64")
1077 if len(android32TargetList) > 0 {
1078 maybeAndroid32Target = &android32TargetList[0]
1079 }
1080 if len(android64TargetList) > 0 {
1081 maybeAndroid64Target = &android64TargetList[0]
1082 }
1083
1084 if len(j.testHostProperties.Data_device_bins_both) > 0 {
1085 if maybeAndroid32Target == nil && maybeAndroid64Target == nil {
1086 ctx.PropertyErrorf("data_device_bins_both", "no device targets available. Targets: %q", ctx.Config().Targets)
1087 return
1088 }
1089 if maybeAndroid32Target != nil {
1090 ctx.AddFarVariationDependencies(
1091 maybeAndroid32Target.Variations(),
1092 dataDeviceBinsTag,
1093 j.testHostProperties.Data_device_bins_both...,
1094 )
1095 }
1096 if maybeAndroid64Target != nil {
1097 ctx.AddFarVariationDependencies(
1098 maybeAndroid64Target.Variations(),
1099 dataDeviceBinsTag,
1100 j.testHostProperties.Data_device_bins_both...,
1101 )
1102 }
1103 }
1104
1105 if len(j.testHostProperties.Data_device_bins_prefer32) > 0 {
1106 if maybeAndroid32Target != nil {
1107 ctx.AddFarVariationDependencies(
1108 maybeAndroid32Target.Variations(),
1109 dataDeviceBinsTag,
1110 j.testHostProperties.Data_device_bins_prefer32...,
1111 )
1112 } else {
1113 if maybeAndroid64Target == nil {
1114 ctx.PropertyErrorf("data_device_bins_prefer32", "no device targets available. Targets: %q", ctx.Config().Targets)
1115 return
1116 }
1117 ctx.AddFarVariationDependencies(
1118 maybeAndroid64Target.Variations(),
1119 dataDeviceBinsTag,
1120 j.testHostProperties.Data_device_bins_prefer32...,
1121 )
1122 }
1123 }
1124
1125 if len(j.testHostProperties.Data_device_bins_32) > 0 {
1126 if maybeAndroid32Target == nil {
1127 ctx.PropertyErrorf("data_device_bins_32", "cannot find 32bit device target. Targets: %q", ctx.Config().Targets)
1128 return
1129 }
1130 deviceVariations := maybeAndroid32Target.Variations()
1131 ctx.AddFarVariationDependencies(deviceVariations, dataDeviceBinsTag, j.testHostProperties.Data_device_bins_32...)
1132 }
1133
1134 if len(j.testHostProperties.Data_device_bins_64) > 0 {
1135 if maybeAndroid64Target == nil {
1136 ctx.PropertyErrorf("data_device_bins_64", "cannot find 64bit device target. Targets: %q", ctx.Config().Targets)
1137 return
1138 }
1139 deviceVariations := maybeAndroid64Target.Variations()
1140 ctx.AddFarVariationDependencies(deviceVariations, dataDeviceBinsTag, j.testHostProperties.Data_device_bins_64...)
1141 }
1142}
1143
Liz Kammerdd849a82020-06-12 16:38:45 -07001144func (j *TestHost) DepsMutator(ctx android.BottomUpMutatorContext) {
1145 if len(j.testHostProperties.Data_native_bins) > 0 {
1146 for _, target := range ctx.MultiTargets() {
1147 ctx.AddVariationDependencies(target.Variations(), dataNativeBinsTag, j.testHostProperties.Data_native_bins...)
1148 }
1149 }
1150
Colin Crossf8d9c492021-01-26 11:01:43 -08001151 if len(j.testProperties.Jni_libs) > 0 {
1152 for _, target := range ctx.MultiTargets() {
1153 sharedLibVariations := append(target.Variations(), blueprint.Variation{Mutator: "link", Variation: "shared"})
1154 ctx.AddFarVariationDependencies(sharedLibVariations, jniLibTag, j.testProperties.Jni_libs...)
1155 }
1156 }
1157
Sam Delmericocc271e22022-06-01 15:45:02 +00001158 j.addDataDeviceBinsDeps(ctx)
Liz Kammerdd849a82020-06-12 16:38:45 -07001159 j.deps(ctx)
1160}
1161
Yuexi Ma627263f2021-03-04 13:47:56 -08001162func (j *TestHost) AddExtraResource(p android.Path) {
1163 j.extraResources = append(j.extraResources, p)
1164}
1165
Sam Delmericocc271e22022-06-01 15:45:02 +00001166func (j *TestHost) dataDeviceBins() []string {
1167 ret := make([]string, 0,
1168 len(j.testHostProperties.Data_device_bins_first)+
1169 len(j.testHostProperties.Data_device_bins_both)+
1170 len(j.testHostProperties.Data_device_bins_prefer32)+
1171 len(j.testHostProperties.Data_device_bins_32)+
1172 len(j.testHostProperties.Data_device_bins_64),
1173 )
1174
1175 ret = append(ret, j.testHostProperties.Data_device_bins_first...)
1176 ret = append(ret, j.testHostProperties.Data_device_bins_both...)
1177 ret = append(ret, j.testHostProperties.Data_device_bins_prefer32...)
1178 ret = append(ret, j.testHostProperties.Data_device_bins_32...)
1179 ret = append(ret, j.testHostProperties.Data_device_bins_64...)
1180
1181 return ret
1182}
1183
Sam Delmericob3342ce2022-01-20 21:10:28 +00001184func (j *TestHost) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1185 var configs []tradefed.Config
Sam Delmericocc271e22022-06-01 15:45:02 +00001186 dataDeviceBins := j.dataDeviceBins()
1187 if len(dataDeviceBins) > 0 {
Sam Delmericob3342ce2022-01-20 21:10:28 +00001188 // add Tradefed configuration to push device bins to device for testing
1189 remoteDir := filepath.Join("/data/local/tests/unrestricted/", j.Name())
1190 options := []tradefed.Option{{Name: "cleanup", Value: "true"}}
Sam Delmericocc271e22022-06-01 15:45:02 +00001191 for _, bin := range dataDeviceBins {
Sam Delmericob3342ce2022-01-20 21:10:28 +00001192 fullPath := filepath.Join(remoteDir, bin)
1193 options = append(options, tradefed.Option{Name: "push-file", Key: bin, Value: fullPath})
1194 }
Sam Delmericocc271e22022-06-01 15:45:02 +00001195 configs = append(configs, tradefed.Object{
1196 Type: "target_preparer",
1197 Class: "com.android.tradefed.targetprep.PushFilePreparer",
1198 Options: options,
1199 })
Sam Delmericob3342ce2022-01-20 21:10:28 +00001200 }
1201
1202 j.Test.generateAndroidBuildActionsWithConfig(ctx, configs)
1203}
1204
Colin Cross303e21f2018-08-07 16:49:25 -07001205func (j *Test) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Sam Delmericob3342ce2022-01-20 21:10:28 +00001206 j.generateAndroidBuildActionsWithConfig(ctx, nil)
1207}
1208
1209func (j *Test) generateAndroidBuildActionsWithConfig(ctx android.ModuleContext, configs []tradefed.Config) {
Julien Desprezb2166612021-03-05 18:08:36 +00001210 if j.testProperties.Test_options.Unit_test == nil && ctx.Host() {
1211 // TODO(b/): Clean temporary heuristic to avoid unexpected onboarding.
Julien Desprezf666b152021-03-15 13:07:53 -07001212 defaultUnitTest := !inList("tradefed", j.properties.Libs) && !inList("cts", j.testProperties.Test_suites)
Julien Desprezb2166612021-03-05 18:08:36 +00001213 j.testProperties.Test_options.Unit_test = proptools.BoolPtr(defaultUnitTest)
1214 }
Cole Faust21680542022-12-07 18:18:37 -08001215 j.testConfig = tradefed.AutoGenTestConfig(ctx, tradefed.AutoGenTestConfigOptions{
1216 TestConfigProp: j.testProperties.Test_config,
1217 TestConfigTemplateProp: j.testProperties.Test_config_template,
1218 TestSuites: j.testProperties.Test_suites,
1219 Config: configs,
1220 OptionsForAutogenerated: j.testProperties.Test_options.Tradefed_options,
1221 AutoGenConfig: j.testProperties.Auto_gen_config,
1222 UnitTest: j.testProperties.Test_options.Unit_test,
1223 DeviceTemplate: "${JavaTestConfigTemplate}",
1224 HostTemplate: "${JavaHostTestConfigTemplate}",
1225 HostUnitTestTemplate: "${JavaHostUnitTestConfigTemplate}",
1226 })
Liz Kammerdd849a82020-06-12 16:38:45 -07001227
Colin Cross8a497952019-03-05 22:25:09 -08001228 j.data = android.PathsForModuleSrc(ctx, j.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07001229
Dan Shi95d19422020-08-15 12:24:26 -07001230 j.extraTestConfigs = android.PathsForModuleSrc(ctx, j.testProperties.Test_options.Extra_test_configs)
1231
Liz Kammerdd849a82020-06-12 16:38:45 -07001232 ctx.VisitDirectDepsWithTag(dataNativeBinsTag, func(dep android.Module) {
1233 j.data = append(j.data, android.OutputFileForModule(ctx, dep, ""))
1234 })
1235
Sam Delmericob3342ce2022-01-20 21:10:28 +00001236 ctx.VisitDirectDepsWithTag(dataDeviceBinsTag, func(dep android.Module) {
1237 j.data = append(j.data, android.OutputFileForModule(ctx, dep, ""))
1238 })
1239
Colin Crossf8d9c492021-01-26 11:01:43 -08001240 ctx.VisitDirectDepsWithTag(jniLibTag, func(dep android.Module) {
1241 sharedLibInfo := ctx.OtherModuleProvider(dep, cc.SharedLibraryInfoProvider).(cc.SharedLibraryInfo)
1242 if sharedLibInfo.SharedLibrary != nil {
1243 // Copy to an intermediate output directory to append "lib[64]" to the path,
1244 // so that it's compatible with the default rpath values.
1245 var relPath string
1246 if sharedLibInfo.Target.Arch.ArchType.Multilib == "lib64" {
1247 relPath = filepath.Join("lib64", sharedLibInfo.SharedLibrary.Base())
1248 } else {
1249 relPath = filepath.Join("lib", sharedLibInfo.SharedLibrary.Base())
1250 }
1251 relocatedLib := android.PathForModuleOut(ctx, "relocated").Join(ctx, relPath)
1252 ctx.Build(pctx, android.BuildParams{
1253 Rule: android.Cp,
1254 Input: sharedLibInfo.SharedLibrary,
1255 Output: relocatedLib,
1256 })
1257 j.data = append(j.data, relocatedLib)
1258 } else {
1259 ctx.PropertyErrorf("jni_libs", "%q of type %q is not supported", dep.Name(), ctx.OtherModuleType(dep))
1260 }
1261 })
1262
Colin Cross303e21f2018-08-07 16:49:25 -07001263 j.Library.GenerateAndroidBuildActions(ctx)
Colin Cross05638fc2018-04-09 18:40:24 -07001264}
1265
Paul Duffin42df1442019-03-20 12:45:53 +00001266func (j *TestHelperLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1267 j.Library.GenerateAndroidBuildActions(ctx)
1268}
1269
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001270func (j *JavaTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Cole Faust21680542022-12-07 18:18:37 -08001271 j.testConfig = tradefed.AutoGenTestConfig(ctx, tradefed.AutoGenTestConfigOptions{
1272 TestConfigProp: j.prebuiltTestProperties.Test_config,
1273 TestSuites: j.prebuiltTestProperties.Test_suites,
1274 DeviceTemplate: "${JavaTestConfigTemplate}",
1275 HostTemplate: "${JavaHostTestConfigTemplate}",
1276 HostUnitTestTemplate: "${JavaHostUnitTestConfigTemplate}",
1277 })
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001278
1279 j.Import.GenerateAndroidBuildActions(ctx)
1280}
1281
1282type testSdkMemberType struct {
1283 android.SdkMemberTypeBase
1284}
1285
Paul Duffin296701e2021-07-14 10:29:36 +01001286func (mt *testSdkMemberType) AddDependencies(ctx android.SdkDependencyContext, dependencyTag blueprint.DependencyTag, names []string) {
1287 ctx.AddVariationDependencies(nil, dependencyTag, names...)
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001288}
1289
1290func (mt *testSdkMemberType) IsInstance(module android.Module) bool {
1291 _, ok := module.(*Test)
1292 return ok
1293}
1294
Paul Duffin3a4eb502020-03-19 16:11:18 +00001295func (mt *testSdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
1296 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_test_import")
Paul Duffin14eb4672020-03-02 11:33:02 +00001297}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001298
Paul Duffin14eb4672020-03-02 11:33:02 +00001299func (mt *testSdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
1300 return &testSdkMemberProperties{}
1301}
1302
1303type testSdkMemberProperties struct {
1304 android.SdkMemberPropertiesBase
1305
Paul Duffina551a1c2020-03-17 21:04:24 +00001306 JarToExport android.Path
1307 TestConfig android.Path
Paul Duffin14eb4672020-03-02 11:33:02 +00001308}
1309
Paul Duffin3a4eb502020-03-19 16:11:18 +00001310func (p *testSdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffin14eb4672020-03-02 11:33:02 +00001311 test := variant.(*Test)
1312
1313 implementationJars := test.ImplementationJars()
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001314 if len(implementationJars) != 1 {
Paul Duffin14eb4672020-03-02 11:33:02 +00001315 panic(fmt.Errorf("there must be only one implementation jar from %q", test.Name()))
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001316 }
1317
Paul Duffina551a1c2020-03-17 21:04:24 +00001318 p.JarToExport = implementationJars[0]
1319 p.TestConfig = test.testConfig
Paul Duffin14eb4672020-03-02 11:33:02 +00001320}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001321
Paul Duffin3a4eb502020-03-19 16:11:18 +00001322func (p *testSdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffina551a1c2020-03-17 21:04:24 +00001323 builder := ctx.SnapshotBuilder()
Paul Duffin3a4eb502020-03-19 16:11:18 +00001324
Paul Duffina551a1c2020-03-17 21:04:24 +00001325 exportedJar := p.JarToExport
1326 if exportedJar != nil {
Paul Duffin13648912022-07-15 13:12:35 +00001327 snapshotRelativeJavaLibPath := sdkSnapshotFilePathForJar(ctx, p.OsPrefix(), ctx.Name())
Paul Duffina551a1c2020-03-17 21:04:24 +00001328 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
Paul Duffin14eb4672020-03-02 11:33:02 +00001329
1330 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
Paul Duffina551a1c2020-03-17 21:04:24 +00001331 }
1332
1333 testConfig := p.TestConfig
1334 if testConfig != nil {
1335 snapshotRelativeTestConfigPath := sdkSnapshotFilePathForMember(p.OsPrefix(), ctx.Name(), testConfigSuffix)
1336 builder.CopyToSnapshot(testConfig, snapshotRelativeTestConfigPath)
Paul Duffin14eb4672020-03-02 11:33:02 +00001337 propertySet.AddProperty("test_config", snapshotRelativeTestConfigPath)
1338 }
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001339}
1340
Colin Cross1b16b0e2019-02-12 14:41:32 -08001341// java_test builds a and links sources into a `.jar` file for the device, and possibly for the host as well, and
1342// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
1343//
1344// By default, a java_test has a single variant that produces a `.jar` file containing `classes.dex` files that were
1345// compiled against the device bootclasspath.
1346//
1347// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
1348// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07001349func TestFactory() android.Module {
1350 module := &Test{}
1351
Colin Crossce6734e2020-06-15 16:09:53 -07001352 module.addHostAndDeviceProperties()
1353 module.AddProperties(&module.testProperties)
Colin Cross05638fc2018-04-09 18:40:24 -07001354
Colin Cross9ae1b922018-06-26 17:59:05 -07001355 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse3026872019-01-05 22:30:13 -08001356 module.Module.dexpreopter.isTest = true
Cole Faustd57e8b22022-08-11 11:59:04 -07001357 module.Module.linter.properties.Lint.Test = proptools.BoolPtr(true)
Colin Cross9ae1b922018-06-26 17:59:05 -07001358
Colin Cross05638fc2018-04-09 18:40:24 -07001359 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07001360 return module
1361}
1362
Paul Duffin42df1442019-03-20 12:45:53 +00001363// java_test_helper_library creates a java library and makes sure that it is added to the appropriate test suite.
1364func TestHelperLibraryFactory() android.Module {
1365 module := &TestHelperLibrary{}
1366
Colin Crossce6734e2020-06-15 16:09:53 -07001367 module.addHostAndDeviceProperties()
1368 module.AddProperties(&module.testHelperLibraryProperties)
Paul Duffin42df1442019-03-20 12:45:53 +00001369
Colin Cross9a4abed2019-04-24 13:19:28 -07001370 module.Module.properties.Installable = proptools.BoolPtr(true)
1371 module.Module.dexpreopter.isTest = true
Cole Faustd57e8b22022-08-11 11:59:04 -07001372 module.Module.linter.properties.Lint.Test = proptools.BoolPtr(true)
Colin Cross9a4abed2019-04-24 13:19:28 -07001373
Paul Duffin42df1442019-03-20 12:45:53 +00001374 InitJavaModule(module, android.HostAndDeviceSupported)
1375 return module
1376}
1377
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001378// java_test_import imports one or more `.jar` files into the build graph as if they were built by a java_test module
1379// and makes sure that it is added to the appropriate test suite.
1380//
1381// By default, a java_test_import has a single variant that expects a `.jar` file containing `.class` files that were
1382// compiled against an Android classpath.
1383//
1384// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
1385// for host modules.
1386func JavaTestImportFactory() android.Module {
1387 module := &JavaTestImport{}
1388
1389 module.AddProperties(
1390 &module.Import.properties,
1391 &module.prebuiltTestProperties)
1392
1393 module.Import.properties.Installable = proptools.BoolPtr(true)
1394
1395 android.InitPrebuiltModule(module, &module.properties.Jars)
1396 android.InitApexModule(module)
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001397 InitJavaModule(module, android.HostAndDeviceSupported)
1398 return module
1399}
1400
Colin Cross1b16b0e2019-02-12 14:41:32 -08001401// java_test_host builds a and links sources into a `.jar` file for the host, and creates an `AndroidTest.xml` file to
1402// allow running the test with `atest` or a `TEST_MAPPING` file.
1403//
1404// A java_test_host has a single variant that produces a `.jar` file containing `.class` files that were
1405// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07001406func TestHostFactory() android.Module {
Liz Kammerdd849a82020-06-12 16:38:45 -07001407 module := &TestHost{}
Colin Cross05638fc2018-04-09 18:40:24 -07001408
Colin Crossce6734e2020-06-15 16:09:53 -07001409 module.addHostProperties()
1410 module.AddProperties(&module.testProperties)
Liz Kammerdd849a82020-06-12 16:38:45 -07001411 module.AddProperties(&module.testHostProperties)
Colin Cross05638fc2018-04-09 18:40:24 -07001412
Yuexi Ma627263f2021-03-04 13:47:56 -08001413 InitTestHost(
1414 module,
1415 proptools.BoolPtr(true),
1416 nil,
1417 nil)
Colin Cross9ae1b922018-06-26 17:59:05 -07001418
Zi Wang65b36722023-05-23 15:18:33 -07001419 android.InitBazelModule(module)
1420
Liz Kammerdd849a82020-06-12 16:38:45 -07001421 InitJavaModuleMultiTargets(module, android.HostSupported)
Julien Desprezb2166612021-03-05 18:08:36 +00001422
Colin Cross05638fc2018-04-09 18:40:24 -07001423 return module
1424}
1425
Yuexi Ma627263f2021-03-04 13:47:56 -08001426func InitTestHost(th *TestHost, installable *bool, testSuites []string, autoGenConfig *bool) {
1427 th.properties.Installable = installable
1428 th.testProperties.Auto_gen_config = autoGenConfig
1429 th.testProperties.Test_suites = testSuites
1430}
1431
Colin Cross05638fc2018-04-09 18:40:24 -07001432//
Colin Cross2fe66872015-03-30 17:20:39 -07001433// Java Binaries (.jar file plus wrapper script)
1434//
1435
Colin Crossf506d872017-07-19 15:53:04 -07001436type binaryProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -07001437 // installable script to execute the resulting jar
Dan Willemsen8e6b3712021-09-20 23:11:24 -07001438 Wrapper *string `android:"path,arch_variant"`
Colin Cross094054a2018-10-17 15:10:48 -07001439
1440 // Name of the class containing main to be inserted into the manifest as Main-Class.
1441 Main_class *string
Colin Cross89226d92020-10-09 19:00:54 -07001442
1443 // Names of modules containing JNI libraries that should be installed alongside the host
1444 // variant of the binary.
Dan Willemsen8e6b3712021-09-20 23:11:24 -07001445 Jni_libs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -07001446}
1447
Colin Crossf506d872017-07-19 15:53:04 -07001448type Binary struct {
1449 Library
Colin Cross2fe66872015-03-30 17:20:39 -07001450
Colin Crossf506d872017-07-19 15:53:04 -07001451 binaryProperties binaryProperties
Colin Cross10a03492017-08-10 17:09:43 -07001452
Colin Cross6b4a32d2017-12-05 13:42:45 -08001453 isWrapperVariant bool
1454
Colin Crossc3315992017-12-08 19:12:36 -08001455 wrapperFile android.Path
Colin Cross70dda7e2019-10-01 22:05:35 -07001456 binaryFile android.InstallPath
Colin Cross2fe66872015-03-30 17:20:39 -07001457}
1458
Alex Light24237172017-10-26 09:46:21 -07001459func (j *Binary) HostToolPath() android.OptionalPath {
1460 return android.OptionalPathForPath(j.binaryFile)
1461}
1462
Colin Crossf506d872017-07-19 15:53:04 -07001463func (j *Binary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08001464 if ctx.Arch().ArchType == android.Common {
1465 // Compile the jar
Colin Cross094054a2018-10-17 15:10:48 -07001466 if j.binaryProperties.Main_class != nil {
1467 if j.properties.Manifest != nil {
1468 ctx.PropertyErrorf("main_class", "main_class cannot be used when manifest is set")
1469 }
1470 manifestFile := android.PathForModuleOut(ctx, "manifest.txt")
1471 GenerateMainClassManifest(ctx, manifestFile, String(j.binaryProperties.Main_class))
1472 j.overrideManifest = android.OptionalPathForPath(manifestFile)
1473 }
1474
Colin Cross6b4a32d2017-12-05 13:42:45 -08001475 j.Library.GenerateAndroidBuildActions(ctx)
Nan Zhang3c807db2017-11-03 14:53:31 -07001476 } else {
Colin Cross6b4a32d2017-12-05 13:42:45 -08001477 // Handle the binary wrapper
1478 j.isWrapperVariant = true
1479
Colin Cross366938f2017-12-11 16:29:02 -08001480 if j.binaryProperties.Wrapper != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001481 j.wrapperFile = android.PathForModuleSrc(ctx, *j.binaryProperties.Wrapper)
Colin Cross6b4a32d2017-12-05 13:42:45 -08001482 } else {
Dan Willemsen8e6b3712021-09-20 23:11:24 -07001483 if ctx.Windows() {
1484 ctx.PropertyErrorf("wrapper", "wrapper is required for Windows")
1485 }
1486
Zi Wangca65b402022-10-10 13:45:06 -07001487 if ctx.Device() {
1488 // device binary should have a main_class property if it does not
1489 // have a specific wrapper, so that a default wrapper can
1490 // be generated for it.
1491 if j.binaryProperties.Main_class == nil {
1492 ctx.PropertyErrorf("main_class", "main_class property "+
1493 "is required for device binary if no default wrapper is assigned")
1494 } else {
1495 wrapper := android.PathForModuleOut(ctx, ctx.ModuleName()+".sh")
1496 jarName := j.Stem() + ".jar"
1497 partition := j.PartitionTag(ctx.DeviceConfig())
1498 ctx.Build(pctx, android.BuildParams{
1499 Rule: deviceBinaryWrapper,
1500 Output: wrapper,
1501 Args: map[string]string{
1502 "jar_name": jarName,
1503 "partition": partition,
1504 "main_class": String(j.binaryProperties.Main_class),
1505 },
1506 })
1507 j.wrapperFile = wrapper
1508 }
1509 } else {
1510 j.wrapperFile = android.PathForSource(ctx, "build/soong/scripts/jar-wrapper.sh")
1511 }
Colin Cross6b4a32d2017-12-05 13:42:45 -08001512 }
1513
Dan Willemsen8e6b3712021-09-20 23:11:24 -07001514 ext := ""
1515 if ctx.Windows() {
1516 ext = ".bat"
1517 }
1518
Colin Crossc179ea62020-10-09 10:54:15 -07001519 // The host installation rules make the installed wrapper depend on all the dependencies
Colin Cross89226d92020-10-09 19:00:54 -07001520 // of the wrapper variant, which will include the common variant's jar file and any JNI
1521 // libraries. This is verified by TestBinary.
Colin Cross6b4a32d2017-12-05 13:42:45 -08001522 j.binaryFile = ctx.InstallExecutable(android.PathForModuleInstall(ctx, "bin"),
Dan Willemsen8e6b3712021-09-20 23:11:24 -07001523 ctx.ModuleName()+ext, j.wrapperFile)
1524 }
Colin Cross2fe66872015-03-30 17:20:39 -07001525}
1526
Colin Crossf506d872017-07-19 15:53:04 -07001527func (j *Binary) DepsMutator(ctx android.BottomUpMutatorContext) {
Liz Kammer3bf97bd2022-04-26 09:38:20 -04001528 if ctx.Arch().ArchType == android.Common {
Colin Cross6b4a32d2017-12-05 13:42:45 -08001529 j.deps(ctx)
Liz Kammer356f7d42021-01-26 09:18:53 -05001530 }
Liz Kammer3bf97bd2022-04-26 09:38:20 -04001531 if ctx.Arch().ArchType != android.Common {
Colin Crosse9fe2942020-11-10 18:12:15 -08001532 // These dependencies ensure the host installation rules will install the jar file and
1533 // the jni libraries when the wrapper is installed.
1534 ctx.AddVariationDependencies(nil, jniInstallTag, j.binaryProperties.Jni_libs...)
1535 ctx.AddVariationDependencies(
1536 []blueprint.Variation{{Mutator: "arch", Variation: android.CommonArch.String()}},
1537 binaryInstallTag, ctx.ModuleName())
Colin Cross6b4a32d2017-12-05 13:42:45 -08001538 }
Colin Cross46c9b8b2017-06-22 16:51:17 -07001539}
1540
Colin Cross1b16b0e2019-02-12 14:41:32 -08001541// java_binary builds a `.jar` file and a shell script that executes it for the device, and possibly for the host
1542// as well.
1543//
1544// By default, a java_binary has a single variant that produces a `.jar` file containing `classes.dex` files that were
1545// compiled against the device bootclasspath.
1546//
1547// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
1548// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07001549func BinaryFactory() android.Module {
1550 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07001551
Colin Crossce6734e2020-06-15 16:09:53 -07001552 module.addHostAndDeviceProperties()
1553 module.AddProperties(&module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07001554
Colin Cross9ae1b922018-06-26 17:59:05 -07001555 module.Module.properties.Installable = proptools.BoolPtr(true)
1556
Colin Cross6b4a32d2017-12-05 13:42:45 -08001557 android.InitAndroidArchModule(module, android.HostAndDeviceSupported, android.MultilibCommonFirst)
1558 android.InitDefaultableModule(module)
Wei Libafb6d62021-12-10 03:14:59 -08001559 android.InitBazelModule(module)
1560
Colin Cross36242852017-06-23 15:06:31 -07001561 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001562}
1563
Colin Cross1b16b0e2019-02-12 14:41:32 -08001564// java_binary_host builds a `.jar` file and a shell script that executes it for the host.
1565//
1566// A java_binary_host has a single variant that produces a `.jar` file containing `.class` files that were
1567// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07001568func BinaryHostFactory() android.Module {
1569 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07001570
Colin Crossce6734e2020-06-15 16:09:53 -07001571 module.addHostProperties()
1572 module.AddProperties(&module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07001573
Colin Cross9ae1b922018-06-26 17:59:05 -07001574 module.Module.properties.Installable = proptools.BoolPtr(true)
1575
Colin Cross6b4a32d2017-12-05 13:42:45 -08001576 android.InitAndroidArchModule(module, android.HostSupported, android.MultilibCommonFirst)
1577 android.InitDefaultableModule(module)
Wei Libafb6d62021-12-10 03:14:59 -08001578 android.InitBazelModule(module)
Colin Cross36242852017-06-23 15:06:31 -07001579 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001580}
1581
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001582type JavaApiContribution struct {
1583 android.ModuleBase
1584 android.DefaultableModuleBase
1585
1586 properties struct {
1587 // name of the API surface
1588 Api_surface *string
1589
1590 // relative path to the API signature text file
1591 Api_file *string `android:"path"`
1592 }
1593}
1594
1595func ApiContributionFactory() android.Module {
1596 module := &JavaApiContribution{}
1597 android.InitAndroidModule(module)
1598 android.InitDefaultableModule(module)
1599 module.AddProperties(&module.properties)
1600 return module
1601}
1602
1603type JavaApiImportInfo struct {
1604 ApiFile android.Path
1605}
1606
1607var JavaApiImportProvider = blueprint.NewProvider(JavaApiImportInfo{})
1608
1609func (ap *JavaApiContribution) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Jihoon Kang3198f3c2023-01-26 08:08:52 +00001610 var apiFile android.Path = nil
1611 if apiFileString := ap.properties.Api_file; apiFileString != nil {
1612 apiFile = android.PathForModuleSrc(ctx, String(apiFileString))
1613 }
1614
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001615 ctx.SetProvider(JavaApiImportProvider, JavaApiImportInfo{
1616 ApiFile: apiFile,
1617 })
1618}
1619
Jihoon Kang01e522c2023-03-14 01:09:34 +00001620type JavaApiLibraryDepsInfo struct {
Jihoon Kangc0a24202023-04-04 22:04:43 +00001621 JavaInfo
Jihoon Kang01e522c2023-03-14 01:09:34 +00001622 StubsSrcJar android.Path
1623}
1624
1625var JavaApiLibraryDepsProvider = blueprint.NewProvider(JavaApiLibraryDepsInfo{})
1626
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001627type ApiLibrary struct {
1628 android.ModuleBase
1629 android.DefaultableModuleBase
1630
Spandan Dascb368ea2023-03-22 04:27:05 +00001631 hiddenAPI
1632 dexer
1633
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001634 properties JavaApiLibraryProperties
1635
Jihoon Kang01e522c2023-03-14 01:09:34 +00001636 stubsSrcJar android.WritablePath
1637 stubsJar android.WritablePath
1638 stubsJarWithoutStaticLibs android.WritablePath
1639 extractedSrcJar android.WritablePath
Spandan Dascb368ea2023-03-22 04:27:05 +00001640 // .dex of stubs, used for hiddenapi processing
1641 dexJarFile OptionalDexJarPath
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001642}
1643
1644type JavaApiLibraryProperties struct {
1645 // name of the API surface
1646 Api_surface *string
1647
Jihoon Kang60d4a092022-11-17 23:47:43 +00001648 // list of Java API contribution modules that consists this API surface
Spandan Dasc082eb82022-12-01 21:43:06 +00001649 // This is a list of Soong modules
Jihoon Kang60d4a092022-11-17 23:47:43 +00001650 Api_contributions []string
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001651
Spandan Dasc082eb82022-12-01 21:43:06 +00001652 // list of api.txt files relative to this directory that contribute to the
1653 // API surface.
1654 // This is a list of relative paths
Jihoon Kang795319f2023-05-17 00:23:38 +00001655 Api_files []string `android:"path"`
Spandan Dasc082eb82022-12-01 21:43:06 +00001656
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001657 // List of flags to be passed to the javac compiler to generate jar file
1658 Javacflags []string
Jihoon Kang362aa9d2023-01-20 19:44:07 +00001659
1660 // List of shared java libs that this module has dependencies to and
1661 // should be passed as classpath in javac invocation
1662 Libs []string
Jihoon Kange30fff02023-02-14 20:18:20 +00001663
1664 // List of java libs that this module has static dependencies to and will be
Jihoon Kang01e522c2023-03-14 01:09:34 +00001665 // merge zipped after metalava invocation
Jihoon Kange30fff02023-02-14 20:18:20 +00001666 Static_libs []string
Jihoon Kang01e522c2023-03-14 01:09:34 +00001667
1668 // Java Api library to provide the full API surface text files and jar file.
1669 // If this property is set, the provided full API surface text files and
1670 // jar file are passed to metalava invocation.
1671 Dep_api_srcs *string
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001672}
1673
1674func ApiLibraryFactory() android.Module {
1675 module := &ApiLibrary{}
1676 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibCommon)
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001677 module.AddProperties(&module.properties)
Jihoon Kang1c51f502023-01-09 23:42:40 +00001678 android.InitDefaultableModule(module)
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001679 return module
1680}
1681
1682func (al *ApiLibrary) ApiSurface() *string {
1683 return al.properties.Api_surface
1684}
1685
1686func (al *ApiLibrary) StubsJar() android.Path {
1687 return al.stubsJar
1688}
1689
1690func metalavaStubCmd(ctx android.ModuleContext, rule *android.RuleBuilder,
1691 srcs android.Paths, homeDir android.WritablePath) *android.RuleBuilderCommand {
1692 rule.Command().Text("rm -rf").Flag(homeDir.String())
1693 rule.Command().Text("mkdir -p").Flag(homeDir.String())
1694
1695 cmd := rule.Command()
1696 cmd.FlagWithArg("ANDROID_PREFS_ROOT=", homeDir.String())
1697
1698 if metalavaUseRbe(ctx) {
1699 rule.Remoteable(android.RemoteRuleSupports{RBE: true})
1700 execStrategy := ctx.Config().GetenvWithDefault("RBE_METALAVA_EXEC_STRATEGY", remoteexec.LocalExecStrategy)
1701 labels := map[string]string{"type": "tool", "name": "metalava"}
1702
1703 pool := ctx.Config().GetenvWithDefault("RBE_METALAVA_POOL", "java16")
1704 rule.Rewrapper(&remoteexec.REParams{
1705 Labels: labels,
1706 ExecStrategy: execStrategy,
1707 ToolchainInputs: []string{config.JavaCmd(ctx).String()},
1708 Platform: map[string]string{remoteexec.PoolKey: pool},
1709 })
1710 }
1711
1712 cmd.BuiltTool("metalava").ImplicitTool(ctx.Config().HostJavaToolPath(ctx, "metalava.jar")).
1713 Flag(config.JavacVmFlags).
1714 Flag("-J--add-opens=java.base/java.util=ALL-UNNAMED").
1715 FlagWithArg("-encoding ", "UTF-8").
1716 FlagWithInputList("--source-files ", srcs, " ")
1717
1718 cmd.Flag("--no-banner").
1719 Flag("--color").
1720 Flag("--quiet").
1721 Flag("--format=v2").
Jihoon Kang1bff0342023-01-17 20:40:22 +00001722 Flag("--include-annotations").
1723 // The flag makes nullability issues as warnings rather than errors by replacing
1724 // @Nullable/@NonNull in the listed packages APIs with @RecentlyNullable/@RecentlyNonNull,
1725 // and these packages are meant to have everything annotated
1726 // @RecentlyNullable/@RecentlyNonNull.
1727 FlagWithArg("--force-convert-to-warning-nullability-annotations ", "+*:-android.*:+android.icu.*:-dalvik.*").
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001728 FlagWithArg("--repeat-errors-max ", "10").
1729 FlagWithArg("--hide ", "UnresolvedImport").
1730 FlagWithArg("--hide ", "InvalidNullabilityOverride").
1731 FlagWithArg("--hide ", "ChangedDefault")
1732
1733 return cmd
1734}
1735
Jihoon Kang1bff0342023-01-17 20:40:22 +00001736func (al *ApiLibrary) HeaderJars() android.Paths {
1737 return android.Paths{al.stubsJar}
1738}
1739
1740func (al *ApiLibrary) OutputDirAndDeps() (android.Path, android.Paths) {
1741 return nil, nil
1742}
1743
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001744func (al *ApiLibrary) stubsFlags(ctx android.ModuleContext, cmd *android.RuleBuilderCommand, stubsDir android.OptionalPath) {
1745 if stubsDir.Valid() {
1746 cmd.FlagWithArg("--stubs ", stubsDir.String())
1747 }
1748}
1749
Jihoon Kang01e522c2023-03-14 01:09:34 +00001750// This method extracts the stub java files from the srcjar file provided from dep_api_srcs module
1751// and replaces the java stubs generated by invoking metalava in this module.
1752// This method is used because metalava can generate compilable from-text stubs only when
1753// the codebase encompasses all classes listed in the input API text file, but a class can extend
1754// a class that is not within the same API domain.
1755func (al *ApiLibrary) extractApiSrcs(ctx android.ModuleContext, rule *android.RuleBuilder, stubsDir android.OptionalPath, depApiSrcsSrcJar android.Path) {
1756 generatedStubsList := android.PathForModuleOut(ctx, "metalava", "sources.txt")
1757 unzippedSrcJarDir := android.PathForModuleOut(ctx, "metalava", "unzipDir")
1758
1759 rule.Command().
1760 BuiltTool("list_files").
1761 Text(stubsDir.String()).
1762 FlagWithOutput("--out ", generatedStubsList).
1763 FlagWithArg("--extensions ", ".java").
1764 FlagWithArg("--root ", unzippedSrcJarDir.String())
1765
1766 rule.Command().
1767 Text("unzip").
1768 Flag("-q").
1769 Input(depApiSrcsSrcJar).
1770 FlagWithArg("-d ", unzippedSrcJarDir.String())
1771
1772 rule.Command().
1773 BuiltTool("soong_zip").
1774 Flag("-srcjar").
1775 Flag("-write_if_changed").
1776 FlagWithArg("-C ", unzippedSrcJarDir.String()).
1777 FlagWithInput("-l ", generatedStubsList).
1778 FlagWithOutput("-o ", al.stubsSrcJar)
1779}
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001780
1781func (al *ApiLibrary) DepsMutator(ctx android.BottomUpMutatorContext) {
Jihoon Kang60d4a092022-11-17 23:47:43 +00001782 apiContributions := al.properties.Api_contributions
1783 for _, apiContributionName := range apiContributions {
1784 ctx.AddDependency(ctx.Module(), javaApiContributionTag, apiContributionName)
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001785 }
Jihoon Kang362aa9d2023-01-20 19:44:07 +00001786 ctx.AddVariationDependencies(nil, libTag, al.properties.Libs...)
Jihoon Kange30fff02023-02-14 20:18:20 +00001787 ctx.AddVariationDependencies(nil, staticLibTag, al.properties.Static_libs...)
Jihoon Kang01e522c2023-03-14 01:09:34 +00001788 if al.properties.Dep_api_srcs != nil {
1789 ctx.AddVariationDependencies(nil, depApiSrcsTag, String(al.properties.Dep_api_srcs))
1790 }
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001791}
1792
1793func (al *ApiLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1794
1795 rule := android.NewRuleBuilder(pctx, ctx)
1796
1797 rule.Sbox(android.PathForModuleOut(ctx, "metalava"),
1798 android.PathForModuleOut(ctx, "metalava.sbox.textproto")).
1799 SandboxInputs()
1800
1801 var stubsDir android.OptionalPath
1802 stubsDir = android.OptionalPathForPath(android.PathForModuleOut(ctx, "metalava", "stubsDir"))
1803 rule.Command().Text("rm -rf").Text(stubsDir.String())
1804 rule.Command().Text("mkdir -p").Text(stubsDir.String())
1805
1806 homeDir := android.PathForModuleOut(ctx, "metalava", "home")
1807
Jihoon Kang362aa9d2023-01-20 19:44:07 +00001808 var srcFiles android.Paths
1809 var classPaths android.Paths
Jihoon Kange30fff02023-02-14 20:18:20 +00001810 var staticLibs android.Paths
Jihoon Kang01e522c2023-03-14 01:09:34 +00001811 var depApiSrcsStubsSrcJar android.Path
Jihoon Kang362aa9d2023-01-20 19:44:07 +00001812 ctx.VisitDirectDeps(func(dep android.Module) {
1813 tag := ctx.OtherModuleDependencyTag(dep)
1814 switch tag {
1815 case javaApiContributionTag:
1816 provider := ctx.OtherModuleProvider(dep, JavaApiImportProvider).(JavaApiImportInfo)
Jihoon Kang3198f3c2023-01-26 08:08:52 +00001817 providerApiFile := provider.ApiFile
Jihoon Kang160634c2023-05-25 05:28:29 +00001818 if providerApiFile == nil && !ctx.Config().AllowMissingDependencies() {
Jihoon Kang3198f3c2023-01-26 08:08:52 +00001819 ctx.ModuleErrorf("Error: %s has an empty api file.", dep.Name())
1820 }
1821 srcFiles = append(srcFiles, android.PathForSource(ctx, providerApiFile.String()))
Jihoon Kang362aa9d2023-01-20 19:44:07 +00001822 case libTag:
1823 provider := ctx.OtherModuleProvider(dep, JavaInfoProvider).(JavaInfo)
1824 classPaths = append(classPaths, provider.HeaderJars...)
Jihoon Kange30fff02023-02-14 20:18:20 +00001825 case staticLibTag:
1826 provider := ctx.OtherModuleProvider(dep, JavaInfoProvider).(JavaInfo)
1827 staticLibs = append(staticLibs, provider.HeaderJars...)
Jihoon Kang01e522c2023-03-14 01:09:34 +00001828 case depApiSrcsTag:
1829 provider := ctx.OtherModuleProvider(dep, JavaApiLibraryDepsProvider).(JavaApiLibraryDepsInfo)
Jihoon Kangc0a24202023-04-04 22:04:43 +00001830 classPaths = append(classPaths, provider.HeaderJars...)
Jihoon Kang01e522c2023-03-14 01:09:34 +00001831 depApiSrcsStubsSrcJar = provider.StubsSrcJar
Jihoon Kang362aa9d2023-01-20 19:44:07 +00001832 }
Jihoon Kang60d4a092022-11-17 23:47:43 +00001833 })
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001834
Spandan Dasc082eb82022-12-01 21:43:06 +00001835 // Add the api_files inputs
1836 for _, api := range al.properties.Api_files {
Jihoon Kang795319f2023-05-17 00:23:38 +00001837 srcFiles = append(srcFiles, android.PathForModuleSrc(ctx, api))
Spandan Dasc082eb82022-12-01 21:43:06 +00001838 }
1839
Jihoon Kang160634c2023-05-25 05:28:29 +00001840 if srcFiles == nil && !ctx.Config().AllowMissingDependencies() {
Jihoon Kang01e522c2023-03-14 01:09:34 +00001841 ctx.ModuleErrorf("Error: %s has an empty api file.", ctx.ModuleName())
1842 }
1843
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001844 cmd := metalavaStubCmd(ctx, rule, srcFiles, homeDir)
1845
1846 al.stubsFlags(ctx, cmd, stubsDir)
1847
1848 al.stubsSrcJar = android.PathForModuleOut(ctx, "metalava", ctx.ModuleName()+"-"+"stubs.srcjar")
Jihoon Kang01e522c2023-03-14 01:09:34 +00001849
1850 if depApiSrcsStubsSrcJar != nil {
1851 al.extractApiSrcs(ctx, rule, stubsDir, depApiSrcsStubsSrcJar)
1852 } else {
1853 rule.Command().
1854 BuiltTool("soong_zip").
1855 Flag("-write_if_changed").
1856 Flag("-jar").
1857 FlagWithOutput("-o ", al.stubsSrcJar).
1858 FlagWithArg("-C ", stubsDir.String()).
1859 FlagWithArg("-D ", stubsDir.String())
1860 }
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001861
1862 rule.Build("metalava", "metalava merged")
Jihoon Kang01e522c2023-03-14 01:09:34 +00001863
1864 al.stubsJarWithoutStaticLibs = android.PathForModuleOut(ctx, ctx.ModuleName(), "stubs.jar")
Jihoon Kang25857f52023-03-01 00:27:32 +00001865 al.stubsJar = android.PathForModuleOut(ctx, ctx.ModuleName(), fmt.Sprintf("%s.jar", ctx.ModuleName()))
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001866
1867 var flags javaBuilderFlags
Jihoon Kangff878bf2022-12-22 21:26:06 +00001868 flags.javaVersion = getStubsJavaVersion()
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001869 flags.javacFlags = strings.Join(al.properties.Javacflags, " ")
Jihoon Kang362aa9d2023-01-20 19:44:07 +00001870 flags.classpath = classpath(classPaths)
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001871
Jihoon Kang01e522c2023-03-14 01:09:34 +00001872 TransformJavaToClasses(ctx, al.stubsJarWithoutStaticLibs, 0, android.Paths{},
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001873 android.Paths{al.stubsSrcJar}, flags, android.Paths{})
Jihoon Kang423d2292022-11-29 23:10:10 +00001874
Jihoon Kange30fff02023-02-14 20:18:20 +00001875 builder := android.NewRuleBuilder(pctx, ctx)
1876 builder.Command().
1877 BuiltTool("merge_zips").
1878 Output(al.stubsJar).
Jihoon Kang01e522c2023-03-14 01:09:34 +00001879 Inputs(android.Paths{al.stubsJarWithoutStaticLibs}).
Jihoon Kange30fff02023-02-14 20:18:20 +00001880 Inputs(staticLibs)
1881 builder.Build("merge_zips", "merge jar files")
1882
Spandan Dascb368ea2023-03-22 04:27:05 +00001883 // compile stubs to .dex for hiddenapi processing
1884 dexParams := &compileDexParams{
1885 flags: javaBuilderFlags{},
1886 sdkVersion: al.SdkVersion(ctx),
1887 minSdkVersion: al.MinSdkVersion(ctx),
1888 classesJar: al.stubsJar,
1889 jarName: ctx.ModuleName() + ".jar",
1890 }
1891 dexOutputFile := al.dexer.compileDex(ctx, dexParams)
1892 uncompressed := true
1893 al.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), al.stubsJar, &uncompressed)
1894 dexOutputFile = al.hiddenAPIEncodeDex(ctx, dexOutputFile)
1895 al.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
1896
Jihoon Kang423d2292022-11-29 23:10:10 +00001897 ctx.Phony(ctx.ModuleName(), al.stubsJar)
Jihoon Kang362aa9d2023-01-20 19:44:07 +00001898
1899 ctx.SetProvider(JavaInfoProvider, JavaInfo{
Jihoon Kang1bff0342023-01-17 20:40:22 +00001900 HeaderJars: android.PathsIfNonNil(al.stubsJar),
1901 ImplementationAndResourcesJars: android.PathsIfNonNil(al.stubsJar),
1902 ImplementationJars: android.PathsIfNonNil(al.stubsJar),
1903 AidlIncludeDirs: android.Paths{},
Jihoon Kang362aa9d2023-01-20 19:44:07 +00001904 })
Jihoon Kang01e522c2023-03-14 01:09:34 +00001905
1906 ctx.SetProvider(JavaApiLibraryDepsProvider, JavaApiLibraryDepsInfo{
Jihoon Kangc0a24202023-04-04 22:04:43 +00001907 JavaInfo: JavaInfo{
1908 HeaderJars: android.PathsIfNonNil(al.stubsJar),
1909 },
Jihoon Kang01e522c2023-03-14 01:09:34 +00001910 StubsSrcJar: al.stubsSrcJar,
1911 })
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001912}
1913
Spandan Dascb368ea2023-03-22 04:27:05 +00001914func (al *ApiLibrary) DexJarBuildPath() OptionalDexJarPath {
1915 return al.dexJarFile
1916}
1917
1918func (al *ApiLibrary) DexJarInstallPath() android.Path {
1919 return al.dexJarFile.Path()
1920}
1921
1922func (al *ApiLibrary) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
1923 return nil
1924}
1925
1926// java_api_library constitutes the sdk, and does not build against one
1927func (al *ApiLibrary) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
1928 return android.SdkSpecNone
1929}
1930
1931// java_api_library is always at "current". Return FutureApiLevel
1932func (al *ApiLibrary) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
1933 return android.FutureApiLevel
1934}
1935
1936// implement the following interfaces for hiddenapi processing
1937var _ hiddenAPIModule = (*ApiLibrary)(nil)
1938var _ UsesLibraryDependency = (*ApiLibrary)(nil)
1939
Colin Cross2fe66872015-03-30 17:20:39 -07001940//
1941// Java prebuilts
1942//
1943
Colin Cross74d73e22017-08-02 11:05:49 -07001944type ImportProperties struct {
Paul Duffina04c1072020-03-02 10:16:35 +00001945 Jars []string `android:"path,arch_variant"`
Colin Cross461bd1a2017-10-20 13:59:18 -07001946
Jaewoong Jung56e12db2021-04-02 00:38:25 +00001947 // The version of the SDK that the source prebuilt file was built against. Defaults to the
1948 // current version if not specified.
Nan Zhangea568a42017-11-08 21:20:04 -08001949 Sdk_version *string
Colin Cross535e2cf2017-10-20 17:57:49 -07001950
Jaewoong Jung56e12db2021-04-02 00:38:25 +00001951 // The minimum version of the SDK that this module supports. Defaults to sdk_version if not
1952 // specified.
1953 Min_sdk_version *string
1954
William Loh5a082f92022-05-17 20:21:50 +00001955 // The max sdk version placeholder used to replace maxSdkVersion attributes on permission
1956 // and uses-permission tags in manifest_fixer.
1957 Replace_max_sdk_version_placeholder *string
1958
Colin Cross535e2cf2017-10-20 17:57:49 -07001959 Installable *bool
Jiyong Park1be96912018-05-28 18:02:19 +09001960
Paul Duffin869de142021-07-15 14:14:41 +01001961 // If not empty, classes are restricted to the specified packages and their sub-packages.
Paul Duffin869de142021-07-15 14:14:41 +01001962 Permitted_packages []string
1963
Jiyong Park1be96912018-05-28 18:02:19 +09001964 // List of shared java libs that this module has dependencies to
1965 Libs []string
Colin Cross37f6d792018-07-12 12:28:41 -07001966
1967 // List of files to remove from the jar file(s)
1968 Exclude_files []string
1969
1970 // List of directories to remove from the jar file(s)
1971 Exclude_dirs []string
Nan Zhang4c819fb2018-08-27 18:31:46 -07001972
1973 // if set to true, run Jetifier against .jar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -07001974 Jetifier *bool
Jiyong Park4c4c0242019-10-21 14:53:15 +09001975
1976 // set the name of the output
1977 Stem *string
Jiyong Park19604de2020-03-24 16:44:11 +09001978
1979 Aidl struct {
1980 // directories that should be added as include directories for any aidl sources of modules
1981 // that depend on this module, as well as to aidl for this module.
1982 Export_include_dirs []string
1983 }
Colin Cross74d73e22017-08-02 11:05:49 -07001984}
1985
1986type Import struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001987 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -07001988 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09001989 android.ApexModuleBase
Romain Jobredeaux428a3662022-01-28 11:12:52 -05001990 android.BazelModuleBase
Colin Crossec7a0422017-07-07 14:47:12 -07001991 prebuilt android.Prebuilt
Colin Cross2fe66872015-03-30 17:20:39 -07001992
Paul Duffin0d3c2e12020-05-17 08:34:50 +01001993 // Functionality common to Module and Import.
1994 embeddableInModuleAndImport
1995
Liz Kammerd6c31d22020-08-05 15:40:41 -07001996 hiddenAPI
1997 dexer
Bill Peckhamff89ffa2020-12-23 16:13:04 -08001998 dexpreopter
Liz Kammerd6c31d22020-08-05 15:40:41 -07001999
Colin Cross74d73e22017-08-02 11:05:49 -07002000 properties ImportProperties
2001
Liz Kammerd6c31d22020-08-05 15:40:41 -07002002 // output file containing classes.dex and resources
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01002003 dexJarFile OptionalDexJarPath
Jeongik Chad5fe8782021-07-08 01:13:11 +09002004 dexJarInstallFile android.Path
Liz Kammerd6c31d22020-08-05 15:40:41 -07002005
Colin Cross0a6e0072017-08-30 14:24:55 -07002006 combinedClasspathFile android.Path
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01002007 classLoaderContexts dexpreopt.ClassLoaderContextMap
Jiyong Park19604de2020-03-24 16:44:11 +09002008 exportAidlIncludeDirs android.Paths
Colin Cross56a83212020-09-15 18:30:11 -07002009
2010 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +09002011
2012 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002013 minSdkVersion android.ApiLevel
Colin Cross2fe66872015-03-30 17:20:39 -07002014}
2015
Paul Duffin630b11e2021-07-15 13:35:26 +01002016var _ PermittedPackagesForUpdatableBootJars = (*Import)(nil)
2017
2018func (j *Import) PermittedPackagesForUpdatableBootJars() []string {
2019 return j.properties.Permitted_packages
2020}
2021
Jiyong Park92315372021-04-02 08:45:46 +09002022func (j *Import) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
2023 return android.SdkSpecFrom(ctx, String(j.properties.Sdk_version))
Liz Kammer2d2fd852020-08-12 14:42:30 -07002024}
2025
Jiyong Parkf1691d22021-03-29 20:11:58 +09002026func (j *Import) SystemModules() string {
Liz Kammerd6c31d22020-08-05 15:40:41 -07002027 return "none"
2028}
2029
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002030func (j *Import) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jaewoong Jung56e12db2021-04-02 00:38:25 +00002031 if j.properties.Min_sdk_version != nil {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002032 return android.ApiLevelFrom(ctx, *j.properties.Min_sdk_version)
Jaewoong Jung56e12db2021-04-02 00:38:25 +00002033 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002034 return j.SdkVersion(ctx).ApiLevel
Colin Cross83bb3162018-06-25 15:48:06 -07002035}
2036
Spandan Dasa26eda72023-03-02 00:56:06 +00002037func (j *Import) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
William Loh5a082f92022-05-17 20:21:50 +00002038 if j.properties.Replace_max_sdk_version_placeholder != nil {
Spandan Dasa26eda72023-03-02 00:56:06 +00002039 return android.ApiLevelFrom(ctx, *j.properties.Replace_max_sdk_version_placeholder)
William Loh5a082f92022-05-17 20:21:50 +00002040 }
Spandan Dasa26eda72023-03-02 00:56:06 +00002041 // Default is PrivateApiLevel
2042 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +00002043}
2044
Spandan Dasca70fc42023-03-01 23:38:49 +00002045func (j *Import) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
2046 return j.SdkVersion(ctx).ApiLevel
Artur Satayev480e25b2020-04-27 18:53:18 +01002047}
2048
Colin Cross74d73e22017-08-02 11:05:49 -07002049func (j *Import) Prebuilt() *android.Prebuilt {
Colin Crossec7a0422017-07-07 14:47:12 -07002050 return &j.prebuilt
2051}
2052
Colin Cross74d73e22017-08-02 11:05:49 -07002053func (j *Import) PrebuiltSrcs() []string {
2054 return j.properties.Jars
2055}
2056
2057func (j *Import) Name() string {
Colin Cross5ea9bcc2017-07-27 15:41:32 -07002058 return j.prebuilt.Name(j.ModuleBase.Name())
2059}
2060
Jiyong Park0b238752019-10-29 11:23:10 +09002061func (j *Import) Stem() string {
2062 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
2063}
2064
Jiyong Park618922e2020-01-08 13:35:43 +09002065func (a *Import) JacocoReportClassesFile() android.Path {
2066 return nil
2067}
2068
Bill Peckhama41a6962021-01-11 10:58:54 -08002069func (j *Import) LintDepSets() LintDepSets {
2070 return LintDepSets{}
2071}
2072
Jaewoong Jung476b9d62021-05-10 15:30:00 -07002073func (j *Import) getStrictUpdatabilityLinting() bool {
2074 return false
2075}
2076
2077func (j *Import) setStrictUpdatabilityLinting(bool) {
2078}
2079
Colin Cross74d73e22017-08-02 11:05:49 -07002080func (j *Import) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross42d48b72018-08-29 14:10:52 -07002081 ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Liz Kammerd6c31d22020-08-05 15:40:41 -07002082
2083 if ctx.Device() && Bool(j.dexProperties.Compile_dex) {
Jiyong Parkf1691d22021-03-29 20:11:58 +09002084 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Liz Kammerd6c31d22020-08-05 15:40:41 -07002085 }
Colin Cross1e676be2016-10-12 14:38:15 -07002086}
2087
Sam Delmerico277795c2022-02-25 17:04:37 +00002088func (j *Import) commonBuildActions(ctx android.ModuleContext) {
Paul Duffin7ed6ff82022-11-21 10:57:30 +00002089 //TODO(b/231322772) these should come from Bazel once available
Jiyong Park92315372021-04-02 08:45:46 +09002090 j.sdkVersion = j.SdkVersion(ctx)
2091 j.minSdkVersion = j.MinSdkVersion(ctx)
2092
Colin Cross56a83212020-09-15 18:30:11 -07002093 if !ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform() {
2094 j.hideApexVariantFromMake = true
2095 }
2096
Dan Willemsen8e6b3712021-09-20 23:11:24 -07002097 if ctx.Windows() {
2098 j.HideFromMake()
2099 }
Sam Delmerico277795c2022-02-25 17:04:37 +00002100}
2101
2102func (j *Import) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2103 j.commonBuildActions(ctx)
Dan Willemsen8e6b3712021-09-20 23:11:24 -07002104
Colin Cross8a497952019-03-05 22:25:09 -08002105 jars := android.PathsForModuleSrc(ctx, j.properties.Jars)
Colin Crosse1d62a82015-04-03 16:53:05 -07002106
Jiyong Park0b238752019-10-29 11:23:10 +09002107 jarName := j.Stem() + ".jar"
Nan Zhang4c819fb2018-08-27 18:31:46 -07002108 outputFile := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07002109 TransformJarsToJar(ctx, outputFile, "for prebuilts", jars, android.OptionalPath{},
2110 false, j.properties.Exclude_files, j.properties.Exclude_dirs)
Colin Cross1001a792019-03-21 22:21:39 -07002111 if Bool(j.properties.Jetifier) {
Nan Zhang4c819fb2018-08-27 18:31:46 -07002112 inputFile := outputFile
2113 outputFile = android.PathForModuleOut(ctx, "jetifier", jarName)
2114 TransformJetifier(ctx, outputFile, inputFile)
2115 }
Colin Crosse9a275b2017-10-16 17:09:48 -07002116 j.combinedClasspathFile = outputFile
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01002117 j.classLoaderContexts = make(dexpreopt.ClassLoaderContextMap)
Paul Duffin859fe962020-05-15 10:20:31 +01002118
Liz Kammerd6c31d22020-08-05 15:40:41 -07002119 var flags javaBuilderFlags
2120
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002121 j.collectTransitiveHeaderJars(ctx)
Jiyong Park1be96912018-05-28 18:02:19 +09002122 ctx.VisitDirectDeps(func(module android.Module) {
Jiyong Park1be96912018-05-28 18:02:19 +09002123 tag := ctx.OtherModuleDependencyTag(module)
Colin Crossdcf71b22021-02-01 13:59:03 -08002124 if ctx.OtherModuleHasProvider(module, JavaInfoProvider) {
2125 dep := ctx.OtherModuleProvider(module, JavaInfoProvider).(JavaInfo)
Jiyong Park1be96912018-05-28 18:02:19 +09002126 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002127 case libTag, sdkLibTag:
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002128 flags.classpath = append(flags.classpath, dep.HeaderJars...)
2129 flags.dexClasspath = append(flags.dexClasspath, dep.HeaderJars...)
2130 case staticLibTag:
Colin Crossdcf71b22021-02-01 13:59:03 -08002131 flags.classpath = append(flags.classpath, dep.HeaderJars...)
Liz Kammerd6c31d22020-08-05 15:40:41 -07002132 case bootClasspathTag:
Colin Crossdcf71b22021-02-01 13:59:03 -08002133 flags.bootClasspath = append(flags.bootClasspath, dep.HeaderJars...)
Jiyong Park1be96912018-05-28 18:02:19 +09002134 }
Colin Crossdcf71b22021-02-01 13:59:03 -08002135 } else if dep, ok := module.(SdkLibraryDependency); ok {
Jiyong Park1be96912018-05-28 18:02:19 +09002136 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002137 case libTag, sdkLibTag:
Jiyong Park92315372021-04-02 08:45:46 +09002138 flags.classpath = append(flags.classpath, dep.SdkHeaderJars(ctx, j.SdkVersion(ctx))...)
Jiyong Park1be96912018-05-28 18:02:19 +09002139 }
2140 }
Ulya Trafimovich65b03192020-12-03 16:50:22 +00002141
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00002142 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiyong Park1be96912018-05-28 18:02:19 +09002143 })
2144
Sam Delmerico277795c2022-02-25 17:04:37 +00002145 j.maybeInstall(ctx, jarName, outputFile)
Jiyong Park19604de2020-03-24 16:44:11 +09002146
2147 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.properties.Aidl.Export_include_dirs)
Liz Kammerd6c31d22020-08-05 15:40:41 -07002148
Paul Duffin064b70c2020-11-02 17:32:38 +00002149 if ctx.Device() {
2150 // If this is a variant created for a prebuilt_apex then use the dex implementation jar
2151 // obtained from the associated deapexer module.
2152 ai := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2153 if ai.ForPrebuiltApex {
Paul Duffin064b70c2020-11-02 17:32:38 +00002154 // Get the path of the dex implementation jar from the `deapexer` module.
Martin Stjernholm44825602021-09-17 01:44:12 +01002155 di := android.FindDeapexerProviderForModule(ctx)
2156 if di == nil {
2157 return // An error has been reported by FindDeapexerProviderForModule.
2158 }
Jiakai Zhang81e46812023-02-08 21:56:07 +08002159 dexJarFileApexRootRelative := apexRootRelativePathToJavaLib(j.BaseModuleName())
2160 if dexOutputPath := di.PrebuiltExportPath(dexJarFileApexRootRelative); dexOutputPath != nil {
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01002161 dexJarFile := makeDexJarPathFromPath(dexOutputPath)
2162 j.dexJarFile = dexJarFile
Jiakai Zhang5b24f722021-09-30 09:32:57 +00002163 installPath := android.PathForModuleInPartitionInstall(ctx, "apex", ai.ApexVariationName, apexRootRelativePathToJavaLib(j.BaseModuleName()))
2164 j.dexJarInstallFile = installPath
Paul Duffin74d18d12021-05-14 14:18:47 +01002165
Jiakai Zhang5b24f722021-09-30 09:32:57 +00002166 j.dexpreopter.installPath = j.dexpreopter.getInstallPath(ctx, installPath)
Jiakai Zhang22450f22021-10-11 03:05:20 +00002167 setUncompressDex(ctx, &j.dexpreopter, &j.dexer)
Jiakai Zhang5b24f722021-09-30 09:32:57 +00002168 j.dexpreopter.uncompressedDex = *j.dexProperties.Uncompress_dex
Jiakai Zhang81e46812023-02-08 21:56:07 +08002169
2170 if profilePath := di.PrebuiltExportPath(dexJarFileApexRootRelative + ".prof"); profilePath != nil {
2171 j.dexpreopter.inputProfilePathOnHost = profilePath
2172 }
2173
Jiakai Zhang5b24f722021-09-30 09:32:57 +00002174 j.dexpreopt(ctx, dexOutputPath)
Jiakai Zhang22450f22021-10-11 03:05:20 +00002175
2176 // Initialize the hiddenapi structure.
2177 j.initHiddenAPI(ctx, dexJarFile, outputFile, j.dexProperties.Uncompress_dex)
Paul Duffin9d67ca62021-02-03 20:06:33 +00002178 } else {
Paul Duffin064b70c2020-11-02 17:32:38 +00002179 // This should never happen as a variant for a prebuilt_apex is only created if the
2180 // prebuilt_apex has been configured to export the java library dex file.
Martin Stjernholm44825602021-09-17 01:44:12 +01002181 ctx.ModuleErrorf("internal error: no dex implementation jar available from prebuilt APEX %s", di.ApexModuleName())
Paul Duffin064b70c2020-11-02 17:32:38 +00002182 }
2183 } else if Bool(j.dexProperties.Compile_dex) {
Jiyong Parkf1691d22021-03-29 20:11:58 +09002184 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
Paul Duffin064b70c2020-11-02 17:32:38 +00002185 if sdkDep.invalidVersion {
2186 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2187 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2188 } else if sdkDep.useFiles {
2189 // sdkDep.jar is actually equivalent to turbine header.jar.
2190 flags.classpath = append(flags.classpath, sdkDep.jars...)
2191 }
2192
2193 // Dex compilation
2194
Jiakai Zhang519c5c82021-09-16 06:15:39 +00002195 j.dexpreopter.installPath = j.dexpreopter.getInstallPath(
2196 ctx, android.PathForModuleInstall(ctx, "framework", jarName))
Jiakai Zhang22450f22021-10-11 03:05:20 +00002197 setUncompressDex(ctx, &j.dexpreopter, &j.dexer)
Paul Duffin064b70c2020-11-02 17:32:38 +00002198 j.dexpreopter.uncompressedDex = *j.dexProperties.Uncompress_dex
2199
Paul Duffin612e6102021-02-02 13:38:13 +00002200 var dexOutputFile android.OutputPath
Spandan Dasc404cc72023-02-23 18:05:05 +00002201 dexParams := &compileDexParams{
2202 flags: flags,
2203 sdkVersion: j.SdkVersion(ctx),
2204 minSdkVersion: j.MinSdkVersion(ctx),
2205 classesJar: outputFile,
2206 jarName: jarName,
2207 }
2208
2209 dexOutputFile = j.dexer.compileDex(ctx, dexParams)
Paul Duffin064b70c2020-11-02 17:32:38 +00002210 if ctx.Failed() {
2211 return
2212 }
2213
Paul Duffin74d18d12021-05-14 14:18:47 +01002214 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01002215 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), outputFile, j.dexProperties.Uncompress_dex)
Paul Duffinafaa47c2021-05-14 13:04:04 +01002216
2217 // Encode hidden API flags in dex file.
Paul Duffin1bbd0622021-05-14 15:52:25 +01002218 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
Paul Duffin064b70c2020-11-02 17:32:38 +00002219
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01002220 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jeongik Chad5fe8782021-07-08 01:13:11 +09002221 j.dexJarInstallFile = android.PathForModuleInstall(ctx, "framework", jarName)
Liz Kammerd6c31d22020-08-05 15:40:41 -07002222 }
Liz Kammerd6c31d22020-08-05 15:40:41 -07002223 }
Colin Crossdcf71b22021-02-01 13:59:03 -08002224
2225 ctx.SetProvider(JavaInfoProvider, JavaInfo{
2226 HeaderJars: android.PathsIfNonNil(j.combinedClasspathFile),
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002227 TransitiveLibsHeaderJars: j.transitiveLibsHeaderJars,
2228 TransitiveStaticLibsHeaderJars: j.transitiveStaticLibsHeaderJars,
Colin Crossdcf71b22021-02-01 13:59:03 -08002229 ImplementationAndResourcesJars: android.PathsIfNonNil(j.combinedClasspathFile),
2230 ImplementationJars: android.PathsIfNonNil(j.combinedClasspathFile),
2231 AidlIncludeDirs: j.exportAidlIncludeDirs,
2232 })
Colin Cross2fe66872015-03-30 17:20:39 -07002233}
2234
Sam Delmerico277795c2022-02-25 17:04:37 +00002235func (j *Import) maybeInstall(ctx android.ModuleContext, jarName string, outputFile android.Path) {
2236 if !Bool(j.properties.Installable) {
2237 return
2238 }
2239
2240 var installDir android.InstallPath
2241 if ctx.InstallInTestcases() {
2242 var archDir string
2243 if !ctx.Host() {
2244 archDir = ctx.DeviceConfig().DeviceArch()
2245 }
2246 installDir = android.PathForModuleInstall(ctx, ctx.ModuleName(), archDir)
2247 } else {
2248 installDir = android.PathForModuleInstall(ctx, "framework")
2249 }
2250 ctx.InstallFile(installDir, jarName, outputFile)
2251}
2252
Paul Duffinaa55f742020-10-06 17:20:13 +01002253func (j *Import) OutputFiles(tag string) (android.Paths, error) {
2254 switch tag {
Saeid Farivar Asanjan128fe5c2020-10-15 17:54:40 +00002255 case "", ".jar":
Paul Duffinaa55f742020-10-06 17:20:13 +01002256 return android.Paths{j.combinedClasspathFile}, nil
2257 default:
2258 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
2259 }
2260}
2261
2262var _ android.OutputFileProducer = (*Import)(nil)
2263
Nan Zhanged19fc32017-10-19 13:06:22 -07002264func (j *Import) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002265 if j.combinedClasspathFile == nil {
2266 return nil
2267 }
Colin Cross37f6d792018-07-12 12:28:41 -07002268 return android.Paths{j.combinedClasspathFile}
Nan Zhanged19fc32017-10-19 13:06:22 -07002269}
2270
Colin Cross331a1212018-08-15 20:40:52 -07002271func (j *Import) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002272 if j.combinedClasspathFile == nil {
2273 return nil
2274 }
Colin Cross331a1212018-08-15 20:40:52 -07002275 return android.Paths{j.combinedClasspathFile}
2276}
2277
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01002278func (j *Import) DexJarBuildPath() OptionalDexJarPath {
Liz Kammerd6c31d22020-08-05 15:40:41 -07002279 return j.dexJarFile
Colin Crossf24a22a2019-01-31 14:12:44 -08002280}
2281
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01002282func (j *Import) DexJarInstallPath() android.Path {
Jeongik Chad5fe8782021-07-08 01:13:11 +09002283 return j.dexJarInstallFile
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01002284}
2285
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01002286func (j *Import) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2287 return j.classLoaderContexts
Jiyong Park1be96912018-05-28 18:02:19 +09002288}
2289
Jiyong Park45bf82e2020-12-15 22:29:02 +09002290var _ android.ApexModule = (*Import)(nil)
2291
2292// Implements android.ApexModule
Jiyong Park0f80c182020-01-31 02:49:53 +09002293func (j *Import) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Paul Duffin0d3c2e12020-05-17 08:34:50 +01002294 return j.depIsInSameApex(ctx, dep)
Jiyong Park0f80c182020-01-31 02:49:53 +09002295}
2296
Jiyong Park45bf82e2020-12-15 22:29:02 +09002297// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07002298func (j *Import) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
2299 sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002300 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002301 minSdkVersion := j.MinSdkVersion(ctx)
2302 if !minSdkVersion.Specified() {
Jaewoong Jung56e12db2021-04-02 00:38:25 +00002303 return fmt.Errorf("min_sdk_version is not specified")
2304 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002305 // If the module is compiling against core (via sdk_version), skip comparison check.
2306 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung56e12db2021-04-02 00:38:25 +00002307 return nil
2308 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002309 if minSdkVersion.GreaterThan(sdkVersion) {
2310 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung56e12db2021-04-02 00:38:25 +00002311 }
Jooyung Han749dc692020-04-15 11:03:39 +09002312 return nil
2313}
2314
Paul Duffinfef55002021-06-17 14:56:05 +01002315// requiredFilesFromPrebuiltApexForImport returns information about the files that a java_import or
2316// java_sdk_library_import with the specified base module name requires to be exported from a
2317// prebuilt_apex/apex_set.
Jiakai Zhang81e46812023-02-08 21:56:07 +08002318func requiredFilesFromPrebuiltApexForImport(name string, d *dexpreopter) []string {
2319 dexJarFileApexRootRelative := apexRootRelativePathToJavaLib(name)
Paul Duffinb4bbf2c2021-06-17 15:59:07 +01002320 // Add the dex implementation jar to the set of exported files.
Jiakai Zhang81e46812023-02-08 21:56:07 +08002321 files := []string{
2322 dexJarFileApexRootRelative,
Paul Duffinfef55002021-06-17 14:56:05 +01002323 }
Jiakai Zhang81e46812023-02-08 21:56:07 +08002324 if BoolDefault(d.importDexpreoptProperties.Dex_preopt.Profile_guided, false) {
2325 files = append(files, dexJarFileApexRootRelative+".prof")
2326 }
2327 return files
Paul Duffinfef55002021-06-17 14:56:05 +01002328}
2329
Paul Duffinb4bbf2c2021-06-17 15:59:07 +01002330// apexRootRelativePathToJavaLib returns the path, relative to the root of the apex's contents, for
2331// the java library with the specified name.
2332func apexRootRelativePathToJavaLib(name string) string {
2333 return filepath.Join("javalib", name+".jar")
2334}
2335
Paul Duffinfef55002021-06-17 14:56:05 +01002336var _ android.RequiredFilesFromPrebuiltApex = (*Import)(nil)
2337
Paul Duffinb4bbf2c2021-06-17 15:59:07 +01002338func (j *Import) RequiredFilesFromPrebuiltApex(_ android.BaseModuleContext) []string {
Paul Duffinfef55002021-06-17 14:56:05 +01002339 name := j.BaseModuleName()
Jiakai Zhang81e46812023-02-08 21:56:07 +08002340 return requiredFilesFromPrebuiltApexForImport(name, &j.dexpreopter)
Paul Duffinfef55002021-06-17 14:56:05 +01002341}
2342
albaltai36ff7dc2018-12-25 14:35:23 +08002343// Add compile time check for interface implementation
2344var _ android.IDEInfo = (*Import)(nil)
2345var _ android.IDECustomizedModuleName = (*Import)(nil)
2346
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002347// Collect information for opening IDE project files in java/jdeps.go.
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002348
2349func (j *Import) IDEInfo(dpInfo *android.IdeInfo) {
2350 dpInfo.Jars = append(dpInfo.Jars, j.PrebuiltSrcs()...)
2351}
2352
2353func (j *Import) IDECustomizedModuleName() string {
2354 // TODO(b/113562217): Extract the base module name from the Import name, often the Import name
2355 // has a prefix "prebuilt_". Remove the prefix explicitly if needed until we find a better
2356 // solution to get the Import name.
Ulya Trafimovich497a0932021-07-14 16:35:33 +01002357 return android.RemoveOptionalPrebuiltPrefix(j.Name())
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002358}
2359
Colin Cross74d73e22017-08-02 11:05:49 -07002360var _ android.PrebuiltInterface = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07002361
Bill Peckhamff89ffa2020-12-23 16:13:04 -08002362func (j *Import) IsInstallable() bool {
2363 return Bool(j.properties.Installable)
2364}
2365
Jiakai Zhang519c5c82021-09-16 06:15:39 +00002366var _ DexpreopterInterface = (*Import)(nil)
Bill Peckhamff89ffa2020-12-23 16:13:04 -08002367
Colin Cross1b16b0e2019-02-12 14:41:32 -08002368// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library module.
2369//
2370// By default, a java_import has a single variant that expects a `.jar` file containing `.class` files that were
2371// compiled against an Android classpath.
2372//
2373// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
2374// for host modules.
Colin Cross74d73e22017-08-02 11:05:49 -07002375func ImportFactory() android.Module {
2376 module := &Import{}
Colin Cross36242852017-06-23 15:06:31 -07002377
Liz Kammerd6c31d22020-08-05 15:40:41 -07002378 module.AddProperties(
2379 &module.properties,
2380 &module.dexer.dexProperties,
Jiakai Zhang9c4dc192023-02-09 00:09:24 +08002381 &module.importDexpreoptProperties,
Liz Kammerd6c31d22020-08-05 15:40:41 -07002382 )
Colin Cross74d73e22017-08-02 11:05:49 -07002383
Paul Duffin71b33cc2021-06-23 11:39:47 +01002384 module.initModuleAndImport(module)
Paul Duffin859fe962020-05-15 10:20:31 +01002385
Liz Kammerd6c31d22020-08-05 15:40:41 -07002386 module.dexProperties.Optimize.EnabledByDefault = false
2387
Colin Cross74d73e22017-08-02 11:05:49 -07002388 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002389 android.InitApexModule(module)
Romain Jobredeaux428a3662022-01-28 11:12:52 -05002390 android.InitBazelModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002391 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross36242852017-06-23 15:06:31 -07002392 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002393}
2394
Colin Cross1b16b0e2019-02-12 14:41:32 -08002395// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library_host
2396// module.
2397//
2398// A java_import_host has a single variant that expects a `.jar` file containing `.class` files that were
2399// compiled against a host bootclasspath.
Colin Cross74d73e22017-08-02 11:05:49 -07002400func ImportFactoryHost() android.Module {
2401 module := &Import{}
2402
2403 module.AddProperties(&module.properties)
2404
2405 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002406 android.InitApexModule(module)
Sam Delmerico5f83b492022-02-28 18:50:56 +00002407 android.InitBazelModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002408 InitJavaModule(module, android.HostSupported)
Colin Cross74d73e22017-08-02 11:05:49 -07002409 return module
2410}
2411
Colin Cross42be7612019-02-21 18:12:14 -08002412// dex_import module
2413
2414type DexImportProperties struct {
Colin Cross5cfc70d2019-07-15 13:36:55 -07002415 Jars []string `android:"path"`
Jiyong Park4c4c0242019-10-21 14:53:15 +09002416
2417 // set the name of the output
2418 Stem *string
Colin Cross42be7612019-02-21 18:12:14 -08002419}
2420
2421type DexImport struct {
2422 android.ModuleBase
2423 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002424 android.ApexModuleBase
Colin Cross42be7612019-02-21 18:12:14 -08002425 prebuilt android.Prebuilt
2426
2427 properties DexImportProperties
2428
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01002429 dexJarFile OptionalDexJarPath
Colin Cross42be7612019-02-21 18:12:14 -08002430
2431 dexpreopter
Colin Cross56a83212020-09-15 18:30:11 -07002432
2433 hideApexVariantFromMake bool
Colin Cross42be7612019-02-21 18:12:14 -08002434}
2435
2436func (j *DexImport) Prebuilt() *android.Prebuilt {
2437 return &j.prebuilt
2438}
2439
2440func (j *DexImport) PrebuiltSrcs() []string {
2441 return j.properties.Jars
2442}
2443
2444func (j *DexImport) Name() string {
2445 return j.prebuilt.Name(j.ModuleBase.Name())
2446}
2447
Jiyong Park0b238752019-10-29 11:23:10 +09002448func (j *DexImport) Stem() string {
2449 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
2450}
2451
Jiyong Park77acec62020-06-01 21:39:15 +09002452func (a *DexImport) JacocoReportClassesFile() android.Path {
2453 return nil
2454}
2455
Colin Cross08dca382020-07-21 20:31:17 -07002456func (a *DexImport) LintDepSets() LintDepSets {
2457 return LintDepSets{}
2458}
2459
Martin Stjernholm6d415272020-01-31 17:10:36 +00002460func (j *DexImport) IsInstallable() bool {
2461 return true
2462}
2463
Jaewoong Jung476b9d62021-05-10 15:30:00 -07002464func (j *DexImport) getStrictUpdatabilityLinting() bool {
2465 return false
2466}
2467
2468func (j *DexImport) setStrictUpdatabilityLinting(bool) {
2469}
2470
Colin Cross42be7612019-02-21 18:12:14 -08002471func (j *DexImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2472 if len(j.properties.Jars) != 1 {
2473 ctx.PropertyErrorf("jars", "exactly one jar must be provided")
2474 }
2475
Colin Cross56a83212020-09-15 18:30:11 -07002476 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2477 if !apexInfo.IsForPlatform() {
2478 j.hideApexVariantFromMake = true
2479 }
2480
Jiakai Zhang519c5c82021-09-16 06:15:39 +00002481 j.dexpreopter.installPath = j.dexpreopter.getInstallPath(
2482 ctx, android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar"))
Colin Cross42be7612019-02-21 18:12:14 -08002483 j.dexpreopter.uncompressedDex = shouldUncompressDex(ctx, &j.dexpreopter)
2484
2485 inputJar := ctx.ExpandSource(j.properties.Jars[0], "jars")
2486 dexOutputFile := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar")
2487
2488 if j.dexpreopter.uncompressedDex {
Colin Crossf1a035e2020-11-16 17:32:30 -08002489 rule := android.NewRuleBuilder(pctx, ctx)
Colin Cross42be7612019-02-21 18:12:14 -08002490
2491 temporary := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar.unaligned")
2492 rule.Temporary(temporary)
2493
2494 // use zip2zip to uncompress classes*.dex files
2495 rule.Command().
Colin Crossf1a035e2020-11-16 17:32:30 -08002496 BuiltTool("zip2zip").
Colin Cross42be7612019-02-21 18:12:14 -08002497 FlagWithInput("-i ", inputJar).
2498 FlagWithOutput("-o ", temporary).
2499 FlagWithArg("-0 ", "'classes*.dex'")
2500
2501 // use zipalign to align uncompressed classes*.dex files
2502 rule.Command().
Colin Crossf1a035e2020-11-16 17:32:30 -08002503 BuiltTool("zipalign").
Colin Cross42be7612019-02-21 18:12:14 -08002504 Flag("-f").
2505 Text("4").
2506 Input(temporary).
2507 Output(dexOutputFile)
2508
2509 rule.DeleteTemporaryFiles()
2510
Colin Crossf1a035e2020-11-16 17:32:30 -08002511 rule.Build("uncompress_dex", "uncompress dex")
Colin Cross42be7612019-02-21 18:12:14 -08002512 } else {
2513 ctx.Build(pctx, android.BuildParams{
2514 Rule: android.Cp,
2515 Input: inputJar,
2516 Output: dexOutputFile,
2517 })
2518 }
2519
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01002520 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Colin Cross42be7612019-02-21 18:12:14 -08002521
Jaewoong Jung4b97a562020-12-17 09:43:28 -08002522 j.dexpreopt(ctx, dexOutputFile)
Colin Cross42be7612019-02-21 18:12:14 -08002523
Colin Cross56a83212020-09-15 18:30:11 -07002524 if apexInfo.IsForPlatform() {
Jiyong Park01bca752020-06-08 19:24:09 +09002525 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
2526 j.Stem()+".jar", dexOutputFile)
2527 }
Colin Cross42be7612019-02-21 18:12:14 -08002528}
2529
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01002530func (j *DexImport) DexJarBuildPath() OptionalDexJarPath {
Colin Cross42be7612019-02-21 18:12:14 -08002531 return j.dexJarFile
2532}
2533
Jiyong Park45bf82e2020-12-15 22:29:02 +09002534var _ android.ApexModule = (*DexImport)(nil)
2535
2536// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07002537func (j *DexImport) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
2538 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09002539 // we don't check prebuilt modules for sdk_version
2540 return nil
2541}
2542
Colin Cross42be7612019-02-21 18:12:14 -08002543// dex_import imports a `.jar` file containing classes.dex files.
2544//
2545// A dex_import module cannot be used as a dependency of a java_* or android_* module, it can only be installed
2546// to the device.
2547func DexImportFactory() android.Module {
2548 module := &DexImport{}
2549
2550 module.AddProperties(&module.properties)
2551
2552 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002553 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002554 InitJavaModule(module, android.DeviceSupported)
Colin Cross42be7612019-02-21 18:12:14 -08002555 return module
2556}
2557
Colin Cross89536d42017-07-07 14:35:50 -07002558// Defaults
Colin Cross89536d42017-07-07 14:35:50 -07002559type Defaults struct {
2560 android.ModuleBase
2561 android.DefaultsModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002562 android.ApexModuleBase
Colin Cross89536d42017-07-07 14:35:50 -07002563}
2564
Colin Cross1b16b0e2019-02-12 14:41:32 -08002565// java_defaults provides a set of properties that can be inherited by other java or android modules.
2566//
2567// A module can use the properties from a java_defaults module using `defaults: ["defaults_module_name"]`. Each
2568// property in the defaults module that exists in the depending module will be prepended to the depending module's
2569// value for that property.
2570//
2571// Example:
2572//
Sam Delmerico277795c2022-02-25 17:04:37 +00002573// java_defaults {
2574// name: "example_defaults",
2575// srcs: ["common/**/*.java"],
2576// javacflags: ["-Xlint:all"],
2577// aaptflags: ["--auto-add-overlay"],
2578// }
Colin Cross1b16b0e2019-02-12 14:41:32 -08002579//
Sam Delmerico277795c2022-02-25 17:04:37 +00002580// java_library {
2581// name: "example",
2582// defaults: ["example_defaults"],
2583// srcs: ["example/**/*.java"],
2584// }
Colin Cross1b16b0e2019-02-12 14:41:32 -08002585//
2586// is functionally identical to:
2587//
Sam Delmerico277795c2022-02-25 17:04:37 +00002588// java_library {
2589// name: "example",
2590// srcs: [
2591// "common/**/*.java",
2592// "example/**/*.java",
2593// ],
2594// javacflags: ["-Xlint:all"],
2595// }
Paul Duffin47357662019-12-05 14:07:14 +00002596func DefaultsFactory() android.Module {
Colin Cross89536d42017-07-07 14:35:50 -07002597 module := &Defaults{}
2598
Colin Cross89536d42017-07-07 14:35:50 -07002599 module.AddProperties(
Jaewoong Jungbc15e3a2021-03-10 17:02:43 -08002600 &CommonProperties{},
2601 &DeviceProperties{},
Jooyung Han01d80d82022-01-08 12:16:32 +09002602 &OverridableDeviceProperties{},
Liz Kammera7a64f32020-07-09 15:16:41 -07002603 &DexProperties{},
Colin Cross43f08db2018-11-12 10:13:39 -08002604 &DexpreoptProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08002605 &android.ProtoProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002606 &aaptProperties{},
2607 &androidLibraryProperties{},
2608 &appProperties{},
2609 &appTestProperties{},
Jaewoong Jung525443a2019-02-28 15:35:54 -08002610 &overridableAppProperties{},
Kun Niubd0fd202023-05-23 17:51:44 +00002611 &hostTestProperties{},
Roland Levillainb5b0ff32020-02-04 15:45:49 +00002612 &testProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002613 &ImportProperties{},
2614 &AARImportProperties{},
2615 &sdkLibraryProperties{},
Paul Duffin1b1e8062020-05-08 13:44:43 +01002616 &commonToSdkLibraryAndImportProperties{},
Colin Cross42be7612019-02-21 18:12:14 -08002617 &DexImportProperties{},
Jooyung Han18020ea2019-11-13 10:50:48 +09002618 &android.ApexProperties{},
Jaewoong Jungbf135462020-04-26 15:10:51 -07002619 &RuntimeResourceOverlayProperties{},
Colin Cross014489c2020-06-02 20:09:13 -07002620 &LintProperties{},
Colin Crosscbce0b02021-02-09 10:38:30 -08002621 &appTestHelperAppProperties{},
Jihoon Kang1c51f502023-01-09 23:42:40 +00002622 &JavaApiLibraryProperties{},
Colin Cross89536d42017-07-07 14:35:50 -07002623 )
2624
2625 android.InitDefaultsModule(module)
Colin Cross89536d42017-07-07 14:35:50 -07002626 return module
2627}
Nan Zhangea568a42017-11-08 21:20:04 -08002628
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002629func kytheExtractJavaFactory() android.Singleton {
2630 return &kytheExtractJavaSingleton{}
2631}
2632
2633type kytheExtractJavaSingleton struct {
2634}
2635
2636func (ks *kytheExtractJavaSingleton) GenerateBuildActions(ctx android.SingletonContext) {
2637 var xrefTargets android.Paths
2638 ctx.VisitAllModules(func(module android.Module) {
2639 if javaModule, ok := module.(xref); ok {
2640 xrefTargets = append(xrefTargets, javaModule.XrefJavaFiles()...)
2641 }
2642 })
2643 // TODO(asmundak): perhaps emit a rule to output a warning if there were no xrefTargets
2644 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07002645 ctx.Phony("xref_java", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002646 }
2647}
2648
Nan Zhangea568a42017-11-08 21:20:04 -08002649var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07002650var BoolDefault = proptools.BoolDefault
Nan Zhangea568a42017-11-08 21:20:04 -08002651var String = proptools.String
Colin Cross0d0ba592018-02-20 13:33:42 -08002652var inList = android.InList
Ulya Trafimovich65b03192020-12-03 16:50:22 +00002653
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00002654// Add class loader context (CLC) of a given dependency to the current CLC.
2655func addCLCFromDep(ctx android.ModuleContext, depModule android.Module,
2656 clcMap dexpreopt.ClassLoaderContextMap) {
2657
2658 dep, ok := depModule.(UsesLibraryDependency)
2659 if !ok {
2660 return
2661 }
2662
Ulya Trafimovich840efb62021-07-15 14:34:40 +01002663 depName := android.RemoveOptionalPrebuiltPrefix(ctx.OtherModuleName(depModule))
2664
2665 var sdkLib *string
2666 if lib, ok := depModule.(SdkLibraryDependency); ok && lib.sharedLibrary() {
2667 // A shared SDK library. This should be added as a top-level CLC element.
2668 sdkLib = &depName
2669 } else if ulib, ok := depModule.(ProvidesUsesLib); ok {
2670 // A non-SDK library disguised as an SDK library by the means of `provides_uses_lib`
2671 // property. This should be handled in the same way as a shared SDK library.
2672 sdkLib = ulib.ProvidesUsesLib()
Ulya Trafimovich65b03192020-12-03 16:50:22 +00002673 }
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00002674
2675 depTag := ctx.OtherModuleDependencyTag(depModule)
Liz Kammeref28a4c2022-09-23 16:50:56 -04002676 if IsLibDepTag(depTag) {
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00002677 // Ok, propagate <uses-library> through non-static library dependencies.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +01002678 } else if tag, ok := depTag.(usesLibraryDependencyTag); ok && tag.sdkVersion == dexpreopt.AnySdkVersion {
2679 // Ok, propagate <uses-library> through non-compatibility <uses-library> dependencies.
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00002680 } else if depTag == staticLibTag {
2681 // Propagate <uses-library> through static library dependencies, unless it is a component
2682 // library (such as stubs). Component libraries have a dependency on their SDK library,
2683 // which should not be pulled just because of a static component library.
Ulya Trafimovich840efb62021-07-15 14:34:40 +01002684 if sdkLib != nil {
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00002685 return
2686 }
2687 } else {
2688 // Don't propagate <uses-library> for other dependency tags.
2689 return
2690 }
2691
Ulya Trafimovich840efb62021-07-15 14:34:40 +01002692 // If this is an SDK (or SDK-like) library, then it should be added as a node in the CLC tree,
2693 // and its CLC should be added as subtree of that node. Otherwise the library is not a
2694 // <uses_library> and should not be added to CLC, but the transitive <uses-library> dependencies
2695 // from its CLC should be added to the current CLC.
2696 if sdkLib != nil {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +01002697 clcMap.AddContext(ctx, dexpreopt.AnySdkVersion, *sdkLib, false,
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01002698 dep.DexJarBuildPath().PathOrNil(), dep.DexJarInstallPath(), dep.ClassLoaderContexts())
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00002699 } else {
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00002700 clcMap.AddContextMap(dep.ClassLoaderContexts(), depName)
2701 }
Ulya Trafimovich65b03192020-12-03 16:50:22 +00002702}
Wei Libafb6d62021-12-10 03:14:59 -08002703
Sam Delmerico79985812022-03-23 20:20:42 +00002704type javaResourcesAttributes struct {
2705 Resources bazel.LabelListAttribute
2706 Resource_strip_prefix *string
2707}
2708
Alixb29a3cd2023-05-09 20:37:49 +00002709func (m *Library) javaResourcesGetSingleFilegroupStripPrefix(ctx android.TopDownMutatorContext) (string, bool) {
2710 if otherM, ok := ctx.ModuleFromName(m.properties.Java_resources[0]); ok && len(m.properties.Java_resources) == 1 {
2711 if fg, isFilegroup := otherM.(android.FileGroupPath); isFilegroup {
2712 return filepath.Join(ctx.OtherModuleDir(otherM), fg.GetPath(ctx)), true
2713 }
2714 }
2715 return "", false
2716}
2717
Sam Delmerico79985812022-03-23 20:20:42 +00002718func (m *Library) convertJavaResourcesAttributes(ctx android.TopDownMutatorContext) *javaResourcesAttributes {
2719 var resources bazel.LabelList
2720 var resourceStripPrefix *string
2721
Romain Jobredeauxd5fe1332023-05-04 14:54:45 -04002722 if m.properties.Java_resources != nil && len(m.properties.Java_resource_dirs) > 0 {
2723 ctx.ModuleErrorf("bp2build doesn't support both java_resources and java_resource_dirs being set on the same module.")
2724 }
2725
Sam Delmerico79985812022-03-23 20:20:42 +00002726 if m.properties.Java_resources != nil {
Alixb29a3cd2023-05-09 20:37:49 +00002727 if prefix, ok := m.javaResourcesGetSingleFilegroupStripPrefix(ctx); ok {
2728 resourceStripPrefix = proptools.StringPtr(prefix)
2729 } else {
2730 resourceStripPrefix = proptools.StringPtr(ctx.ModuleDir())
2731 }
Sam Delmerico79985812022-03-23 20:20:42 +00002732 resources.Append(android.BazelLabelForModuleSrc(ctx, m.properties.Java_resources))
2733 }
2734
Paul Duffin7ed6ff82022-11-21 10:57:30 +00002735 //TODO(b/179889880) handle case where glob includes files outside package
Sam Delmerico79985812022-03-23 20:20:42 +00002736 resDeps := ResourceDirsToFiles(
2737 ctx,
2738 m.properties.Java_resource_dirs,
2739 m.properties.Exclude_java_resource_dirs,
2740 m.properties.Exclude_java_resources,
2741 )
2742
2743 for i, resDep := range resDeps {
2744 dir, files := resDep.dir, resDep.files
2745
2746 resources.Append(bazel.MakeLabelList(android.RootToModuleRelativePaths(ctx, files)))
2747
2748 // Bazel includes the relative path from the WORKSPACE root when placing the resource
2749 // inside the JAR file, so we need to remove that prefix
2750 resourceStripPrefix = proptools.StringPtr(dir.String())
2751 if i > 0 {
2752 // TODO(b/226423379) allow multiple resource prefixes
2753 ctx.ModuleErrorf("bp2build does not support more than one directory in java_resource_dirs (b/226423379)")
2754 }
2755 }
2756
2757 return &javaResourcesAttributes{
2758 Resources: bazel.MakeLabelListAttribute(resources),
2759 Resource_strip_prefix: resourceStripPrefix,
2760 }
2761}
2762
Sam Delmericoc0161432022-02-25 21:34:51 +00002763type javaCommonAttributes struct {
Sam Delmerico79985812022-03-23 20:20:42 +00002764 *javaResourcesAttributes
Alix75db7842023-03-06 22:08:49 +00002765 *kotlinAttributes
Romain Jobredeaux2eef2e12023-02-24 12:07:08 -05002766 Srcs bazel.LabelListAttribute
2767 Plugins bazel.LabelListAttribute
2768 Javacopts bazel.StringListAttribute
2769 Sdk_version bazel.StringAttribute
2770 Java_version bazel.StringAttribute
Wei Libafb6d62021-12-10 03:14:59 -08002771}
2772
Sam Delmericoc0161432022-02-25 21:34:51 +00002773type javaDependencyLabels struct {
2774 // Dependencies which DO NOT contribute to the API visible to upstream dependencies.
2775 Deps bazel.LabelListAttribute
2776 // Dependencies which DO contribute to the API visible to upstream dependencies.
2777 StaticDeps bazel.LabelListAttribute
2778}
2779
Sam Delmerico24da73c2022-03-16 20:36:54 +00002780type eventLogTagsAttributes struct {
2781 Srcs bazel.LabelListAttribute
2782}
2783
Sam Delmerico97bd1272022-08-25 14:45:31 -04002784type aidlLibraryAttributes struct {
2785 Srcs bazel.LabelListAttribute
Liz Kammer2b3f56e2023-03-23 11:51:49 -04002786 Tags bazel.StringListAttribute
Sam Delmerico97bd1272022-08-25 14:45:31 -04002787}
2788
2789type javaAidlLibraryAttributes struct {
2790 Deps bazel.LabelListAttribute
Liz Kammer2b3f56e2023-03-23 11:51:49 -04002791 Tags bazel.StringListAttribute
Sam Delmerico97bd1272022-08-25 14:45:31 -04002792}
2793
Alix8062f4d2022-11-14 21:38:07 +00002794// bp2BuildJavaInfo has information needed for the conversion of java*_modules
2795// that is needed bor Bp2Build conversion but that requires different handling
2796// depending on the module type.
2797type bp2BuildJavaInfo struct {
2798 // separates dependencies into dynamic dependencies and static dependencies.
Alix75db7842023-03-06 22:08:49 +00002799 DepLabels *javaDependencyLabels
2800 hasKotlin bool
Alix8062f4d2022-11-14 21:38:07 +00002801}
2802
2803// convertLibraryAttrsBp2Build returns a javaCommonAttributes struct with
2804// converted attributes shared across java_* modules and a bp2BuildJavaInfo struct
2805// which has other non-attribute information needed for bp2build conversion
2806// that needs different handling depending on the module types, and thus needs
2807// to be returned to the calling function.
2808func (m *Library) convertLibraryAttrsBp2Build(ctx android.TopDownMutatorContext) (*javaCommonAttributes, *bp2BuildJavaInfo) {
Sam Delmericoe91d0302022-02-23 15:28:33 +00002809 var srcs bazel.LabelListAttribute
Alix495cc8a2023-01-12 18:20:32 +00002810 var deps bazel.LabelListAttribute
Sam Delmerico97bd1272022-08-25 14:45:31 -04002811 var staticDeps bazel.LabelList
2812
Sam Delmericoe91d0302022-02-23 15:28:33 +00002813 archVariantProps := m.GetArchVariantProperties(ctx, &CommonProperties{})
2814 for axis, configToProps := range archVariantProps {
2815 for config, _props := range configToProps {
2816 if archProps, ok := _props.(*CommonProperties); ok {
2817 archSrcs := android.BazelLabelForModuleSrcExcludes(ctx, archProps.Srcs, archProps.Exclude_srcs)
2818 srcs.SetSelectValue(axis, config, archSrcs)
2819 }
2820 }
2821 }
Romain Jobredeaux3eaf7472023-03-08 16:34:17 -05002822 srcs.ResolveExcludes()
Sam Delmericoc7681022022-02-04 21:01:20 +00002823
2824 javaSrcPartition := "java"
2825 protoSrcPartition := "proto"
Sam Delmerico24da73c2022-03-16 20:36:54 +00002826 logtagSrcPartition := "logtag"
Sam Delmerico97bd1272022-08-25 14:45:31 -04002827 aidlSrcPartition := "aidl"
Alix8062f4d2022-11-14 21:38:07 +00002828 kotlinPartition := "kotlin"
Sam Delmericoc7681022022-02-04 21:01:20 +00002829 srcPartitions := bazel.PartitionLabelListAttribute(ctx, &srcs, bazel.LabelPartitions{
Sam Delmerico24da73c2022-03-16 20:36:54 +00002830 javaSrcPartition: bazel.LabelPartition{Extensions: []string{".java"}, Keep_remainder: true},
2831 logtagSrcPartition: bazel.LabelPartition{Extensions: []string{".logtags", ".logtag"}},
2832 protoSrcPartition: android.ProtoSrcLabelPartition,
Sam Delmerico97bd1272022-08-25 14:45:31 -04002833 aidlSrcPartition: android.AidlSrcLabelPartition,
Alix8062f4d2022-11-14 21:38:07 +00002834 kotlinPartition: bazel.LabelPartition{Extensions: []string{".kt"}},
Sam Delmericoc7681022022-02-04 21:01:20 +00002835 })
2836
Sam Delmerico24da73c2022-03-16 20:36:54 +00002837 javaSrcs := srcPartitions[javaSrcPartition]
Alix8062f4d2022-11-14 21:38:07 +00002838 kotlinSrcs := srcPartitions[kotlinPartition]
2839 javaSrcs.Append(kotlinSrcs)
Sam Delmerico24da73c2022-03-16 20:36:54 +00002840
Sam Delmerico24da73c2022-03-16 20:36:54 +00002841 if !srcPartitions[logtagSrcPartition].IsEmpty() {
2842 logtagsLibName := m.Name() + "_logtags"
Sam Delmerico24da73c2022-03-16 20:36:54 +00002843 ctx.CreateBazelTargetModule(
2844 bazel.BazelTargetModuleProperties{
2845 Rule_class: "event_log_tags",
Sam Delmerico48af73b2022-04-05 14:03:11 +00002846 Bzl_load_location: "//build/bazel/rules/java:event_log_tags.bzl",
Sam Delmerico24da73c2022-03-16 20:36:54 +00002847 },
2848 android.CommonAttributes{Name: logtagsLibName},
2849 &eventLogTagsAttributes{
2850 Srcs: srcPartitions[logtagSrcPartition],
2851 },
2852 )
Sam Delmerico97bd1272022-08-25 14:45:31 -04002853
2854 logtagsSrcs := bazel.MakeLabelList([]bazel.Label{{Label: ":" + logtagsLibName}})
2855 javaSrcs.Append(bazel.MakeLabelListAttribute(logtagsSrcs))
Sam Delmerico24da73c2022-03-16 20:36:54 +00002856 }
Sam Delmerico97bd1272022-08-25 14:45:31 -04002857
2858 if !srcPartitions[aidlSrcPartition].IsEmpty() {
2859 aidlLibs, aidlSrcs := srcPartitions[aidlSrcPartition].Partition(func(src bazel.Label) bool {
2860 return android.IsConvertedToAidlLibrary(ctx, src.OriginalModuleName)
2861 })
2862
Spandan Das39b6cc52023-04-12 19:05:49 +00002863 apexAvailableTags := android.ApexAvailableTagsWithoutTestApexes(ctx, ctx.Module())
Liz Kammer2b3f56e2023-03-23 11:51:49 -04002864
Sam Delmerico97bd1272022-08-25 14:45:31 -04002865 if !aidlSrcs.IsEmpty() {
2866 aidlLibName := m.Name() + "_aidl_library"
2867 ctx.CreateBazelTargetModule(
2868 bazel.BazelTargetModuleProperties{
2869 Rule_class: "aidl_library",
Sam Delmericoe55bf082023-03-31 09:47:28 -04002870 Bzl_load_location: "//build/bazel/rules/aidl:aidl_library.bzl",
Sam Delmerico97bd1272022-08-25 14:45:31 -04002871 },
2872 android.CommonAttributes{Name: aidlLibName},
2873 &aidlLibraryAttributes{
2874 Srcs: aidlSrcs,
Liz Kammer2b3f56e2023-03-23 11:51:49 -04002875 Tags: apexAvailableTags,
Sam Delmerico97bd1272022-08-25 14:45:31 -04002876 },
2877 )
2878 aidlLibs.Add(&bazel.LabelAttribute{Value: &bazel.Label{Label: ":" + aidlLibName}})
2879 }
2880
2881 javaAidlLibName := m.Name() + "_java_aidl_library"
2882 ctx.CreateBazelTargetModule(
2883 bazel.BazelTargetModuleProperties{
2884 Rule_class: "java_aidl_library",
Sam Delmericoe55bf082023-03-31 09:47:28 -04002885 Bzl_load_location: "//build/bazel/rules/java:java_aidl_library.bzl",
Sam Delmerico97bd1272022-08-25 14:45:31 -04002886 },
2887 android.CommonAttributes{Name: javaAidlLibName},
2888 &javaAidlLibraryAttributes{
2889 Deps: aidlLibs,
Liz Kammer2b3f56e2023-03-23 11:51:49 -04002890 Tags: apexAvailableTags,
Sam Delmerico97bd1272022-08-25 14:45:31 -04002891 },
2892 )
2893
2894 staticDeps.Add(&bazel.Label{Label: ":" + javaAidlLibName})
2895 }
Sam Delmerico24da73c2022-03-16 20:36:54 +00002896
Sam Delmerico58614c02022-03-15 21:02:09 +00002897 var javacopts []string
2898 if m.properties.Javacflags != nil {
2899 javacopts = append(javacopts, m.properties.Javacflags...)
2900 }
Vinh Tran3ac6daf2022-04-22 19:09:58 -04002901
Sam Delmerico58614c02022-03-15 21:02:09 +00002902 epEnabled := m.properties.Errorprone.Enabled
Paul Duffin7ed6ff82022-11-21 10:57:30 +00002903 //TODO(b/227504307) add configuration that depends on RUN_ERROR_PRONE environment variable
Sam Delmerico58614c02022-03-15 21:02:09 +00002904 if Bool(epEnabled) {
2905 javacopts = append(javacopts, m.properties.Errorprone.Javacflags...)
2906 }
2907
Sam Delmericoc0161432022-02-25 21:34:51 +00002908 commonAttrs := &javaCommonAttributes{
Sam Delmerico79985812022-03-23 20:20:42 +00002909 Srcs: javaSrcs,
2910 javaResourcesAttributes: m.convertJavaResourcesAttributes(ctx),
Sam Delmerico77267c72022-03-18 14:11:07 +00002911 Plugins: bazel.MakeLabelListAttribute(
2912 android.BazelLabelForModuleDeps(ctx, m.properties.Plugins),
2913 ),
Romain Jobredeaux2eef2e12023-02-24 12:07:08 -05002914 Javacopts: bazel.MakeStringListAttribute(javacopts),
2915 Java_version: bazel.StringAttribute{Value: m.properties.Java_version},
2916 Sdk_version: bazel.StringAttribute{Value: m.deviceProperties.Sdk_version},
Wei Libafb6d62021-12-10 03:14:59 -08002917 }
2918
Alix495cc8a2023-01-12 18:20:32 +00002919 for axis, configToProps := range archVariantProps {
2920 for config, _props := range configToProps {
2921 if archProps, ok := _props.(*CommonProperties); ok {
2922 var libLabels []bazel.Label
2923 for _, d := range archProps.Libs {
2924 neverlinkLabel := android.BazelLabelForModuleDepSingle(ctx, d)
2925 neverlinkLabel.Label = neverlinkLabel.Label + "-neverlink"
2926 libLabels = append(libLabels, neverlinkLabel)
2927 }
2928 deps.SetSelectValue(axis, config, bazel.MakeLabelList(libLabels))
2929 }
Alixb4e09a02022-09-27 15:36:01 +00002930 }
Wei Libafb6d62021-12-10 03:14:59 -08002931 }
Sam Delmericoc0161432022-02-25 21:34:51 +00002932
Sam Delmericoc0161432022-02-25 21:34:51 +00002933 protoDepLabel := bp2buildProto(ctx, &m.Module, srcPartitions[protoSrcPartition])
2934 // Soong does not differentiate between a java_library and the Bazel equivalent of
2935 // a java_proto_library + proto_library pair. Instead, in Soong proto sources are
2936 // listed directly in the srcs of a java_library, and the classes produced
2937 // by protoc are included directly in the resulting JAR. Thus upstream dependencies
2938 // that depend on a java_library with proto sources can link directly to the protobuf API,
2939 // and so this should be a static dependency.
2940 staticDeps.Add(protoDepLabel)
Sam Delmericoc7681022022-02-04 21:01:20 +00002941
Sam Delmerico97bd1272022-08-25 14:45:31 -04002942 depLabels := &javaDependencyLabels{}
Alix495cc8a2023-01-12 18:20:32 +00002943 depLabels.Deps = deps
Romain Jobredeauxeb711b92023-04-03 22:53:34 -04002944
2945 for axis, configToProps := range archVariantProps {
2946 for config, _props := range configToProps {
2947 if archProps, ok := _props.(*CommonProperties); ok {
2948 archStaticLibs := android.BazelLabelForModuleDeps(
2949 ctx,
2950 android.LastUniqueStrings(android.CopyOf(archProps.Static_libs)))
2951 depLabels.StaticDeps.SetSelectValue(axis, config, archStaticLibs)
2952 }
2953 }
2954 }
2955 depLabels.StaticDeps.Value.Append(staticDeps)
Sam Delmericofde9fb52022-01-28 20:53:38 +00002956
Alix75db7842023-03-06 22:08:49 +00002957 hasKotlin := !kotlinSrcs.IsEmpty()
Alixf848bf82023-03-06 19:43:55 +00002958 commonAttrs.kotlinAttributes = &kotlinAttributes{
2959 Kotlincflags: &m.properties.Kotlincflags,
2960 }
Alix75db7842023-03-06 22:08:49 +00002961 if len(m.properties.Common_srcs) != 0 {
2962 hasKotlin = true
Alixf848bf82023-03-06 19:43:55 +00002963 commonAttrs.kotlinAttributes.Common_srcs = bazel.MakeLabelListAttribute(android.BazelLabelForModuleSrc(ctx, m.properties.Common_srcs))
Alix75db7842023-03-06 22:08:49 +00002964 }
2965
Alix8062f4d2022-11-14 21:38:07 +00002966 bp2BuildInfo := &bp2BuildJavaInfo{
Alix75db7842023-03-06 22:08:49 +00002967 DepLabels: depLabels,
2968 hasKotlin: hasKotlin,
Alix8062f4d2022-11-14 21:38:07 +00002969 }
2970
2971 return commonAttrs, bp2BuildInfo
Sam Delmericoc0161432022-02-25 21:34:51 +00002972}
2973
2974type javaLibraryAttributes struct {
2975 *javaCommonAttributes
Alix7c8eaeb2022-11-16 15:44:55 +00002976 Deps bazel.LabelListAttribute
2977 Exports bazel.LabelListAttribute
2978 Neverlink bazel.BoolAttribute
Sam Delmericofde9fb52022-01-28 20:53:38 +00002979}
2980
Alix75db7842023-03-06 22:08:49 +00002981type kotlinAttributes struct {
Alixf848bf82023-03-06 19:43:55 +00002982 Common_srcs bazel.LabelListAttribute
2983 Kotlincflags *[]string
Alix75db7842023-03-06 22:08:49 +00002984}
2985
Alix32540022023-03-16 21:06:13 +00002986func ktJvmLibraryBazelTargetModuleProperties() bazel.BazelTargetModuleProperties {
2987 return bazel.BazelTargetModuleProperties{
2988 Rule_class: "kt_jvm_library",
Alixa28acb52023-05-08 15:41:01 +00002989 Bzl_load_location: "//build/bazel/rules/kotlin:kt_jvm_library.bzl",
Alix32540022023-03-16 21:06:13 +00002990 }
2991}
2992
2993func javaLibraryBazelTargetModuleProperties() bazel.BazelTargetModuleProperties {
2994 return bazel.BazelTargetModuleProperties{
2995 Rule_class: "java_library",
Alix83a8bc42023-05-04 18:03:23 +00002996 Bzl_load_location: "//build/bazel/rules/java:library.bzl",
Alix32540022023-03-16 21:06:13 +00002997 }
2998}
2999
Sam Delmericofde9fb52022-01-28 20:53:38 +00003000func javaLibraryBp2Build(ctx android.TopDownMutatorContext, m *Library) {
Alix8062f4d2022-11-14 21:38:07 +00003001 commonAttrs, bp2BuildInfo := m.convertLibraryAttrsBp2Build(ctx)
3002 depLabels := bp2BuildInfo.DepLabels
Sam Delmericoc0161432022-02-25 21:34:51 +00003003
3004 deps := depLabels.Deps
3005 if !commonAttrs.Srcs.IsEmpty() {
3006 deps.Append(depLabels.StaticDeps) // we should only append these if there are sources to use them
Sam Delmerico97bd1272022-08-25 14:45:31 -04003007 } else if !deps.IsEmpty() {
Sam Delmericoc0161432022-02-25 21:34:51 +00003008 ctx.ModuleErrorf("Module has direct dependencies but no sources. Bazel will not allow this.")
3009 }
Alix8062f4d2022-11-14 21:38:07 +00003010 var props bazel.BazelTargetModuleProperties
Sam Delmericoc0161432022-02-25 21:34:51 +00003011 attrs := &javaLibraryAttributes{
3012 javaCommonAttributes: commonAttrs,
3013 Deps: deps,
3014 Exports: depLabels.StaticDeps,
3015 }
Alix341484b2022-10-31 19:08:18 +00003016 name := m.Name()
Wei Libafb6d62021-12-10 03:14:59 -08003017
Alix75db7842023-03-06 22:08:49 +00003018 if !bp2BuildInfo.hasKotlin {
Alix32540022023-03-16 21:06:13 +00003019 props = javaLibraryBazelTargetModuleProperties()
Alix8062f4d2022-11-14 21:38:07 +00003020 } else {
Alix32540022023-03-16 21:06:13 +00003021 props = ktJvmLibraryBazelTargetModuleProperties()
Wei Libafb6d62021-12-10 03:14:59 -08003022 }
3023
Alix266bbf22022-12-15 06:12:46 +00003024 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: name}, attrs)
3025 neverlinkProp := true
3026 neverLinkAttrs := &javaLibraryAttributes{
3027 Exports: bazel.MakeSingleLabelListAttribute(bazel.Label{Label: ":" + name}),
3028 Neverlink: bazel.BoolAttribute{Value: &neverlinkProp},
Romain Jobredeaux2eef2e12023-02-24 12:07:08 -05003029 javaCommonAttributes: &javaCommonAttributes{
3030 Sdk_version: bazel.StringAttribute{Value: m.deviceProperties.Sdk_version},
3031 Java_version: bazel.StringAttribute{Value: m.properties.Java_version},
3032 },
Alix266bbf22022-12-15 06:12:46 +00003033 }
3034 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: name + "-neverlink"}, neverLinkAttrs)
3035
Wei Libafb6d62021-12-10 03:14:59 -08003036}
3037
3038type javaBinaryHostAttributes struct {
Sam Delmericoc0161432022-02-25 21:34:51 +00003039 *javaCommonAttributes
3040 Deps bazel.LabelListAttribute
3041 Runtime_deps bazel.LabelListAttribute
3042 Main_class string
3043 Jvm_flags bazel.StringListAttribute
Wei Libafb6d62021-12-10 03:14:59 -08003044}
3045
3046// JavaBinaryHostBp2Build is for java_binary_host bp2build.
3047func javaBinaryHostBp2Build(ctx android.TopDownMutatorContext, m *Binary) {
Alix8062f4d2022-11-14 21:38:07 +00003048 commonAttrs, bp2BuildInfo := m.convertLibraryAttrsBp2Build(ctx)
3049 depLabels := bp2BuildInfo.DepLabels
Sam Delmericoc0161432022-02-25 21:34:51 +00003050
3051 deps := depLabels.Deps
3052 deps.Append(depLabels.StaticDeps)
3053 if m.binaryProperties.Jni_libs != nil {
3054 deps.Append(bazel.MakeLabelListAttribute(android.BazelLabelForModuleDeps(ctx, m.binaryProperties.Jni_libs)))
3055 }
3056
3057 var runtimeDeps bazel.LabelListAttribute
3058 if commonAttrs.Srcs.IsEmpty() {
3059 // if there are no sources, then the dependencies can only be used at runtime
3060 runtimeDeps = deps
3061 deps = bazel.LabelListAttribute{}
3062 }
3063
Wei Libafb6d62021-12-10 03:14:59 -08003064 mainClass := ""
3065 if m.binaryProperties.Main_class != nil {
3066 mainClass = *m.binaryProperties.Main_class
3067 }
3068 if m.properties.Manifest != nil {
3069 mainClassInManifest, err := android.GetMainClassInManifest(ctx.Config(), android.PathForModuleSrc(ctx, *m.properties.Manifest).String())
3070 if err != nil {
3071 return
3072 }
3073 mainClass = mainClassInManifest
3074 }
Sam Delmericoc0161432022-02-25 21:34:51 +00003075
Wei Libafb6d62021-12-10 03:14:59 -08003076 // Attribute jvm_flags
Alix7c8eaeb2022-11-16 15:44:55 +00003077 var jvmFlags bazel.StringListAttribute
Wei Libafb6d62021-12-10 03:14:59 -08003078 if m.binaryProperties.Jni_libs != nil {
3079 jniLibPackages := map[string]bool{}
3080 for _, jniLibLabel := range android.BazelLabelForModuleDeps(ctx, m.binaryProperties.Jni_libs).Includes {
3081 jniLibPackage := jniLibLabel.Label
3082 indexOfColon := strings.Index(jniLibLabel.Label, ":")
3083 if indexOfColon > 0 {
3084 // JNI lib from other package
3085 jniLibPackage = jniLibLabel.Label[2:indexOfColon]
3086 } else if indexOfColon == 0 {
3087 // JNI lib in the same package of java_binary
3088 packageOfCurrentModule := m.GetBazelLabel(ctx, m)
3089 jniLibPackage = packageOfCurrentModule[2:strings.Index(packageOfCurrentModule, ":")]
3090 }
3091 if _, inMap := jniLibPackages[jniLibPackage]; !inMap {
3092 jniLibPackages[jniLibPackage] = true
3093 }
3094 }
3095 jniLibPaths := []string{}
3096 for jniLibPackage, _ := range jniLibPackages {
3097 // See cs/f:.*/third_party/bazel/.*java_stub_template.txt for the use of RUNPATH
3098 jniLibPaths = append(jniLibPaths, "$${RUNPATH}"+jniLibPackage)
3099 }
Alix7c8eaeb2022-11-16 15:44:55 +00003100 jvmFlags = bazel.MakeStringListAttribute([]string{"-Djava.library.path=" + strings.Join(jniLibPaths, ":")})
Wei Libafb6d62021-12-10 03:14:59 -08003101 }
3102
3103 props := bazel.BazelTargetModuleProperties{
Alix82acaf52023-03-09 20:43:10 +00003104 Rule_class: "java_binary",
Alix83a8bc42023-05-04 18:03:23 +00003105 Bzl_load_location: "@rules_java//java:defs.bzl",
Wei Libafb6d62021-12-10 03:14:59 -08003106 }
Romain Jobredeauxf5f60732023-03-16 11:00:36 -04003107 binAttrs := &javaBinaryHostAttributes{
Alix7c8eaeb2022-11-16 15:44:55 +00003108 Runtime_deps: runtimeDeps,
3109 Main_class: mainClass,
3110 Jvm_flags: jvmFlags,
3111 }
3112
Romain Jobredeauxf5f60732023-03-16 11:00:36 -04003113 if commonAttrs.Srcs.IsEmpty() {
3114 binAttrs.javaCommonAttributes = commonAttrs
3115 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: m.Name()}, binAttrs)
3116 return
3117 }
3118
Zi Wang65b36722023-05-23 15:18:33 -07003119 libInfo := libraryCreationInfo{
3120 deps: deps,
3121 attrs: commonAttrs,
3122 baseName: m.Name(),
3123 hasKotlin: bp2BuildInfo.hasKotlin,
3124 }
3125 libName := createLibraryTarget(ctx, libInfo)
3126 binAttrs.Runtime_deps.Add(&bazel.LabelAttribute{Value: &bazel.Label{Label: ":" + libName}})
3127
3128 // Create the BazelTargetModule.
3129 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: m.Name()}, binAttrs)
3130}
3131
3132type javaTestHostAttributes struct {
3133 *javaCommonAttributes
3134 Deps bazel.LabelListAttribute
3135 Runtime_deps bazel.LabelListAttribute
3136}
3137
3138// javaTestHostBp2Build is for java_test_host bp2build.
3139func javaTestHostBp2Build(ctx android.TopDownMutatorContext, m *TestHost) {
3140 commonAttrs, bp2BuildInfo := m.convertLibraryAttrsBp2Build(ctx)
3141 depLabels := bp2BuildInfo.DepLabels
3142
3143 deps := depLabels.Deps
3144 deps.Append(depLabels.StaticDeps)
3145
3146 var runtimeDeps bazel.LabelListAttribute
3147 attrs := &javaTestHostAttributes{
3148 Runtime_deps: runtimeDeps,
3149 }
3150 props := bazel.BazelTargetModuleProperties{
3151 Rule_class: "java_test",
3152 Bzl_load_location: "//build/bazel/rules/java:test.bzl",
3153 }
3154
3155 if commonAttrs.Srcs.IsEmpty() {
3156 // if there are no sources, then the dependencies can only be used at runtime
3157 attrs.Runtime_deps = deps
3158 attrs.javaCommonAttributes = commonAttrs
3159 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: m.Name()}, attrs)
3160 return
3161 }
3162
3163 libInfo := libraryCreationInfo{
3164 deps: deps,
3165 attrs: commonAttrs,
3166 baseName: m.Name(),
3167 hasKotlin: bp2BuildInfo.hasKotlin,
3168 }
3169 libName := createLibraryTarget(ctx, libInfo)
3170 attrs.Runtime_deps.Add(&bazel.LabelAttribute{Value: &bazel.Label{Label: ":" + libName}})
3171
3172 // Create the BazelTargetModule.
3173 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: m.Name()}, attrs)
3174}
3175
3176// libraryCreationInfo encapsulates the info needed to create java_library target from
3177// java_binary_host or java_test_host.
3178type libraryCreationInfo struct {
3179 deps bazel.LabelListAttribute
3180 attrs *javaCommonAttributes
3181 baseName string
3182 hasKotlin bool
3183}
3184
3185// helper function that creates java_library target from java_binary_host or java_test_host,
3186// and returns the library target name,
3187func createLibraryTarget(ctx android.TopDownMutatorContext, libInfo libraryCreationInfo) string {
3188 libName := libInfo.baseName + "_lib"
Romain Jobredeauxf5f60732023-03-16 11:00:36 -04003189 var libProps bazel.BazelTargetModuleProperties
Zi Wang65b36722023-05-23 15:18:33 -07003190 if libInfo.hasKotlin {
Alix32540022023-03-16 21:06:13 +00003191 libProps = ktJvmLibraryBazelTargetModuleProperties()
Romain Jobredeauxf5f60732023-03-16 11:00:36 -04003192 } else {
Alix32540022023-03-16 21:06:13 +00003193 libProps = javaLibraryBazelTargetModuleProperties()
Romain Jobredeauxf5f60732023-03-16 11:00:36 -04003194 }
3195 libAttrs := &javaLibraryAttributes{
Zi Wang65b36722023-05-23 15:18:33 -07003196 Deps: libInfo.deps,
3197 javaCommonAttributes: libInfo.attrs,
Alix7c8eaeb2022-11-16 15:44:55 +00003198 }
Wei Libafb6d62021-12-10 03:14:59 -08003199
Romain Jobredeauxf5f60732023-03-16 11:00:36 -04003200 ctx.CreateBazelTargetModule(libProps, android.CommonAttributes{Name: libName}, libAttrs)
Zi Wang65b36722023-05-23 15:18:33 -07003201 return libName
Wei Libafb6d62021-12-10 03:14:59 -08003202}
Romain Jobredeaux428a3662022-01-28 11:12:52 -05003203
3204type bazelJavaImportAttributes struct {
Alixb4e09a02022-09-27 15:36:01 +00003205 Jars bazel.LabelListAttribute
3206 Exports bazel.LabelListAttribute
Romain Jobredeaux428a3662022-01-28 11:12:52 -05003207}
3208
3209// java_import bp2Build converter.
3210func (i *Import) ConvertWithBp2build(ctx android.TopDownMutatorContext) {
Sam Delmerico48983162022-02-22 21:41:33 +00003211 var jars bazel.LabelListAttribute
3212 archVariantProps := i.GetArchVariantProperties(ctx, &ImportProperties{})
3213 for axis, configToProps := range archVariantProps {
3214 for config, _props := range configToProps {
3215 if archProps, ok := _props.(*ImportProperties); ok {
3216 archJars := android.BazelLabelForModuleSrcExcludes(ctx, archProps.Jars, []string(nil))
3217 jars.SetSelectValue(axis, config, archJars)
3218 }
3219 }
3220 }
Romain Jobredeaux428a3662022-01-28 11:12:52 -05003221
3222 attrs := &bazelJavaImportAttributes{
3223 Jars: jars,
3224 }
Alix82acaf52023-03-09 20:43:10 +00003225 props := bazel.BazelTargetModuleProperties{
3226 Rule_class: "java_import",
Alix83a8bc42023-05-04 18:03:23 +00003227 Bzl_load_location: "//build/bazel/rules/java:import.bzl",
Alix82acaf52023-03-09 20:43:10 +00003228 }
Romain Jobredeaux428a3662022-01-28 11:12:52 -05003229
Alixb4e09a02022-09-27 15:36:01 +00003230 name := android.RemoveOptionalPrebuiltPrefix(i.Name())
3231
3232 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: name}, attrs)
3233
3234 neverlink := true
3235 neverlinkAttrs := &javaLibraryAttributes{
3236 Neverlink: bazel.BoolAttribute{Value: &neverlink},
3237 Exports: bazel.MakeSingleLabelListAttribute(bazel.Label{Label: ":" + name}),
Romain Jobredeaux2eef2e12023-02-24 12:07:08 -05003238 javaCommonAttributes: &javaCommonAttributes{
3239 Sdk_version: bazel.StringAttribute{Value: proptools.StringPtr("none")},
3240 },
Alixb4e09a02022-09-27 15:36:01 +00003241 }
Alix82acaf52023-03-09 20:43:10 +00003242 ctx.CreateBazelTargetModule(
Alix32540022023-03-16 21:06:13 +00003243 javaLibraryBazelTargetModuleProperties(),
Alix82acaf52023-03-09 20:43:10 +00003244 android.CommonAttributes{Name: name + "-neverlink"},
3245 neverlinkAttrs)
Alixb4e09a02022-09-27 15:36:01 +00003246
Sam Delmerico277795c2022-02-25 17:04:37 +00003247}
Romain Jobredeaux428a3662022-01-28 11:12:52 -05003248
Sam Delmerico277795c2022-02-25 17:04:37 +00003249var _ android.MixedBuildBuildable = (*Import)(nil)
3250
3251func (i *Import) getBazelModuleLabel(ctx android.BaseModuleContext) string {
3252 return android.RemoveOptionalPrebuiltPrefixFromBazelLabel(i.GetBazelLabel(ctx, i))
3253}
3254
3255func (i *Import) ProcessBazelQueryResponse(ctx android.ModuleContext) {
3256 i.commonBuildActions(ctx)
3257
3258 bazelCtx := ctx.Config().BazelContext
3259 filePaths, err := bazelCtx.GetOutputFiles(i.getBazelModuleLabel(ctx), android.GetConfigKey(ctx))
3260 if err != nil {
3261 ctx.ModuleErrorf(err.Error())
3262 return
3263 }
3264
3265 bazelJars := android.Paths{}
3266 for _, bazelOutputFile := range filePaths {
3267 bazelJars = append(bazelJars, android.PathForBazelOut(ctx, bazelOutputFile))
3268 }
3269
3270 jarName := android.RemoveOptionalPrebuiltPrefix(i.Name()) + ".jar"
3271 outputFile := android.PathForModuleOut(ctx, "bazelCombined", jarName)
3272 TransformJarsToJar(ctx, outputFile, "combine prebuilt jars", bazelJars,
3273 android.OptionalPath{}, // manifest
3274 false, // stripDirEntries
3275 []string{}, // filesToStrip
3276 []string{}, // dirsToStrip
3277 )
3278 i.combinedClasspathFile = outputFile
3279
3280 ctx.SetProvider(JavaInfoProvider, JavaInfo{
3281 HeaderJars: android.PathsIfNonNil(i.combinedClasspathFile),
3282 ImplementationAndResourcesJars: android.PathsIfNonNil(i.combinedClasspathFile),
3283 ImplementationJars: android.PathsIfNonNil(i.combinedClasspathFile),
Paul Duffin7ed6ff82022-11-21 10:57:30 +00003284 //TODO(b/240308299) include AIDL information from Bazel
Sam Delmerico277795c2022-02-25 17:04:37 +00003285 })
3286
3287 i.maybeInstall(ctx, jarName, outputFile)
3288}
3289
3290func (i *Import) QueueBazelCall(ctx android.BaseModuleContext) {
3291 bazelCtx := ctx.Config().BazelContext
3292 bazelCtx.QueueBazelRequest(i.getBazelModuleLabel(ctx), cquery.GetOutputFiles, android.GetConfigKey(ctx))
3293}
3294
3295func (i *Import) IsMixedBuildSupported(ctx android.BaseModuleContext) bool {
3296 return true
Romain Jobredeaux428a3662022-01-28 11:12:52 -05003297}