1 /* General utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2013 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 3 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, see <http://www.gnu.org/licenses/>. */
21 #include "dyn-string.h"
22 #include "gdb_assert.h"
24 #include "gdb_string.h"
26 #include "event-top.h"
27 #include "exceptions.h"
28 #include "gdbthread.h"
31 #ifdef HAVE_SYS_RESOURCE_H
32 #include <sys/resource.h>
33 #endif /* HAVE_SYS_RESOURCE_H */
36 #include "tui/tui.h" /* For tui_get_command_dimension. */
43 /* SunOS's curses.h has a '#define reg register' in it. Thank you Sun. */
49 #include "timeval-utils.h"
54 #include "gdb-demangle.h"
55 #include "expression.h"
59 #include "filenames.h"
61 #include "gdb_obstack.h"
67 #include "inferior.h" /* for signed_pointer_to_address */
69 #include <sys/param.h> /* For MAXPATHLEN */
71 #include "gdb_curses.h"
73 #include "readline/readline.h"
78 #include "gdb_usleep.h"
80 #include "gdb_regex.h"
83 extern PTR
malloc (); /* ARI: PTR */
85 #if !HAVE_DECL_REALLOC
86 extern PTR
realloc (); /* ARI: PTR */
92 void (*deprecated_error_begin_hook
) (void);
94 /* Prototypes for local functions */
96 static void vfprintf_maybe_filtered (struct ui_file
*, const char *,
97 va_list, int) ATTRIBUTE_PRINTF (2, 0);
99 static void fputs_maybe_filtered (const char *, struct ui_file
*, int);
101 static void prompt_for_continue (void);
103 static void set_screen_size (void);
104 static void set_width (void);
106 /* Time spent in prompt_for_continue in the currently executing command
107 waiting for user to respond.
108 Initialized in make_command_stats_cleanup.
109 Modified in prompt_for_continue and defaulted_query.
110 Used in report_command_stats. */
112 static struct timeval prompt_for_continue_wait_time
;
114 /* A flag indicating whether to timestamp debugging messages. */
116 static int debug_timestamp
= 0;
118 /* Nonzero if we have job control. */
123 /* Nonzero means a quit has been requested. */
126 #endif /* HAVE_PYTHON */
128 /* Nonzero means quit immediately if Control-C is typed now, rather
129 than waiting until QUIT is executed. Be careful in setting this;
130 code which executes with immediate_quit set has to be very careful
131 about being able to deal with being interrupted at any time. It is
132 almost always better to use QUIT; the only exception I can think of
133 is being able to quit out of a system call (using EINTR loses if
134 the SIGINT happens between the previous QUIT and the system call).
135 To immediately quit in the case in which a SIGINT happens between
136 the previous QUIT and setting immediate_quit (desirable anytime we
137 expect to block), call QUIT after setting immediate_quit. */
143 /* Clear the quit flag. */
146 clear_quit_flag (void)
151 /* Set the quit flag. */
159 /* Return true if the quit flag has been set, false otherwise. */
162 check_quit_flag (void)
164 /* This is written in a particular way to avoid races. */
174 #endif /* HAVE_PYTHON */
176 /* Nonzero means that strings with character values >0x7F should be printed
177 as octal escapes. Zero means just print the value (e.g. it's an
178 international character, and the terminal or window can cope.) */
180 int sevenbit_strings
= 0;
182 show_sevenbit_strings (struct ui_file
*file
, int from_tty
,
183 struct cmd_list_element
*c
, const char *value
)
185 fprintf_filtered (file
, _("Printing of 8-bit characters "
186 "in strings as \\nnn is %s.\n"),
190 /* String to be printed before error messages, if any. */
192 char *error_pre_print
;
194 /* String to be printed before quit messages, if any. */
196 char *quit_pre_print
;
198 /* String to be printed before warning messages, if any. */
200 char *warning_pre_print
= "\nwarning: ";
202 int pagination_enabled
= 1;
204 show_pagination_enabled (struct ui_file
*file
, int from_tty
,
205 struct cmd_list_element
*c
, const char *value
)
207 fprintf_filtered (file
, _("State of pagination is %s.\n"), value
);
211 /* Cleanup utilities.
213 These are not defined in cleanups.c (nor declared in cleanups.h)
214 because while they use the "cleanup API" they are not part of the
218 do_freeargv (void *arg
)
220 freeargv ((char **) arg
);
224 make_cleanup_freeargv (char **arg
)
226 return make_cleanup (do_freeargv
, arg
);
230 do_dyn_string_delete (void *arg
)
232 dyn_string_delete ((dyn_string_t
) arg
);
236 make_cleanup_dyn_string_delete (dyn_string_t arg
)
238 return make_cleanup (do_dyn_string_delete
, arg
);
242 do_bfd_close_cleanup (void *arg
)
248 make_cleanup_bfd_unref (bfd
*abfd
)
250 return make_cleanup (do_bfd_close_cleanup
, abfd
);
254 do_close_cleanup (void *arg
)
262 make_cleanup_close (int fd
)
264 int *saved_fd
= xmalloc (sizeof (fd
));
267 return make_cleanup_dtor (do_close_cleanup
, saved_fd
, xfree
);
270 /* Helper function which does the work for make_cleanup_fclose. */
273 do_fclose_cleanup (void *arg
)
280 /* Return a new cleanup that closes FILE. */
283 make_cleanup_fclose (FILE *file
)
285 return make_cleanup (do_fclose_cleanup
, file
);
288 /* Helper function which does the work for make_cleanup_obstack_free. */
291 do_obstack_free (void *arg
)
293 struct obstack
*ob
= arg
;
295 obstack_free (ob
, NULL
);
298 /* Return a new cleanup that frees OBSTACK. */
301 make_cleanup_obstack_free (struct obstack
*obstack
)
303 return make_cleanup (do_obstack_free
, obstack
);
307 do_ui_file_delete (void *arg
)
309 ui_file_delete (arg
);
313 make_cleanup_ui_file_delete (struct ui_file
*arg
)
315 return make_cleanup (do_ui_file_delete
, arg
);
318 /* Helper function for make_cleanup_ui_out_redirect_pop. */
321 do_ui_out_redirect_pop (void *arg
)
323 struct ui_out
*uiout
= arg
;
325 if (ui_out_redirect (uiout
, NULL
) < 0)
326 warning (_("Cannot restore redirection of the current output protocol"));
329 /* Return a new cleanup that pops the last redirection by ui_out_redirect
330 with NULL parameter. */
333 make_cleanup_ui_out_redirect_pop (struct ui_out
*uiout
)
335 return make_cleanup (do_ui_out_redirect_pop
, uiout
);
339 do_free_section_addr_info (void *arg
)
341 free_section_addr_info (arg
);
345 make_cleanup_free_section_addr_info (struct section_addr_info
*addrs
)
347 return make_cleanup (do_free_section_addr_info
, addrs
);
350 struct restore_integer_closure
357 restore_integer (void *p
)
359 struct restore_integer_closure
*closure
= p
;
361 *(closure
->variable
) = closure
->value
;
364 /* Remember the current value of *VARIABLE and make it restored when
365 the cleanup is run. */
368 make_cleanup_restore_integer (int *variable
)
370 struct restore_integer_closure
*c
=
371 xmalloc (sizeof (struct restore_integer_closure
));
373 c
->variable
= variable
;
374 c
->value
= *variable
;
376 return make_cleanup_dtor (restore_integer
, (void *) c
, xfree
);
379 /* Remember the current value of *VARIABLE and make it restored when
380 the cleanup is run. */
383 make_cleanup_restore_uinteger (unsigned int *variable
)
385 return make_cleanup_restore_integer ((int *) variable
);
388 /* Helper for make_cleanup_unpush_target. */
391 do_unpush_target (void *arg
)
393 struct target_ops
*ops
= arg
;
398 /* Return a new cleanup that unpushes OPS. */
401 make_cleanup_unpush_target (struct target_ops
*ops
)
403 return make_cleanup (do_unpush_target
, ops
);
406 /* Helper for make_cleanup_htab_delete compile time checking the types. */
409 do_htab_delete_cleanup (void *htab_voidp
)
411 htab_t htab
= htab_voidp
;
416 /* Return a new cleanup that deletes HTAB. */
419 make_cleanup_htab_delete (htab_t htab
)
421 return make_cleanup (do_htab_delete_cleanup
, htab
);
424 struct restore_ui_file_closure
426 struct ui_file
**variable
;
427 struct ui_file
*value
;
431 do_restore_ui_file (void *p
)
433 struct restore_ui_file_closure
*closure
= p
;
435 *(closure
->variable
) = closure
->value
;
438 /* Remember the current value of *VARIABLE and make it restored when
439 the cleanup is run. */
442 make_cleanup_restore_ui_file (struct ui_file
**variable
)
444 struct restore_ui_file_closure
*c
= XNEW (struct restore_ui_file_closure
);
446 c
->variable
= variable
;
447 c
->value
= *variable
;
449 return make_cleanup_dtor (do_restore_ui_file
, (void *) c
, xfree
);
452 /* Helper for make_cleanup_value_free_to_mark. */
455 do_value_free_to_mark (void *value
)
457 value_free_to_mark ((struct value
*) value
);
460 /* Free all values allocated since MARK was obtained by value_mark
461 (except for those released) when the cleanup is run. */
464 make_cleanup_value_free_to_mark (struct value
*mark
)
466 return make_cleanup (do_value_free_to_mark
, mark
);
469 /* Helper for make_cleanup_value_free. */
472 do_value_free (void *value
)
480 make_cleanup_value_free (struct value
*value
)
482 return make_cleanup (do_value_free
, value
);
485 /* Helper for make_cleanup_free_so. */
488 do_free_so (void *arg
)
490 struct so_list
*so
= arg
;
495 /* Make cleanup handler calling free_so for SO. */
498 make_cleanup_free_so (struct so_list
*so
)
500 return make_cleanup (do_free_so
, so
);
503 /* Helper for make_cleanup_restore_current_language. */
506 do_restore_current_language (void *p
)
508 enum language saved_lang
= (uintptr_t) p
;
510 set_language (saved_lang
);
513 /* Remember the current value of CURRENT_LANGUAGE and make it restored when
514 the cleanup is run. */
517 make_cleanup_restore_current_language (void)
519 enum language saved_lang
= current_language
->la_language
;
521 return make_cleanup (do_restore_current_language
,
522 (void *) (uintptr_t) saved_lang
);
525 /* This function is useful for cleanups.
529 old_chain = make_cleanup (free_current_contents, &foo);
531 to arrange to free the object thus allocated. */
534 free_current_contents (void *ptr
)
536 void **location
= ptr
;
538 if (location
== NULL
)
539 internal_error (__FILE__
, __LINE__
,
540 _("free_current_contents: NULL pointer"));
541 if (*location
!= NULL
)
548 /* If nonzero, display time usage both at startup and for each command. */
550 static int display_time
;
552 /* If nonzero, display space usage both at startup and for each command. */
554 static int display_space
;
556 /* Records a run time and space usage to be used as a base for
557 reporting elapsed time or change in space. In addition,
558 the msg_type field indicates whether the saved time is from the
559 beginning of GDB execution (0) or the beginning of an individual
560 command execution (1). */
565 struct timeval start_wall_time
;
569 /* Set whether to display time statistics to NEW_VALUE (non-zero
572 set_display_time (int new_value
)
574 display_time
= new_value
;
577 /* Set whether to display space statistics to NEW_VALUE (non-zero
580 set_display_space (int new_value
)
582 display_space
= new_value
;
585 /* As indicated by display_time and display_space, report GDB's elapsed time
586 and space usage from the base time and space provided in ARG, which
587 must be a pointer to a struct cmd_stat. This function is intended
588 to be called as a cleanup. */
590 report_command_stats (void *arg
)
592 struct cmd_stats
*start_stats
= (struct cmd_stats
*) arg
;
593 int msg_type
= start_stats
->msg_type
;
597 long cmd_time
= get_run_time () - start_stats
->start_cpu_time
;
598 struct timeval now_wall_time
, delta_wall_time
;
600 gettimeofday (&now_wall_time
, NULL
);
601 timeval_sub (&delta_wall_time
,
602 &now_wall_time
, &start_stats
->start_wall_time
);
604 /* Subtract time spend in prompt_for_continue from walltime. */
605 timeval_sub (&delta_wall_time
,
606 &delta_wall_time
, &prompt_for_continue_wait_time
);
608 printf_unfiltered (msg_type
== 0
609 ? _("Startup time: %ld.%06ld (cpu), %ld.%06ld (wall)\n")
610 : _("Command execution time: %ld.%06ld (cpu), %ld.%06ld (wall)\n"),
611 cmd_time
/ 1000000, cmd_time
% 1000000,
612 (long) delta_wall_time
.tv_sec
,
613 (long) delta_wall_time
.tv_usec
);
619 char *lim
= (char *) sbrk (0);
621 long space_now
= lim
- lim_at_start
;
622 long space_diff
= space_now
- start_stats
->start_space
;
624 printf_unfiltered (msg_type
== 0
625 ? _("Space used: %ld (%s%ld during startup)\n")
626 : _("Space used: %ld (%s%ld for this command)\n"),
628 (space_diff
>= 0 ? "+" : ""),
634 /* Create a cleanup that reports time and space used since its
635 creation. Precise messages depend on MSG_TYPE:
636 0: Initial time/space
637 1: Individual command time/space. */
639 make_command_stats_cleanup (int msg_type
)
641 static const struct timeval zero_timeval
= { 0 };
642 struct cmd_stats
*new_stat
= XMALLOC (struct cmd_stats
);
645 char *lim
= (char *) sbrk (0);
646 new_stat
->start_space
= lim
- lim_at_start
;
649 new_stat
->msg_type
= msg_type
;
650 new_stat
->start_cpu_time
= get_run_time ();
651 gettimeofday (&new_stat
->start_wall_time
, NULL
);
653 /* Initalize timer to keep track of how long we waited for the user. */
654 prompt_for_continue_wait_time
= zero_timeval
;
656 return make_cleanup_dtor (report_command_stats
, new_stat
, xfree
);
661 /* Print a warning message. The first argument STRING is the warning
662 message, used as an fprintf format string, the second is the
663 va_list of arguments for that string. A warning is unfiltered (not
664 paginated) so that the user does not need to page through each
665 screen full of warnings when there are lots of them. */
668 vwarning (const char *string
, va_list args
)
670 if (deprecated_warning_hook
)
671 (*deprecated_warning_hook
) (string
, args
);
674 target_terminal_ours ();
675 wrap_here (""); /* Force out any buffered output. */
676 gdb_flush (gdb_stdout
);
677 if (warning_pre_print
)
678 fputs_unfiltered (warning_pre_print
, gdb_stderr
);
679 vfprintf_unfiltered (gdb_stderr
, string
, args
);
680 fprintf_unfiltered (gdb_stderr
, "\n");
685 /* Print a warning message.
686 The first argument STRING is the warning message, used as a fprintf string,
687 and the remaining args are passed as arguments to it.
688 The primary difference between warnings and errors is that a warning
689 does not force the return to command level. */
692 warning (const char *string
, ...)
696 va_start (args
, string
);
697 vwarning (string
, args
);
701 /* Print an error message and return to command level.
702 The first argument STRING is the error message, used as a fprintf string,
703 and the remaining args are passed as arguments to it. */
706 verror (const char *string
, va_list args
)
708 throw_verror (GENERIC_ERROR
, string
, args
);
712 error (const char *string
, ...)
716 va_start (args
, string
);
717 throw_verror (GENERIC_ERROR
, string
, args
);
721 /* Print an error message and quit.
722 The first argument STRING is the error message, used as a fprintf string,
723 and the remaining args are passed as arguments to it. */
726 vfatal (const char *string
, va_list args
)
728 throw_vfatal (string
, args
);
732 fatal (const char *string
, ...)
736 va_start (args
, string
);
737 throw_vfatal (string
, args
);
742 error_stream (struct ui_file
*stream
)
744 char *message
= ui_file_xstrdup (stream
, NULL
);
746 make_cleanup (xfree
, message
);
747 error (("%s"), message
);
750 /* Dump core trying to increase the core soft limit to hard limit first. */
755 #ifdef HAVE_SETRLIMIT
756 struct rlimit rlim
= { RLIM_INFINITY
, RLIM_INFINITY
};
758 setrlimit (RLIMIT_CORE
, &rlim
);
759 #endif /* HAVE_SETRLIMIT */
761 abort (); /* NOTE: GDB has only three calls to abort(). */
764 /* Check whether GDB will be able to dump core using the dump_core
768 can_dump_core (const char *reason
)
770 #ifdef HAVE_GETRLIMIT
773 /* Be quiet and assume we can dump if an error is returned. */
774 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
777 if (rlim
.rlim_max
== 0)
779 fprintf_unfiltered (gdb_stderr
,
780 _("%s\nUnable to dump core, use `ulimit -c"
781 " unlimited' before executing GDB next time.\n"),
785 #endif /* HAVE_GETRLIMIT */
790 /* Allow the user to configure the debugger behavior with respect to
791 what to do when an internal problem is detected. */
793 const char internal_problem_ask
[] = "ask";
794 const char internal_problem_yes
[] = "yes";
795 const char internal_problem_no
[] = "no";
796 static const char *const internal_problem_modes
[] =
798 internal_problem_ask
,
799 internal_problem_yes
,
804 /* Print a message reporting an internal error/warning. Ask the user
805 if they want to continue, dump core, or just exit. Return
806 something to indicate a quit. */
808 struct internal_problem
811 const char *should_quit
;
812 const char *should_dump_core
;
815 /* Report a problem, internal to GDB, to the user. Once the problem
816 has been reported, and assuming GDB didn't quit, the caller can
817 either allow execution to resume or throw an error. */
819 static void ATTRIBUTE_PRINTF (4, 0)
820 internal_vproblem (struct internal_problem
*problem
,
821 const char *file
, int line
, const char *fmt
, va_list ap
)
828 /* Don't allow infinite error/warning recursion. */
830 static char msg
[] = "Recursive internal problem.\n";
839 fputs_unfiltered (msg
, gdb_stderr
);
840 abort (); /* NOTE: GDB has only three calls to abort(). */
843 /* Newer GLIBC versions put the warn_unused_result attribute
844 on write, but this is one of those rare cases where
845 ignoring the return value is correct. Casting to (void)
846 does not fix this problem. This is the solution suggested
847 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
848 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
849 abort (); /* NOTE: GDB has only three calls to abort(). */
854 /* Try to get the message out and at the start of a new line. */
855 target_terminal_ours ();
858 /* Create a string containing the full error/warning message. Need
859 to call query with this full string, as otherwize the reason
860 (error/warning) and question become separated. Format using a
861 style similar to a compiler error message. Include extra detail
862 so that the user knows that they are living on the edge. */
866 msg
= xstrvprintf (fmt
, ap
);
867 reason
= xstrprintf ("%s:%d: %s: %s\n"
868 "A problem internal to GDB has been detected,\n"
869 "further debugging may prove unreliable.",
870 file
, line
, problem
->name
, msg
);
872 make_cleanup (xfree
, reason
);
875 if (problem
->should_quit
== internal_problem_ask
)
877 /* Default (yes/batch case) is to quit GDB. When in batch mode
878 this lessens the likelihood of GDB going into an infinite
882 /* Emit the message and quit. */
883 fputs_unfiltered (reason
, gdb_stderr
);
884 fputs_unfiltered ("\n", gdb_stderr
);
888 quit_p
= query (_("%s\nQuit this debugging session? "), reason
);
890 else if (problem
->should_quit
== internal_problem_yes
)
892 else if (problem
->should_quit
== internal_problem_no
)
895 internal_error (__FILE__
, __LINE__
, _("bad switch"));
897 if (problem
->should_dump_core
== internal_problem_ask
)
899 if (!can_dump_core (reason
))
903 /* Default (yes/batch case) is to dump core. This leaves a GDB
904 `dropping' so that it is easier to see that something went
906 dump_core_p
= query (_("%s\nCreate a core file of GDB? "), reason
);
909 else if (problem
->should_dump_core
== internal_problem_yes
)
910 dump_core_p
= can_dump_core (reason
);
911 else if (problem
->should_dump_core
== internal_problem_no
)
914 internal_error (__FILE__
, __LINE__
, _("bad switch"));
927 #ifdef HAVE_WORKING_FORK
937 static struct internal_problem internal_error_problem
= {
938 "internal-error", internal_problem_ask
, internal_problem_ask
942 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
944 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
945 deprecated_throw_reason (RETURN_ERROR
);
949 internal_error (const char *file
, int line
, const char *string
, ...)
953 va_start (ap
, string
);
954 internal_verror (file
, line
, string
, ap
);
958 static struct internal_problem internal_warning_problem
= {
959 "internal-warning", internal_problem_ask
, internal_problem_ask
963 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
965 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
969 internal_warning (const char *file
, int line
, const char *string
, ...)
973 va_start (ap
, string
);
974 internal_vwarning (file
, line
, string
, ap
);
978 /* Dummy functions to keep add_prefix_cmd happy. */
981 set_internal_problem_cmd (char *args
, int from_tty
)
986 show_internal_problem_cmd (char *args
, int from_tty
)
990 /* When GDB reports an internal problem (error or warning) it gives
991 the user the opportunity to quit GDB and/or create a core file of
992 the current debug session. This function registers a few commands
993 that make it possible to specify that GDB should always or never
994 quit or create a core file, without asking. The commands look
997 maint set PROBLEM-NAME quit ask|yes|no
998 maint show PROBLEM-NAME quit
999 maint set PROBLEM-NAME corefile ask|yes|no
1000 maint show PROBLEM-NAME corefile
1002 Where PROBLEM-NAME is currently "internal-error" or
1003 "internal-warning". */
1006 add_internal_problem_command (struct internal_problem
*problem
)
1008 struct cmd_list_element
**set_cmd_list
;
1009 struct cmd_list_element
**show_cmd_list
;
1013 set_cmd_list
= xmalloc (sizeof (*set_cmd_list
));
1014 show_cmd_list
= xmalloc (sizeof (*set_cmd_list
));
1015 *set_cmd_list
= NULL
;
1016 *show_cmd_list
= NULL
;
1018 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
1021 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
1024 add_prefix_cmd ((char*) problem
->name
,
1025 class_maintenance
, set_internal_problem_cmd
, set_doc
,
1027 concat ("maintenance set ", problem
->name
, " ",
1029 0/*allow-unknown*/, &maintenance_set_cmdlist
);
1031 add_prefix_cmd ((char*) problem
->name
,
1032 class_maintenance
, show_internal_problem_cmd
, show_doc
,
1034 concat ("maintenance show ", problem
->name
, " ",
1036 0/*allow-unknown*/, &maintenance_show_cmdlist
);
1038 set_doc
= xstrprintf (_("Set whether GDB should quit "
1039 "when an %s is detected"),
1041 show_doc
= xstrprintf (_("Show whether GDB will quit "
1042 "when an %s is detected"),
1044 add_setshow_enum_cmd ("quit", class_maintenance
,
1045 internal_problem_modes
,
1046 &problem
->should_quit
,
1049 NULL
, /* help_doc */
1051 NULL
, /* showfunc */
1058 set_doc
= xstrprintf (_("Set whether GDB should create a core "
1059 "file of GDB when %s is detected"),
1061 show_doc
= xstrprintf (_("Show whether GDB will create a core "
1062 "file of GDB when %s is detected"),
1064 add_setshow_enum_cmd ("corefile", class_maintenance
,
1065 internal_problem_modes
,
1066 &problem
->should_dump_core
,
1069 NULL
, /* help_doc */
1071 NULL
, /* showfunc */
1079 /* Print the system error message for errno, and also mention STRING
1080 as the file name for which the error was encountered.
1081 Then return to command level. */
1084 perror_with_name (const char *string
)
1089 err
= safe_strerror (errno
);
1090 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
1091 strcpy (combined
, string
);
1092 strcat (combined
, ": ");
1093 strcat (combined
, err
);
1095 /* I understand setting these is a matter of taste. Still, some people
1096 may clear errno but not know about bfd_error. Doing this here is not
1098 bfd_set_error (bfd_error_no_error
);
1101 error (_("%s."), combined
);
1104 /* Print the system error message for ERRCODE, and also mention STRING
1105 as the file name for which the error was encountered. */
1108 print_sys_errmsg (const char *string
, int errcode
)
1113 err
= safe_strerror (errcode
);
1114 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
1115 strcpy (combined
, string
);
1116 strcat (combined
, ": ");
1117 strcat (combined
, err
);
1119 /* We want anything which was printed on stdout to come out first, before
1121 gdb_flush (gdb_stdout
);
1122 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
1125 /* Control C eventually causes this to be called, at a convenient time. */
1131 /* No steenking SIGINT will ever be coming our way when the
1132 program is resumed. Don't lie. */
1136 /* If there is no terminal switching for this target, then we can't
1137 possibly get screwed by the lack of job control. */
1138 || current_target
.to_terminal_ours
== NULL
)
1141 fatal ("Quit (expect signal SIGINT when the program is resumed)");
1146 /* Called when a memory allocation fails, with the number of bytes of
1147 memory requested in SIZE. */
1150 malloc_failure (long size
)
1154 internal_error (__FILE__
, __LINE__
,
1155 _("virtual memory exhausted: can't allocate %ld bytes."),
1160 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
1164 /* My replacement for the read system call.
1165 Used like `read' but keeps going if `read' returns too soon. */
1168 myread (int desc
, char *addr
, int len
)
1175 val
= read (desc
, addr
, len
);
1179 return orglen
- len
;
1187 print_spaces (int n
, struct ui_file
*file
)
1189 fputs_unfiltered (n_spaces (n
), file
);
1192 /* Print a host address. */
1195 gdb_print_host_address (const void *addr
, struct ui_file
*stream
)
1197 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
1201 /* A cleanup function that calls regfree. */
1204 do_regfree_cleanup (void *r
)
1209 /* Create a new cleanup that frees the compiled regular expression R. */
1212 make_regfree_cleanup (regex_t
*r
)
1214 return make_cleanup (do_regfree_cleanup
, r
);
1217 /* Return an xmalloc'd error message resulting from a regular
1218 expression compilation failure. */
1221 get_regcomp_error (int code
, regex_t
*rx
)
1223 size_t length
= regerror (code
, rx
, NULL
, 0);
1224 char *result
= xmalloc (length
);
1226 regerror (code
, rx
, result
, length
);
1232 /* This function supports the query, nquery, and yquery functions.
1233 Ask user a y-or-n question and return 0 if answer is no, 1 if
1234 answer is yes, or default the answer to the specified default
1235 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1236 default answer, or '\0' for no default.
1237 CTLSTR is the control string and should end in "? ". It should
1238 not say how to answer, because we do that.
1239 ARGS are the arguments passed along with the CTLSTR argument to
1242 static int ATTRIBUTE_PRINTF (1, 0)
1243 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
1249 char def_answer
, not_def_answer
;
1250 char *y_string
, *n_string
, *question
;
1251 /* Used to add duration we waited for user to respond to
1252 prompt_for_continue_wait_time. */
1253 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1255 /* Set up according to which answer is the default. */
1256 if (defchar
== '\0')
1260 not_def_answer
= 'N';
1264 else if (defchar
== 'y')
1268 not_def_answer
= 'N';
1276 not_def_answer
= 'Y';
1281 /* Automatically answer the default value if the user did not want
1282 prompts or the command was issued with the server prefix. */
1283 if (!confirm
|| server_command
)
1286 /* If input isn't coming from the user directly, just say what
1287 question we're asking, and then answer the default automatically. This
1288 way, important error messages don't get lost when talking to GDB
1290 if (! input_from_terminal_p ())
1293 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
1295 printf_filtered (_("(%s or %s) [answered %c; "
1296 "input not from terminal]\n"),
1297 y_string
, n_string
, def_answer
);
1298 gdb_flush (gdb_stdout
);
1303 if (deprecated_query_hook
)
1305 return deprecated_query_hook (ctlstr
, args
);
1308 /* Format the question outside of the loop, to avoid reusing args. */
1309 question
= xstrvprintf (ctlstr
, args
);
1311 /* Used for calculating time spend waiting for user. */
1312 gettimeofday (&prompt_started
, NULL
);
1316 wrap_here (""); /* Flush any buffered output. */
1317 gdb_flush (gdb_stdout
);
1319 if (annotation_level
> 1)
1320 printf_filtered (("\n\032\032pre-query\n"));
1322 fputs_filtered (question
, gdb_stdout
);
1323 printf_filtered (_("(%s or %s) "), y_string
, n_string
);
1325 if (annotation_level
> 1)
1326 printf_filtered (("\n\032\032query\n"));
1329 gdb_flush (gdb_stdout
);
1331 answer
= fgetc (stdin
);
1333 /* We expect fgetc to block until a character is read. But
1334 this may not be the case if the terminal was opened with
1335 the NONBLOCK flag. In that case, if there is nothing to
1336 read on stdin, fgetc returns EOF, but also sets the error
1337 condition flag on stdin and errno to EAGAIN. With a true
1338 EOF, stdin's error condition flag is not set.
1340 A situation where this behavior was observed is a pseudo
1342 while (answer
== EOF
&& ferror (stdin
) && errno
== EAGAIN
)
1344 /* Not a real EOF. Wait a little while and try again until
1345 we read something. */
1348 answer
= fgetc (stdin
);
1351 clearerr (stdin
); /* in case of C-d */
1352 if (answer
== EOF
) /* C-d */
1354 printf_filtered ("EOF [assumed %c]\n", def_answer
);
1358 /* Eat rest of input line, to EOF or newline. */
1362 ans2
= fgetc (stdin
);
1365 while (ans2
!= EOF
&& ans2
!= '\n' && ans2
!= '\r');
1369 /* Check answer. For the non-default, the user must specify
1370 the non-default explicitly. */
1371 if (answer
== not_def_answer
)
1373 retval
= !def_value
;
1376 /* Otherwise, if a default was specified, the user may either
1377 specify the required input or have it default by entering
1379 if (answer
== def_answer
1380 || (defchar
!= '\0' &&
1381 (answer
== '\n' || answer
== '\r' || answer
== EOF
)))
1386 /* Invalid entries are not defaulted and require another selection. */
1387 printf_filtered (_("Please answer %s or %s.\n"),
1388 y_string
, n_string
);
1391 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1392 gettimeofday (&prompt_ended
, NULL
);
1393 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1394 timeval_add (&prompt_for_continue_wait_time
,
1395 &prompt_for_continue_wait_time
, &prompt_delta
);
1398 if (annotation_level
> 1)
1399 printf_filtered (("\n\032\032post-query\n"));
1404 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1405 answer is yes, or 0 if answer is defaulted.
1406 Takes three args which are given to printf to print the question.
1407 The first, a control string, should end in "? ".
1408 It should not say how to answer, because we do that. */
1411 nquery (const char *ctlstr
, ...)
1416 va_start (args
, ctlstr
);
1417 ret
= defaulted_query (ctlstr
, 'n', args
);
1422 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1423 answer is yes, or 1 if answer is defaulted.
1424 Takes three args which are given to printf to print the question.
1425 The first, a control string, should end in "? ".
1426 It should not say how to answer, because we do that. */
1429 yquery (const char *ctlstr
, ...)
1434 va_start (args
, ctlstr
);
1435 ret
= defaulted_query (ctlstr
, 'y', args
);
1440 /* Ask user a y-or-n question and return 1 iff answer is yes.
1441 Takes three args which are given to printf to print the question.
1442 The first, a control string, should end in "? ".
1443 It should not say how to answer, because we do that. */
1446 query (const char *ctlstr
, ...)
1451 va_start (args
, ctlstr
);
1452 ret
= defaulted_query (ctlstr
, '\0', args
);
1457 /* A helper for parse_escape that converts a host character to a
1458 target character. C is the host character. If conversion is
1459 possible, then the target character is stored in *TARGET_C and the
1460 function returns 1. Otherwise, the function returns 0. */
1463 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1465 struct obstack host_data
;
1467 struct cleanup
*cleanups
;
1470 obstack_init (&host_data
);
1471 cleanups
= make_cleanup_obstack_free (&host_data
);
1473 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1474 (gdb_byte
*) &the_char
, 1, 1,
1475 &host_data
, translit_none
);
1477 if (obstack_object_size (&host_data
) == 1)
1480 *target_c
= *(char *) obstack_base (&host_data
);
1483 do_cleanups (cleanups
);
1487 /* Parse a C escape sequence. STRING_PTR points to a variable
1488 containing a pointer to the string to parse. That pointer
1489 should point to the character after the \. That pointer
1490 is updated past the characters we use. The value of the
1491 escape sequence is returned.
1493 A negative value means the sequence \ newline was seen,
1494 which is supposed to be equivalent to nothing at all.
1496 If \ is followed by a null character, we return a negative
1497 value and leave the string pointer pointing at the null character.
1499 If \ is followed by 000, we return 0 and leave the string pointer
1500 after the zeros. A value of 0 does not mean end of string. */
1503 parse_escape (struct gdbarch
*gdbarch
, char **string_ptr
)
1505 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1506 int c
= *(*string_ptr
)++;
1525 int i
= host_hex_value (c
);
1530 if (isdigit (c
) && c
!= '8' && c
!= '9')
1534 i
+= host_hex_value (c
);
1570 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1571 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1572 " which has no equivalent\nin the `%s' character set."),
1573 c
, c
, target_charset (gdbarch
));
1577 /* Print the character C on STREAM as part of the contents of a literal
1578 string whose delimiter is QUOTER. Note that this routine should only
1579 be call for printing things which are independent of the language
1580 of the program being debugged. */
1583 printchar (int c
, void (*do_fputs
) (const char *, struct ui_file
*),
1584 void (*do_fprintf
) (struct ui_file
*, const char *, ...)
1585 ATTRIBUTE_FPTR_PRINTF_2
, struct ui_file
*stream
, int quoter
)
1587 c
&= 0xFF; /* Avoid sign bit follies */
1589 if (c
< 0x20 || /* Low control chars */
1590 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1591 (sevenbit_strings
&& c
>= 0x80))
1592 { /* high order bit set */
1596 do_fputs ("\\n", stream
);
1599 do_fputs ("\\b", stream
);
1602 do_fputs ("\\t", stream
);
1605 do_fputs ("\\f", stream
);
1608 do_fputs ("\\r", stream
);
1611 do_fputs ("\\e", stream
);
1614 do_fputs ("\\a", stream
);
1617 do_fprintf (stream
, "\\%.3o", (unsigned int) c
);
1623 if (c
== '\\' || c
== quoter
)
1624 do_fputs ("\\", stream
);
1625 do_fprintf (stream
, "%c", c
);
1629 /* Print the character C on STREAM as part of the contents of a
1630 literal string whose delimiter is QUOTER. Note that these routines
1631 should only be call for printing things which are independent of
1632 the language of the program being debugged. */
1635 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1638 printchar (*str
++, fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1642 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1645 printchar (*str
++, fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1649 fputstrn_filtered (const char *str
, int n
, int quoter
,
1650 struct ui_file
*stream
)
1654 for (i
= 0; i
< n
; i
++)
1655 printchar (str
[i
], fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1659 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1660 struct ui_file
*stream
)
1664 for (i
= 0; i
< n
; i
++)
1665 printchar (str
[i
], fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1669 /* Number of lines per page or UINT_MAX if paging is disabled. */
1670 static unsigned int lines_per_page
;
1672 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1673 struct cmd_list_element
*c
, const char *value
)
1675 fprintf_filtered (file
,
1676 _("Number of lines gdb thinks are in a page is %s.\n"),
1680 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1681 static unsigned int chars_per_line
;
1683 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1684 struct cmd_list_element
*c
, const char *value
)
1686 fprintf_filtered (file
,
1687 _("Number of characters gdb thinks "
1688 "are in a line is %s.\n"),
1692 /* Current count of lines printed on this page, chars on this line. */
1693 static unsigned int lines_printed
, chars_printed
;
1695 /* Buffer and start column of buffered text, for doing smarter word-
1696 wrapping. When someone calls wrap_here(), we start buffering output
1697 that comes through fputs_filtered(). If we see a newline, we just
1698 spit it out and forget about the wrap_here(). If we see another
1699 wrap_here(), we spit it out and remember the newer one. If we see
1700 the end of the line, we spit out a newline, the indent, and then
1701 the buffered output. */
1703 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1704 are waiting to be output (they have already been counted in chars_printed).
1705 When wrap_buffer[0] is null, the buffer is empty. */
1706 static char *wrap_buffer
;
1708 /* Pointer in wrap_buffer to the next character to fill. */
1709 static char *wrap_pointer
;
1711 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1713 static char *wrap_indent
;
1715 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1716 is not in effect. */
1717 static int wrap_column
;
1720 /* Inialize the number of lines per page and chars per line. */
1723 init_page_info (void)
1727 lines_per_page
= UINT_MAX
;
1728 chars_per_line
= UINT_MAX
;
1732 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1737 #if defined(__GO32__)
1738 rows
= ScreenRows ();
1739 cols
= ScreenCols ();
1740 lines_per_page
= rows
;
1741 chars_per_line
= cols
;
1743 /* Make sure Readline has initialized its terminal settings. */
1744 rl_reset_terminal (NULL
);
1746 /* Get the screen size from Readline. */
1747 rl_get_screen_size (&rows
, &cols
);
1748 lines_per_page
= rows
;
1749 chars_per_line
= cols
;
1751 /* Readline should have fetched the termcap entry for us. */
1752 if (tgetnum ("li") < 0 || getenv ("EMACS"))
1754 /* The number of lines per page is not mentioned in the
1755 terminal description. This probably means that paging is
1756 not useful (e.g. emacs shell window), so disable paging. */
1757 lines_per_page
= UINT_MAX
;
1760 /* If the output is not a terminal, don't paginate it. */
1761 if (!ui_file_isatty (gdb_stdout
))
1762 lines_per_page
= UINT_MAX
;
1770 /* Helper for make_cleanup_restore_page_info. */
1773 do_restore_page_info_cleanup (void *arg
)
1779 /* Provide cleanup for restoring the terminal size. */
1782 make_cleanup_restore_page_info (void)
1784 struct cleanup
*back_to
;
1786 back_to
= make_cleanup (do_restore_page_info_cleanup
, NULL
);
1787 make_cleanup_restore_uinteger (&lines_per_page
);
1788 make_cleanup_restore_uinteger (&chars_per_line
);
1793 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1794 Provide cleanup for restoring the original state. */
1797 set_batch_flag_and_make_cleanup_restore_page_info (void)
1799 struct cleanup
*back_to
= make_cleanup_restore_page_info ();
1801 make_cleanup_restore_integer (&batch_flag
);
1808 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1811 set_screen_size (void)
1813 int rows
= lines_per_page
;
1814 int cols
= chars_per_line
;
1822 /* Update Readline's idea of the terminal size. */
1823 rl_set_screen_size (rows
, cols
);
1826 /* Reinitialize WRAP_BUFFER according to the current value of
1832 if (chars_per_line
== 0)
1837 wrap_buffer
= (char *) xmalloc (chars_per_line
+ 2);
1838 wrap_buffer
[0] = '\0';
1841 wrap_buffer
= (char *) xrealloc (wrap_buffer
, chars_per_line
+ 2);
1842 wrap_pointer
= wrap_buffer
; /* Start it at the beginning. */
1846 set_width_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1853 set_height_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1858 /* Wait, so the user can read what's on the screen. Prompt the user
1859 to continue by pressing RETURN. */
1862 prompt_for_continue (void)
1865 char cont_prompt
[120];
1866 /* Used to add duration we waited for user to respond to
1867 prompt_for_continue_wait_time. */
1868 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1870 gettimeofday (&prompt_started
, NULL
);
1872 if (annotation_level
> 1)
1873 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1875 strcpy (cont_prompt
,
1876 "---Type <return> to continue, or q <return> to quit---");
1877 if (annotation_level
> 1)
1878 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1880 /* We must do this *before* we call gdb_readline, else it will eventually
1881 call us -- thinking that we're trying to print beyond the end of the
1883 reinitialize_more_filter ();
1887 /* On a real operating system, the user can quit with SIGINT.
1890 'q' is provided on all systems so users don't have to change habits
1891 from system to system, and because telling them what to do in
1892 the prompt is more user-friendly than expecting them to think of
1894 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1895 whereas control-C to gdb_readline will cause the user to get dumped
1897 ignore
= gdb_readline_wrapper (cont_prompt
);
1899 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1900 gettimeofday (&prompt_ended
, NULL
);
1901 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1902 timeval_add (&prompt_for_continue_wait_time
,
1903 &prompt_for_continue_wait_time
, &prompt_delta
);
1905 if (annotation_level
> 1)
1906 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1912 while (*p
== ' ' || *p
== '\t')
1920 /* Now we have to do this again, so that GDB will know that it doesn't
1921 need to save the ---Type <return>--- line at the top of the screen. */
1922 reinitialize_more_filter ();
1924 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1927 /* Reinitialize filter; ie. tell it to reset to original values. */
1930 reinitialize_more_filter (void)
1936 /* Indicate that if the next sequence of characters overflows the line,
1937 a newline should be inserted here rather than when it hits the end.
1938 If INDENT is non-null, it is a string to be printed to indent the
1939 wrapped part on the next line. INDENT must remain accessible until
1940 the next call to wrap_here() or until a newline is printed through
1943 If the line is already overfull, we immediately print a newline and
1944 the indentation, and disable further wrapping.
1946 If we don't know the width of lines, but we know the page height,
1947 we must not wrap words, but should still keep track of newlines
1948 that were explicitly printed.
1950 INDENT should not contain tabs, as that will mess up the char count
1951 on the next line. FIXME.
1953 This routine is guaranteed to force out any output which has been
1954 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1955 used to force out output from the wrap_buffer. */
1958 wrap_here (char *indent
)
1960 /* This should have been allocated, but be paranoid anyway. */
1962 internal_error (__FILE__
, __LINE__
,
1963 _("failed internal consistency check"));
1967 *wrap_pointer
= '\0';
1968 fputs_unfiltered (wrap_buffer
, gdb_stdout
);
1970 wrap_pointer
= wrap_buffer
;
1971 wrap_buffer
[0] = '\0';
1972 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1976 else if (chars_printed
>= chars_per_line
)
1978 puts_filtered ("\n");
1980 puts_filtered (indent
);
1985 wrap_column
= chars_printed
;
1989 wrap_indent
= indent
;
1993 /* Print input string to gdb_stdout, filtered, with wrap,
1994 arranging strings in columns of n chars. String can be
1995 right or left justified in the column. Never prints
1996 trailing spaces. String should never be longer than
1997 width. FIXME: this could be useful for the EXAMINE
1998 command, which currently doesn't tabulate very well. */
2001 puts_filtered_tabular (char *string
, int width
, int right
)
2007 gdb_assert (chars_per_line
> 0);
2008 if (chars_per_line
== UINT_MAX
)
2010 fputs_filtered (string
, gdb_stdout
);
2011 fputs_filtered ("\n", gdb_stdout
);
2015 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
2016 fputs_filtered ("\n", gdb_stdout
);
2018 if (width
>= chars_per_line
)
2019 width
= chars_per_line
- 1;
2021 stringlen
= strlen (string
);
2023 if (chars_printed
> 0)
2024 spaces
= width
- (chars_printed
- 1) % width
- 1;
2026 spaces
+= width
- stringlen
;
2028 spacebuf
= alloca (spaces
+ 1);
2029 spacebuf
[spaces
] = '\0';
2031 spacebuf
[spaces
] = ' ';
2033 fputs_filtered (spacebuf
, gdb_stdout
);
2034 fputs_filtered (string
, gdb_stdout
);
2038 /* Ensure that whatever gets printed next, using the filtered output
2039 commands, starts at the beginning of the line. I.e. if there is
2040 any pending output for the current line, flush it and start a new
2041 line. Otherwise do nothing. */
2046 if (chars_printed
> 0)
2048 puts_filtered ("\n");
2053 /* Like fputs but if FILTER is true, pause after every screenful.
2055 Regardless of FILTER can wrap at points other than the final
2056 character of a line.
2058 Unlike fputs, fputs_maybe_filtered does not return a value.
2059 It is OK for LINEBUFFER to be NULL, in which case just don't print
2062 Note that a longjmp to top level may occur in this routine (only if
2063 FILTER is true) (since prompt_for_continue may do so) so this
2064 routine should not be called when cleanups are not in place. */
2067 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
2070 const char *lineptr
;
2072 if (linebuffer
== 0)
2075 /* Don't do any filtering if it is disabled. */
2076 if (stream
!= gdb_stdout
2077 || !pagination_enabled
2079 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
2080 || top_level_interpreter () == NULL
2081 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2083 fputs_unfiltered (linebuffer
, stream
);
2087 /* Go through and output each character. Show line extension
2088 when this is necessary; prompt user for new page when this is
2091 lineptr
= linebuffer
;
2094 /* Possible new page. */
2095 if (filter
&& (lines_printed
>= lines_per_page
- 1))
2096 prompt_for_continue ();
2098 while (*lineptr
&& *lineptr
!= '\n')
2100 /* Print a single line. */
2101 if (*lineptr
== '\t')
2104 *wrap_pointer
++ = '\t';
2106 fputc_unfiltered ('\t', stream
);
2107 /* Shifting right by 3 produces the number of tab stops
2108 we have already passed, and then adding one and
2109 shifting left 3 advances to the next tab stop. */
2110 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
2116 *wrap_pointer
++ = *lineptr
;
2118 fputc_unfiltered (*lineptr
, stream
);
2123 if (chars_printed
>= chars_per_line
)
2125 unsigned int save_chars
= chars_printed
;
2129 /* If we aren't actually wrapping, don't output newline --
2130 if chars_per_line is right, we probably just overflowed
2131 anyway; if it's wrong, let us keep going. */
2133 fputc_unfiltered ('\n', stream
);
2135 /* Possible new page. */
2136 if (lines_printed
>= lines_per_page
- 1)
2137 prompt_for_continue ();
2139 /* Now output indentation and wrapped string. */
2142 fputs_unfiltered (wrap_indent
, stream
);
2143 *wrap_pointer
= '\0'; /* Null-terminate saved stuff, */
2144 fputs_unfiltered (wrap_buffer
, stream
); /* and eject it. */
2145 /* FIXME, this strlen is what prevents wrap_indent from
2146 containing tabs. However, if we recurse to print it
2147 and count its chars, we risk trouble if wrap_indent is
2148 longer than (the user settable) chars_per_line.
2149 Note also that this can set chars_printed > chars_per_line
2150 if we are printing a long string. */
2151 chars_printed
= strlen (wrap_indent
)
2152 + (save_chars
- wrap_column
);
2153 wrap_pointer
= wrap_buffer
; /* Reset buffer */
2154 wrap_buffer
[0] = '\0';
2155 wrap_column
= 0; /* And disable fancy wrap */
2160 if (*lineptr
== '\n')
2163 wrap_here ((char *) 0); /* Spit out chars, cancel
2166 fputc_unfiltered ('\n', stream
);
2173 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
2175 fputs_maybe_filtered (linebuffer
, stream
, 1);
2179 putchar_unfiltered (int c
)
2183 ui_file_write (gdb_stdout
, &buf
, 1);
2187 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2188 May return nonlocally. */
2191 putchar_filtered (int c
)
2193 return fputc_filtered (c
, gdb_stdout
);
2197 fputc_unfiltered (int c
, struct ui_file
*stream
)
2201 ui_file_write (stream
, &buf
, 1);
2206 fputc_filtered (int c
, struct ui_file
*stream
)
2212 fputs_filtered (buf
, stream
);
2216 /* puts_debug is like fputs_unfiltered, except it prints special
2217 characters in printable fashion. */
2220 puts_debug (char *prefix
, char *string
, char *suffix
)
2224 /* Print prefix and suffix after each line. */
2225 static int new_line
= 1;
2226 static int return_p
= 0;
2227 static char *prev_prefix
= "";
2228 static char *prev_suffix
= "";
2230 if (*string
== '\n')
2233 /* If the prefix is changing, print the previous suffix, a new line,
2234 and the new prefix. */
2235 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
2237 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
2238 fputs_unfiltered ("\n", gdb_stdlog
);
2239 fputs_unfiltered (prefix
, gdb_stdlog
);
2242 /* Print prefix if we printed a newline during the previous call. */
2246 fputs_unfiltered (prefix
, gdb_stdlog
);
2249 prev_prefix
= prefix
;
2250 prev_suffix
= suffix
;
2252 /* Output characters in a printable format. */
2253 while ((ch
= *string
++) != '\0')
2259 fputc_unfiltered (ch
, gdb_stdlog
);
2262 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2266 fputs_unfiltered ("\\\\", gdb_stdlog
);
2269 fputs_unfiltered ("\\b", gdb_stdlog
);
2272 fputs_unfiltered ("\\f", gdb_stdlog
);
2276 fputs_unfiltered ("\\n", gdb_stdlog
);
2279 fputs_unfiltered ("\\r", gdb_stdlog
);
2282 fputs_unfiltered ("\\t", gdb_stdlog
);
2285 fputs_unfiltered ("\\v", gdb_stdlog
);
2289 return_p
= ch
== '\r';
2292 /* Print suffix if we printed a newline. */
2295 fputs_unfiltered (suffix
, gdb_stdlog
);
2296 fputs_unfiltered ("\n", gdb_stdlog
);
2301 /* Print a variable number of ARGS using format FORMAT. If this
2302 information is going to put the amount written (since the last call
2303 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2304 call prompt_for_continue to get the users permision to continue.
2306 Unlike fprintf, this function does not return a value.
2308 We implement three variants, vfprintf (takes a vararg list and stream),
2309 fprintf (takes a stream to write on), and printf (the usual).
2311 Note also that a longjmp to top level may occur in this routine
2312 (since prompt_for_continue may do so) so this routine should not be
2313 called when cleanups are not in place. */
2316 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2317 va_list args
, int filter
)
2320 struct cleanup
*old_cleanups
;
2322 linebuffer
= xstrvprintf (format
, args
);
2323 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2324 fputs_maybe_filtered (linebuffer
, stream
, filter
);
2325 do_cleanups (old_cleanups
);
2330 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2332 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2336 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2339 struct cleanup
*old_cleanups
;
2341 linebuffer
= xstrvprintf (format
, args
);
2342 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2343 if (debug_timestamp
&& stream
== gdb_stdlog
)
2349 gettimeofday (&tm
, NULL
);
2351 len
= strlen (linebuffer
);
2352 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2354 timestamp
= xstrprintf ("%ld:%ld %s%s",
2355 (long) tm
.tv_sec
, (long) tm
.tv_usec
,
2357 need_nl
? "\n": "");
2358 make_cleanup (xfree
, timestamp
);
2359 fputs_unfiltered (timestamp
, stream
);
2362 fputs_unfiltered (linebuffer
, stream
);
2363 do_cleanups (old_cleanups
);
2367 vprintf_filtered (const char *format
, va_list args
)
2369 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2373 vprintf_unfiltered (const char *format
, va_list args
)
2375 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2379 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2383 va_start (args
, format
);
2384 vfprintf_filtered (stream
, format
, args
);
2389 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2393 va_start (args
, format
);
2394 vfprintf_unfiltered (stream
, format
, args
);
2398 /* Like fprintf_filtered, but prints its result indented.
2399 Called as fprintfi_filtered (spaces, stream, format, ...); */
2402 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2407 va_start (args
, format
);
2408 print_spaces_filtered (spaces
, stream
);
2410 vfprintf_filtered (stream
, format
, args
);
2416 printf_filtered (const char *format
, ...)
2420 va_start (args
, format
);
2421 vfprintf_filtered (gdb_stdout
, format
, args
);
2427 printf_unfiltered (const char *format
, ...)
2431 va_start (args
, format
);
2432 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2436 /* Like printf_filtered, but prints it's result indented.
2437 Called as printfi_filtered (spaces, format, ...); */
2440 printfi_filtered (int spaces
, const char *format
, ...)
2444 va_start (args
, format
);
2445 print_spaces_filtered (spaces
, gdb_stdout
);
2446 vfprintf_filtered (gdb_stdout
, format
, args
);
2450 /* Easy -- but watch out!
2452 This routine is *not* a replacement for puts()! puts() appends a newline.
2453 This one doesn't, and had better not! */
2456 puts_filtered (const char *string
)
2458 fputs_filtered (string
, gdb_stdout
);
2462 puts_unfiltered (const char *string
)
2464 fputs_unfiltered (string
, gdb_stdout
);
2467 /* Return a pointer to N spaces and a null. The pointer is good
2468 until the next call to here. */
2473 static char *spaces
= 0;
2474 static int max_spaces
= -1;
2480 spaces
= (char *) xmalloc (n
+ 1);
2481 for (t
= spaces
+ n
; t
!= spaces
;)
2487 return spaces
+ max_spaces
- n
;
2490 /* Print N spaces. */
2492 print_spaces_filtered (int n
, struct ui_file
*stream
)
2494 fputs_filtered (n_spaces (n
), stream
);
2497 /* C++/ObjC demangler stuff. */
2499 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2500 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2501 If the name is not mangled, or the language for the name is unknown, or
2502 demangling is off, the name is printed in its "raw" form. */
2505 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2506 enum language lang
, int arg_mode
)
2512 /* If user wants to see raw output, no problem. */
2515 fputs_filtered (name
, stream
);
2519 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2520 fputs_filtered (demangled
? demangled
: name
, stream
);
2521 if (demangled
!= NULL
)
2529 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2530 differences in whitespace. Returns 0 if they match, non-zero if they
2531 don't (slightly different than strcmp()'s range of return values).
2533 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2534 This "feature" is useful when searching for matching C++ function names
2535 (such as if the user types 'break FOO', where FOO is a mangled C++
2539 strcmp_iw (const char *string1
, const char *string2
)
2541 while ((*string1
!= '\0') && (*string2
!= '\0'))
2543 while (isspace (*string1
))
2547 while (isspace (*string2
))
2551 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2553 if (case_sensitivity
== case_sensitive_off
2554 && (tolower ((unsigned char) *string1
)
2555 != tolower ((unsigned char) *string2
)))
2557 if (*string1
!= '\0')
2563 return (*string1
!= '\0' && *string1
!= '(') || (*string2
!= '\0');
2566 /* This is like strcmp except that it ignores whitespace and treats
2567 '(' as the first non-NULL character in terms of ordering. Like
2568 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2569 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2570 according to that ordering.
2572 If a list is sorted according to this function and if you want to
2573 find names in the list that match some fixed NAME according to
2574 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2575 where this function would put NAME.
2577 This function must be neutral to the CASE_SENSITIVITY setting as the user
2578 may choose it during later lookup. Therefore this function always sorts
2579 primarily case-insensitively and secondarily case-sensitively.
2581 Here are some examples of why using strcmp to sort is a bad idea:
2585 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2586 we try to do a search for "foo<char*>", strcmp will locate this
2587 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2588 will start looking at strings beginning with "goo", and will never
2589 see the correct match of "foo<char *>".
2591 Parenthesis example:
2593 In practice, this is less like to be an issue, but I'll give it a
2594 shot. Let's assume that '$' is a legitimate character to occur in
2595 symbols. (Which may well even be the case on some systems.) Then
2596 say that the partial symbol table contains "foo$" and "foo(int)".
2597 strcmp will put them in this order, since '$' < '('. Now, if the
2598 user searches for "foo", then strcmp will sort "foo" before "foo$".
2599 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2600 "foo") is false, so it won't proceed to the actual match of
2601 "foo(int)" with "foo". */
2604 strcmp_iw_ordered (const char *string1
, const char *string2
)
2606 const char *saved_string1
= string1
, *saved_string2
= string2
;
2607 enum case_sensitivity case_pass
= case_sensitive_off
;
2611 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2612 Provide stub characters if we are already at the end of one of the
2614 char c1
= 'X', c2
= 'X';
2616 while (*string1
!= '\0' && *string2
!= '\0')
2618 while (isspace (*string1
))
2620 while (isspace (*string2
))
2625 case case_sensitive_off
:
2626 c1
= tolower ((unsigned char) *string1
);
2627 c2
= tolower ((unsigned char) *string2
);
2629 case case_sensitive_on
:
2637 if (*string1
!= '\0')
2646 /* Characters are non-equal unless they're both '\0'; we want to
2647 make sure we get the comparison right according to our
2648 comparison in the cases where one of them is '\0' or '('. */
2650 if (*string2
== '\0')
2655 if (*string2
== '\0')
2660 if (*string2
== '\0' || *string2
== '(')
2669 if (case_pass
== case_sensitive_on
)
2672 /* Otherwise the strings were equal in case insensitive way, make
2673 a more fine grained comparison in a case sensitive way. */
2675 case_pass
= case_sensitive_on
;
2676 string1
= saved_string1
;
2677 string2
= saved_string2
;
2681 /* A simple comparison function with opposite semantics to strcmp. */
2684 streq (const char *lhs
, const char *rhs
)
2686 return !strcmp (lhs
, rhs
);
2692 ** Answer whether string_to_compare is a full or partial match to
2693 ** template_string. The partial match must be in sequence starting
2697 subset_compare (char *string_to_compare
, char *template_string
)
2701 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
2702 && strlen (string_to_compare
) <= strlen (template_string
))
2705 (template_string
, string_to_compare
, strlen (string_to_compare
)) == 0);
2712 pagination_on_command (char *arg
, int from_tty
)
2714 pagination_enabled
= 1;
2718 pagination_off_command (char *arg
, int from_tty
)
2720 pagination_enabled
= 0;
2724 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2725 struct cmd_list_element
*c
, const char *value
)
2727 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2733 initialize_utils (void)
2735 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
2736 Set number of characters where GDB should wrap lines of its output."), _("\
2737 Show number of characters where GDB should wrap lines of its output."), _("\
2738 This affects where GDB wraps its output to fit the screen width.\n\
2739 Setting this to zero prevents GDB from wrapping its output."),
2741 show_chars_per_line
,
2742 &setlist
, &showlist
);
2744 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
2745 Set number of lines in a page for GDB output pagination."), _("\
2746 Show number of lines in a page for GDB output pagination."), _("\
2747 This affects the number of lines after which GDB will pause\n\
2748 its output and ask you whether to continue.\n\
2749 Setting this to zero causes GDB never pause during output."),
2751 show_lines_per_page
,
2752 &setlist
, &showlist
);
2756 add_setshow_boolean_cmd ("pagination", class_support
,
2757 &pagination_enabled
, _("\
2758 Set state of GDB output pagination."), _("\
2759 Show state of GDB output pagination."), _("\
2760 When pagination is ON, GDB pauses at end of each screenful of\n\
2761 its output and asks you whether to continue.\n\
2762 Turning pagination off is an alternative to \"set height 0\"."),
2764 show_pagination_enabled
,
2765 &setlist
, &showlist
);
2769 add_com ("am", class_support
, pagination_on_command
,
2770 _("Enable pagination"));
2771 add_com ("sm", class_support
, pagination_off_command
,
2772 _("Disable pagination"));
2775 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
2776 &sevenbit_strings
, _("\
2777 Set printing of 8-bit characters in strings as \\nnn."), _("\
2778 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
2780 show_sevenbit_strings
,
2781 &setprintlist
, &showprintlist
);
2783 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
2784 &debug_timestamp
, _("\
2785 Set timestamping of debugging messages."), _("\
2786 Show timestamping of debugging messages."), _("\
2787 When set, debugging messages will be marked with seconds and microseconds."),
2789 show_debug_timestamp
,
2790 &setdebuglist
, &showdebuglist
);
2793 /* Print routines to handle variable size regs, etc. */
2794 /* Temporary storage using circular buffer. */
2800 static char buf
[NUMCELLS
][CELLSIZE
];
2801 static int cell
= 0;
2803 if (++cell
>= NUMCELLS
)
2809 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2811 /* Truncate address to the size of a target address, avoiding shifts
2812 larger or equal than the width of a CORE_ADDR. The local
2813 variable ADDR_BIT stops the compiler reporting a shift overflow
2814 when it won't occur. */
2815 /* NOTE: This assumes that the significant address information is
2816 kept in the least significant bits of ADDR - the upper bits were
2817 either zero or sign extended. Should gdbarch_address_to_pointer or
2818 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2820 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2822 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2823 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2824 return hex_string (addr
);
2827 /* This function is described in "defs.h". */
2830 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2832 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2834 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2835 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2837 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2838 that returns the language localized string formatted to a width
2839 based on gdbarch_addr_bit. */
2841 return hex_string_custom (address
, 8);
2843 return hex_string_custom (address
, 16);
2846 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2849 core_addr_hash (const void *ap
)
2851 const CORE_ADDR
*addrp
= ap
;
2856 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2859 core_addr_eq (const void *ap
, const void *bp
)
2861 const CORE_ADDR
*addr_ap
= ap
;
2862 const CORE_ADDR
*addr_bp
= bp
;
2864 return *addr_ap
== *addr_bp
;
2868 decimal2str (char *sign
, ULONGEST addr
, int width
)
2870 /* Steal code from valprint.c:print_decimal(). Should this worry
2871 about the real size of addr as the above does? */
2872 unsigned long temp
[3];
2873 char *str
= get_cell ();
2878 temp
[i
] = addr
% (1000 * 1000 * 1000);
2879 addr
/= (1000 * 1000 * 1000);
2883 while (addr
!= 0 && i
< (sizeof (temp
) / sizeof (temp
[0])));
2892 xsnprintf (str
, CELLSIZE
, "%s%0*lu", sign
, width
, temp
[0]);
2895 xsnprintf (str
, CELLSIZE
, "%s%0*lu%09lu", sign
, width
,
2899 xsnprintf (str
, CELLSIZE
, "%s%0*lu%09lu%09lu", sign
, width
,
2900 temp
[2], temp
[1], temp
[0]);
2903 internal_error (__FILE__
, __LINE__
,
2904 _("failed internal consistency check"));
2911 octal2str (ULONGEST addr
, int width
)
2913 unsigned long temp
[3];
2914 char *str
= get_cell ();
2919 temp
[i
] = addr
% (0100000 * 0100000);
2920 addr
/= (0100000 * 0100000);
2924 while (addr
!= 0 && i
< (sizeof (temp
) / sizeof (temp
[0])));
2934 xsnprintf (str
, CELLSIZE
, "%*o", width
, 0);
2936 xsnprintf (str
, CELLSIZE
, "0%0*lo", width
, temp
[0]);
2939 xsnprintf (str
, CELLSIZE
, "0%0*lo%010lo", width
, temp
[1], temp
[0]);
2942 xsnprintf (str
, CELLSIZE
, "0%0*lo%010lo%010lo", width
,
2943 temp
[2], temp
[1], temp
[0]);
2946 internal_error (__FILE__
, __LINE__
,
2947 _("failed internal consistency check"));
2954 pulongest (ULONGEST u
)
2956 return decimal2str ("", u
, 0);
2960 plongest (LONGEST l
)
2963 return decimal2str ("-", -l
, 0);
2965 return decimal2str ("", l
, 0);
2968 /* Eliminate warning from compiler on 32-bit systems. */
2969 static int thirty_two
= 32;
2972 phex (ULONGEST l
, int sizeof_l
)
2980 xsnprintf (str
, CELLSIZE
, "%08lx%08lx",
2981 (unsigned long) (l
>> thirty_two
),
2982 (unsigned long) (l
& 0xffffffff));
2986 xsnprintf (str
, CELLSIZE
, "%08lx", (unsigned long) l
);
2990 xsnprintf (str
, CELLSIZE
, "%04x", (unsigned short) (l
& 0xffff));
2993 str
= phex (l
, sizeof (l
));
3001 phex_nz (ULONGEST l
, int sizeof_l
)
3009 unsigned long high
= (unsigned long) (l
>> thirty_two
);
3013 xsnprintf (str
, CELLSIZE
, "%lx",
3014 (unsigned long) (l
& 0xffffffff));
3016 xsnprintf (str
, CELLSIZE
, "%lx%08lx", high
,
3017 (unsigned long) (l
& 0xffffffff));
3022 xsnprintf (str
, CELLSIZE
, "%lx", (unsigned long) l
);
3026 xsnprintf (str
, CELLSIZE
, "%x", (unsigned short) (l
& 0xffff));
3029 str
= phex_nz (l
, sizeof (l
));
3036 /* Converts a LONGEST to a C-format hexadecimal literal and stores it
3037 in a static string. Returns a pointer to this string. */
3039 hex_string (LONGEST num
)
3041 char *result
= get_cell ();
3043 xsnprintf (result
, CELLSIZE
, "0x%s", phex_nz (num
, sizeof (num
)));
3047 /* Converts a LONGEST number to a C-format hexadecimal literal and
3048 stores it in a static string. Returns a pointer to this string
3049 that is valid until the next call. The number is padded on the
3050 left with 0s to at least WIDTH characters. */
3052 hex_string_custom (LONGEST num
, int width
)
3054 char *result
= get_cell ();
3055 char *result_end
= result
+ CELLSIZE
- 1;
3056 const char *hex
= phex_nz (num
, sizeof (num
));
3057 int hex_len
= strlen (hex
);
3059 if (hex_len
> width
)
3061 if (width
+ 2 >= CELLSIZE
)
3062 internal_error (__FILE__
, __LINE__
, _("\
3063 hex_string_custom: insufficient space to store result"));
3065 strcpy (result_end
- width
- 2, "0x");
3066 memset (result_end
- width
, '0', width
);
3067 strcpy (result_end
- hex_len
, hex
);
3068 return result_end
- width
- 2;
3071 /* Convert VAL to a numeral in the given radix. For
3072 * radix 10, IS_SIGNED may be true, indicating a signed quantity;
3073 * otherwise VAL is interpreted as unsigned. If WIDTH is supplied,
3074 * it is the minimum width (0-padded if needed). USE_C_FORMAT means
3075 * to use C format in all cases. If it is false, then 'x'
3076 * and 'o' formats do not include a prefix (0x or leading 0). */
3079 int_string (LONGEST val
, int radix
, int is_signed
, int width
,
3089 result
= hex_string (val
);
3091 result
= hex_string_custom (val
, width
);
3098 if (is_signed
&& val
< 0)
3099 return decimal2str ("-", -val
, width
);
3101 return decimal2str ("", val
, width
);
3105 char *result
= octal2str (val
, width
);
3107 if (use_c_format
|| val
== 0)
3113 internal_error (__FILE__
, __LINE__
,
3114 _("failed internal consistency check"));
3118 /* Convert a CORE_ADDR into a string. */
3120 core_addr_to_string (const CORE_ADDR addr
)
3122 char *str
= get_cell ();
3125 strcat (str
, phex (addr
, sizeof (addr
)));
3130 core_addr_to_string_nz (const CORE_ADDR addr
)
3132 char *str
= get_cell ();
3135 strcat (str
, phex_nz (addr
, sizeof (addr
)));
3139 /* Convert a string back into a CORE_ADDR. */
3141 string_to_core_addr (const char *my_string
)
3145 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
3147 /* Assume that it is in hex. */
3150 for (i
= 2; my_string
[i
] != '\0'; i
++)
3152 if (isdigit (my_string
[i
]))
3153 addr
= (my_string
[i
] - '0') + (addr
* 16);
3154 else if (isxdigit (my_string
[i
]))
3155 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
3157 error (_("invalid hex \"%s\""), my_string
);
3162 /* Assume that it is in decimal. */
3165 for (i
= 0; my_string
[i
] != '\0'; i
++)
3167 if (isdigit (my_string
[i
]))
3168 addr
= (my_string
[i
] - '0') + (addr
* 10);
3170 error (_("invalid decimal \"%s\""), my_string
);
3178 host_address_to_string (const void *addr
)
3180 char *str
= get_cell ();
3182 xsnprintf (str
, CELLSIZE
, "0x%s", phex_nz ((uintptr_t) addr
, sizeof (addr
)));
3187 gdb_realpath (const char *filename
)
3189 /* Method 1: The system has a compile time upper bound on a filename
3190 path. Use that and realpath() to canonicalize the name. This is
3191 the most common case. Note that, if there isn't a compile time
3192 upper bound, you want to avoid realpath() at all costs. */
3193 #if defined(HAVE_REALPATH)
3195 # if defined (PATH_MAX)
3197 # define USE_REALPATH
3198 # elif defined (MAXPATHLEN)
3199 char buf
[MAXPATHLEN
];
3200 # define USE_REALPATH
3202 # if defined (USE_REALPATH)
3203 const char *rp
= realpath (filename
, buf
);
3207 return xstrdup (rp
);
3210 #endif /* HAVE_REALPATH */
3212 /* Method 2: The host system (i.e., GNU) has the function
3213 canonicalize_file_name() which malloc's a chunk of memory and
3214 returns that, use that. */
3215 #if defined(HAVE_CANONICALIZE_FILE_NAME)
3217 char *rp
= canonicalize_file_name (filename
);
3220 return xstrdup (filename
);
3226 /* FIXME: cagney/2002-11-13:
3228 Method 2a: Use realpath() with a NULL buffer. Some systems, due
3229 to the problems described in method 3, have modified their
3230 realpath() implementation so that it will allocate a buffer when
3231 NULL is passed in. Before this can be used, though, some sort of
3232 configure time test would need to be added. Otherwize the code
3233 will likely core dump. */
3235 /* Method 3: Now we're getting desperate! The system doesn't have a
3236 compile time buffer size and no alternative function. Query the
3237 OS, using pathconf(), for the buffer limit. Care is needed
3238 though, some systems do not limit PATH_MAX (return -1 for
3239 pathconf()) making it impossible to pass a correctly sized buffer
3240 to realpath() (it could always overflow). On those systems, we
3242 #if defined (HAVE_REALPATH) && defined (HAVE_UNISTD_H) && defined(HAVE_ALLOCA)
3244 /* Find out the max path size. */
3245 long path_max
= pathconf ("/", _PC_PATH_MAX
);
3249 /* PATH_MAX is bounded. */
3250 char *buf
= alloca (path_max
);
3251 char *rp
= realpath (filename
, buf
);
3253 return xstrdup (rp
? rp
: filename
);
3258 /* The MS Windows method. If we don't have realpath, we assume we
3259 don't have symlinks and just canonicalize to a Windows absolute
3260 path. GetFullPath converts ../ and ./ in relative paths to
3261 absolute paths, filling in current drive if one is not given
3262 or using the current directory of a specified drive (eg, "E:foo").
3263 It also converts all forward slashes to back slashes. */
3264 /* The file system is case-insensitive but case-preserving.
3265 So we do not lowercase the path. Otherwise, we might not
3266 be able to display the original casing in a given path. */
3267 #if defined (_WIN32)
3270 DWORD len
= GetFullPathName (filename
, MAX_PATH
, buf
, NULL
);
3272 if (len
> 0 && len
< MAX_PATH
)
3273 return xstrdup (buf
);
3277 /* This system is a lost cause, just dup the buffer. */
3278 return xstrdup (filename
);
3282 align_up (ULONGEST v
, int n
)
3284 /* Check that N is really a power of two. */
3285 gdb_assert (n
&& (n
& (n
-1)) == 0);
3286 return (v
+ n
- 1) & -n
;
3290 align_down (ULONGEST v
, int n
)
3292 /* Check that N is really a power of two. */
3293 gdb_assert (n
&& (n
& (n
-1)) == 0);
3297 /* Allocation function for the libiberty hash table which uses an
3298 obstack. The obstack is passed as DATA. */
3301 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
3303 unsigned int total
= size
* count
;
3304 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
3306 memset (ptr
, 0, total
);
3310 /* Trivial deallocation function for the libiberty splay tree and hash
3311 table - don't deallocate anything. Rely on later deletion of the
3312 obstack. DATA will be the obstack, although it is not needed
3316 dummy_obstack_deallocate (void *object
, void *data
)
3321 /* The bit offset of the highest byte in a ULONGEST, for overflow
3324 #define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT)
3326 /* True (non-zero) iff DIGIT is a valid digit in radix BASE,
3327 where 2 <= BASE <= 36. */
3330 is_digit_in_base (unsigned char digit
, int base
)
3332 if (!isalnum (digit
))
3335 return (isdigit (digit
) && digit
< base
+ '0');
3337 return (isdigit (digit
) || tolower (digit
) < base
- 10 + 'a');
3341 digit_to_int (unsigned char c
)
3346 return tolower (c
) - 'a' + 10;
3349 /* As for strtoul, but for ULONGEST results. */
3352 strtoulst (const char *num
, const char **trailer
, int base
)
3354 unsigned int high_part
;
3359 /* Skip leading whitespace. */
3360 while (isspace (num
[i
]))
3363 /* Handle prefixes. */
3366 else if (num
[i
] == '-')
3372 if (base
== 0 || base
== 16)
3374 if (num
[i
] == '0' && (num
[i
+ 1] == 'x' || num
[i
+ 1] == 'X'))
3382 if (base
== 0 && num
[i
] == '0')
3388 if (base
< 2 || base
> 36)
3394 result
= high_part
= 0;
3395 for (; is_digit_in_base (num
[i
], base
); i
+= 1)
3397 result
= result
* base
+ digit_to_int (num
[i
]);
3398 high_part
= high_part
* base
+ (unsigned int) (result
>> HIGH_BYTE_POSN
);
3399 result
&= ((ULONGEST
) 1 << HIGH_BYTE_POSN
) - 1;
3400 if (high_part
> 0xff)
3403 result
= ~ (ULONGEST
) 0;
3410 if (trailer
!= NULL
)
3413 result
= result
+ ((ULONGEST
) high_part
<< HIGH_BYTE_POSN
);
3420 /* Simple, portable version of dirname that does not modify its
3424 ldirname (const char *filename
)
3426 const char *base
= lbasename (filename
);
3429 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
3432 if (base
== filename
)
3435 dirname
= xmalloc (base
- filename
+ 2);
3436 memcpy (dirname
, filename
, base
- filename
);
3438 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3439 create "d:./bar" later instead of the (different) "d:/bar". */
3440 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3441 && !IS_DIR_SEPARATOR (filename
[0]))
3442 dirname
[base
++ - filename
] = '.';
3444 dirname
[base
- filename
] = '\0';
3448 /* Call libiberty's buildargv, and return the result.
3449 If buildargv fails due to out-of-memory, call nomem.
3450 Therefore, the returned value is guaranteed to be non-NULL,
3451 unless the parameter itself is NULL. */
3454 gdb_buildargv (const char *s
)
3456 char **argv
= buildargv (s
);
3458 if (s
!= NULL
&& argv
== NULL
)
3464 compare_positive_ints (const void *ap
, const void *bp
)
3466 /* Because we know we're comparing two ints which are positive,
3467 there's no danger of overflow here. */
3468 return * (int *) ap
- * (int *) bp
;
3471 /* String compare function for qsort. */
3474 compare_strings (const void *arg1
, const void *arg2
)
3476 const char **s1
= (const char **) arg1
;
3477 const char **s2
= (const char **) arg2
;
3479 return strcmp (*s1
, *s2
);
3482 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3483 #define AMBIGUOUS_MESS2 \
3484 ".\nUse \"set gnutarget format-name\" to specify the format."
3487 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3493 /* Check if errmsg just need simple return. */
3494 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3495 return bfd_errmsg (error_tag
);
3497 ret_len
= strlen (bfd_errmsg (error_tag
)) + strlen (AMBIGUOUS_MESS1
)
3498 + strlen (AMBIGUOUS_MESS2
);
3499 for (p
= matching
; *p
; p
++)
3500 ret_len
+= strlen (*p
) + 1;
3501 ret
= xmalloc (ret_len
+ 1);
3503 make_cleanup (xfree
, ret
);
3505 strcpy (retp
, bfd_errmsg (error_tag
));
3506 retp
+= strlen (retp
);
3508 strcpy (retp
, AMBIGUOUS_MESS1
);
3509 retp
+= strlen (retp
);
3511 for (p
= matching
; *p
; p
++)
3513 sprintf (retp
, " %s", *p
);
3514 retp
+= strlen (retp
);
3518 strcpy (retp
, AMBIGUOUS_MESS2
);
3523 /* Return ARGS parsed as a valid pid, or throw an error. */
3526 parse_pid_to_attach (char *args
)
3532 error_no_arg (_("process-id to attach"));
3535 pid
= strtoul (args
, &dummy
, 0);
3536 /* Some targets don't set errno on errors, grrr! */
3537 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3538 error (_("Illegal process-id: %s."), args
);
3543 /* Helper for make_bpstat_clear_actions_cleanup. */
3546 do_bpstat_clear_actions_cleanup (void *unused
)
3548 bpstat_clear_actions ();
3551 /* Call bpstat_clear_actions for the case an exception is throw. You should
3552 discard_cleanups if no exception is caught. */
3555 make_bpstat_clear_actions_cleanup (void)
3557 return make_cleanup (do_bpstat_clear_actions_cleanup
, NULL
);
3560 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3561 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3562 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3565 producer_is_gcc_ge_4 (const char *producer
)
3570 if (producer
== NULL
)
3572 /* For unknown compilers expect their behavior is not compliant. For GCC
3573 this case can also happen for -gdwarf-4 type units supported since
3579 /* Skip any identifier after "GNU " - such as "C++" or "Java". */
3581 if (strncmp (producer
, "GNU ", strlen ("GNU ")) != 0)
3583 /* For non-GCC compilers expect their behavior is not compliant. */
3587 cs
= &producer
[strlen ("GNU ")];
3588 while (*cs
&& !isdigit (*cs
))
3590 if (sscanf (cs
, "%d.%d", &major
, &minor
) != 2)
3592 /* Not recognized as GCC. */
3604 /* Helper for make_cleanup_free_char_ptr_vec. */
3607 do_free_char_ptr_vec (void *arg
)
3609 VEC (char_ptr
) *char_ptr_vec
= arg
;
3611 free_char_ptr_vec (char_ptr_vec
);
3614 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3615 final VEC_free for CHAR_PTR_VEC itself.
3617 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3618 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3619 this function does not (cannot) clear the pointer. */
3622 make_cleanup_free_char_ptr_vec (VEC (char_ptr
) *char_ptr_vec
)
3624 return make_cleanup (do_free_char_ptr_vec
, char_ptr_vec
);
3627 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3628 must come from xrealloc-compatible allocator and it may be updated. FROM
3629 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3630 located at the start or end of *STRINGP. */
3633 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3635 char *string
= *stringp
, *s
;
3636 const size_t from_len
= strlen (from
);
3637 const size_t to_len
= strlen (to
);
3641 s
= strstr (s
, from
);
3645 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3646 || s
[-1] == DIRNAME_SEPARATOR
)
3647 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3648 || s
[from_len
] == DIRNAME_SEPARATOR
))
3652 string_new
= xrealloc (string
, (strlen (string
) + to_len
+ 1));
3654 /* Relocate the current S pointer. */
3655 s
= s
- string
+ string_new
;
3656 string
= string_new
;
3658 /* Replace from by to. */
3659 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3660 memcpy (s
, to
, to_len
);
3675 /* SIGALRM handler for waitpid_with_timeout. */
3678 sigalrm_handler (int signo
)
3680 /* Nothing to do. */
3685 /* Wrapper to wait for child PID to die with TIMEOUT.
3686 TIMEOUT is the time to stop waiting in seconds.
3687 If TIMEOUT is zero, pass WNOHANG to waitpid.
3688 Returns PID if it was successfully waited for, otherwise -1.
3690 Timeouts are currently implemented with alarm and SIGALRM.
3691 If the host does not support them, this waits "forever".
3692 It would be odd though for a host to have waitpid and not SIGALRM. */
3695 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3697 pid_t waitpid_result
;
3699 gdb_assert (pid
> 0);
3700 gdb_assert (timeout
>= 0);
3705 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3706 struct sigaction sa
, old_sa
;
3708 sa
.sa_handler
= sigalrm_handler
;
3709 sigemptyset (&sa
.sa_mask
);
3711 sigaction (SIGALRM
, &sa
, &old_sa
);
3715 ofunc
= (void (*)()) signal (SIGALRM
, sigalrm_handler
);
3721 waitpid_result
= waitpid (pid
, status
, 0);
3725 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3726 sigaction (SIGALRM
, &old_sa
, NULL
);
3728 signal (SIGALRM
, ofunc
);
3733 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3735 if (waitpid_result
== pid
)
3741 #endif /* HAVE_WAITPID */
3743 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3744 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3746 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3747 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3750 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3752 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3754 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3755 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3757 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3759 char *pattern_slash
, *string_slash
;
3761 /* Replace '\' by '/' in both strings. */
3763 pattern_slash
= alloca (strlen (pattern
) + 1);
3764 strcpy (pattern_slash
, pattern
);
3765 pattern
= pattern_slash
;
3766 for (; *pattern_slash
!= 0; pattern_slash
++)
3767 if (IS_DIR_SEPARATOR (*pattern_slash
))
3768 *pattern_slash
= '/';
3770 string_slash
= alloca (strlen (string
) + 1);
3771 strcpy (string_slash
, string
);
3772 string
= string_slash
;
3773 for (; *string_slash
!= 0; string_slash
++)
3774 if (IS_DIR_SEPARATOR (*string_slash
))
3775 *string_slash
= '/';
3777 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3779 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3780 flags
|= FNM_CASEFOLD
;
3781 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3783 return fnmatch (pattern
, string
, flags
);
3786 /* Provide a prototype to silence -Wmissing-prototypes. */
3787 extern initialize_file_ftype _initialize_utils
;
3790 _initialize_utils (void)
3792 add_internal_problem_command (&internal_error_problem
);
3793 add_internal_problem_command (&internal_warning_problem
);