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
)
550 /* Print a warning message. The first argument STRING is the warning
551 message, used as an fprintf format string, the second is the
552 va_list of arguments for that string. A warning is unfiltered (not
553 paginated) so that the user does not need to page through each
554 screen full of warnings when there are lots of them. */
557 vwarning (const char *string
, va_list args
)
559 if (deprecated_warning_hook
)
560 (*deprecated_warning_hook
) (string
, args
);
563 target_terminal_ours ();
564 wrap_here (""); /* Force out any buffered output. */
565 gdb_flush (gdb_stdout
);
566 if (warning_pre_print
)
567 fputs_unfiltered (warning_pre_print
, gdb_stderr
);
568 vfprintf_unfiltered (gdb_stderr
, string
, args
);
569 fprintf_unfiltered (gdb_stderr
, "\n");
574 /* Print a warning message.
575 The first argument STRING is the warning message, used as a fprintf string,
576 and the remaining args are passed as arguments to it.
577 The primary difference between warnings and errors is that a warning
578 does not force the return to command level. */
581 warning (const char *string
, ...)
585 va_start (args
, string
);
586 vwarning (string
, args
);
590 /* Print an error message and return to command level.
591 The first argument STRING is the error message, used as a fprintf string,
592 and the remaining args are passed as arguments to it. */
595 verror (const char *string
, va_list args
)
597 throw_verror (GENERIC_ERROR
, string
, args
);
601 error (const char *string
, ...)
605 va_start (args
, string
);
606 throw_verror (GENERIC_ERROR
, string
, args
);
610 /* Print an error message and quit.
611 The first argument STRING is the error message, used as a fprintf string,
612 and the remaining args are passed as arguments to it. */
615 vfatal (const char *string
, va_list args
)
617 throw_vfatal (string
, args
);
621 fatal (const char *string
, ...)
625 va_start (args
, string
);
626 throw_vfatal (string
, args
);
631 error_stream (struct ui_file
*stream
)
633 char *message
= ui_file_xstrdup (stream
, NULL
);
635 make_cleanup (xfree
, message
);
636 error (("%s"), message
);
639 /* Dump core trying to increase the core soft limit to hard limit first. */
644 #ifdef HAVE_SETRLIMIT
645 struct rlimit rlim
= { RLIM_INFINITY
, RLIM_INFINITY
};
647 setrlimit (RLIMIT_CORE
, &rlim
);
648 #endif /* HAVE_SETRLIMIT */
650 abort (); /* NOTE: GDB has only three calls to abort(). */
653 /* Check whether GDB will be able to dump core using the dump_core
657 can_dump_core (const char *reason
)
659 #ifdef HAVE_GETRLIMIT
662 /* Be quiet and assume we can dump if an error is returned. */
663 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
666 if (rlim
.rlim_max
== 0)
668 fprintf_unfiltered (gdb_stderr
,
669 _("%s\nUnable to dump core, use `ulimit -c"
670 " unlimited' before executing GDB next time.\n"),
674 #endif /* HAVE_GETRLIMIT */
679 /* Allow the user to configure the debugger behavior with respect to
680 what to do when an internal problem is detected. */
682 const char internal_problem_ask
[] = "ask";
683 const char internal_problem_yes
[] = "yes";
684 const char internal_problem_no
[] = "no";
685 static const char *const internal_problem_modes
[] =
687 internal_problem_ask
,
688 internal_problem_yes
,
693 /* Print a message reporting an internal error/warning. Ask the user
694 if they want to continue, dump core, or just exit. Return
695 something to indicate a quit. */
697 struct internal_problem
700 const char *should_quit
;
701 const char *should_dump_core
;
704 /* Report a problem, internal to GDB, to the user. Once the problem
705 has been reported, and assuming GDB didn't quit, the caller can
706 either allow execution to resume or throw an error. */
708 static void ATTRIBUTE_PRINTF (4, 0)
709 internal_vproblem (struct internal_problem
*problem
,
710 const char *file
, int line
, const char *fmt
, va_list ap
)
717 /* Don't allow infinite error/warning recursion. */
719 static char msg
[] = "Recursive internal problem.\n";
728 fputs_unfiltered (msg
, gdb_stderr
);
729 abort (); /* NOTE: GDB has only three calls to abort(). */
732 /* Newer GLIBC versions put the warn_unused_result attribute
733 on write, but this is one of those rare cases where
734 ignoring the return value is correct. Casting to (void)
735 does not fix this problem. This is the solution suggested
736 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
737 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
738 abort (); /* NOTE: GDB has only three calls to abort(). */
743 /* Try to get the message out and at the start of a new line. */
744 target_terminal_ours ();
747 /* Create a string containing the full error/warning message. Need
748 to call query with this full string, as otherwize the reason
749 (error/warning) and question become separated. Format using a
750 style similar to a compiler error message. Include extra detail
751 so that the user knows that they are living on the edge. */
755 msg
= xstrvprintf (fmt
, ap
);
756 reason
= xstrprintf ("%s:%d: %s: %s\n"
757 "A problem internal to GDB has been detected,\n"
758 "further debugging may prove unreliable.",
759 file
, line
, problem
->name
, msg
);
761 make_cleanup (xfree
, reason
);
764 if (problem
->should_quit
== internal_problem_ask
)
766 /* Default (yes/batch case) is to quit GDB. When in batch mode
767 this lessens the likelihood of GDB going into an infinite
771 /* Emit the message and quit. */
772 fputs_unfiltered (reason
, gdb_stderr
);
773 fputs_unfiltered ("\n", gdb_stderr
);
777 quit_p
= query (_("%s\nQuit this debugging session? "), reason
);
779 else if (problem
->should_quit
== internal_problem_yes
)
781 else if (problem
->should_quit
== internal_problem_no
)
784 internal_error (__FILE__
, __LINE__
, _("bad switch"));
786 if (problem
->should_dump_core
== internal_problem_ask
)
788 if (!can_dump_core (reason
))
792 /* Default (yes/batch case) is to dump core. This leaves a GDB
793 `dropping' so that it is easier to see that something went
795 dump_core_p
= query (_("%s\nCreate a core file of GDB? "), reason
);
798 else if (problem
->should_dump_core
== internal_problem_yes
)
799 dump_core_p
= can_dump_core (reason
);
800 else if (problem
->should_dump_core
== internal_problem_no
)
803 internal_error (__FILE__
, __LINE__
, _("bad switch"));
816 #ifdef HAVE_WORKING_FORK
826 static struct internal_problem internal_error_problem
= {
827 "internal-error", internal_problem_ask
, internal_problem_ask
831 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
833 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
834 deprecated_throw_reason (RETURN_ERROR
);
838 internal_error (const char *file
, int line
, const char *string
, ...)
842 va_start (ap
, string
);
843 internal_verror (file
, line
, string
, ap
);
847 static struct internal_problem internal_warning_problem
= {
848 "internal-warning", internal_problem_ask
, internal_problem_ask
852 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
854 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
858 internal_warning (const char *file
, int line
, const char *string
, ...)
862 va_start (ap
, string
);
863 internal_vwarning (file
, line
, string
, ap
);
867 /* Dummy functions to keep add_prefix_cmd happy. */
870 set_internal_problem_cmd (char *args
, int from_tty
)
875 show_internal_problem_cmd (char *args
, int from_tty
)
879 /* When GDB reports an internal problem (error or warning) it gives
880 the user the opportunity to quit GDB and/or create a core file of
881 the current debug session. This function registers a few commands
882 that make it possible to specify that GDB should always or never
883 quit or create a core file, without asking. The commands look
886 maint set PROBLEM-NAME quit ask|yes|no
887 maint show PROBLEM-NAME quit
888 maint set PROBLEM-NAME corefile ask|yes|no
889 maint show PROBLEM-NAME corefile
891 Where PROBLEM-NAME is currently "internal-error" or
892 "internal-warning". */
895 add_internal_problem_command (struct internal_problem
*problem
)
897 struct cmd_list_element
**set_cmd_list
;
898 struct cmd_list_element
**show_cmd_list
;
902 set_cmd_list
= xmalloc (sizeof (*set_cmd_list
));
903 show_cmd_list
= xmalloc (sizeof (*set_cmd_list
));
904 *set_cmd_list
= NULL
;
905 *show_cmd_list
= NULL
;
907 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
910 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
913 add_prefix_cmd ((char*) problem
->name
,
914 class_maintenance
, set_internal_problem_cmd
, set_doc
,
916 concat ("maintenance set ", problem
->name
, " ",
918 0/*allow-unknown*/, &maintenance_set_cmdlist
);
920 add_prefix_cmd ((char*) problem
->name
,
921 class_maintenance
, show_internal_problem_cmd
, show_doc
,
923 concat ("maintenance show ", problem
->name
, " ",
925 0/*allow-unknown*/, &maintenance_show_cmdlist
);
927 set_doc
= xstrprintf (_("Set whether GDB should quit "
928 "when an %s is detected"),
930 show_doc
= xstrprintf (_("Show whether GDB will quit "
931 "when an %s is detected"),
933 add_setshow_enum_cmd ("quit", class_maintenance
,
934 internal_problem_modes
,
935 &problem
->should_quit
,
947 set_doc
= xstrprintf (_("Set whether GDB should create a core "
948 "file of GDB when %s is detected"),
950 show_doc
= xstrprintf (_("Show whether GDB will create a core "
951 "file of GDB when %s is detected"),
953 add_setshow_enum_cmd ("corefile", class_maintenance
,
954 internal_problem_modes
,
955 &problem
->should_dump_core
,
968 /* Print the system error message for errno, and also mention STRING
969 as the file name for which the error was encountered. Use ERRCODE
970 for the thrown exception. Then return to command level. */
973 throw_perror_with_name (enum errors errcode
, const char *string
)
978 err
= safe_strerror (errno
);
979 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
980 strcpy (combined
, string
);
981 strcat (combined
, ": ");
982 strcat (combined
, err
);
984 /* I understand setting these is a matter of taste. Still, some people
985 may clear errno but not know about bfd_error. Doing this here is not
987 bfd_set_error (bfd_error_no_error
);
990 throw_error (errcode
, _("%s."), combined
);
993 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
996 perror_with_name (const char *string
)
998 throw_perror_with_name (GENERIC_ERROR
, string
);
1001 /* Print the system error message for ERRCODE, and also mention STRING
1002 as the file name for which the error was encountered. */
1005 print_sys_errmsg (const char *string
, int errcode
)
1010 err
= safe_strerror (errcode
);
1011 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
1012 strcpy (combined
, string
);
1013 strcat (combined
, ": ");
1014 strcat (combined
, err
);
1016 /* We want anything which was printed on stdout to come out first, before
1018 gdb_flush (gdb_stdout
);
1019 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
1022 /* Control C eventually causes this to be called, at a convenient time. */
1028 /* No steenking SIGINT will ever be coming our way when the
1029 program is resumed. Don't lie. */
1033 /* If there is no terminal switching for this target, then we can't
1034 possibly get screwed by the lack of job control. */
1035 || current_target
.to_terminal_ours
== NULL
)
1038 fatal ("Quit (expect signal SIGINT when the program is resumed)");
1043 /* Called when a memory allocation fails, with the number of bytes of
1044 memory requested in SIZE. */
1047 malloc_failure (long size
)
1051 internal_error (__FILE__
, __LINE__
,
1052 _("virtual memory exhausted: can't allocate %ld bytes."),
1057 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
1061 /* My replacement for the read system call.
1062 Used like `read' but keeps going if `read' returns too soon. */
1065 myread (int desc
, char *addr
, int len
)
1072 val
= read (desc
, addr
, len
);
1076 return orglen
- len
;
1084 print_spaces (int n
, struct ui_file
*file
)
1086 fputs_unfiltered (n_spaces (n
), file
);
1089 /* Print a host address. */
1092 gdb_print_host_address (const void *addr
, struct ui_file
*stream
)
1094 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
1098 /* A cleanup function that calls regfree. */
1101 do_regfree_cleanup (void *r
)
1106 /* Create a new cleanup that frees the compiled regular expression R. */
1109 make_regfree_cleanup (regex_t
*r
)
1111 return make_cleanup (do_regfree_cleanup
, r
);
1114 /* Return an xmalloc'd error message resulting from a regular
1115 expression compilation failure. */
1118 get_regcomp_error (int code
, regex_t
*rx
)
1120 size_t length
= regerror (code
, rx
, NULL
, 0);
1121 char *result
= xmalloc (length
);
1123 regerror (code
, rx
, result
, length
);
1129 /* This function supports the query, nquery, and yquery functions.
1130 Ask user a y-or-n question and return 0 if answer is no, 1 if
1131 answer is yes, or default the answer to the specified default
1132 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1133 default answer, or '\0' for no default.
1134 CTLSTR is the control string and should end in "? ". It should
1135 not say how to answer, because we do that.
1136 ARGS are the arguments passed along with the CTLSTR argument to
1139 static int ATTRIBUTE_PRINTF (1, 0)
1140 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
1146 char def_answer
, not_def_answer
;
1147 char *y_string
, *n_string
, *question
;
1148 /* Used to add duration we waited for user to respond to
1149 prompt_for_continue_wait_time. */
1150 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1152 /* Set up according to which answer is the default. */
1153 if (defchar
== '\0')
1157 not_def_answer
= 'N';
1161 else if (defchar
== 'y')
1165 not_def_answer
= 'N';
1173 not_def_answer
= 'Y';
1178 /* Automatically answer the default value if the user did not want
1179 prompts or the command was issued with the server prefix. */
1180 if (!confirm
|| server_command
)
1183 /* If input isn't coming from the user directly, just say what
1184 question we're asking, and then answer the default automatically. This
1185 way, important error messages don't get lost when talking to GDB
1187 if (! input_from_terminal_p ())
1190 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
1192 printf_filtered (_("(%s or %s) [answered %c; "
1193 "input not from terminal]\n"),
1194 y_string
, n_string
, def_answer
);
1195 gdb_flush (gdb_stdout
);
1200 if (deprecated_query_hook
)
1202 return deprecated_query_hook (ctlstr
, args
);
1205 /* Format the question outside of the loop, to avoid reusing args. */
1206 question
= xstrvprintf (ctlstr
, args
);
1208 /* Used for calculating time spend waiting for user. */
1209 gettimeofday (&prompt_started
, NULL
);
1213 wrap_here (""); /* Flush any buffered output. */
1214 gdb_flush (gdb_stdout
);
1216 if (annotation_level
> 1)
1217 printf_filtered (("\n\032\032pre-query\n"));
1219 fputs_filtered (question
, gdb_stdout
);
1220 printf_filtered (_("(%s or %s) "), y_string
, n_string
);
1222 if (annotation_level
> 1)
1223 printf_filtered (("\n\032\032query\n"));
1226 gdb_flush (gdb_stdout
);
1228 answer
= fgetc (stdin
);
1230 /* We expect fgetc to block until a character is read. But
1231 this may not be the case if the terminal was opened with
1232 the NONBLOCK flag. In that case, if there is nothing to
1233 read on stdin, fgetc returns EOF, but also sets the error
1234 condition flag on stdin and errno to EAGAIN. With a true
1235 EOF, stdin's error condition flag is not set.
1237 A situation where this behavior was observed is a pseudo
1239 while (answer
== EOF
&& ferror (stdin
) && errno
== EAGAIN
)
1241 /* Not a real EOF. Wait a little while and try again until
1242 we read something. */
1245 answer
= fgetc (stdin
);
1248 clearerr (stdin
); /* in case of C-d */
1249 if (answer
== EOF
) /* C-d */
1251 printf_filtered ("EOF [assumed %c]\n", def_answer
);
1255 /* Eat rest of input line, to EOF or newline. */
1259 ans2
= fgetc (stdin
);
1262 while (ans2
!= EOF
&& ans2
!= '\n' && ans2
!= '\r');
1266 /* Check answer. For the non-default, the user must specify
1267 the non-default explicitly. */
1268 if (answer
== not_def_answer
)
1270 retval
= !def_value
;
1273 /* Otherwise, if a default was specified, the user may either
1274 specify the required input or have it default by entering
1276 if (answer
== def_answer
1277 || (defchar
!= '\0' &&
1278 (answer
== '\n' || answer
== '\r' || answer
== EOF
)))
1283 /* Invalid entries are not defaulted and require another selection. */
1284 printf_filtered (_("Please answer %s or %s.\n"),
1285 y_string
, n_string
);
1288 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1289 gettimeofday (&prompt_ended
, NULL
);
1290 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1291 timeval_add (&prompt_for_continue_wait_time
,
1292 &prompt_for_continue_wait_time
, &prompt_delta
);
1295 if (annotation_level
> 1)
1296 printf_filtered (("\n\032\032post-query\n"));
1301 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1302 answer is yes, or 0 if answer is defaulted.
1303 Takes three args which are given to printf to print the question.
1304 The first, a control string, should end in "? ".
1305 It should not say how to answer, because we do that. */
1308 nquery (const char *ctlstr
, ...)
1313 va_start (args
, ctlstr
);
1314 ret
= defaulted_query (ctlstr
, 'n', args
);
1319 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1320 answer is yes, or 1 if answer is defaulted.
1321 Takes three args which are given to printf to print the question.
1322 The first, a control string, should end in "? ".
1323 It should not say how to answer, because we do that. */
1326 yquery (const char *ctlstr
, ...)
1331 va_start (args
, ctlstr
);
1332 ret
= defaulted_query (ctlstr
, 'y', args
);
1337 /* Ask user a y-or-n question and return 1 iff answer is yes.
1338 Takes three args which are given to printf to print the question.
1339 The first, a control string, should end in "? ".
1340 It should not say how to answer, because we do that. */
1343 query (const char *ctlstr
, ...)
1348 va_start (args
, ctlstr
);
1349 ret
= defaulted_query (ctlstr
, '\0', args
);
1354 /* A helper for parse_escape that converts a host character to a
1355 target character. C is the host character. If conversion is
1356 possible, then the target character is stored in *TARGET_C and the
1357 function returns 1. Otherwise, the function returns 0. */
1360 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1362 struct obstack host_data
;
1364 struct cleanup
*cleanups
;
1367 obstack_init (&host_data
);
1368 cleanups
= make_cleanup_obstack_free (&host_data
);
1370 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1371 (gdb_byte
*) &the_char
, 1, 1,
1372 &host_data
, translit_none
);
1374 if (obstack_object_size (&host_data
) == 1)
1377 *target_c
= *(char *) obstack_base (&host_data
);
1380 do_cleanups (cleanups
);
1384 /* Parse a C escape sequence. STRING_PTR points to a variable
1385 containing a pointer to the string to parse. That pointer
1386 should point to the character after the \. That pointer
1387 is updated past the characters we use. The value of the
1388 escape sequence is returned.
1390 A negative value means the sequence \ newline was seen,
1391 which is supposed to be equivalent to nothing at all.
1393 If \ is followed by a null character, we return a negative
1394 value and leave the string pointer pointing at the null character.
1396 If \ is followed by 000, we return 0 and leave the string pointer
1397 after the zeros. A value of 0 does not mean end of string. */
1400 parse_escape (struct gdbarch
*gdbarch
, char **string_ptr
)
1402 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1403 int c
= *(*string_ptr
)++;
1422 int i
= host_hex_value (c
);
1427 if (isdigit (c
) && c
!= '8' && c
!= '9')
1431 i
+= host_hex_value (c
);
1467 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1468 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1469 " which has no equivalent\nin the `%s' character set."),
1470 c
, c
, target_charset (gdbarch
));
1474 /* Print the character C on STREAM as part of the contents of a literal
1475 string whose delimiter is QUOTER. Note that this routine should only
1476 be call for printing things which are independent of the language
1477 of the program being debugged. */
1480 printchar (int c
, void (*do_fputs
) (const char *, struct ui_file
*),
1481 void (*do_fprintf
) (struct ui_file
*, const char *, ...)
1482 ATTRIBUTE_FPTR_PRINTF_2
, struct ui_file
*stream
, int quoter
)
1484 c
&= 0xFF; /* Avoid sign bit follies */
1486 if (c
< 0x20 || /* Low control chars */
1487 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1488 (sevenbit_strings
&& c
>= 0x80))
1489 { /* high order bit set */
1493 do_fputs ("\\n", stream
);
1496 do_fputs ("\\b", stream
);
1499 do_fputs ("\\t", stream
);
1502 do_fputs ("\\f", stream
);
1505 do_fputs ("\\r", stream
);
1508 do_fputs ("\\e", stream
);
1511 do_fputs ("\\a", stream
);
1514 do_fprintf (stream
, "\\%.3o", (unsigned int) c
);
1520 if (c
== '\\' || c
== quoter
)
1521 do_fputs ("\\", stream
);
1522 do_fprintf (stream
, "%c", c
);
1526 /* Print the character C on STREAM as part of the contents of a
1527 literal string whose delimiter is QUOTER. Note that these routines
1528 should only be call for printing things which are independent of
1529 the language of the program being debugged. */
1532 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1535 printchar (*str
++, fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1539 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1542 printchar (*str
++, fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1546 fputstrn_filtered (const char *str
, int n
, int quoter
,
1547 struct ui_file
*stream
)
1551 for (i
= 0; i
< n
; i
++)
1552 printchar (str
[i
], fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1556 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1557 struct ui_file
*stream
)
1561 for (i
= 0; i
< n
; i
++)
1562 printchar (str
[i
], fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1566 /* Number of lines per page or UINT_MAX if paging is disabled. */
1567 static unsigned int lines_per_page
;
1569 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1570 struct cmd_list_element
*c
, const char *value
)
1572 fprintf_filtered (file
,
1573 _("Number of lines gdb thinks are in a page is %s.\n"),
1577 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1578 static unsigned int chars_per_line
;
1580 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1581 struct cmd_list_element
*c
, const char *value
)
1583 fprintf_filtered (file
,
1584 _("Number of characters gdb thinks "
1585 "are in a line is %s.\n"),
1589 /* Current count of lines printed on this page, chars on this line. */
1590 static unsigned int lines_printed
, chars_printed
;
1592 /* Buffer and start column of buffered text, for doing smarter word-
1593 wrapping. When someone calls wrap_here(), we start buffering output
1594 that comes through fputs_filtered(). If we see a newline, we just
1595 spit it out and forget about the wrap_here(). If we see another
1596 wrap_here(), we spit it out and remember the newer one. If we see
1597 the end of the line, we spit out a newline, the indent, and then
1598 the buffered output. */
1600 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1601 are waiting to be output (they have already been counted in chars_printed).
1602 When wrap_buffer[0] is null, the buffer is empty. */
1603 static char *wrap_buffer
;
1605 /* Pointer in wrap_buffer to the next character to fill. */
1606 static char *wrap_pointer
;
1608 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1610 static char *wrap_indent
;
1612 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1613 is not in effect. */
1614 static int wrap_column
;
1617 /* Inialize the number of lines per page and chars per line. */
1620 init_page_info (void)
1624 lines_per_page
= UINT_MAX
;
1625 chars_per_line
= UINT_MAX
;
1629 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1634 #if defined(__GO32__)
1635 rows
= ScreenRows ();
1636 cols
= ScreenCols ();
1637 lines_per_page
= rows
;
1638 chars_per_line
= cols
;
1640 /* Make sure Readline has initialized its terminal settings. */
1641 rl_reset_terminal (NULL
);
1643 /* Get the screen size from Readline. */
1644 rl_get_screen_size (&rows
, &cols
);
1645 lines_per_page
= rows
;
1646 chars_per_line
= cols
;
1648 /* Readline should have fetched the termcap entry for us. */
1649 if (tgetnum ("li") < 0 || getenv ("EMACS"))
1651 /* The number of lines per page is not mentioned in the
1652 terminal description. This probably means that paging is
1653 not useful (e.g. emacs shell window), so disable paging. */
1654 lines_per_page
= UINT_MAX
;
1657 /* If the output is not a terminal, don't paginate it. */
1658 if (!ui_file_isatty (gdb_stdout
))
1659 lines_per_page
= UINT_MAX
;
1667 /* Helper for make_cleanup_restore_page_info. */
1670 do_restore_page_info_cleanup (void *arg
)
1676 /* Provide cleanup for restoring the terminal size. */
1679 make_cleanup_restore_page_info (void)
1681 struct cleanup
*back_to
;
1683 back_to
= make_cleanup (do_restore_page_info_cleanup
, NULL
);
1684 make_cleanup_restore_uinteger (&lines_per_page
);
1685 make_cleanup_restore_uinteger (&chars_per_line
);
1690 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1691 Provide cleanup for restoring the original state. */
1694 set_batch_flag_and_make_cleanup_restore_page_info (void)
1696 struct cleanup
*back_to
= make_cleanup_restore_page_info ();
1698 make_cleanup_restore_integer (&batch_flag
);
1705 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1708 set_screen_size (void)
1710 int rows
= lines_per_page
;
1711 int cols
= chars_per_line
;
1719 /* Update Readline's idea of the terminal size. */
1720 rl_set_screen_size (rows
, cols
);
1723 /* Reinitialize WRAP_BUFFER according to the current value of
1729 if (chars_per_line
== 0)
1734 wrap_buffer
= (char *) xmalloc (chars_per_line
+ 2);
1735 wrap_buffer
[0] = '\0';
1738 wrap_buffer
= (char *) xrealloc (wrap_buffer
, chars_per_line
+ 2);
1739 wrap_pointer
= wrap_buffer
; /* Start it at the beginning. */
1743 set_width_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1750 set_height_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1755 /* Wait, so the user can read what's on the screen. Prompt the user
1756 to continue by pressing RETURN. */
1759 prompt_for_continue (void)
1762 char cont_prompt
[120];
1763 /* Used to add duration we waited for user to respond to
1764 prompt_for_continue_wait_time. */
1765 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1767 gettimeofday (&prompt_started
, NULL
);
1769 if (annotation_level
> 1)
1770 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1772 strcpy (cont_prompt
,
1773 "---Type <return> to continue, or q <return> to quit---");
1774 if (annotation_level
> 1)
1775 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1777 /* We must do this *before* we call gdb_readline, else it will eventually
1778 call us -- thinking that we're trying to print beyond the end of the
1780 reinitialize_more_filter ();
1784 /* On a real operating system, the user can quit with SIGINT.
1787 'q' is provided on all systems so users don't have to change habits
1788 from system to system, and because telling them what to do in
1789 the prompt is more user-friendly than expecting them to think of
1791 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1792 whereas control-C to gdb_readline will cause the user to get dumped
1794 ignore
= gdb_readline_wrapper (cont_prompt
);
1796 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1797 gettimeofday (&prompt_ended
, NULL
);
1798 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1799 timeval_add (&prompt_for_continue_wait_time
,
1800 &prompt_for_continue_wait_time
, &prompt_delta
);
1802 if (annotation_level
> 1)
1803 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1809 while (*p
== ' ' || *p
== '\t')
1817 /* Now we have to do this again, so that GDB will know that it doesn't
1818 need to save the ---Type <return>--- line at the top of the screen. */
1819 reinitialize_more_filter ();
1821 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1824 /* Initalize timer to keep track of how long we waited for the user. */
1827 reset_prompt_for_continue_wait_time (void)
1829 static const struct timeval zero_timeval
= { 0 };
1831 prompt_for_continue_wait_time
= zero_timeval
;
1834 /* Fetch the cumulative time spent in prompt_for_continue. */
1837 get_prompt_for_continue_wait_time (void)
1839 return prompt_for_continue_wait_time
;
1842 /* Reinitialize filter; ie. tell it to reset to original values. */
1845 reinitialize_more_filter (void)
1851 /* Indicate that if the next sequence of characters overflows the line,
1852 a newline should be inserted here rather than when it hits the end.
1853 If INDENT is non-null, it is a string to be printed to indent the
1854 wrapped part on the next line. INDENT must remain accessible until
1855 the next call to wrap_here() or until a newline is printed through
1858 If the line is already overfull, we immediately print a newline and
1859 the indentation, and disable further wrapping.
1861 If we don't know the width of lines, but we know the page height,
1862 we must not wrap words, but should still keep track of newlines
1863 that were explicitly printed.
1865 INDENT should not contain tabs, as that will mess up the char count
1866 on the next line. FIXME.
1868 This routine is guaranteed to force out any output which has been
1869 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1870 used to force out output from the wrap_buffer. */
1873 wrap_here (char *indent
)
1875 /* This should have been allocated, but be paranoid anyway. */
1877 internal_error (__FILE__
, __LINE__
,
1878 _("failed internal consistency check"));
1882 *wrap_pointer
= '\0';
1883 fputs_unfiltered (wrap_buffer
, gdb_stdout
);
1885 wrap_pointer
= wrap_buffer
;
1886 wrap_buffer
[0] = '\0';
1887 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1891 else if (chars_printed
>= chars_per_line
)
1893 puts_filtered ("\n");
1895 puts_filtered (indent
);
1900 wrap_column
= chars_printed
;
1904 wrap_indent
= indent
;
1908 /* Print input string to gdb_stdout, filtered, with wrap,
1909 arranging strings in columns of n chars. String can be
1910 right or left justified in the column. Never prints
1911 trailing spaces. String should never be longer than
1912 width. FIXME: this could be useful for the EXAMINE
1913 command, which currently doesn't tabulate very well. */
1916 puts_filtered_tabular (char *string
, int width
, int right
)
1922 gdb_assert (chars_per_line
> 0);
1923 if (chars_per_line
== UINT_MAX
)
1925 fputs_filtered (string
, gdb_stdout
);
1926 fputs_filtered ("\n", gdb_stdout
);
1930 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1931 fputs_filtered ("\n", gdb_stdout
);
1933 if (width
>= chars_per_line
)
1934 width
= chars_per_line
- 1;
1936 stringlen
= strlen (string
);
1938 if (chars_printed
> 0)
1939 spaces
= width
- (chars_printed
- 1) % width
- 1;
1941 spaces
+= width
- stringlen
;
1943 spacebuf
= alloca (spaces
+ 1);
1944 spacebuf
[spaces
] = '\0';
1946 spacebuf
[spaces
] = ' ';
1948 fputs_filtered (spacebuf
, gdb_stdout
);
1949 fputs_filtered (string
, gdb_stdout
);
1953 /* Ensure that whatever gets printed next, using the filtered output
1954 commands, starts at the beginning of the line. I.e. if there is
1955 any pending output for the current line, flush it and start a new
1956 line. Otherwise do nothing. */
1961 if (chars_printed
> 0)
1963 puts_filtered ("\n");
1968 /* Like fputs but if FILTER is true, pause after every screenful.
1970 Regardless of FILTER can wrap at points other than the final
1971 character of a line.
1973 Unlike fputs, fputs_maybe_filtered does not return a value.
1974 It is OK for LINEBUFFER to be NULL, in which case just don't print
1977 Note that a longjmp to top level may occur in this routine (only if
1978 FILTER is true) (since prompt_for_continue may do so) so this
1979 routine should not be called when cleanups are not in place. */
1982 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1985 const char *lineptr
;
1987 if (linebuffer
== 0)
1990 /* Don't do any filtering if it is disabled. */
1991 if (stream
!= gdb_stdout
1992 || !pagination_enabled
1994 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
1995 || top_level_interpreter () == NULL
1996 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
1998 fputs_unfiltered (linebuffer
, stream
);
2002 /* Go through and output each character. Show line extension
2003 when this is necessary; prompt user for new page when this is
2006 lineptr
= linebuffer
;
2009 /* Possible new page. */
2010 if (filter
&& (lines_printed
>= lines_per_page
- 1))
2011 prompt_for_continue ();
2013 while (*lineptr
&& *lineptr
!= '\n')
2015 /* Print a single line. */
2016 if (*lineptr
== '\t')
2019 *wrap_pointer
++ = '\t';
2021 fputc_unfiltered ('\t', stream
);
2022 /* Shifting right by 3 produces the number of tab stops
2023 we have already passed, and then adding one and
2024 shifting left 3 advances to the next tab stop. */
2025 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
2031 *wrap_pointer
++ = *lineptr
;
2033 fputc_unfiltered (*lineptr
, stream
);
2038 if (chars_printed
>= chars_per_line
)
2040 unsigned int save_chars
= chars_printed
;
2044 /* If we aren't actually wrapping, don't output newline --
2045 if chars_per_line is right, we probably just overflowed
2046 anyway; if it's wrong, let us keep going. */
2048 fputc_unfiltered ('\n', stream
);
2050 /* Possible new page. */
2051 if (lines_printed
>= lines_per_page
- 1)
2052 prompt_for_continue ();
2054 /* Now output indentation and wrapped string. */
2057 fputs_unfiltered (wrap_indent
, stream
);
2058 *wrap_pointer
= '\0'; /* Null-terminate saved stuff, */
2059 fputs_unfiltered (wrap_buffer
, stream
); /* and eject it. */
2060 /* FIXME, this strlen is what prevents wrap_indent from
2061 containing tabs. However, if we recurse to print it
2062 and count its chars, we risk trouble if wrap_indent is
2063 longer than (the user settable) chars_per_line.
2064 Note also that this can set chars_printed > chars_per_line
2065 if we are printing a long string. */
2066 chars_printed
= strlen (wrap_indent
)
2067 + (save_chars
- wrap_column
);
2068 wrap_pointer
= wrap_buffer
; /* Reset buffer */
2069 wrap_buffer
[0] = '\0';
2070 wrap_column
= 0; /* And disable fancy wrap */
2075 if (*lineptr
== '\n')
2078 wrap_here ((char *) 0); /* Spit out chars, cancel
2081 fputc_unfiltered ('\n', stream
);
2088 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
2090 fputs_maybe_filtered (linebuffer
, stream
, 1);
2094 putchar_unfiltered (int c
)
2098 ui_file_write (gdb_stdout
, &buf
, 1);
2102 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2103 May return nonlocally. */
2106 putchar_filtered (int c
)
2108 return fputc_filtered (c
, gdb_stdout
);
2112 fputc_unfiltered (int c
, struct ui_file
*stream
)
2116 ui_file_write (stream
, &buf
, 1);
2121 fputc_filtered (int c
, struct ui_file
*stream
)
2127 fputs_filtered (buf
, stream
);
2131 /* puts_debug is like fputs_unfiltered, except it prints special
2132 characters in printable fashion. */
2135 puts_debug (char *prefix
, char *string
, char *suffix
)
2139 /* Print prefix and suffix after each line. */
2140 static int new_line
= 1;
2141 static int return_p
= 0;
2142 static char *prev_prefix
= "";
2143 static char *prev_suffix
= "";
2145 if (*string
== '\n')
2148 /* If the prefix is changing, print the previous suffix, a new line,
2149 and the new prefix. */
2150 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
2152 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
2153 fputs_unfiltered ("\n", gdb_stdlog
);
2154 fputs_unfiltered (prefix
, gdb_stdlog
);
2157 /* Print prefix if we printed a newline during the previous call. */
2161 fputs_unfiltered (prefix
, gdb_stdlog
);
2164 prev_prefix
= prefix
;
2165 prev_suffix
= suffix
;
2167 /* Output characters in a printable format. */
2168 while ((ch
= *string
++) != '\0')
2174 fputc_unfiltered (ch
, gdb_stdlog
);
2177 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2181 fputs_unfiltered ("\\\\", gdb_stdlog
);
2184 fputs_unfiltered ("\\b", gdb_stdlog
);
2187 fputs_unfiltered ("\\f", gdb_stdlog
);
2191 fputs_unfiltered ("\\n", gdb_stdlog
);
2194 fputs_unfiltered ("\\r", gdb_stdlog
);
2197 fputs_unfiltered ("\\t", gdb_stdlog
);
2200 fputs_unfiltered ("\\v", gdb_stdlog
);
2204 return_p
= ch
== '\r';
2207 /* Print suffix if we printed a newline. */
2210 fputs_unfiltered (suffix
, gdb_stdlog
);
2211 fputs_unfiltered ("\n", gdb_stdlog
);
2216 /* Print a variable number of ARGS using format FORMAT. If this
2217 information is going to put the amount written (since the last call
2218 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2219 call prompt_for_continue to get the users permision to continue.
2221 Unlike fprintf, this function does not return a value.
2223 We implement three variants, vfprintf (takes a vararg list and stream),
2224 fprintf (takes a stream to write on), and printf (the usual).
2226 Note also that a longjmp to top level may occur in this routine
2227 (since prompt_for_continue may do so) so this routine should not be
2228 called when cleanups are not in place. */
2231 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2232 va_list args
, int filter
)
2235 struct cleanup
*old_cleanups
;
2237 linebuffer
= xstrvprintf (format
, args
);
2238 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2239 fputs_maybe_filtered (linebuffer
, stream
, filter
);
2240 do_cleanups (old_cleanups
);
2245 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2247 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2251 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2254 struct cleanup
*old_cleanups
;
2256 linebuffer
= xstrvprintf (format
, args
);
2257 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2258 if (debug_timestamp
&& stream
== gdb_stdlog
)
2264 gettimeofday (&tm
, NULL
);
2266 len
= strlen (linebuffer
);
2267 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2269 timestamp
= xstrprintf ("%ld:%ld %s%s",
2270 (long) tm
.tv_sec
, (long) tm
.tv_usec
,
2272 need_nl
? "\n": "");
2273 make_cleanup (xfree
, timestamp
);
2274 fputs_unfiltered (timestamp
, stream
);
2277 fputs_unfiltered (linebuffer
, stream
);
2278 do_cleanups (old_cleanups
);
2282 vprintf_filtered (const char *format
, va_list args
)
2284 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2288 vprintf_unfiltered (const char *format
, va_list args
)
2290 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2294 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2298 va_start (args
, format
);
2299 vfprintf_filtered (stream
, format
, args
);
2304 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2308 va_start (args
, format
);
2309 vfprintf_unfiltered (stream
, format
, args
);
2313 /* Like fprintf_filtered, but prints its result indented.
2314 Called as fprintfi_filtered (spaces, stream, format, ...); */
2317 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2322 va_start (args
, format
);
2323 print_spaces_filtered (spaces
, stream
);
2325 vfprintf_filtered (stream
, format
, args
);
2331 printf_filtered (const char *format
, ...)
2335 va_start (args
, format
);
2336 vfprintf_filtered (gdb_stdout
, format
, args
);
2342 printf_unfiltered (const char *format
, ...)
2346 va_start (args
, format
);
2347 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2351 /* Like printf_filtered, but prints it's result indented.
2352 Called as printfi_filtered (spaces, format, ...); */
2355 printfi_filtered (int spaces
, const char *format
, ...)
2359 va_start (args
, format
);
2360 print_spaces_filtered (spaces
, gdb_stdout
);
2361 vfprintf_filtered (gdb_stdout
, format
, args
);
2365 /* Easy -- but watch out!
2367 This routine is *not* a replacement for puts()! puts() appends a newline.
2368 This one doesn't, and had better not! */
2371 puts_filtered (const char *string
)
2373 fputs_filtered (string
, gdb_stdout
);
2377 puts_unfiltered (const char *string
)
2379 fputs_unfiltered (string
, gdb_stdout
);
2382 /* Return a pointer to N spaces and a null. The pointer is good
2383 until the next call to here. */
2388 static char *spaces
= 0;
2389 static int max_spaces
= -1;
2395 spaces
= (char *) xmalloc (n
+ 1);
2396 for (t
= spaces
+ n
; t
!= spaces
;)
2402 return spaces
+ max_spaces
- n
;
2405 /* Print N spaces. */
2407 print_spaces_filtered (int n
, struct ui_file
*stream
)
2409 fputs_filtered (n_spaces (n
), stream
);
2412 /* C++/ObjC demangler stuff. */
2414 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2415 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2416 If the name is not mangled, or the language for the name is unknown, or
2417 demangling is off, the name is printed in its "raw" form. */
2420 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2421 enum language lang
, int arg_mode
)
2427 /* If user wants to see raw output, no problem. */
2430 fputs_filtered (name
, stream
);
2434 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2435 fputs_filtered (demangled
? demangled
: name
, stream
);
2436 if (demangled
!= NULL
)
2444 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2445 differences in whitespace. Returns 0 if they match, non-zero if they
2446 don't (slightly different than strcmp()'s range of return values).
2448 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2449 This "feature" is useful when searching for matching C++ function names
2450 (such as if the user types 'break FOO', where FOO is a mangled C++
2454 strcmp_iw (const char *string1
, const char *string2
)
2456 while ((*string1
!= '\0') && (*string2
!= '\0'))
2458 while (isspace (*string1
))
2462 while (isspace (*string2
))
2466 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2468 if (case_sensitivity
== case_sensitive_off
2469 && (tolower ((unsigned char) *string1
)
2470 != tolower ((unsigned char) *string2
)))
2472 if (*string1
!= '\0')
2478 return (*string1
!= '\0' && *string1
!= '(') || (*string2
!= '\0');
2481 /* This is like strcmp except that it ignores whitespace and treats
2482 '(' as the first non-NULL character in terms of ordering. Like
2483 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2484 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2485 according to that ordering.
2487 If a list is sorted according to this function and if you want to
2488 find names in the list that match some fixed NAME according to
2489 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2490 where this function would put NAME.
2492 This function must be neutral to the CASE_SENSITIVITY setting as the user
2493 may choose it during later lookup. Therefore this function always sorts
2494 primarily case-insensitively and secondarily case-sensitively.
2496 Here are some examples of why using strcmp to sort is a bad idea:
2500 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2501 we try to do a search for "foo<char*>", strcmp will locate this
2502 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2503 will start looking at strings beginning with "goo", and will never
2504 see the correct match of "foo<char *>".
2506 Parenthesis example:
2508 In practice, this is less like to be an issue, but I'll give it a
2509 shot. Let's assume that '$' is a legitimate character to occur in
2510 symbols. (Which may well even be the case on some systems.) Then
2511 say that the partial symbol table contains "foo$" and "foo(int)".
2512 strcmp will put them in this order, since '$' < '('. Now, if the
2513 user searches for "foo", then strcmp will sort "foo" before "foo$".
2514 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2515 "foo") is false, so it won't proceed to the actual match of
2516 "foo(int)" with "foo". */
2519 strcmp_iw_ordered (const char *string1
, const char *string2
)
2521 const char *saved_string1
= string1
, *saved_string2
= string2
;
2522 enum case_sensitivity case_pass
= case_sensitive_off
;
2526 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2527 Provide stub characters if we are already at the end of one of the
2529 char c1
= 'X', c2
= 'X';
2531 while (*string1
!= '\0' && *string2
!= '\0')
2533 while (isspace (*string1
))
2535 while (isspace (*string2
))
2540 case case_sensitive_off
:
2541 c1
= tolower ((unsigned char) *string1
);
2542 c2
= tolower ((unsigned char) *string2
);
2544 case case_sensitive_on
:
2552 if (*string1
!= '\0')
2561 /* Characters are non-equal unless they're both '\0'; we want to
2562 make sure we get the comparison right according to our
2563 comparison in the cases where one of them is '\0' or '('. */
2565 if (*string2
== '\0')
2570 if (*string2
== '\0')
2575 if (*string2
== '\0' || *string2
== '(')
2584 if (case_pass
== case_sensitive_on
)
2587 /* Otherwise the strings were equal in case insensitive way, make
2588 a more fine grained comparison in a case sensitive way. */
2590 case_pass
= case_sensitive_on
;
2591 string1
= saved_string1
;
2592 string2
= saved_string2
;
2596 /* A simple comparison function with opposite semantics to strcmp. */
2599 streq (const char *lhs
, const char *rhs
)
2601 return !strcmp (lhs
, rhs
);
2607 ** Answer whether string_to_compare is a full or partial match to
2608 ** template_string. The partial match must be in sequence starting
2612 subset_compare (char *string_to_compare
, char *template_string
)
2616 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
2617 && strlen (string_to_compare
) <= strlen (template_string
))
2620 (template_string
, string_to_compare
, strlen (string_to_compare
)) == 0);
2627 pagination_on_command (char *arg
, int from_tty
)
2629 pagination_enabled
= 1;
2633 pagination_off_command (char *arg
, int from_tty
)
2635 pagination_enabled
= 0;
2639 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2640 struct cmd_list_element
*c
, const char *value
)
2642 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2648 initialize_utils (void)
2650 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
2651 Set number of characters where GDB should wrap lines of its output."), _("\
2652 Show number of characters where GDB should wrap lines of its output."), _("\
2653 This affects where GDB wraps its output to fit the screen width.\n\
2654 Setting this to zero prevents GDB from wrapping its output."),
2656 show_chars_per_line
,
2657 &setlist
, &showlist
);
2659 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
2660 Set number of lines in a page for GDB output pagination."), _("\
2661 Show number of lines in a page for GDB output pagination."), _("\
2662 This affects the number of lines after which GDB will pause\n\
2663 its output and ask you whether to continue.\n\
2664 Setting this to zero causes GDB never pause during output."),
2666 show_lines_per_page
,
2667 &setlist
, &showlist
);
2671 add_setshow_boolean_cmd ("pagination", class_support
,
2672 &pagination_enabled
, _("\
2673 Set state of GDB output pagination."), _("\
2674 Show state of GDB output pagination."), _("\
2675 When pagination is ON, GDB pauses at end of each screenful of\n\
2676 its output and asks you whether to continue.\n\
2677 Turning pagination off is an alternative to \"set height 0\"."),
2679 show_pagination_enabled
,
2680 &setlist
, &showlist
);
2684 add_com ("am", class_support
, pagination_on_command
,
2685 _("Enable pagination"));
2686 add_com ("sm", class_support
, pagination_off_command
,
2687 _("Disable pagination"));
2690 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
2691 &sevenbit_strings
, _("\
2692 Set printing of 8-bit characters in strings as \\nnn."), _("\
2693 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
2695 show_sevenbit_strings
,
2696 &setprintlist
, &showprintlist
);
2698 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
2699 &debug_timestamp
, _("\
2700 Set timestamping of debugging messages."), _("\
2701 Show timestamping of debugging messages."), _("\
2702 When set, debugging messages will be marked with seconds and microseconds."),
2704 show_debug_timestamp
,
2705 &setdebuglist
, &showdebuglist
);
2708 /* Print routines to handle variable size regs, etc. */
2709 /* Temporary storage using circular buffer. */
2715 static char buf
[NUMCELLS
][CELLSIZE
];
2716 static int cell
= 0;
2718 if (++cell
>= NUMCELLS
)
2724 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2726 /* Truncate address to the size of a target address, avoiding shifts
2727 larger or equal than the width of a CORE_ADDR. The local
2728 variable ADDR_BIT stops the compiler reporting a shift overflow
2729 when it won't occur. */
2730 /* NOTE: This assumes that the significant address information is
2731 kept in the least significant bits of ADDR - the upper bits were
2732 either zero or sign extended. Should gdbarch_address_to_pointer or
2733 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2735 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2737 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2738 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2739 return hex_string (addr
);
2742 /* This function is described in "defs.h". */
2745 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2747 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2749 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2750 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2752 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2753 that returns the language localized string formatted to a width
2754 based on gdbarch_addr_bit. */
2756 return hex_string_custom (address
, 8);
2758 return hex_string_custom (address
, 16);
2761 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2764 core_addr_hash (const void *ap
)
2766 const CORE_ADDR
*addrp
= ap
;
2771 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2774 core_addr_eq (const void *ap
, const void *bp
)
2776 const CORE_ADDR
*addr_ap
= ap
;
2777 const CORE_ADDR
*addr_bp
= bp
;
2779 return *addr_ap
== *addr_bp
;
2783 decimal2str (char *sign
, ULONGEST addr
, int width
)
2785 /* Steal code from valprint.c:print_decimal(). Should this worry
2786 about the real size of addr as the above does? */
2787 unsigned long temp
[3];
2788 char *str
= get_cell ();
2793 temp
[i
] = addr
% (1000 * 1000 * 1000);
2794 addr
/= (1000 * 1000 * 1000);
2798 while (addr
!= 0 && i
< (sizeof (temp
) / sizeof (temp
[0])));
2807 xsnprintf (str
, CELLSIZE
, "%s%0*lu", sign
, width
, temp
[0]);
2810 xsnprintf (str
, CELLSIZE
, "%s%0*lu%09lu", sign
, width
,
2814 xsnprintf (str
, CELLSIZE
, "%s%0*lu%09lu%09lu", sign
, width
,
2815 temp
[2], temp
[1], temp
[0]);
2818 internal_error (__FILE__
, __LINE__
,
2819 _("failed internal consistency check"));
2826 octal2str (ULONGEST addr
, int width
)
2828 unsigned long temp
[3];
2829 char *str
= get_cell ();
2834 temp
[i
] = addr
% (0100000 * 0100000);
2835 addr
/= (0100000 * 0100000);
2839 while (addr
!= 0 && i
< (sizeof (temp
) / sizeof (temp
[0])));
2849 xsnprintf (str
, CELLSIZE
, "%*o", width
, 0);
2851 xsnprintf (str
, CELLSIZE
, "0%0*lo", width
, temp
[0]);
2854 xsnprintf (str
, CELLSIZE
, "0%0*lo%010lo", width
, temp
[1], temp
[0]);
2857 xsnprintf (str
, CELLSIZE
, "0%0*lo%010lo%010lo", width
,
2858 temp
[2], temp
[1], temp
[0]);
2861 internal_error (__FILE__
, __LINE__
,
2862 _("failed internal consistency check"));
2869 pulongest (ULONGEST u
)
2871 return decimal2str ("", u
, 0);
2875 plongest (LONGEST l
)
2878 return decimal2str ("-", -l
, 0);
2880 return decimal2str ("", l
, 0);
2883 /* Eliminate warning from compiler on 32-bit systems. */
2884 static int thirty_two
= 32;
2887 phex (ULONGEST l
, int sizeof_l
)
2895 xsnprintf (str
, CELLSIZE
, "%08lx%08lx",
2896 (unsigned long) (l
>> thirty_two
),
2897 (unsigned long) (l
& 0xffffffff));
2901 xsnprintf (str
, CELLSIZE
, "%08lx", (unsigned long) l
);
2905 xsnprintf (str
, CELLSIZE
, "%04x", (unsigned short) (l
& 0xffff));
2908 str
= phex (l
, sizeof (l
));
2916 phex_nz (ULONGEST l
, int sizeof_l
)
2924 unsigned long high
= (unsigned long) (l
>> thirty_two
);
2928 xsnprintf (str
, CELLSIZE
, "%lx",
2929 (unsigned long) (l
& 0xffffffff));
2931 xsnprintf (str
, CELLSIZE
, "%lx%08lx", high
,
2932 (unsigned long) (l
& 0xffffffff));
2937 xsnprintf (str
, CELLSIZE
, "%lx", (unsigned long) l
);
2941 xsnprintf (str
, CELLSIZE
, "%x", (unsigned short) (l
& 0xffff));
2944 str
= phex_nz (l
, sizeof (l
));
2951 /* Converts a LONGEST to a C-format hexadecimal literal and stores it
2952 in a static string. Returns a pointer to this string. */
2954 hex_string (LONGEST num
)
2956 char *result
= get_cell ();
2958 xsnprintf (result
, CELLSIZE
, "0x%s", phex_nz (num
, sizeof (num
)));
2962 /* Converts a LONGEST number to a C-format hexadecimal literal and
2963 stores it in a static string. Returns a pointer to this string
2964 that is valid until the next call. The number is padded on the
2965 left with 0s to at least WIDTH characters. */
2967 hex_string_custom (LONGEST num
, int width
)
2969 char *result
= get_cell ();
2970 char *result_end
= result
+ CELLSIZE
- 1;
2971 const char *hex
= phex_nz (num
, sizeof (num
));
2972 int hex_len
= strlen (hex
);
2974 if (hex_len
> width
)
2976 if (width
+ 2 >= CELLSIZE
)
2977 internal_error (__FILE__
, __LINE__
, _("\
2978 hex_string_custom: insufficient space to store result"));
2980 strcpy (result_end
- width
- 2, "0x");
2981 memset (result_end
- width
, '0', width
);
2982 strcpy (result_end
- hex_len
, hex
);
2983 return result_end
- width
- 2;
2986 /* Convert VAL to a numeral in the given radix. For
2987 * radix 10, IS_SIGNED may be true, indicating a signed quantity;
2988 * otherwise VAL is interpreted as unsigned. If WIDTH is supplied,
2989 * it is the minimum width (0-padded if needed). USE_C_FORMAT means
2990 * to use C format in all cases. If it is false, then 'x'
2991 * and 'o' formats do not include a prefix (0x or leading 0). */
2994 int_string (LONGEST val
, int radix
, int is_signed
, int width
,
3004 result
= hex_string (val
);
3006 result
= hex_string_custom (val
, width
);
3013 if (is_signed
&& val
< 0)
3014 return decimal2str ("-", -val
, width
);
3016 return decimal2str ("", val
, width
);
3020 char *result
= octal2str (val
, width
);
3022 if (use_c_format
|| val
== 0)
3028 internal_error (__FILE__
, __LINE__
,
3029 _("failed internal consistency check"));
3033 /* Convert a CORE_ADDR into a string. */
3035 core_addr_to_string (const CORE_ADDR addr
)
3037 char *str
= get_cell ();
3040 strcat (str
, phex (addr
, sizeof (addr
)));
3045 core_addr_to_string_nz (const CORE_ADDR addr
)
3047 char *str
= get_cell ();
3050 strcat (str
, phex_nz (addr
, sizeof (addr
)));
3054 /* Convert a string back into a CORE_ADDR. */
3056 string_to_core_addr (const char *my_string
)
3060 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
3062 /* Assume that it is in hex. */
3065 for (i
= 2; my_string
[i
] != '\0'; i
++)
3067 if (isdigit (my_string
[i
]))
3068 addr
= (my_string
[i
] - '0') + (addr
* 16);
3069 else if (isxdigit (my_string
[i
]))
3070 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
3072 error (_("invalid hex \"%s\""), my_string
);
3077 /* Assume that it is in decimal. */
3080 for (i
= 0; my_string
[i
] != '\0'; i
++)
3082 if (isdigit (my_string
[i
]))
3083 addr
= (my_string
[i
] - '0') + (addr
* 10);
3085 error (_("invalid decimal \"%s\""), my_string
);
3093 host_address_to_string (const void *addr
)
3095 char *str
= get_cell ();
3097 xsnprintf (str
, CELLSIZE
, "0x%s", phex_nz ((uintptr_t) addr
, sizeof (addr
)));
3102 gdb_realpath (const char *filename
)
3104 /* Method 1: The system has a compile time upper bound on a filename
3105 path. Use that and realpath() to canonicalize the name. This is
3106 the most common case. Note that, if there isn't a compile time
3107 upper bound, you want to avoid realpath() at all costs. */
3108 #if defined(HAVE_REALPATH)
3110 # if defined (PATH_MAX)
3112 # define USE_REALPATH
3113 # elif defined (MAXPATHLEN)
3114 char buf
[MAXPATHLEN
];
3115 # define USE_REALPATH
3117 # if defined (USE_REALPATH)
3118 const char *rp
= realpath (filename
, buf
);
3122 return xstrdup (rp
);
3125 #endif /* HAVE_REALPATH */
3127 /* Method 2: The host system (i.e., GNU) has the function
3128 canonicalize_file_name() which malloc's a chunk of memory and
3129 returns that, use that. */
3130 #if defined(HAVE_CANONICALIZE_FILE_NAME)
3132 char *rp
= canonicalize_file_name (filename
);
3135 return xstrdup (filename
);
3141 /* FIXME: cagney/2002-11-13:
3143 Method 2a: Use realpath() with a NULL buffer. Some systems, due
3144 to the problems described in method 3, have modified their
3145 realpath() implementation so that it will allocate a buffer when
3146 NULL is passed in. Before this can be used, though, some sort of
3147 configure time test would need to be added. Otherwize the code
3148 will likely core dump. */
3150 /* Method 3: Now we're getting desperate! The system doesn't have a
3151 compile time buffer size and no alternative function. Query the
3152 OS, using pathconf(), for the buffer limit. Care is needed
3153 though, some systems do not limit PATH_MAX (return -1 for
3154 pathconf()) making it impossible to pass a correctly sized buffer
3155 to realpath() (it could always overflow). On those systems, we
3157 #if defined (HAVE_REALPATH) && defined (HAVE_UNISTD_H) && defined(HAVE_ALLOCA)
3159 /* Find out the max path size. */
3160 long path_max
= pathconf ("/", _PC_PATH_MAX
);
3164 /* PATH_MAX is bounded. */
3165 char *buf
= alloca (path_max
);
3166 char *rp
= realpath (filename
, buf
);
3168 return xstrdup (rp
? rp
: filename
);
3173 /* The MS Windows method. If we don't have realpath, we assume we
3174 don't have symlinks and just canonicalize to a Windows absolute
3175 path. GetFullPath converts ../ and ./ in relative paths to
3176 absolute paths, filling in current drive if one is not given
3177 or using the current directory of a specified drive (eg, "E:foo").
3178 It also converts all forward slashes to back slashes. */
3179 /* The file system is case-insensitive but case-preserving.
3180 So we do not lowercase the path. Otherwise, we might not
3181 be able to display the original casing in a given path. */
3182 #if defined (_WIN32)
3185 DWORD len
= GetFullPathName (filename
, MAX_PATH
, buf
, NULL
);
3187 if (len
> 0 && len
< MAX_PATH
)
3188 return xstrdup (buf
);
3192 /* This system is a lost cause, just dup the buffer. */
3193 return xstrdup (filename
);
3197 align_up (ULONGEST v
, int n
)
3199 /* Check that N is really a power of two. */
3200 gdb_assert (n
&& (n
& (n
-1)) == 0);
3201 return (v
+ n
- 1) & -n
;
3205 align_down (ULONGEST v
, int n
)
3207 /* Check that N is really a power of two. */
3208 gdb_assert (n
&& (n
& (n
-1)) == 0);
3212 /* Allocation function for the libiberty hash table which uses an
3213 obstack. The obstack is passed as DATA. */
3216 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
3218 unsigned int total
= size
* count
;
3219 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
3221 memset (ptr
, 0, total
);
3225 /* Trivial deallocation function for the libiberty splay tree and hash
3226 table - don't deallocate anything. Rely on later deletion of the
3227 obstack. DATA will be the obstack, although it is not needed
3231 dummy_obstack_deallocate (void *object
, void *data
)
3236 /* The bit offset of the highest byte in a ULONGEST, for overflow
3239 #define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT)
3241 /* True (non-zero) iff DIGIT is a valid digit in radix BASE,
3242 where 2 <= BASE <= 36. */
3245 is_digit_in_base (unsigned char digit
, int base
)
3247 if (!isalnum (digit
))
3250 return (isdigit (digit
) && digit
< base
+ '0');
3252 return (isdigit (digit
) || tolower (digit
) < base
- 10 + 'a');
3256 digit_to_int (unsigned char c
)
3261 return tolower (c
) - 'a' + 10;
3264 /* As for strtoul, but for ULONGEST results. */
3267 strtoulst (const char *num
, const char **trailer
, int base
)
3269 unsigned int high_part
;
3274 /* Skip leading whitespace. */
3275 while (isspace (num
[i
]))
3278 /* Handle prefixes. */
3281 else if (num
[i
] == '-')
3287 if (base
== 0 || base
== 16)
3289 if (num
[i
] == '0' && (num
[i
+ 1] == 'x' || num
[i
+ 1] == 'X'))
3297 if (base
== 0 && num
[i
] == '0')
3303 if (base
< 2 || base
> 36)
3309 result
= high_part
= 0;
3310 for (; is_digit_in_base (num
[i
], base
); i
+= 1)
3312 result
= result
* base
+ digit_to_int (num
[i
]);
3313 high_part
= high_part
* base
+ (unsigned int) (result
>> HIGH_BYTE_POSN
);
3314 result
&= ((ULONGEST
) 1 << HIGH_BYTE_POSN
) - 1;
3315 if (high_part
> 0xff)
3318 result
= ~ (ULONGEST
) 0;
3325 if (trailer
!= NULL
)
3328 result
= result
+ ((ULONGEST
) high_part
<< HIGH_BYTE_POSN
);
3335 /* Simple, portable version of dirname that does not modify its
3339 ldirname (const char *filename
)
3341 const char *base
= lbasename (filename
);
3344 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
3347 if (base
== filename
)
3350 dirname
= xmalloc (base
- filename
+ 2);
3351 memcpy (dirname
, filename
, base
- filename
);
3353 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3354 create "d:./bar" later instead of the (different) "d:/bar". */
3355 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3356 && !IS_DIR_SEPARATOR (filename
[0]))
3357 dirname
[base
++ - filename
] = '.';
3359 dirname
[base
- filename
] = '\0';
3363 /* Call libiberty's buildargv, and return the result.
3364 If buildargv fails due to out-of-memory, call nomem.
3365 Therefore, the returned value is guaranteed to be non-NULL,
3366 unless the parameter itself is NULL. */
3369 gdb_buildargv (const char *s
)
3371 char **argv
= buildargv (s
);
3373 if (s
!= NULL
&& argv
== NULL
)
3379 compare_positive_ints (const void *ap
, const void *bp
)
3381 /* Because we know we're comparing two ints which are positive,
3382 there's no danger of overflow here. */
3383 return * (int *) ap
- * (int *) bp
;
3386 /* String compare function for qsort. */
3389 compare_strings (const void *arg1
, const void *arg2
)
3391 const char **s1
= (const char **) arg1
;
3392 const char **s2
= (const char **) arg2
;
3394 return strcmp (*s1
, *s2
);
3397 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3398 #define AMBIGUOUS_MESS2 \
3399 ".\nUse \"set gnutarget format-name\" to specify the format."
3402 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3408 /* Check if errmsg just need simple return. */
3409 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3410 return bfd_errmsg (error_tag
);
3412 ret_len
= strlen (bfd_errmsg (error_tag
)) + strlen (AMBIGUOUS_MESS1
)
3413 + strlen (AMBIGUOUS_MESS2
);
3414 for (p
= matching
; *p
; p
++)
3415 ret_len
+= strlen (*p
) + 1;
3416 ret
= xmalloc (ret_len
+ 1);
3418 make_cleanup (xfree
, ret
);
3420 strcpy (retp
, bfd_errmsg (error_tag
));
3421 retp
+= strlen (retp
);
3423 strcpy (retp
, AMBIGUOUS_MESS1
);
3424 retp
+= strlen (retp
);
3426 for (p
= matching
; *p
; p
++)
3428 sprintf (retp
, " %s", *p
);
3429 retp
+= strlen (retp
);
3433 strcpy (retp
, AMBIGUOUS_MESS2
);
3438 /* Return ARGS parsed as a valid pid, or throw an error. */
3441 parse_pid_to_attach (char *args
)
3447 error_no_arg (_("process-id to attach"));
3450 pid
= strtoul (args
, &dummy
, 0);
3451 /* Some targets don't set errno on errors, grrr! */
3452 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3453 error (_("Illegal process-id: %s."), args
);
3458 /* Helper for make_bpstat_clear_actions_cleanup. */
3461 do_bpstat_clear_actions_cleanup (void *unused
)
3463 bpstat_clear_actions ();
3466 /* Call bpstat_clear_actions for the case an exception is throw. You should
3467 discard_cleanups if no exception is caught. */
3470 make_bpstat_clear_actions_cleanup (void)
3472 return make_cleanup (do_bpstat_clear_actions_cleanup
, NULL
);
3475 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3476 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3477 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3480 producer_is_gcc_ge_4 (const char *producer
)
3485 if (producer
== NULL
)
3487 /* For unknown compilers expect their behavior is not compliant. For GCC
3488 this case can also happen for -gdwarf-4 type units supported since
3494 /* Skip any identifier after "GNU " - such as "C++" or "Java". */
3496 if (strncmp (producer
, "GNU ", strlen ("GNU ")) != 0)
3498 /* For non-GCC compilers expect their behavior is not compliant. */
3502 cs
= &producer
[strlen ("GNU ")];
3503 while (*cs
&& !isdigit (*cs
))
3505 if (sscanf (cs
, "%d.%d", &major
, &minor
) != 2)
3507 /* Not recognized as GCC. */
3519 /* Helper for make_cleanup_free_char_ptr_vec. */
3522 do_free_char_ptr_vec (void *arg
)
3524 VEC (char_ptr
) *char_ptr_vec
= arg
;
3526 free_char_ptr_vec (char_ptr_vec
);
3529 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3530 final VEC_free for CHAR_PTR_VEC itself.
3532 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3533 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3534 this function does not (cannot) clear the pointer. */
3537 make_cleanup_free_char_ptr_vec (VEC (char_ptr
) *char_ptr_vec
)
3539 return make_cleanup (do_free_char_ptr_vec
, char_ptr_vec
);
3542 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3543 must come from xrealloc-compatible allocator and it may be updated. FROM
3544 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3545 located at the start or end of *STRINGP. */
3548 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3550 char *string
= *stringp
, *s
;
3551 const size_t from_len
= strlen (from
);
3552 const size_t to_len
= strlen (to
);
3556 s
= strstr (s
, from
);
3560 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3561 || s
[-1] == DIRNAME_SEPARATOR
)
3562 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3563 || s
[from_len
] == DIRNAME_SEPARATOR
))
3567 string_new
= xrealloc (string
, (strlen (string
) + to_len
+ 1));
3569 /* Relocate the current S pointer. */
3570 s
= s
- string
+ string_new
;
3571 string
= string_new
;
3573 /* Replace from by to. */
3574 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3575 memcpy (s
, to
, to_len
);
3590 /* SIGALRM handler for waitpid_with_timeout. */
3593 sigalrm_handler (int signo
)
3595 /* Nothing to do. */
3600 /* Wrapper to wait for child PID to die with TIMEOUT.
3601 TIMEOUT is the time to stop waiting in seconds.
3602 If TIMEOUT is zero, pass WNOHANG to waitpid.
3603 Returns PID if it was successfully waited for, otherwise -1.
3605 Timeouts are currently implemented with alarm and SIGALRM.
3606 If the host does not support them, this waits "forever".
3607 It would be odd though for a host to have waitpid and not SIGALRM. */
3610 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3612 pid_t waitpid_result
;
3614 gdb_assert (pid
> 0);
3615 gdb_assert (timeout
>= 0);
3620 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3621 struct sigaction sa
, old_sa
;
3623 sa
.sa_handler
= sigalrm_handler
;
3624 sigemptyset (&sa
.sa_mask
);
3626 sigaction (SIGALRM
, &sa
, &old_sa
);
3630 ofunc
= (void (*)()) signal (SIGALRM
, sigalrm_handler
);
3636 waitpid_result
= waitpid (pid
, status
, 0);
3640 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3641 sigaction (SIGALRM
, &old_sa
, NULL
);
3643 signal (SIGALRM
, ofunc
);
3648 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3650 if (waitpid_result
== pid
)
3656 #endif /* HAVE_WAITPID */
3658 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3659 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3661 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3662 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3665 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3667 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3669 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3670 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3672 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3674 char *pattern_slash
, *string_slash
;
3676 /* Replace '\' by '/' in both strings. */
3678 pattern_slash
= alloca (strlen (pattern
) + 1);
3679 strcpy (pattern_slash
, pattern
);
3680 pattern
= pattern_slash
;
3681 for (; *pattern_slash
!= 0; pattern_slash
++)
3682 if (IS_DIR_SEPARATOR (*pattern_slash
))
3683 *pattern_slash
= '/';
3685 string_slash
= alloca (strlen (string
) + 1);
3686 strcpy (string_slash
, string
);
3687 string
= string_slash
;
3688 for (; *string_slash
!= 0; string_slash
++)
3689 if (IS_DIR_SEPARATOR (*string_slash
))
3690 *string_slash
= '/';
3692 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3694 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3695 flags
|= FNM_CASEFOLD
;
3696 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3698 return fnmatch (pattern
, string
, flags
);
3701 /* Provide a prototype to silence -Wmissing-prototypes. */
3702 extern initialize_file_ftype _initialize_utils
;
3705 _initialize_utils (void)
3707 add_internal_problem_command (&internal_error_problem
);
3708 add_internal_problem_command (&internal_warning_problem
);