1 /* src/vmcore/options.c - contains global options
3 Copyright (C) 1996-2005, 2006, 2007, 2008
4 CACAOVM - Verein zur Foerderung der freien virtuellen Maschine CACAO
6 This file is part of CACAO.
8 This program is free software; you can redistribute it and/or
9 modify it under the terms of the GNU General Public License as
10 published by the Free Software Foundation; either version 2, or (at
11 your option) any later version.
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
33 #include "mm/memory.h"
35 #include "native/jni.h"
39 #include "vmcore/options.h"
40 #include "vmcore/system.h"
43 /* command line option ********************************************************/
45 s4 opt_index = 0; /* index of processed arguments */
46 char *opt_arg; /* this one exports the option argument */
48 bool opt_foo = false; /* option for development */
52 #if defined(ENABLE_JIT)
53 bool opt_jit = true; /* JIT mode execution (default) */
54 bool opt_intrp = false; /* interpreter mode execution */
56 bool opt_jit = false; /* JIT mode execution */
57 bool opt_intrp = true; /* interpreter mode execution (default) */
62 s4 opt_heapmaxsize = 0; /* maximum heap size */
63 s4 opt_heapstartsize = 0; /* initial heap size */
64 s4 opt_stacksize = 0; /* thread stack size */
66 bool opt_verbose = false;
67 bool opt_debugcolor = false; /* use ANSI terminal sequences */
68 bool compileall = false;
70 bool loadverbose = false;
71 bool initverbose = false;
73 bool opt_verboseclass = false;
74 bool opt_verbosegc = false;
75 bool opt_verbosejni = false;
76 bool opt_verbosecall = false; /* trace all method invocation */
78 bool showmethods = false;
79 bool showconstantpool = false;
82 char *opt_method = NULL;
83 char *opt_signature = NULL;
85 bool compileverbose = false; /* trace compiler actions */
86 bool showstack = false;
88 bool opt_showdisassemble = false; /* generate disassembler listing */
89 bool opt_shownops = false;
90 bool opt_showddatasegment = false; /* generate data segment listing */
91 bool opt_showintermediate = false; /* generate intermediate code listing */
93 bool checkbounds = true; /* check array bounds */
94 bool opt_noieee = false; /* don't implement ieee compliant floats */
95 bool checksync = true; /* do synchronization */
96 #if defined(ENABLE_LOOP)
97 bool opt_loops = false; /* optimize array accesses in loops */
100 bool makeinitializations = true;
102 #if defined(ENABLE_STATISTICS)
103 bool opt_stat = false;
104 bool opt_getloadingtime = false; /* to measure the runtime */
105 bool opt_getcompilingtime = false; /* compute compile time */
107 #if defined(ENABLE_VERIFIER)
108 bool opt_verify = true; /* true if classfiles should be verified */
111 #if defined(ENABLE_PROFILING)
112 bool opt_prof = false;
113 bool opt_prof_bb = false;
117 /* optimization options *******************************************************/
119 #if defined(ENABLE_IFCONV)
120 bool opt_ifconv = false;
123 #if defined(ENABLE_LSRA) || defined(ENABLE_SSA)
124 bool opt_lsra = false;
126 #if defined(ENABLE_SSA)
127 bool opt_ssa_dce = false; /* enable dead code elemination */
128 bool opt_ssa_cp = false; /* enable copy propagation */
132 /* interpreter options ********************************************************/
134 #if defined(ENABLE_INTRP)
135 bool opt_no_dynamic = false; /* suppress dynamic superinstructions */
136 bool opt_no_replication = false; /* don't use replication in intrp */
137 bool opt_no_quicksuper = false; /* instructions for quickening cannot be
138 part of dynamic superinstructions */
140 s4 opt_static_supers = 0x7fffffff;
141 bool vm_debug = false; /* XXX this should be called `opt_trace' */
144 #if defined(ENABLE_DEBUG_FILTER)
145 const char *opt_filter_verbosecall_include = 0;
146 const char *opt_filter_verbosecall_exclude = 0;
147 const char *opt_filter_show_method = 0;
151 /* -XX options ****************************************************************/
153 /* NOTE: For better readability keep these alpha-sorted. */
155 /* Options which must always be available (production options in
158 int64_t opt_MaxDirectMemorySize = -1;
159 int opt_MaxPermSize = 0;
160 int opt_PermSize = 0;
161 int opt_ThreadStackSize = 0;
163 /* Debugging options which can be turned off. */
165 int opt_DebugExceptions = 0;
166 int opt_DebugFinalizer = 0;
167 int opt_DebugLocalReferences = 0;
168 int opt_DebugLocks = 0;
169 int opt_DebugPackage = 0;
170 int opt_DebugPatcher = 0;
171 int opt_DebugProperties = 0;
172 int opt_DebugStackFrameInfo = 0;
173 int opt_DebugStackTrace = 0;
174 int opt_DebugThreads = 0;
175 #if defined(ENABLE_DISASSEMBLER)
176 int opt_DisassembleStubs = 0;
178 #if defined(ENABLE_GC_CACAO)
179 int opt_GCDebugRootSet = 0;
180 int opt_GCStress = 0;
182 #if defined(ENABLE_INLINING)
184 #if defined(ENABLE_INLINING_DEBUG) || !defined(NDEBUG)
185 int opt_InlineAll = 0;
186 int opt_InlineCount = INT_MAX;
187 int opt_InlineMaxSize = INT_MAX;
188 int opt_InlineMinSize = 0;
191 int opt_PrintConfig = 0;
192 int opt_ProfileGCMemoryUsage = 0;
193 int opt_ProfileMemoryUsage = 0;
194 FILE *opt_ProfileMemoryUsageGNUPlot = NULL;
195 #if defined(ENABLE_REPLACEMENT)
196 int opt_TestReplacement = 0;
198 int opt_TraceCompilerCalls = 0;
199 int opt_TraceExceptions = 0;
200 #if defined(ENABLE_INLINING) && !defined(NDEBUG)
201 int opt_TraceInlining = 0;
203 int opt_TraceJavaCalls = 0;
204 int opt_TraceJNICalls = 0;
205 int opt_TraceJVMCalls = 0;
206 int opt_TraceJVMCallsVerbose = 0;
207 int opt_TraceLinkClass = 0;
208 #if defined(ENABLE_REPLACEMENT)
209 int opt_TraceReplacement = 0;
211 int opt_TraceSubsystemInitialization = 0;
212 int opt_TraceTraps = 0;
221 /* Options which must always be available (production options in
224 OPT_MaxDirectMemorySize,
229 /* Debugging options which can be turned off. */
233 OPT_DebugLocalReferences,
238 OPT_DebugStackFrameInfo,
241 OPT_DisassembleStubs,
250 OPT_ProfileGCMemoryUsage,
251 OPT_ProfileMemoryUsage,
252 OPT_ProfileMemoryUsageGNUPlot,
254 OPT_TraceCompilerCalls,
260 OPT_TraceJVMCallsVerbose,
262 OPT_TraceReplacement,
263 OPT_TraceSubsystemInitialization,
271 option_t options_XX[] = {
272 /* Options which must always be available (production options in
275 { "MaxDirectMemorySize", OPT_MaxDirectMemorySize, OPT_TYPE_VALUE, "Maximum total size of NIO direct-buffer allocations" },
276 { "MaxPermSize", OPT_MaxPermSize, OPT_TYPE_VALUE, "not implemented" },
277 { "PermSize", OPT_PermSize, OPT_TYPE_VALUE, "not implemented" },
278 { "ThreadStackSize", OPT_ThreadStackSize, OPT_TYPE_VALUE, "TODO" },
280 /* Debugging options which can be turned off. */
282 { "DebugExceptions", OPT_DebugExceptions, OPT_TYPE_BOOLEAN, "debug exceptions" },
283 { "DebugFinalizer", OPT_DebugFinalizer, OPT_TYPE_BOOLEAN, "debug finalizer thread" },
284 { "DebugLocalReferences", OPT_DebugLocalReferences, OPT_TYPE_BOOLEAN, "print debug information for local reference tables" },
285 { "DebugLocks", OPT_DebugLocks, OPT_TYPE_BOOLEAN, "print debug information for locks" },
286 { "DebugPackage", OPT_DebugPackage, OPT_TYPE_BOOLEAN, "debug Java boot-packages" },
287 { "DebugPatcher", OPT_DebugPatcher, OPT_TYPE_BOOLEAN, "debug JIT code patching" },
288 { "DebugProperties", OPT_DebugProperties, OPT_TYPE_BOOLEAN, "print debug information for properties" },
289 { "DebugStackFrameInfo", OPT_DebugStackFrameInfo, OPT_TYPE_BOOLEAN, "TODO" },
290 { "DebugStackTrace", OPT_DebugStackTrace, OPT_TYPE_BOOLEAN, "debug stacktrace creation" },
291 { "DebugThreads", OPT_DebugThreads, OPT_TYPE_BOOLEAN, "print debug information for threads" },
292 #if defined(ENABLE_DISASSEMBLER)
293 { "DisassembleStubs", OPT_DisassembleStubs, OPT_TYPE_BOOLEAN, "disassemble builtin and native stubs when generated" },
295 #if defined(ENABLE_GC_CACAO)
296 { "GCDebugRootSet", OPT_GCDebugRootSet, OPT_TYPE_BOOLEAN, "GC: print root-set at collection" },
297 { "GCStress", OPT_GCStress, OPT_TYPE_BOOLEAN, "GC: forced collection at every allocation" },
299 #if defined(ENABLE_INLINING)
300 { "Inline", OPT_Inline, OPT_TYPE_BOOLEAN, "enable method inlining" },
301 #if defined(ENABLE_INLINING_DEBUG) || !defined(NDEBUG)
302 { "InlineAll", OPT_InlineAll, OPT_TYPE_BOOLEAN, "use inlining in all compilations" },
303 { "InlineCount", OPT_InlineCount, OPT_TYPE_VALUE, "stop inlining after the given number of roots" },
304 { "InlineMaxSize", OPT_InlineMaxSize, OPT_TYPE_VALUE, "maximum size for inlined result" },
305 { "InlineMinSize", OPT_InlineMinSize, OPT_TYPE_VALUE, "minimum size for inlined result" },
308 { "PrintConfig", OPT_PrintConfig, OPT_TYPE_BOOLEAN, "print VM configuration" },
309 { "ProfileGCMemoryUsage", OPT_ProfileGCMemoryUsage, OPT_TYPE_VALUE, "profiles GC memory usage in the given interval, <value> is in seconds (default: 5)" },
310 { "ProfileMemoryUsage", OPT_ProfileMemoryUsage, OPT_TYPE_VALUE, "TODO" },
311 { "ProfileMemoryUsageGNUPlot", OPT_ProfileMemoryUsageGNUPlot, OPT_TYPE_VALUE, "TODO" },
312 #if defined(ENABLE_REPLACEMENT)
313 { "TestReplacement", OPT_TestReplacement, OPT_TYPE_BOOLEAN, "activate all replacement points during code generation" },
315 { "TraceCompilerCalls", OPT_TraceCompilerCalls, OPT_TYPE_BOOLEAN, "trace JIT compiler calls" },
316 { "TraceExceptions", OPT_TraceExceptions, OPT_TYPE_BOOLEAN, "trace Exception throwing" },
317 #if defined(ENABLE_INLINING) && !defined(NDEBUG)
318 { "TraceInlining", OPT_TraceInlining, OPT_TYPE_VALUE, "trace method inlining with the given verbosity level (default: 1)" },
320 #if !defined(ENABLE_VMLOG)
321 { "TraceJavaCalls", OPT_TraceJavaCalls, OPT_TYPE_BOOLEAN, "trace Java method calls" },
323 { "TraceJNICalls", OPT_TraceJNICalls, OPT_TYPE_BOOLEAN, "trace JNI method calls" },
324 { "TraceJVMCalls", OPT_TraceJVMCalls, OPT_TYPE_BOOLEAN, "trace JVM method calls but omit very frequent ones" },
325 { "TraceJVMCallsVerbose", OPT_TraceJVMCallsVerbose, OPT_TYPE_BOOLEAN, "trace all JVM method calls" },
326 { "TraceLinkClass", OPT_TraceLinkClass, OPT_TYPE_BOOLEAN, "trace class linking" },
327 #if defined(ENABLE_REPLACEMENT)
328 { "TraceReplacement", OPT_TraceReplacement, OPT_TYPE_VALUE, "trace on-stack replacement with the given verbosity level (default: 1)" },
330 { "TraceSubsystemInitialization", OPT_TraceSubsystemInitialization, OPT_TYPE_BOOLEAN, "trace initialization of subsystems" },
331 { "TraceTraps", OPT_TraceTraps, OPT_TYPE_BOOLEAN, "trace traps generated by JIT code" },
332 #if defined(ENABLE_VMLOG)
333 { "Vmlog", OPT_Vmlog, OPT_TYPE_VALUE, "prefix for vmlog trace files (enables vmlog)" },
334 { "VmlogStrings", OPT_VmlogStrings, OPT_TYPE_VALUE, "prefix of vmlog string file to load" },
335 { "VmlogIgnore", OPT_VmlogIgnore, OPT_TYPE_VALUE, "prefix of vmlog ignore file to load" },
340 { NULL, -1, -1, NULL }
344 /* options_get *****************************************************************
348 *******************************************************************************/
350 int options_get(opt_struct *opts, JavaVMInitArgs *vm_args)
355 if (opt_index >= vm_args->nOptions)
358 /* get the current option */
360 option = vm_args->options[opt_index].optionString;
362 if ((option == NULL) || (option[0] != '-'))
365 for (i = 0; opts[i].name; i++) {
367 /* boolean option found */
369 if (strcmp(option + 1, opts[i].name) == 0) {
371 return opts[i].value;
375 /* parameter option found */
377 /* with a space between */
379 if (strcmp(option + 1, opts[i].name) == 0) {
382 if (opt_index < vm_args->nOptions) {
383 opt_arg = system_strdup(vm_args->options[opt_index].optionString);
385 return opts[i].value;
391 /* parameter and option have no space between */
393 /* FIXME: this assumption is plain wrong, hits you if there is a
394 * parameter with no argument starting with same letter as param with argument
395 * but named after that one, ouch! */
397 size_t l = system_strlen(opts[i].name);
399 if (system_strlen(option + 1) > l) {
400 if (memcmp(option + 1, opts[i].name, l) == 0) {
402 opt_arg = system_strdup(option + 1 + l);
403 return opts[i].value;
414 /* options_xxusage *************************************************************
416 Print usage message for debugging options.
418 *******************************************************************************/
420 static void options_xxusage(void)
427 /* Prevent compiler warning. */
431 for (opt = options_XX; opt->name != NULL; opt++) {
435 case OPT_TYPE_BOOLEAN:
436 printf("+%s", opt->name);
437 length = system_strlen(" -XX:+") + system_strlen(opt->name);
441 printf("%s=<value>", opt->name);
442 length = system_strlen(" -XX:") + system_strlen(opt->name) +
443 system_strlen("=<value>");
447 vm_abort("options_xxusage: unkown option type %d", opt->type);
450 /* Check if the help fits into one 80-column line.
451 Documentation starts at column 29. */
453 if (length < (29 - 1)) {
454 /* Print missing spaces up to column 29. */
456 for (i = length; i < 29; i++)
461 printf(" "); /* 29 spaces */
464 /* Check documentation length. */
466 length = system_strlen(opt->doc);
468 if (length < (80 - 29)) {
469 printf("%s", opt->doc);
472 for (c = opt->doc, i = 29; *c != 0; c++, i++) {
473 /* If we are at the end of the line, break it. */
477 printf(" "); /* 29 spaces */
488 /* exit with error code */
494 /* options_xx ******************************************************************
498 *******************************************************************************/
500 void options_xx(JavaVMInitArgs *vm_args)
513 /* Iterate over all passed options. */
515 for (i = 0; i < vm_args->nOptions; i++) {
516 /* Get the current option. */
518 name = vm_args->options[i].optionString;
520 /* Check for help (-XX). */
522 if (strcmp(name, "-XX") == 0)
525 /* Check if the option start with -XX. */
527 start = strstr(name, "-XX:");
529 if ((start == NULL) || (start != name))
532 /* Check if the option is a boolean option. */
534 if (name[4] == '+') {
535 start = name + 4 + 1;
538 else if (name[4] == '-') {
539 start = name + 4 + 1;
547 /* Search for a '=' in the option name and get the option name
548 length and the value of the option. */
550 end = strchr(start, '=');
553 length = system_strlen(start);
557 length = end - start;
561 /* Search the option in the option array. */
563 for (opt = options_XX; opt->name != NULL; opt++) {
564 if (strncmp(opt->name, start, length) == 0) {
565 /* Check if the options passed fits to the type. */
568 case OPT_TYPE_BOOLEAN:
569 if ((enable == -1) || (value != NULL))
573 if ((enable != -1) || (value == NULL))
577 vm_abort("options_xx: unknown option type %d for option %s",
578 opt->type, opt->name);
585 /* Process the option. */
587 switch (opt->value) {
589 /* Options which must always be available (production options
592 case OPT_MaxDirectMemorySize:
593 opt_MaxDirectMemorySize = system_atoi(value);
596 case OPT_MaxPermSize:
597 /* Currently ignored. */
601 /* Currently ignored. */
604 case OPT_ThreadStackSize:
605 /* currently ignored */
608 /* Debugging options which can be turned off. */
610 case OPT_DebugExceptions:
611 opt_DebugExceptions = enable;
614 case OPT_DebugFinalizer:
615 opt_DebugFinalizer = enable;
618 case OPT_DebugLocalReferences:
619 opt_DebugLocalReferences = enable;
623 opt_DebugLocks = enable;
626 case OPT_DebugPackage:
627 opt_DebugPackage = enable;
630 case OPT_DebugPatcher:
631 opt_DebugPatcher = enable;
634 case OPT_DebugProperties:
635 opt_DebugProperties = enable;
638 case OPT_DebugStackFrameInfo:
639 opt_DebugStackFrameInfo = enable;
642 case OPT_DebugStackTrace:
643 opt_DebugStackTrace = enable;
646 case OPT_DebugThreads:
647 opt_DebugThreads = enable;
650 #if defined(ENABLE_DISASSEMBLER)
651 case OPT_DisassembleStubs:
652 opt_DisassembleStubs = enable;
656 #if defined(ENABLE_GC_CACAO)
657 case OPT_GCDebugRootSet:
658 opt_GCDebugRootSet = enable;
662 opt_GCStress = enable;
666 #if defined(ENABLE_INLINING)
670 #if defined(ENABLE_INLINING_DEBUG) || !defined(NDEBUG)
672 opt_InlineAll = enable;
675 case OPT_InlineCount:
677 opt_InlineCount = system_atoi(value);
680 case OPT_InlineMaxSize:
682 opt_InlineMaxSize = system_atoi(value);
685 case OPT_InlineMinSize:
687 opt_InlineMinSize = system_atoi(value);
692 case OPT_PrintConfig:
693 opt_PrintConfig = enable;
696 case OPT_ProfileGCMemoryUsage:
698 opt_ProfileGCMemoryUsage = 5;
700 opt_ProfileGCMemoryUsage = system_atoi(value);
703 case OPT_ProfileMemoryUsage:
705 opt_ProfileMemoryUsage = 5;
707 opt_ProfileMemoryUsage = system_atoi(value);
709 # if defined(ENABLE_STATISTICS)
710 /* we also need statistics */
716 case OPT_ProfileMemoryUsageGNUPlot:
718 filename = "profile.dat";
722 file = fopen(filename, "w");
725 vm_abort_errno("options_xx: fopen failed");
727 opt_ProfileMemoryUsageGNUPlot = file;
730 #if defined(ENABLE_REPLACEMENT)
731 case OPT_TestReplacement:
732 opt_TestReplacement = enable;
736 case OPT_TraceCompilerCalls:
737 opt_TraceCompilerCalls = enable;
740 case OPT_TraceExceptions:
741 opt_TraceExceptions = enable;
744 #if defined(ENABLE_INLINING) && !defined(NDEBUG)
745 case OPT_TraceInlining:
747 opt_TraceInlining = 1;
749 opt_TraceInlining = system_atoi(value);
753 case OPT_TraceJavaCalls:
754 opt_verbosecall = enable;
755 opt_TraceJavaCalls = enable;
758 case OPT_TraceJNICalls:
759 opt_TraceJNICalls = enable;
762 case OPT_TraceJVMCalls:
763 opt_TraceJVMCalls = enable;
766 case OPT_TraceJVMCallsVerbose:
767 opt_TraceJVMCallsVerbose = enable;
770 case OPT_TraceLinkClass:
771 opt_TraceLinkClass = enable;
774 #if defined(ENABLE_REPLACEMENT)
775 case OPT_TraceReplacement:
777 opt_TraceReplacement = 1;
779 opt_TraceReplacement = system_atoi(value);
783 case OPT_TraceSubsystemInitialization:
784 opt_TraceSubsystemInitialization = enable;
788 opt_TraceTraps = enable;
791 #if defined(ENABLE_VMLOG)
794 vmlog_cacao_set_prefix("vmlog");
796 vmlog_cacao_set_prefix(value);
798 opt_TraceJavaCalls = 1;
801 case OPT_VmlogStrings:
803 vmlog_cacao_set_stringprefix(value);
806 case OPT_VmlogIgnore:
808 vmlog_cacao_set_ignoreprefix(value);
813 printf("Unknown -XX option: %s\n", name);
821 * These are local overrides for various environment variables in Emacs.
822 * Please do not remove this and leave it at the end of the file, where
823 * Emacs will automagically detect them.
824 * ---------------------------------------------------------------------
827 * indent-tabs-mode: t