1 /* General utility routines for GDB, the GNU debugger.
2 Copyright 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
3 1996, 1997, 1998, 1999, 2000, 2001, 2002
4 Free Software Foundation, Inc.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
23 /* FIXME: cagney/2002-02-28: The GDB coding standard indicates that
24 "defs.h" should be included first. Unfortunatly some systems
25 (currently Debian GNU/Linux) include the <stdbool.h> via <curses.h>
26 and they clash with "bfd.h"'s definiton of true/false. The correct
27 fix is to remove true/false from "bfd.h", however, until that
28 happens, hack around it by including "config.h" and <curses.h>
41 #include "gdb_assert.h"
43 #include "gdb_string.h"
44 #include "event-top.h"
50 /* SunOS's curses.h has a '#define reg register' in it. Thank you Sun. */
61 #include "expression.h"
65 #include "filenames.h"
67 #include "inferior.h" /* for signed_pointer_to_address */
69 #include <sys/param.h> /* For MAXPATHLEN */
71 #include <readline/readline.h>
77 #ifdef NEED_DECLARATION_MALLOC
80 #ifdef NEED_DECLARATION_REALLOC
81 extern PTR
realloc ();
83 #ifdef NEED_DECLARATION_FREE
86 /* Actually, we'll never have the decl, since we don't define _GNU_SOURCE. */
87 #if defined(HAVE_CANONICALIZE_FILE_NAME) \
88 && defined(NEED_DECLARATION_CANONICALIZE_FILE_NAME)
89 extern char *canonicalize_file_name (const char *);
92 /* readline defines this. */
95 void (*error_begin_hook
) (void);
97 /* Holds the last error message issued by gdb */
99 static struct ui_file
*gdb_lasterr
;
101 /* Prototypes for local functions */
103 static void vfprintf_maybe_filtered (struct ui_file
*, const char *,
106 static void fputs_maybe_filtered (const char *, struct ui_file
*, int);
108 #if defined (USE_MMALLOC) && !defined (NO_MMCHECK)
109 static void malloc_botch (void);
112 static void prompt_for_continue (void);
114 static void set_width_command (char *, int, struct cmd_list_element
*);
116 static void set_width (void);
118 /* Chain of cleanup actions established with make_cleanup,
119 to be executed if an error happens. */
121 static struct cleanup
*cleanup_chain
; /* cleaned up after a failed command */
122 static struct cleanup
*final_cleanup_chain
; /* cleaned up when gdb exits */
123 static struct cleanup
*run_cleanup_chain
; /* cleaned up on each 'run' */
124 static struct cleanup
*exec_cleanup_chain
; /* cleaned up on each execution command */
125 /* cleaned up on each error from within an execution command */
126 static struct cleanup
*exec_error_cleanup_chain
;
128 /* Pointer to what is left to do for an execution command after the
129 target stops. Used only in asynchronous mode, by targets that
130 support async execution. The finish and until commands use it. So
131 does the target extended-remote command. */
132 struct continuation
*cmd_continuation
;
133 struct continuation
*intermediate_continuation
;
135 /* Nonzero if we have job control. */
139 /* Nonzero means a quit has been requested. */
143 /* Nonzero means quit immediately if Control-C is typed now, rather
144 than waiting until QUIT is executed. Be careful in setting this;
145 code which executes with immediate_quit set has to be very careful
146 about being able to deal with being interrupted at any time. It is
147 almost always better to use QUIT; the only exception I can think of
148 is being able to quit out of a system call (using EINTR loses if
149 the SIGINT happens between the previous QUIT and the system call).
150 To immediately quit in the case in which a SIGINT happens between
151 the previous QUIT and setting immediate_quit (desirable anytime we
152 expect to block), call QUIT after setting immediate_quit. */
156 /* Nonzero means that encoded C++/ObjC names should be printed out in their
157 C++/ObjC form rather than raw. */
161 /* Nonzero means that encoded C++/ObjC names should be printed out in their
162 C++/ObjC form even in assembler language displays. If this is set, but
163 DEMANGLE is zero, names are printed raw, i.e. DEMANGLE controls. */
165 int asm_demangle
= 0;
167 /* Nonzero means that strings with character values >0x7F should be printed
168 as octal escapes. Zero means just print the value (e.g. it's an
169 international character, and the terminal or window can cope.) */
171 int sevenbit_strings
= 0;
173 /* 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;
188 /* Add a new cleanup to the cleanup_chain,
189 and return the previous chain pointer
190 to be passed later to do_cleanups or discard_cleanups.
191 Args are FUNCTION to clean up with, and ARG to pass to it. */
194 make_cleanup (make_cleanup_ftype
*function
, void *arg
)
196 return make_my_cleanup (&cleanup_chain
, function
, arg
);
200 make_final_cleanup (make_cleanup_ftype
*function
, void *arg
)
202 return make_my_cleanup (&final_cleanup_chain
, function
, arg
);
206 make_run_cleanup (make_cleanup_ftype
*function
, void *arg
)
208 return make_my_cleanup (&run_cleanup_chain
, function
, arg
);
212 make_exec_cleanup (make_cleanup_ftype
*function
, void *arg
)
214 return make_my_cleanup (&exec_cleanup_chain
, function
, arg
);
218 make_exec_error_cleanup (make_cleanup_ftype
*function
, void *arg
)
220 return make_my_cleanup (&exec_error_cleanup_chain
, function
, arg
);
224 do_freeargv (void *arg
)
226 freeargv ((char **) arg
);
230 make_cleanup_freeargv (char **arg
)
232 return make_my_cleanup (&cleanup_chain
, do_freeargv
, arg
);
236 do_bfd_close_cleanup (void *arg
)
242 make_cleanup_bfd_close (bfd
*abfd
)
244 return make_cleanup (do_bfd_close_cleanup
, abfd
);
248 do_close_cleanup (void *arg
)
256 make_cleanup_close (int fd
)
258 int *saved_fd
= xmalloc (sizeof (fd
));
260 return make_cleanup (do_close_cleanup
, saved_fd
);
264 do_ui_file_delete (void *arg
)
266 ui_file_delete (arg
);
270 make_cleanup_ui_file_delete (struct ui_file
*arg
)
272 return make_my_cleanup (&cleanup_chain
, do_ui_file_delete
, arg
);
276 make_my_cleanup (struct cleanup
**pmy_chain
, make_cleanup_ftype
*function
,
279 register struct cleanup
*new
280 = (struct cleanup
*) xmalloc (sizeof (struct cleanup
));
281 register struct cleanup
*old_chain
= *pmy_chain
;
283 new->next
= *pmy_chain
;
284 new->function
= function
;
291 /* Discard cleanups and do the actions they describe
292 until we get back to the point OLD_CHAIN in the cleanup_chain. */
295 do_cleanups (register struct cleanup
*old_chain
)
297 do_my_cleanups (&cleanup_chain
, old_chain
);
301 do_final_cleanups (register struct cleanup
*old_chain
)
303 do_my_cleanups (&final_cleanup_chain
, old_chain
);
307 do_run_cleanups (register struct cleanup
*old_chain
)
309 do_my_cleanups (&run_cleanup_chain
, old_chain
);
313 do_exec_cleanups (register struct cleanup
*old_chain
)
315 do_my_cleanups (&exec_cleanup_chain
, old_chain
);
319 do_exec_error_cleanups (register struct cleanup
*old_chain
)
321 do_my_cleanups (&exec_error_cleanup_chain
, old_chain
);
325 do_my_cleanups (register struct cleanup
**pmy_chain
,
326 register struct cleanup
*old_chain
)
328 register struct cleanup
*ptr
;
329 while ((ptr
= *pmy_chain
) != old_chain
)
331 *pmy_chain
= ptr
->next
; /* Do this first incase recursion */
332 (*ptr
->function
) (ptr
->arg
);
337 /* Discard cleanups, not doing the actions they describe,
338 until we get back to the point OLD_CHAIN in the cleanup_chain. */
341 discard_cleanups (register struct cleanup
*old_chain
)
343 discard_my_cleanups (&cleanup_chain
, old_chain
);
347 discard_final_cleanups (register struct cleanup
*old_chain
)
349 discard_my_cleanups (&final_cleanup_chain
, old_chain
);
353 discard_exec_error_cleanups (register struct cleanup
*old_chain
)
355 discard_my_cleanups (&exec_error_cleanup_chain
, old_chain
);
359 discard_my_cleanups (register struct cleanup
**pmy_chain
,
360 register struct cleanup
*old_chain
)
362 register struct cleanup
*ptr
;
363 while ((ptr
= *pmy_chain
) != old_chain
)
365 *pmy_chain
= ptr
->next
;
370 /* Set the cleanup_chain to 0, and return the old cleanup chain. */
374 return save_my_cleanups (&cleanup_chain
);
378 save_final_cleanups (void)
380 return save_my_cleanups (&final_cleanup_chain
);
384 save_my_cleanups (struct cleanup
**pmy_chain
)
386 struct cleanup
*old_chain
= *pmy_chain
;
392 /* Restore the cleanup chain from a previously saved chain. */
394 restore_cleanups (struct cleanup
*chain
)
396 restore_my_cleanups (&cleanup_chain
, chain
);
400 restore_final_cleanups (struct cleanup
*chain
)
402 restore_my_cleanups (&final_cleanup_chain
, chain
);
406 restore_my_cleanups (struct cleanup
**pmy_chain
, struct cleanup
*chain
)
411 /* This function is useful for cleanups.
415 old_chain = make_cleanup (free_current_contents, &foo);
417 to arrange to free the object thus allocated. */
420 free_current_contents (void *ptr
)
422 void **location
= ptr
;
423 if (location
== NULL
)
424 internal_error (__FILE__
, __LINE__
,
425 "free_current_contents: NULL pointer");
426 if (*location
!= NULL
)
433 /* Provide a known function that does nothing, to use as a base for
434 for a possibly long chain of cleanups. This is useful where we
435 use the cleanup chain for handling normal cleanups as well as dealing
436 with cleanups that need to be done as a result of a call to error().
437 In such cases, we may not be certain where the first cleanup is, unless
438 we have a do-nothing one to always use as the base. */
442 null_cleanup (void *arg
)
446 /* Add a continuation to the continuation list, the global list
447 cmd_continuation. The new continuation will be added at the front.*/
449 add_continuation (void (*continuation_hook
) (struct continuation_arg
*),
450 struct continuation_arg
*arg_list
)
452 struct continuation
*continuation_ptr
;
454 continuation_ptr
= (struct continuation
*) xmalloc (sizeof (struct continuation
));
455 continuation_ptr
->continuation_hook
= continuation_hook
;
456 continuation_ptr
->arg_list
= arg_list
;
457 continuation_ptr
->next
= cmd_continuation
;
458 cmd_continuation
= continuation_ptr
;
461 /* Walk down the cmd_continuation list, and execute all the
462 continuations. There is a problem though. In some cases new
463 continuations may be added while we are in the middle of this
464 loop. If this happens they will be added in the front, and done
465 before we have a chance of exhausting those that were already
466 there. We need to then save the beginning of the list in a pointer
467 and do the continuations from there on, instead of using the
468 global beginning of list as our iteration pointer.*/
470 do_all_continuations (void)
472 struct continuation
*continuation_ptr
;
473 struct continuation
*saved_continuation
;
475 /* Copy the list header into another pointer, and set the global
476 list header to null, so that the global list can change as a side
477 effect of invoking the continuations and the processing of
478 the preexisting continuations will not be affected. */
479 continuation_ptr
= cmd_continuation
;
480 cmd_continuation
= NULL
;
482 /* Work now on the list we have set aside. */
483 while (continuation_ptr
)
485 (continuation_ptr
->continuation_hook
) (continuation_ptr
->arg_list
);
486 saved_continuation
= continuation_ptr
;
487 continuation_ptr
= continuation_ptr
->next
;
488 xfree (saved_continuation
);
492 /* Walk down the cmd_continuation list, and get rid of all the
495 discard_all_continuations (void)
497 struct continuation
*continuation_ptr
;
499 while (cmd_continuation
)
501 continuation_ptr
= cmd_continuation
;
502 cmd_continuation
= continuation_ptr
->next
;
503 xfree (continuation_ptr
);
507 /* Add a continuation to the continuation list, the global list
508 intermediate_continuation. The new continuation will be added at the front.*/
510 add_intermediate_continuation (void (*continuation_hook
)
511 (struct continuation_arg
*),
512 struct continuation_arg
*arg_list
)
514 struct continuation
*continuation_ptr
;
516 continuation_ptr
= (struct continuation
*) xmalloc (sizeof (struct continuation
));
517 continuation_ptr
->continuation_hook
= continuation_hook
;
518 continuation_ptr
->arg_list
= arg_list
;
519 continuation_ptr
->next
= intermediate_continuation
;
520 intermediate_continuation
= continuation_ptr
;
523 /* Walk down the cmd_continuation list, and execute all the
524 continuations. There is a problem though. In some cases new
525 continuations may be added while we are in the middle of this
526 loop. If this happens they will be added in the front, and done
527 before we have a chance of exhausting those that were already
528 there. We need to then save the beginning of the list in a pointer
529 and do the continuations from there on, instead of using the
530 global beginning of list as our iteration pointer.*/
532 do_all_intermediate_continuations (void)
534 struct continuation
*continuation_ptr
;
535 struct continuation
*saved_continuation
;
537 /* Copy the list header into another pointer, and set the global
538 list header to null, so that the global list can change as a side
539 effect of invoking the continuations and the processing of
540 the preexisting continuations will not be affected. */
541 continuation_ptr
= intermediate_continuation
;
542 intermediate_continuation
= NULL
;
544 /* Work now on the list we have set aside. */
545 while (continuation_ptr
)
547 (continuation_ptr
->continuation_hook
) (continuation_ptr
->arg_list
);
548 saved_continuation
= continuation_ptr
;
549 continuation_ptr
= continuation_ptr
->next
;
550 xfree (saved_continuation
);
554 /* Walk down the cmd_continuation list, and get rid of all the
557 discard_all_intermediate_continuations (void)
559 struct continuation
*continuation_ptr
;
561 while (intermediate_continuation
)
563 continuation_ptr
= intermediate_continuation
;
564 intermediate_continuation
= continuation_ptr
->next
;
565 xfree (continuation_ptr
);
571 /* Print a warning message. The first argument STRING is the warning
572 message, used as an fprintf format string, the second is the
573 va_list of arguments for that string. A warning is unfiltered (not
574 paginated) so that the user does not need to page through each
575 screen full of warnings when there are lots of them. */
578 vwarning (const char *string
, va_list args
)
581 (*warning_hook
) (string
, args
);
584 target_terminal_ours ();
585 wrap_here (""); /* Force out any buffered output */
586 gdb_flush (gdb_stdout
);
587 if (warning_pre_print
)
588 fprintf_unfiltered (gdb_stderr
, warning_pre_print
);
589 vfprintf_unfiltered (gdb_stderr
, string
, args
);
590 fprintf_unfiltered (gdb_stderr
, "\n");
595 /* Print a warning message.
596 The first argument STRING is the warning message, used as a fprintf string,
597 and the remaining args are passed as arguments to it.
598 The primary difference between warnings and errors is that a warning
599 does not force the return to command level. */
602 warning (const char *string
,...)
605 va_start (args
, string
);
606 vwarning (string
, args
);
610 /* Print an error message and return to command level.
611 The first argument STRING is the error message, used as a fprintf string,
612 and the remaining args are passed as arguments to it. */
615 verror (const char *string
, va_list args
)
617 struct ui_file
*tmp_stream
= mem_fileopen ();
618 make_cleanup_ui_file_delete (tmp_stream
);
619 vfprintf_unfiltered (tmp_stream
, string
, args
);
620 error_stream (tmp_stream
);
624 error (const char *string
,...)
627 va_start (args
, string
);
628 verror (string
, args
);
633 do_write (void *data
, const char *buffer
, long length_buffer
)
635 ui_file_write (data
, buffer
, length_buffer
);
639 error_stream (struct ui_file
*stream
)
641 if (error_begin_hook
)
644 /* Copy the stream into the GDB_LASTERR buffer. */
645 ui_file_rewind (gdb_lasterr
);
646 ui_file_put (stream
, do_write
, gdb_lasterr
);
648 /* Write the message plus any error_pre_print to gdb_stderr. */
649 target_terminal_ours ();
650 wrap_here (""); /* Force out any buffered output */
651 gdb_flush (gdb_stdout
);
652 annotate_error_begin ();
654 fprintf_filtered (gdb_stderr
, error_pre_print
);
655 ui_file_put (stream
, do_write
, gdb_stderr
);
656 fprintf_filtered (gdb_stderr
, "\n");
658 throw_exception (RETURN_ERROR
);
661 /* Get the last error message issued by gdb */
664 error_last_message (void)
667 return ui_file_xstrdup (gdb_lasterr
, &len
);
670 /* This is to be called by main() at the very beginning */
675 gdb_lasterr
= mem_fileopen ();
678 /* Print a message reporting an internal error/warning. Ask the user
679 if they want to continue, dump core, or just exit. Return
680 something to indicate a quit. */
682 struct internal_problem
685 /* FIXME: cagney/2002-08-15: There should be ``maint set/show''
686 commands available for controlling these variables. */
687 enum auto_boolean should_quit
;
688 enum auto_boolean should_dump_core
;
691 /* Report a problem, internal to GDB, to the user. Once the problem
692 has been reported, and assuming GDB didn't quit, the caller can
693 either allow execution to resume or throw an error. */
696 internal_vproblem (struct internal_problem
*problem
,
697 const char *file
, int line
,
698 const char *fmt
, va_list ap
)
700 static char msg
[] = "Recursive internal problem.\n";
705 /* Don't allow infinite error/warning recursion. */
713 fputs_unfiltered (msg
, gdb_stderr
);
714 abort (); /* NOTE: GDB has only three calls to abort(). */
717 write (STDERR_FILENO
, msg
, sizeof (msg
));
721 /* Try to get the message out and at the start of a new line. */
722 target_terminal_ours ();
725 /* The error/warning message. Format using a style similar to a
726 compiler error message. */
727 fprintf_unfiltered (gdb_stderr
, "%s:%d: %s: ", file
, line
, problem
->name
);
728 vfprintf_unfiltered (gdb_stderr
, fmt
, ap
);
729 fputs_unfiltered ("\n", gdb_stderr
);
731 /* Provide more details so that the user knows that they are living
733 fprintf_unfiltered (gdb_stderr
, "\
734 A problem internal to GDB has been detected. Further\n\
735 debugging may prove unreliable.\n");
737 switch (problem
->should_quit
)
739 case AUTO_BOOLEAN_AUTO
:
740 /* Default (yes/batch case) is to quit GDB. When in batch mode
741 this lessens the likelhood of GDB going into an infinate
743 quit_p
= query ("Quit this debugging session? ");
745 case AUTO_BOOLEAN_TRUE
:
748 case AUTO_BOOLEAN_FALSE
:
752 internal_error (__FILE__
, __LINE__
, "bad switch");
755 switch (problem
->should_dump_core
)
757 case AUTO_BOOLEAN_AUTO
:
758 /* Default (yes/batch case) is to dump core. This leaves a GDB
759 `dropping' so that it is easier to see that something went
761 dump_core_p
= query ("Create a core file of GDB? ");
764 case AUTO_BOOLEAN_TRUE
:
767 case AUTO_BOOLEAN_FALSE
:
771 internal_error (__FILE__
, __LINE__
, "bad switch");
777 abort (); /* NOTE: GDB has only three calls to abort(). */
786 abort (); /* NOTE: GDB has only three calls to abort(). */
793 static struct internal_problem internal_error_problem
= {
794 "internal-error", AUTO_BOOLEAN_AUTO
, AUTO_BOOLEAN_AUTO
798 internal_verror (const char *file
, int line
,
799 const char *fmt
, va_list ap
)
801 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
802 throw_exception (RETURN_ERROR
);
806 internal_error (const char *file
, int line
, const char *string
, ...)
809 va_start (ap
, string
);
810 internal_verror (file
, line
, string
, ap
);
814 static struct internal_problem internal_warning_problem
= {
815 "internal-error", AUTO_BOOLEAN_AUTO
, AUTO_BOOLEAN_AUTO
819 internal_vwarning (const char *file
, int line
,
820 const char *fmt
, va_list ap
)
822 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
826 internal_warning (const char *file
, int line
, const char *string
, ...)
829 va_start (ap
, string
);
830 internal_vwarning (file
, line
, string
, ap
);
834 /* The strerror() function can return NULL for errno values that are
835 out of range. Provide a "safe" version that always returns a
839 safe_strerror (int errnum
)
844 if ((msg
= strerror (errnum
)) == NULL
)
846 sprintf (buf
, "(undocumented errno %d)", errnum
);
852 /* Print the system error message for errno, and also mention STRING
853 as the file name for which the error was encountered.
854 Then return to command level. */
857 perror_with_name (const char *string
)
862 err
= safe_strerror (errno
);
863 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
864 strcpy (combined
, string
);
865 strcat (combined
, ": ");
866 strcat (combined
, err
);
868 /* I understand setting these is a matter of taste. Still, some people
869 may clear errno but not know about bfd_error. Doing this here is not
871 bfd_set_error (bfd_error_no_error
);
874 error ("%s.", combined
);
877 /* Print the system error message for ERRCODE, and also mention STRING
878 as the file name for which the error was encountered. */
881 print_sys_errmsg (const char *string
, int errcode
)
886 err
= safe_strerror (errcode
);
887 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
888 strcpy (combined
, string
);
889 strcat (combined
, ": ");
890 strcat (combined
, err
);
892 /* We want anything which was printed on stdout to come out first, before
894 gdb_flush (gdb_stdout
);
895 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
898 /* Control C eventually causes this to be called, at a convenient time. */
903 struct serial
*gdb_stdout_serial
= serial_fdopen (1);
905 target_terminal_ours ();
907 /* We want all output to appear now, before we print "Quit". We
908 have 3 levels of buffering we have to flush (it's possible that
909 some of these should be changed to flush the lower-level ones
912 /* 1. The _filtered buffer. */
913 wrap_here ((char *) 0);
915 /* 2. The stdio buffer. */
916 gdb_flush (gdb_stdout
);
917 gdb_flush (gdb_stderr
);
919 /* 3. The system-level buffer. */
920 serial_drain_output (gdb_stdout_serial
);
921 serial_un_fdopen (gdb_stdout_serial
);
923 annotate_error_begin ();
925 /* Don't use *_filtered; we don't want to prompt the user to continue. */
927 fprintf_unfiltered (gdb_stderr
, quit_pre_print
);
930 /* No steenking SIGINT will ever be coming our way when the
931 program is resumed. Don't lie. */
932 fprintf_unfiltered (gdb_stderr
, "Quit\n");
935 /* If there is no terminal switching for this target, then we can't
936 possibly get screwed by the lack of job control. */
937 || current_target
.to_terminal_ours
== NULL
)
938 fprintf_unfiltered (gdb_stderr
, "Quit\n");
940 fprintf_unfiltered (gdb_stderr
,
941 "Quit (expect signal SIGINT when the program is resumed)\n");
943 throw_exception (RETURN_QUIT
);
946 /* Control C comes here */
948 request_quit (int signo
)
951 /* Restore the signal handler. Harmless with BSD-style signals, needed
952 for System V-style signals. So just always do it, rather than worrying
953 about USG defines and stuff like that. */
954 signal (signo
, request_quit
);
964 /* Memory management stuff (malloc friends). */
966 #if !defined (USE_MMALLOC)
968 /* NOTE: These must use PTR so that their definition matches the
969 declaration found in "mmalloc.h". */
972 mmalloc (void *md
, size_t size
)
974 return malloc (size
); /* NOTE: GDB's only call to malloc() */
978 mrealloc (void *md
, void *ptr
, size_t size
)
980 if (ptr
== 0) /* Guard against old realloc's */
981 return mmalloc (md
, size
);
983 return realloc (ptr
, size
); /* NOTE: GDB's only call to ralloc() */
987 mcalloc (void *md
, size_t number
, size_t size
)
989 return calloc (number
, size
); /* NOTE: GDB's only call to calloc() */
993 mfree (void *md
, void *ptr
)
995 free (ptr
); /* NOTE: GDB's only call to free() */
998 #endif /* USE_MMALLOC */
1000 #if !defined (USE_MMALLOC) || defined (NO_MMCHECK)
1003 init_malloc (void *md
)
1007 #else /* Have mmalloc and want corruption checking */
1012 fprintf_unfiltered (gdb_stderr
, "Memory corruption\n");
1013 internal_error (__FILE__
, __LINE__
, "failed internal consistency check");
1016 /* Attempt to install hooks in mmalloc/mrealloc/mfree for the heap specified
1017 by MD, to detect memory corruption. Note that MD may be NULL to specify
1018 the default heap that grows via sbrk.
1020 Note that for freshly created regions, we must call mmcheckf prior to any
1021 mallocs in the region. Otherwise, any region which was allocated prior to
1022 installing the checking hooks, which is later reallocated or freed, will
1023 fail the checks! The mmcheck function only allows initial hooks to be
1024 installed before the first mmalloc. However, anytime after we have called
1025 mmcheck the first time to install the checking hooks, we can call it again
1026 to update the function pointer to the memory corruption handler.
1028 Returns zero on failure, non-zero on success. */
1030 #ifndef MMCHECK_FORCE
1031 #define MMCHECK_FORCE 0
1035 init_malloc (void *md
)
1037 if (!mmcheckf (md
, malloc_botch
, MMCHECK_FORCE
))
1039 /* Don't use warning(), which relies on current_target being set
1040 to something other than dummy_target, until after
1041 initialize_all_files(). */
1044 (gdb_stderr
, "warning: failed to install memory consistency checks; ");
1046 (gdb_stderr
, "configuration should define NO_MMCHECK or MMCHECK_FORCE\n");
1052 #endif /* Have mmalloc and want corruption checking */
1054 /* Called when a memory allocation fails, with the number of bytes of
1055 memory requested in SIZE. */
1062 internal_error (__FILE__
, __LINE__
,
1063 "virtual memory exhausted: can't allocate %ld bytes.", size
);
1067 internal_error (__FILE__
, __LINE__
,
1068 "virtual memory exhausted.");
1072 /* The xmmalloc() family of memory management routines.
1074 These are are like the mmalloc() family except that they implement
1075 consistent semantics and guard against typical memory management
1076 problems: if a malloc fails, an internal error is thrown; if
1077 free(NULL) is called, it is ignored; if *alloc(0) is called, NULL
1080 All these routines are implemented using the mmalloc() family. */
1083 xmmalloc (void *md
, size_t size
)
1093 val
= mmalloc (md
, size
);
1101 xmrealloc (void *md
, void *ptr
, size_t size
)
1115 val
= mrealloc (md
, ptr
, size
);
1119 val
= mmalloc (md
, size
);
1130 xmcalloc (void *md
, size_t number
, size_t size
)
1133 if (number
== 0 || size
== 0)
1137 mem
= mcalloc (md
, number
, size
);
1139 nomem (number
* size
);
1145 xmfree (void *md
, void *ptr
)
1151 /* The xmalloc() (libiberty.h) family of memory management routines.
1153 These are like the ISO-C malloc() family except that they implement
1154 consistent semantics and guard against typical memory management
1155 problems. See xmmalloc() above for further information.
1157 All these routines are wrappers to the xmmalloc() family. */
1159 /* NOTE: These are declared using PTR to ensure consistency with
1160 "libiberty.h". xfree() is GDB local. */
1163 xmalloc (size_t size
)
1165 return xmmalloc (NULL
, size
);
1169 xrealloc (PTR ptr
, size_t size
)
1171 return xmrealloc (NULL
, ptr
, size
);
1175 xcalloc (size_t number
, size_t size
)
1177 return xmcalloc (NULL
, number
, size
);
1187 /* Like asprintf/vasprintf but get an internal_error if the call
1191 xasprintf (char **ret
, const char *format
, ...)
1194 va_start (args
, format
);
1195 xvasprintf (ret
, format
, args
);
1200 xvasprintf (char **ret
, const char *format
, va_list ap
)
1202 int status
= vasprintf (ret
, format
, ap
);
1203 /* NULL could be returned due to a memory allocation problem; a
1204 badly format string; or something else. */
1206 internal_error (__FILE__
, __LINE__
,
1207 "vasprintf returned NULL buffer (errno %d)",
1209 /* A negative status with a non-NULL buffer shouldn't never
1210 happen. But to be sure. */
1212 internal_error (__FILE__
, __LINE__
,
1213 "vasprintf call failed (errno %d)",
1218 /* My replacement for the read system call.
1219 Used like `read' but keeps going if `read' returns too soon. */
1222 myread (int desc
, char *addr
, int len
)
1229 val
= read (desc
, addr
, len
);
1233 return orglen
- len
;
1240 /* Make a copy of the string at PTR with SIZE characters
1241 (and add a null character at the end in the copy).
1242 Uses malloc to get the space. Returns the address of the copy. */
1245 savestring (const char *ptr
, size_t size
)
1247 register char *p
= (char *) xmalloc (size
+ 1);
1248 memcpy (p
, ptr
, size
);
1254 msavestring (void *md
, const char *ptr
, size_t size
)
1256 register char *p
= (char *) xmmalloc (md
, size
+ 1);
1257 memcpy (p
, ptr
, size
);
1263 mstrsave (void *md
, const char *ptr
)
1265 return (msavestring (md
, ptr
, strlen (ptr
)));
1269 print_spaces (register int n
, register struct ui_file
*file
)
1271 fputs_unfiltered (n_spaces (n
), file
);
1274 /* Print a host address. */
1277 gdb_print_host_address (void *addr
, struct ui_file
*stream
)
1280 /* We could use the %p conversion specifier to fprintf if we had any
1281 way of knowing whether this host supports it. But the following
1282 should work on the Alpha and on 32 bit machines. */
1284 fprintf_filtered (stream
, "0x%lx", (unsigned long) addr
);
1287 /* Ask user a y-or-n question and return 1 iff answer is yes.
1288 Takes three args which are given to printf to print the question.
1289 The first, a control string, should end in "? ".
1290 It should not say how to answer, because we do that. */
1294 query (const char *ctlstr
,...)
1297 register int answer
;
1301 va_start (args
, ctlstr
);
1305 return query_hook (ctlstr
, args
);
1308 /* Automatically answer "yes" if input is not from a terminal. */
1309 if (!input_from_terminal_p ())
1314 wrap_here (""); /* Flush any buffered output */
1315 gdb_flush (gdb_stdout
);
1317 if (annotation_level
> 1)
1318 printf_filtered ("\n\032\032pre-query\n");
1320 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
1321 printf_filtered ("(y or n) ");
1323 if (annotation_level
> 1)
1324 printf_filtered ("\n\032\032query\n");
1327 gdb_flush (gdb_stdout
);
1329 answer
= fgetc (stdin
);
1330 clearerr (stdin
); /* in case of C-d */
1331 if (answer
== EOF
) /* C-d */
1336 /* Eat rest of input line, to EOF or newline */
1340 ans2
= fgetc (stdin
);
1343 while (ans2
!= EOF
&& ans2
!= '\n' && ans2
!= '\r');
1357 printf_filtered ("Please answer y or n.\n");
1360 if (annotation_level
> 1)
1361 printf_filtered ("\n\032\032post-query\n");
1366 /* Print an error message saying that we couldn't make sense of a
1367 \^mumble sequence in a string or character constant. START and END
1368 indicate a substring of some larger string that contains the
1369 erroneous backslash sequence, missing the initial backslash. */
1371 no_control_char_error (const char *start
, const char *end
)
1373 int len
= end
- start
;
1374 char *copy
= alloca (end
- start
+ 1);
1376 memcpy (copy
, start
, len
);
1379 error ("There is no control character `\\%s' in the `%s' character set.",
1380 copy
, target_charset ());
1383 /* Parse a C escape sequence. STRING_PTR points to a variable
1384 containing a pointer to the string to parse. That pointer
1385 should point to the character after the \. That pointer
1386 is updated past the characters we use. The value of the
1387 escape sequence is returned.
1389 A negative value means the sequence \ newline was seen,
1390 which is supposed to be equivalent to nothing at all.
1392 If \ is followed by a null character, we return a negative
1393 value and leave the string pointer pointing at the null character.
1395 If \ is followed by 000, we return 0 and leave the string pointer
1396 after the zeros. A value of 0 does not mean end of string. */
1399 parse_escape (char **string_ptr
)
1402 register int c
= *(*string_ptr
)++;
1403 if (c_parse_backslash (c
, &target_char
))
1414 /* Remember where this escape sequence started, for reporting
1416 char *sequence_start_pos
= *string_ptr
- 1;
1418 c
= *(*string_ptr
)++;
1422 /* XXXCHARSET: What is `delete' in the host character set? */
1425 if (! host_char_to_target (c
, &target_char
))
1426 error ("There is no character corresponding to `Delete' "
1427 "in the target character set `%s'.",
1433 target_char
= parse_escape (string_ptr
);
1436 if (! host_char_to_target (c
, &target_char
))
1437 no_control_char_error (sequence_start_pos
, *string_ptr
);
1440 /* Now target_char is something like `c', and we want to find
1441 its control-character equivalent. */
1442 if (! target_char_to_control_char (target_char
, &target_char
))
1443 no_control_char_error (sequence_start_pos
, *string_ptr
);
1448 /* XXXCHARSET: we need to use isdigit and value-of-digit
1449 methods of the host character set here. */
1460 register int i
= c
- '0';
1461 register int count
= 0;
1464 if ((c
= *(*string_ptr
)++) >= '0' && c
<= '7')
1478 if (! host_char_to_target (c
, &target_char
))
1479 error ("The escape sequence `\%c' is equivalent to plain `%c', which"
1480 " has no equivalent\n"
1481 "in the `%s' character set.",
1482 c
, c
, target_charset ());
1487 /* Print the character C on STREAM as part of the contents of a literal
1488 string whose delimiter is QUOTER. Note that this routine should only
1489 be call for printing things which are independent of the language
1490 of the program being debugged. */
1493 printchar (int c
, void (*do_fputs
) (const char *, struct ui_file
*),
1494 void (*do_fprintf
) (struct ui_file
*, const char *, ...),
1495 struct ui_file
*stream
, int quoter
)
1498 c
&= 0xFF; /* Avoid sign bit follies */
1500 if (c
< 0x20 || /* Low control chars */
1501 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1502 (sevenbit_strings
&& c
>= 0x80))
1503 { /* high order bit set */
1507 do_fputs ("\\n", stream
);
1510 do_fputs ("\\b", stream
);
1513 do_fputs ("\\t", stream
);
1516 do_fputs ("\\f", stream
);
1519 do_fputs ("\\r", stream
);
1522 do_fputs ("\\e", stream
);
1525 do_fputs ("\\a", stream
);
1528 do_fprintf (stream
, "\\%.3o", (unsigned int) c
);
1534 if (c
== '\\' || c
== quoter
)
1535 do_fputs ("\\", stream
);
1536 do_fprintf (stream
, "%c", c
);
1540 /* Print the character C on STREAM as part of the contents of a
1541 literal string whose delimiter is QUOTER. Note that these routines
1542 should only be call for printing things which are independent of
1543 the language of the program being debugged. */
1546 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1549 printchar (*str
++, fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1553 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1556 printchar (*str
++, fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1560 fputstrn_unfiltered (const char *str
, int n
, int quoter
, struct ui_file
*stream
)
1563 for (i
= 0; i
< n
; i
++)
1564 printchar (str
[i
], fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1569 /* Number of lines per page or UINT_MAX if paging is disabled. */
1570 static unsigned int lines_per_page
;
1571 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1572 static unsigned int chars_per_line
;
1573 /* Current count of lines printed on this page, chars on this line. */
1574 static unsigned int lines_printed
, chars_printed
;
1576 /* Buffer and start column of buffered text, for doing smarter word-
1577 wrapping. When someone calls wrap_here(), we start buffering output
1578 that comes through fputs_filtered(). If we see a newline, we just
1579 spit it out and forget about the wrap_here(). If we see another
1580 wrap_here(), we spit it out and remember the newer one. If we see
1581 the end of the line, we spit out a newline, the indent, and then
1582 the buffered output. */
1584 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1585 are waiting to be output (they have already been counted in chars_printed).
1586 When wrap_buffer[0] is null, the buffer is empty. */
1587 static char *wrap_buffer
;
1589 /* Pointer in wrap_buffer to the next character to fill. */
1590 static char *wrap_pointer
;
1592 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1594 static char *wrap_indent
;
1596 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1597 is not in effect. */
1598 static int wrap_column
;
1601 /* Inialize the lines and chars per page */
1603 init_page_info (void)
1606 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1609 /* These defaults will be used if we are unable to get the correct
1610 values from termcap. */
1611 #if defined(__GO32__)
1612 lines_per_page
= ScreenRows ();
1613 chars_per_line
= ScreenCols ();
1615 lines_per_page
= 24;
1616 chars_per_line
= 80;
1618 #if !defined (_WIN32)
1619 /* No termcap under MPW, although might be cool to do something
1620 by looking at worksheet or console window sizes. */
1621 /* Initialize the screen height and width from termcap. */
1623 char *termtype
= getenv ("TERM");
1625 /* Positive means success, nonpositive means failure. */
1628 /* 2048 is large enough for all known terminals, according to the
1629 GNU termcap manual. */
1630 char term_buffer
[2048];
1634 status
= tgetent (term_buffer
, termtype
);
1638 int running_in_emacs
= getenv ("EMACS") != NULL
;
1640 val
= tgetnum ("li");
1641 if (val
>= 0 && !running_in_emacs
)
1642 lines_per_page
= val
;
1644 /* The number of lines per page is not mentioned
1645 in the terminal description. This probably means
1646 that paging is not useful (e.g. emacs shell window),
1647 so disable paging. */
1648 lines_per_page
= UINT_MAX
;
1650 val
= tgetnum ("co");
1652 chars_per_line
= val
;
1658 #if defined(SIGWINCH) && defined(SIGWINCH_HANDLER)
1660 /* If there is a better way to determine the window size, use it. */
1661 SIGWINCH_HANDLER (SIGWINCH
);
1664 /* If the output is not a terminal, don't paginate it. */
1665 if (!ui_file_isatty (gdb_stdout
))
1666 lines_per_page
= UINT_MAX
;
1667 } /* the command_line_version */
1674 if (chars_per_line
== 0)
1679 wrap_buffer
= (char *) xmalloc (chars_per_line
+ 2);
1680 wrap_buffer
[0] = '\0';
1683 wrap_buffer
= (char *) xrealloc (wrap_buffer
, chars_per_line
+ 2);
1684 wrap_pointer
= wrap_buffer
; /* Start it at the beginning */
1689 set_width_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1694 /* Wait, so the user can read what's on the screen. Prompt the user
1695 to continue by pressing RETURN. */
1698 prompt_for_continue (void)
1701 char cont_prompt
[120];
1703 if (annotation_level
> 1)
1704 printf_unfiltered ("\n\032\032pre-prompt-for-continue\n");
1706 strcpy (cont_prompt
,
1707 "---Type <return> to continue, or q <return> to quit---");
1708 if (annotation_level
> 1)
1709 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1711 /* We must do this *before* we call gdb_readline, else it will eventually
1712 call us -- thinking that we're trying to print beyond the end of the
1714 reinitialize_more_filter ();
1717 /* On a real operating system, the user can quit with SIGINT.
1720 'q' is provided on all systems so users don't have to change habits
1721 from system to system, and because telling them what to do in
1722 the prompt is more user-friendly than expecting them to think of
1724 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1725 whereas control-C to gdb_readline will cause the user to get dumped
1727 ignore
= gdb_readline_wrapper (cont_prompt
);
1729 if (annotation_level
> 1)
1730 printf_unfiltered ("\n\032\032post-prompt-for-continue\n");
1735 while (*p
== ' ' || *p
== '\t')
1740 request_quit (SIGINT
);
1742 async_request_quit (0);
1748 /* Now we have to do this again, so that GDB will know that it doesn't
1749 need to save the ---Type <return>--- line at the top of the screen. */
1750 reinitialize_more_filter ();
1752 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1755 /* Reinitialize filter; ie. tell it to reset to original values. */
1758 reinitialize_more_filter (void)
1764 /* Indicate that if the next sequence of characters overflows the line,
1765 a newline should be inserted here rather than when it hits the end.
1766 If INDENT is non-null, it is a string to be printed to indent the
1767 wrapped part on the next line. INDENT must remain accessible until
1768 the next call to wrap_here() or until a newline is printed through
1771 If the line is already overfull, we immediately print a newline and
1772 the indentation, and disable further wrapping.
1774 If we don't know the width of lines, but we know the page height,
1775 we must not wrap words, but should still keep track of newlines
1776 that were explicitly printed.
1778 INDENT should not contain tabs, as that will mess up the char count
1779 on the next line. FIXME.
1781 This routine is guaranteed to force out any output which has been
1782 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1783 used to force out output from the wrap_buffer. */
1786 wrap_here (char *indent
)
1788 /* This should have been allocated, but be paranoid anyway. */
1790 internal_error (__FILE__
, __LINE__
, "failed internal consistency check");
1794 *wrap_pointer
= '\0';
1795 fputs_unfiltered (wrap_buffer
, gdb_stdout
);
1797 wrap_pointer
= wrap_buffer
;
1798 wrap_buffer
[0] = '\0';
1799 if (chars_per_line
== UINT_MAX
) /* No line overflow checking */
1803 else if (chars_printed
>= chars_per_line
)
1805 puts_filtered ("\n");
1807 puts_filtered (indent
);
1812 wrap_column
= chars_printed
;
1816 wrap_indent
= indent
;
1820 /* Print input string to gdb_stdout, filtered, with wrap,
1821 arranging strings in columns of n chars. String can be
1822 right or left justified in the column. Never prints
1823 trailing spaces. String should never be longer than
1824 width. FIXME: this could be useful for the EXAMINE
1825 command, which currently doesn't tabulate very well */
1828 puts_filtered_tabular (char *string
, int width
, int right
)
1834 gdb_assert (chars_per_line
> 0);
1835 if (chars_per_line
== UINT_MAX
)
1837 fputs_filtered (string
, gdb_stdout
);
1838 fputs_filtered ("\n", gdb_stdout
);
1842 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1843 fputs_filtered ("\n", gdb_stdout
);
1845 if (width
>= chars_per_line
)
1846 width
= chars_per_line
- 1;
1848 stringlen
= strlen (string
);
1850 if (chars_printed
> 0)
1851 spaces
= width
- (chars_printed
- 1) % width
- 1;
1853 spaces
+= width
- stringlen
;
1855 spacebuf
= alloca (spaces
+ 1);
1856 spacebuf
[spaces
] = '\0';
1858 spacebuf
[spaces
] = ' ';
1860 fputs_filtered (spacebuf
, gdb_stdout
);
1861 fputs_filtered (string
, gdb_stdout
);
1865 /* Ensure that whatever gets printed next, using the filtered output
1866 commands, starts at the beginning of the line. I.E. if there is
1867 any pending output for the current line, flush it and start a new
1868 line. Otherwise do nothing. */
1873 if (chars_printed
> 0)
1875 puts_filtered ("\n");
1880 /* Like fputs but if FILTER is true, pause after every screenful.
1882 Regardless of FILTER can wrap at points other than the final
1883 character of a line.
1885 Unlike fputs, fputs_maybe_filtered does not return a value.
1886 It is OK for LINEBUFFER to be NULL, in which case just don't print
1889 Note that a longjmp to top level may occur in this routine (only if
1890 FILTER is true) (since prompt_for_continue may do so) so this
1891 routine should not be called when cleanups are not in place. */
1894 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1897 const char *lineptr
;
1899 if (linebuffer
== 0)
1902 /* Don't do any filtering if it is disabled. */
1903 if ((stream
!= gdb_stdout
) || !pagination_enabled
1904 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
))
1906 fputs_unfiltered (linebuffer
, stream
);
1910 /* Go through and output each character. Show line extension
1911 when this is necessary; prompt user for new page when this is
1914 lineptr
= linebuffer
;
1917 /* Possible new page. */
1919 (lines_printed
>= lines_per_page
- 1))
1920 prompt_for_continue ();
1922 while (*lineptr
&& *lineptr
!= '\n')
1924 /* Print a single line. */
1925 if (*lineptr
== '\t')
1928 *wrap_pointer
++ = '\t';
1930 fputc_unfiltered ('\t', stream
);
1931 /* Shifting right by 3 produces the number of tab stops
1932 we have already passed, and then adding one and
1933 shifting left 3 advances to the next tab stop. */
1934 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
1940 *wrap_pointer
++ = *lineptr
;
1942 fputc_unfiltered (*lineptr
, stream
);
1947 if (chars_printed
>= chars_per_line
)
1949 unsigned int save_chars
= chars_printed
;
1953 /* If we aren't actually wrapping, don't output newline --
1954 if chars_per_line is right, we probably just overflowed
1955 anyway; if it's wrong, let us keep going. */
1957 fputc_unfiltered ('\n', stream
);
1959 /* Possible new page. */
1960 if (lines_printed
>= lines_per_page
- 1)
1961 prompt_for_continue ();
1963 /* Now output indentation and wrapped string */
1966 fputs_unfiltered (wrap_indent
, stream
);
1967 *wrap_pointer
= '\0'; /* Null-terminate saved stuff */
1968 fputs_unfiltered (wrap_buffer
, stream
); /* and eject it */
1969 /* FIXME, this strlen is what prevents wrap_indent from
1970 containing tabs. However, if we recurse to print it
1971 and count its chars, we risk trouble if wrap_indent is
1972 longer than (the user settable) chars_per_line.
1973 Note also that this can set chars_printed > chars_per_line
1974 if we are printing a long string. */
1975 chars_printed
= strlen (wrap_indent
)
1976 + (save_chars
- wrap_column
);
1977 wrap_pointer
= wrap_buffer
; /* Reset buffer */
1978 wrap_buffer
[0] = '\0';
1979 wrap_column
= 0; /* And disable fancy wrap */
1984 if (*lineptr
== '\n')
1987 wrap_here ((char *) 0); /* Spit out chars, cancel further wraps */
1989 fputc_unfiltered ('\n', stream
);
1996 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
1998 fputs_maybe_filtered (linebuffer
, stream
, 1);
2002 putchar_unfiltered (int c
)
2005 ui_file_write (gdb_stdout
, &buf
, 1);
2009 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2010 May return nonlocally. */
2013 putchar_filtered (int c
)
2015 return fputc_filtered (c
, gdb_stdout
);
2019 fputc_unfiltered (int c
, struct ui_file
*stream
)
2022 ui_file_write (stream
, &buf
, 1);
2027 fputc_filtered (int c
, struct ui_file
*stream
)
2033 fputs_filtered (buf
, stream
);
2037 /* puts_debug is like fputs_unfiltered, except it prints special
2038 characters in printable fashion. */
2041 puts_debug (char *prefix
, char *string
, char *suffix
)
2045 /* Print prefix and suffix after each line. */
2046 static int new_line
= 1;
2047 static int return_p
= 0;
2048 static char *prev_prefix
= "";
2049 static char *prev_suffix
= "";
2051 if (*string
== '\n')
2054 /* If the prefix is changing, print the previous suffix, a new line,
2055 and the new prefix. */
2056 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
2058 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
2059 fputs_unfiltered ("\n", gdb_stdlog
);
2060 fputs_unfiltered (prefix
, gdb_stdlog
);
2063 /* Print prefix if we printed a newline during the previous call. */
2067 fputs_unfiltered (prefix
, gdb_stdlog
);
2070 prev_prefix
= prefix
;
2071 prev_suffix
= suffix
;
2073 /* Output characters in a printable format. */
2074 while ((ch
= *string
++) != '\0')
2080 fputc_unfiltered (ch
, gdb_stdlog
);
2083 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2087 fputs_unfiltered ("\\\\", gdb_stdlog
);
2090 fputs_unfiltered ("\\b", gdb_stdlog
);
2093 fputs_unfiltered ("\\f", gdb_stdlog
);
2097 fputs_unfiltered ("\\n", gdb_stdlog
);
2100 fputs_unfiltered ("\\r", gdb_stdlog
);
2103 fputs_unfiltered ("\\t", gdb_stdlog
);
2106 fputs_unfiltered ("\\v", gdb_stdlog
);
2110 return_p
= ch
== '\r';
2113 /* Print suffix if we printed a newline. */
2116 fputs_unfiltered (suffix
, gdb_stdlog
);
2117 fputs_unfiltered ("\n", gdb_stdlog
);
2122 /* Print a variable number of ARGS using format FORMAT. If this
2123 information is going to put the amount written (since the last call
2124 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2125 call prompt_for_continue to get the users permision to continue.
2127 Unlike fprintf, this function does not return a value.
2129 We implement three variants, vfprintf (takes a vararg list and stream),
2130 fprintf (takes a stream to write on), and printf (the usual).
2132 Note also that a longjmp to top level may occur in this routine
2133 (since prompt_for_continue may do so) so this routine should not be
2134 called when cleanups are not in place. */
2137 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2138 va_list args
, int filter
)
2141 struct cleanup
*old_cleanups
;
2143 xvasprintf (&linebuffer
, format
, args
);
2144 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2145 fputs_maybe_filtered (linebuffer
, stream
, filter
);
2146 do_cleanups (old_cleanups
);
2151 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2153 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2157 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2160 struct cleanup
*old_cleanups
;
2162 xvasprintf (&linebuffer
, format
, args
);
2163 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2164 fputs_unfiltered (linebuffer
, stream
);
2165 do_cleanups (old_cleanups
);
2169 vprintf_filtered (const char *format
, va_list args
)
2171 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2175 vprintf_unfiltered (const char *format
, va_list args
)
2177 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2181 fprintf_filtered (struct ui_file
* stream
, const char *format
,...)
2184 va_start (args
, format
);
2185 vfprintf_filtered (stream
, format
, args
);
2190 fprintf_unfiltered (struct ui_file
* stream
, const char *format
,...)
2193 va_start (args
, format
);
2194 vfprintf_unfiltered (stream
, format
, args
);
2198 /* Like fprintf_filtered, but prints its result indented.
2199 Called as fprintfi_filtered (spaces, stream, format, ...); */
2202 fprintfi_filtered (int spaces
, struct ui_file
* stream
, const char *format
,...)
2205 va_start (args
, format
);
2206 print_spaces_filtered (spaces
, stream
);
2208 vfprintf_filtered (stream
, format
, args
);
2214 printf_filtered (const char *format
,...)
2217 va_start (args
, format
);
2218 vfprintf_filtered (gdb_stdout
, format
, args
);
2224 printf_unfiltered (const char *format
,...)
2227 va_start (args
, format
);
2228 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2232 /* Like printf_filtered, but prints it's result indented.
2233 Called as printfi_filtered (spaces, format, ...); */
2236 printfi_filtered (int spaces
, const char *format
,...)
2239 va_start (args
, format
);
2240 print_spaces_filtered (spaces
, gdb_stdout
);
2241 vfprintf_filtered (gdb_stdout
, format
, args
);
2245 /* Easy -- but watch out!
2247 This routine is *not* a replacement for puts()! puts() appends a newline.
2248 This one doesn't, and had better not! */
2251 puts_filtered (const char *string
)
2253 fputs_filtered (string
, gdb_stdout
);
2257 puts_unfiltered (const char *string
)
2259 fputs_unfiltered (string
, gdb_stdout
);
2262 /* Return a pointer to N spaces and a null. The pointer is good
2263 until the next call to here. */
2268 static char *spaces
= 0;
2269 static int max_spaces
= -1;
2275 spaces
= (char *) xmalloc (n
+ 1);
2276 for (t
= spaces
+ n
; t
!= spaces
;)
2282 return spaces
+ max_spaces
- n
;
2285 /* Print N spaces. */
2287 print_spaces_filtered (int n
, struct ui_file
*stream
)
2289 fputs_filtered (n_spaces (n
), stream
);
2292 /* C++/ObjC demangler stuff. */
2294 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2295 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2296 If the name is not mangled, or the language for the name is unknown, or
2297 demangling is off, the name is printed in its "raw" form. */
2300 fprintf_symbol_filtered (struct ui_file
*stream
, char *name
, enum language lang
,
2307 /* If user wants to see raw output, no problem. */
2310 fputs_filtered (name
, stream
);
2316 case language_cplus
:
2317 demangled
= cplus_demangle (name
, arg_mode
);
2320 demangled
= cplus_demangle (name
, arg_mode
| DMGL_JAVA
);
2323 /* Commented out until ObjC handling is enabled. */
2324 /*demangled = objc_demangle (name);*/
2327 /* OBSOLETE case language_chill: */
2328 /* OBSOLETE demangled = chill_demangle (name); */
2329 /* OBSOLETE break; */
2335 fputs_filtered (demangled
? demangled
: name
, stream
);
2336 if (demangled
!= NULL
)
2344 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2345 differences in whitespace. Returns 0 if they match, non-zero if they
2346 don't (slightly different than strcmp()'s range of return values).
2348 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2349 This "feature" is useful when searching for matching C++ function names
2350 (such as if the user types 'break FOO', where FOO is a mangled C++
2354 strcmp_iw (const char *string1
, const char *string2
)
2356 while ((*string1
!= '\0') && (*string2
!= '\0'))
2358 while (isspace (*string1
))
2362 while (isspace (*string2
))
2366 if (*string1
!= *string2
)
2370 if (*string1
!= '\0')
2376 return (*string1
!= '\0' && *string1
!= '(') || (*string2
!= '\0');
2382 ** Answer whether string_to_compare is a full or partial match to
2383 ** template_string. The partial match must be in sequence starting
2387 subset_compare (char *string_to_compare
, char *template_string
)
2390 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
&&
2391 strlen (string_to_compare
) <= strlen (template_string
))
2392 match
= (strncmp (template_string
,
2394 strlen (string_to_compare
)) == 0);
2401 static void pagination_on_command (char *arg
, int from_tty
);
2403 pagination_on_command (char *arg
, int from_tty
)
2405 pagination_enabled
= 1;
2408 static void pagination_on_command (char *arg
, int from_tty
);
2410 pagination_off_command (char *arg
, int from_tty
)
2412 pagination_enabled
= 0;
2417 initialize_utils (void)
2419 struct cmd_list_element
*c
;
2421 c
= add_set_cmd ("width", class_support
, var_uinteger
,
2422 (char *) &chars_per_line
,
2423 "Set number of characters gdb thinks are in a line.",
2425 add_show_from_set (c
, &showlist
);
2426 set_cmd_sfunc (c
, set_width_command
);
2429 (add_set_cmd ("height", class_support
,
2430 var_uinteger
, (char *) &lines_per_page
,
2431 "Set number of lines gdb thinks are in a page.", &setlist
),
2436 /* If the output is not a terminal, don't paginate it. */
2437 if (!ui_file_isatty (gdb_stdout
))
2438 lines_per_page
= UINT_MAX
;
2440 set_width_command ((char *) NULL
, 0, c
);
2443 (add_set_cmd ("demangle", class_support
, var_boolean
,
2445 "Set demangling of encoded C++/ObjC names when displaying symbols.",
2450 (add_set_cmd ("pagination", class_support
,
2451 var_boolean
, (char *) &pagination_enabled
,
2452 "Set state of pagination.", &setlist
),
2457 add_com ("am", class_support
, pagination_on_command
,
2458 "Enable pagination");
2459 add_com ("sm", class_support
, pagination_off_command
,
2460 "Disable pagination");
2464 (add_set_cmd ("sevenbit-strings", class_support
, var_boolean
,
2465 (char *) &sevenbit_strings
,
2466 "Set printing of 8-bit characters in strings as \\nnn.",
2471 (add_set_cmd ("asm-demangle", class_support
, var_boolean
,
2472 (char *) &asm_demangle
,
2473 "Set demangling of C++/ObjC names in disassembly listings.",
2478 /* Machine specific function to handle SIGWINCH signal. */
2480 #ifdef SIGWINCH_HANDLER_BODY
2481 SIGWINCH_HANDLER_BODY
2484 /* print routines to handle variable size regs, etc. */
2486 /* temporary storage using circular buffer */
2492 static char buf
[NUMCELLS
][CELLSIZE
];
2493 static int cell
= 0;
2494 if (++cell
>= NUMCELLS
)
2502 return (TARGET_ADDR_BIT
/ 8 * 2);
2506 paddr (CORE_ADDR addr
)
2508 return phex (addr
, TARGET_ADDR_BIT
/ 8);
2512 paddr_nz (CORE_ADDR addr
)
2514 return phex_nz (addr
, TARGET_ADDR_BIT
/ 8);
2518 decimal2str (char *paddr_str
, char *sign
, ULONGEST addr
)
2520 /* steal code from valprint.c:print_decimal(). Should this worry
2521 about the real size of addr as the above does? */
2522 unsigned long temp
[3];
2526 temp
[i
] = addr
% (1000 * 1000 * 1000);
2527 addr
/= (1000 * 1000 * 1000);
2530 while (addr
!= 0 && i
< (sizeof (temp
) / sizeof (temp
[0])));
2534 sprintf (paddr_str
, "%s%lu",
2538 sprintf (paddr_str
, "%s%lu%09lu",
2539 sign
, temp
[1], temp
[0]);
2542 sprintf (paddr_str
, "%s%lu%09lu%09lu",
2543 sign
, temp
[2], temp
[1], temp
[0]);
2546 internal_error (__FILE__
, __LINE__
, "failed internal consistency check");
2551 paddr_u (CORE_ADDR addr
)
2553 char *paddr_str
= get_cell ();
2554 decimal2str (paddr_str
, "", addr
);
2559 paddr_d (LONGEST addr
)
2561 char *paddr_str
= get_cell ();
2563 decimal2str (paddr_str
, "-", -addr
);
2565 decimal2str (paddr_str
, "", addr
);
2569 /* eliminate warning from compiler on 32-bit systems */
2570 static int thirty_two
= 32;
2573 phex (ULONGEST l
, int sizeof_l
)
2580 sprintf (str
, "%08lx%08lx",
2581 (unsigned long) (l
>> thirty_two
),
2582 (unsigned long) (l
& 0xffffffff));
2586 sprintf (str
, "%08lx", (unsigned long) l
);
2590 sprintf (str
, "%04x", (unsigned short) (l
& 0xffff));
2593 str
= phex (l
, sizeof (l
));
2600 phex_nz (ULONGEST l
, int sizeof_l
)
2607 unsigned long high
= (unsigned long) (l
>> thirty_two
);
2610 sprintf (str
, "%lx", (unsigned long) (l
& 0xffffffff));
2612 sprintf (str
, "%lx%08lx",
2613 high
, (unsigned long) (l
& 0xffffffff));
2618 sprintf (str
, "%lx", (unsigned long) l
);
2622 sprintf (str
, "%x", (unsigned short) (l
& 0xffff));
2625 str
= phex_nz (l
, sizeof (l
));
2632 /* Convert to / from the hosts pointer to GDB's internal CORE_ADDR
2633 using the target's conversion routines. */
2635 host_pointer_to_address (void *ptr
)
2637 gdb_assert (sizeof (ptr
) == TYPE_LENGTH (builtin_type_void_data_ptr
));
2638 return POINTER_TO_ADDRESS (builtin_type_void_data_ptr
, &ptr
);
2642 address_to_host_pointer (CORE_ADDR addr
)
2646 gdb_assert (sizeof (ptr
) == TYPE_LENGTH (builtin_type_void_data_ptr
));
2647 ADDRESS_TO_POINTER (builtin_type_void_data_ptr
, &ptr
, addr
);
2651 /* Convert a CORE_ADDR into a string. */
2653 core_addr_to_string (const CORE_ADDR addr
)
2655 char *str
= get_cell ();
2657 strcat (str
, phex (addr
, sizeof (addr
)));
2662 core_addr_to_string_nz (const CORE_ADDR addr
)
2664 char *str
= get_cell ();
2666 strcat (str
, phex_nz (addr
, sizeof (addr
)));
2670 /* Convert a string back into a CORE_ADDR. */
2672 string_to_core_addr (const char *my_string
)
2675 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2677 /* Assume that it is in decimal. */
2679 for (i
= 2; my_string
[i
] != '\0'; i
++)
2681 if (isdigit (my_string
[i
]))
2682 addr
= (my_string
[i
] - '0') + (addr
* 16);
2683 else if (isxdigit (my_string
[i
]))
2684 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2686 internal_error (__FILE__
, __LINE__
, "invalid hex");
2691 /* Assume that it is in decimal. */
2693 for (i
= 0; my_string
[i
] != '\0'; i
++)
2695 if (isdigit (my_string
[i
]))
2696 addr
= (my_string
[i
] - '0') + (addr
* 10);
2698 internal_error (__FILE__
, __LINE__
, "invalid decimal");
2701 if (INTEGER_TO_ADDRESS_P ())
2702 addr
= INTEGER_TO_ADDRESS (builtin_type_void_data_ptr
, &addr
);
2707 gdb_realpath (const char *filename
)
2709 #if defined(HAVE_REALPATH)
2710 # if defined (PATH_MAX)
2712 # define USE_REALPATH
2713 # elif defined (MAXPATHLEN)
2714 char buf
[MAXPATHLEN
];
2715 # define USE_REALPATH
2716 # elif defined (HAVE_UNISTD_H) && defined(HAVE_ALLOCA)
2717 char *buf
= alloca ((size_t)pathconf ("/", _PC_PATH_MAX
));
2718 # define USE_REALPATH
2720 #endif /* HAVE_REALPATH */
2722 #if defined(USE_REALPATH)
2723 char *rp
= realpath (filename
, buf
);
2724 return xstrdup (rp
? rp
: filename
);
2725 #elif defined(HAVE_CANONICALIZE_FILE_NAME)
2726 char *rp
= canonicalize_file_name (filename
);
2728 return xstrdup (filename
);
2732 return xstrdup (filename
);
2736 /* Return a copy of FILENAME, with its directory prefix canonicalized
2740 xfullpath (const char *filename
)
2742 const char *base_name
= lbasename (filename
);
2747 /* Extract the basename of filename, and return immediately
2748 a copy of filename if it does not contain any directory prefix. */
2749 if (base_name
== filename
)
2750 return xstrdup (filename
);
2752 dir_name
= alloca ((size_t) (base_name
- filename
+ 2));
2753 /* Allocate enough space to store the dir_name + plus one extra
2754 character sometimes needed under Windows (see below), and
2755 then the closing \000 character */
2756 strncpy (dir_name
, filename
, base_name
- filename
);
2757 dir_name
[base_name
- filename
] = '\000';
2759 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
2760 /* We need to be careful when filename is of the form 'd:foo', which
2761 is equivalent of d:./foo, which is totally different from d:/foo. */
2762 if (strlen (dir_name
) == 2 &&
2763 isalpha (dir_name
[0]) && dir_name
[1] == ':')
2766 dir_name
[3] = '\000';
2770 /* Canonicalize the directory prefix, and build the resulting
2771 filename. If the dirname realpath already contains an ending
2772 directory separator, avoid doubling it. */
2773 real_path
= gdb_realpath (dir_name
);
2774 if (IS_DIR_SEPARATOR (real_path
[strlen (real_path
) - 1]))
2775 result
= concat (real_path
, base_name
, NULL
);
2777 result
= concat (real_path
, SLASH_STRING
, base_name
, NULL
);