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 "gdb_assert.h"
25 #include "gdb_string.h"
26 #include "event-top.h"
27 #include "exceptions.h"
28 #include "gdbthread.h"
29 #ifdef HAVE_SYS_RESOURCE_H
30 #include <sys/resource.h>
31 #endif /* HAVE_SYS_RESOURCE_H */
34 #include "tui/tui.h" /* For tui_get_command_dimension. */
41 /* SunOS's curses.h has a '#define reg register' in it. Thank you Sun. */
52 #include "expression.h"
56 #include "filenames.h"
58 #include "gdb_obstack.h"
63 #include "inferior.h" /* for signed_pointer_to_address */
65 #include <sys/param.h> /* For MAXPATHLEN */
67 #include "gdb_curses.h"
69 #include "readline/readline.h"
74 #include "gdb_usleep.h"
76 #include "gdb_regex.h"
79 extern PTR malloc (); /* ARI: PTR */
81 #if !HAVE_DECL_REALLOC
82 extern PTR realloc (); /* ARI: PTR */
88 /* readline defines this. */
91 void (*deprecated_error_begin_hook) (void);
93 /* Prototypes for local functions */
95 static void vfprintf_maybe_filtered (struct ui_file *, const char *,
96 va_list, int) ATTRIBUTE_PRINTF (2, 0);
98 static void fputs_maybe_filtered (const char *, struct ui_file *, int);
100 static void do_my_cleanups (struct cleanup **, struct cleanup *);
102 static void prompt_for_continue (void);
104 static void set_screen_size (void);
105 static void set_width (void);
107 /* A flag indicating whether to timestamp debugging messages. */
109 static int debug_timestamp = 0;
111 /* Chain of cleanup actions established with make_cleanup,
112 to be executed if an error happens. */
114 static struct cleanup *cleanup_chain; /* cleaned up after a failed command */
115 static struct cleanup *final_cleanup_chain; /* cleaned up when gdb exits */
117 /* Nonzero if we have job control. */
121 /* Nonzero means a quit has been requested. */
125 /* Nonzero means quit immediately if Control-C is typed now, rather
126 than waiting until QUIT is executed. Be careful in setting this;
127 code which executes with immediate_quit set has to be very careful
128 about being able to deal with being interrupted at any time. It is
129 almost always better to use QUIT; the only exception I can think of
130 is being able to quit out of a system call (using EINTR loses if
131 the SIGINT happens between the previous QUIT and the system call).
132 To immediately quit in the case in which a SIGINT happens between
133 the previous QUIT and setting immediate_quit (desirable anytime we
134 expect to block), call QUIT after setting immediate_quit. */
138 /* Nonzero means that encoded C++/ObjC names should be printed out in their
139 C++/ObjC form rather than raw. */
143 show_demangle (struct ui_file *file, int from_tty,
144 struct cmd_list_element *c, const char *value)
146 fprintf_filtered (file,
147 _("Demangling of encoded C++/ObjC names "
148 "when displaying symbols is %s.\n"),
152 /* Nonzero means that encoded C++/ObjC names should be printed out in their
153 C++/ObjC form even in assembler language displays. If this is set, but
154 DEMANGLE is zero, names are printed raw, i.e. DEMANGLE controls. */
156 int asm_demangle = 0;
158 show_asm_demangle (struct ui_file *file, int from_tty,
159 struct cmd_list_element *c, const char *value)
161 fprintf_filtered (file,
162 _("Demangling of C++/ObjC names in "
163 "disassembly listings is %s.\n"),
167 /* Nonzero means that strings with character values >0x7F should be printed
168 as octal escapes. Zero means just print the value (e.g. it's an
169 international character, and the terminal or window can cope.) */
171 int sevenbit_strings = 0;
173 show_sevenbit_strings (struct ui_file *file, int from_tty,
174 struct cmd_list_element *c, const char *value)
176 fprintf_filtered (file, _("Printing of 8-bit characters "
177 "in strings as \\nnn is %s.\n"),
181 /* String to be printed before error messages, if any. */
183 char *error_pre_print;
185 /* String to be printed before quit messages, if any. */
187 char *quit_pre_print;
189 /* String to be printed before warning messages, if any. */
191 char *warning_pre_print = "\nwarning: ";
193 int pagination_enabled = 1;
195 show_pagination_enabled (struct ui_file *file, int from_tty,
196 struct cmd_list_element *c, const char *value)
198 fprintf_filtered (file, _("State of pagination is %s.\n"), value);
203 /* Add a new cleanup to the cleanup_chain,
204 and return the previous chain pointer
205 to be passed later to do_cleanups or discard_cleanups.
206 Args are FUNCTION to clean up with, and ARG to pass to it. */
209 make_cleanup (make_cleanup_ftype *function, void *arg)
211 return make_my_cleanup (&cleanup_chain, function, arg);
215 make_cleanup_dtor (make_cleanup_ftype *function, void *arg,
216 void (*dtor) (void *))
218 return make_my_cleanup2 (&cleanup_chain,
219 function, arg, dtor);
223 make_final_cleanup (make_cleanup_ftype *function, void *arg)
225 return make_my_cleanup (&final_cleanup_chain, function, arg);
229 do_freeargv (void *arg)
231 freeargv ((char **) arg);
235 make_cleanup_freeargv (char **arg)
237 return make_my_cleanup (&cleanup_chain, do_freeargv, arg);
241 do_bfd_close_cleanup (void *arg)
247 make_cleanup_bfd_close (bfd *abfd)
249 return make_cleanup (do_bfd_close_cleanup, abfd);
253 do_close_cleanup (void *arg)
261 make_cleanup_close (int fd)
263 int *saved_fd = xmalloc (sizeof (fd));
266 return make_cleanup_dtor (do_close_cleanup, saved_fd, xfree);
269 /* Helper function which does the work for make_cleanup_fclose. */
272 do_fclose_cleanup (void *arg)
279 /* Return a new cleanup that closes FILE. */
282 make_cleanup_fclose (FILE *file)
284 return make_cleanup (do_fclose_cleanup, file);
287 /* Helper function which does the work for make_cleanup_obstack_free. */
290 do_obstack_free (void *arg)
292 struct obstack *ob = arg;
294 obstack_free (ob, NULL);
297 /* Return a new cleanup that frees OBSTACK. */
300 make_cleanup_obstack_free (struct obstack *obstack)
302 return make_cleanup (do_obstack_free, obstack);
306 do_ui_file_delete (void *arg)
308 ui_file_delete (arg);
312 make_cleanup_ui_file_delete (struct ui_file *arg)
314 return make_my_cleanup (&cleanup_chain, do_ui_file_delete, arg);
317 /* Helper function for make_cleanup_ui_out_redirect_pop. */
320 do_ui_out_redirect_pop (void *arg)
322 struct ui_out *uiout = arg;
324 if (ui_out_redirect (uiout, NULL) < 0)
325 warning (_("Cannot restore redirection of the current output protocol"));
328 /* Return a new cleanup that pops the last redirection by ui_out_redirect
329 with NULL parameter. */
332 make_cleanup_ui_out_redirect_pop (struct ui_out *uiout)
334 return make_my_cleanup (&cleanup_chain, do_ui_out_redirect_pop, uiout);
338 do_free_section_addr_info (void *arg)
340 free_section_addr_info (arg);
344 make_cleanup_free_section_addr_info (struct section_addr_info *addrs)
346 return make_my_cleanup (&cleanup_chain, do_free_section_addr_info, addrs);
349 struct restore_integer_closure
356 restore_integer (void *p)
358 struct restore_integer_closure *closure = p;
360 *(closure->variable) = closure->value;
363 /* Remember the current value of *VARIABLE and make it restored when
364 the cleanup is run. */
367 make_cleanup_restore_integer (int *variable)
369 struct restore_integer_closure *c =
370 xmalloc (sizeof (struct restore_integer_closure));
372 c->variable = variable;
373 c->value = *variable;
375 return make_my_cleanup2 (&cleanup_chain, restore_integer, (void *)c,
379 /* Remember the current value of *VARIABLE and make it restored when
380 the cleanup is run. */
383 make_cleanup_restore_uinteger (unsigned int *variable)
385 return make_cleanup_restore_integer ((int *) variable);
388 /* Helper for make_cleanup_unpush_target. */
391 do_unpush_target (void *arg)
393 struct target_ops *ops = arg;
398 /* Return a new cleanup that unpushes OPS. */
401 make_cleanup_unpush_target (struct target_ops *ops)
403 return make_my_cleanup (&cleanup_chain, do_unpush_target, ops);
406 struct restore_ui_file_closure
408 struct ui_file **variable;
409 struct ui_file *value;
413 do_restore_ui_file (void *p)
415 struct restore_ui_file_closure *closure = p;
417 *(closure->variable) = closure->value;
420 /* Remember the current value of *VARIABLE and make it restored when
421 the cleanup is run. */
424 make_cleanup_restore_ui_file (struct ui_file **variable)
426 struct restore_ui_file_closure *c = XNEW (struct restore_ui_file_closure);
428 c->variable = variable;
429 c->value = *variable;
431 return make_cleanup_dtor (do_restore_ui_file, (void *) c, xfree);
435 make_my_cleanup2 (struct cleanup **pmy_chain, make_cleanup_ftype *function,
436 void *arg, void (*free_arg) (void *))
439 = (struct cleanup *) xmalloc (sizeof (struct cleanup));
440 struct cleanup *old_chain = *pmy_chain;
442 new->next = *pmy_chain;
443 new->function = function;
444 new->free_arg = free_arg;
452 make_my_cleanup (struct cleanup **pmy_chain, make_cleanup_ftype *function,
455 return make_my_cleanup2 (pmy_chain, function, arg, NULL);
458 /* Discard cleanups and do the actions they describe
459 until we get back to the point OLD_CHAIN in the cleanup_chain. */
462 do_cleanups (struct cleanup *old_chain)
464 do_my_cleanups (&cleanup_chain, old_chain);
468 do_final_cleanups (struct cleanup *old_chain)
470 do_my_cleanups (&final_cleanup_chain, old_chain);
474 do_my_cleanups (struct cleanup **pmy_chain,
475 struct cleanup *old_chain)
479 while ((ptr = *pmy_chain) != old_chain)
481 *pmy_chain = ptr->next; /* Do this first in case of recursion. */
482 (*ptr->function) (ptr->arg);
484 (*ptr->free_arg) (ptr->arg);
489 /* Discard cleanups, not doing the actions they describe,
490 until we get back to the point OLD_CHAIN in the cleanup_chain. */
493 discard_cleanups (struct cleanup *old_chain)
495 discard_my_cleanups (&cleanup_chain, old_chain);
499 discard_final_cleanups (struct cleanup *old_chain)
501 discard_my_cleanups (&final_cleanup_chain, old_chain);
505 discard_my_cleanups (struct cleanup **pmy_chain,
506 struct cleanup *old_chain)
510 while ((ptr = *pmy_chain) != old_chain)
512 *pmy_chain = ptr->next;
514 (*ptr->free_arg) (ptr->arg);
519 /* Set the cleanup_chain to 0, and return the old cleanup chain. */
523 return save_my_cleanups (&cleanup_chain);
527 save_final_cleanups (void)
529 return save_my_cleanups (&final_cleanup_chain);
533 save_my_cleanups (struct cleanup **pmy_chain)
535 struct cleanup *old_chain = *pmy_chain;
541 /* Restore the cleanup chain from a previously saved chain. */
543 restore_cleanups (struct cleanup *chain)
545 restore_my_cleanups (&cleanup_chain, chain);
549 restore_final_cleanups (struct cleanup *chain)
551 restore_my_cleanups (&final_cleanup_chain, chain);
555 restore_my_cleanups (struct cleanup **pmy_chain, struct cleanup *chain)
560 /* This function is useful for cleanups.
564 old_chain = make_cleanup (free_current_contents, &foo);
566 to arrange to free the object thus allocated. */
569 free_current_contents (void *ptr)
571 void **location = ptr;
573 if (location == NULL)
574 internal_error (__FILE__, __LINE__,
575 _("free_current_contents: NULL pointer"));
576 if (*location != NULL)
583 /* Provide a known function that does nothing, to use as a base for
584 for a possibly long chain of cleanups. This is useful where we
585 use the cleanup chain for handling normal cleanups as well as dealing
586 with cleanups that need to be done as a result of a call to error().
587 In such cases, we may not be certain where the first cleanup is, unless
588 we have a do-nothing one to always use as the base. */
591 null_cleanup (void *arg)
595 /* If nonzero, display time usage both at startup and for each command. */
597 static int display_time;
599 /* If nonzero, display space usage both at startup and for each command. */
601 static int display_space;
603 /* Records a run time and space usage to be used as a base for
604 reporting elapsed time or change in space. In addition,
605 the msg_type field indicates whether the saved time is from the
606 beginning of GDB execution (0) or the beginning of an individual
607 command execution (1). */
615 /* Set whether to display time statistics to NEW_VALUE (non-zero
618 set_display_time (int new_value)
620 display_time = new_value;
623 /* Set whether to display space statistics to NEW_VALUE (non-zero
626 set_display_space (int new_value)
628 display_space = new_value;
631 /* As indicated by display_time and display_space, report GDB's elapsed time
632 and space usage from the base time and space provided in ARG, which
633 must be a pointer to a struct cmd_stat. This function is intended
634 to be called as a cleanup. */
636 report_command_stats (void *arg)
638 struct cmd_stats *start_stats = (struct cmd_stats *) arg;
639 int msg_type = start_stats->msg_type;
643 long cmd_time = get_run_time () - start_stats->start_time;
645 printf_unfiltered (msg_type == 0
646 ? _("Startup time: %ld.%06ld\n")
647 : _("Command execution time: %ld.%06ld\n"),
648 cmd_time / 1000000, cmd_time % 1000000);
654 char *lim = (char *) sbrk (0);
656 long space_now = lim - lim_at_start;
657 long space_diff = space_now - start_stats->start_space;
659 printf_unfiltered (msg_type == 0
660 ? _("Space used: %ld (%c%ld during startup)\n")
661 : _("Space used: %ld (%c%ld for this command)\n"),
663 (space_diff >= 0 ? '+' : '-'),
669 /* Create a cleanup that reports time and space used since its
670 creation. Precise messages depend on MSG_TYPE:
671 0: Initial time/space
672 1: Individual command time/space. */
674 make_command_stats_cleanup (int msg_type)
676 struct cmd_stats *new_stat = XMALLOC (struct cmd_stats);
679 char *lim = (char *) sbrk (0);
680 new_stat->start_space = lim - lim_at_start;
683 new_stat->msg_type = msg_type;
684 new_stat->start_time = get_run_time ();
686 return make_cleanup_dtor (report_command_stats, new_stat, xfree);
689 /* Continuations are implemented as cleanups internally. Inherit from
696 /* Add a continuation to the continuation list of THREAD. The new
697 continuation will be added at the front. */
699 add_continuation (struct thread_info *thread,
700 void (*continuation_hook) (void *), void *args,
701 void (*continuation_free_args) (void *))
703 struct cleanup *as_cleanup = &thread->continuations->base;
704 make_cleanup_ftype *continuation_hook_fn = continuation_hook;
706 make_my_cleanup2 (&as_cleanup,
707 continuation_hook_fn,
709 continuation_free_args);
711 thread->continuations = (struct continuation *) as_cleanup;
714 /* Add a continuation to the continuation list of INFERIOR. The new
715 continuation will be added at the front. */
718 add_inferior_continuation (void (*continuation_hook) (void *), void *args,
719 void (*continuation_free_args) (void *))
721 struct inferior *inf = current_inferior ();
722 struct cleanup *as_cleanup = &inf->continuations->base;
723 make_cleanup_ftype *continuation_hook_fn = continuation_hook;
725 make_my_cleanup2 (&as_cleanup,
726 continuation_hook_fn,
728 continuation_free_args);
730 inf->continuations = (struct continuation *) as_cleanup;
733 /* Do all continuations of the current inferior. */
736 do_all_inferior_continuations (void)
738 struct cleanup *as_cleanup;
739 struct inferior *inf = current_inferior ();
741 if (inf->continuations == NULL)
744 /* Copy the list header into another pointer, and set the global
745 list header to null, so that the global list can change as a side
746 effect of invoking the continuations and the processing of the
747 preexisting continuations will not be affected. */
749 as_cleanup = &inf->continuations->base;
750 inf->continuations = NULL;
752 /* Work now on the list we have set aside. */
753 do_my_cleanups (&as_cleanup, NULL);
756 /* Get rid of all the inferior-wide continuations of INF. */
759 discard_all_inferior_continuations (struct inferior *inf)
761 struct cleanup *continuation_ptr = &inf->continuations->base;
763 discard_my_cleanups (&continuation_ptr, NULL);
764 inf->continuations = NULL;
768 restore_thread_cleanup (void *arg)
770 ptid_t *ptid_p = arg;
772 switch_to_thread (*ptid_p);
775 /* Walk down the continuation list of PTID, and execute all the
776 continuations. There is a problem though. In some cases new
777 continuations may be added while we are in the middle of this loop.
778 If this happens they will be added in the front, and done before we
779 have a chance of exhausting those that were already there. We need
780 to then save the beginning of the list in a pointer and do the
781 continuations from there on, instead of using the global beginning
782 of list as our iteration pointer. */
784 do_all_continuations_ptid (ptid_t ptid,
785 struct continuation **continuations_p)
787 struct cleanup *old_chain;
788 ptid_t current_thread;
789 struct cleanup *as_cleanup;
791 if (*continuations_p == NULL)
794 current_thread = inferior_ptid;
796 /* Restore selected thread on exit. Don't try to restore the frame
799 - When running continuations, the selected frame is always #0.
801 - The continuations may trigger symbol file loads, which may
802 change the frame layout (frame ids change), which would trigger
803 a warning if we used make_cleanup_restore_current_thread. */
805 old_chain = make_cleanup (restore_thread_cleanup, ¤t_thread);
807 /* Let the continuation see this thread as selected. */
808 switch_to_thread (ptid);
810 /* Copy the list header into another pointer, and set the global
811 list header to null, so that the global list can change as a side
812 effect of invoking the continuations and the processing of the
813 preexisting continuations will not be affected. */
815 as_cleanup = &(*continuations_p)->base;
816 *continuations_p = NULL;
818 /* Work now on the list we have set aside. */
819 do_my_cleanups (&as_cleanup, NULL);
821 do_cleanups (old_chain);
824 /* Callback for iterate over threads. */
826 do_all_continuations_thread_callback (struct thread_info *thread, void *data)
828 do_all_continuations_ptid (thread->ptid, &thread->continuations);
832 /* Do all continuations of thread THREAD. */
834 do_all_continuations_thread (struct thread_info *thread)
836 do_all_continuations_thread_callback (thread, NULL);
839 /* Do all continuations of all threads. */
841 do_all_continuations (void)
843 iterate_over_threads (do_all_continuations_thread_callback, NULL);
846 /* Callback for iterate over threads. */
848 discard_all_continuations_thread_callback (struct thread_info *thread,
851 struct cleanup *continuation_ptr = &thread->continuations->base;
853 discard_my_cleanups (&continuation_ptr, NULL);
854 thread->continuations = NULL;
858 /* Get rid of all the continuations of THREAD. */
860 discard_all_continuations_thread (struct thread_info *thread)
862 discard_all_continuations_thread_callback (thread, NULL);
865 /* Get rid of all the continuations of all threads. */
867 discard_all_continuations (void)
869 iterate_over_threads (discard_all_continuations_thread_callback, NULL);
873 /* Add a continuation to the intermediate continuation list of THREAD.
874 The new continuation will be added at the front. */
876 add_intermediate_continuation (struct thread_info *thread,
877 void (*continuation_hook)
878 (void *), void *args,
879 void (*continuation_free_args) (void *))
881 struct cleanup *as_cleanup = &thread->intermediate_continuations->base;
882 make_cleanup_ftype *continuation_hook_fn = continuation_hook;
884 make_my_cleanup2 (&as_cleanup,
885 continuation_hook_fn,
887 continuation_free_args);
889 thread->intermediate_continuations = (struct continuation *) as_cleanup;
892 /* Walk down the cmd_continuation list, and execute all the
893 continuations. There is a problem though. In some cases new
894 continuations may be added while we are in the middle of this
895 loop. If this happens they will be added in the front, and done
896 before we have a chance of exhausting those that were already
897 there. We need to then save the beginning of the list in a pointer
898 and do the continuations from there on, instead of using the
899 global beginning of list as our iteration pointer. */
901 do_all_intermediate_continuations_thread_callback (struct thread_info *thread,
904 do_all_continuations_ptid (thread->ptid,
905 &thread->intermediate_continuations);
909 /* Do all intermediate continuations of thread THREAD. */
911 do_all_intermediate_continuations_thread (struct thread_info *thread)
913 do_all_intermediate_continuations_thread_callback (thread, NULL);
916 /* Do all intermediate continuations of all threads. */
918 do_all_intermediate_continuations (void)
920 iterate_over_threads (do_all_intermediate_continuations_thread_callback,
924 /* Callback for iterate over threads. */
926 discard_all_intermediate_continuations_thread_callback (struct thread_info *thread,
929 struct cleanup *continuation_ptr = &thread->intermediate_continuations->base;
931 discard_my_cleanups (&continuation_ptr, NULL);
932 thread->intermediate_continuations = NULL;
936 /* Get rid of all the intermediate continuations of THREAD. */
938 discard_all_intermediate_continuations_thread (struct thread_info *thread)
940 discard_all_intermediate_continuations_thread_callback (thread, NULL);
943 /* Get rid of all the intermediate continuations of all threads. */
945 discard_all_intermediate_continuations (void)
947 iterate_over_threads (discard_all_intermediate_continuations_thread_callback,
953 /* Print a warning message. The first argument STRING is the warning
954 message, used as an fprintf format string, the second is the
955 va_list of arguments for that string. A warning is unfiltered (not
956 paginated) so that the user does not need to page through each
957 screen full of warnings when there are lots of them. */
960 vwarning (const char *string, va_list args)
962 if (deprecated_warning_hook)
963 (*deprecated_warning_hook) (string, args);
966 target_terminal_ours ();
967 wrap_here (""); /* Force out any buffered output. */
968 gdb_flush (gdb_stdout);
969 if (warning_pre_print)
970 fputs_unfiltered (warning_pre_print, gdb_stderr);
971 vfprintf_unfiltered (gdb_stderr, string, args);
972 fprintf_unfiltered (gdb_stderr, "\n");
977 /* Print a warning message.
978 The first argument STRING is the warning message, used as a fprintf string,
979 and the remaining args are passed as arguments to it.
980 The primary difference between warnings and errors is that a warning
981 does not force the return to command level. */
984 warning (const char *string, ...)
988 va_start (args, string);
989 vwarning (string, args);
993 /* Print an error message and return to command level.
994 The first argument STRING is the error message, used as a fprintf string,
995 and the remaining args are passed as arguments to it. */
998 verror (const char *string, va_list args)
1000 throw_verror (GENERIC_ERROR, string, args);
1004 error (const char *string, ...)
1008 va_start (args, string);
1009 throw_verror (GENERIC_ERROR, string, args);
1013 /* Print an error message and quit.
1014 The first argument STRING is the error message, used as a fprintf string,
1015 and the remaining args are passed as arguments to it. */
1018 vfatal (const char *string, va_list args)
1020 throw_vfatal (string, args);
1024 fatal (const char *string, ...)
1028 va_start (args, string);
1029 throw_vfatal (string, args);
1034 error_stream (struct ui_file *stream)
1036 char *message = ui_file_xstrdup (stream, NULL);
1038 make_cleanup (xfree, message);
1039 error (("%s"), message);
1042 /* Dump core trying to increase the core soft limit to hard limit first. */
1047 #ifdef HAVE_SETRLIMIT
1048 struct rlimit rlim = { RLIM_INFINITY, RLIM_INFINITY };
1050 setrlimit (RLIMIT_CORE, &rlim);
1051 #endif /* HAVE_SETRLIMIT */
1053 abort (); /* NOTE: GDB has only three calls to abort(). */
1056 /* Check whether GDB will be able to dump core using the dump_core
1060 can_dump_core (const char *reason)
1062 #ifdef HAVE_GETRLIMIT
1065 /* Be quiet and assume we can dump if an error is returned. */
1066 if (getrlimit (RLIMIT_CORE, &rlim) != 0)
1069 if (rlim.rlim_max == 0)
1071 fprintf_unfiltered (gdb_stderr,
1072 _("%s\nUnable to dump core, use `ulimit -c"
1073 " unlimited' before executing GDB next time.\n"),
1077 #endif /* HAVE_GETRLIMIT */
1082 /* Allow the user to configure the debugger behavior with respect to
1083 what to do when an internal problem is detected. */
1085 const char internal_problem_ask[] = "ask";
1086 const char internal_problem_yes[] = "yes";
1087 const char internal_problem_no[] = "no";
1088 static const char *internal_problem_modes[] =
1090 internal_problem_ask,
1091 internal_problem_yes,
1092 internal_problem_no,
1096 /* Print a message reporting an internal error/warning. Ask the user
1097 if they want to continue, dump core, or just exit. Return
1098 something to indicate a quit. */
1100 struct internal_problem
1103 const char *should_quit;
1104 const char *should_dump_core;
1107 /* Report a problem, internal to GDB, to the user. Once the problem
1108 has been reported, and assuming GDB didn't quit, the caller can
1109 either allow execution to resume or throw an error. */
1111 static void ATTRIBUTE_PRINTF (4, 0)
1112 internal_vproblem (struct internal_problem *problem,
1113 const char *file, int line, const char *fmt, va_list ap)
1120 /* Don't allow infinite error/warning recursion. */
1122 static char msg[] = "Recursive internal problem.\n";
1131 fputs_unfiltered (msg, gdb_stderr);
1132 abort (); /* NOTE: GDB has only three calls to abort(). */
1135 /* Newer GLIBC versions put the warn_unused_result attribute
1136 on write, but this is one of those rare cases where
1137 ignoring the return value is correct. Casting to (void)
1138 does not fix this problem. This is the solution suggested
1139 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
1140 if (write (STDERR_FILENO, msg, sizeof (msg)) != sizeof (msg))
1141 abort (); /* NOTE: GDB has only three calls to abort(). */
1146 /* Try to get the message out and at the start of a new line. */
1147 target_terminal_ours ();
1150 /* Create a string containing the full error/warning message. Need
1151 to call query with this full string, as otherwize the reason
1152 (error/warning) and question become separated. Format using a
1153 style similar to a compiler error message. Include extra detail
1154 so that the user knows that they are living on the edge. */
1158 msg = xstrvprintf (fmt, ap);
1159 reason = xstrprintf ("%s:%d: %s: %s\n"
1160 "A problem internal to GDB has been detected,\n"
1161 "further debugging may prove unreliable.",
1162 file, line, problem->name, msg);
1164 make_cleanup (xfree, reason);
1167 if (problem->should_quit == internal_problem_ask)
1169 /* Default (yes/batch case) is to quit GDB. When in batch mode
1170 this lessens the likelihood of GDB going into an infinite
1174 /* Emit the message and quit. */
1175 fputs_unfiltered (reason, gdb_stderr);
1176 fputs_unfiltered ("\n", gdb_stderr);
1180 quit_p = query (_("%s\nQuit this debugging session? "), reason);
1182 else if (problem->should_quit == internal_problem_yes)
1184 else if (problem->should_quit == internal_problem_no)
1187 internal_error (__FILE__, __LINE__, _("bad switch"));
1189 if (problem->should_dump_core == internal_problem_ask)
1191 if (!can_dump_core (reason))
1195 /* Default (yes/batch case) is to dump core. This leaves a GDB
1196 `dropping' so that it is easier to see that something went
1198 dump_core_p = query (_("%s\nCreate a core file of GDB? "), reason);
1201 else if (problem->should_dump_core == internal_problem_yes)
1202 dump_core_p = can_dump_core (reason);
1203 else if (problem->should_dump_core == internal_problem_no)
1206 internal_error (__FILE__, __LINE__, _("bad switch"));
1219 #ifdef HAVE_WORKING_FORK
1229 static struct internal_problem internal_error_problem = {
1230 "internal-error", internal_problem_ask, internal_problem_ask
1234 internal_verror (const char *file, int line, const char *fmt, va_list ap)
1236 internal_vproblem (&internal_error_problem, file, line, fmt, ap);
1237 deprecated_throw_reason (RETURN_ERROR);
1241 internal_error (const char *file, int line, const char *string, ...)
1245 va_start (ap, string);
1246 internal_verror (file, line, string, ap);
1250 static struct internal_problem internal_warning_problem = {
1251 "internal-warning", internal_problem_ask, internal_problem_ask
1255 internal_vwarning (const char *file, int line, const char *fmt, va_list ap)
1257 internal_vproblem (&internal_warning_problem, file, line, fmt, ap);
1261 internal_warning (const char *file, int line, const char *string, ...)
1265 va_start (ap, string);
1266 internal_vwarning (file, line, string, ap);
1270 /* Dummy functions to keep add_prefix_cmd happy. */
1273 set_internal_problem_cmd (char *args, int from_tty)
1278 show_internal_problem_cmd (char *args, int from_tty)
1282 /* When GDB reports an internal problem (error or warning) it gives
1283 the user the opportunity to quit GDB and/or create a core file of
1284 the current debug session. This function registers a few commands
1285 that make it possible to specify that GDB should always or never
1286 quit or create a core file, without asking. The commands look
1289 maint set PROBLEM-NAME quit ask|yes|no
1290 maint show PROBLEM-NAME quit
1291 maint set PROBLEM-NAME corefile ask|yes|no
1292 maint show PROBLEM-NAME corefile
1294 Where PROBLEM-NAME is currently "internal-error" or
1295 "internal-warning". */
1298 add_internal_problem_command (struct internal_problem *problem)
1300 struct cmd_list_element **set_cmd_list;
1301 struct cmd_list_element **show_cmd_list;
1305 set_cmd_list = xmalloc (sizeof (*set_cmd_list));
1306 show_cmd_list = xmalloc (sizeof (*set_cmd_list));
1307 *set_cmd_list = NULL;
1308 *show_cmd_list = NULL;
1310 set_doc = xstrprintf (_("Configure what GDB does when %s is detected."),
1313 show_doc = xstrprintf (_("Show what GDB does when %s is detected."),
1316 add_prefix_cmd ((char*) problem->name,
1317 class_maintenance, set_internal_problem_cmd, set_doc,
1319 concat ("maintenance set ", problem->name, " ",
1321 0/*allow-unknown*/, &maintenance_set_cmdlist);
1323 add_prefix_cmd ((char*) problem->name,
1324 class_maintenance, show_internal_problem_cmd, show_doc,
1326 concat ("maintenance show ", problem->name, " ",
1328 0/*allow-unknown*/, &maintenance_show_cmdlist);
1330 set_doc = xstrprintf (_("Set whether GDB should quit "
1331 "when an %s is detected"),
1333 show_doc = xstrprintf (_("Show whether GDB will quit "
1334 "when an %s is detected"),
1336 add_setshow_enum_cmd ("quit", class_maintenance,
1337 internal_problem_modes,
1338 &problem->should_quit,
1341 NULL, /* help_doc */
1343 NULL, /* showfunc */
1350 set_doc = xstrprintf (_("Set whether GDB should create a core "
1351 "file of GDB when %s is detected"),
1353 show_doc = xstrprintf (_("Show whether GDB will create a core "
1354 "file of GDB when %s is detected"),
1356 add_setshow_enum_cmd ("corefile", class_maintenance,
1357 internal_problem_modes,
1358 &problem->should_dump_core,
1361 NULL, /* help_doc */
1363 NULL, /* showfunc */
1371 /* Print the system error message for errno, and also mention STRING
1372 as the file name for which the error was encountered.
1373 Then return to command level. */
1376 perror_with_name (const char *string)
1381 err = safe_strerror (errno);
1382 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
1383 strcpy (combined, string);
1384 strcat (combined, ": ");
1385 strcat (combined, err);
1387 /* I understand setting these is a matter of taste. Still, some people
1388 may clear errno but not know about bfd_error. Doing this here is not
1390 bfd_set_error (bfd_error_no_error);
1393 error (_("%s."), combined);
1396 /* Print the system error message for ERRCODE, and also mention STRING
1397 as the file name for which the error was encountered. */
1400 print_sys_errmsg (const char *string, int errcode)
1405 err = safe_strerror (errcode);
1406 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
1407 strcpy (combined, string);
1408 strcat (combined, ": ");
1409 strcat (combined, err);
1411 /* We want anything which was printed on stdout to come out first, before
1413 gdb_flush (gdb_stdout);
1414 fprintf_unfiltered (gdb_stderr, "%s.\n", combined);
1417 /* Control C eventually causes this to be called, at a convenient time. */
1423 /* No steenking SIGINT will ever be coming our way when the
1424 program is resumed. Don't lie. */
1428 /* If there is no terminal switching for this target, then we can't
1429 possibly get screwed by the lack of job control. */
1430 || current_target.to_terminal_ours == NULL)
1433 fatal ("Quit (expect signal SIGINT when the program is resumed)");
1438 /* Called when a memory allocation fails, with the number of bytes of
1439 memory requested in SIZE. */
1446 internal_error (__FILE__, __LINE__,
1447 _("virtual memory exhausted: can't allocate %ld bytes."),
1452 internal_error (__FILE__, __LINE__, _("virtual memory exhausted."));
1456 /* The xmalloc() (libiberty.h) family of memory management routines.
1458 These are like the ISO-C malloc() family except that they implement
1459 consistent semantics and guard against typical memory management
1462 /* NOTE: These are declared using PTR to ensure consistency with
1463 "libiberty.h". xfree() is GDB local. */
1466 xmalloc (size_t size)
1470 /* See libiberty/xmalloc.c. This function need's to match that's
1471 semantics. It never returns NULL. */
1475 val = malloc (size); /* ARI: malloc */
1483 xzalloc (size_t size)
1485 return xcalloc (1, size);
1489 xrealloc (PTR ptr, size_t size) /* ARI: PTR */
1493 /* See libiberty/xmalloc.c. This function need's to match that's
1494 semantics. It never returns NULL. */
1499 val = realloc (ptr, size); /* ARI: realloc */
1501 val = malloc (size); /* ARI: malloc */
1509 xcalloc (size_t number, size_t size)
1513 /* See libiberty/xmalloc.c. This function need's to match that's
1514 semantics. It never returns NULL. */
1515 if (number == 0 || size == 0)
1521 mem = calloc (number, size); /* ARI: xcalloc */
1523 nomem (number * size);
1532 free (ptr); /* ARI: free */
1536 /* Like asprintf/vasprintf but get an internal_error if the call
1540 xstrprintf (const char *format, ...)
1545 va_start (args, format);
1546 ret = xstrvprintf (format, args);
1552 xasprintf (char **ret, const char *format, ...)
1556 va_start (args, format);
1557 (*ret) = xstrvprintf (format, args);
1562 xvasprintf (char **ret, const char *format, va_list ap)
1564 (*ret) = xstrvprintf (format, ap);
1568 xstrvprintf (const char *format, va_list ap)
1571 int status = vasprintf (&ret, format, ap);
1573 /* NULL is returned when there was a memory allocation problem, or
1574 any other error (for instance, a bad format string). A negative
1575 status (the printed length) with a non-NULL buffer should never
1576 happen, but just to be sure. */
1577 if (ret == NULL || status < 0)
1578 internal_error (__FILE__, __LINE__, _("vasprintf call failed"));
1583 xsnprintf (char *str, size_t size, const char *format, ...)
1588 va_start (args, format);
1589 ret = vsnprintf (str, size, format, args);
1590 gdb_assert (ret < size);
1596 /* My replacement for the read system call.
1597 Used like `read' but keeps going if `read' returns too soon. */
1600 myread (int desc, char *addr, int len)
1607 val = read (desc, addr, len);
1611 return orglen - len;
1618 /* Make a copy of the string at PTR with SIZE characters
1619 (and add a null character at the end in the copy).
1620 Uses malloc to get the space. Returns the address of the copy. */
1623 savestring (const char *ptr, size_t size)
1625 char *p = (char *) xmalloc (size + 1);
1627 memcpy (p, ptr, size);
1633 print_spaces (int n, struct ui_file *file)
1635 fputs_unfiltered (n_spaces (n), file);
1638 /* Print a host address. */
1641 gdb_print_host_address (const void *addr, struct ui_file *stream)
1643 fprintf_filtered (stream, "%s", host_address_to_string (addr));
1647 /* A cleanup function that calls regfree. */
1650 do_regfree_cleanup (void *r)
1655 /* Create a new cleanup that frees the compiled regular expression R. */
1658 make_regfree_cleanup (regex_t *r)
1660 return make_cleanup (do_regfree_cleanup, r);
1663 /* Return an xmalloc'd error message resulting from a regular
1664 expression compilation failure. */
1667 get_regcomp_error (int code, regex_t *rx)
1669 size_t length = regerror (code, rx, NULL, 0);
1670 char *result = xmalloc (length);
1672 regerror (code, rx, result, length);
1678 /* This function supports the query, nquery, and yquery functions.
1679 Ask user a y-or-n question and return 0 if answer is no, 1 if
1680 answer is yes, or default the answer to the specified default
1681 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1682 default answer, or '\0' for no default.
1683 CTLSTR is the control string and should end in "? ". It should
1684 not say how to answer, because we do that.
1685 ARGS are the arguments passed along with the CTLSTR argument to
1688 static int ATTRIBUTE_PRINTF (1, 0)
1689 defaulted_query (const char *ctlstr, const char defchar, va_list args)
1695 char def_answer, not_def_answer;
1696 char *y_string, *n_string, *question;
1698 /* Set up according to which answer is the default. */
1699 if (defchar == '\0')
1703 not_def_answer = 'N';
1707 else if (defchar == 'y')
1711 not_def_answer = 'N';
1719 not_def_answer = 'Y';
1724 /* Automatically answer the default value if the user did not want
1725 prompts or the command was issued with the server prefix. */
1726 if (! caution || server_command)
1729 /* If input isn't coming from the user directly, just say what
1730 question we're asking, and then answer the default automatically. This
1731 way, important error messages don't get lost when talking to GDB
1733 if (! input_from_terminal_p ())
1736 vfprintf_filtered (gdb_stdout, ctlstr, args);
1738 printf_filtered (_("(%s or %s) [answered %c; "
1739 "input not from terminal]\n"),
1740 y_string, n_string, def_answer);
1741 gdb_flush (gdb_stdout);
1746 if (deprecated_query_hook)
1748 return deprecated_query_hook (ctlstr, args);
1751 /* Format the question outside of the loop, to avoid reusing args. */
1752 question = xstrvprintf (ctlstr, args);
1756 wrap_here (""); /* Flush any buffered output. */
1757 gdb_flush (gdb_stdout);
1759 if (annotation_level > 1)
1760 printf_filtered (("\n\032\032pre-query\n"));
1762 fputs_filtered (question, gdb_stdout);
1763 printf_filtered (_("(%s or %s) "), y_string, n_string);
1765 if (annotation_level > 1)
1766 printf_filtered (("\n\032\032query\n"));
1769 gdb_flush (gdb_stdout);
1771 answer = fgetc (stdin);
1773 /* We expect fgetc to block until a character is read. But
1774 this may not be the case if the terminal was opened with
1775 the NONBLOCK flag. In that case, if there is nothing to
1776 read on stdin, fgetc returns EOF, but also sets the error
1777 condition flag on stdin and errno to EAGAIN. With a true
1778 EOF, stdin's error condition flag is not set.
1780 A situation where this behavior was observed is a pseudo
1782 while (answer == EOF && ferror (stdin) && errno == EAGAIN)
1784 /* Not a real EOF. Wait a little while and try again until
1785 we read something. */
1788 answer = fgetc (stdin);
1791 clearerr (stdin); /* in case of C-d */
1792 if (answer == EOF) /* C-d */
1794 printf_filtered ("EOF [assumed %c]\n", def_answer);
1798 /* Eat rest of input line, to EOF or newline. */
1802 ans2 = fgetc (stdin);
1805 while (ans2 != EOF && ans2 != '\n' && ans2 != '\r');
1809 /* Check answer. For the non-default, the user must specify
1810 the non-default explicitly. */
1811 if (answer == not_def_answer)
1813 retval = !def_value;
1816 /* Otherwise, if a default was specified, the user may either
1817 specify the required input or have it default by entering
1819 if (answer == def_answer
1820 || (defchar != '\0' &&
1821 (answer == '\n' || answer == '\r' || answer == EOF)))
1826 /* Invalid entries are not defaulted and require another selection. */
1827 printf_filtered (_("Please answer %s or %s.\n"),
1828 y_string, n_string);
1832 if (annotation_level > 1)
1833 printf_filtered (("\n\032\032post-query\n"));
1838 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1839 answer is yes, or 0 if answer is defaulted.
1840 Takes three args which are given to printf to print the question.
1841 The first, a control string, should end in "? ".
1842 It should not say how to answer, because we do that. */
1845 nquery (const char *ctlstr, ...)
1850 va_start (args, ctlstr);
1851 ret = defaulted_query (ctlstr, 'n', args);
1856 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1857 answer is yes, or 1 if answer is defaulted.
1858 Takes three args which are given to printf to print the question.
1859 The first, a control string, should end in "? ".
1860 It should not say how to answer, because we do that. */
1863 yquery (const char *ctlstr, ...)
1868 va_start (args, ctlstr);
1869 ret = defaulted_query (ctlstr, 'y', args);
1874 /* Ask user a y-or-n question and return 1 iff answer is yes.
1875 Takes three args which are given to printf to print the question.
1876 The first, a control string, should end in "? ".
1877 It should not say how to answer, because we do that. */
1880 query (const char *ctlstr, ...)
1885 va_start (args, ctlstr);
1886 ret = defaulted_query (ctlstr, '\0', args);
1891 /* A helper for parse_escape that converts a host character to a
1892 target character. C is the host character. If conversion is
1893 possible, then the target character is stored in *TARGET_C and the
1894 function returns 1. Otherwise, the function returns 0. */
1897 host_char_to_target (struct gdbarch *gdbarch, int c, int *target_c)
1899 struct obstack host_data;
1901 struct cleanup *cleanups;
1904 obstack_init (&host_data);
1905 cleanups = make_cleanup_obstack_free (&host_data);
1907 convert_between_encodings (target_charset (gdbarch), host_charset (),
1908 &the_char, 1, 1, &host_data, translit_none);
1910 if (obstack_object_size (&host_data) == 1)
1913 *target_c = *(char *) obstack_base (&host_data);
1916 do_cleanups (cleanups);
1920 /* Parse a C escape sequence. STRING_PTR points to a variable
1921 containing a pointer to the string to parse. That pointer
1922 should point to the character after the \. That pointer
1923 is updated past the characters we use. The value of the
1924 escape sequence is returned.
1926 A negative value means the sequence \ newline was seen,
1927 which is supposed to be equivalent to nothing at all.
1929 If \ is followed by a null character, we return a negative
1930 value and leave the string pointer pointing at the null character.
1932 If \ is followed by 000, we return 0 and leave the string pointer
1933 after the zeros. A value of 0 does not mean end of string. */
1936 parse_escape (struct gdbarch *gdbarch, char **string_ptr)
1938 int target_char = -2; /* Initialize to avoid GCC warnings. */
1939 int c = *(*string_ptr)++;
1958 int i = host_hex_value (c);
1963 if (isdigit (c) && c != '8' && c != '9')
1967 i += host_hex_value (c);
2003 if (!host_char_to_target (gdbarch, c, &target_char))
2005 ("The escape sequence `\%c' is equivalent to plain `%c', which"
2006 " has no equivalent\n" "in the `%s' character set.", c, c,
2007 target_charset (gdbarch));
2011 /* Print the character C on STREAM as part of the contents of a literal
2012 string whose delimiter is QUOTER. Note that this routine should only
2013 be call for printing things which are independent of the language
2014 of the program being debugged. */
2017 printchar (int c, void (*do_fputs) (const char *, struct ui_file *),
2018 void (*do_fprintf) (struct ui_file *, const char *, ...)
2019 ATTRIBUTE_FPTR_PRINTF_2, struct ui_file *stream, int quoter)
2021 c &= 0xFF; /* Avoid sign bit follies */
2023 if (c < 0x20 || /* Low control chars */
2024 (c >= 0x7F && c < 0xA0) || /* DEL, High controls */
2025 (sevenbit_strings && c >= 0x80))
2026 { /* high order bit set */
2030 do_fputs ("\\n", stream);
2033 do_fputs ("\\b", stream);
2036 do_fputs ("\\t", stream);
2039 do_fputs ("\\f", stream);
2042 do_fputs ("\\r", stream);
2045 do_fputs ("\\e", stream);
2048 do_fputs ("\\a", stream);
2051 do_fprintf (stream, "\\%.3o", (unsigned int) c);
2057 if (c == '\\' || c == quoter)
2058 do_fputs ("\\", stream);
2059 do_fprintf (stream, "%c", c);
2063 /* Print the character C on STREAM as part of the contents of a
2064 literal string whose delimiter is QUOTER. Note that these routines
2065 should only be call for printing things which are independent of
2066 the language of the program being debugged. */
2069 fputstr_filtered (const char *str, int quoter, struct ui_file *stream)
2072 printchar (*str++, fputs_filtered, fprintf_filtered, stream, quoter);
2076 fputstr_unfiltered (const char *str, int quoter, struct ui_file *stream)
2079 printchar (*str++, fputs_unfiltered, fprintf_unfiltered, stream, quoter);
2083 fputstrn_filtered (const char *str, int n, int quoter,
2084 struct ui_file *stream)
2088 for (i = 0; i < n; i++)
2089 printchar (str[i], fputs_filtered, fprintf_filtered, stream, quoter);
2093 fputstrn_unfiltered (const char *str, int n, int quoter,
2094 struct ui_file *stream)
2098 for (i = 0; i < n; i++)
2099 printchar (str[i], fputs_unfiltered, fprintf_unfiltered, stream, quoter);
2103 /* Number of lines per page or UINT_MAX if paging is disabled. */
2104 static unsigned int lines_per_page;
2106 show_lines_per_page (struct ui_file *file, int from_tty,
2107 struct cmd_list_element *c, const char *value)
2109 fprintf_filtered (file,
2110 _("Number of lines gdb thinks are in a page is %s.\n"),
2114 /* Number of chars per line or UINT_MAX if line folding is disabled. */
2115 static unsigned int chars_per_line;
2117 show_chars_per_line (struct ui_file *file, int from_tty,
2118 struct cmd_list_element *c, const char *value)
2120 fprintf_filtered (file,
2121 _("Number of characters gdb thinks "
2122 "are in a line is %s.\n"),
2126 /* Current count of lines printed on this page, chars on this line. */
2127 static unsigned int lines_printed, chars_printed;
2129 /* Buffer and start column of buffered text, for doing smarter word-
2130 wrapping. When someone calls wrap_here(), we start buffering output
2131 that comes through fputs_filtered(). If we see a newline, we just
2132 spit it out and forget about the wrap_here(). If we see another
2133 wrap_here(), we spit it out and remember the newer one. If we see
2134 the end of the line, we spit out a newline, the indent, and then
2135 the buffered output. */
2137 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
2138 are waiting to be output (they have already been counted in chars_printed).
2139 When wrap_buffer[0] is null, the buffer is empty. */
2140 static char *wrap_buffer;
2142 /* Pointer in wrap_buffer to the next character to fill. */
2143 static char *wrap_pointer;
2145 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
2147 static char *wrap_indent;
2149 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
2150 is not in effect. */
2151 static int wrap_column;
2154 /* Inialize the number of lines per page and chars per line. */
2157 init_page_info (void)
2161 lines_per_page = UINT_MAX;
2162 chars_per_line = UINT_MAX;
2166 if (!tui_get_command_dimension (&chars_per_line, &lines_per_page))
2171 #if defined(__GO32__)
2172 rows = ScreenRows ();
2173 cols = ScreenCols ();
2174 lines_per_page = rows;
2175 chars_per_line = cols;
2177 /* Make sure Readline has initialized its terminal settings. */
2178 rl_reset_terminal (NULL);
2180 /* Get the screen size from Readline. */
2181 rl_get_screen_size (&rows, &cols);
2182 lines_per_page = rows;
2183 chars_per_line = cols;
2185 /* Readline should have fetched the termcap entry for us. */
2186 if (tgetnum ("li") < 0 || getenv ("EMACS"))
2188 /* The number of lines per page is not mentioned in the
2189 terminal description. This probably means that paging is
2190 not useful (e.g. emacs shell window), so disable paging. */
2191 lines_per_page = UINT_MAX;
2194 /* FIXME: Get rid of this junk. */
2195 #if defined(SIGWINCH) && defined(SIGWINCH_HANDLER)
2196 SIGWINCH_HANDLER (SIGWINCH);
2199 /* If the output is not a terminal, don't paginate it. */
2200 if (!ui_file_isatty (gdb_stdout))
2201 lines_per_page = UINT_MAX;
2209 /* Helper for make_cleanup_restore_page_info. */
2212 do_restore_page_info_cleanup (void *arg)
2218 /* Provide cleanup for restoring the terminal size. */
2221 make_cleanup_restore_page_info (void)
2223 struct cleanup *back_to;
2225 back_to = make_cleanup (do_restore_page_info_cleanup, NULL);
2226 make_cleanup_restore_uinteger (&lines_per_page);
2227 make_cleanup_restore_uinteger (&chars_per_line);
2232 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
2233 Provide cleanup for restoring the original state. */
2236 set_batch_flag_and_make_cleanup_restore_page_info (void)
2238 struct cleanup *back_to = make_cleanup_restore_page_info ();
2240 make_cleanup_restore_integer (&batch_flag);
2247 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
2250 set_screen_size (void)
2252 int rows = lines_per_page;
2253 int cols = chars_per_line;
2261 /* Update Readline's idea of the terminal size. */
2262 rl_set_screen_size (rows, cols);
2265 /* Reinitialize WRAP_BUFFER according to the current value of
2271 if (chars_per_line == 0)
2276 wrap_buffer = (char *) xmalloc (chars_per_line + 2);
2277 wrap_buffer[0] = '\0';
2280 wrap_buffer = (char *) xrealloc (wrap_buffer, chars_per_line + 2);
2281 wrap_pointer = wrap_buffer; /* Start it at the beginning. */
2285 set_width_command (char *args, int from_tty, struct cmd_list_element *c)
2292 set_height_command (char *args, int from_tty, struct cmd_list_element *c)
2297 /* Wait, so the user can read what's on the screen. Prompt the user
2298 to continue by pressing RETURN. */
2301 prompt_for_continue (void)
2304 char cont_prompt[120];
2306 if (annotation_level > 1)
2307 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
2309 strcpy (cont_prompt,
2310 "---Type <return> to continue, or q <return> to quit---");
2311 if (annotation_level > 1)
2312 strcat (cont_prompt, "\n\032\032prompt-for-continue\n");
2314 /* We must do this *before* we call gdb_readline, else it will eventually
2315 call us -- thinking that we're trying to print beyond the end of the
2317 reinitialize_more_filter ();
2320 /* On a real operating system, the user can quit with SIGINT.
2323 'q' is provided on all systems so users don't have to change habits
2324 from system to system, and because telling them what to do in
2325 the prompt is more user-friendly than expecting them to think of
2327 /* Call readline, not gdb_readline, because GO32 readline handles control-C
2328 whereas control-C to gdb_readline will cause the user to get dumped
2330 ignore = gdb_readline_wrapper (cont_prompt);
2332 if (annotation_level > 1)
2333 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
2339 while (*p == ' ' || *p == '\t')
2342 async_request_quit (0);
2347 /* Now we have to do this again, so that GDB will know that it doesn't
2348 need to save the ---Type <return>--- line at the top of the screen. */
2349 reinitialize_more_filter ();
2351 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
2354 /* Reinitialize filter; ie. tell it to reset to original values. */
2357 reinitialize_more_filter (void)
2363 /* Indicate that if the next sequence of characters overflows the line,
2364 a newline should be inserted here rather than when it hits the end.
2365 If INDENT is non-null, it is a string to be printed to indent the
2366 wrapped part on the next line. INDENT must remain accessible until
2367 the next call to wrap_here() or until a newline is printed through
2370 If the line is already overfull, we immediately print a newline and
2371 the indentation, and disable further wrapping.
2373 If we don't know the width of lines, but we know the page height,
2374 we must not wrap words, but should still keep track of newlines
2375 that were explicitly printed.
2377 INDENT should not contain tabs, as that will mess up the char count
2378 on the next line. FIXME.
2380 This routine is guaranteed to force out any output which has been
2381 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
2382 used to force out output from the wrap_buffer. */
2385 wrap_here (char *indent)
2387 /* This should have been allocated, but be paranoid anyway. */
2389 internal_error (__FILE__, __LINE__,
2390 _("failed internal consistency check"));
2394 *wrap_pointer = '\0';
2395 fputs_unfiltered (wrap_buffer, gdb_stdout);
2397 wrap_pointer = wrap_buffer;
2398 wrap_buffer[0] = '\0';
2399 if (chars_per_line == UINT_MAX) /* No line overflow checking. */
2403 else if (chars_printed >= chars_per_line)
2405 puts_filtered ("\n");
2407 puts_filtered (indent);
2412 wrap_column = chars_printed;
2416 wrap_indent = indent;
2420 /* Print input string to gdb_stdout, filtered, with wrap,
2421 arranging strings in columns of n chars. String can be
2422 right or left justified in the column. Never prints
2423 trailing spaces. String should never be longer than
2424 width. FIXME: this could be useful for the EXAMINE
2425 command, which currently doesn't tabulate very well. */
2428 puts_filtered_tabular (char *string, int width, int right)
2434 gdb_assert (chars_per_line > 0);
2435 if (chars_per_line == UINT_MAX)
2437 fputs_filtered (string, gdb_stdout);
2438 fputs_filtered ("\n", gdb_stdout);
2442 if (((chars_printed - 1) / width + 2) * width >= chars_per_line)
2443 fputs_filtered ("\n", gdb_stdout);
2445 if (width >= chars_per_line)
2446 width = chars_per_line - 1;
2448 stringlen = strlen (string);
2450 if (chars_printed > 0)
2451 spaces = width - (chars_printed - 1) % width - 1;
2453 spaces += width - stringlen;
2455 spacebuf = alloca (spaces + 1);
2456 spacebuf[spaces] = '\0';
2458 spacebuf[spaces] = ' ';
2460 fputs_filtered (spacebuf, gdb_stdout);
2461 fputs_filtered (string, gdb_stdout);
2465 /* Ensure that whatever gets printed next, using the filtered output
2466 commands, starts at the beginning of the line. I.e. if there is
2467 any pending output for the current line, flush it and start a new
2468 line. Otherwise do nothing. */
2473 if (chars_printed > 0)
2475 puts_filtered ("\n");
2480 /* Like fputs but if FILTER is true, pause after every screenful.
2482 Regardless of FILTER can wrap at points other than the final
2483 character of a line.
2485 Unlike fputs, fputs_maybe_filtered does not return a value.
2486 It is OK for LINEBUFFER to be NULL, in which case just don't print
2489 Note that a longjmp to top level may occur in this routine (only if
2490 FILTER is true) (since prompt_for_continue may do so) so this
2491 routine should not be called when cleanups are not in place. */
2494 fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
2497 const char *lineptr;
2499 if (linebuffer == 0)
2502 /* Don't do any filtering if it is disabled. */
2503 if (stream != gdb_stdout
2504 || ! pagination_enabled
2505 || ! input_from_terminal_p ()
2506 || (lines_per_page == UINT_MAX && chars_per_line == UINT_MAX)
2507 || top_level_interpreter () == NULL
2508 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2510 fputs_unfiltered (linebuffer, stream);
2514 /* Go through and output each character. Show line extension
2515 when this is necessary; prompt user for new page when this is
2518 lineptr = linebuffer;
2521 /* Possible new page. */
2522 if (filter && (lines_printed >= lines_per_page - 1))
2523 prompt_for_continue ();
2525 while (*lineptr && *lineptr != '\n')
2527 /* Print a single line. */
2528 if (*lineptr == '\t')
2531 *wrap_pointer++ = '\t';
2533 fputc_unfiltered ('\t', stream);
2534 /* Shifting right by 3 produces the number of tab stops
2535 we have already passed, and then adding one and
2536 shifting left 3 advances to the next tab stop. */
2537 chars_printed = ((chars_printed >> 3) + 1) << 3;
2543 *wrap_pointer++ = *lineptr;
2545 fputc_unfiltered (*lineptr, stream);
2550 if (chars_printed >= chars_per_line)
2552 unsigned int save_chars = chars_printed;
2556 /* If we aren't actually wrapping, don't output newline --
2557 if chars_per_line is right, we probably just overflowed
2558 anyway; if it's wrong, let us keep going. */
2560 fputc_unfiltered ('\n', stream);
2562 /* Possible new page. */
2563 if (lines_printed >= lines_per_page - 1)
2564 prompt_for_continue ();
2566 /* Now output indentation and wrapped string. */
2569 fputs_unfiltered (wrap_indent, stream);
2570 *wrap_pointer = '\0'; /* Null-terminate saved stuff, */
2571 fputs_unfiltered (wrap_buffer, stream); /* and eject it. */
2572 /* FIXME, this strlen is what prevents wrap_indent from
2573 containing tabs. However, if we recurse to print it
2574 and count its chars, we risk trouble if wrap_indent is
2575 longer than (the user settable) chars_per_line.
2576 Note also that this can set chars_printed > chars_per_line
2577 if we are printing a long string. */
2578 chars_printed = strlen (wrap_indent)
2579 + (save_chars - wrap_column);
2580 wrap_pointer = wrap_buffer; /* Reset buffer */
2581 wrap_buffer[0] = '\0';
2582 wrap_column = 0; /* And disable fancy wrap */
2587 if (*lineptr == '\n')
2590 wrap_here ((char *) 0); /* Spit out chars, cancel
2593 fputc_unfiltered ('\n', stream);
2600 fputs_filtered (const char *linebuffer, struct ui_file *stream)
2602 fputs_maybe_filtered (linebuffer, stream, 1);
2606 putchar_unfiltered (int c)
2610 ui_file_write (gdb_stdout, &buf, 1);
2614 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2615 May return nonlocally. */
2618 putchar_filtered (int c)
2620 return fputc_filtered (c, gdb_stdout);
2624 fputc_unfiltered (int c, struct ui_file *stream)
2628 ui_file_write (stream, &buf, 1);
2633 fputc_filtered (int c, struct ui_file *stream)
2639 fputs_filtered (buf, stream);
2643 /* puts_debug is like fputs_unfiltered, except it prints special
2644 characters in printable fashion. */
2647 puts_debug (char *prefix, char *string, char *suffix)
2651 /* Print prefix and suffix after each line. */
2652 static int new_line = 1;
2653 static int return_p = 0;
2654 static char *prev_prefix = "";
2655 static char *prev_suffix = "";
2657 if (*string == '\n')
2660 /* If the prefix is changing, print the previous suffix, a new line,
2661 and the new prefix. */
2662 if ((return_p || (strcmp (prev_prefix, prefix) != 0)) && !new_line)
2664 fputs_unfiltered (prev_suffix, gdb_stdlog);
2665 fputs_unfiltered ("\n", gdb_stdlog);
2666 fputs_unfiltered (prefix, gdb_stdlog);
2669 /* Print prefix if we printed a newline during the previous call. */
2673 fputs_unfiltered (prefix, gdb_stdlog);
2676 prev_prefix = prefix;
2677 prev_suffix = suffix;
2679 /* Output characters in a printable format. */
2680 while ((ch = *string++) != '\0')
2686 fputc_unfiltered (ch, gdb_stdlog);
2689 fprintf_unfiltered (gdb_stdlog, "\\x%02x", ch & 0xff);
2693 fputs_unfiltered ("\\\\", gdb_stdlog);
2696 fputs_unfiltered ("\\b", gdb_stdlog);
2699 fputs_unfiltered ("\\f", gdb_stdlog);
2703 fputs_unfiltered ("\\n", gdb_stdlog);
2706 fputs_unfiltered ("\\r", gdb_stdlog);
2709 fputs_unfiltered ("\\t", gdb_stdlog);
2712 fputs_unfiltered ("\\v", gdb_stdlog);
2716 return_p = ch == '\r';
2719 /* Print suffix if we printed a newline. */
2722 fputs_unfiltered (suffix, gdb_stdlog);
2723 fputs_unfiltered ("\n", gdb_stdlog);
2728 /* Print a variable number of ARGS using format FORMAT. If this
2729 information is going to put the amount written (since the last call
2730 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2731 call prompt_for_continue to get the users permision to continue.
2733 Unlike fprintf, this function does not return a value.
2735 We implement three variants, vfprintf (takes a vararg list and stream),
2736 fprintf (takes a stream to write on), and printf (the usual).
2738 Note also that a longjmp to top level may occur in this routine
2739 (since prompt_for_continue may do so) so this routine should not be
2740 called when cleanups are not in place. */
2743 vfprintf_maybe_filtered (struct ui_file *stream, const char *format,
2744 va_list args, int filter)
2747 struct cleanup *old_cleanups;
2749 linebuffer = xstrvprintf (format, args);
2750 old_cleanups = make_cleanup (xfree, linebuffer);
2751 fputs_maybe_filtered (linebuffer, stream, filter);
2752 do_cleanups (old_cleanups);
2757 vfprintf_filtered (struct ui_file *stream, const char *format, va_list args)
2759 vfprintf_maybe_filtered (stream, format, args, 1);
2763 vfprintf_unfiltered (struct ui_file *stream, const char *format, va_list args)
2766 struct cleanup *old_cleanups;
2768 linebuffer = xstrvprintf (format, args);
2769 old_cleanups = make_cleanup (xfree, linebuffer);
2770 if (debug_timestamp && stream == gdb_stdlog)
2776 gettimeofday (&tm, NULL);
2778 len = strlen (linebuffer);
2779 need_nl = (len > 0 && linebuffer[len - 1] != '\n');
2781 timestamp = xstrprintf ("%ld:%ld %s%s",
2782 (long) tm.tv_sec, (long) tm.tv_usec,
2784 need_nl ? "\n": "");
2785 make_cleanup (xfree, timestamp);
2786 fputs_unfiltered (timestamp, stream);
2789 fputs_unfiltered (linebuffer, stream);
2790 do_cleanups (old_cleanups);
2794 vprintf_filtered (const char *format, va_list args)
2796 vfprintf_maybe_filtered (gdb_stdout, format, args, 1);
2800 vprintf_unfiltered (const char *format, va_list args)
2802 vfprintf_unfiltered (gdb_stdout, format, args);
2806 fprintf_filtered (struct ui_file *stream, const char *format, ...)
2810 va_start (args, format);
2811 vfprintf_filtered (stream, format, args);
2816 fprintf_unfiltered (struct ui_file *stream, const char *format, ...)
2820 va_start (args, format);
2821 vfprintf_unfiltered (stream, format, args);
2825 /* Like fprintf_filtered, but prints its result indented.
2826 Called as fprintfi_filtered (spaces, stream, format, ...); */
2829 fprintfi_filtered (int spaces, struct ui_file *stream, const char *format,
2834 va_start (args, format);
2835 print_spaces_filtered (spaces, stream);
2837 vfprintf_filtered (stream, format, args);
2843 printf_filtered (const char *format, ...)
2847 va_start (args, format);
2848 vfprintf_filtered (gdb_stdout, format, args);
2854 printf_unfiltered (const char *format, ...)
2858 va_start (args, format);
2859 vfprintf_unfiltered (gdb_stdout, format, args);
2863 /* Like printf_filtered, but prints it's result indented.
2864 Called as printfi_filtered (spaces, format, ...); */
2867 printfi_filtered (int spaces, const char *format, ...)
2871 va_start (args, format);
2872 print_spaces_filtered (spaces, gdb_stdout);
2873 vfprintf_filtered (gdb_stdout, format, args);
2877 /* Easy -- but watch out!
2879 This routine is *not* a replacement for puts()! puts() appends a newline.
2880 This one doesn't, and had better not! */
2883 puts_filtered (const char *string)
2885 fputs_filtered (string, gdb_stdout);
2889 puts_unfiltered (const char *string)
2891 fputs_unfiltered (string, gdb_stdout);
2894 /* Return a pointer to N spaces and a null. The pointer is good
2895 until the next call to here. */
2900 static char *spaces = 0;
2901 static int max_spaces = -1;
2907 spaces = (char *) xmalloc (n + 1);
2908 for (t = spaces + n; t != spaces;)
2914 return spaces + max_spaces - n;
2917 /* Print N spaces. */
2919 print_spaces_filtered (int n, struct ui_file *stream)
2921 fputs_filtered (n_spaces (n), stream);
2924 /* C++/ObjC demangler stuff. */
2926 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2927 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2928 If the name is not mangled, or the language for the name is unknown, or
2929 demangling is off, the name is printed in its "raw" form. */
2932 fprintf_symbol_filtered (struct ui_file *stream, char *name,
2933 enum language lang, int arg_mode)
2939 /* If user wants to see raw output, no problem. */
2942 fputs_filtered (name, stream);
2946 demangled = language_demangle (language_def (lang), name, arg_mode);
2947 fputs_filtered (demangled ? demangled : name, stream);
2948 if (demangled != NULL)
2956 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2957 differences in whitespace. Returns 0 if they match, non-zero if they
2958 don't (slightly different than strcmp()'s range of return values).
2960 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2961 This "feature" is useful when searching for matching C++ function names
2962 (such as if the user types 'break FOO', where FOO is a mangled C++
2966 strcmp_iw (const char *string1, const char *string2)
2968 while ((*string1 != '\0') && (*string2 != '\0'))
2970 while (isspace (*string1))
2974 while (isspace (*string2))
2978 if (*string1 != *string2)
2982 if (*string1 != '\0')
2988 return (*string1 != '\0' && *string1 != '(') || (*string2 != '\0');
2991 /* This is like strcmp except that it ignores whitespace and treats
2992 '(' as the first non-NULL character in terms of ordering. Like
2993 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2994 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2995 according to that ordering.
2997 If a list is sorted according to this function and if you want to
2998 find names in the list that match some fixed NAME according to
2999 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
3000 where this function would put NAME.
3002 Here are some examples of why using strcmp to sort is a bad idea:
3006 Say your partial symtab contains: "foo<char *>", "goo". Then, if
3007 we try to do a search for "foo<char*>", strcmp will locate this
3008 after "foo<char *>" and before "goo". Then lookup_partial_symbol
3009 will start looking at strings beginning with "goo", and will never
3010 see the correct match of "foo<char *>".
3012 Parenthesis example:
3014 In practice, this is less like to be an issue, but I'll give it a
3015 shot. Let's assume that '$' is a legitimate character to occur in
3016 symbols. (Which may well even be the case on some systems.) Then
3017 say that the partial symbol table contains "foo$" and "foo(int)".
3018 strcmp will put them in this order, since '$' < '('. Now, if the
3019 user searches for "foo", then strcmp will sort "foo" before "foo$".
3020 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
3021 "foo") is false, so it won't proceed to the actual match of
3022 "foo(int)" with "foo". */
3025 strcmp_iw_ordered (const char *string1, const char *string2)
3027 while ((*string1 != '\0') && (*string2 != '\0'))
3029 while (isspace (*string1))
3033 while (isspace (*string2))
3037 if (*string1 != *string2)
3041 if (*string1 != '\0')
3050 /* Characters are non-equal unless they're both '\0'; we want to
3051 make sure we get the comparison right according to our
3052 comparison in the cases where one of them is '\0' or '('. */
3054 if (*string2 == '\0')
3059 if (*string2 == '\0')
3064 if (*string2 == '(')
3067 return *string1 - *string2;
3071 /* A simple comparison function with opposite semantics to strcmp. */
3074 streq (const char *lhs, const char *rhs)
3076 return !strcmp (lhs, rhs);
3082 ** Answer whether string_to_compare is a full or partial match to
3083 ** template_string. The partial match must be in sequence starting
3087 subset_compare (char *string_to_compare, char *template_string)
3091 if (template_string != (char *) NULL && string_to_compare != (char *) NULL
3092 && strlen (string_to_compare) <= strlen (template_string))
3095 (template_string, string_to_compare, strlen (string_to_compare)) == 0);
3102 pagination_on_command (char *arg, int from_tty)
3104 pagination_enabled = 1;
3108 pagination_off_command (char *arg, int from_tty)
3110 pagination_enabled = 0;
3114 show_debug_timestamp (struct ui_file *file, int from_tty,
3115 struct cmd_list_element *c, const char *value)
3117 fprintf_filtered (file, _("Timestamping debugging messages is %s.\n"),
3123 initialize_utils (void)
3125 add_setshow_uinteger_cmd ("width", class_support, &chars_per_line, _("\
3126 Set number of characters gdb thinks are in a line."), _("\
3127 Show number of characters gdb thinks are in a line."), NULL,
3129 show_chars_per_line,
3130 &setlist, &showlist);
3132 add_setshow_uinteger_cmd ("height", class_support, &lines_per_page, _("\
3133 Set number of lines gdb thinks are in a page."), _("\
3134 Show number of lines gdb thinks are in a page."), NULL,
3136 show_lines_per_page,
3137 &setlist, &showlist);
3141 add_setshow_boolean_cmd ("demangle", class_support, &demangle, _("\
3142 Set demangling of encoded C++/ObjC names when displaying symbols."), _("\
3143 Show demangling of encoded C++/ObjC names when displaying symbols."), NULL,
3146 &setprintlist, &showprintlist);
3148 add_setshow_boolean_cmd ("pagination", class_support,
3149 &pagination_enabled, _("\
3150 Set state of pagination."), _("\
3151 Show state of pagination."), NULL,
3153 show_pagination_enabled,
3154 &setlist, &showlist);
3158 add_com ("am", class_support, pagination_on_command,
3159 _("Enable pagination"));
3160 add_com ("sm", class_support, pagination_off_command,
3161 _("Disable pagination"));
3164 add_setshow_boolean_cmd ("sevenbit-strings", class_support,
3165 &sevenbit_strings, _("\
3166 Set printing of 8-bit characters in strings as \\nnn."), _("\
3167 Show printing of 8-bit characters in strings as \\nnn."), NULL,
3169 show_sevenbit_strings,
3170 &setprintlist, &showprintlist);
3172 add_setshow_boolean_cmd ("asm-demangle", class_support, &asm_demangle, _("\
3173 Set demangling of C++/ObjC names in disassembly listings."), _("\
3174 Show demangling of C++/ObjC names in disassembly listings."), NULL,
3177 &setprintlist, &showprintlist);
3179 add_setshow_boolean_cmd ("timestamp", class_maintenance,
3180 &debug_timestamp, _("\
3181 Set timestamping of debugging messages."), _("\
3182 Show timestamping of debugging messages."), _("\
3183 When set, debugging messages will be marked with seconds and microseconds."),
3185 show_debug_timestamp,
3186 &setdebuglist, &showdebuglist);
3189 /* Machine specific function to handle SIGWINCH signal. */
3191 #ifdef SIGWINCH_HANDLER_BODY
3192 SIGWINCH_HANDLER_BODY
3194 /* Print routines to handle variable size regs, etc. */
3195 /* Temporary storage using circular buffer. */
3201 static char buf[NUMCELLS][CELLSIZE];
3202 static int cell = 0;
3204 if (++cell >= NUMCELLS)
3210 paddress (struct gdbarch *gdbarch, CORE_ADDR addr)
3212 /* Truncate address to the size of a target address, avoiding shifts
3213 larger or equal than the width of a CORE_ADDR. The local
3214 variable ADDR_BIT stops the compiler reporting a shift overflow
3215 when it won't occur. */
3216 /* NOTE: This assumes that the significant address information is
3217 kept in the least significant bits of ADDR - the upper bits were
3218 either zero or sign extended. Should gdbarch_address_to_pointer or
3219 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
3221 int addr_bit = gdbarch_addr_bit (gdbarch);
3223 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
3224 addr &= ((CORE_ADDR) 1 << addr_bit) - 1;
3225 return hex_string (addr);
3229 decimal2str (char *sign, ULONGEST addr, int width)
3231 /* Steal code from valprint.c:print_decimal(). Should this worry
3232 about the real size of addr as the above does? */
3233 unsigned long temp[3];
3234 char *str = get_cell ();
3239 temp[i] = addr % (1000 * 1000 * 1000);
3240 addr /= (1000 * 1000 * 1000);
3244 while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0])));
3253 xsnprintf (str, CELLSIZE, "%s%0*lu", sign, width, temp[0]);
3256 xsnprintf (str, CELLSIZE, "%s%0*lu%09lu", sign, width,
3260 xsnprintf (str, CELLSIZE, "%s%0*lu%09lu%09lu", sign, width,
3261 temp[2], temp[1], temp[0]);
3264 internal_error (__FILE__, __LINE__,
3265 _("failed internal consistency check"));
3272 octal2str (ULONGEST addr, int width)
3274 unsigned long temp[3];
3275 char *str = get_cell ();
3280 temp[i] = addr % (0100000 * 0100000);
3281 addr /= (0100000 * 0100000);
3285 while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0])));
3295 xsnprintf (str, CELLSIZE, "%*o", width, 0);
3297 xsnprintf (str, CELLSIZE, "0%0*lo", width, temp[0]);
3300 xsnprintf (str, CELLSIZE, "0%0*lo%010lo", width, temp[1], temp[0]);
3303 xsnprintf (str, CELLSIZE, "0%0*lo%010lo%010lo", width,
3304 temp[2], temp[1], temp[0]);
3307 internal_error (__FILE__, __LINE__,
3308 _("failed internal consistency check"));
3315 pulongest (ULONGEST u)
3317 return decimal2str ("", u, 0);
3321 plongest (LONGEST l)
3324 return decimal2str ("-", -l, 0);
3326 return decimal2str ("", l, 0);
3329 /* Eliminate warning from compiler on 32-bit systems. */
3330 static int thirty_two = 32;
3333 phex (ULONGEST l, int sizeof_l)
3341 xsnprintf (str, CELLSIZE, "%08lx%08lx",
3342 (unsigned long) (l >> thirty_two),
3343 (unsigned long) (l & 0xffffffff));
3347 xsnprintf (str, CELLSIZE, "%08lx", (unsigned long) l);
3351 xsnprintf (str, CELLSIZE, "%04x", (unsigned short) (l & 0xffff));
3354 str = phex (l, sizeof (l));
3362 phex_nz (ULONGEST l, int sizeof_l)
3370 unsigned long high = (unsigned long) (l >> thirty_two);
3374 xsnprintf (str, CELLSIZE, "%lx",
3375 (unsigned long) (l & 0xffffffff));
3377 xsnprintf (str, CELLSIZE, "%lx%08lx", high,
3378 (unsigned long) (l & 0xffffffff));
3383 xsnprintf (str, CELLSIZE, "%lx", (unsigned long) l);
3387 xsnprintf (str, CELLSIZE, "%x", (unsigned short) (l & 0xffff));
3390 str = phex_nz (l, sizeof (l));
3397 /* Converts a LONGEST to a C-format hexadecimal literal and stores it
3398 in a static string. Returns a pointer to this string. */
3400 hex_string (LONGEST num)
3402 char *result = get_cell ();
3404 xsnprintf (result, CELLSIZE, "0x%s", phex_nz (num, sizeof (num)));
3408 /* Converts a LONGEST number to a C-format hexadecimal literal and
3409 stores it in a static string. Returns a pointer to this string
3410 that is valid until the next call. The number is padded on the
3411 left with 0s to at least WIDTH characters. */
3413 hex_string_custom (LONGEST num, int width)
3415 char *result = get_cell ();
3416 char *result_end = result + CELLSIZE - 1;
3417 const char *hex = phex_nz (num, sizeof (num));
3418 int hex_len = strlen (hex);
3420 if (hex_len > width)
3422 if (width + 2 >= CELLSIZE)
3423 internal_error (__FILE__, __LINE__, _("\
3424 hex_string_custom: insufficient space to store result"));
3426 strcpy (result_end - width - 2, "0x");
3427 memset (result_end - width, '0', width);
3428 strcpy (result_end - hex_len, hex);
3429 return result_end - width - 2;
3432 /* Convert VAL to a numeral in the given radix. For
3433 * radix 10, IS_SIGNED may be true, indicating a signed quantity;
3434 * otherwise VAL is interpreted as unsigned. If WIDTH is supplied,
3435 * it is the minimum width (0-padded if needed). USE_C_FORMAT means
3436 * to use C format in all cases. If it is false, then 'x'
3437 * and 'o' formats do not include a prefix (0x or leading 0). */
3440 int_string (LONGEST val, int radix, int is_signed, int width,
3450 result = hex_string (val);
3452 result = hex_string_custom (val, width);
3459 if (is_signed && val < 0)
3460 return decimal2str ("-", -val, width);
3462 return decimal2str ("", val, width);
3466 char *result = octal2str (val, width);
3468 if (use_c_format || val == 0)
3474 internal_error (__FILE__, __LINE__,
3475 _("failed internal consistency check"));
3479 /* Convert a CORE_ADDR into a string. */
3481 core_addr_to_string (const CORE_ADDR addr)
3483 char *str = get_cell ();
3486 strcat (str, phex (addr, sizeof (addr)));
3491 core_addr_to_string_nz (const CORE_ADDR addr)
3493 char *str = get_cell ();
3496 strcat (str, phex_nz (addr, sizeof (addr)));
3500 /* Convert a string back into a CORE_ADDR. */
3502 string_to_core_addr (const char *my_string)
3506 if (my_string[0] == '0' && tolower (my_string[1]) == 'x')
3508 /* Assume that it is in hex. */
3511 for (i = 2; my_string[i] != '\0'; i++)
3513 if (isdigit (my_string[i]))
3514 addr = (my_string[i] - '0') + (addr * 16);
3515 else if (isxdigit (my_string[i]))
3516 addr = (tolower (my_string[i]) - 'a' + 0xa) + (addr * 16);
3518 error (_("invalid hex \"%s\""), my_string);
3523 /* Assume that it is in decimal. */
3526 for (i = 0; my_string[i] != '\0'; i++)
3528 if (isdigit (my_string[i]))
3529 addr = (my_string[i] - '0') + (addr * 10);
3531 error (_("invalid decimal \"%s\""), my_string);
3539 host_address_to_string (const void *addr)
3541 char *str = get_cell ();
3543 xsnprintf (str, CELLSIZE, "0x%s", phex_nz ((uintptr_t) addr, sizeof (addr)));
3548 gdb_realpath (const char *filename)
3550 /* Method 1: The system has a compile time upper bound on a filename
3551 path. Use that and realpath() to canonicalize the name. This is
3552 the most common case. Note that, if there isn't a compile time
3553 upper bound, you want to avoid realpath() at all costs. */
3554 #if defined(HAVE_REALPATH)
3556 # if defined (PATH_MAX)
3558 # define USE_REALPATH
3559 # elif defined (MAXPATHLEN)
3560 char buf[MAXPATHLEN];
3561 # define USE_REALPATH
3563 # if defined (USE_REALPATH)
3564 const char *rp = realpath (filename, buf);
3568 return xstrdup (rp);
3571 #endif /* HAVE_REALPATH */
3573 /* Method 2: The host system (i.e., GNU) has the function
3574 canonicalize_file_name() which malloc's a chunk of memory and
3575 returns that, use that. */
3576 #if defined(HAVE_CANONICALIZE_FILE_NAME)
3578 char *rp = canonicalize_file_name (filename);
3581 return xstrdup (filename);
3587 /* FIXME: cagney/2002-11-13:
3589 Method 2a: Use realpath() with a NULL buffer. Some systems, due
3590 to the problems described in in method 3, have modified their
3591 realpath() implementation so that it will allocate a buffer when
3592 NULL is passed in. Before this can be used, though, some sort of
3593 configure time test would need to be added. Otherwize the code
3594 will likely core dump. */
3596 /* Method 3: Now we're getting desperate! The system doesn't have a
3597 compile time buffer size and no alternative function. Query the
3598 OS, using pathconf(), for the buffer limit. Care is needed
3599 though, some systems do not limit PATH_MAX (return -1 for
3600 pathconf()) making it impossible to pass a correctly sized buffer
3601 to realpath() (it could always overflow). On those systems, we
3603 #if defined (HAVE_REALPATH) && defined (HAVE_UNISTD_H) && defined(HAVE_ALLOCA)
3605 /* Find out the max path size. */
3606 long path_max = pathconf ("/", _PC_PATH_MAX);
3610 /* PATH_MAX is bounded. */
3611 char *buf = alloca (path_max);
3612 char *rp = realpath (filename, buf);
3614 return xstrdup (rp ? rp : filename);
3619 /* This system is a lost cause, just dup the buffer. */
3620 return xstrdup (filename);
3623 /* Return a copy of FILENAME, with its directory prefix canonicalized
3627 xfullpath (const char *filename)
3629 const char *base_name = lbasename (filename);
3634 /* Extract the basename of filename, and return immediately
3635 a copy of filename if it does not contain any directory prefix. */
3636 if (base_name == filename)
3637 return xstrdup (filename);
3639 dir_name = alloca ((size_t) (base_name - filename + 2));
3640 /* Allocate enough space to store the dir_name + plus one extra
3641 character sometimes needed under Windows (see below), and
3642 then the closing \000 character. */
3643 strncpy (dir_name, filename, base_name - filename);
3644 dir_name[base_name - filename] = '\000';
3646 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3647 /* We need to be careful when filename is of the form 'd:foo', which
3648 is equivalent of d:./foo, which is totally different from d:/foo. */
3649 if (strlen (dir_name) == 2 && isalpha (dir_name[0]) && dir_name[1] == ':')
3652 dir_name[3] = '\000';
3656 /* Canonicalize the directory prefix, and build the resulting
3657 filename. If the dirname realpath already contains an ending
3658 directory separator, avoid doubling it. */
3659 real_path = gdb_realpath (dir_name);
3660 if (IS_DIR_SEPARATOR (real_path[strlen (real_path) - 1]))
3661 result = concat (real_path, base_name, (char *) NULL);
3663 result = concat (real_path, SLASH_STRING, base_name, (char *) NULL);
3670 /* This is the 32-bit CRC function used by the GNU separate debug
3671 facility. An executable may contain a section named
3672 .gnu_debuglink, which holds the name of a separate executable file
3673 containing its debug info, and a checksum of that file's contents,
3674 computed using this function. */
3676 gnu_debuglink_crc32 (unsigned long crc, unsigned char *buf, size_t len)
3678 static const unsigned int crc32_table[256] = {
3679 0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419,
3680 0x706af48f, 0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4,
3681 0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07,
3682 0x90bf1d91, 0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de,
3683 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7, 0x136c9856,
3684 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
3685 0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4,
3686 0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b,
3687 0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3,
3688 0x45df5c75, 0xdcd60dcf, 0xabd13d59, 0x26d930ac, 0x51de003a,
3689 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599,
3690 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
3691 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190,
3692 0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f,
3693 0x9fbfe4a5, 0xe8b8d433, 0x7807c9a2, 0x0f00f934, 0x9609a88e,
3694 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01,
3695 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed,
3696 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
3697 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3,
3698 0xfbd44c65, 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2,
3699 0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a,
3700 0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5,
3701 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa, 0xbe0b1010,
3702 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
3703 0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17,
3704 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6,
3705 0x03b6e20c, 0x74b1d29a, 0xead54739, 0x9dd277af, 0x04db2615,
3706 0x73dc1683, 0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8,
3707 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1, 0xf00f9344,
3708 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
3709 0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a,
3710 0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5,
3711 0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1,
3712 0xa6bc5767, 0x3fb506dd, 0x48b2364b, 0xd80d2bda, 0xaf0a1b4c,
3713 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef,
3714 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
3715 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe,
3716 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31,
3717 0x2cd99e8b, 0x5bdeae1d, 0x9b64c2b0, 0xec63f226, 0x756aa39c,
3718 0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713,
3719 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 0x92d28e9b,
3720 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
3721 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1,
3722 0x18b74777, 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c,
3723 0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45, 0xa00ae278,
3724 0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7,
3725 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc, 0x40df0b66,
3726 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
3727 0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605,
3728 0xcdd70693, 0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8,
3729 0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b,
3734 crc = ~crc & 0xffffffff;
3735 for (end = buf + len; buf < end; ++buf)
3736 crc = crc32_table[(crc ^ *buf) & 0xff] ^ (crc >> 8);
3737 return ~crc & 0xffffffff;;
3741 align_up (ULONGEST v, int n)
3743 /* Check that N is really a power of two. */
3744 gdb_assert (n && (n & (n-1)) == 0);
3745 return (v + n - 1) & -n;
3749 align_down (ULONGEST v, int n)
3751 /* Check that N is really a power of two. */
3752 gdb_assert (n && (n & (n-1)) == 0);
3756 /* Allocation function for the libiberty hash table which uses an
3757 obstack. The obstack is passed as DATA. */
3760 hashtab_obstack_allocate (void *data, size_t size, size_t count)
3762 unsigned int total = size * count;
3763 void *ptr = obstack_alloc ((struct obstack *) data, total);
3765 memset (ptr, 0, total);
3769 /* Trivial deallocation function for the libiberty splay tree and hash
3770 table - don't deallocate anything. Rely on later deletion of the
3771 obstack. DATA will be the obstack, although it is not needed
3775 dummy_obstack_deallocate (void *object, void *data)
3780 /* The bit offset of the highest byte in a ULONGEST, for overflow
3783 #define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT)
3785 /* True (non-zero) iff DIGIT is a valid digit in radix BASE,
3786 where 2 <= BASE <= 36. */
3789 is_digit_in_base (unsigned char digit, int base)
3791 if (!isalnum (digit))
3794 return (isdigit (digit) && digit < base + '0');
3796 return (isdigit (digit) || tolower (digit) < base - 10 + 'a');
3800 digit_to_int (unsigned char c)
3805 return tolower (c) - 'a' + 10;
3808 /* As for strtoul, but for ULONGEST results. */
3811 strtoulst (const char *num, const char **trailer, int base)
3813 unsigned int high_part;
3818 /* Skip leading whitespace. */
3819 while (isspace (num[i]))
3822 /* Handle prefixes. */
3825 else if (num[i] == '-')
3831 if (base == 0 || base == 16)
3833 if (num[i] == '0' && (num[i + 1] == 'x' || num[i + 1] == 'X'))
3841 if (base == 0 && num[i] == '0')
3847 if (base < 2 || base > 36)
3853 result = high_part = 0;
3854 for (; is_digit_in_base (num[i], base); i += 1)
3856 result = result * base + digit_to_int (num[i]);
3857 high_part = high_part * base + (unsigned int) (result >> HIGH_BYTE_POSN);
3858 result &= ((ULONGEST) 1 << HIGH_BYTE_POSN) - 1;
3859 if (high_part > 0xff)
3862 result = ~ (ULONGEST) 0;
3869 if (trailer != NULL)
3872 result = result + ((ULONGEST) high_part << HIGH_BYTE_POSN);
3879 /* Simple, portable version of dirname that does not modify its
3883 ldirname (const char *filename)
3885 const char *base = lbasename (filename);
3888 while (base > filename && IS_DIR_SEPARATOR (base[-1]))
3891 if (base == filename)
3894 dirname = xmalloc (base - filename + 2);
3895 memcpy (dirname, filename, base - filename);
3897 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3898 create "d:./bar" later instead of the (different) "d:/bar". */
3899 if (base - filename == 2 && IS_ABSOLUTE_PATH (base)
3900 && !IS_DIR_SEPARATOR (filename[0]))
3901 dirname[base++ - filename] = '.';
3903 dirname[base - filename] = '\0';
3907 /* Call libiberty's buildargv, and return the result.
3908 If buildargv fails due to out-of-memory, call nomem.
3909 Therefore, the returned value is guaranteed to be non-NULL,
3910 unless the parameter itself is NULL. */
3913 gdb_buildargv (const char *s)
3915 char **argv = buildargv (s);
3917 if (s != NULL && argv == NULL)
3923 compare_positive_ints (const void *ap, const void *bp)
3925 /* Because we know we're comparing two ints which are positive,
3926 there's no danger of overflow here. */
3927 return * (int *) ap - * (int *) bp;
3930 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3931 #define AMBIGUOUS_MESS2 \
3932 ".\nUse \"set gnutarget format-name\" to specify the format."
3935 gdb_bfd_errmsg (bfd_error_type error_tag, char **matching)
3941 /* Check if errmsg just need simple return. */
3942 if (error_tag != bfd_error_file_ambiguously_recognized || matching == NULL)
3943 return bfd_errmsg (error_tag);
3945 ret_len = strlen (bfd_errmsg (error_tag)) + strlen (AMBIGUOUS_MESS1)
3946 + strlen (AMBIGUOUS_MESS2);
3947 for (p = matching; *p; p++)
3948 ret_len += strlen (*p) + 1;
3949 ret = xmalloc (ret_len + 1);
3951 make_cleanup (xfree, ret);
3953 strcpy (retp, bfd_errmsg (error_tag));
3954 retp += strlen (retp);
3956 strcpy (retp, AMBIGUOUS_MESS1);
3957 retp += strlen (retp);
3959 for (p = matching; *p; p++)
3961 sprintf (retp, " %s", *p);
3962 retp += strlen (retp);
3966 strcpy (retp, AMBIGUOUS_MESS2);
3971 /* Return ARGS parsed as a valid pid, or throw an error. */
3974 parse_pid_to_attach (char *args)
3980 error_no_arg (_("process-id to attach"));
3983 pid = strtoul (args, &dummy, 0);
3984 /* Some targets don't set errno on errors, grrr! */
3985 if ((pid == 0 && dummy == args) || dummy != &args[strlen (args)])
3986 error (_("Illegal process-id: %s."), args);
3991 /* Provide a prototype to silence -Wmissing-prototypes. */
3992 extern initialize_file_ftype _initialize_utils;
3995 _initialize_utils (void)
3997 add_internal_problem_command (&internal_error_problem);
3998 add_internal_problem_command (&internal_warning_problem);