1 /* General utility routines for GDB, the GNU debugger.
2 Copyright 1986, 1989, 1990-1992, 1995, 1996, 1998, 2000, 2001
3 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
24 #include "gdb_string.h"
25 #include "event-top.h"
38 /* SunOS's curses.h has a '#define reg register' in it. Thank you Sun. */
49 #include "expression.h"
53 #include "inferior.h" /* for signed_pointer_to_address */
55 #include <readline/readline.h>
58 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
60 /* readline defines this. */
63 void (*error_begin_hook
) (void);
65 /* Holds the last error message issued by gdb */
67 static struct ui_file
*gdb_lasterr
;
69 /* Prototypes for local functions */
71 static void vfprintf_maybe_filtered (struct ui_file
*, const char *,
74 static void fputs_maybe_filtered (const char *, struct ui_file
*, int);
76 #if defined (USE_MMALLOC) && !defined (NO_MMCHECK)
77 static void malloc_botch (void);
80 static void prompt_for_continue (void);
82 static void set_width_command (char *, int, struct cmd_list_element
*);
84 static void set_width (void);
86 /* Chain of cleanup actions established with make_cleanup,
87 to be executed if an error happens. */
89 static struct cleanup
*cleanup_chain
; /* cleaned up after a failed command */
90 static struct cleanup
*final_cleanup_chain
; /* cleaned up when gdb exits */
91 static struct cleanup
*run_cleanup_chain
; /* cleaned up on each 'run' */
92 static struct cleanup
*exec_cleanup_chain
; /* cleaned up on each execution command */
93 /* cleaned up on each error from within an execution command */
94 static struct cleanup
*exec_error_cleanup_chain
;
96 /* Pointer to what is left to do for an execution command after the
97 target stops. Used only in asynchronous mode, by targets that
98 support async execution. The finish and until commands use it. So
99 does the target extended-remote command. */
100 struct continuation
*cmd_continuation
;
101 struct continuation
*intermediate_continuation
;
103 /* Nonzero if we have job control. */
107 /* Nonzero means a quit has been requested. */
111 /* Nonzero means quit immediately if Control-C is typed now, rather
112 than waiting until QUIT is executed. Be careful in setting this;
113 code which executes with immediate_quit set has to be very careful
114 about being able to deal with being interrupted at any time. It is
115 almost always better to use QUIT; the only exception I can think of
116 is being able to quit out of a system call (using EINTR loses if
117 the SIGINT happens between the previous QUIT and the system call).
118 To immediately quit in the case in which a SIGINT happens between
119 the previous QUIT and setting immediate_quit (desirable anytime we
120 expect to block), call QUIT after setting immediate_quit. */
124 /* Nonzero means that encoded C++ names should be printed out in their
125 C++ form rather than raw. */
129 /* Nonzero means that encoded C++ names should be printed out in their
130 C++ form even in assembler language displays. If this is set, but
131 DEMANGLE is zero, names are printed raw, i.e. DEMANGLE controls. */
133 int asm_demangle
= 0;
135 /* Nonzero means that strings with character values >0x7F should be printed
136 as octal escapes. Zero means just print the value (e.g. it's an
137 international character, and the terminal or window can cope.) */
139 int sevenbit_strings
= 0;
141 /* String to be printed before error messages, if any. */
143 char *error_pre_print
;
145 /* String to be printed before quit messages, if any. */
147 char *quit_pre_print
;
149 /* String to be printed before warning messages, if any. */
151 char *warning_pre_print
= "\nwarning: ";
153 int pagination_enabled
= 1;
156 /* Add a new cleanup to the cleanup_chain,
157 and return the previous chain pointer
158 to be passed later to do_cleanups or discard_cleanups.
159 Args are FUNCTION to clean up with, and ARG to pass to it. */
162 make_cleanup (make_cleanup_ftype
*function
, void *arg
)
164 return make_my_cleanup (&cleanup_chain
, function
, arg
);
168 make_final_cleanup (make_cleanup_ftype
*function
, void *arg
)
170 return make_my_cleanup (&final_cleanup_chain
, function
, arg
);
174 make_run_cleanup (make_cleanup_ftype
*function
, void *arg
)
176 return make_my_cleanup (&run_cleanup_chain
, function
, arg
);
180 make_exec_cleanup (make_cleanup_ftype
*function
, void *arg
)
182 return make_my_cleanup (&exec_cleanup_chain
, function
, arg
);
186 make_exec_error_cleanup (make_cleanup_ftype
*function
, void *arg
)
188 return make_my_cleanup (&exec_error_cleanup_chain
, function
, arg
);
192 do_freeargv (void *arg
)
194 freeargv ((char **) arg
);
198 make_cleanup_freeargv (char **arg
)
200 return make_my_cleanup (&cleanup_chain
, do_freeargv
, arg
);
204 do_bfd_close_cleanup (void *arg
)
210 make_cleanup_bfd_close (bfd
*abfd
)
212 return make_cleanup (do_bfd_close_cleanup
, abfd
);
216 do_close_cleanup (void *arg
)
222 make_cleanup_close (int fd
)
224 /* int into void*. Outch!! */
225 return make_cleanup (do_close_cleanup
, (void *) fd
);
229 do_ui_file_delete (void *arg
)
231 ui_file_delete (arg
);
235 make_cleanup_ui_file_delete (struct ui_file
*arg
)
237 return make_my_cleanup (&cleanup_chain
, do_ui_file_delete
, arg
);
241 make_my_cleanup (struct cleanup
**pmy_chain
, make_cleanup_ftype
*function
,
244 register struct cleanup
*new
245 = (struct cleanup
*) xmalloc (sizeof (struct cleanup
));
246 register struct cleanup
*old_chain
= *pmy_chain
;
248 new->next
= *pmy_chain
;
249 new->function
= function
;
256 /* Discard cleanups and do the actions they describe
257 until we get back to the point OLD_CHAIN in the cleanup_chain. */
260 do_cleanups (register struct cleanup
*old_chain
)
262 do_my_cleanups (&cleanup_chain
, old_chain
);
266 do_final_cleanups (register struct cleanup
*old_chain
)
268 do_my_cleanups (&final_cleanup_chain
, old_chain
);
272 do_run_cleanups (register struct cleanup
*old_chain
)
274 do_my_cleanups (&run_cleanup_chain
, old_chain
);
278 do_exec_cleanups (register struct cleanup
*old_chain
)
280 do_my_cleanups (&exec_cleanup_chain
, old_chain
);
284 do_exec_error_cleanups (register struct cleanup
*old_chain
)
286 do_my_cleanups (&exec_error_cleanup_chain
, old_chain
);
290 do_my_cleanups (register struct cleanup
**pmy_chain
,
291 register struct cleanup
*old_chain
)
293 register struct cleanup
*ptr
;
294 while ((ptr
= *pmy_chain
) != old_chain
)
296 *pmy_chain
= ptr
->next
; /* Do this first incase recursion */
297 (*ptr
->function
) (ptr
->arg
);
302 /* Discard cleanups, not doing the actions they describe,
303 until we get back to the point OLD_CHAIN in the cleanup_chain. */
306 discard_cleanups (register struct cleanup
*old_chain
)
308 discard_my_cleanups (&cleanup_chain
, old_chain
);
312 discard_final_cleanups (register struct cleanup
*old_chain
)
314 discard_my_cleanups (&final_cleanup_chain
, old_chain
);
318 discard_exec_error_cleanups (register struct cleanup
*old_chain
)
320 discard_my_cleanups (&exec_error_cleanup_chain
, old_chain
);
324 discard_my_cleanups (register struct cleanup
**pmy_chain
,
325 register struct cleanup
*old_chain
)
327 register struct cleanup
*ptr
;
328 while ((ptr
= *pmy_chain
) != old_chain
)
330 *pmy_chain
= ptr
->next
;
335 /* Set the cleanup_chain to 0, and return the old cleanup chain. */
339 return save_my_cleanups (&cleanup_chain
);
343 save_final_cleanups (void)
345 return save_my_cleanups (&final_cleanup_chain
);
349 save_my_cleanups (struct cleanup
**pmy_chain
)
351 struct cleanup
*old_chain
= *pmy_chain
;
357 /* Restore the cleanup chain from a previously saved chain. */
359 restore_cleanups (struct cleanup
*chain
)
361 restore_my_cleanups (&cleanup_chain
, chain
);
365 restore_final_cleanups (struct cleanup
*chain
)
367 restore_my_cleanups (&final_cleanup_chain
, chain
);
371 restore_my_cleanups (struct cleanup
**pmy_chain
, struct cleanup
*chain
)
376 /* This function is useful for cleanups.
380 old_chain = make_cleanup (free_current_contents, &foo);
382 to arrange to free the object thus allocated. */
385 free_current_contents (void *ptr
)
387 void **location
= ptr
;
388 if (location
== NULL
)
389 internal_error ("free_current_contents: NULL pointer");
390 if (*location
!= NULL
)
397 /* Provide a known function that does nothing, to use as a base for
398 for a possibly long chain of cleanups. This is useful where we
399 use the cleanup chain for handling normal cleanups as well as dealing
400 with cleanups that need to be done as a result of a call to error().
401 In such cases, we may not be certain where the first cleanup is, unless
402 we have a do-nothing one to always use as the base. */
406 null_cleanup (void *arg
)
410 /* Add a continuation to the continuation list, the global list
411 cmd_continuation. The new continuation will be added at the front.*/
413 add_continuation (void (*continuation_hook
) (struct continuation_arg
*),
414 struct continuation_arg
*arg_list
)
416 struct continuation
*continuation_ptr
;
418 continuation_ptr
= (struct continuation
*) xmalloc (sizeof (struct continuation
));
419 continuation_ptr
->continuation_hook
= continuation_hook
;
420 continuation_ptr
->arg_list
= arg_list
;
421 continuation_ptr
->next
= cmd_continuation
;
422 cmd_continuation
= continuation_ptr
;
425 /* Walk down the cmd_continuation list, and execute all the
426 continuations. There is a problem though. In some cases new
427 continuations may be added while we are in the middle of this
428 loop. If this happens they will be added in the front, and done
429 before we have a chance of exhausting those that were already
430 there. We need to then save the beginning of the list in a pointer
431 and do the continuations from there on, instead of using the
432 global beginning of list as our iteration pointer.*/
434 do_all_continuations (void)
436 struct continuation
*continuation_ptr
;
437 struct continuation
*saved_continuation
;
439 /* Copy the list header into another pointer, and set the global
440 list header to null, so that the global list can change as a side
441 effect of invoking the continuations and the processing of
442 the preexisting continuations will not be affected. */
443 continuation_ptr
= cmd_continuation
;
444 cmd_continuation
= NULL
;
446 /* Work now on the list we have set aside. */
447 while (continuation_ptr
)
449 (continuation_ptr
->continuation_hook
) (continuation_ptr
->arg_list
);
450 saved_continuation
= continuation_ptr
;
451 continuation_ptr
= continuation_ptr
->next
;
452 xfree (saved_continuation
);
456 /* Walk down the cmd_continuation list, and get rid of all the
459 discard_all_continuations (void)
461 struct continuation
*continuation_ptr
;
463 while (cmd_continuation
)
465 continuation_ptr
= cmd_continuation
;
466 cmd_continuation
= continuation_ptr
->next
;
467 xfree (continuation_ptr
);
471 /* Add a continuation to the continuation list, the global list
472 intermediate_continuation. The new continuation will be added at the front.*/
474 add_intermediate_continuation (void (*continuation_hook
)
475 (struct continuation_arg
*),
476 struct continuation_arg
*arg_list
)
478 struct continuation
*continuation_ptr
;
480 continuation_ptr
= (struct continuation
*) xmalloc (sizeof (struct continuation
));
481 continuation_ptr
->continuation_hook
= continuation_hook
;
482 continuation_ptr
->arg_list
= arg_list
;
483 continuation_ptr
->next
= intermediate_continuation
;
484 intermediate_continuation
= continuation_ptr
;
487 /* Walk down the cmd_continuation list, and execute all the
488 continuations. There is a problem though. In some cases new
489 continuations may be added while we are in the middle of this
490 loop. If this happens they will be added in the front, and done
491 before we have a chance of exhausting those that were already
492 there. We need to then save the beginning of the list in a pointer
493 and do the continuations from there on, instead of using the
494 global beginning of list as our iteration pointer.*/
496 do_all_intermediate_continuations (void)
498 struct continuation
*continuation_ptr
;
499 struct continuation
*saved_continuation
;
501 /* Copy the list header into another pointer, and set the global
502 list header to null, so that the global list can change as a side
503 effect of invoking the continuations and the processing of
504 the preexisting continuations will not be affected. */
505 continuation_ptr
= intermediate_continuation
;
506 intermediate_continuation
= NULL
;
508 /* Work now on the list we have set aside. */
509 while (continuation_ptr
)
511 (continuation_ptr
->continuation_hook
) (continuation_ptr
->arg_list
);
512 saved_continuation
= continuation_ptr
;
513 continuation_ptr
= continuation_ptr
->next
;
514 xfree (saved_continuation
);
518 /* Walk down the cmd_continuation list, and get rid of all the
521 discard_all_intermediate_continuations (void)
523 struct continuation
*continuation_ptr
;
525 while (intermediate_continuation
)
527 continuation_ptr
= intermediate_continuation
;
528 intermediate_continuation
= continuation_ptr
->next
;
529 xfree (continuation_ptr
);
535 /* Print a warning message. Way to use this is to call warning_begin,
536 output the warning message (use unfiltered output to gdb_stderr),
537 ending in a newline. There is not currently a warning_end that you
538 call afterwards, but such a thing might be added if it is useful
539 for a GUI to separate warning messages from other output.
541 FIXME: Why do warnings use unfiltered output and errors filtered?
542 Is this anything other than a historical accident? */
547 target_terminal_ours ();
548 wrap_here (""); /* Force out any buffered output */
549 gdb_flush (gdb_stdout
);
550 if (warning_pre_print
)
551 fprintf_unfiltered (gdb_stderr
, warning_pre_print
);
554 /* Print a warning message.
555 The first argument STRING is the warning message, used as a fprintf string,
556 and the remaining args are passed as arguments to it.
557 The primary difference between warnings and errors is that a warning
558 does not force the return to command level. */
561 warning (const char *string
,...)
564 va_start (args
, string
);
566 (*warning_hook
) (string
, args
);
570 vfprintf_unfiltered (gdb_stderr
, string
, args
);
571 fprintf_unfiltered (gdb_stderr
, "\n");
576 /* Start the printing of an error message. Way to use this is to call
577 this, output the error message (use filtered output to gdb_stderr
578 (FIXME: Some callers, like memory_error, use gdb_stdout)), ending
579 in a newline, and then call return_to_top_level (RETURN_ERROR).
580 error() provides a convenient way to do this for the special case
581 that the error message can be formatted with a single printf call,
582 but this is more general. */
586 if (error_begin_hook
)
589 target_terminal_ours ();
590 wrap_here (""); /* Force out any buffered output */
591 gdb_flush (gdb_stdout
);
593 annotate_error_begin ();
596 fprintf_filtered (gdb_stderr
, error_pre_print
);
599 /* Print an error message and return to command level.
600 The first argument STRING is the error message, used as a fprintf string,
601 and the remaining args are passed as arguments to it. */
604 verror (const char *string
, va_list args
)
607 struct cleanup
*err_string_cleanup
;
608 /* FIXME: cagney/1999-11-10: All error calls should come here.
609 Unfortunately some code uses the sequence: error_begin(); print
610 error message; return_to_top_level. That code should be
613 /* NOTE: It's tempting to just do the following...
614 vfprintf_filtered (gdb_stderr, string, args);
615 and then follow with a similar looking statement to cause the message
616 to also go to gdb_lasterr. But if we do this, we'll be traversing the
617 va_list twice which works on some platforms and fails miserably on
619 /* Save it as the last error */
620 ui_file_rewind (gdb_lasterr
);
621 vfprintf_filtered (gdb_lasterr
, string
, args
);
622 /* Retrieve the last error and print it to gdb_stderr */
623 err_string
= error_last_message ();
624 err_string_cleanup
= make_cleanup (xfree
, err_string
);
625 fputs_filtered (err_string
, gdb_stderr
);
626 fprintf_filtered (gdb_stderr
, "\n");
627 do_cleanups (err_string_cleanup
);
628 return_to_top_level (RETURN_ERROR
);
632 error (const char *string
,...)
635 va_start (args
, string
);
636 verror (string
, args
);
641 error_stream (struct ui_file
*stream
)
644 char *msg
= ui_file_xstrdup (stream
, &size
);
645 make_cleanup (xfree
, msg
);
649 /* Get the last error message issued by gdb */
652 error_last_message (void)
655 return ui_file_xstrdup (gdb_lasterr
, &len
);
658 /* This is to be called by main() at the very beginning */
663 gdb_lasterr
= mem_fileopen ();
666 /* Print a message reporting an internal error. Ask the user if they
667 want to continue, dump core, or just exit. */
670 internal_verror (const char *fmt
, va_list ap
)
672 static char msg
[] = "Internal GDB error: recursive internal error.\n";
673 static int dejavu
= 0;
677 /* don't allow infinite error recursion. */
685 fputs_unfiltered (msg
, gdb_stderr
);
689 write (STDERR_FILENO
, msg
, sizeof (msg
));
693 /* Try to get the message out */
694 target_terminal_ours ();
695 fputs_unfiltered ("gdb-internal-error: ", gdb_stderr
);
696 vfprintf_unfiltered (gdb_stderr
, fmt
, ap
);
697 fputs_unfiltered ("\n", gdb_stderr
);
699 /* Default (no case) is to quit GDB. When in batch mode this
700 lessens the likelhood of GDB going into an infinate loop. */
701 continue_p
= query ("\
702 An internal GDB error was detected. This may make further\n\
703 debugging unreliable. Continue this debugging session? ");
705 /* Default (no case) is to not dump core. Lessen the chance of GDB
706 leaving random core files around. */
707 dump_core_p
= query ("\
708 Create a core file containing the current state of GDB? ");
727 return_to_top_level (RETURN_ERROR
);
731 internal_error (char *string
, ...)
734 va_start (ap
, string
);
736 internal_verror (string
, ap
);
740 /* The strerror() function can return NULL for errno values that are
741 out of range. Provide a "safe" version that always returns a
745 safe_strerror (int errnum
)
750 if ((msg
= strerror (errnum
)) == NULL
)
752 sprintf (buf
, "(undocumented errno %d)", errnum
);
758 /* Print the system error message for errno, and also mention STRING
759 as the file name for which the error was encountered.
760 Then return to command level. */
763 perror_with_name (char *string
)
768 err
= safe_strerror (errno
);
769 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
770 strcpy (combined
, string
);
771 strcat (combined
, ": ");
772 strcat (combined
, err
);
774 /* I understand setting these is a matter of taste. Still, some people
775 may clear errno but not know about bfd_error. Doing this here is not
777 bfd_set_error (bfd_error_no_error
);
780 error ("%s.", combined
);
783 /* Print the system error message for ERRCODE, and also mention STRING
784 as the file name for which the error was encountered. */
787 print_sys_errmsg (char *string
, int errcode
)
792 err
= safe_strerror (errcode
);
793 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
794 strcpy (combined
, string
);
795 strcat (combined
, ": ");
796 strcat (combined
, err
);
798 /* We want anything which was printed on stdout to come out first, before
800 gdb_flush (gdb_stdout
);
801 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
804 /* Control C eventually causes this to be called, at a convenient time. */
809 serial_t gdb_stdout_serial
= serial_fdopen (1);
811 target_terminal_ours ();
813 /* We want all output to appear now, before we print "Quit". We
814 have 3 levels of buffering we have to flush (it's possible that
815 some of these should be changed to flush the lower-level ones
818 /* 1. The _filtered buffer. */
819 wrap_here ((char *) 0);
821 /* 2. The stdio buffer. */
822 gdb_flush (gdb_stdout
);
823 gdb_flush (gdb_stderr
);
825 /* 3. The system-level buffer. */
826 SERIAL_DRAIN_OUTPUT (gdb_stdout_serial
);
827 SERIAL_UN_FDOPEN (gdb_stdout_serial
);
829 annotate_error_begin ();
831 /* Don't use *_filtered; we don't want to prompt the user to continue. */
833 fprintf_unfiltered (gdb_stderr
, quit_pre_print
);
836 /* No steenking SIGINT will ever be coming our way when the
837 program is resumed. Don't lie. */
838 fprintf_unfiltered (gdb_stderr
, "Quit\n");
841 /* If there is no terminal switching for this target, then we can't
842 possibly get screwed by the lack of job control. */
843 || current_target
.to_terminal_ours
== NULL
)
844 fprintf_unfiltered (gdb_stderr
, "Quit\n");
846 fprintf_unfiltered (gdb_stderr
,
847 "Quit (expect signal SIGINT when the program is resumed)\n");
849 return_to_top_level (RETURN_QUIT
);
853 #if defined(_MSC_VER) /* should test for wingdb instead? */
856 * Windows translates all keyboard and mouse events
857 * into a message which is appended to the message
858 * queue for the process.
864 int k
= win32pollquit ();
871 #else /* !defined(_MSC_VER) */
876 /* Done by signals */
879 #endif /* !defined(_MSC_VER) */
881 /* Control C comes here */
883 request_quit (int signo
)
886 /* Restore the signal handler. Harmless with BSD-style signals, needed
887 for System V-style signals. So just always do it, rather than worrying
888 about USG defines and stuff like that. */
889 signal (signo
, request_quit
);
899 /* Memory management stuff (malloc friends). */
901 /* Make a substitute size_t for non-ANSI compilers. */
903 #ifndef HAVE_STDDEF_H
905 #define size_t unsigned int
909 #if !defined (USE_MMALLOC)
912 mcalloc (PTR md
, size_t number
, size_t size
)
914 return calloc (number
, size
);
918 mmalloc (PTR md
, size_t size
)
920 return malloc (size
);
924 mrealloc (PTR md
, PTR ptr
, size_t size
)
926 if (ptr
== 0) /* Guard against old realloc's */
927 return malloc (size
);
929 return realloc (ptr
, size
);
933 mfree (PTR md
, PTR ptr
)
938 #endif /* USE_MMALLOC */
940 #if !defined (USE_MMALLOC) || defined (NO_MMCHECK)
943 init_malloc (void *md
)
947 #else /* Have mmalloc and want corruption checking */
952 fprintf_unfiltered (gdb_stderr
, "Memory corruption\n");
956 /* Attempt to install hooks in mmalloc/mrealloc/mfree for the heap specified
957 by MD, to detect memory corruption. Note that MD may be NULL to specify
958 the default heap that grows via sbrk.
960 Note that for freshly created regions, we must call mmcheckf prior to any
961 mallocs in the region. Otherwise, any region which was allocated prior to
962 installing the checking hooks, which is later reallocated or freed, will
963 fail the checks! The mmcheck function only allows initial hooks to be
964 installed before the first mmalloc. However, anytime after we have called
965 mmcheck the first time to install the checking hooks, we can call it again
966 to update the function pointer to the memory corruption handler.
968 Returns zero on failure, non-zero on success. */
970 #ifndef MMCHECK_FORCE
971 #define MMCHECK_FORCE 0
975 init_malloc (void *md
)
977 if (!mmcheckf (md
, malloc_botch
, MMCHECK_FORCE
))
979 /* Don't use warning(), which relies on current_target being set
980 to something other than dummy_target, until after
981 initialize_all_files(). */
984 (gdb_stderr
, "warning: failed to install memory consistency checks; ");
986 (gdb_stderr
, "configuration should define NO_MMCHECK or MMCHECK_FORCE\n");
992 #endif /* Have mmalloc and want corruption checking */
994 /* Called when a memory allocation fails, with the number of bytes of
995 memory requested in SIZE. */
1002 internal_error ("virtual memory exhausted: can't allocate %ld bytes.", size
);
1006 internal_error ("virtual memory exhausted.");
1010 /* Like mmalloc but get error if no storage available, and protect against
1011 the caller wanting to allocate zero bytes. Whether to return NULL for
1012 a zero byte request, or translate the request into a request for one
1013 byte of zero'd storage, is a religious issue. */
1016 xmmalloc (PTR md
, long size
)
1024 else if ((val
= mmalloc (md
, size
)) == NULL
)
1031 /* Like mrealloc but get error if no storage available. */
1034 xmrealloc (PTR md
, PTR ptr
, long size
)
1040 val
= mrealloc (md
, ptr
, size
);
1044 val
= mmalloc (md
, size
);
1053 /* Like malloc but get error if no storage available, and protect against
1054 the caller wanting to allocate zero bytes. */
1057 xmalloc (size_t size
)
1059 return (xmmalloc ((PTR
) NULL
, size
));
1062 /* Like calloc but get error if no storage available */
1065 xcalloc (size_t number
, size_t size
)
1067 void *mem
= mcalloc (NULL
, number
, size
);
1069 nomem (number
* size
);
1073 /* Like mrealloc but get error if no storage available. */
1076 xrealloc (PTR ptr
, size_t size
)
1078 return (xmrealloc ((PTR
) NULL
, ptr
, size
));
1081 /* Free up space allocated by one of xmalloc(), xcalloc(), or
1092 /* Like asprintf/vasprintf but get an internal_error if the call
1096 xasprintf (char **ret
, const char *format
, ...)
1099 va_start (args
, format
);
1100 xvasprintf (ret
, format
, args
);
1105 xvasprintf (char **ret
, const char *format
, va_list ap
)
1107 int status
= vasprintf (ret
, format
, ap
);
1108 /* NULL could be returned due to a memory allocation problem; a
1109 badly format string; or something else. */
1111 internal_error ("%s:%d: vasprintf returned NULL buffer (errno %d)",
1112 __FILE__
, __LINE__
, errno
);
1113 /* A negative status with a non-NULL buffer shouldn't never
1114 happen. But to be sure. */
1116 internal_error ("%s:%d: vasprintf call failed (errno %d)",
1117 __FILE__
, __LINE__
, errno
);
1121 /* My replacement for the read system call.
1122 Used like `read' but keeps going if `read' returns too soon. */
1125 myread (int desc
, char *addr
, int len
)
1132 val
= read (desc
, addr
, len
);
1136 return orglen
- len
;
1143 /* Make a copy of the string at PTR with SIZE characters
1144 (and add a null character at the end in the copy).
1145 Uses malloc to get the space. Returns the address of the copy. */
1148 savestring (const char *ptr
, int size
)
1150 register char *p
= (char *) xmalloc (size
+ 1);
1151 memcpy (p
, ptr
, size
);
1157 msavestring (void *md
, const char *ptr
, int size
)
1159 register char *p
= (char *) xmmalloc (md
, size
+ 1);
1160 memcpy (p
, ptr
, size
);
1166 mstrsave (void *md
, const char *ptr
)
1168 return (msavestring (md
, ptr
, strlen (ptr
)));
1172 print_spaces (register int n
, register struct ui_file
*file
)
1174 fputs_unfiltered (n_spaces (n
), file
);
1177 /* Print a host address. */
1180 gdb_print_host_address (void *addr
, struct ui_file
*stream
)
1183 /* We could use the %p conversion specifier to fprintf if we had any
1184 way of knowing whether this host supports it. But the following
1185 should work on the Alpha and on 32 bit machines. */
1187 fprintf_filtered (stream
, "0x%lx", (unsigned long) addr
);
1190 /* Ask user a y-or-n question and return 1 iff answer is yes.
1191 Takes three args which are given to printf to print the question.
1192 The first, a control string, should end in "? ".
1193 It should not say how to answer, because we do that. */
1197 query (char *ctlstr
,...)
1200 register int answer
;
1204 va_start (args
, ctlstr
);
1208 return query_hook (ctlstr
, args
);
1211 /* Automatically answer "yes" if input is not from a terminal. */
1212 if (!input_from_terminal_p ())
1215 /* FIXME Automatically answer "yes" if called from MacGDB. */
1222 wrap_here (""); /* Flush any buffered output */
1223 gdb_flush (gdb_stdout
);
1225 if (annotation_level
> 1)
1226 printf_filtered ("\n\032\032pre-query\n");
1228 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
1229 printf_filtered ("(y or n) ");
1231 if (annotation_level
> 1)
1232 printf_filtered ("\n\032\032query\n");
1235 /* If not in MacGDB, move to a new line so the entered line doesn't
1236 have a prompt on the front of it. */
1238 fputs_unfiltered ("\n", gdb_stdout
);
1242 gdb_flush (gdb_stdout
);
1245 if (!tui_version
|| cmdWin
== tuiWinWithFocus ())
1247 answer
= fgetc (stdin
);
1250 answer
= (unsigned char) tuiBufferGetc ();
1253 clearerr (stdin
); /* in case of C-d */
1254 if (answer
== EOF
) /* C-d */
1259 /* Eat rest of input line, to EOF or newline */
1260 if ((answer
!= '\n') || (tui_version
&& answer
!= '\r'))
1264 if (!tui_version
|| cmdWin
== tuiWinWithFocus ())
1266 ans2
= fgetc (stdin
);
1269 ans2
= (unsigned char) tuiBufferGetc ();
1273 while (ans2
!= EOF
&& ans2
!= '\n' && ans2
!= '\r');
1274 TUIDO (((TuiOpaqueFuncPtr
) tui_vStartNewLines
, 1));
1288 printf_filtered ("Please answer y or n.\n");
1291 if (annotation_level
> 1)
1292 printf_filtered ("\n\032\032post-query\n");
1297 /* Parse a C escape sequence. STRING_PTR points to a variable
1298 containing a pointer to the string to parse. That pointer
1299 should point to the character after the \. That pointer
1300 is updated past the characters we use. The value of the
1301 escape sequence is returned.
1303 A negative value means the sequence \ newline was seen,
1304 which is supposed to be equivalent to nothing at all.
1306 If \ is followed by a null character, we return a negative
1307 value and leave the string pointer pointing at the null character.
1309 If \ is followed by 000, we return 0 and leave the string pointer
1310 after the zeros. A value of 0 does not mean end of string. */
1313 parse_escape (char **string_ptr
)
1315 register int c
= *(*string_ptr
)++;
1319 return 007; /* Bell (alert) char */
1322 case 'e': /* Escape character */
1340 c
= *(*string_ptr
)++;
1342 c
= parse_escape (string_ptr
);
1345 return (c
& 0200) | (c
& 037);
1356 register int i
= c
- '0';
1357 register int count
= 0;
1360 if ((c
= *(*string_ptr
)++) >= '0' && c
<= '7')
1378 /* Print the character C on STREAM as part of the contents of a literal
1379 string whose delimiter is QUOTER. Note that this routine should only
1380 be call for printing things which are independent of the language
1381 of the program being debugged. */
1384 printchar (int c
, void (*do_fputs
) (const char *, struct ui_file
*),
1385 void (*do_fprintf
) (struct ui_file
*, const char *, ...),
1386 struct ui_file
*stream
, int quoter
)
1389 c
&= 0xFF; /* Avoid sign bit follies */
1391 if (c
< 0x20 || /* Low control chars */
1392 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1393 (sevenbit_strings
&& c
>= 0x80))
1394 { /* high order bit set */
1398 do_fputs ("\\n", stream
);
1401 do_fputs ("\\b", stream
);
1404 do_fputs ("\\t", stream
);
1407 do_fputs ("\\f", stream
);
1410 do_fputs ("\\r", stream
);
1413 do_fputs ("\\e", stream
);
1416 do_fputs ("\\a", stream
);
1419 do_fprintf (stream
, "\\%.3o", (unsigned int) c
);
1425 if (c
== '\\' || c
== quoter
)
1426 do_fputs ("\\", stream
);
1427 do_fprintf (stream
, "%c", c
);
1431 /* Print the character C on STREAM as part of the contents of a
1432 literal string whose delimiter is QUOTER. Note that these routines
1433 should only be call for printing things which are independent of
1434 the language of the program being debugged. */
1437 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1440 printchar (*str
++, fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1444 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1447 printchar (*str
++, fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1451 fputstrn_unfiltered (const char *str
, int n
, int quoter
, struct ui_file
*stream
)
1454 for (i
= 0; i
< n
; i
++)
1455 printchar (str
[i
], fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1460 /* Number of lines per page or UINT_MAX if paging is disabled. */
1461 static unsigned int lines_per_page
;
1462 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1463 static unsigned int chars_per_line
;
1464 /* Current count of lines printed on this page, chars on this line. */
1465 static unsigned int lines_printed
, chars_printed
;
1467 /* Buffer and start column of buffered text, for doing smarter word-
1468 wrapping. When someone calls wrap_here(), we start buffering output
1469 that comes through fputs_filtered(). If we see a newline, we just
1470 spit it out and forget about the wrap_here(). If we see another
1471 wrap_here(), we spit it out and remember the newer one. If we see
1472 the end of the line, we spit out a newline, the indent, and then
1473 the buffered output. */
1475 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1476 are waiting to be output (they have already been counted in chars_printed).
1477 When wrap_buffer[0] is null, the buffer is empty. */
1478 static char *wrap_buffer
;
1480 /* Pointer in wrap_buffer to the next character to fill. */
1481 static char *wrap_pointer
;
1483 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1485 static char *wrap_indent
;
1487 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1488 is not in effect. */
1489 static int wrap_column
;
1492 /* Inialize the lines and chars per page */
1494 init_page_info (void)
1497 if (tui_version
&& m_winPtrNotNull (cmdWin
))
1499 lines_per_page
= cmdWin
->generic
.height
;
1500 chars_per_line
= cmdWin
->generic
.width
;
1505 /* These defaults will be used if we are unable to get the correct
1506 values from termcap. */
1507 #if defined(__GO32__)
1508 lines_per_page
= ScreenRows ();
1509 chars_per_line
= ScreenCols ();
1511 lines_per_page
= 24;
1512 chars_per_line
= 80;
1514 #if !defined (MPW) && !defined (_WIN32)
1515 /* No termcap under MPW, although might be cool to do something
1516 by looking at worksheet or console window sizes. */
1517 /* Initialize the screen height and width from termcap. */
1519 char *termtype
= getenv ("TERM");
1521 /* Positive means success, nonpositive means failure. */
1524 /* 2048 is large enough for all known terminals, according to the
1525 GNU termcap manual. */
1526 char term_buffer
[2048];
1530 status
= tgetent (term_buffer
, termtype
);
1534 int running_in_emacs
= getenv ("EMACS") != NULL
;
1536 val
= tgetnum ("li");
1537 if (val
>= 0 && !running_in_emacs
)
1538 lines_per_page
= val
;
1540 /* The number of lines per page is not mentioned
1541 in the terminal description. This probably means
1542 that paging is not useful (e.g. emacs shell window),
1543 so disable paging. */
1544 lines_per_page
= UINT_MAX
;
1546 val
= tgetnum ("co");
1548 chars_per_line
= val
;
1554 #if defined(SIGWINCH) && defined(SIGWINCH_HANDLER)
1556 /* If there is a better way to determine the window size, use it. */
1557 SIGWINCH_HANDLER (SIGWINCH
);
1560 /* If the output is not a terminal, don't paginate it. */
1561 if (!ui_file_isatty (gdb_stdout
))
1562 lines_per_page
= UINT_MAX
;
1563 } /* the command_line_version */
1570 if (chars_per_line
== 0)
1575 wrap_buffer
= (char *) xmalloc (chars_per_line
+ 2);
1576 wrap_buffer
[0] = '\0';
1579 wrap_buffer
= (char *) xrealloc (wrap_buffer
, chars_per_line
+ 2);
1580 wrap_pointer
= wrap_buffer
; /* Start it at the beginning */
1585 set_width_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1590 /* Wait, so the user can read what's on the screen. Prompt the user
1591 to continue by pressing RETURN. */
1594 prompt_for_continue (void)
1597 char cont_prompt
[120];
1599 if (annotation_level
> 1)
1600 printf_unfiltered ("\n\032\032pre-prompt-for-continue\n");
1602 strcpy (cont_prompt
,
1603 "---Type <return> to continue, or q <return> to quit---");
1604 if (annotation_level
> 1)
1605 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1607 /* We must do this *before* we call gdb_readline, else it will eventually
1608 call us -- thinking that we're trying to print beyond the end of the
1610 reinitialize_more_filter ();
1613 /* On a real operating system, the user can quit with SIGINT.
1616 'q' is provided on all systems so users don't have to change habits
1617 from system to system, and because telling them what to do in
1618 the prompt is more user-friendly than expecting them to think of
1620 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1621 whereas control-C to gdb_readline will cause the user to get dumped
1623 ignore
= readline (cont_prompt
);
1625 if (annotation_level
> 1)
1626 printf_unfiltered ("\n\032\032post-prompt-for-continue\n");
1631 while (*p
== ' ' || *p
== '\t')
1636 request_quit (SIGINT
);
1638 async_request_quit (0);
1644 /* Now we have to do this again, so that GDB will know that it doesn't
1645 need to save the ---Type <return>--- line at the top of the screen. */
1646 reinitialize_more_filter ();
1648 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1651 /* Reinitialize filter; ie. tell it to reset to original values. */
1654 reinitialize_more_filter (void)
1660 /* Indicate that if the next sequence of characters overflows the line,
1661 a newline should be inserted here rather than when it hits the end.
1662 If INDENT is non-null, it is a string to be printed to indent the
1663 wrapped part on the next line. INDENT must remain accessible until
1664 the next call to wrap_here() or until a newline is printed through
1667 If the line is already overfull, we immediately print a newline and
1668 the indentation, and disable further wrapping.
1670 If we don't know the width of lines, but we know the page height,
1671 we must not wrap words, but should still keep track of newlines
1672 that were explicitly printed.
1674 INDENT should not contain tabs, as that will mess up the char count
1675 on the next line. FIXME.
1677 This routine is guaranteed to force out any output which has been
1678 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1679 used to force out output from the wrap_buffer. */
1682 wrap_here (char *indent
)
1684 /* This should have been allocated, but be paranoid anyway. */
1690 *wrap_pointer
= '\0';
1691 fputs_unfiltered (wrap_buffer
, gdb_stdout
);
1693 wrap_pointer
= wrap_buffer
;
1694 wrap_buffer
[0] = '\0';
1695 if (chars_per_line
== UINT_MAX
) /* No line overflow checking */
1699 else if (chars_printed
>= chars_per_line
)
1701 puts_filtered ("\n");
1703 puts_filtered (indent
);
1708 wrap_column
= chars_printed
;
1712 wrap_indent
= indent
;
1716 /* Ensure that whatever gets printed next, using the filtered output
1717 commands, starts at the beginning of the line. I.E. if there is
1718 any pending output for the current line, flush it and start a new
1719 line. Otherwise do nothing. */
1724 if (chars_printed
> 0)
1726 puts_filtered ("\n");
1731 /* Like fputs but if FILTER is true, pause after every screenful.
1733 Regardless of FILTER can wrap at points other than the final
1734 character of a line.
1736 Unlike fputs, fputs_maybe_filtered does not return a value.
1737 It is OK for LINEBUFFER to be NULL, in which case just don't print
1740 Note that a longjmp to top level may occur in this routine (only if
1741 FILTER is true) (since prompt_for_continue may do so) so this
1742 routine should not be called when cleanups are not in place. */
1745 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1748 const char *lineptr
;
1750 if (linebuffer
== 0)
1753 /* Don't do any filtering if it is disabled. */
1754 if ((stream
!= gdb_stdout
) || !pagination_enabled
1755 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
))
1757 fputs_unfiltered (linebuffer
, stream
);
1761 /* Go through and output each character. Show line extension
1762 when this is necessary; prompt user for new page when this is
1765 lineptr
= linebuffer
;
1768 /* Possible new page. */
1770 (lines_printed
>= lines_per_page
- 1))
1771 prompt_for_continue ();
1773 while (*lineptr
&& *lineptr
!= '\n')
1775 /* Print a single line. */
1776 if (*lineptr
== '\t')
1779 *wrap_pointer
++ = '\t';
1781 fputc_unfiltered ('\t', stream
);
1782 /* Shifting right by 3 produces the number of tab stops
1783 we have already passed, and then adding one and
1784 shifting left 3 advances to the next tab stop. */
1785 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
1791 *wrap_pointer
++ = *lineptr
;
1793 fputc_unfiltered (*lineptr
, stream
);
1798 if (chars_printed
>= chars_per_line
)
1800 unsigned int save_chars
= chars_printed
;
1804 /* If we aren't actually wrapping, don't output newline --
1805 if chars_per_line is right, we probably just overflowed
1806 anyway; if it's wrong, let us keep going. */
1808 fputc_unfiltered ('\n', stream
);
1810 /* Possible new page. */
1811 if (lines_printed
>= lines_per_page
- 1)
1812 prompt_for_continue ();
1814 /* Now output indentation and wrapped string */
1817 fputs_unfiltered (wrap_indent
, stream
);
1818 *wrap_pointer
= '\0'; /* Null-terminate saved stuff */
1819 fputs_unfiltered (wrap_buffer
, stream
); /* and eject it */
1820 /* FIXME, this strlen is what prevents wrap_indent from
1821 containing tabs. However, if we recurse to print it
1822 and count its chars, we risk trouble if wrap_indent is
1823 longer than (the user settable) chars_per_line.
1824 Note also that this can set chars_printed > chars_per_line
1825 if we are printing a long string. */
1826 chars_printed
= strlen (wrap_indent
)
1827 + (save_chars
- wrap_column
);
1828 wrap_pointer
= wrap_buffer
; /* Reset buffer */
1829 wrap_buffer
[0] = '\0';
1830 wrap_column
= 0; /* And disable fancy wrap */
1835 if (*lineptr
== '\n')
1838 wrap_here ((char *) 0); /* Spit out chars, cancel further wraps */
1840 fputc_unfiltered ('\n', stream
);
1847 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
1849 fputs_maybe_filtered (linebuffer
, stream
, 1);
1853 putchar_unfiltered (int c
)
1856 ui_file_write (gdb_stdout
, &buf
, 1);
1861 fputc_unfiltered (int c
, struct ui_file
*stream
)
1864 ui_file_write (stream
, &buf
, 1);
1869 fputc_filtered (int c
, struct ui_file
*stream
)
1875 fputs_filtered (buf
, stream
);
1879 /* puts_debug is like fputs_unfiltered, except it prints special
1880 characters in printable fashion. */
1883 puts_debug (char *prefix
, char *string
, char *suffix
)
1887 /* Print prefix and suffix after each line. */
1888 static int new_line
= 1;
1889 static int return_p
= 0;
1890 static char *prev_prefix
= "";
1891 static char *prev_suffix
= "";
1893 if (*string
== '\n')
1896 /* If the prefix is changing, print the previous suffix, a new line,
1897 and the new prefix. */
1898 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
1900 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
1901 fputs_unfiltered ("\n", gdb_stdlog
);
1902 fputs_unfiltered (prefix
, gdb_stdlog
);
1905 /* Print prefix if we printed a newline during the previous call. */
1909 fputs_unfiltered (prefix
, gdb_stdlog
);
1912 prev_prefix
= prefix
;
1913 prev_suffix
= suffix
;
1915 /* Output characters in a printable format. */
1916 while ((ch
= *string
++) != '\0')
1922 fputc_unfiltered (ch
, gdb_stdlog
);
1925 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
1929 fputs_unfiltered ("\\\\", gdb_stdlog
);
1932 fputs_unfiltered ("\\b", gdb_stdlog
);
1935 fputs_unfiltered ("\\f", gdb_stdlog
);
1939 fputs_unfiltered ("\\n", gdb_stdlog
);
1942 fputs_unfiltered ("\\r", gdb_stdlog
);
1945 fputs_unfiltered ("\\t", gdb_stdlog
);
1948 fputs_unfiltered ("\\v", gdb_stdlog
);
1952 return_p
= ch
== '\r';
1955 /* Print suffix if we printed a newline. */
1958 fputs_unfiltered (suffix
, gdb_stdlog
);
1959 fputs_unfiltered ("\n", gdb_stdlog
);
1964 /* Print a variable number of ARGS using format FORMAT. If this
1965 information is going to put the amount written (since the last call
1966 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
1967 call prompt_for_continue to get the users permision to continue.
1969 Unlike fprintf, this function does not return a value.
1971 We implement three variants, vfprintf (takes a vararg list and stream),
1972 fprintf (takes a stream to write on), and printf (the usual).
1974 Note also that a longjmp to top level may occur in this routine
1975 (since prompt_for_continue may do so) so this routine should not be
1976 called when cleanups are not in place. */
1979 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
1980 va_list args
, int filter
)
1983 struct cleanup
*old_cleanups
;
1985 xvasprintf (&linebuffer
, format
, args
);
1986 old_cleanups
= make_cleanup (xfree
, linebuffer
);
1987 fputs_maybe_filtered (linebuffer
, stream
, filter
);
1988 do_cleanups (old_cleanups
);
1993 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
1995 vfprintf_maybe_filtered (stream
, format
, args
, 1);
1999 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2002 struct cleanup
*old_cleanups
;
2004 xvasprintf (&linebuffer
, format
, args
);
2005 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2006 fputs_unfiltered (linebuffer
, stream
);
2007 do_cleanups (old_cleanups
);
2011 vprintf_filtered (const char *format
, va_list args
)
2013 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2017 vprintf_unfiltered (const char *format
, va_list args
)
2019 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2023 fprintf_filtered (struct ui_file
* stream
, const char *format
,...)
2026 va_start (args
, format
);
2027 vfprintf_filtered (stream
, format
, args
);
2032 fprintf_unfiltered (struct ui_file
* stream
, const char *format
,...)
2035 va_start (args
, format
);
2036 vfprintf_unfiltered (stream
, format
, args
);
2040 /* Like fprintf_filtered, but prints its result indented.
2041 Called as fprintfi_filtered (spaces, stream, format, ...); */
2044 fprintfi_filtered (int spaces
, struct ui_file
* stream
, const char *format
,...)
2047 va_start (args
, format
);
2048 print_spaces_filtered (spaces
, stream
);
2050 vfprintf_filtered (stream
, format
, args
);
2056 printf_filtered (const char *format
,...)
2059 va_start (args
, format
);
2060 vfprintf_filtered (gdb_stdout
, format
, args
);
2066 printf_unfiltered (const char *format
,...)
2069 va_start (args
, format
);
2070 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2074 /* Like printf_filtered, but prints it's result indented.
2075 Called as printfi_filtered (spaces, format, ...); */
2078 printfi_filtered (int spaces
, const char *format
,...)
2081 va_start (args
, format
);
2082 print_spaces_filtered (spaces
, gdb_stdout
);
2083 vfprintf_filtered (gdb_stdout
, format
, args
);
2087 /* Easy -- but watch out!
2089 This routine is *not* a replacement for puts()! puts() appends a newline.
2090 This one doesn't, and had better not! */
2093 puts_filtered (const char *string
)
2095 fputs_filtered (string
, gdb_stdout
);
2099 puts_unfiltered (const char *string
)
2101 fputs_unfiltered (string
, gdb_stdout
);
2104 /* Return a pointer to N spaces and a null. The pointer is good
2105 until the next call to here. */
2110 static char *spaces
= 0;
2111 static int max_spaces
= -1;
2117 spaces
= (char *) xmalloc (n
+ 1);
2118 for (t
= spaces
+ n
; t
!= spaces
;)
2124 return spaces
+ max_spaces
- n
;
2127 /* Print N spaces. */
2129 print_spaces_filtered (int n
, struct ui_file
*stream
)
2131 fputs_filtered (n_spaces (n
), stream
);
2134 /* C++ demangler stuff. */
2136 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2137 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2138 If the name is not mangled, or the language for the name is unknown, or
2139 demangling is off, the name is printed in its "raw" form. */
2142 fprintf_symbol_filtered (struct ui_file
*stream
, char *name
, enum language lang
,
2149 /* If user wants to see raw output, no problem. */
2152 fputs_filtered (name
, stream
);
2158 case language_cplus
:
2159 demangled
= cplus_demangle (name
, arg_mode
);
2162 demangled
= cplus_demangle (name
, arg_mode
| DMGL_JAVA
);
2164 case language_chill
:
2165 demangled
= chill_demangle (name
);
2171 fputs_filtered (demangled
? demangled
: name
, stream
);
2172 if (demangled
!= NULL
)
2180 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2181 differences in whitespace. Returns 0 if they match, non-zero if they
2182 don't (slightly different than strcmp()'s range of return values).
2184 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2185 This "feature" is useful when searching for matching C++ function names
2186 (such as if the user types 'break FOO', where FOO is a mangled C++
2190 strcmp_iw (const char *string1
, const char *string2
)
2192 while ((*string1
!= '\0') && (*string2
!= '\0'))
2194 while (isspace (*string1
))
2198 while (isspace (*string2
))
2202 if (*string1
!= *string2
)
2206 if (*string1
!= '\0')
2212 return (*string1
!= '\0' && *string1
!= '(') || (*string2
!= '\0');
2218 ** Answer whether string_to_compare is a full or partial match to
2219 ** template_string. The partial match must be in sequence starting
2223 subset_compare (char *string_to_compare
, char *template_string
)
2226 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
&&
2227 strlen (string_to_compare
) <= strlen (template_string
))
2228 match
= (strncmp (template_string
,
2230 strlen (string_to_compare
)) == 0);
2237 static void pagination_on_command (char *arg
, int from_tty
);
2239 pagination_on_command (char *arg
, int from_tty
)
2241 pagination_enabled
= 1;
2244 static void pagination_on_command (char *arg
, int from_tty
);
2246 pagination_off_command (char *arg
, int from_tty
)
2248 pagination_enabled
= 0;
2253 initialize_utils (void)
2255 struct cmd_list_element
*c
;
2257 c
= add_set_cmd ("width", class_support
, var_uinteger
,
2258 (char *) &chars_per_line
,
2259 "Set number of characters gdb thinks are in a line.",
2261 add_show_from_set (c
, &showlist
);
2262 c
->function
.sfunc
= set_width_command
;
2265 (add_set_cmd ("height", class_support
,
2266 var_uinteger
, (char *) &lines_per_page
,
2267 "Set number of lines gdb thinks are in a page.", &setlist
),
2272 /* If the output is not a terminal, don't paginate it. */
2273 if (!ui_file_isatty (gdb_stdout
))
2274 lines_per_page
= UINT_MAX
;
2276 set_width_command ((char *) NULL
, 0, c
);
2279 (add_set_cmd ("demangle", class_support
, var_boolean
,
2281 "Set demangling of encoded C++ names when displaying symbols.",
2286 (add_set_cmd ("pagination", class_support
,
2287 var_boolean
, (char *) &pagination_enabled
,
2288 "Set state of pagination.", &setlist
),
2293 add_com ("am", class_support
, pagination_on_command
,
2294 "Enable pagination");
2295 add_com ("sm", class_support
, pagination_off_command
,
2296 "Disable pagination");
2300 (add_set_cmd ("sevenbit-strings", class_support
, var_boolean
,
2301 (char *) &sevenbit_strings
,
2302 "Set printing of 8-bit characters in strings as \\nnn.",
2307 (add_set_cmd ("asm-demangle", class_support
, var_boolean
,
2308 (char *) &asm_demangle
,
2309 "Set demangling of C++ names in disassembly listings.",
2314 /* Machine specific function to handle SIGWINCH signal. */
2316 #ifdef SIGWINCH_HANDLER_BODY
2317 SIGWINCH_HANDLER_BODY
2320 /* Support for converting target fp numbers into host DOUBLEST format. */
2322 /* XXX - This code should really be in libiberty/floatformat.c, however
2323 configuration issues with libiberty made this very difficult to do in the
2326 #include "floatformat.h"
2327 #include <math.h> /* ldexp */
2329 /* The odds that CHAR_BIT will be anything but 8 are low enough that I'm not
2330 going to bother with trying to muck around with whether it is defined in
2331 a system header, what we do if not, etc. */
2332 #define FLOATFORMAT_CHAR_BIT 8
2334 static unsigned long get_field (unsigned char *,
2335 enum floatformat_byteorders
,
2336 unsigned int, unsigned int, unsigned int);
2338 /* Extract a field which starts at START and is LEN bytes long. DATA and
2339 TOTAL_LEN are the thing we are extracting it from, in byteorder ORDER. */
2340 static unsigned long
2341 get_field (unsigned char *data
, enum floatformat_byteorders order
,
2342 unsigned int total_len
, unsigned int start
, unsigned int len
)
2344 unsigned long result
;
2345 unsigned int cur_byte
;
2348 /* Start at the least significant part of the field. */
2349 if (order
== floatformat_little
|| order
== floatformat_littlebyte_bigword
)
2351 /* We start counting from the other end (i.e, from the high bytes
2352 rather than the low bytes). As such, we need to be concerned
2353 with what happens if bit 0 doesn't start on a byte boundary.
2354 I.e, we need to properly handle the case where total_len is
2355 not evenly divisible by 8. So we compute ``excess'' which
2356 represents the number of bits from the end of our starting
2357 byte needed to get to bit 0. */
2358 int excess
= FLOATFORMAT_CHAR_BIT
- (total_len
% FLOATFORMAT_CHAR_BIT
);
2359 cur_byte
= (total_len
/ FLOATFORMAT_CHAR_BIT
)
2360 - ((start
+ len
+ excess
) / FLOATFORMAT_CHAR_BIT
);
2361 cur_bitshift
= ((start
+ len
+ excess
) % FLOATFORMAT_CHAR_BIT
)
2362 - FLOATFORMAT_CHAR_BIT
;
2366 cur_byte
= (start
+ len
) / FLOATFORMAT_CHAR_BIT
;
2368 ((start
+ len
) % FLOATFORMAT_CHAR_BIT
) - FLOATFORMAT_CHAR_BIT
;
2370 if (cur_bitshift
> -FLOATFORMAT_CHAR_BIT
)
2371 result
= *(data
+ cur_byte
) >> (-cur_bitshift
);
2374 cur_bitshift
+= FLOATFORMAT_CHAR_BIT
;
2375 if (order
== floatformat_little
|| order
== floatformat_littlebyte_bigword
)
2380 /* Move towards the most significant part of the field. */
2381 while (cur_bitshift
< len
)
2383 result
|= (unsigned long)*(data
+ cur_byte
) << cur_bitshift
;
2384 cur_bitshift
+= FLOATFORMAT_CHAR_BIT
;
2385 if (order
== floatformat_little
|| order
== floatformat_littlebyte_bigword
)
2390 if (len
< sizeof(result
) * FLOATFORMAT_CHAR_BIT
)
2391 /* Mask out bits which are not part of the field */
2392 result
&= ((1UL << len
) - 1);
2396 /* Convert from FMT to a DOUBLEST.
2397 FROM is the address of the extended float.
2398 Store the DOUBLEST in *TO. */
2401 floatformat_to_doublest (const struct floatformat
*fmt
, char *from
,
2404 unsigned char *ufrom
= (unsigned char *) from
;
2408 unsigned int mant_bits
, mant_off
;
2410 int special_exponent
; /* It's a NaN, denorm or zero */
2412 /* If the mantissa bits are not contiguous from one end of the
2413 mantissa to the other, we need to make a private copy of the
2414 source bytes that is in the right order since the unpacking
2415 algorithm assumes that the bits are contiguous.
2417 Swap the bytes individually rather than accessing them through
2418 "long *" since we have no guarantee that they start on a long
2419 alignment, and also sizeof(long) for the host could be different
2420 than sizeof(long) for the target. FIXME: Assumes sizeof(long)
2421 for the target is 4. */
2423 if (fmt
->byteorder
== floatformat_littlebyte_bigword
)
2425 static unsigned char *newfrom
;
2426 unsigned char *swapin
, *swapout
;
2429 longswaps
= fmt
->totalsize
/ FLOATFORMAT_CHAR_BIT
;
2432 if (newfrom
== NULL
)
2434 newfrom
= (unsigned char *) xmalloc (fmt
->totalsize
);
2439 while (longswaps
-- > 0)
2441 /* This is ugly, but efficient */
2442 *swapout
++ = swapin
[4];
2443 *swapout
++ = swapin
[5];
2444 *swapout
++ = swapin
[6];
2445 *swapout
++ = swapin
[7];
2446 *swapout
++ = swapin
[0];
2447 *swapout
++ = swapin
[1];
2448 *swapout
++ = swapin
[2];
2449 *swapout
++ = swapin
[3];
2454 exponent
= get_field (ufrom
, fmt
->byteorder
, fmt
->totalsize
,
2455 fmt
->exp_start
, fmt
->exp_len
);
2456 /* Note that if exponent indicates a NaN, we can't really do anything useful
2457 (not knowing if the host has NaN's, or how to build one). So it will
2458 end up as an infinity or something close; that is OK. */
2460 mant_bits_left
= fmt
->man_len
;
2461 mant_off
= fmt
->man_start
;
2464 special_exponent
= exponent
== 0 || exponent
== fmt
->exp_nan
;
2466 /* Don't bias NaNs. Use minimum exponent for denorms. For simplicity,
2467 we don't check for zero as the exponent doesn't matter. */
2468 if (!special_exponent
)
2469 exponent
-= fmt
->exp_bias
;
2470 else if (exponent
== 0)
2471 exponent
= 1 - fmt
->exp_bias
;
2473 /* Build the result algebraically. Might go infinite, underflow, etc;
2476 /* If this format uses a hidden bit, explicitly add it in now. Otherwise,
2477 increment the exponent by one to account for the integer bit. */
2479 if (!special_exponent
)
2481 if (fmt
->intbit
== floatformat_intbit_no
)
2482 dto
= ldexp (1.0, exponent
);
2487 while (mant_bits_left
> 0)
2489 mant_bits
= min (mant_bits_left
, 32);
2491 mant
= get_field (ufrom
, fmt
->byteorder
, fmt
->totalsize
,
2492 mant_off
, mant_bits
);
2494 dto
+= ldexp ((double) mant
, exponent
- mant_bits
);
2495 exponent
-= mant_bits
;
2496 mant_off
+= mant_bits
;
2497 mant_bits_left
-= mant_bits
;
2500 /* Negate it if negative. */
2501 if (get_field (ufrom
, fmt
->byteorder
, fmt
->totalsize
, fmt
->sign_start
, 1))
2506 static void put_field (unsigned char *, enum floatformat_byteorders
,
2508 unsigned int, unsigned int, unsigned long);
2510 /* Set a field which starts at START and is LEN bytes long. DATA and
2511 TOTAL_LEN are the thing we are extracting it from, in byteorder ORDER. */
2513 put_field (unsigned char *data
, enum floatformat_byteorders order
,
2514 unsigned int total_len
, unsigned int start
, unsigned int len
,
2515 unsigned long stuff_to_put
)
2517 unsigned int cur_byte
;
2520 /* Start at the least significant part of the field. */
2521 if (order
== floatformat_little
|| order
== floatformat_littlebyte_bigword
)
2523 int excess
= FLOATFORMAT_CHAR_BIT
- (total_len
% FLOATFORMAT_CHAR_BIT
);
2524 cur_byte
= (total_len
/ FLOATFORMAT_CHAR_BIT
)
2525 - ((start
+ len
+ excess
) / FLOATFORMAT_CHAR_BIT
);
2526 cur_bitshift
= ((start
+ len
+ excess
) % FLOATFORMAT_CHAR_BIT
)
2527 - FLOATFORMAT_CHAR_BIT
;
2531 cur_byte
= (start
+ len
) / FLOATFORMAT_CHAR_BIT
;
2533 ((start
+ len
) % FLOATFORMAT_CHAR_BIT
) - FLOATFORMAT_CHAR_BIT
;
2535 if (cur_bitshift
> -FLOATFORMAT_CHAR_BIT
)
2537 *(data
+ cur_byte
) &=
2538 ~(((1 << ((start
+ len
) % FLOATFORMAT_CHAR_BIT
)) - 1)
2539 << (-cur_bitshift
));
2540 *(data
+ cur_byte
) |=
2541 (stuff_to_put
& ((1 << FLOATFORMAT_CHAR_BIT
) - 1)) << (-cur_bitshift
);
2543 cur_bitshift
+= FLOATFORMAT_CHAR_BIT
;
2544 if (order
== floatformat_little
|| order
== floatformat_littlebyte_bigword
)
2549 /* Move towards the most significant part of the field. */
2550 while (cur_bitshift
< len
)
2552 if (len
- cur_bitshift
< FLOATFORMAT_CHAR_BIT
)
2554 /* This is the last byte. */
2555 *(data
+ cur_byte
) &=
2556 ~((1 << (len
- cur_bitshift
)) - 1);
2557 *(data
+ cur_byte
) |= (stuff_to_put
>> cur_bitshift
);
2560 *(data
+ cur_byte
) = ((stuff_to_put
>> cur_bitshift
)
2561 & ((1 << FLOATFORMAT_CHAR_BIT
) - 1));
2562 cur_bitshift
+= FLOATFORMAT_CHAR_BIT
;
2563 if (order
== floatformat_little
|| order
== floatformat_littlebyte_bigword
)
2570 #ifdef HAVE_LONG_DOUBLE
2571 /* Return the fractional part of VALUE, and put the exponent of VALUE in *EPTR.
2572 The range of the returned value is >= 0.5 and < 1.0. This is equivalent to
2573 frexp, but operates on the long double data type. */
2575 static long double ldfrexp (long double value
, int *eptr
);
2578 ldfrexp (long double value
, int *eptr
)
2583 /* Unfortunately, there are no portable functions for extracting the exponent
2584 of a long double, so we have to do it iteratively by multiplying or dividing
2585 by two until the fraction is between 0.5 and 1.0. */
2593 if (value
>= tmp
) /* Value >= 1.0 */
2594 while (value
>= tmp
)
2599 else if (value
!= 0.0l) /* Value < 1.0 and > 0.0 */
2613 #endif /* HAVE_LONG_DOUBLE */
2616 /* The converse: convert the DOUBLEST *FROM to an extended float
2617 and store where TO points. Neither FROM nor TO have any alignment
2621 floatformat_from_doublest (CONST
struct floatformat
*fmt
, DOUBLEST
*from
,
2627 unsigned int mant_bits
, mant_off
;
2629 unsigned char *uto
= (unsigned char *) to
;
2631 memcpy (&dfrom
, from
, sizeof (dfrom
));
2632 memset (uto
, 0, (fmt
->totalsize
+ FLOATFORMAT_CHAR_BIT
- 1)
2633 / FLOATFORMAT_CHAR_BIT
);
2635 return; /* Result is zero */
2636 if (dfrom
!= dfrom
) /* Result is NaN */
2639 put_field (uto
, fmt
->byteorder
, fmt
->totalsize
, fmt
->exp_start
,
2640 fmt
->exp_len
, fmt
->exp_nan
);
2641 /* Be sure it's not infinity, but NaN value is irrel */
2642 put_field (uto
, fmt
->byteorder
, fmt
->totalsize
, fmt
->man_start
,
2647 /* If negative, set the sign bit. */
2650 put_field (uto
, fmt
->byteorder
, fmt
->totalsize
, fmt
->sign_start
, 1, 1);
2654 if (dfrom
+ dfrom
== dfrom
&& dfrom
!= 0.0) /* Result is Infinity */
2656 /* Infinity exponent is same as NaN's. */
2657 put_field (uto
, fmt
->byteorder
, fmt
->totalsize
, fmt
->exp_start
,
2658 fmt
->exp_len
, fmt
->exp_nan
);
2659 /* Infinity mantissa is all zeroes. */
2660 put_field (uto
, fmt
->byteorder
, fmt
->totalsize
, fmt
->man_start
,
2665 #ifdef HAVE_LONG_DOUBLE
2666 mant
= ldfrexp (dfrom
, &exponent
);
2668 mant
= frexp (dfrom
, &exponent
);
2671 put_field (uto
, fmt
->byteorder
, fmt
->totalsize
, fmt
->exp_start
, fmt
->exp_len
,
2672 exponent
+ fmt
->exp_bias
- 1);
2674 mant_bits_left
= fmt
->man_len
;
2675 mant_off
= fmt
->man_start
;
2676 while (mant_bits_left
> 0)
2678 unsigned long mant_long
;
2679 mant_bits
= mant_bits_left
< 32 ? mant_bits_left
: 32;
2681 mant
*= 4294967296.0;
2682 mant_long
= ((unsigned long) mant
) & 0xffffffffL
;
2685 /* If the integer bit is implicit, then we need to discard it.
2686 If we are discarding a zero, we should be (but are not) creating
2687 a denormalized number which means adjusting the exponent
2689 if (mant_bits_left
== fmt
->man_len
2690 && fmt
->intbit
== floatformat_intbit_no
)
2693 mant_long
&= 0xffffffffL
;
2699 /* The bits we want are in the most significant MANT_BITS bits of
2700 mant_long. Move them to the least significant. */
2701 mant_long
>>= 32 - mant_bits
;
2704 put_field (uto
, fmt
->byteorder
, fmt
->totalsize
,
2705 mant_off
, mant_bits
, mant_long
);
2706 mant_off
+= mant_bits
;
2707 mant_bits_left
-= mant_bits
;
2709 if (fmt
->byteorder
== floatformat_littlebyte_bigword
)
2712 unsigned char *swaplow
= uto
;
2713 unsigned char *swaphigh
= uto
+ 4;
2716 for (count
= 0; count
< 4; count
++)
2719 *swaplow
++ = *swaphigh
;
2725 /* print routines to handle variable size regs, etc. */
2727 /* temporary storage using circular buffer */
2733 static char buf
[NUMCELLS
][CELLSIZE
];
2734 static int cell
= 0;
2735 if (++cell
>= NUMCELLS
)
2743 return (TARGET_ADDR_BIT
/ 8 * 2);
2747 paddr (CORE_ADDR addr
)
2749 return phex (addr
, TARGET_ADDR_BIT
/ 8);
2753 paddr_nz (CORE_ADDR addr
)
2755 return phex_nz (addr
, TARGET_ADDR_BIT
/ 8);
2759 decimal2str (char *paddr_str
, char *sign
, ULONGEST addr
)
2761 /* steal code from valprint.c:print_decimal(). Should this worry
2762 about the real size of addr as the above does? */
2763 unsigned long temp
[3];
2767 temp
[i
] = addr
% (1000 * 1000 * 1000);
2768 addr
/= (1000 * 1000 * 1000);
2771 while (addr
!= 0 && i
< (sizeof (temp
) / sizeof (temp
[0])));
2775 sprintf (paddr_str
, "%s%lu",
2779 sprintf (paddr_str
, "%s%lu%09lu",
2780 sign
, temp
[1], temp
[0]);
2783 sprintf (paddr_str
, "%s%lu%09lu%09lu",
2784 sign
, temp
[2], temp
[1], temp
[0]);
2792 paddr_u (CORE_ADDR addr
)
2794 char *paddr_str
= get_cell ();
2795 decimal2str (paddr_str
, "", addr
);
2800 paddr_d (LONGEST addr
)
2802 char *paddr_str
= get_cell ();
2804 decimal2str (paddr_str
, "-", -addr
);
2806 decimal2str (paddr_str
, "", addr
);
2810 /* eliminate warning from compiler on 32-bit systems */
2811 static int thirty_two
= 32;
2814 phex (ULONGEST l
, int sizeof_l
)
2816 char *str
= get_cell ();
2820 sprintf (str
, "%08lx%08lx",
2821 (unsigned long) (l
>> thirty_two
),
2822 (unsigned long) (l
& 0xffffffff));
2825 sprintf (str
, "%08lx", (unsigned long) l
);
2828 sprintf (str
, "%04x", (unsigned short) (l
& 0xffff));
2831 phex (l
, sizeof (l
));
2838 phex_nz (ULONGEST l
, int sizeof_l
)
2840 char *str
= get_cell ();
2845 unsigned long high
= (unsigned long) (l
>> thirty_two
);
2847 sprintf (str
, "%lx", (unsigned long) (l
& 0xffffffff));
2849 sprintf (str
, "%lx%08lx",
2850 high
, (unsigned long) (l
& 0xffffffff));
2854 sprintf (str
, "%lx", (unsigned long) l
);
2857 sprintf (str
, "%x", (unsigned short) (l
& 0xffff));
2860 phex_nz (l
, sizeof (l
));
2867 /* Convert to / from the hosts pointer to GDB's internal CORE_ADDR
2868 using the target's conversion routines. */
2870 host_pointer_to_address (void *ptr
)
2872 if (sizeof (ptr
) != TYPE_LENGTH (builtin_type_ptr
))
2873 internal_error ("core_addr_to_void_ptr: bad cast");
2874 return POINTER_TO_ADDRESS (builtin_type_ptr
, &ptr
);
2878 address_to_host_pointer (CORE_ADDR addr
)
2881 if (sizeof (ptr
) != TYPE_LENGTH (builtin_type_ptr
))
2882 internal_error ("core_addr_to_void_ptr: bad cast");
2883 ADDRESS_TO_POINTER (builtin_type_ptr
, &ptr
, addr
);