blob: dd2437621827183ff653f4b9c9857e133fcffc68 [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
76 ctx.RegisterSingletonType("logtags", LogtagsSingleton)
77 ctx.RegisterSingletonType("kythe_java_extract", kytheExtractJavaFactory)
78}
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
233 // ImplementationAndResourceJars is a list of jars that contain the implementations of classes
234 // in the module as well as any resources included in the module.
235 ImplementationAndResourcesJars android.Paths
236
237 // ImplementationJars is a list of jars that contain the implementations of classes in the
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000238 //module.
Colin Crossdcf71b22021-02-01 13:59:03 -0800239 ImplementationJars android.Paths
240
241 // ResourceJars is a list of jars that contain the resources included in the module.
242 ResourceJars android.Paths
243
244 // AidlIncludeDirs is a list of directories that should be passed to the aidl tool when
245 // depending on this module.
246 AidlIncludeDirs android.Paths
247
248 // SrcJarArgs is a list of arguments to pass to soong_zip to package the sources of this
249 // module.
250 SrcJarArgs []string
251
252 // SrcJarDeps is a list of paths to depend on when packaging the sources of this module.
253 SrcJarDeps android.Paths
254
255 // ExportedPlugins is a list of paths that should be used as annotation processors for any
256 // module that depends on this module.
257 ExportedPlugins android.Paths
258
259 // ExportedPluginClasses is a list of classes that should be run as annotation processors for
260 // any module that depends on this module.
261 ExportedPluginClasses []string
262
263 // ExportedPluginDisableTurbine is true if this module's annotation processors generate APIs,
264 // requiring disbling turbine for any modules that depend on it.
265 ExportedPluginDisableTurbine bool
266
267 // JacocoReportClassesFile is the path to a jar containing uninstrumented classes that will be
268 // instrumented by jacoco.
269 JacocoReportClassesFile android.Path
270}
271
272var JavaInfoProvider = blueprint.NewProvider(JavaInfo{})
273
Colin Cross75ce9ec2021-02-26 16:20:32 -0800274// SyspropPublicStubInfo contains info about the sysprop public stub library that corresponds to
275// the sysprop implementation library.
276type SyspropPublicStubInfo struct {
277 // JavaInfo is the JavaInfoProvider of the sysprop public stub library that corresponds to
278 // the sysprop implementation library.
279 JavaInfo JavaInfo
280}
281
282var SyspropPublicStubInfoProvider = blueprint.NewProvider(SyspropPublicStubInfo{})
283
Paul Duffin44b481b2020-06-17 16:59:43 +0100284// Methods that need to be implemented for a module that is added to apex java_libs property.
285type ApexDependency interface {
Nan Zhanged19fc32017-10-19 13:06:22 -0700286 HeaderJars() android.Paths
Paul Duffin44b481b2020-06-17 16:59:43 +0100287 ImplementationAndResourcesJars() android.Paths
288}
289
Ulya Trafimovich31e444e2020-08-14 17:32:16 +0100290// Provides build path and install path to DEX jars.
291type UsesLibraryDependency interface {
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100292 DexJarBuildPath() OptionalDexJarPath
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +0100293 DexJarInstallPath() android.Path
Ulya Trafimovichdbf31662020-12-17 12:07:54 +0000294 ClassLoaderContexts() dexpreopt.ClassLoaderContextMap
Ulya Trafimovich31e444e2020-08-14 17:32:16 +0100295}
296
Jaewoong Jung26342642021-03-17 15:56:23 -0700297// TODO(jungjw): Move this to kythe.go once it's created.
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800298type xref interface {
299 XrefJavaFiles() android.Paths
300}
301
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800302func (j *Module) XrefJavaFiles() android.Paths {
303 return j.kytheFiles
304}
305
Colin Crossbe1da472017-07-07 15:59:46 -0700306type dependencyTag struct {
307 blueprint.BaseDependencyTag
308 name string
Colin Cross65cb3142021-12-10 23:05:02 +0000309
310 // True if the dependency is relinked at runtime.
311 runtimeLinked bool
Colin Crossce564252022-01-12 11:13:32 -0800312
313 // True if the dependency is a toolchain, for example an annotation processor.
314 toolchain bool
Colin Cross2fe66872015-03-30 17:20:39 -0700315}
316
Colin Crosse9fe2942020-11-10 18:12:15 -0800317// installDependencyTag is a dependency tag that is annotated to cause the installed files of the
318// dependency to be installed when the parent module is installed.
319type installDependencyTag struct {
320 blueprint.BaseDependencyTag
321 android.InstallAlwaysNeededDependencyTag
322 name string
323}
324
Colin Cross65cb3142021-12-10 23:05:02 +0000325func (d dependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
326 if d.runtimeLinked {
327 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
Colin Crossce564252022-01-12 11:13:32 -0800328 } else if d.toolchain {
329 return []android.LicenseAnnotation{android.LicenseAnnotationToolchain}
Colin Cross65cb3142021-12-10 23:05:02 +0000330 }
331 return nil
332}
333
334var _ android.LicenseAnnotationsDependencyTag = dependencyTag{}
335
Ulya Trafimovichb5218112020-10-07 15:11:32 +0100336type usesLibraryDependencyTag struct {
337 dependencyTag
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100338 sdkVersion int // SDK version in which the library appared as a standalone library.
339 optional bool // If the dependency is optional or required.
Ulya Trafimovichb5218112020-10-07 15:11:32 +0100340}
341
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100342func makeUsesLibraryDependencyTag(sdkVersion int, optional bool) usesLibraryDependencyTag {
Ulya Trafimovichb5218112020-10-07 15:11:32 +0100343 return usesLibraryDependencyTag{
Colin Cross65cb3142021-12-10 23:05:02 +0000344 dependencyTag: dependencyTag{
345 name: fmt.Sprintf("uses-library-%d", sdkVersion),
346 runtimeLinked: true,
347 },
348 sdkVersion: sdkVersion,
349 optional: optional,
Ulya Trafimovichb5218112020-10-07 15:11:32 +0100350 }
351}
352
Jiyong Park8be103b2019-11-08 15:53:48 +0900353func IsJniDepTag(depTag blueprint.DependencyTag) bool {
Colin Crossde78d132020-10-09 18:59:49 -0700354 return depTag == jniLibTag
Jiyong Park8be103b2019-11-08 15:53:48 +0900355}
356
Colin Crossbe1da472017-07-07 15:59:46 -0700357var (
Colin Cross75ce9ec2021-02-26 16:20:32 -0800358 dataNativeBinsTag = dependencyTag{name: "dataNativeBins"}
Sam Delmericob3342ce2022-01-20 21:10:28 +0000359 dataDeviceBinsTag = dependencyTag{name: "dataDeviceBins"}
Colin Cross75ce9ec2021-02-26 16:20:32 -0800360 staticLibTag = dependencyTag{name: "staticlib"}
Colin Cross65cb3142021-12-10 23:05:02 +0000361 libTag = dependencyTag{name: "javalib", runtimeLinked: true}
Liz Kammeref28a4c2022-09-23 16:50:56 -0400362 sdkLibTag = dependencyTag{name: "sdklib", runtimeLinked: true}
Colin Cross65cb3142021-12-10 23:05:02 +0000363 java9LibTag = dependencyTag{name: "java9lib", runtimeLinked: true}
Colin Crossce564252022-01-12 11:13:32 -0800364 pluginTag = dependencyTag{name: "plugin", toolchain: true}
365 errorpronePluginTag = dependencyTag{name: "errorprone-plugin", toolchain: true}
366 exportedPluginTag = dependencyTag{name: "exported-plugin", toolchain: true}
Colin Cross65cb3142021-12-10 23:05:02 +0000367 bootClasspathTag = dependencyTag{name: "bootclasspath", runtimeLinked: true}
368 systemModulesTag = dependencyTag{name: "system modules", runtimeLinked: true}
Colin Cross75ce9ec2021-02-26 16:20:32 -0800369 frameworkResTag = dependencyTag{name: "framework-res"}
Colin Cross65cb3142021-12-10 23:05:02 +0000370 kotlinStdlibTag = dependencyTag{name: "kotlin-stdlib", runtimeLinked: true}
371 kotlinAnnotationsTag = dependencyTag{name: "kotlin-annotations", runtimeLinked: true}
Colin Crossce564252022-01-12 11:13:32 -0800372 kotlinPluginTag = dependencyTag{name: "kotlin-plugin", toolchain: true}
Colin Cross75ce9ec2021-02-26 16:20:32 -0800373 proguardRaiseTag = dependencyTag{name: "proguard-raise"}
374 certificateTag = dependencyTag{name: "certificate"}
375 instrumentationForTag = dependencyTag{name: "instrumentation_for"}
Colin Crossce564252022-01-12 11:13:32 -0800376 extraLintCheckTag = dependencyTag{name: "extra-lint-check", toolchain: true}
Colin Cross65cb3142021-12-10 23:05:02 +0000377 jniLibTag = dependencyTag{name: "jnilib", runtimeLinked: true}
Colin Cross75ce9ec2021-02-26 16:20:32 -0800378 syspropPublicStubDepTag = dependencyTag{name: "sysprop public stub"}
379 jniInstallTag = installDependencyTag{name: "jni install"}
380 binaryInstallTag = installDependencyTag{name: "binary install"}
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100381 usesLibReqTag = makeUsesLibraryDependencyTag(dexpreopt.AnySdkVersion, false)
382 usesLibOptTag = makeUsesLibraryDependencyTag(dexpreopt.AnySdkVersion, true)
383 usesLibCompat28OptTag = makeUsesLibraryDependencyTag(28, true)
384 usesLibCompat29ReqTag = makeUsesLibraryDependencyTag(29, false)
385 usesLibCompat30OptTag = makeUsesLibraryDependencyTag(30, true)
Colin Crossbe1da472017-07-07 15:59:46 -0700386)
Colin Cross2fe66872015-03-30 17:20:39 -0700387
Jiyong Park83dc74b2020-01-14 18:38:44 +0900388func IsLibDepTag(depTag blueprint.DependencyTag) bool {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400389 return depTag == libTag || depTag == sdkLibTag
Jiyong Park83dc74b2020-01-14 18:38:44 +0900390}
391
392func IsStaticLibDepTag(depTag blueprint.DependencyTag) bool {
393 return depTag == staticLibTag
394}
395
Colin Crossfc3674a2017-09-18 17:41:52 -0700396type sdkDep struct {
Pete Gilline3d44b22020-06-29 11:28:51 +0100397 useModule, useFiles, invalidVersion bool
Colin Cross47ff2522017-10-02 14:22:08 -0700398
Colin Cross6cef4812019-10-17 14:23:50 -0700399 // The modules that will be added to the bootclasspath when targeting 1.8 or lower
400 bootclasspath []string
Paul Duffine25c6442019-10-11 13:50:28 +0100401
402 // The default system modules to use. Will be an empty string if no system
403 // modules are to be used.
Colin Cross1369cdb2017-09-29 17:58:17 -0700404 systemModules string
405
Pete Gilline3d44b22020-06-29 11:28:51 +0100406 // The modules that will be added to the classpath regardless of the Java language level targeted
407 classpath []string
408
Colin Cross6cef4812019-10-17 14:23:50 -0700409 // The modules that will be added ot the classpath when targeting 1.9 or higher
Pete Gilline3d44b22020-06-29 11:28:51 +0100410 // (normally these will be on the bootclasspath when targeting 1.8 or lower)
Colin Cross6cef4812019-10-17 14:23:50 -0700411 java9Classpath []string
412
Colin Crossa97c5d32018-03-28 14:58:31 -0700413 frameworkResModule string
414
Colin Cross86a60ae2018-05-29 14:44:55 -0700415 jars android.Paths
Colin Cross3047fa22019-04-18 10:56:44 -0700416 aidl android.OptionalPath
Paul Duffin250e6192019-06-07 10:44:37 +0100417
418 noStandardLibs, noFrameworksLibs bool
419}
420
421func (s sdkDep) hasStandardLibs() bool {
422 return !s.noStandardLibs
423}
424
425func (s sdkDep) hasFrameworkLibs() bool {
426 return !s.noStandardLibs && !s.noFrameworksLibs
Colin Cross1369cdb2017-09-29 17:58:17 -0700427}
428
Colin Crossa4f08812018-10-02 22:03:40 -0700429type jniLib struct {
Colin Cross403cc152020-07-06 14:15:24 -0700430 name string
431 path android.Path
432 target android.Target
433 coverageFile android.OptionalPath
434 unstrippedFile android.Path
Jihoon Kangf78a8902022-09-01 22:47:07 +0000435 partition string
Colin Crossa4f08812018-10-02 22:03:40 -0700436}
437
Jiyong Parkf1691d22021-03-29 20:11:58 +0900438func sdkDeps(ctx android.BottomUpMutatorContext, sdkContext android.SdkContext, d dexer) {
Liz Kammerd6c31d22020-08-05 15:40:41 -0700439 sdkDep := decodeSdkDep(ctx, sdkContext)
440 if sdkDep.useModule {
441 ctx.AddVariationDependencies(nil, bootClasspathTag, sdkDep.bootclasspath...)
442 ctx.AddVariationDependencies(nil, java9LibTag, sdkDep.java9Classpath...)
Liz Kammeref28a4c2022-09-23 16:50:56 -0400443 ctx.AddVariationDependencies(nil, sdkLibTag, sdkDep.classpath...)
Liz Kammerd6c31d22020-08-05 15:40:41 -0700444 if d.effectiveOptimizeEnabled() && sdkDep.hasStandardLibs() {
445 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.LegacyCorePlatformBootclasspathLibraries...)
446 }
447 if d.effectiveOptimizeEnabled() && sdkDep.hasFrameworkLibs() {
448 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.FrameworkLibraries...)
449 }
450 }
451 if sdkDep.systemModules != "" {
452 ctx.AddVariationDependencies(nil, systemModulesTag, sdkDep.systemModules)
453 }
454}
455
Colin Cross32f676a2017-09-06 13:41:06 -0700456type deps struct {
Colin Cross9bb9bfb2022-03-17 11:12:32 -0700457 // bootClasspath is the list of jars that form the boot classpath (generally the java.* and
458 // android.* classes) for tools that still use it. javac targeting 1.9 or higher uses
459 // systemModules and java9Classpath instead.
460 bootClasspath classpath
461
462 // classpath is the list of jars that form the classpath for javac and kotlinc rules. It
463 // contains header jars for all static and non-static dependencies.
464 classpath classpath
465
466 // dexClasspath is the list of jars that form the classpath for d8 and r8 rules. It contains
467 // header jars for all non-static dependencies. Static dependencies have already been
468 // combined into the program jar.
469 dexClasspath classpath
470
471 // java9Classpath is the list of jars that will be added to the classpath when targeting
472 // 1.9 or higher. It generally contains the android.* classes, while the java.* classes
473 // are provided by systemModules.
474 java9Classpath classpath
475
Colin Cross748b2d82020-11-19 13:52:06 -0800476 processorPath classpath
477 errorProneProcessorPath classpath
478 processorClasses []string
479 staticJars android.Paths
480 staticHeaderJars android.Paths
481 staticResourceJars android.Paths
482 aidlIncludeDirs android.Paths
483 srcs android.Paths
484 srcJars android.Paths
485 systemModules *systemModules
486 aidlPreprocess android.OptionalPath
487 kotlinStdlib android.Paths
488 kotlinAnnotations android.Paths
Colin Crossa1ff7c62021-09-17 14:11:52 -0700489 kotlinPlugins android.Paths
Colin Crossbe9cdb82019-01-21 21:37:16 -0800490
491 disableTurbine bool
Colin Cross32f676a2017-09-06 13:41:06 -0700492}
Colin Cross2fe66872015-03-30 17:20:39 -0700493
Colin Cross54250902017-12-05 09:28:08 -0800494func checkProducesJars(ctx android.ModuleContext, dep android.SourceFileProducer) {
495 for _, f := range dep.Srcs() {
496 if f.Ext() != ".jar" {
497 ctx.ModuleErrorf("genrule %q must generate files ending with .jar to be used as a libs or static_libs dependency",
498 ctx.OtherModuleName(dep.(blueprint.Module)))
499 }
500 }
501}
502
Jiyong Parkf1691d22021-03-29 20:11:58 +0900503func getJavaVersion(ctx android.ModuleContext, javaVersion string, sdkContext android.SdkContext) javaVersion {
Nan Zhang357466b2018-04-17 17:38:36 -0700504 if javaVersion != "" {
Colin Cross1e743852019-10-28 11:37:20 -0700505 return normalizeJavaVersion(ctx, javaVersion)
Colin Cross17dec172020-05-14 18:05:32 -0700506 } else if ctx.Device() {
Jiyong Park92315372021-04-02 08:45:46 +0900507 return defaultJavaLanguageVersion(ctx, sdkContext.SdkVersion(ctx))
Sorin Bascace720c32022-05-24 12:13:50 +0100508 } else if ctx.Config().TargetsJava17() {
509 // Temporary experimental flag to be able to try and build with
510 // java version 17 options. The flag, if used, just sets Java
511 // 17 as the default version, leaving any components that
512 // target an older version intact.
513 return JAVA_VERSION_17
Sorin Basca8d3e0bb2022-01-20 15:21:51 +0000514 } else {
Sorin Basca18ecf612022-01-23 09:01:07 +0000515 return JAVA_VERSION_11
Nan Zhang357466b2018-04-17 17:38:36 -0700516 }
Nan Zhang357466b2018-04-17 17:38:36 -0700517}
518
Colin Cross1e743852019-10-28 11:37:20 -0700519type javaVersion int
520
521const (
522 JAVA_VERSION_UNSUPPORTED = 0
523 JAVA_VERSION_6 = 6
524 JAVA_VERSION_7 = 7
525 JAVA_VERSION_8 = 8
526 JAVA_VERSION_9 = 9
Sorin Bascac0244da2021-11-26 17:26:33 +0000527 JAVA_VERSION_11 = 11
Sorin Bascace720c32022-05-24 12:13:50 +0100528 JAVA_VERSION_17 = 17
Colin Cross1e743852019-10-28 11:37:20 -0700529)
530
531func (v javaVersion) String() string {
532 switch v {
533 case JAVA_VERSION_6:
534 return "1.6"
535 case JAVA_VERSION_7:
536 return "1.7"
537 case JAVA_VERSION_8:
538 return "1.8"
539 case JAVA_VERSION_9:
540 return "1.9"
Sorin Bascac0244da2021-11-26 17:26:33 +0000541 case JAVA_VERSION_11:
542 return "11"
Sorin Bascace720c32022-05-24 12:13:50 +0100543 case JAVA_VERSION_17:
544 return "17"
Colin Cross1e743852019-10-28 11:37:20 -0700545 default:
546 return "unsupported"
547 }
548}
549
Cole Faustd96eebf2022-06-28 14:41:27 -0700550func (v javaVersion) StringForKotlinc() string {
551 // $ ./external/kotlinc/bin/kotlinc -jvm-target foo
552 // error: unknown JVM target version: foo
553 // Supported versions: 1.6, 1.8, 9, 10, 11, 12, 13, 14, 15, 16, 17
554 switch v {
555 case JAVA_VERSION_7:
556 return "1.6"
557 case JAVA_VERSION_9:
558 return "9"
559 default:
560 return v.String()
561 }
562}
563
Colin Cross1e743852019-10-28 11:37:20 -0700564// Returns true if javac targeting this version uses system modules instead of a bootclasspath.
565func (v javaVersion) usesJavaModules() bool {
566 return v >= 9
567}
568
569func normalizeJavaVersion(ctx android.BaseModuleContext, javaVersion string) javaVersion {
Pete Gillin4e8b48a2019-07-12 13:16:17 +0100570 switch javaVersion {
571 case "1.6", "6":
Colin Cross1e743852019-10-28 11:37:20 -0700572 return JAVA_VERSION_6
Pete Gillin4e8b48a2019-07-12 13:16:17 +0100573 case "1.7", "7":
Colin Cross1e743852019-10-28 11:37:20 -0700574 return JAVA_VERSION_7
Pete Gillin4e8b48a2019-07-12 13:16:17 +0100575 case "1.8", "8":
Colin Cross1e743852019-10-28 11:37:20 -0700576 return JAVA_VERSION_8
Pete Gillin4e8b48a2019-07-12 13:16:17 +0100577 case "1.9", "9":
Colin Cross1e743852019-10-28 11:37:20 -0700578 return JAVA_VERSION_9
Sorin Bascac0244da2021-11-26 17:26:33 +0000579 case "11":
580 return JAVA_VERSION_11
Sorin Bascace720c32022-05-24 12:13:50 +0100581 case "17":
Sorin Basca5938fed2022-06-22 12:53:51 +0100582 return JAVA_VERSION_17
Sorin Bascace720c32022-05-24 12:13:50 +0100583 case "10", "12", "13", "14", "15", "16":
584 ctx.PropertyErrorf("java_version", "Java language level %s is not supported", javaVersion)
Colin Cross1e743852019-10-28 11:37:20 -0700585 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +0100586 default:
587 ctx.PropertyErrorf("java_version", "Unrecognized Java language level")
Colin Cross1e743852019-10-28 11:37:20 -0700588 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +0100589 }
590}
591
Colin Cross2fe66872015-03-30 17:20:39 -0700592//
593// Java libraries (.jar file)
594//
595
Colin Crossf506d872017-07-19 15:53:04 -0700596type Library struct {
Colin Cross46c9b8b2017-06-22 16:51:17 -0700597 Module
Colin Crossf0f2e2c2019-10-15 16:36:40 -0700598
599 InstallMixin func(ctx android.ModuleContext, installPath android.Path) (extraInstallDeps android.Paths)
Colin Cross2fe66872015-03-30 17:20:39 -0700600}
601
Jiyong Park45bf82e2020-12-15 22:29:02 +0900602var _ android.ApexModule = (*Library)(nil)
603
satayevd604b212021-07-21 14:23:52 +0100604// Provides access to the list of permitted packages from apex boot jars.
Paul Duffine739f1e2020-05-29 11:24:51 +0100605type PermittedPackagesForUpdatableBootJars interface {
606 PermittedPackagesForUpdatableBootJars() []string
607}
608
609var _ PermittedPackagesForUpdatableBootJars = (*Library)(nil)
610
611func (j *Library) PermittedPackagesForUpdatableBootJars() []string {
612 return j.properties.Permitted_packages
613}
614
Colin Cross42be7612019-02-21 18:12:14 -0800615func shouldUncompressDex(ctx android.ModuleContext, dexpreopter *dexpreopter) bool {
Ulya Trafimovichf491dde2020-01-24 12:19:45 +0000616 // Store uncompressed (and aligned) any dex files from jars in APEXes.
Colin Cross56a83212020-09-15 18:30:11 -0700617 if apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo); !apexInfo.IsForPlatform() {
Ulya Trafimovichf491dde2020-01-24 12:19:45 +0000618 return true
619 }
620
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +0000621 // Store uncompressed (and do not strip) dex files from boot class path jars.
622 if inList(ctx.ModuleName(), ctx.Config().BootJars()) {
623 return true
624 }
625
626 // Store uncompressed dex files that are preopted on /system.
Jiakai Zhang519c5c82021-09-16 06:15:39 +0000627 if !dexpreopter.dexpreoptDisabled(ctx) && (ctx.Host() || !dexpreopter.odexOnSystemOther(ctx, dexpreopter.installPath)) {
Vladimir Markoe8b00d62018-12-21 15:54:16 +0000628 return true
629 }
Colin Cross083a2aa2019-02-06 16:37:12 -0800630 if ctx.Config().UncompressPrivAppDex() &&
631 inList(ctx.ModuleName(), ctx.Config().ModulesLoadedByPrivilegedModules()) {
632 return true
633 }
634
Colin Cross2fc72f62018-12-21 12:59:54 -0800635 return false
636}
637
Jiakai Zhang22450f22021-10-11 03:05:20 +0000638// Sets `dexer.dexProperties.Uncompress_dex` to the proper value.
639func setUncompressDex(ctx android.ModuleContext, dexpreopter *dexpreopter, dexer *dexer) {
640 if dexer.dexProperties.Uncompress_dex == nil {
641 // If the value was not force-set by the user, use reasonable default based on the module.
642 dexer.dexProperties.Uncompress_dex = proptools.BoolPtr(shouldUncompressDex(ctx, dexpreopter))
643 }
644}
645
Colin Crossf506d872017-07-19 15:53:04 -0700646func (j *Library) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000647
648 j.provideHiddenAPIPropertyInfo(ctx)
649
Jiyong Park92315372021-04-02 08:45:46 +0900650 j.sdkVersion = j.SdkVersion(ctx)
651 j.minSdkVersion = j.MinSdkVersion(ctx)
satayev0a420e72021-11-29 17:25:52 +0000652 j.maxSdkVersion = j.MaxSdkVersion(ctx)
Jiyong Park92315372021-04-02 08:45:46 +0900653
Colin Cross56a83212020-09-15 18:30:11 -0700654 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
655 if !apexInfo.IsForPlatform() {
656 j.hideApexVariantFromMake = true
657 }
658
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100659 j.checkSdkVersions(ctx)
Colin Cross61df14a2021-12-01 13:04:46 -0800660 if ctx.Device() {
661 j.dexpreopter.installPath = j.dexpreopter.getInstallPath(
662 ctx, android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar"))
663 j.dexpreopter.isSDKLibrary = j.deviceProperties.IsSDKLibrary
664 setUncompressDex(ctx, &j.dexpreopter, &j.dexer)
665 j.dexpreopter.uncompressedDex = *j.dexProperties.Uncompress_dex
666 j.classLoaderContexts = j.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
667 }
Jaewoong Junga24af3b2019-05-13 09:23:20 -0700668 j.compile(ctx, nil)
Colin Crossb7a63242015-04-16 14:09:14 -0700669
bralee1fbf4402020-05-21 10:11:59 +0800670 // Collect the module directory for IDE info in java/jdeps.go.
671 j.modulePaths = append(j.modulePaths, ctx.ModuleDir())
672
Colin Cross56a83212020-09-15 18:30:11 -0700673 exclusivelyForApex := !apexInfo.IsForPlatform()
Jiyong Park7f7766d2019-07-25 22:02:35 +0900674 if (Bool(j.properties.Installable) || ctx.Host()) && !exclusivelyForApex {
Colin Crossf0f2e2c2019-10-15 16:36:40 -0700675 var extraInstallDeps android.Paths
676 if j.InstallMixin != nil {
677 extraInstallDeps = j.InstallMixin(ctx, j.outputFile)
678 }
Colin Cross1d0eb7a2021-11-03 14:08:20 -0700679 hostDexNeeded := Bool(j.deviceProperties.Hostdex) && !ctx.Host()
680 if hostDexNeeded {
Colin Cross3108ce12021-11-10 14:38:50 -0800681 j.hostdexInstallFile = ctx.InstallFile(
682 android.PathForHostDexInstall(ctx, "framework"),
Colin Cross1d0eb7a2021-11-03 14:08:20 -0700683 j.Stem()+"-hostdex.jar", j.outputFile)
684 }
685 var installDir android.InstallPath
686 if ctx.InstallInTestcases() {
687 var archDir string
688 if !ctx.Host() {
689 archDir = ctx.DeviceConfig().DeviceArch()
690 }
691 installDir = android.PathForModuleInstall(ctx, ctx.ModuleName(), archDir)
692 } else {
693 installDir = android.PathForModuleInstall(ctx, "framework")
694 }
695 j.installFile = ctx.InstallFile(installDir, j.Stem()+".jar", j.outputFile, extraInstallDeps...)
Colin Cross2c429dc2017-08-31 16:45:16 -0700696 }
Colin Crossb7a63242015-04-16 14:09:14 -0700697}
698
Colin Crossf506d872017-07-19 15:53:04 -0700699func (j *Library) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross46c9b8b2017-06-22 16:51:17 -0700700 j.deps(ctx)
Ulya Trafimoviche4432872021-08-18 16:57:11 +0100701 j.usesLibrary.deps(ctx, false)
Colin Cross46c9b8b2017-06-22 16:51:17 -0700702}
703
Paul Duffin0e0cf1d2019-11-12 19:39:25 +0000704const (
Paul Duffin1b82e6a2019-12-03 18:06:47 +0000705 aidlIncludeDir = "aidl"
706 javaDir = "java"
707 jarFileSuffix = ".jar"
708 testConfigSuffix = "-AndroidTest.xml"
Paul Duffin0e0cf1d2019-11-12 19:39:25 +0000709)
710
Paul Duffina0dbf432019-12-05 11:25:53 +0000711// path to the jar file of a java library. Relative to <sdk_root>/<api_dir>
Paul Duffin13648912022-07-15 13:12:35 +0000712func sdkSnapshotFilePathForJar(_ android.SdkMemberContext, osPrefix, name string) string {
Paul Duffina04c1072020-03-02 10:16:35 +0000713 return sdkSnapshotFilePathForMember(osPrefix, name, jarFileSuffix)
Paul Duffin1b82e6a2019-12-03 18:06:47 +0000714}
715
Paul Duffina04c1072020-03-02 10:16:35 +0000716func sdkSnapshotFilePathForMember(osPrefix, name string, suffix string) string {
717 return filepath.Join(javaDir, osPrefix, name+suffix)
Paul Duffin0e0cf1d2019-11-12 19:39:25 +0000718}
719
Paul Duffin13879572019-11-28 14:31:38 +0000720type librarySdkMemberType struct {
Paul Duffin255f18e2019-12-13 11:22:16 +0000721 android.SdkMemberTypeBase
Paul Duffinf5c0a9c2020-02-28 14:39:53 +0000722
723 // Function to retrieve the appropriate output jar (implementation or header) from
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000724 // the library.
Paul Duffindb170e42020-12-08 17:48:25 +0000725 jarToExportGetter func(ctx android.SdkMemberContext, j *Library) android.Path
726
727 // Function to compute the snapshot relative path to which the named library's
728 // jar should be copied.
Paul Duffin13648912022-07-15 13:12:35 +0000729 snapshotPathGetter func(ctx android.SdkMemberContext, osPrefix, name string) string
Paul Duffindb170e42020-12-08 17:48:25 +0000730
731 // True if only the jar should be copied to the snapshot, false if the jar plus any additional
732 // files like aidl files should also be copied.
733 onlyCopyJarToSnapshot bool
Paul Duffin13879572019-11-28 14:31:38 +0000734}
735
Paul Duffindb170e42020-12-08 17:48:25 +0000736const (
737 onlyCopyJarToSnapshot = true
738 copyEverythingToSnapshot = false
739)
740
Paul Duffin296701e2021-07-14 10:29:36 +0100741func (mt *librarySdkMemberType) AddDependencies(ctx android.SdkDependencyContext, dependencyTag blueprint.DependencyTag, names []string) {
742 ctx.AddVariationDependencies(nil, dependencyTag, names...)
Paul Duffin13879572019-11-28 14:31:38 +0000743}
744
745func (mt *librarySdkMemberType) IsInstance(module android.Module) bool {
746 _, ok := module.(*Library)
747 return ok
748}
749
Paul Duffin3a4eb502020-03-19 16:11:18 +0000750func (mt *librarySdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
751 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_import")
Paul Duffin14eb4672020-03-02 11:33:02 +0000752}
Paul Duffina0dbf432019-12-05 11:25:53 +0000753
Paul Duffin14eb4672020-03-02 11:33:02 +0000754func (mt *librarySdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
Paul Duffina551a1c2020-03-17 21:04:24 +0000755 return &librarySdkMemberProperties{}
Paul Duffin14eb4672020-03-02 11:33:02 +0000756}
757
758type librarySdkMemberProperties struct {
759 android.SdkMemberPropertiesBase
760
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000761 JarToExport android.Path `android:"arch_variant"`
Paul Duffina551a1c2020-03-17 21:04:24 +0000762 AidlIncludeDirs android.Paths
Paul Duffin869de142021-07-15 14:14:41 +0100763
764 // The list of permitted packages that need to be passed to the prebuilts as they are used to
765 // create the updatable-bcp-packages.txt file.
766 PermittedPackages []string
Paul Duffinbb638eb2022-11-26 13:36:38 +0000767
768 // The value of the min_sdk_version property, translated into a number where possible.
769 MinSdkVersion *string `supported_build_releases:"Tiramisu+"`
Paul Duffin14eb4672020-03-02 11:33:02 +0000770}
771
Paul Duffin3a4eb502020-03-19 16:11:18 +0000772func (p *librarySdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffin13879572019-11-28 14:31:38 +0000773 j := variant.(*Library)
774
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000775 p.JarToExport = ctx.MemberType().(*librarySdkMemberType).jarToExportGetter(ctx, j)
Paul Duffindb170e42020-12-08 17:48:25 +0000776
Paul Duffina551a1c2020-03-17 21:04:24 +0000777 p.AidlIncludeDirs = j.AidlIncludeDirs()
Paul Duffin869de142021-07-15 14:14:41 +0100778
779 p.PermittedPackages = j.PermittedPackagesForUpdatableBootJars()
Paul Duffinbb638eb2022-11-26 13:36:38 +0000780
781 // If the min_sdk_version was set then add the canonical representation of the API level to the
782 // snapshot.
783 if j.deviceProperties.Min_sdk_version != nil {
784 canonical := android.ReplaceFinalizedCodenames(ctx.SdkModuleContext().Config(), j.minSdkVersion.ApiLevel.String())
785 p.MinSdkVersion = proptools.StringPtr(canonical)
786 }
Paul Duffin14eb4672020-03-02 11:33:02 +0000787}
Paul Duffin0e0cf1d2019-11-12 19:39:25 +0000788
Paul Duffin3a4eb502020-03-19 16:11:18 +0000789func (p *librarySdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffina551a1c2020-03-17 21:04:24 +0000790 builder := ctx.SnapshotBuilder()
Paul Duffin3a4eb502020-03-19 16:11:18 +0000791
Paul Duffindb170e42020-12-08 17:48:25 +0000792 memberType := ctx.MemberType().(*librarySdkMemberType)
793
Paul Duffina551a1c2020-03-17 21:04:24 +0000794 exportedJar := p.JarToExport
795 if exportedJar != nil {
Paul Duffindb170e42020-12-08 17:48:25 +0000796 // Delegate the creation of the snapshot relative path to the member type.
Paul Duffin13648912022-07-15 13:12:35 +0000797 snapshotRelativeJavaLibPath := memberType.snapshotPathGetter(ctx, p.OsPrefix(), ctx.Name())
Paul Duffindb170e42020-12-08 17:48:25 +0000798
799 // Copy the exported jar to the snapshot.
Paul Duffin14eb4672020-03-02 11:33:02 +0000800 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
801
Paul Duffina551a1c2020-03-17 21:04:24 +0000802 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
803 }
804
Paul Duffinbb638eb2022-11-26 13:36:38 +0000805 if p.MinSdkVersion != nil {
806 propertySet.AddProperty("min_sdk_version", *p.MinSdkVersion)
807 }
808
Paul Duffin869de142021-07-15 14:14:41 +0100809 if len(p.PermittedPackages) > 0 {
810 propertySet.AddProperty("permitted_packages", p.PermittedPackages)
811 }
812
Paul Duffindb170e42020-12-08 17:48:25 +0000813 // Do not copy anything else to the snapshot.
814 if memberType.onlyCopyJarToSnapshot {
815 return
816 }
817
Paul Duffina551a1c2020-03-17 21:04:24 +0000818 aidlIncludeDirs := p.AidlIncludeDirs
819 if len(aidlIncludeDirs) != 0 {
820 sdkModuleContext := ctx.SdkModuleContext()
821 for _, dir := range aidlIncludeDirs {
Paul Duffin14eb4672020-03-02 11:33:02 +0000822 // TODO(jiyong): copy parcelable declarations only
823 aidlFiles, _ := sdkModuleContext.GlobWithDeps(dir.String()+"/**/*.aidl", nil)
824 for _, file := range aidlFiles {
825 builder.CopyToSnapshot(android.PathForSource(sdkModuleContext, file), filepath.Join(aidlIncludeDir, file))
826 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +0000827 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +0000828
Paul Duffina551a1c2020-03-17 21:04:24 +0000829 // TODO(b/151933053) - add aidl include dirs property
Paul Duffin14eb4672020-03-02 11:33:02 +0000830 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +0000831}
832
Colin Cross1b16b0e2019-02-12 14:41:32 -0800833// java_library builds and links sources into a `.jar` file for the device, and possibly for the host as well.
834//
835// By default, a java_library has a single variant that produces a `.jar` file containing `.class` files that were
836// compiled against the device bootclasspath. This jar is not suitable for installing on a device, but can be used
837// as a `static_libs` dependency of another module.
838//
839// Specifying `installable: true` will product a `.jar` file containing `classes.dex` files, suitable for installing on
840// a device.
841//
842// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
843// compiled against the host bootclasspath.
Colin Cross9ae1b922018-06-26 17:59:05 -0700844func LibraryFactory() android.Module {
845 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -0700846
Colin Crossce6734e2020-06-15 16:09:53 -0700847 module.addHostAndDeviceProperties()
Colin Cross2fe66872015-03-30 17:20:39 -0700848
Paul Duffin71b33cc2021-06-23 11:39:47 +0100849 module.initModuleAndImport(module)
Paul Duffin859fe962020-05-15 10:20:31 +0100850
Jiyong Park7f7766d2019-07-25 22:02:35 +0900851 android.InitApexModule(module)
Jiyong Parkd1063c12019-07-17 20:08:41 +0900852 android.InitSdkAwareModule(module)
Wei Libafb6d62021-12-10 03:14:59 -0800853 android.InitBazelModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +0900854 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross9ae1b922018-06-26 17:59:05 -0700855 return module
Colin Cross2fe66872015-03-30 17:20:39 -0700856}
857
Colin Cross1b16b0e2019-02-12 14:41:32 -0800858// java_library_static is an obsolete alias for java_library.
859func LibraryStaticFactory() android.Module {
860 return LibraryFactory()
861}
862
863// java_library_host builds and links sources into a `.jar` file for the host.
864//
865// A java_library_host has a single variant that produces a `.jar` file containing `.class` files that were
866// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -0700867func LibraryHostFactory() android.Module {
868 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -0700869
Colin Crossce6734e2020-06-15 16:09:53 -0700870 module.addHostProperties()
Colin Cross36242852017-06-23 15:06:31 -0700871
Colin Cross9ae1b922018-06-26 17:59:05 -0700872 module.Module.properties.Installable = proptools.BoolPtr(true)
873
Jiyong Park7f7766d2019-07-25 22:02:35 +0900874 android.InitApexModule(module)
Paul Duffinb6b89a42021-05-06 16:33:43 +0100875 android.InitSdkAwareModule(module)
Wei Libafb6d62021-12-10 03:14:59 -0800876 android.InitBazelModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +0900877 InitJavaModule(module, android.HostSupported)
Colin Cross36242852017-06-23 15:06:31 -0700878 return module
Colin Cross2fe66872015-03-30 17:20:39 -0700879}
880
881//
Colin Crossb628ea52018-08-14 16:42:33 -0700882// Java Tests
Colin Cross05638fc2018-04-09 18:40:24 -0700883//
884
Dan Shi95d19422020-08-15 12:24:26 -0700885// Test option struct.
886type TestOptions struct {
Zhenhuang Wang0ac5a432022-08-12 18:49:20 +0800887 android.CommonTestOptions
888
Dan Shi95d19422020-08-15 12:24:26 -0700889 // a list of extra test configuration files that should be installed with the module.
890 Extra_test_configs []string `android:"path,arch_variant"`
Cole Faust8ec823c2022-12-07 18:18:37 -0800891
892 // Extra <option> tags to add to the auto generated test xml file. The "key"
893 // is optional in each of these.
894 Tradefed_options []tradefed.Option
Dan Shi95d19422020-08-15 12:24:26 -0700895}
896
Colin Cross05638fc2018-04-09 18:40:24 -0700897type testProperties struct {
Colin Cross05638fc2018-04-09 18:40:24 -0700898 // list of compatibility suites (for example "cts", "vts") that the module should be
899 // installed into.
900 Test_suites []string `android:"arch_variant"`
Julien Despreze146e392018-08-02 15:00:46 -0700901
902 // the name of the test configuration (for example "AndroidTest.xml") that should be
903 // installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -0800904 Test_config *string `android:"path,arch_variant"`
Colin Crossd96ca352018-08-10 16:06:24 -0700905
Jack He33338892018-09-19 02:21:28 -0700906 // the name of the test configuration template (for example "AndroidTestTemplate.xml") that
907 // should be installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -0800908 Test_config_template *string `android:"path,arch_variant"`
Jack He33338892018-09-19 02:21:28 -0700909
Colin Crossd96ca352018-08-10 16:06:24 -0700910 // list of files or filegroup modules that provide data that should be installed alongside
911 // the test
Jiyong Park2b0e4902021-02-16 06:52:39 +0900912 Data []string `android:"path"`
Dan Shi6ffaaa82019-09-26 11:41:36 -0700913
914 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
915 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
916 // explicitly.
917 Auto_gen_config *bool
easoncylee5bcff5d2020-04-30 14:57:06 +0800918
919 // Add parameterized mainline modules to auto generated test config. The options will be
920 // handled by TradeFed to do downloading and installing the specified modules on the device.
921 Test_mainline_modules []string
Dan Shi95d19422020-08-15 12:24:26 -0700922
923 // Test options.
924 Test_options TestOptions
Colin Crossf8d9c492021-01-26 11:01:43 -0800925
926 // Names of modules containing JNI libraries that should be installed alongside the test.
927 Jni_libs []string
Colin Crosscfb0f5e2021-09-24 15:47:17 -0700928
929 // Install the test into a folder named for the module in all test suites.
930 Per_testcase_directory *bool
Colin Cross05638fc2018-04-09 18:40:24 -0700931}
932
Liz Kammerdd849a82020-06-12 16:38:45 -0700933type hostTestProperties struct {
934 // list of native binary modules that should be installed alongside the test
935 Data_native_bins []string `android:"arch_variant"`
Sam Delmericob3342ce2022-01-20 21:10:28 +0000936
937 // list of device binary modules that should be installed alongside the test
Sam Delmericocc271e22022-06-01 15:45:02 +0000938 // This property only adds the first variant of the dependency
939 Data_device_bins_first []string `android:"arch_variant"`
940
941 // list of device binary modules that should be installed alongside the test
942 // This property adds 64bit AND 32bit variants of the dependency
943 Data_device_bins_both []string `android:"arch_variant"`
944
945 // list of device binary modules that should be installed alongside the test
946 // This property only adds 64bit variants of the dependency
947 Data_device_bins_64 []string `android:"arch_variant"`
948
949 // list of device binary modules that should be installed alongside the test
950 // This property adds 32bit variants of the dependency if available, or else
951 // defaults to the 64bit variant
952 Data_device_bins_prefer32 []string `android:"arch_variant"`
953
954 // list of device binary modules that should be installed alongside the test
955 // This property only adds 32bit variants of the dependency
956 Data_device_bins_32 []string `android:"arch_variant"`
Liz Kammerdd849a82020-06-12 16:38:45 -0700957}
958
Paul Duffin42df1442019-03-20 12:45:53 +0000959type testHelperLibraryProperties struct {
960 // list of compatibility suites (for example "cts", "vts") that the module should be
961 // installed into.
962 Test_suites []string `android:"arch_variant"`
Colin Crosscfb0f5e2021-09-24 15:47:17 -0700963
964 // Install the test into a folder named for the module in all test suites.
965 Per_testcase_directory *bool
Paul Duffin42df1442019-03-20 12:45:53 +0000966}
967
Paul Duffin1b82e6a2019-12-03 18:06:47 +0000968type prebuiltTestProperties struct {
969 // list of compatibility suites (for example "cts", "vts") that the module should be
970 // installed into.
971 Test_suites []string `android:"arch_variant"`
972
973 // the name of the test configuration (for example "AndroidTest.xml") that should be
974 // installed with the module.
975 Test_config *string `android:"path,arch_variant"`
976}
977
Colin Cross05638fc2018-04-09 18:40:24 -0700978type Test struct {
979 Library
980
981 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -0700982
Dan Shi95d19422020-08-15 12:24:26 -0700983 testConfig android.Path
984 extraTestConfigs android.Paths
985 data android.Paths
Colin Cross303e21f2018-08-07 16:49:25 -0700986}
987
Liz Kammerdd849a82020-06-12 16:38:45 -0700988type TestHost struct {
989 Test
990
991 testHostProperties hostTestProperties
992}
993
Paul Duffin42df1442019-03-20 12:45:53 +0000994type TestHelperLibrary struct {
995 Library
996
997 testHelperLibraryProperties testHelperLibraryProperties
998}
999
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001000type JavaTestImport struct {
1001 Import
1002
1003 prebuiltTestProperties prebuiltTestProperties
1004
1005 testConfig android.Path
Liz Kammerd6c31d22020-08-05 15:40:41 -07001006 dexJarFile android.Path
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001007}
1008
Colin Cross24cc4be62021-11-03 14:09:41 -07001009func (j *Test) InstallInTestcases() bool {
1010 // Host java tests install into $(HOST_OUT_JAVA_LIBRARIES), and then are copied into
1011 // testcases by base_rules.mk.
1012 return !j.Host()
1013}
1014
1015func (j *TestHelperLibrary) InstallInTestcases() bool {
1016 return true
1017}
1018
1019func (j *JavaTestImport) InstallInTestcases() bool {
1020 return true
1021}
1022
Sam Delmericocc271e22022-06-01 15:45:02 +00001023func (j *TestHost) addDataDeviceBinsDeps(ctx android.BottomUpMutatorContext) {
1024 if len(j.testHostProperties.Data_device_bins_first) > 0 {
1025 deviceVariations := ctx.Config().AndroidFirstDeviceTarget.Variations()
1026 ctx.AddFarVariationDependencies(deviceVariations, dataDeviceBinsTag, j.testHostProperties.Data_device_bins_first...)
1027 }
1028
1029 var maybeAndroid32Target *android.Target
1030 var maybeAndroid64Target *android.Target
1031 android32TargetList := android.FirstTarget(ctx.Config().Targets[android.Android], "lib32")
1032 android64TargetList := android.FirstTarget(ctx.Config().Targets[android.Android], "lib64")
1033 if len(android32TargetList) > 0 {
1034 maybeAndroid32Target = &android32TargetList[0]
1035 }
1036 if len(android64TargetList) > 0 {
1037 maybeAndroid64Target = &android64TargetList[0]
1038 }
1039
1040 if len(j.testHostProperties.Data_device_bins_both) > 0 {
1041 if maybeAndroid32Target == nil && maybeAndroid64Target == nil {
1042 ctx.PropertyErrorf("data_device_bins_both", "no device targets available. Targets: %q", ctx.Config().Targets)
1043 return
1044 }
1045 if maybeAndroid32Target != nil {
1046 ctx.AddFarVariationDependencies(
1047 maybeAndroid32Target.Variations(),
1048 dataDeviceBinsTag,
1049 j.testHostProperties.Data_device_bins_both...,
1050 )
1051 }
1052 if maybeAndroid64Target != nil {
1053 ctx.AddFarVariationDependencies(
1054 maybeAndroid64Target.Variations(),
1055 dataDeviceBinsTag,
1056 j.testHostProperties.Data_device_bins_both...,
1057 )
1058 }
1059 }
1060
1061 if len(j.testHostProperties.Data_device_bins_prefer32) > 0 {
1062 if maybeAndroid32Target != nil {
1063 ctx.AddFarVariationDependencies(
1064 maybeAndroid32Target.Variations(),
1065 dataDeviceBinsTag,
1066 j.testHostProperties.Data_device_bins_prefer32...,
1067 )
1068 } else {
1069 if maybeAndroid64Target == nil {
1070 ctx.PropertyErrorf("data_device_bins_prefer32", "no device targets available. Targets: %q", ctx.Config().Targets)
1071 return
1072 }
1073 ctx.AddFarVariationDependencies(
1074 maybeAndroid64Target.Variations(),
1075 dataDeviceBinsTag,
1076 j.testHostProperties.Data_device_bins_prefer32...,
1077 )
1078 }
1079 }
1080
1081 if len(j.testHostProperties.Data_device_bins_32) > 0 {
1082 if maybeAndroid32Target == nil {
1083 ctx.PropertyErrorf("data_device_bins_32", "cannot find 32bit device target. Targets: %q", ctx.Config().Targets)
1084 return
1085 }
1086 deviceVariations := maybeAndroid32Target.Variations()
1087 ctx.AddFarVariationDependencies(deviceVariations, dataDeviceBinsTag, j.testHostProperties.Data_device_bins_32...)
1088 }
1089
1090 if len(j.testHostProperties.Data_device_bins_64) > 0 {
1091 if maybeAndroid64Target == nil {
1092 ctx.PropertyErrorf("data_device_bins_64", "cannot find 64bit device target. Targets: %q", ctx.Config().Targets)
1093 return
1094 }
1095 deviceVariations := maybeAndroid64Target.Variations()
1096 ctx.AddFarVariationDependencies(deviceVariations, dataDeviceBinsTag, j.testHostProperties.Data_device_bins_64...)
1097 }
1098}
1099
Liz Kammerdd849a82020-06-12 16:38:45 -07001100func (j *TestHost) DepsMutator(ctx android.BottomUpMutatorContext) {
1101 if len(j.testHostProperties.Data_native_bins) > 0 {
1102 for _, target := range ctx.MultiTargets() {
1103 ctx.AddVariationDependencies(target.Variations(), dataNativeBinsTag, j.testHostProperties.Data_native_bins...)
1104 }
1105 }
1106
Colin Crossf8d9c492021-01-26 11:01:43 -08001107 if len(j.testProperties.Jni_libs) > 0 {
1108 for _, target := range ctx.MultiTargets() {
1109 sharedLibVariations := append(target.Variations(), blueprint.Variation{Mutator: "link", Variation: "shared"})
1110 ctx.AddFarVariationDependencies(sharedLibVariations, jniLibTag, j.testProperties.Jni_libs...)
1111 }
1112 }
1113
Sam Delmericocc271e22022-06-01 15:45:02 +00001114 j.addDataDeviceBinsDeps(ctx)
1115
Liz Kammerdd849a82020-06-12 16:38:45 -07001116 j.deps(ctx)
1117}
1118
Yuexi Ma627263f2021-03-04 13:47:56 -08001119func (j *TestHost) AddExtraResource(p android.Path) {
1120 j.extraResources = append(j.extraResources, p)
1121}
1122
Sam Delmericocc271e22022-06-01 15:45:02 +00001123func (j *TestHost) dataDeviceBins() []string {
1124 ret := make([]string, 0,
1125 len(j.testHostProperties.Data_device_bins_first)+
1126 len(j.testHostProperties.Data_device_bins_both)+
1127 len(j.testHostProperties.Data_device_bins_prefer32)+
1128 len(j.testHostProperties.Data_device_bins_32)+
1129 len(j.testHostProperties.Data_device_bins_64),
1130 )
1131
1132 ret = append(ret, j.testHostProperties.Data_device_bins_first...)
1133 ret = append(ret, j.testHostProperties.Data_device_bins_both...)
1134 ret = append(ret, j.testHostProperties.Data_device_bins_prefer32...)
1135 ret = append(ret, j.testHostProperties.Data_device_bins_32...)
1136 ret = append(ret, j.testHostProperties.Data_device_bins_64...)
1137
1138 return ret
1139}
1140
Sam Delmericob3342ce2022-01-20 21:10:28 +00001141func (j *TestHost) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1142 var configs []tradefed.Config
Sam Delmericocc271e22022-06-01 15:45:02 +00001143 dataDeviceBins := j.dataDeviceBins()
1144 if len(dataDeviceBins) > 0 {
Sam Delmericob3342ce2022-01-20 21:10:28 +00001145 // add Tradefed configuration to push device bins to device for testing
1146 remoteDir := filepath.Join("/data/local/tests/unrestricted/", j.Name())
1147 options := []tradefed.Option{{Name: "cleanup", Value: "true"}}
Sam Delmericocc271e22022-06-01 15:45:02 +00001148 for _, bin := range dataDeviceBins {
Sam Delmericob3342ce2022-01-20 21:10:28 +00001149 fullPath := filepath.Join(remoteDir, bin)
1150 options = append(options, tradefed.Option{Name: "push-file", Key: bin, Value: fullPath})
1151 }
Sam Delmericocc271e22022-06-01 15:45:02 +00001152 configs = append(configs, tradefed.Object{
1153 Type: "target_preparer",
1154 Class: "com.android.tradefed.targetprep.PushFilePreparer",
1155 Options: options,
1156 })
Sam Delmericob3342ce2022-01-20 21:10:28 +00001157 }
1158
1159 j.Test.generateAndroidBuildActionsWithConfig(ctx, configs)
1160}
1161
Colin Cross303e21f2018-08-07 16:49:25 -07001162func (j *Test) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Sam Delmericob3342ce2022-01-20 21:10:28 +00001163 j.generateAndroidBuildActionsWithConfig(ctx, nil)
1164}
1165
1166func (j *Test) generateAndroidBuildActionsWithConfig(ctx android.ModuleContext, configs []tradefed.Config) {
Julien Desprezb2166612021-03-05 18:08:36 +00001167 if j.testProperties.Test_options.Unit_test == nil && ctx.Host() {
1168 // TODO(b/): Clean temporary heuristic to avoid unexpected onboarding.
Julien Desprezf666b152021-03-15 13:07:53 -07001169 defaultUnitTest := !inList("tradefed", j.properties.Libs) && !inList("cts", j.testProperties.Test_suites)
Julien Desprezb2166612021-03-05 18:08:36 +00001170 j.testProperties.Test_options.Unit_test = proptools.BoolPtr(defaultUnitTest)
1171 }
Sam Delmericob3342ce2022-01-20 21:10:28 +00001172
Cole Faust8ec823c2022-12-07 18:18:37 -08001173 j.testConfig = tradefed.NewMaybeAutoGenTestConfigBuilder(ctx).
1174 SetTestConfigProp(j.testProperties.Test_config).
1175 SetTestTemplateConfigProp(j.testProperties.Test_config_template).
1176 SetTestSuites(j.testProperties.Test_suites).
1177 SetConfig(configs).
1178 SetOptionsForAutogenerated(j.testProperties.Test_options.Tradefed_options).
1179 SetAutoGenConfig(j.testProperties.Auto_gen_config).
1180 SetUnitTest(j.testProperties.Test_options.Unit_test).
1181 SetDeviceTemplate("${JavaTestConfigTemplate}").
1182 SetHostTemplate("${JavaHostTestConfigTemplate}").
1183 SetHostUnitTestTemplate("${JavaHostUnitTestConfigTemplate}").
1184 Build()
Liz Kammerdd849a82020-06-12 16:38:45 -07001185
Colin Cross8a497952019-03-05 22:25:09 -08001186 j.data = android.PathsForModuleSrc(ctx, j.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07001187
Dan Shi95d19422020-08-15 12:24:26 -07001188 j.extraTestConfigs = android.PathsForModuleSrc(ctx, j.testProperties.Test_options.Extra_test_configs)
1189
Liz Kammerdd849a82020-06-12 16:38:45 -07001190 ctx.VisitDirectDepsWithTag(dataNativeBinsTag, func(dep android.Module) {
1191 j.data = append(j.data, android.OutputFileForModule(ctx, dep, ""))
1192 })
1193
Sam Delmericob3342ce2022-01-20 21:10:28 +00001194 ctx.VisitDirectDepsWithTag(dataDeviceBinsTag, func(dep android.Module) {
1195 j.data = append(j.data, android.OutputFileForModule(ctx, dep, ""))
1196 })
1197
Colin Crossf8d9c492021-01-26 11:01:43 -08001198 ctx.VisitDirectDepsWithTag(jniLibTag, func(dep android.Module) {
1199 sharedLibInfo := ctx.OtherModuleProvider(dep, cc.SharedLibraryInfoProvider).(cc.SharedLibraryInfo)
1200 if sharedLibInfo.SharedLibrary != nil {
1201 // Copy to an intermediate output directory to append "lib[64]" to the path,
1202 // so that it's compatible with the default rpath values.
1203 var relPath string
1204 if sharedLibInfo.Target.Arch.ArchType.Multilib == "lib64" {
1205 relPath = filepath.Join("lib64", sharedLibInfo.SharedLibrary.Base())
1206 } else {
1207 relPath = filepath.Join("lib", sharedLibInfo.SharedLibrary.Base())
1208 }
1209 relocatedLib := android.PathForModuleOut(ctx, "relocated").Join(ctx, relPath)
1210 ctx.Build(pctx, android.BuildParams{
1211 Rule: android.Cp,
1212 Input: sharedLibInfo.SharedLibrary,
1213 Output: relocatedLib,
1214 })
1215 j.data = append(j.data, relocatedLib)
1216 } else {
1217 ctx.PropertyErrorf("jni_libs", "%q of type %q is not supported", dep.Name(), ctx.OtherModuleType(dep))
1218 }
1219 })
1220
Colin Cross303e21f2018-08-07 16:49:25 -07001221 j.Library.GenerateAndroidBuildActions(ctx)
Colin Cross05638fc2018-04-09 18:40:24 -07001222}
1223
Paul Duffin42df1442019-03-20 12:45:53 +00001224func (j *TestHelperLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1225 j.Library.GenerateAndroidBuildActions(ctx)
1226}
1227
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001228func (j *JavaTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Cole Faust8ec823c2022-12-07 18:18:37 -08001229 j.testConfig = tradefed.NewMaybeAutoGenTestConfigBuilder(ctx).
1230 SetTestConfigProp(j.prebuiltTestProperties.Test_config).
1231 SetTestSuites(j.prebuiltTestProperties.Test_suites).
1232 SetDeviceTemplate("${JavaTestConfigTemplate}").
1233 SetHostTemplate("${JavaHostTestConfigTemplate}").
1234 SetHostUnitTestTemplate("${JavaHostUnitTestConfigTemplate}").
1235 Build()
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001236
1237 j.Import.GenerateAndroidBuildActions(ctx)
1238}
1239
1240type testSdkMemberType struct {
1241 android.SdkMemberTypeBase
1242}
1243
Paul Duffin296701e2021-07-14 10:29:36 +01001244func (mt *testSdkMemberType) AddDependencies(ctx android.SdkDependencyContext, dependencyTag blueprint.DependencyTag, names []string) {
1245 ctx.AddVariationDependencies(nil, dependencyTag, names...)
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001246}
1247
1248func (mt *testSdkMemberType) IsInstance(module android.Module) bool {
1249 _, ok := module.(*Test)
1250 return ok
1251}
1252
Paul Duffin3a4eb502020-03-19 16:11:18 +00001253func (mt *testSdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
1254 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_test_import")
Paul Duffin14eb4672020-03-02 11:33:02 +00001255}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001256
Paul Duffin14eb4672020-03-02 11:33:02 +00001257func (mt *testSdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
1258 return &testSdkMemberProperties{}
1259}
1260
1261type testSdkMemberProperties struct {
1262 android.SdkMemberPropertiesBase
1263
Paul Duffina551a1c2020-03-17 21:04:24 +00001264 JarToExport android.Path
1265 TestConfig android.Path
Paul Duffin14eb4672020-03-02 11:33:02 +00001266}
1267
Paul Duffin3a4eb502020-03-19 16:11:18 +00001268func (p *testSdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffin14eb4672020-03-02 11:33:02 +00001269 test := variant.(*Test)
1270
1271 implementationJars := test.ImplementationJars()
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001272 if len(implementationJars) != 1 {
Paul Duffin14eb4672020-03-02 11:33:02 +00001273 panic(fmt.Errorf("there must be only one implementation jar from %q", test.Name()))
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001274 }
1275
Paul Duffina551a1c2020-03-17 21:04:24 +00001276 p.JarToExport = implementationJars[0]
1277 p.TestConfig = test.testConfig
Paul Duffin14eb4672020-03-02 11:33:02 +00001278}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001279
Paul Duffin3a4eb502020-03-19 16:11:18 +00001280func (p *testSdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffina551a1c2020-03-17 21:04:24 +00001281 builder := ctx.SnapshotBuilder()
Paul Duffin3a4eb502020-03-19 16:11:18 +00001282
Paul Duffina551a1c2020-03-17 21:04:24 +00001283 exportedJar := p.JarToExport
1284 if exportedJar != nil {
Paul Duffin13648912022-07-15 13:12:35 +00001285 snapshotRelativeJavaLibPath := sdkSnapshotFilePathForJar(ctx, p.OsPrefix(), ctx.Name())
Paul Duffina551a1c2020-03-17 21:04:24 +00001286 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
Paul Duffin14eb4672020-03-02 11:33:02 +00001287
1288 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
Paul Duffina551a1c2020-03-17 21:04:24 +00001289 }
1290
1291 testConfig := p.TestConfig
1292 if testConfig != nil {
1293 snapshotRelativeTestConfigPath := sdkSnapshotFilePathForMember(p.OsPrefix(), ctx.Name(), testConfigSuffix)
1294 builder.CopyToSnapshot(testConfig, snapshotRelativeTestConfigPath)
Paul Duffin14eb4672020-03-02 11:33:02 +00001295 propertySet.AddProperty("test_config", snapshotRelativeTestConfigPath)
1296 }
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001297}
1298
Colin Cross1b16b0e2019-02-12 14:41:32 -08001299// java_test builds a and links sources into a `.jar` file for the device, and possibly for the host as well, and
1300// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
1301//
1302// By default, a java_test has a single variant that produces a `.jar` file containing `classes.dex` files that were
1303// compiled against the device bootclasspath.
1304//
1305// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
1306// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07001307func TestFactory() android.Module {
1308 module := &Test{}
1309
Colin Crossce6734e2020-06-15 16:09:53 -07001310 module.addHostAndDeviceProperties()
1311 module.AddProperties(&module.testProperties)
Colin Cross05638fc2018-04-09 18:40:24 -07001312
Colin Cross9ae1b922018-06-26 17:59:05 -07001313 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse3026872019-01-05 22:30:13 -08001314 module.Module.dexpreopter.isTest = true
Cole Faustd57e8b22022-08-11 11:59:04 -07001315 module.Module.linter.properties.Lint.Test = proptools.BoolPtr(true)
Colin Cross9ae1b922018-06-26 17:59:05 -07001316
Paul Duffinb6b89a42021-05-06 16:33:43 +01001317 android.InitSdkAwareModule(module)
Colin Cross05638fc2018-04-09 18:40:24 -07001318 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07001319 return module
1320}
1321
Paul Duffin42df1442019-03-20 12:45:53 +00001322// java_test_helper_library creates a java library and makes sure that it is added to the appropriate test suite.
1323func TestHelperLibraryFactory() android.Module {
1324 module := &TestHelperLibrary{}
1325
Colin Crossce6734e2020-06-15 16:09:53 -07001326 module.addHostAndDeviceProperties()
1327 module.AddProperties(&module.testHelperLibraryProperties)
Paul Duffin42df1442019-03-20 12:45:53 +00001328
Colin Cross9a4abed2019-04-24 13:19:28 -07001329 module.Module.properties.Installable = proptools.BoolPtr(true)
1330 module.Module.dexpreopter.isTest = true
Cole Faustd57e8b22022-08-11 11:59:04 -07001331 module.Module.linter.properties.Lint.Test = proptools.BoolPtr(true)
Colin Cross9a4abed2019-04-24 13:19:28 -07001332
Paul Duffin42df1442019-03-20 12:45:53 +00001333 InitJavaModule(module, android.HostAndDeviceSupported)
1334 return module
1335}
1336
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001337// java_test_import imports one or more `.jar` files into the build graph as if they were built by a java_test module
1338// and makes sure that it is added to the appropriate test suite.
1339//
1340// By default, a java_test_import has a single variant that expects a `.jar` file containing `.class` files that were
1341// compiled against an Android classpath.
1342//
1343// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
1344// for host modules.
1345func JavaTestImportFactory() android.Module {
1346 module := &JavaTestImport{}
1347
1348 module.AddProperties(
1349 &module.Import.properties,
1350 &module.prebuiltTestProperties)
1351
1352 module.Import.properties.Installable = proptools.BoolPtr(true)
1353
1354 android.InitPrebuiltModule(module, &module.properties.Jars)
1355 android.InitApexModule(module)
1356 android.InitSdkAwareModule(module)
1357 InitJavaModule(module, android.HostAndDeviceSupported)
1358 return module
1359}
1360
Colin Cross1b16b0e2019-02-12 14:41:32 -08001361// java_test_host builds a and links sources into a `.jar` file for the host, and creates an `AndroidTest.xml` file to
1362// allow running the test with `atest` or a `TEST_MAPPING` file.
1363//
1364// A java_test_host has a single variant that produces a `.jar` file containing `.class` files that were
1365// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07001366func TestHostFactory() android.Module {
Liz Kammerdd849a82020-06-12 16:38:45 -07001367 module := &TestHost{}
Colin Cross05638fc2018-04-09 18:40:24 -07001368
Colin Crossce6734e2020-06-15 16:09:53 -07001369 module.addHostProperties()
1370 module.AddProperties(&module.testProperties)
Liz Kammerdd849a82020-06-12 16:38:45 -07001371 module.AddProperties(&module.testHostProperties)
Colin Cross05638fc2018-04-09 18:40:24 -07001372
Yuexi Ma627263f2021-03-04 13:47:56 -08001373 InitTestHost(
1374 module,
1375 proptools.BoolPtr(true),
1376 nil,
1377 nil)
Colin Cross9ae1b922018-06-26 17:59:05 -07001378
Liz Kammerdd849a82020-06-12 16:38:45 -07001379 InitJavaModuleMultiTargets(module, android.HostSupported)
Julien Desprezb2166612021-03-05 18:08:36 +00001380
Colin Cross05638fc2018-04-09 18:40:24 -07001381 return module
1382}
1383
Yuexi Ma627263f2021-03-04 13:47:56 -08001384func InitTestHost(th *TestHost, installable *bool, testSuites []string, autoGenConfig *bool) {
1385 th.properties.Installable = installable
1386 th.testProperties.Auto_gen_config = autoGenConfig
1387 th.testProperties.Test_suites = testSuites
1388}
1389
Colin Cross05638fc2018-04-09 18:40:24 -07001390//
Colin Cross2fe66872015-03-30 17:20:39 -07001391// Java Binaries (.jar file plus wrapper script)
1392//
1393
Colin Crossf506d872017-07-19 15:53:04 -07001394type binaryProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -07001395 // installable script to execute the resulting jar
Dan Willemsen8e6b3712021-09-20 23:11:24 -07001396 Wrapper *string `android:"path,arch_variant"`
Colin Cross094054a2018-10-17 15:10:48 -07001397
1398 // Name of the class containing main to be inserted into the manifest as Main-Class.
1399 Main_class *string
Colin Cross89226d92020-10-09 19:00:54 -07001400
1401 // Names of modules containing JNI libraries that should be installed alongside the host
1402 // variant of the binary.
Dan Willemsen8e6b3712021-09-20 23:11:24 -07001403 Jni_libs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -07001404}
1405
Colin Crossf506d872017-07-19 15:53:04 -07001406type Binary struct {
1407 Library
Colin Cross2fe66872015-03-30 17:20:39 -07001408
Colin Crossf506d872017-07-19 15:53:04 -07001409 binaryProperties binaryProperties
Colin Cross10a03492017-08-10 17:09:43 -07001410
Colin Cross6b4a32d2017-12-05 13:42:45 -08001411 isWrapperVariant bool
1412
Colin Crossc3315992017-12-08 19:12:36 -08001413 wrapperFile android.Path
Colin Cross70dda7e2019-10-01 22:05:35 -07001414 binaryFile android.InstallPath
Colin Cross2fe66872015-03-30 17:20:39 -07001415}
1416
Alex Light24237172017-10-26 09:46:21 -07001417func (j *Binary) HostToolPath() android.OptionalPath {
1418 return android.OptionalPathForPath(j.binaryFile)
1419}
1420
Colin Crossf506d872017-07-19 15:53:04 -07001421func (j *Binary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08001422 if ctx.Arch().ArchType == android.Common {
1423 // Compile the jar
Colin Cross094054a2018-10-17 15:10:48 -07001424 if j.binaryProperties.Main_class != nil {
1425 if j.properties.Manifest != nil {
1426 ctx.PropertyErrorf("main_class", "main_class cannot be used when manifest is set")
1427 }
1428 manifestFile := android.PathForModuleOut(ctx, "manifest.txt")
1429 GenerateMainClassManifest(ctx, manifestFile, String(j.binaryProperties.Main_class))
1430 j.overrideManifest = android.OptionalPathForPath(manifestFile)
1431 }
1432
Colin Cross6b4a32d2017-12-05 13:42:45 -08001433 j.Library.GenerateAndroidBuildActions(ctx)
Nan Zhang3c807db2017-11-03 14:53:31 -07001434 } else {
Colin Cross6b4a32d2017-12-05 13:42:45 -08001435 // Handle the binary wrapper
1436 j.isWrapperVariant = true
1437
Colin Cross366938f2017-12-11 16:29:02 -08001438 if j.binaryProperties.Wrapper != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001439 j.wrapperFile = android.PathForModuleSrc(ctx, *j.binaryProperties.Wrapper)
Colin Cross6b4a32d2017-12-05 13:42:45 -08001440 } else {
Dan Willemsen8e6b3712021-09-20 23:11:24 -07001441 if ctx.Windows() {
1442 ctx.PropertyErrorf("wrapper", "wrapper is required for Windows")
1443 }
1444
Zi Wangca65b402022-10-10 13:45:06 -07001445 if ctx.Device() {
1446 // device binary should have a main_class property if it does not
1447 // have a specific wrapper, so that a default wrapper can
1448 // be generated for it.
1449 if j.binaryProperties.Main_class == nil {
1450 ctx.PropertyErrorf("main_class", "main_class property "+
1451 "is required for device binary if no default wrapper is assigned")
1452 } else {
1453 wrapper := android.PathForModuleOut(ctx, ctx.ModuleName()+".sh")
1454 jarName := j.Stem() + ".jar"
1455 partition := j.PartitionTag(ctx.DeviceConfig())
1456 ctx.Build(pctx, android.BuildParams{
1457 Rule: deviceBinaryWrapper,
1458 Output: wrapper,
1459 Args: map[string]string{
1460 "jar_name": jarName,
1461 "partition": partition,
1462 "main_class": String(j.binaryProperties.Main_class),
1463 },
1464 })
1465 j.wrapperFile = wrapper
1466 }
1467 } else {
1468 j.wrapperFile = android.PathForSource(ctx, "build/soong/scripts/jar-wrapper.sh")
1469 }
Colin Cross6b4a32d2017-12-05 13:42:45 -08001470 }
1471
Dan Willemsen8e6b3712021-09-20 23:11:24 -07001472 ext := ""
1473 if ctx.Windows() {
1474 ext = ".bat"
1475 }
1476
Colin Crossc179ea62020-10-09 10:54:15 -07001477 // The host installation rules make the installed wrapper depend on all the dependencies
Colin Cross89226d92020-10-09 19:00:54 -07001478 // of the wrapper variant, which will include the common variant's jar file and any JNI
1479 // libraries. This is verified by TestBinary.
Colin Cross6b4a32d2017-12-05 13:42:45 -08001480 j.binaryFile = ctx.InstallExecutable(android.PathForModuleInstall(ctx, "bin"),
Dan Willemsen8e6b3712021-09-20 23:11:24 -07001481 ctx.ModuleName()+ext, j.wrapperFile)
1482 }
Colin Cross2fe66872015-03-30 17:20:39 -07001483}
1484
Colin Crossf506d872017-07-19 15:53:04 -07001485func (j *Binary) DepsMutator(ctx android.BottomUpMutatorContext) {
Liz Kammer3bf97bd2022-04-26 09:38:20 -04001486 if ctx.Arch().ArchType == android.Common {
Colin Cross6b4a32d2017-12-05 13:42:45 -08001487 j.deps(ctx)
Liz Kammer356f7d42021-01-26 09:18:53 -05001488 }
Liz Kammer3bf97bd2022-04-26 09:38:20 -04001489 if ctx.Arch().ArchType != android.Common {
Colin Crosse9fe2942020-11-10 18:12:15 -08001490 // These dependencies ensure the host installation rules will install the jar file and
1491 // the jni libraries when the wrapper is installed.
1492 ctx.AddVariationDependencies(nil, jniInstallTag, j.binaryProperties.Jni_libs...)
1493 ctx.AddVariationDependencies(
1494 []blueprint.Variation{{Mutator: "arch", Variation: android.CommonArch.String()}},
1495 binaryInstallTag, ctx.ModuleName())
Colin Cross6b4a32d2017-12-05 13:42:45 -08001496 }
Colin Cross46c9b8b2017-06-22 16:51:17 -07001497}
1498
Colin Cross1b16b0e2019-02-12 14:41:32 -08001499// java_binary builds a `.jar` file and a shell script that executes it for the device, and possibly for the host
1500// as well.
1501//
1502// By default, a java_binary has a single variant that produces a `.jar` file containing `classes.dex` files that were
1503// compiled against the device bootclasspath.
1504//
1505// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
1506// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07001507func BinaryFactory() android.Module {
1508 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07001509
Colin Crossce6734e2020-06-15 16:09:53 -07001510 module.addHostAndDeviceProperties()
1511 module.AddProperties(&module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07001512
Colin Cross9ae1b922018-06-26 17:59:05 -07001513 module.Module.properties.Installable = proptools.BoolPtr(true)
1514
Colin Cross6b4a32d2017-12-05 13:42:45 -08001515 android.InitAndroidArchModule(module, android.HostAndDeviceSupported, android.MultilibCommonFirst)
1516 android.InitDefaultableModule(module)
Wei Libafb6d62021-12-10 03:14:59 -08001517 android.InitBazelModule(module)
1518
Colin Cross36242852017-06-23 15:06:31 -07001519 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001520}
1521
Colin Cross1b16b0e2019-02-12 14:41:32 -08001522// java_binary_host builds a `.jar` file and a shell script that executes it for the host.
1523//
1524// A java_binary_host has a single variant that produces a `.jar` file containing `.class` files that were
1525// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07001526func BinaryHostFactory() android.Module {
1527 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07001528
Colin Crossce6734e2020-06-15 16:09:53 -07001529 module.addHostProperties()
1530 module.AddProperties(&module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07001531
Colin Cross9ae1b922018-06-26 17:59:05 -07001532 module.Module.properties.Installable = proptools.BoolPtr(true)
1533
Colin Cross6b4a32d2017-12-05 13:42:45 -08001534 android.InitAndroidArchModule(module, android.HostSupported, android.MultilibCommonFirst)
1535 android.InitDefaultableModule(module)
Wei Libafb6d62021-12-10 03:14:59 -08001536 android.InitBazelModule(module)
Colin Cross36242852017-06-23 15:06:31 -07001537 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001538}
1539
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001540type JavaApiContribution struct {
1541 android.ModuleBase
1542 android.DefaultableModuleBase
1543
1544 properties struct {
1545 // name of the API surface
1546 Api_surface *string
1547
1548 // relative path to the API signature text file
1549 Api_file *string `android:"path"`
1550 }
1551}
1552
1553func ApiContributionFactory() android.Module {
1554 module := &JavaApiContribution{}
1555 android.InitAndroidModule(module)
1556 android.InitDefaultableModule(module)
1557 module.AddProperties(&module.properties)
1558 return module
1559}
1560
1561type JavaApiImportInfo struct {
1562 ApiFile android.Path
1563}
1564
1565var JavaApiImportProvider = blueprint.NewProvider(JavaApiImportInfo{})
1566
1567func (ap *JavaApiContribution) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1568 apiFile := android.PathForModuleSrc(ctx, String(ap.properties.Api_file))
1569 ctx.SetProvider(JavaApiImportProvider, JavaApiImportInfo{
1570 ApiFile: apiFile,
1571 })
1572}
1573
1574type ApiLibrary struct {
1575 android.ModuleBase
1576 android.DefaultableModuleBase
1577
1578 properties JavaApiLibraryProperties
1579
1580 stubsSrcJar android.WritablePath
1581 stubsJar android.WritablePath
1582}
1583
1584type JavaApiLibraryProperties struct {
1585 // name of the API surface
1586 Api_surface *string
1587
Jihoon Kang60d4a092022-11-17 23:47:43 +00001588 // list of Java API contribution modules that consists this API surface
Spandan Dasc082eb82022-12-01 21:43:06 +00001589 // This is a list of Soong modules
Jihoon Kang60d4a092022-11-17 23:47:43 +00001590 Api_contributions []string
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001591
Spandan Dasc082eb82022-12-01 21:43:06 +00001592 // list of api.txt files relative to this directory that contribute to the
1593 // API surface.
1594 // This is a list of relative paths
1595 Api_files []string
1596
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001597 // List of flags to be passed to the javac compiler to generate jar file
1598 Javacflags []string
1599}
1600
1601func ApiLibraryFactory() android.Module {
1602 module := &ApiLibrary{}
1603 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibCommon)
1604 android.InitDefaultableModule(module)
1605 module.AddProperties(&module.properties)
1606 return module
1607}
1608
1609func (al *ApiLibrary) ApiSurface() *string {
1610 return al.properties.Api_surface
1611}
1612
1613func (al *ApiLibrary) StubsJar() android.Path {
1614 return al.stubsJar
1615}
1616
1617func metalavaStubCmd(ctx android.ModuleContext, rule *android.RuleBuilder,
1618 srcs android.Paths, homeDir android.WritablePath) *android.RuleBuilderCommand {
1619 rule.Command().Text("rm -rf").Flag(homeDir.String())
1620 rule.Command().Text("mkdir -p").Flag(homeDir.String())
1621
1622 cmd := rule.Command()
1623 cmd.FlagWithArg("ANDROID_PREFS_ROOT=", homeDir.String())
1624
1625 if metalavaUseRbe(ctx) {
1626 rule.Remoteable(android.RemoteRuleSupports{RBE: true})
1627 execStrategy := ctx.Config().GetenvWithDefault("RBE_METALAVA_EXEC_STRATEGY", remoteexec.LocalExecStrategy)
1628 labels := map[string]string{"type": "tool", "name": "metalava"}
1629
1630 pool := ctx.Config().GetenvWithDefault("RBE_METALAVA_POOL", "java16")
1631 rule.Rewrapper(&remoteexec.REParams{
1632 Labels: labels,
1633 ExecStrategy: execStrategy,
1634 ToolchainInputs: []string{config.JavaCmd(ctx).String()},
1635 Platform: map[string]string{remoteexec.PoolKey: pool},
1636 })
1637 }
1638
1639 cmd.BuiltTool("metalava").ImplicitTool(ctx.Config().HostJavaToolPath(ctx, "metalava.jar")).
1640 Flag(config.JavacVmFlags).
1641 Flag("-J--add-opens=java.base/java.util=ALL-UNNAMED").
1642 FlagWithArg("-encoding ", "UTF-8").
1643 FlagWithInputList("--source-files ", srcs, " ")
1644
1645 cmd.Flag("--no-banner").
1646 Flag("--color").
1647 Flag("--quiet").
1648 Flag("--format=v2").
1649 FlagWithArg("--repeat-errors-max ", "10").
1650 FlagWithArg("--hide ", "UnresolvedImport").
1651 FlagWithArg("--hide ", "InvalidNullabilityOverride").
1652 FlagWithArg("--hide ", "ChangedDefault")
1653
1654 return cmd
1655}
1656
1657func (al *ApiLibrary) stubsFlags(ctx android.ModuleContext, cmd *android.RuleBuilderCommand, stubsDir android.OptionalPath) {
1658 if stubsDir.Valid() {
1659 cmd.FlagWithArg("--stubs ", stubsDir.String())
1660 }
1661}
1662
Jihoon Kang60d4a092022-11-17 23:47:43 +00001663var javaApiContributionTag = dependencyTag{name: "java-api-contribution"}
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001664
1665func (al *ApiLibrary) DepsMutator(ctx android.BottomUpMutatorContext) {
Jihoon Kang60d4a092022-11-17 23:47:43 +00001666 apiContributions := al.properties.Api_contributions
1667 for _, apiContributionName := range apiContributions {
1668 ctx.AddDependency(ctx.Module(), javaApiContributionTag, apiContributionName)
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001669 }
1670}
1671
1672func (al *ApiLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1673
1674 rule := android.NewRuleBuilder(pctx, ctx)
1675
1676 rule.Sbox(android.PathForModuleOut(ctx, "metalava"),
1677 android.PathForModuleOut(ctx, "metalava.sbox.textproto")).
1678 SandboxInputs()
1679
1680 var stubsDir android.OptionalPath
1681 stubsDir = android.OptionalPathForPath(android.PathForModuleOut(ctx, "metalava", "stubsDir"))
1682 rule.Command().Text("rm -rf").Text(stubsDir.String())
1683 rule.Command().Text("mkdir -p").Text(stubsDir.String())
1684
1685 homeDir := android.PathForModuleOut(ctx, "metalava", "home")
1686
Jihoon Kang60d4a092022-11-17 23:47:43 +00001687 var srcFiles []android.Path
1688 ctx.VisitDirectDepsWithTag(javaApiContributionTag, func(dep android.Module) {
1689 provider := ctx.OtherModuleProvider(dep, JavaApiImportProvider).(JavaApiImportInfo)
Jihoon Kang423d2292022-11-29 23:10:10 +00001690 srcFiles = append(srcFiles, android.PathForSource(ctx, provider.ApiFile.String()))
Jihoon Kang60d4a092022-11-17 23:47:43 +00001691 })
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001692
Spandan Dasc082eb82022-12-01 21:43:06 +00001693 // Add the api_files inputs
1694 for _, api := range al.properties.Api_files {
1695 // Use MaybeExistentPathForSource since the api file might not exist during analysis.
1696 // This will be provided by the orchestrator in the combined execution.
1697 srcFiles = append(srcFiles, android.MaybeExistentPathForSource(ctx, ctx.ModuleDir(), api))
1698 }
1699
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001700 cmd := metalavaStubCmd(ctx, rule, srcFiles, homeDir)
1701
1702 al.stubsFlags(ctx, cmd, stubsDir)
1703
1704 al.stubsSrcJar = android.PathForModuleOut(ctx, "metalava", ctx.ModuleName()+"-"+"stubs.srcjar")
1705 rule.Command().
1706 BuiltTool("soong_zip").
1707 Flag("-write_if_changed").
1708 Flag("-jar").
1709 FlagWithOutput("-o ", al.stubsSrcJar).
1710 FlagWithArg("-C ", stubsDir.String()).
1711 FlagWithArg("-D ", stubsDir.String())
1712
1713 rule.Build("metalava", "metalava merged")
1714
1715 al.stubsJar = android.PathForModuleOut(ctx, ctx.ModuleName(), "android.jar")
1716
1717 var flags javaBuilderFlags
1718 flags.javacFlags = strings.Join(al.properties.Javacflags, " ")
1719
1720 TransformJavaToClasses(ctx, al.stubsJar, 0, android.Paths{},
1721 android.Paths{al.stubsSrcJar}, flags, android.Paths{})
Jihoon Kang423d2292022-11-29 23:10:10 +00001722
1723 ctx.Phony(ctx.ModuleName(), al.stubsJar)
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001724}
1725
Colin Cross2fe66872015-03-30 17:20:39 -07001726//
1727// Java prebuilts
1728//
1729
Colin Cross74d73e22017-08-02 11:05:49 -07001730type ImportProperties struct {
Paul Duffina04c1072020-03-02 10:16:35 +00001731 Jars []string `android:"path,arch_variant"`
Colin Cross461bd1a2017-10-20 13:59:18 -07001732
Jaewoong Jung56e12db2021-04-02 00:38:25 +00001733 // The version of the SDK that the source prebuilt file was built against. Defaults to the
1734 // current version if not specified.
Nan Zhangea568a42017-11-08 21:20:04 -08001735 Sdk_version *string
Colin Cross535e2cf2017-10-20 17:57:49 -07001736
Jaewoong Jung56e12db2021-04-02 00:38:25 +00001737 // The minimum version of the SDK that this module supports. Defaults to sdk_version if not
1738 // specified.
1739 Min_sdk_version *string
1740
William Loh5a082f92022-05-17 20:21:50 +00001741 // The max sdk version placeholder used to replace maxSdkVersion attributes on permission
1742 // and uses-permission tags in manifest_fixer.
1743 Replace_max_sdk_version_placeholder *string
1744
Colin Cross535e2cf2017-10-20 17:57:49 -07001745 Installable *bool
Jiyong Park1be96912018-05-28 18:02:19 +09001746
Paul Duffin869de142021-07-15 14:14:41 +01001747 // If not empty, classes are restricted to the specified packages and their sub-packages.
Paul Duffin869de142021-07-15 14:14:41 +01001748 Permitted_packages []string
1749
Jiyong Park1be96912018-05-28 18:02:19 +09001750 // List of shared java libs that this module has dependencies to
1751 Libs []string
Colin Cross37f6d792018-07-12 12:28:41 -07001752
1753 // List of files to remove from the jar file(s)
1754 Exclude_files []string
1755
1756 // List of directories to remove from the jar file(s)
1757 Exclude_dirs []string
Nan Zhang4c819fb2018-08-27 18:31:46 -07001758
1759 // if set to true, run Jetifier against .jar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -07001760 Jetifier *bool
Jiyong Park4c4c0242019-10-21 14:53:15 +09001761
1762 // set the name of the output
1763 Stem *string
Jiyong Park19604de2020-03-24 16:44:11 +09001764
1765 Aidl struct {
1766 // directories that should be added as include directories for any aidl sources of modules
1767 // that depend on this module, as well as to aidl for this module.
1768 Export_include_dirs []string
1769 }
Colin Cross74d73e22017-08-02 11:05:49 -07001770}
1771
1772type Import struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001773 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -07001774 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09001775 android.ApexModuleBase
Romain Jobredeaux428a3662022-01-28 11:12:52 -05001776 android.BazelModuleBase
Colin Crossec7a0422017-07-07 14:47:12 -07001777 prebuilt android.Prebuilt
Jiyong Parkd1063c12019-07-17 20:08:41 +09001778 android.SdkBase
Colin Cross2fe66872015-03-30 17:20:39 -07001779
Paul Duffin0d3c2e12020-05-17 08:34:50 +01001780 // Functionality common to Module and Import.
1781 embeddableInModuleAndImport
1782
Liz Kammerd6c31d22020-08-05 15:40:41 -07001783 hiddenAPI
1784 dexer
Bill Peckhamff89ffa2020-12-23 16:13:04 -08001785 dexpreopter
Liz Kammerd6c31d22020-08-05 15:40:41 -07001786
Colin Cross74d73e22017-08-02 11:05:49 -07001787 properties ImportProperties
1788
Liz Kammerd6c31d22020-08-05 15:40:41 -07001789 // output file containing classes.dex and resources
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001790 dexJarFile OptionalDexJarPath
Jeongik Chad5fe8782021-07-08 01:13:11 +09001791 dexJarInstallFile android.Path
Liz Kammerd6c31d22020-08-05 15:40:41 -07001792
Colin Cross0a6e0072017-08-30 14:24:55 -07001793 combinedClasspathFile android.Path
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01001794 classLoaderContexts dexpreopt.ClassLoaderContextMap
Jiyong Park19604de2020-03-24 16:44:11 +09001795 exportAidlIncludeDirs android.Paths
Colin Cross56a83212020-09-15 18:30:11 -07001796
1797 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +09001798
1799 sdkVersion android.SdkSpec
1800 minSdkVersion android.SdkSpec
Colin Cross2fe66872015-03-30 17:20:39 -07001801}
1802
Paul Duffin630b11e2021-07-15 13:35:26 +01001803var _ PermittedPackagesForUpdatableBootJars = (*Import)(nil)
1804
1805func (j *Import) PermittedPackagesForUpdatableBootJars() []string {
1806 return j.properties.Permitted_packages
1807}
1808
Jiyong Park92315372021-04-02 08:45:46 +09001809func (j *Import) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
1810 return android.SdkSpecFrom(ctx, String(j.properties.Sdk_version))
Liz Kammer2d2fd852020-08-12 14:42:30 -07001811}
1812
Jiyong Parkf1691d22021-03-29 20:11:58 +09001813func (j *Import) SystemModules() string {
Liz Kammerd6c31d22020-08-05 15:40:41 -07001814 return "none"
1815}
1816
Jiyong Park92315372021-04-02 08:45:46 +09001817func (j *Import) MinSdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
Jaewoong Jung56e12db2021-04-02 00:38:25 +00001818 if j.properties.Min_sdk_version != nil {
Jiyong Park92315372021-04-02 08:45:46 +09001819 return android.SdkSpecFrom(ctx, *j.properties.Min_sdk_version)
Jaewoong Jung56e12db2021-04-02 00:38:25 +00001820 }
Jiyong Park92315372021-04-02 08:45:46 +09001821 return j.SdkVersion(ctx)
Colin Cross83bb3162018-06-25 15:48:06 -07001822}
1823
William Loh5a082f92022-05-17 20:21:50 +00001824func (j *Import) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.SdkSpec {
1825 if j.properties.Replace_max_sdk_version_placeholder != nil {
1826 return android.SdkSpecFrom(ctx, *j.properties.Replace_max_sdk_version_placeholder)
1827 }
1828 return android.SdkSpecFrom(ctx, "")
1829}
1830
Jiyong Park92315372021-04-02 08:45:46 +09001831func (j *Import) TargetSdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
1832 return j.SdkVersion(ctx)
Artur Satayev480e25b2020-04-27 18:53:18 +01001833}
1834
Colin Cross74d73e22017-08-02 11:05:49 -07001835func (j *Import) Prebuilt() *android.Prebuilt {
Colin Crossec7a0422017-07-07 14:47:12 -07001836 return &j.prebuilt
1837}
1838
Colin Cross74d73e22017-08-02 11:05:49 -07001839func (j *Import) PrebuiltSrcs() []string {
1840 return j.properties.Jars
1841}
1842
1843func (j *Import) Name() string {
Colin Cross5ea9bcc2017-07-27 15:41:32 -07001844 return j.prebuilt.Name(j.ModuleBase.Name())
1845}
1846
Jiyong Park0b238752019-10-29 11:23:10 +09001847func (j *Import) Stem() string {
1848 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
1849}
1850
Jiyong Park618922e2020-01-08 13:35:43 +09001851func (a *Import) JacocoReportClassesFile() android.Path {
1852 return nil
1853}
1854
Bill Peckhama41a6962021-01-11 10:58:54 -08001855func (j *Import) LintDepSets() LintDepSets {
1856 return LintDepSets{}
1857}
1858
Jaewoong Jung476b9d62021-05-10 15:30:00 -07001859func (j *Import) getStrictUpdatabilityLinting() bool {
1860 return false
1861}
1862
1863func (j *Import) setStrictUpdatabilityLinting(bool) {
1864}
1865
Colin Cross74d73e22017-08-02 11:05:49 -07001866func (j *Import) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross42d48b72018-08-29 14:10:52 -07001867 ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Liz Kammerd6c31d22020-08-05 15:40:41 -07001868
1869 if ctx.Device() && Bool(j.dexProperties.Compile_dex) {
Jiyong Parkf1691d22021-03-29 20:11:58 +09001870 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Liz Kammerd6c31d22020-08-05 15:40:41 -07001871 }
Colin Cross1e676be2016-10-12 14:38:15 -07001872}
1873
Sam Delmerico277795c2022-02-25 17:04:37 +00001874func (j *Import) commonBuildActions(ctx android.ModuleContext) {
Paul Duffin7ed6ff82022-11-21 10:57:30 +00001875 //TODO(b/231322772) these should come from Bazel once available
Jiyong Park92315372021-04-02 08:45:46 +09001876 j.sdkVersion = j.SdkVersion(ctx)
1877 j.minSdkVersion = j.MinSdkVersion(ctx)
1878
Colin Cross56a83212020-09-15 18:30:11 -07001879 if !ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform() {
1880 j.hideApexVariantFromMake = true
1881 }
1882
Dan Willemsen8e6b3712021-09-20 23:11:24 -07001883 if ctx.Windows() {
1884 j.HideFromMake()
1885 }
Sam Delmerico277795c2022-02-25 17:04:37 +00001886}
1887
1888func (j *Import) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1889 j.commonBuildActions(ctx)
Dan Willemsen8e6b3712021-09-20 23:11:24 -07001890
Colin Cross8a497952019-03-05 22:25:09 -08001891 jars := android.PathsForModuleSrc(ctx, j.properties.Jars)
Colin Crosse1d62a82015-04-03 16:53:05 -07001892
Jiyong Park0b238752019-10-29 11:23:10 +09001893 jarName := j.Stem() + ".jar"
Nan Zhang4c819fb2018-08-27 18:31:46 -07001894 outputFile := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001895 TransformJarsToJar(ctx, outputFile, "for prebuilts", jars, android.OptionalPath{},
1896 false, j.properties.Exclude_files, j.properties.Exclude_dirs)
Colin Cross1001a792019-03-21 22:21:39 -07001897 if Bool(j.properties.Jetifier) {
Nan Zhang4c819fb2018-08-27 18:31:46 -07001898 inputFile := outputFile
1899 outputFile = android.PathForModuleOut(ctx, "jetifier", jarName)
1900 TransformJetifier(ctx, outputFile, inputFile)
1901 }
Colin Crosse9a275b2017-10-16 17:09:48 -07001902 j.combinedClasspathFile = outputFile
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01001903 j.classLoaderContexts = make(dexpreopt.ClassLoaderContextMap)
Paul Duffin859fe962020-05-15 10:20:31 +01001904
Liz Kammerd6c31d22020-08-05 15:40:41 -07001905 var flags javaBuilderFlags
1906
Jiyong Park1be96912018-05-28 18:02:19 +09001907 ctx.VisitDirectDeps(func(module android.Module) {
Jiyong Park1be96912018-05-28 18:02:19 +09001908 tag := ctx.OtherModuleDependencyTag(module)
1909
Colin Crossdcf71b22021-02-01 13:59:03 -08001910 if ctx.OtherModuleHasProvider(module, JavaInfoProvider) {
1911 dep := ctx.OtherModuleProvider(module, JavaInfoProvider).(JavaInfo)
Jiyong Park1be96912018-05-28 18:02:19 +09001912 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04001913 case libTag, sdkLibTag:
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001914 flags.classpath = append(flags.classpath, dep.HeaderJars...)
1915 flags.dexClasspath = append(flags.dexClasspath, dep.HeaderJars...)
1916 case staticLibTag:
Colin Crossdcf71b22021-02-01 13:59:03 -08001917 flags.classpath = append(flags.classpath, dep.HeaderJars...)
Liz Kammerd6c31d22020-08-05 15:40:41 -07001918 case bootClasspathTag:
Colin Crossdcf71b22021-02-01 13:59:03 -08001919 flags.bootClasspath = append(flags.bootClasspath, dep.HeaderJars...)
Jiyong Park1be96912018-05-28 18:02:19 +09001920 }
Colin Crossdcf71b22021-02-01 13:59:03 -08001921 } else if dep, ok := module.(SdkLibraryDependency); ok {
Jiyong Park1be96912018-05-28 18:02:19 +09001922 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04001923 case libTag, sdkLibTag:
Jiyong Park92315372021-04-02 08:45:46 +09001924 flags.classpath = append(flags.classpath, dep.SdkHeaderJars(ctx, j.SdkVersion(ctx))...)
Jiyong Park1be96912018-05-28 18:02:19 +09001925 }
1926 }
Ulya Trafimovich65b03192020-12-03 16:50:22 +00001927
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00001928 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiyong Park1be96912018-05-28 18:02:19 +09001929 })
1930
Sam Delmerico277795c2022-02-25 17:04:37 +00001931 j.maybeInstall(ctx, jarName, outputFile)
Jiyong Park19604de2020-03-24 16:44:11 +09001932
1933 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.properties.Aidl.Export_include_dirs)
Liz Kammerd6c31d22020-08-05 15:40:41 -07001934
Paul Duffin064b70c2020-11-02 17:32:38 +00001935 if ctx.Device() {
1936 // If this is a variant created for a prebuilt_apex then use the dex implementation jar
1937 // obtained from the associated deapexer module.
1938 ai := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1939 if ai.ForPrebuiltApex {
Paul Duffin064b70c2020-11-02 17:32:38 +00001940 // Get the path of the dex implementation jar from the `deapexer` module.
Martin Stjernholm44825602021-09-17 01:44:12 +01001941 di := android.FindDeapexerProviderForModule(ctx)
1942 if di == nil {
1943 return // An error has been reported by FindDeapexerProviderForModule.
1944 }
Paul Duffinb4bbf2c2021-06-17 15:59:07 +01001945 if dexOutputPath := di.PrebuiltExportPath(apexRootRelativePathToJavaLib(j.BaseModuleName())); dexOutputPath != nil {
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001946 dexJarFile := makeDexJarPathFromPath(dexOutputPath)
1947 j.dexJarFile = dexJarFile
Jiakai Zhang5b24f722021-09-30 09:32:57 +00001948 installPath := android.PathForModuleInPartitionInstall(ctx, "apex", ai.ApexVariationName, apexRootRelativePathToJavaLib(j.BaseModuleName()))
1949 j.dexJarInstallFile = installPath
Paul Duffin74d18d12021-05-14 14:18:47 +01001950
Jiakai Zhang5b24f722021-09-30 09:32:57 +00001951 j.dexpreopter.installPath = j.dexpreopter.getInstallPath(ctx, installPath)
Jiakai Zhang22450f22021-10-11 03:05:20 +00001952 setUncompressDex(ctx, &j.dexpreopter, &j.dexer)
Jiakai Zhang5b24f722021-09-30 09:32:57 +00001953 j.dexpreopter.uncompressedDex = *j.dexProperties.Uncompress_dex
1954 j.dexpreopt(ctx, dexOutputPath)
Jiakai Zhang22450f22021-10-11 03:05:20 +00001955
1956 // Initialize the hiddenapi structure.
1957 j.initHiddenAPI(ctx, dexJarFile, outputFile, j.dexProperties.Uncompress_dex)
Paul Duffin9d67ca62021-02-03 20:06:33 +00001958 } else {
Paul Duffin064b70c2020-11-02 17:32:38 +00001959 // This should never happen as a variant for a prebuilt_apex is only created if the
1960 // prebuilt_apex has been configured to export the java library dex file.
Martin Stjernholm44825602021-09-17 01:44:12 +01001961 ctx.ModuleErrorf("internal error: no dex implementation jar available from prebuilt APEX %s", di.ApexModuleName())
Paul Duffin064b70c2020-11-02 17:32:38 +00001962 }
1963 } else if Bool(j.dexProperties.Compile_dex) {
Jiyong Parkf1691d22021-03-29 20:11:58 +09001964 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
Paul Duffin064b70c2020-11-02 17:32:38 +00001965 if sdkDep.invalidVersion {
1966 ctx.AddMissingDependencies(sdkDep.bootclasspath)
1967 ctx.AddMissingDependencies(sdkDep.java9Classpath)
1968 } else if sdkDep.useFiles {
1969 // sdkDep.jar is actually equivalent to turbine header.jar.
1970 flags.classpath = append(flags.classpath, sdkDep.jars...)
1971 }
1972
1973 // Dex compilation
1974
Jiakai Zhang519c5c82021-09-16 06:15:39 +00001975 j.dexpreopter.installPath = j.dexpreopter.getInstallPath(
1976 ctx, android.PathForModuleInstall(ctx, "framework", jarName))
Jiakai Zhang22450f22021-10-11 03:05:20 +00001977 setUncompressDex(ctx, &j.dexpreopter, &j.dexer)
Paul Duffin064b70c2020-11-02 17:32:38 +00001978 j.dexpreopter.uncompressedDex = *j.dexProperties.Uncompress_dex
1979
Paul Duffin612e6102021-02-02 13:38:13 +00001980 var dexOutputFile android.OutputPath
Jiyong Park92315372021-04-02 08:45:46 +09001981 dexOutputFile = j.dexer.compileDex(ctx, flags, j.MinSdkVersion(ctx), outputFile, jarName)
Paul Duffin064b70c2020-11-02 17:32:38 +00001982 if ctx.Failed() {
1983 return
1984 }
1985
Paul Duffin74d18d12021-05-14 14:18:47 +01001986 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001987 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), outputFile, j.dexProperties.Uncompress_dex)
Paul Duffinafaa47c2021-05-14 13:04:04 +01001988
1989 // Encode hidden API flags in dex file.
Paul Duffin1bbd0622021-05-14 15:52:25 +01001990 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
Paul Duffin064b70c2020-11-02 17:32:38 +00001991
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001992 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jeongik Chad5fe8782021-07-08 01:13:11 +09001993 j.dexJarInstallFile = android.PathForModuleInstall(ctx, "framework", jarName)
Liz Kammerd6c31d22020-08-05 15:40:41 -07001994 }
Liz Kammerd6c31d22020-08-05 15:40:41 -07001995 }
Colin Crossdcf71b22021-02-01 13:59:03 -08001996
1997 ctx.SetProvider(JavaInfoProvider, JavaInfo{
1998 HeaderJars: android.PathsIfNonNil(j.combinedClasspathFile),
1999 ImplementationAndResourcesJars: android.PathsIfNonNil(j.combinedClasspathFile),
2000 ImplementationJars: android.PathsIfNonNil(j.combinedClasspathFile),
2001 AidlIncludeDirs: j.exportAidlIncludeDirs,
2002 })
Colin Cross2fe66872015-03-30 17:20:39 -07002003}
2004
Sam Delmerico277795c2022-02-25 17:04:37 +00002005func (j *Import) maybeInstall(ctx android.ModuleContext, jarName string, outputFile android.Path) {
2006 if !Bool(j.properties.Installable) {
2007 return
2008 }
2009
2010 var installDir android.InstallPath
2011 if ctx.InstallInTestcases() {
2012 var archDir string
2013 if !ctx.Host() {
2014 archDir = ctx.DeviceConfig().DeviceArch()
2015 }
2016 installDir = android.PathForModuleInstall(ctx, ctx.ModuleName(), archDir)
2017 } else {
2018 installDir = android.PathForModuleInstall(ctx, "framework")
2019 }
2020 ctx.InstallFile(installDir, jarName, outputFile)
2021}
2022
Paul Duffinaa55f742020-10-06 17:20:13 +01002023func (j *Import) OutputFiles(tag string) (android.Paths, error) {
2024 switch tag {
Saeid Farivar Asanjan128fe5c2020-10-15 17:54:40 +00002025 case "", ".jar":
Paul Duffinaa55f742020-10-06 17:20:13 +01002026 return android.Paths{j.combinedClasspathFile}, nil
2027 default:
2028 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
2029 }
2030}
2031
2032var _ android.OutputFileProducer = (*Import)(nil)
2033
Nan Zhanged19fc32017-10-19 13:06:22 -07002034func (j *Import) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002035 if j.combinedClasspathFile == nil {
2036 return nil
2037 }
Colin Cross37f6d792018-07-12 12:28:41 -07002038 return android.Paths{j.combinedClasspathFile}
Nan Zhanged19fc32017-10-19 13:06:22 -07002039}
2040
Colin Cross331a1212018-08-15 20:40:52 -07002041func (j *Import) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002042 if j.combinedClasspathFile == nil {
2043 return nil
2044 }
Colin Cross331a1212018-08-15 20:40:52 -07002045 return android.Paths{j.combinedClasspathFile}
2046}
2047
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01002048func (j *Import) DexJarBuildPath() OptionalDexJarPath {
Liz Kammerd6c31d22020-08-05 15:40:41 -07002049 return j.dexJarFile
Colin Crossf24a22a2019-01-31 14:12:44 -08002050}
2051
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01002052func (j *Import) DexJarInstallPath() android.Path {
Jeongik Chad5fe8782021-07-08 01:13:11 +09002053 return j.dexJarInstallFile
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01002054}
2055
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01002056func (j *Import) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2057 return j.classLoaderContexts
Jiyong Park1be96912018-05-28 18:02:19 +09002058}
2059
Jiyong Park45bf82e2020-12-15 22:29:02 +09002060var _ android.ApexModule = (*Import)(nil)
2061
2062// Implements android.ApexModule
Jiyong Park0f80c182020-01-31 02:49:53 +09002063func (j *Import) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Paul Duffin0d3c2e12020-05-17 08:34:50 +01002064 return j.depIsInSameApex(ctx, dep)
Jiyong Park0f80c182020-01-31 02:49:53 +09002065}
2066
Jiyong Park45bf82e2020-12-15 22:29:02 +09002067// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07002068func (j *Import) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
2069 sdkVersion android.ApiLevel) error {
Jiyong Park92315372021-04-02 08:45:46 +09002070 sdkSpec := j.MinSdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002071 if !sdkSpec.Specified() {
Jaewoong Jung56e12db2021-04-02 00:38:25 +00002072 return fmt.Errorf("min_sdk_version is not specified")
2073 }
Jiyong Parkf1691d22021-03-29 20:11:58 +09002074 if sdkSpec.Kind == android.SdkCore {
Jaewoong Jung56e12db2021-04-02 00:38:25 +00002075 return nil
2076 }
Jooyung Han4c4da062021-06-23 10:23:16 +09002077 if sdkSpec.ApiLevel.GreaterThan(sdkVersion) {
2078 return fmt.Errorf("newer SDK(%v)", sdkSpec.ApiLevel)
Jaewoong Jung56e12db2021-04-02 00:38:25 +00002079 }
Jooyung Han749dc692020-04-15 11:03:39 +09002080 return nil
2081}
2082
Paul Duffinfef55002021-06-17 14:56:05 +01002083// requiredFilesFromPrebuiltApexForImport returns information about the files that a java_import or
2084// java_sdk_library_import with the specified base module name requires to be exported from a
2085// prebuilt_apex/apex_set.
Paul Duffinb4bbf2c2021-06-17 15:59:07 +01002086func requiredFilesFromPrebuiltApexForImport(name string) []string {
2087 // Add the dex implementation jar to the set of exported files.
2088 return []string{
2089 apexRootRelativePathToJavaLib(name),
Paul Duffinfef55002021-06-17 14:56:05 +01002090 }
2091}
2092
Paul Duffinb4bbf2c2021-06-17 15:59:07 +01002093// apexRootRelativePathToJavaLib returns the path, relative to the root of the apex's contents, for
2094// the java library with the specified name.
2095func apexRootRelativePathToJavaLib(name string) string {
2096 return filepath.Join("javalib", name+".jar")
2097}
2098
Paul Duffinfef55002021-06-17 14:56:05 +01002099var _ android.RequiredFilesFromPrebuiltApex = (*Import)(nil)
2100
Paul Duffinb4bbf2c2021-06-17 15:59:07 +01002101func (j *Import) RequiredFilesFromPrebuiltApex(_ android.BaseModuleContext) []string {
Paul Duffinfef55002021-06-17 14:56:05 +01002102 name := j.BaseModuleName()
2103 return requiredFilesFromPrebuiltApexForImport(name)
2104}
2105
albaltai36ff7dc2018-12-25 14:35:23 +08002106// Add compile time check for interface implementation
2107var _ android.IDEInfo = (*Import)(nil)
2108var _ android.IDECustomizedModuleName = (*Import)(nil)
2109
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002110// Collect information for opening IDE project files in java/jdeps.go.
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002111
2112func (j *Import) IDEInfo(dpInfo *android.IdeInfo) {
2113 dpInfo.Jars = append(dpInfo.Jars, j.PrebuiltSrcs()...)
2114}
2115
2116func (j *Import) IDECustomizedModuleName() string {
2117 // TODO(b/113562217): Extract the base module name from the Import name, often the Import name
2118 // has a prefix "prebuilt_". Remove the prefix explicitly if needed until we find a better
2119 // solution to get the Import name.
Ulya Trafimovich497a0932021-07-14 16:35:33 +01002120 return android.RemoveOptionalPrebuiltPrefix(j.Name())
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002121}
2122
Colin Cross74d73e22017-08-02 11:05:49 -07002123var _ android.PrebuiltInterface = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07002124
Bill Peckhamff89ffa2020-12-23 16:13:04 -08002125func (j *Import) IsInstallable() bool {
2126 return Bool(j.properties.Installable)
2127}
2128
Jiakai Zhang519c5c82021-09-16 06:15:39 +00002129var _ DexpreopterInterface = (*Import)(nil)
Bill Peckhamff89ffa2020-12-23 16:13:04 -08002130
Colin Cross1b16b0e2019-02-12 14:41:32 -08002131// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library module.
2132//
2133// By default, a java_import has a single variant that expects a `.jar` file containing `.class` files that were
2134// compiled against an Android classpath.
2135//
2136// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
2137// for host modules.
Colin Cross74d73e22017-08-02 11:05:49 -07002138func ImportFactory() android.Module {
2139 module := &Import{}
Colin Cross36242852017-06-23 15:06:31 -07002140
Liz Kammerd6c31d22020-08-05 15:40:41 -07002141 module.AddProperties(
2142 &module.properties,
2143 &module.dexer.dexProperties,
2144 )
Colin Cross74d73e22017-08-02 11:05:49 -07002145
Paul Duffin71b33cc2021-06-23 11:39:47 +01002146 module.initModuleAndImport(module)
Paul Duffin859fe962020-05-15 10:20:31 +01002147
Liz Kammerd6c31d22020-08-05 15:40:41 -07002148 module.dexProperties.Optimize.EnabledByDefault = false
2149
Colin Cross74d73e22017-08-02 11:05:49 -07002150 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002151 android.InitApexModule(module)
Jiyong Parkd1063c12019-07-17 20:08:41 +09002152 android.InitSdkAwareModule(module)
Romain Jobredeaux428a3662022-01-28 11:12:52 -05002153 android.InitBazelModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002154 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross36242852017-06-23 15:06:31 -07002155 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002156}
2157
Colin Cross1b16b0e2019-02-12 14:41:32 -08002158// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library_host
2159// module.
2160//
2161// A java_import_host has a single variant that expects a `.jar` file containing `.class` files that were
2162// compiled against a host bootclasspath.
Colin Cross74d73e22017-08-02 11:05:49 -07002163func ImportFactoryHost() android.Module {
2164 module := &Import{}
2165
2166 module.AddProperties(&module.properties)
2167
2168 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002169 android.InitApexModule(module)
Sam Delmerico5f83b492022-02-28 18:50:56 +00002170 android.InitBazelModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002171 InitJavaModule(module, android.HostSupported)
Colin Cross74d73e22017-08-02 11:05:49 -07002172 return module
2173}
2174
Colin Cross42be7612019-02-21 18:12:14 -08002175// dex_import module
2176
2177type DexImportProperties struct {
Colin Cross5cfc70d2019-07-15 13:36:55 -07002178 Jars []string `android:"path"`
Jiyong Park4c4c0242019-10-21 14:53:15 +09002179
2180 // set the name of the output
2181 Stem *string
Colin Cross42be7612019-02-21 18:12:14 -08002182}
2183
2184type DexImport struct {
2185 android.ModuleBase
2186 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002187 android.ApexModuleBase
Colin Cross42be7612019-02-21 18:12:14 -08002188 prebuilt android.Prebuilt
2189
2190 properties DexImportProperties
2191
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01002192 dexJarFile OptionalDexJarPath
Colin Cross42be7612019-02-21 18:12:14 -08002193
2194 dexpreopter
Colin Cross56a83212020-09-15 18:30:11 -07002195
2196 hideApexVariantFromMake bool
Colin Cross42be7612019-02-21 18:12:14 -08002197}
2198
2199func (j *DexImport) Prebuilt() *android.Prebuilt {
2200 return &j.prebuilt
2201}
2202
2203func (j *DexImport) PrebuiltSrcs() []string {
2204 return j.properties.Jars
2205}
2206
2207func (j *DexImport) Name() string {
2208 return j.prebuilt.Name(j.ModuleBase.Name())
2209}
2210
Jiyong Park0b238752019-10-29 11:23:10 +09002211func (j *DexImport) Stem() string {
2212 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
2213}
2214
Jiyong Park77acec62020-06-01 21:39:15 +09002215func (a *DexImport) JacocoReportClassesFile() android.Path {
2216 return nil
2217}
2218
Colin Cross08dca382020-07-21 20:31:17 -07002219func (a *DexImport) LintDepSets() LintDepSets {
2220 return LintDepSets{}
2221}
2222
Martin Stjernholm6d415272020-01-31 17:10:36 +00002223func (j *DexImport) IsInstallable() bool {
2224 return true
2225}
2226
Jaewoong Jung476b9d62021-05-10 15:30:00 -07002227func (j *DexImport) getStrictUpdatabilityLinting() bool {
2228 return false
2229}
2230
2231func (j *DexImport) setStrictUpdatabilityLinting(bool) {
2232}
2233
Colin Cross42be7612019-02-21 18:12:14 -08002234func (j *DexImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2235 if len(j.properties.Jars) != 1 {
2236 ctx.PropertyErrorf("jars", "exactly one jar must be provided")
2237 }
2238
Colin Cross56a83212020-09-15 18:30:11 -07002239 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2240 if !apexInfo.IsForPlatform() {
2241 j.hideApexVariantFromMake = true
2242 }
2243
Jiakai Zhang519c5c82021-09-16 06:15:39 +00002244 j.dexpreopter.installPath = j.dexpreopter.getInstallPath(
2245 ctx, android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar"))
Colin Cross42be7612019-02-21 18:12:14 -08002246 j.dexpreopter.uncompressedDex = shouldUncompressDex(ctx, &j.dexpreopter)
2247
2248 inputJar := ctx.ExpandSource(j.properties.Jars[0], "jars")
2249 dexOutputFile := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar")
2250
2251 if j.dexpreopter.uncompressedDex {
Colin Crossf1a035e2020-11-16 17:32:30 -08002252 rule := android.NewRuleBuilder(pctx, ctx)
Colin Cross42be7612019-02-21 18:12:14 -08002253
2254 temporary := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar.unaligned")
2255 rule.Temporary(temporary)
2256
2257 // use zip2zip to uncompress classes*.dex files
2258 rule.Command().
Colin Crossf1a035e2020-11-16 17:32:30 -08002259 BuiltTool("zip2zip").
Colin Cross42be7612019-02-21 18:12:14 -08002260 FlagWithInput("-i ", inputJar).
2261 FlagWithOutput("-o ", temporary).
2262 FlagWithArg("-0 ", "'classes*.dex'")
2263
2264 // use zipalign to align uncompressed classes*.dex files
2265 rule.Command().
Colin Crossf1a035e2020-11-16 17:32:30 -08002266 BuiltTool("zipalign").
Colin Cross42be7612019-02-21 18:12:14 -08002267 Flag("-f").
2268 Text("4").
2269 Input(temporary).
2270 Output(dexOutputFile)
2271
2272 rule.DeleteTemporaryFiles()
2273
Colin Crossf1a035e2020-11-16 17:32:30 -08002274 rule.Build("uncompress_dex", "uncompress dex")
Colin Cross42be7612019-02-21 18:12:14 -08002275 } else {
2276 ctx.Build(pctx, android.BuildParams{
2277 Rule: android.Cp,
2278 Input: inputJar,
2279 Output: dexOutputFile,
2280 })
2281 }
2282
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01002283 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Colin Cross42be7612019-02-21 18:12:14 -08002284
Jaewoong Jung4b97a562020-12-17 09:43:28 -08002285 j.dexpreopt(ctx, dexOutputFile)
Colin Cross42be7612019-02-21 18:12:14 -08002286
Colin Cross56a83212020-09-15 18:30:11 -07002287 if apexInfo.IsForPlatform() {
Jiyong Park01bca752020-06-08 19:24:09 +09002288 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
2289 j.Stem()+".jar", dexOutputFile)
2290 }
Colin Cross42be7612019-02-21 18:12:14 -08002291}
2292
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01002293func (j *DexImport) DexJarBuildPath() OptionalDexJarPath {
Colin Cross42be7612019-02-21 18:12:14 -08002294 return j.dexJarFile
2295}
2296
Jiyong Park45bf82e2020-12-15 22:29:02 +09002297var _ android.ApexModule = (*DexImport)(nil)
2298
2299// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07002300func (j *DexImport) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
2301 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09002302 // we don't check prebuilt modules for sdk_version
2303 return nil
2304}
2305
Colin Cross42be7612019-02-21 18:12:14 -08002306// dex_import imports a `.jar` file containing classes.dex files.
2307//
2308// A dex_import module cannot be used as a dependency of a java_* or android_* module, it can only be installed
2309// to the device.
2310func DexImportFactory() android.Module {
2311 module := &DexImport{}
2312
2313 module.AddProperties(&module.properties)
2314
2315 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002316 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002317 InitJavaModule(module, android.DeviceSupported)
Colin Cross42be7612019-02-21 18:12:14 -08002318 return module
2319}
2320
Colin Cross89536d42017-07-07 14:35:50 -07002321// Defaults
Colin Cross89536d42017-07-07 14:35:50 -07002322type Defaults struct {
2323 android.ModuleBase
2324 android.DefaultsModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002325 android.ApexModuleBase
Colin Cross89536d42017-07-07 14:35:50 -07002326}
2327
Colin Cross1b16b0e2019-02-12 14:41:32 -08002328// java_defaults provides a set of properties that can be inherited by other java or android modules.
2329//
2330// A module can use the properties from a java_defaults module using `defaults: ["defaults_module_name"]`. Each
2331// property in the defaults module that exists in the depending module will be prepended to the depending module's
2332// value for that property.
2333//
2334// Example:
2335//
Sam Delmerico277795c2022-02-25 17:04:37 +00002336// java_defaults {
2337// name: "example_defaults",
2338// srcs: ["common/**/*.java"],
2339// javacflags: ["-Xlint:all"],
2340// aaptflags: ["--auto-add-overlay"],
2341// }
Colin Cross1b16b0e2019-02-12 14:41:32 -08002342//
Sam Delmerico277795c2022-02-25 17:04:37 +00002343// java_library {
2344// name: "example",
2345// defaults: ["example_defaults"],
2346// srcs: ["example/**/*.java"],
2347// }
Colin Cross1b16b0e2019-02-12 14:41:32 -08002348//
2349// is functionally identical to:
2350//
Sam Delmerico277795c2022-02-25 17:04:37 +00002351// java_library {
2352// name: "example",
2353// srcs: [
2354// "common/**/*.java",
2355// "example/**/*.java",
2356// ],
2357// javacflags: ["-Xlint:all"],
2358// }
Paul Duffin47357662019-12-05 14:07:14 +00002359func DefaultsFactory() android.Module {
Colin Cross89536d42017-07-07 14:35:50 -07002360 module := &Defaults{}
2361
Colin Cross89536d42017-07-07 14:35:50 -07002362 module.AddProperties(
Jaewoong Jungbc15e3a2021-03-10 17:02:43 -08002363 &CommonProperties{},
2364 &DeviceProperties{},
Jooyung Han01d80d82022-01-08 12:16:32 +09002365 &OverridableDeviceProperties{},
Liz Kammera7a64f32020-07-09 15:16:41 -07002366 &DexProperties{},
Colin Cross43f08db2018-11-12 10:13:39 -08002367 &DexpreoptProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08002368 &android.ProtoProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002369 &aaptProperties{},
2370 &androidLibraryProperties{},
2371 &appProperties{},
2372 &appTestProperties{},
Jaewoong Jung525443a2019-02-28 15:35:54 -08002373 &overridableAppProperties{},
Roland Levillainb5b0ff32020-02-04 15:45:49 +00002374 &testProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002375 &ImportProperties{},
2376 &AARImportProperties{},
2377 &sdkLibraryProperties{},
Paul Duffin1b1e8062020-05-08 13:44:43 +01002378 &commonToSdkLibraryAndImportProperties{},
Colin Cross42be7612019-02-21 18:12:14 -08002379 &DexImportProperties{},
Jooyung Han18020ea2019-11-13 10:50:48 +09002380 &android.ApexProperties{},
Jaewoong Jungbf135462020-04-26 15:10:51 -07002381 &RuntimeResourceOverlayProperties{},
Colin Cross014489c2020-06-02 20:09:13 -07002382 &LintProperties{},
Colin Crosscbce0b02021-02-09 10:38:30 -08002383 &appTestHelperAppProperties{},
Colin Cross89536d42017-07-07 14:35:50 -07002384 )
2385
2386 android.InitDefaultsModule(module)
Colin Cross89536d42017-07-07 14:35:50 -07002387 return module
2388}
Nan Zhangea568a42017-11-08 21:20:04 -08002389
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002390func kytheExtractJavaFactory() android.Singleton {
2391 return &kytheExtractJavaSingleton{}
2392}
2393
2394type kytheExtractJavaSingleton struct {
2395}
2396
2397func (ks *kytheExtractJavaSingleton) GenerateBuildActions(ctx android.SingletonContext) {
2398 var xrefTargets android.Paths
2399 ctx.VisitAllModules(func(module android.Module) {
2400 if javaModule, ok := module.(xref); ok {
2401 xrefTargets = append(xrefTargets, javaModule.XrefJavaFiles()...)
2402 }
2403 })
2404 // TODO(asmundak): perhaps emit a rule to output a warning if there were no xrefTargets
2405 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07002406 ctx.Phony("xref_java", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002407 }
2408}
2409
Nan Zhangea568a42017-11-08 21:20:04 -08002410var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07002411var BoolDefault = proptools.BoolDefault
Nan Zhangea568a42017-11-08 21:20:04 -08002412var String = proptools.String
Colin Cross0d0ba592018-02-20 13:33:42 -08002413var inList = android.InList
Ulya Trafimovich65b03192020-12-03 16:50:22 +00002414
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00002415// Add class loader context (CLC) of a given dependency to the current CLC.
2416func addCLCFromDep(ctx android.ModuleContext, depModule android.Module,
2417 clcMap dexpreopt.ClassLoaderContextMap) {
2418
2419 dep, ok := depModule.(UsesLibraryDependency)
2420 if !ok {
2421 return
2422 }
2423
Ulya Trafimovich840efb62021-07-15 14:34:40 +01002424 depName := android.RemoveOptionalPrebuiltPrefix(ctx.OtherModuleName(depModule))
2425
2426 var sdkLib *string
2427 if lib, ok := depModule.(SdkLibraryDependency); ok && lib.sharedLibrary() {
2428 // A shared SDK library. This should be added as a top-level CLC element.
2429 sdkLib = &depName
2430 } else if ulib, ok := depModule.(ProvidesUsesLib); ok {
2431 // A non-SDK library disguised as an SDK library by the means of `provides_uses_lib`
2432 // property. This should be handled in the same way as a shared SDK library.
2433 sdkLib = ulib.ProvidesUsesLib()
Ulya Trafimovich65b03192020-12-03 16:50:22 +00002434 }
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00002435
2436 depTag := ctx.OtherModuleDependencyTag(depModule)
Liz Kammeref28a4c2022-09-23 16:50:56 -04002437 if IsLibDepTag(depTag) {
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00002438 // Ok, propagate <uses-library> through non-static library dependencies.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +01002439 } else if tag, ok := depTag.(usesLibraryDependencyTag); ok && tag.sdkVersion == dexpreopt.AnySdkVersion {
2440 // Ok, propagate <uses-library> through non-compatibility <uses-library> dependencies.
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00002441 } else if depTag == staticLibTag {
2442 // Propagate <uses-library> through static library dependencies, unless it is a component
2443 // library (such as stubs). Component libraries have a dependency on their SDK library,
2444 // which should not be pulled just because of a static component library.
Ulya Trafimovich840efb62021-07-15 14:34:40 +01002445 if sdkLib != nil {
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00002446 return
2447 }
2448 } else {
2449 // Don't propagate <uses-library> for other dependency tags.
2450 return
2451 }
2452
Ulya Trafimovich840efb62021-07-15 14:34:40 +01002453 // If this is an SDK (or SDK-like) library, then it should be added as a node in the CLC tree,
2454 // and its CLC should be added as subtree of that node. Otherwise the library is not a
2455 // <uses_library> and should not be added to CLC, but the transitive <uses-library> dependencies
2456 // from its CLC should be added to the current CLC.
2457 if sdkLib != nil {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +01002458 clcMap.AddContext(ctx, dexpreopt.AnySdkVersion, *sdkLib, false,
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01002459 dep.DexJarBuildPath().PathOrNil(), dep.DexJarInstallPath(), dep.ClassLoaderContexts())
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00002460 } else {
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00002461 clcMap.AddContextMap(dep.ClassLoaderContexts(), depName)
2462 }
Ulya Trafimovich65b03192020-12-03 16:50:22 +00002463}
Wei Libafb6d62021-12-10 03:14:59 -08002464
Sam Delmerico79985812022-03-23 20:20:42 +00002465type javaResourcesAttributes struct {
2466 Resources bazel.LabelListAttribute
2467 Resource_strip_prefix *string
2468}
2469
2470func (m *Library) convertJavaResourcesAttributes(ctx android.TopDownMutatorContext) *javaResourcesAttributes {
2471 var resources bazel.LabelList
2472 var resourceStripPrefix *string
2473
2474 if m.properties.Java_resources != nil {
2475 resources.Append(android.BazelLabelForModuleSrc(ctx, m.properties.Java_resources))
2476 }
2477
Paul Duffin7ed6ff82022-11-21 10:57:30 +00002478 //TODO(b/179889880) handle case where glob includes files outside package
Sam Delmerico79985812022-03-23 20:20:42 +00002479 resDeps := ResourceDirsToFiles(
2480 ctx,
2481 m.properties.Java_resource_dirs,
2482 m.properties.Exclude_java_resource_dirs,
2483 m.properties.Exclude_java_resources,
2484 )
2485
2486 for i, resDep := range resDeps {
2487 dir, files := resDep.dir, resDep.files
2488
2489 resources.Append(bazel.MakeLabelList(android.RootToModuleRelativePaths(ctx, files)))
2490
2491 // Bazel includes the relative path from the WORKSPACE root when placing the resource
2492 // inside the JAR file, so we need to remove that prefix
2493 resourceStripPrefix = proptools.StringPtr(dir.String())
2494 if i > 0 {
2495 // TODO(b/226423379) allow multiple resource prefixes
2496 ctx.ModuleErrorf("bp2build does not support more than one directory in java_resource_dirs (b/226423379)")
2497 }
2498 }
2499
2500 return &javaResourcesAttributes{
2501 Resources: bazel.MakeLabelListAttribute(resources),
2502 Resource_strip_prefix: resourceStripPrefix,
2503 }
2504}
2505
Sam Delmericoc0161432022-02-25 21:34:51 +00002506type javaCommonAttributes struct {
Sam Delmerico79985812022-03-23 20:20:42 +00002507 *javaResourcesAttributes
Wei Libafb6d62021-12-10 03:14:59 -08002508 Srcs bazel.LabelListAttribute
Sam Delmerico77267c72022-03-18 14:11:07 +00002509 Plugins bazel.LabelListAttribute
Wei Libafb6d62021-12-10 03:14:59 -08002510 Javacopts bazel.StringListAttribute
2511}
2512
Sam Delmericoc0161432022-02-25 21:34:51 +00002513type javaDependencyLabels struct {
2514 // Dependencies which DO NOT contribute to the API visible to upstream dependencies.
2515 Deps bazel.LabelListAttribute
2516 // Dependencies which DO contribute to the API visible to upstream dependencies.
2517 StaticDeps bazel.LabelListAttribute
2518}
2519
Sam Delmerico24da73c2022-03-16 20:36:54 +00002520type eventLogTagsAttributes struct {
2521 Srcs bazel.LabelListAttribute
2522}
2523
Sam Delmerico97bd1272022-08-25 14:45:31 -04002524type aidlLibraryAttributes struct {
2525 Srcs bazel.LabelListAttribute
2526}
2527
2528type javaAidlLibraryAttributes struct {
2529 Deps bazel.LabelListAttribute
2530}
2531
Alix8062f4d2022-11-14 21:38:07 +00002532// bp2BuildJavaInfo has information needed for the conversion of java*_modules
2533// that is needed bor Bp2Build conversion but that requires different handling
2534// depending on the module type.
2535type bp2BuildJavaInfo struct {
2536 // separates dependencies into dynamic dependencies and static dependencies.
2537 DepLabels *javaDependencyLabels
2538 hasKotlinSrcs bool
2539}
2540
2541// convertLibraryAttrsBp2Build returns a javaCommonAttributes struct with
2542// converted attributes shared across java_* modules and a bp2BuildJavaInfo struct
2543// which has other non-attribute information needed for bp2build conversion
2544// that needs different handling depending on the module types, and thus needs
2545// to be returned to the calling function.
2546func (m *Library) convertLibraryAttrsBp2Build(ctx android.TopDownMutatorContext) (*javaCommonAttributes, *bp2BuildJavaInfo) {
Sam Delmericoe91d0302022-02-23 15:28:33 +00002547 var srcs bazel.LabelListAttribute
Sam Delmerico97bd1272022-08-25 14:45:31 -04002548 var deps bazel.LabelList
2549 var staticDeps bazel.LabelList
2550
Sam Delmericoe91d0302022-02-23 15:28:33 +00002551 archVariantProps := m.GetArchVariantProperties(ctx, &CommonProperties{})
2552 for axis, configToProps := range archVariantProps {
2553 for config, _props := range configToProps {
2554 if archProps, ok := _props.(*CommonProperties); ok {
2555 archSrcs := android.BazelLabelForModuleSrcExcludes(ctx, archProps.Srcs, archProps.Exclude_srcs)
2556 srcs.SetSelectValue(axis, config, archSrcs)
2557 }
2558 }
2559 }
Sam Delmericoc7681022022-02-04 21:01:20 +00002560
2561 javaSrcPartition := "java"
2562 protoSrcPartition := "proto"
Sam Delmerico24da73c2022-03-16 20:36:54 +00002563 logtagSrcPartition := "logtag"
Sam Delmerico97bd1272022-08-25 14:45:31 -04002564 aidlSrcPartition := "aidl"
Alix8062f4d2022-11-14 21:38:07 +00002565 kotlinPartition := "kotlin"
Sam Delmericoc7681022022-02-04 21:01:20 +00002566 srcPartitions := bazel.PartitionLabelListAttribute(ctx, &srcs, bazel.LabelPartitions{
Sam Delmerico24da73c2022-03-16 20:36:54 +00002567 javaSrcPartition: bazel.LabelPartition{Extensions: []string{".java"}, Keep_remainder: true},
2568 logtagSrcPartition: bazel.LabelPartition{Extensions: []string{".logtags", ".logtag"}},
2569 protoSrcPartition: android.ProtoSrcLabelPartition,
Sam Delmerico97bd1272022-08-25 14:45:31 -04002570 aidlSrcPartition: android.AidlSrcLabelPartition,
Alix8062f4d2022-11-14 21:38:07 +00002571 kotlinPartition: bazel.LabelPartition{Extensions: []string{".kt"}},
Sam Delmericoc7681022022-02-04 21:01:20 +00002572 })
2573
Sam Delmerico24da73c2022-03-16 20:36:54 +00002574 javaSrcs := srcPartitions[javaSrcPartition]
Alix8062f4d2022-11-14 21:38:07 +00002575 kotlinSrcs := srcPartitions[kotlinPartition]
2576 javaSrcs.Append(kotlinSrcs)
Sam Delmerico24da73c2022-03-16 20:36:54 +00002577
Sam Delmerico24da73c2022-03-16 20:36:54 +00002578 if !srcPartitions[logtagSrcPartition].IsEmpty() {
2579 logtagsLibName := m.Name() + "_logtags"
Sam Delmerico24da73c2022-03-16 20:36:54 +00002580 ctx.CreateBazelTargetModule(
2581 bazel.BazelTargetModuleProperties{
2582 Rule_class: "event_log_tags",
Sam Delmerico48af73b2022-04-05 14:03:11 +00002583 Bzl_load_location: "//build/bazel/rules/java:event_log_tags.bzl",
Sam Delmerico24da73c2022-03-16 20:36:54 +00002584 },
2585 android.CommonAttributes{Name: logtagsLibName},
2586 &eventLogTagsAttributes{
2587 Srcs: srcPartitions[logtagSrcPartition],
2588 },
2589 )
Sam Delmerico97bd1272022-08-25 14:45:31 -04002590
2591 logtagsSrcs := bazel.MakeLabelList([]bazel.Label{{Label: ":" + logtagsLibName}})
2592 javaSrcs.Append(bazel.MakeLabelListAttribute(logtagsSrcs))
Sam Delmerico24da73c2022-03-16 20:36:54 +00002593 }
Sam Delmerico97bd1272022-08-25 14:45:31 -04002594
2595 if !srcPartitions[aidlSrcPartition].IsEmpty() {
2596 aidlLibs, aidlSrcs := srcPartitions[aidlSrcPartition].Partition(func(src bazel.Label) bool {
2597 return android.IsConvertedToAidlLibrary(ctx, src.OriginalModuleName)
2598 })
2599
2600 if !aidlSrcs.IsEmpty() {
2601 aidlLibName := m.Name() + "_aidl_library"
2602 ctx.CreateBazelTargetModule(
2603 bazel.BazelTargetModuleProperties{
2604 Rule_class: "aidl_library",
2605 Bzl_load_location: "//build/bazel/rules/aidl:library.bzl",
2606 },
2607 android.CommonAttributes{Name: aidlLibName},
2608 &aidlLibraryAttributes{
2609 Srcs: aidlSrcs,
2610 },
2611 )
2612 aidlLibs.Add(&bazel.LabelAttribute{Value: &bazel.Label{Label: ":" + aidlLibName}})
2613 }
2614
2615 javaAidlLibName := m.Name() + "_java_aidl_library"
2616 ctx.CreateBazelTargetModule(
2617 bazel.BazelTargetModuleProperties{
2618 Rule_class: "java_aidl_library",
2619 Bzl_load_location: "//build/bazel/rules/java:aidl_library.bzl",
2620 },
2621 android.CommonAttributes{Name: javaAidlLibName},
2622 &javaAidlLibraryAttributes{
2623 Deps: aidlLibs,
2624 },
2625 )
2626
2627 staticDeps.Add(&bazel.Label{Label: ":" + javaAidlLibName})
2628 }
Sam Delmerico24da73c2022-03-16 20:36:54 +00002629
Sam Delmerico58614c02022-03-15 21:02:09 +00002630 var javacopts []string
2631 if m.properties.Javacflags != nil {
2632 javacopts = append(javacopts, m.properties.Javacflags...)
2633 }
Vinh Tran3ac6daf2022-04-22 19:09:58 -04002634 if m.properties.Java_version != nil {
2635 javaVersion := normalizeJavaVersion(ctx, *m.properties.Java_version).String()
2636 javacopts = append(javacopts, fmt.Sprintf("-source %s -target %s", javaVersion, javaVersion))
2637 }
2638
Sam Delmerico58614c02022-03-15 21:02:09 +00002639 epEnabled := m.properties.Errorprone.Enabled
Paul Duffin7ed6ff82022-11-21 10:57:30 +00002640 //TODO(b/227504307) add configuration that depends on RUN_ERROR_PRONE environment variable
Sam Delmerico58614c02022-03-15 21:02:09 +00002641 if Bool(epEnabled) {
2642 javacopts = append(javacopts, m.properties.Errorprone.Javacflags...)
2643 }
2644
Sam Delmericoc0161432022-02-25 21:34:51 +00002645 commonAttrs := &javaCommonAttributes{
Sam Delmerico79985812022-03-23 20:20:42 +00002646 Srcs: javaSrcs,
2647 javaResourcesAttributes: m.convertJavaResourcesAttributes(ctx),
Sam Delmerico77267c72022-03-18 14:11:07 +00002648 Plugins: bazel.MakeLabelListAttribute(
2649 android.BazelLabelForModuleDeps(ctx, m.properties.Plugins),
2650 ),
Sam Delmerico58614c02022-03-15 21:02:09 +00002651 Javacopts: bazel.MakeStringListAttribute(javacopts),
Wei Libafb6d62021-12-10 03:14:59 -08002652 }
2653
2654 if m.properties.Libs != nil {
Alixb4e09a02022-09-27 15:36:01 +00002655
2656 // TODO 244210934 ALIX Check if this else statement breaks presubmits get rid of it if it doesn't
Alix341484b2022-10-31 19:08:18 +00002657 if strings.HasPrefix(ctx.ModuleType(), "java_binary") || strings.HasPrefix(ctx.ModuleType(), "java_library") {
Alixb4e09a02022-09-27 15:36:01 +00002658 for _, d := range m.properties.Libs {
2659 neverlinkLabel := android.BazelLabelForModuleDepSingle(ctx, d)
2660 neverlinkLabel.Label = neverlinkLabel.Label + "-neverlink"
2661 deps.Add(&neverlinkLabel)
2662 }
2663
2664 } else {
2665 deps.Append(android.BazelLabelForModuleDeps(ctx, android.LastUniqueStrings(android.CopyOf(m.properties.Libs))))
2666 }
Wei Libafb6d62021-12-10 03:14:59 -08002667 }
Sam Delmericoc0161432022-02-25 21:34:51 +00002668
Sam Delmericofde9fb52022-01-28 20:53:38 +00002669 if m.properties.Static_libs != nil {
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05002670 staticDeps.Append(android.BazelLabelForModuleDeps(ctx, android.LastUniqueStrings(android.CopyOf(m.properties.Static_libs))))
Sam Delmericofde9fb52022-01-28 20:53:38 +00002671 }
Sam Delmericoc7681022022-02-04 21:01:20 +00002672
Sam Delmericoc0161432022-02-25 21:34:51 +00002673 protoDepLabel := bp2buildProto(ctx, &m.Module, srcPartitions[protoSrcPartition])
2674 // Soong does not differentiate between a java_library and the Bazel equivalent of
2675 // a java_proto_library + proto_library pair. Instead, in Soong proto sources are
2676 // listed directly in the srcs of a java_library, and the classes produced
2677 // by protoc are included directly in the resulting JAR. Thus upstream dependencies
2678 // that depend on a java_library with proto sources can link directly to the protobuf API,
2679 // and so this should be a static dependency.
2680 staticDeps.Add(protoDepLabel)
Sam Delmericoc7681022022-02-04 21:01:20 +00002681
Sam Delmerico97bd1272022-08-25 14:45:31 -04002682 depLabels := &javaDependencyLabels{}
Sam Delmericoc0161432022-02-25 21:34:51 +00002683 depLabels.Deps = bazel.MakeLabelListAttribute(deps)
2684 depLabels.StaticDeps = bazel.MakeLabelListAttribute(staticDeps)
Sam Delmericofde9fb52022-01-28 20:53:38 +00002685
Alix8062f4d2022-11-14 21:38:07 +00002686 bp2BuildInfo := &bp2BuildJavaInfo{
2687 DepLabels: depLabels,
2688 hasKotlinSrcs: !kotlinSrcs.IsEmpty(),
2689 }
2690
2691 return commonAttrs, bp2BuildInfo
Sam Delmericoc0161432022-02-25 21:34:51 +00002692}
2693
2694type javaLibraryAttributes struct {
2695 *javaCommonAttributes
Alix8062f4d2022-11-14 21:38:07 +00002696 Deps bazel.LabelListAttribute
2697 Exports bazel.LabelListAttribute
2698 Neverlink bazel.BoolAttribute
2699 Common_srcs bazel.LabelListAttribute
Sam Delmericofde9fb52022-01-28 20:53:38 +00002700}
2701
2702func javaLibraryBp2Build(ctx android.TopDownMutatorContext, m *Library) {
Alix8062f4d2022-11-14 21:38:07 +00002703 commonAttrs, bp2BuildInfo := m.convertLibraryAttrsBp2Build(ctx)
2704 depLabels := bp2BuildInfo.DepLabels
Sam Delmericoc0161432022-02-25 21:34:51 +00002705
2706 deps := depLabels.Deps
2707 if !commonAttrs.Srcs.IsEmpty() {
2708 deps.Append(depLabels.StaticDeps) // we should only append these if there are sources to use them
2709
2710 sdkVersion := m.SdkVersion(ctx)
2711 if sdkVersion.Kind == android.SdkPublic && sdkVersion.ApiLevel == android.FutureApiLevel {
2712 // TODO(b/220869005) remove forced dependency on current public android.jar
2713 deps.Add(bazel.MakeLabelAttribute("//prebuilts/sdk:public_current_android_sdk_java_import"))
2714 }
Sam Delmerico97bd1272022-08-25 14:45:31 -04002715 } else if !deps.IsEmpty() {
Sam Delmericoc0161432022-02-25 21:34:51 +00002716 ctx.ModuleErrorf("Module has direct dependencies but no sources. Bazel will not allow this.")
2717 }
2718
Alix8062f4d2022-11-14 21:38:07 +00002719 var props bazel.BazelTargetModuleProperties
Sam Delmericoc0161432022-02-25 21:34:51 +00002720 attrs := &javaLibraryAttributes{
2721 javaCommonAttributes: commonAttrs,
2722 Deps: deps,
2723 Exports: depLabels.StaticDeps,
2724 }
Alix341484b2022-10-31 19:08:18 +00002725 name := m.Name()
Wei Libafb6d62021-12-10 03:14:59 -08002726
Alix8062f4d2022-11-14 21:38:07 +00002727 if !bp2BuildInfo.hasKotlinSrcs && len(m.properties.Common_srcs) == 0 {
2728 props = bazel.BazelTargetModuleProperties{
2729 Rule_class: "java_library",
2730 Bzl_load_location: "//build/bazel/rules/java:library.bzl",
2731 }
Alix341484b2022-10-31 19:08:18 +00002732
2733 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: name}, attrs)
2734 neverlinkProp := true
2735 neverLinkAttrs := &javaLibraryAttributes{
2736 Exports: bazel.MakeSingleLabelListAttribute(bazel.Label{Label: ":" + name}),
2737 Neverlink: bazel.BoolAttribute{Value: &neverlinkProp},
2738 }
2739 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: name + "-neverlink"}, neverLinkAttrs)
Alix8062f4d2022-11-14 21:38:07 +00002740 } else {
2741 attrs.Common_srcs = bazel.MakeLabelListAttribute(android.BazelLabelForModuleSrc(ctx, m.properties.Common_srcs))
2742
2743 props = bazel.BazelTargetModuleProperties{
2744 Rule_class: "kt_jvm_library",
2745 Bzl_load_location: "@rules_kotlin//kotlin:jvm_library.bzl",
2746 }
Alix341484b2022-10-31 19:08:18 +00002747 // TODO (b/244210934): create neverlink-duplicate target once kt_jvm_library supports neverlink attribute
2748 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: name}, attrs)
Wei Libafb6d62021-12-10 03:14:59 -08002749 }
2750
Wei Libafb6d62021-12-10 03:14:59 -08002751}
2752
2753type javaBinaryHostAttributes struct {
Sam Delmericoc0161432022-02-25 21:34:51 +00002754 *javaCommonAttributes
2755 Deps bazel.LabelListAttribute
2756 Runtime_deps bazel.LabelListAttribute
2757 Main_class string
2758 Jvm_flags bazel.StringListAttribute
Wei Libafb6d62021-12-10 03:14:59 -08002759}
2760
2761// JavaBinaryHostBp2Build is for java_binary_host bp2build.
2762func javaBinaryHostBp2Build(ctx android.TopDownMutatorContext, m *Binary) {
Alix8062f4d2022-11-14 21:38:07 +00002763 commonAttrs, bp2BuildInfo := m.convertLibraryAttrsBp2Build(ctx)
2764 depLabels := bp2BuildInfo.DepLabels
Sam Delmericoc0161432022-02-25 21:34:51 +00002765
2766 deps := depLabels.Deps
2767 deps.Append(depLabels.StaticDeps)
2768 if m.binaryProperties.Jni_libs != nil {
2769 deps.Append(bazel.MakeLabelListAttribute(android.BazelLabelForModuleDeps(ctx, m.binaryProperties.Jni_libs)))
2770 }
2771
2772 var runtimeDeps bazel.LabelListAttribute
2773 if commonAttrs.Srcs.IsEmpty() {
2774 // if there are no sources, then the dependencies can only be used at runtime
2775 runtimeDeps = deps
2776 deps = bazel.LabelListAttribute{}
2777 }
2778
Wei Libafb6d62021-12-10 03:14:59 -08002779 mainClass := ""
2780 if m.binaryProperties.Main_class != nil {
2781 mainClass = *m.binaryProperties.Main_class
2782 }
2783 if m.properties.Manifest != nil {
2784 mainClassInManifest, err := android.GetMainClassInManifest(ctx.Config(), android.PathForModuleSrc(ctx, *m.properties.Manifest).String())
2785 if err != nil {
2786 return
2787 }
2788 mainClass = mainClassInManifest
2789 }
Sam Delmericoc0161432022-02-25 21:34:51 +00002790
Wei Libafb6d62021-12-10 03:14:59 -08002791 attrs := &javaBinaryHostAttributes{
Sam Delmericoc0161432022-02-25 21:34:51 +00002792 javaCommonAttributes: commonAttrs,
2793 Deps: deps,
2794 Runtime_deps: runtimeDeps,
2795 Main_class: mainClass,
Wei Libafb6d62021-12-10 03:14:59 -08002796 }
2797
2798 // Attribute jvm_flags
2799 if m.binaryProperties.Jni_libs != nil {
2800 jniLibPackages := map[string]bool{}
2801 for _, jniLibLabel := range android.BazelLabelForModuleDeps(ctx, m.binaryProperties.Jni_libs).Includes {
2802 jniLibPackage := jniLibLabel.Label
2803 indexOfColon := strings.Index(jniLibLabel.Label, ":")
2804 if indexOfColon > 0 {
2805 // JNI lib from other package
2806 jniLibPackage = jniLibLabel.Label[2:indexOfColon]
2807 } else if indexOfColon == 0 {
2808 // JNI lib in the same package of java_binary
2809 packageOfCurrentModule := m.GetBazelLabel(ctx, m)
2810 jniLibPackage = packageOfCurrentModule[2:strings.Index(packageOfCurrentModule, ":")]
2811 }
2812 if _, inMap := jniLibPackages[jniLibPackage]; !inMap {
2813 jniLibPackages[jniLibPackage] = true
2814 }
2815 }
2816 jniLibPaths := []string{}
2817 for jniLibPackage, _ := range jniLibPackages {
2818 // See cs/f:.*/third_party/bazel/.*java_stub_template.txt for the use of RUNPATH
2819 jniLibPaths = append(jniLibPaths, "$${RUNPATH}"+jniLibPackage)
2820 }
2821 attrs.Jvm_flags = bazel.MakeStringListAttribute([]string{"-Djava.library.path=" + strings.Join(jniLibPaths, ":")})
2822 }
2823
2824 props := bazel.BazelTargetModuleProperties{
2825 Rule_class: "java_binary",
2826 }
2827
2828 // Create the BazelTargetModule.
2829 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: m.Name()}, attrs)
2830}
Romain Jobredeaux428a3662022-01-28 11:12:52 -05002831
2832type bazelJavaImportAttributes struct {
Alixb4e09a02022-09-27 15:36:01 +00002833 Jars bazel.LabelListAttribute
2834 Exports bazel.LabelListAttribute
Romain Jobredeaux428a3662022-01-28 11:12:52 -05002835}
2836
2837// java_import bp2Build converter.
2838func (i *Import) ConvertWithBp2build(ctx android.TopDownMutatorContext) {
Sam Delmerico48983162022-02-22 21:41:33 +00002839 var jars bazel.LabelListAttribute
2840 archVariantProps := i.GetArchVariantProperties(ctx, &ImportProperties{})
2841 for axis, configToProps := range archVariantProps {
2842 for config, _props := range configToProps {
2843 if archProps, ok := _props.(*ImportProperties); ok {
2844 archJars := android.BazelLabelForModuleSrcExcludes(ctx, archProps.Jars, []string(nil))
2845 jars.SetSelectValue(axis, config, archJars)
2846 }
2847 }
2848 }
Romain Jobredeaux428a3662022-01-28 11:12:52 -05002849
2850 attrs := &bazelJavaImportAttributes{
2851 Jars: jars,
2852 }
2853 props := bazel.BazelTargetModuleProperties{Rule_class: "java_import"}
2854
Alixb4e09a02022-09-27 15:36:01 +00002855 name := android.RemoveOptionalPrebuiltPrefix(i.Name())
2856
2857 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: name}, attrs)
2858
2859 neverlink := true
2860 neverlinkAttrs := &javaLibraryAttributes{
2861 Neverlink: bazel.BoolAttribute{Value: &neverlink},
2862 Exports: bazel.MakeSingleLabelListAttribute(bazel.Label{Label: ":" + name}),
2863 }
2864 ctx.CreateBazelTargetModule(bazel.BazelTargetModuleProperties{Rule_class: "java_library"}, android.CommonAttributes{Name: name + "-neverlink"}, neverlinkAttrs)
2865
Sam Delmerico277795c2022-02-25 17:04:37 +00002866}
Romain Jobredeaux428a3662022-01-28 11:12:52 -05002867
Sam Delmerico277795c2022-02-25 17:04:37 +00002868var _ android.MixedBuildBuildable = (*Import)(nil)
2869
2870func (i *Import) getBazelModuleLabel(ctx android.BaseModuleContext) string {
2871 return android.RemoveOptionalPrebuiltPrefixFromBazelLabel(i.GetBazelLabel(ctx, i))
2872}
2873
2874func (i *Import) ProcessBazelQueryResponse(ctx android.ModuleContext) {
2875 i.commonBuildActions(ctx)
2876
2877 bazelCtx := ctx.Config().BazelContext
2878 filePaths, err := bazelCtx.GetOutputFiles(i.getBazelModuleLabel(ctx), android.GetConfigKey(ctx))
2879 if err != nil {
2880 ctx.ModuleErrorf(err.Error())
2881 return
2882 }
2883
2884 bazelJars := android.Paths{}
2885 for _, bazelOutputFile := range filePaths {
2886 bazelJars = append(bazelJars, android.PathForBazelOut(ctx, bazelOutputFile))
2887 }
2888
2889 jarName := android.RemoveOptionalPrebuiltPrefix(i.Name()) + ".jar"
2890 outputFile := android.PathForModuleOut(ctx, "bazelCombined", jarName)
2891 TransformJarsToJar(ctx, outputFile, "combine prebuilt jars", bazelJars,
2892 android.OptionalPath{}, // manifest
2893 false, // stripDirEntries
2894 []string{}, // filesToStrip
2895 []string{}, // dirsToStrip
2896 )
2897 i.combinedClasspathFile = outputFile
2898
2899 ctx.SetProvider(JavaInfoProvider, JavaInfo{
2900 HeaderJars: android.PathsIfNonNil(i.combinedClasspathFile),
2901 ImplementationAndResourcesJars: android.PathsIfNonNil(i.combinedClasspathFile),
2902 ImplementationJars: android.PathsIfNonNil(i.combinedClasspathFile),
Paul Duffin7ed6ff82022-11-21 10:57:30 +00002903 //TODO(b/240308299) include AIDL information from Bazel
Sam Delmerico277795c2022-02-25 17:04:37 +00002904 })
2905
2906 i.maybeInstall(ctx, jarName, outputFile)
2907}
2908
2909func (i *Import) QueueBazelCall(ctx android.BaseModuleContext) {
2910 bazelCtx := ctx.Config().BazelContext
2911 bazelCtx.QueueBazelRequest(i.getBazelModuleLabel(ctx), cquery.GetOutputFiles, android.GetConfigKey(ctx))
2912}
2913
2914func (i *Import) IsMixedBuildSupported(ctx android.BaseModuleContext) bool {
2915 return true
Romain Jobredeaux428a3662022-01-28 11:12:52 -05002916}