1 /*
2 * Copyright (c) 1997, 2015, 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_VM_RUNTIME_ARGUMENTS_HPP
26 #define SHARE_VM_RUNTIME_ARGUMENTS_HPP
27
28 #include "runtime/java.hpp"
29 #include "runtime/os.hpp"
30 #include "runtime/perfData.hpp"
31 #include "utilities/debug.hpp"
32 #include "utilities/top.hpp"
33
34 // Arguments parses the command line and recognizes options
35
36 // Invocation API hook typedefs (these should really be defined in jni.hpp)
37 extern "C" {
38 typedef void (JNICALL *abort_hook_t)(void);
39 typedef void (JNICALL *exit_hook_t)(jint code);
40 typedef jint (JNICALL *vfprintf_hook_t)(FILE *fp, const char *format, va_list args) ATTRIBUTE_PRINTF(2, 0);
41 }
42
43 // Forward declarations
44
45 class SysClassPath;
46
47 // Element describing System and User (-Dkey=value flags) defined property.
48
49 class SystemProperty: public CHeapObj<mtInternal> {
50 private:
51 char* _key;
52 char* _value;
53 SystemProperty* _next;
54 bool _writeable;
55 bool writeable() { return _writeable; }
56
57 public:
58 // Accessors
59 const char* key() const { return _key; }
60 char* value() const { return _value; }
61 SystemProperty* next() const { return _next; }
62 void set_next(SystemProperty* next) { _next = next; }
63 bool set_value(char *value) {
64 if (writeable()) {
65 if (_value != NULL) {
66 FreeHeap(_value);
67 }
68 _value = AllocateHeap(strlen(value)+1, mtInternal);
69 if (_value != NULL) {
70 strcpy(_value, value);
71 }
72 return true;
73 }
74 return false;
75 }
76
77 void append_value(const char *value) {
78 char *sp;
79 size_t len = 0;
80 if (value != NULL) {
81 len = strlen(value);
82 if (_value != NULL) {
83 len += strlen(_value);
84 }
85 sp = AllocateHeap(len+2, mtInternal);
86 if (sp != NULL) {
87 if (_value != NULL) {
88 strcpy(sp, _value);
89 strcat(sp, os::path_separator());
90 strcat(sp, value);
91 FreeHeap(_value);
92 } else {
93 strcpy(sp, value);
94 }
95 _value = sp;
96 }
97 }
98 }
99
100 // Constructor
101 SystemProperty(const char* key, const char* value, bool writeable) {
102 if (key == NULL) {
103 _key = NULL;
104 } else {
105 _key = AllocateHeap(strlen(key)+1, mtInternal);
106 strcpy(_key, key);
107 }
108 if (value == NULL) {
109 _value = NULL;
110 } else {
111 _value = AllocateHeap(strlen(value)+1, mtInternal);
112 strcpy(_value, value);
113 }
114 _next = NULL;
115 _writeable = writeable;
116 }
117 };
118
119
120 // For use by -agentlib, -agentpath and -Xrun
121 class AgentLibrary : public CHeapObj<mtInternal> {
122 friend class AgentLibraryList;
123 public:
124 // Is this library valid or not. Don't rely on os_lib == NULL as statically
125 // linked lib could have handle of RTLD_DEFAULT which == 0 on some platforms
126 enum AgentState {
127 agent_invalid = 0,
128 agent_valid = 1
129 };
130
131 private:
132 char* _name;
133 char* _options;
134 void* _os_lib;
135 bool _is_absolute_path;
136 bool _is_static_lib;
137 AgentState _state;
138 AgentLibrary* _next;
139
140 public:
141 // Accessors
142 const char* name() const { return _name; }
143 char* options() const { return _options; }
144 bool is_absolute_path() const { return _is_absolute_path; }
145 void* os_lib() const { return _os_lib; }
146 void set_os_lib(void* os_lib) { _os_lib = os_lib; }
147 AgentLibrary* next() const { return _next; }
148 bool is_static_lib() const { return _is_static_lib; }
149 void set_static_lib(bool is_static_lib) { _is_static_lib = is_static_lib; }
150 bool valid() { return (_state == agent_valid); }
151 void set_valid() { _state = agent_valid; }
152 void set_invalid() { _state = agent_invalid; }
153
154 // Constructor
155 AgentLibrary(const char* name, const char* options, bool is_absolute_path, void* os_lib) {
156 _name = AllocateHeap(strlen(name)+1, mtInternal);
157 strcpy(_name, name);
158 if (options == NULL) {
159 _options = NULL;
160 } else {
161 _options = AllocateHeap(strlen(options)+1, mtInternal);
162 strcpy(_options, options);
163 }
164 _is_absolute_path = is_absolute_path;
165 _os_lib = os_lib;
166 _next = NULL;
167 _state = agent_invalid;
168 _is_static_lib = false;
169 }
170 };
171
172 // maintain an order of entry list of AgentLibrary
173 class AgentLibraryList VALUE_OBJ_CLASS_SPEC {
174 private:
175 AgentLibrary* _first;
176 AgentLibrary* _last;
177 public:
178 bool is_empty() const { return _first == NULL; }
179 AgentLibrary* first() const { return _first; }
180
181 // add to the end of the list
182 void add(AgentLibrary* lib) {
183 if (is_empty()) {
184 _first = _last = lib;
185 } else {
186 _last->_next = lib;
187 _last = lib;
188 }
189 lib->_next = NULL;
190 }
191
192 // search for and remove a library known to be in the list
193 void remove(AgentLibrary* lib) {
194 AgentLibrary* curr;
195 AgentLibrary* prev = NULL;
196 for (curr = first(); curr != NULL; prev = curr, curr = curr->next()) {
197 if (curr == lib) {
198 break;
199 }
200 }
201 assert(curr != NULL, "always should be found");
202
203 if (curr != NULL) {
204 // it was found, by-pass this library
205 if (prev == NULL) {
206 _first = curr->_next;
207 } else {
208 prev->_next = curr->_next;
209 }
210 if (curr == _last) {
211 _last = prev;
212 }
213 curr->_next = NULL;
214 }
215 }
216
217 AgentLibraryList() {
218 _first = NULL;
219 _last = NULL;
220 }
221 };
222
223 // Helper class for controlling the lifetime of JavaVMInitArgs objects.
224 class ScopedVMInitArgs;
225
226 class Arguments : AllStatic {
227 friend class VMStructs;
228 friend class JvmtiExport;
229 friend class CodeCacheExtensions;
230 public:
231 // Operation modi
232 enum Mode {
233 _int, // corresponds to -Xint
234 _mixed, // corresponds to -Xmixed
235 _comp // corresponds to -Xcomp
236 };
237
238 enum ArgsRange {
239 arg_unreadable = -3,
240 arg_too_small = -2,
241 arg_too_big = -1,
242 arg_in_range = 0
243 };
244
245 private:
246
247 // an array containing all flags specified in the .hotspotrc file
248 static char** _jvm_flags_array;
249 static int _num_jvm_flags;
250 // an array containing all jvm arguments specified in the command line
251 static char** _jvm_args_array;
252 static int _num_jvm_args;
253 // string containing all java command (class/jarfile name and app args)
254 static char* _java_command;
255
256 // Property list
257 static SystemProperty* _system_properties;
258
259 // Quick accessor to System properties in the list:
260 static SystemProperty *_sun_boot_library_path;
261 static SystemProperty *_java_library_path;
262 static SystemProperty *_java_home;
263 static SystemProperty *_java_class_path;
264 static SystemProperty *_sun_boot_class_path;
265
266 // temporary: to emit warning if the default ext dirs are not empty.
267 // remove this variable when the warning is no longer needed.
268 static char* _ext_dirs;
269
270 // java.vendor.url.bug, bug reporting URL for fatal errors.
271 static const char* _java_vendor_url_bug;
272
273 // sun.java.launcher, private property to provide information about
274 // java launcher
275 static const char* _sun_java_launcher;
276
277 // sun.java.launcher.pid, private property
278 static int _sun_java_launcher_pid;
279
280 // was this VM created via the -XXaltjvm=<path> option
281 static bool _sun_java_launcher_is_altjvm;
282
283 // Option flags
284 static bool _has_profile;
285 static const char* _gc_log_filename;
286 // Value of the conservative maximum heap alignment needed
287 static size_t _conservative_max_heap_alignment;
288
289 static uintx _min_heap_size;
290
291 // Used to store original flag values
292 static uintx _min_heap_free_ratio;
293 static uintx _max_heap_free_ratio;
294
295 // -Xrun arguments
296 static AgentLibraryList _libraryList;
297 static void add_init_library(const char* name, char* options)
298 { _libraryList.add(new AgentLibrary(name, options, false, NULL)); }
299
300 // -agentlib and -agentpath arguments
301 static AgentLibraryList _agentList;
302 static void add_init_agent(const char* name, char* options, bool absolute_path)
303 { _agentList.add(new AgentLibrary(name, options, absolute_path, NULL)); }
304
305 // Late-binding agents not started via arguments
306 static void add_loaded_agent(AgentLibrary *agentLib)
307 { _agentList.add(agentLib); }
308 static void add_loaded_agent(const char* name, char* options, bool absolute_path, void* os_lib)
309 { _agentList.add(new AgentLibrary(name, options, absolute_path, os_lib)); }
310
311 // Operation modi
312 static Mode _mode;
313 static void set_mode_flags(Mode mode);
314 static bool _java_compiler;
315 static void set_java_compiler(bool arg) { _java_compiler = arg; }
316 static bool java_compiler() { return _java_compiler; }
317
318 // -Xdebug flag
319 static bool _xdebug_mode;
320 static void set_xdebug_mode(bool arg) { _xdebug_mode = arg; }
321 static bool xdebug_mode() { return _xdebug_mode; }
322
323 // Used to save default settings
324 static bool _AlwaysCompileLoopMethods;
325 static bool _UseOnStackReplacement;
326 static bool _BackgroundCompilation;
327 static bool _ClipInlining;
328 static bool _CIDynamicCompilePriority;
329 static intx _Tier3InvokeNotifyFreqLog;
330 static intx _Tier4InvocationThreshold;
331
332 // Tiered
333 static void set_tiered_flags();
334 // CMS/ParNew garbage collectors
335 static void set_parnew_gc_flags();
336 static void set_cms_and_parnew_gc_flags();
337 // UseParallel[Old]GC
338 static void set_parallel_gc_flags();
339 // Garbage-First (UseG1GC)
340 static void set_g1_gc_flags();
341 // GC ergonomics
342 static void set_conservative_max_heap_alignment();
343 static void set_use_compressed_oops();
344 static void set_use_compressed_klass_ptrs();
345 static void select_gc();
346 static void set_ergonomics_flags();
347 static void set_shared_spaces_flags();
348 // limits the given memory size by the maximum amount of memory this process is
349 // currently allowed to allocate or reserve.
350 static julong limit_by_allocatable_memory(julong size);
351 // Setup heap size
352 static void set_heap_size();
353 // Set up runtime image flags
354 static void set_runtime_image_flags();
355 // Based on automatic selection criteria, should the
356 // low pause collector be used.
357 static bool should_auto_select_low_pause_collector();
358
359 // Bytecode rewriting
360 static void set_bytecode_flags();
361
362 // Invocation API hooks
363 static abort_hook_t _abort_hook;
364 static exit_hook_t _exit_hook;
365 static vfprintf_hook_t _vfprintf_hook;
366
367 // System properties
368 static bool add_property(const char* prop);
369
370 // Aggressive optimization flags.
371 static void set_aggressive_opts_flags();
372
373 // Argument parsing
374 static void do_pd_flag_adjustments();
375 static bool parse_argument(const char* arg, Flag::Flags origin);
376 static bool process_argument(const char* arg, jboolean ignore_unrecognized, Flag::Flags origin);
377 static void process_java_launcher_argument(const char*, void*);
378 static void process_java_compiler_argument(char* arg);
379 static jint parse_options_environment_variable(const char* name, ScopedVMInitArgs* vm_args);
380 static jint parse_java_tool_options_environment_variable(ScopedVMInitArgs* vm_args);
381 static jint parse_java_options_environment_variable(ScopedVMInitArgs* vm_args);
382 static jint parse_vm_init_args(const JavaVMInitArgs *java_tool_options_args,
383 const JavaVMInitArgs *java_options_args,
384 const JavaVMInitArgs *cmd_line_args);
385 static jint parse_each_vm_init_arg(const JavaVMInitArgs* args, SysClassPath* scp_p, bool* scp_assembly_required_p, Flag::Flags origin);
386 static jint finalize_vm_init_args(SysClassPath* scp_p, bool scp_assembly_required);
387 static bool is_bad_option(const JavaVMOption* option, jboolean ignore, const char* option_type);
388
389 static bool is_bad_option(const JavaVMOption* option, jboolean ignore) {
390 return is_bad_option(option, ignore, NULL);
391 }
392
393 static void describe_range_error(ArgsRange errcode);
394 static ArgsRange check_memory_size(julong size, julong min_size);
395 static ArgsRange parse_memory_size(const char* s, julong* long_arg,
396 julong min_size);
397 // Parse a string for a unsigned integer. Returns true if value
398 // is an unsigned integer greater than or equal to the minimum
399 // parameter passed and returns the value in uintx_arg. Returns
400 // false otherwise, with uintx_arg undefined.
401 static bool parse_uintx(const char* value, uintx* uintx_arg,
402 uintx min_size);
403
404 // methods to build strings from individual args
405 static void build_jvm_args(const char* arg);
406 static void build_jvm_flags(const char* arg);
407 static void add_string(char*** bldarray, int* count, const char* arg);
408 static const char* build_resource_string(char** args, int count);
409
410 static bool methodExists(
411 char* className, char* methodName,
412 int classesNum, char** classes, bool* allMethods,
413 int methodsNum, char** methods, bool* allClasses
414 );
415
416 static void parseOnlyLine(
417 const char* line,
418 short* classesNum, short* classesMax, char*** classes, bool** allMethods,
419 short* methodsNum, short* methodsMax, char*** methods, bool** allClasses
420 );
421
422 // Returns true if the string s is in the list of flags that have recently
423 // been made obsolete. If we detect one of these flags on the command
424 // line, instead of failing we print a warning message and ignore the
425 // flag. This gives the user a release or so to stop using the flag.
426 static bool is_newly_obsolete(const char* s, JDK_Version* buffer);
427
428 static short CompileOnlyClassesNum;
429 static short CompileOnlyClassesMax;
430 static char** CompileOnlyClasses;
431 static bool* CompileOnlyAllMethods;
432
433 static short CompileOnlyMethodsNum;
434 static short CompileOnlyMethodsMax;
435 static char** CompileOnlyMethods;
436 static bool* CompileOnlyAllClasses;
437
438 static short InterpretOnlyClassesNum;
439 static short InterpretOnlyClassesMax;
440 static char** InterpretOnlyClasses;
441 static bool* InterpretOnlyAllMethods;
442
443 static bool CheckCompileOnly;
444
445 static char* SharedArchivePath;
446
447 public:
448 // Scale compile thresholds
449 // Returns threshold scaled with CompileThresholdScaling
450 static intx scaled_compile_threshold(intx threshold, double scale);
451 static intx scaled_compile_threshold(intx threshold) {
452 return scaled_compile_threshold(threshold, CompileThresholdScaling);
453 }
454 // Returns freq_log scaled with CompileThresholdScaling
455 static intx scaled_freq_log(intx freq_log, double scale);
456 static intx scaled_freq_log(intx freq_log) {
457 return scaled_freq_log(freq_log, CompileThresholdScaling);
458 }
459
460 // Parses the arguments, first phase
461 static jint parse(const JavaVMInitArgs* args);
462 // Apply ergonomics
463 static jint apply_ergo();
464 // Adjusts the arguments after the OS have adjusted the arguments
465 static jint adjust_after_os();
466 // Set any arguments that need to be set after the 'CommandLineFlagConstraint::AfterErgo' constraint check
467 static void post_after_ergo_constraint_check(bool check_passed);
468
469 static void set_gc_specific_flags();
470 static inline bool gc_selected(); // whether a gc has been selected
471 static void select_gc_ergonomically();
472
473 // Check for consistency in the selection of the garbage collector.
474 static bool check_gc_consistency(); // Check user-selected gc
475 static void check_deprecated_gc_flags();
476 // Check consistency or otherwise of VM argument settings
477 static bool check_vm_args_consistency();
478 // Used by os_solaris
479 static bool process_settings_file(const char* file_name, bool should_exist, jboolean ignore_unrecognized);
480
481 static size_t conservative_max_heap_alignment() { return _conservative_max_heap_alignment; }
482 // Return the maximum size a heap with compressed oops can take
483 static size_t max_heap_for_compressed_oops();
484
485 // return a char* array containing all options
486 static char** jvm_flags_array() { return _jvm_flags_array; }
487 static char** jvm_args_array() { return _jvm_args_array; }
488 static int num_jvm_flags() { return _num_jvm_flags; }
489 static int num_jvm_args() { return _num_jvm_args; }
490 // return the arguments passed to the Java application
491 static const char* java_command() { return _java_command; }
492
493 // print jvm_flags, jvm_args and java_command
494 static void print_on(outputStream* st);
495 static void print_summary_on(outputStream* st);
496
497 // convenient methods to obtain / print jvm_flags and jvm_args
498 static const char* jvm_flags() { return build_resource_string(_jvm_flags_array, _num_jvm_flags); }
499 static const char* jvm_args() { return build_resource_string(_jvm_args_array, _num_jvm_args); }
500 static void print_jvm_flags_on(outputStream* st);
501 static void print_jvm_args_on(outputStream* st);
502
503 // -Dkey=value flags
504 static SystemProperty* system_properties() { return _system_properties; }
505 static const char* get_property(const char* key);
506
507 // -Djava.vendor.url.bug
508 static const char* java_vendor_url_bug() { return _java_vendor_url_bug; }
509
510 // -Dsun.java.launcher
511 static const char* sun_java_launcher() { return _sun_java_launcher; }
512 // Was VM created by a Java launcher?
513 static bool created_by_java_launcher();
514 // -Dsun.java.launcher.is_altjvm
515 static bool sun_java_launcher_is_altjvm();
516 // -Dsun.java.launcher.pid
517 static int sun_java_launcher_pid() { return _sun_java_launcher_pid; }
518
519 // -Xloggc:<file>, if not specified will be NULL
520 static const char* gc_log_filename() { return _gc_log_filename; }
521
522 // -Xprof
523 static bool has_profile() { return _has_profile; }
524
525 // -Xms
526 static size_t min_heap_size() { return _min_heap_size; }
527 static void set_min_heap_size(size_t v) { _min_heap_size = v; }
528
529 // Returns the original values of -XX:MinHeapFreeRatio and -XX:MaxHeapFreeRatio
530 static uintx min_heap_free_ratio() { return _min_heap_free_ratio; }
531 static uintx max_heap_free_ratio() { return _max_heap_free_ratio; }
532
533 // -Xrun
534 static AgentLibrary* libraries() { return _libraryList.first(); }
535 static bool init_libraries_at_startup() { return !_libraryList.is_empty(); }
536 static void convert_library_to_agent(AgentLibrary* lib)
537 { _libraryList.remove(lib);
538 _agentList.add(lib); }
539
540 // -agentlib -agentpath
541 static AgentLibrary* agents() { return _agentList.first(); }
542 static bool init_agents_at_startup() { return !_agentList.is_empty(); }
543
544 // abort, exit, vfprintf hooks
545 static abort_hook_t abort_hook() { return _abort_hook; }
546 static exit_hook_t exit_hook() { return _exit_hook; }
547 static vfprintf_hook_t vfprintf_hook() { return _vfprintf_hook; }
548
549 static bool GetCheckCompileOnly () { return CheckCompileOnly; }
550
551 static const char* GetSharedArchivePath() { return SharedArchivePath; }
552
553 static bool CompileMethod(char* className, char* methodName) {
554 return
555 methodExists(
556 className, methodName,
557 CompileOnlyClassesNum, CompileOnlyClasses, CompileOnlyAllMethods,
558 CompileOnlyMethodsNum, CompileOnlyMethods, CompileOnlyAllClasses
559 );
560 }
561
562 // Java launcher properties
563 static void process_sun_java_launcher_properties(JavaVMInitArgs* args);
564
565 // System properties
566 static void init_system_properties();
567
568 // Update/Initialize System properties after JDK version number is known
569 static void init_version_specific_system_properties();
570
571 // Property List manipulation
572 static void PropertyList_add(SystemProperty *element);
573 static void PropertyList_add(SystemProperty** plist, SystemProperty *element);
574 static void PropertyList_add(SystemProperty** plist, const char* k, char* v);
575 static void PropertyList_unique_add(SystemProperty** plist, const char* k, char* v) {
576 PropertyList_unique_add(plist, k, v, false);
577 }
578 static void PropertyList_unique_add(SystemProperty** plist, const char* k, char* v, jboolean append);
579 static const char* PropertyList_get_value(SystemProperty* plist, const char* key);
580 static int PropertyList_count(SystemProperty* pl);
581 static const char* PropertyList_get_key_at(SystemProperty* pl,int index);
582 static char* PropertyList_get_value_at(SystemProperty* pl,int index);
583
584 // Miscellaneous System property value getter and setters.
585 static void set_dll_dir(char *value) { _sun_boot_library_path->set_value(value); }
586 static void set_java_home(char *value) { _java_home->set_value(value); }
587 static void set_library_path(char *value) { _java_library_path->set_value(value); }
588 static void set_ext_dirs(char *value) { _ext_dirs = os::strdup_check_oom(value); }
589 static void set_sysclasspath(char *value) { _sun_boot_class_path->set_value(value); }
590 static void append_sysclasspath(const char *value) { _sun_boot_class_path->append_value(value); }
591
592 static char* get_java_home() { return _java_home->value(); }
593 static char* get_dll_dir() { return _sun_boot_library_path->value(); }
594 static char* get_sysclasspath() { return _sun_boot_class_path->value(); }
595 static char* get_ext_dirs() { return _ext_dirs; }
596 static char* get_appclasspath() { return _java_class_path->value(); }
597 static void fix_appclasspath();
598
599
600 // Operation modi
601 static Mode mode() { return _mode; }
602 static bool is_interpreter_only() { return mode() == _int; }
603
604
605 // Utility: copies src into buf, replacing "%%" with "%" and "%p" with pid.
606 static bool copy_expand_pid(const char* src, size_t srclen, char* buf, size_t buflen);
607 };
608
609 bool Arguments::gc_selected() {
610 return UseConcMarkSweepGC || UseG1GC || UseParallelGC || UseParallelOldGC || UseSerialGC;
611 }
612
613 // Disable options not supported in this release, with a warning if they
614 // were explicitly requested on the command-line
615 #define UNSUPPORTED_OPTION(opt, description) \
616 do { \
617 if (opt) { \
618 if (FLAG_IS_CMDLINE(opt)) { \
619 warning(description " is disabled in this release."); \
620 } \
621 FLAG_SET_DEFAULT(opt, false); \
622 } \
623 } while(0)
624
625 #endif // SHARE_VM_RUNTIME_ARGUMENTS_HPP