1 /* General utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2018 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"
71 #include "cp-support.h"
73 #include "common/pathstuff.h"
74 #include "cli/cli-style.h"
76 void (*deprecated_error_begin_hook) (void);
78 /* Prototypes for local functions */
80 static void vfprintf_maybe_filtered (struct ui_file *, const char *,
81 va_list, int) ATTRIBUTE_PRINTF (2, 0);
83 static void fputs_maybe_filtered (const char *, struct ui_file *, int);
85 static void prompt_for_continue (void);
87 static void set_screen_size (void);
88 static void set_width (void);
90 /* Time spent in prompt_for_continue in the currently executing command
91 waiting for user to respond.
92 Initialized in make_command_stats_cleanup.
93 Modified in prompt_for_continue and defaulted_query.
94 Used in report_command_stats. */
96 static std::chrono::steady_clock::duration prompt_for_continue_wait_time;
98 /* A flag indicating whether to timestamp debugging messages. */
100 static int debug_timestamp = 0;
102 /* Nonzero means that strings with character values >0x7F should be printed
103 as octal escapes. Zero means just print the value (e.g. it's an
104 international character, and the terminal or window can cope.) */
106 int sevenbit_strings = 0;
108 show_sevenbit_strings (struct ui_file *file, int from_tty,
109 struct cmd_list_element *c, const char *value)
111 fprintf_filtered (file, _("Printing of 8-bit characters "
112 "in strings as \\nnn is %s.\n"),
116 /* String to be printed before warning messages, if any. */
118 const char *warning_pre_print = "\nwarning: ";
120 int pagination_enabled = 1;
122 show_pagination_enabled (struct ui_file *file, int from_tty,
123 struct cmd_list_element *c, const char *value)
125 fprintf_filtered (file, _("State of pagination is %s.\n"), value);
129 /* Cleanup utilities.
131 These are not defined in cleanups.c (nor declared in cleanups.h)
132 because while they use the "cleanup API" they are not part of the
135 /* This function is useful for cleanups.
139 old_chain = make_cleanup (free_current_contents, &foo);
141 to arrange to free the object thus allocated. */
144 free_current_contents (void *ptr)
146 void **location = (void **) ptr;
148 if (location == NULL)
149 internal_error (__FILE__, __LINE__,
150 _("free_current_contents: NULL pointer"));
151 if (*location != NULL)
160 /* Print a warning message. The first argument STRING is the warning
161 message, used as an fprintf format string, the second is the
162 va_list of arguments for that string. A warning is unfiltered (not
163 paginated) so that the user does not need to page through each
164 screen full of warnings when there are lots of them. */
167 vwarning (const char *string, va_list args)
169 if (deprecated_warning_hook)
170 (*deprecated_warning_hook) (string, args);
173 gdb::optional<target_terminal::scoped_restore_terminal_state> term_state;
174 if (target_supports_terminal_ours ())
176 term_state.emplace ();
177 target_terminal::ours_for_output ();
179 if (filtered_printing_initialized ())
180 wrap_here (""); /* Force out any buffered output. */
181 gdb_flush (gdb_stdout);
182 if (warning_pre_print)
183 fputs_unfiltered (warning_pre_print, gdb_stderr);
184 vfprintf_unfiltered (gdb_stderr, string, args);
185 fprintf_unfiltered (gdb_stderr, "\n");
189 /* Print an error message and return to command level.
190 The first argument STRING is the error message, used as a fprintf string,
191 and the remaining args are passed as arguments to it. */
194 verror (const char *string, va_list args)
196 throw_verror (GENERIC_ERROR, string, args);
200 error_stream (const string_file &stream)
202 error (("%s"), stream.c_str ());
205 /* Emit a message and abort. */
207 static void ATTRIBUTE_NORETURN
208 abort_with_message (const char *msg)
210 if (current_ui == NULL)
213 fputs_unfiltered (msg, gdb_stderr);
215 abort (); /* NOTE: GDB has only three calls to abort(). */
218 /* Dump core trying to increase the core soft limit to hard limit first. */
223 #ifdef HAVE_SETRLIMIT
224 struct rlimit rlim = { (rlim_t) RLIM_INFINITY, (rlim_t) RLIM_INFINITY };
226 setrlimit (RLIMIT_CORE, &rlim);
227 #endif /* HAVE_SETRLIMIT */
229 abort (); /* NOTE: GDB has only three calls to abort(). */
232 /* Check whether GDB will be able to dump core using the dump_core
233 function. Returns zero if GDB cannot or should not dump core.
234 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
235 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
238 can_dump_core (enum resource_limit_kind limit_kind)
240 #ifdef HAVE_GETRLIMIT
243 /* Be quiet and assume we can dump if an error is returned. */
244 if (getrlimit (RLIMIT_CORE, &rlim) != 0)
250 if (rlim.rlim_cur == 0)
255 if (rlim.rlim_max == 0)
258 #endif /* HAVE_GETRLIMIT */
263 /* Print a warning that we cannot dump core. */
266 warn_cant_dump_core (const char *reason)
268 fprintf_unfiltered (gdb_stderr,
269 _("%s\nUnable to dump core, use `ulimit -c"
270 " unlimited' before executing GDB next time.\n"),
274 /* Check whether GDB will be able to dump core using the dump_core
275 function, and print a warning if we cannot. */
278 can_dump_core_warn (enum resource_limit_kind limit_kind,
281 int core_dump_allowed = can_dump_core (limit_kind);
283 if (!core_dump_allowed)
284 warn_cant_dump_core (reason);
286 return core_dump_allowed;
289 /* Allow the user to configure the debugger behavior with respect to
290 what to do when an internal problem is detected. */
292 const char internal_problem_ask[] = "ask";
293 const char internal_problem_yes[] = "yes";
294 const char internal_problem_no[] = "no";
295 static const char *const internal_problem_modes[] =
297 internal_problem_ask,
298 internal_problem_yes,
303 /* Print a message reporting an internal error/warning. Ask the user
304 if they want to continue, dump core, or just exit. Return
305 something to indicate a quit. */
307 struct internal_problem
310 int user_settable_should_quit;
311 const char *should_quit;
312 int user_settable_should_dump_core;
313 const char *should_dump_core;
316 /* Report a problem, internal to GDB, to the user. Once the problem
317 has been reported, and assuming GDB didn't quit, the caller can
318 either allow execution to resume or throw an error. */
320 static void ATTRIBUTE_PRINTF (4, 0)
321 internal_vproblem (struct internal_problem *problem,
322 const char *file, int line, const char *fmt, va_list ap)
329 /* Don't allow infinite error/warning recursion. */
331 static char msg[] = "Recursive internal problem.\n";
340 abort_with_message (msg);
343 /* Newer GLIBC versions put the warn_unused_result attribute
344 on write, but this is one of those rare cases where
345 ignoring the return value is correct. Casting to (void)
346 does not fix this problem. This is the solution suggested
347 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
348 if (write (STDERR_FILENO, msg, sizeof (msg)) != sizeof (msg))
349 abort (); /* NOTE: GDB has only three calls to abort(). */
354 /* Create a string containing the full error/warning message. Need
355 to call query with this full string, as otherwize the reason
356 (error/warning) and question become separated. Format using a
357 style similar to a compiler error message. Include extra detail
358 so that the user knows that they are living on the edge. */
360 std::string msg = string_vprintf (fmt, ap);
361 reason = string_printf ("%s:%d: %s: %s\n"
362 "A problem internal to GDB has been detected,\n"
363 "further debugging may prove unreliable.",
364 file, line, problem->name, msg.c_str ());
367 /* Fall back to abort_with_message if gdb_stderr is not set up. */
368 if (current_ui == NULL)
370 fputs (reason.c_str (), stderr);
371 abort_with_message ("\n");
374 /* Try to get the message out and at the start of a new line. */
375 gdb::optional<target_terminal::scoped_restore_terminal_state> term_state;
376 if (target_supports_terminal_ours ())
378 term_state.emplace ();
379 target_terminal::ours_for_output ();
381 if (filtered_printing_initialized ())
384 /* Emit the message unless query will emit it below. */
385 if (problem->should_quit != internal_problem_ask
387 || !filtered_printing_initialized ())
388 fprintf_unfiltered (gdb_stderr, "%s\n", reason.c_str ());
390 if (problem->should_quit == internal_problem_ask)
392 /* Default (yes/batch case) is to quit GDB. When in batch mode
393 this lessens the likelihood of GDB going into an infinite
395 if (!confirm || !filtered_printing_initialized ())
398 quit_p = query (_("%s\nQuit this debugging session? "),
401 else if (problem->should_quit == internal_problem_yes)
403 else if (problem->should_quit == internal_problem_no)
406 internal_error (__FILE__, __LINE__, _("bad switch"));
408 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr);
409 if (REPORT_BUGS_TO[0])
410 fprintf_unfiltered (gdb_stderr, _(" For instructions, see:\n%s."),
412 fputs_unfiltered ("\n\n", gdb_stderr);
414 if (problem->should_dump_core == internal_problem_ask)
416 if (!can_dump_core_warn (LIMIT_MAX, reason.c_str ()))
418 else if (!filtered_printing_initialized ())
422 /* Default (yes/batch case) is to dump core. This leaves a GDB
423 `dropping' so that it is easier to see that something went
425 dump_core_p = query (_("%s\nCreate a core file of GDB? "),
429 else if (problem->should_dump_core == internal_problem_yes)
430 dump_core_p = can_dump_core_warn (LIMIT_MAX, reason.c_str ());
431 else if (problem->should_dump_core == internal_problem_no)
434 internal_error (__FILE__, __LINE__, _("bad switch"));
447 #ifdef HAVE_WORKING_FORK
457 static struct internal_problem internal_error_problem = {
458 "internal-error", 1, internal_problem_ask, 1, internal_problem_ask
462 internal_verror (const char *file, int line, const char *fmt, va_list ap)
464 internal_vproblem (&internal_error_problem, file, line, fmt, ap);
465 throw_quit (_("Command aborted."));
468 static struct internal_problem internal_warning_problem = {
469 "internal-warning", 1, internal_problem_ask, 1, internal_problem_ask
473 internal_vwarning (const char *file, int line, const char *fmt, va_list ap)
475 internal_vproblem (&internal_warning_problem, file, line, fmt, ap);
478 static struct internal_problem demangler_warning_problem = {
479 "demangler-warning", 1, internal_problem_ask, 0, internal_problem_no
483 demangler_vwarning (const char *file, int line, const char *fmt, va_list ap)
485 internal_vproblem (&demangler_warning_problem, file, line, fmt, ap);
489 demangler_warning (const char *file, int line, const char *string, ...)
493 va_start (ap, string);
494 demangler_vwarning (file, line, string, ap);
498 /* Dummy functions to keep add_prefix_cmd happy. */
501 set_internal_problem_cmd (const char *args, int from_tty)
506 show_internal_problem_cmd (const char *args, int from_tty)
510 /* When GDB reports an internal problem (error or warning) it gives
511 the user the opportunity to quit GDB and/or create a core file of
512 the current debug session. This function registers a few commands
513 that make it possible to specify that GDB should always or never
514 quit or create a core file, without asking. The commands look
517 maint set PROBLEM-NAME quit ask|yes|no
518 maint show PROBLEM-NAME quit
519 maint set PROBLEM-NAME corefile ask|yes|no
520 maint show PROBLEM-NAME corefile
522 Where PROBLEM-NAME is currently "internal-error" or
523 "internal-warning". */
526 add_internal_problem_command (struct internal_problem *problem)
528 struct cmd_list_element **set_cmd_list;
529 struct cmd_list_element **show_cmd_list;
533 set_cmd_list = XNEW (struct cmd_list_element *);
534 show_cmd_list = XNEW (struct cmd_list_element *);
535 *set_cmd_list = NULL;
536 *show_cmd_list = NULL;
538 set_doc = xstrprintf (_("Configure what GDB does when %s is detected."),
541 show_doc = xstrprintf (_("Show what GDB does when %s is detected."),
544 add_prefix_cmd (problem->name,
545 class_maintenance, set_internal_problem_cmd, set_doc,
547 concat ("maintenance set ", problem->name, " ",
549 0/*allow-unknown*/, &maintenance_set_cmdlist);
551 add_prefix_cmd (problem->name,
552 class_maintenance, show_internal_problem_cmd, show_doc,
554 concat ("maintenance show ", problem->name, " ",
556 0/*allow-unknown*/, &maintenance_show_cmdlist);
558 if (problem->user_settable_should_quit)
560 set_doc = xstrprintf (_("Set whether GDB should quit "
561 "when an %s is detected"),
563 show_doc = xstrprintf (_("Show whether GDB will quit "
564 "when an %s is detected"),
566 add_setshow_enum_cmd ("quit", class_maintenance,
567 internal_problem_modes,
568 &problem->should_quit,
581 if (problem->user_settable_should_dump_core)
583 set_doc = xstrprintf (_("Set whether GDB should create a core "
584 "file of GDB when %s is detected"),
586 show_doc = xstrprintf (_("Show whether GDB will create a core "
587 "file of GDB when %s is detected"),
589 add_setshow_enum_cmd ("corefile", class_maintenance,
590 internal_problem_modes,
591 &problem->should_dump_core,
605 /* Return a newly allocated string, containing the PREFIX followed
606 by the system error message for errno (separated by a colon). */
609 perror_string (const char *prefix)
613 err = safe_strerror (errno);
614 return std::string (prefix) + ": " + err;
617 /* Print the system error message for errno, and also mention STRING
618 as the file name for which the error was encountered. Use ERRCODE
619 for the thrown exception. Then return to command level. */
622 throw_perror_with_name (enum errors errcode, const char *string)
624 std::string combined = perror_string (string);
626 /* I understand setting these is a matter of taste. Still, some people
627 may clear errno but not know about bfd_error. Doing this here is not
629 bfd_set_error (bfd_error_no_error);
632 throw_error (errcode, _("%s."), combined.c_str ());
635 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
638 perror_with_name (const char *string)
640 throw_perror_with_name (GENERIC_ERROR, string);
643 /* Same as perror_with_name except that it prints a warning instead
644 of throwing an error. */
647 perror_warning_with_name (const char *string)
649 std::string combined = perror_string (string);
650 warning (_("%s"), combined.c_str ());
653 /* Print the system error message for ERRCODE, and also mention STRING
654 as the file name for which the error was encountered. */
657 print_sys_errmsg (const char *string, int errcode)
662 err = safe_strerror (errcode);
663 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
664 strcpy (combined, string);
665 strcat (combined, ": ");
666 strcat (combined, err);
668 /* We want anything which was printed on stdout to come out first, before
670 gdb_flush (gdb_stdout);
671 fprintf_unfiltered (gdb_stderr, "%s.\n", combined);
674 /* Control C eventually causes this to be called, at a convenient time. */
679 if (sync_quit_force_run)
681 sync_quit_force_run = 0;
682 quit_force (NULL, 0);
686 /* No steenking SIGINT will ever be coming our way when the
687 program is resumed. Don't lie. */
691 /* If there is no terminal switching for this target, then we can't
692 possibly get screwed by the lack of job control. */
693 || !target_supports_terminal_ours ())
696 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
705 if (sync_quit_force_run)
710 if (deprecated_interactive_hook)
711 deprecated_interactive_hook ();
715 /* Called when a memory allocation fails, with the number of bytes of
716 memory requested in SIZE. */
719 malloc_failure (long size)
723 internal_error (__FILE__, __LINE__,
724 _("virtual memory exhausted: can't allocate %ld bytes."),
729 internal_error (__FILE__, __LINE__, _("virtual memory exhausted."));
733 /* My replacement for the read system call.
734 Used like `read' but keeps going if `read' returns too soon. */
737 myread (int desc, char *addr, int len)
744 val = read (desc, addr, len);
756 print_spaces (int n, struct ui_file *file)
758 fputs_unfiltered (n_spaces (n), file);
761 /* Print a host address. */
764 gdb_print_host_address_1 (const void *addr, struct ui_file *stream)
766 fprintf_filtered (stream, "%s", host_address_to_string (addr));
772 make_hex_string (const gdb_byte *data, size_t length)
774 char *result = (char *) xmalloc (length * 2 + 1);
779 for (i = 0; i < length; ++i)
780 p += xsnprintf (p, 3, "%02x", data[i]);
787 /* An RAII class that sets up to handle input and then tears down
788 during destruction. */
790 class scoped_input_handler
794 scoped_input_handler ()
795 : m_quit_handler (&quit_handler, default_quit_handler),
798 target_terminal::ours ();
799 ui_register_input_event_handler (current_ui);
800 if (current_ui->prompt_state == PROMPT_BLOCKED)
804 ~scoped_input_handler ()
807 ui_unregister_input_event_handler (m_ui);
810 DISABLE_COPY_AND_ASSIGN (scoped_input_handler);
814 /* Save and restore the terminal state. */
815 target_terminal::scoped_restore_terminal_state m_term_state;
817 /* Save and restore the quit handler. */
818 scoped_restore_tmpl<quit_handler_ftype *> m_quit_handler;
820 /* The saved UI, if non-NULL. */
826 /* This function supports the query, nquery, and yquery functions.
827 Ask user a y-or-n question and return 0 if answer is no, 1 if
828 answer is yes, or default the answer to the specified default
829 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
830 default answer, or '\0' for no default.
831 CTLSTR is the control string and should end in "? ". It should
832 not say how to answer, because we do that.
833 ARGS are the arguments passed along with the CTLSTR argument to
836 static int ATTRIBUTE_PRINTF (1, 0)
837 defaulted_query (const char *ctlstr, const char defchar, va_list args)
841 char def_answer, not_def_answer;
842 const char *y_string, *n_string;
844 /* Set up according to which answer is the default. */
849 not_def_answer = 'N';
853 else if (defchar == 'y')
857 not_def_answer = 'N';
865 not_def_answer = 'Y';
870 /* Automatically answer the default value if the user did not want
871 prompts or the command was issued with the server prefix. */
872 if (!confirm || server_command)
875 /* If input isn't coming from the user directly, just say what
876 question we're asking, and then answer the default automatically. This
877 way, important error messages don't get lost when talking to GDB
879 if (current_ui->instream != current_ui->stdin_stream
880 || !input_interactive_p (current_ui)
881 /* Restrict queries to the main UI. */
882 || current_ui != main_ui)
884 target_terminal::scoped_restore_terminal_state term_state;
885 target_terminal::ours_for_output ();
887 vfprintf_filtered (gdb_stdout, ctlstr, args);
889 printf_filtered (_("(%s or %s) [answered %c; "
890 "input not from terminal]\n"),
891 y_string, n_string, def_answer);
892 gdb_flush (gdb_stdout);
897 if (deprecated_query_hook)
899 target_terminal::scoped_restore_terminal_state term_state;
900 return deprecated_query_hook (ctlstr, args);
903 /* Format the question outside of the loop, to avoid reusing args. */
904 std::string question = string_vprintf (ctlstr, args);
906 = string_printf (_("%s%s(%s or %s) %s"),
907 annotation_level > 1 ? "\n\032\032pre-query\n" : "",
908 question.c_str (), y_string, n_string,
909 annotation_level > 1 ? "\n\032\032query\n" : "");
911 /* Used to add duration we waited for user to respond to
912 prompt_for_continue_wait_time. */
913 using namespace std::chrono;
914 steady_clock::time_point prompt_started = steady_clock::now ();
916 scoped_input_handler prepare_input;
920 char *response, answer;
922 gdb_flush (gdb_stdout);
923 response = gdb_readline_wrapper (prompt.c_str ());
925 if (response == NULL) /* C-d */
927 printf_filtered ("EOF [assumed %c]\n", def_answer);
932 answer = response[0];
937 /* Check answer. For the non-default, the user must specify
938 the non-default explicitly. */
939 if (answer == not_def_answer)
944 /* Otherwise, if a default was specified, the user may either
945 specify the required input or have it default by entering
947 if (answer == def_answer
948 || (defchar != '\0' && answer == '\0'))
953 /* Invalid entries are not defaulted and require another selection. */
954 printf_filtered (_("Please answer %s or %s.\n"),
958 /* Add time spend in this routine to prompt_for_continue_wait_time. */
959 prompt_for_continue_wait_time += steady_clock::now () - prompt_started;
961 if (annotation_level > 1)
962 printf_filtered (("\n\032\032post-query\n"));
967 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
968 answer is yes, or 0 if answer is defaulted.
969 Takes three args which are given to printf to print the question.
970 The first, a control string, should end in "? ".
971 It should not say how to answer, because we do that. */
974 nquery (const char *ctlstr, ...)
979 va_start (args, ctlstr);
980 ret = defaulted_query (ctlstr, 'n', args);
985 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
986 answer is yes, or 1 if answer is defaulted.
987 Takes three args which are given to printf to print the question.
988 The first, a control string, should end in "? ".
989 It should not say how to answer, because we do that. */
992 yquery (const char *ctlstr, ...)
997 va_start (args, ctlstr);
998 ret = defaulted_query (ctlstr, 'y', args);
1003 /* Ask user a y-or-n question and return 1 iff answer is yes.
1004 Takes three args which are given to printf to print the question.
1005 The first, a control string, should end in "? ".
1006 It should not say how to answer, because we do that. */
1009 query (const char *ctlstr, ...)
1014 va_start (args, ctlstr);
1015 ret = defaulted_query (ctlstr, '\0', args);
1020 /* A helper for parse_escape that converts a host character to a
1021 target character. C is the host character. If conversion is
1022 possible, then the target character is stored in *TARGET_C and the
1023 function returns 1. Otherwise, the function returns 0. */
1026 host_char_to_target (struct gdbarch *gdbarch, int c, int *target_c)
1031 auto_obstack host_data;
1033 convert_between_encodings (target_charset (gdbarch), host_charset (),
1034 (gdb_byte *) &the_char, 1, 1,
1035 &host_data, translit_none);
1037 if (obstack_object_size (&host_data) == 1)
1040 *target_c = *(char *) obstack_base (&host_data);
1046 /* Parse a C escape sequence. STRING_PTR points to a variable
1047 containing a pointer to the string to parse. That pointer
1048 should point to the character after the \. That pointer
1049 is updated past the characters we use. The value of the
1050 escape sequence is returned.
1052 A negative value means the sequence \ newline was seen,
1053 which is supposed to be equivalent to nothing at all.
1055 If \ is followed by a null character, we return a negative
1056 value and leave the string pointer pointing at the null character.
1058 If \ is followed by 000, we return 0 and leave the string pointer
1059 after the zeros. A value of 0 does not mean end of string. */
1062 parse_escape (struct gdbarch *gdbarch, const char **string_ptr)
1064 int target_char = -2; /* Initialize to avoid GCC warnings. */
1065 int c = *(*string_ptr)++;
1084 int i = host_hex_value (c);
1089 if (isdigit (c) && c != '8' && c != '9')
1093 i += host_hex_value (c);
1129 if (!host_char_to_target (gdbarch, c, &target_char))
1130 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1131 " which has no equivalent\nin the `%s' character set."),
1132 c, c, target_charset (gdbarch));
1136 /* Print the character C on STREAM as part of the contents of a literal
1137 string whose delimiter is QUOTER. Note that this routine should only
1138 be called for printing things which are independent of the language
1139 of the program being debugged.
1141 printchar will normally escape backslashes and instances of QUOTER. If
1142 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1143 As a side effect, if you pass the backslash character as the QUOTER,
1144 printchar will escape backslashes as usual, but not any other quoting
1148 printchar (int c, do_fputc_ftype do_fputc, ui_file *stream, int quoter)
1150 c &= 0xFF; /* Avoid sign bit follies */
1152 if (c < 0x20 || /* Low control chars */
1153 (c >= 0x7F && c < 0xA0) || /* DEL, High controls */
1154 (sevenbit_strings && c >= 0x80))
1155 { /* high order bit set */
1156 do_fputc ('\\', stream);
1161 do_fputc ('n', stream);
1164 do_fputc ('b', stream);
1167 do_fputc ('t', stream);
1170 do_fputc ('f', stream);
1173 do_fputc ('r', stream);
1176 do_fputc ('e', stream);
1179 do_fputc ('a', stream);
1183 do_fputc ('0' + ((c >> 6) & 0x7), stream);
1184 do_fputc ('0' + ((c >> 3) & 0x7), stream);
1185 do_fputc ('0' + ((c >> 0) & 0x7), stream);
1192 if (quoter != 0 && (c == '\\' || c == quoter))
1193 do_fputc ('\\', stream);
1194 do_fputc (c, stream);
1198 /* Print the character C on STREAM as part of the contents of a
1199 literal string whose delimiter is QUOTER. Note that these routines
1200 should only be call for printing things which are independent of
1201 the language of the program being debugged. */
1204 fputstr_filtered (const char *str, int quoter, struct ui_file *stream)
1207 printchar (*str++, fputc_filtered, stream, quoter);
1211 fputstr_unfiltered (const char *str, int quoter, struct ui_file *stream)
1214 printchar (*str++, fputc_unfiltered, stream, quoter);
1218 fputstrn_filtered (const char *str, int n, int quoter,
1219 struct ui_file *stream)
1221 for (int i = 0; i < n; i++)
1222 printchar (str[i], fputc_filtered, stream, quoter);
1226 fputstrn_unfiltered (const char *str, int n, int quoter,
1227 do_fputc_ftype do_fputc, struct ui_file *stream)
1229 for (int i = 0; i < n; i++)
1230 printchar (str[i], do_fputc, stream, quoter);
1234 /* Number of lines per page or UINT_MAX if paging is disabled. */
1235 static unsigned int lines_per_page;
1237 show_lines_per_page (struct ui_file *file, int from_tty,
1238 struct cmd_list_element *c, const char *value)
1240 fprintf_filtered (file,
1241 _("Number of lines gdb thinks are in a page is %s.\n"),
1245 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1246 static unsigned int chars_per_line;
1248 show_chars_per_line (struct ui_file *file, int from_tty,
1249 struct cmd_list_element *c, const char *value)
1251 fprintf_filtered (file,
1252 _("Number of characters gdb thinks "
1253 "are in a line is %s.\n"),
1257 /* Current count of lines printed on this page, chars on this line. */
1258 static unsigned int lines_printed, chars_printed;
1260 /* True if pagination is disabled for just one command. */
1262 static bool pagination_disabled_for_command;
1264 /* Buffer and start column of buffered text, for doing smarter word-
1265 wrapping. When someone calls wrap_here(), we start buffering output
1266 that comes through fputs_filtered(). If we see a newline, we just
1267 spit it out and forget about the wrap_here(). If we see another
1268 wrap_here(), we spit it out and remember the newer one. If we see
1269 the end of the line, we spit out a newline, the indent, and then
1270 the buffered output. */
1272 static bool filter_initialized = false;
1274 /* Contains characters which are waiting to be output (they have
1275 already been counted in chars_printed). */
1276 static std::string wrap_buffer;
1278 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1280 static const char *wrap_indent;
1282 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1283 is not in effect. */
1284 static int wrap_column;
1287 /* Initialize the number of lines per page and chars per line. */
1290 init_page_info (void)
1294 lines_per_page = UINT_MAX;
1295 chars_per_line = UINT_MAX;
1299 if (!tui_get_command_dimension (&chars_per_line, &lines_per_page))
1304 #if defined(__GO32__)
1305 rows = ScreenRows ();
1306 cols = ScreenCols ();
1307 lines_per_page = rows;
1308 chars_per_line = cols;
1310 /* Make sure Readline has initialized its terminal settings. */
1311 rl_reset_terminal (NULL);
1313 /* Get the screen size from Readline. */
1314 rl_get_screen_size (&rows, &cols);
1315 lines_per_page = rows;
1316 chars_per_line = cols;
1318 /* Readline should have fetched the termcap entry for us.
1319 Only try to use tgetnum function if rl_get_screen_size
1320 did not return a useful value. */
1321 if (((rows <= 0) && (tgetnum ((char *) "li") < 0))
1322 /* Also disable paging if inside Emacs. $EMACS was used
1323 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1324 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1326 /* The number of lines per page is not mentioned in the terminal
1327 description or EMACS evironment variable is set. This probably
1328 means that paging is not useful, so disable paging. */
1329 lines_per_page = UINT_MAX;
1332 /* If the output is not a terminal, don't paginate it. */
1333 if (!ui_file_isatty (gdb_stdout))
1334 lines_per_page = UINT_MAX;
1338 /* We handle SIGWINCH ourselves. */
1339 rl_catch_sigwinch = 0;
1345 /* Return nonzero if filtered printing is initialized. */
1347 filtered_printing_initialized (void)
1349 return filter_initialized;
1352 set_batch_flag_and_restore_page_info::set_batch_flag_and_restore_page_info ()
1353 : m_save_lines_per_page (lines_per_page),
1354 m_save_chars_per_line (chars_per_line),
1355 m_save_batch_flag (batch_flag)
1361 set_batch_flag_and_restore_page_info::~set_batch_flag_and_restore_page_info ()
1363 batch_flag = m_save_batch_flag;
1364 chars_per_line = m_save_chars_per_line;
1365 lines_per_page = m_save_lines_per_page;
1371 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1374 set_screen_size (void)
1376 int rows = lines_per_page;
1377 int cols = chars_per_line;
1385 /* Update Readline's idea of the terminal size. */
1386 rl_set_screen_size (rows, cols);
1389 /* Reinitialize WRAP_BUFFER. */
1394 if (chars_per_line == 0)
1397 wrap_buffer.clear ();
1398 filter_initialized = true;
1402 set_width_command (const char *args, int from_tty, struct cmd_list_element *c)
1409 set_height_command (const char *args, int from_tty, struct cmd_list_element *c)
1417 set_screen_width_and_height (int width, int height)
1419 lines_per_page = height;
1420 chars_per_line = width;
1426 /* The currently applied style. */
1428 static ui_file_style applied_style;
1430 /* The currently desired style. This can differ from the applied
1431 style when showing the pagination prompt. */
1433 static ui_file_style desired_style;
1435 /* Emit an ANSI style escape for STYLE to the wrap buffer. */
1438 emit_style_escape (const ui_file_style &style)
1440 if (applied_style == style)
1442 applied_style = style;
1444 wrap_buffer.append (style.to_ansi ());
1447 /* Set the current output style. This will affect future uses of the
1448 _filtered output functions. */
1451 set_output_style (struct ui_file *stream, const ui_file_style &style)
1453 if (stream != gdb_stdout
1455 || style == desired_style
1456 || !ui_file_isatty (stream))
1458 const char *term = getenv ("TERM");
1459 if (term == nullptr || !strcmp (term, "dumb"))
1462 desired_style = style;
1463 emit_style_escape (style);
1466 /* Wait, so the user can read what's on the screen. Prompt the user
1467 to continue by pressing RETURN. 'q' is also provided because
1468 telling users what to do in the prompt is more user-friendly than
1469 expecting them to think of Ctrl-C/SIGINT. */
1472 prompt_for_continue (void)
1474 char cont_prompt[120];
1475 /* Used to add duration we waited for user to respond to
1476 prompt_for_continue_wait_time. */
1477 using namespace std::chrono;
1478 steady_clock::time_point prompt_started = steady_clock::now ();
1479 bool disable_pagination = pagination_disabled_for_command;
1481 /* Clear the current styling. */
1482 emit_style_escape (ui_file_style ());
1484 if (annotation_level > 1)
1485 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1487 strcpy (cont_prompt,
1488 "--Type <RET> for more, q to quit, "
1489 "c to continue without paging--");
1490 if (annotation_level > 1)
1491 strcat (cont_prompt, "\n\032\032prompt-for-continue\n");
1493 /* We must do this *before* we call gdb_readline_wrapper, else it
1494 will eventually call us -- thinking that we're trying to print
1495 beyond the end of the screen. */
1496 reinitialize_more_filter ();
1498 scoped_input_handler prepare_input;
1500 /* Call gdb_readline_wrapper, not readline, in order to keep an
1501 event loop running. */
1502 gdb::unique_xmalloc_ptr<char> ignore (gdb_readline_wrapper (cont_prompt));
1504 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1505 prompt_for_continue_wait_time += steady_clock::now () - prompt_started;
1507 if (annotation_level > 1)
1508 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1512 char *p = ignore.get ();
1514 while (*p == ' ' || *p == '\t')
1517 /* Do not call quit here; there is no possibility of SIGINT. */
1518 throw_quit ("Quit");
1520 disable_pagination = true;
1523 /* Now we have to do this again, so that GDB will know that it doesn't
1524 need to save the ---Type <return>--- line at the top of the screen. */
1525 reinitialize_more_filter ();
1526 pagination_disabled_for_command = disable_pagination;
1528 /* Restore the current styling. */
1529 emit_style_escape (desired_style);
1531 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1534 /* Initialize timer to keep track of how long we waited for the user. */
1537 reset_prompt_for_continue_wait_time (void)
1539 using namespace std::chrono;
1541 prompt_for_continue_wait_time = steady_clock::duration::zero ();
1544 /* Fetch the cumulative time spent in prompt_for_continue. */
1546 std::chrono::steady_clock::duration
1547 get_prompt_for_continue_wait_time ()
1549 return prompt_for_continue_wait_time;
1552 /* Reinitialize filter; ie. tell it to reset to original values. */
1555 reinitialize_more_filter (void)
1559 pagination_disabled_for_command = false;
1562 /* Flush the wrap buffer to STREAM, if necessary. */
1565 flush_wrap_buffer (struct ui_file *stream)
1567 if (!wrap_buffer.empty ())
1569 fputs_unfiltered (wrap_buffer.c_str (), stream);
1570 wrap_buffer.clear ();
1574 /* Indicate that if the next sequence of characters overflows the line,
1575 a newline should be inserted here rather than when it hits the end.
1576 If INDENT is non-null, it is a string to be printed to indent the
1577 wrapped part on the next line. INDENT must remain accessible until
1578 the next call to wrap_here() or until a newline is printed through
1581 If the line is already overfull, we immediately print a newline and
1582 the indentation, and disable further wrapping.
1584 If we don't know the width of lines, but we know the page height,
1585 we must not wrap words, but should still keep track of newlines
1586 that were explicitly printed.
1588 INDENT should not contain tabs, as that will mess up the char count
1589 on the next line. FIXME.
1591 This routine is guaranteed to force out any output which has been
1592 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1593 used to force out output from the wrap_buffer. */
1596 wrap_here (const char *indent)
1598 /* This should have been allocated, but be paranoid anyway. */
1599 if (!filter_initialized)
1600 internal_error (__FILE__, __LINE__,
1601 _("failed internal consistency check"));
1603 flush_wrap_buffer (gdb_stdout);
1604 if (chars_per_line == UINT_MAX) /* No line overflow checking. */
1608 else if (chars_printed >= chars_per_line)
1610 puts_filtered ("\n");
1612 puts_filtered (indent);
1617 wrap_column = chars_printed;
1621 wrap_indent = indent;
1625 /* Print input string to gdb_stdout, filtered, with wrap,
1626 arranging strings in columns of n chars. String can be
1627 right or left justified in the column. Never prints
1628 trailing spaces. String should never be longer than
1629 width. FIXME: this could be useful for the EXAMINE
1630 command, which currently doesn't tabulate very well. */
1633 puts_filtered_tabular (char *string, int width, int right)
1639 gdb_assert (chars_per_line > 0);
1640 if (chars_per_line == UINT_MAX)
1642 fputs_filtered (string, gdb_stdout);
1643 fputs_filtered ("\n", gdb_stdout);
1647 if (((chars_printed - 1) / width + 2) * width >= chars_per_line)
1648 fputs_filtered ("\n", gdb_stdout);
1650 if (width >= chars_per_line)
1651 width = chars_per_line - 1;
1653 stringlen = strlen (string);
1655 if (chars_printed > 0)
1656 spaces = width - (chars_printed - 1) % width - 1;
1658 spaces += width - stringlen;
1660 spacebuf = (char *) alloca (spaces + 1);
1661 spacebuf[spaces] = '\0';
1663 spacebuf[spaces] = ' ';
1665 fputs_filtered (spacebuf, gdb_stdout);
1666 fputs_filtered (string, gdb_stdout);
1670 /* Ensure that whatever gets printed next, using the filtered output
1671 commands, starts at the beginning of the line. I.e. if there is
1672 any pending output for the current line, flush it and start a new
1673 line. Otherwise do nothing. */
1678 if (chars_printed > 0)
1680 puts_filtered ("\n");
1685 /* Like fputs but if FILTER is true, pause after every screenful.
1687 Regardless of FILTER can wrap at points other than the final
1688 character of a line.
1690 Unlike fputs, fputs_maybe_filtered does not return a value.
1691 It is OK for LINEBUFFER to be NULL, in which case just don't print
1694 Note that a longjmp to top level may occur in this routine (only if
1695 FILTER is true) (since prompt_for_continue may do so) so this
1696 routine should not be called when cleanups are not in place. */
1699 fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
1702 const char *lineptr;
1704 if (linebuffer == 0)
1707 /* Don't do any filtering if it is disabled. */
1708 if (stream != gdb_stdout
1709 || !pagination_enabled
1710 || pagination_disabled_for_command
1712 || (lines_per_page == UINT_MAX && chars_per_line == UINT_MAX)
1713 || top_level_interpreter () == NULL
1714 || top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
1716 flush_wrap_buffer (stream);
1717 fputs_unfiltered (linebuffer, stream);
1721 /* Go through and output each character. Show line extension
1722 when this is necessary; prompt user for new page when this is
1725 lineptr = linebuffer;
1728 /* Possible new page. Note that PAGINATION_DISABLED_FOR_COMMAND
1729 might be set during this loop, so we must continue to check
1731 if (filter && (lines_printed >= lines_per_page - 1)
1732 && !pagination_disabled_for_command)
1733 prompt_for_continue ();
1735 while (*lineptr && *lineptr != '\n')
1737 /* Print a single line. */
1738 if (*lineptr == '\t')
1740 wrap_buffer.push_back ('\t');
1741 /* Shifting right by 3 produces the number of tab stops
1742 we have already passed, and then adding one and
1743 shifting left 3 advances to the next tab stop. */
1744 chars_printed = ((chars_printed >> 3) + 1) << 3;
1749 wrap_buffer.push_back (*lineptr);
1754 if (chars_printed >= chars_per_line)
1756 unsigned int save_chars = chars_printed;
1760 /* If we aren't actually wrapping, don't output newline --
1761 if chars_per_line is right, we probably just overflowed
1762 anyway; if it's wrong, let us keep going. */
1765 emit_style_escape (ui_file_style ());
1766 flush_wrap_buffer (stream);
1767 fputc_unfiltered ('\n', stream);
1770 /* Possible new page. Note that
1771 PAGINATION_DISABLED_FOR_COMMAND might be set during
1772 this loop, so we must continue to check it here. */
1773 if (lines_printed >= lines_per_page - 1
1774 && !pagination_disabled_for_command)
1775 prompt_for_continue ();
1777 /* Now output indentation and wrapped string. */
1780 fputs_unfiltered (wrap_indent, stream);
1781 emit_style_escape (desired_style);
1782 flush_wrap_buffer (stream);
1783 /* FIXME, this strlen is what prevents wrap_indent from
1784 containing tabs. However, if we recurse to print it
1785 and count its chars, we risk trouble if wrap_indent is
1786 longer than (the user settable) chars_per_line.
1787 Note also that this can set chars_printed > chars_per_line
1788 if we are printing a long string. */
1789 chars_printed = strlen (wrap_indent)
1790 + (save_chars - wrap_column);
1791 wrap_column = 0; /* And disable fancy wrap */
1796 if (*lineptr == '\n')
1799 wrap_here ((char *) 0); /* Spit out chars, cancel
1802 fputc_unfiltered ('\n', stream);
1809 fputs_filtered (const char *linebuffer, struct ui_file *stream)
1811 fputs_maybe_filtered (linebuffer, stream, 1);
1817 fputs_styled (const char *linebuffer, const ui_file_style &style,
1818 struct ui_file *stream)
1820 set_output_style (stream, style);
1821 fputs_maybe_filtered (linebuffer, stream, 1);
1822 set_output_style (stream, ui_file_style ());
1826 putchar_unfiltered (int c)
1830 ui_file_write (gdb_stdout, &buf, 1);
1834 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
1835 May return nonlocally. */
1838 putchar_filtered (int c)
1840 return fputc_filtered (c, gdb_stdout);
1844 fputc_unfiltered (int c, struct ui_file *stream)
1848 ui_file_write (stream, &buf, 1);
1853 fputc_filtered (int c, struct ui_file *stream)
1859 fputs_filtered (buf, stream);
1863 /* puts_debug is like fputs_unfiltered, except it prints special
1864 characters in printable fashion. */
1867 puts_debug (char *prefix, char *string, char *suffix)
1871 /* Print prefix and suffix after each line. */
1872 static int new_line = 1;
1873 static int return_p = 0;
1874 static const char *prev_prefix = "";
1875 static const char *prev_suffix = "";
1877 if (*string == '\n')
1880 /* If the prefix is changing, print the previous suffix, a new line,
1881 and the new prefix. */
1882 if ((return_p || (strcmp (prev_prefix, prefix) != 0)) && !new_line)
1884 fputs_unfiltered (prev_suffix, gdb_stdlog);
1885 fputs_unfiltered ("\n", gdb_stdlog);
1886 fputs_unfiltered (prefix, gdb_stdlog);
1889 /* Print prefix if we printed a newline during the previous call. */
1893 fputs_unfiltered (prefix, gdb_stdlog);
1896 prev_prefix = prefix;
1897 prev_suffix = suffix;
1899 /* Output characters in a printable format. */
1900 while ((ch = *string++) != '\0')
1906 fputc_unfiltered (ch, gdb_stdlog);
1909 fprintf_unfiltered (gdb_stdlog, "\\x%02x", ch & 0xff);
1913 fputs_unfiltered ("\\\\", gdb_stdlog);
1916 fputs_unfiltered ("\\b", gdb_stdlog);
1919 fputs_unfiltered ("\\f", gdb_stdlog);
1923 fputs_unfiltered ("\\n", gdb_stdlog);
1926 fputs_unfiltered ("\\r", gdb_stdlog);
1929 fputs_unfiltered ("\\t", gdb_stdlog);
1932 fputs_unfiltered ("\\v", gdb_stdlog);
1936 return_p = ch == '\r';
1939 /* Print suffix if we printed a newline. */
1942 fputs_unfiltered (suffix, gdb_stdlog);
1943 fputs_unfiltered ("\n", gdb_stdlog);
1948 /* Print a variable number of ARGS using format FORMAT. If this
1949 information is going to put the amount written (since the last call
1950 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
1951 call prompt_for_continue to get the users permision to continue.
1953 Unlike fprintf, this function does not return a value.
1955 We implement three variants, vfprintf (takes a vararg list and stream),
1956 fprintf (takes a stream to write on), and printf (the usual).
1958 Note also that a longjmp to top level may occur in this routine
1959 (since prompt_for_continue may do so) so this routine should not be
1960 called when cleanups are not in place. */
1963 vfprintf_maybe_filtered (struct ui_file *stream, const char *format,
1964 va_list args, int filter)
1966 std::string linebuffer = string_vprintf (format, args);
1967 fputs_maybe_filtered (linebuffer.c_str (), stream, filter);
1972 vfprintf_filtered (struct ui_file *stream, const char *format, va_list args)
1974 vfprintf_maybe_filtered (stream, format, args, 1);
1978 vfprintf_unfiltered (struct ui_file *stream, const char *format, va_list args)
1980 std::string linebuffer = string_vprintf (format, args);
1981 if (debug_timestamp && stream == gdb_stdlog)
1983 using namespace std::chrono;
1986 steady_clock::time_point now = steady_clock::now ();
1987 seconds s = duration_cast<seconds> (now.time_since_epoch ());
1988 microseconds us = duration_cast<microseconds> (now.time_since_epoch () - s);
1990 len = linebuffer.size ();
1991 need_nl = (len > 0 && linebuffer[len - 1] != '\n');
1993 std::string timestamp = string_printf ("%ld.%06ld %s%s",
1996 linebuffer.c_str (),
1997 need_nl ? "\n": "");
1998 fputs_unfiltered (timestamp.c_str (), stream);
2001 fputs_unfiltered (linebuffer.c_str (), stream);
2005 vprintf_filtered (const char *format, va_list args)
2007 vfprintf_maybe_filtered (gdb_stdout, format, args, 1);
2011 vprintf_unfiltered (const char *format, va_list args)
2013 vfprintf_unfiltered (gdb_stdout, format, args);
2017 fprintf_filtered (struct ui_file *stream, const char *format, ...)
2021 va_start (args, format);
2022 vfprintf_filtered (stream, format, args);
2027 fprintf_unfiltered (struct ui_file *stream, const char *format, ...)
2031 va_start (args, format);
2032 vfprintf_unfiltered (stream, format, args);
2036 /* Like fprintf_filtered, but prints its result indented.
2037 Called as fprintfi_filtered (spaces, stream, format, ...); */
2040 fprintfi_filtered (int spaces, struct ui_file *stream, const char *format,
2045 va_start (args, format);
2046 print_spaces_filtered (spaces, stream);
2048 vfprintf_filtered (stream, format, args);
2055 fprintf_styled (struct ui_file *stream, const ui_file_style &style,
2056 const char *format, ...)
2060 set_output_style (stream, style);
2061 va_start (args, format);
2062 vfprintf_filtered (stream, format, args);
2064 set_output_style (stream, ui_file_style ());
2069 printf_filtered (const char *format, ...)
2073 va_start (args, format);
2074 vfprintf_filtered (gdb_stdout, format, args);
2080 printf_unfiltered (const char *format, ...)
2084 va_start (args, format);
2085 vfprintf_unfiltered (gdb_stdout, format, args);
2089 /* Like printf_filtered, but prints it's result indented.
2090 Called as printfi_filtered (spaces, format, ...); */
2093 printfi_filtered (int spaces, const char *format, ...)
2097 va_start (args, format);
2098 print_spaces_filtered (spaces, gdb_stdout);
2099 vfprintf_filtered (gdb_stdout, format, args);
2103 /* Easy -- but watch out!
2105 This routine is *not* a replacement for puts()! puts() appends a newline.
2106 This one doesn't, and had better not! */
2109 puts_filtered (const char *string)
2111 fputs_filtered (string, gdb_stdout);
2115 puts_unfiltered (const char *string)
2117 fputs_unfiltered (string, gdb_stdout);
2120 /* Return a pointer to N spaces and a null. The pointer is good
2121 until the next call to here. */
2126 static char *spaces = 0;
2127 static int max_spaces = -1;
2133 spaces = (char *) xmalloc (n + 1);
2134 for (t = spaces + n; t != spaces;)
2140 return spaces + max_spaces - n;
2143 /* Print N spaces. */
2145 print_spaces_filtered (int n, struct ui_file *stream)
2147 fputs_filtered (n_spaces (n), stream);
2150 /* C++/ObjC demangler stuff. */
2152 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2153 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2154 If the name is not mangled, or the language for the name is unknown, or
2155 demangling is off, the name is printed in its "raw" form. */
2158 fprintf_symbol_filtered (struct ui_file *stream, const char *name,
2159 enum language lang, int arg_mode)
2165 /* If user wants to see raw output, no problem. */
2168 fputs_filtered (name, stream);
2172 demangled = language_demangle (language_def (lang), name, arg_mode);
2173 fputs_filtered (demangled ? demangled : name, stream);
2174 if (demangled != NULL)
2182 /* True if CH is a character that can be part of a symbol name. I.e.,
2183 either a number, a letter, or a '_'. */
2186 valid_identifier_name_char (int ch)
2188 return (isalnum (ch) || ch == '_');
2191 /* Skip to end of token, or to END, whatever comes first. Input is
2192 assumed to be a C++ operator name. */
2195 cp_skip_operator_token (const char *token, const char *end)
2197 const char *p = token;
2198 while (p != end && !isspace (*p) && *p != '(')
2200 if (valid_identifier_name_char (*p))
2202 while (p != end && valid_identifier_name_char (*p))
2208 /* Note, ordered such that among ops that share a prefix,
2209 longer comes first. This is so that the loop below can
2210 bail on first match. */
2211 static const char *ops[] =
2217 "-=", "--", "->", "-",
2226 "<<=", "<=", "<<", "<",
2227 ">>=", ">=", ">>", ">",
2231 for (const char *op : ops)
2233 size_t oplen = strlen (op);
2234 size_t lencmp = std::min<size_t> (oplen, end - p);
2236 if (strncmp (p, op, lencmp) == 0)
2239 /* Some unidentified character. Return it. */
2247 /* Advance STRING1/STRING2 past whitespace. */
2250 skip_ws (const char *&string1, const char *&string2, const char *end_str2)
2252 while (isspace (*string1))
2254 while (string2 < end_str2 && isspace (*string2))
2258 /* True if STRING points at the start of a C++ operator name. START
2259 is the start of the string that STRING points to, hence when
2260 reading backwards, we must not read any character before START. */
2263 cp_is_operator (const char *string, const char *start)
2265 return ((string == start
2266 || !valid_identifier_name_char (string[-1]))
2267 && strncmp (string, CP_OPERATOR_STR, CP_OPERATOR_LEN) == 0
2268 && !valid_identifier_name_char (string[CP_OPERATOR_LEN]));
2271 /* If *NAME points at an ABI tag, skip it and return true. Otherwise
2272 leave *NAME unmodified and return false. (see GCC's abi_tag
2273 attribute), such names are demangled as e.g.,
2274 "function[abi:cxx11]()". */
2277 skip_abi_tag (const char **name)
2279 const char *p = *name;
2281 if (startswith (p, "[abi:"))
2285 while (valid_identifier_name_char (*p))
2301 strncmp_iw_with_mode (const char *string1, const char *string2,
2302 size_t string2_len, strncmp_iw_mode mode,
2303 enum language language,
2304 completion_match_for_lcd *match_for_lcd)
2306 const char *string1_start = string1;
2307 const char *end_str2 = string2 + string2_len;
2308 bool skip_spaces = true;
2309 bool have_colon_op = (language == language_cplus
2310 || language == language_rust
2311 || language == language_fortran);
2316 || ((isspace (*string1) && !valid_identifier_name_char (*string2))
2317 || (isspace (*string2) && !valid_identifier_name_char (*string1))))
2319 skip_ws (string1, string2, end_str2);
2320 skip_spaces = false;
2323 /* Skip [abi:cxx11] tags in the symbol name if the lookup name
2324 doesn't include them. E.g.:
2326 string1: function[abi:cxx1](int)
2329 string1: function[abi:cxx1](int)
2330 string2: function(int)
2332 string1: Struct[abi:cxx1]::function()
2333 string2: Struct::function()
2335 string1: function(Struct[abi:cxx1], int)
2336 string2: function(Struct, int)
2338 if (string2 == end_str2
2339 || (*string2 != '[' && !valid_identifier_name_char (*string2)))
2341 const char *abi_start = string1;
2343 /* There can be more than one tag. */
2344 while (*string1 == '[' && skip_abi_tag (&string1))
2347 if (match_for_lcd != NULL && abi_start != string1)
2348 match_for_lcd->mark_ignored_range (abi_start, string1);
2350 while (isspace (*string1))
2354 if (*string1 == '\0' || string2 == end_str2)
2357 /* Handle the :: operator. */
2358 if (have_colon_op && string1[0] == ':' && string1[1] == ':')
2360 if (*string2 != ':')
2366 if (string2 == end_str2)
2369 if (*string2 != ':')
2375 while (isspace (*string1))
2377 while (string2 < end_str2 && isspace (*string2))
2382 /* Handle C++ user-defined operators. */
2383 else if (language == language_cplus
2386 if (cp_is_operator (string1, string1_start))
2388 /* An operator name in STRING1. Check STRING2. */
2390 = std::min<size_t> (CP_OPERATOR_LEN, end_str2 - string2);
2391 if (strncmp (string1, string2, cmplen) != 0)
2397 if (string2 != end_str2)
2399 /* Check for "operatorX" in STRING2. */
2400 if (valid_identifier_name_char (*string2))
2403 skip_ws (string1, string2, end_str2);
2406 /* Handle operator(). */
2407 if (*string1 == '(')
2409 if (string2 == end_str2)
2411 if (mode == strncmp_iw_mode::NORMAL)
2415 /* Don't break for the regular return at the
2416 bottom, because "operator" should not
2417 match "operator()", since this open
2418 parentheses is not the parameter list
2420 return *string1 != '\0';
2424 if (*string1 != *string2)
2433 skip_ws (string1, string2, end_str2);
2435 /* Skip to end of token, or to END, whatever comes
2437 const char *end_str1 = string1 + strlen (string1);
2438 const char *p1 = cp_skip_operator_token (string1, end_str1);
2439 const char *p2 = cp_skip_operator_token (string2, end_str2);
2441 cmplen = std::min (p1 - string1, p2 - string2);
2444 if (strncmp (string1, string2, cmplen) != 0)
2449 if (p1 - string1 != p2 - string2)
2451 if (strncmp (string1, string2, cmplen) != 0)
2458 if (*string1 == '\0' || string2 == end_str2)
2460 if (*string1 == '(' || *string2 == '(')
2468 if (case_sensitivity == case_sensitive_on && *string1 != *string2)
2470 if (case_sensitivity == case_sensitive_off
2471 && (tolower ((unsigned char) *string1)
2472 != tolower ((unsigned char) *string2)))
2475 /* If we see any non-whitespace, non-identifier-name character
2476 (any of "()<>*&" etc.), then skip spaces the next time
2478 if (!isspace (*string1) && !valid_identifier_name_char (*string1))
2485 if (string2 == end_str2)
2487 if (mode == strncmp_iw_mode::NORMAL)
2489 /* Strip abi tag markers from the matched symbol name.
2490 Usually the ABI marker will be found on function name
2491 (automatically added because the function returns an
2492 object marked with an ABI tag). However, it's also
2493 possible to see a marker in one of the function
2494 parameters, for example.
2496 string2 (lookup name):
2499 function(some_struct[abi:cxx11], int)
2501 and for completion LCD computation we want to say that
2503 function(some_struct, int)
2505 if (match_for_lcd != NULL)
2507 while ((string1 = strstr (string1, "[abi:")) != NULL)
2509 const char *abi_start = string1;
2511 /* There can be more than one tag. */
2512 while (skip_abi_tag (&string1) && *string1 == '[')
2515 if (abi_start != string1)
2516 match_for_lcd->mark_ignored_range (abi_start, string1);
2523 return (*string1 != '\0' && *string1 != '(');
2532 strncmp_iw (const char *string1, const char *string2, size_t string2_len)
2534 return strncmp_iw_with_mode (string1, string2, string2_len,
2535 strncmp_iw_mode::NORMAL, language_minimal);
2541 strcmp_iw (const char *string1, const char *string2)
2543 return strncmp_iw_with_mode (string1, string2, strlen (string2),
2544 strncmp_iw_mode::MATCH_PARAMS, language_minimal);
2547 /* This is like strcmp except that it ignores whitespace and treats
2548 '(' as the first non-NULL character in terms of ordering. Like
2549 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2550 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2551 according to that ordering.
2553 If a list is sorted according to this function and if you want to
2554 find names in the list that match some fixed NAME according to
2555 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2556 where this function would put NAME.
2558 This function must be neutral to the CASE_SENSITIVITY setting as the user
2559 may choose it during later lookup. Therefore this function always sorts
2560 primarily case-insensitively and secondarily case-sensitively.
2562 Here are some examples of why using strcmp to sort is a bad idea:
2566 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2567 we try to do a search for "foo<char*>", strcmp will locate this
2568 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2569 will start looking at strings beginning with "goo", and will never
2570 see the correct match of "foo<char *>".
2572 Parenthesis example:
2574 In practice, this is less like to be an issue, but I'll give it a
2575 shot. Let's assume that '$' is a legitimate character to occur in
2576 symbols. (Which may well even be the case on some systems.) Then
2577 say that the partial symbol table contains "foo$" and "foo(int)".
2578 strcmp will put them in this order, since '$' < '('. Now, if the
2579 user searches for "foo", then strcmp will sort "foo" before "foo$".
2580 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2581 "foo") is false, so it won't proceed to the actual match of
2582 "foo(int)" with "foo". */
2585 strcmp_iw_ordered (const char *string1, const char *string2)
2587 const char *saved_string1 = string1, *saved_string2 = string2;
2588 enum case_sensitivity case_pass = case_sensitive_off;
2592 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2593 Provide stub characters if we are already at the end of one of the
2595 char c1 = 'X', c2 = 'X';
2597 while (*string1 != '\0' && *string2 != '\0')
2599 while (isspace (*string1))
2601 while (isspace (*string2))
2606 case case_sensitive_off:
2607 c1 = tolower ((unsigned char) *string1);
2608 c2 = tolower ((unsigned char) *string2);
2610 case case_sensitive_on:
2618 if (*string1 != '\0')
2627 /* Characters are non-equal unless they're both '\0'; we want to
2628 make sure we get the comparison right according to our
2629 comparison in the cases where one of them is '\0' or '('. */
2631 if (*string2 == '\0')
2636 if (*string2 == '\0')
2641 if (*string2 == '\0' || *string2 == '(')
2650 if (case_pass == case_sensitive_on)
2653 /* Otherwise the strings were equal in case insensitive way, make
2654 a more fine grained comparison in a case sensitive way. */
2656 case_pass = case_sensitive_on;
2657 string1 = saved_string1;
2658 string2 = saved_string2;
2665 streq (const char *lhs, const char *rhs)
2667 return !strcmp (lhs, rhs);
2673 streq_hash (const void *lhs, const void *rhs)
2675 return streq ((const char *) lhs, (const char *) rhs);
2682 ** Answer whether string_to_compare is a full or partial match to
2683 ** template_string. The partial match must be in sequence starting
2687 subset_compare (const char *string_to_compare, const char *template_string)
2691 if (template_string != (char *) NULL && string_to_compare != (char *) NULL
2692 && strlen (string_to_compare) <= strlen (template_string))
2694 (startswith (template_string, string_to_compare));
2701 show_debug_timestamp (struct ui_file *file, int from_tty,
2702 struct cmd_list_element *c, const char *value)
2704 fprintf_filtered (file, _("Timestamping debugging messages is %s.\n"),
2710 initialize_utils (void)
2712 add_setshow_uinteger_cmd ("width", class_support, &chars_per_line, _("\
2713 Set number of characters where GDB should wrap lines of its output."), _("\
2714 Show number of characters where GDB should wrap lines of its output."), _("\
2715 This affects where GDB wraps its output to fit the screen width.\n\
2716 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2718 show_chars_per_line,
2719 &setlist, &showlist);
2721 add_setshow_uinteger_cmd ("height", class_support, &lines_per_page, _("\
2722 Set number of lines in a page for GDB output pagination."), _("\
2723 Show number of lines in a page for GDB output pagination."), _("\
2724 This affects the number of lines after which GDB will pause\n\
2725 its output and ask you whether to continue.\n\
2726 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2728 show_lines_per_page,
2729 &setlist, &showlist);
2731 add_setshow_boolean_cmd ("pagination", class_support,
2732 &pagination_enabled, _("\
2733 Set state of GDB output pagination."), _("\
2734 Show state of GDB output pagination."), _("\
2735 When pagination is ON, GDB pauses at end of each screenful of\n\
2736 its output and asks you whether to continue.\n\
2737 Turning pagination off is an alternative to \"set height unlimited\"."),
2739 show_pagination_enabled,
2740 &setlist, &showlist);
2742 add_setshow_boolean_cmd ("sevenbit-strings", class_support,
2743 &sevenbit_strings, _("\
2744 Set printing of 8-bit characters in strings as \\nnn."), _("\
2745 Show printing of 8-bit characters in strings as \\nnn."), NULL,
2747 show_sevenbit_strings,
2748 &setprintlist, &showprintlist);
2750 add_setshow_boolean_cmd ("timestamp", class_maintenance,
2751 &debug_timestamp, _("\
2752 Set timestamping of debugging messages."), _("\
2753 Show timestamping of debugging messages."), _("\
2754 When set, debugging messages will be marked with seconds and microseconds."),
2756 show_debug_timestamp,
2757 &setdebuglist, &showdebuglist);
2763 address_significant (gdbarch *gdbarch, CORE_ADDR addr)
2765 /* Clear insignificant bits of a target address and sign extend resulting
2766 address, avoiding shifts larger or equal than the width of a CORE_ADDR.
2767 The local variable ADDR_BIT stops the compiler reporting a shift overflow
2768 when it won't occur. Skip updating of target address if current target
2769 has not set gdbarch significant_addr_bit. */
2770 int addr_bit = gdbarch_significant_addr_bit (gdbarch);
2772 if (addr_bit && (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT)))
2774 CORE_ADDR sign = (CORE_ADDR) 1 << (addr_bit - 1);
2775 addr &= ((CORE_ADDR) 1 << addr_bit) - 1;
2776 addr = (addr ^ sign) - sign;
2783 paddress (struct gdbarch *gdbarch, CORE_ADDR addr)
2785 /* Truncate address to the size of a target address, avoiding shifts
2786 larger or equal than the width of a CORE_ADDR. The local
2787 variable ADDR_BIT stops the compiler reporting a shift overflow
2788 when it won't occur. */
2789 /* NOTE: This assumes that the significant address information is
2790 kept in the least significant bits of ADDR - the upper bits were
2791 either zero or sign extended. Should gdbarch_address_to_pointer or
2792 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2794 int addr_bit = gdbarch_addr_bit (gdbarch);
2796 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2797 addr &= ((CORE_ADDR) 1 << addr_bit) - 1;
2798 return hex_string (addr);
2801 /* This function is described in "defs.h". */
2804 print_core_address (struct gdbarch *gdbarch, CORE_ADDR address)
2806 int addr_bit = gdbarch_addr_bit (gdbarch);
2808 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2809 address &= ((CORE_ADDR) 1 << addr_bit) - 1;
2811 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2812 that returns the language localized string formatted to a width
2813 based on gdbarch_addr_bit. */
2815 return hex_string_custom (address, 8);
2817 return hex_string_custom (address, 16);
2820 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2823 core_addr_hash (const void *ap)
2825 const CORE_ADDR *addrp = (const CORE_ADDR *) ap;
2830 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2833 core_addr_eq (const void *ap, const void *bp)
2835 const CORE_ADDR *addr_ap = (const CORE_ADDR *) ap;
2836 const CORE_ADDR *addr_bp = (const CORE_ADDR *) bp;
2838 return *addr_ap == *addr_bp;
2841 /* Convert a string back into a CORE_ADDR. */
2843 string_to_core_addr (const char *my_string)
2847 if (my_string[0] == '0' && tolower (my_string[1]) == 'x')
2849 /* Assume that it is in hex. */
2852 for (i = 2; my_string[i] != '\0'; i++)
2854 if (isdigit (my_string[i]))
2855 addr = (my_string[i] - '0') + (addr * 16);
2856 else if (isxdigit (my_string[i]))
2857 addr = (tolower (my_string[i]) - 'a' + 0xa) + (addr * 16);
2859 error (_("invalid hex \"%s\""), my_string);
2864 /* Assume that it is in decimal. */
2867 for (i = 0; my_string[i] != '\0'; i++)
2869 if (isdigit (my_string[i]))
2870 addr = (my_string[i] - '0') + (addr * 10);
2872 error (_("invalid decimal \"%s\""), my_string);
2882 gdb_realpath_check_trailer (const char *input, const char *trailer)
2884 gdb::unique_xmalloc_ptr<char> result = gdb_realpath (input);
2886 size_t len = strlen (result.get ());
2887 size_t trail_len = strlen (trailer);
2889 SELF_CHECK (len >= trail_len
2890 && strcmp (result.get () + len - trail_len, trailer) == 0);
2894 gdb_realpath_tests ()
2896 /* A file which contains a directory prefix. */
2897 gdb_realpath_check_trailer ("./xfullpath.exp", "/xfullpath.exp");
2898 /* A file which contains a directory prefix. */
2899 gdb_realpath_check_trailer ("../../defs.h", "/defs.h");
2900 /* A one-character filename. */
2901 gdb_realpath_check_trailer ("./a", "/a");
2902 /* A file in the root directory. */
2903 gdb_realpath_check_trailer ("/root_file_which_should_exist",
2904 "/root_file_which_should_exist");
2905 /* A file which does not have a directory prefix. */
2906 gdb_realpath_check_trailer ("xfullpath.exp", "xfullpath.exp");
2907 /* A one-char filename without any directory prefix. */
2908 gdb_realpath_check_trailer ("a", "a");
2909 /* An empty filename. */
2910 gdb_realpath_check_trailer ("", "");
2913 #endif /* GDB_SELF_TEST */
2915 /* Allocation function for the libiberty hash table which uses an
2916 obstack. The obstack is passed as DATA. */
2919 hashtab_obstack_allocate (void *data, size_t size, size_t count)
2921 size_t total = size * count;
2922 void *ptr = obstack_alloc ((struct obstack *) data, total);
2924 memset (ptr, 0, total);
2928 /* Trivial deallocation function for the libiberty splay tree and hash
2929 table - don't deallocate anything. Rely on later deletion of the
2930 obstack. DATA will be the obstack, although it is not needed
2934 dummy_obstack_deallocate (void *object, void *data)
2939 /* Simple, portable version of dirname that does not modify its
2943 ldirname (const char *filename)
2945 std::string dirname;
2946 const char *base = lbasename (filename);
2948 while (base > filename && IS_DIR_SEPARATOR (base[-1]))
2951 if (base == filename)
2954 dirname = std::string (filename, base - filename);
2956 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
2957 create "d:./bar" later instead of the (different) "d:/bar". */
2958 if (base - filename == 2 && IS_ABSOLUTE_PATH (base)
2959 && !IS_DIR_SEPARATOR (filename[0]))
2960 dirname[base++ - filename] = '.';
2968 gdb_argv::reset (const char *s)
2970 char **argv = buildargv (s);
2972 if (s != NULL && argv == NULL)
2980 compare_positive_ints (const void *ap, const void *bp)
2982 /* Because we know we're comparing two ints which are positive,
2983 there's no danger of overflow here. */
2984 return * (int *) ap - * (int *) bp;
2987 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
2988 #define AMBIGUOUS_MESS2 \
2989 ".\nUse \"set gnutarget format-name\" to specify the format."
2992 gdb_bfd_errmsg (bfd_error_type error_tag, char **matching)
2996 /* Check if errmsg just need simple return. */
2997 if (error_tag != bfd_error_file_ambiguously_recognized || matching == NULL)
2998 return bfd_errmsg (error_tag);
3000 std::string ret (bfd_errmsg (error_tag));
3001 ret += AMBIGUOUS_MESS1;
3003 for (p = matching; *p; p++)
3008 ret += AMBIGUOUS_MESS2;
3015 /* Return ARGS parsed as a valid pid, or throw an error. */
3018 parse_pid_to_attach (const char *args)
3024 error_no_arg (_("process-id to attach"));
3026 dummy = (char *) args;
3027 pid = strtoul (args, &dummy, 0);
3028 /* Some targets don't set errno on errors, grrr! */
3029 if ((pid == 0 && dummy == args) || dummy != &args[strlen (args)])
3030 error (_("Illegal process-id: %s."), args);
3035 /* Helper for make_bpstat_clear_actions_cleanup. */
3038 do_bpstat_clear_actions_cleanup (void *unused)
3040 bpstat_clear_actions ();
3043 /* Call bpstat_clear_actions for the case an exception is throw. You should
3044 discard_cleanups if no exception is caught. */
3047 make_bpstat_clear_actions_cleanup (void)
3049 return make_cleanup (do_bpstat_clear_actions_cleanup, NULL);
3052 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3053 must come from xrealloc-compatible allocator and it may be updated. FROM
3054 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3055 located at the start or end of *STRINGP. */
3058 substitute_path_component (char **stringp, const char *from, const char *to)
3060 char *string = *stringp, *s;
3061 const size_t from_len = strlen (from);
3062 const size_t to_len = strlen (to);
3066 s = strstr (s, from);
3070 if ((s == string || IS_DIR_SEPARATOR (s[-1])
3071 || s[-1] == DIRNAME_SEPARATOR)
3072 && (s[from_len] == '\0' || IS_DIR_SEPARATOR (s[from_len])
3073 || s[from_len] == DIRNAME_SEPARATOR))
3078 = (char *) xrealloc (string, (strlen (string) + to_len + 1));
3080 /* Relocate the current S pointer. */
3081 s = s - string + string_new;
3082 string = string_new;
3084 /* Replace from by to. */
3085 memmove (&s[to_len], &s[from_len], strlen (&s[from_len]) + 1);
3086 memcpy (s, to, to_len);
3101 /* SIGALRM handler for waitpid_with_timeout. */
3104 sigalrm_handler (int signo)
3106 /* Nothing to do. */
3111 /* Wrapper to wait for child PID to die with TIMEOUT.
3112 TIMEOUT is the time to stop waiting in seconds.
3113 If TIMEOUT is zero, pass WNOHANG to waitpid.
3114 Returns PID if it was successfully waited for, otherwise -1.
3116 Timeouts are currently implemented with alarm and SIGALRM.
3117 If the host does not support them, this waits "forever".
3118 It would be odd though for a host to have waitpid and not SIGALRM. */
3121 wait_to_die_with_timeout (pid_t pid, int *status, int timeout)
3123 pid_t waitpid_result;
3125 gdb_assert (pid > 0);
3126 gdb_assert (timeout >= 0);
3131 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3132 struct sigaction sa, old_sa;
3134 sa.sa_handler = sigalrm_handler;
3135 sigemptyset (&sa.sa_mask);
3137 sigaction (SIGALRM, &sa, &old_sa);
3141 ofunc = signal (SIGALRM, sigalrm_handler);
3147 waitpid_result = waitpid (pid, status, 0);
3151 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3152 sigaction (SIGALRM, &old_sa, NULL);
3154 signal (SIGALRM, ofunc);
3159 waitpid_result = waitpid (pid, status, WNOHANG);
3161 if (waitpid_result == pid)
3167 #endif /* HAVE_WAITPID */
3169 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3170 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3172 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3173 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3176 gdb_filename_fnmatch (const char *pattern, const char *string, int flags)
3178 gdb_assert ((flags & FNM_FILE_NAME) != 0);
3180 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3181 gdb_assert ((flags & FNM_NOESCAPE) != 0);
3183 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3185 char *pattern_slash, *string_slash;
3187 /* Replace '\' by '/' in both strings. */
3189 pattern_slash = (char *) alloca (strlen (pattern) + 1);
3190 strcpy (pattern_slash, pattern);
3191 pattern = pattern_slash;
3192 for (; *pattern_slash != 0; pattern_slash++)
3193 if (IS_DIR_SEPARATOR (*pattern_slash))
3194 *pattern_slash = '/';
3196 string_slash = (char *) alloca (strlen (string) + 1);
3197 strcpy (string_slash, string);
3198 string = string_slash;
3199 for (; *string_slash != 0; string_slash++)
3200 if (IS_DIR_SEPARATOR (*string_slash))
3201 *string_slash = '/';
3203 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3205 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3206 flags |= FNM_CASEFOLD;
3207 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3209 return fnmatch (pattern, string, flags);
3212 /* Return the number of path elements in PATH.
3220 count_path_elements (const char *path)
3223 const char *p = path;
3225 if (HAS_DRIVE_SPEC (p))
3227 p = STRIP_DRIVE_SPEC (p);
3233 if (IS_DIR_SEPARATOR (*p))
3238 /* Backup one if last character is /, unless it's the only one. */
3239 if (p > path + 1 && IS_DIR_SEPARATOR (p[-1]))
3242 /* Add one for the file name, if present. */
3243 if (p > path && !IS_DIR_SEPARATOR (p[-1]))
3249 /* Remove N leading path elements from PATH.
3250 N must be non-negative.
3251 If PATH has more than N path elements then return NULL.
3252 If PATH has exactly N path elements then return "".
3253 See count_path_elements for a description of how we do the counting. */
3256 strip_leading_path_elements (const char *path, int n)
3259 const char *p = path;
3261 gdb_assert (n >= 0);
3266 if (HAS_DRIVE_SPEC (p))
3268 p = STRIP_DRIVE_SPEC (p);
3274 while (*p != '\0' && !IS_DIR_SEPARATOR (*p))
3292 copy_bitwise (gdb_byte *dest, ULONGEST dest_offset,
3293 const gdb_byte *source, ULONGEST source_offset,
3294 ULONGEST nbits, int bits_big_endian)
3296 unsigned int buf, avail;
3301 if (bits_big_endian)
3303 /* Start from the end, then work backwards. */
3304 dest_offset += nbits - 1;
3305 dest += dest_offset / 8;
3306 dest_offset = 7 - dest_offset % 8;
3307 source_offset += nbits - 1;
3308 source += source_offset / 8;
3309 source_offset = 7 - source_offset % 8;
3313 dest += dest_offset / 8;
3315 source += source_offset / 8;
3319 /* Fill BUF with DEST_OFFSET bits from the destination and 8 -
3320 SOURCE_OFFSET bits from the source. */
3321 buf = *(bits_big_endian ? source-- : source++) >> source_offset;
3322 buf <<= dest_offset;
3323 buf |= *dest & ((1 << dest_offset) - 1);
3325 /* NBITS: bits yet to be written; AVAIL: BUF's fill level. */
3326 nbits += dest_offset;
3327 avail = dest_offset + 8 - source_offset;
3329 /* Flush 8 bits from BUF, if appropriate. */
3330 if (nbits >= 8 && avail >= 8)
3332 *(bits_big_endian ? dest-- : dest++) = buf;
3338 /* Copy the middle part. */
3341 size_t len = nbits / 8;
3343 /* Use a faster method for byte-aligned copies. */
3346 if (bits_big_endian)
3350 memcpy (dest + 1, source + 1, len);
3354 memcpy (dest, source, len);
3363 buf |= *(bits_big_endian ? source-- : source++) << avail;
3364 *(bits_big_endian ? dest-- : dest++) = buf;
3371 /* Write the last byte. */
3375 buf |= *source << avail;
3377 buf &= (1 << nbits) - 1;
3378 *dest = (*dest & (~0 << nbits)) | buf;
3383 _initialize_utils (void)
3385 add_internal_problem_command (&internal_error_problem);
3386 add_internal_problem_command (&internal_warning_problem);
3387 add_internal_problem_command (&demangler_warning_problem);
3390 selftests::register_test ("gdb_realpath", gdb_realpath_tests);