1 /*
  2  * Copyright (c) 1997, 2022, 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 
 80 // ModulePatchPath records the module/path pair as specified to --patch-module.
 81 class ModulePatchPath : public CHeapObj<mtInternal> {
 82 private:
 83   char* _module_name;
 84   PathString* _path;
 85 public:
 86   ModulePatchPath(const char* module_name, const char* path);
 87   ~ModulePatchPath();
 88 
 89   inline const char* module_name() const { return _module_name; }
 90   inline char* path_string() const { return _path->value(); }
 91 };
 92 
 93 // Element describing System and User (-Dkey=value flags) defined property.
 94 //
 95 // An internal SystemProperty is one that has been removed in
 96 // jdk.internal.VM.saveAndRemoveProperties, like jdk.boot.class.path.append.
 97 //
 98 class SystemProperty : public PathString {
 99  private:
100   char*           _key;
101   SystemProperty* _next;
102   bool            _internal;
103   bool            _writeable;
104 
105  public:
106   // Accessors
107   char* value() const                 { return PathString::value(); }
108   const char* key() const             { return _key; }
109   bool internal() const               { return _internal; }
110   SystemProperty* next() const        { return _next; }
111   void set_next(SystemProperty* next) { _next = next; }
112   bool writeable() const              { return _writeable; }
113 
114   bool readable() const {
115     return !_internal || (strcmp(_key, "jdk.boot.class.path.append") == 0 &&
116                           value() != NULL);
117   }
118 
119   // A system property should only have its value set
120   // via an external interface if it is a writeable property.
121   // The internal, non-writeable property jdk.boot.class.path.append
122   // is the only exception to this rule.  It can be set externally
123   // via -Xbootclasspath/a or JVMTI OnLoad phase call to AddToBootstrapClassLoaderSearch.
124   // In those cases for jdk.boot.class.path.append, the base class
125   // set_value and append_value methods are called directly.
126   void set_writeable_value(const char *value) {
127     if (writeable()) {
128       set_value(value);
129     }
130   }
131   void append_writeable_value(const char *value) {
132     if (writeable()) {
133       append_value(value);
134     }
135   }
136 
137   // Constructor
138   SystemProperty(const char* key, const char* value, bool writeable, bool internal = false);
139 };
140 
141 
142 // For use by -agentlib, -agentpath and -Xrun
143 class AgentLibrary : public CHeapObj<mtArguments> {
144   friend class AgentLibraryList;
145 public:
146   // Is this library valid or not. Don't rely on os_lib == NULL as statically
147   // linked lib could have handle of RTLD_DEFAULT which == 0 on some platforms
148   enum AgentState {
149     agent_invalid = 0,
150     agent_valid   = 1
151   };
152 
153  private:
154   char*           _name;
155   char*           _options;
156   void*           _os_lib;
157   bool            _is_absolute_path;
158   bool            _is_static_lib;
159   bool            _is_instrument_lib;
160   AgentState      _state;
161   AgentLibrary*   _next;
162 
163  public:
164   // Accessors
165   const char* name() const                  { return _name; }
166   char* options() const                     { return _options; }
167   bool is_absolute_path() const             { return _is_absolute_path; }
168   void* os_lib() const                      { return _os_lib; }
169   void set_os_lib(void* os_lib)             { _os_lib = os_lib; }
170   AgentLibrary* next() const                { return _next; }
171   bool is_static_lib() const                { return _is_static_lib; }
172   bool is_instrument_lib() const            { return _is_instrument_lib; }
173   void set_static_lib(bool is_static_lib)   { _is_static_lib = is_static_lib; }
174   bool valid()                              { return (_state == agent_valid); }
175   void set_valid()                          { _state = agent_valid; }
176 
177   // Constructor
178   AgentLibrary(const char* name, const char* options, bool is_absolute_path,
179                void* os_lib, bool instrument_lib=false);
180 };
181 
182 // maintain an order of entry list of AgentLibrary
183 class AgentLibraryList {
184  private:
185   AgentLibrary*   _first;
186   AgentLibrary*   _last;
187  public:
188   bool is_empty() const                     { return _first == NULL; }
189   AgentLibrary* first() const               { return _first; }
190 
191   // add to the end of the list
192   void add(AgentLibrary* lib) {
193     if (is_empty()) {
194       _first = _last = lib;
195     } else {
196       _last->_next = lib;
197       _last = lib;
198     }
199     lib->_next = NULL;
200   }
201 
202   // search for and remove a library known to be in the list
203   void remove(AgentLibrary* lib) {
204     AgentLibrary* curr;
205     AgentLibrary* prev = NULL;
206     for (curr = first(); curr != NULL; prev = curr, curr = curr->next()) {
207       if (curr == lib) {
208         break;
209       }
210     }
211     assert(curr != NULL, "always should be found");
212 
213     if (curr != NULL) {
214       // it was found, by-pass this library
215       if (prev == NULL) {
216         _first = curr->_next;
217       } else {
218         prev->_next = curr->_next;
219       }
220       if (curr == _last) {
221         _last = prev;
222       }
223       curr->_next = NULL;
224     }
225   }
226 
227   AgentLibraryList() {
228     _first = NULL;
229     _last = NULL;
230   }
231 };
232 
233 // Helper class for controlling the lifetime of JavaVMInitArgs objects.
234 class ScopedVMInitArgs;
235 
236 class Arguments : AllStatic {
237   friend class VMStructs;
238   friend class JvmtiExport;
239   friend class CodeCacheExtensions;
240   friend class ArgumentsTest;
241   friend class LargeOptionsTest;
242  public:
243   // Operation modi
244   enum Mode {
245     _int,       // corresponds to -Xint
246     _mixed,     // corresponds to -Xmixed
247     _comp       // corresponds to -Xcomp
248   };
249 
250   enum ArgsRange {
251     arg_unreadable = -3,
252     arg_too_small  = -2,
253     arg_too_big    = -1,
254     arg_in_range   = 0
255   };
256 
257   enum PropertyAppendable {
258     AppendProperty,
259     AddProperty
260   };
261 
262   enum PropertyWriteable {
263     WriteableProperty,
264     UnwriteableProperty
265   };
266 
267   enum PropertyInternal {
268     InternalProperty,
269     ExternalProperty
270   };
271 
272  private:
273 
274   // a pointer to the flags file name if it is specified
275   static char*  _jvm_flags_file;
276   // an array containing all flags specified in the .hotspotrc file
277   static char** _jvm_flags_array;
278   static int    _num_jvm_flags;
279   // an array containing all jvm arguments specified in the command line
280   static char** _jvm_args_array;
281   static int    _num_jvm_args;
282   // string containing all java command (class/jarfile name and app args)
283   static char* _java_command;
284 
285   // Property list
286   static SystemProperty* _system_properties;
287 
288   // Quick accessor to System properties in the list:
289   static SystemProperty *_sun_boot_library_path;
290   static SystemProperty *_java_library_path;
291   static SystemProperty *_java_home;
292   static SystemProperty *_java_class_path;
293   static SystemProperty *_jdk_boot_class_path_append;
294   static SystemProperty *_vm_info;
295 
296   // --patch-module=module=<file>(<pathsep><file>)*
297   // Each element contains the associated module name, path
298   // string pair as specified to --patch-module.
299   static GrowableArray<ModulePatchPath*>* _patch_mod_prefix;
300 
301   // The constructed value of the system class path after
302   // argument processing and JVMTI OnLoad additions via
303   // calls to AddToBootstrapClassLoaderSearch.  This is the
304   // final form before ClassLoader::setup_bootstrap_search().
305   // Note: since --patch-module is a module name/path pair, the
306   // boot class path string no longer contains the "prefix"
307   // to the boot class path base piece as it did when
308   // -Xbootclasspath/p was supported.
309   static PathString* _boot_class_path;
310 
311   // Set if a modular java runtime image is present vs. a build with exploded modules
312   static bool _has_jimage;
313 
314   // temporary: to emit warning if the default ext dirs are not empty.
315   // remove this variable when the warning is no longer needed.
316   static char* _ext_dirs;
317 
318   // java.vendor.url.bug, bug reporting URL for fatal errors.
319   static const char* _java_vendor_url_bug;
320 
321   // sun.java.launcher, private property to provide information about
322   // java launcher
323   static const char* _sun_java_launcher;
324 
325   // was this VM created via the -XXaltjvm=<path> option
326   static bool   _sun_java_launcher_is_altjvm;
327 
328   // for legacy gc options (-verbose:gc and -Xloggc:)
329   static LegacyGCLogging _legacyGCLogging;
330 
331   // Value of the conservative maximum heap alignment needed
332   static size_t  _conservative_max_heap_alignment;
333 
334   // -Xrun arguments
335   static AgentLibraryList _libraryList;
336   static void add_init_library(const char* name, char* options);
337 
338   // -agentlib and -agentpath arguments
339   static AgentLibraryList _agentList;
340   static void add_init_agent(const char* name, char* options, bool absolute_path);
341   static void add_instrument_agent(const char* name, char* options, bool absolute_path);
342 
343   // Late-binding agents not started via arguments
344   static void add_loaded_agent(AgentLibrary *agentLib);
345 
346   // Operation modi
347   static Mode _mode;
348   static void set_mode_flags(Mode mode);
349   static bool _java_compiler;
350   static void set_java_compiler(bool arg) { _java_compiler = arg; }
351   static bool java_compiler()   { return _java_compiler; }
352 
353   // -Xdebug flag
354   static bool _xdebug_mode;
355   static void set_xdebug_mode(bool arg) { _xdebug_mode = arg; }
356   static bool xdebug_mode()             { return _xdebug_mode; }
357 
358   // preview features
359   static bool _enable_preview;
360 
361   // Used to save default settings
362   static bool _AlwaysCompileLoopMethods;
363   static bool _UseOnStackReplacement;
364   static bool _BackgroundCompilation;
365   static bool _ClipInlining;
366 
367   // GC ergonomics
368   static void set_conservative_max_heap_alignment();
369   static void set_use_compressed_oops();
370   static void set_use_compressed_klass_ptrs();
371   static jint set_ergonomics_flags();
372   static void set_shared_spaces_flags_and_archive_paths();
373   // Limits the given heap size by the maximum amount of virtual
374   // memory this process is currently allowed to use. It also takes
375   // the virtual-to-physical ratio of the current GC into account.
376   static size_t limit_heap_by_allocatable_memory(size_t size);
377   // Setup heap size
378   static void set_heap_size();
379 
380   // Bytecode rewriting
381   static void set_bytecode_flags();
382 
383   // Invocation API hooks
384   static abort_hook_t     _abort_hook;
385   static exit_hook_t      _exit_hook;
386   static vfprintf_hook_t  _vfprintf_hook;
387 
388   // System properties
389   static bool add_property(const char* prop, PropertyWriteable writeable=WriteableProperty,
390                            PropertyInternal internal=ExternalProperty);
391 
392   // Used for module system related properties: converted from command-line flags.
393   // Basic properties are writeable as they operate as "last one wins" and will get overwritten.
394   // Numbered properties are never writeable, and always internal.
395   static bool create_module_property(const char* prop_name, const char* prop_value, PropertyInternal internal);
396   static bool create_numbered_module_property(const char* prop_base_name, const char* prop_value, unsigned int count);
397 
398   static int process_patch_mod_option(const char* patch_mod_tail, bool* patch_mod_javabase);
399 
400   // Aggressive optimization flags.
401   static jint set_aggressive_opts_flags();
402 
403   static jint set_aggressive_heap_flags();
404 
405   // Argument parsing
406   static bool parse_argument(const char* arg, JVMFlagOrigin origin);
407   static bool process_argument(const char* arg, jboolean ignore_unrecognized, JVMFlagOrigin origin);
408   static void process_java_launcher_argument(const char*, void*);
409   static void process_java_compiler_argument(const char* arg);
410   static jint parse_options_environment_variable(const char* name, ScopedVMInitArgs* vm_args);
411   static jint parse_java_tool_options_environment_variable(ScopedVMInitArgs* vm_args);
412   static jint parse_java_options_environment_variable(ScopedVMInitArgs* vm_args);
413   static jint parse_vm_options_file(const char* file_name, ScopedVMInitArgs* vm_args);
414   static jint parse_options_buffer(const char* name, char* buffer, const size_t buf_len, ScopedVMInitArgs* vm_args);
415   static jint parse_xss(const JavaVMOption* option, const char* tail, intx* out_ThreadStackSize);
416   static jint insert_vm_options_file(const JavaVMInitArgs* args,
417                                      const char* vm_options_file,
418                                      const int vm_options_file_pos,
419                                      ScopedVMInitArgs* vm_options_file_args,
420                                      ScopedVMInitArgs* args_out);
421   static bool args_contains_vm_options_file_arg(const JavaVMInitArgs* args);
422   static jint expand_vm_options_as_needed(const JavaVMInitArgs* args_in,
423                                           ScopedVMInitArgs* mod_args,
424                                           JavaVMInitArgs** args_out);
425   static jint match_special_option_and_act(const JavaVMInitArgs* args,
426                                            ScopedVMInitArgs* args_out);
427 
428   static bool handle_deprecated_print_gc_flags();
429 
430   static jint parse_vm_init_args(const JavaVMInitArgs *vm_options_args,
431                                  const JavaVMInitArgs *java_tool_options_args,
432                                  const JavaVMInitArgs *java_options_args,
433                                  const JavaVMInitArgs *cmd_line_args);
434   static jint parse_each_vm_init_arg(const JavaVMInitArgs* args, bool* patch_mod_javabase, JVMFlagOrigin origin);
435   static jint finalize_vm_init_args(bool patch_mod_javabase);
436   static bool is_bad_option(const JavaVMOption* option, jboolean ignore, const char* option_type);
437 
438   static bool is_bad_option(const JavaVMOption* option, jboolean ignore) {
439     return is_bad_option(option, ignore, NULL);
440   }
441 
442   static void describe_range_error(ArgsRange errcode);
443   static ArgsRange check_memory_size(julong size, julong min_size, julong max_size);
444   static ArgsRange parse_memory_size(const char* s, julong* long_arg,
445                                      julong min_size, julong max_size = max_uintx);
446 
447   // methods to build strings from individual args
448   static void build_jvm_args(const char* arg);
449   static void build_jvm_flags(const char* arg);
450   static void add_string(char*** bldarray, int* count, const char* arg);
451   static const char* build_resource_string(char** args, int count);
452 
453   // Returns true if the flag is obsolete (and not yet expired).
454   // In this case the 'version' buffer is filled in with
455   // the version number when the flag became obsolete.
456   static bool is_obsolete_flag(const char* flag_name, JDK_Version* version);
457 
458   // Returns 1 if the flag is deprecated (and not yet obsolete or expired).
459   //     In this case the 'version' buffer is filled in with the version number when
460   //     the flag became deprecated.
461   // Returns -1 if the flag is expired or obsolete.
462   // Returns 0 otherwise.
463   static int is_deprecated_flag(const char* flag_name, JDK_Version* version);
464 
465   // Return the real name for the flag passed on the command line (either an alias name or "flag_name").
466   static const char* real_flag_name(const char *flag_name);
467   static JVMFlag* find_jvm_flag(const char* name, size_t name_length);
468 
469   // Return the "real" name for option arg if arg is an alias, and print a warning if arg is deprecated.
470   // Return NULL if the arg has expired.
471   static const char* handle_aliases_and_deprecation(const char* arg);
472 
473   static char*  SharedArchivePath;
474   static char*  SharedDynamicArchivePath;
475   static size_t _default_SharedBaseAddress; // The default value specified in globals.hpp
476   static void extract_shared_archive_paths(const char* archive_path,
477                                          char** base_archive_path,
478                                          char** top_archive_path) NOT_CDS_RETURN;
479 
480   // Helpers for parse_malloc_limits
481   static bool parse_malloc_limit_size(const char* s, size_t* out);
482   static void parse_single_category_limit(char* expression, size_t limits[mt_number_of_types]);
483 
484  public:
485   static int num_archives(const char* archive_path) NOT_CDS_RETURN_(0);
486   // Parses the arguments, first phase
487   static jint parse(const JavaVMInitArgs* args);
488   // Parse a string for a unsigned integer.  Returns true if value
489   // is an unsigned integer greater than or equal to the minimum
490   // parameter passed and returns the value in uintx_arg.  Returns
491   // false otherwise, with uintx_arg undefined.
492   static bool parse_uintx(const char* value, uintx* uintx_arg,
493                           uintx min_size);
494   // Apply ergonomics
495   static jint apply_ergo();
496   // Adjusts the arguments after the OS have adjusted the arguments
497   static jint adjust_after_os();
498 
499   // Check consistency or otherwise of VM argument settings
500   static bool check_vm_args_consistency();
501   // Used by os_solaris
502   static bool process_settings_file(const char* file_name, bool should_exist, jboolean ignore_unrecognized);
503 
504   static size_t conservative_max_heap_alignment() { return _conservative_max_heap_alignment; }
505   // Return the maximum size a heap with compressed oops can take
506   static size_t max_heap_for_compressed_oops();
507 
508   // return a char* array containing all options
509   static char** jvm_flags_array()          { return _jvm_flags_array; }
510   static char** jvm_args_array()           { return _jvm_args_array; }
511   static int num_jvm_flags()               { return _num_jvm_flags; }
512   static int num_jvm_args()                { return _num_jvm_args; }
513   // return the arguments passed to the Java application
514   static const char* java_command()        { return _java_command; }
515 
516   // print jvm_flags, jvm_args and java_command
517   static void print_on(outputStream* st);
518   static void print_summary_on(outputStream* st);
519 
520   // convenient methods to get and set jvm_flags_file
521   static const char* get_jvm_flags_file()  { return _jvm_flags_file; }
522   static void set_jvm_flags_file(const char *value) {
523     if (_jvm_flags_file != NULL) {
524       os::free(_jvm_flags_file);
525     }
526     _jvm_flags_file = os::strdup_check_oom(value);
527   }
528   // convenient methods to obtain / print jvm_flags and jvm_args
529   static const char* jvm_flags()           { return build_resource_string(_jvm_flags_array, _num_jvm_flags); }
530   static const char* jvm_args()            { return build_resource_string(_jvm_args_array, _num_jvm_args); }
531   static void print_jvm_flags_on(outputStream* st);
532   static void print_jvm_args_on(outputStream* st);
533 
534   // -Dkey=value flags
535   static SystemProperty*  system_properties()   { return _system_properties; }
536   static const char*    get_property(const char* key);
537 
538   // -Djava.vendor.url.bug
539   static const char* java_vendor_url_bug()  { return _java_vendor_url_bug; }
540 
541   // -Dsun.java.launcher
542   static const char* sun_java_launcher()    { return _sun_java_launcher; }
543   // Was VM created by a Java launcher?
544   static bool created_by_java_launcher();
545   // -Dsun.java.launcher.is_altjvm
546   static bool sun_java_launcher_is_altjvm();
547 
548   // -Xrun
549   static AgentLibrary* libraries()          { return _libraryList.first(); }
550   static bool init_libraries_at_startup()   { return !_libraryList.is_empty(); }
551   static void convert_library_to_agent(AgentLibrary* lib)
552                                             { _libraryList.remove(lib);
553                                               _agentList.add(lib); }
554 
555   // -agentlib -agentpath
556   static AgentLibrary* agents()             { return _agentList.first(); }
557   static bool init_agents_at_startup()      { return !_agentList.is_empty(); }
558 
559   // abort, exit, vfprintf hooks
560   static abort_hook_t    abort_hook()       { return _abort_hook; }
561   static exit_hook_t     exit_hook()        { return _exit_hook; }
562   static vfprintf_hook_t vfprintf_hook()    { return _vfprintf_hook; }
563 
564   static const char* GetSharedArchivePath() { return SharedArchivePath; }
565   static const char* GetSharedDynamicArchivePath() { return SharedDynamicArchivePath; }
566   static size_t default_SharedBaseAddress() { return _default_SharedBaseAddress; }
567   // Java launcher properties
568   static void process_sun_java_launcher_properties(JavaVMInitArgs* args);
569 
570   // System properties
571   static void init_system_properties();
572 
573   // Update/Initialize System properties after JDK version number is known
574   static void init_version_specific_system_properties();
575 
576   // Update VM info property - called after argument parsing
577   static void update_vm_info_property(const char* vm_info) {
578     _vm_info->set_value(vm_info);
579   }
580 
581   // Property List manipulation
582   static void PropertyList_add(SystemProperty *element);
583   static void PropertyList_add(SystemProperty** plist, SystemProperty *element);
584   static void PropertyList_add(SystemProperty** plist, const char* k, const char* v, bool writeable, bool internal);
585 
586   static void PropertyList_unique_add(SystemProperty** plist, const char* k, const char* v,
587                                       PropertyAppendable append, PropertyWriteable writeable,
588                                       PropertyInternal internal);
589   static const char* PropertyList_get_value(SystemProperty* plist, const char* key);
590   static const char* PropertyList_get_readable_value(SystemProperty* plist, const char* key);
591   static int  PropertyList_count(SystemProperty* pl);
592   static int  PropertyList_readable_count(SystemProperty* pl);
593 
594   static bool is_internal_module_property(const char* option);
595 
596   // Miscellaneous System property value getter and setters.
597   static void set_dll_dir(const char *value) { _sun_boot_library_path->set_value(value); }
598   static void set_java_home(const char *value) { _java_home->set_value(value); }
599   static void set_library_path(const char *value) { _java_library_path->set_value(value); }
600   static void set_ext_dirs(char *value)     { _ext_dirs = os::strdup_check_oom(value); }
601 
602   // Set up the underlying pieces of the boot class path
603   static void add_patch_mod_prefix(const char *module_name, const char *path, bool* patch_mod_javabase);
604   static void set_boot_class_path(const char *value, bool has_jimage) {
605     // During start up, set by os::set_boot_path()
606     assert(get_boot_class_path() == NULL, "Boot class path previously set");
607     _boot_class_path->set_value(value);
608     _has_jimage = has_jimage;
609   }
610   static void append_sysclasspath(const char *value) {
611     _boot_class_path->append_value(value);
612     _jdk_boot_class_path_append->append_value(value);
613   }
614 
615   static GrowableArray<ModulePatchPath*>* get_patch_mod_prefix() { return _patch_mod_prefix; }
616   static char* get_boot_class_path() { return _boot_class_path->value(); }
617   static bool has_jimage() { return _has_jimage; }
618 
619   static char* get_java_home()    { return _java_home->value(); }
620   static char* get_dll_dir()      { return _sun_boot_library_path->value(); }
621   static char* get_appclasspath() { return _java_class_path->value(); }
622   static void  fix_appclasspath();
623 
624   static char* get_default_shared_archive_path() NOT_CDS_RETURN_(NULL);
625   static void  init_shared_archive_paths() NOT_CDS_RETURN;
626 
627   // Operation modi
628   static Mode mode()                { return _mode;           }
629   static bool is_interpreter_only() { return mode() == _int;  }
630   static bool is_compiler_only()    { return mode() == _comp; }
631 
632 
633   // preview features
634   static void set_enable_preview() { _enable_preview = true; }
635   static bool enable_preview() { return _enable_preview; }
636 
637   // Utility: copies src into buf, replacing "%%" with "%" and "%p" with pid.
638   static bool copy_expand_pid(const char* src, size_t srclen, char* buf, size_t buflen);
639 
640   static void check_unsupported_dumping_properties() NOT_CDS_RETURN;
641 
642   static bool check_unsupported_cds_runtime_properties() NOT_CDS_RETURN0;
643 
644   static bool atojulong(const char *s, julong* result);
645 
646   static bool has_jfr_option() NOT_JFR_RETURN_(false);
647 
648   static bool is_dumping_archive() { return DumpSharedSpaces || DynamicDumpSharedSpaces; }
649 
650   static void assert_is_dumping_archive() {
651     assert(Arguments::is_dumping_archive(), "dump time only");
652   }
653 
654   // Parse diagnostic NMT switch "MallocLimit" and return the found limits.
655   // 1) If option is not given, it will set all limits to 0 (aka "no limit").
656   // 2) If option is given in the global form (-XX:MallocLimit=<size>), it
657   //    will return the size in *total_limit.
658   // 3) If option is given in its per-NMT-category form (-XX:MallocLimit=<category>:<size>[,<category>:<size>]),
659   //    it will return all found limits in the limits array.
660   // 4) If option is malformed, it will exit the VM.
661   // For (2) and (3), limits not affected by the switch will be set to 0.
662   static void parse_malloc_limits(size_t* total_limit, size_t limits[mt_number_of_types]);
663 
664   DEBUG_ONLY(static bool verify_special_jvm_flags(bool check_globals);)
665 };
666 
667 // Disable options not supported in this release, with a warning if they
668 // were explicitly requested on the command-line
669 #define UNSUPPORTED_OPTION(opt)                          \
670 do {                                                     \
671   if (opt) {                                             \
672     if (FLAG_IS_CMDLINE(opt)) {                          \
673       warning("-XX:+" #opt " not supported in this VM"); \
674     }                                                    \
675     FLAG_SET_DEFAULT(opt, false);                        \
676   }                                                      \
677 } while(0)
678 
679 // similar to UNSUPPORTED_OPTION but sets flag to NULL
680 #define UNSUPPORTED_OPTION_NULL(opt)                     \
681 do {                                                     \
682   if (opt) {                                             \
683     if (FLAG_IS_CMDLINE(opt)) {                          \
684       warning("-XX flag " #opt " not supported in this VM"); \
685     }                                                    \
686     FLAG_SET_DEFAULT(opt, NULL);                         \
687   }                                                      \
688 } while(0)
689 
690 // Initialize options not supported in this release, with a warning
691 // if they were explicitly requested on the command-line
692 #define UNSUPPORTED_OPTION_INIT(opt, value)              \
693 do {                                                     \
694   if (FLAG_IS_CMDLINE(opt)) {                            \
695     warning("-XX flag " #opt " not supported in this VM"); \
696   }                                                      \
697   FLAG_SET_DEFAULT(opt, value);                          \
698 } while(0)
699 
700 #endif // SHARE_RUNTIME_ARGUMENTS_HPP