1 /* 2 * Copyright (c) 1997, 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_RUNTIME_ARGUMENTS_HPP 26 #define SHARE_RUNTIME_ARGUMENTS_HPP 27 28 #include "logging/logLevel.hpp" 29 #include "logging/logTag.hpp" 30 #include "memory/allStatic.hpp" 31 #include "memory/allocation.hpp" 32 #include "runtime/globals.hpp" 33 #include "runtime/java.hpp" 34 #include "runtime/os.hpp" 35 #include "utilities/debug.hpp" 36 #include "utilities/vmEnums.hpp" 37 38 // Arguments parses the command line and recognizes options 39 40 class JVMFlag; 41 42 // Invocation API hook typedefs (these should really be defined in jni.h) 43 extern "C" { 44 typedef void (JNICALL *abort_hook_t)(void); 45 typedef void (JNICALL *exit_hook_t)(jint code); 46 typedef jint (JNICALL *vfprintf_hook_t)(FILE *fp, const char *format, va_list args) ATTRIBUTE_PRINTF(2, 0); 47 } 48 49 // Obsolete or deprecated -XX flag. 50 struct SpecialFlag { 51 const char* name; 52 JDK_Version deprecated_in; // When the deprecation warning started (or "undefined"). 53 JDK_Version obsolete_in; // When the obsolete warning started (or "undefined"). 54 JDK_Version expired_in; // When the option expires (or "undefined"). 55 }; 56 57 struct LegacyGCLogging { 58 const char* file; // null -> stdout 59 int lastFlag; // 0 not set; 1 -> -verbose:gc; 2 -> -Xloggc 60 }; 61 62 // PathString is used as: 63 // - the underlying value for a SystemProperty 64 // - the path portion of an --patch-module module/path pair 65 // - the string that represents the boot class path, Arguments::_boot_class_path. 66 class PathString : public CHeapObj<mtArguments> { 67 protected: 68 char* _value; 69 public: 70 char* value() const { return _value; } 71 72 // return false iff OOM && alloc_failmode == AllocFailStrategy::RETURN_NULL 73 bool set_value(const char *value, AllocFailType alloc_failmode = AllocFailStrategy::EXIT_OOM); 74 void append_value(const char *value); 75 76 PathString(const char* value); 77 ~PathString(); 78 79 // for JVM_ReadSystemPropertiesInfo 80 static int value_offset_in_bytes() { return (int)offset_of(PathString, _value); } 81 }; 82 83 // ModulePatchPath records the module/path pair as specified to --patch-module. 84 class ModulePatchPath : public CHeapObj<mtInternal> { 85 private: 86 char* _module_name; 87 PathString* _path; 88 public: 89 ModulePatchPath(const char* module_name, const char* path); 90 ~ModulePatchPath(); 91 92 inline const char* module_name() const { return _module_name; } 93 inline char* path_string() const { return _path->value(); } 94 inline void append_path(const char* path) { _path->append_value(path); } 95 }; 96 97 // Element describing System and User (-Dkey=value flags) defined property. 98 // 99 // An internal SystemProperty is one that has been removed in 100 // jdk.internal.VM.saveAndRemoveProperties, like jdk.boot.class.path.append. 101 // 102 class SystemProperty : public PathString { 103 private: 104 char* _key; 105 SystemProperty* _next; 106 bool _internal; 107 bool _writeable; 108 109 public: 110 // Accessors 111 char* value() const { return PathString::value(); } 112 const char* key() const { return _key; } 113 bool internal() const { return _internal; } 114 SystemProperty* next() const { return _next; } 115 void set_next(SystemProperty* next) { _next = next; } 116 bool writeable() const { return _writeable; } 117 118 bool readable() const { 119 return !_internal || (strcmp(_key, "jdk.boot.class.path.append") == 0 && 120 value() != nullptr); 121 } 122 123 // A system property should only have its value set 124 // via an external interface if it is a writeable property. 125 // The internal, non-writeable property jdk.boot.class.path.append 126 // is the only exception to this rule. It can be set externally 127 // via -Xbootclasspath/a or JVMTI OnLoad phase call to AddToBootstrapClassLoaderSearch. 128 // In those cases for jdk.boot.class.path.append, the base class 129 // set_value and append_value methods are called directly. 130 void set_writeable_value(const char *value) { 131 if (writeable()) { 132 set_value(value); 133 } 134 } 135 void append_writeable_value(const char *value) { 136 if (writeable()) { 137 append_value(value); 138 } 139 } 140 141 // Constructor 142 SystemProperty(const char* key, const char* value, bool writeable, bool internal = false); 143 144 // for JVM_ReadSystemPropertiesInfo 145 static int key_offset_in_bytes() { return (int)offset_of(SystemProperty, _key); } 146 static int next_offset_in_bytes() { return (int)offset_of(SystemProperty, _next); } 147 }; 148 149 // Helper class for controlling the lifetime of JavaVMInitArgs objects. 150 class ScopedVMInitArgs; 151 152 class Arguments : AllStatic { 153 friend class VMStructs; 154 friend class JvmtiExport; 155 friend class ArgumentsTest; 156 friend class LargeOptionsTest; 157 public: 158 // Operation modi 159 enum Mode { 160 _int, // corresponds to -Xint 161 _mixed, // corresponds to -Xmixed 162 _comp // corresponds to -Xcomp 163 }; 164 165 enum ArgsRange { 166 arg_unreadable = -3, 167 arg_too_small = -2, 168 arg_too_big = -1, 169 arg_in_range = 0 170 }; 171 172 enum PropertyAppendable { 173 AppendProperty, 174 AddProperty 175 }; 176 177 enum PropertyWriteable { 178 WriteableProperty, 179 UnwriteableProperty 180 }; 181 182 enum PropertyInternal { 183 InternalProperty, 184 ExternalProperty 185 }; 186 187 private: 188 189 // a pointer to the flags file name if it is specified 190 static char* _jvm_flags_file; 191 // an array containing all flags specified in the .hotspotrc file 192 static char** _jvm_flags_array; 193 static int _num_jvm_flags; 194 // an array containing all jvm arguments specified in the command line 195 static char** _jvm_args_array; 196 static int _num_jvm_args; 197 // string containing all java command (class/jarfile name and app args) 198 static char* _java_command; 199 // number of unique modules specified in the --add-modules option 200 static unsigned int _addmods_count; 201 202 // Property list 203 static SystemProperty* _system_properties; 204 205 // Quick accessor to System properties in the list: 206 static SystemProperty *_sun_boot_library_path; 207 static SystemProperty *_java_library_path; 208 static SystemProperty *_java_home; 209 static SystemProperty *_java_class_path; 210 static SystemProperty *_jdk_boot_class_path_append; 211 static SystemProperty *_vm_info; 212 213 // --patch-module=module=<file>(<pathsep><file>)* 214 // Each element contains the associated module name, path 215 // string pair as specified to --patch-module. 216 static GrowableArray<ModulePatchPath*>* _patch_mod_prefix; 217 218 // The constructed value of the system class path after 219 // argument processing and JVMTI OnLoad additions via 220 // calls to AddToBootstrapClassLoaderSearch. This is the 221 // final form before ClassLoader::setup_bootstrap_search(). 222 // Note: since --patch-module is a module name/path pair, the 223 // boot class path string no longer contains the "prefix" 224 // to the boot class path base piece as it did when 225 // -Xbootclasspath/p was supported. 226 static PathString* _boot_class_path; 227 228 // Set if a modular java runtime image is present vs. a build with exploded modules 229 static bool _has_jimage; 230 231 // temporary: to emit warning if the default ext dirs are not empty. 232 // remove this variable when the warning is no longer needed. 233 static char* _ext_dirs; 234 235 // java.vendor.url.bug, bug reporting URL for fatal errors. 236 static const char* _java_vendor_url_bug; 237 238 // sun.java.launcher, private property to provide information about 239 // java launcher 240 static const char* _sun_java_launcher; 241 242 // was this VM created via the -XXaltjvm=<path> option 243 static bool _sun_java_launcher_is_altjvm; 244 245 // for legacy gc options (-verbose:gc and -Xloggc:) 246 static LegacyGCLogging _legacyGCLogging; 247 248 // Value of the conservative maximum heap alignment needed 249 static size_t _conservative_max_heap_alignment; 250 251 // Operation modi 252 static Mode _mode; 253 254 // preview features 255 static bool _enable_preview; 256 257 // jdwp 258 static bool _has_jdwp_agent; 259 260 // Used to save default settings 261 static bool _AlwaysCompileLoopMethods; 262 static bool _UseOnStackReplacement; 263 static bool _BackgroundCompilation; 264 static bool _ClipInlining; 265 266 // GC ergonomics 267 static void set_conservative_max_heap_alignment(); 268 static void set_use_compressed_oops(); 269 static jint set_ergonomics_flags(); 270 static void set_compact_headers_flags(); 271 // Limits the given heap size by the maximum amount of virtual 272 // memory this process is currently allowed to use. It also takes 273 // the virtual-to-physical ratio of the current GC into account. 274 static size_t limit_heap_by_allocatable_memory(size_t size); 275 // Setup heap size 276 static void set_heap_size(); 277 278 // Bytecode rewriting 279 static void set_bytecode_flags(); 280 281 // Invocation API hooks 282 static abort_hook_t _abort_hook; 283 static exit_hook_t _exit_hook; 284 static vfprintf_hook_t _vfprintf_hook; 285 286 // System properties 287 static bool add_property(const char* prop, PropertyWriteable writeable=WriteableProperty, 288 PropertyInternal internal=ExternalProperty); 289 290 // Used for module system related properties: converted from command-line flags. 291 // Basic properties are writeable as they operate as "last one wins" and will get overwritten. 292 // Numbered properties are never writeable, and always internal. 293 static bool create_module_property(const char* prop_name, const char* prop_value, PropertyInternal internal); 294 static bool create_numbered_module_property(const char* prop_base_name, const char* prop_value, unsigned int count); 295 296 static int process_patch_mod_option(const char* patch_mod_tail); 297 298 // Aggressive optimization flags. 299 static jint set_aggressive_opts_flags(); 300 301 static jint set_aggressive_heap_flags(); 302 303 // Argument parsing 304 static bool parse_argument(const char* arg, JVMFlagOrigin origin); 305 static bool process_argument(const char* arg, jboolean ignore_unrecognized, JVMFlagOrigin origin); 306 static void process_java_launcher_argument(const char*, void*); 307 static jint parse_options_environment_variable(const char* name, ScopedVMInitArgs* vm_args); 308 static jint parse_java_tool_options_environment_variable(ScopedVMInitArgs* vm_args); 309 static jint parse_java_options_environment_variable(ScopedVMInitArgs* vm_args); 310 static jint parse_vm_options_file(const char* file_name, ScopedVMInitArgs* vm_args); 311 static jint parse_options_buffer(const char* name, char* buffer, const size_t buf_len, ScopedVMInitArgs* vm_args); 312 static jint parse_xss(const JavaVMOption* option, const char* tail, intx* out_ThreadStackSize); 313 static jint insert_vm_options_file(const JavaVMInitArgs* args, 314 const char* vm_options_file, 315 const int vm_options_file_pos, 316 ScopedVMInitArgs* vm_options_file_args, 317 ScopedVMInitArgs* args_out); 318 static bool args_contains_vm_options_file_arg(const JavaVMInitArgs* args); 319 static jint expand_vm_options_as_needed(const JavaVMInitArgs* args_in, 320 ScopedVMInitArgs* mod_args, 321 JavaVMInitArgs** args_out); 322 static jint match_special_option_and_act(const JavaVMInitArgs* args, 323 ScopedVMInitArgs* args_out); 324 325 static bool handle_deprecated_print_gc_flags(); 326 327 static jint parse_vm_init_args(const JavaVMInitArgs *vm_options_args, 328 const JavaVMInitArgs *java_tool_options_args, 329 const JavaVMInitArgs *java_options_args, 330 const JavaVMInitArgs *cmd_line_args); 331 static jint parse_each_vm_init_arg(const JavaVMInitArgs* args, JVMFlagOrigin origin); 332 static jint finalize_vm_init_args(); 333 static bool is_bad_option(const JavaVMOption* option, jboolean ignore, const char* option_type); 334 335 static bool is_bad_option(const JavaVMOption* option, jboolean ignore) { 336 return is_bad_option(option, ignore, nullptr); 337 } 338 339 static void describe_range_error(ArgsRange errcode); 340 static ArgsRange check_memory_size(julong size, julong min_size, julong max_size); 341 static ArgsRange parse_memory_size(const char* s, julong* long_arg, 342 julong min_size, julong max_size = max_uintx); 343 344 // methods to build strings from individual args 345 static void build_jvm_args(const char* arg); 346 static void build_jvm_flags(const char* arg); 347 static void add_string(char*** bldarray, int* count, const char* arg); 348 static const char* build_resource_string(char** args, int count); 349 350 // Returns true if the flag is obsolete (and not yet expired). 351 // In this case the 'version' buffer is filled in with 352 // the version number when the flag became obsolete. 353 static bool is_obsolete_flag(const char* flag_name, JDK_Version* version); 354 355 // Returns 1 if the flag is deprecated (and not yet obsolete or expired). 356 // In this case the 'version' buffer is filled in with the version number when 357 // the flag became deprecated. 358 // Returns -1 if the flag is expired or obsolete. 359 // Returns 0 otherwise. 360 static int is_deprecated_flag(const char* flag_name, JDK_Version* version); 361 362 // Return the real name for the flag passed on the command line (either an alias name or "flag_name"). 363 static const char* real_flag_name(const char *flag_name); 364 static JVMFlag* find_jvm_flag(const char* name, size_t name_length); 365 366 // Return the "real" name for option arg if arg is an alias, and print a warning if arg is deprecated. 367 // Return nullptr if the arg has expired. 368 static const char* handle_aliases_and_deprecation(const char* arg); 369 static size_t _default_SharedBaseAddress; // The default value specified in globals.hpp 370 371 static bool internal_module_property_helper(const char* property, bool check_for_cds); 372 373 public: 374 // Parses the arguments, first phase 375 static jint parse(const JavaVMInitArgs* args); 376 // Parse a string for a unsigned integer. Returns true if value 377 // is an unsigned integer greater than or equal to the minimum 378 // parameter passed and returns the value in uint_arg. Returns 379 // false otherwise, with uint_arg undefined. 380 static bool parse_uint(const char* value, uint* uintx_arg, 381 uint min_size); 382 // Apply ergonomics 383 static jint apply_ergo(); 384 // Adjusts the arguments after the OS have adjusted the arguments 385 static jint adjust_after_os(); 386 387 // Check consistency or otherwise of VM argument settings 388 static bool check_vm_args_consistency(); 389 // Used by os_solaris 390 static bool process_settings_file(const char* file_name, bool should_exist, jboolean ignore_unrecognized); 391 392 static size_t conservative_max_heap_alignment() { return _conservative_max_heap_alignment; } 393 // Return the maximum size a heap with compressed oops can take 394 static size_t max_heap_for_compressed_oops(); 395 396 // return a char* array containing all options 397 static char** jvm_flags_array() { return _jvm_flags_array; } 398 static char** jvm_args_array() { return _jvm_args_array; } 399 static int num_jvm_flags() { return _num_jvm_flags; } 400 static int num_jvm_args() { return _num_jvm_args; } 401 // return the arguments passed to the Java application 402 static const char* java_command() { return _java_command; } 403 404 // print jvm_flags, jvm_args and java_command 405 static void print_on(outputStream* st); 406 static void print_summary_on(outputStream* st); 407 408 // convenient methods to get and set jvm_flags_file 409 static const char* get_jvm_flags_file() { return _jvm_flags_file; } 410 static void set_jvm_flags_file(const char *value) { 411 if (_jvm_flags_file != nullptr) { 412 os::free(_jvm_flags_file); 413 } 414 _jvm_flags_file = os::strdup_check_oom(value); 415 } 416 // convenient methods to obtain / print jvm_flags and jvm_args 417 static const char* jvm_flags() { return build_resource_string(_jvm_flags_array, _num_jvm_flags); } 418 static const char* jvm_args() { return build_resource_string(_jvm_args_array, _num_jvm_args); } 419 static void print_jvm_flags_on(outputStream* st); 420 static void print_jvm_args_on(outputStream* st); 421 422 // -Dkey=value flags 423 static SystemProperty* system_properties() { return _system_properties; } 424 static const char* get_property(const char* key); 425 426 // -Djava.vendor.url.bug 427 static const char* java_vendor_url_bug() { return _java_vendor_url_bug; } 428 429 // -Dsun.java.launcher 430 static const char* sun_java_launcher() { return _sun_java_launcher; } 431 // Was VM created by a Java launcher? 432 static bool created_by_java_launcher(); 433 // -Dsun.java.launcher.is_altjvm 434 static bool sun_java_launcher_is_altjvm(); 435 436 // abort, exit, vfprintf hooks 437 static abort_hook_t abort_hook() { return _abort_hook; } 438 static exit_hook_t exit_hook() { return _exit_hook; } 439 static vfprintf_hook_t vfprintf_hook() { return _vfprintf_hook; } 440 441 static void no_shared_spaces(const char* message); 442 static size_t default_SharedBaseAddress() { return _default_SharedBaseAddress; } 443 // Java launcher properties 444 static void process_sun_java_launcher_properties(JavaVMInitArgs* args); 445 446 // System properties 447 static void init_system_properties(); 448 449 // Update/Initialize System properties after JDK version number is known 450 static void init_version_specific_system_properties(); 451 452 // Update VM info property - called after argument parsing 453 static void update_vm_info_property(const char* vm_info) { 454 _vm_info->set_value(vm_info); 455 } 456 457 // Property List manipulation 458 static void PropertyList_add(SystemProperty *element); 459 static void PropertyList_add(SystemProperty** plist, SystemProperty *element); 460 static void PropertyList_add(SystemProperty** plist, const char* k, const char* v, bool writeable, bool internal); 461 462 static void PropertyList_unique_add(SystemProperty** plist, const char* k, const char* v, 463 PropertyAppendable append, PropertyWriteable writeable, 464 PropertyInternal internal); 465 static const char* PropertyList_get_value(SystemProperty* plist, const char* key); 466 static const char* PropertyList_get_readable_value(SystemProperty* plist, const char* key); 467 static int PropertyList_count(SystemProperty* pl); 468 static int PropertyList_readable_count(SystemProperty* pl); 469 470 static bool is_internal_module_property(const char* option); 471 static bool is_incompatible_cds_internal_module_property(const char* property); 472 473 // Miscellaneous System property value getter and setters. 474 static void set_dll_dir(const char *value) { _sun_boot_library_path->set_value(value); } 475 static void set_java_home(const char *value) { _java_home->set_value(value); } 476 static void set_library_path(const char *value) { _java_library_path->set_value(value); } 477 static void set_ext_dirs(char *value) { _ext_dirs = os::strdup_check_oom(value); } 478 479 // Set up the underlying pieces of the boot class path 480 static void add_patch_mod_prefix(const char *module_name, const char *path, bool allow_append, bool allow_cds); 481 static int finalize_patch_module(); 482 static void set_boot_class_path(const char *value, bool has_jimage) { 483 // During start up, set by os::set_boot_path() 484 assert(get_boot_class_path() == nullptr, "Boot class path previously set"); 485 _boot_class_path->set_value(value); 486 _has_jimage = has_jimage; 487 } 488 static void append_sysclasspath(const char *value) { 489 _boot_class_path->append_value(value); 490 _jdk_boot_class_path_append->append_value(value); 491 } 492 493 static GrowableArray<ModulePatchPath*>* get_patch_mod_prefix() { return _patch_mod_prefix; } 494 static char* get_boot_class_path() { return _boot_class_path->value(); } 495 static bool has_jimage() { return _has_jimage; } 496 497 static char* get_java_home() { return _java_home->value(); } 498 static char* get_dll_dir() { return _sun_boot_library_path->value(); } 499 static char* get_appclasspath() { return _java_class_path->value(); } 500 static void fix_appclasspath(); 501 502 // Operation modi 503 static Mode mode() { return _mode; } 504 static void set_mode_flags(Mode mode); 505 static bool is_interpreter_only() { return mode() == _int; } 506 static bool is_compiler_only() { return mode() == _comp; } 507 508 509 // preview features 510 static void set_enable_preview() { _enable_preview = true; } 511 static bool enable_preview() { return _enable_preview; } 512 513 // jdwp 514 static bool has_jdwp_agent() { return _has_jdwp_agent; } 515 516 // Utility: copies src into buf, replacing "%%" with "%" and "%p" with pid. 517 static bool copy_expand_pid(const char* src, size_t srclen, char* buf, size_t buflen); 518 519 static bool atojulong(const char *s, julong* result); 520 521 static bool has_jfr_option() NOT_JFR_RETURN_(false); 522 523 DEBUG_ONLY(static bool verify_special_jvm_flags(bool check_globals);) 524 }; 525 526 // Disable options not supported in this release, with a warning if they 527 // were explicitly requested on the command-line 528 #define UNSUPPORTED_OPTION(opt) \ 529 do { \ 530 if (opt) { \ 531 if (FLAG_IS_CMDLINE(opt)) { \ 532 warning("-XX:+" #opt " not supported in this VM"); \ 533 } \ 534 FLAG_SET_DEFAULT(opt, false); \ 535 } \ 536 } while(0) 537 538 // similar to UNSUPPORTED_OPTION but sets flag to nullptr 539 #define UNSUPPORTED_OPTION_NULL(opt) \ 540 do { \ 541 if (opt) { \ 542 if (FLAG_IS_CMDLINE(opt)) { \ 543 warning("-XX flag " #opt " not supported in this VM"); \ 544 } \ 545 FLAG_SET_DEFAULT(opt, nullptr); \ 546 } \ 547 } while(0) 548 549 // Initialize options not supported in this release, with a warning 550 // if they were explicitly requested on the command-line 551 #define UNSUPPORTED_OPTION_INIT(opt, value) \ 552 do { \ 553 if (FLAG_IS_CMDLINE(opt)) { \ 554 warning("-XX flag " #opt " not supported in this VM"); \ 555 } \ 556 FLAG_SET_DEFAULT(opt, value); \ 557 } while(0) 558 559 #endif // SHARE_RUNTIME_ARGUMENTS_HPP