1 /* 2 * Copyright (c) 2022, 2025, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. 8 * 9 * This code is distributed in the hope that it will be useful, but WITHOUT 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 12 * version 2 for more details (a copy is included in the LICENSE file that 13 * accompanied this code). 14 * 15 * You should have received a copy of the GNU General Public License version 16 * 2 along with this work; if not, write to the Free Software Foundation, 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 18 * 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 20 * or visit www.oracle.com if you need additional information or have any 21 * questions. 22 * 23 */ 24 25 #ifndef SHARE_CDS_CDS_GLOBALS_HPP 26 #define SHARE_CDS_CDS_GLOBALS_HPP 27 28 #include "runtime/globals_shared.hpp" 29 30 // 31 // Defines all globals flags used by CDS. 32 // 33 34 #define CDS_FLAGS(develop, \ 35 develop_pd, \ 36 product, \ 37 product_pd, \ 38 range, \ 39 constraint) \ 40 /* Shared spaces */ \ 41 \ 42 product(bool, VerifySharedSpaces, false, \ 43 "Verify integrity of shared spaces") \ 44 \ 45 product(bool, RecordDynamicDumpInfo, false, \ 46 "Record class info for jcmd VM.cds dynamic_dump") \ 47 \ 48 product(bool, AutoCreateSharedArchive, false, \ 49 "Create shared archive at exit if cds mapping failed") \ 50 \ 51 product(bool, PrintSharedArchiveAndExit, false, \ 52 "Print shared archive file contents") \ 53 \ 54 product(size_t, SharedBaseAddress, LP64_ONLY(32*G) \ 55 NOT_LP64(LINUX_ONLY(2*G) NOT_LINUX(0)), \ 56 "Address to allocate shared memory region for class data") \ 57 range(0, SIZE_MAX) \ 58 \ 59 product(ccstr, SharedArchiveConfigFile, nullptr, \ 60 "Data to add to the CDS archive file") \ 61 \ 62 product(uint, SharedSymbolTableBucketSize, 4, \ 63 "Average number of symbols per bucket in shared table") \ 64 range(2, 246) \ 65 \ 66 product(bool, AllowArchivingWithJavaAgent, false, DIAGNOSTIC, \ 67 "Allow Java agent to be run with CDS dumping") \ 68 \ 69 develop(ccstr, ArchiveHeapTestClass, nullptr, \ 70 "For JVM internal testing only. The static field named " \ 71 "\"archivedObjects\" of the specified class is stored in the " \ 72 "CDS archive heap") \ 73 \ 74 develop(ccstr, AOTInitTestClass, nullptr, \ 75 "For JVM internal testing only. The specified class is stored " \ 76 "in the initialized state in the AOT cache ") \ 77 \ 78 product(ccstr, DumpLoadedClassList, nullptr, \ 79 "Dump the names all loaded classes, that could be stored into " \ 80 "the CDS archive, in the specified file") \ 81 \ 82 product(ccstr, SharedClassListFile, nullptr, \ 83 "Override the default CDS class list") \ 84 \ 85 product(ccstr, SharedArchiveFile, nullptr, \ 86 "Override the default location of the CDS archive file") \ 87 \ 88 product(ccstr, ArchiveClassesAtExit, nullptr, \ 89 "The path and name of the dynamic archive file") \ 90 \ 91 product(ccstr, ExtraSharedClassListFile, nullptr, \ 92 "Extra classlist for building the CDS archive file") \ 93 \ 94 /*FIXME - AOT code has direct pointers to metadata that's not relocated*/ \ 95 product(int, ArchiveRelocationMode, 0, DIAGNOSTIC, \ 96 "(0) first map at preferred address, and if " \ 97 "unsuccessful, map at alternative address; " \ 98 "(1) always map at alternative address (default); " \ 99 "(2) always map at preferred address, and if unsuccessful, " \ 100 "do not map the archive") \ 101 range(0, 2) \ 102 \ 103 /*========== New "AOT" flags =========================================*/ \ 104 /* The following 3 flags are aliases of -Xshare:dump, */ \ 105 /* -XX:SharedArchiveFile=..., etc. See CDSConfig::check_flag_aliases()*/ \ 106 \ 107 product(ccstr, AOTMode, nullptr, \ 108 "Specifies how AOTCache should be created or used. Valid values " \ 109 "are: off, record, create, auto, on; the default is auto") \ 110 constraint(AOTModeConstraintFunc, AtParse) \ 111 \ 112 product(ccstr, AOTConfiguration, nullptr, \ 113 "The configuration file written by -XX:AOTMode=record, and " \ 114 "loaded by -XX:AOTMode=create. This file contains profiling data "\ 115 "for deciding what contents should be added to AOTCache. ") \ 116 \ 117 product(ccstr, AOTCache, nullptr, \ 118 "Cache for improving start up and warm up") \ 119 \ 120 product(ccstr, AOTCacheOutput, nullptr, \ 121 "Write AOT cache into this file (overrides AOTCache when " \ 122 "writing)") \ 123 \ 124 product(bool, AOTInvokeDynamicLinking, false, DIAGNOSTIC, \ 125 "AOT-link JVM_CONSTANT_InvokeDynamic entries in cached " \ 126 "ConstantPools") \ 127 \ 128 product(bool, AOTClassLinking, false, \ 129 "Load/link all archived classes for the boot/platform/app " \ 130 "loaders before application main") \ 131 \ 132 product(bool, AOTCacheParallelRelocation, true, DIAGNOSTIC, \ 133 "Use parallel relocation code to speed up startup.") \ 134 \ 135 /* flags to control training and deployment modes */ \ 136 \ 137 product(bool, AOTRecordTraining, false, DIAGNOSTIC, \ 138 "Request output of training data for improved deployment.") \ 139 \ 140 product(bool, AOTReplayTraining, false, DIAGNOSTIC, \ 141 "Read training data, if available, for use in this execution") \ 142 \ 143 product(bool, AOTPrintTrainingInfo, false, DIAGNOSTIC, \ 144 "Print additional information about training") \ 145 \ 146 product(bool, AOTVerifyTrainingData, trueInDebug, DIAGNOSTIC, \ 147 "Verify archived training data") \ 148 \ 149 product(bool, AOTRecordOptCompilationOrder, false, \ 150 "Record c2/jvmci nmethod temperature to guide compilation order.")\ 151 \ 152 product(bool, AOTRecordOnlyTopCompilations, false, \ 153 "Record only top compilations (non-zero counts)") \ 154 \ 155 product(int, AOTRecordOptCompilationOrderInterval, 10, \ 156 "Sampling interval for RecordOptCompilationOrder") \ 157 \ 158 /* Recompilation flags */ \ 159 \ 160 product(int, AOTRecompilationLoadAverageThreshold, 5, \ 161 "Queues load avergage after while recompilations are allowed") \ 162 \ 163 product(int, AOTRecompilationWorkUnitSize, 5, \ 164 "Queues load avergage after while recompilations are allowed") \ 165 \ 166 product(bool, AOTRecompilation, false, \ 167 "Recompile methods for peak performance") \ 168 \ 169 product(bool, AOTForceRecompilation, false, \ 170 "Testing mode for recompilation") \ 171 \ 172 product(double, AOTDelayRecompilation, 0.0, \ 173 "Delay recompilation for given number of seconds") \ 174 \ 175 /*========== New options added by Leyden =============================*/ \ 176 \ 177 product(ccstrlist, AOTEndTrainingOnMethodEntry, "", \ 178 "List of methods (pkg/class.name) to trigger end of AOT " \ 179 "training run. Optional ',count=N' where N is > 0") \ 180 \ 181 product(ccstr, CacheOnlyClassesIn, nullptr, \ 182 "If set, only classes loaded from these JAR files will be " \ 183 "stored in the AOTCache") \ 184 \ 185 product(ccstr, CacheDataStore, nullptr, \ 186 "If valid, use the specified file for SharedArchiveFile; " \ 187 "otherwise the specified file is generated at program exit") \ 188 \ 189 product(ccstr, CDSPreimage, nullptr, \ 190 "(** internal use only **) -- used by a child JVM process to " \ 191 "create the CacheDataStore final image") \ 192 \ 193 product(bool, CDSManualFinalImage, false, DIAGNOSTIC, \ 194 "(** internal use only **) -- if false, automatically launch a " \ 195 "child process to create the final image.") \ 196 \ 197 product(bool, ArchiveDynamicProxies, false, \ 198 "Archive classes generated for java/lang/reflect/Proxy") \ 199 \ 200 product(bool, ArchiveLoaderLookupCache, false, \ 201 "Archive app loader's positive and negative lookup cache") \ 202 \ 203 product(bool, ArchivePackages, false, \ 204 "Archive the java.lang.ClassLoader::{packages,package2certs} " \ 205 "tables") \ 206 \ 207 product(bool, ArchiveProtectionDomains, false, \ 208 "Archive the java.security.SecureClassLoader::pdcache table") \ 209 \ 210 product(bool, ArchiveReflectionData, false, \ 211 "Archive Class::reflectionData field") \ 212 \ 213 product(bool, SkipArchiveHeapVerification, false, \ 214 "Skip verification of CDS archive heap") \ 215 \ 216 product(bool, ArchiveAdapters, false, \ 217 "Archive AdapterFingerPrint and AdapterHandlerEntry." \ 218 "Requires AOT code cache") \ 219 220 // end of CDS_FLAGS 221 222 DECLARE_FLAGS(CDS_FLAGS) 223 224 #endif // SHARE_CDS_CDS_GLOBALS_HPP