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