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/os.hpp"
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;
116 #if defined(ENABLE_OPAGENT)
117 bool opt_opagent = false;
120 /* optimization options *******************************************************/
122 #if defined(ENABLE_IFCONV)
123 bool opt_ifconv = false;
126 #if defined(ENABLE_LSRA) || defined(ENABLE_SSA)
127 bool opt_lsra = false;
129 #if defined(ENABLE_SSA)
130 bool opt_ssa_dce = false; /* enable dead code elemination */
131 bool opt_ssa_cp = false; /* enable copy propagation */
135 /* interpreter options ********************************************************/
137 #if defined(ENABLE_INTRP)
138 bool opt_no_dynamic = false; /* suppress dynamic superinstructions */
139 bool opt_no_replication = false; /* don't use replication in intrp */
140 bool opt_no_quicksuper = false; /* instructions for quickening cannot be
141 part of dynamic superinstructions */
143 s4 opt_static_supers = 0x7fffffff;
144 bool vm_debug = false; /* XXX this should be called `opt_trace' */
147 #if defined(ENABLE_DEBUG_FILTER)
148 const char *opt_filter_verbosecall_include = 0;
149 const char *opt_filter_verbosecall_exclude = 0;
150 const char *opt_filter_show_method = 0;
154 /* -XX options ****************************************************************/
156 /* NOTE: For better readability keep these alpha-sorted. */
158 /* Options which must always be available (production options in
161 int64_t opt_MaxDirectMemorySize = -1;
162 int opt_MaxPermSize = 0;
163 int opt_PermSize = 0;
164 int opt_ThreadStackSize = 0;
166 /* Debugging options which can be turned off. */
168 int opt_DebugExceptions = 0;
169 int opt_DebugFinalizer = 0;
170 int opt_DebugLocalReferences = 0;
171 int opt_DebugLocks = 0;
172 int opt_DebugPackage = 0;
173 int opt_DebugPatcher = 0;
174 int opt_DebugProperties = 0;
175 int opt_DebugStackFrameInfo = 0;
176 int opt_DebugStackTrace = 0;
177 int opt_DebugThreads = 0;
178 #if defined(ENABLE_DISASSEMBLER)
179 int opt_DisassembleStubs = 0;
181 #if defined(ENABLE_OPAGENT)
182 int opt_EnableOpagent = 0;
184 #if defined(ENABLE_GC_CACAO)
185 int opt_GCDebugRootSet = 0;
186 int opt_GCStress = 0;
188 #if defined(ENABLE_INLINING)
190 #if defined(ENABLE_INLINING_DEBUG) || !defined(NDEBUG)
191 int opt_InlineAll = 0;
192 int opt_InlineCount = INT_MAX;
193 int opt_InlineMaxSize = INT_MAX;
194 int opt_InlineMinSize = 0;
197 int opt_PrintConfig = 0;
198 int opt_ProfileGCMemoryUsage = 0;
199 int opt_ProfileMemoryUsage = 0;
200 FILE *opt_ProfileMemoryUsageGNUPlot = NULL;
201 #if defined(ENABLE_REPLACEMENT)
202 int opt_TestReplacement = 0;
204 int opt_TraceCompilerCalls = 0;
205 int opt_TraceExceptions = 0;
206 int opt_TraceHPI = 0;
207 #if defined(ENABLE_INLINING) && !defined(NDEBUG)
208 int opt_TraceInlining = 0;
210 int opt_TraceJavaCalls = 0;
211 int opt_TraceJNICalls = 0;
212 int opt_TraceJVMCalls = 0;
213 int opt_TraceJVMCallsVerbose = 0;
214 int opt_TraceLinkClass = 0;
215 #if defined(ENABLE_REPLACEMENT)
216 int opt_TraceReplacement = 0;
218 int opt_TraceSubsystemInitialization = 0;
219 int opt_TraceTraps = 0;
228 /* Options which must always be available (production options in
231 OPT_MaxDirectMemorySize,
236 /* Debugging options which can be turned off. */
240 OPT_DebugLocalReferences,
245 OPT_DebugStackFrameInfo,
248 OPT_DisassembleStubs,
258 OPT_ProfileGCMemoryUsage,
259 OPT_ProfileMemoryUsage,
260 OPT_ProfileMemoryUsageGNUPlot,
262 OPT_TraceCompilerCalls,
269 OPT_TraceJVMCallsVerbose,
271 OPT_TraceReplacement,
272 OPT_TraceSubsystemInitialization,
280 option_t options_XX[] = {
281 /* Options which must always be available (production options in
284 { "MaxDirectMemorySize", OPT_MaxDirectMemorySize, OPT_TYPE_VALUE, "Maximum total size of NIO direct-buffer allocations" },
285 { "MaxPermSize", OPT_MaxPermSize, OPT_TYPE_VALUE, "not implemented" },
286 { "PermSize", OPT_PermSize, OPT_TYPE_VALUE, "not implemented" },
287 { "ThreadStackSize", OPT_ThreadStackSize, OPT_TYPE_VALUE, "TODO" },
289 /* Debugging options which can be turned off. */
291 { "DebugExceptions", OPT_DebugExceptions, OPT_TYPE_BOOLEAN, "debug exceptions" },
292 { "DebugFinalizer", OPT_DebugFinalizer, OPT_TYPE_BOOLEAN, "debug finalizer thread" },
293 { "DebugLocalReferences", OPT_DebugLocalReferences, OPT_TYPE_BOOLEAN, "print debug information for local reference tables" },
294 { "DebugLocks", OPT_DebugLocks, OPT_TYPE_BOOLEAN, "print debug information for locks" },
295 { "DebugPackage", OPT_DebugPackage, OPT_TYPE_BOOLEAN, "debug Java boot-packages" },
296 { "DebugPatcher", OPT_DebugPatcher, OPT_TYPE_BOOLEAN, "debug JIT code patching" },
297 { "DebugProperties", OPT_DebugProperties, OPT_TYPE_BOOLEAN, "print debug information for properties" },
298 { "DebugStackFrameInfo", OPT_DebugStackFrameInfo, OPT_TYPE_BOOLEAN, "TODO" },
299 { "DebugStackTrace", OPT_DebugStackTrace, OPT_TYPE_BOOLEAN, "debug stacktrace creation" },
300 { "DebugThreads", OPT_DebugThreads, OPT_TYPE_BOOLEAN, "print debug information for threads" },
301 #if defined(ENABLE_DISASSEMBLER)
302 { "DisassembleStubs", OPT_DisassembleStubs, OPT_TYPE_BOOLEAN, "disassemble builtin and native stubs when generated" },
304 #if defined(ENABLE_OPAGENT)
305 { "EnableOpagent", OPT_EnableOpagent, OPT_TYPE_BOOLEAN, "enable providing JIT output to Oprofile" },
307 #if defined(ENABLE_GC_CACAO)
308 { "GCDebugRootSet", OPT_GCDebugRootSet, OPT_TYPE_BOOLEAN, "GC: print root-set at collection" },
309 { "GCStress", OPT_GCStress, OPT_TYPE_BOOLEAN, "GC: forced collection at every allocation" },
311 #if defined(ENABLE_INLINING)
312 { "Inline", OPT_Inline, OPT_TYPE_BOOLEAN, "enable method inlining" },
313 #if defined(ENABLE_INLINING_DEBUG) || !defined(NDEBUG)
314 { "InlineAll", OPT_InlineAll, OPT_TYPE_BOOLEAN, "use inlining in all compilations" },
315 { "InlineCount", OPT_InlineCount, OPT_TYPE_VALUE, "stop inlining after the given number of roots" },
316 { "InlineMaxSize", OPT_InlineMaxSize, OPT_TYPE_VALUE, "maximum size for inlined result" },
317 { "InlineMinSize", OPT_InlineMinSize, OPT_TYPE_VALUE, "minimum size for inlined result" },
320 { "PrintConfig", OPT_PrintConfig, OPT_TYPE_BOOLEAN, "print VM configuration" },
321 { "ProfileGCMemoryUsage", OPT_ProfileGCMemoryUsage, OPT_TYPE_VALUE, "profiles GC memory usage in the given interval, <value> is in seconds (default: 5)" },
322 { "ProfileMemoryUsage", OPT_ProfileMemoryUsage, OPT_TYPE_VALUE, "TODO" },
323 { "ProfileMemoryUsageGNUPlot", OPT_ProfileMemoryUsageGNUPlot, OPT_TYPE_VALUE, "TODO" },
324 #if defined(ENABLE_REPLACEMENT)
325 { "TestReplacement", OPT_TestReplacement, OPT_TYPE_BOOLEAN, "activate all replacement points during code generation" },
327 { "TraceCompilerCalls", OPT_TraceCompilerCalls, OPT_TYPE_BOOLEAN, "trace JIT compiler calls" },
328 { "TraceExceptions", OPT_TraceExceptions, OPT_TYPE_BOOLEAN, "trace Exception throwing" },
329 { "TraceHPI", OPT_TraceHPI, OPT_TYPE_BOOLEAN, "Trace Host Porting Interface (HPI)" },
330 #if defined(ENABLE_INLINING) && !defined(NDEBUG)
331 { "TraceInlining", OPT_TraceInlining, OPT_TYPE_VALUE, "trace method inlining with the given verbosity level (default: 1)" },
333 #if !defined(ENABLE_VMLOG)
334 { "TraceJavaCalls", OPT_TraceJavaCalls, OPT_TYPE_BOOLEAN, "trace Java method calls" },
336 { "TraceJNICalls", OPT_TraceJNICalls, OPT_TYPE_BOOLEAN, "trace JNI method calls" },
337 { "TraceJVMCalls", OPT_TraceJVMCalls, OPT_TYPE_BOOLEAN, "trace JVM method calls but omit very frequent ones" },
338 { "TraceJVMCallsVerbose", OPT_TraceJVMCallsVerbose, OPT_TYPE_BOOLEAN, "trace all JVM method calls" },
339 { "TraceLinkClass", OPT_TraceLinkClass, OPT_TYPE_BOOLEAN, "trace class linking" },
340 #if defined(ENABLE_REPLACEMENT)
341 { "TraceReplacement", OPT_TraceReplacement, OPT_TYPE_VALUE, "trace on-stack replacement with the given verbosity level (default: 1)" },
343 { "TraceSubsystemInitialization", OPT_TraceSubsystemInitialization, OPT_TYPE_BOOLEAN, "trace initialization of subsystems" },
344 { "TraceTraps", OPT_TraceTraps, OPT_TYPE_BOOLEAN, "trace traps generated by JIT code" },
345 #if defined(ENABLE_VMLOG)
346 { "Vmlog", OPT_Vmlog, OPT_TYPE_VALUE, "prefix for vmlog trace files (enables vmlog)" },
347 { "VmlogStrings", OPT_VmlogStrings, OPT_TYPE_VALUE, "prefix of vmlog string file to load" },
348 { "VmlogIgnore", OPT_VmlogIgnore, OPT_TYPE_VALUE, "prefix of vmlog ignore file to load" },
353 { NULL, -1, -1, NULL }
357 /* options_get *****************************************************************
361 *******************************************************************************/
363 int options_get(opt_struct *opts, JavaVMInitArgs *vm_args)
368 if (opt_index >= vm_args->nOptions)
371 /* get the current option */
373 option = vm_args->options[opt_index].optionString;
375 if ((option == NULL) || (option[0] != '-'))
378 for (i = 0; opts[i].name; i++) {
380 /* boolean option found */
382 if (strcmp(option + 1, opts[i].name) == 0) {
384 return opts[i].value;
388 /* parameter option found */
390 /* with a space between */
392 if (strcmp(option + 1, opts[i].name) == 0) {
395 if (opt_index < vm_args->nOptions) {
396 opt_arg = os_strdup(vm_args->options[opt_index].optionString);
398 return opts[i].value;
404 /* parameter and option have no space between */
406 /* FIXME: this assumption is plain wrong, hits you if there is a
407 * parameter with no argument starting with same letter as param with argument
408 * but named after that one, ouch! */
410 size_t l = os_strlen(opts[i].name);
412 if (os_strlen(option + 1) > l) {
413 if (memcmp(option + 1, opts[i].name, l) == 0) {
415 opt_arg = os_strdup(option + 1 + l);
416 return opts[i].value;
427 /* options_xxusage *************************************************************
429 Print usage message for debugging options.
431 *******************************************************************************/
433 static void options_xxusage(void)
440 /* Prevent compiler warning. */
444 for (opt = options_XX; opt->name != NULL; opt++) {
448 case OPT_TYPE_BOOLEAN:
449 printf("+%s", opt->name);
450 length = os_strlen(" -XX:+") + os_strlen(opt->name);
454 printf("%s=<value>", opt->name);
455 length = os_strlen(" -XX:") + os_strlen(opt->name) +
456 os_strlen("=<value>");
460 vm_abort("options_xxusage: unkown option type %d", opt->type);
463 /* Check if the help fits into one 80-column line.
464 Documentation starts at column 29. */
466 if (length < (29 - 1)) {
467 /* Print missing spaces up to column 29. */
469 for (i = length; i < 29; i++)
474 printf(" "); /* 29 spaces */
477 /* Check documentation length. */
479 length = os_strlen(opt->doc);
481 if (length < (80 - 29)) {
482 printf("%s", opt->doc);
485 for (c = opt->doc, i = 29; *c != 0; c++, i++) {
486 /* If we are at the end of the line, break it. */
490 printf(" "); /* 29 spaces */
501 /* exit with error code */
507 /* options_xx ******************************************************************
511 *******************************************************************************/
513 void options_xx(JavaVMInitArgs *vm_args)
526 /* Iterate over all passed options. */
528 for (i = 0; i < vm_args->nOptions; i++) {
529 /* Get the current option. */
531 name = vm_args->options[i].optionString;
533 /* Check for help (-XX). */
535 if (strcmp(name, "-XX") == 0)
538 /* Check if the option start with -XX. */
540 start = strstr(name, "-XX:");
542 if ((start == NULL) || (start != name))
545 /* Check if the option is a boolean option. */
547 if (name[4] == '+') {
548 start = name + 4 + 1;
551 else if (name[4] == '-') {
552 start = name + 4 + 1;
560 /* Search for a '=' in the option name and get the option name
561 length and the value of the option. */
563 end = strchr(start, '=');
566 length = os_strlen(start);
570 length = end - start;
574 /* Search the option in the option array. */
576 for (opt = options_XX; opt->name != NULL; opt++) {
577 if (strncmp(opt->name, start, length) == 0) {
578 /* Check if the options passed fits to the type. */
581 case OPT_TYPE_BOOLEAN:
582 if ((enable == -1) || (value != NULL))
586 if ((enable != -1) || (value == NULL))
590 vm_abort("options_xx: unknown option type %d for option %s",
591 opt->type, opt->name);
598 /* Process the option. */
600 switch (opt->value) {
602 /* Options which must always be available (production options
605 case OPT_MaxDirectMemorySize:
606 opt_MaxDirectMemorySize = os_atoi(value);
609 case OPT_MaxPermSize:
610 /* Currently ignored. */
614 /* Currently ignored. */
617 case OPT_ThreadStackSize:
618 /* currently ignored */
621 /* Debugging options which can be turned off. */
623 case OPT_DebugExceptions:
624 opt_DebugExceptions = enable;
627 case OPT_DebugFinalizer:
628 opt_DebugFinalizer = enable;
631 case OPT_DebugLocalReferences:
632 opt_DebugLocalReferences = enable;
636 opt_DebugLocks = enable;
639 case OPT_DebugPackage:
640 opt_DebugPackage = enable;
643 case OPT_DebugPatcher:
644 opt_DebugPatcher = enable;
647 case OPT_DebugProperties:
648 opt_DebugProperties = enable;
651 case OPT_DebugStackFrameInfo:
652 opt_DebugStackFrameInfo = enable;
655 case OPT_DebugStackTrace:
656 opt_DebugStackTrace = enable;
659 case OPT_DebugThreads:
660 opt_DebugThreads = enable;
663 #if defined(ENABLE_DISASSEMBLER)
664 case OPT_DisassembleStubs:
665 opt_DisassembleStubs = enable;
669 #if defined(ENABLE_OPAGENT)
670 case OPT_EnableOpagent:
671 opt_EnableOpagent = enable;
675 #if defined(ENABLE_GC_CACAO)
676 case OPT_GCDebugRootSet:
677 opt_GCDebugRootSet = enable;
681 opt_GCStress = enable;
685 #if defined(ENABLE_INLINING)
689 #if defined(ENABLE_INLINING_DEBUG) || !defined(NDEBUG)
691 opt_InlineAll = enable;
694 case OPT_InlineCount:
696 opt_InlineCount = os_atoi(value);
699 case OPT_InlineMaxSize:
701 opt_InlineMaxSize = os_atoi(value);
704 case OPT_InlineMinSize:
706 opt_InlineMinSize = os_atoi(value);
711 case OPT_PrintConfig:
712 opt_PrintConfig = enable;
715 case OPT_ProfileGCMemoryUsage:
717 opt_ProfileGCMemoryUsage = 5;
719 opt_ProfileGCMemoryUsage = os_atoi(value);
722 case OPT_ProfileMemoryUsage:
724 opt_ProfileMemoryUsage = 5;
726 opt_ProfileMemoryUsage = os_atoi(value);
728 # if defined(ENABLE_STATISTICS)
729 /* we also need statistics */
735 case OPT_ProfileMemoryUsageGNUPlot:
737 filename = "profile.dat";
741 file = fopen(filename, "w");
744 vm_abort_errno("options_xx: fopen failed");
746 opt_ProfileMemoryUsageGNUPlot = file;
749 #if defined(ENABLE_REPLACEMENT)
750 case OPT_TestReplacement:
751 opt_TestReplacement = enable;
755 case OPT_TraceCompilerCalls:
756 opt_TraceCompilerCalls = enable;
759 case OPT_TraceExceptions:
760 opt_TraceExceptions = enable;
764 opt_TraceHPI = enable;
767 #if defined(ENABLE_INLINING) && !defined(NDEBUG)
768 case OPT_TraceInlining:
770 opt_TraceInlining = 1;
772 opt_TraceInlining = os_atoi(value);
776 case OPT_TraceJavaCalls:
777 opt_verbosecall = enable;
778 opt_TraceJavaCalls = enable;
781 case OPT_TraceJNICalls:
782 opt_TraceJNICalls = enable;
785 case OPT_TraceJVMCalls:
786 opt_TraceJVMCalls = enable;
789 case OPT_TraceJVMCallsVerbose:
790 opt_TraceJVMCallsVerbose = enable;
793 case OPT_TraceLinkClass:
794 opt_TraceLinkClass = enable;
797 #if defined(ENABLE_REPLACEMENT)
798 case OPT_TraceReplacement:
800 opt_TraceReplacement = 1;
802 opt_TraceReplacement = os_atoi(value);
806 case OPT_TraceSubsystemInitialization:
807 opt_TraceSubsystemInitialization = enable;
811 opt_TraceTraps = enable;
814 #if defined(ENABLE_VMLOG)
817 vmlog_cacao_set_prefix("vmlog");
819 vmlog_cacao_set_prefix(value);
821 opt_TraceJavaCalls = 1;
824 case OPT_VmlogStrings:
826 vmlog_cacao_set_stringprefix(value);
829 case OPT_VmlogIgnore:
831 vmlog_cacao_set_ignoreprefix(value);
836 printf("Unknown -XX option: %s\n", name);
844 * These are local overrides for various environment variables in Emacs.
845 * Please do not remove this and leave it at the end of the file, where
846 * Emacs will automagically detect them.
847 * ---------------------------------------------------------------------
850 * indent-tabs-mode: t