blob: 1c455f9c853fd1479a0e2ff85bb5a0938ae1c401 [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 Cross42d48b72018-08-29 14:10:52 -0700520 ctx.AddVariationDependencies(nil, kotlinStdlibTag, "kotlin-stdlib")
Colin Cross7788c122019-01-23 16:14:02 -0800521 if len(j.properties.Plugins) > 0 {
Colin Crossafbb1732019-01-17 15:42:52 -0800522 ctx.AddVariationDependencies(nil, kotlinAnnotationsTag, "kotlin-annotations")
523 }
Colin Cross93e85952017-08-15 13:34:18 -0700524 }
Colin Cross3144dfc2018-01-03 15:06:47 -0800525
526 if j.shouldInstrumentStatic(ctx) {
Colin Cross42d48b72018-08-29 14:10:52 -0700527 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
Colin Cross3144dfc2018-01-03 15:06:47 -0800528 }
Colin Cross6af17aa2017-09-20 12:59:05 -0700529}
530
531func hasSrcExt(srcs []string, ext string) bool {
532 for _, src := range srcs {
533 if filepath.Ext(src) == ext {
534 return true
535 }
536 }
537
538 return false
539}
540
Nan Zhang61eaedb2017-11-02 13:28:15 -0700541func shardPaths(paths android.Paths, shardSize int) []android.Paths {
542 ret := make([]android.Paths, 0, (len(paths)+shardSize-1)/shardSize)
543 for len(paths) > shardSize {
544 ret = append(ret, paths[0:shardSize])
545 paths = paths[shardSize:]
546 }
547 if len(paths) > 0 {
548 ret = append(ret, paths)
549 }
550 return ret
551}
552
Colin Cross6af17aa2017-09-20 12:59:05 -0700553func (j *Module) hasSrcExt(ext string) bool {
554 return hasSrcExt(j.properties.Srcs, ext)
Colin Cross2fe66872015-03-30 17:20:39 -0700555}
556
Colin Cross46c9b8b2017-06-22 16:51:17 -0700557func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Colin Cross3047fa22019-04-18 10:56:44 -0700558 aidlIncludeDirs android.Paths) (string, android.Paths) {
Colin Crossc0b06f12015-04-08 13:03:43 -0700559
Colin Crossebe1a512017-11-14 13:12:14 -0800560 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
561 aidlIncludes = append(aidlIncludes,
562 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
563 aidlIncludes = append(aidlIncludes,
564 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
Colin Crossc0b06f12015-04-08 13:03:43 -0700565
Colin Cross3047fa22019-04-18 10:56:44 -0700566 var flags []string
567 var deps android.Paths
Steven Moreland667f6882018-07-26 12:55:08 -0700568
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700569 if aidlPreprocess.Valid() {
570 flags = append(flags, "-p"+aidlPreprocess.String())
Colin Cross3047fa22019-04-18 10:56:44 -0700571 deps = append(deps, aidlPreprocess.Path())
572 } else if len(aidlIncludeDirs) > 0 {
Colin Cross635c3b02016-05-18 15:37:25 -0700573 flags = append(flags, android.JoinWithPrefix(aidlIncludeDirs.Strings(), "-I"))
Colin Crossc0b06f12015-04-08 13:03:43 -0700574 }
575
Colin Cross3047fa22019-04-18 10:56:44 -0700576 if len(j.exportAidlIncludeDirs) > 0 {
577 flags = append(flags, android.JoinWithPrefix(j.exportAidlIncludeDirs.Strings(), "-I"))
578 }
579
580 if len(aidlIncludes) > 0 {
581 flags = append(flags, android.JoinWithPrefix(aidlIncludes.Strings(), "-I"))
582 }
583
Colin Cross635c3b02016-05-18 15:37:25 -0700584 flags = append(flags, "-I"+android.PathForModuleSrc(ctx).String())
Colin Cross32f38982018-02-22 11:47:25 -0800585 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Colin Crossd48633a2017-07-13 14:41:17 -0700586 flags = append(flags, "-I"+src.String())
587 }
Colin Crossc0b06f12015-04-08 13:03:43 -0700588
Martijn Coeneneab15642018-03-09 09:29:59 +0100589 if Bool(j.deviceProperties.Aidl.Generate_traces) {
590 flags = append(flags, "-t")
591 }
592
Olivier Gaillard0a4cfbc2018-07-16 23:37:03 +0100593 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
594 flags = append(flags, "--transaction_names")
595 }
596
Colin Cross3047fa22019-04-18 10:56:44 -0700597 return strings.Join(flags, " "), deps
Colin Crossc0b06f12015-04-08 13:03:43 -0700598}
599
Colin Cross32f676a2017-09-06 13:41:06 -0700600type deps struct {
Nan Zhang581fd212018-01-10 16:06:12 -0800601 classpath classpath
602 bootClasspath classpath
Colin Cross6a77c982018-06-19 22:43:34 -0700603 processorPath classpath
Colin Crossbe9cdb82019-01-21 21:37:16 -0800604 processorClasses []string
Colin Cross6ade34f2017-09-15 13:00:47 -0700605 staticJars android.Paths
Nan Zhanged19fc32017-10-19 13:06:22 -0700606 staticHeaderJars android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700607 staticResourceJars android.Paths
Colin Cross6ade34f2017-09-15 13:00:47 -0700608 aidlIncludeDirs android.Paths
Nan Zhangb2b33de2018-02-23 11:18:47 -0800609 srcs android.Paths
Colin Cross59149b62017-10-16 18:07:29 -0700610 srcJars android.Paths
Colin Cross1369cdb2017-09-29 17:58:17 -0700611 systemModules android.Path
Colin Cross6ade34f2017-09-15 13:00:47 -0700612 aidlPreprocess android.OptionalPath
Colin Cross93e85952017-08-15 13:34:18 -0700613 kotlinStdlib android.Paths
Colin Crossafbb1732019-01-17 15:42:52 -0800614 kotlinAnnotations android.Paths
Colin Crossbe9cdb82019-01-21 21:37:16 -0800615
616 disableTurbine bool
Colin Cross32f676a2017-09-06 13:41:06 -0700617}
Colin Cross2fe66872015-03-30 17:20:39 -0700618
Colin Cross54250902017-12-05 09:28:08 -0800619func checkProducesJars(ctx android.ModuleContext, dep android.SourceFileProducer) {
620 for _, f := range dep.Srcs() {
621 if f.Ext() != ".jar" {
622 ctx.ModuleErrorf("genrule %q must generate files ending with .jar to be used as a libs or static_libs dependency",
623 ctx.OtherModuleName(dep.(blueprint.Module)))
624 }
625 }
626}
627
Jiyong Park2d492942018-03-05 17:44:10 +0900628type linkType int
629
630const (
631 javaCore linkType = iota
632 javaSdk
633 javaSystem
634 javaPlatform
635)
636
Jiyong Park46f78fb2018-10-20 16:33:17 +0900637func getLinkType(m *Module, name string) (ret linkType, stubs bool) {
Colin Cross83bb3162018-06-25 15:48:06 -0700638 ver := m.sdkVersion()
Colin Crossf19b9bb2018-03-26 14:42:44 -0700639 switch {
Jiyong Park46f78fb2018-10-20 16:33:17 +0900640 case name == "core.current.stubs" || name == "core.platform.api.stubs" ||
641 name == "stub-annotations" || name == "private-stub-annotations-jar" ||
642 name == "core-lambda-stubs":
643 return javaCore, true
Neil Fuller401eeba2018-10-18 19:48:58 +0100644 case ver == "core_current":
Jiyong Park46f78fb2018-10-20 16:33:17 +0900645 return javaCore, false
646 case name == "android_system_stubs_current":
647 return javaSystem, true
648 case strings.HasPrefix(ver, "system_"):
649 return javaSystem, false
650 case name == "android_test_stubs_current":
651 return javaSystem, true
652 case strings.HasPrefix(ver, "test_"):
653 return javaPlatform, false
654 case name == "android_stubs_current":
655 return javaSdk, true
656 case ver == "current":
657 return javaSdk, false
Colin Crossf19b9bb2018-03-26 14:42:44 -0700658 case ver == "":
Jiyong Park46f78fb2018-10-20 16:33:17 +0900659 return javaPlatform, false
Colin Crossf19b9bb2018-03-26 14:42:44 -0700660 default:
661 if _, err := strconv.Atoi(ver); err != nil {
662 panic(fmt.Errorf("expected sdk_version to be a number, got %q", ver))
663 }
Jiyong Park46f78fb2018-10-20 16:33:17 +0900664 return javaSdk, false
Jiyong Park2d492942018-03-05 17:44:10 +0900665 }
666}
667
Jiyong Park750e5572018-01-31 00:20:13 +0900668func checkLinkType(ctx android.ModuleContext, from *Module, to *Library, tag dependencyTag) {
Colin Crossf19b9bb2018-03-26 14:42:44 -0700669 if ctx.Host() {
670 return
671 }
672
Jiyong Park46f78fb2018-10-20 16:33:17 +0900673 myLinkType, stubs := getLinkType(from, ctx.ModuleName())
674 if stubs {
675 return
676 }
677 otherLinkType, _ := getLinkType(&to.Module, ctx.OtherModuleName(to))
Jiyong Park2d492942018-03-05 17:44:10 +0900678 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."
679
680 switch myLinkType {
681 case javaCore:
682 if otherLinkType != javaCore {
683 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 +0900684 ctx.OtherModuleName(to))
685 }
Jiyong Park2d492942018-03-05 17:44:10 +0900686 break
687 case javaSdk:
688 if otherLinkType != javaCore && otherLinkType != javaSdk {
689 ctx.ModuleErrorf("compiles against Android API, but dependency %q is compiling against non-public Android API."+commonMessage,
690 ctx.OtherModuleName(to))
691 }
692 break
693 case javaSystem:
694 if otherLinkType == javaPlatform {
695 ctx.ModuleErrorf("compiles against system API, but dependency %q is compiling against private API."+commonMessage,
696 ctx.OtherModuleName(to))
697 }
698 break
699 case javaPlatform:
700 // no restriction on link-type
701 break
Jiyong Park750e5572018-01-31 00:20:13 +0900702 }
703}
704
Colin Cross32f676a2017-09-06 13:41:06 -0700705func (j *Module) collectDeps(ctx android.ModuleContext) deps {
706 var deps deps
Colin Crossfc3674a2017-09-18 17:41:52 -0700707
Colin Cross300f0382018-03-06 13:11:51 -0800708 if ctx.Device() {
Colin Cross83bb3162018-06-25 15:48:06 -0700709 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Cross300f0382018-03-06 13:11:51 -0800710 if sdkDep.invalidVersion {
Colin Cross86a60ae2018-05-29 14:44:55 -0700711 ctx.AddMissingDependencies(sdkDep.modules)
Colin Cross300f0382018-03-06 13:11:51 -0800712 } else if sdkDep.useFiles {
713 // sdkDep.jar is actually equivalent to turbine header.jar.
Colin Cross86a60ae2018-05-29 14:44:55 -0700714 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross3047fa22019-04-18 10:56:44 -0700715 deps.aidlPreprocess = sdkDep.aidl
716 } else {
717 deps.aidlPreprocess = sdkDep.aidl
Colin Cross300f0382018-03-06 13:11:51 -0800718 }
Colin Crossfc3674a2017-09-18 17:41:52 -0700719 }
720
Colin Crossd11fcda2017-10-23 17:59:01 -0700721 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross2fe66872015-03-30 17:20:39 -0700722 otherName := ctx.OtherModuleName(module)
Colin Crossec7a0422017-07-07 14:47:12 -0700723 tag := ctx.OtherModuleDependencyTag(module)
724
Colin Crossa4f08812018-10-02 22:03:40 -0700725 if _, ok := tag.(*jniDependencyTag); ok {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700726 // Handled by AndroidApp.collectAppDeps
727 return
728 }
729 if tag == certificateTag {
730 // Handled by AndroidApp.collectAppDeps
Colin Crossa4f08812018-10-02 22:03:40 -0700731 return
732 }
733
Jiyong Park750e5572018-01-31 00:20:13 +0900734 if to, ok := module.(*Library); ok {
Colin Crossa97c5d32018-03-28 14:58:31 -0700735 switch tag {
736 case bootClasspathTag, libTag, staticLibTag:
737 checkLinkType(ctx, j, to, tag.(dependencyTag))
738 }
Jiyong Park750e5572018-01-31 00:20:13 +0900739 }
Colin Cross54250902017-12-05 09:28:08 -0800740 switch dep := module.(type) {
Colin Cross897d2ed2019-02-11 14:03:51 -0800741 case SdkLibraryDependency:
742 switch tag {
743 case libTag:
744 deps.classpath = append(deps.classpath, dep.SdkHeaderJars(ctx, j.sdkVersion())...)
745 // names of sdk libs that are directly depended are exported
746 j.exportedSdkLibs = append(j.exportedSdkLibs, otherName)
Colin Cross79c7c262019-04-17 11:11:46 -0700747 case staticLibTag:
Colin Cross897d2ed2019-02-11 14:03:51 -0800748 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
749 }
Colin Cross54250902017-12-05 09:28:08 -0800750 case Dependency:
751 switch tag {
752 case bootClasspathTag:
753 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars()...)
Colin Cross4b964c02018-10-15 16:18:06 -0700754 case libTag, instrumentationForTag:
Colin Cross54250902017-12-05 09:28:08 -0800755 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +0900756 // sdk lib names from dependencies are re-exported
757 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -0700758 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Colin Cross54250902017-12-05 09:28:08 -0800759 case staticLibTag:
760 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
761 deps.staticJars = append(deps.staticJars, dep.ImplementationJars()...)
762 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars()...)
Colin Cross331a1212018-08-15 20:40:52 -0700763 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +0900764 // sdk lib names from dependencies are re-exported
765 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -0700766 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Colin Crossbe9cdb82019-01-21 21:37:16 -0800767 case pluginTag:
768 if plugin, ok := dep.(*Plugin); ok {
769 deps.processorPath = append(deps.processorPath, dep.ImplementationAndResourcesJars()...)
770 if plugin.pluginProperties.Processor_class != nil {
771 deps.processorClasses = append(deps.processorClasses, *plugin.pluginProperties.Processor_class)
772 }
773 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
774 } else {
775 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
776 }
Colin Cross54250902017-12-05 09:28:08 -0800777 case frameworkResTag:
Mathew Inwoodebe29ce2018-09-04 14:26:19 +0100778 if (ctx.ModuleName() == "framework") || (ctx.ModuleName() == "framework-annotation-proc") {
Colin Cross54250902017-12-05 09:28:08 -0800779 // framework.jar has a one-off dependency on the R.java and Manifest.java files
780 // generated by framework-res.apk
781 deps.srcJars = append(deps.srcJars, dep.(*AndroidApp).aaptSrcJar)
782 }
Nan Zhangb2b33de2018-02-23 11:18:47 -0800783 case frameworkApkTag:
784 if ctx.ModuleName() == "android_stubs_current" ||
785 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -0700786 ctx.ModuleName() == "android_test_stubs_current" {
Nan Zhangb2b33de2018-02-23 11:18:47 -0800787 // framework stubs.jar need to depend on framework-res.apk, in order to pull the
788 // resource files out of there for aapt.
789 //
790 // Normally the package rule runs aapt, which includes the resource,
791 // but we're not running that in our package rule so just copy in the
792 // resource files here.
Colin Cross331a1212018-08-15 20:40:52 -0700793 deps.staticResourceJars = append(deps.staticResourceJars, dep.(*AndroidApp).exportPackage)
Nan Zhangb2b33de2018-02-23 11:18:47 -0800794 }
Colin Cross54250902017-12-05 09:28:08 -0800795 case kotlinStdlibTag:
796 deps.kotlinStdlib = dep.HeaderJars()
Colin Crossafbb1732019-01-17 15:42:52 -0800797 case kotlinAnnotationsTag:
798 deps.kotlinAnnotations = dep.HeaderJars()
Colin Cross54250902017-12-05 09:28:08 -0800799 }
800
Colin Cross54250902017-12-05 09:28:08 -0800801 case android.SourceFileProducer:
802 switch tag {
803 case libTag:
804 checkProducesJars(ctx, dep)
805 deps.classpath = append(deps.classpath, dep.Srcs()...)
806 case staticLibTag:
807 checkProducesJars(ctx, dep)
808 deps.classpath = append(deps.classpath, dep.Srcs()...)
809 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
810 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Cross54250902017-12-05 09:28:08 -0800811 }
812 default:
Colin Crossec7a0422017-07-07 14:47:12 -0700813 switch tag {
814 case android.DefaultsDepTag, android.SourceDepTag:
Dan Willemsend6ba0d52017-09-13 15:46:47 -0700815 // Nothing to do
Colin Cross1369cdb2017-09-29 17:58:17 -0700816 case systemModulesTag:
817 if deps.systemModules != nil {
818 panic("Found two system module dependencies")
819 }
820 sm := module.(*SystemModules)
821 if sm.outputFile == nil {
822 panic("Missing directory for system module dependency")
823 }
824 deps.systemModules = sm.outputFile
Colin Crossec7a0422017-07-07 14:47:12 -0700825 default:
826 ctx.ModuleErrorf("depends on non-java module %q", otherName)
Colin Cross2fe66872015-03-30 17:20:39 -0700827 }
Colin Crossec7a0422017-07-07 14:47:12 -0700828 }
Colin Cross2fe66872015-03-30 17:20:39 -0700829 })
830
Jiyong Park1be96912018-05-28 18:02:19 +0900831 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
832
Colin Cross32f676a2017-09-06 13:41:06 -0700833 return deps
Colin Cross2fe66872015-03-30 17:20:39 -0700834}
835
Colin Cross83bb3162018-06-25 15:48:06 -0700836func getJavaVersion(ctx android.ModuleContext, javaVersion string, sdkContext sdkContext) string {
Nan Zhang357466b2018-04-17 17:38:36 -0700837 var ret string
Colin Cross98fd5742019-01-09 23:04:25 -0800838 v := sdkContext.sdkVersion()
839 // For PDK builds, use the latest SDK version instead of "current"
840 if ctx.Config().IsPdkBuild() && (v == "" || v == "current") {
Colin Cross3047fa22019-04-18 10:56:44 -0700841 sdkVersions := ctx.Config().Get(sdkVersionsKey).([]int)
Colin Cross98fd5742019-01-09 23:04:25 -0800842 latestSdkVersion := 0
843 if len(sdkVersions) > 0 {
844 latestSdkVersion = sdkVersions[len(sdkVersions)-1]
845 }
846 v = strconv.Itoa(latestSdkVersion)
847 }
848
849 sdk, err := sdkVersionToNumber(ctx, v)
Colin Cross83bb3162018-06-25 15:48:06 -0700850 if err != nil {
851 ctx.PropertyErrorf("sdk_version", "%s", err)
852 }
Nan Zhang357466b2018-04-17 17:38:36 -0700853 if javaVersion != "" {
854 ret = javaVersion
855 } else if ctx.Device() && sdk <= 23 {
856 ret = "1.7"
Jiyong Park4584a8a2018-10-03 18:05:04 +0900857 } else if ctx.Device() && sdk <= 28 || !ctx.Config().TargetOpenJDK9() {
Nan Zhang357466b2018-04-17 17:38:36 -0700858 ret = "1.8"
Colin Cross83bb3162018-06-25 15:48:06 -0700859 } else if ctx.Device() && sdkContext.sdkVersion() != "" && sdk == android.FutureApiLevel {
Nan Zhang357466b2018-04-17 17:38:36 -0700860 // TODO(ccross): once we generate stubs we should be able to use 1.9 for sdk_version: "current"
861 ret = "1.8"
862 } else {
863 ret = "1.9"
864 }
865
866 return ret
867}
868
Nan Zhanged19fc32017-10-19 13:06:22 -0700869func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
Colin Crossc0b06f12015-04-08 13:03:43 -0700870
Colin Crossf03c82b2015-04-13 13:53:40 -0700871 var flags javaBuilderFlags
872
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100873 // javaVersion flag.
874 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), sdkContext(j))
875
Nan Zhanged19fc32017-10-19 13:06:22 -0700876 // javac flags.
Colin Crossf03c82b2015-04-13 13:53:40 -0700877 javacFlags := j.properties.Javacflags
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100878 if flags.javaVersion == "1.9" {
Colin Cross1369cdb2017-09-29 17:58:17 -0700879 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Nan Zhanged19fc32017-10-19 13:06:22 -0700880 }
Colin Cross6510f912017-11-29 00:27:14 -0800881 if ctx.Config().MinimizeJavaDebugInfo() {
Colin Cross126a25c2017-10-31 13:55:34 -0700882 // Override the -g flag passed globally to remove local variable debug info to reduce
883 // disk and memory usage.
884 javacFlags = append(javacFlags, "-g:source,lines")
885 }
Colin Cross64162712017-08-08 13:17:59 -0700886
Colin Cross66548102018-06-19 22:47:35 -0700887 if ctx.Config().RunErrorProne() {
888 if config.ErrorProneClasspath == nil {
889 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
890 }
891
892 errorProneFlags := []string{
893 "-Xplugin:ErrorProne",
894 "${config.ErrorProneChecks}",
895 }
896 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
897
898 flags.errorProneExtraJavacFlags = "${config.ErrorProneFlags} " +
899 "'" + strings.Join(errorProneFlags, " ") + "'"
900 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
Andreas Gampef3e5b552018-01-22 21:27:21 -0800901 }
902
Nan Zhanged19fc32017-10-19 13:06:22 -0700903 // classpath
Nan Zhang581fd212018-01-10 16:06:12 -0800904 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
905 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross6a77c982018-06-19 22:43:34 -0700906 flags.processorPath = append(flags.processorPath, deps.processorPath...)
Colin Cross7fdd2b72018-01-02 18:14:25 -0800907
Colin Crossbe9cdb82019-01-21 21:37:16 -0800908 flags.processor = strings.Join(deps.processorClasses, ",")
909
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100910 if len(flags.bootClasspath) == 0 && ctx.Host() && flags.javaVersion != "1.9" &&
Colin Cross7fdd2b72018-01-02 18:14:25 -0800911 !Bool(j.properties.No_standard_libs) &&
912 inList(flags.javaVersion, []string{"1.6", "1.7", "1.8"}) {
913 // Give host-side tools a version of OpenJDK's standard libraries
914 // close to what they're targeting. As of Dec 2017, AOSP is only
915 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
916 //
917 // When building with OpenJDK 8, the following should have no
918 // effect since those jars would be available by default.
919 //
920 // When building with OpenJDK 9 but targeting a version < 1.8,
921 // putting them on the bootclasspath means that:
922 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
923 // b) references to existing APIs are not reinterpreted in an
924 // OpenJDK 9-specific way, eg. calls to subclasses of
925 // java.nio.Buffer as in http://b/70862583
926 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
927 flags.bootClasspath = append(flags.bootClasspath,
928 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
929 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
Nan Zhang5f8cb422018-02-06 10:34:32 -0800930 if Bool(j.properties.Use_tools_jar) {
931 flags.bootClasspath = append(flags.bootClasspath,
932 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
933 }
Colin Cross7fdd2b72018-01-02 18:14:25 -0800934 }
935
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100936 if j.properties.Patch_module != nil && flags.javaVersion == "1.9" {
Jaewoong Jung38e4fb22018-12-12 09:01:34 -0800937 // Manually specify build directory in case it is not under the repo root.
938 // (javac doesn't seem to expand into symbolc links when searching for patch-module targets, so
939 // just adding a symlink under the root doesn't help.)
940 patchPaths := ".:" + ctx.Config().BuildDir()
941 classPath := flags.classpath.FormJavaClassPath("")
942 if classPath != "" {
943 patchPaths += ":" + classPath
944 }
945 javacFlags = append(javacFlags, "--patch-module="+String(j.properties.Patch_module)+"="+patchPaths)
Colin Cross81440082018-08-15 20:21:55 -0700946 }
947
Nan Zhanged19fc32017-10-19 13:06:22 -0700948 // systemModules
Colin Cross1369cdb2017-09-29 17:58:17 -0700949 if deps.systemModules != nil {
950 flags.systemModules = append(flags.systemModules, deps.systemModules)
951 }
952
Nan Zhanged19fc32017-10-19 13:06:22 -0700953 // aidl flags.
Colin Cross3047fa22019-04-18 10:56:44 -0700954 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs)
Colin Cross2fe66872015-03-30 17:20:39 -0700955
Colin Cross81440082018-08-15 20:21:55 -0700956 if len(javacFlags) > 0 {
957 // optimization.
958 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
959 flags.javacFlags = "$javacFlags"
960 }
961
Nan Zhanged19fc32017-10-19 13:06:22 -0700962 return flags
963}
Colin Crossc0b06f12015-04-08 13:03:43 -0700964
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800965func (j *Module) compile(ctx android.ModuleContext, extraSrcJars ...android.Path) {
Nan Zhanged19fc32017-10-19 13:06:22 -0700966
Colin Crossebe1a512017-11-14 13:12:14 -0800967 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
Nan Zhanged19fc32017-10-19 13:06:22 -0700968
969 deps := j.collectDeps(ctx)
970 flags := j.collectBuilderFlags(ctx, deps)
971
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100972 if flags.javaVersion == "1.9" {
Nan Zhanged19fc32017-10-19 13:06:22 -0700973 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
974 }
Colin Cross8a497952019-03-05 22:25:09 -0800975 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Colin Cross6af17aa2017-09-20 12:59:05 -0700976 if hasSrcExt(srcFiles.Strings(), ".proto") {
Colin Cross0f2ee152017-12-14 15:22:43 -0800977 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
Colin Cross6af17aa2017-09-20 12:59:05 -0700978 }
979
Colin Crossaf050172017-11-15 23:01:59 -0800980 srcFiles = j.genSources(ctx, srcFiles, flags)
981
982 srcJars := srcFiles.FilterByExt(".srcjar")
Colin Cross59149b62017-10-16 18:07:29 -0700983 srcJars = append(srcJars, deps.srcJars...)
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800984 srcJars = append(srcJars, extraSrcJars...)
Colin Crossb7a63242015-04-16 14:09:14 -0700985
Brandon Lee5d45c6f2018-08-15 15:35:38 -0700986 // Collect source files from compiledJavaSrcs, compiledSrcJars and filter out Exclude_srcs
987 // that IDEInfo struct will use
988 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, srcFiles.Strings()...)
989
Steven Morelandc4efd9c2019-01-18 11:51:25 -0800990 if j.properties.Jarjar_rules != nil {
Colin Cross8a497952019-03-05 22:25:09 -0800991 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
Steven Morelandc4efd9c2019-01-18 11:51:25 -0800992 }
993
Colin Cross1ee23172017-10-18 14:44:18 -0700994 jarName := ctx.ModuleName() + ".jar"
995
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +0000996 javaSrcFiles := srcFiles.FilterByExt(".java")
997 var uniqueSrcFiles android.Paths
998 set := make(map[string]bool)
999 for _, v := range javaSrcFiles {
1000 if _, found := set[v.String()]; !found {
1001 set[v.String()] = true
1002 uniqueSrcFiles = append(uniqueSrcFiles, v)
1003 }
1004 }
1005
Colin Cross55f63ea2018-08-27 12:37:09 -07001006 var kotlinJars android.Paths
1007
Colin Cross93e85952017-08-15 13:34:18 -07001008 if srcFiles.HasExt(".kt") {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001009 // user defined kotlin flags.
1010 kotlincFlags := j.properties.Kotlincflags
1011 CheckKotlincFlags(ctx, kotlincFlags)
1012
Colin Cross93e85952017-08-15 13:34:18 -07001013 // If there are kotlin files, compile them first but pass all the kotlin and java files
1014 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1015 // won't emit any classes for them.
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001016 kotlincFlags = append(kotlincFlags, "-no-stdlib")
Colin Cross93e85952017-08-15 13:34:18 -07001017 if ctx.Device() {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001018 kotlincFlags = append(kotlincFlags, "-no-jdk")
1019 }
1020 if len(kotlincFlags) > 0 {
1021 // optimization.
1022 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1023 flags.kotlincFlags += "$kotlincFlags"
Colin Cross93e85952017-08-15 13:34:18 -07001024 }
1025
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001026 var kotlinSrcFiles android.Paths
1027 kotlinSrcFiles = append(kotlinSrcFiles, uniqueSrcFiles...)
1028 kotlinSrcFiles = append(kotlinSrcFiles, srcFiles.FilterByExt(".kt")...)
1029
Colin Crossafbb1732019-01-17 15:42:52 -08001030 flags.classpath = append(flags.classpath, deps.kotlinStdlib...)
1031 flags.classpath = append(flags.classpath, deps.kotlinAnnotations...)
1032
1033 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1034 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1035
1036 if len(flags.processorPath) > 0 {
1037 // Use kapt for annotation processing
1038 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1039 kotlinKapt(ctx, kaptSrcJar, kotlinSrcFiles, srcJars, flags)
1040 srcJars = append(srcJars, kaptSrcJar)
1041 // Disable annotation processing in javac, it's already been handled by kapt
1042 flags.processorPath = nil
Colin Cross3a3e94c2019-01-23 15:39:50 -08001043 flags.processor = ""
Colin Crossafbb1732019-01-17 15:42:52 -08001044 }
Colin Cross93e85952017-08-15 13:34:18 -07001045
Colin Cross1ee23172017-10-18 14:44:18 -07001046 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross21fc9bb2019-01-18 15:05:09 -08001047 kotlinCompile(ctx, kotlinJar, kotlinSrcFiles, srcJars, flags)
Colin Cross93e85952017-08-15 13:34:18 -07001048 if ctx.Failed() {
1049 return
1050 }
1051
1052 // Make javac rule depend on the kotlinc rule
1053 flags.classpath = append(flags.classpath, kotlinJar)
Przemyslaw Szczepaniak66c0c402018-03-08 13:21:55 +00001054
Colin Cross93e85952017-08-15 13:34:18 -07001055 // Jar kotlin classes into the final jar after javac
Colin Cross55f63ea2018-08-27 12:37:09 -07001056 kotlinJars = append(kotlinJars, kotlinJar)
Colin Cross9b38aef2018-08-27 15:42:25 -07001057 kotlinJars = append(kotlinJars, deps.kotlinStdlib...)
Colin Cross93e85952017-08-15 13:34:18 -07001058 }
1059
Colin Cross55f63ea2018-08-27 12:37:09 -07001060 jars := append(android.Paths(nil), kotlinJars...)
1061
Colin Cross5ab4e6d2017-11-22 16:20:45 -08001062 // Store the list of .java files that was passed to javac
1063 j.compiledJavaSrcs = uniqueSrcFiles
1064 j.compiledSrcJars = srcJars
1065
Nan Zhang61eaedb2017-11-02 13:28:15 -07001066 enable_sharding := false
Colin Crossbe9cdb82019-01-21 21:37:16 -08001067 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !deps.disableTurbine {
Nan Zhang61eaedb2017-11-02 13:28:15 -07001068 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1069 enable_sharding = true
Ashley Rosee36efcf2019-01-16 17:34:08 -05001070 // Formerly, there was a check here that prevented annotation processors
1071 // from being used when sharding was enabled, as some annotation processors
1072 // do not function correctly in sharded environments. It was removed to
1073 // allow for the use of annotation processors that do function correctly
1074 // with sharding enabled. See: b/77284273.
Nan Zhang61eaedb2017-11-02 13:28:15 -07001075 }
Colin Cross55f63ea2018-08-27 12:37:09 -07001076 j.headerJarFile = j.compileJavaHeader(ctx, uniqueSrcFiles, srcJars, deps, flags, jarName, kotlinJars)
Colin Crossf19b9bb2018-03-26 14:42:44 -07001077 if ctx.Failed() {
1078 return
Nan Zhanged19fc32017-10-19 13:06:22 -07001079 }
1080 }
Colin Cross8eadbf02017-10-24 17:46:00 -07001081 if len(uniqueSrcFiles) > 0 || len(srcJars) > 0 {
Colin Crossd6891432017-09-27 17:39:56 -07001082 var extraJarDeps android.Paths
Colin Cross66548102018-06-19 22:47:35 -07001083 if ctx.Config().RunErrorProne() {
Colin Crossc6bbef32017-08-14 14:16:06 -07001084 // If error-prone is enabled, add an additional rule to compile the java files into
1085 // a separate set of classes (so that they don't overwrite the normal ones and require
Colin Crossd6891432017-09-27 17:39:56 -07001086 // a rebuild when error-prone is turned off).
Colin Crossc6bbef32017-08-14 14:16:06 -07001087 // TODO(ccross): Once we always compile with javac9 we may be able to conditionally
1088 // enable error-prone without affecting the output class files.
Colin Cross1ee23172017-10-18 14:44:18 -07001089 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001090 RunErrorProne(ctx, errorprone, uniqueSrcFiles, srcJars, flags)
Colin Crossc6bbef32017-08-14 14:16:06 -07001091 extraJarDeps = append(extraJarDeps, errorprone)
1092 }
1093
Nan Zhang61eaedb2017-11-02 13:28:15 -07001094 if enable_sharding {
Nan Zhang581fd212018-01-10 16:06:12 -08001095 flags.classpath = append(flags.classpath, j.headerJarFile)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001096 shardSize := int(*(j.properties.Javac_shard_size))
1097 var shardSrcs []android.Paths
1098 if len(uniqueSrcFiles) > 0 {
1099 shardSrcs = shardPaths(uniqueSrcFiles, shardSize)
1100 for idx, shardSrc := range shardSrcs {
1101 classes := android.PathForModuleOut(ctx, "javac", jarName+strconv.Itoa(idx))
1102 TransformJavaToClasses(ctx, classes, idx, shardSrc, nil, flags, extraJarDeps)
1103 jars = append(jars, classes)
1104 }
1105 }
1106 if len(srcJars) > 0 {
1107 classes := android.PathForModuleOut(ctx, "javac", jarName+strconv.Itoa(len(shardSrcs)))
1108 TransformJavaToClasses(ctx, classes, len(shardSrcs), nil, srcJars, flags, extraJarDeps)
1109 jars = append(jars, classes)
1110 }
1111 } else {
1112 classes := android.PathForModuleOut(ctx, "javac", jarName)
1113 TransformJavaToClasses(ctx, classes, -1, uniqueSrcFiles, srcJars, flags, extraJarDeps)
1114 jars = append(jars, classes)
1115 }
Colin Crossd6891432017-09-27 17:39:56 -07001116 if ctx.Failed() {
1117 return
1118 }
Colin Cross2fe66872015-03-30 17:20:39 -07001119 }
1120
Colin Cross0c4ce212019-05-03 15:28:19 -07001121 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1122
1123 var includeSrcJar android.WritablePath
1124 if Bool(j.properties.Include_srcs) {
1125 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1126 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1127 }
1128
Colin Crosscedd4762018-09-13 11:26:19 -07001129 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1130 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
Colin Cross0f37af02017-09-27 17:42:05 -07001131 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
Colin Cross988708c2019-05-06 14:04:11 -07001132 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
Colin Cross0f37af02017-09-27 17:42:05 -07001133
1134 var resArgs []string
1135 var resDeps android.Paths
1136
1137 resArgs = append(resArgs, dirArgs...)
1138 resDeps = append(resDeps, dirDeps...)
1139
1140 resArgs = append(resArgs, fileArgs...)
1141 resDeps = append(resDeps, fileDeps...)
1142
Colin Cross988708c2019-05-06 14:04:11 -07001143 resArgs = append(resArgs, extraArgs...)
1144 resDeps = append(resDeps, extraDeps...)
1145
Colin Cross40a36712017-09-27 17:41:35 -07001146 if len(resArgs) > 0 {
Colin Cross1ee23172017-10-18 14:44:18 -07001147 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
Colin Crosse9a275b2017-10-16 17:09:48 -07001148 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Colin Cross331a1212018-08-15 20:40:52 -07001149 j.resourceJar = resourceJar
Colin Cross65bf4f22015-04-03 16:54:17 -07001150 if ctx.Failed() {
1151 return
1152 }
1153 }
1154
Colin Cross0c4ce212019-05-03 15:28:19 -07001155 var resourceJars android.Paths
1156 if j.resourceJar != nil {
1157 resourceJars = append(resourceJars, j.resourceJar)
1158 }
1159 if Bool(j.properties.Include_srcs) {
1160 resourceJars = append(resourceJars, includeSrcJar)
1161 }
1162 resourceJars = append(resourceJars, deps.staticResourceJars...)
Colin Cross331a1212018-08-15 20:40:52 -07001163
Colin Cross0c4ce212019-05-03 15:28:19 -07001164 if len(resourceJars) > 1 {
Colin Cross331a1212018-08-15 20:40:52 -07001165 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
Colin Cross0c4ce212019-05-03 15:28:19 -07001166 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
Colin Cross331a1212018-08-15 20:40:52 -07001167 false, nil, nil)
1168 j.resourceJar = combinedJar
Colin Cross0c4ce212019-05-03 15:28:19 -07001169 } else if len(resourceJars) == 1 {
1170 j.resourceJar = resourceJars[0]
Colin Cross331a1212018-08-15 20:40:52 -07001171 }
1172
Colin Cross32f676a2017-09-06 13:41:06 -07001173 jars = append(jars, deps.staticJars...)
Colin Cross0a6e0072017-08-30 14:24:55 -07001174
Colin Cross094054a2018-10-17 15:10:48 -07001175 manifest := j.overrideManifest
1176 if !manifest.Valid() && j.properties.Manifest != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001177 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Colin Cross366938f2017-12-11 16:29:02 -08001178 }
Colin Cross635acc92017-09-12 22:50:46 -07001179
Colin Cross8a497952019-03-05 22:25:09 -08001180 services := android.PathsForModuleSrc(ctx, j.properties.Services)
Alex Light7f004a72019-02-21 13:27:37 -08001181 if len(services) > 0 {
1182 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1183 var zipargs []string
1184 for _, file := range services {
1185 serviceFile := file.String()
1186 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1187 }
1188 ctx.Build(pctx, android.BuildParams{
1189 Rule: zip,
1190 Output: servicesJar,
1191 Implicits: services,
1192 Args: map[string]string{
Colin Cross0b9f31f2019-02-28 11:00:01 -08001193 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
Alex Light7f004a72019-02-21 13:27:37 -08001194 },
1195 })
1196 jars = append(jars, servicesJar)
1197 }
1198
Colin Cross0a6e0072017-08-30 14:24:55 -07001199 // Combine the classes built from sources, any manifests, and any static libraries into
Nan Zhanged19fc32017-10-19 13:06:22 -07001200 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross3063b782018-08-15 11:19:12 -07001201 var outputFile android.ModuleOutPath
Colin Crosse9a275b2017-10-16 17:09:48 -07001202
1203 if len(jars) == 1 && !manifest.Valid() {
Colin Cross3063b782018-08-15 11:19:12 -07001204 if moduleOutPath, ok := jars[0].(android.ModuleOutPath); ok {
1205 // Optimization: skip the combine step if there is nothing to do
1206 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1207 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1208 // any if len(jars) == 1.
1209 outputFile = moduleOutPath
1210 } else {
1211 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1212 ctx.Build(pctx, android.BuildParams{
1213 Rule: android.Cp,
1214 Input: jars[0],
1215 Output: combinedJar,
1216 })
1217 outputFile = combinedJar
1218 }
Colin Crosse9a275b2017-10-16 17:09:48 -07001219 } else {
Colin Cross1ee23172017-10-18 14:44:18 -07001220 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001221 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
Colin Cross9b38aef2018-08-27 15:42:25 -07001222 false, nil, nil)
Colin Crosse9a275b2017-10-16 17:09:48 -07001223 outputFile = combinedJar
1224 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001225
Colin Cross331a1212018-08-15 20:40:52 -07001226 // jarjar implementation jar if necessary
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001227 if j.expandJarjarRules != nil {
Colin Cross8649b262017-09-27 18:03:17 -07001228 // Transform classes.jar into classes-jarjar.jar
Colin Cross1ee23172017-10-18 14:44:18 -07001229 jarjarFile := android.PathForModuleOut(ctx, "jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001230 TransformJarJar(ctx, jarjarFile, outputFile, j.expandJarjarRules)
Colin Crosse9a275b2017-10-16 17:09:48 -07001231 outputFile = jarjarFile
Colin Cross331a1212018-08-15 20:40:52 -07001232
1233 // jarjar resource jar if necessary
1234 if j.resourceJar != nil {
1235 resourceJarJarFile := android.PathForModuleOut(ctx, "res-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001236 TransformJarJar(ctx, resourceJarJarFile, j.resourceJar, j.expandJarjarRules)
Colin Cross331a1212018-08-15 20:40:52 -07001237 j.resourceJar = resourceJarJarFile
1238 }
1239
Colin Cross0a6e0072017-08-30 14:24:55 -07001240 if ctx.Failed() {
1241 return
1242 }
1243 }
Vladimir Marko0975ee02019-04-02 10:29:55 +01001244
1245 // Check package restrictions if necessary.
1246 if len(j.properties.Permitted_packages) > 0 {
1247 // Check packages and copy to package-checked file.
1248 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
1249 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
1250 j.additionalCheckedModules = append(j.additionalCheckedModules, pkgckFile)
1251
1252 if ctx.Failed() {
1253 return
1254 }
1255 }
1256
Nan Zhanged19fc32017-10-19 13:06:22 -07001257 j.implementationJarFile = outputFile
1258 if j.headerJarFile == nil {
1259 j.headerJarFile = j.implementationJarFile
1260 }
Colin Cross2fe66872015-03-30 17:20:39 -07001261
Colin Cross6510f912017-11-29 00:27:14 -08001262 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
Colin Crosscb933592017-11-22 13:49:43 -08001263 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
1264 j.properties.Instrument = true
1265 }
1266 }
1267
Colin Cross3144dfc2018-01-03 15:06:47 -08001268 if j.shouldInstrument(ctx) {
Colin Crosscb933592017-11-22 13:49:43 -08001269 outputFile = j.instrument(ctx, flags, outputFile, jarName)
1270 }
1271
Colin Cross331a1212018-08-15 20:40:52 -07001272 // merge implementation jar with resources if necessary
1273 implementationAndResourcesJar := outputFile
1274 if j.resourceJar != nil {
Colin Cross08a409d2019-04-29 10:22:44 -07001275 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
Colin Cross331a1212018-08-15 20:40:52 -07001276 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
Colin Cross08a409d2019-04-29 10:22:44 -07001277 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
Colin Cross331a1212018-08-15 20:40:52 -07001278 false, nil, nil)
1279 implementationAndResourcesJar = combinedJar
1280 }
1281
1282 j.implementationAndResourcesJar = implementationAndResourcesJar
1283
Colin Cross9ae1b922018-06-26 17:59:05 -07001284 if ctx.Device() && (Bool(j.properties.Installable) || Bool(j.deviceProperties.Compile_dex)) {
Colin Cross8faf8fc2019-01-16 15:15:52 -08001285 // Dex compilation
Colin Cross3063b782018-08-15 11:19:12 -07001286 var dexOutputFile android.ModuleOutPath
David Brazdil17ef5632018-06-27 10:27:45 +01001287 dexOutputFile = j.compileDex(ctx, flags, outputFile, jarName)
Colin Cross2fe66872015-03-30 17:20:39 -07001288 if ctx.Failed() {
1289 return
1290 }
Colin Cross331a1212018-08-15 20:40:52 -07001291
Colin Cross8faf8fc2019-01-16 15:15:52 -08001292 // Hidden API CSV generation and dex encoding
Colin Crossf24a22a2019-01-31 14:12:44 -08001293 dexOutputFile = j.hiddenAPI.hiddenAPI(ctx, dexOutputFile, j.implementationJarFile,
1294 j.deviceProperties.UncompressDex)
Colin Cross8faf8fc2019-01-16 15:15:52 -08001295
Colin Cross331a1212018-08-15 20:40:52 -07001296 // merge dex jar with resources if necessary
1297 if j.resourceJar != nil {
1298 jars := android.Paths{dexOutputFile, j.resourceJar}
1299 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
1300 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1301 false, nil, nil)
Nicolas Geoffrayf3438722019-01-23 15:57:21 +00001302 if j.deviceProperties.UncompressDex {
1303 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
1304 TransformZipAlign(ctx, combinedAlignedJar, combinedJar)
1305 dexOutputFile = combinedAlignedJar
1306 } else {
1307 dexOutputFile = combinedJar
1308 }
Colin Cross331a1212018-08-15 20:40:52 -07001309 }
1310
1311 j.dexJarFile = dexOutputFile
1312
Colin Cross8faf8fc2019-01-16 15:15:52 -08001313 // Dexpreopting
Colin Cross43f08db2018-11-12 10:13:39 -08001314 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
1315
1316 j.maybeStrippedDexJarFile = dexOutputFile
1317
Colin Cross3063b782018-08-15 11:19:12 -07001318 outputFile = dexOutputFile
Colin Cross43f08db2018-11-12 10:13:39 -08001319
1320 if ctx.Failed() {
1321 return
1322 }
Colin Cross331a1212018-08-15 20:40:52 -07001323 } else {
1324 outputFile = implementationAndResourcesJar
Colin Cross2fe66872015-03-30 17:20:39 -07001325 }
Colin Cross331a1212018-08-15 20:40:52 -07001326
Colin Crossb7a63242015-04-16 14:09:14 -07001327 ctx.CheckbuildFile(outputFile)
Colin Cross3063b782018-08-15 11:19:12 -07001328
1329 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1330 j.outputFile = outputFile.WithoutRel()
Colin Cross2fe66872015-03-30 17:20:39 -07001331}
1332
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001333// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1334// since some of these flags may be used internally.
1335func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1336 for _, flag := range flags {
1337 flag = strings.TrimSpace(flag)
1338
1339 if !strings.HasPrefix(flag, "-") {
1340 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1341 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1342 ctx.PropertyErrorf("kotlincflags",
1343 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1344 } else if inList(flag, config.KotlincIllegalFlags) {
1345 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1346 } else if flag == "-include-runtime" {
1347 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1348 } else {
1349 args := strings.Split(flag, " ")
1350 if args[0] == "-kotlin-home" {
1351 ctx.PropertyErrorf("kotlincflags",
1352 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1353 }
1354 }
1355 }
1356}
1357
Colin Cross8eadbf02017-10-24 17:46:00 -07001358func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
Colin Cross55f63ea2018-08-27 12:37:09 -07001359 deps deps, flags javaBuilderFlags, jarName string, extraJars android.Paths) android.Path {
Nan Zhanged19fc32017-10-19 13:06:22 -07001360
1361 var jars android.Paths
Colin Cross8eadbf02017-10-24 17:46:00 -07001362 if len(srcFiles) > 0 || len(srcJars) > 0 {
Nan Zhanged19fc32017-10-19 13:06:22 -07001363 // Compile java sources into turbine.jar.
1364 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1365 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
1366 if ctx.Failed() {
1367 return nil
1368 }
1369 jars = append(jars, turbineJar)
1370 }
1371
Colin Cross55f63ea2018-08-27 12:37:09 -07001372 jars = append(jars, extraJars...)
1373
Nan Zhanged19fc32017-10-19 13:06:22 -07001374 // Combine any static header libraries into classes-header.jar. If there is only
1375 // one input jar this step will be skipped.
1376 var headerJar android.Path
1377 jars = append(jars, deps.staticHeaderJars...)
1378
Colin Cross5c6ecc12017-10-23 18:12:27 -07001379 // we cannot skip the combine step for now if there is only one jar
1380 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
1381 combinedJar := android.PathForModuleOut(ctx, "turbine-combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001382 TransformJarsToJar(ctx, combinedJar, "for turbine", jars, android.OptionalPath{},
1383 false, nil, []string{"META-INF"})
Colin Cross5c6ecc12017-10-23 18:12:27 -07001384 headerJar = combinedJar
Nan Zhanged19fc32017-10-19 13:06:22 -07001385
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001386 if j.expandJarjarRules != nil {
Nan Zhanged19fc32017-10-19 13:06:22 -07001387 // Transform classes.jar into classes-jarjar.jar
1388 jarjarFile := android.PathForModuleOut(ctx, "turbine-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001389 TransformJarJar(ctx, jarjarFile, headerJar, j.expandJarjarRules)
Nan Zhanged19fc32017-10-19 13:06:22 -07001390 headerJar = jarjarFile
1391 if ctx.Failed() {
1392 return nil
1393 }
1394 }
1395
1396 return headerJar
1397}
1398
Colin Crosscb933592017-11-22 13:49:43 -08001399func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross3063b782018-08-15 11:19:12 -07001400 classesJar android.Path, jarName string) android.ModuleOutPath {
Colin Crosscb933592017-11-22 13:49:43 -08001401
Colin Cross7a3139e2017-12-19 13:57:50 -08001402 specs := j.jacocoModuleToZipCommand(ctx)
Colin Crosscb933592017-11-22 13:49:43 -08001403
Colin Cross84c38822018-01-03 15:59:46 -08001404 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Crosscb933592017-11-22 13:49:43 -08001405 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
1406
1407 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1408
1409 j.jacocoReportClassesFile = jacocoReportClassesFile
1410
1411 return instrumentedJar
1412}
1413
albaltai36ff7dc2018-12-25 14:35:23 +08001414var _ Dependency = (*Module)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07001415
Nan Zhanged19fc32017-10-19 13:06:22 -07001416func (j *Module) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001417 if j.headerJarFile == nil {
1418 return nil
1419 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001420 return android.Paths{j.headerJarFile}
1421}
1422
1423func (j *Module) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08001424 if j.implementationJarFile == nil {
1425 return nil
1426 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001427 return android.Paths{j.implementationJarFile}
Colin Cross2fe66872015-03-30 17:20:39 -07001428}
1429
Colin Crossf24a22a2019-01-31 14:12:44 -08001430func (j *Module) DexJar() android.Path {
1431 return j.dexJarFile
1432}
1433
Colin Cross331a1212018-08-15 20:40:52 -07001434func (j *Module) ResourceJars() android.Paths {
1435 if j.resourceJar == nil {
1436 return nil
1437 }
1438 return android.Paths{j.resourceJar}
1439}
1440
1441func (j *Module) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001442 if j.implementationAndResourcesJar == nil {
1443 return nil
1444 }
Colin Cross331a1212018-08-15 20:40:52 -07001445 return android.Paths{j.implementationAndResourcesJar}
1446}
1447
Colin Cross46c9b8b2017-06-22 16:51:17 -07001448func (j *Module) AidlIncludeDirs() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001449 // exportAidlIncludeDirs is type android.Paths already
Colin Crossc0b06f12015-04-08 13:03:43 -07001450 return j.exportAidlIncludeDirs
1451}
1452
Jiyong Park1be96912018-05-28 18:02:19 +09001453func (j *Module) ExportedSdkLibs() []string {
albaltai36ff7dc2018-12-25 14:35:23 +08001454 // exportedSdkLibs is type []string
Jiyong Park1be96912018-05-28 18:02:19 +09001455 return j.exportedSdkLibs
1456}
1457
Colin Cross0c4ce212019-05-03 15:28:19 -07001458func (j *Module) SrcJarArgs() ([]string, android.Paths) {
1459 return j.srcJarArgs, j.srcJarDeps
1460}
1461
Colin Cross46c9b8b2017-06-22 16:51:17 -07001462var _ logtagsProducer = (*Module)(nil)
Colin Crossf05fe972015-04-10 17:45:20 -07001463
Colin Cross46c9b8b2017-06-22 16:51:17 -07001464func (j *Module) logtags() android.Paths {
Colin Crossf05fe972015-04-10 17:45:20 -07001465 return j.logtagsSrcs
1466}
1467
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001468// Collect information for opening IDE project files in java/jdeps.go.
1469func (j *Module) IDEInfo(dpInfo *android.IdeInfo) {
1470 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
1471 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
patricktu18c82ff2019-05-10 15:48:50 +08001472 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001473 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001474 if j.expandJarjarRules != nil {
1475 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001476 }
1477}
1478
1479func (j *Module) CompilerDeps() []string {
1480 jdeps := []string{}
1481 jdeps = append(jdeps, j.properties.Libs...)
1482 jdeps = append(jdeps, j.properties.Static_libs...)
1483 return jdeps
1484}
1485
Colin Cross2fe66872015-03-30 17:20:39 -07001486//
1487// Java libraries (.jar file)
1488//
1489
Colin Crossf506d872017-07-19 15:53:04 -07001490type Library struct {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001491 Module
Colin Cross2fe66872015-03-30 17:20:39 -07001492}
1493
Colin Cross42be7612019-02-21 18:12:14 -08001494func shouldUncompressDex(ctx android.ModuleContext, dexpreopter *dexpreopter) bool {
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +00001495 // Store uncompressed (and do not strip) dex files from boot class path jars.
1496 if inList(ctx.ModuleName(), ctx.Config().BootJars()) {
1497 return true
1498 }
1499
1500 // Store uncompressed dex files that are preopted on /system.
Colin Cross42be7612019-02-21 18:12:14 -08001501 if !dexpreopter.dexpreoptDisabled(ctx) && (ctx.Host() || !odexOnSystemOther(ctx, dexpreopter.installPath)) {
Vladimir Markoe8b00d62018-12-21 15:54:16 +00001502 return true
1503 }
Colin Cross083a2aa2019-02-06 16:37:12 -08001504 if ctx.Config().UncompressPrivAppDex() &&
1505 inList(ctx.ModuleName(), ctx.Config().ModulesLoadedByPrivilegedModules()) {
1506 return true
1507 }
1508
Colin Cross2fc72f62018-12-21 12:59:54 -08001509 return false
1510}
1511
Colin Crossf506d872017-07-19 15:53:04 -07001512func (j *Library) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross43f08db2018-11-12 10:13:39 -08001513 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", ctx.ModuleName()+".jar")
1514 j.dexpreopter.isSDKLibrary = j.deviceProperties.IsSDKLibrary
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +00001515 j.dexpreopter.isInstallable = Bool(j.properties.Installable)
Colin Cross42be7612019-02-21 18:12:14 -08001516 j.dexpreopter.uncompressedDex = shouldUncompressDex(ctx, &j.dexpreopter)
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +00001517 j.deviceProperties.UncompressDex = j.dexpreopter.uncompressedDex
Colin Cross46c9b8b2017-06-22 16:51:17 -07001518 j.compile(ctx)
Colin Crossb7a63242015-04-16 14:09:14 -07001519
Nicolas Geoffray4bdea392019-01-15 11:48:08 +00001520 if (Bool(j.properties.Installable) || ctx.Host()) && !android.DirectlyInAnyApex(ctx, ctx.ModuleName()) {
Colin Cross2c429dc2017-08-31 16:45:16 -07001521 j.installFile = ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
1522 ctx.ModuleName()+".jar", j.outputFile)
1523 }
Colin Crossb7a63242015-04-16 14:09:14 -07001524}
1525
Colin Crossf506d872017-07-19 15:53:04 -07001526func (j *Library) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001527 j.deps(ctx)
1528}
1529
Colin Cross1b16b0e2019-02-12 14:41:32 -08001530// java_library builds and links sources into a `.jar` file for the device, and possibly for the host as well.
1531//
1532// By default, a java_library has a single variant that produces a `.jar` file containing `.class` files that were
1533// compiled against the device bootclasspath. This jar is not suitable for installing on a device, but can be used
1534// as a `static_libs` dependency of another module.
1535//
1536// Specifying `installable: true` will product a `.jar` file containing `classes.dex` files, suitable for installing on
1537// a device.
1538//
1539// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
1540// compiled against the host bootclasspath.
Colin Cross9ae1b922018-06-26 17:59:05 -07001541func LibraryFactory() android.Module {
1542 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07001543
Colin Cross9ae1b922018-06-26 17:59:05 -07001544 module.AddProperties(
1545 &module.Module.properties,
1546 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08001547 &module.Module.dexpreoptProperties,
Colin Cross9ae1b922018-06-26 17:59:05 -07001548 &module.Module.protoProperties)
Colin Cross2fe66872015-03-30 17:20:39 -07001549
Colin Cross9ae1b922018-06-26 17:59:05 -07001550 InitJavaModule(module, android.HostAndDeviceSupported)
1551 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001552}
1553
Colin Cross1b16b0e2019-02-12 14:41:32 -08001554// java_library_static is an obsolete alias for java_library.
1555func LibraryStaticFactory() android.Module {
1556 return LibraryFactory()
1557}
1558
1559// java_library_host builds and links sources into a `.jar` file for the host.
1560//
1561// A java_library_host has a single variant that produces a `.jar` file containing `.class` files that were
1562// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07001563func LibraryHostFactory() android.Module {
1564 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07001565
Colin Cross6af17aa2017-09-20 12:59:05 -07001566 module.AddProperties(
1567 &module.Module.properties,
1568 &module.Module.protoProperties)
Colin Cross36242852017-06-23 15:06:31 -07001569
Colin Cross9ae1b922018-06-26 17:59:05 -07001570 module.Module.properties.Installable = proptools.BoolPtr(true)
1571
Colin Cross89536d42017-07-07 14:35:50 -07001572 InitJavaModule(module, android.HostSupported)
Colin Cross36242852017-06-23 15:06:31 -07001573 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001574}
1575
1576//
Colin Crossb628ea52018-08-14 16:42:33 -07001577// Java Tests
Colin Cross05638fc2018-04-09 18:40:24 -07001578//
1579
1580type testProperties struct {
Colin Cross05638fc2018-04-09 18:40:24 -07001581 // list of compatibility suites (for example "cts", "vts") that the module should be
1582 // installed into.
1583 Test_suites []string `android:"arch_variant"`
Julien Despreze146e392018-08-02 15:00:46 -07001584
1585 // the name of the test configuration (for example "AndroidTest.xml") that should be
1586 // installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08001587 Test_config *string `android:"path,arch_variant"`
Colin Crossd96ca352018-08-10 16:06:24 -07001588
Jack He33338892018-09-19 02:21:28 -07001589 // the name of the test configuration template (for example "AndroidTestTemplate.xml") that
1590 // should be installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08001591 Test_config_template *string `android:"path,arch_variant"`
Jack He33338892018-09-19 02:21:28 -07001592
Colin Crossd96ca352018-08-10 16:06:24 -07001593 // list of files or filegroup modules that provide data that should be installed alongside
1594 // the test
Colin Cross27b922f2019-03-04 22:35:41 -08001595 Data []string `android:"path"`
Colin Cross05638fc2018-04-09 18:40:24 -07001596}
1597
Paul Duffin42df1442019-03-20 12:45:53 +00001598type testHelperLibraryProperties struct {
1599 // list of compatibility suites (for example "cts", "vts") that the module should be
1600 // installed into.
1601 Test_suites []string `android:"arch_variant"`
1602}
1603
Colin Cross05638fc2018-04-09 18:40:24 -07001604type Test struct {
1605 Library
1606
1607 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07001608
1609 testConfig android.Path
Colin Crossd96ca352018-08-10 16:06:24 -07001610 data android.Paths
Colin Cross303e21f2018-08-07 16:49:25 -07001611}
1612
Paul Duffin42df1442019-03-20 12:45:53 +00001613type TestHelperLibrary struct {
1614 Library
1615
1616 testHelperLibraryProperties testHelperLibraryProperties
1617}
1618
Colin Cross303e21f2018-08-07 16:49:25 -07001619func (j *Test) GenerateAndroidBuildActions(ctx android.ModuleContext) {
yangbill4f41bc22019-02-13 21:45:47 +08001620 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 -08001621 j.data = android.PathsForModuleSrc(ctx, j.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07001622
1623 j.Library.GenerateAndroidBuildActions(ctx)
Colin Cross05638fc2018-04-09 18:40:24 -07001624}
1625
Paul Duffin42df1442019-03-20 12:45:53 +00001626func (j *TestHelperLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1627 j.Library.GenerateAndroidBuildActions(ctx)
1628}
1629
Colin Cross1b16b0e2019-02-12 14:41:32 -08001630// java_test builds a and links sources into a `.jar` file for the device, and possibly for the host as well, and
1631// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
1632//
1633// By default, a java_test has a single variant that produces a `.jar` file containing `classes.dex` files that were
1634// compiled against the device bootclasspath.
1635//
1636// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
1637// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07001638func TestFactory() android.Module {
1639 module := &Test{}
1640
1641 module.AddProperties(
1642 &module.Module.properties,
1643 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08001644 &module.Module.dexpreoptProperties,
Colin Cross05638fc2018-04-09 18:40:24 -07001645 &module.Module.protoProperties,
1646 &module.testProperties)
1647
Colin Cross9ae1b922018-06-26 17:59:05 -07001648 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse3026872019-01-05 22:30:13 -08001649 module.Module.dexpreopter.isTest = true
Colin Cross9ae1b922018-06-26 17:59:05 -07001650
Colin Cross05638fc2018-04-09 18:40:24 -07001651 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07001652 return module
1653}
1654
Paul Duffin42df1442019-03-20 12:45:53 +00001655// java_test_helper_library creates a java library and makes sure that it is added to the appropriate test suite.
1656func TestHelperLibraryFactory() android.Module {
1657 module := &TestHelperLibrary{}
1658
1659 module.AddProperties(
1660 &module.Module.properties,
1661 &module.Module.deviceProperties,
1662 &module.Module.dexpreoptProperties,
1663 &module.Module.protoProperties,
1664 &module.testHelperLibraryProperties)
1665
Colin Cross9a4abed2019-04-24 13:19:28 -07001666 module.Module.properties.Installable = proptools.BoolPtr(true)
1667 module.Module.dexpreopter.isTest = true
1668
Paul Duffin42df1442019-03-20 12:45:53 +00001669 InitJavaModule(module, android.HostAndDeviceSupported)
1670 return module
1671}
1672
Colin Cross1b16b0e2019-02-12 14:41:32 -08001673// java_test_host builds a and links sources into a `.jar` file for the host, and creates an `AndroidTest.xml` file to
1674// allow running the test with `atest` or a `TEST_MAPPING` file.
1675//
1676// A java_test_host has a single variant that produces a `.jar` file containing `.class` files that were
1677// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07001678func TestHostFactory() android.Module {
1679 module := &Test{}
1680
1681 module.AddProperties(
1682 &module.Module.properties,
1683 &module.Module.protoProperties,
1684 &module.testProperties)
1685
Colin Cross9ae1b922018-06-26 17:59:05 -07001686 module.Module.properties.Installable = proptools.BoolPtr(true)
1687
Colin Cross05638fc2018-04-09 18:40:24 -07001688 InitJavaModule(module, android.HostSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07001689 return module
1690}
1691
1692//
Colin Cross2fe66872015-03-30 17:20:39 -07001693// Java Binaries (.jar file plus wrapper script)
1694//
1695
Colin Crossf506d872017-07-19 15:53:04 -07001696type binaryProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -07001697 // installable script to execute the resulting jar
Colin Cross27b922f2019-03-04 22:35:41 -08001698 Wrapper *string `android:"path"`
Colin Cross094054a2018-10-17 15:10:48 -07001699
1700 // Name of the class containing main to be inserted into the manifest as Main-Class.
1701 Main_class *string
Colin Cross7d5136f2015-05-11 13:39:40 -07001702}
1703
Colin Crossf506d872017-07-19 15:53:04 -07001704type Binary struct {
1705 Library
Colin Cross2fe66872015-03-30 17:20:39 -07001706
Colin Crossf506d872017-07-19 15:53:04 -07001707 binaryProperties binaryProperties
Colin Cross10a03492017-08-10 17:09:43 -07001708
Colin Cross6b4a32d2017-12-05 13:42:45 -08001709 isWrapperVariant bool
1710
Colin Crossc3315992017-12-08 19:12:36 -08001711 wrapperFile android.Path
Colin Cross10a03492017-08-10 17:09:43 -07001712 binaryFile android.OutputPath
Colin Cross2fe66872015-03-30 17:20:39 -07001713}
1714
Alex Light24237172017-10-26 09:46:21 -07001715func (j *Binary) HostToolPath() android.OptionalPath {
1716 return android.OptionalPathForPath(j.binaryFile)
1717}
1718
Colin Crossf506d872017-07-19 15:53:04 -07001719func (j *Binary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08001720 if ctx.Arch().ArchType == android.Common {
1721 // Compile the jar
Colin Cross094054a2018-10-17 15:10:48 -07001722 if j.binaryProperties.Main_class != nil {
1723 if j.properties.Manifest != nil {
1724 ctx.PropertyErrorf("main_class", "main_class cannot be used when manifest is set")
1725 }
1726 manifestFile := android.PathForModuleOut(ctx, "manifest.txt")
1727 GenerateMainClassManifest(ctx, manifestFile, String(j.binaryProperties.Main_class))
1728 j.overrideManifest = android.OptionalPathForPath(manifestFile)
1729 }
1730
Colin Cross6b4a32d2017-12-05 13:42:45 -08001731 j.Library.GenerateAndroidBuildActions(ctx)
Nan Zhang3c807db2017-11-03 14:53:31 -07001732 } else {
Colin Cross6b4a32d2017-12-05 13:42:45 -08001733 // Handle the binary wrapper
1734 j.isWrapperVariant = true
1735
Colin Cross366938f2017-12-11 16:29:02 -08001736 if j.binaryProperties.Wrapper != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001737 j.wrapperFile = android.PathForModuleSrc(ctx, *j.binaryProperties.Wrapper)
Colin Cross6b4a32d2017-12-05 13:42:45 -08001738 } else {
1739 j.wrapperFile = android.PathForSource(ctx, "build/soong/scripts/jar-wrapper.sh")
1740 }
1741
1742 // Depend on the installed jar so that the wrapper doesn't get executed by
1743 // another build rule before the jar has been installed.
1744 jarFile := ctx.PrimaryModule().(*Binary).installFile
1745
1746 j.binaryFile = ctx.InstallExecutable(android.PathForModuleInstall(ctx, "bin"),
1747 ctx.ModuleName(), j.wrapperFile, jarFile)
Nan Zhang3c807db2017-11-03 14:53:31 -07001748 }
Colin Cross2fe66872015-03-30 17:20:39 -07001749}
1750
Colin Crossf506d872017-07-19 15:53:04 -07001751func (j *Binary) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08001752 if ctx.Arch().ArchType == android.Common {
1753 j.deps(ctx)
1754 }
Colin Cross46c9b8b2017-06-22 16:51:17 -07001755}
1756
Colin Cross1b16b0e2019-02-12 14:41:32 -08001757// java_binary builds a `.jar` file and a shell script that executes it for the device, and possibly for the host
1758// as well.
1759//
1760// By default, a java_binary has a single variant that produces a `.jar` file containing `classes.dex` files that were
1761// compiled against the device bootclasspath.
1762//
1763// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
1764// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07001765func BinaryFactory() android.Module {
1766 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07001767
Colin Cross36242852017-06-23 15:06:31 -07001768 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -07001769 &module.Module.properties,
1770 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08001771 &module.Module.dexpreoptProperties,
Colin Cross6af17aa2017-09-20 12:59:05 -07001772 &module.Module.protoProperties,
Colin Cross540eff82017-06-22 17:01:52 -07001773 &module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07001774
Colin Cross9ae1b922018-06-26 17:59:05 -07001775 module.Module.properties.Installable = proptools.BoolPtr(true)
1776
Colin Cross6b4a32d2017-12-05 13:42:45 -08001777 android.InitAndroidArchModule(module, android.HostAndDeviceSupported, android.MultilibCommonFirst)
1778 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07001779 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001780}
1781
Colin Cross1b16b0e2019-02-12 14:41:32 -08001782// java_binary_host builds a `.jar` file and a shell script that executes it for the host.
1783//
1784// A java_binary_host has a single variant that produces a `.jar` file containing `.class` files that were
1785// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07001786func BinaryHostFactory() android.Module {
1787 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07001788
Colin Cross36242852017-06-23 15:06:31 -07001789 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -07001790 &module.Module.properties,
Colin Cross6af17aa2017-09-20 12:59:05 -07001791 &module.Module.protoProperties,
Colin Cross540eff82017-06-22 17:01:52 -07001792 &module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07001793
Colin Cross9ae1b922018-06-26 17:59:05 -07001794 module.Module.properties.Installable = proptools.BoolPtr(true)
1795
Colin Cross6b4a32d2017-12-05 13:42:45 -08001796 android.InitAndroidArchModule(module, android.HostSupported, android.MultilibCommonFirst)
1797 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07001798 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001799}
1800
1801//
1802// Java prebuilts
1803//
1804
Colin Cross74d73e22017-08-02 11:05:49 -07001805type ImportProperties struct {
Colin Cross27b922f2019-03-04 22:35:41 -08001806 Jars []string `android:"path"`
Colin Cross461bd1a2017-10-20 13:59:18 -07001807
Nan Zhangea568a42017-11-08 21:20:04 -08001808 Sdk_version *string
Colin Cross535e2cf2017-10-20 17:57:49 -07001809
1810 Installable *bool
Jiyong Park1be96912018-05-28 18:02:19 +09001811
1812 // List of shared java libs that this module has dependencies to
1813 Libs []string
Colin Cross37f6d792018-07-12 12:28:41 -07001814
1815 // List of files to remove from the jar file(s)
1816 Exclude_files []string
1817
1818 // List of directories to remove from the jar file(s)
1819 Exclude_dirs []string
Nan Zhang4c819fb2018-08-27 18:31:46 -07001820
1821 // if set to true, run Jetifier against .jar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -07001822 Jetifier *bool
Colin Cross74d73e22017-08-02 11:05:49 -07001823}
1824
1825type Import struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001826 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -07001827 android.DefaultableModuleBase
Colin Crossec7a0422017-07-07 14:47:12 -07001828 prebuilt android.Prebuilt
Colin Cross2fe66872015-03-30 17:20:39 -07001829
Colin Cross74d73e22017-08-02 11:05:49 -07001830 properties ImportProperties
1831
Colin Cross0a6e0072017-08-30 14:24:55 -07001832 combinedClasspathFile android.Path
Jiyong Park1be96912018-05-28 18:02:19 +09001833 exportedSdkLibs []string
Colin Cross2fe66872015-03-30 17:20:39 -07001834}
1835
Colin Cross83bb3162018-06-25 15:48:06 -07001836func (j *Import) sdkVersion() string {
1837 return String(j.properties.Sdk_version)
1838}
1839
1840func (j *Import) minSdkVersion() string {
1841 return j.sdkVersion()
1842}
1843
Colin Cross74d73e22017-08-02 11:05:49 -07001844func (j *Import) Prebuilt() *android.Prebuilt {
Colin Crossec7a0422017-07-07 14:47:12 -07001845 return &j.prebuilt
1846}
1847
Colin Cross74d73e22017-08-02 11:05:49 -07001848func (j *Import) PrebuiltSrcs() []string {
1849 return j.properties.Jars
1850}
1851
1852func (j *Import) Name() string {
Colin Cross5ea9bcc2017-07-27 15:41:32 -07001853 return j.prebuilt.Name(j.ModuleBase.Name())
1854}
1855
Colin Cross74d73e22017-08-02 11:05:49 -07001856func (j *Import) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross42d48b72018-08-29 14:10:52 -07001857 ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Colin Cross1e676be2016-10-12 14:38:15 -07001858}
1859
Colin Cross74d73e22017-08-02 11:05:49 -07001860func (j *Import) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross8a497952019-03-05 22:25:09 -08001861 jars := android.PathsForModuleSrc(ctx, j.properties.Jars)
Colin Crosse1d62a82015-04-03 16:53:05 -07001862
Nan Zhang4c819fb2018-08-27 18:31:46 -07001863 jarName := ctx.ModuleName() + ".jar"
1864 outputFile := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001865 TransformJarsToJar(ctx, outputFile, "for prebuilts", jars, android.OptionalPath{},
1866 false, j.properties.Exclude_files, j.properties.Exclude_dirs)
Colin Cross1001a792019-03-21 22:21:39 -07001867 if Bool(j.properties.Jetifier) {
Nan Zhang4c819fb2018-08-27 18:31:46 -07001868 inputFile := outputFile
1869 outputFile = android.PathForModuleOut(ctx, "jetifier", jarName)
1870 TransformJetifier(ctx, outputFile, inputFile)
1871 }
Colin Crosse9a275b2017-10-16 17:09:48 -07001872 j.combinedClasspathFile = outputFile
Jiyong Park1be96912018-05-28 18:02:19 +09001873
1874 ctx.VisitDirectDeps(func(module android.Module) {
1875 otherName := ctx.OtherModuleName(module)
1876 tag := ctx.OtherModuleDependencyTag(module)
1877
1878 switch dep := module.(type) {
1879 case Dependency:
1880 switch tag {
1881 case libTag, staticLibTag:
1882 // sdk lib names from dependencies are re-exported
1883 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
1884 }
1885 case SdkLibraryDependency:
1886 switch tag {
1887 case libTag:
1888 // names of sdk libs that are directly depended are exported
1889 j.exportedSdkLibs = append(j.exportedSdkLibs, otherName)
1890 }
1891 }
1892 })
1893
1894 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
Nan Zhang4973ecf2018-08-10 13:42:12 -07001895 if Bool(j.properties.Installable) {
1896 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
1897 ctx.ModuleName()+".jar", outputFile)
1898 }
Colin Cross2fe66872015-03-30 17:20:39 -07001899}
1900
Colin Cross74d73e22017-08-02 11:05:49 -07001901var _ Dependency = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07001902
Nan Zhanged19fc32017-10-19 13:06:22 -07001903func (j *Import) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001904 if j.combinedClasspathFile == nil {
1905 return nil
1906 }
Colin Cross37f6d792018-07-12 12:28:41 -07001907 return android.Paths{j.combinedClasspathFile}
Nan Zhanged19fc32017-10-19 13:06:22 -07001908}
1909
1910func (j *Import) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08001911 if j.combinedClasspathFile == nil {
1912 return nil
1913 }
Colin Cross37f6d792018-07-12 12:28:41 -07001914 return android.Paths{j.combinedClasspathFile}
Colin Cross2fe66872015-03-30 17:20:39 -07001915}
1916
Colin Cross331a1212018-08-15 20:40:52 -07001917func (j *Import) ResourceJars() android.Paths {
1918 return nil
1919}
1920
1921func (j *Import) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001922 if j.combinedClasspathFile == nil {
1923 return nil
1924 }
Colin Cross331a1212018-08-15 20:40:52 -07001925 return android.Paths{j.combinedClasspathFile}
1926}
1927
Colin Crossf24a22a2019-01-31 14:12:44 -08001928func (j *Import) DexJar() android.Path {
1929 return nil
1930}
1931
Colin Cross74d73e22017-08-02 11:05:49 -07001932func (j *Import) AidlIncludeDirs() android.Paths {
Colin Crossc0b06f12015-04-08 13:03:43 -07001933 return nil
1934}
1935
Jiyong Park1be96912018-05-28 18:02:19 +09001936func (j *Import) ExportedSdkLibs() []string {
1937 return j.exportedSdkLibs
1938}
1939
Colin Cross0c4ce212019-05-03 15:28:19 -07001940func (j *Import) SrcJarArgs() ([]string, android.Paths) {
1941 return nil, nil
1942}
1943
albaltai36ff7dc2018-12-25 14:35:23 +08001944// Add compile time check for interface implementation
1945var _ android.IDEInfo = (*Import)(nil)
1946var _ android.IDECustomizedModuleName = (*Import)(nil)
1947
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001948// Collect information for opening IDE project files in java/jdeps.go.
1949const (
1950 removedPrefix = "prebuilt_"
1951)
1952
1953func (j *Import) IDEInfo(dpInfo *android.IdeInfo) {
1954 dpInfo.Jars = append(dpInfo.Jars, j.PrebuiltSrcs()...)
1955}
1956
1957func (j *Import) IDECustomizedModuleName() string {
1958 // TODO(b/113562217): Extract the base module name from the Import name, often the Import name
1959 // has a prefix "prebuilt_". Remove the prefix explicitly if needed until we find a better
1960 // solution to get the Import name.
1961 name := j.Name()
1962 if strings.HasPrefix(name, removedPrefix) {
patricktubb640e02018-10-11 18:33:16 +08001963 name = strings.TrimPrefix(name, removedPrefix)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001964 }
1965 return name
1966}
1967
Colin Cross74d73e22017-08-02 11:05:49 -07001968var _ android.PrebuiltInterface = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07001969
Colin Cross1b16b0e2019-02-12 14:41:32 -08001970// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library module.
1971//
1972// By default, a java_import has a single variant that expects a `.jar` file containing `.class` files that were
1973// compiled against an Android classpath.
1974//
1975// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
1976// for host modules.
Colin Cross74d73e22017-08-02 11:05:49 -07001977func ImportFactory() android.Module {
1978 module := &Import{}
Colin Cross36242852017-06-23 15:06:31 -07001979
Colin Cross74d73e22017-08-02 11:05:49 -07001980 module.AddProperties(&module.properties)
1981
1982 android.InitPrebuiltModule(module, &module.properties.Jars)
Colin Cross48de9a42018-10-02 13:53:33 -07001983 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross36242852017-06-23 15:06:31 -07001984 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001985}
1986
Colin Cross1b16b0e2019-02-12 14:41:32 -08001987// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library_host
1988// module.
1989//
1990// A java_import_host has a single variant that expects a `.jar` file containing `.class` files that were
1991// compiled against a host bootclasspath.
Colin Cross74d73e22017-08-02 11:05:49 -07001992func ImportFactoryHost() android.Module {
1993 module := &Import{}
1994
1995 module.AddProperties(&module.properties)
1996
1997 android.InitPrebuiltModule(module, &module.properties.Jars)
Colin Cross48de9a42018-10-02 13:53:33 -07001998 InitJavaModule(module, android.HostSupported)
Colin Cross74d73e22017-08-02 11:05:49 -07001999 return module
2000}
2001
Colin Cross42be7612019-02-21 18:12:14 -08002002// dex_import module
2003
2004type DexImportProperties struct {
2005 Jars []string
2006}
2007
2008type DexImport struct {
2009 android.ModuleBase
2010 android.DefaultableModuleBase
2011 prebuilt android.Prebuilt
2012
2013 properties DexImportProperties
2014
2015 dexJarFile android.Path
2016 maybeStrippedDexJarFile android.Path
2017
2018 dexpreopter
2019}
2020
2021func (j *DexImport) Prebuilt() *android.Prebuilt {
2022 return &j.prebuilt
2023}
2024
2025func (j *DexImport) PrebuiltSrcs() []string {
2026 return j.properties.Jars
2027}
2028
2029func (j *DexImport) Name() string {
2030 return j.prebuilt.Name(j.ModuleBase.Name())
2031}
2032
2033func (j *DexImport) DepsMutator(ctx android.BottomUpMutatorContext) {
2034 android.ExtractSourcesDeps(ctx, j.properties.Jars)
2035}
2036
2037func (j *DexImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2038 if len(j.properties.Jars) != 1 {
2039 ctx.PropertyErrorf("jars", "exactly one jar must be provided")
2040 }
2041
2042 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", ctx.ModuleName()+".jar")
2043 j.dexpreopter.isInstallable = true
2044 j.dexpreopter.uncompressedDex = shouldUncompressDex(ctx, &j.dexpreopter)
2045
2046 inputJar := ctx.ExpandSource(j.properties.Jars[0], "jars")
2047 dexOutputFile := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar")
2048
2049 if j.dexpreopter.uncompressedDex {
2050 rule := android.NewRuleBuilder()
2051
2052 temporary := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar.unaligned")
2053 rule.Temporary(temporary)
2054
2055 // use zip2zip to uncompress classes*.dex files
2056 rule.Command().
2057 Tool(ctx.Config().HostToolPath(ctx, "zip2zip")).
2058 FlagWithInput("-i ", inputJar).
2059 FlagWithOutput("-o ", temporary).
2060 FlagWithArg("-0 ", "'classes*.dex'")
2061
2062 // use zipalign to align uncompressed classes*.dex files
2063 rule.Command().
2064 Tool(ctx.Config().HostToolPath(ctx, "zipalign")).
2065 Flag("-f").
2066 Text("4").
2067 Input(temporary).
2068 Output(dexOutputFile)
2069
2070 rule.DeleteTemporaryFiles()
2071
2072 rule.Build(pctx, ctx, "uncompress_dex", "uncompress dex")
2073 } else {
2074 ctx.Build(pctx, android.BuildParams{
2075 Rule: android.Cp,
2076 Input: inputJar,
2077 Output: dexOutputFile,
2078 })
2079 }
2080
2081 j.dexJarFile = dexOutputFile
2082
2083 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
2084
2085 j.maybeStrippedDexJarFile = dexOutputFile
2086
2087 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
2088 ctx.ModuleName()+".jar", dexOutputFile)
2089}
2090
2091func (j *DexImport) DexJar() android.Path {
2092 return j.dexJarFile
2093}
2094
2095// dex_import imports a `.jar` file containing classes.dex files.
2096//
2097// A dex_import module cannot be used as a dependency of a java_* or android_* module, it can only be installed
2098// to the device.
2099func DexImportFactory() android.Module {
2100 module := &DexImport{}
2101
2102 module.AddProperties(&module.properties)
2103
2104 android.InitPrebuiltModule(module, &module.properties.Jars)
2105 InitJavaModule(module, android.DeviceSupported)
2106 return module
2107}
2108
Colin Cross89536d42017-07-07 14:35:50 -07002109//
2110// Defaults
2111//
2112type Defaults struct {
2113 android.ModuleBase
2114 android.DefaultsModuleBase
2115}
2116
2117func (*Defaults) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2118}
2119
Colin Cross1b16b0e2019-02-12 14:41:32 -08002120// java_defaults provides a set of properties that can be inherited by other java or android modules.
2121//
2122// A module can use the properties from a java_defaults module using `defaults: ["defaults_module_name"]`. Each
2123// property in the defaults module that exists in the depending module will be prepended to the depending module's
2124// value for that property.
2125//
2126// Example:
2127//
2128// java_defaults {
2129// name: "example_defaults",
2130// srcs: ["common/**/*.java"],
2131// javacflags: ["-Xlint:all"],
2132// aaptflags: ["--auto-add-overlay"],
2133// }
2134//
2135// java_library {
2136// name: "example",
2137// defaults: ["example_defaults"],
2138// srcs: ["example/**/*.java"],
2139// }
2140//
2141// is functionally identical to:
2142//
2143// java_library {
2144// name: "example",
2145// srcs: [
2146// "common/**/*.java",
2147// "example/**/*.java",
2148// ],
2149// javacflags: ["-Xlint:all"],
2150// }
Colin Cross89536d42017-07-07 14:35:50 -07002151func defaultsFactory() android.Module {
2152 return DefaultsFactory()
2153}
2154
2155func DefaultsFactory(props ...interface{}) android.Module {
2156 module := &Defaults{}
2157
2158 module.AddProperties(props...)
2159 module.AddProperties(
2160 &CompilerProperties{},
2161 &CompilerDeviceProperties{},
Colin Cross43f08db2018-11-12 10:13:39 -08002162 &DexpreoptProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08002163 &android.ProtoProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002164 &aaptProperties{},
2165 &androidLibraryProperties{},
2166 &appProperties{},
2167 &appTestProperties{},
Jaewoong Jung525443a2019-02-28 15:35:54 -08002168 &overridableAppProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002169 &ImportProperties{},
2170 &AARImportProperties{},
2171 &sdkLibraryProperties{},
Colin Cross42be7612019-02-21 18:12:14 -08002172 &DexImportProperties{},
Colin Cross89536d42017-07-07 14:35:50 -07002173 )
2174
2175 android.InitDefaultsModule(module)
2176
2177 return module
2178}
Nan Zhangea568a42017-11-08 21:20:04 -08002179
2180var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07002181var BoolDefault = proptools.BoolDefault
Nan Zhangea568a42017-11-08 21:20:04 -08002182var String = proptools.String
Colin Cross0d0ba592018-02-20 13:33:42 -08002183var inList = android.InList