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"
71 extern PTR malloc (); /* ARI: PTR */
73 #if !HAVE_DECL_REALLOC
74 extern PTR realloc (); /* ARI: PTR */
80 void (*deprecated_error_begin_hook) (void);
82 /* Prototypes for local functions */
84 static void vfprintf_maybe_filtered (struct ui_file *, const char *,
85 va_list, int) ATTRIBUTE_PRINTF (2, 0);
87 static void fputs_maybe_filtered (const char *, struct ui_file *, int);
89 static void prompt_for_continue (void);
91 static void set_screen_size (void);
92 static void set_width (void);
94 /* Time spent in prompt_for_continue in the currently executing command
95 waiting for user to respond.
96 Initialized in make_command_stats_cleanup.
97 Modified in prompt_for_continue and defaulted_query.
98 Used in report_command_stats. */
100 static std::chrono::steady_clock::duration prompt_for_continue_wait_time;
102 /* A flag indicating whether to timestamp debugging messages. */
104 static int debug_timestamp = 0;
106 /* Nonzero means that strings with character values >0x7F should be printed
107 as octal escapes. Zero means just print the value (e.g. it's an
108 international character, and the terminal or window can cope.) */
110 int sevenbit_strings = 0;
112 show_sevenbit_strings (struct ui_file *file, int from_tty,
113 struct cmd_list_element *c, const char *value)
115 fprintf_filtered (file, _("Printing of 8-bit characters "
116 "in strings as \\nnn is %s.\n"),
120 /* String to be printed before warning messages, if any. */
122 const char *warning_pre_print = "\nwarning: ";
124 int pagination_enabled = 1;
126 show_pagination_enabled (struct ui_file *file, int from_tty,
127 struct cmd_list_element *c, const char *value)
129 fprintf_filtered (file, _("State of pagination is %s.\n"), value);
133 /* Cleanup utilities.
135 These are not defined in cleanups.c (nor declared in cleanups.h)
136 because while they use the "cleanup API" they are not part of the
140 do_freeargv (void *arg)
142 freeargv ((char **) arg);
146 make_cleanup_freeargv (char **arg)
148 return make_cleanup (do_freeargv, arg);
151 /* Helper function for make_cleanup_ui_out_redirect_pop. */
154 do_ui_out_redirect_pop (void *arg)
156 struct ui_out *uiout = (struct ui_out *) arg;
158 uiout->redirect (NULL);
161 /* Return a new cleanup that pops the last redirection by ui_out_redirect
162 with NULL parameter. */
165 make_cleanup_ui_out_redirect_pop (struct ui_out *uiout)
167 return make_cleanup (do_ui_out_redirect_pop, uiout);
171 do_free_section_addr_info (void *arg)
173 free_section_addr_info ((struct section_addr_info *) arg);
177 make_cleanup_free_section_addr_info (struct section_addr_info *addrs)
179 return make_cleanup (do_free_section_addr_info, addrs);
182 struct restore_integer_closure
189 restore_integer (void *p)
191 struct restore_integer_closure *closure
192 = (struct restore_integer_closure *) p;
194 *(closure->variable) = closure->value;
197 /* Remember the current value of *VARIABLE and make it restored when
198 the cleanup is run. */
201 make_cleanup_restore_integer (int *variable)
203 struct restore_integer_closure *c = XNEW (struct restore_integer_closure);
205 c->variable = variable;
206 c->value = *variable;
208 return make_cleanup_dtor (restore_integer, (void *) c, xfree);
211 /* Remember the current value of *VARIABLE and make it restored when
212 the cleanup is run. */
215 make_cleanup_restore_uinteger (unsigned int *variable)
217 return make_cleanup_restore_integer ((int *) variable);
220 /* Helper for make_cleanup_unpush_target. */
223 do_unpush_target (void *arg)
225 struct target_ops *ops = (struct target_ops *) arg;
230 /* Return a new cleanup that unpushes OPS. */
233 make_cleanup_unpush_target (struct target_ops *ops)
235 return make_cleanup (do_unpush_target, ops);
238 /* Helper for make_cleanup_value_free_to_mark. */
241 do_value_free_to_mark (void *value)
243 value_free_to_mark ((struct value *) value);
246 /* Free all values allocated since MARK was obtained by value_mark
247 (except for those released) when the cleanup is run. */
250 make_cleanup_value_free_to_mark (struct value *mark)
252 return make_cleanup (do_value_free_to_mark, mark);
255 /* Helper for make_cleanup_value_free. */
258 do_value_free (void *value)
260 value_free ((struct value *) value);
266 make_cleanup_value_free (struct value *value)
268 return make_cleanup (do_value_free, value);
271 /* Helper for make_cleanup_free_so. */
274 do_free_so (void *arg)
276 struct so_list *so = (struct so_list *) arg;
281 /* Make cleanup handler calling free_so for SO. */
284 make_cleanup_free_so (struct so_list *so)
286 return make_cleanup (do_free_so, so);
289 /* Helper for make_cleanup_restore_current_language. */
292 do_restore_current_language (void *p)
294 enum language saved_lang = (enum language) (uintptr_t) p;
296 set_language (saved_lang);
299 /* Remember the current value of CURRENT_LANGUAGE and make it restored when
300 the cleanup is run. */
303 make_cleanup_restore_current_language (void)
305 enum language saved_lang = current_language->la_language;
307 return make_cleanup (do_restore_current_language,
308 (void *) (uintptr_t) saved_lang);
311 /* Helper function for make_cleanup_clear_parser_state. */
314 do_clear_parser_state (void *ptr)
316 struct parser_state **p = (struct parser_state **) ptr;
321 /* Clean (i.e., set to NULL) the parser state variable P. */
324 make_cleanup_clear_parser_state (struct parser_state **p)
326 return make_cleanup (do_clear_parser_state, (void *) p);
329 /* This function is useful for cleanups.
333 old_chain = make_cleanup (free_current_contents, &foo);
335 to arrange to free the object thus allocated. */
338 free_current_contents (void *ptr)
340 void **location = (void **) ptr;
342 if (location == NULL)
343 internal_error (__FILE__, __LINE__,
344 _("free_current_contents: NULL pointer"));
345 if (*location != NULL)
354 /* Print a warning message. The first argument STRING is the warning
355 message, used as an fprintf format string, the second is the
356 va_list of arguments for that string. A warning is unfiltered (not
357 paginated) so that the user does not need to page through each
358 screen full of warnings when there are lots of them. */
361 vwarning (const char *string, va_list args)
363 if (deprecated_warning_hook)
364 (*deprecated_warning_hook) (string, args);
367 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
369 if (target_supports_terminal_ours ())
371 make_cleanup_restore_target_terminal ();
372 target_terminal_ours_for_output ();
374 if (filtered_printing_initialized ())
375 wrap_here (""); /* Force out any buffered output. */
376 gdb_flush (gdb_stdout);
377 if (warning_pre_print)
378 fputs_unfiltered (warning_pre_print, gdb_stderr);
379 vfprintf_unfiltered (gdb_stderr, string, args);
380 fprintf_unfiltered (gdb_stderr, "\n");
382 do_cleanups (old_chain);
386 /* Print an error message and return to command level.
387 The first argument STRING is the error message, used as a fprintf string,
388 and the remaining args are passed as arguments to it. */
391 verror (const char *string, va_list args)
393 throw_verror (GENERIC_ERROR, string, args);
397 error_stream (const string_file &stream)
399 error (("%s"), stream.c_str ());
402 /* Emit a message and abort. */
404 static void ATTRIBUTE_NORETURN
405 abort_with_message (const char *msg)
407 if (gdb_stderr == NULL)
410 fputs_unfiltered (msg, gdb_stderr);
412 abort (); /* NOTE: GDB has only three calls to abort(). */
415 /* Dump core trying to increase the core soft limit to hard limit first. */
420 #ifdef HAVE_SETRLIMIT
421 struct rlimit rlim = { RLIM_INFINITY, RLIM_INFINITY };
423 setrlimit (RLIMIT_CORE, &rlim);
424 #endif /* HAVE_SETRLIMIT */
426 abort (); /* NOTE: GDB has only three calls to abort(). */
429 /* Check whether GDB will be able to dump core using the dump_core
430 function. Returns zero if GDB cannot or should not dump core.
431 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
432 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
435 can_dump_core (enum resource_limit_kind limit_kind)
437 #ifdef HAVE_GETRLIMIT
440 /* Be quiet and assume we can dump if an error is returned. */
441 if (getrlimit (RLIMIT_CORE, &rlim) != 0)
447 if (rlim.rlim_cur == 0)
451 if (rlim.rlim_max == 0)
454 #endif /* HAVE_GETRLIMIT */
459 /* Print a warning that we cannot dump core. */
462 warn_cant_dump_core (const char *reason)
464 fprintf_unfiltered (gdb_stderr,
465 _("%s\nUnable to dump core, use `ulimit -c"
466 " unlimited' before executing GDB next time.\n"),
470 /* Check whether GDB will be able to dump core using the dump_core
471 function, and print a warning if we cannot. */
474 can_dump_core_warn (enum resource_limit_kind limit_kind,
477 int core_dump_allowed = can_dump_core (limit_kind);
479 if (!core_dump_allowed)
480 warn_cant_dump_core (reason);
482 return core_dump_allowed;
485 /* Allow the user to configure the debugger behavior with respect to
486 what to do when an internal problem is detected. */
488 const char internal_problem_ask[] = "ask";
489 const char internal_problem_yes[] = "yes";
490 const char internal_problem_no[] = "no";
491 static const char *const internal_problem_modes[] =
493 internal_problem_ask,
494 internal_problem_yes,
499 /* Print a message reporting an internal error/warning. Ask the user
500 if they want to continue, dump core, or just exit. Return
501 something to indicate a quit. */
503 struct internal_problem
506 int user_settable_should_quit;
507 const char *should_quit;
508 int user_settable_should_dump_core;
509 const char *should_dump_core;
512 /* Report a problem, internal to GDB, to the user. Once the problem
513 has been reported, and assuming GDB didn't quit, the caller can
514 either allow execution to resume or throw an error. */
516 static void ATTRIBUTE_PRINTF (4, 0)
517 internal_vproblem (struct internal_problem *problem,
518 const char *file, int line, const char *fmt, va_list ap)
524 struct cleanup *cleanup = make_cleanup (null_cleanup, NULL);
526 /* Don't allow infinite error/warning recursion. */
528 static char msg[] = "Recursive internal problem.\n";
537 abort_with_message (msg);
540 /* Newer GLIBC versions put the warn_unused_result attribute
541 on write, but this is one of those rare cases where
542 ignoring the return value is correct. Casting to (void)
543 does not fix this problem. This is the solution suggested
544 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
545 if (write (STDERR_FILENO, msg, sizeof (msg)) != sizeof (msg))
546 abort (); /* NOTE: GDB has only three calls to abort(). */
551 /* Create a string containing the full error/warning message. Need
552 to call query with this full string, as otherwize the reason
553 (error/warning) and question become separated. Format using a
554 style similar to a compiler error message. Include extra detail
555 so that the user knows that they are living on the edge. */
559 msg = xstrvprintf (fmt, ap);
560 reason = xstrprintf ("%s:%d: %s: %s\n"
561 "A problem internal to GDB has been detected,\n"
562 "further debugging may prove unreliable.",
563 file, line, problem->name, msg);
565 make_cleanup (xfree, reason);
568 /* Fall back to abort_with_message if gdb_stderr is not set up. */
569 if (gdb_stderr == NULL)
571 fputs (reason, stderr);
572 abort_with_message ("\n");
575 /* Try to get the message out and at the start of a new line. */
576 if (target_supports_terminal_ours ())
578 make_cleanup_restore_target_terminal ();
579 target_terminal_ours_for_output ();
581 if (filtered_printing_initialized ())
584 /* Emit the message unless query will emit it below. */
585 if (problem->should_quit != internal_problem_ask
587 || !filtered_printing_initialized ())
588 fprintf_unfiltered (gdb_stderr, "%s\n", reason);
590 if (problem->should_quit == internal_problem_ask)
592 /* Default (yes/batch case) is to quit GDB. When in batch mode
593 this lessens the likelihood of GDB going into an infinite
595 if (!confirm || !filtered_printing_initialized ())
598 quit_p = query (_("%s\nQuit this debugging session? "), reason);
600 else if (problem->should_quit == internal_problem_yes)
602 else if (problem->should_quit == internal_problem_no)
605 internal_error (__FILE__, __LINE__, _("bad switch"));
607 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr);
608 if (REPORT_BUGS_TO[0])
609 fprintf_unfiltered (gdb_stderr, _(" For instructions, see:\n%s."),
611 fputs_unfiltered ("\n\n", gdb_stderr);
613 if (problem->should_dump_core == internal_problem_ask)
615 if (!can_dump_core_warn (LIMIT_MAX, reason))
617 else if (!filtered_printing_initialized ())
621 /* Default (yes/batch case) is to dump core. This leaves a GDB
622 `dropping' so that it is easier to see that something went
624 dump_core_p = query (_("%s\nCreate a core file of GDB? "), reason);
627 else if (problem->should_dump_core == internal_problem_yes)
628 dump_core_p = can_dump_core_warn (LIMIT_MAX, reason);
629 else if (problem->should_dump_core == internal_problem_no)
632 internal_error (__FILE__, __LINE__, _("bad switch"));
645 #ifdef HAVE_WORKING_FORK
653 do_cleanups (cleanup);
656 static struct internal_problem internal_error_problem = {
657 "internal-error", 1, internal_problem_ask, 1, internal_problem_ask
661 internal_verror (const char *file, int line, const char *fmt, va_list ap)
663 internal_vproblem (&internal_error_problem, file, line, fmt, ap);
664 throw_quit (_("Command aborted."));
667 static struct internal_problem internal_warning_problem = {
668 "internal-warning", 1, internal_problem_ask, 1, internal_problem_ask
672 internal_vwarning (const char *file, int line, const char *fmt, va_list ap)
674 internal_vproblem (&internal_warning_problem, file, line, fmt, ap);
677 static struct internal_problem demangler_warning_problem = {
678 "demangler-warning", 1, internal_problem_ask, 0, internal_problem_no
682 demangler_vwarning (const char *file, int line, const char *fmt, va_list ap)
684 internal_vproblem (&demangler_warning_problem, file, line, fmt, ap);
688 demangler_warning (const char *file, int line, const char *string, ...)
692 va_start (ap, string);
693 demangler_vwarning (file, line, string, ap);
697 /* Dummy functions to keep add_prefix_cmd happy. */
700 set_internal_problem_cmd (char *args, int from_tty)
705 show_internal_problem_cmd (char *args, int from_tty)
709 /* When GDB reports an internal problem (error or warning) it gives
710 the user the opportunity to quit GDB and/or create a core file of
711 the current debug session. This function registers a few commands
712 that make it possible to specify that GDB should always or never
713 quit or create a core file, without asking. The commands look
716 maint set PROBLEM-NAME quit ask|yes|no
717 maint show PROBLEM-NAME quit
718 maint set PROBLEM-NAME corefile ask|yes|no
719 maint show PROBLEM-NAME corefile
721 Where PROBLEM-NAME is currently "internal-error" or
722 "internal-warning". */
725 add_internal_problem_command (struct internal_problem *problem)
727 struct cmd_list_element **set_cmd_list;
728 struct cmd_list_element **show_cmd_list;
732 set_cmd_list = XNEW (struct cmd_list_element *);
733 show_cmd_list = XNEW (struct cmd_list_element *);
734 *set_cmd_list = NULL;
735 *show_cmd_list = NULL;
737 set_doc = xstrprintf (_("Configure what GDB does when %s is detected."),
740 show_doc = xstrprintf (_("Show what GDB does when %s is detected."),
743 add_prefix_cmd ((char*) problem->name,
744 class_maintenance, set_internal_problem_cmd, set_doc,
746 concat ("maintenance set ", problem->name, " ",
748 0/*allow-unknown*/, &maintenance_set_cmdlist);
750 add_prefix_cmd ((char*) problem->name,
751 class_maintenance, show_internal_problem_cmd, show_doc,
753 concat ("maintenance show ", problem->name, " ",
755 0/*allow-unknown*/, &maintenance_show_cmdlist);
757 if (problem->user_settable_should_quit)
759 set_doc = xstrprintf (_("Set whether GDB should quit "
760 "when an %s is detected"),
762 show_doc = xstrprintf (_("Show whether GDB will quit "
763 "when an %s is detected"),
765 add_setshow_enum_cmd ("quit", class_maintenance,
766 internal_problem_modes,
767 &problem->should_quit,
780 if (problem->user_settable_should_dump_core)
782 set_doc = xstrprintf (_("Set whether GDB should create a core "
783 "file of GDB when %s is detected"),
785 show_doc = xstrprintf (_("Show whether GDB will create a core "
786 "file of GDB when %s is detected"),
788 add_setshow_enum_cmd ("corefile", class_maintenance,
789 internal_problem_modes,
790 &problem->should_dump_core,
804 /* Return a newly allocated string, containing the PREFIX followed
805 by the system error message for errno (separated by a colon).
807 The result must be deallocated after use. */
810 perror_string (const char *prefix)
815 err = safe_strerror (errno);
816 combined = (char *) xmalloc (strlen (err) + strlen (prefix) + 3);
817 strcpy (combined, prefix);
818 strcat (combined, ": ");
819 strcat (combined, err);
824 /* Print the system error message for errno, and also mention STRING
825 as the file name for which the error was encountered. Use ERRCODE
826 for the thrown exception. Then return to command level. */
829 throw_perror_with_name (enum errors errcode, const char *string)
833 combined = perror_string (string);
834 make_cleanup (xfree, combined);
836 /* I understand setting these is a matter of taste. Still, some people
837 may clear errno but not know about bfd_error. Doing this here is not
839 bfd_set_error (bfd_error_no_error);
842 throw_error (errcode, _("%s."), combined);
845 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
848 perror_with_name (const char *string)
850 throw_perror_with_name (GENERIC_ERROR, string);
853 /* Same as perror_with_name except that it prints a warning instead
854 of throwing an error. */
857 perror_warning_with_name (const char *string)
861 combined = perror_string (string);
862 warning (_("%s"), combined);
866 /* Print the system error message for ERRCODE, and also mention STRING
867 as the file name for which the error was encountered. */
870 print_sys_errmsg (const char *string, int errcode)
875 err = safe_strerror (errcode);
876 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
877 strcpy (combined, string);
878 strcat (combined, ": ");
879 strcat (combined, err);
881 /* We want anything which was printed on stdout to come out first, before
883 gdb_flush (gdb_stdout);
884 fprintf_unfiltered (gdb_stderr, "%s.\n", combined);
887 /* Control C eventually causes this to be called, at a convenient time. */
892 struct ui *ui = current_ui;
894 if (sync_quit_force_run)
896 sync_quit_force_run = 0;
897 quit_force (NULL, 0);
901 /* No steenking SIGINT will ever be coming our way when the
902 program is resumed. Don't lie. */
906 /* If there is no terminal switching for this target, then we can't
907 possibly get screwed by the lack of job control. */
908 || !target_supports_terminal_ours ())
911 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
920 if (sync_quit_force_run)
925 if (deprecated_interactive_hook)
926 deprecated_interactive_hook ();
930 /* Called when a memory allocation fails, with the number of bytes of
931 memory requested in SIZE. */
934 malloc_failure (long size)
938 internal_error (__FILE__, __LINE__,
939 _("virtual memory exhausted: can't allocate %ld bytes."),
944 internal_error (__FILE__, __LINE__, _("virtual memory exhausted."));
948 /* My replacement for the read system call.
949 Used like `read' but keeps going if `read' returns too soon. */
952 myread (int desc, char *addr, int len)
959 val = read (desc, addr, len);
971 print_spaces (int n, struct ui_file *file)
973 fputs_unfiltered (n_spaces (n), file);
976 /* Print a host address. */
979 gdb_print_host_address_1 (const void *addr, struct ui_file *stream)
981 fprintf_filtered (stream, "%s", host_address_to_string (addr));
987 make_hex_string (const gdb_byte *data, size_t length)
989 char *result = (char *) xmalloc (length * 2 + 1);
994 for (i = 0; i < length; ++i)
995 p += xsnprintf (p, 3, "%02x", data[i]);
1002 /* A cleanup that simply calls ui_unregister_input_event_handler. */
1005 ui_unregister_input_event_handler_cleanup (void *ui)
1007 ui_unregister_input_event_handler ((struct ui *) ui);
1010 /* Set up to handle input. */
1012 static struct cleanup *
1013 prepare_to_handle_input (void)
1015 struct cleanup *old_chain;
1017 old_chain = make_cleanup_restore_target_terminal ();
1018 target_terminal_ours ();
1020 ui_register_input_event_handler (current_ui);
1021 if (current_ui->prompt_state == PROMPT_BLOCKED)
1022 make_cleanup (ui_unregister_input_event_handler_cleanup, current_ui);
1024 make_cleanup_override_quit_handler (default_quit_handler);
1031 /* This function supports the query, nquery, and yquery functions.
1032 Ask user a y-or-n question and return 0 if answer is no, 1 if
1033 answer is yes, or default the answer to the specified default
1034 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1035 default answer, or '\0' for no default.
1036 CTLSTR is the control string and should end in "? ". It should
1037 not say how to answer, because we do that.
1038 ARGS are the arguments passed along with the CTLSTR argument to
1041 static int ATTRIBUTE_PRINTF (1, 0)
1042 defaulted_query (const char *ctlstr, const char defchar, va_list args)
1047 char def_answer, not_def_answer;
1048 const char *y_string, *n_string;
1049 char *question, *prompt;
1050 struct cleanup *old_chain;
1052 /* Set up according to which answer is the default. */
1053 if (defchar == '\0')
1057 not_def_answer = 'N';
1061 else if (defchar == 'y')
1065 not_def_answer = 'N';
1073 not_def_answer = 'Y';
1078 /* Automatically answer the default value if the user did not want
1079 prompts or the command was issued with the server prefix. */
1080 if (!confirm || server_command)
1083 /* If input isn't coming from the user directly, just say what
1084 question we're asking, and then answer the default automatically. This
1085 way, important error messages don't get lost when talking to GDB
1087 if (current_ui->instream != current_ui->stdin_stream
1088 || !input_interactive_p (current_ui)
1089 /* Restrict queries to the main UI. */
1090 || current_ui != main_ui)
1092 old_chain = make_cleanup_restore_target_terminal ();
1094 target_terminal_ours_for_output ();
1096 vfprintf_filtered (gdb_stdout, ctlstr, args);
1098 printf_filtered (_("(%s or %s) [answered %c; "
1099 "input not from terminal]\n"),
1100 y_string, n_string, def_answer);
1101 gdb_flush (gdb_stdout);
1103 do_cleanups (old_chain);
1107 if (deprecated_query_hook)
1111 old_chain = make_cleanup_restore_target_terminal ();
1112 res = deprecated_query_hook (ctlstr, args);
1113 do_cleanups (old_chain);
1117 /* Format the question outside of the loop, to avoid reusing args. */
1118 question = xstrvprintf (ctlstr, args);
1119 old_chain = make_cleanup (xfree, question);
1120 prompt = xstrprintf (_("%s%s(%s or %s) %s"),
1121 annotation_level > 1 ? "\n\032\032pre-query\n" : "",
1122 question, y_string, n_string,
1123 annotation_level > 1 ? "\n\032\032query\n" : "");
1124 make_cleanup (xfree, prompt);
1126 /* Used to add duration we waited for user to respond to
1127 prompt_for_continue_wait_time. */
1128 using namespace std::chrono;
1129 steady_clock::time_point prompt_started = steady_clock::now ();
1131 prepare_to_handle_input ();
1135 char *response, answer;
1137 gdb_flush (gdb_stdout);
1138 response = gdb_readline_wrapper (prompt);
1140 if (response == NULL) /* C-d */
1142 printf_filtered ("EOF [assumed %c]\n", def_answer);
1147 answer = response[0];
1152 /* Check answer. For the non-default, the user must specify
1153 the non-default explicitly. */
1154 if (answer == not_def_answer)
1156 retval = !def_value;
1159 /* Otherwise, if a default was specified, the user may either
1160 specify the required input or have it default by entering
1162 if (answer == def_answer
1163 || (defchar != '\0' && answer == '\0'))
1168 /* Invalid entries are not defaulted and require another selection. */
1169 printf_filtered (_("Please answer %s or %s.\n"),
1170 y_string, n_string);
1173 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1174 prompt_for_continue_wait_time += steady_clock::now () - prompt_started;
1176 if (annotation_level > 1)
1177 printf_filtered (("\n\032\032post-query\n"));
1178 do_cleanups (old_chain);
1183 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1184 answer is yes, or 0 if answer is defaulted.
1185 Takes three args which are given to printf to print the question.
1186 The first, a control string, should end in "? ".
1187 It should not say how to answer, because we do that. */
1190 nquery (const char *ctlstr, ...)
1195 va_start (args, ctlstr);
1196 ret = defaulted_query (ctlstr, 'n', args);
1201 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1202 answer is yes, or 1 if answer is defaulted.
1203 Takes three args which are given to printf to print the question.
1204 The first, a control string, should end in "? ".
1205 It should not say how to answer, because we do that. */
1208 yquery (const char *ctlstr, ...)
1213 va_start (args, ctlstr);
1214 ret = defaulted_query (ctlstr, 'y', args);
1219 /* Ask user a y-or-n question and return 1 iff answer is yes.
1220 Takes three args which are given to printf to print the question.
1221 The first, a control string, should end in "? ".
1222 It should not say how to answer, because we do that. */
1225 query (const char *ctlstr, ...)
1230 va_start (args, ctlstr);
1231 ret = defaulted_query (ctlstr, '\0', args);
1236 /* A helper for parse_escape that converts a host character to a
1237 target character. C is the host character. If conversion is
1238 possible, then the target character is stored in *TARGET_C and the
1239 function returns 1. Otherwise, the function returns 0. */
1242 host_char_to_target (struct gdbarch *gdbarch, int c, int *target_c)
1247 auto_obstack host_data;
1249 convert_between_encodings (target_charset (gdbarch), host_charset (),
1250 (gdb_byte *) &the_char, 1, 1,
1251 &host_data, translit_none);
1253 if (obstack_object_size (&host_data) == 1)
1256 *target_c = *(char *) obstack_base (&host_data);
1262 /* Parse a C escape sequence. STRING_PTR points to a variable
1263 containing a pointer to the string to parse. That pointer
1264 should point to the character after the \. That pointer
1265 is updated past the characters we use. The value of the
1266 escape sequence is returned.
1268 A negative value means the sequence \ newline was seen,
1269 which is supposed to be equivalent to nothing at all.
1271 If \ is followed by a null character, we return a negative
1272 value and leave the string pointer pointing at the null character.
1274 If \ is followed by 000, we return 0 and leave the string pointer
1275 after the zeros. A value of 0 does not mean end of string. */
1278 parse_escape (struct gdbarch *gdbarch, const char **string_ptr)
1280 int target_char = -2; /* Initialize to avoid GCC warnings. */
1281 int c = *(*string_ptr)++;
1300 int i = host_hex_value (c);
1305 if (isdigit (c) && c != '8' && c != '9')
1309 i += host_hex_value (c);
1345 if (!host_char_to_target (gdbarch, c, &target_char))
1346 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1347 " which has no equivalent\nin the `%s' character set."),
1348 c, c, target_charset (gdbarch));
1352 /* Print the character C on STREAM as part of the contents of a literal
1353 string whose delimiter is QUOTER. Note that this routine should only
1354 be called for printing things which are independent of the language
1355 of the program being debugged.
1357 printchar will normally escape backslashes and instances of QUOTER. If
1358 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1359 As a side effect, if you pass the backslash character as the QUOTER,
1360 printchar will escape backslashes as usual, but not any other quoting
1364 printchar (int c, void (*do_fputs) (const char *, struct ui_file *),
1365 void (*do_fprintf) (struct ui_file *, const char *, ...)
1366 ATTRIBUTE_FPTR_PRINTF_2, struct ui_file *stream, int quoter)
1368 c &= 0xFF; /* Avoid sign bit follies */
1370 if (c < 0x20 || /* Low control chars */
1371 (c >= 0x7F && c < 0xA0) || /* DEL, High controls */
1372 (sevenbit_strings && c >= 0x80))
1373 { /* high order bit set */
1377 do_fputs ("\\n", stream);
1380 do_fputs ("\\b", stream);
1383 do_fputs ("\\t", stream);
1386 do_fputs ("\\f", stream);
1389 do_fputs ("\\r", stream);
1392 do_fputs ("\\e", stream);
1395 do_fputs ("\\a", stream);
1398 do_fprintf (stream, "\\%.3o", (unsigned int) c);
1404 if (quoter != 0 && (c == '\\' || c == quoter))
1405 do_fputs ("\\", stream);
1406 do_fprintf (stream, "%c", c);
1410 /* Print the character C on STREAM as part of the contents of a
1411 literal string whose delimiter is QUOTER. Note that these routines
1412 should only be call for printing things which are independent of
1413 the language of the program being debugged. */
1416 fputstr_filtered (const char *str, int quoter, struct ui_file *stream)
1419 printchar (*str++, fputs_filtered, fprintf_filtered, stream, quoter);
1423 fputstr_unfiltered (const char *str, int quoter, struct ui_file *stream)
1426 printchar (*str++, fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1430 fputstrn_filtered (const char *str, int n, int quoter,
1431 struct ui_file *stream)
1435 for (i = 0; i < n; i++)
1436 printchar (str[i], fputs_filtered, fprintf_filtered, stream, quoter);
1440 fputstrn_unfiltered (const char *str, int n, int quoter,
1441 struct ui_file *stream)
1445 for (i = 0; i < n; i++)
1446 printchar (str[i], fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1450 /* Number of lines per page or UINT_MAX if paging is disabled. */
1451 static unsigned int lines_per_page;
1453 show_lines_per_page (struct ui_file *file, int from_tty,
1454 struct cmd_list_element *c, const char *value)
1456 fprintf_filtered (file,
1457 _("Number of lines gdb thinks are in a page is %s.\n"),
1461 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1462 static unsigned int chars_per_line;
1464 show_chars_per_line (struct ui_file *file, int from_tty,
1465 struct cmd_list_element *c, const char *value)
1467 fprintf_filtered (file,
1468 _("Number of characters gdb thinks "
1469 "are in a line is %s.\n"),
1473 /* Current count of lines printed on this page, chars on this line. */
1474 static unsigned int lines_printed, chars_printed;
1476 /* Buffer and start column of buffered text, for doing smarter word-
1477 wrapping. When someone calls wrap_here(), we start buffering output
1478 that comes through fputs_filtered(). If we see a newline, we just
1479 spit it out and forget about the wrap_here(). If we see another
1480 wrap_here(), we spit it out and remember the newer one. If we see
1481 the end of the line, we spit out a newline, the indent, and then
1482 the buffered output. */
1484 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1485 are waiting to be output (they have already been counted in chars_printed).
1486 When wrap_buffer[0] is null, the buffer is empty. */
1487 static char *wrap_buffer;
1489 /* Pointer in wrap_buffer to the next character to fill. */
1490 static char *wrap_pointer;
1492 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1494 static const char *wrap_indent;
1496 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1497 is not in effect. */
1498 static int wrap_column;
1501 /* Initialize the number of lines per page and chars per line. */
1504 init_page_info (void)
1508 lines_per_page = UINT_MAX;
1509 chars_per_line = UINT_MAX;
1513 if (!tui_get_command_dimension (&chars_per_line, &lines_per_page))
1518 #if defined(__GO32__)
1519 rows = ScreenRows ();
1520 cols = ScreenCols ();
1521 lines_per_page = rows;
1522 chars_per_line = cols;
1524 /* Make sure Readline has initialized its terminal settings. */
1525 rl_reset_terminal (NULL);
1527 /* Get the screen size from Readline. */
1528 rl_get_screen_size (&rows, &cols);
1529 lines_per_page = rows;
1530 chars_per_line = cols;
1532 /* Readline should have fetched the termcap entry for us.
1533 Only try to use tgetnum function if rl_get_screen_size
1534 did not return a useful value. */
1535 if (((rows <= 0) && (tgetnum ((char *) "li") < 0))
1536 /* Also disable paging if inside Emacs. $EMACS was used
1537 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1538 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1540 /* The number of lines per page is not mentioned in the terminal
1541 description or EMACS evironment variable is set. This probably
1542 means that paging is not useful, so disable paging. */
1543 lines_per_page = UINT_MAX;
1546 /* If the output is not a terminal, don't paginate it. */
1547 if (!ui_file_isatty (gdb_stdout))
1548 lines_per_page = UINT_MAX;
1552 /* We handle SIGWINCH ourselves. */
1553 rl_catch_sigwinch = 0;
1559 /* Return nonzero if filtered printing is initialized. */
1561 filtered_printing_initialized (void)
1563 return wrap_buffer != NULL;
1566 /* Helper for make_cleanup_restore_page_info. */
1569 do_restore_page_info_cleanup (void *arg)
1575 /* Provide cleanup for restoring the terminal size. */
1578 make_cleanup_restore_page_info (void)
1580 struct cleanup *back_to;
1582 back_to = make_cleanup (do_restore_page_info_cleanup, NULL);
1583 make_cleanup_restore_uinteger (&lines_per_page);
1584 make_cleanup_restore_uinteger (&chars_per_line);
1589 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1590 Provide cleanup for restoring the original state. */
1593 set_batch_flag_and_make_cleanup_restore_page_info (void)
1595 struct cleanup *back_to = make_cleanup_restore_page_info ();
1597 make_cleanup_restore_integer (&batch_flag);
1604 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1607 set_screen_size (void)
1609 int rows = lines_per_page;
1610 int cols = chars_per_line;
1618 /* Update Readline's idea of the terminal size. */
1619 rl_set_screen_size (rows, cols);
1622 /* Reinitialize WRAP_BUFFER according to the current value of
1628 if (chars_per_line == 0)
1633 wrap_buffer = (char *) xmalloc (chars_per_line + 2);
1634 wrap_buffer[0] = '\0';
1637 wrap_buffer = (char *) xrealloc (wrap_buffer, chars_per_line + 2);
1638 wrap_pointer = wrap_buffer; /* Start it at the beginning. */
1642 set_width_command (char *args, int from_tty, struct cmd_list_element *c)
1649 set_height_command (char *args, int from_tty, struct cmd_list_element *c)
1657 set_screen_width_and_height (int width, int height)
1659 lines_per_page = height;
1660 chars_per_line = width;
1666 /* Wait, so the user can read what's on the screen. Prompt the user
1667 to continue by pressing RETURN. 'q' is also provided because
1668 telling users what to do in the prompt is more user-friendly than
1669 expecting them to think of Ctrl-C/SIGINT. */
1672 prompt_for_continue (void)
1675 char cont_prompt[120];
1676 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
1677 /* Used to add duration we waited for user to respond to
1678 prompt_for_continue_wait_time. */
1679 using namespace std::chrono;
1680 steady_clock::time_point prompt_started = steady_clock::now ();
1682 if (annotation_level > 1)
1683 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1685 strcpy (cont_prompt,
1686 "---Type <return> to continue, or q <return> to quit---");
1687 if (annotation_level > 1)
1688 strcat (cont_prompt, "\n\032\032prompt-for-continue\n");
1690 /* We must do this *before* we call gdb_readline_wrapper, else it
1691 will eventually call us -- thinking that we're trying to print
1692 beyond the end of the screen. */
1693 reinitialize_more_filter ();
1695 prepare_to_handle_input ();
1697 /* Call gdb_readline_wrapper, not readline, in order to keep an
1698 event loop running. */
1699 ignore = gdb_readline_wrapper (cont_prompt);
1700 make_cleanup (xfree, ignore);
1702 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1703 prompt_for_continue_wait_time += steady_clock::now () - prompt_started;
1705 if (annotation_level > 1)
1706 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1712 while (*p == ' ' || *p == '\t')
1715 /* Do not call quit here; there is no possibility of SIGINT. */
1716 throw_quit ("Quit");
1719 /* Now we have to do this again, so that GDB will know that it doesn't
1720 need to save the ---Type <return>--- line at the top of the screen. */
1721 reinitialize_more_filter ();
1723 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1725 do_cleanups (old_chain);
1728 /* Initialize timer to keep track of how long we waited for the user. */
1731 reset_prompt_for_continue_wait_time (void)
1733 using namespace std::chrono;
1735 prompt_for_continue_wait_time = steady_clock::duration::zero ();
1738 /* Fetch the cumulative time spent in prompt_for_continue. */
1740 std::chrono::steady_clock::duration
1741 get_prompt_for_continue_wait_time ()
1743 return prompt_for_continue_wait_time;
1746 /* Reinitialize filter; ie. tell it to reset to original values. */
1749 reinitialize_more_filter (void)
1755 /* Indicate that if the next sequence of characters overflows the line,
1756 a newline should be inserted here rather than when it hits the end.
1757 If INDENT is non-null, it is a string to be printed to indent the
1758 wrapped part on the next line. INDENT must remain accessible until
1759 the next call to wrap_here() or until a newline is printed through
1762 If the line is already overfull, we immediately print a newline and
1763 the indentation, and disable further wrapping.
1765 If we don't know the width of lines, but we know the page height,
1766 we must not wrap words, but should still keep track of newlines
1767 that were explicitly printed.
1769 INDENT should not contain tabs, as that will mess up the char count
1770 on the next line. FIXME.
1772 This routine is guaranteed to force out any output which has been
1773 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1774 used to force out output from the wrap_buffer. */
1777 wrap_here (const char *indent)
1779 /* This should have been allocated, but be paranoid anyway. */
1781 internal_error (__FILE__, __LINE__,
1782 _("failed internal consistency check"));
1786 *wrap_pointer = '\0';
1787 fputs_unfiltered (wrap_buffer, gdb_stdout);
1789 wrap_pointer = wrap_buffer;
1790 wrap_buffer[0] = '\0';
1791 if (chars_per_line == UINT_MAX) /* No line overflow checking. */
1795 else if (chars_printed >= chars_per_line)
1797 puts_filtered ("\n");
1799 puts_filtered (indent);
1804 wrap_column = chars_printed;
1808 wrap_indent = indent;
1812 /* Print input string to gdb_stdout, filtered, with wrap,
1813 arranging strings in columns of n chars. String can be
1814 right or left justified in the column. Never prints
1815 trailing spaces. String should never be longer than
1816 width. FIXME: this could be useful for the EXAMINE
1817 command, which currently doesn't tabulate very well. */
1820 puts_filtered_tabular (char *string, int width, int right)
1826 gdb_assert (chars_per_line > 0);
1827 if (chars_per_line == UINT_MAX)
1829 fputs_filtered (string, gdb_stdout);
1830 fputs_filtered ("\n", gdb_stdout);
1834 if (((chars_printed - 1) / width + 2) * width >= chars_per_line)
1835 fputs_filtered ("\n", gdb_stdout);
1837 if (width >= chars_per_line)
1838 width = chars_per_line - 1;
1840 stringlen = strlen (string);
1842 if (chars_printed > 0)
1843 spaces = width - (chars_printed - 1) % width - 1;
1845 spaces += width - stringlen;
1847 spacebuf = (char *) alloca (spaces + 1);
1848 spacebuf[spaces] = '\0';
1850 spacebuf[spaces] = ' ';
1852 fputs_filtered (spacebuf, gdb_stdout);
1853 fputs_filtered (string, gdb_stdout);
1857 /* Ensure that whatever gets printed next, using the filtered output
1858 commands, starts at the beginning of the line. I.e. if there is
1859 any pending output for the current line, flush it and start a new
1860 line. Otherwise do nothing. */
1865 if (chars_printed > 0)
1867 puts_filtered ("\n");
1872 /* Like fputs but if FILTER is true, pause after every screenful.
1874 Regardless of FILTER can wrap at points other than the final
1875 character of a line.
1877 Unlike fputs, fputs_maybe_filtered does not return a value.
1878 It is OK for LINEBUFFER to be NULL, in which case just don't print
1881 Note that a longjmp to top level may occur in this routine (only if
1882 FILTER is true) (since prompt_for_continue may do so) so this
1883 routine should not be called when cleanups are not in place. */
1886 fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
1889 const char *lineptr;
1891 if (linebuffer == 0)
1894 /* Don't do any filtering if it is disabled. */
1895 if (stream != gdb_stdout
1896 || !pagination_enabled
1898 || (lines_per_page == UINT_MAX && chars_per_line == UINT_MAX)
1899 || top_level_interpreter () == NULL
1900 || interp_ui_out (top_level_interpreter ())->is_mi_like_p ())
1902 fputs_unfiltered (linebuffer, stream);
1906 /* Go through and output each character. Show line extension
1907 when this is necessary; prompt user for new page when this is
1910 lineptr = linebuffer;
1913 /* Possible new page. */
1914 if (filter && (lines_printed >= lines_per_page - 1))
1915 prompt_for_continue ();
1917 while (*lineptr && *lineptr != '\n')
1919 /* Print a single line. */
1920 if (*lineptr == '\t')
1923 *wrap_pointer++ = '\t';
1925 fputc_unfiltered ('\t', stream);
1926 /* Shifting right by 3 produces the number of tab stops
1927 we have already passed, and then adding one and
1928 shifting left 3 advances to the next tab stop. */
1929 chars_printed = ((chars_printed >> 3) + 1) << 3;
1935 *wrap_pointer++ = *lineptr;
1937 fputc_unfiltered (*lineptr, stream);
1942 if (chars_printed >= chars_per_line)
1944 unsigned int save_chars = chars_printed;
1948 /* If we aren't actually wrapping, don't output newline --
1949 if chars_per_line is right, we probably just overflowed
1950 anyway; if it's wrong, let us keep going. */
1952 fputc_unfiltered ('\n', stream);
1954 /* Possible new page. */
1955 if (lines_printed >= lines_per_page - 1)
1956 prompt_for_continue ();
1958 /* Now output indentation and wrapped string. */
1961 fputs_unfiltered (wrap_indent, stream);
1962 *wrap_pointer = '\0'; /* Null-terminate saved stuff, */
1963 fputs_unfiltered (wrap_buffer, stream); /* and eject it. */
1964 /* FIXME, this strlen is what prevents wrap_indent from
1965 containing tabs. However, if we recurse to print it
1966 and count its chars, we risk trouble if wrap_indent is
1967 longer than (the user settable) chars_per_line.
1968 Note also that this can set chars_printed > chars_per_line
1969 if we are printing a long string. */
1970 chars_printed = strlen (wrap_indent)
1971 + (save_chars - wrap_column);
1972 wrap_pointer = wrap_buffer; /* Reset buffer */
1973 wrap_buffer[0] = '\0';
1974 wrap_column = 0; /* And disable fancy wrap */
1979 if (*lineptr == '\n')
1982 wrap_here ((char *) 0); /* Spit out chars, cancel
1985 fputc_unfiltered ('\n', stream);
1992 fputs_filtered (const char *linebuffer, struct ui_file *stream)
1994 fputs_maybe_filtered (linebuffer, stream, 1);
1998 putchar_unfiltered (int c)
2002 ui_file_write (gdb_stdout, &buf, 1);
2006 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2007 May return nonlocally. */
2010 putchar_filtered (int c)
2012 return fputc_filtered (c, gdb_stdout);
2016 fputc_unfiltered (int c, struct ui_file *stream)
2020 ui_file_write (stream, &buf, 1);
2025 fputc_filtered (int c, struct ui_file *stream)
2031 fputs_filtered (buf, stream);
2035 /* puts_debug is like fputs_unfiltered, except it prints special
2036 characters in printable fashion. */
2039 puts_debug (char *prefix, char *string, char *suffix)
2043 /* Print prefix and suffix after each line. */
2044 static int new_line = 1;
2045 static int return_p = 0;
2046 static const char *prev_prefix = "";
2047 static const char *prev_suffix = "";
2049 if (*string == '\n')
2052 /* If the prefix is changing, print the previous suffix, a new line,
2053 and the new prefix. */
2054 if ((return_p || (strcmp (prev_prefix, prefix) != 0)) && !new_line)
2056 fputs_unfiltered (prev_suffix, gdb_stdlog);
2057 fputs_unfiltered ("\n", gdb_stdlog);
2058 fputs_unfiltered (prefix, gdb_stdlog);
2061 /* Print prefix if we printed a newline during the previous call. */
2065 fputs_unfiltered (prefix, gdb_stdlog);
2068 prev_prefix = prefix;
2069 prev_suffix = suffix;
2071 /* Output characters in a printable format. */
2072 while ((ch = *string++) != '\0')
2078 fputc_unfiltered (ch, gdb_stdlog);
2081 fprintf_unfiltered (gdb_stdlog, "\\x%02x", ch & 0xff);
2085 fputs_unfiltered ("\\\\", gdb_stdlog);
2088 fputs_unfiltered ("\\b", gdb_stdlog);
2091 fputs_unfiltered ("\\f", gdb_stdlog);
2095 fputs_unfiltered ("\\n", gdb_stdlog);
2098 fputs_unfiltered ("\\r", gdb_stdlog);
2101 fputs_unfiltered ("\\t", gdb_stdlog);
2104 fputs_unfiltered ("\\v", gdb_stdlog);
2108 return_p = ch == '\r';
2111 /* Print suffix if we printed a newline. */
2114 fputs_unfiltered (suffix, gdb_stdlog);
2115 fputs_unfiltered ("\n", gdb_stdlog);
2120 /* Print a variable number of ARGS using format FORMAT. If this
2121 information is going to put the amount written (since the last call
2122 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2123 call prompt_for_continue to get the users permision to continue.
2125 Unlike fprintf, this function does not return a value.
2127 We implement three variants, vfprintf (takes a vararg list and stream),
2128 fprintf (takes a stream to write on), and printf (the usual).
2130 Note also that a longjmp to top level may occur in this routine
2131 (since prompt_for_continue may do so) so this routine should not be
2132 called when cleanups are not in place. */
2135 vfprintf_maybe_filtered (struct ui_file *stream, const char *format,
2136 va_list args, int filter)
2139 struct cleanup *old_cleanups;
2141 linebuffer = xstrvprintf (format, args);
2142 old_cleanups = make_cleanup (xfree, linebuffer);
2143 fputs_maybe_filtered (linebuffer, stream, filter);
2144 do_cleanups (old_cleanups);
2149 vfprintf_filtered (struct ui_file *stream, const char *format, va_list args)
2151 vfprintf_maybe_filtered (stream, format, args, 1);
2155 vfprintf_unfiltered (struct ui_file *stream, const char *format, va_list args)
2158 struct cleanup *old_cleanups;
2160 linebuffer = xstrvprintf (format, args);
2161 old_cleanups = make_cleanup (xfree, linebuffer);
2162 if (debug_timestamp && stream == gdb_stdlog)
2164 using namespace std::chrono;
2167 steady_clock::time_point now = steady_clock::now ();
2168 seconds s = duration_cast<seconds> (now.time_since_epoch ());
2169 microseconds us = duration_cast<microseconds> (now.time_since_epoch () - s);
2171 len = strlen (linebuffer);
2172 need_nl = (len > 0 && linebuffer[len - 1] != '\n');
2174 std::string timestamp = string_printf ("%ld.%06ld %s%s",
2177 linebuffer, need_nl ? "\n": "");
2178 fputs_unfiltered (timestamp.c_str (), stream);
2181 fputs_unfiltered (linebuffer, stream);
2182 do_cleanups (old_cleanups);
2186 vprintf_filtered (const char *format, va_list args)
2188 vfprintf_maybe_filtered (gdb_stdout, format, args, 1);
2192 vprintf_unfiltered (const char *format, va_list args)
2194 vfprintf_unfiltered (gdb_stdout, format, args);
2198 fprintf_filtered (struct ui_file *stream, const char *format, ...)
2202 va_start (args, format);
2203 vfprintf_filtered (stream, format, args);
2208 fprintf_unfiltered (struct ui_file *stream, const char *format, ...)
2212 va_start (args, format);
2213 vfprintf_unfiltered (stream, format, args);
2217 /* Like fprintf_filtered, but prints its result indented.
2218 Called as fprintfi_filtered (spaces, stream, format, ...); */
2221 fprintfi_filtered (int spaces, struct ui_file *stream, const char *format,
2226 va_start (args, format);
2227 print_spaces_filtered (spaces, stream);
2229 vfprintf_filtered (stream, format, args);
2235 printf_filtered (const char *format, ...)
2239 va_start (args, format);
2240 vfprintf_filtered (gdb_stdout, format, args);
2246 printf_unfiltered (const char *format, ...)
2250 va_start (args, format);
2251 vfprintf_unfiltered (gdb_stdout, format, args);
2255 /* Like printf_filtered, but prints it's result indented.
2256 Called as printfi_filtered (spaces, format, ...); */
2259 printfi_filtered (int spaces, const char *format, ...)
2263 va_start (args, format);
2264 print_spaces_filtered (spaces, gdb_stdout);
2265 vfprintf_filtered (gdb_stdout, format, args);
2269 /* Easy -- but watch out!
2271 This routine is *not* a replacement for puts()! puts() appends a newline.
2272 This one doesn't, and had better not! */
2275 puts_filtered (const char *string)
2277 fputs_filtered (string, gdb_stdout);
2281 puts_unfiltered (const char *string)
2283 fputs_unfiltered (string, gdb_stdout);
2286 /* Return a pointer to N spaces and a null. The pointer is good
2287 until the next call to here. */
2292 static char *spaces = 0;
2293 static int max_spaces = -1;
2299 spaces = (char *) xmalloc (n + 1);
2300 for (t = spaces + n; t != spaces;)
2306 return spaces + max_spaces - n;
2309 /* Print N spaces. */
2311 print_spaces_filtered (int n, struct ui_file *stream)
2313 fputs_filtered (n_spaces (n), stream);
2316 /* C++/ObjC demangler stuff. */
2318 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2319 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2320 If the name is not mangled, or the language for the name is unknown, or
2321 demangling is off, the name is printed in its "raw" form. */
2324 fprintf_symbol_filtered (struct ui_file *stream, const char *name,
2325 enum language lang, int arg_mode)
2331 /* If user wants to see raw output, no problem. */
2334 fputs_filtered (name, stream);
2338 demangled = language_demangle (language_def (lang), name, arg_mode);
2339 fputs_filtered (demangled ? demangled : name, stream);
2340 if (demangled != NULL)
2348 /* Modes of operation for strncmp_iw_with_mode. */
2350 enum class strncmp_iw_mode
2352 /* Work like strncmp, while ignoring whitespace. */
2355 /* Like NORMAL, but also apply the strcmp_iw hack. I.e.,
2356 string1=="FOO(PARAMS)" matches string2=="FOO". */
2360 /* Helper for strncmp_iw and strcmp_iw. */
2363 strncmp_iw_with_mode (const char *string1, const char *string2,
2364 size_t string2_len, strncmp_iw_mode mode)
2366 const char *end_str2 = string2 + string2_len;
2370 while (isspace (*string1))
2372 while (string2 < end_str2 && isspace (*string2))
2374 if (*string1 == '\0' || string2 == end_str2)
2376 if (case_sensitivity == case_sensitive_on && *string1 != *string2)
2378 if (case_sensitivity == case_sensitive_off
2379 && (tolower ((unsigned char) *string1)
2380 != tolower ((unsigned char) *string2)))
2387 if (string2 == end_str2)
2389 if (mode == strncmp_iw_mode::NORMAL)
2392 return (*string1 != '\0' && *string1 != '(');
2401 strncmp_iw (const char *string1, const char *string2, size_t string2_len)
2403 return strncmp_iw_with_mode (string1, string2, string2_len,
2404 strncmp_iw_mode::NORMAL);
2410 strcmp_iw (const char *string1, const char *string2)
2412 return strncmp_iw_with_mode (string1, string2, strlen (string2),
2413 strncmp_iw_mode::MATCH_PARAMS);
2416 /* This is like strcmp except that it ignores whitespace and treats
2417 '(' as the first non-NULL character in terms of ordering. Like
2418 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2419 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2420 according to that ordering.
2422 If a list is sorted according to this function and if you want to
2423 find names in the list that match some fixed NAME according to
2424 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2425 where this function would put NAME.
2427 This function must be neutral to the CASE_SENSITIVITY setting as the user
2428 may choose it during later lookup. Therefore this function always sorts
2429 primarily case-insensitively and secondarily case-sensitively.
2431 Here are some examples of why using strcmp to sort is a bad idea:
2435 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2436 we try to do a search for "foo<char*>", strcmp will locate this
2437 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2438 will start looking at strings beginning with "goo", and will never
2439 see the correct match of "foo<char *>".
2441 Parenthesis example:
2443 In practice, this is less like to be an issue, but I'll give it a
2444 shot. Let's assume that '$' is a legitimate character to occur in
2445 symbols. (Which may well even be the case on some systems.) Then
2446 say that the partial symbol table contains "foo$" and "foo(int)".
2447 strcmp will put them in this order, since '$' < '('. Now, if the
2448 user searches for "foo", then strcmp will sort "foo" before "foo$".
2449 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2450 "foo") is false, so it won't proceed to the actual match of
2451 "foo(int)" with "foo". */
2454 strcmp_iw_ordered (const char *string1, const char *string2)
2456 const char *saved_string1 = string1, *saved_string2 = string2;
2457 enum case_sensitivity case_pass = case_sensitive_off;
2461 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2462 Provide stub characters if we are already at the end of one of the
2464 char c1 = 'X', c2 = 'X';
2466 while (*string1 != '\0' && *string2 != '\0')
2468 while (isspace (*string1))
2470 while (isspace (*string2))
2475 case case_sensitive_off:
2476 c1 = tolower ((unsigned char) *string1);
2477 c2 = tolower ((unsigned char) *string2);
2479 case case_sensitive_on:
2487 if (*string1 != '\0')
2496 /* Characters are non-equal unless they're both '\0'; we want to
2497 make sure we get the comparison right according to our
2498 comparison in the cases where one of them is '\0' or '('. */
2500 if (*string2 == '\0')
2505 if (*string2 == '\0')
2510 if (*string2 == '\0' || *string2 == '(')
2519 if (case_pass == case_sensitive_on)
2522 /* Otherwise the strings were equal in case insensitive way, make
2523 a more fine grained comparison in a case sensitive way. */
2525 case_pass = case_sensitive_on;
2526 string1 = saved_string1;
2527 string2 = saved_string2;
2531 /* A simple comparison function with opposite semantics to strcmp. */
2534 streq (const char *lhs, const char *rhs)
2536 return !strcmp (lhs, rhs);
2542 ** Answer whether string_to_compare is a full or partial match to
2543 ** template_string. The partial match must be in sequence starting
2547 subset_compare (const char *string_to_compare, const char *template_string)
2551 if (template_string != (char *) NULL && string_to_compare != (char *) NULL
2552 && strlen (string_to_compare) <= strlen (template_string))
2554 (startswith (template_string, string_to_compare));
2561 show_debug_timestamp (struct ui_file *file, int from_tty,
2562 struct cmd_list_element *c, const char *value)
2564 fprintf_filtered (file, _("Timestamping debugging messages is %s.\n"),
2570 initialize_utils (void)
2572 add_setshow_uinteger_cmd ("width", class_support, &chars_per_line, _("\
2573 Set number of characters where GDB should wrap lines of its output."), _("\
2574 Show number of characters where GDB should wrap lines of its output."), _("\
2575 This affects where GDB wraps its output to fit the screen width.\n\
2576 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2578 show_chars_per_line,
2579 &setlist, &showlist);
2581 add_setshow_uinteger_cmd ("height", class_support, &lines_per_page, _("\
2582 Set number of lines in a page for GDB output pagination."), _("\
2583 Show number of lines in a page for GDB output pagination."), _("\
2584 This affects the number of lines after which GDB will pause\n\
2585 its output and ask you whether to continue.\n\
2586 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2588 show_lines_per_page,
2589 &setlist, &showlist);
2591 add_setshow_boolean_cmd ("pagination", class_support,
2592 &pagination_enabled, _("\
2593 Set state of GDB output pagination."), _("\
2594 Show state of GDB output pagination."), _("\
2595 When pagination is ON, GDB pauses at end of each screenful of\n\
2596 its output and asks you whether to continue.\n\
2597 Turning pagination off is an alternative to \"set height unlimited\"."),
2599 show_pagination_enabled,
2600 &setlist, &showlist);
2602 add_setshow_boolean_cmd ("sevenbit-strings", class_support,
2603 &sevenbit_strings, _("\
2604 Set printing of 8-bit characters in strings as \\nnn."), _("\
2605 Show printing of 8-bit characters in strings as \\nnn."), NULL,
2607 show_sevenbit_strings,
2608 &setprintlist, &showprintlist);
2610 add_setshow_boolean_cmd ("timestamp", class_maintenance,
2611 &debug_timestamp, _("\
2612 Set timestamping of debugging messages."), _("\
2613 Show timestamping of debugging messages."), _("\
2614 When set, debugging messages will be marked with seconds and microseconds."),
2616 show_debug_timestamp,
2617 &setdebuglist, &showdebuglist);
2621 paddress (struct gdbarch *gdbarch, CORE_ADDR addr)
2623 /* Truncate address to the size of a target address, avoiding shifts
2624 larger or equal than the width of a CORE_ADDR. The local
2625 variable ADDR_BIT stops the compiler reporting a shift overflow
2626 when it won't occur. */
2627 /* NOTE: This assumes that the significant address information is
2628 kept in the least significant bits of ADDR - the upper bits were
2629 either zero or sign extended. Should gdbarch_address_to_pointer or
2630 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2632 int addr_bit = gdbarch_addr_bit (gdbarch);
2634 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2635 addr &= ((CORE_ADDR) 1 << addr_bit) - 1;
2636 return hex_string (addr);
2639 /* This function is described in "defs.h". */
2642 print_core_address (struct gdbarch *gdbarch, CORE_ADDR address)
2644 int addr_bit = gdbarch_addr_bit (gdbarch);
2646 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2647 address &= ((CORE_ADDR) 1 << addr_bit) - 1;
2649 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2650 that returns the language localized string formatted to a width
2651 based on gdbarch_addr_bit. */
2653 return hex_string_custom (address, 8);
2655 return hex_string_custom (address, 16);
2658 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2661 core_addr_hash (const void *ap)
2663 const CORE_ADDR *addrp = (const CORE_ADDR *) ap;
2668 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2671 core_addr_eq (const void *ap, const void *bp)
2673 const CORE_ADDR *addr_ap = (const CORE_ADDR *) ap;
2674 const CORE_ADDR *addr_bp = (const CORE_ADDR *) bp;
2676 return *addr_ap == *addr_bp;
2679 /* Convert a string back into a CORE_ADDR. */
2681 string_to_core_addr (const char *my_string)
2685 if (my_string[0] == '0' && tolower (my_string[1]) == 'x')
2687 /* Assume that it is in hex. */
2690 for (i = 2; my_string[i] != '\0'; i++)
2692 if (isdigit (my_string[i]))
2693 addr = (my_string[i] - '0') + (addr * 16);
2694 else if (isxdigit (my_string[i]))
2695 addr = (tolower (my_string[i]) - 'a' + 0xa) + (addr * 16);
2697 error (_("invalid hex \"%s\""), my_string);
2702 /* Assume that it is in decimal. */
2705 for (i = 0; my_string[i] != '\0'; i++)
2707 if (isdigit (my_string[i]))
2708 addr = (my_string[i] - '0') + (addr * 10);
2710 error (_("invalid decimal \"%s\""), my_string);
2718 gdb_realpath (const char *filename)
2720 /* On most hosts, we rely on canonicalize_file_name to compute
2721 the FILENAME's realpath.
2723 But the situation is slightly more complex on Windows, due to some
2724 versions of GCC which were reported to generate paths where
2725 backlashes (the directory separator) were doubled. For instance:
2726 c:\\some\\double\\slashes\\dir
2728 c:\some\double\slashes\dir
2729 Those double-slashes were getting in the way when comparing paths,
2730 for instance when trying to insert a breakpoint as follow:
2731 (gdb) b c:/some/double/slashes/dir/foo.c:4
2732 No source file named c:/some/double/slashes/dir/foo.c:4.
2733 (gdb) b c:\some\double\slashes\dir\foo.c:4
2734 No source file named c:\some\double\slashes\dir\foo.c:4.
2735 To prevent this from happening, we need this function to always
2736 strip those extra backslashes. While canonicalize_file_name does
2737 perform this simplification, it only works when the path is valid.
2738 Since the simplification would be useful even if the path is not
2739 valid (one can always set a breakpoint on a file, even if the file
2740 does not exist locally), we rely instead on GetFullPathName to
2741 perform the canonicalization. */
2743 #if defined (_WIN32)
2746 DWORD len = GetFullPathName (filename, MAX_PATH, buf, NULL);
2748 /* The file system is case-insensitive but case-preserving.
2749 So it is important we do not lowercase the path. Otherwise,
2750 we might not be able to display the original casing in a given
2752 if (len > 0 && len < MAX_PATH)
2753 return xstrdup (buf);
2757 char *rp = canonicalize_file_name (filename);
2764 /* This system is a lost cause, just dup the buffer. */
2765 return xstrdup (filename);
2768 /* Return a copy of FILENAME, with its directory prefix canonicalized
2772 gdb_realpath_keepfile (const char *filename)
2774 const char *base_name = lbasename (filename);
2779 /* Extract the basename of filename, and return immediately
2780 a copy of filename if it does not contain any directory prefix. */
2781 if (base_name == filename)
2782 return xstrdup (filename);
2784 dir_name = (char *) alloca ((size_t) (base_name - filename + 2));
2785 /* Allocate enough space to store the dir_name + plus one extra
2786 character sometimes needed under Windows (see below), and
2787 then the closing \000 character. */
2788 strncpy (dir_name, filename, base_name - filename);
2789 dir_name[base_name - filename] = '\000';
2791 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
2792 /* We need to be careful when filename is of the form 'd:foo', which
2793 is equivalent of d:./foo, which is totally different from d:/foo. */
2794 if (strlen (dir_name) == 2 && isalpha (dir_name[0]) && dir_name[1] == ':')
2797 dir_name[3] = '\000';
2801 /* Canonicalize the directory prefix, and build the resulting
2802 filename. If the dirname realpath already contains an ending
2803 directory separator, avoid doubling it. */
2804 real_path = gdb_realpath (dir_name);
2805 if (IS_DIR_SEPARATOR (real_path[strlen (real_path) - 1]))
2806 result = concat (real_path, base_name, (char *) NULL);
2808 result = concat (real_path, SLASH_STRING, base_name, (char *) NULL);
2814 /* Return PATH in absolute form, performing tilde-expansion if necessary.
2815 PATH cannot be NULL or the empty string.
2816 This does not resolve symlinks however, use gdb_realpath for that.
2817 Space for the result is allocated with malloc.
2818 If the path is already absolute, it is strdup'd.
2819 If there is a problem computing the absolute path, the path is returned
2820 unchanged (still strdup'd). */
2823 gdb_abspath (const char *path)
2825 gdb_assert (path != NULL && path[0] != '\0');
2828 return tilde_expand (path);
2830 if (IS_ABSOLUTE_PATH (path))
2831 return xstrdup (path);
2833 /* Beware the // my son, the Emacs barfs, the botch that catch... */
2834 return concat (current_directory,
2835 IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1])
2836 ? "" : SLASH_STRING,
2837 path, (char *) NULL);
2841 align_up (ULONGEST v, int n)
2843 /* Check that N is really a power of two. */
2844 gdb_assert (n && (n & (n-1)) == 0);
2845 return (v + n - 1) & -n;
2849 align_down (ULONGEST v, int n)
2851 /* Check that N is really a power of two. */
2852 gdb_assert (n && (n & (n-1)) == 0);
2856 /* Allocation function for the libiberty hash table which uses an
2857 obstack. The obstack is passed as DATA. */
2860 hashtab_obstack_allocate (void *data, size_t size, size_t count)
2862 size_t total = size * count;
2863 void *ptr = obstack_alloc ((struct obstack *) data, total);
2865 memset (ptr, 0, total);
2869 /* Trivial deallocation function for the libiberty splay tree and hash
2870 table - don't deallocate anything. Rely on later deletion of the
2871 obstack. DATA will be the obstack, although it is not needed
2875 dummy_obstack_deallocate (void *object, void *data)
2880 /* Simple, portable version of dirname that does not modify its
2884 ldirname (const char *filename)
2886 std::string dirname;
2887 const char *base = lbasename (filename);
2889 while (base > filename && IS_DIR_SEPARATOR (base[-1]))
2892 if (base == filename)
2895 dirname = std::string (filename, base - filename);
2897 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
2898 create "d:./bar" later instead of the (different) "d:/bar". */
2899 if (base - filename == 2 && IS_ABSOLUTE_PATH (base)
2900 && !IS_DIR_SEPARATOR (filename[0]))
2901 dirname[base++ - filename] = '.';
2906 /* Call libiberty's buildargv, and return the result.
2907 If buildargv fails due to out-of-memory, call nomem.
2908 Therefore, the returned value is guaranteed to be non-NULL,
2909 unless the parameter itself is NULL. */
2912 gdb_buildargv (const char *s)
2914 char **argv = buildargv (s);
2916 if (s != NULL && argv == NULL)
2922 compare_positive_ints (const void *ap, const void *bp)
2924 /* Because we know we're comparing two ints which are positive,
2925 there's no danger of overflow here. */
2926 return * (int *) ap - * (int *) bp;
2929 /* String compare function for qsort. */
2932 compare_strings (const void *arg1, const void *arg2)
2934 const char **s1 = (const char **) arg1;
2935 const char **s2 = (const char **) arg2;
2937 return strcmp (*s1, *s2);
2940 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
2941 #define AMBIGUOUS_MESS2 \
2942 ".\nUse \"set gnutarget format-name\" to specify the format."
2945 gdb_bfd_errmsg (bfd_error_type error_tag, char **matching)
2951 /* Check if errmsg just need simple return. */
2952 if (error_tag != bfd_error_file_ambiguously_recognized || matching == NULL)
2953 return bfd_errmsg (error_tag);
2955 ret_len = strlen (bfd_errmsg (error_tag)) + strlen (AMBIGUOUS_MESS1)
2956 + strlen (AMBIGUOUS_MESS2);
2957 for (p = matching; *p; p++)
2958 ret_len += strlen (*p) + 1;
2959 ret = (char *) xmalloc (ret_len + 1);
2961 make_cleanup (xfree, ret);
2963 strcpy (retp, bfd_errmsg (error_tag));
2964 retp += strlen (retp);
2966 strcpy (retp, AMBIGUOUS_MESS1);
2967 retp += strlen (retp);
2969 for (p = matching; *p; p++)
2971 sprintf (retp, " %s", *p);
2972 retp += strlen (retp);
2976 strcpy (retp, AMBIGUOUS_MESS2);
2981 /* Return ARGS parsed as a valid pid, or throw an error. */
2984 parse_pid_to_attach (const char *args)
2990 error_no_arg (_("process-id to attach"));
2992 dummy = (char *) args;
2993 pid = strtoul (args, &dummy, 0);
2994 /* Some targets don't set errno on errors, grrr! */
2995 if ((pid == 0 && dummy == args) || dummy != &args[strlen (args)])
2996 error (_("Illegal process-id: %s."), args);
3001 /* Helper for make_bpstat_clear_actions_cleanup. */
3004 do_bpstat_clear_actions_cleanup (void *unused)
3006 bpstat_clear_actions ();
3009 /* Call bpstat_clear_actions for the case an exception is throw. You should
3010 discard_cleanups if no exception is caught. */
3013 make_bpstat_clear_actions_cleanup (void)
3015 return make_cleanup (do_bpstat_clear_actions_cleanup, NULL);
3018 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3019 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3020 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3023 producer_is_gcc_ge_4 (const char *producer)
3027 if (! producer_is_gcc (producer, &major, &minor))
3036 /* Returns nonzero if the given PRODUCER string is GCC and sets the MAJOR
3037 and MINOR versions when not NULL. Returns zero if the given PRODUCER
3038 is NULL or it isn't GCC. */
3041 producer_is_gcc (const char *producer, int *major, int *minor)
3045 if (producer != NULL && startswith (producer, "GNU "))
3054 /* Skip any identifier after "GNU " - such as "C11" or "C++".
3055 A full producer string might look like:
3057 "GNU Fortran 4.8.2 20140120 (Red Hat 4.8.2-16) -mtune=generic ..."
3058 "GNU C++14 5.0.0 20150123 (experimental)"
3060 cs = &producer[strlen ("GNU ")];
3061 while (*cs && !isspace (*cs))
3063 if (*cs && isspace (*cs))
3065 if (sscanf (cs, "%d.%d", major, minor) == 2)
3069 /* Not recognized as GCC. */
3073 /* Helper for make_cleanup_free_char_ptr_vec. */
3076 do_free_char_ptr_vec (void *arg)
3078 VEC (char_ptr) *char_ptr_vec = (VEC (char_ptr) *) arg;
3080 free_char_ptr_vec (char_ptr_vec);
3083 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3084 final VEC_free for CHAR_PTR_VEC itself.
3086 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3087 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3088 this function does not (cannot) clear the pointer. */
3091 make_cleanup_free_char_ptr_vec (VEC (char_ptr) *char_ptr_vec)
3093 return make_cleanup (do_free_char_ptr_vec, char_ptr_vec);
3096 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3097 must come from xrealloc-compatible allocator and it may be updated. FROM
3098 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3099 located at the start or end of *STRINGP. */
3102 substitute_path_component (char **stringp, const char *from, const char *to)
3104 char *string = *stringp, *s;
3105 const size_t from_len = strlen (from);
3106 const size_t to_len = strlen (to);
3110 s = strstr (s, from);
3114 if ((s == string || IS_DIR_SEPARATOR (s[-1])
3115 || s[-1] == DIRNAME_SEPARATOR)
3116 && (s[from_len] == '\0' || IS_DIR_SEPARATOR (s[from_len])
3117 || s[from_len] == DIRNAME_SEPARATOR))
3122 = (char *) xrealloc (string, (strlen (string) + to_len + 1));
3124 /* Relocate the current S pointer. */
3125 s = s - string + string_new;
3126 string = string_new;
3128 /* Replace from by to. */
3129 memmove (&s[to_len], &s[from_len], strlen (&s[from_len]) + 1);
3130 memcpy (s, to, to_len);
3145 /* SIGALRM handler for waitpid_with_timeout. */
3148 sigalrm_handler (int signo)
3150 /* Nothing to do. */
3155 /* Wrapper to wait for child PID to die with TIMEOUT.
3156 TIMEOUT is the time to stop waiting in seconds.
3157 If TIMEOUT is zero, pass WNOHANG to waitpid.
3158 Returns PID if it was successfully waited for, otherwise -1.
3160 Timeouts are currently implemented with alarm and SIGALRM.
3161 If the host does not support them, this waits "forever".
3162 It would be odd though for a host to have waitpid and not SIGALRM. */
3165 wait_to_die_with_timeout (pid_t pid, int *status, int timeout)
3167 pid_t waitpid_result;
3169 gdb_assert (pid > 0);
3170 gdb_assert (timeout >= 0);
3175 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3176 struct sigaction sa, old_sa;
3178 sa.sa_handler = sigalrm_handler;
3179 sigemptyset (&sa.sa_mask);
3181 sigaction (SIGALRM, &sa, &old_sa);
3185 ofunc = signal (SIGALRM, sigalrm_handler);
3191 waitpid_result = waitpid (pid, status, 0);
3195 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3196 sigaction (SIGALRM, &old_sa, NULL);
3198 signal (SIGALRM, ofunc);
3203 waitpid_result = waitpid (pid, status, WNOHANG);
3205 if (waitpid_result == pid)
3211 #endif /* HAVE_WAITPID */
3213 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3214 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3216 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3217 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3220 gdb_filename_fnmatch (const char *pattern, const char *string, int flags)
3222 gdb_assert ((flags & FNM_FILE_NAME) != 0);
3224 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3225 gdb_assert ((flags & FNM_NOESCAPE) != 0);
3227 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3229 char *pattern_slash, *string_slash;
3231 /* Replace '\' by '/' in both strings. */
3233 pattern_slash = (char *) alloca (strlen (pattern) + 1);
3234 strcpy (pattern_slash, pattern);
3235 pattern = pattern_slash;
3236 for (; *pattern_slash != 0; pattern_slash++)
3237 if (IS_DIR_SEPARATOR (*pattern_slash))
3238 *pattern_slash = '/';
3240 string_slash = (char *) alloca (strlen (string) + 1);
3241 strcpy (string_slash, string);
3242 string = string_slash;
3243 for (; *string_slash != 0; string_slash++)
3244 if (IS_DIR_SEPARATOR (*string_slash))
3245 *string_slash = '/';
3247 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3249 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3250 flags |= FNM_CASEFOLD;
3251 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3253 return fnmatch (pattern, string, flags);
3256 /* Return the number of path elements in PATH.
3264 count_path_elements (const char *path)
3267 const char *p = path;
3269 if (HAS_DRIVE_SPEC (p))
3271 p = STRIP_DRIVE_SPEC (p);
3277 if (IS_DIR_SEPARATOR (*p))
3282 /* Backup one if last character is /, unless it's the only one. */
3283 if (p > path + 1 && IS_DIR_SEPARATOR (p[-1]))
3286 /* Add one for the file name, if present. */
3287 if (p > path && !IS_DIR_SEPARATOR (p[-1]))
3293 /* Remove N leading path elements from PATH.
3294 N must be non-negative.
3295 If PATH has more than N path elements then return NULL.
3296 If PATH has exactly N path elements then return "".
3297 See count_path_elements for a description of how we do the counting. */
3300 strip_leading_path_elements (const char *path, int n)
3303 const char *p = path;
3305 gdb_assert (n >= 0);
3310 if (HAS_DRIVE_SPEC (p))
3312 p = STRIP_DRIVE_SPEC (p);
3318 while (*p != '\0' && !IS_DIR_SEPARATOR (*p))
3333 /* Provide a prototype to silence -Wmissing-prototypes. */
3334 extern initialize_file_ftype _initialize_utils;
3337 _initialize_utils (void)
3339 add_internal_problem_command (&internal_error_problem);
3340 add_internal_problem_command (&internal_warning_problem);
3341 add_internal_problem_command (&demangler_warning_problem);