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 struct VMInitArgsGroup;
153 template <typename E, MemTag MT> class GrowableArrayCHeap;
154
155 class Arguments : AllStatic {
156 friend class VMStructs;
157 friend class JvmtiExport;
158 friend class ArgumentsTest;
159 friend class LargeOptionsTest;
160 public:
161 // Operation modi
162 enum Mode {
163 _int, // corresponds to -Xint
164 _mixed, // corresponds to -Xmixed
165 _comp // corresponds to -Xcomp
166 };
167
168 enum ArgsRange {
169 arg_unreadable = -3,
170 arg_too_small = -2,
171 arg_too_big = -1,
172 arg_in_range = 0
173 };
174
175 enum PropertyAppendable {
176 AppendProperty,
177 AddProperty
178 };
179
180 enum PropertyWriteable {
181 WriteableProperty,
182 UnwriteableProperty
183 };
184
185 enum PropertyInternal {
186 InternalProperty,
187 ExternalProperty
188 };
189
190 private:
191
192 // a pointer to the flags file name if it is specified
193 static char* _jvm_flags_file;
194 // an array containing all flags specified in the .hotspotrc file
195 static char** _jvm_flags_array;
196 static int _num_jvm_flags;
197 // an array containing all jvm arguments specified in the command line
198 static char** _jvm_args_array;
199 static int _num_jvm_args;
200 // string containing all java command (class/jarfile name and app args)
201 static char* _java_command;
202 // number of unique modules specified in the --add-modules option
203 static unsigned int _addmods_count;
204 #if INCLUDE_JVMCI
205 // was jdk.internal.vm.ci module specified in the --add-modules option?
206 static bool _jvmci_module_added;
207 #endif
208
209 // Property list
210 static SystemProperty* _system_properties;
211
212 // Quick accessor to System properties in the list:
213 static SystemProperty *_sun_boot_library_path;
214 static SystemProperty *_java_library_path;
215 static SystemProperty *_java_home;
216 static SystemProperty *_java_class_path;
217 static SystemProperty *_jdk_boot_class_path_append;
218 static SystemProperty *_vm_info;
219
220 // --patch-module=module=<file>(<pathsep><file>)*
221 // Each element contains the associated module name, path
222 // string pair as specified to --patch-module.
223 static GrowableArray<ModulePatchPath*>* _patch_mod_prefix;
224
225 // The constructed value of the system class path after
226 // argument processing and JVMTI OnLoad additions via
227 // calls to AddToBootstrapClassLoaderSearch. This is the
228 // final form before ClassLoader::setup_bootstrap_search().
229 // Note: since --patch-module is a module name/path pair, the
230 // boot class path string no longer contains the "prefix"
231 // to the boot class path base piece as it did when
232 // -Xbootclasspath/p was supported.
233 static PathString* _boot_class_path;
234
235 // Set if a modular java runtime image is present vs. a build with exploded modules
236 static bool _has_jimage;
237
238 // temporary: to emit warning if the default ext dirs are not empty.
239 // remove this variable when the warning is no longer needed.
240 static char* _ext_dirs;
241
242 // java.vendor.url.bug, bug reporting URL for fatal errors.
243 static const char* _java_vendor_url_bug;
244
245 // sun.java.launcher, private property to provide information about
246 // java launcher
247 static const char* _sun_java_launcher;
248
249 // was this VM created with the -XX:+ExecutingUnitTests option
250 static bool _executing_unit_tests;
251
252 // for legacy gc options (-verbose:gc and -Xloggc:)
253 static LegacyGCLogging _legacyGCLogging;
254
255 // Value of the conservative maximum heap alignment needed
256 static size_t _conservative_max_heap_alignment;
257
258 // Operation modi
259 static Mode _mode;
260
261 // preview features
262 static bool _enable_preview;
263
264 // jdwp
265 static bool _has_jdwp_agent;
266
267 // Used to save default settings
268 static bool _AlwaysCompileLoopMethods;
269 static bool _UseOnStackReplacement;
270 static bool _BackgroundCompilation;
271 static bool _ClipInlining;
272
273 // GC ergonomics
274 static void set_conservative_max_heap_alignment();
275 static void set_use_compressed_oops();
276 static jint set_ergonomics_flags();
277 static void set_compact_headers_flags();
278 // Limits the given heap size by the maximum amount of virtual
279 // memory this process is currently allowed to use. It also takes
280 // the virtual-to-physical ratio of the current GC into account.
281 static size_t limit_heap_by_allocatable_memory(size_t size);
282 // Setup heap size
283 static void set_heap_size();
284
285 // Bytecode rewriting
286 static void set_bytecode_flags();
287
288 // Invocation API hooks
289 static abort_hook_t _abort_hook;
290 static exit_hook_t _exit_hook;
291 static vfprintf_hook_t _vfprintf_hook;
292
293 // System properties
294 static bool add_property(const char* prop, PropertyWriteable writeable=WriteableProperty,
295 PropertyInternal internal=ExternalProperty);
296
297 // Used for module system related properties: converted from command-line flags.
298 // Basic properties are writeable as they operate as "last one wins" and will get overwritten.
299 // Numbered properties are never writeable, and always internal.
300 static bool create_module_property(const char* prop_name, const char* prop_value, PropertyInternal internal);
301 static bool create_numbered_module_property(const char* prop_base_name, const char* prop_value, unsigned int count);
302
303 static int process_patch_mod_option(const char* patch_mod_tail);
304
305 // Aggressive optimization flags.
306 static jint set_aggressive_opts_flags();
307
308 static jint set_aggressive_heap_flags();
309
310 // Argument parsing
311 static bool parse_argument(const char* arg, JVMFlagOrigin origin);
312 static bool process_argument(const char* arg, jboolean ignore_unrecognized, JVMFlagOrigin origin);
313 static void process_java_launcher_argument(const char*, void*);
314 static jint parse_options_environment_variable(const char* name, ScopedVMInitArgs* vm_args);
315 static jint parse_java_tool_options_environment_variable(ScopedVMInitArgs* vm_args);
316 static jint parse_java_options_environment_variable(ScopedVMInitArgs* vm_args);
317 static jint parse_jdk_aot_vm_options_environment_variable(GrowableArrayCHeap<VMInitArgsGroup, mtArguments>* all_args,
318 ScopedVMInitArgs* jdk_aot_vm_options_args);
319 static jint parse_vm_options_file(const char* file_name, ScopedVMInitArgs* vm_args);
320 static jint parse_options_buffer(const char* name, char* buffer, const size_t buf_len, ScopedVMInitArgs* vm_args);
321 static jint parse_xss(const JavaVMOption* option, const char* tail, intx* out_ThreadStackSize);
322 static jint insert_vm_options_file(const JavaVMInitArgs* args,
323 const char* vm_options_file,
324 const int vm_options_file_pos,
325 ScopedVMInitArgs* vm_options_file_args,
326 ScopedVMInitArgs* args_out);
327 static bool args_contains_vm_options_file_arg(const JavaVMInitArgs* args);
328 static jint expand_vm_options_as_needed(const JavaVMInitArgs* args_in,
329 ScopedVMInitArgs* mod_args,
330 JavaVMInitArgs** args_out);
331 static jint match_special_option_and_act(const JavaVMInitArgs* args,
332 ScopedVMInitArgs* args_out);
333
334 static bool handle_deprecated_print_gc_flags();
335
336 static jint parse_vm_init_args(GrowableArrayCHeap<VMInitArgsGroup, mtArguments>* all_args);
337 static jint parse_each_vm_init_arg(const JavaVMInitArgs* args, JVMFlagOrigin origin);
338 static jint finalize_vm_init_args();
339 static bool is_bad_option(const JavaVMOption* option, jboolean ignore, const char* option_type);
340
341 static bool is_bad_option(const JavaVMOption* option, jboolean ignore) {
342 return is_bad_option(option, ignore, nullptr);
343 }
344
345 static void describe_range_error(ArgsRange errcode);
346 static ArgsRange check_memory_size(julong size, julong min_size, julong max_size);
347 static ArgsRange parse_memory_size(const char* s, julong* long_arg,
348 julong min_size, julong max_size = max_uintx);
349
350 // methods to build strings from individual args
351 static void build_jvm_args(const char* arg);
352 static void build_jvm_flags(const char* arg);
353 static void add_string(char*** bldarray, int* count, const char* arg);
354 static const char* build_resource_string(char** args, int count);
355
356 // Returns true if the flag is obsolete (and not yet expired).
357 // In this case the 'version' buffer is filled in with
358 // the version number when the flag became obsolete.
359 static bool is_obsolete_flag(const char* flag_name, JDK_Version* version);
360
361 // Returns 1 if the flag is deprecated (and not yet obsolete or expired).
362 // In this case the 'version' buffer is filled in with the version number when
363 // the flag became deprecated.
364 // Returns -1 if the flag is expired or obsolete.
365 // Returns 0 otherwise.
366 static int is_deprecated_flag(const char* flag_name, JDK_Version* version);
367
368 // Return the real name for the flag passed on the command line (either an alias name or "flag_name").
369 static const char* real_flag_name(const char *flag_name);
370 static JVMFlag* find_jvm_flag(const char* name, size_t name_length);
371
372 // Return the "real" name for option arg if arg is an alias, and print a warning if arg is deprecated.
373 // Return nullptr if the arg has expired.
374 static const char* handle_aliases_and_deprecation(const char* arg);
375 static size_t _default_SharedBaseAddress; // The default value specified in globals.hpp
376
377 static bool internal_module_property_helper(const char* property, bool check_for_cds);
378
379 public:
380 // Parses the arguments, first phase
381 static jint parse(const JavaVMInitArgs* args);
382 // Parse a string for a unsigned integer. Returns true if value
383 // is an unsigned integer greater than or equal to the minimum
384 // parameter passed and returns the value in uint_arg. Returns
385 // false otherwise, with uint_arg undefined.
386 static bool parse_uint(const char* value, uint* uintx_arg,
387 uint min_size);
388 // Apply ergonomics
389 static jint apply_ergo();
390 // Adjusts the arguments after the OS have adjusted the arguments
391 static jint adjust_after_os();
392
393 // Check consistency or otherwise of VM argument settings
394 static bool check_vm_args_consistency();
395 // Used by os_solaris
396 static bool process_settings_file(const char* file_name, bool should_exist, jboolean ignore_unrecognized);
397
398 static size_t conservative_max_heap_alignment() { return _conservative_max_heap_alignment; }
399 // Return the maximum size a heap with compressed oops can take
400 static size_t max_heap_for_compressed_oops();
401
402 // return a char* array containing all options
403 static char** jvm_flags_array() { return _jvm_flags_array; }
404 static char** jvm_args_array() { return _jvm_args_array; }
405 static int num_jvm_flags() { return _num_jvm_flags; }
406 static int num_jvm_args() { return _num_jvm_args; }
407 // return the arguments passed to the Java application
408 static const char* java_command() { return _java_command; }
409
410 // print jvm_flags, jvm_args and java_command
411 static void print_on(outputStream* st);
412 static void print_summary_on(outputStream* st);
413
414 // convenient methods to get and set jvm_flags_file
415 static const char* get_jvm_flags_file() { return _jvm_flags_file; }
416 static void set_jvm_flags_file(const char *value) {
417 if (_jvm_flags_file != nullptr) {
418 os::free(_jvm_flags_file);
419 }
420 _jvm_flags_file = os::strdup_check_oom(value);
421 }
422 // convenient methods to obtain / print jvm_flags and jvm_args
423 static const char* jvm_flags() { return build_resource_string(_jvm_flags_array, _num_jvm_flags); }
424 static const char* jvm_args() { return build_resource_string(_jvm_args_array, _num_jvm_args); }
425 static void print_jvm_flags_on(outputStream* st);
426 static void print_jvm_args_on(outputStream* st);
427
428 // -Dkey=value flags
429 static SystemProperty* system_properties() { return _system_properties; }
430 static const char* get_property(const char* key);
431
432 // -Djava.vendor.url.bug
433 static const char* java_vendor_url_bug() { return _java_vendor_url_bug; }
434
435 // -Dsun.java.launcher
436 static const char* sun_java_launcher() { return _sun_java_launcher; }
437 // Was VM created by a Java launcher?
438 static bool created_by_java_launcher();
439 // -XX:+ExecutingUnitTests
440 static bool executing_unit_tests();
441
442 // abort, exit, vfprintf hooks
443 static abort_hook_t abort_hook() { return _abort_hook; }
444 static exit_hook_t exit_hook() { return _exit_hook; }
445 static vfprintf_hook_t vfprintf_hook() { return _vfprintf_hook; }
446
447 static void no_shared_spaces(const char* message);
448 static size_t default_SharedBaseAddress() { return _default_SharedBaseAddress; }
449 // Java launcher properties
450 static void process_sun_java_launcher_properties(JavaVMInitArgs* args);
451
452 // System properties
453 static void init_system_properties();
454
455 // Update/Initialize System properties after JDK version number is known
456 static void init_version_specific_system_properties();
457
458 // Update VM info property - called after argument parsing
459 static void update_vm_info_property(const char* vm_info) {
460 _vm_info->set_value(vm_info);
461 }
462
463 // Property List manipulation
464 static void PropertyList_add(SystemProperty *element);
465 static void PropertyList_add(SystemProperty** plist, SystemProperty *element);
466 static void PropertyList_add(SystemProperty** plist, const char* k, const char* v, bool writeable, bool internal);
467
468 static void PropertyList_unique_add(SystemProperty** plist, const char* k, const char* v,
469 PropertyAppendable append, PropertyWriteable writeable,
470 PropertyInternal internal);
471 static const char* PropertyList_get_value(SystemProperty* plist, const char* key);
472 static const char* PropertyList_get_readable_value(SystemProperty* plist, const char* key);
473 static int PropertyList_count(SystemProperty* pl);
474 static int PropertyList_readable_count(SystemProperty* pl);
475
476 static bool is_internal_module_property(const char* option);
477 static bool is_incompatible_cds_internal_module_property(const char* property);
478 static bool patching_migrated_classes(const char* property, const char* value);
479
480 // Miscellaneous System property value getter and setters.
481 static void set_dll_dir(const char *value) { _sun_boot_library_path->set_value(value); }
482 static void set_java_home(const char *value) { _java_home->set_value(value); }
483 static void set_library_path(const char *value) { _java_library_path->set_value(value); }
484 static void set_ext_dirs(char *value) { _ext_dirs = os::strdup_check_oom(value); }
485
486 // Set up the underlying pieces of the boot class path
487 static void add_patch_mod_prefix(const char *module_name, const char *path, bool allow_append, bool allow_cds);
488 static int finalize_patch_module();
489 static void set_boot_class_path(const char *value, bool has_jimage) {
490 // During start up, set by os::set_boot_path()
491 assert(get_boot_class_path() == nullptr, "Boot class path previously set");
492 _boot_class_path->set_value(value);
493 _has_jimage = has_jimage;
494 }
495 static void append_sysclasspath(const char *value) {
496 _boot_class_path->append_value(value);
497 _jdk_boot_class_path_append->append_value(value);
498 }
499
500 static GrowableArray<ModulePatchPath*>* get_patch_mod_prefix() { return _patch_mod_prefix; }
501 static char* get_boot_class_path() { return _boot_class_path->value(); }
502 static bool has_jimage() { return _has_jimage; }
503
504 static char* get_java_home() { return _java_home->value(); }
505 static char* get_dll_dir() { return _sun_boot_library_path->value(); }
506 static char* get_appclasspath() { return _java_class_path->value(); }
507 static void fix_appclasspath();
508
509 // Operation modi
510 static Mode mode() { return _mode; }
511 static void set_mode_flags(Mode mode);
512 static bool is_interpreter_only() { return mode() == _int; }
513 static bool is_compiler_only() { return mode() == _comp; }
514
515
516 // preview features
517 static void set_enable_preview() { _enable_preview = true; }
518 static bool enable_preview() { return _enable_preview; }
519
520 // jdwp
521 static bool has_jdwp_agent() { return _has_jdwp_agent; }
522
523 // Utility: copies src into buf, replacing "%%" with "%" and "%p" with pid.
524 static bool copy_expand_pid(const char* src, size_t srclen, char* buf, size_t buflen);
525
526 static bool atojulong(const char *s, julong* result);
527
528 static bool has_jfr_option() NOT_JFR_RETURN_(false);
529
530 DEBUG_ONLY(static bool verify_special_jvm_flags(bool check_globals);)
531 };
532
533 // Disable options not supported in this release, with a warning if they
534 // were explicitly requested on the command-line
535 #define UNSUPPORTED_OPTION(opt) \
536 do { \
537 if (opt) { \
538 if (FLAG_IS_CMDLINE(opt)) { \
539 warning("-XX:+" #opt " not supported in this VM"); \
540 } \
541 FLAG_SET_DEFAULT(opt, false); \
542 } \
543 } while(0)
544
545 // similar to UNSUPPORTED_OPTION but sets flag to nullptr
546 #define UNSUPPORTED_OPTION_NULL(opt) \
547 do { \
548 if (opt) { \
549 if (FLAG_IS_CMDLINE(opt)) { \
550 warning("-XX flag " #opt " not supported in this VM"); \
551 } \
552 FLAG_SET_DEFAULT(opt, nullptr); \
553 } \
554 } while(0)
555
556 // Initialize options not supported in this release, with a warning
557 // if they were explicitly requested on the command-line
558 #define UNSUPPORTED_OPTION_INIT(opt, value) \
559 do { \
560 if (FLAG_IS_CMDLINE(opt)) { \
561 warning("-XX flag " #opt " not supported in this VM"); \
562 } \
563 FLAG_SET_DEFAULT(opt, value); \
564 } while(0)
565
566 #endif // SHARE_RUNTIME_ARGUMENTS_HPP