blob: 3927c619489b86b90462783b3a7cd8d7dba1f824 [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
Cole Faust65cb40a2024-10-21 15:41:42 -070074 // Same as java_resources, but modules added here will use the device variant. Can be useful
75 // for making a host test that tests the contents of a device built app.
76 Device_common_java_resources []string `android:"path_device_common"`
77
78 // Same as java_resources, but modules added here will use the device's os variant and the
79 // device's first architecture variant. Can be useful for making a host test that tests the
80 // contents of a native device built app.
81 Device_first_java_resources []string `android:"path_device_first"`
82
Jaewoong Jung26342642021-03-17 15:56:23 -070083 // list of module-specific flags that will be used for javac compiles
84 Javacflags []string `android:"arch_variant"`
85
86 // list of module-specific flags that will be used for kotlinc compiles
87 Kotlincflags []string `android:"arch_variant"`
88
89 // list of java libraries that will be in the classpath
90 Libs []string `android:"arch_variant"`
91
92 // list of java libraries that will be compiled into the resulting jar
Cole Faustb7493472024-08-28 11:55:52 -070093 Static_libs proptools.Configurable[[]string] `android:"arch_variant"`
Jaewoong Jung26342642021-03-17 15:56:23 -070094
95 // manifest file to be included in resulting jar
96 Manifest *string `android:"path"`
97
98 // if not blank, run jarjar using the specified rules file
99 Jarjar_rules *string `android:"path,arch_variant"`
100
Joe Onoratoa5d17172024-07-20 17:39:56 -0700101 // java class names to rename with jarjar when a reverse dependency has a jarjar_prefix
102 // property.
103 Jarjar_rename []string
104
Joe Onorato349ae8d2024-02-05 22:46:00 +0000105 // if not blank, used as prefix to generate repackage rule
106 Jarjar_prefix *string
107
Jaewoong Jung26342642021-03-17 15:56:23 -0700108 // If not blank, set the java version passed to javac as -source and -target
109 Java_version *string
110
111 // If set to true, allow this module to be dexed and installed on devices. Has no
112 // effect on host modules, which are always considered installable.
113 Installable *bool
114
115 // If set to true, include sources used to compile the module in to the final jar
116 Include_srcs *bool
117
118 // If not empty, classes are restricted to the specified packages and their sub-packages.
119 // This restriction is checked after applying jarjar rules and including static libs.
120 Permitted_packages []string
121
122 // List of modules to use as annotation processors
123 Plugins []string
124
Luca Stefani50098f72024-10-12 17:55:31 +0200125 // List of modules to use as kotlin plugin
126 Kotlin_plugins []string
127
Jaewoong Jung26342642021-03-17 15:56:23 -0700128 // List of modules to export to libraries that directly depend on this library as annotation
129 // processors. Note that if the plugins set generates_api: true this will disable the turbine
130 // optimization on modules that depend on this module, which will reduce parallelism and cause
131 // more recompilation.
132 Exported_plugins []string
133
134 // The number of Java source entries each Javac instance can process
135 Javac_shard_size *int64
136
137 // Add host jdk tools.jar to bootclasspath
138 Use_tools_jar *bool
139
140 Openjdk9 struct {
141 // List of source files that should only be used when passing -source 1.9 or higher
142 Srcs []string `android:"path"`
143
144 // List of javac flags that should only be used when passing -source 1.9 or higher
145 Javacflags []string
146 }
147
148 // When compiling language level 9+ .java code in packages that are part of
149 // a system module, patch_module names the module that your sources and
150 // dependencies should be patched into. The Android runtime currently
151 // doesn't implement the JEP 261 module system so this option is only
152 // supported at compile time. It should only be needed to compile tests in
153 // packages that exist in libcore and which are inconvenient to move
154 // elsewhere.
Liz Kammer0a470a32023-10-05 17:02:00 -0400155 Patch_module *string
Jaewoong Jung26342642021-03-17 15:56:23 -0700156
157 Jacoco struct {
158 // List of classes to include for instrumentation with jacoco to collect coverage
159 // information at runtime when building with coverage enabled. If unset defaults to all
160 // classes.
161 // Supports '*' as the last character of an entry in the list as a wildcard match.
162 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
163 // it matches classes in the package that have the class name as a prefix.
164 Include_filter []string
165
166 // List of classes to exclude from instrumentation with jacoco to collect coverage
167 // information at runtime when building with coverage enabled. Overrides classes selected
168 // by the include_filter property.
169 // Supports '*' as the last character of an entry in the list as a wildcard match.
170 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
171 // it matches classes in the package that have the class name as a prefix.
172 Exclude_filter []string
173 }
174
175 Errorprone struct {
176 // List of javac flags that should only be used when running errorprone.
177 Javacflags []string
178
179 // List of java_plugin modules that provide extra errorprone checks.
180 Extra_check_modules []string
Cole Faust75fffb12021-06-13 15:23:16 -0700181
Cole Faust2b1536e2021-06-18 12:25:54 -0700182 // This property can be in 3 states. When set to true, errorprone will
183 // be run during the regular build. When set to false, errorprone will
184 // never be run. When unset, errorprone will be run when the RUN_ERROR_PRONE
185 // environment variable is true. Setting this to false will improve build
186 // performance more than adding -XepDisableAllChecks in javacflags.
Cole Faust75fffb12021-06-13 15:23:16 -0700187 Enabled *bool
Jaewoong Jung26342642021-03-17 15:56:23 -0700188 }
189
190 Proto struct {
191 // List of extra options that will be passed to the proto generator.
192 Output_params []string
193 }
194
Sam Delmericoc7593722022-08-31 15:57:52 -0400195 // If true, then jacocoagent is automatically added as a libs dependency so that
196 // r8 will not strip instrumentation classes out of dexed libraries.
Jaewoong Jung26342642021-03-17 15:56:23 -0700197 Instrument bool `blueprint:"mutated"`
Paul Duffin0038a8d2022-05-03 00:28:40 +0000198 // If true, then the module supports statically including the jacocoagent
199 // into the library.
200 Supports_static_instrumentation bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700201
202 // List of files to include in the META-INF/services folder of the resulting jar.
203 Services []string `android:"path,arch_variant"`
204
205 // If true, package the kotlin stdlib into the jar. Defaults to true.
206 Static_kotlin_stdlib *bool `android:"arch_variant"`
207
208 // A list of java_library instances that provide additional hiddenapi annotations for the library.
209 Hiddenapi_additional_annotations []string
Joe Onorato175073c2023-06-01 14:42:59 -0700210
211 // Additional srcJars tacked in by GeneratedJavaLibraryModule
212 Generated_srcjars []android.Path `android:"mutated"`
Mark Whitea15790a2023-08-22 21:28:11 +0000213
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000214 // intermediate aconfig cache file tacked in by GeneratedJavaLibraryModule
215 Aconfig_Cache_files []android.Path `android:"mutated"`
216
Mark Whitea15790a2023-08-22 21:28:11 +0000217 // If true, then only the headers are built and not the implementation jar.
Liz Kammer60772632023-10-05 17:18:44 -0400218 Headers_only *bool
Cole Faust2b64af82023-12-13 18:22:18 -0800219
220 // A list of files or dependencies to make available to the build sandbox. This is
221 // useful if source files are symlinks, the targets of the symlinks must be listed here.
222 // Note that currently not all actions implemented by android_apps are sandboxed, so you
223 // may only see this being necessary in lint builds.
224 Compile_data []string `android:"path"`
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000225
226 // Property signifying whether the module compiles stubs or not.
227 // Should be set to true when srcs of this module are stub files.
228 // This property does not need to be set to true when the module depends on
229 // the stubs via libs, but should be set to true when the module depends on
230 // the stubs via static libs.
231 Is_stubs_module *bool
Makoto Onuki7ded3822024-03-28 14:42:20 -0700232
Makoto Onuki7ded3822024-03-28 14:42:20 -0700233 Ravenizer struct {
John Wu989ee842024-10-04 00:21:43 +0000234 // If true, enable the "Ravenizer" tool on the output jar.
235 // "Ravenizer" is a tool for Ravenwood tests, but it can also be enabled on other kinds
236 // of java targets.
Makoto Onuki7ded3822024-03-28 14:42:20 -0700237 Enabled *bool
John Wu989ee842024-10-04 00:21:43 +0000238
239 // If true, the "Ravenizer" tool will remove all Mockito and DexMaker
240 // classes from the output jar.
241 Strip_mockito *bool
Makoto Onuki7ded3822024-03-28 14:42:20 -0700242 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +0000243
244 // Contributing api surface of the stub module. Is not visible to bp modules, and should
245 // only be set for stub submodules generated by the java_sdk_library
246 Stub_contributing_api *string `blueprint:"mutated"`
Yihan Dong8be09c22024-08-29 15:32:13 +0800247
248 // If true, enable the "ApiMapper" tool on the output jar. "ApiMapper" is a tool to inject
249 // bytecode to log API calls.
250 ApiMapper bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700251}
252
253// Properties that are specific to device modules. Host module factories should not add these when
254// constructing a new module.
255type DeviceProperties struct {
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000256 // If not blank, set to the version of the sdk to compile against.
Spandan Das1ccf5742022-10-14 16:51:23 +0000257 // Defaults to an empty string, which compiles the module against the private platform APIs.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000258 // Values are of one of the following forms:
Vinh Trana9c8f7d2022-04-14 20:18:47 +0000259 // 1) numerical API level, "current", "none", or "core_platform"
260 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
261 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
262 // If the SDK kind is empty, it will be set to public.
Jaewoong Jung26342642021-03-17 15:56:23 -0700263 Sdk_version *string
264
satayev0a420e72021-11-29 17:25:52 +0000265 // if not blank, set the maximum version of the sdk that the compiled artifacts will run against.
266 // Defaults to empty string "". See sdk_version for possible values.
267 Max_sdk_version *string
268
William Loh5a082f92022-05-17 20:21:50 +0000269 // if not blank, set the maxSdkVersion properties of permission and uses-permission tags.
270 // Defaults to empty string "". See sdk_version for possible values.
271 Replace_max_sdk_version_placeholder *string
272
Jaewoong Jung26342642021-03-17 15:56:23 -0700273 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000274 // Defaults to sdk_version if not set. See sdk_version for possible values.
Jaewoong Jung26342642021-03-17 15:56:23 -0700275 Target_sdk_version *string
276
277 // Whether to compile against the platform APIs instead of an SDK.
278 // If true, then sdk_version must be empty. The value of this field
Vinh Trand91939e2022-04-18 19:27:17 +0000279 // is ignored when module's type isn't android_app, android_test, or android_test_helper_app.
Jaewoong Jung26342642021-03-17 15:56:23 -0700280 Platform_apis *bool
281
282 Aidl struct {
283 // Top level directories to pass to aidl tool
284 Include_dirs []string
285
286 // Directories rooted at the Android.bp file to pass to aidl tool
287 Local_include_dirs []string
288
289 // directories that should be added as include directories for any aidl sources of modules
290 // that depend on this module, as well as to aidl for this module.
291 Export_include_dirs []string
292
293 // whether to generate traces (for systrace) for this interface
294 Generate_traces *bool
295
296 // whether to generate Binder#GetTransaction name method.
297 Generate_get_transaction_name *bool
298
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100299 // whether all interfaces should be annotated with required permissions.
300 Enforce_permissions *bool
301
302 // allowlist for interfaces that (temporarily) do not require annotation for permissions.
303 Enforce_permissions_exceptions []string `android:"path"`
304
Jaewoong Jung26342642021-03-17 15:56:23 -0700305 // list of flags that will be passed to the AIDL compiler
306 Flags []string
307 }
308
309 // If true, export a copy of the module as a -hostdex module for host testing.
310 Hostdex *bool
311
312 Target struct {
313 Hostdex struct {
314 // Additional required dependencies to add to -hostdex modules.
315 Required []string
316 }
317 }
318
319 // When targeting 1.9 and above, override the modules to use with --system,
320 // otherwise provides defaults libraries to add to the bootclasspath.
321 System_modules *string
322
Jaewoong Jung26342642021-03-17 15:56:23 -0700323 IsSDKLibrary bool `blueprint:"mutated"`
324
325 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
326 // Defaults to false.
327 V4_signature *bool
328
329 // Only for libraries created by a sysprop_library module, SyspropPublicStub is the name of the
330 // public stubs library.
331 SyspropPublicStub string `blueprint:"mutated"`
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000332
333 HiddenAPIPackageProperties
334 HiddenAPIFlagFileProperties
Jaewoong Jung26342642021-03-17 15:56:23 -0700335}
336
yangbill2af0b6e2024-03-15 09:29:29 +0000337// Properties that can be overridden by overriding module (e.g. override_android_app)
338type OverridableProperties struct {
Jooyung Han01d80d82022-01-08 12:16:32 +0900339 // set the name of the output. If not set, `name` is used.
340 // To override a module with this property set, overriding module might need to set this as well.
341 // Otherwise, both the overridden and the overriding modules will have the same output name, which
342 // can cause the duplicate output error.
343 Stem *string
Spandan Dasb9c58352024-05-13 18:29:45 +0000344
345 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
346 // Defaults to sdk_version if not set. See sdk_version for possible values.
347 Min_sdk_version *string
Jooyung Han01d80d82022-01-08 12:16:32 +0900348}
349
Jaewoong Jung26342642021-03-17 15:56:23 -0700350// Functionality common to Module and Import
351//
352// It is embedded in Module so its functionality can be used by methods in Module
353// but it is currently only initialized by Import and Library.
354type embeddableInModuleAndImport struct {
355
356 // Functionality related to this being used as a component of a java_sdk_library.
357 EmbeddableSdkLibraryComponent
358}
359
Paul Duffin71b33cc2021-06-23 11:39:47 +0100360func (e *embeddableInModuleAndImport) initModuleAndImport(module android.Module) {
361 e.initSdkLibraryComponent(module)
Jaewoong Jung26342642021-03-17 15:56:23 -0700362}
363
364// Module/Import's DepIsInSameApex(...) delegates to this method.
365//
366// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
367// the one provided by ApexModuleBase.
368func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
369 // dependencies other than the static linkage are all considered crossing APEX boundary
370 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
371 return true
372 }
373 return false
374}
375
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100376// OptionalDexJarPath can be either unset, hold a valid path to a dex jar file,
377// or an invalid path describing the reason it is invalid.
378//
379// It is unset if a dex jar isn't applicable, i.e. no build rule has been
380// requested to create one.
381//
382// If a dex jar has been requested to be built then it is set, and it may be
383// either a valid android.Path, or invalid with a reason message. The latter
384// happens if the source that should produce the dex file isn't able to.
385//
386// E.g. it is invalid with a reason message if there is a prebuilt APEX that
387// could produce the dex jar through a deapexer module, but the APEX isn't
388// installable so doing so wouldn't be safe.
389type OptionalDexJarPath struct {
390 isSet bool
391 path android.OptionalPath
392}
393
394// IsSet returns true if a path has been set, either invalid or valid.
395func (o OptionalDexJarPath) IsSet() bool {
396 return o.isSet
397}
398
399// Valid returns true if there is a path that is valid.
400func (o OptionalDexJarPath) Valid() bool {
401 return o.isSet && o.path.Valid()
402}
403
404// Path returns the valid path, or panics if it's either not set or is invalid.
405func (o OptionalDexJarPath) Path() android.Path {
406 if !o.isSet {
407 panic("path isn't set")
408 }
409 return o.path.Path()
410}
411
412// PathOrNil returns the path if it's set and valid, or else nil.
413func (o OptionalDexJarPath) PathOrNil() android.Path {
414 if o.Valid() {
415 return o.Path()
416 }
417 return nil
418}
419
420// InvalidReason returns the reason for an invalid path, which is never "". It
421// returns "" for an unset or valid path.
422func (o OptionalDexJarPath) InvalidReason() string {
423 if !o.isSet {
424 return ""
425 }
426 return o.path.InvalidReason()
427}
428
429func (o OptionalDexJarPath) String() string {
430 if !o.isSet {
431 return "<unset>"
432 }
433 return o.path.String()
434}
435
436// makeUnsetDexJarPath returns an unset OptionalDexJarPath.
437func makeUnsetDexJarPath() OptionalDexJarPath {
438 return OptionalDexJarPath{isSet: false}
439}
440
441// makeDexJarPathFromOptionalPath returns an OptionalDexJarPath that is set with
442// the given OptionalPath, which may be valid or invalid.
443func makeDexJarPathFromOptionalPath(path android.OptionalPath) OptionalDexJarPath {
444 return OptionalDexJarPath{isSet: true, path: path}
445}
446
447// makeDexJarPathFromPath returns an OptionalDexJarPath that is set with the
448// valid given path. It returns an unset OptionalDexJarPath if the given path is
449// nil.
450func makeDexJarPathFromPath(path android.Path) OptionalDexJarPath {
451 if path == nil {
452 return makeUnsetDexJarPath()
453 }
454 return makeDexJarPathFromOptionalPath(android.OptionalPathForPath(path))
455}
456
Jaewoong Jung26342642021-03-17 15:56:23 -0700457// Module contains the properties and members used by all java module types
458type Module struct {
459 android.ModuleBase
460 android.DefaultableModuleBase
461 android.ApexModuleBase
Jaewoong Jung26342642021-03-17 15:56:23 -0700462
463 // Functionality common to Module and Import.
464 embeddableInModuleAndImport
465
466 properties CommonProperties
467 protoProperties android.ProtoProperties
468 deviceProperties DeviceProperties
469
yangbill2af0b6e2024-03-15 09:29:29 +0000470 overridableProperties OverridableProperties
Ronald Braunsteincdc66f42024-04-12 11:23:19 -0700471 sourceProperties android.SourceProperties
Jooyung Han01d80d82022-01-08 12:16:32 +0900472
Jaewoong Jung26342642021-03-17 15:56:23 -0700473 // jar file containing header classes including static library dependencies, suitable for
474 // inserting into the bootclasspath/classpath of another compile
475 headerJarFile android.Path
476
477 // jar file containing implementation classes including static library dependencies but no
478 // resources
479 implementationJarFile android.Path
480
Jaewoong Jung26342642021-03-17 15:56:23 -0700481 // args and dependencies to package source files into a srcjar
482 srcJarArgs []string
483 srcJarDeps android.Paths
484
Anton Hansson0e73f9e2023-09-20 13:39:57 +0000485 // the source files of this module and all its static dependencies
486 transitiveSrcFiles *android.DepSet[android.Path]
487
Jaewoong Jung26342642021-03-17 15:56:23 -0700488 // jar file containing implementation classes and resources including static library
489 // dependencies
490 implementationAndResourcesJar android.Path
491
492 // output file containing classes.dex and resources
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100493 dexJarFile OptionalDexJarPath
Jaewoong Jung26342642021-03-17 15:56:23 -0700494
495 // output file containing uninstrumented classes that will be instrumented by jacoco
496 jacocoReportClassesFile android.Path
497
498 // output file of the module, which may be a classes jar or a dex jar
499 outputFile android.Path
500 extraOutputFiles android.Paths
501
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100502 exportAidlIncludeDirs android.Paths
503 ignoredAidlPermissionList android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700504
505 logtagsSrcs android.Paths
506
507 // installed file for binary dependency
508 installFile android.Path
509
Colin Cross3108ce12021-11-10 14:38:50 -0800510 // installed file for hostdex copy
511 hostdexInstallFile android.InstallPath
512
Chaohui Wangdcbe33c2022-10-11 11:13:30 +0800513 // list of unique .java and .kt source files
514 uniqueSrcFiles android.Paths
515
516 // list of srcjars that was passed to javac
517 compiledSrcJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700518
519 // manifest file to use instead of properties.Manifest
520 overrideManifest android.OptionalPath
521
Jaewoong Jung26342642021-03-17 15:56:23 -0700522 // list of plugins that this java module is exporting
523 exportedPluginJars android.Paths
524
525 // list of plugins that this java module is exporting
526 exportedPluginClasses []string
527
528 // if true, the exported plugins generate API and require disabling turbine.
529 exportedDisableTurbine bool
530
531 // list of source files, collected from srcFiles with unique java and all kt files,
532 // will be used by android.IDEInfo struct
533 expandIDEInfoCompiledSrcs []string
534
535 // expanded Jarjar_rules
536 expandJarjarRules android.Path
537
Joe Onorato349ae8d2024-02-05 22:46:00 +0000538 // jarjar rule for inherited jarjar rules
539 repackageJarjarRules android.Path
540
Jaewoong Jung26342642021-03-17 15:56:23 -0700541 // Extra files generated by the module type to be added as java resources.
542 extraResources android.Paths
543
544 hiddenAPI
545 dexer
546 dexpreopter
547 usesLibrary
548 linter
549
550 // list of the xref extraction files
Spandan Das1028d5a2024-08-19 21:45:48 +0000551 kytheFiles android.Paths
552 kytheKotlinFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700553
Jaewoong Jung26342642021-03-17 15:56:23 -0700554 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +0900555
556 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000557 minSdkVersion android.ApiLevel
Spandan Dasa26eda72023-03-02 00:56:06 +0000558 maxSdkVersion android.ApiLevel
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -0400559
560 sourceExtensions []string
Vadim Spivak3c496f02023-06-08 06:14:59 +0000561
562 annoSrcJars android.Paths
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000563
564 // output file name based on Stem property.
565 // This should be set in every ModuleWithStem's GenerateAndroidBuildActions
566 // or the module should override Stem().
567 stem string
Joe Onorato6fe59eb2023-07-16 13:20:33 -0700568
Joe Onorato349ae8d2024-02-05 22:46:00 +0000569 // Values that will be set in the JarJarProvider data for jarjar repackaging,
570 // and merged with our dependencies' rules.
571 jarjarRenameRules map[string]string
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000572
573 stubsLinkType StubsLinkType
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000574
575 // Paths to the aconfig intermediate cache files that are provided by the
576 // java_aconfig_library or java_library modules that are statically linked
577 // to this module. Does not contain cache files from all transitive dependencies.
578 aconfigCacheFiles android.Paths
Spandan Das8aac9932024-07-18 23:14:13 +0000579
580 // List of soong module dependencies required to compile the current module.
581 // This information is printed out to `Dependencies` field in module_bp_java_deps.json
582 compileDepNames []string
Makoto Onuki7ded3822024-03-28 14:42:20 -0700583
584 ravenizer struct {
585 enabled bool
586 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700587}
588
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000589var _ android.InstallableModule = (*Module)(nil)
590
591// To satisfy the InstallableModule interface
Jihoon Kang224ea082024-08-12 22:38:16 +0000592func (j *Module) StaticDependencyTags() []blueprint.DependencyTag {
593 return []blueprint.DependencyTag{staticLibTag}
594}
595
596// To satisfy the InstallableModule interface
597func (j *Module) DynamicDependencyTags() []blueprint.DependencyTag {
598 return []blueprint.DependencyTag{libTag, sdkLibTag, bootClasspathTag, systemModulesTag,
599 instrumentationForTag, java9LibTag}
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000600}
601
602// Overrides android.ModuleBase.InstallInProduct()
603func (j *Module) InstallInProduct() bool {
604 return j.ProductSpecific()
605}
606
Jihoon Kang85bc1932024-07-01 17:04:46 +0000607var _ android.StubsAvailableModule = (*Module)(nil)
608
609// To safisfy the StubsAvailableModule interface
610func (j *Module) IsStubsModule() bool {
611 return proptools.Bool(j.properties.Is_stubs_module)
612}
613
Jiyong Park92315372021-04-02 08:45:46 +0900614func (j *Module) CheckStableSdkVersion(ctx android.BaseModuleContext) error {
615 sdkVersion := j.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900616 if sdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700617 return nil
618 }
Jiyong Parkf1691d22021-03-29 20:11:58 +0900619 if sdkVersion.Kind == android.SdkCorePlatform {
Paul Duffin1ea7c9f2021-03-15 09:39:13 +0000620 if useLegacyCorePlatformApi(ctx, j.BaseModuleName()) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700621 return fmt.Errorf("non stable SDK %v - uses legacy core platform", sdkVersion)
622 } else {
623 // Treat stable core platform as stable.
624 return nil
625 }
626 } else {
627 return fmt.Errorf("non stable SDK %v", sdkVersion)
628 }
629}
630
631// checkSdkVersions enforces restrictions around SDK dependencies.
632func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
633 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900634 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900635 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700636 ctx.PropertyErrorf("sdk_version",
637 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
638 }
639 }
640 }
641
642 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
643 // See rank() for details.
644 ctx.VisitDirectDeps(func(module android.Module) {
645 tag := ctx.OtherModuleDependencyTag(module)
646 switch module.(type) {
647 // TODO(satayev): cover other types as well, e.g. imports
648 case *Library, *AndroidLibrary:
649 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400650 case bootClasspathTag, sdkLibTag, libTag, staticLibTag, java9LibTag:
Jaewoong Jung26342642021-03-17 15:56:23 -0700651 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
652 }
653 }
654 })
655}
656
657func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900658 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700659 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900660 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700661 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000662 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 -0700663 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000664 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 -0700665 }
666
667 }
668}
669
Mark Whitea15790a2023-08-22 21:28:11 +0000670func (j *Module) checkHeadersOnly(ctx android.ModuleContext) {
671 if _, ok := ctx.Module().(android.SdkContext); ok {
Liz Kammer60772632023-10-05 17:18:44 -0400672 headersOnly := proptools.Bool(j.properties.Headers_only)
Mark Whitea15790a2023-08-22 21:28:11 +0000673 installable := proptools.Bool(j.properties.Installable)
674
675 if headersOnly && installable {
676 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.")
677 }
678 }
679}
680
Jaewoong Jung26342642021-03-17 15:56:23 -0700681func (j *Module) addHostProperties() {
682 j.AddProperties(
683 &j.properties,
yangbill2af0b6e2024-03-15 09:29:29 +0000684 &j.overridableProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700685 &j.protoProperties,
686 &j.usesLibraryProperties,
687 )
688}
689
690func (j *Module) addHostAndDeviceProperties() {
691 j.addHostProperties()
692 j.AddProperties(
693 &j.deviceProperties,
694 &j.dexer.dexProperties,
695 &j.dexpreoptProperties,
696 &j.linter.properties,
697 )
698}
699
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000700// provideHiddenAPIPropertyInfo populates a HiddenAPIPropertyInfo from hidden API properties and
701// makes it available through the hiddenAPIPropertyInfoProvider.
702func (j *Module) provideHiddenAPIPropertyInfo(ctx android.ModuleContext) {
703 hiddenAPIInfo := newHiddenAPIPropertyInfo()
704
705 // Populate with flag file paths from the properties.
706 hiddenAPIInfo.extractFlagFilesFromProperties(ctx, &j.deviceProperties.HiddenAPIFlagFileProperties)
707
708 // Populate with package rules from the properties.
709 hiddenAPIInfo.extractPackageRulesFromProperties(&j.deviceProperties.HiddenAPIPackageProperties)
710
Colin Cross40213022023-12-13 15:19:49 -0800711 android.SetProvider(ctx, hiddenAPIPropertyInfoProvider, hiddenAPIInfo)
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000712}
713
mrziwang9f7b9f42024-07-10 12:18:06 -0700714// helper method for java modules to set OutputFilesProvider
715func setOutputFiles(ctx android.ModuleContext, m Module) {
716 ctx.SetOutputFiles(append(android.Paths{m.outputFile}, m.extraOutputFiles...), "")
717 ctx.SetOutputFiles(android.Paths{m.outputFile}, android.DefaultDistTag)
718 ctx.SetOutputFiles(android.Paths{m.implementationAndResourcesJar}, ".jar")
719 ctx.SetOutputFiles(android.Paths{m.headerJarFile}, ".hjar")
720 if m.dexer.proguardDictionary.Valid() {
721 ctx.SetOutputFiles(android.Paths{m.dexer.proguardDictionary.Path()}, ".proguard_map")
722 }
723 ctx.SetOutputFiles(m.properties.Generated_srcjars, ".generated_srcjars")
Jaewoong Jung26342642021-03-17 15:56:23 -0700724}
725
Jaewoong Jung26342642021-03-17 15:56:23 -0700726func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
727 initJavaModule(module, hod, false)
728}
729
730func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
731 initJavaModule(module, hod, true)
732}
733
734func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
735 multilib := android.MultilibCommon
736 if multiTargets {
737 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
738 } else {
739 android.InitAndroidArchModule(module, hod, multilib)
740 }
741 android.InitDefaultableModule(module)
742}
743
744func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
745 return j.properties.Instrument &&
746 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
747 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
748}
749
Yihan Dong8be09c22024-08-29 15:32:13 +0800750func (j *Module) shouldApiMapper() bool {
751 return j.properties.ApiMapper
752}
753
Jaewoong Jung26342642021-03-17 15:56:23 -0700754func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000755 return j.properties.Supports_static_instrumentation &&
756 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700757 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
758 ctx.Config().UnbundledBuild())
759}
760
761func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
762 // Force enable the instrumentation for java code that is built for APEXes ...
763 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
764 // 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 -0800765 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -0700766 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Jihoon Kang690df2e2024-05-22 04:27:38 +0000767
Jihoon Kang46d66de2024-05-22 22:42:39 +0000768 if j.DirectlyInAnyApex() && !isJacocoAgent && !apexInfo.IsForPlatform() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700769 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
770 return true
771 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
772 return true
773 }
774 }
775 return false
776}
777
Sam Delmerico1e3f78f2022-09-07 12:07:07 -0400778func (j *Module) setInstrument(value bool) {
779 j.properties.Instrument = value
780}
781
Yihan Dong8be09c22024-08-29 15:32:13 +0800782func (j *Module) setApiMapper(value bool) {
783 j.properties.ApiMapper = value
784}
785
Jiyong Park92315372021-04-02 08:45:46 +0900786func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
787 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700788}
789
Jiyong Parkf1691d22021-03-29 20:11:58 +0900790func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700791 return proptools.String(j.deviceProperties.System_modules)
792}
793
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000794func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Spandan Dasb9c58352024-05-13 18:29:45 +0000795 if j.overridableProperties.Min_sdk_version != nil {
796 return android.ApiLevelFrom(ctx, *j.overridableProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700797 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000798 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700799}
800
Yu Liuf2b94012023-09-19 15:09:10 -0700801func (j *Module) GetDeviceProperties() *DeviceProperties {
802 return &j.deviceProperties
803}
804
Spandan Dasa26eda72023-03-02 00:56:06 +0000805func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
806 if j.deviceProperties.Max_sdk_version != nil {
807 return android.ApiLevelFrom(ctx, *j.deviceProperties.Max_sdk_version)
808 }
809 // Default is PrivateApiLevel
810 return android.SdkSpecPrivate.ApiLevel
satayev0a420e72021-11-29 17:25:52 +0000811}
812
Spandan Dasa26eda72023-03-02 00:56:06 +0000813func (j *Module) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
814 if j.deviceProperties.Replace_max_sdk_version_placeholder != nil {
815 return android.ApiLevelFrom(ctx, *j.deviceProperties.Replace_max_sdk_version_placeholder)
816 }
817 // Default is PrivateApiLevel
818 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000819}
820
Jiyong Parkf1691d22021-03-29 20:11:58 +0900821func (j *Module) MinSdkVersionString() string {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000822 return j.minSdkVersion.String()
Jiyong Park92315372021-04-02 08:45:46 +0900823}
824
Spandan Dasca70fc42023-03-01 23:38:49 +0000825func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jiyong Park92315372021-04-02 08:45:46 +0900826 if j.deviceProperties.Target_sdk_version != nil {
Spandan Dasca70fc42023-03-01 23:38:49 +0000827 return android.ApiLevelFrom(ctx, *j.deviceProperties.Target_sdk_version)
Jiyong Park92315372021-04-02 08:45:46 +0900828 }
Spandan Dasca70fc42023-03-01 23:38:49 +0000829 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700830}
831
832func (j *Module) AvailableFor(what string) bool {
833 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
834 // Exception: for hostdex: true libraries, the platform variant is created
835 // even if it's not marked as available to platform. In that case, the platform
836 // variant is used only for the hostdex and not installed to the device.
837 return true
838 }
839 return j.ApexModuleBase.AvailableFor(what)
840}
841
Cole Faustb7493472024-08-28 11:55:52 -0700842func (j *Module) staticLibs(ctx android.BaseModuleContext) []string {
Jihoon Kang8bce3812024-09-30 18:46:51 +0000843 return j.properties.Static_libs.GetOrDefault(ctx, nil)
Cole Faustb7493472024-08-28 11:55:52 -0700844}
845
Jaewoong Jung26342642021-03-17 15:56:23 -0700846func (j *Module) deps(ctx android.BottomUpMutatorContext) {
847 if ctx.Device() {
848 j.linter.deps(ctx)
849
Jiyong Parkf1691d22021-03-29 20:11:58 +0900850 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700851
852 if j.deviceProperties.SyspropPublicStub != "" {
853 // This is a sysprop implementation library that has a corresponding sysprop public
854 // stubs library, and a dependency on it so that dependencies on the implementation can
855 // be forwarded to the public stubs library when necessary.
856 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
857 }
858 }
859
860 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000861
Cole Faustb7493472024-08-28 11:55:52 -0700862 ctx.AddVariationDependencies(nil, staticLibTag, j.staticLibs(ctx)...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700863
864 // Add dependency on libraries that provide additional hidden api annotations.
865 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
866
Jaewoong Jung26342642021-03-17 15:56:23 -0700867 // For library dependencies that are component libraries (like stubs), add the implementation
868 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
869 for _, dep := range libDeps {
870 if dep != nil {
871 if component, ok := dep.(SdkLibraryComponentDependency); ok {
872 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000873 // Add library as optional if it's one of the optional compatibility libs or it's
874 // explicitly listed in the optional_uses_libs property.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100875 tag := usesLibReqTag
Jiakai Zhangf98da192024-04-15 11:15:41 +0000876 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) ||
Cole Faust64f2d842024-10-17 13:28:34 -0700877 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs.GetOrDefault(ctx, nil)) {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100878 tag = usesLibOptTag
879 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100880 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700881 }
882 }
883 }
884 }
885
886 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
Luca Stefani50098f72024-10-12 17:55:31 +0200887 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag, j.properties.Kotlin_plugins...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700888 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
889 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
890
891 android.ProtoDeps(ctx, &j.protoProperties)
892 if j.hasSrcExt(".proto") {
893 protoDeps(ctx, &j.protoProperties)
894 }
895
896 if j.hasSrcExt(".kt") {
897 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
898 // Kotlin files
Colin Cross882d6002024-08-14 10:24:06 -0700899 tag := staticLibTag
900 if !BoolDefault(j.properties.Static_kotlin_stdlib, true) {
901 tag = libTag
902 }
903 ctx.AddVariationDependencies(nil, tag,
904 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8", "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700905 }
906
907 // Framework libraries need special handling in static coverage builds: they should not have
908 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
909 // the same jacoco classes coming from different bootclasspath jars.
910 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
911 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
912 j.properties.Instrument = true
913 }
914 } else if j.shouldInstrumentStatic(ctx) {
915 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
916 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700917
Cole Faustb7493472024-08-28 11:55:52 -0700918 if j.useCompose(ctx) {
Colin Crossa1ff7c62021-09-17 14:11:52 -0700919 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
Luca Stefani50098f72024-10-12 17:55:31 +0200920 "androidx.compose.compiler_compiler-hosted-plugin")
Colin Crossa1ff7c62021-09-17 14:11:52 -0700921 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700922}
923
924func hasSrcExt(srcs []string, ext string) bool {
925 for _, src := range srcs {
926 if filepath.Ext(src) == ext {
927 return true
928 }
929 }
930
931 return false
932}
933
934func (j *Module) hasSrcExt(ext string) bool {
935 return hasSrcExt(j.properties.Srcs, ext)
936}
937
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100938func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
939 var flags string
940
941 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
942 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
943 flags = "-Wmissing-permission-annotation -Werror"
944 }
945 }
946 return flags
947}
948
Jaewoong Jung26342642021-03-17 15:56:23 -0700949func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000950 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700951
952 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
953 aidlIncludes = append(aidlIncludes,
954 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
955 aidlIncludes = append(aidlIncludes,
956 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
957
958 var flags []string
959 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000960 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700961
962 flags = append(flags, j.deviceProperties.Aidl.Flags...)
963
964 if aidlPreprocess.Valid() {
965 flags = append(flags, "-p"+aidlPreprocess.String())
966 deps = append(deps, aidlPreprocess.Path())
967 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000968 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700969 }
970
971 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000972 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700973 }
974
975 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000976 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700977 }
978
Sam Delmerico2351eac2022-05-24 17:10:02 +0000979 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -0700980 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000981 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -0700982 }
Sam Delmerico2351eac2022-05-24 17:10:02 +0000983 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
984 // add flags for dirs containing AIDL srcs that haven't been specified yet
985 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -0700986
Zim8774ae12022-08-17 11:46:34 +0100987 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +0000988 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +0100989 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700990 flags = append(flags, "-t")
991 }
992
993 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
994 flags = append(flags, "--transaction_names")
995 }
996
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100997 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
998 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
999 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
1000 }
1001
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001002 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +09001003 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
1004
Jaewoong Jung26342642021-03-17 15:56:23 -07001005 return strings.Join(flags, " "), deps
1006}
1007
1008func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
1009
1010 var flags javaBuilderFlags
1011
1012 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +09001013 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001014
Cole Faust2b1536e2021-06-18 12:25:54 -07001015 epEnabled := j.properties.Errorprone.Enabled
1016 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +01001017 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001018 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1019 }
1020
1021 errorProneFlags := []string{
1022 "-Xplugin:ErrorProne",
1023 "${config.ErrorProneChecks}",
1024 }
1025 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1026
Colin Cross8bf6cad2022-02-28 13:07:03 -08001027 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -07001028 "'" + strings.Join(errorProneFlags, " ") + "'"
1029 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
1030 }
1031
1032 // classpath
1033 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1034 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001035 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001036 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1037 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1038 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1039
1040 flags.processors = append(flags.processors, deps.processorClasses...)
1041 flags.processors = android.FirstUniqueStrings(flags.processors)
1042
1043 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001044 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001045 // Give host-side tools a version of OpenJDK's standard libraries
1046 // close to what they're targeting. As of Dec 2017, AOSP is only
1047 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1048 //
1049 // When building with OpenJDK 8, the following should have no
1050 // effect since those jars would be available by default.
1051 //
1052 // When building with OpenJDK 9 but targeting a version < 1.8,
1053 // putting them on the bootclasspath means that:
1054 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1055 // b) references to existing APIs are not reinterpreted in an
1056 // OpenJDK 9-specific way, eg. calls to subclasses of
1057 // java.nio.Buffer as in http://b/70862583
1058 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1059 flags.bootClasspath = append(flags.bootClasspath,
1060 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1061 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1062 if Bool(j.properties.Use_tools_jar) {
1063 flags.bootClasspath = append(flags.bootClasspath,
1064 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1065 }
1066 }
1067
1068 // systemModules
1069 flags.systemModules = deps.systemModules
1070
Jaewoong Jung26342642021-03-17 15:56:23 -07001071 return flags
1072}
1073
1074func (j *Module) collectJavacFlags(
1075 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1076 // javac flags.
1077 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001078 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001079
Mythri Alle4b9f6182023-10-25 15:17:11 +00001080 needsDebugInfo = false
1081 for _, flag := range javacFlags {
1082 if strings.HasPrefix(flag, "-g") {
1083 needsDebugInfo = true
1084 }
1085 }
1086
1087 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001088 // For non-host binaries, override the -g flag passed globally to remove
1089 // local variable debug info to reduce disk and memory usage.
1090 javacFlags = append(javacFlags, "-g:source,lines")
1091 }
1092 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1093
1094 if flags.javaVersion.usesJavaModules() {
1095 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001096 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1097 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1098 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1099 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001100
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001101 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001102 if j.properties.Patch_module != nil {
1103 // Manually specify build directory in case it is not under the repo root.
1104 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1105 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001106 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001107
Jaewoong Jung26342642021-03-17 15:56:23 -07001108 classPath := flags.classpath.FormJavaClassPath("")
1109 if classPath != "" {
1110 patchPaths = append(patchPaths, classPath)
1111 }
1112 javacFlags = append(
1113 javacFlags,
1114 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1115 }
1116 }
1117
1118 if len(javacFlags) > 0 {
1119 // optimization.
1120 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1121 flags.javacFlags = "$javacFlags"
1122 }
1123
1124 return flags
1125}
1126
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001127func (j *Module) AddJSONData(d *map[string]interface{}) {
1128 (&j.ModuleBase).AddJSONData(d)
1129 (*d)["Java"] = map[string]interface{}{
1130 "SourceExtensions": j.sourceExtensions,
1131 }
1132
1133}
1134
usta0391ca42023-09-19 15:51:59 -04001135func (j *Module) addGeneratedSrcJars(path android.Path) {
1136 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001137}
1138
Colin Crossfdaa6722024-08-23 11:58:08 -07001139func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars, extraDepCombinedJars android.Paths) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001140 // Auto-propagating jarjar rules
1141 jarjarProviderData := j.collectJarJarRules(ctx)
1142 if jarjarProviderData != nil {
1143 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wangddb2ee52024-04-02 16:44:02 +00001144 text := getJarJarRuleText(jarjarProviderData)
1145 if text != "" {
1146 ruleTextFile := android.PathForModuleOut(ctx, "repackaged-jarjar", "repackaging.txt")
1147 android.WriteFileRule(ctx, ruleTextFile, text)
1148 j.repackageJarjarRules = ruleTextFile
Joe Onorato349ae8d2024-02-05 22:46:00 +00001149 }
1150 }
1151
Jaewoong Jung26342642021-03-17 15:56:23 -07001152 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1153
John Wu989ee842024-10-04 00:21:43 +00001154 // Only override the original value if explicitly set
1155 if j.properties.Ravenizer.Enabled != nil {
1156 j.ravenizer.enabled = *j.properties.Ravenizer.Enabled
Makoto Onuki7ded3822024-03-28 14:42:20 -07001157 }
1158
Jaewoong Jung26342642021-03-17 15:56:23 -07001159 deps := j.collectDeps(ctx)
1160 flags := j.collectBuilderFlags(ctx, deps)
1161
1162 if flags.javaVersion.usesJavaModules() {
1163 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001164 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1165 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1166 ctx.PropertyErrorf("openjdk9.srcs", "JDK version defaults to higher than 9")
Jaewoong Jung26342642021-03-17 15:56:23 -07001167 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001168
Jaewoong Jung26342642021-03-17 15:56:23 -07001169 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001170 j.sourceExtensions = []string{}
1171 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1172 if hasSrcExt(srcFiles.Strings(), ext) {
1173 j.sourceExtensions = append(j.sourceExtensions, ext)
1174 }
1175 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001176 if hasSrcExt(srcFiles.Strings(), ".proto") {
1177 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1178 }
1179
1180 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, nil)
1181 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1182 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1183 }
1184
Sam Delmerico2351eac2022-05-24 17:10:02 +00001185 aidlSrcs := srcFiles.FilterByExt(".aidl")
1186 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs, aidlSrcs)
1187
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001188 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001189 srcFiles = j.genSources(ctx, srcFiles, flags)
1190
1191 // Collect javac flags only after computing the full set of srcFiles to
1192 // ensure that the --patch-module lookup paths are complete.
1193 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1194
1195 srcJars := srcFiles.FilterByExt(".srcjar")
1196 srcJars = append(srcJars, deps.srcJars...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001197 srcJars = append(srcJars, extraSrcJars...)
Joe Onorato175073c2023-06-01 14:42:59 -07001198 srcJars = append(srcJars, j.properties.Generated_srcjars...)
Colin Crossb0ef30a2021-06-29 10:42:00 -07001199 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001200
1201 if j.properties.Jarjar_rules != nil {
1202 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1203 }
1204
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00001205 jarName := j.Stem() + ".jar"
Jaewoong Jung26342642021-03-17 15:56:23 -07001206
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001207 var uniqueJavaFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001208 set := make(map[string]bool)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001209 for _, v := range srcFiles.FilterByExt(".java") {
Jaewoong Jung26342642021-03-17 15:56:23 -07001210 if _, found := set[v.String()]; !found {
1211 set[v.String()] = true
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001212 uniqueJavaFiles = append(uniqueJavaFiles, v)
Jaewoong Jung26342642021-03-17 15:56:23 -07001213 }
1214 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001215 var uniqueKtFiles android.Paths
1216 for _, v := range srcFiles.FilterByExt(".kt") {
1217 if _, found := set[v.String()]; !found {
1218 set[v.String()] = true
1219 uniqueKtFiles = append(uniqueKtFiles, v)
1220 }
1221 }
1222
1223 var uniqueSrcFiles android.Paths
1224 uniqueSrcFiles = append(uniqueSrcFiles, uniqueJavaFiles...)
1225 uniqueSrcFiles = append(uniqueSrcFiles, uniqueKtFiles...)
1226 j.uniqueSrcFiles = uniqueSrcFiles
Colin Cross40213022023-12-13 15:19:49 -08001227 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: uniqueSrcFiles.Strings()})
Jaewoong Jung26342642021-03-17 15:56:23 -07001228
Colin Crossb5db4012022-03-28 17:12:39 -07001229 // We don't currently run annotation processors in turbine, which means we can't use turbine
1230 // generated header jars when an annotation processor that generates API is enabled. One
1231 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1232 // is used to run all of the annotation processors.
1233 disableTurbine := deps.disableTurbine
1234
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001235 // Collect .java and .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001236 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1237
Colin Cross220a9a12022-03-28 17:08:01 -07001238 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001239
Colin Cross4eae06d2023-06-20 22:40:02 -07001240 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1241 // any dependencies so that it can override any non-final R classes from dependencies with the
1242 // final R classes from the app.
1243 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1244
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001245 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1246
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001247 var localImplementationJars android.Paths
1248
Mark Whitea15790a2023-08-22 21:28:11 +00001249 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001250 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001251 if srcFiles.HasExt(".kt") {
1252 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1253 }
1254 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1255 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1256 }
1257
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001258 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1259
1260 localHeaderJars, combinedHeaderJarFile := j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
Colin Crossedec77c2024-07-26 15:25:40 -07001261 extraCombinedJars)
1262
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001263 combinedHeaderJarFile, jarjared := j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1264 if jarjared {
1265 localHeaderJars = android.Paths{combinedHeaderJarFile}
1266 transitiveStaticLibsHeaderJars = nil
1267 }
1268 combinedHeaderJarFile, repackaged := j.repackageFlagsIfNecessary(ctx, combinedHeaderJarFile, jarName, "repackage-turbine")
1269 if repackaged {
1270 localHeaderJars = android.Paths{combinedHeaderJarFile}
1271 transitiveStaticLibsHeaderJars = nil
1272 }
Mark Whitea15790a2023-08-22 21:28:11 +00001273 if ctx.Failed() {
1274 return
1275 }
Colin Crossedec77c2024-07-26 15:25:40 -07001276 j.headerJarFile = combinedHeaderJarFile
Mark Whitea15790a2023-08-22 21:28:11 +00001277
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001278 if ctx.Config().UseTransitiveJarsInClasspath() {
1279 if len(localHeaderJars) > 0 {
1280 ctx.CheckbuildFile(localHeaderJars...)
1281 } else {
1282 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1283 ctx.UncheckedModule()
1284 }
1285 } else {
1286 ctx.CheckbuildFile(j.headerJarFile)
1287 }
Colin Crossa6182ab2024-08-21 10:47:44 -07001288
Colin Cross7727c7f2024-07-18 15:36:32 -07001289 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001290 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001291 LocalHeaderJars: localHeaderJars,
1292 TransitiveStaticLibsHeaderJars: android.NewDepSet(android.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Cross9ffaf282024-08-12 13:50:09 -07001293 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1294 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001295 AidlIncludeDirs: j.exportAidlIncludeDirs,
1296 ExportedPlugins: j.exportedPluginJars,
1297 ExportedPluginClasses: j.exportedPluginClasses,
1298 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1299 StubsLinkType: j.stubsLinkType,
1300 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Mark Whitea15790a2023-08-22 21:28:11 +00001301 })
1302
1303 j.outputFile = j.headerJarFile
1304 return
1305 }
1306
Jaewoong Jung26342642021-03-17 15:56:23 -07001307 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001308 // When using kotlin sources turbine is used to generate annotation processor sources,
1309 // including for annotation processors that generate API, so we can use turbine for
1310 // java sources too.
1311 disableTurbine = false
1312
Jaewoong Jung26342642021-03-17 15:56:23 -07001313 // user defined kotlin flags.
1314 kotlincFlags := j.properties.Kotlincflags
1315 CheckKotlincFlags(ctx, kotlincFlags)
1316
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001317 // Workaround for KT-46512
1318 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001319
1320 // If there are kotlin files, compile them first but pass all the kotlin and java files
1321 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1322 // won't emit any classes for them.
1323 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1324 if ctx.Device() {
1325 kotlincFlags = append(kotlincFlags, "-no-jdk")
1326 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001327
1328 for _, plugin := range deps.kotlinPlugins {
1329 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1330 }
1331 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1332
Jaewoong Jung26342642021-03-17 15:56:23 -07001333 if len(kotlincFlags) > 0 {
1334 // optimization.
1335 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1336 flags.kotlincFlags += "$kotlincFlags"
1337 }
1338
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001339 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001340 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1341
Jaewoong Jung26342642021-03-17 15:56:23 -07001342 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1343 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1344
Isaac Chioua23d9942022-04-06 06:14:38 +00001345 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001346 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001347 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1348 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001349 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001350 srcJars = append(srcJars, kaptSrcJar)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001351 localImplementationJars = append(localImplementationJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001352 // Disable annotation processing in javac, it's already been handled by kapt
1353 flags.processorPath = nil
1354 flags.processors = nil
1355 }
1356
1357 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001358 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Spandan Das1028d5a2024-08-19 21:45:48 +00001359 j.kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001360 if ctx.Failed() {
1361 return
1362 }
1363
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001364 kotlinJarPath, _ := j.repackageFlagsIfNecessary(ctx, kotlinJar, jarName, "kotlinc")
Zi Wangddb2ee52024-04-02 16:44:02 +00001365
Isaac Chioua23d9942022-04-06 06:14:38 +00001366 // Make javac rule depend on the kotlinc rule
1367 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1368
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001369 localImplementationJars = append(localImplementationJars, kotlinJarPath)
1370
Colin Cross220a9a12022-03-28 17:08:01 -07001371 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001372 }
1373
Jaewoong Jung26342642021-03-17 15:56:23 -07001374 j.compiledSrcJars = srcJars
1375
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001376 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1377
Jaewoong Jung26342642021-03-17 15:56:23 -07001378 enableSharding := false
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001379 var localHeaderJars android.Paths
1380 var shardingHeaderJars android.Paths
1381 var repackagedHeaderJarFile android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001382 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001383 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1384 enableSharding = true
1385 // Formerly, there was a check here that prevented annotation processors
1386 // from being used when sharding was enabled, as some annotation processors
1387 // do not function correctly in sharded environments. It was removed to
1388 // allow for the use of annotation processors that do function correctly
1389 // with sharding enabled. See: b/77284273.
1390 }
Colin Crossd1d8f172024-07-29 11:30:29 -07001391 extraJars := slices.Clone(kotlinHeaderJars)
Colin Crossd1d8f172024-07-29 11:30:29 -07001392 extraJars = append(extraJars, extraCombinedJars...)
Colin Crossedec77c2024-07-26 15:25:40 -07001393 var combinedHeaderJarFile android.Path
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001394 localHeaderJars, combinedHeaderJarFile = j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
1395 shardingHeaderJars = localHeaderJars
Colin Crossedec77c2024-07-26 15:25:40 -07001396
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001397 var jarjared bool
1398 j.headerJarFile, jarjared = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1399 if jarjared {
1400 // jarjar modifies transitive static dependencies, use the combined header jar and drop the transitive
1401 // static libs header jars.
1402 localHeaderJars = android.Paths{j.headerJarFile}
1403 transitiveStaticLibsHeaderJars = nil
1404 }
1405 var repackaged bool
1406 repackagedHeaderJarFile, repackaged = j.repackageFlagsIfNecessary(ctx, j.headerJarFile, jarName, "turbine")
1407 if repackaged {
1408 // repackage modifies transitive static dependencies, use the combined header jar and drop the transitive
1409 // static libs header jars.
1410 // TODO(b/356688296): this shouldn't export both the unmodified and repackaged header jars
1411 localHeaderJars = android.Paths{j.headerJarFile, repackagedHeaderJarFile}
1412 transitiveStaticLibsHeaderJars = nil
1413 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001414 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001415 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001416 hasErrorproneableFiles := false
1417 for _, ext := range j.sourceExtensions {
1418 if ext != ".proto" && ext != ".aidl" {
1419 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1420 // compile, and it's not useful to have warnings on these generated sources.
1421 hasErrorproneableFiles = true
1422 break
1423 }
1424 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001425 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001426 if Bool(j.properties.Errorprone.Enabled) {
1427 // If error-prone is enabled, enable errorprone flags on the regular
1428 // build.
1429 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001430 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faust75fffb12021-06-13 15:23:16 -07001431 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1432 // a new jar file just for compiling with the errorprone compiler to.
1433 // This is because we don't want to cause the java files to get completely
1434 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1435 // We also don't want to run this if errorprone is enabled by default for
1436 // this module, or else we could have duplicated errorprone messages.
1437 errorproneFlags := enableErrorproneFlags(flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001438 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001439 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001440
Vadim Spivak3c496f02023-06-08 06:14:59 +00001441 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
Cole Faust75fffb12021-06-13 15:23:16 -07001442 "errorprone", "errorprone")
1443
Jaewoong Jung26342642021-03-17 15:56:23 -07001444 extraJarDeps = append(extraJarDeps, errorprone)
1445 }
1446
1447 if enableSharding {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001448 if len(shardingHeaderJars) > 0 {
1449 flags.classpath = append(classpath(slices.Clone(shardingHeaderJars)), flags.classpath...)
Colin Cross3d56ed52021-11-18 22:23:12 -08001450 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001451 shardSize := int(*(j.properties.Javac_shard_size))
1452 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001453 if len(uniqueJavaFiles) > 0 {
1454 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001455 for idx, shardSrc := range shardSrcs {
1456 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1457 nil, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001458 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
1459 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001460 }
1461 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001462 // Assume approximately 5 sources per srcjar.
1463 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1464 // 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 -07001465 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001466 startIdx := len(shardSrcs)
1467 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1468 for idx, shardSrcJars := range shardSrcJarsList {
1469 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1470 nil, shardSrcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001471 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
1472 localImplementationJars = append(localImplementationJars, classes)
Colin Crossa052ddb2023-09-25 21:46:58 -07001473 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001474 }
1475 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001476 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001477 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
1478 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001479 }
1480 if ctx.Failed() {
1481 return
1482 }
1483 }
1484
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001485 localImplementationJars = append(localImplementationJars, extraCombinedJars...)
Colin Crossfd620b22024-02-23 10:05:21 -08001486
Jaewoong Jung26342642021-03-17 15:56:23 -07001487 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1488
1489 var includeSrcJar android.WritablePath
1490 if Bool(j.properties.Include_srcs) {
1491 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1492 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1493 }
1494
1495 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1496 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
1497 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
Cole Faust65cb40a2024-10-21 15:41:42 -07001498 fileArgs2, fileDeps2 := ResourceFilesToJarArgs(ctx, j.properties.Device_common_java_resources, nil)
1499 fileArgs3, fileDeps3 := ResourceFilesToJarArgs(ctx, j.properties.Device_first_java_resources, nil)
1500 fileArgs = slices.Concat(fileArgs, fileArgs2, fileArgs3)
1501 fileDeps = slices.Concat(fileDeps, fileDeps2, fileDeps3)
Jaewoong Jung26342642021-03-17 15:56:23 -07001502 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1503
1504 var resArgs []string
1505 var resDeps android.Paths
1506
1507 resArgs = append(resArgs, dirArgs...)
1508 resDeps = append(resDeps, dirDeps...)
1509
1510 resArgs = append(resArgs, fileArgs...)
1511 resDeps = append(resDeps, fileDeps...)
1512
1513 resArgs = append(resArgs, extraArgs...)
1514 resDeps = append(resDeps, extraDeps...)
1515
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001516 var localResourceJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001517 if len(resArgs) > 0 {
1518 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1519 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001520 if ctx.Failed() {
1521 return
1522 }
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001523 localResourceJars = append(localResourceJars, resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001524 }
1525
Jaewoong Jung26342642021-03-17 15:56:23 -07001526 if Bool(j.properties.Include_srcs) {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001527 localResourceJars = append(localResourceJars, includeSrcJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001528 }
1529
1530 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1531 if len(services) > 0 {
1532 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1533 var zipargs []string
1534 for _, file := range services {
1535 serviceFile := file.String()
1536 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1537 }
1538 rule := zip
1539 args := map[string]string{
1540 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1541 }
1542 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1543 rule = zipRE
1544 args["implicits"] = strings.Join(services.Strings(), ",")
1545 }
1546 ctx.Build(pctx, android.BuildParams{
1547 Rule: rule,
1548 Output: servicesJar,
1549 Implicits: services,
1550 Args: args,
1551 })
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001552 localResourceJars = append(localResourceJars, servicesJar)
1553 }
1554
1555 completeStaticLibsResourceJars := android.NewDepSet(android.PREORDER, localResourceJars, deps.transitiveStaticLibsResourceJars)
1556
1557 var combinedResourceJar android.Path
1558 var resourceJars android.Paths
1559 if ctx.Config().UseTransitiveJarsInClasspath() {
1560 resourceJars = completeStaticLibsResourceJars.ToList()
1561 } else {
1562 resourceJars = append(slices.Clone(localResourceJars), deps.staticResourceJars...)
1563 }
1564 if len(resourceJars) == 1 {
1565 combinedResourceJar = resourceJars[0]
1566 } else if len(resourceJars) > 0 {
1567 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1568 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1569 false, nil, nil)
1570 combinedResourceJar = combinedJar
1571 }
1572
1573 manifest := j.overrideManifest
1574 if !manifest.Valid() && j.properties.Manifest != nil {
1575 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Jaewoong Jung26342642021-03-17 15:56:23 -07001576 }
1577
1578 // Combine the classes built from sources, any manifests, and any static libraries into
1579 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross7707b242024-07-26 12:02:36 -07001580 var outputFile android.Path
Jaewoong Jung26342642021-03-17 15:56:23 -07001581
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001582 completeStaticLibsImplementationJars := android.NewDepSet(android.PREORDER, localImplementationJars, deps.transitiveStaticLibsImplementationJars)
1583
1584 var jars android.Paths
1585 if ctx.Config().UseTransitiveJarsInClasspath() {
1586 jars = completeStaticLibsImplementationJars.ToList()
1587 } else {
1588 jars = append(slices.Clone(localImplementationJars), deps.staticJars...)
1589 }
1590
1591 jars = append(jars, extraDepCombinedJars...)
1592
Jaewoong Jung26342642021-03-17 15:56:23 -07001593 if len(jars) == 1 && !manifest.Valid() {
1594 // Optimization: skip the combine step as there is nothing to do
1595 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1596 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001597 // any if len(extraJars) == 0.
Jaewoong Jung26342642021-03-17 15:56:23 -07001598
Jihoon Kang1147b312023-06-08 23:25:57 +00001599 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1600 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1601 // either with .from-source or .from-text suffix.
1602 // outputFile should be agnostic to the build configuration,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001603 // thus copy the single input static lib in order to prevent the static lib from being exposed
Jihoon Kang1147b312023-06-08 23:25:57 +00001604 // to the copy rules.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001605 if stub, _ := moduleStubLinkType(j); stub {
1606 copiedJar := android.PathForModuleOut(ctx, "combined", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001607 ctx.Build(pctx, android.BuildParams{
1608 Rule: android.Cp,
1609 Input: jars[0],
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001610 Output: copiedJar,
Jaewoong Jung26342642021-03-17 15:56:23 -07001611 })
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001612 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, android.Paths{copiedJar}, nil)
1613 outputFile = copiedJar
Colin Cross7707b242024-07-26 12:02:36 -07001614 } else {
1615 outputFile = jars[0]
Jaewoong Jung26342642021-03-17 15:56:23 -07001616 }
1617 } else {
1618 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1619 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1620 false, nil, nil)
Colin Cross7707b242024-07-26 12:02:36 -07001621 outputFile = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001622 }
1623
1624 // jarjar implementation jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001625 jarjarFile, jarjarred := j.jarjarIfNecessary(ctx, outputFile, jarName, "")
1626 if jarjarred {
1627 localImplementationJars = android.Paths{jarjarFile}
1628 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
1629 }
Colin Crossedec77c2024-07-26 15:25:40 -07001630 outputFile = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001631
Colin Crossedec77c2024-07-26 15:25:40 -07001632 // jarjar resource jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001633 if combinedResourceJar != nil {
1634 resourceJarJarFile, jarjarred := j.jarjarIfNecessary(ctx, combinedResourceJar, jarName, "resource")
1635 combinedResourceJar = resourceJarJarFile
1636 if jarjarred {
1637 localResourceJars = android.Paths{resourceJarJarFile}
1638 completeStaticLibsResourceJars = android.NewDepSet(android.PREORDER, localResourceJars, nil)
1639 }
Colin Crossedec77c2024-07-26 15:25:40 -07001640 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001641
Colin Crossedec77c2024-07-26 15:25:40 -07001642 if ctx.Failed() {
1643 return
Jaewoong Jung26342642021-03-17 15:56:23 -07001644 }
1645
Makoto Onuki7ded3822024-03-28 14:42:20 -07001646 if j.ravenizer.enabled {
1647 ravenizerInput := outputFile
John Wub67040d2024-10-07 18:39:06 +00001648 ravenizerOutput := android.PathForModuleOut(ctx, "ravenizer", "", jarName)
John Wu989ee842024-10-04 00:21:43 +00001649 ravenizerArgs := ""
1650 if proptools.Bool(j.properties.Ravenizer.Strip_mockito) {
1651 ravenizerArgs = "--strip-mockito"
1652 }
1653 TransformRavenizer(ctx, ravenizerOutput, ravenizerInput, ravenizerArgs)
Makoto Onuki7ded3822024-03-28 14:42:20 -07001654 outputFile = ravenizerOutput
Colin Cross7e863852024-09-06 14:42:38 -07001655 localImplementationJars = android.Paths{ravenizerOutput}
1656 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
John Wub67040d2024-10-07 18:39:06 +00001657 if combinedResourceJar != nil {
1658 ravenizerInput = combinedResourceJar
1659 ravenizerOutput = android.PathForModuleOut(ctx, "ravenizer", "resources", jarName)
1660 TransformRavenizer(ctx, ravenizerOutput, ravenizerInput, ravenizerArgs)
1661 combinedResourceJar = ravenizerOutput
1662 localResourceJars = android.Paths{ravenizerOutput}
1663 completeStaticLibsResourceJars = android.NewDepSet(android.PREORDER, localResourceJars, nil)
1664 }
Makoto Onuki7ded3822024-03-28 14:42:20 -07001665 }
1666
Yihan Dong8be09c22024-08-29 15:32:13 +08001667 if j.shouldApiMapper() {
1668 inputFile := outputFile
1669 apiMapperFile := android.PathForModuleOut(ctx, "apimapper", jarName)
1670 ctx.Build(pctx, android.BuildParams{
1671 Rule: apimapper,
1672 Description: "apimapper",
1673 Input: inputFile,
1674 Output: apiMapperFile,
1675 })
1676 outputFile = apiMapperFile
Colin Cross7e863852024-09-06 14:42:38 -07001677 localImplementationJars = android.Paths{apiMapperFile}
1678 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
Yihan Dong8be09c22024-08-29 15:32:13 +08001679 }
1680
Jaewoong Jung26342642021-03-17 15:56:23 -07001681 // Check package restrictions if necessary.
1682 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001683 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001684 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001685
1686 // Create a rule to copy the output jar to another path and add a validate dependency that
1687 // will check that the jar only contains the permitted packages. The new location will become
1688 // the output file of this module.
1689 inputFile := outputFile
Colin Cross7707b242024-07-26 12:02:36 -07001690 packageCheckOutputFile := android.PathForModuleOut(ctx, "package-check", jarName)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001691 ctx.Build(pctx, android.BuildParams{
1692 Rule: android.Cp,
1693 Input: inputFile,
Colin Cross7707b242024-07-26 12:02:36 -07001694 Output: packageCheckOutputFile,
Paul Duffin08a18bf2021-10-01 13:19:58 +01001695 // Make sure that any dependency on the output file will cause ninja to run the package check
1696 // rule.
1697 Validation: pkgckFile,
1698 })
Colin Cross7707b242024-07-26 12:02:36 -07001699 outputFile = packageCheckOutputFile
Colin Cross7e863852024-09-06 14:42:38 -07001700 localImplementationJars = android.Paths{packageCheckOutputFile}
1701 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001702
1703 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001704 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001705
1706 if ctx.Failed() {
1707 return
1708 }
1709 }
1710
1711 j.implementationJarFile = outputFile
1712 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001713 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1714 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1715 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1716 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1717 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1718 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1719 j.headerJarFile = headerJarFile
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001720 if len(localImplementationJars) == 1 && ctx.Config().UseTransitiveJarsInClasspath() {
1721 localHeaderJarFile := android.PathForModuleOut(ctx, "local-javac-header", jarName)
1722 convertImplementationJarToHeaderJar(ctx, localImplementationJars[0], localHeaderJarFile)
1723 localHeaderJars = append(localHeaderJars, localHeaderJarFile)
1724 } else {
1725 localHeaderJars = append(localHeaderJars, headerJarFile)
1726 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001727 }
1728
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001729 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1730 specs := j.jacocoModuleToZipCommand(ctx)
1731 if ctx.Failed() {
1732 return
1733 }
1734
Colin Crossb323c912024-09-24 15:21:00 -07001735 completeStaticLibsImplementationJarsToCombine := completeStaticLibsImplementationJars
1736
Jaewoong Jung26342642021-03-17 15:56:23 -07001737 if j.shouldInstrument(ctx) {
Colin Crossb323c912024-09-24 15:21:00 -07001738 instrumentedOutputFile := j.instrument(ctx, flags, outputFile, jarName, specs)
1739 completeStaticLibsImplementationJarsToCombine = android.NewDepSet(android.PREORDER, android.Paths{instrumentedOutputFile}, nil)
1740 outputFile = instrumentedOutputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001741 }
1742
1743 // merge implementation jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001744 var implementationAndResourcesJarsToCombine android.Paths
1745 if ctx.Config().UseTransitiveJarsInClasspath() {
1746 resourceJars := completeStaticLibsResourceJars.ToList()
1747 if len(resourceJars) > 0 {
Colin Crossb323c912024-09-24 15:21:00 -07001748 implementationAndResourcesJarsToCombine = append(resourceJars, completeStaticLibsImplementationJarsToCombine.ToList()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001749 implementationAndResourcesJarsToCombine = append(implementationAndResourcesJarsToCombine, extraDepCombinedJars...)
1750 }
1751 } else {
1752 if combinedResourceJar != nil {
1753 implementationAndResourcesJarsToCombine = android.Paths{combinedResourceJar, outputFile}
1754 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001755 }
1756
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001757 if len(implementationAndResourcesJarsToCombine) > 0 {
1758 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
1759 TransformJarsToJar(ctx, combinedJar, "for resources", implementationAndResourcesJarsToCombine, manifest,
1760 false, nil, nil)
1761 outputFile = combinedJar
1762 }
1763
1764 j.implementationAndResourcesJar = outputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001765
1766 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001767 compileDex := j.dexProperties.Compile_dex
Colin Crossff694a82023-12-13 15:54:49 -08001768 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -07001769 if j.DirectlyInAnyApex() && !apexInfo.IsForPlatform() {
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001770 if compileDex == nil {
1771 compileDex = proptools.BoolPtr(true)
Jaewoong Jung26342642021-03-17 15:56:23 -07001772 }
1773 if j.deviceProperties.Hostdex == nil {
1774 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1775 }
1776 }
1777
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001778 if ctx.Device() && (Bool(j.properties.Installable) || Bool(compileDex)) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001779 if j.hasCode(ctx) {
1780 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001781 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001782 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1783 }
1784 // Dex compilation
Colin Cross7707b242024-07-26 12:02:36 -07001785 var dexOutputFile android.Path
Spandan Dasc404cc72023-02-23 18:05:05 +00001786 params := &compileDexParams{
1787 flags: flags,
1788 sdkVersion: j.SdkVersion(ctx),
1789 minSdkVersion: j.MinSdkVersion(ctx),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001790 classesJar: outputFile,
Spandan Dasc404cc72023-02-23 18:05:05 +00001791 jarName: jarName,
1792 }
Cole Fausteb032462024-09-19 11:12:54 -07001793 if j.GetProfileGuided(ctx) && j.optimizeOrObfuscateEnabled() && !j.EnableProfileRewriting(ctx) {
Spandan Das15a67112024-05-30 00:07:40 +00001794 ctx.PropertyErrorf("enable_profile_rewriting",
1795 "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.",
1796 )
1797 }
Cole Fausteb032462024-09-19 11:12:54 -07001798 if j.EnableProfileRewriting(ctx) {
1799 profile := j.GetProfile(ctx)
1800 if profile == "" || !j.GetProfileGuided(ctx) {
Spandan Das3dbda182024-05-20 22:23:10 +00001801 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1802 }
1803 params.artProfileInput = &profile
1804 }
1805 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001806 if ctx.Failed() {
1807 return
1808 }
1809
Spandan Das3dbda182024-05-20 22:23:10 +00001810 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1811 if dexArtProfileOutput != nil {
Colin Cross7707b242024-07-26 12:02:36 -07001812 j.dexpreopter.SetRewrittenProfile(dexArtProfileOutput)
Spandan Das3dbda182024-05-20 22:23:10 +00001813 }
1814
Jaewoong Jung26342642021-03-17 15:56:23 -07001815 // merge dex jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001816 var dexAndResourceJarsToCombine android.Paths
1817 if ctx.Config().UseTransitiveJarsInClasspath() {
1818 resourceJars := completeStaticLibsResourceJars.ToList()
1819 if len(resourceJars) > 0 {
1820 dexAndResourceJarsToCombine = append(android.Paths{dexOutputFile}, resourceJars...)
1821 }
1822 } else {
1823 if combinedResourceJar != nil {
1824 dexAndResourceJarsToCombine = android.Paths{dexOutputFile, combinedResourceJar}
1825 }
1826 }
1827 if len(dexAndResourceJarsToCombine) > 0 {
Colin Cross7707b242024-07-26 12:02:36 -07001828 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001829 TransformJarsToJar(ctx, combinedJar, "for dex resources", dexAndResourceJarsToCombine, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07001830 false, nil, nil)
1831 if *j.dexProperties.Uncompress_dex {
Colin Cross7707b242024-07-26 12:02:36 -07001832 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
Cole Faust51d7bfd2023-09-07 05:31:32 +00001833 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001834 dexOutputFile = combinedAlignedJar
1835 } else {
1836 dexOutputFile = combinedJar
1837 }
1838 }
1839
Paul Duffin4de94502021-05-16 05:21:16 +01001840 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001841
1842 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001843
1844 // Encode hidden API flags in dex file, if needed.
1845 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1846
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001847 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001848
1849 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001850 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1851 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1852 libName = strings.TrimSuffix(libName, ".impl")
1853 }
1854 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001855
1856 outputFile = dexOutputFile
Colin Crossa6182ab2024-08-21 10:47:44 -07001857
1858 ctx.CheckbuildFile(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001859 } else {
1860 // There is no code to compile into a dex jar, make sure the resources are propagated
1861 // to the APK if this is an app.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001862 j.dexJarFile = makeDexJarPathFromPath(combinedResourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001863 }
1864
1865 if ctx.Failed() {
1866 return
1867 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001868 }
1869
1870 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001871 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001872 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001873 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001874 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001875 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001876 }
1877 }
1878
1879 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001880 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1881 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001882 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1883 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001884 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001885 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001886 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001887 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001888 j.linter.javaLanguageLevel = flags.javaVersion.String()
1889 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001890 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001891 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1892 j.linter.buildModuleReportZip = true
1893 }
1894 j.linter.lint(ctx)
1895 }
1896
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001897 j.collectTransitiveSrcFiles(ctx, srcFiles)
1898
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001899 if ctx.Config().UseTransitiveJarsInClasspath() {
1900 if len(localImplementationJars) > 0 || len(localResourceJars) > 0 || len(localHeaderJars) > 0 {
1901 ctx.CheckbuildFile(localImplementationJars...)
1902 ctx.CheckbuildFile(localResourceJars...)
1903 ctx.CheckbuildFile(localHeaderJars...)
1904 } else {
1905 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1906 ctx.UncheckedModule()
1907 }
1908 } else {
1909 ctx.CheckbuildFile(j.implementationJarFile)
1910 ctx.CheckbuildFile(j.headerJarFile)
1911 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001912
Colin Cross7727c7f2024-07-18 15:36:32 -07001913 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001914 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1915 RepackagedHeaderJars: android.PathsIfNonNil(repackagedHeaderJarFile),
1916
1917 LocalHeaderJars: localHeaderJars,
1918 TransitiveStaticLibsHeaderJars: android.NewDepSet(android.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
1919 TransitiveStaticLibsImplementationJars: completeStaticLibsImplementationJars,
1920 TransitiveStaticLibsResourceJars: completeStaticLibsResourceJars,
1921
Colin Cross9ffaf282024-08-12 13:50:09 -07001922 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1923 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001924 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1925 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001926 ResourceJars: android.PathsIfNonNil(combinedResourceJar),
Jihoon Kang705e63e2024-03-13 01:21:16 +00001927 AidlIncludeDirs: j.exportAidlIncludeDirs,
1928 SrcJarArgs: j.srcJarArgs,
1929 SrcJarDeps: j.srcJarDeps,
1930 TransitiveSrcFiles: j.transitiveSrcFiles,
1931 ExportedPlugins: j.exportedPluginJars,
1932 ExportedPluginClasses: j.exportedPluginClasses,
1933 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1934 JacocoReportClassesFile: j.jacocoReportClassesFile,
1935 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001936 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001937 })
1938
1939 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1940 j.outputFile = outputFile.WithoutRel()
1941}
1942
Cole Faustb7493472024-08-28 11:55:52 -07001943func (j *Module) useCompose(ctx android.BaseModuleContext) bool {
1944 return android.InList("androidx.compose.runtime_runtime", j.staticLibs(ctx))
Colin Crossa1ff7c62021-09-17 14:11:52 -07001945}
1946
Colin Crosscde55342024-03-27 14:11:51 -07001947func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []*android.DepSet[android.Path]) {
Sam Delmerico95d70942023-08-02 18:00:35 -04001948 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -08001949 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001950 depTag := ctx.OtherModuleDependencyTag(m)
1951
1952 if depProguardInfo.UnconditionallyExportedProguardFlags != nil {
1953 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1954 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1955 }
1956
1957 if depTag == staticLibTag && depProguardInfo.ProguardFlagsFiles != nil {
1958 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
1959 }
1960 })
1961
Colin Crosscde55342024-03-27 14:11:51 -07001962 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
1963}
1964
1965func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
1966 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
1967
Sam Delmerico95d70942023-08-02 18:00:35 -04001968 directUnconditionalExportedFlags := android.Paths{}
1969 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
1970 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
1971 if exportUnconditionally {
1972 // if we explicitly export, then our unconditional exports are the same as our transitive flags
1973 transitiveUnconditionalExportedFlags = transitiveProguardFlags
1974 directUnconditionalExportedFlags = proguardFlagsForThisModule
1975 }
1976
1977 return ProguardSpecInfo{
1978 Export_proguard_flags_files: exportUnconditionally,
1979 ProguardFlagsFiles: android.NewDepSet[android.Path](
1980 android.POSTORDER,
1981 proguardFlagsForThisModule,
1982 transitiveProguardFlags,
1983 ),
1984 UnconditionallyExportedProguardFlags: android.NewDepSet[android.Path](
1985 android.POSTORDER,
1986 directUnconditionalExportedFlags,
1987 transitiveUnconditionalExportedFlags,
1988 ),
1989 }
1990
1991}
1992
Cole Faust75fffb12021-06-13 15:23:16 -07001993// Returns a copy of the supplied flags, but with all the errorprone-related
1994// fields copied to the regular build's fields.
1995func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
1996 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
1997
1998 if len(flags.errorProneExtraJavacFlags) > 0 {
1999 if len(flags.javacFlags) > 0 {
2000 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
2001 } else {
2002 flags.javacFlags = flags.errorProneExtraJavacFlags
2003 }
2004 }
2005 return flags
2006}
2007
Jaewoong Jung26342642021-03-17 15:56:23 -07002008func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
Colin Cross7707b242024-07-26 12:02:36 -07002009 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002010
2011 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00002012 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002013 if idx >= 0 {
2014 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00002015 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002016 jarName += strconv.Itoa(idx)
2017 }
2018
Colin Cross7707b242024-07-26 12:02:36 -07002019 classes := android.PathForModuleOut(ctx, "javac", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00002020 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07002021
Cole Faust9decf832024-06-11 11:45:53 -07002022 if ctx.Config().EmitXrefRules() && ctx.Module() == ctx.PrimaryModule() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002023 extractionFile := android.PathForModuleOut(ctx, kzipName)
2024 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
2025 j.kytheFiles = append(j.kytheFiles, extractionFile)
2026 }
2027
Vadim Spivak3c496f02023-06-08 06:14:59 +00002028 if len(flags.processorPath) > 0 {
2029 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
2030 }
2031
Jaewoong Jung26342642021-03-17 15:56:23 -07002032 return classes
2033}
2034
2035// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
2036// since some of these flags may be used internally.
2037func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
2038 for _, flag := range flags {
2039 flag = strings.TrimSpace(flag)
2040
2041 if !strings.HasPrefix(flag, "-") {
2042 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
2043 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
2044 ctx.PropertyErrorf("kotlincflags",
2045 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
2046 } else if inList(flag, config.KotlincIllegalFlags) {
2047 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
2048 } else if flag == "-include-runtime" {
2049 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
2050 } else {
2051 args := strings.Split(flag, " ")
2052 if args[0] == "-kotlin-home" {
2053 ctx.PropertyErrorf("kotlincflags",
2054 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
2055 }
2056 }
2057 }
2058}
2059
2060func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
2061 deps deps, flags javaBuilderFlags, jarName string,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002062 extraJars android.Paths) (localHeaderJars android.Paths, combinedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002063
Jaewoong Jung26342642021-03-17 15:56:23 -07002064 if len(srcFiles) > 0 || len(srcJars) > 0 {
2065 // Compile java sources into turbine.jar.
2066 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
2067 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002068 localHeaderJars = append(localHeaderJars, turbineJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07002069 }
2070
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002071 localHeaderJars = append(localHeaderJars, extraJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002072
2073 // Combine any static header libraries into classes-header.jar. If there is only
2074 // one input jar this step will be skipped.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002075 var jars android.Paths
2076 if ctx.Config().UseTransitiveJarsInClasspath() {
2077 depSet := android.NewDepSet(android.PREORDER, localHeaderJars, deps.transitiveStaticLibsHeaderJars)
2078 jars = depSet.ToList()
2079 } else {
2080 jars = append(slices.Clone(localHeaderJars), deps.staticHeaderJars...)
2081 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002082
2083 // we cannot skip the combine step for now if there is only one jar
2084 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
Colin Crossedec77c2024-07-26 15:25:40 -07002085 combinedHeaderJarOutputPath := android.PathForModuleOut(ctx, "turbine-combined", jarName)
2086 TransformJarsToJar(ctx, combinedHeaderJarOutputPath, "for turbine", jars, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07002087 false, nil, []string{"META-INF/TRANSITIVE"})
Jaewoong Jung26342642021-03-17 15:56:23 -07002088
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002089 return localHeaderJars, combinedHeaderJarOutputPath
Jaewoong Jung26342642021-03-17 15:56:23 -07002090}
2091
2092func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross7707b242024-07-26 12:02:36 -07002093 classesJar android.Path, jarName string, specs string) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002094
2095 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Cross7707b242024-07-26 12:02:36 -07002096 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07002097
2098 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
2099
2100 j.jacocoReportClassesFile = jacocoReportClassesFile
2101
2102 return instrumentedJar
2103}
2104
Colin Cross9ffaf282024-08-12 13:50:09 -07002105type providesTransitiveHeaderJarsForR8 struct {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002106 // set of header jars for all transitive libs deps
Colin Cross9ffaf282024-08-12 13:50:09 -07002107 transitiveLibsHeaderJarsForR8 *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002108 // set of header jars for all transitive static libs deps
Colin Cross9ffaf282024-08-12 13:50:09 -07002109 transitiveStaticLibsHeaderJarsForR8 *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002110}
2111
Colin Cross9ffaf282024-08-12 13:50:09 -07002112// collectTransitiveHeaderJarsForR8 visits direct dependencies and collects all transitive libs and static_libs
2113// header jars. The semantics of the collected jars are odd (it collects combined jars that contain the static
2114// libs, but also the static libs, and it collects transitive libs dependencies of static_libs), so these
2115// are only used to expand the --lib arguments to R8.
2116func (j *providesTransitiveHeaderJarsForR8) collectTransitiveHeaderJarsForR8(ctx android.ModuleContext) {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002117 directLibs := android.Paths{}
2118 directStaticLibs := android.Paths{}
Colin Crossc85750b2022-04-21 12:50:51 -07002119 transitiveLibs := []*android.DepSet[android.Path]{}
2120 transitiveStaticLibs := []*android.DepSet[android.Path]{}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002121 ctx.VisitDirectDeps(func(module android.Module) {
2122 // don't add deps of the prebuilt version of the same library
2123 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
2124 return
2125 }
2126
Colin Cross7727c7f2024-07-18 15:36:32 -07002127 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2128 tag := ctx.OtherModuleDependencyTag(module)
2129 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
2130 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
2131 directLibs = append(directLibs, dep.HeaderJars...)
2132 } else if tag == staticLibTag {
2133 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
2134 } else {
2135 // Don't propagate transitive libs for other kinds of dependencies.
2136 return
2137 }
Jared Dukeefb6d602023-10-27 18:47:10 +00002138
Colin Cross9ffaf282024-08-12 13:50:09 -07002139 if dep.TransitiveLibsHeaderJarsForR8 != nil {
2140 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJarsForR8)
Colin Cross7727c7f2024-07-18 15:36:32 -07002141 }
Colin Cross9ffaf282024-08-12 13:50:09 -07002142 if dep.TransitiveStaticLibsHeaderJarsForR8 != nil {
2143 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJarsForR8)
Colin Cross7727c7f2024-07-18 15:36:32 -07002144 }
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002145
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002146 }
2147 })
Colin Cross9ffaf282024-08-12 13:50:09 -07002148 j.transitiveLibsHeaderJarsForR8 = android.NewDepSet(android.POSTORDER, directLibs, transitiveLibs)
2149 j.transitiveStaticLibsHeaderJarsForR8 = android.NewDepSet(android.POSTORDER, directStaticLibs, transitiveStaticLibs)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002150}
2151
Jaewoong Jung26342642021-03-17 15:56:23 -07002152func (j *Module) HeaderJars() android.Paths {
2153 if j.headerJarFile == nil {
2154 return nil
2155 }
2156 return android.Paths{j.headerJarFile}
2157}
2158
2159func (j *Module) ImplementationJars() android.Paths {
2160 if j.implementationJarFile == nil {
2161 return nil
2162 }
2163 return android.Paths{j.implementationJarFile}
2164}
2165
Spandan Das59a4a2b2024-01-09 21:35:56 +00002166func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002167 return j.dexJarFile
2168}
2169
2170func (j *Module) DexJarInstallPath() android.Path {
2171 return j.installFile
2172}
2173
2174func (j *Module) ImplementationAndResourcesJars() android.Paths {
2175 if j.implementationAndResourcesJar == nil {
2176 return nil
2177 }
2178 return android.Paths{j.implementationAndResourcesJar}
2179}
2180
2181func (j *Module) AidlIncludeDirs() android.Paths {
2182 // exportAidlIncludeDirs is type android.Paths already
2183 return j.exportAidlIncludeDirs
2184}
2185
2186func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2187 return j.classLoaderContexts
2188}
2189
2190// Collect information for opening IDE project files in java/jdeps.go.
Cole Faustb36d31d2024-08-27 16:04:28 -07002191func (j *Module) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002192 if j.expandJarjarRules != nil {
2193 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Spandan Das096b8d62024-10-08 22:41:26 +00002194 // Add the header jar so that the rdeps can be resolved to the repackaged classes.
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002195 dpInfo.Jars = append(dpInfo.Jars, j.headerJarFile.String())
Jaewoong Jung26342642021-03-17 15:56:23 -07002196 }
Spandan Das096b8d62024-10-08 22:41:26 +00002197 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2198 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2199 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002200 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2201 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Cole Faustb7493472024-08-28 11:55:52 -07002202 dpInfo.Static_libs = append(dpInfo.Static_libs, j.staticLibs(ctx)...)
Yikef6282022022-04-13 20:41:01 +08002203 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002204}
2205
2206func (j *Module) CompilerDeps() []string {
Spandan Das8aac9932024-07-18 23:14:13 +00002207 return j.compileDepNames
Jaewoong Jung26342642021-03-17 15:56:23 -07002208}
2209
2210func (j *Module) hasCode(ctx android.ModuleContext) bool {
2211 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2212 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2213}
2214
2215// Implements android.ApexModule
2216func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
2217 return j.depIsInSameApex(ctx, dep)
2218}
2219
2220// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002221func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002222 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002223 minSdkVersion := j.MinSdkVersion(ctx)
2224 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002225 return fmt.Errorf("min_sdk_version is not specified")
2226 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002227 // If the module is compiling against core (via sdk_version), skip comparison check.
2228 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002229 return nil
2230 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002231 if minSdkVersion.GreaterThan(sdkVersion) {
2232 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002233 }
2234 return nil
2235}
2236
2237func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002238 if j.stem == "" {
2239 panic("Stem() called before stem property was set")
2240 }
2241 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002242}
2243
Jaewoong Jung26342642021-03-17 15:56:23 -07002244func (j *Module) JacocoReportClassesFile() android.Path {
2245 return j.jacocoReportClassesFile
2246}
2247
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002248func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
2249 var fromDeps []*android.DepSet[android.Path]
2250 ctx.VisitDirectDeps(func(module android.Module) {
2251 tag := ctx.OtherModuleDependencyTag(module)
2252 if tag == staticLibTag {
Colin Cross7727c7f2024-07-18 15:36:32 -07002253 if depInfo, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2254 if depInfo.TransitiveSrcFiles != nil {
2255 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
2256 }
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002257 }
2258 }
2259 })
2260
2261 j.transitiveSrcFiles = android.NewDepSet(android.POSTORDER, mine, fromDeps)
2262}
2263
Jaewoong Jung26342642021-03-17 15:56:23 -07002264func (j *Module) IsInstallable() bool {
2265 return Bool(j.properties.Installable)
2266}
2267
2268type sdkLinkType int
2269
2270const (
2271 // TODO(jiyong) rename these for better readability. Make the allowed
2272 // and disallowed link types explicit
2273 // order is important here. See rank()
2274 javaCore sdkLinkType = iota
2275 javaSdk
2276 javaSystem
2277 javaModule
2278 javaSystemServer
2279 javaPlatform
2280)
2281
2282func (lt sdkLinkType) String() string {
2283 switch lt {
2284 case javaCore:
2285 return "core Java API"
2286 case javaSdk:
2287 return "Android API"
2288 case javaSystem:
2289 return "system API"
2290 case javaModule:
2291 return "module API"
2292 case javaSystemServer:
2293 return "system server API"
2294 case javaPlatform:
2295 return "private API"
2296 default:
2297 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2298 }
2299}
2300
2301// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2302// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2303// can't statically depend on modules that use Platform API.
2304func (lt sdkLinkType) rank() int {
2305 return int(lt)
2306}
2307
2308type moduleWithSdkDep interface {
2309 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002310 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002311}
2312
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002313func sdkLinkTypeFromSdkKind(k android.SdkKind) sdkLinkType {
2314 switch k {
2315 case android.SdkCore:
2316 return javaCore
2317 case android.SdkSystem:
2318 return javaSystem
2319 case android.SdkPublic:
2320 return javaSdk
2321 case android.SdkModule:
2322 return javaModule
2323 case android.SdkSystemServer:
2324 return javaSystemServer
2325 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
2326 return javaPlatform
2327 default:
2328 return javaSdk
2329 }
2330}
2331
Jiyong Park92315372021-04-02 08:45:46 +09002332func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002333 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002334 case android.SdkCore.DefaultJavaLibraryName(),
2335 "legacy.core.platform.api.stubs",
2336 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002337 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002338 "core-lambda-stubs",
Jihoon Kangb5078312023-03-29 23:25:49 +00002339 "core-generated-annotation-stubs":
Jaewoong Jung26342642021-03-17 15:56:23 -07002340 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002341 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002342 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002343 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002344 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002345 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002346 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002347 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002348 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002349 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002350 return javaSystem, true
2351 }
2352
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002353 if stub, linkType := moduleStubLinkType(m); stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07002354 return linkType, true
2355 }
2356
Jiyong Park92315372021-04-02 08:45:46 +09002357 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002358 if !ver.Valid() {
2359 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002360 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002361
2362 return sdkLinkTypeFromSdkKind(ver.Kind), false
Jaewoong Jung26342642021-03-17 15:56:23 -07002363}
2364
2365// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2366// this module's. See the comment on rank() for details and an example.
2367func (j *Module) checkSdkLinkType(
2368 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
2369 if ctx.Host() {
2370 return
2371 }
2372
Jiyong Park92315372021-04-02 08:45:46 +09002373 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002374 if stubs {
2375 return
2376 }
Jiyong Park92315372021-04-02 08:45:46 +09002377 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07002378
2379 if myLinkType.rank() < depLinkType.rank() {
2380 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2381 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2382 "property of the source or target module so that target module is built "+
2383 "with the same or smaller API set when compared to the source.",
2384 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2385 }
2386}
2387
2388func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2389 var deps deps
2390
Jiyong Park92315372021-04-02 08:45:46 +09002391 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002392
Colin Cross9ffaf282024-08-12 13:50:09 -07002393 j.collectTransitiveHeaderJarsForR8(ctx)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002394
2395 var transitiveBootClasspathHeaderJars []*android.DepSet[android.Path]
2396 var transitiveClasspathHeaderJars []*android.DepSet[android.Path]
2397 var transitiveJava9ClasspathHeaderJars []*android.DepSet[android.Path]
2398 var transitiveStaticJarsHeaderLibs []*android.DepSet[android.Path]
2399 var transitiveStaticJarsImplementationLibs []*android.DepSet[android.Path]
2400 var transitiveStaticJarsResourceLibs []*android.DepSet[android.Path]
2401
Jaewoong Jung26342642021-03-17 15:56:23 -07002402 ctx.VisitDirectDeps(func(module android.Module) {
2403 otherName := ctx.OtherModuleName(module)
2404 tag := ctx.OtherModuleDependencyTag(module)
2405
2406 if IsJniDepTag(tag) {
2407 // Handled by AndroidApp.collectAppDeps
2408 return
2409 }
2410 if tag == certificateTag {
2411 // Handled by AndroidApp.collectAppDeps
2412 return
2413 }
2414
Jihoon Kang98e9ac62024-09-25 23:42:30 +00002415 if sdkInfo, ok := android.OtherModuleProvider(ctx, module, SdkLibraryInfoProvider); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -07002416 switch tag {
Jihoon Kang28c96572024-09-11 23:44:44 +00002417 case sdkLibTag, libTag, staticLibTag:
Jihoon Kang28c96572024-09-11 23:44:44 +00002418 generatingLibsString := android.PrettyConcat(
2419 getGeneratingLibs(ctx, j.SdkVersion(ctx), module.Name(), sdkInfo), true, "or")
2420 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 -07002421 }
Colin Cross313aa542023-12-13 13:47:44 -08002422 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2423 if sdkLinkType != javaPlatform {
2424 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2425 // dep is a sysprop implementation library, but this module is not linking against
2426 // the platform, so it gets the sysprop public stubs library instead. Replace
2427 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2428 dep = syspropDep.JavaInfo
2429 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002430 }
2431 switch tag {
2432 case bootClasspathTag:
2433 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002434 if dep.TransitiveStaticLibsHeaderJars != nil {
2435 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2436 }
Liz Kammeref28a4c2022-09-23 16:50:56 -04002437 case sdkLibTag, libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002438 if _, ok := module.(*Plugin); ok {
2439 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2440 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002441 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002442 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002443 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2444 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2445 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2446 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002447 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2448 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2449 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002450
2451 if dep.TransitiveStaticLibsHeaderJars != nil {
2452 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2453 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002454 case java9LibTag:
2455 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002456 if dep.TransitiveStaticLibsHeaderJars != nil {
2457 transitiveJava9ClasspathHeaderJars = append(transitiveJava9ClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2458 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002459 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002460 if _, ok := module.(*Plugin); ok {
2461 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2462 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002463 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2464 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2465 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2466 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2467 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2468 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2469 // Turbine doesn't run annotation processors, so any module that uses an
2470 // annotation processor that generates API is incompatible with the turbine
2471 // optimization.
2472 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002473 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002474
2475 if dep.TransitiveStaticLibsHeaderJars != nil {
2476 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2477 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, dep.TransitiveStaticLibsHeaderJars)
2478 }
2479 if dep.TransitiveStaticLibsImplementationJars != nil {
2480 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, dep.TransitiveStaticLibsImplementationJars)
2481 }
2482 if dep.TransitiveStaticLibsResourceJars != nil {
2483 transitiveStaticJarsResourceLibs = append(transitiveStaticJarsResourceLibs, dep.TransitiveStaticLibsResourceJars)
2484 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002485 case pluginTag:
2486 if plugin, ok := module.(*Plugin); ok {
2487 if plugin.pluginProperties.Processor_class != nil {
2488 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
2489 } else {
2490 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2491 }
2492 // Turbine doesn't run annotation processors, so any module that uses an
2493 // annotation processor that generates API is incompatible with the turbine
2494 // optimization.
2495 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
2496 } else {
2497 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2498 }
2499 case errorpronePluginTag:
2500 if _, ok := module.(*Plugin); ok {
2501 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2502 } else {
2503 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2504 }
2505 case exportedPluginTag:
2506 if plugin, ok := module.(*Plugin); ok {
2507 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
2508 if plugin.pluginProperties.Processor_class != nil {
2509 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
2510 }
2511 // Turbine doesn't run annotation processors, so any module that uses an
2512 // annotation processor that generates API is incompatible with the turbine
2513 // optimization.
2514 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
2515 } else {
2516 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2517 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07002518 case kotlinPluginTag:
Luca Stefani50098f72024-10-12 17:55:31 +02002519 if _, ok := module.(*KotlinPlugin); ok {
2520 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
2521 } else {
2522 ctx.PropertyErrorf("kotlin_plugins", "%q is not a kotlin_plugin module", otherName)
2523 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002524 case syspropPublicStubDepTag:
2525 // This is a sysprop implementation library, forward the JavaInfoProvider from
2526 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002527 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002528 JavaInfo: dep,
2529 })
2530 }
2531 } else if dep, ok := module.(android.SourceFileProducer); ok {
2532 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002533 case sdkLibTag, libTag:
Jaewoong Jung26342642021-03-17 15:56:23 -07002534 checkProducesJars(ctx, dep)
2535 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002536 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002537 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars,
2538 android.NewDepSet(android.PREORDER, dep.Srcs(), nil))
Jaewoong Jung26342642021-03-17 15:56:23 -07002539 case staticLibTag:
2540 checkProducesJars(ctx, dep)
2541 deps.classpath = append(deps.classpath, dep.Srcs()...)
2542 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2543 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002544
2545 depHeaderJars := android.NewDepSet(android.PREORDER, dep.Srcs(), nil)
2546 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, depHeaderJars)
2547 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, depHeaderJars)
2548 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, depHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002549 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002550 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002551 switch tag {
2552 case staticLibTag:
2553 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2554 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002555 } else {
2556 switch tag {
2557 case bootClasspathTag:
2558 // If a system modules dependency has been added to the bootclasspath
2559 // then add its libs to the bootclasspath.
Colin Crossb61c2262024-08-08 14:04:42 -07002560 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002561 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars...)
2562 if sm.TransitiveStaticLibsHeaderJars != nil {
2563 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars,
2564 sm.TransitiveStaticLibsHeaderJars)
2565 }
Colin Crossb61c2262024-08-08 14:04:42 -07002566 } else {
2567 ctx.PropertyErrorf("boot classpath dependency %q does not provide SystemModulesProvider",
2568 ctx.OtherModuleName(module))
2569 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002570
2571 case systemModulesTag:
2572 if deps.systemModules != nil {
2573 panic("Found two system module dependencies")
2574 }
Colin Crossb61c2262024-08-08 14:04:42 -07002575 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2576 deps.systemModules = &systemModules{sm.OutputDir, sm.OutputDirDeps}
2577 } else {
2578 ctx.PropertyErrorf("system modules dependency %q does not provide SystemModulesProvider",
2579 ctx.OtherModuleName(module))
2580 }
Paul Duffin53a70a42022-01-11 14:35:55 +00002581
2582 case instrumentationForTag:
2583 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 -07002584 }
2585 }
2586
Spandan Das8aac9932024-07-18 23:14:13 +00002587 if android.InList(tag, compileDependencyTags) {
2588 // Add the dependency name to compileDepNames so that it can be recorded in module_bp_java_deps.json
2589 j.compileDepNames = append(j.compileDepNames, otherName)
2590 }
2591
Jaewoong Jung26342642021-03-17 15:56:23 -07002592 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002593 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002594 })
2595
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002596 deps.transitiveStaticLibsHeaderJars = transitiveStaticJarsHeaderLibs
2597 deps.transitiveStaticLibsImplementationJars = transitiveStaticJarsImplementationLibs
2598 deps.transitiveStaticLibsResourceJars = transitiveStaticJarsResourceLibs
2599
2600 if ctx.Config().UseTransitiveJarsInClasspath() {
2601 depSet := android.NewDepSet(android.PREORDER, nil, transitiveClasspathHeaderJars)
2602 deps.classpath = depSet.ToList()
2603 depSet = android.NewDepSet(android.PREORDER, nil, transitiveBootClasspathHeaderJars)
2604 deps.bootClasspath = depSet.ToList()
2605 depSet = android.NewDepSet(android.PREORDER, nil, transitiveJava9ClasspathHeaderJars)
2606 deps.java9Classpath = depSet.ToList()
2607 }
2608
2609 if ctx.Device() {
2610 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
2611 if sdkDep.invalidVersion {
2612 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2613 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2614 } else if sdkDep.useFiles {
2615 // sdkDep.jar is actually equivalent to turbine header.jar.
2616 deps.classpath = append(slices.Clone(classpath(sdkDep.jars)), deps.classpath...)
2617 deps.dexClasspath = append(slices.Clone(classpath(sdkDep.jars)), deps.dexClasspath...)
2618 deps.aidlPreprocess = sdkDep.aidl
2619 // Add the sdk module dependency to `compileDepNames`.
2620 // This ensures that the dependency is reported in `module_bp_java_deps.json`
2621 // TODO (b/358608607): Move this to decodeSdkDep
2622 sdkSpec := android.SdkContext(j).SdkVersion(ctx)
2623 j.compileDepNames = append(j.compileDepNames, fmt.Sprintf("sdk_%s_%s_android", sdkSpec.Kind.String(), sdkSpec.ApiLevel.String()))
2624 } else {
2625 deps.aidlPreprocess = sdkDep.aidl
2626 }
2627 }
2628
Jaewoong Jung26342642021-03-17 15:56:23 -07002629 return deps
2630}
2631
Joe Onorato349ae8d2024-02-05 22:46:00 +00002632// Provider for jarjar renaming rules.
2633//
2634// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2635// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2636// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2637// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2638// be renamed from that module.
2639// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002640type DependencyUse int
2641
2642const (
2643 RenameUseInvalid DependencyUse = iota
2644 RenameUseInclude
2645 RenameUseExclude
2646)
2647
2648type RenameUseElement struct {
2649 DepName string
2650 RenameUse DependencyUse
2651 Why string // token for determining where in the logic the decision was made.
2652}
2653
Joe Onorato349ae8d2024-02-05 22:46:00 +00002654type JarJarProviderData struct {
2655 // Mapping of class names: original --> renamed. If the value is "", the class will be
2656 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2657 // attribute). Rdeps of that module will inherit the renaming.
LaMont Jones63683e42024-02-08 14:30:45 -08002658 Rename map[string]string
2659 RenameUse []RenameUseElement
Joe Onorato349ae8d2024-02-05 22:46:00 +00002660}
2661
2662func (this JarJarProviderData) GetDebugString() string {
2663 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002664 for _, k := range android.SortedKeys(this.Rename) {
2665 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002666 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2667 result += k + "--&gt;" + v + ";"
2668 }
2669 }
2670 return result
2671}
2672
2673var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2674
2675var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2676
2677func init() {
2678 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
Yu Liu26a716d2024-08-30 23:40:32 +00002679
2680 gob.Register(BaseJarJarProviderData{})
Joe Onorato349ae8d2024-02-05 22:46:00 +00002681}
2682
2683// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2684// whether they are java modules or not.
2685type BaseJarJarProviderData struct {
2686 JarJarProviderData JarJarProviderData
2687}
2688
2689func (this BaseJarJarProviderData) GetDebugString() string {
2690 return this.JarJarProviderData.GetDebugString()
2691}
2692
2693var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2694
2695// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2696// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2697// either JarJarProvider or BaseJarJarProvider.
2698func mergeJarJarPrefixes(ctx android.ModuleContext) {
2699 mod := ctx.Module()
2700 // Explicitly avoid propagating into some module types.
2701 switch reflect.TypeOf(mod).String() {
2702 case "*java.Droidstubs":
2703 return
2704 }
2705 jarJarData := collectDirectDepsProviders(ctx)
2706 if jarJarData != nil {
2707 providerData := BaseJarJarProviderData{
2708 JarJarProviderData: *jarJarData,
2709 }
2710 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2711 }
2712
2713}
2714
2715// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2716func (module *Module) addJarJarRenameRule(original string, renamed string) {
2717 if module.jarjarRenameRules == nil {
2718 module.jarjarRenameRules = make(map[string]string)
2719 }
2720 module.jarjarRenameRules[original] = renamed
2721}
2722
2723func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2724 // Gather repackage information from deps
2725 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002726
2727 module := ctx.Module()
2728 moduleName := module.Name()
2729
Colin Cross648daea2024-09-12 14:35:29 -07002730 ctx.VisitDirectDeps(func(m android.Module) {
LaMont Jones63683e42024-02-08 14:30:45 -08002731 tag := ctx.OtherModuleDependencyTag(m)
2732 // This logic mirrors that in (*Module).collectDeps above. There are several places
2733 // where we explicitly return RenameUseExclude, even though it is the default, to
2734 // indicate that it has been verified to be the case.
2735 //
2736 // Note well: there are probably cases that are getting to the unconditional return
2737 // and are therefore wrong.
2738 shouldIncludeRenames := func() (DependencyUse, string) {
2739 if moduleName == m.Name() {
2740 return RenameUseInclude, "name" // If we have the same module name, include the renames.
2741 }
2742 if sc, ok := module.(android.SdkContext); ok {
2743 if ctx.Device() {
2744 sdkDep := decodeSdkDep(ctx, sc)
2745 if !sdkDep.invalidVersion && sdkDep.useFiles {
2746 return RenameUseExclude, "useFiles"
Joe Onorato349ae8d2024-02-05 22:46:00 +00002747 }
2748 }
LaMont Jones63683e42024-02-08 14:30:45 -08002749 }
2750 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
2751 return RenameUseExclude, "tags"
2752 }
Jihoon Kang98e9ac62024-09-25 23:42:30 +00002753 if _, ok := android.OtherModuleProvider(ctx, m, SdkLibraryInfoProvider); ok {
LaMont Jones63683e42024-02-08 14:30:45 -08002754 switch tag {
2755 case sdkLibTag, libTag:
2756 return RenameUseExclude, "sdklibdep" // matches collectDeps()
2757 }
2758 return RenameUseInvalid, "sdklibdep" // dep is not used in collectDeps()
2759 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2760 switch ji.StubsLinkType {
2761 case Stubs:
2762 return RenameUseExclude, "info"
2763 case Implementation:
2764 return RenameUseInclude, "info"
2765 default:
LaMont Jones09721862024-06-11 10:30:50 -07002766 //fmt.Printf("collectDirectDepsProviders: %v -> %v StubsLinkType unknown\n", module, m)
LaMont Jones63683e42024-02-08 14:30:45 -08002767 // Fall through to the heuristic logic.
2768 }
2769 switch reflect.TypeOf(m).String() {
2770 case "*java.GeneratedJavaLibraryModule":
2771 // Probably a java_aconfig_library module.
2772 // TODO: make this check better.
2773 return RenameUseInclude, "reflect"
2774 }
2775 switch tag {
2776 case bootClasspathTag:
2777 return RenameUseExclude, "tagswitch"
2778 case sdkLibTag, libTag, instrumentationForTag:
2779 return RenameUseInclude, "tagswitch"
2780 case java9LibTag:
2781 return RenameUseExclude, "tagswitch"
2782 case staticLibTag:
2783 return RenameUseInclude, "tagswitch"
2784 case pluginTag:
2785 return RenameUseInclude, "tagswitch"
2786 case errorpronePluginTag:
2787 return RenameUseInclude, "tagswitch"
2788 case exportedPluginTag:
2789 return RenameUseInclude, "tagswitch"
LaMont Jones63683e42024-02-08 14:30:45 -08002790 case kotlinPluginTag:
2791 return RenameUseInclude, "tagswitch"
2792 default:
2793 return RenameUseExclude, "tagswitch"
2794 }
2795 } else if _, ok := m.(android.SourceFileProducer); ok {
2796 switch tag {
2797 case sdkLibTag, libTag, staticLibTag:
2798 return RenameUseInclude, "srcfile"
2799 default:
2800 return RenameUseExclude, "srcfile"
2801 }
Yu Liu67a28422024-03-05 00:36:31 +00002802 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kang03d014f2024-02-16 22:22:18 +00002803 return RenameUseInclude, "aconfig_declarations_group"
LaMont Jones63683e42024-02-08 14:30:45 -08002804 } else {
2805 switch tag {
2806 case bootClasspathTag:
2807 return RenameUseExclude, "else"
2808 case systemModulesTag:
2809 return RenameUseInclude, "else"
2810 }
2811 }
2812 // If we got here, choose the safer option, which may lead to a build failure, rather
2813 // than runtime failures on the device.
2814 return RenameUseExclude, "end"
2815 }
2816
2817 if result == nil {
2818 result = &JarJarProviderData{
2819 Rename: make(map[string]string),
2820 RenameUse: make([]RenameUseElement, 0),
2821 }
2822 }
2823 how, why := shouldIncludeRenames()
2824 result.RenameUse = append(result.RenameUse, RenameUseElement{DepName: m.Name(), RenameUse: how, Why: why})
2825 if how != RenameUseInclude {
2826 // Nothing to merge.
2827 return
2828 }
2829
2830 merge := func(theirs *JarJarProviderData) {
2831 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002832 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2833 result.Rename[orig] = renamed
2834 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2835 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2836 result.Rename[orig] = renamed
2837 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2838 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2839 continue
2840 }
2841 }
2842 }
2843 }
2844 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2845 merge(&theirs)
2846 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2847 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2848 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2849 // to java.Module.
2850 merge(&theirs.JarJarProviderData)
2851 }
2852 })
2853 return
2854}
2855
2856func (this Module) GetDebugString() string {
2857 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2858}
2859
2860// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2861// us, and if it's been set, apply the jarjar_prefix property to rename them.
2862func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2863 // Gather repackage information from deps
2864 result := collectDirectDepsProviders(ctx)
2865
Joe Onoratoa5d17172024-07-20 17:39:56 -07002866 add := func(orig string, renamed string) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002867 if result == nil {
2868 result = &JarJarProviderData{
2869 Rename: make(map[string]string),
2870 }
2871 }
2872 if renamed != "" {
2873 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2874 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
Joe Onoratoa5d17172024-07-20 17:39:56 -07002875 return
Joe Onorato349ae8d2024-02-05 22:46:00 +00002876 }
2877 }
2878 (*result).Rename[orig] = renamed
2879 }
2880
Joe Onoratoa5d17172024-07-20 17:39:56 -07002881 // Update that with entries we've stored for ourself
2882 for orig, renamed := range module.jarjarRenameRules {
2883 add(orig, renamed)
2884 }
2885
2886 // Update that with entries given in the jarjar_rename property.
2887 for _, orig := range module.properties.Jarjar_rename {
2888 add(orig, "")
2889 }
2890
Joe Onorato349ae8d2024-02-05 22:46:00 +00002891 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2892 if result == nil {
2893 return nil
2894 }
2895
2896 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2897 // that have not yet been renamed.
2898 prefix := proptools.String(module.properties.Jarjar_prefix)
2899 if prefix != "" {
2900 if prefix[0] == '.' {
2901 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2902 return nil
2903 }
2904 if prefix[len(prefix)-1] == '.' {
2905 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2906 return nil
2907 }
2908
2909 var updated map[string]string
2910 for orig, renamed := range (*result).Rename {
2911 if renamed == "" {
2912 if updated == nil {
2913 updated = make(map[string]string)
2914 }
2915 updated[orig] = prefix + "." + orig
2916 }
2917 }
2918 for orig, renamed := range updated {
2919 (*result).Rename[orig] = renamed
2920 }
2921 }
2922
2923 return result
2924}
2925
2926// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2927// to "" won't be in this list because they shouldn't be renamed yet.
2928func getJarJarRuleText(provider *JarJarProviderData) string {
2929 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002930 for _, orig := range android.SortedKeys(provider.Rename) {
2931 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002932 if renamed != "" {
2933 result += "rule " + orig + " " + renamed + "\n"
2934 }
2935 }
2936 return result
2937}
2938
Zi Wangddb2ee52024-04-02 16:44:02 +00002939// Repackage the flags if the jarjar rule txt for the flags is generated
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002940func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Zi Wangddb2ee52024-04-02 16:44:02 +00002941 if j.repackageJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002942 return infile, false
Zi Wangddb2ee52024-04-02 16:44:02 +00002943 }
Colin Crossedec77c2024-07-26 15:25:40 -07002944 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info, jarName)
Zi Wangddb2ee52024-04-02 16:44:02 +00002945 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002946 return repackagedJarjarFile, true
Zi Wangddb2ee52024-04-02 16:44:02 +00002947}
2948
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002949func (j *Module) jarjarIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Colin Crossedec77c2024-07-26 15:25:40 -07002950 if j.expandJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002951 return infile, false
Colin Crossedec77c2024-07-26 15:25:40 -07002952 }
2953 jarjarFile := android.PathForModuleOut(ctx, "jarjar", info, jarName)
2954 TransformJarJar(ctx, jarjarFile, infile, j.expandJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002955 return jarjarFile, true
Colin Crossedec77c2024-07-26 15:25:40 -07002956
2957}
2958
Jaewoong Jung26342642021-03-17 15:56:23 -07002959func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2960 deps.processorPath = append(deps.processorPath, pluginJars...)
2961 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2962}
2963
2964// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2965// this interface.
2966type ProvidesUsesLib interface {
2967 ProvidesUsesLib() *string
2968}
2969
2970func (j *Module) ProvidesUsesLib() *string {
2971 return j.usesLibraryProperties.Provides_uses_lib
2972}
satayev1c564cc2021-05-25 19:50:30 +01002973
2974type ModuleWithStem interface {
2975 Stem() string
2976}
2977
2978var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00002979
2980type ModuleWithUsesLibrary interface {
2981 UsesLibrary() *usesLibrary
2982}
2983
2984func (j *Module) UsesLibrary() *usesLibrary {
2985 return &j.usesLibrary
2986}
2987
2988var _ ModuleWithUsesLibrary = (*Module)(nil)