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 public:
122 // Is this library valid or not. Don't rely on os_lib == NULL as statically
123 // linked lib could have handle of RTLD_DEFAULT which == 0 on some platforms
124 enum AgentState {
125 agent_invalid = 0,
126 agent_valid = 1
127 };
128
129 private:
130 char* _name;
131 char* _options;
132 void* _os_lib;
133 bool _is_absolute_path;
134 bool _is_static_lib;
135 AgentState _state;
136 AgentLibrary* _next;
137
138 public:
139 // Accessors
140 const char* name() const { return _name; }
141 char* options() const { return _options; }
142 bool is_absolute_path() const { return _is_absolute_path; }
143 void* os_lib() const { return _os_lib; }
144 void set_os_lib(void* os_lib) { _os_lib = os_lib; }
145 AgentLibrary* next() const { return _next; }
146 bool is_static_lib() const { return _is_static_lib; }
147 void set_static_lib(bool static_lib) { _is_static_lib = static_lib; }
148 bool valid() { return (_state == agent_valid); }
149 void set_valid() { _state = agent_valid; }
150 void set_invalid() { _state = agent_invalid; }
151
152 // Constructor
153 AgentLibrary(const char* name, const char* options, bool is_absolute_path, void* os_lib) {
154 _name = AllocateHeap(strlen(name)+1, mtInternal);
155 strcpy(_name, name);
156 if (options == NULL) {
157 _options = NULL;
158 } else {
159 _options = AllocateHeap(strlen(options)+1, mtInternal);
160 strcpy(_options, options);
161 }
162 _is_absolute_path = is_absolute_path;
163 _os_lib = os_lib;
164 _next = NULL;
165 _state = agent_invalid;
166 _is_static_lib = false;
167 }
168 };
169
170 // maintain an order of entry list of AgentLibrary
171 class AgentLibraryList VALUE_OBJ_CLASS_SPEC {
172 private:
173 AgentLibrary* _first;
174 AgentLibrary* _last;
175 public:
176 bool is_empty() const { return _first == NULL; }
177 AgentLibrary* first() const { return _first; }
178
179 // add to the end of the list
180 void add(AgentLibrary* lib) {
181 if (is_empty()) {
182 _first = _last = lib;
183 } else {
184 _last->_next = lib;
185 _last = lib;
186 }
187 lib->_next = NULL;
188 }
189
190 // search for and remove a library known to be in the list
191 void remove(AgentLibrary* lib) {
192 AgentLibrary* curr;
193 AgentLibrary* prev = NULL;
194 for (curr = first(); curr != NULL; prev = curr, curr = curr->next()) {
195 if (curr == lib) {
196 break;
197 }
198 }
199 assert(curr != NULL, "always should be found");
200
201 if (curr != NULL) {
202 // it was found, by-pass this library
203 if (prev == NULL) {
204 _first = curr->_next;
205 } else {
206 prev->_next = curr->_next;
207 }
208 if (curr == _last) {
209 _last = prev;
210 }
211 curr->_next = NULL;
212 }
213 }
214
215 AgentLibraryList() {
216 _first = NULL;
217 _last = NULL;
218 }
219 };
220
221
222 class Arguments : AllStatic {
223 friend class VMStructs;
224 friend class JvmtiExport;
225 public:
226 // Operation modi
227 enum Mode {
228 _int, // corresponds to -Xint
229 _mixed, // corresponds to -Xmixed
230 _comp // corresponds to -Xcomp
231 };
232
233 enum ArgsRange {
234 arg_unreadable = -3,
235 arg_too_small = -2,
236 arg_too_big = -1,
237 arg_in_range = 0
238 };
239
240 private:
241
242 // an array containing all flags specified in the .hotspotrc file
243 static char** _jvm_flags_array;
244 static int _num_jvm_flags;
245 // an array containing all jvm arguments specified in the command line
246 static char** _jvm_args_array;
247 static int _num_jvm_args;
248 // string containing all java command (class/jarfile name and app args)
249 static char* _java_command;
250
251 // Property list
252 static SystemProperty* _system_properties;
253
254 // Quick accessor to System properties in the list:
255 static SystemProperty *_java_ext_dirs;
256 static SystemProperty *_java_endorsed_dirs;
257 static SystemProperty *_sun_boot_library_path;
258 static SystemProperty *_java_library_path;
259 static SystemProperty *_java_home;
260 static SystemProperty *_java_class_path;
261 static SystemProperty *_sun_boot_class_path;
262
263 // Meta-index for knowing what packages are in the boot class path
264 static char* _meta_index_path;
265 static char* _meta_index_dir;
266
267 // java.vendor.url.bug, bug reporting URL for fatal errors.
268 static const char* _java_vendor_url_bug;
269
270 // sun.java.launcher, private property to provide information about
271 // java/gamma launcher
272 static const char* _sun_java_launcher;
273
274 // sun.java.launcher.pid, private property
275 static int _sun_java_launcher_pid;
276
277 // was this VM created by the gamma launcher
278 static bool _created_by_gamma_launcher;
279
280 // Option flags
281 static bool _has_profile;
282 static const char* _gc_log_filename;
283 static uintx _min_heap_size;
284
285 // -Xrun arguments
286 static AgentLibraryList _libraryList;
287 static void add_init_library(const char* name, char* options)
288 { _libraryList.add(new AgentLibrary(name, options, false, NULL)); }
289
290 // -agentlib and -agentpath arguments
291 static AgentLibraryList _agentList;
292 static void add_init_agent(const char* name, char* options, bool absolute_path)
293 { _agentList.add(new AgentLibrary(name, options, absolute_path, NULL)); }
294
295 // Late-binding agents not started via arguments
296 static void add_loaded_agent(AgentLibrary *agentLib)
297 { _agentList.add(agentLib); }
298 static void add_loaded_agent(const char* name, char* options, bool absolute_path, void* os_lib)
299 { _agentList.add(new AgentLibrary(name, options, absolute_path, os_lib)); }
300
301 // Operation modi
302 static Mode _mode;
303 static void set_mode_flags(Mode mode);
304 static bool _java_compiler;
305 static void set_java_compiler(bool arg) { _java_compiler = arg; }
306 static bool java_compiler() { return _java_compiler; }
307
308 // -Xdebug flag
309 static bool _xdebug_mode;
310 static void set_xdebug_mode(bool arg) { _xdebug_mode = arg; }
311 static bool xdebug_mode() { return _xdebug_mode; }
312
313 // Used to save default settings
314 static bool _AlwaysCompileLoopMethods;
315 static bool _UseOnStackReplacement;
316 static bool _BackgroundCompilation;
317 static bool _ClipInlining;
318 static bool _CIDynamicCompilePriority;
319
320 // Tiered
321 static void set_tiered_flags();
322 // CMS/ParNew garbage collectors
323 static void set_parnew_gc_flags();
324 static void set_cms_and_parnew_gc_flags();
325 // UseParallel[Old]GC
326 static void set_parallel_gc_flags();
327 // Garbage-First (UseG1GC)
328 static void set_g1_gc_flags();
329 // GC ergonomics
330 static void set_use_compressed_oops();
331 static void set_ergonomics_flags();
332 static void set_shared_spaces_flags();
333 // limits the given memory size by the maximum amount of memory this process is
334 // currently allowed to allocate or reserve.
335 static julong limit_by_allocatable_memory(julong size);
336 // Setup HeapBaseMinAddress
337 static void set_heap_base_min_address();
338 // Setup heap size
339 static void set_heap_size();
340 // Based on automatic selection criteria, should the
341 // low pause collector be used.
342 static bool should_auto_select_low_pause_collector();
343
344 // Bytecode rewriting
345 static void set_bytecode_flags();
346
347 // Invocation API hooks
348 static abort_hook_t _abort_hook;
349 static exit_hook_t _exit_hook;
350 static vfprintf_hook_t _vfprintf_hook;
351
352 // System properties
353 static bool add_property(const char* prop);
354
355 // Aggressive optimization flags.
356 static void set_aggressive_opts_flags();
357
358 // Argument parsing
359 static void do_pd_flag_adjustments();
360 static bool parse_argument(const char* arg, FlagValueOrigin origin);
361 static bool process_argument(const char* arg, jboolean ignore_unrecognized, FlagValueOrigin origin);
362 static void process_java_launcher_argument(const char*, void*);
363 static void process_java_compiler_argument(char* arg);
364 static jint parse_options_environment_variable(const char* name, SysClassPath* scp_p, bool* scp_assembly_required_p);
365 static jint parse_java_tool_options_environment_variable(SysClassPath* scp_p, bool* scp_assembly_required_p);
366 static jint parse_java_options_environment_variable(SysClassPath* scp_p, bool* scp_assembly_required_p);
367 static jint parse_vm_init_args(const JavaVMInitArgs* args);
368 static jint parse_each_vm_init_arg(const JavaVMInitArgs* args, SysClassPath* scp_p, bool* scp_assembly_required_p, FlagValueOrigin origin);
369 static jint finalize_vm_init_args(SysClassPath* scp_p, bool scp_assembly_required);
370 static bool is_bad_option(const JavaVMOption* option, jboolean ignore,
371 const char* option_type);
372 static bool is_bad_option(const JavaVMOption* option, jboolean ignore) {
373 return is_bad_option(option, ignore, NULL);
374 }
375 static bool verify_interval(uintx val, uintx min,
376 uintx max, const char* name);
377 static bool verify_min_value(intx val, intx min, const char* name);
378 static bool verify_percentage(uintx value, const char* name);
379 static void describe_range_error(ArgsRange errcode);
380 static ArgsRange check_memory_size(julong size, julong min_size);
381 static ArgsRange parse_memory_size(const char* s, julong* long_arg,
382 julong min_size);
383 // Parse a string for a unsigned integer. Returns true if value
384 // is an unsigned integer greater than or equal to the minimum
385 // parameter passed and returns the value in uintx_arg. Returns
386 // false otherwise, with uintx_arg undefined.
387 static bool parse_uintx(const char* value, uintx* uintx_arg,
388 uintx min_size);
389
390 // methods to build strings from individual args
391 static void build_jvm_args(const char* arg);
392 static void build_jvm_flags(const char* arg);
393 static void add_string(char*** bldarray, int* count, const char* arg);
394 static const char* build_resource_string(char** args, int count);
395
396 static bool methodExists(
397 char* className, char* methodName,
398 int classesNum, char** classes, bool* allMethods,
399 int methodsNum, char** methods, bool* allClasses
400 );
401
402 static void parseOnlyLine(
403 const char* line,
404 short* classesNum, short* classesMax, char*** classes, bool** allMethods,
405 short* methodsNum, short* methodsMax, char*** methods, bool** allClasses
406 );
407
408 // Returns true if the string s is in the list of flags that have recently
409 // been made obsolete. If we detect one of these flags on the command
410 // line, instead of failing we print a warning message and ignore the
411 // flag. This gives the user a release or so to stop using the flag.
412 static bool is_newly_obsolete(const char* s, JDK_Version* buffer);
413
414 static short CompileOnlyClassesNum;
415 static short CompileOnlyClassesMax;
416 static char** CompileOnlyClasses;
417 static bool* CompileOnlyAllMethods;
418
419 static short CompileOnlyMethodsNum;
420 static short CompileOnlyMethodsMax;
421 static char** CompileOnlyMethods;
422 static bool* CompileOnlyAllClasses;
423
424 static short InterpretOnlyClassesNum;
425 static short InterpretOnlyClassesMax;
426 static char** InterpretOnlyClasses;
427 static bool* InterpretOnlyAllMethods;
428
429 static bool CheckCompileOnly;
430
431 static char* SharedArchivePath;
432
433 public:
434 // Parses the arguments
435 static jint parse(const JavaVMInitArgs* args);
436 // Adjusts the arguments after the OS have adjusted the arguments
437 static jint adjust_after_os();
438 // Check for consistency in the selection of the garbage collector.
439 static bool check_gc_consistency();
440 static void check_deprecated_gcs();
441 static void check_deprecated_gc_flags();
442 // Check consistecy or otherwise of VM argument settings
443 static bool check_vm_args_consistency();
444 // Check stack pages settings
445 static bool check_stack_pages();
446 // Used by os_solaris
447 static bool process_settings_file(const char* file_name, bool should_exist, jboolean ignore_unrecognized);
448
449 // return a char* array containing all options
450 static char** jvm_flags_array() { return _jvm_flags_array; }
451 static char** jvm_args_array() { return _jvm_args_array; }
452 static int num_jvm_flags() { return _num_jvm_flags; }
453 static int num_jvm_args() { return _num_jvm_args; }
454 // return the arguments passed to the Java application
455 static const char* java_command() { return _java_command; }
456
457 // print jvm_flags, jvm_args and java_command
458 static void print_on(outputStream* st);
459
460 // convenient methods to obtain / print jvm_flags and jvm_args
461 static const char* jvm_flags() { return build_resource_string(_jvm_flags_array, _num_jvm_flags); }
462 static const char* jvm_args() { return build_resource_string(_jvm_args_array, _num_jvm_args); }
463 static void print_jvm_flags_on(outputStream* st);
464 static void print_jvm_args_on(outputStream* st);
465
466 // -Dkey=value flags
467 static SystemProperty* system_properties() { return _system_properties; }
468 static const char* get_property(const char* key);
469
470 // -Djava.vendor.url.bug
471 static const char* java_vendor_url_bug() { return _java_vendor_url_bug; }
472
473 // -Dsun.java.launcher
474 static const char* sun_java_launcher() { return _sun_java_launcher; }
475 // Was VM created by a Java launcher?
476 static bool created_by_java_launcher();
477 // Was VM created by the gamma Java launcher?
478 static bool created_by_gamma_launcher();
479 // -Dsun.java.launcher.pid
480 static int sun_java_launcher_pid() { return _sun_java_launcher_pid; }
481
482 // -Xloggc:<file>, if not specified will be NULL
483 static const char* gc_log_filename() { return _gc_log_filename; }
484
485 // -Xprof
486 static bool has_profile() { return _has_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