1 /* General utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2014 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 #include "dyn-string.h"
25 #include "event-top.h"
26 #include "exceptions.h"
27 #include "gdbthread.h"
30 #ifdef HAVE_SYS_RESOURCE_H
31 #include <sys/resource.h>
32 #endif /* HAVE_SYS_RESOURCE_H */
35 #include "tui/tui.h" /* For tui_get_command_dimension. */
43 #include "timeval-utils.h"
48 #include "gdb-demangle.h"
49 #include "expression.h"
53 #include "filenames.h"
55 #include "gdb_obstack.h"
61 #include "inferior.h" /* for signed_pointer_to_address */
63 #include "gdb_curses.h"
65 #include "readline/readline.h"
70 #include "gdb_usleep.h"
72 #include "gdb_regex.h"
75 extern PTR malloc (); /* ARI: PTR */
77 #if !HAVE_DECL_REALLOC
78 extern PTR realloc (); /* ARI: PTR */
84 void (*deprecated_error_begin_hook) (void);
86 /* Prototypes for local functions */
88 static void vfprintf_maybe_filtered (struct ui_file *, const char *,
89 va_list, int) ATTRIBUTE_PRINTF (2, 0);
91 static void fputs_maybe_filtered (const char *, struct ui_file *, int);
93 static void prompt_for_continue (void);
95 static void set_screen_size (void);
96 static void set_width (void);
98 /* Time spent in prompt_for_continue in the currently executing command
99 waiting for user to respond.
100 Initialized in make_command_stats_cleanup.
101 Modified in prompt_for_continue and defaulted_query.
102 Used in report_command_stats. */
104 static struct timeval prompt_for_continue_wait_time;
106 /* A flag indicating whether to timestamp debugging messages. */
108 static int debug_timestamp = 0;
110 /* Nonzero if we have job control. */
114 /* Nonzero means quit immediately if Control-C is typed now, rather
115 than waiting until QUIT is executed. Be careful in setting this;
116 code which executes with immediate_quit set has to be very careful
117 about being able to deal with being interrupted at any time. It is
118 almost always better to use QUIT; the only exception I can think of
119 is being able to quit out of a system call (using EINTR loses if
120 the SIGINT happens between the previous QUIT and the system call).
121 To immediately quit in the case in which a SIGINT happens between
122 the previous QUIT and setting immediate_quit (desirable anytime we
123 expect to block), call QUIT after setting immediate_quit. */
127 /* Nonzero means that strings with character values >0x7F should be printed
128 as octal escapes. Zero means just print the value (e.g. it's an
129 international character, and the terminal or window can cope.) */
131 int sevenbit_strings = 0;
133 show_sevenbit_strings (struct ui_file *file, int from_tty,
134 struct cmd_list_element *c, const char *value)
136 fprintf_filtered (file, _("Printing of 8-bit characters "
137 "in strings as \\nnn is %s.\n"),
141 /* String to be printed before warning messages, if any. */
143 char *warning_pre_print = "\nwarning: ";
145 int pagination_enabled = 1;
147 show_pagination_enabled (struct ui_file *file, int from_tty,
148 struct cmd_list_element *c, const char *value)
150 fprintf_filtered (file, _("State of pagination is %s.\n"), value);
154 /* Cleanup utilities.
156 These are not defined in cleanups.c (nor declared in cleanups.h)
157 because while they use the "cleanup API" they are not part of the
161 do_freeargv (void *arg)
163 freeargv ((char **) arg);
167 make_cleanup_freeargv (char **arg)
169 return make_cleanup (do_freeargv, arg);
173 do_dyn_string_delete (void *arg)
175 dyn_string_delete ((dyn_string_t) arg);
179 make_cleanup_dyn_string_delete (dyn_string_t arg)
181 return make_cleanup (do_dyn_string_delete, arg);
185 do_bfd_close_cleanup (void *arg)
191 make_cleanup_bfd_unref (bfd *abfd)
193 return make_cleanup (do_bfd_close_cleanup, abfd);
197 do_close_cleanup (void *arg)
205 make_cleanup_close (int fd)
207 int *saved_fd = xmalloc (sizeof (fd));
210 return make_cleanup_dtor (do_close_cleanup, saved_fd, xfree);
213 /* Helper function which does the work for make_cleanup_fclose. */
216 do_fclose_cleanup (void *arg)
223 /* Return a new cleanup that closes FILE. */
226 make_cleanup_fclose (FILE *file)
228 return make_cleanup (do_fclose_cleanup, file);
231 /* Helper function which does the work for make_cleanup_obstack_free. */
234 do_obstack_free (void *arg)
236 struct obstack *ob = arg;
238 obstack_free (ob, NULL);
241 /* Return a new cleanup that frees OBSTACK. */
244 make_cleanup_obstack_free (struct obstack *obstack)
246 return make_cleanup (do_obstack_free, obstack);
250 do_ui_file_delete (void *arg)
252 ui_file_delete (arg);
256 make_cleanup_ui_file_delete (struct ui_file *arg)
258 return make_cleanup (do_ui_file_delete, arg);
261 /* Helper function for make_cleanup_ui_out_redirect_pop. */
264 do_ui_out_redirect_pop (void *arg)
266 struct ui_out *uiout = arg;
268 if (ui_out_redirect (uiout, NULL) < 0)
269 warning (_("Cannot restore redirection of the current output protocol"));
272 /* Return a new cleanup that pops the last redirection by ui_out_redirect
273 with NULL parameter. */
276 make_cleanup_ui_out_redirect_pop (struct ui_out *uiout)
278 return make_cleanup (do_ui_out_redirect_pop, uiout);
282 do_free_section_addr_info (void *arg)
284 free_section_addr_info (arg);
288 make_cleanup_free_section_addr_info (struct section_addr_info *addrs)
290 return make_cleanup (do_free_section_addr_info, addrs);
293 struct restore_integer_closure
300 restore_integer (void *p)
302 struct restore_integer_closure *closure = p;
304 *(closure->variable) = closure->value;
307 /* Remember the current value of *VARIABLE and make it restored when
308 the cleanup is run. */
311 make_cleanup_restore_integer (int *variable)
313 struct restore_integer_closure *c =
314 xmalloc (sizeof (struct restore_integer_closure));
316 c->variable = variable;
317 c->value = *variable;
319 return make_cleanup_dtor (restore_integer, (void *) c, xfree);
322 /* Remember the current value of *VARIABLE and make it restored when
323 the cleanup is run. */
326 make_cleanup_restore_uinteger (unsigned int *variable)
328 return make_cleanup_restore_integer ((int *) variable);
331 /* Helper for make_cleanup_unpush_target. */
334 do_unpush_target (void *arg)
336 struct target_ops *ops = arg;
341 /* Return a new cleanup that unpushes OPS. */
344 make_cleanup_unpush_target (struct target_ops *ops)
346 return make_cleanup (do_unpush_target, ops);
349 /* Helper for make_cleanup_htab_delete compile time checking the types. */
352 do_htab_delete_cleanup (void *htab_voidp)
354 htab_t htab = htab_voidp;
359 /* Return a new cleanup that deletes HTAB. */
362 make_cleanup_htab_delete (htab_t htab)
364 return make_cleanup (do_htab_delete_cleanup, htab);
367 struct restore_ui_file_closure
369 struct ui_file **variable;
370 struct ui_file *value;
374 do_restore_ui_file (void *p)
376 struct restore_ui_file_closure *closure = p;
378 *(closure->variable) = closure->value;
381 /* Remember the current value of *VARIABLE and make it restored when
382 the cleanup is run. */
385 make_cleanup_restore_ui_file (struct ui_file **variable)
387 struct restore_ui_file_closure *c = XNEW (struct restore_ui_file_closure);
389 c->variable = variable;
390 c->value = *variable;
392 return make_cleanup_dtor (do_restore_ui_file, (void *) c, xfree);
395 /* Helper for make_cleanup_value_free_to_mark. */
398 do_value_free_to_mark (void *value)
400 value_free_to_mark ((struct value *) value);
403 /* Free all values allocated since MARK was obtained by value_mark
404 (except for those released) when the cleanup is run. */
407 make_cleanup_value_free_to_mark (struct value *mark)
409 return make_cleanup (do_value_free_to_mark, mark);
412 /* Helper for make_cleanup_value_free. */
415 do_value_free (void *value)
423 make_cleanup_value_free (struct value *value)
425 return make_cleanup (do_value_free, value);
428 /* Helper for make_cleanup_free_so. */
431 do_free_so (void *arg)
433 struct so_list *so = arg;
438 /* Make cleanup handler calling free_so for SO. */
441 make_cleanup_free_so (struct so_list *so)
443 return make_cleanup (do_free_so, so);
446 /* Helper for make_cleanup_restore_current_language. */
449 do_restore_current_language (void *p)
451 enum language saved_lang = (uintptr_t) p;
453 set_language (saved_lang);
456 /* Remember the current value of CURRENT_LANGUAGE and make it restored when
457 the cleanup is run. */
460 make_cleanup_restore_current_language (void)
462 enum language saved_lang = current_language->la_language;
464 return make_cleanup (do_restore_current_language,
465 (void *) (uintptr_t) saved_lang);
468 /* Helper function for make_cleanup_clear_parser_state. */
471 do_clear_parser_state (void *ptr)
473 struct parser_state **p = (struct parser_state **) ptr;
478 /* Clean (i.e., set to NULL) the parser state variable P. */
481 make_cleanup_clear_parser_state (struct parser_state **p)
483 return make_cleanup (do_clear_parser_state, (void *) p);
486 /* This function is useful for cleanups.
490 old_chain = make_cleanup (free_current_contents, &foo);
492 to arrange to free the object thus allocated. */
495 free_current_contents (void *ptr)
497 void **location = ptr;
499 if (location == NULL)
500 internal_error (__FILE__, __LINE__,
501 _("free_current_contents: NULL pointer"));
502 if (*location != NULL)
511 /* Print a warning message. The first argument STRING is the warning
512 message, used as an fprintf format string, the second is the
513 va_list of arguments for that string. A warning is unfiltered (not
514 paginated) so that the user does not need to page through each
515 screen full of warnings when there are lots of them. */
518 vwarning (const char *string, va_list args)
520 if (deprecated_warning_hook)
521 (*deprecated_warning_hook) (string, args);
524 target_terminal_ours ();
525 wrap_here (""); /* Force out any buffered output. */
526 gdb_flush (gdb_stdout);
527 if (warning_pre_print)
528 fputs_unfiltered (warning_pre_print, gdb_stderr);
529 vfprintf_unfiltered (gdb_stderr, string, args);
530 fprintf_unfiltered (gdb_stderr, "\n");
534 /* Print a warning message.
535 The first argument STRING is the warning message, used as a fprintf string,
536 and the remaining args are passed as arguments to it.
537 The primary difference between warnings and errors is that a warning
538 does not force the return to command level. */
541 warning (const char *string, ...)
545 va_start (args, string);
546 vwarning (string, args);
550 /* Print an error message and return to command level.
551 The first argument STRING is the error message, used as a fprintf string,
552 and the remaining args are passed as arguments to it. */
555 verror (const char *string, va_list args)
557 throw_verror (GENERIC_ERROR, string, args);
561 error (const char *string, ...)
565 va_start (args, string);
566 throw_verror (GENERIC_ERROR, string, args);
571 error_stream (struct ui_file *stream)
573 char *message = ui_file_xstrdup (stream, NULL);
575 make_cleanup (xfree, message);
576 error (("%s"), message);
579 /* Dump core trying to increase the core soft limit to hard limit first. */
584 #ifdef HAVE_SETRLIMIT
585 struct rlimit rlim = { RLIM_INFINITY, RLIM_INFINITY };
587 setrlimit (RLIMIT_CORE, &rlim);
588 #endif /* HAVE_SETRLIMIT */
590 abort (); /* NOTE: GDB has only three calls to abort(). */
593 /* Check whether GDB will be able to dump core using the dump_core
594 function. Returns zero if GDB cannot or should not dump core.
595 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
596 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
599 can_dump_core (enum resource_limit_kind limit_kind)
601 #ifdef HAVE_GETRLIMIT
604 /* Be quiet and assume we can dump if an error is returned. */
605 if (getrlimit (RLIMIT_CORE, &rlim) != 0)
611 if (rlim.rlim_cur == 0)
615 if (rlim.rlim_max == 0)
618 #endif /* HAVE_GETRLIMIT */
623 /* Print a warning that we cannot dump core. */
626 warn_cant_dump_core (const char *reason)
628 fprintf_unfiltered (gdb_stderr,
629 _("%s\nUnable to dump core, use `ulimit -c"
630 " unlimited' before executing GDB next time.\n"),
634 /* Check whether GDB will be able to dump core using the dump_core
635 function, and print a warning if we cannot. */
638 can_dump_core_warn (enum resource_limit_kind limit_kind,
641 int core_dump_allowed = can_dump_core (limit_kind);
643 if (!core_dump_allowed)
644 warn_cant_dump_core (reason);
646 return core_dump_allowed;
649 /* Allow the user to configure the debugger behavior with respect to
650 what to do when an internal problem is detected. */
652 const char internal_problem_ask[] = "ask";
653 const char internal_problem_yes[] = "yes";
654 const char internal_problem_no[] = "no";
655 static const char *const internal_problem_modes[] =
657 internal_problem_ask,
658 internal_problem_yes,
663 /* Print a message reporting an internal error/warning. Ask the user
664 if they want to continue, dump core, or just exit. Return
665 something to indicate a quit. */
667 struct internal_problem
670 int user_settable_should_quit;
671 const char *should_quit;
672 int user_settable_should_dump_core;
673 const char *should_dump_core;
676 /* Report a problem, internal to GDB, to the user. Once the problem
677 has been reported, and assuming GDB didn't quit, the caller can
678 either allow execution to resume or throw an error. */
680 static void ATTRIBUTE_PRINTF (4, 0)
681 internal_vproblem (struct internal_problem *problem,
682 const char *file, int line, const char *fmt, va_list ap)
688 struct cleanup *cleanup = make_cleanup (null_cleanup, NULL);
690 /* Don't allow infinite error/warning recursion. */
692 static char msg[] = "Recursive internal problem.\n";
701 fputs_unfiltered (msg, gdb_stderr);
702 abort (); /* NOTE: GDB has only three calls to abort(). */
705 /* Newer GLIBC versions put the warn_unused_result attribute
706 on write, but this is one of those rare cases where
707 ignoring the return value is correct. Casting to (void)
708 does not fix this problem. This is the solution suggested
709 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
710 if (write (STDERR_FILENO, msg, sizeof (msg)) != sizeof (msg))
711 abort (); /* NOTE: GDB has only three calls to abort(). */
716 /* Try to get the message out and at the start of a new line. */
717 target_terminal_ours ();
720 /* Create a string containing the full error/warning message. Need
721 to call query with this full string, as otherwize the reason
722 (error/warning) and question become separated. Format using a
723 style similar to a compiler error message. Include extra detail
724 so that the user knows that they are living on the edge. */
728 msg = xstrvprintf (fmt, ap);
729 reason = xstrprintf ("%s:%d: %s: %s\n"
730 "A problem internal to GDB has been detected,\n"
731 "further debugging may prove unreliable.",
732 file, line, problem->name, msg);
734 make_cleanup (xfree, reason);
737 if (problem->should_quit == internal_problem_ask)
739 /* Default (yes/batch case) is to quit GDB. When in batch mode
740 this lessens the likelihood of GDB going into an infinite
744 /* Emit the message and quit. */
745 fputs_unfiltered (reason, gdb_stderr);
746 fputs_unfiltered ("\n", gdb_stderr);
750 quit_p = query (_("%s\nQuit this debugging session? "), reason);
752 else if (problem->should_quit == internal_problem_yes)
754 else if (problem->should_quit == internal_problem_no)
757 internal_error (__FILE__, __LINE__, _("bad switch"));
759 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr);
760 if (REPORT_BUGS_TO[0])
761 fprintf_unfiltered (gdb_stderr, _(" For instructions, see:\n%s."),
763 fputs_unfiltered ("\n\n", gdb_stderr);
765 if (problem->should_dump_core == internal_problem_ask)
767 if (!can_dump_core_warn (LIMIT_MAX, reason))
771 /* Default (yes/batch case) is to dump core. This leaves a GDB
772 `dropping' so that it is easier to see that something went
774 dump_core_p = query (_("%s\nCreate a core file of GDB? "), reason);
777 else if (problem->should_dump_core == internal_problem_yes)
778 dump_core_p = can_dump_core_warn (LIMIT_MAX, reason);
779 else if (problem->should_dump_core == internal_problem_no)
782 internal_error (__FILE__, __LINE__, _("bad switch"));
795 #ifdef HAVE_WORKING_FORK
803 do_cleanups (cleanup);
806 static struct internal_problem internal_error_problem = {
807 "internal-error", 1, internal_problem_ask, 1, internal_problem_ask
811 internal_verror (const char *file, int line, const char *fmt, va_list ap)
813 internal_vproblem (&internal_error_problem, file, line, fmt, ap);
814 throw_quit (_("Command aborted."));
818 internal_error (const char *file, int line, const char *string, ...)
822 va_start (ap, string);
823 internal_verror (file, line, string, ap);
827 static struct internal_problem internal_warning_problem = {
828 "internal-warning", 1, internal_problem_ask, 1, internal_problem_ask
832 internal_vwarning (const char *file, int line, const char *fmt, va_list ap)
834 internal_vproblem (&internal_warning_problem, file, line, fmt, ap);
838 internal_warning (const char *file, int line, const char *string, ...)
842 va_start (ap, string);
843 internal_vwarning (file, line, string, ap);
847 static struct internal_problem demangler_warning_problem = {
848 "demangler-warning", 1, internal_problem_ask, 0, internal_problem_no
852 demangler_vwarning (const char *file, int line, const char *fmt, va_list ap)
854 internal_vproblem (&demangler_warning_problem, file, line, fmt, ap);
858 demangler_warning (const char *file, int line, const char *string, ...)
862 va_start (ap, string);
863 demangler_vwarning (file, line, string, ap);
867 /* Dummy functions to keep add_prefix_cmd happy. */
870 set_internal_problem_cmd (char *args, int from_tty)
875 show_internal_problem_cmd (char *args, int from_tty)
879 /* When GDB reports an internal problem (error or warning) it gives
880 the user the opportunity to quit GDB and/or create a core file of
881 the current debug session. This function registers a few commands
882 that make it possible to specify that GDB should always or never
883 quit or create a core file, without asking. The commands look
886 maint set PROBLEM-NAME quit ask|yes|no
887 maint show PROBLEM-NAME quit
888 maint set PROBLEM-NAME corefile ask|yes|no
889 maint show PROBLEM-NAME corefile
891 Where PROBLEM-NAME is currently "internal-error" or
892 "internal-warning". */
895 add_internal_problem_command (struct internal_problem *problem)
897 struct cmd_list_element **set_cmd_list;
898 struct cmd_list_element **show_cmd_list;
902 set_cmd_list = xmalloc (sizeof (*set_cmd_list));
903 show_cmd_list = xmalloc (sizeof (*set_cmd_list));
904 *set_cmd_list = NULL;
905 *show_cmd_list = NULL;
907 set_doc = xstrprintf (_("Configure what GDB does when %s is detected."),
910 show_doc = xstrprintf (_("Show what GDB does when %s is detected."),
913 add_prefix_cmd ((char*) problem->name,
914 class_maintenance, set_internal_problem_cmd, set_doc,
916 concat ("maintenance set ", problem->name, " ",
918 0/*allow-unknown*/, &maintenance_set_cmdlist);
920 add_prefix_cmd ((char*) problem->name,
921 class_maintenance, show_internal_problem_cmd, show_doc,
923 concat ("maintenance show ", problem->name, " ",
925 0/*allow-unknown*/, &maintenance_show_cmdlist);
927 if (problem->user_settable_should_quit)
929 set_doc = xstrprintf (_("Set whether GDB should quit "
930 "when an %s is detected"),
932 show_doc = xstrprintf (_("Show whether GDB will quit "
933 "when an %s is detected"),
935 add_setshow_enum_cmd ("quit", class_maintenance,
936 internal_problem_modes,
937 &problem->should_quit,
950 if (problem->user_settable_should_dump_core)
952 set_doc = xstrprintf (_("Set whether GDB should create a core "
953 "file of GDB when %s is detected"),
955 show_doc = xstrprintf (_("Show whether GDB will create a core "
956 "file of GDB when %s is detected"),
958 add_setshow_enum_cmd ("corefile", class_maintenance,
959 internal_problem_modes,
960 &problem->should_dump_core,
974 /* Return a newly allocated string, containing the PREFIX followed
975 by the system error message for errno (separated by a colon).
977 The result must be deallocated after use. */
980 perror_string (const char *prefix)
985 err = safe_strerror (errno);
986 combined = (char *) xmalloc (strlen (err) + strlen (prefix) + 3);
987 strcpy (combined, prefix);
988 strcat (combined, ": ");
989 strcat (combined, err);
994 /* Print the system error message for errno, and also mention STRING
995 as the file name for which the error was encountered. Use ERRCODE
996 for the thrown exception. Then return to command level. */
999 throw_perror_with_name (enum errors errcode, const char *string)
1003 combined = perror_string (string);
1004 make_cleanup (xfree, combined);
1006 /* I understand setting these is a matter of taste. Still, some people
1007 may clear errno but not know about bfd_error. Doing this here is not
1009 bfd_set_error (bfd_error_no_error);
1012 throw_error (errcode, _("%s."), combined);
1015 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
1018 perror_with_name (const char *string)
1020 throw_perror_with_name (GENERIC_ERROR, string);
1023 /* Same as perror_with_name except that it prints a warning instead
1024 of throwing an error. */
1027 perror_warning_with_name (const char *string)
1031 combined = perror_string (string);
1032 warning (_("%s"), combined);
1036 /* Print the system error message for ERRCODE, and also mention STRING
1037 as the file name for which the error was encountered. */
1040 print_sys_errmsg (const char *string, int errcode)
1045 err = safe_strerror (errcode);
1046 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
1047 strcpy (combined, string);
1048 strcat (combined, ": ");
1049 strcat (combined, err);
1051 /* We want anything which was printed on stdout to come out first, before
1053 gdb_flush (gdb_stdout);
1054 fprintf_unfiltered (gdb_stderr, "%s.\n", combined);
1057 /* Control C eventually causes this to be called, at a convenient time. */
1062 if (sync_quit_force_run)
1064 sync_quit_force_run = 0;
1065 quit_force (NULL, stdin == instream);
1069 /* No steenking SIGINT will ever be coming our way when the
1070 program is resumed. Don't lie. */
1071 throw_quit ("Quit");
1074 /* If there is no terminal switching for this target, then we can't
1075 possibly get screwed by the lack of job control. */
1076 || !target_supports_terminal_ours ())
1077 throw_quit ("Quit");
1079 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
1084 /* Called when a memory allocation fails, with the number of bytes of
1085 memory requested in SIZE. */
1088 malloc_failure (long size)
1092 internal_error (__FILE__, __LINE__,
1093 _("virtual memory exhausted: can't allocate %ld bytes."),
1098 internal_error (__FILE__, __LINE__, _("virtual memory exhausted."));
1102 /* My replacement for the read system call.
1103 Used like `read' but keeps going if `read' returns too soon. */
1106 myread (int desc, char *addr, int len)
1113 val = read (desc, addr, len);
1117 return orglen - len;
1125 print_spaces (int n, struct ui_file *file)
1127 fputs_unfiltered (n_spaces (n), file);
1130 /* Print a host address. */
1133 gdb_print_host_address (const void *addr, struct ui_file *stream)
1135 fprintf_filtered (stream, "%s", host_address_to_string (addr));
1139 /* A cleanup function that calls regfree. */
1142 do_regfree_cleanup (void *r)
1147 /* Create a new cleanup that frees the compiled regular expression R. */
1150 make_regfree_cleanup (regex_t *r)
1152 return make_cleanup (do_regfree_cleanup, r);
1155 /* Return an xmalloc'd error message resulting from a regular
1156 expression compilation failure. */
1159 get_regcomp_error (int code, regex_t *rx)
1161 size_t length = regerror (code, rx, NULL, 0);
1162 char *result = xmalloc (length);
1164 regerror (code, rx, result, length);
1168 /* Compile a regexp and throw an exception on error. This returns a
1169 cleanup to free the resulting pattern on success. RX must not be
1173 compile_rx_or_error (regex_t *pattern, const char *rx, const char *message)
1177 gdb_assert (rx != NULL);
1179 code = regcomp (pattern, rx, REG_NOSUB);
1182 char *err = get_regcomp_error (code, pattern);
1184 make_cleanup (xfree, err);
1185 error (("%s: %s"), message, err);
1188 return make_regfree_cleanup (pattern);
1193 /* This function supports the query, nquery, and yquery functions.
1194 Ask user a y-or-n question and return 0 if answer is no, 1 if
1195 answer is yes, or default the answer to the specified default
1196 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1197 default answer, or '\0' for no default.
1198 CTLSTR is the control string and should end in "? ". It should
1199 not say how to answer, because we do that.
1200 ARGS are the arguments passed along with the CTLSTR argument to
1203 static int ATTRIBUTE_PRINTF (1, 0)
1204 defaulted_query (const char *ctlstr, const char defchar, va_list args)
1210 char def_answer, not_def_answer;
1211 char *y_string, *n_string, *question;
1212 /* Used to add duration we waited for user to respond to
1213 prompt_for_continue_wait_time. */
1214 struct timeval prompt_started, prompt_ended, prompt_delta;
1216 /* Set up according to which answer is the default. */
1217 if (defchar == '\0')
1221 not_def_answer = 'N';
1225 else if (defchar == 'y')
1229 not_def_answer = 'N';
1237 not_def_answer = 'Y';
1242 /* Automatically answer the default value if the user did not want
1243 prompts or the command was issued with the server prefix. */
1244 if (!confirm || server_command)
1247 /* If input isn't coming from the user directly, just say what
1248 question we're asking, and then answer the default automatically. This
1249 way, important error messages don't get lost when talking to GDB
1251 if (! input_from_terminal_p ())
1254 vfprintf_filtered (gdb_stdout, ctlstr, args);
1256 printf_filtered (_("(%s or %s) [answered %c; "
1257 "input not from terminal]\n"),
1258 y_string, n_string, def_answer);
1259 gdb_flush (gdb_stdout);
1264 if (deprecated_query_hook)
1266 return deprecated_query_hook (ctlstr, args);
1269 /* Format the question outside of the loop, to avoid reusing args. */
1270 question = xstrvprintf (ctlstr, args);
1272 /* Used for calculating time spend waiting for user. */
1273 gettimeofday (&prompt_started, NULL);
1277 wrap_here (""); /* Flush any buffered output. */
1278 gdb_flush (gdb_stdout);
1280 if (annotation_level > 1)
1281 printf_filtered (("\n\032\032pre-query\n"));
1283 fputs_filtered (question, gdb_stdout);
1284 printf_filtered (_("(%s or %s) "), y_string, n_string);
1286 if (annotation_level > 1)
1287 printf_filtered (("\n\032\032query\n"));
1290 gdb_flush (gdb_stdout);
1292 answer = fgetc (stdin);
1294 /* We expect fgetc to block until a character is read. But
1295 this may not be the case if the terminal was opened with
1296 the NONBLOCK flag. In that case, if there is nothing to
1297 read on stdin, fgetc returns EOF, but also sets the error
1298 condition flag on stdin and errno to EAGAIN. With a true
1299 EOF, stdin's error condition flag is not set.
1301 A situation where this behavior was observed is a pseudo
1303 while (answer == EOF && ferror (stdin) && errno == EAGAIN)
1305 /* Not a real EOF. Wait a little while and try again until
1306 we read something. */
1309 answer = fgetc (stdin);
1312 clearerr (stdin); /* in case of C-d */
1313 if (answer == EOF) /* C-d */
1315 printf_filtered ("EOF [assumed %c]\n", def_answer);
1319 /* Eat rest of input line, to EOF or newline. */
1323 ans2 = fgetc (stdin);
1326 while (ans2 != EOF && ans2 != '\n' && ans2 != '\r');
1330 /* Check answer. For the non-default, the user must specify
1331 the non-default explicitly. */
1332 if (answer == not_def_answer)
1334 retval = !def_value;
1337 /* Otherwise, if a default was specified, the user may either
1338 specify the required input or have it default by entering
1340 if (answer == def_answer
1341 || (defchar != '\0' &&
1342 (answer == '\n' || answer == '\r' || answer == EOF)))
1347 /* Invalid entries are not defaulted and require another selection. */
1348 printf_filtered (_("Please answer %s or %s.\n"),
1349 y_string, n_string);
1352 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1353 gettimeofday (&prompt_ended, NULL);
1354 timeval_sub (&prompt_delta, &prompt_ended, &prompt_started);
1355 timeval_add (&prompt_for_continue_wait_time,
1356 &prompt_for_continue_wait_time, &prompt_delta);
1359 if (annotation_level > 1)
1360 printf_filtered (("\n\032\032post-query\n"));
1365 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1366 answer is yes, or 0 if answer is defaulted.
1367 Takes three args which are given to printf to print the question.
1368 The first, a control string, should end in "? ".
1369 It should not say how to answer, because we do that. */
1372 nquery (const char *ctlstr, ...)
1377 va_start (args, ctlstr);
1378 ret = defaulted_query (ctlstr, 'n', args);
1383 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1384 answer is yes, or 1 if answer is defaulted.
1385 Takes three args which are given to printf to print the question.
1386 The first, a control string, should end in "? ".
1387 It should not say how to answer, because we do that. */
1390 yquery (const char *ctlstr, ...)
1395 va_start (args, ctlstr);
1396 ret = defaulted_query (ctlstr, 'y', args);
1401 /* Ask user a y-or-n question and return 1 iff answer is yes.
1402 Takes three args which are given to printf to print the question.
1403 The first, a control string, should end in "? ".
1404 It should not say how to answer, because we do that. */
1407 query (const char *ctlstr, ...)
1412 va_start (args, ctlstr);
1413 ret = defaulted_query (ctlstr, '\0', args);
1418 /* A helper for parse_escape that converts a host character to a
1419 target character. C is the host character. If conversion is
1420 possible, then the target character is stored in *TARGET_C and the
1421 function returns 1. Otherwise, the function returns 0. */
1424 host_char_to_target (struct gdbarch *gdbarch, int c, int *target_c)
1426 struct obstack host_data;
1428 struct cleanup *cleanups;
1431 obstack_init (&host_data);
1432 cleanups = make_cleanup_obstack_free (&host_data);
1434 convert_between_encodings (target_charset (gdbarch), host_charset (),
1435 (gdb_byte *) &the_char, 1, 1,
1436 &host_data, translit_none);
1438 if (obstack_object_size (&host_data) == 1)
1441 *target_c = *(char *) obstack_base (&host_data);
1444 do_cleanups (cleanups);
1448 /* Parse a C escape sequence. STRING_PTR points to a variable
1449 containing a pointer to the string to parse. That pointer
1450 should point to the character after the \. That pointer
1451 is updated past the characters we use. The value of the
1452 escape sequence is returned.
1454 A negative value means the sequence \ newline was seen,
1455 which is supposed to be equivalent to nothing at all.
1457 If \ is followed by a null character, we return a negative
1458 value and leave the string pointer pointing at the null character.
1460 If \ is followed by 000, we return 0 and leave the string pointer
1461 after the zeros. A value of 0 does not mean end of string. */
1464 parse_escape (struct gdbarch *gdbarch, const char **string_ptr)
1466 int target_char = -2; /* Initialize to avoid GCC warnings. */
1467 int c = *(*string_ptr)++;
1486 int i = host_hex_value (c);
1491 if (isdigit (c) && c != '8' && c != '9')
1495 i += host_hex_value (c);
1531 if (!host_char_to_target (gdbarch, c, &target_char))
1532 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1533 " which has no equivalent\nin the `%s' character set."),
1534 c, c, target_charset (gdbarch));
1538 /* Print the character C on STREAM as part of the contents of a literal
1539 string whose delimiter is QUOTER. Note that this routine should only
1540 be call for printing things which are independent of the language
1541 of the program being debugged.
1543 printchar will normally escape backslashes and instances of QUOTER. If
1544 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1545 As a side effect, if you pass the backslash character as the QUOTER,
1546 printchar will escape backslashes as usual, but not any other quoting
1550 printchar (int c, void (*do_fputs) (const char *, struct ui_file *),
1551 void (*do_fprintf) (struct ui_file *, const char *, ...)
1552 ATTRIBUTE_FPTR_PRINTF_2, struct ui_file *stream, int quoter)
1554 c &= 0xFF; /* Avoid sign bit follies */
1556 if (c < 0x20 || /* Low control chars */
1557 (c >= 0x7F && c < 0xA0) || /* DEL, High controls */
1558 (sevenbit_strings && c >= 0x80))
1559 { /* high order bit set */
1563 do_fputs ("\\n", stream);
1566 do_fputs ("\\b", stream);
1569 do_fputs ("\\t", stream);
1572 do_fputs ("\\f", stream);
1575 do_fputs ("\\r", stream);
1578 do_fputs ("\\e", stream);
1581 do_fputs ("\\a", stream);
1584 do_fprintf (stream, "\\%.3o", (unsigned int) c);
1590 if (quoter != 0 && (c == '\\' || c == quoter))
1591 do_fputs ("\\", stream);
1592 do_fprintf (stream, "%c", c);
1596 /* Print the character C on STREAM as part of the contents of a
1597 literal string whose delimiter is QUOTER. Note that these routines
1598 should only be call for printing things which are independent of
1599 the language of the program being debugged. */
1602 fputstr_filtered (const char *str, int quoter, struct ui_file *stream)
1605 printchar (*str++, fputs_filtered, fprintf_filtered, stream, quoter);
1609 fputstr_unfiltered (const char *str, int quoter, struct ui_file *stream)
1612 printchar (*str++, fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1616 fputstrn_filtered (const char *str, int n, int quoter,
1617 struct ui_file *stream)
1621 for (i = 0; i < n; i++)
1622 printchar (str[i], fputs_filtered, fprintf_filtered, stream, quoter);
1626 fputstrn_unfiltered (const char *str, int n, int quoter,
1627 struct ui_file *stream)
1631 for (i = 0; i < n; i++)
1632 printchar (str[i], fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1636 /* Number of lines per page or UINT_MAX if paging is disabled. */
1637 static unsigned int lines_per_page;
1639 show_lines_per_page (struct ui_file *file, int from_tty,
1640 struct cmd_list_element *c, const char *value)
1642 fprintf_filtered (file,
1643 _("Number of lines gdb thinks are in a page is %s.\n"),
1647 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1648 static unsigned int chars_per_line;
1650 show_chars_per_line (struct ui_file *file, int from_tty,
1651 struct cmd_list_element *c, const char *value)
1653 fprintf_filtered (file,
1654 _("Number of characters gdb thinks "
1655 "are in a line is %s.\n"),
1659 /* Current count of lines printed on this page, chars on this line. */
1660 static unsigned int lines_printed, chars_printed;
1662 /* Buffer and start column of buffered text, for doing smarter word-
1663 wrapping. When someone calls wrap_here(), we start buffering output
1664 that comes through fputs_filtered(). If we see a newline, we just
1665 spit it out and forget about the wrap_here(). If we see another
1666 wrap_here(), we spit it out and remember the newer one. If we see
1667 the end of the line, we spit out a newline, the indent, and then
1668 the buffered output. */
1670 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1671 are waiting to be output (they have already been counted in chars_printed).
1672 When wrap_buffer[0] is null, the buffer is empty. */
1673 static char *wrap_buffer;
1675 /* Pointer in wrap_buffer to the next character to fill. */
1676 static char *wrap_pointer;
1678 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1680 static char *wrap_indent;
1682 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1683 is not in effect. */
1684 static int wrap_column;
1687 /* Inialize the number of lines per page and chars per line. */
1690 init_page_info (void)
1694 lines_per_page = UINT_MAX;
1695 chars_per_line = UINT_MAX;
1699 if (!tui_get_command_dimension (&chars_per_line, &lines_per_page))
1704 #if defined(__GO32__)
1705 rows = ScreenRows ();
1706 cols = ScreenCols ();
1707 lines_per_page = rows;
1708 chars_per_line = cols;
1710 /* Make sure Readline has initialized its terminal settings. */
1711 rl_reset_terminal (NULL);
1713 /* Get the screen size from Readline. */
1714 rl_get_screen_size (&rows, &cols);
1715 lines_per_page = rows;
1716 chars_per_line = cols;
1718 /* Readline should have fetched the termcap entry for us.
1719 Only try to use tgetnum function if rl_get_screen_size
1720 did not return a useful value. */
1721 if (((rows <= 0) && (tgetnum ("li") < 0))
1722 /* Also disable paging if inside EMACS. */
1723 || getenv ("EMACS"))
1725 /* The number of lines per page is not mentioned in the terminal
1726 description or EMACS evironment variable is set. This probably
1727 means that paging is not useful, so disable paging. */
1728 lines_per_page = UINT_MAX;
1731 /* If the output is not a terminal, don't paginate it. */
1732 if (!ui_file_isatty (gdb_stdout))
1733 lines_per_page = UINT_MAX;
1741 /* Helper for make_cleanup_restore_page_info. */
1744 do_restore_page_info_cleanup (void *arg)
1750 /* Provide cleanup for restoring the terminal size. */
1753 make_cleanup_restore_page_info (void)
1755 struct cleanup *back_to;
1757 back_to = make_cleanup (do_restore_page_info_cleanup, NULL);
1758 make_cleanup_restore_uinteger (&lines_per_page);
1759 make_cleanup_restore_uinteger (&chars_per_line);
1764 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1765 Provide cleanup for restoring the original state. */
1768 set_batch_flag_and_make_cleanup_restore_page_info (void)
1770 struct cleanup *back_to = make_cleanup_restore_page_info ();
1772 make_cleanup_restore_integer (&batch_flag);
1779 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1782 set_screen_size (void)
1784 int rows = lines_per_page;
1785 int cols = chars_per_line;
1793 /* Update Readline's idea of the terminal size. */
1794 rl_set_screen_size (rows, cols);
1797 /* Reinitialize WRAP_BUFFER according to the current value of
1803 if (chars_per_line == 0)
1808 wrap_buffer = (char *) xmalloc (chars_per_line + 2);
1809 wrap_buffer[0] = '\0';
1812 wrap_buffer = (char *) xrealloc (wrap_buffer, chars_per_line + 2);
1813 wrap_pointer = wrap_buffer; /* Start it at the beginning. */
1817 set_width_command (char *args, int from_tty, struct cmd_list_element *c)
1824 set_height_command (char *args, int from_tty, struct cmd_list_element *c)
1829 /* Wait, so the user can read what's on the screen. Prompt the user
1830 to continue by pressing RETURN. */
1833 prompt_for_continue (void)
1836 char cont_prompt[120];
1837 /* Used to add duration we waited for user to respond to
1838 prompt_for_continue_wait_time. */
1839 struct timeval prompt_started, prompt_ended, prompt_delta;
1841 gettimeofday (&prompt_started, NULL);
1843 if (annotation_level > 1)
1844 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1846 strcpy (cont_prompt,
1847 "---Type <return> to continue, or q <return> to quit---");
1848 if (annotation_level > 1)
1849 strcat (cont_prompt, "\n\032\032prompt-for-continue\n");
1851 /* We must do this *before* we call gdb_readline, else it will eventually
1852 call us -- thinking that we're trying to print beyond the end of the
1854 reinitialize_more_filter ();
1859 /* We'll need to handle input. */
1860 target_terminal_ours ();
1862 /* On a real operating system, the user can quit with SIGINT.
1865 'q' is provided on all systems so users don't have to change habits
1866 from system to system, and because telling them what to do in
1867 the prompt is more user-friendly than expecting them to think of
1869 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1870 whereas control-C to gdb_readline will cause the user to get dumped
1872 ignore = gdb_readline_wrapper (cont_prompt);
1874 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1875 gettimeofday (&prompt_ended, NULL);
1876 timeval_sub (&prompt_delta, &prompt_ended, &prompt_started);
1877 timeval_add (&prompt_for_continue_wait_time,
1878 &prompt_for_continue_wait_time, &prompt_delta);
1880 if (annotation_level > 1)
1881 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1887 while (*p == ' ' || *p == '\t')
1895 /* Now we have to do this again, so that GDB will know that it doesn't
1896 need to save the ---Type <return>--- line at the top of the screen. */
1897 reinitialize_more_filter ();
1899 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1902 /* Initalize timer to keep track of how long we waited for the user. */
1905 reset_prompt_for_continue_wait_time (void)
1907 static const struct timeval zero_timeval = { 0 };
1909 prompt_for_continue_wait_time = zero_timeval;
1912 /* Fetch the cumulative time spent in prompt_for_continue. */
1915 get_prompt_for_continue_wait_time (void)
1917 return prompt_for_continue_wait_time;
1920 /* Reinitialize filter; ie. tell it to reset to original values. */
1923 reinitialize_more_filter (void)
1929 /* Indicate that if the next sequence of characters overflows the line,
1930 a newline should be inserted here rather than when it hits the end.
1931 If INDENT is non-null, it is a string to be printed to indent the
1932 wrapped part on the next line. INDENT must remain accessible until
1933 the next call to wrap_here() or until a newline is printed through
1936 If the line is already overfull, we immediately print a newline and
1937 the indentation, and disable further wrapping.
1939 If we don't know the width of lines, but we know the page height,
1940 we must not wrap words, but should still keep track of newlines
1941 that were explicitly printed.
1943 INDENT should not contain tabs, as that will mess up the char count
1944 on the next line. FIXME.
1946 This routine is guaranteed to force out any output which has been
1947 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1948 used to force out output from the wrap_buffer. */
1951 wrap_here (char *indent)
1953 /* This should have been allocated, but be paranoid anyway. */
1955 internal_error (__FILE__, __LINE__,
1956 _("failed internal consistency check"));
1960 *wrap_pointer = '\0';
1961 fputs_unfiltered (wrap_buffer, gdb_stdout);
1963 wrap_pointer = wrap_buffer;
1964 wrap_buffer[0] = '\0';
1965 if (chars_per_line == UINT_MAX) /* No line overflow checking. */
1969 else if (chars_printed >= chars_per_line)
1971 puts_filtered ("\n");
1973 puts_filtered (indent);
1978 wrap_column = chars_printed;
1982 wrap_indent = indent;
1986 /* Print input string to gdb_stdout, filtered, with wrap,
1987 arranging strings in columns of n chars. String can be
1988 right or left justified in the column. Never prints
1989 trailing spaces. String should never be longer than
1990 width. FIXME: this could be useful for the EXAMINE
1991 command, which currently doesn't tabulate very well. */
1994 puts_filtered_tabular (char *string, int width, int right)
2000 gdb_assert (chars_per_line > 0);
2001 if (chars_per_line == UINT_MAX)
2003 fputs_filtered (string, gdb_stdout);
2004 fputs_filtered ("\n", gdb_stdout);
2008 if (((chars_printed - 1) / width + 2) * width >= chars_per_line)
2009 fputs_filtered ("\n", gdb_stdout);
2011 if (width >= chars_per_line)
2012 width = chars_per_line - 1;
2014 stringlen = strlen (string);
2016 if (chars_printed > 0)
2017 spaces = width - (chars_printed - 1) % width - 1;
2019 spaces += width - stringlen;
2021 spacebuf = alloca (spaces + 1);
2022 spacebuf[spaces] = '\0';
2024 spacebuf[spaces] = ' ';
2026 fputs_filtered (spacebuf, gdb_stdout);
2027 fputs_filtered (string, gdb_stdout);
2031 /* Ensure that whatever gets printed next, using the filtered output
2032 commands, starts at the beginning of the line. I.e. if there is
2033 any pending output for the current line, flush it and start a new
2034 line. Otherwise do nothing. */
2039 if (chars_printed > 0)
2041 puts_filtered ("\n");
2046 /* Like fputs but if FILTER is true, pause after every screenful.
2048 Regardless of FILTER can wrap at points other than the final
2049 character of a line.
2051 Unlike fputs, fputs_maybe_filtered does not return a value.
2052 It is OK for LINEBUFFER to be NULL, in which case just don't print
2055 Note that a longjmp to top level may occur in this routine (only if
2056 FILTER is true) (since prompt_for_continue may do so) so this
2057 routine should not be called when cleanups are not in place. */
2060 fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
2063 const char *lineptr;
2065 if (linebuffer == 0)
2068 /* Don't do any filtering if it is disabled. */
2069 if (stream != gdb_stdout
2070 || !pagination_enabled
2072 || (lines_per_page == UINT_MAX && chars_per_line == UINT_MAX)
2073 || top_level_interpreter () == NULL
2074 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2076 fputs_unfiltered (linebuffer, stream);
2080 /* Go through and output each character. Show line extension
2081 when this is necessary; prompt user for new page when this is
2084 lineptr = linebuffer;
2087 /* Possible new page. */
2088 if (filter && (lines_printed >= lines_per_page - 1))
2089 prompt_for_continue ();
2091 while (*lineptr && *lineptr != '\n')
2093 /* Print a single line. */
2094 if (*lineptr == '\t')
2097 *wrap_pointer++ = '\t';
2099 fputc_unfiltered ('\t', stream);
2100 /* Shifting right by 3 produces the number of tab stops
2101 we have already passed, and then adding one and
2102 shifting left 3 advances to the next tab stop. */
2103 chars_printed = ((chars_printed >> 3) + 1) << 3;
2109 *wrap_pointer++ = *lineptr;
2111 fputc_unfiltered (*lineptr, stream);
2116 if (chars_printed >= chars_per_line)
2118 unsigned int save_chars = chars_printed;
2122 /* If we aren't actually wrapping, don't output newline --
2123 if chars_per_line is right, we probably just overflowed
2124 anyway; if it's wrong, let us keep going. */
2126 fputc_unfiltered ('\n', stream);
2128 /* Possible new page. */
2129 if (lines_printed >= lines_per_page - 1)
2130 prompt_for_continue ();
2132 /* Now output indentation and wrapped string. */
2135 fputs_unfiltered (wrap_indent, stream);
2136 *wrap_pointer = '\0'; /* Null-terminate saved stuff, */
2137 fputs_unfiltered (wrap_buffer, stream); /* and eject it. */
2138 /* FIXME, this strlen is what prevents wrap_indent from
2139 containing tabs. However, if we recurse to print it
2140 and count its chars, we risk trouble if wrap_indent is
2141 longer than (the user settable) chars_per_line.
2142 Note also that this can set chars_printed > chars_per_line
2143 if we are printing a long string. */
2144 chars_printed = strlen (wrap_indent)
2145 + (save_chars - wrap_column);
2146 wrap_pointer = wrap_buffer; /* Reset buffer */
2147 wrap_buffer[0] = '\0';
2148 wrap_column = 0; /* And disable fancy wrap */
2153 if (*lineptr == '\n')
2156 wrap_here ((char *) 0); /* Spit out chars, cancel
2159 fputc_unfiltered ('\n', stream);
2166 fputs_filtered (const char *linebuffer, struct ui_file *stream)
2168 fputs_maybe_filtered (linebuffer, stream, 1);
2172 putchar_unfiltered (int c)
2176 ui_file_write (gdb_stdout, &buf, 1);
2180 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2181 May return nonlocally. */
2184 putchar_filtered (int c)
2186 return fputc_filtered (c, gdb_stdout);
2190 fputc_unfiltered (int c, struct ui_file *stream)
2194 ui_file_write (stream, &buf, 1);
2199 fputc_filtered (int c, struct ui_file *stream)
2205 fputs_filtered (buf, stream);
2209 /* puts_debug is like fputs_unfiltered, except it prints special
2210 characters in printable fashion. */
2213 puts_debug (char *prefix, char *string, char *suffix)
2217 /* Print prefix and suffix after each line. */
2218 static int new_line = 1;
2219 static int return_p = 0;
2220 static char *prev_prefix = "";
2221 static char *prev_suffix = "";
2223 if (*string == '\n')
2226 /* If the prefix is changing, print the previous suffix, a new line,
2227 and the new prefix. */
2228 if ((return_p || (strcmp (prev_prefix, prefix) != 0)) && !new_line)
2230 fputs_unfiltered (prev_suffix, gdb_stdlog);
2231 fputs_unfiltered ("\n", gdb_stdlog);
2232 fputs_unfiltered (prefix, gdb_stdlog);
2235 /* Print prefix if we printed a newline during the previous call. */
2239 fputs_unfiltered (prefix, gdb_stdlog);
2242 prev_prefix = prefix;
2243 prev_suffix = suffix;
2245 /* Output characters in a printable format. */
2246 while ((ch = *string++) != '\0')
2252 fputc_unfiltered (ch, gdb_stdlog);
2255 fprintf_unfiltered (gdb_stdlog, "\\x%02x", ch & 0xff);
2259 fputs_unfiltered ("\\\\", gdb_stdlog);
2262 fputs_unfiltered ("\\b", gdb_stdlog);
2265 fputs_unfiltered ("\\f", gdb_stdlog);
2269 fputs_unfiltered ("\\n", gdb_stdlog);
2272 fputs_unfiltered ("\\r", gdb_stdlog);
2275 fputs_unfiltered ("\\t", gdb_stdlog);
2278 fputs_unfiltered ("\\v", gdb_stdlog);
2282 return_p = ch == '\r';
2285 /* Print suffix if we printed a newline. */
2288 fputs_unfiltered (suffix, gdb_stdlog);
2289 fputs_unfiltered ("\n", gdb_stdlog);
2294 /* Print a variable number of ARGS using format FORMAT. If this
2295 information is going to put the amount written (since the last call
2296 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2297 call prompt_for_continue to get the users permision to continue.
2299 Unlike fprintf, this function does not return a value.
2301 We implement three variants, vfprintf (takes a vararg list and stream),
2302 fprintf (takes a stream to write on), and printf (the usual).
2304 Note also that a longjmp to top level may occur in this routine
2305 (since prompt_for_continue may do so) so this routine should not be
2306 called when cleanups are not in place. */
2309 vfprintf_maybe_filtered (struct ui_file *stream, const char *format,
2310 va_list args, int filter)
2313 struct cleanup *old_cleanups;
2315 linebuffer = xstrvprintf (format, args);
2316 old_cleanups = make_cleanup (xfree, linebuffer);
2317 fputs_maybe_filtered (linebuffer, stream, filter);
2318 do_cleanups (old_cleanups);
2323 vfprintf_filtered (struct ui_file *stream, const char *format, va_list args)
2325 vfprintf_maybe_filtered (stream, format, args, 1);
2329 vfprintf_unfiltered (struct ui_file *stream, const char *format, va_list args)
2332 struct cleanup *old_cleanups;
2334 linebuffer = xstrvprintf (format, args);
2335 old_cleanups = make_cleanup (xfree, linebuffer);
2336 if (debug_timestamp && stream == gdb_stdlog)
2342 gettimeofday (&tm, NULL);
2344 len = strlen (linebuffer);
2345 need_nl = (len > 0 && linebuffer[len - 1] != '\n');
2347 timestamp = xstrprintf ("%ld:%ld %s%s",
2348 (long) tm.tv_sec, (long) tm.tv_usec,
2350 need_nl ? "\n": "");
2351 make_cleanup (xfree, timestamp);
2352 fputs_unfiltered (timestamp, stream);
2355 fputs_unfiltered (linebuffer, stream);
2356 do_cleanups (old_cleanups);
2360 vprintf_filtered (const char *format, va_list args)
2362 vfprintf_maybe_filtered (gdb_stdout, format, args, 1);
2366 vprintf_unfiltered (const char *format, va_list args)
2368 vfprintf_unfiltered (gdb_stdout, format, args);
2372 fprintf_filtered (struct ui_file *stream, const char *format, ...)
2376 va_start (args, format);
2377 vfprintf_filtered (stream, format, args);
2382 fprintf_unfiltered (struct ui_file *stream, const char *format, ...)
2386 va_start (args, format);
2387 vfprintf_unfiltered (stream, format, args);
2391 /* Like fprintf_filtered, but prints its result indented.
2392 Called as fprintfi_filtered (spaces, stream, format, ...); */
2395 fprintfi_filtered (int spaces, struct ui_file *stream, const char *format,
2400 va_start (args, format);
2401 print_spaces_filtered (spaces, stream);
2403 vfprintf_filtered (stream, format, args);
2409 printf_filtered (const char *format, ...)
2413 va_start (args, format);
2414 vfprintf_filtered (gdb_stdout, format, args);
2420 printf_unfiltered (const char *format, ...)
2424 va_start (args, format);
2425 vfprintf_unfiltered (gdb_stdout, format, args);
2429 /* Like printf_filtered, but prints it's result indented.
2430 Called as printfi_filtered (spaces, format, ...); */
2433 printfi_filtered (int spaces, const char *format, ...)
2437 va_start (args, format);
2438 print_spaces_filtered (spaces, gdb_stdout);
2439 vfprintf_filtered (gdb_stdout, format, args);
2443 /* Easy -- but watch out!
2445 This routine is *not* a replacement for puts()! puts() appends a newline.
2446 This one doesn't, and had better not! */
2449 puts_filtered (const char *string)
2451 fputs_filtered (string, gdb_stdout);
2455 puts_unfiltered (const char *string)
2457 fputs_unfiltered (string, gdb_stdout);
2460 /* Return a pointer to N spaces and a null. The pointer is good
2461 until the next call to here. */
2466 static char *spaces = 0;
2467 static int max_spaces = -1;
2473 spaces = (char *) xmalloc (n + 1);
2474 for (t = spaces + n; t != spaces;)
2480 return spaces + max_spaces - n;
2483 /* Print N spaces. */
2485 print_spaces_filtered (int n, struct ui_file *stream)
2487 fputs_filtered (n_spaces (n), stream);
2490 /* C++/ObjC demangler stuff. */
2492 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2493 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2494 If the name is not mangled, or the language for the name is unknown, or
2495 demangling is off, the name is printed in its "raw" form. */
2498 fprintf_symbol_filtered (struct ui_file *stream, const char *name,
2499 enum language lang, int arg_mode)
2505 /* If user wants to see raw output, no problem. */
2508 fputs_filtered (name, stream);
2512 demangled = language_demangle (language_def (lang), name, arg_mode);
2513 fputs_filtered (demangled ? demangled : name, stream);
2514 if (demangled != NULL)
2522 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2523 differences in whitespace. Returns 0 if they match, non-zero if they
2524 don't (slightly different than strcmp()'s range of return values).
2526 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2527 This "feature" is useful when searching for matching C++ function names
2528 (such as if the user types 'break FOO', where FOO is a mangled C++
2532 strcmp_iw (const char *string1, const char *string2)
2534 while ((*string1 != '\0') && (*string2 != '\0'))
2536 while (isspace (*string1))
2540 while (isspace (*string2))
2544 if (case_sensitivity == case_sensitive_on && *string1 != *string2)
2546 if (case_sensitivity == case_sensitive_off
2547 && (tolower ((unsigned char) *string1)
2548 != tolower ((unsigned char) *string2)))
2550 if (*string1 != '\0')
2556 return (*string1 != '\0' && *string1 != '(') || (*string2 != '\0');
2559 /* This is like strcmp except that it ignores whitespace and treats
2560 '(' as the first non-NULL character in terms of ordering. Like
2561 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2562 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2563 according to that ordering.
2565 If a list is sorted according to this function and if you want to
2566 find names in the list that match some fixed NAME according to
2567 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2568 where this function would put NAME.
2570 This function must be neutral to the CASE_SENSITIVITY setting as the user
2571 may choose it during later lookup. Therefore this function always sorts
2572 primarily case-insensitively and secondarily case-sensitively.
2574 Here are some examples of why using strcmp to sort is a bad idea:
2578 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2579 we try to do a search for "foo<char*>", strcmp will locate this
2580 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2581 will start looking at strings beginning with "goo", and will never
2582 see the correct match of "foo<char *>".
2584 Parenthesis example:
2586 In practice, this is less like to be an issue, but I'll give it a
2587 shot. Let's assume that '$' is a legitimate character to occur in
2588 symbols. (Which may well even be the case on some systems.) Then
2589 say that the partial symbol table contains "foo$" and "foo(int)".
2590 strcmp will put them in this order, since '$' < '('. Now, if the
2591 user searches for "foo", then strcmp will sort "foo" before "foo$".
2592 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2593 "foo") is false, so it won't proceed to the actual match of
2594 "foo(int)" with "foo". */
2597 strcmp_iw_ordered (const char *string1, const char *string2)
2599 const char *saved_string1 = string1, *saved_string2 = string2;
2600 enum case_sensitivity case_pass = case_sensitive_off;
2604 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2605 Provide stub characters if we are already at the end of one of the
2607 char c1 = 'X', c2 = 'X';
2609 while (*string1 != '\0' && *string2 != '\0')
2611 while (isspace (*string1))
2613 while (isspace (*string2))
2618 case case_sensitive_off:
2619 c1 = tolower ((unsigned char) *string1);
2620 c2 = tolower ((unsigned char) *string2);
2622 case case_sensitive_on:
2630 if (*string1 != '\0')
2639 /* Characters are non-equal unless they're both '\0'; we want to
2640 make sure we get the comparison right according to our
2641 comparison in the cases where one of them is '\0' or '('. */
2643 if (*string2 == '\0')
2648 if (*string2 == '\0')
2653 if (*string2 == '\0' || *string2 == '(')
2662 if (case_pass == case_sensitive_on)
2665 /* Otherwise the strings were equal in case insensitive way, make
2666 a more fine grained comparison in a case sensitive way. */
2668 case_pass = case_sensitive_on;
2669 string1 = saved_string1;
2670 string2 = saved_string2;
2674 /* A simple comparison function with opposite semantics to strcmp. */
2677 streq (const char *lhs, const char *rhs)
2679 return !strcmp (lhs, rhs);
2685 ** Answer whether string_to_compare is a full or partial match to
2686 ** template_string. The partial match must be in sequence starting
2690 subset_compare (char *string_to_compare, char *template_string)
2694 if (template_string != (char *) NULL && string_to_compare != (char *) NULL
2695 && strlen (string_to_compare) <= strlen (template_string))
2698 (template_string, string_to_compare, strlen (string_to_compare)) == 0);
2705 pagination_on_command (char *arg, int from_tty)
2707 pagination_enabled = 1;
2711 pagination_off_command (char *arg, int from_tty)
2713 pagination_enabled = 0;
2717 show_debug_timestamp (struct ui_file *file, int from_tty,
2718 struct cmd_list_element *c, const char *value)
2720 fprintf_filtered (file, _("Timestamping debugging messages is %s.\n"),
2726 initialize_utils (void)
2728 add_setshow_uinteger_cmd ("width", class_support, &chars_per_line, _("\
2729 Set number of characters where GDB should wrap lines of its output."), _("\
2730 Show number of characters where GDB should wrap lines of its output."), _("\
2731 This affects where GDB wraps its output to fit the screen width.\n\
2732 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2734 show_chars_per_line,
2735 &setlist, &showlist);
2737 add_setshow_uinteger_cmd ("height", class_support, &lines_per_page, _("\
2738 Set number of lines in a page for GDB output pagination."), _("\
2739 Show number of lines in a page for GDB output pagination."), _("\
2740 This affects the number of lines after which GDB will pause\n\
2741 its output and ask you whether to continue.\n\
2742 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2744 show_lines_per_page,
2745 &setlist, &showlist);
2749 add_setshow_boolean_cmd ("pagination", class_support,
2750 &pagination_enabled, _("\
2751 Set state of GDB output pagination."), _("\
2752 Show state of GDB output pagination."), _("\
2753 When pagination is ON, GDB pauses at end of each screenful of\n\
2754 its output and asks you whether to continue.\n\
2755 Turning pagination off is an alternative to \"set height unlimited\"."),
2757 show_pagination_enabled,
2758 &setlist, &showlist);
2762 add_com ("am", class_support, pagination_on_command,
2763 _("Enable pagination"));
2764 add_com ("sm", class_support, pagination_off_command,
2765 _("Disable pagination"));
2768 add_setshow_boolean_cmd ("sevenbit-strings", class_support,
2769 &sevenbit_strings, _("\
2770 Set printing of 8-bit characters in strings as \\nnn."), _("\
2771 Show printing of 8-bit characters in strings as \\nnn."), NULL,
2773 show_sevenbit_strings,
2774 &setprintlist, &showprintlist);
2776 add_setshow_boolean_cmd ("timestamp", class_maintenance,
2777 &debug_timestamp, _("\
2778 Set timestamping of debugging messages."), _("\
2779 Show timestamping of debugging messages."), _("\
2780 When set, debugging messages will be marked with seconds and microseconds."),
2782 show_debug_timestamp,
2783 &setdebuglist, &showdebuglist);
2787 paddress (struct gdbarch *gdbarch, CORE_ADDR addr)
2789 /* Truncate address to the size of a target address, avoiding shifts
2790 larger or equal than the width of a CORE_ADDR. The local
2791 variable ADDR_BIT stops the compiler reporting a shift overflow
2792 when it won't occur. */
2793 /* NOTE: This assumes that the significant address information is
2794 kept in the least significant bits of ADDR - the upper bits were
2795 either zero or sign extended. Should gdbarch_address_to_pointer or
2796 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2798 int addr_bit = gdbarch_addr_bit (gdbarch);
2800 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2801 addr &= ((CORE_ADDR) 1 << addr_bit) - 1;
2802 return hex_string (addr);
2805 /* This function is described in "defs.h". */
2808 print_core_address (struct gdbarch *gdbarch, CORE_ADDR address)
2810 int addr_bit = gdbarch_addr_bit (gdbarch);
2812 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2813 address &= ((CORE_ADDR) 1 << addr_bit) - 1;
2815 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2816 that returns the language localized string formatted to a width
2817 based on gdbarch_addr_bit. */
2819 return hex_string_custom (address, 8);
2821 return hex_string_custom (address, 16);
2824 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2827 core_addr_hash (const void *ap)
2829 const CORE_ADDR *addrp = ap;
2834 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2837 core_addr_eq (const void *ap, const void *bp)
2839 const CORE_ADDR *addr_ap = ap;
2840 const CORE_ADDR *addr_bp = bp;
2842 return *addr_ap == *addr_bp;
2845 /* Convert a string back into a CORE_ADDR. */
2847 string_to_core_addr (const char *my_string)
2851 if (my_string[0] == '0' && tolower (my_string[1]) == 'x')
2853 /* Assume that it is in hex. */
2856 for (i = 2; my_string[i] != '\0'; i++)
2858 if (isdigit (my_string[i]))
2859 addr = (my_string[i] - '0') + (addr * 16);
2860 else if (isxdigit (my_string[i]))
2861 addr = (tolower (my_string[i]) - 'a' + 0xa) + (addr * 16);
2863 error (_("invalid hex \"%s\""), my_string);
2868 /* Assume that it is in decimal. */
2871 for (i = 0; my_string[i] != '\0'; i++)
2873 if (isdigit (my_string[i]))
2874 addr = (my_string[i] - '0') + (addr * 10);
2876 error (_("invalid decimal \"%s\""), my_string);
2884 gdb_realpath (const char *filename)
2886 /* Method 1: The system has a compile time upper bound on a filename
2887 path. Use that and realpath() to canonicalize the name. This is
2888 the most common case. Note that, if there isn't a compile time
2889 upper bound, you want to avoid realpath() at all costs. */
2890 #if defined (HAVE_REALPATH) && defined (PATH_MAX)
2893 const char *rp = realpath (filename, buf);
2897 return xstrdup (rp);
2899 #endif /* HAVE_REALPATH */
2901 /* Method 2: The host system (i.e., GNU) has the function
2902 canonicalize_file_name() which malloc's a chunk of memory and
2903 returns that, use that. */
2904 #if defined(HAVE_CANONICALIZE_FILE_NAME)
2906 char *rp = canonicalize_file_name (filename);
2909 return xstrdup (filename);
2915 /* FIXME: cagney/2002-11-13:
2917 Method 2a: Use realpath() with a NULL buffer. Some systems, due
2918 to the problems described in method 3, have modified their
2919 realpath() implementation so that it will allocate a buffer when
2920 NULL is passed in. Before this can be used, though, some sort of
2921 configure time test would need to be added. Otherwize the code
2922 will likely core dump. */
2924 /* Method 3: Now we're getting desperate! The system doesn't have a
2925 compile time buffer size and no alternative function. Query the
2926 OS, using pathconf(), for the buffer limit. Care is needed
2927 though, some systems do not limit PATH_MAX (return -1 for
2928 pathconf()) making it impossible to pass a correctly sized buffer
2929 to realpath() (it could always overflow). On those systems, we
2931 #if defined (HAVE_REALPATH) && defined (_PC_PATH_MAX) && defined(HAVE_ALLOCA)
2933 /* Find out the max path size. */
2934 long path_max = pathconf ("/", _PC_PATH_MAX);
2938 /* PATH_MAX is bounded. */
2939 char *buf = alloca (path_max);
2940 char *rp = realpath (filename, buf);
2942 return xstrdup (rp ? rp : filename);
2947 /* The MS Windows method. If we don't have realpath, we assume we
2948 don't have symlinks and just canonicalize to a Windows absolute
2949 path. GetFullPath converts ../ and ./ in relative paths to
2950 absolute paths, filling in current drive if one is not given
2951 or using the current directory of a specified drive (eg, "E:foo").
2952 It also converts all forward slashes to back slashes. */
2953 /* The file system is case-insensitive but case-preserving.
2954 So we do not lowercase the path. Otherwise, we might not
2955 be able to display the original casing in a given path. */
2956 #if defined (_WIN32)
2959 DWORD len = GetFullPathName (filename, MAX_PATH, buf, NULL);
2961 if (len > 0 && len < MAX_PATH)
2962 return xstrdup (buf);
2966 /* This system is a lost cause, just dup the buffer. */
2967 return xstrdup (filename);
2970 /* Return a copy of FILENAME, with its directory prefix canonicalized
2974 gdb_realpath_keepfile (const char *filename)
2976 const char *base_name = lbasename (filename);
2981 /* Extract the basename of filename, and return immediately
2982 a copy of filename if it does not contain any directory prefix. */
2983 if (base_name == filename)
2984 return xstrdup (filename);
2986 dir_name = alloca ((size_t) (base_name - filename + 2));
2987 /* Allocate enough space to store the dir_name + plus one extra
2988 character sometimes needed under Windows (see below), and
2989 then the closing \000 character. */
2990 strncpy (dir_name, filename, base_name - filename);
2991 dir_name[base_name - filename] = '\000';
2993 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
2994 /* We need to be careful when filename is of the form 'd:foo', which
2995 is equivalent of d:./foo, which is totally different from d:/foo. */
2996 if (strlen (dir_name) == 2 && isalpha (dir_name[0]) && dir_name[1] == ':')
2999 dir_name[3] = '\000';
3003 /* Canonicalize the directory prefix, and build the resulting
3004 filename. If the dirname realpath already contains an ending
3005 directory separator, avoid doubling it. */
3006 real_path = gdb_realpath (dir_name);
3007 if (IS_DIR_SEPARATOR (real_path[strlen (real_path) - 1]))
3008 result = concat (real_path, base_name, (char *) NULL);
3010 result = concat (real_path, SLASH_STRING, base_name, (char *) NULL);
3016 /* Return PATH in absolute form, performing tilde-expansion if necessary.
3017 PATH cannot be NULL or the empty string.
3018 This does not resolve symlinks however, use gdb_realpath for that.
3019 Space for the result is allocated with malloc.
3020 If the path is already absolute, it is strdup'd.
3021 If there is a problem computing the absolute path, the path is returned
3022 unchanged (still strdup'd). */
3025 gdb_abspath (const char *path)
3027 gdb_assert (path != NULL && path[0] != '\0');
3030 return tilde_expand (path);
3032 if (IS_ABSOLUTE_PATH (path))
3033 return xstrdup (path);
3035 /* Beware the // my son, the Emacs barfs, the botch that catch... */
3036 return concat (current_directory,
3037 IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1])
3038 ? "" : SLASH_STRING,
3039 path, (char *) NULL);
3043 align_up (ULONGEST v, int n)
3045 /* Check that N is really a power of two. */
3046 gdb_assert (n && (n & (n-1)) == 0);
3047 return (v + n - 1) & -n;
3051 align_down (ULONGEST v, int n)
3053 /* Check that N is really a power of two. */
3054 gdb_assert (n && (n & (n-1)) == 0);
3061 gdb_sign_extend (LONGEST value, int bit)
3063 gdb_assert (bit >= 1 && bit <= 8 * sizeof (LONGEST));
3065 if (((value >> (bit - 1)) & 1) != 0)
3067 LONGEST signbit = ((LONGEST) 1) << (bit - 1);
3069 value = (value ^ signbit) - signbit;
3075 /* Allocation function for the libiberty hash table which uses an
3076 obstack. The obstack is passed as DATA. */
3079 hashtab_obstack_allocate (void *data, size_t size, size_t count)
3081 size_t total = size * count;
3082 void *ptr = obstack_alloc ((struct obstack *) data, total);
3084 memset (ptr, 0, total);
3088 /* Trivial deallocation function for the libiberty splay tree and hash
3089 table - don't deallocate anything. Rely on later deletion of the
3090 obstack. DATA will be the obstack, although it is not needed
3094 dummy_obstack_deallocate (void *object, void *data)
3099 /* The bit offset of the highest byte in a ULONGEST, for overflow
3102 #define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT)
3104 /* True (non-zero) iff DIGIT is a valid digit in radix BASE,
3105 where 2 <= BASE <= 36. */
3108 is_digit_in_base (unsigned char digit, int base)
3110 if (!isalnum (digit))
3113 return (isdigit (digit) && digit < base + '0');
3115 return (isdigit (digit) || tolower (digit) < base - 10 + 'a');
3119 digit_to_int (unsigned char c)
3124 return tolower (c) - 'a' + 10;
3127 /* As for strtoul, but for ULONGEST results. */
3130 strtoulst (const char *num, const char **trailer, int base)
3132 unsigned int high_part;
3137 /* Skip leading whitespace. */
3138 while (isspace (num[i]))
3141 /* Handle prefixes. */
3144 else if (num[i] == '-')
3150 if (base == 0 || base == 16)
3152 if (num[i] == '0' && (num[i + 1] == 'x' || num[i + 1] == 'X'))
3160 if (base == 0 && num[i] == '0')
3166 if (base < 2 || base > 36)
3172 result = high_part = 0;
3173 for (; is_digit_in_base (num[i], base); i += 1)
3175 result = result * base + digit_to_int (num[i]);
3176 high_part = high_part * base + (unsigned int) (result >> HIGH_BYTE_POSN);
3177 result &= ((ULONGEST) 1 << HIGH_BYTE_POSN) - 1;
3178 if (high_part > 0xff)
3181 result = ~ (ULONGEST) 0;
3188 if (trailer != NULL)
3191 result = result + ((ULONGEST) high_part << HIGH_BYTE_POSN);
3198 /* Simple, portable version of dirname that does not modify its
3202 ldirname (const char *filename)
3204 const char *base = lbasename (filename);
3207 while (base > filename && IS_DIR_SEPARATOR (base[-1]))
3210 if (base == filename)
3213 dirname = xmalloc (base - filename + 2);
3214 memcpy (dirname, filename, base - filename);
3216 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3217 create "d:./bar" later instead of the (different) "d:/bar". */
3218 if (base - filename == 2 && IS_ABSOLUTE_PATH (base)
3219 && !IS_DIR_SEPARATOR (filename[0]))
3220 dirname[base++ - filename] = '.';
3222 dirname[base - filename] = '\0';
3226 /* Call libiberty's buildargv, and return the result.
3227 If buildargv fails due to out-of-memory, call nomem.
3228 Therefore, the returned value is guaranteed to be non-NULL,
3229 unless the parameter itself is NULL. */
3232 gdb_buildargv (const char *s)
3234 char **argv = buildargv (s);
3236 if (s != NULL && argv == NULL)
3242 compare_positive_ints (const void *ap, const void *bp)
3244 /* Because we know we're comparing two ints which are positive,
3245 there's no danger of overflow here. */
3246 return * (int *) ap - * (int *) bp;
3249 /* String compare function for qsort. */
3252 compare_strings (const void *arg1, const void *arg2)
3254 const char **s1 = (const char **) arg1;
3255 const char **s2 = (const char **) arg2;
3257 return strcmp (*s1, *s2);
3260 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3261 #define AMBIGUOUS_MESS2 \
3262 ".\nUse \"set gnutarget format-name\" to specify the format."
3265 gdb_bfd_errmsg (bfd_error_type error_tag, char **matching)
3271 /* Check if errmsg just need simple return. */
3272 if (error_tag != bfd_error_file_ambiguously_recognized || matching == NULL)
3273 return bfd_errmsg (error_tag);
3275 ret_len = strlen (bfd_errmsg (error_tag)) + strlen (AMBIGUOUS_MESS1)
3276 + strlen (AMBIGUOUS_MESS2);
3277 for (p = matching; *p; p++)
3278 ret_len += strlen (*p) + 1;
3279 ret = xmalloc (ret_len + 1);
3281 make_cleanup (xfree, ret);
3283 strcpy (retp, bfd_errmsg (error_tag));
3284 retp += strlen (retp);
3286 strcpy (retp, AMBIGUOUS_MESS1);
3287 retp += strlen (retp);
3289 for (p = matching; *p; p++)
3291 sprintf (retp, " %s", *p);
3292 retp += strlen (retp);
3296 strcpy (retp, AMBIGUOUS_MESS2);
3301 /* Return ARGS parsed as a valid pid, or throw an error. */
3304 parse_pid_to_attach (const char *args)
3310 error_no_arg (_("process-id to attach"));
3312 dummy = (char *) args;
3313 pid = strtoul (args, &dummy, 0);
3314 /* Some targets don't set errno on errors, grrr! */
3315 if ((pid == 0 && dummy == args) || dummy != &args[strlen (args)])
3316 error (_("Illegal process-id: %s."), args);
3321 /* Helper for make_bpstat_clear_actions_cleanup. */
3324 do_bpstat_clear_actions_cleanup (void *unused)
3326 bpstat_clear_actions ();
3329 /* Call bpstat_clear_actions for the case an exception is throw. You should
3330 discard_cleanups if no exception is caught. */
3333 make_bpstat_clear_actions_cleanup (void)
3335 return make_cleanup (do_bpstat_clear_actions_cleanup, NULL);
3338 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3339 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3340 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3343 producer_is_gcc_ge_4 (const char *producer)
3348 if (producer == NULL)
3350 /* For unknown compilers expect their behavior is not compliant. For GCC
3351 this case can also happen for -gdwarf-4 type units supported since
3357 /* Skip any identifier after "GNU " - such as "C++" or "Java". */
3359 if (strncmp (producer, "GNU ", strlen ("GNU ")) != 0)
3361 /* For non-GCC compilers expect their behavior is not compliant. */
3365 cs = &producer[strlen ("GNU ")];
3366 while (*cs && !isdigit (*cs))
3368 if (sscanf (cs, "%d.%d", &major, &minor) != 2)
3370 /* Not recognized as GCC. */
3382 /* Helper for make_cleanup_free_char_ptr_vec. */
3385 do_free_char_ptr_vec (void *arg)
3387 VEC (char_ptr) *char_ptr_vec = arg;
3389 free_char_ptr_vec (char_ptr_vec);
3392 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3393 final VEC_free for CHAR_PTR_VEC itself.
3395 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3396 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3397 this function does not (cannot) clear the pointer. */
3400 make_cleanup_free_char_ptr_vec (VEC (char_ptr) *char_ptr_vec)
3402 return make_cleanup (do_free_char_ptr_vec, char_ptr_vec);
3405 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3406 must come from xrealloc-compatible allocator and it may be updated. FROM
3407 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3408 located at the start or end of *STRINGP. */
3411 substitute_path_component (char **stringp, const char *from, const char *to)
3413 char *string = *stringp, *s;
3414 const size_t from_len = strlen (from);
3415 const size_t to_len = strlen (to);
3419 s = strstr (s, from);
3423 if ((s == string || IS_DIR_SEPARATOR (s[-1])
3424 || s[-1] == DIRNAME_SEPARATOR)
3425 && (s[from_len] == '\0' || IS_DIR_SEPARATOR (s[from_len])
3426 || s[from_len] == DIRNAME_SEPARATOR))
3430 string_new = xrealloc (string, (strlen (string) + to_len + 1));
3432 /* Relocate the current S pointer. */
3433 s = s - string + string_new;
3434 string = string_new;
3436 /* Replace from by to. */
3437 memmove (&s[to_len], &s[from_len], strlen (&s[from_len]) + 1);
3438 memcpy (s, to, to_len);
3453 /* SIGALRM handler for waitpid_with_timeout. */
3456 sigalrm_handler (int signo)
3458 /* Nothing to do. */
3463 /* Wrapper to wait for child PID to die with TIMEOUT.
3464 TIMEOUT is the time to stop waiting in seconds.
3465 If TIMEOUT is zero, pass WNOHANG to waitpid.
3466 Returns PID if it was successfully waited for, otherwise -1.
3468 Timeouts are currently implemented with alarm and SIGALRM.
3469 If the host does not support them, this waits "forever".
3470 It would be odd though for a host to have waitpid and not SIGALRM. */
3473 wait_to_die_with_timeout (pid_t pid, int *status, int timeout)
3475 pid_t waitpid_result;
3477 gdb_assert (pid > 0);
3478 gdb_assert (timeout >= 0);
3483 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3484 struct sigaction sa, old_sa;
3486 sa.sa_handler = sigalrm_handler;
3487 sigemptyset (&sa.sa_mask);
3489 sigaction (SIGALRM, &sa, &old_sa);
3493 ofunc = (void (*)()) signal (SIGALRM, sigalrm_handler);
3499 waitpid_result = waitpid (pid, status, 0);
3503 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3504 sigaction (SIGALRM, &old_sa, NULL);
3506 signal (SIGALRM, ofunc);
3511 waitpid_result = waitpid (pid, status, WNOHANG);
3513 if (waitpid_result == pid)
3519 #endif /* HAVE_WAITPID */
3521 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3522 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3524 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3525 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3528 gdb_filename_fnmatch (const char *pattern, const char *string, int flags)
3530 gdb_assert ((flags & FNM_FILE_NAME) != 0);
3532 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3533 gdb_assert ((flags & FNM_NOESCAPE) != 0);
3535 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3537 char *pattern_slash, *string_slash;
3539 /* Replace '\' by '/' in both strings. */
3541 pattern_slash = alloca (strlen (pattern) + 1);
3542 strcpy (pattern_slash, pattern);
3543 pattern = pattern_slash;
3544 for (; *pattern_slash != 0; pattern_slash++)
3545 if (IS_DIR_SEPARATOR (*pattern_slash))
3546 *pattern_slash = '/';
3548 string_slash = alloca (strlen (string) + 1);
3549 strcpy (string_slash, string);
3550 string = string_slash;
3551 for (; *string_slash != 0; string_slash++)
3552 if (IS_DIR_SEPARATOR (*string_slash))
3553 *string_slash = '/';
3555 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3557 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3558 flags |= FNM_CASEFOLD;
3559 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3561 return fnmatch (pattern, string, flags);
3564 /* Provide a prototype to silence -Wmissing-prototypes. */
3565 extern initialize_file_ftype _initialize_utils;
3568 _initialize_utils (void)
3570 add_internal_problem_command (&internal_error_problem);
3571 add_internal_problem_command (&internal_warning_problem);
3572 add_internal_problem_command (&demangler_warning_problem);