1 /* General utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
4 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
5 2009, 2010, 2011 Free Software Foundation, Inc.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
23 #include "dyn-string.h"
24 #include "gdb_assert.h"
26 #include "gdb_string.h"
27 #include "event-top.h"
28 #include "exceptions.h"
29 #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. */
42 /* SunOS's curses.h has a '#define reg register' in it. Thank you Sun. */
53 #include "expression.h"
57 #include "filenames.h"
59 #include "gdb_obstack.h"
64 #include "inferior.h" /* for signed_pointer_to_address */
66 #include <sys/param.h> /* For MAXPATHLEN */
68 #include "gdb_curses.h"
70 #include "readline/readline.h"
75 #include "gdb_usleep.h"
77 #include "gdb_regex.h"
80 extern PTR malloc (); /* ARI: PTR */
82 #if !HAVE_DECL_REALLOC
83 extern PTR realloc (); /* ARI: PTR */
89 /* readline defines this. */
92 void (*deprecated_error_begin_hook) (void);
94 /* Prototypes for local functions */
96 static void vfprintf_maybe_filtered (struct ui_file *, const char *,
97 va_list, int) ATTRIBUTE_PRINTF (2, 0);
99 static void fputs_maybe_filtered (const char *, struct ui_file *, int);
101 static void do_my_cleanups (struct cleanup **, struct cleanup *);
103 static void prompt_for_continue (void);
105 static void set_screen_size (void);
106 static void set_width (void);
108 /* A flag indicating whether to timestamp debugging messages. */
110 static int debug_timestamp = 0;
112 /* Chain of cleanup actions established with make_cleanup,
113 to be executed if an error happens. */
115 static struct cleanup *cleanup_chain; /* cleaned up after a failed command */
116 static struct cleanup *final_cleanup_chain; /* cleaned up when gdb exits */
118 /* Nonzero if we have job control. */
122 /* Nonzero means a quit has been requested. */
126 /* Nonzero means quit immediately if Control-C is typed now, rather
127 than waiting until QUIT is executed. Be careful in setting this;
128 code which executes with immediate_quit set has to be very careful
129 about being able to deal with being interrupted at any time. It is
130 almost always better to use QUIT; the only exception I can think of
131 is being able to quit out of a system call (using EINTR loses if
132 the SIGINT happens between the previous QUIT and the system call).
133 To immediately quit in the case in which a SIGINT happens between
134 the previous QUIT and setting immediate_quit (desirable anytime we
135 expect to block), call QUIT after setting immediate_quit. */
139 /* Nonzero means that encoded C++/ObjC names should be printed out in their
140 C++/ObjC form rather than raw. */
144 show_demangle (struct ui_file *file, int from_tty,
145 struct cmd_list_element *c, const char *value)
147 fprintf_filtered (file,
148 _("Demangling of encoded C++/ObjC names "
149 "when displaying symbols is %s.\n"),
153 /* Nonzero means that encoded C++/ObjC names should be printed out in their
154 C++/ObjC form even in assembler language displays. If this is set, but
155 DEMANGLE is zero, names are printed raw, i.e. DEMANGLE controls. */
157 int asm_demangle = 0;
159 show_asm_demangle (struct ui_file *file, int from_tty,
160 struct cmd_list_element *c, const char *value)
162 fprintf_filtered (file,
163 _("Demangling of C++/ObjC names in "
164 "disassembly listings is %s.\n"),
168 /* Nonzero means that strings with character values >0x7F should be printed
169 as octal escapes. Zero means just print the value (e.g. it's an
170 international character, and the terminal or window can cope.) */
172 int sevenbit_strings = 0;
174 show_sevenbit_strings (struct ui_file *file, int from_tty,
175 struct cmd_list_element *c, const char *value)
177 fprintf_filtered (file, _("Printing of 8-bit characters "
178 "in strings as \\nnn is %s.\n"),
182 /* String to be printed before error messages, if any. */
184 char *error_pre_print;
186 /* String to be printed before quit messages, if any. */
188 char *quit_pre_print;
190 /* String to be printed before warning messages, if any. */
192 char *warning_pre_print = "\nwarning: ";
194 int pagination_enabled = 1;
196 show_pagination_enabled (struct ui_file *file, int from_tty,
197 struct cmd_list_element *c, const char *value)
199 fprintf_filtered (file, _("State of pagination is %s.\n"), value);
204 /* Add a new cleanup to the cleanup_chain,
205 and return the previous chain pointer
206 to be passed later to do_cleanups or discard_cleanups.
207 Args are FUNCTION to clean up with, and ARG to pass to it. */
210 make_cleanup (make_cleanup_ftype *function, void *arg)
212 return make_my_cleanup (&cleanup_chain, function, arg);
216 make_cleanup_dtor (make_cleanup_ftype *function, void *arg,
217 void (*dtor) (void *))
219 return make_my_cleanup2 (&cleanup_chain,
220 function, arg, dtor);
224 make_final_cleanup (make_cleanup_ftype *function, void *arg)
226 return make_my_cleanup (&final_cleanup_chain, function, arg);
230 do_freeargv (void *arg)
232 freeargv ((char **) arg);
236 make_cleanup_freeargv (char **arg)
238 return make_my_cleanup (&cleanup_chain, do_freeargv, arg);
242 do_dyn_string_delete (void *arg)
244 dyn_string_delete ((dyn_string_t) arg);
248 make_cleanup_dyn_string_delete (dyn_string_t arg)
250 return make_my_cleanup (&cleanup_chain, do_dyn_string_delete, arg);
254 do_bfd_close_cleanup (void *arg)
260 make_cleanup_bfd_close (bfd *abfd)
262 return make_cleanup (do_bfd_close_cleanup, abfd);
266 do_close_cleanup (void *arg)
274 make_cleanup_close (int fd)
276 int *saved_fd = xmalloc (sizeof (fd));
279 return make_cleanup_dtor (do_close_cleanup, saved_fd, xfree);
282 /* Helper function which does the work for make_cleanup_fclose. */
285 do_fclose_cleanup (void *arg)
292 /* Return a new cleanup that closes FILE. */
295 make_cleanup_fclose (FILE *file)
297 return make_cleanup (do_fclose_cleanup, file);
300 /* Helper function which does the work for make_cleanup_obstack_free. */
303 do_obstack_free (void *arg)
305 struct obstack *ob = arg;
307 obstack_free (ob, NULL);
310 /* Return a new cleanup that frees OBSTACK. */
313 make_cleanup_obstack_free (struct obstack *obstack)
315 return make_cleanup (do_obstack_free, obstack);
319 do_ui_file_delete (void *arg)
321 ui_file_delete (arg);
325 make_cleanup_ui_file_delete (struct ui_file *arg)
327 return make_my_cleanup (&cleanup_chain, do_ui_file_delete, arg);
330 /* Helper function for make_cleanup_ui_out_redirect_pop. */
333 do_ui_out_redirect_pop (void *arg)
335 struct ui_out *uiout = arg;
337 if (ui_out_redirect (uiout, NULL) < 0)
338 warning (_("Cannot restore redirection of the current output protocol"));
341 /* Return a new cleanup that pops the last redirection by ui_out_redirect
342 with NULL parameter. */
345 make_cleanup_ui_out_redirect_pop (struct ui_out *uiout)
347 return make_my_cleanup (&cleanup_chain, do_ui_out_redirect_pop, uiout);
351 do_free_section_addr_info (void *arg)
353 free_section_addr_info (arg);
357 make_cleanup_free_section_addr_info (struct section_addr_info *addrs)
359 return make_my_cleanup (&cleanup_chain, do_free_section_addr_info, addrs);
362 struct restore_integer_closure
369 restore_integer (void *p)
371 struct restore_integer_closure *closure = p;
373 *(closure->variable) = closure->value;
376 /* Remember the current value of *VARIABLE and make it restored when
377 the cleanup is run. */
380 make_cleanup_restore_integer (int *variable)
382 struct restore_integer_closure *c =
383 xmalloc (sizeof (struct restore_integer_closure));
385 c->variable = variable;
386 c->value = *variable;
388 return make_my_cleanup2 (&cleanup_chain, restore_integer, (void *)c,
392 /* Remember the current value of *VARIABLE and make it restored when
393 the cleanup is run. */
396 make_cleanup_restore_uinteger (unsigned int *variable)
398 return make_cleanup_restore_integer ((int *) variable);
401 /* Helper for make_cleanup_unpush_target. */
404 do_unpush_target (void *arg)
406 struct target_ops *ops = arg;
411 /* Return a new cleanup that unpushes OPS. */
414 make_cleanup_unpush_target (struct target_ops *ops)
416 return make_my_cleanup (&cleanup_chain, do_unpush_target, ops);
419 /* Helper for make_cleanup_htab_delete compile time checking the types. */
422 do_htab_delete_cleanup (void *htab_voidp)
424 htab_t htab = htab_voidp;
429 /* Return a new cleanup that deletes HTAB. */
432 make_cleanup_htab_delete (htab_t htab)
434 return make_cleanup (do_htab_delete_cleanup, htab);
437 struct restore_ui_file_closure
439 struct ui_file **variable;
440 struct ui_file *value;
444 do_restore_ui_file (void *p)
446 struct restore_ui_file_closure *closure = p;
448 *(closure->variable) = closure->value;
451 /* Remember the current value of *VARIABLE and make it restored when
452 the cleanup is run. */
455 make_cleanup_restore_ui_file (struct ui_file **variable)
457 struct restore_ui_file_closure *c = XNEW (struct restore_ui_file_closure);
459 c->variable = variable;
460 c->value = *variable;
462 return make_cleanup_dtor (do_restore_ui_file, (void *) c, xfree);
465 /* Helper for make_cleanup_value_free_to_mark. */
468 do_value_free_to_mark (void *value)
470 value_free_to_mark ((struct value *) value);
473 /* Free all values allocated since MARK was obtained by value_mark
474 (except for those released) when the cleanup is run. */
477 make_cleanup_value_free_to_mark (struct value *mark)
479 return make_my_cleanup (&cleanup_chain, do_value_free_to_mark, mark);
482 /* Helper for make_cleanup_value_free. */
485 do_value_free (void *value)
493 make_cleanup_value_free (struct value *value)
495 return make_my_cleanup (&cleanup_chain, do_value_free, value);
499 make_my_cleanup2 (struct cleanup **pmy_chain, make_cleanup_ftype *function,
500 void *arg, void (*free_arg) (void *))
503 = (struct cleanup *) xmalloc (sizeof (struct cleanup));
504 struct cleanup *old_chain = *pmy_chain;
506 new->next = *pmy_chain;
507 new->function = function;
508 new->free_arg = free_arg;
516 make_my_cleanup (struct cleanup **pmy_chain, make_cleanup_ftype *function,
519 return make_my_cleanup2 (pmy_chain, function, arg, NULL);
522 /* Discard cleanups and do the actions they describe
523 until we get back to the point OLD_CHAIN in the cleanup_chain. */
526 do_cleanups (struct cleanup *old_chain)
528 do_my_cleanups (&cleanup_chain, old_chain);
532 do_final_cleanups (struct cleanup *old_chain)
534 do_my_cleanups (&final_cleanup_chain, old_chain);
538 do_my_cleanups (struct cleanup **pmy_chain,
539 struct cleanup *old_chain)
543 while ((ptr = *pmy_chain) != old_chain)
545 *pmy_chain = ptr->next; /* Do this first in case of recursion. */
546 (*ptr->function) (ptr->arg);
548 (*ptr->free_arg) (ptr->arg);
553 /* Discard cleanups, not doing the actions they describe,
554 until we get back to the point OLD_CHAIN in the cleanup_chain. */
557 discard_cleanups (struct cleanup *old_chain)
559 discard_my_cleanups (&cleanup_chain, old_chain);
563 discard_final_cleanups (struct cleanup *old_chain)
565 discard_my_cleanups (&final_cleanup_chain, old_chain);
569 discard_my_cleanups (struct cleanup **pmy_chain,
570 struct cleanup *old_chain)
574 while ((ptr = *pmy_chain) != old_chain)
576 *pmy_chain = ptr->next;
578 (*ptr->free_arg) (ptr->arg);
583 /* Set the cleanup_chain to 0, and return the old cleanup chain. */
587 return save_my_cleanups (&cleanup_chain);
591 save_final_cleanups (void)
593 return save_my_cleanups (&final_cleanup_chain);
597 save_my_cleanups (struct cleanup **pmy_chain)
599 struct cleanup *old_chain = *pmy_chain;
605 /* Restore the cleanup chain from a previously saved chain. */
607 restore_cleanups (struct cleanup *chain)
609 restore_my_cleanups (&cleanup_chain, chain);
613 restore_final_cleanups (struct cleanup *chain)
615 restore_my_cleanups (&final_cleanup_chain, chain);
619 restore_my_cleanups (struct cleanup **pmy_chain, struct cleanup *chain)
624 /* This function is useful for cleanups.
628 old_chain = make_cleanup (free_current_contents, &foo);
630 to arrange to free the object thus allocated. */
633 free_current_contents (void *ptr)
635 void **location = ptr;
637 if (location == NULL)
638 internal_error (__FILE__, __LINE__,
639 _("free_current_contents: NULL pointer"));
640 if (*location != NULL)
647 /* Provide a known function that does nothing, to use as a base for
648 a possibly long chain of cleanups. This is useful where we
649 use the cleanup chain for handling normal cleanups as well as dealing
650 with cleanups that need to be done as a result of a call to error().
651 In such cases, we may not be certain where the first cleanup is, unless
652 we have a do-nothing one to always use as the base. */
655 null_cleanup (void *arg)
659 /* If nonzero, display time usage both at startup and for each command. */
661 static int display_time;
663 /* If nonzero, display space usage both at startup and for each command. */
665 static int display_space;
667 /* Records a run time and space usage to be used as a base for
668 reporting elapsed time or change in space. In addition,
669 the msg_type field indicates whether the saved time is from the
670 beginning of GDB execution (0) or the beginning of an individual
671 command execution (1). */
679 /* Set whether to display time statistics to NEW_VALUE (non-zero
682 set_display_time (int new_value)
684 display_time = new_value;
687 /* Set whether to display space statistics to NEW_VALUE (non-zero
690 set_display_space (int new_value)
692 display_space = new_value;
695 /* As indicated by display_time and display_space, report GDB's elapsed time
696 and space usage from the base time and space provided in ARG, which
697 must be a pointer to a struct cmd_stat. This function is intended
698 to be called as a cleanup. */
700 report_command_stats (void *arg)
702 struct cmd_stats *start_stats = (struct cmd_stats *) arg;
703 int msg_type = start_stats->msg_type;
707 long cmd_time = get_run_time () - start_stats->start_time;
709 printf_unfiltered (msg_type == 0
710 ? _("Startup time: %ld.%06ld\n")
711 : _("Command execution time: %ld.%06ld\n"),
712 cmd_time / 1000000, cmd_time % 1000000);
718 char *lim = (char *) sbrk (0);
720 long space_now = lim - lim_at_start;
721 long space_diff = space_now - start_stats->start_space;
723 printf_unfiltered (msg_type == 0
724 ? _("Space used: %ld (%s%ld during startup)\n")
725 : _("Space used: %ld (%s%ld for this command)\n"),
727 (space_diff >= 0 ? "+" : ""),
733 /* Create a cleanup that reports time and space used since its
734 creation. Precise messages depend on MSG_TYPE:
735 0: Initial time/space
736 1: Individual command time/space. */
738 make_command_stats_cleanup (int msg_type)
740 struct cmd_stats *new_stat = XMALLOC (struct cmd_stats);
743 char *lim = (char *) sbrk (0);
744 new_stat->start_space = lim - lim_at_start;
747 new_stat->msg_type = msg_type;
748 new_stat->start_time = get_run_time ();
750 return make_cleanup_dtor (report_command_stats, new_stat, xfree);
755 /* Print a warning message. The first argument STRING is the warning
756 message, used as an fprintf format string, the second is the
757 va_list of arguments for that string. A warning is unfiltered (not
758 paginated) so that the user does not need to page through each
759 screen full of warnings when there are lots of them. */
762 vwarning (const char *string, va_list args)
764 if (deprecated_warning_hook)
765 (*deprecated_warning_hook) (string, args);
768 target_terminal_ours ();
769 wrap_here (""); /* Force out any buffered output. */
770 gdb_flush (gdb_stdout);
771 if (warning_pre_print)
772 fputs_unfiltered (warning_pre_print, gdb_stderr);
773 vfprintf_unfiltered (gdb_stderr, string, args);
774 fprintf_unfiltered (gdb_stderr, "\n");
779 /* Print a warning message.
780 The first argument STRING is the warning message, used as a fprintf string,
781 and the remaining args are passed as arguments to it.
782 The primary difference between warnings and errors is that a warning
783 does not force the return to command level. */
786 warning (const char *string, ...)
790 va_start (args, string);
791 vwarning (string, args);
795 /* Print an error message and return to command level.
796 The first argument STRING is the error message, used as a fprintf string,
797 and the remaining args are passed as arguments to it. */
800 verror (const char *string, va_list args)
802 throw_verror (GENERIC_ERROR, string, args);
806 error (const char *string, ...)
810 va_start (args, string);
811 throw_verror (GENERIC_ERROR, string, args);
815 /* Print an error message and quit.
816 The first argument STRING is the error message, used as a fprintf string,
817 and the remaining args are passed as arguments to it. */
820 vfatal (const char *string, va_list args)
822 throw_vfatal (string, args);
826 fatal (const char *string, ...)
830 va_start (args, string);
831 throw_vfatal (string, args);
836 error_stream (struct ui_file *stream)
838 char *message = ui_file_xstrdup (stream, NULL);
840 make_cleanup (xfree, message);
841 error (("%s"), message);
844 /* Dump core trying to increase the core soft limit to hard limit first. */
849 #ifdef HAVE_SETRLIMIT
850 struct rlimit rlim = { RLIM_INFINITY, RLIM_INFINITY };
852 setrlimit (RLIMIT_CORE, &rlim);
853 #endif /* HAVE_SETRLIMIT */
855 abort (); /* NOTE: GDB has only three calls to abort(). */
858 /* Check whether GDB will be able to dump core using the dump_core
862 can_dump_core (const char *reason)
864 #ifdef HAVE_GETRLIMIT
867 /* Be quiet and assume we can dump if an error is returned. */
868 if (getrlimit (RLIMIT_CORE, &rlim) != 0)
871 if (rlim.rlim_max == 0)
873 fprintf_unfiltered (gdb_stderr,
874 _("%s\nUnable to dump core, use `ulimit -c"
875 " unlimited' before executing GDB next time.\n"),
879 #endif /* HAVE_GETRLIMIT */
884 /* Allow the user to configure the debugger behavior with respect to
885 what to do when an internal problem is detected. */
887 const char internal_problem_ask[] = "ask";
888 const char internal_problem_yes[] = "yes";
889 const char internal_problem_no[] = "no";
890 static const char *internal_problem_modes[] =
892 internal_problem_ask,
893 internal_problem_yes,
898 /* Print a message reporting an internal error/warning. Ask the user
899 if they want to continue, dump core, or just exit. Return
900 something to indicate a quit. */
902 struct internal_problem
905 const char *should_quit;
906 const char *should_dump_core;
909 /* Report a problem, internal to GDB, to the user. Once the problem
910 has been reported, and assuming GDB didn't quit, the caller can
911 either allow execution to resume or throw an error. */
913 static void ATTRIBUTE_PRINTF (4, 0)
914 internal_vproblem (struct internal_problem *problem,
915 const char *file, int line, const char *fmt, va_list ap)
922 /* Don't allow infinite error/warning recursion. */
924 static char msg[] = "Recursive internal problem.\n";
933 fputs_unfiltered (msg, gdb_stderr);
934 abort (); /* NOTE: GDB has only three calls to abort(). */
937 /* Newer GLIBC versions put the warn_unused_result attribute
938 on write, but this is one of those rare cases where
939 ignoring the return value is correct. Casting to (void)
940 does not fix this problem. This is the solution suggested
941 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
942 if (write (STDERR_FILENO, msg, sizeof (msg)) != sizeof (msg))
943 abort (); /* NOTE: GDB has only three calls to abort(). */
948 /* Try to get the message out and at the start of a new line. */
949 target_terminal_ours ();
952 /* Create a string containing the full error/warning message. Need
953 to call query with this full string, as otherwize the reason
954 (error/warning) and question become separated. Format using a
955 style similar to a compiler error message. Include extra detail
956 so that the user knows that they are living on the edge. */
960 msg = xstrvprintf (fmt, ap);
961 reason = xstrprintf ("%s:%d: %s: %s\n"
962 "A problem internal to GDB has been detected,\n"
963 "further debugging may prove unreliable.",
964 file, line, problem->name, msg);
966 make_cleanup (xfree, reason);
969 if (problem->should_quit == internal_problem_ask)
971 /* Default (yes/batch case) is to quit GDB. When in batch mode
972 this lessens the likelihood of GDB going into an infinite
976 /* Emit the message and quit. */
977 fputs_unfiltered (reason, gdb_stderr);
978 fputs_unfiltered ("\n", gdb_stderr);
982 quit_p = query (_("%s\nQuit this debugging session? "), reason);
984 else if (problem->should_quit == internal_problem_yes)
986 else if (problem->should_quit == internal_problem_no)
989 internal_error (__FILE__, __LINE__, _("bad switch"));
991 if (problem->should_dump_core == internal_problem_ask)
993 if (!can_dump_core (reason))
997 /* Default (yes/batch case) is to dump core. This leaves a GDB
998 `dropping' so that it is easier to see that something went
1000 dump_core_p = query (_("%s\nCreate a core file of GDB? "), reason);
1003 else if (problem->should_dump_core == internal_problem_yes)
1004 dump_core_p = can_dump_core (reason);
1005 else if (problem->should_dump_core == internal_problem_no)
1008 internal_error (__FILE__, __LINE__, _("bad switch"));
1021 #ifdef HAVE_WORKING_FORK
1031 static struct internal_problem internal_error_problem = {
1032 "internal-error", internal_problem_ask, internal_problem_ask
1036 internal_verror (const char *file, int line, const char *fmt, va_list ap)
1038 internal_vproblem (&internal_error_problem, file, line, fmt, ap);
1039 deprecated_throw_reason (RETURN_ERROR);
1043 internal_error (const char *file, int line, const char *string, ...)
1047 va_start (ap, string);
1048 internal_verror (file, line, string, ap);
1052 static struct internal_problem internal_warning_problem = {
1053 "internal-warning", internal_problem_ask, internal_problem_ask
1057 internal_vwarning (const char *file, int line, const char *fmt, va_list ap)
1059 internal_vproblem (&internal_warning_problem, file, line, fmt, ap);
1063 internal_warning (const char *file, int line, const char *string, ...)
1067 va_start (ap, string);
1068 internal_vwarning (file, line, string, ap);
1072 /* Dummy functions to keep add_prefix_cmd happy. */
1075 set_internal_problem_cmd (char *args, int from_tty)
1080 show_internal_problem_cmd (char *args, int from_tty)
1084 /* When GDB reports an internal problem (error or warning) it gives
1085 the user the opportunity to quit GDB and/or create a core file of
1086 the current debug session. This function registers a few commands
1087 that make it possible to specify that GDB should always or never
1088 quit or create a core file, without asking. The commands look
1091 maint set PROBLEM-NAME quit ask|yes|no
1092 maint show PROBLEM-NAME quit
1093 maint set PROBLEM-NAME corefile ask|yes|no
1094 maint show PROBLEM-NAME corefile
1096 Where PROBLEM-NAME is currently "internal-error" or
1097 "internal-warning". */
1100 add_internal_problem_command (struct internal_problem *problem)
1102 struct cmd_list_element **set_cmd_list;
1103 struct cmd_list_element **show_cmd_list;
1107 set_cmd_list = xmalloc (sizeof (*set_cmd_list));
1108 show_cmd_list = xmalloc (sizeof (*set_cmd_list));
1109 *set_cmd_list = NULL;
1110 *show_cmd_list = NULL;
1112 set_doc = xstrprintf (_("Configure what GDB does when %s is detected."),
1115 show_doc = xstrprintf (_("Show what GDB does when %s is detected."),
1118 add_prefix_cmd ((char*) problem->name,
1119 class_maintenance, set_internal_problem_cmd, set_doc,
1121 concat ("maintenance set ", problem->name, " ",
1123 0/*allow-unknown*/, &maintenance_set_cmdlist);
1125 add_prefix_cmd ((char*) problem->name,
1126 class_maintenance, show_internal_problem_cmd, show_doc,
1128 concat ("maintenance show ", problem->name, " ",
1130 0/*allow-unknown*/, &maintenance_show_cmdlist);
1132 set_doc = xstrprintf (_("Set whether GDB should quit "
1133 "when an %s is detected"),
1135 show_doc = xstrprintf (_("Show whether GDB will quit "
1136 "when an %s is detected"),
1138 add_setshow_enum_cmd ("quit", class_maintenance,
1139 internal_problem_modes,
1140 &problem->should_quit,
1143 NULL, /* help_doc */
1145 NULL, /* showfunc */
1152 set_doc = xstrprintf (_("Set whether GDB should create a core "
1153 "file of GDB when %s is detected"),
1155 show_doc = xstrprintf (_("Show whether GDB will create a core "
1156 "file of GDB when %s is detected"),
1158 add_setshow_enum_cmd ("corefile", class_maintenance,
1159 internal_problem_modes,
1160 &problem->should_dump_core,
1163 NULL, /* help_doc */
1165 NULL, /* showfunc */
1173 /* Print the system error message for errno, and also mention STRING
1174 as the file name for which the error was encountered.
1175 Then return to command level. */
1178 perror_with_name (const char *string)
1183 err = safe_strerror (errno);
1184 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
1185 strcpy (combined, string);
1186 strcat (combined, ": ");
1187 strcat (combined, err);
1189 /* I understand setting these is a matter of taste. Still, some people
1190 may clear errno but not know about bfd_error. Doing this here is not
1192 bfd_set_error (bfd_error_no_error);
1195 error (_("%s."), combined);
1198 /* Print the system error message for ERRCODE, and also mention STRING
1199 as the file name for which the error was encountered. */
1202 print_sys_errmsg (const char *string, int errcode)
1207 err = safe_strerror (errcode);
1208 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
1209 strcpy (combined, string);
1210 strcat (combined, ": ");
1211 strcat (combined, err);
1213 /* We want anything which was printed on stdout to come out first, before
1215 gdb_flush (gdb_stdout);
1216 fprintf_unfiltered (gdb_stderr, "%s.\n", combined);
1219 /* Control C eventually causes this to be called, at a convenient time. */
1225 /* No steenking SIGINT will ever be coming our way when the
1226 program is resumed. Don't lie. */
1230 /* If there is no terminal switching for this target, then we can't
1231 possibly get screwed by the lack of job control. */
1232 || current_target.to_terminal_ours == NULL)
1235 fatal ("Quit (expect signal SIGINT when the program is resumed)");
1240 /* Called when a memory allocation fails, with the number of bytes of
1241 memory requested in SIZE. */
1244 malloc_failure (long size)
1248 internal_error (__FILE__, __LINE__,
1249 _("virtual memory exhausted: can't allocate %ld bytes."),
1254 internal_error (__FILE__, __LINE__, _("virtual memory exhausted."));
1258 /* My replacement for the read system call.
1259 Used like `read' but keeps going if `read' returns too soon. */
1262 myread (int desc, char *addr, int len)
1269 val = read (desc, addr, len);
1273 return orglen - len;
1280 /* Make a copy of the string at PTR with SIZE characters
1281 (and add a null character at the end in the copy).
1282 Uses malloc to get the space. Returns the address of the copy. */
1285 savestring (const char *ptr, size_t size)
1287 char *p = (char *) xmalloc (size + 1);
1289 memcpy (p, ptr, size);
1295 print_spaces (int n, struct ui_file *file)
1297 fputs_unfiltered (n_spaces (n), file);
1300 /* Print a host address. */
1303 gdb_print_host_address (const void *addr, struct ui_file *stream)
1305 fprintf_filtered (stream, "%s", host_address_to_string (addr));
1309 /* A cleanup function that calls regfree. */
1312 do_regfree_cleanup (void *r)
1317 /* Create a new cleanup that frees the compiled regular expression R. */
1320 make_regfree_cleanup (regex_t *r)
1322 return make_cleanup (do_regfree_cleanup, r);
1325 /* Return an xmalloc'd error message resulting from a regular
1326 expression compilation failure. */
1329 get_regcomp_error (int code, regex_t *rx)
1331 size_t length = regerror (code, rx, NULL, 0);
1332 char *result = xmalloc (length);
1334 regerror (code, rx, result, length);
1340 /* This function supports the query, nquery, and yquery functions.
1341 Ask user a y-or-n question and return 0 if answer is no, 1 if
1342 answer is yes, or default the answer to the specified default
1343 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1344 default answer, or '\0' for no default.
1345 CTLSTR is the control string and should end in "? ". It should
1346 not say how to answer, because we do that.
1347 ARGS are the arguments passed along with the CTLSTR argument to
1350 static int ATTRIBUTE_PRINTF (1, 0)
1351 defaulted_query (const char *ctlstr, const char defchar, va_list args)
1357 char def_answer, not_def_answer;
1358 char *y_string, *n_string, *question;
1360 /* Set up according to which answer is the default. */
1361 if (defchar == '\0')
1365 not_def_answer = 'N';
1369 else if (defchar == 'y')
1373 not_def_answer = 'N';
1381 not_def_answer = 'Y';
1386 /* Automatically answer the default value if the user did not want
1387 prompts or the command was issued with the server prefix. */
1388 if (! caution || server_command)
1391 /* If input isn't coming from the user directly, just say what
1392 question we're asking, and then answer the default automatically. This
1393 way, important error messages don't get lost when talking to GDB
1395 if (! input_from_terminal_p ())
1398 vfprintf_filtered (gdb_stdout, ctlstr, args);
1400 printf_filtered (_("(%s or %s) [answered %c; "
1401 "input not from terminal]\n"),
1402 y_string, n_string, def_answer);
1403 gdb_flush (gdb_stdout);
1408 if (deprecated_query_hook)
1410 return deprecated_query_hook (ctlstr, args);
1413 /* Format the question outside of the loop, to avoid reusing args. */
1414 question = xstrvprintf (ctlstr, args);
1418 wrap_here (""); /* Flush any buffered output. */
1419 gdb_flush (gdb_stdout);
1421 if (annotation_level > 1)
1422 printf_filtered (("\n\032\032pre-query\n"));
1424 fputs_filtered (question, gdb_stdout);
1425 printf_filtered (_("(%s or %s) "), y_string, n_string);
1427 if (annotation_level > 1)
1428 printf_filtered (("\n\032\032query\n"));
1431 gdb_flush (gdb_stdout);
1433 answer = fgetc (stdin);
1435 /* We expect fgetc to block until a character is read. But
1436 this may not be the case if the terminal was opened with
1437 the NONBLOCK flag. In that case, if there is nothing to
1438 read on stdin, fgetc returns EOF, but also sets the error
1439 condition flag on stdin and errno to EAGAIN. With a true
1440 EOF, stdin's error condition flag is not set.
1442 A situation where this behavior was observed is a pseudo
1444 while (answer == EOF && ferror (stdin) && errno == EAGAIN)
1446 /* Not a real EOF. Wait a little while and try again until
1447 we read something. */
1450 answer = fgetc (stdin);
1453 clearerr (stdin); /* in case of C-d */
1454 if (answer == EOF) /* C-d */
1456 printf_filtered ("EOF [assumed %c]\n", def_answer);
1460 /* Eat rest of input line, to EOF or newline. */
1464 ans2 = fgetc (stdin);
1467 while (ans2 != EOF && ans2 != '\n' && ans2 != '\r');
1471 /* Check answer. For the non-default, the user must specify
1472 the non-default explicitly. */
1473 if (answer == not_def_answer)
1475 retval = !def_value;
1478 /* Otherwise, if a default was specified, the user may either
1479 specify the required input or have it default by entering
1481 if (answer == def_answer
1482 || (defchar != '\0' &&
1483 (answer == '\n' || answer == '\r' || answer == EOF)))
1488 /* Invalid entries are not defaulted and require another selection. */
1489 printf_filtered (_("Please answer %s or %s.\n"),
1490 y_string, n_string);
1494 if (annotation_level > 1)
1495 printf_filtered (("\n\032\032post-query\n"));
1500 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1501 answer is yes, or 0 if answer is defaulted.
1502 Takes three args which are given to printf to print the question.
1503 The first, a control string, should end in "? ".
1504 It should not say how to answer, because we do that. */
1507 nquery (const char *ctlstr, ...)
1512 va_start (args, ctlstr);
1513 ret = defaulted_query (ctlstr, 'n', args);
1518 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1519 answer is yes, or 1 if answer is defaulted.
1520 Takes three args which are given to printf to print the question.
1521 The first, a control string, should end in "? ".
1522 It should not say how to answer, because we do that. */
1525 yquery (const char *ctlstr, ...)
1530 va_start (args, ctlstr);
1531 ret = defaulted_query (ctlstr, 'y', args);
1536 /* Ask user a y-or-n question and return 1 iff answer is yes.
1537 Takes three args which are given to printf to print the question.
1538 The first, a control string, should end in "? ".
1539 It should not say how to answer, because we do that. */
1542 query (const char *ctlstr, ...)
1547 va_start (args, ctlstr);
1548 ret = defaulted_query (ctlstr, '\0', args);
1553 /* A helper for parse_escape that converts a host character to a
1554 target character. C is the host character. If conversion is
1555 possible, then the target character is stored in *TARGET_C and the
1556 function returns 1. Otherwise, the function returns 0. */
1559 host_char_to_target (struct gdbarch *gdbarch, int c, int *target_c)
1561 struct obstack host_data;
1563 struct cleanup *cleanups;
1566 obstack_init (&host_data);
1567 cleanups = make_cleanup_obstack_free (&host_data);
1569 convert_between_encodings (target_charset (gdbarch), host_charset (),
1570 &the_char, 1, 1, &host_data, translit_none);
1572 if (obstack_object_size (&host_data) == 1)
1575 *target_c = *(char *) obstack_base (&host_data);
1578 do_cleanups (cleanups);
1582 /* Parse a C escape sequence. STRING_PTR points to a variable
1583 containing a pointer to the string to parse. That pointer
1584 should point to the character after the \. That pointer
1585 is updated past the characters we use. The value of the
1586 escape sequence is returned.
1588 A negative value means the sequence \ newline was seen,
1589 which is supposed to be equivalent to nothing at all.
1591 If \ is followed by a null character, we return a negative
1592 value and leave the string pointer pointing at the null character.
1594 If \ is followed by 000, we return 0 and leave the string pointer
1595 after the zeros. A value of 0 does not mean end of string. */
1598 parse_escape (struct gdbarch *gdbarch, char **string_ptr)
1600 int target_char = -2; /* Initialize to avoid GCC warnings. */
1601 int c = *(*string_ptr)++;
1620 int i = host_hex_value (c);
1625 if (isdigit (c) && c != '8' && c != '9')
1629 i += host_hex_value (c);
1665 if (!host_char_to_target (gdbarch, c, &target_char))
1666 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1667 " which has no equivalent\nin the `%s' character set."),
1668 c, c, target_charset (gdbarch));
1672 /* Print the character C on STREAM as part of the contents of a literal
1673 string whose delimiter is QUOTER. Note that this routine should only
1674 be call for printing things which are independent of the language
1675 of the program being debugged. */
1678 printchar (int c, void (*do_fputs) (const char *, struct ui_file *),
1679 void (*do_fprintf) (struct ui_file *, const char *, ...)
1680 ATTRIBUTE_FPTR_PRINTF_2, struct ui_file *stream, int quoter)
1682 c &= 0xFF; /* Avoid sign bit follies */
1684 if (c < 0x20 || /* Low control chars */
1685 (c >= 0x7F && c < 0xA0) || /* DEL, High controls */
1686 (sevenbit_strings && c >= 0x80))
1687 { /* high order bit set */
1691 do_fputs ("\\n", stream);
1694 do_fputs ("\\b", stream);
1697 do_fputs ("\\t", stream);
1700 do_fputs ("\\f", stream);
1703 do_fputs ("\\r", stream);
1706 do_fputs ("\\e", stream);
1709 do_fputs ("\\a", stream);
1712 do_fprintf (stream, "\\%.3o", (unsigned int) c);
1718 if (c == '\\' || c == quoter)
1719 do_fputs ("\\", stream);
1720 do_fprintf (stream, "%c", c);
1724 /* Print the character C on STREAM as part of the contents of a
1725 literal string whose delimiter is QUOTER. Note that these routines
1726 should only be call for printing things which are independent of
1727 the language of the program being debugged. */
1730 fputstr_filtered (const char *str, int quoter, struct ui_file *stream)
1733 printchar (*str++, fputs_filtered, fprintf_filtered, stream, quoter);
1737 fputstr_unfiltered (const char *str, int quoter, struct ui_file *stream)
1740 printchar (*str++, fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1744 fputstrn_filtered (const char *str, int n, int quoter,
1745 struct ui_file *stream)
1749 for (i = 0; i < n; i++)
1750 printchar (str[i], fputs_filtered, fprintf_filtered, stream, quoter);
1754 fputstrn_unfiltered (const char *str, int n, int quoter,
1755 struct ui_file *stream)
1759 for (i = 0; i < n; i++)
1760 printchar (str[i], fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1764 /* Number of lines per page or UINT_MAX if paging is disabled. */
1765 static unsigned int lines_per_page;
1767 show_lines_per_page (struct ui_file *file, int from_tty,
1768 struct cmd_list_element *c, const char *value)
1770 fprintf_filtered (file,
1771 _("Number of lines gdb thinks are in a page is %s.\n"),
1775 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1776 static unsigned int chars_per_line;
1778 show_chars_per_line (struct ui_file *file, int from_tty,
1779 struct cmd_list_element *c, const char *value)
1781 fprintf_filtered (file,
1782 _("Number of characters gdb thinks "
1783 "are in a line is %s.\n"),
1787 /* Current count of lines printed on this page, chars on this line. */
1788 static unsigned int lines_printed, chars_printed;
1790 /* Buffer and start column of buffered text, for doing smarter word-
1791 wrapping. When someone calls wrap_here(), we start buffering output
1792 that comes through fputs_filtered(). If we see a newline, we just
1793 spit it out and forget about the wrap_here(). If we see another
1794 wrap_here(), we spit it out and remember the newer one. If we see
1795 the end of the line, we spit out a newline, the indent, and then
1796 the buffered output. */
1798 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1799 are waiting to be output (they have already been counted in chars_printed).
1800 When wrap_buffer[0] is null, the buffer is empty. */
1801 static char *wrap_buffer;
1803 /* Pointer in wrap_buffer to the next character to fill. */
1804 static char *wrap_pointer;
1806 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1808 static char *wrap_indent;
1810 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1811 is not in effect. */
1812 static int wrap_column;
1815 /* Inialize the number of lines per page and chars per line. */
1818 init_page_info (void)
1822 lines_per_page = UINT_MAX;
1823 chars_per_line = UINT_MAX;
1827 if (!tui_get_command_dimension (&chars_per_line, &lines_per_page))
1832 #if defined(__GO32__)
1833 rows = ScreenRows ();
1834 cols = ScreenCols ();
1835 lines_per_page = rows;
1836 chars_per_line = cols;
1838 /* Make sure Readline has initialized its terminal settings. */
1839 rl_reset_terminal (NULL);
1841 /* Get the screen size from Readline. */
1842 rl_get_screen_size (&rows, &cols);
1843 lines_per_page = rows;
1844 chars_per_line = cols;
1846 /* Readline should have fetched the termcap entry for us. */
1847 if (tgetnum ("li") < 0 || getenv ("EMACS"))
1849 /* The number of lines per page is not mentioned in the
1850 terminal description. This probably means that paging is
1851 not useful (e.g. emacs shell window), so disable paging. */
1852 lines_per_page = UINT_MAX;
1855 /* FIXME: Get rid of this junk. */
1856 #if defined(SIGWINCH) && defined(SIGWINCH_HANDLER)
1857 SIGWINCH_HANDLER (SIGWINCH);
1860 /* If the output is not a terminal, don't paginate it. */
1861 if (!ui_file_isatty (gdb_stdout))
1862 lines_per_page = UINT_MAX;
1870 /* Helper for make_cleanup_restore_page_info. */
1873 do_restore_page_info_cleanup (void *arg)
1879 /* Provide cleanup for restoring the terminal size. */
1882 make_cleanup_restore_page_info (void)
1884 struct cleanup *back_to;
1886 back_to = make_cleanup (do_restore_page_info_cleanup, NULL);
1887 make_cleanup_restore_uinteger (&lines_per_page);
1888 make_cleanup_restore_uinteger (&chars_per_line);
1893 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1894 Provide cleanup for restoring the original state. */
1897 set_batch_flag_and_make_cleanup_restore_page_info (void)
1899 struct cleanup *back_to = make_cleanup_restore_page_info ();
1901 make_cleanup_restore_integer (&batch_flag);
1908 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1911 set_screen_size (void)
1913 int rows = lines_per_page;
1914 int cols = chars_per_line;
1922 /* Update Readline's idea of the terminal size. */
1923 rl_set_screen_size (rows, cols);
1926 /* Reinitialize WRAP_BUFFER according to the current value of
1932 if (chars_per_line == 0)
1937 wrap_buffer = (char *) xmalloc (chars_per_line + 2);
1938 wrap_buffer[0] = '\0';
1941 wrap_buffer = (char *) xrealloc (wrap_buffer, chars_per_line + 2);
1942 wrap_pointer = wrap_buffer; /* Start it at the beginning. */
1946 set_width_command (char *args, int from_tty, struct cmd_list_element *c)
1953 set_height_command (char *args, int from_tty, struct cmd_list_element *c)
1958 /* Wait, so the user can read what's on the screen. Prompt the user
1959 to continue by pressing RETURN. */
1962 prompt_for_continue (void)
1965 char cont_prompt[120];
1967 if (annotation_level > 1)
1968 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1970 strcpy (cont_prompt,
1971 "---Type <return> to continue, or q <return> to quit---");
1972 if (annotation_level > 1)
1973 strcat (cont_prompt, "\n\032\032prompt-for-continue\n");
1975 /* We must do this *before* we call gdb_readline, else it will eventually
1976 call us -- thinking that we're trying to print beyond the end of the
1978 reinitialize_more_filter ();
1981 /* On a real operating system, the user can quit with SIGINT.
1984 'q' is provided on all systems so users don't have to change habits
1985 from system to system, and because telling them what to do in
1986 the prompt is more user-friendly than expecting them to think of
1988 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1989 whereas control-C to gdb_readline will cause the user to get dumped
1991 ignore = gdb_readline_wrapper (cont_prompt);
1993 if (annotation_level > 1)
1994 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
2000 while (*p == ' ' || *p == '\t')
2003 async_request_quit (0);
2008 /* Now we have to do this again, so that GDB will know that it doesn't
2009 need to save the ---Type <return>--- line at the top of the screen. */
2010 reinitialize_more_filter ();
2012 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
2015 /* Reinitialize filter; ie. tell it to reset to original values. */
2018 reinitialize_more_filter (void)
2024 /* Indicate that if the next sequence of characters overflows the line,
2025 a newline should be inserted here rather than when it hits the end.
2026 If INDENT is non-null, it is a string to be printed to indent the
2027 wrapped part on the next line. INDENT must remain accessible until
2028 the next call to wrap_here() or until a newline is printed through
2031 If the line is already overfull, we immediately print a newline and
2032 the indentation, and disable further wrapping.
2034 If we don't know the width of lines, but we know the page height,
2035 we must not wrap words, but should still keep track of newlines
2036 that were explicitly printed.
2038 INDENT should not contain tabs, as that will mess up the char count
2039 on the next line. FIXME.
2041 This routine is guaranteed to force out any output which has been
2042 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
2043 used to force out output from the wrap_buffer. */
2046 wrap_here (char *indent)
2048 /* This should have been allocated, but be paranoid anyway. */
2050 internal_error (__FILE__, __LINE__,
2051 _("failed internal consistency check"));
2055 *wrap_pointer = '\0';
2056 fputs_unfiltered (wrap_buffer, gdb_stdout);
2058 wrap_pointer = wrap_buffer;
2059 wrap_buffer[0] = '\0';
2060 if (chars_per_line == UINT_MAX) /* No line overflow checking. */
2064 else if (chars_printed >= chars_per_line)
2066 puts_filtered ("\n");
2068 puts_filtered (indent);
2073 wrap_column = chars_printed;
2077 wrap_indent = indent;
2081 /* Print input string to gdb_stdout, filtered, with wrap,
2082 arranging strings in columns of n chars. String can be
2083 right or left justified in the column. Never prints
2084 trailing spaces. String should never be longer than
2085 width. FIXME: this could be useful for the EXAMINE
2086 command, which currently doesn't tabulate very well. */
2089 puts_filtered_tabular (char *string, int width, int right)
2095 gdb_assert (chars_per_line > 0);
2096 if (chars_per_line == UINT_MAX)
2098 fputs_filtered (string, gdb_stdout);
2099 fputs_filtered ("\n", gdb_stdout);
2103 if (((chars_printed - 1) / width + 2) * width >= chars_per_line)
2104 fputs_filtered ("\n", gdb_stdout);
2106 if (width >= chars_per_line)
2107 width = chars_per_line - 1;
2109 stringlen = strlen (string);
2111 if (chars_printed > 0)
2112 spaces = width - (chars_printed - 1) % width - 1;
2114 spaces += width - stringlen;
2116 spacebuf = alloca (spaces + 1);
2117 spacebuf[spaces] = '\0';
2119 spacebuf[spaces] = ' ';
2121 fputs_filtered (spacebuf, gdb_stdout);
2122 fputs_filtered (string, gdb_stdout);
2126 /* Ensure that whatever gets printed next, using the filtered output
2127 commands, starts at the beginning of the line. I.e. if there is
2128 any pending output for the current line, flush it and start a new
2129 line. Otherwise do nothing. */
2134 if (chars_printed > 0)
2136 puts_filtered ("\n");
2141 /* Like fputs but if FILTER is true, pause after every screenful.
2143 Regardless of FILTER can wrap at points other than the final
2144 character of a line.
2146 Unlike fputs, fputs_maybe_filtered does not return a value.
2147 It is OK for LINEBUFFER to be NULL, in which case just don't print
2150 Note that a longjmp to top level may occur in this routine (only if
2151 FILTER is true) (since prompt_for_continue may do so) so this
2152 routine should not be called when cleanups are not in place. */
2155 fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
2158 const char *lineptr;
2160 if (linebuffer == 0)
2163 /* Don't do any filtering if it is disabled. */
2164 if (stream != gdb_stdout
2165 || !pagination_enabled
2167 || (lines_per_page == UINT_MAX && chars_per_line == UINT_MAX)
2168 || top_level_interpreter () == NULL
2169 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2171 fputs_unfiltered (linebuffer, stream);
2175 /* Go through and output each character. Show line extension
2176 when this is necessary; prompt user for new page when this is
2179 lineptr = linebuffer;
2182 /* Possible new page. */
2183 if (filter && (lines_printed >= lines_per_page - 1))
2184 prompt_for_continue ();
2186 while (*lineptr && *lineptr != '\n')
2188 /* Print a single line. */
2189 if (*lineptr == '\t')
2192 *wrap_pointer++ = '\t';
2194 fputc_unfiltered ('\t', stream);
2195 /* Shifting right by 3 produces the number of tab stops
2196 we have already passed, and then adding one and
2197 shifting left 3 advances to the next tab stop. */
2198 chars_printed = ((chars_printed >> 3) + 1) << 3;
2204 *wrap_pointer++ = *lineptr;
2206 fputc_unfiltered (*lineptr, stream);
2211 if (chars_printed >= chars_per_line)
2213 unsigned int save_chars = chars_printed;
2217 /* If we aren't actually wrapping, don't output newline --
2218 if chars_per_line is right, we probably just overflowed
2219 anyway; if it's wrong, let us keep going. */
2221 fputc_unfiltered ('\n', stream);
2223 /* Possible new page. */
2224 if (lines_printed >= lines_per_page - 1)
2225 prompt_for_continue ();
2227 /* Now output indentation and wrapped string. */
2230 fputs_unfiltered (wrap_indent, stream);
2231 *wrap_pointer = '\0'; /* Null-terminate saved stuff, */
2232 fputs_unfiltered (wrap_buffer, stream); /* and eject it. */
2233 /* FIXME, this strlen is what prevents wrap_indent from
2234 containing tabs. However, if we recurse to print it
2235 and count its chars, we risk trouble if wrap_indent is
2236 longer than (the user settable) chars_per_line.
2237 Note also that this can set chars_printed > chars_per_line
2238 if we are printing a long string. */
2239 chars_printed = strlen (wrap_indent)
2240 + (save_chars - wrap_column);
2241 wrap_pointer = wrap_buffer; /* Reset buffer */
2242 wrap_buffer[0] = '\0';
2243 wrap_column = 0; /* And disable fancy wrap */
2248 if (*lineptr == '\n')
2251 wrap_here ((char *) 0); /* Spit out chars, cancel
2254 fputc_unfiltered ('\n', stream);
2261 fputs_filtered (const char *linebuffer, struct ui_file *stream)
2263 fputs_maybe_filtered (linebuffer, stream, 1);
2267 putchar_unfiltered (int c)
2271 ui_file_write (gdb_stdout, &buf, 1);
2275 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2276 May return nonlocally. */
2279 putchar_filtered (int c)
2281 return fputc_filtered (c, gdb_stdout);
2285 fputc_unfiltered (int c, struct ui_file *stream)
2289 ui_file_write (stream, &buf, 1);
2294 fputc_filtered (int c, struct ui_file *stream)
2300 fputs_filtered (buf, stream);
2304 /* puts_debug is like fputs_unfiltered, except it prints special
2305 characters in printable fashion. */
2308 puts_debug (char *prefix, char *string, char *suffix)
2312 /* Print prefix and suffix after each line. */
2313 static int new_line = 1;
2314 static int return_p = 0;
2315 static char *prev_prefix = "";
2316 static char *prev_suffix = "";
2318 if (*string == '\n')
2321 /* If the prefix is changing, print the previous suffix, a new line,
2322 and the new prefix. */
2323 if ((return_p || (strcmp (prev_prefix, prefix) != 0)) && !new_line)
2325 fputs_unfiltered (prev_suffix, gdb_stdlog);
2326 fputs_unfiltered ("\n", gdb_stdlog);
2327 fputs_unfiltered (prefix, gdb_stdlog);
2330 /* Print prefix if we printed a newline during the previous call. */
2334 fputs_unfiltered (prefix, gdb_stdlog);
2337 prev_prefix = prefix;
2338 prev_suffix = suffix;
2340 /* Output characters in a printable format. */
2341 while ((ch = *string++) != '\0')
2347 fputc_unfiltered (ch, gdb_stdlog);
2350 fprintf_unfiltered (gdb_stdlog, "\\x%02x", ch & 0xff);
2354 fputs_unfiltered ("\\\\", gdb_stdlog);
2357 fputs_unfiltered ("\\b", gdb_stdlog);
2360 fputs_unfiltered ("\\f", gdb_stdlog);
2364 fputs_unfiltered ("\\n", gdb_stdlog);
2367 fputs_unfiltered ("\\r", gdb_stdlog);
2370 fputs_unfiltered ("\\t", gdb_stdlog);
2373 fputs_unfiltered ("\\v", gdb_stdlog);
2377 return_p = ch == '\r';
2380 /* Print suffix if we printed a newline. */
2383 fputs_unfiltered (suffix, gdb_stdlog);
2384 fputs_unfiltered ("\n", gdb_stdlog);
2389 /* Print a variable number of ARGS using format FORMAT. If this
2390 information is going to put the amount written (since the last call
2391 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2392 call prompt_for_continue to get the users permision to continue.
2394 Unlike fprintf, this function does not return a value.
2396 We implement three variants, vfprintf (takes a vararg list and stream),
2397 fprintf (takes a stream to write on), and printf (the usual).
2399 Note also that a longjmp to top level may occur in this routine
2400 (since prompt_for_continue may do so) so this routine should not be
2401 called when cleanups are not in place. */
2404 vfprintf_maybe_filtered (struct ui_file *stream, const char *format,
2405 va_list args, int filter)
2408 struct cleanup *old_cleanups;
2410 linebuffer = xstrvprintf (format, args);
2411 old_cleanups = make_cleanup (xfree, linebuffer);
2412 fputs_maybe_filtered (linebuffer, stream, filter);
2413 do_cleanups (old_cleanups);
2418 vfprintf_filtered (struct ui_file *stream, const char *format, va_list args)
2420 vfprintf_maybe_filtered (stream, format, args, 1);
2424 vfprintf_unfiltered (struct ui_file *stream, const char *format, va_list args)
2427 struct cleanup *old_cleanups;
2429 linebuffer = xstrvprintf (format, args);
2430 old_cleanups = make_cleanup (xfree, linebuffer);
2431 if (debug_timestamp && stream == gdb_stdlog)
2437 gettimeofday (&tm, NULL);
2439 len = strlen (linebuffer);
2440 need_nl = (len > 0 && linebuffer[len - 1] != '\n');
2442 timestamp = xstrprintf ("%ld:%ld %s%s",
2443 (long) tm.tv_sec, (long) tm.tv_usec,
2445 need_nl ? "\n": "");
2446 make_cleanup (xfree, timestamp);
2447 fputs_unfiltered (timestamp, stream);
2450 fputs_unfiltered (linebuffer, stream);
2451 do_cleanups (old_cleanups);
2455 vprintf_filtered (const char *format, va_list args)
2457 vfprintf_maybe_filtered (gdb_stdout, format, args, 1);
2461 vprintf_unfiltered (const char *format, va_list args)
2463 vfprintf_unfiltered (gdb_stdout, format, args);
2467 fprintf_filtered (struct ui_file *stream, const char *format, ...)
2471 va_start (args, format);
2472 vfprintf_filtered (stream, format, args);
2477 fprintf_unfiltered (struct ui_file *stream, const char *format, ...)
2481 va_start (args, format);
2482 vfprintf_unfiltered (stream, format, args);
2486 /* Like fprintf_filtered, but prints its result indented.
2487 Called as fprintfi_filtered (spaces, stream, format, ...); */
2490 fprintfi_filtered (int spaces, struct ui_file *stream, const char *format,
2495 va_start (args, format);
2496 print_spaces_filtered (spaces, stream);
2498 vfprintf_filtered (stream, format, args);
2504 printf_filtered (const char *format, ...)
2508 va_start (args, format);
2509 vfprintf_filtered (gdb_stdout, format, args);
2515 printf_unfiltered (const char *format, ...)
2519 va_start (args, format);
2520 vfprintf_unfiltered (gdb_stdout, format, args);
2524 /* Like printf_filtered, but prints it's result indented.
2525 Called as printfi_filtered (spaces, format, ...); */
2528 printfi_filtered (int spaces, const char *format, ...)
2532 va_start (args, format);
2533 print_spaces_filtered (spaces, gdb_stdout);
2534 vfprintf_filtered (gdb_stdout, format, args);
2538 /* Easy -- but watch out!
2540 This routine is *not* a replacement for puts()! puts() appends a newline.
2541 This one doesn't, and had better not! */
2544 puts_filtered (const char *string)
2546 fputs_filtered (string, gdb_stdout);
2550 puts_unfiltered (const char *string)
2552 fputs_unfiltered (string, gdb_stdout);
2555 /* Return a pointer to N spaces and a null. The pointer is good
2556 until the next call to here. */
2561 static char *spaces = 0;
2562 static int max_spaces = -1;
2568 spaces = (char *) xmalloc (n + 1);
2569 for (t = spaces + n; t != spaces;)
2575 return spaces + max_spaces - n;
2578 /* Print N spaces. */
2580 print_spaces_filtered (int n, struct ui_file *stream)
2582 fputs_filtered (n_spaces (n), stream);
2585 /* C++/ObjC demangler stuff. */
2587 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2588 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2589 If the name is not mangled, or the language for the name is unknown, or
2590 demangling is off, the name is printed in its "raw" form. */
2593 fprintf_symbol_filtered (struct ui_file *stream, char *name,
2594 enum language lang, int arg_mode)
2600 /* If user wants to see raw output, no problem. */
2603 fputs_filtered (name, stream);
2607 demangled = language_demangle (language_def (lang), name, arg_mode);
2608 fputs_filtered (demangled ? demangled : name, stream);
2609 if (demangled != NULL)
2617 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2618 differences in whitespace. Returns 0 if they match, non-zero if they
2619 don't (slightly different than strcmp()'s range of return values).
2621 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2622 This "feature" is useful when searching for matching C++ function names
2623 (such as if the user types 'break FOO', where FOO is a mangled C++
2627 strcmp_iw (const char *string1, const char *string2)
2629 while ((*string1 != '\0') && (*string2 != '\0'))
2631 while (isspace (*string1))
2635 while (isspace (*string2))
2639 if (case_sensitivity == case_sensitive_on && *string1 != *string2)
2641 if (case_sensitivity == case_sensitive_off
2642 && (tolower ((unsigned char) *string1)
2643 != tolower ((unsigned char) *string2)))
2645 if (*string1 != '\0')
2651 return (*string1 != '\0' && *string1 != '(') || (*string2 != '\0');
2654 /* This is like strcmp except that it ignores whitespace and treats
2655 '(' as the first non-NULL character in terms of ordering. Like
2656 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2657 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2658 according to that ordering.
2660 If a list is sorted according to this function and if you want to
2661 find names in the list that match some fixed NAME according to
2662 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2663 where this function would put NAME.
2665 This function must be neutral to the CASE_SENSITIVITY setting as the user
2666 may choose it during later lookup. Therefore this function always sorts
2667 primarily case-insensitively and secondarily case-sensitively.
2669 Here are some examples of why using strcmp to sort is a bad idea:
2673 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2674 we try to do a search for "foo<char*>", strcmp will locate this
2675 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2676 will start looking at strings beginning with "goo", and will never
2677 see the correct match of "foo<char *>".
2679 Parenthesis example:
2681 In practice, this is less like to be an issue, but I'll give it a
2682 shot. Let's assume that '$' is a legitimate character to occur in
2683 symbols. (Which may well even be the case on some systems.) Then
2684 say that the partial symbol table contains "foo$" and "foo(int)".
2685 strcmp will put them in this order, since '$' < '('. Now, if the
2686 user searches for "foo", then strcmp will sort "foo" before "foo$".
2687 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2688 "foo") is false, so it won't proceed to the actual match of
2689 "foo(int)" with "foo". */
2692 strcmp_iw_ordered (const char *string1, const char *string2)
2694 const char *saved_string1 = string1, *saved_string2 = string2;
2695 enum case_sensitivity case_pass = case_sensitive_off;
2699 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2700 Provide stub characters if we are already at the end of one of the
2702 char c1 = 'X', c2 = 'X';
2704 while (*string1 != '\0' && *string2 != '\0')
2706 while (isspace (*string1))
2708 while (isspace (*string2))
2713 case case_sensitive_off:
2714 c1 = tolower ((unsigned char) *string1);
2715 c2 = tolower ((unsigned char) *string2);
2717 case case_sensitive_on:
2725 if (*string1 != '\0')
2734 /* Characters are non-equal unless they're both '\0'; we want to
2735 make sure we get the comparison right according to our
2736 comparison in the cases where one of them is '\0' or '('. */
2738 if (*string2 == '\0')
2743 if (*string2 == '\0')
2748 if (*string2 == '\0' || *string2 == '(')
2757 if (case_pass == case_sensitive_on)
2760 /* Otherwise the strings were equal in case insensitive way, make
2761 a more fine grained comparison in a case sensitive way. */
2763 case_pass = case_sensitive_on;
2764 string1 = saved_string1;
2765 string2 = saved_string2;
2769 /* A simple comparison function with opposite semantics to strcmp. */
2772 streq (const char *lhs, const char *rhs)
2774 return !strcmp (lhs, rhs);
2780 ** Answer whether string_to_compare is a full or partial match to
2781 ** template_string. The partial match must be in sequence starting
2785 subset_compare (char *string_to_compare, char *template_string)
2789 if (template_string != (char *) NULL && string_to_compare != (char *) NULL
2790 && strlen (string_to_compare) <= strlen (template_string))
2793 (template_string, string_to_compare, strlen (string_to_compare)) == 0);
2800 pagination_on_command (char *arg, int from_tty)
2802 pagination_enabled = 1;
2806 pagination_off_command (char *arg, int from_tty)
2808 pagination_enabled = 0;
2812 show_debug_timestamp (struct ui_file *file, int from_tty,
2813 struct cmd_list_element *c, const char *value)
2815 fprintf_filtered (file, _("Timestamping debugging messages is %s.\n"),
2821 initialize_utils (void)
2823 add_setshow_uinteger_cmd ("width", class_support, &chars_per_line, _("\
2824 Set number of characters gdb thinks are in a line."), _("\
2825 Show number of characters gdb thinks are in a line."), NULL,
2827 show_chars_per_line,
2828 &setlist, &showlist);
2830 add_setshow_uinteger_cmd ("height", class_support, &lines_per_page, _("\
2831 Set number of lines gdb thinks are in a page."), _("\
2832 Show number of lines gdb thinks are in a page."), NULL,
2834 show_lines_per_page,
2835 &setlist, &showlist);
2839 add_setshow_boolean_cmd ("demangle", class_support, &demangle, _("\
2840 Set demangling of encoded C++/ObjC names when displaying symbols."), _("\
2841 Show demangling of encoded C++/ObjC names when displaying symbols."), NULL,
2844 &setprintlist, &showprintlist);
2846 add_setshow_boolean_cmd ("pagination", class_support,
2847 &pagination_enabled, _("\
2848 Set state of pagination."), _("\
2849 Show state of pagination."), NULL,
2851 show_pagination_enabled,
2852 &setlist, &showlist);
2856 add_com ("am", class_support, pagination_on_command,
2857 _("Enable pagination"));
2858 add_com ("sm", class_support, pagination_off_command,
2859 _("Disable pagination"));
2862 add_setshow_boolean_cmd ("sevenbit-strings", class_support,
2863 &sevenbit_strings, _("\
2864 Set printing of 8-bit characters in strings as \\nnn."), _("\
2865 Show printing of 8-bit characters in strings as \\nnn."), NULL,
2867 show_sevenbit_strings,
2868 &setprintlist, &showprintlist);
2870 add_setshow_boolean_cmd ("asm-demangle", class_support, &asm_demangle, _("\
2871 Set demangling of C++/ObjC names in disassembly listings."), _("\
2872 Show demangling of C++/ObjC names in disassembly listings."), NULL,
2875 &setprintlist, &showprintlist);
2877 add_setshow_boolean_cmd ("timestamp", class_maintenance,
2878 &debug_timestamp, _("\
2879 Set timestamping of debugging messages."), _("\
2880 Show timestamping of debugging messages."), _("\
2881 When set, debugging messages will be marked with seconds and microseconds."),
2883 show_debug_timestamp,
2884 &setdebuglist, &showdebuglist);
2887 /* Machine specific function to handle SIGWINCH signal. */
2889 #ifdef SIGWINCH_HANDLER_BODY
2890 SIGWINCH_HANDLER_BODY
2892 /* Print routines to handle variable size regs, etc. */
2893 /* Temporary storage using circular buffer. */
2899 static char buf[NUMCELLS][CELLSIZE];
2900 static int cell = 0;
2902 if (++cell >= NUMCELLS)
2908 paddress (struct gdbarch *gdbarch, CORE_ADDR addr)
2910 /* Truncate address to the size of a target address, avoiding shifts
2911 larger or equal than the width of a CORE_ADDR. The local
2912 variable ADDR_BIT stops the compiler reporting a shift overflow
2913 when it won't occur. */
2914 /* NOTE: This assumes that the significant address information is
2915 kept in the least significant bits of ADDR - the upper bits were
2916 either zero or sign extended. Should gdbarch_address_to_pointer or
2917 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2919 int addr_bit = gdbarch_addr_bit (gdbarch);
2921 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2922 addr &= ((CORE_ADDR) 1 << addr_bit) - 1;
2923 return hex_string (addr);
2926 /* This function is described in "defs.h". */
2929 print_core_address (struct gdbarch *gdbarch, CORE_ADDR address)
2931 int addr_bit = gdbarch_addr_bit (gdbarch);
2933 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2934 address &= ((CORE_ADDR) 1 << addr_bit) - 1;
2936 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2937 that returns the language localized string formatted to a width
2938 based on gdbarch_addr_bit. */
2940 return hex_string_custom (address, 8);
2942 return hex_string_custom (address, 16);
2945 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2948 core_addr_hash (const void *ap)
2950 const CORE_ADDR *addrp = ap;
2955 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2958 core_addr_eq (const void *ap, const void *bp)
2960 const CORE_ADDR *addr_ap = ap;
2961 const CORE_ADDR *addr_bp = bp;
2963 return *addr_ap == *addr_bp;
2967 decimal2str (char *sign, ULONGEST addr, int width)
2969 /* Steal code from valprint.c:print_decimal(). Should this worry
2970 about the real size of addr as the above does? */
2971 unsigned long temp[3];
2972 char *str = get_cell ();
2977 temp[i] = addr % (1000 * 1000 * 1000);
2978 addr /= (1000 * 1000 * 1000);
2982 while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0])));
2991 xsnprintf (str, CELLSIZE, "%s%0*lu", sign, width, temp[0]);
2994 xsnprintf (str, CELLSIZE, "%s%0*lu%09lu", sign, width,
2998 xsnprintf (str, CELLSIZE, "%s%0*lu%09lu%09lu", sign, width,
2999 temp[2], temp[1], temp[0]);
3002 internal_error (__FILE__, __LINE__,
3003 _("failed internal consistency check"));
3010 octal2str (ULONGEST addr, int width)
3012 unsigned long temp[3];
3013 char *str = get_cell ();
3018 temp[i] = addr % (0100000 * 0100000);
3019 addr /= (0100000 * 0100000);
3023 while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0])));
3033 xsnprintf (str, CELLSIZE, "%*o", width, 0);
3035 xsnprintf (str, CELLSIZE, "0%0*lo", width, temp[0]);
3038 xsnprintf (str, CELLSIZE, "0%0*lo%010lo", width, temp[1], temp[0]);
3041 xsnprintf (str, CELLSIZE, "0%0*lo%010lo%010lo", width,
3042 temp[2], temp[1], temp[0]);
3045 internal_error (__FILE__, __LINE__,
3046 _("failed internal consistency check"));
3053 pulongest (ULONGEST u)
3055 return decimal2str ("", u, 0);
3059 plongest (LONGEST l)
3062 return decimal2str ("-", -l, 0);
3064 return decimal2str ("", l, 0);
3067 /* Eliminate warning from compiler on 32-bit systems. */
3068 static int thirty_two = 32;
3071 phex (ULONGEST l, int sizeof_l)
3079 xsnprintf (str, CELLSIZE, "%08lx%08lx",
3080 (unsigned long) (l >> thirty_two),
3081 (unsigned long) (l & 0xffffffff));
3085 xsnprintf (str, CELLSIZE, "%08lx", (unsigned long) l);
3089 xsnprintf (str, CELLSIZE, "%04x", (unsigned short) (l & 0xffff));
3092 str = phex (l, sizeof (l));
3100 phex_nz (ULONGEST l, int sizeof_l)
3108 unsigned long high = (unsigned long) (l >> thirty_two);
3112 xsnprintf (str, CELLSIZE, "%lx",
3113 (unsigned long) (l & 0xffffffff));
3115 xsnprintf (str, CELLSIZE, "%lx%08lx", high,
3116 (unsigned long) (l & 0xffffffff));
3121 xsnprintf (str, CELLSIZE, "%lx", (unsigned long) l);
3125 xsnprintf (str, CELLSIZE, "%x", (unsigned short) (l & 0xffff));
3128 str = phex_nz (l, sizeof (l));
3135 /* Converts a LONGEST to a C-format hexadecimal literal and stores it
3136 in a static string. Returns a pointer to this string. */
3138 hex_string (LONGEST num)
3140 char *result = get_cell ();
3142 xsnprintf (result, CELLSIZE, "0x%s", phex_nz (num, sizeof (num)));
3146 /* Converts a LONGEST number to a C-format hexadecimal literal and
3147 stores it in a static string. Returns a pointer to this string
3148 that is valid until the next call. The number is padded on the
3149 left with 0s to at least WIDTH characters. */
3151 hex_string_custom (LONGEST num, int width)
3153 char *result = get_cell ();
3154 char *result_end = result + CELLSIZE - 1;
3155 const char *hex = phex_nz (num, sizeof (num));
3156 int hex_len = strlen (hex);
3158 if (hex_len > width)
3160 if (width + 2 >= CELLSIZE)
3161 internal_error (__FILE__, __LINE__, _("\
3162 hex_string_custom: insufficient space to store result"));
3164 strcpy (result_end - width - 2, "0x");
3165 memset (result_end - width, '0', width);
3166 strcpy (result_end - hex_len, hex);
3167 return result_end - width - 2;
3170 /* Convert VAL to a numeral in the given radix. For
3171 * radix 10, IS_SIGNED may be true, indicating a signed quantity;
3172 * otherwise VAL is interpreted as unsigned. If WIDTH is supplied,
3173 * it is the minimum width (0-padded if needed). USE_C_FORMAT means
3174 * to use C format in all cases. If it is false, then 'x'
3175 * and 'o' formats do not include a prefix (0x or leading 0). */
3178 int_string (LONGEST val, int radix, int is_signed, int width,
3188 result = hex_string (val);
3190 result = hex_string_custom (val, width);
3197 if (is_signed && val < 0)
3198 return decimal2str ("-", -val, width);
3200 return decimal2str ("", val, width);
3204 char *result = octal2str (val, width);
3206 if (use_c_format || val == 0)
3212 internal_error (__FILE__, __LINE__,
3213 _("failed internal consistency check"));
3217 /* Convert a CORE_ADDR into a string. */
3219 core_addr_to_string (const CORE_ADDR addr)
3221 char *str = get_cell ();
3224 strcat (str, phex (addr, sizeof (addr)));
3229 core_addr_to_string_nz (const CORE_ADDR addr)
3231 char *str = get_cell ();
3234 strcat (str, phex_nz (addr, sizeof (addr)));
3238 /* Convert a string back into a CORE_ADDR. */
3240 string_to_core_addr (const char *my_string)
3244 if (my_string[0] == '0' && tolower (my_string[1]) == 'x')
3246 /* Assume that it is in hex. */
3249 for (i = 2; my_string[i] != '\0'; i++)
3251 if (isdigit (my_string[i]))
3252 addr = (my_string[i] - '0') + (addr * 16);
3253 else if (isxdigit (my_string[i]))
3254 addr = (tolower (my_string[i]) - 'a' + 0xa) + (addr * 16);
3256 error (_("invalid hex \"%s\""), my_string);
3261 /* Assume that it is in decimal. */
3264 for (i = 0; my_string[i] != '\0'; i++)
3266 if (isdigit (my_string[i]))
3267 addr = (my_string[i] - '0') + (addr * 10);
3269 error (_("invalid decimal \"%s\""), my_string);
3277 host_address_to_string (const void *addr)
3279 char *str = get_cell ();
3281 xsnprintf (str, CELLSIZE, "0x%s", phex_nz ((uintptr_t) addr, sizeof (addr)));
3286 gdb_realpath (const char *filename)
3288 /* Method 1: The system has a compile time upper bound on a filename
3289 path. Use that and realpath() to canonicalize the name. This is
3290 the most common case. Note that, if there isn't a compile time
3291 upper bound, you want to avoid realpath() at all costs. */
3292 #if defined(HAVE_REALPATH)
3294 # if defined (PATH_MAX)
3296 # define USE_REALPATH
3297 # elif defined (MAXPATHLEN)
3298 char buf[MAXPATHLEN];
3299 # define USE_REALPATH
3301 # if defined (USE_REALPATH)
3302 const char *rp = realpath (filename, buf);
3306 return xstrdup (rp);
3309 #endif /* HAVE_REALPATH */
3311 /* Method 2: The host system (i.e., GNU) has the function
3312 canonicalize_file_name() which malloc's a chunk of memory and
3313 returns that, use that. */
3314 #if defined(HAVE_CANONICALIZE_FILE_NAME)
3316 char *rp = canonicalize_file_name (filename);
3319 return xstrdup (filename);
3325 /* FIXME: cagney/2002-11-13:
3327 Method 2a: Use realpath() with a NULL buffer. Some systems, due
3328 to the problems described in method 3, have modified their
3329 realpath() implementation so that it will allocate a buffer when
3330 NULL is passed in. Before this can be used, though, some sort of
3331 configure time test would need to be added. Otherwize the code
3332 will likely core dump. */
3334 /* Method 3: Now we're getting desperate! The system doesn't have a
3335 compile time buffer size and no alternative function. Query the
3336 OS, using pathconf(), for the buffer limit. Care is needed
3337 though, some systems do not limit PATH_MAX (return -1 for
3338 pathconf()) making it impossible to pass a correctly sized buffer
3339 to realpath() (it could always overflow). On those systems, we
3341 #if defined (HAVE_REALPATH) && defined (HAVE_UNISTD_H) && defined(HAVE_ALLOCA)
3343 /* Find out the max path size. */
3344 long path_max = pathconf ("/", _PC_PATH_MAX);
3348 /* PATH_MAX is bounded. */
3349 char *buf = alloca (path_max);
3350 char *rp = realpath (filename, buf);
3352 return xstrdup (rp ? rp : filename);
3357 /* This system is a lost cause, just dup the buffer. */
3358 return xstrdup (filename);
3361 /* Return a copy of FILENAME, with its directory prefix canonicalized
3365 xfullpath (const char *filename)
3367 const char *base_name = lbasename (filename);
3372 /* Extract the basename of filename, and return immediately
3373 a copy of filename if it does not contain any directory prefix. */
3374 if (base_name == filename)
3375 return xstrdup (filename);
3377 dir_name = alloca ((size_t) (base_name - filename + 2));
3378 /* Allocate enough space to store the dir_name + plus one extra
3379 character sometimes needed under Windows (see below), and
3380 then the closing \000 character. */
3381 strncpy (dir_name, filename, base_name - filename);
3382 dir_name[base_name - filename] = '\000';
3384 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3385 /* We need to be careful when filename is of the form 'd:foo', which
3386 is equivalent of d:./foo, which is totally different from d:/foo. */
3387 if (strlen (dir_name) == 2 && isalpha (dir_name[0]) && dir_name[1] == ':')
3390 dir_name[3] = '\000';
3394 /* Canonicalize the directory prefix, and build the resulting
3395 filename. If the dirname realpath already contains an ending
3396 directory separator, avoid doubling it. */
3397 real_path = gdb_realpath (dir_name);
3398 if (IS_DIR_SEPARATOR (real_path[strlen (real_path) - 1]))
3399 result = concat (real_path, base_name, (char *) NULL);
3401 result = concat (real_path, SLASH_STRING, base_name, (char *) NULL);
3408 /* This is the 32-bit CRC function used by the GNU separate debug
3409 facility. An executable may contain a section named
3410 .gnu_debuglink, which holds the name of a separate executable file
3411 containing its debug info, and a checksum of that file's contents,
3412 computed using this function. */
3414 gnu_debuglink_crc32 (unsigned long crc, unsigned char *buf, size_t len)
3416 static const unsigned int crc32_table[256] = {
3417 0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419,
3418 0x706af48f, 0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4,
3419 0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07,
3420 0x90bf1d91, 0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de,
3421 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7, 0x136c9856,
3422 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
3423 0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4,
3424 0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b,
3425 0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3,
3426 0x45df5c75, 0xdcd60dcf, 0xabd13d59, 0x26d930ac, 0x51de003a,
3427 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599,
3428 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
3429 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190,
3430 0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f,
3431 0x9fbfe4a5, 0xe8b8d433, 0x7807c9a2, 0x0f00f934, 0x9609a88e,
3432 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01,
3433 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed,
3434 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
3435 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3,
3436 0xfbd44c65, 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2,
3437 0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a,
3438 0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5,
3439 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa, 0xbe0b1010,
3440 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
3441 0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17,
3442 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6,
3443 0x03b6e20c, 0x74b1d29a, 0xead54739, 0x9dd277af, 0x04db2615,
3444 0x73dc1683, 0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8,
3445 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1, 0xf00f9344,
3446 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
3447 0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a,
3448 0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5,
3449 0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1,
3450 0xa6bc5767, 0x3fb506dd, 0x48b2364b, 0xd80d2bda, 0xaf0a1b4c,
3451 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef,
3452 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
3453 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe,
3454 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31,
3455 0x2cd99e8b, 0x5bdeae1d, 0x9b64c2b0, 0xec63f226, 0x756aa39c,
3456 0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713,
3457 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 0x92d28e9b,
3458 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
3459 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1,
3460 0x18b74777, 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c,
3461 0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45, 0xa00ae278,
3462 0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7,
3463 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc, 0x40df0b66,
3464 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
3465 0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605,
3466 0xcdd70693, 0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8,
3467 0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b,
3472 crc = ~crc & 0xffffffff;
3473 for (end = buf + len; buf < end; ++buf)
3474 crc = crc32_table[(crc ^ *buf) & 0xff] ^ (crc >> 8);
3475 return ~crc & 0xffffffff;
3479 align_up (ULONGEST v, int n)
3481 /* Check that N is really a power of two. */
3482 gdb_assert (n && (n & (n-1)) == 0);
3483 return (v + n - 1) & -n;
3487 align_down (ULONGEST v, int n)
3489 /* Check that N is really a power of two. */
3490 gdb_assert (n && (n & (n-1)) == 0);
3494 /* Allocation function for the libiberty hash table which uses an
3495 obstack. The obstack is passed as DATA. */
3498 hashtab_obstack_allocate (void *data, size_t size, size_t count)
3500 unsigned int total = size * count;
3501 void *ptr = obstack_alloc ((struct obstack *) data, total);
3503 memset (ptr, 0, total);
3507 /* Trivial deallocation function for the libiberty splay tree and hash
3508 table - don't deallocate anything. Rely on later deletion of the
3509 obstack. DATA will be the obstack, although it is not needed
3513 dummy_obstack_deallocate (void *object, void *data)
3518 /* The bit offset of the highest byte in a ULONGEST, for overflow
3521 #define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT)
3523 /* True (non-zero) iff DIGIT is a valid digit in radix BASE,
3524 where 2 <= BASE <= 36. */
3527 is_digit_in_base (unsigned char digit, int base)
3529 if (!isalnum (digit))
3532 return (isdigit (digit) && digit < base + '0');
3534 return (isdigit (digit) || tolower (digit) < base - 10 + 'a');
3538 digit_to_int (unsigned char c)
3543 return tolower (c) - 'a' + 10;
3546 /* As for strtoul, but for ULONGEST results. */
3549 strtoulst (const char *num, const char **trailer, int base)
3551 unsigned int high_part;
3556 /* Skip leading whitespace. */
3557 while (isspace (num[i]))
3560 /* Handle prefixes. */
3563 else if (num[i] == '-')
3569 if (base == 0 || base == 16)
3571 if (num[i] == '0' && (num[i + 1] == 'x' || num[i + 1] == 'X'))
3579 if (base == 0 && num[i] == '0')
3585 if (base < 2 || base > 36)
3591 result = high_part = 0;
3592 for (; is_digit_in_base (num[i], base); i += 1)
3594 result = result * base + digit_to_int (num[i]);
3595 high_part = high_part * base + (unsigned int) (result >> HIGH_BYTE_POSN);
3596 result &= ((ULONGEST) 1 << HIGH_BYTE_POSN) - 1;
3597 if (high_part > 0xff)
3600 result = ~ (ULONGEST) 0;
3607 if (trailer != NULL)
3610 result = result + ((ULONGEST) high_part << HIGH_BYTE_POSN);
3617 /* Simple, portable version of dirname that does not modify its
3621 ldirname (const char *filename)
3623 const char *base = lbasename (filename);
3626 while (base > filename && IS_DIR_SEPARATOR (base[-1]))
3629 if (base == filename)
3632 dirname = xmalloc (base - filename + 2);
3633 memcpy (dirname, filename, base - filename);
3635 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3636 create "d:./bar" later instead of the (different) "d:/bar". */
3637 if (base - filename == 2 && IS_ABSOLUTE_PATH (base)
3638 && !IS_DIR_SEPARATOR (filename[0]))
3639 dirname[base++ - filename] = '.';
3641 dirname[base - filename] = '\0';
3645 /* Call libiberty's buildargv, and return the result.
3646 If buildargv fails due to out-of-memory, call nomem.
3647 Therefore, the returned value is guaranteed to be non-NULL,
3648 unless the parameter itself is NULL. */
3651 gdb_buildargv (const char *s)
3653 char **argv = buildargv (s);
3655 if (s != NULL && argv == NULL)
3661 compare_positive_ints (const void *ap, const void *bp)
3663 /* Because we know we're comparing two ints which are positive,
3664 there's no danger of overflow here. */
3665 return * (int *) ap - * (int *) bp;
3668 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3669 #define AMBIGUOUS_MESS2 \
3670 ".\nUse \"set gnutarget format-name\" to specify the format."
3673 gdb_bfd_errmsg (bfd_error_type error_tag, char **matching)
3679 /* Check if errmsg just need simple return. */
3680 if (error_tag != bfd_error_file_ambiguously_recognized || matching == NULL)
3681 return bfd_errmsg (error_tag);
3683 ret_len = strlen (bfd_errmsg (error_tag)) + strlen (AMBIGUOUS_MESS1)
3684 + strlen (AMBIGUOUS_MESS2);
3685 for (p = matching; *p; p++)
3686 ret_len += strlen (*p) + 1;
3687 ret = xmalloc (ret_len + 1);
3689 make_cleanup (xfree, ret);
3691 strcpy (retp, bfd_errmsg (error_tag));
3692 retp += strlen (retp);
3694 strcpy (retp, AMBIGUOUS_MESS1);
3695 retp += strlen (retp);
3697 for (p = matching; *p; p++)
3699 sprintf (retp, " %s", *p);
3700 retp += strlen (retp);
3704 strcpy (retp, AMBIGUOUS_MESS2);
3709 /* Return ARGS parsed as a valid pid, or throw an error. */
3712 parse_pid_to_attach (char *args)
3718 error_no_arg (_("process-id to attach"));
3721 pid = strtoul (args, &dummy, 0);
3722 /* Some targets don't set errno on errors, grrr! */
3723 if ((pid == 0 && dummy == args) || dummy != &args[strlen (args)])
3724 error (_("Illegal process-id: %s."), args);
3729 /* Helper for make_bpstat_clear_actions_cleanup. */
3732 do_bpstat_clear_actions_cleanup (void *unused)
3734 bpstat_clear_actions ();
3737 /* Call bpstat_clear_actions for the case an exception is throw. You should
3738 discard_cleanups if no exception is caught. */
3741 make_bpstat_clear_actions_cleanup (void)
3743 return make_cleanup (do_bpstat_clear_actions_cleanup, NULL);
3746 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3747 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3748 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3751 producer_is_gcc_ge_4 (const char *producer)
3756 if (producer == NULL)
3758 /* For unknown compilers expect their behavior is not compliant. For GCC
3759 this case can also happen for -gdwarf-4 type units supported since
3765 /* Skip any identifier after "GNU " - such as "C++" or "Java". */
3767 if (strncmp (producer, "GNU ", strlen ("GNU ")) != 0)
3769 /* For non-GCC compilers expect their behavior is not compliant. */
3773 cs = &producer[strlen ("GNU ")];
3774 while (*cs && !isdigit (*cs))
3776 if (sscanf (cs, "%d.%d", &major, &minor) != 2)
3778 /* Not recognized as GCC. */
3790 /* Provide a prototype to silence -Wmissing-prototypes. */
3791 extern initialize_file_ftype _initialize_utils;
3794 _initialize_utils (void)
3796 add_internal_problem_command (&internal_error_problem);
3797 add_internal_problem_command (&internal_warning_problem);