blob: a02b3da25b15e7b4803b9d4b53c9259ea7e5a623 [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
Spandan Das1028d5a2024-08-19 21:45:48 +0000538 kytheFiles android.Paths
539 kytheKotlinFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700540
Jaewoong Jung26342642021-03-17 15:56:23 -0700541 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +0900542
543 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000544 minSdkVersion android.ApiLevel
Spandan Dasa26eda72023-03-02 00:56:06 +0000545 maxSdkVersion android.ApiLevel
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -0400546
547 sourceExtensions []string
Vadim Spivak3c496f02023-06-08 06:14:59 +0000548
549 annoSrcJars android.Paths
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000550
551 // output file name based on Stem property.
552 // This should be set in every ModuleWithStem's GenerateAndroidBuildActions
553 // or the module should override Stem().
554 stem string
Joe Onorato6fe59eb2023-07-16 13:20:33 -0700555
Joe Onorato349ae8d2024-02-05 22:46:00 +0000556 // Values that will be set in the JarJarProvider data for jarjar repackaging,
557 // and merged with our dependencies' rules.
558 jarjarRenameRules map[string]string
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000559
560 stubsLinkType StubsLinkType
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000561
562 // Paths to the aconfig intermediate cache files that are provided by the
563 // java_aconfig_library or java_library modules that are statically linked
564 // to this module. Does not contain cache files from all transitive dependencies.
565 aconfigCacheFiles android.Paths
Spandan Das8aac9932024-07-18 23:14:13 +0000566
567 // List of soong module dependencies required to compile the current module.
568 // This information is printed out to `Dependencies` field in module_bp_java_deps.json
569 compileDepNames []string
Makoto Onuki7ded3822024-03-28 14:42:20 -0700570
571 ravenizer struct {
572 enabled bool
573 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700574}
575
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000576var _ android.InstallableModule = (*Module)(nil)
577
578// To satisfy the InstallableModule interface
Jihoon Kang224ea082024-08-12 22:38:16 +0000579func (j *Module) StaticDependencyTags() []blueprint.DependencyTag {
580 return []blueprint.DependencyTag{staticLibTag}
581}
582
583// To satisfy the InstallableModule interface
584func (j *Module) DynamicDependencyTags() []blueprint.DependencyTag {
585 return []blueprint.DependencyTag{libTag, sdkLibTag, bootClasspathTag, systemModulesTag,
586 instrumentationForTag, java9LibTag}
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000587}
588
589// Overrides android.ModuleBase.InstallInProduct()
590func (j *Module) InstallInProduct() bool {
591 return j.ProductSpecific()
592}
593
Jihoon Kang85bc1932024-07-01 17:04:46 +0000594var _ android.StubsAvailableModule = (*Module)(nil)
595
596// To safisfy the StubsAvailableModule interface
597func (j *Module) IsStubsModule() bool {
598 return proptools.Bool(j.properties.Is_stubs_module)
599}
600
Jiyong Park92315372021-04-02 08:45:46 +0900601func (j *Module) CheckStableSdkVersion(ctx android.BaseModuleContext) error {
602 sdkVersion := j.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900603 if sdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700604 return nil
605 }
Jiyong Parkf1691d22021-03-29 20:11:58 +0900606 if sdkVersion.Kind == android.SdkCorePlatform {
Paul Duffin1ea7c9f2021-03-15 09:39:13 +0000607 if useLegacyCorePlatformApi(ctx, j.BaseModuleName()) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700608 return fmt.Errorf("non stable SDK %v - uses legacy core platform", sdkVersion)
609 } else {
610 // Treat stable core platform as stable.
611 return nil
612 }
613 } else {
614 return fmt.Errorf("non stable SDK %v", sdkVersion)
615 }
616}
617
618// checkSdkVersions enforces restrictions around SDK dependencies.
619func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
620 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900621 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900622 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700623 ctx.PropertyErrorf("sdk_version",
624 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
625 }
626 }
627 }
628
629 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
630 // See rank() for details.
631 ctx.VisitDirectDeps(func(module android.Module) {
632 tag := ctx.OtherModuleDependencyTag(module)
633 switch module.(type) {
634 // TODO(satayev): cover other types as well, e.g. imports
635 case *Library, *AndroidLibrary:
636 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400637 case bootClasspathTag, sdkLibTag, libTag, staticLibTag, java9LibTag:
Jaewoong Jung26342642021-03-17 15:56:23 -0700638 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
639 }
640 }
641 })
642}
643
644func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900645 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700646 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900647 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700648 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000649 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 -0700650 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000651 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 -0700652 }
653
654 }
655}
656
Mark Whitea15790a2023-08-22 21:28:11 +0000657func (j *Module) checkHeadersOnly(ctx android.ModuleContext) {
658 if _, ok := ctx.Module().(android.SdkContext); ok {
Liz Kammer60772632023-10-05 17:18:44 -0400659 headersOnly := proptools.Bool(j.properties.Headers_only)
Mark Whitea15790a2023-08-22 21:28:11 +0000660 installable := proptools.Bool(j.properties.Installable)
661
662 if headersOnly && installable {
663 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.")
664 }
665 }
666}
667
Jaewoong Jung26342642021-03-17 15:56:23 -0700668func (j *Module) addHostProperties() {
669 j.AddProperties(
670 &j.properties,
yangbill2af0b6e2024-03-15 09:29:29 +0000671 &j.overridableProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700672 &j.protoProperties,
673 &j.usesLibraryProperties,
674 )
675}
676
677func (j *Module) addHostAndDeviceProperties() {
678 j.addHostProperties()
679 j.AddProperties(
680 &j.deviceProperties,
681 &j.dexer.dexProperties,
682 &j.dexpreoptProperties,
683 &j.linter.properties,
684 )
685}
686
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000687// provideHiddenAPIPropertyInfo populates a HiddenAPIPropertyInfo from hidden API properties and
688// makes it available through the hiddenAPIPropertyInfoProvider.
689func (j *Module) provideHiddenAPIPropertyInfo(ctx android.ModuleContext) {
690 hiddenAPIInfo := newHiddenAPIPropertyInfo()
691
692 // Populate with flag file paths from the properties.
693 hiddenAPIInfo.extractFlagFilesFromProperties(ctx, &j.deviceProperties.HiddenAPIFlagFileProperties)
694
695 // Populate with package rules from the properties.
696 hiddenAPIInfo.extractPackageRulesFromProperties(&j.deviceProperties.HiddenAPIPackageProperties)
697
Colin Cross40213022023-12-13 15:19:49 -0800698 android.SetProvider(ctx, hiddenAPIPropertyInfoProvider, hiddenAPIInfo)
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000699}
700
mrziwang9f7b9f42024-07-10 12:18:06 -0700701// helper method for java modules to set OutputFilesProvider
702func setOutputFiles(ctx android.ModuleContext, m Module) {
703 ctx.SetOutputFiles(append(android.Paths{m.outputFile}, m.extraOutputFiles...), "")
704 ctx.SetOutputFiles(android.Paths{m.outputFile}, android.DefaultDistTag)
705 ctx.SetOutputFiles(android.Paths{m.implementationAndResourcesJar}, ".jar")
706 ctx.SetOutputFiles(android.Paths{m.headerJarFile}, ".hjar")
707 if m.dexer.proguardDictionary.Valid() {
708 ctx.SetOutputFiles(android.Paths{m.dexer.proguardDictionary.Path()}, ".proguard_map")
709 }
710 ctx.SetOutputFiles(m.properties.Generated_srcjars, ".generated_srcjars")
711 if m.linter.outputs.xml != nil {
712 ctx.SetOutputFiles(android.Paths{m.linter.outputs.xml}, ".lint")
Jaewoong Jung26342642021-03-17 15:56:23 -0700713 }
714}
715
Jaewoong Jung26342642021-03-17 15:56:23 -0700716func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
717 initJavaModule(module, hod, false)
718}
719
720func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
721 initJavaModule(module, hod, true)
722}
723
724func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
725 multilib := android.MultilibCommon
726 if multiTargets {
727 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
728 } else {
729 android.InitAndroidArchModule(module, hod, multilib)
730 }
731 android.InitDefaultableModule(module)
732}
733
734func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
735 return j.properties.Instrument &&
736 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
737 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
738}
739
Yihan Dong8be09c22024-08-29 15:32:13 +0800740func (j *Module) shouldApiMapper() bool {
741 return j.properties.ApiMapper
742}
743
Jaewoong Jung26342642021-03-17 15:56:23 -0700744func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000745 return j.properties.Supports_static_instrumentation &&
746 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700747 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
748 ctx.Config().UnbundledBuild())
749}
750
751func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
752 // Force enable the instrumentation for java code that is built for APEXes ...
753 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
754 // 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 -0800755 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -0700756 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Jihoon Kang690df2e2024-05-22 04:27:38 +0000757
Jihoon Kang46d66de2024-05-22 22:42:39 +0000758 if j.DirectlyInAnyApex() && !isJacocoAgent && !apexInfo.IsForPlatform() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700759 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
760 return true
761 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
762 return true
763 }
764 }
765 return false
766}
767
Sam Delmerico1e3f78f2022-09-07 12:07:07 -0400768func (j *Module) setInstrument(value bool) {
769 j.properties.Instrument = value
770}
771
Yihan Dong8be09c22024-08-29 15:32:13 +0800772func (j *Module) setApiMapper(value bool) {
773 j.properties.ApiMapper = value
774}
775
Jiyong Park92315372021-04-02 08:45:46 +0900776func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
777 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700778}
779
Jiyong Parkf1691d22021-03-29 20:11:58 +0900780func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700781 return proptools.String(j.deviceProperties.System_modules)
782}
783
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000784func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Spandan Dasb9c58352024-05-13 18:29:45 +0000785 if j.overridableProperties.Min_sdk_version != nil {
786 return android.ApiLevelFrom(ctx, *j.overridableProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700787 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000788 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700789}
790
Yu Liuf2b94012023-09-19 15:09:10 -0700791func (j *Module) GetDeviceProperties() *DeviceProperties {
792 return &j.deviceProperties
793}
794
Spandan Dasa26eda72023-03-02 00:56:06 +0000795func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
796 if j.deviceProperties.Max_sdk_version != nil {
797 return android.ApiLevelFrom(ctx, *j.deviceProperties.Max_sdk_version)
798 }
799 // Default is PrivateApiLevel
800 return android.SdkSpecPrivate.ApiLevel
satayev0a420e72021-11-29 17:25:52 +0000801}
802
Spandan Dasa26eda72023-03-02 00:56:06 +0000803func (j *Module) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
804 if j.deviceProperties.Replace_max_sdk_version_placeholder != nil {
805 return android.ApiLevelFrom(ctx, *j.deviceProperties.Replace_max_sdk_version_placeholder)
806 }
807 // Default is PrivateApiLevel
808 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000809}
810
Jiyong Parkf1691d22021-03-29 20:11:58 +0900811func (j *Module) MinSdkVersionString() string {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000812 return j.minSdkVersion.String()
Jiyong Park92315372021-04-02 08:45:46 +0900813}
814
Spandan Dasca70fc42023-03-01 23:38:49 +0000815func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jiyong Park92315372021-04-02 08:45:46 +0900816 if j.deviceProperties.Target_sdk_version != nil {
Spandan Dasca70fc42023-03-01 23:38:49 +0000817 return android.ApiLevelFrom(ctx, *j.deviceProperties.Target_sdk_version)
Jiyong Park92315372021-04-02 08:45:46 +0900818 }
Spandan Dasca70fc42023-03-01 23:38:49 +0000819 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700820}
821
822func (j *Module) AvailableFor(what string) bool {
823 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
824 // Exception: for hostdex: true libraries, the platform variant is created
825 // even if it's not marked as available to platform. In that case, the platform
826 // variant is used only for the hostdex and not installed to the device.
827 return true
828 }
829 return j.ApexModuleBase.AvailableFor(what)
830}
831
Cole Faustb7493472024-08-28 11:55:52 -0700832func (j *Module) staticLibs(ctx android.BaseModuleContext) []string {
833 return android.RemoveListFromList(j.properties.Static_libs.GetOrDefault(ctx, nil), j.properties.Exclude_static_libs)
834}
835
Jaewoong Jung26342642021-03-17 15:56:23 -0700836func (j *Module) deps(ctx android.BottomUpMutatorContext) {
837 if ctx.Device() {
838 j.linter.deps(ctx)
839
Jiyong Parkf1691d22021-03-29 20:11:58 +0900840 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700841
842 if j.deviceProperties.SyspropPublicStub != "" {
843 // This is a sysprop implementation library that has a corresponding sysprop public
844 // stubs library, and a dependency on it so that dependencies on the implementation can
845 // be forwarded to the public stubs library when necessary.
846 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
847 }
848 }
849
850 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000851
Cole Faustb7493472024-08-28 11:55:52 -0700852 ctx.AddVariationDependencies(nil, staticLibTag, j.staticLibs(ctx)...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700853
854 // Add dependency on libraries that provide additional hidden api annotations.
855 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
856
Jaewoong Jung26342642021-03-17 15:56:23 -0700857 // For library dependencies that are component libraries (like stubs), add the implementation
858 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
859 for _, dep := range libDeps {
860 if dep != nil {
861 if component, ok := dep.(SdkLibraryComponentDependency); ok {
862 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000863 // Add library as optional if it's one of the optional compatibility libs or it's
864 // explicitly listed in the optional_uses_libs property.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100865 tag := usesLibReqTag
Jiakai Zhangf98da192024-04-15 11:15:41 +0000866 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) ||
867 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs) {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100868 tag = usesLibOptTag
869 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100870 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700871 }
872 }
873 }
874 }
875
876 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
877 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
878 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
879
880 android.ProtoDeps(ctx, &j.protoProperties)
881 if j.hasSrcExt(".proto") {
882 protoDeps(ctx, &j.protoProperties)
883 }
884
885 if j.hasSrcExt(".kt") {
886 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
887 // Kotlin files
Colin Cross882d6002024-08-14 10:24:06 -0700888 tag := staticLibTag
889 if !BoolDefault(j.properties.Static_kotlin_stdlib, true) {
890 tag = libTag
891 }
892 ctx.AddVariationDependencies(nil, tag,
893 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8", "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700894 }
895
896 // Framework libraries need special handling in static coverage builds: they should not have
897 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
898 // the same jacoco classes coming from different bootclasspath jars.
899 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
900 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
901 j.properties.Instrument = true
902 }
903 } else if j.shouldInstrumentStatic(ctx) {
904 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
905 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700906
Cole Faustb7493472024-08-28 11:55:52 -0700907 if j.useCompose(ctx) {
Colin Crossa1ff7c62021-09-17 14:11:52 -0700908 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
909 "androidx.compose.compiler_compiler-hosted")
910 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700911}
912
913func hasSrcExt(srcs []string, ext string) bool {
914 for _, src := range srcs {
915 if filepath.Ext(src) == ext {
916 return true
917 }
918 }
919
920 return false
921}
922
923func (j *Module) hasSrcExt(ext string) bool {
924 return hasSrcExt(j.properties.Srcs, ext)
925}
926
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100927func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
928 var flags string
929
930 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
931 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
932 flags = "-Wmissing-permission-annotation -Werror"
933 }
934 }
935 return flags
936}
937
Jaewoong Jung26342642021-03-17 15:56:23 -0700938func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000939 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700940
941 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
942 aidlIncludes = append(aidlIncludes,
943 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
944 aidlIncludes = append(aidlIncludes,
945 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
946
947 var flags []string
948 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000949 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700950
951 flags = append(flags, j.deviceProperties.Aidl.Flags...)
952
953 if aidlPreprocess.Valid() {
954 flags = append(flags, "-p"+aidlPreprocess.String())
955 deps = append(deps, aidlPreprocess.Path())
956 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000957 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700958 }
959
960 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000961 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700962 }
963
964 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000965 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700966 }
967
Sam Delmerico2351eac2022-05-24 17:10:02 +0000968 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -0700969 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000970 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -0700971 }
Sam Delmerico2351eac2022-05-24 17:10:02 +0000972 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
973 // add flags for dirs containing AIDL srcs that haven't been specified yet
974 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -0700975
Zim8774ae12022-08-17 11:46:34 +0100976 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +0000977 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +0100978 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700979 flags = append(flags, "-t")
980 }
981
982 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
983 flags = append(flags, "--transaction_names")
984 }
985
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100986 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
987 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
988 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
989 }
990
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000991 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +0900992 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
993
Jaewoong Jung26342642021-03-17 15:56:23 -0700994 return strings.Join(flags, " "), deps
995}
996
997func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
998
999 var flags javaBuilderFlags
1000
1001 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +09001002 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001003
Cole Faust2b1536e2021-06-18 12:25:54 -07001004 epEnabled := j.properties.Errorprone.Enabled
1005 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +01001006 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001007 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1008 }
1009
1010 errorProneFlags := []string{
1011 "-Xplugin:ErrorProne",
1012 "${config.ErrorProneChecks}",
1013 }
1014 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1015
Colin Cross8bf6cad2022-02-28 13:07:03 -08001016 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -07001017 "'" + strings.Join(errorProneFlags, " ") + "'"
1018 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
1019 }
1020
1021 // classpath
1022 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1023 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001024 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001025 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1026 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1027 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1028
1029 flags.processors = append(flags.processors, deps.processorClasses...)
1030 flags.processors = android.FirstUniqueStrings(flags.processors)
1031
1032 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001033 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001034 // Give host-side tools a version of OpenJDK's standard libraries
1035 // close to what they're targeting. As of Dec 2017, AOSP is only
1036 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1037 //
1038 // When building with OpenJDK 8, the following should have no
1039 // effect since those jars would be available by default.
1040 //
1041 // When building with OpenJDK 9 but targeting a version < 1.8,
1042 // putting them on the bootclasspath means that:
1043 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1044 // b) references to existing APIs are not reinterpreted in an
1045 // OpenJDK 9-specific way, eg. calls to subclasses of
1046 // java.nio.Buffer as in http://b/70862583
1047 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1048 flags.bootClasspath = append(flags.bootClasspath,
1049 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1050 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1051 if Bool(j.properties.Use_tools_jar) {
1052 flags.bootClasspath = append(flags.bootClasspath,
1053 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1054 }
1055 }
1056
1057 // systemModules
1058 flags.systemModules = deps.systemModules
1059
Jaewoong Jung26342642021-03-17 15:56:23 -07001060 return flags
1061}
1062
1063func (j *Module) collectJavacFlags(
1064 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1065 // javac flags.
1066 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001067 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001068
Mythri Alle4b9f6182023-10-25 15:17:11 +00001069 needsDebugInfo = false
1070 for _, flag := range javacFlags {
1071 if strings.HasPrefix(flag, "-g") {
1072 needsDebugInfo = true
1073 }
1074 }
1075
1076 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001077 // For non-host binaries, override the -g flag passed globally to remove
1078 // local variable debug info to reduce disk and memory usage.
1079 javacFlags = append(javacFlags, "-g:source,lines")
1080 }
1081 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1082
1083 if flags.javaVersion.usesJavaModules() {
1084 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001085 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1086 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1087 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1088 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001089
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001090 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001091 if j.properties.Patch_module != nil {
1092 // Manually specify build directory in case it is not under the repo root.
1093 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1094 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001095 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001096
Jaewoong Jung26342642021-03-17 15:56:23 -07001097 classPath := flags.classpath.FormJavaClassPath("")
1098 if classPath != "" {
1099 patchPaths = append(patchPaths, classPath)
1100 }
1101 javacFlags = append(
1102 javacFlags,
1103 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1104 }
1105 }
1106
1107 if len(javacFlags) > 0 {
1108 // optimization.
1109 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1110 flags.javacFlags = "$javacFlags"
1111 }
1112
1113 return flags
1114}
1115
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001116func (j *Module) AddJSONData(d *map[string]interface{}) {
1117 (&j.ModuleBase).AddJSONData(d)
1118 (*d)["Java"] = map[string]interface{}{
1119 "SourceExtensions": j.sourceExtensions,
1120 }
1121
1122}
1123
usta0391ca42023-09-19 15:51:59 -04001124func (j *Module) addGeneratedSrcJars(path android.Path) {
1125 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001126}
1127
Colin Crossfdaa6722024-08-23 11:58:08 -07001128func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars, extraDepCombinedJars android.Paths) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001129 // Auto-propagating jarjar rules
1130 jarjarProviderData := j.collectJarJarRules(ctx)
1131 if jarjarProviderData != nil {
1132 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wangddb2ee52024-04-02 16:44:02 +00001133 text := getJarJarRuleText(jarjarProviderData)
1134 if text != "" {
1135 ruleTextFile := android.PathForModuleOut(ctx, "repackaged-jarjar", "repackaging.txt")
1136 android.WriteFileRule(ctx, ruleTextFile, text)
1137 j.repackageJarjarRules = ruleTextFile
Joe Onorato349ae8d2024-02-05 22:46:00 +00001138 }
1139 }
1140
Jaewoong Jung26342642021-03-17 15:56:23 -07001141 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1142
Makoto Onuki7ded3822024-03-28 14:42:20 -07001143 if re := proptools.Bool(j.properties.Ravenizer.Enabled); re {
1144 j.ravenizer.enabled = re
1145 }
1146
Jaewoong Jung26342642021-03-17 15:56:23 -07001147 deps := j.collectDeps(ctx)
1148 flags := j.collectBuilderFlags(ctx, deps)
1149
1150 if flags.javaVersion.usesJavaModules() {
1151 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001152 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1153 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1154 ctx.PropertyErrorf("openjdk9.srcs", "JDK version defaults to higher than 9")
Jaewoong Jung26342642021-03-17 15:56:23 -07001155 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001156
Jaewoong Jung26342642021-03-17 15:56:23 -07001157 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001158 j.sourceExtensions = []string{}
1159 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1160 if hasSrcExt(srcFiles.Strings(), ext) {
1161 j.sourceExtensions = append(j.sourceExtensions, ext)
1162 }
1163 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001164 if hasSrcExt(srcFiles.Strings(), ".proto") {
1165 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1166 }
1167
1168 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, nil)
1169 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1170 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1171 }
1172
Sam Delmerico2351eac2022-05-24 17:10:02 +00001173 aidlSrcs := srcFiles.FilterByExt(".aidl")
1174 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs, aidlSrcs)
1175
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001176 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001177 srcFiles = j.genSources(ctx, srcFiles, flags)
1178
1179 // Collect javac flags only after computing the full set of srcFiles to
1180 // ensure that the --patch-module lookup paths are complete.
1181 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1182
1183 srcJars := srcFiles.FilterByExt(".srcjar")
1184 srcJars = append(srcJars, deps.srcJars...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001185 srcJars = append(srcJars, extraSrcJars...)
Joe Onorato175073c2023-06-01 14:42:59 -07001186 srcJars = append(srcJars, j.properties.Generated_srcjars...)
Colin Crossb0ef30a2021-06-29 10:42:00 -07001187 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001188
1189 if j.properties.Jarjar_rules != nil {
1190 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1191 }
1192
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00001193 jarName := j.Stem() + ".jar"
Jaewoong Jung26342642021-03-17 15:56:23 -07001194
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001195 var uniqueJavaFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001196 set := make(map[string]bool)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001197 for _, v := range srcFiles.FilterByExt(".java") {
Jaewoong Jung26342642021-03-17 15:56:23 -07001198 if _, found := set[v.String()]; !found {
1199 set[v.String()] = true
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001200 uniqueJavaFiles = append(uniqueJavaFiles, v)
Jaewoong Jung26342642021-03-17 15:56:23 -07001201 }
1202 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001203 var uniqueKtFiles android.Paths
1204 for _, v := range srcFiles.FilterByExt(".kt") {
1205 if _, found := set[v.String()]; !found {
1206 set[v.String()] = true
1207 uniqueKtFiles = append(uniqueKtFiles, v)
1208 }
1209 }
1210
1211 var uniqueSrcFiles android.Paths
1212 uniqueSrcFiles = append(uniqueSrcFiles, uniqueJavaFiles...)
1213 uniqueSrcFiles = append(uniqueSrcFiles, uniqueKtFiles...)
1214 j.uniqueSrcFiles = uniqueSrcFiles
Colin Cross40213022023-12-13 15:19:49 -08001215 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: uniqueSrcFiles.Strings()})
Jaewoong Jung26342642021-03-17 15:56:23 -07001216
Colin Crossb5db4012022-03-28 17:12:39 -07001217 // We don't currently run annotation processors in turbine, which means we can't use turbine
1218 // generated header jars when an annotation processor that generates API is enabled. One
1219 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1220 // is used to run all of the annotation processors.
1221 disableTurbine := deps.disableTurbine
1222
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001223 // Collect .java and .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001224 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1225
Colin Cross220a9a12022-03-28 17:08:01 -07001226 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001227
Colin Cross4eae06d2023-06-20 22:40:02 -07001228 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1229 // any dependencies so that it can override any non-final R classes from dependencies with the
1230 // final R classes from the app.
1231 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1232
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001233 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1234
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001235 var localImplementationJars android.Paths
1236
Mark Whitea15790a2023-08-22 21:28:11 +00001237 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001238 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001239 if srcFiles.HasExt(".kt") {
1240 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1241 }
1242 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1243 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1244 }
1245
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001246 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1247
1248 localHeaderJars, combinedHeaderJarFile := j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
Colin Crossedec77c2024-07-26 15:25:40 -07001249 extraCombinedJars)
1250
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001251 combinedHeaderJarFile, jarjared := j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1252 if jarjared {
1253 localHeaderJars = android.Paths{combinedHeaderJarFile}
1254 transitiveStaticLibsHeaderJars = nil
1255 }
1256 combinedHeaderJarFile, repackaged := j.repackageFlagsIfNecessary(ctx, combinedHeaderJarFile, jarName, "repackage-turbine")
1257 if repackaged {
1258 localHeaderJars = android.Paths{combinedHeaderJarFile}
1259 transitiveStaticLibsHeaderJars = nil
1260 }
Mark Whitea15790a2023-08-22 21:28:11 +00001261 if ctx.Failed() {
1262 return
1263 }
Colin Crossedec77c2024-07-26 15:25:40 -07001264 j.headerJarFile = combinedHeaderJarFile
Mark Whitea15790a2023-08-22 21:28:11 +00001265
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001266 if ctx.Config().UseTransitiveJarsInClasspath() {
1267 if len(localHeaderJars) > 0 {
1268 ctx.CheckbuildFile(localHeaderJars...)
1269 } else {
1270 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1271 ctx.UncheckedModule()
1272 }
1273 } else {
1274 ctx.CheckbuildFile(j.headerJarFile)
1275 }
Colin Crossa6182ab2024-08-21 10:47:44 -07001276
Colin Cross7727c7f2024-07-18 15:36:32 -07001277 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001278 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001279 LocalHeaderJars: localHeaderJars,
1280 TransitiveStaticLibsHeaderJars: android.NewDepSet(android.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Cross9ffaf282024-08-12 13:50:09 -07001281 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1282 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001283 AidlIncludeDirs: j.exportAidlIncludeDirs,
1284 ExportedPlugins: j.exportedPluginJars,
1285 ExportedPluginClasses: j.exportedPluginClasses,
1286 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1287 StubsLinkType: j.stubsLinkType,
1288 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Mark Whitea15790a2023-08-22 21:28:11 +00001289 })
1290
1291 j.outputFile = j.headerJarFile
1292 return
1293 }
1294
Jaewoong Jung26342642021-03-17 15:56:23 -07001295 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001296 // When using kotlin sources turbine is used to generate annotation processor sources,
1297 // including for annotation processors that generate API, so we can use turbine for
1298 // java sources too.
1299 disableTurbine = false
1300
Jaewoong Jung26342642021-03-17 15:56:23 -07001301 // user defined kotlin flags.
1302 kotlincFlags := j.properties.Kotlincflags
1303 CheckKotlincFlags(ctx, kotlincFlags)
1304
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001305 // Workaround for KT-46512
1306 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001307
1308 // If there are kotlin files, compile them first but pass all the kotlin and java files
1309 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1310 // won't emit any classes for them.
1311 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1312 if ctx.Device() {
1313 kotlincFlags = append(kotlincFlags, "-no-jdk")
1314 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001315
1316 for _, plugin := range deps.kotlinPlugins {
1317 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1318 }
1319 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1320
Jaewoong Jung26342642021-03-17 15:56:23 -07001321 if len(kotlincFlags) > 0 {
1322 // optimization.
1323 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1324 flags.kotlincFlags += "$kotlincFlags"
1325 }
1326
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001327 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001328 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1329
Jaewoong Jung26342642021-03-17 15:56:23 -07001330 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1331 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1332
Isaac Chioua23d9942022-04-06 06:14:38 +00001333 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001334 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001335 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1336 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001337 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001338 srcJars = append(srcJars, kaptSrcJar)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001339 localImplementationJars = append(localImplementationJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001340 // Disable annotation processing in javac, it's already been handled by kapt
1341 flags.processorPath = nil
1342 flags.processors = nil
1343 }
1344
1345 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001346 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Spandan Das1028d5a2024-08-19 21:45:48 +00001347 j.kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001348 if ctx.Failed() {
1349 return
1350 }
1351
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001352 kotlinJarPath, _ := j.repackageFlagsIfNecessary(ctx, kotlinJar, jarName, "kotlinc")
Zi Wangddb2ee52024-04-02 16:44:02 +00001353
Isaac Chioua23d9942022-04-06 06:14:38 +00001354 // Make javac rule depend on the kotlinc rule
1355 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1356
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001357 localImplementationJars = append(localImplementationJars, kotlinJarPath)
1358
Colin Cross220a9a12022-03-28 17:08:01 -07001359 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001360 }
1361
Jaewoong Jung26342642021-03-17 15:56:23 -07001362 j.compiledSrcJars = srcJars
1363
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001364 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1365
Jaewoong Jung26342642021-03-17 15:56:23 -07001366 enableSharding := false
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001367 var localHeaderJars android.Paths
1368 var shardingHeaderJars android.Paths
1369 var repackagedHeaderJarFile android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001370 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001371 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1372 enableSharding = true
1373 // Formerly, there was a check here that prevented annotation processors
1374 // from being used when sharding was enabled, as some annotation processors
1375 // do not function correctly in sharded environments. It was removed to
1376 // allow for the use of annotation processors that do function correctly
1377 // with sharding enabled. See: b/77284273.
1378 }
Colin Crossd1d8f172024-07-29 11:30:29 -07001379 extraJars := slices.Clone(kotlinHeaderJars)
Colin Crossd1d8f172024-07-29 11:30:29 -07001380 extraJars = append(extraJars, extraCombinedJars...)
Colin Crossedec77c2024-07-26 15:25:40 -07001381 var combinedHeaderJarFile android.Path
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001382 localHeaderJars, combinedHeaderJarFile = j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
1383 shardingHeaderJars = localHeaderJars
Colin Crossedec77c2024-07-26 15:25:40 -07001384
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001385 var jarjared bool
1386 j.headerJarFile, jarjared = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1387 if jarjared {
1388 // jarjar modifies transitive static dependencies, use the combined header jar and drop the transitive
1389 // static libs header jars.
1390 localHeaderJars = android.Paths{j.headerJarFile}
1391 transitiveStaticLibsHeaderJars = nil
1392 }
1393 var repackaged bool
1394 repackagedHeaderJarFile, repackaged = j.repackageFlagsIfNecessary(ctx, j.headerJarFile, jarName, "turbine")
1395 if repackaged {
1396 // repackage modifies transitive static dependencies, use the combined header jar and drop the transitive
1397 // static libs header jars.
1398 // TODO(b/356688296): this shouldn't export both the unmodified and repackaged header jars
1399 localHeaderJars = android.Paths{j.headerJarFile, repackagedHeaderJarFile}
1400 transitiveStaticLibsHeaderJars = nil
1401 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001402 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001403 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001404 hasErrorproneableFiles := false
1405 for _, ext := range j.sourceExtensions {
1406 if ext != ".proto" && ext != ".aidl" {
1407 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1408 // compile, and it's not useful to have warnings on these generated sources.
1409 hasErrorproneableFiles = true
1410 break
1411 }
1412 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001413 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001414 if Bool(j.properties.Errorprone.Enabled) {
1415 // If error-prone is enabled, enable errorprone flags on the regular
1416 // build.
1417 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001418 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faust75fffb12021-06-13 15:23:16 -07001419 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1420 // a new jar file just for compiling with the errorprone compiler to.
1421 // This is because we don't want to cause the java files to get completely
1422 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1423 // We also don't want to run this if errorprone is enabled by default for
1424 // this module, or else we could have duplicated errorprone messages.
1425 errorproneFlags := enableErrorproneFlags(flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001426 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001427 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001428
Vadim Spivak3c496f02023-06-08 06:14:59 +00001429 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
Cole Faust75fffb12021-06-13 15:23:16 -07001430 "errorprone", "errorprone")
1431
Jaewoong Jung26342642021-03-17 15:56:23 -07001432 extraJarDeps = append(extraJarDeps, errorprone)
1433 }
1434
1435 if enableSharding {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001436 if len(shardingHeaderJars) > 0 {
1437 flags.classpath = append(classpath(slices.Clone(shardingHeaderJars)), flags.classpath...)
Colin Cross3d56ed52021-11-18 22:23:12 -08001438 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001439 shardSize := int(*(j.properties.Javac_shard_size))
1440 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001441 if len(uniqueJavaFiles) > 0 {
1442 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001443 for idx, shardSrc := range shardSrcs {
1444 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1445 nil, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001446 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
1447 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001448 }
1449 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001450 // Assume approximately 5 sources per srcjar.
1451 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1452 // 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 -07001453 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001454 startIdx := len(shardSrcs)
1455 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1456 for idx, shardSrcJars := range shardSrcJarsList {
1457 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1458 nil, shardSrcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001459 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
1460 localImplementationJars = append(localImplementationJars, classes)
Colin Crossa052ddb2023-09-25 21:46:58 -07001461 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001462 }
1463 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001464 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001465 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
1466 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001467 }
1468 if ctx.Failed() {
1469 return
1470 }
1471 }
1472
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001473 localImplementationJars = append(localImplementationJars, extraCombinedJars...)
Colin Crossfd620b22024-02-23 10:05:21 -08001474
Jaewoong Jung26342642021-03-17 15:56:23 -07001475 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1476
1477 var includeSrcJar android.WritablePath
1478 if Bool(j.properties.Include_srcs) {
1479 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1480 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1481 }
1482
1483 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1484 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
1485 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
1486 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1487
1488 var resArgs []string
1489 var resDeps android.Paths
1490
1491 resArgs = append(resArgs, dirArgs...)
1492 resDeps = append(resDeps, dirDeps...)
1493
1494 resArgs = append(resArgs, fileArgs...)
1495 resDeps = append(resDeps, fileDeps...)
1496
1497 resArgs = append(resArgs, extraArgs...)
1498 resDeps = append(resDeps, extraDeps...)
1499
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001500 var localResourceJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001501 if len(resArgs) > 0 {
1502 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1503 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001504 if ctx.Failed() {
1505 return
1506 }
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001507 localResourceJars = append(localResourceJars, resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001508 }
1509
Jaewoong Jung26342642021-03-17 15:56:23 -07001510 if Bool(j.properties.Include_srcs) {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001511 localResourceJars = append(localResourceJars, includeSrcJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001512 }
1513
1514 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1515 if len(services) > 0 {
1516 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1517 var zipargs []string
1518 for _, file := range services {
1519 serviceFile := file.String()
1520 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1521 }
1522 rule := zip
1523 args := map[string]string{
1524 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1525 }
1526 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1527 rule = zipRE
1528 args["implicits"] = strings.Join(services.Strings(), ",")
1529 }
1530 ctx.Build(pctx, android.BuildParams{
1531 Rule: rule,
1532 Output: servicesJar,
1533 Implicits: services,
1534 Args: args,
1535 })
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001536 localResourceJars = append(localResourceJars, servicesJar)
1537 }
1538
1539 completeStaticLibsResourceJars := android.NewDepSet(android.PREORDER, localResourceJars, deps.transitiveStaticLibsResourceJars)
1540
1541 var combinedResourceJar android.Path
1542 var resourceJars android.Paths
1543 if ctx.Config().UseTransitiveJarsInClasspath() {
1544 resourceJars = completeStaticLibsResourceJars.ToList()
1545 } else {
1546 resourceJars = append(slices.Clone(localResourceJars), deps.staticResourceJars...)
1547 }
1548 if len(resourceJars) == 1 {
1549 combinedResourceJar = resourceJars[0]
1550 } else if len(resourceJars) > 0 {
1551 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1552 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1553 false, nil, nil)
1554 combinedResourceJar = combinedJar
1555 }
1556
1557 manifest := j.overrideManifest
1558 if !manifest.Valid() && j.properties.Manifest != nil {
1559 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Jaewoong Jung26342642021-03-17 15:56:23 -07001560 }
1561
1562 // Combine the classes built from sources, any manifests, and any static libraries into
1563 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross7707b242024-07-26 12:02:36 -07001564 var outputFile android.Path
Jaewoong Jung26342642021-03-17 15:56:23 -07001565
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001566 completeStaticLibsImplementationJars := android.NewDepSet(android.PREORDER, localImplementationJars, deps.transitiveStaticLibsImplementationJars)
1567
1568 var jars android.Paths
1569 if ctx.Config().UseTransitiveJarsInClasspath() {
1570 jars = completeStaticLibsImplementationJars.ToList()
1571 } else {
1572 jars = append(slices.Clone(localImplementationJars), deps.staticJars...)
1573 }
1574
1575 jars = append(jars, extraDepCombinedJars...)
1576
Jaewoong Jung26342642021-03-17 15:56:23 -07001577 if len(jars) == 1 && !manifest.Valid() {
1578 // Optimization: skip the combine step as there is nothing to do
1579 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1580 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001581 // any if len(extraJars) == 0.
Jaewoong Jung26342642021-03-17 15:56:23 -07001582
Jihoon Kang1147b312023-06-08 23:25:57 +00001583 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1584 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1585 // either with .from-source or .from-text suffix.
1586 // outputFile should be agnostic to the build configuration,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001587 // thus copy the single input static lib in order to prevent the static lib from being exposed
Jihoon Kang1147b312023-06-08 23:25:57 +00001588 // to the copy rules.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001589 if stub, _ := moduleStubLinkType(j); stub {
1590 copiedJar := android.PathForModuleOut(ctx, "combined", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001591 ctx.Build(pctx, android.BuildParams{
1592 Rule: android.Cp,
1593 Input: jars[0],
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001594 Output: copiedJar,
Jaewoong Jung26342642021-03-17 15:56:23 -07001595 })
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001596 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, android.Paths{copiedJar}, nil)
1597 outputFile = copiedJar
Colin Cross7707b242024-07-26 12:02:36 -07001598 } else {
1599 outputFile = jars[0]
Jaewoong Jung26342642021-03-17 15:56:23 -07001600 }
1601 } else {
1602 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1603 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1604 false, nil, nil)
Colin Cross7707b242024-07-26 12:02:36 -07001605 outputFile = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001606 }
1607
1608 // jarjar implementation jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001609 jarjarFile, jarjarred := j.jarjarIfNecessary(ctx, outputFile, jarName, "")
1610 if jarjarred {
1611 localImplementationJars = android.Paths{jarjarFile}
1612 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
1613 }
Colin Crossedec77c2024-07-26 15:25:40 -07001614 outputFile = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001615
Colin Crossedec77c2024-07-26 15:25:40 -07001616 // jarjar resource jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001617 if combinedResourceJar != nil {
1618 resourceJarJarFile, jarjarred := j.jarjarIfNecessary(ctx, combinedResourceJar, jarName, "resource")
1619 combinedResourceJar = resourceJarJarFile
1620 if jarjarred {
1621 localResourceJars = android.Paths{resourceJarJarFile}
1622 completeStaticLibsResourceJars = android.NewDepSet(android.PREORDER, localResourceJars, nil)
1623 }
Colin Crossedec77c2024-07-26 15:25:40 -07001624 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001625
Colin Crossedec77c2024-07-26 15:25:40 -07001626 if ctx.Failed() {
1627 return
Jaewoong Jung26342642021-03-17 15:56:23 -07001628 }
1629
Makoto Onuki7ded3822024-03-28 14:42:20 -07001630 if j.ravenizer.enabled {
1631 ravenizerInput := outputFile
1632 ravenizerOutput := android.PathForModuleOut(ctx, "ravenizer", jarName)
1633 ctx.Build(pctx, android.BuildParams{
1634 Rule: ravenizer,
1635 Description: "ravenizer",
1636 Input: ravenizerInput,
1637 Output: ravenizerOutput,
1638 })
1639 outputFile = ravenizerOutput
Colin Cross7e863852024-09-06 14:42:38 -07001640 localImplementationJars = android.Paths{ravenizerOutput}
1641 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
Makoto Onuki7ded3822024-03-28 14:42:20 -07001642 }
1643
Yihan Dong8be09c22024-08-29 15:32:13 +08001644 if j.shouldApiMapper() {
1645 inputFile := outputFile
1646 apiMapperFile := android.PathForModuleOut(ctx, "apimapper", jarName)
1647 ctx.Build(pctx, android.BuildParams{
1648 Rule: apimapper,
1649 Description: "apimapper",
1650 Input: inputFile,
1651 Output: apiMapperFile,
1652 })
1653 outputFile = apiMapperFile
Colin Cross7e863852024-09-06 14:42:38 -07001654 localImplementationJars = android.Paths{apiMapperFile}
1655 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
Yihan Dong8be09c22024-08-29 15:32:13 +08001656 }
1657
Jaewoong Jung26342642021-03-17 15:56:23 -07001658 // Check package restrictions if necessary.
1659 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001660 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001661 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001662
1663 // Create a rule to copy the output jar to another path and add a validate dependency that
1664 // will check that the jar only contains the permitted packages. The new location will become
1665 // the output file of this module.
1666 inputFile := outputFile
Colin Cross7707b242024-07-26 12:02:36 -07001667 packageCheckOutputFile := android.PathForModuleOut(ctx, "package-check", jarName)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001668 ctx.Build(pctx, android.BuildParams{
1669 Rule: android.Cp,
1670 Input: inputFile,
Colin Cross7707b242024-07-26 12:02:36 -07001671 Output: packageCheckOutputFile,
Paul Duffin08a18bf2021-10-01 13:19:58 +01001672 // Make sure that any dependency on the output file will cause ninja to run the package check
1673 // rule.
1674 Validation: pkgckFile,
1675 })
Colin Cross7707b242024-07-26 12:02:36 -07001676 outputFile = packageCheckOutputFile
Colin Cross7e863852024-09-06 14:42:38 -07001677 localImplementationJars = android.Paths{packageCheckOutputFile}
1678 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001679
1680 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001681 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001682
1683 if ctx.Failed() {
1684 return
1685 }
1686 }
1687
1688 j.implementationJarFile = outputFile
1689 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001690 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1691 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1692 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1693 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1694 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1695 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1696 j.headerJarFile = headerJarFile
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001697 if len(localImplementationJars) == 1 && ctx.Config().UseTransitiveJarsInClasspath() {
1698 localHeaderJarFile := android.PathForModuleOut(ctx, "local-javac-header", jarName)
1699 convertImplementationJarToHeaderJar(ctx, localImplementationJars[0], localHeaderJarFile)
1700 localHeaderJars = append(localHeaderJars, localHeaderJarFile)
1701 } else {
1702 localHeaderJars = append(localHeaderJars, headerJarFile)
1703 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001704 }
1705
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001706 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1707 specs := j.jacocoModuleToZipCommand(ctx)
1708 if ctx.Failed() {
1709 return
1710 }
1711
Colin Crossb323c912024-09-24 15:21:00 -07001712 completeStaticLibsImplementationJarsToCombine := completeStaticLibsImplementationJars
1713
Jaewoong Jung26342642021-03-17 15:56:23 -07001714 if j.shouldInstrument(ctx) {
Colin Crossb323c912024-09-24 15:21:00 -07001715 instrumentedOutputFile := j.instrument(ctx, flags, outputFile, jarName, specs)
1716 completeStaticLibsImplementationJarsToCombine = android.NewDepSet(android.PREORDER, android.Paths{instrumentedOutputFile}, nil)
1717 outputFile = instrumentedOutputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001718 }
1719
1720 // merge implementation jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001721 var implementationAndResourcesJarsToCombine android.Paths
1722 if ctx.Config().UseTransitiveJarsInClasspath() {
1723 resourceJars := completeStaticLibsResourceJars.ToList()
1724 if len(resourceJars) > 0 {
Colin Crossb323c912024-09-24 15:21:00 -07001725 implementationAndResourcesJarsToCombine = append(resourceJars, completeStaticLibsImplementationJarsToCombine.ToList()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001726 implementationAndResourcesJarsToCombine = append(implementationAndResourcesJarsToCombine, extraDepCombinedJars...)
1727 }
1728 } else {
1729 if combinedResourceJar != nil {
1730 implementationAndResourcesJarsToCombine = android.Paths{combinedResourceJar, outputFile}
1731 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001732 }
1733
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001734 if len(implementationAndResourcesJarsToCombine) > 0 {
1735 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
1736 TransformJarsToJar(ctx, combinedJar, "for resources", implementationAndResourcesJarsToCombine, manifest,
1737 false, nil, nil)
1738 outputFile = combinedJar
1739 }
1740
1741 j.implementationAndResourcesJar = outputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001742
1743 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001744 compileDex := j.dexProperties.Compile_dex
Colin Crossff694a82023-12-13 15:54:49 -08001745 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -07001746 if j.DirectlyInAnyApex() && !apexInfo.IsForPlatform() {
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001747 if compileDex == nil {
1748 compileDex = proptools.BoolPtr(true)
Jaewoong Jung26342642021-03-17 15:56:23 -07001749 }
1750 if j.deviceProperties.Hostdex == nil {
1751 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1752 }
1753 }
1754
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001755 if ctx.Device() && (Bool(j.properties.Installable) || Bool(compileDex)) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001756 if j.hasCode(ctx) {
1757 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001758 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001759 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1760 }
1761 // Dex compilation
Colin Cross7707b242024-07-26 12:02:36 -07001762 var dexOutputFile android.Path
Spandan Dasc404cc72023-02-23 18:05:05 +00001763 params := &compileDexParams{
1764 flags: flags,
1765 sdkVersion: j.SdkVersion(ctx),
1766 minSdkVersion: j.MinSdkVersion(ctx),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001767 classesJar: outputFile,
Spandan Dasc404cc72023-02-23 18:05:05 +00001768 jarName: jarName,
1769 }
Cole Fausteb032462024-09-19 11:12:54 -07001770 if j.GetProfileGuided(ctx) && j.optimizeOrObfuscateEnabled() && !j.EnableProfileRewriting(ctx) {
Spandan Das15a67112024-05-30 00:07:40 +00001771 ctx.PropertyErrorf("enable_profile_rewriting",
1772 "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.",
1773 )
1774 }
Cole Fausteb032462024-09-19 11:12:54 -07001775 if j.EnableProfileRewriting(ctx) {
1776 profile := j.GetProfile(ctx)
1777 if profile == "" || !j.GetProfileGuided(ctx) {
Spandan Das3dbda182024-05-20 22:23:10 +00001778 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1779 }
1780 params.artProfileInput = &profile
1781 }
1782 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001783 if ctx.Failed() {
1784 return
1785 }
1786
Spandan Das3dbda182024-05-20 22:23:10 +00001787 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1788 if dexArtProfileOutput != nil {
Colin Cross7707b242024-07-26 12:02:36 -07001789 j.dexpreopter.SetRewrittenProfile(dexArtProfileOutput)
Spandan Das3dbda182024-05-20 22:23:10 +00001790 }
1791
Jaewoong Jung26342642021-03-17 15:56:23 -07001792 // merge dex jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001793 var dexAndResourceJarsToCombine android.Paths
1794 if ctx.Config().UseTransitiveJarsInClasspath() {
1795 resourceJars := completeStaticLibsResourceJars.ToList()
1796 if len(resourceJars) > 0 {
1797 dexAndResourceJarsToCombine = append(android.Paths{dexOutputFile}, resourceJars...)
1798 }
1799 } else {
1800 if combinedResourceJar != nil {
1801 dexAndResourceJarsToCombine = android.Paths{dexOutputFile, combinedResourceJar}
1802 }
1803 }
1804 if len(dexAndResourceJarsToCombine) > 0 {
Colin Cross7707b242024-07-26 12:02:36 -07001805 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001806 TransformJarsToJar(ctx, combinedJar, "for dex resources", dexAndResourceJarsToCombine, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07001807 false, nil, nil)
1808 if *j.dexProperties.Uncompress_dex {
Colin Cross7707b242024-07-26 12:02:36 -07001809 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
Cole Faust51d7bfd2023-09-07 05:31:32 +00001810 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001811 dexOutputFile = combinedAlignedJar
1812 } else {
1813 dexOutputFile = combinedJar
1814 }
1815 }
1816
Paul Duffin4de94502021-05-16 05:21:16 +01001817 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001818
1819 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001820
1821 // Encode hidden API flags in dex file, if needed.
1822 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1823
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001824 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001825
1826 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001827 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1828 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1829 libName = strings.TrimSuffix(libName, ".impl")
1830 }
1831 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001832
1833 outputFile = dexOutputFile
Colin Crossa6182ab2024-08-21 10:47:44 -07001834
1835 ctx.CheckbuildFile(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001836 } else {
1837 // There is no code to compile into a dex jar, make sure the resources are propagated
1838 // to the APK if this is an app.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001839 j.dexJarFile = makeDexJarPathFromPath(combinedResourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001840 }
1841
1842 if ctx.Failed() {
1843 return
1844 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001845 }
1846
1847 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001848 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001849 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001850 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001851 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001852 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001853 }
1854 }
1855
1856 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001857 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1858 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001859 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1860 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001861 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001862 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001863 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001864 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001865 j.linter.javaLanguageLevel = flags.javaVersion.String()
1866 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001867 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001868 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1869 j.linter.buildModuleReportZip = true
1870 }
1871 j.linter.lint(ctx)
1872 }
1873
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001874 j.collectTransitiveSrcFiles(ctx, srcFiles)
1875
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001876 if ctx.Config().UseTransitiveJarsInClasspath() {
1877 if len(localImplementationJars) > 0 || len(localResourceJars) > 0 || len(localHeaderJars) > 0 {
1878 ctx.CheckbuildFile(localImplementationJars...)
1879 ctx.CheckbuildFile(localResourceJars...)
1880 ctx.CheckbuildFile(localHeaderJars...)
1881 } else {
1882 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1883 ctx.UncheckedModule()
1884 }
1885 } else {
1886 ctx.CheckbuildFile(j.implementationJarFile)
1887 ctx.CheckbuildFile(j.headerJarFile)
1888 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001889
Colin Cross7727c7f2024-07-18 15:36:32 -07001890 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001891 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1892 RepackagedHeaderJars: android.PathsIfNonNil(repackagedHeaderJarFile),
1893
1894 LocalHeaderJars: localHeaderJars,
1895 TransitiveStaticLibsHeaderJars: android.NewDepSet(android.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
1896 TransitiveStaticLibsImplementationJars: completeStaticLibsImplementationJars,
1897 TransitiveStaticLibsResourceJars: completeStaticLibsResourceJars,
1898
Colin Cross9ffaf282024-08-12 13:50:09 -07001899 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1900 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001901 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1902 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001903 ResourceJars: android.PathsIfNonNil(combinedResourceJar),
Jihoon Kang705e63e2024-03-13 01:21:16 +00001904 AidlIncludeDirs: j.exportAidlIncludeDirs,
1905 SrcJarArgs: j.srcJarArgs,
1906 SrcJarDeps: j.srcJarDeps,
1907 TransitiveSrcFiles: j.transitiveSrcFiles,
1908 ExportedPlugins: j.exportedPluginJars,
1909 ExportedPluginClasses: j.exportedPluginClasses,
1910 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1911 JacocoReportClassesFile: j.jacocoReportClassesFile,
1912 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001913 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001914 })
1915
1916 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1917 j.outputFile = outputFile.WithoutRel()
1918}
1919
Cole Faustb7493472024-08-28 11:55:52 -07001920func (j *Module) useCompose(ctx android.BaseModuleContext) bool {
1921 return android.InList("androidx.compose.runtime_runtime", j.staticLibs(ctx))
Colin Crossa1ff7c62021-09-17 14:11:52 -07001922}
1923
Colin Crosscde55342024-03-27 14:11:51 -07001924func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []*android.DepSet[android.Path]) {
Sam Delmerico95d70942023-08-02 18:00:35 -04001925 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -08001926 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001927 depTag := ctx.OtherModuleDependencyTag(m)
1928
1929 if depProguardInfo.UnconditionallyExportedProguardFlags != nil {
1930 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1931 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1932 }
1933
1934 if depTag == staticLibTag && depProguardInfo.ProguardFlagsFiles != nil {
1935 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
1936 }
1937 })
1938
Colin Crosscde55342024-03-27 14:11:51 -07001939 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
1940}
1941
1942func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
1943 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
1944
Sam Delmerico95d70942023-08-02 18:00:35 -04001945 directUnconditionalExportedFlags := android.Paths{}
1946 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
1947 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
1948 if exportUnconditionally {
1949 // if we explicitly export, then our unconditional exports are the same as our transitive flags
1950 transitiveUnconditionalExportedFlags = transitiveProguardFlags
1951 directUnconditionalExportedFlags = proguardFlagsForThisModule
1952 }
1953
1954 return ProguardSpecInfo{
1955 Export_proguard_flags_files: exportUnconditionally,
1956 ProguardFlagsFiles: android.NewDepSet[android.Path](
1957 android.POSTORDER,
1958 proguardFlagsForThisModule,
1959 transitiveProguardFlags,
1960 ),
1961 UnconditionallyExportedProguardFlags: android.NewDepSet[android.Path](
1962 android.POSTORDER,
1963 directUnconditionalExportedFlags,
1964 transitiveUnconditionalExportedFlags,
1965 ),
1966 }
1967
1968}
1969
Cole Faust75fffb12021-06-13 15:23:16 -07001970// Returns a copy of the supplied flags, but with all the errorprone-related
1971// fields copied to the regular build's fields.
1972func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
1973 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
1974
1975 if len(flags.errorProneExtraJavacFlags) > 0 {
1976 if len(flags.javacFlags) > 0 {
1977 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
1978 } else {
1979 flags.javacFlags = flags.errorProneExtraJavacFlags
1980 }
1981 }
1982 return flags
1983}
1984
Jaewoong Jung26342642021-03-17 15:56:23 -07001985func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
Colin Cross7707b242024-07-26 12:02:36 -07001986 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07001987
1988 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00001989 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001990 if idx >= 0 {
1991 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00001992 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001993 jarName += strconv.Itoa(idx)
1994 }
1995
Colin Cross7707b242024-07-26 12:02:36 -07001996 classes := android.PathForModuleOut(ctx, "javac", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001997 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001998
Cole Faust9decf832024-06-11 11:45:53 -07001999 if ctx.Config().EmitXrefRules() && ctx.Module() == ctx.PrimaryModule() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002000 extractionFile := android.PathForModuleOut(ctx, kzipName)
2001 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
2002 j.kytheFiles = append(j.kytheFiles, extractionFile)
2003 }
2004
Vadim Spivak3c496f02023-06-08 06:14:59 +00002005 if len(flags.processorPath) > 0 {
2006 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
2007 }
2008
Jaewoong Jung26342642021-03-17 15:56:23 -07002009 return classes
2010}
2011
2012// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
2013// since some of these flags may be used internally.
2014func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
2015 for _, flag := range flags {
2016 flag = strings.TrimSpace(flag)
2017
2018 if !strings.HasPrefix(flag, "-") {
2019 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
2020 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
2021 ctx.PropertyErrorf("kotlincflags",
2022 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
2023 } else if inList(flag, config.KotlincIllegalFlags) {
2024 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
2025 } else if flag == "-include-runtime" {
2026 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
2027 } else {
2028 args := strings.Split(flag, " ")
2029 if args[0] == "-kotlin-home" {
2030 ctx.PropertyErrorf("kotlincflags",
2031 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
2032 }
2033 }
2034 }
2035}
2036
2037func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
2038 deps deps, flags javaBuilderFlags, jarName string,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002039 extraJars android.Paths) (localHeaderJars android.Paths, combinedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002040
Jaewoong Jung26342642021-03-17 15:56:23 -07002041 if len(srcFiles) > 0 || len(srcJars) > 0 {
2042 // Compile java sources into turbine.jar.
2043 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
2044 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002045 localHeaderJars = append(localHeaderJars, turbineJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07002046 }
2047
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002048 localHeaderJars = append(localHeaderJars, extraJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002049
2050 // Combine any static header libraries into classes-header.jar. If there is only
2051 // one input jar this step will be skipped.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002052 var jars android.Paths
2053 if ctx.Config().UseTransitiveJarsInClasspath() {
2054 depSet := android.NewDepSet(android.PREORDER, localHeaderJars, deps.transitiveStaticLibsHeaderJars)
2055 jars = depSet.ToList()
2056 } else {
2057 jars = append(slices.Clone(localHeaderJars), deps.staticHeaderJars...)
2058 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002059
2060 // we cannot skip the combine step for now if there is only one jar
2061 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
Colin Crossedec77c2024-07-26 15:25:40 -07002062 combinedHeaderJarOutputPath := android.PathForModuleOut(ctx, "turbine-combined", jarName)
2063 TransformJarsToJar(ctx, combinedHeaderJarOutputPath, "for turbine", jars, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07002064 false, nil, []string{"META-INF/TRANSITIVE"})
Jaewoong Jung26342642021-03-17 15:56:23 -07002065
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002066 return localHeaderJars, combinedHeaderJarOutputPath
Jaewoong Jung26342642021-03-17 15:56:23 -07002067}
2068
2069func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross7707b242024-07-26 12:02:36 -07002070 classesJar android.Path, jarName string, specs string) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002071
2072 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Cross7707b242024-07-26 12:02:36 -07002073 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07002074
2075 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
2076
2077 j.jacocoReportClassesFile = jacocoReportClassesFile
2078
2079 return instrumentedJar
2080}
2081
Colin Cross9ffaf282024-08-12 13:50:09 -07002082type providesTransitiveHeaderJarsForR8 struct {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002083 // set of header jars for all transitive libs deps
Colin Cross9ffaf282024-08-12 13:50:09 -07002084 transitiveLibsHeaderJarsForR8 *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002085 // set of header jars for all transitive static libs deps
Colin Cross9ffaf282024-08-12 13:50:09 -07002086 transitiveStaticLibsHeaderJarsForR8 *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002087}
2088
Colin Cross9ffaf282024-08-12 13:50:09 -07002089// collectTransitiveHeaderJarsForR8 visits direct dependencies and collects all transitive libs and static_libs
2090// header jars. The semantics of the collected jars are odd (it collects combined jars that contain the static
2091// libs, but also the static libs, and it collects transitive libs dependencies of static_libs), so these
2092// are only used to expand the --lib arguments to R8.
2093func (j *providesTransitiveHeaderJarsForR8) collectTransitiveHeaderJarsForR8(ctx android.ModuleContext) {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002094 directLibs := android.Paths{}
2095 directStaticLibs := android.Paths{}
Colin Crossc85750b2022-04-21 12:50:51 -07002096 transitiveLibs := []*android.DepSet[android.Path]{}
2097 transitiveStaticLibs := []*android.DepSet[android.Path]{}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002098 ctx.VisitDirectDeps(func(module android.Module) {
2099 // don't add deps of the prebuilt version of the same library
2100 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
2101 return
2102 }
2103
Colin Cross7727c7f2024-07-18 15:36:32 -07002104 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2105 tag := ctx.OtherModuleDependencyTag(module)
2106 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
2107 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
2108 directLibs = append(directLibs, dep.HeaderJars...)
2109 } else if tag == staticLibTag {
2110 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
2111 } else {
2112 // Don't propagate transitive libs for other kinds of dependencies.
2113 return
2114 }
Jared Dukeefb6d602023-10-27 18:47:10 +00002115
Colin Cross9ffaf282024-08-12 13:50:09 -07002116 if dep.TransitiveLibsHeaderJarsForR8 != nil {
2117 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJarsForR8)
Colin Cross7727c7f2024-07-18 15:36:32 -07002118 }
Colin Cross9ffaf282024-08-12 13:50:09 -07002119 if dep.TransitiveStaticLibsHeaderJarsForR8 != nil {
2120 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJarsForR8)
Colin Cross7727c7f2024-07-18 15:36:32 -07002121 }
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002122
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002123 }
2124 })
Colin Cross9ffaf282024-08-12 13:50:09 -07002125 j.transitiveLibsHeaderJarsForR8 = android.NewDepSet(android.POSTORDER, directLibs, transitiveLibs)
2126 j.transitiveStaticLibsHeaderJarsForR8 = android.NewDepSet(android.POSTORDER, directStaticLibs, transitiveStaticLibs)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002127}
2128
Jaewoong Jung26342642021-03-17 15:56:23 -07002129func (j *Module) HeaderJars() android.Paths {
2130 if j.headerJarFile == nil {
2131 return nil
2132 }
2133 return android.Paths{j.headerJarFile}
2134}
2135
2136func (j *Module) ImplementationJars() android.Paths {
2137 if j.implementationJarFile == nil {
2138 return nil
2139 }
2140 return android.Paths{j.implementationJarFile}
2141}
2142
Spandan Das59a4a2b2024-01-09 21:35:56 +00002143func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002144 return j.dexJarFile
2145}
2146
2147func (j *Module) DexJarInstallPath() android.Path {
2148 return j.installFile
2149}
2150
2151func (j *Module) ImplementationAndResourcesJars() android.Paths {
2152 if j.implementationAndResourcesJar == nil {
2153 return nil
2154 }
2155 return android.Paths{j.implementationAndResourcesJar}
2156}
2157
2158func (j *Module) AidlIncludeDirs() android.Paths {
2159 // exportAidlIncludeDirs is type android.Paths already
2160 return j.exportAidlIncludeDirs
2161}
2162
2163func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2164 return j.classLoaderContexts
2165}
2166
2167// Collect information for opening IDE project files in java/jdeps.go.
Cole Faustb36d31d2024-08-27 16:04:28 -07002168func (j *Module) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002169 // jarjar rules will repackage the sources. To prevent misleading results, IdeInfo should contain the
2170 // repackaged jar instead of the input sources.
Jaewoong Jung26342642021-03-17 15:56:23 -07002171 if j.expandJarjarRules != nil {
2172 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002173 dpInfo.Jars = append(dpInfo.Jars, j.headerJarFile.String())
2174 } else {
2175 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2176 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2177 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002178 }
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002179 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2180 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Cole Faustb7493472024-08-28 11:55:52 -07002181 dpInfo.Static_libs = append(dpInfo.Static_libs, j.staticLibs(ctx)...)
Yikef6282022022-04-13 20:41:01 +08002182 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002183}
2184
2185func (j *Module) CompilerDeps() []string {
Spandan Das8aac9932024-07-18 23:14:13 +00002186 return j.compileDepNames
Jaewoong Jung26342642021-03-17 15:56:23 -07002187}
2188
2189func (j *Module) hasCode(ctx android.ModuleContext) bool {
2190 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2191 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2192}
2193
2194// Implements android.ApexModule
2195func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
2196 return j.depIsInSameApex(ctx, dep)
2197}
2198
2199// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002200func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002201 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002202 minSdkVersion := j.MinSdkVersion(ctx)
2203 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002204 return fmt.Errorf("min_sdk_version is not specified")
2205 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002206 // If the module is compiling against core (via sdk_version), skip comparison check.
2207 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002208 return nil
2209 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002210 if minSdkVersion.GreaterThan(sdkVersion) {
2211 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002212 }
2213 return nil
2214}
2215
2216func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002217 if j.stem == "" {
2218 panic("Stem() called before stem property was set")
2219 }
2220 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002221}
2222
Jaewoong Jung26342642021-03-17 15:56:23 -07002223func (j *Module) JacocoReportClassesFile() android.Path {
2224 return j.jacocoReportClassesFile
2225}
2226
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002227func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
2228 var fromDeps []*android.DepSet[android.Path]
2229 ctx.VisitDirectDeps(func(module android.Module) {
2230 tag := ctx.OtherModuleDependencyTag(module)
2231 if tag == staticLibTag {
Colin Cross7727c7f2024-07-18 15:36:32 -07002232 if depInfo, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2233 if depInfo.TransitiveSrcFiles != nil {
2234 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
2235 }
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002236 }
2237 }
2238 })
2239
2240 j.transitiveSrcFiles = android.NewDepSet(android.POSTORDER, mine, fromDeps)
2241}
2242
Jaewoong Jung26342642021-03-17 15:56:23 -07002243func (j *Module) IsInstallable() bool {
2244 return Bool(j.properties.Installable)
2245}
2246
2247type sdkLinkType int
2248
2249const (
2250 // TODO(jiyong) rename these for better readability. Make the allowed
2251 // and disallowed link types explicit
2252 // order is important here. See rank()
2253 javaCore sdkLinkType = iota
2254 javaSdk
2255 javaSystem
2256 javaModule
2257 javaSystemServer
2258 javaPlatform
2259)
2260
2261func (lt sdkLinkType) String() string {
2262 switch lt {
2263 case javaCore:
2264 return "core Java API"
2265 case javaSdk:
2266 return "Android API"
2267 case javaSystem:
2268 return "system API"
2269 case javaModule:
2270 return "module API"
2271 case javaSystemServer:
2272 return "system server API"
2273 case javaPlatform:
2274 return "private API"
2275 default:
2276 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2277 }
2278}
2279
2280// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2281// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2282// can't statically depend on modules that use Platform API.
2283func (lt sdkLinkType) rank() int {
2284 return int(lt)
2285}
2286
2287type moduleWithSdkDep interface {
2288 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002289 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002290}
2291
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002292func sdkLinkTypeFromSdkKind(k android.SdkKind) sdkLinkType {
2293 switch k {
2294 case android.SdkCore:
2295 return javaCore
2296 case android.SdkSystem:
2297 return javaSystem
2298 case android.SdkPublic:
2299 return javaSdk
2300 case android.SdkModule:
2301 return javaModule
2302 case android.SdkSystemServer:
2303 return javaSystemServer
2304 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
2305 return javaPlatform
2306 default:
2307 return javaSdk
2308 }
2309}
2310
Jiyong Park92315372021-04-02 08:45:46 +09002311func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002312 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002313 case android.SdkCore.DefaultJavaLibraryName(),
2314 "legacy.core.platform.api.stubs",
2315 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002316 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002317 "core-lambda-stubs",
Jihoon Kangb5078312023-03-29 23:25:49 +00002318 "core-generated-annotation-stubs":
Jaewoong Jung26342642021-03-17 15:56:23 -07002319 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002320 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002321 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002322 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002323 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002324 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002325 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002326 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002327 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002328 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002329 return javaSystem, true
2330 }
2331
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002332 if stub, linkType := moduleStubLinkType(m); stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07002333 return linkType, true
2334 }
2335
Jiyong Park92315372021-04-02 08:45:46 +09002336 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002337 if !ver.Valid() {
2338 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002339 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002340
2341 return sdkLinkTypeFromSdkKind(ver.Kind), false
Jaewoong Jung26342642021-03-17 15:56:23 -07002342}
2343
2344// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2345// this module's. See the comment on rank() for details and an example.
2346func (j *Module) checkSdkLinkType(
2347 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
2348 if ctx.Host() {
2349 return
2350 }
2351
Jiyong Park92315372021-04-02 08:45:46 +09002352 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002353 if stubs {
2354 return
2355 }
Jiyong Park92315372021-04-02 08:45:46 +09002356 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07002357
2358 if myLinkType.rank() < depLinkType.rank() {
2359 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2360 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2361 "property of the source or target module so that target module is built "+
2362 "with the same or smaller API set when compared to the source.",
2363 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2364 }
2365}
2366
2367func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2368 var deps deps
2369
Jiyong Park92315372021-04-02 08:45:46 +09002370 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002371
Colin Cross9ffaf282024-08-12 13:50:09 -07002372 j.collectTransitiveHeaderJarsForR8(ctx)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002373
2374 var transitiveBootClasspathHeaderJars []*android.DepSet[android.Path]
2375 var transitiveClasspathHeaderJars []*android.DepSet[android.Path]
2376 var transitiveJava9ClasspathHeaderJars []*android.DepSet[android.Path]
2377 var transitiveStaticJarsHeaderLibs []*android.DepSet[android.Path]
2378 var transitiveStaticJarsImplementationLibs []*android.DepSet[android.Path]
2379 var transitiveStaticJarsResourceLibs []*android.DepSet[android.Path]
2380
Jaewoong Jung26342642021-03-17 15:56:23 -07002381 ctx.VisitDirectDeps(func(module android.Module) {
2382 otherName := ctx.OtherModuleName(module)
2383 tag := ctx.OtherModuleDependencyTag(module)
2384
2385 if IsJniDepTag(tag) {
2386 // Handled by AndroidApp.collectAppDeps
2387 return
2388 }
2389 if tag == certificateTag {
2390 // Handled by AndroidApp.collectAppDeps
2391 return
2392 }
2393
Jihoon Kang28c96572024-09-11 23:44:44 +00002394 if _, ok := module.(SdkLibraryDependency); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -07002395 switch tag {
Jihoon Kang28c96572024-09-11 23:44:44 +00002396 case sdkLibTag, libTag, staticLibTag:
2397 sdkInfo, _ := android.OtherModuleProvider(ctx, module, SdkLibraryInfoProvider)
2398 generatingLibsString := android.PrettyConcat(
2399 getGeneratingLibs(ctx, j.SdkVersion(ctx), module.Name(), sdkInfo), true, "or")
2400 ctx.ModuleErrorf("cannot depend directly on java_sdk_library %q; try depending on %s instead", module.Name(), generatingLibsString)
Jaewoong Jung26342642021-03-17 15:56:23 -07002401 }
Colin Cross313aa542023-12-13 13:47:44 -08002402 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2403 if sdkLinkType != javaPlatform {
2404 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2405 // dep is a sysprop implementation library, but this module is not linking against
2406 // the platform, so it gets the sysprop public stubs library instead. Replace
2407 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2408 dep = syspropDep.JavaInfo
2409 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002410 }
2411 switch tag {
2412 case bootClasspathTag:
2413 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002414 if dep.TransitiveStaticLibsHeaderJars != nil {
2415 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2416 }
Liz Kammeref28a4c2022-09-23 16:50:56 -04002417 case sdkLibTag, libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002418 if _, ok := module.(*Plugin); ok {
2419 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2420 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002421 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002422 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002423 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2424 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2425 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2426 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002427 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2428 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2429 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002430
2431 if dep.TransitiveStaticLibsHeaderJars != nil {
2432 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2433 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002434 case java9LibTag:
2435 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002436 if dep.TransitiveStaticLibsHeaderJars != nil {
2437 transitiveJava9ClasspathHeaderJars = append(transitiveJava9ClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2438 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002439 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002440 if _, ok := module.(*Plugin); ok {
2441 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2442 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002443 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2444 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2445 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2446 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2447 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2448 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2449 // Turbine doesn't run annotation processors, so any module that uses an
2450 // annotation processor that generates API is incompatible with the turbine
2451 // optimization.
2452 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002453 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002454
2455 if dep.TransitiveStaticLibsHeaderJars != nil {
2456 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2457 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, dep.TransitiveStaticLibsHeaderJars)
2458 }
2459 if dep.TransitiveStaticLibsImplementationJars != nil {
2460 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, dep.TransitiveStaticLibsImplementationJars)
2461 }
2462 if dep.TransitiveStaticLibsResourceJars != nil {
2463 transitiveStaticJarsResourceLibs = append(transitiveStaticJarsResourceLibs, dep.TransitiveStaticLibsResourceJars)
2464 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002465 case pluginTag:
2466 if plugin, ok := module.(*Plugin); ok {
2467 if plugin.pluginProperties.Processor_class != nil {
2468 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
2469 } else {
2470 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2471 }
2472 // Turbine doesn't run annotation processors, so any module that uses an
2473 // annotation processor that generates API is incompatible with the turbine
2474 // optimization.
2475 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
2476 } else {
2477 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2478 }
2479 case errorpronePluginTag:
2480 if _, ok := module.(*Plugin); ok {
2481 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2482 } else {
2483 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2484 }
2485 case exportedPluginTag:
2486 if plugin, ok := module.(*Plugin); ok {
2487 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
2488 if plugin.pluginProperties.Processor_class != nil {
2489 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
2490 }
2491 // Turbine doesn't run annotation processors, so any module that uses an
2492 // annotation processor that generates API is incompatible with the turbine
2493 // optimization.
2494 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
2495 } else {
2496 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2497 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07002498 case kotlinPluginTag:
2499 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002500 case syspropPublicStubDepTag:
2501 // This is a sysprop implementation library, forward the JavaInfoProvider from
2502 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002503 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002504 JavaInfo: dep,
2505 })
2506 }
2507 } else if dep, ok := module.(android.SourceFileProducer); ok {
2508 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002509 case sdkLibTag, libTag:
Jaewoong Jung26342642021-03-17 15:56:23 -07002510 checkProducesJars(ctx, dep)
2511 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002512 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002513 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars,
2514 android.NewDepSet(android.PREORDER, dep.Srcs(), nil))
Jaewoong Jung26342642021-03-17 15:56:23 -07002515 case staticLibTag:
2516 checkProducesJars(ctx, dep)
2517 deps.classpath = append(deps.classpath, dep.Srcs()...)
2518 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2519 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002520
2521 depHeaderJars := android.NewDepSet(android.PREORDER, dep.Srcs(), nil)
2522 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, depHeaderJars)
2523 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, depHeaderJars)
2524 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, depHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002525 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002526 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002527 switch tag {
2528 case staticLibTag:
2529 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2530 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002531 } else {
2532 switch tag {
2533 case bootClasspathTag:
2534 // If a system modules dependency has been added to the bootclasspath
2535 // then add its libs to the bootclasspath.
Colin Crossb61c2262024-08-08 14:04:42 -07002536 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002537 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars...)
2538 if sm.TransitiveStaticLibsHeaderJars != nil {
2539 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars,
2540 sm.TransitiveStaticLibsHeaderJars)
2541 }
Colin Crossb61c2262024-08-08 14:04:42 -07002542 } else {
2543 ctx.PropertyErrorf("boot classpath dependency %q does not provide SystemModulesProvider",
2544 ctx.OtherModuleName(module))
2545 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002546
2547 case systemModulesTag:
2548 if deps.systemModules != nil {
2549 panic("Found two system module dependencies")
2550 }
Colin Crossb61c2262024-08-08 14:04:42 -07002551 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2552 deps.systemModules = &systemModules{sm.OutputDir, sm.OutputDirDeps}
2553 } else {
2554 ctx.PropertyErrorf("system modules dependency %q does not provide SystemModulesProvider",
2555 ctx.OtherModuleName(module))
2556 }
Paul Duffin53a70a42022-01-11 14:35:55 +00002557
2558 case instrumentationForTag:
2559 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 -07002560 }
2561 }
2562
Spandan Das8aac9932024-07-18 23:14:13 +00002563 if android.InList(tag, compileDependencyTags) {
2564 // Add the dependency name to compileDepNames so that it can be recorded in module_bp_java_deps.json
2565 j.compileDepNames = append(j.compileDepNames, otherName)
2566 }
2567
Jaewoong Jung26342642021-03-17 15:56:23 -07002568 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002569 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002570 })
2571
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002572 deps.transitiveStaticLibsHeaderJars = transitiveStaticJarsHeaderLibs
2573 deps.transitiveStaticLibsImplementationJars = transitiveStaticJarsImplementationLibs
2574 deps.transitiveStaticLibsResourceJars = transitiveStaticJarsResourceLibs
2575
2576 if ctx.Config().UseTransitiveJarsInClasspath() {
2577 depSet := android.NewDepSet(android.PREORDER, nil, transitiveClasspathHeaderJars)
2578 deps.classpath = depSet.ToList()
2579 depSet = android.NewDepSet(android.PREORDER, nil, transitiveBootClasspathHeaderJars)
2580 deps.bootClasspath = depSet.ToList()
2581 depSet = android.NewDepSet(android.PREORDER, nil, transitiveJava9ClasspathHeaderJars)
2582 deps.java9Classpath = depSet.ToList()
2583 }
2584
2585 if ctx.Device() {
2586 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
2587 if sdkDep.invalidVersion {
2588 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2589 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2590 } else if sdkDep.useFiles {
2591 // sdkDep.jar is actually equivalent to turbine header.jar.
2592 deps.classpath = append(slices.Clone(classpath(sdkDep.jars)), deps.classpath...)
2593 deps.dexClasspath = append(slices.Clone(classpath(sdkDep.jars)), deps.dexClasspath...)
2594 deps.aidlPreprocess = sdkDep.aidl
2595 // Add the sdk module dependency to `compileDepNames`.
2596 // This ensures that the dependency is reported in `module_bp_java_deps.json`
2597 // TODO (b/358608607): Move this to decodeSdkDep
2598 sdkSpec := android.SdkContext(j).SdkVersion(ctx)
2599 j.compileDepNames = append(j.compileDepNames, fmt.Sprintf("sdk_%s_%s_android", sdkSpec.Kind.String(), sdkSpec.ApiLevel.String()))
2600 } else {
2601 deps.aidlPreprocess = sdkDep.aidl
2602 }
2603 }
2604
Jaewoong Jung26342642021-03-17 15:56:23 -07002605 return deps
2606}
2607
Joe Onorato349ae8d2024-02-05 22:46:00 +00002608// Provider for jarjar renaming rules.
2609//
2610// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2611// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2612// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2613// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2614// be renamed from that module.
2615// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002616type DependencyUse int
2617
2618const (
2619 RenameUseInvalid DependencyUse = iota
2620 RenameUseInclude
2621 RenameUseExclude
2622)
2623
2624type RenameUseElement struct {
2625 DepName string
2626 RenameUse DependencyUse
2627 Why string // token for determining where in the logic the decision was made.
2628}
2629
Joe Onorato349ae8d2024-02-05 22:46:00 +00002630type JarJarProviderData struct {
2631 // Mapping of class names: original --> renamed. If the value is "", the class will be
2632 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2633 // attribute). Rdeps of that module will inherit the renaming.
LaMont Jones63683e42024-02-08 14:30:45 -08002634 Rename map[string]string
2635 RenameUse []RenameUseElement
Joe Onorato349ae8d2024-02-05 22:46:00 +00002636}
2637
2638func (this JarJarProviderData) GetDebugString() string {
2639 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002640 for _, k := range android.SortedKeys(this.Rename) {
2641 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002642 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2643 result += k + "--&gt;" + v + ";"
2644 }
2645 }
2646 return result
2647}
2648
2649var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2650
2651var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2652
2653func init() {
2654 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
Yu Liu26a716d2024-08-30 23:40:32 +00002655
2656 gob.Register(BaseJarJarProviderData{})
Joe Onorato349ae8d2024-02-05 22:46:00 +00002657}
2658
2659// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2660// whether they are java modules or not.
2661type BaseJarJarProviderData struct {
2662 JarJarProviderData JarJarProviderData
2663}
2664
2665func (this BaseJarJarProviderData) GetDebugString() string {
2666 return this.JarJarProviderData.GetDebugString()
2667}
2668
2669var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2670
2671// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2672// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2673// either JarJarProvider or BaseJarJarProvider.
2674func mergeJarJarPrefixes(ctx android.ModuleContext) {
2675 mod := ctx.Module()
2676 // Explicitly avoid propagating into some module types.
2677 switch reflect.TypeOf(mod).String() {
2678 case "*java.Droidstubs":
2679 return
2680 }
2681 jarJarData := collectDirectDepsProviders(ctx)
2682 if jarJarData != nil {
2683 providerData := BaseJarJarProviderData{
2684 JarJarProviderData: *jarJarData,
2685 }
2686 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2687 }
2688
2689}
2690
2691// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2692func (module *Module) addJarJarRenameRule(original string, renamed string) {
2693 if module.jarjarRenameRules == nil {
2694 module.jarjarRenameRules = make(map[string]string)
2695 }
2696 module.jarjarRenameRules[original] = renamed
2697}
2698
2699func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2700 // Gather repackage information from deps
2701 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002702
2703 module := ctx.Module()
2704 moduleName := module.Name()
2705
Joe Onorato349ae8d2024-02-05 22:46:00 +00002706 ctx.VisitDirectDepsIgnoreBlueprint(func(m android.Module) {
LaMont Jones63683e42024-02-08 14:30:45 -08002707 tag := ctx.OtherModuleDependencyTag(m)
2708 // This logic mirrors that in (*Module).collectDeps above. There are several places
2709 // where we explicitly return RenameUseExclude, even though it is the default, to
2710 // indicate that it has been verified to be the case.
2711 //
2712 // Note well: there are probably cases that are getting to the unconditional return
2713 // and are therefore wrong.
2714 shouldIncludeRenames := func() (DependencyUse, string) {
2715 if moduleName == m.Name() {
2716 return RenameUseInclude, "name" // If we have the same module name, include the renames.
2717 }
2718 if sc, ok := module.(android.SdkContext); ok {
2719 if ctx.Device() {
2720 sdkDep := decodeSdkDep(ctx, sc)
2721 if !sdkDep.invalidVersion && sdkDep.useFiles {
2722 return RenameUseExclude, "useFiles"
Joe Onorato349ae8d2024-02-05 22:46:00 +00002723 }
2724 }
LaMont Jones63683e42024-02-08 14:30:45 -08002725 }
2726 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
2727 return RenameUseExclude, "tags"
2728 }
2729 if _, ok := m.(SdkLibraryDependency); ok {
2730 switch tag {
2731 case sdkLibTag, libTag:
2732 return RenameUseExclude, "sdklibdep" // matches collectDeps()
2733 }
2734 return RenameUseInvalid, "sdklibdep" // dep is not used in collectDeps()
2735 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2736 switch ji.StubsLinkType {
2737 case Stubs:
2738 return RenameUseExclude, "info"
2739 case Implementation:
2740 return RenameUseInclude, "info"
2741 default:
LaMont Jones09721862024-06-11 10:30:50 -07002742 //fmt.Printf("collectDirectDepsProviders: %v -> %v StubsLinkType unknown\n", module, m)
LaMont Jones63683e42024-02-08 14:30:45 -08002743 // Fall through to the heuristic logic.
2744 }
2745 switch reflect.TypeOf(m).String() {
2746 case "*java.GeneratedJavaLibraryModule":
2747 // Probably a java_aconfig_library module.
2748 // TODO: make this check better.
2749 return RenameUseInclude, "reflect"
2750 }
2751 switch tag {
2752 case bootClasspathTag:
2753 return RenameUseExclude, "tagswitch"
2754 case sdkLibTag, libTag, instrumentationForTag:
2755 return RenameUseInclude, "tagswitch"
2756 case java9LibTag:
2757 return RenameUseExclude, "tagswitch"
2758 case staticLibTag:
2759 return RenameUseInclude, "tagswitch"
2760 case pluginTag:
2761 return RenameUseInclude, "tagswitch"
2762 case errorpronePluginTag:
2763 return RenameUseInclude, "tagswitch"
2764 case exportedPluginTag:
2765 return RenameUseInclude, "tagswitch"
LaMont Jones63683e42024-02-08 14:30:45 -08002766 case kotlinPluginTag:
2767 return RenameUseInclude, "tagswitch"
2768 default:
2769 return RenameUseExclude, "tagswitch"
2770 }
2771 } else if _, ok := m.(android.SourceFileProducer); ok {
2772 switch tag {
2773 case sdkLibTag, libTag, staticLibTag:
2774 return RenameUseInclude, "srcfile"
2775 default:
2776 return RenameUseExclude, "srcfile"
2777 }
Yu Liu67a28422024-03-05 00:36:31 +00002778 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kang03d014f2024-02-16 22:22:18 +00002779 return RenameUseInclude, "aconfig_declarations_group"
LaMont Jones63683e42024-02-08 14:30:45 -08002780 } else {
2781 switch tag {
2782 case bootClasspathTag:
2783 return RenameUseExclude, "else"
2784 case systemModulesTag:
2785 return RenameUseInclude, "else"
2786 }
2787 }
2788 // If we got here, choose the safer option, which may lead to a build failure, rather
2789 // than runtime failures on the device.
2790 return RenameUseExclude, "end"
2791 }
2792
2793 if result == nil {
2794 result = &JarJarProviderData{
2795 Rename: make(map[string]string),
2796 RenameUse: make([]RenameUseElement, 0),
2797 }
2798 }
2799 how, why := shouldIncludeRenames()
2800 result.RenameUse = append(result.RenameUse, RenameUseElement{DepName: m.Name(), RenameUse: how, Why: why})
2801 if how != RenameUseInclude {
2802 // Nothing to merge.
2803 return
2804 }
2805
2806 merge := func(theirs *JarJarProviderData) {
2807 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002808 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2809 result.Rename[orig] = renamed
2810 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2811 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2812 result.Rename[orig] = renamed
2813 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2814 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2815 continue
2816 }
2817 }
2818 }
2819 }
2820 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2821 merge(&theirs)
2822 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2823 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2824 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2825 // to java.Module.
2826 merge(&theirs.JarJarProviderData)
2827 }
2828 })
2829 return
2830}
2831
2832func (this Module) GetDebugString() string {
2833 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2834}
2835
2836// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2837// us, and if it's been set, apply the jarjar_prefix property to rename them.
2838func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2839 // Gather repackage information from deps
2840 result := collectDirectDepsProviders(ctx)
2841
Joe Onoratoa5d17172024-07-20 17:39:56 -07002842 add := func(orig string, renamed string) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002843 if result == nil {
2844 result = &JarJarProviderData{
2845 Rename: make(map[string]string),
2846 }
2847 }
2848 if renamed != "" {
2849 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2850 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
Joe Onoratoa5d17172024-07-20 17:39:56 -07002851 return
Joe Onorato349ae8d2024-02-05 22:46:00 +00002852 }
2853 }
2854 (*result).Rename[orig] = renamed
2855 }
2856
Joe Onoratoa5d17172024-07-20 17:39:56 -07002857 // Update that with entries we've stored for ourself
2858 for orig, renamed := range module.jarjarRenameRules {
2859 add(orig, renamed)
2860 }
2861
2862 // Update that with entries given in the jarjar_rename property.
2863 for _, orig := range module.properties.Jarjar_rename {
2864 add(orig, "")
2865 }
2866
Joe Onorato349ae8d2024-02-05 22:46:00 +00002867 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2868 if result == nil {
2869 return nil
2870 }
2871
2872 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2873 // that have not yet been renamed.
2874 prefix := proptools.String(module.properties.Jarjar_prefix)
2875 if prefix != "" {
2876 if prefix[0] == '.' {
2877 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2878 return nil
2879 }
2880 if prefix[len(prefix)-1] == '.' {
2881 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2882 return nil
2883 }
2884
2885 var updated map[string]string
2886 for orig, renamed := range (*result).Rename {
2887 if renamed == "" {
2888 if updated == nil {
2889 updated = make(map[string]string)
2890 }
2891 updated[orig] = prefix + "." + orig
2892 }
2893 }
2894 for orig, renamed := range updated {
2895 (*result).Rename[orig] = renamed
2896 }
2897 }
2898
2899 return result
2900}
2901
2902// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2903// to "" won't be in this list because they shouldn't be renamed yet.
2904func getJarJarRuleText(provider *JarJarProviderData) string {
2905 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002906 for _, orig := range android.SortedKeys(provider.Rename) {
2907 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002908 if renamed != "" {
2909 result += "rule " + orig + " " + renamed + "\n"
2910 }
2911 }
2912 return result
2913}
2914
Zi Wangddb2ee52024-04-02 16:44:02 +00002915// Repackage the flags if the jarjar rule txt for the flags is generated
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002916func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Zi Wangddb2ee52024-04-02 16:44:02 +00002917 if j.repackageJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002918 return infile, false
Zi Wangddb2ee52024-04-02 16:44:02 +00002919 }
Colin Crossedec77c2024-07-26 15:25:40 -07002920 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info, jarName)
Zi Wangddb2ee52024-04-02 16:44:02 +00002921 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002922 return repackagedJarjarFile, true
Zi Wangddb2ee52024-04-02 16:44:02 +00002923}
2924
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002925func (j *Module) jarjarIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Colin Crossedec77c2024-07-26 15:25:40 -07002926 if j.expandJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002927 return infile, false
Colin Crossedec77c2024-07-26 15:25:40 -07002928 }
2929 jarjarFile := android.PathForModuleOut(ctx, "jarjar", info, jarName)
2930 TransformJarJar(ctx, jarjarFile, infile, j.expandJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002931 return jarjarFile, true
Colin Crossedec77c2024-07-26 15:25:40 -07002932
2933}
2934
Jaewoong Jung26342642021-03-17 15:56:23 -07002935func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2936 deps.processorPath = append(deps.processorPath, pluginJars...)
2937 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2938}
2939
2940// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2941// this interface.
2942type ProvidesUsesLib interface {
2943 ProvidesUsesLib() *string
2944}
2945
2946func (j *Module) ProvidesUsesLib() *string {
2947 return j.usesLibraryProperties.Provides_uses_lib
2948}
satayev1c564cc2021-05-25 19:50:30 +01002949
2950type ModuleWithStem interface {
2951 Stem() string
2952}
2953
2954var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00002955
2956type ModuleWithUsesLibrary interface {
2957 UsesLibrary() *usesLibrary
2958}
2959
2960func (j *Module) UsesLibrary() *usesLibrary {
2961 return &j.usesLibrary
2962}
2963
2964var _ ModuleWithUsesLibrary = (*Module)(nil)