blob: 0ba1f5a7a54249787de435ac85189e4546751240 [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"
Colin Cross74d73e22017-08-02 11:05:49 -070024 "strconv"
Colin Cross2fe66872015-03-30 17:20:39 -070025 "strings"
26
27 "github.com/google/blueprint"
Colin Cross3b706fd2019-09-05 16:44:18 -070028 "github.com/google/blueprint/pathtools"
Colin Cross76b5f0c2017-08-29 16:02:06 -070029 "github.com/google/blueprint/proptools"
Colin Cross2fe66872015-03-30 17:20:39 -070030
Colin Cross635c3b02016-05-18 15:37:25 -070031 "android/soong/android"
Colin Cross3e3e72d2017-06-22 17:20:19 -070032 "android/soong/java/config"
Colin Cross303e21f2018-08-07 16:49:25 -070033 "android/soong/tradefed"
Colin Cross2fe66872015-03-30 17:20:39 -070034)
35
Colin Cross463a90e2015-06-17 14:20:06 -070036func init() {
Paul Duffinf9b1da02019-12-18 19:51:55 +000037 RegisterJavaBuildComponents(android.InitRegistrationContext)
Paul Duffin255f18e2019-12-13 11:22:16 +000038
39 // Register sdk member types.
Paul Duffin7b81f5e2020-01-13 21:03:22 +000040 android.RegisterSdkMemberType(javaHeaderLibsSdkMemberType)
Paul Duffin255f18e2019-12-13 11:22:16 +000041
Paul Duffinf5c0a9c2020-02-28 14:39:53 +000042 android.RegisterSdkMemberType(&librarySdkMemberType{
43 android.SdkMemberTypeBase{
44 PropertyName: "java_libs",
45 },
46 func(j *Library) android.Path {
47 implementationJars := j.ImplementationJars()
48 if len(implementationJars) != 1 {
49 panic(fmt.Errorf("there must be only one implementation jar from %q", j.Name()))
50 }
51
52 return implementationJars[0]
Paul Duffin255f18e2019-12-13 11:22:16 +000053 },
54 })
Paul Duffin1b82e6a2019-12-03 18:06:47 +000055
56 android.RegisterSdkMemberType(&testSdkMemberType{
57 SdkMemberTypeBase: android.SdkMemberTypeBase{
58 PropertyName: "java_tests",
59 },
60 })
Colin Cross463a90e2015-06-17 14:20:06 -070061}
62
Paul Duffinf9b1da02019-12-18 19:51:55 +000063func RegisterJavaBuildComponents(ctx android.RegistrationContext) {
64 ctx.RegisterModuleType("java_defaults", DefaultsFactory)
65
66 ctx.RegisterModuleType("java_library", LibraryFactory)
67 ctx.RegisterModuleType("java_library_static", LibraryStaticFactory)
68 ctx.RegisterModuleType("java_library_host", LibraryHostFactory)
69 ctx.RegisterModuleType("java_binary", BinaryFactory)
70 ctx.RegisterModuleType("java_binary_host", BinaryHostFactory)
71 ctx.RegisterModuleType("java_test", TestFactory)
72 ctx.RegisterModuleType("java_test_helper_library", TestHelperLibraryFactory)
73 ctx.RegisterModuleType("java_test_host", TestHostFactory)
Paul Duffin1b82e6a2019-12-03 18:06:47 +000074 ctx.RegisterModuleType("java_test_import", JavaTestImportFactory)
Paul Duffinf9b1da02019-12-18 19:51:55 +000075 ctx.RegisterModuleType("java_import", ImportFactory)
76 ctx.RegisterModuleType("java_import_host", ImportFactoryHost)
77 ctx.RegisterModuleType("java_device_for_host", DeviceForHostFactory)
78 ctx.RegisterModuleType("java_host_for_device", HostForDeviceFactory)
79 ctx.RegisterModuleType("dex_import", DexImportFactory)
80
Martin Stjernholm6d415272020-01-31 17:10:36 +000081 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
82 ctx.BottomUp("dexpreopt_tool_deps", dexpreoptToolDepsMutator).Parallel()
83 })
Martin Stjernholmd90676f2020-01-11 00:37:30 +000084
Paul Duffinf9b1da02019-12-18 19:51:55 +000085 ctx.RegisterSingletonType("logtags", LogtagsSingleton)
86 ctx.RegisterSingletonType("kythe_java_extract", kytheExtractJavaFactory)
87}
88
Artur Satayev8cf899a2020-04-15 17:29:42 +010089func (j *Module) CheckStableSdkVersion() error {
90 sdkVersion := j.sdkVersion()
91 if sdkVersion.stable() {
92 return nil
93 }
94 return fmt.Errorf("non stable SDK %v", sdkVersion)
95}
96
Artur Satayev2db1c3f2020-04-08 19:09:30 +010097func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
Colin Crossc2d24052020-05-13 11:05:02 -070098 if j.RequiresStableAPIs(ctx) {
Jeongik Cha2cc570d2019-10-29 15:44:45 +090099 if sc, ok := ctx.Module().(sdkContext); ok {
Jiyong Park6a927c42020-01-21 02:03:43 +0900100 if !sc.sdkVersion().specified() {
Jeongik Cha2cc570d2019-10-29 15:44:45 +0900101 ctx.PropertyErrorf("sdk_version",
102 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
103 }
104 }
105 }
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100106
107 ctx.VisitDirectDeps(func(module android.Module) {
108 tag := ctx.OtherModuleDependencyTag(module)
109 switch module.(type) {
110 // TODO(satayev): cover other types as well, e.g. imports
111 case *Library, *AndroidLibrary:
112 switch tag {
113 case bootClasspathTag, libTag, staticLibTag, java9LibTag:
114 checkLinkType(ctx, j, module.(linkTypeContext), tag.(dependencyTag))
115 }
116 }
117 })
Jeongik Cha2cc570d2019-10-29 15:44:45 +0900118}
119
Jeongik Cha538c0d02019-07-11 15:54:27 +0900120func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
121 if sc, ok := ctx.Module().(sdkContext); ok {
122 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park6a927c42020-01-21 02:03:43 +0900123 sdkVersionSpecified := sc.sdkVersion().specified()
124 if usePlatformAPI && sdkVersionSpecified {
125 ctx.PropertyErrorf("platform_apis", "platform_apis must be false when sdk_version is not empty.")
126 } else if !usePlatformAPI && !sdkVersionSpecified {
127 ctx.PropertyErrorf("platform_apis", "platform_apis must be true when sdk_version is empty.")
Jeongik Cha538c0d02019-07-11 15:54:27 +0900128 }
129
130 }
131}
132
Colin Cross2fe66872015-03-30 17:20:39 -0700133// TODO:
134// Autogenerated files:
Colin Cross2fe66872015-03-30 17:20:39 -0700135// Renderscript
136// Post-jar passes:
137// Proguard
Colin Cross2fe66872015-03-30 17:20:39 -0700138// Rmtypedefs
Colin Cross2fe66872015-03-30 17:20:39 -0700139// DroidDoc
140// Findbugs
141
Colin Cross89536d42017-07-07 14:35:50 -0700142type CompilerProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -0700143 // list of source files used to compile the Java module. May be .java, .logtags, .proto,
144 // or .aidl files.
Colin Cross27b922f2019-03-04 22:35:41 -0800145 Srcs []string `android:"path,arch_variant"`
Dan Willemsen2ef08f42015-06-30 18:15:24 -0700146
147 // list of source files that should not be used to build the Java module.
148 // This is most useful in the arch/multilib variants to remove non-common files
Colin Cross27b922f2019-03-04 22:35:41 -0800149 Exclude_srcs []string `android:"path,arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700150
151 // list of directories containing Java resources
Colin Cross86a63ff2017-09-27 17:33:10 -0700152 Java_resource_dirs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700153
Colin Cross86a63ff2017-09-27 17:33:10 -0700154 // list of directories that should be excluded from java_resource_dirs
155 Exclude_java_resource_dirs []string `android:"arch_variant"`
Dan Willemsen2ef08f42015-06-30 18:15:24 -0700156
Colin Cross0f37af02017-09-27 17:42:05 -0700157 // list of files to use as Java resources
Colin Cross27b922f2019-03-04 22:35:41 -0800158 Java_resources []string `android:"path,arch_variant"`
Colin Cross0f37af02017-09-27 17:42:05 -0700159
Colin Crosscedd4762018-09-13 11:26:19 -0700160 // list of files that should be excluded from java_resources and java_resource_dirs
Colin Cross27b922f2019-03-04 22:35:41 -0800161 Exclude_java_resources []string `android:"path,arch_variant"`
Colin Cross0f37af02017-09-27 17:42:05 -0700162
Colin Cross7d5136f2015-05-11 13:39:40 -0700163 // list of module-specific flags that will be used for javac compiles
164 Javacflags []string `android:"arch_variant"`
165
Zoran Jovanovic8736ce22018-08-21 17:10:29 +0200166 // list of module-specific flags that will be used for kotlinc compiles
167 Kotlincflags []string `android:"arch_variant"`
168
Colin Cross7d5136f2015-05-11 13:39:40 -0700169 // list of of java libraries that will be in the classpath
Colin Crosse8dc34a2017-07-19 11:22:16 -0700170 Libs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700171
172 // list of java libraries that will be compiled into the resulting jar
Colin Crosse8dc34a2017-07-19 11:22:16 -0700173 Static_libs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700174
175 // manifest file to be included in resulting jar
Colin Cross27b922f2019-03-04 22:35:41 -0800176 Manifest *string `android:"path"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700177
Colin Cross540eff82017-06-22 17:01:52 -0700178 // if not blank, run jarjar using the specified rules file
Colin Cross27b922f2019-03-04 22:35:41 -0800179 Jarjar_rules *string `android:"path,arch_variant"`
Colin Cross64162712017-08-08 13:17:59 -0700180
181 // If not blank, set the java version passed to javac as -source and -target
182 Java_version *string
Colin Cross2c429dc2017-08-31 16:45:16 -0700183
Colin Cross9ae1b922018-06-26 17:59:05 -0700184 // If set to true, allow this module to be dexed and installed on devices. Has no
185 // effect on host modules, which are always considered installable.
Colin Cross2c429dc2017-08-31 16:45:16 -0700186 Installable *bool
Colin Cross32f676a2017-09-06 13:41:06 -0700187
Colin Cross0f37af02017-09-27 17:42:05 -0700188 // If set to true, include sources used to compile the module in to the final jar
189 Include_srcs *bool
190
Vladimir Marko0975ee02019-04-02 10:29:55 +0100191 // If not empty, classes are restricted to the specified packages and their sub-packages.
192 // This restriction is checked after applying jarjar rules and including static libs.
193 Permitted_packages []string
194
Colin Crossbe9cdb82019-01-21 21:37:16 -0800195 // List of modules to use as annotation processors
196 Plugins []string
Colin Cross1369cdb2017-09-29 17:58:17 -0700197
Artur Satayev9cf46692019-11-26 18:08:34 +0000198 // List of modules to export to libraries that directly depend on this library as annotation processors
199 Exported_plugins []string
200
Nan Zhang61eaedb2017-11-02 13:28:15 -0700201 // The number of Java source entries each Javac instance can process
202 Javac_shard_size *int64
203
Nan Zhang5f8cb422018-02-06 10:34:32 -0800204 // Add host jdk tools.jar to bootclasspath
205 Use_tools_jar *bool
206
Colin Cross1369cdb2017-09-29 17:58:17 -0700207 Openjdk9 struct {
Colin Cross6cef4812019-10-17 14:23:50 -0700208 // List of source files that should only be used when passing -source 1.9 or higher
Colin Cross27b922f2019-03-04 22:35:41 -0800209 Srcs []string `android:"path"`
Colin Cross1369cdb2017-09-29 17:58:17 -0700210
Colin Cross6cef4812019-10-17 14:23:50 -0700211 // List of javac flags that should only be used when passing -source 1.9 or higher
Colin Cross1369cdb2017-09-29 17:58:17 -0700212 Javacflags []string
213 }
Colin Crosscb933592017-11-22 13:49:43 -0800214
Colin Cross81440082018-08-15 20:21:55 -0700215 // When compiling language level 9+ .java code in packages that are part of
216 // a system module, patch_module names the module that your sources and
217 // dependencies should be patched into. The Android runtime currently
218 // doesn't implement the JEP 261 module system so this option is only
219 // supported at compile time. It should only be needed to compile tests in
220 // packages that exist in libcore and which are inconvenient to move
221 // elsewhere.
Tobias Thiererdda713d2018-09-19 16:16:19 +0100222 Patch_module *string `android:"arch_variant"`
Colin Cross81440082018-08-15 20:21:55 -0700223
Colin Crosscb933592017-11-22 13:49:43 -0800224 Jacoco struct {
225 // List of classes to include for instrumentation with jacoco to collect coverage
226 // information at runtime when building with coverage enabled. If unset defaults to all
227 // classes.
228 // Supports '*' as the last character of an entry in the list as a wildcard match.
229 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
230 // it matches classes in the package that have the class name as a prefix.
231 Include_filter []string
232
233 // List of classes to exclude from instrumentation with jacoco to collect coverage
234 // information at runtime when building with coverage enabled. Overrides classes selected
235 // by the include_filter property.
236 // Supports '*' as the last character of an entry in the list as a wildcard match.
237 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
238 // it matches classes in the package that have the class name as a prefix.
239 Exclude_filter []string
240 }
241
Andreas Gampef3e5b552018-01-22 21:27:21 -0800242 Errorprone struct {
243 // List of javac flags that should only be used when running errorprone.
244 Javacflags []string
245 }
246
Colin Cross0f2ee152017-12-14 15:22:43 -0800247 Proto struct {
248 // List of extra options that will be passed to the proto generator.
249 Output_params []string
250 }
251
Colin Crosscb933592017-11-22 13:49:43 -0800252 Instrument bool `blueprint:"mutated"`
Alex Light7f004a72019-02-21 13:27:37 -0800253
254 // List of files to include in the META-INF/services folder of the resulting jar.
Colin Cross27b922f2019-03-04 22:35:41 -0800255 Services []string `android:"path,arch_variant"`
Colin Cross540eff82017-06-22 17:01:52 -0700256}
257
Colin Cross89536d42017-07-07 14:35:50 -0700258type CompilerDeviceProperties struct {
Colin Cross540eff82017-06-22 17:01:52 -0700259 // list of module-specific flags that will be used for dex compiles
260 Dxflags []string `android:"arch_variant"`
261
Jeongik Cha538c0d02019-07-11 15:54:27 +0900262 // if not blank, set to the version of the sdk to compile against.
263 // Defaults to compiling against the current platform.
Nan Zhangea568a42017-11-08 21:20:04 -0800264 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700265
Colin Cross83bb3162018-06-25 15:48:06 -0700266 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
267 // Defaults to sdk_version if not set.
268 Min_sdk_version *string
269
Dan Willemsen419290a2018-10-31 15:28:47 -0700270 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
271 // Defaults to sdk_version if not set.
272 Target_sdk_version *string
273
Jeongik Cha356dac42019-08-19 14:09:52 +0900274 // Whether to compile against the platform APIs instead of an SDK.
275 // If true, then sdk_version must be empty. The value of this field
276 // is ignored when module's type isn't android_app.
Colin Cross6af2e492018-05-22 11:12:33 -0700277 Platform_apis *bool
278
Colin Crossebe1a512017-11-14 13:12:14 -0800279 Aidl struct {
280 // Top level directories to pass to aidl tool
281 Include_dirs []string
Colin Cross7d5136f2015-05-11 13:39:40 -0700282
Colin Crossebe1a512017-11-14 13:12:14 -0800283 // Directories rooted at the Android.bp file to pass to aidl tool
284 Local_include_dirs []string
285
286 // directories that should be added as include directories for any aidl sources of modules
287 // that depend on this module, as well as to aidl for this module.
288 Export_include_dirs []string
Martijn Coeneneab15642018-03-09 09:29:59 +0100289
290 // whether to generate traces (for systrace) for this interface
291 Generate_traces *bool
Olivier Gaillard0a4cfbc2018-07-16 23:37:03 +0100292
293 // whether to generate Binder#GetTransaction name method.
294 Generate_get_transaction_name *bool
Colin Crossebe1a512017-11-14 13:12:14 -0800295 }
Colin Cross92430102017-10-09 14:59:32 -0700296
297 // If true, export a copy of the module as a -hostdex module for host testing.
298 Hostdex *bool
Colin Cross1369cdb2017-09-29 17:58:17 -0700299
Colin Cross7f87f4f2019-04-24 13:41:45 -0700300 Target struct {
301 Hostdex struct {
302 // Additional required dependencies to add to -hostdex modules.
303 Required []string
304 }
305 }
306
David Brazdil17ef5632018-06-27 10:27:45 +0100307 // If set to true, compile dex regardless of installable. Defaults to false.
308 Compile_dex *bool
309
Colin Cross66dbc0b2017-12-28 12:23:20 -0800310 Optimize struct {
Colin Crossae5caf52018-05-22 11:11:52 -0700311 // If false, disable all optimization. Defaults to true for android_app and android_test
312 // modules, false for java_library and java_test modules.
Colin Cross66dbc0b2017-12-28 12:23:20 -0800313 Enabled *bool
Sasha Smundak2057f822019-04-16 17:16:58 -0700314 // True if the module containing this has it set by default.
315 EnabledByDefault bool `blueprint:"mutated"`
Colin Cross66dbc0b2017-12-28 12:23:20 -0800316
317 // If true, optimize for size by removing unused code. Defaults to true for apps,
318 // false for libraries and tests.
319 Shrink *bool
320
321 // If true, optimize bytecode. Defaults to false.
322 Optimize *bool
323
324 // If true, obfuscate bytecode. Defaults to false.
325 Obfuscate *bool
326
327 // If true, do not use the flag files generated by aapt that automatically keep
328 // classes referenced by the app manifest. Defaults to false.
329 No_aapt_flags *bool
330
331 // Flags to pass to proguard.
332 Proguard_flags []string
333
334 // Specifies the locations of files containing proguard flags.
Colin Cross27b922f2019-03-04 22:35:41 -0800335 Proguard_flags_files []string `android:"path"`
Colin Cross66dbc0b2017-12-28 12:23:20 -0800336 }
337
Paul Duffine25c6442019-10-11 13:50:28 +0100338 // When targeting 1.9 and above, override the modules to use with --system,
339 // otherwise provides defaults libraries to add to the bootclasspath.
Colin Cross1369cdb2017-09-29 17:58:17 -0700340 System_modules *string
Colin Cross5a0dcd52018-10-05 14:20:06 -0700341
Jiyong Park4c4c0242019-10-21 14:53:15 +0900342 // set the name of the output
343 Stem *string
344
David Srbeckye033cba2020-05-20 22:20:28 +0100345 // Keep the data uncompressed. We always need uncompressed dex for execution,
346 // so this might actually save space by avoiding storing the same data twice.
347 // This defaults to reasonable value based on module and should not be set.
348 // It exists only to support ART tests.
349 Uncompress_dex *bool
350
351 IsSDKLibrary bool `blueprint:"mutated"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700352}
353
Sasha Smundak2057f822019-04-16 17:16:58 -0700354func (me *CompilerDeviceProperties) EffectiveOptimizeEnabled() bool {
355 return BoolDefault(me.Optimize.Enabled, me.Optimize.EnabledByDefault)
356}
357
Paul Duffin0d3c2e12020-05-17 08:34:50 +0100358// Functionality common to Module and Import
Paul Duffin859fe962020-05-15 10:20:31 +0100359//
360// It is embedded in Module so its functionality can be used by methods in Module
361// but it is currently only initialized by Import and Library.
Paul Duffin0d3c2e12020-05-17 08:34:50 +0100362type embeddableInModuleAndImport struct {
Paul Duffin859fe962020-05-15 10:20:31 +0100363
364 // Functionality related to this being used as a component of a java_sdk_library.
365 EmbeddableSdkLibraryComponent
366}
367
368func (e *embeddableInModuleAndImport) initModuleAndImport(moduleBase *android.ModuleBase) {
369 e.initSdkLibraryComponent(moduleBase)
Paul Duffin0d3c2e12020-05-17 08:34:50 +0100370}
371
372// Module/Import's DepIsInSameApex(...) delegates to this method.
373//
374// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
375// the one provided by ApexModuleBase.
376func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
377 // dependencies other than the static linkage are all considered crossing APEX boundary
378 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
379 return true
380 }
381 return false
382}
383
Colin Cross46c9b8b2017-06-22 16:51:17 -0700384// Module contains the properties and members used by all java module types
385type Module struct {
Colin Cross635c3b02016-05-18 15:37:25 -0700386 android.ModuleBase
Colin Cross89536d42017-07-07 14:35:50 -0700387 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +0900388 android.ApexModuleBase
Jiyong Parkd1063c12019-07-17 20:08:41 +0900389 android.SdkBase
Colin Cross2fe66872015-03-30 17:20:39 -0700390
Paul Duffin0d3c2e12020-05-17 08:34:50 +0100391 // Functionality common to Module and Import.
392 embeddableInModuleAndImport
393
Colin Cross89536d42017-07-07 14:35:50 -0700394 properties CompilerProperties
Colin Cross6af17aa2017-09-20 12:59:05 -0700395 protoProperties android.ProtoProperties
Colin Cross89536d42017-07-07 14:35:50 -0700396 deviceProperties CompilerDeviceProperties
Colin Cross2fe66872015-03-30 17:20:39 -0700397
Colin Cross331a1212018-08-15 20:40:52 -0700398 // jar file containing header classes including static library dependencies, suitable for
399 // inserting into the bootclasspath/classpath of another compile
Nan Zhanged19fc32017-10-19 13:06:22 -0700400 headerJarFile android.Path
401
Colin Cross331a1212018-08-15 20:40:52 -0700402 // jar file containing implementation classes including static library dependencies but no
403 // resources
Nan Zhanged19fc32017-10-19 13:06:22 -0700404 implementationJarFile android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700405
Colin Cross331a1212018-08-15 20:40:52 -0700406 // jar file containing only resources including from static library dependencies
407 resourceJar android.Path
408
Colin Cross0c4ce212019-05-03 15:28:19 -0700409 // args and dependencies to package source files into a srcjar
410 srcJarArgs []string
411 srcJarDeps android.Paths
412
Colin Cross331a1212018-08-15 20:40:52 -0700413 // jar file containing implementation classes and resources including static library
414 // dependencies
415 implementationAndResourcesJar android.Path
416
417 // output file containing classes.dex and resources
Colin Cross6ade34f2017-09-15 13:00:47 -0700418 dexJarFile android.Path
419
Colin Cross43f08db2018-11-12 10:13:39 -0800420 // output file that contains classes.dex if it should be in the output file
421 maybeStrippedDexJarFile android.Path
422
Colin Crosscb933592017-11-22 13:49:43 -0800423 // output file containing uninstrumented classes that will be instrumented by jacoco
424 jacocoReportClassesFile android.Path
425
Colin Cross66dbc0b2017-12-28 12:23:20 -0800426 // output file containing mapping of obfuscated names
427 proguardDictionary android.Path
428
Colin Cross331a1212018-08-15 20:40:52 -0700429 // output file of the module, which may be a classes jar or a dex jar
Colin Crosse560c4a2019-03-19 16:03:11 -0700430 outputFile android.Path
431 extraOutputFiles android.Paths
Colin Crossb7a63242015-04-16 14:09:14 -0700432
Colin Cross635c3b02016-05-18 15:37:25 -0700433 exportAidlIncludeDirs android.Paths
Colin Crossc0b06f12015-04-08 13:03:43 -0700434
Colin Cross635c3b02016-05-18 15:37:25 -0700435 logtagsSrcs android.Paths
Colin Crossf05fe972015-04-10 17:45:20 -0700436
Colin Cross2fe66872015-03-30 17:20:39 -0700437 // installed file for binary dependency
Colin Cross635c3b02016-05-18 15:37:25 -0700438 installFile android.Path
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800439
440 // list of .java files and srcjars that was passed to javac
441 compiledJavaSrcs android.Paths
442 compiledSrcJars android.Paths
Colin Cross66dbc0b2017-12-28 12:23:20 -0800443
444 // list of extra progurad flag files
445 extraProguardFlagFiles android.Paths
Jiyong Park1be96912018-05-28 18:02:19 +0900446
Colin Cross094054a2018-10-17 15:10:48 -0700447 // manifest file to use instead of properties.Manifest
448 overrideManifest android.OptionalPath
449
Artur Satayev9cf46692019-11-26 18:08:34 +0000450 // list of SDK lib names that this java module is exporting
Jiyong Park1be96912018-05-28 18:02:19 +0900451 exportedSdkLibs []string
Brandon Lee5d45c6f2018-08-15 15:35:38 -0700452
Artur Satayev9cf46692019-11-26 18:08:34 +0000453 // list of plugins that this java module is exporting
454 exportedPluginJars android.Paths
455
456 // list of plugins that this java module is exporting
457 exportedPluginClasses []string
458
459 // list of source files, collected from srcFiles with unique java and all kt files,
patricktu242faad2019-09-24 15:41:30 +0800460 // will be used by android.IDEInfo struct
Brandon Lee5d45c6f2018-08-15 15:35:38 -0700461 expandIDEInfoCompiledSrcs []string
Colin Cross43f08db2018-11-12 10:13:39 -0800462
Steven Morelandc4efd9c2019-01-18 11:51:25 -0800463 // expanded Jarjar_rules
464 expandJarjarRules android.Path
465
Vladimir Marko0975ee02019-04-02 10:29:55 +0100466 // list of additional targets for checkbuild
467 additionalCheckedModules android.Paths
468
Colin Cross988708c2019-05-06 14:04:11 -0700469 // Extra files generated by the module type to be added as java resources.
470 extraResources android.Paths
471
Colin Crossf24a22a2019-01-31 14:12:44 -0800472 hiddenAPI
Colin Cross43f08db2018-11-12 10:13:39 -0800473 dexpreopter
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800474
475 // list of the xref extraction files
476 kytheFiles android.Paths
Anton Hansson78156ef2020-03-27 19:39:48 +0000477
478 distFile android.Path
bralee1fbf4402020-05-21 10:11:59 +0800479
480 // Collect the module directory for IDE info in java/jdeps.go.
481 modulePaths []string
Colin Cross2fe66872015-03-30 17:20:39 -0700482}
483
Colin Cross41955e82019-05-29 14:40:35 -0700484func (j *Module) OutputFiles(tag string) (android.Paths, error) {
485 switch tag {
486 case "":
487 return append(android.Paths{j.outputFile}, j.extraOutputFiles...), nil
Colin Cross375ca3c2019-05-29 14:40:58 -0700488 case ".jar":
489 return android.Paths{j.implementationAndResourcesJar}, nil
Colin Cross2d975b12019-07-29 16:47:42 -0700490 case ".proguard_map":
491 return android.Paths{j.proguardDictionary}, nil
Colin Cross41955e82019-05-29 14:40:35 -0700492 default:
493 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
494 }
Colin Cross54250902017-12-05 09:28:08 -0800495}
496
Colin Cross41955e82019-05-29 14:40:35 -0700497var _ android.OutputFileProducer = (*Module)(nil)
Colin Cross54250902017-12-05 09:28:08 -0800498
Colin Crossf506d872017-07-19 15:53:04 -0700499type Dependency interface {
Nan Zhanged19fc32017-10-19 13:06:22 -0700500 HeaderJars() android.Paths
501 ImplementationJars() android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700502 ResourceJars() android.Paths
503 ImplementationAndResourcesJars() android.Paths
Ulyana Trafimovich5539e7b2020-06-04 14:08:17 +0000504 DexJarBuildPath() android.Path
Colin Cross635c3b02016-05-18 15:37:25 -0700505 AidlIncludeDirs() android.Paths
Jiyong Park1be96912018-05-28 18:02:19 +0900506 ExportedSdkLibs() []string
Artur Satayev9cf46692019-11-26 18:08:34 +0000507 ExportedPlugins() (android.Paths, []string)
Colin Cross0c4ce212019-05-03 15:28:19 -0700508 SrcJarArgs() ([]string, android.Paths)
Colin Crosse323f3c2019-09-17 15:34:09 -0700509 BaseModuleName() string
Jiyong Park618922e2020-01-08 13:35:43 +0900510 JacocoReportClassesFile() android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700511}
512
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800513type xref interface {
514 XrefJavaFiles() android.Paths
515}
516
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800517func (j *Module) XrefJavaFiles() android.Paths {
518 return j.kytheFiles
519}
520
Colin Cross89536d42017-07-07 14:35:50 -0700521func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
522 android.InitAndroidArchModule(module, hod, android.MultilibCommon)
523 android.InitDefaultableModule(module)
524}
525
Colin Crossbe1da472017-07-07 15:59:46 -0700526type dependencyTag struct {
527 blueprint.BaseDependencyTag
528 name string
Colin Cross2fe66872015-03-30 17:20:39 -0700529}
530
Colin Crossa4f08812018-10-02 22:03:40 -0700531type jniDependencyTag struct {
532 blueprint.BaseDependencyTag
Colin Crossa4f08812018-10-02 22:03:40 -0700533}
534
Jiyong Park8be103b2019-11-08 15:53:48 +0900535func IsJniDepTag(depTag blueprint.DependencyTag) bool {
536 _, ok := depTag.(*jniDependencyTag)
537 return ok
538}
539
Colin Crossbe1da472017-07-07 15:59:46 -0700540var (
Colin Cross4b964c02018-10-15 16:18:06 -0700541 staticLibTag = dependencyTag{name: "staticlib"}
542 libTag = dependencyTag{name: "javalib"}
Colin Cross6cef4812019-10-17 14:23:50 -0700543 java9LibTag = dependencyTag{name: "java9lib"}
Colin Crossbe9cdb82019-01-21 21:37:16 -0800544 pluginTag = dependencyTag{name: "plugin"}
Artur Satayev9cf46692019-11-26 18:08:34 +0000545 exportedPluginTag = dependencyTag{name: "exported-plugin"}
Colin Cross4b964c02018-10-15 16:18:06 -0700546 bootClasspathTag = dependencyTag{name: "bootclasspath"}
547 systemModulesTag = dependencyTag{name: "system modules"}
548 frameworkResTag = dependencyTag{name: "framework-res"}
549 frameworkApkTag = dependencyTag{name: "framework-apk"}
550 kotlinStdlibTag = dependencyTag{name: "kotlin-stdlib"}
Colin Crossafbb1732019-01-17 15:42:52 -0800551 kotlinAnnotationsTag = dependencyTag{name: "kotlin-annotations"}
Colin Cross4b964c02018-10-15 16:18:06 -0700552 proguardRaiseTag = dependencyTag{name: "proguard-raise"}
553 certificateTag = dependencyTag{name: "certificate"}
554 instrumentationForTag = dependencyTag{name: "instrumentation_for"}
Colin Cross50ddcc42019-05-16 12:28:22 -0700555 usesLibTag = dependencyTag{name: "uses-library"}
Colin Crossbe1da472017-07-07 15:59:46 -0700556)
Colin Cross2fe66872015-03-30 17:20:39 -0700557
Jiyong Park83dc74b2020-01-14 18:38:44 +0900558func IsLibDepTag(depTag blueprint.DependencyTag) bool {
559 return depTag == libTag
560}
561
562func IsStaticLibDepTag(depTag blueprint.DependencyTag) bool {
563 return depTag == staticLibTag
564}
565
Colin Crossfc3674a2017-09-18 17:41:52 -0700566type sdkDep struct {
Colin Cross47ff2522017-10-02 14:22:08 -0700567 useModule, useFiles, useDefaultLibs, invalidVersion bool
568
Colin Cross6cef4812019-10-17 14:23:50 -0700569 // The modules that will be added to the bootclasspath when targeting 1.8 or lower
570 bootclasspath []string
Paul Duffine25c6442019-10-11 13:50:28 +0100571
572 // The default system modules to use. Will be an empty string if no system
573 // modules are to be used.
Colin Cross1369cdb2017-09-29 17:58:17 -0700574 systemModules string
575
Colin Cross6cef4812019-10-17 14:23:50 -0700576 // The modules that will be added ot the classpath when targeting 1.9 or higher
577 java9Classpath []string
578
Colin Crossa97c5d32018-03-28 14:58:31 -0700579 frameworkResModule string
580
Colin Cross86a60ae2018-05-29 14:44:55 -0700581 jars android.Paths
Colin Cross3047fa22019-04-18 10:56:44 -0700582 aidl android.OptionalPath
Paul Duffin250e6192019-06-07 10:44:37 +0100583
584 noStandardLibs, noFrameworksLibs bool
585}
586
587func (s sdkDep) hasStandardLibs() bool {
588 return !s.noStandardLibs
589}
590
591func (s sdkDep) hasFrameworkLibs() bool {
592 return !s.noStandardLibs && !s.noFrameworksLibs
Colin Cross1369cdb2017-09-29 17:58:17 -0700593}
594
Colin Crossa4f08812018-10-02 22:03:40 -0700595type jniLib struct {
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700596 name string
597 path android.Path
598 target android.Target
599 coverageFile android.OptionalPath
Colin Crossa4f08812018-10-02 22:03:40 -0700600}
601
Colin Cross0ea8ba82019-06-06 14:33:29 -0700602func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
Colin Cross3144dfc2018-01-03 15:06:47 -0800603 return j.properties.Instrument && ctx.Config().IsEnvTrue("EMMA_INSTRUMENT")
604}
605
Colin Cross0ea8ba82019-06-06 14:33:29 -0700606func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Colin Cross3144dfc2018-01-03 15:06:47 -0800607 return j.shouldInstrument(ctx) &&
608 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
609 ctx.Config().UnbundledBuild())
610}
611
Jiyong Park6a927c42020-01-21 02:03:43 +0900612func (j *Module) sdkVersion() sdkSpec {
613 return sdkSpecFrom(String(j.deviceProperties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -0700614}
615
Paul Duffine25c6442019-10-11 13:50:28 +0100616func (j *Module) systemModules() string {
617 return proptools.String(j.deviceProperties.System_modules)
618}
619
Jiyong Park6a927c42020-01-21 02:03:43 +0900620func (j *Module) minSdkVersion() sdkSpec {
Colin Cross83bb3162018-06-25 15:48:06 -0700621 if j.deviceProperties.Min_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +0900622 return sdkSpecFrom(*j.deviceProperties.Min_sdk_version)
Colin Cross83bb3162018-06-25 15:48:06 -0700623 }
624 return j.sdkVersion()
625}
626
Jiyong Park6a927c42020-01-21 02:03:43 +0900627func (j *Module) targetSdkVersion() sdkSpec {
Dan Willemsen419290a2018-10-31 15:28:47 -0700628 if j.deviceProperties.Target_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +0900629 return sdkSpecFrom(*j.deviceProperties.Target_sdk_version)
Dan Willemsen419290a2018-10-31 15:28:47 -0700630 }
631 return j.sdkVersion()
632}
633
Artur Satayev480e25b2020-04-27 18:53:18 +0100634func (j *Module) MinSdkVersion() string {
635 return j.minSdkVersion().version.String()
636}
637
Jiyong Parkb02bb402019-12-03 00:43:57 +0900638func (j *Module) AvailableFor(what string) bool {
639 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
640 // Exception: for hostdex: true libraries, the platform variant is created
641 // even if it's not marked as available to platform. In that case, the platform
642 // variant is used only for the hostdex and not installed to the device.
643 return true
644 }
645 return j.ApexModuleBase.AvailableFor(what)
646}
647
Colin Crossbe1da472017-07-07 15:59:46 -0700648func (j *Module) deps(ctx android.BottomUpMutatorContext) {
Colin Cross1369cdb2017-09-29 17:58:17 -0700649 if ctx.Device() {
Paul Duffin250e6192019-06-07 10:44:37 +0100650 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Cross6d8d8c62019-10-28 15:10:03 -0700651 if sdkDep.useDefaultLibs {
652 ctx.AddVariationDependencies(nil, bootClasspathTag, config.DefaultBootclasspathLibraries...)
653 ctx.AddVariationDependencies(nil, systemModulesTag, config.DefaultSystemModules)
654 if sdkDep.hasFrameworkLibs() {
655 ctx.AddVariationDependencies(nil, libTag, config.DefaultLibraries...)
Colin Crossbe1da472017-07-07 15:59:46 -0700656 }
Colin Cross6d8d8c62019-10-28 15:10:03 -0700657 } else if sdkDep.useModule {
Colin Cross6cef4812019-10-17 14:23:50 -0700658 ctx.AddVariationDependencies(nil, bootClasspathTag, sdkDep.bootclasspath...)
Colin Cross6cef4812019-10-17 14:23:50 -0700659 ctx.AddVariationDependencies(nil, java9LibTag, sdkDep.java9Classpath...)
Colin Cross6d8d8c62019-10-28 15:10:03 -0700660 if j.deviceProperties.EffectiveOptimizeEnabled() && sdkDep.hasStandardLibs() {
661 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.DefaultBootclasspathLibraries...)
662 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.DefaultLibraries...)
663 }
Colin Cross2fe66872015-03-30 17:20:39 -0700664 }
Colin Cross17dec172020-05-14 18:05:32 -0700665 if sdkDep.systemModules != "" {
666 ctx.AddVariationDependencies(nil, systemModulesTag, sdkDep.systemModules)
667 }
Colin Cross6d8d8c62019-10-28 15:10:03 -0700668
Nan Zhangb2b33de2018-02-23 11:18:47 -0800669 if ctx.ModuleName() == "android_stubs_current" ||
670 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -0700671 ctx.ModuleName() == "android_test_stubs_current" {
Colin Cross42d48b72018-08-29 14:10:52 -0700672 ctx.AddVariationDependencies(nil, frameworkApkTag, "framework-res")
Nan Zhangb2b33de2018-02-23 11:18:47 -0800673 }
Colin Cross2fe66872015-03-30 17:20:39 -0700674 }
Colin Cross1369cdb2017-09-29 17:58:17 -0700675
Inseob Kimac1e9862019-12-09 18:15:47 +0900676 syspropPublicStubs := syspropPublicStubs(ctx.Config())
677
678 // rewriteSyspropLibs validates if a java module can link against platform's sysprop_library,
679 // and redirects dependency to public stub depending on the link type.
680 rewriteSyspropLibs := func(libs []string, prop string) []string {
681 // make a copy
682 ret := android.CopyOf(libs)
683
684 for idx, lib := range libs {
685 stub, ok := syspropPublicStubs[lib]
686
687 if !ok {
688 continue
689 }
690
691 linkType, _ := j.getLinkType(ctx.ModuleName())
Inseob Kimc5239512020-01-14 15:36:21 +0900692 // only platform modules can use internal props
693 if linkType != javaPlatform {
Inseob Kimac1e9862019-12-09 18:15:47 +0900694 ret[idx] = stub
Inseob Kimac1e9862019-12-09 18:15:47 +0900695 }
696 }
697
698 return ret
699 }
700
701 ctx.AddVariationDependencies(nil, libTag, rewriteSyspropLibs(j.properties.Libs, "libs")...)
702 ctx.AddVariationDependencies(nil, staticLibTag, rewriteSyspropLibs(j.properties.Static_libs, "static_libs")...)
Colin Crossa4f08812018-10-02 22:03:40 -0700703
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700704 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
Artur Satayev9cf46692019-11-26 18:08:34 +0000705 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
Colin Crossbe9cdb82019-01-21 21:37:16 -0800706
Colin Crossfe17f6f2019-03-28 19:30:56 -0700707 android.ProtoDeps(ctx, &j.protoProperties)
Colin Cross6af17aa2017-09-20 12:59:05 -0700708 if j.hasSrcExt(".proto") {
709 protoDeps(ctx, &j.protoProperties)
710 }
Colin Cross93e85952017-08-15 13:34:18 -0700711
712 if j.hasSrcExt(".kt") {
713 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
714 // Kotlin files
Colin Cross0b03d972019-05-13 11:06:25 -0700715 ctx.AddVariationDependencies(nil, kotlinStdlibTag,
716 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8")
Colin Cross7788c122019-01-23 16:14:02 -0800717 if len(j.properties.Plugins) > 0 {
Colin Crossafbb1732019-01-17 15:42:52 -0800718 ctx.AddVariationDependencies(nil, kotlinAnnotationsTag, "kotlin-annotations")
719 }
Colin Cross93e85952017-08-15 13:34:18 -0700720 }
Colin Cross3144dfc2018-01-03 15:06:47 -0800721
Ulya Trafimovich38dfa0f2020-01-07 16:37:02 +0000722 // Framework libraries need special handling in static coverage builds: they should not have
723 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
724 // the same jacoco classes coming from different bootclasspath jars.
725 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
726 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
727 j.properties.Instrument = true
728 }
729 } else if j.shouldInstrumentStatic(ctx) {
Colin Cross42d48b72018-08-29 14:10:52 -0700730 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
Colin Cross3144dfc2018-01-03 15:06:47 -0800731 }
Colin Cross6af17aa2017-09-20 12:59:05 -0700732}
733
734func hasSrcExt(srcs []string, ext string) bool {
735 for _, src := range srcs {
736 if filepath.Ext(src) == ext {
737 return true
738 }
739 }
740
741 return false
742}
743
744func (j *Module) hasSrcExt(ext string) bool {
745 return hasSrcExt(j.properties.Srcs, ext)
Colin Cross2fe66872015-03-30 17:20:39 -0700746}
747
Colin Cross46c9b8b2017-06-22 16:51:17 -0700748func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Colin Cross3047fa22019-04-18 10:56:44 -0700749 aidlIncludeDirs android.Paths) (string, android.Paths) {
Colin Crossc0b06f12015-04-08 13:03:43 -0700750
Colin Crossebe1a512017-11-14 13:12:14 -0800751 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
752 aidlIncludes = append(aidlIncludes,
753 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
754 aidlIncludes = append(aidlIncludes,
755 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
Colin Crossc0b06f12015-04-08 13:03:43 -0700756
Colin Cross3047fa22019-04-18 10:56:44 -0700757 var flags []string
758 var deps android.Paths
Steven Moreland667f6882018-07-26 12:55:08 -0700759
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700760 if aidlPreprocess.Valid() {
761 flags = append(flags, "-p"+aidlPreprocess.String())
Colin Cross3047fa22019-04-18 10:56:44 -0700762 deps = append(deps, aidlPreprocess.Path())
763 } else if len(aidlIncludeDirs) > 0 {
Colin Cross635c3b02016-05-18 15:37:25 -0700764 flags = append(flags, android.JoinWithPrefix(aidlIncludeDirs.Strings(), "-I"))
Colin Crossc0b06f12015-04-08 13:03:43 -0700765 }
766
Colin Cross3047fa22019-04-18 10:56:44 -0700767 if len(j.exportAidlIncludeDirs) > 0 {
768 flags = append(flags, android.JoinWithPrefix(j.exportAidlIncludeDirs.Strings(), "-I"))
769 }
770
771 if len(aidlIncludes) > 0 {
772 flags = append(flags, android.JoinWithPrefix(aidlIncludes.Strings(), "-I"))
773 }
774
Colin Cross635c3b02016-05-18 15:37:25 -0700775 flags = append(flags, "-I"+android.PathForModuleSrc(ctx).String())
Colin Cross32f38982018-02-22 11:47:25 -0800776 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Colin Crossd48633a2017-07-13 14:41:17 -0700777 flags = append(flags, "-I"+src.String())
778 }
Colin Crossc0b06f12015-04-08 13:03:43 -0700779
Martijn Coeneneab15642018-03-09 09:29:59 +0100780 if Bool(j.deviceProperties.Aidl.Generate_traces) {
781 flags = append(flags, "-t")
782 }
783
Olivier Gaillard0a4cfbc2018-07-16 23:37:03 +0100784 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
785 flags = append(flags, "--transaction_names")
786 }
787
Colin Cross3047fa22019-04-18 10:56:44 -0700788 return strings.Join(flags, " "), deps
Colin Crossc0b06f12015-04-08 13:03:43 -0700789}
790
Colin Cross32f676a2017-09-06 13:41:06 -0700791type deps struct {
Nan Zhang581fd212018-01-10 16:06:12 -0800792 classpath classpath
Colin Cross6cef4812019-10-17 14:23:50 -0700793 java9Classpath classpath
Nan Zhang581fd212018-01-10 16:06:12 -0800794 bootClasspath classpath
Colin Cross6a77c982018-06-19 22:43:34 -0700795 processorPath classpath
Colin Crossbe9cdb82019-01-21 21:37:16 -0800796 processorClasses []string
Colin Cross6ade34f2017-09-15 13:00:47 -0700797 staticJars android.Paths
Nan Zhanged19fc32017-10-19 13:06:22 -0700798 staticHeaderJars android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700799 staticResourceJars android.Paths
Colin Cross6ade34f2017-09-15 13:00:47 -0700800 aidlIncludeDirs android.Paths
Nan Zhangb2b33de2018-02-23 11:18:47 -0800801 srcs android.Paths
Colin Cross59149b62017-10-16 18:07:29 -0700802 srcJars android.Paths
Colin Crossb77043e2019-07-16 13:57:13 -0700803 systemModules *systemModules
Colin Cross6ade34f2017-09-15 13:00:47 -0700804 aidlPreprocess android.OptionalPath
Colin Cross93e85952017-08-15 13:34:18 -0700805 kotlinStdlib android.Paths
Colin Crossafbb1732019-01-17 15:42:52 -0800806 kotlinAnnotations android.Paths
Colin Crossbe9cdb82019-01-21 21:37:16 -0800807
808 disableTurbine bool
Colin Cross32f676a2017-09-06 13:41:06 -0700809}
Colin Cross2fe66872015-03-30 17:20:39 -0700810
Colin Cross54250902017-12-05 09:28:08 -0800811func checkProducesJars(ctx android.ModuleContext, dep android.SourceFileProducer) {
812 for _, f := range dep.Srcs() {
813 if f.Ext() != ".jar" {
814 ctx.ModuleErrorf("genrule %q must generate files ending with .jar to be used as a libs or static_libs dependency",
815 ctx.OtherModuleName(dep.(blueprint.Module)))
816 }
817 }
818}
819
Jiyong Park2d492942018-03-05 17:44:10 +0900820type linkType int
821
822const (
Jiyong Park50146e92020-01-30 18:00:15 +0900823 // TODO(jiyong) rename these for better readability. Make the allowed
824 // and disallowed link types explicit
Jiyong Park2d492942018-03-05 17:44:10 +0900825 javaCore linkType = iota
826 javaSdk
827 javaSystem
Jiyong Park50146e92020-01-30 18:00:15 +0900828 javaModule
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900829 javaSystemServer
Jiyong Park2d492942018-03-05 17:44:10 +0900830 javaPlatform
831)
832
Jeongik Cha75b83b02019-11-01 15:28:00 +0900833type linkTypeContext interface {
834 android.Module
835 getLinkType(name string) (ret linkType, stubs bool)
836}
837
838func (m *Module) getLinkType(name string) (ret linkType, stubs bool) {
Anton Hanssoncc51a682020-05-19 12:06:48 +0100839 switch name {
840 case "core.current.stubs", "core.platform.api.stubs", "stub-annotations",
841 "private-stub-annotations-jar", "core-lambda-stubs", "core-generated-annotation-stubs":
Jiyong Park46f78fb2018-10-20 16:33:17 +0900842 return javaCore, true
Anton Hanssoncc51a682020-05-19 12:06:48 +0100843 case "android_stubs_current":
Jiyong Park46f78fb2018-10-20 16:33:17 +0900844 return javaSdk, true
Anton Hanssoncc51a682020-05-19 12:06:48 +0100845 case "android_system_stubs_current":
846 return javaSystem, true
847 case "android_module_lib_stubs_current":
Jiyong Park50146e92020-01-30 18:00:15 +0900848 return javaModule, true
Anton Hanssoncc51a682020-05-19 12:06:48 +0100849 case "android_system_server_stubs_current":
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900850 return javaSystemServer, true
Anton Hanssoncc51a682020-05-19 12:06:48 +0100851 case "android_test_stubs_current":
852 return javaSystem, true
Jiyong Park2d492942018-03-05 17:44:10 +0900853 }
Anton Hanssoncc51a682020-05-19 12:06:48 +0100854
Anton Hansson2d0c1942020-05-25 12:20:51 +0100855 if stub, linkType := moduleStubLinkType(name); stub {
856 return linkType, true
857 }
858
Anton Hanssoncc51a682020-05-19 12:06:48 +0100859 ver := m.sdkVersion()
860 switch ver.kind {
861 case sdkCore:
862 return javaCore, false
863 case sdkSystem:
864 return javaSystem, false
865 case sdkPublic:
866 return javaSdk, false
867 case sdkModule:
868 return javaModule, false
869 case sdkSystemServer:
870 return javaSystemServer, false
871 case sdkPrivate, sdkNone, sdkCorePlatform, sdkTest:
872 return javaPlatform, false
873 }
874
875 if !ver.valid() {
876 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.raw))
877 }
878 return javaSdk, false
Jiyong Park2d492942018-03-05 17:44:10 +0900879}
880
Jeongik Cha75b83b02019-11-01 15:28:00 +0900881func checkLinkType(ctx android.ModuleContext, from *Module, to linkTypeContext, tag dependencyTag) {
Colin Crossf19b9bb2018-03-26 14:42:44 -0700882 if ctx.Host() {
883 return
884 }
885
Jeongik Cha75b83b02019-11-01 15:28:00 +0900886 myLinkType, stubs := from.getLinkType(ctx.ModuleName())
Jiyong Park46f78fb2018-10-20 16:33:17 +0900887 if stubs {
888 return
889 }
Jeongik Cha75b83b02019-11-01 15:28:00 +0900890 otherLinkType, _ := to.getLinkType(ctx.OtherModuleName(to))
Jiyong Park2d492942018-03-05 17:44:10 +0900891 commonMessage := "Adjust sdk_version: property of the source or target module so that target module is built with the same or smaller API set than the source."
892
893 switch myLinkType {
894 case javaCore:
895 if otherLinkType != javaCore {
896 ctx.ModuleErrorf("compiles against core Java API, but dependency %q is compiling against non-core Java APIs."+commonMessage,
Jiyong Park750e5572018-01-31 00:20:13 +0900897 ctx.OtherModuleName(to))
898 }
Jiyong Park2d492942018-03-05 17:44:10 +0900899 break
900 case javaSdk:
901 if otherLinkType != javaCore && otherLinkType != javaSdk {
902 ctx.ModuleErrorf("compiles against Android API, but dependency %q is compiling against non-public Android API."+commonMessage,
903 ctx.OtherModuleName(to))
904 }
905 break
906 case javaSystem:
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900907 if otherLinkType == javaPlatform || otherLinkType == javaModule || otherLinkType == javaSystemServer {
Jiyong Park2d492942018-03-05 17:44:10 +0900908 ctx.ModuleErrorf("compiles against system API, but dependency %q is compiling against private API."+commonMessage,
909 ctx.OtherModuleName(to))
910 }
911 break
Jiyong Park50146e92020-01-30 18:00:15 +0900912 case javaModule:
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900913 if otherLinkType == javaPlatform || otherLinkType == javaSystemServer {
Jiyong Park50146e92020-01-30 18:00:15 +0900914 ctx.ModuleErrorf("compiles against module API, but dependency %q is compiling against private API."+commonMessage,
915 ctx.OtherModuleName(to))
916 }
917 break
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900918 case javaSystemServer:
919 if otherLinkType == javaPlatform {
920 ctx.ModuleErrorf("compiles against system server API, but dependency %q is compiling against private API."+commonMessage,
921 ctx.OtherModuleName(to))
922 }
923 break
Jiyong Park2d492942018-03-05 17:44:10 +0900924 case javaPlatform:
925 // no restriction on link-type
926 break
Jiyong Park750e5572018-01-31 00:20:13 +0900927 }
928}
929
Colin Cross32f676a2017-09-06 13:41:06 -0700930func (j *Module) collectDeps(ctx android.ModuleContext) deps {
931 var deps deps
Colin Crossfc3674a2017-09-18 17:41:52 -0700932
Colin Cross300f0382018-03-06 13:11:51 -0800933 if ctx.Device() {
Colin Cross83bb3162018-06-25 15:48:06 -0700934 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Cross300f0382018-03-06 13:11:51 -0800935 if sdkDep.invalidVersion {
Colin Cross6cef4812019-10-17 14:23:50 -0700936 ctx.AddMissingDependencies(sdkDep.bootclasspath)
937 ctx.AddMissingDependencies(sdkDep.java9Classpath)
Colin Cross300f0382018-03-06 13:11:51 -0800938 } else if sdkDep.useFiles {
939 // sdkDep.jar is actually equivalent to turbine header.jar.
Colin Cross86a60ae2018-05-29 14:44:55 -0700940 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross3047fa22019-04-18 10:56:44 -0700941 deps.aidlPreprocess = sdkDep.aidl
942 } else {
943 deps.aidlPreprocess = sdkDep.aidl
Colin Cross300f0382018-03-06 13:11:51 -0800944 }
Colin Crossfc3674a2017-09-18 17:41:52 -0700945 }
946
Paul Duffin859fe962020-05-15 10:20:31 +0100947 // If this is a component library (stubs, etc.) for a java_sdk_library then
948 // add the name of that java_sdk_library to the exported sdk libs to make sure
949 // that, if necessary, a <uses-library> element for that java_sdk_library is
950 // added to the Android manifest.
951 j.exportedSdkLibs = append(j.exportedSdkLibs, j.OptionalImplicitSdkLibrary()...)
952
Colin Crossd11fcda2017-10-23 17:59:01 -0700953 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross2fe66872015-03-30 17:20:39 -0700954 otherName := ctx.OtherModuleName(module)
Colin Crossec7a0422017-07-07 14:47:12 -0700955 tag := ctx.OtherModuleDependencyTag(module)
956
Colin Crossa4f08812018-10-02 22:03:40 -0700957 if _, ok := tag.(*jniDependencyTag); ok {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700958 // Handled by AndroidApp.collectAppDeps
959 return
960 }
961 if tag == certificateTag {
962 // Handled by AndroidApp.collectAppDeps
Colin Crossa4f08812018-10-02 22:03:40 -0700963 return
964 }
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100965
Colin Cross54250902017-12-05 09:28:08 -0800966 switch dep := module.(type) {
Colin Cross897d2ed2019-02-11 14:03:51 -0800967 case SdkLibraryDependency:
968 switch tag {
969 case libTag:
970 deps.classpath = append(deps.classpath, dep.SdkHeaderJars(ctx, j.sdkVersion())...)
971 // names of sdk libs that are directly depended are exported
Paul Duffin859fe962020-05-15 10:20:31 +0100972 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.OptionalImplicitSdkLibrary()...)
Colin Cross79c7c262019-04-17 11:11:46 -0700973 case staticLibTag:
Colin Cross897d2ed2019-02-11 14:03:51 -0800974 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
975 }
Colin Cross54250902017-12-05 09:28:08 -0800976 case Dependency:
977 switch tag {
978 case bootClasspathTag:
979 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars()...)
Colin Cross4b964c02018-10-15 16:18:06 -0700980 case libTag, instrumentationForTag:
Colin Cross54250902017-12-05 09:28:08 -0800981 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +0900982 // sdk lib names from dependencies are re-exported
983 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -0700984 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Artur Satayev9cf46692019-11-26 18:08:34 +0000985 pluginJars, pluginClasses := dep.ExportedPlugins()
986 addPlugins(&deps, pluginJars, pluginClasses...)
Colin Cross6cef4812019-10-17 14:23:50 -0700987 case java9LibTag:
988 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars()...)
Colin Cross54250902017-12-05 09:28:08 -0800989 case staticLibTag:
990 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
991 deps.staticJars = append(deps.staticJars, dep.ImplementationJars()...)
992 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars()...)
Colin Cross331a1212018-08-15 20:40:52 -0700993 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +0900994 // sdk lib names from dependencies are re-exported
995 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -0700996 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Artur Satayev9cf46692019-11-26 18:08:34 +0000997 pluginJars, pluginClasses := dep.ExportedPlugins()
998 addPlugins(&deps, pluginJars, pluginClasses...)
Colin Crossbe9cdb82019-01-21 21:37:16 -0800999 case pluginTag:
1000 if plugin, ok := dep.(*Plugin); ok {
Colin Crossbe9cdb82019-01-21 21:37:16 -08001001 if plugin.pluginProperties.Processor_class != nil {
Artur Satayev9cf46692019-11-26 18:08:34 +00001002 addPlugins(&deps, plugin.ImplementationAndResourcesJars(), *plugin.pluginProperties.Processor_class)
1003 } else {
1004 addPlugins(&deps, plugin.ImplementationAndResourcesJars())
Colin Crossbe9cdb82019-01-21 21:37:16 -08001005 }
1006 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
1007 } else {
1008 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
1009 }
Artur Satayev9cf46692019-11-26 18:08:34 +00001010 case exportedPluginTag:
1011 if plugin, ok := dep.(*Plugin); ok {
1012 if plugin.pluginProperties.Generates_api != nil && *plugin.pluginProperties.Generates_api {
1013 ctx.PropertyErrorf("exported_plugins", "Cannot export plugins with generates_api = true, found %v", otherName)
1014 }
1015 j.exportedPluginJars = append(j.exportedPluginJars, plugin.ImplementationAndResourcesJars()...)
1016 if plugin.pluginProperties.Processor_class != nil {
1017 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
1018 }
1019 } else {
1020 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
1021 }
Nan Zhangb2b33de2018-02-23 11:18:47 -08001022 case frameworkApkTag:
1023 if ctx.ModuleName() == "android_stubs_current" ||
1024 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -07001025 ctx.ModuleName() == "android_test_stubs_current" {
Nan Zhangb2b33de2018-02-23 11:18:47 -08001026 // framework stubs.jar need to depend on framework-res.apk, in order to pull the
1027 // resource files out of there for aapt.
1028 //
1029 // Normally the package rule runs aapt, which includes the resource,
1030 // but we're not running that in our package rule so just copy in the
1031 // resource files here.
Colin Cross331a1212018-08-15 20:40:52 -07001032 deps.staticResourceJars = append(deps.staticResourceJars, dep.(*AndroidApp).exportPackage)
Nan Zhangb2b33de2018-02-23 11:18:47 -08001033 }
Colin Cross54250902017-12-05 09:28:08 -08001034 case kotlinStdlibTag:
Colin Cross0b03d972019-05-13 11:06:25 -07001035 deps.kotlinStdlib = append(deps.kotlinStdlib, dep.HeaderJars()...)
Colin Crossafbb1732019-01-17 15:42:52 -08001036 case kotlinAnnotationsTag:
1037 deps.kotlinAnnotations = dep.HeaderJars()
Colin Cross54250902017-12-05 09:28:08 -08001038 }
1039
Colin Cross54250902017-12-05 09:28:08 -08001040 case android.SourceFileProducer:
1041 switch tag {
1042 case libTag:
1043 checkProducesJars(ctx, dep)
1044 deps.classpath = append(deps.classpath, dep.Srcs()...)
1045 case staticLibTag:
1046 checkProducesJars(ctx, dep)
1047 deps.classpath = append(deps.classpath, dep.Srcs()...)
1048 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
1049 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Cross54250902017-12-05 09:28:08 -08001050 }
1051 default:
Colin Crossec7a0422017-07-07 14:47:12 -07001052 switch tag {
Paul Duffin68289b02019-09-20 13:50:52 +01001053 case bootClasspathTag:
1054 // If a system modules dependency has been added to the bootclasspath
1055 // then add its libs to the bootclasspath.
Paul Duffin83a2d962019-11-19 19:44:10 +00001056 sm := module.(SystemModulesProvider)
1057 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars()...)
Paul Duffin68289b02019-09-20 13:50:52 +01001058
Colin Cross1369cdb2017-09-29 17:58:17 -07001059 case systemModulesTag:
1060 if deps.systemModules != nil {
1061 panic("Found two system module dependencies")
1062 }
Paul Duffin83a2d962019-11-19 19:44:10 +00001063 sm := module.(SystemModulesProvider)
1064 outputDir, outputDeps := sm.OutputDirAndDeps()
1065 deps.systemModules = &systemModules{outputDir, outputDeps}
Colin Cross2fe66872015-03-30 17:20:39 -07001066 }
Colin Crossec7a0422017-07-07 14:47:12 -07001067 }
Colin Cross2fe66872015-03-30 17:20:39 -07001068 })
1069
Jiyong Park1be96912018-05-28 18:02:19 +09001070 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
1071
Colin Cross32f676a2017-09-06 13:41:06 -07001072 return deps
Colin Cross2fe66872015-03-30 17:20:39 -07001073}
1074
Artur Satayev9cf46692019-11-26 18:08:34 +00001075func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
1076 deps.processorPath = append(deps.processorPath, pluginJars...)
1077 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
1078}
1079
Colin Cross1e743852019-10-28 11:37:20 -07001080func getJavaVersion(ctx android.ModuleContext, javaVersion string, sdkContext sdkContext) javaVersion {
Nan Zhang357466b2018-04-17 17:38:36 -07001081 if javaVersion != "" {
Colin Cross1e743852019-10-28 11:37:20 -07001082 return normalizeJavaVersion(ctx, javaVersion)
Colin Cross17dec172020-05-14 18:05:32 -07001083 } else if ctx.Device() {
1084 return sdkContext.sdkVersion().defaultJavaLanguageVersion(ctx)
Nan Zhang357466b2018-04-17 17:38:36 -07001085 } else {
Colin Cross1e743852019-10-28 11:37:20 -07001086 return JAVA_VERSION_9
Nan Zhang357466b2018-04-17 17:38:36 -07001087 }
Nan Zhang357466b2018-04-17 17:38:36 -07001088}
1089
Colin Cross1e743852019-10-28 11:37:20 -07001090type javaVersion int
1091
1092const (
1093 JAVA_VERSION_UNSUPPORTED = 0
1094 JAVA_VERSION_6 = 6
1095 JAVA_VERSION_7 = 7
1096 JAVA_VERSION_8 = 8
1097 JAVA_VERSION_9 = 9
1098)
1099
1100func (v javaVersion) String() string {
1101 switch v {
1102 case JAVA_VERSION_6:
1103 return "1.6"
1104 case JAVA_VERSION_7:
1105 return "1.7"
1106 case JAVA_VERSION_8:
1107 return "1.8"
1108 case JAVA_VERSION_9:
1109 return "1.9"
1110 default:
1111 return "unsupported"
1112 }
1113}
1114
1115// Returns true if javac targeting this version uses system modules instead of a bootclasspath.
1116func (v javaVersion) usesJavaModules() bool {
1117 return v >= 9
1118}
1119
1120func normalizeJavaVersion(ctx android.BaseModuleContext, javaVersion string) javaVersion {
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001121 switch javaVersion {
1122 case "1.6", "6":
Colin Cross1e743852019-10-28 11:37:20 -07001123 return JAVA_VERSION_6
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001124 case "1.7", "7":
Colin Cross1e743852019-10-28 11:37:20 -07001125 return JAVA_VERSION_7
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001126 case "1.8", "8":
Colin Cross1e743852019-10-28 11:37:20 -07001127 return JAVA_VERSION_8
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001128 case "1.9", "9":
Colin Cross1e743852019-10-28 11:37:20 -07001129 return JAVA_VERSION_9
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001130 case "10", "11":
1131 ctx.PropertyErrorf("java_version", "Java language levels above 9 are not supported")
Colin Cross1e743852019-10-28 11:37:20 -07001132 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001133 default:
1134 ctx.PropertyErrorf("java_version", "Unrecognized Java language level")
Colin Cross1e743852019-10-28 11:37:20 -07001135 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001136 }
1137}
1138
Nan Zhanged19fc32017-10-19 13:06:22 -07001139func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
Colin Crossc0b06f12015-04-08 13:03:43 -07001140
Colin Crossf03c82b2015-04-13 13:53:40 -07001141 var flags javaBuilderFlags
1142
Tobias Thierer06dd04f2018-09-11 16:21:05 +01001143 // javaVersion flag.
1144 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), sdkContext(j))
1145
Nan Zhanged19fc32017-10-19 13:06:22 -07001146 // javac flags.
Colin Crossf03c82b2015-04-13 13:53:40 -07001147 javacFlags := j.properties.Javacflags
Colin Cross1e743852019-10-28 11:37:20 -07001148 if flags.javaVersion.usesJavaModules() {
Colin Cross1369cdb2017-09-29 17:58:17 -07001149 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Nan Zhanged19fc32017-10-19 13:06:22 -07001150 }
Colin Cross6510f912017-11-29 00:27:14 -08001151 if ctx.Config().MinimizeJavaDebugInfo() {
Colin Cross126a25c2017-10-31 13:55:34 -07001152 // Override the -g flag passed globally to remove local variable debug info to reduce
1153 // disk and memory usage.
1154 javacFlags = append(javacFlags, "-g:source,lines")
1155 }
Colin Crossc228a702019-11-06 16:18:05 -08001156 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
Colin Cross64162712017-08-08 13:17:59 -07001157
Colin Cross66548102018-06-19 22:47:35 -07001158 if ctx.Config().RunErrorProne() {
1159 if config.ErrorProneClasspath == nil {
1160 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1161 }
1162
1163 errorProneFlags := []string{
1164 "-Xplugin:ErrorProne",
1165 "${config.ErrorProneChecks}",
1166 }
1167 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1168
1169 flags.errorProneExtraJavacFlags = "${config.ErrorProneFlags} " +
1170 "'" + strings.Join(errorProneFlags, " ") + "'"
1171 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
Andreas Gampef3e5b552018-01-22 21:27:21 -08001172 }
1173
Nan Zhanged19fc32017-10-19 13:06:22 -07001174 // classpath
Nan Zhang581fd212018-01-10 16:06:12 -08001175 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1176 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross6cef4812019-10-17 14:23:50 -07001177 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
Colin Cross6a77c982018-06-19 22:43:34 -07001178 flags.processorPath = append(flags.processorPath, deps.processorPath...)
Colin Cross7fdd2b72018-01-02 18:14:25 -08001179
Colin Cross5a116862020-04-22 11:44:34 -07001180 flags.processors = append(flags.processors, deps.processorClasses...)
1181 flags.processors = android.FirstUniqueStrings(flags.processors)
Colin Crossbe9cdb82019-01-21 21:37:16 -08001182
Colin Cross1e743852019-10-28 11:37:20 -07001183 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
1184 decodeSdkDep(ctx, sdkContext(j)).hasStandardLibs() {
Colin Cross7fdd2b72018-01-02 18:14:25 -08001185 // Give host-side tools a version of OpenJDK's standard libraries
1186 // close to what they're targeting. As of Dec 2017, AOSP is only
1187 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1188 //
1189 // When building with OpenJDK 8, the following should have no
1190 // effect since those jars would be available by default.
1191 //
1192 // When building with OpenJDK 9 but targeting a version < 1.8,
1193 // putting them on the bootclasspath means that:
1194 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1195 // b) references to existing APIs are not reinterpreted in an
1196 // OpenJDK 9-specific way, eg. calls to subclasses of
1197 // java.nio.Buffer as in http://b/70862583
1198 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1199 flags.bootClasspath = append(flags.bootClasspath,
1200 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1201 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
Nan Zhang5f8cb422018-02-06 10:34:32 -08001202 if Bool(j.properties.Use_tools_jar) {
1203 flags.bootClasspath = append(flags.bootClasspath,
1204 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1205 }
Colin Cross7fdd2b72018-01-02 18:14:25 -08001206 }
1207
Colin Cross1e743852019-10-28 11:37:20 -07001208 if j.properties.Patch_module != nil && flags.javaVersion.usesJavaModules() {
Jaewoong Jung38e4fb22018-12-12 09:01:34 -08001209 // Manually specify build directory in case it is not under the repo root.
1210 // (javac doesn't seem to expand into symbolc links when searching for patch-module targets, so
1211 // just adding a symlink under the root doesn't help.)
1212 patchPaths := ".:" + ctx.Config().BuildDir()
1213 classPath := flags.classpath.FormJavaClassPath("")
1214 if classPath != "" {
1215 patchPaths += ":" + classPath
1216 }
1217 javacFlags = append(javacFlags, "--patch-module="+String(j.properties.Patch_module)+"="+patchPaths)
Colin Cross81440082018-08-15 20:21:55 -07001218 }
1219
Nan Zhanged19fc32017-10-19 13:06:22 -07001220 // systemModules
Colin Crossb77043e2019-07-16 13:57:13 -07001221 flags.systemModules = deps.systemModules
Colin Cross1369cdb2017-09-29 17:58:17 -07001222
Nan Zhanged19fc32017-10-19 13:06:22 -07001223 // aidl flags.
Colin Cross3047fa22019-04-18 10:56:44 -07001224 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs)
Colin Cross2fe66872015-03-30 17:20:39 -07001225
Colin Cross81440082018-08-15 20:21:55 -07001226 if len(javacFlags) > 0 {
1227 // optimization.
1228 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1229 flags.javacFlags = "$javacFlags"
1230 }
1231
Nan Zhanged19fc32017-10-19 13:06:22 -07001232 return flags
1233}
Colin Crossc0b06f12015-04-08 13:03:43 -07001234
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001235func (j *Module) compile(ctx android.ModuleContext, aaptSrcJar android.Path) {
Colin Crossebe1a512017-11-14 13:12:14 -08001236 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
Nan Zhanged19fc32017-10-19 13:06:22 -07001237
1238 deps := j.collectDeps(ctx)
1239 flags := j.collectBuilderFlags(ctx, deps)
1240
Colin Cross1e743852019-10-28 11:37:20 -07001241 if flags.javaVersion.usesJavaModules() {
Nan Zhanged19fc32017-10-19 13:06:22 -07001242 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
1243 }
Colin Cross8a497952019-03-05 22:25:09 -08001244 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Colin Cross6af17aa2017-09-20 12:59:05 -07001245 if hasSrcExt(srcFiles.Strings(), ".proto") {
Colin Cross0f2ee152017-12-14 15:22:43 -08001246 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
Colin Cross6af17aa2017-09-20 12:59:05 -07001247 }
1248
Colin Crossaf050172017-11-15 23:01:59 -08001249 srcFiles = j.genSources(ctx, srcFiles, flags)
1250
1251 srcJars := srcFiles.FilterByExt(".srcjar")
Colin Cross59149b62017-10-16 18:07:29 -07001252 srcJars = append(srcJars, deps.srcJars...)
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001253 if aaptSrcJar != nil {
1254 srcJars = append(srcJars, aaptSrcJar)
1255 }
Colin Crossb7a63242015-04-16 14:09:14 -07001256
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001257 if j.properties.Jarjar_rules != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001258 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001259 }
1260
Colin Cross1ee23172017-10-18 14:44:18 -07001261 jarName := ctx.ModuleName() + ".jar"
1262
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001263 javaSrcFiles := srcFiles.FilterByExt(".java")
1264 var uniqueSrcFiles android.Paths
1265 set := make(map[string]bool)
1266 for _, v := range javaSrcFiles {
1267 if _, found := set[v.String()]; !found {
1268 set[v.String()] = true
1269 uniqueSrcFiles = append(uniqueSrcFiles, v)
1270 }
1271 }
1272
patricktu242faad2019-09-24 15:41:30 +08001273 // Collect .java files for AIDEGen
1274 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1275
Colin Cross55f63ea2018-08-27 12:37:09 -07001276 var kotlinJars android.Paths
1277
Colin Cross93e85952017-08-15 13:34:18 -07001278 if srcFiles.HasExt(".kt") {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001279 // user defined kotlin flags.
1280 kotlincFlags := j.properties.Kotlincflags
1281 CheckKotlincFlags(ctx, kotlincFlags)
1282
Colin Cross93e85952017-08-15 13:34:18 -07001283 // If there are kotlin files, compile them first but pass all the kotlin and java files
1284 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1285 // won't emit any classes for them.
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001286 kotlincFlags = append(kotlincFlags, "-no-stdlib")
Colin Cross93e85952017-08-15 13:34:18 -07001287 if ctx.Device() {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001288 kotlincFlags = append(kotlincFlags, "-no-jdk")
1289 }
1290 if len(kotlincFlags) > 0 {
1291 // optimization.
1292 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1293 flags.kotlincFlags += "$kotlincFlags"
Colin Cross93e85952017-08-15 13:34:18 -07001294 }
1295
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001296 var kotlinSrcFiles android.Paths
1297 kotlinSrcFiles = append(kotlinSrcFiles, uniqueSrcFiles...)
1298 kotlinSrcFiles = append(kotlinSrcFiles, srcFiles.FilterByExt(".kt")...)
1299
patricktu242faad2019-09-24 15:41:30 +08001300 // Collect .kt files for AIDEGen
1301 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, srcFiles.FilterByExt(".kt").Strings()...)
1302
Colin Crossafbb1732019-01-17 15:42:52 -08001303 flags.classpath = append(flags.classpath, deps.kotlinStdlib...)
1304 flags.classpath = append(flags.classpath, deps.kotlinAnnotations...)
1305
1306 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1307 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1308
1309 if len(flags.processorPath) > 0 {
1310 // Use kapt for annotation processing
1311 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1312 kotlinKapt(ctx, kaptSrcJar, kotlinSrcFiles, srcJars, flags)
1313 srcJars = append(srcJars, kaptSrcJar)
1314 // Disable annotation processing in javac, it's already been handled by kapt
1315 flags.processorPath = nil
Colin Cross5a116862020-04-22 11:44:34 -07001316 flags.processors = nil
Colin Crossafbb1732019-01-17 15:42:52 -08001317 }
Colin Cross93e85952017-08-15 13:34:18 -07001318
Colin Cross1ee23172017-10-18 14:44:18 -07001319 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross21fc9bb2019-01-18 15:05:09 -08001320 kotlinCompile(ctx, kotlinJar, kotlinSrcFiles, srcJars, flags)
Colin Cross93e85952017-08-15 13:34:18 -07001321 if ctx.Failed() {
1322 return
1323 }
1324
1325 // Make javac rule depend on the kotlinc rule
1326 flags.classpath = append(flags.classpath, kotlinJar)
Przemyslaw Szczepaniak66c0c402018-03-08 13:21:55 +00001327
Colin Cross93e85952017-08-15 13:34:18 -07001328 // Jar kotlin classes into the final jar after javac
Colin Cross55f63ea2018-08-27 12:37:09 -07001329 kotlinJars = append(kotlinJars, kotlinJar)
Colin Cross9b38aef2018-08-27 15:42:25 -07001330 kotlinJars = append(kotlinJars, deps.kotlinStdlib...)
Colin Cross93e85952017-08-15 13:34:18 -07001331 }
1332
Colin Cross55f63ea2018-08-27 12:37:09 -07001333 jars := append(android.Paths(nil), kotlinJars...)
1334
Colin Cross5ab4e6d2017-11-22 16:20:45 -08001335 // Store the list of .java files that was passed to javac
1336 j.compiledJavaSrcs = uniqueSrcFiles
1337 j.compiledSrcJars = srcJars
1338
Nan Zhang61eaedb2017-11-02 13:28:15 -07001339 enable_sharding := false
Colin Crossf7d84012020-02-21 08:16:41 -08001340 var headerJarFileWithoutJarjar android.Path
Colin Crossbe9cdb82019-01-21 21:37:16 -08001341 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !deps.disableTurbine {
Nan Zhang61eaedb2017-11-02 13:28:15 -07001342 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1343 enable_sharding = true
Ashley Rosee36efcf2019-01-16 17:34:08 -05001344 // Formerly, there was a check here that prevented annotation processors
1345 // from being used when sharding was enabled, as some annotation processors
1346 // do not function correctly in sharded environments. It was removed to
1347 // allow for the use of annotation processors that do function correctly
1348 // with sharding enabled. See: b/77284273.
Nan Zhang61eaedb2017-11-02 13:28:15 -07001349 }
Colin Crossf7d84012020-02-21 08:16:41 -08001350 headerJarFileWithoutJarjar, j.headerJarFile =
1351 j.compileJavaHeader(ctx, uniqueSrcFiles, srcJars, deps, flags, jarName, kotlinJars)
Colin Crossf19b9bb2018-03-26 14:42:44 -07001352 if ctx.Failed() {
1353 return
Nan Zhanged19fc32017-10-19 13:06:22 -07001354 }
1355 }
Colin Cross8eadbf02017-10-24 17:46:00 -07001356 if len(uniqueSrcFiles) > 0 || len(srcJars) > 0 {
Colin Crossd6891432017-09-27 17:39:56 -07001357 var extraJarDeps android.Paths
Colin Cross66548102018-06-19 22:47:35 -07001358 if ctx.Config().RunErrorProne() {
Colin Crossc6bbef32017-08-14 14:16:06 -07001359 // If error-prone is enabled, add an additional rule to compile the java files into
1360 // a separate set of classes (so that they don't overwrite the normal ones and require
Colin Crossd6891432017-09-27 17:39:56 -07001361 // a rebuild when error-prone is turned off).
Colin Crossc6bbef32017-08-14 14:16:06 -07001362 // TODO(ccross): Once we always compile with javac9 we may be able to conditionally
1363 // enable error-prone without affecting the output class files.
Colin Cross1ee23172017-10-18 14:44:18 -07001364 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001365 RunErrorProne(ctx, errorprone, uniqueSrcFiles, srcJars, flags)
Colin Crossc6bbef32017-08-14 14:16:06 -07001366 extraJarDeps = append(extraJarDeps, errorprone)
1367 }
1368
Nan Zhang61eaedb2017-11-02 13:28:15 -07001369 if enable_sharding {
Colin Crossf7d84012020-02-21 08:16:41 -08001370 flags.classpath = append(flags.classpath, headerJarFileWithoutJarjar)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001371 shardSize := int(*(j.properties.Javac_shard_size))
1372 var shardSrcs []android.Paths
1373 if len(uniqueSrcFiles) > 0 {
Colin Cross0a2f7192019-09-23 14:33:09 -07001374 shardSrcs = android.ShardPaths(uniqueSrcFiles, shardSize)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001375 for idx, shardSrc := range shardSrcs {
Colin Cross3b706fd2019-09-05 16:44:18 -07001376 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1377 nil, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001378 jars = append(jars, classes)
1379 }
1380 }
1381 if len(srcJars) > 0 {
Colin Cross3b706fd2019-09-05 16:44:18 -07001382 classes := j.compileJavaClasses(ctx, jarName, len(shardSrcs),
1383 nil, srcJars, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001384 jars = append(jars, classes)
1385 }
1386 } else {
Colin Cross3b706fd2019-09-05 16:44:18 -07001387 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueSrcFiles, srcJars, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001388 jars = append(jars, classes)
1389 }
Colin Crossd6891432017-09-27 17:39:56 -07001390 if ctx.Failed() {
1391 return
1392 }
Colin Cross2fe66872015-03-30 17:20:39 -07001393 }
1394
Colin Cross0c4ce212019-05-03 15:28:19 -07001395 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1396
1397 var includeSrcJar android.WritablePath
1398 if Bool(j.properties.Include_srcs) {
1399 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1400 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1401 }
1402
Colin Crosscedd4762018-09-13 11:26:19 -07001403 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1404 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
Colin Cross0f37af02017-09-27 17:42:05 -07001405 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
Colin Cross988708c2019-05-06 14:04:11 -07001406 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
Colin Cross0f37af02017-09-27 17:42:05 -07001407
1408 var resArgs []string
1409 var resDeps android.Paths
1410
1411 resArgs = append(resArgs, dirArgs...)
1412 resDeps = append(resDeps, dirDeps...)
1413
1414 resArgs = append(resArgs, fileArgs...)
1415 resDeps = append(resDeps, fileDeps...)
1416
Colin Cross988708c2019-05-06 14:04:11 -07001417 resArgs = append(resArgs, extraArgs...)
1418 resDeps = append(resDeps, extraDeps...)
1419
Colin Cross40a36712017-09-27 17:41:35 -07001420 if len(resArgs) > 0 {
Colin Cross1ee23172017-10-18 14:44:18 -07001421 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
Colin Crosse9a275b2017-10-16 17:09:48 -07001422 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Colin Cross331a1212018-08-15 20:40:52 -07001423 j.resourceJar = resourceJar
Colin Cross65bf4f22015-04-03 16:54:17 -07001424 if ctx.Failed() {
1425 return
1426 }
1427 }
1428
Colin Cross0c4ce212019-05-03 15:28:19 -07001429 var resourceJars android.Paths
1430 if j.resourceJar != nil {
1431 resourceJars = append(resourceJars, j.resourceJar)
1432 }
1433 if Bool(j.properties.Include_srcs) {
1434 resourceJars = append(resourceJars, includeSrcJar)
1435 }
1436 resourceJars = append(resourceJars, deps.staticResourceJars...)
Colin Cross331a1212018-08-15 20:40:52 -07001437
Colin Cross0c4ce212019-05-03 15:28:19 -07001438 if len(resourceJars) > 1 {
Colin Cross331a1212018-08-15 20:40:52 -07001439 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
Colin Cross0c4ce212019-05-03 15:28:19 -07001440 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
Colin Cross331a1212018-08-15 20:40:52 -07001441 false, nil, nil)
1442 j.resourceJar = combinedJar
Colin Cross0c4ce212019-05-03 15:28:19 -07001443 } else if len(resourceJars) == 1 {
1444 j.resourceJar = resourceJars[0]
Colin Cross331a1212018-08-15 20:40:52 -07001445 }
1446
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001447 if len(deps.staticJars) > 0 {
1448 jars = append(jars, deps.staticJars...)
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001449 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001450
Colin Cross094054a2018-10-17 15:10:48 -07001451 manifest := j.overrideManifest
1452 if !manifest.Valid() && j.properties.Manifest != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001453 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Colin Cross366938f2017-12-11 16:29:02 -08001454 }
Colin Cross635acc92017-09-12 22:50:46 -07001455
Colin Cross8a497952019-03-05 22:25:09 -08001456 services := android.PathsForModuleSrc(ctx, j.properties.Services)
Alex Light7f004a72019-02-21 13:27:37 -08001457 if len(services) > 0 {
1458 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1459 var zipargs []string
1460 for _, file := range services {
1461 serviceFile := file.String()
1462 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1463 }
Kousik Kumar366afc52020-05-20 11:27:16 -07001464 rule := zip
1465 args := map[string]string{
1466 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1467 }
1468 if ctx.Config().IsEnvTrue("RBE_ZIP") {
1469 rule = zipRE
1470 args["implicits"] = strings.Join(services.Strings(), ",")
1471 }
Alex Light7f004a72019-02-21 13:27:37 -08001472 ctx.Build(pctx, android.BuildParams{
Kousik Kumar366afc52020-05-20 11:27:16 -07001473 Rule: rule,
Alex Light7f004a72019-02-21 13:27:37 -08001474 Output: servicesJar,
1475 Implicits: services,
Kousik Kumar366afc52020-05-20 11:27:16 -07001476 Args: args,
Alex Light7f004a72019-02-21 13:27:37 -08001477 })
1478 jars = append(jars, servicesJar)
1479 }
1480
Colin Cross0a6e0072017-08-30 14:24:55 -07001481 // Combine the classes built from sources, any manifests, and any static libraries into
Nan Zhanged19fc32017-10-19 13:06:22 -07001482 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross3063b782018-08-15 11:19:12 -07001483 var outputFile android.ModuleOutPath
Colin Crosse9a275b2017-10-16 17:09:48 -07001484
1485 if len(jars) == 1 && !manifest.Valid() {
Colin Cross3063b782018-08-15 11:19:12 -07001486 if moduleOutPath, ok := jars[0].(android.ModuleOutPath); ok {
1487 // Optimization: skip the combine step if there is nothing to do
1488 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1489 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1490 // any if len(jars) == 1.
1491 outputFile = moduleOutPath
1492 } else {
1493 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1494 ctx.Build(pctx, android.BuildParams{
1495 Rule: android.Cp,
1496 Input: jars[0],
1497 Output: combinedJar,
1498 })
1499 outputFile = combinedJar
1500 }
Colin Crosse9a275b2017-10-16 17:09:48 -07001501 } else {
Colin Cross1ee23172017-10-18 14:44:18 -07001502 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001503 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
Colin Cross9b38aef2018-08-27 15:42:25 -07001504 false, nil, nil)
Colin Crosse9a275b2017-10-16 17:09:48 -07001505 outputFile = combinedJar
1506 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001507
Colin Cross331a1212018-08-15 20:40:52 -07001508 // jarjar implementation jar if necessary
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001509 if j.expandJarjarRules != nil {
Colin Cross8649b262017-09-27 18:03:17 -07001510 // Transform classes.jar into classes-jarjar.jar
Colin Cross1ee23172017-10-18 14:44:18 -07001511 jarjarFile := android.PathForModuleOut(ctx, "jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001512 TransformJarJar(ctx, jarjarFile, outputFile, j.expandJarjarRules)
Colin Crosse9a275b2017-10-16 17:09:48 -07001513 outputFile = jarjarFile
Colin Cross331a1212018-08-15 20:40:52 -07001514
1515 // jarjar resource jar if necessary
1516 if j.resourceJar != nil {
1517 resourceJarJarFile := android.PathForModuleOut(ctx, "res-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001518 TransformJarJar(ctx, resourceJarJarFile, j.resourceJar, j.expandJarjarRules)
Colin Cross331a1212018-08-15 20:40:52 -07001519 j.resourceJar = resourceJarJarFile
1520 }
1521
Colin Cross0a6e0072017-08-30 14:24:55 -07001522 if ctx.Failed() {
1523 return
1524 }
1525 }
Vladimir Marko0975ee02019-04-02 10:29:55 +01001526
1527 // Check package restrictions if necessary.
1528 if len(j.properties.Permitted_packages) > 0 {
1529 // Check packages and copy to package-checked file.
1530 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
1531 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
1532 j.additionalCheckedModules = append(j.additionalCheckedModules, pkgckFile)
1533
1534 if ctx.Failed() {
1535 return
1536 }
1537 }
1538
Nan Zhanged19fc32017-10-19 13:06:22 -07001539 j.implementationJarFile = outputFile
1540 if j.headerJarFile == nil {
1541 j.headerJarFile = j.implementationJarFile
1542 }
Colin Cross2fe66872015-03-30 17:20:39 -07001543
Jiyong Park93e57a02020-02-21 16:04:53 +09001544 // Force enable the instrumentation for java code that is built for APEXes ...
1545 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
1546 // doesn't make sense)
1547 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
1548 if android.DirectlyInAnyApex(ctx, ctx.ModuleName()) && !isJacocoAgent && !j.IsForPlatform() {
Jiyong Park00cae1c2020-02-18 12:50:44 +00001549 j.properties.Instrument = true
1550 }
1551
Colin Cross3144dfc2018-01-03 15:06:47 -08001552 if j.shouldInstrument(ctx) {
Colin Crosscb933592017-11-22 13:49:43 -08001553 outputFile = j.instrument(ctx, flags, outputFile, jarName)
1554 }
1555
Colin Cross331a1212018-08-15 20:40:52 -07001556 // merge implementation jar with resources if necessary
1557 implementationAndResourcesJar := outputFile
1558 if j.resourceJar != nil {
Colin Cross08a409d2019-04-29 10:22:44 -07001559 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
Colin Cross331a1212018-08-15 20:40:52 -07001560 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
Colin Cross08a409d2019-04-29 10:22:44 -07001561 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
Colin Cross331a1212018-08-15 20:40:52 -07001562 false, nil, nil)
1563 implementationAndResourcesJar = combinedJar
1564 }
1565
1566 j.implementationAndResourcesJar = implementationAndResourcesJar
1567
Jiyong Park6b21c7d2020-02-11 09:16:01 +09001568 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
1569 if android.DirectlyInAnyApex(ctx, ctx.ModuleName()) && !j.IsForPlatform() {
1570 if j.deviceProperties.Compile_dex == nil {
1571 j.deviceProperties.Compile_dex = proptools.BoolPtr(true)
1572 }
1573 if j.deviceProperties.Hostdex == nil {
1574 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1575 }
1576 }
1577
Jaewoong Jungc27ab662019-05-30 15:51:14 -07001578 if ctx.Device() && j.hasCode(ctx) &&
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001579 (Bool(j.properties.Installable) || Bool(j.deviceProperties.Compile_dex)) {
Colin Cross8faf8fc2019-01-16 15:15:52 -08001580 // Dex compilation
Colin Cross3063b782018-08-15 11:19:12 -07001581 var dexOutputFile android.ModuleOutPath
David Brazdil17ef5632018-06-27 10:27:45 +01001582 dexOutputFile = j.compileDex(ctx, flags, outputFile, jarName)
Colin Cross2fe66872015-03-30 17:20:39 -07001583 if ctx.Failed() {
1584 return
1585 }
Colin Cross331a1212018-08-15 20:40:52 -07001586
Jiyong Park09cb6292019-07-15 15:29:23 +09001587 // Hidden API CSV generation and dex encoding
1588 dexOutputFile = j.hiddenAPI.hiddenAPI(ctx, dexOutputFile, j.implementationJarFile,
David Srbeckye033cba2020-05-20 22:20:28 +01001589 proptools.Bool(j.deviceProperties.Uncompress_dex))
Colin Cross8faf8fc2019-01-16 15:15:52 -08001590
Colin Cross331a1212018-08-15 20:40:52 -07001591 // merge dex jar with resources if necessary
1592 if j.resourceJar != nil {
1593 jars := android.Paths{dexOutputFile, j.resourceJar}
1594 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
1595 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1596 false, nil, nil)
David Srbeckye033cba2020-05-20 22:20:28 +01001597 if *j.deviceProperties.Uncompress_dex {
Nicolas Geoffrayf3438722019-01-23 15:57:21 +00001598 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
1599 TransformZipAlign(ctx, combinedAlignedJar, combinedJar)
1600 dexOutputFile = combinedAlignedJar
1601 } else {
1602 dexOutputFile = combinedJar
1603 }
Colin Cross331a1212018-08-15 20:40:52 -07001604 }
1605
1606 j.dexJarFile = dexOutputFile
1607
Colin Cross8faf8fc2019-01-16 15:15:52 -08001608 // Dexpreopting
Colin Cross43f08db2018-11-12 10:13:39 -08001609 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
1610
1611 j.maybeStrippedDexJarFile = dexOutputFile
1612
Colin Cross3063b782018-08-15 11:19:12 -07001613 outputFile = dexOutputFile
Colin Cross43f08db2018-11-12 10:13:39 -08001614
1615 if ctx.Failed() {
1616 return
1617 }
Colin Cross331a1212018-08-15 20:40:52 -07001618 } else {
1619 outputFile = implementationAndResourcesJar
Colin Cross2fe66872015-03-30 17:20:39 -07001620 }
Colin Cross331a1212018-08-15 20:40:52 -07001621
Colin Crossb7a63242015-04-16 14:09:14 -07001622 ctx.CheckbuildFile(outputFile)
Colin Cross3063b782018-08-15 11:19:12 -07001623
1624 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1625 j.outputFile = outputFile.WithoutRel()
Colin Cross2fe66872015-03-30 17:20:39 -07001626}
1627
Colin Cross3b706fd2019-09-05 16:44:18 -07001628func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
1629 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.WritablePath {
1630
1631 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
1632 if idx >= 0 {
1633 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
1634 jarName += strconv.Itoa(idx)
1635 }
1636
1637 classes := android.PathForModuleOut(ctx, "javac", jarName)
1638 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, flags, extraJarDeps)
1639
1640 if ctx.Config().EmitXrefRules() {
1641 extractionFile := android.PathForModuleOut(ctx, kzipName)
1642 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
1643 j.kytheFiles = append(j.kytheFiles, extractionFile)
1644 }
1645
1646 return classes
1647}
1648
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001649// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1650// since some of these flags may be used internally.
1651func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1652 for _, flag := range flags {
1653 flag = strings.TrimSpace(flag)
1654
1655 if !strings.HasPrefix(flag, "-") {
1656 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1657 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1658 ctx.PropertyErrorf("kotlincflags",
1659 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1660 } else if inList(flag, config.KotlincIllegalFlags) {
1661 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1662 } else if flag == "-include-runtime" {
1663 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1664 } else {
1665 args := strings.Split(flag, " ")
1666 if args[0] == "-kotlin-home" {
1667 ctx.PropertyErrorf("kotlincflags",
1668 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1669 }
1670 }
1671 }
1672}
1673
Colin Cross8eadbf02017-10-24 17:46:00 -07001674func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
Colin Crossf7d84012020-02-21 08:16:41 -08001675 deps deps, flags javaBuilderFlags, jarName string,
1676 extraJars android.Paths) (headerJar, jarjarHeaderJar android.Path) {
Nan Zhanged19fc32017-10-19 13:06:22 -07001677
1678 var jars android.Paths
Colin Cross8eadbf02017-10-24 17:46:00 -07001679 if len(srcFiles) > 0 || len(srcJars) > 0 {
Nan Zhanged19fc32017-10-19 13:06:22 -07001680 // Compile java sources into turbine.jar.
1681 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1682 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
1683 if ctx.Failed() {
Colin Crossf7d84012020-02-21 08:16:41 -08001684 return nil, nil
Nan Zhanged19fc32017-10-19 13:06:22 -07001685 }
1686 jars = append(jars, turbineJar)
1687 }
1688
Colin Cross55f63ea2018-08-27 12:37:09 -07001689 jars = append(jars, extraJars...)
1690
Nan Zhanged19fc32017-10-19 13:06:22 -07001691 // Combine any static header libraries into classes-header.jar. If there is only
1692 // one input jar this step will be skipped.
Nan Zhanged19fc32017-10-19 13:06:22 -07001693 jars = append(jars, deps.staticHeaderJars...)
1694
Colin Cross5c6ecc12017-10-23 18:12:27 -07001695 // we cannot skip the combine step for now if there is only one jar
1696 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
1697 combinedJar := android.PathForModuleOut(ctx, "turbine-combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001698 TransformJarsToJar(ctx, combinedJar, "for turbine", jars, android.OptionalPath{},
Colin Cross6c6e6cd2019-05-08 14:30:12 -07001699 false, nil, []string{"META-INF/TRANSITIVE"})
Colin Cross5c6ecc12017-10-23 18:12:27 -07001700 headerJar = combinedJar
Colin Crossf7d84012020-02-21 08:16:41 -08001701 jarjarHeaderJar = combinedJar
Nan Zhanged19fc32017-10-19 13:06:22 -07001702
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001703 if j.expandJarjarRules != nil {
Nan Zhanged19fc32017-10-19 13:06:22 -07001704 // Transform classes.jar into classes-jarjar.jar
1705 jarjarFile := android.PathForModuleOut(ctx, "turbine-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001706 TransformJarJar(ctx, jarjarFile, headerJar, j.expandJarjarRules)
Colin Crossf7d84012020-02-21 08:16:41 -08001707 jarjarHeaderJar = jarjarFile
Nan Zhanged19fc32017-10-19 13:06:22 -07001708 if ctx.Failed() {
Colin Crossf7d84012020-02-21 08:16:41 -08001709 return nil, nil
Nan Zhanged19fc32017-10-19 13:06:22 -07001710 }
1711 }
1712
Colin Crossf7d84012020-02-21 08:16:41 -08001713 return headerJar, jarjarHeaderJar
Nan Zhanged19fc32017-10-19 13:06:22 -07001714}
1715
Colin Crosscb933592017-11-22 13:49:43 -08001716func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross3063b782018-08-15 11:19:12 -07001717 classesJar android.Path, jarName string) android.ModuleOutPath {
Colin Crosscb933592017-11-22 13:49:43 -08001718
Colin Cross7a3139e2017-12-19 13:57:50 -08001719 specs := j.jacocoModuleToZipCommand(ctx)
Colin Crosscb933592017-11-22 13:49:43 -08001720
Colin Cross84c38822018-01-03 15:59:46 -08001721 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Crosscb933592017-11-22 13:49:43 -08001722 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
1723
1724 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1725
1726 j.jacocoReportClassesFile = jacocoReportClassesFile
1727
1728 return instrumentedJar
1729}
1730
albaltai36ff7dc2018-12-25 14:35:23 +08001731var _ Dependency = (*Module)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07001732
Nan Zhanged19fc32017-10-19 13:06:22 -07001733func (j *Module) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001734 if j.headerJarFile == nil {
1735 return nil
1736 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001737 return android.Paths{j.headerJarFile}
1738}
1739
1740func (j *Module) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08001741 if j.implementationJarFile == nil {
1742 return nil
1743 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001744 return android.Paths{j.implementationJarFile}
Colin Cross2fe66872015-03-30 17:20:39 -07001745}
1746
Ulyana Trafimovich5539e7b2020-06-04 14:08:17 +00001747func (j *Module) DexJarBuildPath() android.Path {
Colin Crossf24a22a2019-01-31 14:12:44 -08001748 return j.dexJarFile
1749}
1750
Colin Cross331a1212018-08-15 20:40:52 -07001751func (j *Module) ResourceJars() android.Paths {
1752 if j.resourceJar == nil {
1753 return nil
1754 }
1755 return android.Paths{j.resourceJar}
1756}
1757
1758func (j *Module) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001759 if j.implementationAndResourcesJar == nil {
1760 return nil
1761 }
Colin Cross331a1212018-08-15 20:40:52 -07001762 return android.Paths{j.implementationAndResourcesJar}
1763}
1764
Colin Cross46c9b8b2017-06-22 16:51:17 -07001765func (j *Module) AidlIncludeDirs() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001766 // exportAidlIncludeDirs is type android.Paths already
Colin Crossc0b06f12015-04-08 13:03:43 -07001767 return j.exportAidlIncludeDirs
1768}
1769
Jiyong Park1be96912018-05-28 18:02:19 +09001770func (j *Module) ExportedSdkLibs() []string {
albaltai36ff7dc2018-12-25 14:35:23 +08001771 // exportedSdkLibs is type []string
Jiyong Park1be96912018-05-28 18:02:19 +09001772 return j.exportedSdkLibs
1773}
1774
Artur Satayev9cf46692019-11-26 18:08:34 +00001775func (j *Module) ExportedPlugins() (android.Paths, []string) {
1776 return j.exportedPluginJars, j.exportedPluginClasses
1777}
1778
Colin Cross0c4ce212019-05-03 15:28:19 -07001779func (j *Module) SrcJarArgs() ([]string, android.Paths) {
1780 return j.srcJarArgs, j.srcJarDeps
1781}
1782
Colin Cross46c9b8b2017-06-22 16:51:17 -07001783var _ logtagsProducer = (*Module)(nil)
Colin Crossf05fe972015-04-10 17:45:20 -07001784
Colin Cross46c9b8b2017-06-22 16:51:17 -07001785func (j *Module) logtags() android.Paths {
Colin Crossf05fe972015-04-10 17:45:20 -07001786 return j.logtagsSrcs
1787}
1788
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001789// Collect information for opening IDE project files in java/jdeps.go.
1790func (j *Module) IDEInfo(dpInfo *android.IdeInfo) {
1791 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
1792 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
patricktu18c82ff2019-05-10 15:48:50 +08001793 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001794 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001795 if j.expandJarjarRules != nil {
1796 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001797 }
bralee1fbf4402020-05-21 10:11:59 +08001798 dpInfo.Paths = append(dpInfo.Paths, j.modulePaths...)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001799}
1800
1801func (j *Module) CompilerDeps() []string {
1802 jdeps := []string{}
1803 jdeps = append(jdeps, j.properties.Libs...)
1804 jdeps = append(jdeps, j.properties.Static_libs...)
1805 return jdeps
1806}
1807
Jaewoong Jungc27ab662019-05-30 15:51:14 -07001808func (j *Module) hasCode(ctx android.ModuleContext) bool {
1809 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
1810 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
1811}
1812
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09001813func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Paul Duffin0d3c2e12020-05-17 08:34:50 +01001814 return j.depIsInSameApex(ctx, dep)
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09001815}
1816
Jiyong Park0b238752019-10-29 11:23:10 +09001817func (j *Module) Stem() string {
1818 return proptools.StringDefault(j.deviceProperties.Stem, j.Name())
1819}
1820
Jiyong Park618922e2020-01-08 13:35:43 +09001821func (j *Module) JacocoReportClassesFile() android.Path {
1822 return j.jacocoReportClassesFile
1823}
1824
Martin Stjernholm6d415272020-01-31 17:10:36 +00001825func (j *Module) IsInstallable() bool {
1826 return Bool(j.properties.Installable)
1827}
1828
Colin Cross2fe66872015-03-30 17:20:39 -07001829//
1830// Java libraries (.jar file)
1831//
1832
Anton Hansson78156ef2020-03-27 19:39:48 +00001833type LibraryProperties struct {
1834 Dist struct {
1835 // The tag of the output of this module that should be output.
1836 Tag *string `android:"arch_variant"`
1837 } `android:"arch_variant"`
1838}
1839
Colin Crossf506d872017-07-19 15:53:04 -07001840type Library struct {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001841 Module
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001842
Anton Hansson78156ef2020-03-27 19:39:48 +00001843 libraryProperties LibraryProperties
1844
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001845 InstallMixin func(ctx android.ModuleContext, installPath android.Path) (extraInstallDeps android.Paths)
Colin Cross2fe66872015-03-30 17:20:39 -07001846}
1847
Paul Duffine739f1e2020-05-29 11:24:51 +01001848// Provides access to the list of permitted packages from updatable boot jars.
1849type PermittedPackagesForUpdatableBootJars interface {
1850 PermittedPackagesForUpdatableBootJars() []string
1851}
1852
1853var _ PermittedPackagesForUpdatableBootJars = (*Library)(nil)
1854
1855func (j *Library) PermittedPackagesForUpdatableBootJars() []string {
1856 return j.properties.Permitted_packages
1857}
1858
Colin Cross42be7612019-02-21 18:12:14 -08001859func shouldUncompressDex(ctx android.ModuleContext, dexpreopter *dexpreopter) bool {
Ulya Trafimovichf491dde2020-01-24 12:19:45 +00001860 // Store uncompressed (and aligned) any dex files from jars in APEXes.
1861 if am, ok := ctx.Module().(android.ApexModule); ok && !am.IsForPlatform() {
1862 return true
1863 }
1864
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +00001865 // Store uncompressed (and do not strip) dex files from boot class path jars.
1866 if inList(ctx.ModuleName(), ctx.Config().BootJars()) {
1867 return true
1868 }
1869
1870 // Store uncompressed dex files that are preopted on /system.
Colin Cross42be7612019-02-21 18:12:14 -08001871 if !dexpreopter.dexpreoptDisabled(ctx) && (ctx.Host() || !odexOnSystemOther(ctx, dexpreopter.installPath)) {
Vladimir Markoe8b00d62018-12-21 15:54:16 +00001872 return true
1873 }
Colin Cross083a2aa2019-02-06 16:37:12 -08001874 if ctx.Config().UncompressPrivAppDex() &&
1875 inList(ctx.ModuleName(), ctx.Config().ModulesLoadedByPrivilegedModules()) {
1876 return true
1877 }
1878
Colin Cross2fc72f62018-12-21 12:59:54 -08001879 return false
1880}
1881
Colin Crossf506d872017-07-19 15:53:04 -07001882func (j *Library) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Artur Satayev2db1c3f2020-04-08 19:09:30 +01001883 j.checkSdkVersions(ctx)
Jiyong Park0b238752019-10-29 11:23:10 +09001884 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar")
Colin Cross43f08db2018-11-12 10:13:39 -08001885 j.dexpreopter.isSDKLibrary = j.deviceProperties.IsSDKLibrary
David Srbeckye033cba2020-05-20 22:20:28 +01001886 if j.deviceProperties.Uncompress_dex == nil {
1887 // If the value was not force-set by the user, use reasonable default based on the module.
1888 j.deviceProperties.Uncompress_dex = proptools.BoolPtr(shouldUncompressDex(ctx, &j.dexpreopter))
1889 }
1890 j.dexpreopter.uncompressedDex = *j.deviceProperties.Uncompress_dex
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001891 j.compile(ctx, nil)
Colin Crossb7a63242015-04-16 14:09:14 -07001892
bralee1fbf4402020-05-21 10:11:59 +08001893 // Collect the module directory for IDE info in java/jdeps.go.
1894 j.modulePaths = append(j.modulePaths, ctx.ModuleDir())
1895
Jiyong Park7f7766d2019-07-25 22:02:35 +09001896 exclusivelyForApex := android.InAnyApex(ctx.ModuleName()) && !j.IsForPlatform()
1897 if (Bool(j.properties.Installable) || ctx.Host()) && !exclusivelyForApex {
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001898 var extraInstallDeps android.Paths
1899 if j.InstallMixin != nil {
1900 extraInstallDeps = j.InstallMixin(ctx, j.outputFile)
1901 }
Colin Cross2c429dc2017-08-31 16:45:16 -07001902 j.installFile = ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
Jiyong Parka62aa232020-05-28 23:46:55 +09001903 j.Stem()+".jar", j.outputFile, extraInstallDeps...)
Colin Cross2c429dc2017-08-31 16:45:16 -07001904 }
Anton Hansson78156ef2020-03-27 19:39:48 +00001905
1906 // Verify Dist.Tag is set to a supported output
1907 if j.libraryProperties.Dist.Tag != nil {
1908 distFiles, err := j.OutputFiles(*j.libraryProperties.Dist.Tag)
1909 if err != nil {
1910 ctx.PropertyErrorf("dist.tag", "%s", err.Error())
1911 }
1912 j.distFile = distFiles[0]
1913 }
Colin Crossb7a63242015-04-16 14:09:14 -07001914}
1915
Colin Crossf506d872017-07-19 15:53:04 -07001916func (j *Library) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001917 j.deps(ctx)
1918}
1919
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001920const (
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001921 aidlIncludeDir = "aidl"
1922 javaDir = "java"
1923 jarFileSuffix = ".jar"
1924 testConfigSuffix = "-AndroidTest.xml"
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001925)
1926
Paul Duffina0dbf432019-12-05 11:25:53 +00001927// path to the jar file of a java library. Relative to <sdk_root>/<api_dir>
Paul Duffina04c1072020-03-02 10:16:35 +00001928func sdkSnapshotFilePathForJar(osPrefix, name string) string {
1929 return sdkSnapshotFilePathForMember(osPrefix, name, jarFileSuffix)
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001930}
1931
Paul Duffina04c1072020-03-02 10:16:35 +00001932func sdkSnapshotFilePathForMember(osPrefix, name string, suffix string) string {
1933 return filepath.Join(javaDir, osPrefix, name+suffix)
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001934}
1935
Paul Duffin13879572019-11-28 14:31:38 +00001936type librarySdkMemberType struct {
Paul Duffin255f18e2019-12-13 11:22:16 +00001937 android.SdkMemberTypeBase
Paul Duffinf5c0a9c2020-02-28 14:39:53 +00001938
1939 // Function to retrieve the appropriate output jar (implementation or header) from
1940 // the library.
1941 jarToExportGetter func(j *Library) android.Path
Paul Duffin13879572019-11-28 14:31:38 +00001942}
1943
1944func (mt *librarySdkMemberType) AddDependencies(mctx android.BottomUpMutatorContext, dependencyTag blueprint.DependencyTag, names []string) {
1945 mctx.AddVariationDependencies(nil, dependencyTag, names...)
1946}
1947
1948func (mt *librarySdkMemberType) IsInstance(module android.Module) bool {
1949 _, ok := module.(*Library)
1950 return ok
1951}
1952
Paul Duffin3a4eb502020-03-19 16:11:18 +00001953func (mt *librarySdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
1954 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_import")
Paul Duffin14eb4672020-03-02 11:33:02 +00001955}
Paul Duffina0dbf432019-12-05 11:25:53 +00001956
Paul Duffin14eb4672020-03-02 11:33:02 +00001957func (mt *librarySdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
Paul Duffina551a1c2020-03-17 21:04:24 +00001958 return &librarySdkMemberProperties{}
Paul Duffin14eb4672020-03-02 11:33:02 +00001959}
1960
1961type librarySdkMemberProperties struct {
1962 android.SdkMemberPropertiesBase
1963
Paul Duffin864e1b42020-05-06 10:23:19 +01001964 JarToExport android.Path `android:"arch_variant"`
Paul Duffina551a1c2020-03-17 21:04:24 +00001965 AidlIncludeDirs android.Paths
Paul Duffin14eb4672020-03-02 11:33:02 +00001966}
1967
Paul Duffin3a4eb502020-03-19 16:11:18 +00001968func (p *librarySdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffin13879572019-11-28 14:31:38 +00001969 j := variant.(*Library)
1970
Paul Duffina551a1c2020-03-17 21:04:24 +00001971 p.JarToExport = ctx.MemberType().(*librarySdkMemberType).jarToExportGetter(j)
1972 p.AidlIncludeDirs = j.AidlIncludeDirs()
Paul Duffin14eb4672020-03-02 11:33:02 +00001973}
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001974
Paul Duffin3a4eb502020-03-19 16:11:18 +00001975func (p *librarySdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffina551a1c2020-03-17 21:04:24 +00001976 builder := ctx.SnapshotBuilder()
Paul Duffin3a4eb502020-03-19 16:11:18 +00001977
Paul Duffina551a1c2020-03-17 21:04:24 +00001978 exportedJar := p.JarToExport
1979 if exportedJar != nil {
1980 snapshotRelativeJavaLibPath := sdkSnapshotFilePathForJar(p.OsPrefix(), ctx.Name())
Paul Duffin14eb4672020-03-02 11:33:02 +00001981 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
1982
Paul Duffina551a1c2020-03-17 21:04:24 +00001983 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
1984 }
1985
1986 aidlIncludeDirs := p.AidlIncludeDirs
1987 if len(aidlIncludeDirs) != 0 {
1988 sdkModuleContext := ctx.SdkModuleContext()
1989 for _, dir := range aidlIncludeDirs {
Paul Duffin14eb4672020-03-02 11:33:02 +00001990 // TODO(jiyong): copy parcelable declarations only
1991 aidlFiles, _ := sdkModuleContext.GlobWithDeps(dir.String()+"/**/*.aidl", nil)
1992 for _, file := range aidlFiles {
1993 builder.CopyToSnapshot(android.PathForSource(sdkModuleContext, file), filepath.Join(aidlIncludeDir, file))
1994 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001995 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001996
Paul Duffina551a1c2020-03-17 21:04:24 +00001997 // TODO(b/151933053) - add aidl include dirs property
Paul Duffin14eb4672020-03-02 11:33:02 +00001998 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001999}
2000
Paul Duffinf5c0a9c2020-02-28 14:39:53 +00002001var javaHeaderLibsSdkMemberType android.SdkMemberType = &librarySdkMemberType{
2002 android.SdkMemberTypeBase{
2003 PropertyName: "java_header_libs",
2004 SupportsSdk: true,
Paul Duffin7b81f5e2020-01-13 21:03:22 +00002005 },
Paul Duffinf5c0a9c2020-02-28 14:39:53 +00002006 func(j *Library) android.Path {
Paul Duffina0dbf432019-12-05 11:25:53 +00002007 headerJars := j.HeaderJars()
2008 if len(headerJars) != 1 {
2009 panic(fmt.Errorf("there must be only one header jar from %q", j.Name()))
2010 }
2011
2012 return headerJars[0]
Paul Duffinf5c0a9c2020-02-28 14:39:53 +00002013 },
Paul Duffina0dbf432019-12-05 11:25:53 +00002014}
2015
Colin Cross1b16b0e2019-02-12 14:41:32 -08002016// java_library builds and links sources into a `.jar` file for the device, and possibly for the host as well.
2017//
2018// By default, a java_library has a single variant that produces a `.jar` file containing `.class` files that were
2019// compiled against the device bootclasspath. This jar is not suitable for installing on a device, but can be used
2020// as a `static_libs` dependency of another module.
2021//
2022// Specifying `installable: true` will product a `.jar` file containing `classes.dex` files, suitable for installing on
2023// a device.
2024//
2025// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2026// compiled against the host bootclasspath.
Colin Cross9ae1b922018-06-26 17:59:05 -07002027func LibraryFactory() android.Module {
2028 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07002029
Colin Cross9ae1b922018-06-26 17:59:05 -07002030 module.AddProperties(
2031 &module.Module.properties,
2032 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08002033 &module.Module.dexpreoptProperties,
Anton Hansson78156ef2020-03-27 19:39:48 +00002034 &module.Module.protoProperties,
2035 &module.libraryProperties)
Colin Cross2fe66872015-03-30 17:20:39 -07002036
Paul Duffin859fe962020-05-15 10:20:31 +01002037 module.initModuleAndImport(&module.ModuleBase)
2038
Jiyong Park7f7766d2019-07-25 22:02:35 +09002039 android.InitApexModule(module)
Jiyong Parkd1063c12019-07-17 20:08:41 +09002040 android.InitSdkAwareModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002041 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross9ae1b922018-06-26 17:59:05 -07002042 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002043}
2044
Colin Cross1b16b0e2019-02-12 14:41:32 -08002045// java_library_static is an obsolete alias for java_library.
2046func LibraryStaticFactory() android.Module {
2047 return LibraryFactory()
2048}
2049
2050// java_library_host builds and links sources into a `.jar` file for the host.
2051//
2052// A java_library_host has a single variant that produces a `.jar` file containing `.class` files that were
2053// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002054func LibraryHostFactory() android.Module {
2055 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07002056
Colin Cross6af17aa2017-09-20 12:59:05 -07002057 module.AddProperties(
2058 &module.Module.properties,
2059 &module.Module.protoProperties)
Colin Cross36242852017-06-23 15:06:31 -07002060
Colin Cross9ae1b922018-06-26 17:59:05 -07002061 module.Module.properties.Installable = proptools.BoolPtr(true)
2062
Jiyong Park7f7766d2019-07-25 22:02:35 +09002063 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002064 InitJavaModule(module, android.HostSupported)
Colin Cross36242852017-06-23 15:06:31 -07002065 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002066}
2067
2068//
Colin Crossb628ea52018-08-14 16:42:33 -07002069// Java Tests
Colin Cross05638fc2018-04-09 18:40:24 -07002070//
2071
2072type testProperties struct {
Colin Cross05638fc2018-04-09 18:40:24 -07002073 // list of compatibility suites (for example "cts", "vts") that the module should be
2074 // installed into.
2075 Test_suites []string `android:"arch_variant"`
Julien Despreze146e392018-08-02 15:00:46 -07002076
2077 // the name of the test configuration (for example "AndroidTest.xml") that should be
2078 // installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08002079 Test_config *string `android:"path,arch_variant"`
Colin Crossd96ca352018-08-10 16:06:24 -07002080
Jack He33338892018-09-19 02:21:28 -07002081 // the name of the test configuration template (for example "AndroidTestTemplate.xml") that
2082 // should be installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08002083 Test_config_template *string `android:"path,arch_variant"`
Jack He33338892018-09-19 02:21:28 -07002084
Colin Crossd96ca352018-08-10 16:06:24 -07002085 // list of files or filegroup modules that provide data that should be installed alongside
2086 // the test
Colin Cross27b922f2019-03-04 22:35:41 -08002087 Data []string `android:"path"`
Dan Shi6ffaaa82019-09-26 11:41:36 -07002088
2089 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
2090 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
2091 // explicitly.
2092 Auto_gen_config *bool
easoncylee5bcff5d2020-04-30 14:57:06 +08002093
2094 // Add parameterized mainline modules to auto generated test config. The options will be
2095 // handled by TradeFed to do downloading and installing the specified modules on the device.
2096 Test_mainline_modules []string
Colin Cross05638fc2018-04-09 18:40:24 -07002097}
2098
Paul Duffin42df1442019-03-20 12:45:53 +00002099type testHelperLibraryProperties struct {
2100 // list of compatibility suites (for example "cts", "vts") that the module should be
2101 // installed into.
2102 Test_suites []string `android:"arch_variant"`
2103}
2104
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002105type prebuiltTestProperties struct {
2106 // list of compatibility suites (for example "cts", "vts") that the module should be
2107 // installed into.
2108 Test_suites []string `android:"arch_variant"`
2109
2110 // the name of the test configuration (for example "AndroidTest.xml") that should be
2111 // installed with the module.
2112 Test_config *string `android:"path,arch_variant"`
2113}
2114
Colin Cross05638fc2018-04-09 18:40:24 -07002115type Test struct {
2116 Library
2117
2118 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07002119
2120 testConfig android.Path
Colin Crossd96ca352018-08-10 16:06:24 -07002121 data android.Paths
Colin Cross303e21f2018-08-07 16:49:25 -07002122}
2123
Paul Duffin42df1442019-03-20 12:45:53 +00002124type TestHelperLibrary struct {
2125 Library
2126
2127 testHelperLibraryProperties testHelperLibraryProperties
2128}
2129
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002130type JavaTestImport struct {
2131 Import
2132
2133 prebuiltTestProperties prebuiltTestProperties
2134
2135 testConfig android.Path
2136}
2137
Colin Cross303e21f2018-08-07 16:49:25 -07002138func (j *Test) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Dan Shi6ffaaa82019-09-26 11:41:36 -07002139 j.testConfig = tradefed.AutoGenJavaTestConfig(ctx, j.testProperties.Test_config, j.testProperties.Test_config_template,
2140 j.testProperties.Test_suites, j.testProperties.Auto_gen_config)
Colin Cross8a497952019-03-05 22:25:09 -08002141 j.data = android.PathsForModuleSrc(ctx, j.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07002142
2143 j.Library.GenerateAndroidBuildActions(ctx)
Colin Cross05638fc2018-04-09 18:40:24 -07002144}
2145
Paul Duffin42df1442019-03-20 12:45:53 +00002146func (j *TestHelperLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2147 j.Library.GenerateAndroidBuildActions(ctx)
2148}
2149
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002150func (j *JavaTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2151 j.testConfig = tradefed.AutoGenJavaTestConfig(ctx, j.prebuiltTestProperties.Test_config, nil,
2152 j.prebuiltTestProperties.Test_suites, nil)
2153
2154 j.Import.GenerateAndroidBuildActions(ctx)
2155}
2156
2157type testSdkMemberType struct {
2158 android.SdkMemberTypeBase
2159}
2160
2161func (mt *testSdkMemberType) AddDependencies(mctx android.BottomUpMutatorContext, dependencyTag blueprint.DependencyTag, names []string) {
2162 mctx.AddVariationDependencies(nil, dependencyTag, names...)
2163}
2164
2165func (mt *testSdkMemberType) IsInstance(module android.Module) bool {
2166 _, ok := module.(*Test)
2167 return ok
2168}
2169
Paul Duffin3a4eb502020-03-19 16:11:18 +00002170func (mt *testSdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
2171 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_test_import")
Paul Duffin14eb4672020-03-02 11:33:02 +00002172}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002173
Paul Duffin14eb4672020-03-02 11:33:02 +00002174func (mt *testSdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
2175 return &testSdkMemberProperties{}
2176}
2177
2178type testSdkMemberProperties struct {
2179 android.SdkMemberPropertiesBase
2180
Paul Duffina551a1c2020-03-17 21:04:24 +00002181 JarToExport android.Path
2182 TestConfig android.Path
Paul Duffin14eb4672020-03-02 11:33:02 +00002183}
2184
Paul Duffin3a4eb502020-03-19 16:11:18 +00002185func (p *testSdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffin14eb4672020-03-02 11:33:02 +00002186 test := variant.(*Test)
2187
2188 implementationJars := test.ImplementationJars()
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002189 if len(implementationJars) != 1 {
Paul Duffin14eb4672020-03-02 11:33:02 +00002190 panic(fmt.Errorf("there must be only one implementation jar from %q", test.Name()))
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002191 }
2192
Paul Duffina551a1c2020-03-17 21:04:24 +00002193 p.JarToExport = implementationJars[0]
2194 p.TestConfig = test.testConfig
Paul Duffin14eb4672020-03-02 11:33:02 +00002195}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002196
Paul Duffin3a4eb502020-03-19 16:11:18 +00002197func (p *testSdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffina551a1c2020-03-17 21:04:24 +00002198 builder := ctx.SnapshotBuilder()
Paul Duffin3a4eb502020-03-19 16:11:18 +00002199
Paul Duffina551a1c2020-03-17 21:04:24 +00002200 exportedJar := p.JarToExport
2201 if exportedJar != nil {
2202 snapshotRelativeJavaLibPath := sdkSnapshotFilePathForJar(p.OsPrefix(), ctx.Name())
2203 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
Paul Duffin14eb4672020-03-02 11:33:02 +00002204
2205 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
Paul Duffina551a1c2020-03-17 21:04:24 +00002206 }
2207
2208 testConfig := p.TestConfig
2209 if testConfig != nil {
2210 snapshotRelativeTestConfigPath := sdkSnapshotFilePathForMember(p.OsPrefix(), ctx.Name(), testConfigSuffix)
2211 builder.CopyToSnapshot(testConfig, snapshotRelativeTestConfigPath)
Paul Duffin14eb4672020-03-02 11:33:02 +00002212 propertySet.AddProperty("test_config", snapshotRelativeTestConfigPath)
2213 }
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002214}
2215
Colin Cross1b16b0e2019-02-12 14:41:32 -08002216// java_test builds a and links sources into a `.jar` file for the device, and possibly for the host as well, and
2217// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
2218//
2219// By default, a java_test has a single variant that produces a `.jar` file containing `classes.dex` files that were
2220// compiled against the device bootclasspath.
2221//
2222// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2223// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07002224func TestFactory() android.Module {
2225 module := &Test{}
2226
2227 module.AddProperties(
2228 &module.Module.properties,
2229 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08002230 &module.Module.dexpreoptProperties,
Colin Cross05638fc2018-04-09 18:40:24 -07002231 &module.Module.protoProperties,
2232 &module.testProperties)
2233
Colin Cross9ae1b922018-06-26 17:59:05 -07002234 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse3026872019-01-05 22:30:13 -08002235 module.Module.dexpreopter.isTest = true
Colin Cross9ae1b922018-06-26 17:59:05 -07002236
Colin Cross05638fc2018-04-09 18:40:24 -07002237 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07002238 return module
2239}
2240
Paul Duffin42df1442019-03-20 12:45:53 +00002241// java_test_helper_library creates a java library and makes sure that it is added to the appropriate test suite.
2242func TestHelperLibraryFactory() android.Module {
2243 module := &TestHelperLibrary{}
2244
2245 module.AddProperties(
2246 &module.Module.properties,
2247 &module.Module.deviceProperties,
2248 &module.Module.dexpreoptProperties,
2249 &module.Module.protoProperties,
2250 &module.testHelperLibraryProperties)
2251
Colin Cross9a4abed2019-04-24 13:19:28 -07002252 module.Module.properties.Installable = proptools.BoolPtr(true)
2253 module.Module.dexpreopter.isTest = true
2254
Paul Duffin42df1442019-03-20 12:45:53 +00002255 InitJavaModule(module, android.HostAndDeviceSupported)
2256 return module
2257}
2258
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002259// java_test_import imports one or more `.jar` files into the build graph as if they were built by a java_test module
2260// and makes sure that it is added to the appropriate test suite.
2261//
2262// By default, a java_test_import has a single variant that expects a `.jar` file containing `.class` files that were
2263// compiled against an Android classpath.
2264//
2265// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
2266// for host modules.
2267func JavaTestImportFactory() android.Module {
2268 module := &JavaTestImport{}
2269
2270 module.AddProperties(
2271 &module.Import.properties,
2272 &module.prebuiltTestProperties)
2273
2274 module.Import.properties.Installable = proptools.BoolPtr(true)
2275
2276 android.InitPrebuiltModule(module, &module.properties.Jars)
2277 android.InitApexModule(module)
2278 android.InitSdkAwareModule(module)
2279 InitJavaModule(module, android.HostAndDeviceSupported)
2280 return module
2281}
2282
Colin Cross1b16b0e2019-02-12 14:41:32 -08002283// java_test_host builds a and links sources into a `.jar` file for the host, and creates an `AndroidTest.xml` file to
2284// allow running the test with `atest` or a `TEST_MAPPING` file.
2285//
2286// A java_test_host has a single variant that produces a `.jar` file containing `.class` files that were
2287// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07002288func TestHostFactory() android.Module {
2289 module := &Test{}
2290
2291 module.AddProperties(
2292 &module.Module.properties,
2293 &module.Module.protoProperties,
2294 &module.testProperties)
2295
Colin Cross9ae1b922018-06-26 17:59:05 -07002296 module.Module.properties.Installable = proptools.BoolPtr(true)
2297
Colin Cross05638fc2018-04-09 18:40:24 -07002298 InitJavaModule(module, android.HostSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07002299 return module
2300}
2301
2302//
Colin Cross2fe66872015-03-30 17:20:39 -07002303// Java Binaries (.jar file plus wrapper script)
2304//
2305
Colin Crossf506d872017-07-19 15:53:04 -07002306type binaryProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -07002307 // installable script to execute the resulting jar
Colin Cross27b922f2019-03-04 22:35:41 -08002308 Wrapper *string `android:"path"`
Colin Cross094054a2018-10-17 15:10:48 -07002309
2310 // Name of the class containing main to be inserted into the manifest as Main-Class.
2311 Main_class *string
Colin Cross7d5136f2015-05-11 13:39:40 -07002312}
2313
Colin Crossf506d872017-07-19 15:53:04 -07002314type Binary struct {
2315 Library
Colin Cross2fe66872015-03-30 17:20:39 -07002316
Colin Crossf506d872017-07-19 15:53:04 -07002317 binaryProperties binaryProperties
Colin Cross10a03492017-08-10 17:09:43 -07002318
Colin Cross6b4a32d2017-12-05 13:42:45 -08002319 isWrapperVariant bool
2320
Colin Crossc3315992017-12-08 19:12:36 -08002321 wrapperFile android.Path
Colin Cross70dda7e2019-10-01 22:05:35 -07002322 binaryFile android.InstallPath
Colin Cross2fe66872015-03-30 17:20:39 -07002323}
2324
Alex Light24237172017-10-26 09:46:21 -07002325func (j *Binary) HostToolPath() android.OptionalPath {
2326 return android.OptionalPathForPath(j.binaryFile)
2327}
2328
Colin Crossf506d872017-07-19 15:53:04 -07002329func (j *Binary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002330 if ctx.Arch().ArchType == android.Common {
2331 // Compile the jar
Colin Cross094054a2018-10-17 15:10:48 -07002332 if j.binaryProperties.Main_class != nil {
2333 if j.properties.Manifest != nil {
2334 ctx.PropertyErrorf("main_class", "main_class cannot be used when manifest is set")
2335 }
2336 manifestFile := android.PathForModuleOut(ctx, "manifest.txt")
2337 GenerateMainClassManifest(ctx, manifestFile, String(j.binaryProperties.Main_class))
2338 j.overrideManifest = android.OptionalPathForPath(manifestFile)
2339 }
2340
Colin Cross6b4a32d2017-12-05 13:42:45 -08002341 j.Library.GenerateAndroidBuildActions(ctx)
Nan Zhang3c807db2017-11-03 14:53:31 -07002342 } else {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002343 // Handle the binary wrapper
2344 j.isWrapperVariant = true
2345
Colin Cross366938f2017-12-11 16:29:02 -08002346 if j.binaryProperties.Wrapper != nil {
Colin Cross8a497952019-03-05 22:25:09 -08002347 j.wrapperFile = android.PathForModuleSrc(ctx, *j.binaryProperties.Wrapper)
Colin Cross6b4a32d2017-12-05 13:42:45 -08002348 } else {
2349 j.wrapperFile = android.PathForSource(ctx, "build/soong/scripts/jar-wrapper.sh")
2350 }
2351
2352 // Depend on the installed jar so that the wrapper doesn't get executed by
2353 // another build rule before the jar has been installed.
2354 jarFile := ctx.PrimaryModule().(*Binary).installFile
2355
2356 j.binaryFile = ctx.InstallExecutable(android.PathForModuleInstall(ctx, "bin"),
2357 ctx.ModuleName(), j.wrapperFile, jarFile)
Nan Zhang3c807db2017-11-03 14:53:31 -07002358 }
Colin Cross2fe66872015-03-30 17:20:39 -07002359}
2360
Colin Crossf506d872017-07-19 15:53:04 -07002361func (j *Binary) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002362 if ctx.Arch().ArchType == android.Common {
2363 j.deps(ctx)
2364 }
Colin Cross46c9b8b2017-06-22 16:51:17 -07002365}
2366
Colin Cross1b16b0e2019-02-12 14:41:32 -08002367// java_binary builds a `.jar` file and a shell script that executes it for the device, and possibly for the host
2368// as well.
2369//
2370// By default, a java_binary has a single variant that produces a `.jar` file containing `classes.dex` files that were
2371// compiled against the device bootclasspath.
2372//
2373// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2374// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002375func BinaryFactory() android.Module {
2376 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07002377
Colin Cross36242852017-06-23 15:06:31 -07002378 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -07002379 &module.Module.properties,
2380 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08002381 &module.Module.dexpreoptProperties,
Colin Cross6af17aa2017-09-20 12:59:05 -07002382 &module.Module.protoProperties,
Colin Cross540eff82017-06-22 17:01:52 -07002383 &module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07002384
Colin Cross9ae1b922018-06-26 17:59:05 -07002385 module.Module.properties.Installable = proptools.BoolPtr(true)
2386
Colin Cross6b4a32d2017-12-05 13:42:45 -08002387 android.InitAndroidArchModule(module, android.HostAndDeviceSupported, android.MultilibCommonFirst)
2388 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07002389 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002390}
2391
Colin Cross1b16b0e2019-02-12 14:41:32 -08002392// java_binary_host builds a `.jar` file and a shell script that executes it for the host.
2393//
2394// A java_binary_host has a single variant that produces a `.jar` file containing `.class` files that were
2395// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002396func BinaryHostFactory() android.Module {
2397 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07002398
Colin Cross36242852017-06-23 15:06:31 -07002399 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -07002400 &module.Module.properties,
Colin Cross6af17aa2017-09-20 12:59:05 -07002401 &module.Module.protoProperties,
Colin Cross540eff82017-06-22 17:01:52 -07002402 &module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07002403
Colin Cross9ae1b922018-06-26 17:59:05 -07002404 module.Module.properties.Installable = proptools.BoolPtr(true)
2405
Colin Cross6b4a32d2017-12-05 13:42:45 -08002406 android.InitAndroidArchModule(module, android.HostSupported, android.MultilibCommonFirst)
2407 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07002408 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002409}
2410
2411//
2412// Java prebuilts
2413//
2414
Colin Cross74d73e22017-08-02 11:05:49 -07002415type ImportProperties struct {
Paul Duffina04c1072020-03-02 10:16:35 +00002416 Jars []string `android:"path,arch_variant"`
Colin Cross461bd1a2017-10-20 13:59:18 -07002417
Nan Zhangea568a42017-11-08 21:20:04 -08002418 Sdk_version *string
Colin Cross535e2cf2017-10-20 17:57:49 -07002419
2420 Installable *bool
Jiyong Park1be96912018-05-28 18:02:19 +09002421
2422 // List of shared java libs that this module has dependencies to
2423 Libs []string
Colin Cross37f6d792018-07-12 12:28:41 -07002424
2425 // List of files to remove from the jar file(s)
2426 Exclude_files []string
2427
2428 // List of directories to remove from the jar file(s)
2429 Exclude_dirs []string
Nan Zhang4c819fb2018-08-27 18:31:46 -07002430
2431 // if set to true, run Jetifier against .jar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -07002432 Jetifier *bool
Jiyong Park4c4c0242019-10-21 14:53:15 +09002433
2434 // set the name of the output
2435 Stem *string
Jiyong Park19604de2020-03-24 16:44:11 +09002436
2437 Aidl struct {
2438 // directories that should be added as include directories for any aidl sources of modules
2439 // that depend on this module, as well as to aidl for this module.
2440 Export_include_dirs []string
2441 }
Colin Cross74d73e22017-08-02 11:05:49 -07002442}
2443
2444type Import struct {
Colin Cross635c3b02016-05-18 15:37:25 -07002445 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -07002446 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002447 android.ApexModuleBase
Colin Crossec7a0422017-07-07 14:47:12 -07002448 prebuilt android.Prebuilt
Jiyong Parkd1063c12019-07-17 20:08:41 +09002449 android.SdkBase
Colin Cross2fe66872015-03-30 17:20:39 -07002450
Paul Duffin0d3c2e12020-05-17 08:34:50 +01002451 // Functionality common to Module and Import.
2452 embeddableInModuleAndImport
2453
Colin Cross74d73e22017-08-02 11:05:49 -07002454 properties ImportProperties
2455
Colin Cross0a6e0072017-08-30 14:24:55 -07002456 combinedClasspathFile android.Path
Jiyong Park1be96912018-05-28 18:02:19 +09002457 exportedSdkLibs []string
Jiyong Park19604de2020-03-24 16:44:11 +09002458 exportAidlIncludeDirs android.Paths
Colin Cross2fe66872015-03-30 17:20:39 -07002459}
2460
Jiyong Park6a927c42020-01-21 02:03:43 +09002461func (j *Import) sdkVersion() sdkSpec {
2462 return sdkSpecFrom(String(j.properties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -07002463}
2464
Jiyong Park6a927c42020-01-21 02:03:43 +09002465func (j *Import) minSdkVersion() sdkSpec {
Colin Cross83bb3162018-06-25 15:48:06 -07002466 return j.sdkVersion()
2467}
2468
Artur Satayev480e25b2020-04-27 18:53:18 +01002469func (j *Import) MinSdkVersion() string {
2470 return j.minSdkVersion().version.String()
2471}
2472
Colin Cross74d73e22017-08-02 11:05:49 -07002473func (j *Import) Prebuilt() *android.Prebuilt {
Colin Crossec7a0422017-07-07 14:47:12 -07002474 return &j.prebuilt
2475}
2476
Colin Cross74d73e22017-08-02 11:05:49 -07002477func (j *Import) PrebuiltSrcs() []string {
2478 return j.properties.Jars
2479}
2480
2481func (j *Import) Name() string {
Colin Cross5ea9bcc2017-07-27 15:41:32 -07002482 return j.prebuilt.Name(j.ModuleBase.Name())
2483}
2484
Jiyong Park0b238752019-10-29 11:23:10 +09002485func (j *Import) Stem() string {
2486 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
2487}
2488
Jiyong Park618922e2020-01-08 13:35:43 +09002489func (a *Import) JacocoReportClassesFile() android.Path {
2490 return nil
2491}
2492
Colin Cross74d73e22017-08-02 11:05:49 -07002493func (j *Import) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross42d48b72018-08-29 14:10:52 -07002494 ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Colin Cross1e676be2016-10-12 14:38:15 -07002495}
2496
Colin Cross74d73e22017-08-02 11:05:49 -07002497func (j *Import) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross8a497952019-03-05 22:25:09 -08002498 jars := android.PathsForModuleSrc(ctx, j.properties.Jars)
Colin Crosse1d62a82015-04-03 16:53:05 -07002499
Jiyong Park0b238752019-10-29 11:23:10 +09002500 jarName := j.Stem() + ".jar"
Nan Zhang4c819fb2018-08-27 18:31:46 -07002501 outputFile := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07002502 TransformJarsToJar(ctx, outputFile, "for prebuilts", jars, android.OptionalPath{},
2503 false, j.properties.Exclude_files, j.properties.Exclude_dirs)
Colin Cross1001a792019-03-21 22:21:39 -07002504 if Bool(j.properties.Jetifier) {
Nan Zhang4c819fb2018-08-27 18:31:46 -07002505 inputFile := outputFile
2506 outputFile = android.PathForModuleOut(ctx, "jetifier", jarName)
2507 TransformJetifier(ctx, outputFile, inputFile)
2508 }
Colin Crosse9a275b2017-10-16 17:09:48 -07002509 j.combinedClasspathFile = outputFile
Jiyong Park1be96912018-05-28 18:02:19 +09002510
Paul Duffin859fe962020-05-15 10:20:31 +01002511 // If this is a component library (impl, stubs, etc.) for a java_sdk_library then
2512 // add the name of that java_sdk_library to the exported sdk libs to make sure
2513 // that, if necessary, a <uses-library> element for that java_sdk_library is
2514 // added to the Android manifest.
2515 j.exportedSdkLibs = append(j.exportedSdkLibs, j.OptionalImplicitSdkLibrary()...)
2516
Jiyong Park1be96912018-05-28 18:02:19 +09002517 ctx.VisitDirectDeps(func(module android.Module) {
2518 otherName := ctx.OtherModuleName(module)
2519 tag := ctx.OtherModuleDependencyTag(module)
2520
2521 switch dep := module.(type) {
2522 case Dependency:
2523 switch tag {
2524 case libTag, staticLibTag:
2525 // sdk lib names from dependencies are re-exported
2526 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
2527 }
2528 case SdkLibraryDependency:
2529 switch tag {
2530 case libTag:
2531 // names of sdk libs that are directly depended are exported
2532 j.exportedSdkLibs = append(j.exportedSdkLibs, otherName)
2533 }
2534 }
2535 })
2536
2537 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
Nan Zhang4973ecf2018-08-10 13:42:12 -07002538 if Bool(j.properties.Installable) {
2539 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
Jiyong Park4c4c0242019-10-21 14:53:15 +09002540 jarName, outputFile)
Nan Zhang4973ecf2018-08-10 13:42:12 -07002541 }
Jiyong Park19604de2020-03-24 16:44:11 +09002542
2543 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.properties.Aidl.Export_include_dirs)
Colin Cross2fe66872015-03-30 17:20:39 -07002544}
2545
Colin Cross74d73e22017-08-02 11:05:49 -07002546var _ Dependency = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07002547
Nan Zhanged19fc32017-10-19 13:06:22 -07002548func (j *Import) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002549 if j.combinedClasspathFile == nil {
2550 return nil
2551 }
Colin Cross37f6d792018-07-12 12:28:41 -07002552 return android.Paths{j.combinedClasspathFile}
Nan Zhanged19fc32017-10-19 13:06:22 -07002553}
2554
2555func (j *Import) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08002556 if j.combinedClasspathFile == nil {
2557 return nil
2558 }
Colin Cross37f6d792018-07-12 12:28:41 -07002559 return android.Paths{j.combinedClasspathFile}
Colin Cross2fe66872015-03-30 17:20:39 -07002560}
2561
Colin Cross331a1212018-08-15 20:40:52 -07002562func (j *Import) ResourceJars() android.Paths {
2563 return nil
2564}
2565
2566func (j *Import) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002567 if j.combinedClasspathFile == nil {
2568 return nil
2569 }
Colin Cross331a1212018-08-15 20:40:52 -07002570 return android.Paths{j.combinedClasspathFile}
2571}
2572
Ulyana Trafimovich5539e7b2020-06-04 14:08:17 +00002573func (j *Import) DexJarBuildPath() android.Path {
Colin Crossf24a22a2019-01-31 14:12:44 -08002574 return nil
2575}
2576
Colin Cross74d73e22017-08-02 11:05:49 -07002577func (j *Import) AidlIncludeDirs() android.Paths {
Jiyong Park19604de2020-03-24 16:44:11 +09002578 return j.exportAidlIncludeDirs
Colin Crossc0b06f12015-04-08 13:03:43 -07002579}
2580
Jiyong Park1be96912018-05-28 18:02:19 +09002581func (j *Import) ExportedSdkLibs() []string {
2582 return j.exportedSdkLibs
2583}
2584
Artur Satayev9cf46692019-11-26 18:08:34 +00002585func (j *Import) ExportedPlugins() (android.Paths, []string) {
2586 return nil, nil
2587}
2588
Colin Cross0c4ce212019-05-03 15:28:19 -07002589func (j *Import) SrcJarArgs() ([]string, android.Paths) {
2590 return nil, nil
2591}
2592
Jiyong Park0f80c182020-01-31 02:49:53 +09002593func (j *Import) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Paul Duffin0d3c2e12020-05-17 08:34:50 +01002594 return j.depIsInSameApex(ctx, dep)
Jiyong Park0f80c182020-01-31 02:49:53 +09002595}
2596
albaltai36ff7dc2018-12-25 14:35:23 +08002597// Add compile time check for interface implementation
2598var _ android.IDEInfo = (*Import)(nil)
2599var _ android.IDECustomizedModuleName = (*Import)(nil)
2600
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002601// Collect information for opening IDE project files in java/jdeps.go.
2602const (
2603 removedPrefix = "prebuilt_"
2604)
2605
2606func (j *Import) IDEInfo(dpInfo *android.IdeInfo) {
2607 dpInfo.Jars = append(dpInfo.Jars, j.PrebuiltSrcs()...)
2608}
2609
2610func (j *Import) IDECustomizedModuleName() string {
2611 // TODO(b/113562217): Extract the base module name from the Import name, often the Import name
2612 // has a prefix "prebuilt_". Remove the prefix explicitly if needed until we find a better
2613 // solution to get the Import name.
2614 name := j.Name()
2615 if strings.HasPrefix(name, removedPrefix) {
patricktubb640e02018-10-11 18:33:16 +08002616 name = strings.TrimPrefix(name, removedPrefix)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002617 }
2618 return name
2619}
2620
Colin Cross74d73e22017-08-02 11:05:49 -07002621var _ android.PrebuiltInterface = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07002622
Colin Cross1b16b0e2019-02-12 14:41:32 -08002623// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library module.
2624//
2625// By default, a java_import has a single variant that expects a `.jar` file containing `.class` files that were
2626// compiled against an Android classpath.
2627//
2628// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
2629// for host modules.
Colin Cross74d73e22017-08-02 11:05:49 -07002630func ImportFactory() android.Module {
2631 module := &Import{}
Colin Cross36242852017-06-23 15:06:31 -07002632
Colin Cross74d73e22017-08-02 11:05:49 -07002633 module.AddProperties(&module.properties)
2634
Paul Duffin859fe962020-05-15 10:20:31 +01002635 module.initModuleAndImport(&module.ModuleBase)
2636
Colin Cross74d73e22017-08-02 11:05:49 -07002637 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002638 android.InitApexModule(module)
Jiyong Parkd1063c12019-07-17 20:08:41 +09002639 android.InitSdkAwareModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002640 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross36242852017-06-23 15:06:31 -07002641 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002642}
2643
Colin Cross1b16b0e2019-02-12 14:41:32 -08002644// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library_host
2645// module.
2646//
2647// A java_import_host has a single variant that expects a `.jar` file containing `.class` files that were
2648// compiled against a host bootclasspath.
Colin Cross74d73e22017-08-02 11:05:49 -07002649func ImportFactoryHost() android.Module {
2650 module := &Import{}
2651
2652 module.AddProperties(&module.properties)
2653
2654 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002655 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002656 InitJavaModule(module, android.HostSupported)
Colin Cross74d73e22017-08-02 11:05:49 -07002657 return module
2658}
2659
Colin Cross42be7612019-02-21 18:12:14 -08002660// dex_import module
2661
2662type DexImportProperties struct {
Colin Cross5cfc70d2019-07-15 13:36:55 -07002663 Jars []string `android:"path"`
Jiyong Park4c4c0242019-10-21 14:53:15 +09002664
2665 // set the name of the output
2666 Stem *string
Colin Cross42be7612019-02-21 18:12:14 -08002667}
2668
2669type DexImport struct {
2670 android.ModuleBase
2671 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002672 android.ApexModuleBase
Colin Cross42be7612019-02-21 18:12:14 -08002673 prebuilt android.Prebuilt
2674
2675 properties DexImportProperties
2676
2677 dexJarFile android.Path
2678 maybeStrippedDexJarFile android.Path
2679
2680 dexpreopter
2681}
2682
2683func (j *DexImport) Prebuilt() *android.Prebuilt {
2684 return &j.prebuilt
2685}
2686
2687func (j *DexImport) PrebuiltSrcs() []string {
2688 return j.properties.Jars
2689}
2690
2691func (j *DexImport) Name() string {
2692 return j.prebuilt.Name(j.ModuleBase.Name())
2693}
2694
Jiyong Park0b238752019-10-29 11:23:10 +09002695func (j *DexImport) Stem() string {
2696 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
2697}
2698
Jiyong Park77acec62020-06-01 21:39:15 +09002699func (a *DexImport) JacocoReportClassesFile() android.Path {
2700 return nil
2701}
2702
Martin Stjernholm6d415272020-01-31 17:10:36 +00002703func (j *DexImport) IsInstallable() bool {
2704 return true
2705}
2706
Colin Cross42be7612019-02-21 18:12:14 -08002707func (j *DexImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2708 if len(j.properties.Jars) != 1 {
2709 ctx.PropertyErrorf("jars", "exactly one jar must be provided")
2710 }
2711
Jiyong Park0b238752019-10-29 11:23:10 +09002712 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar")
Colin Cross42be7612019-02-21 18:12:14 -08002713 j.dexpreopter.uncompressedDex = shouldUncompressDex(ctx, &j.dexpreopter)
2714
2715 inputJar := ctx.ExpandSource(j.properties.Jars[0], "jars")
2716 dexOutputFile := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar")
2717
2718 if j.dexpreopter.uncompressedDex {
2719 rule := android.NewRuleBuilder()
2720
2721 temporary := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar.unaligned")
2722 rule.Temporary(temporary)
2723
2724 // use zip2zip to uncompress classes*.dex files
2725 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -07002726 BuiltTool(ctx, "zip2zip").
Colin Cross42be7612019-02-21 18:12:14 -08002727 FlagWithInput("-i ", inputJar).
2728 FlagWithOutput("-o ", temporary).
2729 FlagWithArg("-0 ", "'classes*.dex'")
2730
2731 // use zipalign to align uncompressed classes*.dex files
2732 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -07002733 BuiltTool(ctx, "zipalign").
Colin Cross42be7612019-02-21 18:12:14 -08002734 Flag("-f").
2735 Text("4").
2736 Input(temporary).
2737 Output(dexOutputFile)
2738
2739 rule.DeleteTemporaryFiles()
2740
2741 rule.Build(pctx, ctx, "uncompress_dex", "uncompress dex")
2742 } else {
2743 ctx.Build(pctx, android.BuildParams{
2744 Rule: android.Cp,
2745 Input: inputJar,
2746 Output: dexOutputFile,
2747 })
2748 }
2749
2750 j.dexJarFile = dexOutputFile
2751
2752 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
2753
2754 j.maybeStrippedDexJarFile = dexOutputFile
2755
2756 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
Jiyong Parka62aa232020-05-28 23:46:55 +09002757 j.Stem()+".jar", dexOutputFile)
Colin Cross42be7612019-02-21 18:12:14 -08002758}
2759
Ulyana Trafimovich5539e7b2020-06-04 14:08:17 +00002760func (j *DexImport) DexJarBuildPath() android.Path {
Colin Cross42be7612019-02-21 18:12:14 -08002761 return j.dexJarFile
2762}
2763
2764// dex_import imports a `.jar` file containing classes.dex files.
2765//
2766// A dex_import module cannot be used as a dependency of a java_* or android_* module, it can only be installed
2767// to the device.
2768func DexImportFactory() android.Module {
2769 module := &DexImport{}
2770
2771 module.AddProperties(&module.properties)
2772
2773 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002774 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002775 InitJavaModule(module, android.DeviceSupported)
Colin Cross42be7612019-02-21 18:12:14 -08002776 return module
2777}
2778
Colin Cross89536d42017-07-07 14:35:50 -07002779//
2780// Defaults
2781//
2782type Defaults struct {
2783 android.ModuleBase
2784 android.DefaultsModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002785 android.ApexModuleBase
Colin Cross89536d42017-07-07 14:35:50 -07002786}
2787
Colin Cross1b16b0e2019-02-12 14:41:32 -08002788// java_defaults provides a set of properties that can be inherited by other java or android modules.
2789//
2790// A module can use the properties from a java_defaults module using `defaults: ["defaults_module_name"]`. Each
2791// property in the defaults module that exists in the depending module will be prepended to the depending module's
2792// value for that property.
2793//
2794// Example:
2795//
2796// java_defaults {
2797// name: "example_defaults",
2798// srcs: ["common/**/*.java"],
2799// javacflags: ["-Xlint:all"],
2800// aaptflags: ["--auto-add-overlay"],
2801// }
2802//
2803// java_library {
2804// name: "example",
2805// defaults: ["example_defaults"],
2806// srcs: ["example/**/*.java"],
2807// }
2808//
2809// is functionally identical to:
2810//
2811// java_library {
2812// name: "example",
2813// srcs: [
2814// "common/**/*.java",
2815// "example/**/*.java",
2816// ],
2817// javacflags: ["-Xlint:all"],
2818// }
Colin Cross89536d42017-07-07 14:35:50 -07002819func defaultsFactory() android.Module {
2820 return DefaultsFactory()
2821}
2822
Paul Duffin47357662019-12-05 14:07:14 +00002823func DefaultsFactory() android.Module {
Colin Cross89536d42017-07-07 14:35:50 -07002824 module := &Defaults{}
2825
Colin Cross89536d42017-07-07 14:35:50 -07002826 module.AddProperties(
2827 &CompilerProperties{},
2828 &CompilerDeviceProperties{},
Colin Cross43f08db2018-11-12 10:13:39 -08002829 &DexpreoptProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08002830 &android.ProtoProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002831 &aaptProperties{},
2832 &androidLibraryProperties{},
2833 &appProperties{},
2834 &appTestProperties{},
Jaewoong Jung525443a2019-02-28 15:35:54 -08002835 &overridableAppProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002836 &ImportProperties{},
2837 &AARImportProperties{},
2838 &sdkLibraryProperties{},
Paul Duffin1b1e8062020-05-08 13:44:43 +01002839 &commonToSdkLibraryAndImportProperties{},
Colin Cross42be7612019-02-21 18:12:14 -08002840 &DexImportProperties{},
Jooyung Han18020ea2019-11-13 10:50:48 +09002841 &android.ApexProperties{},
Jaewoong Jungbf135462020-04-26 15:10:51 -07002842 &RuntimeResourceOverlayProperties{},
Colin Cross89536d42017-07-07 14:35:50 -07002843 )
2844
2845 android.InitDefaultsModule(module)
Colin Cross89536d42017-07-07 14:35:50 -07002846 return module
2847}
Nan Zhangea568a42017-11-08 21:20:04 -08002848
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002849func kytheExtractJavaFactory() android.Singleton {
2850 return &kytheExtractJavaSingleton{}
2851}
2852
2853type kytheExtractJavaSingleton struct {
2854}
2855
2856func (ks *kytheExtractJavaSingleton) GenerateBuildActions(ctx android.SingletonContext) {
2857 var xrefTargets android.Paths
2858 ctx.VisitAllModules(func(module android.Module) {
2859 if javaModule, ok := module.(xref); ok {
2860 xrefTargets = append(xrefTargets, javaModule.XrefJavaFiles()...)
2861 }
2862 })
2863 // TODO(asmundak): perhaps emit a rule to output a warning if there were no xrefTargets
2864 if len(xrefTargets) > 0 {
2865 ctx.Build(pctx, android.BuildParams{
2866 Rule: blueprint.Phony,
2867 Output: android.PathForPhony(ctx, "xref_java"),
2868 Inputs: xrefTargets,
2869 })
2870 }
2871}
2872
Nan Zhangea568a42017-11-08 21:20:04 -08002873var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07002874var BoolDefault = proptools.BoolDefault
Nan Zhangea568a42017-11-08 21:20:04 -08002875var String = proptools.String
Colin Cross0d0ba592018-02-20 13:33:42 -08002876var inList = android.InList