1 /* General utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2021 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. */
783 print_spaces (int n
, struct ui_file
*file
)
785 fputs_unfiltered (n_spaces (n
), file
);
788 /* Print a host address. */
791 gdb_print_host_address_1 (const void *addr
, struct ui_file
*stream
)
793 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
798 /* An RAII class that sets up to handle input and then tears down
799 during destruction. */
801 class scoped_input_handler
805 scoped_input_handler ()
806 : m_quit_handler (&quit_handler
, default_quit_handler
),
809 target_terminal::ours ();
810 ui_register_input_event_handler (current_ui
);
811 if (current_ui
->prompt_state
== PROMPT_BLOCKED
)
815 ~scoped_input_handler ()
818 ui_unregister_input_event_handler (m_ui
);
821 DISABLE_COPY_AND_ASSIGN (scoped_input_handler
);
825 /* Save and restore the terminal state. */
826 target_terminal::scoped_restore_terminal_state m_term_state
;
828 /* Save and restore the quit handler. */
829 scoped_restore_tmpl
<quit_handler_ftype
*> m_quit_handler
;
831 /* The saved UI, if non-NULL. */
837 /* This function supports the query, nquery, and yquery functions.
838 Ask user a y-or-n question and return 0 if answer is no, 1 if
839 answer is yes, or default the answer to the specified default
840 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
841 default answer, or '\0' for no default.
842 CTLSTR is the control string and should end in "? ". It should
843 not say how to answer, because we do that.
844 ARGS are the arguments passed along with the CTLSTR argument to
847 static int ATTRIBUTE_PRINTF (1, 0)
848 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
852 char def_answer
, not_def_answer
;
853 const char *y_string
, *n_string
;
855 /* Set up according to which answer is the default. */
860 not_def_answer
= 'N';
864 else if (defchar
== 'y')
868 not_def_answer
= 'N';
876 not_def_answer
= 'Y';
881 /* Automatically answer the default value if the user did not want
882 prompts or the command was issued with the server prefix. */
883 if (!confirm
|| server_command
)
886 /* If input isn't coming from the user directly, just say what
887 question we're asking, and then answer the default automatically. This
888 way, important error messages don't get lost when talking to GDB
890 if (current_ui
->instream
!= current_ui
->stdin_stream
891 || !input_interactive_p (current_ui
)
892 /* Restrict queries to the main UI. */
893 || current_ui
!= main_ui
)
895 target_terminal::scoped_restore_terminal_state term_state
;
896 target_terminal::ours_for_output ();
898 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
900 printf_filtered (_("(%s or %s) [answered %c; "
901 "input not from terminal]\n"),
902 y_string
, n_string
, def_answer
);
907 if (deprecated_query_hook
)
909 target_terminal::scoped_restore_terminal_state term_state
;
910 return deprecated_query_hook (ctlstr
, args
);
913 /* Format the question outside of the loop, to avoid reusing args. */
914 std::string question
= string_vprintf (ctlstr
, args
);
916 = string_printf (_("%s%s(%s or %s) %s"),
917 annotation_level
> 1 ? "\n\032\032pre-query\n" : "",
918 question
.c_str (), y_string
, n_string
,
919 annotation_level
> 1 ? "\n\032\032query\n" : "");
921 /* Used to add duration we waited for user to respond to
922 prompt_for_continue_wait_time. */
923 using namespace std::chrono
;
924 steady_clock::time_point prompt_started
= steady_clock::now ();
926 scoped_input_handler prepare_input
;
930 char *response
, answer
;
932 gdb_flush (gdb_stdout
);
933 response
= gdb_readline_wrapper (prompt
.c_str ());
935 if (response
== NULL
) /* C-d */
937 printf_filtered ("EOF [assumed %c]\n", def_answer
);
942 answer
= response
[0];
947 /* Check answer. For the non-default, the user must specify
948 the non-default explicitly. */
949 if (answer
== not_def_answer
)
954 /* Otherwise, if a default was specified, the user may either
955 specify the required input or have it default by entering
957 if (answer
== def_answer
958 || (defchar
!= '\0' && answer
== '\0'))
963 /* Invalid entries are not defaulted and require another selection. */
964 printf_filtered (_("Please answer %s or %s.\n"),
968 /* Add time spend in this routine to prompt_for_continue_wait_time. */
969 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
971 if (annotation_level
> 1)
972 printf_filtered (("\n\032\032post-query\n"));
977 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
978 answer is yes, or 0 if answer is defaulted.
979 Takes three args which are given to printf to print the question.
980 The first, a control string, should end in "? ".
981 It should not say how to answer, because we do that. */
984 nquery (const char *ctlstr
, ...)
989 va_start (args
, ctlstr
);
990 ret
= defaulted_query (ctlstr
, 'n', args
);
995 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
996 answer is yes, or 1 if answer is defaulted.
997 Takes three args which are given to printf to print the question.
998 The first, a control string, should end in "? ".
999 It should not say how to answer, because we do that. */
1002 yquery (const char *ctlstr
, ...)
1007 va_start (args
, ctlstr
);
1008 ret
= defaulted_query (ctlstr
, 'y', args
);
1013 /* Ask user a y-or-n question and return 1 iff answer is yes.
1014 Takes three args which are given to printf to print the question.
1015 The first, a control string, should end in "? ".
1016 It should not say how to answer, because we do that. */
1019 query (const char *ctlstr
, ...)
1024 va_start (args
, ctlstr
);
1025 ret
= defaulted_query (ctlstr
, '\0', args
);
1030 /* A helper for parse_escape that converts a host character to a
1031 target character. C is the host character. If conversion is
1032 possible, then the target character is stored in *TARGET_C and the
1033 function returns 1. Otherwise, the function returns 0. */
1036 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1041 auto_obstack host_data
;
1043 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1044 (gdb_byte
*) &the_char
, 1, 1,
1045 &host_data
, translit_none
);
1047 if (obstack_object_size (&host_data
) == 1)
1050 *target_c
= *(char *) obstack_base (&host_data
);
1056 /* Parse a C escape sequence. STRING_PTR points to a variable
1057 containing a pointer to the string to parse. That pointer
1058 should point to the character after the \. That pointer
1059 is updated past the characters we use. The value of the
1060 escape sequence is returned.
1062 A negative value means the sequence \ newline was seen,
1063 which is supposed to be equivalent to nothing at all.
1065 If \ is followed by a null character, we return a negative
1066 value and leave the string pointer pointing at the null character.
1068 If \ is followed by 000, we return 0 and leave the string pointer
1069 after the zeros. A value of 0 does not mean end of string. */
1072 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1074 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1075 int c
= *(*string_ptr
)++;
1094 int i
= host_hex_value (c
);
1099 if (ISDIGIT (c
) && c
!= '8' && c
!= '9')
1103 i
+= host_hex_value (c
);
1139 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1140 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1141 " which has no equivalent\nin the `%s' character set."),
1142 c
, c
, target_charset (gdbarch
));
1146 /* Print the character C on STREAM as part of the contents of a literal
1147 string whose delimiter is QUOTER. Note that this routine should only
1148 be called for printing things which are independent of the language
1149 of the program being debugged.
1151 printchar will normally escape backslashes and instances of QUOTER. If
1152 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1153 As a side effect, if you pass the backslash character as the QUOTER,
1154 printchar will escape backslashes as usual, but not any other quoting
1158 printchar (int c
, do_fputc_ftype do_fputc
, ui_file
*stream
, int quoter
)
1160 c
&= 0xFF; /* Avoid sign bit follies */
1162 if (c
< 0x20 || /* Low control chars */
1163 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1164 (sevenbit_strings
&& c
>= 0x80))
1165 { /* high order bit set */
1166 do_fputc ('\\', stream
);
1171 do_fputc ('n', stream
);
1174 do_fputc ('b', stream
);
1177 do_fputc ('t', stream
);
1180 do_fputc ('f', stream
);
1183 do_fputc ('r', stream
);
1186 do_fputc ('e', stream
);
1189 do_fputc ('a', stream
);
1193 do_fputc ('0' + ((c
>> 6) & 0x7), stream
);
1194 do_fputc ('0' + ((c
>> 3) & 0x7), stream
);
1195 do_fputc ('0' + ((c
>> 0) & 0x7), stream
);
1202 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1203 do_fputc ('\\', stream
);
1204 do_fputc (c
, stream
);
1208 /* Print the character C on STREAM as part of the contents of a
1209 literal string whose delimiter is QUOTER. Note that these routines
1210 should only be call for printing things which are independent of
1211 the language of the program being debugged. */
1214 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1217 printchar (*str
++, fputc_filtered
, stream
, quoter
);
1221 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1224 printchar (*str
++, fputc_unfiltered
, stream
, quoter
);
1228 fputstrn_filtered (const char *str
, int n
, int quoter
,
1229 struct ui_file
*stream
)
1231 for (int i
= 0; i
< n
; i
++)
1232 printchar (str
[i
], fputc_filtered
, stream
, quoter
);
1236 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1237 do_fputc_ftype do_fputc
, struct ui_file
*stream
)
1239 for (int i
= 0; i
< n
; i
++)
1240 printchar (str
[i
], do_fputc
, stream
, quoter
);
1244 /* Number of lines per page or UINT_MAX if paging is disabled. */
1245 static unsigned int lines_per_page
;
1247 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1248 struct cmd_list_element
*c
, const char *value
)
1250 fprintf_filtered (file
,
1251 _("Number of lines gdb thinks are in a page is %s.\n"),
1255 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1256 static unsigned int chars_per_line
;
1258 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1259 struct cmd_list_element
*c
, const char *value
)
1261 fprintf_filtered (file
,
1262 _("Number of characters gdb thinks "
1263 "are in a line is %s.\n"),
1267 /* Current count of lines printed on this page, chars on this line. */
1268 static unsigned int lines_printed
, chars_printed
;
1270 /* True if pagination is disabled for just one command. */
1272 static bool pagination_disabled_for_command
;
1274 /* Buffer and start column of buffered text, for doing smarter word-
1275 wrapping. When someone calls wrap_here(), we start buffering output
1276 that comes through fputs_filtered(). If we see a newline, we just
1277 spit it out and forget about the wrap_here(). If we see another
1278 wrap_here(), we spit it out and remember the newer one. If we see
1279 the end of the line, we spit out a newline, the indent, and then
1280 the buffered output. */
1282 static bool filter_initialized
= false;
1284 /* Contains characters which are waiting to be output (they have
1285 already been counted in chars_printed). */
1286 static std::string wrap_buffer
;
1288 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1290 static const char *wrap_indent
;
1292 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1293 is not in effect. */
1294 static int wrap_column
;
1296 /* The style applied at the time that wrap_here was called. */
1297 static ui_file_style wrap_style
;
1300 /* Initialize the number of lines per page and chars per line. */
1303 init_page_info (void)
1307 lines_per_page
= UINT_MAX
;
1308 chars_per_line
= UINT_MAX
;
1312 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1317 #if defined(__GO32__)
1318 rows
= ScreenRows ();
1319 cols
= ScreenCols ();
1320 lines_per_page
= rows
;
1321 chars_per_line
= cols
;
1323 /* Make sure Readline has initialized its terminal settings. */
1324 rl_reset_terminal (NULL
);
1326 /* Get the screen size from Readline. */
1327 rl_get_screen_size (&rows
, &cols
);
1328 lines_per_page
= rows
;
1329 chars_per_line
= cols
;
1331 /* Readline should have fetched the termcap entry for us.
1332 Only try to use tgetnum function if rl_get_screen_size
1333 did not return a useful value. */
1334 if (((rows
<= 0) && (tgetnum ((char *) "li") < 0))
1335 /* Also disable paging if inside Emacs. $EMACS was used
1336 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1337 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1339 /* The number of lines per page is not mentioned in the terminal
1340 description or EMACS environment variable is set. This probably
1341 means that paging is not useful, so disable paging. */
1342 lines_per_page
= UINT_MAX
;
1345 /* If the output is not a terminal, don't paginate it. */
1346 if (!gdb_stdout
->isatty ())
1347 lines_per_page
= UINT_MAX
;
1351 /* We handle SIGWINCH ourselves. */
1352 rl_catch_sigwinch
= 0;
1358 /* Return nonzero if filtered printing is initialized. */
1360 filtered_printing_initialized (void)
1362 return filter_initialized
;
1365 set_batch_flag_and_restore_page_info::set_batch_flag_and_restore_page_info ()
1366 : m_save_lines_per_page (lines_per_page
),
1367 m_save_chars_per_line (chars_per_line
),
1368 m_save_batch_flag (batch_flag
)
1374 set_batch_flag_and_restore_page_info::~set_batch_flag_and_restore_page_info ()
1376 batch_flag
= m_save_batch_flag
;
1377 chars_per_line
= m_save_chars_per_line
;
1378 lines_per_page
= m_save_lines_per_page
;
1384 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1387 set_screen_size (void)
1389 int rows
= lines_per_page
;
1390 int cols
= chars_per_line
;
1392 /* If we get 0 or negative ROWS or COLS, treat as "infinite" size.
1393 A negative number can be seen here with the "set width/height"
1394 commands and either:
1396 - the user specified "unlimited", which maps to UINT_MAX, or
1397 - the user specified some number between INT_MAX and UINT_MAX.
1399 Cap "infinity" to approximately sqrt(INT_MAX) so that we don't
1400 overflow in rl_set_screen_size, which multiplies rows and columns
1401 to compute the number of characters on the screen. */
1403 const int sqrt_int_max
= INT_MAX
>> (sizeof (int) * 8 / 2);
1405 if (rows
<= 0 || rows
> sqrt_int_max
)
1407 rows
= sqrt_int_max
;
1408 lines_per_page
= UINT_MAX
;
1411 if (cols
<= 0 || cols
> sqrt_int_max
)
1413 cols
= sqrt_int_max
;
1414 chars_per_line
= UINT_MAX
;
1417 /* Update Readline's idea of the terminal size. */
1418 rl_set_screen_size (rows
, cols
);
1421 /* Reinitialize WRAP_BUFFER. */
1426 if (chars_per_line
== 0)
1429 wrap_buffer
.clear ();
1430 filter_initialized
= true;
1434 set_width_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1441 set_height_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1449 set_screen_width_and_height (int width
, int height
)
1451 lines_per_page
= height
;
1452 chars_per_line
= width
;
1458 /* The currently applied style. */
1460 static ui_file_style applied_style
;
1462 /* Emit an ANSI style escape for STYLE. If STREAM is nullptr, emit to
1463 the wrap buffer; otherwise emit to STREAM. */
1466 emit_style_escape (const ui_file_style
&style
,
1467 struct ui_file
*stream
= nullptr)
1469 if (applied_style
!= style
)
1471 applied_style
= style
;
1473 if (stream
== nullptr)
1474 wrap_buffer
.append (style
.to_ansi ());
1476 stream
->puts (style
.to_ansi ().c_str ());
1480 /* Set the current output style. This will affect future uses of the
1481 _filtered output functions. */
1484 set_output_style (struct ui_file
*stream
, const ui_file_style
&style
)
1486 if (!stream
->can_emit_style_escape ())
1489 /* Note that we may not pass STREAM here, when we want to emit to
1490 the wrap buffer, not directly to STREAM. */
1491 if (stream
== gdb_stdout
)
1493 emit_style_escape (style
, stream
);
1499 reset_terminal_style (struct ui_file
*stream
)
1501 if (stream
->can_emit_style_escape ())
1503 /* Force the setting, regardless of what we think the setting
1504 might already be. */
1505 applied_style
= ui_file_style ();
1506 wrap_buffer
.append (applied_style
.to_ansi ());
1510 /* Wait, so the user can read what's on the screen. Prompt the user
1511 to continue by pressing RETURN. 'q' is also provided because
1512 telling users what to do in the prompt is more user-friendly than
1513 expecting them to think of Ctrl-C/SIGINT. */
1516 prompt_for_continue (void)
1518 char cont_prompt
[120];
1519 /* Used to add duration we waited for user to respond to
1520 prompt_for_continue_wait_time. */
1521 using namespace std::chrono
;
1522 steady_clock::time_point prompt_started
= steady_clock::now ();
1523 bool disable_pagination
= pagination_disabled_for_command
;
1525 /* Clear the current styling. */
1526 if (gdb_stdout
->can_emit_style_escape ())
1527 emit_style_escape (ui_file_style (), gdb_stdout
);
1529 if (annotation_level
> 1)
1530 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1532 strcpy (cont_prompt
,
1533 "--Type <RET> for more, q to quit, "
1534 "c to continue without paging--");
1535 if (annotation_level
> 1)
1536 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1538 /* We must do this *before* we call gdb_readline_wrapper, else it
1539 will eventually call us -- thinking that we're trying to print
1540 beyond the end of the screen. */
1541 reinitialize_more_filter ();
1543 scoped_input_handler prepare_input
;
1545 /* Call gdb_readline_wrapper, not readline, in order to keep an
1546 event loop running. */
1547 gdb::unique_xmalloc_ptr
<char> ignore (gdb_readline_wrapper (cont_prompt
));
1549 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1550 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1552 if (annotation_level
> 1)
1553 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1557 char *p
= ignore
.get ();
1559 while (*p
== ' ' || *p
== '\t')
1562 /* Do not call quit here; there is no possibility of SIGINT. */
1563 throw_quit ("Quit");
1565 disable_pagination
= true;
1568 /* Now we have to do this again, so that GDB will know that it doesn't
1569 need to save the ---Type <return>--- line at the top of the screen. */
1570 reinitialize_more_filter ();
1571 pagination_disabled_for_command
= disable_pagination
;
1573 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1576 /* Initialize timer to keep track of how long we waited for the user. */
1579 reset_prompt_for_continue_wait_time (void)
1581 using namespace std::chrono
;
1583 prompt_for_continue_wait_time
= steady_clock::duration::zero ();
1586 /* Fetch the cumulative time spent in prompt_for_continue. */
1588 std::chrono::steady_clock::duration
1589 get_prompt_for_continue_wait_time ()
1591 return prompt_for_continue_wait_time
;
1594 /* Reinitialize filter; ie. tell it to reset to original values. */
1597 reinitialize_more_filter (void)
1601 pagination_disabled_for_command
= false;
1604 /* Flush the wrap buffer to STREAM, if necessary. */
1607 flush_wrap_buffer (struct ui_file
*stream
)
1609 if (stream
== gdb_stdout
&& !wrap_buffer
.empty ())
1611 stream
->puts (wrap_buffer
.c_str ());
1612 wrap_buffer
.clear ();
1619 gdb_flush (struct ui_file
*stream
)
1621 flush_wrap_buffer (stream
);
1628 get_chars_per_line ()
1630 return chars_per_line
;
1633 /* Indicate that if the next sequence of characters overflows the line,
1634 a newline should be inserted here rather than when it hits the end.
1635 If INDENT is non-null, it is a string to be printed to indent the
1636 wrapped part on the next line. INDENT must remain accessible until
1637 the next call to wrap_here() or until a newline is printed through
1640 If the line is already overfull, we immediately print a newline and
1641 the indentation, and disable further wrapping.
1643 If we don't know the width of lines, but we know the page height,
1644 we must not wrap words, but should still keep track of newlines
1645 that were explicitly printed.
1647 INDENT should not contain tabs, as that will mess up the char count
1648 on the next line. FIXME.
1650 This routine is guaranteed to force out any output which has been
1651 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1652 used to force out output from the wrap_buffer. */
1655 wrap_here (const char *indent
)
1657 /* This should have been allocated, but be paranoid anyway. */
1658 gdb_assert (filter_initialized
);
1660 flush_wrap_buffer (gdb_stdout
);
1661 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1665 else if (chars_printed
>= chars_per_line
)
1667 puts_filtered ("\n");
1669 puts_filtered (indent
);
1674 wrap_column
= chars_printed
;
1678 wrap_indent
= indent
;
1679 wrap_style
= applied_style
;
1683 /* Print input string to gdb_stdout, filtered, with wrap,
1684 arranging strings in columns of n chars. String can be
1685 right or left justified in the column. Never prints
1686 trailing spaces. String should never be longer than
1687 width. FIXME: this could be useful for the EXAMINE
1688 command, which currently doesn't tabulate very well. */
1691 puts_filtered_tabular (char *string
, int width
, int right
)
1697 gdb_assert (chars_per_line
> 0);
1698 if (chars_per_line
== UINT_MAX
)
1700 fputs_filtered (string
, gdb_stdout
);
1701 fputs_filtered ("\n", gdb_stdout
);
1705 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1706 fputs_filtered ("\n", gdb_stdout
);
1708 if (width
>= chars_per_line
)
1709 width
= chars_per_line
- 1;
1711 stringlen
= strlen (string
);
1713 if (chars_printed
> 0)
1714 spaces
= width
- (chars_printed
- 1) % width
- 1;
1716 spaces
+= width
- stringlen
;
1718 spacebuf
= (char *) alloca (spaces
+ 1);
1719 spacebuf
[spaces
] = '\0';
1721 spacebuf
[spaces
] = ' ';
1723 fputs_filtered (spacebuf
, gdb_stdout
);
1724 fputs_filtered (string
, gdb_stdout
);
1728 /* Ensure that whatever gets printed next, using the filtered output
1729 commands, starts at the beginning of the line. I.e. if there is
1730 any pending output for the current line, flush it and start a new
1731 line. Otherwise do nothing. */
1736 if (chars_printed
> 0)
1738 puts_filtered ("\n");
1743 /* Like fputs but if FILTER is true, pause after every screenful.
1745 Regardless of FILTER can wrap at points other than the final
1746 character of a line.
1748 Unlike fputs, fputs_maybe_filtered does not return a value.
1749 It is OK for LINEBUFFER to be NULL, in which case just don't print
1752 Note that a longjmp to top level may occur in this routine (only if
1753 FILTER is true) (since prompt_for_continue may do so) so this
1754 routine should not be called when cleanups are not in place. */
1757 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1760 const char *lineptr
;
1762 if (linebuffer
== 0)
1765 /* Don't do any filtering if it is disabled. */
1766 if (stream
!= gdb_stdout
1767 || !pagination_enabled
1768 || pagination_disabled_for_command
1770 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
1771 || top_level_interpreter () == NULL
1772 || top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
1774 flush_wrap_buffer (stream
);
1775 stream
->puts (linebuffer
);
1780 = make_scope_exit ([&] ()
1782 wrap_buffer
.clear ();
1787 /* Go through and output each character. Show line extension
1788 when this is necessary; prompt user for new page when this is
1791 lineptr
= linebuffer
;
1794 /* Possible new page. Note that PAGINATION_DISABLED_FOR_COMMAND
1795 might be set during this loop, so we must continue to check
1797 if (filter
&& (lines_printed
>= lines_per_page
- 1)
1798 && !pagination_disabled_for_command
)
1799 prompt_for_continue ();
1801 while (*lineptr
&& *lineptr
!= '\n')
1805 /* Print a single line. */
1806 if (*lineptr
== '\t')
1808 wrap_buffer
.push_back ('\t');
1809 /* Shifting right by 3 produces the number of tab stops
1810 we have already passed, and then adding one and
1811 shifting left 3 advances to the next tab stop. */
1812 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
1815 else if (*lineptr
== '\033'
1816 && skip_ansi_escape (lineptr
, &skip_bytes
))
1818 wrap_buffer
.append (lineptr
, skip_bytes
);
1819 /* Note that we don't consider this a character, so we
1820 don't increment chars_printed here. */
1821 lineptr
+= skip_bytes
;
1823 else if (*lineptr
== '\r')
1825 wrap_buffer
.push_back (*lineptr
);
1831 wrap_buffer
.push_back (*lineptr
);
1836 if (chars_printed
>= chars_per_line
)
1838 unsigned int save_chars
= chars_printed
;
1840 /* If we change the style, below, we'll want to reset it
1841 before continuing to print. If there is no wrap
1842 column, then we'll only reset the style if the pager
1843 prompt is given; and to avoid emitting style
1844 sequences in the middle of a run of text, we track
1846 ui_file_style save_style
= applied_style
;
1847 bool did_paginate
= false;
1853 /* We are about to insert a newline at an historic
1854 location in the WRAP_BUFFER. Before we do we want to
1855 restore the default style. To know if we actually
1856 need to insert an escape sequence we must restore the
1857 current applied style to how it was at the WRAP_COLUMN
1859 applied_style
= wrap_style
;
1860 if (stream
->can_emit_style_escape ())
1861 emit_style_escape (ui_file_style (), stream
);
1862 /* If we aren't actually wrapping, don't output
1863 newline -- if chars_per_line is right, we
1864 probably just overflowed anyway; if it's wrong,
1865 let us keep going. */
1866 /* XXX: The ideal thing would be to call
1867 'stream->putc' here, but we can't because it
1868 currently calls 'fputc_unfiltered', which ends up
1869 calling us, which generates an infinite
1871 stream
->puts ("\n");
1874 flush_wrap_buffer (stream
);
1876 /* Possible new page. Note that
1877 PAGINATION_DISABLED_FOR_COMMAND might be set during
1878 this loop, so we must continue to check it here. */
1879 if (lines_printed
>= lines_per_page
- 1
1880 && !pagination_disabled_for_command
)
1882 prompt_for_continue ();
1883 did_paginate
= true;
1886 /* Now output indentation and wrapped string. */
1889 stream
->puts (wrap_indent
);
1891 /* Having finished inserting the wrapping we should
1892 restore the style as it was at the WRAP_COLUMN. */
1893 if (stream
->can_emit_style_escape ())
1894 emit_style_escape (wrap_style
, stream
);
1896 /* The WRAP_BUFFER will still contain content, and that
1897 content might set some alternative style. Restore
1898 APPLIED_STYLE as it was before we started wrapping,
1899 this reflects the current style for the last character
1901 applied_style
= save_style
;
1903 /* FIXME, this strlen is what prevents wrap_indent from
1904 containing tabs. However, if we recurse to print it
1905 and count its chars, we risk trouble if wrap_indent is
1906 longer than (the user settable) chars_per_line.
1907 Note also that this can set chars_printed > chars_per_line
1908 if we are printing a long string. */
1909 chars_printed
= strlen (wrap_indent
)
1910 + (save_chars
- wrap_column
);
1911 wrap_column
= 0; /* And disable fancy wrap */
1913 else if (did_paginate
&& stream
->can_emit_style_escape ())
1914 emit_style_escape (save_style
, stream
);
1918 if (*lineptr
== '\n')
1921 wrap_here ((char *) 0); /* Spit out chars, cancel
1924 /* XXX: The ideal thing would be to call
1925 'stream->putc' here, but we can't because it
1926 currently calls 'fputc_unfiltered', which ends up
1927 calling us, which generates an infinite
1929 stream
->puts ("\n");
1934 buffer_clearer
.release ();
1938 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
1940 fputs_maybe_filtered (linebuffer
, stream
, 1);
1944 fputs_unfiltered (const char *linebuffer
, struct ui_file
*stream
)
1946 fputs_maybe_filtered (linebuffer
, stream
, 0);
1952 fputs_styled (const char *linebuffer
, const ui_file_style
&style
,
1953 struct ui_file
*stream
)
1955 set_output_style (stream
, style
);
1956 fputs_maybe_filtered (linebuffer
, stream
, 1);
1957 set_output_style (stream
, ui_file_style ());
1963 fputs_styled_unfiltered (const char *linebuffer
, const ui_file_style
&style
,
1964 struct ui_file
*stream
)
1966 set_output_style (stream
, style
);
1967 fputs_maybe_filtered (linebuffer
, stream
, 0);
1968 set_output_style (stream
, ui_file_style ());
1974 fputs_highlighted (const char *str
, const compiled_regex
&highlight
,
1975 struct ui_file
*stream
)
1979 while (*str
&& highlight
.exec (str
, 1, &pmatch
, 0) == 0)
1981 size_t n_highlight
= pmatch
.rm_eo
- pmatch
.rm_so
;
1983 /* Output the part before pmatch with current style. */
1984 while (pmatch
.rm_so
> 0)
1986 fputc_filtered (*str
, stream
);
1991 /* Output pmatch with the highlight style. */
1992 set_output_style (stream
, highlight_style
.style ());
1993 while (n_highlight
> 0)
1995 fputc_filtered (*str
, stream
);
1999 set_output_style (stream
, ui_file_style ());
2002 /* Output the trailing part of STR not matching HIGHLIGHT. */
2004 fputs_filtered (str
, stream
);
2008 putchar_unfiltered (int c
)
2010 return fputc_unfiltered (c
, gdb_stdout
);
2013 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2014 May return nonlocally. */
2017 putchar_filtered (int c
)
2019 return fputc_filtered (c
, gdb_stdout
);
2023 fputc_unfiltered (int c
, struct ui_file
*stream
)
2029 fputs_unfiltered (buf
, stream
);
2034 fputc_filtered (int c
, struct ui_file
*stream
)
2040 fputs_filtered (buf
, stream
);
2044 /* puts_debug is like fputs_unfiltered, except it prints special
2045 characters in printable fashion. */
2048 puts_debug (char *prefix
, char *string
, char *suffix
)
2052 /* Print prefix and suffix after each line. */
2053 static int new_line
= 1;
2054 static int return_p
= 0;
2055 static const char *prev_prefix
= "";
2056 static const char *prev_suffix
= "";
2058 if (*string
== '\n')
2061 /* If the prefix is changing, print the previous suffix, a new line,
2062 and the new prefix. */
2063 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
2065 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
2066 fputs_unfiltered ("\n", gdb_stdlog
);
2067 fputs_unfiltered (prefix
, gdb_stdlog
);
2070 /* Print prefix if we printed a newline during the previous call. */
2074 fputs_unfiltered (prefix
, gdb_stdlog
);
2077 prev_prefix
= prefix
;
2078 prev_suffix
= suffix
;
2080 /* Output characters in a printable format. */
2081 while ((ch
= *string
++) != '\0')
2086 if (gdb_isprint (ch
))
2087 fputc_unfiltered (ch
, gdb_stdlog
);
2090 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2094 fputs_unfiltered ("\\\\", gdb_stdlog
);
2097 fputs_unfiltered ("\\b", gdb_stdlog
);
2100 fputs_unfiltered ("\\f", gdb_stdlog
);
2104 fputs_unfiltered ("\\n", gdb_stdlog
);
2107 fputs_unfiltered ("\\r", gdb_stdlog
);
2110 fputs_unfiltered ("\\t", gdb_stdlog
);
2113 fputs_unfiltered ("\\v", gdb_stdlog
);
2117 return_p
= ch
== '\r';
2120 /* Print suffix if we printed a newline. */
2123 fputs_unfiltered (suffix
, gdb_stdlog
);
2124 fputs_unfiltered ("\n", gdb_stdlog
);
2129 /* Print a variable number of ARGS using format FORMAT. If this
2130 information is going to put the amount written (since the last call
2131 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2132 call prompt_for_continue to get the users permission to continue.
2134 Unlike fprintf, this function does not return a value.
2136 We implement three variants, vfprintf (takes a vararg list and stream),
2137 fprintf (takes a stream to write on), and printf (the usual).
2139 Note also that this may throw a quit (since prompt_for_continue may
2143 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2144 va_list args
, bool filter
)
2146 ui_out_flags flags
= disallow_ui_out_field
;
2148 flags
|= unfiltered_output
;
2149 cli_ui_out (stream
, flags
).vmessage (applied_style
, format
, args
);
2154 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2156 vfprintf_maybe_filtered (stream
, format
, args
, true);
2160 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2162 if (debug_timestamp
&& stream
== gdb_stdlog
)
2164 static bool needs_timestamp
= true;
2166 /* Print timestamp if previous print ended with a \n. */
2167 if (needs_timestamp
)
2169 using namespace std::chrono
;
2171 steady_clock::time_point now
= steady_clock::now ();
2172 seconds s
= duration_cast
<seconds
> (now
.time_since_epoch ());
2173 microseconds us
= duration_cast
<microseconds
> (now
.time_since_epoch () - s
);
2174 std::string timestamp
= string_printf ("%ld.%06ld ",
2176 (long) us
.count ());
2177 fputs_unfiltered (timestamp
.c_str (), stream
);
2180 /* Print the message. */
2182 cli_ui_out (&sfile
, 0).vmessage (ui_file_style (), format
, args
);
2183 std::string linebuffer
= std::move (sfile
.string ());
2184 fputs_unfiltered (linebuffer
.c_str (), stream
);
2186 size_t len
= linebuffer
.length ();
2187 needs_timestamp
= (len
> 0 && linebuffer
[len
- 1] == '\n');
2190 vfprintf_maybe_filtered (stream
, format
, args
, false);
2194 vprintf_filtered (const char *format
, va_list args
)
2196 vfprintf_filtered (gdb_stdout
, format
, args
);
2200 vprintf_unfiltered (const char *format
, va_list args
)
2202 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2206 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2210 va_start (args
, format
);
2211 vfprintf_filtered (stream
, format
, args
);
2216 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2220 va_start (args
, format
);
2221 vfprintf_unfiltered (stream
, format
, args
);
2228 fprintf_styled (struct ui_file
*stream
, const ui_file_style
&style
,
2229 const char *format
, ...)
2233 set_output_style (stream
, style
);
2234 va_start (args
, format
);
2235 vfprintf_filtered (stream
, format
, args
);
2237 set_output_style (stream
, ui_file_style ());
2243 vfprintf_styled (struct ui_file
*stream
, const ui_file_style
&style
,
2244 const char *format
, va_list args
)
2246 set_output_style (stream
, style
);
2247 vfprintf_filtered (stream
, format
, args
);
2248 set_output_style (stream
, ui_file_style ());
2254 vfprintf_styled_no_gdbfmt (struct ui_file
*stream
, const ui_file_style
&style
,
2255 bool filter
, const char *format
, va_list args
)
2257 std::string str
= string_vprintf (format
, args
);
2260 set_output_style (stream
, style
);
2261 fputs_maybe_filtered (str
.c_str (), stream
, filter
);
2262 set_output_style (stream
, ui_file_style ());
2267 printf_filtered (const char *format
, ...)
2271 va_start (args
, format
);
2272 vfprintf_filtered (gdb_stdout
, format
, args
);
2278 printf_unfiltered (const char *format
, ...)
2282 va_start (args
, format
);
2283 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2287 /* Easy -- but watch out!
2289 This routine is *not* a replacement for puts()! puts() appends a newline.
2290 This one doesn't, and had better not! */
2293 puts_filtered (const char *string
)
2295 fputs_filtered (string
, gdb_stdout
);
2299 puts_unfiltered (const char *string
)
2301 fputs_unfiltered (string
, gdb_stdout
);
2304 /* Return a pointer to N spaces and a null. The pointer is good
2305 until the next call to here. */
2310 static char *spaces
= 0;
2311 static int max_spaces
= -1;
2316 spaces
= (char *) xmalloc (n
+ 1);
2317 for (t
= spaces
+ n
; t
!= spaces
;)
2323 return spaces
+ max_spaces
- n
;
2326 /* Print N spaces. */
2328 print_spaces_filtered (int n
, struct ui_file
*stream
)
2330 fputs_filtered (n_spaces (n
), stream
);
2333 /* C++/ObjC demangler stuff. */
2335 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2336 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2337 If the name is not mangled, or the language for the name is unknown, or
2338 demangling is off, the name is printed in its "raw" form. */
2341 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2342 enum language lang
, int arg_mode
)
2346 /* If user wants to see raw output, no problem. */
2349 fputs_filtered (name
, stream
);
2353 gdb::unique_xmalloc_ptr
<char> demangled
2354 = language_demangle (language_def (lang
), name
, arg_mode
);
2355 fputs_filtered (demangled
? demangled
.get () : name
, stream
);
2360 /* True if CH is a character that can be part of a symbol name. I.e.,
2361 either a number, a letter, or a '_'. */
2364 valid_identifier_name_char (int ch
)
2366 return (ISALNUM (ch
) || ch
== '_');
2369 /* Skip to end of token, or to END, whatever comes first. Input is
2370 assumed to be a C++ operator name. */
2373 cp_skip_operator_token (const char *token
, const char *end
)
2375 const char *p
= token
;
2376 while (p
!= end
&& !ISSPACE (*p
) && *p
!= '(')
2378 if (valid_identifier_name_char (*p
))
2380 while (p
!= end
&& valid_identifier_name_char (*p
))
2386 /* Note, ordered such that among ops that share a prefix,
2387 longer comes first. This is so that the loop below can
2388 bail on first match. */
2389 static const char *ops
[] =
2395 "-=", "--", "->", "-",
2404 "<<=", "<=", "<<", "<",
2405 ">>=", ">=", ">>", ">",
2409 for (const char *op
: ops
)
2411 size_t oplen
= strlen (op
);
2412 size_t lencmp
= std::min
<size_t> (oplen
, end
- p
);
2414 if (strncmp (p
, op
, lencmp
) == 0)
2417 /* Some unidentified character. Return it. */
2425 /* Advance STRING1/STRING2 past whitespace. */
2428 skip_ws (const char *&string1
, const char *&string2
, const char *end_str2
)
2430 while (ISSPACE (*string1
))
2432 while (string2
< end_str2
&& ISSPACE (*string2
))
2436 /* True if STRING points at the start of a C++ operator name. START
2437 is the start of the string that STRING points to, hence when
2438 reading backwards, we must not read any character before START. */
2441 cp_is_operator (const char *string
, const char *start
)
2443 return ((string
== start
2444 || !valid_identifier_name_char (string
[-1]))
2445 && strncmp (string
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
2446 && !valid_identifier_name_char (string
[CP_OPERATOR_LEN
]));
2449 /* If *NAME points at an ABI tag, skip it and return true. Otherwise
2450 leave *NAME unmodified and return false. (see GCC's abi_tag
2451 attribute), such names are demangled as e.g.,
2452 "function[abi:cxx11]()". */
2455 skip_abi_tag (const char **name
)
2457 const char *p
= *name
;
2459 if (startswith (p
, "[abi:"))
2463 while (valid_identifier_name_char (*p
))
2479 strncmp_iw_with_mode (const char *string1
, const char *string2
,
2480 size_t string2_len
, strncmp_iw_mode mode
,
2481 enum language language
,
2482 completion_match_for_lcd
*match_for_lcd
)
2484 const char *string1_start
= string1
;
2485 const char *end_str2
= string2
+ string2_len
;
2486 bool skip_spaces
= true;
2487 bool have_colon_op
= (language
== language_cplus
2488 || language
== language_rust
2489 || language
== language_fortran
);
2494 || ((ISSPACE (*string1
) && !valid_identifier_name_char (*string2
))
2495 || (ISSPACE (*string2
) && !valid_identifier_name_char (*string1
))))
2497 skip_ws (string1
, string2
, end_str2
);
2498 skip_spaces
= false;
2501 /* Skip [abi:cxx11] tags in the symbol name if the lookup name
2502 doesn't include them. E.g.:
2504 string1: function[abi:cxx1](int)
2507 string1: function[abi:cxx1](int)
2508 string2: function(int)
2510 string1: Struct[abi:cxx1]::function()
2511 string2: Struct::function()
2513 string1: function(Struct[abi:cxx1], int)
2514 string2: function(Struct, int)
2516 if (string2
== end_str2
2517 || (*string2
!= '[' && !valid_identifier_name_char (*string2
)))
2519 const char *abi_start
= string1
;
2521 /* There can be more than one tag. */
2522 while (*string1
== '[' && skip_abi_tag (&string1
))
2525 if (match_for_lcd
!= NULL
&& abi_start
!= string1
)
2526 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2528 while (ISSPACE (*string1
))
2532 if (*string1
== '\0' || string2
== end_str2
)
2535 /* Handle the :: operator. */
2536 if (have_colon_op
&& string1
[0] == ':' && string1
[1] == ':')
2538 if (*string2
!= ':')
2544 if (string2
== end_str2
)
2547 if (*string2
!= ':')
2553 while (ISSPACE (*string1
))
2555 while (string2
< end_str2
&& ISSPACE (*string2
))
2560 /* Handle C++ user-defined operators. */
2561 else if (language
== language_cplus
2564 if (cp_is_operator (string1
, string1_start
))
2566 /* An operator name in STRING1. Check STRING2. */
2568 = std::min
<size_t> (CP_OPERATOR_LEN
, end_str2
- string2
);
2569 if (strncmp (string1
, string2
, cmplen
) != 0)
2575 if (string2
!= end_str2
)
2577 /* Check for "operatorX" in STRING2. */
2578 if (valid_identifier_name_char (*string2
))
2581 skip_ws (string1
, string2
, end_str2
);
2584 /* Handle operator(). */
2585 if (*string1
== '(')
2587 if (string2
== end_str2
)
2589 if (mode
== strncmp_iw_mode::NORMAL
)
2593 /* Don't break for the regular return at the
2594 bottom, because "operator" should not
2595 match "operator()", since this open
2596 parentheses is not the parameter list
2598 return *string1
!= '\0';
2602 if (*string1
!= *string2
)
2611 skip_ws (string1
, string2
, end_str2
);
2613 /* Skip to end of token, or to END, whatever comes
2615 const char *end_str1
= string1
+ strlen (string1
);
2616 const char *p1
= cp_skip_operator_token (string1
, end_str1
);
2617 const char *p2
= cp_skip_operator_token (string2
, end_str2
);
2619 cmplen
= std::min (p1
- string1
, p2
- string2
);
2622 if (strncmp (string1
, string2
, cmplen
) != 0)
2627 if (p1
- string1
!= p2
- string2
)
2629 if (strncmp (string1
, string2
, cmplen
) != 0)
2636 if (*string1
== '\0' || string2
== end_str2
)
2638 if (*string1
== '(' || *string2
== '(')
2646 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2648 if (case_sensitivity
== case_sensitive_off
2649 && (TOLOWER ((unsigned char) *string1
)
2650 != TOLOWER ((unsigned char) *string2
)))
2653 /* If we see any non-whitespace, non-identifier-name character
2654 (any of "()<>*&" etc.), then skip spaces the next time
2656 if (!ISSPACE (*string1
) && !valid_identifier_name_char (*string1
))
2663 if (string2
== end_str2
)
2665 if (mode
== strncmp_iw_mode::NORMAL
)
2667 /* Strip abi tag markers from the matched symbol name.
2668 Usually the ABI marker will be found on function name
2669 (automatically added because the function returns an
2670 object marked with an ABI tag). However, it's also
2671 possible to see a marker in one of the function
2672 parameters, for example.
2674 string2 (lookup name):
2677 function(some_struct[abi:cxx11], int)
2679 and for completion LCD computation we want to say that
2681 function(some_struct, int)
2683 if (match_for_lcd
!= NULL
)
2685 while ((string1
= strstr (string1
, "[abi:")) != NULL
)
2687 const char *abi_start
= string1
;
2689 /* There can be more than one tag. */
2690 while (skip_abi_tag (&string1
) && *string1
== '[')
2693 if (abi_start
!= string1
)
2694 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2701 return (*string1
!= '\0' && *string1
!= '(');
2710 strncmp_iw (const char *string1
, const char *string2
, size_t string2_len
)
2712 return strncmp_iw_with_mode (string1
, string2
, string2_len
,
2713 strncmp_iw_mode::NORMAL
, language_minimal
);
2719 strcmp_iw (const char *string1
, const char *string2
)
2721 return strncmp_iw_with_mode (string1
, string2
, strlen (string2
),
2722 strncmp_iw_mode::MATCH_PARAMS
, language_minimal
);
2725 /* This is like strcmp except that it ignores whitespace and treats
2726 '(' as the first non-NULL character in terms of ordering. Like
2727 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2728 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2729 according to that ordering.
2731 If a list is sorted according to this function and if you want to
2732 find names in the list that match some fixed NAME according to
2733 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2734 where this function would put NAME.
2736 This function must be neutral to the CASE_SENSITIVITY setting as the user
2737 may choose it during later lookup. Therefore this function always sorts
2738 primarily case-insensitively and secondarily case-sensitively.
2740 Here are some examples of why using strcmp to sort is a bad idea:
2744 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2745 we try to do a search for "foo<char*>", strcmp will locate this
2746 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2747 will start looking at strings beginning with "goo", and will never
2748 see the correct match of "foo<char *>".
2750 Parenthesis example:
2752 In practice, this is less like to be an issue, but I'll give it a
2753 shot. Let's assume that '$' is a legitimate character to occur in
2754 symbols. (Which may well even be the case on some systems.) Then
2755 say that the partial symbol table contains "foo$" and "foo(int)".
2756 strcmp will put them in this order, since '$' < '('. Now, if the
2757 user searches for "foo", then strcmp will sort "foo" before "foo$".
2758 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2759 "foo") is false, so it won't proceed to the actual match of
2760 "foo(int)" with "foo". */
2763 strcmp_iw_ordered (const char *string1
, const char *string2
)
2765 const char *saved_string1
= string1
, *saved_string2
= string2
;
2766 enum case_sensitivity case_pass
= case_sensitive_off
;
2770 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2771 Provide stub characters if we are already at the end of one of the
2773 char c1
= 'X', c2
= 'X';
2775 while (*string1
!= '\0' && *string2
!= '\0')
2777 while (ISSPACE (*string1
))
2779 while (ISSPACE (*string2
))
2784 case case_sensitive_off
:
2785 c1
= TOLOWER ((unsigned char) *string1
);
2786 c2
= TOLOWER ((unsigned char) *string2
);
2788 case case_sensitive_on
:
2796 if (*string1
!= '\0')
2805 /* Characters are non-equal unless they're both '\0'; we want to
2806 make sure we get the comparison right according to our
2807 comparison in the cases where one of them is '\0' or '('. */
2809 if (*string2
== '\0')
2814 if (*string2
== '\0')
2819 if (*string2
== '\0' || *string2
== '(')
2828 if (case_pass
== case_sensitive_on
)
2831 /* Otherwise the strings were equal in case insensitive way, make
2832 a more fine grained comparison in a case sensitive way. */
2834 case_pass
= case_sensitive_on
;
2835 string1
= saved_string1
;
2836 string2
= saved_string2
;
2843 streq (const char *lhs
, const char *rhs
)
2845 return !strcmp (lhs
, rhs
);
2852 ** Answer whether string_to_compare is a full or partial match to
2853 ** template_string. The partial match must be in sequence starting
2857 subset_compare (const char *string_to_compare
, const char *template_string
)
2861 if (template_string
!= NULL
&& string_to_compare
!= NULL
2862 && strlen (string_to_compare
) <= strlen (template_string
))
2864 (startswith (template_string
, string_to_compare
));
2871 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2872 struct cmd_list_element
*c
, const char *value
)
2874 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2882 address_significant (gdbarch
*gdbarch
, CORE_ADDR addr
)
2884 /* Clear insignificant bits of a target address and sign extend resulting
2885 address, avoiding shifts larger or equal than the width of a CORE_ADDR.
2886 The local variable ADDR_BIT stops the compiler reporting a shift overflow
2887 when it won't occur. Skip updating of target address if current target
2888 has not set gdbarch significant_addr_bit. */
2889 int addr_bit
= gdbarch_significant_addr_bit (gdbarch
);
2891 if (addr_bit
&& (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
)))
2893 CORE_ADDR sign
= (CORE_ADDR
) 1 << (addr_bit
- 1);
2894 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2895 addr
= (addr
^ sign
) - sign
;
2902 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2904 /* Truncate address to the size of a target address, avoiding shifts
2905 larger or equal than the width of a CORE_ADDR. The local
2906 variable ADDR_BIT stops the compiler reporting a shift overflow
2907 when it won't occur. */
2908 /* NOTE: This assumes that the significant address information is
2909 kept in the least significant bits of ADDR - the upper bits were
2910 either zero or sign extended. Should gdbarch_address_to_pointer or
2911 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2913 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2915 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2916 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2917 return hex_string (addr
);
2920 /* This function is described in "defs.h". */
2923 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2925 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2927 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2928 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2930 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2931 that returns the language localized string formatted to a width
2932 based on gdbarch_addr_bit. */
2934 return hex_string_custom (address
, 8);
2936 return hex_string_custom (address
, 16);
2939 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2942 core_addr_hash (const void *ap
)
2944 const CORE_ADDR
*addrp
= (const CORE_ADDR
*) ap
;
2949 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2952 core_addr_eq (const void *ap
, const void *bp
)
2954 const CORE_ADDR
*addr_ap
= (const CORE_ADDR
*) ap
;
2955 const CORE_ADDR
*addr_bp
= (const CORE_ADDR
*) bp
;
2957 return *addr_ap
== *addr_bp
;
2960 /* Convert a string back into a CORE_ADDR. */
2962 string_to_core_addr (const char *my_string
)
2966 if (my_string
[0] == '0' && TOLOWER (my_string
[1]) == 'x')
2968 /* Assume that it is in hex. */
2971 for (i
= 2; my_string
[i
] != '\0'; i
++)
2973 if (ISDIGIT (my_string
[i
]))
2974 addr
= (my_string
[i
] - '0') + (addr
* 16);
2975 else if (ISXDIGIT (my_string
[i
]))
2976 addr
= (TOLOWER (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2978 error (_("invalid hex \"%s\""), my_string
);
2983 /* Assume that it is in decimal. */
2986 for (i
= 0; my_string
[i
] != '\0'; i
++)
2988 if (ISDIGIT (my_string
[i
]))
2989 addr
= (my_string
[i
] - '0') + (addr
* 10);
2991 error (_("invalid decimal \"%s\""), my_string
);
3001 gdb_realpath_check_trailer (const char *input
, const char *trailer
)
3003 gdb::unique_xmalloc_ptr
<char> result
= gdb_realpath (input
);
3005 size_t len
= strlen (result
.get ());
3006 size_t trail_len
= strlen (trailer
);
3008 SELF_CHECK (len
>= trail_len
3009 && strcmp (result
.get () + len
- trail_len
, trailer
) == 0);
3013 gdb_realpath_tests ()
3015 /* A file which contains a directory prefix. */
3016 gdb_realpath_check_trailer ("./xfullpath.exp", "/xfullpath.exp");
3017 /* A file which contains a directory prefix. */
3018 gdb_realpath_check_trailer ("../../defs.h", "/defs.h");
3019 /* A one-character filename. */
3020 gdb_realpath_check_trailer ("./a", "/a");
3021 /* A file in the root directory. */
3022 gdb_realpath_check_trailer ("/root_file_which_should_exist",
3023 "/root_file_which_should_exist");
3024 /* A file which does not have a directory prefix. */
3025 gdb_realpath_check_trailer ("xfullpath.exp", "xfullpath.exp");
3026 /* A one-char filename without any directory prefix. */
3027 gdb_realpath_check_trailer ("a", "a");
3028 /* An empty filename. */
3029 gdb_realpath_check_trailer ("", "");
3032 /* Test the gdb_argv::as_array_view method. */
3035 gdb_argv_as_array_view_test ()
3040 gdb::array_view
<char *> view
= argv
.as_array_view ();
3042 SELF_CHECK (view
.data () == nullptr);
3043 SELF_CHECK (view
.size () == 0);
3046 gdb_argv
argv ("une bonne 50");
3048 gdb::array_view
<char *> view
= argv
.as_array_view ();
3050 SELF_CHECK (view
.size () == 3);
3051 SELF_CHECK (strcmp (view
[0], "une") == 0);
3052 SELF_CHECK (strcmp (view
[1], "bonne") == 0);
3053 SELF_CHECK (strcmp (view
[2], "50") == 0);
3057 #endif /* GDB_SELF_TEST */
3059 /* Allocation function for the libiberty hash table which uses an
3060 obstack. The obstack is passed as DATA. */
3063 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
3065 size_t total
= size
* count
;
3066 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
3068 memset (ptr
, 0, total
);
3072 /* Trivial deallocation function for the libiberty splay tree and hash
3073 table - don't deallocate anything. Rely on later deletion of the
3074 obstack. DATA will be the obstack, although it is not needed
3078 dummy_obstack_deallocate (void *object
, void *data
)
3083 /* Simple, portable version of dirname that does not modify its
3087 ldirname (const char *filename
)
3089 std::string dirname
;
3090 const char *base
= lbasename (filename
);
3092 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
3095 if (base
== filename
)
3098 dirname
= std::string (filename
, base
- filename
);
3100 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3101 create "d:./bar" later instead of the (different) "d:/bar". */
3102 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3103 && !IS_DIR_SEPARATOR (filename
[0]))
3104 dirname
[base
++ - filename
] = '.';
3112 gdb_argv::reset (const char *s
)
3114 char **argv
= buildargv (s
);
3120 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3121 #define AMBIGUOUS_MESS2 \
3122 ".\nUse \"set gnutarget format-name\" to specify the format."
3125 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3129 /* Check if errmsg just need simple return. */
3130 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3131 return bfd_errmsg (error_tag
);
3133 std::string
ret (bfd_errmsg (error_tag
));
3134 ret
+= AMBIGUOUS_MESS1
;
3136 for (p
= matching
; *p
; p
++)
3141 ret
+= AMBIGUOUS_MESS2
;
3148 /* Return ARGS parsed as a valid pid, or throw an error. */
3151 parse_pid_to_attach (const char *args
)
3157 error_no_arg (_("process-id to attach"));
3159 dummy
= (char *) args
;
3160 pid
= strtoul (args
, &dummy
, 0);
3161 /* Some targets don't set errno on errors, grrr! */
3162 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3163 error (_("Illegal process-id: %s."), args
);
3168 /* Substitute all occurrences of string FROM by string TO in *STRINGP. *STRINGP
3169 must come from xrealloc-compatible allocator and it may be updated. FROM
3170 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3171 located at the start or end of *STRINGP. */
3174 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3176 char *string
= *stringp
, *s
;
3177 const size_t from_len
= strlen (from
);
3178 const size_t to_len
= strlen (to
);
3182 s
= strstr (s
, from
);
3186 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3187 || s
[-1] == DIRNAME_SEPARATOR
)
3188 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3189 || s
[from_len
] == DIRNAME_SEPARATOR
))
3194 = (char *) xrealloc (string
, (strlen (string
) + to_len
+ 1));
3196 /* Relocate the current S pointer. */
3197 s
= s
- string
+ string_new
;
3198 string
= string_new
;
3200 /* Replace from by to. */
3201 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3202 memcpy (s
, to
, to_len
);
3217 /* SIGALRM handler for waitpid_with_timeout. */
3220 sigalrm_handler (int signo
)
3222 /* Nothing to do. */
3227 /* Wrapper to wait for child PID to die with TIMEOUT.
3228 TIMEOUT is the time to stop waiting in seconds.
3229 If TIMEOUT is zero, pass WNOHANG to waitpid.
3230 Returns PID if it was successfully waited for, otherwise -1.
3232 Timeouts are currently implemented with alarm and SIGALRM.
3233 If the host does not support them, this waits "forever".
3234 It would be odd though for a host to have waitpid and not SIGALRM. */
3237 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3239 pid_t waitpid_result
;
3241 gdb_assert (pid
> 0);
3242 gdb_assert (timeout
>= 0);
3247 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3248 struct sigaction sa
, old_sa
;
3250 sa
.sa_handler
= sigalrm_handler
;
3251 sigemptyset (&sa
.sa_mask
);
3253 sigaction (SIGALRM
, &sa
, &old_sa
);
3257 ofunc
= signal (SIGALRM
, sigalrm_handler
);
3263 waitpid_result
= waitpid (pid
, status
, 0);
3267 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3268 sigaction (SIGALRM
, &old_sa
, NULL
);
3270 signal (SIGALRM
, ofunc
);
3275 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3277 if (waitpid_result
== pid
)
3283 #endif /* HAVE_WAITPID */
3285 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3286 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3288 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3289 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3292 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3294 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3296 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3297 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3299 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3301 char *pattern_slash
, *string_slash
;
3303 /* Replace '\' by '/' in both strings. */
3305 pattern_slash
= (char *) alloca (strlen (pattern
) + 1);
3306 strcpy (pattern_slash
, pattern
);
3307 pattern
= pattern_slash
;
3308 for (; *pattern_slash
!= 0; pattern_slash
++)
3309 if (IS_DIR_SEPARATOR (*pattern_slash
))
3310 *pattern_slash
= '/';
3312 string_slash
= (char *) alloca (strlen (string
) + 1);
3313 strcpy (string_slash
, string
);
3314 string
= string_slash
;
3315 for (; *string_slash
!= 0; string_slash
++)
3316 if (IS_DIR_SEPARATOR (*string_slash
))
3317 *string_slash
= '/';
3319 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3321 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3322 flags
|= FNM_CASEFOLD
;
3323 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3325 return fnmatch (pattern
, string
, flags
);
3328 /* Return the number of path elements in PATH.
3336 count_path_elements (const char *path
)
3339 const char *p
= path
;
3341 if (HAS_DRIVE_SPEC (p
))
3343 p
= STRIP_DRIVE_SPEC (p
);
3349 if (IS_DIR_SEPARATOR (*p
))
3354 /* Backup one if last character is /, unless it's the only one. */
3355 if (p
> path
+ 1 && IS_DIR_SEPARATOR (p
[-1]))
3358 /* Add one for the file name, if present. */
3359 if (p
> path
&& !IS_DIR_SEPARATOR (p
[-1]))
3365 /* Remove N leading path elements from PATH.
3366 N must be non-negative.
3367 If PATH has more than N path elements then return NULL.
3368 If PATH has exactly N path elements then return "".
3369 See count_path_elements for a description of how we do the counting. */
3372 strip_leading_path_elements (const char *path
, int n
)
3375 const char *p
= path
;
3377 gdb_assert (n
>= 0);
3382 if (HAS_DRIVE_SPEC (p
))
3384 p
= STRIP_DRIVE_SPEC (p
);
3390 while (*p
!= '\0' && !IS_DIR_SEPARATOR (*p
))
3408 copy_bitwise (gdb_byte
*dest
, ULONGEST dest_offset
,
3409 const gdb_byte
*source
, ULONGEST source_offset
,
3410 ULONGEST nbits
, int bits_big_endian
)
3412 unsigned int buf
, avail
;
3417 if (bits_big_endian
)
3419 /* Start from the end, then work backwards. */
3420 dest_offset
+= nbits
- 1;
3421 dest
+= dest_offset
/ 8;
3422 dest_offset
= 7 - dest_offset
% 8;
3423 source_offset
+= nbits
- 1;
3424 source
+= source_offset
/ 8;
3425 source_offset
= 7 - source_offset
% 8;
3429 dest
+= dest_offset
/ 8;
3431 source
+= source_offset
/ 8;
3435 /* Fill BUF with DEST_OFFSET bits from the destination and 8 -
3436 SOURCE_OFFSET bits from the source. */
3437 buf
= *(bits_big_endian
? source
-- : source
++) >> source_offset
;
3438 buf
<<= dest_offset
;
3439 buf
|= *dest
& ((1 << dest_offset
) - 1);
3441 /* NBITS: bits yet to be written; AVAIL: BUF's fill level. */
3442 nbits
+= dest_offset
;
3443 avail
= dest_offset
+ 8 - source_offset
;
3445 /* Flush 8 bits from BUF, if appropriate. */
3446 if (nbits
>= 8 && avail
>= 8)
3448 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3454 /* Copy the middle part. */
3457 size_t len
= nbits
/ 8;
3459 /* Use a faster method for byte-aligned copies. */
3462 if (bits_big_endian
)
3466 memcpy (dest
+ 1, source
+ 1, len
);
3470 memcpy (dest
, source
, len
);
3479 buf
|= *(bits_big_endian
? source
-- : source
++) << avail
;
3480 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3487 /* Write the last byte. */
3491 buf
|= *source
<< avail
;
3493 buf
&= (1 << nbits
) - 1;
3494 *dest
= (*dest
& (~0U << nbits
)) | buf
;
3498 void _initialize_utils ();
3500 _initialize_utils ()
3502 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
3503 Set number of characters where GDB should wrap lines of its output."), _("\
3504 Show number of characters where GDB should wrap lines of its output."), _("\
3505 This affects where GDB wraps its output to fit the screen width.\n\
3506 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
3508 show_chars_per_line
,
3509 &setlist
, &showlist
);
3511 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
3512 Set number of lines in a page for GDB output pagination."), _("\
3513 Show number of lines in a page for GDB output pagination."), _("\
3514 This affects the number of lines after which GDB will pause\n\
3515 its output and ask you whether to continue.\n\
3516 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
3518 show_lines_per_page
,
3519 &setlist
, &showlist
);
3521 add_setshow_boolean_cmd ("pagination", class_support
,
3522 &pagination_enabled
, _("\
3523 Set state of GDB output pagination."), _("\
3524 Show state of GDB output pagination."), _("\
3525 When pagination is ON, GDB pauses at end of each screenful of\n\
3526 its output and asks you whether to continue.\n\
3527 Turning pagination off is an alternative to \"set height unlimited\"."),
3529 show_pagination_enabled
,
3530 &setlist
, &showlist
);
3532 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
3533 &sevenbit_strings
, _("\
3534 Set printing of 8-bit characters in strings as \\nnn."), _("\
3535 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
3537 show_sevenbit_strings
,
3538 &setprintlist
, &showprintlist
);
3540 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
3541 &debug_timestamp
, _("\
3542 Set timestamping of debugging messages."), _("\
3543 Show timestamping of debugging messages."), _("\
3544 When set, debugging messages will be marked with seconds and microseconds."),
3546 show_debug_timestamp
,
3547 &setdebuglist
, &showdebuglist
);
3549 add_internal_problem_command (&internal_error_problem
);
3550 add_internal_problem_command (&internal_warning_problem
);
3551 add_internal_problem_command (&demangler_warning_problem
);
3554 selftests::register_test ("gdb_realpath", gdb_realpath_tests
);
3555 selftests::register_test ("gdb_argv_array_view", gdb_argv_as_array_view_test
);