blob: 6930bcd178e40d32b1d77ded29eb42cd8cc081f6 [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"`
173
174 // List of files to include in the META-INF/services folder of the resulting jar.
175 Services []string `android:"path,arch_variant"`
176
177 // If true, package the kotlin stdlib into the jar. Defaults to true.
178 Static_kotlin_stdlib *bool `android:"arch_variant"`
179
180 // A list of java_library instances that provide additional hiddenapi annotations for the library.
181 Hiddenapi_additional_annotations []string
182}
183
184// Properties that are specific to device modules. Host module factories should not add these when
185// constructing a new module.
186type DeviceProperties struct {
187 // if not blank, set to the version of the sdk to compile against.
188 // Defaults to compiling against the current platform.
189 Sdk_version *string
190
191 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
192 // Defaults to sdk_version if not set.
193 Min_sdk_version *string
194
195 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
196 // Defaults to sdk_version if not set.
197 Target_sdk_version *string
198
199 // Whether to compile against the platform APIs instead of an SDK.
200 // If true, then sdk_version must be empty. The value of this field
201 // is ignored when module's type isn't android_app.
202 Platform_apis *bool
203
204 Aidl struct {
205 // Top level directories to pass to aidl tool
206 Include_dirs []string
207
208 // Directories rooted at the Android.bp file to pass to aidl tool
209 Local_include_dirs []string
210
211 // directories that should be added as include directories for any aidl sources of modules
212 // that depend on this module, as well as to aidl for this module.
213 Export_include_dirs []string
214
215 // whether to generate traces (for systrace) for this interface
216 Generate_traces *bool
217
218 // whether to generate Binder#GetTransaction name method.
219 Generate_get_transaction_name *bool
220
221 // list of flags that will be passed to the AIDL compiler
222 Flags []string
223 }
224
225 // If true, export a copy of the module as a -hostdex module for host testing.
226 Hostdex *bool
227
228 Target struct {
229 Hostdex struct {
230 // Additional required dependencies to add to -hostdex modules.
231 Required []string
232 }
233 }
234
235 // When targeting 1.9 and above, override the modules to use with --system,
236 // otherwise provides defaults libraries to add to the bootclasspath.
237 System_modules *string
238
Jaewoong Jung26342642021-03-17 15:56:23 -0700239 // set the name of the output
240 Stem *string
241
242 IsSDKLibrary bool `blueprint:"mutated"`
243
244 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
245 // Defaults to false.
246 V4_signature *bool
247
248 // Only for libraries created by a sysprop_library module, SyspropPublicStub is the name of the
249 // public stubs library.
250 SyspropPublicStub string `blueprint:"mutated"`
251}
252
253// Functionality common to Module and Import
254//
255// It is embedded in Module so its functionality can be used by methods in Module
256// but it is currently only initialized by Import and Library.
257type embeddableInModuleAndImport struct {
258
259 // Functionality related to this being used as a component of a java_sdk_library.
260 EmbeddableSdkLibraryComponent
261}
262
Paul Duffin71b33cc2021-06-23 11:39:47 +0100263func (e *embeddableInModuleAndImport) initModuleAndImport(module android.Module) {
264 e.initSdkLibraryComponent(module)
Jaewoong Jung26342642021-03-17 15:56:23 -0700265}
266
267// Module/Import's DepIsInSameApex(...) delegates to this method.
268//
269// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
270// the one provided by ApexModuleBase.
271func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
272 // dependencies other than the static linkage are all considered crossing APEX boundary
273 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
274 return true
275 }
276 return false
277}
278
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100279// OptionalDexJarPath can be either unset, hold a valid path to a dex jar file,
280// or an invalid path describing the reason it is invalid.
281//
282// It is unset if a dex jar isn't applicable, i.e. no build rule has been
283// requested to create one.
284//
285// If a dex jar has been requested to be built then it is set, and it may be
286// either a valid android.Path, or invalid with a reason message. The latter
287// happens if the source that should produce the dex file isn't able to.
288//
289// E.g. it is invalid with a reason message if there is a prebuilt APEX that
290// could produce the dex jar through a deapexer module, but the APEX isn't
291// installable so doing so wouldn't be safe.
292type OptionalDexJarPath struct {
293 isSet bool
294 path android.OptionalPath
295}
296
297// IsSet returns true if a path has been set, either invalid or valid.
298func (o OptionalDexJarPath) IsSet() bool {
299 return o.isSet
300}
301
302// Valid returns true if there is a path that is valid.
303func (o OptionalDexJarPath) Valid() bool {
304 return o.isSet && o.path.Valid()
305}
306
307// Path returns the valid path, or panics if it's either not set or is invalid.
308func (o OptionalDexJarPath) Path() android.Path {
309 if !o.isSet {
310 panic("path isn't set")
311 }
312 return o.path.Path()
313}
314
315// PathOrNil returns the path if it's set and valid, or else nil.
316func (o OptionalDexJarPath) PathOrNil() android.Path {
317 if o.Valid() {
318 return o.Path()
319 }
320 return nil
321}
322
323// InvalidReason returns the reason for an invalid path, which is never "". It
324// returns "" for an unset or valid path.
325func (o OptionalDexJarPath) InvalidReason() string {
326 if !o.isSet {
327 return ""
328 }
329 return o.path.InvalidReason()
330}
331
332func (o OptionalDexJarPath) String() string {
333 if !o.isSet {
334 return "<unset>"
335 }
336 return o.path.String()
337}
338
339// makeUnsetDexJarPath returns an unset OptionalDexJarPath.
340func makeUnsetDexJarPath() OptionalDexJarPath {
341 return OptionalDexJarPath{isSet: false}
342}
343
344// makeDexJarPathFromOptionalPath returns an OptionalDexJarPath that is set with
345// the given OptionalPath, which may be valid or invalid.
346func makeDexJarPathFromOptionalPath(path android.OptionalPath) OptionalDexJarPath {
347 return OptionalDexJarPath{isSet: true, path: path}
348}
349
350// makeDexJarPathFromPath returns an OptionalDexJarPath that is set with the
351// valid given path. It returns an unset OptionalDexJarPath if the given path is
352// nil.
353func makeDexJarPathFromPath(path android.Path) OptionalDexJarPath {
354 if path == nil {
355 return makeUnsetDexJarPath()
356 }
357 return makeDexJarPathFromOptionalPath(android.OptionalPathForPath(path))
358}
359
Jaewoong Jung26342642021-03-17 15:56:23 -0700360// Module contains the properties and members used by all java module types
361type Module struct {
362 android.ModuleBase
363 android.DefaultableModuleBase
364 android.ApexModuleBase
365 android.SdkBase
366
367 // Functionality common to Module and Import.
368 embeddableInModuleAndImport
369
370 properties CommonProperties
371 protoProperties android.ProtoProperties
372 deviceProperties DeviceProperties
373
374 // jar file containing header classes including static library dependencies, suitable for
375 // inserting into the bootclasspath/classpath of another compile
376 headerJarFile android.Path
377
378 // jar file containing implementation classes including static library dependencies but no
379 // resources
380 implementationJarFile android.Path
381
382 // jar file containing only resources including from static library dependencies
383 resourceJar android.Path
384
385 // args and dependencies to package source files into a srcjar
386 srcJarArgs []string
387 srcJarDeps android.Paths
388
389 // jar file containing implementation classes and resources including static library
390 // dependencies
391 implementationAndResourcesJar android.Path
392
393 // output file containing classes.dex and resources
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100394 dexJarFile OptionalDexJarPath
Jaewoong Jung26342642021-03-17 15:56:23 -0700395
396 // output file containing uninstrumented classes that will be instrumented by jacoco
397 jacocoReportClassesFile android.Path
398
399 // output file of the module, which may be a classes jar or a dex jar
400 outputFile android.Path
401 extraOutputFiles android.Paths
402
403 exportAidlIncludeDirs android.Paths
404
405 logtagsSrcs android.Paths
406
407 // installed file for binary dependency
408 installFile android.Path
409
Colin Cross3108ce12021-11-10 14:38:50 -0800410 // installed file for hostdex copy
411 hostdexInstallFile android.InstallPath
412
Jaewoong Jung26342642021-03-17 15:56:23 -0700413 // list of .java files and srcjars that was passed to javac
414 compiledJavaSrcs android.Paths
415 compiledSrcJars android.Paths
416
417 // manifest file to use instead of properties.Manifest
418 overrideManifest android.OptionalPath
419
420 // map of SDK version to class loader context
421 classLoaderContexts dexpreopt.ClassLoaderContextMap
422
423 // list of plugins that this java module is exporting
424 exportedPluginJars android.Paths
425
426 // list of plugins that this java module is exporting
427 exportedPluginClasses []string
428
429 // if true, the exported plugins generate API and require disabling turbine.
430 exportedDisableTurbine bool
431
432 // list of source files, collected from srcFiles with unique java and all kt files,
433 // will be used by android.IDEInfo struct
434 expandIDEInfoCompiledSrcs []string
435
436 // expanded Jarjar_rules
437 expandJarjarRules android.Path
438
Jaewoong Jung26342642021-03-17 15:56:23 -0700439 // Extra files generated by the module type to be added as java resources.
440 extraResources android.Paths
441
442 hiddenAPI
443 dexer
444 dexpreopter
445 usesLibrary
446 linter
447
448 // list of the xref extraction files
449 kytheFiles android.Paths
450
451 // Collect the module directory for IDE info in java/jdeps.go.
452 modulePaths []string
453
454 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +0900455
456 sdkVersion android.SdkSpec
457 minSdkVersion android.SdkSpec
Jaewoong Jung26342642021-03-17 15:56:23 -0700458}
459
Jiyong Park92315372021-04-02 08:45:46 +0900460func (j *Module) CheckStableSdkVersion(ctx android.BaseModuleContext) error {
461 sdkVersion := j.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900462 if sdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700463 return nil
464 }
Jiyong Parkf1691d22021-03-29 20:11:58 +0900465 if sdkVersion.Kind == android.SdkCorePlatform {
Paul Duffin1ea7c9f2021-03-15 09:39:13 +0000466 if useLegacyCorePlatformApi(ctx, j.BaseModuleName()) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700467 return fmt.Errorf("non stable SDK %v - uses legacy core platform", sdkVersion)
468 } else {
469 // Treat stable core platform as stable.
470 return nil
471 }
472 } else {
473 return fmt.Errorf("non stable SDK %v", sdkVersion)
474 }
475}
476
477// checkSdkVersions enforces restrictions around SDK dependencies.
478func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
479 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900480 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900481 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700482 ctx.PropertyErrorf("sdk_version",
483 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
484 }
485 }
486 }
487
488 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
489 // See rank() for details.
490 ctx.VisitDirectDeps(func(module android.Module) {
491 tag := ctx.OtherModuleDependencyTag(module)
492 switch module.(type) {
493 // TODO(satayev): cover other types as well, e.g. imports
494 case *Library, *AndroidLibrary:
495 switch tag {
496 case bootClasspathTag, libTag, staticLibTag, java9LibTag:
497 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
498 }
499 }
500 })
501}
502
503func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900504 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700505 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900506 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700507 if usePlatformAPI && sdkVersionSpecified {
508 ctx.PropertyErrorf("platform_apis", "platform_apis must be false when sdk_version is not empty.")
509 } else if !usePlatformAPI && !sdkVersionSpecified {
510 ctx.PropertyErrorf("platform_apis", "platform_apis must be true when sdk_version is empty.")
511 }
512
513 }
514}
515
516func (j *Module) addHostProperties() {
517 j.AddProperties(
518 &j.properties,
519 &j.protoProperties,
520 &j.usesLibraryProperties,
521 )
522}
523
524func (j *Module) addHostAndDeviceProperties() {
525 j.addHostProperties()
526 j.AddProperties(
527 &j.deviceProperties,
528 &j.dexer.dexProperties,
529 &j.dexpreoptProperties,
530 &j.linter.properties,
531 )
532}
533
534func (j *Module) OutputFiles(tag string) (android.Paths, error) {
535 switch tag {
536 case "":
537 return append(android.Paths{j.outputFile}, j.extraOutputFiles...), nil
538 case android.DefaultDistTag:
539 return android.Paths{j.outputFile}, nil
540 case ".jar":
541 return android.Paths{j.implementationAndResourcesJar}, nil
542 case ".proguard_map":
543 if j.dexer.proguardDictionary.Valid() {
544 return android.Paths{j.dexer.proguardDictionary.Path()}, nil
545 }
546 return nil, fmt.Errorf("%q was requested, but no output file was found.", tag)
547 default:
548 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
549 }
550}
551
552var _ android.OutputFileProducer = (*Module)(nil)
553
554func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
555 initJavaModule(module, hod, false)
556}
557
558func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
559 initJavaModule(module, hod, true)
560}
561
562func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
563 multilib := android.MultilibCommon
564 if multiTargets {
565 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
566 } else {
567 android.InitAndroidArchModule(module, hod, multilib)
568 }
569 android.InitDefaultableModule(module)
570}
571
572func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
573 return j.properties.Instrument &&
574 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
575 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
576}
577
578func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
579 return j.shouldInstrument(ctx) &&
580 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
581 ctx.Config().UnbundledBuild())
582}
583
584func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
585 // Force enable the instrumentation for java code that is built for APEXes ...
586 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
587 // doesn't make sense) or framework libraries (e.g. libraries found in the InstrumentFrameworkModules list) unless EMMA_INSTRUMENT_FRAMEWORK is true.
588 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
589 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
590 if j.DirectlyInAnyApex() && !isJacocoAgent && !apexInfo.IsForPlatform() {
591 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
592 return true
593 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
594 return true
595 }
596 }
597 return false
598}
599
Jiyong Park92315372021-04-02 08:45:46 +0900600func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
601 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700602}
603
Jiyong Parkf1691d22021-03-29 20:11:58 +0900604func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700605 return proptools.String(j.deviceProperties.System_modules)
606}
607
Jiyong Park92315372021-04-02 08:45:46 +0900608func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
Jaewoong Jung26342642021-03-17 15:56:23 -0700609 if j.deviceProperties.Min_sdk_version != nil {
Jiyong Park92315372021-04-02 08:45:46 +0900610 return android.SdkSpecFrom(ctx, *j.deviceProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700611 }
Jiyong Park92315372021-04-02 08:45:46 +0900612 return j.SdkVersion(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -0700613}
614
Jiyong Parkf1691d22021-03-29 20:11:58 +0900615func (j *Module) MinSdkVersionString() string {
Jiyong Park92315372021-04-02 08:45:46 +0900616 return j.minSdkVersion.Raw
617}
618
619func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
620 if j.deviceProperties.Target_sdk_version != nil {
621 return android.SdkSpecFrom(ctx, *j.deviceProperties.Target_sdk_version)
622 }
623 return j.SdkVersion(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -0700624}
625
626func (j *Module) AvailableFor(what string) bool {
627 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
628 // Exception: for hostdex: true libraries, the platform variant is created
629 // even if it's not marked as available to platform. In that case, the platform
630 // variant is used only for the hostdex and not installed to the device.
631 return true
632 }
633 return j.ApexModuleBase.AvailableFor(what)
634}
635
636func (j *Module) deps(ctx android.BottomUpMutatorContext) {
637 if ctx.Device() {
638 j.linter.deps(ctx)
639
Jiyong Parkf1691d22021-03-29 20:11:58 +0900640 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700641
642 if j.deviceProperties.SyspropPublicStub != "" {
643 // This is a sysprop implementation library that has a corresponding sysprop public
644 // stubs library, and a dependency on it so that dependencies on the implementation can
645 // be forwarded to the public stubs library when necessary.
646 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
647 }
648 }
649
650 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
651 ctx.AddVariationDependencies(nil, staticLibTag, j.properties.Static_libs...)
652
653 // Add dependency on libraries that provide additional hidden api annotations.
654 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
655
656 if ctx.DeviceConfig().VndkVersion() != "" && ctx.Config().EnforceInterPartitionJavaSdkLibrary() {
657 // Require java_sdk_library at inter-partition java dependency to ensure stable
658 // interface between partitions. If inter-partition java_library dependency is detected,
659 // raise build error because java_library doesn't have a stable interface.
660 //
661 // Inputs:
662 // PRODUCT_ENFORCE_INTER_PARTITION_JAVA_SDK_LIBRARY
663 // if true, enable enforcement
664 // PRODUCT_INTER_PARTITION_JAVA_LIBRARY_ALLOWLIST
665 // exception list of java_library names to allow inter-partition dependency
666 for idx := range j.properties.Libs {
667 if libDeps[idx] == nil {
668 continue
669 }
670
671 if javaDep, ok := libDeps[idx].(javaSdkLibraryEnforceContext); ok {
672 // java_sdk_library is always allowed at inter-partition dependency.
673 // So, skip check.
674 if _, ok := javaDep.(*SdkLibrary); ok {
675 continue
676 }
677
678 j.checkPartitionsForJavaDependency(ctx, "libs", javaDep)
679 }
680 }
681 }
682
683 // For library dependencies that are component libraries (like stubs), add the implementation
684 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
685 for _, dep := range libDeps {
686 if dep != nil {
687 if component, ok := dep.(SdkLibraryComponentDependency); ok {
688 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100689 // Add library as optional if it's one of the optional compatibility libs.
Ulya Trafimovich0b1c70e2021-08-20 15:39:12 +0100690 optional := android.InList(*lib, dexpreopt.OptionalCompatUsesLibs)
691 tag := makeUsesLibraryDependencyTag(dexpreopt.AnySdkVersion, optional, true)
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100692 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700693 }
694 }
695 }
696 }
697
698 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
699 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
700 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
701
702 android.ProtoDeps(ctx, &j.protoProperties)
703 if j.hasSrcExt(".proto") {
704 protoDeps(ctx, &j.protoProperties)
705 }
706
707 if j.hasSrcExt(".kt") {
708 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
709 // Kotlin files
710 ctx.AddVariationDependencies(nil, kotlinStdlibTag,
711 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8")
712 if len(j.properties.Plugins) > 0 {
713 ctx.AddVariationDependencies(nil, kotlinAnnotationsTag, "kotlin-annotations")
714 }
715 }
716
717 // Framework libraries need special handling in static coverage builds: they should not have
718 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
719 // the same jacoco classes coming from different bootclasspath jars.
720 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
721 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
722 j.properties.Instrument = true
723 }
724 } else if j.shouldInstrumentStatic(ctx) {
725 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
726 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700727
728 if j.useCompose() {
729 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
730 "androidx.compose.compiler_compiler-hosted")
731 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700732}
733
734func hasSrcExt(srcs []string, ext string) bool {
735 for _, src := range srcs {
736 if filepath.Ext(src) == ext {
737 return true
738 }
739 }
740
741 return false
742}
743
744func (j *Module) hasSrcExt(ext string) bool {
745 return hasSrcExt(j.properties.Srcs, ext)
746}
747
748func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
749 aidlIncludeDirs android.Paths) (string, android.Paths) {
750
751 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
752 aidlIncludes = append(aidlIncludes,
753 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
754 aidlIncludes = append(aidlIncludes,
755 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
756
757 var flags []string
758 var deps android.Paths
759
760 flags = append(flags, j.deviceProperties.Aidl.Flags...)
761
762 if aidlPreprocess.Valid() {
763 flags = append(flags, "-p"+aidlPreprocess.String())
764 deps = append(deps, aidlPreprocess.Path())
765 } else if len(aidlIncludeDirs) > 0 {
766 flags = append(flags, android.JoinWithPrefix(aidlIncludeDirs.Strings(), "-I"))
767 }
768
769 if len(j.exportAidlIncludeDirs) > 0 {
770 flags = append(flags, android.JoinWithPrefix(j.exportAidlIncludeDirs.Strings(), "-I"))
771 }
772
773 if len(aidlIncludes) > 0 {
774 flags = append(flags, android.JoinWithPrefix(aidlIncludes.Strings(), "-I"))
775 }
776
777 flags = append(flags, "-I"+android.PathForModuleSrc(ctx).String())
778 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
779 flags = append(flags, "-I"+src.String())
780 }
781
782 if Bool(j.deviceProperties.Aidl.Generate_traces) {
783 flags = append(flags, "-t")
784 }
785
786 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
787 flags = append(flags, "--transaction_names")
788 }
789
Jooyung Han07f70c02021-11-06 07:08:45 +0900790 aidlMinSdkVersion := j.MinSdkVersion(ctx).ApiLevel.String()
791 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
792
Jaewoong Jung26342642021-03-17 15:56:23 -0700793 return strings.Join(flags, " "), deps
794}
795
796func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
797
798 var flags javaBuilderFlags
799
800 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +0900801 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -0700802
Cole Faust2b1536e2021-06-18 12:25:54 -0700803 epEnabled := j.properties.Errorprone.Enabled
804 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700805 if config.ErrorProneClasspath == nil && ctx.Config().TestProductVariables == nil {
806 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
807 }
808
809 errorProneFlags := []string{
810 "-Xplugin:ErrorProne",
811 "${config.ErrorProneChecks}",
812 }
813 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
814
815 flags.errorProneExtraJavacFlags = "${config.ErrorProneFlags} " +
816 "'" + strings.Join(errorProneFlags, " ") + "'"
817 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
818 }
819
820 // classpath
821 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
822 flags.classpath = append(flags.classpath, deps.classpath...)
823 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
824 flags.processorPath = append(flags.processorPath, deps.processorPath...)
825 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
826
827 flags.processors = append(flags.processors, deps.processorClasses...)
828 flags.processors = android.FirstUniqueStrings(flags.processors)
829
830 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +0900831 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700832 // Give host-side tools a version of OpenJDK's standard libraries
833 // close to what they're targeting. As of Dec 2017, AOSP is only
834 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
835 //
836 // When building with OpenJDK 8, the following should have no
837 // effect since those jars would be available by default.
838 //
839 // When building with OpenJDK 9 but targeting a version < 1.8,
840 // putting them on the bootclasspath means that:
841 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
842 // b) references to existing APIs are not reinterpreted in an
843 // OpenJDK 9-specific way, eg. calls to subclasses of
844 // java.nio.Buffer as in http://b/70862583
845 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
846 flags.bootClasspath = append(flags.bootClasspath,
847 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
848 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
849 if Bool(j.properties.Use_tools_jar) {
850 flags.bootClasspath = append(flags.bootClasspath,
851 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
852 }
853 }
854
855 // systemModules
856 flags.systemModules = deps.systemModules
857
858 // aidl flags.
859 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs)
860
861 return flags
862}
863
864func (j *Module) collectJavacFlags(
865 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
866 // javac flags.
867 javacFlags := j.properties.Javacflags
868
869 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() {
870 // For non-host binaries, override the -g flag passed globally to remove
871 // local variable debug info to reduce disk and memory usage.
872 javacFlags = append(javacFlags, "-g:source,lines")
873 }
874 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
875
876 if flags.javaVersion.usesJavaModules() {
877 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
878
879 if j.properties.Patch_module != nil {
880 // Manually specify build directory in case it is not under the repo root.
881 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
882 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200883 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -0700884
885 // b/150878007
886 //
887 // Workaround to support *Bazel-executed* JDK9 javac in Bazel's
888 // execution root for --patch-module. If this javac command line is
889 // invoked within Bazel's execution root working directory, the top
890 // level directories (e.g. libcore/, tools/, frameworks/) are all
891 // symlinks. JDK9 javac does not traverse into symlinks, which causes
892 // --patch-module to fail source file lookups when invoked in the
893 // execution root.
894 //
895 // Short of patching javac or enumerating *all* directories as possible
896 // input dirs, manually add the top level dir of the source files to be
897 // compiled.
898 topLevelDirs := map[string]bool{}
899 for _, srcFilePath := range srcFiles {
900 srcFileParts := strings.Split(srcFilePath.String(), "/")
901 // Ignore source files that are already in the top level directory
902 // as well as generated files in the out directory. The out
903 // directory may be an absolute path, which means srcFileParts[0] is the
904 // empty string, so check that as well. Note that "out" in Bazel's execution
905 // root is *not* a symlink, which doesn't cause problems for --patch-modules
906 // anyway, so it's fine to not apply this workaround for generated
907 // source files.
908 if len(srcFileParts) > 1 &&
909 srcFileParts[0] != "" &&
910 srcFileParts[0] != "out" {
911 topLevelDirs[srcFileParts[0]] = true
912 }
913 }
914 patchPaths = append(patchPaths, android.SortedStringKeys(topLevelDirs)...)
915
916 classPath := flags.classpath.FormJavaClassPath("")
917 if classPath != "" {
918 patchPaths = append(patchPaths, classPath)
919 }
920 javacFlags = append(
921 javacFlags,
922 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
923 }
924 }
925
926 if len(javacFlags) > 0 {
927 // optimization.
928 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
929 flags.javacFlags = "$javacFlags"
930 }
931
932 return flags
933}
934
935func (j *Module) compile(ctx android.ModuleContext, aaptSrcJar android.Path) {
936 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
937
938 deps := j.collectDeps(ctx)
939 flags := j.collectBuilderFlags(ctx, deps)
940
941 if flags.javaVersion.usesJavaModules() {
942 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
943 }
944 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
945 if hasSrcExt(srcFiles.Strings(), ".proto") {
946 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
947 }
948
949 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, nil)
950 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
951 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
952 }
953
954 srcFiles = j.genSources(ctx, srcFiles, flags)
955
956 // Collect javac flags only after computing the full set of srcFiles to
957 // ensure that the --patch-module lookup paths are complete.
958 flags = j.collectJavacFlags(ctx, flags, srcFiles)
959
960 srcJars := srcFiles.FilterByExt(".srcjar")
961 srcJars = append(srcJars, deps.srcJars...)
962 if aaptSrcJar != nil {
963 srcJars = append(srcJars, aaptSrcJar)
964 }
Colin Crossb0ef30a2021-06-29 10:42:00 -0700965 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -0700966
967 if j.properties.Jarjar_rules != nil {
968 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
969 }
970
971 jarName := ctx.ModuleName() + ".jar"
972
973 javaSrcFiles := srcFiles.FilterByExt(".java")
974 var uniqueSrcFiles android.Paths
975 set := make(map[string]bool)
976 for _, v := range javaSrcFiles {
977 if _, found := set[v.String()]; !found {
978 set[v.String()] = true
979 uniqueSrcFiles = append(uniqueSrcFiles, v)
980 }
981 }
982
983 // Collect .java files for AIDEGen
984 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
985
986 var kotlinJars android.Paths
987
988 if srcFiles.HasExt(".kt") {
989 // user defined kotlin flags.
990 kotlincFlags := j.properties.Kotlincflags
991 CheckKotlincFlags(ctx, kotlincFlags)
992
Aurimas Liutikas24a987f2021-05-17 17:47:10 +0000993 // Workaround for KT-46512
994 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -0700995
996 // If there are kotlin files, compile them first but pass all the kotlin and java files
997 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
998 // won't emit any classes for them.
999 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1000 if ctx.Device() {
1001 kotlincFlags = append(kotlincFlags, "-no-jdk")
1002 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001003
1004 for _, plugin := range deps.kotlinPlugins {
1005 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1006 }
1007 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1008
Jaewoong Jung26342642021-03-17 15:56:23 -07001009 if len(kotlincFlags) > 0 {
1010 // optimization.
1011 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1012 flags.kotlincFlags += "$kotlincFlags"
1013 }
1014
1015 var kotlinSrcFiles android.Paths
1016 kotlinSrcFiles = append(kotlinSrcFiles, uniqueSrcFiles...)
1017 kotlinSrcFiles = append(kotlinSrcFiles, srcFiles.FilterByExt(".kt")...)
1018
1019 // Collect .kt files for AIDEGen
1020 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, srcFiles.FilterByExt(".kt").Strings()...)
1021 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1022
1023 flags.classpath = append(flags.classpath, deps.kotlinStdlib...)
1024 flags.classpath = append(flags.classpath, deps.kotlinAnnotations...)
1025
1026 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1027 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1028
1029 if len(flags.processorPath) > 0 {
1030 // Use kapt for annotation processing
1031 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1032 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
1033 kotlinKapt(ctx, kaptSrcJar, kaptResJar, kotlinSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
1034 srcJars = append(srcJars, kaptSrcJar)
1035 kotlinJars = append(kotlinJars, kaptResJar)
1036 // Disable annotation processing in javac, it's already been handled by kapt
1037 flags.processorPath = nil
1038 flags.processors = nil
1039 }
1040
1041 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
1042 kotlinCompile(ctx, kotlinJar, kotlinSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
1043 if ctx.Failed() {
1044 return
1045 }
1046
1047 // Make javac rule depend on the kotlinc rule
1048 flags.classpath = append(flags.classpath, kotlinJar)
1049
1050 kotlinJars = append(kotlinJars, kotlinJar)
1051 // Jar kotlin classes into the final jar after javac
1052 if BoolDefault(j.properties.Static_kotlin_stdlib, true) {
1053 kotlinJars = append(kotlinJars, deps.kotlinStdlib...)
1054 }
1055 }
1056
1057 jars := append(android.Paths(nil), kotlinJars...)
1058
1059 // Store the list of .java files that was passed to javac
1060 j.compiledJavaSrcs = uniqueSrcFiles
1061 j.compiledSrcJars = srcJars
1062
1063 enableSharding := false
1064 var headerJarFileWithoutJarjar android.Path
1065 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !deps.disableTurbine {
1066 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1067 enableSharding = true
1068 // Formerly, there was a check here that prevented annotation processors
1069 // from being used when sharding was enabled, as some annotation processors
1070 // do not function correctly in sharded environments. It was removed to
1071 // allow for the use of annotation processors that do function correctly
1072 // with sharding enabled. See: b/77284273.
1073 }
1074 headerJarFileWithoutJarjar, j.headerJarFile =
1075 j.compileJavaHeader(ctx, uniqueSrcFiles, srcJars, deps, flags, jarName, kotlinJars)
1076 if ctx.Failed() {
1077 return
1078 }
1079 }
1080 if len(uniqueSrcFiles) > 0 || len(srcJars) > 0 {
1081 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001082 if Bool(j.properties.Errorprone.Enabled) {
1083 // If error-prone is enabled, enable errorprone flags on the regular
1084 // build.
1085 flags = enableErrorproneFlags(flags)
Cole Faust2b1536e2021-06-18 12:25:54 -07001086 } else if ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faust75fffb12021-06-13 15:23:16 -07001087 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1088 // a new jar file just for compiling with the errorprone compiler to.
1089 // This is because we don't want to cause the java files to get completely
1090 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1091 // We also don't want to run this if errorprone is enabled by default for
1092 // this module, or else we could have duplicated errorprone messages.
1093 errorproneFlags := enableErrorproneFlags(flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001094 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Cole Faust75fffb12021-06-13 15:23:16 -07001095
1096 transformJavaToClasses(ctx, errorprone, -1, uniqueSrcFiles, srcJars, errorproneFlags, nil,
1097 "errorprone", "errorprone")
1098
Jaewoong Jung26342642021-03-17 15:56:23 -07001099 extraJarDeps = append(extraJarDeps, errorprone)
1100 }
1101
1102 if enableSharding {
1103 flags.classpath = append(flags.classpath, headerJarFileWithoutJarjar)
1104 shardSize := int(*(j.properties.Javac_shard_size))
1105 var shardSrcs []android.Paths
1106 if len(uniqueSrcFiles) > 0 {
1107 shardSrcs = android.ShardPaths(uniqueSrcFiles, shardSize)
1108 for idx, shardSrc := range shardSrcs {
1109 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1110 nil, flags, extraJarDeps)
1111 jars = append(jars, classes)
1112 }
1113 }
1114 if len(srcJars) > 0 {
1115 classes := j.compileJavaClasses(ctx, jarName, len(shardSrcs),
1116 nil, srcJars, flags, extraJarDeps)
1117 jars = append(jars, classes)
1118 }
1119 } else {
1120 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueSrcFiles, srcJars, flags, extraJarDeps)
1121 jars = append(jars, classes)
1122 }
1123 if ctx.Failed() {
1124 return
1125 }
1126 }
1127
1128 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1129
1130 var includeSrcJar android.WritablePath
1131 if Bool(j.properties.Include_srcs) {
1132 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1133 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1134 }
1135
1136 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1137 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
1138 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
1139 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1140
1141 var resArgs []string
1142 var resDeps android.Paths
1143
1144 resArgs = append(resArgs, dirArgs...)
1145 resDeps = append(resDeps, dirDeps...)
1146
1147 resArgs = append(resArgs, fileArgs...)
1148 resDeps = append(resDeps, fileDeps...)
1149
1150 resArgs = append(resArgs, extraArgs...)
1151 resDeps = append(resDeps, extraDeps...)
1152
1153 if len(resArgs) > 0 {
1154 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1155 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
1156 j.resourceJar = resourceJar
1157 if ctx.Failed() {
1158 return
1159 }
1160 }
1161
1162 var resourceJars android.Paths
1163 if j.resourceJar != nil {
1164 resourceJars = append(resourceJars, j.resourceJar)
1165 }
1166 if Bool(j.properties.Include_srcs) {
1167 resourceJars = append(resourceJars, includeSrcJar)
1168 }
1169 resourceJars = append(resourceJars, deps.staticResourceJars...)
1170
1171 if len(resourceJars) > 1 {
1172 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1173 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1174 false, nil, nil)
1175 j.resourceJar = combinedJar
1176 } else if len(resourceJars) == 1 {
1177 j.resourceJar = resourceJars[0]
1178 }
1179
1180 if len(deps.staticJars) > 0 {
1181 jars = append(jars, deps.staticJars...)
1182 }
1183
1184 manifest := j.overrideManifest
1185 if !manifest.Valid() && j.properties.Manifest != nil {
1186 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
1187 }
1188
1189 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1190 if len(services) > 0 {
1191 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1192 var zipargs []string
1193 for _, file := range services {
1194 serviceFile := file.String()
1195 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1196 }
1197 rule := zip
1198 args := map[string]string{
1199 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1200 }
1201 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1202 rule = zipRE
1203 args["implicits"] = strings.Join(services.Strings(), ",")
1204 }
1205 ctx.Build(pctx, android.BuildParams{
1206 Rule: rule,
1207 Output: servicesJar,
1208 Implicits: services,
1209 Args: args,
1210 })
1211 jars = append(jars, servicesJar)
1212 }
1213
1214 // Combine the classes built from sources, any manifests, and any static libraries into
1215 // classes.jar. If there is only one input jar this step will be skipped.
1216 var outputFile android.OutputPath
1217
1218 if len(jars) == 1 && !manifest.Valid() {
1219 // Optimization: skip the combine step as there is nothing to do
1220 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1221 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1222 // any if len(jars) == 1.
1223
1224 // Transform the single path to the jar into an OutputPath as that is required by the following
1225 // code.
1226 if moduleOutPath, ok := jars[0].(android.ModuleOutPath); ok {
1227 // The path contains an embedded OutputPath so reuse that.
1228 outputFile = moduleOutPath.OutputPath
1229 } else if outputPath, ok := jars[0].(android.OutputPath); ok {
1230 // The path is an OutputPath so reuse it directly.
1231 outputFile = outputPath
1232 } else {
1233 // The file is not in the out directory so create an OutputPath into which it can be copied
1234 // and which the following code can use to refer to it.
1235 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1236 ctx.Build(pctx, android.BuildParams{
1237 Rule: android.Cp,
1238 Input: jars[0],
1239 Output: combinedJar,
1240 })
1241 outputFile = combinedJar.OutputPath
1242 }
1243 } else {
1244 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1245 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1246 false, nil, nil)
1247 outputFile = combinedJar.OutputPath
1248 }
1249
1250 // jarjar implementation jar if necessary
1251 if j.expandJarjarRules != nil {
1252 // Transform classes.jar into classes-jarjar.jar
1253 jarjarFile := android.PathForModuleOut(ctx, "jarjar", jarName).OutputPath
1254 TransformJarJar(ctx, jarjarFile, outputFile, j.expandJarjarRules)
1255 outputFile = jarjarFile
1256
1257 // jarjar resource jar if necessary
1258 if j.resourceJar != nil {
1259 resourceJarJarFile := android.PathForModuleOut(ctx, "res-jarjar", jarName)
1260 TransformJarJar(ctx, resourceJarJarFile, j.resourceJar, j.expandJarjarRules)
1261 j.resourceJar = resourceJarJarFile
1262 }
1263
1264 if ctx.Failed() {
1265 return
1266 }
1267 }
1268
1269 // Check package restrictions if necessary.
1270 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001271 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001272 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001273
1274 // Create a rule to copy the output jar to another path and add a validate dependency that
1275 // will check that the jar only contains the permitted packages. The new location will become
1276 // the output file of this module.
1277 inputFile := outputFile
1278 outputFile = android.PathForModuleOut(ctx, "package-check", jarName).OutputPath
1279 ctx.Build(pctx, android.BuildParams{
1280 Rule: android.Cp,
1281 Input: inputFile,
1282 Output: outputFile,
1283 // Make sure that any dependency on the output file will cause ninja to run the package check
1284 // rule.
1285 Validation: pkgckFile,
1286 })
1287
1288 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001289 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001290
1291 if ctx.Failed() {
1292 return
1293 }
1294 }
1295
1296 j.implementationJarFile = outputFile
1297 if j.headerJarFile == nil {
1298 j.headerJarFile = j.implementationJarFile
1299 }
1300
1301 if j.shouldInstrumentInApex(ctx) {
1302 j.properties.Instrument = true
1303 }
1304
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001305 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1306 specs := j.jacocoModuleToZipCommand(ctx)
1307 if ctx.Failed() {
1308 return
1309 }
1310
Jaewoong Jung26342642021-03-17 15:56:23 -07001311 if j.shouldInstrument(ctx) {
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001312 outputFile = j.instrument(ctx, flags, outputFile, jarName, specs)
Jaewoong Jung26342642021-03-17 15:56:23 -07001313 }
1314
1315 // merge implementation jar with resources if necessary
1316 implementationAndResourcesJar := outputFile
1317 if j.resourceJar != nil {
1318 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
1319 combinedJar := android.PathForModuleOut(ctx, "withres", jarName).OutputPath
1320 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
1321 false, nil, nil)
1322 implementationAndResourcesJar = combinedJar
1323 }
1324
1325 j.implementationAndResourcesJar = implementationAndResourcesJar
1326
1327 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
1328 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1329 if j.DirectlyInAnyApex() && !apexInfo.IsForPlatform() {
1330 if j.dexProperties.Compile_dex == nil {
1331 j.dexProperties.Compile_dex = proptools.BoolPtr(true)
1332 }
1333 if j.deviceProperties.Hostdex == nil {
1334 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1335 }
1336 }
1337
1338 if ctx.Device() && (Bool(j.properties.Installable) || Bool(j.dexProperties.Compile_dex)) {
1339 if j.hasCode(ctx) {
1340 if j.shouldInstrumentStatic(ctx) {
1341 j.dexer.extraProguardFlagFiles = append(j.dexer.extraProguardFlagFiles,
1342 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1343 }
1344 // Dex compilation
1345 var dexOutputFile android.OutputPath
Colin Crossa79a52c2021-08-04 10:52:44 -07001346 dexOutputFile = j.dexer.compileDex(ctx, flags, j.MinSdkVersion(ctx), implementationAndResourcesJar, jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001347 if ctx.Failed() {
1348 return
1349 }
1350
Jaewoong Jung26342642021-03-17 15:56:23 -07001351 // merge dex jar with resources if necessary
1352 if j.resourceJar != nil {
1353 jars := android.Paths{dexOutputFile, j.resourceJar}
1354 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName).OutputPath
1355 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1356 false, nil, nil)
1357 if *j.dexProperties.Uncompress_dex {
1358 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName).OutputPath
1359 TransformZipAlign(ctx, combinedAlignedJar, combinedJar)
1360 dexOutputFile = combinedAlignedJar
1361 } else {
1362 dexOutputFile = combinedJar
1363 }
1364 }
1365
Paul Duffin4de94502021-05-16 05:21:16 +01001366 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001367
1368 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001369
1370 // Encode hidden API flags in dex file, if needed.
1371 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1372
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001373 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001374
1375 // Dexpreopting
1376 j.dexpreopt(ctx, dexOutputFile)
1377
1378 outputFile = dexOutputFile
1379 } else {
1380 // There is no code to compile into a dex jar, make sure the resources are propagated
1381 // to the APK if this is an app.
1382 outputFile = implementationAndResourcesJar
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001383 j.dexJarFile = makeDexJarPathFromPath(j.resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001384 }
1385
1386 if ctx.Failed() {
1387 return
1388 }
1389 } else {
1390 outputFile = implementationAndResourcesJar
1391 }
1392
1393 if ctx.Device() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09001394 lintSDKVersionString := func(sdkSpec android.SdkSpec) string {
Jiyong Park54105c42021-03-31 18:17:53 +09001395 if v := sdkSpec.ApiLevel; !v.IsPreview() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001396 return v.String()
1397 } else {
1398 return ctx.Config().DefaultAppTargetSdk(ctx).String()
1399 }
1400 }
1401
1402 j.linter.name = ctx.ModuleName()
1403 j.linter.srcs = srcFiles
1404 j.linter.srcJars = srcJars
1405 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1406 j.linter.classes = j.implementationJarFile
Jiyong Park92315372021-04-02 08:45:46 +09001407 j.linter.minSdkVersion = lintSDKVersionString(j.MinSdkVersion(ctx))
1408 j.linter.targetSdkVersion = lintSDKVersionString(j.TargetSdkVersion(ctx))
1409 j.linter.compileSdkVersion = lintSDKVersionString(j.SdkVersion(ctx))
Pedro Loureiro18233a22021-06-08 18:11:21 +00001410 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001411 j.linter.javaLanguageLevel = flags.javaVersion.String()
1412 j.linter.kotlinLanguageLevel = "1.3"
1413 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1414 j.linter.buildModuleReportZip = true
1415 }
1416 j.linter.lint(ctx)
1417 }
1418
1419 ctx.CheckbuildFile(outputFile)
1420
1421 ctx.SetProvider(JavaInfoProvider, JavaInfo{
1422 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1423 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1424 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
1425 ResourceJars: android.PathsIfNonNil(j.resourceJar),
1426 AidlIncludeDirs: j.exportAidlIncludeDirs,
1427 SrcJarArgs: j.srcJarArgs,
1428 SrcJarDeps: j.srcJarDeps,
1429 ExportedPlugins: j.exportedPluginJars,
1430 ExportedPluginClasses: j.exportedPluginClasses,
1431 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1432 JacocoReportClassesFile: j.jacocoReportClassesFile,
1433 })
1434
1435 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1436 j.outputFile = outputFile.WithoutRel()
1437}
1438
Colin Crossa1ff7c62021-09-17 14:11:52 -07001439func (j *Module) useCompose() bool {
1440 return android.InList("androidx.compose.runtime_runtime", j.properties.Static_libs)
1441}
1442
Cole Faust75fffb12021-06-13 15:23:16 -07001443// Returns a copy of the supplied flags, but with all the errorprone-related
1444// fields copied to the regular build's fields.
1445func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
1446 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
1447
1448 if len(flags.errorProneExtraJavacFlags) > 0 {
1449 if len(flags.javacFlags) > 0 {
1450 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
1451 } else {
1452 flags.javacFlags = flags.errorProneExtraJavacFlags
1453 }
1454 }
1455 return flags
1456}
1457
Jaewoong Jung26342642021-03-17 15:56:23 -07001458func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
1459 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.WritablePath {
1460
1461 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
1462 if idx >= 0 {
1463 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
1464 jarName += strconv.Itoa(idx)
1465 }
1466
1467 classes := android.PathForModuleOut(ctx, "javac", jarName).OutputPath
1468 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, flags, extraJarDeps)
1469
1470 if ctx.Config().EmitXrefRules() {
1471 extractionFile := android.PathForModuleOut(ctx, kzipName)
1472 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
1473 j.kytheFiles = append(j.kytheFiles, extractionFile)
1474 }
1475
1476 return classes
1477}
1478
1479// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1480// since some of these flags may be used internally.
1481func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1482 for _, flag := range flags {
1483 flag = strings.TrimSpace(flag)
1484
1485 if !strings.HasPrefix(flag, "-") {
1486 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1487 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1488 ctx.PropertyErrorf("kotlincflags",
1489 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1490 } else if inList(flag, config.KotlincIllegalFlags) {
1491 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1492 } else if flag == "-include-runtime" {
1493 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1494 } else {
1495 args := strings.Split(flag, " ")
1496 if args[0] == "-kotlin-home" {
1497 ctx.PropertyErrorf("kotlincflags",
1498 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1499 }
1500 }
1501 }
1502}
1503
1504func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
1505 deps deps, flags javaBuilderFlags, jarName string,
1506 extraJars android.Paths) (headerJar, jarjarHeaderJar android.Path) {
1507
1508 var jars android.Paths
1509 if len(srcFiles) > 0 || len(srcJars) > 0 {
1510 // Compile java sources into turbine.jar.
1511 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1512 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
1513 if ctx.Failed() {
1514 return nil, nil
1515 }
1516 jars = append(jars, turbineJar)
1517 }
1518
1519 jars = append(jars, extraJars...)
1520
1521 // Combine any static header libraries into classes-header.jar. If there is only
1522 // one input jar this step will be skipped.
1523 jars = append(jars, deps.staticHeaderJars...)
1524
1525 // we cannot skip the combine step for now if there is only one jar
1526 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
1527 combinedJar := android.PathForModuleOut(ctx, "turbine-combined", jarName)
1528 TransformJarsToJar(ctx, combinedJar, "for turbine", jars, android.OptionalPath{},
1529 false, nil, []string{"META-INF/TRANSITIVE"})
1530 headerJar = combinedJar
1531 jarjarHeaderJar = combinedJar
1532
1533 if j.expandJarjarRules != nil {
1534 // Transform classes.jar into classes-jarjar.jar
1535 jarjarFile := android.PathForModuleOut(ctx, "turbine-jarjar", jarName)
1536 TransformJarJar(ctx, jarjarFile, headerJar, j.expandJarjarRules)
1537 jarjarHeaderJar = jarjarFile
1538 if ctx.Failed() {
1539 return nil, nil
1540 }
1541 }
1542
1543 return headerJar, jarjarHeaderJar
1544}
1545
1546func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001547 classesJar android.Path, jarName string, specs string) android.OutputPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07001548
1549 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
1550 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName).OutputPath
1551
1552 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1553
1554 j.jacocoReportClassesFile = jacocoReportClassesFile
1555
1556 return instrumentedJar
1557}
1558
1559func (j *Module) HeaderJars() android.Paths {
1560 if j.headerJarFile == nil {
1561 return nil
1562 }
1563 return android.Paths{j.headerJarFile}
1564}
1565
1566func (j *Module) ImplementationJars() android.Paths {
1567 if j.implementationJarFile == nil {
1568 return nil
1569 }
1570 return android.Paths{j.implementationJarFile}
1571}
1572
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001573func (j *Module) DexJarBuildPath() OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07001574 return j.dexJarFile
1575}
1576
1577func (j *Module) DexJarInstallPath() android.Path {
1578 return j.installFile
1579}
1580
1581func (j *Module) ImplementationAndResourcesJars() android.Paths {
1582 if j.implementationAndResourcesJar == nil {
1583 return nil
1584 }
1585 return android.Paths{j.implementationAndResourcesJar}
1586}
1587
1588func (j *Module) AidlIncludeDirs() android.Paths {
1589 // exportAidlIncludeDirs is type android.Paths already
1590 return j.exportAidlIncludeDirs
1591}
1592
1593func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
1594 return j.classLoaderContexts
1595}
1596
1597// Collect information for opening IDE project files in java/jdeps.go.
1598func (j *Module) IDEInfo(dpInfo *android.IdeInfo) {
1599 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
1600 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
1601 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
1602 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
1603 if j.expandJarjarRules != nil {
1604 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
1605 }
1606 dpInfo.Paths = append(dpInfo.Paths, j.modulePaths...)
1607}
1608
1609func (j *Module) CompilerDeps() []string {
1610 jdeps := []string{}
1611 jdeps = append(jdeps, j.properties.Libs...)
1612 jdeps = append(jdeps, j.properties.Static_libs...)
1613 return jdeps
1614}
1615
1616func (j *Module) hasCode(ctx android.ModuleContext) bool {
1617 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
1618 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
1619}
1620
1621// Implements android.ApexModule
1622func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1623 return j.depIsInSameApex(ctx, dep)
1624}
1625
1626// Implements android.ApexModule
1627func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
1628 sdkVersion android.ApiLevel) error {
Jiyong Park92315372021-04-02 08:45:46 +09001629 sdkSpec := j.MinSdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09001630 if !sdkSpec.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001631 return fmt.Errorf("min_sdk_version is not specified")
1632 }
Jiyong Parkf1691d22021-03-29 20:11:58 +09001633 if sdkSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07001634 return nil
1635 }
Jooyung Han4c4da062021-06-23 10:23:16 +09001636 if sdkSpec.ApiLevel.GreaterThan(sdkVersion) {
1637 return fmt.Errorf("newer SDK(%v)", sdkSpec.ApiLevel)
Jaewoong Jung26342642021-03-17 15:56:23 -07001638 }
1639 return nil
1640}
1641
1642func (j *Module) Stem() string {
1643 return proptools.StringDefault(j.deviceProperties.Stem, j.Name())
1644}
1645
Jaewoong Jung26342642021-03-17 15:56:23 -07001646func (j *Module) JacocoReportClassesFile() android.Path {
1647 return j.jacocoReportClassesFile
1648}
1649
1650func (j *Module) IsInstallable() bool {
1651 return Bool(j.properties.Installable)
1652}
1653
1654type sdkLinkType int
1655
1656const (
1657 // TODO(jiyong) rename these for better readability. Make the allowed
1658 // and disallowed link types explicit
1659 // order is important here. See rank()
1660 javaCore sdkLinkType = iota
1661 javaSdk
1662 javaSystem
1663 javaModule
1664 javaSystemServer
1665 javaPlatform
1666)
1667
1668func (lt sdkLinkType) String() string {
1669 switch lt {
1670 case javaCore:
1671 return "core Java API"
1672 case javaSdk:
1673 return "Android API"
1674 case javaSystem:
1675 return "system API"
1676 case javaModule:
1677 return "module API"
1678 case javaSystemServer:
1679 return "system server API"
1680 case javaPlatform:
1681 return "private API"
1682 default:
1683 panic(fmt.Errorf("unrecognized linktype: %d", lt))
1684 }
1685}
1686
1687// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
1688// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
1689// can't statically depend on modules that use Platform API.
1690func (lt sdkLinkType) rank() int {
1691 return int(lt)
1692}
1693
1694type moduleWithSdkDep interface {
1695 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09001696 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07001697}
1698
Jiyong Park92315372021-04-02 08:45:46 +09001699func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001700 switch name {
1701 case "core.current.stubs", "legacy.core.platform.api.stubs", "stable.core.platform.api.stubs",
1702 "stub-annotations", "private-stub-annotations-jar",
1703 "core-lambda-stubs", "core-generated-annotation-stubs":
1704 return javaCore, true
1705 case "android_stubs_current":
1706 return javaSdk, true
1707 case "android_system_stubs_current":
1708 return javaSystem, true
1709 case "android_module_lib_stubs_current":
1710 return javaModule, true
1711 case "android_system_server_stubs_current":
1712 return javaSystemServer, true
1713 case "android_test_stubs_current":
1714 return javaSystem, true
1715 }
1716
1717 if stub, linkType := moduleStubLinkType(name); stub {
1718 return linkType, true
1719 }
1720
Jiyong Park92315372021-04-02 08:45:46 +09001721 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09001722 switch ver.Kind {
1723 case android.SdkCore:
Jaewoong Jung26342642021-03-17 15:56:23 -07001724 return javaCore, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09001725 case android.SdkSystem:
Jaewoong Jung26342642021-03-17 15:56:23 -07001726 return javaSystem, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09001727 case android.SdkPublic:
Jaewoong Jung26342642021-03-17 15:56:23 -07001728 return javaSdk, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09001729 case android.SdkModule:
Jaewoong Jung26342642021-03-17 15:56:23 -07001730 return javaModule, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09001731 case android.SdkSystemServer:
Jaewoong Jung26342642021-03-17 15:56:23 -07001732 return javaSystemServer, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09001733 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
Jaewoong Jung26342642021-03-17 15:56:23 -07001734 return javaPlatform, false
1735 }
1736
Jiyong Parkf1691d22021-03-29 20:11:58 +09001737 if !ver.Valid() {
1738 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07001739 }
1740 return javaSdk, false
1741}
1742
1743// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
1744// this module's. See the comment on rank() for details and an example.
1745func (j *Module) checkSdkLinkType(
1746 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
1747 if ctx.Host() {
1748 return
1749 }
1750
Jiyong Park92315372021-04-02 08:45:46 +09001751 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07001752 if stubs {
1753 return
1754 }
Jiyong Park92315372021-04-02 08:45:46 +09001755 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07001756
1757 if myLinkType.rank() < depLinkType.rank() {
1758 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
1759 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
1760 "property of the source or target module so that target module is built "+
1761 "with the same or smaller API set when compared to the source.",
1762 myLinkType, ctx.OtherModuleName(dep), depLinkType)
1763 }
1764}
1765
1766func (j *Module) collectDeps(ctx android.ModuleContext) deps {
1767 var deps deps
1768
1769 if ctx.Device() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09001770 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001771 if sdkDep.invalidVersion {
1772 ctx.AddMissingDependencies(sdkDep.bootclasspath)
1773 ctx.AddMissingDependencies(sdkDep.java9Classpath)
1774 } else if sdkDep.useFiles {
1775 // sdkDep.jar is actually equivalent to turbine header.jar.
1776 deps.classpath = append(deps.classpath, sdkDep.jars...)
1777 deps.aidlPreprocess = sdkDep.aidl
1778 } else {
1779 deps.aidlPreprocess = sdkDep.aidl
1780 }
1781 }
1782
Jiyong Park92315372021-04-02 08:45:46 +09001783 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07001784
1785 ctx.VisitDirectDeps(func(module android.Module) {
1786 otherName := ctx.OtherModuleName(module)
1787 tag := ctx.OtherModuleDependencyTag(module)
1788
1789 if IsJniDepTag(tag) {
1790 // Handled by AndroidApp.collectAppDeps
1791 return
1792 }
1793 if tag == certificateTag {
1794 // Handled by AndroidApp.collectAppDeps
1795 return
1796 }
1797
1798 if dep, ok := module.(SdkLibraryDependency); ok {
1799 switch tag {
1800 case libTag:
Jiyong Park92315372021-04-02 08:45:46 +09001801 deps.classpath = append(deps.classpath, dep.SdkHeaderJars(ctx, j.SdkVersion(ctx))...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001802 case staticLibTag:
1803 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
1804 }
1805 } else if ctx.OtherModuleHasProvider(module, JavaInfoProvider) {
1806 dep := ctx.OtherModuleProvider(module, JavaInfoProvider).(JavaInfo)
1807 if sdkLinkType != javaPlatform &&
1808 ctx.OtherModuleHasProvider(module, SyspropPublicStubInfoProvider) {
1809 // dep is a sysprop implementation library, but this module is not linking against
1810 // the platform, so it gets the sysprop public stubs library instead. Replace
1811 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
1812 syspropDep := ctx.OtherModuleProvider(module, SyspropPublicStubInfoProvider).(SyspropPublicStubInfo)
1813 dep = syspropDep.JavaInfo
1814 }
1815 switch tag {
1816 case bootClasspathTag:
1817 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
1818 case libTag, instrumentationForTag:
1819 deps.classpath = append(deps.classpath, dep.HeaderJars...)
1820 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
1821 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
1822 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
1823 case java9LibTag:
1824 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
1825 case staticLibTag:
1826 deps.classpath = append(deps.classpath, dep.HeaderJars...)
1827 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
1828 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
1829 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
1830 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
1831 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
1832 // Turbine doesn't run annotation processors, so any module that uses an
1833 // annotation processor that generates API is incompatible with the turbine
1834 // optimization.
1835 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
1836 case pluginTag:
1837 if plugin, ok := module.(*Plugin); ok {
1838 if plugin.pluginProperties.Processor_class != nil {
1839 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
1840 } else {
1841 addPlugins(&deps, dep.ImplementationAndResourcesJars)
1842 }
1843 // Turbine doesn't run annotation processors, so any module that uses an
1844 // annotation processor that generates API is incompatible with the turbine
1845 // optimization.
1846 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
1847 } else {
1848 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
1849 }
1850 case errorpronePluginTag:
1851 if _, ok := module.(*Plugin); ok {
1852 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
1853 } else {
1854 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
1855 }
1856 case exportedPluginTag:
1857 if plugin, ok := module.(*Plugin); ok {
1858 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
1859 if plugin.pluginProperties.Processor_class != nil {
1860 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
1861 }
1862 // Turbine doesn't run annotation processors, so any module that uses an
1863 // annotation processor that generates API is incompatible with the turbine
1864 // optimization.
1865 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
1866 } else {
1867 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
1868 }
1869 case kotlinStdlibTag:
1870 deps.kotlinStdlib = append(deps.kotlinStdlib, dep.HeaderJars...)
1871 case kotlinAnnotationsTag:
1872 deps.kotlinAnnotations = dep.HeaderJars
Colin Crossa1ff7c62021-09-17 14:11:52 -07001873 case kotlinPluginTag:
1874 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001875 case syspropPublicStubDepTag:
1876 // This is a sysprop implementation library, forward the JavaInfoProvider from
1877 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
1878 ctx.SetProvider(SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
1879 JavaInfo: dep,
1880 })
1881 }
1882 } else if dep, ok := module.(android.SourceFileProducer); ok {
1883 switch tag {
1884 case libTag:
1885 checkProducesJars(ctx, dep)
1886 deps.classpath = append(deps.classpath, dep.Srcs()...)
1887 case staticLibTag:
1888 checkProducesJars(ctx, dep)
1889 deps.classpath = append(deps.classpath, dep.Srcs()...)
1890 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
1891 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
1892 }
1893 } else {
1894 switch tag {
1895 case bootClasspathTag:
1896 // If a system modules dependency has been added to the bootclasspath
1897 // then add its libs to the bootclasspath.
1898 sm := module.(SystemModulesProvider)
1899 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars()...)
1900
1901 case systemModulesTag:
1902 if deps.systemModules != nil {
1903 panic("Found two system module dependencies")
1904 }
1905 sm := module.(SystemModulesProvider)
1906 outputDir, outputDeps := sm.OutputDirAndDeps()
1907 deps.systemModules = &systemModules{outputDir, outputDeps}
1908 }
1909 }
1910
1911 addCLCFromDep(ctx, module, j.classLoaderContexts)
1912 })
1913
1914 return deps
1915}
1916
1917func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
1918 deps.processorPath = append(deps.processorPath, pluginJars...)
1919 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
1920}
1921
1922// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
1923// this interface.
1924type ProvidesUsesLib interface {
1925 ProvidesUsesLib() *string
1926}
1927
1928func (j *Module) ProvidesUsesLib() *string {
1929 return j.usesLibraryProperties.Provides_uses_lib
1930}
satayev1c564cc2021-05-25 19:50:30 +01001931
1932type ModuleWithStem interface {
1933 Stem() string
1934}
1935
1936var _ ModuleWithStem = (*Module)(nil)