blob: 42a196e555aee648ffbbd8414cdeade7e68267cc [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
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500233 // set of header jars for all transitive libs deps
234 TransitiveLibsHeaderJars *android.DepSet
235
236 // set of header jars for all transitive static libs deps
237 TransitiveStaticLibsHeaderJars *android.DepSet
238
Colin Crossdcf71b22021-02-01 13:59:03 -0800239 // ImplementationAndResourceJars is a list of jars that contain the implementations of classes
240 // in the module as well as any resources included in the module.
241 ImplementationAndResourcesJars android.Paths
242
243 // ImplementationJars is a list of jars that contain the implementations of classes in the
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000244 //module.
Colin Crossdcf71b22021-02-01 13:59:03 -0800245 ImplementationJars android.Paths
246
247 // ResourceJars is a list of jars that contain the resources included in the module.
248 ResourceJars android.Paths
249
250 // AidlIncludeDirs is a list of directories that should be passed to the aidl tool when
251 // depending on this module.
252 AidlIncludeDirs android.Paths
253
254 // SrcJarArgs is a list of arguments to pass to soong_zip to package the sources of this
255 // module.
256 SrcJarArgs []string
257
258 // SrcJarDeps is a list of paths to depend on when packaging the sources of this module.
259 SrcJarDeps android.Paths
260
261 // ExportedPlugins is a list of paths that should be used as annotation processors for any
262 // module that depends on this module.
263 ExportedPlugins android.Paths
264
265 // ExportedPluginClasses is a list of classes that should be run as annotation processors for
266 // any module that depends on this module.
267 ExportedPluginClasses []string
268
269 // ExportedPluginDisableTurbine is true if this module's annotation processors generate APIs,
270 // requiring disbling turbine for any modules that depend on it.
271 ExportedPluginDisableTurbine bool
272
273 // JacocoReportClassesFile is the path to a jar containing uninstrumented classes that will be
274 // instrumented by jacoco.
275 JacocoReportClassesFile android.Path
276}
277
278var JavaInfoProvider = blueprint.NewProvider(JavaInfo{})
279
Colin Cross75ce9ec2021-02-26 16:20:32 -0800280// SyspropPublicStubInfo contains info about the sysprop public stub library that corresponds to
281// the sysprop implementation library.
282type SyspropPublicStubInfo struct {
283 // JavaInfo is the JavaInfoProvider of the sysprop public stub library that corresponds to
284 // the sysprop implementation library.
285 JavaInfo JavaInfo
286}
287
288var SyspropPublicStubInfoProvider = blueprint.NewProvider(SyspropPublicStubInfo{})
289
Paul Duffin44b481b2020-06-17 16:59:43 +0100290// Methods that need to be implemented for a module that is added to apex java_libs property.
291type ApexDependency interface {
Nan Zhanged19fc32017-10-19 13:06:22 -0700292 HeaderJars() android.Paths
Paul Duffin44b481b2020-06-17 16:59:43 +0100293 ImplementationAndResourcesJars() android.Paths
294}
295
Ulya Trafimovich31e444e2020-08-14 17:32:16 +0100296// Provides build path and install path to DEX jars.
297type UsesLibraryDependency interface {
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100298 DexJarBuildPath() OptionalDexJarPath
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +0100299 DexJarInstallPath() android.Path
Ulya Trafimovichdbf31662020-12-17 12:07:54 +0000300 ClassLoaderContexts() dexpreopt.ClassLoaderContextMap
Ulya Trafimovich31e444e2020-08-14 17:32:16 +0100301}
302
Jared Duke5979b302022-12-19 21:08:39 +0000303// Provides transitive Proguard flag files to downstream DEX jars.
304type LibraryDependency interface {
305 ExportedProguardFlagFiles() android.Paths
306}
307
Jaewoong Jung26342642021-03-17 15:56:23 -0700308// TODO(jungjw): Move this to kythe.go once it's created.
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800309type xref interface {
310 XrefJavaFiles() android.Paths
311}
312
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800313func (j *Module) XrefJavaFiles() android.Paths {
314 return j.kytheFiles
315}
316
Colin Crossbe1da472017-07-07 15:59:46 -0700317type dependencyTag struct {
318 blueprint.BaseDependencyTag
319 name string
Colin Cross65cb3142021-12-10 23:05:02 +0000320
321 // True if the dependency is relinked at runtime.
322 runtimeLinked bool
Colin Crossce564252022-01-12 11:13:32 -0800323
324 // True if the dependency is a toolchain, for example an annotation processor.
325 toolchain bool
Colin Cross2fe66872015-03-30 17:20:39 -0700326}
327
Colin Crosse9fe2942020-11-10 18:12:15 -0800328// installDependencyTag is a dependency tag that is annotated to cause the installed files of the
329// dependency to be installed when the parent module is installed.
330type installDependencyTag struct {
331 blueprint.BaseDependencyTag
332 android.InstallAlwaysNeededDependencyTag
333 name string
334}
335
Colin Cross65cb3142021-12-10 23:05:02 +0000336func (d dependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
337 if d.runtimeLinked {
338 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
Colin Crossce564252022-01-12 11:13:32 -0800339 } else if d.toolchain {
340 return []android.LicenseAnnotation{android.LicenseAnnotationToolchain}
Colin Cross65cb3142021-12-10 23:05:02 +0000341 }
342 return nil
343}
344
345var _ android.LicenseAnnotationsDependencyTag = dependencyTag{}
346
Ulya Trafimovichb5218112020-10-07 15:11:32 +0100347type usesLibraryDependencyTag struct {
348 dependencyTag
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100349 sdkVersion int // SDK version in which the library appared as a standalone library.
350 optional bool // If the dependency is optional or required.
Ulya Trafimovichb5218112020-10-07 15:11:32 +0100351}
352
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100353func makeUsesLibraryDependencyTag(sdkVersion int, optional bool) usesLibraryDependencyTag {
Ulya Trafimovichb5218112020-10-07 15:11:32 +0100354 return usesLibraryDependencyTag{
Colin Cross65cb3142021-12-10 23:05:02 +0000355 dependencyTag: dependencyTag{
356 name: fmt.Sprintf("uses-library-%d", sdkVersion),
357 runtimeLinked: true,
358 },
359 sdkVersion: sdkVersion,
360 optional: optional,
Ulya Trafimovichb5218112020-10-07 15:11:32 +0100361 }
362}
363
Jiyong Park8be103b2019-11-08 15:53:48 +0900364func IsJniDepTag(depTag blueprint.DependencyTag) bool {
Colin Crossde78d132020-10-09 18:59:49 -0700365 return depTag == jniLibTag
Jiyong Park8be103b2019-11-08 15:53:48 +0900366}
367
Colin Crossbe1da472017-07-07 15:59:46 -0700368var (
Colin Cross75ce9ec2021-02-26 16:20:32 -0800369 dataNativeBinsTag = dependencyTag{name: "dataNativeBins"}
Sam Delmericob3342ce2022-01-20 21:10:28 +0000370 dataDeviceBinsTag = dependencyTag{name: "dataDeviceBins"}
Colin Cross75ce9ec2021-02-26 16:20:32 -0800371 staticLibTag = dependencyTag{name: "staticlib"}
Colin Cross65cb3142021-12-10 23:05:02 +0000372 libTag = dependencyTag{name: "javalib", runtimeLinked: true}
Liz Kammeref28a4c2022-09-23 16:50:56 -0400373 sdkLibTag = dependencyTag{name: "sdklib", runtimeLinked: true}
Colin Cross65cb3142021-12-10 23:05:02 +0000374 java9LibTag = dependencyTag{name: "java9lib", runtimeLinked: true}
Colin Crossce564252022-01-12 11:13:32 -0800375 pluginTag = dependencyTag{name: "plugin", toolchain: true}
376 errorpronePluginTag = dependencyTag{name: "errorprone-plugin", toolchain: true}
377 exportedPluginTag = dependencyTag{name: "exported-plugin", toolchain: true}
Colin Cross65cb3142021-12-10 23:05:02 +0000378 bootClasspathTag = dependencyTag{name: "bootclasspath", runtimeLinked: true}
379 systemModulesTag = dependencyTag{name: "system modules", runtimeLinked: true}
Colin Cross75ce9ec2021-02-26 16:20:32 -0800380 frameworkResTag = dependencyTag{name: "framework-res"}
Colin Cross65cb3142021-12-10 23:05:02 +0000381 kotlinStdlibTag = dependencyTag{name: "kotlin-stdlib", runtimeLinked: true}
382 kotlinAnnotationsTag = dependencyTag{name: "kotlin-annotations", runtimeLinked: true}
Colin Crossce564252022-01-12 11:13:32 -0800383 kotlinPluginTag = dependencyTag{name: "kotlin-plugin", toolchain: true}
Colin Cross75ce9ec2021-02-26 16:20:32 -0800384 proguardRaiseTag = dependencyTag{name: "proguard-raise"}
385 certificateTag = dependencyTag{name: "certificate"}
386 instrumentationForTag = dependencyTag{name: "instrumentation_for"}
Colin Crossce564252022-01-12 11:13:32 -0800387 extraLintCheckTag = dependencyTag{name: "extra-lint-check", toolchain: true}
Colin Cross65cb3142021-12-10 23:05:02 +0000388 jniLibTag = dependencyTag{name: "jnilib", runtimeLinked: true}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500389 r8LibraryJarTag = dependencyTag{name: "r8-libraryjar", runtimeLinked: true}
Colin Cross75ce9ec2021-02-26 16:20:32 -0800390 syspropPublicStubDepTag = dependencyTag{name: "sysprop public stub"}
391 jniInstallTag = installDependencyTag{name: "jni install"}
392 binaryInstallTag = installDependencyTag{name: "binary install"}
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100393 usesLibReqTag = makeUsesLibraryDependencyTag(dexpreopt.AnySdkVersion, false)
394 usesLibOptTag = makeUsesLibraryDependencyTag(dexpreopt.AnySdkVersion, true)
395 usesLibCompat28OptTag = makeUsesLibraryDependencyTag(28, true)
396 usesLibCompat29ReqTag = makeUsesLibraryDependencyTag(29, false)
397 usesLibCompat30OptTag = makeUsesLibraryDependencyTag(30, true)
Colin Crossbe1da472017-07-07 15:59:46 -0700398)
Colin Cross2fe66872015-03-30 17:20:39 -0700399
Jiyong Park83dc74b2020-01-14 18:38:44 +0900400func IsLibDepTag(depTag blueprint.DependencyTag) bool {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400401 return depTag == libTag || depTag == sdkLibTag
Jiyong Park83dc74b2020-01-14 18:38:44 +0900402}
403
404func IsStaticLibDepTag(depTag blueprint.DependencyTag) bool {
405 return depTag == staticLibTag
406}
407
Colin Crossfc3674a2017-09-18 17:41:52 -0700408type sdkDep struct {
Pete Gilline3d44b22020-06-29 11:28:51 +0100409 useModule, useFiles, invalidVersion bool
Colin Cross47ff2522017-10-02 14:22:08 -0700410
Colin Cross6cef4812019-10-17 14:23:50 -0700411 // The modules that will be added to the bootclasspath when targeting 1.8 or lower
412 bootclasspath []string
Paul Duffine25c6442019-10-11 13:50:28 +0100413
414 // The default system modules to use. Will be an empty string if no system
415 // modules are to be used.
Colin Cross1369cdb2017-09-29 17:58:17 -0700416 systemModules string
417
Pete Gilline3d44b22020-06-29 11:28:51 +0100418 // The modules that will be added to the classpath regardless of the Java language level targeted
419 classpath []string
420
Colin Cross6cef4812019-10-17 14:23:50 -0700421 // The modules that will be added ot the classpath when targeting 1.9 or higher
Pete Gilline3d44b22020-06-29 11:28:51 +0100422 // (normally these will be on the bootclasspath when targeting 1.8 or lower)
Colin Cross6cef4812019-10-17 14:23:50 -0700423 java9Classpath []string
424
Colin Crossa97c5d32018-03-28 14:58:31 -0700425 frameworkResModule string
426
Colin Cross86a60ae2018-05-29 14:44:55 -0700427 jars android.Paths
Colin Cross3047fa22019-04-18 10:56:44 -0700428 aidl android.OptionalPath
Paul Duffin250e6192019-06-07 10:44:37 +0100429
430 noStandardLibs, noFrameworksLibs bool
431}
432
433func (s sdkDep) hasStandardLibs() bool {
434 return !s.noStandardLibs
435}
436
437func (s sdkDep) hasFrameworkLibs() bool {
438 return !s.noStandardLibs && !s.noFrameworksLibs
Colin Cross1369cdb2017-09-29 17:58:17 -0700439}
440
Colin Crossa4f08812018-10-02 22:03:40 -0700441type jniLib struct {
Colin Cross403cc152020-07-06 14:15:24 -0700442 name string
443 path android.Path
444 target android.Target
445 coverageFile android.OptionalPath
446 unstrippedFile android.Path
Jihoon Kangf78a8902022-09-01 22:47:07 +0000447 partition string
Colin Crossa4f08812018-10-02 22:03:40 -0700448}
449
Jiyong Parkf1691d22021-03-29 20:11:58 +0900450func sdkDeps(ctx android.BottomUpMutatorContext, sdkContext android.SdkContext, d dexer) {
Liz Kammerd6c31d22020-08-05 15:40:41 -0700451 sdkDep := decodeSdkDep(ctx, sdkContext)
452 if sdkDep.useModule {
453 ctx.AddVariationDependencies(nil, bootClasspathTag, sdkDep.bootclasspath...)
454 ctx.AddVariationDependencies(nil, java9LibTag, sdkDep.java9Classpath...)
Liz Kammeref28a4c2022-09-23 16:50:56 -0400455 ctx.AddVariationDependencies(nil, sdkLibTag, sdkDep.classpath...)
Liz Kammerd6c31d22020-08-05 15:40:41 -0700456 if d.effectiveOptimizeEnabled() && sdkDep.hasStandardLibs() {
457 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.LegacyCorePlatformBootclasspathLibraries...)
458 }
459 if d.effectiveOptimizeEnabled() && sdkDep.hasFrameworkLibs() {
460 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.FrameworkLibraries...)
461 }
462 }
463 if sdkDep.systemModules != "" {
464 ctx.AddVariationDependencies(nil, systemModulesTag, sdkDep.systemModules)
465 }
466}
467
Colin Cross32f676a2017-09-06 13:41:06 -0700468type deps struct {
Colin Cross9bb9bfb2022-03-17 11:12:32 -0700469 // bootClasspath is the list of jars that form the boot classpath (generally the java.* and
470 // android.* classes) for tools that still use it. javac targeting 1.9 or higher uses
471 // systemModules and java9Classpath instead.
472 bootClasspath classpath
473
474 // classpath is the list of jars that form the classpath for javac and kotlinc rules. It
475 // contains header jars for all static and non-static dependencies.
476 classpath classpath
477
478 // dexClasspath is the list of jars that form the classpath for d8 and r8 rules. It contains
479 // header jars for all non-static dependencies. Static dependencies have already been
480 // combined into the program jar.
481 dexClasspath classpath
482
483 // java9Classpath is the list of jars that will be added to the classpath when targeting
484 // 1.9 or higher. It generally contains the android.* classes, while the java.* classes
485 // are provided by systemModules.
486 java9Classpath classpath
487
Colin Cross748b2d82020-11-19 13:52:06 -0800488 processorPath classpath
489 errorProneProcessorPath classpath
490 processorClasses []string
491 staticJars android.Paths
492 staticHeaderJars android.Paths
493 staticResourceJars android.Paths
494 aidlIncludeDirs android.Paths
495 srcs android.Paths
496 srcJars android.Paths
497 systemModules *systemModules
498 aidlPreprocess android.OptionalPath
499 kotlinStdlib android.Paths
500 kotlinAnnotations android.Paths
Colin Crossa1ff7c62021-09-17 14:11:52 -0700501 kotlinPlugins android.Paths
Colin Crossbe9cdb82019-01-21 21:37:16 -0800502
503 disableTurbine bool
Colin Cross32f676a2017-09-06 13:41:06 -0700504}
Colin Cross2fe66872015-03-30 17:20:39 -0700505
Colin Cross54250902017-12-05 09:28:08 -0800506func checkProducesJars(ctx android.ModuleContext, dep android.SourceFileProducer) {
507 for _, f := range dep.Srcs() {
508 if f.Ext() != ".jar" {
509 ctx.ModuleErrorf("genrule %q must generate files ending with .jar to be used as a libs or static_libs dependency",
510 ctx.OtherModuleName(dep.(blueprint.Module)))
511 }
512 }
513}
514
Jiyong Parkf1691d22021-03-29 20:11:58 +0900515func getJavaVersion(ctx android.ModuleContext, javaVersion string, sdkContext android.SdkContext) javaVersion {
Nan Zhang357466b2018-04-17 17:38:36 -0700516 if javaVersion != "" {
Colin Cross1e743852019-10-28 11:37:20 -0700517 return normalizeJavaVersion(ctx, javaVersion)
Colin Cross17dec172020-05-14 18:05:32 -0700518 } else if ctx.Device() {
Jiyong Park92315372021-04-02 08:45:46 +0900519 return defaultJavaLanguageVersion(ctx, sdkContext.SdkVersion(ctx))
Sorin Bascace720c32022-05-24 12:13:50 +0100520 } else if ctx.Config().TargetsJava17() {
521 // Temporary experimental flag to be able to try and build with
522 // java version 17 options. The flag, if used, just sets Java
523 // 17 as the default version, leaving any components that
524 // target an older version intact.
525 return JAVA_VERSION_17
Sorin Basca8d3e0bb2022-01-20 15:21:51 +0000526 } else {
Sorin Basca18ecf612022-01-23 09:01:07 +0000527 return JAVA_VERSION_11
Nan Zhang357466b2018-04-17 17:38:36 -0700528 }
Nan Zhang357466b2018-04-17 17:38:36 -0700529}
530
Jihoon Kangff878bf2022-12-22 21:26:06 +0000531// Java version for stubs generation
532func getStubsJavaVersion() javaVersion {
533 return JAVA_VERSION_8
534}
535
Colin Cross1e743852019-10-28 11:37:20 -0700536type javaVersion int
537
538const (
539 JAVA_VERSION_UNSUPPORTED = 0
540 JAVA_VERSION_6 = 6
541 JAVA_VERSION_7 = 7
542 JAVA_VERSION_8 = 8
543 JAVA_VERSION_9 = 9
Sorin Bascac0244da2021-11-26 17:26:33 +0000544 JAVA_VERSION_11 = 11
Sorin Bascace720c32022-05-24 12:13:50 +0100545 JAVA_VERSION_17 = 17
Colin Cross1e743852019-10-28 11:37:20 -0700546)
547
548func (v javaVersion) String() string {
549 switch v {
550 case JAVA_VERSION_6:
551 return "1.6"
552 case JAVA_VERSION_7:
553 return "1.7"
554 case JAVA_VERSION_8:
555 return "1.8"
556 case JAVA_VERSION_9:
557 return "1.9"
Sorin Bascac0244da2021-11-26 17:26:33 +0000558 case JAVA_VERSION_11:
559 return "11"
Sorin Bascace720c32022-05-24 12:13:50 +0100560 case JAVA_VERSION_17:
561 return "17"
Colin Cross1e743852019-10-28 11:37:20 -0700562 default:
563 return "unsupported"
564 }
565}
566
Cole Faustd96eebf2022-06-28 14:41:27 -0700567func (v javaVersion) StringForKotlinc() string {
568 // $ ./external/kotlinc/bin/kotlinc -jvm-target foo
569 // error: unknown JVM target version: foo
570 // Supported versions: 1.6, 1.8, 9, 10, 11, 12, 13, 14, 15, 16, 17
571 switch v {
572 case JAVA_VERSION_7:
573 return "1.6"
574 case JAVA_VERSION_9:
575 return "9"
576 default:
577 return v.String()
578 }
579}
580
Colin Cross1e743852019-10-28 11:37:20 -0700581// Returns true if javac targeting this version uses system modules instead of a bootclasspath.
582func (v javaVersion) usesJavaModules() bool {
583 return v >= 9
584}
585
586func normalizeJavaVersion(ctx android.BaseModuleContext, javaVersion string) javaVersion {
Pete Gillin4e8b48a2019-07-12 13:16:17 +0100587 switch javaVersion {
588 case "1.6", "6":
Colin Cross1e743852019-10-28 11:37:20 -0700589 return JAVA_VERSION_6
Pete Gillin4e8b48a2019-07-12 13:16:17 +0100590 case "1.7", "7":
Colin Cross1e743852019-10-28 11:37:20 -0700591 return JAVA_VERSION_7
Pete Gillin4e8b48a2019-07-12 13:16:17 +0100592 case "1.8", "8":
Colin Cross1e743852019-10-28 11:37:20 -0700593 return JAVA_VERSION_8
Pete Gillin4e8b48a2019-07-12 13:16:17 +0100594 case "1.9", "9":
Colin Cross1e743852019-10-28 11:37:20 -0700595 return JAVA_VERSION_9
Sorin Bascac0244da2021-11-26 17:26:33 +0000596 case "11":
597 return JAVA_VERSION_11
Sorin Bascace720c32022-05-24 12:13:50 +0100598 case "17":
Sorin Basca5938fed2022-06-22 12:53:51 +0100599 return JAVA_VERSION_17
Sorin Bascace720c32022-05-24 12:13:50 +0100600 case "10", "12", "13", "14", "15", "16":
601 ctx.PropertyErrorf("java_version", "Java language level %s is not supported", javaVersion)
Colin Cross1e743852019-10-28 11:37:20 -0700602 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +0100603 default:
604 ctx.PropertyErrorf("java_version", "Unrecognized Java language level")
Colin Cross1e743852019-10-28 11:37:20 -0700605 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +0100606 }
607}
608
Colin Cross2fe66872015-03-30 17:20:39 -0700609//
610// Java libraries (.jar file)
611//
612
Colin Crossf506d872017-07-19 15:53:04 -0700613type Library struct {
Colin Cross46c9b8b2017-06-22 16:51:17 -0700614 Module
Colin Crossf0f2e2c2019-10-15 16:36:40 -0700615
Jared Duke5979b302022-12-19 21:08:39 +0000616 exportedProguardFlagFiles android.Paths
617
Colin Crossf0f2e2c2019-10-15 16:36:40 -0700618 InstallMixin func(ctx android.ModuleContext, installPath android.Path) (extraInstallDeps android.Paths)
Colin Cross2fe66872015-03-30 17:20:39 -0700619}
620
Jared Duke5979b302022-12-19 21:08:39 +0000621var _ LibraryDependency = (*Library)(nil)
622
623func (j *Library) ExportedProguardFlagFiles() android.Paths {
624 return j.exportedProguardFlagFiles
625}
626
Jiyong Park45bf82e2020-12-15 22:29:02 +0900627var _ android.ApexModule = (*Library)(nil)
628
satayevd604b212021-07-21 14:23:52 +0100629// Provides access to the list of permitted packages from apex boot jars.
Paul Duffine739f1e2020-05-29 11:24:51 +0100630type PermittedPackagesForUpdatableBootJars interface {
631 PermittedPackagesForUpdatableBootJars() []string
632}
633
634var _ PermittedPackagesForUpdatableBootJars = (*Library)(nil)
635
636func (j *Library) PermittedPackagesForUpdatableBootJars() []string {
637 return j.properties.Permitted_packages
638}
639
Colin Cross42be7612019-02-21 18:12:14 -0800640func shouldUncompressDex(ctx android.ModuleContext, dexpreopter *dexpreopter) bool {
Ulya Trafimovichf491dde2020-01-24 12:19:45 +0000641 // Store uncompressed (and aligned) any dex files from jars in APEXes.
Colin Cross56a83212020-09-15 18:30:11 -0700642 if apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo); !apexInfo.IsForPlatform() {
Ulya Trafimovichf491dde2020-01-24 12:19:45 +0000643 return true
644 }
645
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +0000646 // Store uncompressed (and do not strip) dex files from boot class path jars.
647 if inList(ctx.ModuleName(), ctx.Config().BootJars()) {
648 return true
649 }
650
651 // Store uncompressed dex files that are preopted on /system.
Jiakai Zhang519c5c82021-09-16 06:15:39 +0000652 if !dexpreopter.dexpreoptDisabled(ctx) && (ctx.Host() || !dexpreopter.odexOnSystemOther(ctx, dexpreopter.installPath)) {
Vladimir Markoe8b00d62018-12-21 15:54:16 +0000653 return true
654 }
Colin Cross083a2aa2019-02-06 16:37:12 -0800655 if ctx.Config().UncompressPrivAppDex() &&
656 inList(ctx.ModuleName(), ctx.Config().ModulesLoadedByPrivilegedModules()) {
657 return true
658 }
659
Colin Cross2fc72f62018-12-21 12:59:54 -0800660 return false
661}
662
Jiakai Zhang22450f22021-10-11 03:05:20 +0000663// Sets `dexer.dexProperties.Uncompress_dex` to the proper value.
664func setUncompressDex(ctx android.ModuleContext, dexpreopter *dexpreopter, dexer *dexer) {
665 if dexer.dexProperties.Uncompress_dex == nil {
666 // If the value was not force-set by the user, use reasonable default based on the module.
667 dexer.dexProperties.Uncompress_dex = proptools.BoolPtr(shouldUncompressDex(ctx, dexpreopter))
668 }
669}
670
Colin Crossf506d872017-07-19 15:53:04 -0700671func (j *Library) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000672
673 j.provideHiddenAPIPropertyInfo(ctx)
674
Jiyong Park92315372021-04-02 08:45:46 +0900675 j.sdkVersion = j.SdkVersion(ctx)
676 j.minSdkVersion = j.MinSdkVersion(ctx)
satayev0a420e72021-11-29 17:25:52 +0000677 j.maxSdkVersion = j.MaxSdkVersion(ctx)
Jiyong Park92315372021-04-02 08:45:46 +0900678
Colin Cross56a83212020-09-15 18:30:11 -0700679 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
680 if !apexInfo.IsForPlatform() {
681 j.hideApexVariantFromMake = true
682 }
683
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100684 j.checkSdkVersions(ctx)
Colin Cross61df14a2021-12-01 13:04:46 -0800685 if ctx.Device() {
686 j.dexpreopter.installPath = j.dexpreopter.getInstallPath(
687 ctx, android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar"))
688 j.dexpreopter.isSDKLibrary = j.deviceProperties.IsSDKLibrary
689 setUncompressDex(ctx, &j.dexpreopter, &j.dexer)
690 j.dexpreopter.uncompressedDex = *j.dexProperties.Uncompress_dex
691 j.classLoaderContexts = j.usesLibrary.classLoaderContextForUsesLibDeps(ctx)
692 }
Jaewoong Junga24af3b2019-05-13 09:23:20 -0700693 j.compile(ctx, nil)
Colin Crossb7a63242015-04-16 14:09:14 -0700694
bralee1fbf4402020-05-21 10:11:59 +0800695 // Collect the module directory for IDE info in java/jdeps.go.
696 j.modulePaths = append(j.modulePaths, ctx.ModuleDir())
697
Colin Cross56a83212020-09-15 18:30:11 -0700698 exclusivelyForApex := !apexInfo.IsForPlatform()
Jiyong Park7f7766d2019-07-25 22:02:35 +0900699 if (Bool(j.properties.Installable) || ctx.Host()) && !exclusivelyForApex {
Colin Crossf0f2e2c2019-10-15 16:36:40 -0700700 var extraInstallDeps android.Paths
701 if j.InstallMixin != nil {
702 extraInstallDeps = j.InstallMixin(ctx, j.outputFile)
703 }
Colin Cross1d0eb7a2021-11-03 14:08:20 -0700704 hostDexNeeded := Bool(j.deviceProperties.Hostdex) && !ctx.Host()
705 if hostDexNeeded {
Colin Cross3108ce12021-11-10 14:38:50 -0800706 j.hostdexInstallFile = ctx.InstallFile(
707 android.PathForHostDexInstall(ctx, "framework"),
Colin Cross1d0eb7a2021-11-03 14:08:20 -0700708 j.Stem()+"-hostdex.jar", j.outputFile)
709 }
710 var installDir android.InstallPath
711 if ctx.InstallInTestcases() {
712 var archDir string
713 if !ctx.Host() {
714 archDir = ctx.DeviceConfig().DeviceArch()
715 }
716 installDir = android.PathForModuleInstall(ctx, ctx.ModuleName(), archDir)
717 } else {
718 installDir = android.PathForModuleInstall(ctx, "framework")
719 }
720 j.installFile = ctx.InstallFile(installDir, j.Stem()+".jar", j.outputFile, extraInstallDeps...)
Colin Cross2c429dc2017-08-31 16:45:16 -0700721 }
Jared Duke5979b302022-12-19 21:08:39 +0000722
723 j.exportedProguardFlagFiles = append(j.exportedProguardFlagFiles,
724 android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)...)
725 ctx.VisitDirectDeps(func(m android.Module) {
726 if lib, ok := m.(LibraryDependency); ok && ctx.OtherModuleDependencyTag(m) == staticLibTag {
727 j.exportedProguardFlagFiles = append(j.exportedProguardFlagFiles, lib.ExportedProguardFlagFiles()...)
728 }
729 })
730 j.exportedProguardFlagFiles = android.FirstUniquePaths(j.exportedProguardFlagFiles)
Colin Crossb7a63242015-04-16 14:09:14 -0700731}
732
Colin Crossf506d872017-07-19 15:53:04 -0700733func (j *Library) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross46c9b8b2017-06-22 16:51:17 -0700734 j.deps(ctx)
Ulya Trafimoviche4432872021-08-18 16:57:11 +0100735 j.usesLibrary.deps(ctx, false)
Colin Cross46c9b8b2017-06-22 16:51:17 -0700736}
737
Paul Duffin0e0cf1d2019-11-12 19:39:25 +0000738const (
Paul Duffin1b82e6a2019-12-03 18:06:47 +0000739 aidlIncludeDir = "aidl"
740 javaDir = "java"
741 jarFileSuffix = ".jar"
742 testConfigSuffix = "-AndroidTest.xml"
Paul Duffin0e0cf1d2019-11-12 19:39:25 +0000743)
744
Paul Duffina0dbf432019-12-05 11:25:53 +0000745// path to the jar file of a java library. Relative to <sdk_root>/<api_dir>
Paul Duffin13648912022-07-15 13:12:35 +0000746func sdkSnapshotFilePathForJar(_ android.SdkMemberContext, osPrefix, name string) string {
Paul Duffina04c1072020-03-02 10:16:35 +0000747 return sdkSnapshotFilePathForMember(osPrefix, name, jarFileSuffix)
Paul Duffin1b82e6a2019-12-03 18:06:47 +0000748}
749
Paul Duffina04c1072020-03-02 10:16:35 +0000750func sdkSnapshotFilePathForMember(osPrefix, name string, suffix string) string {
751 return filepath.Join(javaDir, osPrefix, name+suffix)
Paul Duffin0e0cf1d2019-11-12 19:39:25 +0000752}
753
Paul Duffin13879572019-11-28 14:31:38 +0000754type librarySdkMemberType struct {
Paul Duffin255f18e2019-12-13 11:22:16 +0000755 android.SdkMemberTypeBase
Paul Duffinf5c0a9c2020-02-28 14:39:53 +0000756
757 // Function to retrieve the appropriate output jar (implementation or header) from
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000758 // the library.
Paul Duffindb170e42020-12-08 17:48:25 +0000759 jarToExportGetter func(ctx android.SdkMemberContext, j *Library) android.Path
760
761 // Function to compute the snapshot relative path to which the named library's
762 // jar should be copied.
Paul Duffin13648912022-07-15 13:12:35 +0000763 snapshotPathGetter func(ctx android.SdkMemberContext, osPrefix, name string) string
Paul Duffindb170e42020-12-08 17:48:25 +0000764
765 // True if only the jar should be copied to the snapshot, false if the jar plus any additional
766 // files like aidl files should also be copied.
767 onlyCopyJarToSnapshot bool
Paul Duffin13879572019-11-28 14:31:38 +0000768}
769
Paul Duffindb170e42020-12-08 17:48:25 +0000770const (
771 onlyCopyJarToSnapshot = true
772 copyEverythingToSnapshot = false
773)
774
Paul Duffin296701e2021-07-14 10:29:36 +0100775func (mt *librarySdkMemberType) AddDependencies(ctx android.SdkDependencyContext, dependencyTag blueprint.DependencyTag, names []string) {
776 ctx.AddVariationDependencies(nil, dependencyTag, names...)
Paul Duffin13879572019-11-28 14:31:38 +0000777}
778
779func (mt *librarySdkMemberType) IsInstance(module android.Module) bool {
780 _, ok := module.(*Library)
781 return ok
782}
783
Paul Duffin3a4eb502020-03-19 16:11:18 +0000784func (mt *librarySdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
785 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_import")
Paul Duffin14eb4672020-03-02 11:33:02 +0000786}
Paul Duffina0dbf432019-12-05 11:25:53 +0000787
Paul Duffin14eb4672020-03-02 11:33:02 +0000788func (mt *librarySdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
Paul Duffina551a1c2020-03-17 21:04:24 +0000789 return &librarySdkMemberProperties{}
Paul Duffin14eb4672020-03-02 11:33:02 +0000790}
791
792type librarySdkMemberProperties struct {
793 android.SdkMemberPropertiesBase
794
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000795 JarToExport android.Path `android:"arch_variant"`
Paul Duffina551a1c2020-03-17 21:04:24 +0000796 AidlIncludeDirs android.Paths
Paul Duffin869de142021-07-15 14:14:41 +0100797
798 // The list of permitted packages that need to be passed to the prebuilts as they are used to
799 // create the updatable-bcp-packages.txt file.
800 PermittedPackages []string
Paul Duffinbb638eb2022-11-26 13:36:38 +0000801
802 // The value of the min_sdk_version property, translated into a number where possible.
803 MinSdkVersion *string `supported_build_releases:"Tiramisu+"`
Paul Duffin14eb4672020-03-02 11:33:02 +0000804}
805
Paul Duffin3a4eb502020-03-19 16:11:18 +0000806func (p *librarySdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffin13879572019-11-28 14:31:38 +0000807 j := variant.(*Library)
808
Paul Duffin7ed6ff82022-11-21 10:57:30 +0000809 p.JarToExport = ctx.MemberType().(*librarySdkMemberType).jarToExportGetter(ctx, j)
Paul Duffindb170e42020-12-08 17:48:25 +0000810
Paul Duffina551a1c2020-03-17 21:04:24 +0000811 p.AidlIncludeDirs = j.AidlIncludeDirs()
Paul Duffin869de142021-07-15 14:14:41 +0100812
813 p.PermittedPackages = j.PermittedPackagesForUpdatableBootJars()
Paul Duffinbb638eb2022-11-26 13:36:38 +0000814
815 // If the min_sdk_version was set then add the canonical representation of the API level to the
816 // snapshot.
817 if j.deviceProperties.Min_sdk_version != nil {
818 canonical := android.ReplaceFinalizedCodenames(ctx.SdkModuleContext().Config(), j.minSdkVersion.ApiLevel.String())
819 p.MinSdkVersion = proptools.StringPtr(canonical)
820 }
Paul Duffin14eb4672020-03-02 11:33:02 +0000821}
Paul Duffin0e0cf1d2019-11-12 19:39:25 +0000822
Paul Duffin3a4eb502020-03-19 16:11:18 +0000823func (p *librarySdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffina551a1c2020-03-17 21:04:24 +0000824 builder := ctx.SnapshotBuilder()
Paul Duffin3a4eb502020-03-19 16:11:18 +0000825
Paul Duffindb170e42020-12-08 17:48:25 +0000826 memberType := ctx.MemberType().(*librarySdkMemberType)
827
Paul Duffina551a1c2020-03-17 21:04:24 +0000828 exportedJar := p.JarToExport
829 if exportedJar != nil {
Paul Duffindb170e42020-12-08 17:48:25 +0000830 // Delegate the creation of the snapshot relative path to the member type.
Paul Duffin13648912022-07-15 13:12:35 +0000831 snapshotRelativeJavaLibPath := memberType.snapshotPathGetter(ctx, p.OsPrefix(), ctx.Name())
Paul Duffindb170e42020-12-08 17:48:25 +0000832
833 // Copy the exported jar to the snapshot.
Paul Duffin14eb4672020-03-02 11:33:02 +0000834 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
835
Paul Duffina551a1c2020-03-17 21:04:24 +0000836 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
837 }
838
Paul Duffinbb638eb2022-11-26 13:36:38 +0000839 if p.MinSdkVersion != nil {
840 propertySet.AddProperty("min_sdk_version", *p.MinSdkVersion)
841 }
842
Paul Duffin869de142021-07-15 14:14:41 +0100843 if len(p.PermittedPackages) > 0 {
844 propertySet.AddProperty("permitted_packages", p.PermittedPackages)
845 }
846
Paul Duffindb170e42020-12-08 17:48:25 +0000847 // Do not copy anything else to the snapshot.
848 if memberType.onlyCopyJarToSnapshot {
849 return
850 }
851
Paul Duffina551a1c2020-03-17 21:04:24 +0000852 aidlIncludeDirs := p.AidlIncludeDirs
853 if len(aidlIncludeDirs) != 0 {
854 sdkModuleContext := ctx.SdkModuleContext()
855 for _, dir := range aidlIncludeDirs {
Paul Duffin14eb4672020-03-02 11:33:02 +0000856 // TODO(jiyong): copy parcelable declarations only
857 aidlFiles, _ := sdkModuleContext.GlobWithDeps(dir.String()+"/**/*.aidl", nil)
858 for _, file := range aidlFiles {
859 builder.CopyToSnapshot(android.PathForSource(sdkModuleContext, file), filepath.Join(aidlIncludeDir, file))
860 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +0000861 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +0000862
Paul Duffina551a1c2020-03-17 21:04:24 +0000863 // TODO(b/151933053) - add aidl include dirs property
Paul Duffin14eb4672020-03-02 11:33:02 +0000864 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +0000865}
866
Colin Cross1b16b0e2019-02-12 14:41:32 -0800867// java_library builds and links sources into a `.jar` file for the device, and possibly for the host as well.
868//
869// By default, a java_library has a single variant that produces a `.jar` file containing `.class` files that were
870// compiled against the device bootclasspath. This jar is not suitable for installing on a device, but can be used
871// as a `static_libs` dependency of another module.
872//
873// Specifying `installable: true` will product a `.jar` file containing `classes.dex` files, suitable for installing on
874// a device.
875//
876// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
877// compiled against the host bootclasspath.
Colin Cross9ae1b922018-06-26 17:59:05 -0700878func LibraryFactory() android.Module {
879 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -0700880
Colin Crossce6734e2020-06-15 16:09:53 -0700881 module.addHostAndDeviceProperties()
Colin Cross2fe66872015-03-30 17:20:39 -0700882
Paul Duffin71b33cc2021-06-23 11:39:47 +0100883 module.initModuleAndImport(module)
Paul Duffin859fe962020-05-15 10:20:31 +0100884
Jiyong Park7f7766d2019-07-25 22:02:35 +0900885 android.InitApexModule(module)
Wei Libafb6d62021-12-10 03:14:59 -0800886 android.InitBazelModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +0900887 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross9ae1b922018-06-26 17:59:05 -0700888 return module
Colin Cross2fe66872015-03-30 17:20:39 -0700889}
890
Colin Cross1b16b0e2019-02-12 14:41:32 -0800891// java_library_static is an obsolete alias for java_library.
892func LibraryStaticFactory() android.Module {
893 return LibraryFactory()
894}
895
896// java_library_host builds and links sources into a `.jar` file for the host.
897//
898// A java_library_host has a single variant that produces a `.jar` file containing `.class` files that were
899// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -0700900func LibraryHostFactory() android.Module {
901 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -0700902
Colin Crossce6734e2020-06-15 16:09:53 -0700903 module.addHostProperties()
Colin Cross36242852017-06-23 15:06:31 -0700904
Colin Cross9ae1b922018-06-26 17:59:05 -0700905 module.Module.properties.Installable = proptools.BoolPtr(true)
906
Jiyong Park7f7766d2019-07-25 22:02:35 +0900907 android.InitApexModule(module)
Wei Libafb6d62021-12-10 03:14:59 -0800908 android.InitBazelModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +0900909 InitJavaModule(module, android.HostSupported)
Colin Cross36242852017-06-23 15:06:31 -0700910 return module
Colin Cross2fe66872015-03-30 17:20:39 -0700911}
912
913//
Colin Crossb628ea52018-08-14 16:42:33 -0700914// Java Tests
Colin Cross05638fc2018-04-09 18:40:24 -0700915//
916
Dan Shi95d19422020-08-15 12:24:26 -0700917// Test option struct.
918type TestOptions struct {
Zhenhuang Wang0ac5a432022-08-12 18:49:20 +0800919 android.CommonTestOptions
920
Dan Shi95d19422020-08-15 12:24:26 -0700921 // a list of extra test configuration files that should be installed with the module.
922 Extra_test_configs []string `android:"path,arch_variant"`
Cole Faust21680542022-12-07 18:18:37 -0800923
924 // Extra <option> tags to add to the auto generated test xml file. The "key"
925 // is optional in each of these.
926 Tradefed_options []tradefed.Option
Dan Shi95d19422020-08-15 12:24:26 -0700927}
928
Colin Cross05638fc2018-04-09 18:40:24 -0700929type testProperties struct {
Colin Cross05638fc2018-04-09 18:40:24 -0700930 // list of compatibility suites (for example "cts", "vts") that the module should be
931 // installed into.
932 Test_suites []string `android:"arch_variant"`
Julien Despreze146e392018-08-02 15:00:46 -0700933
934 // the name of the test configuration (for example "AndroidTest.xml") that should be
935 // installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -0800936 Test_config *string `android:"path,arch_variant"`
Colin Crossd96ca352018-08-10 16:06:24 -0700937
Jack He33338892018-09-19 02:21:28 -0700938 // the name of the test configuration template (for example "AndroidTestTemplate.xml") that
939 // should be installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -0800940 Test_config_template *string `android:"path,arch_variant"`
Jack He33338892018-09-19 02:21:28 -0700941
Colin Crossd96ca352018-08-10 16:06:24 -0700942 // list of files or filegroup modules that provide data that should be installed alongside
943 // the test
Jiyong Park2b0e4902021-02-16 06:52:39 +0900944 Data []string `android:"path"`
Dan Shi6ffaaa82019-09-26 11:41:36 -0700945
946 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
947 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
948 // explicitly.
949 Auto_gen_config *bool
easoncylee5bcff5d2020-04-30 14:57:06 +0800950
951 // Add parameterized mainline modules to auto generated test config. The options will be
952 // handled by TradeFed to do downloading and installing the specified modules on the device.
953 Test_mainline_modules []string
Dan Shi95d19422020-08-15 12:24:26 -0700954
955 // Test options.
956 Test_options TestOptions
Colin Crossf8d9c492021-01-26 11:01:43 -0800957
958 // Names of modules containing JNI libraries that should be installed alongside the test.
959 Jni_libs []string
Colin Crosscfb0f5e2021-09-24 15:47:17 -0700960
961 // Install the test into a folder named for the module in all test suites.
962 Per_testcase_directory *bool
Colin Cross05638fc2018-04-09 18:40:24 -0700963}
964
Liz Kammerdd849a82020-06-12 16:38:45 -0700965type hostTestProperties struct {
966 // list of native binary modules that should be installed alongside the test
967 Data_native_bins []string `android:"arch_variant"`
Sam Delmericob3342ce2022-01-20 21:10:28 +0000968
969 // list of device binary modules that should be installed alongside the test
Sam Delmericocc271e22022-06-01 15:45:02 +0000970 // This property only adds the first variant of the dependency
971 Data_device_bins_first []string `android:"arch_variant"`
972
973 // list of device binary modules that should be installed alongside the test
974 // This property adds 64bit AND 32bit variants of the dependency
975 Data_device_bins_both []string `android:"arch_variant"`
976
977 // list of device binary modules that should be installed alongside the test
978 // This property only adds 64bit variants of the dependency
979 Data_device_bins_64 []string `android:"arch_variant"`
980
981 // list of device binary modules that should be installed alongside the test
982 // This property adds 32bit variants of the dependency if available, or else
983 // defaults to the 64bit variant
984 Data_device_bins_prefer32 []string `android:"arch_variant"`
985
986 // list of device binary modules that should be installed alongside the test
987 // This property only adds 32bit variants of the dependency
988 Data_device_bins_32 []string `android:"arch_variant"`
Liz Kammerdd849a82020-06-12 16:38:45 -0700989}
990
Paul Duffin42df1442019-03-20 12:45:53 +0000991type testHelperLibraryProperties struct {
992 // list of compatibility suites (for example "cts", "vts") that the module should be
993 // installed into.
994 Test_suites []string `android:"arch_variant"`
Colin Crosscfb0f5e2021-09-24 15:47:17 -0700995
996 // Install the test into a folder named for the module in all test suites.
997 Per_testcase_directory *bool
Paul Duffin42df1442019-03-20 12:45:53 +0000998}
999
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001000type prebuiltTestProperties struct {
1001 // list of compatibility suites (for example "cts", "vts") that the module should be
1002 // installed into.
1003 Test_suites []string `android:"arch_variant"`
1004
1005 // the name of the test configuration (for example "AndroidTest.xml") that should be
1006 // installed with the module.
1007 Test_config *string `android:"path,arch_variant"`
1008}
1009
Colin Cross05638fc2018-04-09 18:40:24 -07001010type Test struct {
1011 Library
1012
1013 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07001014
Dan Shi95d19422020-08-15 12:24:26 -07001015 testConfig android.Path
1016 extraTestConfigs android.Paths
1017 data android.Paths
Colin Cross303e21f2018-08-07 16:49:25 -07001018}
1019
Liz Kammerdd849a82020-06-12 16:38:45 -07001020type TestHost struct {
1021 Test
1022
1023 testHostProperties hostTestProperties
1024}
1025
Paul Duffin42df1442019-03-20 12:45:53 +00001026type TestHelperLibrary struct {
1027 Library
1028
1029 testHelperLibraryProperties testHelperLibraryProperties
1030}
1031
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001032type JavaTestImport struct {
1033 Import
1034
1035 prebuiltTestProperties prebuiltTestProperties
1036
1037 testConfig android.Path
Liz Kammerd6c31d22020-08-05 15:40:41 -07001038 dexJarFile android.Path
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001039}
1040
Colin Cross24cc4be62021-11-03 14:09:41 -07001041func (j *Test) InstallInTestcases() bool {
1042 // Host java tests install into $(HOST_OUT_JAVA_LIBRARIES), and then are copied into
1043 // testcases by base_rules.mk.
1044 return !j.Host()
1045}
1046
1047func (j *TestHelperLibrary) InstallInTestcases() bool {
1048 return true
1049}
1050
1051func (j *JavaTestImport) InstallInTestcases() bool {
1052 return true
1053}
1054
Sam Delmericocc271e22022-06-01 15:45:02 +00001055func (j *TestHost) addDataDeviceBinsDeps(ctx android.BottomUpMutatorContext) {
1056 if len(j.testHostProperties.Data_device_bins_first) > 0 {
1057 deviceVariations := ctx.Config().AndroidFirstDeviceTarget.Variations()
1058 ctx.AddFarVariationDependencies(deviceVariations, dataDeviceBinsTag, j.testHostProperties.Data_device_bins_first...)
1059 }
1060
1061 var maybeAndroid32Target *android.Target
1062 var maybeAndroid64Target *android.Target
1063 android32TargetList := android.FirstTarget(ctx.Config().Targets[android.Android], "lib32")
1064 android64TargetList := android.FirstTarget(ctx.Config().Targets[android.Android], "lib64")
1065 if len(android32TargetList) > 0 {
1066 maybeAndroid32Target = &android32TargetList[0]
1067 }
1068 if len(android64TargetList) > 0 {
1069 maybeAndroid64Target = &android64TargetList[0]
1070 }
1071
1072 if len(j.testHostProperties.Data_device_bins_both) > 0 {
1073 if maybeAndroid32Target == nil && maybeAndroid64Target == nil {
1074 ctx.PropertyErrorf("data_device_bins_both", "no device targets available. Targets: %q", ctx.Config().Targets)
1075 return
1076 }
1077 if maybeAndroid32Target != nil {
1078 ctx.AddFarVariationDependencies(
1079 maybeAndroid32Target.Variations(),
1080 dataDeviceBinsTag,
1081 j.testHostProperties.Data_device_bins_both...,
1082 )
1083 }
1084 if maybeAndroid64Target != nil {
1085 ctx.AddFarVariationDependencies(
1086 maybeAndroid64Target.Variations(),
1087 dataDeviceBinsTag,
1088 j.testHostProperties.Data_device_bins_both...,
1089 )
1090 }
1091 }
1092
1093 if len(j.testHostProperties.Data_device_bins_prefer32) > 0 {
1094 if maybeAndroid32Target != nil {
1095 ctx.AddFarVariationDependencies(
1096 maybeAndroid32Target.Variations(),
1097 dataDeviceBinsTag,
1098 j.testHostProperties.Data_device_bins_prefer32...,
1099 )
1100 } else {
1101 if maybeAndroid64Target == nil {
1102 ctx.PropertyErrorf("data_device_bins_prefer32", "no device targets available. Targets: %q", ctx.Config().Targets)
1103 return
1104 }
1105 ctx.AddFarVariationDependencies(
1106 maybeAndroid64Target.Variations(),
1107 dataDeviceBinsTag,
1108 j.testHostProperties.Data_device_bins_prefer32...,
1109 )
1110 }
1111 }
1112
1113 if len(j.testHostProperties.Data_device_bins_32) > 0 {
1114 if maybeAndroid32Target == nil {
1115 ctx.PropertyErrorf("data_device_bins_32", "cannot find 32bit device target. Targets: %q", ctx.Config().Targets)
1116 return
1117 }
1118 deviceVariations := maybeAndroid32Target.Variations()
1119 ctx.AddFarVariationDependencies(deviceVariations, dataDeviceBinsTag, j.testHostProperties.Data_device_bins_32...)
1120 }
1121
1122 if len(j.testHostProperties.Data_device_bins_64) > 0 {
1123 if maybeAndroid64Target == nil {
1124 ctx.PropertyErrorf("data_device_bins_64", "cannot find 64bit device target. Targets: %q", ctx.Config().Targets)
1125 return
1126 }
1127 deviceVariations := maybeAndroid64Target.Variations()
1128 ctx.AddFarVariationDependencies(deviceVariations, dataDeviceBinsTag, j.testHostProperties.Data_device_bins_64...)
1129 }
1130}
1131
Liz Kammerdd849a82020-06-12 16:38:45 -07001132func (j *TestHost) DepsMutator(ctx android.BottomUpMutatorContext) {
1133 if len(j.testHostProperties.Data_native_bins) > 0 {
1134 for _, target := range ctx.MultiTargets() {
1135 ctx.AddVariationDependencies(target.Variations(), dataNativeBinsTag, j.testHostProperties.Data_native_bins...)
1136 }
1137 }
1138
Colin Crossf8d9c492021-01-26 11:01:43 -08001139 if len(j.testProperties.Jni_libs) > 0 {
1140 for _, target := range ctx.MultiTargets() {
1141 sharedLibVariations := append(target.Variations(), blueprint.Variation{Mutator: "link", Variation: "shared"})
1142 ctx.AddFarVariationDependencies(sharedLibVariations, jniLibTag, j.testProperties.Jni_libs...)
1143 }
1144 }
1145
Sam Delmericocc271e22022-06-01 15:45:02 +00001146 j.addDataDeviceBinsDeps(ctx)
Liz Kammerdd849a82020-06-12 16:38:45 -07001147 j.deps(ctx)
1148}
1149
Yuexi Ma627263f2021-03-04 13:47:56 -08001150func (j *TestHost) AddExtraResource(p android.Path) {
1151 j.extraResources = append(j.extraResources, p)
1152}
1153
Sam Delmericocc271e22022-06-01 15:45:02 +00001154func (j *TestHost) dataDeviceBins() []string {
1155 ret := make([]string, 0,
1156 len(j.testHostProperties.Data_device_bins_first)+
1157 len(j.testHostProperties.Data_device_bins_both)+
1158 len(j.testHostProperties.Data_device_bins_prefer32)+
1159 len(j.testHostProperties.Data_device_bins_32)+
1160 len(j.testHostProperties.Data_device_bins_64),
1161 )
1162
1163 ret = append(ret, j.testHostProperties.Data_device_bins_first...)
1164 ret = append(ret, j.testHostProperties.Data_device_bins_both...)
1165 ret = append(ret, j.testHostProperties.Data_device_bins_prefer32...)
1166 ret = append(ret, j.testHostProperties.Data_device_bins_32...)
1167 ret = append(ret, j.testHostProperties.Data_device_bins_64...)
1168
1169 return ret
1170}
1171
Sam Delmericob3342ce2022-01-20 21:10:28 +00001172func (j *TestHost) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1173 var configs []tradefed.Config
Sam Delmericocc271e22022-06-01 15:45:02 +00001174 dataDeviceBins := j.dataDeviceBins()
1175 if len(dataDeviceBins) > 0 {
Sam Delmericob3342ce2022-01-20 21:10:28 +00001176 // add Tradefed configuration to push device bins to device for testing
1177 remoteDir := filepath.Join("/data/local/tests/unrestricted/", j.Name())
1178 options := []tradefed.Option{{Name: "cleanup", Value: "true"}}
Sam Delmericocc271e22022-06-01 15:45:02 +00001179 for _, bin := range dataDeviceBins {
Sam Delmericob3342ce2022-01-20 21:10:28 +00001180 fullPath := filepath.Join(remoteDir, bin)
1181 options = append(options, tradefed.Option{Name: "push-file", Key: bin, Value: fullPath})
1182 }
Sam Delmericocc271e22022-06-01 15:45:02 +00001183 configs = append(configs, tradefed.Object{
1184 Type: "target_preparer",
1185 Class: "com.android.tradefed.targetprep.PushFilePreparer",
1186 Options: options,
1187 })
Sam Delmericob3342ce2022-01-20 21:10:28 +00001188 }
1189
1190 j.Test.generateAndroidBuildActionsWithConfig(ctx, configs)
1191}
1192
Colin Cross303e21f2018-08-07 16:49:25 -07001193func (j *Test) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Sam Delmericob3342ce2022-01-20 21:10:28 +00001194 j.generateAndroidBuildActionsWithConfig(ctx, nil)
1195}
1196
1197func (j *Test) generateAndroidBuildActionsWithConfig(ctx android.ModuleContext, configs []tradefed.Config) {
Julien Desprezb2166612021-03-05 18:08:36 +00001198 if j.testProperties.Test_options.Unit_test == nil && ctx.Host() {
1199 // TODO(b/): Clean temporary heuristic to avoid unexpected onboarding.
Julien Desprezf666b152021-03-15 13:07:53 -07001200 defaultUnitTest := !inList("tradefed", j.properties.Libs) && !inList("cts", j.testProperties.Test_suites)
Julien Desprezb2166612021-03-05 18:08:36 +00001201 j.testProperties.Test_options.Unit_test = proptools.BoolPtr(defaultUnitTest)
1202 }
Cole Faust21680542022-12-07 18:18:37 -08001203 j.testConfig = tradefed.AutoGenTestConfig(ctx, tradefed.AutoGenTestConfigOptions{
1204 TestConfigProp: j.testProperties.Test_config,
1205 TestConfigTemplateProp: j.testProperties.Test_config_template,
1206 TestSuites: j.testProperties.Test_suites,
1207 Config: configs,
1208 OptionsForAutogenerated: j.testProperties.Test_options.Tradefed_options,
1209 AutoGenConfig: j.testProperties.Auto_gen_config,
1210 UnitTest: j.testProperties.Test_options.Unit_test,
1211 DeviceTemplate: "${JavaTestConfigTemplate}",
1212 HostTemplate: "${JavaHostTestConfigTemplate}",
1213 HostUnitTestTemplate: "${JavaHostUnitTestConfigTemplate}",
1214 })
Liz Kammerdd849a82020-06-12 16:38:45 -07001215
Colin Cross8a497952019-03-05 22:25:09 -08001216 j.data = android.PathsForModuleSrc(ctx, j.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07001217
Dan Shi95d19422020-08-15 12:24:26 -07001218 j.extraTestConfigs = android.PathsForModuleSrc(ctx, j.testProperties.Test_options.Extra_test_configs)
1219
Liz Kammerdd849a82020-06-12 16:38:45 -07001220 ctx.VisitDirectDepsWithTag(dataNativeBinsTag, func(dep android.Module) {
1221 j.data = append(j.data, android.OutputFileForModule(ctx, dep, ""))
1222 })
1223
Sam Delmericob3342ce2022-01-20 21:10:28 +00001224 ctx.VisitDirectDepsWithTag(dataDeviceBinsTag, func(dep android.Module) {
1225 j.data = append(j.data, android.OutputFileForModule(ctx, dep, ""))
1226 })
1227
Colin Crossf8d9c492021-01-26 11:01:43 -08001228 ctx.VisitDirectDepsWithTag(jniLibTag, func(dep android.Module) {
1229 sharedLibInfo := ctx.OtherModuleProvider(dep, cc.SharedLibraryInfoProvider).(cc.SharedLibraryInfo)
1230 if sharedLibInfo.SharedLibrary != nil {
1231 // Copy to an intermediate output directory to append "lib[64]" to the path,
1232 // so that it's compatible with the default rpath values.
1233 var relPath string
1234 if sharedLibInfo.Target.Arch.ArchType.Multilib == "lib64" {
1235 relPath = filepath.Join("lib64", sharedLibInfo.SharedLibrary.Base())
1236 } else {
1237 relPath = filepath.Join("lib", sharedLibInfo.SharedLibrary.Base())
1238 }
1239 relocatedLib := android.PathForModuleOut(ctx, "relocated").Join(ctx, relPath)
1240 ctx.Build(pctx, android.BuildParams{
1241 Rule: android.Cp,
1242 Input: sharedLibInfo.SharedLibrary,
1243 Output: relocatedLib,
1244 })
1245 j.data = append(j.data, relocatedLib)
1246 } else {
1247 ctx.PropertyErrorf("jni_libs", "%q of type %q is not supported", dep.Name(), ctx.OtherModuleType(dep))
1248 }
1249 })
1250
Colin Cross303e21f2018-08-07 16:49:25 -07001251 j.Library.GenerateAndroidBuildActions(ctx)
Colin Cross05638fc2018-04-09 18:40:24 -07001252}
1253
Paul Duffin42df1442019-03-20 12:45:53 +00001254func (j *TestHelperLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1255 j.Library.GenerateAndroidBuildActions(ctx)
1256}
1257
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001258func (j *JavaTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Cole Faust21680542022-12-07 18:18:37 -08001259 j.testConfig = tradefed.AutoGenTestConfig(ctx, tradefed.AutoGenTestConfigOptions{
1260 TestConfigProp: j.prebuiltTestProperties.Test_config,
1261 TestSuites: j.prebuiltTestProperties.Test_suites,
1262 DeviceTemplate: "${JavaTestConfigTemplate}",
1263 HostTemplate: "${JavaHostTestConfigTemplate}",
1264 HostUnitTestTemplate: "${JavaHostUnitTestConfigTemplate}",
1265 })
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001266
1267 j.Import.GenerateAndroidBuildActions(ctx)
1268}
1269
1270type testSdkMemberType struct {
1271 android.SdkMemberTypeBase
1272}
1273
Paul Duffin296701e2021-07-14 10:29:36 +01001274func (mt *testSdkMemberType) AddDependencies(ctx android.SdkDependencyContext, dependencyTag blueprint.DependencyTag, names []string) {
1275 ctx.AddVariationDependencies(nil, dependencyTag, names...)
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001276}
1277
1278func (mt *testSdkMemberType) IsInstance(module android.Module) bool {
1279 _, ok := module.(*Test)
1280 return ok
1281}
1282
Paul Duffin3a4eb502020-03-19 16:11:18 +00001283func (mt *testSdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
1284 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_test_import")
Paul Duffin14eb4672020-03-02 11:33:02 +00001285}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001286
Paul Duffin14eb4672020-03-02 11:33:02 +00001287func (mt *testSdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
1288 return &testSdkMemberProperties{}
1289}
1290
1291type testSdkMemberProperties struct {
1292 android.SdkMemberPropertiesBase
1293
Paul Duffina551a1c2020-03-17 21:04:24 +00001294 JarToExport android.Path
1295 TestConfig android.Path
Paul Duffin14eb4672020-03-02 11:33:02 +00001296}
1297
Paul Duffin3a4eb502020-03-19 16:11:18 +00001298func (p *testSdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffin14eb4672020-03-02 11:33:02 +00001299 test := variant.(*Test)
1300
1301 implementationJars := test.ImplementationJars()
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001302 if len(implementationJars) != 1 {
Paul Duffin14eb4672020-03-02 11:33:02 +00001303 panic(fmt.Errorf("there must be only one implementation jar from %q", test.Name()))
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001304 }
1305
Paul Duffina551a1c2020-03-17 21:04:24 +00001306 p.JarToExport = implementationJars[0]
1307 p.TestConfig = test.testConfig
Paul Duffin14eb4672020-03-02 11:33:02 +00001308}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001309
Paul Duffin3a4eb502020-03-19 16:11:18 +00001310func (p *testSdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffina551a1c2020-03-17 21:04:24 +00001311 builder := ctx.SnapshotBuilder()
Paul Duffin3a4eb502020-03-19 16:11:18 +00001312
Paul Duffina551a1c2020-03-17 21:04:24 +00001313 exportedJar := p.JarToExport
1314 if exportedJar != nil {
Paul Duffin13648912022-07-15 13:12:35 +00001315 snapshotRelativeJavaLibPath := sdkSnapshotFilePathForJar(ctx, p.OsPrefix(), ctx.Name())
Paul Duffina551a1c2020-03-17 21:04:24 +00001316 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
Paul Duffin14eb4672020-03-02 11:33:02 +00001317
1318 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
Paul Duffina551a1c2020-03-17 21:04:24 +00001319 }
1320
1321 testConfig := p.TestConfig
1322 if testConfig != nil {
1323 snapshotRelativeTestConfigPath := sdkSnapshotFilePathForMember(p.OsPrefix(), ctx.Name(), testConfigSuffix)
1324 builder.CopyToSnapshot(testConfig, snapshotRelativeTestConfigPath)
Paul Duffin14eb4672020-03-02 11:33:02 +00001325 propertySet.AddProperty("test_config", snapshotRelativeTestConfigPath)
1326 }
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001327}
1328
Colin Cross1b16b0e2019-02-12 14:41:32 -08001329// java_test builds a and links sources into a `.jar` file for the device, and possibly for the host as well, and
1330// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
1331//
1332// By default, a java_test has a single variant that produces a `.jar` file containing `classes.dex` files that were
1333// compiled against the device bootclasspath.
1334//
1335// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
1336// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07001337func TestFactory() android.Module {
1338 module := &Test{}
1339
Colin Crossce6734e2020-06-15 16:09:53 -07001340 module.addHostAndDeviceProperties()
1341 module.AddProperties(&module.testProperties)
Colin Cross05638fc2018-04-09 18:40:24 -07001342
Colin Cross9ae1b922018-06-26 17:59:05 -07001343 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse3026872019-01-05 22:30:13 -08001344 module.Module.dexpreopter.isTest = true
Cole Faustd57e8b22022-08-11 11:59:04 -07001345 module.Module.linter.properties.Lint.Test = proptools.BoolPtr(true)
Colin Cross9ae1b922018-06-26 17:59:05 -07001346
Colin Cross05638fc2018-04-09 18:40:24 -07001347 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07001348 return module
1349}
1350
Paul Duffin42df1442019-03-20 12:45:53 +00001351// java_test_helper_library creates a java library and makes sure that it is added to the appropriate test suite.
1352func TestHelperLibraryFactory() android.Module {
1353 module := &TestHelperLibrary{}
1354
Colin Crossce6734e2020-06-15 16:09:53 -07001355 module.addHostAndDeviceProperties()
1356 module.AddProperties(&module.testHelperLibraryProperties)
Paul Duffin42df1442019-03-20 12:45:53 +00001357
Colin Cross9a4abed2019-04-24 13:19:28 -07001358 module.Module.properties.Installable = proptools.BoolPtr(true)
1359 module.Module.dexpreopter.isTest = true
Cole Faustd57e8b22022-08-11 11:59:04 -07001360 module.Module.linter.properties.Lint.Test = proptools.BoolPtr(true)
Colin Cross9a4abed2019-04-24 13:19:28 -07001361
Paul Duffin42df1442019-03-20 12:45:53 +00001362 InitJavaModule(module, android.HostAndDeviceSupported)
1363 return module
1364}
1365
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001366// java_test_import imports one or more `.jar` files into the build graph as if they were built by a java_test module
1367// and makes sure that it is added to the appropriate test suite.
1368//
1369// By default, a java_test_import has a single variant that expects a `.jar` file containing `.class` files that were
1370// compiled against an Android classpath.
1371//
1372// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
1373// for host modules.
1374func JavaTestImportFactory() android.Module {
1375 module := &JavaTestImport{}
1376
1377 module.AddProperties(
1378 &module.Import.properties,
1379 &module.prebuiltTestProperties)
1380
1381 module.Import.properties.Installable = proptools.BoolPtr(true)
1382
1383 android.InitPrebuiltModule(module, &module.properties.Jars)
1384 android.InitApexModule(module)
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001385 InitJavaModule(module, android.HostAndDeviceSupported)
1386 return module
1387}
1388
Colin Cross1b16b0e2019-02-12 14:41:32 -08001389// java_test_host builds a and links sources into a `.jar` file for the host, and creates an `AndroidTest.xml` file to
1390// allow running the test with `atest` or a `TEST_MAPPING` file.
1391//
1392// A java_test_host has a single variant that produces a `.jar` file containing `.class` files that were
1393// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07001394func TestHostFactory() android.Module {
Liz Kammerdd849a82020-06-12 16:38:45 -07001395 module := &TestHost{}
Colin Cross05638fc2018-04-09 18:40:24 -07001396
Colin Crossce6734e2020-06-15 16:09:53 -07001397 module.addHostProperties()
1398 module.AddProperties(&module.testProperties)
Liz Kammerdd849a82020-06-12 16:38:45 -07001399 module.AddProperties(&module.testHostProperties)
Colin Cross05638fc2018-04-09 18:40:24 -07001400
Yuexi Ma627263f2021-03-04 13:47:56 -08001401 InitTestHost(
1402 module,
1403 proptools.BoolPtr(true),
1404 nil,
1405 nil)
Colin Cross9ae1b922018-06-26 17:59:05 -07001406
Liz Kammerdd849a82020-06-12 16:38:45 -07001407 InitJavaModuleMultiTargets(module, android.HostSupported)
Julien Desprezb2166612021-03-05 18:08:36 +00001408
Colin Cross05638fc2018-04-09 18:40:24 -07001409 return module
1410}
1411
Yuexi Ma627263f2021-03-04 13:47:56 -08001412func InitTestHost(th *TestHost, installable *bool, testSuites []string, autoGenConfig *bool) {
1413 th.properties.Installable = installable
1414 th.testProperties.Auto_gen_config = autoGenConfig
1415 th.testProperties.Test_suites = testSuites
1416}
1417
Colin Cross05638fc2018-04-09 18:40:24 -07001418//
Colin Cross2fe66872015-03-30 17:20:39 -07001419// Java Binaries (.jar file plus wrapper script)
1420//
1421
Colin Crossf506d872017-07-19 15:53:04 -07001422type binaryProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -07001423 // installable script to execute the resulting jar
Dan Willemsen8e6b3712021-09-20 23:11:24 -07001424 Wrapper *string `android:"path,arch_variant"`
Colin Cross094054a2018-10-17 15:10:48 -07001425
1426 // Name of the class containing main to be inserted into the manifest as Main-Class.
1427 Main_class *string
Colin Cross89226d92020-10-09 19:00:54 -07001428
1429 // Names of modules containing JNI libraries that should be installed alongside the host
1430 // variant of the binary.
Dan Willemsen8e6b3712021-09-20 23:11:24 -07001431 Jni_libs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -07001432}
1433
Colin Crossf506d872017-07-19 15:53:04 -07001434type Binary struct {
1435 Library
Colin Cross2fe66872015-03-30 17:20:39 -07001436
Colin Crossf506d872017-07-19 15:53:04 -07001437 binaryProperties binaryProperties
Colin Cross10a03492017-08-10 17:09:43 -07001438
Colin Cross6b4a32d2017-12-05 13:42:45 -08001439 isWrapperVariant bool
1440
Colin Crossc3315992017-12-08 19:12:36 -08001441 wrapperFile android.Path
Colin Cross70dda7e2019-10-01 22:05:35 -07001442 binaryFile android.InstallPath
Colin Cross2fe66872015-03-30 17:20:39 -07001443}
1444
Alex Light24237172017-10-26 09:46:21 -07001445func (j *Binary) HostToolPath() android.OptionalPath {
1446 return android.OptionalPathForPath(j.binaryFile)
1447}
1448
Colin Crossf506d872017-07-19 15:53:04 -07001449func (j *Binary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08001450 if ctx.Arch().ArchType == android.Common {
1451 // Compile the jar
Colin Cross094054a2018-10-17 15:10:48 -07001452 if j.binaryProperties.Main_class != nil {
1453 if j.properties.Manifest != nil {
1454 ctx.PropertyErrorf("main_class", "main_class cannot be used when manifest is set")
1455 }
1456 manifestFile := android.PathForModuleOut(ctx, "manifest.txt")
1457 GenerateMainClassManifest(ctx, manifestFile, String(j.binaryProperties.Main_class))
1458 j.overrideManifest = android.OptionalPathForPath(manifestFile)
1459 }
1460
Colin Cross6b4a32d2017-12-05 13:42:45 -08001461 j.Library.GenerateAndroidBuildActions(ctx)
Nan Zhang3c807db2017-11-03 14:53:31 -07001462 } else {
Colin Cross6b4a32d2017-12-05 13:42:45 -08001463 // Handle the binary wrapper
1464 j.isWrapperVariant = true
1465
Colin Cross366938f2017-12-11 16:29:02 -08001466 if j.binaryProperties.Wrapper != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001467 j.wrapperFile = android.PathForModuleSrc(ctx, *j.binaryProperties.Wrapper)
Colin Cross6b4a32d2017-12-05 13:42:45 -08001468 } else {
Dan Willemsen8e6b3712021-09-20 23:11:24 -07001469 if ctx.Windows() {
1470 ctx.PropertyErrorf("wrapper", "wrapper is required for Windows")
1471 }
1472
Zi Wangca65b402022-10-10 13:45:06 -07001473 if ctx.Device() {
1474 // device binary should have a main_class property if it does not
1475 // have a specific wrapper, so that a default wrapper can
1476 // be generated for it.
1477 if j.binaryProperties.Main_class == nil {
1478 ctx.PropertyErrorf("main_class", "main_class property "+
1479 "is required for device binary if no default wrapper is assigned")
1480 } else {
1481 wrapper := android.PathForModuleOut(ctx, ctx.ModuleName()+".sh")
1482 jarName := j.Stem() + ".jar"
1483 partition := j.PartitionTag(ctx.DeviceConfig())
1484 ctx.Build(pctx, android.BuildParams{
1485 Rule: deviceBinaryWrapper,
1486 Output: wrapper,
1487 Args: map[string]string{
1488 "jar_name": jarName,
1489 "partition": partition,
1490 "main_class": String(j.binaryProperties.Main_class),
1491 },
1492 })
1493 j.wrapperFile = wrapper
1494 }
1495 } else {
1496 j.wrapperFile = android.PathForSource(ctx, "build/soong/scripts/jar-wrapper.sh")
1497 }
Colin Cross6b4a32d2017-12-05 13:42:45 -08001498 }
1499
Dan Willemsen8e6b3712021-09-20 23:11:24 -07001500 ext := ""
1501 if ctx.Windows() {
1502 ext = ".bat"
1503 }
1504
Colin Crossc179ea62020-10-09 10:54:15 -07001505 // The host installation rules make the installed wrapper depend on all the dependencies
Colin Cross89226d92020-10-09 19:00:54 -07001506 // of the wrapper variant, which will include the common variant's jar file and any JNI
1507 // libraries. This is verified by TestBinary.
Colin Cross6b4a32d2017-12-05 13:42:45 -08001508 j.binaryFile = ctx.InstallExecutable(android.PathForModuleInstall(ctx, "bin"),
Dan Willemsen8e6b3712021-09-20 23:11:24 -07001509 ctx.ModuleName()+ext, j.wrapperFile)
1510 }
Colin Cross2fe66872015-03-30 17:20:39 -07001511}
1512
Colin Crossf506d872017-07-19 15:53:04 -07001513func (j *Binary) DepsMutator(ctx android.BottomUpMutatorContext) {
Liz Kammer3bf97bd2022-04-26 09:38:20 -04001514 if ctx.Arch().ArchType == android.Common {
Colin Cross6b4a32d2017-12-05 13:42:45 -08001515 j.deps(ctx)
Liz Kammer356f7d42021-01-26 09:18:53 -05001516 }
Liz Kammer3bf97bd2022-04-26 09:38:20 -04001517 if ctx.Arch().ArchType != android.Common {
Colin Crosse9fe2942020-11-10 18:12:15 -08001518 // These dependencies ensure the host installation rules will install the jar file and
1519 // the jni libraries when the wrapper is installed.
1520 ctx.AddVariationDependencies(nil, jniInstallTag, j.binaryProperties.Jni_libs...)
1521 ctx.AddVariationDependencies(
1522 []blueprint.Variation{{Mutator: "arch", Variation: android.CommonArch.String()}},
1523 binaryInstallTag, ctx.ModuleName())
Colin Cross6b4a32d2017-12-05 13:42:45 -08001524 }
Colin Cross46c9b8b2017-06-22 16:51:17 -07001525}
1526
Colin Cross1b16b0e2019-02-12 14:41:32 -08001527// java_binary builds a `.jar` file and a shell script that executes it for the device, and possibly for the host
1528// as well.
1529//
1530// By default, a java_binary has a single variant that produces a `.jar` file containing `classes.dex` files that were
1531// compiled against the device bootclasspath.
1532//
1533// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
1534// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07001535func BinaryFactory() android.Module {
1536 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07001537
Colin Crossce6734e2020-06-15 16:09:53 -07001538 module.addHostAndDeviceProperties()
1539 module.AddProperties(&module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07001540
Colin Cross9ae1b922018-06-26 17:59:05 -07001541 module.Module.properties.Installable = proptools.BoolPtr(true)
1542
Colin Cross6b4a32d2017-12-05 13:42:45 -08001543 android.InitAndroidArchModule(module, android.HostAndDeviceSupported, android.MultilibCommonFirst)
1544 android.InitDefaultableModule(module)
Wei Libafb6d62021-12-10 03:14:59 -08001545 android.InitBazelModule(module)
1546
Colin Cross36242852017-06-23 15:06:31 -07001547 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001548}
1549
Colin Cross1b16b0e2019-02-12 14:41:32 -08001550// java_binary_host builds a `.jar` file and a shell script that executes it for the host.
1551//
1552// A java_binary_host has a single variant that produces a `.jar` file containing `.class` files that were
1553// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07001554func BinaryHostFactory() android.Module {
1555 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07001556
Colin Crossce6734e2020-06-15 16:09:53 -07001557 module.addHostProperties()
1558 module.AddProperties(&module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07001559
Colin Cross9ae1b922018-06-26 17:59:05 -07001560 module.Module.properties.Installable = proptools.BoolPtr(true)
1561
Colin Cross6b4a32d2017-12-05 13:42:45 -08001562 android.InitAndroidArchModule(module, android.HostSupported, android.MultilibCommonFirst)
1563 android.InitDefaultableModule(module)
Wei Libafb6d62021-12-10 03:14:59 -08001564 android.InitBazelModule(module)
Colin Cross36242852017-06-23 15:06:31 -07001565 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001566}
1567
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001568type JavaApiContribution struct {
1569 android.ModuleBase
1570 android.DefaultableModuleBase
1571
1572 properties struct {
1573 // name of the API surface
1574 Api_surface *string
1575
1576 // relative path to the API signature text file
1577 Api_file *string `android:"path"`
1578 }
1579}
1580
1581func ApiContributionFactory() android.Module {
1582 module := &JavaApiContribution{}
1583 android.InitAndroidModule(module)
1584 android.InitDefaultableModule(module)
1585 module.AddProperties(&module.properties)
1586 return module
1587}
1588
1589type JavaApiImportInfo struct {
1590 ApiFile android.Path
1591}
1592
1593var JavaApiImportProvider = blueprint.NewProvider(JavaApiImportInfo{})
1594
1595func (ap *JavaApiContribution) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Jihoon Kang3198f3c2023-01-26 08:08:52 +00001596 var apiFile android.Path = nil
1597 if apiFileString := ap.properties.Api_file; apiFileString != nil {
1598 apiFile = android.PathForModuleSrc(ctx, String(apiFileString))
1599 }
1600
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001601 ctx.SetProvider(JavaApiImportProvider, JavaApiImportInfo{
1602 ApiFile: apiFile,
1603 })
1604}
1605
1606type ApiLibrary struct {
1607 android.ModuleBase
1608 android.DefaultableModuleBase
1609
1610 properties JavaApiLibraryProperties
1611
1612 stubsSrcJar android.WritablePath
1613 stubsJar android.WritablePath
1614}
1615
1616type JavaApiLibraryProperties struct {
1617 // name of the API surface
1618 Api_surface *string
1619
Jihoon Kang60d4a092022-11-17 23:47:43 +00001620 // list of Java API contribution modules that consists this API surface
Spandan Dasc082eb82022-12-01 21:43:06 +00001621 // This is a list of Soong modules
Jihoon Kang60d4a092022-11-17 23:47:43 +00001622 Api_contributions []string
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001623
Spandan Dasc082eb82022-12-01 21:43:06 +00001624 // list of api.txt files relative to this directory that contribute to the
1625 // API surface.
1626 // This is a list of relative paths
1627 Api_files []string
1628
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001629 // List of flags to be passed to the javac compiler to generate jar file
1630 Javacflags []string
Jihoon Kang362aa9d2023-01-20 19:44:07 +00001631
1632 // List of shared java libs that this module has dependencies to and
1633 // should be passed as classpath in javac invocation
1634 Libs []string
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001635}
1636
1637func ApiLibraryFactory() android.Module {
1638 module := &ApiLibrary{}
1639 android.InitAndroidArchModule(module, android.DeviceSupported, android.MultilibCommon)
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001640 module.AddProperties(&module.properties)
Jihoon Kang1c51f502023-01-09 23:42:40 +00001641 android.InitDefaultableModule(module)
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001642 return module
1643}
1644
1645func (al *ApiLibrary) ApiSurface() *string {
1646 return al.properties.Api_surface
1647}
1648
1649func (al *ApiLibrary) StubsJar() android.Path {
1650 return al.stubsJar
1651}
1652
1653func metalavaStubCmd(ctx android.ModuleContext, rule *android.RuleBuilder,
1654 srcs android.Paths, homeDir android.WritablePath) *android.RuleBuilderCommand {
1655 rule.Command().Text("rm -rf").Flag(homeDir.String())
1656 rule.Command().Text("mkdir -p").Flag(homeDir.String())
1657
1658 cmd := rule.Command()
1659 cmd.FlagWithArg("ANDROID_PREFS_ROOT=", homeDir.String())
1660
1661 if metalavaUseRbe(ctx) {
1662 rule.Remoteable(android.RemoteRuleSupports{RBE: true})
1663 execStrategy := ctx.Config().GetenvWithDefault("RBE_METALAVA_EXEC_STRATEGY", remoteexec.LocalExecStrategy)
1664 labels := map[string]string{"type": "tool", "name": "metalava"}
1665
1666 pool := ctx.Config().GetenvWithDefault("RBE_METALAVA_POOL", "java16")
1667 rule.Rewrapper(&remoteexec.REParams{
1668 Labels: labels,
1669 ExecStrategy: execStrategy,
1670 ToolchainInputs: []string{config.JavaCmd(ctx).String()},
1671 Platform: map[string]string{remoteexec.PoolKey: pool},
1672 })
1673 }
1674
1675 cmd.BuiltTool("metalava").ImplicitTool(ctx.Config().HostJavaToolPath(ctx, "metalava.jar")).
1676 Flag(config.JavacVmFlags).
1677 Flag("-J--add-opens=java.base/java.util=ALL-UNNAMED").
1678 FlagWithArg("-encoding ", "UTF-8").
1679 FlagWithInputList("--source-files ", srcs, " ")
1680
1681 cmd.Flag("--no-banner").
1682 Flag("--color").
1683 Flag("--quiet").
1684 Flag("--format=v2").
1685 FlagWithArg("--repeat-errors-max ", "10").
1686 FlagWithArg("--hide ", "UnresolvedImport").
1687 FlagWithArg("--hide ", "InvalidNullabilityOverride").
1688 FlagWithArg("--hide ", "ChangedDefault")
1689
1690 return cmd
1691}
1692
1693func (al *ApiLibrary) stubsFlags(ctx android.ModuleContext, cmd *android.RuleBuilderCommand, stubsDir android.OptionalPath) {
1694 if stubsDir.Valid() {
1695 cmd.FlagWithArg("--stubs ", stubsDir.String())
1696 }
1697}
1698
Jihoon Kang60d4a092022-11-17 23:47:43 +00001699var javaApiContributionTag = dependencyTag{name: "java-api-contribution"}
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001700
1701func (al *ApiLibrary) DepsMutator(ctx android.BottomUpMutatorContext) {
Jihoon Kang60d4a092022-11-17 23:47:43 +00001702 apiContributions := al.properties.Api_contributions
1703 for _, apiContributionName := range apiContributions {
1704 ctx.AddDependency(ctx.Module(), javaApiContributionTag, apiContributionName)
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001705 }
Jihoon Kang362aa9d2023-01-20 19:44:07 +00001706 ctx.AddVariationDependencies(nil, libTag, al.properties.Libs...)
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001707}
1708
1709func (al *ApiLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1710
1711 rule := android.NewRuleBuilder(pctx, ctx)
1712
1713 rule.Sbox(android.PathForModuleOut(ctx, "metalava"),
1714 android.PathForModuleOut(ctx, "metalava.sbox.textproto")).
1715 SandboxInputs()
1716
1717 var stubsDir android.OptionalPath
1718 stubsDir = android.OptionalPathForPath(android.PathForModuleOut(ctx, "metalava", "stubsDir"))
1719 rule.Command().Text("rm -rf").Text(stubsDir.String())
1720 rule.Command().Text("mkdir -p").Text(stubsDir.String())
1721
1722 homeDir := android.PathForModuleOut(ctx, "metalava", "home")
1723
Jihoon Kang362aa9d2023-01-20 19:44:07 +00001724 var srcFiles android.Paths
1725 var classPaths android.Paths
1726 ctx.VisitDirectDeps(func(dep android.Module) {
1727 tag := ctx.OtherModuleDependencyTag(dep)
1728 switch tag {
1729 case javaApiContributionTag:
1730 provider := ctx.OtherModuleProvider(dep, JavaApiImportProvider).(JavaApiImportInfo)
Jihoon Kang3198f3c2023-01-26 08:08:52 +00001731 providerApiFile := provider.ApiFile
1732 if providerApiFile == nil {
1733 ctx.ModuleErrorf("Error: %s has an empty api file.", dep.Name())
1734 }
1735 srcFiles = append(srcFiles, android.PathForSource(ctx, providerApiFile.String()))
Jihoon Kang362aa9d2023-01-20 19:44:07 +00001736 case libTag:
1737 provider := ctx.OtherModuleProvider(dep, JavaInfoProvider).(JavaInfo)
1738 classPaths = append(classPaths, provider.HeaderJars...)
1739 }
Jihoon Kang60d4a092022-11-17 23:47:43 +00001740 })
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001741
Spandan Dasc082eb82022-12-01 21:43:06 +00001742 // Add the api_files inputs
1743 for _, api := range al.properties.Api_files {
1744 // Use MaybeExistentPathForSource since the api file might not exist during analysis.
1745 // This will be provided by the orchestrator in the combined execution.
1746 srcFiles = append(srcFiles, android.MaybeExistentPathForSource(ctx, ctx.ModuleDir(), api))
1747 }
1748
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001749 cmd := metalavaStubCmd(ctx, rule, srcFiles, homeDir)
1750
1751 al.stubsFlags(ctx, cmd, stubsDir)
1752
1753 al.stubsSrcJar = android.PathForModuleOut(ctx, "metalava", ctx.ModuleName()+"-"+"stubs.srcjar")
1754 rule.Command().
1755 BuiltTool("soong_zip").
1756 Flag("-write_if_changed").
1757 Flag("-jar").
1758 FlagWithOutput("-o ", al.stubsSrcJar).
1759 FlagWithArg("-C ", stubsDir.String()).
1760 FlagWithArg("-D ", stubsDir.String())
1761
1762 rule.Build("metalava", "metalava merged")
1763
1764 al.stubsJar = android.PathForModuleOut(ctx, ctx.ModuleName(), "android.jar")
1765
1766 var flags javaBuilderFlags
Jihoon Kangff878bf2022-12-22 21:26:06 +00001767 flags.javaVersion = getStubsJavaVersion()
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001768 flags.javacFlags = strings.Join(al.properties.Javacflags, " ")
Jihoon Kang362aa9d2023-01-20 19:44:07 +00001769 flags.classpath = classpath(classPaths)
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001770
1771 TransformJavaToClasses(ctx, al.stubsJar, 0, android.Paths{},
1772 android.Paths{al.stubsSrcJar}, flags, android.Paths{})
Jihoon Kang423d2292022-11-29 23:10:10 +00001773
1774 ctx.Phony(ctx.ModuleName(), al.stubsJar)
Jihoon Kang362aa9d2023-01-20 19:44:07 +00001775
1776 ctx.SetProvider(JavaInfoProvider, JavaInfo{
1777 HeaderJars: android.PathsIfNonNil(al.stubsJar),
1778 })
Jihoon Kang0ac87c22022-11-15 19:06:14 +00001779}
1780
Colin Cross2fe66872015-03-30 17:20:39 -07001781//
1782// Java prebuilts
1783//
1784
Colin Cross74d73e22017-08-02 11:05:49 -07001785type ImportProperties struct {
Paul Duffina04c1072020-03-02 10:16:35 +00001786 Jars []string `android:"path,arch_variant"`
Colin Cross461bd1a2017-10-20 13:59:18 -07001787
Jaewoong Jung56e12db2021-04-02 00:38:25 +00001788 // The version of the SDK that the source prebuilt file was built against. Defaults to the
1789 // current version if not specified.
Nan Zhangea568a42017-11-08 21:20:04 -08001790 Sdk_version *string
Colin Cross535e2cf2017-10-20 17:57:49 -07001791
Jaewoong Jung56e12db2021-04-02 00:38:25 +00001792 // The minimum version of the SDK that this module supports. Defaults to sdk_version if not
1793 // specified.
1794 Min_sdk_version *string
1795
William Loh5a082f92022-05-17 20:21:50 +00001796 // The max sdk version placeholder used to replace maxSdkVersion attributes on permission
1797 // and uses-permission tags in manifest_fixer.
1798 Replace_max_sdk_version_placeholder *string
1799
Colin Cross535e2cf2017-10-20 17:57:49 -07001800 Installable *bool
Jiyong Park1be96912018-05-28 18:02:19 +09001801
Paul Duffin869de142021-07-15 14:14:41 +01001802 // If not empty, classes are restricted to the specified packages and their sub-packages.
Paul Duffin869de142021-07-15 14:14:41 +01001803 Permitted_packages []string
1804
Jiyong Park1be96912018-05-28 18:02:19 +09001805 // List of shared java libs that this module has dependencies to
1806 Libs []string
Colin Cross37f6d792018-07-12 12:28:41 -07001807
1808 // List of files to remove from the jar file(s)
1809 Exclude_files []string
1810
1811 // List of directories to remove from the jar file(s)
1812 Exclude_dirs []string
Nan Zhang4c819fb2018-08-27 18:31:46 -07001813
1814 // if set to true, run Jetifier against .jar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -07001815 Jetifier *bool
Jiyong Park4c4c0242019-10-21 14:53:15 +09001816
1817 // set the name of the output
1818 Stem *string
Jiyong Park19604de2020-03-24 16:44:11 +09001819
1820 Aidl struct {
1821 // directories that should be added as include directories for any aidl sources of modules
1822 // that depend on this module, as well as to aidl for this module.
1823 Export_include_dirs []string
1824 }
Colin Cross74d73e22017-08-02 11:05:49 -07001825}
1826
1827type Import struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001828 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -07001829 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09001830 android.ApexModuleBase
Romain Jobredeaux428a3662022-01-28 11:12:52 -05001831 android.BazelModuleBase
Colin Crossec7a0422017-07-07 14:47:12 -07001832 prebuilt android.Prebuilt
Colin Cross2fe66872015-03-30 17:20:39 -07001833
Paul Duffin0d3c2e12020-05-17 08:34:50 +01001834 // Functionality common to Module and Import.
1835 embeddableInModuleAndImport
1836
Liz Kammerd6c31d22020-08-05 15:40:41 -07001837 hiddenAPI
1838 dexer
Bill Peckhamff89ffa2020-12-23 16:13:04 -08001839 dexpreopter
Liz Kammerd6c31d22020-08-05 15:40:41 -07001840
Colin Cross74d73e22017-08-02 11:05:49 -07001841 properties ImportProperties
1842
Liz Kammerd6c31d22020-08-05 15:40:41 -07001843 // output file containing classes.dex and resources
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001844 dexJarFile OptionalDexJarPath
Jeongik Chad5fe8782021-07-08 01:13:11 +09001845 dexJarInstallFile android.Path
Liz Kammerd6c31d22020-08-05 15:40:41 -07001846
Colin Cross0a6e0072017-08-30 14:24:55 -07001847 combinedClasspathFile android.Path
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01001848 classLoaderContexts dexpreopt.ClassLoaderContextMap
Jiyong Park19604de2020-03-24 16:44:11 +09001849 exportAidlIncludeDirs android.Paths
Colin Cross56a83212020-09-15 18:30:11 -07001850
1851 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +09001852
1853 sdkVersion android.SdkSpec
1854 minSdkVersion android.SdkSpec
Colin Cross2fe66872015-03-30 17:20:39 -07001855}
1856
Paul Duffin630b11e2021-07-15 13:35:26 +01001857var _ PermittedPackagesForUpdatableBootJars = (*Import)(nil)
1858
1859func (j *Import) PermittedPackagesForUpdatableBootJars() []string {
1860 return j.properties.Permitted_packages
1861}
1862
Jiyong Park92315372021-04-02 08:45:46 +09001863func (j *Import) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
1864 return android.SdkSpecFrom(ctx, String(j.properties.Sdk_version))
Liz Kammer2d2fd852020-08-12 14:42:30 -07001865}
1866
Jiyong Parkf1691d22021-03-29 20:11:58 +09001867func (j *Import) SystemModules() string {
Liz Kammerd6c31d22020-08-05 15:40:41 -07001868 return "none"
1869}
1870
Jiyong Park92315372021-04-02 08:45:46 +09001871func (j *Import) MinSdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
Jaewoong Jung56e12db2021-04-02 00:38:25 +00001872 if j.properties.Min_sdk_version != nil {
Jiyong Park92315372021-04-02 08:45:46 +09001873 return android.SdkSpecFrom(ctx, *j.properties.Min_sdk_version)
Jaewoong Jung56e12db2021-04-02 00:38:25 +00001874 }
Jiyong Park92315372021-04-02 08:45:46 +09001875 return j.SdkVersion(ctx)
Colin Cross83bb3162018-06-25 15:48:06 -07001876}
1877
William Loh5a082f92022-05-17 20:21:50 +00001878func (j *Import) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.SdkSpec {
1879 if j.properties.Replace_max_sdk_version_placeholder != nil {
1880 return android.SdkSpecFrom(ctx, *j.properties.Replace_max_sdk_version_placeholder)
1881 }
1882 return android.SdkSpecFrom(ctx, "")
1883}
1884
Jiyong Park92315372021-04-02 08:45:46 +09001885func (j *Import) TargetSdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
1886 return j.SdkVersion(ctx)
Artur Satayev480e25b2020-04-27 18:53:18 +01001887}
1888
Colin Cross74d73e22017-08-02 11:05:49 -07001889func (j *Import) Prebuilt() *android.Prebuilt {
Colin Crossec7a0422017-07-07 14:47:12 -07001890 return &j.prebuilt
1891}
1892
Colin Cross74d73e22017-08-02 11:05:49 -07001893func (j *Import) PrebuiltSrcs() []string {
1894 return j.properties.Jars
1895}
1896
1897func (j *Import) Name() string {
Colin Cross5ea9bcc2017-07-27 15:41:32 -07001898 return j.prebuilt.Name(j.ModuleBase.Name())
1899}
1900
Jiyong Park0b238752019-10-29 11:23:10 +09001901func (j *Import) Stem() string {
1902 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
1903}
1904
Jiyong Park618922e2020-01-08 13:35:43 +09001905func (a *Import) JacocoReportClassesFile() android.Path {
1906 return nil
1907}
1908
Bill Peckhama41a6962021-01-11 10:58:54 -08001909func (j *Import) LintDepSets() LintDepSets {
1910 return LintDepSets{}
1911}
1912
Jaewoong Jung476b9d62021-05-10 15:30:00 -07001913func (j *Import) getStrictUpdatabilityLinting() bool {
1914 return false
1915}
1916
1917func (j *Import) setStrictUpdatabilityLinting(bool) {
1918}
1919
Colin Cross74d73e22017-08-02 11:05:49 -07001920func (j *Import) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross42d48b72018-08-29 14:10:52 -07001921 ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Liz Kammerd6c31d22020-08-05 15:40:41 -07001922
1923 if ctx.Device() && Bool(j.dexProperties.Compile_dex) {
Jiyong Parkf1691d22021-03-29 20:11:58 +09001924 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Liz Kammerd6c31d22020-08-05 15:40:41 -07001925 }
Colin Cross1e676be2016-10-12 14:38:15 -07001926}
1927
Sam Delmerico277795c2022-02-25 17:04:37 +00001928func (j *Import) commonBuildActions(ctx android.ModuleContext) {
Paul Duffin7ed6ff82022-11-21 10:57:30 +00001929 //TODO(b/231322772) these should come from Bazel once available
Jiyong Park92315372021-04-02 08:45:46 +09001930 j.sdkVersion = j.SdkVersion(ctx)
1931 j.minSdkVersion = j.MinSdkVersion(ctx)
1932
Colin Cross56a83212020-09-15 18:30:11 -07001933 if !ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform() {
1934 j.hideApexVariantFromMake = true
1935 }
1936
Dan Willemsen8e6b3712021-09-20 23:11:24 -07001937 if ctx.Windows() {
1938 j.HideFromMake()
1939 }
Sam Delmerico277795c2022-02-25 17:04:37 +00001940}
1941
1942func (j *Import) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1943 j.commonBuildActions(ctx)
Dan Willemsen8e6b3712021-09-20 23:11:24 -07001944
Colin Cross8a497952019-03-05 22:25:09 -08001945 jars := android.PathsForModuleSrc(ctx, j.properties.Jars)
Colin Crosse1d62a82015-04-03 16:53:05 -07001946
Jiyong Park0b238752019-10-29 11:23:10 +09001947 jarName := j.Stem() + ".jar"
Nan Zhang4c819fb2018-08-27 18:31:46 -07001948 outputFile := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001949 TransformJarsToJar(ctx, outputFile, "for prebuilts", jars, android.OptionalPath{},
1950 false, j.properties.Exclude_files, j.properties.Exclude_dirs)
Colin Cross1001a792019-03-21 22:21:39 -07001951 if Bool(j.properties.Jetifier) {
Nan Zhang4c819fb2018-08-27 18:31:46 -07001952 inputFile := outputFile
1953 outputFile = android.PathForModuleOut(ctx, "jetifier", jarName)
1954 TransformJetifier(ctx, outputFile, inputFile)
1955 }
Colin Crosse9a275b2017-10-16 17:09:48 -07001956 j.combinedClasspathFile = outputFile
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01001957 j.classLoaderContexts = make(dexpreopt.ClassLoaderContextMap)
Paul Duffin859fe962020-05-15 10:20:31 +01001958
Liz Kammerd6c31d22020-08-05 15:40:41 -07001959 var flags javaBuilderFlags
1960
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001961 j.collectTransitiveHeaderJars(ctx)
Jiyong Park1be96912018-05-28 18:02:19 +09001962 ctx.VisitDirectDeps(func(module android.Module) {
Jiyong Park1be96912018-05-28 18:02:19 +09001963 tag := ctx.OtherModuleDependencyTag(module)
Colin Crossdcf71b22021-02-01 13:59:03 -08001964 if ctx.OtherModuleHasProvider(module, JavaInfoProvider) {
1965 dep := ctx.OtherModuleProvider(module, JavaInfoProvider).(JavaInfo)
Jiyong Park1be96912018-05-28 18:02:19 +09001966 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04001967 case libTag, sdkLibTag:
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001968 flags.classpath = append(flags.classpath, dep.HeaderJars...)
1969 flags.dexClasspath = append(flags.dexClasspath, dep.HeaderJars...)
1970 case staticLibTag:
Colin Crossdcf71b22021-02-01 13:59:03 -08001971 flags.classpath = append(flags.classpath, dep.HeaderJars...)
Liz Kammerd6c31d22020-08-05 15:40:41 -07001972 case bootClasspathTag:
Colin Crossdcf71b22021-02-01 13:59:03 -08001973 flags.bootClasspath = append(flags.bootClasspath, dep.HeaderJars...)
Jiyong Park1be96912018-05-28 18:02:19 +09001974 }
Colin Crossdcf71b22021-02-01 13:59:03 -08001975 } else if dep, ok := module.(SdkLibraryDependency); ok {
Jiyong Park1be96912018-05-28 18:02:19 +09001976 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04001977 case libTag, sdkLibTag:
Jiyong Park92315372021-04-02 08:45:46 +09001978 flags.classpath = append(flags.classpath, dep.SdkHeaderJars(ctx, j.SdkVersion(ctx))...)
Jiyong Park1be96912018-05-28 18:02:19 +09001979 }
1980 }
Ulya Trafimovich65b03192020-12-03 16:50:22 +00001981
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00001982 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiyong Park1be96912018-05-28 18:02:19 +09001983 })
1984
Sam Delmerico277795c2022-02-25 17:04:37 +00001985 j.maybeInstall(ctx, jarName, outputFile)
Jiyong Park19604de2020-03-24 16:44:11 +09001986
1987 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.properties.Aidl.Export_include_dirs)
Liz Kammerd6c31d22020-08-05 15:40:41 -07001988
Paul Duffin064b70c2020-11-02 17:32:38 +00001989 if ctx.Device() {
1990 // If this is a variant created for a prebuilt_apex then use the dex implementation jar
1991 // obtained from the associated deapexer module.
1992 ai := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1993 if ai.ForPrebuiltApex {
Paul Duffin064b70c2020-11-02 17:32:38 +00001994 // Get the path of the dex implementation jar from the `deapexer` module.
Martin Stjernholm44825602021-09-17 01:44:12 +01001995 di := android.FindDeapexerProviderForModule(ctx)
1996 if di == nil {
1997 return // An error has been reported by FindDeapexerProviderForModule.
1998 }
Paul Duffinb4bbf2c2021-06-17 15:59:07 +01001999 if dexOutputPath := di.PrebuiltExportPath(apexRootRelativePathToJavaLib(j.BaseModuleName())); dexOutputPath != nil {
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01002000 dexJarFile := makeDexJarPathFromPath(dexOutputPath)
2001 j.dexJarFile = dexJarFile
Jiakai Zhang5b24f722021-09-30 09:32:57 +00002002 installPath := android.PathForModuleInPartitionInstall(ctx, "apex", ai.ApexVariationName, apexRootRelativePathToJavaLib(j.BaseModuleName()))
2003 j.dexJarInstallFile = installPath
Paul Duffin74d18d12021-05-14 14:18:47 +01002004
Jiakai Zhang5b24f722021-09-30 09:32:57 +00002005 j.dexpreopter.installPath = j.dexpreopter.getInstallPath(ctx, installPath)
Jiakai Zhang22450f22021-10-11 03:05:20 +00002006 setUncompressDex(ctx, &j.dexpreopter, &j.dexer)
Jiakai Zhang5b24f722021-09-30 09:32:57 +00002007 j.dexpreopter.uncompressedDex = *j.dexProperties.Uncompress_dex
2008 j.dexpreopt(ctx, dexOutputPath)
Jiakai Zhang22450f22021-10-11 03:05:20 +00002009
2010 // Initialize the hiddenapi structure.
2011 j.initHiddenAPI(ctx, dexJarFile, outputFile, j.dexProperties.Uncompress_dex)
Paul Duffin9d67ca62021-02-03 20:06:33 +00002012 } else {
Paul Duffin064b70c2020-11-02 17:32:38 +00002013 // This should never happen as a variant for a prebuilt_apex is only created if the
2014 // prebuilt_apex has been configured to export the java library dex file.
Martin Stjernholm44825602021-09-17 01:44:12 +01002015 ctx.ModuleErrorf("internal error: no dex implementation jar available from prebuilt APEX %s", di.ApexModuleName())
Paul Duffin064b70c2020-11-02 17:32:38 +00002016 }
2017 } else if Bool(j.dexProperties.Compile_dex) {
Jiyong Parkf1691d22021-03-29 20:11:58 +09002018 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
Paul Duffin064b70c2020-11-02 17:32:38 +00002019 if sdkDep.invalidVersion {
2020 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2021 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2022 } else if sdkDep.useFiles {
2023 // sdkDep.jar is actually equivalent to turbine header.jar.
2024 flags.classpath = append(flags.classpath, sdkDep.jars...)
2025 }
2026
2027 // Dex compilation
2028
Jiakai Zhang519c5c82021-09-16 06:15:39 +00002029 j.dexpreopter.installPath = j.dexpreopter.getInstallPath(
2030 ctx, android.PathForModuleInstall(ctx, "framework", jarName))
Jiakai Zhang22450f22021-10-11 03:05:20 +00002031 setUncompressDex(ctx, &j.dexpreopter, &j.dexer)
Paul Duffin064b70c2020-11-02 17:32:38 +00002032 j.dexpreopter.uncompressedDex = *j.dexProperties.Uncompress_dex
2033
Paul Duffin612e6102021-02-02 13:38:13 +00002034 var dexOutputFile android.OutputPath
Spandan Das7eb92432023-01-04 22:14:59 +00002035 dexOutputFile = j.dexer.compileDex(ctx, flags, j.MinSdkVersion(ctx), outputFile, jarName)
Paul Duffin064b70c2020-11-02 17:32:38 +00002036 if ctx.Failed() {
2037 return
2038 }
2039
Paul Duffin74d18d12021-05-14 14:18:47 +01002040 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01002041 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), outputFile, j.dexProperties.Uncompress_dex)
Paul Duffinafaa47c2021-05-14 13:04:04 +01002042
2043 // Encode hidden API flags in dex file.
Paul Duffin1bbd0622021-05-14 15:52:25 +01002044 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
Paul Duffin064b70c2020-11-02 17:32:38 +00002045
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01002046 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jeongik Chad5fe8782021-07-08 01:13:11 +09002047 j.dexJarInstallFile = android.PathForModuleInstall(ctx, "framework", jarName)
Liz Kammerd6c31d22020-08-05 15:40:41 -07002048 }
Liz Kammerd6c31d22020-08-05 15:40:41 -07002049 }
Colin Crossdcf71b22021-02-01 13:59:03 -08002050
2051 ctx.SetProvider(JavaInfoProvider, JavaInfo{
2052 HeaderJars: android.PathsIfNonNil(j.combinedClasspathFile),
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002053 TransitiveLibsHeaderJars: j.transitiveLibsHeaderJars,
2054 TransitiveStaticLibsHeaderJars: j.transitiveStaticLibsHeaderJars,
Colin Crossdcf71b22021-02-01 13:59:03 -08002055 ImplementationAndResourcesJars: android.PathsIfNonNil(j.combinedClasspathFile),
2056 ImplementationJars: android.PathsIfNonNil(j.combinedClasspathFile),
2057 AidlIncludeDirs: j.exportAidlIncludeDirs,
2058 })
Colin Cross2fe66872015-03-30 17:20:39 -07002059}
2060
Sam Delmerico277795c2022-02-25 17:04:37 +00002061func (j *Import) maybeInstall(ctx android.ModuleContext, jarName string, outputFile android.Path) {
2062 if !Bool(j.properties.Installable) {
2063 return
2064 }
2065
2066 var installDir android.InstallPath
2067 if ctx.InstallInTestcases() {
2068 var archDir string
2069 if !ctx.Host() {
2070 archDir = ctx.DeviceConfig().DeviceArch()
2071 }
2072 installDir = android.PathForModuleInstall(ctx, ctx.ModuleName(), archDir)
2073 } else {
2074 installDir = android.PathForModuleInstall(ctx, "framework")
2075 }
2076 ctx.InstallFile(installDir, jarName, outputFile)
2077}
2078
Paul Duffinaa55f742020-10-06 17:20:13 +01002079func (j *Import) OutputFiles(tag string) (android.Paths, error) {
2080 switch tag {
Saeid Farivar Asanjan128fe5c2020-10-15 17:54:40 +00002081 case "", ".jar":
Paul Duffinaa55f742020-10-06 17:20:13 +01002082 return android.Paths{j.combinedClasspathFile}, nil
2083 default:
2084 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
2085 }
2086}
2087
2088var _ android.OutputFileProducer = (*Import)(nil)
2089
Nan Zhanged19fc32017-10-19 13:06:22 -07002090func (j *Import) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002091 if j.combinedClasspathFile == nil {
2092 return nil
2093 }
Colin Cross37f6d792018-07-12 12:28:41 -07002094 return android.Paths{j.combinedClasspathFile}
Nan Zhanged19fc32017-10-19 13:06:22 -07002095}
2096
Colin Cross331a1212018-08-15 20:40:52 -07002097func (j *Import) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002098 if j.combinedClasspathFile == nil {
2099 return nil
2100 }
Colin Cross331a1212018-08-15 20:40:52 -07002101 return android.Paths{j.combinedClasspathFile}
2102}
2103
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01002104func (j *Import) DexJarBuildPath() OptionalDexJarPath {
Liz Kammerd6c31d22020-08-05 15:40:41 -07002105 return j.dexJarFile
Colin Crossf24a22a2019-01-31 14:12:44 -08002106}
2107
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01002108func (j *Import) DexJarInstallPath() android.Path {
Jeongik Chad5fe8782021-07-08 01:13:11 +09002109 return j.dexJarInstallFile
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01002110}
2111
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01002112func (j *Import) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2113 return j.classLoaderContexts
Jiyong Park1be96912018-05-28 18:02:19 +09002114}
2115
Jiyong Park45bf82e2020-12-15 22:29:02 +09002116var _ android.ApexModule = (*Import)(nil)
2117
2118// Implements android.ApexModule
Jiyong Park0f80c182020-01-31 02:49:53 +09002119func (j *Import) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Paul Duffin0d3c2e12020-05-17 08:34:50 +01002120 return j.depIsInSameApex(ctx, dep)
Jiyong Park0f80c182020-01-31 02:49:53 +09002121}
2122
Jiyong Park45bf82e2020-12-15 22:29:02 +09002123// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07002124func (j *Import) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
2125 sdkVersion android.ApiLevel) error {
Jiyong Park92315372021-04-02 08:45:46 +09002126 sdkSpec := j.MinSdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002127 if !sdkSpec.Specified() {
Jaewoong Jung56e12db2021-04-02 00:38:25 +00002128 return fmt.Errorf("min_sdk_version is not specified")
2129 }
Jiyong Parkf1691d22021-03-29 20:11:58 +09002130 if sdkSpec.Kind == android.SdkCore {
Jaewoong Jung56e12db2021-04-02 00:38:25 +00002131 return nil
2132 }
Jooyung Han4c4da062021-06-23 10:23:16 +09002133 if sdkSpec.ApiLevel.GreaterThan(sdkVersion) {
2134 return fmt.Errorf("newer SDK(%v)", sdkSpec.ApiLevel)
Jaewoong Jung56e12db2021-04-02 00:38:25 +00002135 }
Jooyung Han749dc692020-04-15 11:03:39 +09002136 return nil
2137}
2138
Paul Duffinfef55002021-06-17 14:56:05 +01002139// requiredFilesFromPrebuiltApexForImport returns information about the files that a java_import or
2140// java_sdk_library_import with the specified base module name requires to be exported from a
2141// prebuilt_apex/apex_set.
Paul Duffinb4bbf2c2021-06-17 15:59:07 +01002142func requiredFilesFromPrebuiltApexForImport(name string) []string {
2143 // Add the dex implementation jar to the set of exported files.
2144 return []string{
2145 apexRootRelativePathToJavaLib(name),
Paul Duffinfef55002021-06-17 14:56:05 +01002146 }
2147}
2148
Paul Duffinb4bbf2c2021-06-17 15:59:07 +01002149// apexRootRelativePathToJavaLib returns the path, relative to the root of the apex's contents, for
2150// the java library with the specified name.
2151func apexRootRelativePathToJavaLib(name string) string {
2152 return filepath.Join("javalib", name+".jar")
2153}
2154
Paul Duffinfef55002021-06-17 14:56:05 +01002155var _ android.RequiredFilesFromPrebuiltApex = (*Import)(nil)
2156
Paul Duffinb4bbf2c2021-06-17 15:59:07 +01002157func (j *Import) RequiredFilesFromPrebuiltApex(_ android.BaseModuleContext) []string {
Paul Duffinfef55002021-06-17 14:56:05 +01002158 name := j.BaseModuleName()
2159 return requiredFilesFromPrebuiltApexForImport(name)
2160}
2161
albaltai36ff7dc2018-12-25 14:35:23 +08002162// Add compile time check for interface implementation
2163var _ android.IDEInfo = (*Import)(nil)
2164var _ android.IDECustomizedModuleName = (*Import)(nil)
2165
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002166// Collect information for opening IDE project files in java/jdeps.go.
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002167
2168func (j *Import) IDEInfo(dpInfo *android.IdeInfo) {
2169 dpInfo.Jars = append(dpInfo.Jars, j.PrebuiltSrcs()...)
2170}
2171
2172func (j *Import) IDECustomizedModuleName() string {
2173 // TODO(b/113562217): Extract the base module name from the Import name, often the Import name
2174 // has a prefix "prebuilt_". Remove the prefix explicitly if needed until we find a better
2175 // solution to get the Import name.
Ulya Trafimovich497a0932021-07-14 16:35:33 +01002176 return android.RemoveOptionalPrebuiltPrefix(j.Name())
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002177}
2178
Colin Cross74d73e22017-08-02 11:05:49 -07002179var _ android.PrebuiltInterface = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07002180
Bill Peckhamff89ffa2020-12-23 16:13:04 -08002181func (j *Import) IsInstallable() bool {
2182 return Bool(j.properties.Installable)
2183}
2184
Jiakai Zhang519c5c82021-09-16 06:15:39 +00002185var _ DexpreopterInterface = (*Import)(nil)
Bill Peckhamff89ffa2020-12-23 16:13:04 -08002186
Colin Cross1b16b0e2019-02-12 14:41:32 -08002187// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library module.
2188//
2189// By default, a java_import has a single variant that expects a `.jar` file containing `.class` files that were
2190// compiled against an Android classpath.
2191//
2192// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
2193// for host modules.
Colin Cross74d73e22017-08-02 11:05:49 -07002194func ImportFactory() android.Module {
2195 module := &Import{}
Colin Cross36242852017-06-23 15:06:31 -07002196
Liz Kammerd6c31d22020-08-05 15:40:41 -07002197 module.AddProperties(
2198 &module.properties,
2199 &module.dexer.dexProperties,
2200 )
Colin Cross74d73e22017-08-02 11:05:49 -07002201
Paul Duffin71b33cc2021-06-23 11:39:47 +01002202 module.initModuleAndImport(module)
Paul Duffin859fe962020-05-15 10:20:31 +01002203
Liz Kammerd6c31d22020-08-05 15:40:41 -07002204 module.dexProperties.Optimize.EnabledByDefault = false
2205
Colin Cross74d73e22017-08-02 11:05:49 -07002206 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002207 android.InitApexModule(module)
Romain Jobredeaux428a3662022-01-28 11:12:52 -05002208 android.InitBazelModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002209 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross36242852017-06-23 15:06:31 -07002210 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002211}
2212
Colin Cross1b16b0e2019-02-12 14:41:32 -08002213// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library_host
2214// module.
2215//
2216// A java_import_host has a single variant that expects a `.jar` file containing `.class` files that were
2217// compiled against a host bootclasspath.
Colin Cross74d73e22017-08-02 11:05:49 -07002218func ImportFactoryHost() android.Module {
2219 module := &Import{}
2220
2221 module.AddProperties(&module.properties)
2222
2223 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002224 android.InitApexModule(module)
Sam Delmerico5f83b492022-02-28 18:50:56 +00002225 android.InitBazelModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002226 InitJavaModule(module, android.HostSupported)
Colin Cross74d73e22017-08-02 11:05:49 -07002227 return module
2228}
2229
Colin Cross42be7612019-02-21 18:12:14 -08002230// dex_import module
2231
2232type DexImportProperties struct {
Colin Cross5cfc70d2019-07-15 13:36:55 -07002233 Jars []string `android:"path"`
Jiyong Park4c4c0242019-10-21 14:53:15 +09002234
2235 // set the name of the output
2236 Stem *string
Colin Cross42be7612019-02-21 18:12:14 -08002237}
2238
2239type DexImport struct {
2240 android.ModuleBase
2241 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002242 android.ApexModuleBase
Colin Cross42be7612019-02-21 18:12:14 -08002243 prebuilt android.Prebuilt
2244
2245 properties DexImportProperties
2246
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01002247 dexJarFile OptionalDexJarPath
Colin Cross42be7612019-02-21 18:12:14 -08002248
2249 dexpreopter
Colin Cross56a83212020-09-15 18:30:11 -07002250
2251 hideApexVariantFromMake bool
Colin Cross42be7612019-02-21 18:12:14 -08002252}
2253
2254func (j *DexImport) Prebuilt() *android.Prebuilt {
2255 return &j.prebuilt
2256}
2257
2258func (j *DexImport) PrebuiltSrcs() []string {
2259 return j.properties.Jars
2260}
2261
2262func (j *DexImport) Name() string {
2263 return j.prebuilt.Name(j.ModuleBase.Name())
2264}
2265
Jiyong Park0b238752019-10-29 11:23:10 +09002266func (j *DexImport) Stem() string {
2267 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
2268}
2269
Jiyong Park77acec62020-06-01 21:39:15 +09002270func (a *DexImport) JacocoReportClassesFile() android.Path {
2271 return nil
2272}
2273
Colin Cross08dca382020-07-21 20:31:17 -07002274func (a *DexImport) LintDepSets() LintDepSets {
2275 return LintDepSets{}
2276}
2277
Martin Stjernholm6d415272020-01-31 17:10:36 +00002278func (j *DexImport) IsInstallable() bool {
2279 return true
2280}
2281
Jaewoong Jung476b9d62021-05-10 15:30:00 -07002282func (j *DexImport) getStrictUpdatabilityLinting() bool {
2283 return false
2284}
2285
2286func (j *DexImport) setStrictUpdatabilityLinting(bool) {
2287}
2288
Colin Cross42be7612019-02-21 18:12:14 -08002289func (j *DexImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2290 if len(j.properties.Jars) != 1 {
2291 ctx.PropertyErrorf("jars", "exactly one jar must be provided")
2292 }
2293
Colin Cross56a83212020-09-15 18:30:11 -07002294 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2295 if !apexInfo.IsForPlatform() {
2296 j.hideApexVariantFromMake = true
2297 }
2298
Jiakai Zhang519c5c82021-09-16 06:15:39 +00002299 j.dexpreopter.installPath = j.dexpreopter.getInstallPath(
2300 ctx, android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar"))
Colin Cross42be7612019-02-21 18:12:14 -08002301 j.dexpreopter.uncompressedDex = shouldUncompressDex(ctx, &j.dexpreopter)
2302
2303 inputJar := ctx.ExpandSource(j.properties.Jars[0], "jars")
2304 dexOutputFile := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar")
2305
2306 if j.dexpreopter.uncompressedDex {
Colin Crossf1a035e2020-11-16 17:32:30 -08002307 rule := android.NewRuleBuilder(pctx, ctx)
Colin Cross42be7612019-02-21 18:12:14 -08002308
2309 temporary := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar.unaligned")
2310 rule.Temporary(temporary)
2311
2312 // use zip2zip to uncompress classes*.dex files
2313 rule.Command().
Colin Crossf1a035e2020-11-16 17:32:30 -08002314 BuiltTool("zip2zip").
Colin Cross42be7612019-02-21 18:12:14 -08002315 FlagWithInput("-i ", inputJar).
2316 FlagWithOutput("-o ", temporary).
2317 FlagWithArg("-0 ", "'classes*.dex'")
2318
2319 // use zipalign to align uncompressed classes*.dex files
2320 rule.Command().
Colin Crossf1a035e2020-11-16 17:32:30 -08002321 BuiltTool("zipalign").
Colin Cross42be7612019-02-21 18:12:14 -08002322 Flag("-f").
2323 Text("4").
2324 Input(temporary).
2325 Output(dexOutputFile)
2326
2327 rule.DeleteTemporaryFiles()
2328
Colin Crossf1a035e2020-11-16 17:32:30 -08002329 rule.Build("uncompress_dex", "uncompress dex")
Colin Cross42be7612019-02-21 18:12:14 -08002330 } else {
2331 ctx.Build(pctx, android.BuildParams{
2332 Rule: android.Cp,
2333 Input: inputJar,
2334 Output: dexOutputFile,
2335 })
2336 }
2337
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01002338 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Colin Cross42be7612019-02-21 18:12:14 -08002339
Jaewoong Jung4b97a562020-12-17 09:43:28 -08002340 j.dexpreopt(ctx, dexOutputFile)
Colin Cross42be7612019-02-21 18:12:14 -08002341
Colin Cross56a83212020-09-15 18:30:11 -07002342 if apexInfo.IsForPlatform() {
Jiyong Park01bca752020-06-08 19:24:09 +09002343 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
2344 j.Stem()+".jar", dexOutputFile)
2345 }
Colin Cross42be7612019-02-21 18:12:14 -08002346}
2347
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01002348func (j *DexImport) DexJarBuildPath() OptionalDexJarPath {
Colin Cross42be7612019-02-21 18:12:14 -08002349 return j.dexJarFile
2350}
2351
Jiyong Park45bf82e2020-12-15 22:29:02 +09002352var _ android.ApexModule = (*DexImport)(nil)
2353
2354// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07002355func (j *DexImport) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
2356 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09002357 // we don't check prebuilt modules for sdk_version
2358 return nil
2359}
2360
Colin Cross42be7612019-02-21 18:12:14 -08002361// dex_import imports a `.jar` file containing classes.dex files.
2362//
2363// A dex_import module cannot be used as a dependency of a java_* or android_* module, it can only be installed
2364// to the device.
2365func DexImportFactory() android.Module {
2366 module := &DexImport{}
2367
2368 module.AddProperties(&module.properties)
2369
2370 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002371 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002372 InitJavaModule(module, android.DeviceSupported)
Colin Cross42be7612019-02-21 18:12:14 -08002373 return module
2374}
2375
Colin Cross89536d42017-07-07 14:35:50 -07002376// Defaults
Colin Cross89536d42017-07-07 14:35:50 -07002377type Defaults struct {
2378 android.ModuleBase
2379 android.DefaultsModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002380 android.ApexModuleBase
Colin Cross89536d42017-07-07 14:35:50 -07002381}
2382
Colin Cross1b16b0e2019-02-12 14:41:32 -08002383// java_defaults provides a set of properties that can be inherited by other java or android modules.
2384//
2385// A module can use the properties from a java_defaults module using `defaults: ["defaults_module_name"]`. Each
2386// property in the defaults module that exists in the depending module will be prepended to the depending module's
2387// value for that property.
2388//
2389// Example:
2390//
Sam Delmerico277795c2022-02-25 17:04:37 +00002391// java_defaults {
2392// name: "example_defaults",
2393// srcs: ["common/**/*.java"],
2394// javacflags: ["-Xlint:all"],
2395// aaptflags: ["--auto-add-overlay"],
2396// }
Colin Cross1b16b0e2019-02-12 14:41:32 -08002397//
Sam Delmerico277795c2022-02-25 17:04:37 +00002398// java_library {
2399// name: "example",
2400// defaults: ["example_defaults"],
2401// srcs: ["example/**/*.java"],
2402// }
Colin Cross1b16b0e2019-02-12 14:41:32 -08002403//
2404// is functionally identical to:
2405//
Sam Delmerico277795c2022-02-25 17:04:37 +00002406// java_library {
2407// name: "example",
2408// srcs: [
2409// "common/**/*.java",
2410// "example/**/*.java",
2411// ],
2412// javacflags: ["-Xlint:all"],
2413// }
Paul Duffin47357662019-12-05 14:07:14 +00002414func DefaultsFactory() android.Module {
Colin Cross89536d42017-07-07 14:35:50 -07002415 module := &Defaults{}
2416
Colin Cross89536d42017-07-07 14:35:50 -07002417 module.AddProperties(
Jaewoong Jungbc15e3a2021-03-10 17:02:43 -08002418 &CommonProperties{},
2419 &DeviceProperties{},
Jooyung Han01d80d82022-01-08 12:16:32 +09002420 &OverridableDeviceProperties{},
Liz Kammera7a64f32020-07-09 15:16:41 -07002421 &DexProperties{},
Colin Cross43f08db2018-11-12 10:13:39 -08002422 &DexpreoptProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08002423 &android.ProtoProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002424 &aaptProperties{},
2425 &androidLibraryProperties{},
2426 &appProperties{},
2427 &appTestProperties{},
Jaewoong Jung525443a2019-02-28 15:35:54 -08002428 &overridableAppProperties{},
Roland Levillainb5b0ff32020-02-04 15:45:49 +00002429 &testProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002430 &ImportProperties{},
2431 &AARImportProperties{},
2432 &sdkLibraryProperties{},
Paul Duffin1b1e8062020-05-08 13:44:43 +01002433 &commonToSdkLibraryAndImportProperties{},
Colin Cross42be7612019-02-21 18:12:14 -08002434 &DexImportProperties{},
Jooyung Han18020ea2019-11-13 10:50:48 +09002435 &android.ApexProperties{},
Jaewoong Jungbf135462020-04-26 15:10:51 -07002436 &RuntimeResourceOverlayProperties{},
Colin Cross014489c2020-06-02 20:09:13 -07002437 &LintProperties{},
Colin Crosscbce0b02021-02-09 10:38:30 -08002438 &appTestHelperAppProperties{},
Jihoon Kang1c51f502023-01-09 23:42:40 +00002439 &JavaApiLibraryProperties{},
Colin Cross89536d42017-07-07 14:35:50 -07002440 )
2441
2442 android.InitDefaultsModule(module)
Colin Cross89536d42017-07-07 14:35:50 -07002443 return module
2444}
Nan Zhangea568a42017-11-08 21:20:04 -08002445
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002446func kytheExtractJavaFactory() android.Singleton {
2447 return &kytheExtractJavaSingleton{}
2448}
2449
2450type kytheExtractJavaSingleton struct {
2451}
2452
2453func (ks *kytheExtractJavaSingleton) GenerateBuildActions(ctx android.SingletonContext) {
2454 var xrefTargets android.Paths
2455 ctx.VisitAllModules(func(module android.Module) {
2456 if javaModule, ok := module.(xref); ok {
2457 xrefTargets = append(xrefTargets, javaModule.XrefJavaFiles()...)
2458 }
2459 })
2460 // TODO(asmundak): perhaps emit a rule to output a warning if there were no xrefTargets
2461 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07002462 ctx.Phony("xref_java", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002463 }
2464}
2465
Nan Zhangea568a42017-11-08 21:20:04 -08002466var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07002467var BoolDefault = proptools.BoolDefault
Nan Zhangea568a42017-11-08 21:20:04 -08002468var String = proptools.String
Colin Cross0d0ba592018-02-20 13:33:42 -08002469var inList = android.InList
Ulya Trafimovich65b03192020-12-03 16:50:22 +00002470
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00002471// Add class loader context (CLC) of a given dependency to the current CLC.
2472func addCLCFromDep(ctx android.ModuleContext, depModule android.Module,
2473 clcMap dexpreopt.ClassLoaderContextMap) {
2474
2475 dep, ok := depModule.(UsesLibraryDependency)
2476 if !ok {
2477 return
2478 }
2479
Ulya Trafimovich840efb62021-07-15 14:34:40 +01002480 depName := android.RemoveOptionalPrebuiltPrefix(ctx.OtherModuleName(depModule))
2481
2482 var sdkLib *string
2483 if lib, ok := depModule.(SdkLibraryDependency); ok && lib.sharedLibrary() {
2484 // A shared SDK library. This should be added as a top-level CLC element.
2485 sdkLib = &depName
2486 } else if ulib, ok := depModule.(ProvidesUsesLib); ok {
2487 // A non-SDK library disguised as an SDK library by the means of `provides_uses_lib`
2488 // property. This should be handled in the same way as a shared SDK library.
2489 sdkLib = ulib.ProvidesUsesLib()
Ulya Trafimovich65b03192020-12-03 16:50:22 +00002490 }
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00002491
2492 depTag := ctx.OtherModuleDependencyTag(depModule)
Liz Kammeref28a4c2022-09-23 16:50:56 -04002493 if IsLibDepTag(depTag) {
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00002494 // Ok, propagate <uses-library> through non-static library dependencies.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +01002495 } else if tag, ok := depTag.(usesLibraryDependencyTag); ok && tag.sdkVersion == dexpreopt.AnySdkVersion {
2496 // Ok, propagate <uses-library> through non-compatibility <uses-library> dependencies.
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00002497 } else if depTag == staticLibTag {
2498 // Propagate <uses-library> through static library dependencies, unless it is a component
2499 // library (such as stubs). Component libraries have a dependency on their SDK library,
2500 // which should not be pulled just because of a static component library.
Ulya Trafimovich840efb62021-07-15 14:34:40 +01002501 if sdkLib != nil {
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00002502 return
2503 }
2504 } else {
2505 // Don't propagate <uses-library> for other dependency tags.
2506 return
2507 }
2508
Ulya Trafimovich840efb62021-07-15 14:34:40 +01002509 // If this is an SDK (or SDK-like) library, then it should be added as a node in the CLC tree,
2510 // and its CLC should be added as subtree of that node. Otherwise the library is not a
2511 // <uses_library> and should not be added to CLC, but the transitive <uses-library> dependencies
2512 // from its CLC should be added to the current CLC.
2513 if sdkLib != nil {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +01002514 clcMap.AddContext(ctx, dexpreopt.AnySdkVersion, *sdkLib, false,
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01002515 dep.DexJarBuildPath().PathOrNil(), dep.DexJarInstallPath(), dep.ClassLoaderContexts())
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00002516 } else {
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00002517 clcMap.AddContextMap(dep.ClassLoaderContexts(), depName)
2518 }
Ulya Trafimovich65b03192020-12-03 16:50:22 +00002519}
Wei Libafb6d62021-12-10 03:14:59 -08002520
Sam Delmerico79985812022-03-23 20:20:42 +00002521type javaResourcesAttributes struct {
2522 Resources bazel.LabelListAttribute
2523 Resource_strip_prefix *string
2524}
2525
2526func (m *Library) convertJavaResourcesAttributes(ctx android.TopDownMutatorContext) *javaResourcesAttributes {
2527 var resources bazel.LabelList
2528 var resourceStripPrefix *string
2529
2530 if m.properties.Java_resources != nil {
2531 resources.Append(android.BazelLabelForModuleSrc(ctx, m.properties.Java_resources))
2532 }
2533
Paul Duffin7ed6ff82022-11-21 10:57:30 +00002534 //TODO(b/179889880) handle case where glob includes files outside package
Sam Delmerico79985812022-03-23 20:20:42 +00002535 resDeps := ResourceDirsToFiles(
2536 ctx,
2537 m.properties.Java_resource_dirs,
2538 m.properties.Exclude_java_resource_dirs,
2539 m.properties.Exclude_java_resources,
2540 )
2541
2542 for i, resDep := range resDeps {
2543 dir, files := resDep.dir, resDep.files
2544
2545 resources.Append(bazel.MakeLabelList(android.RootToModuleRelativePaths(ctx, files)))
2546
2547 // Bazel includes the relative path from the WORKSPACE root when placing the resource
2548 // inside the JAR file, so we need to remove that prefix
2549 resourceStripPrefix = proptools.StringPtr(dir.String())
2550 if i > 0 {
2551 // TODO(b/226423379) allow multiple resource prefixes
2552 ctx.ModuleErrorf("bp2build does not support more than one directory in java_resource_dirs (b/226423379)")
2553 }
2554 }
2555
2556 return &javaResourcesAttributes{
2557 Resources: bazel.MakeLabelListAttribute(resources),
2558 Resource_strip_prefix: resourceStripPrefix,
2559 }
2560}
2561
Sam Delmericoc0161432022-02-25 21:34:51 +00002562type javaCommonAttributes struct {
Sam Delmerico79985812022-03-23 20:20:42 +00002563 *javaResourcesAttributes
Alix7c8eaeb2022-11-16 15:44:55 +00002564 Srcs bazel.LabelListAttribute
2565 Plugins bazel.LabelListAttribute
2566 Javacopts bazel.StringListAttribute
2567 Common_srcs bazel.LabelListAttribute
Wei Libafb6d62021-12-10 03:14:59 -08002568}
2569
Sam Delmericoc0161432022-02-25 21:34:51 +00002570type javaDependencyLabels struct {
2571 // Dependencies which DO NOT contribute to the API visible to upstream dependencies.
2572 Deps bazel.LabelListAttribute
2573 // Dependencies which DO contribute to the API visible to upstream dependencies.
2574 StaticDeps bazel.LabelListAttribute
2575}
2576
Sam Delmerico24da73c2022-03-16 20:36:54 +00002577type eventLogTagsAttributes struct {
2578 Srcs bazel.LabelListAttribute
2579}
2580
Sam Delmerico97bd1272022-08-25 14:45:31 -04002581type aidlLibraryAttributes struct {
2582 Srcs bazel.LabelListAttribute
2583}
2584
2585type javaAidlLibraryAttributes struct {
2586 Deps bazel.LabelListAttribute
2587}
2588
Alix8062f4d2022-11-14 21:38:07 +00002589// bp2BuildJavaInfo has information needed for the conversion of java*_modules
2590// that is needed bor Bp2Build conversion but that requires different handling
2591// depending on the module type.
2592type bp2BuildJavaInfo struct {
2593 // separates dependencies into dynamic dependencies and static dependencies.
2594 DepLabels *javaDependencyLabels
2595 hasKotlinSrcs bool
2596}
2597
2598// convertLibraryAttrsBp2Build returns a javaCommonAttributes struct with
2599// converted attributes shared across java_* modules and a bp2BuildJavaInfo struct
2600// which has other non-attribute information needed for bp2build conversion
2601// that needs different handling depending on the module types, and thus needs
2602// to be returned to the calling function.
2603func (m *Library) convertLibraryAttrsBp2Build(ctx android.TopDownMutatorContext) (*javaCommonAttributes, *bp2BuildJavaInfo) {
Sam Delmericoe91d0302022-02-23 15:28:33 +00002604 var srcs bazel.LabelListAttribute
Alix495cc8a2023-01-12 18:20:32 +00002605 var deps bazel.LabelListAttribute
Sam Delmerico97bd1272022-08-25 14:45:31 -04002606 var staticDeps bazel.LabelList
2607
Sam Delmericoe91d0302022-02-23 15:28:33 +00002608 archVariantProps := m.GetArchVariantProperties(ctx, &CommonProperties{})
2609 for axis, configToProps := range archVariantProps {
2610 for config, _props := range configToProps {
2611 if archProps, ok := _props.(*CommonProperties); ok {
2612 archSrcs := android.BazelLabelForModuleSrcExcludes(ctx, archProps.Srcs, archProps.Exclude_srcs)
2613 srcs.SetSelectValue(axis, config, archSrcs)
2614 }
2615 }
2616 }
Sam Delmericoc7681022022-02-04 21:01:20 +00002617
2618 javaSrcPartition := "java"
2619 protoSrcPartition := "proto"
Sam Delmerico24da73c2022-03-16 20:36:54 +00002620 logtagSrcPartition := "logtag"
Sam Delmerico97bd1272022-08-25 14:45:31 -04002621 aidlSrcPartition := "aidl"
Alix8062f4d2022-11-14 21:38:07 +00002622 kotlinPartition := "kotlin"
Sam Delmericoc7681022022-02-04 21:01:20 +00002623 srcPartitions := bazel.PartitionLabelListAttribute(ctx, &srcs, bazel.LabelPartitions{
Sam Delmerico24da73c2022-03-16 20:36:54 +00002624 javaSrcPartition: bazel.LabelPartition{Extensions: []string{".java"}, Keep_remainder: true},
2625 logtagSrcPartition: bazel.LabelPartition{Extensions: []string{".logtags", ".logtag"}},
2626 protoSrcPartition: android.ProtoSrcLabelPartition,
Sam Delmerico97bd1272022-08-25 14:45:31 -04002627 aidlSrcPartition: android.AidlSrcLabelPartition,
Alix8062f4d2022-11-14 21:38:07 +00002628 kotlinPartition: bazel.LabelPartition{Extensions: []string{".kt"}},
Sam Delmericoc7681022022-02-04 21:01:20 +00002629 })
2630
Sam Delmerico24da73c2022-03-16 20:36:54 +00002631 javaSrcs := srcPartitions[javaSrcPartition]
Alix8062f4d2022-11-14 21:38:07 +00002632 kotlinSrcs := srcPartitions[kotlinPartition]
2633 javaSrcs.Append(kotlinSrcs)
Sam Delmerico24da73c2022-03-16 20:36:54 +00002634
Sam Delmerico24da73c2022-03-16 20:36:54 +00002635 if !srcPartitions[logtagSrcPartition].IsEmpty() {
2636 logtagsLibName := m.Name() + "_logtags"
Sam Delmerico24da73c2022-03-16 20:36:54 +00002637 ctx.CreateBazelTargetModule(
2638 bazel.BazelTargetModuleProperties{
2639 Rule_class: "event_log_tags",
Sam Delmerico48af73b2022-04-05 14:03:11 +00002640 Bzl_load_location: "//build/bazel/rules/java:event_log_tags.bzl",
Sam Delmerico24da73c2022-03-16 20:36:54 +00002641 },
2642 android.CommonAttributes{Name: logtagsLibName},
2643 &eventLogTagsAttributes{
2644 Srcs: srcPartitions[logtagSrcPartition],
2645 },
2646 )
Sam Delmerico97bd1272022-08-25 14:45:31 -04002647
2648 logtagsSrcs := bazel.MakeLabelList([]bazel.Label{{Label: ":" + logtagsLibName}})
2649 javaSrcs.Append(bazel.MakeLabelListAttribute(logtagsSrcs))
Sam Delmerico24da73c2022-03-16 20:36:54 +00002650 }
Sam Delmerico97bd1272022-08-25 14:45:31 -04002651
2652 if !srcPartitions[aidlSrcPartition].IsEmpty() {
2653 aidlLibs, aidlSrcs := srcPartitions[aidlSrcPartition].Partition(func(src bazel.Label) bool {
2654 return android.IsConvertedToAidlLibrary(ctx, src.OriginalModuleName)
2655 })
2656
2657 if !aidlSrcs.IsEmpty() {
2658 aidlLibName := m.Name() + "_aidl_library"
2659 ctx.CreateBazelTargetModule(
2660 bazel.BazelTargetModuleProperties{
2661 Rule_class: "aidl_library",
2662 Bzl_load_location: "//build/bazel/rules/aidl:library.bzl",
2663 },
2664 android.CommonAttributes{Name: aidlLibName},
2665 &aidlLibraryAttributes{
2666 Srcs: aidlSrcs,
2667 },
2668 )
2669 aidlLibs.Add(&bazel.LabelAttribute{Value: &bazel.Label{Label: ":" + aidlLibName}})
2670 }
2671
2672 javaAidlLibName := m.Name() + "_java_aidl_library"
2673 ctx.CreateBazelTargetModule(
2674 bazel.BazelTargetModuleProperties{
2675 Rule_class: "java_aidl_library",
2676 Bzl_load_location: "//build/bazel/rules/java:aidl_library.bzl",
2677 },
2678 android.CommonAttributes{Name: javaAidlLibName},
2679 &javaAidlLibraryAttributes{
2680 Deps: aidlLibs,
2681 },
2682 )
2683
2684 staticDeps.Add(&bazel.Label{Label: ":" + javaAidlLibName})
2685 }
Sam Delmerico24da73c2022-03-16 20:36:54 +00002686
Sam Delmerico58614c02022-03-15 21:02:09 +00002687 var javacopts []string
2688 if m.properties.Javacflags != nil {
2689 javacopts = append(javacopts, m.properties.Javacflags...)
2690 }
Vinh Tran3ac6daf2022-04-22 19:09:58 -04002691 if m.properties.Java_version != nil {
2692 javaVersion := normalizeJavaVersion(ctx, *m.properties.Java_version).String()
2693 javacopts = append(javacopts, fmt.Sprintf("-source %s -target %s", javaVersion, javaVersion))
2694 }
2695
Sam Delmerico58614c02022-03-15 21:02:09 +00002696 epEnabled := m.properties.Errorprone.Enabled
Paul Duffin7ed6ff82022-11-21 10:57:30 +00002697 //TODO(b/227504307) add configuration that depends on RUN_ERROR_PRONE environment variable
Sam Delmerico58614c02022-03-15 21:02:09 +00002698 if Bool(epEnabled) {
2699 javacopts = append(javacopts, m.properties.Errorprone.Javacflags...)
2700 }
2701
Sam Delmericoc0161432022-02-25 21:34:51 +00002702 commonAttrs := &javaCommonAttributes{
Sam Delmerico79985812022-03-23 20:20:42 +00002703 Srcs: javaSrcs,
2704 javaResourcesAttributes: m.convertJavaResourcesAttributes(ctx),
Sam Delmerico77267c72022-03-18 14:11:07 +00002705 Plugins: bazel.MakeLabelListAttribute(
2706 android.BazelLabelForModuleDeps(ctx, m.properties.Plugins),
2707 ),
Sam Delmerico58614c02022-03-15 21:02:09 +00002708 Javacopts: bazel.MakeStringListAttribute(javacopts),
Wei Libafb6d62021-12-10 03:14:59 -08002709 }
2710
Alix495cc8a2023-01-12 18:20:32 +00002711 for axis, configToProps := range archVariantProps {
2712 for config, _props := range configToProps {
2713 if archProps, ok := _props.(*CommonProperties); ok {
2714 var libLabels []bazel.Label
2715 for _, d := range archProps.Libs {
2716 neverlinkLabel := android.BazelLabelForModuleDepSingle(ctx, d)
2717 neverlinkLabel.Label = neverlinkLabel.Label + "-neverlink"
2718 libLabels = append(libLabels, neverlinkLabel)
2719 }
2720 deps.SetSelectValue(axis, config, bazel.MakeLabelList(libLabels))
2721 }
Alixb4e09a02022-09-27 15:36:01 +00002722 }
Wei Libafb6d62021-12-10 03:14:59 -08002723 }
Sam Delmericoc0161432022-02-25 21:34:51 +00002724
Sam Delmericofde9fb52022-01-28 20:53:38 +00002725 if m.properties.Static_libs != nil {
Romain Jobredeauxc9b2bba2022-02-15 09:35:07 -05002726 staticDeps.Append(android.BazelLabelForModuleDeps(ctx, android.LastUniqueStrings(android.CopyOf(m.properties.Static_libs))))
Sam Delmericofde9fb52022-01-28 20:53:38 +00002727 }
Sam Delmericoc7681022022-02-04 21:01:20 +00002728
Sam Delmericoc0161432022-02-25 21:34:51 +00002729 protoDepLabel := bp2buildProto(ctx, &m.Module, srcPartitions[protoSrcPartition])
2730 // Soong does not differentiate between a java_library and the Bazel equivalent of
2731 // a java_proto_library + proto_library pair. Instead, in Soong proto sources are
2732 // listed directly in the srcs of a java_library, and the classes produced
2733 // by protoc are included directly in the resulting JAR. Thus upstream dependencies
2734 // that depend on a java_library with proto sources can link directly to the protobuf API,
2735 // and so this should be a static dependency.
2736 staticDeps.Add(protoDepLabel)
Sam Delmericoc7681022022-02-04 21:01:20 +00002737
Sam Delmerico97bd1272022-08-25 14:45:31 -04002738 depLabels := &javaDependencyLabels{}
Alix495cc8a2023-01-12 18:20:32 +00002739 depLabels.Deps = deps
Sam Delmericoc0161432022-02-25 21:34:51 +00002740 depLabels.StaticDeps = bazel.MakeLabelListAttribute(staticDeps)
Sam Delmericofde9fb52022-01-28 20:53:38 +00002741
Alix8062f4d2022-11-14 21:38:07 +00002742 bp2BuildInfo := &bp2BuildJavaInfo{
2743 DepLabels: depLabels,
2744 hasKotlinSrcs: !kotlinSrcs.IsEmpty(),
2745 }
2746
2747 return commonAttrs, bp2BuildInfo
Sam Delmericoc0161432022-02-25 21:34:51 +00002748}
2749
2750type javaLibraryAttributes struct {
2751 *javaCommonAttributes
Alix7c8eaeb2022-11-16 15:44:55 +00002752 Deps bazel.LabelListAttribute
2753 Exports bazel.LabelListAttribute
2754 Neverlink bazel.BoolAttribute
Sam Delmericofde9fb52022-01-28 20:53:38 +00002755}
2756
2757func javaLibraryBp2Build(ctx android.TopDownMutatorContext, m *Library) {
Alix8062f4d2022-11-14 21:38:07 +00002758 commonAttrs, bp2BuildInfo := m.convertLibraryAttrsBp2Build(ctx)
2759 depLabels := bp2BuildInfo.DepLabels
Sam Delmericoc0161432022-02-25 21:34:51 +00002760
2761 deps := depLabels.Deps
2762 if !commonAttrs.Srcs.IsEmpty() {
2763 deps.Append(depLabels.StaticDeps) // we should only append these if there are sources to use them
2764
2765 sdkVersion := m.SdkVersion(ctx)
2766 if sdkVersion.Kind == android.SdkPublic && sdkVersion.ApiLevel == android.FutureApiLevel {
2767 // TODO(b/220869005) remove forced dependency on current public android.jar
2768 deps.Add(bazel.MakeLabelAttribute("//prebuilts/sdk:public_current_android_sdk_java_import"))
2769 }
Sam Delmerico97bd1272022-08-25 14:45:31 -04002770 } else if !deps.IsEmpty() {
Sam Delmericoc0161432022-02-25 21:34:51 +00002771 ctx.ModuleErrorf("Module has direct dependencies but no sources. Bazel will not allow this.")
2772 }
2773
Alix8062f4d2022-11-14 21:38:07 +00002774 var props bazel.BazelTargetModuleProperties
Sam Delmericoc0161432022-02-25 21:34:51 +00002775 attrs := &javaLibraryAttributes{
2776 javaCommonAttributes: commonAttrs,
2777 Deps: deps,
2778 Exports: depLabels.StaticDeps,
2779 }
Alix341484b2022-10-31 19:08:18 +00002780 name := m.Name()
Wei Libafb6d62021-12-10 03:14:59 -08002781
Alix8062f4d2022-11-14 21:38:07 +00002782 if !bp2BuildInfo.hasKotlinSrcs && len(m.properties.Common_srcs) == 0 {
2783 props = bazel.BazelTargetModuleProperties{
2784 Rule_class: "java_library",
2785 Bzl_load_location: "//build/bazel/rules/java:library.bzl",
2786 }
2787 } else {
Alix7c8eaeb2022-11-16 15:44:55 +00002788 attrs.javaCommonAttributes.Common_srcs = bazel.MakeLabelListAttribute(android.BazelLabelForModuleSrc(ctx, m.properties.Common_srcs))
Alix8062f4d2022-11-14 21:38:07 +00002789
2790 props = bazel.BazelTargetModuleProperties{
2791 Rule_class: "kt_jvm_library",
2792 Bzl_load_location: "@rules_kotlin//kotlin:jvm_library.bzl",
2793 }
Wei Libafb6d62021-12-10 03:14:59 -08002794 }
2795
Alix266bbf22022-12-15 06:12:46 +00002796 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: name}, attrs)
2797 neverlinkProp := true
2798 neverLinkAttrs := &javaLibraryAttributes{
2799 Exports: bazel.MakeSingleLabelListAttribute(bazel.Label{Label: ":" + name}),
2800 Neverlink: bazel.BoolAttribute{Value: &neverlinkProp},
2801 }
2802 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: name + "-neverlink"}, neverLinkAttrs)
2803
Wei Libafb6d62021-12-10 03:14:59 -08002804}
2805
2806type javaBinaryHostAttributes struct {
Sam Delmericoc0161432022-02-25 21:34:51 +00002807 *javaCommonAttributes
2808 Deps bazel.LabelListAttribute
2809 Runtime_deps bazel.LabelListAttribute
2810 Main_class string
2811 Jvm_flags bazel.StringListAttribute
Wei Libafb6d62021-12-10 03:14:59 -08002812}
2813
2814// JavaBinaryHostBp2Build is for java_binary_host bp2build.
2815func javaBinaryHostBp2Build(ctx android.TopDownMutatorContext, m *Binary) {
Alix8062f4d2022-11-14 21:38:07 +00002816 commonAttrs, bp2BuildInfo := m.convertLibraryAttrsBp2Build(ctx)
2817 depLabels := bp2BuildInfo.DepLabels
Sam Delmericoc0161432022-02-25 21:34:51 +00002818
2819 deps := depLabels.Deps
2820 deps.Append(depLabels.StaticDeps)
2821 if m.binaryProperties.Jni_libs != nil {
2822 deps.Append(bazel.MakeLabelListAttribute(android.BazelLabelForModuleDeps(ctx, m.binaryProperties.Jni_libs)))
2823 }
2824
2825 var runtimeDeps bazel.LabelListAttribute
2826 if commonAttrs.Srcs.IsEmpty() {
2827 // if there are no sources, then the dependencies can only be used at runtime
2828 runtimeDeps = deps
2829 deps = bazel.LabelListAttribute{}
2830 }
2831
Wei Libafb6d62021-12-10 03:14:59 -08002832 mainClass := ""
2833 if m.binaryProperties.Main_class != nil {
2834 mainClass = *m.binaryProperties.Main_class
2835 }
2836 if m.properties.Manifest != nil {
2837 mainClassInManifest, err := android.GetMainClassInManifest(ctx.Config(), android.PathForModuleSrc(ctx, *m.properties.Manifest).String())
2838 if err != nil {
2839 return
2840 }
2841 mainClass = mainClassInManifest
2842 }
Sam Delmericoc0161432022-02-25 21:34:51 +00002843
Wei Libafb6d62021-12-10 03:14:59 -08002844 // Attribute jvm_flags
Alix7c8eaeb2022-11-16 15:44:55 +00002845 var jvmFlags bazel.StringListAttribute
Wei Libafb6d62021-12-10 03:14:59 -08002846 if m.binaryProperties.Jni_libs != nil {
2847 jniLibPackages := map[string]bool{}
2848 for _, jniLibLabel := range android.BazelLabelForModuleDeps(ctx, m.binaryProperties.Jni_libs).Includes {
2849 jniLibPackage := jniLibLabel.Label
2850 indexOfColon := strings.Index(jniLibLabel.Label, ":")
2851 if indexOfColon > 0 {
2852 // JNI lib from other package
2853 jniLibPackage = jniLibLabel.Label[2:indexOfColon]
2854 } else if indexOfColon == 0 {
2855 // JNI lib in the same package of java_binary
2856 packageOfCurrentModule := m.GetBazelLabel(ctx, m)
2857 jniLibPackage = packageOfCurrentModule[2:strings.Index(packageOfCurrentModule, ":")]
2858 }
2859 if _, inMap := jniLibPackages[jniLibPackage]; !inMap {
2860 jniLibPackages[jniLibPackage] = true
2861 }
2862 }
2863 jniLibPaths := []string{}
2864 for jniLibPackage, _ := range jniLibPackages {
2865 // See cs/f:.*/third_party/bazel/.*java_stub_template.txt for the use of RUNPATH
2866 jniLibPaths = append(jniLibPaths, "$${RUNPATH}"+jniLibPackage)
2867 }
Alix7c8eaeb2022-11-16 15:44:55 +00002868 jvmFlags = bazel.MakeStringListAttribute([]string{"-Djava.library.path=" + strings.Join(jniLibPaths, ":")})
Wei Libafb6d62021-12-10 03:14:59 -08002869 }
2870
2871 props := bazel.BazelTargetModuleProperties{
2872 Rule_class: "java_binary",
2873 }
Alix7c8eaeb2022-11-16 15:44:55 +00002874 attrs := &javaBinaryHostAttributes{
2875 Runtime_deps: runtimeDeps,
2876 Main_class: mainClass,
2877 Jvm_flags: jvmFlags,
2878 }
2879
2880 if !bp2BuildInfo.hasKotlinSrcs && len(m.properties.Common_srcs) == 0 {
2881 attrs.javaCommonAttributes = commonAttrs
2882 attrs.Deps = deps
2883 } else {
2884 ktName := m.Name() + "_kt"
2885 ktProps := bazel.BazelTargetModuleProperties{
2886 Rule_class: "kt_jvm_library",
2887 Bzl_load_location: "@rules_kotlin//kotlin:jvm_library.bzl",
2888 }
2889 ktAttrs := &javaLibraryAttributes{
2890 Deps: deps,
2891 javaCommonAttributes: &javaCommonAttributes{
2892 Srcs: commonAttrs.Srcs,
2893 Plugins: commonAttrs.Plugins,
2894 Javacopts: commonAttrs.Javacopts,
2895 },
2896 }
2897
2898 if len(m.properties.Common_srcs) != 0 {
2899 ktAttrs.javaCommonAttributes.Common_srcs = bazel.MakeLabelListAttribute(android.BazelLabelForModuleSrc(ctx, m.properties.Common_srcs))
2900 }
2901
2902 // kt_jvm_library does not support resource_strip_prefix, if this attribute
2903 // is set, than javaResourcesAttributes needs to be set in the
2904 // javaCommonAttributes of the java_binary target
2905 if commonAttrs.javaResourcesAttributes != nil {
2906 if commonAttrs.javaResourcesAttributes.Resource_strip_prefix != nil {
2907 attrs.javaCommonAttributes = &javaCommonAttributes{
2908 javaResourcesAttributes: commonAttrs.javaResourcesAttributes,
2909 }
2910 } else {
2911 ktAttrs.javaCommonAttributes.javaResourcesAttributes = commonAttrs.javaResourcesAttributes
2912 }
2913 }
2914
2915 ctx.CreateBazelTargetModule(ktProps, android.CommonAttributes{Name: ktName}, ktAttrs)
2916 attrs.Runtime_deps.Add(&bazel.LabelAttribute{Value: &bazel.Label{Label: ":" + ktName}})
2917 }
Wei Libafb6d62021-12-10 03:14:59 -08002918
2919 // Create the BazelTargetModule.
2920 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: m.Name()}, attrs)
2921}
Romain Jobredeaux428a3662022-01-28 11:12:52 -05002922
2923type bazelJavaImportAttributes struct {
Alixb4e09a02022-09-27 15:36:01 +00002924 Jars bazel.LabelListAttribute
2925 Exports bazel.LabelListAttribute
Romain Jobredeaux428a3662022-01-28 11:12:52 -05002926}
2927
2928// java_import bp2Build converter.
2929func (i *Import) ConvertWithBp2build(ctx android.TopDownMutatorContext) {
Sam Delmerico48983162022-02-22 21:41:33 +00002930 var jars bazel.LabelListAttribute
2931 archVariantProps := i.GetArchVariantProperties(ctx, &ImportProperties{})
2932 for axis, configToProps := range archVariantProps {
2933 for config, _props := range configToProps {
2934 if archProps, ok := _props.(*ImportProperties); ok {
2935 archJars := android.BazelLabelForModuleSrcExcludes(ctx, archProps.Jars, []string(nil))
2936 jars.SetSelectValue(axis, config, archJars)
2937 }
2938 }
2939 }
Romain Jobredeaux428a3662022-01-28 11:12:52 -05002940
2941 attrs := &bazelJavaImportAttributes{
2942 Jars: jars,
2943 }
2944 props := bazel.BazelTargetModuleProperties{Rule_class: "java_import"}
2945
Alixb4e09a02022-09-27 15:36:01 +00002946 name := android.RemoveOptionalPrebuiltPrefix(i.Name())
2947
2948 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: name}, attrs)
2949
2950 neverlink := true
2951 neverlinkAttrs := &javaLibraryAttributes{
2952 Neverlink: bazel.BoolAttribute{Value: &neverlink},
2953 Exports: bazel.MakeSingleLabelListAttribute(bazel.Label{Label: ":" + name}),
2954 }
2955 ctx.CreateBazelTargetModule(bazel.BazelTargetModuleProperties{Rule_class: "java_library"}, android.CommonAttributes{Name: name + "-neverlink"}, neverlinkAttrs)
2956
Sam Delmerico277795c2022-02-25 17:04:37 +00002957}
Romain Jobredeaux428a3662022-01-28 11:12:52 -05002958
Sam Delmerico277795c2022-02-25 17:04:37 +00002959var _ android.MixedBuildBuildable = (*Import)(nil)
2960
2961func (i *Import) getBazelModuleLabel(ctx android.BaseModuleContext) string {
2962 return android.RemoveOptionalPrebuiltPrefixFromBazelLabel(i.GetBazelLabel(ctx, i))
2963}
2964
2965func (i *Import) ProcessBazelQueryResponse(ctx android.ModuleContext) {
2966 i.commonBuildActions(ctx)
2967
2968 bazelCtx := ctx.Config().BazelContext
2969 filePaths, err := bazelCtx.GetOutputFiles(i.getBazelModuleLabel(ctx), android.GetConfigKey(ctx))
2970 if err != nil {
2971 ctx.ModuleErrorf(err.Error())
2972 return
2973 }
2974
2975 bazelJars := android.Paths{}
2976 for _, bazelOutputFile := range filePaths {
2977 bazelJars = append(bazelJars, android.PathForBazelOut(ctx, bazelOutputFile))
2978 }
2979
2980 jarName := android.RemoveOptionalPrebuiltPrefix(i.Name()) + ".jar"
2981 outputFile := android.PathForModuleOut(ctx, "bazelCombined", jarName)
2982 TransformJarsToJar(ctx, outputFile, "combine prebuilt jars", bazelJars,
2983 android.OptionalPath{}, // manifest
2984 false, // stripDirEntries
2985 []string{}, // filesToStrip
2986 []string{}, // dirsToStrip
2987 )
2988 i.combinedClasspathFile = outputFile
2989
2990 ctx.SetProvider(JavaInfoProvider, JavaInfo{
2991 HeaderJars: android.PathsIfNonNil(i.combinedClasspathFile),
2992 ImplementationAndResourcesJars: android.PathsIfNonNil(i.combinedClasspathFile),
2993 ImplementationJars: android.PathsIfNonNil(i.combinedClasspathFile),
Paul Duffin7ed6ff82022-11-21 10:57:30 +00002994 //TODO(b/240308299) include AIDL information from Bazel
Sam Delmerico277795c2022-02-25 17:04:37 +00002995 })
2996
2997 i.maybeInstall(ctx, jarName, outputFile)
2998}
2999
3000func (i *Import) QueueBazelCall(ctx android.BaseModuleContext) {
3001 bazelCtx := ctx.Config().BazelContext
3002 bazelCtx.QueueBazelRequest(i.getBazelModuleLabel(ctx), cquery.GetOutputFiles, android.GetConfigKey(ctx))
3003}
3004
3005func (i *Import) IsMixedBuildSupported(ctx android.BaseModuleContext) bool {
3006 return true
Romain Jobredeaux428a3662022-01-28 11:12:52 -05003007}