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   static void set_mode_flags(Mode mode);
252 
253   // preview features
254   static bool _enable_preview;
255 
256   // Used to save default settings
257   static bool _AlwaysCompileLoopMethods;
258   static bool _UseOnStackReplacement;
259   static bool _BackgroundCompilation;
260   static bool _ClipInlining;
261 
262   // GC ergonomics
263   static void set_conservative_max_heap_alignment();
264   static void set_use_compressed_oops();
265   static void set_use_compressed_klass_ptrs();
266   static jint set_ergonomics_flags();
267   static void set_shared_spaces_flags_and_archive_paths();
268   // Limits the given heap size by the maximum amount of virtual
269   // memory this process is currently allowed to use. It also takes
270   // the virtual-to-physical ratio of the current GC into account.
271   static size_t limit_heap_by_allocatable_memory(size_t size);
272   // Setup heap size
273   static void set_heap_size();
274 
275   // Bytecode rewriting
276   static void set_bytecode_flags();
277 
278   // Invocation API hooks
279   static abort_hook_t     _abort_hook;
280   static exit_hook_t      _exit_hook;
281   static vfprintf_hook_t  _vfprintf_hook;
282 
283   // System properties
284   static bool add_property(const char* prop, PropertyWriteable writeable=WriteableProperty,
285                            PropertyInternal internal=ExternalProperty);
286 
287   // Used for module system related properties: converted from command-line flags.
288   // Basic properties are writeable as they operate as "last one wins" and will get overwritten.
289   // Numbered properties are never writeable, and always internal.
290   static bool create_module_property(const char* prop_name, const char* prop_value, PropertyInternal internal);
291   static bool create_numbered_module_property(const char* prop_base_name, const char* prop_value, unsigned int count);
292 
293   static int process_patch_mod_option(const char* patch_mod_tail, bool* patch_mod_javabase);
294 
295   // Aggressive optimization flags.
296   static jint set_aggressive_opts_flags();
297 
298   static jint set_aggressive_heap_flags();
299 
300   // Argument parsing
301   static bool parse_argument(const char* arg, JVMFlagOrigin origin);
302   static bool process_argument(const char* arg, jboolean ignore_unrecognized, JVMFlagOrigin origin);
303   static void process_java_launcher_argument(const char*, void*);
304   static jint parse_options_environment_variable(const char* name, ScopedVMInitArgs* vm_args);
305   static jint parse_java_tool_options_environment_variable(ScopedVMInitArgs* vm_args);
306   static jint parse_java_options_environment_variable(ScopedVMInitArgs* vm_args);
307   static jint parse_vm_options_file(const char* file_name, ScopedVMInitArgs* vm_args);
308   static jint parse_options_buffer(const char* name, char* buffer, const size_t buf_len, ScopedVMInitArgs* vm_args);
309   static jint parse_xss(const JavaVMOption* option, const char* tail, intx* out_ThreadStackSize);
310   static jint insert_vm_options_file(const JavaVMInitArgs* args,
311                                      const char* vm_options_file,
312                                      const int vm_options_file_pos,
313                                      ScopedVMInitArgs* vm_options_file_args,
314                                      ScopedVMInitArgs* args_out);
315   static bool args_contains_vm_options_file_arg(const JavaVMInitArgs* args);
316   static jint expand_vm_options_as_needed(const JavaVMInitArgs* args_in,
317                                           ScopedVMInitArgs* mod_args,
318                                           JavaVMInitArgs** args_out);
319   static jint match_special_option_and_act(const JavaVMInitArgs* args,
320                                            ScopedVMInitArgs* args_out);
321 
322   static bool handle_deprecated_print_gc_flags();
323 
324   static jint parse_vm_init_args(const JavaVMInitArgs *vm_options_args,
325                                  const JavaVMInitArgs *java_tool_options_args,
326                                  const JavaVMInitArgs *java_options_args,
327                                  const JavaVMInitArgs *cmd_line_args);
328   static jint parse_each_vm_init_arg(const JavaVMInitArgs* args, bool* patch_mod_javabase, JVMFlagOrigin origin);
329   static jint finalize_vm_init_args(bool patch_mod_javabase);
330   static bool is_bad_option(const JavaVMOption* option, jboolean ignore, const char* option_type);
331 
332   static bool is_bad_option(const JavaVMOption* option, jboolean ignore) {
333     return is_bad_option(option, ignore, nullptr);
334   }
335 
336   static void describe_range_error(ArgsRange errcode);
337   static ArgsRange check_memory_size(julong size, julong min_size, julong max_size);
338   static ArgsRange parse_memory_size(const char* s, julong* long_arg,
339                                      julong min_size, julong max_size = max_uintx);
340 
341   // methods to build strings from individual args
342   static void build_jvm_args(const char* arg);
343   static void build_jvm_flags(const char* arg);
344   static void add_string(char*** bldarray, int* count, const char* arg);
345   static const char* build_resource_string(char** args, int count);
346 
347   // Returns true if the flag is obsolete (and not yet expired).
348   // In this case the 'version' buffer is filled in with
349   // the version number when the flag became obsolete.
350   static bool is_obsolete_flag(const char* flag_name, JDK_Version* version);
351 
352   // Returns 1 if the flag is deprecated (and not yet obsolete or expired).
353   //     In this case the 'version' buffer is filled in with the version number when
354   //     the flag became deprecated.
355   // Returns -1 if the flag is expired or obsolete.
356   // Returns 0 otherwise.
357   static int is_deprecated_flag(const char* flag_name, JDK_Version* version);
358 
359   // Return the real name for the flag passed on the command line (either an alias name or "flag_name").
360   static const char* real_flag_name(const char *flag_name);
361   static JVMFlag* find_jvm_flag(const char* name, size_t name_length);
362 
363   // Return the "real" name for option arg if arg is an alias, and print a warning if arg is deprecated.
364   // Return nullptr if the arg has expired.
365   static const char* handle_aliases_and_deprecation(const char* arg);
366 
367   static char*  _default_shared_archive_path;
368   static char*  SharedArchivePath;
369   static char*  SharedDynamicArchivePath;
370   static size_t _default_SharedBaseAddress; // The default value specified in globals.hpp
371   static void extract_shared_archive_paths(const char* archive_path,
372                                          char** base_archive_path,
373                                          char** top_archive_path) NOT_CDS_RETURN;
374 
375  public:
376   static int num_archives(const char* archive_path) NOT_CDS_RETURN_(0);
377   // Parses the arguments, first phase
378   static jint parse(const JavaVMInitArgs* args);
379   // Parse a string for a unsigned integer.  Returns true if value
380   // is an unsigned integer greater than or equal to the minimum
381   // parameter passed and returns the value in uint_arg.  Returns
382   // false otherwise, with uint_arg undefined.
383   static bool parse_uint(const char* value, uint* uintx_arg,
384                          uint min_size);
385   // Apply ergonomics
386   static jint apply_ergo();
387   // Adjusts the arguments after the OS have adjusted the arguments
388   static jint adjust_after_os();
389 
390   // Check consistency or otherwise of VM argument settings
391   static bool check_vm_args_consistency();
392   // Used by os_solaris
393   static bool process_settings_file(const char* file_name, bool should_exist, jboolean ignore_unrecognized);
394 
395   static size_t conservative_max_heap_alignment() { return _conservative_max_heap_alignment; }
396   // Return the maximum size a heap with compressed oops can take
397   static size_t max_heap_for_compressed_oops();
398 
399   // return a char* array containing all options
400   static char** jvm_flags_array()          { return _jvm_flags_array; }
401   static char** jvm_args_array()           { return _jvm_args_array; }
402   static int num_jvm_flags()               { return _num_jvm_flags; }
403   static int num_jvm_args()                { return _num_jvm_args; }
404   // return the arguments passed to the Java application
405   static const char* java_command()        { return _java_command; }
406 
407   // print jvm_flags, jvm_args and java_command
408   static void print_on(outputStream* st);
409   static void print_summary_on(outputStream* st);
410 
411   // convenient methods to get and set jvm_flags_file
412   static const char* get_jvm_flags_file()  { return _jvm_flags_file; }
413   static void set_jvm_flags_file(const char *value) {
414     if (_jvm_flags_file != nullptr) {
415       os::free(_jvm_flags_file);
416     }
417     _jvm_flags_file = os::strdup_check_oom(value);
418   }
419   // convenient methods to obtain / print jvm_flags and jvm_args
420   static const char* jvm_flags()           { return build_resource_string(_jvm_flags_array, _num_jvm_flags); }
421   static const char* jvm_args()            { return build_resource_string(_jvm_args_array, _num_jvm_args); }
422   static void print_jvm_flags_on(outputStream* st);
423   static void print_jvm_args_on(outputStream* st);
424 
425   // -Dkey=value flags
426   static SystemProperty*  system_properties()   { return _system_properties; }
427   static const char*    get_property(const char* key);
428 
429   // -Djava.vendor.url.bug
430   static const char* java_vendor_url_bug()  { return _java_vendor_url_bug; }
431 
432   // -Dsun.java.launcher
433   static const char* sun_java_launcher()    { return _sun_java_launcher; }
434   // Was VM created by a Java launcher?
435   static bool created_by_java_launcher();
436   // -Dsun.java.launcher.is_altjvm
437   static bool sun_java_launcher_is_altjvm();
438 
439   // abort, exit, vfprintf hooks
440   static abort_hook_t    abort_hook()       { return _abort_hook; }
441   static exit_hook_t     exit_hook()        { return _exit_hook; }
442   static vfprintf_hook_t vfprintf_hook()    { return _vfprintf_hook; }
443 
444   static const char* GetSharedArchivePath() { return SharedArchivePath; }
445   static const char* GetSharedDynamicArchivePath() { return SharedDynamicArchivePath; }
446   static size_t default_SharedBaseAddress() { return _default_SharedBaseAddress; }
447   // Java launcher properties
448   static void process_sun_java_launcher_properties(JavaVMInitArgs* args);
449 
450   // System properties
451   static void init_system_properties();
452 
453   // Update/Initialize System properties after JDK version number is known
454   static void init_version_specific_system_properties();
455 
456   // Update VM info property - called after argument parsing
457   static void update_vm_info_property(const char* vm_info) {
458     _vm_info->set_value(vm_info);
459   }
460 
461   // Property List manipulation
462   static void PropertyList_add(SystemProperty *element);
463   static void PropertyList_add(SystemProperty** plist, SystemProperty *element);
464   static void PropertyList_add(SystemProperty** plist, const char* k, const char* v, bool writeable, bool internal);
465 
466   static void PropertyList_unique_add(SystemProperty** plist, const char* k, const char* v,
467                                       PropertyAppendable append, PropertyWriteable writeable,
468                                       PropertyInternal internal);
469   static const char* PropertyList_get_value(SystemProperty* plist, const char* key);
470   static const char* PropertyList_get_readable_value(SystemProperty* plist, const char* key);
471   static int  PropertyList_count(SystemProperty* pl);
472   static int  PropertyList_readable_count(SystemProperty* pl);
473 
474   static bool is_internal_module_property(const char* option);
475 
476   // Miscellaneous System property value getter and setters.
477   static void set_dll_dir(const char *value) { _sun_boot_library_path->set_value(value); }
478   static void set_java_home(const char *value) { _java_home->set_value(value); }
479   static void set_library_path(const char *value) { _java_library_path->set_value(value); }
480   static void set_ext_dirs(char *value)     { _ext_dirs = os::strdup_check_oom(value); }
481 
482   // Set up the underlying pieces of the boot class path
483   static void add_patch_mod_prefix(const char *module_name, const char *path, bool* patch_mod_javabase);
484   static void set_boot_class_path(const char *value, bool has_jimage) {
485     // During start up, set by os::set_boot_path()
486     assert(get_boot_class_path() == nullptr, "Boot class path previously set");
487     _boot_class_path->set_value(value);
488     _has_jimage = has_jimage;
489   }
490   static void append_sysclasspath(const char *value) {
491     _boot_class_path->append_value(value);
492     _jdk_boot_class_path_append->append_value(value);
493   }
494 
495   static GrowableArray<ModulePatchPath*>* get_patch_mod_prefix() { return _patch_mod_prefix; }
496   static char* get_boot_class_path() { return _boot_class_path->value(); }
497   static bool has_jimage() { return _has_jimage; }
498 
499   static char* get_java_home()    { return _java_home->value(); }
500   static char* get_dll_dir()      { return _sun_boot_library_path->value(); }
501   static char* get_appclasspath() { return _java_class_path->value(); }
502   static void  fix_appclasspath();
503 
504   static char* get_default_shared_archive_path() NOT_CDS_RETURN_(nullptr);
505   static void  init_shared_archive_paths() NOT_CDS_RETURN;
506 
507   // Operation modi
508   static Mode mode()                { return _mode;           }
509   static bool is_interpreter_only() { return mode() == _int;  }
510   static bool is_compiler_only()    { return mode() == _comp; }
511 
512 
513   // preview features
514   static void set_enable_preview() { _enable_preview = true; }
515   static bool enable_preview() { return _enable_preview; }
516 
517   // Utility: copies src into buf, replacing "%%" with "%" and "%p" with pid.
518   static bool copy_expand_pid(const char* src, size_t srclen, char* buf, size_t buflen);
519 
520   static void check_unsupported_dumping_properties() NOT_CDS_RETURN;
521 
522   static bool check_unsupported_cds_runtime_properties() NOT_CDS_RETURN0;
523 
524   static bool atojulong(const char *s, julong* result);
525 
526   static bool has_jfr_option() NOT_JFR_RETURN_(false);
527 
528   DEBUG_ONLY(static bool verify_special_jvm_flags(bool check_globals);)
529 };
530 
531 // Disable options not supported in this release, with a warning if they
532 // were explicitly requested on the command-line
533 #define UNSUPPORTED_OPTION(opt)                          \
534 do {                                                     \
535   if (opt) {                                             \
536     if (FLAG_IS_CMDLINE(opt)) {                          \
537       warning("-XX:+" #opt " not supported in this VM"); \
538     }                                                    \
539     FLAG_SET_DEFAULT(opt, false);                        \
540   }                                                      \
541 } while(0)
542 
543 // similar to UNSUPPORTED_OPTION but sets flag to nullptr
544 #define UNSUPPORTED_OPTION_NULL(opt)                         \
545 do {                                                         \
546   if (opt) {                                                 \
547     if (FLAG_IS_CMDLINE(opt)) {                              \
548       warning("-XX flag " #opt " not supported in this VM"); \
549     }                                                        \
550     FLAG_SET_DEFAULT(opt, nullptr);                          \
551   }                                                          \
552 } while(0)
553 
554 // Initialize options not supported in this release, with a warning
555 // if they were explicitly requested on the command-line
556 #define UNSUPPORTED_OPTION_INIT(opt, value)              \
557 do {                                                     \
558   if (FLAG_IS_CMDLINE(opt)) {                            \
559     warning("-XX flag " #opt " not supported in this VM"); \
560   }                                                      \
561   FLAG_SET_DEFAULT(opt, value);                          \
562 } while(0)
563 
564 #endif // SHARE_RUNTIME_ARGUMENTS_HPP