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