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 /* This function is useful for cleanups.
192 old_chain = make_cleanup (free_current_contents, &foo);
194 to arrange to free the object thus allocated. */
197 free_current_contents (void *ptr
)
199 void **location
= (void **) ptr
;
201 if (location
== NULL
)
202 internal_error (__FILE__
, __LINE__
,
203 _("free_current_contents: NULL pointer"));
204 if (*location
!= NULL
)
213 /* Print a warning message. The first argument STRING is the warning
214 message, used as an fprintf format string, the second is the
215 va_list of arguments for that string. A warning is unfiltered (not
216 paginated) so that the user does not need to page through each
217 screen full of warnings when there are lots of them. */
220 vwarning (const char *string
, va_list args
)
222 if (deprecated_warning_hook
)
223 (*deprecated_warning_hook
) (string
, args
);
226 gdb::optional
<target_terminal::scoped_restore_terminal_state
> term_state
;
227 if (target_supports_terminal_ours ())
229 term_state
.emplace ();
230 target_terminal::ours_for_output ();
232 if (filtered_printing_initialized ())
233 wrap_here (""); /* Force out any buffered output. */
234 gdb_flush (gdb_stdout
);
235 if (warning_pre_print
)
236 fputs_unfiltered (warning_pre_print
, gdb_stderr
);
237 vfprintf_unfiltered (gdb_stderr
, string
, args
);
238 fprintf_unfiltered (gdb_stderr
, "\n");
242 /* Print an error message and return to command level.
243 The first argument STRING is the error message, used as a fprintf string,
244 and the remaining args are passed as arguments to it. */
247 verror (const char *string
, va_list args
)
249 throw_verror (GENERIC_ERROR
, string
, args
);
253 error_stream (const string_file
&stream
)
255 error (("%s"), stream
.c_str ());
258 /* Emit a message and abort. */
260 static void ATTRIBUTE_NORETURN
261 abort_with_message (const char *msg
)
263 if (current_ui
== NULL
)
266 fputs_unfiltered (msg
, gdb_stderr
);
268 abort (); /* NOTE: GDB has only three calls to abort(). */
271 /* Dump core trying to increase the core soft limit to hard limit first. */
276 #ifdef HAVE_SETRLIMIT
277 struct rlimit rlim
= { RLIM_INFINITY
, RLIM_INFINITY
};
279 setrlimit (RLIMIT_CORE
, &rlim
);
280 #endif /* HAVE_SETRLIMIT */
282 abort (); /* NOTE: GDB has only three calls to abort(). */
285 /* Check whether GDB will be able to dump core using the dump_core
286 function. Returns zero if GDB cannot or should not dump core.
287 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
288 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
291 can_dump_core (enum resource_limit_kind limit_kind
)
293 #ifdef HAVE_GETRLIMIT
296 /* Be quiet and assume we can dump if an error is returned. */
297 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
303 if (rlim
.rlim_cur
== 0)
307 if (rlim
.rlim_max
== 0)
310 #endif /* HAVE_GETRLIMIT */
315 /* Print a warning that we cannot dump core. */
318 warn_cant_dump_core (const char *reason
)
320 fprintf_unfiltered (gdb_stderr
,
321 _("%s\nUnable to dump core, use `ulimit -c"
322 " unlimited' before executing GDB next time.\n"),
326 /* Check whether GDB will be able to dump core using the dump_core
327 function, and print a warning if we cannot. */
330 can_dump_core_warn (enum resource_limit_kind limit_kind
,
333 int core_dump_allowed
= can_dump_core (limit_kind
);
335 if (!core_dump_allowed
)
336 warn_cant_dump_core (reason
);
338 return core_dump_allowed
;
341 /* Allow the user to configure the debugger behavior with respect to
342 what to do when an internal problem is detected. */
344 const char internal_problem_ask
[] = "ask";
345 const char internal_problem_yes
[] = "yes";
346 const char internal_problem_no
[] = "no";
347 static const char *const internal_problem_modes
[] =
349 internal_problem_ask
,
350 internal_problem_yes
,
355 /* Print a message reporting an internal error/warning. Ask the user
356 if they want to continue, dump core, or just exit. Return
357 something to indicate a quit. */
359 struct internal_problem
362 int user_settable_should_quit
;
363 const char *should_quit
;
364 int user_settable_should_dump_core
;
365 const char *should_dump_core
;
368 /* Report a problem, internal to GDB, to the user. Once the problem
369 has been reported, and assuming GDB didn't quit, the caller can
370 either allow execution to resume or throw an error. */
372 static void ATTRIBUTE_PRINTF (4, 0)
373 internal_vproblem (struct internal_problem
*problem
,
374 const char *file
, int line
, const char *fmt
, va_list ap
)
381 /* Don't allow infinite error/warning recursion. */
383 static char msg
[] = "Recursive internal problem.\n";
392 abort_with_message (msg
);
395 /* Newer GLIBC versions put the warn_unused_result attribute
396 on write, but this is one of those rare cases where
397 ignoring the return value is correct. Casting to (void)
398 does not fix this problem. This is the solution suggested
399 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
400 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
401 abort (); /* NOTE: GDB has only three calls to abort(). */
406 /* Create a string containing the full error/warning message. Need
407 to call query with this full string, as otherwize the reason
408 (error/warning) and question become separated. Format using a
409 style similar to a compiler error message. Include extra detail
410 so that the user knows that they are living on the edge. */
412 std::string msg
= string_vprintf (fmt
, ap
);
413 reason
= string_printf ("%s:%d: %s: %s\n"
414 "A problem internal to GDB has been detected,\n"
415 "further debugging may prove unreliable.",
416 file
, line
, problem
->name
, msg
.c_str ());
419 /* Fall back to abort_with_message if gdb_stderr is not set up. */
420 if (current_ui
== NULL
)
422 fputs (reason
.c_str (), stderr
);
423 abort_with_message ("\n");
426 /* Try to get the message out and at the start of a new line. */
427 gdb::optional
<target_terminal::scoped_restore_terminal_state
> term_state
;
428 if (target_supports_terminal_ours ())
430 term_state
.emplace ();
431 target_terminal::ours_for_output ();
433 if (filtered_printing_initialized ())
436 /* Emit the message unless query will emit it below. */
437 if (problem
->should_quit
!= internal_problem_ask
439 || !filtered_printing_initialized ())
440 fprintf_unfiltered (gdb_stderr
, "%s\n", reason
.c_str ());
442 if (problem
->should_quit
== internal_problem_ask
)
444 /* Default (yes/batch case) is to quit GDB. When in batch mode
445 this lessens the likelihood of GDB going into an infinite
447 if (!confirm
|| !filtered_printing_initialized ())
450 quit_p
= query (_("%s\nQuit this debugging session? "),
453 else if (problem
->should_quit
== internal_problem_yes
)
455 else if (problem
->should_quit
== internal_problem_no
)
458 internal_error (__FILE__
, __LINE__
, _("bad switch"));
460 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr
);
461 if (REPORT_BUGS_TO
[0])
462 fprintf_unfiltered (gdb_stderr
, _(" For instructions, see:\n%s."),
464 fputs_unfiltered ("\n\n", gdb_stderr
);
466 if (problem
->should_dump_core
== internal_problem_ask
)
468 if (!can_dump_core_warn (LIMIT_MAX
, reason
.c_str ()))
470 else if (!filtered_printing_initialized ())
474 /* Default (yes/batch case) is to dump core. This leaves a GDB
475 `dropping' so that it is easier to see that something went
477 dump_core_p
= query (_("%s\nCreate a core file of GDB? "),
481 else if (problem
->should_dump_core
== internal_problem_yes
)
482 dump_core_p
= can_dump_core_warn (LIMIT_MAX
, reason
.c_str ());
483 else if (problem
->should_dump_core
== internal_problem_no
)
486 internal_error (__FILE__
, __LINE__
, _("bad switch"));
499 #ifdef HAVE_WORKING_FORK
509 static struct internal_problem internal_error_problem
= {
510 "internal-error", 1, internal_problem_ask
, 1, internal_problem_ask
514 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
516 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
517 throw_quit (_("Command aborted."));
520 static struct internal_problem internal_warning_problem
= {
521 "internal-warning", 1, internal_problem_ask
, 1, internal_problem_ask
525 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
527 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
530 static struct internal_problem demangler_warning_problem
= {
531 "demangler-warning", 1, internal_problem_ask
, 0, internal_problem_no
535 demangler_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
537 internal_vproblem (&demangler_warning_problem
, file
, line
, fmt
, ap
);
541 demangler_warning (const char *file
, int line
, const char *string
, ...)
545 va_start (ap
, string
);
546 demangler_vwarning (file
, line
, string
, ap
);
550 /* Dummy functions to keep add_prefix_cmd happy. */
553 set_internal_problem_cmd (const char *args
, int from_tty
)
558 show_internal_problem_cmd (const char *args
, int from_tty
)
562 /* When GDB reports an internal problem (error or warning) it gives
563 the user the opportunity to quit GDB and/or create a core file of
564 the current debug session. This function registers a few commands
565 that make it possible to specify that GDB should always or never
566 quit or create a core file, without asking. The commands look
569 maint set PROBLEM-NAME quit ask|yes|no
570 maint show PROBLEM-NAME quit
571 maint set PROBLEM-NAME corefile ask|yes|no
572 maint show PROBLEM-NAME corefile
574 Where PROBLEM-NAME is currently "internal-error" or
575 "internal-warning". */
578 add_internal_problem_command (struct internal_problem
*problem
)
580 struct cmd_list_element
**set_cmd_list
;
581 struct cmd_list_element
**show_cmd_list
;
585 set_cmd_list
= XNEW (struct cmd_list_element
*);
586 show_cmd_list
= XNEW (struct cmd_list_element
*);
587 *set_cmd_list
= NULL
;
588 *show_cmd_list
= NULL
;
590 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
593 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
596 add_prefix_cmd (problem
->name
,
597 class_maintenance
, set_internal_problem_cmd
, set_doc
,
599 concat ("maintenance set ", problem
->name
, " ",
601 0/*allow-unknown*/, &maintenance_set_cmdlist
);
603 add_prefix_cmd (problem
->name
,
604 class_maintenance
, show_internal_problem_cmd
, show_doc
,
606 concat ("maintenance show ", problem
->name
, " ",
608 0/*allow-unknown*/, &maintenance_show_cmdlist
);
610 if (problem
->user_settable_should_quit
)
612 set_doc
= xstrprintf (_("Set whether GDB should quit "
613 "when an %s is detected"),
615 show_doc
= xstrprintf (_("Show whether GDB will quit "
616 "when an %s is detected"),
618 add_setshow_enum_cmd ("quit", class_maintenance
,
619 internal_problem_modes
,
620 &problem
->should_quit
,
633 if (problem
->user_settable_should_dump_core
)
635 set_doc
= xstrprintf (_("Set whether GDB should create a core "
636 "file of GDB when %s is detected"),
638 show_doc
= xstrprintf (_("Show whether GDB will create a core "
639 "file of GDB when %s is detected"),
641 add_setshow_enum_cmd ("corefile", class_maintenance
,
642 internal_problem_modes
,
643 &problem
->should_dump_core
,
657 /* Return a newly allocated string, containing the PREFIX followed
658 by the system error message for errno (separated by a colon). */
661 perror_string (const char *prefix
)
665 err
= safe_strerror (errno
);
666 return std::string (prefix
) + ": " + err
;
669 /* Print the system error message for errno, and also mention STRING
670 as the file name for which the error was encountered. Use ERRCODE
671 for the thrown exception. Then return to command level. */
674 throw_perror_with_name (enum errors errcode
, const char *string
)
676 std::string combined
= perror_string (string
);
678 /* I understand setting these is a matter of taste. Still, some people
679 may clear errno but not know about bfd_error. Doing this here is not
681 bfd_set_error (bfd_error_no_error
);
684 throw_error (errcode
, _("%s."), combined
.c_str ());
687 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
690 perror_with_name (const char *string
)
692 throw_perror_with_name (GENERIC_ERROR
, string
);
695 /* Same as perror_with_name except that it prints a warning instead
696 of throwing an error. */
699 perror_warning_with_name (const char *string
)
701 std::string combined
= perror_string (string
);
702 warning (_("%s"), combined
.c_str ());
705 /* Print the system error message for ERRCODE, and also mention STRING
706 as the file name for which the error was encountered. */
709 print_sys_errmsg (const char *string
, int errcode
)
714 err
= safe_strerror (errcode
);
715 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
716 strcpy (combined
, string
);
717 strcat (combined
, ": ");
718 strcat (combined
, err
);
720 /* We want anything which was printed on stdout to come out first, before
722 gdb_flush (gdb_stdout
);
723 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
726 /* Control C eventually causes this to be called, at a convenient time. */
731 struct ui
*ui
= current_ui
;
733 if (sync_quit_force_run
)
735 sync_quit_force_run
= 0;
736 quit_force (NULL
, 0);
740 /* No steenking SIGINT will ever be coming our way when the
741 program is resumed. Don't lie. */
745 /* If there is no terminal switching for this target, then we can't
746 possibly get screwed by the lack of job control. */
747 || !target_supports_terminal_ours ())
750 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
759 if (sync_quit_force_run
)
764 if (deprecated_interactive_hook
)
765 deprecated_interactive_hook ();
769 /* Called when a memory allocation fails, with the number of bytes of
770 memory requested in SIZE. */
773 malloc_failure (long size
)
777 internal_error (__FILE__
, __LINE__
,
778 _("virtual memory exhausted: can't allocate %ld bytes."),
783 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
787 /* My replacement for the read system call.
788 Used like `read' but keeps going if `read' returns too soon. */
791 myread (int desc
, char *addr
, int len
)
798 val
= read (desc
, addr
, len
);
810 print_spaces (int n
, struct ui_file
*file
)
812 fputs_unfiltered (n_spaces (n
), file
);
815 /* Print a host address. */
818 gdb_print_host_address_1 (const void *addr
, struct ui_file
*stream
)
820 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
826 make_hex_string (const gdb_byte
*data
, size_t length
)
828 char *result
= (char *) xmalloc (length
* 2 + 1);
833 for (i
= 0; i
< length
; ++i
)
834 p
+= xsnprintf (p
, 3, "%02x", data
[i
]);
841 /* An RAII class that sets up to handle input and then tears down
842 during destruction. */
844 class scoped_input_handler
848 scoped_input_handler ()
849 : m_quit_handler (&quit_handler
, default_quit_handler
),
852 target_terminal::ours ();
853 ui_register_input_event_handler (current_ui
);
854 if (current_ui
->prompt_state
== PROMPT_BLOCKED
)
858 ~scoped_input_handler ()
861 ui_unregister_input_event_handler (m_ui
);
864 DISABLE_COPY_AND_ASSIGN (scoped_input_handler
);
868 /* Save and restore the terminal state. */
869 target_terminal::scoped_restore_terminal_state m_term_state
;
871 /* Save and restore the quit handler. */
872 scoped_restore_tmpl
<quit_handler_ftype
*> m_quit_handler
;
874 /* The saved UI, if non-NULL. */
880 /* This function supports the query, nquery, and yquery functions.
881 Ask user a y-or-n question and return 0 if answer is no, 1 if
882 answer is yes, or default the answer to the specified default
883 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
884 default answer, or '\0' for no default.
885 CTLSTR is the control string and should end in "? ". It should
886 not say how to answer, because we do that.
887 ARGS are the arguments passed along with the CTLSTR argument to
890 static int ATTRIBUTE_PRINTF (1, 0)
891 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
896 char def_answer
, not_def_answer
;
897 const char *y_string
, *n_string
;
899 /* Set up according to which answer is the default. */
904 not_def_answer
= 'N';
908 else if (defchar
== 'y')
912 not_def_answer
= 'N';
920 not_def_answer
= 'Y';
925 /* Automatically answer the default value if the user did not want
926 prompts or the command was issued with the server prefix. */
927 if (!confirm
|| server_command
)
930 /* If input isn't coming from the user directly, just say what
931 question we're asking, and then answer the default automatically. This
932 way, important error messages don't get lost when talking to GDB
934 if (current_ui
->instream
!= current_ui
->stdin_stream
935 || !input_interactive_p (current_ui
)
936 /* Restrict queries to the main UI. */
937 || current_ui
!= main_ui
)
939 target_terminal::scoped_restore_terminal_state term_state
;
940 target_terminal::ours_for_output ();
942 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
944 printf_filtered (_("(%s or %s) [answered %c; "
945 "input not from terminal]\n"),
946 y_string
, n_string
, def_answer
);
947 gdb_flush (gdb_stdout
);
952 if (deprecated_query_hook
)
954 target_terminal::scoped_restore_terminal_state term_state
;
955 return deprecated_query_hook (ctlstr
, args
);
958 /* Format the question outside of the loop, to avoid reusing args. */
959 std::string question
= string_vprintf (ctlstr
, args
);
961 = string_printf (_("%s%s(%s or %s) %s"),
962 annotation_level
> 1 ? "\n\032\032pre-query\n" : "",
963 question
.c_str (), y_string
, n_string
,
964 annotation_level
> 1 ? "\n\032\032query\n" : "");
966 /* Used to add duration we waited for user to respond to
967 prompt_for_continue_wait_time. */
968 using namespace std::chrono
;
969 steady_clock::time_point prompt_started
= steady_clock::now ();
971 scoped_input_handler prepare_input
;
975 char *response
, answer
;
977 gdb_flush (gdb_stdout
);
978 response
= gdb_readline_wrapper (prompt
.c_str ());
980 if (response
== NULL
) /* C-d */
982 printf_filtered ("EOF [assumed %c]\n", def_answer
);
987 answer
= response
[0];
992 /* Check answer. For the non-default, the user must specify
993 the non-default explicitly. */
994 if (answer
== not_def_answer
)
999 /* Otherwise, if a default was specified, the user may either
1000 specify the required input or have it default by entering
1002 if (answer
== def_answer
1003 || (defchar
!= '\0' && answer
== '\0'))
1008 /* Invalid entries are not defaulted and require another selection. */
1009 printf_filtered (_("Please answer %s or %s.\n"),
1010 y_string
, n_string
);
1013 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1014 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1016 if (annotation_level
> 1)
1017 printf_filtered (("\n\032\032post-query\n"));
1022 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1023 answer is yes, or 0 if answer is defaulted.
1024 Takes three args which are given to printf to print the question.
1025 The first, a control string, should end in "? ".
1026 It should not say how to answer, because we do that. */
1029 nquery (const char *ctlstr
, ...)
1034 va_start (args
, ctlstr
);
1035 ret
= defaulted_query (ctlstr
, 'n', args
);
1040 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1041 answer is yes, or 1 if answer is defaulted.
1042 Takes three args which are given to printf to print the question.
1043 The first, a control string, should end in "? ".
1044 It should not say how to answer, because we do that. */
1047 yquery (const char *ctlstr
, ...)
1052 va_start (args
, ctlstr
);
1053 ret
= defaulted_query (ctlstr
, 'y', args
);
1058 /* Ask user a y-or-n question and return 1 iff answer is yes.
1059 Takes three args which are given to printf to print the question.
1060 The first, a control string, should end in "? ".
1061 It should not say how to answer, because we do that. */
1064 query (const char *ctlstr
, ...)
1069 va_start (args
, ctlstr
);
1070 ret
= defaulted_query (ctlstr
, '\0', args
);
1075 /* A helper for parse_escape that converts a host character to a
1076 target character. C is the host character. If conversion is
1077 possible, then the target character is stored in *TARGET_C and the
1078 function returns 1. Otherwise, the function returns 0. */
1081 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1086 auto_obstack host_data
;
1088 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1089 (gdb_byte
*) &the_char
, 1, 1,
1090 &host_data
, translit_none
);
1092 if (obstack_object_size (&host_data
) == 1)
1095 *target_c
= *(char *) obstack_base (&host_data
);
1101 /* Parse a C escape sequence. STRING_PTR points to a variable
1102 containing a pointer to the string to parse. That pointer
1103 should point to the character after the \. That pointer
1104 is updated past the characters we use. The value of the
1105 escape sequence is returned.
1107 A negative value means the sequence \ newline was seen,
1108 which is supposed to be equivalent to nothing at all.
1110 If \ is followed by a null character, we return a negative
1111 value and leave the string pointer pointing at the null character.
1113 If \ is followed by 000, we return 0 and leave the string pointer
1114 after the zeros. A value of 0 does not mean end of string. */
1117 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1119 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1120 int c
= *(*string_ptr
)++;
1139 int i
= host_hex_value (c
);
1144 if (isdigit (c
) && c
!= '8' && c
!= '9')
1148 i
+= host_hex_value (c
);
1184 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1185 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1186 " which has no equivalent\nin the `%s' character set."),
1187 c
, c
, target_charset (gdbarch
));
1191 /* Print the character C on STREAM as part of the contents of a literal
1192 string whose delimiter is QUOTER. Note that this routine should only
1193 be called for printing things which are independent of the language
1194 of the program being debugged.
1196 printchar will normally escape backslashes and instances of QUOTER. If
1197 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1198 As a side effect, if you pass the backslash character as the QUOTER,
1199 printchar will escape backslashes as usual, but not any other quoting
1203 printchar (int c
, void (*do_fputs
) (const char *, struct ui_file
*),
1204 void (*do_fprintf
) (struct ui_file
*, const char *, ...)
1205 ATTRIBUTE_FPTR_PRINTF_2
, struct ui_file
*stream
, int quoter
)
1207 c
&= 0xFF; /* Avoid sign bit follies */
1209 if (c
< 0x20 || /* Low control chars */
1210 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1211 (sevenbit_strings
&& c
>= 0x80))
1212 { /* high order bit set */
1216 do_fputs ("\\n", stream
);
1219 do_fputs ("\\b", stream
);
1222 do_fputs ("\\t", stream
);
1225 do_fputs ("\\f", stream
);
1228 do_fputs ("\\r", stream
);
1231 do_fputs ("\\e", stream
);
1234 do_fputs ("\\a", stream
);
1237 do_fprintf (stream
, "\\%.3o", (unsigned int) c
);
1243 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1244 do_fputs ("\\", stream
);
1245 do_fprintf (stream
, "%c", c
);
1249 /* Print the character C on STREAM as part of the contents of a
1250 literal string whose delimiter is QUOTER. Note that these routines
1251 should only be call for printing things which are independent of
1252 the language of the program being debugged. */
1255 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1258 printchar (*str
++, fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1262 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1265 printchar (*str
++, fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1269 fputstrn_filtered (const char *str
, int n
, int quoter
,
1270 struct ui_file
*stream
)
1274 for (i
= 0; i
< n
; i
++)
1275 printchar (str
[i
], fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1279 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1280 struct ui_file
*stream
)
1284 for (i
= 0; i
< n
; i
++)
1285 printchar (str
[i
], fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1289 /* Number of lines per page or UINT_MAX if paging is disabled. */
1290 static unsigned int lines_per_page
;
1292 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1293 struct cmd_list_element
*c
, const char *value
)
1295 fprintf_filtered (file
,
1296 _("Number of lines gdb thinks are in a page is %s.\n"),
1300 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1301 static unsigned int chars_per_line
;
1303 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1304 struct cmd_list_element
*c
, const char *value
)
1306 fprintf_filtered (file
,
1307 _("Number of characters gdb thinks "
1308 "are in a line is %s.\n"),
1312 /* Current count of lines printed on this page, chars on this line. */
1313 static unsigned int lines_printed
, chars_printed
;
1315 /* Buffer and start column of buffered text, for doing smarter word-
1316 wrapping. When someone calls wrap_here(), we start buffering output
1317 that comes through fputs_filtered(). If we see a newline, we just
1318 spit it out and forget about the wrap_here(). If we see another
1319 wrap_here(), we spit it out and remember the newer one. If we see
1320 the end of the line, we spit out a newline, the indent, and then
1321 the buffered output. */
1323 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1324 are waiting to be output (they have already been counted in chars_printed).
1325 When wrap_buffer[0] is null, the buffer is empty. */
1326 static char *wrap_buffer
;
1328 /* Pointer in wrap_buffer to the next character to fill. */
1329 static char *wrap_pointer
;
1331 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1333 static const char *wrap_indent
;
1335 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1336 is not in effect. */
1337 static int wrap_column
;
1340 /* Initialize the number of lines per page and chars per line. */
1343 init_page_info (void)
1347 lines_per_page
= UINT_MAX
;
1348 chars_per_line
= UINT_MAX
;
1352 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1357 #if defined(__GO32__)
1358 rows
= ScreenRows ();
1359 cols
= ScreenCols ();
1360 lines_per_page
= rows
;
1361 chars_per_line
= cols
;
1363 /* Make sure Readline has initialized its terminal settings. */
1364 rl_reset_terminal (NULL
);
1366 /* Get the screen size from Readline. */
1367 rl_get_screen_size (&rows
, &cols
);
1368 lines_per_page
= rows
;
1369 chars_per_line
= cols
;
1371 /* Readline should have fetched the termcap entry for us.
1372 Only try to use tgetnum function if rl_get_screen_size
1373 did not return a useful value. */
1374 if (((rows
<= 0) && (tgetnum ((char *) "li") < 0))
1375 /* Also disable paging if inside Emacs. $EMACS was used
1376 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1377 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1379 /* The number of lines per page is not mentioned in the terminal
1380 description or EMACS evironment variable is set. This probably
1381 means that paging is not useful, so disable paging. */
1382 lines_per_page
= UINT_MAX
;
1385 /* If the output is not a terminal, don't paginate it. */
1386 if (!ui_file_isatty (gdb_stdout
))
1387 lines_per_page
= UINT_MAX
;
1391 /* We handle SIGWINCH ourselves. */
1392 rl_catch_sigwinch
= 0;
1398 /* Return nonzero if filtered printing is initialized. */
1400 filtered_printing_initialized (void)
1402 return wrap_buffer
!= NULL
;
1405 set_batch_flag_and_restore_page_info::set_batch_flag_and_restore_page_info ()
1406 : m_save_lines_per_page (lines_per_page
),
1407 m_save_chars_per_line (chars_per_line
),
1408 m_save_batch_flag (batch_flag
)
1414 set_batch_flag_and_restore_page_info::~set_batch_flag_and_restore_page_info ()
1416 batch_flag
= m_save_batch_flag
;
1417 chars_per_line
= m_save_chars_per_line
;
1418 lines_per_page
= m_save_lines_per_page
;
1424 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1427 set_screen_size (void)
1429 int rows
= lines_per_page
;
1430 int cols
= chars_per_line
;
1438 /* Update Readline's idea of the terminal size. */
1439 rl_set_screen_size (rows
, cols
);
1442 /* Reinitialize WRAP_BUFFER according to the current value of
1448 if (chars_per_line
== 0)
1453 wrap_buffer
= (char *) xmalloc (chars_per_line
+ 2);
1454 wrap_buffer
[0] = '\0';
1457 wrap_buffer
= (char *) xrealloc (wrap_buffer
, chars_per_line
+ 2);
1458 wrap_pointer
= wrap_buffer
; /* Start it at the beginning. */
1462 set_width_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1469 set_height_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1477 set_screen_width_and_height (int width
, int height
)
1479 lines_per_page
= height
;
1480 chars_per_line
= width
;
1486 /* Wait, so the user can read what's on the screen. Prompt the user
1487 to continue by pressing RETURN. 'q' is also provided because
1488 telling users what to do in the prompt is more user-friendly than
1489 expecting them to think of Ctrl-C/SIGINT. */
1492 prompt_for_continue (void)
1495 char cont_prompt
[120];
1496 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
1497 /* Used to add duration we waited for user to respond to
1498 prompt_for_continue_wait_time. */
1499 using namespace std::chrono
;
1500 steady_clock::time_point prompt_started
= steady_clock::now ();
1502 if (annotation_level
> 1)
1503 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1505 strcpy (cont_prompt
,
1506 "---Type <return> to continue, or q <return> to quit---");
1507 if (annotation_level
> 1)
1508 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1510 /* We must do this *before* we call gdb_readline_wrapper, else it
1511 will eventually call us -- thinking that we're trying to print
1512 beyond the end of the screen. */
1513 reinitialize_more_filter ();
1515 scoped_input_handler prepare_input
;
1517 /* Call gdb_readline_wrapper, not readline, in order to keep an
1518 event loop running. */
1519 ignore
= gdb_readline_wrapper (cont_prompt
);
1520 make_cleanup (xfree
, ignore
);
1522 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1523 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1525 if (annotation_level
> 1)
1526 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1532 while (*p
== ' ' || *p
== '\t')
1535 /* Do not call quit here; there is no possibility of SIGINT. */
1536 throw_quit ("Quit");
1539 /* Now we have to do this again, so that GDB will know that it doesn't
1540 need to save the ---Type <return>--- line at the top of the screen. */
1541 reinitialize_more_filter ();
1543 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1545 do_cleanups (old_chain
);
1548 /* Initialize timer to keep track of how long we waited for the user. */
1551 reset_prompt_for_continue_wait_time (void)
1553 using namespace std::chrono
;
1555 prompt_for_continue_wait_time
= steady_clock::duration::zero ();
1558 /* Fetch the cumulative time spent in prompt_for_continue. */
1560 std::chrono::steady_clock::duration
1561 get_prompt_for_continue_wait_time ()
1563 return prompt_for_continue_wait_time
;
1566 /* Reinitialize filter; ie. tell it to reset to original values. */
1569 reinitialize_more_filter (void)
1575 /* Indicate that if the next sequence of characters overflows the line,
1576 a newline should be inserted here rather than when it hits the end.
1577 If INDENT is non-null, it is a string to be printed to indent the
1578 wrapped part on the next line. INDENT must remain accessible until
1579 the next call to wrap_here() or until a newline is printed through
1582 If the line is already overfull, we immediately print a newline and
1583 the indentation, and disable further wrapping.
1585 If we don't know the width of lines, but we know the page height,
1586 we must not wrap words, but should still keep track of newlines
1587 that were explicitly printed.
1589 INDENT should not contain tabs, as that will mess up the char count
1590 on the next line. FIXME.
1592 This routine is guaranteed to force out any output which has been
1593 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1594 used to force out output from the wrap_buffer. */
1597 wrap_here (const char *indent
)
1599 /* This should have been allocated, but be paranoid anyway. */
1601 internal_error (__FILE__
, __LINE__
,
1602 _("failed internal consistency check"));
1606 *wrap_pointer
= '\0';
1607 fputs_unfiltered (wrap_buffer
, gdb_stdout
);
1609 wrap_pointer
= wrap_buffer
;
1610 wrap_buffer
[0] = '\0';
1611 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1615 else if (chars_printed
>= chars_per_line
)
1617 puts_filtered ("\n");
1619 puts_filtered (indent
);
1624 wrap_column
= chars_printed
;
1628 wrap_indent
= indent
;
1632 /* Print input string to gdb_stdout, filtered, with wrap,
1633 arranging strings in columns of n chars. String can be
1634 right or left justified in the column. Never prints
1635 trailing spaces. String should never be longer than
1636 width. FIXME: this could be useful for the EXAMINE
1637 command, which currently doesn't tabulate very well. */
1640 puts_filtered_tabular (char *string
, int width
, int right
)
1646 gdb_assert (chars_per_line
> 0);
1647 if (chars_per_line
== UINT_MAX
)
1649 fputs_filtered (string
, gdb_stdout
);
1650 fputs_filtered ("\n", gdb_stdout
);
1654 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1655 fputs_filtered ("\n", gdb_stdout
);
1657 if (width
>= chars_per_line
)
1658 width
= chars_per_line
- 1;
1660 stringlen
= strlen (string
);
1662 if (chars_printed
> 0)
1663 spaces
= width
- (chars_printed
- 1) % width
- 1;
1665 spaces
+= width
- stringlen
;
1667 spacebuf
= (char *) alloca (spaces
+ 1);
1668 spacebuf
[spaces
] = '\0';
1670 spacebuf
[spaces
] = ' ';
1672 fputs_filtered (spacebuf
, gdb_stdout
);
1673 fputs_filtered (string
, gdb_stdout
);
1677 /* Ensure that whatever gets printed next, using the filtered output
1678 commands, starts at the beginning of the line. I.e. if there is
1679 any pending output for the current line, flush it and start a new
1680 line. Otherwise do nothing. */
1685 if (chars_printed
> 0)
1687 puts_filtered ("\n");
1692 /* Like fputs but if FILTER is true, pause after every screenful.
1694 Regardless of FILTER can wrap at points other than the final
1695 character of a line.
1697 Unlike fputs, fputs_maybe_filtered does not return a value.
1698 It is OK for LINEBUFFER to be NULL, in which case just don't print
1701 Note that a longjmp to top level may occur in this routine (only if
1702 FILTER is true) (since prompt_for_continue may do so) so this
1703 routine should not be called when cleanups are not in place. */
1706 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1709 const char *lineptr
;
1711 if (linebuffer
== 0)
1714 /* Don't do any filtering if it is disabled. */
1715 if (stream
!= gdb_stdout
1716 || !pagination_enabled
1718 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
1719 || top_level_interpreter () == NULL
1720 || interp_ui_out (top_level_interpreter ())->is_mi_like_p ())
1722 fputs_unfiltered (linebuffer
, stream
);
1726 /* Go through and output each character. Show line extension
1727 when this is necessary; prompt user for new page when this is
1730 lineptr
= linebuffer
;
1733 /* Possible new page. */
1734 if (filter
&& (lines_printed
>= lines_per_page
- 1))
1735 prompt_for_continue ();
1737 while (*lineptr
&& *lineptr
!= '\n')
1739 /* Print a single line. */
1740 if (*lineptr
== '\t')
1743 *wrap_pointer
++ = '\t';
1745 fputc_unfiltered ('\t', stream
);
1746 /* Shifting right by 3 produces the number of tab stops
1747 we have already passed, and then adding one and
1748 shifting left 3 advances to the next tab stop. */
1749 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
1755 *wrap_pointer
++ = *lineptr
;
1757 fputc_unfiltered (*lineptr
, stream
);
1762 if (chars_printed
>= chars_per_line
)
1764 unsigned int save_chars
= chars_printed
;
1768 /* If we aren't actually wrapping, don't output newline --
1769 if chars_per_line is right, we probably just overflowed
1770 anyway; if it's wrong, let us keep going. */
1772 fputc_unfiltered ('\n', stream
);
1774 /* Possible new page. */
1775 if (lines_printed
>= lines_per_page
- 1)
1776 prompt_for_continue ();
1778 /* Now output indentation and wrapped string. */
1781 fputs_unfiltered (wrap_indent
, stream
);
1782 *wrap_pointer
= '\0'; /* Null-terminate saved stuff, */
1783 fputs_unfiltered (wrap_buffer
, stream
); /* and eject it. */
1784 /* FIXME, this strlen is what prevents wrap_indent from
1785 containing tabs. However, if we recurse to print it
1786 and count its chars, we risk trouble if wrap_indent is
1787 longer than (the user settable) chars_per_line.
1788 Note also that this can set chars_printed > chars_per_line
1789 if we are printing a long string. */
1790 chars_printed
= strlen (wrap_indent
)
1791 + (save_chars
- wrap_column
);
1792 wrap_pointer
= wrap_buffer
; /* Reset buffer */
1793 wrap_buffer
[0] = '\0';
1794 wrap_column
= 0; /* And disable fancy wrap */
1799 if (*lineptr
== '\n')
1802 wrap_here ((char *) 0); /* Spit out chars, cancel
1805 fputc_unfiltered ('\n', stream
);
1812 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
1814 fputs_maybe_filtered (linebuffer
, stream
, 1);
1818 putchar_unfiltered (int c
)
1822 ui_file_write (gdb_stdout
, &buf
, 1);
1826 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
1827 May return nonlocally. */
1830 putchar_filtered (int c
)
1832 return fputc_filtered (c
, gdb_stdout
);
1836 fputc_unfiltered (int c
, struct ui_file
*stream
)
1840 ui_file_write (stream
, &buf
, 1);
1845 fputc_filtered (int c
, struct ui_file
*stream
)
1851 fputs_filtered (buf
, stream
);
1855 /* puts_debug is like fputs_unfiltered, except it prints special
1856 characters in printable fashion. */
1859 puts_debug (char *prefix
, char *string
, char *suffix
)
1863 /* Print prefix and suffix after each line. */
1864 static int new_line
= 1;
1865 static int return_p
= 0;
1866 static const char *prev_prefix
= "";
1867 static const char *prev_suffix
= "";
1869 if (*string
== '\n')
1872 /* If the prefix is changing, print the previous suffix, a new line,
1873 and the new prefix. */
1874 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
1876 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
1877 fputs_unfiltered ("\n", gdb_stdlog
);
1878 fputs_unfiltered (prefix
, gdb_stdlog
);
1881 /* Print prefix if we printed a newline during the previous call. */
1885 fputs_unfiltered (prefix
, gdb_stdlog
);
1888 prev_prefix
= prefix
;
1889 prev_suffix
= suffix
;
1891 /* Output characters in a printable format. */
1892 while ((ch
= *string
++) != '\0')
1898 fputc_unfiltered (ch
, gdb_stdlog
);
1901 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
1905 fputs_unfiltered ("\\\\", gdb_stdlog
);
1908 fputs_unfiltered ("\\b", gdb_stdlog
);
1911 fputs_unfiltered ("\\f", gdb_stdlog
);
1915 fputs_unfiltered ("\\n", gdb_stdlog
);
1918 fputs_unfiltered ("\\r", gdb_stdlog
);
1921 fputs_unfiltered ("\\t", gdb_stdlog
);
1924 fputs_unfiltered ("\\v", gdb_stdlog
);
1928 return_p
= ch
== '\r';
1931 /* Print suffix if we printed a newline. */
1934 fputs_unfiltered (suffix
, gdb_stdlog
);
1935 fputs_unfiltered ("\n", gdb_stdlog
);
1940 /* Print a variable number of ARGS using format FORMAT. If this
1941 information is going to put the amount written (since the last call
1942 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
1943 call prompt_for_continue to get the users permision to continue.
1945 Unlike fprintf, this function does not return a value.
1947 We implement three variants, vfprintf (takes a vararg list and stream),
1948 fprintf (takes a stream to write on), and printf (the usual).
1950 Note also that a longjmp to top level may occur in this routine
1951 (since prompt_for_continue may do so) so this routine should not be
1952 called when cleanups are not in place. */
1955 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
1956 va_list args
, int filter
)
1958 std::string linebuffer
= string_vprintf (format
, args
);
1959 fputs_maybe_filtered (linebuffer
.c_str (), stream
, filter
);
1964 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
1966 vfprintf_maybe_filtered (stream
, format
, args
, 1);
1970 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
1972 std::string linebuffer
= string_vprintf (format
, args
);
1973 if (debug_timestamp
&& stream
== gdb_stdlog
)
1975 using namespace std::chrono
;
1978 steady_clock::time_point now
= steady_clock::now ();
1979 seconds s
= duration_cast
<seconds
> (now
.time_since_epoch ());
1980 microseconds us
= duration_cast
<microseconds
> (now
.time_since_epoch () - s
);
1982 len
= linebuffer
.size ();
1983 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
1985 std::string timestamp
= string_printf ("%ld.%06ld %s%s",
1988 linebuffer
.c_str (),
1989 need_nl
? "\n": "");
1990 fputs_unfiltered (timestamp
.c_str (), stream
);
1993 fputs_unfiltered (linebuffer
.c_str (), stream
);
1997 vprintf_filtered (const char *format
, va_list args
)
1999 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2003 vprintf_unfiltered (const char *format
, va_list args
)
2005 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2009 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2013 va_start (args
, format
);
2014 vfprintf_filtered (stream
, format
, args
);
2019 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2023 va_start (args
, format
);
2024 vfprintf_unfiltered (stream
, format
, args
);
2028 /* Like fprintf_filtered, but prints its result indented.
2029 Called as fprintfi_filtered (spaces, stream, format, ...); */
2032 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2037 va_start (args
, format
);
2038 print_spaces_filtered (spaces
, stream
);
2040 vfprintf_filtered (stream
, format
, args
);
2046 printf_filtered (const char *format
, ...)
2050 va_start (args
, format
);
2051 vfprintf_filtered (gdb_stdout
, format
, args
);
2057 printf_unfiltered (const char *format
, ...)
2061 va_start (args
, format
);
2062 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2066 /* Like printf_filtered, but prints it's result indented.
2067 Called as printfi_filtered (spaces, format, ...); */
2070 printfi_filtered (int spaces
, const char *format
, ...)
2074 va_start (args
, format
);
2075 print_spaces_filtered (spaces
, gdb_stdout
);
2076 vfprintf_filtered (gdb_stdout
, format
, args
);
2080 /* Easy -- but watch out!
2082 This routine is *not* a replacement for puts()! puts() appends a newline.
2083 This one doesn't, and had better not! */
2086 puts_filtered (const char *string
)
2088 fputs_filtered (string
, gdb_stdout
);
2092 puts_unfiltered (const char *string
)
2094 fputs_unfiltered (string
, gdb_stdout
);
2097 /* Return a pointer to N spaces and a null. The pointer is good
2098 until the next call to here. */
2103 static char *spaces
= 0;
2104 static int max_spaces
= -1;
2110 spaces
= (char *) xmalloc (n
+ 1);
2111 for (t
= spaces
+ n
; t
!= spaces
;)
2117 return spaces
+ max_spaces
- n
;
2120 /* Print N spaces. */
2122 print_spaces_filtered (int n
, struct ui_file
*stream
)
2124 fputs_filtered (n_spaces (n
), stream
);
2127 /* C++/ObjC demangler stuff. */
2129 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2130 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2131 If the name is not mangled, or the language for the name is unknown, or
2132 demangling is off, the name is printed in its "raw" form. */
2135 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2136 enum language lang
, int arg_mode
)
2142 /* If user wants to see raw output, no problem. */
2145 fputs_filtered (name
, stream
);
2149 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2150 fputs_filtered (demangled
? demangled
: name
, stream
);
2151 if (demangled
!= NULL
)
2159 /* Modes of operation for strncmp_iw_with_mode. */
2161 enum class strncmp_iw_mode
2163 /* Work like strncmp, while ignoring whitespace. */
2166 /* Like NORMAL, but also apply the strcmp_iw hack. I.e.,
2167 string1=="FOO(PARAMS)" matches string2=="FOO". */
2171 /* Helper for strncmp_iw and strcmp_iw. */
2174 strncmp_iw_with_mode (const char *string1
, const char *string2
,
2175 size_t string2_len
, strncmp_iw_mode mode
)
2177 const char *end_str2
= string2
+ string2_len
;
2181 while (isspace (*string1
))
2183 while (string2
< end_str2
&& isspace (*string2
))
2185 if (*string1
== '\0' || string2
== end_str2
)
2187 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2189 if (case_sensitivity
== case_sensitive_off
2190 && (tolower ((unsigned char) *string1
)
2191 != tolower ((unsigned char) *string2
)))
2198 if (string2
== end_str2
)
2200 if (mode
== strncmp_iw_mode::NORMAL
)
2203 return (*string1
!= '\0' && *string1
!= '(');
2212 strncmp_iw (const char *string1
, const char *string2
, size_t string2_len
)
2214 return strncmp_iw_with_mode (string1
, string2
, string2_len
,
2215 strncmp_iw_mode::NORMAL
);
2221 strcmp_iw (const char *string1
, const char *string2
)
2223 return strncmp_iw_with_mode (string1
, string2
, strlen (string2
),
2224 strncmp_iw_mode::MATCH_PARAMS
);
2227 /* This is like strcmp except that it ignores whitespace and treats
2228 '(' as the first non-NULL character in terms of ordering. Like
2229 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2230 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2231 according to that ordering.
2233 If a list is sorted according to this function and if you want to
2234 find names in the list that match some fixed NAME according to
2235 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2236 where this function would put NAME.
2238 This function must be neutral to the CASE_SENSITIVITY setting as the user
2239 may choose it during later lookup. Therefore this function always sorts
2240 primarily case-insensitively and secondarily case-sensitively.
2242 Here are some examples of why using strcmp to sort is a bad idea:
2246 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2247 we try to do a search for "foo<char*>", strcmp will locate this
2248 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2249 will start looking at strings beginning with "goo", and will never
2250 see the correct match of "foo<char *>".
2252 Parenthesis example:
2254 In practice, this is less like to be an issue, but I'll give it a
2255 shot. Let's assume that '$' is a legitimate character to occur in
2256 symbols. (Which may well even be the case on some systems.) Then
2257 say that the partial symbol table contains "foo$" and "foo(int)".
2258 strcmp will put them in this order, since '$' < '('. Now, if the
2259 user searches for "foo", then strcmp will sort "foo" before "foo$".
2260 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2261 "foo") is false, so it won't proceed to the actual match of
2262 "foo(int)" with "foo". */
2265 strcmp_iw_ordered (const char *string1
, const char *string2
)
2267 const char *saved_string1
= string1
, *saved_string2
= string2
;
2268 enum case_sensitivity case_pass
= case_sensitive_off
;
2272 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2273 Provide stub characters if we are already at the end of one of the
2275 char c1
= 'X', c2
= 'X';
2277 while (*string1
!= '\0' && *string2
!= '\0')
2279 while (isspace (*string1
))
2281 while (isspace (*string2
))
2286 case case_sensitive_off
:
2287 c1
= tolower ((unsigned char) *string1
);
2288 c2
= tolower ((unsigned char) *string2
);
2290 case case_sensitive_on
:
2298 if (*string1
!= '\0')
2307 /* Characters are non-equal unless they're both '\0'; we want to
2308 make sure we get the comparison right according to our
2309 comparison in the cases where one of them is '\0' or '('. */
2311 if (*string2
== '\0')
2316 if (*string2
== '\0')
2321 if (*string2
== '\0' || *string2
== '(')
2330 if (case_pass
== case_sensitive_on
)
2333 /* Otherwise the strings were equal in case insensitive way, make
2334 a more fine grained comparison in a case sensitive way. */
2336 case_pass
= case_sensitive_on
;
2337 string1
= saved_string1
;
2338 string2
= saved_string2
;
2342 /* A simple comparison function with opposite semantics to strcmp. */
2345 streq (const char *lhs
, const char *rhs
)
2347 return !strcmp (lhs
, rhs
);
2353 ** Answer whether string_to_compare is a full or partial match to
2354 ** template_string. The partial match must be in sequence starting
2358 subset_compare (const char *string_to_compare
, const char *template_string
)
2362 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
2363 && strlen (string_to_compare
) <= strlen (template_string
))
2365 (startswith (template_string
, string_to_compare
));
2372 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2373 struct cmd_list_element
*c
, const char *value
)
2375 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2381 initialize_utils (void)
2383 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
2384 Set number of characters where GDB should wrap lines of its output."), _("\
2385 Show number of characters where GDB should wrap lines of its output."), _("\
2386 This affects where GDB wraps its output to fit the screen width.\n\
2387 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2389 show_chars_per_line
,
2390 &setlist
, &showlist
);
2392 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
2393 Set number of lines in a page for GDB output pagination."), _("\
2394 Show number of lines in a page for GDB output pagination."), _("\
2395 This affects the number of lines after which GDB will pause\n\
2396 its output and ask you whether to continue.\n\
2397 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2399 show_lines_per_page
,
2400 &setlist
, &showlist
);
2402 add_setshow_boolean_cmd ("pagination", class_support
,
2403 &pagination_enabled
, _("\
2404 Set state of GDB output pagination."), _("\
2405 Show state of GDB output pagination."), _("\
2406 When pagination is ON, GDB pauses at end of each screenful of\n\
2407 its output and asks you whether to continue.\n\
2408 Turning pagination off is an alternative to \"set height unlimited\"."),
2410 show_pagination_enabled
,
2411 &setlist
, &showlist
);
2413 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
2414 &sevenbit_strings
, _("\
2415 Set printing of 8-bit characters in strings as \\nnn."), _("\
2416 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
2418 show_sevenbit_strings
,
2419 &setprintlist
, &showprintlist
);
2421 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
2422 &debug_timestamp
, _("\
2423 Set timestamping of debugging messages."), _("\
2424 Show timestamping of debugging messages."), _("\
2425 When set, debugging messages will be marked with seconds and microseconds."),
2427 show_debug_timestamp
,
2428 &setdebuglist
, &showdebuglist
);
2432 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2434 /* Truncate address to the size of a target address, avoiding shifts
2435 larger or equal than the width of a CORE_ADDR. The local
2436 variable ADDR_BIT stops the compiler reporting a shift overflow
2437 when it won't occur. */
2438 /* NOTE: This assumes that the significant address information is
2439 kept in the least significant bits of ADDR - the upper bits were
2440 either zero or sign extended. Should gdbarch_address_to_pointer or
2441 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2443 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2445 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2446 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2447 return hex_string (addr
);
2450 /* This function is described in "defs.h". */
2453 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2455 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2457 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2458 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2460 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2461 that returns the language localized string formatted to a width
2462 based on gdbarch_addr_bit. */
2464 return hex_string_custom (address
, 8);
2466 return hex_string_custom (address
, 16);
2469 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2472 core_addr_hash (const void *ap
)
2474 const CORE_ADDR
*addrp
= (const CORE_ADDR
*) ap
;
2479 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2482 core_addr_eq (const void *ap
, const void *bp
)
2484 const CORE_ADDR
*addr_ap
= (const CORE_ADDR
*) ap
;
2485 const CORE_ADDR
*addr_bp
= (const CORE_ADDR
*) bp
;
2487 return *addr_ap
== *addr_bp
;
2490 /* Convert a string back into a CORE_ADDR. */
2492 string_to_core_addr (const char *my_string
)
2496 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2498 /* Assume that it is in hex. */
2501 for (i
= 2; my_string
[i
] != '\0'; i
++)
2503 if (isdigit (my_string
[i
]))
2504 addr
= (my_string
[i
] - '0') + (addr
* 16);
2505 else if (isxdigit (my_string
[i
]))
2506 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2508 error (_("invalid hex \"%s\""), my_string
);
2513 /* Assume that it is in decimal. */
2516 for (i
= 0; my_string
[i
] != '\0'; i
++)
2518 if (isdigit (my_string
[i
]))
2519 addr
= (my_string
[i
] - '0') + (addr
* 10);
2521 error (_("invalid decimal \"%s\""), my_string
);
2528 gdb::unique_xmalloc_ptr
<char>
2529 gdb_realpath (const char *filename
)
2531 /* On most hosts, we rely on canonicalize_file_name to compute
2532 the FILENAME's realpath.
2534 But the situation is slightly more complex on Windows, due to some
2535 versions of GCC which were reported to generate paths where
2536 backlashes (the directory separator) were doubled. For instance:
2537 c:\\some\\double\\slashes\\dir
2539 c:\some\double\slashes\dir
2540 Those double-slashes were getting in the way when comparing paths,
2541 for instance when trying to insert a breakpoint as follow:
2542 (gdb) b c:/some/double/slashes/dir/foo.c:4
2543 No source file named c:/some/double/slashes/dir/foo.c:4.
2544 (gdb) b c:\some\double\slashes\dir\foo.c:4
2545 No source file named c:\some\double\slashes\dir\foo.c:4.
2546 To prevent this from happening, we need this function to always
2547 strip those extra backslashes. While canonicalize_file_name does
2548 perform this simplification, it only works when the path is valid.
2549 Since the simplification would be useful even if the path is not
2550 valid (one can always set a breakpoint on a file, even if the file
2551 does not exist locally), we rely instead on GetFullPathName to
2552 perform the canonicalization. */
2554 #if defined (_WIN32)
2557 DWORD len
= GetFullPathName (filename
, MAX_PATH
, buf
, NULL
);
2559 /* The file system is case-insensitive but case-preserving.
2560 So it is important we do not lowercase the path. Otherwise,
2561 we might not be able to display the original casing in a given
2563 if (len
> 0 && len
< MAX_PATH
)
2564 return gdb::unique_xmalloc_ptr
<char> (xstrdup (buf
));
2568 char *rp
= canonicalize_file_name (filename
);
2571 return gdb::unique_xmalloc_ptr
<char> (rp
);
2575 /* This system is a lost cause, just dup the buffer. */
2576 return gdb::unique_xmalloc_ptr
<char> (xstrdup (filename
));
2582 gdb_realpath_check_trailer (const char *input
, const char *trailer
)
2584 gdb::unique_xmalloc_ptr
<char> result
= gdb_realpath (input
);
2586 size_t len
= strlen (result
.get ());
2587 size_t trail_len
= strlen (trailer
);
2589 SELF_CHECK (len
>= trail_len
2590 && strcmp (result
.get () + len
- trail_len
, trailer
) == 0);
2594 gdb_realpath_tests ()
2596 /* A file which contains a directory prefix. */
2597 gdb_realpath_check_trailer ("./xfullpath.exp", "/xfullpath.exp");
2598 /* A file which contains a directory prefix. */
2599 gdb_realpath_check_trailer ("../../defs.h", "/defs.h");
2600 /* A one-character filename. */
2601 gdb_realpath_check_trailer ("./a", "/a");
2602 /* A file in the root directory. */
2603 gdb_realpath_check_trailer ("/root_file_which_should_exist",
2604 "/root_file_which_should_exist");
2605 /* A file which does not have a directory prefix. */
2606 gdb_realpath_check_trailer ("xfullpath.exp", "xfullpath.exp");
2607 /* A one-char filename without any directory prefix. */
2608 gdb_realpath_check_trailer ("a", "a");
2609 /* An empty filename. */
2610 gdb_realpath_check_trailer ("", "");
2613 #endif /* GDB_SELF_TEST */
2615 /* Return a copy of FILENAME, with its directory prefix canonicalized
2618 gdb::unique_xmalloc_ptr
<char>
2619 gdb_realpath_keepfile (const char *filename
)
2621 const char *base_name
= lbasename (filename
);
2625 /* Extract the basename of filename, and return immediately
2626 a copy of filename if it does not contain any directory prefix. */
2627 if (base_name
== filename
)
2628 return gdb::unique_xmalloc_ptr
<char> (xstrdup (filename
));
2630 dir_name
= (char *) alloca ((size_t) (base_name
- filename
+ 2));
2631 /* Allocate enough space to store the dir_name + plus one extra
2632 character sometimes needed under Windows (see below), and
2633 then the closing \000 character. */
2634 strncpy (dir_name
, filename
, base_name
- filename
);
2635 dir_name
[base_name
- filename
] = '\000';
2637 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
2638 /* We need to be careful when filename is of the form 'd:foo', which
2639 is equivalent of d:./foo, which is totally different from d:/foo. */
2640 if (strlen (dir_name
) == 2 && isalpha (dir_name
[0]) && dir_name
[1] == ':')
2643 dir_name
[3] = '\000';
2647 /* Canonicalize the directory prefix, and build the resulting
2648 filename. If the dirname realpath already contains an ending
2649 directory separator, avoid doubling it. */
2650 gdb::unique_xmalloc_ptr
<char> path_storage
= gdb_realpath (dir_name
);
2651 const char *real_path
= path_storage
.get ();
2652 if (IS_DIR_SEPARATOR (real_path
[strlen (real_path
) - 1]))
2653 result
= concat (real_path
, base_name
, (char *) NULL
);
2655 result
= concat (real_path
, SLASH_STRING
, base_name
, (char *) NULL
);
2657 return gdb::unique_xmalloc_ptr
<char> (result
);
2660 /* Return PATH in absolute form, performing tilde-expansion if necessary.
2661 PATH cannot be NULL or the empty string.
2662 This does not resolve symlinks however, use gdb_realpath for that. */
2664 gdb::unique_xmalloc_ptr
<char>
2665 gdb_abspath (const char *path
)
2667 gdb_assert (path
!= NULL
&& path
[0] != '\0');
2670 return gdb::unique_xmalloc_ptr
<char> (tilde_expand (path
));
2672 if (IS_ABSOLUTE_PATH (path
))
2673 return gdb::unique_xmalloc_ptr
<char> (xstrdup (path
));
2675 /* Beware the // my son, the Emacs barfs, the botch that catch... */
2676 return gdb::unique_xmalloc_ptr
<char>
2677 (concat (current_directory
,
2678 IS_DIR_SEPARATOR (current_directory
[strlen (current_directory
) - 1])
2679 ? "" : SLASH_STRING
,
2680 path
, (char *) NULL
));
2684 align_up (ULONGEST v
, int n
)
2686 /* Check that N is really a power of two. */
2687 gdb_assert (n
&& (n
& (n
-1)) == 0);
2688 return (v
+ n
- 1) & -n
;
2692 align_down (ULONGEST v
, int n
)
2694 /* Check that N is really a power of two. */
2695 gdb_assert (n
&& (n
& (n
-1)) == 0);
2699 /* Allocation function for the libiberty hash table which uses an
2700 obstack. The obstack is passed as DATA. */
2703 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
2705 size_t total
= size
* count
;
2706 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
2708 memset (ptr
, 0, total
);
2712 /* Trivial deallocation function for the libiberty splay tree and hash
2713 table - don't deallocate anything. Rely on later deletion of the
2714 obstack. DATA will be the obstack, although it is not needed
2718 dummy_obstack_deallocate (void *object
, void *data
)
2723 /* Simple, portable version of dirname that does not modify its
2727 ldirname (const char *filename
)
2729 std::string dirname
;
2730 const char *base
= lbasename (filename
);
2732 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
2735 if (base
== filename
)
2738 dirname
= std::string (filename
, base
- filename
);
2740 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
2741 create "d:./bar" later instead of the (different) "d:/bar". */
2742 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
2743 && !IS_DIR_SEPARATOR (filename
[0]))
2744 dirname
[base
++ - filename
] = '.';
2752 gdb_argv::reset (const char *s
)
2754 char **argv
= buildargv (s
);
2756 if (s
!= NULL
&& argv
== NULL
)
2764 compare_positive_ints (const void *ap
, const void *bp
)
2766 /* Because we know we're comparing two ints which are positive,
2767 there's no danger of overflow here. */
2768 return * (int *) ap
- * (int *) bp
;
2771 /* String compare function for qsort. */
2774 compare_strings (const void *arg1
, const void *arg2
)
2776 const char **s1
= (const char **) arg1
;
2777 const char **s2
= (const char **) arg2
;
2779 return strcmp (*s1
, *s2
);
2782 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
2783 #define AMBIGUOUS_MESS2 \
2784 ".\nUse \"set gnutarget format-name\" to specify the format."
2787 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
2793 /* Check if errmsg just need simple return. */
2794 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
2795 return bfd_errmsg (error_tag
);
2797 ret_len
= strlen (bfd_errmsg (error_tag
)) + strlen (AMBIGUOUS_MESS1
)
2798 + strlen (AMBIGUOUS_MESS2
);
2799 for (p
= matching
; *p
; p
++)
2800 ret_len
+= strlen (*p
) + 1;
2801 ret
= (char *) xmalloc (ret_len
+ 1);
2803 make_cleanup (xfree
, ret
);
2805 strcpy (retp
, bfd_errmsg (error_tag
));
2806 retp
+= strlen (retp
);
2808 strcpy (retp
, AMBIGUOUS_MESS1
);
2809 retp
+= strlen (retp
);
2811 for (p
= matching
; *p
; p
++)
2813 sprintf (retp
, " %s", *p
);
2814 retp
+= strlen (retp
);
2818 strcpy (retp
, AMBIGUOUS_MESS2
);
2823 /* Return ARGS parsed as a valid pid, or throw an error. */
2826 parse_pid_to_attach (const char *args
)
2832 error_no_arg (_("process-id to attach"));
2834 dummy
= (char *) args
;
2835 pid
= strtoul (args
, &dummy
, 0);
2836 /* Some targets don't set errno on errors, grrr! */
2837 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
2838 error (_("Illegal process-id: %s."), args
);
2843 /* Helper for make_bpstat_clear_actions_cleanup. */
2846 do_bpstat_clear_actions_cleanup (void *unused
)
2848 bpstat_clear_actions ();
2851 /* Call bpstat_clear_actions for the case an exception is throw. You should
2852 discard_cleanups if no exception is caught. */
2855 make_bpstat_clear_actions_cleanup (void)
2857 return make_cleanup (do_bpstat_clear_actions_cleanup
, NULL
);
2861 /* Helper for make_cleanup_free_char_ptr_vec. */
2864 do_free_char_ptr_vec (void *arg
)
2866 VEC (char_ptr
) *char_ptr_vec
= (VEC (char_ptr
) *) arg
;
2868 free_char_ptr_vec (char_ptr_vec
);
2871 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
2872 final VEC_free for CHAR_PTR_VEC itself.
2874 You must not modify CHAR_PTR_VEC after this cleanup registration as the
2875 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
2876 this function does not (cannot) clear the pointer. */
2879 make_cleanup_free_char_ptr_vec (VEC (char_ptr
) *char_ptr_vec
)
2881 return make_cleanup (do_free_char_ptr_vec
, char_ptr_vec
);
2884 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
2885 must come from xrealloc-compatible allocator and it may be updated. FROM
2886 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
2887 located at the start or end of *STRINGP. */
2890 substitute_path_component (char **stringp
, const char *from
, const char *to
)
2892 char *string
= *stringp
, *s
;
2893 const size_t from_len
= strlen (from
);
2894 const size_t to_len
= strlen (to
);
2898 s
= strstr (s
, from
);
2902 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
2903 || s
[-1] == DIRNAME_SEPARATOR
)
2904 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
2905 || s
[from_len
] == DIRNAME_SEPARATOR
))
2910 = (char *) xrealloc (string
, (strlen (string
) + to_len
+ 1));
2912 /* Relocate the current S pointer. */
2913 s
= s
- string
+ string_new
;
2914 string
= string_new
;
2916 /* Replace from by to. */
2917 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
2918 memcpy (s
, to
, to_len
);
2933 /* SIGALRM handler for waitpid_with_timeout. */
2936 sigalrm_handler (int signo
)
2938 /* Nothing to do. */
2943 /* Wrapper to wait for child PID to die with TIMEOUT.
2944 TIMEOUT is the time to stop waiting in seconds.
2945 If TIMEOUT is zero, pass WNOHANG to waitpid.
2946 Returns PID if it was successfully waited for, otherwise -1.
2948 Timeouts are currently implemented with alarm and SIGALRM.
2949 If the host does not support them, this waits "forever".
2950 It would be odd though for a host to have waitpid and not SIGALRM. */
2953 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
2955 pid_t waitpid_result
;
2957 gdb_assert (pid
> 0);
2958 gdb_assert (timeout
>= 0);
2963 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
2964 struct sigaction sa
, old_sa
;
2966 sa
.sa_handler
= sigalrm_handler
;
2967 sigemptyset (&sa
.sa_mask
);
2969 sigaction (SIGALRM
, &sa
, &old_sa
);
2973 ofunc
= signal (SIGALRM
, sigalrm_handler
);
2979 waitpid_result
= waitpid (pid
, status
, 0);
2983 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
2984 sigaction (SIGALRM
, &old_sa
, NULL
);
2986 signal (SIGALRM
, ofunc
);
2991 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
2993 if (waitpid_result
== pid
)
2999 #endif /* HAVE_WAITPID */
3001 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3002 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3004 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3005 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3008 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3010 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3012 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3013 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3015 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3017 char *pattern_slash
, *string_slash
;
3019 /* Replace '\' by '/' in both strings. */
3021 pattern_slash
= (char *) alloca (strlen (pattern
) + 1);
3022 strcpy (pattern_slash
, pattern
);
3023 pattern
= pattern_slash
;
3024 for (; *pattern_slash
!= 0; pattern_slash
++)
3025 if (IS_DIR_SEPARATOR (*pattern_slash
))
3026 *pattern_slash
= '/';
3028 string_slash
= (char *) alloca (strlen (string
) + 1);
3029 strcpy (string_slash
, string
);
3030 string
= string_slash
;
3031 for (; *string_slash
!= 0; string_slash
++)
3032 if (IS_DIR_SEPARATOR (*string_slash
))
3033 *string_slash
= '/';
3035 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3037 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3038 flags
|= FNM_CASEFOLD
;
3039 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3041 return fnmatch (pattern
, string
, flags
);
3044 /* Return the number of path elements in PATH.
3052 count_path_elements (const char *path
)
3055 const char *p
= path
;
3057 if (HAS_DRIVE_SPEC (p
))
3059 p
= STRIP_DRIVE_SPEC (p
);
3065 if (IS_DIR_SEPARATOR (*p
))
3070 /* Backup one if last character is /, unless it's the only one. */
3071 if (p
> path
+ 1 && IS_DIR_SEPARATOR (p
[-1]))
3074 /* Add one for the file name, if present. */
3075 if (p
> path
&& !IS_DIR_SEPARATOR (p
[-1]))
3081 /* Remove N leading path elements from PATH.
3082 N must be non-negative.
3083 If PATH has more than N path elements then return NULL.
3084 If PATH has exactly N path elements then return "".
3085 See count_path_elements for a description of how we do the counting. */
3088 strip_leading_path_elements (const char *path
, int n
)
3091 const char *p
= path
;
3093 gdb_assert (n
>= 0);
3098 if (HAS_DRIVE_SPEC (p
))
3100 p
= STRIP_DRIVE_SPEC (p
);
3106 while (*p
!= '\0' && !IS_DIR_SEPARATOR (*p
))
3122 _initialize_utils (void)
3124 add_internal_problem_command (&internal_error_problem
);
3125 add_internal_problem_command (&internal_warning_problem
);
3126 add_internal_problem_command (&demangler_warning_problem
);
3129 selftests::register_test ("gdb_realpath", gdb_realpath_tests
);