1 /* General utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2022 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/>. */
22 #include "gdbsupport/gdb_wait.h"
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 "gdbsupport/gdb_obstack.h"
57 #include "inferior.h" /* for signed_pointer_to_address */
59 #include "gdb_curses.h"
61 #include "readline/readline.h"
66 #include "gdbsupport/gdb_regex.h"
67 #include "gdbsupport/job-control.h"
68 #include "gdbsupport/selftest.h"
69 #include "gdbsupport/gdb_optional.h"
70 #include "cp-support.h"
72 #include "gdbsupport/pathstuff.h"
73 #include "cli/cli-style.h"
74 #include "gdbsupport/scope-exit.h"
77 #include "gdbsupport/gdb-safe-ctype.h"
79 #include "gdbsupport/buildargv.h"
81 void (*deprecated_error_begin_hook
) (void);
83 /* Prototypes for local functions */
85 static void vfprintf_maybe_filtered (struct ui_file
*, const char *,
87 ATTRIBUTE_PRINTF (2, 0);
89 static void fputs_maybe_filtered (const char *, struct ui_file
*, int);
91 static void prompt_for_continue (void);
93 static void set_screen_size (void);
94 static void set_width (void);
96 /* Time spent in prompt_for_continue in the currently executing command
97 waiting for user to respond.
98 Initialized in make_command_stats_cleanup.
99 Modified in prompt_for_continue and defaulted_query.
100 Used in report_command_stats. */
102 static std::chrono::steady_clock::duration prompt_for_continue_wait_time
;
104 /* A flag indicating whether to timestamp debugging messages. */
106 static bool debug_timestamp
= false;
108 /* True means that strings with character values >0x7F should be printed
109 as octal escapes. False means just print the value (e.g. it's an
110 international character, and the terminal or window can cope.) */
112 bool sevenbit_strings
= false;
114 show_sevenbit_strings (struct ui_file
*file
, int from_tty
,
115 struct cmd_list_element
*c
, const char *value
)
117 fprintf_filtered (file
, _("Printing of 8-bit characters "
118 "in strings as \\nnn is %s.\n"),
122 /* String to be printed before warning messages, if any. */
124 const char *warning_pre_print
= "\nwarning: ";
126 bool pagination_enabled
= true;
128 show_pagination_enabled (struct ui_file
*file
, int from_tty
,
129 struct cmd_list_element
*c
, const char *value
)
131 fprintf_filtered (file
, _("State of pagination is %s.\n"), value
);
137 /* Print a warning message. The first argument STRING is the warning
138 message, used as an fprintf format string, the second is the
139 va_list of arguments for that string. A warning is unfiltered (not
140 paginated) so that the user does not need to page through each
141 screen full of warnings when there are lots of them. */
144 vwarning (const char *string
, va_list args
)
146 if (deprecated_warning_hook
)
147 (*deprecated_warning_hook
) (string
, args
);
150 gdb::optional
<target_terminal::scoped_restore_terminal_state
> term_state
;
151 if (target_supports_terminal_ours ())
153 term_state
.emplace ();
154 target_terminal::ours_for_output ();
156 if (filtered_printing_initialized ())
157 gdb_stdout
->wrap_here (0); /* Force out any buffered output. */
158 gdb_flush (gdb_stdout
);
159 if (warning_pre_print
)
160 fputs_unfiltered (warning_pre_print
, gdb_stderr
);
161 vfprintf_unfiltered (gdb_stderr
, string
, args
);
162 fprintf_unfiltered (gdb_stderr
, "\n");
166 /* Print an error message and return to command level.
167 The first argument STRING is the error message, used as a fprintf string,
168 and the remaining args are passed as arguments to it. */
171 verror (const char *string
, va_list args
)
173 throw_verror (GENERIC_ERROR
, string
, args
);
177 error_stream (const string_file
&stream
)
179 error (("%s"), stream
.c_str ());
182 /* Emit a message and abort. */
184 static void ATTRIBUTE_NORETURN
185 abort_with_message (const char *msg
)
187 if (current_ui
== NULL
)
190 fputs_unfiltered (msg
, gdb_stderr
);
192 abort (); /* ARI: abort */
195 /* Dump core trying to increase the core soft limit to hard limit first. */
200 #ifdef HAVE_SETRLIMIT
201 struct rlimit rlim
= { (rlim_t
) RLIM_INFINITY
, (rlim_t
) RLIM_INFINITY
};
203 setrlimit (RLIMIT_CORE
, &rlim
);
204 #endif /* HAVE_SETRLIMIT */
206 /* Ensure that the SIGABRT we're about to raise will immediately cause
207 GDB to exit and dump core, we don't want to trigger GDB's printing of
208 a backtrace to the console here. */
209 signal (SIGABRT
, SIG_DFL
);
211 abort (); /* ARI: abort */
214 /* Check whether GDB will be able to dump core using the dump_core
215 function. Returns zero if GDB cannot or should not dump core.
216 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
217 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
220 can_dump_core (enum resource_limit_kind limit_kind
)
222 #ifdef HAVE_GETRLIMIT
225 /* Be quiet and assume we can dump if an error is returned. */
226 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
232 if (rlim
.rlim_cur
== 0)
237 if (rlim
.rlim_max
== 0)
240 #endif /* HAVE_GETRLIMIT */
245 /* Print a warning that we cannot dump core. */
248 warn_cant_dump_core (const char *reason
)
250 fprintf_unfiltered (gdb_stderr
,
251 _("%s\nUnable to dump core, use `ulimit -c"
252 " unlimited' before executing GDB next time.\n"),
256 /* Check whether GDB will be able to dump core using the dump_core
257 function, and print a warning if we cannot. */
260 can_dump_core_warn (enum resource_limit_kind limit_kind
,
263 int core_dump_allowed
= can_dump_core (limit_kind
);
265 if (!core_dump_allowed
)
266 warn_cant_dump_core (reason
);
268 return core_dump_allowed
;
271 /* Allow the user to configure the debugger behavior with respect to
272 what to do when an internal problem is detected. */
274 const char internal_problem_ask
[] = "ask";
275 const char internal_problem_yes
[] = "yes";
276 const char internal_problem_no
[] = "no";
277 static const char *const internal_problem_modes
[] =
279 internal_problem_ask
,
280 internal_problem_yes
,
285 /* Data structure used to control how the internal_vproblem function
286 should behave. An instance of this structure is created for each
287 problem type that GDB supports. */
289 struct internal_problem
291 /* The name of this problem type. This must not contain white space as
292 this string is used to build command names. */
295 /* When this is true then a user command is created (based on NAME) that
296 allows the SHOULD_QUIT field to be modified, otherwise, SHOULD_QUIT
297 can't be changed from its default value by the user. */
298 bool user_settable_should_quit
;
300 /* Reference a value from internal_problem_modes to indicate if GDB
301 should quit when it hits a problem of this type. */
302 const char *should_quit
;
304 /* Like USER_SETTABLE_SHOULD_QUIT but for SHOULD_DUMP_CORE. */
305 bool user_settable_should_dump_core
;
307 /* Like SHOULD_QUIT, but whether GDB should dump core. */
308 const char *should_dump_core
;
310 /* Like USER_SETTABLE_SHOULD_QUIT but for SHOULD_PRINT_BACKTRACE. */
311 bool user_settable_should_print_backtrace
;
313 /* When this is true GDB will print a backtrace when a problem of this
314 type is encountered. */
315 bool should_print_backtrace
;
318 /* Report a problem, internal to GDB, to the user. Once the problem
319 has been reported, and assuming GDB didn't quit, the caller can
320 either allow execution to resume or throw an error. */
322 static void ATTRIBUTE_PRINTF (4, 0)
323 internal_vproblem (struct internal_problem
*problem
,
324 const char *file
, int line
, const char *fmt
, va_list ap
)
331 /* Don't allow infinite error/warning recursion. */
333 static const char msg
[] = "Recursive internal problem.\n";
342 abort_with_message (msg
);
345 /* Newer GLIBC versions put the warn_unused_result attribute
346 on write, but this is one of those rare cases where
347 ignoring the return value is correct. Casting to (void)
348 does not fix this problem. This is the solution suggested
349 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
350 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
351 abort (); /* ARI: abort */
356 /* Create a string containing the full error/warning message. Need
357 to call query with this full string, as otherwize the reason
358 (error/warning) and question become separated. Format using a
359 style similar to a compiler error message. Include extra detail
360 so that the user knows that they are living on the edge. */
362 std::string msg
= string_vprintf (fmt
, ap
);
363 reason
= string_printf ("%s:%d: %s: %s\n"
364 "A problem internal to GDB has been detected,\n"
365 "further debugging may prove unreliable.",
366 file
, line
, problem
->name
, msg
.c_str ());
369 /* Fall back to abort_with_message if gdb_stderr is not set up. */
370 if (current_ui
== NULL
)
372 fputs (reason
.c_str (), stderr
);
373 abort_with_message ("\n");
376 /* Try to get the message out and at the start of a new line. */
377 gdb::optional
<target_terminal::scoped_restore_terminal_state
> term_state
;
378 if (target_supports_terminal_ours ())
380 term_state
.emplace ();
381 target_terminal::ours_for_output ();
383 if (filtered_printing_initialized ())
386 /* Emit the message unless query will emit it below. */
387 if (problem
->should_quit
!= internal_problem_ask
389 || !filtered_printing_initialized ()
390 || problem
->should_print_backtrace
)
391 fprintf_unfiltered (gdb_stderr
, "%s\n", reason
.c_str ());
393 if (problem
->should_print_backtrace
)
394 gdb_internal_backtrace ();
396 if (problem
->should_quit
== internal_problem_ask
)
398 /* Default (yes/batch case) is to quit GDB. When in batch mode
399 this lessens the likelihood of GDB going into an infinite
401 if (!confirm
|| !filtered_printing_initialized ())
404 quit_p
= query (_("%s\nQuit this debugging session? "),
407 else if (problem
->should_quit
== internal_problem_yes
)
409 else if (problem
->should_quit
== internal_problem_no
)
412 internal_error (__FILE__
, __LINE__
, _("bad switch"));
414 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr
);
415 if (REPORT_BUGS_TO
[0])
416 fprintf_unfiltered (gdb_stderr
, _(" For instructions, see:\n%s."),
418 fputs_unfiltered ("\n\n", gdb_stderr
);
420 if (problem
->should_dump_core
== internal_problem_ask
)
422 if (!can_dump_core_warn (LIMIT_MAX
, reason
.c_str ()))
424 else if (!filtered_printing_initialized ())
428 /* Default (yes/batch case) is to dump core. This leaves a GDB
429 `dropping' so that it is easier to see that something went
431 dump_core_p
= query (_("%s\nCreate a core file of GDB? "),
435 else if (problem
->should_dump_core
== internal_problem_yes
)
436 dump_core_p
= can_dump_core_warn (LIMIT_MAX
, reason
.c_str ());
437 else if (problem
->should_dump_core
== internal_problem_no
)
440 internal_error (__FILE__
, __LINE__
, _("bad switch"));
453 #ifdef HAVE_WORKING_FORK
463 static struct internal_problem internal_error_problem
= {
464 "internal-error", true, internal_problem_ask
, true, internal_problem_ask
,
465 true, GDB_PRINT_INTERNAL_BACKTRACE_INIT_ON
469 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
471 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
472 throw_quit (_("Command aborted."));
475 static struct internal_problem internal_warning_problem
= {
476 "internal-warning", true, internal_problem_ask
, true, internal_problem_ask
,
481 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
483 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
486 static struct internal_problem demangler_warning_problem
= {
487 "demangler-warning", true, internal_problem_ask
, false, internal_problem_no
,
492 demangler_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
494 internal_vproblem (&demangler_warning_problem
, file
, line
, fmt
, ap
);
498 demangler_warning (const char *file
, int line
, const char *string
, ...)
502 va_start (ap
, string
);
503 demangler_vwarning (file
, line
, string
, ap
);
507 /* When GDB reports an internal problem (error or warning) it gives
508 the user the opportunity to quit GDB and/or create a core file of
509 the current debug session. This function registers a few commands
510 that make it possible to specify that GDB should always or never
511 quit or create a core file, without asking. The commands look
514 maint set PROBLEM-NAME quit ask|yes|no
515 maint show PROBLEM-NAME quit
516 maint set PROBLEM-NAME corefile ask|yes|no
517 maint show PROBLEM-NAME corefile
519 Where PROBLEM-NAME is currently "internal-error" or
520 "internal-warning". */
523 add_internal_problem_command (struct internal_problem
*problem
)
525 struct cmd_list_element
**set_cmd_list
;
526 struct cmd_list_element
**show_cmd_list
;
528 set_cmd_list
= XNEW (struct cmd_list_element
*);
529 show_cmd_list
= XNEW (struct cmd_list_element
*);
530 *set_cmd_list
= NULL
;
531 *show_cmd_list
= NULL
;
533 /* The add_basic_prefix_cmd and add_show_prefix_cmd functions take
534 ownership of the string passed in, which is why we don't need to free
535 set_doc and show_doc in this function. */
537 = xstrprintf (_("Configure what GDB does when %s is detected."),
538 problem
->name
).release ();
540 = xstrprintf (_("Show what GDB does when %s is detected."),
541 problem
->name
).release ();
543 add_setshow_prefix_cmd (problem
->name
, class_maintenance
,
544 set_doc
, show_doc
, set_cmd_list
, show_cmd_list
,
545 &maintenance_set_cmdlist
, &maintenance_show_cmdlist
);
547 if (problem
->user_settable_should_quit
)
549 std::string set_quit_doc
550 = string_printf (_("Set whether GDB should quit when an %s is "
551 "detected."), problem
->name
);
552 std::string show_quit_doc
553 = string_printf (_("Show whether GDB will quit when an %s is "
554 "detected."), problem
->name
);
555 add_setshow_enum_cmd ("quit", class_maintenance
,
556 internal_problem_modes
,
557 &problem
->should_quit
,
558 set_quit_doc
.c_str (),
559 show_quit_doc
.c_str (),
567 if (problem
->user_settable_should_dump_core
)
569 std::string set_core_doc
570 = string_printf (_("Set whether GDB should create a core file of "
571 "GDB when %s is detected."), problem
->name
);
572 std::string show_core_doc
573 = string_printf (_("Show whether GDB will create a core file of "
574 "GDB when %s is detected."), problem
->name
);
575 add_setshow_enum_cmd ("corefile", class_maintenance
,
576 internal_problem_modes
,
577 &problem
->should_dump_core
,
578 set_core_doc
.c_str (),
579 show_core_doc
.c_str (),
587 if (problem
->user_settable_should_print_backtrace
)
589 std::string set_bt_doc
590 = string_printf (_("Set whether GDB should print a backtrace of "
591 "GDB when %s is detected."), problem
->name
);
592 std::string show_bt_doc
593 = string_printf (_("Show whether GDB will print a backtrace of "
594 "GDB when %s is detected."), problem
->name
);
595 add_setshow_boolean_cmd ("backtrace", class_maintenance
,
596 &problem
->should_print_backtrace
,
598 show_bt_doc
.c_str (),
600 gdb_internal_backtrace_set_cmd
,
607 /* Return a newly allocated string, containing the PREFIX followed
608 by the system error message for errno (separated by a colon). */
611 perror_string (const char *prefix
)
613 const char *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
)
659 const char *err
= safe_strerror (errcode
);
660 /* We want anything which was printed on stdout to come out first, before
662 gdb_flush (gdb_stdout
);
663 fprintf_unfiltered (gdb_stderr
, "%s: %s.\n", string
, err
);
666 /* Control C eventually causes this to be called, at a convenient time. */
671 if (sync_quit_force_run
)
673 sync_quit_force_run
= 0;
674 quit_force (NULL
, 0);
678 /* No steenking SIGINT will ever be coming our way when the
679 program is resumed. Don't lie. */
683 /* If there is no terminal switching for this target, then we can't
684 possibly get screwed by the lack of job control. */
685 || !target_supports_terminal_ours ())
688 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
697 if (sync_quit_force_run
)
704 /* Called when a memory allocation fails, with the number of bytes of
705 memory requested in SIZE. */
708 malloc_failure (long size
)
712 internal_error (__FILE__
, __LINE__
,
713 _("virtual memory exhausted: can't allocate %ld bytes."),
718 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
722 /* See common/errors.h. */
727 gdb_stdout
->flush ();
728 gdb_stderr
->flush ();
731 /* My replacement for the read system call.
732 Used like `read' but keeps going if `read' returns too soon. */
735 myread (int desc
, char *addr
, int len
)
742 val
= read (desc
, addr
, len
);
756 uinteger_pow (ULONGEST v1
, LONGEST v2
)
761 error (_("Attempt to raise 0 to negative power."));
767 /* The Russian Peasant's Algorithm. */
785 /* An RAII class that sets up to handle input and then tears down
786 during destruction. */
788 class scoped_input_handler
792 scoped_input_handler ()
793 : m_quit_handler (&quit_handler
, default_quit_handler
),
796 target_terminal::ours ();
797 ui_register_input_event_handler (current_ui
);
798 if (current_ui
->prompt_state
== PROMPT_BLOCKED
)
802 ~scoped_input_handler ()
805 ui_unregister_input_event_handler (m_ui
);
808 DISABLE_COPY_AND_ASSIGN (scoped_input_handler
);
812 /* Save and restore the terminal state. */
813 target_terminal::scoped_restore_terminal_state m_term_state
;
815 /* Save and restore the quit handler. */
816 scoped_restore_tmpl
<quit_handler_ftype
*> m_quit_handler
;
818 /* The saved UI, if non-NULL. */
824 /* This function supports the query, nquery, and yquery functions.
825 Ask user a y-or-n question and return 0 if answer is no, 1 if
826 answer is yes, or default the answer to the specified default
827 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
828 default answer, or '\0' for no default.
829 CTLSTR is the control string and should end in "? ". It should
830 not say how to answer, because we do that.
831 ARGS are the arguments passed along with the CTLSTR argument to
834 static int ATTRIBUTE_PRINTF (1, 0)
835 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
839 char def_answer
, not_def_answer
;
840 const char *y_string
, *n_string
;
842 /* Set up according to which answer is the default. */
847 not_def_answer
= 'N';
851 else if (defchar
== 'y')
855 not_def_answer
= 'N';
863 not_def_answer
= 'Y';
868 /* Automatically answer the default value if the user did not want
869 prompts or the command was issued with the server prefix. */
870 if (!confirm
|| server_command
)
873 /* If input isn't coming from the user directly, just say what
874 question we're asking, and then answer the default automatically. This
875 way, important error messages don't get lost when talking to GDB
877 if (current_ui
->instream
!= current_ui
->stdin_stream
878 || !input_interactive_p (current_ui
)
879 /* Restrict queries to the main UI. */
880 || current_ui
!= main_ui
)
882 target_terminal::scoped_restore_terminal_state term_state
;
883 target_terminal::ours_for_output ();
884 gdb_stdout
->wrap_here (0);
885 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
887 printf_filtered (_("(%s or %s) [answered %c; "
888 "input not from terminal]\n"),
889 y_string
, n_string
, def_answer
);
894 if (deprecated_query_hook
)
896 target_terminal::scoped_restore_terminal_state term_state
;
897 return deprecated_query_hook (ctlstr
, args
);
900 /* Format the question outside of the loop, to avoid reusing args. */
901 std::string question
= string_vprintf (ctlstr
, args
);
903 = string_printf (_("%s%s(%s or %s) %s"),
904 annotation_level
> 1 ? "\n\032\032pre-query\n" : "",
905 question
.c_str (), y_string
, n_string
,
906 annotation_level
> 1 ? "\n\032\032query\n" : "");
908 /* Used to add duration we waited for user to respond to
909 prompt_for_continue_wait_time. */
910 using namespace std::chrono
;
911 steady_clock::time_point prompt_started
= steady_clock::now ();
913 scoped_input_handler prepare_input
;
917 char *response
, answer
;
919 gdb_flush (gdb_stdout
);
920 response
= gdb_readline_wrapper (prompt
.c_str ());
922 if (response
== NULL
) /* C-d */
924 printf_filtered ("EOF [assumed %c]\n", def_answer
);
929 answer
= response
[0];
934 /* Check answer. For the non-default, the user must specify
935 the non-default explicitly. */
936 if (answer
== not_def_answer
)
941 /* Otherwise, if a default was specified, the user may either
942 specify the required input or have it default by entering
944 if (answer
== def_answer
945 || (defchar
!= '\0' && answer
== '\0'))
950 /* Invalid entries are not defaulted and require another selection. */
951 printf_filtered (_("Please answer %s or %s.\n"),
955 /* Add time spend in this routine to prompt_for_continue_wait_time. */
956 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
958 if (annotation_level
> 1)
959 printf_filtered (("\n\032\032post-query\n"));
964 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
965 answer is yes, or 0 if answer is defaulted.
966 Takes three args which are given to printf to print the question.
967 The first, a control string, should end in "? ".
968 It should not say how to answer, because we do that. */
971 nquery (const char *ctlstr
, ...)
976 va_start (args
, ctlstr
);
977 ret
= defaulted_query (ctlstr
, 'n', args
);
982 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
983 answer is yes, or 1 if answer is defaulted.
984 Takes three args which are given to printf to print the question.
985 The first, a control string, should end in "? ".
986 It should not say how to answer, because we do that. */
989 yquery (const char *ctlstr
, ...)
994 va_start (args
, ctlstr
);
995 ret
= defaulted_query (ctlstr
, 'y', args
);
1000 /* Ask user a y-or-n question and return 1 iff answer is yes.
1001 Takes three args which are given to printf to print the question.
1002 The first, a control string, should end in "? ".
1003 It should not say how to answer, because we do that. */
1006 query (const char *ctlstr
, ...)
1011 va_start (args
, ctlstr
);
1012 ret
= defaulted_query (ctlstr
, '\0', args
);
1017 /* A helper for parse_escape that converts a host character to a
1018 target character. C is the host character. If conversion is
1019 possible, then the target character is stored in *TARGET_C and the
1020 function returns 1. Otherwise, the function returns 0. */
1023 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1028 auto_obstack host_data
;
1030 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1031 (gdb_byte
*) &the_char
, 1, 1,
1032 &host_data
, translit_none
);
1034 if (obstack_object_size (&host_data
) == 1)
1037 *target_c
= *(char *) obstack_base (&host_data
);
1043 /* Parse a C escape sequence. STRING_PTR points to a variable
1044 containing a pointer to the string to parse. That pointer
1045 should point to the character after the \. That pointer
1046 is updated past the characters we use. The value of the
1047 escape sequence is returned.
1049 A negative value means the sequence \ newline was seen,
1050 which is supposed to be equivalent to nothing at all.
1052 If \ is followed by a null character, we return a negative
1053 value and leave the string pointer pointing at the null character.
1055 If \ is followed by 000, we return 0 and leave the string pointer
1056 after the zeros. A value of 0 does not mean end of string. */
1059 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1061 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1062 int c
= *(*string_ptr
)++;
1081 int i
= fromhex (c
);
1086 if (ISDIGIT (c
) && c
!= '8' && c
!= '9')
1126 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1127 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1128 " which has no equivalent\nin the `%s' character set."),
1129 c
, c
, target_charset (gdbarch
));
1134 /* Number of lines per page or UINT_MAX if paging is disabled. */
1135 static unsigned int lines_per_page
;
1137 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1138 struct cmd_list_element
*c
, const char *value
)
1140 fprintf_filtered (file
,
1141 _("Number of lines gdb thinks are in a page is %s.\n"),
1145 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1146 static unsigned int chars_per_line
;
1148 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1149 struct cmd_list_element
*c
, const char *value
)
1151 fprintf_filtered (file
,
1152 _("Number of characters gdb thinks "
1153 "are in a line is %s.\n"),
1157 /* Current count of lines printed on this page, chars on this line. */
1158 static unsigned int lines_printed
, chars_printed
;
1160 /* True if pagination is disabled for just one command. */
1162 static bool pagination_disabled_for_command
;
1164 /* Buffer and start column of buffered text, for doing smarter word-
1165 wrapping. When someone calls wrap_here(), we start buffering output
1166 that comes through fputs_filtered(). If we see a newline, we just
1167 spit it out and forget about the wrap_here(). If we see another
1168 wrap_here(), we spit it out and remember the newer one. If we see
1169 the end of the line, we spit out a newline, the indent, and then
1170 the buffered output. */
1172 static bool filter_initialized
= false;
1174 /* Contains characters which are waiting to be output (they have
1175 already been counted in chars_printed). */
1176 static std::string wrap_buffer
;
1178 /* String to indent by if the wrap occurs. */
1179 static int wrap_indent
;
1181 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1182 is not in effect. */
1183 static int wrap_column
;
1185 /* The style applied at the time that wrap_here was called. */
1186 static ui_file_style wrap_style
;
1189 /* Initialize the number of lines per page and chars per line. */
1192 init_page_info (void)
1196 lines_per_page
= UINT_MAX
;
1197 chars_per_line
= UINT_MAX
;
1201 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1206 #if defined(__GO32__)
1207 rows
= ScreenRows ();
1208 cols
= ScreenCols ();
1209 lines_per_page
= rows
;
1210 chars_per_line
= cols
;
1212 /* Make sure Readline has initialized its terminal settings. */
1213 rl_reset_terminal (NULL
);
1215 /* Get the screen size from Readline. */
1216 rl_get_screen_size (&rows
, &cols
);
1217 lines_per_page
= rows
;
1218 chars_per_line
= cols
;
1220 /* Readline should have fetched the termcap entry for us.
1221 Only try to use tgetnum function if rl_get_screen_size
1222 did not return a useful value. */
1223 if (((rows
<= 0) && (tgetnum ((char *) "li") < 0))
1224 /* Also disable paging if inside Emacs. $EMACS was used
1225 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1226 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1228 /* The number of lines per page is not mentioned in the terminal
1229 description or EMACS environment variable is set. This probably
1230 means that paging is not useful, so disable paging. */
1231 lines_per_page
= UINT_MAX
;
1234 /* If the output is not a terminal, don't paginate it. */
1235 if (!gdb_stdout
->isatty ())
1236 lines_per_page
= UINT_MAX
;
1240 /* We handle SIGWINCH ourselves. */
1241 rl_catch_sigwinch
= 0;
1247 /* Return nonzero if filtered printing is initialized. */
1249 filtered_printing_initialized (void)
1251 return filter_initialized
;
1254 set_batch_flag_and_restore_page_info::set_batch_flag_and_restore_page_info ()
1255 : m_save_lines_per_page (lines_per_page
),
1256 m_save_chars_per_line (chars_per_line
),
1257 m_save_batch_flag (batch_flag
)
1263 set_batch_flag_and_restore_page_info::~set_batch_flag_and_restore_page_info ()
1265 batch_flag
= m_save_batch_flag
;
1266 chars_per_line
= m_save_chars_per_line
;
1267 lines_per_page
= m_save_lines_per_page
;
1273 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1276 set_screen_size (void)
1278 int rows
= lines_per_page
;
1279 int cols
= chars_per_line
;
1281 /* If we get 0 or negative ROWS or COLS, treat as "infinite" size.
1282 A negative number can be seen here with the "set width/height"
1283 commands and either:
1285 - the user specified "unlimited", which maps to UINT_MAX, or
1286 - the user specified some number between INT_MAX and UINT_MAX.
1288 Cap "infinity" to approximately sqrt(INT_MAX) so that we don't
1289 overflow in rl_set_screen_size, which multiplies rows and columns
1290 to compute the number of characters on the screen. */
1292 const int sqrt_int_max
= INT_MAX
>> (sizeof (int) * 8 / 2);
1294 if (rows
<= 0 || rows
> sqrt_int_max
)
1296 rows
= sqrt_int_max
;
1297 lines_per_page
= UINT_MAX
;
1300 if (cols
<= 0 || cols
> sqrt_int_max
)
1302 cols
= sqrt_int_max
;
1303 chars_per_line
= UINT_MAX
;
1306 /* Update Readline's idea of the terminal size. */
1307 rl_set_screen_size (rows
, cols
);
1310 /* Reinitialize WRAP_BUFFER. */
1315 if (chars_per_line
== 0)
1318 wrap_buffer
.clear ();
1319 filter_initialized
= true;
1323 set_width_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1330 set_height_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1338 set_screen_width_and_height (int width
, int height
)
1340 lines_per_page
= height
;
1341 chars_per_line
= width
;
1347 /* The currently applied style. */
1349 static ui_file_style applied_style
;
1351 /* Emit an ANSI style escape for STYLE. If STREAM is nullptr, emit to
1352 the wrap buffer; otherwise emit to STREAM. */
1355 emit_style_escape (const ui_file_style
&style
,
1356 struct ui_file
*stream
= nullptr)
1358 if (applied_style
!= style
)
1360 applied_style
= style
;
1362 if (stream
== nullptr)
1363 wrap_buffer
.append (style
.to_ansi ());
1365 stream
->puts (style
.to_ansi ().c_str ());
1369 /* Set the current output style. This will affect future uses of the
1370 _filtered output functions. */
1373 set_output_style (struct ui_file
*stream
, const ui_file_style
&style
)
1375 if (!stream
->can_emit_style_escape ())
1378 /* Note that we may not pass STREAM here, when we want to emit to
1379 the wrap buffer, not directly to STREAM. */
1380 if (stream
== gdb_stdout
)
1382 emit_style_escape (style
, stream
);
1388 reset_terminal_style (struct ui_file
*stream
)
1390 if (stream
->can_emit_style_escape ())
1392 /* Force the setting, regardless of what we think the setting
1393 might already be. */
1394 applied_style
= ui_file_style ();
1395 wrap_buffer
.append (applied_style
.to_ansi ());
1399 /* Wait, so the user can read what's on the screen. Prompt the user
1400 to continue by pressing RETURN. 'q' is also provided because
1401 telling users what to do in the prompt is more user-friendly than
1402 expecting them to think of Ctrl-C/SIGINT. */
1405 prompt_for_continue (void)
1407 char cont_prompt
[120];
1408 /* Used to add duration we waited for user to respond to
1409 prompt_for_continue_wait_time. */
1410 using namespace std::chrono
;
1411 steady_clock::time_point prompt_started
= steady_clock::now ();
1412 bool disable_pagination
= pagination_disabled_for_command
;
1414 /* Clear the current styling. */
1415 if (gdb_stdout
->can_emit_style_escape ())
1416 emit_style_escape (ui_file_style (), gdb_stdout
);
1418 if (annotation_level
> 1)
1419 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1421 strcpy (cont_prompt
,
1422 "--Type <RET> for more, q to quit, "
1423 "c to continue without paging--");
1424 if (annotation_level
> 1)
1425 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1427 /* We must do this *before* we call gdb_readline_wrapper, else it
1428 will eventually call us -- thinking that we're trying to print
1429 beyond the end of the screen. */
1430 reinitialize_more_filter ();
1432 scoped_input_handler prepare_input
;
1434 /* Call gdb_readline_wrapper, not readline, in order to keep an
1435 event loop running. */
1436 gdb::unique_xmalloc_ptr
<char> ignore (gdb_readline_wrapper (cont_prompt
));
1438 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1439 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1441 if (annotation_level
> 1)
1442 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1446 char *p
= ignore
.get ();
1448 while (*p
== ' ' || *p
== '\t')
1451 /* Do not call quit here; there is no possibility of SIGINT. */
1452 throw_quit ("Quit");
1454 disable_pagination
= true;
1457 /* Now we have to do this again, so that GDB will know that it doesn't
1458 need to save the ---Type <return>--- line at the top of the screen. */
1459 reinitialize_more_filter ();
1460 pagination_disabled_for_command
= disable_pagination
;
1462 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1465 /* Initialize timer to keep track of how long we waited for the user. */
1468 reset_prompt_for_continue_wait_time (void)
1470 using namespace std::chrono
;
1472 prompt_for_continue_wait_time
= steady_clock::duration::zero ();
1475 /* Fetch the cumulative time spent in prompt_for_continue. */
1477 std::chrono::steady_clock::duration
1478 get_prompt_for_continue_wait_time ()
1480 return prompt_for_continue_wait_time
;
1483 /* Reinitialize filter; ie. tell it to reset to original values. */
1486 reinitialize_more_filter (void)
1490 pagination_disabled_for_command
= false;
1493 /* Flush the wrap buffer to STREAM, if necessary. */
1496 flush_wrap_buffer (struct ui_file
*stream
)
1498 if (stream
== gdb_stdout
&& !wrap_buffer
.empty ())
1500 stream
->puts (wrap_buffer
.c_str ());
1501 wrap_buffer
.clear ();
1508 gdb_flush (struct ui_file
*stream
)
1510 flush_wrap_buffer (stream
);
1517 get_chars_per_line ()
1519 return chars_per_line
;
1522 /* See ui-file.h. */
1525 ui_file::wrap_here (int indent
)
1527 /* This should have been allocated, but be paranoid anyway. */
1528 gdb_assert (filter_initialized
);
1530 flush_wrap_buffer (this);
1531 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1535 else if (chars_printed
>= chars_per_line
)
1537 puts_filtered ("\n");
1539 puts_filtered (n_spaces (indent
));
1544 wrap_column
= chars_printed
;
1545 wrap_indent
= indent
;
1546 wrap_style
= applied_style
;
1550 /* Print input string to gdb_stdout, filtered, with wrap,
1551 arranging strings in columns of n chars. String can be
1552 right or left justified in the column. Never prints
1553 trailing spaces. String should never be longer than
1554 width. FIXME: this could be useful for the EXAMINE
1555 command, which currently doesn't tabulate very well. */
1558 puts_filtered_tabular (char *string
, int width
, int right
)
1564 gdb_assert (chars_per_line
> 0);
1565 if (chars_per_line
== UINT_MAX
)
1567 puts_filtered (string
);
1568 puts_filtered ("\n");
1572 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1573 puts_filtered ("\n");
1575 if (width
>= chars_per_line
)
1576 width
= chars_per_line
- 1;
1578 stringlen
= strlen (string
);
1580 if (chars_printed
> 0)
1581 spaces
= width
- (chars_printed
- 1) % width
- 1;
1583 spaces
+= width
- stringlen
;
1585 spacebuf
= (char *) alloca (spaces
+ 1);
1586 spacebuf
[spaces
] = '\0';
1588 spacebuf
[spaces
] = ' ';
1590 puts_filtered (spacebuf
);
1591 puts_filtered (string
);
1595 /* Ensure that whatever gets printed next, using the filtered output
1596 commands, starts at the beginning of the line. I.e. if there is
1597 any pending output for the current line, flush it and start a new
1598 line. Otherwise do nothing. */
1603 if (chars_printed
> 0)
1605 puts_filtered ("\n");
1610 /* Like fputs but if FILTER is true, pause after every screenful.
1612 Regardless of FILTER can wrap at points other than the final
1613 character of a line.
1615 Unlike fputs, fputs_maybe_filtered does not return a value.
1616 It is OK for LINEBUFFER to be NULL, in which case just don't print
1619 Note that a longjmp to top level may occur in this routine (only if
1620 FILTER is true) (since prompt_for_continue may do so) so this
1621 routine should not be called when cleanups are not in place. */
1624 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1627 const char *lineptr
;
1629 if (linebuffer
== 0)
1632 /* Don't do any filtering if it is disabled. */
1633 if (!stream
->can_page ()
1634 || stream
!= gdb_stdout
1635 || !pagination_enabled
1636 || pagination_disabled_for_command
1638 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
1639 || top_level_interpreter () == NULL
1640 || top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
1642 flush_wrap_buffer (stream
);
1643 stream
->puts (linebuffer
);
1648 = make_scope_exit ([&] ()
1650 wrap_buffer
.clear ();
1655 /* Go through and output each character. Show line extension
1656 when this is necessary; prompt user for new page when this is
1659 lineptr
= linebuffer
;
1662 /* Possible new page. Note that PAGINATION_DISABLED_FOR_COMMAND
1663 might be set during this loop, so we must continue to check
1665 if (filter
&& (lines_printed
>= lines_per_page
- 1)
1666 && !pagination_disabled_for_command
)
1667 prompt_for_continue ();
1669 while (*lineptr
&& *lineptr
!= '\n')
1673 /* Print a single line. */
1674 if (*lineptr
== '\t')
1676 wrap_buffer
.push_back ('\t');
1677 /* Shifting right by 3 produces the number of tab stops
1678 we have already passed, and then adding one and
1679 shifting left 3 advances to the next tab stop. */
1680 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
1683 else if (*lineptr
== '\033'
1684 && skip_ansi_escape (lineptr
, &skip_bytes
))
1686 wrap_buffer
.append (lineptr
, skip_bytes
);
1687 /* Note that we don't consider this a character, so we
1688 don't increment chars_printed here. */
1689 lineptr
+= skip_bytes
;
1691 else if (*lineptr
== '\r')
1693 wrap_buffer
.push_back (*lineptr
);
1699 wrap_buffer
.push_back (*lineptr
);
1704 if (chars_printed
>= chars_per_line
)
1706 unsigned int save_chars
= chars_printed
;
1708 /* If we change the style, below, we'll want to reset it
1709 before continuing to print. If there is no wrap
1710 column, then we'll only reset the style if the pager
1711 prompt is given; and to avoid emitting style
1712 sequences in the middle of a run of text, we track
1714 ui_file_style save_style
= applied_style
;
1715 bool did_paginate
= false;
1721 /* We are about to insert a newline at an historic
1722 location in the WRAP_BUFFER. Before we do we want to
1723 restore the default style. To know if we actually
1724 need to insert an escape sequence we must restore the
1725 current applied style to how it was at the WRAP_COLUMN
1727 applied_style
= wrap_style
;
1728 if (stream
->can_emit_style_escape ())
1729 emit_style_escape (ui_file_style (), stream
);
1730 /* If we aren't actually wrapping, don't output
1731 newline -- if chars_per_line is right, we
1732 probably just overflowed anyway; if it's wrong,
1733 let us keep going. */
1734 /* XXX: The ideal thing would be to call
1735 'stream->putc' here, but we can't because it
1736 currently calls 'fputc_unfiltered', which ends up
1737 calling us, which generates an infinite
1739 stream
->puts ("\n");
1742 flush_wrap_buffer (stream
);
1744 /* Possible new page. Note that
1745 PAGINATION_DISABLED_FOR_COMMAND might be set during
1746 this loop, so we must continue to check it here. */
1747 if (lines_printed
>= lines_per_page
- 1
1748 && !pagination_disabled_for_command
)
1750 prompt_for_continue ();
1751 did_paginate
= true;
1754 /* Now output indentation and wrapped string. */
1757 stream
->puts (n_spaces (wrap_indent
));
1759 /* Having finished inserting the wrapping we should
1760 restore the style as it was at the WRAP_COLUMN. */
1761 if (stream
->can_emit_style_escape ())
1762 emit_style_escape (wrap_style
, stream
);
1764 /* The WRAP_BUFFER will still contain content, and that
1765 content might set some alternative style. Restore
1766 APPLIED_STYLE as it was before we started wrapping,
1767 this reflects the current style for the last character
1769 applied_style
= save_style
;
1771 /* Note that this can set chars_printed > chars_per_line
1772 if we are printing a long string. */
1773 chars_printed
= wrap_indent
+ (save_chars
- wrap_column
);
1774 wrap_column
= 0; /* And disable fancy wrap */
1776 else if (did_paginate
&& stream
->can_emit_style_escape ())
1777 emit_style_escape (save_style
, stream
);
1781 if (*lineptr
== '\n')
1784 stream
->wrap_here (0); /* Spit out chars, cancel
1787 /* XXX: The ideal thing would be to call
1788 'stream->putc' here, but we can't because it
1789 currently calls 'fputc_unfiltered', which ends up
1790 calling us, which generates an infinite
1792 stream
->puts ("\n");
1797 buffer_clearer
.release ();
1801 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
1803 fputs_maybe_filtered (linebuffer
, stream
, 1);
1807 fputs_unfiltered (const char *linebuffer
, struct ui_file
*stream
)
1809 fputs_maybe_filtered (linebuffer
, stream
, 0);
1815 fputs_styled (const char *linebuffer
, const ui_file_style
&style
,
1816 struct ui_file
*stream
)
1818 set_output_style (stream
, style
);
1819 fputs_maybe_filtered (linebuffer
, stream
, 1);
1820 set_output_style (stream
, ui_file_style ());
1826 fputs_styled_unfiltered (const char *linebuffer
, const ui_file_style
&style
,
1827 struct ui_file
*stream
)
1829 set_output_style (stream
, style
);
1830 fputs_maybe_filtered (linebuffer
, stream
, 0);
1831 set_output_style (stream
, ui_file_style ());
1837 fputs_highlighted (const char *str
, const compiled_regex
&highlight
,
1838 struct ui_file
*stream
)
1842 while (*str
&& highlight
.exec (str
, 1, &pmatch
, 0) == 0)
1844 size_t n_highlight
= pmatch
.rm_eo
- pmatch
.rm_so
;
1846 /* Output the part before pmatch with current style. */
1847 while (pmatch
.rm_so
> 0)
1849 fputc_filtered (*str
, stream
);
1854 /* Output pmatch with the highlight style. */
1855 set_output_style (stream
, highlight_style
.style ());
1856 while (n_highlight
> 0)
1858 fputc_filtered (*str
, stream
);
1862 set_output_style (stream
, ui_file_style ());
1865 /* Output the trailing part of STR not matching HIGHLIGHT. */
1867 fputs_filtered (str
, stream
);
1871 putchar_unfiltered (int c
)
1873 return fputc_unfiltered (c
, gdb_stdout
);
1876 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
1877 May return nonlocally. */
1880 putchar_filtered (int c
)
1882 return fputc_filtered (c
, gdb_stdout
);
1886 fputc_unfiltered (int c
, struct ui_file
*stream
)
1892 fputs_unfiltered (buf
, stream
);
1897 fputc_filtered (int c
, struct ui_file
*stream
)
1903 fputs_filtered (buf
, stream
);
1907 /* Print a variable number of ARGS using format FORMAT. If this
1908 information is going to put the amount written (since the last call
1909 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
1910 call prompt_for_continue to get the users permission to continue.
1912 Unlike fprintf, this function does not return a value.
1914 We implement three variants, vfprintf (takes a vararg list and stream),
1915 fprintf (takes a stream to write on), and printf (the usual).
1917 Note also that this may throw a quit (since prompt_for_continue may
1921 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
1922 va_list args
, bool filter
)
1924 ui_out_flags flags
= disallow_ui_out_field
;
1926 flags
|= unfiltered_output
;
1927 cli_ui_out (stream
, flags
).vmessage (applied_style
, format
, args
);
1932 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
1934 vfprintf_maybe_filtered (stream
, format
, args
, true);
1938 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
1940 if (debug_timestamp
&& stream
== gdb_stdlog
)
1942 static bool needs_timestamp
= true;
1944 /* Print timestamp if previous print ended with a \n. */
1945 if (needs_timestamp
)
1947 using namespace std::chrono
;
1949 steady_clock::time_point now
= steady_clock::now ();
1950 seconds s
= duration_cast
<seconds
> (now
.time_since_epoch ());
1951 microseconds us
= duration_cast
<microseconds
> (now
.time_since_epoch () - s
);
1952 std::string timestamp
= string_printf ("%ld.%06ld ",
1954 (long) us
.count ());
1955 fputs_unfiltered (timestamp
.c_str (), stream
);
1958 /* Print the message. */
1960 cli_ui_out (&sfile
, 0).vmessage (ui_file_style (), format
, args
);
1961 const std::string
&linebuffer
= sfile
.string ();
1962 fputs_unfiltered (linebuffer
.c_str (), stream
);
1964 size_t len
= linebuffer
.length ();
1965 needs_timestamp
= (len
> 0 && linebuffer
[len
- 1] == '\n');
1968 vfprintf_maybe_filtered (stream
, format
, args
, false);
1972 vprintf_filtered (const char *format
, va_list args
)
1974 vfprintf_filtered (gdb_stdout
, format
, args
);
1978 vprintf_unfiltered (const char *format
, va_list args
)
1980 vfprintf_unfiltered (gdb_stdout
, format
, args
);
1984 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
1988 va_start (args
, format
);
1989 vfprintf_filtered (stream
, format
, args
);
1994 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
1998 va_start (args
, format
);
1999 vfprintf_unfiltered (stream
, format
, args
);
2006 fprintf_styled (struct ui_file
*stream
, const ui_file_style
&style
,
2007 const char *format
, ...)
2011 set_output_style (stream
, style
);
2012 va_start (args
, format
);
2013 vfprintf_filtered (stream
, format
, args
);
2015 set_output_style (stream
, ui_file_style ());
2021 vfprintf_styled (struct ui_file
*stream
, const ui_file_style
&style
,
2022 const char *format
, va_list args
)
2024 set_output_style (stream
, style
);
2025 vfprintf_filtered (stream
, format
, args
);
2026 set_output_style (stream
, ui_file_style ());
2032 vfprintf_styled_no_gdbfmt (struct ui_file
*stream
, const ui_file_style
&style
,
2033 bool filter
, const char *format
, va_list args
)
2035 std::string str
= string_vprintf (format
, args
);
2038 set_output_style (stream
, style
);
2039 fputs_maybe_filtered (str
.c_str (), stream
, filter
);
2040 set_output_style (stream
, ui_file_style ());
2045 printf_filtered (const char *format
, ...)
2049 va_start (args
, format
);
2050 vfprintf_filtered (gdb_stdout
, format
, args
);
2056 printf_unfiltered (const char *format
, ...)
2060 va_start (args
, format
);
2061 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2065 /* Easy -- but watch out!
2067 This routine is *not* a replacement for puts()! puts() appends a newline.
2068 This one doesn't, and had better not! */
2071 puts_filtered (const char *string
)
2073 fputs_filtered (string
, gdb_stdout
);
2077 puts_unfiltered (const char *string
)
2079 fputs_unfiltered (string
, gdb_stdout
);
2082 /* Return a pointer to N spaces and a null. The pointer is good
2083 until the next call to here. */
2088 static char *spaces
= 0;
2089 static int max_spaces
= -1;
2094 spaces
= (char *) xmalloc (n
+ 1);
2095 for (t
= spaces
+ n
; t
!= spaces
;)
2101 return spaces
+ max_spaces
- n
;
2104 /* Print N spaces. */
2106 print_spaces_filtered (int n
, struct ui_file
*stream
)
2108 fputs_filtered (n_spaces (n
), stream
);
2111 /* C++/ObjC demangler stuff. */
2113 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2114 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2115 If the name is not mangled, or the language for the name is unknown, or
2116 demangling is off, the name is printed in its "raw" form. */
2119 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2120 enum language lang
, int arg_mode
)
2124 /* If user wants to see raw output, no problem. */
2127 fputs_filtered (name
, stream
);
2131 gdb::unique_xmalloc_ptr
<char> demangled
2132 = language_demangle (language_def (lang
), name
, arg_mode
);
2133 fputs_filtered (demangled
? demangled
.get () : name
, stream
);
2138 /* True if CH is a character that can be part of a symbol name. I.e.,
2139 either a number, a letter, or a '_'. */
2142 valid_identifier_name_char (int ch
)
2144 return (ISALNUM (ch
) || ch
== '_');
2147 /* Skip to end of token, or to END, whatever comes first. Input is
2148 assumed to be a C++ operator name. */
2151 cp_skip_operator_token (const char *token
, const char *end
)
2153 const char *p
= token
;
2154 while (p
!= end
&& !ISSPACE (*p
) && *p
!= '(')
2156 if (valid_identifier_name_char (*p
))
2158 while (p
!= end
&& valid_identifier_name_char (*p
))
2164 /* Note, ordered such that among ops that share a prefix,
2165 longer comes first. This is so that the loop below can
2166 bail on first match. */
2167 static const char *ops
[] =
2173 "-=", "--", "->", "-",
2182 "<<=", "<=", "<<", "<",
2183 ">>=", ">=", ">>", ">",
2187 for (const char *op
: ops
)
2189 size_t oplen
= strlen (op
);
2190 size_t lencmp
= std::min
<size_t> (oplen
, end
- p
);
2192 if (strncmp (p
, op
, lencmp
) == 0)
2195 /* Some unidentified character. Return it. */
2203 /* Advance STRING1/STRING2 past whitespace. */
2206 skip_ws (const char *&string1
, const char *&string2
, const char *end_str2
)
2208 while (ISSPACE (*string1
))
2210 while (string2
< end_str2
&& ISSPACE (*string2
))
2214 /* True if STRING points at the start of a C++ operator name. START
2215 is the start of the string that STRING points to, hence when
2216 reading backwards, we must not read any character before START. */
2219 cp_is_operator (const char *string
, const char *start
)
2221 return ((string
== start
2222 || !valid_identifier_name_char (string
[-1]))
2223 && strncmp (string
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
2224 && !valid_identifier_name_char (string
[CP_OPERATOR_LEN
]));
2227 /* If *NAME points at an ABI tag, skip it and return true. Otherwise
2228 leave *NAME unmodified and return false. (see GCC's abi_tag
2229 attribute), such names are demangled as e.g.,
2230 "function[abi:cxx11]()". */
2233 skip_abi_tag (const char **name
)
2235 const char *p
= *name
;
2237 if (startswith (p
, "[abi:"))
2241 while (valid_identifier_name_char (*p
))
2257 strncmp_iw_with_mode (const char *string1
, const char *string2
,
2258 size_t string2_len
, strncmp_iw_mode mode
,
2259 enum language language
,
2260 completion_match_for_lcd
*match_for_lcd
)
2262 const char *string1_start
= string1
;
2263 const char *end_str2
= string2
+ string2_len
;
2264 bool skip_spaces
= true;
2265 bool have_colon_op
= (language
== language_cplus
2266 || language
== language_rust
2267 || language
== language_fortran
);
2272 || ((ISSPACE (*string1
) && !valid_identifier_name_char (*string2
))
2273 || (ISSPACE (*string2
) && !valid_identifier_name_char (*string1
))))
2275 skip_ws (string1
, string2
, end_str2
);
2276 skip_spaces
= false;
2279 /* Skip [abi:cxx11] tags in the symbol name if the lookup name
2280 doesn't include them. E.g.:
2282 string1: function[abi:cxx1](int)
2285 string1: function[abi:cxx1](int)
2286 string2: function(int)
2288 string1: Struct[abi:cxx1]::function()
2289 string2: Struct::function()
2291 string1: function(Struct[abi:cxx1], int)
2292 string2: function(Struct, int)
2294 if (string2
== end_str2
2295 || (*string2
!= '[' && !valid_identifier_name_char (*string2
)))
2297 const char *abi_start
= string1
;
2299 /* There can be more than one tag. */
2300 while (*string1
== '[' && skip_abi_tag (&string1
))
2303 if (match_for_lcd
!= NULL
&& abi_start
!= string1
)
2304 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2306 while (ISSPACE (*string1
))
2310 if (*string1
== '\0' || string2
== end_str2
)
2313 /* Handle the :: operator. */
2314 if (have_colon_op
&& string1
[0] == ':' && string1
[1] == ':')
2316 if (*string2
!= ':')
2322 if (string2
== end_str2
)
2325 if (*string2
!= ':')
2331 while (ISSPACE (*string1
))
2333 while (string2
< end_str2
&& ISSPACE (*string2
))
2338 /* Handle C++ user-defined operators. */
2339 else if (language
== language_cplus
2342 if (cp_is_operator (string1
, string1_start
))
2344 /* An operator name in STRING1. Check STRING2. */
2346 = std::min
<size_t> (CP_OPERATOR_LEN
, end_str2
- string2
);
2347 if (strncmp (string1
, string2
, cmplen
) != 0)
2353 if (string2
!= end_str2
)
2355 /* Check for "operatorX" in STRING2. */
2356 if (valid_identifier_name_char (*string2
))
2359 skip_ws (string1
, string2
, end_str2
);
2362 /* Handle operator(). */
2363 if (*string1
== '(')
2365 if (string2
== end_str2
)
2367 if (mode
== strncmp_iw_mode::NORMAL
)
2371 /* Don't break for the regular return at the
2372 bottom, because "operator" should not
2373 match "operator()", since this open
2374 parentheses is not the parameter list
2376 return *string1
!= '\0';
2380 if (*string1
!= *string2
)
2389 skip_ws (string1
, string2
, end_str2
);
2391 /* Skip to end of token, or to END, whatever comes
2393 const char *end_str1
= string1
+ strlen (string1
);
2394 const char *p1
= cp_skip_operator_token (string1
, end_str1
);
2395 const char *p2
= cp_skip_operator_token (string2
, end_str2
);
2397 cmplen
= std::min (p1
- string1
, p2
- string2
);
2400 if (strncmp (string1
, string2
, cmplen
) != 0)
2405 if (p1
- string1
!= p2
- string2
)
2407 if (strncmp (string1
, string2
, cmplen
) != 0)
2414 if (*string1
== '\0' || string2
== end_str2
)
2416 if (*string1
== '(' || *string2
== '(')
2424 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2426 if (case_sensitivity
== case_sensitive_off
2427 && (TOLOWER ((unsigned char) *string1
)
2428 != TOLOWER ((unsigned char) *string2
)))
2431 /* If we see any non-whitespace, non-identifier-name character
2432 (any of "()<>*&" etc.), then skip spaces the next time
2434 if (!ISSPACE (*string1
) && !valid_identifier_name_char (*string1
))
2441 if (string2
== end_str2
)
2443 if (mode
== strncmp_iw_mode::NORMAL
)
2445 /* Strip abi tag markers from the matched symbol name.
2446 Usually the ABI marker will be found on function name
2447 (automatically added because the function returns an
2448 object marked with an ABI tag). However, it's also
2449 possible to see a marker in one of the function
2450 parameters, for example.
2452 string2 (lookup name):
2455 function(some_struct[abi:cxx11], int)
2457 and for completion LCD computation we want to say that
2459 function(some_struct, int)
2461 if (match_for_lcd
!= NULL
)
2463 while ((string1
= strstr (string1
, "[abi:")) != NULL
)
2465 const char *abi_start
= string1
;
2467 /* There can be more than one tag. */
2468 while (skip_abi_tag (&string1
) && *string1
== '[')
2471 if (abi_start
!= string1
)
2472 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2479 return (*string1
!= '\0' && *string1
!= '(');
2488 strncmp_iw (const char *string1
, const char *string2
, size_t string2_len
)
2490 return strncmp_iw_with_mode (string1
, string2
, string2_len
,
2491 strncmp_iw_mode::NORMAL
, language_minimal
);
2497 strcmp_iw (const char *string1
, const char *string2
)
2499 return strncmp_iw_with_mode (string1
, string2
, strlen (string2
),
2500 strncmp_iw_mode::MATCH_PARAMS
, language_minimal
);
2503 /* This is like strcmp except that it ignores whitespace and treats
2504 '(' as the first non-NULL character in terms of ordering. Like
2505 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2506 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2507 according to that ordering.
2509 If a list is sorted according to this function and if you want to
2510 find names in the list that match some fixed NAME according to
2511 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2512 where this function would put NAME.
2514 This function must be neutral to the CASE_SENSITIVITY setting as the user
2515 may choose it during later lookup. Therefore this function always sorts
2516 primarily case-insensitively and secondarily case-sensitively.
2518 Here are some examples of why using strcmp to sort is a bad idea:
2522 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2523 we try to do a search for "foo<char*>", strcmp will locate this
2524 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2525 will start looking at strings beginning with "goo", and will never
2526 see the correct match of "foo<char *>".
2528 Parenthesis example:
2530 In practice, this is less like to be an issue, but I'll give it a
2531 shot. Let's assume that '$' is a legitimate character to occur in
2532 symbols. (Which may well even be the case on some systems.) Then
2533 say that the partial symbol table contains "foo$" and "foo(int)".
2534 strcmp will put them in this order, since '$' < '('. Now, if the
2535 user searches for "foo", then strcmp will sort "foo" before "foo$".
2536 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2537 "foo") is false, so it won't proceed to the actual match of
2538 "foo(int)" with "foo". */
2541 strcmp_iw_ordered (const char *string1
, const char *string2
)
2543 const char *saved_string1
= string1
, *saved_string2
= string2
;
2544 enum case_sensitivity case_pass
= case_sensitive_off
;
2548 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2549 Provide stub characters if we are already at the end of one of the
2551 char c1
= 'X', c2
= 'X';
2553 while (*string1
!= '\0' && *string2
!= '\0')
2555 while (ISSPACE (*string1
))
2557 while (ISSPACE (*string2
))
2562 case case_sensitive_off
:
2563 c1
= TOLOWER ((unsigned char) *string1
);
2564 c2
= TOLOWER ((unsigned char) *string2
);
2566 case case_sensitive_on
:
2574 if (*string1
!= '\0')
2583 /* Characters are non-equal unless they're both '\0'; we want to
2584 make sure we get the comparison right according to our
2585 comparison in the cases where one of them is '\0' or '('. */
2587 if (*string2
== '\0')
2592 if (*string2
== '\0')
2597 if (*string2
== '\0' || *string2
== '(')
2606 if (case_pass
== case_sensitive_on
)
2609 /* Otherwise the strings were equal in case insensitive way, make
2610 a more fine grained comparison in a case sensitive way. */
2612 case_pass
= case_sensitive_on
;
2613 string1
= saved_string1
;
2614 string2
= saved_string2
;
2621 streq (const char *lhs
, const char *rhs
)
2623 return !strcmp (lhs
, rhs
);
2630 ** Answer whether string_to_compare is a full or partial match to
2631 ** template_string. The partial match must be in sequence starting
2635 subset_compare (const char *string_to_compare
, const char *template_string
)
2639 if (template_string
!= NULL
&& string_to_compare
!= NULL
2640 && strlen (string_to_compare
) <= strlen (template_string
))
2642 (startswith (template_string
, string_to_compare
));
2649 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2650 struct cmd_list_element
*c
, const char *value
)
2652 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2660 address_significant (gdbarch
*gdbarch
, CORE_ADDR addr
)
2662 /* Clear insignificant bits of a target address and sign extend resulting
2663 address, avoiding shifts larger or equal than the width of a CORE_ADDR.
2664 The local variable ADDR_BIT stops the compiler reporting a shift overflow
2665 when it won't occur. Skip updating of target address if current target
2666 has not set gdbarch significant_addr_bit. */
2667 int addr_bit
= gdbarch_significant_addr_bit (gdbarch
);
2669 if (addr_bit
&& (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
)))
2671 CORE_ADDR sign
= (CORE_ADDR
) 1 << (addr_bit
- 1);
2672 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2673 addr
= (addr
^ sign
) - sign
;
2680 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2682 /* Truncate address to the size of a target address, avoiding shifts
2683 larger or equal than the width of a CORE_ADDR. The local
2684 variable ADDR_BIT stops the compiler reporting a shift overflow
2685 when it won't occur. */
2686 /* NOTE: This assumes that the significant address information is
2687 kept in the least significant bits of ADDR - the upper bits were
2688 either zero or sign extended. Should gdbarch_address_to_pointer or
2689 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2691 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2693 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2694 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2695 return hex_string (addr
);
2698 /* This function is described in "defs.h". */
2701 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2703 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2705 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2706 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2708 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2709 that returns the language localized string formatted to a width
2710 based on gdbarch_addr_bit. */
2712 return hex_string_custom (address
, 8);
2714 return hex_string_custom (address
, 16);
2717 /* Convert a string back into a CORE_ADDR. */
2719 string_to_core_addr (const char *my_string
)
2723 if (my_string
[0] == '0' && TOLOWER (my_string
[1]) == 'x')
2725 /* Assume that it is in hex. */
2728 for (i
= 2; my_string
[i
] != '\0'; i
++)
2730 if (ISDIGIT (my_string
[i
]))
2731 addr
= (my_string
[i
] - '0') + (addr
* 16);
2732 else if (ISXDIGIT (my_string
[i
]))
2733 addr
= (TOLOWER (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2735 error (_("invalid hex \"%s\""), my_string
);
2740 /* Assume that it is in decimal. */
2743 for (i
= 0; my_string
[i
] != '\0'; i
++)
2745 if (ISDIGIT (my_string
[i
]))
2746 addr
= (my_string
[i
] - '0') + (addr
* 10);
2748 error (_("invalid decimal \"%s\""), my_string
);
2758 gdb_realpath_check_trailer (const char *input
, const char *trailer
)
2760 gdb::unique_xmalloc_ptr
<char> result
= gdb_realpath (input
);
2762 size_t len
= strlen (result
.get ());
2763 size_t trail_len
= strlen (trailer
);
2765 SELF_CHECK (len
>= trail_len
2766 && strcmp (result
.get () + len
- trail_len
, trailer
) == 0);
2770 gdb_realpath_tests ()
2772 /* A file which contains a directory prefix. */
2773 gdb_realpath_check_trailer ("./xfullpath.exp", "/xfullpath.exp");
2774 /* A file which contains a directory prefix. */
2775 gdb_realpath_check_trailer ("../../defs.h", "/defs.h");
2776 /* A one-character filename. */
2777 gdb_realpath_check_trailer ("./a", "/a");
2778 /* A file in the root directory. */
2779 gdb_realpath_check_trailer ("/root_file_which_should_exist",
2780 "/root_file_which_should_exist");
2781 /* A file which does not have a directory prefix. */
2782 gdb_realpath_check_trailer ("xfullpath.exp", "xfullpath.exp");
2783 /* A one-char filename without any directory prefix. */
2784 gdb_realpath_check_trailer ("a", "a");
2785 /* An empty filename. */
2786 gdb_realpath_check_trailer ("", "");
2789 /* Test the gdb_argv::as_array_view method. */
2792 gdb_argv_as_array_view_test ()
2797 gdb::array_view
<char *> view
= argv
.as_array_view ();
2799 SELF_CHECK (view
.data () == nullptr);
2800 SELF_CHECK (view
.size () == 0);
2803 gdb_argv
argv ("une bonne 50");
2805 gdb::array_view
<char *> view
= argv
.as_array_view ();
2807 SELF_CHECK (view
.size () == 3);
2808 SELF_CHECK (strcmp (view
[0], "une") == 0);
2809 SELF_CHECK (strcmp (view
[1], "bonne") == 0);
2810 SELF_CHECK (strcmp (view
[2], "50") == 0);
2814 #endif /* GDB_SELF_TEST */
2816 /* Simple, portable version of dirname that does not modify its
2820 ldirname (const char *filename
)
2822 std::string dirname
;
2823 const char *base
= lbasename (filename
);
2825 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
2828 if (base
== filename
)
2831 dirname
= std::string (filename
, base
- filename
);
2833 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
2834 create "d:./bar" later instead of the (different) "d:/bar". */
2835 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
2836 && !IS_DIR_SEPARATOR (filename
[0]))
2837 dirname
[base
++ - filename
] = '.';
2842 /* Return ARGS parsed as a valid pid, or throw an error. */
2845 parse_pid_to_attach (const char *args
)
2851 error_no_arg (_("process-id to attach"));
2853 dummy
= (char *) args
;
2854 pid
= strtoul (args
, &dummy
, 0);
2855 /* Some targets don't set errno on errors, grrr! */
2856 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
2857 error (_("Illegal process-id: %s."), args
);
2862 /* Substitute all occurrences of string FROM by string TO in *STRINGP. *STRINGP
2863 must come from xrealloc-compatible allocator and it may be updated. FROM
2864 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
2865 located at the start or end of *STRINGP. */
2868 substitute_path_component (char **stringp
, const char *from
, const char *to
)
2870 char *string
= *stringp
, *s
;
2871 const size_t from_len
= strlen (from
);
2872 const size_t to_len
= strlen (to
);
2876 s
= strstr (s
, from
);
2880 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
2881 || s
[-1] == DIRNAME_SEPARATOR
)
2882 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
2883 || s
[from_len
] == DIRNAME_SEPARATOR
))
2888 = (char *) xrealloc (string
, (strlen (string
) + to_len
+ 1));
2890 /* Relocate the current S pointer. */
2891 s
= s
- string
+ string_new
;
2892 string
= string_new
;
2894 /* Replace from by to. */
2895 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
2896 memcpy (s
, to
, to_len
);
2911 /* SIGALRM handler for waitpid_with_timeout. */
2914 sigalrm_handler (int signo
)
2916 /* Nothing to do. */
2921 /* Wrapper to wait for child PID to die with TIMEOUT.
2922 TIMEOUT is the time to stop waiting in seconds.
2923 If TIMEOUT is zero, pass WNOHANG to waitpid.
2924 Returns PID if it was successfully waited for, otherwise -1.
2926 Timeouts are currently implemented with alarm and SIGALRM.
2927 If the host does not support them, this waits "forever".
2928 It would be odd though for a host to have waitpid and not SIGALRM. */
2931 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
2933 pid_t waitpid_result
;
2935 gdb_assert (pid
> 0);
2936 gdb_assert (timeout
>= 0);
2941 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
2942 struct sigaction sa
, old_sa
;
2944 sa
.sa_handler
= sigalrm_handler
;
2945 sigemptyset (&sa
.sa_mask
);
2947 sigaction (SIGALRM
, &sa
, &old_sa
);
2951 ofunc
= signal (SIGALRM
, sigalrm_handler
);
2957 waitpid_result
= waitpid (pid
, status
, 0);
2961 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
2962 sigaction (SIGALRM
, &old_sa
, NULL
);
2964 signal (SIGALRM
, ofunc
);
2969 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
2971 if (waitpid_result
== pid
)
2977 #endif /* HAVE_WAITPID */
2979 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
2980 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
2982 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
2983 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
2986 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
2988 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
2990 /* It is unclear how '\' escaping vs. directory separator should coexist. */
2991 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
2993 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
2995 char *pattern_slash
, *string_slash
;
2997 /* Replace '\' by '/' in both strings. */
2999 pattern_slash
= (char *) alloca (strlen (pattern
) + 1);
3000 strcpy (pattern_slash
, pattern
);
3001 pattern
= pattern_slash
;
3002 for (; *pattern_slash
!= 0; pattern_slash
++)
3003 if (IS_DIR_SEPARATOR (*pattern_slash
))
3004 *pattern_slash
= '/';
3006 string_slash
= (char *) alloca (strlen (string
) + 1);
3007 strcpy (string_slash
, string
);
3008 string
= string_slash
;
3009 for (; *string_slash
!= 0; string_slash
++)
3010 if (IS_DIR_SEPARATOR (*string_slash
))
3011 *string_slash
= '/';
3013 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3015 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3016 flags
|= FNM_CASEFOLD
;
3017 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3019 return fnmatch (pattern
, string
, flags
);
3022 /* Return the number of path elements in PATH.
3030 count_path_elements (const char *path
)
3033 const char *p
= path
;
3035 if (HAS_DRIVE_SPEC (p
))
3037 p
= STRIP_DRIVE_SPEC (p
);
3043 if (IS_DIR_SEPARATOR (*p
))
3048 /* Backup one if last character is /, unless it's the only one. */
3049 if (p
> path
+ 1 && IS_DIR_SEPARATOR (p
[-1]))
3052 /* Add one for the file name, if present. */
3053 if (p
> path
&& !IS_DIR_SEPARATOR (p
[-1]))
3059 /* Remove N leading path elements from PATH.
3060 N must be non-negative.
3061 If PATH has more than N path elements then return NULL.
3062 If PATH has exactly N path elements then return "".
3063 See count_path_elements for a description of how we do the counting. */
3066 strip_leading_path_elements (const char *path
, int n
)
3069 const char *p
= path
;
3071 gdb_assert (n
>= 0);
3076 if (HAS_DRIVE_SPEC (p
))
3078 p
= STRIP_DRIVE_SPEC (p
);
3084 while (*p
!= '\0' && !IS_DIR_SEPARATOR (*p
))
3102 copy_bitwise (gdb_byte
*dest
, ULONGEST dest_offset
,
3103 const gdb_byte
*source
, ULONGEST source_offset
,
3104 ULONGEST nbits
, int bits_big_endian
)
3106 unsigned int buf
, avail
;
3111 if (bits_big_endian
)
3113 /* Start from the end, then work backwards. */
3114 dest_offset
+= nbits
- 1;
3115 dest
+= dest_offset
/ 8;
3116 dest_offset
= 7 - dest_offset
% 8;
3117 source_offset
+= nbits
- 1;
3118 source
+= source_offset
/ 8;
3119 source_offset
= 7 - source_offset
% 8;
3123 dest
+= dest_offset
/ 8;
3125 source
+= source_offset
/ 8;
3129 /* Fill BUF with DEST_OFFSET bits from the destination and 8 -
3130 SOURCE_OFFSET bits from the source. */
3131 buf
= *(bits_big_endian
? source
-- : source
++) >> source_offset
;
3132 buf
<<= dest_offset
;
3133 buf
|= *dest
& ((1 << dest_offset
) - 1);
3135 /* NBITS: bits yet to be written; AVAIL: BUF's fill level. */
3136 nbits
+= dest_offset
;
3137 avail
= dest_offset
+ 8 - source_offset
;
3139 /* Flush 8 bits from BUF, if appropriate. */
3140 if (nbits
>= 8 && avail
>= 8)
3142 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3148 /* Copy the middle part. */
3151 size_t len
= nbits
/ 8;
3153 /* Use a faster method for byte-aligned copies. */
3156 if (bits_big_endian
)
3160 memcpy (dest
+ 1, source
+ 1, len
);
3164 memcpy (dest
, source
, len
);
3173 buf
|= *(bits_big_endian
? source
-- : source
++) << avail
;
3174 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3181 /* Write the last byte. */
3185 buf
|= *source
<< avail
;
3187 buf
&= (1 << nbits
) - 1;
3188 *dest
= (*dest
& (~0U << nbits
)) | buf
;
3192 void _initialize_utils ();
3194 _initialize_utils ()
3196 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
3197 Set number of characters where GDB should wrap lines of its output."), _("\
3198 Show number of characters where GDB should wrap lines of its output."), _("\
3199 This affects where GDB wraps its output to fit the screen width.\n\
3200 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
3202 show_chars_per_line
,
3203 &setlist
, &showlist
);
3205 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
3206 Set number of lines in a page for GDB output pagination."), _("\
3207 Show number of lines in a page for GDB output pagination."), _("\
3208 This affects the number of lines after which GDB will pause\n\
3209 its output and ask you whether to continue.\n\
3210 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
3212 show_lines_per_page
,
3213 &setlist
, &showlist
);
3215 add_setshow_boolean_cmd ("pagination", class_support
,
3216 &pagination_enabled
, _("\
3217 Set state of GDB output pagination."), _("\
3218 Show state of GDB output pagination."), _("\
3219 When pagination is ON, GDB pauses at end of each screenful of\n\
3220 its output and asks you whether to continue.\n\
3221 Turning pagination off is an alternative to \"set height unlimited\"."),
3223 show_pagination_enabled
,
3224 &setlist
, &showlist
);
3226 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
3227 &sevenbit_strings
, _("\
3228 Set printing of 8-bit characters in strings as \\nnn."), _("\
3229 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
3231 show_sevenbit_strings
,
3232 &setprintlist
, &showprintlist
);
3234 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
3235 &debug_timestamp
, _("\
3236 Set timestamping of debugging messages."), _("\
3237 Show timestamping of debugging messages."), _("\
3238 When set, debugging messages will be marked with seconds and microseconds."),
3240 show_debug_timestamp
,
3241 &setdebuglist
, &showdebuglist
);
3243 add_internal_problem_command (&internal_error_problem
);
3244 add_internal_problem_command (&internal_warning_problem
);
3245 add_internal_problem_command (&demangler_warning_problem
);
3248 selftests::register_test ("gdb_realpath", gdb_realpath_tests
);
3249 selftests::register_test ("gdb_argv_array_view", gdb_argv_as_array_view_test
);