1 /* General utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2017 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/>. */
23 #include "event-top.h"
24 #include "gdbthread.h"
27 #ifdef HAVE_SYS_RESOURCE_H
28 #include <sys/resource.h>
29 #endif /* HAVE_SYS_RESOURCE_H */
32 #include "tui/tui.h" /* For tui_get_command_dimension. */
44 #include "gdb-demangle.h"
45 #include "expression.h"
49 #include "filenames.h"
51 #include "gdb_obstack.h"
57 #include "inferior.h" /* for signed_pointer_to_address */
59 #include "gdb_curses.h"
61 #include "readline/readline.h"
65 #include "gdb_usleep.h"
67 #include "gdb_regex.h"
68 #include "job-control.h"
69 #include "common/selftest.h"
70 #include "common/gdb_optional.h"
73 extern PTR
malloc (); /* ARI: PTR */
75 #if !HAVE_DECL_REALLOC
76 extern PTR
realloc (); /* ARI: PTR */
82 void (*deprecated_error_begin_hook
) (void);
84 /* Prototypes for local functions */
86 static void vfprintf_maybe_filtered (struct ui_file
*, const char *,
87 va_list, int) ATTRIBUTE_PRINTF (2, 0);
89 static void fputs_maybe_filtered (const char *, struct ui_file
*, int);
91 static void prompt_for_continue (void);
93 static void set_screen_size (void);
94 static void set_width (void);
96 /* Time spent in prompt_for_continue in the currently executing command
97 waiting for user to respond.
98 Initialized in make_command_stats_cleanup.
99 Modified in prompt_for_continue and defaulted_query.
100 Used in report_command_stats. */
102 static std::chrono::steady_clock::duration prompt_for_continue_wait_time
;
104 /* A flag indicating whether to timestamp debugging messages. */
106 static int debug_timestamp
= 0;
108 /* Nonzero means that strings with character values >0x7F should be printed
109 as octal escapes. Zero means just print the value (e.g. it's an
110 international character, and the terminal or window can cope.) */
112 int sevenbit_strings
= 0;
114 show_sevenbit_strings (struct ui_file
*file
, int from_tty
,
115 struct cmd_list_element
*c
, const char *value
)
117 fprintf_filtered (file
, _("Printing of 8-bit characters "
118 "in strings as \\nnn is %s.\n"),
122 /* String to be printed before warning messages, if any. */
124 const char *warning_pre_print
= "\nwarning: ";
126 int pagination_enabled
= 1;
128 show_pagination_enabled (struct ui_file
*file
, int from_tty
,
129 struct cmd_list_element
*c
, const char *value
)
131 fprintf_filtered (file
, _("State of pagination is %s.\n"), value
);
135 /* Cleanup utilities.
137 These are not defined in cleanups.c (nor declared in cleanups.h)
138 because while they use the "cleanup API" they are not part of the
142 do_free_section_addr_info (void *arg
)
144 free_section_addr_info ((struct section_addr_info
*) arg
);
148 make_cleanup_free_section_addr_info (struct section_addr_info
*addrs
)
150 return make_cleanup (do_free_section_addr_info
, addrs
);
153 /* Helper for make_cleanup_unpush_target. */
156 do_unpush_target (void *arg
)
158 struct target_ops
*ops
= (struct target_ops
*) arg
;
163 /* Return a new cleanup that unpushes OPS. */
166 make_cleanup_unpush_target (struct target_ops
*ops
)
168 return make_cleanup (do_unpush_target
, ops
);
171 /* Helper for make_cleanup_value_free_to_mark. */
174 do_value_free_to_mark (void *value
)
176 value_free_to_mark ((struct value
*) value
);
179 /* Free all values allocated since MARK was obtained by value_mark
180 (except for those released) when the cleanup is run. */
183 make_cleanup_value_free_to_mark (struct value
*mark
)
185 return make_cleanup (do_value_free_to_mark
, mark
);
188 /* Helper for make_cleanup_value_free. */
191 do_value_free (void *value
)
193 value_free ((struct value
*) value
);
199 make_cleanup_value_free (struct value
*value
)
201 return make_cleanup (do_value_free
, value
);
204 /* This function is useful for cleanups.
208 old_chain = make_cleanup (free_current_contents, &foo);
210 to arrange to free the object thus allocated. */
213 free_current_contents (void *ptr
)
215 void **location
= (void **) ptr
;
217 if (location
== NULL
)
218 internal_error (__FILE__
, __LINE__
,
219 _("free_current_contents: NULL pointer"));
220 if (*location
!= NULL
)
229 /* Print a warning message. The first argument STRING is the warning
230 message, used as an fprintf format string, the second is the
231 va_list of arguments for that string. A warning is unfiltered (not
232 paginated) so that the user does not need to page through each
233 screen full of warnings when there are lots of them. */
236 vwarning (const char *string
, va_list args
)
238 if (deprecated_warning_hook
)
239 (*deprecated_warning_hook
) (string
, args
);
242 gdb::optional
<target_terminal::scoped_restore_terminal_state
> term_state
;
243 if (target_supports_terminal_ours ())
245 term_state
.emplace ();
246 target_terminal::ours_for_output ();
248 if (filtered_printing_initialized ())
249 wrap_here (""); /* Force out any buffered output. */
250 gdb_flush (gdb_stdout
);
251 if (warning_pre_print
)
252 fputs_unfiltered (warning_pre_print
, gdb_stderr
);
253 vfprintf_unfiltered (gdb_stderr
, string
, args
);
254 fprintf_unfiltered (gdb_stderr
, "\n");
258 /* Print an error message and return to command level.
259 The first argument STRING is the error message, used as a fprintf string,
260 and the remaining args are passed as arguments to it. */
263 verror (const char *string
, va_list args
)
265 throw_verror (GENERIC_ERROR
, string
, args
);
269 error_stream (const string_file
&stream
)
271 error (("%s"), stream
.c_str ());
274 /* Emit a message and abort. */
276 static void ATTRIBUTE_NORETURN
277 abort_with_message (const char *msg
)
279 if (current_ui
== NULL
)
282 fputs_unfiltered (msg
, gdb_stderr
);
284 abort (); /* NOTE: GDB has only three calls to abort(). */
287 /* Dump core trying to increase the core soft limit to hard limit first. */
292 #ifdef HAVE_SETRLIMIT
293 struct rlimit rlim
= { RLIM_INFINITY
, RLIM_INFINITY
};
295 setrlimit (RLIMIT_CORE
, &rlim
);
296 #endif /* HAVE_SETRLIMIT */
298 abort (); /* NOTE: GDB has only three calls to abort(). */
301 /* Check whether GDB will be able to dump core using the dump_core
302 function. Returns zero if GDB cannot or should not dump core.
303 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
304 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
307 can_dump_core (enum resource_limit_kind limit_kind
)
309 #ifdef HAVE_GETRLIMIT
312 /* Be quiet and assume we can dump if an error is returned. */
313 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
319 if (rlim
.rlim_cur
== 0)
323 if (rlim
.rlim_max
== 0)
326 #endif /* HAVE_GETRLIMIT */
331 /* Print a warning that we cannot dump core. */
334 warn_cant_dump_core (const char *reason
)
336 fprintf_unfiltered (gdb_stderr
,
337 _("%s\nUnable to dump core, use `ulimit -c"
338 " unlimited' before executing GDB next time.\n"),
342 /* Check whether GDB will be able to dump core using the dump_core
343 function, and print a warning if we cannot. */
346 can_dump_core_warn (enum resource_limit_kind limit_kind
,
349 int core_dump_allowed
= can_dump_core (limit_kind
);
351 if (!core_dump_allowed
)
352 warn_cant_dump_core (reason
);
354 return core_dump_allowed
;
357 /* Allow the user to configure the debugger behavior with respect to
358 what to do when an internal problem is detected. */
360 const char internal_problem_ask
[] = "ask";
361 const char internal_problem_yes
[] = "yes";
362 const char internal_problem_no
[] = "no";
363 static const char *const internal_problem_modes
[] =
365 internal_problem_ask
,
366 internal_problem_yes
,
371 /* Print a message reporting an internal error/warning. Ask the user
372 if they want to continue, dump core, or just exit. Return
373 something to indicate a quit. */
375 struct internal_problem
378 int user_settable_should_quit
;
379 const char *should_quit
;
380 int user_settable_should_dump_core
;
381 const char *should_dump_core
;
384 /* Report a problem, internal to GDB, to the user. Once the problem
385 has been reported, and assuming GDB didn't quit, the caller can
386 either allow execution to resume or throw an error. */
388 static void ATTRIBUTE_PRINTF (4, 0)
389 internal_vproblem (struct internal_problem
*problem
,
390 const char *file
, int line
, const char *fmt
, va_list ap
)
397 /* Don't allow infinite error/warning recursion. */
399 static char msg
[] = "Recursive internal problem.\n";
408 abort_with_message (msg
);
411 /* Newer GLIBC versions put the warn_unused_result attribute
412 on write, but this is one of those rare cases where
413 ignoring the return value is correct. Casting to (void)
414 does not fix this problem. This is the solution suggested
415 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
416 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
417 abort (); /* NOTE: GDB has only three calls to abort(). */
422 /* Create a string containing the full error/warning message. Need
423 to call query with this full string, as otherwize the reason
424 (error/warning) and question become separated. Format using a
425 style similar to a compiler error message. Include extra detail
426 so that the user knows that they are living on the edge. */
428 std::string msg
= string_printf (fmt
, ap
);
429 reason
= string_printf ("%s:%d: %s: %s\n"
430 "A problem internal to GDB has been detected,\n"
431 "further debugging may prove unreliable.",
432 file
, line
, problem
->name
, msg
.c_str ());
435 /* Fall back to abort_with_message if gdb_stderr is not set up. */
436 if (current_ui
== NULL
)
438 fputs (reason
.c_str (), stderr
);
439 abort_with_message ("\n");
442 /* Try to get the message out and at the start of a new line. */
443 gdb::optional
<target_terminal::scoped_restore_terminal_state
> term_state
;
444 if (target_supports_terminal_ours ())
446 term_state
.emplace ();
447 target_terminal::ours_for_output ();
449 if (filtered_printing_initialized ())
452 /* Emit the message unless query will emit it below. */
453 if (problem
->should_quit
!= internal_problem_ask
455 || !filtered_printing_initialized ())
456 fprintf_unfiltered (gdb_stderr
, "%s\n", reason
.c_str ());
458 if (problem
->should_quit
== internal_problem_ask
)
460 /* Default (yes/batch case) is to quit GDB. When in batch mode
461 this lessens the likelihood of GDB going into an infinite
463 if (!confirm
|| !filtered_printing_initialized ())
466 quit_p
= query (_("%s\nQuit this debugging session? "),
469 else if (problem
->should_quit
== internal_problem_yes
)
471 else if (problem
->should_quit
== internal_problem_no
)
474 internal_error (__FILE__
, __LINE__
, _("bad switch"));
476 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr
);
477 if (REPORT_BUGS_TO
[0])
478 fprintf_unfiltered (gdb_stderr
, _(" For instructions, see:\n%s."),
480 fputs_unfiltered ("\n\n", gdb_stderr
);
482 if (problem
->should_dump_core
== internal_problem_ask
)
484 if (!can_dump_core_warn (LIMIT_MAX
, reason
.c_str ()))
486 else if (!filtered_printing_initialized ())
490 /* Default (yes/batch case) is to dump core. This leaves a GDB
491 `dropping' so that it is easier to see that something went
493 dump_core_p
= query (_("%s\nCreate a core file of GDB? "),
497 else if (problem
->should_dump_core
== internal_problem_yes
)
498 dump_core_p
= can_dump_core_warn (LIMIT_MAX
, reason
.c_str ());
499 else if (problem
->should_dump_core
== internal_problem_no
)
502 internal_error (__FILE__
, __LINE__
, _("bad switch"));
515 #ifdef HAVE_WORKING_FORK
525 static struct internal_problem internal_error_problem
= {
526 "internal-error", 1, internal_problem_ask
, 1, internal_problem_ask
530 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
532 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
533 throw_quit (_("Command aborted."));
536 static struct internal_problem internal_warning_problem
= {
537 "internal-warning", 1, internal_problem_ask
, 1, internal_problem_ask
541 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
543 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
546 static struct internal_problem demangler_warning_problem
= {
547 "demangler-warning", 1, internal_problem_ask
, 0, internal_problem_no
551 demangler_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
553 internal_vproblem (&demangler_warning_problem
, file
, line
, fmt
, ap
);
557 demangler_warning (const char *file
, int line
, const char *string
, ...)
561 va_start (ap
, string
);
562 demangler_vwarning (file
, line
, string
, ap
);
566 /* Dummy functions to keep add_prefix_cmd happy. */
569 set_internal_problem_cmd (char *args
, int from_tty
)
574 show_internal_problem_cmd (char *args
, int from_tty
)
578 /* When GDB reports an internal problem (error or warning) it gives
579 the user the opportunity to quit GDB and/or create a core file of
580 the current debug session. This function registers a few commands
581 that make it possible to specify that GDB should always or never
582 quit or create a core file, without asking. The commands look
585 maint set PROBLEM-NAME quit ask|yes|no
586 maint show PROBLEM-NAME quit
587 maint set PROBLEM-NAME corefile ask|yes|no
588 maint show PROBLEM-NAME corefile
590 Where PROBLEM-NAME is currently "internal-error" or
591 "internal-warning". */
594 add_internal_problem_command (struct internal_problem
*problem
)
596 struct cmd_list_element
**set_cmd_list
;
597 struct cmd_list_element
**show_cmd_list
;
601 set_cmd_list
= XNEW (struct cmd_list_element
*);
602 show_cmd_list
= XNEW (struct cmd_list_element
*);
603 *set_cmd_list
= NULL
;
604 *show_cmd_list
= NULL
;
606 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
609 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
612 add_prefix_cmd ((char*) problem
->name
,
613 class_maintenance
, set_internal_problem_cmd
, set_doc
,
615 concat ("maintenance set ", problem
->name
, " ",
617 0/*allow-unknown*/, &maintenance_set_cmdlist
);
619 add_prefix_cmd ((char*) problem
->name
,
620 class_maintenance
, show_internal_problem_cmd
, show_doc
,
622 concat ("maintenance show ", problem
->name
, " ",
624 0/*allow-unknown*/, &maintenance_show_cmdlist
);
626 if (problem
->user_settable_should_quit
)
628 set_doc
= xstrprintf (_("Set whether GDB should quit "
629 "when an %s is detected"),
631 show_doc
= xstrprintf (_("Show whether GDB will quit "
632 "when an %s is detected"),
634 add_setshow_enum_cmd ("quit", class_maintenance
,
635 internal_problem_modes
,
636 &problem
->should_quit
,
649 if (problem
->user_settable_should_dump_core
)
651 set_doc
= xstrprintf (_("Set whether GDB should create a core "
652 "file of GDB when %s is detected"),
654 show_doc
= xstrprintf (_("Show whether GDB will create a core "
655 "file of GDB when %s is detected"),
657 add_setshow_enum_cmd ("corefile", class_maintenance
,
658 internal_problem_modes
,
659 &problem
->should_dump_core
,
673 /* Return a newly allocated string, containing the PREFIX followed
674 by the system error message for errno (separated by a colon). */
677 perror_string (const char *prefix
)
681 err
= safe_strerror (errno
);
682 return std::string (prefix
) + ": " + err
;
685 /* Print the system error message for errno, and also mention STRING
686 as the file name for which the error was encountered. Use ERRCODE
687 for the thrown exception. Then return to command level. */
690 throw_perror_with_name (enum errors errcode
, const char *string
)
692 std::string combined
= perror_string (string
);
694 /* I understand setting these is a matter of taste. Still, some people
695 may clear errno but not know about bfd_error. Doing this here is not
697 bfd_set_error (bfd_error_no_error
);
700 throw_error (errcode
, _("%s."), combined
.c_str ());
703 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
706 perror_with_name (const char *string
)
708 throw_perror_with_name (GENERIC_ERROR
, string
);
711 /* Same as perror_with_name except that it prints a warning instead
712 of throwing an error. */
715 perror_warning_with_name (const char *string
)
717 std::string combined
= perror_string (string
);
718 warning (_("%s"), combined
.c_str ());
721 /* Print the system error message for ERRCODE, and also mention STRING
722 as the file name for which the error was encountered. */
725 print_sys_errmsg (const char *string
, int errcode
)
730 err
= safe_strerror (errcode
);
731 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
732 strcpy (combined
, string
);
733 strcat (combined
, ": ");
734 strcat (combined
, err
);
736 /* We want anything which was printed on stdout to come out first, before
738 gdb_flush (gdb_stdout
);
739 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
742 /* Control C eventually causes this to be called, at a convenient time. */
747 struct ui
*ui
= current_ui
;
749 if (sync_quit_force_run
)
751 sync_quit_force_run
= 0;
752 quit_force (NULL
, 0);
756 /* No steenking SIGINT will ever be coming our way when the
757 program is resumed. Don't lie. */
761 /* If there is no terminal switching for this target, then we can't
762 possibly get screwed by the lack of job control. */
763 || !target_supports_terminal_ours ())
766 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
775 if (sync_quit_force_run
)
780 if (deprecated_interactive_hook
)
781 deprecated_interactive_hook ();
785 /* Called when a memory allocation fails, with the number of bytes of
786 memory requested in SIZE. */
789 malloc_failure (long size
)
793 internal_error (__FILE__
, __LINE__
,
794 _("virtual memory exhausted: can't allocate %ld bytes."),
799 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
803 /* My replacement for the read system call.
804 Used like `read' but keeps going if `read' returns too soon. */
807 myread (int desc
, char *addr
, int len
)
814 val
= read (desc
, addr
, len
);
826 print_spaces (int n
, struct ui_file
*file
)
828 fputs_unfiltered (n_spaces (n
), file
);
831 /* Print a host address. */
834 gdb_print_host_address_1 (const void *addr
, struct ui_file
*stream
)
836 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
842 make_hex_string (const gdb_byte
*data
, size_t length
)
844 char *result
= (char *) xmalloc (length
* 2 + 1);
849 for (i
= 0; i
< length
; ++i
)
850 p
+= xsnprintf (p
, 3, "%02x", data
[i
]);
857 /* An RAII class that sets up to handle input and then tears down
858 during destruction. */
860 class scoped_input_handler
864 scoped_input_handler ()
865 : m_quit_handler (&quit_handler
, default_quit_handler
),
868 target_terminal::ours ();
869 ui_register_input_event_handler (current_ui
);
870 if (current_ui
->prompt_state
== PROMPT_BLOCKED
)
874 ~scoped_input_handler ()
877 ui_unregister_input_event_handler (m_ui
);
880 DISABLE_COPY_AND_ASSIGN (scoped_input_handler
);
884 /* Save and restore the terminal state. */
885 target_terminal::scoped_restore_terminal_state m_term_state
;
887 /* Save and restore the quit handler. */
888 scoped_restore_tmpl
<quit_handler_ftype
*> m_quit_handler
;
890 /* The saved UI, if non-NULL. */
896 /* This function supports the query, nquery, and yquery functions.
897 Ask user a y-or-n question and return 0 if answer is no, 1 if
898 answer is yes, or default the answer to the specified default
899 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
900 default answer, or '\0' for no default.
901 CTLSTR is the control string and should end in "? ". It should
902 not say how to answer, because we do that.
903 ARGS are the arguments passed along with the CTLSTR argument to
906 static int ATTRIBUTE_PRINTF (1, 0)
907 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
912 char def_answer
, not_def_answer
;
913 const char *y_string
, *n_string
;
915 /* Set up according to which answer is the default. */
920 not_def_answer
= 'N';
924 else if (defchar
== 'y')
928 not_def_answer
= 'N';
936 not_def_answer
= 'Y';
941 /* Automatically answer the default value if the user did not want
942 prompts or the command was issued with the server prefix. */
943 if (!confirm
|| server_command
)
946 /* If input isn't coming from the user directly, just say what
947 question we're asking, and then answer the default automatically. This
948 way, important error messages don't get lost when talking to GDB
950 if (current_ui
->instream
!= current_ui
->stdin_stream
951 || !input_interactive_p (current_ui
)
952 /* Restrict queries to the main UI. */
953 || current_ui
!= main_ui
)
955 target_terminal::scoped_restore_terminal_state term_state
;
956 target_terminal::ours_for_output ();
958 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
960 printf_filtered (_("(%s or %s) [answered %c; "
961 "input not from terminal]\n"),
962 y_string
, n_string
, def_answer
);
963 gdb_flush (gdb_stdout
);
968 if (deprecated_query_hook
)
970 target_terminal::scoped_restore_terminal_state term_state
;
971 return deprecated_query_hook (ctlstr
, args
);
974 /* Format the question outside of the loop, to avoid reusing args. */
975 std::string question
= string_vprintf (ctlstr
, args
);
977 = string_printf (_("%s%s(%s or %s) %s"),
978 annotation_level
> 1 ? "\n\032\032pre-query\n" : "",
979 question
.c_str (), y_string
, n_string
,
980 annotation_level
> 1 ? "\n\032\032query\n" : "");
982 /* Used to add duration we waited for user to respond to
983 prompt_for_continue_wait_time. */
984 using namespace std::chrono
;
985 steady_clock::time_point prompt_started
= steady_clock::now ();
987 scoped_input_handler prepare_input
;
991 char *response
, answer
;
993 gdb_flush (gdb_stdout
);
994 response
= gdb_readline_wrapper (prompt
.c_str ());
996 if (response
== NULL
) /* C-d */
998 printf_filtered ("EOF [assumed %c]\n", def_answer
);
1003 answer
= response
[0];
1008 /* Check answer. For the non-default, the user must specify
1009 the non-default explicitly. */
1010 if (answer
== not_def_answer
)
1012 retval
= !def_value
;
1015 /* Otherwise, if a default was specified, the user may either
1016 specify the required input or have it default by entering
1018 if (answer
== def_answer
1019 || (defchar
!= '\0' && answer
== '\0'))
1024 /* Invalid entries are not defaulted and require another selection. */
1025 printf_filtered (_("Please answer %s or %s.\n"),
1026 y_string
, n_string
);
1029 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1030 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1032 if (annotation_level
> 1)
1033 printf_filtered (("\n\032\032post-query\n"));
1038 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1039 answer is yes, or 0 if answer is defaulted.
1040 Takes three args which are given to printf to print the question.
1041 The first, a control string, should end in "? ".
1042 It should not say how to answer, because we do that. */
1045 nquery (const char *ctlstr
, ...)
1050 va_start (args
, ctlstr
);
1051 ret
= defaulted_query (ctlstr
, 'n', args
);
1056 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1057 answer is yes, or 1 if answer is defaulted.
1058 Takes three args which are given to printf to print the question.
1059 The first, a control string, should end in "? ".
1060 It should not say how to answer, because we do that. */
1063 yquery (const char *ctlstr
, ...)
1068 va_start (args
, ctlstr
);
1069 ret
= defaulted_query (ctlstr
, 'y', args
);
1074 /* Ask user a y-or-n question and return 1 iff answer is yes.
1075 Takes three args which are given to printf to print the question.
1076 The first, a control string, should end in "? ".
1077 It should not say how to answer, because we do that. */
1080 query (const char *ctlstr
, ...)
1085 va_start (args
, ctlstr
);
1086 ret
= defaulted_query (ctlstr
, '\0', args
);
1091 /* A helper for parse_escape that converts a host character to a
1092 target character. C is the host character. If conversion is
1093 possible, then the target character is stored in *TARGET_C and the
1094 function returns 1. Otherwise, the function returns 0. */
1097 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1102 auto_obstack host_data
;
1104 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1105 (gdb_byte
*) &the_char
, 1, 1,
1106 &host_data
, translit_none
);
1108 if (obstack_object_size (&host_data
) == 1)
1111 *target_c
= *(char *) obstack_base (&host_data
);
1117 /* Parse a C escape sequence. STRING_PTR points to a variable
1118 containing a pointer to the string to parse. That pointer
1119 should point to the character after the \. That pointer
1120 is updated past the characters we use. The value of the
1121 escape sequence is returned.
1123 A negative value means the sequence \ newline was seen,
1124 which is supposed to be equivalent to nothing at all.
1126 If \ is followed by a null character, we return a negative
1127 value and leave the string pointer pointing at the null character.
1129 If \ is followed by 000, we return 0 and leave the string pointer
1130 after the zeros. A value of 0 does not mean end of string. */
1133 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1135 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1136 int c
= *(*string_ptr
)++;
1155 int i
= host_hex_value (c
);
1160 if (isdigit (c
) && c
!= '8' && c
!= '9')
1164 i
+= host_hex_value (c
);
1200 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1201 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1202 " which has no equivalent\nin the `%s' character set."),
1203 c
, c
, target_charset (gdbarch
));
1207 /* Print the character C on STREAM as part of the contents of a literal
1208 string whose delimiter is QUOTER. Note that this routine should only
1209 be called for printing things which are independent of the language
1210 of the program being debugged.
1212 printchar will normally escape backslashes and instances of QUOTER. If
1213 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1214 As a side effect, if you pass the backslash character as the QUOTER,
1215 printchar will escape backslashes as usual, but not any other quoting
1219 printchar (int c
, void (*do_fputs
) (const char *, struct ui_file
*),
1220 void (*do_fprintf
) (struct ui_file
*, const char *, ...)
1221 ATTRIBUTE_FPTR_PRINTF_2
, struct ui_file
*stream
, int quoter
)
1223 c
&= 0xFF; /* Avoid sign bit follies */
1225 if (c
< 0x20 || /* Low control chars */
1226 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1227 (sevenbit_strings
&& c
>= 0x80))
1228 { /* high order bit set */
1232 do_fputs ("\\n", stream
);
1235 do_fputs ("\\b", stream
);
1238 do_fputs ("\\t", stream
);
1241 do_fputs ("\\f", stream
);
1244 do_fputs ("\\r", stream
);
1247 do_fputs ("\\e", stream
);
1250 do_fputs ("\\a", stream
);
1253 do_fprintf (stream
, "\\%.3o", (unsigned int) c
);
1259 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1260 do_fputs ("\\", stream
);
1261 do_fprintf (stream
, "%c", c
);
1265 /* Print the character C on STREAM as part of the contents of a
1266 literal string whose delimiter is QUOTER. Note that these routines
1267 should only be call for printing things which are independent of
1268 the language of the program being debugged. */
1271 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1274 printchar (*str
++, fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1278 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1281 printchar (*str
++, fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1285 fputstrn_filtered (const char *str
, int n
, int quoter
,
1286 struct ui_file
*stream
)
1290 for (i
= 0; i
< n
; i
++)
1291 printchar (str
[i
], fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1295 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1296 struct ui_file
*stream
)
1300 for (i
= 0; i
< n
; i
++)
1301 printchar (str
[i
], fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1305 /* Number of lines per page or UINT_MAX if paging is disabled. */
1306 static unsigned int lines_per_page
;
1308 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1309 struct cmd_list_element
*c
, const char *value
)
1311 fprintf_filtered (file
,
1312 _("Number of lines gdb thinks are in a page is %s.\n"),
1316 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1317 static unsigned int chars_per_line
;
1319 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1320 struct cmd_list_element
*c
, const char *value
)
1322 fprintf_filtered (file
,
1323 _("Number of characters gdb thinks "
1324 "are in a line is %s.\n"),
1328 /* Current count of lines printed on this page, chars on this line. */
1329 static unsigned int lines_printed
, chars_printed
;
1331 /* Buffer and start column of buffered text, for doing smarter word-
1332 wrapping. When someone calls wrap_here(), we start buffering output
1333 that comes through fputs_filtered(). If we see a newline, we just
1334 spit it out and forget about the wrap_here(). If we see another
1335 wrap_here(), we spit it out and remember the newer one. If we see
1336 the end of the line, we spit out a newline, the indent, and then
1337 the buffered output. */
1339 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1340 are waiting to be output (they have already been counted in chars_printed).
1341 When wrap_buffer[0] is null, the buffer is empty. */
1342 static char *wrap_buffer
;
1344 /* Pointer in wrap_buffer to the next character to fill. */
1345 static char *wrap_pointer
;
1347 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1349 static const char *wrap_indent
;
1351 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1352 is not in effect. */
1353 static int wrap_column
;
1356 /* Initialize the number of lines per page and chars per line. */
1359 init_page_info (void)
1363 lines_per_page
= UINT_MAX
;
1364 chars_per_line
= UINT_MAX
;
1368 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1373 #if defined(__GO32__)
1374 rows
= ScreenRows ();
1375 cols
= ScreenCols ();
1376 lines_per_page
= rows
;
1377 chars_per_line
= cols
;
1379 /* Make sure Readline has initialized its terminal settings. */
1380 rl_reset_terminal (NULL
);
1382 /* Get the screen size from Readline. */
1383 rl_get_screen_size (&rows
, &cols
);
1384 lines_per_page
= rows
;
1385 chars_per_line
= cols
;
1387 /* Readline should have fetched the termcap entry for us.
1388 Only try to use tgetnum function if rl_get_screen_size
1389 did not return a useful value. */
1390 if (((rows
<= 0) && (tgetnum ((char *) "li") < 0))
1391 /* Also disable paging if inside Emacs. $EMACS was used
1392 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1393 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1395 /* The number of lines per page is not mentioned in the terminal
1396 description or EMACS evironment variable is set. This probably
1397 means that paging is not useful, so disable paging. */
1398 lines_per_page
= UINT_MAX
;
1401 /* If the output is not a terminal, don't paginate it. */
1402 if (!ui_file_isatty (gdb_stdout
))
1403 lines_per_page
= UINT_MAX
;
1407 /* We handle SIGWINCH ourselves. */
1408 rl_catch_sigwinch
= 0;
1414 /* Return nonzero if filtered printing is initialized. */
1416 filtered_printing_initialized (void)
1418 return wrap_buffer
!= NULL
;
1421 set_batch_flag_and_restore_page_info::set_batch_flag_and_restore_page_info ()
1422 : m_save_lines_per_page (lines_per_page
),
1423 m_save_chars_per_line (chars_per_line
),
1424 m_save_batch_flag (batch_flag
)
1430 set_batch_flag_and_restore_page_info::~set_batch_flag_and_restore_page_info ()
1432 batch_flag
= m_save_batch_flag
;
1433 chars_per_line
= m_save_chars_per_line
;
1434 lines_per_page
= m_save_lines_per_page
;
1440 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1443 set_screen_size (void)
1445 int rows
= lines_per_page
;
1446 int cols
= chars_per_line
;
1454 /* Update Readline's idea of the terminal size. */
1455 rl_set_screen_size (rows
, cols
);
1458 /* Reinitialize WRAP_BUFFER according to the current value of
1464 if (chars_per_line
== 0)
1469 wrap_buffer
= (char *) xmalloc (chars_per_line
+ 2);
1470 wrap_buffer
[0] = '\0';
1473 wrap_buffer
= (char *) xrealloc (wrap_buffer
, chars_per_line
+ 2);
1474 wrap_pointer
= wrap_buffer
; /* Start it at the beginning. */
1478 set_width_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1485 set_height_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1493 set_screen_width_and_height (int width
, int height
)
1495 lines_per_page
= height
;
1496 chars_per_line
= width
;
1502 /* Wait, so the user can read what's on the screen. Prompt the user
1503 to continue by pressing RETURN. 'q' is also provided because
1504 telling users what to do in the prompt is more user-friendly than
1505 expecting them to think of Ctrl-C/SIGINT. */
1508 prompt_for_continue (void)
1511 char cont_prompt
[120];
1512 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
1513 /* Used to add duration we waited for user to respond to
1514 prompt_for_continue_wait_time. */
1515 using namespace std::chrono
;
1516 steady_clock::time_point prompt_started
= steady_clock::now ();
1518 if (annotation_level
> 1)
1519 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1521 strcpy (cont_prompt
,
1522 "---Type <return> to continue, or q <return> to quit---");
1523 if (annotation_level
> 1)
1524 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1526 /* We must do this *before* we call gdb_readline_wrapper, else it
1527 will eventually call us -- thinking that we're trying to print
1528 beyond the end of the screen. */
1529 reinitialize_more_filter ();
1531 scoped_input_handler prepare_input
;
1533 /* Call gdb_readline_wrapper, not readline, in order to keep an
1534 event loop running. */
1535 ignore
= gdb_readline_wrapper (cont_prompt
);
1536 make_cleanup (xfree
, ignore
);
1538 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1539 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1541 if (annotation_level
> 1)
1542 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1548 while (*p
== ' ' || *p
== '\t')
1551 /* Do not call quit here; there is no possibility of SIGINT. */
1552 throw_quit ("Quit");
1555 /* Now we have to do this again, so that GDB will know that it doesn't
1556 need to save the ---Type <return>--- line at the top of the screen. */
1557 reinitialize_more_filter ();
1559 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1561 do_cleanups (old_chain
);
1564 /* Initialize timer to keep track of how long we waited for the user. */
1567 reset_prompt_for_continue_wait_time (void)
1569 using namespace std::chrono
;
1571 prompt_for_continue_wait_time
= steady_clock::duration::zero ();
1574 /* Fetch the cumulative time spent in prompt_for_continue. */
1576 std::chrono::steady_clock::duration
1577 get_prompt_for_continue_wait_time ()
1579 return prompt_for_continue_wait_time
;
1582 /* Reinitialize filter; ie. tell it to reset to original values. */
1585 reinitialize_more_filter (void)
1591 /* Indicate that if the next sequence of characters overflows the line,
1592 a newline should be inserted here rather than when it hits the end.
1593 If INDENT is non-null, it is a string to be printed to indent the
1594 wrapped part on the next line. INDENT must remain accessible until
1595 the next call to wrap_here() or until a newline is printed through
1598 If the line is already overfull, we immediately print a newline and
1599 the indentation, and disable further wrapping.
1601 If we don't know the width of lines, but we know the page height,
1602 we must not wrap words, but should still keep track of newlines
1603 that were explicitly printed.
1605 INDENT should not contain tabs, as that will mess up the char count
1606 on the next line. FIXME.
1608 This routine is guaranteed to force out any output which has been
1609 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1610 used to force out output from the wrap_buffer. */
1613 wrap_here (const char *indent
)
1615 /* This should have been allocated, but be paranoid anyway. */
1617 internal_error (__FILE__
, __LINE__
,
1618 _("failed internal consistency check"));
1622 *wrap_pointer
= '\0';
1623 fputs_unfiltered (wrap_buffer
, gdb_stdout
);
1625 wrap_pointer
= wrap_buffer
;
1626 wrap_buffer
[0] = '\0';
1627 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1631 else if (chars_printed
>= chars_per_line
)
1633 puts_filtered ("\n");
1635 puts_filtered (indent
);
1640 wrap_column
= chars_printed
;
1644 wrap_indent
= indent
;
1648 /* Print input string to gdb_stdout, filtered, with wrap,
1649 arranging strings in columns of n chars. String can be
1650 right or left justified in the column. Never prints
1651 trailing spaces. String should never be longer than
1652 width. FIXME: this could be useful for the EXAMINE
1653 command, which currently doesn't tabulate very well. */
1656 puts_filtered_tabular (char *string
, int width
, int right
)
1662 gdb_assert (chars_per_line
> 0);
1663 if (chars_per_line
== UINT_MAX
)
1665 fputs_filtered (string
, gdb_stdout
);
1666 fputs_filtered ("\n", gdb_stdout
);
1670 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1671 fputs_filtered ("\n", gdb_stdout
);
1673 if (width
>= chars_per_line
)
1674 width
= chars_per_line
- 1;
1676 stringlen
= strlen (string
);
1678 if (chars_printed
> 0)
1679 spaces
= width
- (chars_printed
- 1) % width
- 1;
1681 spaces
+= width
- stringlen
;
1683 spacebuf
= (char *) alloca (spaces
+ 1);
1684 spacebuf
[spaces
] = '\0';
1686 spacebuf
[spaces
] = ' ';
1688 fputs_filtered (spacebuf
, gdb_stdout
);
1689 fputs_filtered (string
, gdb_stdout
);
1693 /* Ensure that whatever gets printed next, using the filtered output
1694 commands, starts at the beginning of the line. I.e. if there is
1695 any pending output for the current line, flush it and start a new
1696 line. Otherwise do nothing. */
1701 if (chars_printed
> 0)
1703 puts_filtered ("\n");
1708 /* Like fputs but if FILTER is true, pause after every screenful.
1710 Regardless of FILTER can wrap at points other than the final
1711 character of a line.
1713 Unlike fputs, fputs_maybe_filtered does not return a value.
1714 It is OK for LINEBUFFER to be NULL, in which case just don't print
1717 Note that a longjmp to top level may occur in this routine (only if
1718 FILTER is true) (since prompt_for_continue may do so) so this
1719 routine should not be called when cleanups are not in place. */
1722 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1725 const char *lineptr
;
1727 if (linebuffer
== 0)
1730 /* Don't do any filtering if it is disabled. */
1731 if (stream
!= gdb_stdout
1732 || !pagination_enabled
1734 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
1735 || top_level_interpreter () == NULL
1736 || interp_ui_out (top_level_interpreter ())->is_mi_like_p ())
1738 fputs_unfiltered (linebuffer
, stream
);
1742 /* Go through and output each character. Show line extension
1743 when this is necessary; prompt user for new page when this is
1746 lineptr
= linebuffer
;
1749 /* Possible new page. */
1750 if (filter
&& (lines_printed
>= lines_per_page
- 1))
1751 prompt_for_continue ();
1753 while (*lineptr
&& *lineptr
!= '\n')
1755 /* Print a single line. */
1756 if (*lineptr
== '\t')
1759 *wrap_pointer
++ = '\t';
1761 fputc_unfiltered ('\t', stream
);
1762 /* Shifting right by 3 produces the number of tab stops
1763 we have already passed, and then adding one and
1764 shifting left 3 advances to the next tab stop. */
1765 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
1771 *wrap_pointer
++ = *lineptr
;
1773 fputc_unfiltered (*lineptr
, stream
);
1778 if (chars_printed
>= chars_per_line
)
1780 unsigned int save_chars
= chars_printed
;
1784 /* If we aren't actually wrapping, don't output newline --
1785 if chars_per_line is right, we probably just overflowed
1786 anyway; if it's wrong, let us keep going. */
1788 fputc_unfiltered ('\n', stream
);
1790 /* Possible new page. */
1791 if (lines_printed
>= lines_per_page
- 1)
1792 prompt_for_continue ();
1794 /* Now output indentation and wrapped string. */
1797 fputs_unfiltered (wrap_indent
, stream
);
1798 *wrap_pointer
= '\0'; /* Null-terminate saved stuff, */
1799 fputs_unfiltered (wrap_buffer
, stream
); /* and eject it. */
1800 /* FIXME, this strlen is what prevents wrap_indent from
1801 containing tabs. However, if we recurse to print it
1802 and count its chars, we risk trouble if wrap_indent is
1803 longer than (the user settable) chars_per_line.
1804 Note also that this can set chars_printed > chars_per_line
1805 if we are printing a long string. */
1806 chars_printed
= strlen (wrap_indent
)
1807 + (save_chars
- wrap_column
);
1808 wrap_pointer
= wrap_buffer
; /* Reset buffer */
1809 wrap_buffer
[0] = '\0';
1810 wrap_column
= 0; /* And disable fancy wrap */
1815 if (*lineptr
== '\n')
1818 wrap_here ((char *) 0); /* Spit out chars, cancel
1821 fputc_unfiltered ('\n', stream
);
1828 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
1830 fputs_maybe_filtered (linebuffer
, stream
, 1);
1834 putchar_unfiltered (int c
)
1838 ui_file_write (gdb_stdout
, &buf
, 1);
1842 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
1843 May return nonlocally. */
1846 putchar_filtered (int c
)
1848 return fputc_filtered (c
, gdb_stdout
);
1852 fputc_unfiltered (int c
, struct ui_file
*stream
)
1856 ui_file_write (stream
, &buf
, 1);
1861 fputc_filtered (int c
, struct ui_file
*stream
)
1867 fputs_filtered (buf
, stream
);
1871 /* puts_debug is like fputs_unfiltered, except it prints special
1872 characters in printable fashion. */
1875 puts_debug (char *prefix
, char *string
, char *suffix
)
1879 /* Print prefix and suffix after each line. */
1880 static int new_line
= 1;
1881 static int return_p
= 0;
1882 static const char *prev_prefix
= "";
1883 static const char *prev_suffix
= "";
1885 if (*string
== '\n')
1888 /* If the prefix is changing, print the previous suffix, a new line,
1889 and the new prefix. */
1890 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
1892 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
1893 fputs_unfiltered ("\n", gdb_stdlog
);
1894 fputs_unfiltered (prefix
, gdb_stdlog
);
1897 /* Print prefix if we printed a newline during the previous call. */
1901 fputs_unfiltered (prefix
, gdb_stdlog
);
1904 prev_prefix
= prefix
;
1905 prev_suffix
= suffix
;
1907 /* Output characters in a printable format. */
1908 while ((ch
= *string
++) != '\0')
1914 fputc_unfiltered (ch
, gdb_stdlog
);
1917 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
1921 fputs_unfiltered ("\\\\", gdb_stdlog
);
1924 fputs_unfiltered ("\\b", gdb_stdlog
);
1927 fputs_unfiltered ("\\f", gdb_stdlog
);
1931 fputs_unfiltered ("\\n", gdb_stdlog
);
1934 fputs_unfiltered ("\\r", gdb_stdlog
);
1937 fputs_unfiltered ("\\t", gdb_stdlog
);
1940 fputs_unfiltered ("\\v", gdb_stdlog
);
1944 return_p
= ch
== '\r';
1947 /* Print suffix if we printed a newline. */
1950 fputs_unfiltered (suffix
, gdb_stdlog
);
1951 fputs_unfiltered ("\n", gdb_stdlog
);
1956 /* Print a variable number of ARGS using format FORMAT. If this
1957 information is going to put the amount written (since the last call
1958 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
1959 call prompt_for_continue to get the users permision to continue.
1961 Unlike fprintf, this function does not return a value.
1963 We implement three variants, vfprintf (takes a vararg list and stream),
1964 fprintf (takes a stream to write on), and printf (the usual).
1966 Note also that a longjmp to top level may occur in this routine
1967 (since prompt_for_continue may do so) so this routine should not be
1968 called when cleanups are not in place. */
1971 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
1972 va_list args
, int filter
)
1974 std::string linebuffer
= string_vprintf (format
, args
);
1975 fputs_maybe_filtered (linebuffer
.c_str (), stream
, filter
);
1980 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
1982 vfprintf_maybe_filtered (stream
, format
, args
, 1);
1986 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
1988 std::string linebuffer
= string_vprintf (format
, args
);
1989 if (debug_timestamp
&& stream
== gdb_stdlog
)
1991 using namespace std::chrono
;
1994 steady_clock::time_point now
= steady_clock::now ();
1995 seconds s
= duration_cast
<seconds
> (now
.time_since_epoch ());
1996 microseconds us
= duration_cast
<microseconds
> (now
.time_since_epoch () - s
);
1998 len
= linebuffer
.size ();
1999 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2001 std::string timestamp
= string_printf ("%ld.%06ld %s%s",
2004 linebuffer
.c_str (),
2005 need_nl
? "\n": "");
2006 fputs_unfiltered (timestamp
.c_str (), stream
);
2009 fputs_unfiltered (linebuffer
.c_str (), stream
);
2013 vprintf_filtered (const char *format
, va_list args
)
2015 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2019 vprintf_unfiltered (const char *format
, va_list args
)
2021 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2025 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2029 va_start (args
, format
);
2030 vfprintf_filtered (stream
, format
, args
);
2035 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2039 va_start (args
, format
);
2040 vfprintf_unfiltered (stream
, format
, args
);
2044 /* Like fprintf_filtered, but prints its result indented.
2045 Called as fprintfi_filtered (spaces, stream, format, ...); */
2048 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2053 va_start (args
, format
);
2054 print_spaces_filtered (spaces
, stream
);
2056 vfprintf_filtered (stream
, format
, args
);
2062 printf_filtered (const char *format
, ...)
2066 va_start (args
, format
);
2067 vfprintf_filtered (gdb_stdout
, format
, args
);
2073 printf_unfiltered (const char *format
, ...)
2077 va_start (args
, format
);
2078 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2082 /* Like printf_filtered, but prints it's result indented.
2083 Called as printfi_filtered (spaces, format, ...); */
2086 printfi_filtered (int spaces
, const char *format
, ...)
2090 va_start (args
, format
);
2091 print_spaces_filtered (spaces
, gdb_stdout
);
2092 vfprintf_filtered (gdb_stdout
, format
, args
);
2096 /* Easy -- but watch out!
2098 This routine is *not* a replacement for puts()! puts() appends a newline.
2099 This one doesn't, and had better not! */
2102 puts_filtered (const char *string
)
2104 fputs_filtered (string
, gdb_stdout
);
2108 puts_unfiltered (const char *string
)
2110 fputs_unfiltered (string
, gdb_stdout
);
2113 /* Return a pointer to N spaces and a null. The pointer is good
2114 until the next call to here. */
2119 static char *spaces
= 0;
2120 static int max_spaces
= -1;
2126 spaces
= (char *) xmalloc (n
+ 1);
2127 for (t
= spaces
+ n
; t
!= spaces
;)
2133 return spaces
+ max_spaces
- n
;
2136 /* Print N spaces. */
2138 print_spaces_filtered (int n
, struct ui_file
*stream
)
2140 fputs_filtered (n_spaces (n
), stream
);
2143 /* C++/ObjC demangler stuff. */
2145 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2146 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2147 If the name is not mangled, or the language for the name is unknown, or
2148 demangling is off, the name is printed in its "raw" form. */
2151 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2152 enum language lang
, int arg_mode
)
2158 /* If user wants to see raw output, no problem. */
2161 fputs_filtered (name
, stream
);
2165 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2166 fputs_filtered (demangled
? demangled
: name
, stream
);
2167 if (demangled
!= NULL
)
2175 /* Modes of operation for strncmp_iw_with_mode. */
2177 enum class strncmp_iw_mode
2179 /* Work like strncmp, while ignoring whitespace. */
2182 /* Like NORMAL, but also apply the strcmp_iw hack. I.e.,
2183 string1=="FOO(PARAMS)" matches string2=="FOO". */
2187 /* Helper for strncmp_iw and strcmp_iw. */
2190 strncmp_iw_with_mode (const char *string1
, const char *string2
,
2191 size_t string2_len
, strncmp_iw_mode mode
)
2193 const char *end_str2
= string2
+ string2_len
;
2197 while (isspace (*string1
))
2199 while (string2
< end_str2
&& isspace (*string2
))
2201 if (*string1
== '\0' || string2
== end_str2
)
2203 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2205 if (case_sensitivity
== case_sensitive_off
2206 && (tolower ((unsigned char) *string1
)
2207 != tolower ((unsigned char) *string2
)))
2214 if (string2
== end_str2
)
2216 if (mode
== strncmp_iw_mode::NORMAL
)
2219 return (*string1
!= '\0' && *string1
!= '(');
2228 strncmp_iw (const char *string1
, const char *string2
, size_t string2_len
)
2230 return strncmp_iw_with_mode (string1
, string2
, string2_len
,
2231 strncmp_iw_mode::NORMAL
);
2237 strcmp_iw (const char *string1
, const char *string2
)
2239 return strncmp_iw_with_mode (string1
, string2
, strlen (string2
),
2240 strncmp_iw_mode::MATCH_PARAMS
);
2243 /* This is like strcmp except that it ignores whitespace and treats
2244 '(' as the first non-NULL character in terms of ordering. Like
2245 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2246 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2247 according to that ordering.
2249 If a list is sorted according to this function and if you want to
2250 find names in the list that match some fixed NAME according to
2251 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2252 where this function would put NAME.
2254 This function must be neutral to the CASE_SENSITIVITY setting as the user
2255 may choose it during later lookup. Therefore this function always sorts
2256 primarily case-insensitively and secondarily case-sensitively.
2258 Here are some examples of why using strcmp to sort is a bad idea:
2262 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2263 we try to do a search for "foo<char*>", strcmp will locate this
2264 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2265 will start looking at strings beginning with "goo", and will never
2266 see the correct match of "foo<char *>".
2268 Parenthesis example:
2270 In practice, this is less like to be an issue, but I'll give it a
2271 shot. Let's assume that '$' is a legitimate character to occur in
2272 symbols. (Which may well even be the case on some systems.) Then
2273 say that the partial symbol table contains "foo$" and "foo(int)".
2274 strcmp will put them in this order, since '$' < '('. Now, if the
2275 user searches for "foo", then strcmp will sort "foo" before "foo$".
2276 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2277 "foo") is false, so it won't proceed to the actual match of
2278 "foo(int)" with "foo". */
2281 strcmp_iw_ordered (const char *string1
, const char *string2
)
2283 const char *saved_string1
= string1
, *saved_string2
= string2
;
2284 enum case_sensitivity case_pass
= case_sensitive_off
;
2288 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2289 Provide stub characters if we are already at the end of one of the
2291 char c1
= 'X', c2
= 'X';
2293 while (*string1
!= '\0' && *string2
!= '\0')
2295 while (isspace (*string1
))
2297 while (isspace (*string2
))
2302 case case_sensitive_off
:
2303 c1
= tolower ((unsigned char) *string1
);
2304 c2
= tolower ((unsigned char) *string2
);
2306 case case_sensitive_on
:
2314 if (*string1
!= '\0')
2323 /* Characters are non-equal unless they're both '\0'; we want to
2324 make sure we get the comparison right according to our
2325 comparison in the cases where one of them is '\0' or '('. */
2327 if (*string2
== '\0')
2332 if (*string2
== '\0')
2337 if (*string2
== '\0' || *string2
== '(')
2346 if (case_pass
== case_sensitive_on
)
2349 /* Otherwise the strings were equal in case insensitive way, make
2350 a more fine grained comparison in a case sensitive way. */
2352 case_pass
= case_sensitive_on
;
2353 string1
= saved_string1
;
2354 string2
= saved_string2
;
2358 /* A simple comparison function with opposite semantics to strcmp. */
2361 streq (const char *lhs
, const char *rhs
)
2363 return !strcmp (lhs
, rhs
);
2369 ** Answer whether string_to_compare is a full or partial match to
2370 ** template_string. The partial match must be in sequence starting
2374 subset_compare (const char *string_to_compare
, const char *template_string
)
2378 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
2379 && strlen (string_to_compare
) <= strlen (template_string
))
2381 (startswith (template_string
, string_to_compare
));
2388 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2389 struct cmd_list_element
*c
, const char *value
)
2391 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2397 initialize_utils (void)
2399 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
2400 Set number of characters where GDB should wrap lines of its output."), _("\
2401 Show number of characters where GDB should wrap lines of its output."), _("\
2402 This affects where GDB wraps its output to fit the screen width.\n\
2403 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2405 show_chars_per_line
,
2406 &setlist
, &showlist
);
2408 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
2409 Set number of lines in a page for GDB output pagination."), _("\
2410 Show number of lines in a page for GDB output pagination."), _("\
2411 This affects the number of lines after which GDB will pause\n\
2412 its output and ask you whether to continue.\n\
2413 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2415 show_lines_per_page
,
2416 &setlist
, &showlist
);
2418 add_setshow_boolean_cmd ("pagination", class_support
,
2419 &pagination_enabled
, _("\
2420 Set state of GDB output pagination."), _("\
2421 Show state of GDB output pagination."), _("\
2422 When pagination is ON, GDB pauses at end of each screenful of\n\
2423 its output and asks you whether to continue.\n\
2424 Turning pagination off is an alternative to \"set height unlimited\"."),
2426 show_pagination_enabled
,
2427 &setlist
, &showlist
);
2429 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
2430 &sevenbit_strings
, _("\
2431 Set printing of 8-bit characters in strings as \\nnn."), _("\
2432 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
2434 show_sevenbit_strings
,
2435 &setprintlist
, &showprintlist
);
2437 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
2438 &debug_timestamp
, _("\
2439 Set timestamping of debugging messages."), _("\
2440 Show timestamping of debugging messages."), _("\
2441 When set, debugging messages will be marked with seconds and microseconds."),
2443 show_debug_timestamp
,
2444 &setdebuglist
, &showdebuglist
);
2448 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2450 /* Truncate address to the size of a target address, avoiding shifts
2451 larger or equal than the width of a CORE_ADDR. The local
2452 variable ADDR_BIT stops the compiler reporting a shift overflow
2453 when it won't occur. */
2454 /* NOTE: This assumes that the significant address information is
2455 kept in the least significant bits of ADDR - the upper bits were
2456 either zero or sign extended. Should gdbarch_address_to_pointer or
2457 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2459 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2461 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2462 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2463 return hex_string (addr
);
2466 /* This function is described in "defs.h". */
2469 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2471 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2473 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2474 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2476 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2477 that returns the language localized string formatted to a width
2478 based on gdbarch_addr_bit. */
2480 return hex_string_custom (address
, 8);
2482 return hex_string_custom (address
, 16);
2485 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2488 core_addr_hash (const void *ap
)
2490 const CORE_ADDR
*addrp
= (const CORE_ADDR
*) ap
;
2495 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2498 core_addr_eq (const void *ap
, const void *bp
)
2500 const CORE_ADDR
*addr_ap
= (const CORE_ADDR
*) ap
;
2501 const CORE_ADDR
*addr_bp
= (const CORE_ADDR
*) bp
;
2503 return *addr_ap
== *addr_bp
;
2506 /* Convert a string back into a CORE_ADDR. */
2508 string_to_core_addr (const char *my_string
)
2512 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2514 /* Assume that it is in hex. */
2517 for (i
= 2; my_string
[i
] != '\0'; i
++)
2519 if (isdigit (my_string
[i
]))
2520 addr
= (my_string
[i
] - '0') + (addr
* 16);
2521 else if (isxdigit (my_string
[i
]))
2522 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2524 error (_("invalid hex \"%s\""), my_string
);
2529 /* Assume that it is in decimal. */
2532 for (i
= 0; my_string
[i
] != '\0'; i
++)
2534 if (isdigit (my_string
[i
]))
2535 addr
= (my_string
[i
] - '0') + (addr
* 10);
2537 error (_("invalid decimal \"%s\""), my_string
);
2544 gdb::unique_xmalloc_ptr
<char>
2545 gdb_realpath (const char *filename
)
2547 /* On most hosts, we rely on canonicalize_file_name to compute
2548 the FILENAME's realpath.
2550 But the situation is slightly more complex on Windows, due to some
2551 versions of GCC which were reported to generate paths where
2552 backlashes (the directory separator) were doubled. For instance:
2553 c:\\some\\double\\slashes\\dir
2555 c:\some\double\slashes\dir
2556 Those double-slashes were getting in the way when comparing paths,
2557 for instance when trying to insert a breakpoint as follow:
2558 (gdb) b c:/some/double/slashes/dir/foo.c:4
2559 No source file named c:/some/double/slashes/dir/foo.c:4.
2560 (gdb) b c:\some\double\slashes\dir\foo.c:4
2561 No source file named c:\some\double\slashes\dir\foo.c:4.
2562 To prevent this from happening, we need this function to always
2563 strip those extra backslashes. While canonicalize_file_name does
2564 perform this simplification, it only works when the path is valid.
2565 Since the simplification would be useful even if the path is not
2566 valid (one can always set a breakpoint on a file, even if the file
2567 does not exist locally), we rely instead on GetFullPathName to
2568 perform the canonicalization. */
2570 #if defined (_WIN32)
2573 DWORD len
= GetFullPathName (filename
, MAX_PATH
, buf
, NULL
);
2575 /* The file system is case-insensitive but case-preserving.
2576 So it is important we do not lowercase the path. Otherwise,
2577 we might not be able to display the original casing in a given
2579 if (len
> 0 && len
< MAX_PATH
)
2580 return gdb::unique_xmalloc_ptr
<char> (xstrdup (buf
));
2584 char *rp
= canonicalize_file_name (filename
);
2587 return gdb::unique_xmalloc_ptr
<char> (rp
);
2591 /* This system is a lost cause, just dup the buffer. */
2592 return gdb::unique_xmalloc_ptr
<char> (xstrdup (filename
));
2598 gdb_realpath_check_trailer (const char *input
, const char *trailer
)
2600 gdb::unique_xmalloc_ptr
<char> result
= gdb_realpath (input
);
2602 size_t len
= strlen (result
.get ());
2603 size_t trail_len
= strlen (trailer
);
2605 SELF_CHECK (len
>= trail_len
2606 && strcmp (result
.get () + len
- trail_len
, trailer
) == 0);
2610 gdb_realpath_tests ()
2612 /* A file which contains a directory prefix. */
2613 gdb_realpath_check_trailer ("./xfullpath.exp", "/xfullpath.exp");
2614 /* A file which contains a directory prefix. */
2615 gdb_realpath_check_trailer ("../../defs.h", "/defs.h");
2616 /* A one-character filename. */
2617 gdb_realpath_check_trailer ("./a", "/a");
2618 /* A file in the root directory. */
2619 gdb_realpath_check_trailer ("/root_file_which_should_exist",
2620 "/root_file_which_should_exist");
2621 /* A file which does not have a directory prefix. */
2622 gdb_realpath_check_trailer ("xfullpath.exp", "xfullpath.exp");
2623 /* A one-char filename without any directory prefix. */
2624 gdb_realpath_check_trailer ("a", "a");
2625 /* An empty filename. */
2626 gdb_realpath_check_trailer ("", "");
2629 #endif /* GDB_SELF_TEST */
2631 /* Return a copy of FILENAME, with its directory prefix canonicalized
2634 gdb::unique_xmalloc_ptr
<char>
2635 gdb_realpath_keepfile (const char *filename
)
2637 const char *base_name
= lbasename (filename
);
2641 /* Extract the basename of filename, and return immediately
2642 a copy of filename if it does not contain any directory prefix. */
2643 if (base_name
== filename
)
2644 return gdb::unique_xmalloc_ptr
<char> (xstrdup (filename
));
2646 dir_name
= (char *) alloca ((size_t) (base_name
- filename
+ 2));
2647 /* Allocate enough space to store the dir_name + plus one extra
2648 character sometimes needed under Windows (see below), and
2649 then the closing \000 character. */
2650 strncpy (dir_name
, filename
, base_name
- filename
);
2651 dir_name
[base_name
- filename
] = '\000';
2653 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
2654 /* We need to be careful when filename is of the form 'd:foo', which
2655 is equivalent of d:./foo, which is totally different from d:/foo. */
2656 if (strlen (dir_name
) == 2 && isalpha (dir_name
[0]) && dir_name
[1] == ':')
2659 dir_name
[3] = '\000';
2663 /* Canonicalize the directory prefix, and build the resulting
2664 filename. If the dirname realpath already contains an ending
2665 directory separator, avoid doubling it. */
2666 gdb::unique_xmalloc_ptr
<char> path_storage
= gdb_realpath (dir_name
);
2667 const char *real_path
= path_storage
.get ();
2668 if (IS_DIR_SEPARATOR (real_path
[strlen (real_path
) - 1]))
2669 result
= concat (real_path
, base_name
, (char *) NULL
);
2671 result
= concat (real_path
, SLASH_STRING
, base_name
, (char *) NULL
);
2673 return gdb::unique_xmalloc_ptr
<char> (result
);
2676 /* Return PATH in absolute form, performing tilde-expansion if necessary.
2677 PATH cannot be NULL or the empty string.
2678 This does not resolve symlinks however, use gdb_realpath for that. */
2680 gdb::unique_xmalloc_ptr
<char>
2681 gdb_abspath (const char *path
)
2683 gdb_assert (path
!= NULL
&& path
[0] != '\0');
2686 return gdb::unique_xmalloc_ptr
<char> (tilde_expand (path
));
2688 if (IS_ABSOLUTE_PATH (path
))
2689 return gdb::unique_xmalloc_ptr
<char> (xstrdup (path
));
2691 /* Beware the // my son, the Emacs barfs, the botch that catch... */
2692 return gdb::unique_xmalloc_ptr
<char>
2693 (concat (current_directory
,
2694 IS_DIR_SEPARATOR (current_directory
[strlen (current_directory
) - 1])
2695 ? "" : SLASH_STRING
,
2696 path
, (char *) NULL
));
2700 align_up (ULONGEST v
, int n
)
2702 /* Check that N is really a power of two. */
2703 gdb_assert (n
&& (n
& (n
-1)) == 0);
2704 return (v
+ n
- 1) & -n
;
2708 align_down (ULONGEST v
, int n
)
2710 /* Check that N is really a power of two. */
2711 gdb_assert (n
&& (n
& (n
-1)) == 0);
2715 /* Allocation function for the libiberty hash table which uses an
2716 obstack. The obstack is passed as DATA. */
2719 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
2721 size_t total
= size
* count
;
2722 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
2724 memset (ptr
, 0, total
);
2728 /* Trivial deallocation function for the libiberty splay tree and hash
2729 table - don't deallocate anything. Rely on later deletion of the
2730 obstack. DATA will be the obstack, although it is not needed
2734 dummy_obstack_deallocate (void *object
, void *data
)
2739 /* Simple, portable version of dirname that does not modify its
2743 ldirname (const char *filename
)
2745 std::string dirname
;
2746 const char *base
= lbasename (filename
);
2748 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
2751 if (base
== filename
)
2754 dirname
= std::string (filename
, base
- filename
);
2756 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
2757 create "d:./bar" later instead of the (different) "d:/bar". */
2758 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
2759 && !IS_DIR_SEPARATOR (filename
[0]))
2760 dirname
[base
++ - filename
] = '.';
2768 gdb_argv::reset (const char *s
)
2770 char **argv
= buildargv (s
);
2772 if (s
!= NULL
&& argv
== NULL
)
2780 compare_positive_ints (const void *ap
, const void *bp
)
2782 /* Because we know we're comparing two ints which are positive,
2783 there's no danger of overflow here. */
2784 return * (int *) ap
- * (int *) bp
;
2787 /* String compare function for qsort. */
2790 compare_strings (const void *arg1
, const void *arg2
)
2792 const char **s1
= (const char **) arg1
;
2793 const char **s2
= (const char **) arg2
;
2795 return strcmp (*s1
, *s2
);
2798 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
2799 #define AMBIGUOUS_MESS2 \
2800 ".\nUse \"set gnutarget format-name\" to specify the format."
2803 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
2809 /* Check if errmsg just need simple return. */
2810 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
2811 return bfd_errmsg (error_tag
);
2813 ret_len
= strlen (bfd_errmsg (error_tag
)) + strlen (AMBIGUOUS_MESS1
)
2814 + strlen (AMBIGUOUS_MESS2
);
2815 for (p
= matching
; *p
; p
++)
2816 ret_len
+= strlen (*p
) + 1;
2817 ret
= (char *) xmalloc (ret_len
+ 1);
2819 make_cleanup (xfree
, ret
);
2821 strcpy (retp
, bfd_errmsg (error_tag
));
2822 retp
+= strlen (retp
);
2824 strcpy (retp
, AMBIGUOUS_MESS1
);
2825 retp
+= strlen (retp
);
2827 for (p
= matching
; *p
; p
++)
2829 sprintf (retp
, " %s", *p
);
2830 retp
+= strlen (retp
);
2834 strcpy (retp
, AMBIGUOUS_MESS2
);
2839 /* Return ARGS parsed as a valid pid, or throw an error. */
2842 parse_pid_to_attach (const char *args
)
2848 error_no_arg (_("process-id to attach"));
2850 dummy
= (char *) args
;
2851 pid
= strtoul (args
, &dummy
, 0);
2852 /* Some targets don't set errno on errors, grrr! */
2853 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
2854 error (_("Illegal process-id: %s."), args
);
2859 /* Helper for make_bpstat_clear_actions_cleanup. */
2862 do_bpstat_clear_actions_cleanup (void *unused
)
2864 bpstat_clear_actions ();
2867 /* Call bpstat_clear_actions for the case an exception is throw. You should
2868 discard_cleanups if no exception is caught. */
2871 make_bpstat_clear_actions_cleanup (void)
2873 return make_cleanup (do_bpstat_clear_actions_cleanup
, NULL
);
2877 /* Helper for make_cleanup_free_char_ptr_vec. */
2880 do_free_char_ptr_vec (void *arg
)
2882 VEC (char_ptr
) *char_ptr_vec
= (VEC (char_ptr
) *) arg
;
2884 free_char_ptr_vec (char_ptr_vec
);
2887 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
2888 final VEC_free for CHAR_PTR_VEC itself.
2890 You must not modify CHAR_PTR_VEC after this cleanup registration as the
2891 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
2892 this function does not (cannot) clear the pointer. */
2895 make_cleanup_free_char_ptr_vec (VEC (char_ptr
) *char_ptr_vec
)
2897 return make_cleanup (do_free_char_ptr_vec
, char_ptr_vec
);
2900 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
2901 must come from xrealloc-compatible allocator and it may be updated. FROM
2902 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
2903 located at the start or end of *STRINGP. */
2906 substitute_path_component (char **stringp
, const char *from
, const char *to
)
2908 char *string
= *stringp
, *s
;
2909 const size_t from_len
= strlen (from
);
2910 const size_t to_len
= strlen (to
);
2914 s
= strstr (s
, from
);
2918 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
2919 || s
[-1] == DIRNAME_SEPARATOR
)
2920 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
2921 || s
[from_len
] == DIRNAME_SEPARATOR
))
2926 = (char *) xrealloc (string
, (strlen (string
) + to_len
+ 1));
2928 /* Relocate the current S pointer. */
2929 s
= s
- string
+ string_new
;
2930 string
= string_new
;
2932 /* Replace from by to. */
2933 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
2934 memcpy (s
, to
, to_len
);
2949 /* SIGALRM handler for waitpid_with_timeout. */
2952 sigalrm_handler (int signo
)
2954 /* Nothing to do. */
2959 /* Wrapper to wait for child PID to die with TIMEOUT.
2960 TIMEOUT is the time to stop waiting in seconds.
2961 If TIMEOUT is zero, pass WNOHANG to waitpid.
2962 Returns PID if it was successfully waited for, otherwise -1.
2964 Timeouts are currently implemented with alarm and SIGALRM.
2965 If the host does not support them, this waits "forever".
2966 It would be odd though for a host to have waitpid and not SIGALRM. */
2969 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
2971 pid_t waitpid_result
;
2973 gdb_assert (pid
> 0);
2974 gdb_assert (timeout
>= 0);
2979 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
2980 struct sigaction sa
, old_sa
;
2982 sa
.sa_handler
= sigalrm_handler
;
2983 sigemptyset (&sa
.sa_mask
);
2985 sigaction (SIGALRM
, &sa
, &old_sa
);
2989 ofunc
= signal (SIGALRM
, sigalrm_handler
);
2995 waitpid_result
= waitpid (pid
, status
, 0);
2999 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3000 sigaction (SIGALRM
, &old_sa
, NULL
);
3002 signal (SIGALRM
, ofunc
);
3007 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3009 if (waitpid_result
== pid
)
3015 #endif /* HAVE_WAITPID */
3017 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3018 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3020 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3021 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3024 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3026 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3028 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3029 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3031 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3033 char *pattern_slash
, *string_slash
;
3035 /* Replace '\' by '/' in both strings. */
3037 pattern_slash
= (char *) alloca (strlen (pattern
) + 1);
3038 strcpy (pattern_slash
, pattern
);
3039 pattern
= pattern_slash
;
3040 for (; *pattern_slash
!= 0; pattern_slash
++)
3041 if (IS_DIR_SEPARATOR (*pattern_slash
))
3042 *pattern_slash
= '/';
3044 string_slash
= (char *) alloca (strlen (string
) + 1);
3045 strcpy (string_slash
, string
);
3046 string
= string_slash
;
3047 for (; *string_slash
!= 0; string_slash
++)
3048 if (IS_DIR_SEPARATOR (*string_slash
))
3049 *string_slash
= '/';
3051 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3053 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3054 flags
|= FNM_CASEFOLD
;
3055 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3057 return fnmatch (pattern
, string
, flags
);
3060 /* Return the number of path elements in PATH.
3068 count_path_elements (const char *path
)
3071 const char *p
= path
;
3073 if (HAS_DRIVE_SPEC (p
))
3075 p
= STRIP_DRIVE_SPEC (p
);
3081 if (IS_DIR_SEPARATOR (*p
))
3086 /* Backup one if last character is /, unless it's the only one. */
3087 if (p
> path
+ 1 && IS_DIR_SEPARATOR (p
[-1]))
3090 /* Add one for the file name, if present. */
3091 if (p
> path
&& !IS_DIR_SEPARATOR (p
[-1]))
3097 /* Remove N leading path elements from PATH.
3098 N must be non-negative.
3099 If PATH has more than N path elements then return NULL.
3100 If PATH has exactly N path elements then return "".
3101 See count_path_elements for a description of how we do the counting. */
3104 strip_leading_path_elements (const char *path
, int n
)
3107 const char *p
= path
;
3109 gdb_assert (n
>= 0);
3114 if (HAS_DRIVE_SPEC (p
))
3116 p
= STRIP_DRIVE_SPEC (p
);
3122 while (*p
!= '\0' && !IS_DIR_SEPARATOR (*p
))
3138 _initialize_utils (void)
3140 add_internal_problem_command (&internal_error_problem
);
3141 add_internal_problem_command (&internal_warning_problem
);
3142 add_internal_problem_command (&demangler_warning_problem
);
3145 selftests::register_test ("gdb_realpath", gdb_realpath_tests
);