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 "native/jni.h"
37 #include "vm/options.h"
42 /* command line option ********************************************************/
44 s4 opt_index = 0; /* index of processed arguments */
45 char *opt_arg; /* this one exports the option argument */
47 bool opt_foo = false; /* option for development */
51 #if defined(ENABLE_JIT)
52 bool opt_jit = true; /* JIT mode execution (default) */
53 bool opt_intrp = false; /* interpreter mode execution */
55 bool opt_jit = false; /* JIT mode execution */
56 bool opt_intrp = true; /* interpreter mode execution (default) */
61 s4 opt_heapmaxsize = 0; /* maximum heap size */
62 s4 opt_heapstartsize = 0; /* initial heap size */
63 s4 opt_stacksize = 0; /* thread stack size */
65 bool opt_verbose = false;
66 bool opt_debugcolor = false; /* use ANSI terminal sequences */
67 bool compileall = false;
69 bool loadverbose = false;
70 bool initverbose = false;
72 bool opt_verboseclass = false;
73 bool opt_verbosegc = false;
74 bool opt_verbosejni = false;
75 bool opt_verbosecall = false; /* trace all method invocation */
77 bool showmethods = false;
78 bool showconstantpool = false;
81 char *opt_method = NULL;
82 char *opt_signature = NULL;
84 bool compileverbose = false; /* trace compiler actions */
85 bool showstack = false;
87 bool opt_showdisassemble = false; /* generate disassembler listing */
88 bool opt_shownops = false;
89 bool opt_showddatasegment = false; /* generate data segment listing */
90 bool opt_showintermediate = false; /* generate intermediate code listing */
92 bool checkbounds = true; /* check array bounds */
93 bool opt_noieee = false; /* don't implement ieee compliant floats */
94 bool checksync = true; /* do synchronization */
95 #if defined(ENABLE_LOOP)
96 bool opt_loops = false; /* optimize array accesses in loops */
99 bool makeinitializations = true;
101 #if defined(ENABLE_STATISTICS)
102 bool opt_stat = false;
103 bool opt_getloadingtime = false; /* to measure the runtime */
104 bool opt_getcompilingtime = false; /* compute compile time */
106 #if defined(ENABLE_VERIFIER)
107 bool opt_verify = true; /* true if classfiles should be verified */
110 #if defined(ENABLE_PROFILING)
111 bool opt_prof = false;
112 bool opt_prof_bb = false;
115 #if defined(ENABLE_OPAGENT)
116 bool opt_opagent = false;
119 /* optimization options *******************************************************/
121 #if defined(ENABLE_IFCONV)
122 bool opt_ifconv = false;
125 #if defined(ENABLE_LSRA) || defined(ENABLE_SSA)
126 bool opt_lsra = false;
128 #if defined(ENABLE_SSA)
129 bool opt_ssa_dce = false; /* enable dead code elemination */
130 bool opt_ssa_cp = false; /* enable copy propagation */
134 /* interpreter options ********************************************************/
136 #if defined(ENABLE_INTRP)
137 bool opt_no_dynamic = false; /* suppress dynamic superinstructions */
138 bool opt_no_replication = false; /* don't use replication in intrp */
139 bool opt_no_quicksuper = false; /* instructions for quickening cannot be
140 part of dynamic superinstructions */
142 s4 opt_static_supers = 0x7fffffff;
143 bool vm_debug = false; /* XXX this should be called `opt_trace' */
146 #if defined(ENABLE_DEBUG_FILTER)
147 const char *opt_filter_verbosecall_include = 0;
148 const char *opt_filter_verbosecall_exclude = 0;
149 const char *opt_filter_show_method = 0;
153 /* -XX options ****************************************************************/
155 /* NOTE: For better readability keep these alpha-sorted. */
157 /* Options which must always be available (production options in
160 int64_t opt_MaxDirectMemorySize = -1;
161 int opt_MaxPermSize = 0;
162 int opt_PermSize = 0;
163 int opt_ThreadStackSize = 0;
165 /* Debugging options which can be turned off. */
167 int opt_DebugExceptions = 0;
168 int opt_DebugFinalizer = 0;
169 int opt_DebugLocalReferences = 0;
170 int opt_DebugLocks = 0;
171 int opt_DebugPackage = 0;
172 int opt_DebugPatcher = 0;
173 int opt_DebugProperties = 0;
174 int opt_DebugStackFrameInfo = 0;
175 int opt_DebugStackTrace = 0;
176 int opt_DebugThreads = 0;
177 #if defined(ENABLE_DISASSEMBLER)
178 int opt_DisassembleStubs = 0;
180 #if defined(ENABLE_OPAGENT)
181 int opt_EnableOpagent = 0;
183 #if defined(ENABLE_GC_CACAO)
184 int opt_GCDebugRootSet = 0;
185 int opt_GCStress = 0;
187 #if defined(ENABLE_INLINING)
189 #if defined(ENABLE_INLINING_DEBUG) || !defined(NDEBUG)
190 int opt_InlineAll = 0;
191 int opt_InlineCount = INT_MAX;
192 int opt_InlineMaxSize = INT_MAX;
193 int opt_InlineMinSize = 0;
196 int opt_PrintConfig = 0;
197 int opt_ProfileGCMemoryUsage = 0;
198 int opt_ProfileMemoryUsage = 0;
199 FILE *opt_ProfileMemoryUsageGNUPlot = NULL;
200 #if defined(ENABLE_REPLACEMENT)
201 int opt_TestReplacement = 0;
203 int opt_TraceCompilerCalls = 0;
204 int opt_TraceExceptions = 0;
205 int opt_TraceHPI = 0;
206 #if defined(ENABLE_INLINING) && !defined(NDEBUG)
207 int opt_TraceInlining = 0;
209 int opt_TraceJavaCalls = 0;
210 int opt_TraceJNICalls = 0;
211 int opt_TraceJVMCalls = 0;
212 int opt_TraceJVMCallsVerbose = 0;
213 int opt_TraceLinkClass = 0;
214 #if defined(ENABLE_REPLACEMENT)
215 int opt_TraceReplacement = 0;
217 int opt_TraceSubsystemInitialization = 0;
218 int opt_TraceTraps = 0;
227 /* Options which must always be available (production options in
230 OPT_MaxDirectMemorySize,
235 /* Debugging options which can be turned off. */
239 OPT_DebugLocalReferences,
244 OPT_DebugStackFrameInfo,
247 OPT_DisassembleStubs,
257 OPT_ProfileGCMemoryUsage,
258 OPT_ProfileMemoryUsage,
259 OPT_ProfileMemoryUsageGNUPlot,
261 OPT_TraceCompilerCalls,
268 OPT_TraceJVMCallsVerbose,
270 OPT_TraceReplacement,
271 OPT_TraceSubsystemInitialization,
279 option_t options_XX[] = {
280 /* Options which must always be available (production options in
283 { "MaxDirectMemorySize", OPT_MaxDirectMemorySize, OPT_TYPE_VALUE, "Maximum total size of NIO direct-buffer allocations" },
284 { "MaxPermSize", OPT_MaxPermSize, OPT_TYPE_VALUE, "not implemented" },
285 { "PermSize", OPT_PermSize, OPT_TYPE_VALUE, "not implemented" },
286 { "ThreadStackSize", OPT_ThreadStackSize, OPT_TYPE_VALUE, "TODO" },
288 /* Debugging options which can be turned off. */
290 { "DebugExceptions", OPT_DebugExceptions, OPT_TYPE_BOOLEAN, "debug exceptions" },
291 { "DebugFinalizer", OPT_DebugFinalizer, OPT_TYPE_BOOLEAN, "debug finalizer thread" },
292 { "DebugLocalReferences", OPT_DebugLocalReferences, OPT_TYPE_BOOLEAN, "print debug information for local reference tables" },
293 { "DebugLocks", OPT_DebugLocks, OPT_TYPE_BOOLEAN, "print debug information for locks" },
294 { "DebugPackage", OPT_DebugPackage, OPT_TYPE_BOOLEAN, "debug Java boot-packages" },
295 { "DebugPatcher", OPT_DebugPatcher, OPT_TYPE_BOOLEAN, "debug JIT code patching" },
296 { "DebugProperties", OPT_DebugProperties, OPT_TYPE_BOOLEAN, "print debug information for properties" },
297 { "DebugStackFrameInfo", OPT_DebugStackFrameInfo, OPT_TYPE_BOOLEAN, "TODO" },
298 { "DebugStackTrace", OPT_DebugStackTrace, OPT_TYPE_BOOLEAN, "debug stacktrace creation" },
299 { "DebugThreads", OPT_DebugThreads, OPT_TYPE_BOOLEAN, "print debug information for threads" },
300 #if defined(ENABLE_DISASSEMBLER)
301 { "DisassembleStubs", OPT_DisassembleStubs, OPT_TYPE_BOOLEAN, "disassemble builtin and native stubs when generated" },
303 #if defined(ENABLE_OPAGENT)
304 { "EnableOpagent", OPT_EnableOpagent, OPT_TYPE_BOOLEAN, "enable providing JIT output to Oprofile" },
306 #if defined(ENABLE_GC_CACAO)
307 { "GCDebugRootSet", OPT_GCDebugRootSet, OPT_TYPE_BOOLEAN, "GC: print root-set at collection" },
308 { "GCStress", OPT_GCStress, OPT_TYPE_BOOLEAN, "GC: forced collection at every allocation" },
310 #if defined(ENABLE_INLINING)
311 { "Inline", OPT_Inline, OPT_TYPE_BOOLEAN, "enable method inlining" },
312 #if defined(ENABLE_INLINING_DEBUG) || !defined(NDEBUG)
313 { "InlineAll", OPT_InlineAll, OPT_TYPE_BOOLEAN, "use inlining in all compilations" },
314 { "InlineCount", OPT_InlineCount, OPT_TYPE_VALUE, "stop inlining after the given number of roots" },
315 { "InlineMaxSize", OPT_InlineMaxSize, OPT_TYPE_VALUE, "maximum size for inlined result" },
316 { "InlineMinSize", OPT_InlineMinSize, OPT_TYPE_VALUE, "minimum size for inlined result" },
319 { "PrintConfig", OPT_PrintConfig, OPT_TYPE_BOOLEAN, "print VM configuration" },
320 { "ProfileGCMemoryUsage", OPT_ProfileGCMemoryUsage, OPT_TYPE_VALUE, "profiles GC memory usage in the given interval, <value> is in seconds (default: 5)" },
321 { "ProfileMemoryUsage", OPT_ProfileMemoryUsage, OPT_TYPE_VALUE, "TODO" },
322 { "ProfileMemoryUsageGNUPlot", OPT_ProfileMemoryUsageGNUPlot, OPT_TYPE_VALUE, "TODO" },
323 #if defined(ENABLE_REPLACEMENT)
324 { "TestReplacement", OPT_TestReplacement, OPT_TYPE_BOOLEAN, "activate all replacement points during code generation" },
326 { "TraceCompilerCalls", OPT_TraceCompilerCalls, OPT_TYPE_BOOLEAN, "trace JIT compiler calls" },
327 { "TraceExceptions", OPT_TraceExceptions, OPT_TYPE_BOOLEAN, "trace Exception throwing" },
328 { "TraceHPI", OPT_TraceHPI, OPT_TYPE_BOOLEAN, "Trace Host Porting Interface (HPI)" },
329 #if defined(ENABLE_INLINING) && !defined(NDEBUG)
330 { "TraceInlining", OPT_TraceInlining, OPT_TYPE_VALUE, "trace method inlining with the given verbosity level (default: 1)" },
332 #if !defined(ENABLE_VMLOG)
333 { "TraceJavaCalls", OPT_TraceJavaCalls, OPT_TYPE_BOOLEAN, "trace Java method calls" },
335 { "TraceJNICalls", OPT_TraceJNICalls, OPT_TYPE_BOOLEAN, "trace JNI method calls" },
336 { "TraceJVMCalls", OPT_TraceJVMCalls, OPT_TYPE_BOOLEAN, "trace JVM method calls but omit very frequent ones" },
337 { "TraceJVMCallsVerbose", OPT_TraceJVMCallsVerbose, OPT_TYPE_BOOLEAN, "trace all JVM method calls" },
338 { "TraceLinkClass", OPT_TraceLinkClass, OPT_TYPE_BOOLEAN, "trace class linking" },
339 #if defined(ENABLE_REPLACEMENT)
340 { "TraceReplacement", OPT_TraceReplacement, OPT_TYPE_VALUE, "trace on-stack replacement with the given verbosity level (default: 1)" },
342 { "TraceSubsystemInitialization", OPT_TraceSubsystemInitialization, OPT_TYPE_BOOLEAN, "trace initialization of subsystems" },
343 { "TraceTraps", OPT_TraceTraps, OPT_TYPE_BOOLEAN, "trace traps generated by JIT code" },
344 #if defined(ENABLE_VMLOG)
345 { "Vmlog", OPT_Vmlog, OPT_TYPE_VALUE, "prefix for vmlog trace files (enables vmlog)" },
346 { "VmlogStrings", OPT_VmlogStrings, OPT_TYPE_VALUE, "prefix of vmlog string file to load" },
347 { "VmlogIgnore", OPT_VmlogIgnore, OPT_TYPE_VALUE, "prefix of vmlog ignore file to load" },
352 { NULL, -1, -1, NULL }
356 /* options_get *****************************************************************
360 *******************************************************************************/
362 int options_get(opt_struct *opts, JavaVMInitArgs *vm_args)
367 if (opt_index >= vm_args->nOptions)
370 /* get the current option */
372 option = vm_args->options[opt_index].optionString;
374 if ((option == NULL) || (option[0] != '-'))
377 for (i = 0; opts[i].name; i++) {
379 /* boolean option found */
381 if (strcmp(option + 1, opts[i].name) == 0) {
383 return opts[i].value;
387 /* parameter option found */
389 /* with a space between */
391 if (strcmp(option + 1, opts[i].name) == 0) {
394 if (opt_index < vm_args->nOptions) {
395 opt_arg = os_strdup(vm_args->options[opt_index].optionString);
397 return opts[i].value;
403 /* parameter and option have no space between */
405 /* FIXME: this assumption is plain wrong, hits you if there is a
406 * parameter with no argument starting with same letter as param with argument
407 * but named after that one, ouch! */
409 size_t l = os_strlen(opts[i].name);
411 if (os_strlen(option + 1) > l) {
412 if (memcmp(option + 1, opts[i].name, l) == 0) {
414 opt_arg = os_strdup(option + 1 + l);
415 return opts[i].value;
426 /* options_xxusage *************************************************************
428 Print usage message for debugging options.
430 *******************************************************************************/
432 static void options_xxusage(void)
439 /* Prevent compiler warning. */
443 for (opt = options_XX; opt->name != NULL; opt++) {
447 case OPT_TYPE_BOOLEAN:
448 printf("+%s", opt->name);
449 length = os_strlen(" -XX:+") + os_strlen(opt->name);
453 printf("%s=<value>", opt->name);
454 length = os_strlen(" -XX:") + os_strlen(opt->name) +
455 os_strlen("=<value>");
459 vm_abort("options_xxusage: unkown option type %d", opt->type);
462 /* Check if the help fits into one 80-column line.
463 Documentation starts at column 29. */
465 if (length < (29 - 1)) {
466 /* Print missing spaces up to column 29. */
468 for (i = length; i < 29; i++)
473 printf(" "); /* 29 spaces */
476 /* Check documentation length. */
478 length = os_strlen(opt->doc);
480 if (length < (80 - 29)) {
481 printf("%s", opt->doc);
484 for (c = opt->doc, i = 29; *c != 0; c++, i++) {
485 /* If we are at the end of the line, break it. */
489 printf(" "); /* 29 spaces */
500 /* exit with error code */
506 /* options_xx ******************************************************************
510 *******************************************************************************/
512 void options_xx(JavaVMInitArgs *vm_args)
525 /* Iterate over all passed options. */
527 for (i = 0; i < vm_args->nOptions; i++) {
528 /* Get the current option. */
530 name = vm_args->options[i].optionString;
532 /* Check for help (-XX). */
534 if (strcmp(name, "-XX") == 0)
537 /* Check if the option start with -XX. */
539 start = strstr(name, "-XX:");
541 if ((start == NULL) || (start != name))
544 /* Check if the option is a boolean option. */
546 if (name[4] == '+') {
547 start = name + 4 + 1;
550 else if (name[4] == '-') {
551 start = name + 4 + 1;
559 /* Search for a '=' in the option name and get the option name
560 length and the value of the option. */
562 end = strchr(start, '=');
565 length = os_strlen(start);
569 length = end - start;
573 /* Search the option in the option array. */
575 for (opt = options_XX; opt->name != NULL; opt++) {
576 if (strncmp(opt->name, start, length) == 0) {
577 /* Check if the options passed fits to the type. */
580 case OPT_TYPE_BOOLEAN:
581 if ((enable == -1) || (value != NULL))
585 if ((enable != -1) || (value == NULL))
589 vm_abort("options_xx: unknown option type %d for option %s",
590 opt->type, opt->name);
597 /* Process the option. */
599 switch (opt->value) {
601 /* Options which must always be available (production options
604 case OPT_MaxDirectMemorySize:
605 opt_MaxDirectMemorySize = os_atoi(value);
608 case OPT_MaxPermSize:
609 /* Currently ignored. */
613 /* Currently ignored. */
616 case OPT_ThreadStackSize:
617 /* currently ignored */
620 /* Debugging options which can be turned off. */
622 case OPT_DebugExceptions:
623 opt_DebugExceptions = enable;
626 case OPT_DebugFinalizer:
627 opt_DebugFinalizer = enable;
630 case OPT_DebugLocalReferences:
631 opt_DebugLocalReferences = enable;
635 opt_DebugLocks = enable;
638 case OPT_DebugPackage:
639 opt_DebugPackage = enable;
642 case OPT_DebugPatcher:
643 opt_DebugPatcher = enable;
646 case OPT_DebugProperties:
647 opt_DebugProperties = enable;
650 case OPT_DebugStackFrameInfo:
651 opt_DebugStackFrameInfo = enable;
654 case OPT_DebugStackTrace:
655 opt_DebugStackTrace = enable;
658 case OPT_DebugThreads:
659 opt_DebugThreads = enable;
662 #if defined(ENABLE_DISASSEMBLER)
663 case OPT_DisassembleStubs:
664 opt_DisassembleStubs = enable;
668 #if defined(ENABLE_OPAGENT)
669 case OPT_EnableOpagent:
670 opt_EnableOpagent = enable;
674 #if defined(ENABLE_GC_CACAO)
675 case OPT_GCDebugRootSet:
676 opt_GCDebugRootSet = enable;
680 opt_GCStress = enable;
684 #if defined(ENABLE_INLINING)
688 #if defined(ENABLE_INLINING_DEBUG) || !defined(NDEBUG)
690 opt_InlineAll = enable;
693 case OPT_InlineCount:
695 opt_InlineCount = os_atoi(value);
698 case OPT_InlineMaxSize:
700 opt_InlineMaxSize = os_atoi(value);
703 case OPT_InlineMinSize:
705 opt_InlineMinSize = os_atoi(value);
710 case OPT_PrintConfig:
711 opt_PrintConfig = enable;
714 case OPT_ProfileGCMemoryUsage:
716 opt_ProfileGCMemoryUsage = 5;
718 opt_ProfileGCMemoryUsage = os_atoi(value);
721 case OPT_ProfileMemoryUsage:
723 opt_ProfileMemoryUsage = 5;
725 opt_ProfileMemoryUsage = os_atoi(value);
727 # if defined(ENABLE_STATISTICS)
728 /* we also need statistics */
734 case OPT_ProfileMemoryUsageGNUPlot:
736 filename = "profile.dat";
740 file = fopen(filename, "w");
743 vm_abort_errno("options_xx: fopen failed");
745 opt_ProfileMemoryUsageGNUPlot = file;
748 #if defined(ENABLE_REPLACEMENT)
749 case OPT_TestReplacement:
750 opt_TestReplacement = enable;
754 case OPT_TraceCompilerCalls:
755 opt_TraceCompilerCalls = enable;
758 case OPT_TraceExceptions:
759 opt_TraceExceptions = enable;
763 opt_TraceHPI = enable;
766 #if defined(ENABLE_INLINING) && !defined(NDEBUG)
767 case OPT_TraceInlining:
769 opt_TraceInlining = 1;
771 opt_TraceInlining = os_atoi(value);
775 case OPT_TraceJavaCalls:
776 opt_verbosecall = enable;
777 opt_TraceJavaCalls = enable;
780 case OPT_TraceJNICalls:
781 opt_TraceJNICalls = enable;
784 case OPT_TraceJVMCalls:
785 opt_TraceJVMCalls = enable;
788 case OPT_TraceJVMCallsVerbose:
789 opt_TraceJVMCallsVerbose = enable;
792 case OPT_TraceLinkClass:
793 opt_TraceLinkClass = enable;
796 #if defined(ENABLE_REPLACEMENT)
797 case OPT_TraceReplacement:
799 opt_TraceReplacement = 1;
801 opt_TraceReplacement = os_atoi(value);
805 case OPT_TraceSubsystemInitialization:
806 opt_TraceSubsystemInitialization = enable;
810 opt_TraceTraps = enable;
813 #if defined(ENABLE_VMLOG)
816 vmlog_cacao_set_prefix("vmlog");
818 vmlog_cacao_set_prefix(value);
820 opt_TraceJavaCalls = 1;
823 case OPT_VmlogStrings:
825 vmlog_cacao_set_stringprefix(value);
828 case OPT_VmlogIgnore:
830 vmlog_cacao_set_ignoreprefix(value);
835 printf("Unknown -XX option: %s\n", name);
843 * These are local overrides for various environment variables in Emacs.
844 * Please do not remove this and leave it at the end of the file, where
845 * Emacs will automagically detect them.
846 * ---------------------------------------------------------------------
849 * indent-tabs-mode: t