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 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 "gdb_assert.h"
25 #include "gdb_string.h"
26 #include "event-top.h"
27 #include "exceptions.h"
28 #include "gdbthread.h"
31 #include "tui/tui.h" /* For tui_get_command_dimension. */
38 /* SunOS's curses.h has a '#define reg register' in it. Thank you Sun. */
49 #include "expression.h"
53 #include "filenames.h"
55 #include "gdb_obstack.h"
59 #include "inferior.h" /* for signed_pointer_to_address */
61 #include <sys/param.h> /* For MAXPATHLEN */
63 #include "gdb_curses.h"
65 #include "readline/readline.h"
71 extern PTR malloc (); /* OK: PTR */
73 #if !HAVE_DECL_REALLOC
74 extern PTR realloc (); /* OK: PTR */
80 /* readline defines this. */
83 void (*deprecated_error_begin_hook) (void);
85 /* Prototypes for local functions */
87 static void vfprintf_maybe_filtered (struct ui_file *, const char *,
88 va_list, int) ATTR_FORMAT (printf, 2, 0);
90 static void fputs_maybe_filtered (const char *, struct ui_file *, int);
92 static void do_my_cleanups (struct cleanup **, struct cleanup *);
94 static void prompt_for_continue (void);
96 static void set_screen_size (void);
97 static void set_width (void);
99 /* A flag indicating whether to timestamp debugging messages. */
101 static int debug_timestamp = 0;
103 /* Chain of cleanup actions established with make_cleanup,
104 to be executed if an error happens. */
106 static struct cleanup *cleanup_chain; /* cleaned up after a failed command */
107 static struct cleanup *final_cleanup_chain; /* cleaned up when gdb exits */
109 /* Nonzero if we have job control. */
113 /* Nonzero means a quit has been requested. */
117 /* Nonzero means quit immediately if Control-C is typed now, rather
118 than waiting until QUIT is executed. Be careful in setting this;
119 code which executes with immediate_quit set has to be very careful
120 about being able to deal with being interrupted at any time. It is
121 almost always better to use QUIT; the only exception I can think of
122 is being able to quit out of a system call (using EINTR loses if
123 the SIGINT happens between the previous QUIT and the system call).
124 To immediately quit in the case in which a SIGINT happens between
125 the previous QUIT and setting immediate_quit (desirable anytime we
126 expect to block), call QUIT after setting immediate_quit. */
130 /* Nonzero means that encoded C++/ObjC names should be printed out in their
131 C++/ObjC form rather than raw. */
135 show_demangle (struct ui_file *file, int from_tty,
136 struct cmd_list_element *c, const char *value)
138 fprintf_filtered (file, _("\
139 Demangling of encoded C++/ObjC names when displaying symbols is %s.\n"),
143 /* Nonzero means that encoded C++/ObjC names should be printed out in their
144 C++/ObjC form even in assembler language displays. If this is set, but
145 DEMANGLE is zero, names are printed raw, i.e. DEMANGLE controls. */
147 int asm_demangle = 0;
149 show_asm_demangle (struct ui_file *file, int from_tty,
150 struct cmd_list_element *c, const char *value)
152 fprintf_filtered (file, _("\
153 Demangling of C++/ObjC names in disassembly listings is %s.\n"),
157 /* Nonzero means that strings with character values >0x7F should be printed
158 as octal escapes. Zero means just print the value (e.g. it's an
159 international character, and the terminal or window can cope.) */
161 int sevenbit_strings = 0;
163 show_sevenbit_strings (struct ui_file *file, int from_tty,
164 struct cmd_list_element *c, const char *value)
166 fprintf_filtered (file, _("\
167 Printing of 8-bit characters in strings as \\nnn is %s.\n"),
171 /* String to be printed before error messages, if any. */
173 char *error_pre_print;
175 /* String to be printed before quit messages, if any. */
177 char *quit_pre_print;
179 /* String to be printed before warning messages, if any. */
181 char *warning_pre_print = "\nwarning: ";
183 int pagination_enabled = 1;
185 show_pagination_enabled (struct ui_file *file, int from_tty,
186 struct cmd_list_element *c, const char *value)
188 fprintf_filtered (file, _("State of pagination is %s.\n"), value);
193 /* Add a new cleanup to the cleanup_chain,
194 and return the previous chain pointer
195 to be passed later to do_cleanups or discard_cleanups.
196 Args are FUNCTION to clean up with, and ARG to pass to it. */
199 make_cleanup (make_cleanup_ftype *function, void *arg)
201 return make_my_cleanup (&cleanup_chain, function, arg);
205 make_cleanup_dtor (make_cleanup_ftype *function, void *arg,
206 void (*dtor) (void *))
208 return make_my_cleanup2 (&cleanup_chain,
209 function, arg, dtor);
213 make_final_cleanup (make_cleanup_ftype *function, void *arg)
215 return make_my_cleanup (&final_cleanup_chain, function, arg);
219 do_freeargv (void *arg)
221 freeargv ((char **) arg);
225 make_cleanup_freeargv (char **arg)
227 return make_my_cleanup (&cleanup_chain, do_freeargv, arg);
231 do_bfd_close_cleanup (void *arg)
237 make_cleanup_bfd_close (bfd *abfd)
239 return make_cleanup (do_bfd_close_cleanup, abfd);
243 do_close_cleanup (void *arg)
250 make_cleanup_close (int fd)
252 int *saved_fd = xmalloc (sizeof (fd));
254 return make_cleanup_dtor (do_close_cleanup, saved_fd, xfree);
257 /* Helper function which does the work for make_cleanup_fclose. */
260 do_fclose_cleanup (void *arg)
266 /* Return a new cleanup that closes FILE. */
269 make_cleanup_fclose (FILE *file)
271 return make_cleanup (do_fclose_cleanup, file);
274 /* Helper function which does the work for make_cleanup_obstack_free. */
277 do_obstack_free (void *arg)
279 struct obstack *ob = arg;
280 obstack_free (ob, NULL);
283 /* Return a new cleanup that frees OBSTACK. */
286 make_cleanup_obstack_free (struct obstack *obstack)
288 return make_cleanup (do_obstack_free, obstack);
292 do_ui_file_delete (void *arg)
294 ui_file_delete (arg);
298 make_cleanup_ui_file_delete (struct ui_file *arg)
300 return make_my_cleanup (&cleanup_chain, do_ui_file_delete, arg);
304 do_free_section_addr_info (void *arg)
306 free_section_addr_info (arg);
310 make_cleanup_free_section_addr_info (struct section_addr_info *addrs)
312 return make_my_cleanup (&cleanup_chain, do_free_section_addr_info, addrs);
315 struct restore_integer_closure
322 restore_integer (void *p)
324 struct restore_integer_closure *closure = p;
325 *(closure->variable) = closure->value;
328 /* Remember the current value of *VARIABLE and make it restored when the cleanup
331 make_cleanup_restore_integer (int *variable)
333 struct restore_integer_closure *c =
334 xmalloc (sizeof (struct restore_integer_closure));
335 c->variable = variable;
336 c->value = *variable;
338 return make_my_cleanup2 (&cleanup_chain, restore_integer, (void *)c,
343 make_my_cleanup2 (struct cleanup **pmy_chain, make_cleanup_ftype *function,
344 void *arg, void (*free_arg) (void *))
347 = (struct cleanup *) xmalloc (sizeof (struct cleanup));
348 struct cleanup *old_chain = *pmy_chain;
350 new->next = *pmy_chain;
351 new->function = function;
352 new->free_arg = free_arg;
360 make_my_cleanup (struct cleanup **pmy_chain, make_cleanup_ftype *function,
363 return make_my_cleanup2 (pmy_chain, function, arg, NULL);
366 /* Discard cleanups and do the actions they describe
367 until we get back to the point OLD_CHAIN in the cleanup_chain. */
370 do_cleanups (struct cleanup *old_chain)
372 do_my_cleanups (&cleanup_chain, old_chain);
376 do_final_cleanups (struct cleanup *old_chain)
378 do_my_cleanups (&final_cleanup_chain, old_chain);
382 do_my_cleanups (struct cleanup **pmy_chain,
383 struct cleanup *old_chain)
386 while ((ptr = *pmy_chain) != old_chain)
388 *pmy_chain = ptr->next; /* Do this first incase recursion */
389 (*ptr->function) (ptr->arg);
391 (*ptr->free_arg) (ptr->arg);
396 /* Discard cleanups, not doing the actions they describe,
397 until we get back to the point OLD_CHAIN in the cleanup_chain. */
400 discard_cleanups (struct cleanup *old_chain)
402 discard_my_cleanups (&cleanup_chain, old_chain);
406 discard_final_cleanups (struct cleanup *old_chain)
408 discard_my_cleanups (&final_cleanup_chain, old_chain);
412 discard_my_cleanups (struct cleanup **pmy_chain,
413 struct cleanup *old_chain)
416 while ((ptr = *pmy_chain) != old_chain)
418 *pmy_chain = ptr->next;
420 (*ptr->free_arg) (ptr->arg);
425 /* Set the cleanup_chain to 0, and return the old cleanup chain. */
429 return save_my_cleanups (&cleanup_chain);
433 save_final_cleanups (void)
435 return save_my_cleanups (&final_cleanup_chain);
439 save_my_cleanups (struct cleanup **pmy_chain)
441 struct cleanup *old_chain = *pmy_chain;
447 /* Restore the cleanup chain from a previously saved chain. */
449 restore_cleanups (struct cleanup *chain)
451 restore_my_cleanups (&cleanup_chain, chain);
455 restore_final_cleanups (struct cleanup *chain)
457 restore_my_cleanups (&final_cleanup_chain, chain);
461 restore_my_cleanups (struct cleanup **pmy_chain, struct cleanup *chain)
466 /* This function is useful for cleanups.
470 old_chain = make_cleanup (free_current_contents, &foo);
472 to arrange to free the object thus allocated. */
475 free_current_contents (void *ptr)
477 void **location = ptr;
478 if (location == NULL)
479 internal_error (__FILE__, __LINE__,
480 _("free_current_contents: NULL pointer"));
481 if (*location != NULL)
488 /* Provide a known function that does nothing, to use as a base for
489 for a possibly long chain of cleanups. This is useful where we
490 use the cleanup chain for handling normal cleanups as well as dealing
491 with cleanups that need to be done as a result of a call to error().
492 In such cases, we may not be certain where the first cleanup is, unless
493 we have a do-nothing one to always use as the base. */
496 null_cleanup (void *arg)
500 /* Continuations are implemented as cleanups internally. Inherit from
507 /* Add a continuation to the continuation list of THREAD. The new
508 continuation will be added at the front. */
510 add_continuation (struct thread_info *thread,
511 void (*continuation_hook) (void *), void *args,
512 void (*continuation_free_args) (void *))
514 struct cleanup *as_cleanup = &thread->continuations->base;
515 make_cleanup_ftype *continuation_hook_fn = continuation_hook;
517 make_my_cleanup2 (&as_cleanup,
518 continuation_hook_fn,
520 continuation_free_args);
522 thread->continuations = (struct continuation *) as_cleanup;
525 /* Add a continuation to the continuation list of INFERIOR. The new
526 continuation will be added at the front. */
529 add_inferior_continuation (void (*continuation_hook) (void *), void *args,
530 void (*continuation_free_args) (void *))
532 struct inferior *inf = current_inferior ();
533 struct cleanup *as_cleanup = &inf->continuations->base;
534 make_cleanup_ftype *continuation_hook_fn = continuation_hook;
536 make_my_cleanup2 (&as_cleanup,
537 continuation_hook_fn,
539 continuation_free_args);
541 inf->continuations = (struct continuation *) as_cleanup;
544 /* Do all continuations of the current inferior. */
547 do_all_inferior_continuations (void)
549 struct cleanup *old_chain;
550 struct cleanup *as_cleanup;
551 struct inferior *inf = current_inferior ();
553 if (inf->continuations == NULL)
556 /* Copy the list header into another pointer, and set the global
557 list header to null, so that the global list can change as a side
558 effect of invoking the continuations and the processing of the
559 preexisting continuations will not be affected. */
561 as_cleanup = &inf->continuations->base;
562 inf->continuations = NULL;
564 /* Work now on the list we have set aside. */
565 do_my_cleanups (&as_cleanup, NULL);
568 /* Get rid of all the inferior-wide continuations of INF. */
571 discard_all_inferior_continuations (struct inferior *inf)
573 struct cleanup *continuation_ptr = &inf->continuations->base;
574 discard_my_cleanups (&continuation_ptr, NULL);
575 inf->continuations = NULL;
579 restore_thread_cleanup (void *arg)
581 ptid_t *ptid_p = arg;
582 switch_to_thread (*ptid_p);
585 /* Walk down the continuation list of PTID, and execute all the
586 continuations. There is a problem though. In some cases new
587 continuations may be added while we are in the middle of this loop.
588 If this happens they will be added in the front, and done before we
589 have a chance of exhausting those that were already there. We need
590 to then save the beginning of the list in a pointer and do the
591 continuations from there on, instead of using the global beginning
592 of list as our iteration pointer. */
594 do_all_continuations_ptid (ptid_t ptid,
595 struct continuation **continuations_p)
597 struct cleanup *old_chain;
598 ptid_t current_thread;
599 struct cleanup *as_cleanup;
601 if (*continuations_p == NULL)
604 current_thread = inferior_ptid;
606 /* Restore selected thread on exit. Don't try to restore the frame
609 - When running continuations, the selected frame is always #0.
611 - The continuations may trigger symbol file loads, which may
612 change the frame layout (frame ids change), which would trigger
613 a warning if we used make_cleanup_restore_current_thread. */
615 old_chain = make_cleanup (restore_thread_cleanup, ¤t_thread);
617 /* Let the continuation see this thread as selected. */
618 switch_to_thread (ptid);
620 /* Copy the list header into another pointer, and set the global
621 list header to null, so that the global list can change as a side
622 effect of invoking the continuations and the processing of the
623 preexisting continuations will not be affected. */
625 as_cleanup = &(*continuations_p)->base;
626 *continuations_p = NULL;
628 /* Work now on the list we have set aside. */
629 do_my_cleanups (&as_cleanup, NULL);
631 do_cleanups (old_chain);
634 /* Callback for iterate over threads. */
636 do_all_continuations_thread_callback (struct thread_info *thread, void *data)
638 do_all_continuations_ptid (thread->ptid, &thread->continuations);
642 /* Do all continuations of thread THREAD. */
644 do_all_continuations_thread (struct thread_info *thread)
646 do_all_continuations_thread_callback (thread, NULL);
649 /* Do all continuations of all threads. */
651 do_all_continuations (void)
653 iterate_over_threads (do_all_continuations_thread_callback, NULL);
656 /* Callback for iterate over threads. */
658 discard_all_continuations_thread_callback (struct thread_info *thread,
661 struct cleanup *continuation_ptr = &thread->continuations->base;
662 discard_my_cleanups (&continuation_ptr, NULL);
663 thread->continuations = NULL;
667 /* Get rid of all the continuations of THREAD. */
669 discard_all_continuations_thread (struct thread_info *thread)
671 discard_all_continuations_thread_callback (thread, NULL);
674 /* Get rid of all the continuations of all threads. */
676 discard_all_continuations (void)
678 iterate_over_threads (discard_all_continuations_thread_callback, NULL);
682 /* Add a continuation to the intermediate continuation list of THREAD.
683 The new continuation will be added at the front. */
685 add_intermediate_continuation (struct thread_info *thread,
686 void (*continuation_hook)
687 (void *), void *args,
688 void (*continuation_free_args) (void *))
690 struct cleanup *as_cleanup = &thread->intermediate_continuations->base;
691 make_cleanup_ftype *continuation_hook_fn = continuation_hook;
693 make_my_cleanup2 (&as_cleanup,
694 continuation_hook_fn,
696 continuation_free_args);
698 thread->intermediate_continuations = (struct continuation *) as_cleanup;
701 /* Walk down the cmd_continuation list, and execute all the
702 continuations. There is a problem though. In some cases new
703 continuations may be added while we are in the middle of this
704 loop. If this happens they will be added in the front, and done
705 before we have a chance of exhausting those that were already
706 there. We need to then save the beginning of the list in a pointer
707 and do the continuations from there on, instead of using the
708 global beginning of list as our iteration pointer.*/
710 do_all_intermediate_continuations_thread_callback (struct thread_info *thread,
713 do_all_continuations_ptid (thread->ptid,
714 &thread->intermediate_continuations);
718 /* Do all intermediate continuations of thread THREAD. */
720 do_all_intermediate_continuations_thread (struct thread_info *thread)
722 do_all_intermediate_continuations_thread_callback (thread, NULL);
725 /* Do all intermediate continuations of all threads. */
727 do_all_intermediate_continuations (void)
729 iterate_over_threads (do_all_intermediate_continuations_thread_callback, NULL);
732 /* Callback for iterate over threads. */
734 discard_all_intermediate_continuations_thread_callback (struct thread_info *thread,
737 struct cleanup *continuation_ptr = &thread->intermediate_continuations->base;
738 discard_my_cleanups (&continuation_ptr, NULL);
739 thread->intermediate_continuations = NULL;
743 /* Get rid of all the intermediate continuations of THREAD. */
745 discard_all_intermediate_continuations_thread (struct thread_info *thread)
747 discard_all_intermediate_continuations_thread_callback (thread, NULL);
750 /* Get rid of all the intermediate continuations of all threads. */
752 discard_all_intermediate_continuations (void)
754 iterate_over_threads (discard_all_intermediate_continuations_thread_callback, NULL);
759 /* Print a warning message. The first argument STRING is the warning
760 message, used as an fprintf format string, the second is the
761 va_list of arguments for that string. A warning is unfiltered (not
762 paginated) so that the user does not need to page through each
763 screen full of warnings when there are lots of them. */
766 vwarning (const char *string, va_list args)
768 if (deprecated_warning_hook)
769 (*deprecated_warning_hook) (string, args);
772 target_terminal_ours ();
773 wrap_here (""); /* Force out any buffered output */
774 gdb_flush (gdb_stdout);
775 if (warning_pre_print)
776 fputs_unfiltered (warning_pre_print, gdb_stderr);
777 vfprintf_unfiltered (gdb_stderr, string, args);
778 fprintf_unfiltered (gdb_stderr, "\n");
783 /* Print a warning message.
784 The first argument STRING is the warning message, used as a fprintf string,
785 and the remaining args are passed as arguments to it.
786 The primary difference between warnings and errors is that a warning
787 does not force the return to command level. */
790 warning (const char *string, ...)
793 va_start (args, string);
794 vwarning (string, args);
798 /* Print an error message and return to command level.
799 The first argument STRING is the error message, used as a fprintf string,
800 and the remaining args are passed as arguments to it. */
803 verror (const char *string, va_list args)
805 throw_verror (GENERIC_ERROR, string, args);
809 error (const char *string, ...)
812 va_start (args, string);
813 throw_verror (GENERIC_ERROR, string, args);
817 /* Print an error message and quit.
818 The first argument STRING is the error message, used as a fprintf string,
819 and the remaining args are passed as arguments to it. */
822 vfatal (const char *string, va_list args)
824 throw_vfatal (string, args);
828 fatal (const char *string, ...)
831 va_start (args, string);
832 throw_vfatal (string, args);
837 error_stream (struct ui_file *stream)
840 char *message = ui_file_xstrdup (stream, &len);
841 make_cleanup (xfree, message);
842 error (("%s"), message);
845 /* Allow the user to configure the debugger behavior with respect to
846 what to do when an internal problem is detected. */
848 const char internal_problem_ask[] = "ask";
849 const char internal_problem_yes[] = "yes";
850 const char internal_problem_no[] = "no";
851 static const char *internal_problem_modes[] =
853 internal_problem_ask,
854 internal_problem_yes,
858 static const char *internal_problem_mode = internal_problem_ask;
860 /* Print a message reporting an internal error/warning. Ask the user
861 if they want to continue, dump core, or just exit. Return
862 something to indicate a quit. */
864 struct internal_problem
867 const char *should_quit;
868 const char *should_dump_core;
871 /* Report a problem, internal to GDB, to the user. Once the problem
872 has been reported, and assuming GDB didn't quit, the caller can
873 either allow execution to resume or throw an error. */
875 static void ATTR_FORMAT (printf, 4, 0)
876 internal_vproblem (struct internal_problem *problem,
877 const char *file, int line, const char *fmt, va_list ap)
884 /* Don't allow infinite error/warning recursion. */
886 static char msg[] = "Recursive internal problem.\n";
894 fputs_unfiltered (msg, gdb_stderr);
895 abort (); /* NOTE: GDB has only four calls to abort(). */
898 /* Newer GLIBC versions put the warn_unused_result attribute
899 on write, but this is one of those rare cases where
900 ignoring the return value is correct. Casting to (void)
901 does not fix this problem. This is the solution suggested
902 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
903 if (write (STDERR_FILENO, msg, sizeof (msg)) != sizeof (msg))
904 abort (); /* NOTE: GDB has only four calls to abort(). */
909 /* Try to get the message out and at the start of a new line. */
910 target_terminal_ours ();
913 /* Create a string containing the full error/warning message. Need
914 to call query with this full string, as otherwize the reason
915 (error/warning) and question become separated. Format using a
916 style similar to a compiler error message. Include extra detail
917 so that the user knows that they are living on the edge. */
920 msg = xstrvprintf (fmt, ap);
921 reason = xstrprintf ("\
923 A problem internal to GDB has been detected,\n\
924 further debugging may prove unreliable.", file, line, problem->name, msg);
926 make_cleanup (xfree, reason);
929 if (problem->should_quit == internal_problem_ask)
931 /* Default (yes/batch case) is to quit GDB. When in batch mode
932 this lessens the likelihood of GDB going into an infinite
934 quit_p = query (_("%s\nQuit this debugging session? "), reason);
936 else if (problem->should_quit == internal_problem_yes)
938 else if (problem->should_quit == internal_problem_no)
941 internal_error (__FILE__, __LINE__, _("bad switch"));
943 if (problem->should_dump_core == internal_problem_ask)
945 /* Default (yes/batch case) is to dump core. This leaves a GDB
946 `dropping' so that it is easier to see that something went
948 dump_core_p = query (_("%s\nCreate a core file of GDB? "), reason);
950 else if (problem->should_dump_core == internal_problem_yes)
952 else if (problem->should_dump_core == internal_problem_no)
955 internal_error (__FILE__, __LINE__, _("bad switch"));
960 abort (); /* NOTE: GDB has only four calls to abort(). */
968 #ifdef HAVE_WORKING_FORK
970 abort (); /* NOTE: GDB has only four calls to abort(). */
978 static struct internal_problem internal_error_problem = {
979 "internal-error", internal_problem_ask, internal_problem_ask
983 internal_verror (const char *file, int line, const char *fmt, va_list ap)
985 internal_vproblem (&internal_error_problem, file, line, fmt, ap);
986 deprecated_throw_reason (RETURN_ERROR);
990 internal_error (const char *file, int line, const char *string, ...)
993 va_start (ap, string);
994 internal_verror (file, line, string, ap);
998 static struct internal_problem internal_warning_problem = {
999 "internal-warning", internal_problem_ask, internal_problem_ask
1003 internal_vwarning (const char *file, int line, const char *fmt, va_list ap)
1005 internal_vproblem (&internal_warning_problem, file, line, fmt, ap);
1009 internal_warning (const char *file, int line, const char *string, ...)
1012 va_start (ap, string);
1013 internal_vwarning (file, line, string, ap);
1017 /* Dummy functions to keep add_prefix_cmd happy. */
1020 set_internal_problem_cmd (char *args, int from_tty)
1025 show_internal_problem_cmd (char *args, int from_tty)
1029 /* When GDB reports an internal problem (error or warning) it gives
1030 the user the opportunity to quit GDB and/or create a core file of
1031 the current debug session. This function registers a few commands
1032 that make it possible to specify that GDB should always or never
1033 quit or create a core file, without asking. The commands look
1036 maint set PROBLEM-NAME quit ask|yes|no
1037 maint show PROBLEM-NAME quit
1038 maint set PROBLEM-NAME corefile ask|yes|no
1039 maint show PROBLEM-NAME corefile
1041 Where PROBLEM-NAME is currently "internal-error" or
1042 "internal-warning". */
1045 add_internal_problem_command (struct internal_problem *problem)
1047 struct cmd_list_element **set_cmd_list;
1048 struct cmd_list_element **show_cmd_list;
1052 set_cmd_list = xmalloc (sizeof (*set_cmd_list));
1053 show_cmd_list = xmalloc (sizeof (*set_cmd_list));
1054 *set_cmd_list = NULL;
1055 *show_cmd_list = NULL;
1057 set_doc = xstrprintf (_("Configure what GDB does when %s is detected."),
1060 show_doc = xstrprintf (_("Show what GDB does when %s is detected."),
1063 add_prefix_cmd ((char*) problem->name,
1064 class_maintenance, set_internal_problem_cmd, set_doc,
1066 concat ("maintenance set ", problem->name, " ", NULL),
1067 0/*allow-unknown*/, &maintenance_set_cmdlist);
1069 add_prefix_cmd ((char*) problem->name,
1070 class_maintenance, show_internal_problem_cmd, show_doc,
1072 concat ("maintenance show ", problem->name, " ", NULL),
1073 0/*allow-unknown*/, &maintenance_show_cmdlist);
1075 set_doc = xstrprintf (_("\
1076 Set whether GDB should quit when an %s is detected"),
1078 show_doc = xstrprintf (_("\
1079 Show whether GDB will quit when an %s is detected"),
1081 add_setshow_enum_cmd ("quit", class_maintenance,
1082 internal_problem_modes,
1083 &problem->should_quit,
1086 NULL, /* help_doc */
1088 NULL, /* showfunc */
1092 set_doc = xstrprintf (_("\
1093 Set whether GDB should create a core file of GDB when %s is detected"),
1095 show_doc = xstrprintf (_("\
1096 Show whether GDB will create a core file of GDB when %s is detected"),
1098 add_setshow_enum_cmd ("corefile", class_maintenance,
1099 internal_problem_modes,
1100 &problem->should_dump_core,
1103 NULL, /* help_doc */
1105 NULL, /* showfunc */
1110 /* Print the system error message for errno, and also mention STRING
1111 as the file name for which the error was encountered.
1112 Then return to command level. */
1115 perror_with_name (const char *string)
1120 err = safe_strerror (errno);
1121 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
1122 strcpy (combined, string);
1123 strcat (combined, ": ");
1124 strcat (combined, err);
1126 /* I understand setting these is a matter of taste. Still, some people
1127 may clear errno but not know about bfd_error. Doing this here is not
1129 bfd_set_error (bfd_error_no_error);
1132 error (_("%s."), combined);
1135 /* Print the system error message for ERRCODE, and also mention STRING
1136 as the file name for which the error was encountered. */
1139 print_sys_errmsg (const char *string, int errcode)
1144 err = safe_strerror (errcode);
1145 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
1146 strcpy (combined, string);
1147 strcat (combined, ": ");
1148 strcat (combined, err);
1150 /* We want anything which was printed on stdout to come out first, before
1152 gdb_flush (gdb_stdout);
1153 fprintf_unfiltered (gdb_stderr, "%s.\n", combined);
1156 /* Control C eventually causes this to be called, at a convenient time. */
1162 /* No steenking SIGINT will ever be coming our way when the
1163 program is resumed. Don't lie. */
1167 /* If there is no terminal switching for this target, then we can't
1168 possibly get screwed by the lack of job control. */
1169 || current_target.to_terminal_ours == NULL)
1172 fatal ("Quit (expect signal SIGINT when the program is resumed)");
1177 /* Called when a memory allocation fails, with the number of bytes of
1178 memory requested in SIZE. */
1185 internal_error (__FILE__, __LINE__,
1186 _("virtual memory exhausted: can't allocate %ld bytes."),
1191 internal_error (__FILE__, __LINE__, _("virtual memory exhausted."));
1195 /* The xmalloc() (libiberty.h) family of memory management routines.
1197 These are like the ISO-C malloc() family except that they implement
1198 consistent semantics and guard against typical memory management
1201 /* NOTE: These are declared using PTR to ensure consistency with
1202 "libiberty.h". xfree() is GDB local. */
1205 xmalloc (size_t size)
1209 /* See libiberty/xmalloc.c. This function need's to match that's
1210 semantics. It never returns NULL. */
1214 val = malloc (size); /* OK: malloc */
1222 xzalloc (size_t size)
1224 return xcalloc (1, size);
1228 xrealloc (PTR ptr, size_t size) /* OK: PTR */
1232 /* See libiberty/xmalloc.c. This function need's to match that's
1233 semantics. It never returns NULL. */
1238 val = realloc (ptr, size); /* OK: realloc */
1240 val = malloc (size); /* OK: malloc */
1248 xcalloc (size_t number, size_t size)
1252 /* See libiberty/xmalloc.c. This function need's to match that's
1253 semantics. It never returns NULL. */
1254 if (number == 0 || size == 0)
1260 mem = calloc (number, size); /* OK: xcalloc */
1262 nomem (number * size);
1271 free (ptr); /* OK: free */
1275 /* Like asprintf/vasprintf but get an internal_error if the call
1279 xstrprintf (const char *format, ...)
1283 va_start (args, format);
1284 ret = xstrvprintf (format, args);
1290 xasprintf (char **ret, const char *format, ...)
1293 va_start (args, format);
1294 (*ret) = xstrvprintf (format, args);
1299 xvasprintf (char **ret, const char *format, va_list ap)
1301 (*ret) = xstrvprintf (format, ap);
1305 xstrvprintf (const char *format, va_list ap)
1308 int status = vasprintf (&ret, format, ap);
1309 /* NULL is returned when there was a memory allocation problem, or
1310 any other error (for instance, a bad format string). A negative
1311 status (the printed length) with a non-NULL buffer should never
1312 happen, but just to be sure. */
1313 if (ret == NULL || status < 0)
1314 internal_error (__FILE__, __LINE__, _("vasprintf call failed"));
1319 xsnprintf (char *str, size_t size, const char *format, ...)
1324 va_start (args, format);
1325 ret = vsnprintf (str, size, format, args);
1326 gdb_assert (ret < size);
1332 /* My replacement for the read system call.
1333 Used like `read' but keeps going if `read' returns too soon. */
1336 myread (int desc, char *addr, int len)
1343 val = read (desc, addr, len);
1347 return orglen - len;
1354 /* Make a copy of the string at PTR with SIZE characters
1355 (and add a null character at the end in the copy).
1356 Uses malloc to get the space. Returns the address of the copy. */
1359 savestring (const char *ptr, size_t size)
1361 char *p = (char *) xmalloc (size + 1);
1362 memcpy (p, ptr, size);
1368 print_spaces (int n, struct ui_file *file)
1370 fputs_unfiltered (n_spaces (n), file);
1373 /* Print a host address. */
1376 gdb_print_host_address (const void *addr, struct ui_file *stream)
1378 fprintf_filtered (stream, "%s", host_address_to_string (addr));
1382 /* This function supports the query, nquery, and yquery functions.
1383 Ask user a y-or-n question and return 0 if answer is no, 1 if
1384 answer is yes, or default the answer to the specified default
1385 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1386 default answer, or '\0' for no default.
1387 CTLSTR is the control string and should end in "? ". It should
1388 not say how to answer, because we do that.
1389 ARGS are the arguments passed along with the CTLSTR argument to
1392 static int ATTR_FORMAT (printf, 1, 0)
1393 defaulted_query (const char *ctlstr, const char defchar, va_list args)
1399 char def_answer, not_def_answer;
1400 char *y_string, *n_string, *question;
1402 /* Set up according to which answer is the default. */
1403 if (defchar == '\0')
1407 not_def_answer = 'N';
1411 else if (defchar == 'y')
1415 not_def_answer = 'N';
1423 not_def_answer = 'Y';
1428 /* Automatically answer the default value if the user did not want
1433 /* If input isn't coming from the user directly, just say what
1434 question we're asking, and then answer "yes" automatically. This
1435 way, important error messages don't get lost when talking to GDB
1437 if (! input_from_terminal_p ())
1440 vfprintf_filtered (gdb_stdout, ctlstr, args);
1442 printf_filtered (_("(%s or %s) [answered %c; input not from terminal]\n"),
1443 y_string, n_string, def_answer);
1444 gdb_flush (gdb_stdout);
1449 /* Automatically answer the default value if input is not from the user
1450 directly, or if the user did not want prompts. */
1451 if (!input_from_terminal_p () || !caution)
1454 if (deprecated_query_hook)
1456 return deprecated_query_hook (ctlstr, args);
1459 /* Format the question outside of the loop, to avoid reusing args. */
1460 question = xstrvprintf (ctlstr, args);
1464 wrap_here (""); /* Flush any buffered output */
1465 gdb_flush (gdb_stdout);
1467 if (annotation_level > 1)
1468 printf_filtered (("\n\032\032pre-query\n"));
1470 fputs_filtered (question, gdb_stdout);
1471 printf_filtered (_("(%s or %s) "), y_string, n_string);
1473 if (annotation_level > 1)
1474 printf_filtered (("\n\032\032query\n"));
1477 gdb_flush (gdb_stdout);
1479 answer = fgetc (stdin);
1480 clearerr (stdin); /* in case of C-d */
1481 if (answer == EOF) /* C-d */
1483 printf_filtered ("EOF [assumed %c]\n", def_answer);
1487 /* Eat rest of input line, to EOF or newline */
1491 ans2 = fgetc (stdin);
1494 while (ans2 != EOF && ans2 != '\n' && ans2 != '\r');
1498 /* Check answer. For the non-default, the user must specify
1499 the non-default explicitly. */
1500 if (answer == not_def_answer)
1502 retval = !def_value;
1505 /* Otherwise, if a default was specified, the user may either
1506 specify the required input or have it default by entering
1508 if (answer == def_answer
1509 || (defchar != '\0' &&
1510 (answer == '\n' || answer == '\r' || answer == EOF)))
1515 /* Invalid entries are not defaulted and require another selection. */
1516 printf_filtered (_("Please answer %s or %s.\n"),
1517 y_string, n_string);
1521 if (annotation_level > 1)
1522 printf_filtered (("\n\032\032post-query\n"));
1527 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1528 answer is yes, or 0 if answer is defaulted.
1529 Takes three args which are given to printf to print the question.
1530 The first, a control string, should end in "? ".
1531 It should not say how to answer, because we do that. */
1534 nquery (const char *ctlstr, ...)
1538 va_start (args, ctlstr);
1539 return defaulted_query (ctlstr, 'n', args);
1543 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1544 answer is yes, or 1 if answer is defaulted.
1545 Takes three args which are given to printf to print the question.
1546 The first, a control string, should end in "? ".
1547 It should not say how to answer, because we do that. */
1550 yquery (const char *ctlstr, ...)
1554 va_start (args, ctlstr);
1555 return defaulted_query (ctlstr, 'y', args);
1559 /* Ask user a y-or-n question and return 1 iff answer is yes.
1560 Takes three args which are given to printf to print the question.
1561 The first, a control string, should end in "? ".
1562 It should not say how to answer, because we do that. */
1565 query (const char *ctlstr, ...)
1569 va_start (args, ctlstr);
1570 return defaulted_query (ctlstr, '\0', args);
1574 /* A helper for parse_escape that converts a host character to a
1575 target character. C is the host character. If conversion is
1576 possible, then the target character is stored in *TARGET_C and the
1577 function returns 1. Otherwise, the function returns 0. */
1580 host_char_to_target (int c, int *target_c)
1582 struct obstack host_data;
1584 struct cleanup *cleanups;
1587 obstack_init (&host_data);
1588 cleanups = make_cleanup_obstack_free (&host_data);
1590 convert_between_encodings (target_charset (), host_charset (),
1591 &the_char, 1, 1, &host_data, translit_none);
1593 if (obstack_object_size (&host_data) == 1)
1596 *target_c = *(char *) obstack_base (&host_data);
1599 do_cleanups (cleanups);
1603 /* Parse a C escape sequence. STRING_PTR points to a variable
1604 containing a pointer to the string to parse. That pointer
1605 should point to the character after the \. That pointer
1606 is updated past the characters we use. The value of the
1607 escape sequence is returned.
1609 A negative value means the sequence \ newline was seen,
1610 which is supposed to be equivalent to nothing at all.
1612 If \ is followed by a null character, we return a negative
1613 value and leave the string pointer pointing at the null character.
1615 If \ is followed by 000, we return 0 and leave the string pointer
1616 after the zeros. A value of 0 does not mean end of string. */
1619 parse_escape (char **string_ptr)
1622 int c = *(*string_ptr)++;
1640 int i = host_hex_value (c);
1645 if (isdigit (c) && c != '8' && c != '9')
1649 i += host_hex_value (c);
1685 if (!host_char_to_target (c, &target_char))
1687 ("The escape sequence `\%c' is equivalent to plain `%c', which"
1688 " has no equivalent\n" "in the `%s' character set.", c, c,
1693 /* Print the character C on STREAM as part of the contents of a literal
1694 string whose delimiter is QUOTER. Note that this routine should only
1695 be call for printing things which are independent of the language
1696 of the program being debugged. */
1699 printchar (int c, void (*do_fputs) (const char *, struct ui_file *),
1700 void (*do_fprintf) (struct ui_file *, const char *, ...)
1701 ATTRIBUTE_FPTR_PRINTF_2, struct ui_file *stream, int quoter)
1704 c &= 0xFF; /* Avoid sign bit follies */
1706 if (c < 0x20 || /* Low control chars */
1707 (c >= 0x7F && c < 0xA0) || /* DEL, High controls */
1708 (sevenbit_strings && c >= 0x80))
1709 { /* high order bit set */
1713 do_fputs ("\\n", stream);
1716 do_fputs ("\\b", stream);
1719 do_fputs ("\\t", stream);
1722 do_fputs ("\\f", stream);
1725 do_fputs ("\\r", stream);
1728 do_fputs ("\\e", stream);
1731 do_fputs ("\\a", stream);
1734 do_fprintf (stream, "\\%.3o", (unsigned int) c);
1740 if (c == '\\' || c == quoter)
1741 do_fputs ("\\", stream);
1742 do_fprintf (stream, "%c", c);
1746 /* Print the character C on STREAM as part of the contents of a
1747 literal string whose delimiter is QUOTER. Note that these routines
1748 should only be call for printing things which are independent of
1749 the language of the program being debugged. */
1752 fputstr_filtered (const char *str, int quoter, struct ui_file *stream)
1755 printchar (*str++, fputs_filtered, fprintf_filtered, stream, quoter);
1759 fputstr_unfiltered (const char *str, int quoter, struct ui_file *stream)
1762 printchar (*str++, fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1766 fputstrn_filtered (const char *str, int n, int quoter,
1767 struct ui_file *stream)
1770 for (i = 0; i < n; i++)
1771 printchar (str[i], fputs_filtered, fprintf_filtered, stream, quoter);
1775 fputstrn_unfiltered (const char *str, int n, int quoter,
1776 struct ui_file *stream)
1779 for (i = 0; i < n; i++)
1780 printchar (str[i], fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1784 /* Number of lines per page or UINT_MAX if paging is disabled. */
1785 static unsigned int lines_per_page;
1787 show_lines_per_page (struct ui_file *file, int from_tty,
1788 struct cmd_list_element *c, const char *value)
1790 fprintf_filtered (file, _("\
1791 Number of lines gdb thinks are in a page is %s.\n"),
1795 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1796 static unsigned int chars_per_line;
1798 show_chars_per_line (struct ui_file *file, int from_tty,
1799 struct cmd_list_element *c, const char *value)
1801 fprintf_filtered (file, _("\
1802 Number of characters gdb thinks are in a line is %s.\n"),
1806 /* Current count of lines printed on this page, chars on this line. */
1807 static unsigned int lines_printed, chars_printed;
1809 /* Buffer and start column of buffered text, for doing smarter word-
1810 wrapping. When someone calls wrap_here(), we start buffering output
1811 that comes through fputs_filtered(). If we see a newline, we just
1812 spit it out and forget about the wrap_here(). If we see another
1813 wrap_here(), we spit it out and remember the newer one. If we see
1814 the end of the line, we spit out a newline, the indent, and then
1815 the buffered output. */
1817 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1818 are waiting to be output (they have already been counted in chars_printed).
1819 When wrap_buffer[0] is null, the buffer is empty. */
1820 static char *wrap_buffer;
1822 /* Pointer in wrap_buffer to the next character to fill. */
1823 static char *wrap_pointer;
1825 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1827 static char *wrap_indent;
1829 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1830 is not in effect. */
1831 static int wrap_column;
1834 /* Inialize the number of lines per page and chars per line. */
1837 init_page_info (void)
1840 if (!tui_get_command_dimension (&chars_per_line, &lines_per_page))
1845 #if defined(__GO32__)
1846 rows = ScreenRows ();
1847 cols = ScreenCols ();
1848 lines_per_page = rows;
1849 chars_per_line = cols;
1851 /* Make sure Readline has initialized its terminal settings. */
1852 rl_reset_terminal (NULL);
1854 /* Get the screen size from Readline. */
1855 rl_get_screen_size (&rows, &cols);
1856 lines_per_page = rows;
1857 chars_per_line = cols;
1859 /* Readline should have fetched the termcap entry for us. */
1860 if (tgetnum ("li") < 0 || getenv ("EMACS"))
1862 /* The number of lines per page is not mentioned in the
1863 terminal description. This probably means that paging is
1864 not useful (e.g. emacs shell window), so disable paging. */
1865 lines_per_page = UINT_MAX;
1868 /* FIXME: Get rid of this junk. */
1869 #if defined(SIGWINCH) && defined(SIGWINCH_HANDLER)
1870 SIGWINCH_HANDLER (SIGWINCH);
1873 /* If the output is not a terminal, don't paginate it. */
1874 if (!ui_file_isatty (gdb_stdout))
1875 lines_per_page = UINT_MAX;
1883 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1886 set_screen_size (void)
1888 int rows = lines_per_page;
1889 int cols = chars_per_line;
1897 /* Update Readline's idea of the terminal size. */
1898 rl_set_screen_size (rows, cols);
1901 /* Reinitialize WRAP_BUFFER according to the current value of
1907 if (chars_per_line == 0)
1912 wrap_buffer = (char *) xmalloc (chars_per_line + 2);
1913 wrap_buffer[0] = '\0';
1916 wrap_buffer = (char *) xrealloc (wrap_buffer, chars_per_line + 2);
1917 wrap_pointer = wrap_buffer; /* Start it at the beginning. */
1921 set_width_command (char *args, int from_tty, struct cmd_list_element *c)
1928 set_height_command (char *args, int from_tty, struct cmd_list_element *c)
1933 /* Wait, so the user can read what's on the screen. Prompt the user
1934 to continue by pressing RETURN. */
1937 prompt_for_continue (void)
1940 char cont_prompt[120];
1942 if (annotation_level > 1)
1943 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1945 strcpy (cont_prompt,
1946 "---Type <return> to continue, or q <return> to quit---");
1947 if (annotation_level > 1)
1948 strcat (cont_prompt, "\n\032\032prompt-for-continue\n");
1950 /* We must do this *before* we call gdb_readline, else it will eventually
1951 call us -- thinking that we're trying to print beyond the end of the
1953 reinitialize_more_filter ();
1956 /* On a real operating system, the user can quit with SIGINT.
1959 'q' is provided on all systems so users don't have to change habits
1960 from system to system, and because telling them what to do in
1961 the prompt is more user-friendly than expecting them to think of
1963 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1964 whereas control-C to gdb_readline will cause the user to get dumped
1966 ignore = gdb_readline_wrapper (cont_prompt);
1968 if (annotation_level > 1)
1969 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1974 while (*p == ' ' || *p == '\t')
1977 async_request_quit (0);
1982 /* Now we have to do this again, so that GDB will know that it doesn't
1983 need to save the ---Type <return>--- line at the top of the screen. */
1984 reinitialize_more_filter ();
1986 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1989 /* Reinitialize filter; ie. tell it to reset to original values. */
1992 reinitialize_more_filter (void)
1998 /* Indicate that if the next sequence of characters overflows the line,
1999 a newline should be inserted here rather than when it hits the end.
2000 If INDENT is non-null, it is a string to be printed to indent the
2001 wrapped part on the next line. INDENT must remain accessible until
2002 the next call to wrap_here() or until a newline is printed through
2005 If the line is already overfull, we immediately print a newline and
2006 the indentation, and disable further wrapping.
2008 If we don't know the width of lines, but we know the page height,
2009 we must not wrap words, but should still keep track of newlines
2010 that were explicitly printed.
2012 INDENT should not contain tabs, as that will mess up the char count
2013 on the next line. FIXME.
2015 This routine is guaranteed to force out any output which has been
2016 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
2017 used to force out output from the wrap_buffer. */
2020 wrap_here (char *indent)
2022 /* This should have been allocated, but be paranoid anyway. */
2024 internal_error (__FILE__, __LINE__, _("failed internal consistency check"));
2028 *wrap_pointer = '\0';
2029 fputs_unfiltered (wrap_buffer, gdb_stdout);
2031 wrap_pointer = wrap_buffer;
2032 wrap_buffer[0] = '\0';
2033 if (chars_per_line == UINT_MAX) /* No line overflow checking */
2037 else if (chars_printed >= chars_per_line)
2039 puts_filtered ("\n");
2041 puts_filtered (indent);
2046 wrap_column = chars_printed;
2050 wrap_indent = indent;
2054 /* Print input string to gdb_stdout, filtered, with wrap,
2055 arranging strings in columns of n chars. String can be
2056 right or left justified in the column. Never prints
2057 trailing spaces. String should never be longer than
2058 width. FIXME: this could be useful for the EXAMINE
2059 command, which currently doesn't tabulate very well */
2062 puts_filtered_tabular (char *string, int width, int right)
2068 gdb_assert (chars_per_line > 0);
2069 if (chars_per_line == UINT_MAX)
2071 fputs_filtered (string, gdb_stdout);
2072 fputs_filtered ("\n", gdb_stdout);
2076 if (((chars_printed - 1) / width + 2) * width >= chars_per_line)
2077 fputs_filtered ("\n", gdb_stdout);
2079 if (width >= chars_per_line)
2080 width = chars_per_line - 1;
2082 stringlen = strlen (string);
2084 if (chars_printed > 0)
2085 spaces = width - (chars_printed - 1) % width - 1;
2087 spaces += width - stringlen;
2089 spacebuf = alloca (spaces + 1);
2090 spacebuf[spaces] = '\0';
2092 spacebuf[spaces] = ' ';
2094 fputs_filtered (spacebuf, gdb_stdout);
2095 fputs_filtered (string, gdb_stdout);
2099 /* Ensure that whatever gets printed next, using the filtered output
2100 commands, starts at the beginning of the line. I.E. if there is
2101 any pending output for the current line, flush it and start a new
2102 line. Otherwise do nothing. */
2107 if (chars_printed > 0)
2109 puts_filtered ("\n");
2114 /* Like fputs but if FILTER is true, pause after every screenful.
2116 Regardless of FILTER can wrap at points other than the final
2117 character of a line.
2119 Unlike fputs, fputs_maybe_filtered does not return a value.
2120 It is OK for LINEBUFFER to be NULL, in which case just don't print
2123 Note that a longjmp to top level may occur in this routine (only if
2124 FILTER is true) (since prompt_for_continue may do so) so this
2125 routine should not be called when cleanups are not in place. */
2128 fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
2131 const char *lineptr;
2133 if (linebuffer == 0)
2136 /* Don't do any filtering if it is disabled. */
2137 if ((stream != gdb_stdout) || !pagination_enabled
2138 || (lines_per_page == UINT_MAX && chars_per_line == UINT_MAX))
2140 fputs_unfiltered (linebuffer, stream);
2144 /* Go through and output each character. Show line extension
2145 when this is necessary; prompt user for new page when this is
2148 lineptr = linebuffer;
2151 /* Possible new page. */
2152 if (filter && (lines_printed >= lines_per_page - 1))
2153 prompt_for_continue ();
2155 while (*lineptr && *lineptr != '\n')
2157 /* Print a single line. */
2158 if (*lineptr == '\t')
2161 *wrap_pointer++ = '\t';
2163 fputc_unfiltered ('\t', stream);
2164 /* Shifting right by 3 produces the number of tab stops
2165 we have already passed, and then adding one and
2166 shifting left 3 advances to the next tab stop. */
2167 chars_printed = ((chars_printed >> 3) + 1) << 3;
2173 *wrap_pointer++ = *lineptr;
2175 fputc_unfiltered (*lineptr, stream);
2180 if (chars_printed >= chars_per_line)
2182 unsigned int save_chars = chars_printed;
2186 /* If we aren't actually wrapping, don't output newline --
2187 if chars_per_line is right, we probably just overflowed
2188 anyway; if it's wrong, let us keep going. */
2190 fputc_unfiltered ('\n', stream);
2192 /* Possible new page. */
2193 if (lines_printed >= lines_per_page - 1)
2194 prompt_for_continue ();
2196 /* Now output indentation and wrapped string */
2199 fputs_unfiltered (wrap_indent, stream);
2200 *wrap_pointer = '\0'; /* Null-terminate saved stuff */
2201 fputs_unfiltered (wrap_buffer, stream); /* and eject it */
2202 /* FIXME, this strlen is what prevents wrap_indent from
2203 containing tabs. However, if we recurse to print it
2204 and count its chars, we risk trouble if wrap_indent is
2205 longer than (the user settable) chars_per_line.
2206 Note also that this can set chars_printed > chars_per_line
2207 if we are printing a long string. */
2208 chars_printed = strlen (wrap_indent)
2209 + (save_chars - wrap_column);
2210 wrap_pointer = wrap_buffer; /* Reset buffer */
2211 wrap_buffer[0] = '\0';
2212 wrap_column = 0; /* And disable fancy wrap */
2217 if (*lineptr == '\n')
2220 wrap_here ((char *) 0); /* Spit out chars, cancel further wraps */
2222 fputc_unfiltered ('\n', stream);
2229 fputs_filtered (const char *linebuffer, struct ui_file *stream)
2231 fputs_maybe_filtered (linebuffer, stream, 1);
2235 putchar_unfiltered (int c)
2238 ui_file_write (gdb_stdout, &buf, 1);
2242 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2243 May return nonlocally. */
2246 putchar_filtered (int c)
2248 return fputc_filtered (c, gdb_stdout);
2252 fputc_unfiltered (int c, struct ui_file *stream)
2255 ui_file_write (stream, &buf, 1);
2260 fputc_filtered (int c, struct ui_file *stream)
2266 fputs_filtered (buf, stream);
2270 /* puts_debug is like fputs_unfiltered, except it prints special
2271 characters in printable fashion. */
2274 puts_debug (char *prefix, char *string, char *suffix)
2278 /* Print prefix and suffix after each line. */
2279 static int new_line = 1;
2280 static int return_p = 0;
2281 static char *prev_prefix = "";
2282 static char *prev_suffix = "";
2284 if (*string == '\n')
2287 /* If the prefix is changing, print the previous suffix, a new line,
2288 and the new prefix. */
2289 if ((return_p || (strcmp (prev_prefix, prefix) != 0)) && !new_line)
2291 fputs_unfiltered (prev_suffix, gdb_stdlog);
2292 fputs_unfiltered ("\n", gdb_stdlog);
2293 fputs_unfiltered (prefix, gdb_stdlog);
2296 /* Print prefix if we printed a newline during the previous call. */
2300 fputs_unfiltered (prefix, gdb_stdlog);
2303 prev_prefix = prefix;
2304 prev_suffix = suffix;
2306 /* Output characters in a printable format. */
2307 while ((ch = *string++) != '\0')
2313 fputc_unfiltered (ch, gdb_stdlog);
2316 fprintf_unfiltered (gdb_stdlog, "\\x%02x", ch & 0xff);
2320 fputs_unfiltered ("\\\\", gdb_stdlog);
2323 fputs_unfiltered ("\\b", gdb_stdlog);
2326 fputs_unfiltered ("\\f", gdb_stdlog);
2330 fputs_unfiltered ("\\n", gdb_stdlog);
2333 fputs_unfiltered ("\\r", gdb_stdlog);
2336 fputs_unfiltered ("\\t", gdb_stdlog);
2339 fputs_unfiltered ("\\v", gdb_stdlog);
2343 return_p = ch == '\r';
2346 /* Print suffix if we printed a newline. */
2349 fputs_unfiltered (suffix, gdb_stdlog);
2350 fputs_unfiltered ("\n", gdb_stdlog);
2355 /* Print a variable number of ARGS using format FORMAT. If this
2356 information is going to put the amount written (since the last call
2357 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2358 call prompt_for_continue to get the users permision to continue.
2360 Unlike fprintf, this function does not return a value.
2362 We implement three variants, vfprintf (takes a vararg list and stream),
2363 fprintf (takes a stream to write on), and printf (the usual).
2365 Note also that a longjmp to top level may occur in this routine
2366 (since prompt_for_continue may do so) so this routine should not be
2367 called when cleanups are not in place. */
2370 vfprintf_maybe_filtered (struct ui_file *stream, const char *format,
2371 va_list args, int filter)
2374 struct cleanup *old_cleanups;
2376 linebuffer = xstrvprintf (format, args);
2377 old_cleanups = make_cleanup (xfree, linebuffer);
2378 fputs_maybe_filtered (linebuffer, stream, filter);
2379 do_cleanups (old_cleanups);
2384 vfprintf_filtered (struct ui_file *stream, const char *format, va_list args)
2386 vfprintf_maybe_filtered (stream, format, args, 1);
2390 vfprintf_unfiltered (struct ui_file *stream, const char *format, va_list args)
2393 struct cleanup *old_cleanups;
2395 linebuffer = xstrvprintf (format, args);
2396 old_cleanups = make_cleanup (xfree, linebuffer);
2397 if (debug_timestamp && stream == gdb_stdlog)
2403 gettimeofday (&tm, NULL);
2405 len = strlen (linebuffer);
2406 need_nl = (len > 0 && linebuffer[len - 1] != '\n');
2408 timestamp = xstrprintf ("%ld:%ld %s%s",
2409 (long) tm.tv_sec, (long) tm.tv_usec,
2411 need_nl ? "\n": "");
2412 make_cleanup (xfree, timestamp);
2413 fputs_unfiltered (timestamp, stream);
2416 fputs_unfiltered (linebuffer, stream);
2417 do_cleanups (old_cleanups);
2421 vprintf_filtered (const char *format, va_list args)
2423 vfprintf_maybe_filtered (gdb_stdout, format, args, 1);
2427 vprintf_unfiltered (const char *format, va_list args)
2429 vfprintf_unfiltered (gdb_stdout, format, args);
2433 fprintf_filtered (struct ui_file *stream, const char *format, ...)
2436 va_start (args, format);
2437 vfprintf_filtered (stream, format, args);
2442 fprintf_unfiltered (struct ui_file *stream, const char *format, ...)
2445 va_start (args, format);
2446 vfprintf_unfiltered (stream, format, args);
2450 /* Like fprintf_filtered, but prints its result indented.
2451 Called as fprintfi_filtered (spaces, stream, format, ...); */
2454 fprintfi_filtered (int spaces, struct ui_file *stream, const char *format,
2458 va_start (args, format);
2459 print_spaces_filtered (spaces, stream);
2461 vfprintf_filtered (stream, format, args);
2467 printf_filtered (const char *format, ...)
2470 va_start (args, format);
2471 vfprintf_filtered (gdb_stdout, format, args);
2477 printf_unfiltered (const char *format, ...)
2480 va_start (args, format);
2481 vfprintf_unfiltered (gdb_stdout, format, args);
2485 /* Like printf_filtered, but prints it's result indented.
2486 Called as printfi_filtered (spaces, format, ...); */
2489 printfi_filtered (int spaces, const char *format, ...)
2492 va_start (args, format);
2493 print_spaces_filtered (spaces, gdb_stdout);
2494 vfprintf_filtered (gdb_stdout, format, args);
2498 /* Easy -- but watch out!
2500 This routine is *not* a replacement for puts()! puts() appends a newline.
2501 This one doesn't, and had better not! */
2504 puts_filtered (const char *string)
2506 fputs_filtered (string, gdb_stdout);
2510 puts_unfiltered (const char *string)
2512 fputs_unfiltered (string, gdb_stdout);
2515 /* Return a pointer to N spaces and a null. The pointer is good
2516 until the next call to here. */
2521 static char *spaces = 0;
2522 static int max_spaces = -1;
2528 spaces = (char *) xmalloc (n + 1);
2529 for (t = spaces + n; t != spaces;)
2535 return spaces + max_spaces - n;
2538 /* Print N spaces. */
2540 print_spaces_filtered (int n, struct ui_file *stream)
2542 fputs_filtered (n_spaces (n), stream);
2545 /* C++/ObjC demangler stuff. */
2547 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2548 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2549 If the name is not mangled, or the language for the name is unknown, or
2550 demangling is off, the name is printed in its "raw" form. */
2553 fprintf_symbol_filtered (struct ui_file *stream, char *name,
2554 enum language lang, int arg_mode)
2560 /* If user wants to see raw output, no problem. */
2563 fputs_filtered (name, stream);
2567 demangled = language_demangle (language_def (lang), name, arg_mode);
2568 fputs_filtered (demangled ? demangled : name, stream);
2569 if (demangled != NULL)
2577 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2578 differences in whitespace. Returns 0 if they match, non-zero if they
2579 don't (slightly different than strcmp()'s range of return values).
2581 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2582 This "feature" is useful when searching for matching C++ function names
2583 (such as if the user types 'break FOO', where FOO is a mangled C++
2587 strcmp_iw (const char *string1, const char *string2)
2589 while ((*string1 != '\0') && (*string2 != '\0'))
2591 while (isspace (*string1))
2595 while (isspace (*string2))
2599 if (*string1 != *string2)
2603 if (*string1 != '\0')
2609 return (*string1 != '\0' && *string1 != '(') || (*string2 != '\0');
2612 /* This is like strcmp except that it ignores whitespace and treats
2613 '(' as the first non-NULL character in terms of ordering. Like
2614 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2615 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2616 according to that ordering.
2618 If a list is sorted according to this function and if you want to
2619 find names in the list that match some fixed NAME according to
2620 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2621 where this function would put NAME.
2623 Here are some examples of why using strcmp to sort is a bad idea:
2627 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2628 we try to do a search for "foo<char*>", strcmp will locate this
2629 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2630 will start looking at strings beginning with "goo", and will never
2631 see the correct match of "foo<char *>".
2633 Parenthesis example:
2635 In practice, this is less like to be an issue, but I'll give it a
2636 shot. Let's assume that '$' is a legitimate character to occur in
2637 symbols. (Which may well even be the case on some systems.) Then
2638 say that the partial symbol table contains "foo$" and "foo(int)".
2639 strcmp will put them in this order, since '$' < '('. Now, if the
2640 user searches for "foo", then strcmp will sort "foo" before "foo$".
2641 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2642 "foo") is false, so it won't proceed to the actual match of
2643 "foo(int)" with "foo". */
2646 strcmp_iw_ordered (const char *string1, const char *string2)
2648 while ((*string1 != '\0') && (*string2 != '\0'))
2650 while (isspace (*string1))
2654 while (isspace (*string2))
2658 if (*string1 != *string2)
2662 if (*string1 != '\0')
2671 /* Characters are non-equal unless they're both '\0'; we want to
2672 make sure we get the comparison right according to our
2673 comparison in the cases where one of them is '\0' or '('. */
2675 if (*string2 == '\0')
2680 if (*string2 == '\0')
2685 if (*string2 == '(')
2688 return *string1 - *string2;
2692 /* A simple comparison function with opposite semantics to strcmp. */
2695 streq (const char *lhs, const char *rhs)
2697 return !strcmp (lhs, rhs);
2703 ** Answer whether string_to_compare is a full or partial match to
2704 ** template_string. The partial match must be in sequence starting
2708 subset_compare (char *string_to_compare, char *template_string)
2711 if (template_string != (char *) NULL && string_to_compare != (char *) NULL
2712 && strlen (string_to_compare) <= strlen (template_string))
2715 (template_string, string_to_compare, strlen (string_to_compare)) == 0);
2722 pagination_on_command (char *arg, int from_tty)
2724 pagination_enabled = 1;
2728 pagination_off_command (char *arg, int from_tty)
2730 pagination_enabled = 0;
2734 show_debug_timestamp (struct ui_file *file, int from_tty,
2735 struct cmd_list_element *c, const char *value)
2737 fprintf_filtered (file, _("Timestamping debugging messages is %s.\n"), value);
2742 initialize_utils (void)
2744 struct cmd_list_element *c;
2746 add_setshow_uinteger_cmd ("width", class_support, &chars_per_line, _("\
2747 Set number of characters gdb thinks are in a line."), _("\
2748 Show number of characters gdb thinks are in a line."), NULL,
2750 show_chars_per_line,
2751 &setlist, &showlist);
2753 add_setshow_uinteger_cmd ("height", class_support, &lines_per_page, _("\
2754 Set number of lines gdb thinks are in a page."), _("\
2755 Show number of lines gdb thinks are in a page."), NULL,
2757 show_lines_per_page,
2758 &setlist, &showlist);
2762 add_setshow_boolean_cmd ("demangle", class_support, &demangle, _("\
2763 Set demangling of encoded C++/ObjC names when displaying symbols."), _("\
2764 Show demangling of encoded C++/ObjC names when displaying symbols."), NULL,
2767 &setprintlist, &showprintlist);
2769 add_setshow_boolean_cmd ("pagination", class_support,
2770 &pagination_enabled, _("\
2771 Set state of pagination."), _("\
2772 Show state of pagination."), NULL,
2774 show_pagination_enabled,
2775 &setlist, &showlist);
2779 add_com ("am", class_support, pagination_on_command,
2780 _("Enable pagination"));
2781 add_com ("sm", class_support, pagination_off_command,
2782 _("Disable pagination"));
2785 add_setshow_boolean_cmd ("sevenbit-strings", class_support,
2786 &sevenbit_strings, _("\
2787 Set printing of 8-bit characters in strings as \\nnn."), _("\
2788 Show printing of 8-bit characters in strings as \\nnn."), NULL,
2790 show_sevenbit_strings,
2791 &setprintlist, &showprintlist);
2793 add_setshow_boolean_cmd ("asm-demangle", class_support, &asm_demangle, _("\
2794 Set demangling of C++/ObjC names in disassembly listings."), _("\
2795 Show demangling of C++/ObjC names in disassembly listings."), NULL,
2798 &setprintlist, &showprintlist);
2800 add_setshow_boolean_cmd ("timestamp", class_maintenance,
2801 &debug_timestamp, _("\
2802 Set timestamping of debugging messages."), _("\
2803 Show timestamping of debugging messages."), _("\
2804 When set, debugging messages will be marked with seconds and microseconds."),
2806 show_debug_timestamp,
2807 &setdebuglist, &showdebuglist);
2810 /* Machine specific function to handle SIGWINCH signal. */
2812 #ifdef SIGWINCH_HANDLER_BODY
2813 SIGWINCH_HANDLER_BODY
2815 /* print routines to handle variable size regs, etc. */
2816 /* temporary storage using circular buffer */
2822 static char buf[NUMCELLS][CELLSIZE];
2823 static int cell = 0;
2824 if (++cell >= NUMCELLS)
2832 return (gdbarch_addr_bit (current_gdbarch) / 8 * 2);
2836 paddr (CORE_ADDR addr)
2838 return phex (addr, gdbarch_addr_bit (current_gdbarch) / 8);
2842 paddr_nz (CORE_ADDR addr)
2844 return phex_nz (addr, gdbarch_addr_bit (current_gdbarch) / 8);
2848 paddress (CORE_ADDR addr)
2850 /* Truncate address to the size of a target address, avoiding shifts
2851 larger or equal than the width of a CORE_ADDR. The local
2852 variable ADDR_BIT stops the compiler reporting a shift overflow
2853 when it won't occur. */
2854 /* NOTE: This assumes that the significant address information is
2855 kept in the least significant bits of ADDR - the upper bits were
2856 either zero or sign extended. Should gdbarch_address_to_pointer or
2857 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2859 int addr_bit = gdbarch_addr_bit (current_gdbarch);
2861 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2862 addr &= ((CORE_ADDR) 1 << addr_bit) - 1;
2863 return hex_string (addr);
2867 decimal2str (char *sign, ULONGEST addr, int width)
2869 /* Steal code from valprint.c:print_decimal(). Should this worry
2870 about the real size of addr as the above does? */
2871 unsigned long temp[3];
2872 char *str = get_cell ();
2877 temp[i] = addr % (1000 * 1000 * 1000);
2878 addr /= (1000 * 1000 * 1000);
2882 while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0])));
2891 xsnprintf (str, CELLSIZE, "%s%0*lu", sign, width, temp[0]);
2894 xsnprintf (str, CELLSIZE, "%s%0*lu%09lu", sign, width,
2898 xsnprintf (str, CELLSIZE, "%s%0*lu%09lu%09lu", sign, width,
2899 temp[2], temp[1], temp[0]);
2902 internal_error (__FILE__, __LINE__,
2903 _("failed internal consistency check"));
2910 octal2str (ULONGEST addr, int width)
2912 unsigned long temp[3];
2913 char *str = get_cell ();
2918 temp[i] = addr % (0100000 * 0100000);
2919 addr /= (0100000 * 0100000);
2923 while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0])));
2933 xsnprintf (str, CELLSIZE, "%*o", width, 0);
2935 xsnprintf (str, CELLSIZE, "0%0*lo", width, temp[0]);
2938 xsnprintf (str, CELLSIZE, "0%0*lo%010lo", width, temp[1], temp[0]);
2941 xsnprintf (str, CELLSIZE, "0%0*lo%010lo%010lo", width,
2942 temp[2], temp[1], temp[0]);
2945 internal_error (__FILE__, __LINE__,
2946 _("failed internal consistency check"));
2953 pulongest (ULONGEST u)
2955 return decimal2str ("", u, 0);
2959 plongest (LONGEST l)
2962 return decimal2str ("-", -l, 0);
2964 return decimal2str ("", l, 0);
2967 /* Eliminate warning from compiler on 32-bit systems. */
2968 static int thirty_two = 32;
2971 phex (ULONGEST l, int sizeof_l)
2979 xsnprintf (str, CELLSIZE, "%08lx%08lx",
2980 (unsigned long) (l >> thirty_two),
2981 (unsigned long) (l & 0xffffffff));
2985 xsnprintf (str, CELLSIZE, "%08lx", (unsigned long) l);
2989 xsnprintf (str, CELLSIZE, "%04x", (unsigned short) (l & 0xffff));
2992 str = phex (l, sizeof (l));
3000 phex_nz (ULONGEST l, int sizeof_l)
3008 unsigned long high = (unsigned long) (l >> thirty_two);
3011 xsnprintf (str, CELLSIZE, "%lx",
3012 (unsigned long) (l & 0xffffffff));
3014 xsnprintf (str, CELLSIZE, "%lx%08lx", high,
3015 (unsigned long) (l & 0xffffffff));
3020 xsnprintf (str, CELLSIZE, "%lx", (unsigned long) l);
3024 xsnprintf (str, CELLSIZE, "%x", (unsigned short) (l & 0xffff));
3027 str = phex_nz (l, sizeof (l));
3034 /* Converts a LONGEST to a C-format hexadecimal literal and stores it
3035 in a static string. Returns a pointer to this string. */
3037 hex_string (LONGEST num)
3039 char *result = get_cell ();
3040 xsnprintf (result, CELLSIZE, "0x%s", phex_nz (num, sizeof (num)));
3044 /* Converts a LONGEST number to a C-format hexadecimal literal and
3045 stores it in a static string. Returns a pointer to this string
3046 that is valid until the next call. The number is padded on the
3047 left with 0s to at least WIDTH characters. */
3049 hex_string_custom (LONGEST num, int width)
3051 char *result = get_cell ();
3052 char *result_end = result + CELLSIZE - 1;
3053 const char *hex = phex_nz (num, sizeof (num));
3054 int hex_len = strlen (hex);
3056 if (hex_len > width)
3058 if (width + 2 >= CELLSIZE)
3059 internal_error (__FILE__, __LINE__,
3060 _("hex_string_custom: insufficient space to store result"));
3062 strcpy (result_end - width - 2, "0x");
3063 memset (result_end - width, '0', width);
3064 strcpy (result_end - hex_len, hex);
3065 return result_end - width - 2;
3068 /* Convert VAL to a numeral in the given radix. For
3069 * radix 10, IS_SIGNED may be true, indicating a signed quantity;
3070 * otherwise VAL is interpreted as unsigned. If WIDTH is supplied,
3071 * it is the minimum width (0-padded if needed). USE_C_FORMAT means
3072 * to use C format in all cases. If it is false, then 'x'
3073 * and 'o' formats do not include a prefix (0x or leading 0). */
3076 int_string (LONGEST val, int radix, int is_signed, int width,
3085 result = hex_string (val);
3087 result = hex_string_custom (val, width);
3094 if (is_signed && val < 0)
3095 return decimal2str ("-", -val, width);
3097 return decimal2str ("", val, width);
3101 char *result = octal2str (val, width);
3102 if (use_c_format || val == 0)
3108 internal_error (__FILE__, __LINE__,
3109 _("failed internal consistency check"));
3113 /* Convert a CORE_ADDR into a string. */
3115 core_addr_to_string (const CORE_ADDR addr)
3117 char *str = get_cell ();
3119 strcat (str, phex (addr, sizeof (addr)));
3124 core_addr_to_string_nz (const CORE_ADDR addr)
3126 char *str = get_cell ();
3128 strcat (str, phex_nz (addr, sizeof (addr)));
3132 /* Convert a string back into a CORE_ADDR. */
3134 string_to_core_addr (const char *my_string)
3136 int addr_bit = gdbarch_addr_bit (current_gdbarch);
3139 if (my_string[0] == '0' && tolower (my_string[1]) == 'x')
3141 /* Assume that it is in hex. */
3143 for (i = 2; my_string[i] != '\0'; i++)
3145 if (isdigit (my_string[i]))
3146 addr = (my_string[i] - '0') + (addr * 16);
3147 else if (isxdigit (my_string[i]))
3148 addr = (tolower (my_string[i]) - 'a' + 0xa) + (addr * 16);
3150 error (_("invalid hex \"%s\""), my_string);
3153 /* Not very modular, but if the executable format expects
3154 addresses to be sign-extended, then do so if the address was
3155 specified with only 32 significant bits. Really this should
3156 be determined by the target architecture, not by the object
3158 if (i - 2 == addr_bit / 4
3160 && bfd_get_sign_extend_vma (exec_bfd))
3161 addr = (addr ^ ((CORE_ADDR) 1 << (addr_bit - 1)))
3162 - ((CORE_ADDR) 1 << (addr_bit - 1));
3166 /* Assume that it is in decimal. */
3168 for (i = 0; my_string[i] != '\0'; i++)
3170 if (isdigit (my_string[i]))
3171 addr = (my_string[i] - '0') + (addr * 10);
3173 error (_("invalid decimal \"%s\""), my_string);
3181 host_address_to_string (const void *addr)
3183 char *str = get_cell ();
3185 xsnprintf (str, CELLSIZE, "0x%s", phex_nz ((uintptr_t) addr, sizeof (addr)));
3190 gdb_realpath (const char *filename)
3192 /* Method 1: The system has a compile time upper bound on a filename
3193 path. Use that and realpath() to canonicalize the name. This is
3194 the most common case. Note that, if there isn't a compile time
3195 upper bound, you want to avoid realpath() at all costs. */
3196 #if defined(HAVE_REALPATH)
3198 # if defined (PATH_MAX)
3200 # define USE_REALPATH
3201 # elif defined (MAXPATHLEN)
3202 char buf[MAXPATHLEN];
3203 # define USE_REALPATH
3205 # if defined (USE_REALPATH)
3206 const char *rp = realpath (filename, buf);
3209 return xstrdup (rp);
3212 #endif /* HAVE_REALPATH */
3214 /* Method 2: The host system (i.e., GNU) has the function
3215 canonicalize_file_name() which malloc's a chunk of memory and
3216 returns that, use that. */
3217 #if defined(HAVE_CANONICALIZE_FILE_NAME)
3219 char *rp = canonicalize_file_name (filename);
3221 return xstrdup (filename);
3227 /* FIXME: cagney/2002-11-13:
3229 Method 2a: Use realpath() with a NULL buffer. Some systems, due
3230 to the problems described in in method 3, have modified their
3231 realpath() implementation so that it will allocate a buffer when
3232 NULL is passed in. Before this can be used, though, some sort of
3233 configure time test would need to be added. Otherwize the code
3234 will likely core dump. */
3236 /* Method 3: Now we're getting desperate! The system doesn't have a
3237 compile time buffer size and no alternative function. Query the
3238 OS, using pathconf(), for the buffer limit. Care is needed
3239 though, some systems do not limit PATH_MAX (return -1 for
3240 pathconf()) making it impossible to pass a correctly sized buffer
3241 to realpath() (it could always overflow). On those systems, we
3243 #if defined (HAVE_REALPATH) && defined (HAVE_UNISTD_H) && defined(HAVE_ALLOCA)
3245 /* Find out the max path size. */
3246 long path_max = pathconf ("/", _PC_PATH_MAX);
3249 /* PATH_MAX is bounded. */
3250 char *buf = alloca (path_max);
3251 char *rp = realpath (filename, buf);
3252 return xstrdup (rp ? rp : filename);
3257 /* This system is a lost cause, just dup the buffer. */
3258 return xstrdup (filename);
3261 /* Return a copy of FILENAME, with its directory prefix canonicalized
3265 xfullpath (const char *filename)
3267 const char *base_name = lbasename (filename);
3272 /* Extract the basename of filename, and return immediately
3273 a copy of filename if it does not contain any directory prefix. */
3274 if (base_name == filename)
3275 return xstrdup (filename);
3277 dir_name = alloca ((size_t) (base_name - filename + 2));
3278 /* Allocate enough space to store the dir_name + plus one extra
3279 character sometimes needed under Windows (see below), and
3280 then the closing \000 character */
3281 strncpy (dir_name, filename, base_name - filename);
3282 dir_name[base_name - filename] = '\000';
3284 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3285 /* We need to be careful when filename is of the form 'd:foo', which
3286 is equivalent of d:./foo, which is totally different from d:/foo. */
3287 if (strlen (dir_name) == 2 && isalpha (dir_name[0]) && dir_name[1] == ':')
3290 dir_name[3] = '\000';
3294 /* Canonicalize the directory prefix, and build the resulting
3295 filename. If the dirname realpath already contains an ending
3296 directory separator, avoid doubling it. */
3297 real_path = gdb_realpath (dir_name);
3298 if (IS_DIR_SEPARATOR (real_path[strlen (real_path) - 1]))
3299 result = concat (real_path, base_name, (char *)NULL);
3301 result = concat (real_path, SLASH_STRING, base_name, (char *)NULL);
3308 /* This is the 32-bit CRC function used by the GNU separate debug
3309 facility. An executable may contain a section named
3310 .gnu_debuglink, which holds the name of a separate executable file
3311 containing its debug info, and a checksum of that file's contents,
3312 computed using this function. */
3314 gnu_debuglink_crc32 (unsigned long crc, unsigned char *buf, size_t len)
3316 static const unsigned long crc32_table[256] = {
3317 0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419,
3318 0x706af48f, 0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4,
3319 0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07,
3320 0x90bf1d91, 0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de,
3321 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7, 0x136c9856,
3322 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
3323 0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4,
3324 0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b,
3325 0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3,
3326 0x45df5c75, 0xdcd60dcf, 0xabd13d59, 0x26d930ac, 0x51de003a,
3327 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599,
3328 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
3329 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190,
3330 0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f,
3331 0x9fbfe4a5, 0xe8b8d433, 0x7807c9a2, 0x0f00f934, 0x9609a88e,
3332 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01,
3333 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed,
3334 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
3335 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3,
3336 0xfbd44c65, 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2,
3337 0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a,
3338 0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5,
3339 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa, 0xbe0b1010,
3340 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
3341 0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17,
3342 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6,
3343 0x03b6e20c, 0x74b1d29a, 0xead54739, 0x9dd277af, 0x04db2615,
3344 0x73dc1683, 0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8,
3345 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1, 0xf00f9344,
3346 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
3347 0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a,
3348 0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5,
3349 0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1,
3350 0xa6bc5767, 0x3fb506dd, 0x48b2364b, 0xd80d2bda, 0xaf0a1b4c,
3351 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef,
3352 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
3353 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe,
3354 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31,
3355 0x2cd99e8b, 0x5bdeae1d, 0x9b64c2b0, 0xec63f226, 0x756aa39c,
3356 0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713,
3357 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 0x92d28e9b,
3358 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
3359 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1,
3360 0x18b74777, 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c,
3361 0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45, 0xa00ae278,
3362 0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7,
3363 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc, 0x40df0b66,
3364 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
3365 0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605,
3366 0xcdd70693, 0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8,
3367 0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b,
3372 crc = ~crc & 0xffffffff;
3373 for (end = buf + len; buf < end; ++buf)
3374 crc = crc32_table[(crc ^ *buf) & 0xff] ^ (crc >> 8);
3375 return ~crc & 0xffffffff;;
3379 align_up (ULONGEST v, int n)
3381 /* Check that N is really a power of two. */
3382 gdb_assert (n && (n & (n-1)) == 0);
3383 return (v + n - 1) & -n;
3387 align_down (ULONGEST v, int n)
3389 /* Check that N is really a power of two. */
3390 gdb_assert (n && (n & (n-1)) == 0);
3394 /* Allocation function for the libiberty hash table which uses an
3395 obstack. The obstack is passed as DATA. */
3398 hashtab_obstack_allocate (void *data, size_t size, size_t count)
3400 unsigned int total = size * count;
3401 void *ptr = obstack_alloc ((struct obstack *) data, total);
3402 memset (ptr, 0, total);
3406 /* Trivial deallocation function for the libiberty splay tree and hash
3407 table - don't deallocate anything. Rely on later deletion of the
3408 obstack. DATA will be the obstack, although it is not needed
3412 dummy_obstack_deallocate (void *object, void *data)
3417 /* The bit offset of the highest byte in a ULONGEST, for overflow
3420 #define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT)
3422 /* True (non-zero) iff DIGIT is a valid digit in radix BASE,
3423 where 2 <= BASE <= 36. */
3426 is_digit_in_base (unsigned char digit, int base)
3428 if (!isalnum (digit))
3431 return (isdigit (digit) && digit < base + '0');
3433 return (isdigit (digit) || tolower (digit) < base - 10 + 'a');
3437 digit_to_int (unsigned char c)
3442 return tolower (c) - 'a' + 10;
3445 /* As for strtoul, but for ULONGEST results. */
3448 strtoulst (const char *num, const char **trailer, int base)
3450 unsigned int high_part;
3455 /* Skip leading whitespace. */
3456 while (isspace (num[i]))
3459 /* Handle prefixes. */
3462 else if (num[i] == '-')
3468 if (base == 0 || base == 16)
3470 if (num[i] == '0' && (num[i + 1] == 'x' || num[i + 1] == 'X'))
3478 if (base == 0 && num[i] == '0')
3484 if (base < 2 || base > 36)
3490 result = high_part = 0;
3491 for (; is_digit_in_base (num[i], base); i += 1)
3493 result = result * base + digit_to_int (num[i]);
3494 high_part = high_part * base + (unsigned int) (result >> HIGH_BYTE_POSN);
3495 result &= ((ULONGEST) 1 << HIGH_BYTE_POSN) - 1;
3496 if (high_part > 0xff)
3499 result = ~ (ULONGEST) 0;
3506 if (trailer != NULL)
3509 result = result + ((ULONGEST) high_part << HIGH_BYTE_POSN);
3516 /* Simple, portable version of dirname that does not modify its
3520 ldirname (const char *filename)
3522 const char *base = lbasename (filename);
3525 while (base > filename && IS_DIR_SEPARATOR (base[-1]))
3528 if (base == filename)
3531 dirname = xmalloc (base - filename + 2);
3532 memcpy (dirname, filename, base - filename);
3534 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3535 create "d:./bar" later instead of the (different) "d:/bar". */
3536 if (base - filename == 2 && IS_ABSOLUTE_PATH (base)
3537 && !IS_DIR_SEPARATOR (filename[0]))
3538 dirname[base++ - filename] = '.';
3540 dirname[base - filename] = '\0';
3544 /* Call libiberty's buildargv, and return the result.
3545 If buildargv fails due to out-of-memory, call nomem.
3546 Therefore, the returned value is guaranteed to be non-NULL,
3547 unless the parameter itself is NULL. */
3550 gdb_buildargv (const char *s)
3552 char **argv = buildargv (s);
3553 if (s != NULL && argv == NULL)
3558 /* Provide a prototype to silence -Wmissing-prototypes. */
3559 extern initialize_file_ftype _initialize_utils;
3562 _initialize_utils (void)
3564 add_internal_problem_command (&internal_error_problem);
3565 add_internal_problem_command (&internal_warning_problem);