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 "gdb_obstack.h"
57 #include "inferior.h" /* for signed_pointer_to_address */
59 #include "gdb_curses.h"
61 #include "readline/readline.h"
66 #include "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"
80 void (*deprecated_error_begin_hook
) (void);
82 /* Prototypes for local functions */
84 static void vfprintf_maybe_filtered (struct ui_file
*, const char *,
86 ATTRIBUTE_PRINTF (2, 0);
88 static void fputs_maybe_filtered (const char *, struct ui_file
*, int);
90 static void prompt_for_continue (void);
92 static void set_screen_size (void);
93 static void set_width (void);
95 /* Time spent in prompt_for_continue in the currently executing command
96 waiting for user to respond.
97 Initialized in make_command_stats_cleanup.
98 Modified in prompt_for_continue and defaulted_query.
99 Used in report_command_stats. */
101 static std::chrono::steady_clock::duration prompt_for_continue_wait_time
;
103 /* A flag indicating whether to timestamp debugging messages. */
105 static bool debug_timestamp
= false;
107 /* True means that strings with character values >0x7F should be printed
108 as octal escapes. False means just print the value (e.g. it's an
109 international character, and the terminal or window can cope.) */
111 bool sevenbit_strings
= false;
113 show_sevenbit_strings (struct ui_file
*file
, int from_tty
,
114 struct cmd_list_element
*c
, const char *value
)
116 fprintf_filtered (file
, _("Printing of 8-bit characters "
117 "in strings as \\nnn is %s.\n"),
121 /* String to be printed before warning messages, if any. */
123 const char *warning_pre_print
= "\nwarning: ";
125 bool pagination_enabled
= true;
127 show_pagination_enabled (struct ui_file
*file
, int from_tty
,
128 struct cmd_list_element
*c
, const char *value
)
130 fprintf_filtered (file
, _("State of pagination is %s.\n"), value
);
136 /* Print a warning message. The first argument STRING is the warning
137 message, used as an fprintf format string, the second is the
138 va_list of arguments for that string. A warning is unfiltered (not
139 paginated) so that the user does not need to page through each
140 screen full of warnings when there are lots of them. */
143 vwarning (const char *string
, va_list args
)
145 if (deprecated_warning_hook
)
146 (*deprecated_warning_hook
) (string
, args
);
149 gdb::optional
<target_terminal::scoped_restore_terminal_state
> term_state
;
150 if (target_supports_terminal_ours ())
152 term_state
.emplace ();
153 target_terminal::ours_for_output ();
155 if (filtered_printing_initialized ())
156 wrap_here (""); /* Force out any buffered output. */
157 gdb_flush (gdb_stdout
);
158 if (warning_pre_print
)
159 fputs_unfiltered (warning_pre_print
, gdb_stderr
);
160 vfprintf_unfiltered (gdb_stderr
, string
, args
);
161 fprintf_unfiltered (gdb_stderr
, "\n");
165 /* Print an error message and return to command level.
166 The first argument STRING is the error message, used as a fprintf string,
167 and the remaining args are passed as arguments to it. */
170 verror (const char *string
, va_list args
)
172 throw_verror (GENERIC_ERROR
, string
, args
);
176 error_stream (const string_file
&stream
)
178 error (("%s"), stream
.c_str ());
181 /* Emit a message and abort. */
183 static void ATTRIBUTE_NORETURN
184 abort_with_message (const char *msg
)
186 if (current_ui
== NULL
)
189 fputs_unfiltered (msg
, gdb_stderr
);
191 abort (); /* ARI: abort */
194 /* Dump core trying to increase the core soft limit to hard limit first. */
199 #ifdef HAVE_SETRLIMIT
200 struct rlimit rlim
= { (rlim_t
) RLIM_INFINITY
, (rlim_t
) RLIM_INFINITY
};
202 setrlimit (RLIMIT_CORE
, &rlim
);
203 #endif /* HAVE_SETRLIMIT */
205 /* Ensure that the SIGABRT we're about to raise will immediately cause
206 GDB to exit and dump core, we don't want to trigger GDB's printing of
207 a backtrace to the console here. */
208 signal (SIGABRT
, SIG_DFL
);
210 abort (); /* ARI: abort */
213 /* Check whether GDB will be able to dump core using the dump_core
214 function. Returns zero if GDB cannot or should not dump core.
215 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
216 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
219 can_dump_core (enum resource_limit_kind limit_kind
)
221 #ifdef HAVE_GETRLIMIT
224 /* Be quiet and assume we can dump if an error is returned. */
225 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
231 if (rlim
.rlim_cur
== 0)
236 if (rlim
.rlim_max
== 0)
239 #endif /* HAVE_GETRLIMIT */
244 /* Print a warning that we cannot dump core. */
247 warn_cant_dump_core (const char *reason
)
249 fprintf_unfiltered (gdb_stderr
,
250 _("%s\nUnable to dump core, use `ulimit -c"
251 " unlimited' before executing GDB next time.\n"),
255 /* Check whether GDB will be able to dump core using the dump_core
256 function, and print a warning if we cannot. */
259 can_dump_core_warn (enum resource_limit_kind limit_kind
,
262 int core_dump_allowed
= can_dump_core (limit_kind
);
264 if (!core_dump_allowed
)
265 warn_cant_dump_core (reason
);
267 return core_dump_allowed
;
270 /* Allow the user to configure the debugger behavior with respect to
271 what to do when an internal problem is detected. */
273 const char internal_problem_ask
[] = "ask";
274 const char internal_problem_yes
[] = "yes";
275 const char internal_problem_no
[] = "no";
276 static const char *const internal_problem_modes
[] =
278 internal_problem_ask
,
279 internal_problem_yes
,
284 /* Data structure used to control how the internal_vproblem function
285 should behave. An instance of this structure is created for each
286 problem type that GDB supports. */
288 struct internal_problem
290 /* The name of this problem type. This must not contain white space as
291 this string is used to build command names. */
294 /* When this is true then a user command is created (based on NAME) that
295 allows the SHOULD_QUIT field to be modified, otherwise, SHOULD_QUIT
296 can't be changed from its default value by the user. */
297 bool user_settable_should_quit
;
299 /* Reference a value from internal_problem_modes to indicate if GDB
300 should quit when it hits a problem of this type. */
301 const char *should_quit
;
303 /* Like USER_SETTABLE_SHOULD_QUIT but for SHOULD_DUMP_CORE. */
304 bool user_settable_should_dump_core
;
306 /* Like SHOULD_QUIT, but whether GDB should dump core. */
307 const char *should_dump_core
;
309 /* Like USER_SETTABLE_SHOULD_QUIT but for SHOULD_PRINT_BACKTRACE. */
310 bool user_settable_should_print_backtrace
;
312 /* When this is true GDB will print a backtrace when a problem of this
313 type is encountered. */
314 bool should_print_backtrace
;
317 /* Report a problem, internal to GDB, to the user. Once the problem
318 has been reported, and assuming GDB didn't quit, the caller can
319 either allow execution to resume or throw an error. */
321 static void ATTRIBUTE_PRINTF (4, 0)
322 internal_vproblem (struct internal_problem
*problem
,
323 const char *file
, int line
, const char *fmt
, va_list ap
)
330 /* Don't allow infinite error/warning recursion. */
332 static const char msg
[] = "Recursive internal problem.\n";
341 abort_with_message (msg
);
344 /* Newer GLIBC versions put the warn_unused_result attribute
345 on write, but this is one of those rare cases where
346 ignoring the return value is correct. Casting to (void)
347 does not fix this problem. This is the solution suggested
348 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
349 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
350 abort (); /* ARI: abort */
355 /* Create a string containing the full error/warning message. Need
356 to call query with this full string, as otherwize the reason
357 (error/warning) and question become separated. Format using a
358 style similar to a compiler error message. Include extra detail
359 so that the user knows that they are living on the edge. */
361 std::string msg
= string_vprintf (fmt
, ap
);
362 reason
= string_printf ("%s:%d: %s: %s\n"
363 "A problem internal to GDB has been detected,\n"
364 "further debugging may prove unreliable.",
365 file
, line
, problem
->name
, msg
.c_str ());
368 /* Fall back to abort_with_message if gdb_stderr is not set up. */
369 if (current_ui
== NULL
)
371 fputs (reason
.c_str (), stderr
);
372 abort_with_message ("\n");
375 /* Try to get the message out and at the start of a new line. */
376 gdb::optional
<target_terminal::scoped_restore_terminal_state
> term_state
;
377 if (target_supports_terminal_ours ())
379 term_state
.emplace ();
380 target_terminal::ours_for_output ();
382 if (filtered_printing_initialized ())
385 /* Emit the message unless query will emit it below. */
386 if (problem
->should_quit
!= internal_problem_ask
388 || !filtered_printing_initialized ()
389 || problem
->should_print_backtrace
)
390 fprintf_unfiltered (gdb_stderr
, "%s\n", reason
.c_str ());
392 if (problem
->should_print_backtrace
)
393 gdb_internal_backtrace ();
395 if (problem
->should_quit
== internal_problem_ask
)
397 /* Default (yes/batch case) is to quit GDB. When in batch mode
398 this lessens the likelihood of GDB going into an infinite
400 if (!confirm
|| !filtered_printing_initialized ())
403 quit_p
= query (_("%s\nQuit this debugging session? "),
406 else if (problem
->should_quit
== internal_problem_yes
)
408 else if (problem
->should_quit
== internal_problem_no
)
411 internal_error (__FILE__
, __LINE__
, _("bad switch"));
413 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr
);
414 if (REPORT_BUGS_TO
[0])
415 fprintf_unfiltered (gdb_stderr
, _(" For instructions, see:\n%s."),
417 fputs_unfiltered ("\n\n", gdb_stderr
);
419 if (problem
->should_dump_core
== internal_problem_ask
)
421 if (!can_dump_core_warn (LIMIT_MAX
, reason
.c_str ()))
423 else if (!filtered_printing_initialized ())
427 /* Default (yes/batch case) is to dump core. This leaves a GDB
428 `dropping' so that it is easier to see that something went
430 dump_core_p
= query (_("%s\nCreate a core file of GDB? "),
434 else if (problem
->should_dump_core
== internal_problem_yes
)
435 dump_core_p
= can_dump_core_warn (LIMIT_MAX
, reason
.c_str ());
436 else if (problem
->should_dump_core
== internal_problem_no
)
439 internal_error (__FILE__
, __LINE__
, _("bad switch"));
452 #ifdef HAVE_WORKING_FORK
462 static struct internal_problem internal_error_problem
= {
463 "internal-error", true, internal_problem_ask
, true, internal_problem_ask
,
464 true, GDB_PRINT_INTERNAL_BACKTRACE_INIT_ON
468 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
470 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
471 throw_quit (_("Command aborted."));
474 static struct internal_problem internal_warning_problem
= {
475 "internal-warning", true, internal_problem_ask
, true, internal_problem_ask
,
480 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
482 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
485 static struct internal_problem demangler_warning_problem
= {
486 "demangler-warning", true, internal_problem_ask
, false, internal_problem_no
,
491 demangler_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
493 internal_vproblem (&demangler_warning_problem
, file
, line
, fmt
, ap
);
497 demangler_warning (const char *file
, int line
, const char *string
, ...)
501 va_start (ap
, string
);
502 demangler_vwarning (file
, line
, string
, ap
);
506 /* When GDB reports an internal problem (error or warning) it gives
507 the user the opportunity to quit GDB and/or create a core file of
508 the current debug session. This function registers a few commands
509 that make it possible to specify that GDB should always or never
510 quit or create a core file, without asking. The commands look
513 maint set PROBLEM-NAME quit ask|yes|no
514 maint show PROBLEM-NAME quit
515 maint set PROBLEM-NAME corefile ask|yes|no
516 maint show PROBLEM-NAME corefile
518 Where PROBLEM-NAME is currently "internal-error" or
519 "internal-warning". */
522 add_internal_problem_command (struct internal_problem
*problem
)
524 struct cmd_list_element
**set_cmd_list
;
525 struct cmd_list_element
**show_cmd_list
;
527 set_cmd_list
= XNEW (struct cmd_list_element
*);
528 show_cmd_list
= XNEW (struct cmd_list_element
*);
529 *set_cmd_list
= NULL
;
530 *show_cmd_list
= NULL
;
532 /* The add_basic_prefix_cmd and add_show_prefix_cmd functions take
533 ownership of the string passed in, which is why we don't need to free
534 set_doc and show_doc in this function. */
536 = xstrprintf (_("Configure what GDB does when %s is detected."),
537 problem
->name
).release ();
539 = xstrprintf (_("Show what GDB does when %s is detected."),
540 problem
->name
).release ();
542 add_setshow_prefix_cmd (problem
->name
, class_maintenance
,
543 set_doc
, show_doc
, set_cmd_list
, show_cmd_list
,
544 &maintenance_set_cmdlist
, &maintenance_show_cmdlist
);
546 if (problem
->user_settable_should_quit
)
548 std::string set_quit_doc
549 = string_printf (_("Set whether GDB should quit when an %s is "
550 "detected."), problem
->name
);
551 std::string show_quit_doc
552 = string_printf (_("Show whether GDB will quit when an %s is "
553 "detected."), problem
->name
);
554 add_setshow_enum_cmd ("quit", class_maintenance
,
555 internal_problem_modes
,
556 &problem
->should_quit
,
557 set_quit_doc
.c_str (),
558 show_quit_doc
.c_str (),
566 if (problem
->user_settable_should_dump_core
)
568 std::string set_core_doc
569 = string_printf (_("Set whether GDB should create a core file of "
570 "GDB when %s is detected."), problem
->name
);
571 std::string show_core_doc
572 = string_printf (_("Show whether GDB will create a core file of "
573 "GDB when %s is detected."), problem
->name
);
574 add_setshow_enum_cmd ("corefile", class_maintenance
,
575 internal_problem_modes
,
576 &problem
->should_dump_core
,
577 set_core_doc
.c_str (),
578 show_core_doc
.c_str (),
586 if (problem
->user_settable_should_print_backtrace
)
588 std::string set_bt_doc
589 = string_printf (_("Set whether GDB should print a backtrace of "
590 "GDB when %s is detected."), problem
->name
);
591 std::string show_bt_doc
592 = string_printf (_("Show whether GDB will print a backtrace of "
593 "GDB when %s is detected."), problem
->name
);
594 add_setshow_boolean_cmd ("backtrace", class_maintenance
,
595 &problem
->should_print_backtrace
,
597 show_bt_doc
.c_str (),
599 gdb_internal_backtrace_set_cmd
,
606 /* Return a newly allocated string, containing the PREFIX followed
607 by the system error message for errno (separated by a colon). */
610 perror_string (const char *prefix
)
612 const char *err
= safe_strerror (errno
);
613 return std::string (prefix
) + ": " + err
;
616 /* Print the system error message for errno, and also mention STRING
617 as the file name for which the error was encountered. Use ERRCODE
618 for the thrown exception. Then return to command level. */
621 throw_perror_with_name (enum errors errcode
, const char *string
)
623 std::string combined
= perror_string (string
);
625 /* I understand setting these is a matter of taste. Still, some people
626 may clear errno but not know about bfd_error. Doing this here is not
628 bfd_set_error (bfd_error_no_error
);
631 throw_error (errcode
, _("%s."), combined
.c_str ());
634 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
637 perror_with_name (const char *string
)
639 throw_perror_with_name (GENERIC_ERROR
, string
);
642 /* Same as perror_with_name except that it prints a warning instead
643 of throwing an error. */
646 perror_warning_with_name (const char *string
)
648 std::string combined
= perror_string (string
);
649 warning (_("%s"), combined
.c_str ());
652 /* Print the system error message for ERRCODE, and also mention STRING
653 as the file name for which the error was encountered. */
656 print_sys_errmsg (const char *string
, int errcode
)
658 const char *err
= safe_strerror (errcode
);
659 /* We want anything which was printed on stdout to come out first, before
661 gdb_flush (gdb_stdout
);
662 fprintf_unfiltered (gdb_stderr
, "%s: %s.\n", string
, err
);
665 /* Control C eventually causes this to be called, at a convenient time. */
670 if (sync_quit_force_run
)
672 sync_quit_force_run
= 0;
673 quit_force (NULL
, 0);
677 /* No steenking SIGINT will ever be coming our way when the
678 program is resumed. Don't lie. */
682 /* If there is no terminal switching for this target, then we can't
683 possibly get screwed by the lack of job control. */
684 || !target_supports_terminal_ours ())
687 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
696 if (sync_quit_force_run
)
703 /* Called when a memory allocation fails, with the number of bytes of
704 memory requested in SIZE. */
707 malloc_failure (long size
)
711 internal_error (__FILE__
, __LINE__
,
712 _("virtual memory exhausted: can't allocate %ld bytes."),
717 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
721 /* See common/errors.h. */
726 gdb_stdout
->flush ();
727 gdb_stderr
->flush ();
730 /* My replacement for the read system call.
731 Used like `read' but keeps going if `read' returns too soon. */
734 myread (int desc
, char *addr
, int len
)
741 val
= read (desc
, addr
, len
);
755 uinteger_pow (ULONGEST v1
, LONGEST v2
)
760 error (_("Attempt to raise 0 to negative power."));
766 /* The Russian Peasant's Algorithm. */
784 /* An RAII class that sets up to handle input and then tears down
785 during destruction. */
787 class scoped_input_handler
791 scoped_input_handler ()
792 : m_quit_handler (&quit_handler
, default_quit_handler
),
795 target_terminal::ours ();
796 ui_register_input_event_handler (current_ui
);
797 if (current_ui
->prompt_state
== PROMPT_BLOCKED
)
801 ~scoped_input_handler ()
804 ui_unregister_input_event_handler (m_ui
);
807 DISABLE_COPY_AND_ASSIGN (scoped_input_handler
);
811 /* Save and restore the terminal state. */
812 target_terminal::scoped_restore_terminal_state m_term_state
;
814 /* Save and restore the quit handler. */
815 scoped_restore_tmpl
<quit_handler_ftype
*> m_quit_handler
;
817 /* The saved UI, if non-NULL. */
823 /* This function supports the query, nquery, and yquery functions.
824 Ask user a y-or-n question and return 0 if answer is no, 1 if
825 answer is yes, or default the answer to the specified default
826 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
827 default answer, or '\0' for no default.
828 CTLSTR is the control string and should end in "? ". It should
829 not say how to answer, because we do that.
830 ARGS are the arguments passed along with the CTLSTR argument to
833 static int ATTRIBUTE_PRINTF (1, 0)
834 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
838 char def_answer
, not_def_answer
;
839 const char *y_string
, *n_string
;
841 /* Set up according to which answer is the default. */
846 not_def_answer
= 'N';
850 else if (defchar
== 'y')
854 not_def_answer
= 'N';
862 not_def_answer
= 'Y';
867 /* Automatically answer the default value if the user did not want
868 prompts or the command was issued with the server prefix. */
869 if (!confirm
|| server_command
)
872 /* If input isn't coming from the user directly, just say what
873 question we're asking, and then answer the default automatically. This
874 way, important error messages don't get lost when talking to GDB
876 if (current_ui
->instream
!= current_ui
->stdin_stream
877 || !input_interactive_p (current_ui
)
878 /* Restrict queries to the main UI. */
879 || current_ui
!= main_ui
)
881 target_terminal::scoped_restore_terminal_state term_state
;
882 target_terminal::ours_for_output ();
884 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
886 printf_filtered (_("(%s or %s) [answered %c; "
887 "input not from terminal]\n"),
888 y_string
, n_string
, def_answer
);
893 if (deprecated_query_hook
)
895 target_terminal::scoped_restore_terminal_state term_state
;
896 return deprecated_query_hook (ctlstr
, args
);
899 /* Format the question outside of the loop, to avoid reusing args. */
900 std::string question
= string_vprintf (ctlstr
, args
);
902 = string_printf (_("%s%s(%s or %s) %s"),
903 annotation_level
> 1 ? "\n\032\032pre-query\n" : "",
904 question
.c_str (), y_string
, n_string
,
905 annotation_level
> 1 ? "\n\032\032query\n" : "");
907 /* Used to add duration we waited for user to respond to
908 prompt_for_continue_wait_time. */
909 using namespace std::chrono
;
910 steady_clock::time_point prompt_started
= steady_clock::now ();
912 scoped_input_handler prepare_input
;
916 char *response
, answer
;
918 gdb_flush (gdb_stdout
);
919 response
= gdb_readline_wrapper (prompt
.c_str ());
921 if (response
== NULL
) /* C-d */
923 printf_filtered ("EOF [assumed %c]\n", def_answer
);
928 answer
= response
[0];
933 /* Check answer. For the non-default, the user must specify
934 the non-default explicitly. */
935 if (answer
== not_def_answer
)
940 /* Otherwise, if a default was specified, the user may either
941 specify the required input or have it default by entering
943 if (answer
== def_answer
944 || (defchar
!= '\0' && answer
== '\0'))
949 /* Invalid entries are not defaulted and require another selection. */
950 printf_filtered (_("Please answer %s or %s.\n"),
954 /* Add time spend in this routine to prompt_for_continue_wait_time. */
955 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
957 if (annotation_level
> 1)
958 printf_filtered (("\n\032\032post-query\n"));
963 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
964 answer is yes, or 0 if answer is defaulted.
965 Takes three args which are given to printf to print the question.
966 The first, a control string, should end in "? ".
967 It should not say how to answer, because we do that. */
970 nquery (const char *ctlstr
, ...)
975 va_start (args
, ctlstr
);
976 ret
= defaulted_query (ctlstr
, 'n', args
);
981 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
982 answer is yes, or 1 if answer is defaulted.
983 Takes three args which are given to printf to print the question.
984 The first, a control string, should end in "? ".
985 It should not say how to answer, because we do that. */
988 yquery (const char *ctlstr
, ...)
993 va_start (args
, ctlstr
);
994 ret
= defaulted_query (ctlstr
, 'y', args
);
999 /* Ask user a y-or-n question and return 1 iff answer is yes.
1000 Takes three args which are given to printf to print the question.
1001 The first, a control string, should end in "? ".
1002 It should not say how to answer, because we do that. */
1005 query (const char *ctlstr
, ...)
1010 va_start (args
, ctlstr
);
1011 ret
= defaulted_query (ctlstr
, '\0', args
);
1016 /* A helper for parse_escape that converts a host character to a
1017 target character. C is the host character. If conversion is
1018 possible, then the target character is stored in *TARGET_C and the
1019 function returns 1. Otherwise, the function returns 0. */
1022 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1027 auto_obstack host_data
;
1029 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1030 (gdb_byte
*) &the_char
, 1, 1,
1031 &host_data
, translit_none
);
1033 if (obstack_object_size (&host_data
) == 1)
1036 *target_c
= *(char *) obstack_base (&host_data
);
1042 /* Parse a C escape sequence. STRING_PTR points to a variable
1043 containing a pointer to the string to parse. That pointer
1044 should point to the character after the \. That pointer
1045 is updated past the characters we use. The value of the
1046 escape sequence is returned.
1048 A negative value means the sequence \ newline was seen,
1049 which is supposed to be equivalent to nothing at all.
1051 If \ is followed by a null character, we return a negative
1052 value and leave the string pointer pointing at the null character.
1054 If \ is followed by 000, we return 0 and leave the string pointer
1055 after the zeros. A value of 0 does not mean end of string. */
1058 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1060 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1061 int c
= *(*string_ptr
)++;
1080 int i
= host_hex_value (c
);
1085 if (ISDIGIT (c
) && c
!= '8' && c
!= '9')
1089 i
+= host_hex_value (c
);
1125 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1126 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1127 " which has no equivalent\nin the `%s' character set."),
1128 c
, c
, target_charset (gdbarch
));
1133 /* Number of lines per page or UINT_MAX if paging is disabled. */
1134 static unsigned int lines_per_page
;
1136 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1137 struct cmd_list_element
*c
, const char *value
)
1139 fprintf_filtered (file
,
1140 _("Number of lines gdb thinks are in a page is %s.\n"),
1144 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1145 static unsigned int chars_per_line
;
1147 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1148 struct cmd_list_element
*c
, const char *value
)
1150 fprintf_filtered (file
,
1151 _("Number of characters gdb thinks "
1152 "are in a line is %s.\n"),
1156 /* Current count of lines printed on this page, chars on this line. */
1157 static unsigned int lines_printed
, chars_printed
;
1159 /* True if pagination is disabled for just one command. */
1161 static bool pagination_disabled_for_command
;
1163 /* Buffer and start column of buffered text, for doing smarter word-
1164 wrapping. When someone calls wrap_here(), we start buffering output
1165 that comes through fputs_filtered(). If we see a newline, we just
1166 spit it out and forget about the wrap_here(). If we see another
1167 wrap_here(), we spit it out and remember the newer one. If we see
1168 the end of the line, we spit out a newline, the indent, and then
1169 the buffered output. */
1171 static bool filter_initialized
= false;
1173 /* Contains characters which are waiting to be output (they have
1174 already been counted in chars_printed). */
1175 static std::string wrap_buffer
;
1177 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1179 static const char *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 /* Indicate that if the next sequence of characters overflows the line,
1523 a newline should be inserted here rather than when it hits the end.
1524 If INDENT is non-null, it is a string to be printed to indent the
1525 wrapped part on the next line. INDENT must remain accessible until
1526 the next call to wrap_here() or until a newline is printed through
1529 If the line is already overfull, we immediately print a newline and
1530 the indentation, and disable further wrapping.
1532 If we don't know the width of lines, but we know the page height,
1533 we must not wrap words, but should still keep track of newlines
1534 that were explicitly printed.
1536 INDENT should not contain tabs, as that will mess up the char count
1537 on the next line. FIXME.
1539 This routine is guaranteed to force out any output which has been
1540 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1541 used to force out output from the wrap_buffer. */
1544 wrap_here (const char *indent
)
1546 /* This should have been allocated, but be paranoid anyway. */
1547 gdb_assert (filter_initialized
);
1549 flush_wrap_buffer (gdb_stdout
);
1550 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1554 else if (chars_printed
>= chars_per_line
)
1556 puts_filtered ("\n");
1558 puts_filtered (indent
);
1563 wrap_column
= chars_printed
;
1567 wrap_indent
= indent
;
1568 wrap_style
= applied_style
;
1572 /* Print input string to gdb_stdout, filtered, with wrap,
1573 arranging strings in columns of n chars. String can be
1574 right or left justified in the column. Never prints
1575 trailing spaces. String should never be longer than
1576 width. FIXME: this could be useful for the EXAMINE
1577 command, which currently doesn't tabulate very well. */
1580 puts_filtered_tabular (char *string
, int width
, int right
)
1586 gdb_assert (chars_per_line
> 0);
1587 if (chars_per_line
== UINT_MAX
)
1589 fputs_filtered (string
, gdb_stdout
);
1590 fputs_filtered ("\n", gdb_stdout
);
1594 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1595 fputs_filtered ("\n", gdb_stdout
);
1597 if (width
>= chars_per_line
)
1598 width
= chars_per_line
- 1;
1600 stringlen
= strlen (string
);
1602 if (chars_printed
> 0)
1603 spaces
= width
- (chars_printed
- 1) % width
- 1;
1605 spaces
+= width
- stringlen
;
1607 spacebuf
= (char *) alloca (spaces
+ 1);
1608 spacebuf
[spaces
] = '\0';
1610 spacebuf
[spaces
] = ' ';
1612 fputs_filtered (spacebuf
, gdb_stdout
);
1613 fputs_filtered (string
, gdb_stdout
);
1617 /* Ensure that whatever gets printed next, using the filtered output
1618 commands, starts at the beginning of the line. I.e. if there is
1619 any pending output for the current line, flush it and start a new
1620 line. Otherwise do nothing. */
1625 if (chars_printed
> 0)
1627 puts_filtered ("\n");
1632 /* Like fputs but if FILTER is true, pause after every screenful.
1634 Regardless of FILTER can wrap at points other than the final
1635 character of a line.
1637 Unlike fputs, fputs_maybe_filtered does not return a value.
1638 It is OK for LINEBUFFER to be NULL, in which case just don't print
1641 Note that a longjmp to top level may occur in this routine (only if
1642 FILTER is true) (since prompt_for_continue may do so) so this
1643 routine should not be called when cleanups are not in place. */
1646 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1649 const char *lineptr
;
1651 if (linebuffer
== 0)
1654 /* Don't do any filtering if it is disabled. */
1655 if (!stream
->can_page ()
1656 || stream
!= gdb_stdout
1657 || !pagination_enabled
1658 || pagination_disabled_for_command
1660 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
1661 || top_level_interpreter () == NULL
1662 || top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
1664 flush_wrap_buffer (stream
);
1665 stream
->puts (linebuffer
);
1670 = make_scope_exit ([&] ()
1672 wrap_buffer
.clear ();
1677 /* Go through and output each character. Show line extension
1678 when this is necessary; prompt user for new page when this is
1681 lineptr
= linebuffer
;
1684 /* Possible new page. Note that PAGINATION_DISABLED_FOR_COMMAND
1685 might be set during this loop, so we must continue to check
1687 if (filter
&& (lines_printed
>= lines_per_page
- 1)
1688 && !pagination_disabled_for_command
)
1689 prompt_for_continue ();
1691 while (*lineptr
&& *lineptr
!= '\n')
1695 /* Print a single line. */
1696 if (*lineptr
== '\t')
1698 wrap_buffer
.push_back ('\t');
1699 /* Shifting right by 3 produces the number of tab stops
1700 we have already passed, and then adding one and
1701 shifting left 3 advances to the next tab stop. */
1702 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
1705 else if (*lineptr
== '\033'
1706 && skip_ansi_escape (lineptr
, &skip_bytes
))
1708 wrap_buffer
.append (lineptr
, skip_bytes
);
1709 /* Note that we don't consider this a character, so we
1710 don't increment chars_printed here. */
1711 lineptr
+= skip_bytes
;
1713 else if (*lineptr
== '\r')
1715 wrap_buffer
.push_back (*lineptr
);
1721 wrap_buffer
.push_back (*lineptr
);
1726 if (chars_printed
>= chars_per_line
)
1728 unsigned int save_chars
= chars_printed
;
1730 /* If we change the style, below, we'll want to reset it
1731 before continuing to print. If there is no wrap
1732 column, then we'll only reset the style if the pager
1733 prompt is given; and to avoid emitting style
1734 sequences in the middle of a run of text, we track
1736 ui_file_style save_style
= applied_style
;
1737 bool did_paginate
= false;
1743 /* We are about to insert a newline at an historic
1744 location in the WRAP_BUFFER. Before we do we want to
1745 restore the default style. To know if we actually
1746 need to insert an escape sequence we must restore the
1747 current applied style to how it was at the WRAP_COLUMN
1749 applied_style
= wrap_style
;
1750 if (stream
->can_emit_style_escape ())
1751 emit_style_escape (ui_file_style (), stream
);
1752 /* If we aren't actually wrapping, don't output
1753 newline -- if chars_per_line is right, we
1754 probably just overflowed anyway; if it's wrong,
1755 let us keep going. */
1756 /* XXX: The ideal thing would be to call
1757 'stream->putc' here, but we can't because it
1758 currently calls 'fputc_unfiltered', which ends up
1759 calling us, which generates an infinite
1761 stream
->puts ("\n");
1764 flush_wrap_buffer (stream
);
1766 /* Possible new page. Note that
1767 PAGINATION_DISABLED_FOR_COMMAND might be set during
1768 this loop, so we must continue to check it here. */
1769 if (lines_printed
>= lines_per_page
- 1
1770 && !pagination_disabled_for_command
)
1772 prompt_for_continue ();
1773 did_paginate
= true;
1776 /* Now output indentation and wrapped string. */
1779 stream
->puts (wrap_indent
);
1781 /* Having finished inserting the wrapping we should
1782 restore the style as it was at the WRAP_COLUMN. */
1783 if (stream
->can_emit_style_escape ())
1784 emit_style_escape (wrap_style
, stream
);
1786 /* The WRAP_BUFFER will still contain content, and that
1787 content might set some alternative style. Restore
1788 APPLIED_STYLE as it was before we started wrapping,
1789 this reflects the current style for the last character
1791 applied_style
= save_style
;
1793 /* FIXME, this strlen is what prevents wrap_indent from
1794 containing tabs. However, if we recurse to print it
1795 and count its chars, we risk trouble if wrap_indent is
1796 longer than (the user settable) chars_per_line.
1797 Note also that this can set chars_printed > chars_per_line
1798 if we are printing a long string. */
1799 chars_printed
= strlen (wrap_indent
)
1800 + (save_chars
- wrap_column
);
1801 wrap_column
= 0; /* And disable fancy wrap */
1803 else if (did_paginate
&& stream
->can_emit_style_escape ())
1804 emit_style_escape (save_style
, stream
);
1808 if (*lineptr
== '\n')
1811 wrap_here ((char *) 0); /* Spit out chars, cancel
1814 /* XXX: The ideal thing would be to call
1815 'stream->putc' here, but we can't because it
1816 currently calls 'fputc_unfiltered', which ends up
1817 calling us, which generates an infinite
1819 stream
->puts ("\n");
1824 buffer_clearer
.release ();
1828 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
1830 fputs_maybe_filtered (linebuffer
, stream
, 1);
1834 fputs_unfiltered (const char *linebuffer
, struct ui_file
*stream
)
1836 fputs_maybe_filtered (linebuffer
, stream
, 0);
1842 fputs_styled (const char *linebuffer
, const ui_file_style
&style
,
1843 struct ui_file
*stream
)
1845 set_output_style (stream
, style
);
1846 fputs_maybe_filtered (linebuffer
, stream
, 1);
1847 set_output_style (stream
, ui_file_style ());
1853 fputs_styled_unfiltered (const char *linebuffer
, const ui_file_style
&style
,
1854 struct ui_file
*stream
)
1856 set_output_style (stream
, style
);
1857 fputs_maybe_filtered (linebuffer
, stream
, 0);
1858 set_output_style (stream
, ui_file_style ());
1864 fputs_highlighted (const char *str
, const compiled_regex
&highlight
,
1865 struct ui_file
*stream
)
1869 while (*str
&& highlight
.exec (str
, 1, &pmatch
, 0) == 0)
1871 size_t n_highlight
= pmatch
.rm_eo
- pmatch
.rm_so
;
1873 /* Output the part before pmatch with current style. */
1874 while (pmatch
.rm_so
> 0)
1876 fputc_filtered (*str
, stream
);
1881 /* Output pmatch with the highlight style. */
1882 set_output_style (stream
, highlight_style
.style ());
1883 while (n_highlight
> 0)
1885 fputc_filtered (*str
, stream
);
1889 set_output_style (stream
, ui_file_style ());
1892 /* Output the trailing part of STR not matching HIGHLIGHT. */
1894 fputs_filtered (str
, stream
);
1898 putchar_unfiltered (int c
)
1900 return fputc_unfiltered (c
, gdb_stdout
);
1903 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
1904 May return nonlocally. */
1907 putchar_filtered (int c
)
1909 return fputc_filtered (c
, gdb_stdout
);
1913 fputc_unfiltered (int c
, struct ui_file
*stream
)
1919 fputs_unfiltered (buf
, stream
);
1924 fputc_filtered (int c
, struct ui_file
*stream
)
1930 fputs_filtered (buf
, stream
);
1934 /* Print a variable number of ARGS using format FORMAT. If this
1935 information is going to put the amount written (since the last call
1936 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
1937 call prompt_for_continue to get the users permission to continue.
1939 Unlike fprintf, this function does not return a value.
1941 We implement three variants, vfprintf (takes a vararg list and stream),
1942 fprintf (takes a stream to write on), and printf (the usual).
1944 Note also that this may throw a quit (since prompt_for_continue may
1948 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
1949 va_list args
, bool filter
)
1951 ui_out_flags flags
= disallow_ui_out_field
;
1953 flags
|= unfiltered_output
;
1954 cli_ui_out (stream
, flags
).vmessage (applied_style
, format
, args
);
1959 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
1961 vfprintf_maybe_filtered (stream
, format
, args
, true);
1965 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
1967 if (debug_timestamp
&& stream
== gdb_stdlog
)
1969 static bool needs_timestamp
= true;
1971 /* Print timestamp if previous print ended with a \n. */
1972 if (needs_timestamp
)
1974 using namespace std::chrono
;
1976 steady_clock::time_point now
= steady_clock::now ();
1977 seconds s
= duration_cast
<seconds
> (now
.time_since_epoch ());
1978 microseconds us
= duration_cast
<microseconds
> (now
.time_since_epoch () - s
);
1979 std::string timestamp
= string_printf ("%ld.%06ld ",
1981 (long) us
.count ());
1982 fputs_unfiltered (timestamp
.c_str (), stream
);
1985 /* Print the message. */
1987 cli_ui_out (&sfile
, 0).vmessage (ui_file_style (), format
, args
);
1988 std::string linebuffer
= std::move (sfile
.string ());
1989 fputs_unfiltered (linebuffer
.c_str (), stream
);
1991 size_t len
= linebuffer
.length ();
1992 needs_timestamp
= (len
> 0 && linebuffer
[len
- 1] == '\n');
1995 vfprintf_maybe_filtered (stream
, format
, args
, false);
1999 vprintf_filtered (const char *format
, va_list args
)
2001 vfprintf_filtered (gdb_stdout
, format
, args
);
2005 vprintf_unfiltered (const char *format
, va_list args
)
2007 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2011 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2015 va_start (args
, format
);
2016 vfprintf_filtered (stream
, format
, args
);
2021 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2025 va_start (args
, format
);
2026 vfprintf_unfiltered (stream
, format
, args
);
2033 fprintf_styled (struct ui_file
*stream
, const ui_file_style
&style
,
2034 const char *format
, ...)
2038 set_output_style (stream
, style
);
2039 va_start (args
, format
);
2040 vfprintf_filtered (stream
, format
, args
);
2042 set_output_style (stream
, ui_file_style ());
2048 vfprintf_styled (struct ui_file
*stream
, const ui_file_style
&style
,
2049 const char *format
, va_list args
)
2051 set_output_style (stream
, style
);
2052 vfprintf_filtered (stream
, format
, args
);
2053 set_output_style (stream
, ui_file_style ());
2059 vfprintf_styled_no_gdbfmt (struct ui_file
*stream
, const ui_file_style
&style
,
2060 bool filter
, const char *format
, va_list args
)
2062 std::string str
= string_vprintf (format
, args
);
2065 set_output_style (stream
, style
);
2066 fputs_maybe_filtered (str
.c_str (), stream
, filter
);
2067 set_output_style (stream
, ui_file_style ());
2072 printf_filtered (const char *format
, ...)
2076 va_start (args
, format
);
2077 vfprintf_filtered (gdb_stdout
, format
, args
);
2083 printf_unfiltered (const char *format
, ...)
2087 va_start (args
, format
);
2088 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2092 /* Easy -- but watch out!
2094 This routine is *not* a replacement for puts()! puts() appends a newline.
2095 This one doesn't, and had better not! */
2098 puts_filtered (const char *string
)
2100 fputs_filtered (string
, gdb_stdout
);
2104 puts_unfiltered (const char *string
)
2106 fputs_unfiltered (string
, gdb_stdout
);
2109 /* Return a pointer to N spaces and a null. The pointer is good
2110 until the next call to here. */
2115 static char *spaces
= 0;
2116 static int max_spaces
= -1;
2121 spaces
= (char *) xmalloc (n
+ 1);
2122 for (t
= spaces
+ n
; t
!= spaces
;)
2128 return spaces
+ max_spaces
- n
;
2131 /* Print N spaces. */
2133 print_spaces_filtered (int n
, struct ui_file
*stream
)
2135 fputs_filtered (n_spaces (n
), stream
);
2138 /* C++/ObjC demangler stuff. */
2140 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2141 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2142 If the name is not mangled, or the language for the name is unknown, or
2143 demangling is off, the name is printed in its "raw" form. */
2146 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2147 enum language lang
, int arg_mode
)
2151 /* If user wants to see raw output, no problem. */
2154 fputs_filtered (name
, stream
);
2158 gdb::unique_xmalloc_ptr
<char> demangled
2159 = language_demangle (language_def (lang
), name
, arg_mode
);
2160 fputs_filtered (demangled
? demangled
.get () : name
, stream
);
2165 /* True if CH is a character that can be part of a symbol name. I.e.,
2166 either a number, a letter, or a '_'. */
2169 valid_identifier_name_char (int ch
)
2171 return (ISALNUM (ch
) || ch
== '_');
2174 /* Skip to end of token, or to END, whatever comes first. Input is
2175 assumed to be a C++ operator name. */
2178 cp_skip_operator_token (const char *token
, const char *end
)
2180 const char *p
= token
;
2181 while (p
!= end
&& !ISSPACE (*p
) && *p
!= '(')
2183 if (valid_identifier_name_char (*p
))
2185 while (p
!= end
&& valid_identifier_name_char (*p
))
2191 /* Note, ordered such that among ops that share a prefix,
2192 longer comes first. This is so that the loop below can
2193 bail on first match. */
2194 static const char *ops
[] =
2200 "-=", "--", "->", "-",
2209 "<<=", "<=", "<<", "<",
2210 ">>=", ">=", ">>", ">",
2214 for (const char *op
: ops
)
2216 size_t oplen
= strlen (op
);
2217 size_t lencmp
= std::min
<size_t> (oplen
, end
- p
);
2219 if (strncmp (p
, op
, lencmp
) == 0)
2222 /* Some unidentified character. Return it. */
2230 /* Advance STRING1/STRING2 past whitespace. */
2233 skip_ws (const char *&string1
, const char *&string2
, const char *end_str2
)
2235 while (ISSPACE (*string1
))
2237 while (string2
< end_str2
&& ISSPACE (*string2
))
2241 /* True if STRING points at the start of a C++ operator name. START
2242 is the start of the string that STRING points to, hence when
2243 reading backwards, we must not read any character before START. */
2246 cp_is_operator (const char *string
, const char *start
)
2248 return ((string
== start
2249 || !valid_identifier_name_char (string
[-1]))
2250 && strncmp (string
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
2251 && !valid_identifier_name_char (string
[CP_OPERATOR_LEN
]));
2254 /* If *NAME points at an ABI tag, skip it and return true. Otherwise
2255 leave *NAME unmodified and return false. (see GCC's abi_tag
2256 attribute), such names are demangled as e.g.,
2257 "function[abi:cxx11]()". */
2260 skip_abi_tag (const char **name
)
2262 const char *p
= *name
;
2264 if (startswith (p
, "[abi:"))
2268 while (valid_identifier_name_char (*p
))
2284 strncmp_iw_with_mode (const char *string1
, const char *string2
,
2285 size_t string2_len
, strncmp_iw_mode mode
,
2286 enum language language
,
2287 completion_match_for_lcd
*match_for_lcd
)
2289 const char *string1_start
= string1
;
2290 const char *end_str2
= string2
+ string2_len
;
2291 bool skip_spaces
= true;
2292 bool have_colon_op
= (language
== language_cplus
2293 || language
== language_rust
2294 || language
== language_fortran
);
2299 || ((ISSPACE (*string1
) && !valid_identifier_name_char (*string2
))
2300 || (ISSPACE (*string2
) && !valid_identifier_name_char (*string1
))))
2302 skip_ws (string1
, string2
, end_str2
);
2303 skip_spaces
= false;
2306 /* Skip [abi:cxx11] tags in the symbol name if the lookup name
2307 doesn't include them. E.g.:
2309 string1: function[abi:cxx1](int)
2312 string1: function[abi:cxx1](int)
2313 string2: function(int)
2315 string1: Struct[abi:cxx1]::function()
2316 string2: Struct::function()
2318 string1: function(Struct[abi:cxx1], int)
2319 string2: function(Struct, int)
2321 if (string2
== end_str2
2322 || (*string2
!= '[' && !valid_identifier_name_char (*string2
)))
2324 const char *abi_start
= string1
;
2326 /* There can be more than one tag. */
2327 while (*string1
== '[' && skip_abi_tag (&string1
))
2330 if (match_for_lcd
!= NULL
&& abi_start
!= string1
)
2331 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2333 while (ISSPACE (*string1
))
2337 if (*string1
== '\0' || string2
== end_str2
)
2340 /* Handle the :: operator. */
2341 if (have_colon_op
&& string1
[0] == ':' && string1
[1] == ':')
2343 if (*string2
!= ':')
2349 if (string2
== end_str2
)
2352 if (*string2
!= ':')
2358 while (ISSPACE (*string1
))
2360 while (string2
< end_str2
&& ISSPACE (*string2
))
2365 /* Handle C++ user-defined operators. */
2366 else if (language
== language_cplus
2369 if (cp_is_operator (string1
, string1_start
))
2371 /* An operator name in STRING1. Check STRING2. */
2373 = std::min
<size_t> (CP_OPERATOR_LEN
, end_str2
- string2
);
2374 if (strncmp (string1
, string2
, cmplen
) != 0)
2380 if (string2
!= end_str2
)
2382 /* Check for "operatorX" in STRING2. */
2383 if (valid_identifier_name_char (*string2
))
2386 skip_ws (string1
, string2
, end_str2
);
2389 /* Handle operator(). */
2390 if (*string1
== '(')
2392 if (string2
== end_str2
)
2394 if (mode
== strncmp_iw_mode::NORMAL
)
2398 /* Don't break for the regular return at the
2399 bottom, because "operator" should not
2400 match "operator()", since this open
2401 parentheses is not the parameter list
2403 return *string1
!= '\0';
2407 if (*string1
!= *string2
)
2416 skip_ws (string1
, string2
, end_str2
);
2418 /* Skip to end of token, or to END, whatever comes
2420 const char *end_str1
= string1
+ strlen (string1
);
2421 const char *p1
= cp_skip_operator_token (string1
, end_str1
);
2422 const char *p2
= cp_skip_operator_token (string2
, end_str2
);
2424 cmplen
= std::min (p1
- string1
, p2
- string2
);
2427 if (strncmp (string1
, string2
, cmplen
) != 0)
2432 if (p1
- string1
!= p2
- string2
)
2434 if (strncmp (string1
, string2
, cmplen
) != 0)
2441 if (*string1
== '\0' || string2
== end_str2
)
2443 if (*string1
== '(' || *string2
== '(')
2451 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2453 if (case_sensitivity
== case_sensitive_off
2454 && (TOLOWER ((unsigned char) *string1
)
2455 != TOLOWER ((unsigned char) *string2
)))
2458 /* If we see any non-whitespace, non-identifier-name character
2459 (any of "()<>*&" etc.), then skip spaces the next time
2461 if (!ISSPACE (*string1
) && !valid_identifier_name_char (*string1
))
2468 if (string2
== end_str2
)
2470 if (mode
== strncmp_iw_mode::NORMAL
)
2472 /* Strip abi tag markers from the matched symbol name.
2473 Usually the ABI marker will be found on function name
2474 (automatically added because the function returns an
2475 object marked with an ABI tag). However, it's also
2476 possible to see a marker in one of the function
2477 parameters, for example.
2479 string2 (lookup name):
2482 function(some_struct[abi:cxx11], int)
2484 and for completion LCD computation we want to say that
2486 function(some_struct, int)
2488 if (match_for_lcd
!= NULL
)
2490 while ((string1
= strstr (string1
, "[abi:")) != NULL
)
2492 const char *abi_start
= string1
;
2494 /* There can be more than one tag. */
2495 while (skip_abi_tag (&string1
) && *string1
== '[')
2498 if (abi_start
!= string1
)
2499 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2506 return (*string1
!= '\0' && *string1
!= '(');
2515 strncmp_iw (const char *string1
, const char *string2
, size_t string2_len
)
2517 return strncmp_iw_with_mode (string1
, string2
, string2_len
,
2518 strncmp_iw_mode::NORMAL
, language_minimal
);
2524 strcmp_iw (const char *string1
, const char *string2
)
2526 return strncmp_iw_with_mode (string1
, string2
, strlen (string2
),
2527 strncmp_iw_mode::MATCH_PARAMS
, language_minimal
);
2530 /* This is like strcmp except that it ignores whitespace and treats
2531 '(' as the first non-NULL character in terms of ordering. Like
2532 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2533 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2534 according to that ordering.
2536 If a list is sorted according to this function and if you want to
2537 find names in the list that match some fixed NAME according to
2538 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2539 where this function would put NAME.
2541 This function must be neutral to the CASE_SENSITIVITY setting as the user
2542 may choose it during later lookup. Therefore this function always sorts
2543 primarily case-insensitively and secondarily case-sensitively.
2545 Here are some examples of why using strcmp to sort is a bad idea:
2549 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2550 we try to do a search for "foo<char*>", strcmp will locate this
2551 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2552 will start looking at strings beginning with "goo", and will never
2553 see the correct match of "foo<char *>".
2555 Parenthesis example:
2557 In practice, this is less like to be an issue, but I'll give it a
2558 shot. Let's assume that '$' is a legitimate character to occur in
2559 symbols. (Which may well even be the case on some systems.) Then
2560 say that the partial symbol table contains "foo$" and "foo(int)".
2561 strcmp will put them in this order, since '$' < '('. Now, if the
2562 user searches for "foo", then strcmp will sort "foo" before "foo$".
2563 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2564 "foo") is false, so it won't proceed to the actual match of
2565 "foo(int)" with "foo". */
2568 strcmp_iw_ordered (const char *string1
, const char *string2
)
2570 const char *saved_string1
= string1
, *saved_string2
= string2
;
2571 enum case_sensitivity case_pass
= case_sensitive_off
;
2575 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2576 Provide stub characters if we are already at the end of one of the
2578 char c1
= 'X', c2
= 'X';
2580 while (*string1
!= '\0' && *string2
!= '\0')
2582 while (ISSPACE (*string1
))
2584 while (ISSPACE (*string2
))
2589 case case_sensitive_off
:
2590 c1
= TOLOWER ((unsigned char) *string1
);
2591 c2
= TOLOWER ((unsigned char) *string2
);
2593 case case_sensitive_on
:
2601 if (*string1
!= '\0')
2610 /* Characters are non-equal unless they're both '\0'; we want to
2611 make sure we get the comparison right according to our
2612 comparison in the cases where one of them is '\0' or '('. */
2614 if (*string2
== '\0')
2619 if (*string2
== '\0')
2624 if (*string2
== '\0' || *string2
== '(')
2633 if (case_pass
== case_sensitive_on
)
2636 /* Otherwise the strings were equal in case insensitive way, make
2637 a more fine grained comparison in a case sensitive way. */
2639 case_pass
= case_sensitive_on
;
2640 string1
= saved_string1
;
2641 string2
= saved_string2
;
2648 streq (const char *lhs
, const char *rhs
)
2650 return !strcmp (lhs
, rhs
);
2657 ** Answer whether string_to_compare is a full or partial match to
2658 ** template_string. The partial match must be in sequence starting
2662 subset_compare (const char *string_to_compare
, const char *template_string
)
2666 if (template_string
!= NULL
&& string_to_compare
!= NULL
2667 && strlen (string_to_compare
) <= strlen (template_string
))
2669 (startswith (template_string
, string_to_compare
));
2676 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2677 struct cmd_list_element
*c
, const char *value
)
2679 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2687 address_significant (gdbarch
*gdbarch
, CORE_ADDR addr
)
2689 /* Clear insignificant bits of a target address and sign extend resulting
2690 address, avoiding shifts larger or equal than the width of a CORE_ADDR.
2691 The local variable ADDR_BIT stops the compiler reporting a shift overflow
2692 when it won't occur. Skip updating of target address if current target
2693 has not set gdbarch significant_addr_bit. */
2694 int addr_bit
= gdbarch_significant_addr_bit (gdbarch
);
2696 if (addr_bit
&& (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
)))
2698 CORE_ADDR sign
= (CORE_ADDR
) 1 << (addr_bit
- 1);
2699 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2700 addr
= (addr
^ sign
) - sign
;
2707 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2709 /* Truncate address to the size of a target address, avoiding shifts
2710 larger or equal than the width of a CORE_ADDR. The local
2711 variable ADDR_BIT stops the compiler reporting a shift overflow
2712 when it won't occur. */
2713 /* NOTE: This assumes that the significant address information is
2714 kept in the least significant bits of ADDR - the upper bits were
2715 either zero or sign extended. Should gdbarch_address_to_pointer or
2716 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2718 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2720 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2721 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2722 return hex_string (addr
);
2725 /* This function is described in "defs.h". */
2728 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2730 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2732 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2733 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2735 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2736 that returns the language localized string formatted to a width
2737 based on gdbarch_addr_bit. */
2739 return hex_string_custom (address
, 8);
2741 return hex_string_custom (address
, 16);
2744 /* Convert a string back into a CORE_ADDR. */
2746 string_to_core_addr (const char *my_string
)
2750 if (my_string
[0] == '0' && TOLOWER (my_string
[1]) == 'x')
2752 /* Assume that it is in hex. */
2755 for (i
= 2; my_string
[i
] != '\0'; i
++)
2757 if (ISDIGIT (my_string
[i
]))
2758 addr
= (my_string
[i
] - '0') + (addr
* 16);
2759 else if (ISXDIGIT (my_string
[i
]))
2760 addr
= (TOLOWER (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2762 error (_("invalid hex \"%s\""), my_string
);
2767 /* Assume that it is in decimal. */
2770 for (i
= 0; my_string
[i
] != '\0'; i
++)
2772 if (ISDIGIT (my_string
[i
]))
2773 addr
= (my_string
[i
] - '0') + (addr
* 10);
2775 error (_("invalid decimal \"%s\""), my_string
);
2785 gdb_realpath_check_trailer (const char *input
, const char *trailer
)
2787 gdb::unique_xmalloc_ptr
<char> result
= gdb_realpath (input
);
2789 size_t len
= strlen (result
.get ());
2790 size_t trail_len
= strlen (trailer
);
2792 SELF_CHECK (len
>= trail_len
2793 && strcmp (result
.get () + len
- trail_len
, trailer
) == 0);
2797 gdb_realpath_tests ()
2799 /* A file which contains a directory prefix. */
2800 gdb_realpath_check_trailer ("./xfullpath.exp", "/xfullpath.exp");
2801 /* A file which contains a directory prefix. */
2802 gdb_realpath_check_trailer ("../../defs.h", "/defs.h");
2803 /* A one-character filename. */
2804 gdb_realpath_check_trailer ("./a", "/a");
2805 /* A file in the root directory. */
2806 gdb_realpath_check_trailer ("/root_file_which_should_exist",
2807 "/root_file_which_should_exist");
2808 /* A file which does not have a directory prefix. */
2809 gdb_realpath_check_trailer ("xfullpath.exp", "xfullpath.exp");
2810 /* A one-char filename without any directory prefix. */
2811 gdb_realpath_check_trailer ("a", "a");
2812 /* An empty filename. */
2813 gdb_realpath_check_trailer ("", "");
2816 /* Test the gdb_argv::as_array_view method. */
2819 gdb_argv_as_array_view_test ()
2824 gdb::array_view
<char *> view
= argv
.as_array_view ();
2826 SELF_CHECK (view
.data () == nullptr);
2827 SELF_CHECK (view
.size () == 0);
2830 gdb_argv
argv ("une bonne 50");
2832 gdb::array_view
<char *> view
= argv
.as_array_view ();
2834 SELF_CHECK (view
.size () == 3);
2835 SELF_CHECK (strcmp (view
[0], "une") == 0);
2836 SELF_CHECK (strcmp (view
[1], "bonne") == 0);
2837 SELF_CHECK (strcmp (view
[2], "50") == 0);
2841 #endif /* GDB_SELF_TEST */
2843 /* Allocation function for the libiberty hash table which uses an
2844 obstack. The obstack is passed as DATA. */
2847 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
2849 size_t total
= size
* count
;
2850 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
2852 memset (ptr
, 0, total
);
2856 /* Trivial deallocation function for the libiberty splay tree and hash
2857 table - don't deallocate anything. Rely on later deletion of the
2858 obstack. DATA will be the obstack, although it is not needed
2862 dummy_obstack_deallocate (void *object
, void *data
)
2867 /* Simple, portable version of dirname that does not modify its
2871 ldirname (const char *filename
)
2873 std::string dirname
;
2874 const char *base
= lbasename (filename
);
2876 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
2879 if (base
== filename
)
2882 dirname
= std::string (filename
, base
- filename
);
2884 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
2885 create "d:./bar" later instead of the (different) "d:/bar". */
2886 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
2887 && !IS_DIR_SEPARATOR (filename
[0]))
2888 dirname
[base
++ - filename
] = '.';
2896 gdb_argv::reset (const char *s
)
2898 char **argv
= buildargv (s
);
2904 /* Return ARGS parsed as a valid pid, or throw an error. */
2907 parse_pid_to_attach (const char *args
)
2913 error_no_arg (_("process-id to attach"));
2915 dummy
= (char *) args
;
2916 pid
= strtoul (args
, &dummy
, 0);
2917 /* Some targets don't set errno on errors, grrr! */
2918 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
2919 error (_("Illegal process-id: %s."), args
);
2924 /* Substitute all occurrences of string FROM by string TO in *STRINGP. *STRINGP
2925 must come from xrealloc-compatible allocator and it may be updated. FROM
2926 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
2927 located at the start or end of *STRINGP. */
2930 substitute_path_component (char **stringp
, const char *from
, const char *to
)
2932 char *string
= *stringp
, *s
;
2933 const size_t from_len
= strlen (from
);
2934 const size_t to_len
= strlen (to
);
2938 s
= strstr (s
, from
);
2942 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
2943 || s
[-1] == DIRNAME_SEPARATOR
)
2944 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
2945 || s
[from_len
] == DIRNAME_SEPARATOR
))
2950 = (char *) xrealloc (string
, (strlen (string
) + to_len
+ 1));
2952 /* Relocate the current S pointer. */
2953 s
= s
- string
+ string_new
;
2954 string
= string_new
;
2956 /* Replace from by to. */
2957 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
2958 memcpy (s
, to
, to_len
);
2973 /* SIGALRM handler for waitpid_with_timeout. */
2976 sigalrm_handler (int signo
)
2978 /* Nothing to do. */
2983 /* Wrapper to wait for child PID to die with TIMEOUT.
2984 TIMEOUT is the time to stop waiting in seconds.
2985 If TIMEOUT is zero, pass WNOHANG to waitpid.
2986 Returns PID if it was successfully waited for, otherwise -1.
2988 Timeouts are currently implemented with alarm and SIGALRM.
2989 If the host does not support them, this waits "forever".
2990 It would be odd though for a host to have waitpid and not SIGALRM. */
2993 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
2995 pid_t waitpid_result
;
2997 gdb_assert (pid
> 0);
2998 gdb_assert (timeout
>= 0);
3003 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3004 struct sigaction sa
, old_sa
;
3006 sa
.sa_handler
= sigalrm_handler
;
3007 sigemptyset (&sa
.sa_mask
);
3009 sigaction (SIGALRM
, &sa
, &old_sa
);
3013 ofunc
= signal (SIGALRM
, sigalrm_handler
);
3019 waitpid_result
= waitpid (pid
, status
, 0);
3023 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3024 sigaction (SIGALRM
, &old_sa
, NULL
);
3026 signal (SIGALRM
, ofunc
);
3031 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3033 if (waitpid_result
== pid
)
3039 #endif /* HAVE_WAITPID */
3041 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3042 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3044 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3045 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3048 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3050 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3052 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3053 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3055 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3057 char *pattern_slash
, *string_slash
;
3059 /* Replace '\' by '/' in both strings. */
3061 pattern_slash
= (char *) alloca (strlen (pattern
) + 1);
3062 strcpy (pattern_slash
, pattern
);
3063 pattern
= pattern_slash
;
3064 for (; *pattern_slash
!= 0; pattern_slash
++)
3065 if (IS_DIR_SEPARATOR (*pattern_slash
))
3066 *pattern_slash
= '/';
3068 string_slash
= (char *) alloca (strlen (string
) + 1);
3069 strcpy (string_slash
, string
);
3070 string
= string_slash
;
3071 for (; *string_slash
!= 0; string_slash
++)
3072 if (IS_DIR_SEPARATOR (*string_slash
))
3073 *string_slash
= '/';
3075 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3077 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3078 flags
|= FNM_CASEFOLD
;
3079 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3081 return fnmatch (pattern
, string
, flags
);
3084 /* Return the number of path elements in PATH.
3092 count_path_elements (const char *path
)
3095 const char *p
= path
;
3097 if (HAS_DRIVE_SPEC (p
))
3099 p
= STRIP_DRIVE_SPEC (p
);
3105 if (IS_DIR_SEPARATOR (*p
))
3110 /* Backup one if last character is /, unless it's the only one. */
3111 if (p
> path
+ 1 && IS_DIR_SEPARATOR (p
[-1]))
3114 /* Add one for the file name, if present. */
3115 if (p
> path
&& !IS_DIR_SEPARATOR (p
[-1]))
3121 /* Remove N leading path elements from PATH.
3122 N must be non-negative.
3123 If PATH has more than N path elements then return NULL.
3124 If PATH has exactly N path elements then return "".
3125 See count_path_elements for a description of how we do the counting. */
3128 strip_leading_path_elements (const char *path
, int n
)
3131 const char *p
= path
;
3133 gdb_assert (n
>= 0);
3138 if (HAS_DRIVE_SPEC (p
))
3140 p
= STRIP_DRIVE_SPEC (p
);
3146 while (*p
!= '\0' && !IS_DIR_SEPARATOR (*p
))
3164 copy_bitwise (gdb_byte
*dest
, ULONGEST dest_offset
,
3165 const gdb_byte
*source
, ULONGEST source_offset
,
3166 ULONGEST nbits
, int bits_big_endian
)
3168 unsigned int buf
, avail
;
3173 if (bits_big_endian
)
3175 /* Start from the end, then work backwards. */
3176 dest_offset
+= nbits
- 1;
3177 dest
+= dest_offset
/ 8;
3178 dest_offset
= 7 - dest_offset
% 8;
3179 source_offset
+= nbits
- 1;
3180 source
+= source_offset
/ 8;
3181 source_offset
= 7 - source_offset
% 8;
3185 dest
+= dest_offset
/ 8;
3187 source
+= source_offset
/ 8;
3191 /* Fill BUF with DEST_OFFSET bits from the destination and 8 -
3192 SOURCE_OFFSET bits from the source. */
3193 buf
= *(bits_big_endian
? source
-- : source
++) >> source_offset
;
3194 buf
<<= dest_offset
;
3195 buf
|= *dest
& ((1 << dest_offset
) - 1);
3197 /* NBITS: bits yet to be written; AVAIL: BUF's fill level. */
3198 nbits
+= dest_offset
;
3199 avail
= dest_offset
+ 8 - source_offset
;
3201 /* Flush 8 bits from BUF, if appropriate. */
3202 if (nbits
>= 8 && avail
>= 8)
3204 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3210 /* Copy the middle part. */
3213 size_t len
= nbits
/ 8;
3215 /* Use a faster method for byte-aligned copies. */
3218 if (bits_big_endian
)
3222 memcpy (dest
+ 1, source
+ 1, len
);
3226 memcpy (dest
, source
, len
);
3235 buf
|= *(bits_big_endian
? source
-- : source
++) << avail
;
3236 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3243 /* Write the last byte. */
3247 buf
|= *source
<< avail
;
3249 buf
&= (1 << nbits
) - 1;
3250 *dest
= (*dest
& (~0U << nbits
)) | buf
;
3254 void _initialize_utils ();
3256 _initialize_utils ()
3258 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
3259 Set number of characters where GDB should wrap lines of its output."), _("\
3260 Show number of characters where GDB should wrap lines of its output."), _("\
3261 This affects where GDB wraps its output to fit the screen width.\n\
3262 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
3264 show_chars_per_line
,
3265 &setlist
, &showlist
);
3267 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
3268 Set number of lines in a page for GDB output pagination."), _("\
3269 Show number of lines in a page for GDB output pagination."), _("\
3270 This affects the number of lines after which GDB will pause\n\
3271 its output and ask you whether to continue.\n\
3272 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
3274 show_lines_per_page
,
3275 &setlist
, &showlist
);
3277 add_setshow_boolean_cmd ("pagination", class_support
,
3278 &pagination_enabled
, _("\
3279 Set state of GDB output pagination."), _("\
3280 Show state of GDB output pagination."), _("\
3281 When pagination is ON, GDB pauses at end of each screenful of\n\
3282 its output and asks you whether to continue.\n\
3283 Turning pagination off is an alternative to \"set height unlimited\"."),
3285 show_pagination_enabled
,
3286 &setlist
, &showlist
);
3288 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
3289 &sevenbit_strings
, _("\
3290 Set printing of 8-bit characters in strings as \\nnn."), _("\
3291 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
3293 show_sevenbit_strings
,
3294 &setprintlist
, &showprintlist
);
3296 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
3297 &debug_timestamp
, _("\
3298 Set timestamping of debugging messages."), _("\
3299 Show timestamping of debugging messages."), _("\
3300 When set, debugging messages will be marked with seconds and microseconds."),
3302 show_debug_timestamp
,
3303 &setdebuglist
, &showdebuglist
);
3305 add_internal_problem_command (&internal_error_problem
);
3306 add_internal_problem_command (&internal_warning_problem
);
3307 add_internal_problem_command (&demangler_warning_problem
);
3310 selftests::register_test ("gdb_realpath", gdb_realpath_tests
);
3311 selftests::register_test ("gdb_argv_array_view", gdb_argv_as_array_view_test
);