1 /* src/vm/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 "vm/options.h"
40 /* command line option ********************************************************/
42 s4 opt_index = 0; /* index of processed arguments */
43 char *opt_arg; /* this one exports the option argument */
45 bool opt_foo = false; /* option for development */
49 #if defined(ENABLE_JIT)
50 bool opt_jit = true; /* JIT mode execution (default) */
51 bool opt_intrp = false; /* interpreter mode execution */
53 bool opt_jit = false; /* JIT mode execution */
54 bool opt_intrp = true; /* interpreter mode execution (default) */
59 s4 opt_heapmaxsize = 0; /* maximum heap size */
60 s4 opt_heapstartsize = 0; /* initial heap size */
61 s4 opt_stacksize = 0; /* thread stack size */
63 bool opt_verbose = false;
64 bool opt_debugcolor = false; /* use ANSI terminal sequences */
65 bool compileall = false;
67 bool loadverbose = false;
68 bool initverbose = false;
70 bool opt_verboseclass = false;
71 bool opt_verbosegc = false;
72 bool opt_verbosejni = false;
73 bool opt_verbosecall = false; /* trace all method invocation */
75 bool showmethods = false;
76 bool showconstantpool = false;
79 char *opt_method = NULL;
80 char *opt_signature = NULL;
82 bool compileverbose = false; /* trace compiler actions */
83 bool showstack = false;
85 bool opt_showdisassemble = false; /* generate disassembler listing */
86 bool opt_showddatasegment = false; /* generate data segment listing */
87 bool opt_showintermediate = false; /* generate intermediate code listing */
89 bool checkbounds = true; /* check array bounds */
90 bool checksync = true; /* do synchronization */
91 #if defined(ENABLE_LOOP)
92 bool opt_loops = false; /* optimize array accesses in loops */
95 bool makeinitializations = true;
97 #if defined(ENABLE_STATISTICS)
98 bool opt_stat = false;
99 bool opt_getloadingtime = false; /* to measure the runtime */
100 bool opt_getcompilingtime = false; /* compute compile time */
102 #if defined(ENABLE_VERIFIER)
103 bool opt_verify = true; /* true if classfiles should be verified */
106 #if defined(ENABLE_PROFILING)
107 bool opt_prof = false;
108 bool opt_prof_bb = false;
111 #if defined(ENABLE_OPAGENT)
112 bool opt_opagent = false;
115 /* optimization options *******************************************************/
117 #if defined(ENABLE_IFCONV)
118 bool opt_ifconv = false;
121 #if defined(ENABLE_LSRA) || defined(ENABLE_SSA)
122 bool opt_lsra = false;
124 #if defined(ENABLE_SSA)
125 bool opt_ssa_dce = false; /* enable dead code elemination */
126 bool opt_ssa_cp = false; /* enable copy propagation */
130 /* interpreter options ********************************************************/
132 #if defined(ENABLE_INTRP)
133 bool opt_no_dynamic = false; /* suppress dynamic superinstructions */
134 bool opt_no_replication = false; /* don't use replication in intrp */
135 bool opt_no_quicksuper = false; /* instructions for quickening cannot be
136 part of dynamic superinstructions */
138 s4 opt_static_supers = 0x7fffffff;
139 bool vm_debug = false; /* XXX this should be called `opt_trace' */
142 #if defined(ENABLE_DEBUG_FILTER)
143 const char *opt_filter_verbosecall_include = 0;
144 const char *opt_filter_verbosecall_exclude = 0;
145 const char *opt_filter_show_method = 0;
149 /* -XX options ****************************************************************/
151 /* NOTE: For better readability keep these alpha-sorted. */
153 /* Options which must always be available (production options in
156 int64_t opt_MaxDirectMemorySize = -1;
157 int opt_MaxPermSize = 0;
158 int opt_PermSize = 0;
159 int opt_ThreadStackSize = 0;
161 /* Debugging options which can be turned off. */
163 bool opt_AlwaysEmitLongBranches = false;
164 int opt_DebugExceptions = 0;
165 int opt_DebugFinalizer = 0;
166 int opt_DebugLocalReferences = 0;
167 int opt_DebugLocks = 0;
168 int opt_DebugPackage = 0;
169 int opt_DebugPatcher = 0;
170 int opt_DebugProperties = 0;
171 int opt_DebugStackFrameInfo = 0;
172 int opt_DebugStackTrace = 0;
173 int opt_DebugThreads = 0;
174 #if defined(ENABLE_DISASSEMBLER)
175 int opt_DisassembleStubs = 0;
177 #if defined(ENABLE_OPAGENT)
178 int opt_EnableOpagent = 0;
180 #if defined(ENABLE_GC_CACAO)
181 int opt_GCDebugRootSet = 0;
182 int opt_GCStress = 0;
184 #if defined(ENABLE_INLINING)
186 #if defined(ENABLE_INLINING_DEBUG) || !defined(NDEBUG)
187 int opt_InlineAll = 0;
188 int opt_InlineCount = INT_MAX;
189 int opt_InlineMaxSize = INT_MAX;
190 int opt_InlineMinSize = 0;
193 int opt_PrintConfig = 0;
194 int opt_ProfileGCMemoryUsage = 0;
195 int opt_ProfileMemoryUsage = 0;
196 FILE *opt_ProfileMemoryUsageGNUPlot = NULL;
197 #if defined(ENABLE_REPLACEMENT)
198 int opt_TestReplacement = 0;
200 int opt_TraceCompilerCalls = 0;
201 int opt_TraceExceptions = 0;
202 int opt_TraceHPI = 0;
203 #if defined(ENABLE_INLINING) && !defined(NDEBUG)
204 int opt_TraceInlining = 0;
206 int opt_TraceJavaCalls = 0;
207 int opt_TraceJNICalls = 0;
208 int opt_TraceJVMCalls = 0;
209 int opt_TraceJVMCallsVerbose = 0;
210 int opt_TraceLinkClass = 0;
211 #if defined(ENABLE_REPLACEMENT)
212 int opt_TraceReplacement = 0;
214 int opt_TraceSubsystemInitialization = 0;
215 int opt_TraceTraps = 0;
224 /* Options which must always be available (production options in
227 OPT_MaxDirectMemorySize,
232 /* Debugging options which can be turned off. */
234 OPT_AlwaysEmitLongBranches,
237 OPT_DebugLocalReferences,
242 OPT_DebugStackFrameInfo,
245 OPT_DisassembleStubs,
255 OPT_ProfileGCMemoryUsage,
256 OPT_ProfileMemoryUsage,
257 OPT_ProfileMemoryUsageGNUPlot,
259 OPT_TraceCompilerCalls,
266 OPT_TraceJVMCallsVerbose,
268 OPT_TraceReplacement,
269 OPT_TraceSubsystemInitialization,
277 option_t options_XX[] = {
278 /* Options which must always be available (production options in
281 { "MaxDirectMemorySize", OPT_MaxDirectMemorySize, OPT_TYPE_VALUE, "Maximum total size of NIO direct-buffer allocations" },
282 { "MaxPermSize", OPT_MaxPermSize, OPT_TYPE_VALUE, "not implemented" },
283 { "PermSize", OPT_PermSize, OPT_TYPE_VALUE, "not implemented" },
284 { "ThreadStackSize", OPT_ThreadStackSize, OPT_TYPE_VALUE, "TODO" },
286 /* Debugging options which can be turned off. */
288 { "AlwaysEmitLongBranches", OPT_AlwaysEmitLongBranches, OPT_TYPE_BOOLEAN, "Always emit long-branches." },
289 { "DebugExceptions", OPT_DebugExceptions, OPT_TYPE_BOOLEAN, "debug exceptions" },
290 { "DebugFinalizer", OPT_DebugFinalizer, OPT_TYPE_BOOLEAN, "debug finalizer thread" },
291 { "DebugLocalReferences", OPT_DebugLocalReferences, OPT_TYPE_BOOLEAN, "print debug information for local reference tables" },
292 { "DebugLocks", OPT_DebugLocks, OPT_TYPE_BOOLEAN, "print debug information for locks" },
293 { "DebugPackage", OPT_DebugPackage, OPT_TYPE_BOOLEAN, "debug Java boot-packages" },
294 { "DebugPatcher", OPT_DebugPatcher, OPT_TYPE_BOOLEAN, "debug JIT code patching" },
295 { "DebugProperties", OPT_DebugProperties, OPT_TYPE_BOOLEAN, "print debug information for properties" },
296 { "DebugStackFrameInfo", OPT_DebugStackFrameInfo, OPT_TYPE_BOOLEAN, "TODO" },
297 { "DebugStackTrace", OPT_DebugStackTrace, OPT_TYPE_BOOLEAN, "debug stacktrace creation" },
298 { "DebugThreads", OPT_DebugThreads, OPT_TYPE_BOOLEAN, "print debug information for threads" },
299 #if defined(ENABLE_DISASSEMBLER)
300 { "DisassembleStubs", OPT_DisassembleStubs, OPT_TYPE_BOOLEAN, "disassemble builtin and native stubs when generated" },
302 #if defined(ENABLE_OPAGENT)
303 { "EnableOpagent", OPT_EnableOpagent, OPT_TYPE_BOOLEAN, "enable providing JIT output to Oprofile" },
305 #if defined(ENABLE_GC_CACAO)
306 { "GCDebugRootSet", OPT_GCDebugRootSet, OPT_TYPE_BOOLEAN, "GC: print root-set at collection" },
307 { "GCStress", OPT_GCStress, OPT_TYPE_BOOLEAN, "GC: forced collection at every allocation" },
309 #if defined(ENABLE_INLINING)
310 { "Inline", OPT_Inline, OPT_TYPE_BOOLEAN, "enable method inlining" },
311 #if defined(ENABLE_INLINING_DEBUG) || !defined(NDEBUG)
312 { "InlineAll", OPT_InlineAll, OPT_TYPE_BOOLEAN, "use inlining in all compilations" },
313 { "InlineCount", OPT_InlineCount, OPT_TYPE_VALUE, "stop inlining after the given number of roots" },
314 { "InlineMaxSize", OPT_InlineMaxSize, OPT_TYPE_VALUE, "maximum size for inlined result" },
315 { "InlineMinSize", OPT_InlineMinSize, OPT_TYPE_VALUE, "minimum size for inlined result" },
318 { "PrintConfig", OPT_PrintConfig, OPT_TYPE_BOOLEAN, "print VM configuration" },
319 { "ProfileGCMemoryUsage", OPT_ProfileGCMemoryUsage, OPT_TYPE_VALUE, "profiles GC memory usage in the given interval, <value> is in seconds (default: 5)" },
320 { "ProfileMemoryUsage", OPT_ProfileMemoryUsage, OPT_TYPE_VALUE, "TODO" },
321 { "ProfileMemoryUsageGNUPlot", OPT_ProfileMemoryUsageGNUPlot, OPT_TYPE_VALUE, "TODO" },
322 #if defined(ENABLE_REPLACEMENT)
323 { "TestReplacement", OPT_TestReplacement, OPT_TYPE_BOOLEAN, "activate all replacement points during code generation" },
325 { "TraceCompilerCalls", OPT_TraceCompilerCalls, OPT_TYPE_BOOLEAN, "trace JIT compiler calls" },
326 { "TraceExceptions", OPT_TraceExceptions, OPT_TYPE_BOOLEAN, "trace Exception throwing" },
327 { "TraceHPI", OPT_TraceHPI, OPT_TYPE_BOOLEAN, "Trace Host Porting Interface (HPI)" },
328 #if defined(ENABLE_INLINING) && !defined(NDEBUG)
329 { "TraceInlining", OPT_TraceInlining, OPT_TYPE_VALUE, "trace method inlining with the given verbosity level (default: 1)" },
331 #if !defined(ENABLE_VMLOG)
332 { "TraceJavaCalls", OPT_TraceJavaCalls, OPT_TYPE_BOOLEAN, "trace Java method calls" },
334 { "TraceJNICalls", OPT_TraceJNICalls, OPT_TYPE_BOOLEAN, "trace JNI method calls" },
335 { "TraceJVMCalls", OPT_TraceJVMCalls, OPT_TYPE_BOOLEAN, "trace JVM method calls but omit very frequent ones" },
336 { "TraceJVMCallsVerbose", OPT_TraceJVMCallsVerbose, OPT_TYPE_BOOLEAN, "trace all JVM method calls" },
337 { "TraceLinkClass", OPT_TraceLinkClass, OPT_TYPE_BOOLEAN, "trace class linking" },
338 #if defined(ENABLE_REPLACEMENT)
339 { "TraceReplacement", OPT_TraceReplacement, OPT_TYPE_VALUE, "trace on-stack replacement with the given verbosity level (default: 1)" },
341 { "TraceSubsystemInitialization", OPT_TraceSubsystemInitialization, OPT_TYPE_BOOLEAN, "trace initialization of subsystems" },
342 { "TraceTraps", OPT_TraceTraps, OPT_TYPE_BOOLEAN, "trace traps generated by JIT code" },
343 #if defined(ENABLE_VMLOG)
344 { "Vmlog", OPT_Vmlog, OPT_TYPE_VALUE, "prefix for vmlog trace files (enables vmlog)" },
345 { "VmlogStrings", OPT_VmlogStrings, OPT_TYPE_VALUE, "prefix of vmlog string file to load" },
346 { "VmlogIgnore", OPT_VmlogIgnore, OPT_TYPE_VALUE, "prefix of vmlog ignore file to load" },
351 { NULL, -1, -1, NULL }
355 /* options_get *****************************************************************
359 *******************************************************************************/
361 int options_get(opt_struct *opts, JavaVMInitArgs *vm_args)
366 if (opt_index >= vm_args->nOptions)
369 /* get the current option */
371 option = vm_args->options[opt_index].optionString;
373 if ((option == NULL) || (option[0] != '-'))
376 for (i = 0; opts[i].name; i++) {
378 /* boolean option found */
380 if (strcmp(option + 1, opts[i].name) == 0) {
382 return opts[i].value;
386 /* parameter option found */
388 /* with a space between */
390 if (strcmp(option + 1, opts[i].name) == 0) {
393 if (opt_index < vm_args->nOptions) {
394 opt_arg = os_strdup(vm_args->options[opt_index].optionString);
396 return opts[i].value;
402 /* parameter and option have no space between */
404 /* FIXME: this assumption is plain wrong, hits you if there is a
405 * parameter with no argument starting with same letter as param with argument
406 * but named after that one, ouch! */
408 size_t l = os_strlen(opts[i].name);
410 if (os_strlen(option + 1) > l) {
411 if (memcmp(option + 1, opts[i].name, l) == 0) {
413 opt_arg = os_strdup(option + 1 + l);
414 return opts[i].value;
425 /* options_xxusage *************************************************************
427 Print usage message for debugging options.
429 *******************************************************************************/
431 static void options_xxusage(void)
438 /* Prevent compiler warning. */
442 for (opt = options_XX; opt->name != NULL; opt++) {
446 case OPT_TYPE_BOOLEAN:
447 printf("+%s", opt->name);
448 length = os_strlen(" -XX:+") + os_strlen(opt->name);
452 printf("%s=<value>", opt->name);
453 length = os_strlen(" -XX:") + os_strlen(opt->name) +
454 os_strlen("=<value>");
458 vm_abort("options_xxusage: unkown option type %d", opt->type);
461 /* Check if the help fits into one 80-column line.
462 Documentation starts at column 29. */
464 if (length < (29 - 1)) {
465 /* Print missing spaces up to column 29. */
467 for (i = length; i < 29; i++)
472 printf(" "); /* 29 spaces */
475 /* Check documentation length. */
477 length = os_strlen(opt->doc);
479 if (length < (80 - 29)) {
480 printf("%s", opt->doc);
483 for (c = opt->doc, i = 29; *c != 0; c++, i++) {
484 /* If we are at the end of the line, break it. */
488 printf(" "); /* 29 spaces */
499 /* exit with error code */
505 /* options_xx ******************************************************************
509 *******************************************************************************/
511 void options_xx(JavaVMInitArgs *vm_args)
524 /* Iterate over all passed options. */
526 for (i = 0; i < vm_args->nOptions; i++) {
527 /* Get the current option. */
529 name = vm_args->options[i].optionString;
531 /* Check for help (-XX). */
533 if (strcmp(name, "-XX") == 0)
536 /* Check if the option start with -XX. */
538 start = strstr(name, "-XX:");
540 if ((start == NULL) || (start != name))
543 /* Check if the option is a boolean option. */
545 if (name[4] == '+') {
546 start = name + 4 + 1;
549 else if (name[4] == '-') {
550 start = name + 4 + 1;
558 /* Search for a '=' in the option name and get the option name
559 length and the value of the option. */
561 end = strchr(start, '=');
564 length = os_strlen(start);
568 length = end - start;
572 /* Search the option in the option array. */
574 for (opt = options_XX; opt->name != NULL; opt++) {
575 if (strncmp(opt->name, start, length) == 0) {
576 /* Check if the options passed fits to the type. */
579 case OPT_TYPE_BOOLEAN:
580 if ((enable == -1) || (value != NULL))
584 if ((enable != -1) || (value == NULL))
588 vm_abort("options_xx: unknown option type %d for option %s",
589 opt->type, opt->name);
596 /* Process the option. */
598 switch (opt->value) {
600 /* Options which must always be available (production options
603 case OPT_MaxDirectMemorySize:
604 opt_MaxDirectMemorySize = os_atoi(value);
607 case OPT_MaxPermSize:
608 /* Currently ignored. */
612 /* Currently ignored. */
615 case OPT_ThreadStackSize:
616 /* currently ignored */
619 /* Debugging options which can be turned off. */
621 case OPT_AlwaysEmitLongBranches:
622 opt_AlwaysEmitLongBranches = enable;
625 case OPT_DebugExceptions:
626 opt_DebugExceptions = enable;
629 case OPT_DebugFinalizer:
630 opt_DebugFinalizer = enable;
633 case OPT_DebugLocalReferences:
634 opt_DebugLocalReferences = enable;
638 opt_DebugLocks = enable;
641 case OPT_DebugPackage:
642 opt_DebugPackage = enable;
645 case OPT_DebugPatcher:
646 opt_DebugPatcher = enable;
649 case OPT_DebugProperties:
650 opt_DebugProperties = enable;
653 case OPT_DebugStackFrameInfo:
654 opt_DebugStackFrameInfo = enable;
657 case OPT_DebugStackTrace:
658 opt_DebugStackTrace = enable;
661 case OPT_DebugThreads:
662 opt_DebugThreads = enable;
665 #if defined(ENABLE_DISASSEMBLER)
666 case OPT_DisassembleStubs:
667 opt_DisassembleStubs = enable;
671 #if defined(ENABLE_OPAGENT)
672 case OPT_EnableOpagent:
673 opt_EnableOpagent = enable;
677 #if defined(ENABLE_GC_CACAO)
678 case OPT_GCDebugRootSet:
679 opt_GCDebugRootSet = enable;
683 opt_GCStress = enable;
687 #if defined(ENABLE_INLINING)
691 #if defined(ENABLE_INLINING_DEBUG) || !defined(NDEBUG)
693 opt_InlineAll = enable;
696 case OPT_InlineCount:
698 opt_InlineCount = os_atoi(value);
701 case OPT_InlineMaxSize:
703 opt_InlineMaxSize = os_atoi(value);
706 case OPT_InlineMinSize:
708 opt_InlineMinSize = os_atoi(value);
713 case OPT_PrintConfig:
714 opt_PrintConfig = enable;
717 case OPT_ProfileGCMemoryUsage:
719 opt_ProfileGCMemoryUsage = 5;
721 opt_ProfileGCMemoryUsage = os_atoi(value);
724 case OPT_ProfileMemoryUsage:
726 opt_ProfileMemoryUsage = 5;
728 opt_ProfileMemoryUsage = os_atoi(value);
730 # if defined(ENABLE_STATISTICS)
731 /* we also need statistics */
737 case OPT_ProfileMemoryUsageGNUPlot:
739 filename = "profile.dat";
743 file = fopen(filename, "w");
746 vm_abort_errno("options_xx: fopen failed");
748 opt_ProfileMemoryUsageGNUPlot = file;
751 #if defined(ENABLE_REPLACEMENT)
752 case OPT_TestReplacement:
753 opt_TestReplacement = enable;
757 case OPT_TraceCompilerCalls:
758 opt_TraceCompilerCalls = enable;
761 case OPT_TraceExceptions:
762 opt_TraceExceptions = enable;
766 opt_TraceHPI = enable;
769 #if defined(ENABLE_INLINING) && !defined(NDEBUG)
770 case OPT_TraceInlining:
772 opt_TraceInlining = 1;
774 opt_TraceInlining = os_atoi(value);
778 case OPT_TraceJavaCalls:
779 opt_verbosecall = enable;
780 opt_TraceJavaCalls = enable;
783 case OPT_TraceJNICalls:
784 opt_TraceJNICalls = enable;
787 case OPT_TraceJVMCalls:
788 opt_TraceJVMCalls = enable;
791 case OPT_TraceJVMCallsVerbose:
792 opt_TraceJVMCallsVerbose = enable;
795 case OPT_TraceLinkClass:
796 opt_TraceLinkClass = enable;
799 #if defined(ENABLE_REPLACEMENT)
800 case OPT_TraceReplacement:
802 opt_TraceReplacement = 1;
804 opt_TraceReplacement = os_atoi(value);
808 case OPT_TraceSubsystemInitialization:
809 opt_TraceSubsystemInitialization = enable;
813 opt_TraceTraps = enable;
816 #if defined(ENABLE_VMLOG)
819 vmlog_cacao_set_prefix("vmlog");
821 vmlog_cacao_set_prefix(value);
823 opt_TraceJavaCalls = 1;
826 case OPT_VmlogStrings:
828 vmlog_cacao_set_stringprefix(value);
831 case OPT_VmlogIgnore:
833 vmlog_cacao_set_ignoreprefix(value);
838 printf("Unknown -XX option: %s\n", name);
846 * These are local overrides for various environment variables in Emacs.
847 * Please do not remove this and leave it at the end of the file, where
848 * Emacs will automagically detect them.
849 * ---------------------------------------------------------------------
852 * indent-tabs-mode: t