| |
| /*--------------------------------------------------------------------*/ |
| /*--- Command line options. m_options.c ---*/ |
| /*--------------------------------------------------------------------*/ |
| |
| /* |
| This file is part of Valgrind, a dynamic binary instrumentation |
| framework. |
| |
| Copyright (C) 2000-2011 Nicholas Nethercote |
| njn@valgrind.org |
| |
| This program is free software; you can redistribute it and/or |
| modify it under the terms of the GNU General Public License as |
| published by the Free Software Foundation; either version 2 of the |
| License, or (at your option) any later version. |
| |
| This program is distributed in the hope that it will be useful, but |
| WITHOUT ANY WARRANTY; without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| General Public License for more details. |
| |
| You should have received a copy of the GNU General Public License |
| along with this program; if not, write to the Free Software |
| Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
| 02111-1307, USA. |
| |
| The GNU General Public License is contained in the file COPYING. |
| */ |
| |
| #include "pub_core_basics.h" |
| #include "pub_core_vki.h" |
| #include "pub_core_options.h" |
| #include "pub_core_libcassert.h" |
| #include "pub_core_libcbase.h" |
| #include "pub_core_libcfile.h" |
| #include "pub_core_libcprint.h" |
| #include "pub_core_libcproc.h" |
| #include "pub_core_mallocfree.h" |
| #include "pub_core_seqmatch.h" // VG_(string_match) |
| |
| // See pub_{core,tool}_options.h for explanations of all these. |
| |
| |
| /* Define, and set defaults. */ |
| VexControl VG_(clo_vex_control); |
| Bool VG_(clo_error_limit) = True; |
| Int VG_(clo_error_exitcode) = 0; |
| |
| VgVgdb VG_(clo_vgdb) = Vg_VgdbYes; |
| Int VG_(clo_vgdb_poll) = 5000; |
| Int VG_(clo_vgdb_error) = 999999999; |
| HChar* VG_(clo_vgdb_prefix) = NULL; |
| Bool VG_(clo_vgdb_shadow_registers) = False; |
| |
| Bool VG_(clo_db_attach) = False; |
| Char* VG_(clo_db_command) = GDB_PATH " -nw %f %p"; |
| Int VG_(clo_gen_suppressions) = 0; |
| Int VG_(clo_sanity_level) = 1; |
| Int VG_(clo_verbosity) = 1; |
| Bool VG_(clo_stats) = False; |
| Bool VG_(clo_xml) = False; |
| HChar* VG_(clo_xml_user_comment) = NULL; |
| Bool VG_(clo_demangle) = True; |
| Bool VG_(clo_trace_children) = False; |
| HChar* VG_(clo_trace_children_skip) = NULL; |
| HChar* VG_(clo_trace_children_skip_by_arg) = NULL; |
| Bool VG_(clo_child_silent_after_fork) = False; |
| Char* VG_(clo_log_fname_expanded) = NULL; |
| Char* VG_(clo_xml_fname_expanded) = NULL; |
| Bool VG_(clo_time_stamp) = False; |
| Int VG_(clo_input_fd) = 0; /* stdin */ |
| Int VG_(clo_n_suppressions) = 0; |
| Char* VG_(clo_suppressions)[VG_CLO_MAX_SFILES]; |
| Int VG_(clo_n_fullpath_after) = 0; |
| Char* VG_(clo_fullpath_after)[VG_CLO_MAX_FULLPATH_AFTER]; |
| UChar VG_(clo_trace_flags) = 0; // 00000000b |
| UChar VG_(clo_profile_flags) = 0; // 00000000b |
| Int VG_(clo_trace_notbelow) = 999999999; |
| Bool VG_(clo_trace_syscalls) = False; |
| Bool VG_(clo_trace_signals) = False; |
| Bool VG_(clo_trace_symtab) = False; |
| HChar* VG_(clo_trace_symtab_patt) = "*"; |
| Bool VG_(clo_trace_cfi) = False; |
| Bool VG_(clo_debug_dump_syms) = False; |
| Bool VG_(clo_debug_dump_line) = False; |
| Bool VG_(clo_debug_dump_frames) = False; |
| Bool VG_(clo_trace_redir) = False; |
| Bool VG_(clo_trace_sched) = False; |
| Bool VG_(clo_profile_heap) = False; |
| Int VG_(clo_dump_error) = 0; |
| Int VG_(clo_backtrace_size) = 12; |
| Char* VG_(clo_sim_hints) = NULL; |
| Bool VG_(clo_sym_offsets) = False; |
| Bool VG_(clo_read_var_info) = False; |
| Int VG_(clo_n_req_tsyms) = 0; |
| HChar* VG_(clo_req_tsyms)[VG_CLO_MAX_REQ_TSYMS]; |
| HChar* VG_(clo_require_text_symbol) = NULL; |
| Bool VG_(clo_run_libc_freeres) = True; |
| Bool VG_(clo_track_fds) = False; |
| Bool VG_(clo_show_below_main)= False; |
| Bool VG_(clo_show_emwarns) = False; |
| Word VG_(clo_max_stackframe) = 2000000; |
| Word VG_(clo_main_stacksize) = 0; /* use client's rlimit.stack */ |
| Bool VG_(clo_wait_for_gdb) = False; |
| VgSmc VG_(clo_smc_check) = Vg_SmcStack; |
| HChar* VG_(clo_kernel_variant) = NULL; |
| Bool VG_(clo_dsymutil) = False; |
| Char* VG_(clo_nacl_file) = NULL; |
| Char* VG_(clo_memfs_malloc_path) = NULL; |
| Int VG_(clo_memfs_page_size) = 2048; /* 2M */ |
| |
| |
| /*====================================================================*/ |
| /*=== File expansion ===*/ |
| /*====================================================================*/ |
| |
| // Copies the string, prepending it with the startup working directory, and |
| // expanding %p and %q entries. Returns a new, malloc'd string. |
| Char* VG_(expand_file_name)(Char* option_name, Char* format) |
| { |
| static Char base_dir[VKI_PATH_MAX]; |
| Int len, i = 0, j = 0; |
| Char* out; |
| |
| Bool ok = VG_(get_startup_wd)(base_dir, VKI_PATH_MAX); |
| tl_assert(ok); |
| |
| if (VG_STREQ(format, "")) { |
| // Empty name, bad. |
| VG_(fmsg)("%s: filename is empty", option_name); |
| goto bad; |
| } |
| |
| // If 'format' starts with a '~', abort -- the user probably expected the |
| // shell to expand but it didn't (see bug 195268 for details). This means |
| // that we don't allow a legitimate filename beginning with '~' but that |
| // seems very unlikely. |
| if (format[0] == '~') { |
| VG_(fmsg)( |
| "%s: filename begins with '~'\n" |
| "You probably expected the shell to expand the '~', but it\n" |
| "didn't. The rules for '~'-expansion vary from shell to shell.\n" |
| "You might have more luck using $HOME instead.\n", |
| option_name |
| ); |
| goto bad; |
| } |
| |
| // If 'format' starts with a '/', do not prefix with startup dir. |
| if (format[0] != '/') { |
| j += VG_(strlen)(base_dir); |
| } |
| |
| // The 10 is slop, it should be enough in most cases. |
| len = j + VG_(strlen)(format) + 10; |
| out = VG_(malloc)( "options.efn.1", len ); |
| if (format[0] != '/') { |
| VG_(strcpy)(out, base_dir); |
| out[j++] = '/'; |
| } |
| |
| #define ENSURE_THIS_MUCH_SPACE(x) \ |
| if (j + x >= len) { \ |
| len += (10 + x); \ |
| out = VG_(realloc)("options.efn.2(multiple)", out, len); \ |
| } |
| |
| while (format[i]) { |
| if (format[i] != '%') { |
| ENSURE_THIS_MUCH_SPACE(1); |
| out[j++] = format[i++]; |
| |
| } else { |
| // We saw a '%'. What's next... |
| i++; |
| if ('%' == format[i]) { |
| // Replace '%%' with '%'. |
| ENSURE_THIS_MUCH_SPACE(1); |
| out[j++] = format[i++]; |
| } |
| else if ('p' == format[i]) { |
| // Print the PID. Assume that it's not longer than 10 chars -- |
| // reasonable since 'pid' is an Int (ie. 32 bits). |
| Int pid = VG_(getpid)(); |
| ENSURE_THIS_MUCH_SPACE(10); |
| j += VG_(sprintf)(&out[j], "%d", pid); |
| i++; |
| } |
| else if ('q' == format[i]) { |
| i++; |
| if ('{' == format[i]) { |
| // Get the env var name, print its contents. |
| Char* qualname; |
| Char* qual; |
| i++; |
| qualname = &format[i]; |
| while (True) { |
| if (0 == format[i]) { |
| VG_(fmsg)("%s: malformed %%q specifier\n", option_name); |
| goto bad; |
| } else if ('}' == format[i]) { |
| // Temporarily replace the '}' with NUL to extract var |
| // name. |
| format[i] = 0; |
| qual = VG_(getenv)(qualname); |
| if (NULL == qual) { |
| VG_(fmsg)("%s: environment variable %s is not set\n", |
| option_name, qualname); |
| format[i] = '}'; // Put the '}' back. |
| goto bad; |
| } |
| format[i] = '}'; // Put the '}' back. |
| i++; |
| break; |
| } |
| i++; |
| } |
| ENSURE_THIS_MUCH_SPACE(VG_(strlen)(qual)); |
| j += VG_(sprintf)(&out[j], "%s", qual); |
| } else { |
| VG_(fmsg)("%s: expected '{' after '%%q'\n", option_name); |
| goto bad; |
| } |
| } |
| else { |
| // Something else, abort. |
| VG_(fmsg)("%s: expected 'p' or 'q' or '%%' after '%%'\n", |
| option_name); |
| goto bad; |
| } |
| } |
| } |
| ENSURE_THIS_MUCH_SPACE(1); |
| out[j++] = 0; |
| |
| return out; |
| |
| bad: { |
| Char* opt = // 2: 1 for the '=', 1 for the NUL. |
| VG_(malloc)( "options.efn.3", |
| VG_(strlen)(option_name) + VG_(strlen)(format) + 2 ); |
| VG_(strcpy)(opt, option_name); |
| VG_(strcat)(opt, "="); |
| VG_(strcat)(opt, format); |
| VG_(fmsg_bad_option)(opt, ""); |
| } |
| } |
| |
| /*====================================================================*/ |
| /*=== --trace-children= support ===*/ |
| /*====================================================================*/ |
| |
| static HChar const* consume_commas ( HChar const* c ) { |
| while (*c && *c == ',') { |
| ++c; |
| } |
| return c; |
| } |
| |
| static HChar const* consume_field ( HChar const* c ) { |
| while (*c && *c != ',') { |
| ++c; |
| } |
| return c; |
| } |
| |
| /* Should we trace into this child executable (across execve etc) ? |
| This involves considering --trace-children=, |
| --trace-children-skip=, --trace-children-skip-by-arg=, and the name |
| of the executable. 'child_argv' must not include the name of the |
| executable itself; iow child_argv[0] must be the first arg, if any, |
| for the child. */ |
| Bool VG_(should_we_trace_this_child) ( HChar* child_exe_name, |
| HChar** child_argv ) |
| { |
| // child_exe_name is pulled out of the guest's space. We |
| // should be at least marginally cautious with it, lest it |
| // explode or burst into flames unexpectedly. |
| if (child_exe_name == NULL || VG_(strlen)(child_exe_name) == 0) |
| return VG_(clo_trace_children); // we know narfink |
| |
| // If --trace-children=no, the answer is simply NO. |
| if (! VG_(clo_trace_children)) |
| return False; |
| |
| // Otherwise, look for other reasons to say NO. First, |
| // see if the exe name matches any of the patterns specified |
| // by --trace-children-skip=. |
| if (VG_(clo_trace_children_skip)) { |
| HChar const* last = VG_(clo_trace_children_skip); |
| HChar const* name = (HChar const*)child_exe_name; |
| while (*last) { |
| Bool matches; |
| HChar* patt; |
| HChar const* first = consume_commas(last); |
| last = consume_field(first); |
| if (first == last) |
| break; |
| vg_assert(last > first); |
| /* copy the candidate string into a temporary malloc'd block |
| so we can use VG_(string_match) on it. */ |
| patt = VG_(calloc)("m_options.swttc.1", last - first + 1, 1); |
| VG_(memcpy)(patt, first, last - first); |
| vg_assert(patt[last-first] == 0); |
| matches = VG_(string_match)(patt, name); |
| VG_(free)(patt); |
| if (matches) |
| return False; |
| } |
| } |
| |
| // Check if any of the args match any of the patterns specified |
| // by --trace-children-skip-by-arg=. |
| if (VG_(clo_trace_children_skip_by_arg) && child_argv != NULL) { |
| HChar const* last = VG_(clo_trace_children_skip_by_arg); |
| while (*last) { |
| Int i; |
| Bool matches; |
| HChar* patt; |
| HChar const* first = consume_commas(last); |
| last = consume_field(first); |
| if (first == last) |
| break; |
| vg_assert(last > first); |
| /* copy the candidate string into a temporary malloc'd block |
| so we can use VG_(string_match) on it. */ |
| patt = VG_(calloc)("m_options.swttc.1", last - first + 1, 1); |
| VG_(memcpy)(patt, first, last - first); |
| vg_assert(patt[last-first] == 0); |
| for (i = 0; child_argv[i]; i++) { |
| matches = VG_(string_match)(patt, child_argv[i]); |
| if (matches) { |
| VG_(free)(patt); |
| return False; |
| } |
| } |
| VG_(free)(patt); |
| } |
| } |
| |
| // --trace-children=yes, and this particular executable isn't |
| // excluded |
| return True; |
| } |
| |
| |
| /*--------------------------------------------------------------------*/ |
| /*--- end ---*/ |
| /*--------------------------------------------------------------------*/ |