blob: 09df2ad43a657cff817430b11d1b73529220be92 [file] [log] [blame]
Colin Cross2fe66872015-03-30 17:20:39 -07001// Copyright 2015 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package java
16
17// This file contains the module types for compiling Java for Android, and converts the properties
Colin Cross46c9b8b2017-06-22 16:51:17 -070018// into the flags and filenames necessary to pass to the Module. The final creation of the rules
Colin Cross2fe66872015-03-30 17:20:39 -070019// is handled in builder.go
20
21import (
Colin Crossf19b9bb2018-03-26 14:42:44 -070022 "fmt"
Colin Crossfc3674a2017-09-18 17:41:52 -070023 "path/filepath"
Colin Cross74d73e22017-08-02 11:05:49 -070024 "strconv"
Colin Cross2fe66872015-03-30 17:20:39 -070025 "strings"
26
27 "github.com/google/blueprint"
Colin Cross3b706fd2019-09-05 16:44:18 -070028 "github.com/google/blueprint/pathtools"
Colin Cross76b5f0c2017-08-29 16:02:06 -070029 "github.com/google/blueprint/proptools"
Colin Cross2fe66872015-03-30 17:20:39 -070030
Colin Cross635c3b02016-05-18 15:37:25 -070031 "android/soong/android"
Colin Cross3e3e72d2017-06-22 17:20:19 -070032 "android/soong/java/config"
Colin Cross303e21f2018-08-07 16:49:25 -070033 "android/soong/tradefed"
Colin Cross2fe66872015-03-30 17:20:39 -070034)
35
Colin Cross463a90e2015-06-17 14:20:06 -070036func init() {
Paul Duffinf9b1da02019-12-18 19:51:55 +000037 RegisterJavaBuildComponents(android.InitRegistrationContext)
Paul Duffin255f18e2019-12-13 11:22:16 +000038
39 // Register sdk member types.
Paul Duffin7b81f5e2020-01-13 21:03:22 +000040 android.RegisterSdkMemberType(javaHeaderLibsSdkMemberType)
Paul Duffin255f18e2019-12-13 11:22:16 +000041
Paul Duffinf5c0a9c2020-02-28 14:39:53 +000042 android.RegisterSdkMemberType(&librarySdkMemberType{
43 android.SdkMemberTypeBase{
44 PropertyName: "java_libs",
45 },
46 func(j *Library) android.Path {
47 implementationJars := j.ImplementationJars()
48 if len(implementationJars) != 1 {
49 panic(fmt.Errorf("there must be only one implementation jar from %q", j.Name()))
50 }
51
52 return implementationJars[0]
Paul Duffin255f18e2019-12-13 11:22:16 +000053 },
54 })
Paul Duffin1b82e6a2019-12-03 18:06:47 +000055
56 android.RegisterSdkMemberType(&testSdkMemberType{
57 SdkMemberTypeBase: android.SdkMemberTypeBase{
58 PropertyName: "java_tests",
59 },
60 })
Colin Cross463a90e2015-06-17 14:20:06 -070061}
62
Paul Duffinf9b1da02019-12-18 19:51:55 +000063func RegisterJavaBuildComponents(ctx android.RegistrationContext) {
64 ctx.RegisterModuleType("java_defaults", DefaultsFactory)
65
66 ctx.RegisterModuleType("java_library", LibraryFactory)
67 ctx.RegisterModuleType("java_library_static", LibraryStaticFactory)
68 ctx.RegisterModuleType("java_library_host", LibraryHostFactory)
69 ctx.RegisterModuleType("java_binary", BinaryFactory)
70 ctx.RegisterModuleType("java_binary_host", BinaryHostFactory)
71 ctx.RegisterModuleType("java_test", TestFactory)
72 ctx.RegisterModuleType("java_test_helper_library", TestHelperLibraryFactory)
73 ctx.RegisterModuleType("java_test_host", TestHostFactory)
Paul Duffin1b82e6a2019-12-03 18:06:47 +000074 ctx.RegisterModuleType("java_test_import", JavaTestImportFactory)
Paul Duffinf9b1da02019-12-18 19:51:55 +000075 ctx.RegisterModuleType("java_import", ImportFactory)
76 ctx.RegisterModuleType("java_import_host", ImportFactoryHost)
77 ctx.RegisterModuleType("java_device_for_host", DeviceForHostFactory)
78 ctx.RegisterModuleType("java_host_for_device", HostForDeviceFactory)
79 ctx.RegisterModuleType("dex_import", DexImportFactory)
80
Martin Stjernholm6d415272020-01-31 17:10:36 +000081 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
82 ctx.BottomUp("dexpreopt_tool_deps", dexpreoptToolDepsMutator).Parallel()
83 })
Martin Stjernholmd90676f2020-01-11 00:37:30 +000084
Paul Duffinf9b1da02019-12-18 19:51:55 +000085 ctx.RegisterSingletonType("logtags", LogtagsSingleton)
86 ctx.RegisterSingletonType("kythe_java_extract", kytheExtractJavaFactory)
87}
88
Artur Satayev8cf899a2020-04-15 17:29:42 +010089func (j *Module) CheckStableSdkVersion() error {
90 sdkVersion := j.sdkVersion()
91 if sdkVersion.stable() {
92 return nil
93 }
94 return fmt.Errorf("non stable SDK %v", sdkVersion)
95}
96
Artur Satayev2db1c3f2020-04-08 19:09:30 +010097func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
Colin Crossc2d24052020-05-13 11:05:02 -070098 if j.RequiresStableAPIs(ctx) {
Jeongik Cha2cc570d2019-10-29 15:44:45 +090099 if sc, ok := ctx.Module().(sdkContext); ok {
Jiyong Park6a927c42020-01-21 02:03:43 +0900100 if !sc.sdkVersion().specified() {
Jeongik Cha2cc570d2019-10-29 15:44:45 +0900101 ctx.PropertyErrorf("sdk_version",
102 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
103 }
104 }
105 }
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100106
107 ctx.VisitDirectDeps(func(module android.Module) {
108 tag := ctx.OtherModuleDependencyTag(module)
109 switch module.(type) {
110 // TODO(satayev): cover other types as well, e.g. imports
111 case *Library, *AndroidLibrary:
112 switch tag {
113 case bootClasspathTag, libTag, staticLibTag, java9LibTag:
114 checkLinkType(ctx, j, module.(linkTypeContext), tag.(dependencyTag))
115 }
116 }
117 })
Jeongik Cha2cc570d2019-10-29 15:44:45 +0900118}
119
Jeongik Cha538c0d02019-07-11 15:54:27 +0900120func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
121 if sc, ok := ctx.Module().(sdkContext); ok {
122 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park6a927c42020-01-21 02:03:43 +0900123 sdkVersionSpecified := sc.sdkVersion().specified()
124 if usePlatformAPI && sdkVersionSpecified {
125 ctx.PropertyErrorf("platform_apis", "platform_apis must be false when sdk_version is not empty.")
126 } else if !usePlatformAPI && !sdkVersionSpecified {
127 ctx.PropertyErrorf("platform_apis", "platform_apis must be true when sdk_version is empty.")
Jeongik Cha538c0d02019-07-11 15:54:27 +0900128 }
129
130 }
131}
132
Colin Cross2fe66872015-03-30 17:20:39 -0700133// TODO:
134// Autogenerated files:
Colin Cross2fe66872015-03-30 17:20:39 -0700135// Renderscript
136// Post-jar passes:
137// Proguard
Colin Cross2fe66872015-03-30 17:20:39 -0700138// Rmtypedefs
Colin Cross2fe66872015-03-30 17:20:39 -0700139// DroidDoc
140// Findbugs
141
Colin Cross89536d42017-07-07 14:35:50 -0700142type CompilerProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -0700143 // list of source files used to compile the Java module. May be .java, .logtags, .proto,
144 // or .aidl files.
Colin Cross27b922f2019-03-04 22:35:41 -0800145 Srcs []string `android:"path,arch_variant"`
Dan Willemsen2ef08f42015-06-30 18:15:24 -0700146
147 // list of source files that should not be used to build the Java module.
148 // This is most useful in the arch/multilib variants to remove non-common files
Colin Cross27b922f2019-03-04 22:35:41 -0800149 Exclude_srcs []string `android:"path,arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700150
151 // list of directories containing Java resources
Colin Cross86a63ff2017-09-27 17:33:10 -0700152 Java_resource_dirs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700153
Colin Cross86a63ff2017-09-27 17:33:10 -0700154 // list of directories that should be excluded from java_resource_dirs
155 Exclude_java_resource_dirs []string `android:"arch_variant"`
Dan Willemsen2ef08f42015-06-30 18:15:24 -0700156
Colin Cross0f37af02017-09-27 17:42:05 -0700157 // list of files to use as Java resources
Colin Cross27b922f2019-03-04 22:35:41 -0800158 Java_resources []string `android:"path,arch_variant"`
Colin Cross0f37af02017-09-27 17:42:05 -0700159
Colin Crosscedd4762018-09-13 11:26:19 -0700160 // list of files that should be excluded from java_resources and java_resource_dirs
Colin Cross27b922f2019-03-04 22:35:41 -0800161 Exclude_java_resources []string `android:"path,arch_variant"`
Colin Cross0f37af02017-09-27 17:42:05 -0700162
Colin Cross7d5136f2015-05-11 13:39:40 -0700163 // list of module-specific flags that will be used for javac compiles
164 Javacflags []string `android:"arch_variant"`
165
Zoran Jovanovic8736ce22018-08-21 17:10:29 +0200166 // list of module-specific flags that will be used for kotlinc compiles
167 Kotlincflags []string `android:"arch_variant"`
168
Colin Cross7d5136f2015-05-11 13:39:40 -0700169 // list of of java libraries that will be in the classpath
Colin Crosse8dc34a2017-07-19 11:22:16 -0700170 Libs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700171
172 // list of java libraries that will be compiled into the resulting jar
Colin Crosse8dc34a2017-07-19 11:22:16 -0700173 Static_libs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700174
175 // manifest file to be included in resulting jar
Colin Cross27b922f2019-03-04 22:35:41 -0800176 Manifest *string `android:"path"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700177
Colin Cross540eff82017-06-22 17:01:52 -0700178 // if not blank, run jarjar using the specified rules file
Colin Cross27b922f2019-03-04 22:35:41 -0800179 Jarjar_rules *string `android:"path,arch_variant"`
Colin Cross64162712017-08-08 13:17:59 -0700180
181 // If not blank, set the java version passed to javac as -source and -target
182 Java_version *string
Colin Cross2c429dc2017-08-31 16:45:16 -0700183
Colin Cross9ae1b922018-06-26 17:59:05 -0700184 // If set to true, allow this module to be dexed and installed on devices. Has no
185 // effect on host modules, which are always considered installable.
Colin Cross2c429dc2017-08-31 16:45:16 -0700186 Installable *bool
Colin Cross32f676a2017-09-06 13:41:06 -0700187
Colin Cross0f37af02017-09-27 17:42:05 -0700188 // If set to true, include sources used to compile the module in to the final jar
189 Include_srcs *bool
190
Vladimir Marko0975ee02019-04-02 10:29:55 +0100191 // If not empty, classes are restricted to the specified packages and their sub-packages.
192 // This restriction is checked after applying jarjar rules and including static libs.
193 Permitted_packages []string
194
Colin Crossbe9cdb82019-01-21 21:37:16 -0800195 // List of modules to use as annotation processors
196 Plugins []string
Colin Cross1369cdb2017-09-29 17:58:17 -0700197
Artur Satayev9cf46692019-11-26 18:08:34 +0000198 // List of modules to export to libraries that directly depend on this library as annotation processors
199 Exported_plugins []string
200
Nan Zhang61eaedb2017-11-02 13:28:15 -0700201 // The number of Java source entries each Javac instance can process
202 Javac_shard_size *int64
203
Nan Zhang5f8cb422018-02-06 10:34:32 -0800204 // Add host jdk tools.jar to bootclasspath
205 Use_tools_jar *bool
206
Colin Cross1369cdb2017-09-29 17:58:17 -0700207 Openjdk9 struct {
Colin Cross6cef4812019-10-17 14:23:50 -0700208 // List of source files that should only be used when passing -source 1.9 or higher
Colin Cross27b922f2019-03-04 22:35:41 -0800209 Srcs []string `android:"path"`
Colin Cross1369cdb2017-09-29 17:58:17 -0700210
Colin Cross6cef4812019-10-17 14:23:50 -0700211 // List of javac flags that should only be used when passing -source 1.9 or higher
Colin Cross1369cdb2017-09-29 17:58:17 -0700212 Javacflags []string
213 }
Colin Crosscb933592017-11-22 13:49:43 -0800214
Colin Cross81440082018-08-15 20:21:55 -0700215 // When compiling language level 9+ .java code in packages that are part of
216 // a system module, patch_module names the module that your sources and
217 // dependencies should be patched into. The Android runtime currently
218 // doesn't implement the JEP 261 module system so this option is only
219 // supported at compile time. It should only be needed to compile tests in
220 // packages that exist in libcore and which are inconvenient to move
221 // elsewhere.
Tobias Thiererdda713d2018-09-19 16:16:19 +0100222 Patch_module *string `android:"arch_variant"`
Colin Cross81440082018-08-15 20:21:55 -0700223
Colin Crosscb933592017-11-22 13:49:43 -0800224 Jacoco struct {
225 // List of classes to include for instrumentation with jacoco to collect coverage
226 // information at runtime when building with coverage enabled. If unset defaults to all
227 // classes.
228 // Supports '*' as the last character of an entry in the list as a wildcard match.
229 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
230 // it matches classes in the package that have the class name as a prefix.
231 Include_filter []string
232
233 // List of classes to exclude from instrumentation with jacoco to collect coverage
234 // information at runtime when building with coverage enabled. Overrides classes selected
235 // by the include_filter property.
236 // Supports '*' as the last character of an entry in the list as a wildcard match.
237 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
238 // it matches classes in the package that have the class name as a prefix.
239 Exclude_filter []string
240 }
241
Andreas Gampef3e5b552018-01-22 21:27:21 -0800242 Errorprone struct {
243 // List of javac flags that should only be used when running errorprone.
244 Javacflags []string
245 }
246
Colin Cross0f2ee152017-12-14 15:22:43 -0800247 Proto struct {
248 // List of extra options that will be passed to the proto generator.
249 Output_params []string
250 }
251
Colin Crosscb933592017-11-22 13:49:43 -0800252 Instrument bool `blueprint:"mutated"`
Alex Light7f004a72019-02-21 13:27:37 -0800253
254 // List of files to include in the META-INF/services folder of the resulting jar.
Colin Cross27b922f2019-03-04 22:35:41 -0800255 Services []string `android:"path,arch_variant"`
Colin Cross540eff82017-06-22 17:01:52 -0700256}
257
Colin Cross89536d42017-07-07 14:35:50 -0700258type CompilerDeviceProperties struct {
Colin Cross540eff82017-06-22 17:01:52 -0700259 // list of module-specific flags that will be used for dex compiles
260 Dxflags []string `android:"arch_variant"`
261
Jeongik Cha538c0d02019-07-11 15:54:27 +0900262 // if not blank, set to the version of the sdk to compile against.
263 // Defaults to compiling against the current platform.
Nan Zhangea568a42017-11-08 21:20:04 -0800264 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700265
Colin Cross83bb3162018-06-25 15:48:06 -0700266 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
267 // Defaults to sdk_version if not set.
268 Min_sdk_version *string
269
Dan Willemsen419290a2018-10-31 15:28:47 -0700270 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
271 // Defaults to sdk_version if not set.
272 Target_sdk_version *string
273
Jeongik Cha356dac42019-08-19 14:09:52 +0900274 // Whether to compile against the platform APIs instead of an SDK.
275 // If true, then sdk_version must be empty. The value of this field
276 // is ignored when module's type isn't android_app.
Colin Cross6af2e492018-05-22 11:12:33 -0700277 Platform_apis *bool
278
Colin Crossebe1a512017-11-14 13:12:14 -0800279 Aidl struct {
280 // Top level directories to pass to aidl tool
281 Include_dirs []string
Colin Cross7d5136f2015-05-11 13:39:40 -0700282
Colin Crossebe1a512017-11-14 13:12:14 -0800283 // Directories rooted at the Android.bp file to pass to aidl tool
284 Local_include_dirs []string
285
286 // directories that should be added as include directories for any aidl sources of modules
287 // that depend on this module, as well as to aidl for this module.
288 Export_include_dirs []string
Martijn Coeneneab15642018-03-09 09:29:59 +0100289
290 // whether to generate traces (for systrace) for this interface
291 Generate_traces *bool
Olivier Gaillard0a4cfbc2018-07-16 23:37:03 +0100292
293 // whether to generate Binder#GetTransaction name method.
294 Generate_get_transaction_name *bool
Colin Crossebe1a512017-11-14 13:12:14 -0800295 }
Colin Cross92430102017-10-09 14:59:32 -0700296
297 // If true, export a copy of the module as a -hostdex module for host testing.
298 Hostdex *bool
Colin Cross1369cdb2017-09-29 17:58:17 -0700299
Colin Cross7f87f4f2019-04-24 13:41:45 -0700300 Target struct {
301 Hostdex struct {
302 // Additional required dependencies to add to -hostdex modules.
303 Required []string
304 }
305 }
306
David Brazdil17ef5632018-06-27 10:27:45 +0100307 // If set to true, compile dex regardless of installable. Defaults to false.
308 Compile_dex *bool
309
Colin Cross66dbc0b2017-12-28 12:23:20 -0800310 Optimize struct {
Colin Crossae5caf52018-05-22 11:11:52 -0700311 // If false, disable all optimization. Defaults to true for android_app and android_test
312 // modules, false for java_library and java_test modules.
Colin Cross66dbc0b2017-12-28 12:23:20 -0800313 Enabled *bool
Sasha Smundak2057f822019-04-16 17:16:58 -0700314 // True if the module containing this has it set by default.
315 EnabledByDefault bool `blueprint:"mutated"`
Colin Cross66dbc0b2017-12-28 12:23:20 -0800316
317 // If true, optimize for size by removing unused code. Defaults to true for apps,
318 // false for libraries and tests.
319 Shrink *bool
320
321 // If true, optimize bytecode. Defaults to false.
322 Optimize *bool
323
324 // If true, obfuscate bytecode. Defaults to false.
325 Obfuscate *bool
326
327 // If true, do not use the flag files generated by aapt that automatically keep
328 // classes referenced by the app manifest. Defaults to false.
329 No_aapt_flags *bool
330
331 // Flags to pass to proguard.
332 Proguard_flags []string
333
334 // Specifies the locations of files containing proguard flags.
Colin Cross27b922f2019-03-04 22:35:41 -0800335 Proguard_flags_files []string `android:"path"`
Colin Cross66dbc0b2017-12-28 12:23:20 -0800336 }
337
Paul Duffine25c6442019-10-11 13:50:28 +0100338 // When targeting 1.9 and above, override the modules to use with --system,
339 // otherwise provides defaults libraries to add to the bootclasspath.
Colin Cross1369cdb2017-09-29 17:58:17 -0700340 System_modules *string
Colin Cross5a0dcd52018-10-05 14:20:06 -0700341
Jiyong Park4c4c0242019-10-21 14:53:15 +0900342 // set the name of the output
343 Stem *string
344
David Srbeckye033cba2020-05-20 22:20:28 +0100345 // Keep the data uncompressed. We always need uncompressed dex for execution,
346 // so this might actually save space by avoiding storing the same data twice.
347 // This defaults to reasonable value based on module and should not be set.
348 // It exists only to support ART tests.
349 Uncompress_dex *bool
350
351 IsSDKLibrary bool `blueprint:"mutated"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700352}
353
Sasha Smundak2057f822019-04-16 17:16:58 -0700354func (me *CompilerDeviceProperties) EffectiveOptimizeEnabled() bool {
355 return BoolDefault(me.Optimize.Enabled, me.Optimize.EnabledByDefault)
356}
357
Paul Duffin0d3c2e12020-05-17 08:34:50 +0100358// Functionality common to Module and Import
Paul Duffin859fe962020-05-15 10:20:31 +0100359//
360// It is embedded in Module so its functionality can be used by methods in Module
361// but it is currently only initialized by Import and Library.
Paul Duffin0d3c2e12020-05-17 08:34:50 +0100362type embeddableInModuleAndImport struct {
Paul Duffin859fe962020-05-15 10:20:31 +0100363
364 // Functionality related to this being used as a component of a java_sdk_library.
365 EmbeddableSdkLibraryComponent
366}
367
368func (e *embeddableInModuleAndImport) initModuleAndImport(moduleBase *android.ModuleBase) {
369 e.initSdkLibraryComponent(moduleBase)
Paul Duffin0d3c2e12020-05-17 08:34:50 +0100370}
371
372// Module/Import's DepIsInSameApex(...) delegates to this method.
373//
374// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
375// the one provided by ApexModuleBase.
376func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
377 // dependencies other than the static linkage are all considered crossing APEX boundary
378 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
379 return true
380 }
381 return false
382}
383
Colin Cross46c9b8b2017-06-22 16:51:17 -0700384// Module contains the properties and members used by all java module types
385type Module struct {
Colin Cross635c3b02016-05-18 15:37:25 -0700386 android.ModuleBase
Colin Cross89536d42017-07-07 14:35:50 -0700387 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +0900388 android.ApexModuleBase
Jiyong Parkd1063c12019-07-17 20:08:41 +0900389 android.SdkBase
Colin Cross2fe66872015-03-30 17:20:39 -0700390
Paul Duffin0d3c2e12020-05-17 08:34:50 +0100391 // Functionality common to Module and Import.
392 embeddableInModuleAndImport
393
Colin Cross89536d42017-07-07 14:35:50 -0700394 properties CompilerProperties
Colin Cross6af17aa2017-09-20 12:59:05 -0700395 protoProperties android.ProtoProperties
Colin Cross89536d42017-07-07 14:35:50 -0700396 deviceProperties CompilerDeviceProperties
Colin Cross2fe66872015-03-30 17:20:39 -0700397
Colin Cross331a1212018-08-15 20:40:52 -0700398 // jar file containing header classes including static library dependencies, suitable for
399 // inserting into the bootclasspath/classpath of another compile
Nan Zhanged19fc32017-10-19 13:06:22 -0700400 headerJarFile android.Path
401
Colin Cross331a1212018-08-15 20:40:52 -0700402 // jar file containing implementation classes including static library dependencies but no
403 // resources
Nan Zhanged19fc32017-10-19 13:06:22 -0700404 implementationJarFile android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700405
Colin Cross331a1212018-08-15 20:40:52 -0700406 // jar file containing only resources including from static library dependencies
407 resourceJar android.Path
408
Colin Cross0c4ce212019-05-03 15:28:19 -0700409 // args and dependencies to package source files into a srcjar
410 srcJarArgs []string
411 srcJarDeps android.Paths
412
Colin Cross331a1212018-08-15 20:40:52 -0700413 // jar file containing implementation classes and resources including static library
414 // dependencies
415 implementationAndResourcesJar android.Path
416
417 // output file containing classes.dex and resources
Colin Cross6ade34f2017-09-15 13:00:47 -0700418 dexJarFile android.Path
419
Colin Cross43f08db2018-11-12 10:13:39 -0800420 // output file that contains classes.dex if it should be in the output file
421 maybeStrippedDexJarFile android.Path
422
Colin Crosscb933592017-11-22 13:49:43 -0800423 // output file containing uninstrumented classes that will be instrumented by jacoco
424 jacocoReportClassesFile android.Path
425
Colin Cross66dbc0b2017-12-28 12:23:20 -0800426 // output file containing mapping of obfuscated names
427 proguardDictionary android.Path
428
Colin Cross331a1212018-08-15 20:40:52 -0700429 // output file of the module, which may be a classes jar or a dex jar
Colin Crosse560c4a2019-03-19 16:03:11 -0700430 outputFile android.Path
431 extraOutputFiles android.Paths
Colin Crossb7a63242015-04-16 14:09:14 -0700432
Colin Cross635c3b02016-05-18 15:37:25 -0700433 exportAidlIncludeDirs android.Paths
Colin Crossc0b06f12015-04-08 13:03:43 -0700434
Colin Cross635c3b02016-05-18 15:37:25 -0700435 logtagsSrcs android.Paths
Colin Crossf05fe972015-04-10 17:45:20 -0700436
Colin Cross2fe66872015-03-30 17:20:39 -0700437 // installed file for binary dependency
Colin Cross635c3b02016-05-18 15:37:25 -0700438 installFile android.Path
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800439
440 // list of .java files and srcjars that was passed to javac
441 compiledJavaSrcs android.Paths
442 compiledSrcJars android.Paths
Colin Cross66dbc0b2017-12-28 12:23:20 -0800443
444 // list of extra progurad flag files
445 extraProguardFlagFiles android.Paths
Jiyong Park1be96912018-05-28 18:02:19 +0900446
Colin Cross094054a2018-10-17 15:10:48 -0700447 // manifest file to use instead of properties.Manifest
448 overrideManifest android.OptionalPath
449
Artur Satayev9cf46692019-11-26 18:08:34 +0000450 // list of SDK lib names that this java module is exporting
Jiyong Park1be96912018-05-28 18:02:19 +0900451 exportedSdkLibs []string
Brandon Lee5d45c6f2018-08-15 15:35:38 -0700452
Artur Satayev9cf46692019-11-26 18:08:34 +0000453 // list of plugins that this java module is exporting
454 exportedPluginJars android.Paths
455
456 // list of plugins that this java module is exporting
457 exportedPluginClasses []string
458
459 // list of source files, collected from srcFiles with unique java and all kt files,
patricktu242faad2019-09-24 15:41:30 +0800460 // will be used by android.IDEInfo struct
Brandon Lee5d45c6f2018-08-15 15:35:38 -0700461 expandIDEInfoCompiledSrcs []string
Colin Cross43f08db2018-11-12 10:13:39 -0800462
Steven Morelandc4efd9c2019-01-18 11:51:25 -0800463 // expanded Jarjar_rules
464 expandJarjarRules android.Path
465
Colin Cross988708c2019-05-06 14:04:11 -0700466 // Extra files generated by the module type to be added as java resources.
467 extraResources android.Paths
468
Colin Crossf24a22a2019-01-31 14:12:44 -0800469 hiddenAPI
Colin Cross43f08db2018-11-12 10:13:39 -0800470 dexpreopter
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800471
472 // list of the xref extraction files
473 kytheFiles android.Paths
Anton Hansson78156ef2020-03-27 19:39:48 +0000474
475 distFile android.Path
bralee1fbf4402020-05-21 10:11:59 +0800476
477 // Collect the module directory for IDE info in java/jdeps.go.
478 modulePaths []string
Colin Cross2fe66872015-03-30 17:20:39 -0700479}
480
Colin Cross41955e82019-05-29 14:40:35 -0700481func (j *Module) OutputFiles(tag string) (android.Paths, error) {
482 switch tag {
483 case "":
484 return append(android.Paths{j.outputFile}, j.extraOutputFiles...), nil
Colin Cross375ca3c2019-05-29 14:40:58 -0700485 case ".jar":
486 return android.Paths{j.implementationAndResourcesJar}, nil
Colin Cross2d975b12019-07-29 16:47:42 -0700487 case ".proguard_map":
488 return android.Paths{j.proguardDictionary}, nil
Colin Cross41955e82019-05-29 14:40:35 -0700489 default:
490 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
491 }
Colin Cross54250902017-12-05 09:28:08 -0800492}
493
Colin Cross41955e82019-05-29 14:40:35 -0700494var _ android.OutputFileProducer = (*Module)(nil)
Colin Cross54250902017-12-05 09:28:08 -0800495
Colin Crossf506d872017-07-19 15:53:04 -0700496type Dependency interface {
Nan Zhanged19fc32017-10-19 13:06:22 -0700497 HeaderJars() android.Paths
498 ImplementationJars() android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700499 ResourceJars() android.Paths
500 ImplementationAndResourcesJars() android.Paths
Ulyana Trafimovichb0dc8512020-06-04 10:37:36 +0000501 DexJar() android.Path
Colin Cross635c3b02016-05-18 15:37:25 -0700502 AidlIncludeDirs() android.Paths
Jiyong Park1be96912018-05-28 18:02:19 +0900503 ExportedSdkLibs() []string
Artur Satayev9cf46692019-11-26 18:08:34 +0000504 ExportedPlugins() (android.Paths, []string)
Colin Cross0c4ce212019-05-03 15:28:19 -0700505 SrcJarArgs() ([]string, android.Paths)
Colin Crosse323f3c2019-09-17 15:34:09 -0700506 BaseModuleName() string
Jiyong Park618922e2020-01-08 13:35:43 +0900507 JacocoReportClassesFile() android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700508}
509
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800510type xref interface {
511 XrefJavaFiles() android.Paths
512}
513
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800514func (j *Module) XrefJavaFiles() android.Paths {
515 return j.kytheFiles
516}
517
Colin Cross89536d42017-07-07 14:35:50 -0700518func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
519 android.InitAndroidArchModule(module, hod, android.MultilibCommon)
520 android.InitDefaultableModule(module)
521}
522
Colin Crossbe1da472017-07-07 15:59:46 -0700523type dependencyTag struct {
524 blueprint.BaseDependencyTag
525 name string
Colin Cross2fe66872015-03-30 17:20:39 -0700526}
527
Colin Crossa4f08812018-10-02 22:03:40 -0700528type jniDependencyTag struct {
529 blueprint.BaseDependencyTag
Colin Crossa4f08812018-10-02 22:03:40 -0700530}
531
Jiyong Park8be103b2019-11-08 15:53:48 +0900532func IsJniDepTag(depTag blueprint.DependencyTag) bool {
533 _, ok := depTag.(*jniDependencyTag)
534 return ok
535}
536
Colin Crossbe1da472017-07-07 15:59:46 -0700537var (
Colin Cross4b964c02018-10-15 16:18:06 -0700538 staticLibTag = dependencyTag{name: "staticlib"}
539 libTag = dependencyTag{name: "javalib"}
Colin Cross6cef4812019-10-17 14:23:50 -0700540 java9LibTag = dependencyTag{name: "java9lib"}
Colin Crossbe9cdb82019-01-21 21:37:16 -0800541 pluginTag = dependencyTag{name: "plugin"}
Artur Satayev9cf46692019-11-26 18:08:34 +0000542 exportedPluginTag = dependencyTag{name: "exported-plugin"}
Colin Cross4b964c02018-10-15 16:18:06 -0700543 bootClasspathTag = dependencyTag{name: "bootclasspath"}
544 systemModulesTag = dependencyTag{name: "system modules"}
545 frameworkResTag = dependencyTag{name: "framework-res"}
546 frameworkApkTag = dependencyTag{name: "framework-apk"}
547 kotlinStdlibTag = dependencyTag{name: "kotlin-stdlib"}
Colin Crossafbb1732019-01-17 15:42:52 -0800548 kotlinAnnotationsTag = dependencyTag{name: "kotlin-annotations"}
Colin Cross4b964c02018-10-15 16:18:06 -0700549 proguardRaiseTag = dependencyTag{name: "proguard-raise"}
550 certificateTag = dependencyTag{name: "certificate"}
551 instrumentationForTag = dependencyTag{name: "instrumentation_for"}
Colin Cross50ddcc42019-05-16 12:28:22 -0700552 usesLibTag = dependencyTag{name: "uses-library"}
Colin Crossbe1da472017-07-07 15:59:46 -0700553)
Colin Cross2fe66872015-03-30 17:20:39 -0700554
Jiyong Park83dc74b2020-01-14 18:38:44 +0900555func IsLibDepTag(depTag blueprint.DependencyTag) bool {
556 return depTag == libTag
557}
558
559func IsStaticLibDepTag(depTag blueprint.DependencyTag) bool {
560 return depTag == staticLibTag
561}
562
Colin Crossfc3674a2017-09-18 17:41:52 -0700563type sdkDep struct {
Colin Cross47ff2522017-10-02 14:22:08 -0700564 useModule, useFiles, useDefaultLibs, invalidVersion bool
565
Colin Cross6cef4812019-10-17 14:23:50 -0700566 // The modules that will be added to the bootclasspath when targeting 1.8 or lower
567 bootclasspath []string
Paul Duffine25c6442019-10-11 13:50:28 +0100568
569 // The default system modules to use. Will be an empty string if no system
570 // modules are to be used.
Colin Cross1369cdb2017-09-29 17:58:17 -0700571 systemModules string
572
Colin Cross6cef4812019-10-17 14:23:50 -0700573 // The modules that will be added ot the classpath when targeting 1.9 or higher
574 java9Classpath []string
575
Colin Crossa97c5d32018-03-28 14:58:31 -0700576 frameworkResModule string
577
Colin Cross86a60ae2018-05-29 14:44:55 -0700578 jars android.Paths
Colin Cross3047fa22019-04-18 10:56:44 -0700579 aidl android.OptionalPath
Paul Duffin250e6192019-06-07 10:44:37 +0100580
581 noStandardLibs, noFrameworksLibs bool
582}
583
584func (s sdkDep) hasStandardLibs() bool {
585 return !s.noStandardLibs
586}
587
588func (s sdkDep) hasFrameworkLibs() bool {
589 return !s.noStandardLibs && !s.noFrameworksLibs
Colin Cross1369cdb2017-09-29 17:58:17 -0700590}
591
Colin Crossa4f08812018-10-02 22:03:40 -0700592type jniLib struct {
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700593 name string
594 path android.Path
595 target android.Target
596 coverageFile android.OptionalPath
Colin Crossa4f08812018-10-02 22:03:40 -0700597}
598
Colin Cross0ea8ba82019-06-06 14:33:29 -0700599func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
Colin Cross3144dfc2018-01-03 15:06:47 -0800600 return j.properties.Instrument && ctx.Config().IsEnvTrue("EMMA_INSTRUMENT")
601}
602
Colin Cross0ea8ba82019-06-06 14:33:29 -0700603func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Colin Cross3144dfc2018-01-03 15:06:47 -0800604 return j.shouldInstrument(ctx) &&
605 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
606 ctx.Config().UnbundledBuild())
607}
608
Jiyong Park6a927c42020-01-21 02:03:43 +0900609func (j *Module) sdkVersion() sdkSpec {
610 return sdkSpecFrom(String(j.deviceProperties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -0700611}
612
Paul Duffine25c6442019-10-11 13:50:28 +0100613func (j *Module) systemModules() string {
614 return proptools.String(j.deviceProperties.System_modules)
615}
616
Jiyong Park6a927c42020-01-21 02:03:43 +0900617func (j *Module) minSdkVersion() sdkSpec {
Colin Cross83bb3162018-06-25 15:48:06 -0700618 if j.deviceProperties.Min_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +0900619 return sdkSpecFrom(*j.deviceProperties.Min_sdk_version)
Colin Cross83bb3162018-06-25 15:48:06 -0700620 }
621 return j.sdkVersion()
622}
623
Jiyong Park6a927c42020-01-21 02:03:43 +0900624func (j *Module) targetSdkVersion() sdkSpec {
Dan Willemsen419290a2018-10-31 15:28:47 -0700625 if j.deviceProperties.Target_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +0900626 return sdkSpecFrom(*j.deviceProperties.Target_sdk_version)
Dan Willemsen419290a2018-10-31 15:28:47 -0700627 }
628 return j.sdkVersion()
629}
630
Artur Satayev480e25b2020-04-27 18:53:18 +0100631func (j *Module) MinSdkVersion() string {
632 return j.minSdkVersion().version.String()
633}
634
Jiyong Parkb02bb402019-12-03 00:43:57 +0900635func (j *Module) AvailableFor(what string) bool {
636 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
637 // Exception: for hostdex: true libraries, the platform variant is created
638 // even if it's not marked as available to platform. In that case, the platform
639 // variant is used only for the hostdex and not installed to the device.
640 return true
641 }
642 return j.ApexModuleBase.AvailableFor(what)
643}
644
Colin Crossbe1da472017-07-07 15:59:46 -0700645func (j *Module) deps(ctx android.BottomUpMutatorContext) {
Colin Cross1369cdb2017-09-29 17:58:17 -0700646 if ctx.Device() {
Paul Duffin250e6192019-06-07 10:44:37 +0100647 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Cross6d8d8c62019-10-28 15:10:03 -0700648 if sdkDep.useDefaultLibs {
649 ctx.AddVariationDependencies(nil, bootClasspathTag, config.DefaultBootclasspathLibraries...)
650 ctx.AddVariationDependencies(nil, systemModulesTag, config.DefaultSystemModules)
651 if sdkDep.hasFrameworkLibs() {
652 ctx.AddVariationDependencies(nil, libTag, config.DefaultLibraries...)
Colin Crossbe1da472017-07-07 15:59:46 -0700653 }
Colin Cross6d8d8c62019-10-28 15:10:03 -0700654 } else if sdkDep.useModule {
Colin Cross6cef4812019-10-17 14:23:50 -0700655 ctx.AddVariationDependencies(nil, bootClasspathTag, sdkDep.bootclasspath...)
Colin Cross6cef4812019-10-17 14:23:50 -0700656 ctx.AddVariationDependencies(nil, java9LibTag, sdkDep.java9Classpath...)
Colin Cross6d8d8c62019-10-28 15:10:03 -0700657 if j.deviceProperties.EffectiveOptimizeEnabled() && sdkDep.hasStandardLibs() {
658 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.DefaultBootclasspathLibraries...)
659 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.DefaultLibraries...)
660 }
Colin Cross2fe66872015-03-30 17:20:39 -0700661 }
Colin Cross17dec172020-05-14 18:05:32 -0700662 if sdkDep.systemModules != "" {
663 ctx.AddVariationDependencies(nil, systemModulesTag, sdkDep.systemModules)
664 }
Colin Cross6d8d8c62019-10-28 15:10:03 -0700665
Nan Zhangb2b33de2018-02-23 11:18:47 -0800666 if ctx.ModuleName() == "android_stubs_current" ||
667 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -0700668 ctx.ModuleName() == "android_test_stubs_current" {
Colin Cross42d48b72018-08-29 14:10:52 -0700669 ctx.AddVariationDependencies(nil, frameworkApkTag, "framework-res")
Nan Zhangb2b33de2018-02-23 11:18:47 -0800670 }
Colin Cross2fe66872015-03-30 17:20:39 -0700671 }
Colin Cross1369cdb2017-09-29 17:58:17 -0700672
Inseob Kimac1e9862019-12-09 18:15:47 +0900673 syspropPublicStubs := syspropPublicStubs(ctx.Config())
674
675 // rewriteSyspropLibs validates if a java module can link against platform's sysprop_library,
676 // and redirects dependency to public stub depending on the link type.
677 rewriteSyspropLibs := func(libs []string, prop string) []string {
678 // make a copy
679 ret := android.CopyOf(libs)
680
681 for idx, lib := range libs {
682 stub, ok := syspropPublicStubs[lib]
683
684 if !ok {
685 continue
686 }
687
688 linkType, _ := j.getLinkType(ctx.ModuleName())
Inseob Kimc5239512020-01-14 15:36:21 +0900689 // only platform modules can use internal props
690 if linkType != javaPlatform {
Inseob Kimac1e9862019-12-09 18:15:47 +0900691 ret[idx] = stub
Inseob Kimac1e9862019-12-09 18:15:47 +0900692 }
693 }
694
695 return ret
696 }
697
698 ctx.AddVariationDependencies(nil, libTag, rewriteSyspropLibs(j.properties.Libs, "libs")...)
699 ctx.AddVariationDependencies(nil, staticLibTag, rewriteSyspropLibs(j.properties.Static_libs, "static_libs")...)
Colin Crossa4f08812018-10-02 22:03:40 -0700700
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700701 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
Artur Satayev9cf46692019-11-26 18:08:34 +0000702 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
Colin Crossbe9cdb82019-01-21 21:37:16 -0800703
Colin Crossfe17f6f2019-03-28 19:30:56 -0700704 android.ProtoDeps(ctx, &j.protoProperties)
Colin Cross6af17aa2017-09-20 12:59:05 -0700705 if j.hasSrcExt(".proto") {
706 protoDeps(ctx, &j.protoProperties)
707 }
Colin Cross93e85952017-08-15 13:34:18 -0700708
709 if j.hasSrcExt(".kt") {
710 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
711 // Kotlin files
Colin Cross0b03d972019-05-13 11:06:25 -0700712 ctx.AddVariationDependencies(nil, kotlinStdlibTag,
713 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8")
Colin Cross7788c122019-01-23 16:14:02 -0800714 if len(j.properties.Plugins) > 0 {
Colin Crossafbb1732019-01-17 15:42:52 -0800715 ctx.AddVariationDependencies(nil, kotlinAnnotationsTag, "kotlin-annotations")
716 }
Colin Cross93e85952017-08-15 13:34:18 -0700717 }
Colin Cross3144dfc2018-01-03 15:06:47 -0800718
Ulya Trafimovich38dfa0f2020-01-07 16:37:02 +0000719 // Framework libraries need special handling in static coverage builds: they should not have
720 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
721 // the same jacoco classes coming from different bootclasspath jars.
722 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
723 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
724 j.properties.Instrument = true
725 }
726 } else if j.shouldInstrumentStatic(ctx) {
Colin Cross42d48b72018-08-29 14:10:52 -0700727 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
Colin Cross3144dfc2018-01-03 15:06:47 -0800728 }
Colin Cross6af17aa2017-09-20 12:59:05 -0700729}
730
731func hasSrcExt(srcs []string, ext string) bool {
732 for _, src := range srcs {
733 if filepath.Ext(src) == ext {
734 return true
735 }
736 }
737
738 return false
739}
740
741func (j *Module) hasSrcExt(ext string) bool {
742 return hasSrcExt(j.properties.Srcs, ext)
Colin Cross2fe66872015-03-30 17:20:39 -0700743}
744
Colin Cross46c9b8b2017-06-22 16:51:17 -0700745func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Colin Cross3047fa22019-04-18 10:56:44 -0700746 aidlIncludeDirs android.Paths) (string, android.Paths) {
Colin Crossc0b06f12015-04-08 13:03:43 -0700747
Colin Crossebe1a512017-11-14 13:12:14 -0800748 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
749 aidlIncludes = append(aidlIncludes,
750 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
751 aidlIncludes = append(aidlIncludes,
752 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
Colin Crossc0b06f12015-04-08 13:03:43 -0700753
Colin Cross3047fa22019-04-18 10:56:44 -0700754 var flags []string
755 var deps android.Paths
Steven Moreland667f6882018-07-26 12:55:08 -0700756
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700757 if aidlPreprocess.Valid() {
758 flags = append(flags, "-p"+aidlPreprocess.String())
Colin Cross3047fa22019-04-18 10:56:44 -0700759 deps = append(deps, aidlPreprocess.Path())
760 } else if len(aidlIncludeDirs) > 0 {
Colin Cross635c3b02016-05-18 15:37:25 -0700761 flags = append(flags, android.JoinWithPrefix(aidlIncludeDirs.Strings(), "-I"))
Colin Crossc0b06f12015-04-08 13:03:43 -0700762 }
763
Colin Cross3047fa22019-04-18 10:56:44 -0700764 if len(j.exportAidlIncludeDirs) > 0 {
765 flags = append(flags, android.JoinWithPrefix(j.exportAidlIncludeDirs.Strings(), "-I"))
766 }
767
768 if len(aidlIncludes) > 0 {
769 flags = append(flags, android.JoinWithPrefix(aidlIncludes.Strings(), "-I"))
770 }
771
Colin Cross635c3b02016-05-18 15:37:25 -0700772 flags = append(flags, "-I"+android.PathForModuleSrc(ctx).String())
Colin Cross32f38982018-02-22 11:47:25 -0800773 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Colin Crossd48633a2017-07-13 14:41:17 -0700774 flags = append(flags, "-I"+src.String())
775 }
Colin Crossc0b06f12015-04-08 13:03:43 -0700776
Martijn Coeneneab15642018-03-09 09:29:59 +0100777 if Bool(j.deviceProperties.Aidl.Generate_traces) {
778 flags = append(flags, "-t")
779 }
780
Olivier Gaillard0a4cfbc2018-07-16 23:37:03 +0100781 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
782 flags = append(flags, "--transaction_names")
783 }
784
Colin Cross3047fa22019-04-18 10:56:44 -0700785 return strings.Join(flags, " "), deps
Colin Crossc0b06f12015-04-08 13:03:43 -0700786}
787
Colin Cross32f676a2017-09-06 13:41:06 -0700788type deps struct {
Nan Zhang581fd212018-01-10 16:06:12 -0800789 classpath classpath
Colin Cross6cef4812019-10-17 14:23:50 -0700790 java9Classpath classpath
Nan Zhang581fd212018-01-10 16:06:12 -0800791 bootClasspath classpath
Colin Cross6a77c982018-06-19 22:43:34 -0700792 processorPath classpath
Colin Crossbe9cdb82019-01-21 21:37:16 -0800793 processorClasses []string
Colin Cross6ade34f2017-09-15 13:00:47 -0700794 staticJars android.Paths
Nan Zhanged19fc32017-10-19 13:06:22 -0700795 staticHeaderJars android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700796 staticResourceJars android.Paths
Colin Cross6ade34f2017-09-15 13:00:47 -0700797 aidlIncludeDirs android.Paths
Nan Zhangb2b33de2018-02-23 11:18:47 -0800798 srcs android.Paths
Colin Cross59149b62017-10-16 18:07:29 -0700799 srcJars android.Paths
Colin Crossb77043e2019-07-16 13:57:13 -0700800 systemModules *systemModules
Colin Cross6ade34f2017-09-15 13:00:47 -0700801 aidlPreprocess android.OptionalPath
Colin Cross93e85952017-08-15 13:34:18 -0700802 kotlinStdlib android.Paths
Colin Crossafbb1732019-01-17 15:42:52 -0800803 kotlinAnnotations android.Paths
Colin Crossbe9cdb82019-01-21 21:37:16 -0800804
805 disableTurbine bool
Colin Cross32f676a2017-09-06 13:41:06 -0700806}
Colin Cross2fe66872015-03-30 17:20:39 -0700807
Colin Cross54250902017-12-05 09:28:08 -0800808func checkProducesJars(ctx android.ModuleContext, dep android.SourceFileProducer) {
809 for _, f := range dep.Srcs() {
810 if f.Ext() != ".jar" {
811 ctx.ModuleErrorf("genrule %q must generate files ending with .jar to be used as a libs or static_libs dependency",
812 ctx.OtherModuleName(dep.(blueprint.Module)))
813 }
814 }
815}
816
Jiyong Park2d492942018-03-05 17:44:10 +0900817type linkType int
818
819const (
Jiyong Park50146e92020-01-30 18:00:15 +0900820 // TODO(jiyong) rename these for better readability. Make the allowed
821 // and disallowed link types explicit
Jiyong Park2d492942018-03-05 17:44:10 +0900822 javaCore linkType = iota
823 javaSdk
824 javaSystem
Jiyong Park50146e92020-01-30 18:00:15 +0900825 javaModule
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900826 javaSystemServer
Jiyong Park2d492942018-03-05 17:44:10 +0900827 javaPlatform
828)
829
Jeongik Cha75b83b02019-11-01 15:28:00 +0900830type linkTypeContext interface {
831 android.Module
832 getLinkType(name string) (ret linkType, stubs bool)
833}
834
835func (m *Module) getLinkType(name string) (ret linkType, stubs bool) {
Colin Cross83bb3162018-06-25 15:48:06 -0700836 ver := m.sdkVersion()
Colin Crossf19b9bb2018-03-26 14:42:44 -0700837 switch {
Jiyong Park46f78fb2018-10-20 16:33:17 +0900838 case name == "core.current.stubs" || name == "core.platform.api.stubs" ||
839 name == "stub-annotations" || name == "private-stub-annotations-jar" ||
Pete Gillincbff3262019-05-08 15:10:06 +0100840 name == "core-lambda-stubs" || name == "core-generated-annotation-stubs":
Jiyong Park46f78fb2018-10-20 16:33:17 +0900841 return javaCore, true
Jiyong Park6a927c42020-01-21 02:03:43 +0900842 case ver.kind == sdkCore:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900843 return javaCore, false
844 case name == "android_system_stubs_current":
845 return javaSystem, true
Jiyong Park6a927c42020-01-21 02:03:43 +0900846 case ver.kind == sdkSystem:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900847 return javaSystem, false
848 case name == "android_test_stubs_current":
849 return javaSystem, true
Jiyong Park6a927c42020-01-21 02:03:43 +0900850 case ver.kind == sdkTest:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900851 return javaPlatform, false
852 case name == "android_stubs_current":
853 return javaSdk, true
Jiyong Park6a927c42020-01-21 02:03:43 +0900854 case ver.kind == sdkPublic:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900855 return javaSdk, false
Jiyong Park50146e92020-01-30 18:00:15 +0900856 case name == "android_module_lib_stubs_current":
857 return javaModule, true
858 case ver.kind == sdkModule:
859 return javaModule, false
Anton Hanssonba6ab2e2020-03-19 15:23:38 +0000860 case name == "android_system_server_stubs_current":
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900861 return javaSystemServer, true
862 case ver.kind == sdkSystemServer:
863 return javaSystemServer, false
Jiyong Park6a927c42020-01-21 02:03:43 +0900864 case ver.kind == sdkPrivate || ver.kind == sdkNone || ver.kind == sdkCorePlatform:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900865 return javaPlatform, false
Jiyong Park6a927c42020-01-21 02:03:43 +0900866 case !ver.valid():
867 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.raw))
Colin Crossf19b9bb2018-03-26 14:42:44 -0700868 default:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900869 return javaSdk, false
Jiyong Park2d492942018-03-05 17:44:10 +0900870 }
871}
872
Jeongik Cha75b83b02019-11-01 15:28:00 +0900873func checkLinkType(ctx android.ModuleContext, from *Module, to linkTypeContext, tag dependencyTag) {
Colin Crossf19b9bb2018-03-26 14:42:44 -0700874 if ctx.Host() {
875 return
876 }
877
Jeongik Cha75b83b02019-11-01 15:28:00 +0900878 myLinkType, stubs := from.getLinkType(ctx.ModuleName())
Jiyong Park46f78fb2018-10-20 16:33:17 +0900879 if stubs {
880 return
881 }
Jeongik Cha75b83b02019-11-01 15:28:00 +0900882 otherLinkType, _ := to.getLinkType(ctx.OtherModuleName(to))
Jiyong Park2d492942018-03-05 17:44:10 +0900883 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."
884
885 switch myLinkType {
886 case javaCore:
887 if otherLinkType != javaCore {
888 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 +0900889 ctx.OtherModuleName(to))
890 }
Jiyong Park2d492942018-03-05 17:44:10 +0900891 break
892 case javaSdk:
893 if otherLinkType != javaCore && otherLinkType != javaSdk {
894 ctx.ModuleErrorf("compiles against Android API, but dependency %q is compiling against non-public Android API."+commonMessage,
895 ctx.OtherModuleName(to))
896 }
897 break
898 case javaSystem:
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900899 if otherLinkType == javaPlatform || otherLinkType == javaModule || otherLinkType == javaSystemServer {
Jiyong Park2d492942018-03-05 17:44:10 +0900900 ctx.ModuleErrorf("compiles against system API, but dependency %q is compiling against private API."+commonMessage,
901 ctx.OtherModuleName(to))
902 }
903 break
Jiyong Park50146e92020-01-30 18:00:15 +0900904 case javaModule:
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900905 if otherLinkType == javaPlatform || otherLinkType == javaSystemServer {
Jiyong Park50146e92020-01-30 18:00:15 +0900906 ctx.ModuleErrorf("compiles against module API, but dependency %q is compiling against private API."+commonMessage,
907 ctx.OtherModuleName(to))
908 }
909 break
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900910 case javaSystemServer:
911 if otherLinkType == javaPlatform {
912 ctx.ModuleErrorf("compiles against system server API, but dependency %q is compiling against private API."+commonMessage,
913 ctx.OtherModuleName(to))
914 }
915 break
Jiyong Park2d492942018-03-05 17:44:10 +0900916 case javaPlatform:
917 // no restriction on link-type
918 break
Jiyong Park750e5572018-01-31 00:20:13 +0900919 }
920}
921
Colin Cross32f676a2017-09-06 13:41:06 -0700922func (j *Module) collectDeps(ctx android.ModuleContext) deps {
923 var deps deps
Colin Crossfc3674a2017-09-18 17:41:52 -0700924
Colin Cross300f0382018-03-06 13:11:51 -0800925 if ctx.Device() {
Colin Cross83bb3162018-06-25 15:48:06 -0700926 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Cross300f0382018-03-06 13:11:51 -0800927 if sdkDep.invalidVersion {
Colin Cross6cef4812019-10-17 14:23:50 -0700928 ctx.AddMissingDependencies(sdkDep.bootclasspath)
929 ctx.AddMissingDependencies(sdkDep.java9Classpath)
Colin Cross300f0382018-03-06 13:11:51 -0800930 } else if sdkDep.useFiles {
931 // sdkDep.jar is actually equivalent to turbine header.jar.
Colin Cross86a60ae2018-05-29 14:44:55 -0700932 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross3047fa22019-04-18 10:56:44 -0700933 deps.aidlPreprocess = sdkDep.aidl
934 } else {
935 deps.aidlPreprocess = sdkDep.aidl
Colin Cross300f0382018-03-06 13:11:51 -0800936 }
Colin Crossfc3674a2017-09-18 17:41:52 -0700937 }
938
Paul Duffin859fe962020-05-15 10:20:31 +0100939 // If this is a component library (stubs, etc.) for a java_sdk_library then
940 // add the name of that java_sdk_library to the exported sdk libs to make sure
941 // that, if necessary, a <uses-library> element for that java_sdk_library is
942 // added to the Android manifest.
943 j.exportedSdkLibs = append(j.exportedSdkLibs, j.OptionalImplicitSdkLibrary()...)
944
Colin Crossd11fcda2017-10-23 17:59:01 -0700945 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross2fe66872015-03-30 17:20:39 -0700946 otherName := ctx.OtherModuleName(module)
Colin Crossec7a0422017-07-07 14:47:12 -0700947 tag := ctx.OtherModuleDependencyTag(module)
948
Colin Crossa4f08812018-10-02 22:03:40 -0700949 if _, ok := tag.(*jniDependencyTag); ok {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700950 // Handled by AndroidApp.collectAppDeps
951 return
952 }
953 if tag == certificateTag {
954 // Handled by AndroidApp.collectAppDeps
Colin Crossa4f08812018-10-02 22:03:40 -0700955 return
956 }
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100957
Colin Cross54250902017-12-05 09:28:08 -0800958 switch dep := module.(type) {
Colin Cross897d2ed2019-02-11 14:03:51 -0800959 case SdkLibraryDependency:
960 switch tag {
961 case libTag:
962 deps.classpath = append(deps.classpath, dep.SdkHeaderJars(ctx, j.sdkVersion())...)
963 // names of sdk libs that are directly depended are exported
Paul Duffin859fe962020-05-15 10:20:31 +0100964 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.OptionalImplicitSdkLibrary()...)
Colin Cross79c7c262019-04-17 11:11:46 -0700965 case staticLibTag:
Colin Cross897d2ed2019-02-11 14:03:51 -0800966 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
967 }
Colin Cross54250902017-12-05 09:28:08 -0800968 case Dependency:
969 switch tag {
970 case bootClasspathTag:
971 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars()...)
Colin Cross4b964c02018-10-15 16:18:06 -0700972 case libTag, instrumentationForTag:
Colin Cross54250902017-12-05 09:28:08 -0800973 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +0900974 // sdk lib names from dependencies are re-exported
975 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -0700976 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Artur Satayev9cf46692019-11-26 18:08:34 +0000977 pluginJars, pluginClasses := dep.ExportedPlugins()
978 addPlugins(&deps, pluginJars, pluginClasses...)
Colin Cross6cef4812019-10-17 14:23:50 -0700979 case java9LibTag:
980 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars()...)
Colin Cross54250902017-12-05 09:28:08 -0800981 case staticLibTag:
982 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
983 deps.staticJars = append(deps.staticJars, dep.ImplementationJars()...)
984 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars()...)
Colin Cross331a1212018-08-15 20:40:52 -0700985 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +0900986 // sdk lib names from dependencies are re-exported
987 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -0700988 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Artur Satayev9cf46692019-11-26 18:08:34 +0000989 pluginJars, pluginClasses := dep.ExportedPlugins()
990 addPlugins(&deps, pluginJars, pluginClasses...)
Colin Crossbe9cdb82019-01-21 21:37:16 -0800991 case pluginTag:
992 if plugin, ok := dep.(*Plugin); ok {
Colin Crossbe9cdb82019-01-21 21:37:16 -0800993 if plugin.pluginProperties.Processor_class != nil {
Artur Satayev9cf46692019-11-26 18:08:34 +0000994 addPlugins(&deps, plugin.ImplementationAndResourcesJars(), *plugin.pluginProperties.Processor_class)
995 } else {
996 addPlugins(&deps, plugin.ImplementationAndResourcesJars())
Colin Crossbe9cdb82019-01-21 21:37:16 -0800997 }
998 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
999 } else {
1000 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
1001 }
Artur Satayev9cf46692019-11-26 18:08:34 +00001002 case exportedPluginTag:
1003 if plugin, ok := dep.(*Plugin); ok {
1004 if plugin.pluginProperties.Generates_api != nil && *plugin.pluginProperties.Generates_api {
1005 ctx.PropertyErrorf("exported_plugins", "Cannot export plugins with generates_api = true, found %v", otherName)
1006 }
1007 j.exportedPluginJars = append(j.exportedPluginJars, plugin.ImplementationAndResourcesJars()...)
1008 if plugin.pluginProperties.Processor_class != nil {
1009 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
1010 }
1011 } else {
1012 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
1013 }
Nan Zhangb2b33de2018-02-23 11:18:47 -08001014 case frameworkApkTag:
1015 if ctx.ModuleName() == "android_stubs_current" ||
1016 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -07001017 ctx.ModuleName() == "android_test_stubs_current" {
Nan Zhangb2b33de2018-02-23 11:18:47 -08001018 // framework stubs.jar need to depend on framework-res.apk, in order to pull the
1019 // resource files out of there for aapt.
1020 //
1021 // Normally the package rule runs aapt, which includes the resource,
1022 // but we're not running that in our package rule so just copy in the
1023 // resource files here.
Colin Cross331a1212018-08-15 20:40:52 -07001024 deps.staticResourceJars = append(deps.staticResourceJars, dep.(*AndroidApp).exportPackage)
Nan Zhangb2b33de2018-02-23 11:18:47 -08001025 }
Colin Cross54250902017-12-05 09:28:08 -08001026 case kotlinStdlibTag:
Colin Cross0b03d972019-05-13 11:06:25 -07001027 deps.kotlinStdlib = append(deps.kotlinStdlib, dep.HeaderJars()...)
Colin Crossafbb1732019-01-17 15:42:52 -08001028 case kotlinAnnotationsTag:
1029 deps.kotlinAnnotations = dep.HeaderJars()
Colin Cross54250902017-12-05 09:28:08 -08001030 }
1031
Colin Cross54250902017-12-05 09:28:08 -08001032 case android.SourceFileProducer:
1033 switch tag {
1034 case libTag:
1035 checkProducesJars(ctx, dep)
1036 deps.classpath = append(deps.classpath, dep.Srcs()...)
1037 case staticLibTag:
1038 checkProducesJars(ctx, dep)
1039 deps.classpath = append(deps.classpath, dep.Srcs()...)
1040 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
1041 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Cross54250902017-12-05 09:28:08 -08001042 }
1043 default:
Colin Crossec7a0422017-07-07 14:47:12 -07001044 switch tag {
Paul Duffin68289b02019-09-20 13:50:52 +01001045 case bootClasspathTag:
1046 // If a system modules dependency has been added to the bootclasspath
1047 // then add its libs to the bootclasspath.
Paul Duffin83a2d962019-11-19 19:44:10 +00001048 sm := module.(SystemModulesProvider)
1049 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars()...)
Paul Duffin68289b02019-09-20 13:50:52 +01001050
Colin Cross1369cdb2017-09-29 17:58:17 -07001051 case systemModulesTag:
1052 if deps.systemModules != nil {
1053 panic("Found two system module dependencies")
1054 }
Paul Duffin83a2d962019-11-19 19:44:10 +00001055 sm := module.(SystemModulesProvider)
1056 outputDir, outputDeps := sm.OutputDirAndDeps()
1057 deps.systemModules = &systemModules{outputDir, outputDeps}
Colin Cross2fe66872015-03-30 17:20:39 -07001058 }
Colin Crossec7a0422017-07-07 14:47:12 -07001059 }
Colin Cross2fe66872015-03-30 17:20:39 -07001060 })
1061
Jiyong Park1be96912018-05-28 18:02:19 +09001062 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
1063
Colin Cross32f676a2017-09-06 13:41:06 -07001064 return deps
Colin Cross2fe66872015-03-30 17:20:39 -07001065}
1066
Artur Satayev9cf46692019-11-26 18:08:34 +00001067func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
1068 deps.processorPath = append(deps.processorPath, pluginJars...)
1069 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
1070}
1071
Colin Cross1e743852019-10-28 11:37:20 -07001072func getJavaVersion(ctx android.ModuleContext, javaVersion string, sdkContext sdkContext) javaVersion {
Nan Zhang357466b2018-04-17 17:38:36 -07001073 if javaVersion != "" {
Colin Cross1e743852019-10-28 11:37:20 -07001074 return normalizeJavaVersion(ctx, javaVersion)
Colin Cross17dec172020-05-14 18:05:32 -07001075 } else if ctx.Device() {
1076 return sdkContext.sdkVersion().defaultJavaLanguageVersion(ctx)
Nan Zhang357466b2018-04-17 17:38:36 -07001077 } else {
Colin Cross1e743852019-10-28 11:37:20 -07001078 return JAVA_VERSION_9
Nan Zhang357466b2018-04-17 17:38:36 -07001079 }
Nan Zhang357466b2018-04-17 17:38:36 -07001080}
1081
Colin Cross1e743852019-10-28 11:37:20 -07001082type javaVersion int
1083
1084const (
1085 JAVA_VERSION_UNSUPPORTED = 0
1086 JAVA_VERSION_6 = 6
1087 JAVA_VERSION_7 = 7
1088 JAVA_VERSION_8 = 8
1089 JAVA_VERSION_9 = 9
1090)
1091
1092func (v javaVersion) String() string {
1093 switch v {
1094 case JAVA_VERSION_6:
1095 return "1.6"
1096 case JAVA_VERSION_7:
1097 return "1.7"
1098 case JAVA_VERSION_8:
1099 return "1.8"
1100 case JAVA_VERSION_9:
1101 return "1.9"
1102 default:
1103 return "unsupported"
1104 }
1105}
1106
1107// Returns true if javac targeting this version uses system modules instead of a bootclasspath.
1108func (v javaVersion) usesJavaModules() bool {
1109 return v >= 9
1110}
1111
1112func normalizeJavaVersion(ctx android.BaseModuleContext, javaVersion string) javaVersion {
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001113 switch javaVersion {
1114 case "1.6", "6":
Colin Cross1e743852019-10-28 11:37:20 -07001115 return JAVA_VERSION_6
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001116 case "1.7", "7":
Colin Cross1e743852019-10-28 11:37:20 -07001117 return JAVA_VERSION_7
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001118 case "1.8", "8":
Colin Cross1e743852019-10-28 11:37:20 -07001119 return JAVA_VERSION_8
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001120 case "1.9", "9":
Colin Cross1e743852019-10-28 11:37:20 -07001121 return JAVA_VERSION_9
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001122 case "10", "11":
1123 ctx.PropertyErrorf("java_version", "Java language levels above 9 are not supported")
Colin Cross1e743852019-10-28 11:37:20 -07001124 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001125 default:
1126 ctx.PropertyErrorf("java_version", "Unrecognized Java language level")
Colin Cross1e743852019-10-28 11:37:20 -07001127 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001128 }
1129}
1130
Nan Zhanged19fc32017-10-19 13:06:22 -07001131func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
Colin Crossc0b06f12015-04-08 13:03:43 -07001132
Colin Crossf03c82b2015-04-13 13:53:40 -07001133 var flags javaBuilderFlags
1134
Tobias Thierer06dd04f2018-09-11 16:21:05 +01001135 // javaVersion flag.
1136 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), sdkContext(j))
1137
Nan Zhanged19fc32017-10-19 13:06:22 -07001138 // javac flags.
Colin Crossf03c82b2015-04-13 13:53:40 -07001139 javacFlags := j.properties.Javacflags
Colin Cross1e743852019-10-28 11:37:20 -07001140 if flags.javaVersion.usesJavaModules() {
Colin Cross1369cdb2017-09-29 17:58:17 -07001141 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Nan Zhanged19fc32017-10-19 13:06:22 -07001142 }
Colin Cross6510f912017-11-29 00:27:14 -08001143 if ctx.Config().MinimizeJavaDebugInfo() {
Colin Cross126a25c2017-10-31 13:55:34 -07001144 // Override the -g flag passed globally to remove local variable debug info to reduce
1145 // disk and memory usage.
1146 javacFlags = append(javacFlags, "-g:source,lines")
1147 }
Colin Crossc228a702019-11-06 16:18:05 -08001148 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
Colin Cross64162712017-08-08 13:17:59 -07001149
Colin Cross66548102018-06-19 22:47:35 -07001150 if ctx.Config().RunErrorProne() {
1151 if config.ErrorProneClasspath == nil {
1152 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1153 }
1154
1155 errorProneFlags := []string{
1156 "-Xplugin:ErrorProne",
1157 "${config.ErrorProneChecks}",
1158 }
1159 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1160
1161 flags.errorProneExtraJavacFlags = "${config.ErrorProneFlags} " +
1162 "'" + strings.Join(errorProneFlags, " ") + "'"
1163 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
Andreas Gampef3e5b552018-01-22 21:27:21 -08001164 }
1165
Nan Zhanged19fc32017-10-19 13:06:22 -07001166 // classpath
Nan Zhang581fd212018-01-10 16:06:12 -08001167 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1168 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross6cef4812019-10-17 14:23:50 -07001169 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
Colin Cross6a77c982018-06-19 22:43:34 -07001170 flags.processorPath = append(flags.processorPath, deps.processorPath...)
Colin Cross7fdd2b72018-01-02 18:14:25 -08001171
Colin Cross5a116862020-04-22 11:44:34 -07001172 flags.processors = append(flags.processors, deps.processorClasses...)
1173 flags.processors = android.FirstUniqueStrings(flags.processors)
Colin Crossbe9cdb82019-01-21 21:37:16 -08001174
Colin Cross1e743852019-10-28 11:37:20 -07001175 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
1176 decodeSdkDep(ctx, sdkContext(j)).hasStandardLibs() {
Colin Cross7fdd2b72018-01-02 18:14:25 -08001177 // Give host-side tools a version of OpenJDK's standard libraries
1178 // close to what they're targeting. As of Dec 2017, AOSP is only
1179 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1180 //
1181 // When building with OpenJDK 8, the following should have no
1182 // effect since those jars would be available by default.
1183 //
1184 // When building with OpenJDK 9 but targeting a version < 1.8,
1185 // putting them on the bootclasspath means that:
1186 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1187 // b) references to existing APIs are not reinterpreted in an
1188 // OpenJDK 9-specific way, eg. calls to subclasses of
1189 // java.nio.Buffer as in http://b/70862583
1190 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1191 flags.bootClasspath = append(flags.bootClasspath,
1192 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1193 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
Nan Zhang5f8cb422018-02-06 10:34:32 -08001194 if Bool(j.properties.Use_tools_jar) {
1195 flags.bootClasspath = append(flags.bootClasspath,
1196 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1197 }
Colin Cross7fdd2b72018-01-02 18:14:25 -08001198 }
1199
Colin Cross1e743852019-10-28 11:37:20 -07001200 if j.properties.Patch_module != nil && flags.javaVersion.usesJavaModules() {
Jaewoong Jung38e4fb22018-12-12 09:01:34 -08001201 // Manually specify build directory in case it is not under the repo root.
1202 // (javac doesn't seem to expand into symbolc links when searching for patch-module targets, so
1203 // just adding a symlink under the root doesn't help.)
1204 patchPaths := ".:" + ctx.Config().BuildDir()
1205 classPath := flags.classpath.FormJavaClassPath("")
1206 if classPath != "" {
1207 patchPaths += ":" + classPath
1208 }
1209 javacFlags = append(javacFlags, "--patch-module="+String(j.properties.Patch_module)+"="+patchPaths)
Colin Cross81440082018-08-15 20:21:55 -07001210 }
1211
Nan Zhanged19fc32017-10-19 13:06:22 -07001212 // systemModules
Colin Crossb77043e2019-07-16 13:57:13 -07001213 flags.systemModules = deps.systemModules
Colin Cross1369cdb2017-09-29 17:58:17 -07001214
Nan Zhanged19fc32017-10-19 13:06:22 -07001215 // aidl flags.
Colin Cross3047fa22019-04-18 10:56:44 -07001216 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs)
Colin Cross2fe66872015-03-30 17:20:39 -07001217
Colin Cross81440082018-08-15 20:21:55 -07001218 if len(javacFlags) > 0 {
1219 // optimization.
1220 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1221 flags.javacFlags = "$javacFlags"
1222 }
1223
Nan Zhanged19fc32017-10-19 13:06:22 -07001224 return flags
1225}
Colin Crossc0b06f12015-04-08 13:03:43 -07001226
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001227func (j *Module) compile(ctx android.ModuleContext, aaptSrcJar android.Path) {
Colin Crossebe1a512017-11-14 13:12:14 -08001228 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
Nan Zhanged19fc32017-10-19 13:06:22 -07001229
1230 deps := j.collectDeps(ctx)
1231 flags := j.collectBuilderFlags(ctx, deps)
1232
Colin Cross1e743852019-10-28 11:37:20 -07001233 if flags.javaVersion.usesJavaModules() {
Nan Zhanged19fc32017-10-19 13:06:22 -07001234 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
1235 }
Colin Cross8a497952019-03-05 22:25:09 -08001236 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Colin Cross6af17aa2017-09-20 12:59:05 -07001237 if hasSrcExt(srcFiles.Strings(), ".proto") {
Colin Cross0f2ee152017-12-14 15:22:43 -08001238 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
Colin Cross6af17aa2017-09-20 12:59:05 -07001239 }
1240
Colin Crossaf050172017-11-15 23:01:59 -08001241 srcFiles = j.genSources(ctx, srcFiles, flags)
1242
1243 srcJars := srcFiles.FilterByExt(".srcjar")
Colin Cross59149b62017-10-16 18:07:29 -07001244 srcJars = append(srcJars, deps.srcJars...)
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001245 if aaptSrcJar != nil {
1246 srcJars = append(srcJars, aaptSrcJar)
1247 }
Colin Crossb7a63242015-04-16 14:09:14 -07001248
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001249 if j.properties.Jarjar_rules != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001250 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001251 }
1252
Colin Cross1ee23172017-10-18 14:44:18 -07001253 jarName := ctx.ModuleName() + ".jar"
1254
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001255 javaSrcFiles := srcFiles.FilterByExt(".java")
1256 var uniqueSrcFiles android.Paths
1257 set := make(map[string]bool)
1258 for _, v := range javaSrcFiles {
1259 if _, found := set[v.String()]; !found {
1260 set[v.String()] = true
1261 uniqueSrcFiles = append(uniqueSrcFiles, v)
1262 }
1263 }
1264
patricktu242faad2019-09-24 15:41:30 +08001265 // Collect .java files for AIDEGen
1266 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1267
Colin Cross55f63ea2018-08-27 12:37:09 -07001268 var kotlinJars android.Paths
1269
Colin Cross93e85952017-08-15 13:34:18 -07001270 if srcFiles.HasExt(".kt") {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001271 // user defined kotlin flags.
1272 kotlincFlags := j.properties.Kotlincflags
1273 CheckKotlincFlags(ctx, kotlincFlags)
1274
Colin Cross93e85952017-08-15 13:34:18 -07001275 // If there are kotlin files, compile them first but pass all the kotlin and java files
1276 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1277 // won't emit any classes for them.
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001278 kotlincFlags = append(kotlincFlags, "-no-stdlib")
Colin Cross93e85952017-08-15 13:34:18 -07001279 if ctx.Device() {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001280 kotlincFlags = append(kotlincFlags, "-no-jdk")
1281 }
1282 if len(kotlincFlags) > 0 {
1283 // optimization.
1284 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1285 flags.kotlincFlags += "$kotlincFlags"
Colin Cross93e85952017-08-15 13:34:18 -07001286 }
1287
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001288 var kotlinSrcFiles android.Paths
1289 kotlinSrcFiles = append(kotlinSrcFiles, uniqueSrcFiles...)
1290 kotlinSrcFiles = append(kotlinSrcFiles, srcFiles.FilterByExt(".kt")...)
1291
patricktu242faad2019-09-24 15:41:30 +08001292 // Collect .kt files for AIDEGen
1293 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, srcFiles.FilterByExt(".kt").Strings()...)
1294
Colin Crossafbb1732019-01-17 15:42:52 -08001295 flags.classpath = append(flags.classpath, deps.kotlinStdlib...)
1296 flags.classpath = append(flags.classpath, deps.kotlinAnnotations...)
1297
1298 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1299 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1300
1301 if len(flags.processorPath) > 0 {
1302 // Use kapt for annotation processing
1303 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1304 kotlinKapt(ctx, kaptSrcJar, kotlinSrcFiles, srcJars, flags)
1305 srcJars = append(srcJars, kaptSrcJar)
1306 // Disable annotation processing in javac, it's already been handled by kapt
1307 flags.processorPath = nil
Colin Cross5a116862020-04-22 11:44:34 -07001308 flags.processors = nil
Colin Crossafbb1732019-01-17 15:42:52 -08001309 }
Colin Cross93e85952017-08-15 13:34:18 -07001310
Colin Cross1ee23172017-10-18 14:44:18 -07001311 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross21fc9bb2019-01-18 15:05:09 -08001312 kotlinCompile(ctx, kotlinJar, kotlinSrcFiles, srcJars, flags)
Colin Cross93e85952017-08-15 13:34:18 -07001313 if ctx.Failed() {
1314 return
1315 }
1316
1317 // Make javac rule depend on the kotlinc rule
1318 flags.classpath = append(flags.classpath, kotlinJar)
Przemyslaw Szczepaniak66c0c402018-03-08 13:21:55 +00001319
Colin Cross93e85952017-08-15 13:34:18 -07001320 // Jar kotlin classes into the final jar after javac
Colin Cross55f63ea2018-08-27 12:37:09 -07001321 kotlinJars = append(kotlinJars, kotlinJar)
Colin Cross9b38aef2018-08-27 15:42:25 -07001322 kotlinJars = append(kotlinJars, deps.kotlinStdlib...)
Colin Cross93e85952017-08-15 13:34:18 -07001323 }
1324
Colin Cross55f63ea2018-08-27 12:37:09 -07001325 jars := append(android.Paths(nil), kotlinJars...)
1326
Colin Cross5ab4e6d2017-11-22 16:20:45 -08001327 // Store the list of .java files that was passed to javac
1328 j.compiledJavaSrcs = uniqueSrcFiles
1329 j.compiledSrcJars = srcJars
1330
Nan Zhang61eaedb2017-11-02 13:28:15 -07001331 enable_sharding := false
Colin Crossf7d84012020-02-21 08:16:41 -08001332 var headerJarFileWithoutJarjar android.Path
Colin Crossbe9cdb82019-01-21 21:37:16 -08001333 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !deps.disableTurbine {
Nan Zhang61eaedb2017-11-02 13:28:15 -07001334 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1335 enable_sharding = true
Ashley Rosee36efcf2019-01-16 17:34:08 -05001336 // Formerly, there was a check here that prevented annotation processors
1337 // from being used when sharding was enabled, as some annotation processors
1338 // do not function correctly in sharded environments. It was removed to
1339 // allow for the use of annotation processors that do function correctly
1340 // with sharding enabled. See: b/77284273.
Nan Zhang61eaedb2017-11-02 13:28:15 -07001341 }
Colin Crossf7d84012020-02-21 08:16:41 -08001342 headerJarFileWithoutJarjar, j.headerJarFile =
1343 j.compileJavaHeader(ctx, uniqueSrcFiles, srcJars, deps, flags, jarName, kotlinJars)
Colin Crossf19b9bb2018-03-26 14:42:44 -07001344 if ctx.Failed() {
1345 return
Nan Zhanged19fc32017-10-19 13:06:22 -07001346 }
1347 }
Colin Cross8eadbf02017-10-24 17:46:00 -07001348 if len(uniqueSrcFiles) > 0 || len(srcJars) > 0 {
Colin Crossd6891432017-09-27 17:39:56 -07001349 var extraJarDeps android.Paths
Colin Cross66548102018-06-19 22:47:35 -07001350 if ctx.Config().RunErrorProne() {
Colin Crossc6bbef32017-08-14 14:16:06 -07001351 // If error-prone is enabled, add an additional rule to compile the java files into
1352 // a separate set of classes (so that they don't overwrite the normal ones and require
Colin Crossd6891432017-09-27 17:39:56 -07001353 // a rebuild when error-prone is turned off).
Colin Crossc6bbef32017-08-14 14:16:06 -07001354 // TODO(ccross): Once we always compile with javac9 we may be able to conditionally
1355 // enable error-prone without affecting the output class files.
Colin Cross1ee23172017-10-18 14:44:18 -07001356 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001357 RunErrorProne(ctx, errorprone, uniqueSrcFiles, srcJars, flags)
Colin Crossc6bbef32017-08-14 14:16:06 -07001358 extraJarDeps = append(extraJarDeps, errorprone)
1359 }
1360
Nan Zhang61eaedb2017-11-02 13:28:15 -07001361 if enable_sharding {
Colin Crossf7d84012020-02-21 08:16:41 -08001362 flags.classpath = append(flags.classpath, headerJarFileWithoutJarjar)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001363 shardSize := int(*(j.properties.Javac_shard_size))
1364 var shardSrcs []android.Paths
1365 if len(uniqueSrcFiles) > 0 {
Colin Cross0a2f7192019-09-23 14:33:09 -07001366 shardSrcs = android.ShardPaths(uniqueSrcFiles, shardSize)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001367 for idx, shardSrc := range shardSrcs {
Colin Cross3b706fd2019-09-05 16:44:18 -07001368 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1369 nil, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001370 jars = append(jars, classes)
1371 }
1372 }
1373 if len(srcJars) > 0 {
Colin Cross3b706fd2019-09-05 16:44:18 -07001374 classes := j.compileJavaClasses(ctx, jarName, len(shardSrcs),
1375 nil, srcJars, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001376 jars = append(jars, classes)
1377 }
1378 } else {
Colin Cross3b706fd2019-09-05 16:44:18 -07001379 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueSrcFiles, srcJars, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001380 jars = append(jars, classes)
1381 }
Colin Crossd6891432017-09-27 17:39:56 -07001382 if ctx.Failed() {
1383 return
1384 }
Colin Cross2fe66872015-03-30 17:20:39 -07001385 }
1386
Colin Cross0c4ce212019-05-03 15:28:19 -07001387 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1388
1389 var includeSrcJar android.WritablePath
1390 if Bool(j.properties.Include_srcs) {
1391 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1392 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1393 }
1394
Colin Crosscedd4762018-09-13 11:26:19 -07001395 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1396 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
Colin Cross0f37af02017-09-27 17:42:05 -07001397 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
Colin Cross988708c2019-05-06 14:04:11 -07001398 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
Colin Cross0f37af02017-09-27 17:42:05 -07001399
1400 var resArgs []string
1401 var resDeps android.Paths
1402
1403 resArgs = append(resArgs, dirArgs...)
1404 resDeps = append(resDeps, dirDeps...)
1405
1406 resArgs = append(resArgs, fileArgs...)
1407 resDeps = append(resDeps, fileDeps...)
1408
Colin Cross988708c2019-05-06 14:04:11 -07001409 resArgs = append(resArgs, extraArgs...)
1410 resDeps = append(resDeps, extraDeps...)
1411
Colin Cross40a36712017-09-27 17:41:35 -07001412 if len(resArgs) > 0 {
Colin Cross1ee23172017-10-18 14:44:18 -07001413 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
Colin Crosse9a275b2017-10-16 17:09:48 -07001414 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Colin Cross331a1212018-08-15 20:40:52 -07001415 j.resourceJar = resourceJar
Colin Cross65bf4f22015-04-03 16:54:17 -07001416 if ctx.Failed() {
1417 return
1418 }
1419 }
1420
Colin Cross0c4ce212019-05-03 15:28:19 -07001421 var resourceJars android.Paths
1422 if j.resourceJar != nil {
1423 resourceJars = append(resourceJars, j.resourceJar)
1424 }
1425 if Bool(j.properties.Include_srcs) {
1426 resourceJars = append(resourceJars, includeSrcJar)
1427 }
1428 resourceJars = append(resourceJars, deps.staticResourceJars...)
Colin Cross331a1212018-08-15 20:40:52 -07001429
Colin Cross0c4ce212019-05-03 15:28:19 -07001430 if len(resourceJars) > 1 {
Colin Cross331a1212018-08-15 20:40:52 -07001431 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
Colin Cross0c4ce212019-05-03 15:28:19 -07001432 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
Colin Cross331a1212018-08-15 20:40:52 -07001433 false, nil, nil)
1434 j.resourceJar = combinedJar
Colin Cross0c4ce212019-05-03 15:28:19 -07001435 } else if len(resourceJars) == 1 {
1436 j.resourceJar = resourceJars[0]
Colin Cross331a1212018-08-15 20:40:52 -07001437 }
1438
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001439 if len(deps.staticJars) > 0 {
1440 jars = append(jars, deps.staticJars...)
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001441 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001442
Colin Cross094054a2018-10-17 15:10:48 -07001443 manifest := j.overrideManifest
1444 if !manifest.Valid() && j.properties.Manifest != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001445 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Colin Cross366938f2017-12-11 16:29:02 -08001446 }
Colin Cross635acc92017-09-12 22:50:46 -07001447
Colin Cross8a497952019-03-05 22:25:09 -08001448 services := android.PathsForModuleSrc(ctx, j.properties.Services)
Alex Light7f004a72019-02-21 13:27:37 -08001449 if len(services) > 0 {
1450 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1451 var zipargs []string
1452 for _, file := range services {
1453 serviceFile := file.String()
1454 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1455 }
Kousik Kumar366afc52020-05-20 11:27:16 -07001456 rule := zip
1457 args := map[string]string{
1458 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1459 }
1460 if ctx.Config().IsEnvTrue("RBE_ZIP") {
1461 rule = zipRE
1462 args["implicits"] = strings.Join(services.Strings(), ",")
1463 }
Alex Light7f004a72019-02-21 13:27:37 -08001464 ctx.Build(pctx, android.BuildParams{
Kousik Kumar366afc52020-05-20 11:27:16 -07001465 Rule: rule,
Alex Light7f004a72019-02-21 13:27:37 -08001466 Output: servicesJar,
1467 Implicits: services,
Kousik Kumar366afc52020-05-20 11:27:16 -07001468 Args: args,
Alex Light7f004a72019-02-21 13:27:37 -08001469 })
1470 jars = append(jars, servicesJar)
1471 }
1472
Colin Cross0a6e0072017-08-30 14:24:55 -07001473 // Combine the classes built from sources, any manifests, and any static libraries into
Nan Zhanged19fc32017-10-19 13:06:22 -07001474 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross3063b782018-08-15 11:19:12 -07001475 var outputFile android.ModuleOutPath
Colin Crosse9a275b2017-10-16 17:09:48 -07001476
1477 if len(jars) == 1 && !manifest.Valid() {
Colin Cross3063b782018-08-15 11:19:12 -07001478 if moduleOutPath, ok := jars[0].(android.ModuleOutPath); ok {
1479 // Optimization: skip the combine step if there is nothing to do
1480 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1481 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1482 // any if len(jars) == 1.
1483 outputFile = moduleOutPath
1484 } else {
1485 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1486 ctx.Build(pctx, android.BuildParams{
1487 Rule: android.Cp,
1488 Input: jars[0],
1489 Output: combinedJar,
1490 })
1491 outputFile = combinedJar
1492 }
Colin Crosse9a275b2017-10-16 17:09:48 -07001493 } else {
Colin Cross1ee23172017-10-18 14:44:18 -07001494 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001495 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
Colin Cross9b38aef2018-08-27 15:42:25 -07001496 false, nil, nil)
Colin Crosse9a275b2017-10-16 17:09:48 -07001497 outputFile = combinedJar
1498 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001499
Colin Cross331a1212018-08-15 20:40:52 -07001500 // jarjar implementation jar if necessary
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001501 if j.expandJarjarRules != nil {
Colin Cross8649b262017-09-27 18:03:17 -07001502 // Transform classes.jar into classes-jarjar.jar
Colin Cross1ee23172017-10-18 14:44:18 -07001503 jarjarFile := android.PathForModuleOut(ctx, "jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001504 TransformJarJar(ctx, jarjarFile, outputFile, j.expandJarjarRules)
Colin Crosse9a275b2017-10-16 17:09:48 -07001505 outputFile = jarjarFile
Colin Cross331a1212018-08-15 20:40:52 -07001506
1507 // jarjar resource jar if necessary
1508 if j.resourceJar != nil {
1509 resourceJarJarFile := android.PathForModuleOut(ctx, "res-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001510 TransformJarJar(ctx, resourceJarJarFile, j.resourceJar, j.expandJarjarRules)
Colin Cross331a1212018-08-15 20:40:52 -07001511 j.resourceJar = resourceJarJarFile
1512 }
1513
Colin Cross0a6e0072017-08-30 14:24:55 -07001514 if ctx.Failed() {
1515 return
1516 }
1517 }
Vladimir Marko0975ee02019-04-02 10:29:55 +01001518
1519 // Check package restrictions if necessary.
1520 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin91206d92020-06-02 09:52:17 +01001521 // Check packages and copy input to package-checked file.
1522 // Use the file copied after a successful package check as the output file for this
1523 // module so that any dependencies on this module will trigger the package check.
1524 outputFile = CheckJarPackages(ctx, outputFile, j.properties.Permitted_packages)
Vladimir Marko0975ee02019-04-02 10:29:55 +01001525
1526 if ctx.Failed() {
1527 return
1528 }
1529 }
1530
Nan Zhanged19fc32017-10-19 13:06:22 -07001531 j.implementationJarFile = outputFile
1532 if j.headerJarFile == nil {
1533 j.headerJarFile = j.implementationJarFile
1534 }
Colin Cross2fe66872015-03-30 17:20:39 -07001535
Jiyong Park93e57a02020-02-21 16:04:53 +09001536 // Force enable the instrumentation for java code that is built for APEXes ...
1537 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
1538 // doesn't make sense)
1539 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
1540 if android.DirectlyInAnyApex(ctx, ctx.ModuleName()) && !isJacocoAgent && !j.IsForPlatform() {
Jiyong Park00cae1c2020-02-18 12:50:44 +00001541 j.properties.Instrument = true
1542 }
1543
Colin Cross3144dfc2018-01-03 15:06:47 -08001544 if j.shouldInstrument(ctx) {
Colin Crosscb933592017-11-22 13:49:43 -08001545 outputFile = j.instrument(ctx, flags, outputFile, jarName)
1546 }
1547
Colin Cross331a1212018-08-15 20:40:52 -07001548 // merge implementation jar with resources if necessary
1549 implementationAndResourcesJar := outputFile
1550 if j.resourceJar != nil {
Colin Cross08a409d2019-04-29 10:22:44 -07001551 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
Colin Cross331a1212018-08-15 20:40:52 -07001552 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
Colin Cross08a409d2019-04-29 10:22:44 -07001553 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
Colin Cross331a1212018-08-15 20:40:52 -07001554 false, nil, nil)
1555 implementationAndResourcesJar = combinedJar
1556 }
1557
1558 j.implementationAndResourcesJar = implementationAndResourcesJar
1559
Jiyong Park6b21c7d2020-02-11 09:16:01 +09001560 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
1561 if android.DirectlyInAnyApex(ctx, ctx.ModuleName()) && !j.IsForPlatform() {
1562 if j.deviceProperties.Compile_dex == nil {
1563 j.deviceProperties.Compile_dex = proptools.BoolPtr(true)
1564 }
1565 if j.deviceProperties.Hostdex == nil {
1566 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1567 }
1568 }
1569
Jaewoong Jungc27ab662019-05-30 15:51:14 -07001570 if ctx.Device() && j.hasCode(ctx) &&
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001571 (Bool(j.properties.Installable) || Bool(j.deviceProperties.Compile_dex)) {
Colin Cross8faf8fc2019-01-16 15:15:52 -08001572 // Dex compilation
Colin Cross3063b782018-08-15 11:19:12 -07001573 var dexOutputFile android.ModuleOutPath
David Brazdil17ef5632018-06-27 10:27:45 +01001574 dexOutputFile = j.compileDex(ctx, flags, outputFile, jarName)
Colin Cross2fe66872015-03-30 17:20:39 -07001575 if ctx.Failed() {
1576 return
1577 }
Colin Cross331a1212018-08-15 20:40:52 -07001578
Jiyong Park09cb6292019-07-15 15:29:23 +09001579 // Hidden API CSV generation and dex encoding
1580 dexOutputFile = j.hiddenAPI.hiddenAPI(ctx, dexOutputFile, j.implementationJarFile,
David Srbeckye033cba2020-05-20 22:20:28 +01001581 proptools.Bool(j.deviceProperties.Uncompress_dex))
Colin Cross8faf8fc2019-01-16 15:15:52 -08001582
Colin Cross331a1212018-08-15 20:40:52 -07001583 // merge dex jar with resources if necessary
1584 if j.resourceJar != nil {
1585 jars := android.Paths{dexOutputFile, j.resourceJar}
1586 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
1587 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1588 false, nil, nil)
David Srbeckye033cba2020-05-20 22:20:28 +01001589 if *j.deviceProperties.Uncompress_dex {
Nicolas Geoffrayf3438722019-01-23 15:57:21 +00001590 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
1591 TransformZipAlign(ctx, combinedAlignedJar, combinedJar)
1592 dexOutputFile = combinedAlignedJar
1593 } else {
1594 dexOutputFile = combinedJar
1595 }
Colin Cross331a1212018-08-15 20:40:52 -07001596 }
1597
1598 j.dexJarFile = dexOutputFile
1599
Colin Cross8faf8fc2019-01-16 15:15:52 -08001600 // Dexpreopting
Colin Cross43f08db2018-11-12 10:13:39 -08001601 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
1602
1603 j.maybeStrippedDexJarFile = dexOutputFile
1604
Colin Cross3063b782018-08-15 11:19:12 -07001605 outputFile = dexOutputFile
Colin Cross43f08db2018-11-12 10:13:39 -08001606
1607 if ctx.Failed() {
1608 return
1609 }
Colin Cross331a1212018-08-15 20:40:52 -07001610 } else {
1611 outputFile = implementationAndResourcesJar
Colin Cross2fe66872015-03-30 17:20:39 -07001612 }
Colin Cross331a1212018-08-15 20:40:52 -07001613
Colin Crossb7a63242015-04-16 14:09:14 -07001614 ctx.CheckbuildFile(outputFile)
Colin Cross3063b782018-08-15 11:19:12 -07001615
1616 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1617 j.outputFile = outputFile.WithoutRel()
Colin Cross2fe66872015-03-30 17:20:39 -07001618}
1619
Colin Cross3b706fd2019-09-05 16:44:18 -07001620func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
1621 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.WritablePath {
1622
1623 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
1624 if idx >= 0 {
1625 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
1626 jarName += strconv.Itoa(idx)
1627 }
1628
1629 classes := android.PathForModuleOut(ctx, "javac", jarName)
1630 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, flags, extraJarDeps)
1631
1632 if ctx.Config().EmitXrefRules() {
1633 extractionFile := android.PathForModuleOut(ctx, kzipName)
1634 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
1635 j.kytheFiles = append(j.kytheFiles, extractionFile)
1636 }
1637
1638 return classes
1639}
1640
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001641// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1642// since some of these flags may be used internally.
1643func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1644 for _, flag := range flags {
1645 flag = strings.TrimSpace(flag)
1646
1647 if !strings.HasPrefix(flag, "-") {
1648 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1649 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1650 ctx.PropertyErrorf("kotlincflags",
1651 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1652 } else if inList(flag, config.KotlincIllegalFlags) {
1653 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1654 } else if flag == "-include-runtime" {
1655 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1656 } else {
1657 args := strings.Split(flag, " ")
1658 if args[0] == "-kotlin-home" {
1659 ctx.PropertyErrorf("kotlincflags",
1660 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1661 }
1662 }
1663 }
1664}
1665
Colin Cross8eadbf02017-10-24 17:46:00 -07001666func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
Colin Crossf7d84012020-02-21 08:16:41 -08001667 deps deps, flags javaBuilderFlags, jarName string,
1668 extraJars android.Paths) (headerJar, jarjarHeaderJar android.Path) {
Nan Zhanged19fc32017-10-19 13:06:22 -07001669
1670 var jars android.Paths
Colin Cross8eadbf02017-10-24 17:46:00 -07001671 if len(srcFiles) > 0 || len(srcJars) > 0 {
Nan Zhanged19fc32017-10-19 13:06:22 -07001672 // Compile java sources into turbine.jar.
1673 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1674 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
1675 if ctx.Failed() {
Colin Crossf7d84012020-02-21 08:16:41 -08001676 return nil, nil
Nan Zhanged19fc32017-10-19 13:06:22 -07001677 }
1678 jars = append(jars, turbineJar)
1679 }
1680
Colin Cross55f63ea2018-08-27 12:37:09 -07001681 jars = append(jars, extraJars...)
1682
Nan Zhanged19fc32017-10-19 13:06:22 -07001683 // Combine any static header libraries into classes-header.jar. If there is only
1684 // one input jar this step will be skipped.
Nan Zhanged19fc32017-10-19 13:06:22 -07001685 jars = append(jars, deps.staticHeaderJars...)
1686
Colin Cross5c6ecc12017-10-23 18:12:27 -07001687 // we cannot skip the combine step for now if there is only one jar
1688 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
1689 combinedJar := android.PathForModuleOut(ctx, "turbine-combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001690 TransformJarsToJar(ctx, combinedJar, "for turbine", jars, android.OptionalPath{},
Colin Cross6c6e6cd2019-05-08 14:30:12 -07001691 false, nil, []string{"META-INF/TRANSITIVE"})
Colin Cross5c6ecc12017-10-23 18:12:27 -07001692 headerJar = combinedJar
Colin Crossf7d84012020-02-21 08:16:41 -08001693 jarjarHeaderJar = combinedJar
Nan Zhanged19fc32017-10-19 13:06:22 -07001694
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001695 if j.expandJarjarRules != nil {
Nan Zhanged19fc32017-10-19 13:06:22 -07001696 // Transform classes.jar into classes-jarjar.jar
1697 jarjarFile := android.PathForModuleOut(ctx, "turbine-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001698 TransformJarJar(ctx, jarjarFile, headerJar, j.expandJarjarRules)
Colin Crossf7d84012020-02-21 08:16:41 -08001699 jarjarHeaderJar = jarjarFile
Nan Zhanged19fc32017-10-19 13:06:22 -07001700 if ctx.Failed() {
Colin Crossf7d84012020-02-21 08:16:41 -08001701 return nil, nil
Nan Zhanged19fc32017-10-19 13:06:22 -07001702 }
1703 }
1704
Colin Crossf7d84012020-02-21 08:16:41 -08001705 return headerJar, jarjarHeaderJar
Nan Zhanged19fc32017-10-19 13:06:22 -07001706}
1707
Colin Crosscb933592017-11-22 13:49:43 -08001708func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross3063b782018-08-15 11:19:12 -07001709 classesJar android.Path, jarName string) android.ModuleOutPath {
Colin Crosscb933592017-11-22 13:49:43 -08001710
Colin Cross7a3139e2017-12-19 13:57:50 -08001711 specs := j.jacocoModuleToZipCommand(ctx)
Colin Crosscb933592017-11-22 13:49:43 -08001712
Colin Cross84c38822018-01-03 15:59:46 -08001713 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Crosscb933592017-11-22 13:49:43 -08001714 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
1715
1716 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1717
1718 j.jacocoReportClassesFile = jacocoReportClassesFile
1719
1720 return instrumentedJar
1721}
1722
albaltai36ff7dc2018-12-25 14:35:23 +08001723var _ Dependency = (*Module)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07001724
Nan Zhanged19fc32017-10-19 13:06:22 -07001725func (j *Module) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001726 if j.headerJarFile == nil {
1727 return nil
1728 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001729 return android.Paths{j.headerJarFile}
1730}
1731
1732func (j *Module) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08001733 if j.implementationJarFile == nil {
1734 return nil
1735 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001736 return android.Paths{j.implementationJarFile}
Colin Cross2fe66872015-03-30 17:20:39 -07001737}
1738
Ulyana Trafimovichb0dc8512020-06-04 10:37:36 +00001739func (j *Module) DexJar() android.Path {
Colin Crossf24a22a2019-01-31 14:12:44 -08001740 return j.dexJarFile
1741}
1742
Colin Cross331a1212018-08-15 20:40:52 -07001743func (j *Module) ResourceJars() android.Paths {
1744 if j.resourceJar == nil {
1745 return nil
1746 }
1747 return android.Paths{j.resourceJar}
1748}
1749
1750func (j *Module) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001751 if j.implementationAndResourcesJar == nil {
1752 return nil
1753 }
Colin Cross331a1212018-08-15 20:40:52 -07001754 return android.Paths{j.implementationAndResourcesJar}
1755}
1756
Colin Cross46c9b8b2017-06-22 16:51:17 -07001757func (j *Module) AidlIncludeDirs() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001758 // exportAidlIncludeDirs is type android.Paths already
Colin Crossc0b06f12015-04-08 13:03:43 -07001759 return j.exportAidlIncludeDirs
1760}
1761
Jiyong Park1be96912018-05-28 18:02:19 +09001762func (j *Module) ExportedSdkLibs() []string {
albaltai36ff7dc2018-12-25 14:35:23 +08001763 // exportedSdkLibs is type []string
Jiyong Park1be96912018-05-28 18:02:19 +09001764 return j.exportedSdkLibs
1765}
1766
Artur Satayev9cf46692019-11-26 18:08:34 +00001767func (j *Module) ExportedPlugins() (android.Paths, []string) {
1768 return j.exportedPluginJars, j.exportedPluginClasses
1769}
1770
Colin Cross0c4ce212019-05-03 15:28:19 -07001771func (j *Module) SrcJarArgs() ([]string, android.Paths) {
1772 return j.srcJarArgs, j.srcJarDeps
1773}
1774
Colin Cross46c9b8b2017-06-22 16:51:17 -07001775var _ logtagsProducer = (*Module)(nil)
Colin Crossf05fe972015-04-10 17:45:20 -07001776
Colin Cross46c9b8b2017-06-22 16:51:17 -07001777func (j *Module) logtags() android.Paths {
Colin Crossf05fe972015-04-10 17:45:20 -07001778 return j.logtagsSrcs
1779}
1780
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001781// Collect information for opening IDE project files in java/jdeps.go.
1782func (j *Module) IDEInfo(dpInfo *android.IdeInfo) {
1783 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
1784 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
patricktu18c82ff2019-05-10 15:48:50 +08001785 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001786 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001787 if j.expandJarjarRules != nil {
1788 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001789 }
bralee1fbf4402020-05-21 10:11:59 +08001790 dpInfo.Paths = append(dpInfo.Paths, j.modulePaths...)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001791}
1792
1793func (j *Module) CompilerDeps() []string {
1794 jdeps := []string{}
1795 jdeps = append(jdeps, j.properties.Libs...)
1796 jdeps = append(jdeps, j.properties.Static_libs...)
1797 return jdeps
1798}
1799
Jaewoong Jungc27ab662019-05-30 15:51:14 -07001800func (j *Module) hasCode(ctx android.ModuleContext) bool {
1801 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
1802 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
1803}
1804
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09001805func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Paul Duffin0d3c2e12020-05-17 08:34:50 +01001806 return j.depIsInSameApex(ctx, dep)
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09001807}
1808
Jiyong Park0b238752019-10-29 11:23:10 +09001809func (j *Module) Stem() string {
1810 return proptools.StringDefault(j.deviceProperties.Stem, j.Name())
1811}
1812
Jiyong Park618922e2020-01-08 13:35:43 +09001813func (j *Module) JacocoReportClassesFile() android.Path {
1814 return j.jacocoReportClassesFile
1815}
1816
Martin Stjernholm6d415272020-01-31 17:10:36 +00001817func (j *Module) IsInstallable() bool {
1818 return Bool(j.properties.Installable)
1819}
1820
Colin Cross2fe66872015-03-30 17:20:39 -07001821//
1822// Java libraries (.jar file)
1823//
1824
Anton Hansson78156ef2020-03-27 19:39:48 +00001825type LibraryProperties struct {
1826 Dist struct {
1827 // The tag of the output of this module that should be output.
1828 Tag *string `android:"arch_variant"`
1829 } `android:"arch_variant"`
1830}
1831
Colin Crossf506d872017-07-19 15:53:04 -07001832type Library struct {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001833 Module
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001834
Anton Hansson78156ef2020-03-27 19:39:48 +00001835 libraryProperties LibraryProperties
1836
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001837 InstallMixin func(ctx android.ModuleContext, installPath android.Path) (extraInstallDeps android.Paths)
Colin Cross2fe66872015-03-30 17:20:39 -07001838}
1839
Paul Duffine739f1e2020-05-29 11:24:51 +01001840// Provides access to the list of permitted packages from updatable boot jars.
1841type PermittedPackagesForUpdatableBootJars interface {
1842 PermittedPackagesForUpdatableBootJars() []string
1843}
1844
1845var _ PermittedPackagesForUpdatableBootJars = (*Library)(nil)
1846
1847func (j *Library) PermittedPackagesForUpdatableBootJars() []string {
1848 return j.properties.Permitted_packages
1849}
1850
Colin Cross42be7612019-02-21 18:12:14 -08001851func shouldUncompressDex(ctx android.ModuleContext, dexpreopter *dexpreopter) bool {
Ulya Trafimovichf491dde2020-01-24 12:19:45 +00001852 // Store uncompressed (and aligned) any dex files from jars in APEXes.
1853 if am, ok := ctx.Module().(android.ApexModule); ok && !am.IsForPlatform() {
1854 return true
1855 }
1856
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +00001857 // Store uncompressed (and do not strip) dex files from boot class path jars.
1858 if inList(ctx.ModuleName(), ctx.Config().BootJars()) {
1859 return true
1860 }
1861
1862 // Store uncompressed dex files that are preopted on /system.
Colin Cross42be7612019-02-21 18:12:14 -08001863 if !dexpreopter.dexpreoptDisabled(ctx) && (ctx.Host() || !odexOnSystemOther(ctx, dexpreopter.installPath)) {
Vladimir Markoe8b00d62018-12-21 15:54:16 +00001864 return true
1865 }
Colin Cross083a2aa2019-02-06 16:37:12 -08001866 if ctx.Config().UncompressPrivAppDex() &&
1867 inList(ctx.ModuleName(), ctx.Config().ModulesLoadedByPrivilegedModules()) {
1868 return true
1869 }
1870
Colin Cross2fc72f62018-12-21 12:59:54 -08001871 return false
1872}
1873
Colin Crossf506d872017-07-19 15:53:04 -07001874func (j *Library) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Artur Satayev2db1c3f2020-04-08 19:09:30 +01001875 j.checkSdkVersions(ctx)
Jiyong Park0b238752019-10-29 11:23:10 +09001876 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar")
Colin Cross43f08db2018-11-12 10:13:39 -08001877 j.dexpreopter.isSDKLibrary = j.deviceProperties.IsSDKLibrary
David Srbeckye033cba2020-05-20 22:20:28 +01001878 if j.deviceProperties.Uncompress_dex == nil {
1879 // If the value was not force-set by the user, use reasonable default based on the module.
1880 j.deviceProperties.Uncompress_dex = proptools.BoolPtr(shouldUncompressDex(ctx, &j.dexpreopter))
1881 }
1882 j.dexpreopter.uncompressedDex = *j.deviceProperties.Uncompress_dex
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001883 j.compile(ctx, nil)
Colin Crossb7a63242015-04-16 14:09:14 -07001884
bralee1fbf4402020-05-21 10:11:59 +08001885 // Collect the module directory for IDE info in java/jdeps.go.
1886 j.modulePaths = append(j.modulePaths, ctx.ModuleDir())
1887
Jiyong Park7f7766d2019-07-25 22:02:35 +09001888 exclusivelyForApex := android.InAnyApex(ctx.ModuleName()) && !j.IsForPlatform()
1889 if (Bool(j.properties.Installable) || ctx.Host()) && !exclusivelyForApex {
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001890 var extraInstallDeps android.Paths
1891 if j.InstallMixin != nil {
1892 extraInstallDeps = j.InstallMixin(ctx, j.outputFile)
1893 }
Colin Cross2c429dc2017-08-31 16:45:16 -07001894 j.installFile = ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
Jiyong Parka62aa232020-05-28 23:46:55 +09001895 j.Stem()+".jar", j.outputFile, extraInstallDeps...)
Colin Cross2c429dc2017-08-31 16:45:16 -07001896 }
Anton Hansson78156ef2020-03-27 19:39:48 +00001897
1898 // Verify Dist.Tag is set to a supported output
1899 if j.libraryProperties.Dist.Tag != nil {
1900 distFiles, err := j.OutputFiles(*j.libraryProperties.Dist.Tag)
1901 if err != nil {
1902 ctx.PropertyErrorf("dist.tag", "%s", err.Error())
1903 }
1904 j.distFile = distFiles[0]
1905 }
Colin Crossb7a63242015-04-16 14:09:14 -07001906}
1907
Colin Crossf506d872017-07-19 15:53:04 -07001908func (j *Library) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001909 j.deps(ctx)
1910}
1911
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001912const (
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001913 aidlIncludeDir = "aidl"
1914 javaDir = "java"
1915 jarFileSuffix = ".jar"
1916 testConfigSuffix = "-AndroidTest.xml"
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001917)
1918
Paul Duffina0dbf432019-12-05 11:25:53 +00001919// path to the jar file of a java library. Relative to <sdk_root>/<api_dir>
Paul Duffina04c1072020-03-02 10:16:35 +00001920func sdkSnapshotFilePathForJar(osPrefix, name string) string {
1921 return sdkSnapshotFilePathForMember(osPrefix, name, jarFileSuffix)
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001922}
1923
Paul Duffina04c1072020-03-02 10:16:35 +00001924func sdkSnapshotFilePathForMember(osPrefix, name string, suffix string) string {
1925 return filepath.Join(javaDir, osPrefix, name+suffix)
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001926}
1927
Paul Duffin13879572019-11-28 14:31:38 +00001928type librarySdkMemberType struct {
Paul Duffin255f18e2019-12-13 11:22:16 +00001929 android.SdkMemberTypeBase
Paul Duffinf5c0a9c2020-02-28 14:39:53 +00001930
1931 // Function to retrieve the appropriate output jar (implementation or header) from
1932 // the library.
1933 jarToExportGetter func(j *Library) android.Path
Paul Duffin13879572019-11-28 14:31:38 +00001934}
1935
1936func (mt *librarySdkMemberType) AddDependencies(mctx android.BottomUpMutatorContext, dependencyTag blueprint.DependencyTag, names []string) {
1937 mctx.AddVariationDependencies(nil, dependencyTag, names...)
1938}
1939
1940func (mt *librarySdkMemberType) IsInstance(module android.Module) bool {
1941 _, ok := module.(*Library)
1942 return ok
1943}
1944
Paul Duffin3a4eb502020-03-19 16:11:18 +00001945func (mt *librarySdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
1946 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_import")
Paul Duffin14eb4672020-03-02 11:33:02 +00001947}
Paul Duffina0dbf432019-12-05 11:25:53 +00001948
Paul Duffin14eb4672020-03-02 11:33:02 +00001949func (mt *librarySdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
Paul Duffina551a1c2020-03-17 21:04:24 +00001950 return &librarySdkMemberProperties{}
Paul Duffin14eb4672020-03-02 11:33:02 +00001951}
1952
1953type librarySdkMemberProperties struct {
1954 android.SdkMemberPropertiesBase
1955
Paul Duffin864e1b42020-05-06 10:23:19 +01001956 JarToExport android.Path `android:"arch_variant"`
Paul Duffina551a1c2020-03-17 21:04:24 +00001957 AidlIncludeDirs android.Paths
Paul Duffin14eb4672020-03-02 11:33:02 +00001958}
1959
Paul Duffin3a4eb502020-03-19 16:11:18 +00001960func (p *librarySdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffin13879572019-11-28 14:31:38 +00001961 j := variant.(*Library)
1962
Paul Duffina551a1c2020-03-17 21:04:24 +00001963 p.JarToExport = ctx.MemberType().(*librarySdkMemberType).jarToExportGetter(j)
1964 p.AidlIncludeDirs = j.AidlIncludeDirs()
Paul Duffin14eb4672020-03-02 11:33:02 +00001965}
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001966
Paul Duffin3a4eb502020-03-19 16:11:18 +00001967func (p *librarySdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffina551a1c2020-03-17 21:04:24 +00001968 builder := ctx.SnapshotBuilder()
Paul Duffin3a4eb502020-03-19 16:11:18 +00001969
Paul Duffina551a1c2020-03-17 21:04:24 +00001970 exportedJar := p.JarToExport
1971 if exportedJar != nil {
1972 snapshotRelativeJavaLibPath := sdkSnapshotFilePathForJar(p.OsPrefix(), ctx.Name())
Paul Duffin14eb4672020-03-02 11:33:02 +00001973 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
1974
Paul Duffina551a1c2020-03-17 21:04:24 +00001975 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
1976 }
1977
1978 aidlIncludeDirs := p.AidlIncludeDirs
1979 if len(aidlIncludeDirs) != 0 {
1980 sdkModuleContext := ctx.SdkModuleContext()
1981 for _, dir := range aidlIncludeDirs {
Paul Duffin14eb4672020-03-02 11:33:02 +00001982 // TODO(jiyong): copy parcelable declarations only
1983 aidlFiles, _ := sdkModuleContext.GlobWithDeps(dir.String()+"/**/*.aidl", nil)
1984 for _, file := range aidlFiles {
1985 builder.CopyToSnapshot(android.PathForSource(sdkModuleContext, file), filepath.Join(aidlIncludeDir, file))
1986 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001987 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001988
Paul Duffina551a1c2020-03-17 21:04:24 +00001989 // TODO(b/151933053) - add aidl include dirs property
Paul Duffin14eb4672020-03-02 11:33:02 +00001990 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001991}
1992
Paul Duffinf5c0a9c2020-02-28 14:39:53 +00001993var javaHeaderLibsSdkMemberType android.SdkMemberType = &librarySdkMemberType{
1994 android.SdkMemberTypeBase{
1995 PropertyName: "java_header_libs",
1996 SupportsSdk: true,
Paul Duffin7b81f5e2020-01-13 21:03:22 +00001997 },
Paul Duffinf5c0a9c2020-02-28 14:39:53 +00001998 func(j *Library) android.Path {
Paul Duffina0dbf432019-12-05 11:25:53 +00001999 headerJars := j.HeaderJars()
2000 if len(headerJars) != 1 {
2001 panic(fmt.Errorf("there must be only one header jar from %q", j.Name()))
2002 }
2003
2004 return headerJars[0]
Paul Duffinf5c0a9c2020-02-28 14:39:53 +00002005 },
Paul Duffina0dbf432019-12-05 11:25:53 +00002006}
2007
Colin Cross1b16b0e2019-02-12 14:41:32 -08002008// java_library builds and links sources into a `.jar` file for the device, and possibly for the host as well.
2009//
2010// By default, a java_library has a single variant that produces a `.jar` file containing `.class` files that were
2011// compiled against the device bootclasspath. This jar is not suitable for installing on a device, but can be used
2012// as a `static_libs` dependency of another module.
2013//
2014// Specifying `installable: true` will product a `.jar` file containing `classes.dex` files, suitable for installing on
2015// a device.
2016//
2017// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2018// compiled against the host bootclasspath.
Colin Cross9ae1b922018-06-26 17:59:05 -07002019func LibraryFactory() android.Module {
2020 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07002021
Colin Cross9ae1b922018-06-26 17:59:05 -07002022 module.AddProperties(
2023 &module.Module.properties,
2024 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08002025 &module.Module.dexpreoptProperties,
Anton Hansson78156ef2020-03-27 19:39:48 +00002026 &module.Module.protoProperties,
2027 &module.libraryProperties)
Colin Cross2fe66872015-03-30 17:20:39 -07002028
Paul Duffin859fe962020-05-15 10:20:31 +01002029 module.initModuleAndImport(&module.ModuleBase)
2030
Jiyong Park7f7766d2019-07-25 22:02:35 +09002031 android.InitApexModule(module)
Jiyong Parkd1063c12019-07-17 20:08:41 +09002032 android.InitSdkAwareModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002033 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross9ae1b922018-06-26 17:59:05 -07002034 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002035}
2036
Colin Cross1b16b0e2019-02-12 14:41:32 -08002037// java_library_static is an obsolete alias for java_library.
2038func LibraryStaticFactory() android.Module {
2039 return LibraryFactory()
2040}
2041
2042// java_library_host builds and links sources into a `.jar` file for the host.
2043//
2044// A java_library_host has a single variant that produces a `.jar` file containing `.class` files that were
2045// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002046func LibraryHostFactory() android.Module {
2047 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07002048
Colin Cross6af17aa2017-09-20 12:59:05 -07002049 module.AddProperties(
2050 &module.Module.properties,
2051 &module.Module.protoProperties)
Colin Cross36242852017-06-23 15:06:31 -07002052
Colin Cross9ae1b922018-06-26 17:59:05 -07002053 module.Module.properties.Installable = proptools.BoolPtr(true)
2054
Jiyong Park7f7766d2019-07-25 22:02:35 +09002055 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002056 InitJavaModule(module, android.HostSupported)
Colin Cross36242852017-06-23 15:06:31 -07002057 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002058}
2059
2060//
Colin Crossb628ea52018-08-14 16:42:33 -07002061// Java Tests
Colin Cross05638fc2018-04-09 18:40:24 -07002062//
2063
2064type testProperties struct {
Colin Cross05638fc2018-04-09 18:40:24 -07002065 // list of compatibility suites (for example "cts", "vts") that the module should be
2066 // installed into.
2067 Test_suites []string `android:"arch_variant"`
Julien Despreze146e392018-08-02 15:00:46 -07002068
2069 // the name of the test configuration (for example "AndroidTest.xml") that should be
2070 // installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08002071 Test_config *string `android:"path,arch_variant"`
Colin Crossd96ca352018-08-10 16:06:24 -07002072
Jack He33338892018-09-19 02:21:28 -07002073 // the name of the test configuration template (for example "AndroidTestTemplate.xml") that
2074 // should be installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08002075 Test_config_template *string `android:"path,arch_variant"`
Jack He33338892018-09-19 02:21:28 -07002076
Colin Crossd96ca352018-08-10 16:06:24 -07002077 // list of files or filegroup modules that provide data that should be installed alongside
2078 // the test
Colin Cross27b922f2019-03-04 22:35:41 -08002079 Data []string `android:"path"`
Dan Shi6ffaaa82019-09-26 11:41:36 -07002080
2081 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
2082 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
2083 // explicitly.
2084 Auto_gen_config *bool
easoncylee5bcff5d2020-04-30 14:57:06 +08002085
2086 // Add parameterized mainline modules to auto generated test config. The options will be
2087 // handled by TradeFed to do downloading and installing the specified modules on the device.
2088 Test_mainline_modules []string
Colin Cross05638fc2018-04-09 18:40:24 -07002089}
2090
Paul Duffin42df1442019-03-20 12:45:53 +00002091type testHelperLibraryProperties struct {
2092 // list of compatibility suites (for example "cts", "vts") that the module should be
2093 // installed into.
2094 Test_suites []string `android:"arch_variant"`
2095}
2096
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002097type prebuiltTestProperties struct {
2098 // list of compatibility suites (for example "cts", "vts") that the module should be
2099 // installed into.
2100 Test_suites []string `android:"arch_variant"`
2101
2102 // the name of the test configuration (for example "AndroidTest.xml") that should be
2103 // installed with the module.
2104 Test_config *string `android:"path,arch_variant"`
2105}
2106
Colin Cross05638fc2018-04-09 18:40:24 -07002107type Test struct {
2108 Library
2109
2110 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07002111
2112 testConfig android.Path
Colin Crossd96ca352018-08-10 16:06:24 -07002113 data android.Paths
Colin Cross303e21f2018-08-07 16:49:25 -07002114}
2115
Paul Duffin42df1442019-03-20 12:45:53 +00002116type TestHelperLibrary struct {
2117 Library
2118
2119 testHelperLibraryProperties testHelperLibraryProperties
2120}
2121
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002122type JavaTestImport struct {
2123 Import
2124
2125 prebuiltTestProperties prebuiltTestProperties
2126
2127 testConfig android.Path
2128}
2129
Colin Cross303e21f2018-08-07 16:49:25 -07002130func (j *Test) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Dan Shi6ffaaa82019-09-26 11:41:36 -07002131 j.testConfig = tradefed.AutoGenJavaTestConfig(ctx, j.testProperties.Test_config, j.testProperties.Test_config_template,
2132 j.testProperties.Test_suites, j.testProperties.Auto_gen_config)
Colin Cross8a497952019-03-05 22:25:09 -08002133 j.data = android.PathsForModuleSrc(ctx, j.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07002134
2135 j.Library.GenerateAndroidBuildActions(ctx)
Colin Cross05638fc2018-04-09 18:40:24 -07002136}
2137
Paul Duffin42df1442019-03-20 12:45:53 +00002138func (j *TestHelperLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2139 j.Library.GenerateAndroidBuildActions(ctx)
2140}
2141
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002142func (j *JavaTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2143 j.testConfig = tradefed.AutoGenJavaTestConfig(ctx, j.prebuiltTestProperties.Test_config, nil,
2144 j.prebuiltTestProperties.Test_suites, nil)
2145
2146 j.Import.GenerateAndroidBuildActions(ctx)
2147}
2148
2149type testSdkMemberType struct {
2150 android.SdkMemberTypeBase
2151}
2152
2153func (mt *testSdkMemberType) AddDependencies(mctx android.BottomUpMutatorContext, dependencyTag blueprint.DependencyTag, names []string) {
2154 mctx.AddVariationDependencies(nil, dependencyTag, names...)
2155}
2156
2157func (mt *testSdkMemberType) IsInstance(module android.Module) bool {
2158 _, ok := module.(*Test)
2159 return ok
2160}
2161
Paul Duffin3a4eb502020-03-19 16:11:18 +00002162func (mt *testSdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
2163 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_test_import")
Paul Duffin14eb4672020-03-02 11:33:02 +00002164}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002165
Paul Duffin14eb4672020-03-02 11:33:02 +00002166func (mt *testSdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
2167 return &testSdkMemberProperties{}
2168}
2169
2170type testSdkMemberProperties struct {
2171 android.SdkMemberPropertiesBase
2172
Paul Duffina551a1c2020-03-17 21:04:24 +00002173 JarToExport android.Path
2174 TestConfig android.Path
Paul Duffin14eb4672020-03-02 11:33:02 +00002175}
2176
Paul Duffin3a4eb502020-03-19 16:11:18 +00002177func (p *testSdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffin14eb4672020-03-02 11:33:02 +00002178 test := variant.(*Test)
2179
2180 implementationJars := test.ImplementationJars()
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002181 if len(implementationJars) != 1 {
Paul Duffin14eb4672020-03-02 11:33:02 +00002182 panic(fmt.Errorf("there must be only one implementation jar from %q", test.Name()))
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002183 }
2184
Paul Duffina551a1c2020-03-17 21:04:24 +00002185 p.JarToExport = implementationJars[0]
2186 p.TestConfig = test.testConfig
Paul Duffin14eb4672020-03-02 11:33:02 +00002187}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002188
Paul Duffin3a4eb502020-03-19 16:11:18 +00002189func (p *testSdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffina551a1c2020-03-17 21:04:24 +00002190 builder := ctx.SnapshotBuilder()
Paul Duffin3a4eb502020-03-19 16:11:18 +00002191
Paul Duffina551a1c2020-03-17 21:04:24 +00002192 exportedJar := p.JarToExport
2193 if exportedJar != nil {
2194 snapshotRelativeJavaLibPath := sdkSnapshotFilePathForJar(p.OsPrefix(), ctx.Name())
2195 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
Paul Duffin14eb4672020-03-02 11:33:02 +00002196
2197 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
Paul Duffina551a1c2020-03-17 21:04:24 +00002198 }
2199
2200 testConfig := p.TestConfig
2201 if testConfig != nil {
2202 snapshotRelativeTestConfigPath := sdkSnapshotFilePathForMember(p.OsPrefix(), ctx.Name(), testConfigSuffix)
2203 builder.CopyToSnapshot(testConfig, snapshotRelativeTestConfigPath)
Paul Duffin14eb4672020-03-02 11:33:02 +00002204 propertySet.AddProperty("test_config", snapshotRelativeTestConfigPath)
2205 }
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002206}
2207
Colin Cross1b16b0e2019-02-12 14:41:32 -08002208// java_test builds a and links sources into a `.jar` file for the device, and possibly for the host as well, and
2209// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
2210//
2211// By default, a java_test has a single variant that produces a `.jar` file containing `classes.dex` files that were
2212// compiled against the device bootclasspath.
2213//
2214// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2215// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07002216func TestFactory() android.Module {
2217 module := &Test{}
2218
2219 module.AddProperties(
2220 &module.Module.properties,
2221 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08002222 &module.Module.dexpreoptProperties,
Colin Cross05638fc2018-04-09 18:40:24 -07002223 &module.Module.protoProperties,
2224 &module.testProperties)
2225
Colin Cross9ae1b922018-06-26 17:59:05 -07002226 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse3026872019-01-05 22:30:13 -08002227 module.Module.dexpreopter.isTest = true
Colin Cross9ae1b922018-06-26 17:59:05 -07002228
Colin Cross05638fc2018-04-09 18:40:24 -07002229 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07002230 return module
2231}
2232
Paul Duffin42df1442019-03-20 12:45:53 +00002233// java_test_helper_library creates a java library and makes sure that it is added to the appropriate test suite.
2234func TestHelperLibraryFactory() android.Module {
2235 module := &TestHelperLibrary{}
2236
2237 module.AddProperties(
2238 &module.Module.properties,
2239 &module.Module.deviceProperties,
2240 &module.Module.dexpreoptProperties,
2241 &module.Module.protoProperties,
2242 &module.testHelperLibraryProperties)
2243
Colin Cross9a4abed2019-04-24 13:19:28 -07002244 module.Module.properties.Installable = proptools.BoolPtr(true)
2245 module.Module.dexpreopter.isTest = true
2246
Paul Duffin42df1442019-03-20 12:45:53 +00002247 InitJavaModule(module, android.HostAndDeviceSupported)
2248 return module
2249}
2250
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002251// java_test_import imports one or more `.jar` files into the build graph as if they were built by a java_test module
2252// and makes sure that it is added to the appropriate test suite.
2253//
2254// By default, a java_test_import has a single variant that expects a `.jar` file containing `.class` files that were
2255// compiled against an Android classpath.
2256//
2257// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
2258// for host modules.
2259func JavaTestImportFactory() android.Module {
2260 module := &JavaTestImport{}
2261
2262 module.AddProperties(
2263 &module.Import.properties,
2264 &module.prebuiltTestProperties)
2265
2266 module.Import.properties.Installable = proptools.BoolPtr(true)
2267
2268 android.InitPrebuiltModule(module, &module.properties.Jars)
2269 android.InitApexModule(module)
2270 android.InitSdkAwareModule(module)
2271 InitJavaModule(module, android.HostAndDeviceSupported)
2272 return module
2273}
2274
Colin Cross1b16b0e2019-02-12 14:41:32 -08002275// java_test_host builds a and links sources into a `.jar` file for the host, and creates an `AndroidTest.xml` file to
2276// allow running the test with `atest` or a `TEST_MAPPING` file.
2277//
2278// A java_test_host has a single variant that produces a `.jar` file containing `.class` files that were
2279// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07002280func TestHostFactory() android.Module {
2281 module := &Test{}
2282
2283 module.AddProperties(
2284 &module.Module.properties,
2285 &module.Module.protoProperties,
2286 &module.testProperties)
2287
Colin Cross9ae1b922018-06-26 17:59:05 -07002288 module.Module.properties.Installable = proptools.BoolPtr(true)
2289
Colin Cross05638fc2018-04-09 18:40:24 -07002290 InitJavaModule(module, android.HostSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07002291 return module
2292}
2293
2294//
Colin Cross2fe66872015-03-30 17:20:39 -07002295// Java Binaries (.jar file plus wrapper script)
2296//
2297
Colin Crossf506d872017-07-19 15:53:04 -07002298type binaryProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -07002299 // installable script to execute the resulting jar
Colin Cross27b922f2019-03-04 22:35:41 -08002300 Wrapper *string `android:"path"`
Colin Cross094054a2018-10-17 15:10:48 -07002301
2302 // Name of the class containing main to be inserted into the manifest as Main-Class.
2303 Main_class *string
Colin Cross7d5136f2015-05-11 13:39:40 -07002304}
2305
Colin Crossf506d872017-07-19 15:53:04 -07002306type Binary struct {
2307 Library
Colin Cross2fe66872015-03-30 17:20:39 -07002308
Colin Crossf506d872017-07-19 15:53:04 -07002309 binaryProperties binaryProperties
Colin Cross10a03492017-08-10 17:09:43 -07002310
Colin Cross6b4a32d2017-12-05 13:42:45 -08002311 isWrapperVariant bool
2312
Colin Crossc3315992017-12-08 19:12:36 -08002313 wrapperFile android.Path
Colin Cross70dda7e2019-10-01 22:05:35 -07002314 binaryFile android.InstallPath
Colin Cross2fe66872015-03-30 17:20:39 -07002315}
2316
Alex Light24237172017-10-26 09:46:21 -07002317func (j *Binary) HostToolPath() android.OptionalPath {
2318 return android.OptionalPathForPath(j.binaryFile)
2319}
2320
Colin Crossf506d872017-07-19 15:53:04 -07002321func (j *Binary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002322 if ctx.Arch().ArchType == android.Common {
2323 // Compile the jar
Colin Cross094054a2018-10-17 15:10:48 -07002324 if j.binaryProperties.Main_class != nil {
2325 if j.properties.Manifest != nil {
2326 ctx.PropertyErrorf("main_class", "main_class cannot be used when manifest is set")
2327 }
2328 manifestFile := android.PathForModuleOut(ctx, "manifest.txt")
2329 GenerateMainClassManifest(ctx, manifestFile, String(j.binaryProperties.Main_class))
2330 j.overrideManifest = android.OptionalPathForPath(manifestFile)
2331 }
2332
Colin Cross6b4a32d2017-12-05 13:42:45 -08002333 j.Library.GenerateAndroidBuildActions(ctx)
Nan Zhang3c807db2017-11-03 14:53:31 -07002334 } else {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002335 // Handle the binary wrapper
2336 j.isWrapperVariant = true
2337
Colin Cross366938f2017-12-11 16:29:02 -08002338 if j.binaryProperties.Wrapper != nil {
Colin Cross8a497952019-03-05 22:25:09 -08002339 j.wrapperFile = android.PathForModuleSrc(ctx, *j.binaryProperties.Wrapper)
Colin Cross6b4a32d2017-12-05 13:42:45 -08002340 } else {
2341 j.wrapperFile = android.PathForSource(ctx, "build/soong/scripts/jar-wrapper.sh")
2342 }
2343
2344 // Depend on the installed jar so that the wrapper doesn't get executed by
2345 // another build rule before the jar has been installed.
2346 jarFile := ctx.PrimaryModule().(*Binary).installFile
2347
2348 j.binaryFile = ctx.InstallExecutable(android.PathForModuleInstall(ctx, "bin"),
2349 ctx.ModuleName(), j.wrapperFile, jarFile)
Nan Zhang3c807db2017-11-03 14:53:31 -07002350 }
Colin Cross2fe66872015-03-30 17:20:39 -07002351}
2352
Colin Crossf506d872017-07-19 15:53:04 -07002353func (j *Binary) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002354 if ctx.Arch().ArchType == android.Common {
2355 j.deps(ctx)
2356 }
Colin Cross46c9b8b2017-06-22 16:51:17 -07002357}
2358
Colin Cross1b16b0e2019-02-12 14:41:32 -08002359// java_binary builds a `.jar` file and a shell script that executes it for the device, and possibly for the host
2360// as well.
2361//
2362// By default, a java_binary has a single variant that produces a `.jar` file containing `classes.dex` files that were
2363// compiled against the device bootclasspath.
2364//
2365// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2366// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002367func BinaryFactory() android.Module {
2368 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07002369
Colin Cross36242852017-06-23 15:06:31 -07002370 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -07002371 &module.Module.properties,
2372 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08002373 &module.Module.dexpreoptProperties,
Colin Cross6af17aa2017-09-20 12:59:05 -07002374 &module.Module.protoProperties,
Colin Cross540eff82017-06-22 17:01:52 -07002375 &module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07002376
Colin Cross9ae1b922018-06-26 17:59:05 -07002377 module.Module.properties.Installable = proptools.BoolPtr(true)
2378
Colin Cross6b4a32d2017-12-05 13:42:45 -08002379 android.InitAndroidArchModule(module, android.HostAndDeviceSupported, android.MultilibCommonFirst)
2380 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07002381 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002382}
2383
Colin Cross1b16b0e2019-02-12 14:41:32 -08002384// java_binary_host builds a `.jar` file and a shell script that executes it for the host.
2385//
2386// A java_binary_host has a single variant that produces a `.jar` file containing `.class` files that were
2387// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002388func BinaryHostFactory() android.Module {
2389 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07002390
Colin Cross36242852017-06-23 15:06:31 -07002391 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -07002392 &module.Module.properties,
Colin Cross6af17aa2017-09-20 12:59:05 -07002393 &module.Module.protoProperties,
Colin Cross540eff82017-06-22 17:01:52 -07002394 &module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07002395
Colin Cross9ae1b922018-06-26 17:59:05 -07002396 module.Module.properties.Installable = proptools.BoolPtr(true)
2397
Colin Cross6b4a32d2017-12-05 13:42:45 -08002398 android.InitAndroidArchModule(module, android.HostSupported, android.MultilibCommonFirst)
2399 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07002400 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002401}
2402
2403//
2404// Java prebuilts
2405//
2406
Colin Cross74d73e22017-08-02 11:05:49 -07002407type ImportProperties struct {
Paul Duffina04c1072020-03-02 10:16:35 +00002408 Jars []string `android:"path,arch_variant"`
Colin Cross461bd1a2017-10-20 13:59:18 -07002409
Nan Zhangea568a42017-11-08 21:20:04 -08002410 Sdk_version *string
Colin Cross535e2cf2017-10-20 17:57:49 -07002411
2412 Installable *bool
Jiyong Park1be96912018-05-28 18:02:19 +09002413
2414 // List of shared java libs that this module has dependencies to
2415 Libs []string
Colin Cross37f6d792018-07-12 12:28:41 -07002416
2417 // List of files to remove from the jar file(s)
2418 Exclude_files []string
2419
2420 // List of directories to remove from the jar file(s)
2421 Exclude_dirs []string
Nan Zhang4c819fb2018-08-27 18:31:46 -07002422
2423 // if set to true, run Jetifier against .jar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -07002424 Jetifier *bool
Jiyong Park4c4c0242019-10-21 14:53:15 +09002425
2426 // set the name of the output
2427 Stem *string
Jiyong Park19604de2020-03-24 16:44:11 +09002428
2429 Aidl struct {
2430 // directories that should be added as include directories for any aidl sources of modules
2431 // that depend on this module, as well as to aidl for this module.
2432 Export_include_dirs []string
2433 }
Colin Cross74d73e22017-08-02 11:05:49 -07002434}
2435
2436type Import struct {
Colin Cross635c3b02016-05-18 15:37:25 -07002437 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -07002438 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002439 android.ApexModuleBase
Colin Crossec7a0422017-07-07 14:47:12 -07002440 prebuilt android.Prebuilt
Jiyong Parkd1063c12019-07-17 20:08:41 +09002441 android.SdkBase
Colin Cross2fe66872015-03-30 17:20:39 -07002442
Paul Duffin0d3c2e12020-05-17 08:34:50 +01002443 // Functionality common to Module and Import.
2444 embeddableInModuleAndImport
2445
Colin Cross74d73e22017-08-02 11:05:49 -07002446 properties ImportProperties
2447
Colin Cross0a6e0072017-08-30 14:24:55 -07002448 combinedClasspathFile android.Path
Jiyong Park1be96912018-05-28 18:02:19 +09002449 exportedSdkLibs []string
Jiyong Park19604de2020-03-24 16:44:11 +09002450 exportAidlIncludeDirs android.Paths
Colin Cross2fe66872015-03-30 17:20:39 -07002451}
2452
Jiyong Park6a927c42020-01-21 02:03:43 +09002453func (j *Import) sdkVersion() sdkSpec {
2454 return sdkSpecFrom(String(j.properties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -07002455}
2456
Jiyong Park6a927c42020-01-21 02:03:43 +09002457func (j *Import) minSdkVersion() sdkSpec {
Colin Cross83bb3162018-06-25 15:48:06 -07002458 return j.sdkVersion()
2459}
2460
Artur Satayev480e25b2020-04-27 18:53:18 +01002461func (j *Import) MinSdkVersion() string {
2462 return j.minSdkVersion().version.String()
2463}
2464
Colin Cross74d73e22017-08-02 11:05:49 -07002465func (j *Import) Prebuilt() *android.Prebuilt {
Colin Crossec7a0422017-07-07 14:47:12 -07002466 return &j.prebuilt
2467}
2468
Colin Cross74d73e22017-08-02 11:05:49 -07002469func (j *Import) PrebuiltSrcs() []string {
2470 return j.properties.Jars
2471}
2472
2473func (j *Import) Name() string {
Colin Cross5ea9bcc2017-07-27 15:41:32 -07002474 return j.prebuilt.Name(j.ModuleBase.Name())
2475}
2476
Jiyong Park0b238752019-10-29 11:23:10 +09002477func (j *Import) Stem() string {
2478 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
2479}
2480
Jiyong Park618922e2020-01-08 13:35:43 +09002481func (a *Import) JacocoReportClassesFile() android.Path {
2482 return nil
2483}
2484
Colin Cross74d73e22017-08-02 11:05:49 -07002485func (j *Import) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross42d48b72018-08-29 14:10:52 -07002486 ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Colin Cross1e676be2016-10-12 14:38:15 -07002487}
2488
Colin Cross74d73e22017-08-02 11:05:49 -07002489func (j *Import) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross8a497952019-03-05 22:25:09 -08002490 jars := android.PathsForModuleSrc(ctx, j.properties.Jars)
Colin Crosse1d62a82015-04-03 16:53:05 -07002491
Jiyong Park0b238752019-10-29 11:23:10 +09002492 jarName := j.Stem() + ".jar"
Nan Zhang4c819fb2018-08-27 18:31:46 -07002493 outputFile := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07002494 TransformJarsToJar(ctx, outputFile, "for prebuilts", jars, android.OptionalPath{},
2495 false, j.properties.Exclude_files, j.properties.Exclude_dirs)
Colin Cross1001a792019-03-21 22:21:39 -07002496 if Bool(j.properties.Jetifier) {
Nan Zhang4c819fb2018-08-27 18:31:46 -07002497 inputFile := outputFile
2498 outputFile = android.PathForModuleOut(ctx, "jetifier", jarName)
2499 TransformJetifier(ctx, outputFile, inputFile)
2500 }
Colin Crosse9a275b2017-10-16 17:09:48 -07002501 j.combinedClasspathFile = outputFile
Jiyong Park1be96912018-05-28 18:02:19 +09002502
Paul Duffin859fe962020-05-15 10:20:31 +01002503 // If this is a component library (impl, stubs, etc.) for a java_sdk_library then
2504 // add the name of that java_sdk_library to the exported sdk libs to make sure
2505 // that, if necessary, a <uses-library> element for that java_sdk_library is
2506 // added to the Android manifest.
2507 j.exportedSdkLibs = append(j.exportedSdkLibs, j.OptionalImplicitSdkLibrary()...)
2508
Jiyong Park1be96912018-05-28 18:02:19 +09002509 ctx.VisitDirectDeps(func(module android.Module) {
2510 otherName := ctx.OtherModuleName(module)
2511 tag := ctx.OtherModuleDependencyTag(module)
2512
2513 switch dep := module.(type) {
2514 case Dependency:
2515 switch tag {
2516 case libTag, staticLibTag:
2517 // sdk lib names from dependencies are re-exported
2518 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
2519 }
2520 case SdkLibraryDependency:
2521 switch tag {
2522 case libTag:
2523 // names of sdk libs that are directly depended are exported
2524 j.exportedSdkLibs = append(j.exportedSdkLibs, otherName)
2525 }
2526 }
2527 })
2528
2529 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
Nan Zhang4973ecf2018-08-10 13:42:12 -07002530 if Bool(j.properties.Installable) {
2531 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
Jiyong Park4c4c0242019-10-21 14:53:15 +09002532 jarName, outputFile)
Nan Zhang4973ecf2018-08-10 13:42:12 -07002533 }
Jiyong Park19604de2020-03-24 16:44:11 +09002534
2535 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.properties.Aidl.Export_include_dirs)
Colin Cross2fe66872015-03-30 17:20:39 -07002536}
2537
Colin Cross74d73e22017-08-02 11:05:49 -07002538var _ Dependency = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07002539
Nan Zhanged19fc32017-10-19 13:06:22 -07002540func (j *Import) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002541 if j.combinedClasspathFile == nil {
2542 return nil
2543 }
Colin Cross37f6d792018-07-12 12:28:41 -07002544 return android.Paths{j.combinedClasspathFile}
Nan Zhanged19fc32017-10-19 13:06:22 -07002545}
2546
2547func (j *Import) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08002548 if j.combinedClasspathFile == nil {
2549 return nil
2550 }
Colin Cross37f6d792018-07-12 12:28:41 -07002551 return android.Paths{j.combinedClasspathFile}
Colin Cross2fe66872015-03-30 17:20:39 -07002552}
2553
Colin Cross331a1212018-08-15 20:40:52 -07002554func (j *Import) ResourceJars() android.Paths {
2555 return nil
2556}
2557
2558func (j *Import) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002559 if j.combinedClasspathFile == nil {
2560 return nil
2561 }
Colin Cross331a1212018-08-15 20:40:52 -07002562 return android.Paths{j.combinedClasspathFile}
2563}
2564
Ulyana Trafimovichb0dc8512020-06-04 10:37:36 +00002565func (j *Import) DexJar() android.Path {
Colin Crossf24a22a2019-01-31 14:12:44 -08002566 return nil
2567}
2568
Colin Cross74d73e22017-08-02 11:05:49 -07002569func (j *Import) AidlIncludeDirs() android.Paths {
Jiyong Park19604de2020-03-24 16:44:11 +09002570 return j.exportAidlIncludeDirs
Colin Crossc0b06f12015-04-08 13:03:43 -07002571}
2572
Jiyong Park1be96912018-05-28 18:02:19 +09002573func (j *Import) ExportedSdkLibs() []string {
2574 return j.exportedSdkLibs
2575}
2576
Artur Satayev9cf46692019-11-26 18:08:34 +00002577func (j *Import) ExportedPlugins() (android.Paths, []string) {
2578 return nil, nil
2579}
2580
Colin Cross0c4ce212019-05-03 15:28:19 -07002581func (j *Import) SrcJarArgs() ([]string, android.Paths) {
2582 return nil, nil
2583}
2584
Jiyong Park0f80c182020-01-31 02:49:53 +09002585func (j *Import) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Paul Duffin0d3c2e12020-05-17 08:34:50 +01002586 return j.depIsInSameApex(ctx, dep)
Jiyong Park0f80c182020-01-31 02:49:53 +09002587}
2588
albaltai36ff7dc2018-12-25 14:35:23 +08002589// Add compile time check for interface implementation
2590var _ android.IDEInfo = (*Import)(nil)
2591var _ android.IDECustomizedModuleName = (*Import)(nil)
2592
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002593// Collect information for opening IDE project files in java/jdeps.go.
2594const (
2595 removedPrefix = "prebuilt_"
2596)
2597
2598func (j *Import) IDEInfo(dpInfo *android.IdeInfo) {
2599 dpInfo.Jars = append(dpInfo.Jars, j.PrebuiltSrcs()...)
2600}
2601
2602func (j *Import) IDECustomizedModuleName() string {
2603 // TODO(b/113562217): Extract the base module name from the Import name, often the Import name
2604 // has a prefix "prebuilt_". Remove the prefix explicitly if needed until we find a better
2605 // solution to get the Import name.
2606 name := j.Name()
2607 if strings.HasPrefix(name, removedPrefix) {
patricktubb640e02018-10-11 18:33:16 +08002608 name = strings.TrimPrefix(name, removedPrefix)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002609 }
2610 return name
2611}
2612
Colin Cross74d73e22017-08-02 11:05:49 -07002613var _ android.PrebuiltInterface = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07002614
Colin Cross1b16b0e2019-02-12 14:41:32 -08002615// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library module.
2616//
2617// By default, a java_import has a single variant that expects a `.jar` file containing `.class` files that were
2618// compiled against an Android classpath.
2619//
2620// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
2621// for host modules.
Colin Cross74d73e22017-08-02 11:05:49 -07002622func ImportFactory() android.Module {
2623 module := &Import{}
Colin Cross36242852017-06-23 15:06:31 -07002624
Colin Cross74d73e22017-08-02 11:05:49 -07002625 module.AddProperties(&module.properties)
2626
Paul Duffin859fe962020-05-15 10:20:31 +01002627 module.initModuleAndImport(&module.ModuleBase)
2628
Colin Cross74d73e22017-08-02 11:05:49 -07002629 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002630 android.InitApexModule(module)
Jiyong Parkd1063c12019-07-17 20:08:41 +09002631 android.InitSdkAwareModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002632 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross36242852017-06-23 15:06:31 -07002633 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002634}
2635
Colin Cross1b16b0e2019-02-12 14:41:32 -08002636// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library_host
2637// module.
2638//
2639// A java_import_host has a single variant that expects a `.jar` file containing `.class` files that were
2640// compiled against a host bootclasspath.
Colin Cross74d73e22017-08-02 11:05:49 -07002641func ImportFactoryHost() android.Module {
2642 module := &Import{}
2643
2644 module.AddProperties(&module.properties)
2645
2646 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002647 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002648 InitJavaModule(module, android.HostSupported)
Colin Cross74d73e22017-08-02 11:05:49 -07002649 return module
2650}
2651
Colin Cross42be7612019-02-21 18:12:14 -08002652// dex_import module
2653
2654type DexImportProperties struct {
Colin Cross5cfc70d2019-07-15 13:36:55 -07002655 Jars []string `android:"path"`
Jiyong Park4c4c0242019-10-21 14:53:15 +09002656
2657 // set the name of the output
2658 Stem *string
Colin Cross42be7612019-02-21 18:12:14 -08002659}
2660
2661type DexImport struct {
2662 android.ModuleBase
2663 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002664 android.ApexModuleBase
Colin Cross42be7612019-02-21 18:12:14 -08002665 prebuilt android.Prebuilt
2666
2667 properties DexImportProperties
2668
2669 dexJarFile android.Path
2670 maybeStrippedDexJarFile android.Path
2671
2672 dexpreopter
2673}
2674
2675func (j *DexImport) Prebuilt() *android.Prebuilt {
2676 return &j.prebuilt
2677}
2678
2679func (j *DexImport) PrebuiltSrcs() []string {
2680 return j.properties.Jars
2681}
2682
2683func (j *DexImport) Name() string {
2684 return j.prebuilt.Name(j.ModuleBase.Name())
2685}
2686
Jiyong Park0b238752019-10-29 11:23:10 +09002687func (j *DexImport) Stem() string {
2688 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
2689}
2690
Martin Stjernholm6d415272020-01-31 17:10:36 +00002691func (j *DexImport) IsInstallable() bool {
2692 return true
2693}
2694
Colin Cross42be7612019-02-21 18:12:14 -08002695func (j *DexImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2696 if len(j.properties.Jars) != 1 {
2697 ctx.PropertyErrorf("jars", "exactly one jar must be provided")
2698 }
2699
Jiyong Park0b238752019-10-29 11:23:10 +09002700 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar")
Colin Cross42be7612019-02-21 18:12:14 -08002701 j.dexpreopter.uncompressedDex = shouldUncompressDex(ctx, &j.dexpreopter)
2702
2703 inputJar := ctx.ExpandSource(j.properties.Jars[0], "jars")
2704 dexOutputFile := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar")
2705
2706 if j.dexpreopter.uncompressedDex {
2707 rule := android.NewRuleBuilder()
2708
2709 temporary := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar.unaligned")
2710 rule.Temporary(temporary)
2711
2712 // use zip2zip to uncompress classes*.dex files
2713 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -07002714 BuiltTool(ctx, "zip2zip").
Colin Cross42be7612019-02-21 18:12:14 -08002715 FlagWithInput("-i ", inputJar).
2716 FlagWithOutput("-o ", temporary).
2717 FlagWithArg("-0 ", "'classes*.dex'")
2718
2719 // use zipalign to align uncompressed classes*.dex files
2720 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -07002721 BuiltTool(ctx, "zipalign").
Colin Cross42be7612019-02-21 18:12:14 -08002722 Flag("-f").
2723 Text("4").
2724 Input(temporary).
2725 Output(dexOutputFile)
2726
2727 rule.DeleteTemporaryFiles()
2728
2729 rule.Build(pctx, ctx, "uncompress_dex", "uncompress dex")
2730 } else {
2731 ctx.Build(pctx, android.BuildParams{
2732 Rule: android.Cp,
2733 Input: inputJar,
2734 Output: dexOutputFile,
2735 })
2736 }
2737
2738 j.dexJarFile = dexOutputFile
2739
2740 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
2741
2742 j.maybeStrippedDexJarFile = dexOutputFile
2743
2744 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
Jiyong Parka62aa232020-05-28 23:46:55 +09002745 j.Stem()+".jar", dexOutputFile)
Colin Cross42be7612019-02-21 18:12:14 -08002746}
2747
Ulyana Trafimovichb0dc8512020-06-04 10:37:36 +00002748func (j *DexImport) DexJar() android.Path {
Colin Cross42be7612019-02-21 18:12:14 -08002749 return j.dexJarFile
2750}
2751
2752// dex_import imports a `.jar` file containing classes.dex files.
2753//
2754// A dex_import module cannot be used as a dependency of a java_* or android_* module, it can only be installed
2755// to the device.
2756func DexImportFactory() android.Module {
2757 module := &DexImport{}
2758
2759 module.AddProperties(&module.properties)
2760
2761 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002762 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002763 InitJavaModule(module, android.DeviceSupported)
Colin Cross42be7612019-02-21 18:12:14 -08002764 return module
2765}
2766
Colin Cross89536d42017-07-07 14:35:50 -07002767//
2768// Defaults
2769//
2770type Defaults struct {
2771 android.ModuleBase
2772 android.DefaultsModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002773 android.ApexModuleBase
Colin Cross89536d42017-07-07 14:35:50 -07002774}
2775
Colin Cross1b16b0e2019-02-12 14:41:32 -08002776// java_defaults provides a set of properties that can be inherited by other java or android modules.
2777//
2778// A module can use the properties from a java_defaults module using `defaults: ["defaults_module_name"]`. Each
2779// property in the defaults module that exists in the depending module will be prepended to the depending module's
2780// value for that property.
2781//
2782// Example:
2783//
2784// java_defaults {
2785// name: "example_defaults",
2786// srcs: ["common/**/*.java"],
2787// javacflags: ["-Xlint:all"],
2788// aaptflags: ["--auto-add-overlay"],
2789// }
2790//
2791// java_library {
2792// name: "example",
2793// defaults: ["example_defaults"],
2794// srcs: ["example/**/*.java"],
2795// }
2796//
2797// is functionally identical to:
2798//
2799// java_library {
2800// name: "example",
2801// srcs: [
2802// "common/**/*.java",
2803// "example/**/*.java",
2804// ],
2805// javacflags: ["-Xlint:all"],
2806// }
Colin Cross89536d42017-07-07 14:35:50 -07002807func defaultsFactory() android.Module {
2808 return DefaultsFactory()
2809}
2810
Paul Duffin47357662019-12-05 14:07:14 +00002811func DefaultsFactory() android.Module {
Colin Cross89536d42017-07-07 14:35:50 -07002812 module := &Defaults{}
2813
Colin Cross89536d42017-07-07 14:35:50 -07002814 module.AddProperties(
2815 &CompilerProperties{},
2816 &CompilerDeviceProperties{},
Colin Cross43f08db2018-11-12 10:13:39 -08002817 &DexpreoptProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08002818 &android.ProtoProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002819 &aaptProperties{},
2820 &androidLibraryProperties{},
2821 &appProperties{},
2822 &appTestProperties{},
Jaewoong Jung525443a2019-02-28 15:35:54 -08002823 &overridableAppProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002824 &ImportProperties{},
2825 &AARImportProperties{},
2826 &sdkLibraryProperties{},
Paul Duffin1b1e8062020-05-08 13:44:43 +01002827 &commonToSdkLibraryAndImportProperties{},
Colin Cross42be7612019-02-21 18:12:14 -08002828 &DexImportProperties{},
Jooyung Han18020ea2019-11-13 10:50:48 +09002829 &android.ApexProperties{},
Jaewoong Jungbf135462020-04-26 15:10:51 -07002830 &RuntimeResourceOverlayProperties{},
Colin Cross89536d42017-07-07 14:35:50 -07002831 )
2832
2833 android.InitDefaultsModule(module)
Colin Cross89536d42017-07-07 14:35:50 -07002834 return module
2835}
Nan Zhangea568a42017-11-08 21:20:04 -08002836
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002837func kytheExtractJavaFactory() android.Singleton {
2838 return &kytheExtractJavaSingleton{}
2839}
2840
2841type kytheExtractJavaSingleton struct {
2842}
2843
2844func (ks *kytheExtractJavaSingleton) GenerateBuildActions(ctx android.SingletonContext) {
2845 var xrefTargets android.Paths
2846 ctx.VisitAllModules(func(module android.Module) {
2847 if javaModule, ok := module.(xref); ok {
2848 xrefTargets = append(xrefTargets, javaModule.XrefJavaFiles()...)
2849 }
2850 })
2851 // TODO(asmundak): perhaps emit a rule to output a warning if there were no xrefTargets
2852 if len(xrefTargets) > 0 {
2853 ctx.Build(pctx, android.BuildParams{
2854 Rule: blueprint.Phony,
2855 Output: android.PathForPhony(ctx, "xref_java"),
2856 Inputs: xrefTargets,
2857 })
2858 }
2859}
2860
Nan Zhangea568a42017-11-08 21:20:04 -08002861var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07002862var BoolDefault = proptools.BoolDefault
Nan Zhangea568a42017-11-08 21:20:04 -08002863var String = proptools.String
Colin Cross0d0ba592018-02-20 13:33:42 -08002864var inList = android.InList