/* General utility routines for GDB, the GNU debugger. Copyright (C) 1986-2013 Free Software Foundation, Inc. This file is part of GDB. 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 3 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, see . */ #include "defs.h" #include "dyn-string.h" #include "gdb_assert.h" #include #include #include "gdb_wait.h" #include "event-top.h" #include "exceptions.h" #include "gdbthread.h" #include "fnmatch.h" #include "gdb_bfd.h" #ifdef HAVE_SYS_RESOURCE_H #include #endif /* HAVE_SYS_RESOURCE_H */ #ifdef TUI #include "tui/tui.h" /* For tui_get_command_dimension. */ #endif #ifdef __GO32__ #include #endif #include #include "timeval-utils.h" #include "gdbcmd.h" #include "serial.h" #include "bfd.h" #include "target.h" #include "gdb-demangle.h" #include "expression.h" #include "language.h" #include "charset.h" #include "annotate.h" #include "filenames.h" #include "symfile.h" #include "gdb_obstack.h" #include "gdbcore.h" #include "top.h" #include "main.h" #include "solist.h" #include "inferior.h" /* for signed_pointer_to_address */ #include "gdb_curses.h" #include "readline/readline.h" #include #include #include "gdb_usleep.h" #include "interps.h" #include "gdb_regex.h" #if !HAVE_DECL_MALLOC extern PTR malloc (); /* ARI: PTR */ #endif #if !HAVE_DECL_REALLOC extern PTR realloc (); /* ARI: PTR */ #endif #if !HAVE_DECL_FREE extern void free (); #endif void (*deprecated_error_begin_hook) (void); /* Prototypes for local functions */ static void vfprintf_maybe_filtered (struct ui_file *, const char *, va_list, int) ATTRIBUTE_PRINTF (2, 0); static void fputs_maybe_filtered (const char *, struct ui_file *, int); static void prompt_for_continue (void); static void set_screen_size (void); static void set_width (void); /* Time spent in prompt_for_continue in the currently executing command waiting for user to respond. Initialized in make_command_stats_cleanup. Modified in prompt_for_continue and defaulted_query. Used in report_command_stats. */ static struct timeval prompt_for_continue_wait_time; /* A flag indicating whether to timestamp debugging messages. */ static int debug_timestamp = 0; /* Nonzero if we have job control. */ int job_control; #ifndef HAVE_PYTHON /* Nonzero means a quit has been requested. */ int quit_flag; #endif /* HAVE_PYTHON */ /* Nonzero means quit immediately if Control-C is typed now, rather than waiting until QUIT is executed. Be careful in setting this; code which executes with immediate_quit set has to be very careful about being able to deal with being interrupted at any time. It is almost always better to use QUIT; the only exception I can think of is being able to quit out of a system call (using EINTR loses if the SIGINT happens between the previous QUIT and the system call). To immediately quit in the case in which a SIGINT happens between the previous QUIT and setting immediate_quit (desirable anytime we expect to block), call QUIT after setting immediate_quit. */ int immediate_quit; #ifndef HAVE_PYTHON /* Clear the quit flag. */ void clear_quit_flag (void) { quit_flag = 0; } /* Set the quit flag. */ void set_quit_flag (void) { quit_flag = 1; } /* Return true if the quit flag has been set, false otherwise. */ int check_quit_flag (void) { /* This is written in a particular way to avoid races. */ if (quit_flag) { quit_flag = 0; return 1; } return 0; } #endif /* HAVE_PYTHON */ /* Nonzero means that strings with character values >0x7F should be printed as octal escapes. Zero means just print the value (e.g. it's an international character, and the terminal or window can cope.) */ int sevenbit_strings = 0; static void show_sevenbit_strings (struct ui_file *file, int from_tty, struct cmd_list_element *c, const char *value) { fprintf_filtered (file, _("Printing of 8-bit characters " "in strings as \\nnn is %s.\n"), value); } /* String to be printed before warning messages, if any. */ char *warning_pre_print = "\nwarning: "; int pagination_enabled = 1; static void show_pagination_enabled (struct ui_file *file, int from_tty, struct cmd_list_element *c, const char *value) { fprintf_filtered (file, _("State of pagination is %s.\n"), value); } /* Cleanup utilities. These are not defined in cleanups.c (nor declared in cleanups.h) because while they use the "cleanup API" they are not part of the "cleanup API". */ static void do_freeargv (void *arg) { freeargv ((char **) arg); } struct cleanup * make_cleanup_freeargv (char **arg) { return make_cleanup (do_freeargv, arg); } static void do_dyn_string_delete (void *arg) { dyn_string_delete ((dyn_string_t) arg); } struct cleanup * make_cleanup_dyn_string_delete (dyn_string_t arg) { return make_cleanup (do_dyn_string_delete, arg); } static void do_bfd_close_cleanup (void *arg) { gdb_bfd_unref (arg); } struct cleanup * make_cleanup_bfd_unref (bfd *abfd) { return make_cleanup (do_bfd_close_cleanup, abfd); } static void do_close_cleanup (void *arg) { int *fd = arg; close (*fd); } struct cleanup * make_cleanup_close (int fd) { int *saved_fd = xmalloc (sizeof (fd)); *saved_fd = fd; return make_cleanup_dtor (do_close_cleanup, saved_fd, xfree); } /* Helper function which does the work for make_cleanup_fclose. */ static void do_fclose_cleanup (void *arg) { FILE *file = arg; fclose (file); } /* Return a new cleanup that closes FILE. */ struct cleanup * make_cleanup_fclose (FILE *file) { return make_cleanup (do_fclose_cleanup, file); } /* Helper function which does the work for make_cleanup_obstack_free. */ static void do_obstack_free (void *arg) { struct obstack *ob = arg; obstack_free (ob, NULL); } /* Return a new cleanup that frees OBSTACK. */ struct cleanup * make_cleanup_obstack_free (struct obstack *obstack) { return make_cleanup (do_obstack_free, obstack); } static void do_ui_file_delete (void *arg) { ui_file_delete (arg); } struct cleanup * make_cleanup_ui_file_delete (struct ui_file *arg) { return make_cleanup (do_ui_file_delete, arg); } /* Helper function for make_cleanup_ui_out_redirect_pop. */ static void do_ui_out_redirect_pop (void *arg) { struct ui_out *uiout = arg; if (ui_out_redirect (uiout, NULL) < 0) warning (_("Cannot restore redirection of the current output protocol")); } /* Return a new cleanup that pops the last redirection by ui_out_redirect with NULL parameter. */ struct cleanup * make_cleanup_ui_out_redirect_pop (struct ui_out *uiout) { return make_cleanup (do_ui_out_redirect_pop, uiout); } static void do_free_section_addr_info (void *arg) { free_section_addr_info (arg); } struct cleanup * make_cleanup_free_section_addr_info (struct section_addr_info *addrs) { return make_cleanup (do_free_section_addr_info, addrs); } struct restore_integer_closure { int *variable; int value; }; static void restore_integer (void *p) { struct restore_integer_closure *closure = p; *(closure->variable) = closure->value; } /* Remember the current value of *VARIABLE and make it restored when the cleanup is run. */ struct cleanup * make_cleanup_restore_integer (int *variable) { struct restore_integer_closure *c = xmalloc (sizeof (struct restore_integer_closure)); c->variable = variable; c->value = *variable; return make_cleanup_dtor (restore_integer, (void *) c, xfree); } /* Remember the current value of *VARIABLE and make it restored when the cleanup is run. */ struct cleanup * make_cleanup_restore_uinteger (unsigned int *variable) { return make_cleanup_restore_integer ((int *) variable); } /* Helper for make_cleanup_unpush_target. */ static void do_unpush_target (void *arg) { struct target_ops *ops = arg; unpush_target (ops); } /* Return a new cleanup that unpushes OPS. */ struct cleanup * make_cleanup_unpush_target (struct target_ops *ops) { return make_cleanup (do_unpush_target, ops); } /* Helper for make_cleanup_htab_delete compile time checking the types. */ static void do_htab_delete_cleanup (void *htab_voidp) { htab_t htab = htab_voidp; htab_delete (htab); } /* Return a new cleanup that deletes HTAB. */ struct cleanup * make_cleanup_htab_delete (htab_t htab) { return make_cleanup (do_htab_delete_cleanup, htab); } struct restore_ui_file_closure { struct ui_file **variable; struct ui_file *value; }; static void do_restore_ui_file (void *p) { struct restore_ui_file_closure *closure = p; *(closure->variable) = closure->value; } /* Remember the current value of *VARIABLE and make it restored when the cleanup is run. */ struct cleanup * make_cleanup_restore_ui_file (struct ui_file **variable) { struct restore_ui_file_closure *c = XNEW (struct restore_ui_file_closure); c->variable = variable; c->value = *variable; return make_cleanup_dtor (do_restore_ui_file, (void *) c, xfree); } /* Helper for make_cleanup_value_free_to_mark. */ static void do_value_free_to_mark (void *value) { value_free_to_mark ((struct value *) value); } /* Free all values allocated since MARK was obtained by value_mark (except for those released) when the cleanup is run. */ struct cleanup * make_cleanup_value_free_to_mark (struct value *mark) { return make_cleanup (do_value_free_to_mark, mark); } /* Helper for make_cleanup_value_free. */ static void do_value_free (void *value) { value_free (value); } /* Free VALUE. */ struct cleanup * make_cleanup_value_free (struct value *value) { return make_cleanup (do_value_free, value); } /* Helper for make_cleanup_free_so. */ static void do_free_so (void *arg) { struct so_list *so = arg; free_so (so); } /* Make cleanup handler calling free_so for SO. */ struct cleanup * make_cleanup_free_so (struct so_list *so) { return make_cleanup (do_free_so, so); } /* Helper for make_cleanup_restore_current_language. */ static void do_restore_current_language (void *p) { enum language saved_lang = (uintptr_t) p; set_language (saved_lang); } /* Remember the current value of CURRENT_LANGUAGE and make it restored when the cleanup is run. */ struct cleanup * make_cleanup_restore_current_language (void) { enum language saved_lang = current_language->la_language; return make_cleanup (do_restore_current_language, (void *) (uintptr_t) saved_lang); } /* This function is useful for cleanups. Do foo = xmalloc (...); old_chain = make_cleanup (free_current_contents, &foo); to arrange to free the object thus allocated. */ void free_current_contents (void *ptr) { void **location = ptr; if (location == NULL) internal_error (__FILE__, __LINE__, _("free_current_contents: NULL pointer")); if (*location != NULL) { xfree (*location); *location = NULL; } } /* Print a warning message. The first argument STRING is the warning message, used as an fprintf format string, the second is the va_list of arguments for that string. A warning is unfiltered (not paginated) so that the user does not need to page through each screen full of warnings when there are lots of them. */ void vwarning (const char *string, va_list args) { if (deprecated_warning_hook) (*deprecated_warning_hook) (string, args); else { target_terminal_ours (); wrap_here (""); /* Force out any buffered output. */ gdb_flush (gdb_stdout); if (warning_pre_print) fputs_unfiltered (warning_pre_print, gdb_stderr); vfprintf_unfiltered (gdb_stderr, string, args); fprintf_unfiltered (gdb_stderr, "\n"); va_end (args); } } /* Print a warning message. The first argument STRING is the warning message, used as a fprintf string, and the remaining args are passed as arguments to it. The primary difference between warnings and errors is that a warning does not force the return to command level. */ void warning (const char *string, ...) { va_list args; va_start (args, string); vwarning (string, args); va_end (args); } /* Print an error message and return to command level. The first argument STRING is the error message, used as a fprintf string, and the remaining args are passed as arguments to it. */ void verror (const char *string, va_list args) { throw_verror (GENERIC_ERROR, string, args); } void error (const char *string, ...) { va_list args; va_start (args, string); throw_verror (GENERIC_ERROR, string, args); va_end (args); } /* Print an error message and quit. The first argument STRING is the error message, used as a fprintf string, and the remaining args are passed as arguments to it. */ void vfatal (const char *string, va_list args) { throw_vfatal (string, args); } void fatal (const char *string, ...) { va_list args; va_start (args, string); throw_vfatal (string, args); va_end (args); } void error_stream (struct ui_file *stream) { char *message = ui_file_xstrdup (stream, NULL); make_cleanup (xfree, message); error (("%s"), message); } /* Dump core trying to increase the core soft limit to hard limit first. */ static void dump_core (void) { #ifdef HAVE_SETRLIMIT struct rlimit rlim = { RLIM_INFINITY, RLIM_INFINITY }; setrlimit (RLIMIT_CORE, &rlim); #endif /* HAVE_SETRLIMIT */ abort (); /* NOTE: GDB has only three calls to abort(). */ } /* Check whether GDB will be able to dump core using the dump_core function. */ static int can_dump_core (const char *reason) { #ifdef HAVE_GETRLIMIT struct rlimit rlim; /* Be quiet and assume we can dump if an error is returned. */ if (getrlimit (RLIMIT_CORE, &rlim) != 0) return 1; if (rlim.rlim_max == 0) { fprintf_unfiltered (gdb_stderr, _("%s\nUnable to dump core, use `ulimit -c" " unlimited' before executing GDB next time.\n"), reason); return 0; } #endif /* HAVE_GETRLIMIT */ return 1; } /* Allow the user to configure the debugger behavior with respect to what to do when an internal problem is detected. */ const char internal_problem_ask[] = "ask"; const char internal_problem_yes[] = "yes"; const char internal_problem_no[] = "no"; static const char *const internal_problem_modes[] = { internal_problem_ask, internal_problem_yes, internal_problem_no, NULL }; /* Print a message reporting an internal error/warning. Ask the user if they want to continue, dump core, or just exit. Return something to indicate a quit. */ struct internal_problem { const char *name; const char *should_quit; const char *should_dump_core; }; /* Report a problem, internal to GDB, to the user. Once the problem has been reported, and assuming GDB didn't quit, the caller can either allow execution to resume or throw an error. */ static void ATTRIBUTE_PRINTF (4, 0) internal_vproblem (struct internal_problem *problem, const char *file, int line, const char *fmt, va_list ap) { static int dejavu; int quit_p; int dump_core_p; char *reason; struct cleanup *cleanup = make_cleanup (null_cleanup, NULL); /* Don't allow infinite error/warning recursion. */ { static char msg[] = "Recursive internal problem.\n"; switch (dejavu) { case 0: dejavu = 1; break; case 1: dejavu = 2; fputs_unfiltered (msg, gdb_stderr); abort (); /* NOTE: GDB has only three calls to abort(). */ default: dejavu = 3; /* Newer GLIBC versions put the warn_unused_result attribute on write, but this is one of those rare cases where ignoring the return value is correct. Casting to (void) does not fix this problem. This is the solution suggested at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */ if (write (STDERR_FILENO, msg, sizeof (msg)) != sizeof (msg)) abort (); /* NOTE: GDB has only three calls to abort(). */ exit (1); } } /* Try to get the message out and at the start of a new line. */ target_terminal_ours (); begin_line (); /* Create a string containing the full error/warning message. Need to call query with this full string, as otherwize the reason (error/warning) and question become separated. Format using a style similar to a compiler error message. Include extra detail so that the user knows that they are living on the edge. */ { char *msg; msg = xstrvprintf (fmt, ap); reason = xstrprintf ("%s:%d: %s: %s\n" "A problem internal to GDB has been detected,\n" "further debugging may prove unreliable.", file, line, problem->name, msg); xfree (msg); make_cleanup (xfree, reason); } if (problem->should_quit == internal_problem_ask) { /* Default (yes/batch case) is to quit GDB. When in batch mode this lessens the likelihood of GDB going into an infinite loop. */ if (!confirm) { /* Emit the message and quit. */ fputs_unfiltered (reason, gdb_stderr); fputs_unfiltered ("\n", gdb_stderr); quit_p = 1; } else quit_p = query (_("%s\nQuit this debugging session? "), reason); } else if (problem->should_quit == internal_problem_yes) quit_p = 1; else if (problem->should_quit == internal_problem_no) quit_p = 0; else internal_error (__FILE__, __LINE__, _("bad switch")); if (problem->should_dump_core == internal_problem_ask) { if (!can_dump_core (reason)) dump_core_p = 0; else { /* Default (yes/batch case) is to dump core. This leaves a GDB `dropping' so that it is easier to see that something went wrong in GDB. */ dump_core_p = query (_("%s\nCreate a core file of GDB? "), reason); } } else if (problem->should_dump_core == internal_problem_yes) dump_core_p = can_dump_core (reason); else if (problem->should_dump_core == internal_problem_no) dump_core_p = 0; else internal_error (__FILE__, __LINE__, _("bad switch")); if (quit_p) { if (dump_core_p) dump_core (); else exit (1); } else { if (dump_core_p) { #ifdef HAVE_WORKING_FORK if (fork () == 0) dump_core (); #endif } } dejavu = 0; do_cleanups (cleanup); } static struct internal_problem internal_error_problem = { "internal-error", internal_problem_ask, internal_problem_ask }; void internal_verror (const char *file, int line, const char *fmt, va_list ap) { internal_vproblem (&internal_error_problem, file, line, fmt, ap); fatal (_("Command aborted.")); } void internal_error (const char *file, int line, const char *string, ...) { va_list ap; va_start (ap, string); internal_verror (file, line, string, ap); va_end (ap); } static struct internal_problem internal_warning_problem = { "internal-warning", internal_problem_ask, internal_problem_ask }; void internal_vwarning (const char *file, int line, const char *fmt, va_list ap) { internal_vproblem (&internal_warning_problem, file, line, fmt, ap); } void internal_warning (const char *file, int line, const char *string, ...) { va_list ap; va_start (ap, string); internal_vwarning (file, line, string, ap); va_end (ap); } /* Dummy functions to keep add_prefix_cmd happy. */ static void set_internal_problem_cmd (char *args, int from_tty) { } static void show_internal_problem_cmd (char *args, int from_tty) { } /* When GDB reports an internal problem (error or warning) it gives the user the opportunity to quit GDB and/or create a core file of the current debug session. This function registers a few commands that make it possible to specify that GDB should always or never quit or create a core file, without asking. The commands look like: maint set PROBLEM-NAME quit ask|yes|no maint show PROBLEM-NAME quit maint set PROBLEM-NAME corefile ask|yes|no maint show PROBLEM-NAME corefile Where PROBLEM-NAME is currently "internal-error" or "internal-warning". */ static void add_internal_problem_command (struct internal_problem *problem) { struct cmd_list_element **set_cmd_list; struct cmd_list_element **show_cmd_list; char *set_doc; char *show_doc; set_cmd_list = xmalloc (sizeof (*set_cmd_list)); show_cmd_list = xmalloc (sizeof (*set_cmd_list)); *set_cmd_list = NULL; *show_cmd_list = NULL; set_doc = xstrprintf (_("Configure what GDB does when %s is detected."), problem->name); show_doc = xstrprintf (_("Show what GDB does when %s is detected."), problem->name); add_prefix_cmd ((char*) problem->name, class_maintenance, set_internal_problem_cmd, set_doc, set_cmd_list, concat ("maintenance set ", problem->name, " ", (char *) NULL), 0/*allow-unknown*/, &maintenance_set_cmdlist); add_prefix_cmd ((char*) problem->name, class_maintenance, show_internal_problem_cmd, show_doc, show_cmd_list, concat ("maintenance show ", problem->name, " ", (char *) NULL), 0/*allow-unknown*/, &maintenance_show_cmdlist); set_doc = xstrprintf (_("Set whether GDB should quit " "when an %s is detected"), problem->name); show_doc = xstrprintf (_("Show whether GDB will quit " "when an %s is detected"), problem->name); add_setshow_enum_cmd ("quit", class_maintenance, internal_problem_modes, &problem->should_quit, set_doc, show_doc, NULL, /* help_doc */ NULL, /* setfunc */ NULL, /* showfunc */ set_cmd_list, show_cmd_list); xfree (set_doc); xfree (show_doc); set_doc = xstrprintf (_("Set whether GDB should create a core " "file of GDB when %s is detected"), problem->name); show_doc = xstrprintf (_("Show whether GDB will create a core " "file of GDB when %s is detected"), problem->name); add_setshow_enum_cmd ("corefile", class_maintenance, internal_problem_modes, &problem->should_dump_core, set_doc, show_doc, NULL, /* help_doc */ NULL, /* setfunc */ NULL, /* showfunc */ set_cmd_list, show_cmd_list); xfree (set_doc); xfree (show_doc); } /* Return a newly allocated string, containing the PREFIX followed by the system error message for errno (separated by a colon). The result must be deallocated after use. */ static char * perror_string (const char *prefix) { char *err; char *combined; err = safe_strerror (errno); combined = (char *) xmalloc (strlen (err) + strlen (prefix) + 3); strcpy (combined, prefix); strcat (combined, ": "); strcat (combined, err); return combined; } /* Print the system error message for errno, and also mention STRING as the file name for which the error was encountered. Use ERRCODE for the thrown exception. Then return to command level. */ void throw_perror_with_name (enum errors errcode, const char *string) { char *combined; combined = perror_string (string); make_cleanup (xfree, combined); /* I understand setting these is a matter of taste. Still, some people may clear errno but not know about bfd_error. Doing this here is not unreasonable. */ bfd_set_error (bfd_error_no_error); errno = 0; throw_error (errcode, _("%s."), combined); } /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */ void perror_with_name (const char *string) { throw_perror_with_name (GENERIC_ERROR, string); } /* Same as perror_with_name except that it prints a warning instead of throwing an error. */ void perror_warning_with_name (const char *string) { char *combined; combined = perror_string (string); warning (_("%s"), combined); xfree (combined); } /* Print the system error message for ERRCODE, and also mention STRING as the file name for which the error was encountered. */ void print_sys_errmsg (const char *string, int errcode) { char *err; char *combined; err = safe_strerror (errcode); combined = (char *) alloca (strlen (err) + strlen (string) + 3); strcpy (combined, string); strcat (combined, ": "); strcat (combined, err); /* We want anything which was printed on stdout to come out first, before this message. */ gdb_flush (gdb_stdout); fprintf_unfiltered (gdb_stderr, "%s.\n", combined); } /* Control C eventually causes this to be called, at a convenient time. */ void quit (void) { #ifdef __MSDOS__ /* No steenking SIGINT will ever be coming our way when the program is resumed. Don't lie. */ fatal ("Quit"); #else if (job_control /* If there is no terminal switching for this target, then we can't possibly get screwed by the lack of job control. */ || current_target.to_terminal_ours == NULL) fatal ("Quit"); else fatal ("Quit (expect signal SIGINT when the program is resumed)"); #endif } /* Called when a memory allocation fails, with the number of bytes of memory requested in SIZE. */ void malloc_failure (long size) { if (size > 0) { internal_error (__FILE__, __LINE__, _("virtual memory exhausted: can't allocate %ld bytes."), size); } else { internal_error (__FILE__, __LINE__, _("virtual memory exhausted.")); } } /* My replacement for the read system call. Used like `read' but keeps going if `read' returns too soon. */ int myread (int desc, char *addr, int len) { int val; int orglen = len; while (len > 0) { val = read (desc, addr, len); if (val < 0) return val; if (val == 0) return orglen - len; len -= val; addr += val; } return orglen; } void print_spaces (int n, struct ui_file *file) { fputs_unfiltered (n_spaces (n), file); } /* Print a host address. */ void gdb_print_host_address (const void *addr, struct ui_file *stream) { fprintf_filtered (stream, "%s", host_address_to_string (addr)); } /* A cleanup function that calls regfree. */ static void do_regfree_cleanup (void *r) { regfree (r); } /* Create a new cleanup that frees the compiled regular expression R. */ struct cleanup * make_regfree_cleanup (regex_t *r) { return make_cleanup (do_regfree_cleanup, r); } /* Return an xmalloc'd error message resulting from a regular expression compilation failure. */ char * get_regcomp_error (int code, regex_t *rx) { size_t length = regerror (code, rx, NULL, 0); char *result = xmalloc (length); regerror (code, rx, result, length); return result; } /* Compile a regexp and throw an exception on error. This returns a cleanup to free the resulting pattern on success. RX must not be NULL. */ struct cleanup * compile_rx_or_error (regex_t *pattern, const char *rx, const char *message) { int code; gdb_assert (rx != NULL); code = regcomp (pattern, rx, REG_NOSUB); if (code != 0) { char *err = get_regcomp_error (code, pattern); make_cleanup (xfree, err); error (("%s: %s"), message, err); } return make_regfree_cleanup (pattern); } /* This function supports the query, nquery, and yquery functions. Ask user a y-or-n question and return 0 if answer is no, 1 if answer is yes, or default the answer to the specified default (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a default answer, or '\0' for no default. CTLSTR is the control string and should end in "? ". It should not say how to answer, because we do that. ARGS are the arguments passed along with the CTLSTR argument to printf. */ static int ATTRIBUTE_PRINTF (1, 0) defaulted_query (const char *ctlstr, const char defchar, va_list args) { int answer; int ans2; int retval; int def_value; char def_answer, not_def_answer; char *y_string, *n_string, *question; /* Used to add duration we waited for user to respond to prompt_for_continue_wait_time. */ struct timeval prompt_started, prompt_ended, prompt_delta; /* Set up according to which answer is the default. */ if (defchar == '\0') { def_value = 1; def_answer = 'Y'; not_def_answer = 'N'; y_string = "y"; n_string = "n"; } else if (defchar == 'y') { def_value = 1; def_answer = 'Y'; not_def_answer = 'N'; y_string = "[y]"; n_string = "n"; } else { def_value = 0; def_answer = 'N'; not_def_answer = 'Y'; y_string = "y"; n_string = "[n]"; } /* Automatically answer the default value if the user did not want prompts or the command was issued with the server prefix. */ if (!confirm || server_command) return def_value; /* If input isn't coming from the user directly, just say what question we're asking, and then answer the default automatically. This way, important error messages don't get lost when talking to GDB over a pipe. */ if (! input_from_terminal_p ()) { wrap_here (""); vfprintf_filtered (gdb_stdout, ctlstr, args); printf_filtered (_("(%s or %s) [answered %c; " "input not from terminal]\n"), y_string, n_string, def_answer); gdb_flush (gdb_stdout); return def_value; } if (deprecated_query_hook) { return deprecated_query_hook (ctlstr, args); } /* Format the question outside of the loop, to avoid reusing args. */ question = xstrvprintf (ctlstr, args); /* Used for calculating time spend waiting for user. */ gettimeofday (&prompt_started, NULL); while (1) { wrap_here (""); /* Flush any buffered output. */ gdb_flush (gdb_stdout); if (annotation_level > 1) printf_filtered (("\n\032\032pre-query\n")); fputs_filtered (question, gdb_stdout); printf_filtered (_("(%s or %s) "), y_string, n_string); if (annotation_level > 1) printf_filtered (("\n\032\032query\n")); wrap_here (""); gdb_flush (gdb_stdout); answer = fgetc (stdin); /* We expect fgetc to block until a character is read. But this may not be the case if the terminal was opened with the NONBLOCK flag. In that case, if there is nothing to read on stdin, fgetc returns EOF, but also sets the error condition flag on stdin and errno to EAGAIN. With a true EOF, stdin's error condition flag is not set. A situation where this behavior was observed is a pseudo terminal on AIX. */ while (answer == EOF && ferror (stdin) && errno == EAGAIN) { /* Not a real EOF. Wait a little while and try again until we read something. */ clearerr (stdin); gdb_usleep (10000); answer = fgetc (stdin); } clearerr (stdin); /* in case of C-d */ if (answer == EOF) /* C-d */ { printf_filtered ("EOF [assumed %c]\n", def_answer); retval = def_value; break; } /* Eat rest of input line, to EOF or newline. */ if (answer != '\n') do { ans2 = fgetc (stdin); clearerr (stdin); } while (ans2 != EOF && ans2 != '\n' && ans2 != '\r'); if (answer >= 'a') answer -= 040; /* Check answer. For the non-default, the user must specify the non-default explicitly. */ if (answer == not_def_answer) { retval = !def_value; break; } /* Otherwise, if a default was specified, the user may either specify the required input or have it default by entering nothing. */ if (answer == def_answer || (defchar != '\0' && (answer == '\n' || answer == '\r' || answer == EOF))) { retval = def_value; break; } /* Invalid entries are not defaulted and require another selection. */ printf_filtered (_("Please answer %s or %s.\n"), y_string, n_string); } /* Add time spend in this routine to prompt_for_continue_wait_time. */ gettimeofday (&prompt_ended, NULL); timeval_sub (&prompt_delta, &prompt_ended, &prompt_started); timeval_add (&prompt_for_continue_wait_time, &prompt_for_continue_wait_time, &prompt_delta); xfree (question); if (annotation_level > 1) printf_filtered (("\n\032\032post-query\n")); return retval; } /* Ask user a y-or-n question and return 0 if answer is no, 1 if answer is yes, or 0 if answer is defaulted. Takes three args which are given to printf to print the question. The first, a control string, should end in "? ". It should not say how to answer, because we do that. */ int nquery (const char *ctlstr, ...) { va_list args; int ret; va_start (args, ctlstr); ret = defaulted_query (ctlstr, 'n', args); va_end (args); return ret; } /* Ask user a y-or-n question and return 0 if answer is no, 1 if answer is yes, or 1 if answer is defaulted. Takes three args which are given to printf to print the question. The first, a control string, should end in "? ". It should not say how to answer, because we do that. */ int yquery (const char *ctlstr, ...) { va_list args; int ret; va_start (args, ctlstr); ret = defaulted_query (ctlstr, 'y', args); va_end (args); return ret; } /* Ask user a y-or-n question and return 1 iff answer is yes. Takes three args which are given to printf to print the question. The first, a control string, should end in "? ". It should not say how to answer, because we do that. */ int query (const char *ctlstr, ...) { va_list args; int ret; va_start (args, ctlstr); ret = defaulted_query (ctlstr, '\0', args); va_end (args); return ret; } /* A helper for parse_escape that converts a host character to a target character. C is the host character. If conversion is possible, then the target character is stored in *TARGET_C and the function returns 1. Otherwise, the function returns 0. */ static int host_char_to_target (struct gdbarch *gdbarch, int c, int *target_c) { struct obstack host_data; char the_char = c; struct cleanup *cleanups; int result = 0; obstack_init (&host_data); cleanups = make_cleanup_obstack_free (&host_data); convert_between_encodings (target_charset (gdbarch), host_charset (), (gdb_byte *) &the_char, 1, 1, &host_data, translit_none); if (obstack_object_size (&host_data) == 1) { result = 1; *target_c = *(char *) obstack_base (&host_data); } do_cleanups (cleanups); return result; } /* Parse a C escape sequence. STRING_PTR points to a variable containing a pointer to the string to parse. That pointer should point to the character after the \. That pointer is updated past the characters we use. The value of the escape sequence is returned. A negative value means the sequence \ newline was seen, which is supposed to be equivalent to nothing at all. If \ is followed by a null character, we return a negative value and leave the string pointer pointing at the null character. If \ is followed by 000, we return 0 and leave the string pointer after the zeros. A value of 0 does not mean end of string. */ int parse_escape (struct gdbarch *gdbarch, const char **string_ptr) { int target_char = -2; /* Initialize to avoid GCC warnings. */ int c = *(*string_ptr)++; switch (c) { case '\n': return -2; case 0: (*string_ptr)--; return 0; case '0': case '1': case '2': case '3': case '4': case '5': case '6': case '7': { int i = host_hex_value (c); int count = 0; while (++count < 3) { c = (**string_ptr); if (isdigit (c) && c != '8' && c != '9') { (*string_ptr)++; i *= 8; i += host_hex_value (c); } else { break; } } return i; } case 'a': c = '\a'; break; case 'b': c = '\b'; break; case 'f': c = '\f'; break; case 'n': c = '\n'; break; case 'r': c = '\r'; break; case 't': c = '\t'; break; case 'v': c = '\v'; break; default: break; } if (!host_char_to_target (gdbarch, c, &target_char)) error (_("The escape sequence `\\%c' is equivalent to plain `%c'," " which has no equivalent\nin the `%s' character set."), c, c, target_charset (gdbarch)); return target_char; } /* Print the character C on STREAM as part of the contents of a literal string whose delimiter is QUOTER. Note that this routine should only be call for printing things which are independent of the language of the program being debugged. */ static void printchar (int c, void (*do_fputs) (const char *, struct ui_file *), void (*do_fprintf) (struct ui_file *, const char *, ...) ATTRIBUTE_FPTR_PRINTF_2, struct ui_file *stream, int quoter) { c &= 0xFF; /* Avoid sign bit follies */ if (c < 0x20 || /* Low control chars */ (c >= 0x7F && c < 0xA0) || /* DEL, High controls */ (sevenbit_strings && c >= 0x80)) { /* high order bit set */ switch (c) { case '\n': do_fputs ("\\n", stream); break; case '\b': do_fputs ("\\b", stream); break; case '\t': do_fputs ("\\t", stream); break; case '\f': do_fputs ("\\f", stream); break; case '\r': do_fputs ("\\r", stream); break; case '\033': do_fputs ("\\e", stream); break; case '\007': do_fputs ("\\a", stream); break; default: do_fprintf (stream, "\\%.3o", (unsigned int) c); break; } } else { if (c == '\\' || c == quoter) do_fputs ("\\", stream); do_fprintf (stream, "%c", c); } } /* Print the character C on STREAM as part of the contents of a literal string whose delimiter is QUOTER. Note that these routines should only be call for printing things which are independent of the language of the program being debugged. */ void fputstr_filtered (const char *str, int quoter, struct ui_file *stream) { while (*str) printchar (*str++, fputs_filtered, fprintf_filtered, stream, quoter); } void fputstr_unfiltered (const char *str, int quoter, struct ui_file *stream) { while (*str) printchar (*str++, fputs_unfiltered, fprintf_unfiltered, stream, quoter); } void fputstrn_filtered (const char *str, int n, int quoter, struct ui_file *stream) { int i; for (i = 0; i < n; i++) printchar (str[i], fputs_filtered, fprintf_filtered, stream, quoter); } void fputstrn_unfiltered (const char *str, int n, int quoter, struct ui_file *stream) { int i; for (i = 0; i < n; i++) printchar (str[i], fputs_unfiltered, fprintf_unfiltered, stream, quoter); } /* Number of lines per page or UINT_MAX if paging is disabled. */ static unsigned int lines_per_page; static void show_lines_per_page (struct ui_file *file, int from_tty, struct cmd_list_element *c, const char *value) { fprintf_filtered (file, _("Number of lines gdb thinks are in a page is %s.\n"), value); } /* Number of chars per line or UINT_MAX if line folding is disabled. */ static unsigned int chars_per_line; static void show_chars_per_line (struct ui_file *file, int from_tty, struct cmd_list_element *c, const char *value) { fprintf_filtered (file, _("Number of characters gdb thinks " "are in a line is %s.\n"), value); } /* Current count of lines printed on this page, chars on this line. */ static unsigned int lines_printed, chars_printed; /* Buffer and start column of buffered text, for doing smarter word- wrapping. When someone calls wrap_here(), we start buffering output that comes through fputs_filtered(). If we see a newline, we just spit it out and forget about the wrap_here(). If we see another wrap_here(), we spit it out and remember the newer one. If we see the end of the line, we spit out a newline, the indent, and then the buffered output. */ /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which are waiting to be output (they have already been counted in chars_printed). When wrap_buffer[0] is null, the buffer is empty. */ static char *wrap_buffer; /* Pointer in wrap_buffer to the next character to fill. */ static char *wrap_pointer; /* String to indent by if the wrap occurs. Must not be NULL if wrap_column is non-zero. */ static char *wrap_indent; /* Column number on the screen where wrap_buffer begins, or 0 if wrapping is not in effect. */ static int wrap_column; /* Inialize the number of lines per page and chars per line. */ void init_page_info (void) { if (batch_flag) { lines_per_page = UINT_MAX; chars_per_line = UINT_MAX; } else #if defined(TUI) if (!tui_get_command_dimension (&chars_per_line, &lines_per_page)) #endif { int rows, cols; #if defined(__GO32__) rows = ScreenRows (); cols = ScreenCols (); lines_per_page = rows; chars_per_line = cols; #else /* Make sure Readline has initialized its terminal settings. */ rl_reset_terminal (NULL); /* Get the screen size from Readline. */ rl_get_screen_size (&rows, &cols); lines_per_page = rows; chars_per_line = cols; /* Readline should have fetched the termcap entry for us. Only try to use tgetnum function if rl_get_screen_size did not return a useful value. */ if (((rows <= 0) && (tgetnum ("li") < 0)) /* Also disable paging if inside EMACS. */ || getenv ("EMACS")) { /* The number of lines per page is not mentioned in the terminal description or EMACS evironment variable is set. This probably means that paging is not useful, so disable paging. */ lines_per_page = UINT_MAX; } /* If the output is not a terminal, don't paginate it. */ if (!ui_file_isatty (gdb_stdout)) lines_per_page = UINT_MAX; #endif } set_screen_size (); set_width (); } /* Helper for make_cleanup_restore_page_info. */ static void do_restore_page_info_cleanup (void *arg) { set_screen_size (); set_width (); } /* Provide cleanup for restoring the terminal size. */ struct cleanup * make_cleanup_restore_page_info (void) { struct cleanup *back_to; back_to = make_cleanup (do_restore_page_info_cleanup, NULL); make_cleanup_restore_uinteger (&lines_per_page); make_cleanup_restore_uinteger (&chars_per_line); return back_to; } /* Temporarily set BATCH_FLAG and the associated unlimited terminal size. Provide cleanup for restoring the original state. */ struct cleanup * set_batch_flag_and_make_cleanup_restore_page_info (void) { struct cleanup *back_to = make_cleanup_restore_page_info (); make_cleanup_restore_integer (&batch_flag); batch_flag = 1; init_page_info (); return back_to; } /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */ static void set_screen_size (void) { int rows = lines_per_page; int cols = chars_per_line; if (rows <= 0) rows = INT_MAX; if (cols <= 0) cols = INT_MAX; /* Update Readline's idea of the terminal size. */ rl_set_screen_size (rows, cols); } /* Reinitialize WRAP_BUFFER according to the current value of CHARS_PER_LINE. */ static void set_width (void) { if (chars_per_line == 0) init_page_info (); if (!wrap_buffer) { wrap_buffer = (char *) xmalloc (chars_per_line + 2); wrap_buffer[0] = '\0'; } else wrap_buffer = (char *) xrealloc (wrap_buffer, chars_per_line + 2); wrap_pointer = wrap_buffer; /* Start it at the beginning. */ } static void set_width_command (char *args, int from_tty, struct cmd_list_element *c) { set_screen_size (); set_width (); } static void set_height_command (char *args, int from_tty, struct cmd_list_element *c) { set_screen_size (); } /* Wait, so the user can read what's on the screen. Prompt the user to continue by pressing RETURN. */ static void prompt_for_continue (void) { char *ignore; char cont_prompt[120]; /* Used to add duration we waited for user to respond to prompt_for_continue_wait_time. */ struct timeval prompt_started, prompt_ended, prompt_delta; gettimeofday (&prompt_started, NULL); if (annotation_level > 1) printf_unfiltered (("\n\032\032pre-prompt-for-continue\n")); strcpy (cont_prompt, "---Type to continue, or q to quit---"); if (annotation_level > 1) strcat (cont_prompt, "\n\032\032prompt-for-continue\n"); /* We must do this *before* we call gdb_readline, else it will eventually call us -- thinking that we're trying to print beyond the end of the screen. */ reinitialize_more_filter (); immediate_quit++; QUIT; /* On a real operating system, the user can quit with SIGINT. But not on GO32. 'q' is provided on all systems so users don't have to change habits from system to system, and because telling them what to do in the prompt is more user-friendly than expecting them to think of SIGINT. */ /* Call readline, not gdb_readline, because GO32 readline handles control-C whereas control-C to gdb_readline will cause the user to get dumped out to DOS. */ ignore = gdb_readline_wrapper (cont_prompt); /* Add time spend in this routine to prompt_for_continue_wait_time. */ gettimeofday (&prompt_ended, NULL); timeval_sub (&prompt_delta, &prompt_ended, &prompt_started); timeval_add (&prompt_for_continue_wait_time, &prompt_for_continue_wait_time, &prompt_delta); if (annotation_level > 1) printf_unfiltered (("\n\032\032post-prompt-for-continue\n")); if (ignore) { char *p = ignore; while (*p == ' ' || *p == '\t') ++p; if (p[0] == 'q') quit (); xfree (ignore); } immediate_quit--; /* Now we have to do this again, so that GDB will know that it doesn't need to save the ---Type --- line at the top of the screen. */ reinitialize_more_filter (); dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */ } /* Initalize timer to keep track of how long we waited for the user. */ void reset_prompt_for_continue_wait_time (void) { static const struct timeval zero_timeval = { 0 }; prompt_for_continue_wait_time = zero_timeval; } /* Fetch the cumulative time spent in prompt_for_continue. */ struct timeval get_prompt_for_continue_wait_time (void) { return prompt_for_continue_wait_time; } /* Reinitialize filter; ie. tell it to reset to original values. */ void reinitialize_more_filter (void) { lines_printed = 0; chars_printed = 0; } /* Indicate that if the next sequence of characters overflows the line, a newline should be inserted here rather than when it hits the end. If INDENT is non-null, it is a string to be printed to indent the wrapped part on the next line. INDENT must remain accessible until the next call to wrap_here() or until a newline is printed through fputs_filtered(). If the line is already overfull, we immediately print a newline and the indentation, and disable further wrapping. If we don't know the width of lines, but we know the page height, we must not wrap words, but should still keep track of newlines that were explicitly printed. INDENT should not contain tabs, as that will mess up the char count on the next line. FIXME. This routine is guaranteed to force out any output which has been squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be used to force out output from the wrap_buffer. */ void wrap_here (char *indent) { /* This should have been allocated, but be paranoid anyway. */ if (!wrap_buffer) internal_error (__FILE__, __LINE__, _("failed internal consistency check")); if (wrap_buffer[0]) { *wrap_pointer = '\0'; fputs_unfiltered (wrap_buffer, gdb_stdout); } wrap_pointer = wrap_buffer; wrap_buffer[0] = '\0'; if (chars_per_line == UINT_MAX) /* No line overflow checking. */ { wrap_column = 0; } else if (chars_printed >= chars_per_line) { puts_filtered ("\n"); if (indent != NULL) puts_filtered (indent); wrap_column = 0; } else { wrap_column = chars_printed; if (indent == NULL) wrap_indent = ""; else wrap_indent = indent; } } /* Print input string to gdb_stdout, filtered, with wrap, arranging strings in columns of n chars. String can be right or left justified in the column. Never prints trailing spaces. String should never be longer than width. FIXME: this could be useful for the EXAMINE command, which currently doesn't tabulate very well. */ void puts_filtered_tabular (char *string, int width, int right) { int spaces = 0; int stringlen; char *spacebuf; gdb_assert (chars_per_line > 0); if (chars_per_line == UINT_MAX) { fputs_filtered (string, gdb_stdout); fputs_filtered ("\n", gdb_stdout); return; } if (((chars_printed - 1) / width + 2) * width >= chars_per_line) fputs_filtered ("\n", gdb_stdout); if (width >= chars_per_line) width = chars_per_line - 1; stringlen = strlen (string); if (chars_printed > 0) spaces = width - (chars_printed - 1) % width - 1; if (right) spaces += width - stringlen; spacebuf = alloca (spaces + 1); spacebuf[spaces] = '\0'; while (spaces--) spacebuf[spaces] = ' '; fputs_filtered (spacebuf, gdb_stdout); fputs_filtered (string, gdb_stdout); } /* Ensure that whatever gets printed next, using the filtered output commands, starts at the beginning of the line. I.e. if there is any pending output for the current line, flush it and start a new line. Otherwise do nothing. */ void begin_line (void) { if (chars_printed > 0) { puts_filtered ("\n"); } } /* Like fputs but if FILTER is true, pause after every screenful. Regardless of FILTER can wrap at points other than the final character of a line. Unlike fputs, fputs_maybe_filtered does not return a value. It is OK for LINEBUFFER to be NULL, in which case just don't print anything. Note that a longjmp to top level may occur in this routine (only if FILTER is true) (since prompt_for_continue may do so) so this routine should not be called when cleanups are not in place. */ static void fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream, int filter) { const char *lineptr; if (linebuffer == 0) return; /* Don't do any filtering if it is disabled. */ if (stream != gdb_stdout || !pagination_enabled || batch_flag || (lines_per_page == UINT_MAX && chars_per_line == UINT_MAX) || top_level_interpreter () == NULL || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ()))) { fputs_unfiltered (linebuffer, stream); return; } /* Go through and output each character. Show line extension when this is necessary; prompt user for new page when this is necessary. */ lineptr = linebuffer; while (*lineptr) { /* Possible new page. */ if (filter && (lines_printed >= lines_per_page - 1)) prompt_for_continue (); while (*lineptr && *lineptr != '\n') { /* Print a single line. */ if (*lineptr == '\t') { if (wrap_column) *wrap_pointer++ = '\t'; else fputc_unfiltered ('\t', stream); /* Shifting right by 3 produces the number of tab stops we have already passed, and then adding one and shifting left 3 advances to the next tab stop. */ chars_printed = ((chars_printed >> 3) + 1) << 3; lineptr++; } else { if (wrap_column) *wrap_pointer++ = *lineptr; else fputc_unfiltered (*lineptr, stream); chars_printed++; lineptr++; } if (chars_printed >= chars_per_line) { unsigned int save_chars = chars_printed; chars_printed = 0; lines_printed++; /* If we aren't actually wrapping, don't output newline -- if chars_per_line is right, we probably just overflowed anyway; if it's wrong, let us keep going. */ if (wrap_column) fputc_unfiltered ('\n', stream); /* Possible new page. */ if (lines_printed >= lines_per_page - 1) prompt_for_continue (); /* Now output indentation and wrapped string. */ if (wrap_column) { fputs_unfiltered (wrap_indent, stream); *wrap_pointer = '\0'; /* Null-terminate saved stuff, */ fputs_unfiltered (wrap_buffer, stream); /* and eject it. */ /* FIXME, this strlen is what prevents wrap_indent from containing tabs. However, if we recurse to print it and count its chars, we risk trouble if wrap_indent is longer than (the user settable) chars_per_line. Note also that this can set chars_printed > chars_per_line if we are printing a long string. */ chars_printed = strlen (wrap_indent) + (save_chars - wrap_column); wrap_pointer = wrap_buffer; /* Reset buffer */ wrap_buffer[0] = '\0'; wrap_column = 0; /* And disable fancy wrap */ } } } if (*lineptr == '\n') { chars_printed = 0; wrap_here ((char *) 0); /* Spit out chars, cancel further wraps. */ lines_printed++; fputc_unfiltered ('\n', stream); lineptr++; } } } void fputs_filtered (const char *linebuffer, struct ui_file *stream) { fputs_maybe_filtered (linebuffer, stream, 1); } int putchar_unfiltered (int c) { char buf = c; ui_file_write (gdb_stdout, &buf, 1); return c; } /* Write character C to gdb_stdout using GDB's paging mechanism and return C. May return nonlocally. */ int putchar_filtered (int c) { return fputc_filtered (c, gdb_stdout); } int fputc_unfiltered (int c, struct ui_file *stream) { char buf = c; ui_file_write (stream, &buf, 1); return c; } int fputc_filtered (int c, struct ui_file *stream) { char buf[2]; buf[0] = c; buf[1] = 0; fputs_filtered (buf, stream); return c; } /* puts_debug is like fputs_unfiltered, except it prints special characters in printable fashion. */ void puts_debug (char *prefix, char *string, char *suffix) { int ch; /* Print prefix and suffix after each line. */ static int new_line = 1; static int return_p = 0; static char *prev_prefix = ""; static char *prev_suffix = ""; if (*string == '\n') return_p = 0; /* If the prefix is changing, print the previous suffix, a new line, and the new prefix. */ if ((return_p || (strcmp (prev_prefix, prefix) != 0)) && !new_line) { fputs_unfiltered (prev_suffix, gdb_stdlog); fputs_unfiltered ("\n", gdb_stdlog); fputs_unfiltered (prefix, gdb_stdlog); } /* Print prefix if we printed a newline during the previous call. */ if (new_line) { new_line = 0; fputs_unfiltered (prefix, gdb_stdlog); } prev_prefix = prefix; prev_suffix = suffix; /* Output characters in a printable format. */ while ((ch = *string++) != '\0') { switch (ch) { default: if (isprint (ch)) fputc_unfiltered (ch, gdb_stdlog); else fprintf_unfiltered (gdb_stdlog, "\\x%02x", ch & 0xff); break; case '\\': fputs_unfiltered ("\\\\", gdb_stdlog); break; case '\b': fputs_unfiltered ("\\b", gdb_stdlog); break; case '\f': fputs_unfiltered ("\\f", gdb_stdlog); break; case '\n': new_line = 1; fputs_unfiltered ("\\n", gdb_stdlog); break; case '\r': fputs_unfiltered ("\\r", gdb_stdlog); break; case '\t': fputs_unfiltered ("\\t", gdb_stdlog); break; case '\v': fputs_unfiltered ("\\v", gdb_stdlog); break; } return_p = ch == '\r'; } /* Print suffix if we printed a newline. */ if (new_line) { fputs_unfiltered (suffix, gdb_stdlog); fputs_unfiltered ("\n", gdb_stdlog); } } /* Print a variable number of ARGS using format FORMAT. If this information is going to put the amount written (since the last call to REINITIALIZE_MORE_FILTER or the last page break) over the page size, call prompt_for_continue to get the users permision to continue. Unlike fprintf, this function does not return a value. We implement three variants, vfprintf (takes a vararg list and stream), fprintf (takes a stream to write on), and printf (the usual). Note also that a longjmp to top level may occur in this routine (since prompt_for_continue may do so) so this routine should not be called when cleanups are not in place. */ static void vfprintf_maybe_filtered (struct ui_file *stream, const char *format, va_list args, int filter) { char *linebuffer; struct cleanup *old_cleanups; linebuffer = xstrvprintf (format, args); old_cleanups = make_cleanup (xfree, linebuffer); fputs_maybe_filtered (linebuffer, stream, filter); do_cleanups (old_cleanups); } void vfprintf_filtered (struct ui_file *stream, const char *format, va_list args) { vfprintf_maybe_filtered (stream, format, args, 1); } void vfprintf_unfiltered (struct ui_file *stream, const char *format, va_list args) { char *linebuffer; struct cleanup *old_cleanups; linebuffer = xstrvprintf (format, args); old_cleanups = make_cleanup (xfree, linebuffer); if (debug_timestamp && stream == gdb_stdlog) { struct timeval tm; char *timestamp; int len, need_nl; gettimeofday (&tm, NULL); len = strlen (linebuffer); need_nl = (len > 0 && linebuffer[len - 1] != '\n'); timestamp = xstrprintf ("%ld:%ld %s%s", (long) tm.tv_sec, (long) tm.tv_usec, linebuffer, need_nl ? "\n": ""); make_cleanup (xfree, timestamp); fputs_unfiltered (timestamp, stream); } else fputs_unfiltered (linebuffer, stream); do_cleanups (old_cleanups); } void vprintf_filtered (const char *format, va_list args) { vfprintf_maybe_filtered (gdb_stdout, format, args, 1); } void vprintf_unfiltered (const char *format, va_list args) { vfprintf_unfiltered (gdb_stdout, format, args); } void fprintf_filtered (struct ui_file *stream, const char *format, ...) { va_list args; va_start (args, format); vfprintf_filtered (stream, format, args); va_end (args); } void fprintf_unfiltered (struct ui_file *stream, const char *format, ...) { va_list args; va_start (args, format); vfprintf_unfiltered (stream, format, args); va_end (args); } /* Like fprintf_filtered, but prints its result indented. Called as fprintfi_filtered (spaces, stream, format, ...); */ void fprintfi_filtered (int spaces, struct ui_file *stream, const char *format, ...) { va_list args; va_start (args, format); print_spaces_filtered (spaces, stream); vfprintf_filtered (stream, format, args); va_end (args); } void printf_filtered (const char *format, ...) { va_list args; va_start (args, format); vfprintf_filtered (gdb_stdout, format, args); va_end (args); } void printf_unfiltered (const char *format, ...) { va_list args; va_start (args, format); vfprintf_unfiltered (gdb_stdout, format, args); va_end (args); } /* Like printf_filtered, but prints it's result indented. Called as printfi_filtered (spaces, format, ...); */ void printfi_filtered (int spaces, const char *format, ...) { va_list args; va_start (args, format); print_spaces_filtered (spaces, gdb_stdout); vfprintf_filtered (gdb_stdout, format, args); va_end (args); } /* Easy -- but watch out! This routine is *not* a replacement for puts()! puts() appends a newline. This one doesn't, and had better not! */ void puts_filtered (const char *string) { fputs_filtered (string, gdb_stdout); } void puts_unfiltered (const char *string) { fputs_unfiltered (string, gdb_stdout); } /* Return a pointer to N spaces and a null. The pointer is good until the next call to here. */ char * n_spaces (int n) { char *t; static char *spaces = 0; static int max_spaces = -1; if (n > max_spaces) { if (spaces) xfree (spaces); spaces = (char *) xmalloc (n + 1); for (t = spaces + n; t != spaces;) *--t = ' '; spaces[n] = '\0'; max_spaces = n; } return spaces + max_spaces - n; } /* Print N spaces. */ void print_spaces_filtered (int n, struct ui_file *stream) { fputs_filtered (n_spaces (n), stream); } /* C++/ObjC demangler stuff. */ /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language LANG, using demangling args ARG_MODE, and print it filtered to STREAM. If the name is not mangled, or the language for the name is unknown, or demangling is off, the name is printed in its "raw" form. */ void fprintf_symbol_filtered (struct ui_file *stream, const char *name, enum language lang, int arg_mode) { char *demangled; if (name != NULL) { /* If user wants to see raw output, no problem. */ if (!demangle) { fputs_filtered (name, stream); } else { demangled = language_demangle (language_def (lang), name, arg_mode); fputs_filtered (demangled ? demangled : name, stream); if (demangled != NULL) { xfree (demangled); } } } } /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any differences in whitespace. Returns 0 if they match, non-zero if they don't (slightly different than strcmp()'s range of return values). As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO". This "feature" is useful when searching for matching C++ function names (such as if the user types 'break FOO', where FOO is a mangled C++ function). */ int strcmp_iw (const char *string1, const char *string2) { while ((*string1 != '\0') && (*string2 != '\0')) { while (isspace (*string1)) { string1++; } while (isspace (*string2)) { string2++; } if (case_sensitivity == case_sensitive_on && *string1 != *string2) break; if (case_sensitivity == case_sensitive_off && (tolower ((unsigned char) *string1) != tolower ((unsigned char) *string2))) break; if (*string1 != '\0') { string1++; string2++; } } return (*string1 != '\0' && *string1 != '(') || (*string2 != '\0'); } /* This is like strcmp except that it ignores whitespace and treats '(' as the first non-NULL character in terms of ordering. Like strcmp (and unlike strcmp_iw), it returns negative if STRING1 < STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2 according to that ordering. If a list is sorted according to this function and if you want to find names in the list that match some fixed NAME according to strcmp_iw(LIST_ELT, NAME), then the place to start looking is right where this function would put NAME. This function must be neutral to the CASE_SENSITIVITY setting as the user may choose it during later lookup. Therefore this function always sorts primarily case-insensitively and secondarily case-sensitively. Here are some examples of why using strcmp to sort is a bad idea: Whitespace example: Say your partial symtab contains: "foo", "goo". Then, if we try to do a search for "foo", strcmp will locate this after "foo" and before "goo". Then lookup_partial_symbol will start looking at strings beginning with "goo", and will never see the correct match of "foo". Parenthesis example: In practice, this is less like to be an issue, but I'll give it a shot. Let's assume that '$' is a legitimate character to occur in symbols. (Which may well even be the case on some systems.) Then say that the partial symbol table contains "foo$" and "foo(int)". strcmp will put them in this order, since '$' < '('. Now, if the user searches for "foo", then strcmp will sort "foo" before "foo$". Then lookup_partial_symbol will notice that strcmp_iw("foo$", "foo") is false, so it won't proceed to the actual match of "foo(int)" with "foo". */ int strcmp_iw_ordered (const char *string1, const char *string2) { const char *saved_string1 = string1, *saved_string2 = string2; enum case_sensitivity case_pass = case_sensitive_off; for (;;) { /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'. Provide stub characters if we are already at the end of one of the strings. */ char c1 = 'X', c2 = 'X'; while (*string1 != '\0' && *string2 != '\0') { while (isspace (*string1)) string1++; while (isspace (*string2)) string2++; switch (case_pass) { case case_sensitive_off: c1 = tolower ((unsigned char) *string1); c2 = tolower ((unsigned char) *string2); break; case case_sensitive_on: c1 = *string1; c2 = *string2; break; } if (c1 != c2) break; if (*string1 != '\0') { string1++; string2++; } } switch (*string1) { /* Characters are non-equal unless they're both '\0'; we want to make sure we get the comparison right according to our comparison in the cases where one of them is '\0' or '('. */ case '\0': if (*string2 == '\0') break; else return -1; case '(': if (*string2 == '\0') return 1; else return -1; default: if (*string2 == '\0' || *string2 == '(') return 1; else if (c1 > c2) return 1; else if (c1 < c2) return -1; /* PASSTHRU */ } if (case_pass == case_sensitive_on) return 0; /* Otherwise the strings were equal in case insensitive way, make a more fine grained comparison in a case sensitive way. */ case_pass = case_sensitive_on; string1 = saved_string1; string2 = saved_string2; } } /* A simple comparison function with opposite semantics to strcmp. */ int streq (const char *lhs, const char *rhs) { return !strcmp (lhs, rhs); } /* ** subset_compare() ** Answer whether string_to_compare is a full or partial match to ** template_string. The partial match must be in sequence starting ** at index 0. */ int subset_compare (char *string_to_compare, char *template_string) { int match; if (template_string != (char *) NULL && string_to_compare != (char *) NULL && strlen (string_to_compare) <= strlen (template_string)) match = (strncmp (template_string, string_to_compare, strlen (string_to_compare)) == 0); else match = 0; return match; } static void pagination_on_command (char *arg, int from_tty) { pagination_enabled = 1; } static void pagination_off_command (char *arg, int from_tty) { pagination_enabled = 0; } static void show_debug_timestamp (struct ui_file *file, int from_tty, struct cmd_list_element *c, const char *value) { fprintf_filtered (file, _("Timestamping debugging messages is %s.\n"), value); } void initialize_utils (void) { add_setshow_uinteger_cmd ("width", class_support, &chars_per_line, _("\ Set number of characters where GDB should wrap lines of its output."), _("\ Show number of characters where GDB should wrap lines of its output."), _("\ This affects where GDB wraps its output to fit the screen width.\n\ Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."), set_width_command, show_chars_per_line, &setlist, &showlist); add_setshow_uinteger_cmd ("height", class_support, &lines_per_page, _("\ Set number of lines in a page for GDB output pagination."), _("\ Show number of lines in a page for GDB output pagination."), _("\ This affects the number of lines after which GDB will pause\n\ its output and ask you whether to continue.\n\ Setting this to \"unlimited\" or zero causes GDB never pause during output."), set_height_command, show_lines_per_page, &setlist, &showlist); init_page_info (); add_setshow_boolean_cmd ("pagination", class_support, &pagination_enabled, _("\ Set state of GDB output pagination."), _("\ Show state of GDB output pagination."), _("\ When pagination is ON, GDB pauses at end of each screenful of\n\ its output and asks you whether to continue.\n\ Turning pagination off is an alternative to \"set height unlimited\"."), NULL, show_pagination_enabled, &setlist, &showlist); if (xdb_commands) { add_com ("am", class_support, pagination_on_command, _("Enable pagination")); add_com ("sm", class_support, pagination_off_command, _("Disable pagination")); } add_setshow_boolean_cmd ("sevenbit-strings", class_support, &sevenbit_strings, _("\ Set printing of 8-bit characters in strings as \\nnn."), _("\ Show printing of 8-bit characters in strings as \\nnn."), NULL, NULL, show_sevenbit_strings, &setprintlist, &showprintlist); add_setshow_boolean_cmd ("timestamp", class_maintenance, &debug_timestamp, _("\ Set timestamping of debugging messages."), _("\ Show timestamping of debugging messages."), _("\ When set, debugging messages will be marked with seconds and microseconds."), NULL, show_debug_timestamp, &setdebuglist, &showdebuglist); } /* Print routines to handle variable size regs, etc. */ /* Temporary storage using circular buffer. */ #define NUMCELLS 16 #define CELLSIZE 50 static char * get_cell (void) { static char buf[NUMCELLS][CELLSIZE]; static int cell = 0; if (++cell >= NUMCELLS) cell = 0; return buf[cell]; } const char * paddress (struct gdbarch *gdbarch, CORE_ADDR addr) { /* Truncate address to the size of a target address, avoiding shifts larger or equal than the width of a CORE_ADDR. The local variable ADDR_BIT stops the compiler reporting a shift overflow when it won't occur. */ /* NOTE: This assumes that the significant address information is kept in the least significant bits of ADDR - the upper bits were either zero or sign extended. Should gdbarch_address_to_pointer or some ADDRESS_TO_PRINTABLE() be used to do the conversion? */ int addr_bit = gdbarch_addr_bit (gdbarch); if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT)) addr &= ((CORE_ADDR) 1 << addr_bit) - 1; return hex_string (addr); } /* This function is described in "defs.h". */ const char * print_core_address (struct gdbarch *gdbarch, CORE_ADDR address) { int addr_bit = gdbarch_addr_bit (gdbarch); if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT)) address &= ((CORE_ADDR) 1 << addr_bit) - 1; /* FIXME: cagney/2002-05-03: Need local_address_string() function that returns the language localized string formatted to a width based on gdbarch_addr_bit. */ if (addr_bit <= 32) return hex_string_custom (address, 8); else return hex_string_custom (address, 16); } /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */ hashval_t core_addr_hash (const void *ap) { const CORE_ADDR *addrp = ap; return *addrp; } /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */ int core_addr_eq (const void *ap, const void *bp) { const CORE_ADDR *addr_ap = ap; const CORE_ADDR *addr_bp = bp; return *addr_ap == *addr_bp; } static char * decimal2str (char *sign, ULONGEST addr, int width) { /* Steal code from valprint.c:print_decimal(). Should this worry about the real size of addr as the above does? */ unsigned long temp[3]; char *str = get_cell (); int i = 0; do { temp[i] = addr % (1000 * 1000 * 1000); addr /= (1000 * 1000 * 1000); i++; width -= 9; } while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0]))); width += 9; if (width < 0) width = 0; switch (i) { case 1: xsnprintf (str, CELLSIZE, "%s%0*lu", sign, width, temp[0]); break; case 2: xsnprintf (str, CELLSIZE, "%s%0*lu%09lu", sign, width, temp[1], temp[0]); break; case 3: xsnprintf (str, CELLSIZE, "%s%0*lu%09lu%09lu", sign, width, temp[2], temp[1], temp[0]); break; default: internal_error (__FILE__, __LINE__, _("failed internal consistency check")); } return str; } static char * octal2str (ULONGEST addr, int width) { unsigned long temp[3]; char *str = get_cell (); int i = 0; do { temp[i] = addr % (0100000 * 0100000); addr /= (0100000 * 0100000); i++; width -= 10; } while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0]))); width += 10; if (width < 0) width = 0; switch (i) { case 1: if (temp[0] == 0) xsnprintf (str, CELLSIZE, "%*o", width, 0); else xsnprintf (str, CELLSIZE, "0%0*lo", width, temp[0]); break; case 2: xsnprintf (str, CELLSIZE, "0%0*lo%010lo", width, temp[1], temp[0]); break; case 3: xsnprintf (str, CELLSIZE, "0%0*lo%010lo%010lo", width, temp[2], temp[1], temp[0]); break; default: internal_error (__FILE__, __LINE__, _("failed internal consistency check")); } return str; } char * pulongest (ULONGEST u) { return decimal2str ("", u, 0); } char * plongest (LONGEST l) { if (l < 0) return decimal2str ("-", -l, 0); else return decimal2str ("", l, 0); } /* Eliminate warning from compiler on 32-bit systems. */ static int thirty_two = 32; char * phex (ULONGEST l, int sizeof_l) { char *str; switch (sizeof_l) { case 8: str = get_cell (); xsnprintf (str, CELLSIZE, "%08lx%08lx", (unsigned long) (l >> thirty_two), (unsigned long) (l & 0xffffffff)); break; case 4: str = get_cell (); xsnprintf (str, CELLSIZE, "%08lx", (unsigned long) l); break; case 2: str = get_cell (); xsnprintf (str, CELLSIZE, "%04x", (unsigned short) (l & 0xffff)); break; default: str = phex (l, sizeof (l)); break; } return str; } char * phex_nz (ULONGEST l, int sizeof_l) { char *str; switch (sizeof_l) { case 8: { unsigned long high = (unsigned long) (l >> thirty_two); str = get_cell (); if (high == 0) xsnprintf (str, CELLSIZE, "%lx", (unsigned long) (l & 0xffffffff)); else xsnprintf (str, CELLSIZE, "%lx%08lx", high, (unsigned long) (l & 0xffffffff)); break; } case 4: str = get_cell (); xsnprintf (str, CELLSIZE, "%lx", (unsigned long) l); break; case 2: str = get_cell (); xsnprintf (str, CELLSIZE, "%x", (unsigned short) (l & 0xffff)); break; default: str = phex_nz (l, sizeof (l)); break; } return str; } /* Converts a LONGEST to a C-format hexadecimal literal and stores it in a static string. Returns a pointer to this string. */ char * hex_string (LONGEST num) { char *result = get_cell (); xsnprintf (result, CELLSIZE, "0x%s", phex_nz (num, sizeof (num))); return result; } /* Converts a LONGEST number to a C-format hexadecimal literal and stores it in a static string. Returns a pointer to this string that is valid until the next call. The number is padded on the left with 0s to at least WIDTH characters. */ char * hex_string_custom (LONGEST num, int width) { char *result = get_cell (); char *result_end = result + CELLSIZE - 1; const char *hex = phex_nz (num, sizeof (num)); int hex_len = strlen (hex); if (hex_len > width) width = hex_len; if (width + 2 >= CELLSIZE) internal_error (__FILE__, __LINE__, _("\ hex_string_custom: insufficient space to store result")); strcpy (result_end - width - 2, "0x"); memset (result_end - width, '0', width); strcpy (result_end - hex_len, hex); return result_end - width - 2; } /* Convert VAL to a numeral in the given radix. For * radix 10, IS_SIGNED may be true, indicating a signed quantity; * otherwise VAL is interpreted as unsigned. If WIDTH is supplied, * it is the minimum width (0-padded if needed). USE_C_FORMAT means * to use C format in all cases. If it is false, then 'x' * and 'o' formats do not include a prefix (0x or leading 0). */ char * int_string (LONGEST val, int radix, int is_signed, int width, int use_c_format) { switch (radix) { case 16: { char *result; if (width == 0) result = hex_string (val); else result = hex_string_custom (val, width); if (! use_c_format) result += 2; return result; } case 10: { if (is_signed && val < 0) return decimal2str ("-", -val, width); else return decimal2str ("", val, width); } case 8: { char *result = octal2str (val, width); if (use_c_format || val == 0) return result; else return result + 1; } default: internal_error (__FILE__, __LINE__, _("failed internal consistency check")); } } /* Convert a CORE_ADDR into a string. */ const char * core_addr_to_string (const CORE_ADDR addr) { char *str = get_cell (); strcpy (str, "0x"); strcat (str, phex (addr, sizeof (addr))); return str; } const char * core_addr_to_string_nz (const CORE_ADDR addr) { char *str = get_cell (); strcpy (str, "0x"); strcat (str, phex_nz (addr, sizeof (addr))); return str; } /* Convert a string back into a CORE_ADDR. */ CORE_ADDR string_to_core_addr (const char *my_string) { CORE_ADDR addr = 0; if (my_string[0] == '0' && tolower (my_string[1]) == 'x') { /* Assume that it is in hex. */ int i; for (i = 2; my_string[i] != '\0'; i++) { if (isdigit (my_string[i])) addr = (my_string[i] - '0') + (addr * 16); else if (isxdigit (my_string[i])) addr = (tolower (my_string[i]) - 'a' + 0xa) + (addr * 16); else error (_("invalid hex \"%s\""), my_string); } } else { /* Assume that it is in decimal. */ int i; for (i = 0; my_string[i] != '\0'; i++) { if (isdigit (my_string[i])) addr = (my_string[i] - '0') + (addr * 10); else error (_("invalid decimal \"%s\""), my_string); } } return addr; } const char * host_address_to_string (const void *addr) { char *str = get_cell (); xsnprintf (str, CELLSIZE, "0x%s", phex_nz ((uintptr_t) addr, sizeof (addr))); return str; } char * gdb_realpath (const char *filename) { /* Method 1: The system has a compile time upper bound on a filename path. Use that and realpath() to canonicalize the name. This is the most common case. Note that, if there isn't a compile time upper bound, you want to avoid realpath() at all costs. */ #if defined (HAVE_REALPATH) && defined (PATH_MAX) { char buf[PATH_MAX]; const char *rp = realpath (filename, buf); if (rp == NULL) rp = filename; return xstrdup (rp); } #endif /* HAVE_REALPATH */ /* Method 2: The host system (i.e., GNU) has the function canonicalize_file_name() which malloc's a chunk of memory and returns that, use that. */ #if defined(HAVE_CANONICALIZE_FILE_NAME) { char *rp = canonicalize_file_name (filename); if (rp == NULL) return xstrdup (filename); else return rp; } #endif /* FIXME: cagney/2002-11-13: Method 2a: Use realpath() with a NULL buffer. Some systems, due to the problems described in method 3, have modified their realpath() implementation so that it will allocate a buffer when NULL is passed in. Before this can be used, though, some sort of configure time test would need to be added. Otherwize the code will likely core dump. */ /* Method 3: Now we're getting desperate! The system doesn't have a compile time buffer size and no alternative function. Query the OS, using pathconf(), for the buffer limit. Care is needed though, some systems do not limit PATH_MAX (return -1 for pathconf()) making it impossible to pass a correctly sized buffer to realpath() (it could always overflow). On those systems, we skip this. */ #if defined (HAVE_REALPATH) && defined (_PC_PATH_MAX) && defined(HAVE_ALLOCA) { /* Find out the max path size. */ long path_max = pathconf ("/", _PC_PATH_MAX); if (path_max > 0) { /* PATH_MAX is bounded. */ char *buf = alloca (path_max); char *rp = realpath (filename, buf); return xstrdup (rp ? rp : filename); } } #endif /* The MS Windows method. If we don't have realpath, we assume we don't have symlinks and just canonicalize to a Windows absolute path. GetFullPath converts ../ and ./ in relative paths to absolute paths, filling in current drive if one is not given or using the current directory of a specified drive (eg, "E:foo"). It also converts all forward slashes to back slashes. */ /* The file system is case-insensitive but case-preserving. So we do not lowercase the path. Otherwise, we might not be able to display the original casing in a given path. */ #if defined (_WIN32) { char buf[MAX_PATH]; DWORD len = GetFullPathName (filename, MAX_PATH, buf, NULL); if (len > 0 && len < MAX_PATH) return xstrdup (buf); } #endif /* This system is a lost cause, just dup the buffer. */ return xstrdup (filename); } /* Return a copy of FILENAME, with its directory prefix canonicalized by gdb_realpath. */ char * gdb_realpath_keepfile (const char *filename) { const char *base_name = lbasename (filename); char *dir_name; char *real_path; char *result; /* Extract the basename of filename, and return immediately a copy of filename if it does not contain any directory prefix. */ if (base_name == filename) return xstrdup (filename); dir_name = alloca ((size_t) (base_name - filename + 2)); /* Allocate enough space to store the dir_name + plus one extra character sometimes needed under Windows (see below), and then the closing \000 character. */ strncpy (dir_name, filename, base_name - filename); dir_name[base_name - filename] = '\000'; #ifdef HAVE_DOS_BASED_FILE_SYSTEM /* We need to be careful when filename is of the form 'd:foo', which is equivalent of d:./foo, which is totally different from d:/foo. */ if (strlen (dir_name) == 2 && isalpha (dir_name[0]) && dir_name[1] == ':') { dir_name[2] = '.'; dir_name[3] = '\000'; } #endif /* Canonicalize the directory prefix, and build the resulting filename. If the dirname realpath already contains an ending directory separator, avoid doubling it. */ real_path = gdb_realpath (dir_name); if (IS_DIR_SEPARATOR (real_path[strlen (real_path) - 1])) result = concat (real_path, base_name, (char *) NULL); else result = concat (real_path, SLASH_STRING, base_name, (char *) NULL); xfree (real_path); return result; } /* Return PATH in absolute form, performing tilde-expansion if necessary. PATH cannot be NULL or the empty string. This does not resolve symlinks however, use gdb_realpath for that. Space for the result is allocated with malloc. If the path is already absolute, it is strdup'd. If there is a problem computing the absolute path, the path is returned unchanged (still strdup'd). */ char * gdb_abspath (const char *path) { gdb_assert (path != NULL && path[0] != '\0'); if (path[0] == '~') return tilde_expand (path); if (IS_ABSOLUTE_PATH (path)) return xstrdup (path); /* Beware the // my son, the Emacs barfs, the botch that catch... */ return concat (current_directory, IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1]) ? "" : SLASH_STRING, path, (char *) NULL); } ULONGEST align_up (ULONGEST v, int n) { /* Check that N is really a power of two. */ gdb_assert (n && (n & (n-1)) == 0); return (v + n - 1) & -n; } ULONGEST align_down (ULONGEST v, int n) { /* Check that N is really a power of two. */ gdb_assert (n && (n & (n-1)) == 0); return (v & -n); } /* See utils.h. */ LONGEST gdb_sign_extend (LONGEST value, int bit) { gdb_assert (bit >= 1 && bit <= 8 * sizeof (LONGEST)); if (((value >> (bit - 1)) & 1) != 0) { LONGEST signbit = ((LONGEST) 1) << (bit - 1); value = (value ^ signbit) - signbit; } return value; } /* Allocation function for the libiberty hash table which uses an obstack. The obstack is passed as DATA. */ void * hashtab_obstack_allocate (void *data, size_t size, size_t count) { unsigned int total = size * count; void *ptr = obstack_alloc ((struct obstack *) data, total); memset (ptr, 0, total); return ptr; } /* Trivial deallocation function for the libiberty splay tree and hash table - don't deallocate anything. Rely on later deletion of the obstack. DATA will be the obstack, although it is not needed here. */ void dummy_obstack_deallocate (void *object, void *data) { return; } /* The bit offset of the highest byte in a ULONGEST, for overflow checking. */ #define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT) /* True (non-zero) iff DIGIT is a valid digit in radix BASE, where 2 <= BASE <= 36. */ static int is_digit_in_base (unsigned char digit, int base) { if (!isalnum (digit)) return 0; if (base <= 10) return (isdigit (digit) && digit < base + '0'); else return (isdigit (digit) || tolower (digit) < base - 10 + 'a'); } static int digit_to_int (unsigned char c) { if (isdigit (c)) return c - '0'; else return tolower (c) - 'a' + 10; } /* As for strtoul, but for ULONGEST results. */ ULONGEST strtoulst (const char *num, const char **trailer, int base) { unsigned int high_part; ULONGEST result; int minus = 0; int i = 0; /* Skip leading whitespace. */ while (isspace (num[i])) i++; /* Handle prefixes. */ if (num[i] == '+') i++; else if (num[i] == '-') { minus = 1; i++; } if (base == 0 || base == 16) { if (num[i] == '0' && (num[i + 1] == 'x' || num[i + 1] == 'X')) { i += 2; if (base == 0) base = 16; } } if (base == 0 && num[i] == '0') base = 8; if (base == 0) base = 10; if (base < 2 || base > 36) { errno = EINVAL; return 0; } result = high_part = 0; for (; is_digit_in_base (num[i], base); i += 1) { result = result * base + digit_to_int (num[i]); high_part = high_part * base + (unsigned int) (result >> HIGH_BYTE_POSN); result &= ((ULONGEST) 1 << HIGH_BYTE_POSN) - 1; if (high_part > 0xff) { errno = ERANGE; result = ~ (ULONGEST) 0; high_part = 0; minus = 0; break; } } if (trailer != NULL) *trailer = &num[i]; result = result + ((ULONGEST) high_part << HIGH_BYTE_POSN); if (minus) return -result; else return result; } /* Simple, portable version of dirname that does not modify its argument. */ char * ldirname (const char *filename) { const char *base = lbasename (filename); char *dirname; while (base > filename && IS_DIR_SEPARATOR (base[-1])) --base; if (base == filename) return NULL; dirname = xmalloc (base - filename + 2); memcpy (dirname, filename, base - filename); /* On DOS based file systems, convert "d:foo" to "d:.", so that we create "d:./bar" later instead of the (different) "d:/bar". */ if (base - filename == 2 && IS_ABSOLUTE_PATH (base) && !IS_DIR_SEPARATOR (filename[0])) dirname[base++ - filename] = '.'; dirname[base - filename] = '\0'; return dirname; } /* Call libiberty's buildargv, and return the result. If buildargv fails due to out-of-memory, call nomem. Therefore, the returned value is guaranteed to be non-NULL, unless the parameter itself is NULL. */ char ** gdb_buildargv (const char *s) { char **argv = buildargv (s); if (s != NULL && argv == NULL) malloc_failure (0); return argv; } int compare_positive_ints (const void *ap, const void *bp) { /* Because we know we're comparing two ints which are positive, there's no danger of overflow here. */ return * (int *) ap - * (int *) bp; } /* String compare function for qsort. */ int compare_strings (const void *arg1, const void *arg2) { const char **s1 = (const char **) arg1; const char **s2 = (const char **) arg2; return strcmp (*s1, *s2); } #define AMBIGUOUS_MESS1 ".\nMatching formats:" #define AMBIGUOUS_MESS2 \ ".\nUse \"set gnutarget format-name\" to specify the format." const char * gdb_bfd_errmsg (bfd_error_type error_tag, char **matching) { char *ret, *retp; int ret_len; char **p; /* Check if errmsg just need simple return. */ if (error_tag != bfd_error_file_ambiguously_recognized || matching == NULL) return bfd_errmsg (error_tag); ret_len = strlen (bfd_errmsg (error_tag)) + strlen (AMBIGUOUS_MESS1) + strlen (AMBIGUOUS_MESS2); for (p = matching; *p; p++) ret_len += strlen (*p) + 1; ret = xmalloc (ret_len + 1); retp = ret; make_cleanup (xfree, ret); strcpy (retp, bfd_errmsg (error_tag)); retp += strlen (retp); strcpy (retp, AMBIGUOUS_MESS1); retp += strlen (retp); for (p = matching; *p; p++) { sprintf (retp, " %s", *p); retp += strlen (retp); } xfree (matching); strcpy (retp, AMBIGUOUS_MESS2); return ret; } /* Return ARGS parsed as a valid pid, or throw an error. */ int parse_pid_to_attach (char *args) { unsigned long pid; char *dummy; if (!args) error_no_arg (_("process-id to attach")); dummy = args; pid = strtoul (args, &dummy, 0); /* Some targets don't set errno on errors, grrr! */ if ((pid == 0 && dummy == args) || dummy != &args[strlen (args)]) error (_("Illegal process-id: %s."), args); return pid; } /* Helper for make_bpstat_clear_actions_cleanup. */ static void do_bpstat_clear_actions_cleanup (void *unused) { bpstat_clear_actions (); } /* Call bpstat_clear_actions for the case an exception is throw. You should discard_cleanups if no exception is caught. */ struct cleanup * make_bpstat_clear_actions_cleanup (void) { return make_cleanup (do_bpstat_clear_actions_cleanup, NULL); } /* Check for GCC >= 4.x according to the symtab->producer string. Return minor version (x) of 4.x in such case. If it is not GCC or it is GCC older than 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */ int producer_is_gcc_ge_4 (const char *producer) { const char *cs; int major, minor; if (producer == NULL) { /* For unknown compilers expect their behavior is not compliant. For GCC this case can also happen for -gdwarf-4 type units supported since gcc-4.5. */ return -1; } /* Skip any identifier after "GNU " - such as "C++" or "Java". */ if (strncmp (producer, "GNU ", strlen ("GNU ")) != 0) { /* For non-GCC compilers expect their behavior is not compliant. */ return -1; } cs = &producer[strlen ("GNU ")]; while (*cs && !isdigit (*cs)) cs++; if (sscanf (cs, "%d.%d", &major, &minor) != 2) { /* Not recognized as GCC. */ return -1; } if (major < 4) return -1; if (major > 4) return INT_MAX; return minor; } /* Helper for make_cleanup_free_char_ptr_vec. */ static void do_free_char_ptr_vec (void *arg) { VEC (char_ptr) *char_ptr_vec = arg; free_char_ptr_vec (char_ptr_vec); } /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and final VEC_free for CHAR_PTR_VEC itself. You must not modify CHAR_PTR_VEC after this cleanup registration as the CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free this function does not (cannot) clear the pointer. */ struct cleanup * make_cleanup_free_char_ptr_vec (VEC (char_ptr) *char_ptr_vec) { return make_cleanup (do_free_char_ptr_vec, char_ptr_vec); } /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP must come from xrealloc-compatible allocator and it may be updated. FROM needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be located at the start or end of *STRINGP. */ void substitute_path_component (char **stringp, const char *from, const char *to) { char *string = *stringp, *s; const size_t from_len = strlen (from); const size_t to_len = strlen (to); for (s = string;;) { s = strstr (s, from); if (s == NULL) break; if ((s == string || IS_DIR_SEPARATOR (s[-1]) || s[-1] == DIRNAME_SEPARATOR) && (s[from_len] == '\0' || IS_DIR_SEPARATOR (s[from_len]) || s[from_len] == DIRNAME_SEPARATOR)) { char *string_new; string_new = xrealloc (string, (strlen (string) + to_len + 1)); /* Relocate the current S pointer. */ s = s - string + string_new; string = string_new; /* Replace from by to. */ memmove (&s[to_len], &s[from_len], strlen (&s[from_len]) + 1); memcpy (s, to, to_len); s += to_len; } else s++; } *stringp = string; } #ifdef HAVE_WAITPID #ifdef SIGALRM /* SIGALRM handler for waitpid_with_timeout. */ static void sigalrm_handler (int signo) { /* Nothing to do. */ } #endif /* Wrapper to wait for child PID to die with TIMEOUT. TIMEOUT is the time to stop waiting in seconds. If TIMEOUT is zero, pass WNOHANG to waitpid. Returns PID if it was successfully waited for, otherwise -1. Timeouts are currently implemented with alarm and SIGALRM. If the host does not support them, this waits "forever". It would be odd though for a host to have waitpid and not SIGALRM. */ pid_t wait_to_die_with_timeout (pid_t pid, int *status, int timeout) { pid_t waitpid_result; gdb_assert (pid > 0); gdb_assert (timeout >= 0); if (timeout > 0) { #ifdef SIGALRM #if defined (HAVE_SIGACTION) && defined (SA_RESTART) struct sigaction sa, old_sa; sa.sa_handler = sigalrm_handler; sigemptyset (&sa.sa_mask); sa.sa_flags = 0; sigaction (SIGALRM, &sa, &old_sa); #else void (*ofunc) (); ofunc = (void (*)()) signal (SIGALRM, sigalrm_handler); #endif alarm (timeout); #endif waitpid_result = waitpid (pid, status, 0); #ifdef SIGALRM alarm (0); #if defined (HAVE_SIGACTION) && defined (SA_RESTART) sigaction (SIGALRM, &old_sa, NULL); #else signal (SIGALRM, ofunc); #endif #endif } else waitpid_result = waitpid (pid, status, WNOHANG); if (waitpid_result == pid) return pid; else return -1; } #endif /* HAVE_WAITPID */ /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files. Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS. It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */ int gdb_filename_fnmatch (const char *pattern, const char *string, int flags) { gdb_assert ((flags & FNM_FILE_NAME) != 0); /* It is unclear how '\' escaping vs. directory separator should coexist. */ gdb_assert ((flags & FNM_NOESCAPE) != 0); #ifdef HAVE_DOS_BASED_FILE_SYSTEM { char *pattern_slash, *string_slash; /* Replace '\' by '/' in both strings. */ pattern_slash = alloca (strlen (pattern) + 1); strcpy (pattern_slash, pattern); pattern = pattern_slash; for (; *pattern_slash != 0; pattern_slash++) if (IS_DIR_SEPARATOR (*pattern_slash)) *pattern_slash = '/'; string_slash = alloca (strlen (string) + 1); strcpy (string_slash, string); string = string_slash; for (; *string_slash != 0; string_slash++) if (IS_DIR_SEPARATOR (*string_slash)) *string_slash = '/'; } #endif /* HAVE_DOS_BASED_FILE_SYSTEM */ #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM flags |= FNM_CASEFOLD; #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */ return fnmatch (pattern, string, flags); } /* Provide a prototype to silence -Wmissing-prototypes. */ extern initialize_file_ftype _initialize_utils; void _initialize_utils (void) { add_internal_problem_command (&internal_error_problem); add_internal_problem_command (&internal_warning_problem); }