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"
70 #include "gdb_usleep.h"
73 extern PTR malloc (); /* ARI: PTR */
75 #if !HAVE_DECL_REALLOC
76 extern PTR realloc (); /* ARI: PTR */
82 /* readline defines this. */
85 void (*deprecated_error_begin_hook) (void);
87 /* Prototypes for local functions */
89 static void vfprintf_maybe_filtered (struct ui_file *, const char *,
90 va_list, int) ATTR_FORMAT (printf, 2, 0);
92 static void fputs_maybe_filtered (const char *, struct ui_file *, int);
94 static void do_my_cleanups (struct cleanup **, struct cleanup *);
96 static void prompt_for_continue (void);
98 static void set_screen_size (void);
99 static void set_width (void);
101 /* A flag indicating whether to timestamp debugging messages. */
103 static int debug_timestamp = 0;
105 /* Chain of cleanup actions established with make_cleanup,
106 to be executed if an error happens. */
108 static struct cleanup *cleanup_chain; /* cleaned up after a failed command */
109 static struct cleanup *final_cleanup_chain; /* cleaned up when gdb exits */
111 /* Nonzero if we have job control. */
115 /* Nonzero means a quit has been requested. */
119 /* Nonzero means quit immediately if Control-C is typed now, rather
120 than waiting until QUIT is executed. Be careful in setting this;
121 code which executes with immediate_quit set has to be very careful
122 about being able to deal with being interrupted at any time. It is
123 almost always better to use QUIT; the only exception I can think of
124 is being able to quit out of a system call (using EINTR loses if
125 the SIGINT happens between the previous QUIT and the system call).
126 To immediately quit in the case in which a SIGINT happens between
127 the previous QUIT and setting immediate_quit (desirable anytime we
128 expect to block), call QUIT after setting immediate_quit. */
132 /* Nonzero means that encoded C++/ObjC names should be printed out in their
133 C++/ObjC form rather than raw. */
137 show_demangle (struct ui_file *file, int from_tty,
138 struct cmd_list_element *c, const char *value)
140 fprintf_filtered (file, _("\
141 Demangling of encoded C++/ObjC names when displaying symbols is %s.\n"),
145 /* Nonzero means that encoded C++/ObjC names should be printed out in their
146 C++/ObjC form even in assembler language displays. If this is set, but
147 DEMANGLE is zero, names are printed raw, i.e. DEMANGLE controls. */
149 int asm_demangle = 0;
151 show_asm_demangle (struct ui_file *file, int from_tty,
152 struct cmd_list_element *c, const char *value)
154 fprintf_filtered (file, _("\
155 Demangling of C++/ObjC names in disassembly listings is %s.\n"),
159 /* Nonzero means that strings with character values >0x7F should be printed
160 as octal escapes. Zero means just print the value (e.g. it's an
161 international character, and the terminal or window can cope.) */
163 int sevenbit_strings = 0;
165 show_sevenbit_strings (struct ui_file *file, int from_tty,
166 struct cmd_list_element *c, const char *value)
168 fprintf_filtered (file, _("\
169 Printing of 8-bit characters in strings as \\nnn is %s.\n"),
173 /* String to be printed before error messages, if any. */
175 char *error_pre_print;
177 /* String to be printed before quit messages, if any. */
179 char *quit_pre_print;
181 /* String to be printed before warning messages, if any. */
183 char *warning_pre_print = "\nwarning: ";
185 int pagination_enabled = 1;
187 show_pagination_enabled (struct ui_file *file, int from_tty,
188 struct cmd_list_element *c, const char *value)
190 fprintf_filtered (file, _("State of pagination is %s.\n"), value);
195 /* Add a new cleanup to the cleanup_chain,
196 and return the previous chain pointer
197 to be passed later to do_cleanups or discard_cleanups.
198 Args are FUNCTION to clean up with, and ARG to pass to it. */
201 make_cleanup (make_cleanup_ftype *function, void *arg)
203 return make_my_cleanup (&cleanup_chain, function, arg);
207 make_cleanup_dtor (make_cleanup_ftype *function, void *arg,
208 void (*dtor) (void *))
210 return make_my_cleanup2 (&cleanup_chain,
211 function, arg, dtor);
215 make_final_cleanup (make_cleanup_ftype *function, void *arg)
217 return make_my_cleanup (&final_cleanup_chain, function, arg);
221 do_freeargv (void *arg)
223 freeargv ((char **) arg);
227 make_cleanup_freeargv (char **arg)
229 return make_my_cleanup (&cleanup_chain, do_freeargv, arg);
233 do_bfd_close_cleanup (void *arg)
239 make_cleanup_bfd_close (bfd *abfd)
241 return make_cleanup (do_bfd_close_cleanup, abfd);
245 do_close_cleanup (void *arg)
252 make_cleanup_close (int fd)
254 int *saved_fd = xmalloc (sizeof (fd));
256 return make_cleanup_dtor (do_close_cleanup, saved_fd, xfree);
259 /* Helper function which does the work for make_cleanup_fclose. */
262 do_fclose_cleanup (void *arg)
268 /* Return a new cleanup that closes FILE. */
271 make_cleanup_fclose (FILE *file)
273 return make_cleanup (do_fclose_cleanup, file);
276 /* Helper function which does the work for make_cleanup_obstack_free. */
279 do_obstack_free (void *arg)
281 struct obstack *ob = arg;
282 obstack_free (ob, NULL);
285 /* Return a new cleanup that frees OBSTACK. */
288 make_cleanup_obstack_free (struct obstack *obstack)
290 return make_cleanup (do_obstack_free, obstack);
294 do_ui_file_delete (void *arg)
296 ui_file_delete (arg);
300 make_cleanup_ui_file_delete (struct ui_file *arg)
302 return make_my_cleanup (&cleanup_chain, do_ui_file_delete, arg);
306 do_free_section_addr_info (void *arg)
308 free_section_addr_info (arg);
312 make_cleanup_free_section_addr_info (struct section_addr_info *addrs)
314 return make_my_cleanup (&cleanup_chain, do_free_section_addr_info, addrs);
317 struct restore_integer_closure
324 restore_integer (void *p)
326 struct restore_integer_closure *closure = p;
327 *(closure->variable) = closure->value;
330 /* Remember the current value of *VARIABLE and make it restored when the cleanup
333 make_cleanup_restore_integer (int *variable)
335 struct restore_integer_closure *c =
336 xmalloc (sizeof (struct restore_integer_closure));
337 c->variable = variable;
338 c->value = *variable;
340 return make_my_cleanup2 (&cleanup_chain, restore_integer, (void *)c,
345 make_my_cleanup2 (struct cleanup **pmy_chain, make_cleanup_ftype *function,
346 void *arg, void (*free_arg) (void *))
349 = (struct cleanup *) xmalloc (sizeof (struct cleanup));
350 struct cleanup *old_chain = *pmy_chain;
352 new->next = *pmy_chain;
353 new->function = function;
354 new->free_arg = free_arg;
362 make_my_cleanup (struct cleanup **pmy_chain, make_cleanup_ftype *function,
365 return make_my_cleanup2 (pmy_chain, function, arg, NULL);
368 /* Discard cleanups and do the actions they describe
369 until we get back to the point OLD_CHAIN in the cleanup_chain. */
372 do_cleanups (struct cleanup *old_chain)
374 do_my_cleanups (&cleanup_chain, old_chain);
378 do_final_cleanups (struct cleanup *old_chain)
380 do_my_cleanups (&final_cleanup_chain, old_chain);
384 do_my_cleanups (struct cleanup **pmy_chain,
385 struct cleanup *old_chain)
388 while ((ptr = *pmy_chain) != old_chain)
390 *pmy_chain = ptr->next; /* Do this first incase recursion */
391 (*ptr->function) (ptr->arg);
393 (*ptr->free_arg) (ptr->arg);
398 /* Discard cleanups, not doing the actions they describe,
399 until we get back to the point OLD_CHAIN in the cleanup_chain. */
402 discard_cleanups (struct cleanup *old_chain)
404 discard_my_cleanups (&cleanup_chain, old_chain);
408 discard_final_cleanups (struct cleanup *old_chain)
410 discard_my_cleanups (&final_cleanup_chain, old_chain);
414 discard_my_cleanups (struct cleanup **pmy_chain,
415 struct cleanup *old_chain)
418 while ((ptr = *pmy_chain) != old_chain)
420 *pmy_chain = ptr->next;
422 (*ptr->free_arg) (ptr->arg);
427 /* Set the cleanup_chain to 0, and return the old cleanup chain. */
431 return save_my_cleanups (&cleanup_chain);
435 save_final_cleanups (void)
437 return save_my_cleanups (&final_cleanup_chain);
441 save_my_cleanups (struct cleanup **pmy_chain)
443 struct cleanup *old_chain = *pmy_chain;
449 /* Restore the cleanup chain from a previously saved chain. */
451 restore_cleanups (struct cleanup *chain)
453 restore_my_cleanups (&cleanup_chain, chain);
457 restore_final_cleanups (struct cleanup *chain)
459 restore_my_cleanups (&final_cleanup_chain, chain);
463 restore_my_cleanups (struct cleanup **pmy_chain, struct cleanup *chain)
468 /* This function is useful for cleanups.
472 old_chain = make_cleanup (free_current_contents, &foo);
474 to arrange to free the object thus allocated. */
477 free_current_contents (void *ptr)
479 void **location = ptr;
480 if (location == NULL)
481 internal_error (__FILE__, __LINE__,
482 _("free_current_contents: NULL pointer"));
483 if (*location != NULL)
490 /* Provide a known function that does nothing, to use as a base for
491 for a possibly long chain of cleanups. This is useful where we
492 use the cleanup chain for handling normal cleanups as well as dealing
493 with cleanups that need to be done as a result of a call to error().
494 In such cases, we may not be certain where the first cleanup is, unless
495 we have a do-nothing one to always use as the base. */
498 null_cleanup (void *arg)
502 /* Continuations are implemented as cleanups internally. Inherit from
509 /* Add a continuation to the continuation list of THREAD. The new
510 continuation will be added at the front. */
512 add_continuation (struct thread_info *thread,
513 void (*continuation_hook) (void *), void *args,
514 void (*continuation_free_args) (void *))
516 struct cleanup *as_cleanup = &thread->continuations->base;
517 make_cleanup_ftype *continuation_hook_fn = continuation_hook;
519 make_my_cleanup2 (&as_cleanup,
520 continuation_hook_fn,
522 continuation_free_args);
524 thread->continuations = (struct continuation *) as_cleanup;
527 /* Add a continuation to the continuation list of INFERIOR. The new
528 continuation will be added at the front. */
531 add_inferior_continuation (void (*continuation_hook) (void *), void *args,
532 void (*continuation_free_args) (void *))
534 struct inferior *inf = current_inferior ();
535 struct cleanup *as_cleanup = &inf->continuations->base;
536 make_cleanup_ftype *continuation_hook_fn = continuation_hook;
538 make_my_cleanup2 (&as_cleanup,
539 continuation_hook_fn,
541 continuation_free_args);
543 inf->continuations = (struct continuation *) as_cleanup;
546 /* Do all continuations of the current inferior. */
549 do_all_inferior_continuations (void)
551 struct cleanup *old_chain;
552 struct cleanup *as_cleanup;
553 struct inferior *inf = current_inferior ();
555 if (inf->continuations == NULL)
558 /* Copy the list header into another pointer, and set the global
559 list header to null, so that the global list can change as a side
560 effect of invoking the continuations and the processing of the
561 preexisting continuations will not be affected. */
563 as_cleanup = &inf->continuations->base;
564 inf->continuations = NULL;
566 /* Work now on the list we have set aside. */
567 do_my_cleanups (&as_cleanup, NULL);
570 /* Get rid of all the inferior-wide continuations of INF. */
573 discard_all_inferior_continuations (struct inferior *inf)
575 struct cleanup *continuation_ptr = &inf->continuations->base;
576 discard_my_cleanups (&continuation_ptr, NULL);
577 inf->continuations = NULL;
581 restore_thread_cleanup (void *arg)
583 ptid_t *ptid_p = arg;
584 switch_to_thread (*ptid_p);
587 /* Walk down the continuation list of PTID, and execute all the
588 continuations. There is a problem though. In some cases new
589 continuations may be added while we are in the middle of this loop.
590 If this happens they will be added in the front, and done before we
591 have a chance of exhausting those that were already there. We need
592 to then save the beginning of the list in a pointer and do the
593 continuations from there on, instead of using the global beginning
594 of list as our iteration pointer. */
596 do_all_continuations_ptid (ptid_t ptid,
597 struct continuation **continuations_p)
599 struct cleanup *old_chain;
600 ptid_t current_thread;
601 struct cleanup *as_cleanup;
603 if (*continuations_p == NULL)
606 current_thread = inferior_ptid;
608 /* Restore selected thread on exit. Don't try to restore the frame
611 - When running continuations, the selected frame is always #0.
613 - The continuations may trigger symbol file loads, which may
614 change the frame layout (frame ids change), which would trigger
615 a warning if we used make_cleanup_restore_current_thread. */
617 old_chain = make_cleanup (restore_thread_cleanup, ¤t_thread);
619 /* Let the continuation see this thread as selected. */
620 switch_to_thread (ptid);
622 /* Copy the list header into another pointer, and set the global
623 list header to null, so that the global list can change as a side
624 effect of invoking the continuations and the processing of the
625 preexisting continuations will not be affected. */
627 as_cleanup = &(*continuations_p)->base;
628 *continuations_p = NULL;
630 /* Work now on the list we have set aside. */
631 do_my_cleanups (&as_cleanup, NULL);
633 do_cleanups (old_chain);
636 /* Callback for iterate over threads. */
638 do_all_continuations_thread_callback (struct thread_info *thread, void *data)
640 do_all_continuations_ptid (thread->ptid, &thread->continuations);
644 /* Do all continuations of thread THREAD. */
646 do_all_continuations_thread (struct thread_info *thread)
648 do_all_continuations_thread_callback (thread, NULL);
651 /* Do all continuations of all threads. */
653 do_all_continuations (void)
655 iterate_over_threads (do_all_continuations_thread_callback, NULL);
658 /* Callback for iterate over threads. */
660 discard_all_continuations_thread_callback (struct thread_info *thread,
663 struct cleanup *continuation_ptr = &thread->continuations->base;
664 discard_my_cleanups (&continuation_ptr, NULL);
665 thread->continuations = NULL;
669 /* Get rid of all the continuations of THREAD. */
671 discard_all_continuations_thread (struct thread_info *thread)
673 discard_all_continuations_thread_callback (thread, NULL);
676 /* Get rid of all the continuations of all threads. */
678 discard_all_continuations (void)
680 iterate_over_threads (discard_all_continuations_thread_callback, NULL);
684 /* Add a continuation to the intermediate continuation list of THREAD.
685 The new continuation will be added at the front. */
687 add_intermediate_continuation (struct thread_info *thread,
688 void (*continuation_hook)
689 (void *), void *args,
690 void (*continuation_free_args) (void *))
692 struct cleanup *as_cleanup = &thread->intermediate_continuations->base;
693 make_cleanup_ftype *continuation_hook_fn = continuation_hook;
695 make_my_cleanup2 (&as_cleanup,
696 continuation_hook_fn,
698 continuation_free_args);
700 thread->intermediate_continuations = (struct continuation *) as_cleanup;
703 /* Walk down the cmd_continuation list, and execute all the
704 continuations. There is a problem though. In some cases new
705 continuations may be added while we are in the middle of this
706 loop. If this happens they will be added in the front, and done
707 before we have a chance of exhausting those that were already
708 there. We need to then save the beginning of the list in a pointer
709 and do the continuations from there on, instead of using the
710 global beginning of list as our iteration pointer.*/
712 do_all_intermediate_continuations_thread_callback (struct thread_info *thread,
715 do_all_continuations_ptid (thread->ptid,
716 &thread->intermediate_continuations);
720 /* Do all intermediate continuations of thread THREAD. */
722 do_all_intermediate_continuations_thread (struct thread_info *thread)
724 do_all_intermediate_continuations_thread_callback (thread, NULL);
727 /* Do all intermediate continuations of all threads. */
729 do_all_intermediate_continuations (void)
731 iterate_over_threads (do_all_intermediate_continuations_thread_callback, NULL);
734 /* Callback for iterate over threads. */
736 discard_all_intermediate_continuations_thread_callback (struct thread_info *thread,
739 struct cleanup *continuation_ptr = &thread->intermediate_continuations->base;
740 discard_my_cleanups (&continuation_ptr, NULL);
741 thread->intermediate_continuations = NULL;
745 /* Get rid of all the intermediate continuations of THREAD. */
747 discard_all_intermediate_continuations_thread (struct thread_info *thread)
749 discard_all_intermediate_continuations_thread_callback (thread, NULL);
752 /* Get rid of all the intermediate continuations of all threads. */
754 discard_all_intermediate_continuations (void)
756 iterate_over_threads (discard_all_intermediate_continuations_thread_callback, NULL);
761 /* Print a warning message. The first argument STRING is the warning
762 message, used as an fprintf format string, the second is the
763 va_list of arguments for that string. A warning is unfiltered (not
764 paginated) so that the user does not need to page through each
765 screen full of warnings when there are lots of them. */
768 vwarning (const char *string, va_list args)
770 if (deprecated_warning_hook)
771 (*deprecated_warning_hook) (string, args);
774 target_terminal_ours ();
775 wrap_here (""); /* Force out any buffered output */
776 gdb_flush (gdb_stdout);
777 if (warning_pre_print)
778 fputs_unfiltered (warning_pre_print, gdb_stderr);
779 vfprintf_unfiltered (gdb_stderr, string, args);
780 fprintf_unfiltered (gdb_stderr, "\n");
785 /* Print a warning message.
786 The first argument STRING is the warning message, used as a fprintf string,
787 and the remaining args are passed as arguments to it.
788 The primary difference between warnings and errors is that a warning
789 does not force the return to command level. */
792 warning (const char *string, ...)
795 va_start (args, string);
796 vwarning (string, args);
800 /* Print an error message and return to command level.
801 The first argument STRING is the error message, used as a fprintf string,
802 and the remaining args are passed as arguments to it. */
805 verror (const char *string, va_list args)
807 throw_verror (GENERIC_ERROR, string, args);
811 error (const char *string, ...)
814 va_start (args, string);
815 throw_verror (GENERIC_ERROR, string, args);
819 /* Print an error message and quit.
820 The first argument STRING is the error message, used as a fprintf string,
821 and the remaining args are passed as arguments to it. */
824 vfatal (const char *string, va_list args)
826 throw_vfatal (string, args);
830 fatal (const char *string, ...)
833 va_start (args, string);
834 throw_vfatal (string, args);
839 error_stream (struct ui_file *stream)
842 char *message = ui_file_xstrdup (stream, &len);
843 make_cleanup (xfree, message);
844 error (("%s"), message);
847 /* Allow the user to configure the debugger behavior with respect to
848 what to do when an internal problem is detected. */
850 const char internal_problem_ask[] = "ask";
851 const char internal_problem_yes[] = "yes";
852 const char internal_problem_no[] = "no";
853 static const char *internal_problem_modes[] =
855 internal_problem_ask,
856 internal_problem_yes,
860 static const char *internal_problem_mode = internal_problem_ask;
862 /* Print a message reporting an internal error/warning. Ask the user
863 if they want to continue, dump core, or just exit. Return
864 something to indicate a quit. */
866 struct internal_problem
869 const char *should_quit;
870 const char *should_dump_core;
873 /* Report a problem, internal to GDB, to the user. Once the problem
874 has been reported, and assuming GDB didn't quit, the caller can
875 either allow execution to resume or throw an error. */
877 static void ATTR_FORMAT (printf, 4, 0)
878 internal_vproblem (struct internal_problem *problem,
879 const char *file, int line, const char *fmt, va_list ap)
886 /* Don't allow infinite error/warning recursion. */
888 static char msg[] = "Recursive internal problem.\n";
896 fputs_unfiltered (msg, gdb_stderr);
897 abort (); /* NOTE: GDB has only four calls to abort(). */
900 /* Newer GLIBC versions put the warn_unused_result attribute
901 on write, but this is one of those rare cases where
902 ignoring the return value is correct. Casting to (void)
903 does not fix this problem. This is the solution suggested
904 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
905 if (write (STDERR_FILENO, msg, sizeof (msg)) != sizeof (msg))
906 abort (); /* NOTE: GDB has only four calls to abort(). */
911 /* Try to get the message out and at the start of a new line. */
912 target_terminal_ours ();
915 /* Create a string containing the full error/warning message. Need
916 to call query with this full string, as otherwize the reason
917 (error/warning) and question become separated. Format using a
918 style similar to a compiler error message. Include extra detail
919 so that the user knows that they are living on the edge. */
922 msg = xstrvprintf (fmt, ap);
923 reason = xstrprintf ("\
925 A problem internal to GDB has been detected,\n\
926 further debugging may prove unreliable.", file, line, problem->name, msg);
928 make_cleanup (xfree, reason);
931 if (problem->should_quit == internal_problem_ask)
933 /* Default (yes/batch case) is to quit GDB. When in batch mode
934 this lessens the likelihood of GDB going into an infinite
938 /* Emit the message and quit. */
939 fputs_unfiltered (reason, gdb_stderr);
940 fputs_unfiltered ("\n", gdb_stderr);
944 quit_p = query (_("%s\nQuit this debugging session? "), reason);
946 else if (problem->should_quit == internal_problem_yes)
948 else if (problem->should_quit == internal_problem_no)
951 internal_error (__FILE__, __LINE__, _("bad switch"));
953 if (problem->should_dump_core == internal_problem_ask)
955 /* Default (yes/batch case) is to dump core. This leaves a GDB
956 `dropping' so that it is easier to see that something went
958 dump_core_p = query (_("%s\nCreate a core file of GDB? "), reason);
960 else if (problem->should_dump_core == internal_problem_yes)
962 else if (problem->should_dump_core == internal_problem_no)
965 internal_error (__FILE__, __LINE__, _("bad switch"));
970 abort (); /* NOTE: GDB has only four calls to abort(). */
978 #ifdef HAVE_WORKING_FORK
980 abort (); /* NOTE: GDB has only four calls to abort(). */
988 static struct internal_problem internal_error_problem = {
989 "internal-error", internal_problem_ask, internal_problem_ask
993 internal_verror (const char *file, int line, const char *fmt, va_list ap)
995 internal_vproblem (&internal_error_problem, file, line, fmt, ap);
996 deprecated_throw_reason (RETURN_ERROR);
1000 internal_error (const char *file, int line, const char *string, ...)
1003 va_start (ap, string);
1004 internal_verror (file, line, string, ap);
1008 static struct internal_problem internal_warning_problem = {
1009 "internal-warning", internal_problem_ask, internal_problem_ask
1013 internal_vwarning (const char *file, int line, const char *fmt, va_list ap)
1015 internal_vproblem (&internal_warning_problem, file, line, fmt, ap);
1019 internal_warning (const char *file, int line, const char *string, ...)
1022 va_start (ap, string);
1023 internal_vwarning (file, line, string, ap);
1027 /* Dummy functions to keep add_prefix_cmd happy. */
1030 set_internal_problem_cmd (char *args, int from_tty)
1035 show_internal_problem_cmd (char *args, int from_tty)
1039 /* When GDB reports an internal problem (error or warning) it gives
1040 the user the opportunity to quit GDB and/or create a core file of
1041 the current debug session. This function registers a few commands
1042 that make it possible to specify that GDB should always or never
1043 quit or create a core file, without asking. The commands look
1046 maint set PROBLEM-NAME quit ask|yes|no
1047 maint show PROBLEM-NAME quit
1048 maint set PROBLEM-NAME corefile ask|yes|no
1049 maint show PROBLEM-NAME corefile
1051 Where PROBLEM-NAME is currently "internal-error" or
1052 "internal-warning". */
1055 add_internal_problem_command (struct internal_problem *problem)
1057 struct cmd_list_element **set_cmd_list;
1058 struct cmd_list_element **show_cmd_list;
1062 set_cmd_list = xmalloc (sizeof (*set_cmd_list));
1063 show_cmd_list = xmalloc (sizeof (*set_cmd_list));
1064 *set_cmd_list = NULL;
1065 *show_cmd_list = NULL;
1067 set_doc = xstrprintf (_("Configure what GDB does when %s is detected."),
1070 show_doc = xstrprintf (_("Show what GDB does when %s is detected."),
1073 add_prefix_cmd ((char*) problem->name,
1074 class_maintenance, set_internal_problem_cmd, set_doc,
1076 concat ("maintenance set ", problem->name, " ", NULL),
1077 0/*allow-unknown*/, &maintenance_set_cmdlist);
1079 add_prefix_cmd ((char*) problem->name,
1080 class_maintenance, show_internal_problem_cmd, show_doc,
1082 concat ("maintenance show ", problem->name, " ", NULL),
1083 0/*allow-unknown*/, &maintenance_show_cmdlist);
1085 set_doc = xstrprintf (_("\
1086 Set whether GDB should quit when an %s is detected"),
1088 show_doc = xstrprintf (_("\
1089 Show whether GDB will quit when an %s is detected"),
1091 add_setshow_enum_cmd ("quit", class_maintenance,
1092 internal_problem_modes,
1093 &problem->should_quit,
1096 NULL, /* help_doc */
1098 NULL, /* showfunc */
1102 set_doc = xstrprintf (_("\
1103 Set whether GDB should create a core file of GDB when %s is detected"),
1105 show_doc = xstrprintf (_("\
1106 Show whether GDB will create a core file of GDB when %s is detected"),
1108 add_setshow_enum_cmd ("corefile", class_maintenance,
1109 internal_problem_modes,
1110 &problem->should_dump_core,
1113 NULL, /* help_doc */
1115 NULL, /* showfunc */
1120 /* Print the system error message for errno, and also mention STRING
1121 as the file name for which the error was encountered.
1122 Then return to command level. */
1125 perror_with_name (const char *string)
1130 err = safe_strerror (errno);
1131 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
1132 strcpy (combined, string);
1133 strcat (combined, ": ");
1134 strcat (combined, err);
1136 /* I understand setting these is a matter of taste. Still, some people
1137 may clear errno but not know about bfd_error. Doing this here is not
1139 bfd_set_error (bfd_error_no_error);
1142 error (_("%s."), combined);
1145 /* Print the system error message for ERRCODE, and also mention STRING
1146 as the file name for which the error was encountered. */
1149 print_sys_errmsg (const char *string, int errcode)
1154 err = safe_strerror (errcode);
1155 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
1156 strcpy (combined, string);
1157 strcat (combined, ": ");
1158 strcat (combined, err);
1160 /* We want anything which was printed on stdout to come out first, before
1162 gdb_flush (gdb_stdout);
1163 fprintf_unfiltered (gdb_stderr, "%s.\n", combined);
1166 /* Control C eventually causes this to be called, at a convenient time. */
1172 /* No steenking SIGINT will ever be coming our way when the
1173 program is resumed. Don't lie. */
1177 /* If there is no terminal switching for this target, then we can't
1178 possibly get screwed by the lack of job control. */
1179 || current_target.to_terminal_ours == NULL)
1182 fatal ("Quit (expect signal SIGINT when the program is resumed)");
1187 /* Called when a memory allocation fails, with the number of bytes of
1188 memory requested in SIZE. */
1195 internal_error (__FILE__, __LINE__,
1196 _("virtual memory exhausted: can't allocate %ld bytes."),
1201 internal_error (__FILE__, __LINE__, _("virtual memory exhausted."));
1205 /* The xmalloc() (libiberty.h) family of memory management routines.
1207 These are like the ISO-C malloc() family except that they implement
1208 consistent semantics and guard against typical memory management
1211 /* NOTE: These are declared using PTR to ensure consistency with
1212 "libiberty.h". xfree() is GDB local. */
1215 xmalloc (size_t size)
1219 /* See libiberty/xmalloc.c. This function need's to match that's
1220 semantics. It never returns NULL. */
1224 val = malloc (size); /* ARI: malloc */
1232 xzalloc (size_t size)
1234 return xcalloc (1, size);
1238 xrealloc (PTR ptr, size_t size) /* ARI: PTR */
1242 /* See libiberty/xmalloc.c. This function need's to match that's
1243 semantics. It never returns NULL. */
1248 val = realloc (ptr, size); /* ARI: realloc */
1250 val = malloc (size); /* ARI: malloc */
1258 xcalloc (size_t number, size_t size)
1262 /* See libiberty/xmalloc.c. This function need's to match that's
1263 semantics. It never returns NULL. */
1264 if (number == 0 || size == 0)
1270 mem = calloc (number, size); /* ARI: xcalloc */
1272 nomem (number * size);
1281 free (ptr); /* ARI: free */
1285 /* Like asprintf/vasprintf but get an internal_error if the call
1289 xstrprintf (const char *format, ...)
1293 va_start (args, format);
1294 ret = xstrvprintf (format, args);
1300 xasprintf (char **ret, const char *format, ...)
1303 va_start (args, format);
1304 (*ret) = xstrvprintf (format, args);
1309 xvasprintf (char **ret, const char *format, va_list ap)
1311 (*ret) = xstrvprintf (format, ap);
1315 xstrvprintf (const char *format, va_list ap)
1318 int status = vasprintf (&ret, format, ap);
1319 /* NULL is returned when there was a memory allocation problem, or
1320 any other error (for instance, a bad format string). A negative
1321 status (the printed length) with a non-NULL buffer should never
1322 happen, but just to be sure. */
1323 if (ret == NULL || status < 0)
1324 internal_error (__FILE__, __LINE__, _("vasprintf call failed"));
1329 xsnprintf (char *str, size_t size, const char *format, ...)
1334 va_start (args, format);
1335 ret = vsnprintf (str, size, format, args);
1336 gdb_assert (ret < size);
1342 /* My replacement for the read system call.
1343 Used like `read' but keeps going if `read' returns too soon. */
1346 myread (int desc, char *addr, int len)
1353 val = read (desc, addr, len);
1357 return orglen - len;
1364 /* Make a copy of the string at PTR with SIZE characters
1365 (and add a null character at the end in the copy).
1366 Uses malloc to get the space. Returns the address of the copy. */
1369 savestring (const char *ptr, size_t size)
1371 char *p = (char *) xmalloc (size + 1);
1372 memcpy (p, ptr, size);
1378 print_spaces (int n, struct ui_file *file)
1380 fputs_unfiltered (n_spaces (n), file);
1383 /* Print a host address. */
1386 gdb_print_host_address (const void *addr, struct ui_file *stream)
1388 fprintf_filtered (stream, "%s", host_address_to_string (addr));
1392 /* This function supports the query, nquery, and yquery functions.
1393 Ask user a y-or-n question and return 0 if answer is no, 1 if
1394 answer is yes, or default the answer to the specified default
1395 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1396 default answer, or '\0' for no default.
1397 CTLSTR is the control string and should end in "? ". It should
1398 not say how to answer, because we do that.
1399 ARGS are the arguments passed along with the CTLSTR argument to
1402 static int ATTR_FORMAT (printf, 1, 0)
1403 defaulted_query (const char *ctlstr, const char defchar, va_list args)
1409 char def_answer, not_def_answer;
1410 char *y_string, *n_string, *question;
1412 /* Set up according to which answer is the default. */
1413 if (defchar == '\0')
1417 not_def_answer = 'N';
1421 else if (defchar == 'y')
1425 not_def_answer = 'N';
1433 not_def_answer = 'Y';
1438 /* Automatically answer the default value if the user did not want
1443 /* If input isn't coming from the user directly, just say what
1444 question we're asking, and then answer the default automatically. This
1445 way, important error messages don't get lost when talking to GDB
1447 if (! input_from_terminal_p ())
1450 vfprintf_filtered (gdb_stdout, ctlstr, args);
1452 printf_filtered (_("(%s or %s) [answered %c; input not from terminal]\n"),
1453 y_string, n_string, def_answer);
1454 gdb_flush (gdb_stdout);
1459 if (deprecated_query_hook)
1461 return deprecated_query_hook (ctlstr, args);
1464 /* Format the question outside of the loop, to avoid reusing args. */
1465 question = xstrvprintf (ctlstr, args);
1469 wrap_here (""); /* Flush any buffered output */
1470 gdb_flush (gdb_stdout);
1472 if (annotation_level > 1)
1473 printf_filtered (("\n\032\032pre-query\n"));
1475 fputs_filtered (question, gdb_stdout);
1476 printf_filtered (_("(%s or %s) "), y_string, n_string);
1478 if (annotation_level > 1)
1479 printf_filtered (("\n\032\032query\n"));
1482 gdb_flush (gdb_stdout);
1484 answer = fgetc (stdin);
1486 /* We expect fgetc to block until a character is read. But
1487 this may not be the case if the terminal was opened with
1488 the NONBLOCK flag. In that case, if there is nothing to
1489 read on stdin, fgetc returns EOF, but also sets the error
1490 condition flag on stdin and errno to EAGAIN. With a true
1491 EOF, stdin's error condition flag is not set.
1493 A situation where this behavior was observed is a pseudo
1495 while (answer == EOF && ferror (stdin) && errno == EAGAIN)
1497 /* Not a real EOF. Wait a little while and try again until
1498 we read something. */
1501 answer = fgetc (stdin);
1504 clearerr (stdin); /* in case of C-d */
1505 if (answer == EOF) /* C-d */
1507 printf_filtered ("EOF [assumed %c]\n", def_answer);
1511 /* Eat rest of input line, to EOF or newline */
1515 ans2 = fgetc (stdin);
1518 while (ans2 != EOF && ans2 != '\n' && ans2 != '\r');
1522 /* Check answer. For the non-default, the user must specify
1523 the non-default explicitly. */
1524 if (answer == not_def_answer)
1526 retval = !def_value;
1529 /* Otherwise, if a default was specified, the user may either
1530 specify the required input or have it default by entering
1532 if (answer == def_answer
1533 || (defchar != '\0' &&
1534 (answer == '\n' || answer == '\r' || answer == EOF)))
1539 /* Invalid entries are not defaulted and require another selection. */
1540 printf_filtered (_("Please answer %s or %s.\n"),
1541 y_string, n_string);
1545 if (annotation_level > 1)
1546 printf_filtered (("\n\032\032post-query\n"));
1551 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1552 answer is yes, or 0 if answer is defaulted.
1553 Takes three args which are given to printf to print the question.
1554 The first, a control string, should end in "? ".
1555 It should not say how to answer, because we do that. */
1558 nquery (const char *ctlstr, ...)
1562 va_start (args, ctlstr);
1563 return defaulted_query (ctlstr, 'n', args);
1567 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1568 answer is yes, or 1 if answer is defaulted.
1569 Takes three args which are given to printf to print the question.
1570 The first, a control string, should end in "? ".
1571 It should not say how to answer, because we do that. */
1574 yquery (const char *ctlstr, ...)
1578 va_start (args, ctlstr);
1579 return defaulted_query (ctlstr, 'y', args);
1583 /* Ask user a y-or-n question and return 1 iff answer is yes.
1584 Takes three args which are given to printf to print the question.
1585 The first, a control string, should end in "? ".
1586 It should not say how to answer, because we do that. */
1589 query (const char *ctlstr, ...)
1593 va_start (args, ctlstr);
1594 return defaulted_query (ctlstr, '\0', args);
1598 /* A helper for parse_escape that converts a host character to a
1599 target character. C is the host character. If conversion is
1600 possible, then the target character is stored in *TARGET_C and the
1601 function returns 1. Otherwise, the function returns 0. */
1604 host_char_to_target (int c, int *target_c)
1606 struct obstack host_data;
1608 struct cleanup *cleanups;
1611 obstack_init (&host_data);
1612 cleanups = make_cleanup_obstack_free (&host_data);
1614 convert_between_encodings (target_charset (), host_charset (),
1615 &the_char, 1, 1, &host_data, translit_none);
1617 if (obstack_object_size (&host_data) == 1)
1620 *target_c = *(char *) obstack_base (&host_data);
1623 do_cleanups (cleanups);
1627 /* Parse a C escape sequence. STRING_PTR points to a variable
1628 containing a pointer to the string to parse. That pointer
1629 should point to the character after the \. That pointer
1630 is updated past the characters we use. The value of the
1631 escape sequence is returned.
1633 A negative value means the sequence \ newline was seen,
1634 which is supposed to be equivalent to nothing at all.
1636 If \ is followed by a null character, we return a negative
1637 value and leave the string pointer pointing at the null character.
1639 If \ is followed by 000, we return 0 and leave the string pointer
1640 after the zeros. A value of 0 does not mean end of string. */
1643 parse_escape (char **string_ptr)
1645 int target_char = -2; /* initialize to avoid GCC warnings */
1646 int c = *(*string_ptr)++;
1664 int i = host_hex_value (c);
1669 if (isdigit (c) && c != '8' && c != '9')
1673 i += host_hex_value (c);
1709 if (!host_char_to_target (c, &target_char))
1711 ("The escape sequence `\%c' is equivalent to plain `%c', which"
1712 " has no equivalent\n" "in the `%s' character set.", c, c,
1717 /* Print the character C on STREAM as part of the contents of a literal
1718 string whose delimiter is QUOTER. Note that this routine should only
1719 be call for printing things which are independent of the language
1720 of the program being debugged. */
1723 printchar (int c, void (*do_fputs) (const char *, struct ui_file *),
1724 void (*do_fprintf) (struct ui_file *, const char *, ...)
1725 ATTRIBUTE_FPTR_PRINTF_2, struct ui_file *stream, int quoter)
1728 c &= 0xFF; /* Avoid sign bit follies */
1730 if (c < 0x20 || /* Low control chars */
1731 (c >= 0x7F && c < 0xA0) || /* DEL, High controls */
1732 (sevenbit_strings && c >= 0x80))
1733 { /* high order bit set */
1737 do_fputs ("\\n", stream);
1740 do_fputs ("\\b", stream);
1743 do_fputs ("\\t", stream);
1746 do_fputs ("\\f", stream);
1749 do_fputs ("\\r", stream);
1752 do_fputs ("\\e", stream);
1755 do_fputs ("\\a", stream);
1758 do_fprintf (stream, "\\%.3o", (unsigned int) c);
1764 if (c == '\\' || c == quoter)
1765 do_fputs ("\\", stream);
1766 do_fprintf (stream, "%c", c);
1770 /* Print the character C on STREAM as part of the contents of a
1771 literal string whose delimiter is QUOTER. Note that these routines
1772 should only be call for printing things which are independent of
1773 the language of the program being debugged. */
1776 fputstr_filtered (const char *str, int quoter, struct ui_file *stream)
1779 printchar (*str++, fputs_filtered, fprintf_filtered, stream, quoter);
1783 fputstr_unfiltered (const char *str, int quoter, struct ui_file *stream)
1786 printchar (*str++, fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1790 fputstrn_filtered (const char *str, int n, int quoter,
1791 struct ui_file *stream)
1794 for (i = 0; i < n; i++)
1795 printchar (str[i], fputs_filtered, fprintf_filtered, stream, quoter);
1799 fputstrn_unfiltered (const char *str, int n, int quoter,
1800 struct ui_file *stream)
1803 for (i = 0; i < n; i++)
1804 printchar (str[i], fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1808 /* Number of lines per page or UINT_MAX if paging is disabled. */
1809 static unsigned int lines_per_page;
1811 show_lines_per_page (struct ui_file *file, int from_tty,
1812 struct cmd_list_element *c, const char *value)
1814 fprintf_filtered (file, _("\
1815 Number of lines gdb thinks are in a page is %s.\n"),
1819 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1820 static unsigned int chars_per_line;
1822 show_chars_per_line (struct ui_file *file, int from_tty,
1823 struct cmd_list_element *c, const char *value)
1825 fprintf_filtered (file, _("\
1826 Number of characters gdb thinks are in a line is %s.\n"),
1830 /* Current count of lines printed on this page, chars on this line. */
1831 static unsigned int lines_printed, chars_printed;
1833 /* Buffer and start column of buffered text, for doing smarter word-
1834 wrapping. When someone calls wrap_here(), we start buffering output
1835 that comes through fputs_filtered(). If we see a newline, we just
1836 spit it out and forget about the wrap_here(). If we see another
1837 wrap_here(), we spit it out and remember the newer one. If we see
1838 the end of the line, we spit out a newline, the indent, and then
1839 the buffered output. */
1841 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1842 are waiting to be output (they have already been counted in chars_printed).
1843 When wrap_buffer[0] is null, the buffer is empty. */
1844 static char *wrap_buffer;
1846 /* Pointer in wrap_buffer to the next character to fill. */
1847 static char *wrap_pointer;
1849 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1851 static char *wrap_indent;
1853 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1854 is not in effect. */
1855 static int wrap_column;
1858 /* Inialize the number of lines per page and chars per line. */
1861 init_page_info (void)
1864 if (!tui_get_command_dimension (&chars_per_line, &lines_per_page))
1869 #if defined(__GO32__)
1870 rows = ScreenRows ();
1871 cols = ScreenCols ();
1872 lines_per_page = rows;
1873 chars_per_line = cols;
1875 /* Make sure Readline has initialized its terminal settings. */
1876 rl_reset_terminal (NULL);
1878 /* Get the screen size from Readline. */
1879 rl_get_screen_size (&rows, &cols);
1880 lines_per_page = rows;
1881 chars_per_line = cols;
1883 /* Readline should have fetched the termcap entry for us. */
1884 if (tgetnum ("li") < 0 || getenv ("EMACS"))
1886 /* The number of lines per page is not mentioned in the
1887 terminal description. This probably means that paging is
1888 not useful (e.g. emacs shell window), so disable paging. */
1889 lines_per_page = UINT_MAX;
1892 /* FIXME: Get rid of this junk. */
1893 #if defined(SIGWINCH) && defined(SIGWINCH_HANDLER)
1894 SIGWINCH_HANDLER (SIGWINCH);
1897 /* If the output is not a terminal, don't paginate it. */
1898 if (!ui_file_isatty (gdb_stdout))
1899 lines_per_page = UINT_MAX;
1907 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1910 set_screen_size (void)
1912 int rows = lines_per_page;
1913 int cols = chars_per_line;
1921 /* Update Readline's idea of the terminal size. */
1922 rl_set_screen_size (rows, cols);
1925 /* Reinitialize WRAP_BUFFER according to the current value of
1931 if (chars_per_line == 0)
1936 wrap_buffer = (char *) xmalloc (chars_per_line + 2);
1937 wrap_buffer[0] = '\0';
1940 wrap_buffer = (char *) xrealloc (wrap_buffer, chars_per_line + 2);
1941 wrap_pointer = wrap_buffer; /* Start it at the beginning. */
1945 set_width_command (char *args, int from_tty, struct cmd_list_element *c)
1952 set_height_command (char *args, int from_tty, struct cmd_list_element *c)
1957 /* Wait, so the user can read what's on the screen. Prompt the user
1958 to continue by pressing RETURN. */
1961 prompt_for_continue (void)
1964 char cont_prompt[120];
1966 if (annotation_level > 1)
1967 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1969 strcpy (cont_prompt,
1970 "---Type <return> to continue, or q <return> to quit---");
1971 if (annotation_level > 1)
1972 strcat (cont_prompt, "\n\032\032prompt-for-continue\n");
1974 /* We must do this *before* we call gdb_readline, else it will eventually
1975 call us -- thinking that we're trying to print beyond the end of the
1977 reinitialize_more_filter ();
1980 /* On a real operating system, the user can quit with SIGINT.
1983 'q' is provided on all systems so users don't have to change habits
1984 from system to system, and because telling them what to do in
1985 the prompt is more user-friendly than expecting them to think of
1987 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1988 whereas control-C to gdb_readline will cause the user to get dumped
1990 ignore = gdb_readline_wrapper (cont_prompt);
1992 if (annotation_level > 1)
1993 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1998 while (*p == ' ' || *p == '\t')
2001 async_request_quit (0);
2006 /* Now we have to do this again, so that GDB will know that it doesn't
2007 need to save the ---Type <return>--- line at the top of the screen. */
2008 reinitialize_more_filter ();
2010 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
2013 /* Reinitialize filter; ie. tell it to reset to original values. */
2016 reinitialize_more_filter (void)
2022 /* Indicate that if the next sequence of characters overflows the line,
2023 a newline should be inserted here rather than when it hits the end.
2024 If INDENT is non-null, it is a string to be printed to indent the
2025 wrapped part on the next line. INDENT must remain accessible until
2026 the next call to wrap_here() or until a newline is printed through
2029 If the line is already overfull, we immediately print a newline and
2030 the indentation, and disable further wrapping.
2032 If we don't know the width of lines, but we know the page height,
2033 we must not wrap words, but should still keep track of newlines
2034 that were explicitly printed.
2036 INDENT should not contain tabs, as that will mess up the char count
2037 on the next line. FIXME.
2039 This routine is guaranteed to force out any output which has been
2040 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
2041 used to force out output from the wrap_buffer. */
2044 wrap_here (char *indent)
2046 /* This should have been allocated, but be paranoid anyway. */
2048 internal_error (__FILE__, __LINE__, _("failed internal consistency check"));
2052 *wrap_pointer = '\0';
2053 fputs_unfiltered (wrap_buffer, gdb_stdout);
2055 wrap_pointer = wrap_buffer;
2056 wrap_buffer[0] = '\0';
2057 if (chars_per_line == UINT_MAX) /* No line overflow checking */
2061 else if (chars_printed >= chars_per_line)
2063 puts_filtered ("\n");
2065 puts_filtered (indent);
2070 wrap_column = chars_printed;
2074 wrap_indent = indent;
2078 /* Print input string to gdb_stdout, filtered, with wrap,
2079 arranging strings in columns of n chars. String can be
2080 right or left justified in the column. Never prints
2081 trailing spaces. String should never be longer than
2082 width. FIXME: this could be useful for the EXAMINE
2083 command, which currently doesn't tabulate very well */
2086 puts_filtered_tabular (char *string, int width, int right)
2092 gdb_assert (chars_per_line > 0);
2093 if (chars_per_line == UINT_MAX)
2095 fputs_filtered (string, gdb_stdout);
2096 fputs_filtered ("\n", gdb_stdout);
2100 if (((chars_printed - 1) / width + 2) * width >= chars_per_line)
2101 fputs_filtered ("\n", gdb_stdout);
2103 if (width >= chars_per_line)
2104 width = chars_per_line - 1;
2106 stringlen = strlen (string);
2108 if (chars_printed > 0)
2109 spaces = width - (chars_printed - 1) % width - 1;
2111 spaces += width - stringlen;
2113 spacebuf = alloca (spaces + 1);
2114 spacebuf[spaces] = '\0';
2116 spacebuf[spaces] = ' ';
2118 fputs_filtered (spacebuf, gdb_stdout);
2119 fputs_filtered (string, gdb_stdout);
2123 /* Ensure that whatever gets printed next, using the filtered output
2124 commands, starts at the beginning of the line. I.E. if there is
2125 any pending output for the current line, flush it and start a new
2126 line. Otherwise do nothing. */
2131 if (chars_printed > 0)
2133 puts_filtered ("\n");
2138 /* Like fputs but if FILTER is true, pause after every screenful.
2140 Regardless of FILTER can wrap at points other than the final
2141 character of a line.
2143 Unlike fputs, fputs_maybe_filtered does not return a value.
2144 It is OK for LINEBUFFER to be NULL, in which case just don't print
2147 Note that a longjmp to top level may occur in this routine (only if
2148 FILTER is true) (since prompt_for_continue may do so) so this
2149 routine should not be called when cleanups are not in place. */
2152 fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
2155 const char *lineptr;
2157 if (linebuffer == 0)
2160 /* Don't do any filtering if it is disabled. */
2161 if ((stream != gdb_stdout) || !pagination_enabled
2162 || (lines_per_page == UINT_MAX && chars_per_line == UINT_MAX))
2164 fputs_unfiltered (linebuffer, stream);
2168 /* Go through and output each character. Show line extension
2169 when this is necessary; prompt user for new page when this is
2172 lineptr = linebuffer;
2175 /* Possible new page. */
2176 if (filter && (lines_printed >= lines_per_page - 1))
2177 prompt_for_continue ();
2179 while (*lineptr && *lineptr != '\n')
2181 /* Print a single line. */
2182 if (*lineptr == '\t')
2185 *wrap_pointer++ = '\t';
2187 fputc_unfiltered ('\t', stream);
2188 /* Shifting right by 3 produces the number of tab stops
2189 we have already passed, and then adding one and
2190 shifting left 3 advances to the next tab stop. */
2191 chars_printed = ((chars_printed >> 3) + 1) << 3;
2197 *wrap_pointer++ = *lineptr;
2199 fputc_unfiltered (*lineptr, stream);
2204 if (chars_printed >= chars_per_line)
2206 unsigned int save_chars = chars_printed;
2210 /* If we aren't actually wrapping, don't output newline --
2211 if chars_per_line is right, we probably just overflowed
2212 anyway; if it's wrong, let us keep going. */
2214 fputc_unfiltered ('\n', stream);
2216 /* Possible new page. */
2217 if (lines_printed >= lines_per_page - 1)
2218 prompt_for_continue ();
2220 /* Now output indentation and wrapped string */
2223 fputs_unfiltered (wrap_indent, stream);
2224 *wrap_pointer = '\0'; /* Null-terminate saved stuff */
2225 fputs_unfiltered (wrap_buffer, stream); /* and eject it */
2226 /* FIXME, this strlen is what prevents wrap_indent from
2227 containing tabs. However, if we recurse to print it
2228 and count its chars, we risk trouble if wrap_indent is
2229 longer than (the user settable) chars_per_line.
2230 Note also that this can set chars_printed > chars_per_line
2231 if we are printing a long string. */
2232 chars_printed = strlen (wrap_indent)
2233 + (save_chars - wrap_column);
2234 wrap_pointer = wrap_buffer; /* Reset buffer */
2235 wrap_buffer[0] = '\0';
2236 wrap_column = 0; /* And disable fancy wrap */
2241 if (*lineptr == '\n')
2244 wrap_here ((char *) 0); /* Spit out chars, cancel further wraps */
2246 fputc_unfiltered ('\n', stream);
2253 fputs_filtered (const char *linebuffer, struct ui_file *stream)
2255 fputs_maybe_filtered (linebuffer, stream, 1);
2259 putchar_unfiltered (int c)
2262 ui_file_write (gdb_stdout, &buf, 1);
2266 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2267 May return nonlocally. */
2270 putchar_filtered (int c)
2272 return fputc_filtered (c, gdb_stdout);
2276 fputc_unfiltered (int c, struct ui_file *stream)
2279 ui_file_write (stream, &buf, 1);
2284 fputc_filtered (int c, struct ui_file *stream)
2290 fputs_filtered (buf, stream);
2294 /* puts_debug is like fputs_unfiltered, except it prints special
2295 characters in printable fashion. */
2298 puts_debug (char *prefix, char *string, char *suffix)
2302 /* Print prefix and suffix after each line. */
2303 static int new_line = 1;
2304 static int return_p = 0;
2305 static char *prev_prefix = "";
2306 static char *prev_suffix = "";
2308 if (*string == '\n')
2311 /* If the prefix is changing, print the previous suffix, a new line,
2312 and the new prefix. */
2313 if ((return_p || (strcmp (prev_prefix, prefix) != 0)) && !new_line)
2315 fputs_unfiltered (prev_suffix, gdb_stdlog);
2316 fputs_unfiltered ("\n", gdb_stdlog);
2317 fputs_unfiltered (prefix, gdb_stdlog);
2320 /* Print prefix if we printed a newline during the previous call. */
2324 fputs_unfiltered (prefix, gdb_stdlog);
2327 prev_prefix = prefix;
2328 prev_suffix = suffix;
2330 /* Output characters in a printable format. */
2331 while ((ch = *string++) != '\0')
2337 fputc_unfiltered (ch, gdb_stdlog);
2340 fprintf_unfiltered (gdb_stdlog, "\\x%02x", ch & 0xff);
2344 fputs_unfiltered ("\\\\", gdb_stdlog);
2347 fputs_unfiltered ("\\b", gdb_stdlog);
2350 fputs_unfiltered ("\\f", gdb_stdlog);
2354 fputs_unfiltered ("\\n", gdb_stdlog);
2357 fputs_unfiltered ("\\r", gdb_stdlog);
2360 fputs_unfiltered ("\\t", gdb_stdlog);
2363 fputs_unfiltered ("\\v", gdb_stdlog);
2367 return_p = ch == '\r';
2370 /* Print suffix if we printed a newline. */
2373 fputs_unfiltered (suffix, gdb_stdlog);
2374 fputs_unfiltered ("\n", gdb_stdlog);
2379 /* Print a variable number of ARGS using format FORMAT. If this
2380 information is going to put the amount written (since the last call
2381 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2382 call prompt_for_continue to get the users permision to continue.
2384 Unlike fprintf, this function does not return a value.
2386 We implement three variants, vfprintf (takes a vararg list and stream),
2387 fprintf (takes a stream to write on), and printf (the usual).
2389 Note also that a longjmp to top level may occur in this routine
2390 (since prompt_for_continue may do so) so this routine should not be
2391 called when cleanups are not in place. */
2394 vfprintf_maybe_filtered (struct ui_file *stream, const char *format,
2395 va_list args, int filter)
2398 struct cleanup *old_cleanups;
2400 linebuffer = xstrvprintf (format, args);
2401 old_cleanups = make_cleanup (xfree, linebuffer);
2402 fputs_maybe_filtered (linebuffer, stream, filter);
2403 do_cleanups (old_cleanups);
2408 vfprintf_filtered (struct ui_file *stream, const char *format, va_list args)
2410 vfprintf_maybe_filtered (stream, format, args, 1);
2414 vfprintf_unfiltered (struct ui_file *stream, const char *format, va_list args)
2417 struct cleanup *old_cleanups;
2419 linebuffer = xstrvprintf (format, args);
2420 old_cleanups = make_cleanup (xfree, linebuffer);
2421 if (debug_timestamp && stream == gdb_stdlog)
2427 gettimeofday (&tm, NULL);
2429 len = strlen (linebuffer);
2430 need_nl = (len > 0 && linebuffer[len - 1] != '\n');
2432 timestamp = xstrprintf ("%ld:%ld %s%s",
2433 (long) tm.tv_sec, (long) tm.tv_usec,
2435 need_nl ? "\n": "");
2436 make_cleanup (xfree, timestamp);
2437 fputs_unfiltered (timestamp, stream);
2440 fputs_unfiltered (linebuffer, stream);
2441 do_cleanups (old_cleanups);
2445 vprintf_filtered (const char *format, va_list args)
2447 vfprintf_maybe_filtered (gdb_stdout, format, args, 1);
2451 vprintf_unfiltered (const char *format, va_list args)
2453 vfprintf_unfiltered (gdb_stdout, format, args);
2457 fprintf_filtered (struct ui_file *stream, const char *format, ...)
2460 va_start (args, format);
2461 vfprintf_filtered (stream, format, args);
2466 fprintf_unfiltered (struct ui_file *stream, const char *format, ...)
2469 va_start (args, format);
2470 vfprintf_unfiltered (stream, format, args);
2474 /* Like fprintf_filtered, but prints its result indented.
2475 Called as fprintfi_filtered (spaces, stream, format, ...); */
2478 fprintfi_filtered (int spaces, struct ui_file *stream, const char *format,
2482 va_start (args, format);
2483 print_spaces_filtered (spaces, stream);
2485 vfprintf_filtered (stream, format, args);
2491 printf_filtered (const char *format, ...)
2494 va_start (args, format);
2495 vfprintf_filtered (gdb_stdout, format, args);
2501 printf_unfiltered (const char *format, ...)
2504 va_start (args, format);
2505 vfprintf_unfiltered (gdb_stdout, format, args);
2509 /* Like printf_filtered, but prints it's result indented.
2510 Called as printfi_filtered (spaces, format, ...); */
2513 printfi_filtered (int spaces, const char *format, ...)
2516 va_start (args, format);
2517 print_spaces_filtered (spaces, gdb_stdout);
2518 vfprintf_filtered (gdb_stdout, format, args);
2522 /* Easy -- but watch out!
2524 This routine is *not* a replacement for puts()! puts() appends a newline.
2525 This one doesn't, and had better not! */
2528 puts_filtered (const char *string)
2530 fputs_filtered (string, gdb_stdout);
2534 puts_unfiltered (const char *string)
2536 fputs_unfiltered (string, gdb_stdout);
2539 /* Return a pointer to N spaces and a null. The pointer is good
2540 until the next call to here. */
2545 static char *spaces = 0;
2546 static int max_spaces = -1;
2552 spaces = (char *) xmalloc (n + 1);
2553 for (t = spaces + n; t != spaces;)
2559 return spaces + max_spaces - n;
2562 /* Print N spaces. */
2564 print_spaces_filtered (int n, struct ui_file *stream)
2566 fputs_filtered (n_spaces (n), stream);
2569 /* C++/ObjC demangler stuff. */
2571 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2572 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2573 If the name is not mangled, or the language for the name is unknown, or
2574 demangling is off, the name is printed in its "raw" form. */
2577 fprintf_symbol_filtered (struct ui_file *stream, char *name,
2578 enum language lang, int arg_mode)
2584 /* If user wants to see raw output, no problem. */
2587 fputs_filtered (name, stream);
2591 demangled = language_demangle (language_def (lang), name, arg_mode);
2592 fputs_filtered (demangled ? demangled : name, stream);
2593 if (demangled != NULL)
2601 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2602 differences in whitespace. Returns 0 if they match, non-zero if they
2603 don't (slightly different than strcmp()'s range of return values).
2605 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2606 This "feature" is useful when searching for matching C++ function names
2607 (such as if the user types 'break FOO', where FOO is a mangled C++
2611 strcmp_iw (const char *string1, const char *string2)
2613 while ((*string1 != '\0') && (*string2 != '\0'))
2615 while (isspace (*string1))
2619 while (isspace (*string2))
2623 if (*string1 != *string2)
2627 if (*string1 != '\0')
2633 return (*string1 != '\0' && *string1 != '(') || (*string2 != '\0');
2636 /* This is like strcmp except that it ignores whitespace and treats
2637 '(' as the first non-NULL character in terms of ordering. Like
2638 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2639 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2640 according to that ordering.
2642 If a list is sorted according to this function and if you want to
2643 find names in the list that match some fixed NAME according to
2644 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2645 where this function would put NAME.
2647 Here are some examples of why using strcmp to sort is a bad idea:
2651 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2652 we try to do a search for "foo<char*>", strcmp will locate this
2653 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2654 will start looking at strings beginning with "goo", and will never
2655 see the correct match of "foo<char *>".
2657 Parenthesis example:
2659 In practice, this is less like to be an issue, but I'll give it a
2660 shot. Let's assume that '$' is a legitimate character to occur in
2661 symbols. (Which may well even be the case on some systems.) Then
2662 say that the partial symbol table contains "foo$" and "foo(int)".
2663 strcmp will put them in this order, since '$' < '('. Now, if the
2664 user searches for "foo", then strcmp will sort "foo" before "foo$".
2665 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2666 "foo") is false, so it won't proceed to the actual match of
2667 "foo(int)" with "foo". */
2670 strcmp_iw_ordered (const char *string1, const char *string2)
2672 while ((*string1 != '\0') && (*string2 != '\0'))
2674 while (isspace (*string1))
2678 while (isspace (*string2))
2682 if (*string1 != *string2)
2686 if (*string1 != '\0')
2695 /* Characters are non-equal unless they're both '\0'; we want to
2696 make sure we get the comparison right according to our
2697 comparison in the cases where one of them is '\0' or '('. */
2699 if (*string2 == '\0')
2704 if (*string2 == '\0')
2709 if (*string2 == '(')
2712 return *string1 - *string2;
2716 /* A simple comparison function with opposite semantics to strcmp. */
2719 streq (const char *lhs, const char *rhs)
2721 return !strcmp (lhs, rhs);
2727 ** Answer whether string_to_compare is a full or partial match to
2728 ** template_string. The partial match must be in sequence starting
2732 subset_compare (char *string_to_compare, char *template_string)
2735 if (template_string != (char *) NULL && string_to_compare != (char *) NULL
2736 && strlen (string_to_compare) <= strlen (template_string))
2739 (template_string, string_to_compare, strlen (string_to_compare)) == 0);
2746 pagination_on_command (char *arg, int from_tty)
2748 pagination_enabled = 1;
2752 pagination_off_command (char *arg, int from_tty)
2754 pagination_enabled = 0;
2758 show_debug_timestamp (struct ui_file *file, int from_tty,
2759 struct cmd_list_element *c, const char *value)
2761 fprintf_filtered (file, _("Timestamping debugging messages is %s.\n"), value);
2766 initialize_utils (void)
2768 struct cmd_list_element *c;
2770 add_setshow_uinteger_cmd ("width", class_support, &chars_per_line, _("\
2771 Set number of characters gdb thinks are in a line."), _("\
2772 Show number of characters gdb thinks are in a line."), NULL,
2774 show_chars_per_line,
2775 &setlist, &showlist);
2777 add_setshow_uinteger_cmd ("height", class_support, &lines_per_page, _("\
2778 Set number of lines gdb thinks are in a page."), _("\
2779 Show number of lines gdb thinks are in a page."), NULL,
2781 show_lines_per_page,
2782 &setlist, &showlist);
2786 add_setshow_boolean_cmd ("demangle", class_support, &demangle, _("\
2787 Set demangling of encoded C++/ObjC names when displaying symbols."), _("\
2788 Show demangling of encoded C++/ObjC names when displaying symbols."), NULL,
2791 &setprintlist, &showprintlist);
2793 add_setshow_boolean_cmd ("pagination", class_support,
2794 &pagination_enabled, _("\
2795 Set state of pagination."), _("\
2796 Show state of pagination."), NULL,
2798 show_pagination_enabled,
2799 &setlist, &showlist);
2803 add_com ("am", class_support, pagination_on_command,
2804 _("Enable pagination"));
2805 add_com ("sm", class_support, pagination_off_command,
2806 _("Disable pagination"));
2809 add_setshow_boolean_cmd ("sevenbit-strings", class_support,
2810 &sevenbit_strings, _("\
2811 Set printing of 8-bit characters in strings as \\nnn."), _("\
2812 Show printing of 8-bit characters in strings as \\nnn."), NULL,
2814 show_sevenbit_strings,
2815 &setprintlist, &showprintlist);
2817 add_setshow_boolean_cmd ("asm-demangle", class_support, &asm_demangle, _("\
2818 Set demangling of C++/ObjC names in disassembly listings."), _("\
2819 Show demangling of C++/ObjC names in disassembly listings."), NULL,
2822 &setprintlist, &showprintlist);
2824 add_setshow_boolean_cmd ("timestamp", class_maintenance,
2825 &debug_timestamp, _("\
2826 Set timestamping of debugging messages."), _("\
2827 Show timestamping of debugging messages."), _("\
2828 When set, debugging messages will be marked with seconds and microseconds."),
2830 show_debug_timestamp,
2831 &setdebuglist, &showdebuglist);
2834 /* Machine specific function to handle SIGWINCH signal. */
2836 #ifdef SIGWINCH_HANDLER_BODY
2837 SIGWINCH_HANDLER_BODY
2839 /* print routines to handle variable size regs, etc. */
2840 /* temporary storage using circular buffer */
2846 static char buf[NUMCELLS][CELLSIZE];
2847 static int cell = 0;
2848 if (++cell >= NUMCELLS)
2854 paddress (struct gdbarch *gdbarch, CORE_ADDR addr)
2856 /* Truncate address to the size of a target address, avoiding shifts
2857 larger or equal than the width of a CORE_ADDR. The local
2858 variable ADDR_BIT stops the compiler reporting a shift overflow
2859 when it won't occur. */
2860 /* NOTE: This assumes that the significant address information is
2861 kept in the least significant bits of ADDR - the upper bits were
2862 either zero or sign extended. Should gdbarch_address_to_pointer or
2863 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2865 int addr_bit = gdbarch_addr_bit (gdbarch);
2867 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2868 addr &= ((CORE_ADDR) 1 << addr_bit) - 1;
2869 return hex_string (addr);
2873 decimal2str (char *sign, ULONGEST addr, int width)
2875 /* Steal code from valprint.c:print_decimal(). Should this worry
2876 about the real size of addr as the above does? */
2877 unsigned long temp[3];
2878 char *str = get_cell ();
2883 temp[i] = addr % (1000 * 1000 * 1000);
2884 addr /= (1000 * 1000 * 1000);
2888 while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0])));
2897 xsnprintf (str, CELLSIZE, "%s%0*lu", sign, width, temp[0]);
2900 xsnprintf (str, CELLSIZE, "%s%0*lu%09lu", sign, width,
2904 xsnprintf (str, CELLSIZE, "%s%0*lu%09lu%09lu", sign, width,
2905 temp[2], temp[1], temp[0]);
2908 internal_error (__FILE__, __LINE__,
2909 _("failed internal consistency check"));
2916 octal2str (ULONGEST addr, int width)
2918 unsigned long temp[3];
2919 char *str = get_cell ();
2924 temp[i] = addr % (0100000 * 0100000);
2925 addr /= (0100000 * 0100000);
2929 while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0])));
2939 xsnprintf (str, CELLSIZE, "%*o", width, 0);
2941 xsnprintf (str, CELLSIZE, "0%0*lo", width, temp[0]);
2944 xsnprintf (str, CELLSIZE, "0%0*lo%010lo", width, temp[1], temp[0]);
2947 xsnprintf (str, CELLSIZE, "0%0*lo%010lo%010lo", width,
2948 temp[2], temp[1], temp[0]);
2951 internal_error (__FILE__, __LINE__,
2952 _("failed internal consistency check"));
2959 pulongest (ULONGEST u)
2961 return decimal2str ("", u, 0);
2965 plongest (LONGEST l)
2968 return decimal2str ("-", -l, 0);
2970 return decimal2str ("", l, 0);
2973 /* Eliminate warning from compiler on 32-bit systems. */
2974 static int thirty_two = 32;
2977 phex (ULONGEST l, int sizeof_l)
2985 xsnprintf (str, CELLSIZE, "%08lx%08lx",
2986 (unsigned long) (l >> thirty_two),
2987 (unsigned long) (l & 0xffffffff));
2991 xsnprintf (str, CELLSIZE, "%08lx", (unsigned long) l);
2995 xsnprintf (str, CELLSIZE, "%04x", (unsigned short) (l & 0xffff));
2998 str = phex (l, sizeof (l));
3006 phex_nz (ULONGEST l, int sizeof_l)
3014 unsigned long high = (unsigned long) (l >> thirty_two);
3017 xsnprintf (str, CELLSIZE, "%lx",
3018 (unsigned long) (l & 0xffffffff));
3020 xsnprintf (str, CELLSIZE, "%lx%08lx", high,
3021 (unsigned long) (l & 0xffffffff));
3026 xsnprintf (str, CELLSIZE, "%lx", (unsigned long) l);
3030 xsnprintf (str, CELLSIZE, "%x", (unsigned short) (l & 0xffff));
3033 str = phex_nz (l, sizeof (l));
3040 /* Converts a LONGEST to a C-format hexadecimal literal and stores it
3041 in a static string. Returns a pointer to this string. */
3043 hex_string (LONGEST num)
3045 char *result = get_cell ();
3046 xsnprintf (result, CELLSIZE, "0x%s", phex_nz (num, sizeof (num)));
3050 /* Converts a LONGEST number to a C-format hexadecimal literal and
3051 stores it in a static string. Returns a pointer to this string
3052 that is valid until the next call. The number is padded on the
3053 left with 0s to at least WIDTH characters. */
3055 hex_string_custom (LONGEST num, int width)
3057 char *result = get_cell ();
3058 char *result_end = result + CELLSIZE - 1;
3059 const char *hex = phex_nz (num, sizeof (num));
3060 int hex_len = strlen (hex);
3062 if (hex_len > width)
3064 if (width + 2 >= CELLSIZE)
3065 internal_error (__FILE__, __LINE__,
3066 _("hex_string_custom: insufficient space to store result"));
3068 strcpy (result_end - width - 2, "0x");
3069 memset (result_end - width, '0', width);
3070 strcpy (result_end - hex_len, hex);
3071 return result_end - width - 2;
3074 /* Convert VAL to a numeral in the given radix. For
3075 * radix 10, IS_SIGNED may be true, indicating a signed quantity;
3076 * otherwise VAL is interpreted as unsigned. If WIDTH is supplied,
3077 * it is the minimum width (0-padded if needed). USE_C_FORMAT means
3078 * to use C format in all cases. If it is false, then 'x'
3079 * and 'o' formats do not include a prefix (0x or leading 0). */
3082 int_string (LONGEST val, int radix, int is_signed, int width,
3091 result = hex_string (val);
3093 result = hex_string_custom (val, width);
3100 if (is_signed && val < 0)
3101 return decimal2str ("-", -val, width);
3103 return decimal2str ("", val, width);
3107 char *result = octal2str (val, width);
3108 if (use_c_format || val == 0)
3114 internal_error (__FILE__, __LINE__,
3115 _("failed internal consistency check"));
3119 /* Convert a CORE_ADDR into a string. */
3121 core_addr_to_string (const CORE_ADDR addr)
3123 char *str = get_cell ();
3125 strcat (str, phex (addr, sizeof (addr)));
3130 core_addr_to_string_nz (const CORE_ADDR addr)
3132 char *str = get_cell ();
3134 strcat (str, phex_nz (addr, sizeof (addr)));
3138 /* Convert a string back into a CORE_ADDR. */
3140 string_to_core_addr (const char *my_string)
3144 if (my_string[0] == '0' && tolower (my_string[1]) == 'x')
3146 /* Assume that it is in hex. */
3148 for (i = 2; my_string[i] != '\0'; i++)
3150 if (isdigit (my_string[i]))
3151 addr = (my_string[i] - '0') + (addr * 16);
3152 else if (isxdigit (my_string[i]))
3153 addr = (tolower (my_string[i]) - 'a' + 0xa) + (addr * 16);
3155 error (_("invalid hex \"%s\""), my_string);
3160 /* Assume that it is in decimal. */
3162 for (i = 0; my_string[i] != '\0'; i++)
3164 if (isdigit (my_string[i]))
3165 addr = (my_string[i] - '0') + (addr * 10);
3167 error (_("invalid decimal \"%s\""), my_string);
3175 host_address_to_string (const void *addr)
3177 char *str = get_cell ();
3179 xsnprintf (str, CELLSIZE, "0x%s", phex_nz ((uintptr_t) addr, sizeof (addr)));
3184 gdb_realpath (const char *filename)
3186 /* Method 1: The system has a compile time upper bound on a filename
3187 path. Use that and realpath() to canonicalize the name. This is
3188 the most common case. Note that, if there isn't a compile time
3189 upper bound, you want to avoid realpath() at all costs. */
3190 #if defined(HAVE_REALPATH)
3192 # if defined (PATH_MAX)
3194 # define USE_REALPATH
3195 # elif defined (MAXPATHLEN)
3196 char buf[MAXPATHLEN];
3197 # define USE_REALPATH
3199 # if defined (USE_REALPATH)
3200 const char *rp = realpath (filename, buf);
3203 return xstrdup (rp);
3206 #endif /* HAVE_REALPATH */
3208 /* Method 2: The host system (i.e., GNU) has the function
3209 canonicalize_file_name() which malloc's a chunk of memory and
3210 returns that, use that. */
3211 #if defined(HAVE_CANONICALIZE_FILE_NAME)
3213 char *rp = canonicalize_file_name (filename);
3215 return xstrdup (filename);
3221 /* FIXME: cagney/2002-11-13:
3223 Method 2a: Use realpath() with a NULL buffer. Some systems, due
3224 to the problems described in in method 3, have modified their
3225 realpath() implementation so that it will allocate a buffer when
3226 NULL is passed in. Before this can be used, though, some sort of
3227 configure time test would need to be added. Otherwize the code
3228 will likely core dump. */
3230 /* Method 3: Now we're getting desperate! The system doesn't have a
3231 compile time buffer size and no alternative function. Query the
3232 OS, using pathconf(), for the buffer limit. Care is needed
3233 though, some systems do not limit PATH_MAX (return -1 for
3234 pathconf()) making it impossible to pass a correctly sized buffer
3235 to realpath() (it could always overflow). On those systems, we
3237 #if defined (HAVE_REALPATH) && defined (HAVE_UNISTD_H) && defined(HAVE_ALLOCA)
3239 /* Find out the max path size. */
3240 long path_max = pathconf ("/", _PC_PATH_MAX);
3243 /* PATH_MAX is bounded. */
3244 char *buf = alloca (path_max);
3245 char *rp = realpath (filename, buf);
3246 return xstrdup (rp ? rp : filename);
3251 /* This system is a lost cause, just dup the buffer. */
3252 return xstrdup (filename);
3255 /* Return a copy of FILENAME, with its directory prefix canonicalized
3259 xfullpath (const char *filename)
3261 const char *base_name = lbasename (filename);
3266 /* Extract the basename of filename, and return immediately
3267 a copy of filename if it does not contain any directory prefix. */
3268 if (base_name == filename)
3269 return xstrdup (filename);
3271 dir_name = alloca ((size_t) (base_name - filename + 2));
3272 /* Allocate enough space to store the dir_name + plus one extra
3273 character sometimes needed under Windows (see below), and
3274 then the closing \000 character */
3275 strncpy (dir_name, filename, base_name - filename);
3276 dir_name[base_name - filename] = '\000';
3278 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3279 /* We need to be careful when filename is of the form 'd:foo', which
3280 is equivalent of d:./foo, which is totally different from d:/foo. */
3281 if (strlen (dir_name) == 2 && isalpha (dir_name[0]) && dir_name[1] == ':')
3284 dir_name[3] = '\000';
3288 /* Canonicalize the directory prefix, and build the resulting
3289 filename. If the dirname realpath already contains an ending
3290 directory separator, avoid doubling it. */
3291 real_path = gdb_realpath (dir_name);
3292 if (IS_DIR_SEPARATOR (real_path[strlen (real_path) - 1]))
3293 result = concat (real_path, base_name, (char *)NULL);
3295 result = concat (real_path, SLASH_STRING, base_name, (char *)NULL);
3302 /* This is the 32-bit CRC function used by the GNU separate debug
3303 facility. An executable may contain a section named
3304 .gnu_debuglink, which holds the name of a separate executable file
3305 containing its debug info, and a checksum of that file's contents,
3306 computed using this function. */
3308 gnu_debuglink_crc32 (unsigned long crc, unsigned char *buf, size_t len)
3310 static const unsigned long crc32_table[256] = {
3311 0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419,
3312 0x706af48f, 0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4,
3313 0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07,
3314 0x90bf1d91, 0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de,
3315 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7, 0x136c9856,
3316 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
3317 0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4,
3318 0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b,
3319 0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3,
3320 0x45df5c75, 0xdcd60dcf, 0xabd13d59, 0x26d930ac, 0x51de003a,
3321 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599,
3322 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
3323 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190,
3324 0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f,
3325 0x9fbfe4a5, 0xe8b8d433, 0x7807c9a2, 0x0f00f934, 0x9609a88e,
3326 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01,
3327 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed,
3328 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
3329 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3,
3330 0xfbd44c65, 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2,
3331 0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a,
3332 0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5,
3333 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa, 0xbe0b1010,
3334 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
3335 0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17,
3336 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6,
3337 0x03b6e20c, 0x74b1d29a, 0xead54739, 0x9dd277af, 0x04db2615,
3338 0x73dc1683, 0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8,
3339 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1, 0xf00f9344,
3340 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
3341 0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a,
3342 0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5,
3343 0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1,
3344 0xa6bc5767, 0x3fb506dd, 0x48b2364b, 0xd80d2bda, 0xaf0a1b4c,
3345 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef,
3346 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
3347 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe,
3348 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31,
3349 0x2cd99e8b, 0x5bdeae1d, 0x9b64c2b0, 0xec63f226, 0x756aa39c,
3350 0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713,
3351 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 0x92d28e9b,
3352 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
3353 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1,
3354 0x18b74777, 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c,
3355 0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45, 0xa00ae278,
3356 0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7,
3357 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc, 0x40df0b66,
3358 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
3359 0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605,
3360 0xcdd70693, 0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8,
3361 0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b,
3366 crc = ~crc & 0xffffffff;
3367 for (end = buf + len; buf < end; ++buf)
3368 crc = crc32_table[(crc ^ *buf) & 0xff] ^ (crc >> 8);
3369 return ~crc & 0xffffffff;;
3373 align_up (ULONGEST v, int n)
3375 /* Check that N is really a power of two. */
3376 gdb_assert (n && (n & (n-1)) == 0);
3377 return (v + n - 1) & -n;
3381 align_down (ULONGEST v, int n)
3383 /* Check that N is really a power of two. */
3384 gdb_assert (n && (n & (n-1)) == 0);
3388 /* Allocation function for the libiberty hash table which uses an
3389 obstack. The obstack is passed as DATA. */
3392 hashtab_obstack_allocate (void *data, size_t size, size_t count)
3394 unsigned int total = size * count;
3395 void *ptr = obstack_alloc ((struct obstack *) data, total);
3396 memset (ptr, 0, total);
3400 /* Trivial deallocation function for the libiberty splay tree and hash
3401 table - don't deallocate anything. Rely on later deletion of the
3402 obstack. DATA will be the obstack, although it is not needed
3406 dummy_obstack_deallocate (void *object, void *data)
3411 /* The bit offset of the highest byte in a ULONGEST, for overflow
3414 #define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT)
3416 /* True (non-zero) iff DIGIT is a valid digit in radix BASE,
3417 where 2 <= BASE <= 36. */
3420 is_digit_in_base (unsigned char digit, int base)
3422 if (!isalnum (digit))
3425 return (isdigit (digit) && digit < base + '0');
3427 return (isdigit (digit) || tolower (digit) < base - 10 + 'a');
3431 digit_to_int (unsigned char c)
3436 return tolower (c) - 'a' + 10;
3439 /* As for strtoul, but for ULONGEST results. */
3442 strtoulst (const char *num, const char **trailer, int base)
3444 unsigned int high_part;
3449 /* Skip leading whitespace. */
3450 while (isspace (num[i]))
3453 /* Handle prefixes. */
3456 else if (num[i] == '-')
3462 if (base == 0 || base == 16)
3464 if (num[i] == '0' && (num[i + 1] == 'x' || num[i + 1] == 'X'))
3472 if (base == 0 && num[i] == '0')
3478 if (base < 2 || base > 36)
3484 result = high_part = 0;
3485 for (; is_digit_in_base (num[i], base); i += 1)
3487 result = result * base + digit_to_int (num[i]);
3488 high_part = high_part * base + (unsigned int) (result >> HIGH_BYTE_POSN);
3489 result &= ((ULONGEST) 1 << HIGH_BYTE_POSN) - 1;
3490 if (high_part > 0xff)
3493 result = ~ (ULONGEST) 0;
3500 if (trailer != NULL)
3503 result = result + ((ULONGEST) high_part << HIGH_BYTE_POSN);
3510 /* Simple, portable version of dirname that does not modify its
3514 ldirname (const char *filename)
3516 const char *base = lbasename (filename);
3519 while (base > filename && IS_DIR_SEPARATOR (base[-1]))
3522 if (base == filename)
3525 dirname = xmalloc (base - filename + 2);
3526 memcpy (dirname, filename, base - filename);
3528 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3529 create "d:./bar" later instead of the (different) "d:/bar". */
3530 if (base - filename == 2 && IS_ABSOLUTE_PATH (base)
3531 && !IS_DIR_SEPARATOR (filename[0]))
3532 dirname[base++ - filename] = '.';
3534 dirname[base - filename] = '\0';
3538 /* Call libiberty's buildargv, and return the result.
3539 If buildargv fails due to out-of-memory, call nomem.
3540 Therefore, the returned value is guaranteed to be non-NULL,
3541 unless the parameter itself is NULL. */
3544 gdb_buildargv (const char *s)
3546 char **argv = buildargv (s);
3547 if (s != NULL && argv == NULL)
3552 /* Provide a prototype to silence -Wmissing-prototypes. */
3553 extern initialize_file_ftype _initialize_utils;
3556 _initialize_utils (void)
3558 add_internal_problem_command (&internal_error_problem);
3559 add_internal_problem_command (&internal_warning_problem);