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
936 quit_p = query (_("%s\nQuit this debugging session? "), reason);
938 else if (problem->should_quit == internal_problem_yes)
940 else if (problem->should_quit == internal_problem_no)
943 internal_error (__FILE__, __LINE__, _("bad switch"));
945 if (problem->should_dump_core == internal_problem_ask)
947 /* Default (yes/batch case) is to dump core. This leaves a GDB
948 `dropping' so that it is easier to see that something went
950 dump_core_p = query (_("%s\nCreate a core file of GDB? "), reason);
952 else if (problem->should_dump_core == internal_problem_yes)
954 else if (problem->should_dump_core == internal_problem_no)
957 internal_error (__FILE__, __LINE__, _("bad switch"));
962 abort (); /* NOTE: GDB has only four calls to abort(). */
970 #ifdef HAVE_WORKING_FORK
972 abort (); /* NOTE: GDB has only four calls to abort(). */
980 static struct internal_problem internal_error_problem = {
981 "internal-error", internal_problem_ask, internal_problem_ask
985 internal_verror (const char *file, int line, const char *fmt, va_list ap)
987 internal_vproblem (&internal_error_problem, file, line, fmt, ap);
988 deprecated_throw_reason (RETURN_ERROR);
992 internal_error (const char *file, int line, const char *string, ...)
995 va_start (ap, string);
996 internal_verror (file, line, string, ap);
1000 static struct internal_problem internal_warning_problem = {
1001 "internal-warning", internal_problem_ask, internal_problem_ask
1005 internal_vwarning (const char *file, int line, const char *fmt, va_list ap)
1007 internal_vproblem (&internal_warning_problem, file, line, fmt, ap);
1011 internal_warning (const char *file, int line, const char *string, ...)
1014 va_start (ap, string);
1015 internal_vwarning (file, line, string, ap);
1019 /* Dummy functions to keep add_prefix_cmd happy. */
1022 set_internal_problem_cmd (char *args, int from_tty)
1027 show_internal_problem_cmd (char *args, int from_tty)
1031 /* When GDB reports an internal problem (error or warning) it gives
1032 the user the opportunity to quit GDB and/or create a core file of
1033 the current debug session. This function registers a few commands
1034 that make it possible to specify that GDB should always or never
1035 quit or create a core file, without asking. The commands look
1038 maint set PROBLEM-NAME quit ask|yes|no
1039 maint show PROBLEM-NAME quit
1040 maint set PROBLEM-NAME corefile ask|yes|no
1041 maint show PROBLEM-NAME corefile
1043 Where PROBLEM-NAME is currently "internal-error" or
1044 "internal-warning". */
1047 add_internal_problem_command (struct internal_problem *problem)
1049 struct cmd_list_element **set_cmd_list;
1050 struct cmd_list_element **show_cmd_list;
1054 set_cmd_list = xmalloc (sizeof (*set_cmd_list));
1055 show_cmd_list = xmalloc (sizeof (*set_cmd_list));
1056 *set_cmd_list = NULL;
1057 *show_cmd_list = NULL;
1059 set_doc = xstrprintf (_("Configure what GDB does when %s is detected."),
1062 show_doc = xstrprintf (_("Show what GDB does when %s is detected."),
1065 add_prefix_cmd ((char*) problem->name,
1066 class_maintenance, set_internal_problem_cmd, set_doc,
1068 concat ("maintenance set ", problem->name, " ", NULL),
1069 0/*allow-unknown*/, &maintenance_set_cmdlist);
1071 add_prefix_cmd ((char*) problem->name,
1072 class_maintenance, show_internal_problem_cmd, show_doc,
1074 concat ("maintenance show ", problem->name, " ", NULL),
1075 0/*allow-unknown*/, &maintenance_show_cmdlist);
1077 set_doc = xstrprintf (_("\
1078 Set whether GDB should quit when an %s is detected"),
1080 show_doc = xstrprintf (_("\
1081 Show whether GDB will quit when an %s is detected"),
1083 add_setshow_enum_cmd ("quit", class_maintenance,
1084 internal_problem_modes,
1085 &problem->should_quit,
1088 NULL, /* help_doc */
1090 NULL, /* showfunc */
1094 set_doc = xstrprintf (_("\
1095 Set whether GDB should create a core file of GDB when %s is detected"),
1097 show_doc = xstrprintf (_("\
1098 Show whether GDB will create a core file of GDB when %s is detected"),
1100 add_setshow_enum_cmd ("corefile", class_maintenance,
1101 internal_problem_modes,
1102 &problem->should_dump_core,
1105 NULL, /* help_doc */
1107 NULL, /* showfunc */
1112 /* Print the system error message for errno, and also mention STRING
1113 as the file name for which the error was encountered.
1114 Then return to command level. */
1117 perror_with_name (const char *string)
1122 err = safe_strerror (errno);
1123 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
1124 strcpy (combined, string);
1125 strcat (combined, ": ");
1126 strcat (combined, err);
1128 /* I understand setting these is a matter of taste. Still, some people
1129 may clear errno but not know about bfd_error. Doing this here is not
1131 bfd_set_error (bfd_error_no_error);
1134 error (_("%s."), combined);
1137 /* Print the system error message for ERRCODE, and also mention STRING
1138 as the file name for which the error was encountered. */
1141 print_sys_errmsg (const char *string, int errcode)
1146 err = safe_strerror (errcode);
1147 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
1148 strcpy (combined, string);
1149 strcat (combined, ": ");
1150 strcat (combined, err);
1152 /* We want anything which was printed on stdout to come out first, before
1154 gdb_flush (gdb_stdout);
1155 fprintf_unfiltered (gdb_stderr, "%s.\n", combined);
1158 /* Control C eventually causes this to be called, at a convenient time. */
1164 /* No steenking SIGINT will ever be coming our way when the
1165 program is resumed. Don't lie. */
1169 /* If there is no terminal switching for this target, then we can't
1170 possibly get screwed by the lack of job control. */
1171 || current_target.to_terminal_ours == NULL)
1174 fatal ("Quit (expect signal SIGINT when the program is resumed)");
1179 /* Called when a memory allocation fails, with the number of bytes of
1180 memory requested in SIZE. */
1187 internal_error (__FILE__, __LINE__,
1188 _("virtual memory exhausted: can't allocate %ld bytes."),
1193 internal_error (__FILE__, __LINE__, _("virtual memory exhausted."));
1197 /* The xmalloc() (libiberty.h) family of memory management routines.
1199 These are like the ISO-C malloc() family except that they implement
1200 consistent semantics and guard against typical memory management
1203 /* NOTE: These are declared using PTR to ensure consistency with
1204 "libiberty.h". xfree() is GDB local. */
1207 xmalloc (size_t size)
1211 /* See libiberty/xmalloc.c. This function need's to match that's
1212 semantics. It never returns NULL. */
1216 val = malloc (size); /* ARI: malloc */
1224 xzalloc (size_t size)
1226 return xcalloc (1, size);
1230 xrealloc (PTR ptr, size_t size) /* ARI: PTR */
1234 /* See libiberty/xmalloc.c. This function need's to match that's
1235 semantics. It never returns NULL. */
1240 val = realloc (ptr, size); /* ARI: realloc */
1242 val = malloc (size); /* ARI: malloc */
1250 xcalloc (size_t number, size_t size)
1254 /* See libiberty/xmalloc.c. This function need's to match that's
1255 semantics. It never returns NULL. */
1256 if (number == 0 || size == 0)
1262 mem = calloc (number, size); /* ARI: xcalloc */
1264 nomem (number * size);
1273 free (ptr); /* ARI: free */
1277 /* Like asprintf/vasprintf but get an internal_error if the call
1281 xstrprintf (const char *format, ...)
1285 va_start (args, format);
1286 ret = xstrvprintf (format, args);
1292 xasprintf (char **ret, const char *format, ...)
1295 va_start (args, format);
1296 (*ret) = xstrvprintf (format, args);
1301 xvasprintf (char **ret, const char *format, va_list ap)
1303 (*ret) = xstrvprintf (format, ap);
1307 xstrvprintf (const char *format, va_list ap)
1310 int status = vasprintf (&ret, format, ap);
1311 /* NULL is returned when there was a memory allocation problem, or
1312 any other error (for instance, a bad format string). A negative
1313 status (the printed length) with a non-NULL buffer should never
1314 happen, but just to be sure. */
1315 if (ret == NULL || status < 0)
1316 internal_error (__FILE__, __LINE__, _("vasprintf call failed"));
1321 xsnprintf (char *str, size_t size, const char *format, ...)
1326 va_start (args, format);
1327 ret = vsnprintf (str, size, format, args);
1328 gdb_assert (ret < size);
1334 /* My replacement for the read system call.
1335 Used like `read' but keeps going if `read' returns too soon. */
1338 myread (int desc, char *addr, int len)
1345 val = read (desc, addr, len);
1349 return orglen - len;
1356 /* Make a copy of the string at PTR with SIZE characters
1357 (and add a null character at the end in the copy).
1358 Uses malloc to get the space. Returns the address of the copy. */
1361 savestring (const char *ptr, size_t size)
1363 char *p = (char *) xmalloc (size + 1);
1364 memcpy (p, ptr, size);
1370 print_spaces (int n, struct ui_file *file)
1372 fputs_unfiltered (n_spaces (n), file);
1375 /* Print a host address. */
1378 gdb_print_host_address (const void *addr, struct ui_file *stream)
1380 fprintf_filtered (stream, "%s", host_address_to_string (addr));
1384 /* This function supports the query, nquery, and yquery functions.
1385 Ask user a y-or-n question and return 0 if answer is no, 1 if
1386 answer is yes, or default the answer to the specified default
1387 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1388 default answer, or '\0' for no default.
1389 CTLSTR is the control string and should end in "? ". It should
1390 not say how to answer, because we do that.
1391 ARGS are the arguments passed along with the CTLSTR argument to
1394 static int ATTR_FORMAT (printf, 1, 0)
1395 defaulted_query (const char *ctlstr, const char defchar, va_list args)
1401 char def_answer, not_def_answer;
1402 char *y_string, *n_string, *question;
1404 /* Set up according to which answer is the default. */
1405 if (defchar == '\0')
1409 not_def_answer = 'N';
1413 else if (defchar == 'y')
1417 not_def_answer = 'N';
1425 not_def_answer = 'Y';
1430 /* Automatically answer the default value if the user did not want
1435 /* If input isn't coming from the user directly, just say what
1436 question we're asking, and then answer the default automatically. This
1437 way, important error messages don't get lost when talking to GDB
1439 if (! input_from_terminal_p ())
1442 vfprintf_filtered (gdb_stdout, ctlstr, args);
1444 printf_filtered (_("(%s or %s) [answered %c; input not from terminal]\n"),
1445 y_string, n_string, def_answer);
1446 gdb_flush (gdb_stdout);
1451 if (deprecated_query_hook)
1453 return deprecated_query_hook (ctlstr, args);
1456 /* Format the question outside of the loop, to avoid reusing args. */
1457 question = xstrvprintf (ctlstr, args);
1461 wrap_here (""); /* Flush any buffered output */
1462 gdb_flush (gdb_stdout);
1464 if (annotation_level > 1)
1465 printf_filtered (("\n\032\032pre-query\n"));
1467 fputs_filtered (question, gdb_stdout);
1468 printf_filtered (_("(%s or %s) "), y_string, n_string);
1470 if (annotation_level > 1)
1471 printf_filtered (("\n\032\032query\n"));
1474 gdb_flush (gdb_stdout);
1476 answer = fgetc (stdin);
1478 /* We expect fgetc to block until a character is read. But
1479 this may not be the case if the terminal was opened with
1480 the NONBLOCK flag. In that case, if there is nothing to
1481 read on stdin, fgetc returns EOF, but also sets the error
1482 condition flag on stdin and errno to EAGAIN. With a true
1483 EOF, stdin's error condition flag is not set.
1485 A situation where this behavior was observed is a pseudo
1487 while (answer == EOF && ferror (stdin) && errno == EAGAIN)
1489 /* Not a real EOF. Wait a little while and try again until
1490 we read something. */
1493 answer = fgetc (stdin);
1496 clearerr (stdin); /* in case of C-d */
1497 if (answer == EOF) /* C-d */
1499 printf_filtered ("EOF [assumed %c]\n", def_answer);
1503 /* Eat rest of input line, to EOF or newline */
1507 ans2 = fgetc (stdin);
1510 while (ans2 != EOF && ans2 != '\n' && ans2 != '\r');
1514 /* Check answer. For the non-default, the user must specify
1515 the non-default explicitly. */
1516 if (answer == not_def_answer)
1518 retval = !def_value;
1521 /* Otherwise, if a default was specified, the user may either
1522 specify the required input or have it default by entering
1524 if (answer == def_answer
1525 || (defchar != '\0' &&
1526 (answer == '\n' || answer == '\r' || answer == EOF)))
1531 /* Invalid entries are not defaulted and require another selection. */
1532 printf_filtered (_("Please answer %s or %s.\n"),
1533 y_string, n_string);
1537 if (annotation_level > 1)
1538 printf_filtered (("\n\032\032post-query\n"));
1543 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1544 answer is yes, or 0 if answer is defaulted.
1545 Takes three args which are given to printf to print the question.
1546 The first, a control string, should end in "? ".
1547 It should not say how to answer, because we do that. */
1550 nquery (const char *ctlstr, ...)
1554 va_start (args, ctlstr);
1555 return defaulted_query (ctlstr, 'n', args);
1559 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1560 answer is yes, or 1 if answer is defaulted.
1561 Takes three args which are given to printf to print the question.
1562 The first, a control string, should end in "? ".
1563 It should not say how to answer, because we do that. */
1566 yquery (const char *ctlstr, ...)
1570 va_start (args, ctlstr);
1571 return defaulted_query (ctlstr, 'y', args);
1575 /* Ask user a y-or-n question and return 1 iff answer is yes.
1576 Takes three args which are given to printf to print the question.
1577 The first, a control string, should end in "? ".
1578 It should not say how to answer, because we do that. */
1581 query (const char *ctlstr, ...)
1585 va_start (args, ctlstr);
1586 return defaulted_query (ctlstr, '\0', args);
1590 /* A helper for parse_escape that converts a host character to a
1591 target character. C is the host character. If conversion is
1592 possible, then the target character is stored in *TARGET_C and the
1593 function returns 1. Otherwise, the function returns 0. */
1596 host_char_to_target (int c, int *target_c)
1598 struct obstack host_data;
1600 struct cleanup *cleanups;
1603 obstack_init (&host_data);
1604 cleanups = make_cleanup_obstack_free (&host_data);
1606 convert_between_encodings (target_charset (), host_charset (),
1607 &the_char, 1, 1, &host_data, translit_none);
1609 if (obstack_object_size (&host_data) == 1)
1612 *target_c = *(char *) obstack_base (&host_data);
1615 do_cleanups (cleanups);
1619 /* Parse a C escape sequence. STRING_PTR points to a variable
1620 containing a pointer to the string to parse. That pointer
1621 should point to the character after the \. That pointer
1622 is updated past the characters we use. The value of the
1623 escape sequence is returned.
1625 A negative value means the sequence \ newline was seen,
1626 which is supposed to be equivalent to nothing at all.
1628 If \ is followed by a null character, we return a negative
1629 value and leave the string pointer pointing at the null character.
1631 If \ is followed by 000, we return 0 and leave the string pointer
1632 after the zeros. A value of 0 does not mean end of string. */
1635 parse_escape (char **string_ptr)
1637 int target_char = -2; /* initialize to avoid GCC warnings */
1638 int c = *(*string_ptr)++;
1656 int i = host_hex_value (c);
1661 if (isdigit (c) && c != '8' && c != '9')
1665 i += host_hex_value (c);
1701 if (!host_char_to_target (c, &target_char))
1703 ("The escape sequence `\%c' is equivalent to plain `%c', which"
1704 " has no equivalent\n" "in the `%s' character set.", c, c,
1709 /* Print the character C on STREAM as part of the contents of a literal
1710 string whose delimiter is QUOTER. Note that this routine should only
1711 be call for printing things which are independent of the language
1712 of the program being debugged. */
1715 printchar (int c, void (*do_fputs) (const char *, struct ui_file *),
1716 void (*do_fprintf) (struct ui_file *, const char *, ...)
1717 ATTRIBUTE_FPTR_PRINTF_2, struct ui_file *stream, int quoter)
1720 c &= 0xFF; /* Avoid sign bit follies */
1722 if (c < 0x20 || /* Low control chars */
1723 (c >= 0x7F && c < 0xA0) || /* DEL, High controls */
1724 (sevenbit_strings && c >= 0x80))
1725 { /* high order bit set */
1729 do_fputs ("\\n", stream);
1732 do_fputs ("\\b", stream);
1735 do_fputs ("\\t", stream);
1738 do_fputs ("\\f", stream);
1741 do_fputs ("\\r", stream);
1744 do_fputs ("\\e", stream);
1747 do_fputs ("\\a", stream);
1750 do_fprintf (stream, "\\%.3o", (unsigned int) c);
1756 if (c == '\\' || c == quoter)
1757 do_fputs ("\\", stream);
1758 do_fprintf (stream, "%c", c);
1762 /* Print the character C on STREAM as part of the contents of a
1763 literal string whose delimiter is QUOTER. Note that these routines
1764 should only be call for printing things which are independent of
1765 the language of the program being debugged. */
1768 fputstr_filtered (const char *str, int quoter, struct ui_file *stream)
1771 printchar (*str++, fputs_filtered, fprintf_filtered, stream, quoter);
1775 fputstr_unfiltered (const char *str, int quoter, struct ui_file *stream)
1778 printchar (*str++, fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1782 fputstrn_filtered (const char *str, int n, int quoter,
1783 struct ui_file *stream)
1786 for (i = 0; i < n; i++)
1787 printchar (str[i], fputs_filtered, fprintf_filtered, stream, quoter);
1791 fputstrn_unfiltered (const char *str, int n, int quoter,
1792 struct ui_file *stream)
1795 for (i = 0; i < n; i++)
1796 printchar (str[i], fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1800 /* Number of lines per page or UINT_MAX if paging is disabled. */
1801 static unsigned int lines_per_page;
1803 show_lines_per_page (struct ui_file *file, int from_tty,
1804 struct cmd_list_element *c, const char *value)
1806 fprintf_filtered (file, _("\
1807 Number of lines gdb thinks are in a page is %s.\n"),
1811 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1812 static unsigned int chars_per_line;
1814 show_chars_per_line (struct ui_file *file, int from_tty,
1815 struct cmd_list_element *c, const char *value)
1817 fprintf_filtered (file, _("\
1818 Number of characters gdb thinks are in a line is %s.\n"),
1822 /* Current count of lines printed on this page, chars on this line. */
1823 static unsigned int lines_printed, chars_printed;
1825 /* Buffer and start column of buffered text, for doing smarter word-
1826 wrapping. When someone calls wrap_here(), we start buffering output
1827 that comes through fputs_filtered(). If we see a newline, we just
1828 spit it out and forget about the wrap_here(). If we see another
1829 wrap_here(), we spit it out and remember the newer one. If we see
1830 the end of the line, we spit out a newline, the indent, and then
1831 the buffered output. */
1833 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1834 are waiting to be output (they have already been counted in chars_printed).
1835 When wrap_buffer[0] is null, the buffer is empty. */
1836 static char *wrap_buffer;
1838 /* Pointer in wrap_buffer to the next character to fill. */
1839 static char *wrap_pointer;
1841 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1843 static char *wrap_indent;
1845 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1846 is not in effect. */
1847 static int wrap_column;
1850 /* Inialize the number of lines per page and chars per line. */
1853 init_page_info (void)
1856 if (!tui_get_command_dimension (&chars_per_line, &lines_per_page))
1861 #if defined(__GO32__)
1862 rows = ScreenRows ();
1863 cols = ScreenCols ();
1864 lines_per_page = rows;
1865 chars_per_line = cols;
1867 /* Make sure Readline has initialized its terminal settings. */
1868 rl_reset_terminal (NULL);
1870 /* Get the screen size from Readline. */
1871 rl_get_screen_size (&rows, &cols);
1872 lines_per_page = rows;
1873 chars_per_line = cols;
1875 /* Readline should have fetched the termcap entry for us. */
1876 if (tgetnum ("li") < 0 || getenv ("EMACS"))
1878 /* The number of lines per page is not mentioned in the
1879 terminal description. This probably means that paging is
1880 not useful (e.g. emacs shell window), so disable paging. */
1881 lines_per_page = UINT_MAX;
1884 /* FIXME: Get rid of this junk. */
1885 #if defined(SIGWINCH) && defined(SIGWINCH_HANDLER)
1886 SIGWINCH_HANDLER (SIGWINCH);
1889 /* If the output is not a terminal, don't paginate it. */
1890 if (!ui_file_isatty (gdb_stdout))
1891 lines_per_page = UINT_MAX;
1899 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1902 set_screen_size (void)
1904 int rows = lines_per_page;
1905 int cols = chars_per_line;
1913 /* Update Readline's idea of the terminal size. */
1914 rl_set_screen_size (rows, cols);
1917 /* Reinitialize WRAP_BUFFER according to the current value of
1923 if (chars_per_line == 0)
1928 wrap_buffer = (char *) xmalloc (chars_per_line + 2);
1929 wrap_buffer[0] = '\0';
1932 wrap_buffer = (char *) xrealloc (wrap_buffer, chars_per_line + 2);
1933 wrap_pointer = wrap_buffer; /* Start it at the beginning. */
1937 set_width_command (char *args, int from_tty, struct cmd_list_element *c)
1944 set_height_command (char *args, int from_tty, struct cmd_list_element *c)
1949 /* Wait, so the user can read what's on the screen. Prompt the user
1950 to continue by pressing RETURN. */
1953 prompt_for_continue (void)
1956 char cont_prompt[120];
1958 if (annotation_level > 1)
1959 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1961 strcpy (cont_prompt,
1962 "---Type <return> to continue, or q <return> to quit---");
1963 if (annotation_level > 1)
1964 strcat (cont_prompt, "\n\032\032prompt-for-continue\n");
1966 /* We must do this *before* we call gdb_readline, else it will eventually
1967 call us -- thinking that we're trying to print beyond the end of the
1969 reinitialize_more_filter ();
1972 /* On a real operating system, the user can quit with SIGINT.
1975 'q' is provided on all systems so users don't have to change habits
1976 from system to system, and because telling them what to do in
1977 the prompt is more user-friendly than expecting them to think of
1979 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1980 whereas control-C to gdb_readline will cause the user to get dumped
1982 ignore = gdb_readline_wrapper (cont_prompt);
1984 if (annotation_level > 1)
1985 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1990 while (*p == ' ' || *p == '\t')
1993 async_request_quit (0);
1998 /* Now we have to do this again, so that GDB will know that it doesn't
1999 need to save the ---Type <return>--- line at the top of the screen. */
2000 reinitialize_more_filter ();
2002 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
2005 /* Reinitialize filter; ie. tell it to reset to original values. */
2008 reinitialize_more_filter (void)
2014 /* Indicate that if the next sequence of characters overflows the line,
2015 a newline should be inserted here rather than when it hits the end.
2016 If INDENT is non-null, it is a string to be printed to indent the
2017 wrapped part on the next line. INDENT must remain accessible until
2018 the next call to wrap_here() or until a newline is printed through
2021 If the line is already overfull, we immediately print a newline and
2022 the indentation, and disable further wrapping.
2024 If we don't know the width of lines, but we know the page height,
2025 we must not wrap words, but should still keep track of newlines
2026 that were explicitly printed.
2028 INDENT should not contain tabs, as that will mess up the char count
2029 on the next line. FIXME.
2031 This routine is guaranteed to force out any output which has been
2032 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
2033 used to force out output from the wrap_buffer. */
2036 wrap_here (char *indent)
2038 /* This should have been allocated, but be paranoid anyway. */
2040 internal_error (__FILE__, __LINE__, _("failed internal consistency check"));
2044 *wrap_pointer = '\0';
2045 fputs_unfiltered (wrap_buffer, gdb_stdout);
2047 wrap_pointer = wrap_buffer;
2048 wrap_buffer[0] = '\0';
2049 if (chars_per_line == UINT_MAX) /* No line overflow checking */
2053 else if (chars_printed >= chars_per_line)
2055 puts_filtered ("\n");
2057 puts_filtered (indent);
2062 wrap_column = chars_printed;
2066 wrap_indent = indent;
2070 /* Print input string to gdb_stdout, filtered, with wrap,
2071 arranging strings in columns of n chars. String can be
2072 right or left justified in the column. Never prints
2073 trailing spaces. String should never be longer than
2074 width. FIXME: this could be useful for the EXAMINE
2075 command, which currently doesn't tabulate very well */
2078 puts_filtered_tabular (char *string, int width, int right)
2084 gdb_assert (chars_per_line > 0);
2085 if (chars_per_line == UINT_MAX)
2087 fputs_filtered (string, gdb_stdout);
2088 fputs_filtered ("\n", gdb_stdout);
2092 if (((chars_printed - 1) / width + 2) * width >= chars_per_line)
2093 fputs_filtered ("\n", gdb_stdout);
2095 if (width >= chars_per_line)
2096 width = chars_per_line - 1;
2098 stringlen = strlen (string);
2100 if (chars_printed > 0)
2101 spaces = width - (chars_printed - 1) % width - 1;
2103 spaces += width - stringlen;
2105 spacebuf = alloca (spaces + 1);
2106 spacebuf[spaces] = '\0';
2108 spacebuf[spaces] = ' ';
2110 fputs_filtered (spacebuf, gdb_stdout);
2111 fputs_filtered (string, gdb_stdout);
2115 /* Ensure that whatever gets printed next, using the filtered output
2116 commands, starts at the beginning of the line. I.E. if there is
2117 any pending output for the current line, flush it and start a new
2118 line. Otherwise do nothing. */
2123 if (chars_printed > 0)
2125 puts_filtered ("\n");
2130 /* Like fputs but if FILTER is true, pause after every screenful.
2132 Regardless of FILTER can wrap at points other than the final
2133 character of a line.
2135 Unlike fputs, fputs_maybe_filtered does not return a value.
2136 It is OK for LINEBUFFER to be NULL, in which case just don't print
2139 Note that a longjmp to top level may occur in this routine (only if
2140 FILTER is true) (since prompt_for_continue may do so) so this
2141 routine should not be called when cleanups are not in place. */
2144 fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
2147 const char *lineptr;
2149 if (linebuffer == 0)
2152 /* Don't do any filtering if it is disabled. */
2153 if ((stream != gdb_stdout) || !pagination_enabled
2154 || (lines_per_page == UINT_MAX && chars_per_line == UINT_MAX))
2156 fputs_unfiltered (linebuffer, stream);
2160 /* Go through and output each character. Show line extension
2161 when this is necessary; prompt user for new page when this is
2164 lineptr = linebuffer;
2167 /* Possible new page. */
2168 if (filter && (lines_printed >= lines_per_page - 1))
2169 prompt_for_continue ();
2171 while (*lineptr && *lineptr != '\n')
2173 /* Print a single line. */
2174 if (*lineptr == '\t')
2177 *wrap_pointer++ = '\t';
2179 fputc_unfiltered ('\t', stream);
2180 /* Shifting right by 3 produces the number of tab stops
2181 we have already passed, and then adding one and
2182 shifting left 3 advances to the next tab stop. */
2183 chars_printed = ((chars_printed >> 3) + 1) << 3;
2189 *wrap_pointer++ = *lineptr;
2191 fputc_unfiltered (*lineptr, stream);
2196 if (chars_printed >= chars_per_line)
2198 unsigned int save_chars = chars_printed;
2202 /* If we aren't actually wrapping, don't output newline --
2203 if chars_per_line is right, we probably just overflowed
2204 anyway; if it's wrong, let us keep going. */
2206 fputc_unfiltered ('\n', stream);
2208 /* Possible new page. */
2209 if (lines_printed >= lines_per_page - 1)
2210 prompt_for_continue ();
2212 /* Now output indentation and wrapped string */
2215 fputs_unfiltered (wrap_indent, stream);
2216 *wrap_pointer = '\0'; /* Null-terminate saved stuff */
2217 fputs_unfiltered (wrap_buffer, stream); /* and eject it */
2218 /* FIXME, this strlen is what prevents wrap_indent from
2219 containing tabs. However, if we recurse to print it
2220 and count its chars, we risk trouble if wrap_indent is
2221 longer than (the user settable) chars_per_line.
2222 Note also that this can set chars_printed > chars_per_line
2223 if we are printing a long string. */
2224 chars_printed = strlen (wrap_indent)
2225 + (save_chars - wrap_column);
2226 wrap_pointer = wrap_buffer; /* Reset buffer */
2227 wrap_buffer[0] = '\0';
2228 wrap_column = 0; /* And disable fancy wrap */
2233 if (*lineptr == '\n')
2236 wrap_here ((char *) 0); /* Spit out chars, cancel further wraps */
2238 fputc_unfiltered ('\n', stream);
2245 fputs_filtered (const char *linebuffer, struct ui_file *stream)
2247 fputs_maybe_filtered (linebuffer, stream, 1);
2251 putchar_unfiltered (int c)
2254 ui_file_write (gdb_stdout, &buf, 1);
2258 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2259 May return nonlocally. */
2262 putchar_filtered (int c)
2264 return fputc_filtered (c, gdb_stdout);
2268 fputc_unfiltered (int c, struct ui_file *stream)
2271 ui_file_write (stream, &buf, 1);
2276 fputc_filtered (int c, struct ui_file *stream)
2282 fputs_filtered (buf, stream);
2286 /* puts_debug is like fputs_unfiltered, except it prints special
2287 characters in printable fashion. */
2290 puts_debug (char *prefix, char *string, char *suffix)
2294 /* Print prefix and suffix after each line. */
2295 static int new_line = 1;
2296 static int return_p = 0;
2297 static char *prev_prefix = "";
2298 static char *prev_suffix = "";
2300 if (*string == '\n')
2303 /* If the prefix is changing, print the previous suffix, a new line,
2304 and the new prefix. */
2305 if ((return_p || (strcmp (prev_prefix, prefix) != 0)) && !new_line)
2307 fputs_unfiltered (prev_suffix, gdb_stdlog);
2308 fputs_unfiltered ("\n", gdb_stdlog);
2309 fputs_unfiltered (prefix, gdb_stdlog);
2312 /* Print prefix if we printed a newline during the previous call. */
2316 fputs_unfiltered (prefix, gdb_stdlog);
2319 prev_prefix = prefix;
2320 prev_suffix = suffix;
2322 /* Output characters in a printable format. */
2323 while ((ch = *string++) != '\0')
2329 fputc_unfiltered (ch, gdb_stdlog);
2332 fprintf_unfiltered (gdb_stdlog, "\\x%02x", ch & 0xff);
2336 fputs_unfiltered ("\\\\", gdb_stdlog);
2339 fputs_unfiltered ("\\b", gdb_stdlog);
2342 fputs_unfiltered ("\\f", gdb_stdlog);
2346 fputs_unfiltered ("\\n", gdb_stdlog);
2349 fputs_unfiltered ("\\r", gdb_stdlog);
2352 fputs_unfiltered ("\\t", gdb_stdlog);
2355 fputs_unfiltered ("\\v", gdb_stdlog);
2359 return_p = ch == '\r';
2362 /* Print suffix if we printed a newline. */
2365 fputs_unfiltered (suffix, gdb_stdlog);
2366 fputs_unfiltered ("\n", gdb_stdlog);
2371 /* Print a variable number of ARGS using format FORMAT. If this
2372 information is going to put the amount written (since the last call
2373 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2374 call prompt_for_continue to get the users permision to continue.
2376 Unlike fprintf, this function does not return a value.
2378 We implement three variants, vfprintf (takes a vararg list and stream),
2379 fprintf (takes a stream to write on), and printf (the usual).
2381 Note also that a longjmp to top level may occur in this routine
2382 (since prompt_for_continue may do so) so this routine should not be
2383 called when cleanups are not in place. */
2386 vfprintf_maybe_filtered (struct ui_file *stream, const char *format,
2387 va_list args, int filter)
2390 struct cleanup *old_cleanups;
2392 linebuffer = xstrvprintf (format, args);
2393 old_cleanups = make_cleanup (xfree, linebuffer);
2394 fputs_maybe_filtered (linebuffer, stream, filter);
2395 do_cleanups (old_cleanups);
2400 vfprintf_filtered (struct ui_file *stream, const char *format, va_list args)
2402 vfprintf_maybe_filtered (stream, format, args, 1);
2406 vfprintf_unfiltered (struct ui_file *stream, const char *format, va_list args)
2409 struct cleanup *old_cleanups;
2411 linebuffer = xstrvprintf (format, args);
2412 old_cleanups = make_cleanup (xfree, linebuffer);
2413 if (debug_timestamp && stream == gdb_stdlog)
2419 gettimeofday (&tm, NULL);
2421 len = strlen (linebuffer);
2422 need_nl = (len > 0 && linebuffer[len - 1] != '\n');
2424 timestamp = xstrprintf ("%ld:%ld %s%s",
2425 (long) tm.tv_sec, (long) tm.tv_usec,
2427 need_nl ? "\n": "");
2428 make_cleanup (xfree, timestamp);
2429 fputs_unfiltered (timestamp, stream);
2432 fputs_unfiltered (linebuffer, stream);
2433 do_cleanups (old_cleanups);
2437 vprintf_filtered (const char *format, va_list args)
2439 vfprintf_maybe_filtered (gdb_stdout, format, args, 1);
2443 vprintf_unfiltered (const char *format, va_list args)
2445 vfprintf_unfiltered (gdb_stdout, format, args);
2449 fprintf_filtered (struct ui_file *stream, const char *format, ...)
2452 va_start (args, format);
2453 vfprintf_filtered (stream, format, args);
2458 fprintf_unfiltered (struct ui_file *stream, const char *format, ...)
2461 va_start (args, format);
2462 vfprintf_unfiltered (stream, format, args);
2466 /* Like fprintf_filtered, but prints its result indented.
2467 Called as fprintfi_filtered (spaces, stream, format, ...); */
2470 fprintfi_filtered (int spaces, struct ui_file *stream, const char *format,
2474 va_start (args, format);
2475 print_spaces_filtered (spaces, stream);
2477 vfprintf_filtered (stream, format, args);
2483 printf_filtered (const char *format, ...)
2486 va_start (args, format);
2487 vfprintf_filtered (gdb_stdout, format, args);
2493 printf_unfiltered (const char *format, ...)
2496 va_start (args, format);
2497 vfprintf_unfiltered (gdb_stdout, format, args);
2501 /* Like printf_filtered, but prints it's result indented.
2502 Called as printfi_filtered (spaces, format, ...); */
2505 printfi_filtered (int spaces, const char *format, ...)
2508 va_start (args, format);
2509 print_spaces_filtered (spaces, gdb_stdout);
2510 vfprintf_filtered (gdb_stdout, format, args);
2514 /* Easy -- but watch out!
2516 This routine is *not* a replacement for puts()! puts() appends a newline.
2517 This one doesn't, and had better not! */
2520 puts_filtered (const char *string)
2522 fputs_filtered (string, gdb_stdout);
2526 puts_unfiltered (const char *string)
2528 fputs_unfiltered (string, gdb_stdout);
2531 /* Return a pointer to N spaces and a null. The pointer is good
2532 until the next call to here. */
2537 static char *spaces = 0;
2538 static int max_spaces = -1;
2544 spaces = (char *) xmalloc (n + 1);
2545 for (t = spaces + n; t != spaces;)
2551 return spaces + max_spaces - n;
2554 /* Print N spaces. */
2556 print_spaces_filtered (int n, struct ui_file *stream)
2558 fputs_filtered (n_spaces (n), stream);
2561 /* C++/ObjC demangler stuff. */
2563 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2564 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2565 If the name is not mangled, or the language for the name is unknown, or
2566 demangling is off, the name is printed in its "raw" form. */
2569 fprintf_symbol_filtered (struct ui_file *stream, char *name,
2570 enum language lang, int arg_mode)
2576 /* If user wants to see raw output, no problem. */
2579 fputs_filtered (name, stream);
2583 demangled = language_demangle (language_def (lang), name, arg_mode);
2584 fputs_filtered (demangled ? demangled : name, stream);
2585 if (demangled != NULL)
2593 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2594 differences in whitespace. Returns 0 if they match, non-zero if they
2595 don't (slightly different than strcmp()'s range of return values).
2597 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2598 This "feature" is useful when searching for matching C++ function names
2599 (such as if the user types 'break FOO', where FOO is a mangled C++
2603 strcmp_iw (const char *string1, const char *string2)
2605 while ((*string1 != '\0') && (*string2 != '\0'))
2607 while (isspace (*string1))
2611 while (isspace (*string2))
2615 if (*string1 != *string2)
2619 if (*string1 != '\0')
2625 return (*string1 != '\0' && *string1 != '(') || (*string2 != '\0');
2628 /* This is like strcmp except that it ignores whitespace and treats
2629 '(' as the first non-NULL character in terms of ordering. Like
2630 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2631 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2632 according to that ordering.
2634 If a list is sorted according to this function and if you want to
2635 find names in the list that match some fixed NAME according to
2636 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2637 where this function would put NAME.
2639 Here are some examples of why using strcmp to sort is a bad idea:
2643 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2644 we try to do a search for "foo<char*>", strcmp will locate this
2645 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2646 will start looking at strings beginning with "goo", and will never
2647 see the correct match of "foo<char *>".
2649 Parenthesis example:
2651 In practice, this is less like to be an issue, but I'll give it a
2652 shot. Let's assume that '$' is a legitimate character to occur in
2653 symbols. (Which may well even be the case on some systems.) Then
2654 say that the partial symbol table contains "foo$" and "foo(int)".
2655 strcmp will put them in this order, since '$' < '('. Now, if the
2656 user searches for "foo", then strcmp will sort "foo" before "foo$".
2657 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2658 "foo") is false, so it won't proceed to the actual match of
2659 "foo(int)" with "foo". */
2662 strcmp_iw_ordered (const char *string1, const char *string2)
2664 while ((*string1 != '\0') && (*string2 != '\0'))
2666 while (isspace (*string1))
2670 while (isspace (*string2))
2674 if (*string1 != *string2)
2678 if (*string1 != '\0')
2687 /* Characters are non-equal unless they're both '\0'; we want to
2688 make sure we get the comparison right according to our
2689 comparison in the cases where one of them is '\0' or '('. */
2691 if (*string2 == '\0')
2696 if (*string2 == '\0')
2701 if (*string2 == '(')
2704 return *string1 - *string2;
2708 /* A simple comparison function with opposite semantics to strcmp. */
2711 streq (const char *lhs, const char *rhs)
2713 return !strcmp (lhs, rhs);
2719 ** Answer whether string_to_compare is a full or partial match to
2720 ** template_string. The partial match must be in sequence starting
2724 subset_compare (char *string_to_compare, char *template_string)
2727 if (template_string != (char *) NULL && string_to_compare != (char *) NULL
2728 && strlen (string_to_compare) <= strlen (template_string))
2731 (template_string, string_to_compare, strlen (string_to_compare)) == 0);
2738 pagination_on_command (char *arg, int from_tty)
2740 pagination_enabled = 1;
2744 pagination_off_command (char *arg, int from_tty)
2746 pagination_enabled = 0;
2750 show_debug_timestamp (struct ui_file *file, int from_tty,
2751 struct cmd_list_element *c, const char *value)
2753 fprintf_filtered (file, _("Timestamping debugging messages is %s.\n"), value);
2758 initialize_utils (void)
2760 struct cmd_list_element *c;
2762 add_setshow_uinteger_cmd ("width", class_support, &chars_per_line, _("\
2763 Set number of characters gdb thinks are in a line."), _("\
2764 Show number of characters gdb thinks are in a line."), NULL,
2766 show_chars_per_line,
2767 &setlist, &showlist);
2769 add_setshow_uinteger_cmd ("height", class_support, &lines_per_page, _("\
2770 Set number of lines gdb thinks are in a page."), _("\
2771 Show number of lines gdb thinks are in a page."), NULL,
2773 show_lines_per_page,
2774 &setlist, &showlist);
2778 add_setshow_boolean_cmd ("demangle", class_support, &demangle, _("\
2779 Set demangling of encoded C++/ObjC names when displaying symbols."), _("\
2780 Show demangling of encoded C++/ObjC names when displaying symbols."), NULL,
2783 &setprintlist, &showprintlist);
2785 add_setshow_boolean_cmd ("pagination", class_support,
2786 &pagination_enabled, _("\
2787 Set state of pagination."), _("\
2788 Show state of pagination."), NULL,
2790 show_pagination_enabled,
2791 &setlist, &showlist);
2795 add_com ("am", class_support, pagination_on_command,
2796 _("Enable pagination"));
2797 add_com ("sm", class_support, pagination_off_command,
2798 _("Disable pagination"));
2801 add_setshow_boolean_cmd ("sevenbit-strings", class_support,
2802 &sevenbit_strings, _("\
2803 Set printing of 8-bit characters in strings as \\nnn."), _("\
2804 Show printing of 8-bit characters in strings as \\nnn."), NULL,
2806 show_sevenbit_strings,
2807 &setprintlist, &showprintlist);
2809 add_setshow_boolean_cmd ("asm-demangle", class_support, &asm_demangle, _("\
2810 Set demangling of C++/ObjC names in disassembly listings."), _("\
2811 Show demangling of C++/ObjC names in disassembly listings."), NULL,
2814 &setprintlist, &showprintlist);
2816 add_setshow_boolean_cmd ("timestamp", class_maintenance,
2817 &debug_timestamp, _("\
2818 Set timestamping of debugging messages."), _("\
2819 Show timestamping of debugging messages."), _("\
2820 When set, debugging messages will be marked with seconds and microseconds."),
2822 show_debug_timestamp,
2823 &setdebuglist, &showdebuglist);
2826 /* Machine specific function to handle SIGWINCH signal. */
2828 #ifdef SIGWINCH_HANDLER_BODY
2829 SIGWINCH_HANDLER_BODY
2831 /* print routines to handle variable size regs, etc. */
2832 /* temporary storage using circular buffer */
2838 static char buf[NUMCELLS][CELLSIZE];
2839 static int cell = 0;
2840 if (++cell >= NUMCELLS)
2846 paddress (struct gdbarch *gdbarch, CORE_ADDR addr)
2848 /* Truncate address to the size of a target address, avoiding shifts
2849 larger or equal than the width of a CORE_ADDR. The local
2850 variable ADDR_BIT stops the compiler reporting a shift overflow
2851 when it won't occur. */
2852 /* NOTE: This assumes that the significant address information is
2853 kept in the least significant bits of ADDR - the upper bits were
2854 either zero or sign extended. Should gdbarch_address_to_pointer or
2855 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2857 int addr_bit = gdbarch_addr_bit (gdbarch);
2859 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2860 addr &= ((CORE_ADDR) 1 << addr_bit) - 1;
2861 return hex_string (addr);
2865 decimal2str (char *sign, ULONGEST addr, int width)
2867 /* Steal code from valprint.c:print_decimal(). Should this worry
2868 about the real size of addr as the above does? */
2869 unsigned long temp[3];
2870 char *str = get_cell ();
2875 temp[i] = addr % (1000 * 1000 * 1000);
2876 addr /= (1000 * 1000 * 1000);
2880 while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0])));
2889 xsnprintf (str, CELLSIZE, "%s%0*lu", sign, width, temp[0]);
2892 xsnprintf (str, CELLSIZE, "%s%0*lu%09lu", sign, width,
2896 xsnprintf (str, CELLSIZE, "%s%0*lu%09lu%09lu", sign, width,
2897 temp[2], temp[1], temp[0]);
2900 internal_error (__FILE__, __LINE__,
2901 _("failed internal consistency check"));
2908 octal2str (ULONGEST addr, int width)
2910 unsigned long temp[3];
2911 char *str = get_cell ();
2916 temp[i] = addr % (0100000 * 0100000);
2917 addr /= (0100000 * 0100000);
2921 while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0])));
2931 xsnprintf (str, CELLSIZE, "%*o", width, 0);
2933 xsnprintf (str, CELLSIZE, "0%0*lo", width, temp[0]);
2936 xsnprintf (str, CELLSIZE, "0%0*lo%010lo", width, temp[1], temp[0]);
2939 xsnprintf (str, CELLSIZE, "0%0*lo%010lo%010lo", width,
2940 temp[2], temp[1], temp[0]);
2943 internal_error (__FILE__, __LINE__,
2944 _("failed internal consistency check"));
2951 pulongest (ULONGEST u)
2953 return decimal2str ("", u, 0);
2957 plongest (LONGEST l)
2960 return decimal2str ("-", -l, 0);
2962 return decimal2str ("", l, 0);
2965 /* Eliminate warning from compiler on 32-bit systems. */
2966 static int thirty_two = 32;
2969 phex (ULONGEST l, int sizeof_l)
2977 xsnprintf (str, CELLSIZE, "%08lx%08lx",
2978 (unsigned long) (l >> thirty_two),
2979 (unsigned long) (l & 0xffffffff));
2983 xsnprintf (str, CELLSIZE, "%08lx", (unsigned long) l);
2987 xsnprintf (str, CELLSIZE, "%04x", (unsigned short) (l & 0xffff));
2990 str = phex (l, sizeof (l));
2998 phex_nz (ULONGEST l, int sizeof_l)
3006 unsigned long high = (unsigned long) (l >> thirty_two);
3009 xsnprintf (str, CELLSIZE, "%lx",
3010 (unsigned long) (l & 0xffffffff));
3012 xsnprintf (str, CELLSIZE, "%lx%08lx", high,
3013 (unsigned long) (l & 0xffffffff));
3018 xsnprintf (str, CELLSIZE, "%lx", (unsigned long) l);
3022 xsnprintf (str, CELLSIZE, "%x", (unsigned short) (l & 0xffff));
3025 str = phex_nz (l, sizeof (l));
3032 /* Converts a LONGEST to a C-format hexadecimal literal and stores it
3033 in a static string. Returns a pointer to this string. */
3035 hex_string (LONGEST num)
3037 char *result = get_cell ();
3038 xsnprintf (result, CELLSIZE, "0x%s", phex_nz (num, sizeof (num)));
3042 /* Converts a LONGEST number to a C-format hexadecimal literal and
3043 stores it in a static string. Returns a pointer to this string
3044 that is valid until the next call. The number is padded on the
3045 left with 0s to at least WIDTH characters. */
3047 hex_string_custom (LONGEST num, int width)
3049 char *result = get_cell ();
3050 char *result_end = result + CELLSIZE - 1;
3051 const char *hex = phex_nz (num, sizeof (num));
3052 int hex_len = strlen (hex);
3054 if (hex_len > width)
3056 if (width + 2 >= CELLSIZE)
3057 internal_error (__FILE__, __LINE__,
3058 _("hex_string_custom: insufficient space to store result"));
3060 strcpy (result_end - width - 2, "0x");
3061 memset (result_end - width, '0', width);
3062 strcpy (result_end - hex_len, hex);
3063 return result_end - width - 2;
3066 /* Convert VAL to a numeral in the given radix. For
3067 * radix 10, IS_SIGNED may be true, indicating a signed quantity;
3068 * otherwise VAL is interpreted as unsigned. If WIDTH is supplied,
3069 * it is the minimum width (0-padded if needed). USE_C_FORMAT means
3070 * to use C format in all cases. If it is false, then 'x'
3071 * and 'o' formats do not include a prefix (0x or leading 0). */
3074 int_string (LONGEST val, int radix, int is_signed, int width,
3083 result = hex_string (val);
3085 result = hex_string_custom (val, width);
3092 if (is_signed && val < 0)
3093 return decimal2str ("-", -val, width);
3095 return decimal2str ("", val, width);
3099 char *result = octal2str (val, width);
3100 if (use_c_format || val == 0)
3106 internal_error (__FILE__, __LINE__,
3107 _("failed internal consistency check"));
3111 /* Convert a CORE_ADDR into a string. */
3113 core_addr_to_string (const CORE_ADDR addr)
3115 char *str = get_cell ();
3117 strcat (str, phex (addr, sizeof (addr)));
3122 core_addr_to_string_nz (const CORE_ADDR addr)
3124 char *str = get_cell ();
3126 strcat (str, phex_nz (addr, sizeof (addr)));
3130 /* Convert a string back into a CORE_ADDR. */
3132 string_to_core_addr (const char *my_string)
3136 if (my_string[0] == '0' && tolower (my_string[1]) == 'x')
3138 /* Assume that it is in hex. */
3140 for (i = 2; my_string[i] != '\0'; i++)
3142 if (isdigit (my_string[i]))
3143 addr = (my_string[i] - '0') + (addr * 16);
3144 else if (isxdigit (my_string[i]))
3145 addr = (tolower (my_string[i]) - 'a' + 0xa) + (addr * 16);
3147 error (_("invalid hex \"%s\""), my_string);
3152 /* Assume that it is in decimal. */
3154 for (i = 0; my_string[i] != '\0'; i++)
3156 if (isdigit (my_string[i]))
3157 addr = (my_string[i] - '0') + (addr * 10);
3159 error (_("invalid decimal \"%s\""), my_string);
3167 host_address_to_string (const void *addr)
3169 char *str = get_cell ();
3171 xsnprintf (str, CELLSIZE, "0x%s", phex_nz ((uintptr_t) addr, sizeof (addr)));
3176 gdb_realpath (const char *filename)
3178 /* Method 1: The system has a compile time upper bound on a filename
3179 path. Use that and realpath() to canonicalize the name. This is
3180 the most common case. Note that, if there isn't a compile time
3181 upper bound, you want to avoid realpath() at all costs. */
3182 #if defined(HAVE_REALPATH)
3184 # if defined (PATH_MAX)
3186 # define USE_REALPATH
3187 # elif defined (MAXPATHLEN)
3188 char buf[MAXPATHLEN];
3189 # define USE_REALPATH
3191 # if defined (USE_REALPATH)
3192 const char *rp = realpath (filename, buf);
3195 return xstrdup (rp);
3198 #endif /* HAVE_REALPATH */
3200 /* Method 2: The host system (i.e., GNU) has the function
3201 canonicalize_file_name() which malloc's a chunk of memory and
3202 returns that, use that. */
3203 #if defined(HAVE_CANONICALIZE_FILE_NAME)
3205 char *rp = canonicalize_file_name (filename);
3207 return xstrdup (filename);
3213 /* FIXME: cagney/2002-11-13:
3215 Method 2a: Use realpath() with a NULL buffer. Some systems, due
3216 to the problems described in in method 3, have modified their
3217 realpath() implementation so that it will allocate a buffer when
3218 NULL is passed in. Before this can be used, though, some sort of
3219 configure time test would need to be added. Otherwize the code
3220 will likely core dump. */
3222 /* Method 3: Now we're getting desperate! The system doesn't have a
3223 compile time buffer size and no alternative function. Query the
3224 OS, using pathconf(), for the buffer limit. Care is needed
3225 though, some systems do not limit PATH_MAX (return -1 for
3226 pathconf()) making it impossible to pass a correctly sized buffer
3227 to realpath() (it could always overflow). On those systems, we
3229 #if defined (HAVE_REALPATH) && defined (HAVE_UNISTD_H) && defined(HAVE_ALLOCA)
3231 /* Find out the max path size. */
3232 long path_max = pathconf ("/", _PC_PATH_MAX);
3235 /* PATH_MAX is bounded. */
3236 char *buf = alloca (path_max);
3237 char *rp = realpath (filename, buf);
3238 return xstrdup (rp ? rp : filename);
3243 /* This system is a lost cause, just dup the buffer. */
3244 return xstrdup (filename);
3247 /* Return a copy of FILENAME, with its directory prefix canonicalized
3251 xfullpath (const char *filename)
3253 const char *base_name = lbasename (filename);
3258 /* Extract the basename of filename, and return immediately
3259 a copy of filename if it does not contain any directory prefix. */
3260 if (base_name == filename)
3261 return xstrdup (filename);
3263 dir_name = alloca ((size_t) (base_name - filename + 2));
3264 /* Allocate enough space to store the dir_name + plus one extra
3265 character sometimes needed under Windows (see below), and
3266 then the closing \000 character */
3267 strncpy (dir_name, filename, base_name - filename);
3268 dir_name[base_name - filename] = '\000';
3270 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3271 /* We need to be careful when filename is of the form 'd:foo', which
3272 is equivalent of d:./foo, which is totally different from d:/foo. */
3273 if (strlen (dir_name) == 2 && isalpha (dir_name[0]) && dir_name[1] == ':')
3276 dir_name[3] = '\000';
3280 /* Canonicalize the directory prefix, and build the resulting
3281 filename. If the dirname realpath already contains an ending
3282 directory separator, avoid doubling it. */
3283 real_path = gdb_realpath (dir_name);
3284 if (IS_DIR_SEPARATOR (real_path[strlen (real_path) - 1]))
3285 result = concat (real_path, base_name, (char *)NULL);
3287 result = concat (real_path, SLASH_STRING, base_name, (char *)NULL);
3294 /* This is the 32-bit CRC function used by the GNU separate debug
3295 facility. An executable may contain a section named
3296 .gnu_debuglink, which holds the name of a separate executable file
3297 containing its debug info, and a checksum of that file's contents,
3298 computed using this function. */
3300 gnu_debuglink_crc32 (unsigned long crc, unsigned char *buf, size_t len)
3302 static const unsigned long crc32_table[256] = {
3303 0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419,
3304 0x706af48f, 0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4,
3305 0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07,
3306 0x90bf1d91, 0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de,
3307 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7, 0x136c9856,
3308 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
3309 0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4,
3310 0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b,
3311 0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3,
3312 0x45df5c75, 0xdcd60dcf, 0xabd13d59, 0x26d930ac, 0x51de003a,
3313 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599,
3314 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
3315 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190,
3316 0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f,
3317 0x9fbfe4a5, 0xe8b8d433, 0x7807c9a2, 0x0f00f934, 0x9609a88e,
3318 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01,
3319 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed,
3320 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
3321 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3,
3322 0xfbd44c65, 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2,
3323 0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a,
3324 0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5,
3325 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa, 0xbe0b1010,
3326 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
3327 0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17,
3328 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6,
3329 0x03b6e20c, 0x74b1d29a, 0xead54739, 0x9dd277af, 0x04db2615,
3330 0x73dc1683, 0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8,
3331 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1, 0xf00f9344,
3332 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
3333 0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a,
3334 0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5,
3335 0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1,
3336 0xa6bc5767, 0x3fb506dd, 0x48b2364b, 0xd80d2bda, 0xaf0a1b4c,
3337 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef,
3338 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
3339 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe,
3340 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31,
3341 0x2cd99e8b, 0x5bdeae1d, 0x9b64c2b0, 0xec63f226, 0x756aa39c,
3342 0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713,
3343 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 0x92d28e9b,
3344 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
3345 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1,
3346 0x18b74777, 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c,
3347 0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45, 0xa00ae278,
3348 0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7,
3349 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc, 0x40df0b66,
3350 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
3351 0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605,
3352 0xcdd70693, 0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8,
3353 0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b,
3358 crc = ~crc & 0xffffffff;
3359 for (end = buf + len; buf < end; ++buf)
3360 crc = crc32_table[(crc ^ *buf) & 0xff] ^ (crc >> 8);
3361 return ~crc & 0xffffffff;;
3365 align_up (ULONGEST v, int n)
3367 /* Check that N is really a power of two. */
3368 gdb_assert (n && (n & (n-1)) == 0);
3369 return (v + n - 1) & -n;
3373 align_down (ULONGEST v, int n)
3375 /* Check that N is really a power of two. */
3376 gdb_assert (n && (n & (n-1)) == 0);
3380 /* Allocation function for the libiberty hash table which uses an
3381 obstack. The obstack is passed as DATA. */
3384 hashtab_obstack_allocate (void *data, size_t size, size_t count)
3386 unsigned int total = size * count;
3387 void *ptr = obstack_alloc ((struct obstack *) data, total);
3388 memset (ptr, 0, total);
3392 /* Trivial deallocation function for the libiberty splay tree and hash
3393 table - don't deallocate anything. Rely on later deletion of the
3394 obstack. DATA will be the obstack, although it is not needed
3398 dummy_obstack_deallocate (void *object, void *data)
3403 /* The bit offset of the highest byte in a ULONGEST, for overflow
3406 #define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT)
3408 /* True (non-zero) iff DIGIT is a valid digit in radix BASE,
3409 where 2 <= BASE <= 36. */
3412 is_digit_in_base (unsigned char digit, int base)
3414 if (!isalnum (digit))
3417 return (isdigit (digit) && digit < base + '0');
3419 return (isdigit (digit) || tolower (digit) < base - 10 + 'a');
3423 digit_to_int (unsigned char c)
3428 return tolower (c) - 'a' + 10;
3431 /* As for strtoul, but for ULONGEST results. */
3434 strtoulst (const char *num, const char **trailer, int base)
3436 unsigned int high_part;
3441 /* Skip leading whitespace. */
3442 while (isspace (num[i]))
3445 /* Handle prefixes. */
3448 else if (num[i] == '-')
3454 if (base == 0 || base == 16)
3456 if (num[i] == '0' && (num[i + 1] == 'x' || num[i + 1] == 'X'))
3464 if (base == 0 && num[i] == '0')
3470 if (base < 2 || base > 36)
3476 result = high_part = 0;
3477 for (; is_digit_in_base (num[i], base); i += 1)
3479 result = result * base + digit_to_int (num[i]);
3480 high_part = high_part * base + (unsigned int) (result >> HIGH_BYTE_POSN);
3481 result &= ((ULONGEST) 1 << HIGH_BYTE_POSN) - 1;
3482 if (high_part > 0xff)
3485 result = ~ (ULONGEST) 0;
3492 if (trailer != NULL)
3495 result = result + ((ULONGEST) high_part << HIGH_BYTE_POSN);
3502 /* Simple, portable version of dirname that does not modify its
3506 ldirname (const char *filename)
3508 const char *base = lbasename (filename);
3511 while (base > filename && IS_DIR_SEPARATOR (base[-1]))
3514 if (base == filename)
3517 dirname = xmalloc (base - filename + 2);
3518 memcpy (dirname, filename, base - filename);
3520 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3521 create "d:./bar" later instead of the (different) "d:/bar". */
3522 if (base - filename == 2 && IS_ABSOLUTE_PATH (base)
3523 && !IS_DIR_SEPARATOR (filename[0]))
3524 dirname[base++ - filename] = '.';
3526 dirname[base - filename] = '\0';
3530 /* Call libiberty's buildargv, and return the result.
3531 If buildargv fails due to out-of-memory, call nomem.
3532 Therefore, the returned value is guaranteed to be non-NULL,
3533 unless the parameter itself is NULL. */
3536 gdb_buildargv (const char *s)
3538 char **argv = buildargv (s);
3539 if (s != NULL && argv == NULL)
3544 /* Provide a prototype to silence -Wmissing-prototypes. */
3545 extern initialize_file_ftype _initialize_utils;
3548 _initialize_utils (void)
3550 add_internal_problem_command (&internal_error_problem);
3551 add_internal_problem_command (&internal_warning_problem);