blob: 3d42f46096abaa92db9deee7c15d17e068f7ef21 [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 (
Yu Liu26a716d2024-08-30 23:40:32 +000018 "encoding/gob"
Jaewoong Jung26342642021-03-17 15:56:23 -070019 "fmt"
20 "path/filepath"
Joe Onorato349ae8d2024-02-05 22:46:00 +000021 "reflect"
22 "slices"
Jaewoong Jung26342642021-03-17 15:56:23 -070023 "strconv"
24 "strings"
25
Colin Crossd788b3e2023-11-28 13:14:56 -080026 "github.com/google/blueprint"
Jaewoong Jung26342642021-03-17 15:56:23 -070027 "github.com/google/blueprint/pathtools"
28 "github.com/google/blueprint/proptools"
29
30 "android/soong/android"
31 "android/soong/dexpreopt"
32 "android/soong/java/config"
33)
34
35// This file contains the definition and the implementation of the base module that most
36// source-based Java module structs embed.
37
38// TODO:
39// Autogenerated files:
40// Renderscript
41// Post-jar passes:
42// Proguard
43// Rmtypedefs
44// DroidDoc
45// Findbugs
46
47// Properties that are common to most Java modules, i.e. whether it's a host or device module.
48type CommonProperties struct {
49 // list of source files used to compile the Java module. May be .java, .kt, .logtags, .proto,
50 // or .aidl files.
51 Srcs []string `android:"path,arch_variant"`
52
53 // list Kotlin of source files containing Kotlin code that should be treated as common code in
54 // a codebase that supports Kotlin multiplatform. See
55 // https://kotlinlang.org/docs/reference/multiplatform.html. May be only be .kt files.
56 Common_srcs []string `android:"path,arch_variant"`
57
58 // list of source files that should not be used to build the Java module.
59 // This is most useful in the arch/multilib variants to remove non-common files
60 Exclude_srcs []string `android:"path,arch_variant"`
61
62 // list of directories containing Java resources
63 Java_resource_dirs []string `android:"arch_variant"`
64
65 // list of directories that should be excluded from java_resource_dirs
66 Exclude_java_resource_dirs []string `android:"arch_variant"`
67
68 // list of files to use as Java resources
69 Java_resources []string `android:"path,arch_variant"`
70
71 // list of files that should be excluded from java_resources and java_resource_dirs
72 Exclude_java_resources []string `android:"path,arch_variant"`
73
74 // list of module-specific flags that will be used for javac compiles
75 Javacflags []string `android:"arch_variant"`
76
77 // list of module-specific flags that will be used for kotlinc compiles
78 Kotlincflags []string `android:"arch_variant"`
79
80 // list of java libraries that will be in the classpath
81 Libs []string `android:"arch_variant"`
82
83 // list of java libraries that will be compiled into the resulting jar
Cole Faustb7493472024-08-28 11:55:52 -070084 Static_libs proptools.Configurable[[]string] `android:"arch_variant"`
Jaewoong Jung26342642021-03-17 15:56:23 -070085
Jihoon Kang381c2fa2023-06-01 22:17:32 +000086 // list of java libraries that should not be used to build this module
87 Exclude_static_libs []string `android:"arch_variant"`
88
Jaewoong Jung26342642021-03-17 15:56:23 -070089 // manifest file to be included in resulting jar
90 Manifest *string `android:"path"`
91
92 // if not blank, run jarjar using the specified rules file
93 Jarjar_rules *string `android:"path,arch_variant"`
94
Joe Onoratoa5d17172024-07-20 17:39:56 -070095 // java class names to rename with jarjar when a reverse dependency has a jarjar_prefix
96 // property.
97 Jarjar_rename []string
98
Joe Onorato349ae8d2024-02-05 22:46:00 +000099 // if not blank, used as prefix to generate repackage rule
100 Jarjar_prefix *string
101
Jaewoong Jung26342642021-03-17 15:56:23 -0700102 // If not blank, set the java version passed to javac as -source and -target
103 Java_version *string
104
105 // If set to true, allow this module to be dexed and installed on devices. Has no
106 // effect on host modules, which are always considered installable.
107 Installable *bool
108
109 // If set to true, include sources used to compile the module in to the final jar
110 Include_srcs *bool
111
112 // If not empty, classes are restricted to the specified packages and their sub-packages.
113 // This restriction is checked after applying jarjar rules and including static libs.
114 Permitted_packages []string
115
116 // List of modules to use as annotation processors
117 Plugins []string
118
119 // List of modules to export to libraries that directly depend on this library as annotation
120 // processors. Note that if the plugins set generates_api: true this will disable the turbine
121 // optimization on modules that depend on this module, which will reduce parallelism and cause
122 // more recompilation.
123 Exported_plugins []string
124
125 // The number of Java source entries each Javac instance can process
126 Javac_shard_size *int64
127
128 // Add host jdk tools.jar to bootclasspath
129 Use_tools_jar *bool
130
131 Openjdk9 struct {
132 // List of source files that should only be used when passing -source 1.9 or higher
133 Srcs []string `android:"path"`
134
135 // List of javac flags that should only be used when passing -source 1.9 or higher
136 Javacflags []string
137 }
138
139 // When compiling language level 9+ .java code in packages that are part of
140 // a system module, patch_module names the module that your sources and
141 // dependencies should be patched into. The Android runtime currently
142 // doesn't implement the JEP 261 module system so this option is only
143 // supported at compile time. It should only be needed to compile tests in
144 // packages that exist in libcore and which are inconvenient to move
145 // elsewhere.
Liz Kammer0a470a32023-10-05 17:02:00 -0400146 Patch_module *string
Jaewoong Jung26342642021-03-17 15:56:23 -0700147
148 Jacoco struct {
149 // List of classes to include for instrumentation with jacoco to collect coverage
150 // information at runtime when building with coverage enabled. If unset defaults to all
151 // classes.
152 // Supports '*' as the last character of an entry in the list as a wildcard match.
153 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
154 // it matches classes in the package that have the class name as a prefix.
155 Include_filter []string
156
157 // List of classes to exclude from instrumentation with jacoco to collect coverage
158 // information at runtime when building with coverage enabled. Overrides classes selected
159 // by the include_filter property.
160 // Supports '*' as the last character of an entry in the list as a wildcard match.
161 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
162 // it matches classes in the package that have the class name as a prefix.
163 Exclude_filter []string
164 }
165
166 Errorprone struct {
167 // List of javac flags that should only be used when running errorprone.
168 Javacflags []string
169
170 // List of java_plugin modules that provide extra errorprone checks.
171 Extra_check_modules []string
Cole Faust75fffb12021-06-13 15:23:16 -0700172
Cole Faust2b1536e2021-06-18 12:25:54 -0700173 // This property can be in 3 states. When set to true, errorprone will
174 // be run during the regular build. When set to false, errorprone will
175 // never be run. When unset, errorprone will be run when the RUN_ERROR_PRONE
176 // environment variable is true. Setting this to false will improve build
177 // performance more than adding -XepDisableAllChecks in javacflags.
Cole Faust75fffb12021-06-13 15:23:16 -0700178 Enabled *bool
Jaewoong Jung26342642021-03-17 15:56:23 -0700179 }
180
181 Proto struct {
182 // List of extra options that will be passed to the proto generator.
183 Output_params []string
184 }
185
Sam Delmericoc7593722022-08-31 15:57:52 -0400186 // If true, then jacocoagent is automatically added as a libs dependency so that
187 // r8 will not strip instrumentation classes out of dexed libraries.
Jaewoong Jung26342642021-03-17 15:56:23 -0700188 Instrument bool `blueprint:"mutated"`
Paul Duffin0038a8d2022-05-03 00:28:40 +0000189 // If true, then the module supports statically including the jacocoagent
190 // into the library.
191 Supports_static_instrumentation bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700192
193 // List of files to include in the META-INF/services folder of the resulting jar.
194 Services []string `android:"path,arch_variant"`
195
196 // If true, package the kotlin stdlib into the jar. Defaults to true.
197 Static_kotlin_stdlib *bool `android:"arch_variant"`
198
199 // A list of java_library instances that provide additional hiddenapi annotations for the library.
200 Hiddenapi_additional_annotations []string
Joe Onorato175073c2023-06-01 14:42:59 -0700201
202 // Additional srcJars tacked in by GeneratedJavaLibraryModule
203 Generated_srcjars []android.Path `android:"mutated"`
Mark Whitea15790a2023-08-22 21:28:11 +0000204
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000205 // intermediate aconfig cache file tacked in by GeneratedJavaLibraryModule
206 Aconfig_Cache_files []android.Path `android:"mutated"`
207
Mark Whitea15790a2023-08-22 21:28:11 +0000208 // If true, then only the headers are built and not the implementation jar.
Liz Kammer60772632023-10-05 17:18:44 -0400209 Headers_only *bool
Cole Faust2b64af82023-12-13 18:22:18 -0800210
211 // A list of files or dependencies to make available to the build sandbox. This is
212 // useful if source files are symlinks, the targets of the symlinks must be listed here.
213 // Note that currently not all actions implemented by android_apps are sandboxed, so you
214 // may only see this being necessary in lint builds.
215 Compile_data []string `android:"path"`
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000216
217 // Property signifying whether the module compiles stubs or not.
218 // Should be set to true when srcs of this module are stub files.
219 // This property does not need to be set to true when the module depends on
220 // the stubs via libs, but should be set to true when the module depends on
221 // the stubs via static libs.
222 Is_stubs_module *bool
Makoto Onuki7ded3822024-03-28 14:42:20 -0700223
224 // If true, enable the "Ravenizer" tool on the output jar.
225 // "Ravenizer" is a tool for Ravenwood tests, but it can also be enabled on other kinds
226 // of java targets.
227 Ravenizer struct {
228 Enabled *bool
229 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +0000230
231 // Contributing api surface of the stub module. Is not visible to bp modules, and should
232 // only be set for stub submodules generated by the java_sdk_library
233 Stub_contributing_api *string `blueprint:"mutated"`
Yihan Dong8be09c22024-08-29 15:32:13 +0800234
235 // If true, enable the "ApiMapper" tool on the output jar. "ApiMapper" is a tool to inject
236 // bytecode to log API calls.
237 ApiMapper bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700238}
239
240// Properties that are specific to device modules. Host module factories should not add these when
241// constructing a new module.
242type DeviceProperties struct {
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000243 // If not blank, set to the version of the sdk to compile against.
Spandan Das1ccf5742022-10-14 16:51:23 +0000244 // Defaults to an empty string, which compiles the module against the private platform APIs.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000245 // Values are of one of the following forms:
Vinh Trana9c8f7d2022-04-14 20:18:47 +0000246 // 1) numerical API level, "current", "none", or "core_platform"
247 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
248 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
249 // If the SDK kind is empty, it will be set to public.
Jaewoong Jung26342642021-03-17 15:56:23 -0700250 Sdk_version *string
251
satayev0a420e72021-11-29 17:25:52 +0000252 // if not blank, set the maximum version of the sdk that the compiled artifacts will run against.
253 // Defaults to empty string "". See sdk_version for possible values.
254 Max_sdk_version *string
255
William Loh5a082f92022-05-17 20:21:50 +0000256 // if not blank, set the maxSdkVersion properties of permission and uses-permission tags.
257 // Defaults to empty string "". See sdk_version for possible values.
258 Replace_max_sdk_version_placeholder *string
259
Jaewoong Jung26342642021-03-17 15:56:23 -0700260 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000261 // Defaults to sdk_version if not set. See sdk_version for possible values.
Jaewoong Jung26342642021-03-17 15:56:23 -0700262 Target_sdk_version *string
263
264 // Whether to compile against the platform APIs instead of an SDK.
265 // If true, then sdk_version must be empty. The value of this field
Vinh Trand91939e2022-04-18 19:27:17 +0000266 // is ignored when module's type isn't android_app, android_test, or android_test_helper_app.
Jaewoong Jung26342642021-03-17 15:56:23 -0700267 Platform_apis *bool
268
269 Aidl struct {
270 // Top level directories to pass to aidl tool
271 Include_dirs []string
272
273 // Directories rooted at the Android.bp file to pass to aidl tool
274 Local_include_dirs []string
275
276 // directories that should be added as include directories for any aidl sources of modules
277 // that depend on this module, as well as to aidl for this module.
278 Export_include_dirs []string
279
280 // whether to generate traces (for systrace) for this interface
281 Generate_traces *bool
282
283 // whether to generate Binder#GetTransaction name method.
284 Generate_get_transaction_name *bool
285
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100286 // whether all interfaces should be annotated with required permissions.
287 Enforce_permissions *bool
288
289 // allowlist for interfaces that (temporarily) do not require annotation for permissions.
290 Enforce_permissions_exceptions []string `android:"path"`
291
Jaewoong Jung26342642021-03-17 15:56:23 -0700292 // list of flags that will be passed to the AIDL compiler
293 Flags []string
294 }
295
296 // If true, export a copy of the module as a -hostdex module for host testing.
297 Hostdex *bool
298
299 Target struct {
300 Hostdex struct {
301 // Additional required dependencies to add to -hostdex modules.
302 Required []string
303 }
304 }
305
306 // When targeting 1.9 and above, override the modules to use with --system,
307 // otherwise provides defaults libraries to add to the bootclasspath.
308 System_modules *string
309
Jaewoong Jung26342642021-03-17 15:56:23 -0700310 IsSDKLibrary bool `blueprint:"mutated"`
311
312 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
313 // Defaults to false.
314 V4_signature *bool
315
316 // Only for libraries created by a sysprop_library module, SyspropPublicStub is the name of the
317 // public stubs library.
318 SyspropPublicStub string `blueprint:"mutated"`
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000319
320 HiddenAPIPackageProperties
321 HiddenAPIFlagFileProperties
Jaewoong Jung26342642021-03-17 15:56:23 -0700322}
323
yangbill2af0b6e2024-03-15 09:29:29 +0000324// Properties that can be overridden by overriding module (e.g. override_android_app)
325type OverridableProperties struct {
Jooyung Han01d80d82022-01-08 12:16:32 +0900326 // set the name of the output. If not set, `name` is used.
327 // To override a module with this property set, overriding module might need to set this as well.
328 // Otherwise, both the overridden and the overriding modules will have the same output name, which
329 // can cause the duplicate output error.
330 Stem *string
Spandan Dasb9c58352024-05-13 18:29:45 +0000331
332 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
333 // Defaults to sdk_version if not set. See sdk_version for possible values.
334 Min_sdk_version *string
Jooyung Han01d80d82022-01-08 12:16:32 +0900335}
336
Jaewoong Jung26342642021-03-17 15:56:23 -0700337// Functionality common to Module and Import
338//
339// It is embedded in Module so its functionality can be used by methods in Module
340// but it is currently only initialized by Import and Library.
341type embeddableInModuleAndImport struct {
342
343 // Functionality related to this being used as a component of a java_sdk_library.
344 EmbeddableSdkLibraryComponent
345}
346
Paul Duffin71b33cc2021-06-23 11:39:47 +0100347func (e *embeddableInModuleAndImport) initModuleAndImport(module android.Module) {
348 e.initSdkLibraryComponent(module)
Jaewoong Jung26342642021-03-17 15:56:23 -0700349}
350
351// Module/Import's DepIsInSameApex(...) delegates to this method.
352//
353// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
354// the one provided by ApexModuleBase.
355func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
356 // dependencies other than the static linkage are all considered crossing APEX boundary
357 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
358 return true
359 }
360 return false
361}
362
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100363// OptionalDexJarPath can be either unset, hold a valid path to a dex jar file,
364// or an invalid path describing the reason it is invalid.
365//
366// It is unset if a dex jar isn't applicable, i.e. no build rule has been
367// requested to create one.
368//
369// If a dex jar has been requested to be built then it is set, and it may be
370// either a valid android.Path, or invalid with a reason message. The latter
371// happens if the source that should produce the dex file isn't able to.
372//
373// E.g. it is invalid with a reason message if there is a prebuilt APEX that
374// could produce the dex jar through a deapexer module, but the APEX isn't
375// installable so doing so wouldn't be safe.
376type OptionalDexJarPath struct {
377 isSet bool
378 path android.OptionalPath
379}
380
381// IsSet returns true if a path has been set, either invalid or valid.
382func (o OptionalDexJarPath) IsSet() bool {
383 return o.isSet
384}
385
386// Valid returns true if there is a path that is valid.
387func (o OptionalDexJarPath) Valid() bool {
388 return o.isSet && o.path.Valid()
389}
390
391// Path returns the valid path, or panics if it's either not set or is invalid.
392func (o OptionalDexJarPath) Path() android.Path {
393 if !o.isSet {
394 panic("path isn't set")
395 }
396 return o.path.Path()
397}
398
399// PathOrNil returns the path if it's set and valid, or else nil.
400func (o OptionalDexJarPath) PathOrNil() android.Path {
401 if o.Valid() {
402 return o.Path()
403 }
404 return nil
405}
406
407// InvalidReason returns the reason for an invalid path, which is never "". It
408// returns "" for an unset or valid path.
409func (o OptionalDexJarPath) InvalidReason() string {
410 if !o.isSet {
411 return ""
412 }
413 return o.path.InvalidReason()
414}
415
416func (o OptionalDexJarPath) String() string {
417 if !o.isSet {
418 return "<unset>"
419 }
420 return o.path.String()
421}
422
423// makeUnsetDexJarPath returns an unset OptionalDexJarPath.
424func makeUnsetDexJarPath() OptionalDexJarPath {
425 return OptionalDexJarPath{isSet: false}
426}
427
428// makeDexJarPathFromOptionalPath returns an OptionalDexJarPath that is set with
429// the given OptionalPath, which may be valid or invalid.
430func makeDexJarPathFromOptionalPath(path android.OptionalPath) OptionalDexJarPath {
431 return OptionalDexJarPath{isSet: true, path: path}
432}
433
434// makeDexJarPathFromPath returns an OptionalDexJarPath that is set with the
435// valid given path. It returns an unset OptionalDexJarPath if the given path is
436// nil.
437func makeDexJarPathFromPath(path android.Path) OptionalDexJarPath {
438 if path == nil {
439 return makeUnsetDexJarPath()
440 }
441 return makeDexJarPathFromOptionalPath(android.OptionalPathForPath(path))
442}
443
Jaewoong Jung26342642021-03-17 15:56:23 -0700444// Module contains the properties and members used by all java module types
445type Module struct {
446 android.ModuleBase
447 android.DefaultableModuleBase
448 android.ApexModuleBase
Jaewoong Jung26342642021-03-17 15:56:23 -0700449
450 // Functionality common to Module and Import.
451 embeddableInModuleAndImport
452
453 properties CommonProperties
454 protoProperties android.ProtoProperties
455 deviceProperties DeviceProperties
456
yangbill2af0b6e2024-03-15 09:29:29 +0000457 overridableProperties OverridableProperties
Ronald Braunsteincdc66f42024-04-12 11:23:19 -0700458 sourceProperties android.SourceProperties
Jooyung Han01d80d82022-01-08 12:16:32 +0900459
Jaewoong Jung26342642021-03-17 15:56:23 -0700460 // jar file containing header classes including static library dependencies, suitable for
461 // inserting into the bootclasspath/classpath of another compile
462 headerJarFile android.Path
463
464 // jar file containing implementation classes including static library dependencies but no
465 // resources
466 implementationJarFile android.Path
467
Jaewoong Jung26342642021-03-17 15:56:23 -0700468 // args and dependencies to package source files into a srcjar
469 srcJarArgs []string
470 srcJarDeps android.Paths
471
Anton Hansson0e73f9e2023-09-20 13:39:57 +0000472 // the source files of this module and all its static dependencies
473 transitiveSrcFiles *android.DepSet[android.Path]
474
Jaewoong Jung26342642021-03-17 15:56:23 -0700475 // jar file containing implementation classes and resources including static library
476 // dependencies
477 implementationAndResourcesJar android.Path
478
479 // output file containing classes.dex and resources
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100480 dexJarFile OptionalDexJarPath
Jaewoong Jung26342642021-03-17 15:56:23 -0700481
482 // output file containing uninstrumented classes that will be instrumented by jacoco
483 jacocoReportClassesFile android.Path
484
485 // output file of the module, which may be a classes jar or a dex jar
486 outputFile android.Path
487 extraOutputFiles android.Paths
488
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100489 exportAidlIncludeDirs android.Paths
490 ignoredAidlPermissionList android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700491
492 logtagsSrcs android.Paths
493
494 // installed file for binary dependency
495 installFile android.Path
496
Colin Cross3108ce12021-11-10 14:38:50 -0800497 // installed file for hostdex copy
498 hostdexInstallFile android.InstallPath
499
Chaohui Wangdcbe33c2022-10-11 11:13:30 +0800500 // list of unique .java and .kt source files
501 uniqueSrcFiles android.Paths
502
503 // list of srcjars that was passed to javac
504 compiledSrcJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700505
506 // manifest file to use instead of properties.Manifest
507 overrideManifest android.OptionalPath
508
Jaewoong Jung26342642021-03-17 15:56:23 -0700509 // list of plugins that this java module is exporting
510 exportedPluginJars android.Paths
511
512 // list of plugins that this java module is exporting
513 exportedPluginClasses []string
514
515 // if true, the exported plugins generate API and require disabling turbine.
516 exportedDisableTurbine bool
517
518 // list of source files, collected from srcFiles with unique java and all kt files,
519 // will be used by android.IDEInfo struct
520 expandIDEInfoCompiledSrcs []string
521
522 // expanded Jarjar_rules
523 expandJarjarRules android.Path
524
Joe Onorato349ae8d2024-02-05 22:46:00 +0000525 // jarjar rule for inherited jarjar rules
526 repackageJarjarRules android.Path
527
Jaewoong Jung26342642021-03-17 15:56:23 -0700528 // Extra files generated by the module type to be added as java resources.
529 extraResources android.Paths
530
531 hiddenAPI
532 dexer
533 dexpreopter
534 usesLibrary
535 linter
536
537 // list of the xref extraction files
538 kytheFiles android.Paths
539
Jaewoong Jung26342642021-03-17 15:56:23 -0700540 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +0900541
542 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000543 minSdkVersion android.ApiLevel
Spandan Dasa26eda72023-03-02 00:56:06 +0000544 maxSdkVersion android.ApiLevel
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -0400545
546 sourceExtensions []string
Vadim Spivak3c496f02023-06-08 06:14:59 +0000547
548 annoSrcJars android.Paths
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000549
550 // output file name based on Stem property.
551 // This should be set in every ModuleWithStem's GenerateAndroidBuildActions
552 // or the module should override Stem().
553 stem string
Joe Onorato6fe59eb2023-07-16 13:20:33 -0700554
Joe Onorato349ae8d2024-02-05 22:46:00 +0000555 // Values that will be set in the JarJarProvider data for jarjar repackaging,
556 // and merged with our dependencies' rules.
557 jarjarRenameRules map[string]string
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000558
559 stubsLinkType StubsLinkType
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000560
561 // Paths to the aconfig intermediate cache files that are provided by the
562 // java_aconfig_library or java_library modules that are statically linked
563 // to this module. Does not contain cache files from all transitive dependencies.
564 aconfigCacheFiles android.Paths
Spandan Das8aac9932024-07-18 23:14:13 +0000565
566 // List of soong module dependencies required to compile the current module.
567 // This information is printed out to `Dependencies` field in module_bp_java_deps.json
568 compileDepNames []string
Makoto Onuki7ded3822024-03-28 14:42:20 -0700569
570 ravenizer struct {
571 enabled bool
572 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700573}
574
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000575var _ android.InstallableModule = (*Module)(nil)
576
577// To satisfy the InstallableModule interface
Jihoon Kang224ea082024-08-12 22:38:16 +0000578func (j *Module) StaticDependencyTags() []blueprint.DependencyTag {
579 return []blueprint.DependencyTag{staticLibTag}
580}
581
582// To satisfy the InstallableModule interface
583func (j *Module) DynamicDependencyTags() []blueprint.DependencyTag {
584 return []blueprint.DependencyTag{libTag, sdkLibTag, bootClasspathTag, systemModulesTag,
585 instrumentationForTag, java9LibTag}
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000586}
587
588// Overrides android.ModuleBase.InstallInProduct()
589func (j *Module) InstallInProduct() bool {
590 return j.ProductSpecific()
591}
592
Jihoon Kang85bc1932024-07-01 17:04:46 +0000593var _ android.StubsAvailableModule = (*Module)(nil)
594
595// To safisfy the StubsAvailableModule interface
596func (j *Module) IsStubsModule() bool {
597 return proptools.Bool(j.properties.Is_stubs_module)
598}
599
Jiyong Park92315372021-04-02 08:45:46 +0900600func (j *Module) CheckStableSdkVersion(ctx android.BaseModuleContext) error {
601 sdkVersion := j.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900602 if sdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700603 return nil
604 }
Jiyong Parkf1691d22021-03-29 20:11:58 +0900605 if sdkVersion.Kind == android.SdkCorePlatform {
Paul Duffin1ea7c9f2021-03-15 09:39:13 +0000606 if useLegacyCorePlatformApi(ctx, j.BaseModuleName()) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700607 return fmt.Errorf("non stable SDK %v - uses legacy core platform", sdkVersion)
608 } else {
609 // Treat stable core platform as stable.
610 return nil
611 }
612 } else {
613 return fmt.Errorf("non stable SDK %v", sdkVersion)
614 }
615}
616
617// checkSdkVersions enforces restrictions around SDK dependencies.
618func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
619 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900620 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900621 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700622 ctx.PropertyErrorf("sdk_version",
623 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
624 }
625 }
626 }
627
628 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
629 // See rank() for details.
630 ctx.VisitDirectDeps(func(module android.Module) {
631 tag := ctx.OtherModuleDependencyTag(module)
632 switch module.(type) {
633 // TODO(satayev): cover other types as well, e.g. imports
634 case *Library, *AndroidLibrary:
635 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400636 case bootClasspathTag, sdkLibTag, libTag, staticLibTag, java9LibTag:
Jaewoong Jung26342642021-03-17 15:56:23 -0700637 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
638 }
639 }
640 })
641}
642
643func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900644 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700645 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900646 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700647 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000648 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 -0700649 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000650 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 -0700651 }
652
653 }
654}
655
Mark Whitea15790a2023-08-22 21:28:11 +0000656func (j *Module) checkHeadersOnly(ctx android.ModuleContext) {
657 if _, ok := ctx.Module().(android.SdkContext); ok {
Liz Kammer60772632023-10-05 17:18:44 -0400658 headersOnly := proptools.Bool(j.properties.Headers_only)
Mark Whitea15790a2023-08-22 21:28:11 +0000659 installable := proptools.Bool(j.properties.Installable)
660
661 if headersOnly && installable {
662 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.")
663 }
664 }
665}
666
Jaewoong Jung26342642021-03-17 15:56:23 -0700667func (j *Module) addHostProperties() {
668 j.AddProperties(
669 &j.properties,
yangbill2af0b6e2024-03-15 09:29:29 +0000670 &j.overridableProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700671 &j.protoProperties,
672 &j.usesLibraryProperties,
673 )
674}
675
676func (j *Module) addHostAndDeviceProperties() {
677 j.addHostProperties()
678 j.AddProperties(
679 &j.deviceProperties,
680 &j.dexer.dexProperties,
681 &j.dexpreoptProperties,
682 &j.linter.properties,
683 )
684}
685
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000686// provideHiddenAPIPropertyInfo populates a HiddenAPIPropertyInfo from hidden API properties and
687// makes it available through the hiddenAPIPropertyInfoProvider.
688func (j *Module) provideHiddenAPIPropertyInfo(ctx android.ModuleContext) {
689 hiddenAPIInfo := newHiddenAPIPropertyInfo()
690
691 // Populate with flag file paths from the properties.
692 hiddenAPIInfo.extractFlagFilesFromProperties(ctx, &j.deviceProperties.HiddenAPIFlagFileProperties)
693
694 // Populate with package rules from the properties.
695 hiddenAPIInfo.extractPackageRulesFromProperties(&j.deviceProperties.HiddenAPIPackageProperties)
696
Colin Cross40213022023-12-13 15:19:49 -0800697 android.SetProvider(ctx, hiddenAPIPropertyInfoProvider, hiddenAPIInfo)
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000698}
699
mrziwang9f7b9f42024-07-10 12:18:06 -0700700// helper method for java modules to set OutputFilesProvider
701func setOutputFiles(ctx android.ModuleContext, m Module) {
702 ctx.SetOutputFiles(append(android.Paths{m.outputFile}, m.extraOutputFiles...), "")
703 ctx.SetOutputFiles(android.Paths{m.outputFile}, android.DefaultDistTag)
704 ctx.SetOutputFiles(android.Paths{m.implementationAndResourcesJar}, ".jar")
705 ctx.SetOutputFiles(android.Paths{m.headerJarFile}, ".hjar")
706 if m.dexer.proguardDictionary.Valid() {
707 ctx.SetOutputFiles(android.Paths{m.dexer.proguardDictionary.Path()}, ".proguard_map")
708 }
709 ctx.SetOutputFiles(m.properties.Generated_srcjars, ".generated_srcjars")
710 if m.linter.outputs.xml != nil {
711 ctx.SetOutputFiles(android.Paths{m.linter.outputs.xml}, ".lint")
Jaewoong Jung26342642021-03-17 15:56:23 -0700712 }
713}
714
Jaewoong Jung26342642021-03-17 15:56:23 -0700715func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
716 initJavaModule(module, hod, false)
717}
718
719func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
720 initJavaModule(module, hod, true)
721}
722
723func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
724 multilib := android.MultilibCommon
725 if multiTargets {
726 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
727 } else {
728 android.InitAndroidArchModule(module, hod, multilib)
729 }
730 android.InitDefaultableModule(module)
731}
732
733func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
734 return j.properties.Instrument &&
735 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
736 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
737}
738
Yihan Dong8be09c22024-08-29 15:32:13 +0800739func (j *Module) shouldApiMapper() bool {
740 return j.properties.ApiMapper
741}
742
Jaewoong Jung26342642021-03-17 15:56:23 -0700743func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000744 return j.properties.Supports_static_instrumentation &&
745 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700746 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
747 ctx.Config().UnbundledBuild())
748}
749
750func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
751 // Force enable the instrumentation for java code that is built for APEXes ...
752 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
753 // 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 -0800754 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -0700755 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Jihoon Kang690df2e2024-05-22 04:27:38 +0000756
Jihoon Kang46d66de2024-05-22 22:42:39 +0000757 if j.DirectlyInAnyApex() && !isJacocoAgent && !apexInfo.IsForPlatform() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700758 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
759 return true
760 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
761 return true
762 }
763 }
764 return false
765}
766
Sam Delmerico1e3f78f2022-09-07 12:07:07 -0400767func (j *Module) setInstrument(value bool) {
768 j.properties.Instrument = value
769}
770
Yihan Dong8be09c22024-08-29 15:32:13 +0800771func (j *Module) setApiMapper(value bool) {
772 j.properties.ApiMapper = value
773}
774
Jiyong Park92315372021-04-02 08:45:46 +0900775func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
776 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700777}
778
Jiyong Parkf1691d22021-03-29 20:11:58 +0900779func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700780 return proptools.String(j.deviceProperties.System_modules)
781}
782
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000783func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Spandan Dasb9c58352024-05-13 18:29:45 +0000784 if j.overridableProperties.Min_sdk_version != nil {
785 return android.ApiLevelFrom(ctx, *j.overridableProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700786 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000787 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700788}
789
Yu Liuf2b94012023-09-19 15:09:10 -0700790func (j *Module) GetDeviceProperties() *DeviceProperties {
791 return &j.deviceProperties
792}
793
Spandan Dasa26eda72023-03-02 00:56:06 +0000794func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
795 if j.deviceProperties.Max_sdk_version != nil {
796 return android.ApiLevelFrom(ctx, *j.deviceProperties.Max_sdk_version)
797 }
798 // Default is PrivateApiLevel
799 return android.SdkSpecPrivate.ApiLevel
satayev0a420e72021-11-29 17:25:52 +0000800}
801
Spandan Dasa26eda72023-03-02 00:56:06 +0000802func (j *Module) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
803 if j.deviceProperties.Replace_max_sdk_version_placeholder != nil {
804 return android.ApiLevelFrom(ctx, *j.deviceProperties.Replace_max_sdk_version_placeholder)
805 }
806 // Default is PrivateApiLevel
807 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000808}
809
Jiyong Parkf1691d22021-03-29 20:11:58 +0900810func (j *Module) MinSdkVersionString() string {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000811 return j.minSdkVersion.String()
Jiyong Park92315372021-04-02 08:45:46 +0900812}
813
Spandan Dasca70fc42023-03-01 23:38:49 +0000814func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jiyong Park92315372021-04-02 08:45:46 +0900815 if j.deviceProperties.Target_sdk_version != nil {
Spandan Dasca70fc42023-03-01 23:38:49 +0000816 return android.ApiLevelFrom(ctx, *j.deviceProperties.Target_sdk_version)
Jiyong Park92315372021-04-02 08:45:46 +0900817 }
Spandan Dasca70fc42023-03-01 23:38:49 +0000818 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700819}
820
821func (j *Module) AvailableFor(what string) bool {
822 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
823 // Exception: for hostdex: true libraries, the platform variant is created
824 // even if it's not marked as available to platform. In that case, the platform
825 // variant is used only for the hostdex and not installed to the device.
826 return true
827 }
828 return j.ApexModuleBase.AvailableFor(what)
829}
830
Cole Faustb7493472024-08-28 11:55:52 -0700831func (j *Module) staticLibs(ctx android.BaseModuleContext) []string {
832 return android.RemoveListFromList(j.properties.Static_libs.GetOrDefault(ctx, nil), j.properties.Exclude_static_libs)
833}
834
Jaewoong Jung26342642021-03-17 15:56:23 -0700835func (j *Module) deps(ctx android.BottomUpMutatorContext) {
836 if ctx.Device() {
837 j.linter.deps(ctx)
838
Jiyong Parkf1691d22021-03-29 20:11:58 +0900839 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700840
841 if j.deviceProperties.SyspropPublicStub != "" {
842 // This is a sysprop implementation library that has a corresponding sysprop public
843 // stubs library, and a dependency on it so that dependencies on the implementation can
844 // be forwarded to the public stubs library when necessary.
845 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
846 }
847 }
848
849 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000850
Cole Faustb7493472024-08-28 11:55:52 -0700851 ctx.AddVariationDependencies(nil, staticLibTag, j.staticLibs(ctx)...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700852
853 // Add dependency on libraries that provide additional hidden api annotations.
854 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
855
Kiyoung Kim9743bab2024-03-28 15:44:56 +0900856 if ctx.Config().EnforceInterPartitionJavaSdkLibrary() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700857 // Require java_sdk_library at inter-partition java dependency to ensure stable
858 // interface between partitions. If inter-partition java_library dependency is detected,
859 // raise build error because java_library doesn't have a stable interface.
860 //
861 // Inputs:
862 // PRODUCT_ENFORCE_INTER_PARTITION_JAVA_SDK_LIBRARY
863 // if true, enable enforcement
864 // PRODUCT_INTER_PARTITION_JAVA_LIBRARY_ALLOWLIST
865 // exception list of java_library names to allow inter-partition dependency
866 for idx := range j.properties.Libs {
867 if libDeps[idx] == nil {
868 continue
869 }
870
871 if javaDep, ok := libDeps[idx].(javaSdkLibraryEnforceContext); ok {
872 // java_sdk_library is always allowed at inter-partition dependency.
873 // So, skip check.
874 if _, ok := javaDep.(*SdkLibrary); ok {
875 continue
876 }
877
878 j.checkPartitionsForJavaDependency(ctx, "libs", javaDep)
879 }
880 }
881 }
882
883 // For library dependencies that are component libraries (like stubs), add the implementation
884 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
885 for _, dep := range libDeps {
886 if dep != nil {
887 if component, ok := dep.(SdkLibraryComponentDependency); ok {
888 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000889 // Add library as optional if it's one of the optional compatibility libs or it's
890 // explicitly listed in the optional_uses_libs property.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100891 tag := usesLibReqTag
Jiakai Zhangf98da192024-04-15 11:15:41 +0000892 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) ||
893 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs) {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100894 tag = usesLibOptTag
895 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100896 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700897 }
898 }
899 }
900 }
901
902 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
903 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
904 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
905
906 android.ProtoDeps(ctx, &j.protoProperties)
907 if j.hasSrcExt(".proto") {
908 protoDeps(ctx, &j.protoProperties)
909 }
910
911 if j.hasSrcExt(".kt") {
912 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
913 // Kotlin files
Colin Cross882d6002024-08-14 10:24:06 -0700914 tag := staticLibTag
915 if !BoolDefault(j.properties.Static_kotlin_stdlib, true) {
916 tag = libTag
917 }
918 ctx.AddVariationDependencies(nil, tag,
919 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8", "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700920 }
921
922 // Framework libraries need special handling in static coverage builds: they should not have
923 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
924 // the same jacoco classes coming from different bootclasspath jars.
925 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
926 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
927 j.properties.Instrument = true
928 }
929 } else if j.shouldInstrumentStatic(ctx) {
930 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
931 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700932
Cole Faustb7493472024-08-28 11:55:52 -0700933 if j.useCompose(ctx) {
Colin Crossa1ff7c62021-09-17 14:11:52 -0700934 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
935 "androidx.compose.compiler_compiler-hosted")
936 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700937}
938
939func hasSrcExt(srcs []string, ext string) bool {
940 for _, src := range srcs {
941 if filepath.Ext(src) == ext {
942 return true
943 }
944 }
945
946 return false
947}
948
949func (j *Module) hasSrcExt(ext string) bool {
950 return hasSrcExt(j.properties.Srcs, ext)
951}
952
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100953func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
954 var flags string
955
956 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
957 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
958 flags = "-Wmissing-permission-annotation -Werror"
959 }
960 }
961 return flags
962}
963
Jaewoong Jung26342642021-03-17 15:56:23 -0700964func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000965 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700966
967 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
968 aidlIncludes = append(aidlIncludes,
969 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
970 aidlIncludes = append(aidlIncludes,
971 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
972
973 var flags []string
974 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000975 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700976
977 flags = append(flags, j.deviceProperties.Aidl.Flags...)
978
979 if aidlPreprocess.Valid() {
980 flags = append(flags, "-p"+aidlPreprocess.String())
981 deps = append(deps, aidlPreprocess.Path())
982 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000983 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700984 }
985
986 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000987 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700988 }
989
990 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000991 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700992 }
993
Sam Delmerico2351eac2022-05-24 17:10:02 +0000994 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -0700995 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000996 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -0700997 }
Sam Delmerico2351eac2022-05-24 17:10:02 +0000998 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
999 // add flags for dirs containing AIDL srcs that haven't been specified yet
1000 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -07001001
Zim8774ae12022-08-17 11:46:34 +01001002 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +00001003 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +01001004 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001005 flags = append(flags, "-t")
1006 }
1007
1008 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
1009 flags = append(flags, "--transaction_names")
1010 }
1011
Thiébaud Weksteende8417c2022-02-10 15:41:46 +11001012 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
1013 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
1014 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
1015 }
1016
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001017 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +09001018 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
1019
Jaewoong Jung26342642021-03-17 15:56:23 -07001020 return strings.Join(flags, " "), deps
1021}
1022
1023func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
1024
1025 var flags javaBuilderFlags
1026
1027 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +09001028 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001029
Cole Faust2b1536e2021-06-18 12:25:54 -07001030 epEnabled := j.properties.Errorprone.Enabled
1031 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +01001032 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001033 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1034 }
1035
1036 errorProneFlags := []string{
1037 "-Xplugin:ErrorProne",
1038 "${config.ErrorProneChecks}",
1039 }
1040 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1041
Colin Cross8bf6cad2022-02-28 13:07:03 -08001042 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -07001043 "'" + strings.Join(errorProneFlags, " ") + "'"
1044 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
1045 }
1046
1047 // classpath
1048 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1049 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001050 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001051 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1052 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1053 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1054
1055 flags.processors = append(flags.processors, deps.processorClasses...)
1056 flags.processors = android.FirstUniqueStrings(flags.processors)
1057
1058 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001059 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001060 // Give host-side tools a version of OpenJDK's standard libraries
1061 // close to what they're targeting. As of Dec 2017, AOSP is only
1062 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1063 //
1064 // When building with OpenJDK 8, the following should have no
1065 // effect since those jars would be available by default.
1066 //
1067 // When building with OpenJDK 9 but targeting a version < 1.8,
1068 // putting them on the bootclasspath means that:
1069 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1070 // b) references to existing APIs are not reinterpreted in an
1071 // OpenJDK 9-specific way, eg. calls to subclasses of
1072 // java.nio.Buffer as in http://b/70862583
1073 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1074 flags.bootClasspath = append(flags.bootClasspath,
1075 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1076 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1077 if Bool(j.properties.Use_tools_jar) {
1078 flags.bootClasspath = append(flags.bootClasspath,
1079 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1080 }
1081 }
1082
1083 // systemModules
1084 flags.systemModules = deps.systemModules
1085
Jaewoong Jung26342642021-03-17 15:56:23 -07001086 return flags
1087}
1088
1089func (j *Module) collectJavacFlags(
1090 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1091 // javac flags.
1092 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001093 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001094
Mythri Alle4b9f6182023-10-25 15:17:11 +00001095 needsDebugInfo = false
1096 for _, flag := range javacFlags {
1097 if strings.HasPrefix(flag, "-g") {
1098 needsDebugInfo = true
1099 }
1100 }
1101
1102 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001103 // For non-host binaries, override the -g flag passed globally to remove
1104 // local variable debug info to reduce disk and memory usage.
1105 javacFlags = append(javacFlags, "-g:source,lines")
1106 }
1107 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1108
1109 if flags.javaVersion.usesJavaModules() {
1110 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001111 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1112 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1113 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1114 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001115
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001116 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001117 if j.properties.Patch_module != nil {
1118 // Manually specify build directory in case it is not under the repo root.
1119 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1120 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001121 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001122
Jaewoong Jung26342642021-03-17 15:56:23 -07001123 classPath := flags.classpath.FormJavaClassPath("")
1124 if classPath != "" {
1125 patchPaths = append(patchPaths, classPath)
1126 }
1127 javacFlags = append(
1128 javacFlags,
1129 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1130 }
1131 }
1132
1133 if len(javacFlags) > 0 {
1134 // optimization.
1135 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1136 flags.javacFlags = "$javacFlags"
1137 }
1138
1139 return flags
1140}
1141
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001142func (j *Module) AddJSONData(d *map[string]interface{}) {
1143 (&j.ModuleBase).AddJSONData(d)
1144 (*d)["Java"] = map[string]interface{}{
1145 "SourceExtensions": j.sourceExtensions,
1146 }
1147
1148}
1149
usta0391ca42023-09-19 15:51:59 -04001150func (j *Module) addGeneratedSrcJars(path android.Path) {
1151 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001152}
1153
Colin Crossfdaa6722024-08-23 11:58:08 -07001154func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars, extraDepCombinedJars android.Paths) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001155 // Auto-propagating jarjar rules
1156 jarjarProviderData := j.collectJarJarRules(ctx)
1157 if jarjarProviderData != nil {
1158 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wangddb2ee52024-04-02 16:44:02 +00001159 text := getJarJarRuleText(jarjarProviderData)
1160 if text != "" {
1161 ruleTextFile := android.PathForModuleOut(ctx, "repackaged-jarjar", "repackaging.txt")
1162 android.WriteFileRule(ctx, ruleTextFile, text)
1163 j.repackageJarjarRules = ruleTextFile
Joe Onorato349ae8d2024-02-05 22:46:00 +00001164 }
1165 }
1166
Jaewoong Jung26342642021-03-17 15:56:23 -07001167 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1168
Makoto Onuki7ded3822024-03-28 14:42:20 -07001169 if re := proptools.Bool(j.properties.Ravenizer.Enabled); re {
1170 j.ravenizer.enabled = re
1171 }
1172
Jaewoong Jung26342642021-03-17 15:56:23 -07001173 deps := j.collectDeps(ctx)
1174 flags := j.collectBuilderFlags(ctx, deps)
1175
1176 if flags.javaVersion.usesJavaModules() {
1177 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001178 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1179 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1180 ctx.PropertyErrorf("openjdk9.srcs", "JDK version defaults to higher than 9")
Jaewoong Jung26342642021-03-17 15:56:23 -07001181 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001182
Jaewoong Jung26342642021-03-17 15:56:23 -07001183 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001184 j.sourceExtensions = []string{}
1185 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1186 if hasSrcExt(srcFiles.Strings(), ext) {
1187 j.sourceExtensions = append(j.sourceExtensions, ext)
1188 }
1189 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001190 if hasSrcExt(srcFiles.Strings(), ".proto") {
1191 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1192 }
1193
1194 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, nil)
1195 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1196 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1197 }
1198
Sam Delmerico2351eac2022-05-24 17:10:02 +00001199 aidlSrcs := srcFiles.FilterByExt(".aidl")
1200 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs, aidlSrcs)
1201
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001202 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001203 srcFiles = j.genSources(ctx, srcFiles, flags)
1204
1205 // Collect javac flags only after computing the full set of srcFiles to
1206 // ensure that the --patch-module lookup paths are complete.
1207 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1208
1209 srcJars := srcFiles.FilterByExt(".srcjar")
1210 srcJars = append(srcJars, deps.srcJars...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001211 srcJars = append(srcJars, extraSrcJars...)
Joe Onorato175073c2023-06-01 14:42:59 -07001212 srcJars = append(srcJars, j.properties.Generated_srcjars...)
Colin Crossb0ef30a2021-06-29 10:42:00 -07001213 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001214
1215 if j.properties.Jarjar_rules != nil {
1216 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1217 }
1218
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00001219 jarName := j.Stem() + ".jar"
Jaewoong Jung26342642021-03-17 15:56:23 -07001220
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001221 var uniqueJavaFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001222 set := make(map[string]bool)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001223 for _, v := range srcFiles.FilterByExt(".java") {
Jaewoong Jung26342642021-03-17 15:56:23 -07001224 if _, found := set[v.String()]; !found {
1225 set[v.String()] = true
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001226 uniqueJavaFiles = append(uniqueJavaFiles, v)
Jaewoong Jung26342642021-03-17 15:56:23 -07001227 }
1228 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001229 var uniqueKtFiles android.Paths
1230 for _, v := range srcFiles.FilterByExt(".kt") {
1231 if _, found := set[v.String()]; !found {
1232 set[v.String()] = true
1233 uniqueKtFiles = append(uniqueKtFiles, v)
1234 }
1235 }
1236
1237 var uniqueSrcFiles android.Paths
1238 uniqueSrcFiles = append(uniqueSrcFiles, uniqueJavaFiles...)
1239 uniqueSrcFiles = append(uniqueSrcFiles, uniqueKtFiles...)
1240 j.uniqueSrcFiles = uniqueSrcFiles
Colin Cross40213022023-12-13 15:19:49 -08001241 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: uniqueSrcFiles.Strings()})
Jaewoong Jung26342642021-03-17 15:56:23 -07001242
Colin Crossb5db4012022-03-28 17:12:39 -07001243 // We don't currently run annotation processors in turbine, which means we can't use turbine
1244 // generated header jars when an annotation processor that generates API is enabled. One
1245 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1246 // is used to run all of the annotation processors.
1247 disableTurbine := deps.disableTurbine
1248
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001249 // Collect .java and .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001250 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1251
Colin Cross220a9a12022-03-28 17:08:01 -07001252 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001253
Colin Cross4eae06d2023-06-20 22:40:02 -07001254 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1255 // any dependencies so that it can override any non-final R classes from dependencies with the
1256 // final R classes from the app.
1257 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1258
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001259 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1260
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001261 var localImplementationJars android.Paths
1262
Mark Whitea15790a2023-08-22 21:28:11 +00001263 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001264 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001265 if srcFiles.HasExt(".kt") {
1266 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1267 }
1268 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1269 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1270 }
1271
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001272 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1273
1274 localHeaderJars, combinedHeaderJarFile := j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
Colin Crossedec77c2024-07-26 15:25:40 -07001275 extraCombinedJars)
1276
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001277 combinedHeaderJarFile, jarjared := j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1278 if jarjared {
1279 localHeaderJars = android.Paths{combinedHeaderJarFile}
1280 transitiveStaticLibsHeaderJars = nil
1281 }
1282 combinedHeaderJarFile, repackaged := j.repackageFlagsIfNecessary(ctx, combinedHeaderJarFile, jarName, "repackage-turbine")
1283 if repackaged {
1284 localHeaderJars = android.Paths{combinedHeaderJarFile}
1285 transitiveStaticLibsHeaderJars = nil
1286 }
Mark Whitea15790a2023-08-22 21:28:11 +00001287 if ctx.Failed() {
1288 return
1289 }
Colin Crossedec77c2024-07-26 15:25:40 -07001290 j.headerJarFile = combinedHeaderJarFile
Mark Whitea15790a2023-08-22 21:28:11 +00001291
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001292 if ctx.Config().UseTransitiveJarsInClasspath() {
1293 if len(localHeaderJars) > 0 {
1294 ctx.CheckbuildFile(localHeaderJars...)
1295 } else {
1296 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1297 ctx.UncheckedModule()
1298 }
1299 } else {
1300 ctx.CheckbuildFile(j.headerJarFile)
1301 }
Colin Crossa6182ab2024-08-21 10:47:44 -07001302
Colin Cross7727c7f2024-07-18 15:36:32 -07001303 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001304 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001305 LocalHeaderJars: localHeaderJars,
1306 TransitiveStaticLibsHeaderJars: android.NewDepSet(android.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Cross9ffaf282024-08-12 13:50:09 -07001307 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1308 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001309 AidlIncludeDirs: j.exportAidlIncludeDirs,
1310 ExportedPlugins: j.exportedPluginJars,
1311 ExportedPluginClasses: j.exportedPluginClasses,
1312 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1313 StubsLinkType: j.stubsLinkType,
1314 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Mark Whitea15790a2023-08-22 21:28:11 +00001315 })
1316
1317 j.outputFile = j.headerJarFile
1318 return
1319 }
1320
Jaewoong Jung26342642021-03-17 15:56:23 -07001321 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001322 // When using kotlin sources turbine is used to generate annotation processor sources,
1323 // including for annotation processors that generate API, so we can use turbine for
1324 // java sources too.
1325 disableTurbine = false
1326
Jaewoong Jung26342642021-03-17 15:56:23 -07001327 // user defined kotlin flags.
1328 kotlincFlags := j.properties.Kotlincflags
1329 CheckKotlincFlags(ctx, kotlincFlags)
1330
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001331 // Workaround for KT-46512
1332 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001333
1334 // If there are kotlin files, compile them first but pass all the kotlin and java files
1335 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1336 // won't emit any classes for them.
1337 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1338 if ctx.Device() {
1339 kotlincFlags = append(kotlincFlags, "-no-jdk")
1340 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001341
1342 for _, plugin := range deps.kotlinPlugins {
1343 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1344 }
1345 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1346
Jaewoong Jung26342642021-03-17 15:56:23 -07001347 if len(kotlincFlags) > 0 {
1348 // optimization.
1349 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1350 flags.kotlincFlags += "$kotlincFlags"
1351 }
1352
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001353 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001354 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1355
Jaewoong Jung26342642021-03-17 15:56:23 -07001356 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1357 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1358
Isaac Chioua23d9942022-04-06 06:14:38 +00001359 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001360 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001361 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1362 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001363 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001364 srcJars = append(srcJars, kaptSrcJar)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001365 localImplementationJars = append(localImplementationJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001366 // Disable annotation processing in javac, it's already been handled by kapt
1367 flags.processorPath = nil
1368 flags.processors = nil
1369 }
1370
1371 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001372 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001373 kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001374 if ctx.Failed() {
1375 return
1376 }
1377
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001378 kotlinJarPath, _ := j.repackageFlagsIfNecessary(ctx, kotlinJar, jarName, "kotlinc")
Zi Wangddb2ee52024-04-02 16:44:02 +00001379
Isaac Chioua23d9942022-04-06 06:14:38 +00001380 // Make javac rule depend on the kotlinc rule
1381 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1382
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001383 localImplementationJars = append(localImplementationJars, kotlinJarPath)
1384
Colin Cross220a9a12022-03-28 17:08:01 -07001385 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001386 }
1387
Jaewoong Jung26342642021-03-17 15:56:23 -07001388 j.compiledSrcJars = srcJars
1389
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001390 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1391
Jaewoong Jung26342642021-03-17 15:56:23 -07001392 enableSharding := false
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001393 var localHeaderJars android.Paths
1394 var shardingHeaderJars android.Paths
1395 var repackagedHeaderJarFile android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001396 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001397 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1398 enableSharding = true
1399 // Formerly, there was a check here that prevented annotation processors
1400 // from being used when sharding was enabled, as some annotation processors
1401 // do not function correctly in sharded environments. It was removed to
1402 // allow for the use of annotation processors that do function correctly
1403 // with sharding enabled. See: b/77284273.
1404 }
Colin Crossd1d8f172024-07-29 11:30:29 -07001405 extraJars := slices.Clone(kotlinHeaderJars)
Colin Crossd1d8f172024-07-29 11:30:29 -07001406 extraJars = append(extraJars, extraCombinedJars...)
Colin Crossedec77c2024-07-26 15:25:40 -07001407 var combinedHeaderJarFile android.Path
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001408 localHeaderJars, combinedHeaderJarFile = j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
1409 shardingHeaderJars = localHeaderJars
Colin Crossedec77c2024-07-26 15:25:40 -07001410
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001411 var jarjared bool
1412 j.headerJarFile, jarjared = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1413 if jarjared {
1414 // jarjar modifies transitive static dependencies, use the combined header jar and drop the transitive
1415 // static libs header jars.
1416 localHeaderJars = android.Paths{j.headerJarFile}
1417 transitiveStaticLibsHeaderJars = nil
1418 }
1419 var repackaged bool
1420 repackagedHeaderJarFile, repackaged = j.repackageFlagsIfNecessary(ctx, j.headerJarFile, jarName, "turbine")
1421 if repackaged {
1422 // repackage modifies transitive static dependencies, use the combined header jar and drop the transitive
1423 // static libs header jars.
1424 // TODO(b/356688296): this shouldn't export both the unmodified and repackaged header jars
1425 localHeaderJars = android.Paths{j.headerJarFile, repackagedHeaderJarFile}
1426 transitiveStaticLibsHeaderJars = nil
1427 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001428 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001429 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001430 hasErrorproneableFiles := false
1431 for _, ext := range j.sourceExtensions {
1432 if ext != ".proto" && ext != ".aidl" {
1433 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1434 // compile, and it's not useful to have warnings on these generated sources.
1435 hasErrorproneableFiles = true
1436 break
1437 }
1438 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001439 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001440 if Bool(j.properties.Errorprone.Enabled) {
1441 // If error-prone is enabled, enable errorprone flags on the regular
1442 // build.
1443 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001444 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faust75fffb12021-06-13 15:23:16 -07001445 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1446 // a new jar file just for compiling with the errorprone compiler to.
1447 // This is because we don't want to cause the java files to get completely
1448 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1449 // We also don't want to run this if errorprone is enabled by default for
1450 // this module, or else we could have duplicated errorprone messages.
1451 errorproneFlags := enableErrorproneFlags(flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001452 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001453 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001454
Vadim Spivak3c496f02023-06-08 06:14:59 +00001455 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
Cole Faust75fffb12021-06-13 15:23:16 -07001456 "errorprone", "errorprone")
1457
Jaewoong Jung26342642021-03-17 15:56:23 -07001458 extraJarDeps = append(extraJarDeps, errorprone)
1459 }
1460
1461 if enableSharding {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001462 if len(shardingHeaderJars) > 0 {
1463 flags.classpath = append(classpath(slices.Clone(shardingHeaderJars)), flags.classpath...)
Colin Cross3d56ed52021-11-18 22:23:12 -08001464 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001465 shardSize := int(*(j.properties.Javac_shard_size))
1466 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001467 if len(uniqueJavaFiles) > 0 {
1468 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001469 for idx, shardSrc := range shardSrcs {
1470 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1471 nil, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001472 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
1473 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001474 }
1475 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001476 // Assume approximately 5 sources per srcjar.
1477 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1478 // 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 -07001479 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001480 startIdx := len(shardSrcs)
1481 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1482 for idx, shardSrcJars := range shardSrcJarsList {
1483 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1484 nil, shardSrcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001485 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
1486 localImplementationJars = append(localImplementationJars, classes)
Colin Crossa052ddb2023-09-25 21:46:58 -07001487 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001488 }
1489 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001490 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001491 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
1492 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001493 }
1494 if ctx.Failed() {
1495 return
1496 }
1497 }
1498
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001499 localImplementationJars = append(localImplementationJars, extraCombinedJars...)
Colin Crossfd620b22024-02-23 10:05:21 -08001500
Jaewoong Jung26342642021-03-17 15:56:23 -07001501 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1502
1503 var includeSrcJar android.WritablePath
1504 if Bool(j.properties.Include_srcs) {
1505 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1506 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1507 }
1508
1509 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1510 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
1511 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
1512 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1513
1514 var resArgs []string
1515 var resDeps android.Paths
1516
1517 resArgs = append(resArgs, dirArgs...)
1518 resDeps = append(resDeps, dirDeps...)
1519
1520 resArgs = append(resArgs, fileArgs...)
1521 resDeps = append(resDeps, fileDeps...)
1522
1523 resArgs = append(resArgs, extraArgs...)
1524 resDeps = append(resDeps, extraDeps...)
1525
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001526 var localResourceJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001527 if len(resArgs) > 0 {
1528 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1529 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001530 if ctx.Failed() {
1531 return
1532 }
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001533 localResourceJars = append(localResourceJars, resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001534 }
1535
Jaewoong Jung26342642021-03-17 15:56:23 -07001536 if Bool(j.properties.Include_srcs) {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001537 localResourceJars = append(localResourceJars, includeSrcJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001538 }
1539
1540 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1541 if len(services) > 0 {
1542 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1543 var zipargs []string
1544 for _, file := range services {
1545 serviceFile := file.String()
1546 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1547 }
1548 rule := zip
1549 args := map[string]string{
1550 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1551 }
1552 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1553 rule = zipRE
1554 args["implicits"] = strings.Join(services.Strings(), ",")
1555 }
1556 ctx.Build(pctx, android.BuildParams{
1557 Rule: rule,
1558 Output: servicesJar,
1559 Implicits: services,
1560 Args: args,
1561 })
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001562 localResourceJars = append(localResourceJars, servicesJar)
1563 }
1564
1565 completeStaticLibsResourceJars := android.NewDepSet(android.PREORDER, localResourceJars, deps.transitiveStaticLibsResourceJars)
1566
1567 var combinedResourceJar android.Path
1568 var resourceJars android.Paths
1569 if ctx.Config().UseTransitiveJarsInClasspath() {
1570 resourceJars = completeStaticLibsResourceJars.ToList()
1571 } else {
1572 resourceJars = append(slices.Clone(localResourceJars), deps.staticResourceJars...)
1573 }
1574 if len(resourceJars) == 1 {
1575 combinedResourceJar = resourceJars[0]
1576 } else if len(resourceJars) > 0 {
1577 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1578 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1579 false, nil, nil)
1580 combinedResourceJar = combinedJar
1581 }
1582
1583 manifest := j.overrideManifest
1584 if !manifest.Valid() && j.properties.Manifest != nil {
1585 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Jaewoong Jung26342642021-03-17 15:56:23 -07001586 }
1587
1588 // Combine the classes built from sources, any manifests, and any static libraries into
1589 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross7707b242024-07-26 12:02:36 -07001590 var outputFile android.Path
Jaewoong Jung26342642021-03-17 15:56:23 -07001591
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001592 completeStaticLibsImplementationJars := android.NewDepSet(android.PREORDER, localImplementationJars, deps.transitiveStaticLibsImplementationJars)
1593
1594 var jars android.Paths
1595 if ctx.Config().UseTransitiveJarsInClasspath() {
1596 jars = completeStaticLibsImplementationJars.ToList()
1597 } else {
1598 jars = append(slices.Clone(localImplementationJars), deps.staticJars...)
1599 }
1600
1601 jars = append(jars, extraDepCombinedJars...)
1602
Jaewoong Jung26342642021-03-17 15:56:23 -07001603 if len(jars) == 1 && !manifest.Valid() {
1604 // Optimization: skip the combine step as there is nothing to do
1605 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1606 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001607 // any if len(extraJars) == 0.
Jaewoong Jung26342642021-03-17 15:56:23 -07001608
Jihoon Kang1147b312023-06-08 23:25:57 +00001609 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1610 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1611 // either with .from-source or .from-text suffix.
1612 // outputFile should be agnostic to the build configuration,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001613 // thus copy the single input static lib in order to prevent the static lib from being exposed
Jihoon Kang1147b312023-06-08 23:25:57 +00001614 // to the copy rules.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001615 if stub, _ := moduleStubLinkType(j); stub {
1616 copiedJar := android.PathForModuleOut(ctx, "combined", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001617 ctx.Build(pctx, android.BuildParams{
1618 Rule: android.Cp,
1619 Input: jars[0],
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001620 Output: copiedJar,
Jaewoong Jung26342642021-03-17 15:56:23 -07001621 })
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001622 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, android.Paths{copiedJar}, nil)
1623 outputFile = copiedJar
Colin Cross7707b242024-07-26 12:02:36 -07001624 } else {
1625 outputFile = jars[0]
Jaewoong Jung26342642021-03-17 15:56:23 -07001626 }
1627 } else {
1628 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1629 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1630 false, nil, nil)
Colin Cross7707b242024-07-26 12:02:36 -07001631 outputFile = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001632 }
1633
1634 // jarjar implementation jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001635 jarjarFile, jarjarred := j.jarjarIfNecessary(ctx, outputFile, jarName, "")
1636 if jarjarred {
1637 localImplementationJars = android.Paths{jarjarFile}
1638 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
1639 }
Colin Crossedec77c2024-07-26 15:25:40 -07001640 outputFile = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001641
Colin Crossedec77c2024-07-26 15:25:40 -07001642 // jarjar resource jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001643 if combinedResourceJar != nil {
1644 resourceJarJarFile, jarjarred := j.jarjarIfNecessary(ctx, combinedResourceJar, jarName, "resource")
1645 combinedResourceJar = resourceJarJarFile
1646 if jarjarred {
1647 localResourceJars = android.Paths{resourceJarJarFile}
1648 completeStaticLibsResourceJars = android.NewDepSet(android.PREORDER, localResourceJars, nil)
1649 }
Colin Crossedec77c2024-07-26 15:25:40 -07001650 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001651
Colin Crossedec77c2024-07-26 15:25:40 -07001652 if ctx.Failed() {
1653 return
Jaewoong Jung26342642021-03-17 15:56:23 -07001654 }
1655
Makoto Onuki7ded3822024-03-28 14:42:20 -07001656 if j.ravenizer.enabled {
1657 ravenizerInput := outputFile
1658 ravenizerOutput := android.PathForModuleOut(ctx, "ravenizer", jarName)
1659 ctx.Build(pctx, android.BuildParams{
1660 Rule: ravenizer,
1661 Description: "ravenizer",
1662 Input: ravenizerInput,
1663 Output: ravenizerOutput,
1664 })
1665 outputFile = ravenizerOutput
Colin Cross7e863852024-09-06 14:42:38 -07001666 localImplementationJars = android.Paths{ravenizerOutput}
1667 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
Makoto Onuki7ded3822024-03-28 14:42:20 -07001668 }
1669
Yihan Dong8be09c22024-08-29 15:32:13 +08001670 if j.shouldApiMapper() {
1671 inputFile := outputFile
1672 apiMapperFile := android.PathForModuleOut(ctx, "apimapper", jarName)
1673 ctx.Build(pctx, android.BuildParams{
1674 Rule: apimapper,
1675 Description: "apimapper",
1676 Input: inputFile,
1677 Output: apiMapperFile,
1678 })
1679 outputFile = apiMapperFile
Colin Cross7e863852024-09-06 14:42:38 -07001680 localImplementationJars = android.Paths{apiMapperFile}
1681 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
Yihan Dong8be09c22024-08-29 15:32:13 +08001682 }
1683
Jaewoong Jung26342642021-03-17 15:56:23 -07001684 // Check package restrictions if necessary.
1685 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001686 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001687 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001688
1689 // Create a rule to copy the output jar to another path and add a validate dependency that
1690 // will check that the jar only contains the permitted packages. The new location will become
1691 // the output file of this module.
1692 inputFile := outputFile
Colin Cross7707b242024-07-26 12:02:36 -07001693 packageCheckOutputFile := android.PathForModuleOut(ctx, "package-check", jarName)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001694 ctx.Build(pctx, android.BuildParams{
1695 Rule: android.Cp,
1696 Input: inputFile,
Colin Cross7707b242024-07-26 12:02:36 -07001697 Output: packageCheckOutputFile,
Paul Duffin08a18bf2021-10-01 13:19:58 +01001698 // Make sure that any dependency on the output file will cause ninja to run the package check
1699 // rule.
1700 Validation: pkgckFile,
1701 })
Colin Cross7707b242024-07-26 12:02:36 -07001702 outputFile = packageCheckOutputFile
Colin Cross7e863852024-09-06 14:42:38 -07001703 localImplementationJars = android.Paths{packageCheckOutputFile}
1704 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001705
1706 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001707 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001708
1709 if ctx.Failed() {
1710 return
1711 }
1712 }
1713
1714 j.implementationJarFile = outputFile
1715 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001716 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1717 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1718 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1719 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1720 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1721 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1722 j.headerJarFile = headerJarFile
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001723 if len(localImplementationJars) == 1 && ctx.Config().UseTransitiveJarsInClasspath() {
1724 localHeaderJarFile := android.PathForModuleOut(ctx, "local-javac-header", jarName)
1725 convertImplementationJarToHeaderJar(ctx, localImplementationJars[0], localHeaderJarFile)
1726 localHeaderJars = append(localHeaderJars, localHeaderJarFile)
1727 } else {
1728 localHeaderJars = append(localHeaderJars, headerJarFile)
1729 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001730 }
1731
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001732 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1733 specs := j.jacocoModuleToZipCommand(ctx)
1734 if ctx.Failed() {
1735 return
1736 }
1737
Colin Crossb323c912024-09-24 15:21:00 -07001738 completeStaticLibsImplementationJarsToCombine := completeStaticLibsImplementationJars
1739
Jaewoong Jung26342642021-03-17 15:56:23 -07001740 if j.shouldInstrument(ctx) {
Colin Crossb323c912024-09-24 15:21:00 -07001741 instrumentedOutputFile := j.instrument(ctx, flags, outputFile, jarName, specs)
1742 completeStaticLibsImplementationJarsToCombine = android.NewDepSet(android.PREORDER, android.Paths{instrumentedOutputFile}, nil)
1743 outputFile = instrumentedOutputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001744 }
1745
1746 // merge implementation jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001747 var implementationAndResourcesJarsToCombine android.Paths
1748 if ctx.Config().UseTransitiveJarsInClasspath() {
1749 resourceJars := completeStaticLibsResourceJars.ToList()
1750 if len(resourceJars) > 0 {
Colin Crossb323c912024-09-24 15:21:00 -07001751 implementationAndResourcesJarsToCombine = append(resourceJars, completeStaticLibsImplementationJarsToCombine.ToList()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001752 implementationAndResourcesJarsToCombine = append(implementationAndResourcesJarsToCombine, extraDepCombinedJars...)
1753 }
1754 } else {
1755 if combinedResourceJar != nil {
1756 implementationAndResourcesJarsToCombine = android.Paths{combinedResourceJar, outputFile}
1757 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001758 }
1759
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001760 if len(implementationAndResourcesJarsToCombine) > 0 {
1761 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
1762 TransformJarsToJar(ctx, combinedJar, "for resources", implementationAndResourcesJarsToCombine, manifest,
1763 false, nil, nil)
1764 outputFile = combinedJar
1765 }
1766
1767 j.implementationAndResourcesJar = outputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001768
1769 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001770 compileDex := j.dexProperties.Compile_dex
Colin Crossff694a82023-12-13 15:54:49 -08001771 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -07001772 if j.DirectlyInAnyApex() && !apexInfo.IsForPlatform() {
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001773 if compileDex == nil {
1774 compileDex = proptools.BoolPtr(true)
Jaewoong Jung26342642021-03-17 15:56:23 -07001775 }
1776 if j.deviceProperties.Hostdex == nil {
1777 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1778 }
1779 }
1780
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001781 if ctx.Device() && (Bool(j.properties.Installable) || Bool(compileDex)) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001782 if j.hasCode(ctx) {
1783 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001784 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001785 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1786 }
1787 // Dex compilation
Colin Cross7707b242024-07-26 12:02:36 -07001788 var dexOutputFile android.Path
Spandan Dasc404cc72023-02-23 18:05:05 +00001789 params := &compileDexParams{
1790 flags: flags,
1791 sdkVersion: j.SdkVersion(ctx),
1792 minSdkVersion: j.MinSdkVersion(ctx),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001793 classesJar: outputFile,
Spandan Dasc404cc72023-02-23 18:05:05 +00001794 jarName: jarName,
1795 }
Spandan Das15a67112024-05-30 00:07:40 +00001796 if j.GetProfileGuided() && j.optimizeOrObfuscateEnabled() && !j.EnableProfileRewriting() {
1797 ctx.PropertyErrorf("enable_profile_rewriting",
1798 "Enable_profile_rewriting must be true when profile_guided dexpreopt and R8 optimization/obfuscation is turned on. The attached profile should be sourced from an unoptimized/unobfuscated APK.",
1799 )
1800 }
Spandan Das3dbda182024-05-20 22:23:10 +00001801 if j.EnableProfileRewriting() {
1802 profile := j.GetProfile()
1803 if profile == "" || !j.GetProfileGuided() {
1804 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1805 }
1806 params.artProfileInput = &profile
1807 }
1808 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001809 if ctx.Failed() {
1810 return
1811 }
1812
Spandan Das3dbda182024-05-20 22:23:10 +00001813 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1814 if dexArtProfileOutput != nil {
Colin Cross7707b242024-07-26 12:02:36 -07001815 j.dexpreopter.SetRewrittenProfile(dexArtProfileOutput)
Spandan Das3dbda182024-05-20 22:23:10 +00001816 }
1817
Jaewoong Jung26342642021-03-17 15:56:23 -07001818 // merge dex jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001819 var dexAndResourceJarsToCombine android.Paths
1820 if ctx.Config().UseTransitiveJarsInClasspath() {
1821 resourceJars := completeStaticLibsResourceJars.ToList()
1822 if len(resourceJars) > 0 {
1823 dexAndResourceJarsToCombine = append(android.Paths{dexOutputFile}, resourceJars...)
1824 }
1825 } else {
1826 if combinedResourceJar != nil {
1827 dexAndResourceJarsToCombine = android.Paths{dexOutputFile, combinedResourceJar}
1828 }
1829 }
1830 if len(dexAndResourceJarsToCombine) > 0 {
Colin Cross7707b242024-07-26 12:02:36 -07001831 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001832 TransformJarsToJar(ctx, combinedJar, "for dex resources", dexAndResourceJarsToCombine, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07001833 false, nil, nil)
1834 if *j.dexProperties.Uncompress_dex {
Colin Cross7707b242024-07-26 12:02:36 -07001835 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
Cole Faust51d7bfd2023-09-07 05:31:32 +00001836 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001837 dexOutputFile = combinedAlignedJar
1838 } else {
1839 dexOutputFile = combinedJar
1840 }
1841 }
1842
Paul Duffin4de94502021-05-16 05:21:16 +01001843 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001844
1845 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001846
1847 // Encode hidden API flags in dex file, if needed.
1848 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1849
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001850 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001851
1852 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001853 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1854 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1855 libName = strings.TrimSuffix(libName, ".impl")
1856 }
1857 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001858
1859 outputFile = dexOutputFile
Colin Crossa6182ab2024-08-21 10:47:44 -07001860
1861 ctx.CheckbuildFile(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001862 } else {
1863 // There is no code to compile into a dex jar, make sure the resources are propagated
1864 // to the APK if this is an app.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001865 j.dexJarFile = makeDexJarPathFromPath(combinedResourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001866 }
1867
1868 if ctx.Failed() {
1869 return
1870 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001871 }
1872
1873 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001874 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001875 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001876 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001877 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001878 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001879 }
1880 }
1881
1882 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001883 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1884 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001885 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1886 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001887 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001888 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001889 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001890 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001891 j.linter.javaLanguageLevel = flags.javaVersion.String()
1892 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001893 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001894 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1895 j.linter.buildModuleReportZip = true
1896 }
1897 j.linter.lint(ctx)
1898 }
1899
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001900 j.collectTransitiveSrcFiles(ctx, srcFiles)
1901
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001902 if ctx.Config().UseTransitiveJarsInClasspath() {
1903 if len(localImplementationJars) > 0 || len(localResourceJars) > 0 || len(localHeaderJars) > 0 {
1904 ctx.CheckbuildFile(localImplementationJars...)
1905 ctx.CheckbuildFile(localResourceJars...)
1906 ctx.CheckbuildFile(localHeaderJars...)
1907 } else {
1908 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1909 ctx.UncheckedModule()
1910 }
1911 } else {
1912 ctx.CheckbuildFile(j.implementationJarFile)
1913 ctx.CheckbuildFile(j.headerJarFile)
1914 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001915
Colin Cross7727c7f2024-07-18 15:36:32 -07001916 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001917 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1918 RepackagedHeaderJars: android.PathsIfNonNil(repackagedHeaderJarFile),
1919
1920 LocalHeaderJars: localHeaderJars,
1921 TransitiveStaticLibsHeaderJars: android.NewDepSet(android.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
1922 TransitiveStaticLibsImplementationJars: completeStaticLibsImplementationJars,
1923 TransitiveStaticLibsResourceJars: completeStaticLibsResourceJars,
1924
Colin Cross9ffaf282024-08-12 13:50:09 -07001925 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1926 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001927 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1928 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001929 ResourceJars: android.PathsIfNonNil(combinedResourceJar),
Jihoon Kang705e63e2024-03-13 01:21:16 +00001930 AidlIncludeDirs: j.exportAidlIncludeDirs,
1931 SrcJarArgs: j.srcJarArgs,
1932 SrcJarDeps: j.srcJarDeps,
1933 TransitiveSrcFiles: j.transitiveSrcFiles,
1934 ExportedPlugins: j.exportedPluginJars,
1935 ExportedPluginClasses: j.exportedPluginClasses,
1936 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1937 JacocoReportClassesFile: j.jacocoReportClassesFile,
1938 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001939 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001940 })
1941
1942 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1943 j.outputFile = outputFile.WithoutRel()
1944}
1945
Cole Faustb7493472024-08-28 11:55:52 -07001946func (j *Module) useCompose(ctx android.BaseModuleContext) bool {
1947 return android.InList("androidx.compose.runtime_runtime", j.staticLibs(ctx))
Colin Crossa1ff7c62021-09-17 14:11:52 -07001948}
1949
Colin Crosscde55342024-03-27 14:11:51 -07001950func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []*android.DepSet[android.Path]) {
Sam Delmerico95d70942023-08-02 18:00:35 -04001951 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -08001952 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001953 depTag := ctx.OtherModuleDependencyTag(m)
1954
1955 if depProguardInfo.UnconditionallyExportedProguardFlags != nil {
1956 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1957 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1958 }
1959
1960 if depTag == staticLibTag && depProguardInfo.ProguardFlagsFiles != nil {
1961 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
1962 }
1963 })
1964
Colin Crosscde55342024-03-27 14:11:51 -07001965 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
1966}
1967
1968func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
1969 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
1970
Sam Delmerico95d70942023-08-02 18:00:35 -04001971 directUnconditionalExportedFlags := android.Paths{}
1972 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
1973 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
1974 if exportUnconditionally {
1975 // if we explicitly export, then our unconditional exports are the same as our transitive flags
1976 transitiveUnconditionalExportedFlags = transitiveProguardFlags
1977 directUnconditionalExportedFlags = proguardFlagsForThisModule
1978 }
1979
1980 return ProguardSpecInfo{
1981 Export_proguard_flags_files: exportUnconditionally,
1982 ProguardFlagsFiles: android.NewDepSet[android.Path](
1983 android.POSTORDER,
1984 proguardFlagsForThisModule,
1985 transitiveProguardFlags,
1986 ),
1987 UnconditionallyExportedProguardFlags: android.NewDepSet[android.Path](
1988 android.POSTORDER,
1989 directUnconditionalExportedFlags,
1990 transitiveUnconditionalExportedFlags,
1991 ),
1992 }
1993
1994}
1995
Cole Faust75fffb12021-06-13 15:23:16 -07001996// Returns a copy of the supplied flags, but with all the errorprone-related
1997// fields copied to the regular build's fields.
1998func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
1999 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
2000
2001 if len(flags.errorProneExtraJavacFlags) > 0 {
2002 if len(flags.javacFlags) > 0 {
2003 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
2004 } else {
2005 flags.javacFlags = flags.errorProneExtraJavacFlags
2006 }
2007 }
2008 return flags
2009}
2010
Jaewoong Jung26342642021-03-17 15:56:23 -07002011func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
Colin Cross7707b242024-07-26 12:02:36 -07002012 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002013
2014 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00002015 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002016 if idx >= 0 {
2017 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00002018 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002019 jarName += strconv.Itoa(idx)
2020 }
2021
Colin Cross7707b242024-07-26 12:02:36 -07002022 classes := android.PathForModuleOut(ctx, "javac", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00002023 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07002024
Cole Faust9decf832024-06-11 11:45:53 -07002025 if ctx.Config().EmitXrefRules() && ctx.Module() == ctx.PrimaryModule() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002026 extractionFile := android.PathForModuleOut(ctx, kzipName)
2027 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
2028 j.kytheFiles = append(j.kytheFiles, extractionFile)
2029 }
2030
Vadim Spivak3c496f02023-06-08 06:14:59 +00002031 if len(flags.processorPath) > 0 {
2032 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
2033 }
2034
Jaewoong Jung26342642021-03-17 15:56:23 -07002035 return classes
2036}
2037
2038// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
2039// since some of these flags may be used internally.
2040func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
2041 for _, flag := range flags {
2042 flag = strings.TrimSpace(flag)
2043
2044 if !strings.HasPrefix(flag, "-") {
2045 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
2046 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
2047 ctx.PropertyErrorf("kotlincflags",
2048 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
2049 } else if inList(flag, config.KotlincIllegalFlags) {
2050 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
2051 } else if flag == "-include-runtime" {
2052 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
2053 } else {
2054 args := strings.Split(flag, " ")
2055 if args[0] == "-kotlin-home" {
2056 ctx.PropertyErrorf("kotlincflags",
2057 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
2058 }
2059 }
2060 }
2061}
2062
2063func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
2064 deps deps, flags javaBuilderFlags, jarName string,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002065 extraJars android.Paths) (localHeaderJars android.Paths, combinedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002066
Jaewoong Jung26342642021-03-17 15:56:23 -07002067 if len(srcFiles) > 0 || len(srcJars) > 0 {
2068 // Compile java sources into turbine.jar.
2069 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
2070 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002071 localHeaderJars = append(localHeaderJars, turbineJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07002072 }
2073
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002074 localHeaderJars = append(localHeaderJars, extraJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002075
2076 // Combine any static header libraries into classes-header.jar. If there is only
2077 // one input jar this step will be skipped.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002078 var jars android.Paths
2079 if ctx.Config().UseTransitiveJarsInClasspath() {
2080 depSet := android.NewDepSet(android.PREORDER, localHeaderJars, deps.transitiveStaticLibsHeaderJars)
2081 jars = depSet.ToList()
2082 } else {
2083 jars = append(slices.Clone(localHeaderJars), deps.staticHeaderJars...)
2084 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002085
2086 // we cannot skip the combine step for now if there is only one jar
2087 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
Colin Crossedec77c2024-07-26 15:25:40 -07002088 combinedHeaderJarOutputPath := android.PathForModuleOut(ctx, "turbine-combined", jarName)
2089 TransformJarsToJar(ctx, combinedHeaderJarOutputPath, "for turbine", jars, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07002090 false, nil, []string{"META-INF/TRANSITIVE"})
Jaewoong Jung26342642021-03-17 15:56:23 -07002091
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002092 return localHeaderJars, combinedHeaderJarOutputPath
Jaewoong Jung26342642021-03-17 15:56:23 -07002093}
2094
2095func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross7707b242024-07-26 12:02:36 -07002096 classesJar android.Path, jarName string, specs string) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002097
2098 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Cross7707b242024-07-26 12:02:36 -07002099 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07002100
2101 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
2102
2103 j.jacocoReportClassesFile = jacocoReportClassesFile
2104
2105 return instrumentedJar
2106}
2107
Colin Cross9ffaf282024-08-12 13:50:09 -07002108type providesTransitiveHeaderJarsForR8 struct {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002109 // set of header jars for all transitive libs deps
Colin Cross9ffaf282024-08-12 13:50:09 -07002110 transitiveLibsHeaderJarsForR8 *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002111 // set of header jars for all transitive static libs deps
Colin Cross9ffaf282024-08-12 13:50:09 -07002112 transitiveStaticLibsHeaderJarsForR8 *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002113}
2114
Colin Cross9ffaf282024-08-12 13:50:09 -07002115// collectTransitiveHeaderJarsForR8 visits direct dependencies and collects all transitive libs and static_libs
2116// header jars. The semantics of the collected jars are odd (it collects combined jars that contain the static
2117// libs, but also the static libs, and it collects transitive libs dependencies of static_libs), so these
2118// are only used to expand the --lib arguments to R8.
2119func (j *providesTransitiveHeaderJarsForR8) collectTransitiveHeaderJarsForR8(ctx android.ModuleContext) {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002120 directLibs := android.Paths{}
2121 directStaticLibs := android.Paths{}
Colin Crossc85750b2022-04-21 12:50:51 -07002122 transitiveLibs := []*android.DepSet[android.Path]{}
2123 transitiveStaticLibs := []*android.DepSet[android.Path]{}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002124 ctx.VisitDirectDeps(func(module android.Module) {
2125 // don't add deps of the prebuilt version of the same library
2126 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
2127 return
2128 }
2129
Colin Cross7727c7f2024-07-18 15:36:32 -07002130 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2131 tag := ctx.OtherModuleDependencyTag(module)
2132 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
2133 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
2134 directLibs = append(directLibs, dep.HeaderJars...)
2135 } else if tag == staticLibTag {
2136 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
2137 } else {
2138 // Don't propagate transitive libs for other kinds of dependencies.
2139 return
2140 }
Jared Dukeefb6d602023-10-27 18:47:10 +00002141
Colin Cross9ffaf282024-08-12 13:50:09 -07002142 if dep.TransitiveLibsHeaderJarsForR8 != nil {
2143 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJarsForR8)
Colin Cross7727c7f2024-07-18 15:36:32 -07002144 }
Colin Cross9ffaf282024-08-12 13:50:09 -07002145 if dep.TransitiveStaticLibsHeaderJarsForR8 != nil {
2146 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJarsForR8)
Colin Cross7727c7f2024-07-18 15:36:32 -07002147 }
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002148
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002149 }
2150 })
Colin Cross9ffaf282024-08-12 13:50:09 -07002151 j.transitiveLibsHeaderJarsForR8 = android.NewDepSet(android.POSTORDER, directLibs, transitiveLibs)
2152 j.transitiveStaticLibsHeaderJarsForR8 = android.NewDepSet(android.POSTORDER, directStaticLibs, transitiveStaticLibs)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002153}
2154
Jaewoong Jung26342642021-03-17 15:56:23 -07002155func (j *Module) HeaderJars() android.Paths {
2156 if j.headerJarFile == nil {
2157 return nil
2158 }
2159 return android.Paths{j.headerJarFile}
2160}
2161
2162func (j *Module) ImplementationJars() android.Paths {
2163 if j.implementationJarFile == nil {
2164 return nil
2165 }
2166 return android.Paths{j.implementationJarFile}
2167}
2168
Spandan Das59a4a2b2024-01-09 21:35:56 +00002169func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002170 return j.dexJarFile
2171}
2172
2173func (j *Module) DexJarInstallPath() android.Path {
2174 return j.installFile
2175}
2176
2177func (j *Module) ImplementationAndResourcesJars() android.Paths {
2178 if j.implementationAndResourcesJar == nil {
2179 return nil
2180 }
2181 return android.Paths{j.implementationAndResourcesJar}
2182}
2183
2184func (j *Module) AidlIncludeDirs() android.Paths {
2185 // exportAidlIncludeDirs is type android.Paths already
2186 return j.exportAidlIncludeDirs
2187}
2188
2189func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2190 return j.classLoaderContexts
2191}
2192
2193// Collect information for opening IDE project files in java/jdeps.go.
Cole Faustb36d31d2024-08-27 16:04:28 -07002194func (j *Module) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002195 // jarjar rules will repackage the sources. To prevent misleading results, IdeInfo should contain the
2196 // repackaged jar instead of the input sources.
Jaewoong Jung26342642021-03-17 15:56:23 -07002197 if j.expandJarjarRules != nil {
2198 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002199 dpInfo.Jars = append(dpInfo.Jars, j.headerJarFile.String())
2200 } else {
2201 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2202 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2203 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002204 }
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002205 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2206 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Cole Faustb7493472024-08-28 11:55:52 -07002207 dpInfo.Static_libs = append(dpInfo.Static_libs, j.staticLibs(ctx)...)
Yikef6282022022-04-13 20:41:01 +08002208 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002209}
2210
2211func (j *Module) CompilerDeps() []string {
Spandan Das8aac9932024-07-18 23:14:13 +00002212 return j.compileDepNames
Jaewoong Jung26342642021-03-17 15:56:23 -07002213}
2214
2215func (j *Module) hasCode(ctx android.ModuleContext) bool {
2216 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2217 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2218}
2219
2220// Implements android.ApexModule
2221func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
2222 return j.depIsInSameApex(ctx, dep)
2223}
2224
2225// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002226func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002227 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002228 minSdkVersion := j.MinSdkVersion(ctx)
2229 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002230 return fmt.Errorf("min_sdk_version is not specified")
2231 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002232 // If the module is compiling against core (via sdk_version), skip comparison check.
2233 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002234 return nil
2235 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002236 if minSdkVersion.GreaterThan(sdkVersion) {
2237 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002238 }
2239 return nil
2240}
2241
2242func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002243 if j.stem == "" {
2244 panic("Stem() called before stem property was set")
2245 }
2246 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002247}
2248
Jaewoong Jung26342642021-03-17 15:56:23 -07002249func (j *Module) JacocoReportClassesFile() android.Path {
2250 return j.jacocoReportClassesFile
2251}
2252
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002253func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
2254 var fromDeps []*android.DepSet[android.Path]
2255 ctx.VisitDirectDeps(func(module android.Module) {
2256 tag := ctx.OtherModuleDependencyTag(module)
2257 if tag == staticLibTag {
Colin Cross7727c7f2024-07-18 15:36:32 -07002258 if depInfo, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2259 if depInfo.TransitiveSrcFiles != nil {
2260 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
2261 }
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002262 }
2263 }
2264 })
2265
2266 j.transitiveSrcFiles = android.NewDepSet(android.POSTORDER, mine, fromDeps)
2267}
2268
Jaewoong Jung26342642021-03-17 15:56:23 -07002269func (j *Module) IsInstallable() bool {
2270 return Bool(j.properties.Installable)
2271}
2272
2273type sdkLinkType int
2274
2275const (
2276 // TODO(jiyong) rename these for better readability. Make the allowed
2277 // and disallowed link types explicit
2278 // order is important here. See rank()
2279 javaCore sdkLinkType = iota
2280 javaSdk
2281 javaSystem
2282 javaModule
2283 javaSystemServer
2284 javaPlatform
2285)
2286
2287func (lt sdkLinkType) String() string {
2288 switch lt {
2289 case javaCore:
2290 return "core Java API"
2291 case javaSdk:
2292 return "Android API"
2293 case javaSystem:
2294 return "system API"
2295 case javaModule:
2296 return "module API"
2297 case javaSystemServer:
2298 return "system server API"
2299 case javaPlatform:
2300 return "private API"
2301 default:
2302 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2303 }
2304}
2305
2306// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2307// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2308// can't statically depend on modules that use Platform API.
2309func (lt sdkLinkType) rank() int {
2310 return int(lt)
2311}
2312
2313type moduleWithSdkDep interface {
2314 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002315 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002316}
2317
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002318func sdkLinkTypeFromSdkKind(k android.SdkKind) sdkLinkType {
2319 switch k {
2320 case android.SdkCore:
2321 return javaCore
2322 case android.SdkSystem:
2323 return javaSystem
2324 case android.SdkPublic:
2325 return javaSdk
2326 case android.SdkModule:
2327 return javaModule
2328 case android.SdkSystemServer:
2329 return javaSystemServer
2330 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
2331 return javaPlatform
2332 default:
2333 return javaSdk
2334 }
2335}
2336
Jiyong Park92315372021-04-02 08:45:46 +09002337func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002338 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002339 case android.SdkCore.DefaultJavaLibraryName(),
2340 "legacy.core.platform.api.stubs",
2341 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002342 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002343 "core-lambda-stubs",
Jihoon Kangb5078312023-03-29 23:25:49 +00002344 "core-generated-annotation-stubs":
Jaewoong Jung26342642021-03-17 15:56:23 -07002345 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002346 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002347 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002348 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002349 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002350 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002351 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002352 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002353 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002354 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002355 return javaSystem, true
2356 }
2357
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002358 if stub, linkType := moduleStubLinkType(m); stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07002359 return linkType, true
2360 }
2361
Jiyong Park92315372021-04-02 08:45:46 +09002362 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002363 if !ver.Valid() {
2364 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002365 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002366
2367 return sdkLinkTypeFromSdkKind(ver.Kind), false
Jaewoong Jung26342642021-03-17 15:56:23 -07002368}
2369
2370// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2371// this module's. See the comment on rank() for details and an example.
2372func (j *Module) checkSdkLinkType(
2373 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
2374 if ctx.Host() {
2375 return
2376 }
2377
Jiyong Park92315372021-04-02 08:45:46 +09002378 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002379 if stubs {
2380 return
2381 }
Jiyong Park92315372021-04-02 08:45:46 +09002382 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07002383
2384 if myLinkType.rank() < depLinkType.rank() {
2385 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2386 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2387 "property of the source or target module so that target module is built "+
2388 "with the same or smaller API set when compared to the source.",
2389 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2390 }
2391}
2392
2393func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2394 var deps deps
2395
Jiyong Park92315372021-04-02 08:45:46 +09002396 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002397
Colin Cross9ffaf282024-08-12 13:50:09 -07002398 j.collectTransitiveHeaderJarsForR8(ctx)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002399
2400 var transitiveBootClasspathHeaderJars []*android.DepSet[android.Path]
2401 var transitiveClasspathHeaderJars []*android.DepSet[android.Path]
2402 var transitiveJava9ClasspathHeaderJars []*android.DepSet[android.Path]
2403 var transitiveStaticJarsHeaderLibs []*android.DepSet[android.Path]
2404 var transitiveStaticJarsImplementationLibs []*android.DepSet[android.Path]
2405 var transitiveStaticJarsResourceLibs []*android.DepSet[android.Path]
2406
Jaewoong Jung26342642021-03-17 15:56:23 -07002407 ctx.VisitDirectDeps(func(module android.Module) {
2408 otherName := ctx.OtherModuleName(module)
2409 tag := ctx.OtherModuleDependencyTag(module)
2410
2411 if IsJniDepTag(tag) {
2412 // Handled by AndroidApp.collectAppDeps
2413 return
2414 }
2415 if tag == certificateTag {
2416 // Handled by AndroidApp.collectAppDeps
2417 return
2418 }
2419
2420 if dep, ok := module.(SdkLibraryDependency); ok {
2421 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002422 case sdkLibTag, libTag:
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002423 depHeaderJars := dep.SdkHeaderJars(ctx, j.SdkVersion(ctx))
2424 deps.classpath = append(deps.classpath, depHeaderJars...)
2425 deps.dexClasspath = append(deps.dexClasspath, depHeaderJars...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002426
2427 // TODO: SDK libraries should export a provider with TransitiveClasspathHeaderJars
2428 depHeaderJarsSet := android.NewDepSet(android.PREORDER, depHeaderJars, nil)
2429 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, depHeaderJarsSet)
Jaewoong Jung26342642021-03-17 15:56:23 -07002430 case staticLibTag:
2431 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
2432 }
Colin Cross313aa542023-12-13 13:47:44 -08002433 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2434 if sdkLinkType != javaPlatform {
2435 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2436 // dep is a sysprop implementation library, but this module is not linking against
2437 // the platform, so it gets the sysprop public stubs library instead. Replace
2438 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2439 dep = syspropDep.JavaInfo
2440 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002441 }
2442 switch tag {
2443 case bootClasspathTag:
2444 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002445 if dep.TransitiveStaticLibsHeaderJars != nil {
2446 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2447 }
Liz Kammeref28a4c2022-09-23 16:50:56 -04002448 case sdkLibTag, libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002449 if _, ok := module.(*Plugin); ok {
2450 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2451 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002452 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002453 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002454 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2455 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2456 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2457 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002458 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2459 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2460 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002461
2462 if dep.TransitiveStaticLibsHeaderJars != nil {
2463 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2464 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002465 case java9LibTag:
2466 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002467 if dep.TransitiveStaticLibsHeaderJars != nil {
2468 transitiveJava9ClasspathHeaderJars = append(transitiveJava9ClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2469 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002470 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002471 if _, ok := module.(*Plugin); ok {
2472 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2473 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002474 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2475 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2476 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2477 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2478 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2479 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2480 // Turbine doesn't run annotation processors, so any module that uses an
2481 // annotation processor that generates API is incompatible with the turbine
2482 // optimization.
2483 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002484 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002485
2486 if dep.TransitiveStaticLibsHeaderJars != nil {
2487 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2488 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, dep.TransitiveStaticLibsHeaderJars)
2489 }
2490 if dep.TransitiveStaticLibsImplementationJars != nil {
2491 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, dep.TransitiveStaticLibsImplementationJars)
2492 }
2493 if dep.TransitiveStaticLibsResourceJars != nil {
2494 transitiveStaticJarsResourceLibs = append(transitiveStaticJarsResourceLibs, dep.TransitiveStaticLibsResourceJars)
2495 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002496 case pluginTag:
2497 if plugin, ok := module.(*Plugin); ok {
2498 if plugin.pluginProperties.Processor_class != nil {
2499 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
2500 } else {
2501 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2502 }
2503 // Turbine doesn't run annotation processors, so any module that uses an
2504 // annotation processor that generates API is incompatible with the turbine
2505 // optimization.
2506 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
2507 } else {
2508 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2509 }
2510 case errorpronePluginTag:
2511 if _, ok := module.(*Plugin); ok {
2512 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2513 } else {
2514 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2515 }
2516 case exportedPluginTag:
2517 if plugin, ok := module.(*Plugin); ok {
2518 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
2519 if plugin.pluginProperties.Processor_class != nil {
2520 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
2521 }
2522 // Turbine doesn't run annotation processors, so any module that uses an
2523 // annotation processor that generates API is incompatible with the turbine
2524 // optimization.
2525 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
2526 } else {
2527 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2528 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07002529 case kotlinPluginTag:
2530 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002531 case syspropPublicStubDepTag:
2532 // This is a sysprop implementation library, forward the JavaInfoProvider from
2533 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002534 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002535 JavaInfo: dep,
2536 })
2537 }
2538 } else if dep, ok := module.(android.SourceFileProducer); ok {
2539 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002540 case sdkLibTag, libTag:
Jaewoong Jung26342642021-03-17 15:56:23 -07002541 checkProducesJars(ctx, dep)
2542 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002543 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002544 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars,
2545 android.NewDepSet(android.PREORDER, dep.Srcs(), nil))
Jaewoong Jung26342642021-03-17 15:56:23 -07002546 case staticLibTag:
2547 checkProducesJars(ctx, dep)
2548 deps.classpath = append(deps.classpath, dep.Srcs()...)
2549 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2550 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002551
2552 depHeaderJars := android.NewDepSet(android.PREORDER, dep.Srcs(), nil)
2553 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, depHeaderJars)
2554 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, depHeaderJars)
2555 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, depHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002556 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002557 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002558 switch tag {
2559 case staticLibTag:
2560 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2561 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002562 } else {
2563 switch tag {
2564 case bootClasspathTag:
2565 // If a system modules dependency has been added to the bootclasspath
2566 // then add its libs to the bootclasspath.
Colin Crossb61c2262024-08-08 14:04:42 -07002567 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002568 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars...)
2569 if sm.TransitiveStaticLibsHeaderJars != nil {
2570 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars,
2571 sm.TransitiveStaticLibsHeaderJars)
2572 }
Colin Crossb61c2262024-08-08 14:04:42 -07002573 } else {
2574 ctx.PropertyErrorf("boot classpath dependency %q does not provide SystemModulesProvider",
2575 ctx.OtherModuleName(module))
2576 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002577
2578 case systemModulesTag:
2579 if deps.systemModules != nil {
2580 panic("Found two system module dependencies")
2581 }
Colin Crossb61c2262024-08-08 14:04:42 -07002582 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2583 deps.systemModules = &systemModules{sm.OutputDir, sm.OutputDirDeps}
2584 } else {
2585 ctx.PropertyErrorf("system modules dependency %q does not provide SystemModulesProvider",
2586 ctx.OtherModuleName(module))
2587 }
Paul Duffin53a70a42022-01-11 14:35:55 +00002588
2589 case instrumentationForTag:
2590 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 -07002591 }
2592 }
2593
Spandan Das8aac9932024-07-18 23:14:13 +00002594 if android.InList(tag, compileDependencyTags) {
2595 // Add the dependency name to compileDepNames so that it can be recorded in module_bp_java_deps.json
2596 j.compileDepNames = append(j.compileDepNames, otherName)
2597 }
2598
Jaewoong Jung26342642021-03-17 15:56:23 -07002599 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002600 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002601 })
2602
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002603 deps.transitiveStaticLibsHeaderJars = transitiveStaticJarsHeaderLibs
2604 deps.transitiveStaticLibsImplementationJars = transitiveStaticJarsImplementationLibs
2605 deps.transitiveStaticLibsResourceJars = transitiveStaticJarsResourceLibs
2606
2607 if ctx.Config().UseTransitiveJarsInClasspath() {
2608 depSet := android.NewDepSet(android.PREORDER, nil, transitiveClasspathHeaderJars)
2609 deps.classpath = depSet.ToList()
2610 depSet = android.NewDepSet(android.PREORDER, nil, transitiveBootClasspathHeaderJars)
2611 deps.bootClasspath = depSet.ToList()
2612 depSet = android.NewDepSet(android.PREORDER, nil, transitiveJava9ClasspathHeaderJars)
2613 deps.java9Classpath = depSet.ToList()
2614 }
2615
2616 if ctx.Device() {
2617 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
2618 if sdkDep.invalidVersion {
2619 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2620 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2621 } else if sdkDep.useFiles {
2622 // sdkDep.jar is actually equivalent to turbine header.jar.
2623 deps.classpath = append(slices.Clone(classpath(sdkDep.jars)), deps.classpath...)
2624 deps.dexClasspath = append(slices.Clone(classpath(sdkDep.jars)), deps.dexClasspath...)
2625 deps.aidlPreprocess = sdkDep.aidl
2626 // Add the sdk module dependency to `compileDepNames`.
2627 // This ensures that the dependency is reported in `module_bp_java_deps.json`
2628 // TODO (b/358608607): Move this to decodeSdkDep
2629 sdkSpec := android.SdkContext(j).SdkVersion(ctx)
2630 j.compileDepNames = append(j.compileDepNames, fmt.Sprintf("sdk_%s_%s_android", sdkSpec.Kind.String(), sdkSpec.ApiLevel.String()))
2631 } else {
2632 deps.aidlPreprocess = sdkDep.aidl
2633 }
2634 }
2635
Jaewoong Jung26342642021-03-17 15:56:23 -07002636 return deps
2637}
2638
Joe Onorato349ae8d2024-02-05 22:46:00 +00002639// Provider for jarjar renaming rules.
2640//
2641// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2642// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2643// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2644// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2645// be renamed from that module.
2646// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002647type DependencyUse int
2648
2649const (
2650 RenameUseInvalid DependencyUse = iota
2651 RenameUseInclude
2652 RenameUseExclude
2653)
2654
2655type RenameUseElement struct {
2656 DepName string
2657 RenameUse DependencyUse
2658 Why string // token for determining where in the logic the decision was made.
2659}
2660
Joe Onorato349ae8d2024-02-05 22:46:00 +00002661type JarJarProviderData struct {
2662 // Mapping of class names: original --> renamed. If the value is "", the class will be
2663 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2664 // attribute). Rdeps of that module will inherit the renaming.
LaMont Jones63683e42024-02-08 14:30:45 -08002665 Rename map[string]string
2666 RenameUse []RenameUseElement
Joe Onorato349ae8d2024-02-05 22:46:00 +00002667}
2668
2669func (this JarJarProviderData) GetDebugString() string {
2670 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002671 for _, k := range android.SortedKeys(this.Rename) {
2672 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002673 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2674 result += k + "--&gt;" + v + ";"
2675 }
2676 }
2677 return result
2678}
2679
2680var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2681
2682var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2683
2684func init() {
2685 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
Yu Liu26a716d2024-08-30 23:40:32 +00002686
2687 gob.Register(BaseJarJarProviderData{})
Joe Onorato349ae8d2024-02-05 22:46:00 +00002688}
2689
2690// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2691// whether they are java modules or not.
2692type BaseJarJarProviderData struct {
2693 JarJarProviderData JarJarProviderData
2694}
2695
2696func (this BaseJarJarProviderData) GetDebugString() string {
2697 return this.JarJarProviderData.GetDebugString()
2698}
2699
2700var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2701
2702// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2703// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2704// either JarJarProvider or BaseJarJarProvider.
2705func mergeJarJarPrefixes(ctx android.ModuleContext) {
2706 mod := ctx.Module()
2707 // Explicitly avoid propagating into some module types.
2708 switch reflect.TypeOf(mod).String() {
2709 case "*java.Droidstubs":
2710 return
2711 }
2712 jarJarData := collectDirectDepsProviders(ctx)
2713 if jarJarData != nil {
2714 providerData := BaseJarJarProviderData{
2715 JarJarProviderData: *jarJarData,
2716 }
2717 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2718 }
2719
2720}
2721
2722// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2723func (module *Module) addJarJarRenameRule(original string, renamed string) {
2724 if module.jarjarRenameRules == nil {
2725 module.jarjarRenameRules = make(map[string]string)
2726 }
2727 module.jarjarRenameRules[original] = renamed
2728}
2729
2730func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2731 // Gather repackage information from deps
2732 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002733
2734 module := ctx.Module()
2735 moduleName := module.Name()
2736
Joe Onorato349ae8d2024-02-05 22:46:00 +00002737 ctx.VisitDirectDepsIgnoreBlueprint(func(m android.Module) {
LaMont Jones63683e42024-02-08 14:30:45 -08002738 tag := ctx.OtherModuleDependencyTag(m)
2739 // This logic mirrors that in (*Module).collectDeps above. There are several places
2740 // where we explicitly return RenameUseExclude, even though it is the default, to
2741 // indicate that it has been verified to be the case.
2742 //
2743 // Note well: there are probably cases that are getting to the unconditional return
2744 // and are therefore wrong.
2745 shouldIncludeRenames := func() (DependencyUse, string) {
2746 if moduleName == m.Name() {
2747 return RenameUseInclude, "name" // If we have the same module name, include the renames.
2748 }
2749 if sc, ok := module.(android.SdkContext); ok {
2750 if ctx.Device() {
2751 sdkDep := decodeSdkDep(ctx, sc)
2752 if !sdkDep.invalidVersion && sdkDep.useFiles {
2753 return RenameUseExclude, "useFiles"
Joe Onorato349ae8d2024-02-05 22:46:00 +00002754 }
2755 }
LaMont Jones63683e42024-02-08 14:30:45 -08002756 }
2757 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
2758 return RenameUseExclude, "tags"
2759 }
2760 if _, ok := m.(SdkLibraryDependency); ok {
2761 switch tag {
2762 case sdkLibTag, libTag:
2763 return RenameUseExclude, "sdklibdep" // matches collectDeps()
2764 }
2765 return RenameUseInvalid, "sdklibdep" // dep is not used in collectDeps()
2766 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2767 switch ji.StubsLinkType {
2768 case Stubs:
2769 return RenameUseExclude, "info"
2770 case Implementation:
2771 return RenameUseInclude, "info"
2772 default:
LaMont Jones09721862024-06-11 10:30:50 -07002773 //fmt.Printf("collectDirectDepsProviders: %v -> %v StubsLinkType unknown\n", module, m)
LaMont Jones63683e42024-02-08 14:30:45 -08002774 // Fall through to the heuristic logic.
2775 }
2776 switch reflect.TypeOf(m).String() {
2777 case "*java.GeneratedJavaLibraryModule":
2778 // Probably a java_aconfig_library module.
2779 // TODO: make this check better.
2780 return RenameUseInclude, "reflect"
2781 }
2782 switch tag {
2783 case bootClasspathTag:
2784 return RenameUseExclude, "tagswitch"
2785 case sdkLibTag, libTag, instrumentationForTag:
2786 return RenameUseInclude, "tagswitch"
2787 case java9LibTag:
2788 return RenameUseExclude, "tagswitch"
2789 case staticLibTag:
2790 return RenameUseInclude, "tagswitch"
2791 case pluginTag:
2792 return RenameUseInclude, "tagswitch"
2793 case errorpronePluginTag:
2794 return RenameUseInclude, "tagswitch"
2795 case exportedPluginTag:
2796 return RenameUseInclude, "tagswitch"
LaMont Jones63683e42024-02-08 14:30:45 -08002797 case kotlinPluginTag:
2798 return RenameUseInclude, "tagswitch"
2799 default:
2800 return RenameUseExclude, "tagswitch"
2801 }
2802 } else if _, ok := m.(android.SourceFileProducer); ok {
2803 switch tag {
2804 case sdkLibTag, libTag, staticLibTag:
2805 return RenameUseInclude, "srcfile"
2806 default:
2807 return RenameUseExclude, "srcfile"
2808 }
Yu Liu67a28422024-03-05 00:36:31 +00002809 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kang03d014f2024-02-16 22:22:18 +00002810 return RenameUseInclude, "aconfig_declarations_group"
LaMont Jones63683e42024-02-08 14:30:45 -08002811 } else {
2812 switch tag {
2813 case bootClasspathTag:
2814 return RenameUseExclude, "else"
2815 case systemModulesTag:
2816 return RenameUseInclude, "else"
2817 }
2818 }
2819 // If we got here, choose the safer option, which may lead to a build failure, rather
2820 // than runtime failures on the device.
2821 return RenameUseExclude, "end"
2822 }
2823
2824 if result == nil {
2825 result = &JarJarProviderData{
2826 Rename: make(map[string]string),
2827 RenameUse: make([]RenameUseElement, 0),
2828 }
2829 }
2830 how, why := shouldIncludeRenames()
2831 result.RenameUse = append(result.RenameUse, RenameUseElement{DepName: m.Name(), RenameUse: how, Why: why})
2832 if how != RenameUseInclude {
2833 // Nothing to merge.
2834 return
2835 }
2836
2837 merge := func(theirs *JarJarProviderData) {
2838 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002839 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2840 result.Rename[orig] = renamed
2841 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2842 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2843 result.Rename[orig] = renamed
2844 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2845 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2846 continue
2847 }
2848 }
2849 }
2850 }
2851 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2852 merge(&theirs)
2853 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2854 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2855 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2856 // to java.Module.
2857 merge(&theirs.JarJarProviderData)
2858 }
2859 })
2860 return
2861}
2862
2863func (this Module) GetDebugString() string {
2864 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2865}
2866
2867// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2868// us, and if it's been set, apply the jarjar_prefix property to rename them.
2869func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2870 // Gather repackage information from deps
2871 result := collectDirectDepsProviders(ctx)
2872
Joe Onoratoa5d17172024-07-20 17:39:56 -07002873 add := func(orig string, renamed string) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002874 if result == nil {
2875 result = &JarJarProviderData{
2876 Rename: make(map[string]string),
2877 }
2878 }
2879 if renamed != "" {
2880 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2881 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
Joe Onoratoa5d17172024-07-20 17:39:56 -07002882 return
Joe Onorato349ae8d2024-02-05 22:46:00 +00002883 }
2884 }
2885 (*result).Rename[orig] = renamed
2886 }
2887
Joe Onoratoa5d17172024-07-20 17:39:56 -07002888 // Update that with entries we've stored for ourself
2889 for orig, renamed := range module.jarjarRenameRules {
2890 add(orig, renamed)
2891 }
2892
2893 // Update that with entries given in the jarjar_rename property.
2894 for _, orig := range module.properties.Jarjar_rename {
2895 add(orig, "")
2896 }
2897
Joe Onorato349ae8d2024-02-05 22:46:00 +00002898 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2899 if result == nil {
2900 return nil
2901 }
2902
2903 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2904 // that have not yet been renamed.
2905 prefix := proptools.String(module.properties.Jarjar_prefix)
2906 if prefix != "" {
2907 if prefix[0] == '.' {
2908 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2909 return nil
2910 }
2911 if prefix[len(prefix)-1] == '.' {
2912 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2913 return nil
2914 }
2915
2916 var updated map[string]string
2917 for orig, renamed := range (*result).Rename {
2918 if renamed == "" {
2919 if updated == nil {
2920 updated = make(map[string]string)
2921 }
2922 updated[orig] = prefix + "." + orig
2923 }
2924 }
2925 for orig, renamed := range updated {
2926 (*result).Rename[orig] = renamed
2927 }
2928 }
2929
2930 return result
2931}
2932
2933// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2934// to "" won't be in this list because they shouldn't be renamed yet.
2935func getJarJarRuleText(provider *JarJarProviderData) string {
2936 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002937 for _, orig := range android.SortedKeys(provider.Rename) {
2938 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002939 if renamed != "" {
2940 result += "rule " + orig + " " + renamed + "\n"
2941 }
2942 }
2943 return result
2944}
2945
Zi Wangddb2ee52024-04-02 16:44:02 +00002946// Repackage the flags if the jarjar rule txt for the flags is generated
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002947func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Zi Wangddb2ee52024-04-02 16:44:02 +00002948 if j.repackageJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002949 return infile, false
Zi Wangddb2ee52024-04-02 16:44:02 +00002950 }
Colin Crossedec77c2024-07-26 15:25:40 -07002951 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info, jarName)
Zi Wangddb2ee52024-04-02 16:44:02 +00002952 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002953 return repackagedJarjarFile, true
Zi Wangddb2ee52024-04-02 16:44:02 +00002954}
2955
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002956func (j *Module) jarjarIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Colin Crossedec77c2024-07-26 15:25:40 -07002957 if j.expandJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002958 return infile, false
Colin Crossedec77c2024-07-26 15:25:40 -07002959 }
2960 jarjarFile := android.PathForModuleOut(ctx, "jarjar", info, jarName)
2961 TransformJarJar(ctx, jarjarFile, infile, j.expandJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002962 return jarjarFile, true
Colin Crossedec77c2024-07-26 15:25:40 -07002963
2964}
2965
Jaewoong Jung26342642021-03-17 15:56:23 -07002966func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2967 deps.processorPath = append(deps.processorPath, pluginJars...)
2968 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2969}
2970
2971// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2972// this interface.
2973type ProvidesUsesLib interface {
2974 ProvidesUsesLib() *string
2975}
2976
2977func (j *Module) ProvidesUsesLib() *string {
2978 return j.usesLibraryProperties.Provides_uses_lib
2979}
satayev1c564cc2021-05-25 19:50:30 +01002980
2981type ModuleWithStem interface {
2982 Stem() string
2983}
2984
2985var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00002986
2987type ModuleWithUsesLibrary interface {
2988 UsesLibrary() *usesLibrary
2989}
2990
2991func (j *Module) UsesLibrary() *usesLibrary {
2992 return &j.usesLibrary
2993}
2994
2995var _ ModuleWithUsesLibrary = (*Module)(nil)