1 /* General utility routines for GDB, the GNU debugger.
3 Copyright 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
4 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003 Free Software
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 2 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, write to the Free Software
21 Foundation, Inc., 59 Temple Place - Suite 330,
22 Boston, MA 02111-1307, USA. */
25 #include "gdb_assert.h"
27 #include "gdb_string.h"
28 #include "event-top.h"
34 /* SunOS's curses.h has a '#define reg register' in it. Thank you Sun. */
45 #include "expression.h"
49 #include "filenames.h"
51 #include "inferior.h" /* for signed_pointer_to_address */
53 #include <sys/param.h> /* For MAXPATHLEN */
62 #include <readline/readline.h>
68 #ifdef NEED_DECLARATION_MALLOC
71 #ifdef NEED_DECLARATION_REALLOC
72 extern PTR
realloc ();
74 #ifdef NEED_DECLARATION_FREE
77 /* Actually, we'll never have the decl, since we don't define _GNU_SOURCE. */
78 #if defined(HAVE_CANONICALIZE_FILE_NAME) \
79 && defined(NEED_DECLARATION_CANONICALIZE_FILE_NAME)
80 extern char *canonicalize_file_name (const char *);
83 /* readline defines this. */
86 void (*error_begin_hook
) (void);
88 /* Holds the last error message issued by gdb */
90 static struct ui_file
*gdb_lasterr
;
92 /* Prototypes for local functions */
94 static void vfprintf_maybe_filtered (struct ui_file
*, const char *,
97 static void fputs_maybe_filtered (const char *, struct ui_file
*, int);
99 #if defined (USE_MMALLOC) && !defined (NO_MMCHECK)
100 static void malloc_botch (void);
103 static void prompt_for_continue (void);
105 static void set_width_command (char *, int, struct cmd_list_element
*);
107 static void set_width (void);
109 /* Chain of cleanup actions established with make_cleanup,
110 to be executed if an error happens. */
112 static struct cleanup
*cleanup_chain
; /* cleaned up after a failed command */
113 static struct cleanup
*final_cleanup_chain
; /* cleaned up when gdb exits */
114 static struct cleanup
*run_cleanup_chain
; /* cleaned up on each 'run' */
115 static struct cleanup
*exec_cleanup_chain
; /* cleaned up on each execution command */
116 /* cleaned up on each error from within an execution command */
117 static struct cleanup
*exec_error_cleanup_chain
;
119 /* Pointer to what is left to do for an execution command after the
120 target stops. Used only in asynchronous mode, by targets that
121 support async execution. The finish and until commands use it. So
122 does the target extended-remote command. */
123 struct continuation
*cmd_continuation
;
124 struct continuation
*intermediate_continuation
;
126 /* Nonzero if we have job control. */
130 /* Nonzero means a quit has been requested. */
134 /* Nonzero means quit immediately if Control-C is typed now, rather
135 than waiting until QUIT is executed. Be careful in setting this;
136 code which executes with immediate_quit set has to be very careful
137 about being able to deal with being interrupted at any time. It is
138 almost always better to use QUIT; the only exception I can think of
139 is being able to quit out of a system call (using EINTR loses if
140 the SIGINT happens between the previous QUIT and the system call).
141 To immediately quit in the case in which a SIGINT happens between
142 the previous QUIT and setting immediate_quit (desirable anytime we
143 expect to block), call QUIT after setting immediate_quit. */
147 /* Nonzero means that encoded C++/ObjC names should be printed out in their
148 C++/ObjC form rather than raw. */
152 /* Nonzero means that encoded C++/ObjC names should be printed out in their
153 C++/ObjC form even in assembler language displays. If this is set, but
154 DEMANGLE is zero, names are printed raw, i.e. DEMANGLE controls. */
156 int asm_demangle
= 0;
158 /* Nonzero means that strings with character values >0x7F should be printed
159 as octal escapes. Zero means just print the value (e.g. it's an
160 international character, and the terminal or window can cope.) */
162 int sevenbit_strings
= 0;
164 /* String to be printed before error messages, if any. */
166 char *error_pre_print
;
168 /* String to be printed before quit messages, if any. */
170 char *quit_pre_print
;
172 /* String to be printed before warning messages, if any. */
174 char *warning_pre_print
= "\nwarning: ";
176 int pagination_enabled
= 1;
179 /* Add a new cleanup to the cleanup_chain,
180 and return the previous chain pointer
181 to be passed later to do_cleanups or discard_cleanups.
182 Args are FUNCTION to clean up with, and ARG to pass to it. */
185 make_cleanup (make_cleanup_ftype
*function
, void *arg
)
187 return make_my_cleanup (&cleanup_chain
, function
, arg
);
191 make_final_cleanup (make_cleanup_ftype
*function
, void *arg
)
193 return make_my_cleanup (&final_cleanup_chain
, function
, arg
);
197 make_run_cleanup (make_cleanup_ftype
*function
, void *arg
)
199 return make_my_cleanup (&run_cleanup_chain
, function
, arg
);
203 make_exec_cleanup (make_cleanup_ftype
*function
, void *arg
)
205 return make_my_cleanup (&exec_cleanup_chain
, function
, arg
);
209 make_exec_error_cleanup (make_cleanup_ftype
*function
, void *arg
)
211 return make_my_cleanup (&exec_error_cleanup_chain
, function
, arg
);
215 do_freeargv (void *arg
)
217 freeargv ((char **) arg
);
221 make_cleanup_freeargv (char **arg
)
223 return make_my_cleanup (&cleanup_chain
, do_freeargv
, arg
);
227 do_bfd_close_cleanup (void *arg
)
233 make_cleanup_bfd_close (bfd
*abfd
)
235 return make_cleanup (do_bfd_close_cleanup
, abfd
);
239 do_close_cleanup (void *arg
)
247 make_cleanup_close (int fd
)
249 int *saved_fd
= xmalloc (sizeof (fd
));
251 return make_cleanup (do_close_cleanup
, saved_fd
);
255 do_ui_file_delete (void *arg
)
257 ui_file_delete (arg
);
261 make_cleanup_ui_file_delete (struct ui_file
*arg
)
263 return make_my_cleanup (&cleanup_chain
, do_ui_file_delete
, arg
);
267 make_my_cleanup (struct cleanup
**pmy_chain
, make_cleanup_ftype
*function
,
270 register struct cleanup
*new
271 = (struct cleanup
*) xmalloc (sizeof (struct cleanup
));
272 register struct cleanup
*old_chain
= *pmy_chain
;
274 new->next
= *pmy_chain
;
275 new->function
= function
;
282 /* Discard cleanups and do the actions they describe
283 until we get back to the point OLD_CHAIN in the cleanup_chain. */
286 do_cleanups (register struct cleanup
*old_chain
)
288 do_my_cleanups (&cleanup_chain
, old_chain
);
292 do_final_cleanups (register struct cleanup
*old_chain
)
294 do_my_cleanups (&final_cleanup_chain
, old_chain
);
298 do_run_cleanups (register struct cleanup
*old_chain
)
300 do_my_cleanups (&run_cleanup_chain
, old_chain
);
304 do_exec_cleanups (register struct cleanup
*old_chain
)
306 do_my_cleanups (&exec_cleanup_chain
, old_chain
);
310 do_exec_error_cleanups (register struct cleanup
*old_chain
)
312 do_my_cleanups (&exec_error_cleanup_chain
, old_chain
);
316 do_my_cleanups (register struct cleanup
**pmy_chain
,
317 register struct cleanup
*old_chain
)
319 register struct cleanup
*ptr
;
320 while ((ptr
= *pmy_chain
) != old_chain
)
322 *pmy_chain
= ptr
->next
; /* Do this first incase recursion */
323 (*ptr
->function
) (ptr
->arg
);
328 /* Discard cleanups, not doing the actions they describe,
329 until we get back to the point OLD_CHAIN in the cleanup_chain. */
332 discard_cleanups (register struct cleanup
*old_chain
)
334 discard_my_cleanups (&cleanup_chain
, old_chain
);
338 discard_final_cleanups (register struct cleanup
*old_chain
)
340 discard_my_cleanups (&final_cleanup_chain
, old_chain
);
344 discard_exec_error_cleanups (register struct cleanup
*old_chain
)
346 discard_my_cleanups (&exec_error_cleanup_chain
, old_chain
);
350 discard_my_cleanups (register struct cleanup
**pmy_chain
,
351 register struct cleanup
*old_chain
)
353 register struct cleanup
*ptr
;
354 while ((ptr
= *pmy_chain
) != old_chain
)
356 *pmy_chain
= ptr
->next
;
361 /* Set the cleanup_chain to 0, and return the old cleanup chain. */
365 return save_my_cleanups (&cleanup_chain
);
369 save_final_cleanups (void)
371 return save_my_cleanups (&final_cleanup_chain
);
375 save_my_cleanups (struct cleanup
**pmy_chain
)
377 struct cleanup
*old_chain
= *pmy_chain
;
383 /* Restore the cleanup chain from a previously saved chain. */
385 restore_cleanups (struct cleanup
*chain
)
387 restore_my_cleanups (&cleanup_chain
, chain
);
391 restore_final_cleanups (struct cleanup
*chain
)
393 restore_my_cleanups (&final_cleanup_chain
, chain
);
397 restore_my_cleanups (struct cleanup
**pmy_chain
, struct cleanup
*chain
)
402 /* This function is useful for cleanups.
406 old_chain = make_cleanup (free_current_contents, &foo);
408 to arrange to free the object thus allocated. */
411 free_current_contents (void *ptr
)
413 void **location
= ptr
;
414 if (location
== NULL
)
415 internal_error (__FILE__
, __LINE__
,
416 "free_current_contents: NULL pointer");
417 if (*location
!= NULL
)
424 /* Provide a known function that does nothing, to use as a base for
425 for a possibly long chain of cleanups. This is useful where we
426 use the cleanup chain for handling normal cleanups as well as dealing
427 with cleanups that need to be done as a result of a call to error().
428 In such cases, we may not be certain where the first cleanup is, unless
429 we have a do-nothing one to always use as the base. */
433 null_cleanup (void *arg
)
437 /* Add a continuation to the continuation list, the global list
438 cmd_continuation. The new continuation will be added at the front.*/
440 add_continuation (void (*continuation_hook
) (struct continuation_arg
*),
441 struct continuation_arg
*arg_list
)
443 struct continuation
*continuation_ptr
;
445 continuation_ptr
= (struct continuation
*) xmalloc (sizeof (struct continuation
));
446 continuation_ptr
->continuation_hook
= continuation_hook
;
447 continuation_ptr
->arg_list
= arg_list
;
448 continuation_ptr
->next
= cmd_continuation
;
449 cmd_continuation
= continuation_ptr
;
452 /* Walk down the cmd_continuation list, and execute all the
453 continuations. There is a problem though. In some cases new
454 continuations may be added while we are in the middle of this
455 loop. If this happens they will be added in the front, and done
456 before we have a chance of exhausting those that were already
457 there. We need to then save the beginning of the list in a pointer
458 and do the continuations from there on, instead of using the
459 global beginning of list as our iteration pointer.*/
461 do_all_continuations (void)
463 struct continuation
*continuation_ptr
;
464 struct continuation
*saved_continuation
;
466 /* Copy the list header into another pointer, and set the global
467 list header to null, so that the global list can change as a side
468 effect of invoking the continuations and the processing of
469 the preexisting continuations will not be affected. */
470 continuation_ptr
= cmd_continuation
;
471 cmd_continuation
= NULL
;
473 /* Work now on the list we have set aside. */
474 while (continuation_ptr
)
476 (continuation_ptr
->continuation_hook
) (continuation_ptr
->arg_list
);
477 saved_continuation
= continuation_ptr
;
478 continuation_ptr
= continuation_ptr
->next
;
479 xfree (saved_continuation
);
483 /* Walk down the cmd_continuation list, and get rid of all the
486 discard_all_continuations (void)
488 struct continuation
*continuation_ptr
;
490 while (cmd_continuation
)
492 continuation_ptr
= cmd_continuation
;
493 cmd_continuation
= continuation_ptr
->next
;
494 xfree (continuation_ptr
);
498 /* Add a continuation to the continuation list, the global list
499 intermediate_continuation. The new continuation will be added at the front.*/
501 add_intermediate_continuation (void (*continuation_hook
)
502 (struct continuation_arg
*),
503 struct continuation_arg
*arg_list
)
505 struct continuation
*continuation_ptr
;
507 continuation_ptr
= (struct continuation
*) xmalloc (sizeof (struct continuation
));
508 continuation_ptr
->continuation_hook
= continuation_hook
;
509 continuation_ptr
->arg_list
= arg_list
;
510 continuation_ptr
->next
= intermediate_continuation
;
511 intermediate_continuation
= continuation_ptr
;
514 /* Walk down the cmd_continuation list, and execute all the
515 continuations. There is a problem though. In some cases new
516 continuations may be added while we are in the middle of this
517 loop. If this happens they will be added in the front, and done
518 before we have a chance of exhausting those that were already
519 there. We need to then save the beginning of the list in a pointer
520 and do the continuations from there on, instead of using the
521 global beginning of list as our iteration pointer.*/
523 do_all_intermediate_continuations (void)
525 struct continuation
*continuation_ptr
;
526 struct continuation
*saved_continuation
;
528 /* Copy the list header into another pointer, and set the global
529 list header to null, so that the global list can change as a side
530 effect of invoking the continuations and the processing of
531 the preexisting continuations will not be affected. */
532 continuation_ptr
= intermediate_continuation
;
533 intermediate_continuation
= NULL
;
535 /* Work now on the list we have set aside. */
536 while (continuation_ptr
)
538 (continuation_ptr
->continuation_hook
) (continuation_ptr
->arg_list
);
539 saved_continuation
= continuation_ptr
;
540 continuation_ptr
= continuation_ptr
->next
;
541 xfree (saved_continuation
);
545 /* Walk down the cmd_continuation list, and get rid of all the
548 discard_all_intermediate_continuations (void)
550 struct continuation
*continuation_ptr
;
552 while (intermediate_continuation
)
554 continuation_ptr
= intermediate_continuation
;
555 intermediate_continuation
= continuation_ptr
->next
;
556 xfree (continuation_ptr
);
562 /* Print a warning message. The first argument STRING is the warning
563 message, used as an fprintf format string, the second is the
564 va_list of arguments for that string. A warning is unfiltered (not
565 paginated) so that the user does not need to page through each
566 screen full of warnings when there are lots of them. */
569 vwarning (const char *string
, va_list args
)
572 (*warning_hook
) (string
, args
);
575 target_terminal_ours ();
576 wrap_here (""); /* Force out any buffered output */
577 gdb_flush (gdb_stdout
);
578 if (warning_pre_print
)
579 fprintf_unfiltered (gdb_stderr
, warning_pre_print
);
580 vfprintf_unfiltered (gdb_stderr
, string
, args
);
581 fprintf_unfiltered (gdb_stderr
, "\n");
586 /* Print a warning message.
587 The first argument STRING is the warning message, used as a fprintf string,
588 and the remaining args are passed as arguments to it.
589 The primary difference between warnings and errors is that a warning
590 does not force the return to command level. */
593 warning (const char *string
,...)
596 va_start (args
, string
);
597 vwarning (string
, args
);
601 /* Print an error message and return to command level.
602 The first argument STRING is the error message, used as a fprintf string,
603 and the remaining args are passed as arguments to it. */
606 verror (const char *string
, va_list args
)
608 struct ui_file
*tmp_stream
= mem_fileopen ();
609 make_cleanup_ui_file_delete (tmp_stream
);
610 vfprintf_unfiltered (tmp_stream
, string
, args
);
611 error_stream (tmp_stream
);
615 error (const char *string
,...)
618 va_start (args
, string
);
619 verror (string
, args
);
624 do_write (void *data
, const char *buffer
, long length_buffer
)
626 ui_file_write (data
, buffer
, length_buffer
);
630 error_stream (struct ui_file
*stream
)
632 if (error_begin_hook
)
635 /* Copy the stream into the GDB_LASTERR buffer. */
636 ui_file_rewind (gdb_lasterr
);
637 ui_file_put (stream
, do_write
, gdb_lasterr
);
639 /* Write the message plus any error_pre_print to gdb_stderr. */
640 target_terminal_ours ();
641 wrap_here (""); /* Force out any buffered output */
642 gdb_flush (gdb_stdout
);
643 annotate_error_begin ();
645 fprintf_filtered (gdb_stderr
, error_pre_print
);
646 ui_file_put (stream
, do_write
, gdb_stderr
);
647 fprintf_filtered (gdb_stderr
, "\n");
649 throw_exception (RETURN_ERROR
);
652 /* Get the last error message issued by gdb */
655 error_last_message (void)
658 return ui_file_xstrdup (gdb_lasterr
, &len
);
661 /* This is to be called by main() at the very beginning */
666 gdb_lasterr
= mem_fileopen ();
669 /* Print a message reporting an internal error/warning. Ask the user
670 if they want to continue, dump core, or just exit. Return
671 something to indicate a quit. */
673 struct internal_problem
676 /* FIXME: cagney/2002-08-15: There should be ``maint set/show''
677 commands available for controlling these variables. */
678 enum auto_boolean should_quit
;
679 enum auto_boolean should_dump_core
;
682 /* Report a problem, internal to GDB, to the user. Once the problem
683 has been reported, and assuming GDB didn't quit, the caller can
684 either allow execution to resume or throw an error. */
687 internal_vproblem (struct internal_problem
*problem
,
688 const char *file
, int line
,
689 const char *fmt
, va_list ap
)
691 static char msg
[] = "Recursive internal problem.\n";
696 /* Don't allow infinite error/warning recursion. */
704 fputs_unfiltered (msg
, gdb_stderr
);
705 abort (); /* NOTE: GDB has only three calls to abort(). */
708 write (STDERR_FILENO
, msg
, sizeof (msg
));
712 /* Try to get the message out and at the start of a new line. */
713 target_terminal_ours ();
716 /* The error/warning message. Format using a style similar to a
717 compiler error message. */
718 fprintf_unfiltered (gdb_stderr
, "%s:%d: %s: ", file
, line
, problem
->name
);
719 vfprintf_unfiltered (gdb_stderr
, fmt
, ap
);
720 fputs_unfiltered ("\n", gdb_stderr
);
722 /* Provide more details so that the user knows that they are living
724 fprintf_unfiltered (gdb_stderr
, "\
725 A problem internal to GDB has been detected. Further\n\
726 debugging may prove unreliable.\n");
728 switch (problem
->should_quit
)
730 case AUTO_BOOLEAN_AUTO
:
731 /* Default (yes/batch case) is to quit GDB. When in batch mode
732 this lessens the likelhood of GDB going into an infinate
734 quit_p
= query ("Quit this debugging session? ");
736 case AUTO_BOOLEAN_TRUE
:
739 case AUTO_BOOLEAN_FALSE
:
743 internal_error (__FILE__
, __LINE__
, "bad switch");
746 switch (problem
->should_dump_core
)
748 case AUTO_BOOLEAN_AUTO
:
749 /* Default (yes/batch case) is to dump core. This leaves a GDB
750 `dropping' so that it is easier to see that something went
752 dump_core_p
= query ("Create a core file of GDB? ");
755 case AUTO_BOOLEAN_TRUE
:
758 case AUTO_BOOLEAN_FALSE
:
762 internal_error (__FILE__
, __LINE__
, "bad switch");
768 abort (); /* NOTE: GDB has only three calls to abort(). */
777 abort (); /* NOTE: GDB has only three calls to abort(). */
784 static struct internal_problem internal_error_problem
= {
785 "internal-error", AUTO_BOOLEAN_AUTO
, AUTO_BOOLEAN_AUTO
789 internal_verror (const char *file
, int line
,
790 const char *fmt
, va_list ap
)
792 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
793 throw_exception (RETURN_ERROR
);
797 internal_error (const char *file
, int line
, const char *string
, ...)
800 va_start (ap
, string
);
801 internal_verror (file
, line
, string
, ap
);
805 static struct internal_problem internal_warning_problem
= {
806 "internal-error", AUTO_BOOLEAN_AUTO
, AUTO_BOOLEAN_AUTO
810 internal_vwarning (const char *file
, int line
,
811 const char *fmt
, va_list ap
)
813 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
817 internal_warning (const char *file
, int line
, const char *string
, ...)
820 va_start (ap
, string
);
821 internal_vwarning (file
, line
, string
, ap
);
825 /* The strerror() function can return NULL for errno values that are
826 out of range. Provide a "safe" version that always returns a
830 safe_strerror (int errnum
)
835 if ((msg
= strerror (errnum
)) == NULL
)
837 sprintf (buf
, "(undocumented errno %d)", errnum
);
843 /* Print the system error message for errno, and also mention STRING
844 as the file name for which the error was encountered.
845 Then return to command level. */
848 perror_with_name (const char *string
)
853 err
= safe_strerror (errno
);
854 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
855 strcpy (combined
, string
);
856 strcat (combined
, ": ");
857 strcat (combined
, err
);
859 /* I understand setting these is a matter of taste. Still, some people
860 may clear errno but not know about bfd_error. Doing this here is not
862 bfd_set_error (bfd_error_no_error
);
865 error ("%s.", combined
);
868 /* Print the system error message for ERRCODE, and also mention STRING
869 as the file name for which the error was encountered. */
872 print_sys_errmsg (const char *string
, int errcode
)
877 err
= safe_strerror (errcode
);
878 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
879 strcpy (combined
, string
);
880 strcat (combined
, ": ");
881 strcat (combined
, err
);
883 /* We want anything which was printed on stdout to come out first, before
885 gdb_flush (gdb_stdout
);
886 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
889 /* Control C eventually causes this to be called, at a convenient time. */
894 struct serial
*gdb_stdout_serial
= serial_fdopen (1);
896 target_terminal_ours ();
898 /* We want all output to appear now, before we print "Quit". We
899 have 3 levels of buffering we have to flush (it's possible that
900 some of these should be changed to flush the lower-level ones
903 /* 1. The _filtered buffer. */
904 wrap_here ((char *) 0);
906 /* 2. The stdio buffer. */
907 gdb_flush (gdb_stdout
);
908 gdb_flush (gdb_stderr
);
910 /* 3. The system-level buffer. */
911 serial_drain_output (gdb_stdout_serial
);
912 serial_un_fdopen (gdb_stdout_serial
);
914 annotate_error_begin ();
916 /* Don't use *_filtered; we don't want to prompt the user to continue. */
918 fprintf_unfiltered (gdb_stderr
, quit_pre_print
);
921 /* No steenking SIGINT will ever be coming our way when the
922 program is resumed. Don't lie. */
923 fprintf_unfiltered (gdb_stderr
, "Quit\n");
926 /* If there is no terminal switching for this target, then we can't
927 possibly get screwed by the lack of job control. */
928 || current_target
.to_terminal_ours
== NULL
)
929 fprintf_unfiltered (gdb_stderr
, "Quit\n");
931 fprintf_unfiltered (gdb_stderr
,
932 "Quit (expect signal SIGINT when the program is resumed)\n");
934 throw_exception (RETURN_QUIT
);
937 /* Control C comes here */
939 request_quit (int signo
)
942 /* Restore the signal handler. Harmless with BSD-style signals, needed
943 for System V-style signals. So just always do it, rather than worrying
944 about USG defines and stuff like that. */
945 signal (signo
, request_quit
);
955 /* Memory management stuff (malloc friends). */
957 #if !defined (USE_MMALLOC)
959 /* NOTE: These must use PTR so that their definition matches the
960 declaration found in "mmalloc.h". */
963 mmalloc (void *md
, size_t size
)
965 return malloc (size
); /* NOTE: GDB's only call to malloc() */
969 mrealloc (void *md
, void *ptr
, size_t size
)
971 if (ptr
== 0) /* Guard against old realloc's */
972 return mmalloc (md
, size
);
974 return realloc (ptr
, size
); /* NOTE: GDB's only call to ralloc() */
978 mcalloc (void *md
, size_t number
, size_t size
)
980 return calloc (number
, size
); /* NOTE: GDB's only call to calloc() */
984 mfree (void *md
, void *ptr
)
986 free (ptr
); /* NOTE: GDB's only call to free() */
989 #endif /* USE_MMALLOC */
991 #if !defined (USE_MMALLOC) || defined (NO_MMCHECK)
994 init_malloc (void *md
)
998 #else /* Have mmalloc and want corruption checking */
1003 fprintf_unfiltered (gdb_stderr
, "Memory corruption\n");
1004 internal_error (__FILE__
, __LINE__
, "failed internal consistency check");
1007 /* Attempt to install hooks in mmalloc/mrealloc/mfree for the heap specified
1008 by MD, to detect memory corruption. Note that MD may be NULL to specify
1009 the default heap that grows via sbrk.
1011 Note that for freshly created regions, we must call mmcheckf prior to any
1012 mallocs in the region. Otherwise, any region which was allocated prior to
1013 installing the checking hooks, which is later reallocated or freed, will
1014 fail the checks! The mmcheck function only allows initial hooks to be
1015 installed before the first mmalloc. However, anytime after we have called
1016 mmcheck the first time to install the checking hooks, we can call it again
1017 to update the function pointer to the memory corruption handler.
1019 Returns zero on failure, non-zero on success. */
1021 #ifndef MMCHECK_FORCE
1022 #define MMCHECK_FORCE 0
1026 init_malloc (void *md
)
1028 if (!mmcheckf (md
, malloc_botch
, MMCHECK_FORCE
))
1030 /* Don't use warning(), which relies on current_target being set
1031 to something other than dummy_target, until after
1032 initialize_all_files(). */
1035 (gdb_stderr
, "warning: failed to install memory consistency checks; ");
1037 (gdb_stderr
, "configuration should define NO_MMCHECK or MMCHECK_FORCE\n");
1043 #endif /* Have mmalloc and want corruption checking */
1045 /* Called when a memory allocation fails, with the number of bytes of
1046 memory requested in SIZE. */
1053 internal_error (__FILE__
, __LINE__
,
1054 "virtual memory exhausted: can't allocate %ld bytes.", size
);
1058 internal_error (__FILE__
, __LINE__
,
1059 "virtual memory exhausted.");
1063 /* The xmmalloc() family of memory management routines.
1065 These are are like the mmalloc() family except that they implement
1066 consistent semantics and guard against typical memory management
1067 problems: if a malloc fails, an internal error is thrown; if
1068 free(NULL) is called, it is ignored; if *alloc(0) is called, NULL
1071 All these routines are implemented using the mmalloc() family. */
1074 xmmalloc (void *md
, size_t size
)
1084 val
= mmalloc (md
, size
);
1092 xmrealloc (void *md
, void *ptr
, size_t size
)
1106 val
= mrealloc (md
, ptr
, size
);
1110 val
= mmalloc (md
, size
);
1121 xmcalloc (void *md
, size_t number
, size_t size
)
1124 if (number
== 0 || size
== 0)
1128 mem
= mcalloc (md
, number
, size
);
1130 nomem (number
* size
);
1136 xmfree (void *md
, void *ptr
)
1142 /* The xmalloc() (libiberty.h) family of memory management routines.
1144 These are like the ISO-C malloc() family except that they implement
1145 consistent semantics and guard against typical memory management
1146 problems. See xmmalloc() above for further information.
1148 All these routines are wrappers to the xmmalloc() family. */
1150 /* NOTE: These are declared using PTR to ensure consistency with
1151 "libiberty.h". xfree() is GDB local. */
1154 xmalloc (size_t size
)
1156 return xmmalloc (NULL
, size
);
1160 xrealloc (PTR ptr
, size_t size
)
1162 return xmrealloc (NULL
, ptr
, size
);
1166 xcalloc (size_t number
, size_t size
)
1168 return xmcalloc (NULL
, number
, size
);
1178 /* Like asprintf/vasprintf but get an internal_error if the call
1182 xasprintf (char **ret
, const char *format
, ...)
1185 va_start (args
, format
);
1186 xvasprintf (ret
, format
, args
);
1191 xvasprintf (char **ret
, const char *format
, va_list ap
)
1193 int status
= vasprintf (ret
, format
, ap
);
1194 /* NULL could be returned due to a memory allocation problem; a
1195 badly format string; or something else. */
1197 internal_error (__FILE__
, __LINE__
,
1198 "vasprintf returned NULL buffer (errno %d)",
1200 /* A negative status with a non-NULL buffer shouldn't never
1201 happen. But to be sure. */
1203 internal_error (__FILE__
, __LINE__
,
1204 "vasprintf call failed (errno %d)",
1209 /* My replacement for the read system call.
1210 Used like `read' but keeps going if `read' returns too soon. */
1213 myread (int desc
, char *addr
, int len
)
1220 val
= read (desc
, addr
, len
);
1224 return orglen
- len
;
1231 /* Make a copy of the string at PTR with SIZE characters
1232 (and add a null character at the end in the copy).
1233 Uses malloc to get the space. Returns the address of the copy. */
1236 savestring (const char *ptr
, size_t size
)
1238 register char *p
= (char *) xmalloc (size
+ 1);
1239 memcpy (p
, ptr
, size
);
1245 msavestring (void *md
, const char *ptr
, size_t size
)
1247 register char *p
= (char *) xmmalloc (md
, size
+ 1);
1248 memcpy (p
, ptr
, size
);
1254 mstrsave (void *md
, const char *ptr
)
1256 return (msavestring (md
, ptr
, strlen (ptr
)));
1260 print_spaces (register int n
, register struct ui_file
*file
)
1262 fputs_unfiltered (n_spaces (n
), file
);
1265 /* Print a host address. */
1268 gdb_print_host_address (void *addr
, struct ui_file
*stream
)
1271 /* We could use the %p conversion specifier to fprintf if we had any
1272 way of knowing whether this host supports it. But the following
1273 should work on the Alpha and on 32 bit machines. */
1275 fprintf_filtered (stream
, "0x%lx", (unsigned long) addr
);
1278 /* Ask user a y-or-n question and return 1 iff answer is yes.
1279 Takes three args which are given to printf to print the question.
1280 The first, a control string, should end in "? ".
1281 It should not say how to answer, because we do that. */
1285 query (const char *ctlstr
,...)
1288 register int answer
;
1292 va_start (args
, ctlstr
);
1296 return query_hook (ctlstr
, args
);
1299 /* Automatically answer "yes" if input is not from a terminal. */
1300 if (!input_from_terminal_p ())
1305 wrap_here (""); /* Flush any buffered output */
1306 gdb_flush (gdb_stdout
);
1308 if (annotation_level
> 1)
1309 printf_filtered ("\n\032\032pre-query\n");
1311 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
1312 printf_filtered ("(y or n) ");
1314 if (annotation_level
> 1)
1315 printf_filtered ("\n\032\032query\n");
1318 gdb_flush (gdb_stdout
);
1320 answer
= fgetc (stdin
);
1321 clearerr (stdin
); /* in case of C-d */
1322 if (answer
== EOF
) /* C-d */
1327 /* Eat rest of input line, to EOF or newline */
1331 ans2
= fgetc (stdin
);
1334 while (ans2
!= EOF
&& ans2
!= '\n' && ans2
!= '\r');
1348 printf_filtered ("Please answer y or n.\n");
1351 if (annotation_level
> 1)
1352 printf_filtered ("\n\032\032post-query\n");
1357 /* Print an error message saying that we couldn't make sense of a
1358 \^mumble sequence in a string or character constant. START and END
1359 indicate a substring of some larger string that contains the
1360 erroneous backslash sequence, missing the initial backslash. */
1362 no_control_char_error (const char *start
, const char *end
)
1364 int len
= end
- start
;
1365 char *copy
= alloca (end
- start
+ 1);
1367 memcpy (copy
, start
, len
);
1370 error ("There is no control character `\\%s' in the `%s' character set.",
1371 copy
, target_charset ());
1374 /* Parse a C escape sequence. STRING_PTR points to a variable
1375 containing a pointer to the string to parse. That pointer
1376 should point to the character after the \. That pointer
1377 is updated past the characters we use. The value of the
1378 escape sequence is returned.
1380 A negative value means the sequence \ newline was seen,
1381 which is supposed to be equivalent to nothing at all.
1383 If \ is followed by a null character, we return a negative
1384 value and leave the string pointer pointing at the null character.
1386 If \ is followed by 000, we return 0 and leave the string pointer
1387 after the zeros. A value of 0 does not mean end of string. */
1390 parse_escape (char **string_ptr
)
1393 register int c
= *(*string_ptr
)++;
1394 if (c_parse_backslash (c
, &target_char
))
1405 /* Remember where this escape sequence started, for reporting
1407 char *sequence_start_pos
= *string_ptr
- 1;
1409 c
= *(*string_ptr
)++;
1413 /* XXXCHARSET: What is `delete' in the host character set? */
1416 if (! host_char_to_target (c
, &target_char
))
1417 error ("There is no character corresponding to `Delete' "
1418 "in the target character set `%s'.",
1424 target_char
= parse_escape (string_ptr
);
1427 if (! host_char_to_target (c
, &target_char
))
1428 no_control_char_error (sequence_start_pos
, *string_ptr
);
1431 /* Now target_char is something like `c', and we want to find
1432 its control-character equivalent. */
1433 if (! target_char_to_control_char (target_char
, &target_char
))
1434 no_control_char_error (sequence_start_pos
, *string_ptr
);
1439 /* XXXCHARSET: we need to use isdigit and value-of-digit
1440 methods of the host character set here. */
1451 register int i
= c
- '0';
1452 register int count
= 0;
1455 if ((c
= *(*string_ptr
)++) >= '0' && c
<= '7')
1469 if (! host_char_to_target (c
, &target_char
))
1470 error ("The escape sequence `\%c' is equivalent to plain `%c', which"
1471 " has no equivalent\n"
1472 "in the `%s' character set.",
1473 c
, c
, target_charset ());
1478 /* Print the character C on STREAM as part of the contents of a literal
1479 string whose delimiter is QUOTER. Note that this routine should only
1480 be call for printing things which are independent of the language
1481 of the program being debugged. */
1484 printchar (int c
, void (*do_fputs
) (const char *, struct ui_file
*),
1485 void (*do_fprintf
) (struct ui_file
*, const char *, ...),
1486 struct ui_file
*stream
, int quoter
)
1489 c
&= 0xFF; /* Avoid sign bit follies */
1491 if (c
< 0x20 || /* Low control chars */
1492 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1493 (sevenbit_strings
&& c
>= 0x80))
1494 { /* high order bit set */
1498 do_fputs ("\\n", stream
);
1501 do_fputs ("\\b", stream
);
1504 do_fputs ("\\t", stream
);
1507 do_fputs ("\\f", stream
);
1510 do_fputs ("\\r", stream
);
1513 do_fputs ("\\e", stream
);
1516 do_fputs ("\\a", stream
);
1519 do_fprintf (stream
, "\\%.3o", (unsigned int) c
);
1525 if (c
== '\\' || c
== quoter
)
1526 do_fputs ("\\", stream
);
1527 do_fprintf (stream
, "%c", c
);
1531 /* Print the character C on STREAM as part of the contents of a
1532 literal string whose delimiter is QUOTER. Note that these routines
1533 should only be call for printing things which are independent of
1534 the language of the program being debugged. */
1537 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1540 printchar (*str
++, fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1544 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1547 printchar (*str
++, fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1551 fputstrn_unfiltered (const char *str
, int n
, int quoter
, struct ui_file
*stream
)
1554 for (i
= 0; i
< n
; i
++)
1555 printchar (str
[i
], fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1560 /* Number of lines per page or UINT_MAX if paging is disabled. */
1561 static unsigned int lines_per_page
;
1562 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1563 static unsigned int chars_per_line
;
1564 /* Current count of lines printed on this page, chars on this line. */
1565 static unsigned int lines_printed
, chars_printed
;
1567 /* Buffer and start column of buffered text, for doing smarter word-
1568 wrapping. When someone calls wrap_here(), we start buffering output
1569 that comes through fputs_filtered(). If we see a newline, we just
1570 spit it out and forget about the wrap_here(). If we see another
1571 wrap_here(), we spit it out and remember the newer one. If we see
1572 the end of the line, we spit out a newline, the indent, and then
1573 the buffered output. */
1575 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1576 are waiting to be output (they have already been counted in chars_printed).
1577 When wrap_buffer[0] is null, the buffer is empty. */
1578 static char *wrap_buffer
;
1580 /* Pointer in wrap_buffer to the next character to fill. */
1581 static char *wrap_pointer
;
1583 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1585 static char *wrap_indent
;
1587 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1588 is not in effect. */
1589 static int wrap_column
;
1592 /* Inialize the lines and chars per page */
1594 init_page_info (void)
1597 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1600 /* These defaults will be used if we are unable to get the correct
1601 values from termcap. */
1602 #if defined(__GO32__)
1603 lines_per_page
= ScreenRows ();
1604 chars_per_line
= ScreenCols ();
1606 lines_per_page
= 24;
1607 chars_per_line
= 80;
1609 #if !defined (_WIN32)
1610 /* No termcap under MPW, although might be cool to do something
1611 by looking at worksheet or console window sizes. */
1612 /* Initialize the screen height and width from termcap. */
1614 char *termtype
= getenv ("TERM");
1616 /* Positive means success, nonpositive means failure. */
1619 /* 2048 is large enough for all known terminals, according to the
1620 GNU termcap manual. */
1621 char term_buffer
[2048];
1625 status
= tgetent (term_buffer
, termtype
);
1629 int running_in_emacs
= getenv ("EMACS") != NULL
;
1631 val
= tgetnum ("li");
1632 if (val
>= 0 && !running_in_emacs
)
1633 lines_per_page
= val
;
1635 /* The number of lines per page is not mentioned
1636 in the terminal description. This probably means
1637 that paging is not useful (e.g. emacs shell window),
1638 so disable paging. */
1639 lines_per_page
= UINT_MAX
;
1641 val
= tgetnum ("co");
1643 chars_per_line
= val
;
1649 #if defined(SIGWINCH) && defined(SIGWINCH_HANDLER)
1651 /* If there is a better way to determine the window size, use it. */
1652 SIGWINCH_HANDLER (SIGWINCH
);
1655 /* If the output is not a terminal, don't paginate it. */
1656 if (!ui_file_isatty (gdb_stdout
))
1657 lines_per_page
= UINT_MAX
;
1658 } /* the command_line_version */
1665 if (chars_per_line
== 0)
1670 wrap_buffer
= (char *) xmalloc (chars_per_line
+ 2);
1671 wrap_buffer
[0] = '\0';
1674 wrap_buffer
= (char *) xrealloc (wrap_buffer
, chars_per_line
+ 2);
1675 wrap_pointer
= wrap_buffer
; /* Start it at the beginning */
1680 set_width_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1685 /* Wait, so the user can read what's on the screen. Prompt the user
1686 to continue by pressing RETURN. */
1689 prompt_for_continue (void)
1692 char cont_prompt
[120];
1694 if (annotation_level
> 1)
1695 printf_unfiltered ("\n\032\032pre-prompt-for-continue\n");
1697 strcpy (cont_prompt
,
1698 "---Type <return> to continue, or q <return> to quit---");
1699 if (annotation_level
> 1)
1700 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1702 /* We must do this *before* we call gdb_readline, else it will eventually
1703 call us -- thinking that we're trying to print beyond the end of the
1705 reinitialize_more_filter ();
1708 /* On a real operating system, the user can quit with SIGINT.
1711 'q' is provided on all systems so users don't have to change habits
1712 from system to system, and because telling them what to do in
1713 the prompt is more user-friendly than expecting them to think of
1715 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1716 whereas control-C to gdb_readline will cause the user to get dumped
1718 ignore
= gdb_readline_wrapper (cont_prompt
);
1720 if (annotation_level
> 1)
1721 printf_unfiltered ("\n\032\032post-prompt-for-continue\n");
1726 while (*p
== ' ' || *p
== '\t')
1731 request_quit (SIGINT
);
1733 async_request_quit (0);
1739 /* Now we have to do this again, so that GDB will know that it doesn't
1740 need to save the ---Type <return>--- line at the top of the screen. */
1741 reinitialize_more_filter ();
1743 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1746 /* Reinitialize filter; ie. tell it to reset to original values. */
1749 reinitialize_more_filter (void)
1755 /* Indicate that if the next sequence of characters overflows the line,
1756 a newline should be inserted here rather than when it hits the end.
1757 If INDENT is non-null, it is a string to be printed to indent the
1758 wrapped part on the next line. INDENT must remain accessible until
1759 the next call to wrap_here() or until a newline is printed through
1762 If the line is already overfull, we immediately print a newline and
1763 the indentation, and disable further wrapping.
1765 If we don't know the width of lines, but we know the page height,
1766 we must not wrap words, but should still keep track of newlines
1767 that were explicitly printed.
1769 INDENT should not contain tabs, as that will mess up the char count
1770 on the next line. FIXME.
1772 This routine is guaranteed to force out any output which has been
1773 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1774 used to force out output from the wrap_buffer. */
1777 wrap_here (char *indent
)
1779 /* This should have been allocated, but be paranoid anyway. */
1781 internal_error (__FILE__
, __LINE__
, "failed internal consistency check");
1785 *wrap_pointer
= '\0';
1786 fputs_unfiltered (wrap_buffer
, gdb_stdout
);
1788 wrap_pointer
= wrap_buffer
;
1789 wrap_buffer
[0] = '\0';
1790 if (chars_per_line
== UINT_MAX
) /* No line overflow checking */
1794 else if (chars_printed
>= chars_per_line
)
1796 puts_filtered ("\n");
1798 puts_filtered (indent
);
1803 wrap_column
= chars_printed
;
1807 wrap_indent
= indent
;
1811 /* Print input string to gdb_stdout, filtered, with wrap,
1812 arranging strings in columns of n chars. String can be
1813 right or left justified in the column. Never prints
1814 trailing spaces. String should never be longer than
1815 width. FIXME: this could be useful for the EXAMINE
1816 command, which currently doesn't tabulate very well */
1819 puts_filtered_tabular (char *string
, int width
, int right
)
1825 gdb_assert (chars_per_line
> 0);
1826 if (chars_per_line
== UINT_MAX
)
1828 fputs_filtered (string
, gdb_stdout
);
1829 fputs_filtered ("\n", gdb_stdout
);
1833 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1834 fputs_filtered ("\n", gdb_stdout
);
1836 if (width
>= chars_per_line
)
1837 width
= chars_per_line
- 1;
1839 stringlen
= strlen (string
);
1841 if (chars_printed
> 0)
1842 spaces
= width
- (chars_printed
- 1) % width
- 1;
1844 spaces
+= width
- stringlen
;
1846 spacebuf
= alloca (spaces
+ 1);
1847 spacebuf
[spaces
] = '\0';
1849 spacebuf
[spaces
] = ' ';
1851 fputs_filtered (spacebuf
, gdb_stdout
);
1852 fputs_filtered (string
, gdb_stdout
);
1856 /* Ensure that whatever gets printed next, using the filtered output
1857 commands, starts at the beginning of the line. I.E. if there is
1858 any pending output for the current line, flush it and start a new
1859 line. Otherwise do nothing. */
1864 if (chars_printed
> 0)
1866 puts_filtered ("\n");
1871 /* Like fputs but if FILTER is true, pause after every screenful.
1873 Regardless of FILTER can wrap at points other than the final
1874 character of a line.
1876 Unlike fputs, fputs_maybe_filtered does not return a value.
1877 It is OK for LINEBUFFER to be NULL, in which case just don't print
1880 Note that a longjmp to top level may occur in this routine (only if
1881 FILTER is true) (since prompt_for_continue may do so) so this
1882 routine should not be called when cleanups are not in place. */
1885 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1888 const char *lineptr
;
1890 if (linebuffer
== 0)
1893 /* Don't do any filtering if it is disabled. */
1894 if ((stream
!= gdb_stdout
) || !pagination_enabled
1895 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
))
1897 fputs_unfiltered (linebuffer
, stream
);
1901 /* Go through and output each character. Show line extension
1902 when this is necessary; prompt user for new page when this is
1905 lineptr
= linebuffer
;
1908 /* Possible new page. */
1910 (lines_printed
>= lines_per_page
- 1))
1911 prompt_for_continue ();
1913 while (*lineptr
&& *lineptr
!= '\n')
1915 /* Print a single line. */
1916 if (*lineptr
== '\t')
1919 *wrap_pointer
++ = '\t';
1921 fputc_unfiltered ('\t', stream
);
1922 /* Shifting right by 3 produces the number of tab stops
1923 we have already passed, and then adding one and
1924 shifting left 3 advances to the next tab stop. */
1925 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
1931 *wrap_pointer
++ = *lineptr
;
1933 fputc_unfiltered (*lineptr
, stream
);
1938 if (chars_printed
>= chars_per_line
)
1940 unsigned int save_chars
= chars_printed
;
1944 /* If we aren't actually wrapping, don't output newline --
1945 if chars_per_line is right, we probably just overflowed
1946 anyway; if it's wrong, let us keep going. */
1948 fputc_unfiltered ('\n', stream
);
1950 /* Possible new page. */
1951 if (lines_printed
>= lines_per_page
- 1)
1952 prompt_for_continue ();
1954 /* Now output indentation and wrapped string */
1957 fputs_unfiltered (wrap_indent
, stream
);
1958 *wrap_pointer
= '\0'; /* Null-terminate saved stuff */
1959 fputs_unfiltered (wrap_buffer
, stream
); /* and eject it */
1960 /* FIXME, this strlen is what prevents wrap_indent from
1961 containing tabs. However, if we recurse to print it
1962 and count its chars, we risk trouble if wrap_indent is
1963 longer than (the user settable) chars_per_line.
1964 Note also that this can set chars_printed > chars_per_line
1965 if we are printing a long string. */
1966 chars_printed
= strlen (wrap_indent
)
1967 + (save_chars
- wrap_column
);
1968 wrap_pointer
= wrap_buffer
; /* Reset buffer */
1969 wrap_buffer
[0] = '\0';
1970 wrap_column
= 0; /* And disable fancy wrap */
1975 if (*lineptr
== '\n')
1978 wrap_here ((char *) 0); /* Spit out chars, cancel further wraps */
1980 fputc_unfiltered ('\n', stream
);
1987 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
1989 fputs_maybe_filtered (linebuffer
, stream
, 1);
1993 putchar_unfiltered (int c
)
1996 ui_file_write (gdb_stdout
, &buf
, 1);
2000 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2001 May return nonlocally. */
2004 putchar_filtered (int c
)
2006 return fputc_filtered (c
, gdb_stdout
);
2010 fputc_unfiltered (int c
, struct ui_file
*stream
)
2013 ui_file_write (stream
, &buf
, 1);
2018 fputc_filtered (int c
, struct ui_file
*stream
)
2024 fputs_filtered (buf
, stream
);
2028 /* puts_debug is like fputs_unfiltered, except it prints special
2029 characters in printable fashion. */
2032 puts_debug (char *prefix
, char *string
, char *suffix
)
2036 /* Print prefix and suffix after each line. */
2037 static int new_line
= 1;
2038 static int return_p
= 0;
2039 static char *prev_prefix
= "";
2040 static char *prev_suffix
= "";
2042 if (*string
== '\n')
2045 /* If the prefix is changing, print the previous suffix, a new line,
2046 and the new prefix. */
2047 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
2049 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
2050 fputs_unfiltered ("\n", gdb_stdlog
);
2051 fputs_unfiltered (prefix
, gdb_stdlog
);
2054 /* Print prefix if we printed a newline during the previous call. */
2058 fputs_unfiltered (prefix
, gdb_stdlog
);
2061 prev_prefix
= prefix
;
2062 prev_suffix
= suffix
;
2064 /* Output characters in a printable format. */
2065 while ((ch
= *string
++) != '\0')
2071 fputc_unfiltered (ch
, gdb_stdlog
);
2074 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2078 fputs_unfiltered ("\\\\", gdb_stdlog
);
2081 fputs_unfiltered ("\\b", gdb_stdlog
);
2084 fputs_unfiltered ("\\f", gdb_stdlog
);
2088 fputs_unfiltered ("\\n", gdb_stdlog
);
2091 fputs_unfiltered ("\\r", gdb_stdlog
);
2094 fputs_unfiltered ("\\t", gdb_stdlog
);
2097 fputs_unfiltered ("\\v", gdb_stdlog
);
2101 return_p
= ch
== '\r';
2104 /* Print suffix if we printed a newline. */
2107 fputs_unfiltered (suffix
, gdb_stdlog
);
2108 fputs_unfiltered ("\n", gdb_stdlog
);
2113 /* Print a variable number of ARGS using format FORMAT. If this
2114 information is going to put the amount written (since the last call
2115 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2116 call prompt_for_continue to get the users permision to continue.
2118 Unlike fprintf, this function does not return a value.
2120 We implement three variants, vfprintf (takes a vararg list and stream),
2121 fprintf (takes a stream to write on), and printf (the usual).
2123 Note also that a longjmp to top level may occur in this routine
2124 (since prompt_for_continue may do so) so this routine should not be
2125 called when cleanups are not in place. */
2128 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2129 va_list args
, int filter
)
2132 struct cleanup
*old_cleanups
;
2134 xvasprintf (&linebuffer
, format
, args
);
2135 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2136 fputs_maybe_filtered (linebuffer
, stream
, filter
);
2137 do_cleanups (old_cleanups
);
2142 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2144 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2148 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2151 struct cleanup
*old_cleanups
;
2153 xvasprintf (&linebuffer
, format
, args
);
2154 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2155 fputs_unfiltered (linebuffer
, stream
);
2156 do_cleanups (old_cleanups
);
2160 vprintf_filtered (const char *format
, va_list args
)
2162 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2166 vprintf_unfiltered (const char *format
, va_list args
)
2168 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2172 fprintf_filtered (struct ui_file
* stream
, const char *format
,...)
2175 va_start (args
, format
);
2176 vfprintf_filtered (stream
, format
, args
);
2181 fprintf_unfiltered (struct ui_file
* stream
, const char *format
,...)
2184 va_start (args
, format
);
2185 vfprintf_unfiltered (stream
, format
, args
);
2189 /* Like fprintf_filtered, but prints its result indented.
2190 Called as fprintfi_filtered (spaces, stream, format, ...); */
2193 fprintfi_filtered (int spaces
, struct ui_file
* stream
, const char *format
,...)
2196 va_start (args
, format
);
2197 print_spaces_filtered (spaces
, stream
);
2199 vfprintf_filtered (stream
, format
, args
);
2205 printf_filtered (const char *format
,...)
2208 va_start (args
, format
);
2209 vfprintf_filtered (gdb_stdout
, format
, args
);
2215 printf_unfiltered (const char *format
,...)
2218 va_start (args
, format
);
2219 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2223 /* Like printf_filtered, but prints it's result indented.
2224 Called as printfi_filtered (spaces, format, ...); */
2227 printfi_filtered (int spaces
, const char *format
,...)
2230 va_start (args
, format
);
2231 print_spaces_filtered (spaces
, gdb_stdout
);
2232 vfprintf_filtered (gdb_stdout
, format
, args
);
2236 /* Easy -- but watch out!
2238 This routine is *not* a replacement for puts()! puts() appends a newline.
2239 This one doesn't, and had better not! */
2242 puts_filtered (const char *string
)
2244 fputs_filtered (string
, gdb_stdout
);
2248 puts_unfiltered (const char *string
)
2250 fputs_unfiltered (string
, gdb_stdout
);
2253 /* Return a pointer to N spaces and a null. The pointer is good
2254 until the next call to here. */
2259 static char *spaces
= 0;
2260 static int max_spaces
= -1;
2266 spaces
= (char *) xmalloc (n
+ 1);
2267 for (t
= spaces
+ n
; t
!= spaces
;)
2273 return spaces
+ max_spaces
- n
;
2276 /* Print N spaces. */
2278 print_spaces_filtered (int n
, struct ui_file
*stream
)
2280 fputs_filtered (n_spaces (n
), stream
);
2283 /* C++/ObjC demangler stuff. */
2285 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2286 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2287 If the name is not mangled, or the language for the name is unknown, or
2288 demangling is off, the name is printed in its "raw" form. */
2291 fprintf_symbol_filtered (struct ui_file
*stream
, char *name
, enum language lang
,
2298 /* If user wants to see raw output, no problem. */
2301 fputs_filtered (name
, stream
);
2307 case language_cplus
:
2308 demangled
= cplus_demangle (name
, arg_mode
);
2311 demangled
= cplus_demangle (name
, arg_mode
| DMGL_JAVA
);
2314 /* Commented out until ObjC handling is enabled. */
2315 /*demangled = objc_demangle (name);*/
2321 fputs_filtered (demangled
? demangled
: name
, stream
);
2322 if (demangled
!= NULL
)
2330 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2331 differences in whitespace. Returns 0 if they match, non-zero if they
2332 don't (slightly different than strcmp()'s range of return values).
2334 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2335 This "feature" is useful when searching for matching C++ function names
2336 (such as if the user types 'break FOO', where FOO is a mangled C++
2340 strcmp_iw (const char *string1
, const char *string2
)
2342 while ((*string1
!= '\0') && (*string2
!= '\0'))
2344 while (isspace (*string1
))
2348 while (isspace (*string2
))
2352 if (*string1
!= *string2
)
2356 if (*string1
!= '\0')
2362 return (*string1
!= '\0' && *string1
!= '(') || (*string2
!= '\0');
2368 ** Answer whether string_to_compare is a full or partial match to
2369 ** template_string. The partial match must be in sequence starting
2373 subset_compare (char *string_to_compare
, char *template_string
)
2376 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
&&
2377 strlen (string_to_compare
) <= strlen (template_string
))
2378 match
= (strncmp (template_string
,
2380 strlen (string_to_compare
)) == 0);
2387 static void pagination_on_command (char *arg
, int from_tty
);
2389 pagination_on_command (char *arg
, int from_tty
)
2391 pagination_enabled
= 1;
2394 static void pagination_on_command (char *arg
, int from_tty
);
2396 pagination_off_command (char *arg
, int from_tty
)
2398 pagination_enabled
= 0;
2403 initialize_utils (void)
2405 struct cmd_list_element
*c
;
2407 c
= add_set_cmd ("width", class_support
, var_uinteger
,
2408 (char *) &chars_per_line
,
2409 "Set number of characters gdb thinks are in a line.",
2411 add_show_from_set (c
, &showlist
);
2412 set_cmd_sfunc (c
, set_width_command
);
2415 (add_set_cmd ("height", class_support
,
2416 var_uinteger
, (char *) &lines_per_page
,
2417 "Set number of lines gdb thinks are in a page.", &setlist
),
2422 /* If the output is not a terminal, don't paginate it. */
2423 if (!ui_file_isatty (gdb_stdout
))
2424 lines_per_page
= UINT_MAX
;
2426 set_width_command ((char *) NULL
, 0, c
);
2429 (add_set_cmd ("demangle", class_support
, var_boolean
,
2431 "Set demangling of encoded C++/ObjC names when displaying symbols.",
2436 (add_set_cmd ("pagination", class_support
,
2437 var_boolean
, (char *) &pagination_enabled
,
2438 "Set state of pagination.", &setlist
),
2443 add_com ("am", class_support
, pagination_on_command
,
2444 "Enable pagination");
2445 add_com ("sm", class_support
, pagination_off_command
,
2446 "Disable pagination");
2450 (add_set_cmd ("sevenbit-strings", class_support
, var_boolean
,
2451 (char *) &sevenbit_strings
,
2452 "Set printing of 8-bit characters in strings as \\nnn.",
2457 (add_set_cmd ("asm-demangle", class_support
, var_boolean
,
2458 (char *) &asm_demangle
,
2459 "Set demangling of C++/ObjC names in disassembly listings.",
2464 /* Machine specific function to handle SIGWINCH signal. */
2466 #ifdef SIGWINCH_HANDLER_BODY
2467 SIGWINCH_HANDLER_BODY
2470 /* print routines to handle variable size regs, etc. */
2472 /* temporary storage using circular buffer */
2478 static char buf
[NUMCELLS
][CELLSIZE
];
2479 static int cell
= 0;
2480 if (++cell
>= NUMCELLS
)
2488 return (TARGET_ADDR_BIT
/ 8 * 2);
2492 paddr (CORE_ADDR addr
)
2494 return phex (addr
, TARGET_ADDR_BIT
/ 8);
2498 paddr_nz (CORE_ADDR addr
)
2500 return phex_nz (addr
, TARGET_ADDR_BIT
/ 8);
2504 decimal2str (char *paddr_str
, char *sign
, ULONGEST addr
)
2506 /* steal code from valprint.c:print_decimal(). Should this worry
2507 about the real size of addr as the above does? */
2508 unsigned long temp
[3];
2512 temp
[i
] = addr
% (1000 * 1000 * 1000);
2513 addr
/= (1000 * 1000 * 1000);
2516 while (addr
!= 0 && i
< (sizeof (temp
) / sizeof (temp
[0])));
2520 sprintf (paddr_str
, "%s%lu",
2524 sprintf (paddr_str
, "%s%lu%09lu",
2525 sign
, temp
[1], temp
[0]);
2528 sprintf (paddr_str
, "%s%lu%09lu%09lu",
2529 sign
, temp
[2], temp
[1], temp
[0]);
2532 internal_error (__FILE__
, __LINE__
, "failed internal consistency check");
2537 paddr_u (CORE_ADDR addr
)
2539 char *paddr_str
= get_cell ();
2540 decimal2str (paddr_str
, "", addr
);
2545 paddr_d (LONGEST addr
)
2547 char *paddr_str
= get_cell ();
2549 decimal2str (paddr_str
, "-", -addr
);
2551 decimal2str (paddr_str
, "", addr
);
2555 /* eliminate warning from compiler on 32-bit systems */
2556 static int thirty_two
= 32;
2559 phex (ULONGEST l
, int sizeof_l
)
2566 sprintf (str
, "%08lx%08lx",
2567 (unsigned long) (l
>> thirty_two
),
2568 (unsigned long) (l
& 0xffffffff));
2572 sprintf (str
, "%08lx", (unsigned long) l
);
2576 sprintf (str
, "%04x", (unsigned short) (l
& 0xffff));
2579 str
= phex (l
, sizeof (l
));
2586 phex_nz (ULONGEST l
, int sizeof_l
)
2593 unsigned long high
= (unsigned long) (l
>> thirty_two
);
2596 sprintf (str
, "%lx", (unsigned long) (l
& 0xffffffff));
2598 sprintf (str
, "%lx%08lx",
2599 high
, (unsigned long) (l
& 0xffffffff));
2604 sprintf (str
, "%lx", (unsigned long) l
);
2608 sprintf (str
, "%x", (unsigned short) (l
& 0xffff));
2611 str
= phex_nz (l
, sizeof (l
));
2618 /* Convert to / from the hosts pointer to GDB's internal CORE_ADDR
2619 using the target's conversion routines. */
2621 host_pointer_to_address (void *ptr
)
2623 gdb_assert (sizeof (ptr
) == TYPE_LENGTH (builtin_type_void_data_ptr
));
2624 return POINTER_TO_ADDRESS (builtin_type_void_data_ptr
, &ptr
);
2628 address_to_host_pointer (CORE_ADDR addr
)
2632 gdb_assert (sizeof (ptr
) == TYPE_LENGTH (builtin_type_void_data_ptr
));
2633 ADDRESS_TO_POINTER (builtin_type_void_data_ptr
, &ptr
, addr
);
2637 /* Convert a CORE_ADDR into a string. */
2639 core_addr_to_string (const CORE_ADDR addr
)
2641 char *str
= get_cell ();
2643 strcat (str
, phex (addr
, sizeof (addr
)));
2648 core_addr_to_string_nz (const CORE_ADDR addr
)
2650 char *str
= get_cell ();
2652 strcat (str
, phex_nz (addr
, sizeof (addr
)));
2656 /* Convert a string back into a CORE_ADDR. */
2658 string_to_core_addr (const char *my_string
)
2661 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2663 /* Assume that it is in decimal. */
2665 for (i
= 2; my_string
[i
] != '\0'; i
++)
2667 if (isdigit (my_string
[i
]))
2668 addr
= (my_string
[i
] - '0') + (addr
* 16);
2669 else if (isxdigit (my_string
[i
]))
2670 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2672 internal_error (__FILE__
, __LINE__
, "invalid hex");
2677 /* Assume that it is in decimal. */
2679 for (i
= 0; my_string
[i
] != '\0'; i
++)
2681 if (isdigit (my_string
[i
]))
2682 addr
= (my_string
[i
] - '0') + (addr
* 10);
2684 internal_error (__FILE__
, __LINE__
, "invalid decimal");
2691 gdb_realpath (const char *filename
)
2693 /* Method 1: The system has a compile time upper bound on a filename
2694 path. Use that and realpath() to canonicalize the name. This is
2695 the most common case. Note that, if there isn't a compile time
2696 upper bound, you want to avoid realpath() at all costs. */
2697 #if defined(HAVE_REALPATH)
2699 # if defined (PATH_MAX)
2701 # define USE_REALPATH
2702 # elif defined (MAXPATHLEN)
2703 char buf
[MAXPATHLEN
];
2704 # define USE_REALPATH
2706 # if defined (USE_REALPATH)
2707 const char *rp
= realpath (filename
, buf
);
2710 return xstrdup (rp
);
2713 #endif /* HAVE_REALPATH */
2715 /* Method 2: The host system (i.e., GNU) has the function
2716 canonicalize_file_name() which malloc's a chunk of memory and
2717 returns that, use that. */
2718 #if defined(HAVE_CANONICALIZE_FILE_NAME)
2720 char *rp
= canonicalize_file_name (filename
);
2722 return xstrdup (filename
);
2728 /* FIXME: cagney/2002-11-13:
2730 Method 2a: Use realpath() with a NULL buffer. Some systems, due
2731 to the problems described in in method 3, have modified their
2732 realpath() implementation so that it will allocate a buffer when
2733 NULL is passed in. Before this can be used, though, some sort of
2734 configure time test would need to be added. Otherwize the code
2735 will likely core dump. */
2737 /* Method 3: Now we're getting desperate! The system doesn't have a
2738 compile time buffer size and no alternative function. Query the
2739 OS, using pathconf(), for the buffer limit. Care is needed
2740 though, some systems do not limit PATH_MAX (return -1 for
2741 pathconf()) making it impossible to pass a correctly sized buffer
2742 to realpath() (it could always overflow). On those systems, we
2744 #if defined (HAVE_REALPATH) && defined (HAVE_UNISTD_H) && defined(HAVE_ALLOCA)
2746 /* Find out the max path size. */
2747 long path_max
= pathconf ("/", _PC_PATH_MAX
);
2750 /* PATH_MAX is bounded. */
2751 char *buf
= alloca (path_max
);
2752 char *rp
= realpath (filename
, buf
);
2753 return xstrdup (rp
? rp
: filename
);
2758 /* This system is a lost cause, just dup the buffer. */
2759 return xstrdup (filename
);
2762 /* Return a copy of FILENAME, with its directory prefix canonicalized
2766 xfullpath (const char *filename
)
2768 const char *base_name
= lbasename (filename
);
2773 /* Extract the basename of filename, and return immediately
2774 a copy of filename if it does not contain any directory prefix. */
2775 if (base_name
== filename
)
2776 return xstrdup (filename
);
2778 dir_name
= alloca ((size_t) (base_name
- filename
+ 2));
2779 /* Allocate enough space to store the dir_name + plus one extra
2780 character sometimes needed under Windows (see below), and
2781 then the closing \000 character */
2782 strncpy (dir_name
, filename
, base_name
- filename
);
2783 dir_name
[base_name
- filename
] = '\000';
2785 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
2786 /* We need to be careful when filename is of the form 'd:foo', which
2787 is equivalent of d:./foo, which is totally different from d:/foo. */
2788 if (strlen (dir_name
) == 2 &&
2789 isalpha (dir_name
[0]) && dir_name
[1] == ':')
2792 dir_name
[3] = '\000';
2796 /* Canonicalize the directory prefix, and build the resulting
2797 filename. If the dirname realpath already contains an ending
2798 directory separator, avoid doubling it. */
2799 real_path
= gdb_realpath (dir_name
);
2800 if (IS_DIR_SEPARATOR (real_path
[strlen (real_path
) - 1]))
2801 result
= concat (real_path
, base_name
, NULL
);
2803 result
= concat (real_path
, SLASH_STRING
, base_name
, NULL
);