blob: db104111677c6b1cd174850bd2f2acc6aa743b1a [file] [log] [blame]
Jaewoong Jung26342642021-03-17 15:56:23 -07001// Copyright 2021 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
17import (
18 "fmt"
19 "path/filepath"
20 "strconv"
21 "strings"
22
23 "github.com/google/blueprint/pathtools"
24 "github.com/google/blueprint/proptools"
25
26 "android/soong/android"
27 "android/soong/dexpreopt"
28 "android/soong/java/config"
29)
30
31// This file contains the definition and the implementation of the base module that most
32// source-based Java module structs embed.
33
34// TODO:
35// Autogenerated files:
36// Renderscript
37// Post-jar passes:
38// Proguard
39// Rmtypedefs
40// DroidDoc
41// Findbugs
42
43// Properties that are common to most Java modules, i.e. whether it's a host or device module.
44type CommonProperties struct {
45 // list of source files used to compile the Java module. May be .java, .kt, .logtags, .proto,
46 // or .aidl files.
47 Srcs []string `android:"path,arch_variant"`
48
49 // list Kotlin of source files containing Kotlin code that should be treated as common code in
50 // a codebase that supports Kotlin multiplatform. See
51 // https://kotlinlang.org/docs/reference/multiplatform.html. May be only be .kt files.
52 Common_srcs []string `android:"path,arch_variant"`
53
54 // list of source files that should not be used to build the Java module.
55 // This is most useful in the arch/multilib variants to remove non-common files
56 Exclude_srcs []string `android:"path,arch_variant"`
57
58 // list of directories containing Java resources
59 Java_resource_dirs []string `android:"arch_variant"`
60
61 // list of directories that should be excluded from java_resource_dirs
62 Exclude_java_resource_dirs []string `android:"arch_variant"`
63
64 // list of files to use as Java resources
65 Java_resources []string `android:"path,arch_variant"`
66
67 // list of files that should be excluded from java_resources and java_resource_dirs
68 Exclude_java_resources []string `android:"path,arch_variant"`
69
70 // list of module-specific flags that will be used for javac compiles
71 Javacflags []string `android:"arch_variant"`
72
73 // list of module-specific flags that will be used for kotlinc compiles
74 Kotlincflags []string `android:"arch_variant"`
75
76 // list of java libraries that will be in the classpath
77 Libs []string `android:"arch_variant"`
78
79 // list of java libraries that will be compiled into the resulting jar
80 Static_libs []string `android:"arch_variant"`
81
82 // manifest file to be included in resulting jar
83 Manifest *string `android:"path"`
84
85 // if not blank, run jarjar using the specified rules file
86 Jarjar_rules *string `android:"path,arch_variant"`
87
88 // If not blank, set the java version passed to javac as -source and -target
89 Java_version *string
90
91 // If set to true, allow this module to be dexed and installed on devices. Has no
92 // effect on host modules, which are always considered installable.
93 Installable *bool
94
95 // If set to true, include sources used to compile the module in to the final jar
96 Include_srcs *bool
97
98 // If not empty, classes are restricted to the specified packages and their sub-packages.
99 // This restriction is checked after applying jarjar rules and including static libs.
100 Permitted_packages []string
101
102 // List of modules to use as annotation processors
103 Plugins []string
104
105 // List of modules to export to libraries that directly depend on this library as annotation
106 // processors. Note that if the plugins set generates_api: true this will disable the turbine
107 // optimization on modules that depend on this module, which will reduce parallelism and cause
108 // more recompilation.
109 Exported_plugins []string
110
111 // The number of Java source entries each Javac instance can process
112 Javac_shard_size *int64
113
114 // Add host jdk tools.jar to bootclasspath
115 Use_tools_jar *bool
116
117 Openjdk9 struct {
118 // List of source files that should only be used when passing -source 1.9 or higher
119 Srcs []string `android:"path"`
120
121 // List of javac flags that should only be used when passing -source 1.9 or higher
122 Javacflags []string
123 }
124
125 // When compiling language level 9+ .java code in packages that are part of
126 // a system module, patch_module names the module that your sources and
127 // dependencies should be patched into. The Android runtime currently
128 // doesn't implement the JEP 261 module system so this option is only
129 // supported at compile time. It should only be needed to compile tests in
130 // packages that exist in libcore and which are inconvenient to move
131 // elsewhere.
132 Patch_module *string `android:"arch_variant"`
133
134 Jacoco struct {
135 // List of classes to include for instrumentation with jacoco to collect coverage
136 // information at runtime when building with coverage enabled. If unset defaults to all
137 // classes.
138 // Supports '*' as the last character of an entry in the list as a wildcard match.
139 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
140 // it matches classes in the package that have the class name as a prefix.
141 Include_filter []string
142
143 // List of classes to exclude from instrumentation with jacoco to collect coverage
144 // information at runtime when building with coverage enabled. Overrides classes selected
145 // by the include_filter property.
146 // Supports '*' as the last character of an entry in the list as a wildcard match.
147 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
148 // it matches classes in the package that have the class name as a prefix.
149 Exclude_filter []string
150 }
151
152 Errorprone struct {
153 // List of javac flags that should only be used when running errorprone.
154 Javacflags []string
155
156 // List of java_plugin modules that provide extra errorprone checks.
157 Extra_check_modules []string
Cole Faust75fffb12021-06-13 15:23:16 -0700158
Cole Faust2b1536e2021-06-18 12:25:54 -0700159 // This property can be in 3 states. When set to true, errorprone will
160 // be run during the regular build. When set to false, errorprone will
161 // never be run. When unset, errorprone will be run when the RUN_ERROR_PRONE
162 // environment variable is true. Setting this to false will improve build
163 // performance more than adding -XepDisableAllChecks in javacflags.
Cole Faust75fffb12021-06-13 15:23:16 -0700164 Enabled *bool
Jaewoong Jung26342642021-03-17 15:56:23 -0700165 }
166
167 Proto struct {
168 // List of extra options that will be passed to the proto generator.
169 Output_params []string
170 }
171
172 Instrument bool `blueprint:"mutated"`
Paul Duffin0038a8d2022-05-03 00:28:40 +0000173 // If true, then the module supports statically including the jacocoagent
174 // into the library.
175 Supports_static_instrumentation bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700176
177 // List of files to include in the META-INF/services folder of the resulting jar.
178 Services []string `android:"path,arch_variant"`
179
180 // If true, package the kotlin stdlib into the jar. Defaults to true.
181 Static_kotlin_stdlib *bool `android:"arch_variant"`
182
183 // A list of java_library instances that provide additional hiddenapi annotations for the library.
184 Hiddenapi_additional_annotations []string
185}
186
187// Properties that are specific to device modules. Host module factories should not add these when
188// constructing a new module.
189type DeviceProperties struct {
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000190 // If not blank, set to the version of the sdk to compile against.
Vinh Trana9c8f7d2022-04-14 20:18:47 +0000191 // Defaults to private.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000192 // Values are of one of the following forms:
Vinh Trana9c8f7d2022-04-14 20:18:47 +0000193 // 1) numerical API level, "current", "none", or "core_platform"
194 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
195 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
196 // If the SDK kind is empty, it will be set to public.
Jaewoong Jung26342642021-03-17 15:56:23 -0700197 Sdk_version *string
198
199 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000200 // Defaults to sdk_version if not set. See sdk_version for possible values.
Jaewoong Jung26342642021-03-17 15:56:23 -0700201 Min_sdk_version *string
202
satayev0a420e72021-11-29 17:25:52 +0000203 // if not blank, set the maximum version of the sdk that the compiled artifacts will run against.
204 // Defaults to empty string "". See sdk_version for possible values.
205 Max_sdk_version *string
206
Jaewoong Jung26342642021-03-17 15:56:23 -0700207 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000208 // Defaults to sdk_version if not set. See sdk_version for possible values.
Jaewoong Jung26342642021-03-17 15:56:23 -0700209 Target_sdk_version *string
210
211 // Whether to compile against the platform APIs instead of an SDK.
212 // If true, then sdk_version must be empty. The value of this field
Vinh Trand91939e2022-04-18 19:27:17 +0000213 // is ignored when module's type isn't android_app, android_test, or android_test_helper_app.
Jaewoong Jung26342642021-03-17 15:56:23 -0700214 Platform_apis *bool
215
216 Aidl struct {
217 // Top level directories to pass to aidl tool
218 Include_dirs []string
219
220 // Directories rooted at the Android.bp file to pass to aidl tool
221 Local_include_dirs []string
222
223 // directories that should be added as include directories for any aidl sources of modules
224 // that depend on this module, as well as to aidl for this module.
225 Export_include_dirs []string
226
227 // whether to generate traces (for systrace) for this interface
228 Generate_traces *bool
229
230 // whether to generate Binder#GetTransaction name method.
231 Generate_get_transaction_name *bool
232
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100233 // whether all interfaces should be annotated with required permissions.
234 Enforce_permissions *bool
235
236 // allowlist for interfaces that (temporarily) do not require annotation for permissions.
237 Enforce_permissions_exceptions []string `android:"path"`
238
Jaewoong Jung26342642021-03-17 15:56:23 -0700239 // list of flags that will be passed to the AIDL compiler
240 Flags []string
241 }
242
243 // If true, export a copy of the module as a -hostdex module for host testing.
244 Hostdex *bool
245
246 Target struct {
247 Hostdex struct {
248 // Additional required dependencies to add to -hostdex modules.
249 Required []string
250 }
251 }
252
253 // When targeting 1.9 and above, override the modules to use with --system,
254 // otherwise provides defaults libraries to add to the bootclasspath.
255 System_modules *string
256
Jaewoong Jung26342642021-03-17 15:56:23 -0700257 IsSDKLibrary bool `blueprint:"mutated"`
258
259 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
260 // Defaults to false.
261 V4_signature *bool
262
263 // Only for libraries created by a sysprop_library module, SyspropPublicStub is the name of the
264 // public stubs library.
265 SyspropPublicStub string `blueprint:"mutated"`
266}
267
Jooyung Han01d80d82022-01-08 12:16:32 +0900268// Device properties that can be overridden by overriding module (e.g. override_android_app)
269type OverridableDeviceProperties struct {
270 // set the name of the output. If not set, `name` is used.
271 // To override a module with this property set, overriding module might need to set this as well.
272 // Otherwise, both the overridden and the overriding modules will have the same output name, which
273 // can cause the duplicate output error.
274 Stem *string
275}
276
Jaewoong Jung26342642021-03-17 15:56:23 -0700277// Functionality common to Module and Import
278//
279// It is embedded in Module so its functionality can be used by methods in Module
280// but it is currently only initialized by Import and Library.
281type embeddableInModuleAndImport struct {
282
283 // Functionality related to this being used as a component of a java_sdk_library.
284 EmbeddableSdkLibraryComponent
285}
286
Paul Duffin71b33cc2021-06-23 11:39:47 +0100287func (e *embeddableInModuleAndImport) initModuleAndImport(module android.Module) {
288 e.initSdkLibraryComponent(module)
Jaewoong Jung26342642021-03-17 15:56:23 -0700289}
290
291// Module/Import's DepIsInSameApex(...) delegates to this method.
292//
293// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
294// the one provided by ApexModuleBase.
295func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
296 // dependencies other than the static linkage are all considered crossing APEX boundary
297 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
298 return true
299 }
300 return false
301}
302
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100303// OptionalDexJarPath can be either unset, hold a valid path to a dex jar file,
304// or an invalid path describing the reason it is invalid.
305//
306// It is unset if a dex jar isn't applicable, i.e. no build rule has been
307// requested to create one.
308//
309// If a dex jar has been requested to be built then it is set, and it may be
310// either a valid android.Path, or invalid with a reason message. The latter
311// happens if the source that should produce the dex file isn't able to.
312//
313// E.g. it is invalid with a reason message if there is a prebuilt APEX that
314// could produce the dex jar through a deapexer module, but the APEX isn't
315// installable so doing so wouldn't be safe.
316type OptionalDexJarPath struct {
317 isSet bool
318 path android.OptionalPath
319}
320
321// IsSet returns true if a path has been set, either invalid or valid.
322func (o OptionalDexJarPath) IsSet() bool {
323 return o.isSet
324}
325
326// Valid returns true if there is a path that is valid.
327func (o OptionalDexJarPath) Valid() bool {
328 return o.isSet && o.path.Valid()
329}
330
331// Path returns the valid path, or panics if it's either not set or is invalid.
332func (o OptionalDexJarPath) Path() android.Path {
333 if !o.isSet {
334 panic("path isn't set")
335 }
336 return o.path.Path()
337}
338
339// PathOrNil returns the path if it's set and valid, or else nil.
340func (o OptionalDexJarPath) PathOrNil() android.Path {
341 if o.Valid() {
342 return o.Path()
343 }
344 return nil
345}
346
347// InvalidReason returns the reason for an invalid path, which is never "". It
348// returns "" for an unset or valid path.
349func (o OptionalDexJarPath) InvalidReason() string {
350 if !o.isSet {
351 return ""
352 }
353 return o.path.InvalidReason()
354}
355
356func (o OptionalDexJarPath) String() string {
357 if !o.isSet {
358 return "<unset>"
359 }
360 return o.path.String()
361}
362
363// makeUnsetDexJarPath returns an unset OptionalDexJarPath.
364func makeUnsetDexJarPath() OptionalDexJarPath {
365 return OptionalDexJarPath{isSet: false}
366}
367
368// makeDexJarPathFromOptionalPath returns an OptionalDexJarPath that is set with
369// the given OptionalPath, which may be valid or invalid.
370func makeDexJarPathFromOptionalPath(path android.OptionalPath) OptionalDexJarPath {
371 return OptionalDexJarPath{isSet: true, path: path}
372}
373
374// makeDexJarPathFromPath returns an OptionalDexJarPath that is set with the
375// valid given path. It returns an unset OptionalDexJarPath if the given path is
376// nil.
377func makeDexJarPathFromPath(path android.Path) OptionalDexJarPath {
378 if path == nil {
379 return makeUnsetDexJarPath()
380 }
381 return makeDexJarPathFromOptionalPath(android.OptionalPathForPath(path))
382}
383
Jaewoong Jung26342642021-03-17 15:56:23 -0700384// Module contains the properties and members used by all java module types
385type Module struct {
386 android.ModuleBase
387 android.DefaultableModuleBase
388 android.ApexModuleBase
389 android.SdkBase
Wei Libafb6d62021-12-10 03:14:59 -0800390 android.BazelModuleBase
Jaewoong Jung26342642021-03-17 15:56:23 -0700391
392 // Functionality common to Module and Import.
393 embeddableInModuleAndImport
394
395 properties CommonProperties
396 protoProperties android.ProtoProperties
397 deviceProperties DeviceProperties
398
Jooyung Han01d80d82022-01-08 12:16:32 +0900399 overridableDeviceProperties OverridableDeviceProperties
400
Jaewoong Jung26342642021-03-17 15:56:23 -0700401 // jar file containing header classes including static library dependencies, suitable for
402 // inserting into the bootclasspath/classpath of another compile
403 headerJarFile android.Path
404
405 // jar file containing implementation classes including static library dependencies but no
406 // resources
407 implementationJarFile android.Path
408
409 // jar file containing only resources including from static library dependencies
410 resourceJar android.Path
411
412 // args and dependencies to package source files into a srcjar
413 srcJarArgs []string
414 srcJarDeps android.Paths
415
416 // jar file containing implementation classes and resources including static library
417 // dependencies
418 implementationAndResourcesJar android.Path
419
420 // output file containing classes.dex and resources
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100421 dexJarFile OptionalDexJarPath
Jaewoong Jung26342642021-03-17 15:56:23 -0700422
423 // output file containing uninstrumented classes that will be instrumented by jacoco
424 jacocoReportClassesFile android.Path
425
426 // output file of the module, which may be a classes jar or a dex jar
427 outputFile android.Path
428 extraOutputFiles android.Paths
429
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100430 exportAidlIncludeDirs android.Paths
431 ignoredAidlPermissionList android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700432
433 logtagsSrcs android.Paths
434
435 // installed file for binary dependency
436 installFile android.Path
437
Colin Cross3108ce12021-11-10 14:38:50 -0800438 // installed file for hostdex copy
439 hostdexInstallFile android.InstallPath
440
Jaewoong Jung26342642021-03-17 15:56:23 -0700441 // list of .java files and srcjars that was passed to javac
442 compiledJavaSrcs android.Paths
443 compiledSrcJars android.Paths
444
445 // manifest file to use instead of properties.Manifest
446 overrideManifest android.OptionalPath
447
Jaewoong Jung26342642021-03-17 15:56:23 -0700448 // list of plugins that this java module is exporting
449 exportedPluginJars android.Paths
450
451 // list of plugins that this java module is exporting
452 exportedPluginClasses []string
453
454 // if true, the exported plugins generate API and require disabling turbine.
455 exportedDisableTurbine bool
456
457 // list of source files, collected from srcFiles with unique java and all kt files,
458 // will be used by android.IDEInfo struct
459 expandIDEInfoCompiledSrcs []string
460
461 // expanded Jarjar_rules
462 expandJarjarRules android.Path
463
Jaewoong Jung26342642021-03-17 15:56:23 -0700464 // Extra files generated by the module type to be added as java resources.
465 extraResources android.Paths
466
467 hiddenAPI
468 dexer
469 dexpreopter
470 usesLibrary
471 linter
472
473 // list of the xref extraction files
474 kytheFiles android.Paths
475
476 // Collect the module directory for IDE info in java/jdeps.go.
477 modulePaths []string
478
479 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +0900480
481 sdkVersion android.SdkSpec
482 minSdkVersion android.SdkSpec
satayev0a420e72021-11-29 17:25:52 +0000483 maxSdkVersion android.SdkSpec
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -0400484
485 sourceExtensions []string
Jaewoong Jung26342642021-03-17 15:56:23 -0700486}
487
Jiyong Park92315372021-04-02 08:45:46 +0900488func (j *Module) CheckStableSdkVersion(ctx android.BaseModuleContext) error {
489 sdkVersion := j.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900490 if sdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700491 return nil
492 }
Jiyong Parkf1691d22021-03-29 20:11:58 +0900493 if sdkVersion.Kind == android.SdkCorePlatform {
Paul Duffin1ea7c9f2021-03-15 09:39:13 +0000494 if useLegacyCorePlatformApi(ctx, j.BaseModuleName()) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700495 return fmt.Errorf("non stable SDK %v - uses legacy core platform", sdkVersion)
496 } else {
497 // Treat stable core platform as stable.
498 return nil
499 }
500 } else {
501 return fmt.Errorf("non stable SDK %v", sdkVersion)
502 }
503}
504
505// checkSdkVersions enforces restrictions around SDK dependencies.
506func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
507 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900508 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900509 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700510 ctx.PropertyErrorf("sdk_version",
511 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
512 }
513 }
514 }
515
516 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
517 // See rank() for details.
518 ctx.VisitDirectDeps(func(module android.Module) {
519 tag := ctx.OtherModuleDependencyTag(module)
520 switch module.(type) {
521 // TODO(satayev): cover other types as well, e.g. imports
522 case *Library, *AndroidLibrary:
523 switch tag {
524 case bootClasspathTag, libTag, staticLibTag, java9LibTag:
525 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
526 }
527 }
528 })
529}
530
531func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900532 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700533 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900534 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700535 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000536 ctx.PropertyErrorf("platform_apis", "This module has conflicting settings. sdk_version is not empty, which means this module cannot use platform APIs. However platform_apis is set to true.")
Jaewoong Jung26342642021-03-17 15:56:23 -0700537 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000538 ctx.PropertyErrorf("platform_apis", "This module has conflicting settings. sdk_version is empty, which means that this module is build against platform APIs. However platform_apis is not set to true")
Jaewoong Jung26342642021-03-17 15:56:23 -0700539 }
540
541 }
542}
543
544func (j *Module) addHostProperties() {
545 j.AddProperties(
546 &j.properties,
547 &j.protoProperties,
548 &j.usesLibraryProperties,
549 )
550}
551
552func (j *Module) addHostAndDeviceProperties() {
553 j.addHostProperties()
554 j.AddProperties(
555 &j.deviceProperties,
Jooyung Han01d80d82022-01-08 12:16:32 +0900556 &j.overridableDeviceProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700557 &j.dexer.dexProperties,
558 &j.dexpreoptProperties,
559 &j.linter.properties,
560 )
561}
562
563func (j *Module) OutputFiles(tag string) (android.Paths, error) {
564 switch tag {
565 case "":
566 return append(android.Paths{j.outputFile}, j.extraOutputFiles...), nil
567 case android.DefaultDistTag:
568 return android.Paths{j.outputFile}, nil
569 case ".jar":
570 return android.Paths{j.implementationAndResourcesJar}, nil
571 case ".proguard_map":
572 if j.dexer.proguardDictionary.Valid() {
573 return android.Paths{j.dexer.proguardDictionary.Path()}, nil
574 }
575 return nil, fmt.Errorf("%q was requested, but no output file was found.", tag)
576 default:
577 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
578 }
579}
580
581var _ android.OutputFileProducer = (*Module)(nil)
582
583func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
584 initJavaModule(module, hod, false)
585}
586
587func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
588 initJavaModule(module, hod, true)
589}
590
591func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
592 multilib := android.MultilibCommon
593 if multiTargets {
594 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
595 } else {
596 android.InitAndroidArchModule(module, hod, multilib)
597 }
598 android.InitDefaultableModule(module)
599}
600
601func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
602 return j.properties.Instrument &&
603 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
604 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
605}
606
607func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000608 return j.properties.Supports_static_instrumentation &&
609 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700610 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
611 ctx.Config().UnbundledBuild())
612}
613
614func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
615 // Force enable the instrumentation for java code that is built for APEXes ...
616 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
617 // doesn't make sense) or framework libraries (e.g. libraries found in the InstrumentFrameworkModules list) unless EMMA_INSTRUMENT_FRAMEWORK is true.
618 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
619 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
620 if j.DirectlyInAnyApex() && !isJacocoAgent && !apexInfo.IsForPlatform() {
621 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
622 return true
623 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
624 return true
625 }
626 }
627 return false
628}
629
Jiyong Park92315372021-04-02 08:45:46 +0900630func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
631 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700632}
633
Jiyong Parkf1691d22021-03-29 20:11:58 +0900634func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700635 return proptools.String(j.deviceProperties.System_modules)
636}
637
Jiyong Park92315372021-04-02 08:45:46 +0900638func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
Jaewoong Jung26342642021-03-17 15:56:23 -0700639 if j.deviceProperties.Min_sdk_version != nil {
Jiyong Park92315372021-04-02 08:45:46 +0900640 return android.SdkSpecFrom(ctx, *j.deviceProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700641 }
Jiyong Park92315372021-04-02 08:45:46 +0900642 return j.SdkVersion(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -0700643}
644
satayev0a420e72021-11-29 17:25:52 +0000645func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
646 maxSdkVersion := proptools.StringDefault(j.deviceProperties.Max_sdk_version, "")
647 // SdkSpecFrom returns SdkSpecPrivate for this, which may be confusing.
648 // TODO(b/208456999): ideally MaxSdkVersion should be an ApiLevel and not SdkSpec.
649 return android.SdkSpecFrom(ctx, maxSdkVersion)
650}
651
Jiyong Parkf1691d22021-03-29 20:11:58 +0900652func (j *Module) MinSdkVersionString() string {
Jiyong Park92315372021-04-02 08:45:46 +0900653 return j.minSdkVersion.Raw
654}
655
656func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
657 if j.deviceProperties.Target_sdk_version != nil {
658 return android.SdkSpecFrom(ctx, *j.deviceProperties.Target_sdk_version)
659 }
660 return j.SdkVersion(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -0700661}
662
663func (j *Module) AvailableFor(what string) bool {
664 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
665 // Exception: for hostdex: true libraries, the platform variant is created
666 // even if it's not marked as available to platform. In that case, the platform
667 // variant is used only for the hostdex and not installed to the device.
668 return true
669 }
670 return j.ApexModuleBase.AvailableFor(what)
671}
672
673func (j *Module) deps(ctx android.BottomUpMutatorContext) {
674 if ctx.Device() {
675 j.linter.deps(ctx)
676
Jiyong Parkf1691d22021-03-29 20:11:58 +0900677 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700678
679 if j.deviceProperties.SyspropPublicStub != "" {
680 // This is a sysprop implementation library that has a corresponding sysprop public
681 // stubs library, and a dependency on it so that dependencies on the implementation can
682 // be forwarded to the public stubs library when necessary.
683 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
684 }
685 }
686
687 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
688 ctx.AddVariationDependencies(nil, staticLibTag, j.properties.Static_libs...)
689
690 // Add dependency on libraries that provide additional hidden api annotations.
691 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
692
693 if ctx.DeviceConfig().VndkVersion() != "" && ctx.Config().EnforceInterPartitionJavaSdkLibrary() {
694 // Require java_sdk_library at inter-partition java dependency to ensure stable
695 // interface between partitions. If inter-partition java_library dependency is detected,
696 // raise build error because java_library doesn't have a stable interface.
697 //
698 // Inputs:
699 // PRODUCT_ENFORCE_INTER_PARTITION_JAVA_SDK_LIBRARY
700 // if true, enable enforcement
701 // PRODUCT_INTER_PARTITION_JAVA_LIBRARY_ALLOWLIST
702 // exception list of java_library names to allow inter-partition dependency
703 for idx := range j.properties.Libs {
704 if libDeps[idx] == nil {
705 continue
706 }
707
708 if javaDep, ok := libDeps[idx].(javaSdkLibraryEnforceContext); ok {
709 // java_sdk_library is always allowed at inter-partition dependency.
710 // So, skip check.
711 if _, ok := javaDep.(*SdkLibrary); ok {
712 continue
713 }
714
715 j.checkPartitionsForJavaDependency(ctx, "libs", javaDep)
716 }
717 }
718 }
719
720 // For library dependencies that are component libraries (like stubs), add the implementation
721 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
722 for _, dep := range libDeps {
723 if dep != nil {
724 if component, ok := dep.(SdkLibraryComponentDependency); ok {
725 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100726 // Add library as optional if it's one of the optional compatibility libs.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100727 tag := usesLibReqTag
728 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) {
729 tag = usesLibOptTag
730 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100731 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700732 }
733 }
734 }
735 }
736
737 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
738 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
739 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
740
741 android.ProtoDeps(ctx, &j.protoProperties)
742 if j.hasSrcExt(".proto") {
743 protoDeps(ctx, &j.protoProperties)
744 }
745
746 if j.hasSrcExt(".kt") {
747 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
748 // Kotlin files
749 ctx.AddVariationDependencies(nil, kotlinStdlibTag,
750 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8")
Colin Cross06354472022-05-03 14:20:24 -0700751 ctx.AddVariationDependencies(nil, kotlinAnnotationsTag, "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700752 }
753
754 // Framework libraries need special handling in static coverage builds: they should not have
755 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
756 // the same jacoco classes coming from different bootclasspath jars.
757 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
758 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
759 j.properties.Instrument = true
760 }
761 } else if j.shouldInstrumentStatic(ctx) {
762 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
763 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700764
765 if j.useCompose() {
766 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
767 "androidx.compose.compiler_compiler-hosted")
768 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700769}
770
771func hasSrcExt(srcs []string, ext string) bool {
772 for _, src := range srcs {
773 if filepath.Ext(src) == ext {
774 return true
775 }
776 }
777
778 return false
779}
780
781func (j *Module) hasSrcExt(ext string) bool {
782 return hasSrcExt(j.properties.Srcs, ext)
783}
784
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100785func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
786 var flags string
787
788 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
789 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
790 flags = "-Wmissing-permission-annotation -Werror"
791 }
792 }
793 return flags
794}
795
Jaewoong Jung26342642021-03-17 15:56:23 -0700796func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
797 aidlIncludeDirs android.Paths) (string, android.Paths) {
798
799 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
800 aidlIncludes = append(aidlIncludes,
801 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
802 aidlIncludes = append(aidlIncludes,
803 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
804
805 var flags []string
806 var deps android.Paths
807
808 flags = append(flags, j.deviceProperties.Aidl.Flags...)
809
810 if aidlPreprocess.Valid() {
811 flags = append(flags, "-p"+aidlPreprocess.String())
812 deps = append(deps, aidlPreprocess.Path())
813 } else if len(aidlIncludeDirs) > 0 {
814 flags = append(flags, android.JoinWithPrefix(aidlIncludeDirs.Strings(), "-I"))
815 }
816
817 if len(j.exportAidlIncludeDirs) > 0 {
818 flags = append(flags, android.JoinWithPrefix(j.exportAidlIncludeDirs.Strings(), "-I"))
819 }
820
821 if len(aidlIncludes) > 0 {
822 flags = append(flags, android.JoinWithPrefix(aidlIncludes.Strings(), "-I"))
823 }
824
825 flags = append(flags, "-I"+android.PathForModuleSrc(ctx).String())
826 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
827 flags = append(flags, "-I"+src.String())
828 }
829
830 if Bool(j.deviceProperties.Aidl.Generate_traces) {
831 flags = append(flags, "-t")
832 }
833
834 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
835 flags = append(flags, "--transaction_names")
836 }
837
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100838 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
839 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
840 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
841 }
842
Jooyung Han07f70c02021-11-06 07:08:45 +0900843 aidlMinSdkVersion := j.MinSdkVersion(ctx).ApiLevel.String()
844 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
845
Jaewoong Jung26342642021-03-17 15:56:23 -0700846 return strings.Join(flags, " "), deps
847}
848
849func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
850
851 var flags javaBuilderFlags
852
853 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +0900854 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -0700855
Cole Faust2b1536e2021-06-18 12:25:54 -0700856 epEnabled := j.properties.Errorprone.Enabled
857 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700858 if config.ErrorProneClasspath == nil && ctx.Config().TestProductVariables == nil {
859 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
860 }
861
862 errorProneFlags := []string{
863 "-Xplugin:ErrorProne",
864 "${config.ErrorProneChecks}",
865 }
866 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
867
Colin Cross8bf6cad2022-02-28 13:07:03 -0800868 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -0700869 "'" + strings.Join(errorProneFlags, " ") + "'"
870 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
871 }
872
873 // classpath
874 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
875 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -0700876 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700877 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
878 flags.processorPath = append(flags.processorPath, deps.processorPath...)
879 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
880
881 flags.processors = append(flags.processors, deps.processorClasses...)
882 flags.processors = android.FirstUniqueStrings(flags.processors)
883
884 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +0900885 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700886 // Give host-side tools a version of OpenJDK's standard libraries
887 // close to what they're targeting. As of Dec 2017, AOSP is only
888 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
889 //
890 // When building with OpenJDK 8, the following should have no
891 // effect since those jars would be available by default.
892 //
893 // When building with OpenJDK 9 but targeting a version < 1.8,
894 // putting them on the bootclasspath means that:
895 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
896 // b) references to existing APIs are not reinterpreted in an
897 // OpenJDK 9-specific way, eg. calls to subclasses of
898 // java.nio.Buffer as in http://b/70862583
899 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
900 flags.bootClasspath = append(flags.bootClasspath,
901 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
902 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
903 if Bool(j.properties.Use_tools_jar) {
904 flags.bootClasspath = append(flags.bootClasspath,
905 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
906 }
907 }
908
909 // systemModules
910 flags.systemModules = deps.systemModules
911
912 // aidl flags.
913 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs)
914
915 return flags
916}
917
918func (j *Module) collectJavacFlags(
919 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
920 // javac flags.
921 javacFlags := j.properties.Javacflags
922
923 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() {
924 // For non-host binaries, override the -g flag passed globally to remove
925 // local variable debug info to reduce disk and memory usage.
926 javacFlags = append(javacFlags, "-g:source,lines")
927 }
928 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
929
930 if flags.javaVersion.usesJavaModules() {
931 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
932
933 if j.properties.Patch_module != nil {
934 // Manually specify build directory in case it is not under the repo root.
935 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
936 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200937 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -0700938
939 // b/150878007
940 //
941 // Workaround to support *Bazel-executed* JDK9 javac in Bazel's
942 // execution root for --patch-module. If this javac command line is
943 // invoked within Bazel's execution root working directory, the top
944 // level directories (e.g. libcore/, tools/, frameworks/) are all
945 // symlinks. JDK9 javac does not traverse into symlinks, which causes
946 // --patch-module to fail source file lookups when invoked in the
947 // execution root.
948 //
949 // Short of patching javac or enumerating *all* directories as possible
950 // input dirs, manually add the top level dir of the source files to be
951 // compiled.
952 topLevelDirs := map[string]bool{}
953 for _, srcFilePath := range srcFiles {
954 srcFileParts := strings.Split(srcFilePath.String(), "/")
955 // Ignore source files that are already in the top level directory
956 // as well as generated files in the out directory. The out
957 // directory may be an absolute path, which means srcFileParts[0] is the
958 // empty string, so check that as well. Note that "out" in Bazel's execution
959 // root is *not* a symlink, which doesn't cause problems for --patch-modules
960 // anyway, so it's fine to not apply this workaround for generated
961 // source files.
962 if len(srcFileParts) > 1 &&
963 srcFileParts[0] != "" &&
964 srcFileParts[0] != "out" {
965 topLevelDirs[srcFileParts[0]] = true
966 }
967 }
968 patchPaths = append(patchPaths, android.SortedStringKeys(topLevelDirs)...)
969
970 classPath := flags.classpath.FormJavaClassPath("")
971 if classPath != "" {
972 patchPaths = append(patchPaths, classPath)
973 }
974 javacFlags = append(
975 javacFlags,
976 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
977 }
978 }
979
980 if len(javacFlags) > 0 {
981 // optimization.
982 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
983 flags.javacFlags = "$javacFlags"
984 }
985
986 return flags
987}
988
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -0400989func (j *Module) AddJSONData(d *map[string]interface{}) {
990 (&j.ModuleBase).AddJSONData(d)
991 (*d)["Java"] = map[string]interface{}{
992 "SourceExtensions": j.sourceExtensions,
993 }
994
995}
996
Jaewoong Jung26342642021-03-17 15:56:23 -0700997func (j *Module) compile(ctx android.ModuleContext, aaptSrcJar android.Path) {
998 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
999
1000 deps := j.collectDeps(ctx)
1001 flags := j.collectBuilderFlags(ctx, deps)
1002
1003 if flags.javaVersion.usesJavaModules() {
1004 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
1005 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001006
Jaewoong Jung26342642021-03-17 15:56:23 -07001007 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001008 j.sourceExtensions = []string{}
1009 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1010 if hasSrcExt(srcFiles.Strings(), ext) {
1011 j.sourceExtensions = append(j.sourceExtensions, ext)
1012 }
1013 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001014 if hasSrcExt(srcFiles.Strings(), ".proto") {
1015 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1016 }
1017
1018 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, nil)
1019 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1020 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1021 }
1022
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001023 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001024 srcFiles = j.genSources(ctx, srcFiles, flags)
1025
1026 // Collect javac flags only after computing the full set of srcFiles to
1027 // ensure that the --patch-module lookup paths are complete.
1028 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1029
1030 srcJars := srcFiles.FilterByExt(".srcjar")
1031 srcJars = append(srcJars, deps.srcJars...)
1032 if aaptSrcJar != nil {
1033 srcJars = append(srcJars, aaptSrcJar)
1034 }
Colin Crossb0ef30a2021-06-29 10:42:00 -07001035 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001036
1037 if j.properties.Jarjar_rules != nil {
1038 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1039 }
1040
1041 jarName := ctx.ModuleName() + ".jar"
1042
1043 javaSrcFiles := srcFiles.FilterByExt(".java")
1044 var uniqueSrcFiles android.Paths
1045 set := make(map[string]bool)
1046 for _, v := range javaSrcFiles {
1047 if _, found := set[v.String()]; !found {
1048 set[v.String()] = true
1049 uniqueSrcFiles = append(uniqueSrcFiles, v)
1050 }
1051 }
1052
Colin Crossb5db4012022-03-28 17:12:39 -07001053 // We don't currently run annotation processors in turbine, which means we can't use turbine
1054 // generated header jars when an annotation processor that generates API is enabled. One
1055 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1056 // is used to run all of the annotation processors.
1057 disableTurbine := deps.disableTurbine
1058
Jaewoong Jung26342642021-03-17 15:56:23 -07001059 // Collect .java files for AIDEGen
1060 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1061
1062 var kotlinJars android.Paths
Colin Cross220a9a12022-03-28 17:08:01 -07001063 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001064
1065 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001066 // When using kotlin sources turbine is used to generate annotation processor sources,
1067 // including for annotation processors that generate API, so we can use turbine for
1068 // java sources too.
1069 disableTurbine = false
1070
Jaewoong Jung26342642021-03-17 15:56:23 -07001071 // user defined kotlin flags.
1072 kotlincFlags := j.properties.Kotlincflags
1073 CheckKotlincFlags(ctx, kotlincFlags)
1074
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001075 // Workaround for KT-46512
1076 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001077
1078 // If there are kotlin files, compile them first but pass all the kotlin and java files
1079 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1080 // won't emit any classes for them.
1081 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1082 if ctx.Device() {
1083 kotlincFlags = append(kotlincFlags, "-no-jdk")
1084 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001085
1086 for _, plugin := range deps.kotlinPlugins {
1087 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1088 }
1089 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1090
Jaewoong Jung26342642021-03-17 15:56:23 -07001091 if len(kotlincFlags) > 0 {
1092 // optimization.
1093 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1094 flags.kotlincFlags += "$kotlincFlags"
1095 }
1096
1097 var kotlinSrcFiles android.Paths
1098 kotlinSrcFiles = append(kotlinSrcFiles, uniqueSrcFiles...)
1099 kotlinSrcFiles = append(kotlinSrcFiles, srcFiles.FilterByExt(".kt")...)
1100
1101 // Collect .kt files for AIDEGen
1102 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, srcFiles.FilterByExt(".kt").Strings()...)
1103 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1104
1105 flags.classpath = append(flags.classpath, deps.kotlinStdlib...)
1106 flags.classpath = append(flags.classpath, deps.kotlinAnnotations...)
1107
1108 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1109 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1110
Isaac Chioua23d9942022-04-06 06:14:38 +00001111 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001112 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001113 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1114 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
1115 kotlinKapt(ctx, kaptSrcJar, kaptResJar, kotlinSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
1116 srcJars = append(srcJars, kaptSrcJar)
1117 kotlinJars = append(kotlinJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001118 // Disable annotation processing in javac, it's already been handled by kapt
1119 flags.processorPath = nil
1120 flags.processors = nil
1121 }
1122
1123 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001124 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
1125 kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, kotlinSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001126 if ctx.Failed() {
1127 return
1128 }
1129
Isaac Chioua23d9942022-04-06 06:14:38 +00001130 // Make javac rule depend on the kotlinc rule
1131 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1132
Jaewoong Jung26342642021-03-17 15:56:23 -07001133 kotlinJars = append(kotlinJars, kotlinJar)
Colin Cross220a9a12022-03-28 17:08:01 -07001134 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
1135
Jaewoong Jung26342642021-03-17 15:56:23 -07001136 // Jar kotlin classes into the final jar after javac
1137 if BoolDefault(j.properties.Static_kotlin_stdlib, true) {
1138 kotlinJars = append(kotlinJars, deps.kotlinStdlib...)
Colin Cross06354472022-05-03 14:20:24 -07001139 kotlinJars = append(kotlinJars, deps.kotlinAnnotations...)
Colin Cross220a9a12022-03-28 17:08:01 -07001140 kotlinHeaderJars = append(kotlinHeaderJars, deps.kotlinStdlib...)
Colin Cross06354472022-05-03 14:20:24 -07001141 kotlinHeaderJars = append(kotlinHeaderJars, deps.kotlinAnnotations...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001142 } else {
1143 flags.dexClasspath = append(flags.dexClasspath, deps.kotlinStdlib...)
Colin Cross06354472022-05-03 14:20:24 -07001144 flags.dexClasspath = append(flags.dexClasspath, deps.kotlinAnnotations...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001145 }
1146 }
1147
1148 jars := append(android.Paths(nil), kotlinJars...)
1149
1150 // Store the list of .java files that was passed to javac
1151 j.compiledJavaSrcs = uniqueSrcFiles
1152 j.compiledSrcJars = srcJars
1153
1154 enableSharding := false
Colin Cross3d56ed52021-11-18 22:23:12 -08001155 var headerJarFileWithoutDepsOrJarjar android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001156 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001157 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1158 enableSharding = true
1159 // Formerly, there was a check here that prevented annotation processors
1160 // from being used when sharding was enabled, as some annotation processors
1161 // do not function correctly in sharded environments. It was removed to
1162 // allow for the use of annotation processors that do function correctly
1163 // with sharding enabled. See: b/77284273.
1164 }
Colin Cross3d56ed52021-11-18 22:23:12 -08001165 headerJarFileWithoutDepsOrJarjar, j.headerJarFile =
Colin Cross220a9a12022-03-28 17:08:01 -07001166 j.compileJavaHeader(ctx, uniqueSrcFiles, srcJars, deps, flags, jarName, kotlinHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001167 if ctx.Failed() {
1168 return
1169 }
1170 }
1171 if len(uniqueSrcFiles) > 0 || len(srcJars) > 0 {
1172 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001173 if Bool(j.properties.Errorprone.Enabled) {
1174 // If error-prone is enabled, enable errorprone flags on the regular
1175 // build.
1176 flags = enableErrorproneFlags(flags)
Cole Faust2b1536e2021-06-18 12:25:54 -07001177 } else if ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faust75fffb12021-06-13 15:23:16 -07001178 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1179 // a new jar file just for compiling with the errorprone compiler to.
1180 // This is because we don't want to cause the java files to get completely
1181 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1182 // We also don't want to run this if errorprone is enabled by default for
1183 // this module, or else we could have duplicated errorprone messages.
1184 errorproneFlags := enableErrorproneFlags(flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001185 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Cole Faust75fffb12021-06-13 15:23:16 -07001186
1187 transformJavaToClasses(ctx, errorprone, -1, uniqueSrcFiles, srcJars, errorproneFlags, nil,
1188 "errorprone", "errorprone")
1189
Jaewoong Jung26342642021-03-17 15:56:23 -07001190 extraJarDeps = append(extraJarDeps, errorprone)
1191 }
1192
1193 if enableSharding {
Colin Cross3d56ed52021-11-18 22:23:12 -08001194 if headerJarFileWithoutDepsOrJarjar != nil {
1195 flags.classpath = append(classpath{headerJarFileWithoutDepsOrJarjar}, flags.classpath...)
1196 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001197 shardSize := int(*(j.properties.Javac_shard_size))
1198 var shardSrcs []android.Paths
1199 if len(uniqueSrcFiles) > 0 {
1200 shardSrcs = android.ShardPaths(uniqueSrcFiles, shardSize)
1201 for idx, shardSrc := range shardSrcs {
1202 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1203 nil, flags, extraJarDeps)
1204 jars = append(jars, classes)
1205 }
1206 }
1207 if len(srcJars) > 0 {
1208 classes := j.compileJavaClasses(ctx, jarName, len(shardSrcs),
1209 nil, srcJars, flags, extraJarDeps)
1210 jars = append(jars, classes)
1211 }
1212 } else {
1213 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueSrcFiles, srcJars, flags, extraJarDeps)
1214 jars = append(jars, classes)
1215 }
1216 if ctx.Failed() {
1217 return
1218 }
1219 }
1220
1221 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1222
1223 var includeSrcJar android.WritablePath
1224 if Bool(j.properties.Include_srcs) {
1225 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1226 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1227 }
1228
1229 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1230 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
1231 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
1232 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1233
1234 var resArgs []string
1235 var resDeps android.Paths
1236
1237 resArgs = append(resArgs, dirArgs...)
1238 resDeps = append(resDeps, dirDeps...)
1239
1240 resArgs = append(resArgs, fileArgs...)
1241 resDeps = append(resDeps, fileDeps...)
1242
1243 resArgs = append(resArgs, extraArgs...)
1244 resDeps = append(resDeps, extraDeps...)
1245
1246 if len(resArgs) > 0 {
1247 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1248 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
1249 j.resourceJar = resourceJar
1250 if ctx.Failed() {
1251 return
1252 }
1253 }
1254
1255 var resourceJars android.Paths
1256 if j.resourceJar != nil {
1257 resourceJars = append(resourceJars, j.resourceJar)
1258 }
1259 if Bool(j.properties.Include_srcs) {
1260 resourceJars = append(resourceJars, includeSrcJar)
1261 }
1262 resourceJars = append(resourceJars, deps.staticResourceJars...)
1263
1264 if len(resourceJars) > 1 {
1265 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1266 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1267 false, nil, nil)
1268 j.resourceJar = combinedJar
1269 } else if len(resourceJars) == 1 {
1270 j.resourceJar = resourceJars[0]
1271 }
1272
1273 if len(deps.staticJars) > 0 {
1274 jars = append(jars, deps.staticJars...)
1275 }
1276
1277 manifest := j.overrideManifest
1278 if !manifest.Valid() && j.properties.Manifest != nil {
1279 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
1280 }
1281
1282 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1283 if len(services) > 0 {
1284 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1285 var zipargs []string
1286 for _, file := range services {
1287 serviceFile := file.String()
1288 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1289 }
1290 rule := zip
1291 args := map[string]string{
1292 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1293 }
1294 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1295 rule = zipRE
1296 args["implicits"] = strings.Join(services.Strings(), ",")
1297 }
1298 ctx.Build(pctx, android.BuildParams{
1299 Rule: rule,
1300 Output: servicesJar,
1301 Implicits: services,
1302 Args: args,
1303 })
1304 jars = append(jars, servicesJar)
1305 }
1306
1307 // Combine the classes built from sources, any manifests, and any static libraries into
1308 // classes.jar. If there is only one input jar this step will be skipped.
1309 var outputFile android.OutputPath
1310
1311 if len(jars) == 1 && !manifest.Valid() {
1312 // Optimization: skip the combine step as there is nothing to do
1313 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1314 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1315 // any if len(jars) == 1.
1316
1317 // Transform the single path to the jar into an OutputPath as that is required by the following
1318 // code.
1319 if moduleOutPath, ok := jars[0].(android.ModuleOutPath); ok {
1320 // The path contains an embedded OutputPath so reuse that.
1321 outputFile = moduleOutPath.OutputPath
1322 } else if outputPath, ok := jars[0].(android.OutputPath); ok {
1323 // The path is an OutputPath so reuse it directly.
1324 outputFile = outputPath
1325 } else {
1326 // The file is not in the out directory so create an OutputPath into which it can be copied
1327 // and which the following code can use to refer to it.
1328 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1329 ctx.Build(pctx, android.BuildParams{
1330 Rule: android.Cp,
1331 Input: jars[0],
1332 Output: combinedJar,
1333 })
1334 outputFile = combinedJar.OutputPath
1335 }
1336 } else {
1337 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1338 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1339 false, nil, nil)
1340 outputFile = combinedJar.OutputPath
1341 }
1342
1343 // jarjar implementation jar if necessary
1344 if j.expandJarjarRules != nil {
1345 // Transform classes.jar into classes-jarjar.jar
1346 jarjarFile := android.PathForModuleOut(ctx, "jarjar", jarName).OutputPath
1347 TransformJarJar(ctx, jarjarFile, outputFile, j.expandJarjarRules)
1348 outputFile = jarjarFile
1349
1350 // jarjar resource jar if necessary
1351 if j.resourceJar != nil {
1352 resourceJarJarFile := android.PathForModuleOut(ctx, "res-jarjar", jarName)
1353 TransformJarJar(ctx, resourceJarJarFile, j.resourceJar, j.expandJarjarRules)
1354 j.resourceJar = resourceJarJarFile
1355 }
1356
1357 if ctx.Failed() {
1358 return
1359 }
1360 }
1361
1362 // Check package restrictions if necessary.
1363 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001364 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001365 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001366
1367 // Create a rule to copy the output jar to another path and add a validate dependency that
1368 // will check that the jar only contains the permitted packages. The new location will become
1369 // the output file of this module.
1370 inputFile := outputFile
1371 outputFile = android.PathForModuleOut(ctx, "package-check", jarName).OutputPath
1372 ctx.Build(pctx, android.BuildParams{
1373 Rule: android.Cp,
1374 Input: inputFile,
1375 Output: outputFile,
1376 // Make sure that any dependency on the output file will cause ninja to run the package check
1377 // rule.
1378 Validation: pkgckFile,
1379 })
1380
1381 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001382 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001383
1384 if ctx.Failed() {
1385 return
1386 }
1387 }
1388
1389 j.implementationJarFile = outputFile
1390 if j.headerJarFile == nil {
1391 j.headerJarFile = j.implementationJarFile
1392 }
1393
1394 if j.shouldInstrumentInApex(ctx) {
1395 j.properties.Instrument = true
1396 }
1397
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001398 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1399 specs := j.jacocoModuleToZipCommand(ctx)
1400 if ctx.Failed() {
1401 return
1402 }
1403
Jaewoong Jung26342642021-03-17 15:56:23 -07001404 if j.shouldInstrument(ctx) {
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001405 outputFile = j.instrument(ctx, flags, outputFile, jarName, specs)
Jaewoong Jung26342642021-03-17 15:56:23 -07001406 }
1407
1408 // merge implementation jar with resources if necessary
1409 implementationAndResourcesJar := outputFile
1410 if j.resourceJar != nil {
1411 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
1412 combinedJar := android.PathForModuleOut(ctx, "withres", jarName).OutputPath
1413 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
1414 false, nil, nil)
1415 implementationAndResourcesJar = combinedJar
1416 }
1417
1418 j.implementationAndResourcesJar = implementationAndResourcesJar
1419
1420 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001421 compileDex := j.dexProperties.Compile_dex
Jaewoong Jung26342642021-03-17 15:56:23 -07001422 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1423 if j.DirectlyInAnyApex() && !apexInfo.IsForPlatform() {
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001424 if compileDex == nil {
1425 compileDex = proptools.BoolPtr(true)
Jaewoong Jung26342642021-03-17 15:56:23 -07001426 }
1427 if j.deviceProperties.Hostdex == nil {
1428 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1429 }
1430 }
1431
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001432 if ctx.Device() && (Bool(j.properties.Installable) || Bool(compileDex)) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001433 if j.hasCode(ctx) {
1434 if j.shouldInstrumentStatic(ctx) {
1435 j.dexer.extraProguardFlagFiles = append(j.dexer.extraProguardFlagFiles,
1436 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1437 }
1438 // Dex compilation
1439 var dexOutputFile android.OutputPath
Colin Crossa79a52c2021-08-04 10:52:44 -07001440 dexOutputFile = j.dexer.compileDex(ctx, flags, j.MinSdkVersion(ctx), implementationAndResourcesJar, jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001441 if ctx.Failed() {
1442 return
1443 }
1444
Jaewoong Jung26342642021-03-17 15:56:23 -07001445 // merge dex jar with resources if necessary
1446 if j.resourceJar != nil {
1447 jars := android.Paths{dexOutputFile, j.resourceJar}
1448 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName).OutputPath
1449 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1450 false, nil, nil)
1451 if *j.dexProperties.Uncompress_dex {
1452 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName).OutputPath
1453 TransformZipAlign(ctx, combinedAlignedJar, combinedJar)
1454 dexOutputFile = combinedAlignedJar
1455 } else {
1456 dexOutputFile = combinedJar
1457 }
1458 }
1459
Paul Duffin4de94502021-05-16 05:21:16 +01001460 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001461
1462 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001463
1464 // Encode hidden API flags in dex file, if needed.
1465 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1466
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001467 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001468
1469 // Dexpreopting
1470 j.dexpreopt(ctx, dexOutputFile)
1471
1472 outputFile = dexOutputFile
1473 } else {
1474 // There is no code to compile into a dex jar, make sure the resources are propagated
1475 // to the APK if this is an app.
1476 outputFile = implementationAndResourcesJar
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001477 j.dexJarFile = makeDexJarPathFromPath(j.resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001478 }
1479
1480 if ctx.Failed() {
1481 return
1482 }
1483 } else {
1484 outputFile = implementationAndResourcesJar
1485 }
1486
1487 if ctx.Device() {
Nataniel Borges5d80d892022-04-29 09:49:16 +00001488 lintSDKVersion := func(sdkSpec android.SdkSpec) android.ApiLevel {
Jiyong Park54105c42021-03-31 18:17:53 +09001489 if v := sdkSpec.ApiLevel; !v.IsPreview() {
Nataniel Borges5d80d892022-04-29 09:49:16 +00001490 return v
Jaewoong Jung26342642021-03-17 15:56:23 -07001491 } else {
Nataniel Borges5d80d892022-04-29 09:49:16 +00001492 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001493 }
1494 }
1495
1496 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001497 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1498 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001499 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1500 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001501 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
1502 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
1503 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx))
Pedro Loureiro18233a22021-06-08 18:11:21 +00001504 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001505 j.linter.javaLanguageLevel = flags.javaVersion.String()
1506 j.linter.kotlinLanguageLevel = "1.3"
1507 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1508 j.linter.buildModuleReportZip = true
1509 }
1510 j.linter.lint(ctx)
1511 }
1512
1513 ctx.CheckbuildFile(outputFile)
1514
1515 ctx.SetProvider(JavaInfoProvider, JavaInfo{
1516 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1517 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1518 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
1519 ResourceJars: android.PathsIfNonNil(j.resourceJar),
1520 AidlIncludeDirs: j.exportAidlIncludeDirs,
1521 SrcJarArgs: j.srcJarArgs,
1522 SrcJarDeps: j.srcJarDeps,
1523 ExportedPlugins: j.exportedPluginJars,
1524 ExportedPluginClasses: j.exportedPluginClasses,
1525 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1526 JacocoReportClassesFile: j.jacocoReportClassesFile,
1527 })
1528
1529 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1530 j.outputFile = outputFile.WithoutRel()
1531}
1532
Colin Crossa1ff7c62021-09-17 14:11:52 -07001533func (j *Module) useCompose() bool {
1534 return android.InList("androidx.compose.runtime_runtime", j.properties.Static_libs)
1535}
1536
Cole Faust75fffb12021-06-13 15:23:16 -07001537// Returns a copy of the supplied flags, but with all the errorprone-related
1538// fields copied to the regular build's fields.
1539func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
1540 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
1541
1542 if len(flags.errorProneExtraJavacFlags) > 0 {
1543 if len(flags.javacFlags) > 0 {
1544 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
1545 } else {
1546 flags.javacFlags = flags.errorProneExtraJavacFlags
1547 }
1548 }
1549 return flags
1550}
1551
Jaewoong Jung26342642021-03-17 15:56:23 -07001552func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
1553 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.WritablePath {
1554
1555 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
1556 if idx >= 0 {
1557 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
1558 jarName += strconv.Itoa(idx)
1559 }
1560
1561 classes := android.PathForModuleOut(ctx, "javac", jarName).OutputPath
1562 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, flags, extraJarDeps)
1563
1564 if ctx.Config().EmitXrefRules() {
1565 extractionFile := android.PathForModuleOut(ctx, kzipName)
1566 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
1567 j.kytheFiles = append(j.kytheFiles, extractionFile)
1568 }
1569
1570 return classes
1571}
1572
1573// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1574// since some of these flags may be used internally.
1575func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1576 for _, flag := range flags {
1577 flag = strings.TrimSpace(flag)
1578
1579 if !strings.HasPrefix(flag, "-") {
1580 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1581 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1582 ctx.PropertyErrorf("kotlincflags",
1583 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1584 } else if inList(flag, config.KotlincIllegalFlags) {
1585 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1586 } else if flag == "-include-runtime" {
1587 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1588 } else {
1589 args := strings.Split(flag, " ")
1590 if args[0] == "-kotlin-home" {
1591 ctx.PropertyErrorf("kotlincflags",
1592 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1593 }
1594 }
1595 }
1596}
1597
1598func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
1599 deps deps, flags javaBuilderFlags, jarName string,
Colin Cross3d56ed52021-11-18 22:23:12 -08001600 extraJars android.Paths) (headerJar, jarjarAndDepsHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001601
1602 var jars android.Paths
1603 if len(srcFiles) > 0 || len(srcJars) > 0 {
1604 // Compile java sources into turbine.jar.
1605 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1606 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
1607 if ctx.Failed() {
1608 return nil, nil
1609 }
1610 jars = append(jars, turbineJar)
Colin Cross3d56ed52021-11-18 22:23:12 -08001611 headerJar = turbineJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001612 }
1613
1614 jars = append(jars, extraJars...)
1615
1616 // Combine any static header libraries into classes-header.jar. If there is only
1617 // one input jar this step will be skipped.
1618 jars = append(jars, deps.staticHeaderJars...)
1619
1620 // we cannot skip the combine step for now if there is only one jar
1621 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
1622 combinedJar := android.PathForModuleOut(ctx, "turbine-combined", jarName)
1623 TransformJarsToJar(ctx, combinedJar, "for turbine", jars, android.OptionalPath{},
1624 false, nil, []string{"META-INF/TRANSITIVE"})
Colin Cross3d56ed52021-11-18 22:23:12 -08001625 jarjarAndDepsHeaderJar = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001626
1627 if j.expandJarjarRules != nil {
1628 // Transform classes.jar into classes-jarjar.jar
1629 jarjarFile := android.PathForModuleOut(ctx, "turbine-jarjar", jarName)
Colin Cross3d56ed52021-11-18 22:23:12 -08001630 TransformJarJar(ctx, jarjarFile, jarjarAndDepsHeaderJar, j.expandJarjarRules)
1631 jarjarAndDepsHeaderJar = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001632 if ctx.Failed() {
1633 return nil, nil
1634 }
1635 }
1636
Colin Cross3d56ed52021-11-18 22:23:12 -08001637 return headerJar, jarjarAndDepsHeaderJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001638}
1639
1640func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001641 classesJar android.Path, jarName string, specs string) android.OutputPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07001642
1643 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
1644 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName).OutputPath
1645
1646 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1647
1648 j.jacocoReportClassesFile = jacocoReportClassesFile
1649
1650 return instrumentedJar
1651}
1652
1653func (j *Module) HeaderJars() android.Paths {
1654 if j.headerJarFile == nil {
1655 return nil
1656 }
1657 return android.Paths{j.headerJarFile}
1658}
1659
1660func (j *Module) ImplementationJars() android.Paths {
1661 if j.implementationJarFile == nil {
1662 return nil
1663 }
1664 return android.Paths{j.implementationJarFile}
1665}
1666
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001667func (j *Module) DexJarBuildPath() OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07001668 return j.dexJarFile
1669}
1670
1671func (j *Module) DexJarInstallPath() android.Path {
1672 return j.installFile
1673}
1674
1675func (j *Module) ImplementationAndResourcesJars() android.Paths {
1676 if j.implementationAndResourcesJar == nil {
1677 return nil
1678 }
1679 return android.Paths{j.implementationAndResourcesJar}
1680}
1681
1682func (j *Module) AidlIncludeDirs() android.Paths {
1683 // exportAidlIncludeDirs is type android.Paths already
1684 return j.exportAidlIncludeDirs
1685}
1686
1687func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
1688 return j.classLoaderContexts
1689}
1690
1691// Collect information for opening IDE project files in java/jdeps.go.
1692func (j *Module) IDEInfo(dpInfo *android.IdeInfo) {
1693 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
1694 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
1695 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
1696 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
1697 if j.expandJarjarRules != nil {
1698 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
1699 }
1700 dpInfo.Paths = append(dpInfo.Paths, j.modulePaths...)
Yikef6282022022-04-13 20:41:01 +08001701 dpInfo.Static_libs = append(dpInfo.Static_libs, j.properties.Static_libs...)
1702 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001703}
1704
1705func (j *Module) CompilerDeps() []string {
1706 jdeps := []string{}
1707 jdeps = append(jdeps, j.properties.Libs...)
1708 jdeps = append(jdeps, j.properties.Static_libs...)
1709 return jdeps
1710}
1711
1712func (j *Module) hasCode(ctx android.ModuleContext) bool {
1713 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
1714 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
1715}
1716
1717// Implements android.ApexModule
1718func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1719 return j.depIsInSameApex(ctx, dep)
1720}
1721
1722// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00001723func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Jiyong Park92315372021-04-02 08:45:46 +09001724 sdkSpec := j.MinSdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09001725 if !sdkSpec.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001726 return fmt.Errorf("min_sdk_version is not specified")
1727 }
Jiyong Parkf1691d22021-03-29 20:11:58 +09001728 if sdkSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07001729 return nil
1730 }
Jooyung Han4c4da062021-06-23 10:23:16 +09001731 if sdkSpec.ApiLevel.GreaterThan(sdkVersion) {
1732 return fmt.Errorf("newer SDK(%v)", sdkSpec.ApiLevel)
Jaewoong Jung26342642021-03-17 15:56:23 -07001733 }
1734 return nil
1735}
1736
1737func (j *Module) Stem() string {
Jooyung Han01d80d82022-01-08 12:16:32 +09001738 return proptools.StringDefault(j.overridableDeviceProperties.Stem, j.Name())
Jaewoong Jung26342642021-03-17 15:56:23 -07001739}
1740
Jaewoong Jung26342642021-03-17 15:56:23 -07001741func (j *Module) JacocoReportClassesFile() android.Path {
1742 return j.jacocoReportClassesFile
1743}
1744
1745func (j *Module) IsInstallable() bool {
1746 return Bool(j.properties.Installable)
1747}
1748
1749type sdkLinkType int
1750
1751const (
1752 // TODO(jiyong) rename these for better readability. Make the allowed
1753 // and disallowed link types explicit
1754 // order is important here. See rank()
1755 javaCore sdkLinkType = iota
1756 javaSdk
1757 javaSystem
1758 javaModule
1759 javaSystemServer
1760 javaPlatform
1761)
1762
1763func (lt sdkLinkType) String() string {
1764 switch lt {
1765 case javaCore:
1766 return "core Java API"
1767 case javaSdk:
1768 return "Android API"
1769 case javaSystem:
1770 return "system API"
1771 case javaModule:
1772 return "module API"
1773 case javaSystemServer:
1774 return "system server API"
1775 case javaPlatform:
1776 return "private API"
1777 default:
1778 panic(fmt.Errorf("unrecognized linktype: %d", lt))
1779 }
1780}
1781
1782// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
1783// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
1784// can't statically depend on modules that use Platform API.
1785func (lt sdkLinkType) rank() int {
1786 return int(lt)
1787}
1788
1789type moduleWithSdkDep interface {
1790 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09001791 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07001792}
1793
Jiyong Park92315372021-04-02 08:45:46 +09001794func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001795 switch name {
1796 case "core.current.stubs", "legacy.core.platform.api.stubs", "stable.core.platform.api.stubs",
1797 "stub-annotations", "private-stub-annotations-jar",
1798 "core-lambda-stubs", "core-generated-annotation-stubs":
1799 return javaCore, true
1800 case "android_stubs_current":
1801 return javaSdk, true
1802 case "android_system_stubs_current":
1803 return javaSystem, true
1804 case "android_module_lib_stubs_current":
1805 return javaModule, true
1806 case "android_system_server_stubs_current":
1807 return javaSystemServer, true
1808 case "android_test_stubs_current":
1809 return javaSystem, true
1810 }
1811
1812 if stub, linkType := moduleStubLinkType(name); stub {
1813 return linkType, true
1814 }
1815
Jiyong Park92315372021-04-02 08:45:46 +09001816 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09001817 switch ver.Kind {
1818 case android.SdkCore:
Jaewoong Jung26342642021-03-17 15:56:23 -07001819 return javaCore, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09001820 case android.SdkSystem:
Jaewoong Jung26342642021-03-17 15:56:23 -07001821 return javaSystem, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09001822 case android.SdkPublic:
Jaewoong Jung26342642021-03-17 15:56:23 -07001823 return javaSdk, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09001824 case android.SdkModule:
Jaewoong Jung26342642021-03-17 15:56:23 -07001825 return javaModule, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09001826 case android.SdkSystemServer:
Jaewoong Jung26342642021-03-17 15:56:23 -07001827 return javaSystemServer, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09001828 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
Jaewoong Jung26342642021-03-17 15:56:23 -07001829 return javaPlatform, false
1830 }
1831
Jiyong Parkf1691d22021-03-29 20:11:58 +09001832 if !ver.Valid() {
1833 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07001834 }
1835 return javaSdk, false
1836}
1837
1838// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
1839// this module's. See the comment on rank() for details and an example.
1840func (j *Module) checkSdkLinkType(
1841 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
1842 if ctx.Host() {
1843 return
1844 }
1845
Jiyong Park92315372021-04-02 08:45:46 +09001846 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07001847 if stubs {
1848 return
1849 }
Jiyong Park92315372021-04-02 08:45:46 +09001850 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07001851
1852 if myLinkType.rank() < depLinkType.rank() {
1853 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
1854 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
1855 "property of the source or target module so that target module is built "+
1856 "with the same or smaller API set when compared to the source.",
1857 myLinkType, ctx.OtherModuleName(dep), depLinkType)
1858 }
1859}
1860
1861func (j *Module) collectDeps(ctx android.ModuleContext) deps {
1862 var deps deps
1863
1864 if ctx.Device() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09001865 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001866 if sdkDep.invalidVersion {
1867 ctx.AddMissingDependencies(sdkDep.bootclasspath)
1868 ctx.AddMissingDependencies(sdkDep.java9Classpath)
1869 } else if sdkDep.useFiles {
1870 // sdkDep.jar is actually equivalent to turbine header.jar.
1871 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001872 deps.dexClasspath = append(deps.dexClasspath, sdkDep.jars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001873 deps.aidlPreprocess = sdkDep.aidl
1874 } else {
1875 deps.aidlPreprocess = sdkDep.aidl
1876 }
1877 }
1878
Jiyong Park92315372021-04-02 08:45:46 +09001879 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07001880
1881 ctx.VisitDirectDeps(func(module android.Module) {
1882 otherName := ctx.OtherModuleName(module)
1883 tag := ctx.OtherModuleDependencyTag(module)
1884
1885 if IsJniDepTag(tag) {
1886 // Handled by AndroidApp.collectAppDeps
1887 return
1888 }
1889 if tag == certificateTag {
1890 // Handled by AndroidApp.collectAppDeps
1891 return
1892 }
1893
1894 if dep, ok := module.(SdkLibraryDependency); ok {
1895 switch tag {
1896 case libTag:
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001897 depHeaderJars := dep.SdkHeaderJars(ctx, j.SdkVersion(ctx))
1898 deps.classpath = append(deps.classpath, depHeaderJars...)
1899 deps.dexClasspath = append(deps.dexClasspath, depHeaderJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001900 case staticLibTag:
1901 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
1902 }
1903 } else if ctx.OtherModuleHasProvider(module, JavaInfoProvider) {
1904 dep := ctx.OtherModuleProvider(module, JavaInfoProvider).(JavaInfo)
1905 if sdkLinkType != javaPlatform &&
1906 ctx.OtherModuleHasProvider(module, SyspropPublicStubInfoProvider) {
1907 // dep is a sysprop implementation library, but this module is not linking against
1908 // the platform, so it gets the sysprop public stubs library instead. Replace
1909 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
1910 syspropDep := ctx.OtherModuleProvider(module, SyspropPublicStubInfoProvider).(SyspropPublicStubInfo)
1911 dep = syspropDep.JavaInfo
1912 }
1913 switch tag {
1914 case bootClasspathTag:
1915 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
1916 case libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00001917 if _, ok := module.(*Plugin); ok {
1918 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
1919 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001920 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001921 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001922 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
1923 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
1924 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
1925 case java9LibTag:
1926 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
1927 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00001928 if _, ok := module.(*Plugin); ok {
1929 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
1930 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001931 deps.classpath = append(deps.classpath, dep.HeaderJars...)
1932 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
1933 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
1934 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
1935 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
1936 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
1937 // Turbine doesn't run annotation processors, so any module that uses an
1938 // annotation processor that generates API is incompatible with the turbine
1939 // optimization.
1940 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
1941 case pluginTag:
1942 if plugin, ok := module.(*Plugin); ok {
1943 if plugin.pluginProperties.Processor_class != nil {
1944 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
1945 } else {
1946 addPlugins(&deps, dep.ImplementationAndResourcesJars)
1947 }
1948 // Turbine doesn't run annotation processors, so any module that uses an
1949 // annotation processor that generates API is incompatible with the turbine
1950 // optimization.
1951 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
1952 } else {
1953 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
1954 }
1955 case errorpronePluginTag:
1956 if _, ok := module.(*Plugin); ok {
1957 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
1958 } else {
1959 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
1960 }
1961 case exportedPluginTag:
1962 if plugin, ok := module.(*Plugin); ok {
1963 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
1964 if plugin.pluginProperties.Processor_class != nil {
1965 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
1966 }
1967 // Turbine doesn't run annotation processors, so any module that uses an
1968 // annotation processor that generates API is incompatible with the turbine
1969 // optimization.
1970 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
1971 } else {
1972 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
1973 }
1974 case kotlinStdlibTag:
1975 deps.kotlinStdlib = append(deps.kotlinStdlib, dep.HeaderJars...)
1976 case kotlinAnnotationsTag:
1977 deps.kotlinAnnotations = dep.HeaderJars
Colin Crossa1ff7c62021-09-17 14:11:52 -07001978 case kotlinPluginTag:
1979 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001980 case syspropPublicStubDepTag:
1981 // This is a sysprop implementation library, forward the JavaInfoProvider from
1982 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
1983 ctx.SetProvider(SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
1984 JavaInfo: dep,
1985 })
1986 }
1987 } else if dep, ok := module.(android.SourceFileProducer); ok {
1988 switch tag {
1989 case libTag:
1990 checkProducesJars(ctx, dep)
1991 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001992 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001993 case staticLibTag:
1994 checkProducesJars(ctx, dep)
1995 deps.classpath = append(deps.classpath, dep.Srcs()...)
1996 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
1997 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
1998 }
1999 } else {
2000 switch tag {
2001 case bootClasspathTag:
2002 // If a system modules dependency has been added to the bootclasspath
2003 // then add its libs to the bootclasspath.
2004 sm := module.(SystemModulesProvider)
2005 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars()...)
2006
2007 case systemModulesTag:
2008 if deps.systemModules != nil {
2009 panic("Found two system module dependencies")
2010 }
2011 sm := module.(SystemModulesProvider)
2012 outputDir, outputDeps := sm.OutputDirAndDeps()
2013 deps.systemModules = &systemModules{outputDir, outputDeps}
Paul Duffin53a70a42022-01-11 14:35:55 +00002014
2015 case instrumentationForTag:
2016 ctx.PropertyErrorf("instrumentation_for", "dependency %q of type %q does not provide JavaInfo so is unsuitable for use with this property", ctx.OtherModuleName(module), ctx.OtherModuleType(module))
Jaewoong Jung26342642021-03-17 15:56:23 -07002017 }
2018 }
2019
2020 addCLCFromDep(ctx, module, j.classLoaderContexts)
2021 })
2022
2023 return deps
2024}
2025
2026func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2027 deps.processorPath = append(deps.processorPath, pluginJars...)
2028 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2029}
2030
2031// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2032// this interface.
2033type ProvidesUsesLib interface {
2034 ProvidesUsesLib() *string
2035}
2036
2037func (j *Module) ProvidesUsesLib() *string {
2038 return j.usesLibraryProperties.Provides_uses_lib
2039}
satayev1c564cc2021-05-25 19:50:30 +01002040
2041type ModuleWithStem interface {
2042 Stem() string
2043}
2044
2045var _ ModuleWithStem = (*Module)(nil)
Wei Libafb6d62021-12-10 03:14:59 -08002046
2047func (j *Module) ConvertWithBp2build(ctx android.TopDownMutatorContext) {
2048 switch ctx.ModuleType() {
Sam Delmericofde9fb52022-01-28 20:53:38 +00002049 case "java_library", "java_library_host", "java_library_static":
Wei Libafb6d62021-12-10 03:14:59 -08002050 if lib, ok := ctx.Module().(*Library); ok {
2051 javaLibraryBp2Build(ctx, lib)
2052 }
2053 case "java_binary_host":
2054 if binary, ok := ctx.Module().(*Binary); ok {
2055 javaBinaryHostBp2Build(ctx, binary)
2056 }
2057 }
Wei Libafb6d62021-12-10 03:14:59 -08002058}