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