blob: 1a5e86f3d67f63e59e53e6526fa96ca0ca98464d [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 Duffin2b9e3d32020-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 Satayev2eedf622020-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 Satayeve5ac15a2020-04-08 19:09:30 +010097func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
Colin Crosseb032962020-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 Satayeve5ac15a2020-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 Srbecky98c71222020-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"`
Songchun Fan688de9a2020-03-24 20:32:24 -0700352
353 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
354 // Defaults to false.
355 V4_signature *bool
Colin Cross7d5136f2015-05-11 13:39:40 -0700356}
357
Sasha Smundak2057f822019-04-16 17:16:58 -0700358func (me *CompilerDeviceProperties) EffectiveOptimizeEnabled() bool {
359 return BoolDefault(me.Optimize.Enabled, me.Optimize.EnabledByDefault)
360}
361
Paul Duffinc8f2f182020-05-17 08:34:50 +0100362// Functionality common to Module and Import
Paul Duffin64e61992020-05-15 10:20:31 +0100363//
364// It is embedded in Module so its functionality can be used by methods in Module
365// but it is currently only initialized by Import and Library.
Paul Duffinc8f2f182020-05-17 08:34:50 +0100366type embeddableInModuleAndImport struct {
Paul Duffin64e61992020-05-15 10:20:31 +0100367
368 // Functionality related to this being used as a component of a java_sdk_library.
369 EmbeddableSdkLibraryComponent
370}
371
372func (e *embeddableInModuleAndImport) initModuleAndImport(moduleBase *android.ModuleBase) {
373 e.initSdkLibraryComponent(moduleBase)
Paul Duffinc8f2f182020-05-17 08:34:50 +0100374}
375
376// Module/Import's DepIsInSameApex(...) delegates to this method.
377//
378// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
379// the one provided by ApexModuleBase.
380func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
381 // dependencies other than the static linkage are all considered crossing APEX boundary
382 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
383 return true
384 }
385 return false
386}
387
Colin Cross46c9b8b2017-06-22 16:51:17 -0700388// Module contains the properties and members used by all java module types
389type Module struct {
Colin Cross635c3b02016-05-18 15:37:25 -0700390 android.ModuleBase
Colin Cross89536d42017-07-07 14:35:50 -0700391 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +0900392 android.ApexModuleBase
Jiyong Parkd1063c12019-07-17 20:08:41 +0900393 android.SdkBase
Colin Cross2fe66872015-03-30 17:20:39 -0700394
Paul Duffinc8f2f182020-05-17 08:34:50 +0100395 // Functionality common to Module and Import.
396 embeddableInModuleAndImport
397
Colin Cross89536d42017-07-07 14:35:50 -0700398 properties CompilerProperties
Colin Cross6af17aa2017-09-20 12:59:05 -0700399 protoProperties android.ProtoProperties
Colin Cross89536d42017-07-07 14:35:50 -0700400 deviceProperties CompilerDeviceProperties
Colin Cross2fe66872015-03-30 17:20:39 -0700401
Colin Cross331a1212018-08-15 20:40:52 -0700402 // jar file containing header classes including static library dependencies, suitable for
403 // inserting into the bootclasspath/classpath of another compile
Nan Zhanged19fc32017-10-19 13:06:22 -0700404 headerJarFile android.Path
405
Colin Cross331a1212018-08-15 20:40:52 -0700406 // jar file containing implementation classes including static library dependencies but no
407 // resources
Nan Zhanged19fc32017-10-19 13:06:22 -0700408 implementationJarFile android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700409
Colin Cross331a1212018-08-15 20:40:52 -0700410 // jar file containing only resources including from static library dependencies
411 resourceJar android.Path
412
Colin Cross0c4ce212019-05-03 15:28:19 -0700413 // args and dependencies to package source files into a srcjar
414 srcJarArgs []string
415 srcJarDeps android.Paths
416
Colin Cross331a1212018-08-15 20:40:52 -0700417 // jar file containing implementation classes and resources including static library
418 // dependencies
419 implementationAndResourcesJar android.Path
420
421 // output file containing classes.dex and resources
Colin Cross6ade34f2017-09-15 13:00:47 -0700422 dexJarFile android.Path
423
Colin Cross43f08db2018-11-12 10:13:39 -0800424 // output file that contains classes.dex if it should be in the output file
425 maybeStrippedDexJarFile android.Path
426
Colin Crosscb933592017-11-22 13:49:43 -0800427 // output file containing uninstrumented classes that will be instrumented by jacoco
428 jacocoReportClassesFile android.Path
429
Colin Cross66dbc0b2017-12-28 12:23:20 -0800430 // output file containing mapping of obfuscated names
431 proguardDictionary android.Path
432
Colin Cross331a1212018-08-15 20:40:52 -0700433 // output file of the module, which may be a classes jar or a dex jar
Colin Crosse560c4a2019-03-19 16:03:11 -0700434 outputFile android.Path
435 extraOutputFiles android.Paths
Colin Crossb7a63242015-04-16 14:09:14 -0700436
Colin Cross635c3b02016-05-18 15:37:25 -0700437 exportAidlIncludeDirs android.Paths
Colin Crossc0b06f12015-04-08 13:03:43 -0700438
Colin Cross635c3b02016-05-18 15:37:25 -0700439 logtagsSrcs android.Paths
Colin Crossf05fe972015-04-10 17:45:20 -0700440
Colin Cross2fe66872015-03-30 17:20:39 -0700441 // installed file for binary dependency
Colin Cross635c3b02016-05-18 15:37:25 -0700442 installFile android.Path
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800443
444 // list of .java files and srcjars that was passed to javac
445 compiledJavaSrcs android.Paths
446 compiledSrcJars android.Paths
Colin Cross66dbc0b2017-12-28 12:23:20 -0800447
448 // list of extra progurad flag files
449 extraProguardFlagFiles android.Paths
Jiyong Park1be96912018-05-28 18:02:19 +0900450
Colin Cross094054a2018-10-17 15:10:48 -0700451 // manifest file to use instead of properties.Manifest
452 overrideManifest android.OptionalPath
453
Artur Satayev9cf46692019-11-26 18:08:34 +0000454 // list of SDK lib names that this java module is exporting
Jiyong Park1be96912018-05-28 18:02:19 +0900455 exportedSdkLibs []string
Brandon Lee5d45c6f2018-08-15 15:35:38 -0700456
Artur Satayev9cf46692019-11-26 18:08:34 +0000457 // list of plugins that this java module is exporting
458 exportedPluginJars android.Paths
459
460 // list of plugins that this java module is exporting
461 exportedPluginClasses []string
462
463 // list of source files, collected from srcFiles with unique java and all kt files,
patricktu242faad2019-09-24 15:41:30 +0800464 // will be used by android.IDEInfo struct
Brandon Lee5d45c6f2018-08-15 15:35:38 -0700465 expandIDEInfoCompiledSrcs []string
Colin Cross43f08db2018-11-12 10:13:39 -0800466
Steven Morelandc4efd9c2019-01-18 11:51:25 -0800467 // expanded Jarjar_rules
468 expandJarjarRules android.Path
469
Colin Cross988708c2019-05-06 14:04:11 -0700470 // Extra files generated by the module type to be added as java resources.
471 extraResources android.Paths
472
Colin Crossf24a22a2019-01-31 14:12:44 -0800473 hiddenAPI
Colin Cross43f08db2018-11-12 10:13:39 -0800474 dexpreopter
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800475
476 // list of the xref extraction files
477 kytheFiles android.Paths
Anton Hansson1e65f942020-03-27 19:39:48 +0000478
479 distFile android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700480}
481
Colin Cross41955e82019-05-29 14:40:35 -0700482func (j *Module) OutputFiles(tag string) (android.Paths, error) {
483 switch tag {
484 case "":
485 return append(android.Paths{j.outputFile}, j.extraOutputFiles...), nil
Colin Cross375ca3c2019-05-29 14:40:58 -0700486 case ".jar":
487 return android.Paths{j.implementationAndResourcesJar}, nil
Colin Cross2d975b12019-07-29 16:47:42 -0700488 case ".proguard_map":
489 return android.Paths{j.proguardDictionary}, nil
Colin Cross41955e82019-05-29 14:40:35 -0700490 default:
491 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
492 }
Colin Cross54250902017-12-05 09:28:08 -0800493}
494
Colin Cross41955e82019-05-29 14:40:35 -0700495var _ android.OutputFileProducer = (*Module)(nil)
Colin Cross54250902017-12-05 09:28:08 -0800496
Colin Crossf506d872017-07-19 15:53:04 -0700497type Dependency interface {
Nan Zhanged19fc32017-10-19 13:06:22 -0700498 HeaderJars() android.Paths
499 ImplementationJars() android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700500 ResourceJars() android.Paths
501 ImplementationAndResourcesJars() android.Paths
Colin Crossf24a22a2019-01-31 14:12:44 -0800502 DexJar() android.Path
Colin Cross635c3b02016-05-18 15:37:25 -0700503 AidlIncludeDirs() android.Paths
Jiyong Park1be96912018-05-28 18:02:19 +0900504 ExportedSdkLibs() []string
Artur Satayev9cf46692019-11-26 18:08:34 +0000505 ExportedPlugins() (android.Paths, []string)
Colin Cross0c4ce212019-05-03 15:28:19 -0700506 SrcJarArgs() ([]string, android.Paths)
Colin Crosse323f3c2019-09-17 15:34:09 -0700507 BaseModuleName() string
Jiyong Park618922e2020-01-08 13:35:43 +0900508 JacocoReportClassesFile() android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700509}
510
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800511type xref interface {
512 XrefJavaFiles() android.Paths
513}
514
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800515func (j *Module) XrefJavaFiles() android.Paths {
516 return j.kytheFiles
517}
518
Colin Cross89536d42017-07-07 14:35:50 -0700519func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
520 android.InitAndroidArchModule(module, hod, android.MultilibCommon)
521 android.InitDefaultableModule(module)
522}
523
Colin Crossbe1da472017-07-07 15:59:46 -0700524type dependencyTag struct {
525 blueprint.BaseDependencyTag
526 name string
Colin Cross2fe66872015-03-30 17:20:39 -0700527}
528
Colin Crossa4f08812018-10-02 22:03:40 -0700529type jniDependencyTag struct {
530 blueprint.BaseDependencyTag
Colin Crossa4f08812018-10-02 22:03:40 -0700531}
532
Jiyong Park8be103b2019-11-08 15:53:48 +0900533func IsJniDepTag(depTag blueprint.DependencyTag) bool {
534 _, ok := depTag.(*jniDependencyTag)
535 return ok
536}
537
Colin Crossbe1da472017-07-07 15:59:46 -0700538var (
Colin Cross4b964c02018-10-15 16:18:06 -0700539 staticLibTag = dependencyTag{name: "staticlib"}
540 libTag = dependencyTag{name: "javalib"}
Colin Cross6cef4812019-10-17 14:23:50 -0700541 java9LibTag = dependencyTag{name: "java9lib"}
Colin Crossbe9cdb82019-01-21 21:37:16 -0800542 pluginTag = dependencyTag{name: "plugin"}
Artur Satayev9cf46692019-11-26 18:08:34 +0000543 exportedPluginTag = dependencyTag{name: "exported-plugin"}
Colin Cross4b964c02018-10-15 16:18:06 -0700544 bootClasspathTag = dependencyTag{name: "bootclasspath"}
545 systemModulesTag = dependencyTag{name: "system modules"}
546 frameworkResTag = dependencyTag{name: "framework-res"}
547 frameworkApkTag = dependencyTag{name: "framework-apk"}
548 kotlinStdlibTag = dependencyTag{name: "kotlin-stdlib"}
Colin Crossafbb1732019-01-17 15:42:52 -0800549 kotlinAnnotationsTag = dependencyTag{name: "kotlin-annotations"}
Colin Cross4b964c02018-10-15 16:18:06 -0700550 proguardRaiseTag = dependencyTag{name: "proguard-raise"}
551 certificateTag = dependencyTag{name: "certificate"}
552 instrumentationForTag = dependencyTag{name: "instrumentation_for"}
Colin Cross50ddcc42019-05-16 12:28:22 -0700553 usesLibTag = dependencyTag{name: "uses-library"}
Colin Crossbe1da472017-07-07 15:59:46 -0700554)
Colin Cross2fe66872015-03-30 17:20:39 -0700555
Jiyong Park83dc74b2020-01-14 18:38:44 +0900556func IsLibDepTag(depTag blueprint.DependencyTag) bool {
557 return depTag == libTag
558}
559
560func IsStaticLibDepTag(depTag blueprint.DependencyTag) bool {
561 return depTag == staticLibTag
562}
563
Colin Crossfc3674a2017-09-18 17:41:52 -0700564type sdkDep struct {
Colin Cross47ff2522017-10-02 14:22:08 -0700565 useModule, useFiles, useDefaultLibs, invalidVersion bool
566
Colin Cross6cef4812019-10-17 14:23:50 -0700567 // The modules that will be added to the bootclasspath when targeting 1.8 or lower
568 bootclasspath []string
Paul Duffine25c6442019-10-11 13:50:28 +0100569
570 // The default system modules to use. Will be an empty string if no system
571 // modules are to be used.
Colin Cross1369cdb2017-09-29 17:58:17 -0700572 systemModules string
573
Colin Cross6cef4812019-10-17 14:23:50 -0700574 // The modules that will be added ot the classpath when targeting 1.9 or higher
575 java9Classpath []string
576
Colin Crossa97c5d32018-03-28 14:58:31 -0700577 frameworkResModule string
578
Colin Cross86a60ae2018-05-29 14:44:55 -0700579 jars android.Paths
Colin Cross3047fa22019-04-18 10:56:44 -0700580 aidl android.OptionalPath
Paul Duffin250e6192019-06-07 10:44:37 +0100581
582 noStandardLibs, noFrameworksLibs bool
583}
584
585func (s sdkDep) hasStandardLibs() bool {
586 return !s.noStandardLibs
587}
588
589func (s sdkDep) hasFrameworkLibs() bool {
590 return !s.noStandardLibs && !s.noFrameworksLibs
Colin Cross1369cdb2017-09-29 17:58:17 -0700591}
592
Colin Crossa4f08812018-10-02 22:03:40 -0700593type jniLib struct {
Jaewoong Jung37ca4a12020-03-26 14:01:48 -0700594 name string
595 path android.Path
596 target android.Target
597 coverageFile android.OptionalPath
Colin Crossa4f08812018-10-02 22:03:40 -0700598}
599
Colin Cross0ea8ba82019-06-06 14:33:29 -0700600func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
Colin Cross3144dfc2018-01-03 15:06:47 -0800601 return j.properties.Instrument && ctx.Config().IsEnvTrue("EMMA_INSTRUMENT")
602}
603
Colin Cross0ea8ba82019-06-06 14:33:29 -0700604func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Colin Cross3144dfc2018-01-03 15:06:47 -0800605 return j.shouldInstrument(ctx) &&
606 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
607 ctx.Config().UnbundledBuild())
608}
609
Jiyong Park6a927c42020-01-21 02:03:43 +0900610func (j *Module) sdkVersion() sdkSpec {
611 return sdkSpecFrom(String(j.deviceProperties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -0700612}
613
Paul Duffine25c6442019-10-11 13:50:28 +0100614func (j *Module) systemModules() string {
615 return proptools.String(j.deviceProperties.System_modules)
616}
617
Jiyong Park6a927c42020-01-21 02:03:43 +0900618func (j *Module) minSdkVersion() sdkSpec {
Colin Cross83bb3162018-06-25 15:48:06 -0700619 if j.deviceProperties.Min_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +0900620 return sdkSpecFrom(*j.deviceProperties.Min_sdk_version)
Colin Cross83bb3162018-06-25 15:48:06 -0700621 }
622 return j.sdkVersion()
623}
624
Jiyong Park6a927c42020-01-21 02:03:43 +0900625func (j *Module) targetSdkVersion() sdkSpec {
Dan Willemsen419290a2018-10-31 15:28:47 -0700626 if j.deviceProperties.Target_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +0900627 return sdkSpecFrom(*j.deviceProperties.Target_sdk_version)
Dan Willemsen419290a2018-10-31 15:28:47 -0700628 }
629 return j.sdkVersion()
630}
631
Artur Satayev388d39b2020-04-27 18:53:18 +0100632func (j *Module) MinSdkVersion() string {
633 return j.minSdkVersion().version.String()
634}
635
Jiyong Parkb02bb402019-12-03 00:43:57 +0900636func (j *Module) AvailableFor(what string) bool {
637 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
638 // Exception: for hostdex: true libraries, the platform variant is created
639 // even if it's not marked as available to platform. In that case, the platform
640 // variant is used only for the hostdex and not installed to the device.
641 return true
642 }
643 return j.ApexModuleBase.AvailableFor(what)
644}
645
Colin Crossbe1da472017-07-07 15:59:46 -0700646func (j *Module) deps(ctx android.BottomUpMutatorContext) {
Colin Cross1369cdb2017-09-29 17:58:17 -0700647 if ctx.Device() {
Paul Duffin250e6192019-06-07 10:44:37 +0100648 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Cross6d8d8c62019-10-28 15:10:03 -0700649 if sdkDep.useDefaultLibs {
650 ctx.AddVariationDependencies(nil, bootClasspathTag, config.DefaultBootclasspathLibraries...)
651 ctx.AddVariationDependencies(nil, systemModulesTag, config.DefaultSystemModules)
652 if sdkDep.hasFrameworkLibs() {
653 ctx.AddVariationDependencies(nil, libTag, config.DefaultLibraries...)
Colin Crossbe1da472017-07-07 15:59:46 -0700654 }
Colin Cross6d8d8c62019-10-28 15:10:03 -0700655 } else if sdkDep.useModule {
Colin Cross6cef4812019-10-17 14:23:50 -0700656 ctx.AddVariationDependencies(nil, bootClasspathTag, sdkDep.bootclasspath...)
Colin Cross6cef4812019-10-17 14:23:50 -0700657 ctx.AddVariationDependencies(nil, java9LibTag, sdkDep.java9Classpath...)
Colin Cross6d8d8c62019-10-28 15:10:03 -0700658 if j.deviceProperties.EffectiveOptimizeEnabled() && sdkDep.hasStandardLibs() {
659 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.DefaultBootclasspathLibraries...)
660 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.DefaultLibraries...)
661 }
Colin Cross2fe66872015-03-30 17:20:39 -0700662 }
Colin Crossdb224752020-05-14 18:05:32 -0700663 if sdkDep.systemModules != "" {
664 ctx.AddVariationDependencies(nil, systemModulesTag, sdkDep.systemModules)
665 }
Colin Cross6d8d8c62019-10-28 15:10:03 -0700666
Nan Zhangb2b33de2018-02-23 11:18:47 -0800667 if ctx.ModuleName() == "android_stubs_current" ||
668 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -0700669 ctx.ModuleName() == "android_test_stubs_current" {
Colin Cross42d48b72018-08-29 14:10:52 -0700670 ctx.AddVariationDependencies(nil, frameworkApkTag, "framework-res")
Nan Zhangb2b33de2018-02-23 11:18:47 -0800671 }
Colin Cross2fe66872015-03-30 17:20:39 -0700672 }
Colin Cross1369cdb2017-09-29 17:58:17 -0700673
Inseob Kimac1e9862019-12-09 18:15:47 +0900674 syspropPublicStubs := syspropPublicStubs(ctx.Config())
675
676 // rewriteSyspropLibs validates if a java module can link against platform's sysprop_library,
677 // and redirects dependency to public stub depending on the link type.
678 rewriteSyspropLibs := func(libs []string, prop string) []string {
679 // make a copy
680 ret := android.CopyOf(libs)
681
682 for idx, lib := range libs {
683 stub, ok := syspropPublicStubs[lib]
684
685 if !ok {
686 continue
687 }
688
689 linkType, _ := j.getLinkType(ctx.ModuleName())
Inseob Kimc5239512020-01-14 15:36:21 +0900690 // only platform modules can use internal props
691 if linkType != javaPlatform {
Inseob Kimac1e9862019-12-09 18:15:47 +0900692 ret[idx] = stub
Inseob Kimac1e9862019-12-09 18:15:47 +0900693 }
694 }
695
696 return ret
697 }
698
699 ctx.AddVariationDependencies(nil, libTag, rewriteSyspropLibs(j.properties.Libs, "libs")...)
700 ctx.AddVariationDependencies(nil, staticLibTag, rewriteSyspropLibs(j.properties.Static_libs, "static_libs")...)
Colin Crossa4f08812018-10-02 22:03:40 -0700701
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700702 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
Artur Satayev9cf46692019-11-26 18:08:34 +0000703 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
Colin Crossbe9cdb82019-01-21 21:37:16 -0800704
Colin Crossfe17f6f2019-03-28 19:30:56 -0700705 android.ProtoDeps(ctx, &j.protoProperties)
Colin Cross6af17aa2017-09-20 12:59:05 -0700706 if j.hasSrcExt(".proto") {
707 protoDeps(ctx, &j.protoProperties)
708 }
Colin Cross93e85952017-08-15 13:34:18 -0700709
710 if j.hasSrcExt(".kt") {
711 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
712 // Kotlin files
Colin Cross0b03d972019-05-13 11:06:25 -0700713 ctx.AddVariationDependencies(nil, kotlinStdlibTag,
714 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8")
Colin Cross7788c122019-01-23 16:14:02 -0800715 if len(j.properties.Plugins) > 0 {
Colin Crossafbb1732019-01-17 15:42:52 -0800716 ctx.AddVariationDependencies(nil, kotlinAnnotationsTag, "kotlin-annotations")
717 }
Colin Cross93e85952017-08-15 13:34:18 -0700718 }
Colin Cross3144dfc2018-01-03 15:06:47 -0800719
Ulya Trafimovich38dfa0f2020-01-07 16:37:02 +0000720 // Framework libraries need special handling in static coverage builds: they should not have
721 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
722 // the same jacoco classes coming from different bootclasspath jars.
723 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
724 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
725 j.properties.Instrument = true
726 }
727 } else if j.shouldInstrumentStatic(ctx) {
Colin Cross42d48b72018-08-29 14:10:52 -0700728 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
Colin Cross3144dfc2018-01-03 15:06:47 -0800729 }
Colin Cross6af17aa2017-09-20 12:59:05 -0700730}
731
732func hasSrcExt(srcs []string, ext string) bool {
733 for _, src := range srcs {
734 if filepath.Ext(src) == ext {
735 return true
736 }
737 }
738
739 return false
740}
741
742func (j *Module) hasSrcExt(ext string) bool {
743 return hasSrcExt(j.properties.Srcs, ext)
Colin Cross2fe66872015-03-30 17:20:39 -0700744}
745
Colin Cross46c9b8b2017-06-22 16:51:17 -0700746func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Colin Cross3047fa22019-04-18 10:56:44 -0700747 aidlIncludeDirs android.Paths) (string, android.Paths) {
Colin Crossc0b06f12015-04-08 13:03:43 -0700748
Colin Crossebe1a512017-11-14 13:12:14 -0800749 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
750 aidlIncludes = append(aidlIncludes,
751 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
752 aidlIncludes = append(aidlIncludes,
753 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
Colin Crossc0b06f12015-04-08 13:03:43 -0700754
Colin Cross3047fa22019-04-18 10:56:44 -0700755 var flags []string
756 var deps android.Paths
Steven Moreland667f6882018-07-26 12:55:08 -0700757
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700758 if aidlPreprocess.Valid() {
759 flags = append(flags, "-p"+aidlPreprocess.String())
Colin Cross3047fa22019-04-18 10:56:44 -0700760 deps = append(deps, aidlPreprocess.Path())
761 } else if len(aidlIncludeDirs) > 0 {
Colin Cross635c3b02016-05-18 15:37:25 -0700762 flags = append(flags, android.JoinWithPrefix(aidlIncludeDirs.Strings(), "-I"))
Colin Crossc0b06f12015-04-08 13:03:43 -0700763 }
764
Colin Cross3047fa22019-04-18 10:56:44 -0700765 if len(j.exportAidlIncludeDirs) > 0 {
766 flags = append(flags, android.JoinWithPrefix(j.exportAidlIncludeDirs.Strings(), "-I"))
767 }
768
769 if len(aidlIncludes) > 0 {
770 flags = append(flags, android.JoinWithPrefix(aidlIncludes.Strings(), "-I"))
771 }
772
Colin Cross635c3b02016-05-18 15:37:25 -0700773 flags = append(flags, "-I"+android.PathForModuleSrc(ctx).String())
Colin Cross32f38982018-02-22 11:47:25 -0800774 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Colin Crossd48633a2017-07-13 14:41:17 -0700775 flags = append(flags, "-I"+src.String())
776 }
Colin Crossc0b06f12015-04-08 13:03:43 -0700777
Martijn Coeneneab15642018-03-09 09:29:59 +0100778 if Bool(j.deviceProperties.Aidl.Generate_traces) {
779 flags = append(flags, "-t")
780 }
781
Olivier Gaillard0a4cfbc2018-07-16 23:37:03 +0100782 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
783 flags = append(flags, "--transaction_names")
784 }
785
Colin Cross3047fa22019-04-18 10:56:44 -0700786 return strings.Join(flags, " "), deps
Colin Crossc0b06f12015-04-08 13:03:43 -0700787}
788
Colin Cross32f676a2017-09-06 13:41:06 -0700789type deps struct {
Nan Zhang581fd212018-01-10 16:06:12 -0800790 classpath classpath
Colin Cross6cef4812019-10-17 14:23:50 -0700791 java9Classpath classpath
Nan Zhang581fd212018-01-10 16:06:12 -0800792 bootClasspath classpath
Colin Cross6a77c982018-06-19 22:43:34 -0700793 processorPath classpath
Colin Crossbe9cdb82019-01-21 21:37:16 -0800794 processorClasses []string
Colin Cross6ade34f2017-09-15 13:00:47 -0700795 staticJars android.Paths
Nan Zhanged19fc32017-10-19 13:06:22 -0700796 staticHeaderJars android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700797 staticResourceJars android.Paths
Colin Cross6ade34f2017-09-15 13:00:47 -0700798 aidlIncludeDirs android.Paths
Nan Zhangb2b33de2018-02-23 11:18:47 -0800799 srcs android.Paths
Colin Cross59149b62017-10-16 18:07:29 -0700800 srcJars android.Paths
Colin Crossb77043e2019-07-16 13:57:13 -0700801 systemModules *systemModules
Colin Cross6ade34f2017-09-15 13:00:47 -0700802 aidlPreprocess android.OptionalPath
Colin Cross93e85952017-08-15 13:34:18 -0700803 kotlinStdlib android.Paths
Colin Crossafbb1732019-01-17 15:42:52 -0800804 kotlinAnnotations android.Paths
Colin Crossbe9cdb82019-01-21 21:37:16 -0800805
806 disableTurbine bool
Colin Cross32f676a2017-09-06 13:41:06 -0700807}
Colin Cross2fe66872015-03-30 17:20:39 -0700808
Colin Cross54250902017-12-05 09:28:08 -0800809func checkProducesJars(ctx android.ModuleContext, dep android.SourceFileProducer) {
810 for _, f := range dep.Srcs() {
811 if f.Ext() != ".jar" {
812 ctx.ModuleErrorf("genrule %q must generate files ending with .jar to be used as a libs or static_libs dependency",
813 ctx.OtherModuleName(dep.(blueprint.Module)))
814 }
815 }
816}
817
Jiyong Park2d492942018-03-05 17:44:10 +0900818type linkType int
819
820const (
Jiyong Park50146e92020-01-30 18:00:15 +0900821 // TODO(jiyong) rename these for better readability. Make the allowed
822 // and disallowed link types explicit
Jiyong Park2d492942018-03-05 17:44:10 +0900823 javaCore linkType = iota
824 javaSdk
825 javaSystem
Jiyong Park50146e92020-01-30 18:00:15 +0900826 javaModule
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900827 javaSystemServer
Jiyong Park2d492942018-03-05 17:44:10 +0900828 javaPlatform
829)
830
Jeongik Cha75b83b02019-11-01 15:28:00 +0900831type linkTypeContext interface {
832 android.Module
833 getLinkType(name string) (ret linkType, stubs bool)
834}
835
836func (m *Module) getLinkType(name string) (ret linkType, stubs bool) {
Anton Hanssonac103462020-05-19 12:06:48 +0100837 switch name {
838 case "core.current.stubs", "core.platform.api.stubs", "stub-annotations",
839 "private-stub-annotations-jar", "core-lambda-stubs", "core-generated-annotation-stubs":
Jiyong Park46f78fb2018-10-20 16:33:17 +0900840 return javaCore, true
Anton Hanssonac103462020-05-19 12:06:48 +0100841 case "android_stubs_current":
Jiyong Park46f78fb2018-10-20 16:33:17 +0900842 return javaSdk, true
Anton Hanssonac103462020-05-19 12:06:48 +0100843 case "android_system_stubs_current":
844 return javaSystem, true
845 case "android_module_lib_stubs_current":
Jiyong Park50146e92020-01-30 18:00:15 +0900846 return javaModule, true
Anton Hanssonac103462020-05-19 12:06:48 +0100847 case "android_system_server_stubs_current":
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900848 return javaSystemServer, true
Anton Hanssonac103462020-05-19 12:06:48 +0100849 case "android_test_stubs_current":
850 return javaSystem, true
Jiyong Park2d492942018-03-05 17:44:10 +0900851 }
Anton Hanssonac103462020-05-19 12:06:48 +0100852
Anton Hansson0bd88d02020-05-25 12:20:51 +0100853 if stub, linkType := moduleStubLinkType(name); stub {
854 return linkType, true
855 }
856
Anton Hanssonac103462020-05-19 12:06:48 +0100857 ver := m.sdkVersion()
858 switch ver.kind {
859 case sdkCore:
860 return javaCore, false
861 case sdkSystem:
862 return javaSystem, false
863 case sdkPublic:
864 return javaSdk, false
865 case sdkModule:
866 return javaModule, false
867 case sdkSystemServer:
868 return javaSystemServer, false
869 case sdkPrivate, sdkNone, sdkCorePlatform, sdkTest:
870 return javaPlatform, false
871 }
872
873 if !ver.valid() {
874 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.raw))
875 }
876 return javaSdk, false
Jiyong Park2d492942018-03-05 17:44:10 +0900877}
878
Jeongik Cha75b83b02019-11-01 15:28:00 +0900879func checkLinkType(ctx android.ModuleContext, from *Module, to linkTypeContext, tag dependencyTag) {
Colin Crossf19b9bb2018-03-26 14:42:44 -0700880 if ctx.Host() {
881 return
882 }
883
Jeongik Cha75b83b02019-11-01 15:28:00 +0900884 myLinkType, stubs := from.getLinkType(ctx.ModuleName())
Jiyong Park46f78fb2018-10-20 16:33:17 +0900885 if stubs {
886 return
887 }
Jeongik Cha75b83b02019-11-01 15:28:00 +0900888 otherLinkType, _ := to.getLinkType(ctx.OtherModuleName(to))
Jiyong Park2d492942018-03-05 17:44:10 +0900889 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."
890
891 switch myLinkType {
892 case javaCore:
893 if otherLinkType != javaCore {
894 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 +0900895 ctx.OtherModuleName(to))
896 }
Jiyong Park2d492942018-03-05 17:44:10 +0900897 break
898 case javaSdk:
899 if otherLinkType != javaCore && otherLinkType != javaSdk {
900 ctx.ModuleErrorf("compiles against Android API, but dependency %q is compiling against non-public Android API."+commonMessage,
901 ctx.OtherModuleName(to))
902 }
903 break
904 case javaSystem:
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900905 if otherLinkType == javaPlatform || otherLinkType == javaModule || otherLinkType == javaSystemServer {
Jiyong Park2d492942018-03-05 17:44:10 +0900906 ctx.ModuleErrorf("compiles against system API, but dependency %q is compiling against private API."+commonMessage,
907 ctx.OtherModuleName(to))
908 }
909 break
Jiyong Park50146e92020-01-30 18:00:15 +0900910 case javaModule:
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900911 if otherLinkType == javaPlatform || otherLinkType == javaSystemServer {
Jiyong Park50146e92020-01-30 18:00:15 +0900912 ctx.ModuleErrorf("compiles against module API, but dependency %q is compiling against private API."+commonMessage,
913 ctx.OtherModuleName(to))
914 }
915 break
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900916 case javaSystemServer:
917 if otherLinkType == javaPlatform {
918 ctx.ModuleErrorf("compiles against system server API, but dependency %q is compiling against private API."+commonMessage,
919 ctx.OtherModuleName(to))
920 }
921 break
Jiyong Park2d492942018-03-05 17:44:10 +0900922 case javaPlatform:
923 // no restriction on link-type
924 break
Jiyong Park750e5572018-01-31 00:20:13 +0900925 }
926}
927
Colin Cross32f676a2017-09-06 13:41:06 -0700928func (j *Module) collectDeps(ctx android.ModuleContext) deps {
929 var deps deps
Colin Crossfc3674a2017-09-18 17:41:52 -0700930
Colin Cross300f0382018-03-06 13:11:51 -0800931 if ctx.Device() {
Colin Cross83bb3162018-06-25 15:48:06 -0700932 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Cross300f0382018-03-06 13:11:51 -0800933 if sdkDep.invalidVersion {
Colin Cross6cef4812019-10-17 14:23:50 -0700934 ctx.AddMissingDependencies(sdkDep.bootclasspath)
935 ctx.AddMissingDependencies(sdkDep.java9Classpath)
Colin Cross300f0382018-03-06 13:11:51 -0800936 } else if sdkDep.useFiles {
937 // sdkDep.jar is actually equivalent to turbine header.jar.
Colin Cross86a60ae2018-05-29 14:44:55 -0700938 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross3047fa22019-04-18 10:56:44 -0700939 deps.aidlPreprocess = sdkDep.aidl
940 } else {
941 deps.aidlPreprocess = sdkDep.aidl
Colin Cross300f0382018-03-06 13:11:51 -0800942 }
Colin Crossfc3674a2017-09-18 17:41:52 -0700943 }
944
Paul Duffin64e61992020-05-15 10:20:31 +0100945 // If this is a component library (stubs, etc.) for a java_sdk_library then
946 // add the name of that java_sdk_library to the exported sdk libs to make sure
947 // that, if necessary, a <uses-library> element for that java_sdk_library is
948 // added to the Android manifest.
949 j.exportedSdkLibs = append(j.exportedSdkLibs, j.OptionalImplicitSdkLibrary()...)
950
Colin Crossd11fcda2017-10-23 17:59:01 -0700951 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross2fe66872015-03-30 17:20:39 -0700952 otherName := ctx.OtherModuleName(module)
Colin Crossec7a0422017-07-07 14:47:12 -0700953 tag := ctx.OtherModuleDependencyTag(module)
954
Colin Crossa4f08812018-10-02 22:03:40 -0700955 if _, ok := tag.(*jniDependencyTag); ok {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700956 // Handled by AndroidApp.collectAppDeps
957 return
958 }
959 if tag == certificateTag {
960 // Handled by AndroidApp.collectAppDeps
Colin Crossa4f08812018-10-02 22:03:40 -0700961 return
962 }
Artur Satayeve5ac15a2020-04-08 19:09:30 +0100963
Colin Cross54250902017-12-05 09:28:08 -0800964 switch dep := module.(type) {
Colin Cross897d2ed2019-02-11 14:03:51 -0800965 case SdkLibraryDependency:
966 switch tag {
967 case libTag:
968 deps.classpath = append(deps.classpath, dep.SdkHeaderJars(ctx, j.sdkVersion())...)
969 // names of sdk libs that are directly depended are exported
Paul Duffin64e61992020-05-15 10:20:31 +0100970 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.OptionalImplicitSdkLibrary()...)
Colin Cross79c7c262019-04-17 11:11:46 -0700971 case staticLibTag:
Colin Cross897d2ed2019-02-11 14:03:51 -0800972 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
973 }
Colin Cross54250902017-12-05 09:28:08 -0800974 case Dependency:
975 switch tag {
976 case bootClasspathTag:
977 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars()...)
Colin Cross4b964c02018-10-15 16:18:06 -0700978 case libTag, instrumentationForTag:
Colin Cross54250902017-12-05 09:28:08 -0800979 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +0900980 // sdk lib names from dependencies are re-exported
981 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -0700982 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Artur Satayev9cf46692019-11-26 18:08:34 +0000983 pluginJars, pluginClasses := dep.ExportedPlugins()
984 addPlugins(&deps, pluginJars, pluginClasses...)
Colin Cross6cef4812019-10-17 14:23:50 -0700985 case java9LibTag:
986 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars()...)
Colin Cross54250902017-12-05 09:28:08 -0800987 case staticLibTag:
988 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
989 deps.staticJars = append(deps.staticJars, dep.ImplementationJars()...)
990 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars()...)
Colin Cross331a1212018-08-15 20:40:52 -0700991 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +0900992 // sdk lib names from dependencies are re-exported
993 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -0700994 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Artur Satayev9cf46692019-11-26 18:08:34 +0000995 pluginJars, pluginClasses := dep.ExportedPlugins()
996 addPlugins(&deps, pluginJars, pluginClasses...)
Colin Crossbe9cdb82019-01-21 21:37:16 -0800997 case pluginTag:
998 if plugin, ok := dep.(*Plugin); ok {
Colin Crossbe9cdb82019-01-21 21:37:16 -0800999 if plugin.pluginProperties.Processor_class != nil {
Artur Satayev9cf46692019-11-26 18:08:34 +00001000 addPlugins(&deps, plugin.ImplementationAndResourcesJars(), *plugin.pluginProperties.Processor_class)
1001 } else {
1002 addPlugins(&deps, plugin.ImplementationAndResourcesJars())
Colin Crossbe9cdb82019-01-21 21:37:16 -08001003 }
1004 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
1005 } else {
1006 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
1007 }
Artur Satayev9cf46692019-11-26 18:08:34 +00001008 case exportedPluginTag:
1009 if plugin, ok := dep.(*Plugin); ok {
1010 if plugin.pluginProperties.Generates_api != nil && *plugin.pluginProperties.Generates_api {
1011 ctx.PropertyErrorf("exported_plugins", "Cannot export plugins with generates_api = true, found %v", otherName)
1012 }
1013 j.exportedPluginJars = append(j.exportedPluginJars, plugin.ImplementationAndResourcesJars()...)
1014 if plugin.pluginProperties.Processor_class != nil {
1015 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
1016 }
1017 } else {
1018 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
1019 }
Nan Zhangb2b33de2018-02-23 11:18:47 -08001020 case frameworkApkTag:
1021 if ctx.ModuleName() == "android_stubs_current" ||
1022 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -07001023 ctx.ModuleName() == "android_test_stubs_current" {
Nan Zhangb2b33de2018-02-23 11:18:47 -08001024 // framework stubs.jar need to depend on framework-res.apk, in order to pull the
1025 // resource files out of there for aapt.
1026 //
1027 // Normally the package rule runs aapt, which includes the resource,
1028 // but we're not running that in our package rule so just copy in the
1029 // resource files here.
Colin Cross331a1212018-08-15 20:40:52 -07001030 deps.staticResourceJars = append(deps.staticResourceJars, dep.(*AndroidApp).exportPackage)
Nan Zhangb2b33de2018-02-23 11:18:47 -08001031 }
Colin Cross54250902017-12-05 09:28:08 -08001032 case kotlinStdlibTag:
Colin Cross0b03d972019-05-13 11:06:25 -07001033 deps.kotlinStdlib = append(deps.kotlinStdlib, dep.HeaderJars()...)
Colin Crossafbb1732019-01-17 15:42:52 -08001034 case kotlinAnnotationsTag:
1035 deps.kotlinAnnotations = dep.HeaderJars()
Colin Cross54250902017-12-05 09:28:08 -08001036 }
1037
Colin Cross54250902017-12-05 09:28:08 -08001038 case android.SourceFileProducer:
1039 switch tag {
1040 case libTag:
1041 checkProducesJars(ctx, dep)
1042 deps.classpath = append(deps.classpath, dep.Srcs()...)
1043 case staticLibTag:
1044 checkProducesJars(ctx, dep)
1045 deps.classpath = append(deps.classpath, dep.Srcs()...)
1046 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
1047 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Cross54250902017-12-05 09:28:08 -08001048 }
1049 default:
Colin Crossec7a0422017-07-07 14:47:12 -07001050 switch tag {
Paul Duffin68289b02019-09-20 13:50:52 +01001051 case bootClasspathTag:
1052 // If a system modules dependency has been added to the bootclasspath
1053 // then add its libs to the bootclasspath.
Paul Duffin83a2d962019-11-19 19:44:10 +00001054 sm := module.(SystemModulesProvider)
1055 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars()...)
Paul Duffin68289b02019-09-20 13:50:52 +01001056
Colin Cross1369cdb2017-09-29 17:58:17 -07001057 case systemModulesTag:
1058 if deps.systemModules != nil {
1059 panic("Found two system module dependencies")
1060 }
Paul Duffin83a2d962019-11-19 19:44:10 +00001061 sm := module.(SystemModulesProvider)
1062 outputDir, outputDeps := sm.OutputDirAndDeps()
1063 deps.systemModules = &systemModules{outputDir, outputDeps}
Colin Cross2fe66872015-03-30 17:20:39 -07001064 }
Colin Crossec7a0422017-07-07 14:47:12 -07001065 }
Colin Cross2fe66872015-03-30 17:20:39 -07001066 })
1067
Jiyong Park1be96912018-05-28 18:02:19 +09001068 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
1069
Colin Cross32f676a2017-09-06 13:41:06 -07001070 return deps
Colin Cross2fe66872015-03-30 17:20:39 -07001071}
1072
Artur Satayev9cf46692019-11-26 18:08:34 +00001073func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
1074 deps.processorPath = append(deps.processorPath, pluginJars...)
1075 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
1076}
1077
Colin Cross1e743852019-10-28 11:37:20 -07001078func getJavaVersion(ctx android.ModuleContext, javaVersion string, sdkContext sdkContext) javaVersion {
Nan Zhang357466b2018-04-17 17:38:36 -07001079 if javaVersion != "" {
Colin Cross1e743852019-10-28 11:37:20 -07001080 return normalizeJavaVersion(ctx, javaVersion)
Colin Crossdb224752020-05-14 18:05:32 -07001081 } else if ctx.Device() {
1082 return sdkContext.sdkVersion().defaultJavaLanguageVersion(ctx)
Nan Zhang357466b2018-04-17 17:38:36 -07001083 } else {
Colin Cross1e743852019-10-28 11:37:20 -07001084 return JAVA_VERSION_9
Nan Zhang357466b2018-04-17 17:38:36 -07001085 }
Nan Zhang357466b2018-04-17 17:38:36 -07001086}
1087
Colin Cross1e743852019-10-28 11:37:20 -07001088type javaVersion int
1089
1090const (
1091 JAVA_VERSION_UNSUPPORTED = 0
1092 JAVA_VERSION_6 = 6
1093 JAVA_VERSION_7 = 7
1094 JAVA_VERSION_8 = 8
1095 JAVA_VERSION_9 = 9
1096)
1097
1098func (v javaVersion) String() string {
1099 switch v {
1100 case JAVA_VERSION_6:
1101 return "1.6"
1102 case JAVA_VERSION_7:
1103 return "1.7"
1104 case JAVA_VERSION_8:
1105 return "1.8"
1106 case JAVA_VERSION_9:
1107 return "1.9"
1108 default:
1109 return "unsupported"
1110 }
1111}
1112
1113// Returns true if javac targeting this version uses system modules instead of a bootclasspath.
1114func (v javaVersion) usesJavaModules() bool {
1115 return v >= 9
1116}
1117
1118func normalizeJavaVersion(ctx android.BaseModuleContext, javaVersion string) javaVersion {
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001119 switch javaVersion {
1120 case "1.6", "6":
Colin Cross1e743852019-10-28 11:37:20 -07001121 return JAVA_VERSION_6
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001122 case "1.7", "7":
Colin Cross1e743852019-10-28 11:37:20 -07001123 return JAVA_VERSION_7
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001124 case "1.8", "8":
Colin Cross1e743852019-10-28 11:37:20 -07001125 return JAVA_VERSION_8
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001126 case "1.9", "9":
Colin Cross1e743852019-10-28 11:37:20 -07001127 return JAVA_VERSION_9
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001128 case "10", "11":
1129 ctx.PropertyErrorf("java_version", "Java language levels above 9 are not supported")
Colin Cross1e743852019-10-28 11:37:20 -07001130 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001131 default:
1132 ctx.PropertyErrorf("java_version", "Unrecognized Java language level")
Colin Cross1e743852019-10-28 11:37:20 -07001133 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001134 }
1135}
1136
Nan Zhanged19fc32017-10-19 13:06:22 -07001137func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
Colin Crossc0b06f12015-04-08 13:03:43 -07001138
Colin Crossf03c82b2015-04-13 13:53:40 -07001139 var flags javaBuilderFlags
1140
Tobias Thierer06dd04f2018-09-11 16:21:05 +01001141 // javaVersion flag.
1142 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), sdkContext(j))
1143
Nan Zhanged19fc32017-10-19 13:06:22 -07001144 // javac flags.
Colin Crossf03c82b2015-04-13 13:53:40 -07001145 javacFlags := j.properties.Javacflags
Colin Cross1e743852019-10-28 11:37:20 -07001146 if flags.javaVersion.usesJavaModules() {
Colin Cross1369cdb2017-09-29 17:58:17 -07001147 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Nan Zhanged19fc32017-10-19 13:06:22 -07001148 }
Colin Cross6510f912017-11-29 00:27:14 -08001149 if ctx.Config().MinimizeJavaDebugInfo() {
Colin Cross126a25c2017-10-31 13:55:34 -07001150 // Override the -g flag passed globally to remove local variable debug info to reduce
1151 // disk and memory usage.
1152 javacFlags = append(javacFlags, "-g:source,lines")
1153 }
Colin Crossc228a702019-11-06 16:18:05 -08001154 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
Colin Cross64162712017-08-08 13:17:59 -07001155
Colin Cross66548102018-06-19 22:47:35 -07001156 if ctx.Config().RunErrorProne() {
1157 if config.ErrorProneClasspath == nil {
1158 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1159 }
1160
1161 errorProneFlags := []string{
1162 "-Xplugin:ErrorProne",
1163 "${config.ErrorProneChecks}",
1164 }
1165 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1166
1167 flags.errorProneExtraJavacFlags = "${config.ErrorProneFlags} " +
1168 "'" + strings.Join(errorProneFlags, " ") + "'"
1169 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
Andreas Gampef3e5b552018-01-22 21:27:21 -08001170 }
1171
Nan Zhanged19fc32017-10-19 13:06:22 -07001172 // classpath
Nan Zhang581fd212018-01-10 16:06:12 -08001173 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1174 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross6cef4812019-10-17 14:23:50 -07001175 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
Colin Cross6a77c982018-06-19 22:43:34 -07001176 flags.processorPath = append(flags.processorPath, deps.processorPath...)
Colin Cross7fdd2b72018-01-02 18:14:25 -08001177
Colin Crossd99540b2020-04-22 11:44:34 -07001178 flags.processors = append(flags.processors, deps.processorClasses...)
1179 flags.processors = android.FirstUniqueStrings(flags.processors)
Colin Crossbe9cdb82019-01-21 21:37:16 -08001180
Colin Cross1e743852019-10-28 11:37:20 -07001181 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
1182 decodeSdkDep(ctx, sdkContext(j)).hasStandardLibs() {
Colin Cross7fdd2b72018-01-02 18:14:25 -08001183 // Give host-side tools a version of OpenJDK's standard libraries
1184 // close to what they're targeting. As of Dec 2017, AOSP is only
1185 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1186 //
1187 // When building with OpenJDK 8, the following should have no
1188 // effect since those jars would be available by default.
1189 //
1190 // When building with OpenJDK 9 but targeting a version < 1.8,
1191 // putting them on the bootclasspath means that:
1192 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1193 // b) references to existing APIs are not reinterpreted in an
1194 // OpenJDK 9-specific way, eg. calls to subclasses of
1195 // java.nio.Buffer as in http://b/70862583
1196 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1197 flags.bootClasspath = append(flags.bootClasspath,
1198 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1199 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
Nan Zhang5f8cb422018-02-06 10:34:32 -08001200 if Bool(j.properties.Use_tools_jar) {
1201 flags.bootClasspath = append(flags.bootClasspath,
1202 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1203 }
Colin Cross7fdd2b72018-01-02 18:14:25 -08001204 }
1205
Colin Cross1e743852019-10-28 11:37:20 -07001206 if j.properties.Patch_module != nil && flags.javaVersion.usesJavaModules() {
Jaewoong Jung38e4fb22018-12-12 09:01:34 -08001207 // Manually specify build directory in case it is not under the repo root.
1208 // (javac doesn't seem to expand into symbolc links when searching for patch-module targets, so
1209 // just adding a symlink under the root doesn't help.)
1210 patchPaths := ".:" + ctx.Config().BuildDir()
1211 classPath := flags.classpath.FormJavaClassPath("")
1212 if classPath != "" {
1213 patchPaths += ":" + classPath
1214 }
1215 javacFlags = append(javacFlags, "--patch-module="+String(j.properties.Patch_module)+"="+patchPaths)
Colin Cross81440082018-08-15 20:21:55 -07001216 }
1217
Nan Zhanged19fc32017-10-19 13:06:22 -07001218 // systemModules
Colin Crossb77043e2019-07-16 13:57:13 -07001219 flags.systemModules = deps.systemModules
Colin Cross1369cdb2017-09-29 17:58:17 -07001220
Nan Zhanged19fc32017-10-19 13:06:22 -07001221 // aidl flags.
Colin Cross3047fa22019-04-18 10:56:44 -07001222 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs)
Colin Cross2fe66872015-03-30 17:20:39 -07001223
Colin Cross81440082018-08-15 20:21:55 -07001224 if len(javacFlags) > 0 {
1225 // optimization.
1226 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1227 flags.javacFlags = "$javacFlags"
1228 }
1229
Nan Zhanged19fc32017-10-19 13:06:22 -07001230 return flags
1231}
Colin Crossc0b06f12015-04-08 13:03:43 -07001232
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001233func (j *Module) compile(ctx android.ModuleContext, aaptSrcJar android.Path) {
Colin Crossebe1a512017-11-14 13:12:14 -08001234 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
Nan Zhanged19fc32017-10-19 13:06:22 -07001235
1236 deps := j.collectDeps(ctx)
1237 flags := j.collectBuilderFlags(ctx, deps)
1238
Colin Cross1e743852019-10-28 11:37:20 -07001239 if flags.javaVersion.usesJavaModules() {
Nan Zhanged19fc32017-10-19 13:06:22 -07001240 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
1241 }
Colin Cross8a497952019-03-05 22:25:09 -08001242 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Colin Cross6af17aa2017-09-20 12:59:05 -07001243 if hasSrcExt(srcFiles.Strings(), ".proto") {
Colin Cross0f2ee152017-12-14 15:22:43 -08001244 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
Colin Cross6af17aa2017-09-20 12:59:05 -07001245 }
1246
Colin Crossaf050172017-11-15 23:01:59 -08001247 srcFiles = j.genSources(ctx, srcFiles, flags)
1248
1249 srcJars := srcFiles.FilterByExt(".srcjar")
Colin Cross59149b62017-10-16 18:07:29 -07001250 srcJars = append(srcJars, deps.srcJars...)
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001251 if aaptSrcJar != nil {
1252 srcJars = append(srcJars, aaptSrcJar)
1253 }
Colin Crossb7a63242015-04-16 14:09:14 -07001254
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001255 if j.properties.Jarjar_rules != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001256 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001257 }
1258
Colin Cross1ee23172017-10-18 14:44:18 -07001259 jarName := ctx.ModuleName() + ".jar"
1260
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001261 javaSrcFiles := srcFiles.FilterByExt(".java")
1262 var uniqueSrcFiles android.Paths
1263 set := make(map[string]bool)
1264 for _, v := range javaSrcFiles {
1265 if _, found := set[v.String()]; !found {
1266 set[v.String()] = true
1267 uniqueSrcFiles = append(uniqueSrcFiles, v)
1268 }
1269 }
1270
patricktu242faad2019-09-24 15:41:30 +08001271 // Collect .java files for AIDEGen
1272 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1273
Colin Cross55f63ea2018-08-27 12:37:09 -07001274 var kotlinJars android.Paths
1275
Colin Cross93e85952017-08-15 13:34:18 -07001276 if srcFiles.HasExt(".kt") {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001277 // user defined kotlin flags.
1278 kotlincFlags := j.properties.Kotlincflags
1279 CheckKotlincFlags(ctx, kotlincFlags)
1280
Colin Cross93e85952017-08-15 13:34:18 -07001281 // If there are kotlin files, compile them first but pass all the kotlin and java files
1282 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1283 // won't emit any classes for them.
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001284 kotlincFlags = append(kotlincFlags, "-no-stdlib")
Colin Cross93e85952017-08-15 13:34:18 -07001285 if ctx.Device() {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001286 kotlincFlags = append(kotlincFlags, "-no-jdk")
1287 }
1288 if len(kotlincFlags) > 0 {
1289 // optimization.
1290 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1291 flags.kotlincFlags += "$kotlincFlags"
Colin Cross93e85952017-08-15 13:34:18 -07001292 }
1293
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001294 var kotlinSrcFiles android.Paths
1295 kotlinSrcFiles = append(kotlinSrcFiles, uniqueSrcFiles...)
1296 kotlinSrcFiles = append(kotlinSrcFiles, srcFiles.FilterByExt(".kt")...)
1297
patricktu242faad2019-09-24 15:41:30 +08001298 // Collect .kt files for AIDEGen
1299 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, srcFiles.FilterByExt(".kt").Strings()...)
1300
Colin Crossafbb1732019-01-17 15:42:52 -08001301 flags.classpath = append(flags.classpath, deps.kotlinStdlib...)
1302 flags.classpath = append(flags.classpath, deps.kotlinAnnotations...)
1303
1304 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1305 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1306
1307 if len(flags.processorPath) > 0 {
1308 // Use kapt for annotation processing
1309 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1310 kotlinKapt(ctx, kaptSrcJar, kotlinSrcFiles, srcJars, flags)
1311 srcJars = append(srcJars, kaptSrcJar)
1312 // Disable annotation processing in javac, it's already been handled by kapt
1313 flags.processorPath = nil
Colin Crossd99540b2020-04-22 11:44:34 -07001314 flags.processors = nil
Colin Crossafbb1732019-01-17 15:42:52 -08001315 }
Colin Cross93e85952017-08-15 13:34:18 -07001316
Colin Cross1ee23172017-10-18 14:44:18 -07001317 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross21fc9bb2019-01-18 15:05:09 -08001318 kotlinCompile(ctx, kotlinJar, kotlinSrcFiles, srcJars, flags)
Colin Cross93e85952017-08-15 13:34:18 -07001319 if ctx.Failed() {
1320 return
1321 }
1322
1323 // Make javac rule depend on the kotlinc rule
1324 flags.classpath = append(flags.classpath, kotlinJar)
Przemyslaw Szczepaniak66c0c402018-03-08 13:21:55 +00001325
Colin Cross93e85952017-08-15 13:34:18 -07001326 // Jar kotlin classes into the final jar after javac
Colin Cross55f63ea2018-08-27 12:37:09 -07001327 kotlinJars = append(kotlinJars, kotlinJar)
Colin Cross9b38aef2018-08-27 15:42:25 -07001328 kotlinJars = append(kotlinJars, deps.kotlinStdlib...)
Colin Cross93e85952017-08-15 13:34:18 -07001329 }
1330
Colin Cross55f63ea2018-08-27 12:37:09 -07001331 jars := append(android.Paths(nil), kotlinJars...)
1332
Colin Cross5ab4e6d2017-11-22 16:20:45 -08001333 // Store the list of .java files that was passed to javac
1334 j.compiledJavaSrcs = uniqueSrcFiles
1335 j.compiledSrcJars = srcJars
1336
Nan Zhang61eaedb2017-11-02 13:28:15 -07001337 enable_sharding := false
Colin Crossf5a66282020-02-21 08:16:41 -08001338 var headerJarFileWithoutJarjar android.Path
Colin Crossbe9cdb82019-01-21 21:37:16 -08001339 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !deps.disableTurbine {
Nan Zhang61eaedb2017-11-02 13:28:15 -07001340 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1341 enable_sharding = true
Ashley Rosee36efcf2019-01-16 17:34:08 -05001342 // Formerly, there was a check here that prevented annotation processors
1343 // from being used when sharding was enabled, as some annotation processors
1344 // do not function correctly in sharded environments. It was removed to
1345 // allow for the use of annotation processors that do function correctly
1346 // with sharding enabled. See: b/77284273.
Nan Zhang61eaedb2017-11-02 13:28:15 -07001347 }
Colin Crossf5a66282020-02-21 08:16:41 -08001348 headerJarFileWithoutJarjar, j.headerJarFile =
1349 j.compileJavaHeader(ctx, uniqueSrcFiles, srcJars, deps, flags, jarName, kotlinJars)
Colin Crossf19b9bb2018-03-26 14:42:44 -07001350 if ctx.Failed() {
1351 return
Nan Zhanged19fc32017-10-19 13:06:22 -07001352 }
1353 }
Colin Cross8eadbf02017-10-24 17:46:00 -07001354 if len(uniqueSrcFiles) > 0 || len(srcJars) > 0 {
Colin Crossd6891432017-09-27 17:39:56 -07001355 var extraJarDeps android.Paths
Colin Cross66548102018-06-19 22:47:35 -07001356 if ctx.Config().RunErrorProne() {
Colin Crossc6bbef32017-08-14 14:16:06 -07001357 // If error-prone is enabled, add an additional rule to compile the java files into
1358 // a separate set of classes (so that they don't overwrite the normal ones and require
Colin Crossd6891432017-09-27 17:39:56 -07001359 // a rebuild when error-prone is turned off).
Colin Crossc6bbef32017-08-14 14:16:06 -07001360 // TODO(ccross): Once we always compile with javac9 we may be able to conditionally
1361 // enable error-prone without affecting the output class files.
Colin Cross1ee23172017-10-18 14:44:18 -07001362 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001363 RunErrorProne(ctx, errorprone, uniqueSrcFiles, srcJars, flags)
Colin Crossc6bbef32017-08-14 14:16:06 -07001364 extraJarDeps = append(extraJarDeps, errorprone)
1365 }
1366
Nan Zhang61eaedb2017-11-02 13:28:15 -07001367 if enable_sharding {
Colin Crossf5a66282020-02-21 08:16:41 -08001368 flags.classpath = append(flags.classpath, headerJarFileWithoutJarjar)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001369 shardSize := int(*(j.properties.Javac_shard_size))
1370 var shardSrcs []android.Paths
1371 if len(uniqueSrcFiles) > 0 {
Colin Cross0a2f7192019-09-23 14:33:09 -07001372 shardSrcs = android.ShardPaths(uniqueSrcFiles, shardSize)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001373 for idx, shardSrc := range shardSrcs {
Colin Cross3b706fd2019-09-05 16:44:18 -07001374 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1375 nil, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001376 jars = append(jars, classes)
1377 }
1378 }
1379 if len(srcJars) > 0 {
Colin Cross3b706fd2019-09-05 16:44:18 -07001380 classes := j.compileJavaClasses(ctx, jarName, len(shardSrcs),
1381 nil, srcJars, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001382 jars = append(jars, classes)
1383 }
1384 } else {
Colin Cross3b706fd2019-09-05 16:44:18 -07001385 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueSrcFiles, srcJars, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001386 jars = append(jars, classes)
1387 }
Colin Crossd6891432017-09-27 17:39:56 -07001388 if ctx.Failed() {
1389 return
1390 }
Colin Cross2fe66872015-03-30 17:20:39 -07001391 }
1392
Colin Cross0c4ce212019-05-03 15:28:19 -07001393 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1394
1395 var includeSrcJar android.WritablePath
1396 if Bool(j.properties.Include_srcs) {
1397 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1398 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1399 }
1400
Colin Crosscedd4762018-09-13 11:26:19 -07001401 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1402 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
Colin Cross0f37af02017-09-27 17:42:05 -07001403 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
Colin Cross988708c2019-05-06 14:04:11 -07001404 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
Colin Cross0f37af02017-09-27 17:42:05 -07001405
1406 var resArgs []string
1407 var resDeps android.Paths
1408
1409 resArgs = append(resArgs, dirArgs...)
1410 resDeps = append(resDeps, dirDeps...)
1411
1412 resArgs = append(resArgs, fileArgs...)
1413 resDeps = append(resDeps, fileDeps...)
1414
Colin Cross988708c2019-05-06 14:04:11 -07001415 resArgs = append(resArgs, extraArgs...)
1416 resDeps = append(resDeps, extraDeps...)
1417
Colin Cross40a36712017-09-27 17:41:35 -07001418 if len(resArgs) > 0 {
Colin Cross1ee23172017-10-18 14:44:18 -07001419 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
Colin Crosse9a275b2017-10-16 17:09:48 -07001420 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Colin Cross331a1212018-08-15 20:40:52 -07001421 j.resourceJar = resourceJar
Colin Cross65bf4f22015-04-03 16:54:17 -07001422 if ctx.Failed() {
1423 return
1424 }
1425 }
1426
Colin Cross0c4ce212019-05-03 15:28:19 -07001427 var resourceJars android.Paths
1428 if j.resourceJar != nil {
1429 resourceJars = append(resourceJars, j.resourceJar)
1430 }
1431 if Bool(j.properties.Include_srcs) {
1432 resourceJars = append(resourceJars, includeSrcJar)
1433 }
1434 resourceJars = append(resourceJars, deps.staticResourceJars...)
Colin Cross331a1212018-08-15 20:40:52 -07001435
Colin Cross0c4ce212019-05-03 15:28:19 -07001436 if len(resourceJars) > 1 {
Colin Cross331a1212018-08-15 20:40:52 -07001437 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
Colin Cross0c4ce212019-05-03 15:28:19 -07001438 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
Colin Cross331a1212018-08-15 20:40:52 -07001439 false, nil, nil)
1440 j.resourceJar = combinedJar
Colin Cross0c4ce212019-05-03 15:28:19 -07001441 } else if len(resourceJars) == 1 {
1442 j.resourceJar = resourceJars[0]
Colin Cross331a1212018-08-15 20:40:52 -07001443 }
1444
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001445 if len(deps.staticJars) > 0 {
1446 jars = append(jars, deps.staticJars...)
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001447 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001448
Colin Cross094054a2018-10-17 15:10:48 -07001449 manifest := j.overrideManifest
1450 if !manifest.Valid() && j.properties.Manifest != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001451 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Colin Cross366938f2017-12-11 16:29:02 -08001452 }
Colin Cross635acc92017-09-12 22:50:46 -07001453
Colin Cross8a497952019-03-05 22:25:09 -08001454 services := android.PathsForModuleSrc(ctx, j.properties.Services)
Alex Light7f004a72019-02-21 13:27:37 -08001455 if len(services) > 0 {
1456 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1457 var zipargs []string
1458 for _, file := range services {
1459 serviceFile := file.String()
1460 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1461 }
Kousik Kumarc05da0a2020-05-20 11:27:16 -07001462 rule := zip
1463 args := map[string]string{
1464 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1465 }
1466 if ctx.Config().IsEnvTrue("RBE_ZIP") {
1467 rule = zipRE
1468 args["implicits"] = strings.Join(services.Strings(), ",")
1469 }
Alex Light7f004a72019-02-21 13:27:37 -08001470 ctx.Build(pctx, android.BuildParams{
Kousik Kumarc05da0a2020-05-20 11:27:16 -07001471 Rule: rule,
Alex Light7f004a72019-02-21 13:27:37 -08001472 Output: servicesJar,
1473 Implicits: services,
Kousik Kumarc05da0a2020-05-20 11:27:16 -07001474 Args: args,
Alex Light7f004a72019-02-21 13:27:37 -08001475 })
1476 jars = append(jars, servicesJar)
1477 }
1478
Colin Cross0a6e0072017-08-30 14:24:55 -07001479 // Combine the classes built from sources, any manifests, and any static libraries into
Nan Zhanged19fc32017-10-19 13:06:22 -07001480 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross3063b782018-08-15 11:19:12 -07001481 var outputFile android.ModuleOutPath
Colin Crosse9a275b2017-10-16 17:09:48 -07001482
1483 if len(jars) == 1 && !manifest.Valid() {
Colin Cross3063b782018-08-15 11:19:12 -07001484 if moduleOutPath, ok := jars[0].(android.ModuleOutPath); ok {
1485 // Optimization: skip the combine step if there is nothing to do
1486 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1487 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1488 // any if len(jars) == 1.
1489 outputFile = moduleOutPath
1490 } else {
1491 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1492 ctx.Build(pctx, android.BuildParams{
1493 Rule: android.Cp,
1494 Input: jars[0],
1495 Output: combinedJar,
1496 })
1497 outputFile = combinedJar
1498 }
Colin Crosse9a275b2017-10-16 17:09:48 -07001499 } else {
Colin Cross1ee23172017-10-18 14:44:18 -07001500 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001501 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
Colin Cross9b38aef2018-08-27 15:42:25 -07001502 false, nil, nil)
Colin Crosse9a275b2017-10-16 17:09:48 -07001503 outputFile = combinedJar
1504 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001505
Colin Cross331a1212018-08-15 20:40:52 -07001506 // jarjar implementation jar if necessary
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001507 if j.expandJarjarRules != nil {
Colin Cross8649b262017-09-27 18:03:17 -07001508 // Transform classes.jar into classes-jarjar.jar
Colin Cross1ee23172017-10-18 14:44:18 -07001509 jarjarFile := android.PathForModuleOut(ctx, "jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001510 TransformJarJar(ctx, jarjarFile, outputFile, j.expandJarjarRules)
Colin Crosse9a275b2017-10-16 17:09:48 -07001511 outputFile = jarjarFile
Colin Cross331a1212018-08-15 20:40:52 -07001512
1513 // jarjar resource jar if necessary
1514 if j.resourceJar != nil {
1515 resourceJarJarFile := android.PathForModuleOut(ctx, "res-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001516 TransformJarJar(ctx, resourceJarJarFile, j.resourceJar, j.expandJarjarRules)
Colin Cross331a1212018-08-15 20:40:52 -07001517 j.resourceJar = resourceJarJarFile
1518 }
1519
Colin Cross0a6e0072017-08-30 14:24:55 -07001520 if ctx.Failed() {
1521 return
1522 }
1523 }
Vladimir Marko0975ee02019-04-02 10:29:55 +01001524
1525 // Check package restrictions if necessary.
1526 if len(j.properties.Permitted_packages) > 0 {
Paul Duffinaa7359a2020-06-02 09:52:17 +01001527 // Check packages and copy input to package-checked file.
1528 // Use the file copied after a successful package check as the output file for this
1529 // module so that any dependencies on this module will trigger the package check.
1530 outputFile = CheckJarPackages(ctx, outputFile, j.properties.Permitted_packages)
Vladimir Marko0975ee02019-04-02 10:29:55 +01001531
1532 if ctx.Failed() {
1533 return
1534 }
1535 }
1536
Nan Zhanged19fc32017-10-19 13:06:22 -07001537 j.implementationJarFile = outputFile
1538 if j.headerJarFile == nil {
1539 j.headerJarFile = j.implementationJarFile
1540 }
Colin Cross2fe66872015-03-30 17:20:39 -07001541
Jiyong Park28826602020-02-21 16:04:53 +09001542 // Force enable the instrumentation for java code that is built for APEXes ...
1543 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
1544 // doesn't make sense)
1545 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
1546 if android.DirectlyInAnyApex(ctx, ctx.ModuleName()) && !isJacocoAgent && !j.IsForPlatform() {
Jiyong Park81aaa0c2020-02-18 12:50:44 +00001547 j.properties.Instrument = true
1548 }
1549
Colin Cross3144dfc2018-01-03 15:06:47 -08001550 if j.shouldInstrument(ctx) {
Colin Crosscb933592017-11-22 13:49:43 -08001551 outputFile = j.instrument(ctx, flags, outputFile, jarName)
1552 }
1553
Colin Cross331a1212018-08-15 20:40:52 -07001554 // merge implementation jar with resources if necessary
1555 implementationAndResourcesJar := outputFile
1556 if j.resourceJar != nil {
Colin Cross08a409d2019-04-29 10:22:44 -07001557 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
Colin Cross331a1212018-08-15 20:40:52 -07001558 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
Colin Cross08a409d2019-04-29 10:22:44 -07001559 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
Colin Cross331a1212018-08-15 20:40:52 -07001560 false, nil, nil)
1561 implementationAndResourcesJar = combinedJar
1562 }
1563
1564 j.implementationAndResourcesJar = implementationAndResourcesJar
1565
Jiyong Park6b21c7d2020-02-11 09:16:01 +09001566 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
1567 if android.DirectlyInAnyApex(ctx, ctx.ModuleName()) && !j.IsForPlatform() {
1568 if j.deviceProperties.Compile_dex == nil {
1569 j.deviceProperties.Compile_dex = proptools.BoolPtr(true)
1570 }
1571 if j.deviceProperties.Hostdex == nil {
1572 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1573 }
1574 }
1575
Jaewoong Jungc27ab662019-05-30 15:51:14 -07001576 if ctx.Device() && j.hasCode(ctx) &&
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001577 (Bool(j.properties.Installable) || Bool(j.deviceProperties.Compile_dex)) {
Colin Cross8faf8fc2019-01-16 15:15:52 -08001578 // Dex compilation
Colin Cross3063b782018-08-15 11:19:12 -07001579 var dexOutputFile android.ModuleOutPath
David Brazdil17ef5632018-06-27 10:27:45 +01001580 dexOutputFile = j.compileDex(ctx, flags, outputFile, jarName)
Colin Cross2fe66872015-03-30 17:20:39 -07001581 if ctx.Failed() {
1582 return
1583 }
Colin Cross331a1212018-08-15 20:40:52 -07001584
Jiyong Park09cb6292019-07-15 15:29:23 +09001585 // Hidden API CSV generation and dex encoding
1586 dexOutputFile = j.hiddenAPI.hiddenAPI(ctx, dexOutputFile, j.implementationJarFile,
David Srbecky98c71222020-05-20 22:20:28 +01001587 proptools.Bool(j.deviceProperties.Uncompress_dex))
Colin Cross8faf8fc2019-01-16 15:15:52 -08001588
Colin Cross331a1212018-08-15 20:40:52 -07001589 // merge dex jar with resources if necessary
1590 if j.resourceJar != nil {
1591 jars := android.Paths{dexOutputFile, j.resourceJar}
1592 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
1593 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1594 false, nil, nil)
David Srbecky98c71222020-05-20 22:20:28 +01001595 if *j.deviceProperties.Uncompress_dex {
Nicolas Geoffrayf3438722019-01-23 15:57:21 +00001596 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
1597 TransformZipAlign(ctx, combinedAlignedJar, combinedJar)
1598 dexOutputFile = combinedAlignedJar
1599 } else {
1600 dexOutputFile = combinedJar
1601 }
Colin Cross331a1212018-08-15 20:40:52 -07001602 }
1603
1604 j.dexJarFile = dexOutputFile
1605
Colin Cross8faf8fc2019-01-16 15:15:52 -08001606 // Dexpreopting
Colin Cross43f08db2018-11-12 10:13:39 -08001607 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
1608
1609 j.maybeStrippedDexJarFile = dexOutputFile
1610
Colin Cross3063b782018-08-15 11:19:12 -07001611 outputFile = dexOutputFile
Colin Cross43f08db2018-11-12 10:13:39 -08001612
1613 if ctx.Failed() {
1614 return
1615 }
Colin Cross331a1212018-08-15 20:40:52 -07001616 } else {
1617 outputFile = implementationAndResourcesJar
Colin Cross2fe66872015-03-30 17:20:39 -07001618 }
Colin Cross331a1212018-08-15 20:40:52 -07001619
Colin Crossb7a63242015-04-16 14:09:14 -07001620 ctx.CheckbuildFile(outputFile)
Colin Cross3063b782018-08-15 11:19:12 -07001621
1622 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1623 j.outputFile = outputFile.WithoutRel()
Colin Cross2fe66872015-03-30 17:20:39 -07001624}
1625
Colin Cross3b706fd2019-09-05 16:44:18 -07001626func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
1627 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.WritablePath {
1628
1629 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
1630 if idx >= 0 {
1631 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
1632 jarName += strconv.Itoa(idx)
1633 }
1634
1635 classes := android.PathForModuleOut(ctx, "javac", jarName)
1636 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, flags, extraJarDeps)
1637
1638 if ctx.Config().EmitXrefRules() {
1639 extractionFile := android.PathForModuleOut(ctx, kzipName)
1640 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
1641 j.kytheFiles = append(j.kytheFiles, extractionFile)
1642 }
1643
1644 return classes
1645}
1646
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001647// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1648// since some of these flags may be used internally.
1649func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1650 for _, flag := range flags {
1651 flag = strings.TrimSpace(flag)
1652
1653 if !strings.HasPrefix(flag, "-") {
1654 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1655 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1656 ctx.PropertyErrorf("kotlincflags",
1657 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1658 } else if inList(flag, config.KotlincIllegalFlags) {
1659 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1660 } else if flag == "-include-runtime" {
1661 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1662 } else {
1663 args := strings.Split(flag, " ")
1664 if args[0] == "-kotlin-home" {
1665 ctx.PropertyErrorf("kotlincflags",
1666 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1667 }
1668 }
1669 }
1670}
1671
Colin Cross8eadbf02017-10-24 17:46:00 -07001672func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
Colin Crossf5a66282020-02-21 08:16:41 -08001673 deps deps, flags javaBuilderFlags, jarName string,
1674 extraJars android.Paths) (headerJar, jarjarHeaderJar android.Path) {
Nan Zhanged19fc32017-10-19 13:06:22 -07001675
1676 var jars android.Paths
Colin Cross8eadbf02017-10-24 17:46:00 -07001677 if len(srcFiles) > 0 || len(srcJars) > 0 {
Nan Zhanged19fc32017-10-19 13:06:22 -07001678 // Compile java sources into turbine.jar.
1679 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1680 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
1681 if ctx.Failed() {
Colin Crossf5a66282020-02-21 08:16:41 -08001682 return nil, nil
Nan Zhanged19fc32017-10-19 13:06:22 -07001683 }
1684 jars = append(jars, turbineJar)
1685 }
1686
Colin Cross55f63ea2018-08-27 12:37:09 -07001687 jars = append(jars, extraJars...)
1688
Nan Zhanged19fc32017-10-19 13:06:22 -07001689 // Combine any static header libraries into classes-header.jar. If there is only
1690 // one input jar this step will be skipped.
Nan Zhanged19fc32017-10-19 13:06:22 -07001691 jars = append(jars, deps.staticHeaderJars...)
1692
Colin Cross5c6ecc12017-10-23 18:12:27 -07001693 // we cannot skip the combine step for now if there is only one jar
1694 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
1695 combinedJar := android.PathForModuleOut(ctx, "turbine-combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001696 TransformJarsToJar(ctx, combinedJar, "for turbine", jars, android.OptionalPath{},
Colin Cross6c6e6cd2019-05-08 14:30:12 -07001697 false, nil, []string{"META-INF/TRANSITIVE"})
Colin Cross5c6ecc12017-10-23 18:12:27 -07001698 headerJar = combinedJar
Colin Crossf5a66282020-02-21 08:16:41 -08001699 jarjarHeaderJar = combinedJar
Nan Zhanged19fc32017-10-19 13:06:22 -07001700
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001701 if j.expandJarjarRules != nil {
Nan Zhanged19fc32017-10-19 13:06:22 -07001702 // Transform classes.jar into classes-jarjar.jar
1703 jarjarFile := android.PathForModuleOut(ctx, "turbine-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001704 TransformJarJar(ctx, jarjarFile, headerJar, j.expandJarjarRules)
Colin Crossf5a66282020-02-21 08:16:41 -08001705 jarjarHeaderJar = jarjarFile
Nan Zhanged19fc32017-10-19 13:06:22 -07001706 if ctx.Failed() {
Colin Crossf5a66282020-02-21 08:16:41 -08001707 return nil, nil
Nan Zhanged19fc32017-10-19 13:06:22 -07001708 }
1709 }
1710
Colin Crossf5a66282020-02-21 08:16:41 -08001711 return headerJar, jarjarHeaderJar
Nan Zhanged19fc32017-10-19 13:06:22 -07001712}
1713
Colin Crosscb933592017-11-22 13:49:43 -08001714func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross3063b782018-08-15 11:19:12 -07001715 classesJar android.Path, jarName string) android.ModuleOutPath {
Colin Crosscb933592017-11-22 13:49:43 -08001716
Colin Cross7a3139e2017-12-19 13:57:50 -08001717 specs := j.jacocoModuleToZipCommand(ctx)
Colin Crosscb933592017-11-22 13:49:43 -08001718
Colin Cross84c38822018-01-03 15:59:46 -08001719 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Crosscb933592017-11-22 13:49:43 -08001720 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
1721
1722 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1723
1724 j.jacocoReportClassesFile = jacocoReportClassesFile
1725
1726 return instrumentedJar
1727}
1728
albaltai36ff7dc2018-12-25 14:35:23 +08001729var _ Dependency = (*Module)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07001730
Nan Zhanged19fc32017-10-19 13:06:22 -07001731func (j *Module) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001732 if j.headerJarFile == nil {
1733 return nil
1734 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001735 return android.Paths{j.headerJarFile}
1736}
1737
1738func (j *Module) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08001739 if j.implementationJarFile == nil {
1740 return nil
1741 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001742 return android.Paths{j.implementationJarFile}
Colin Cross2fe66872015-03-30 17:20:39 -07001743}
1744
Colin Crossf24a22a2019-01-31 14:12:44 -08001745func (j *Module) DexJar() android.Path {
1746 return j.dexJarFile
1747}
1748
Colin Cross331a1212018-08-15 20:40:52 -07001749func (j *Module) ResourceJars() android.Paths {
1750 if j.resourceJar == nil {
1751 return nil
1752 }
1753 return android.Paths{j.resourceJar}
1754}
1755
1756func (j *Module) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001757 if j.implementationAndResourcesJar == nil {
1758 return nil
1759 }
Colin Cross331a1212018-08-15 20:40:52 -07001760 return android.Paths{j.implementationAndResourcesJar}
1761}
1762
Colin Cross46c9b8b2017-06-22 16:51:17 -07001763func (j *Module) AidlIncludeDirs() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001764 // exportAidlIncludeDirs is type android.Paths already
Colin Crossc0b06f12015-04-08 13:03:43 -07001765 return j.exportAidlIncludeDirs
1766}
1767
Jiyong Park1be96912018-05-28 18:02:19 +09001768func (j *Module) ExportedSdkLibs() []string {
albaltai36ff7dc2018-12-25 14:35:23 +08001769 // exportedSdkLibs is type []string
Jiyong Park1be96912018-05-28 18:02:19 +09001770 return j.exportedSdkLibs
1771}
1772
Artur Satayev9cf46692019-11-26 18:08:34 +00001773func (j *Module) ExportedPlugins() (android.Paths, []string) {
1774 return j.exportedPluginJars, j.exportedPluginClasses
1775}
1776
Colin Cross0c4ce212019-05-03 15:28:19 -07001777func (j *Module) SrcJarArgs() ([]string, android.Paths) {
1778 return j.srcJarArgs, j.srcJarDeps
1779}
1780
Colin Cross46c9b8b2017-06-22 16:51:17 -07001781var _ logtagsProducer = (*Module)(nil)
Colin Crossf05fe972015-04-10 17:45:20 -07001782
Colin Cross46c9b8b2017-06-22 16:51:17 -07001783func (j *Module) logtags() android.Paths {
Colin Crossf05fe972015-04-10 17:45:20 -07001784 return j.logtagsSrcs
1785}
1786
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001787// Collect information for opening IDE project files in java/jdeps.go.
1788func (j *Module) IDEInfo(dpInfo *android.IdeInfo) {
1789 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
1790 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
patricktu18c82ff2019-05-10 15:48:50 +08001791 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001792 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001793 if j.expandJarjarRules != nil {
1794 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001795 }
1796}
1797
1798func (j *Module) CompilerDeps() []string {
1799 jdeps := []string{}
1800 jdeps = append(jdeps, j.properties.Libs...)
1801 jdeps = append(jdeps, j.properties.Static_libs...)
1802 return jdeps
1803}
1804
Jaewoong Jungc27ab662019-05-30 15:51:14 -07001805func (j *Module) hasCode(ctx android.ModuleContext) bool {
1806 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
1807 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
1808}
1809
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09001810func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Paul Duffinc8f2f182020-05-17 08:34:50 +01001811 return j.depIsInSameApex(ctx, dep)
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09001812}
1813
Jiyong Park0b238752019-10-29 11:23:10 +09001814func (j *Module) Stem() string {
1815 return proptools.StringDefault(j.deviceProperties.Stem, j.Name())
1816}
1817
Jiyong Park618922e2020-01-08 13:35:43 +09001818func (j *Module) JacocoReportClassesFile() android.Path {
1819 return j.jacocoReportClassesFile
1820}
1821
Martin Stjernholm6d415272020-01-31 17:10:36 +00001822func (j *Module) IsInstallable() bool {
1823 return Bool(j.properties.Installable)
1824}
1825
Colin Cross2fe66872015-03-30 17:20:39 -07001826//
1827// Java libraries (.jar file)
1828//
1829
Anton Hansson1e65f942020-03-27 19:39:48 +00001830type LibraryProperties struct {
1831 Dist struct {
1832 // The tag of the output of this module that should be output.
1833 Tag *string `android:"arch_variant"`
1834 } `android:"arch_variant"`
1835}
1836
Colin Crossf506d872017-07-19 15:53:04 -07001837type Library struct {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001838 Module
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001839
Anton Hansson1e65f942020-03-27 19:39:48 +00001840 libraryProperties LibraryProperties
1841
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001842 InstallMixin func(ctx android.ModuleContext, installPath android.Path) (extraInstallDeps android.Paths)
Colin Cross2fe66872015-03-30 17:20:39 -07001843}
1844
Paul Duffina105cf92020-05-29 11:24:51 +01001845// Provides access to the list of permitted packages from updatable boot jars.
1846type PermittedPackagesForUpdatableBootJars interface {
1847 PermittedPackagesForUpdatableBootJars() []string
1848}
1849
1850var _ PermittedPackagesForUpdatableBootJars = (*Library)(nil)
1851
1852func (j *Library) PermittedPackagesForUpdatableBootJars() []string {
1853 return j.properties.Permitted_packages
1854}
1855
Colin Cross42be7612019-02-21 18:12:14 -08001856func shouldUncompressDex(ctx android.ModuleContext, dexpreopter *dexpreopter) bool {
Ulya Trafimovichf491dde2020-01-24 12:19:45 +00001857 // Store uncompressed (and aligned) any dex files from jars in APEXes.
1858 if am, ok := ctx.Module().(android.ApexModule); ok && !am.IsForPlatform() {
1859 return true
1860 }
1861
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +00001862 // Store uncompressed (and do not strip) dex files from boot class path jars.
1863 if inList(ctx.ModuleName(), ctx.Config().BootJars()) {
1864 return true
1865 }
1866
1867 // Store uncompressed dex files that are preopted on /system.
Colin Cross42be7612019-02-21 18:12:14 -08001868 if !dexpreopter.dexpreoptDisabled(ctx) && (ctx.Host() || !odexOnSystemOther(ctx, dexpreopter.installPath)) {
Vladimir Markoe8b00d62018-12-21 15:54:16 +00001869 return true
1870 }
Colin Cross083a2aa2019-02-06 16:37:12 -08001871 if ctx.Config().UncompressPrivAppDex() &&
1872 inList(ctx.ModuleName(), ctx.Config().ModulesLoadedByPrivilegedModules()) {
1873 return true
1874 }
1875
Colin Cross2fc72f62018-12-21 12:59:54 -08001876 return false
1877}
1878
Colin Crossf506d872017-07-19 15:53:04 -07001879func (j *Library) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Artur Satayeve5ac15a2020-04-08 19:09:30 +01001880 j.checkSdkVersions(ctx)
Jiyong Park0b238752019-10-29 11:23:10 +09001881 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar")
Colin Cross43f08db2018-11-12 10:13:39 -08001882 j.dexpreopter.isSDKLibrary = j.deviceProperties.IsSDKLibrary
David Srbecky98c71222020-05-20 22:20:28 +01001883 if j.deviceProperties.Uncompress_dex == nil {
1884 // If the value was not force-set by the user, use reasonable default based on the module.
1885 j.deviceProperties.Uncompress_dex = proptools.BoolPtr(shouldUncompressDex(ctx, &j.dexpreopter))
1886 }
1887 j.dexpreopter.uncompressedDex = *j.deviceProperties.Uncompress_dex
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001888 j.compile(ctx, nil)
Colin Crossb7a63242015-04-16 14:09:14 -07001889
Jiyong Park7f7766d2019-07-25 22:02:35 +09001890 exclusivelyForApex := android.InAnyApex(ctx.ModuleName()) && !j.IsForPlatform()
1891 if (Bool(j.properties.Installable) || ctx.Host()) && !exclusivelyForApex {
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001892 var extraInstallDeps android.Paths
1893 if j.InstallMixin != nil {
1894 extraInstallDeps = j.InstallMixin(ctx, j.outputFile)
1895 }
Colin Cross2c429dc2017-08-31 16:45:16 -07001896 j.installFile = ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
Jiyong Parked50ca82020-05-28 23:46:55 +09001897 j.Stem()+".jar", j.outputFile, extraInstallDeps...)
Colin Cross2c429dc2017-08-31 16:45:16 -07001898 }
Anton Hansson1e65f942020-03-27 19:39:48 +00001899
1900 // Verify Dist.Tag is set to a supported output
1901 if j.libraryProperties.Dist.Tag != nil {
1902 distFiles, err := j.OutputFiles(*j.libraryProperties.Dist.Tag)
1903 if err != nil {
1904 ctx.PropertyErrorf("dist.tag", "%s", err.Error())
1905 }
1906 j.distFile = distFiles[0]
1907 }
Colin Crossb7a63242015-04-16 14:09:14 -07001908}
1909
Colin Crossf506d872017-07-19 15:53:04 -07001910func (j *Library) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001911 j.deps(ctx)
1912}
1913
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001914const (
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001915 aidlIncludeDir = "aidl"
1916 javaDir = "java"
1917 jarFileSuffix = ".jar"
1918 testConfigSuffix = "-AndroidTest.xml"
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001919)
1920
Paul Duffina0dbf432019-12-05 11:25:53 +00001921// path to the jar file of a java library. Relative to <sdk_root>/<api_dir>
Paul Duffin9b358d72020-03-02 10:16:35 +00001922func sdkSnapshotFilePathForJar(osPrefix, name string) string {
1923 return sdkSnapshotFilePathForMember(osPrefix, name, jarFileSuffix)
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001924}
1925
Paul Duffin9b358d72020-03-02 10:16:35 +00001926func sdkSnapshotFilePathForMember(osPrefix, name string, suffix string) string {
1927 return filepath.Join(javaDir, osPrefix, name+suffix)
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001928}
1929
Paul Duffin13879572019-11-28 14:31:38 +00001930type librarySdkMemberType struct {
Paul Duffin255f18e2019-12-13 11:22:16 +00001931 android.SdkMemberTypeBase
Paul Duffin2b9e3d32020-02-28 14:39:53 +00001932
1933 // Function to retrieve the appropriate output jar (implementation or header) from
1934 // the library.
1935 jarToExportGetter func(j *Library) android.Path
Paul Duffin13879572019-11-28 14:31:38 +00001936}
1937
1938func (mt *librarySdkMemberType) AddDependencies(mctx android.BottomUpMutatorContext, dependencyTag blueprint.DependencyTag, names []string) {
1939 mctx.AddVariationDependencies(nil, dependencyTag, names...)
1940}
1941
1942func (mt *librarySdkMemberType) IsInstance(module android.Module) bool {
1943 _, ok := module.(*Library)
1944 return ok
1945}
1946
Paul Duffin17ab8832020-03-19 16:11:18 +00001947func (mt *librarySdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
1948 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_import")
Paul Duffind76209b2020-03-02 11:33:02 +00001949}
Paul Duffina0dbf432019-12-05 11:25:53 +00001950
Paul Duffind76209b2020-03-02 11:33:02 +00001951func (mt *librarySdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
Paul Duffinc9103932020-03-17 21:04:24 +00001952 return &librarySdkMemberProperties{}
Paul Duffind76209b2020-03-02 11:33:02 +00001953}
1954
1955type librarySdkMemberProperties struct {
1956 android.SdkMemberPropertiesBase
1957
Paul Duffin08385bf2020-05-06 10:23:19 +01001958 JarToExport android.Path `android:"arch_variant"`
Paul Duffinc9103932020-03-17 21:04:24 +00001959 AidlIncludeDirs android.Paths
Paul Duffind76209b2020-03-02 11:33:02 +00001960}
1961
Paul Duffin17ab8832020-03-19 16:11:18 +00001962func (p *librarySdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffin13879572019-11-28 14:31:38 +00001963 j := variant.(*Library)
1964
Paul Duffinc9103932020-03-17 21:04:24 +00001965 p.JarToExport = ctx.MemberType().(*librarySdkMemberType).jarToExportGetter(j)
1966 p.AidlIncludeDirs = j.AidlIncludeDirs()
Paul Duffind76209b2020-03-02 11:33:02 +00001967}
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001968
Paul Duffin17ab8832020-03-19 16:11:18 +00001969func (p *librarySdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffinc9103932020-03-17 21:04:24 +00001970 builder := ctx.SnapshotBuilder()
Paul Duffin17ab8832020-03-19 16:11:18 +00001971
Paul Duffinc9103932020-03-17 21:04:24 +00001972 exportedJar := p.JarToExport
1973 if exportedJar != nil {
1974 snapshotRelativeJavaLibPath := sdkSnapshotFilePathForJar(p.OsPrefix(), ctx.Name())
Paul Duffind76209b2020-03-02 11:33:02 +00001975 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
1976
Paul Duffinc9103932020-03-17 21:04:24 +00001977 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
1978 }
1979
1980 aidlIncludeDirs := p.AidlIncludeDirs
1981 if len(aidlIncludeDirs) != 0 {
1982 sdkModuleContext := ctx.SdkModuleContext()
1983 for _, dir := range aidlIncludeDirs {
Paul Duffind76209b2020-03-02 11:33:02 +00001984 // TODO(jiyong): copy parcelable declarations only
1985 aidlFiles, _ := sdkModuleContext.GlobWithDeps(dir.String()+"/**/*.aidl", nil)
1986 for _, file := range aidlFiles {
1987 builder.CopyToSnapshot(android.PathForSource(sdkModuleContext, file), filepath.Join(aidlIncludeDir, file))
1988 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001989 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001990
Paul Duffinc9103932020-03-17 21:04:24 +00001991 // TODO(b/151933053) - add aidl include dirs property
Paul Duffind76209b2020-03-02 11:33:02 +00001992 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001993}
1994
Paul Duffin2b9e3d32020-02-28 14:39:53 +00001995var javaHeaderLibsSdkMemberType android.SdkMemberType = &librarySdkMemberType{
1996 android.SdkMemberTypeBase{
1997 PropertyName: "java_header_libs",
1998 SupportsSdk: true,
Paul Duffin7b81f5e2020-01-13 21:03:22 +00001999 },
Paul Duffin2b9e3d32020-02-28 14:39:53 +00002000 func(j *Library) android.Path {
Paul Duffina0dbf432019-12-05 11:25:53 +00002001 headerJars := j.HeaderJars()
2002 if len(headerJars) != 1 {
2003 panic(fmt.Errorf("there must be only one header jar from %q", j.Name()))
2004 }
2005
2006 return headerJars[0]
Paul Duffin2b9e3d32020-02-28 14:39:53 +00002007 },
Paul Duffina0dbf432019-12-05 11:25:53 +00002008}
2009
Colin Cross1b16b0e2019-02-12 14:41:32 -08002010// java_library builds and links sources into a `.jar` file for the device, and possibly for the host as well.
2011//
2012// By default, a java_library has a single variant that produces a `.jar` file containing `.class` files that were
2013// compiled against the device bootclasspath. This jar is not suitable for installing on a device, but can be used
2014// as a `static_libs` dependency of another module.
2015//
2016// Specifying `installable: true` will product a `.jar` file containing `classes.dex` files, suitable for installing on
2017// a device.
2018//
2019// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2020// compiled against the host bootclasspath.
Colin Cross9ae1b922018-06-26 17:59:05 -07002021func LibraryFactory() android.Module {
2022 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07002023
Colin Cross9ae1b922018-06-26 17:59:05 -07002024 module.AddProperties(
2025 &module.Module.properties,
2026 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08002027 &module.Module.dexpreoptProperties,
Anton Hansson1e65f942020-03-27 19:39:48 +00002028 &module.Module.protoProperties,
2029 &module.libraryProperties)
Colin Cross2fe66872015-03-30 17:20:39 -07002030
Paul Duffin64e61992020-05-15 10:20:31 +01002031 module.initModuleAndImport(&module.ModuleBase)
2032
Jiyong Park7f7766d2019-07-25 22:02:35 +09002033 android.InitApexModule(module)
Jiyong Parkd1063c12019-07-17 20:08:41 +09002034 android.InitSdkAwareModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002035 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross9ae1b922018-06-26 17:59:05 -07002036 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002037}
2038
Colin Cross1b16b0e2019-02-12 14:41:32 -08002039// java_library_static is an obsolete alias for java_library.
2040func LibraryStaticFactory() android.Module {
2041 return LibraryFactory()
2042}
2043
2044// java_library_host builds and links sources into a `.jar` file for the host.
2045//
2046// A java_library_host has a single variant that produces a `.jar` file containing `.class` files that were
2047// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002048func LibraryHostFactory() android.Module {
2049 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07002050
Colin Cross6af17aa2017-09-20 12:59:05 -07002051 module.AddProperties(
2052 &module.Module.properties,
2053 &module.Module.protoProperties)
Colin Cross36242852017-06-23 15:06:31 -07002054
Colin Cross9ae1b922018-06-26 17:59:05 -07002055 module.Module.properties.Installable = proptools.BoolPtr(true)
2056
Jiyong Park7f7766d2019-07-25 22:02:35 +09002057 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002058 InitJavaModule(module, android.HostSupported)
Colin Cross36242852017-06-23 15:06:31 -07002059 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002060}
2061
2062//
Colin Crossb628ea52018-08-14 16:42:33 -07002063// Java Tests
Colin Cross05638fc2018-04-09 18:40:24 -07002064//
2065
2066type testProperties struct {
Colin Cross05638fc2018-04-09 18:40:24 -07002067 // list of compatibility suites (for example "cts", "vts") that the module should be
2068 // installed into.
2069 Test_suites []string `android:"arch_variant"`
Julien Despreze146e392018-08-02 15:00:46 -07002070
2071 // the name of the test configuration (for example "AndroidTest.xml") that should be
2072 // installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08002073 Test_config *string `android:"path,arch_variant"`
Colin Crossd96ca352018-08-10 16:06:24 -07002074
Jack He33338892018-09-19 02:21:28 -07002075 // the name of the test configuration template (for example "AndroidTestTemplate.xml") that
2076 // should be installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08002077 Test_config_template *string `android:"path,arch_variant"`
Jack He33338892018-09-19 02:21:28 -07002078
Colin Crossd96ca352018-08-10 16:06:24 -07002079 // list of files or filegroup modules that provide data that should be installed alongside
2080 // the test
Colin Cross27b922f2019-03-04 22:35:41 -08002081 Data []string `android:"path"`
Dan Shi6ffaaa82019-09-26 11:41:36 -07002082
2083 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
2084 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
2085 // explicitly.
2086 Auto_gen_config *bool
easoncyleeba606252020-04-30 14:57:06 +08002087
2088 // Add parameterized mainline modules to auto generated test config. The options will be
2089 // handled by TradeFed to do downloading and installing the specified modules on the device.
2090 Test_mainline_modules []string
Colin Cross05638fc2018-04-09 18:40:24 -07002091}
2092
Paul Duffin42df1442019-03-20 12:45:53 +00002093type testHelperLibraryProperties struct {
2094 // list of compatibility suites (for example "cts", "vts") that the module should be
2095 // installed into.
2096 Test_suites []string `android:"arch_variant"`
2097}
2098
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002099type prebuiltTestProperties 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 // the name of the test configuration (for example "AndroidTest.xml") that should be
2105 // installed with the module.
2106 Test_config *string `android:"path,arch_variant"`
2107}
2108
Colin Cross05638fc2018-04-09 18:40:24 -07002109type Test struct {
2110 Library
2111
2112 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07002113
2114 testConfig android.Path
Colin Crossd96ca352018-08-10 16:06:24 -07002115 data android.Paths
Colin Cross303e21f2018-08-07 16:49:25 -07002116}
2117
Paul Duffin42df1442019-03-20 12:45:53 +00002118type TestHelperLibrary struct {
2119 Library
2120
2121 testHelperLibraryProperties testHelperLibraryProperties
2122}
2123
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002124type JavaTestImport struct {
2125 Import
2126
2127 prebuiltTestProperties prebuiltTestProperties
2128
2129 testConfig android.Path
2130}
2131
Colin Cross303e21f2018-08-07 16:49:25 -07002132func (j *Test) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Dan Shi6ffaaa82019-09-26 11:41:36 -07002133 j.testConfig = tradefed.AutoGenJavaTestConfig(ctx, j.testProperties.Test_config, j.testProperties.Test_config_template,
2134 j.testProperties.Test_suites, j.testProperties.Auto_gen_config)
Colin Cross8a497952019-03-05 22:25:09 -08002135 j.data = android.PathsForModuleSrc(ctx, j.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07002136
2137 j.Library.GenerateAndroidBuildActions(ctx)
Colin Cross05638fc2018-04-09 18:40:24 -07002138}
2139
Paul Duffin42df1442019-03-20 12:45:53 +00002140func (j *TestHelperLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2141 j.Library.GenerateAndroidBuildActions(ctx)
2142}
2143
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002144func (j *JavaTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2145 j.testConfig = tradefed.AutoGenJavaTestConfig(ctx, j.prebuiltTestProperties.Test_config, nil,
2146 j.prebuiltTestProperties.Test_suites, nil)
2147
2148 j.Import.GenerateAndroidBuildActions(ctx)
2149}
2150
2151type testSdkMemberType struct {
2152 android.SdkMemberTypeBase
2153}
2154
2155func (mt *testSdkMemberType) AddDependencies(mctx android.BottomUpMutatorContext, dependencyTag blueprint.DependencyTag, names []string) {
2156 mctx.AddVariationDependencies(nil, dependencyTag, names...)
2157}
2158
2159func (mt *testSdkMemberType) IsInstance(module android.Module) bool {
2160 _, ok := module.(*Test)
2161 return ok
2162}
2163
Paul Duffin17ab8832020-03-19 16:11:18 +00002164func (mt *testSdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
2165 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_test_import")
Paul Duffind76209b2020-03-02 11:33:02 +00002166}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002167
Paul Duffind76209b2020-03-02 11:33:02 +00002168func (mt *testSdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
2169 return &testSdkMemberProperties{}
2170}
2171
2172type testSdkMemberProperties struct {
2173 android.SdkMemberPropertiesBase
2174
Paul Duffinc9103932020-03-17 21:04:24 +00002175 JarToExport android.Path
2176 TestConfig android.Path
Paul Duffind76209b2020-03-02 11:33:02 +00002177}
2178
Paul Duffin17ab8832020-03-19 16:11:18 +00002179func (p *testSdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffind76209b2020-03-02 11:33:02 +00002180 test := variant.(*Test)
2181
2182 implementationJars := test.ImplementationJars()
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002183 if len(implementationJars) != 1 {
Paul Duffind76209b2020-03-02 11:33:02 +00002184 panic(fmt.Errorf("there must be only one implementation jar from %q", test.Name()))
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002185 }
2186
Paul Duffinc9103932020-03-17 21:04:24 +00002187 p.JarToExport = implementationJars[0]
2188 p.TestConfig = test.testConfig
Paul Duffind76209b2020-03-02 11:33:02 +00002189}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002190
Paul Duffin17ab8832020-03-19 16:11:18 +00002191func (p *testSdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffinc9103932020-03-17 21:04:24 +00002192 builder := ctx.SnapshotBuilder()
Paul Duffin17ab8832020-03-19 16:11:18 +00002193
Paul Duffinc9103932020-03-17 21:04:24 +00002194 exportedJar := p.JarToExport
2195 if exportedJar != nil {
2196 snapshotRelativeJavaLibPath := sdkSnapshotFilePathForJar(p.OsPrefix(), ctx.Name())
2197 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
Paul Duffind76209b2020-03-02 11:33:02 +00002198
2199 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
Paul Duffinc9103932020-03-17 21:04:24 +00002200 }
2201
2202 testConfig := p.TestConfig
2203 if testConfig != nil {
2204 snapshotRelativeTestConfigPath := sdkSnapshotFilePathForMember(p.OsPrefix(), ctx.Name(), testConfigSuffix)
2205 builder.CopyToSnapshot(testConfig, snapshotRelativeTestConfigPath)
Paul Duffind76209b2020-03-02 11:33:02 +00002206 propertySet.AddProperty("test_config", snapshotRelativeTestConfigPath)
2207 }
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002208}
2209
Colin Cross1b16b0e2019-02-12 14:41:32 -08002210// java_test builds a and links sources into a `.jar` file for the device, and possibly for the host as well, and
2211// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
2212//
2213// By default, a java_test has a single variant that produces a `.jar` file containing `classes.dex` files that were
2214// compiled against the device bootclasspath.
2215//
2216// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2217// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07002218func TestFactory() android.Module {
2219 module := &Test{}
2220
2221 module.AddProperties(
2222 &module.Module.properties,
2223 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08002224 &module.Module.dexpreoptProperties,
Colin Cross05638fc2018-04-09 18:40:24 -07002225 &module.Module.protoProperties,
2226 &module.testProperties)
2227
Colin Cross9ae1b922018-06-26 17:59:05 -07002228 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse3026872019-01-05 22:30:13 -08002229 module.Module.dexpreopter.isTest = true
Colin Cross9ae1b922018-06-26 17:59:05 -07002230
Colin Cross05638fc2018-04-09 18:40:24 -07002231 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07002232 return module
2233}
2234
Paul Duffin42df1442019-03-20 12:45:53 +00002235// java_test_helper_library creates a java library and makes sure that it is added to the appropriate test suite.
2236func TestHelperLibraryFactory() android.Module {
2237 module := &TestHelperLibrary{}
2238
2239 module.AddProperties(
2240 &module.Module.properties,
2241 &module.Module.deviceProperties,
2242 &module.Module.dexpreoptProperties,
2243 &module.Module.protoProperties,
2244 &module.testHelperLibraryProperties)
2245
Colin Cross9a4abed2019-04-24 13:19:28 -07002246 module.Module.properties.Installable = proptools.BoolPtr(true)
2247 module.Module.dexpreopter.isTest = true
2248
Paul Duffin42df1442019-03-20 12:45:53 +00002249 InitJavaModule(module, android.HostAndDeviceSupported)
2250 return module
2251}
2252
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002253// java_test_import imports one or more `.jar` files into the build graph as if they were built by a java_test module
2254// and makes sure that it is added to the appropriate test suite.
2255//
2256// By default, a java_test_import has a single variant that expects a `.jar` file containing `.class` files that were
2257// compiled against an Android classpath.
2258//
2259// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
2260// for host modules.
2261func JavaTestImportFactory() android.Module {
2262 module := &JavaTestImport{}
2263
2264 module.AddProperties(
2265 &module.Import.properties,
2266 &module.prebuiltTestProperties)
2267
2268 module.Import.properties.Installable = proptools.BoolPtr(true)
2269
2270 android.InitPrebuiltModule(module, &module.properties.Jars)
2271 android.InitApexModule(module)
2272 android.InitSdkAwareModule(module)
2273 InitJavaModule(module, android.HostAndDeviceSupported)
2274 return module
2275}
2276
Colin Cross1b16b0e2019-02-12 14:41:32 -08002277// java_test_host builds a and links sources into a `.jar` file for the host, and creates an `AndroidTest.xml` file to
2278// allow running the test with `atest` or a `TEST_MAPPING` file.
2279//
2280// A java_test_host has a single variant that produces a `.jar` file containing `.class` files that were
2281// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07002282func TestHostFactory() android.Module {
2283 module := &Test{}
2284
2285 module.AddProperties(
2286 &module.Module.properties,
2287 &module.Module.protoProperties,
2288 &module.testProperties)
2289
Colin Cross9ae1b922018-06-26 17:59:05 -07002290 module.Module.properties.Installable = proptools.BoolPtr(true)
2291
Colin Cross05638fc2018-04-09 18:40:24 -07002292 InitJavaModule(module, android.HostSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07002293 return module
2294}
2295
2296//
Colin Cross2fe66872015-03-30 17:20:39 -07002297// Java Binaries (.jar file plus wrapper script)
2298//
2299
Colin Crossf506d872017-07-19 15:53:04 -07002300type binaryProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -07002301 // installable script to execute the resulting jar
Colin Cross27b922f2019-03-04 22:35:41 -08002302 Wrapper *string `android:"path"`
Colin Cross094054a2018-10-17 15:10:48 -07002303
2304 // Name of the class containing main to be inserted into the manifest as Main-Class.
2305 Main_class *string
Colin Cross7d5136f2015-05-11 13:39:40 -07002306}
2307
Colin Crossf506d872017-07-19 15:53:04 -07002308type Binary struct {
2309 Library
Colin Cross2fe66872015-03-30 17:20:39 -07002310
Colin Crossf506d872017-07-19 15:53:04 -07002311 binaryProperties binaryProperties
Colin Cross10a03492017-08-10 17:09:43 -07002312
Colin Cross6b4a32d2017-12-05 13:42:45 -08002313 isWrapperVariant bool
2314
Colin Crossc3315992017-12-08 19:12:36 -08002315 wrapperFile android.Path
Colin Cross70dda7e2019-10-01 22:05:35 -07002316 binaryFile android.InstallPath
Colin Cross2fe66872015-03-30 17:20:39 -07002317}
2318
Alex Light24237172017-10-26 09:46:21 -07002319func (j *Binary) HostToolPath() android.OptionalPath {
2320 return android.OptionalPathForPath(j.binaryFile)
2321}
2322
Colin Crossf506d872017-07-19 15:53:04 -07002323func (j *Binary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002324 if ctx.Arch().ArchType == android.Common {
2325 // Compile the jar
Colin Cross094054a2018-10-17 15:10:48 -07002326 if j.binaryProperties.Main_class != nil {
2327 if j.properties.Manifest != nil {
2328 ctx.PropertyErrorf("main_class", "main_class cannot be used when manifest is set")
2329 }
2330 manifestFile := android.PathForModuleOut(ctx, "manifest.txt")
2331 GenerateMainClassManifest(ctx, manifestFile, String(j.binaryProperties.Main_class))
2332 j.overrideManifest = android.OptionalPathForPath(manifestFile)
2333 }
2334
Colin Cross6b4a32d2017-12-05 13:42:45 -08002335 j.Library.GenerateAndroidBuildActions(ctx)
Nan Zhang3c807db2017-11-03 14:53:31 -07002336 } else {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002337 // Handle the binary wrapper
2338 j.isWrapperVariant = true
2339
Colin Cross366938f2017-12-11 16:29:02 -08002340 if j.binaryProperties.Wrapper != nil {
Colin Cross8a497952019-03-05 22:25:09 -08002341 j.wrapperFile = android.PathForModuleSrc(ctx, *j.binaryProperties.Wrapper)
Colin Cross6b4a32d2017-12-05 13:42:45 -08002342 } else {
2343 j.wrapperFile = android.PathForSource(ctx, "build/soong/scripts/jar-wrapper.sh")
2344 }
2345
2346 // Depend on the installed jar so that the wrapper doesn't get executed by
2347 // another build rule before the jar has been installed.
2348 jarFile := ctx.PrimaryModule().(*Binary).installFile
2349
2350 j.binaryFile = ctx.InstallExecutable(android.PathForModuleInstall(ctx, "bin"),
2351 ctx.ModuleName(), j.wrapperFile, jarFile)
Nan Zhang3c807db2017-11-03 14:53:31 -07002352 }
Colin Cross2fe66872015-03-30 17:20:39 -07002353}
2354
Colin Crossf506d872017-07-19 15:53:04 -07002355func (j *Binary) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002356 if ctx.Arch().ArchType == android.Common {
2357 j.deps(ctx)
2358 }
Colin Cross46c9b8b2017-06-22 16:51:17 -07002359}
2360
Colin Cross1b16b0e2019-02-12 14:41:32 -08002361// java_binary builds a `.jar` file and a shell script that executes it for the device, and possibly for the host
2362// as well.
2363//
2364// By default, a java_binary has a single variant that produces a `.jar` file containing `classes.dex` files that were
2365// compiled against the device bootclasspath.
2366//
2367// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2368// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002369func BinaryFactory() android.Module {
2370 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07002371
Colin Cross36242852017-06-23 15:06:31 -07002372 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -07002373 &module.Module.properties,
2374 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08002375 &module.Module.dexpreoptProperties,
Colin Cross6af17aa2017-09-20 12:59:05 -07002376 &module.Module.protoProperties,
Colin Cross540eff82017-06-22 17:01:52 -07002377 &module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07002378
Colin Cross9ae1b922018-06-26 17:59:05 -07002379 module.Module.properties.Installable = proptools.BoolPtr(true)
2380
Colin Cross6b4a32d2017-12-05 13:42:45 -08002381 android.InitAndroidArchModule(module, android.HostAndDeviceSupported, android.MultilibCommonFirst)
2382 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07002383 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002384}
2385
Colin Cross1b16b0e2019-02-12 14:41:32 -08002386// java_binary_host builds a `.jar` file and a shell script that executes it for the host.
2387//
2388// A java_binary_host has a single variant that produces a `.jar` file containing `.class` files that were
2389// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002390func BinaryHostFactory() android.Module {
2391 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07002392
Colin Cross36242852017-06-23 15:06:31 -07002393 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -07002394 &module.Module.properties,
Colin Cross6af17aa2017-09-20 12:59:05 -07002395 &module.Module.protoProperties,
Colin Cross540eff82017-06-22 17:01:52 -07002396 &module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07002397
Colin Cross9ae1b922018-06-26 17:59:05 -07002398 module.Module.properties.Installable = proptools.BoolPtr(true)
2399
Colin Cross6b4a32d2017-12-05 13:42:45 -08002400 android.InitAndroidArchModule(module, android.HostSupported, android.MultilibCommonFirst)
2401 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07002402 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002403}
2404
2405//
2406// Java prebuilts
2407//
2408
Colin Cross74d73e22017-08-02 11:05:49 -07002409type ImportProperties struct {
Paul Duffin9b358d72020-03-02 10:16:35 +00002410 Jars []string `android:"path,arch_variant"`
Colin Cross461bd1a2017-10-20 13:59:18 -07002411
Nan Zhangea568a42017-11-08 21:20:04 -08002412 Sdk_version *string
Colin Cross535e2cf2017-10-20 17:57:49 -07002413
2414 Installable *bool
Jiyong Park1be96912018-05-28 18:02:19 +09002415
2416 // List of shared java libs that this module has dependencies to
2417 Libs []string
Colin Cross37f6d792018-07-12 12:28:41 -07002418
2419 // List of files to remove from the jar file(s)
2420 Exclude_files []string
2421
2422 // List of directories to remove from the jar file(s)
2423 Exclude_dirs []string
Nan Zhang4c819fb2018-08-27 18:31:46 -07002424
2425 // if set to true, run Jetifier against .jar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -07002426 Jetifier *bool
Jiyong Park4c4c0242019-10-21 14:53:15 +09002427
2428 // set the name of the output
2429 Stem *string
Colin Cross74d73e22017-08-02 11:05:49 -07002430}
2431
2432type Import struct {
Colin Cross635c3b02016-05-18 15:37:25 -07002433 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -07002434 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002435 android.ApexModuleBase
Colin Crossec7a0422017-07-07 14:47:12 -07002436 prebuilt android.Prebuilt
Jiyong Parkd1063c12019-07-17 20:08:41 +09002437 android.SdkBase
Colin Cross2fe66872015-03-30 17:20:39 -07002438
Paul Duffinc8f2f182020-05-17 08:34:50 +01002439 // Functionality common to Module and Import.
2440 embeddableInModuleAndImport
2441
Colin Cross74d73e22017-08-02 11:05:49 -07002442 properties ImportProperties
2443
Colin Cross0a6e0072017-08-30 14:24:55 -07002444 combinedClasspathFile android.Path
Jiyong Park1be96912018-05-28 18:02:19 +09002445 exportedSdkLibs []string
Colin Cross2fe66872015-03-30 17:20:39 -07002446}
2447
Jiyong Park6a927c42020-01-21 02:03:43 +09002448func (j *Import) sdkVersion() sdkSpec {
2449 return sdkSpecFrom(String(j.properties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -07002450}
2451
Jiyong Park6a927c42020-01-21 02:03:43 +09002452func (j *Import) minSdkVersion() sdkSpec {
Colin Cross83bb3162018-06-25 15:48:06 -07002453 return j.sdkVersion()
2454}
2455
Artur Satayev388d39b2020-04-27 18:53:18 +01002456func (j *Import) MinSdkVersion() string {
2457 return j.minSdkVersion().version.String()
2458}
2459
Colin Cross74d73e22017-08-02 11:05:49 -07002460func (j *Import) Prebuilt() *android.Prebuilt {
Colin Crossec7a0422017-07-07 14:47:12 -07002461 return &j.prebuilt
2462}
2463
Colin Cross74d73e22017-08-02 11:05:49 -07002464func (j *Import) PrebuiltSrcs() []string {
2465 return j.properties.Jars
2466}
2467
2468func (j *Import) Name() string {
Colin Cross5ea9bcc2017-07-27 15:41:32 -07002469 return j.prebuilt.Name(j.ModuleBase.Name())
2470}
2471
Jiyong Park0b238752019-10-29 11:23:10 +09002472func (j *Import) Stem() string {
2473 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
2474}
2475
Jiyong Park618922e2020-01-08 13:35:43 +09002476func (a *Import) JacocoReportClassesFile() android.Path {
2477 return nil
2478}
2479
Colin Cross74d73e22017-08-02 11:05:49 -07002480func (j *Import) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross42d48b72018-08-29 14:10:52 -07002481 ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Colin Cross1e676be2016-10-12 14:38:15 -07002482}
2483
Colin Cross74d73e22017-08-02 11:05:49 -07002484func (j *Import) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross8a497952019-03-05 22:25:09 -08002485 jars := android.PathsForModuleSrc(ctx, j.properties.Jars)
Colin Crosse1d62a82015-04-03 16:53:05 -07002486
Jiyong Park0b238752019-10-29 11:23:10 +09002487 jarName := j.Stem() + ".jar"
Nan Zhang4c819fb2018-08-27 18:31:46 -07002488 outputFile := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07002489 TransformJarsToJar(ctx, outputFile, "for prebuilts", jars, android.OptionalPath{},
2490 false, j.properties.Exclude_files, j.properties.Exclude_dirs)
Colin Cross1001a792019-03-21 22:21:39 -07002491 if Bool(j.properties.Jetifier) {
Nan Zhang4c819fb2018-08-27 18:31:46 -07002492 inputFile := outputFile
2493 outputFile = android.PathForModuleOut(ctx, "jetifier", jarName)
2494 TransformJetifier(ctx, outputFile, inputFile)
2495 }
Colin Crosse9a275b2017-10-16 17:09:48 -07002496 j.combinedClasspathFile = outputFile
Jiyong Park1be96912018-05-28 18:02:19 +09002497
Paul Duffin64e61992020-05-15 10:20:31 +01002498 // If this is a component library (impl, stubs, etc.) for a java_sdk_library then
2499 // add the name of that java_sdk_library to the exported sdk libs to make sure
2500 // that, if necessary, a <uses-library> element for that java_sdk_library is
2501 // added to the Android manifest.
2502 j.exportedSdkLibs = append(j.exportedSdkLibs, j.OptionalImplicitSdkLibrary()...)
2503
Jiyong Park1be96912018-05-28 18:02:19 +09002504 ctx.VisitDirectDeps(func(module android.Module) {
2505 otherName := ctx.OtherModuleName(module)
2506 tag := ctx.OtherModuleDependencyTag(module)
2507
2508 switch dep := module.(type) {
2509 case Dependency:
2510 switch tag {
2511 case libTag, staticLibTag:
2512 // sdk lib names from dependencies are re-exported
2513 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
2514 }
2515 case SdkLibraryDependency:
2516 switch tag {
2517 case libTag:
2518 // names of sdk libs that are directly depended are exported
2519 j.exportedSdkLibs = append(j.exportedSdkLibs, otherName)
2520 }
2521 }
2522 })
2523
2524 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
Nan Zhang4973ecf2018-08-10 13:42:12 -07002525 if Bool(j.properties.Installable) {
2526 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
Jiyong Park4c4c0242019-10-21 14:53:15 +09002527 jarName, outputFile)
Nan Zhang4973ecf2018-08-10 13:42:12 -07002528 }
Colin Cross2fe66872015-03-30 17:20:39 -07002529}
2530
Colin Cross74d73e22017-08-02 11:05:49 -07002531var _ Dependency = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07002532
Nan Zhanged19fc32017-10-19 13:06:22 -07002533func (j *Import) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002534 if j.combinedClasspathFile == nil {
2535 return nil
2536 }
Colin Cross37f6d792018-07-12 12:28:41 -07002537 return android.Paths{j.combinedClasspathFile}
Nan Zhanged19fc32017-10-19 13:06:22 -07002538}
2539
2540func (j *Import) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08002541 if j.combinedClasspathFile == nil {
2542 return nil
2543 }
Colin Cross37f6d792018-07-12 12:28:41 -07002544 return android.Paths{j.combinedClasspathFile}
Colin Cross2fe66872015-03-30 17:20:39 -07002545}
2546
Colin Cross331a1212018-08-15 20:40:52 -07002547func (j *Import) ResourceJars() android.Paths {
2548 return nil
2549}
2550
2551func (j *Import) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002552 if j.combinedClasspathFile == nil {
2553 return nil
2554 }
Colin Cross331a1212018-08-15 20:40:52 -07002555 return android.Paths{j.combinedClasspathFile}
2556}
2557
Colin Crossf24a22a2019-01-31 14:12:44 -08002558func (j *Import) DexJar() android.Path {
2559 return nil
2560}
2561
Colin Cross74d73e22017-08-02 11:05:49 -07002562func (j *Import) AidlIncludeDirs() android.Paths {
Colin Crossc0b06f12015-04-08 13:03:43 -07002563 return nil
2564}
2565
Jiyong Park1be96912018-05-28 18:02:19 +09002566func (j *Import) ExportedSdkLibs() []string {
2567 return j.exportedSdkLibs
2568}
2569
Artur Satayev9cf46692019-11-26 18:08:34 +00002570func (j *Import) ExportedPlugins() (android.Paths, []string) {
2571 return nil, nil
2572}
2573
Colin Cross0c4ce212019-05-03 15:28:19 -07002574func (j *Import) SrcJarArgs() ([]string, android.Paths) {
2575 return nil, nil
2576}
2577
Jiyong Park0f80c182020-01-31 02:49:53 +09002578func (j *Import) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Paul Duffinc8f2f182020-05-17 08:34:50 +01002579 return j.depIsInSameApex(ctx, dep)
Jiyong Park0f80c182020-01-31 02:49:53 +09002580}
2581
albaltai36ff7dc2018-12-25 14:35:23 +08002582// Add compile time check for interface implementation
2583var _ android.IDEInfo = (*Import)(nil)
2584var _ android.IDECustomizedModuleName = (*Import)(nil)
2585
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002586// Collect information for opening IDE project files in java/jdeps.go.
2587const (
2588 removedPrefix = "prebuilt_"
2589)
2590
2591func (j *Import) IDEInfo(dpInfo *android.IdeInfo) {
2592 dpInfo.Jars = append(dpInfo.Jars, j.PrebuiltSrcs()...)
2593}
2594
2595func (j *Import) IDECustomizedModuleName() string {
2596 // TODO(b/113562217): Extract the base module name from the Import name, often the Import name
2597 // has a prefix "prebuilt_". Remove the prefix explicitly if needed until we find a better
2598 // solution to get the Import name.
2599 name := j.Name()
2600 if strings.HasPrefix(name, removedPrefix) {
patricktubb640e02018-10-11 18:33:16 +08002601 name = strings.TrimPrefix(name, removedPrefix)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002602 }
2603 return name
2604}
2605
Colin Cross74d73e22017-08-02 11:05:49 -07002606var _ android.PrebuiltInterface = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07002607
Colin Cross1b16b0e2019-02-12 14:41:32 -08002608// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library module.
2609//
2610// By default, a java_import has a single variant that expects a `.jar` file containing `.class` files that were
2611// compiled against an Android classpath.
2612//
2613// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
2614// for host modules.
Colin Cross74d73e22017-08-02 11:05:49 -07002615func ImportFactory() android.Module {
2616 module := &Import{}
Colin Cross36242852017-06-23 15:06:31 -07002617
Colin Cross74d73e22017-08-02 11:05:49 -07002618 module.AddProperties(&module.properties)
2619
Paul Duffin64e61992020-05-15 10:20:31 +01002620 module.initModuleAndImport(&module.ModuleBase)
2621
Colin Cross74d73e22017-08-02 11:05:49 -07002622 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002623 android.InitApexModule(module)
Jiyong Parkd1063c12019-07-17 20:08:41 +09002624 android.InitSdkAwareModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002625 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross36242852017-06-23 15:06:31 -07002626 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002627}
2628
Colin Cross1b16b0e2019-02-12 14:41:32 -08002629// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library_host
2630// module.
2631//
2632// A java_import_host has a single variant that expects a `.jar` file containing `.class` files that were
2633// compiled against a host bootclasspath.
Colin Cross74d73e22017-08-02 11:05:49 -07002634func ImportFactoryHost() android.Module {
2635 module := &Import{}
2636
2637 module.AddProperties(&module.properties)
2638
2639 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002640 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002641 InitJavaModule(module, android.HostSupported)
Colin Cross74d73e22017-08-02 11:05:49 -07002642 return module
2643}
2644
Colin Cross42be7612019-02-21 18:12:14 -08002645// dex_import module
2646
2647type DexImportProperties struct {
Colin Cross5cfc70d2019-07-15 13:36:55 -07002648 Jars []string `android:"path"`
Jiyong Park4c4c0242019-10-21 14:53:15 +09002649
2650 // set the name of the output
2651 Stem *string
Colin Cross42be7612019-02-21 18:12:14 -08002652}
2653
2654type DexImport struct {
2655 android.ModuleBase
2656 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002657 android.ApexModuleBase
Colin Cross42be7612019-02-21 18:12:14 -08002658 prebuilt android.Prebuilt
2659
2660 properties DexImportProperties
2661
2662 dexJarFile android.Path
2663 maybeStrippedDexJarFile android.Path
2664
2665 dexpreopter
2666}
2667
2668func (j *DexImport) Prebuilt() *android.Prebuilt {
2669 return &j.prebuilt
2670}
2671
2672func (j *DexImport) PrebuiltSrcs() []string {
2673 return j.properties.Jars
2674}
2675
2676func (j *DexImport) Name() string {
2677 return j.prebuilt.Name(j.ModuleBase.Name())
2678}
2679
Jiyong Park0b238752019-10-29 11:23:10 +09002680func (j *DexImport) Stem() string {
2681 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
2682}
2683
Martin Stjernholm6d415272020-01-31 17:10:36 +00002684func (j *DexImport) IsInstallable() bool {
2685 return true
2686}
2687
Colin Cross42be7612019-02-21 18:12:14 -08002688func (j *DexImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2689 if len(j.properties.Jars) != 1 {
2690 ctx.PropertyErrorf("jars", "exactly one jar must be provided")
2691 }
2692
Jiyong Park0b238752019-10-29 11:23:10 +09002693 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar")
Colin Cross42be7612019-02-21 18:12:14 -08002694 j.dexpreopter.uncompressedDex = shouldUncompressDex(ctx, &j.dexpreopter)
2695
2696 inputJar := ctx.ExpandSource(j.properties.Jars[0], "jars")
2697 dexOutputFile := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar")
2698
2699 if j.dexpreopter.uncompressedDex {
2700 rule := android.NewRuleBuilder()
2701
2702 temporary := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar.unaligned")
2703 rule.Temporary(temporary)
2704
2705 // use zip2zip to uncompress classes*.dex files
2706 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -07002707 BuiltTool(ctx, "zip2zip").
Colin Cross42be7612019-02-21 18:12:14 -08002708 FlagWithInput("-i ", inputJar).
2709 FlagWithOutput("-o ", temporary).
2710 FlagWithArg("-0 ", "'classes*.dex'")
2711
2712 // use zipalign to align uncompressed classes*.dex files
2713 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -07002714 BuiltTool(ctx, "zipalign").
Colin Cross42be7612019-02-21 18:12:14 -08002715 Flag("-f").
2716 Text("4").
2717 Input(temporary).
2718 Output(dexOutputFile)
2719
2720 rule.DeleteTemporaryFiles()
2721
2722 rule.Build(pctx, ctx, "uncompress_dex", "uncompress dex")
2723 } else {
2724 ctx.Build(pctx, android.BuildParams{
2725 Rule: android.Cp,
2726 Input: inputJar,
2727 Output: dexOutputFile,
2728 })
2729 }
2730
2731 j.dexJarFile = dexOutputFile
2732
2733 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
2734
2735 j.maybeStrippedDexJarFile = dexOutputFile
2736
2737 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
Jiyong Parked50ca82020-05-28 23:46:55 +09002738 j.Stem()+".jar", dexOutputFile)
Colin Cross42be7612019-02-21 18:12:14 -08002739}
2740
2741func (j *DexImport) DexJar() android.Path {
2742 return j.dexJarFile
2743}
2744
2745// dex_import imports a `.jar` file containing classes.dex files.
2746//
2747// A dex_import module cannot be used as a dependency of a java_* or android_* module, it can only be installed
2748// to the device.
2749func DexImportFactory() android.Module {
2750 module := &DexImport{}
2751
2752 module.AddProperties(&module.properties)
2753
2754 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002755 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002756 InitJavaModule(module, android.DeviceSupported)
Colin Cross42be7612019-02-21 18:12:14 -08002757 return module
2758}
2759
Colin Cross89536d42017-07-07 14:35:50 -07002760//
2761// Defaults
2762//
2763type Defaults struct {
2764 android.ModuleBase
2765 android.DefaultsModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002766 android.ApexModuleBase
Colin Cross89536d42017-07-07 14:35:50 -07002767}
2768
Colin Cross1b16b0e2019-02-12 14:41:32 -08002769// java_defaults provides a set of properties that can be inherited by other java or android modules.
2770//
2771// A module can use the properties from a java_defaults module using `defaults: ["defaults_module_name"]`. Each
2772// property in the defaults module that exists in the depending module will be prepended to the depending module's
2773// value for that property.
2774//
2775// Example:
2776//
2777// java_defaults {
2778// name: "example_defaults",
2779// srcs: ["common/**/*.java"],
2780// javacflags: ["-Xlint:all"],
2781// aaptflags: ["--auto-add-overlay"],
2782// }
2783//
2784// java_library {
2785// name: "example",
2786// defaults: ["example_defaults"],
2787// srcs: ["example/**/*.java"],
2788// }
2789//
2790// is functionally identical to:
2791//
2792// java_library {
2793// name: "example",
2794// srcs: [
2795// "common/**/*.java",
2796// "example/**/*.java",
2797// ],
2798// javacflags: ["-Xlint:all"],
2799// }
Colin Cross89536d42017-07-07 14:35:50 -07002800func defaultsFactory() android.Module {
2801 return DefaultsFactory()
2802}
2803
Paul Duffin47357662019-12-05 14:07:14 +00002804func DefaultsFactory() android.Module {
Colin Cross89536d42017-07-07 14:35:50 -07002805 module := &Defaults{}
2806
Colin Cross89536d42017-07-07 14:35:50 -07002807 module.AddProperties(
2808 &CompilerProperties{},
2809 &CompilerDeviceProperties{},
Colin Cross43f08db2018-11-12 10:13:39 -08002810 &DexpreoptProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08002811 &android.ProtoProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002812 &aaptProperties{},
2813 &androidLibraryProperties{},
2814 &appProperties{},
2815 &appTestProperties{},
Jaewoong Jung525443a2019-02-28 15:35:54 -08002816 &overridableAppProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002817 &ImportProperties{},
2818 &AARImportProperties{},
2819 &sdkLibraryProperties{},
Paul Duffin1a724e62020-05-08 13:44:43 +01002820 &commonToSdkLibraryAndImportProperties{},
Colin Cross42be7612019-02-21 18:12:14 -08002821 &DexImportProperties{},
Jooyung Han18020ea2019-11-13 10:50:48 +09002822 &android.ApexProperties{},
Jaewoong Jung062ed7e2020-04-26 15:10:51 -07002823 &RuntimeResourceOverlayProperties{},
Colin Cross89536d42017-07-07 14:35:50 -07002824 )
2825
2826 android.InitDefaultsModule(module)
Colin Cross89536d42017-07-07 14:35:50 -07002827 return module
2828}
Nan Zhangea568a42017-11-08 21:20:04 -08002829
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002830func kytheExtractJavaFactory() android.Singleton {
2831 return &kytheExtractJavaSingleton{}
2832}
2833
2834type kytheExtractJavaSingleton struct {
2835}
2836
2837func (ks *kytheExtractJavaSingleton) GenerateBuildActions(ctx android.SingletonContext) {
2838 var xrefTargets android.Paths
2839 ctx.VisitAllModules(func(module android.Module) {
2840 if javaModule, ok := module.(xref); ok {
2841 xrefTargets = append(xrefTargets, javaModule.XrefJavaFiles()...)
2842 }
2843 })
2844 // TODO(asmundak): perhaps emit a rule to output a warning if there were no xrefTargets
2845 if len(xrefTargets) > 0 {
2846 ctx.Build(pctx, android.BuildParams{
2847 Rule: blueprint.Phony,
2848 Output: android.PathForPhony(ctx, "xref_java"),
2849 Inputs: xrefTargets,
2850 })
2851 }
2852}
2853
Nan Zhangea568a42017-11-08 21:20:04 -08002854var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07002855var BoolDefault = proptools.BoolDefault
Nan Zhangea568a42017-11-08 21:20:04 -08002856var String = proptools.String
Colin Cross0d0ba592018-02-20 13:33:42 -08002857var inList = android.InList