blob: 8dbdfb6a7ba4c5ebeb4200947b8cc27895f94de8 [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 Cross76b5f0c2017-08-29 16:02:06 -070028 "github.com/google/blueprint/proptools"
Colin Cross2fe66872015-03-30 17:20:39 -070029
Colin Cross635c3b02016-05-18 15:37:25 -070030 "android/soong/android"
Colin Cross3e3e72d2017-06-22 17:20:19 -070031 "android/soong/java/config"
Colin Cross303e21f2018-08-07 16:49:25 -070032 "android/soong/tradefed"
Colin Cross2fe66872015-03-30 17:20:39 -070033)
34
Colin Cross463a90e2015-06-17 14:20:06 -070035func init() {
Colin Cross89536d42017-07-07 14:35:50 -070036 android.RegisterModuleType("java_defaults", defaultsFactory)
37
Colin Cross9ae1b922018-06-26 17:59:05 -070038 android.RegisterModuleType("java_library", LibraryFactory)
Colin Cross1b16b0e2019-02-12 14:41:32 -080039 android.RegisterModuleType("java_library_static", LibraryStaticFactory)
Colin Crossf506d872017-07-19 15:53:04 -070040 android.RegisterModuleType("java_library_host", LibraryHostFactory)
41 android.RegisterModuleType("java_binary", BinaryFactory)
42 android.RegisterModuleType("java_binary_host", BinaryHostFactory)
Colin Cross05638fc2018-04-09 18:40:24 -070043 android.RegisterModuleType("java_test", TestFactory)
Paul Duffin42df1442019-03-20 12:45:53 +000044 android.RegisterModuleType("java_test_helper_library", TestHelperLibraryFactory)
Colin Cross05638fc2018-04-09 18:40:24 -070045 android.RegisterModuleType("java_test_host", TestHostFactory)
Colin Cross74d73e22017-08-02 11:05:49 -070046 android.RegisterModuleType("java_import", ImportFactory)
47 android.RegisterModuleType("java_import_host", ImportFactoryHost)
Colin Cross3d7c9822019-03-01 13:46:24 -080048 android.RegisterModuleType("java_device_for_host", DeviceForHostFactory)
49 android.RegisterModuleType("java_host_for_device", HostForDeviceFactory)
Colin Cross42be7612019-02-21 18:12:14 -080050 android.RegisterModuleType("dex_import", DexImportFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070051
Colin Cross798bfce2016-10-12 14:28:16 -070052 android.RegisterSingletonType("logtags", LogtagsSingleton)
Colin Cross463a90e2015-06-17 14:20:06 -070053}
54
Colin Cross2fe66872015-03-30 17:20:39 -070055// TODO:
56// Autogenerated files:
Colin Cross2fe66872015-03-30 17:20:39 -070057// Renderscript
58// Post-jar passes:
59// Proguard
Colin Cross2fe66872015-03-30 17:20:39 -070060// Rmtypedefs
Colin Cross2fe66872015-03-30 17:20:39 -070061// DroidDoc
62// Findbugs
63
Colin Cross89536d42017-07-07 14:35:50 -070064type CompilerProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -070065 // list of source files used to compile the Java module. May be .java, .logtags, .proto,
66 // or .aidl files.
Colin Cross27b922f2019-03-04 22:35:41 -080067 Srcs []string `android:"path,arch_variant"`
Dan Willemsen2ef08f42015-06-30 18:15:24 -070068
69 // list of source files that should not be used to build the Java module.
70 // This is most useful in the arch/multilib variants to remove non-common files
Colin Cross27b922f2019-03-04 22:35:41 -080071 Exclude_srcs []string `android:"path,arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -070072
73 // list of directories containing Java resources
Colin Cross86a63ff2017-09-27 17:33:10 -070074 Java_resource_dirs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -070075
Colin Cross86a63ff2017-09-27 17:33:10 -070076 // list of directories that should be excluded from java_resource_dirs
77 Exclude_java_resource_dirs []string `android:"arch_variant"`
Dan Willemsen2ef08f42015-06-30 18:15:24 -070078
Colin Cross0f37af02017-09-27 17:42:05 -070079 // list of files to use as Java resources
Colin Cross27b922f2019-03-04 22:35:41 -080080 Java_resources []string `android:"path,arch_variant"`
Colin Cross0f37af02017-09-27 17:42:05 -070081
Colin Crosscedd4762018-09-13 11:26:19 -070082 // list of files that should be excluded from java_resources and java_resource_dirs
Colin Cross27b922f2019-03-04 22:35:41 -080083 Exclude_java_resources []string `android:"path,arch_variant"`
Colin Cross0f37af02017-09-27 17:42:05 -070084
Paul Duffin2fbbfb82019-02-13 12:49:33 +000085 // don't build against the default libraries (bootclasspath, ext, and framework for device
86 // targets)
Colin Cross76b5f0c2017-08-29 16:02:06 -070087 No_standard_libs *bool
Colin Cross7d5136f2015-05-11 13:39:40 -070088
Paul Duffin2fbbfb82019-02-13 12:49:33 +000089 // don't build against the framework libraries (ext, and framework for device targets)
Colin Crossfa5eb232017-10-01 20:33:03 -070090 No_framework_libs *bool
91
Colin Cross7d5136f2015-05-11 13:39:40 -070092 // list of module-specific flags that will be used for javac compiles
93 Javacflags []string `android:"arch_variant"`
94
Zoran Jovanovic8736ce22018-08-21 17:10:29 +020095 // list of module-specific flags that will be used for kotlinc compiles
96 Kotlincflags []string `android:"arch_variant"`
97
Colin Cross7d5136f2015-05-11 13:39:40 -070098 // list of of java libraries that will be in the classpath
Colin Crosse8dc34a2017-07-19 11:22:16 -070099 Libs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700100
101 // list of java libraries that will be compiled into the resulting jar
Colin Crosse8dc34a2017-07-19 11:22:16 -0700102 Static_libs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700103
104 // manifest file to be included in resulting jar
Colin Cross27b922f2019-03-04 22:35:41 -0800105 Manifest *string `android:"path"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700106
Colin Cross540eff82017-06-22 17:01:52 -0700107 // if not blank, run jarjar using the specified rules file
Colin Cross27b922f2019-03-04 22:35:41 -0800108 Jarjar_rules *string `android:"path,arch_variant"`
Colin Cross64162712017-08-08 13:17:59 -0700109
110 // If not blank, set the java version passed to javac as -source and -target
111 Java_version *string
Colin Cross2c429dc2017-08-31 16:45:16 -0700112
Colin Cross9ae1b922018-06-26 17:59:05 -0700113 // If set to true, allow this module to be dexed and installed on devices. Has no
114 // effect on host modules, which are always considered installable.
Colin Cross2c429dc2017-08-31 16:45:16 -0700115 Installable *bool
Colin Cross32f676a2017-09-06 13:41:06 -0700116
Colin Cross0f37af02017-09-27 17:42:05 -0700117 // If set to true, include sources used to compile the module in to the final jar
118 Include_srcs *bool
119
Vladimir Marko0975ee02019-04-02 10:29:55 +0100120 // If not empty, classes are restricted to the specified packages and their sub-packages.
121 // This restriction is checked after applying jarjar rules and including static libs.
122 Permitted_packages []string
123
Colin Crossbe9cdb82019-01-21 21:37:16 -0800124 // List of modules to use as annotation processors
125 Plugins []string
Colin Cross1369cdb2017-09-29 17:58:17 -0700126
Nan Zhang61eaedb2017-11-02 13:28:15 -0700127 // The number of Java source entries each Javac instance can process
128 Javac_shard_size *int64
129
Nan Zhang5f8cb422018-02-06 10:34:32 -0800130 // Add host jdk tools.jar to bootclasspath
131 Use_tools_jar *bool
132
Colin Cross1369cdb2017-09-29 17:58:17 -0700133 Openjdk9 struct {
134 // List of source files that should only be used when passing -source 1.9
Colin Cross27b922f2019-03-04 22:35:41 -0800135 Srcs []string `android:"path"`
Colin Cross1369cdb2017-09-29 17:58:17 -0700136
137 // List of javac flags that should only be used when passing -source 1.9
138 Javacflags []string
139 }
Colin Crosscb933592017-11-22 13:49:43 -0800140
Colin Cross81440082018-08-15 20:21:55 -0700141 // When compiling language level 9+ .java code in packages that are part of
142 // a system module, patch_module names the module that your sources and
143 // dependencies should be patched into. The Android runtime currently
144 // doesn't implement the JEP 261 module system so this option is only
145 // supported at compile time. It should only be needed to compile tests in
146 // packages that exist in libcore and which are inconvenient to move
147 // elsewhere.
Tobias Thiererdda713d2018-09-19 16:16:19 +0100148 Patch_module *string `android:"arch_variant"`
Colin Cross81440082018-08-15 20:21:55 -0700149
Colin Crosscb933592017-11-22 13:49:43 -0800150 Jacoco struct {
151 // List of classes to include for instrumentation with jacoco to collect coverage
152 // information at runtime when building with coverage enabled. If unset defaults to all
153 // classes.
154 // Supports '*' as the last character of an entry in the list as a wildcard match.
155 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
156 // it matches classes in the package that have the class name as a prefix.
157 Include_filter []string
158
159 // List of classes to exclude from instrumentation with jacoco to collect coverage
160 // information at runtime when building with coverage enabled. Overrides classes selected
161 // by the include_filter property.
162 // Supports '*' as the last character of an entry in the list as a wildcard match.
163 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
164 // it matches classes in the package that have the class name as a prefix.
165 Exclude_filter []string
166 }
167
Andreas Gampef3e5b552018-01-22 21:27:21 -0800168 Errorprone struct {
169 // List of javac flags that should only be used when running errorprone.
170 Javacflags []string
171 }
172
Colin Cross0f2ee152017-12-14 15:22:43 -0800173 Proto struct {
174 // List of extra options that will be passed to the proto generator.
175 Output_params []string
176 }
177
Colin Crosscb933592017-11-22 13:49:43 -0800178 Instrument bool `blueprint:"mutated"`
Alex Light7f004a72019-02-21 13:27:37 -0800179
180 // List of files to include in the META-INF/services folder of the resulting jar.
Colin Cross27b922f2019-03-04 22:35:41 -0800181 Services []string `android:"path,arch_variant"`
Colin Cross540eff82017-06-22 17:01:52 -0700182}
183
Colin Cross89536d42017-07-07 14:35:50 -0700184type CompilerDeviceProperties struct {
Colin Cross540eff82017-06-22 17:01:52 -0700185 // list of module-specific flags that will be used for dex compiles
186 Dxflags []string `android:"arch_variant"`
187
Colin Cross83bb3162018-06-25 15:48:06 -0700188 // if not blank, set to the version of the sdk to compile against. Defaults to compiling against the current
189 // sdk if platform_apis is not set.
Nan Zhangea568a42017-11-08 21:20:04 -0800190 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700191
Colin Cross83bb3162018-06-25 15:48:06 -0700192 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
193 // Defaults to sdk_version if not set.
194 Min_sdk_version *string
195
Dan Willemsen419290a2018-10-31 15:28:47 -0700196 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
197 // Defaults to sdk_version if not set.
198 Target_sdk_version *string
199
Colin Cross6af2e492018-05-22 11:12:33 -0700200 // if true, compile against the platform APIs instead of an SDK.
201 Platform_apis *bool
202
Colin Crossebe1a512017-11-14 13:12:14 -0800203 Aidl struct {
204 // Top level directories to pass to aidl tool
205 Include_dirs []string
Colin Cross7d5136f2015-05-11 13:39:40 -0700206
Colin Crossebe1a512017-11-14 13:12:14 -0800207 // Directories rooted at the Android.bp file to pass to aidl tool
208 Local_include_dirs []string
209
210 // directories that should be added as include directories for any aidl sources of modules
211 // that depend on this module, as well as to aidl for this module.
212 Export_include_dirs []string
Martijn Coeneneab15642018-03-09 09:29:59 +0100213
214 // whether to generate traces (for systrace) for this interface
215 Generate_traces *bool
Olivier Gaillard0a4cfbc2018-07-16 23:37:03 +0100216
217 // whether to generate Binder#GetTransaction name method.
218 Generate_get_transaction_name *bool
Colin Crossebe1a512017-11-14 13:12:14 -0800219 }
Colin Cross92430102017-10-09 14:59:32 -0700220
221 // If true, export a copy of the module as a -hostdex module for host testing.
222 Hostdex *bool
Colin Cross1369cdb2017-09-29 17:58:17 -0700223
Colin Cross7f87f4f2019-04-24 13:41:45 -0700224 Target struct {
225 Hostdex struct {
226 // Additional required dependencies to add to -hostdex modules.
227 Required []string
228 }
229 }
230
David Brazdil17ef5632018-06-27 10:27:45 +0100231 // If set to true, compile dex regardless of installable. Defaults to false.
232 Compile_dex *bool
233
Colin Cross66dbc0b2017-12-28 12:23:20 -0800234 Optimize struct {
Colin Crossae5caf52018-05-22 11:11:52 -0700235 // If false, disable all optimization. Defaults to true for android_app and android_test
236 // modules, false for java_library and java_test modules.
Colin Cross66dbc0b2017-12-28 12:23:20 -0800237 Enabled *bool
Sasha Smundak2057f822019-04-16 17:16:58 -0700238 // True if the module containing this has it set by default.
239 EnabledByDefault bool `blueprint:"mutated"`
Colin Cross66dbc0b2017-12-28 12:23:20 -0800240
241 // If true, optimize for size by removing unused code. Defaults to true for apps,
242 // false for libraries and tests.
243 Shrink *bool
244
245 // If true, optimize bytecode. Defaults to false.
246 Optimize *bool
247
248 // If true, obfuscate bytecode. Defaults to false.
249 Obfuscate *bool
250
251 // If true, do not use the flag files generated by aapt that automatically keep
252 // classes referenced by the app manifest. Defaults to false.
253 No_aapt_flags *bool
254
255 // Flags to pass to proguard.
256 Proguard_flags []string
257
258 // Specifies the locations of files containing proguard flags.
Colin Cross27b922f2019-03-04 22:35:41 -0800259 Proguard_flags_files []string `android:"path"`
Colin Cross66dbc0b2017-12-28 12:23:20 -0800260 }
261
Colin Cross1369cdb2017-09-29 17:58:17 -0700262 // When targeting 1.9, override the modules to use with --system
263 System_modules *string
Colin Cross5a0dcd52018-10-05 14:20:06 -0700264
265 UncompressDex bool `blueprint:"mutated"`
Colin Cross43f08db2018-11-12 10:13:39 -0800266 IsSDKLibrary bool `blueprint:"mutated"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700267}
268
Sasha Smundak2057f822019-04-16 17:16:58 -0700269func (me *CompilerDeviceProperties) EffectiveOptimizeEnabled() bool {
270 return BoolDefault(me.Optimize.Enabled, me.Optimize.EnabledByDefault)
271}
272
Colin Cross46c9b8b2017-06-22 16:51:17 -0700273// Module contains the properties and members used by all java module types
274type Module struct {
Colin Cross635c3b02016-05-18 15:37:25 -0700275 android.ModuleBase
Colin Cross89536d42017-07-07 14:35:50 -0700276 android.DefaultableModuleBase
Colin Cross2fe66872015-03-30 17:20:39 -0700277
Colin Cross89536d42017-07-07 14:35:50 -0700278 properties CompilerProperties
Colin Cross6af17aa2017-09-20 12:59:05 -0700279 protoProperties android.ProtoProperties
Colin Cross89536d42017-07-07 14:35:50 -0700280 deviceProperties CompilerDeviceProperties
Colin Cross2fe66872015-03-30 17:20:39 -0700281
Colin Cross331a1212018-08-15 20:40:52 -0700282 // jar file containing header classes including static library dependencies, suitable for
283 // inserting into the bootclasspath/classpath of another compile
Nan Zhanged19fc32017-10-19 13:06:22 -0700284 headerJarFile android.Path
285
Colin Cross331a1212018-08-15 20:40:52 -0700286 // jar file containing implementation classes including static library dependencies but no
287 // resources
Nan Zhanged19fc32017-10-19 13:06:22 -0700288 implementationJarFile android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700289
Colin Cross331a1212018-08-15 20:40:52 -0700290 // jar file containing only resources including from static library dependencies
291 resourceJar android.Path
292
Colin Cross0c4ce212019-05-03 15:28:19 -0700293 // args and dependencies to package source files into a srcjar
294 srcJarArgs []string
295 srcJarDeps android.Paths
296
Colin Cross331a1212018-08-15 20:40:52 -0700297 // jar file containing implementation classes and resources including static library
298 // dependencies
299 implementationAndResourcesJar android.Path
300
301 // output file containing classes.dex and resources
Colin Cross6ade34f2017-09-15 13:00:47 -0700302 dexJarFile android.Path
303
Colin Cross43f08db2018-11-12 10:13:39 -0800304 // output file that contains classes.dex if it should be in the output file
305 maybeStrippedDexJarFile android.Path
306
Colin Crosscb933592017-11-22 13:49:43 -0800307 // output file containing uninstrumented classes that will be instrumented by jacoco
308 jacocoReportClassesFile android.Path
309
Colin Cross66dbc0b2017-12-28 12:23:20 -0800310 // output file containing mapping of obfuscated names
311 proguardDictionary android.Path
312
Colin Cross331a1212018-08-15 20:40:52 -0700313 // output file of the module, which may be a classes jar or a dex jar
Colin Crosse560c4a2019-03-19 16:03:11 -0700314 outputFile android.Path
315 extraOutputFiles android.Paths
Colin Crossb7a63242015-04-16 14:09:14 -0700316
Colin Cross635c3b02016-05-18 15:37:25 -0700317 exportAidlIncludeDirs android.Paths
Colin Crossc0b06f12015-04-08 13:03:43 -0700318
Colin Cross635c3b02016-05-18 15:37:25 -0700319 logtagsSrcs android.Paths
Colin Crossf05fe972015-04-10 17:45:20 -0700320
Colin Cross2fe66872015-03-30 17:20:39 -0700321 // installed file for binary dependency
Colin Cross635c3b02016-05-18 15:37:25 -0700322 installFile android.Path
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800323
324 // list of .java files and srcjars that was passed to javac
325 compiledJavaSrcs android.Paths
326 compiledSrcJars android.Paths
Colin Cross66dbc0b2017-12-28 12:23:20 -0800327
328 // list of extra progurad flag files
329 extraProguardFlagFiles android.Paths
Jiyong Park1be96912018-05-28 18:02:19 +0900330
Colin Cross094054a2018-10-17 15:10:48 -0700331 // manifest file to use instead of properties.Manifest
332 overrideManifest android.OptionalPath
333
Jiyong Park1be96912018-05-28 18:02:19 +0900334 // list of SDK lib names that this java moudule is exporting
335 exportedSdkLibs []string
Brandon Lee5d45c6f2018-08-15 15:35:38 -0700336
337 // list of source files, collected from compiledJavaSrcs and compiledSrcJars
338 // filter out Exclude_srcs, will be used by android.IDEInfo struct
339 expandIDEInfoCompiledSrcs []string
Colin Cross43f08db2018-11-12 10:13:39 -0800340
Steven Morelandc4efd9c2019-01-18 11:51:25 -0800341 // expanded Jarjar_rules
342 expandJarjarRules android.Path
343
Vladimir Marko0975ee02019-04-02 10:29:55 +0100344 // list of additional targets for checkbuild
345 additionalCheckedModules android.Paths
346
Colin Cross988708c2019-05-06 14:04:11 -0700347 // Extra files generated by the module type to be added as java resources.
348 extraResources android.Paths
349
Colin Crossf24a22a2019-01-31 14:12:44 -0800350 hiddenAPI
Colin Cross43f08db2018-11-12 10:13:39 -0800351 dexpreopter
Colin Cross2fe66872015-03-30 17:20:39 -0700352}
353
Colin Cross54250902017-12-05 09:28:08 -0800354func (j *Module) Srcs() android.Paths {
Colin Crosse560c4a2019-03-19 16:03:11 -0700355 return append(android.Paths{j.outputFile}, j.extraOutputFiles...)
Colin Cross54250902017-12-05 09:28:08 -0800356}
357
Jiyong Park8fd61922018-11-08 02:50:25 +0900358func (j *Module) DexJarFile() android.Path {
359 return j.dexJarFile
360}
361
Colin Cross54250902017-12-05 09:28:08 -0800362var _ android.SourceFileProducer = (*Module)(nil)
363
Colin Crossf506d872017-07-19 15:53:04 -0700364type Dependency interface {
Nan Zhanged19fc32017-10-19 13:06:22 -0700365 HeaderJars() android.Paths
366 ImplementationJars() android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700367 ResourceJars() android.Paths
368 ImplementationAndResourcesJars() android.Paths
Colin Crossf24a22a2019-01-31 14:12:44 -0800369 DexJar() android.Path
Colin Cross635c3b02016-05-18 15:37:25 -0700370 AidlIncludeDirs() android.Paths
Jiyong Park1be96912018-05-28 18:02:19 +0900371 ExportedSdkLibs() []string
Colin Cross0c4ce212019-05-03 15:28:19 -0700372 SrcJarArgs() ([]string, android.Paths)
Colin Cross2fe66872015-03-30 17:20:39 -0700373}
374
Jiyong Parkc678ad32018-04-10 13:07:10 +0900375type SdkLibraryDependency interface {
Colin Cross897d2ed2019-02-11 14:03:51 -0800376 SdkHeaderJars(ctx android.BaseContext, sdkVersion string) android.Paths
377 SdkImplementationJars(ctx android.BaseContext, sdkVersion string) android.Paths
Jiyong Parkc678ad32018-04-10 13:07:10 +0900378}
379
Nan Zhangb2b33de2018-02-23 11:18:47 -0800380type SrcDependency interface {
381 CompiledSrcs() android.Paths
382 CompiledSrcJars() android.Paths
383}
384
385func (j *Module) CompiledSrcs() android.Paths {
386 return j.compiledJavaSrcs
387}
388
389func (j *Module) CompiledSrcJars() android.Paths {
390 return j.compiledSrcJars
391}
392
393var _ SrcDependency = (*Module)(nil)
394
Colin Cross89536d42017-07-07 14:35:50 -0700395func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
396 android.InitAndroidArchModule(module, hod, android.MultilibCommon)
397 android.InitDefaultableModule(module)
398}
399
Colin Crossbe1da472017-07-07 15:59:46 -0700400type dependencyTag struct {
401 blueprint.BaseDependencyTag
402 name string
Colin Cross2fe66872015-03-30 17:20:39 -0700403}
404
Colin Crossa4f08812018-10-02 22:03:40 -0700405type jniDependencyTag struct {
406 blueprint.BaseDependencyTag
407 target android.Target
408}
409
Colin Crossbe1da472017-07-07 15:59:46 -0700410var (
Colin Cross4b964c02018-10-15 16:18:06 -0700411 staticLibTag = dependencyTag{name: "staticlib"}
412 libTag = dependencyTag{name: "javalib"}
Colin Crossbe9cdb82019-01-21 21:37:16 -0800413 pluginTag = dependencyTag{name: "plugin"}
Colin Cross4b964c02018-10-15 16:18:06 -0700414 bootClasspathTag = dependencyTag{name: "bootclasspath"}
415 systemModulesTag = dependencyTag{name: "system modules"}
416 frameworkResTag = dependencyTag{name: "framework-res"}
417 frameworkApkTag = dependencyTag{name: "framework-apk"}
418 kotlinStdlibTag = dependencyTag{name: "kotlin-stdlib"}
Colin Crossafbb1732019-01-17 15:42:52 -0800419 kotlinAnnotationsTag = dependencyTag{name: "kotlin-annotations"}
Colin Cross4b964c02018-10-15 16:18:06 -0700420 proguardRaiseTag = dependencyTag{name: "proguard-raise"}
421 certificateTag = dependencyTag{name: "certificate"}
422 instrumentationForTag = dependencyTag{name: "instrumentation_for"}
Colin Crossbe1da472017-07-07 15:59:46 -0700423)
Colin Cross2fe66872015-03-30 17:20:39 -0700424
Colin Crossfc3674a2017-09-18 17:41:52 -0700425type sdkDep struct {
Colin Cross47ff2522017-10-02 14:22:08 -0700426 useModule, useFiles, useDefaultLibs, invalidVersion bool
427
Colin Cross86a60ae2018-05-29 14:44:55 -0700428 modules []string
Colin Cross1369cdb2017-09-29 17:58:17 -0700429 systemModules string
430
Colin Crossa97c5d32018-03-28 14:58:31 -0700431 frameworkResModule string
432
Colin Cross86a60ae2018-05-29 14:44:55 -0700433 jars android.Paths
Colin Cross3047fa22019-04-18 10:56:44 -0700434 aidl android.OptionalPath
Colin Cross1369cdb2017-09-29 17:58:17 -0700435}
436
Colin Crossa4f08812018-10-02 22:03:40 -0700437type jniLib struct {
438 name string
439 path android.Path
440 target android.Target
441}
442
Colin Cross3144dfc2018-01-03 15:06:47 -0800443func (j *Module) shouldInstrument(ctx android.BaseContext) bool {
444 return j.properties.Instrument && ctx.Config().IsEnvTrue("EMMA_INSTRUMENT")
445}
446
447func (j *Module) shouldInstrumentStatic(ctx android.BaseContext) bool {
448 return j.shouldInstrument(ctx) &&
449 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
450 ctx.Config().UnbundledBuild())
451}
452
Colin Cross83bb3162018-06-25 15:48:06 -0700453func (j *Module) sdkVersion() string {
454 return String(j.deviceProperties.Sdk_version)
455}
456
457func (j *Module) minSdkVersion() string {
458 if j.deviceProperties.Min_sdk_version != nil {
459 return *j.deviceProperties.Min_sdk_version
460 }
461 return j.sdkVersion()
462}
463
Dan Willemsen419290a2018-10-31 15:28:47 -0700464func (j *Module) targetSdkVersion() string {
465 if j.deviceProperties.Target_sdk_version != nil {
466 return *j.deviceProperties.Target_sdk_version
467 }
468 return j.sdkVersion()
469}
470
Colin Crossbe1da472017-07-07 15:59:46 -0700471func (j *Module) deps(ctx android.BottomUpMutatorContext) {
Colin Cross1369cdb2017-09-29 17:58:17 -0700472 if ctx.Device() {
Colin Crossff3ae9d2018-04-10 16:15:18 -0700473 if !Bool(j.properties.No_standard_libs) {
Colin Cross83bb3162018-06-25 15:48:06 -0700474 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Crossfc3674a2017-09-18 17:41:52 -0700475 if sdkDep.useDefaultLibs {
Colin Cross42d48b72018-08-29 14:10:52 -0700476 ctx.AddVariationDependencies(nil, bootClasspathTag, config.DefaultBootclasspathLibraries...)
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100477 ctx.AddVariationDependencies(nil, systemModulesTag, config.DefaultSystemModules)
Colin Crossff3ae9d2018-04-10 16:15:18 -0700478 if !Bool(j.properties.No_framework_libs) {
Colin Cross42d48b72018-08-29 14:10:52 -0700479 ctx.AddVariationDependencies(nil, libTag, config.DefaultLibraries...)
Colin Crossfa5eb232017-10-01 20:33:03 -0700480 }
Colin Cross1369cdb2017-09-29 17:58:17 -0700481 } else if sdkDep.useModule {
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100482 ctx.AddVariationDependencies(nil, systemModulesTag, sdkDep.systemModules)
Colin Cross42d48b72018-08-29 14:10:52 -0700483 ctx.AddVariationDependencies(nil, bootClasspathTag, sdkDep.modules...)
Sasha Smundak2057f822019-04-16 17:16:58 -0700484 if j.deviceProperties.EffectiveOptimizeEnabled() {
Colin Cross42d48b72018-08-29 14:10:52 -0700485 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.DefaultBootclasspathLibraries...)
486 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.DefaultLibraries...)
Colin Cross66dbc0b2017-12-28 12:23:20 -0800487 }
Colin Crossbe1da472017-07-07 15:59:46 -0700488 }
Colin Cross1369cdb2017-09-29 17:58:17 -0700489 } else if j.deviceProperties.System_modules == nil {
490 ctx.PropertyErrorf("no_standard_libs",
491 "system_modules is required to be set when no_standard_libs is true, did you mean no_framework_libs?")
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100492 } else if *j.deviceProperties.System_modules != "none" {
Colin Cross42d48b72018-08-29 14:10:52 -0700493 ctx.AddVariationDependencies(nil, systemModulesTag, *j.deviceProperties.System_modules)
Colin Cross2fe66872015-03-30 17:20:39 -0700494 }
Mathew Inwoodebe29ce2018-09-04 14:26:19 +0100495 if (ctx.ModuleName() == "framework") || (ctx.ModuleName() == "framework-annotation-proc") {
Colin Cross42d48b72018-08-29 14:10:52 -0700496 ctx.AddVariationDependencies(nil, frameworkResTag, "framework-res")
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800497 }
Nan Zhangb2b33de2018-02-23 11:18:47 -0800498 if ctx.ModuleName() == "android_stubs_current" ||
499 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -0700500 ctx.ModuleName() == "android_test_stubs_current" {
Colin Cross42d48b72018-08-29 14:10:52 -0700501 ctx.AddVariationDependencies(nil, frameworkApkTag, "framework-res")
Nan Zhangb2b33de2018-02-23 11:18:47 -0800502 }
Colin Cross2fe66872015-03-30 17:20:39 -0700503 }
Colin Cross1369cdb2017-09-29 17:58:17 -0700504
Colin Cross42d48b72018-08-29 14:10:52 -0700505 ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
506 ctx.AddVariationDependencies(nil, staticLibTag, j.properties.Static_libs...)
Colin Crossa4f08812018-10-02 22:03:40 -0700507
Colin Crossbe9cdb82019-01-21 21:37:16 -0800508 ctx.AddFarVariationDependencies([]blueprint.Variation{
509 {Mutator: "arch", Variation: ctx.Config().BuildOsCommonVariant},
510 }, pluginTag, j.properties.Plugins...)
511
Colin Crossfe17f6f2019-03-28 19:30:56 -0700512 android.ProtoDeps(ctx, &j.protoProperties)
Colin Cross6af17aa2017-09-20 12:59:05 -0700513 if j.hasSrcExt(".proto") {
514 protoDeps(ctx, &j.protoProperties)
515 }
Colin Cross93e85952017-08-15 13:34:18 -0700516
517 if j.hasSrcExt(".kt") {
518 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
519 // Kotlin files
Colin Cross0b03d972019-05-13 11:06:25 -0700520 ctx.AddVariationDependencies(nil, kotlinStdlibTag,
521 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8")
Colin Cross7788c122019-01-23 16:14:02 -0800522 if len(j.properties.Plugins) > 0 {
Colin Crossafbb1732019-01-17 15:42:52 -0800523 ctx.AddVariationDependencies(nil, kotlinAnnotationsTag, "kotlin-annotations")
524 }
Colin Cross93e85952017-08-15 13:34:18 -0700525 }
Colin Cross3144dfc2018-01-03 15:06:47 -0800526
527 if j.shouldInstrumentStatic(ctx) {
Colin Cross42d48b72018-08-29 14:10:52 -0700528 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
Colin Cross3144dfc2018-01-03 15:06:47 -0800529 }
Colin Cross6af17aa2017-09-20 12:59:05 -0700530}
531
532func hasSrcExt(srcs []string, ext string) bool {
533 for _, src := range srcs {
534 if filepath.Ext(src) == ext {
535 return true
536 }
537 }
538
539 return false
540}
541
Nan Zhang61eaedb2017-11-02 13:28:15 -0700542func shardPaths(paths android.Paths, shardSize int) []android.Paths {
543 ret := make([]android.Paths, 0, (len(paths)+shardSize-1)/shardSize)
544 for len(paths) > shardSize {
545 ret = append(ret, paths[0:shardSize])
546 paths = paths[shardSize:]
547 }
548 if len(paths) > 0 {
549 ret = append(ret, paths)
550 }
551 return ret
552}
553
Colin Cross6af17aa2017-09-20 12:59:05 -0700554func (j *Module) hasSrcExt(ext string) bool {
555 return hasSrcExt(j.properties.Srcs, ext)
Colin Cross2fe66872015-03-30 17:20:39 -0700556}
557
Colin Cross46c9b8b2017-06-22 16:51:17 -0700558func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Colin Cross3047fa22019-04-18 10:56:44 -0700559 aidlIncludeDirs android.Paths) (string, android.Paths) {
Colin Crossc0b06f12015-04-08 13:03:43 -0700560
Colin Crossebe1a512017-11-14 13:12:14 -0800561 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
562 aidlIncludes = append(aidlIncludes,
563 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
564 aidlIncludes = append(aidlIncludes,
565 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
Colin Crossc0b06f12015-04-08 13:03:43 -0700566
Colin Cross3047fa22019-04-18 10:56:44 -0700567 var flags []string
568 var deps android.Paths
Steven Moreland667f6882018-07-26 12:55:08 -0700569
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700570 if aidlPreprocess.Valid() {
571 flags = append(flags, "-p"+aidlPreprocess.String())
Colin Cross3047fa22019-04-18 10:56:44 -0700572 deps = append(deps, aidlPreprocess.Path())
573 } else if len(aidlIncludeDirs) > 0 {
Colin Cross635c3b02016-05-18 15:37:25 -0700574 flags = append(flags, android.JoinWithPrefix(aidlIncludeDirs.Strings(), "-I"))
Colin Crossc0b06f12015-04-08 13:03:43 -0700575 }
576
Colin Cross3047fa22019-04-18 10:56:44 -0700577 if len(j.exportAidlIncludeDirs) > 0 {
578 flags = append(flags, android.JoinWithPrefix(j.exportAidlIncludeDirs.Strings(), "-I"))
579 }
580
581 if len(aidlIncludes) > 0 {
582 flags = append(flags, android.JoinWithPrefix(aidlIncludes.Strings(), "-I"))
583 }
584
Colin Cross635c3b02016-05-18 15:37:25 -0700585 flags = append(flags, "-I"+android.PathForModuleSrc(ctx).String())
Colin Cross32f38982018-02-22 11:47:25 -0800586 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Colin Crossd48633a2017-07-13 14:41:17 -0700587 flags = append(flags, "-I"+src.String())
588 }
Colin Crossc0b06f12015-04-08 13:03:43 -0700589
Martijn Coeneneab15642018-03-09 09:29:59 +0100590 if Bool(j.deviceProperties.Aidl.Generate_traces) {
591 flags = append(flags, "-t")
592 }
593
Olivier Gaillard0a4cfbc2018-07-16 23:37:03 +0100594 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
595 flags = append(flags, "--transaction_names")
596 }
597
Colin Cross3047fa22019-04-18 10:56:44 -0700598 return strings.Join(flags, " "), deps
Colin Crossc0b06f12015-04-08 13:03:43 -0700599}
600
Colin Cross32f676a2017-09-06 13:41:06 -0700601type deps struct {
Nan Zhang581fd212018-01-10 16:06:12 -0800602 classpath classpath
603 bootClasspath classpath
Colin Cross6a77c982018-06-19 22:43:34 -0700604 processorPath classpath
Colin Crossbe9cdb82019-01-21 21:37:16 -0800605 processorClasses []string
Colin Cross6ade34f2017-09-15 13:00:47 -0700606 staticJars android.Paths
Nan Zhanged19fc32017-10-19 13:06:22 -0700607 staticHeaderJars android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700608 staticResourceJars android.Paths
Colin Cross6ade34f2017-09-15 13:00:47 -0700609 aidlIncludeDirs android.Paths
Nan Zhangb2b33de2018-02-23 11:18:47 -0800610 srcs android.Paths
Colin Cross59149b62017-10-16 18:07:29 -0700611 srcJars android.Paths
Colin Cross1369cdb2017-09-29 17:58:17 -0700612 systemModules android.Path
Colin Cross6ade34f2017-09-15 13:00:47 -0700613 aidlPreprocess android.OptionalPath
Colin Cross93e85952017-08-15 13:34:18 -0700614 kotlinStdlib android.Paths
Colin Crossafbb1732019-01-17 15:42:52 -0800615 kotlinAnnotations android.Paths
Colin Crossbe9cdb82019-01-21 21:37:16 -0800616
617 disableTurbine bool
Colin Cross32f676a2017-09-06 13:41:06 -0700618}
Colin Cross2fe66872015-03-30 17:20:39 -0700619
Colin Cross54250902017-12-05 09:28:08 -0800620func checkProducesJars(ctx android.ModuleContext, dep android.SourceFileProducer) {
621 for _, f := range dep.Srcs() {
622 if f.Ext() != ".jar" {
623 ctx.ModuleErrorf("genrule %q must generate files ending with .jar to be used as a libs or static_libs dependency",
624 ctx.OtherModuleName(dep.(blueprint.Module)))
625 }
626 }
627}
628
Jiyong Park2d492942018-03-05 17:44:10 +0900629type linkType int
630
631const (
632 javaCore linkType = iota
633 javaSdk
634 javaSystem
635 javaPlatform
636)
637
Jiyong Park46f78fb2018-10-20 16:33:17 +0900638func getLinkType(m *Module, name string) (ret linkType, stubs bool) {
Colin Cross83bb3162018-06-25 15:48:06 -0700639 ver := m.sdkVersion()
Colin Crossf19b9bb2018-03-26 14:42:44 -0700640 switch {
Jiyong Park46f78fb2018-10-20 16:33:17 +0900641 case name == "core.current.stubs" || name == "core.platform.api.stubs" ||
642 name == "stub-annotations" || name == "private-stub-annotations-jar" ||
Pete Gillincbff3262019-05-08 15:10:06 +0100643 name == "core-lambda-stubs" || name == "core-generated-annotation-stubs":
Jiyong Park46f78fb2018-10-20 16:33:17 +0900644 return javaCore, true
Neil Fuller401eeba2018-10-18 19:48:58 +0100645 case ver == "core_current":
Jiyong Park46f78fb2018-10-20 16:33:17 +0900646 return javaCore, false
647 case name == "android_system_stubs_current":
648 return javaSystem, true
649 case strings.HasPrefix(ver, "system_"):
650 return javaSystem, false
651 case name == "android_test_stubs_current":
652 return javaSystem, true
653 case strings.HasPrefix(ver, "test_"):
654 return javaPlatform, false
655 case name == "android_stubs_current":
656 return javaSdk, true
657 case ver == "current":
658 return javaSdk, false
Colin Crossf19b9bb2018-03-26 14:42:44 -0700659 case ver == "":
Jiyong Park46f78fb2018-10-20 16:33:17 +0900660 return javaPlatform, false
Colin Crossf19b9bb2018-03-26 14:42:44 -0700661 default:
662 if _, err := strconv.Atoi(ver); err != nil {
663 panic(fmt.Errorf("expected sdk_version to be a number, got %q", ver))
664 }
Jiyong Park46f78fb2018-10-20 16:33:17 +0900665 return javaSdk, false
Jiyong Park2d492942018-03-05 17:44:10 +0900666 }
667}
668
Jiyong Park750e5572018-01-31 00:20:13 +0900669func checkLinkType(ctx android.ModuleContext, from *Module, to *Library, tag dependencyTag) {
Colin Crossf19b9bb2018-03-26 14:42:44 -0700670 if ctx.Host() {
671 return
672 }
673
Jiyong Park46f78fb2018-10-20 16:33:17 +0900674 myLinkType, stubs := getLinkType(from, ctx.ModuleName())
675 if stubs {
676 return
677 }
678 otherLinkType, _ := getLinkType(&to.Module, ctx.OtherModuleName(to))
Jiyong Park2d492942018-03-05 17:44:10 +0900679 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."
680
681 switch myLinkType {
682 case javaCore:
683 if otherLinkType != javaCore {
684 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 +0900685 ctx.OtherModuleName(to))
686 }
Jiyong Park2d492942018-03-05 17:44:10 +0900687 break
688 case javaSdk:
689 if otherLinkType != javaCore && otherLinkType != javaSdk {
690 ctx.ModuleErrorf("compiles against Android API, but dependency %q is compiling against non-public Android API."+commonMessage,
691 ctx.OtherModuleName(to))
692 }
693 break
694 case javaSystem:
695 if otherLinkType == javaPlatform {
696 ctx.ModuleErrorf("compiles against system API, but dependency %q is compiling against private API."+commonMessage,
697 ctx.OtherModuleName(to))
698 }
699 break
700 case javaPlatform:
701 // no restriction on link-type
702 break
Jiyong Park750e5572018-01-31 00:20:13 +0900703 }
704}
705
Colin Cross32f676a2017-09-06 13:41:06 -0700706func (j *Module) collectDeps(ctx android.ModuleContext) deps {
707 var deps deps
Colin Crossfc3674a2017-09-18 17:41:52 -0700708
Colin Cross300f0382018-03-06 13:11:51 -0800709 if ctx.Device() {
Colin Cross83bb3162018-06-25 15:48:06 -0700710 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Cross300f0382018-03-06 13:11:51 -0800711 if sdkDep.invalidVersion {
Colin Cross86a60ae2018-05-29 14:44:55 -0700712 ctx.AddMissingDependencies(sdkDep.modules)
Colin Cross300f0382018-03-06 13:11:51 -0800713 } else if sdkDep.useFiles {
714 // sdkDep.jar is actually equivalent to turbine header.jar.
Colin Cross86a60ae2018-05-29 14:44:55 -0700715 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross3047fa22019-04-18 10:56:44 -0700716 deps.aidlPreprocess = sdkDep.aidl
717 } else {
718 deps.aidlPreprocess = sdkDep.aidl
Colin Cross300f0382018-03-06 13:11:51 -0800719 }
Colin Crossfc3674a2017-09-18 17:41:52 -0700720 }
721
Colin Crossd11fcda2017-10-23 17:59:01 -0700722 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross2fe66872015-03-30 17:20:39 -0700723 otherName := ctx.OtherModuleName(module)
Colin Crossec7a0422017-07-07 14:47:12 -0700724 tag := ctx.OtherModuleDependencyTag(module)
725
Colin Crossa4f08812018-10-02 22:03:40 -0700726 if _, ok := tag.(*jniDependencyTag); ok {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700727 // Handled by AndroidApp.collectAppDeps
728 return
729 }
730 if tag == certificateTag {
731 // Handled by AndroidApp.collectAppDeps
Colin Crossa4f08812018-10-02 22:03:40 -0700732 return
733 }
734
Jiyong Park750e5572018-01-31 00:20:13 +0900735 if to, ok := module.(*Library); ok {
Colin Crossa97c5d32018-03-28 14:58:31 -0700736 switch tag {
737 case bootClasspathTag, libTag, staticLibTag:
738 checkLinkType(ctx, j, to, tag.(dependencyTag))
739 }
Jiyong Park750e5572018-01-31 00:20:13 +0900740 }
Colin Cross54250902017-12-05 09:28:08 -0800741 switch dep := module.(type) {
Colin Cross897d2ed2019-02-11 14:03:51 -0800742 case SdkLibraryDependency:
743 switch tag {
744 case libTag:
745 deps.classpath = append(deps.classpath, dep.SdkHeaderJars(ctx, j.sdkVersion())...)
746 // names of sdk libs that are directly depended are exported
747 j.exportedSdkLibs = append(j.exportedSdkLibs, otherName)
Colin Cross79c7c262019-04-17 11:11:46 -0700748 case staticLibTag:
Colin Cross897d2ed2019-02-11 14:03:51 -0800749 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
750 }
Colin Cross54250902017-12-05 09:28:08 -0800751 case Dependency:
752 switch tag {
753 case bootClasspathTag:
754 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars()...)
Colin Cross4b964c02018-10-15 16:18:06 -0700755 case libTag, instrumentationForTag:
Colin Cross54250902017-12-05 09:28:08 -0800756 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +0900757 // sdk lib names from dependencies are re-exported
758 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -0700759 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Colin Cross54250902017-12-05 09:28:08 -0800760 case staticLibTag:
761 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
762 deps.staticJars = append(deps.staticJars, dep.ImplementationJars()...)
763 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars()...)
Colin Cross331a1212018-08-15 20:40:52 -0700764 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +0900765 // sdk lib names from dependencies are re-exported
766 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -0700767 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Colin Crossbe9cdb82019-01-21 21:37:16 -0800768 case pluginTag:
769 if plugin, ok := dep.(*Plugin); ok {
770 deps.processorPath = append(deps.processorPath, dep.ImplementationAndResourcesJars()...)
771 if plugin.pluginProperties.Processor_class != nil {
772 deps.processorClasses = append(deps.processorClasses, *plugin.pluginProperties.Processor_class)
773 }
774 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
775 } else {
776 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
777 }
Colin Cross54250902017-12-05 09:28:08 -0800778 case frameworkResTag:
Mathew Inwoodebe29ce2018-09-04 14:26:19 +0100779 if (ctx.ModuleName() == "framework") || (ctx.ModuleName() == "framework-annotation-proc") {
Colin Cross54250902017-12-05 09:28:08 -0800780 // framework.jar has a one-off dependency on the R.java and Manifest.java files
781 // generated by framework-res.apk
782 deps.srcJars = append(deps.srcJars, dep.(*AndroidApp).aaptSrcJar)
783 }
Nan Zhangb2b33de2018-02-23 11:18:47 -0800784 case frameworkApkTag:
785 if ctx.ModuleName() == "android_stubs_current" ||
786 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -0700787 ctx.ModuleName() == "android_test_stubs_current" {
Nan Zhangb2b33de2018-02-23 11:18:47 -0800788 // framework stubs.jar need to depend on framework-res.apk, in order to pull the
789 // resource files out of there for aapt.
790 //
791 // Normally the package rule runs aapt, which includes the resource,
792 // but we're not running that in our package rule so just copy in the
793 // resource files here.
Colin Cross331a1212018-08-15 20:40:52 -0700794 deps.staticResourceJars = append(deps.staticResourceJars, dep.(*AndroidApp).exportPackage)
Nan Zhangb2b33de2018-02-23 11:18:47 -0800795 }
Colin Cross54250902017-12-05 09:28:08 -0800796 case kotlinStdlibTag:
Colin Cross0b03d972019-05-13 11:06:25 -0700797 deps.kotlinStdlib = append(deps.kotlinStdlib, dep.HeaderJars()...)
Colin Crossafbb1732019-01-17 15:42:52 -0800798 case kotlinAnnotationsTag:
799 deps.kotlinAnnotations = dep.HeaderJars()
Colin Cross54250902017-12-05 09:28:08 -0800800 }
801
Colin Cross54250902017-12-05 09:28:08 -0800802 case android.SourceFileProducer:
803 switch tag {
804 case libTag:
805 checkProducesJars(ctx, dep)
806 deps.classpath = append(deps.classpath, dep.Srcs()...)
807 case staticLibTag:
808 checkProducesJars(ctx, dep)
809 deps.classpath = append(deps.classpath, dep.Srcs()...)
810 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
811 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Cross54250902017-12-05 09:28:08 -0800812 }
813 default:
Colin Crossec7a0422017-07-07 14:47:12 -0700814 switch tag {
815 case android.DefaultsDepTag, android.SourceDepTag:
Dan Willemsend6ba0d52017-09-13 15:46:47 -0700816 // Nothing to do
Colin Cross1369cdb2017-09-29 17:58:17 -0700817 case systemModulesTag:
818 if deps.systemModules != nil {
819 panic("Found two system module dependencies")
820 }
821 sm := module.(*SystemModules)
822 if sm.outputFile == nil {
823 panic("Missing directory for system module dependency")
824 }
825 deps.systemModules = sm.outputFile
Colin Crossec7a0422017-07-07 14:47:12 -0700826 default:
827 ctx.ModuleErrorf("depends on non-java module %q", otherName)
Colin Cross2fe66872015-03-30 17:20:39 -0700828 }
Colin Crossec7a0422017-07-07 14:47:12 -0700829 }
Colin Cross2fe66872015-03-30 17:20:39 -0700830 })
831
Jiyong Park1be96912018-05-28 18:02:19 +0900832 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
833
Colin Cross32f676a2017-09-06 13:41:06 -0700834 return deps
Colin Cross2fe66872015-03-30 17:20:39 -0700835}
836
Colin Cross83bb3162018-06-25 15:48:06 -0700837func getJavaVersion(ctx android.ModuleContext, javaVersion string, sdkContext sdkContext) string {
Nan Zhang357466b2018-04-17 17:38:36 -0700838 var ret string
Colin Cross98fd5742019-01-09 23:04:25 -0800839 v := sdkContext.sdkVersion()
840 // For PDK builds, use the latest SDK version instead of "current"
841 if ctx.Config().IsPdkBuild() && (v == "" || v == "current") {
Colin Cross3047fa22019-04-18 10:56:44 -0700842 sdkVersions := ctx.Config().Get(sdkVersionsKey).([]int)
Colin Cross98fd5742019-01-09 23:04:25 -0800843 latestSdkVersion := 0
844 if len(sdkVersions) > 0 {
845 latestSdkVersion = sdkVersions[len(sdkVersions)-1]
846 }
847 v = strconv.Itoa(latestSdkVersion)
848 }
849
850 sdk, err := sdkVersionToNumber(ctx, v)
Colin Cross83bb3162018-06-25 15:48:06 -0700851 if err != nil {
852 ctx.PropertyErrorf("sdk_version", "%s", err)
853 }
Nan Zhang357466b2018-04-17 17:38:36 -0700854 if javaVersion != "" {
855 ret = javaVersion
856 } else if ctx.Device() && sdk <= 23 {
857 ret = "1.7"
Pete Gillin9c640142019-05-20 15:44:53 +0100858 } else if ctx.Device() && sdk <= 29 || !ctx.Config().TargetOpenJDK9() {
Nan Zhang357466b2018-04-17 17:38:36 -0700859 ret = "1.8"
Colin Cross83bb3162018-06-25 15:48:06 -0700860 } else if ctx.Device() && sdkContext.sdkVersion() != "" && sdk == android.FutureApiLevel {
Nan Zhang357466b2018-04-17 17:38:36 -0700861 // TODO(ccross): once we generate stubs we should be able to use 1.9 for sdk_version: "current"
862 ret = "1.8"
863 } else {
864 ret = "1.9"
865 }
866
867 return ret
868}
869
Nan Zhanged19fc32017-10-19 13:06:22 -0700870func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
Colin Crossc0b06f12015-04-08 13:03:43 -0700871
Colin Crossf03c82b2015-04-13 13:53:40 -0700872 var flags javaBuilderFlags
873
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100874 // javaVersion flag.
875 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), sdkContext(j))
876
Nan Zhanged19fc32017-10-19 13:06:22 -0700877 // javac flags.
Colin Crossf03c82b2015-04-13 13:53:40 -0700878 javacFlags := j.properties.Javacflags
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100879 if flags.javaVersion == "1.9" {
Colin Cross1369cdb2017-09-29 17:58:17 -0700880 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Nan Zhanged19fc32017-10-19 13:06:22 -0700881 }
Colin Cross6510f912017-11-29 00:27:14 -0800882 if ctx.Config().MinimizeJavaDebugInfo() {
Colin Cross126a25c2017-10-31 13:55:34 -0700883 // Override the -g flag passed globally to remove local variable debug info to reduce
884 // disk and memory usage.
885 javacFlags = append(javacFlags, "-g:source,lines")
886 }
Colin Cross64162712017-08-08 13:17:59 -0700887
Colin Cross66548102018-06-19 22:47:35 -0700888 if ctx.Config().RunErrorProne() {
889 if config.ErrorProneClasspath == nil {
890 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
891 }
892
893 errorProneFlags := []string{
894 "-Xplugin:ErrorProne",
895 "${config.ErrorProneChecks}",
896 }
897 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
898
899 flags.errorProneExtraJavacFlags = "${config.ErrorProneFlags} " +
900 "'" + strings.Join(errorProneFlags, " ") + "'"
901 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
Andreas Gampef3e5b552018-01-22 21:27:21 -0800902 }
903
Nan Zhanged19fc32017-10-19 13:06:22 -0700904 // classpath
Nan Zhang581fd212018-01-10 16:06:12 -0800905 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
906 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross6a77c982018-06-19 22:43:34 -0700907 flags.processorPath = append(flags.processorPath, deps.processorPath...)
Colin Cross7fdd2b72018-01-02 18:14:25 -0800908
Colin Crossbe9cdb82019-01-21 21:37:16 -0800909 flags.processor = strings.Join(deps.processorClasses, ",")
910
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100911 if len(flags.bootClasspath) == 0 && ctx.Host() && flags.javaVersion != "1.9" &&
Colin Cross7fdd2b72018-01-02 18:14:25 -0800912 !Bool(j.properties.No_standard_libs) &&
913 inList(flags.javaVersion, []string{"1.6", "1.7", "1.8"}) {
914 // Give host-side tools a version of OpenJDK's standard libraries
915 // close to what they're targeting. As of Dec 2017, AOSP is only
916 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
917 //
918 // When building with OpenJDK 8, the following should have no
919 // effect since those jars would be available by default.
920 //
921 // When building with OpenJDK 9 but targeting a version < 1.8,
922 // putting them on the bootclasspath means that:
923 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
924 // b) references to existing APIs are not reinterpreted in an
925 // OpenJDK 9-specific way, eg. calls to subclasses of
926 // java.nio.Buffer as in http://b/70862583
927 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
928 flags.bootClasspath = append(flags.bootClasspath,
929 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
930 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
Nan Zhang5f8cb422018-02-06 10:34:32 -0800931 if Bool(j.properties.Use_tools_jar) {
932 flags.bootClasspath = append(flags.bootClasspath,
933 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
934 }
Colin Cross7fdd2b72018-01-02 18:14:25 -0800935 }
936
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100937 if j.properties.Patch_module != nil && flags.javaVersion == "1.9" {
Jaewoong Jung38e4fb22018-12-12 09:01:34 -0800938 // Manually specify build directory in case it is not under the repo root.
939 // (javac doesn't seem to expand into symbolc links when searching for patch-module targets, so
940 // just adding a symlink under the root doesn't help.)
941 patchPaths := ".:" + ctx.Config().BuildDir()
942 classPath := flags.classpath.FormJavaClassPath("")
943 if classPath != "" {
944 patchPaths += ":" + classPath
945 }
946 javacFlags = append(javacFlags, "--patch-module="+String(j.properties.Patch_module)+"="+patchPaths)
Colin Cross81440082018-08-15 20:21:55 -0700947 }
948
Nan Zhanged19fc32017-10-19 13:06:22 -0700949 // systemModules
Colin Cross1369cdb2017-09-29 17:58:17 -0700950 if deps.systemModules != nil {
951 flags.systemModules = append(flags.systemModules, deps.systemModules)
952 }
953
Nan Zhanged19fc32017-10-19 13:06:22 -0700954 // aidl flags.
Colin Cross3047fa22019-04-18 10:56:44 -0700955 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs)
Colin Cross2fe66872015-03-30 17:20:39 -0700956
Colin Cross81440082018-08-15 20:21:55 -0700957 if len(javacFlags) > 0 {
958 // optimization.
959 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
960 flags.javacFlags = "$javacFlags"
961 }
962
Nan Zhanged19fc32017-10-19 13:06:22 -0700963 return flags
964}
Colin Crossc0b06f12015-04-08 13:03:43 -0700965
Jaewoong Junga24af3b2019-05-13 09:23:20 -0700966func (j *Module) compile(ctx android.ModuleContext, aaptSrcJar android.Path) {
967
968 hasSrcs := false
Nan Zhanged19fc32017-10-19 13:06:22 -0700969
Colin Crossebe1a512017-11-14 13:12:14 -0800970 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
Nan Zhanged19fc32017-10-19 13:06:22 -0700971
972 deps := j.collectDeps(ctx)
973 flags := j.collectBuilderFlags(ctx, deps)
974
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100975 if flags.javaVersion == "1.9" {
Nan Zhanged19fc32017-10-19 13:06:22 -0700976 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
977 }
Colin Cross8a497952019-03-05 22:25:09 -0800978 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Colin Cross6af17aa2017-09-20 12:59:05 -0700979 if hasSrcExt(srcFiles.Strings(), ".proto") {
Colin Cross0f2ee152017-12-14 15:22:43 -0800980 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
Colin Cross6af17aa2017-09-20 12:59:05 -0700981 }
982
Colin Crossaf050172017-11-15 23:01:59 -0800983 srcFiles = j.genSources(ctx, srcFiles, flags)
Jaewoong Junga24af3b2019-05-13 09:23:20 -0700984 if len(srcFiles) > 0 {
985 hasSrcs = true
986 }
Colin Crossaf050172017-11-15 23:01:59 -0800987
988 srcJars := srcFiles.FilterByExt(".srcjar")
Colin Cross59149b62017-10-16 18:07:29 -0700989 srcJars = append(srcJars, deps.srcJars...)
Jaewoong Junga24af3b2019-05-13 09:23:20 -0700990 if aaptSrcJar != nil {
991 srcJars = append(srcJars, aaptSrcJar)
992 }
Colin Crossb7a63242015-04-16 14:09:14 -0700993
Brandon Lee5d45c6f2018-08-15 15:35:38 -0700994 // Collect source files from compiledJavaSrcs, compiledSrcJars and filter out Exclude_srcs
995 // that IDEInfo struct will use
996 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, srcFiles.Strings()...)
997
Steven Morelandc4efd9c2019-01-18 11:51:25 -0800998 if j.properties.Jarjar_rules != nil {
Colin Cross8a497952019-03-05 22:25:09 -0800999 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001000 }
1001
Colin Cross1ee23172017-10-18 14:44:18 -07001002 jarName := ctx.ModuleName() + ".jar"
1003
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001004 javaSrcFiles := srcFiles.FilterByExt(".java")
1005 var uniqueSrcFiles android.Paths
1006 set := make(map[string]bool)
1007 for _, v := range javaSrcFiles {
1008 if _, found := set[v.String()]; !found {
1009 set[v.String()] = true
1010 uniqueSrcFiles = append(uniqueSrcFiles, v)
1011 }
1012 }
1013
Colin Cross55f63ea2018-08-27 12:37:09 -07001014 var kotlinJars android.Paths
1015
Colin Cross93e85952017-08-15 13:34:18 -07001016 if srcFiles.HasExt(".kt") {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001017 // user defined kotlin flags.
1018 kotlincFlags := j.properties.Kotlincflags
1019 CheckKotlincFlags(ctx, kotlincFlags)
1020
Colin Cross93e85952017-08-15 13:34:18 -07001021 // If there are kotlin files, compile them first but pass all the kotlin and java files
1022 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1023 // won't emit any classes for them.
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001024 kotlincFlags = append(kotlincFlags, "-no-stdlib")
Colin Cross93e85952017-08-15 13:34:18 -07001025 if ctx.Device() {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001026 kotlincFlags = append(kotlincFlags, "-no-jdk")
1027 }
1028 if len(kotlincFlags) > 0 {
1029 // optimization.
1030 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1031 flags.kotlincFlags += "$kotlincFlags"
Colin Cross93e85952017-08-15 13:34:18 -07001032 }
1033
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001034 var kotlinSrcFiles android.Paths
1035 kotlinSrcFiles = append(kotlinSrcFiles, uniqueSrcFiles...)
1036 kotlinSrcFiles = append(kotlinSrcFiles, srcFiles.FilterByExt(".kt")...)
1037
Colin Crossafbb1732019-01-17 15:42:52 -08001038 flags.classpath = append(flags.classpath, deps.kotlinStdlib...)
1039 flags.classpath = append(flags.classpath, deps.kotlinAnnotations...)
1040
1041 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1042 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1043
1044 if len(flags.processorPath) > 0 {
1045 // Use kapt for annotation processing
1046 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1047 kotlinKapt(ctx, kaptSrcJar, kotlinSrcFiles, srcJars, flags)
1048 srcJars = append(srcJars, kaptSrcJar)
1049 // Disable annotation processing in javac, it's already been handled by kapt
1050 flags.processorPath = nil
Colin Cross3a3e94c2019-01-23 15:39:50 -08001051 flags.processor = ""
Colin Crossafbb1732019-01-17 15:42:52 -08001052 }
Colin Cross93e85952017-08-15 13:34:18 -07001053
Colin Cross1ee23172017-10-18 14:44:18 -07001054 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross21fc9bb2019-01-18 15:05:09 -08001055 kotlinCompile(ctx, kotlinJar, kotlinSrcFiles, srcJars, flags)
Colin Cross93e85952017-08-15 13:34:18 -07001056 if ctx.Failed() {
1057 return
1058 }
1059
1060 // Make javac rule depend on the kotlinc rule
1061 flags.classpath = append(flags.classpath, kotlinJar)
Przemyslaw Szczepaniak66c0c402018-03-08 13:21:55 +00001062
Colin Cross93e85952017-08-15 13:34:18 -07001063 // Jar kotlin classes into the final jar after javac
Colin Cross55f63ea2018-08-27 12:37:09 -07001064 kotlinJars = append(kotlinJars, kotlinJar)
Colin Cross9b38aef2018-08-27 15:42:25 -07001065 kotlinJars = append(kotlinJars, deps.kotlinStdlib...)
Colin Cross93e85952017-08-15 13:34:18 -07001066 }
1067
Colin Cross55f63ea2018-08-27 12:37:09 -07001068 jars := append(android.Paths(nil), kotlinJars...)
1069
Colin Cross5ab4e6d2017-11-22 16:20:45 -08001070 // Store the list of .java files that was passed to javac
1071 j.compiledJavaSrcs = uniqueSrcFiles
1072 j.compiledSrcJars = srcJars
1073
Nan Zhang61eaedb2017-11-02 13:28:15 -07001074 enable_sharding := false
Colin Crossbe9cdb82019-01-21 21:37:16 -08001075 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !deps.disableTurbine {
Nan Zhang61eaedb2017-11-02 13:28:15 -07001076 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1077 enable_sharding = true
Ashley Rosee36efcf2019-01-16 17:34:08 -05001078 // Formerly, there was a check here that prevented annotation processors
1079 // from being used when sharding was enabled, as some annotation processors
1080 // do not function correctly in sharded environments. It was removed to
1081 // allow for the use of annotation processors that do function correctly
1082 // with sharding enabled. See: b/77284273.
Nan Zhang61eaedb2017-11-02 13:28:15 -07001083 }
Colin Cross55f63ea2018-08-27 12:37:09 -07001084 j.headerJarFile = j.compileJavaHeader(ctx, uniqueSrcFiles, srcJars, deps, flags, jarName, kotlinJars)
Colin Crossf19b9bb2018-03-26 14:42:44 -07001085 if ctx.Failed() {
1086 return
Nan Zhanged19fc32017-10-19 13:06:22 -07001087 }
1088 }
Colin Cross8eadbf02017-10-24 17:46:00 -07001089 if len(uniqueSrcFiles) > 0 || len(srcJars) > 0 {
Colin Crossd6891432017-09-27 17:39:56 -07001090 var extraJarDeps android.Paths
Colin Cross66548102018-06-19 22:47:35 -07001091 if ctx.Config().RunErrorProne() {
Colin Crossc6bbef32017-08-14 14:16:06 -07001092 // If error-prone is enabled, add an additional rule to compile the java files into
1093 // a separate set of classes (so that they don't overwrite the normal ones and require
Colin Crossd6891432017-09-27 17:39:56 -07001094 // a rebuild when error-prone is turned off).
Colin Crossc6bbef32017-08-14 14:16:06 -07001095 // TODO(ccross): Once we always compile with javac9 we may be able to conditionally
1096 // enable error-prone without affecting the output class files.
Colin Cross1ee23172017-10-18 14:44:18 -07001097 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001098 RunErrorProne(ctx, errorprone, uniqueSrcFiles, srcJars, flags)
Colin Crossc6bbef32017-08-14 14:16:06 -07001099 extraJarDeps = append(extraJarDeps, errorprone)
1100 }
1101
Nan Zhang61eaedb2017-11-02 13:28:15 -07001102 if enable_sharding {
Nan Zhang581fd212018-01-10 16:06:12 -08001103 flags.classpath = append(flags.classpath, j.headerJarFile)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001104 shardSize := int(*(j.properties.Javac_shard_size))
1105 var shardSrcs []android.Paths
1106 if len(uniqueSrcFiles) > 0 {
1107 shardSrcs = shardPaths(uniqueSrcFiles, shardSize)
1108 for idx, shardSrc := range shardSrcs {
1109 classes := android.PathForModuleOut(ctx, "javac", jarName+strconv.Itoa(idx))
1110 TransformJavaToClasses(ctx, classes, idx, shardSrc, nil, flags, extraJarDeps)
1111 jars = append(jars, classes)
1112 }
1113 }
1114 if len(srcJars) > 0 {
1115 classes := android.PathForModuleOut(ctx, "javac", jarName+strconv.Itoa(len(shardSrcs)))
1116 TransformJavaToClasses(ctx, classes, len(shardSrcs), nil, srcJars, flags, extraJarDeps)
1117 jars = append(jars, classes)
1118 }
1119 } else {
1120 classes := android.PathForModuleOut(ctx, "javac", jarName)
1121 TransformJavaToClasses(ctx, classes, -1, uniqueSrcFiles, srcJars, flags, extraJarDeps)
1122 jars = append(jars, classes)
1123 }
Colin Crossd6891432017-09-27 17:39:56 -07001124 if ctx.Failed() {
1125 return
1126 }
Colin Cross2fe66872015-03-30 17:20:39 -07001127 }
1128
Colin Cross0c4ce212019-05-03 15:28:19 -07001129 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1130
1131 var includeSrcJar android.WritablePath
1132 if Bool(j.properties.Include_srcs) {
1133 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1134 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1135 }
1136
Colin Crosscedd4762018-09-13 11:26:19 -07001137 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1138 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
Colin Cross0f37af02017-09-27 17:42:05 -07001139 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
Colin Cross988708c2019-05-06 14:04:11 -07001140 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
Colin Cross0f37af02017-09-27 17:42:05 -07001141
1142 var resArgs []string
1143 var resDeps android.Paths
1144
1145 resArgs = append(resArgs, dirArgs...)
1146 resDeps = append(resDeps, dirDeps...)
1147
1148 resArgs = append(resArgs, fileArgs...)
1149 resDeps = append(resDeps, fileDeps...)
1150
Colin Cross988708c2019-05-06 14:04:11 -07001151 resArgs = append(resArgs, extraArgs...)
1152 resDeps = append(resDeps, extraDeps...)
1153
Colin Cross40a36712017-09-27 17:41:35 -07001154 if len(resArgs) > 0 {
Colin Cross1ee23172017-10-18 14:44:18 -07001155 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
Colin Crosse9a275b2017-10-16 17:09:48 -07001156 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Colin Cross331a1212018-08-15 20:40:52 -07001157 j.resourceJar = resourceJar
Colin Cross65bf4f22015-04-03 16:54:17 -07001158 if ctx.Failed() {
1159 return
1160 }
1161 }
1162
Colin Cross0c4ce212019-05-03 15:28:19 -07001163 var resourceJars android.Paths
1164 if j.resourceJar != nil {
1165 resourceJars = append(resourceJars, j.resourceJar)
1166 }
1167 if Bool(j.properties.Include_srcs) {
1168 resourceJars = append(resourceJars, includeSrcJar)
1169 }
1170 resourceJars = append(resourceJars, deps.staticResourceJars...)
Colin Cross331a1212018-08-15 20:40:52 -07001171
Colin Cross0c4ce212019-05-03 15:28:19 -07001172 if len(resourceJars) > 1 {
Colin Cross331a1212018-08-15 20:40:52 -07001173 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
Colin Cross0c4ce212019-05-03 15:28:19 -07001174 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
Colin Cross331a1212018-08-15 20:40:52 -07001175 false, nil, nil)
1176 j.resourceJar = combinedJar
Colin Cross0c4ce212019-05-03 15:28:19 -07001177 } else if len(resourceJars) == 1 {
1178 j.resourceJar = resourceJars[0]
Colin Cross331a1212018-08-15 20:40:52 -07001179 }
1180
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001181 if len(deps.staticJars) > 0 {
1182 jars = append(jars, deps.staticJars...)
1183 hasSrcs = true
1184 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001185
Colin Cross094054a2018-10-17 15:10:48 -07001186 manifest := j.overrideManifest
1187 if !manifest.Valid() && j.properties.Manifest != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001188 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Colin Cross366938f2017-12-11 16:29:02 -08001189 }
Colin Cross635acc92017-09-12 22:50:46 -07001190
Colin Cross8a497952019-03-05 22:25:09 -08001191 services := android.PathsForModuleSrc(ctx, j.properties.Services)
Alex Light7f004a72019-02-21 13:27:37 -08001192 if len(services) > 0 {
1193 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1194 var zipargs []string
1195 for _, file := range services {
1196 serviceFile := file.String()
1197 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1198 }
1199 ctx.Build(pctx, android.BuildParams{
1200 Rule: zip,
1201 Output: servicesJar,
1202 Implicits: services,
1203 Args: map[string]string{
Colin Cross0b9f31f2019-02-28 11:00:01 -08001204 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
Alex Light7f004a72019-02-21 13:27:37 -08001205 },
1206 })
1207 jars = append(jars, servicesJar)
1208 }
1209
Colin Cross0a6e0072017-08-30 14:24:55 -07001210 // Combine the classes built from sources, any manifests, and any static libraries into
Nan Zhanged19fc32017-10-19 13:06:22 -07001211 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross3063b782018-08-15 11:19:12 -07001212 var outputFile android.ModuleOutPath
Colin Crosse9a275b2017-10-16 17:09:48 -07001213
1214 if len(jars) == 1 && !manifest.Valid() {
Colin Cross3063b782018-08-15 11:19:12 -07001215 if moduleOutPath, ok := jars[0].(android.ModuleOutPath); ok {
1216 // Optimization: skip the combine step if there is nothing to do
1217 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1218 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1219 // any if len(jars) == 1.
1220 outputFile = moduleOutPath
1221 } else {
1222 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1223 ctx.Build(pctx, android.BuildParams{
1224 Rule: android.Cp,
1225 Input: jars[0],
1226 Output: combinedJar,
1227 })
1228 outputFile = combinedJar
1229 }
Colin Crosse9a275b2017-10-16 17:09:48 -07001230 } else {
Colin Cross1ee23172017-10-18 14:44:18 -07001231 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001232 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
Colin Cross9b38aef2018-08-27 15:42:25 -07001233 false, nil, nil)
Colin Crosse9a275b2017-10-16 17:09:48 -07001234 outputFile = combinedJar
1235 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001236
Colin Cross331a1212018-08-15 20:40:52 -07001237 // jarjar implementation jar if necessary
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001238 if j.expandJarjarRules != nil {
Colin Cross8649b262017-09-27 18:03:17 -07001239 // Transform classes.jar into classes-jarjar.jar
Colin Cross1ee23172017-10-18 14:44:18 -07001240 jarjarFile := android.PathForModuleOut(ctx, "jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001241 TransformJarJar(ctx, jarjarFile, outputFile, j.expandJarjarRules)
Colin Crosse9a275b2017-10-16 17:09:48 -07001242 outputFile = jarjarFile
Colin Cross331a1212018-08-15 20:40:52 -07001243
1244 // jarjar resource jar if necessary
1245 if j.resourceJar != nil {
1246 resourceJarJarFile := android.PathForModuleOut(ctx, "res-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001247 TransformJarJar(ctx, resourceJarJarFile, j.resourceJar, j.expandJarjarRules)
Colin Cross331a1212018-08-15 20:40:52 -07001248 j.resourceJar = resourceJarJarFile
1249 }
1250
Colin Cross0a6e0072017-08-30 14:24:55 -07001251 if ctx.Failed() {
1252 return
1253 }
1254 }
Vladimir Marko0975ee02019-04-02 10:29:55 +01001255
1256 // Check package restrictions if necessary.
1257 if len(j.properties.Permitted_packages) > 0 {
1258 // Check packages and copy to package-checked file.
1259 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
1260 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
1261 j.additionalCheckedModules = append(j.additionalCheckedModules, pkgckFile)
1262
1263 if ctx.Failed() {
1264 return
1265 }
1266 }
1267
Nan Zhanged19fc32017-10-19 13:06:22 -07001268 j.implementationJarFile = outputFile
1269 if j.headerJarFile == nil {
1270 j.headerJarFile = j.implementationJarFile
1271 }
Colin Cross2fe66872015-03-30 17:20:39 -07001272
Colin Cross6510f912017-11-29 00:27:14 -08001273 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
Colin Crosscb933592017-11-22 13:49:43 -08001274 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
1275 j.properties.Instrument = true
1276 }
1277 }
1278
Colin Cross3144dfc2018-01-03 15:06:47 -08001279 if j.shouldInstrument(ctx) {
Colin Crosscb933592017-11-22 13:49:43 -08001280 outputFile = j.instrument(ctx, flags, outputFile, jarName)
1281 }
1282
Colin Cross331a1212018-08-15 20:40:52 -07001283 // merge implementation jar with resources if necessary
1284 implementationAndResourcesJar := outputFile
1285 if j.resourceJar != nil {
Colin Cross08a409d2019-04-29 10:22:44 -07001286 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
Colin Cross331a1212018-08-15 20:40:52 -07001287 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
Colin Cross08a409d2019-04-29 10:22:44 -07001288 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
Colin Cross331a1212018-08-15 20:40:52 -07001289 false, nil, nil)
1290 implementationAndResourcesJar = combinedJar
1291 }
1292
1293 j.implementationAndResourcesJar = implementationAndResourcesJar
1294
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001295 if ctx.Device() && hasSrcs &&
1296 (Bool(j.properties.Installable) || Bool(j.deviceProperties.Compile_dex)) {
Colin Cross8faf8fc2019-01-16 15:15:52 -08001297 // Dex compilation
Colin Cross3063b782018-08-15 11:19:12 -07001298 var dexOutputFile android.ModuleOutPath
David Brazdil17ef5632018-06-27 10:27:45 +01001299 dexOutputFile = j.compileDex(ctx, flags, outputFile, jarName)
Colin Cross2fe66872015-03-30 17:20:39 -07001300 if ctx.Failed() {
1301 return
1302 }
Colin Cross331a1212018-08-15 20:40:52 -07001303
Colin Cross9c74a1e2019-05-28 14:06:17 -07001304 if !ctx.Config().UnbundledBuild() {
1305 // Hidden API CSV generation and dex encoding
1306 dexOutputFile = j.hiddenAPI.hiddenAPI(ctx, dexOutputFile, j.implementationJarFile,
1307 j.deviceProperties.UncompressDex)
1308 }
Colin Cross8faf8fc2019-01-16 15:15:52 -08001309
Colin Cross331a1212018-08-15 20:40:52 -07001310 // merge dex jar with resources if necessary
1311 if j.resourceJar != nil {
1312 jars := android.Paths{dexOutputFile, j.resourceJar}
1313 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
1314 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1315 false, nil, nil)
Nicolas Geoffrayf3438722019-01-23 15:57:21 +00001316 if j.deviceProperties.UncompressDex {
1317 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
1318 TransformZipAlign(ctx, combinedAlignedJar, combinedJar)
1319 dexOutputFile = combinedAlignedJar
1320 } else {
1321 dexOutputFile = combinedJar
1322 }
Colin Cross331a1212018-08-15 20:40:52 -07001323 }
1324
1325 j.dexJarFile = dexOutputFile
1326
Colin Cross8faf8fc2019-01-16 15:15:52 -08001327 // Dexpreopting
Colin Cross43f08db2018-11-12 10:13:39 -08001328 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
1329
1330 j.maybeStrippedDexJarFile = dexOutputFile
1331
Colin Cross3063b782018-08-15 11:19:12 -07001332 outputFile = dexOutputFile
Colin Cross43f08db2018-11-12 10:13:39 -08001333
1334 if ctx.Failed() {
1335 return
1336 }
Colin Cross331a1212018-08-15 20:40:52 -07001337 } else {
1338 outputFile = implementationAndResourcesJar
Colin Cross2fe66872015-03-30 17:20:39 -07001339 }
Colin Cross331a1212018-08-15 20:40:52 -07001340
Colin Crossb7a63242015-04-16 14:09:14 -07001341 ctx.CheckbuildFile(outputFile)
Colin Cross3063b782018-08-15 11:19:12 -07001342
1343 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1344 j.outputFile = outputFile.WithoutRel()
Colin Cross2fe66872015-03-30 17:20:39 -07001345}
1346
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001347// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1348// since some of these flags may be used internally.
1349func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1350 for _, flag := range flags {
1351 flag = strings.TrimSpace(flag)
1352
1353 if !strings.HasPrefix(flag, "-") {
1354 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1355 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1356 ctx.PropertyErrorf("kotlincflags",
1357 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1358 } else if inList(flag, config.KotlincIllegalFlags) {
1359 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1360 } else if flag == "-include-runtime" {
1361 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1362 } else {
1363 args := strings.Split(flag, " ")
1364 if args[0] == "-kotlin-home" {
1365 ctx.PropertyErrorf("kotlincflags",
1366 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1367 }
1368 }
1369 }
1370}
1371
Colin Cross8eadbf02017-10-24 17:46:00 -07001372func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
Colin Cross55f63ea2018-08-27 12:37:09 -07001373 deps deps, flags javaBuilderFlags, jarName string, extraJars android.Paths) android.Path {
Nan Zhanged19fc32017-10-19 13:06:22 -07001374
1375 var jars android.Paths
Colin Cross8eadbf02017-10-24 17:46:00 -07001376 if len(srcFiles) > 0 || len(srcJars) > 0 {
Nan Zhanged19fc32017-10-19 13:06:22 -07001377 // Compile java sources into turbine.jar.
1378 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1379 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
1380 if ctx.Failed() {
1381 return nil
1382 }
1383 jars = append(jars, turbineJar)
1384 }
1385
Colin Cross55f63ea2018-08-27 12:37:09 -07001386 jars = append(jars, extraJars...)
1387
Nan Zhanged19fc32017-10-19 13:06:22 -07001388 // Combine any static header libraries into classes-header.jar. If there is only
1389 // one input jar this step will be skipped.
1390 var headerJar android.Path
1391 jars = append(jars, deps.staticHeaderJars...)
1392
Colin Cross5c6ecc12017-10-23 18:12:27 -07001393 // we cannot skip the combine step for now if there is only one jar
1394 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
1395 combinedJar := android.PathForModuleOut(ctx, "turbine-combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001396 TransformJarsToJar(ctx, combinedJar, "for turbine", jars, android.OptionalPath{},
Colin Cross6c6e6cd2019-05-08 14:30:12 -07001397 false, nil, []string{"META-INF/TRANSITIVE"})
Colin Cross5c6ecc12017-10-23 18:12:27 -07001398 headerJar = combinedJar
Nan Zhanged19fc32017-10-19 13:06:22 -07001399
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001400 if j.expandJarjarRules != nil {
Nan Zhanged19fc32017-10-19 13:06:22 -07001401 // Transform classes.jar into classes-jarjar.jar
1402 jarjarFile := android.PathForModuleOut(ctx, "turbine-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001403 TransformJarJar(ctx, jarjarFile, headerJar, j.expandJarjarRules)
Nan Zhanged19fc32017-10-19 13:06:22 -07001404 headerJar = jarjarFile
1405 if ctx.Failed() {
1406 return nil
1407 }
1408 }
1409
1410 return headerJar
1411}
1412
Colin Crosscb933592017-11-22 13:49:43 -08001413func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross3063b782018-08-15 11:19:12 -07001414 classesJar android.Path, jarName string) android.ModuleOutPath {
Colin Crosscb933592017-11-22 13:49:43 -08001415
Colin Cross7a3139e2017-12-19 13:57:50 -08001416 specs := j.jacocoModuleToZipCommand(ctx)
Colin Crosscb933592017-11-22 13:49:43 -08001417
Colin Cross84c38822018-01-03 15:59:46 -08001418 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Crosscb933592017-11-22 13:49:43 -08001419 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
1420
1421 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1422
1423 j.jacocoReportClassesFile = jacocoReportClassesFile
1424
1425 return instrumentedJar
1426}
1427
albaltai36ff7dc2018-12-25 14:35:23 +08001428var _ Dependency = (*Module)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07001429
Nan Zhanged19fc32017-10-19 13:06:22 -07001430func (j *Module) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001431 if j.headerJarFile == nil {
1432 return nil
1433 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001434 return android.Paths{j.headerJarFile}
1435}
1436
1437func (j *Module) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08001438 if j.implementationJarFile == nil {
1439 return nil
1440 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001441 return android.Paths{j.implementationJarFile}
Colin Cross2fe66872015-03-30 17:20:39 -07001442}
1443
Colin Crossf24a22a2019-01-31 14:12:44 -08001444func (j *Module) DexJar() android.Path {
1445 return j.dexJarFile
1446}
1447
Colin Cross331a1212018-08-15 20:40:52 -07001448func (j *Module) ResourceJars() android.Paths {
1449 if j.resourceJar == nil {
1450 return nil
1451 }
1452 return android.Paths{j.resourceJar}
1453}
1454
1455func (j *Module) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001456 if j.implementationAndResourcesJar == nil {
1457 return nil
1458 }
Colin Cross331a1212018-08-15 20:40:52 -07001459 return android.Paths{j.implementationAndResourcesJar}
1460}
1461
Colin Cross46c9b8b2017-06-22 16:51:17 -07001462func (j *Module) AidlIncludeDirs() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001463 // exportAidlIncludeDirs is type android.Paths already
Colin Crossc0b06f12015-04-08 13:03:43 -07001464 return j.exportAidlIncludeDirs
1465}
1466
Jiyong Park1be96912018-05-28 18:02:19 +09001467func (j *Module) ExportedSdkLibs() []string {
albaltai36ff7dc2018-12-25 14:35:23 +08001468 // exportedSdkLibs is type []string
Jiyong Park1be96912018-05-28 18:02:19 +09001469 return j.exportedSdkLibs
1470}
1471
Colin Cross0c4ce212019-05-03 15:28:19 -07001472func (j *Module) SrcJarArgs() ([]string, android.Paths) {
1473 return j.srcJarArgs, j.srcJarDeps
1474}
1475
Colin Cross46c9b8b2017-06-22 16:51:17 -07001476var _ logtagsProducer = (*Module)(nil)
Colin Crossf05fe972015-04-10 17:45:20 -07001477
Colin Cross46c9b8b2017-06-22 16:51:17 -07001478func (j *Module) logtags() android.Paths {
Colin Crossf05fe972015-04-10 17:45:20 -07001479 return j.logtagsSrcs
1480}
1481
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001482// Collect information for opening IDE project files in java/jdeps.go.
1483func (j *Module) IDEInfo(dpInfo *android.IdeInfo) {
1484 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
1485 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
1486 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001487 if j.expandJarjarRules != nil {
1488 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001489 }
1490}
1491
1492func (j *Module) CompilerDeps() []string {
1493 jdeps := []string{}
1494 jdeps = append(jdeps, j.properties.Libs...)
1495 jdeps = append(jdeps, j.properties.Static_libs...)
1496 return jdeps
1497}
1498
Colin Cross2fe66872015-03-30 17:20:39 -07001499//
1500// Java libraries (.jar file)
1501//
1502
Colin Crossf506d872017-07-19 15:53:04 -07001503type Library struct {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001504 Module
Colin Cross2fe66872015-03-30 17:20:39 -07001505}
1506
Colin Cross42be7612019-02-21 18:12:14 -08001507func shouldUncompressDex(ctx android.ModuleContext, dexpreopter *dexpreopter) bool {
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +00001508 // Store uncompressed (and do not strip) dex files from boot class path jars.
1509 if inList(ctx.ModuleName(), ctx.Config().BootJars()) {
1510 return true
1511 }
1512
1513 // Store uncompressed dex files that are preopted on /system.
Colin Cross42be7612019-02-21 18:12:14 -08001514 if !dexpreopter.dexpreoptDisabled(ctx) && (ctx.Host() || !odexOnSystemOther(ctx, dexpreopter.installPath)) {
Vladimir Markoe8b00d62018-12-21 15:54:16 +00001515 return true
1516 }
Colin Cross083a2aa2019-02-06 16:37:12 -08001517 if ctx.Config().UncompressPrivAppDex() &&
1518 inList(ctx.ModuleName(), ctx.Config().ModulesLoadedByPrivilegedModules()) {
1519 return true
1520 }
1521
Colin Cross2fc72f62018-12-21 12:59:54 -08001522 return false
1523}
1524
Colin Crossf506d872017-07-19 15:53:04 -07001525func (j *Library) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross43f08db2018-11-12 10:13:39 -08001526 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", ctx.ModuleName()+".jar")
1527 j.dexpreopter.isSDKLibrary = j.deviceProperties.IsSDKLibrary
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +00001528 j.dexpreopter.isInstallable = Bool(j.properties.Installable)
Colin Cross42be7612019-02-21 18:12:14 -08001529 j.dexpreopter.uncompressedDex = shouldUncompressDex(ctx, &j.dexpreopter)
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +00001530 j.deviceProperties.UncompressDex = j.dexpreopter.uncompressedDex
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001531 j.compile(ctx, nil)
Colin Crossb7a63242015-04-16 14:09:14 -07001532
Nicolas Geoffray4bdea392019-01-15 11:48:08 +00001533 if (Bool(j.properties.Installable) || ctx.Host()) && !android.DirectlyInAnyApex(ctx, ctx.ModuleName()) {
Colin Cross2c429dc2017-08-31 16:45:16 -07001534 j.installFile = ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
1535 ctx.ModuleName()+".jar", j.outputFile)
1536 }
Colin Crossb7a63242015-04-16 14:09:14 -07001537}
1538
Colin Crossf506d872017-07-19 15:53:04 -07001539func (j *Library) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001540 j.deps(ctx)
1541}
1542
Colin Cross1b16b0e2019-02-12 14:41:32 -08001543// java_library builds and links sources into a `.jar` file for the device, and possibly for the host as well.
1544//
1545// By default, a java_library has a single variant that produces a `.jar` file containing `.class` files that were
1546// compiled against the device bootclasspath. This jar is not suitable for installing on a device, but can be used
1547// as a `static_libs` dependency of another module.
1548//
1549// Specifying `installable: true` will product a `.jar` file containing `classes.dex` files, suitable for installing on
1550// a device.
1551//
1552// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
1553// compiled against the host bootclasspath.
Colin Cross9ae1b922018-06-26 17:59:05 -07001554func LibraryFactory() android.Module {
1555 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07001556
Colin Cross9ae1b922018-06-26 17:59:05 -07001557 module.AddProperties(
1558 &module.Module.properties,
1559 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08001560 &module.Module.dexpreoptProperties,
Colin Cross9ae1b922018-06-26 17:59:05 -07001561 &module.Module.protoProperties)
Colin Cross2fe66872015-03-30 17:20:39 -07001562
Colin Cross9ae1b922018-06-26 17:59:05 -07001563 InitJavaModule(module, android.HostAndDeviceSupported)
1564 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001565}
1566
Colin Cross1b16b0e2019-02-12 14:41:32 -08001567// java_library_static is an obsolete alias for java_library.
1568func LibraryStaticFactory() android.Module {
1569 return LibraryFactory()
1570}
1571
1572// java_library_host builds and links sources into a `.jar` file for the host.
1573//
1574// A java_library_host has a single variant that produces a `.jar` file containing `.class` files that were
1575// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07001576func LibraryHostFactory() android.Module {
1577 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07001578
Colin Cross6af17aa2017-09-20 12:59:05 -07001579 module.AddProperties(
1580 &module.Module.properties,
1581 &module.Module.protoProperties)
Colin Cross36242852017-06-23 15:06:31 -07001582
Colin Cross9ae1b922018-06-26 17:59:05 -07001583 module.Module.properties.Installable = proptools.BoolPtr(true)
1584
Colin Cross89536d42017-07-07 14:35:50 -07001585 InitJavaModule(module, android.HostSupported)
Colin Cross36242852017-06-23 15:06:31 -07001586 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001587}
1588
1589//
Colin Crossb628ea52018-08-14 16:42:33 -07001590// Java Tests
Colin Cross05638fc2018-04-09 18:40:24 -07001591//
1592
1593type testProperties struct {
Colin Cross05638fc2018-04-09 18:40:24 -07001594 // list of compatibility suites (for example "cts", "vts") that the module should be
1595 // installed into.
1596 Test_suites []string `android:"arch_variant"`
Julien Despreze146e392018-08-02 15:00:46 -07001597
1598 // the name of the test configuration (for example "AndroidTest.xml") that should be
1599 // installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08001600 Test_config *string `android:"path,arch_variant"`
Colin Crossd96ca352018-08-10 16:06:24 -07001601
Jack He33338892018-09-19 02:21:28 -07001602 // the name of the test configuration template (for example "AndroidTestTemplate.xml") that
1603 // should be installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08001604 Test_config_template *string `android:"path,arch_variant"`
Jack He33338892018-09-19 02:21:28 -07001605
Colin Crossd96ca352018-08-10 16:06:24 -07001606 // list of files or filegroup modules that provide data that should be installed alongside
1607 // the test
Colin Cross27b922f2019-03-04 22:35:41 -08001608 Data []string `android:"path"`
Colin Cross05638fc2018-04-09 18:40:24 -07001609}
1610
Paul Duffin42df1442019-03-20 12:45:53 +00001611type testHelperLibraryProperties struct {
1612 // list of compatibility suites (for example "cts", "vts") that the module should be
1613 // installed into.
1614 Test_suites []string `android:"arch_variant"`
1615}
1616
Colin Cross05638fc2018-04-09 18:40:24 -07001617type Test struct {
1618 Library
1619
1620 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07001621
1622 testConfig android.Path
Colin Crossd96ca352018-08-10 16:06:24 -07001623 data android.Paths
Colin Cross303e21f2018-08-07 16:49:25 -07001624}
1625
Paul Duffin42df1442019-03-20 12:45:53 +00001626type TestHelperLibrary struct {
1627 Library
1628
1629 testHelperLibraryProperties testHelperLibraryProperties
1630}
1631
Colin Cross303e21f2018-08-07 16:49:25 -07001632func (j *Test) GenerateAndroidBuildActions(ctx android.ModuleContext) {
yangbill4f41bc22019-02-13 21:45:47 +08001633 j.testConfig = tradefed.AutoGenJavaTestConfig(ctx, j.testProperties.Test_config, j.testProperties.Test_config_template, j.testProperties.Test_suites)
Colin Cross8a497952019-03-05 22:25:09 -08001634 j.data = android.PathsForModuleSrc(ctx, j.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07001635
1636 j.Library.GenerateAndroidBuildActions(ctx)
Colin Cross05638fc2018-04-09 18:40:24 -07001637}
1638
Paul Duffin42df1442019-03-20 12:45:53 +00001639func (j *TestHelperLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1640 j.Library.GenerateAndroidBuildActions(ctx)
1641}
1642
Colin Cross1b16b0e2019-02-12 14:41:32 -08001643// java_test builds a and links sources into a `.jar` file for the device, and possibly for the host as well, and
1644// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
1645//
1646// By default, a java_test has a single variant that produces a `.jar` file containing `classes.dex` files that were
1647// compiled against the device bootclasspath.
1648//
1649// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
1650// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07001651func TestFactory() android.Module {
1652 module := &Test{}
1653
1654 module.AddProperties(
1655 &module.Module.properties,
1656 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08001657 &module.Module.dexpreoptProperties,
Colin Cross05638fc2018-04-09 18:40:24 -07001658 &module.Module.protoProperties,
1659 &module.testProperties)
1660
Colin Cross9ae1b922018-06-26 17:59:05 -07001661 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse3026872019-01-05 22:30:13 -08001662 module.Module.dexpreopter.isTest = true
Colin Cross9ae1b922018-06-26 17:59:05 -07001663
Colin Cross05638fc2018-04-09 18:40:24 -07001664 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07001665 return module
1666}
1667
Paul Duffin42df1442019-03-20 12:45:53 +00001668// java_test_helper_library creates a java library and makes sure that it is added to the appropriate test suite.
1669func TestHelperLibraryFactory() android.Module {
1670 module := &TestHelperLibrary{}
1671
1672 module.AddProperties(
1673 &module.Module.properties,
1674 &module.Module.deviceProperties,
1675 &module.Module.dexpreoptProperties,
1676 &module.Module.protoProperties,
1677 &module.testHelperLibraryProperties)
1678
Colin Cross9a4abed2019-04-24 13:19:28 -07001679 module.Module.properties.Installable = proptools.BoolPtr(true)
1680 module.Module.dexpreopter.isTest = true
1681
Paul Duffin42df1442019-03-20 12:45:53 +00001682 InitJavaModule(module, android.HostAndDeviceSupported)
1683 return module
1684}
1685
Colin Cross1b16b0e2019-02-12 14:41:32 -08001686// java_test_host builds a and links sources into a `.jar` file for the host, and creates an `AndroidTest.xml` file to
1687// allow running the test with `atest` or a `TEST_MAPPING` file.
1688//
1689// A java_test_host has a single variant that produces a `.jar` file containing `.class` files that were
1690// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07001691func TestHostFactory() android.Module {
1692 module := &Test{}
1693
1694 module.AddProperties(
1695 &module.Module.properties,
1696 &module.Module.protoProperties,
1697 &module.testProperties)
1698
Colin Cross9ae1b922018-06-26 17:59:05 -07001699 module.Module.properties.Installable = proptools.BoolPtr(true)
1700
Colin Cross05638fc2018-04-09 18:40:24 -07001701 InitJavaModule(module, android.HostSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07001702 return module
1703}
1704
1705//
Colin Cross2fe66872015-03-30 17:20:39 -07001706// Java Binaries (.jar file plus wrapper script)
1707//
1708
Colin Crossf506d872017-07-19 15:53:04 -07001709type binaryProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -07001710 // installable script to execute the resulting jar
Colin Cross27b922f2019-03-04 22:35:41 -08001711 Wrapper *string `android:"path"`
Colin Cross094054a2018-10-17 15:10:48 -07001712
1713 // Name of the class containing main to be inserted into the manifest as Main-Class.
1714 Main_class *string
Colin Cross7d5136f2015-05-11 13:39:40 -07001715}
1716
Colin Crossf506d872017-07-19 15:53:04 -07001717type Binary struct {
1718 Library
Colin Cross2fe66872015-03-30 17:20:39 -07001719
Colin Crossf506d872017-07-19 15:53:04 -07001720 binaryProperties binaryProperties
Colin Cross10a03492017-08-10 17:09:43 -07001721
Colin Cross6b4a32d2017-12-05 13:42:45 -08001722 isWrapperVariant bool
1723
Colin Crossc3315992017-12-08 19:12:36 -08001724 wrapperFile android.Path
Colin Cross10a03492017-08-10 17:09:43 -07001725 binaryFile android.OutputPath
Colin Cross2fe66872015-03-30 17:20:39 -07001726}
1727
Alex Light24237172017-10-26 09:46:21 -07001728func (j *Binary) HostToolPath() android.OptionalPath {
1729 return android.OptionalPathForPath(j.binaryFile)
1730}
1731
Colin Crossf506d872017-07-19 15:53:04 -07001732func (j *Binary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08001733 if ctx.Arch().ArchType == android.Common {
1734 // Compile the jar
Colin Cross094054a2018-10-17 15:10:48 -07001735 if j.binaryProperties.Main_class != nil {
1736 if j.properties.Manifest != nil {
1737 ctx.PropertyErrorf("main_class", "main_class cannot be used when manifest is set")
1738 }
1739 manifestFile := android.PathForModuleOut(ctx, "manifest.txt")
1740 GenerateMainClassManifest(ctx, manifestFile, String(j.binaryProperties.Main_class))
1741 j.overrideManifest = android.OptionalPathForPath(manifestFile)
1742 }
1743
Colin Cross6b4a32d2017-12-05 13:42:45 -08001744 j.Library.GenerateAndroidBuildActions(ctx)
Nan Zhang3c807db2017-11-03 14:53:31 -07001745 } else {
Colin Cross6b4a32d2017-12-05 13:42:45 -08001746 // Handle the binary wrapper
1747 j.isWrapperVariant = true
1748
Colin Cross366938f2017-12-11 16:29:02 -08001749 if j.binaryProperties.Wrapper != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001750 j.wrapperFile = android.PathForModuleSrc(ctx, *j.binaryProperties.Wrapper)
Colin Cross6b4a32d2017-12-05 13:42:45 -08001751 } else {
1752 j.wrapperFile = android.PathForSource(ctx, "build/soong/scripts/jar-wrapper.sh")
1753 }
1754
1755 // Depend on the installed jar so that the wrapper doesn't get executed by
1756 // another build rule before the jar has been installed.
1757 jarFile := ctx.PrimaryModule().(*Binary).installFile
1758
1759 j.binaryFile = ctx.InstallExecutable(android.PathForModuleInstall(ctx, "bin"),
1760 ctx.ModuleName(), j.wrapperFile, jarFile)
Nan Zhang3c807db2017-11-03 14:53:31 -07001761 }
Colin Cross2fe66872015-03-30 17:20:39 -07001762}
1763
Colin Crossf506d872017-07-19 15:53:04 -07001764func (j *Binary) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08001765 if ctx.Arch().ArchType == android.Common {
1766 j.deps(ctx)
1767 }
Colin Cross46c9b8b2017-06-22 16:51:17 -07001768}
1769
Colin Cross1b16b0e2019-02-12 14:41:32 -08001770// java_binary builds a `.jar` file and a shell script that executes it for the device, and possibly for the host
1771// as well.
1772//
1773// By default, a java_binary has a single variant that produces a `.jar` file containing `classes.dex` files that were
1774// compiled against the device bootclasspath.
1775//
1776// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
1777// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07001778func BinaryFactory() android.Module {
1779 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07001780
Colin Cross36242852017-06-23 15:06:31 -07001781 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -07001782 &module.Module.properties,
1783 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08001784 &module.Module.dexpreoptProperties,
Colin Cross6af17aa2017-09-20 12:59:05 -07001785 &module.Module.protoProperties,
Colin Cross540eff82017-06-22 17:01:52 -07001786 &module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07001787
Colin Cross9ae1b922018-06-26 17:59:05 -07001788 module.Module.properties.Installable = proptools.BoolPtr(true)
1789
Colin Cross6b4a32d2017-12-05 13:42:45 -08001790 android.InitAndroidArchModule(module, android.HostAndDeviceSupported, android.MultilibCommonFirst)
1791 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07001792 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001793}
1794
Colin Cross1b16b0e2019-02-12 14:41:32 -08001795// java_binary_host builds a `.jar` file and a shell script that executes it for the host.
1796//
1797// A java_binary_host has a single variant that produces a `.jar` file containing `.class` files that were
1798// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07001799func BinaryHostFactory() android.Module {
1800 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07001801
Colin Cross36242852017-06-23 15:06:31 -07001802 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -07001803 &module.Module.properties,
Colin Cross6af17aa2017-09-20 12:59:05 -07001804 &module.Module.protoProperties,
Colin Cross540eff82017-06-22 17:01:52 -07001805 &module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07001806
Colin Cross9ae1b922018-06-26 17:59:05 -07001807 module.Module.properties.Installable = proptools.BoolPtr(true)
1808
Colin Cross6b4a32d2017-12-05 13:42:45 -08001809 android.InitAndroidArchModule(module, android.HostSupported, android.MultilibCommonFirst)
1810 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07001811 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001812}
1813
1814//
1815// Java prebuilts
1816//
1817
Colin Cross74d73e22017-08-02 11:05:49 -07001818type ImportProperties struct {
Colin Cross27b922f2019-03-04 22:35:41 -08001819 Jars []string `android:"path"`
Colin Cross461bd1a2017-10-20 13:59:18 -07001820
Nan Zhangea568a42017-11-08 21:20:04 -08001821 Sdk_version *string
Colin Cross535e2cf2017-10-20 17:57:49 -07001822
1823 Installable *bool
Jiyong Park1be96912018-05-28 18:02:19 +09001824
1825 // List of shared java libs that this module has dependencies to
1826 Libs []string
Colin Cross37f6d792018-07-12 12:28:41 -07001827
1828 // List of files to remove from the jar file(s)
1829 Exclude_files []string
1830
1831 // List of directories to remove from the jar file(s)
1832 Exclude_dirs []string
Nan Zhang4c819fb2018-08-27 18:31:46 -07001833
1834 // if set to true, run Jetifier against .jar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -07001835 Jetifier *bool
Colin Cross74d73e22017-08-02 11:05:49 -07001836}
1837
1838type Import struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001839 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -07001840 android.DefaultableModuleBase
Colin Crossec7a0422017-07-07 14:47:12 -07001841 prebuilt android.Prebuilt
Colin Cross2fe66872015-03-30 17:20:39 -07001842
Colin Cross74d73e22017-08-02 11:05:49 -07001843 properties ImportProperties
1844
Colin Cross0a6e0072017-08-30 14:24:55 -07001845 combinedClasspathFile android.Path
Jiyong Park1be96912018-05-28 18:02:19 +09001846 exportedSdkLibs []string
Colin Cross2fe66872015-03-30 17:20:39 -07001847}
1848
Colin Cross83bb3162018-06-25 15:48:06 -07001849func (j *Import) sdkVersion() string {
1850 return String(j.properties.Sdk_version)
1851}
1852
1853func (j *Import) minSdkVersion() string {
1854 return j.sdkVersion()
1855}
1856
Colin Cross74d73e22017-08-02 11:05:49 -07001857func (j *Import) Prebuilt() *android.Prebuilt {
Colin Crossec7a0422017-07-07 14:47:12 -07001858 return &j.prebuilt
1859}
1860
Colin Cross74d73e22017-08-02 11:05:49 -07001861func (j *Import) PrebuiltSrcs() []string {
1862 return j.properties.Jars
1863}
1864
1865func (j *Import) Name() string {
Colin Cross5ea9bcc2017-07-27 15:41:32 -07001866 return j.prebuilt.Name(j.ModuleBase.Name())
1867}
1868
Colin Cross74d73e22017-08-02 11:05:49 -07001869func (j *Import) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross42d48b72018-08-29 14:10:52 -07001870 ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Colin Cross1e676be2016-10-12 14:38:15 -07001871}
1872
Colin Cross74d73e22017-08-02 11:05:49 -07001873func (j *Import) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross8a497952019-03-05 22:25:09 -08001874 jars := android.PathsForModuleSrc(ctx, j.properties.Jars)
Colin Crosse1d62a82015-04-03 16:53:05 -07001875
Nan Zhang4c819fb2018-08-27 18:31:46 -07001876 jarName := ctx.ModuleName() + ".jar"
1877 outputFile := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001878 TransformJarsToJar(ctx, outputFile, "for prebuilts", jars, android.OptionalPath{},
1879 false, j.properties.Exclude_files, j.properties.Exclude_dirs)
Colin Cross1001a792019-03-21 22:21:39 -07001880 if Bool(j.properties.Jetifier) {
Nan Zhang4c819fb2018-08-27 18:31:46 -07001881 inputFile := outputFile
1882 outputFile = android.PathForModuleOut(ctx, "jetifier", jarName)
1883 TransformJetifier(ctx, outputFile, inputFile)
1884 }
Colin Crosse9a275b2017-10-16 17:09:48 -07001885 j.combinedClasspathFile = outputFile
Jiyong Park1be96912018-05-28 18:02:19 +09001886
1887 ctx.VisitDirectDeps(func(module android.Module) {
1888 otherName := ctx.OtherModuleName(module)
1889 tag := ctx.OtherModuleDependencyTag(module)
1890
1891 switch dep := module.(type) {
1892 case Dependency:
1893 switch tag {
1894 case libTag, staticLibTag:
1895 // sdk lib names from dependencies are re-exported
1896 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
1897 }
1898 case SdkLibraryDependency:
1899 switch tag {
1900 case libTag:
1901 // names of sdk libs that are directly depended are exported
1902 j.exportedSdkLibs = append(j.exportedSdkLibs, otherName)
1903 }
1904 }
1905 })
1906
1907 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
Nan Zhang4973ecf2018-08-10 13:42:12 -07001908 if Bool(j.properties.Installable) {
1909 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
1910 ctx.ModuleName()+".jar", outputFile)
1911 }
Colin Cross2fe66872015-03-30 17:20:39 -07001912}
1913
Colin Cross74d73e22017-08-02 11:05:49 -07001914var _ Dependency = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07001915
Nan Zhanged19fc32017-10-19 13:06:22 -07001916func (j *Import) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001917 if j.combinedClasspathFile == nil {
1918 return nil
1919 }
Colin Cross37f6d792018-07-12 12:28:41 -07001920 return android.Paths{j.combinedClasspathFile}
Nan Zhanged19fc32017-10-19 13:06:22 -07001921}
1922
1923func (j *Import) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08001924 if j.combinedClasspathFile == nil {
1925 return nil
1926 }
Colin Cross37f6d792018-07-12 12:28:41 -07001927 return android.Paths{j.combinedClasspathFile}
Colin Cross2fe66872015-03-30 17:20:39 -07001928}
1929
Colin Cross331a1212018-08-15 20:40:52 -07001930func (j *Import) ResourceJars() android.Paths {
1931 return nil
1932}
1933
1934func (j *Import) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001935 if j.combinedClasspathFile == nil {
1936 return nil
1937 }
Colin Cross331a1212018-08-15 20:40:52 -07001938 return android.Paths{j.combinedClasspathFile}
1939}
1940
Colin Crossf24a22a2019-01-31 14:12:44 -08001941func (j *Import) DexJar() android.Path {
1942 return nil
1943}
1944
Colin Cross74d73e22017-08-02 11:05:49 -07001945func (j *Import) AidlIncludeDirs() android.Paths {
Colin Crossc0b06f12015-04-08 13:03:43 -07001946 return nil
1947}
1948
Jiyong Park1be96912018-05-28 18:02:19 +09001949func (j *Import) ExportedSdkLibs() []string {
1950 return j.exportedSdkLibs
1951}
1952
Colin Cross0c4ce212019-05-03 15:28:19 -07001953func (j *Import) SrcJarArgs() ([]string, android.Paths) {
1954 return nil, nil
1955}
1956
albaltai36ff7dc2018-12-25 14:35:23 +08001957// Add compile time check for interface implementation
1958var _ android.IDEInfo = (*Import)(nil)
1959var _ android.IDECustomizedModuleName = (*Import)(nil)
1960
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001961// Collect information for opening IDE project files in java/jdeps.go.
1962const (
1963 removedPrefix = "prebuilt_"
1964)
1965
1966func (j *Import) IDEInfo(dpInfo *android.IdeInfo) {
1967 dpInfo.Jars = append(dpInfo.Jars, j.PrebuiltSrcs()...)
1968}
1969
1970func (j *Import) IDECustomizedModuleName() string {
1971 // TODO(b/113562217): Extract the base module name from the Import name, often the Import name
1972 // has a prefix "prebuilt_". Remove the prefix explicitly if needed until we find a better
1973 // solution to get the Import name.
1974 name := j.Name()
1975 if strings.HasPrefix(name, removedPrefix) {
patricktubb640e02018-10-11 18:33:16 +08001976 name = strings.TrimPrefix(name, removedPrefix)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001977 }
1978 return name
1979}
1980
Colin Cross74d73e22017-08-02 11:05:49 -07001981var _ android.PrebuiltInterface = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07001982
Colin Cross1b16b0e2019-02-12 14:41:32 -08001983// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library module.
1984//
1985// By default, a java_import has a single variant that expects a `.jar` file containing `.class` files that were
1986// compiled against an Android classpath.
1987//
1988// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
1989// for host modules.
Colin Cross74d73e22017-08-02 11:05:49 -07001990func ImportFactory() android.Module {
1991 module := &Import{}
Colin Cross36242852017-06-23 15:06:31 -07001992
Colin Cross74d73e22017-08-02 11:05:49 -07001993 module.AddProperties(&module.properties)
1994
1995 android.InitPrebuiltModule(module, &module.properties.Jars)
Colin Cross48de9a42018-10-02 13:53:33 -07001996 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross36242852017-06-23 15:06:31 -07001997 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001998}
1999
Colin Cross1b16b0e2019-02-12 14:41:32 -08002000// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library_host
2001// module.
2002//
2003// A java_import_host has a single variant that expects a `.jar` file containing `.class` files that were
2004// compiled against a host bootclasspath.
Colin Cross74d73e22017-08-02 11:05:49 -07002005func ImportFactoryHost() android.Module {
2006 module := &Import{}
2007
2008 module.AddProperties(&module.properties)
2009
2010 android.InitPrebuiltModule(module, &module.properties.Jars)
Colin Cross48de9a42018-10-02 13:53:33 -07002011 InitJavaModule(module, android.HostSupported)
Colin Cross74d73e22017-08-02 11:05:49 -07002012 return module
2013}
2014
Colin Cross42be7612019-02-21 18:12:14 -08002015// dex_import module
2016
2017type DexImportProperties struct {
2018 Jars []string
2019}
2020
2021type DexImport struct {
2022 android.ModuleBase
2023 android.DefaultableModuleBase
2024 prebuilt android.Prebuilt
2025
2026 properties DexImportProperties
2027
2028 dexJarFile android.Path
2029 maybeStrippedDexJarFile android.Path
2030
2031 dexpreopter
2032}
2033
2034func (j *DexImport) Prebuilt() *android.Prebuilt {
2035 return &j.prebuilt
2036}
2037
2038func (j *DexImport) PrebuiltSrcs() []string {
2039 return j.properties.Jars
2040}
2041
2042func (j *DexImport) Name() string {
2043 return j.prebuilt.Name(j.ModuleBase.Name())
2044}
2045
2046func (j *DexImport) DepsMutator(ctx android.BottomUpMutatorContext) {
2047 android.ExtractSourcesDeps(ctx, j.properties.Jars)
2048}
2049
2050func (j *DexImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2051 if len(j.properties.Jars) != 1 {
2052 ctx.PropertyErrorf("jars", "exactly one jar must be provided")
2053 }
2054
2055 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", ctx.ModuleName()+".jar")
2056 j.dexpreopter.isInstallable = true
2057 j.dexpreopter.uncompressedDex = shouldUncompressDex(ctx, &j.dexpreopter)
2058
2059 inputJar := ctx.ExpandSource(j.properties.Jars[0], "jars")
2060 dexOutputFile := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar")
2061
2062 if j.dexpreopter.uncompressedDex {
2063 rule := android.NewRuleBuilder()
2064
2065 temporary := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar.unaligned")
2066 rule.Temporary(temporary)
2067
2068 // use zip2zip to uncompress classes*.dex files
2069 rule.Command().
2070 Tool(ctx.Config().HostToolPath(ctx, "zip2zip")).
2071 FlagWithInput("-i ", inputJar).
2072 FlagWithOutput("-o ", temporary).
2073 FlagWithArg("-0 ", "'classes*.dex'")
2074
2075 // use zipalign to align uncompressed classes*.dex files
2076 rule.Command().
2077 Tool(ctx.Config().HostToolPath(ctx, "zipalign")).
2078 Flag("-f").
2079 Text("4").
2080 Input(temporary).
2081 Output(dexOutputFile)
2082
2083 rule.DeleteTemporaryFiles()
2084
2085 rule.Build(pctx, ctx, "uncompress_dex", "uncompress dex")
2086 } else {
2087 ctx.Build(pctx, android.BuildParams{
2088 Rule: android.Cp,
2089 Input: inputJar,
2090 Output: dexOutputFile,
2091 })
2092 }
2093
2094 j.dexJarFile = dexOutputFile
2095
2096 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
2097
2098 j.maybeStrippedDexJarFile = dexOutputFile
2099
2100 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
2101 ctx.ModuleName()+".jar", dexOutputFile)
2102}
2103
2104func (j *DexImport) DexJar() android.Path {
2105 return j.dexJarFile
2106}
2107
2108// dex_import imports a `.jar` file containing classes.dex files.
2109//
2110// A dex_import module cannot be used as a dependency of a java_* or android_* module, it can only be installed
2111// to the device.
2112func DexImportFactory() android.Module {
2113 module := &DexImport{}
2114
2115 module.AddProperties(&module.properties)
2116
2117 android.InitPrebuiltModule(module, &module.properties.Jars)
2118 InitJavaModule(module, android.DeviceSupported)
2119 return module
2120}
2121
Colin Cross89536d42017-07-07 14:35:50 -07002122//
2123// Defaults
2124//
2125type Defaults struct {
2126 android.ModuleBase
2127 android.DefaultsModuleBase
2128}
2129
2130func (*Defaults) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2131}
2132
Colin Cross1b16b0e2019-02-12 14:41:32 -08002133// java_defaults provides a set of properties that can be inherited by other java or android modules.
2134//
2135// A module can use the properties from a java_defaults module using `defaults: ["defaults_module_name"]`. Each
2136// property in the defaults module that exists in the depending module will be prepended to the depending module's
2137// value for that property.
2138//
2139// Example:
2140//
2141// java_defaults {
2142// name: "example_defaults",
2143// srcs: ["common/**/*.java"],
2144// javacflags: ["-Xlint:all"],
2145// aaptflags: ["--auto-add-overlay"],
2146// }
2147//
2148// java_library {
2149// name: "example",
2150// defaults: ["example_defaults"],
2151// srcs: ["example/**/*.java"],
2152// }
2153//
2154// is functionally identical to:
2155//
2156// java_library {
2157// name: "example",
2158// srcs: [
2159// "common/**/*.java",
2160// "example/**/*.java",
2161// ],
2162// javacflags: ["-Xlint:all"],
2163// }
Colin Cross89536d42017-07-07 14:35:50 -07002164func defaultsFactory() android.Module {
2165 return DefaultsFactory()
2166}
2167
2168func DefaultsFactory(props ...interface{}) android.Module {
2169 module := &Defaults{}
2170
2171 module.AddProperties(props...)
2172 module.AddProperties(
2173 &CompilerProperties{},
2174 &CompilerDeviceProperties{},
Colin Cross43f08db2018-11-12 10:13:39 -08002175 &DexpreoptProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08002176 &android.ProtoProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002177 &aaptProperties{},
2178 &androidLibraryProperties{},
2179 &appProperties{},
2180 &appTestProperties{},
Jaewoong Jung525443a2019-02-28 15:35:54 -08002181 &overridableAppProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002182 &ImportProperties{},
2183 &AARImportProperties{},
2184 &sdkLibraryProperties{},
Colin Cross42be7612019-02-21 18:12:14 -08002185 &DexImportProperties{},
Colin Cross89536d42017-07-07 14:35:50 -07002186 )
2187
2188 android.InitDefaultsModule(module)
2189
2190 return module
2191}
Nan Zhangea568a42017-11-08 21:20:04 -08002192
2193var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07002194var BoolDefault = proptools.BoolDefault
Nan Zhangea568a42017-11-08 21:20:04 -08002195var String = proptools.String
Colin Cross0d0ba592018-02-20 13:33:42 -08002196var inList = android.InList