xref: /aosp_15_r20/build/soong/java/config/config.go (revision 333d2b3687b3a337dbcca9d65000bca186795e39)
1// Copyright 2017 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 config
16
17import (
18	"path/filepath"
19	"runtime"
20	"strings"
21
22	_ "github.com/google/blueprint/bootstrap"
23
24	"android/soong/android"
25	"android/soong/remoteexec"
26)
27
28var (
29	pctx = android.NewPackageContext("android/soong/java/config")
30
31	LegacyCorePlatformBootclasspathLibraries = []string{"legacy.core.platform.api.stubs", "core-lambda-stubs"}
32	LegacyCorePlatformSystemModules          = "legacy-core-platform-api-stubs-system-modules"
33	StableCorePlatformBootclasspathLibraries = []string{"stable.core.platform.api.stubs", "core-lambda-stubs"}
34	StableCorePlatformSystemModules          = "stable-core-platform-api-stubs-system-modules"
35	FrameworkLibraries                       = []string{"ext", "framework"}
36	DefaultLambdaStubsLibrary                = "core-lambda-stubs"
37	SdkLambdaStubsPath                       = "prebuilts/sdk/tools/core-lambda-stubs.jar"
38
39	DefaultMakeJacocoExcludeFilter = []string{"org.junit.*", "org.jacoco.*", "org.mockito.*"}
40	DefaultJacocoExcludeFilter     = []string{"org.junit.**", "org.jacoco.**", "org.mockito.**"}
41
42	InstrumentFrameworkModules = []string{
43		"framework",
44		"framework-minus-apex",
45		"ims-common",
46		"telephony-common",
47		"services",
48		"android.car",
49		"android.car7",
50		"android.car.builtin.impl",
51		"conscrypt",
52		"core-icu4j",
53		"core-oj",
54		"core-libart",
55		"wear-sdk.impl",
56	}
57)
58
59var (
60	JavacVmFlags    = strings.Join(javacVmFlagsList, " ")
61	javaVmFlagsList = []string{
62		`-XX:OnError="cat hs_err_pid%p.log"`,
63		"-XX:CICompilerCount=6",
64		"-XX:+UseDynamicNumberOfGCThreads",
65	}
66	javacVmFlagsList = []string{
67		`-J-XX:OnError="cat hs_err_pid%p.log"`,
68		"-J-XX:CICompilerCount=6",
69		"-J-XX:+UseDynamicNumberOfGCThreads",
70		"-J-XX:+TieredCompilation",
71		"-J-XX:TieredStopAtLevel=1",
72	}
73	dexerJavaVmFlagsList = []string{
74		`-JXX:OnError="cat hs_err_pid%p.log"`,
75		"-JXX:CICompilerCount=6",
76		"-JXX:+UseDynamicNumberOfGCThreads",
77	}
78)
79
80func init() {
81	pctx.Import("github.com/google/blueprint/bootstrap")
82
83	pctx.StaticVariable("JavacHeapSize", "4096M")
84	pctx.StaticVariable("JavacHeapFlags", "-J-Xmx${JavacHeapSize}")
85
86	// ErrorProne can use significantly more memory than javac alone, give it a higher heap
87	// size (b/221480398).
88	pctx.StaticVariable("ErrorProneHeapSize", "8192M")
89	pctx.StaticVariable("ErrorProneHeapFlags", "-J-Xmx${ErrorProneHeapSize}")
90
91	// D8 invocations are shorter lived, so we restrict their JIT tiering relative to R8.
92	// Note that the `-JXX` prefix syntax is specific to the R8/D8 invocation wrappers.
93	pctx.StaticVariable("D8Flags", strings.Join(append([]string{
94		"-JXmx4096M",
95		"-JXX:+TieredCompilation",
96		"-JXX:TieredStopAtLevel=1",
97		"-JDcom.android.tools.r8.emitRecordAnnotationsInDex",
98		"-JDcom.android.tools.r8.emitPermittedSubclassesAnnotationsInDex",
99	}, dexerJavaVmFlagsList...), " "))
100
101	pctx.VariableFunc("R8Flags", func(ctx android.PackageVarContext) string {
102		r8flags := append([]string{
103			"-JXmx4096M",
104			"-JDcom.android.tools.r8.emitRecordAnnotationsInDex",
105			"-JDcom.android.tools.r8.emitPermittedSubclassesAnnotationsInDex",
106		}, dexerJavaVmFlagsList...)
107		if r8DumpDir := ctx.Config().Getenv("R8_DUMP_DIRECTORY"); r8DumpDir != "" {
108			r8flags = append(r8flags, "-JDcom.android.tools.r8.dumpinputtodirectory="+r8DumpDir)
109		}
110		return strings.Join(r8flags, " ")
111
112	})
113
114	pctx.StaticVariable("CommonJdkFlags", strings.Join([]string{
115		`-Xmaxerrs 9999999`,
116		`-encoding UTF-8`,
117		`-sourcepath ""`,
118		`-g`,
119		// Turbine leaves out bridges which can cause javac to unnecessarily insert them into
120		// subclasses (b/65645120).  Setting this flag causes our custom javac to assume that
121		// the missing bridges will exist at runtime and not recreate them in subclasses.
122		// If a different javac is used the flag will be ignored and extra bridges will be inserted.
123		// The flag is implemented by https://android-review.googlesource.com/c/486427
124		`-XDskipDuplicateBridges=true`,
125
126		// b/65004097: prevent using java.lang.invoke.StringConcatFactory when using -target 1.9
127		`-XDstringConcat=inline`,
128	}, " "))
129
130	pctx.StaticVariable("JavaVmFlags", strings.Join(javaVmFlagsList, " "))
131	pctx.StaticVariable("JavacVmFlags", strings.Join(javacVmFlagsList, " "))
132
133	pctx.VariableConfigMethod("hostPrebuiltTag", android.Config.PrebuiltOS)
134
135	pctx.VariableFunc("JavaHome", func(ctx android.PackageVarContext) string {
136		// This is set up and guaranteed by soong_ui
137		return ctx.Config().Getenv("ANDROID_JAVA_HOME")
138	})
139	pctx.VariableFunc("JlinkVersion", func(ctx android.PackageVarContext) string {
140		if override := ctx.Config().Getenv("OVERRIDE_JLINK_VERSION_NUMBER"); override != "" {
141			return override
142		}
143		return "21"
144	})
145
146	pctx.SourcePathVariable("JavaToolchain", "${JavaHome}/bin")
147	pctx.SourcePathVariableWithEnvOverride("JavacCmd",
148		"${JavaToolchain}/javac", "ALTERNATE_JAVAC")
149	pctx.SourcePathVariable("JavaCmd", "${JavaToolchain}/java")
150	pctx.SourcePathVariable("JarCmd", "${JavaToolchain}/jar")
151	pctx.SourcePathVariable("JavadocCmd", "${JavaToolchain}/javadoc")
152	pctx.SourcePathVariable("JlinkCmd", "${JavaToolchain}/jlink")
153	pctx.SourcePathVariable("JmodCmd", "${JavaToolchain}/jmod")
154	pctx.SourcePathVariable("JrtFsJar", "${JavaHome}/lib/jrt-fs.jar")
155	pctx.SourcePathVariable("JavaKytheExtractorJar", "prebuilts/build-tools/common/framework/javac_extractor.jar")
156	pctx.SourcePathVariable("KotlinKytheExtractor", "prebuilts/build-tools/${hostPrebuiltTag}/bin/kotlinc_extractor")
157	pctx.SourcePathVariable("Ziptime", "prebuilts/build-tools/${hostPrebuiltTag}/bin/ziptime")
158
159	pctx.SourcePathVariable("ResourceProcessorBusyBox", "prebuilts/bazel/common/android_tools/android_tools/all_android_tools_deploy.jar")
160
161	pctx.HostBinToolVariable("GenKotlinBuildFileCmd", "gen-kotlin-build-file")
162
163	pctx.SourcePathVariable("JarArgsCmd", "build/soong/scripts/jar-args.sh")
164	pctx.SourcePathVariable("PackageCheckCmd", "build/soong/scripts/package-check.sh")
165	pctx.HostBinToolVariable("ExtractJarPackagesCmd", "extract_jar_packages")
166	pctx.HostBinToolVariable("SoongZipCmd", "soong_zip")
167	pctx.HostBinToolVariable("MergeZipsCmd", "merge_zips")
168	pctx.HostBinToolVariable("Zip2ZipCmd", "zip2zip")
169	pctx.HostBinToolVariable("ZipSyncCmd", "zipsync")
170	pctx.HostBinToolVariable("ApiCheckCmd", "apicheck")
171	pctx.HostBinToolVariable("D8Cmd", "d8")
172	pctx.HostBinToolVariable("R8Cmd", "r8")
173	pctx.HostBinToolVariable("ResourceShrinkerCmd", "resourceshrinker")
174	pctx.HostBinToolVariable("HiddenAPICmd", "hiddenapi")
175	pctx.HostBinToolVariable("ExtractApksCmd", "extract_apks")
176	pctx.VariableFunc("TurbineJar", func(ctx android.PackageVarContext) string {
177		turbine := "turbine.jar"
178		if ctx.Config().AlwaysUsePrebuiltSdks() {
179			return "prebuilts/build-tools/common/framework/" + turbine
180		} else {
181			return ctx.Config().HostJavaToolPath(ctx, turbine).String()
182		}
183	})
184
185	pctx.HostJavaToolVariable("JarjarCmd", "jarjar.jar")
186	pctx.HostJavaToolVariable("JsilverJar", "jsilver.jar")
187	pctx.HostJavaToolVariable("DoclavaJar", "doclava.jar")
188	pctx.HostJavaToolVariable("MetalavaJar", "metalava.jar")
189	pctx.HostJavaToolVariable("DokkaJar", "dokka.jar")
190	pctx.HostJavaToolVariable("JetifierJar", "jetifier.jar")
191	pctx.HostJavaToolVariable("R8Jar", "r8.jar")
192	pctx.HostJavaToolVariable("D8Jar", "d8.jar")
193
194	pctx.HostBinToolVariable("SoongJavacWrapper", "soong_javac_wrapper")
195	pctx.HostBinToolVariable("DexpreoptGen", "dexpreopt_gen")
196
197	pctx.StaticVariableWithEnvOverride("REJavaPool", "RBE_JAVA_POOL", "java16")
198	pctx.StaticVariableWithEnvOverride("REJavacExecStrategy", "RBE_JAVAC_EXEC_STRATEGY", remoteexec.RemoteLocalFallbackExecStrategy)
199	pctx.StaticVariableWithEnvOverride("RED8ExecStrategy", "RBE_D8_EXEC_STRATEGY", remoteexec.RemoteLocalFallbackExecStrategy)
200	pctx.StaticVariableWithEnvOverride("RER8ExecStrategy", "RBE_R8_EXEC_STRATEGY", remoteexec.RemoteLocalFallbackExecStrategy)
201	pctx.StaticVariableWithEnvOverride("RETurbineExecStrategy", "RBE_TURBINE_EXEC_STRATEGY", remoteexec.LocalExecStrategy)
202	pctx.StaticVariableWithEnvOverride("RESignApkExecStrategy", "RBE_SIGNAPK_EXEC_STRATEGY", remoteexec.LocalExecStrategy)
203	pctx.StaticVariableWithEnvOverride("REJarExecStrategy", "RBE_JAR_EXEC_STRATEGY", remoteexec.LocalExecStrategy)
204	pctx.StaticVariableWithEnvOverride("REZipExecStrategy", "RBE_ZIP_EXEC_STRATEGY", remoteexec.LocalExecStrategy)
205
206	pctx.HostJavaToolVariable("JacocoCLIJar", "jacoco-cli.jar")
207
208	pctx.HostBinToolVariable("ManifestCheckCmd", "manifest_check")
209	pctx.HostBinToolVariable("ManifestFixerCmd", "manifest_fixer")
210
211	pctx.HostBinToolVariable("ManifestMergerCmd", "manifest-merger")
212
213	pctx.HostBinToolVariable("Class2NonSdkList", "class2nonsdklist")
214	pctx.HostBinToolVariable("MergeCsvCommand", "merge_csv")
215	pctx.HostBinToolVariable("HiddenAPI", "hiddenapi")
216
217	hostBinToolVariableWithSdkToolsPrebuilt("Aapt2Cmd", "aapt2")
218	hostBinToolVariableWithBuildToolsPrebuilt("AidlCmd", "aidl")
219	hostBinToolVariableWithBuildToolsPrebuilt("ZipAlign", "zipalign")
220
221	hostJavaToolVariableWithSdkToolsPrebuilt("SignapkCmd", "signapk")
222	// TODO(ccross): this should come from the signapk dependencies, but we don't have any way
223	// to express host JNI dependencies yet.
224	hostJNIToolVariableWithSdkToolsPrebuilt("SignapkJniLibrary", "libconscrypt_openjdk_jni")
225}
226
227func hostBinToolVariableWithSdkToolsPrebuilt(name, tool string) {
228	pctx.VariableFunc(name, func(ctx android.PackageVarContext) string {
229		if ctx.Config().AlwaysUsePrebuiltSdks() {
230			return filepath.Join("prebuilts/sdk/tools", runtime.GOOS, "bin", tool)
231		} else {
232			return ctx.Config().HostToolPath(ctx, tool).String()
233		}
234	})
235}
236
237func hostJavaToolVariableWithSdkToolsPrebuilt(name, tool string) {
238	pctx.VariableFunc(name, func(ctx android.PackageVarContext) string {
239		if ctx.Config().AlwaysUsePrebuiltSdks() {
240			return filepath.Join("prebuilts/sdk/tools/lib", tool+".jar")
241		} else {
242			return ctx.Config().HostJavaToolPath(ctx, tool+".jar").String()
243		}
244	})
245}
246
247func hostJNIToolVariableWithSdkToolsPrebuilt(name, tool string) {
248	pctx.VariableFunc(name, func(ctx android.PackageVarContext) string {
249		if ctx.Config().AlwaysUsePrebuiltSdks() {
250			ext := ".so"
251			if runtime.GOOS == "darwin" {
252				ext = ".dylib"
253			}
254			return filepath.Join("prebuilts/sdk/tools", runtime.GOOS, "lib64", tool+ext)
255		} else {
256			return ctx.Config().HostJNIToolPath(ctx, tool).String()
257		}
258	})
259}
260
261func hostBinToolVariableWithBuildToolsPrebuilt(name, tool string) {
262	pctx.VariableFunc(name, func(ctx android.PackageVarContext) string {
263		if ctx.Config().AlwaysUsePrebuiltSdks() {
264			return filepath.Join("prebuilts/build-tools", ctx.Config().PrebuiltOS(), "bin", tool)
265		} else {
266			return ctx.Config().HostToolPath(ctx, tool).String()
267		}
268	})
269}
270
271// JavaCmd returns a SourcePath object with the path to the java command.
272func JavaCmd(ctx android.PathContext) android.SourcePath {
273	return javaTool(ctx, "java")
274}
275
276// JavadocCmd returns a SourcePath object with the path to the java command.
277func JavadocCmd(ctx android.PathContext) android.SourcePath {
278	return javaTool(ctx, "javadoc")
279}
280
281func javaTool(ctx android.PathContext, tool string) android.SourcePath {
282	type javaToolKey string
283
284	key := android.NewCustomOnceKey(javaToolKey(tool))
285
286	return ctx.Config().OnceSourcePath(key, func() android.SourcePath {
287		return javaToolchain(ctx).Join(ctx, tool)
288	})
289
290}
291
292var javaToolchainKey = android.NewOnceKey("javaToolchain")
293
294func javaToolchain(ctx android.PathContext) android.SourcePath {
295	return ctx.Config().OnceSourcePath(javaToolchainKey, func() android.SourcePath {
296		return javaHome(ctx).Join(ctx, "bin")
297	})
298}
299
300var javaHomeKey = android.NewOnceKey("javaHome")
301
302func javaHome(ctx android.PathContext) android.SourcePath {
303	return ctx.Config().OnceSourcePath(javaHomeKey, func() android.SourcePath {
304		// This is set up and guaranteed by soong_ui
305		return android.PathForSource(ctx, ctx.Config().Getenv("ANDROID_JAVA_HOME"))
306	})
307}
308