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