blob: 056dbd5281480f4770f6e8b31aa0b93eacf8768a [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"
Joe Onorato349ae8d2024-02-05 22:46:00 +000020 "reflect"
21 "slices"
Jaewoong Jung26342642021-03-17 15:56:23 -070022 "strconv"
23 "strings"
24
Colin Crossd788b3e2023-11-28 13:14:56 -080025 "github.com/google/blueprint"
Jaewoong Jung26342642021-03-17 15:56:23 -070026 "github.com/google/blueprint/pathtools"
27 "github.com/google/blueprint/proptools"
28
29 "android/soong/android"
30 "android/soong/dexpreopt"
31 "android/soong/java/config"
32)
33
34// This file contains the definition and the implementation of the base module that most
35// source-based Java module structs embed.
36
37// TODO:
38// Autogenerated files:
39// Renderscript
40// Post-jar passes:
41// Proguard
42// Rmtypedefs
43// DroidDoc
44// Findbugs
45
46// Properties that are common to most Java modules, i.e. whether it's a host or device module.
47type CommonProperties struct {
48 // list of source files used to compile the Java module. May be .java, .kt, .logtags, .proto,
49 // or .aidl files.
50 Srcs []string `android:"path,arch_variant"`
51
52 // list Kotlin of source files containing Kotlin code that should be treated as common code in
53 // a codebase that supports Kotlin multiplatform. See
54 // https://kotlinlang.org/docs/reference/multiplatform.html. May be only be .kt files.
55 Common_srcs []string `android:"path,arch_variant"`
56
57 // list of source files that should not be used to build the Java module.
58 // This is most useful in the arch/multilib variants to remove non-common files
59 Exclude_srcs []string `android:"path,arch_variant"`
60
61 // list of directories containing Java resources
62 Java_resource_dirs []string `android:"arch_variant"`
63
64 // list of directories that should be excluded from java_resource_dirs
65 Exclude_java_resource_dirs []string `android:"arch_variant"`
66
67 // list of files to use as Java resources
68 Java_resources []string `android:"path,arch_variant"`
69
70 // list of files that should be excluded from java_resources and java_resource_dirs
71 Exclude_java_resources []string `android:"path,arch_variant"`
72
73 // list of module-specific flags that will be used for javac compiles
74 Javacflags []string `android:"arch_variant"`
75
76 // list of module-specific flags that will be used for kotlinc compiles
77 Kotlincflags []string `android:"arch_variant"`
78
79 // list of java libraries that will be in the classpath
80 Libs []string `android:"arch_variant"`
81
82 // list of java libraries that will be compiled into the resulting jar
83 Static_libs []string `android:"arch_variant"`
84
Jihoon Kang381c2fa2023-06-01 22:17:32 +000085 // list of java libraries that should not be used to build this module
86 Exclude_static_libs []string `android:"arch_variant"`
87
Jaewoong Jung26342642021-03-17 15:56:23 -070088 // manifest file to be included in resulting jar
89 Manifest *string `android:"path"`
90
91 // if not blank, run jarjar using the specified rules file
92 Jarjar_rules *string `android:"path,arch_variant"`
93
Joe Onorato349ae8d2024-02-05 22:46:00 +000094 // if not blank, used as prefix to generate repackage rule
95 Jarjar_prefix *string
96
Jaewoong Jung26342642021-03-17 15:56:23 -070097 // If not blank, set the java version passed to javac as -source and -target
98 Java_version *string
99
100 // If set to true, allow this module to be dexed and installed on devices. Has no
101 // effect on host modules, which are always considered installable.
102 Installable *bool
103
104 // If set to true, include sources used to compile the module in to the final jar
105 Include_srcs *bool
106
107 // If not empty, classes are restricted to the specified packages and their sub-packages.
108 // This restriction is checked after applying jarjar rules and including static libs.
109 Permitted_packages []string
110
111 // List of modules to use as annotation processors
112 Plugins []string
113
114 // List of modules to export to libraries that directly depend on this library as annotation
115 // processors. Note that if the plugins set generates_api: true this will disable the turbine
116 // optimization on modules that depend on this module, which will reduce parallelism and cause
117 // more recompilation.
118 Exported_plugins []string
119
120 // The number of Java source entries each Javac instance can process
121 Javac_shard_size *int64
122
123 // Add host jdk tools.jar to bootclasspath
124 Use_tools_jar *bool
125
126 Openjdk9 struct {
127 // List of source files that should only be used when passing -source 1.9 or higher
128 Srcs []string `android:"path"`
129
130 // List of javac flags that should only be used when passing -source 1.9 or higher
131 Javacflags []string
132 }
133
134 // When compiling language level 9+ .java code in packages that are part of
135 // a system module, patch_module names the module that your sources and
136 // dependencies should be patched into. The Android runtime currently
137 // doesn't implement the JEP 261 module system so this option is only
138 // supported at compile time. It should only be needed to compile tests in
139 // packages that exist in libcore and which are inconvenient to move
140 // elsewhere.
Liz Kammer0a470a32023-10-05 17:02:00 -0400141 Patch_module *string
Jaewoong Jung26342642021-03-17 15:56:23 -0700142
143 Jacoco struct {
144 // List of classes to include for instrumentation with jacoco to collect coverage
145 // information at runtime when building with coverage enabled. If unset defaults to all
146 // classes.
147 // Supports '*' as the last character of an entry in the list as a wildcard match.
148 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
149 // it matches classes in the package that have the class name as a prefix.
150 Include_filter []string
151
152 // List of classes to exclude from instrumentation with jacoco to collect coverage
153 // information at runtime when building with coverage enabled. Overrides classes selected
154 // by the include_filter property.
155 // Supports '*' as the last character of an entry in the list as a wildcard match.
156 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
157 // it matches classes in the package that have the class name as a prefix.
158 Exclude_filter []string
159 }
160
161 Errorprone struct {
162 // List of javac flags that should only be used when running errorprone.
163 Javacflags []string
164
165 // List of java_plugin modules that provide extra errorprone checks.
166 Extra_check_modules []string
Cole Faust75fffb12021-06-13 15:23:16 -0700167
Cole Faust2b1536e2021-06-18 12:25:54 -0700168 // This property can be in 3 states. When set to true, errorprone will
169 // be run during the regular build. When set to false, errorprone will
170 // never be run. When unset, errorprone will be run when the RUN_ERROR_PRONE
171 // environment variable is true. Setting this to false will improve build
172 // performance more than adding -XepDisableAllChecks in javacflags.
Cole Faust75fffb12021-06-13 15:23:16 -0700173 Enabled *bool
Jaewoong Jung26342642021-03-17 15:56:23 -0700174 }
175
176 Proto struct {
177 // List of extra options that will be passed to the proto generator.
178 Output_params []string
179 }
180
Sam Delmericoc7593722022-08-31 15:57:52 -0400181 // If true, then jacocoagent is automatically added as a libs dependency so that
182 // r8 will not strip instrumentation classes out of dexed libraries.
Jaewoong Jung26342642021-03-17 15:56:23 -0700183 Instrument bool `blueprint:"mutated"`
Paul Duffin0038a8d2022-05-03 00:28:40 +0000184 // If true, then the module supports statically including the jacocoagent
185 // into the library.
186 Supports_static_instrumentation bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700187
188 // List of files to include in the META-INF/services folder of the resulting jar.
189 Services []string `android:"path,arch_variant"`
190
191 // If true, package the kotlin stdlib into the jar. Defaults to true.
192 Static_kotlin_stdlib *bool `android:"arch_variant"`
193
194 // A list of java_library instances that provide additional hiddenapi annotations for the library.
195 Hiddenapi_additional_annotations []string
Joe Onorato175073c2023-06-01 14:42:59 -0700196
197 // Additional srcJars tacked in by GeneratedJavaLibraryModule
198 Generated_srcjars []android.Path `android:"mutated"`
Mark Whitea15790a2023-08-22 21:28:11 +0000199
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000200 // intermediate aconfig cache file tacked in by GeneratedJavaLibraryModule
201 Aconfig_Cache_files []android.Path `android:"mutated"`
202
Mark Whitea15790a2023-08-22 21:28:11 +0000203 // If true, then only the headers are built and not the implementation jar.
Liz Kammer60772632023-10-05 17:18:44 -0400204 Headers_only *bool
Cole Faust2b64af82023-12-13 18:22:18 -0800205
206 // A list of files or dependencies to make available to the build sandbox. This is
207 // useful if source files are symlinks, the targets of the symlinks must be listed here.
208 // Note that currently not all actions implemented by android_apps are sandboxed, so you
209 // may only see this being necessary in lint builds.
210 Compile_data []string `android:"path"`
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000211
212 // Property signifying whether the module compiles stubs or not.
213 // Should be set to true when srcs of this module are stub files.
214 // This property does not need to be set to true when the module depends on
215 // the stubs via libs, but should be set to true when the module depends on
216 // the stubs via static libs.
217 Is_stubs_module *bool
Jaewoong Jung26342642021-03-17 15:56:23 -0700218}
219
220// Properties that are specific to device modules. Host module factories should not add these when
221// constructing a new module.
222type DeviceProperties struct {
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000223 // If not blank, set to the version of the sdk to compile against.
Spandan Das1ccf5742022-10-14 16:51:23 +0000224 // Defaults to an empty string, which compiles the module against the private platform APIs.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000225 // Values are of one of the following forms:
Vinh Trana9c8f7d2022-04-14 20:18:47 +0000226 // 1) numerical API level, "current", "none", or "core_platform"
227 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
228 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
229 // If the SDK kind is empty, it will be set to public.
Jaewoong Jung26342642021-03-17 15:56:23 -0700230 Sdk_version *string
231
satayev0a420e72021-11-29 17:25:52 +0000232 // if not blank, set the maximum version of the sdk that the compiled artifacts will run against.
233 // Defaults to empty string "". See sdk_version for possible values.
234 Max_sdk_version *string
235
William Loh5a082f92022-05-17 20:21:50 +0000236 // if not blank, set the maxSdkVersion properties of permission and uses-permission tags.
237 // Defaults to empty string "". See sdk_version for possible values.
238 Replace_max_sdk_version_placeholder *string
239
Jaewoong Jung26342642021-03-17 15:56:23 -0700240 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000241 // Defaults to sdk_version if not set. See sdk_version for possible values.
Jaewoong Jung26342642021-03-17 15:56:23 -0700242 Target_sdk_version *string
243
244 // Whether to compile against the platform APIs instead of an SDK.
245 // If true, then sdk_version must be empty. The value of this field
Vinh Trand91939e2022-04-18 19:27:17 +0000246 // is ignored when module's type isn't android_app, android_test, or android_test_helper_app.
Jaewoong Jung26342642021-03-17 15:56:23 -0700247 Platform_apis *bool
248
249 Aidl struct {
250 // Top level directories to pass to aidl tool
251 Include_dirs []string
252
253 // Directories rooted at the Android.bp file to pass to aidl tool
254 Local_include_dirs []string
255
256 // directories that should be added as include directories for any aidl sources of modules
257 // that depend on this module, as well as to aidl for this module.
258 Export_include_dirs []string
259
260 // whether to generate traces (for systrace) for this interface
261 Generate_traces *bool
262
263 // whether to generate Binder#GetTransaction name method.
264 Generate_get_transaction_name *bool
265
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100266 // whether all interfaces should be annotated with required permissions.
267 Enforce_permissions *bool
268
269 // allowlist for interfaces that (temporarily) do not require annotation for permissions.
270 Enforce_permissions_exceptions []string `android:"path"`
271
Jaewoong Jung26342642021-03-17 15:56:23 -0700272 // list of flags that will be passed to the AIDL compiler
273 Flags []string
274 }
275
276 // If true, export a copy of the module as a -hostdex module for host testing.
277 Hostdex *bool
278
279 Target struct {
280 Hostdex struct {
281 // Additional required dependencies to add to -hostdex modules.
282 Required []string
283 }
284 }
285
286 // When targeting 1.9 and above, override the modules to use with --system,
287 // otherwise provides defaults libraries to add to the bootclasspath.
288 System_modules *string
289
Jaewoong Jung26342642021-03-17 15:56:23 -0700290 IsSDKLibrary bool `blueprint:"mutated"`
291
292 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
293 // Defaults to false.
294 V4_signature *bool
295
296 // Only for libraries created by a sysprop_library module, SyspropPublicStub is the name of the
297 // public stubs library.
298 SyspropPublicStub string `blueprint:"mutated"`
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000299
300 HiddenAPIPackageProperties
301 HiddenAPIFlagFileProperties
Jaewoong Jung26342642021-03-17 15:56:23 -0700302}
303
yangbill2af0b6e2024-03-15 09:29:29 +0000304// Properties that can be overridden by overriding module (e.g. override_android_app)
305type OverridableProperties struct {
Jooyung Han01d80d82022-01-08 12:16:32 +0900306 // set the name of the output. If not set, `name` is used.
307 // To override a module with this property set, overriding module might need to set this as well.
308 // Otherwise, both the overridden and the overriding modules will have the same output name, which
309 // can cause the duplicate output error.
310 Stem *string
Spandan Dasb9c58352024-05-13 18:29:45 +0000311
312 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
313 // Defaults to sdk_version if not set. See sdk_version for possible values.
314 Min_sdk_version *string
Jooyung Han01d80d82022-01-08 12:16:32 +0900315}
316
Jaewoong Jung26342642021-03-17 15:56:23 -0700317// Functionality common to Module and Import
318//
319// It is embedded in Module so its functionality can be used by methods in Module
320// but it is currently only initialized by Import and Library.
321type embeddableInModuleAndImport struct {
322
323 // Functionality related to this being used as a component of a java_sdk_library.
324 EmbeddableSdkLibraryComponent
325}
326
Paul Duffin71b33cc2021-06-23 11:39:47 +0100327func (e *embeddableInModuleAndImport) initModuleAndImport(module android.Module) {
328 e.initSdkLibraryComponent(module)
Jaewoong Jung26342642021-03-17 15:56:23 -0700329}
330
331// Module/Import's DepIsInSameApex(...) delegates to this method.
332//
333// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
334// the one provided by ApexModuleBase.
335func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
336 // dependencies other than the static linkage are all considered crossing APEX boundary
337 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
338 return true
339 }
340 return false
341}
342
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100343// OptionalDexJarPath can be either unset, hold a valid path to a dex jar file,
344// or an invalid path describing the reason it is invalid.
345//
346// It is unset if a dex jar isn't applicable, i.e. no build rule has been
347// requested to create one.
348//
349// If a dex jar has been requested to be built then it is set, and it may be
350// either a valid android.Path, or invalid with a reason message. The latter
351// happens if the source that should produce the dex file isn't able to.
352//
353// E.g. it is invalid with a reason message if there is a prebuilt APEX that
354// could produce the dex jar through a deapexer module, but the APEX isn't
355// installable so doing so wouldn't be safe.
356type OptionalDexJarPath struct {
357 isSet bool
358 path android.OptionalPath
359}
360
361// IsSet returns true if a path has been set, either invalid or valid.
362func (o OptionalDexJarPath) IsSet() bool {
363 return o.isSet
364}
365
366// Valid returns true if there is a path that is valid.
367func (o OptionalDexJarPath) Valid() bool {
368 return o.isSet && o.path.Valid()
369}
370
371// Path returns the valid path, or panics if it's either not set or is invalid.
372func (o OptionalDexJarPath) Path() android.Path {
373 if !o.isSet {
374 panic("path isn't set")
375 }
376 return o.path.Path()
377}
378
379// PathOrNil returns the path if it's set and valid, or else nil.
380func (o OptionalDexJarPath) PathOrNil() android.Path {
381 if o.Valid() {
382 return o.Path()
383 }
384 return nil
385}
386
387// InvalidReason returns the reason for an invalid path, which is never "". It
388// returns "" for an unset or valid path.
389func (o OptionalDexJarPath) InvalidReason() string {
390 if !o.isSet {
391 return ""
392 }
393 return o.path.InvalidReason()
394}
395
396func (o OptionalDexJarPath) String() string {
397 if !o.isSet {
398 return "<unset>"
399 }
400 return o.path.String()
401}
402
403// makeUnsetDexJarPath returns an unset OptionalDexJarPath.
404func makeUnsetDexJarPath() OptionalDexJarPath {
405 return OptionalDexJarPath{isSet: false}
406}
407
408// makeDexJarPathFromOptionalPath returns an OptionalDexJarPath that is set with
409// the given OptionalPath, which may be valid or invalid.
410func makeDexJarPathFromOptionalPath(path android.OptionalPath) OptionalDexJarPath {
411 return OptionalDexJarPath{isSet: true, path: path}
412}
413
414// makeDexJarPathFromPath returns an OptionalDexJarPath that is set with the
415// valid given path. It returns an unset OptionalDexJarPath if the given path is
416// nil.
417func makeDexJarPathFromPath(path android.Path) OptionalDexJarPath {
418 if path == nil {
419 return makeUnsetDexJarPath()
420 }
421 return makeDexJarPathFromOptionalPath(android.OptionalPathForPath(path))
422}
423
Jaewoong Jung26342642021-03-17 15:56:23 -0700424// Module contains the properties and members used by all java module types
425type Module struct {
426 android.ModuleBase
427 android.DefaultableModuleBase
428 android.ApexModuleBase
Jaewoong Jung26342642021-03-17 15:56:23 -0700429
430 // Functionality common to Module and Import.
431 embeddableInModuleAndImport
432
433 properties CommonProperties
434 protoProperties android.ProtoProperties
435 deviceProperties DeviceProperties
436
yangbill2af0b6e2024-03-15 09:29:29 +0000437 overridableProperties OverridableProperties
Ronald Braunsteincdc66f42024-04-12 11:23:19 -0700438 sourceProperties android.SourceProperties
Jooyung Han01d80d82022-01-08 12:16:32 +0900439
Jaewoong Jung26342642021-03-17 15:56:23 -0700440 // jar file containing header classes including static library dependencies, suitable for
441 // inserting into the bootclasspath/classpath of another compile
442 headerJarFile android.Path
443
Joe Onorato349ae8d2024-02-05 22:46:00 +0000444 repackagedHeaderJarFile android.Path
445
Jaewoong Jung26342642021-03-17 15:56:23 -0700446 // jar file containing implementation classes including static library dependencies but no
447 // resources
448 implementationJarFile android.Path
449
450 // jar file containing only resources including from static library dependencies
451 resourceJar android.Path
452
453 // args and dependencies to package source files into a srcjar
454 srcJarArgs []string
455 srcJarDeps android.Paths
456
Anton Hansson0e73f9e2023-09-20 13:39:57 +0000457 // the source files of this module and all its static dependencies
458 transitiveSrcFiles *android.DepSet[android.Path]
459
Jaewoong Jung26342642021-03-17 15:56:23 -0700460 // jar file containing implementation classes and resources including static library
461 // dependencies
462 implementationAndResourcesJar android.Path
463
464 // output file containing classes.dex and resources
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100465 dexJarFile OptionalDexJarPath
Jaewoong Jung26342642021-03-17 15:56:23 -0700466
467 // output file containing uninstrumented classes that will be instrumented by jacoco
468 jacocoReportClassesFile android.Path
469
470 // output file of the module, which may be a classes jar or a dex jar
471 outputFile android.Path
472 extraOutputFiles android.Paths
473
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100474 exportAidlIncludeDirs android.Paths
475 ignoredAidlPermissionList android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700476
477 logtagsSrcs android.Paths
478
479 // installed file for binary dependency
480 installFile android.Path
481
Colin Cross3108ce12021-11-10 14:38:50 -0800482 // installed file for hostdex copy
483 hostdexInstallFile android.InstallPath
484
Chaohui Wangdcbe33c2022-10-11 11:13:30 +0800485 // list of unique .java and .kt source files
486 uniqueSrcFiles android.Paths
487
488 // list of srcjars that was passed to javac
489 compiledSrcJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700490
491 // manifest file to use instead of properties.Manifest
492 overrideManifest android.OptionalPath
493
Jaewoong Jung26342642021-03-17 15:56:23 -0700494 // list of plugins that this java module is exporting
495 exportedPluginJars android.Paths
496
497 // list of plugins that this java module is exporting
498 exportedPluginClasses []string
499
500 // if true, the exported plugins generate API and require disabling turbine.
501 exportedDisableTurbine bool
502
503 // list of source files, collected from srcFiles with unique java and all kt files,
504 // will be used by android.IDEInfo struct
505 expandIDEInfoCompiledSrcs []string
506
507 // expanded Jarjar_rules
508 expandJarjarRules android.Path
509
Joe Onorato349ae8d2024-02-05 22:46:00 +0000510 // jarjar rule for inherited jarjar rules
511 repackageJarjarRules android.Path
512
Jaewoong Jung26342642021-03-17 15:56:23 -0700513 // Extra files generated by the module type to be added as java resources.
514 extraResources android.Paths
515
516 hiddenAPI
517 dexer
518 dexpreopter
519 usesLibrary
520 linter
521
522 // list of the xref extraction files
523 kytheFiles android.Paths
524
Jaewoong Jung26342642021-03-17 15:56:23 -0700525 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +0900526
527 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000528 minSdkVersion android.ApiLevel
Spandan Dasa26eda72023-03-02 00:56:06 +0000529 maxSdkVersion android.ApiLevel
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -0400530
531 sourceExtensions []string
Vadim Spivak3c496f02023-06-08 06:14:59 +0000532
533 annoSrcJars android.Paths
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000534
535 // output file name based on Stem property.
536 // This should be set in every ModuleWithStem's GenerateAndroidBuildActions
537 // or the module should override Stem().
538 stem string
Joe Onorato6fe59eb2023-07-16 13:20:33 -0700539
Joe Onorato349ae8d2024-02-05 22:46:00 +0000540 // Values that will be set in the JarJarProvider data for jarjar repackaging,
541 // and merged with our dependencies' rules.
542 jarjarRenameRules map[string]string
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000543
544 stubsLinkType StubsLinkType
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000545
546 // Paths to the aconfig intermediate cache files that are provided by the
547 // java_aconfig_library or java_library modules that are statically linked
548 // to this module. Does not contain cache files from all transitive dependencies.
549 aconfigCacheFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700550}
551
Jiyong Park92315372021-04-02 08:45:46 +0900552func (j *Module) CheckStableSdkVersion(ctx android.BaseModuleContext) error {
553 sdkVersion := j.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900554 if sdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700555 return nil
556 }
Jiyong Parkf1691d22021-03-29 20:11:58 +0900557 if sdkVersion.Kind == android.SdkCorePlatform {
Paul Duffin1ea7c9f2021-03-15 09:39:13 +0000558 if useLegacyCorePlatformApi(ctx, j.BaseModuleName()) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700559 return fmt.Errorf("non stable SDK %v - uses legacy core platform", sdkVersion)
560 } else {
561 // Treat stable core platform as stable.
562 return nil
563 }
564 } else {
565 return fmt.Errorf("non stable SDK %v", sdkVersion)
566 }
567}
568
569// checkSdkVersions enforces restrictions around SDK dependencies.
570func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
571 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900572 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900573 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700574 ctx.PropertyErrorf("sdk_version",
575 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
576 }
577 }
578 }
579
580 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
581 // See rank() for details.
582 ctx.VisitDirectDeps(func(module android.Module) {
583 tag := ctx.OtherModuleDependencyTag(module)
584 switch module.(type) {
585 // TODO(satayev): cover other types as well, e.g. imports
586 case *Library, *AndroidLibrary:
587 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400588 case bootClasspathTag, sdkLibTag, libTag, staticLibTag, java9LibTag:
Jaewoong Jung26342642021-03-17 15:56:23 -0700589 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
590 }
591 }
592 })
593}
594
595func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900596 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700597 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900598 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700599 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000600 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 -0700601 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000602 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 -0700603 }
604
605 }
606}
607
Mark Whitea15790a2023-08-22 21:28:11 +0000608func (j *Module) checkHeadersOnly(ctx android.ModuleContext) {
609 if _, ok := ctx.Module().(android.SdkContext); ok {
Liz Kammer60772632023-10-05 17:18:44 -0400610 headersOnly := proptools.Bool(j.properties.Headers_only)
Mark Whitea15790a2023-08-22 21:28:11 +0000611 installable := proptools.Bool(j.properties.Installable)
612
613 if headersOnly && installable {
614 ctx.PropertyErrorf("headers_only", "This module has conflicting settings. headers_only is true which, which means this module doesn't generate an implementation jar. However installable is set to true.")
615 }
616 }
617}
618
Jaewoong Jung26342642021-03-17 15:56:23 -0700619func (j *Module) addHostProperties() {
620 j.AddProperties(
621 &j.properties,
yangbill2af0b6e2024-03-15 09:29:29 +0000622 &j.overridableProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700623 &j.protoProperties,
624 &j.usesLibraryProperties,
625 )
626}
627
628func (j *Module) addHostAndDeviceProperties() {
629 j.addHostProperties()
630 j.AddProperties(
631 &j.deviceProperties,
632 &j.dexer.dexProperties,
633 &j.dexpreoptProperties,
634 &j.linter.properties,
635 )
636}
637
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000638// provideHiddenAPIPropertyInfo populates a HiddenAPIPropertyInfo from hidden API properties and
639// makes it available through the hiddenAPIPropertyInfoProvider.
640func (j *Module) provideHiddenAPIPropertyInfo(ctx android.ModuleContext) {
641 hiddenAPIInfo := newHiddenAPIPropertyInfo()
642
643 // Populate with flag file paths from the properties.
644 hiddenAPIInfo.extractFlagFilesFromProperties(ctx, &j.deviceProperties.HiddenAPIFlagFileProperties)
645
646 // Populate with package rules from the properties.
647 hiddenAPIInfo.extractPackageRulesFromProperties(&j.deviceProperties.HiddenAPIPackageProperties)
648
Colin Cross40213022023-12-13 15:19:49 -0800649 android.SetProvider(ctx, hiddenAPIPropertyInfoProvider, hiddenAPIInfo)
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000650}
651
Jaewoong Jung26342642021-03-17 15:56:23 -0700652func (j *Module) OutputFiles(tag string) (android.Paths, error) {
653 switch tag {
654 case "":
655 return append(android.Paths{j.outputFile}, j.extraOutputFiles...), nil
656 case android.DefaultDistTag:
657 return android.Paths{j.outputFile}, nil
658 case ".jar":
659 return android.Paths{j.implementationAndResourcesJar}, nil
Colin Crossab50dea2022-10-14 11:45:44 -0700660 case ".hjar":
661 return android.Paths{j.headerJarFile}, nil
Jaewoong Jung26342642021-03-17 15:56:23 -0700662 case ".proguard_map":
663 if j.dexer.proguardDictionary.Valid() {
664 return android.Paths{j.dexer.proguardDictionary.Path()}, nil
665 }
666 return nil, fmt.Errorf("%q was requested, but no output file was found.", tag)
Joe Onoratoffac9be2023-08-19 19:48:34 -0700667 case ".generated_srcjars":
668 return j.properties.Generated_srcjars, nil
Thiébaud Weksteend0544362023-09-29 10:26:43 +1000669 case ".lint":
670 if j.linter.outputs.xml != nil {
671 return android.Paths{j.linter.outputs.xml}, nil
672 }
673 return nil, fmt.Errorf("%q was requested, but no output file was found.", tag)
Jaewoong Jung26342642021-03-17 15:56:23 -0700674 default:
675 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
676 }
677}
678
679var _ android.OutputFileProducer = (*Module)(nil)
680
681func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
682 initJavaModule(module, hod, false)
683}
684
685func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
686 initJavaModule(module, hod, true)
687}
688
689func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
690 multilib := android.MultilibCommon
691 if multiTargets {
692 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
693 } else {
694 android.InitAndroidArchModule(module, hod, multilib)
695 }
696 android.InitDefaultableModule(module)
697}
698
699func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
700 return j.properties.Instrument &&
701 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
702 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
703}
704
705func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000706 return j.properties.Supports_static_instrumentation &&
707 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700708 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
709 ctx.Config().UnbundledBuild())
710}
711
712func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
713 // Force enable the instrumentation for java code that is built for APEXes ...
714 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
715 // doesn't make sense) or framework libraries (e.g. libraries found in the InstrumentFrameworkModules list) unless EMMA_INSTRUMENT_FRAMEWORK is true.
Colin Crossff694a82023-12-13 15:54:49 -0800716 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -0700717 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Jihoon Kang690df2e2024-05-22 04:27:38 +0000718
Jihoon Kang46d66de2024-05-22 22:42:39 +0000719 if j.DirectlyInAnyApex() && !isJacocoAgent && !apexInfo.IsForPlatform() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700720 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
721 return true
722 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
723 return true
724 }
725 }
726 return false
727}
728
Sam Delmerico1e3f78f2022-09-07 12:07:07 -0400729func (j *Module) setInstrument(value bool) {
730 j.properties.Instrument = value
731}
732
Jiyong Park92315372021-04-02 08:45:46 +0900733func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
734 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700735}
736
Jiyong Parkf1691d22021-03-29 20:11:58 +0900737func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700738 return proptools.String(j.deviceProperties.System_modules)
739}
740
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000741func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Spandan Dasb9c58352024-05-13 18:29:45 +0000742 if j.overridableProperties.Min_sdk_version != nil {
743 return android.ApiLevelFrom(ctx, *j.overridableProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700744 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000745 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700746}
747
Yu Liuf2b94012023-09-19 15:09:10 -0700748func (j *Module) GetDeviceProperties() *DeviceProperties {
749 return &j.deviceProperties
750}
751
Spandan Dasa26eda72023-03-02 00:56:06 +0000752func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
753 if j.deviceProperties.Max_sdk_version != nil {
754 return android.ApiLevelFrom(ctx, *j.deviceProperties.Max_sdk_version)
755 }
756 // Default is PrivateApiLevel
757 return android.SdkSpecPrivate.ApiLevel
satayev0a420e72021-11-29 17:25:52 +0000758}
759
Spandan Dasa26eda72023-03-02 00:56:06 +0000760func (j *Module) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
761 if j.deviceProperties.Replace_max_sdk_version_placeholder != nil {
762 return android.ApiLevelFrom(ctx, *j.deviceProperties.Replace_max_sdk_version_placeholder)
763 }
764 // Default is PrivateApiLevel
765 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000766}
767
Jiyong Parkf1691d22021-03-29 20:11:58 +0900768func (j *Module) MinSdkVersionString() string {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000769 return j.minSdkVersion.String()
Jiyong Park92315372021-04-02 08:45:46 +0900770}
771
Spandan Dasca70fc42023-03-01 23:38:49 +0000772func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jiyong Park92315372021-04-02 08:45:46 +0900773 if j.deviceProperties.Target_sdk_version != nil {
Spandan Dasca70fc42023-03-01 23:38:49 +0000774 return android.ApiLevelFrom(ctx, *j.deviceProperties.Target_sdk_version)
Jiyong Park92315372021-04-02 08:45:46 +0900775 }
Spandan Dasca70fc42023-03-01 23:38:49 +0000776 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700777}
778
779func (j *Module) AvailableFor(what string) bool {
780 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
781 // Exception: for hostdex: true libraries, the platform variant is created
782 // even if it's not marked as available to platform. In that case, the platform
783 // variant is used only for the hostdex and not installed to the device.
784 return true
785 }
786 return j.ApexModuleBase.AvailableFor(what)
787}
788
789func (j *Module) deps(ctx android.BottomUpMutatorContext) {
790 if ctx.Device() {
791 j.linter.deps(ctx)
792
Jiyong Parkf1691d22021-03-29 20:11:58 +0900793 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700794
795 if j.deviceProperties.SyspropPublicStub != "" {
796 // This is a sysprop implementation library that has a corresponding sysprop public
797 // stubs library, and a dependency on it so that dependencies on the implementation can
798 // be forwarded to the public stubs library when necessary.
799 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
800 }
801 }
802
803 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000804
805 j.properties.Static_libs = android.RemoveListFromList(j.properties.Static_libs, j.properties.Exclude_static_libs)
Jaewoong Jung26342642021-03-17 15:56:23 -0700806 ctx.AddVariationDependencies(nil, staticLibTag, j.properties.Static_libs...)
807
808 // Add dependency on libraries that provide additional hidden api annotations.
809 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
810
Kiyoung Kim9743bab2024-03-28 15:44:56 +0900811 if ctx.Config().EnforceInterPartitionJavaSdkLibrary() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700812 // Require java_sdk_library at inter-partition java dependency to ensure stable
813 // interface between partitions. If inter-partition java_library dependency is detected,
814 // raise build error because java_library doesn't have a stable interface.
815 //
816 // Inputs:
817 // PRODUCT_ENFORCE_INTER_PARTITION_JAVA_SDK_LIBRARY
818 // if true, enable enforcement
819 // PRODUCT_INTER_PARTITION_JAVA_LIBRARY_ALLOWLIST
820 // exception list of java_library names to allow inter-partition dependency
821 for idx := range j.properties.Libs {
822 if libDeps[idx] == nil {
823 continue
824 }
825
826 if javaDep, ok := libDeps[idx].(javaSdkLibraryEnforceContext); ok {
827 // java_sdk_library is always allowed at inter-partition dependency.
828 // So, skip check.
829 if _, ok := javaDep.(*SdkLibrary); ok {
830 continue
831 }
832
833 j.checkPartitionsForJavaDependency(ctx, "libs", javaDep)
834 }
835 }
836 }
837
838 // For library dependencies that are component libraries (like stubs), add the implementation
839 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
840 for _, dep := range libDeps {
841 if dep != nil {
842 if component, ok := dep.(SdkLibraryComponentDependency); ok {
843 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000844 // Add library as optional if it's one of the optional compatibility libs or it's
845 // explicitly listed in the optional_uses_libs property.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100846 tag := usesLibReqTag
Jiakai Zhangf98da192024-04-15 11:15:41 +0000847 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) ||
848 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs) {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100849 tag = usesLibOptTag
850 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100851 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700852 }
853 }
854 }
855 }
856
857 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
858 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
859 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
860
861 android.ProtoDeps(ctx, &j.protoProperties)
862 if j.hasSrcExt(".proto") {
863 protoDeps(ctx, &j.protoProperties)
864 }
865
866 if j.hasSrcExt(".kt") {
867 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
868 // Kotlin files
869 ctx.AddVariationDependencies(nil, kotlinStdlibTag,
870 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8")
Colin Cross06354472022-05-03 14:20:24 -0700871 ctx.AddVariationDependencies(nil, kotlinAnnotationsTag, "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700872 }
873
874 // Framework libraries need special handling in static coverage builds: they should not have
875 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
876 // the same jacoco classes coming from different bootclasspath jars.
877 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
878 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
879 j.properties.Instrument = true
880 }
881 } else if j.shouldInstrumentStatic(ctx) {
882 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
883 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700884
885 if j.useCompose() {
886 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
887 "androidx.compose.compiler_compiler-hosted")
888 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700889}
890
891func hasSrcExt(srcs []string, ext string) bool {
892 for _, src := range srcs {
893 if filepath.Ext(src) == ext {
894 return true
895 }
896 }
897
898 return false
899}
900
901func (j *Module) hasSrcExt(ext string) bool {
902 return hasSrcExt(j.properties.Srcs, ext)
903}
904
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100905func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
906 var flags string
907
908 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
909 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
910 flags = "-Wmissing-permission-annotation -Werror"
911 }
912 }
913 return flags
914}
915
Jaewoong Jung26342642021-03-17 15:56:23 -0700916func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000917 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700918
919 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
920 aidlIncludes = append(aidlIncludes,
921 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
922 aidlIncludes = append(aidlIncludes,
923 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
924
925 var flags []string
926 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000927 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700928
929 flags = append(flags, j.deviceProperties.Aidl.Flags...)
930
931 if aidlPreprocess.Valid() {
932 flags = append(flags, "-p"+aidlPreprocess.String())
933 deps = append(deps, aidlPreprocess.Path())
934 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000935 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700936 }
937
938 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000939 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700940 }
941
942 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000943 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700944 }
945
Sam Delmerico2351eac2022-05-24 17:10:02 +0000946 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -0700947 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000948 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -0700949 }
Sam Delmerico2351eac2022-05-24 17:10:02 +0000950 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
951 // add flags for dirs containing AIDL srcs that haven't been specified yet
952 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -0700953
Zim8774ae12022-08-17 11:46:34 +0100954 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +0000955 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +0100956 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700957 flags = append(flags, "-t")
958 }
959
960 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
961 flags = append(flags, "--transaction_names")
962 }
963
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100964 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
965 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
966 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
967 }
968
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000969 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +0900970 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
971
Jaewoong Jung26342642021-03-17 15:56:23 -0700972 return strings.Join(flags, " "), deps
973}
974
975func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
976
977 var flags javaBuilderFlags
978
979 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +0900980 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -0700981
Cole Faust2b1536e2021-06-18 12:25:54 -0700982 epEnabled := j.properties.Errorprone.Enabled
983 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +0100984 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700985 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
986 }
987
988 errorProneFlags := []string{
989 "-Xplugin:ErrorProne",
990 "${config.ErrorProneChecks}",
991 }
992 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
993
Colin Cross8bf6cad2022-02-28 13:07:03 -0800994 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -0700995 "'" + strings.Join(errorProneFlags, " ") + "'"
996 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
997 }
998
999 // classpath
1000 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1001 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001002 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001003 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1004 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1005 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1006
1007 flags.processors = append(flags.processors, deps.processorClasses...)
1008 flags.processors = android.FirstUniqueStrings(flags.processors)
1009
1010 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001011 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001012 // Give host-side tools a version of OpenJDK's standard libraries
1013 // close to what they're targeting. As of Dec 2017, AOSP is only
1014 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1015 //
1016 // When building with OpenJDK 8, the following should have no
1017 // effect since those jars would be available by default.
1018 //
1019 // When building with OpenJDK 9 but targeting a version < 1.8,
1020 // putting them on the bootclasspath means that:
1021 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1022 // b) references to existing APIs are not reinterpreted in an
1023 // OpenJDK 9-specific way, eg. calls to subclasses of
1024 // java.nio.Buffer as in http://b/70862583
1025 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1026 flags.bootClasspath = append(flags.bootClasspath,
1027 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1028 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1029 if Bool(j.properties.Use_tools_jar) {
1030 flags.bootClasspath = append(flags.bootClasspath,
1031 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1032 }
1033 }
1034
1035 // systemModules
1036 flags.systemModules = deps.systemModules
1037
Jaewoong Jung26342642021-03-17 15:56:23 -07001038 return flags
1039}
1040
1041func (j *Module) collectJavacFlags(
1042 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1043 // javac flags.
1044 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001045 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001046
Mythri Alle4b9f6182023-10-25 15:17:11 +00001047 needsDebugInfo = false
1048 for _, flag := range javacFlags {
1049 if strings.HasPrefix(flag, "-g") {
1050 needsDebugInfo = true
1051 }
1052 }
1053
1054 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001055 // For non-host binaries, override the -g flag passed globally to remove
1056 // local variable debug info to reduce disk and memory usage.
1057 javacFlags = append(javacFlags, "-g:source,lines")
1058 }
1059 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1060
1061 if flags.javaVersion.usesJavaModules() {
1062 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001063 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1064 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1065 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1066 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001067
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001068 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001069 if j.properties.Patch_module != nil {
1070 // Manually specify build directory in case it is not under the repo root.
1071 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1072 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001073 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001074
Jaewoong Jung26342642021-03-17 15:56:23 -07001075 classPath := flags.classpath.FormJavaClassPath("")
1076 if classPath != "" {
1077 patchPaths = append(patchPaths, classPath)
1078 }
1079 javacFlags = append(
1080 javacFlags,
1081 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1082 }
1083 }
1084
1085 if len(javacFlags) > 0 {
1086 // optimization.
1087 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1088 flags.javacFlags = "$javacFlags"
1089 }
1090
1091 return flags
1092}
1093
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001094func (j *Module) AddJSONData(d *map[string]interface{}) {
1095 (&j.ModuleBase).AddJSONData(d)
1096 (*d)["Java"] = map[string]interface{}{
1097 "SourceExtensions": j.sourceExtensions,
1098 }
1099
1100}
1101
usta0391ca42023-09-19 15:51:59 -04001102func (j *Module) addGeneratedSrcJars(path android.Path) {
1103 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001104}
1105
Colin Cross4eae06d2023-06-20 22:40:02 -07001106func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars android.Paths) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001107
1108 // Auto-propagating jarjar rules
1109 jarjarProviderData := j.collectJarJarRules(ctx)
1110 if jarjarProviderData != nil {
1111 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wangddb2ee52024-04-02 16:44:02 +00001112 text := getJarJarRuleText(jarjarProviderData)
1113 if text != "" {
1114 ruleTextFile := android.PathForModuleOut(ctx, "repackaged-jarjar", "repackaging.txt")
1115 android.WriteFileRule(ctx, ruleTextFile, text)
1116 j.repackageJarjarRules = ruleTextFile
Joe Onorato349ae8d2024-02-05 22:46:00 +00001117 }
1118 }
1119
Jaewoong Jung26342642021-03-17 15:56:23 -07001120 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1121
1122 deps := j.collectDeps(ctx)
1123 flags := j.collectBuilderFlags(ctx, deps)
1124
1125 if flags.javaVersion.usesJavaModules() {
1126 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001127 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1128 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1129 ctx.PropertyErrorf("openjdk9.srcs", "JDK version defaults to higher than 9")
Jaewoong Jung26342642021-03-17 15:56:23 -07001130 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001131
Jaewoong Jung26342642021-03-17 15:56:23 -07001132 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001133 j.sourceExtensions = []string{}
1134 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1135 if hasSrcExt(srcFiles.Strings(), ext) {
1136 j.sourceExtensions = append(j.sourceExtensions, ext)
1137 }
1138 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001139 if hasSrcExt(srcFiles.Strings(), ".proto") {
1140 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1141 }
1142
1143 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, nil)
1144 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1145 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1146 }
1147
Sam Delmerico2351eac2022-05-24 17:10:02 +00001148 aidlSrcs := srcFiles.FilterByExt(".aidl")
1149 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs, aidlSrcs)
1150
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001151 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001152 srcFiles = j.genSources(ctx, srcFiles, flags)
1153
1154 // Collect javac flags only after computing the full set of srcFiles to
1155 // ensure that the --patch-module lookup paths are complete.
1156 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1157
1158 srcJars := srcFiles.FilterByExt(".srcjar")
1159 srcJars = append(srcJars, deps.srcJars...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001160 srcJars = append(srcJars, extraSrcJars...)
Joe Onorato175073c2023-06-01 14:42:59 -07001161 srcJars = append(srcJars, j.properties.Generated_srcjars...)
Colin Crossb0ef30a2021-06-29 10:42:00 -07001162 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001163
1164 if j.properties.Jarjar_rules != nil {
1165 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1166 }
1167
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00001168 jarName := j.Stem() + ".jar"
Jaewoong Jung26342642021-03-17 15:56:23 -07001169
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001170 var uniqueJavaFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001171 set := make(map[string]bool)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001172 for _, v := range srcFiles.FilterByExt(".java") {
Jaewoong Jung26342642021-03-17 15:56:23 -07001173 if _, found := set[v.String()]; !found {
1174 set[v.String()] = true
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001175 uniqueJavaFiles = append(uniqueJavaFiles, v)
Jaewoong Jung26342642021-03-17 15:56:23 -07001176 }
1177 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001178 var uniqueKtFiles android.Paths
1179 for _, v := range srcFiles.FilterByExt(".kt") {
1180 if _, found := set[v.String()]; !found {
1181 set[v.String()] = true
1182 uniqueKtFiles = append(uniqueKtFiles, v)
1183 }
1184 }
1185
1186 var uniqueSrcFiles android.Paths
1187 uniqueSrcFiles = append(uniqueSrcFiles, uniqueJavaFiles...)
1188 uniqueSrcFiles = append(uniqueSrcFiles, uniqueKtFiles...)
1189 j.uniqueSrcFiles = uniqueSrcFiles
Colin Cross40213022023-12-13 15:19:49 -08001190 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: uniqueSrcFiles.Strings()})
Jaewoong Jung26342642021-03-17 15:56:23 -07001191
Colin Crossb5db4012022-03-28 17:12:39 -07001192 // We don't currently run annotation processors in turbine, which means we can't use turbine
1193 // generated header jars when an annotation processor that generates API is enabled. One
1194 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1195 // is used to run all of the annotation processors.
1196 disableTurbine := deps.disableTurbine
1197
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001198 // Collect .java and .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001199 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1200
1201 var kotlinJars android.Paths
Colin Cross220a9a12022-03-28 17:08:01 -07001202 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001203
Colin Cross4eae06d2023-06-20 22:40:02 -07001204 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1205 // any dependencies so that it can override any non-final R classes from dependencies with the
1206 // final R classes from the app.
1207 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1208
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001209 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1210
Mark Whitea15790a2023-08-22 21:28:11 +00001211 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001212 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001213 if srcFiles.HasExt(".kt") {
1214 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1215 }
1216 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1217 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1218 }
1219
Joe Onorato349ae8d2024-02-05 22:46:00 +00001220 _, j.headerJarFile, _ =
Mark Whitea15790a2023-08-22 21:28:11 +00001221 j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
1222 extraCombinedJars)
1223 if ctx.Failed() {
1224 return
1225 }
1226
Colin Cross40213022023-12-13 15:19:49 -08001227 android.SetProvider(ctx, JavaInfoProvider, JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001228 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1229 TransitiveLibsHeaderJars: j.transitiveLibsHeaderJars,
1230 TransitiveStaticLibsHeaderJars: j.transitiveStaticLibsHeaderJars,
1231 AidlIncludeDirs: j.exportAidlIncludeDirs,
1232 ExportedPlugins: j.exportedPluginJars,
1233 ExportedPluginClasses: j.exportedPluginClasses,
1234 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1235 StubsLinkType: j.stubsLinkType,
1236 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Mark Whitea15790a2023-08-22 21:28:11 +00001237 })
1238
1239 j.outputFile = j.headerJarFile
1240 return
1241 }
1242
Jaewoong Jung26342642021-03-17 15:56:23 -07001243 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001244 // When using kotlin sources turbine is used to generate annotation processor sources,
1245 // including for annotation processors that generate API, so we can use turbine for
1246 // java sources too.
1247 disableTurbine = false
1248
Jaewoong Jung26342642021-03-17 15:56:23 -07001249 // user defined kotlin flags.
1250 kotlincFlags := j.properties.Kotlincflags
1251 CheckKotlincFlags(ctx, kotlincFlags)
1252
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001253 // Workaround for KT-46512
1254 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001255
1256 // If there are kotlin files, compile them first but pass all the kotlin and java files
1257 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1258 // won't emit any classes for them.
1259 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1260 if ctx.Device() {
1261 kotlincFlags = append(kotlincFlags, "-no-jdk")
1262 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001263
1264 for _, plugin := range deps.kotlinPlugins {
1265 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1266 }
1267 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1268
Jaewoong Jung26342642021-03-17 15:56:23 -07001269 if len(kotlincFlags) > 0 {
1270 // optimization.
1271 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1272 flags.kotlincFlags += "$kotlincFlags"
1273 }
1274
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001275 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001276 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1277
1278 flags.classpath = append(flags.classpath, deps.kotlinStdlib...)
1279 flags.classpath = append(flags.classpath, deps.kotlinAnnotations...)
1280
1281 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1282 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1283
Isaac Chioua23d9942022-04-06 06:14:38 +00001284 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001285 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001286 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1287 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001288 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001289 srcJars = append(srcJars, kaptSrcJar)
1290 kotlinJars = append(kotlinJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001291 // Disable annotation processing in javac, it's already been handled by kapt
1292 flags.processorPath = nil
1293 flags.processors = nil
1294 }
1295
1296 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001297 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001298 kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001299 if ctx.Failed() {
1300 return
1301 }
1302
Zi Wangddb2ee52024-04-02 16:44:02 +00001303 kotlinJarPath := j.repackageFlagsIfNecessary(ctx, kotlinJar.OutputPath, jarName, "kotlinc")
1304
Isaac Chioua23d9942022-04-06 06:14:38 +00001305 // Make javac rule depend on the kotlinc rule
1306 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1307
Zi Wangddb2ee52024-04-02 16:44:02 +00001308 kotlinJars = append(kotlinJars, kotlinJarPath)
Colin Cross220a9a12022-03-28 17:08:01 -07001309 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
1310
Jaewoong Jung26342642021-03-17 15:56:23 -07001311 // Jar kotlin classes into the final jar after javac
1312 if BoolDefault(j.properties.Static_kotlin_stdlib, true) {
1313 kotlinJars = append(kotlinJars, deps.kotlinStdlib...)
Colin Cross06354472022-05-03 14:20:24 -07001314 kotlinJars = append(kotlinJars, deps.kotlinAnnotations...)
Colin Cross220a9a12022-03-28 17:08:01 -07001315 kotlinHeaderJars = append(kotlinHeaderJars, deps.kotlinStdlib...)
Colin Cross06354472022-05-03 14:20:24 -07001316 kotlinHeaderJars = append(kotlinHeaderJars, deps.kotlinAnnotations...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001317 } else {
1318 flags.dexClasspath = append(flags.dexClasspath, deps.kotlinStdlib...)
Colin Cross06354472022-05-03 14:20:24 -07001319 flags.dexClasspath = append(flags.dexClasspath, deps.kotlinAnnotations...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001320 }
1321 }
1322
Colin Crossfd620b22024-02-23 10:05:21 -08001323 jars := slices.Clone(kotlinJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001324
Jaewoong Jung26342642021-03-17 15:56:23 -07001325 j.compiledSrcJars = srcJars
1326
1327 enableSharding := false
Colin Cross3d56ed52021-11-18 22:23:12 -08001328 var headerJarFileWithoutDepsOrJarjar android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001329 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001330 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1331 enableSharding = true
1332 // Formerly, there was a check here that prevented annotation processors
1333 // from being used when sharding was enabled, as some annotation processors
1334 // do not function correctly in sharded environments. It was removed to
1335 // allow for the use of annotation processors that do function correctly
1336 // with sharding enabled. See: b/77284273.
1337 }
Colin Crossfd620b22024-02-23 10:05:21 -08001338 extraJars := append(slices.Clone(kotlinHeaderJars), extraCombinedJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00001339 headerJarFileWithoutDepsOrJarjar, j.headerJarFile, j.repackagedHeaderJarFile =
Colin Cross4eae06d2023-06-20 22:40:02 -07001340 j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001341 if ctx.Failed() {
1342 return
1343 }
1344 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001345 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001346 hasErrorproneableFiles := false
1347 for _, ext := range j.sourceExtensions {
1348 if ext != ".proto" && ext != ".aidl" {
1349 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1350 // compile, and it's not useful to have warnings on these generated sources.
1351 hasErrorproneableFiles = true
1352 break
1353 }
1354 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001355 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001356 if Bool(j.properties.Errorprone.Enabled) {
1357 // If error-prone is enabled, enable errorprone flags on the regular
1358 // build.
1359 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001360 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faust75fffb12021-06-13 15:23:16 -07001361 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1362 // a new jar file just for compiling with the errorprone compiler to.
1363 // This is because we don't want to cause the java files to get completely
1364 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1365 // We also don't want to run this if errorprone is enabled by default for
1366 // this module, or else we could have duplicated errorprone messages.
1367 errorproneFlags := enableErrorproneFlags(flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001368 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001369 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001370
Vadim Spivak3c496f02023-06-08 06:14:59 +00001371 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
Cole Faust75fffb12021-06-13 15:23:16 -07001372 "errorprone", "errorprone")
1373
Jaewoong Jung26342642021-03-17 15:56:23 -07001374 extraJarDeps = append(extraJarDeps, errorprone)
1375 }
1376
1377 if enableSharding {
Colin Cross3d56ed52021-11-18 22:23:12 -08001378 if headerJarFileWithoutDepsOrJarjar != nil {
1379 flags.classpath = append(classpath{headerJarFileWithoutDepsOrJarjar}, flags.classpath...)
1380 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001381 shardSize := int(*(j.properties.Javac_shard_size))
1382 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001383 if len(uniqueJavaFiles) > 0 {
1384 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001385 for idx, shardSrc := range shardSrcs {
1386 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1387 nil, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001388 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
Jaewoong Jung26342642021-03-17 15:56:23 -07001389 jars = append(jars, classes)
1390 }
1391 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001392 // Assume approximately 5 sources per srcjar.
1393 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1394 // of 5.8 sources per srcjar, but a median of 1, a standard deviation of 10, and a max of 48 source files.
Jaewoong Jung26342642021-03-17 15:56:23 -07001395 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001396 startIdx := len(shardSrcs)
1397 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1398 for idx, shardSrcJars := range shardSrcJarsList {
1399 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1400 nil, shardSrcJars, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001401 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
Colin Crossa052ddb2023-09-25 21:46:58 -07001402 jars = append(jars, classes)
1403 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001404 }
1405 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001406 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001407 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
Jaewoong Jung26342642021-03-17 15:56:23 -07001408 jars = append(jars, classes)
1409 }
1410 if ctx.Failed() {
1411 return
1412 }
1413 }
1414
Colin Crossfd620b22024-02-23 10:05:21 -08001415 jars = append(jars, extraCombinedJars...)
1416
Jaewoong Jung26342642021-03-17 15:56:23 -07001417 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1418
1419 var includeSrcJar android.WritablePath
1420 if Bool(j.properties.Include_srcs) {
1421 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1422 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1423 }
1424
1425 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1426 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
1427 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
1428 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1429
1430 var resArgs []string
1431 var resDeps android.Paths
1432
1433 resArgs = append(resArgs, dirArgs...)
1434 resDeps = append(resDeps, dirDeps...)
1435
1436 resArgs = append(resArgs, fileArgs...)
1437 resDeps = append(resDeps, fileDeps...)
1438
1439 resArgs = append(resArgs, extraArgs...)
1440 resDeps = append(resDeps, extraDeps...)
1441
1442 if len(resArgs) > 0 {
1443 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1444 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
1445 j.resourceJar = resourceJar
1446 if ctx.Failed() {
1447 return
1448 }
1449 }
1450
1451 var resourceJars android.Paths
1452 if j.resourceJar != nil {
1453 resourceJars = append(resourceJars, j.resourceJar)
1454 }
1455 if Bool(j.properties.Include_srcs) {
1456 resourceJars = append(resourceJars, includeSrcJar)
1457 }
1458 resourceJars = append(resourceJars, deps.staticResourceJars...)
1459
1460 if len(resourceJars) > 1 {
1461 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1462 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1463 false, nil, nil)
1464 j.resourceJar = combinedJar
1465 } else if len(resourceJars) == 1 {
1466 j.resourceJar = resourceJars[0]
1467 }
1468
1469 if len(deps.staticJars) > 0 {
1470 jars = append(jars, deps.staticJars...)
1471 }
1472
1473 manifest := j.overrideManifest
1474 if !manifest.Valid() && j.properties.Manifest != nil {
1475 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
1476 }
1477
1478 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1479 if len(services) > 0 {
1480 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1481 var zipargs []string
1482 for _, file := range services {
1483 serviceFile := file.String()
1484 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1485 }
1486 rule := zip
1487 args := map[string]string{
1488 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1489 }
1490 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1491 rule = zipRE
1492 args["implicits"] = strings.Join(services.Strings(), ",")
1493 }
1494 ctx.Build(pctx, android.BuildParams{
1495 Rule: rule,
1496 Output: servicesJar,
1497 Implicits: services,
1498 Args: args,
1499 })
1500 jars = append(jars, servicesJar)
1501 }
1502
1503 // Combine the classes built from sources, any manifests, and any static libraries into
1504 // classes.jar. If there is only one input jar this step will be skipped.
1505 var outputFile android.OutputPath
1506
1507 if len(jars) == 1 && !manifest.Valid() {
1508 // Optimization: skip the combine step as there is nothing to do
1509 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1510 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1511 // any if len(jars) == 1.
1512
Jihoon Kang1147b312023-06-08 23:25:57 +00001513 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1514 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1515 // either with .from-source or .from-text suffix.
1516 // outputFile should be agnostic to the build configuration,
1517 // thus "combine" the single static lib in order to prevent the static lib from being exposed
1518 // to the copy rules.
1519 stub, _ := moduleStubLinkType(ctx.ModuleName())
1520
Jaewoong Jung26342642021-03-17 15:56:23 -07001521 // Transform the single path to the jar into an OutputPath as that is required by the following
1522 // code.
Jihoon Kang1147b312023-06-08 23:25:57 +00001523 if moduleOutPath, ok := jars[0].(android.ModuleOutPath); ok && !stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07001524 // The path contains an embedded OutputPath so reuse that.
1525 outputFile = moduleOutPath.OutputPath
Jihoon Kang1147b312023-06-08 23:25:57 +00001526 } else if outputPath, ok := jars[0].(android.OutputPath); ok && !stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07001527 // The path is an OutputPath so reuse it directly.
1528 outputFile = outputPath
1529 } else {
1530 // The file is not in the out directory so create an OutputPath into which it can be copied
1531 // and which the following code can use to refer to it.
1532 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1533 ctx.Build(pctx, android.BuildParams{
1534 Rule: android.Cp,
1535 Input: jars[0],
1536 Output: combinedJar,
1537 })
1538 outputFile = combinedJar.OutputPath
1539 }
1540 } else {
1541 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1542 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1543 false, nil, nil)
1544 outputFile = combinedJar.OutputPath
1545 }
1546
1547 // jarjar implementation jar if necessary
1548 if j.expandJarjarRules != nil {
1549 // Transform classes.jar into classes-jarjar.jar
1550 jarjarFile := android.PathForModuleOut(ctx, "jarjar", jarName).OutputPath
1551 TransformJarJar(ctx, jarjarFile, outputFile, j.expandJarjarRules)
1552 outputFile = jarjarFile
1553
1554 // jarjar resource jar if necessary
1555 if j.resourceJar != nil {
1556 resourceJarJarFile := android.PathForModuleOut(ctx, "res-jarjar", jarName)
1557 TransformJarJar(ctx, resourceJarJarFile, j.resourceJar, j.expandJarjarRules)
1558 j.resourceJar = resourceJarJarFile
1559 }
1560
1561 if ctx.Failed() {
1562 return
1563 }
1564 }
1565
1566 // Check package restrictions if necessary.
1567 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001568 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001569 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001570
1571 // Create a rule to copy the output jar to another path and add a validate dependency that
1572 // will check that the jar only contains the permitted packages. The new location will become
1573 // the output file of this module.
1574 inputFile := outputFile
1575 outputFile = android.PathForModuleOut(ctx, "package-check", jarName).OutputPath
1576 ctx.Build(pctx, android.BuildParams{
1577 Rule: android.Cp,
1578 Input: inputFile,
1579 Output: outputFile,
1580 // Make sure that any dependency on the output file will cause ninja to run the package check
1581 // rule.
1582 Validation: pkgckFile,
1583 })
1584
1585 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001586 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001587
1588 if ctx.Failed() {
1589 return
1590 }
1591 }
1592
1593 j.implementationJarFile = outputFile
1594 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001595 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1596 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1597 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1598 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1599 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1600 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1601 j.headerJarFile = headerJarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001602 }
1603
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001604 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1605 specs := j.jacocoModuleToZipCommand(ctx)
1606 if ctx.Failed() {
1607 return
1608 }
1609
Jaewoong Jung26342642021-03-17 15:56:23 -07001610 if j.shouldInstrument(ctx) {
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001611 outputFile = j.instrument(ctx, flags, outputFile, jarName, specs)
Jaewoong Jung26342642021-03-17 15:56:23 -07001612 }
1613
1614 // merge implementation jar with resources if necessary
1615 implementationAndResourcesJar := outputFile
1616 if j.resourceJar != nil {
1617 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
1618 combinedJar := android.PathForModuleOut(ctx, "withres", jarName).OutputPath
1619 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
1620 false, nil, nil)
1621 implementationAndResourcesJar = combinedJar
1622 }
1623
1624 j.implementationAndResourcesJar = implementationAndResourcesJar
1625
1626 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001627 compileDex := j.dexProperties.Compile_dex
Colin Crossff694a82023-12-13 15:54:49 -08001628 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -07001629 if j.DirectlyInAnyApex() && !apexInfo.IsForPlatform() {
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001630 if compileDex == nil {
1631 compileDex = proptools.BoolPtr(true)
Jaewoong Jung26342642021-03-17 15:56:23 -07001632 }
1633 if j.deviceProperties.Hostdex == nil {
1634 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1635 }
1636 }
1637
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001638 if ctx.Device() && (Bool(j.properties.Installable) || Bool(compileDex)) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001639 if j.hasCode(ctx) {
1640 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001641 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001642 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1643 }
1644 // Dex compilation
1645 var dexOutputFile android.OutputPath
Spandan Dasc404cc72023-02-23 18:05:05 +00001646 params := &compileDexParams{
1647 flags: flags,
1648 sdkVersion: j.SdkVersion(ctx),
1649 minSdkVersion: j.MinSdkVersion(ctx),
1650 classesJar: implementationAndResourcesJar,
1651 jarName: jarName,
1652 }
Spandan Das3dbda182024-05-20 22:23:10 +00001653 if j.EnableProfileRewriting() {
1654 profile := j.GetProfile()
1655 if profile == "" || !j.GetProfileGuided() {
1656 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1657 }
1658 params.artProfileInput = &profile
1659 }
1660 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001661 if ctx.Failed() {
1662 return
1663 }
1664
Spandan Das3dbda182024-05-20 22:23:10 +00001665 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1666 if dexArtProfileOutput != nil {
1667 j.dexpreopter.SetRewrittenProfile(*dexArtProfileOutput)
1668 }
1669
Jaewoong Jung26342642021-03-17 15:56:23 -07001670 // merge dex jar with resources if necessary
1671 if j.resourceJar != nil {
1672 jars := android.Paths{dexOutputFile, j.resourceJar}
1673 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName).OutputPath
1674 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1675 false, nil, nil)
1676 if *j.dexProperties.Uncompress_dex {
1677 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName).OutputPath
Cole Faust51d7bfd2023-09-07 05:31:32 +00001678 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001679 dexOutputFile = combinedAlignedJar
1680 } else {
1681 dexOutputFile = combinedJar
1682 }
1683 }
1684
Paul Duffin4de94502021-05-16 05:21:16 +01001685 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001686
1687 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001688
1689 // Encode hidden API flags in dex file, if needed.
1690 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1691
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001692 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001693
1694 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001695 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1696 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1697 libName = strings.TrimSuffix(libName, ".impl")
1698 }
1699 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001700
1701 outputFile = dexOutputFile
1702 } else {
1703 // There is no code to compile into a dex jar, make sure the resources are propagated
1704 // to the APK if this is an app.
1705 outputFile = implementationAndResourcesJar
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001706 j.dexJarFile = makeDexJarPathFromPath(j.resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001707 }
1708
1709 if ctx.Failed() {
1710 return
1711 }
1712 } else {
1713 outputFile = implementationAndResourcesJar
1714 }
1715
1716 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001717 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001718 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001719 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001720 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001721 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001722 }
1723 }
1724
1725 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001726 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1727 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001728 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1729 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001730 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001731 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001732 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001733 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001734 j.linter.javaLanguageLevel = flags.javaVersion.String()
1735 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001736 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001737 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1738 j.linter.buildModuleReportZip = true
1739 }
1740 j.linter.lint(ctx)
1741 }
1742
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001743 j.collectTransitiveSrcFiles(ctx, srcFiles)
1744
Jaewoong Jung26342642021-03-17 15:56:23 -07001745 ctx.CheckbuildFile(outputFile)
1746
Colin Cross40213022023-12-13 15:19:49 -08001747 android.SetProvider(ctx, JavaInfoProvider, JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001748 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1749 RepackagedHeaderJars: android.PathsIfNonNil(j.repackagedHeaderJarFile),
1750 TransitiveLibsHeaderJars: j.transitiveLibsHeaderJars,
1751 TransitiveStaticLibsHeaderJars: j.transitiveStaticLibsHeaderJars,
1752 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1753 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
1754 ResourceJars: android.PathsIfNonNil(j.resourceJar),
1755 AidlIncludeDirs: j.exportAidlIncludeDirs,
1756 SrcJarArgs: j.srcJarArgs,
1757 SrcJarDeps: j.srcJarDeps,
1758 TransitiveSrcFiles: j.transitiveSrcFiles,
1759 ExportedPlugins: j.exportedPluginJars,
1760 ExportedPluginClasses: j.exportedPluginClasses,
1761 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1762 JacocoReportClassesFile: j.jacocoReportClassesFile,
1763 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001764 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001765 })
1766
1767 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1768 j.outputFile = outputFile.WithoutRel()
1769}
1770
Colin Crossa1ff7c62021-09-17 14:11:52 -07001771func (j *Module) useCompose() bool {
1772 return android.InList("androidx.compose.runtime_runtime", j.properties.Static_libs)
1773}
1774
Colin Crosscde55342024-03-27 14:11:51 -07001775func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []*android.DepSet[android.Path]) {
Sam Delmerico95d70942023-08-02 18:00:35 -04001776 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -08001777 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001778 depTag := ctx.OtherModuleDependencyTag(m)
1779
1780 if depProguardInfo.UnconditionallyExportedProguardFlags != nil {
1781 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1782 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1783 }
1784
1785 if depTag == staticLibTag && depProguardInfo.ProguardFlagsFiles != nil {
1786 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
1787 }
1788 })
1789
Colin Crosscde55342024-03-27 14:11:51 -07001790 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
1791}
1792
1793func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
1794 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
1795
Sam Delmerico95d70942023-08-02 18:00:35 -04001796 directUnconditionalExportedFlags := android.Paths{}
1797 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
1798 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
1799 if exportUnconditionally {
1800 // if we explicitly export, then our unconditional exports are the same as our transitive flags
1801 transitiveUnconditionalExportedFlags = transitiveProguardFlags
1802 directUnconditionalExportedFlags = proguardFlagsForThisModule
1803 }
1804
1805 return ProguardSpecInfo{
1806 Export_proguard_flags_files: exportUnconditionally,
1807 ProguardFlagsFiles: android.NewDepSet[android.Path](
1808 android.POSTORDER,
1809 proguardFlagsForThisModule,
1810 transitiveProguardFlags,
1811 ),
1812 UnconditionallyExportedProguardFlags: android.NewDepSet[android.Path](
1813 android.POSTORDER,
1814 directUnconditionalExportedFlags,
1815 transitiveUnconditionalExportedFlags,
1816 ),
1817 }
1818
1819}
1820
Cole Faust75fffb12021-06-13 15:23:16 -07001821// Returns a copy of the supplied flags, but with all the errorprone-related
1822// fields copied to the regular build's fields.
1823func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
1824 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
1825
1826 if len(flags.errorProneExtraJavacFlags) > 0 {
1827 if len(flags.javacFlags) > 0 {
1828 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
1829 } else {
1830 flags.javacFlags = flags.errorProneExtraJavacFlags
1831 }
1832 }
1833 return flags
1834}
1835
Jaewoong Jung26342642021-03-17 15:56:23 -07001836func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
1837 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.WritablePath {
1838
1839 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00001840 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001841 if idx >= 0 {
1842 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00001843 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001844 jarName += strconv.Itoa(idx)
1845 }
1846
1847 classes := android.PathForModuleOut(ctx, "javac", jarName).OutputPath
Vadim Spivak3c496f02023-06-08 06:14:59 +00001848 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001849
1850 if ctx.Config().EmitXrefRules() {
1851 extractionFile := android.PathForModuleOut(ctx, kzipName)
1852 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
1853 j.kytheFiles = append(j.kytheFiles, extractionFile)
1854 }
1855
Vadim Spivak3c496f02023-06-08 06:14:59 +00001856 if len(flags.processorPath) > 0 {
1857 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
1858 }
1859
Jaewoong Jung26342642021-03-17 15:56:23 -07001860 return classes
1861}
1862
1863// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1864// since some of these flags may be used internally.
1865func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1866 for _, flag := range flags {
1867 flag = strings.TrimSpace(flag)
1868
1869 if !strings.HasPrefix(flag, "-") {
1870 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1871 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1872 ctx.PropertyErrorf("kotlincflags",
1873 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1874 } else if inList(flag, config.KotlincIllegalFlags) {
1875 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1876 } else if flag == "-include-runtime" {
1877 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1878 } else {
1879 args := strings.Split(flag, " ")
1880 if args[0] == "-kotlin-home" {
1881 ctx.PropertyErrorf("kotlincflags",
1882 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1883 }
1884 }
1885 }
1886}
1887
1888func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
1889 deps deps, flags javaBuilderFlags, jarName string,
Joe Onorato349ae8d2024-02-05 22:46:00 +00001890 extraJars android.Paths) (headerJar, jarjarAndDepsHeaderJar, jarjarAndDepsRepackagedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001891
1892 var jars android.Paths
1893 if len(srcFiles) > 0 || len(srcJars) > 0 {
1894 // Compile java sources into turbine.jar.
1895 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1896 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
1897 if ctx.Failed() {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001898 return nil, nil, nil
Jaewoong Jung26342642021-03-17 15:56:23 -07001899 }
1900 jars = append(jars, turbineJar)
Colin Cross3d56ed52021-11-18 22:23:12 -08001901 headerJar = turbineJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001902 }
1903
1904 jars = append(jars, extraJars...)
1905
1906 // Combine any static header libraries into classes-header.jar. If there is only
1907 // one input jar this step will be skipped.
1908 jars = append(jars, deps.staticHeaderJars...)
1909
1910 // we cannot skip the combine step for now if there is only one jar
1911 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
1912 combinedJar := android.PathForModuleOut(ctx, "turbine-combined", jarName)
1913 TransformJarsToJar(ctx, combinedJar, "for turbine", jars, android.OptionalPath{},
1914 false, nil, []string{"META-INF/TRANSITIVE"})
Colin Cross3d56ed52021-11-18 22:23:12 -08001915 jarjarAndDepsHeaderJar = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001916
1917 if j.expandJarjarRules != nil {
1918 // Transform classes.jar into classes-jarjar.jar
1919 jarjarFile := android.PathForModuleOut(ctx, "turbine-jarjar", jarName)
Colin Cross3d56ed52021-11-18 22:23:12 -08001920 TransformJarJar(ctx, jarjarFile, jarjarAndDepsHeaderJar, j.expandJarjarRules)
1921 jarjarAndDepsHeaderJar = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001922 if ctx.Failed() {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001923 return nil, nil, nil
Jaewoong Jung26342642021-03-17 15:56:23 -07001924 }
1925 }
1926
Joe Onorato349ae8d2024-02-05 22:46:00 +00001927 if j.repackageJarjarRules != nil {
1928 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-turbine-jarjar", jarName)
1929 TransformJarJar(ctx, repackagedJarjarFile, jarjarAndDepsHeaderJar, j.repackageJarjarRules)
1930 jarjarAndDepsRepackagedHeaderJar = repackagedJarjarFile
1931 if ctx.Failed() {
1932 return nil, nil, nil
1933 }
1934 } else {
1935 jarjarAndDepsRepackagedHeaderJar = jarjarAndDepsHeaderJar
1936 }
1937
1938 return headerJar, jarjarAndDepsHeaderJar, jarjarAndDepsRepackagedHeaderJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001939}
1940
1941func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001942 classesJar android.Path, jarName string, specs string) android.OutputPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07001943
1944 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
1945 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName).OutputPath
1946
1947 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1948
1949 j.jacocoReportClassesFile = jacocoReportClassesFile
1950
1951 return instrumentedJar
1952}
1953
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001954type providesTransitiveHeaderJars struct {
1955 // set of header jars for all transitive libs deps
Colin Crossc85750b2022-04-21 12:50:51 -07001956 transitiveLibsHeaderJars *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001957 // set of header jars for all transitive static libs deps
Colin Crossc85750b2022-04-21 12:50:51 -07001958 transitiveStaticLibsHeaderJars *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001959}
1960
Colin Crossc85750b2022-04-21 12:50:51 -07001961func (j *providesTransitiveHeaderJars) TransitiveLibsHeaderJars() *android.DepSet[android.Path] {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001962 return j.transitiveLibsHeaderJars
1963}
1964
Colin Crossc85750b2022-04-21 12:50:51 -07001965func (j *providesTransitiveHeaderJars) TransitiveStaticLibsHeaderJars() *android.DepSet[android.Path] {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001966 return j.transitiveStaticLibsHeaderJars
1967}
1968
1969func (j *providesTransitiveHeaderJars) collectTransitiveHeaderJars(ctx android.ModuleContext) {
1970 directLibs := android.Paths{}
1971 directStaticLibs := android.Paths{}
Colin Crossc85750b2022-04-21 12:50:51 -07001972 transitiveLibs := []*android.DepSet[android.Path]{}
1973 transitiveStaticLibs := []*android.DepSet[android.Path]{}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001974 ctx.VisitDirectDeps(func(module android.Module) {
1975 // don't add deps of the prebuilt version of the same library
1976 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
1977 return
1978 }
1979
Colin Cross313aa542023-12-13 13:47:44 -08001980 dep, _ := android.OtherModuleProvider(ctx, module, JavaInfoProvider)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001981 tag := ctx.OtherModuleDependencyTag(module)
1982 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
1983 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
1984 directLibs = append(directLibs, dep.HeaderJars...)
1985 } else if tag == staticLibTag {
1986 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
Jared Dukeefb6d602023-10-27 18:47:10 +00001987 } else {
1988 // Don't propagate transitive libs for other kinds of dependencies.
1989 return
1990 }
1991
1992 if dep.TransitiveLibsHeaderJars != nil {
1993 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJars)
1994 }
1995 if dep.TransitiveStaticLibsHeaderJars != nil {
1996 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJars)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001997 }
1998 })
1999 j.transitiveLibsHeaderJars = android.NewDepSet(android.POSTORDER, directLibs, transitiveLibs)
2000 j.transitiveStaticLibsHeaderJars = android.NewDepSet(android.POSTORDER, directStaticLibs, transitiveStaticLibs)
2001}
2002
Jaewoong Jung26342642021-03-17 15:56:23 -07002003func (j *Module) HeaderJars() android.Paths {
2004 if j.headerJarFile == nil {
2005 return nil
2006 }
2007 return android.Paths{j.headerJarFile}
2008}
2009
2010func (j *Module) ImplementationJars() android.Paths {
2011 if j.implementationJarFile == nil {
2012 return nil
2013 }
2014 return android.Paths{j.implementationJarFile}
2015}
2016
Spandan Das59a4a2b2024-01-09 21:35:56 +00002017func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002018 return j.dexJarFile
2019}
2020
2021func (j *Module) DexJarInstallPath() android.Path {
2022 return j.installFile
2023}
2024
2025func (j *Module) ImplementationAndResourcesJars() android.Paths {
2026 if j.implementationAndResourcesJar == nil {
2027 return nil
2028 }
2029 return android.Paths{j.implementationAndResourcesJar}
2030}
2031
2032func (j *Module) AidlIncludeDirs() android.Paths {
2033 // exportAidlIncludeDirs is type android.Paths already
2034 return j.exportAidlIncludeDirs
2035}
2036
2037func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2038 return j.classLoaderContexts
2039}
2040
2041// Collect information for opening IDE project files in java/jdeps.go.
2042func (j *Module) IDEInfo(dpInfo *android.IdeInfo) {
2043 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2044 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2045 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2046 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
2047 if j.expandJarjarRules != nil {
2048 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
2049 }
Yikef6282022022-04-13 20:41:01 +08002050 dpInfo.Static_libs = append(dpInfo.Static_libs, j.properties.Static_libs...)
2051 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Vadim Spivak3c496f02023-06-08 06:14:59 +00002052 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002053}
2054
2055func (j *Module) CompilerDeps() []string {
2056 jdeps := []string{}
2057 jdeps = append(jdeps, j.properties.Libs...)
2058 jdeps = append(jdeps, j.properties.Static_libs...)
2059 return jdeps
2060}
2061
2062func (j *Module) hasCode(ctx android.ModuleContext) bool {
2063 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2064 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2065}
2066
2067// Implements android.ApexModule
2068func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
2069 return j.depIsInSameApex(ctx, dep)
2070}
2071
2072// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002073func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002074 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002075 minSdkVersion := j.MinSdkVersion(ctx)
2076 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002077 return fmt.Errorf("min_sdk_version is not specified")
2078 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002079 // If the module is compiling against core (via sdk_version), skip comparison check.
2080 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002081 return nil
2082 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002083 if minSdkVersion.GreaterThan(sdkVersion) {
2084 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002085 }
2086 return nil
2087}
2088
2089func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002090 if j.stem == "" {
2091 panic("Stem() called before stem property was set")
2092 }
2093 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002094}
2095
Jaewoong Jung26342642021-03-17 15:56:23 -07002096func (j *Module) JacocoReportClassesFile() android.Path {
2097 return j.jacocoReportClassesFile
2098}
2099
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002100func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
2101 var fromDeps []*android.DepSet[android.Path]
2102 ctx.VisitDirectDeps(func(module android.Module) {
2103 tag := ctx.OtherModuleDependencyTag(module)
2104 if tag == staticLibTag {
Colin Cross313aa542023-12-13 13:47:44 -08002105 depInfo, _ := android.OtherModuleProvider(ctx, module, JavaInfoProvider)
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002106 if depInfo.TransitiveSrcFiles != nil {
2107 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
2108 }
2109 }
2110 })
2111
2112 j.transitiveSrcFiles = android.NewDepSet(android.POSTORDER, mine, fromDeps)
2113}
2114
Jaewoong Jung26342642021-03-17 15:56:23 -07002115func (j *Module) IsInstallable() bool {
2116 return Bool(j.properties.Installable)
2117}
2118
2119type sdkLinkType int
2120
2121const (
2122 // TODO(jiyong) rename these for better readability. Make the allowed
2123 // and disallowed link types explicit
2124 // order is important here. See rank()
2125 javaCore sdkLinkType = iota
2126 javaSdk
2127 javaSystem
2128 javaModule
2129 javaSystemServer
2130 javaPlatform
2131)
2132
2133func (lt sdkLinkType) String() string {
2134 switch lt {
2135 case javaCore:
2136 return "core Java API"
2137 case javaSdk:
2138 return "Android API"
2139 case javaSystem:
2140 return "system API"
2141 case javaModule:
2142 return "module API"
2143 case javaSystemServer:
2144 return "system server API"
2145 case javaPlatform:
2146 return "private API"
2147 default:
2148 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2149 }
2150}
2151
2152// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2153// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2154// can't statically depend on modules that use Platform API.
2155func (lt sdkLinkType) rank() int {
2156 return int(lt)
2157}
2158
2159type moduleWithSdkDep interface {
2160 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002161 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002162}
2163
Jiyong Park92315372021-04-02 08:45:46 +09002164func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002165 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002166 case android.SdkCore.DefaultJavaLibraryName(),
2167 "legacy.core.platform.api.stubs",
2168 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002169 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002170 "core-lambda-stubs",
Jihoon Kangb5078312023-03-29 23:25:49 +00002171 "core-generated-annotation-stubs":
Jaewoong Jung26342642021-03-17 15:56:23 -07002172 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002173 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002174 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002175 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002176 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002177 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002178 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002179 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002180 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002181 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002182 return javaSystem, true
2183 }
2184
2185 if stub, linkType := moduleStubLinkType(name); stub {
2186 return linkType, true
2187 }
2188
Jiyong Park92315372021-04-02 08:45:46 +09002189 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002190 switch ver.Kind {
2191 case android.SdkCore:
Jaewoong Jung26342642021-03-17 15:56:23 -07002192 return javaCore, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09002193 case android.SdkSystem:
Jaewoong Jung26342642021-03-17 15:56:23 -07002194 return javaSystem, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09002195 case android.SdkPublic:
Jaewoong Jung26342642021-03-17 15:56:23 -07002196 return javaSdk, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09002197 case android.SdkModule:
Jaewoong Jung26342642021-03-17 15:56:23 -07002198 return javaModule, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09002199 case android.SdkSystemServer:
Jaewoong Jung26342642021-03-17 15:56:23 -07002200 return javaSystemServer, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09002201 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
Jaewoong Jung26342642021-03-17 15:56:23 -07002202 return javaPlatform, false
2203 }
2204
Jiyong Parkf1691d22021-03-29 20:11:58 +09002205 if !ver.Valid() {
2206 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002207 }
2208 return javaSdk, false
2209}
2210
2211// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2212// this module's. See the comment on rank() for details and an example.
2213func (j *Module) checkSdkLinkType(
2214 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
2215 if ctx.Host() {
2216 return
2217 }
2218
Jiyong Park92315372021-04-02 08:45:46 +09002219 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002220 if stubs {
2221 return
2222 }
Jiyong Park92315372021-04-02 08:45:46 +09002223 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07002224
2225 if myLinkType.rank() < depLinkType.rank() {
2226 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2227 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2228 "property of the source or target module so that target module is built "+
2229 "with the same or smaller API set when compared to the source.",
2230 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2231 }
2232}
2233
2234func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2235 var deps deps
2236
2237 if ctx.Device() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09002238 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07002239 if sdkDep.invalidVersion {
2240 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2241 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2242 } else if sdkDep.useFiles {
2243 // sdkDep.jar is actually equivalent to turbine header.jar.
2244 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002245 deps.dexClasspath = append(deps.dexClasspath, sdkDep.jars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002246 deps.aidlPreprocess = sdkDep.aidl
2247 } else {
2248 deps.aidlPreprocess = sdkDep.aidl
2249 }
2250 }
2251
Jiyong Park92315372021-04-02 08:45:46 +09002252 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002253
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002254 j.collectTransitiveHeaderJars(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07002255 ctx.VisitDirectDeps(func(module android.Module) {
2256 otherName := ctx.OtherModuleName(module)
2257 tag := ctx.OtherModuleDependencyTag(module)
2258
2259 if IsJniDepTag(tag) {
2260 // Handled by AndroidApp.collectAppDeps
2261 return
2262 }
2263 if tag == certificateTag {
2264 // Handled by AndroidApp.collectAppDeps
2265 return
2266 }
2267
2268 if dep, ok := module.(SdkLibraryDependency); ok {
2269 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002270 case sdkLibTag, libTag:
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002271 depHeaderJars := dep.SdkHeaderJars(ctx, j.SdkVersion(ctx))
2272 deps.classpath = append(deps.classpath, depHeaderJars...)
2273 deps.dexClasspath = append(deps.dexClasspath, depHeaderJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002274 case staticLibTag:
2275 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
2276 }
Colin Cross313aa542023-12-13 13:47:44 -08002277 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2278 if sdkLinkType != javaPlatform {
2279 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2280 // dep is a sysprop implementation library, but this module is not linking against
2281 // the platform, so it gets the sysprop public stubs library instead. Replace
2282 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2283 dep = syspropDep.JavaInfo
2284 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002285 }
2286 switch tag {
2287 case bootClasspathTag:
2288 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Liz Kammeref28a4c2022-09-23 16:50:56 -04002289 case sdkLibTag, libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002290 if _, ok := module.(*Plugin); ok {
2291 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2292 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002293 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002294 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002295 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2296 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2297 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2298 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002299 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2300 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2301 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
2302 case java9LibTag:
2303 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
2304 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002305 if _, ok := module.(*Plugin); ok {
2306 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2307 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002308 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2309 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2310 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2311 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2312 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2313 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2314 // Turbine doesn't run annotation processors, so any module that uses an
2315 // annotation processor that generates API is incompatible with the turbine
2316 // optimization.
2317 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002318 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002319 case pluginTag:
2320 if plugin, ok := module.(*Plugin); ok {
2321 if plugin.pluginProperties.Processor_class != nil {
2322 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
2323 } else {
2324 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2325 }
2326 // Turbine doesn't run annotation processors, so any module that uses an
2327 // annotation processor that generates API is incompatible with the turbine
2328 // optimization.
2329 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
2330 } else {
2331 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2332 }
2333 case errorpronePluginTag:
2334 if _, ok := module.(*Plugin); ok {
2335 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2336 } else {
2337 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2338 }
2339 case exportedPluginTag:
2340 if plugin, ok := module.(*Plugin); ok {
2341 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
2342 if plugin.pluginProperties.Processor_class != nil {
2343 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
2344 }
2345 // Turbine doesn't run annotation processors, so any module that uses an
2346 // annotation processor that generates API is incompatible with the turbine
2347 // optimization.
2348 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
2349 } else {
2350 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2351 }
2352 case kotlinStdlibTag:
2353 deps.kotlinStdlib = append(deps.kotlinStdlib, dep.HeaderJars...)
2354 case kotlinAnnotationsTag:
2355 deps.kotlinAnnotations = dep.HeaderJars
Colin Crossa1ff7c62021-09-17 14:11:52 -07002356 case kotlinPluginTag:
2357 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002358 case syspropPublicStubDepTag:
2359 // This is a sysprop implementation library, forward the JavaInfoProvider from
2360 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002361 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002362 JavaInfo: dep,
2363 })
2364 }
2365 } else if dep, ok := module.(android.SourceFileProducer); ok {
2366 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002367 case sdkLibTag, libTag:
Jaewoong Jung26342642021-03-17 15:56:23 -07002368 checkProducesJars(ctx, dep)
2369 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002370 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002371 case staticLibTag:
2372 checkProducesJars(ctx, dep)
2373 deps.classpath = append(deps.classpath, dep.Srcs()...)
2374 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2375 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
2376 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002377 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002378 switch tag {
2379 case staticLibTag:
2380 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2381 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002382 } else {
2383 switch tag {
2384 case bootClasspathTag:
2385 // If a system modules dependency has been added to the bootclasspath
2386 // then add its libs to the bootclasspath.
2387 sm := module.(SystemModulesProvider)
2388 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars()...)
2389
2390 case systemModulesTag:
2391 if deps.systemModules != nil {
2392 panic("Found two system module dependencies")
2393 }
2394 sm := module.(SystemModulesProvider)
2395 outputDir, outputDeps := sm.OutputDirAndDeps()
2396 deps.systemModules = &systemModules{outputDir, outputDeps}
Paul Duffin53a70a42022-01-11 14:35:55 +00002397
2398 case instrumentationForTag:
2399 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 -07002400 }
2401 }
2402
2403 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002404 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002405 })
2406
2407 return deps
2408}
2409
Joe Onorato349ae8d2024-02-05 22:46:00 +00002410// Provider for jarjar renaming rules.
2411//
2412// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2413// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2414// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2415// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2416// be renamed from that module.
2417// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002418type DependencyUse int
2419
2420const (
2421 RenameUseInvalid DependencyUse = iota
2422 RenameUseInclude
2423 RenameUseExclude
2424)
2425
2426type RenameUseElement struct {
2427 DepName string
2428 RenameUse DependencyUse
2429 Why string // token for determining where in the logic the decision was made.
2430}
2431
Joe Onorato349ae8d2024-02-05 22:46:00 +00002432type JarJarProviderData struct {
2433 // Mapping of class names: original --> renamed. If the value is "", the class will be
2434 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2435 // attribute). Rdeps of that module will inherit the renaming.
LaMont Jones63683e42024-02-08 14:30:45 -08002436 Rename map[string]string
2437 RenameUse []RenameUseElement
Joe Onorato349ae8d2024-02-05 22:46:00 +00002438}
2439
2440func (this JarJarProviderData) GetDebugString() string {
2441 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002442 for _, k := range android.SortedKeys(this.Rename) {
2443 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002444 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2445 result += k + "--&gt;" + v + ";"
2446 }
2447 }
2448 return result
2449}
2450
2451var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2452
2453var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2454
2455func init() {
2456 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
2457}
2458
2459// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2460// whether they are java modules or not.
2461type BaseJarJarProviderData struct {
2462 JarJarProviderData JarJarProviderData
2463}
2464
2465func (this BaseJarJarProviderData) GetDebugString() string {
2466 return this.JarJarProviderData.GetDebugString()
2467}
2468
2469var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2470
2471// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2472// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2473// either JarJarProvider or BaseJarJarProvider.
2474func mergeJarJarPrefixes(ctx android.ModuleContext) {
2475 mod := ctx.Module()
2476 // Explicitly avoid propagating into some module types.
2477 switch reflect.TypeOf(mod).String() {
2478 case "*java.Droidstubs":
2479 return
2480 }
2481 jarJarData := collectDirectDepsProviders(ctx)
2482 if jarJarData != nil {
2483 providerData := BaseJarJarProviderData{
2484 JarJarProviderData: *jarJarData,
2485 }
2486 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2487 }
2488
2489}
2490
2491// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2492func (module *Module) addJarJarRenameRule(original string, renamed string) {
2493 if module.jarjarRenameRules == nil {
2494 module.jarjarRenameRules = make(map[string]string)
2495 }
2496 module.jarjarRenameRules[original] = renamed
2497}
2498
2499func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2500 // Gather repackage information from deps
2501 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002502
2503 module := ctx.Module()
2504 moduleName := module.Name()
2505
Joe Onorato349ae8d2024-02-05 22:46:00 +00002506 ctx.VisitDirectDepsIgnoreBlueprint(func(m android.Module) {
LaMont Jones63683e42024-02-08 14:30:45 -08002507 tag := ctx.OtherModuleDependencyTag(m)
2508 // This logic mirrors that in (*Module).collectDeps above. There are several places
2509 // where we explicitly return RenameUseExclude, even though it is the default, to
2510 // indicate that it has been verified to be the case.
2511 //
2512 // Note well: there are probably cases that are getting to the unconditional return
2513 // and are therefore wrong.
2514 shouldIncludeRenames := func() (DependencyUse, string) {
2515 if moduleName == m.Name() {
2516 return RenameUseInclude, "name" // If we have the same module name, include the renames.
2517 }
2518 if sc, ok := module.(android.SdkContext); ok {
2519 if ctx.Device() {
2520 sdkDep := decodeSdkDep(ctx, sc)
2521 if !sdkDep.invalidVersion && sdkDep.useFiles {
2522 return RenameUseExclude, "useFiles"
Joe Onorato349ae8d2024-02-05 22:46:00 +00002523 }
2524 }
LaMont Jones63683e42024-02-08 14:30:45 -08002525 }
2526 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
2527 return RenameUseExclude, "tags"
2528 }
2529 if _, ok := m.(SdkLibraryDependency); ok {
2530 switch tag {
2531 case sdkLibTag, libTag:
2532 return RenameUseExclude, "sdklibdep" // matches collectDeps()
2533 }
2534 return RenameUseInvalid, "sdklibdep" // dep is not used in collectDeps()
2535 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2536 switch ji.StubsLinkType {
2537 case Stubs:
2538 return RenameUseExclude, "info"
2539 case Implementation:
2540 return RenameUseInclude, "info"
2541 default:
2542 //fmt.Printf("LJ: %v -> %v StubsLinkType unknown\n", module, m)
2543 // Fall through to the heuristic logic.
2544 }
2545 switch reflect.TypeOf(m).String() {
2546 case "*java.GeneratedJavaLibraryModule":
2547 // Probably a java_aconfig_library module.
2548 // TODO: make this check better.
2549 return RenameUseInclude, "reflect"
2550 }
2551 switch tag {
2552 case bootClasspathTag:
2553 return RenameUseExclude, "tagswitch"
2554 case sdkLibTag, libTag, instrumentationForTag:
2555 return RenameUseInclude, "tagswitch"
2556 case java9LibTag:
2557 return RenameUseExclude, "tagswitch"
2558 case staticLibTag:
2559 return RenameUseInclude, "tagswitch"
2560 case pluginTag:
2561 return RenameUseInclude, "tagswitch"
2562 case errorpronePluginTag:
2563 return RenameUseInclude, "tagswitch"
2564 case exportedPluginTag:
2565 return RenameUseInclude, "tagswitch"
2566 case kotlinStdlibTag, kotlinAnnotationsTag:
2567 return RenameUseExclude, "tagswitch"
2568 case kotlinPluginTag:
2569 return RenameUseInclude, "tagswitch"
2570 default:
2571 return RenameUseExclude, "tagswitch"
2572 }
2573 } else if _, ok := m.(android.SourceFileProducer); ok {
2574 switch tag {
2575 case sdkLibTag, libTag, staticLibTag:
2576 return RenameUseInclude, "srcfile"
2577 default:
2578 return RenameUseExclude, "srcfile"
2579 }
Yu Liu67a28422024-03-05 00:36:31 +00002580 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kang03d014f2024-02-16 22:22:18 +00002581 return RenameUseInclude, "aconfig_declarations_group"
LaMont Jones63683e42024-02-08 14:30:45 -08002582 } else {
2583 switch tag {
2584 case bootClasspathTag:
2585 return RenameUseExclude, "else"
2586 case systemModulesTag:
2587 return RenameUseInclude, "else"
2588 }
2589 }
2590 // If we got here, choose the safer option, which may lead to a build failure, rather
2591 // than runtime failures on the device.
2592 return RenameUseExclude, "end"
2593 }
2594
2595 if result == nil {
2596 result = &JarJarProviderData{
2597 Rename: make(map[string]string),
2598 RenameUse: make([]RenameUseElement, 0),
2599 }
2600 }
2601 how, why := shouldIncludeRenames()
2602 result.RenameUse = append(result.RenameUse, RenameUseElement{DepName: m.Name(), RenameUse: how, Why: why})
2603 if how != RenameUseInclude {
2604 // Nothing to merge.
2605 return
2606 }
2607
2608 merge := func(theirs *JarJarProviderData) {
2609 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002610 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2611 result.Rename[orig] = renamed
2612 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2613 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2614 result.Rename[orig] = renamed
2615 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2616 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2617 continue
2618 }
2619 }
2620 }
2621 }
2622 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2623 merge(&theirs)
2624 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2625 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2626 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2627 // to java.Module.
2628 merge(&theirs.JarJarProviderData)
2629 }
2630 })
2631 return
2632}
2633
2634func (this Module) GetDebugString() string {
2635 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2636}
2637
2638// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2639// us, and if it's been set, apply the jarjar_prefix property to rename them.
2640func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2641 // Gather repackage information from deps
2642 result := collectDirectDepsProviders(ctx)
2643
2644 // Update that with entries we've stored for ourself
2645 for orig, renamed := range module.jarjarRenameRules {
2646 if result == nil {
2647 result = &JarJarProviderData{
2648 Rename: make(map[string]string),
2649 }
2650 }
2651 if renamed != "" {
2652 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2653 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
2654 continue
2655 }
2656 }
2657 (*result).Rename[orig] = renamed
2658 }
2659
2660 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2661 if result == nil {
2662 return nil
2663 }
2664
2665 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2666 // that have not yet been renamed.
2667 prefix := proptools.String(module.properties.Jarjar_prefix)
2668 if prefix != "" {
2669 if prefix[0] == '.' {
2670 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2671 return nil
2672 }
2673 if prefix[len(prefix)-1] == '.' {
2674 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2675 return nil
2676 }
2677
2678 var updated map[string]string
2679 for orig, renamed := range (*result).Rename {
2680 if renamed == "" {
2681 if updated == nil {
2682 updated = make(map[string]string)
2683 }
2684 updated[orig] = prefix + "." + orig
2685 }
2686 }
2687 for orig, renamed := range updated {
2688 (*result).Rename[orig] = renamed
2689 }
2690 }
2691
2692 return result
2693}
2694
2695// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2696// to "" won't be in this list because they shouldn't be renamed yet.
2697func getJarJarRuleText(provider *JarJarProviderData) string {
2698 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002699 for _, orig := range android.SortedKeys(provider.Rename) {
2700 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002701 if renamed != "" {
2702 result += "rule " + orig + " " + renamed + "\n"
2703 }
2704 }
2705 return result
2706}
2707
Zi Wangddb2ee52024-04-02 16:44:02 +00002708// Repackage the flags if the jarjar rule txt for the flags is generated
2709func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.WritablePath, jarName, info string) android.WritablePath {
2710 if j.repackageJarjarRules == nil {
2711 return infile
2712 }
2713 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info+jarName)
2714 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
2715 return repackagedJarjarFile
2716}
2717
Jaewoong Jung26342642021-03-17 15:56:23 -07002718func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2719 deps.processorPath = append(deps.processorPath, pluginJars...)
2720 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2721}
2722
2723// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2724// this interface.
2725type ProvidesUsesLib interface {
2726 ProvidesUsesLib() *string
2727}
2728
2729func (j *Module) ProvidesUsesLib() *string {
2730 return j.usesLibraryProperties.Provides_uses_lib
2731}
satayev1c564cc2021-05-25 19:50:30 +01002732
2733type ModuleWithStem interface {
2734 Stem() string
2735}
2736
2737var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00002738
2739type ModuleWithUsesLibrary interface {
2740 UsesLibrary() *usesLibrary
2741}
2742
2743func (j *Module) UsesLibrary() *usesLibrary {
2744 return &j.usesLibrary
2745}
2746
2747var _ ModuleWithUsesLibrary = (*Module)(nil)