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 int opt_DebugExceptions = 0;
164 int opt_DebugFinalizer = 0;
165 int opt_DebugLocalReferences = 0;
166 int opt_DebugLocks = 0;
167 int opt_DebugPackage = 0;
168 int opt_DebugPatcher = 0;
169 int opt_DebugProperties = 0;
170 int opt_DebugStackFrameInfo = 0;
171 int opt_DebugStackTrace = 0;
172 int opt_DebugThreads = 0;
173 #if defined(ENABLE_DISASSEMBLER)
174 int opt_DisassembleStubs = 0;
176 #if defined(ENABLE_OPAGENT)
177 int opt_EnableOpagent = 0;
179 #if defined(ENABLE_GC_CACAO)
180 int opt_GCDebugRootSet = 0;
181 int opt_GCStress = 0;
183 #if defined(ENABLE_INLINING)
185 #if defined(ENABLE_INLINING_DEBUG) || !defined(NDEBUG)
186 int opt_InlineAll = 0;
187 int opt_InlineCount = INT_MAX;
188 int opt_InlineMaxSize = INT_MAX;
189 int opt_InlineMinSize = 0;
192 int opt_PrintConfig = 0;
193 int opt_ProfileGCMemoryUsage = 0;
194 int opt_ProfileMemoryUsage = 0;
195 FILE *opt_ProfileMemoryUsageGNUPlot = NULL;
196 #if defined(ENABLE_REPLACEMENT)
197 int opt_TestReplacement = 0;
199 int opt_TraceCompilerCalls = 0;
200 int opt_TraceExceptions = 0;
201 int opt_TraceHPI = 0;
202 #if defined(ENABLE_INLINING) && !defined(NDEBUG)
203 int opt_TraceInlining = 0;
205 int opt_TraceJavaCalls = 0;
206 int opt_TraceJNICalls = 0;
207 int opt_TraceJVMCalls = 0;
208 int opt_TraceJVMCallsVerbose = 0;
209 int opt_TraceLinkClass = 0;
210 #if defined(ENABLE_REPLACEMENT)
211 int opt_TraceReplacement = 0;
213 int opt_TraceSubsystemInitialization = 0;
214 int opt_TraceTraps = 0;
223 /* Options which must always be available (production options in
226 OPT_MaxDirectMemorySize,
231 /* Debugging options which can be turned off. */
235 OPT_DebugLocalReferences,
240 OPT_DebugStackFrameInfo,
243 OPT_DisassembleStubs,
253 OPT_ProfileGCMemoryUsage,
254 OPT_ProfileMemoryUsage,
255 OPT_ProfileMemoryUsageGNUPlot,
257 OPT_TraceCompilerCalls,
264 OPT_TraceJVMCallsVerbose,
266 OPT_TraceReplacement,
267 OPT_TraceSubsystemInitialization,
275 option_t options_XX[] = {
276 /* Options which must always be available (production options in
279 { "MaxDirectMemorySize", OPT_MaxDirectMemorySize, OPT_TYPE_VALUE, "Maximum total size of NIO direct-buffer allocations" },
280 { "MaxPermSize", OPT_MaxPermSize, OPT_TYPE_VALUE, "not implemented" },
281 { "PermSize", OPT_PermSize, OPT_TYPE_VALUE, "not implemented" },
282 { "ThreadStackSize", OPT_ThreadStackSize, OPT_TYPE_VALUE, "TODO" },
284 /* Debugging options which can be turned off. */
286 { "DebugExceptions", OPT_DebugExceptions, OPT_TYPE_BOOLEAN, "debug exceptions" },
287 { "DebugFinalizer", OPT_DebugFinalizer, OPT_TYPE_BOOLEAN, "debug finalizer thread" },
288 { "DebugLocalReferences", OPT_DebugLocalReferences, OPT_TYPE_BOOLEAN, "print debug information for local reference tables" },
289 { "DebugLocks", OPT_DebugLocks, OPT_TYPE_BOOLEAN, "print debug information for locks" },
290 { "DebugPackage", OPT_DebugPackage, OPT_TYPE_BOOLEAN, "debug Java boot-packages" },
291 { "DebugPatcher", OPT_DebugPatcher, OPT_TYPE_BOOLEAN, "debug JIT code patching" },
292 { "DebugProperties", OPT_DebugProperties, OPT_TYPE_BOOLEAN, "print debug information for properties" },
293 { "DebugStackFrameInfo", OPT_DebugStackFrameInfo, OPT_TYPE_BOOLEAN, "TODO" },
294 { "DebugStackTrace", OPT_DebugStackTrace, OPT_TYPE_BOOLEAN, "debug stacktrace creation" },
295 { "DebugThreads", OPT_DebugThreads, OPT_TYPE_BOOLEAN, "print debug information for threads" },
296 #if defined(ENABLE_DISASSEMBLER)
297 { "DisassembleStubs", OPT_DisassembleStubs, OPT_TYPE_BOOLEAN, "disassemble builtin and native stubs when generated" },
299 #if defined(ENABLE_OPAGENT)
300 { "EnableOpagent", OPT_EnableOpagent, OPT_TYPE_BOOLEAN, "enable providing JIT output to Oprofile" },
302 #if defined(ENABLE_GC_CACAO)
303 { "GCDebugRootSet", OPT_GCDebugRootSet, OPT_TYPE_BOOLEAN, "GC: print root-set at collection" },
304 { "GCStress", OPT_GCStress, OPT_TYPE_BOOLEAN, "GC: forced collection at every allocation" },
306 #if defined(ENABLE_INLINING)
307 { "Inline", OPT_Inline, OPT_TYPE_BOOLEAN, "enable method inlining" },
308 #if defined(ENABLE_INLINING_DEBUG) || !defined(NDEBUG)
309 { "InlineAll", OPT_InlineAll, OPT_TYPE_BOOLEAN, "use inlining in all compilations" },
310 { "InlineCount", OPT_InlineCount, OPT_TYPE_VALUE, "stop inlining after the given number of roots" },
311 { "InlineMaxSize", OPT_InlineMaxSize, OPT_TYPE_VALUE, "maximum size for inlined result" },
312 { "InlineMinSize", OPT_InlineMinSize, OPT_TYPE_VALUE, "minimum size for inlined result" },
315 { "PrintConfig", OPT_PrintConfig, OPT_TYPE_BOOLEAN, "print VM configuration" },
316 { "ProfileGCMemoryUsage", OPT_ProfileGCMemoryUsage, OPT_TYPE_VALUE, "profiles GC memory usage in the given interval, <value> is in seconds (default: 5)" },
317 { "ProfileMemoryUsage", OPT_ProfileMemoryUsage, OPT_TYPE_VALUE, "TODO" },
318 { "ProfileMemoryUsageGNUPlot", OPT_ProfileMemoryUsageGNUPlot, OPT_TYPE_VALUE, "TODO" },
319 #if defined(ENABLE_REPLACEMENT)
320 { "TestReplacement", OPT_TestReplacement, OPT_TYPE_BOOLEAN, "activate all replacement points during code generation" },
322 { "TraceCompilerCalls", OPT_TraceCompilerCalls, OPT_TYPE_BOOLEAN, "trace JIT compiler calls" },
323 { "TraceExceptions", OPT_TraceExceptions, OPT_TYPE_BOOLEAN, "trace Exception throwing" },
324 { "TraceHPI", OPT_TraceHPI, OPT_TYPE_BOOLEAN, "Trace Host Porting Interface (HPI)" },
325 #if defined(ENABLE_INLINING) && !defined(NDEBUG)
326 { "TraceInlining", OPT_TraceInlining, OPT_TYPE_VALUE, "trace method inlining with the given verbosity level (default: 1)" },
328 #if !defined(ENABLE_VMLOG)
329 { "TraceJavaCalls", OPT_TraceJavaCalls, OPT_TYPE_BOOLEAN, "trace Java method calls" },
331 { "TraceJNICalls", OPT_TraceJNICalls, OPT_TYPE_BOOLEAN, "trace JNI method calls" },
332 { "TraceJVMCalls", OPT_TraceJVMCalls, OPT_TYPE_BOOLEAN, "trace JVM method calls but omit very frequent ones" },
333 { "TraceJVMCallsVerbose", OPT_TraceJVMCallsVerbose, OPT_TYPE_BOOLEAN, "trace all JVM method calls" },
334 { "TraceLinkClass", OPT_TraceLinkClass, OPT_TYPE_BOOLEAN, "trace class linking" },
335 #if defined(ENABLE_REPLACEMENT)
336 { "TraceReplacement", OPT_TraceReplacement, OPT_TYPE_VALUE, "trace on-stack replacement with the given verbosity level (default: 1)" },
338 { "TraceSubsystemInitialization", OPT_TraceSubsystemInitialization, OPT_TYPE_BOOLEAN, "trace initialization of subsystems" },
339 { "TraceTraps", OPT_TraceTraps, OPT_TYPE_BOOLEAN, "trace traps generated by JIT code" },
340 #if defined(ENABLE_VMLOG)
341 { "Vmlog", OPT_Vmlog, OPT_TYPE_VALUE, "prefix for vmlog trace files (enables vmlog)" },
342 { "VmlogStrings", OPT_VmlogStrings, OPT_TYPE_VALUE, "prefix of vmlog string file to load" },
343 { "VmlogIgnore", OPT_VmlogIgnore, OPT_TYPE_VALUE, "prefix of vmlog ignore file to load" },
348 { NULL, -1, -1, NULL }
352 /* options_get *****************************************************************
356 *******************************************************************************/
358 int options_get(opt_struct *opts, JavaVMInitArgs *vm_args)
363 if (opt_index >= vm_args->nOptions)
366 /* get the current option */
368 option = vm_args->options[opt_index].optionString;
370 if ((option == NULL) || (option[0] != '-'))
373 for (i = 0; opts[i].name; i++) {
375 /* boolean option found */
377 if (strcmp(option + 1, opts[i].name) == 0) {
379 return opts[i].value;
383 /* parameter option found */
385 /* with a space between */
387 if (strcmp(option + 1, opts[i].name) == 0) {
390 if (opt_index < vm_args->nOptions) {
391 opt_arg = os_strdup(vm_args->options[opt_index].optionString);
393 return opts[i].value;
399 /* parameter and option have no space between */
401 /* FIXME: this assumption is plain wrong, hits you if there is a
402 * parameter with no argument starting with same letter as param with argument
403 * but named after that one, ouch! */
405 size_t l = os_strlen(opts[i].name);
407 if (os_strlen(option + 1) > l) {
408 if (memcmp(option + 1, opts[i].name, l) == 0) {
410 opt_arg = os_strdup(option + 1 + l);
411 return opts[i].value;
422 /* options_xxusage *************************************************************
424 Print usage message for debugging options.
426 *******************************************************************************/
428 static void options_xxusage(void)
435 /* Prevent compiler warning. */
439 for (opt = options_XX; opt->name != NULL; opt++) {
443 case OPT_TYPE_BOOLEAN:
444 printf("+%s", opt->name);
445 length = os_strlen(" -XX:+") + os_strlen(opt->name);
449 printf("%s=<value>", opt->name);
450 length = os_strlen(" -XX:") + os_strlen(opt->name) +
451 os_strlen("=<value>");
455 vm_abort("options_xxusage: unkown option type %d", opt->type);
458 /* Check if the help fits into one 80-column line.
459 Documentation starts at column 29. */
461 if (length < (29 - 1)) {
462 /* Print missing spaces up to column 29. */
464 for (i = length; i < 29; i++)
469 printf(" "); /* 29 spaces */
472 /* Check documentation length. */
474 length = os_strlen(opt->doc);
476 if (length < (80 - 29)) {
477 printf("%s", opt->doc);
480 for (c = opt->doc, i = 29; *c != 0; c++, i++) {
481 /* If we are at the end of the line, break it. */
485 printf(" "); /* 29 spaces */
496 /* exit with error code */
502 /* options_xx ******************************************************************
506 *******************************************************************************/
508 void options_xx(JavaVMInitArgs *vm_args)
521 /* Iterate over all passed options. */
523 for (i = 0; i < vm_args->nOptions; i++) {
524 /* Get the current option. */
526 name = vm_args->options[i].optionString;
528 /* Check for help (-XX). */
530 if (strcmp(name, "-XX") == 0)
533 /* Check if the option start with -XX. */
535 start = strstr(name, "-XX:");
537 if ((start == NULL) || (start != name))
540 /* Check if the option is a boolean option. */
542 if (name[4] == '+') {
543 start = name + 4 + 1;
546 else if (name[4] == '-') {
547 start = name + 4 + 1;
555 /* Search for a '=' in the option name and get the option name
556 length and the value of the option. */
558 end = strchr(start, '=');
561 length = os_strlen(start);
565 length = end - start;
569 /* Search the option in the option array. */
571 for (opt = options_XX; opt->name != NULL; opt++) {
572 if (strncmp(opt->name, start, length) == 0) {
573 /* Check if the options passed fits to the type. */
576 case OPT_TYPE_BOOLEAN:
577 if ((enable == -1) || (value != NULL))
581 if ((enable != -1) || (value == NULL))
585 vm_abort("options_xx: unknown option type %d for option %s",
586 opt->type, opt->name);
593 /* Process the option. */
595 switch (opt->value) {
597 /* Options which must always be available (production options
600 case OPT_MaxDirectMemorySize:
601 opt_MaxDirectMemorySize = os_atoi(value);
604 case OPT_MaxPermSize:
605 /* Currently ignored. */
609 /* Currently ignored. */
612 case OPT_ThreadStackSize:
613 /* currently ignored */
616 /* Debugging options which can be turned off. */
618 case OPT_DebugExceptions:
619 opt_DebugExceptions = enable;
622 case OPT_DebugFinalizer:
623 opt_DebugFinalizer = enable;
626 case OPT_DebugLocalReferences:
627 opt_DebugLocalReferences = enable;
631 opt_DebugLocks = enable;
634 case OPT_DebugPackage:
635 opt_DebugPackage = enable;
638 case OPT_DebugPatcher:
639 opt_DebugPatcher = enable;
642 case OPT_DebugProperties:
643 opt_DebugProperties = enable;
646 case OPT_DebugStackFrameInfo:
647 opt_DebugStackFrameInfo = enable;
650 case OPT_DebugStackTrace:
651 opt_DebugStackTrace = enable;
654 case OPT_DebugThreads:
655 opt_DebugThreads = enable;
658 #if defined(ENABLE_DISASSEMBLER)
659 case OPT_DisassembleStubs:
660 opt_DisassembleStubs = enable;
664 #if defined(ENABLE_OPAGENT)
665 case OPT_EnableOpagent:
666 opt_EnableOpagent = enable;
670 #if defined(ENABLE_GC_CACAO)
671 case OPT_GCDebugRootSet:
672 opt_GCDebugRootSet = enable;
676 opt_GCStress = enable;
680 #if defined(ENABLE_INLINING)
684 #if defined(ENABLE_INLINING_DEBUG) || !defined(NDEBUG)
686 opt_InlineAll = enable;
689 case OPT_InlineCount:
691 opt_InlineCount = os_atoi(value);
694 case OPT_InlineMaxSize:
696 opt_InlineMaxSize = os_atoi(value);
699 case OPT_InlineMinSize:
701 opt_InlineMinSize = os_atoi(value);
706 case OPT_PrintConfig:
707 opt_PrintConfig = enable;
710 case OPT_ProfileGCMemoryUsage:
712 opt_ProfileGCMemoryUsage = 5;
714 opt_ProfileGCMemoryUsage = os_atoi(value);
717 case OPT_ProfileMemoryUsage:
719 opt_ProfileMemoryUsage = 5;
721 opt_ProfileMemoryUsage = os_atoi(value);
723 # if defined(ENABLE_STATISTICS)
724 /* we also need statistics */
730 case OPT_ProfileMemoryUsageGNUPlot:
732 filename = "profile.dat";
736 file = fopen(filename, "w");
739 vm_abort_errno("options_xx: fopen failed");
741 opt_ProfileMemoryUsageGNUPlot = file;
744 #if defined(ENABLE_REPLACEMENT)
745 case OPT_TestReplacement:
746 opt_TestReplacement = enable;
750 case OPT_TraceCompilerCalls:
751 opt_TraceCompilerCalls = enable;
754 case OPT_TraceExceptions:
755 opt_TraceExceptions = enable;
759 opt_TraceHPI = enable;
762 #if defined(ENABLE_INLINING) && !defined(NDEBUG)
763 case OPT_TraceInlining:
765 opt_TraceInlining = 1;
767 opt_TraceInlining = os_atoi(value);
771 case OPT_TraceJavaCalls:
772 opt_verbosecall = enable;
773 opt_TraceJavaCalls = enable;
776 case OPT_TraceJNICalls:
777 opt_TraceJNICalls = enable;
780 case OPT_TraceJVMCalls:
781 opt_TraceJVMCalls = enable;
784 case OPT_TraceJVMCallsVerbose:
785 opt_TraceJVMCallsVerbose = enable;
788 case OPT_TraceLinkClass:
789 opt_TraceLinkClass = enable;
792 #if defined(ENABLE_REPLACEMENT)
793 case OPT_TraceReplacement:
795 opt_TraceReplacement = 1;
797 opt_TraceReplacement = os_atoi(value);
801 case OPT_TraceSubsystemInitialization:
802 opt_TraceSubsystemInitialization = enable;
806 opt_TraceTraps = enable;
809 #if defined(ENABLE_VMLOG)
812 vmlog_cacao_set_prefix("vmlog");
814 vmlog_cacao_set_prefix(value);
816 opt_TraceJavaCalls = 1;
819 case OPT_VmlogStrings:
821 vmlog_cacao_set_stringprefix(value);
824 case OPT_VmlogIgnore:
826 vmlog_cacao_set_ignoreprefix(value);
831 printf("Unknown -XX option: %s\n", name);
839 * These are local overrides for various environment variables in Emacs.
840 * Please do not remove this and leave it at the end of the file, where
841 * Emacs will automagically detect them.
842 * ---------------------------------------------------------------------
845 * indent-tabs-mode: t