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"
79 void (*deprecated_error_begin_hook
) (void);
81 /* Prototypes for local functions */
83 static void vfprintf_maybe_filtered (struct ui_file
*, const char *,
85 ATTRIBUTE_PRINTF (2, 0);
87 static void fputs_maybe_filtered (const char *, struct ui_file
*, int);
89 static void prompt_for_continue (void);
91 static void set_screen_size (void);
92 static void set_width (void);
94 /* Time spent in prompt_for_continue in the currently executing command
95 waiting for user to respond.
96 Initialized in make_command_stats_cleanup.
97 Modified in prompt_for_continue and defaulted_query.
98 Used in report_command_stats. */
100 static std::chrono::steady_clock::duration prompt_for_continue_wait_time
;
102 /* A flag indicating whether to timestamp debugging messages. */
104 static bool debug_timestamp
= false;
106 /* True means that strings with character values >0x7F should be printed
107 as octal escapes. False means just print the value (e.g. it's an
108 international character, and the terminal or window can cope.) */
110 bool sevenbit_strings
= false;
112 show_sevenbit_strings (struct ui_file
*file
, int from_tty
,
113 struct cmd_list_element
*c
, const char *value
)
115 fprintf_filtered (file
, _("Printing of 8-bit characters "
116 "in strings as \\nnn is %s.\n"),
120 /* String to be printed before warning messages, if any. */
122 const char *warning_pre_print
= "\nwarning: ";
124 bool pagination_enabled
= true;
126 show_pagination_enabled (struct ui_file
*file
, int from_tty
,
127 struct cmd_list_element
*c
, const char *value
)
129 fprintf_filtered (file
, _("State of pagination is %s.\n"), value
);
135 /* Print a warning message. The first argument STRING is the warning
136 message, used as an fprintf format string, the second is the
137 va_list of arguments for that string. A warning is unfiltered (not
138 paginated) so that the user does not need to page through each
139 screen full of warnings when there are lots of them. */
142 vwarning (const char *string
, va_list args
)
144 if (deprecated_warning_hook
)
145 (*deprecated_warning_hook
) (string
, args
);
148 gdb::optional
<target_terminal::scoped_restore_terminal_state
> term_state
;
149 if (target_supports_terminal_ours ())
151 term_state
.emplace ();
152 target_terminal::ours_for_output ();
154 if (filtered_printing_initialized ())
155 wrap_here (""); /* Force out any buffered output. */
156 gdb_flush (gdb_stdout
);
157 if (warning_pre_print
)
158 fputs_unfiltered (warning_pre_print
, gdb_stderr
);
159 vfprintf_unfiltered (gdb_stderr
, string
, args
);
160 fprintf_unfiltered (gdb_stderr
, "\n");
164 /* Print an error message and return to command level.
165 The first argument STRING is the error message, used as a fprintf string,
166 and the remaining args are passed as arguments to it. */
169 verror (const char *string
, va_list args
)
171 throw_verror (GENERIC_ERROR
, string
, args
);
175 error_stream (const string_file
&stream
)
177 error (("%s"), stream
.c_str ());
180 /* Emit a message and abort. */
182 static void ATTRIBUTE_NORETURN
183 abort_with_message (const char *msg
)
185 if (current_ui
== NULL
)
188 fputs_unfiltered (msg
, gdb_stderr
);
190 abort (); /* ARI: abort */
193 /* Dump core trying to increase the core soft limit to hard limit first. */
198 #ifdef HAVE_SETRLIMIT
199 struct rlimit rlim
= { (rlim_t
) RLIM_INFINITY
, (rlim_t
) RLIM_INFINITY
};
201 setrlimit (RLIMIT_CORE
, &rlim
);
202 #endif /* HAVE_SETRLIMIT */
204 /* Ensure that the SIGABRT we're about to raise will immediately cause
205 GDB to exit and dump core, we don't want to trigger GDB's printing of
206 a backtrace to the console here. */
207 signal (SIGABRT
, SIG_DFL
);
209 abort (); /* ARI: abort */
212 /* Check whether GDB will be able to dump core using the dump_core
213 function. Returns zero if GDB cannot or should not dump core.
214 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
215 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
218 can_dump_core (enum resource_limit_kind limit_kind
)
220 #ifdef HAVE_GETRLIMIT
223 /* Be quiet and assume we can dump if an error is returned. */
224 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
230 if (rlim
.rlim_cur
== 0)
235 if (rlim
.rlim_max
== 0)
238 #endif /* HAVE_GETRLIMIT */
243 /* Print a warning that we cannot dump core. */
246 warn_cant_dump_core (const char *reason
)
248 fprintf_unfiltered (gdb_stderr
,
249 _("%s\nUnable to dump core, use `ulimit -c"
250 " unlimited' before executing GDB next time.\n"),
254 /* Check whether GDB will be able to dump core using the dump_core
255 function, and print a warning if we cannot. */
258 can_dump_core_warn (enum resource_limit_kind limit_kind
,
261 int core_dump_allowed
= can_dump_core (limit_kind
);
263 if (!core_dump_allowed
)
264 warn_cant_dump_core (reason
);
266 return core_dump_allowed
;
269 /* Allow the user to configure the debugger behavior with respect to
270 what to do when an internal problem is detected. */
272 const char internal_problem_ask
[] = "ask";
273 const char internal_problem_yes
[] = "yes";
274 const char internal_problem_no
[] = "no";
275 static const char *const internal_problem_modes
[] =
277 internal_problem_ask
,
278 internal_problem_yes
,
283 /* Print a message reporting an internal error/warning. Ask the user
284 if they want to continue, dump core, or just exit. Return
285 something to indicate a quit. */
287 struct internal_problem
290 int user_settable_should_quit
;
291 const char *should_quit
;
292 int user_settable_should_dump_core
;
293 const char *should_dump_core
;
296 /* Report a problem, internal to GDB, to the user. Once the problem
297 has been reported, and assuming GDB didn't quit, the caller can
298 either allow execution to resume or throw an error. */
300 static void ATTRIBUTE_PRINTF (4, 0)
301 internal_vproblem (struct internal_problem
*problem
,
302 const char *file
, int line
, const char *fmt
, va_list ap
)
309 /* Don't allow infinite error/warning recursion. */
311 static const char msg
[] = "Recursive internal problem.\n";
320 abort_with_message (msg
);
323 /* Newer GLIBC versions put the warn_unused_result attribute
324 on write, but this is one of those rare cases where
325 ignoring the return value is correct. Casting to (void)
326 does not fix this problem. This is the solution suggested
327 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
328 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
329 abort (); /* ARI: abort */
334 /* Create a string containing the full error/warning message. Need
335 to call query with this full string, as otherwize the reason
336 (error/warning) and question become separated. Format using a
337 style similar to a compiler error message. Include extra detail
338 so that the user knows that they are living on the edge. */
340 std::string msg
= string_vprintf (fmt
, ap
);
341 reason
= string_printf ("%s:%d: %s: %s\n"
342 "A problem internal to GDB has been detected,\n"
343 "further debugging may prove unreliable.",
344 file
, line
, problem
->name
, msg
.c_str ());
347 /* Fall back to abort_with_message if gdb_stderr is not set up. */
348 if (current_ui
== NULL
)
350 fputs (reason
.c_str (), stderr
);
351 abort_with_message ("\n");
354 /* Try to get the message out and at the start of a new line. */
355 gdb::optional
<target_terminal::scoped_restore_terminal_state
> term_state
;
356 if (target_supports_terminal_ours ())
358 term_state
.emplace ();
359 target_terminal::ours_for_output ();
361 if (filtered_printing_initialized ())
364 /* Emit the message unless query will emit it below. */
365 if (problem
->should_quit
!= internal_problem_ask
367 || !filtered_printing_initialized ())
368 fprintf_unfiltered (gdb_stderr
, "%s\n", reason
.c_str ());
370 if (problem
->should_quit
== internal_problem_ask
)
372 /* Default (yes/batch case) is to quit GDB. When in batch mode
373 this lessens the likelihood of GDB going into an infinite
375 if (!confirm
|| !filtered_printing_initialized ())
378 quit_p
= query (_("%s\nQuit this debugging session? "),
381 else if (problem
->should_quit
== internal_problem_yes
)
383 else if (problem
->should_quit
== internal_problem_no
)
386 internal_error (__FILE__
, __LINE__
, _("bad switch"));
388 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr
);
389 if (REPORT_BUGS_TO
[0])
390 fprintf_unfiltered (gdb_stderr
, _(" For instructions, see:\n%s."),
392 fputs_unfiltered ("\n\n", gdb_stderr
);
394 if (problem
->should_dump_core
== internal_problem_ask
)
396 if (!can_dump_core_warn (LIMIT_MAX
, reason
.c_str ()))
398 else if (!filtered_printing_initialized ())
402 /* Default (yes/batch case) is to dump core. This leaves a GDB
403 `dropping' so that it is easier to see that something went
405 dump_core_p
= query (_("%s\nCreate a core file of GDB? "),
409 else if (problem
->should_dump_core
== internal_problem_yes
)
410 dump_core_p
= can_dump_core_warn (LIMIT_MAX
, reason
.c_str ());
411 else if (problem
->should_dump_core
== internal_problem_no
)
414 internal_error (__FILE__
, __LINE__
, _("bad switch"));
427 #ifdef HAVE_WORKING_FORK
437 static struct internal_problem internal_error_problem
= {
438 "internal-error", 1, internal_problem_ask
, 1, internal_problem_ask
442 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
444 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
445 throw_quit (_("Command aborted."));
448 static struct internal_problem internal_warning_problem
= {
449 "internal-warning", 1, internal_problem_ask
, 1, internal_problem_ask
453 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
455 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
458 static struct internal_problem demangler_warning_problem
= {
459 "demangler-warning", 1, internal_problem_ask
, 0, internal_problem_no
463 demangler_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
465 internal_vproblem (&demangler_warning_problem
, file
, line
, fmt
, ap
);
469 demangler_warning (const char *file
, int line
, const char *string
, ...)
473 va_start (ap
, string
);
474 demangler_vwarning (file
, line
, string
, ap
);
478 /* When GDB reports an internal problem (error or warning) it gives
479 the user the opportunity to quit GDB and/or create a core file of
480 the current debug session. This function registers a few commands
481 that make it possible to specify that GDB should always or never
482 quit or create a core file, without asking. The commands look
485 maint set PROBLEM-NAME quit ask|yes|no
486 maint show PROBLEM-NAME quit
487 maint set PROBLEM-NAME corefile ask|yes|no
488 maint show PROBLEM-NAME corefile
490 Where PROBLEM-NAME is currently "internal-error" or
491 "internal-warning". */
494 add_internal_problem_command (struct internal_problem
*problem
)
496 struct cmd_list_element
**set_cmd_list
;
497 struct cmd_list_element
**show_cmd_list
;
501 set_cmd_list
= XNEW (struct cmd_list_element
*);
502 show_cmd_list
= XNEW (struct cmd_list_element
*);
503 *set_cmd_list
= NULL
;
504 *show_cmd_list
= NULL
;
506 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
509 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
512 add_basic_prefix_cmd (problem
->name
, class_maintenance
, set_doc
,
514 0/*allow-unknown*/, &maintenance_set_cmdlist
);
516 add_show_prefix_cmd (problem
->name
, class_maintenance
, show_doc
,
518 0/*allow-unknown*/, &maintenance_show_cmdlist
);
520 if (problem
->user_settable_should_quit
)
522 set_doc
= xstrprintf (_("Set whether GDB should quit "
523 "when an %s is detected."),
525 show_doc
= xstrprintf (_("Show whether GDB will quit "
526 "when an %s is detected."),
528 add_setshow_enum_cmd ("quit", class_maintenance
,
529 internal_problem_modes
,
530 &problem
->should_quit
,
543 if (problem
->user_settable_should_dump_core
)
545 set_doc
= xstrprintf (_("Set whether GDB should create a core "
546 "file of GDB when %s is detected."),
548 show_doc
= xstrprintf (_("Show whether GDB will create a core "
549 "file of GDB when %s is detected."),
551 add_setshow_enum_cmd ("corefile", class_maintenance
,
552 internal_problem_modes
,
553 &problem
->should_dump_core
,
567 /* Return a newly allocated string, containing the PREFIX followed
568 by the system error message for errno (separated by a colon). */
571 perror_string (const char *prefix
)
573 const char *err
= safe_strerror (errno
);
574 return std::string (prefix
) + ": " + err
;
577 /* Print the system error message for errno, and also mention STRING
578 as the file name for which the error was encountered. Use ERRCODE
579 for the thrown exception. Then return to command level. */
582 throw_perror_with_name (enum errors errcode
, const char *string
)
584 std::string combined
= perror_string (string
);
586 /* I understand setting these is a matter of taste. Still, some people
587 may clear errno but not know about bfd_error. Doing this here is not
589 bfd_set_error (bfd_error_no_error
);
592 throw_error (errcode
, _("%s."), combined
.c_str ());
595 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
598 perror_with_name (const char *string
)
600 throw_perror_with_name (GENERIC_ERROR
, string
);
603 /* Same as perror_with_name except that it prints a warning instead
604 of throwing an error. */
607 perror_warning_with_name (const char *string
)
609 std::string combined
= perror_string (string
);
610 warning (_("%s"), combined
.c_str ());
613 /* Print the system error message for ERRCODE, and also mention STRING
614 as the file name for which the error was encountered. */
617 print_sys_errmsg (const char *string
, int errcode
)
619 const char *err
= safe_strerror (errcode
);
620 /* We want anything which was printed on stdout to come out first, before
622 gdb_flush (gdb_stdout
);
623 fprintf_unfiltered (gdb_stderr
, "%s: %s.\n", string
, err
);
626 /* Control C eventually causes this to be called, at a convenient time. */
631 if (sync_quit_force_run
)
633 sync_quit_force_run
= 0;
634 quit_force (NULL
, 0);
638 /* No steenking SIGINT will ever be coming our way when the
639 program is resumed. Don't lie. */
643 /* If there is no terminal switching for this target, then we can't
644 possibly get screwed by the lack of job control. */
645 || !target_supports_terminal_ours ())
648 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
657 if (sync_quit_force_run
)
664 /* Called when a memory allocation fails, with the number of bytes of
665 memory requested in SIZE. */
668 malloc_failure (long size
)
672 internal_error (__FILE__
, __LINE__
,
673 _("virtual memory exhausted: can't allocate %ld bytes."),
678 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
682 /* See common/errors.h. */
687 gdb_stdout
->flush ();
688 gdb_stderr
->flush ();
691 /* My replacement for the read system call.
692 Used like `read' but keeps going if `read' returns too soon. */
695 myread (int desc
, char *addr
, int len
)
702 val
= read (desc
, addr
, len
);
716 uinteger_pow (ULONGEST v1
, LONGEST v2
)
721 error (_("Attempt to raise 0 to negative power."));
727 /* The Russian Peasant's Algorithm. */
744 print_spaces (int n
, struct ui_file
*file
)
746 fputs_unfiltered (n_spaces (n
), file
);
749 /* Print a host address. */
752 gdb_print_host_address_1 (const void *addr
, struct ui_file
*stream
)
754 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
759 /* An RAII class that sets up to handle input and then tears down
760 during destruction. */
762 class scoped_input_handler
766 scoped_input_handler ()
767 : m_quit_handler (&quit_handler
, default_quit_handler
),
770 target_terminal::ours ();
771 ui_register_input_event_handler (current_ui
);
772 if (current_ui
->prompt_state
== PROMPT_BLOCKED
)
776 ~scoped_input_handler ()
779 ui_unregister_input_event_handler (m_ui
);
782 DISABLE_COPY_AND_ASSIGN (scoped_input_handler
);
786 /* Save and restore the terminal state. */
787 target_terminal::scoped_restore_terminal_state m_term_state
;
789 /* Save and restore the quit handler. */
790 scoped_restore_tmpl
<quit_handler_ftype
*> m_quit_handler
;
792 /* The saved UI, if non-NULL. */
798 /* This function supports the query, nquery, and yquery functions.
799 Ask user a y-or-n question and return 0 if answer is no, 1 if
800 answer is yes, or default the answer to the specified default
801 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
802 default answer, or '\0' for no default.
803 CTLSTR is the control string and should end in "? ". It should
804 not say how to answer, because we do that.
805 ARGS are the arguments passed along with the CTLSTR argument to
808 static int ATTRIBUTE_PRINTF (1, 0)
809 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
813 char def_answer
, not_def_answer
;
814 const char *y_string
, *n_string
;
816 /* Set up according to which answer is the default. */
821 not_def_answer
= 'N';
825 else if (defchar
== 'y')
829 not_def_answer
= 'N';
837 not_def_answer
= 'Y';
842 /* Automatically answer the default value if the user did not want
843 prompts or the command was issued with the server prefix. */
844 if (!confirm
|| server_command
)
847 /* If input isn't coming from the user directly, just say what
848 question we're asking, and then answer the default automatically. This
849 way, important error messages don't get lost when talking to GDB
851 if (current_ui
->instream
!= current_ui
->stdin_stream
852 || !input_interactive_p (current_ui
)
853 /* Restrict queries to the main UI. */
854 || current_ui
!= main_ui
)
856 target_terminal::scoped_restore_terminal_state term_state
;
857 target_terminal::ours_for_output ();
859 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
861 printf_filtered (_("(%s or %s) [answered %c; "
862 "input not from terminal]\n"),
863 y_string
, n_string
, def_answer
);
868 if (deprecated_query_hook
)
870 target_terminal::scoped_restore_terminal_state term_state
;
871 return deprecated_query_hook (ctlstr
, args
);
874 /* Format the question outside of the loop, to avoid reusing args. */
875 std::string question
= string_vprintf (ctlstr
, args
);
877 = string_printf (_("%s%s(%s or %s) %s"),
878 annotation_level
> 1 ? "\n\032\032pre-query\n" : "",
879 question
.c_str (), y_string
, n_string
,
880 annotation_level
> 1 ? "\n\032\032query\n" : "");
882 /* Used to add duration we waited for user to respond to
883 prompt_for_continue_wait_time. */
884 using namespace std::chrono
;
885 steady_clock::time_point prompt_started
= steady_clock::now ();
887 scoped_input_handler prepare_input
;
891 char *response
, answer
;
893 gdb_flush (gdb_stdout
);
894 response
= gdb_readline_wrapper (prompt
.c_str ());
896 if (response
== NULL
) /* C-d */
898 printf_filtered ("EOF [assumed %c]\n", def_answer
);
903 answer
= response
[0];
908 /* Check answer. For the non-default, the user must specify
909 the non-default explicitly. */
910 if (answer
== not_def_answer
)
915 /* Otherwise, if a default was specified, the user may either
916 specify the required input or have it default by entering
918 if (answer
== def_answer
919 || (defchar
!= '\0' && answer
== '\0'))
924 /* Invalid entries are not defaulted and require another selection. */
925 printf_filtered (_("Please answer %s or %s.\n"),
929 /* Add time spend in this routine to prompt_for_continue_wait_time. */
930 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
932 if (annotation_level
> 1)
933 printf_filtered (("\n\032\032post-query\n"));
938 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
939 answer is yes, or 0 if answer is defaulted.
940 Takes three args which are given to printf to print the question.
941 The first, a control string, should end in "? ".
942 It should not say how to answer, because we do that. */
945 nquery (const char *ctlstr
, ...)
950 va_start (args
, ctlstr
);
951 ret
= defaulted_query (ctlstr
, 'n', args
);
956 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
957 answer is yes, or 1 if answer is defaulted.
958 Takes three args which are given to printf to print the question.
959 The first, a control string, should end in "? ".
960 It should not say how to answer, because we do that. */
963 yquery (const char *ctlstr
, ...)
968 va_start (args
, ctlstr
);
969 ret
= defaulted_query (ctlstr
, 'y', args
);
974 /* Ask user a y-or-n question and return 1 iff answer is yes.
975 Takes three args which are given to printf to print the question.
976 The first, a control string, should end in "? ".
977 It should not say how to answer, because we do that. */
980 query (const char *ctlstr
, ...)
985 va_start (args
, ctlstr
);
986 ret
= defaulted_query (ctlstr
, '\0', args
);
991 /* A helper for parse_escape that converts a host character to a
992 target character. C is the host character. If conversion is
993 possible, then the target character is stored in *TARGET_C and the
994 function returns 1. Otherwise, the function returns 0. */
997 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1002 auto_obstack host_data
;
1004 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1005 (gdb_byte
*) &the_char
, 1, 1,
1006 &host_data
, translit_none
);
1008 if (obstack_object_size (&host_data
) == 1)
1011 *target_c
= *(char *) obstack_base (&host_data
);
1017 /* Parse a C escape sequence. STRING_PTR points to a variable
1018 containing a pointer to the string to parse. That pointer
1019 should point to the character after the \. That pointer
1020 is updated past the characters we use. The value of the
1021 escape sequence is returned.
1023 A negative value means the sequence \ newline was seen,
1024 which is supposed to be equivalent to nothing at all.
1026 If \ is followed by a null character, we return a negative
1027 value and leave the string pointer pointing at the null character.
1029 If \ is followed by 000, we return 0 and leave the string pointer
1030 after the zeros. A value of 0 does not mean end of string. */
1033 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1035 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1036 int c
= *(*string_ptr
)++;
1055 int i
= host_hex_value (c
);
1060 if (ISDIGIT (c
) && c
!= '8' && c
!= '9')
1064 i
+= host_hex_value (c
);
1100 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1101 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1102 " which has no equivalent\nin the `%s' character set."),
1103 c
, c
, target_charset (gdbarch
));
1107 /* Print the character C on STREAM as part of the contents of a literal
1108 string whose delimiter is QUOTER. Note that this routine should only
1109 be called for printing things which are independent of the language
1110 of the program being debugged.
1112 printchar will normally escape backslashes and instances of QUOTER. If
1113 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1114 As a side effect, if you pass the backslash character as the QUOTER,
1115 printchar will escape backslashes as usual, but not any other quoting
1119 printchar (int c
, do_fputc_ftype do_fputc
, ui_file
*stream
, int quoter
)
1121 c
&= 0xFF; /* Avoid sign bit follies */
1123 if (c
< 0x20 || /* Low control chars */
1124 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1125 (sevenbit_strings
&& c
>= 0x80))
1126 { /* high order bit set */
1127 do_fputc ('\\', stream
);
1132 do_fputc ('n', stream
);
1135 do_fputc ('b', stream
);
1138 do_fputc ('t', stream
);
1141 do_fputc ('f', stream
);
1144 do_fputc ('r', stream
);
1147 do_fputc ('e', stream
);
1150 do_fputc ('a', stream
);
1154 do_fputc ('0' + ((c
>> 6) & 0x7), stream
);
1155 do_fputc ('0' + ((c
>> 3) & 0x7), stream
);
1156 do_fputc ('0' + ((c
>> 0) & 0x7), stream
);
1163 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1164 do_fputc ('\\', stream
);
1165 do_fputc (c
, stream
);
1169 /* Print the character C on STREAM as part of the contents of a
1170 literal string whose delimiter is QUOTER. Note that these routines
1171 should only be call for printing things which are independent of
1172 the language of the program being debugged. */
1175 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1178 printchar (*str
++, fputc_filtered
, stream
, quoter
);
1182 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1185 printchar (*str
++, fputc_unfiltered
, stream
, quoter
);
1189 fputstrn_filtered (const char *str
, int n
, int quoter
,
1190 struct ui_file
*stream
)
1192 for (int i
= 0; i
< n
; i
++)
1193 printchar (str
[i
], fputc_filtered
, stream
, quoter
);
1197 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1198 do_fputc_ftype do_fputc
, struct ui_file
*stream
)
1200 for (int i
= 0; i
< n
; i
++)
1201 printchar (str
[i
], do_fputc
, stream
, quoter
);
1205 /* Number of lines per page or UINT_MAX if paging is disabled. */
1206 static unsigned int lines_per_page
;
1208 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1209 struct cmd_list_element
*c
, const char *value
)
1211 fprintf_filtered (file
,
1212 _("Number of lines gdb thinks are in a page is %s.\n"),
1216 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1217 static unsigned int chars_per_line
;
1219 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1220 struct cmd_list_element
*c
, const char *value
)
1222 fprintf_filtered (file
,
1223 _("Number of characters gdb thinks "
1224 "are in a line is %s.\n"),
1228 /* Current count of lines printed on this page, chars on this line. */
1229 static unsigned int lines_printed
, chars_printed
;
1231 /* True if pagination is disabled for just one command. */
1233 static bool pagination_disabled_for_command
;
1235 /* Buffer and start column of buffered text, for doing smarter word-
1236 wrapping. When someone calls wrap_here(), we start buffering output
1237 that comes through fputs_filtered(). If we see a newline, we just
1238 spit it out and forget about the wrap_here(). If we see another
1239 wrap_here(), we spit it out and remember the newer one. If we see
1240 the end of the line, we spit out a newline, the indent, and then
1241 the buffered output. */
1243 static bool filter_initialized
= false;
1245 /* Contains characters which are waiting to be output (they have
1246 already been counted in chars_printed). */
1247 static std::string wrap_buffer
;
1249 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1251 static const char *wrap_indent
;
1253 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1254 is not in effect. */
1255 static int wrap_column
;
1257 /* The style applied at the time that wrap_here was called. */
1258 static ui_file_style wrap_style
;
1261 /* Initialize the number of lines per page and chars per line. */
1264 init_page_info (void)
1268 lines_per_page
= UINT_MAX
;
1269 chars_per_line
= UINT_MAX
;
1273 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1278 #if defined(__GO32__)
1279 rows
= ScreenRows ();
1280 cols
= ScreenCols ();
1281 lines_per_page
= rows
;
1282 chars_per_line
= cols
;
1284 /* Make sure Readline has initialized its terminal settings. */
1285 rl_reset_terminal (NULL
);
1287 /* Get the screen size from Readline. */
1288 rl_get_screen_size (&rows
, &cols
);
1289 lines_per_page
= rows
;
1290 chars_per_line
= cols
;
1292 /* Readline should have fetched the termcap entry for us.
1293 Only try to use tgetnum function if rl_get_screen_size
1294 did not return a useful value. */
1295 if (((rows
<= 0) && (tgetnum ((char *) "li") < 0))
1296 /* Also disable paging if inside Emacs. $EMACS was used
1297 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1298 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1300 /* The number of lines per page is not mentioned in the terminal
1301 description or EMACS environment variable is set. This probably
1302 means that paging is not useful, so disable paging. */
1303 lines_per_page
= UINT_MAX
;
1306 /* If the output is not a terminal, don't paginate it. */
1307 if (!gdb_stdout
->isatty ())
1308 lines_per_page
= UINT_MAX
;
1312 /* We handle SIGWINCH ourselves. */
1313 rl_catch_sigwinch
= 0;
1319 /* Return nonzero if filtered printing is initialized. */
1321 filtered_printing_initialized (void)
1323 return filter_initialized
;
1326 set_batch_flag_and_restore_page_info::set_batch_flag_and_restore_page_info ()
1327 : m_save_lines_per_page (lines_per_page
),
1328 m_save_chars_per_line (chars_per_line
),
1329 m_save_batch_flag (batch_flag
)
1335 set_batch_flag_and_restore_page_info::~set_batch_flag_and_restore_page_info ()
1337 batch_flag
= m_save_batch_flag
;
1338 chars_per_line
= m_save_chars_per_line
;
1339 lines_per_page
= m_save_lines_per_page
;
1345 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1348 set_screen_size (void)
1350 int rows
= lines_per_page
;
1351 int cols
= chars_per_line
;
1353 /* If we get 0 or negative ROWS or COLS, treat as "infinite" size.
1354 A negative number can be seen here with the "set width/height"
1355 commands and either:
1357 - the user specified "unlimited", which maps to UINT_MAX, or
1358 - the user specified some number between INT_MAX and UINT_MAX.
1360 Cap "infinity" to approximately sqrt(INT_MAX) so that we don't
1361 overflow in rl_set_screen_size, which multiplies rows and columns
1362 to compute the number of characters on the screen. */
1364 const int sqrt_int_max
= INT_MAX
>> (sizeof (int) * 8 / 2);
1366 if (rows
<= 0 || rows
> sqrt_int_max
)
1368 rows
= sqrt_int_max
;
1369 lines_per_page
= UINT_MAX
;
1372 if (cols
<= 0 || cols
> sqrt_int_max
)
1374 cols
= sqrt_int_max
;
1375 chars_per_line
= UINT_MAX
;
1378 /* Update Readline's idea of the terminal size. */
1379 rl_set_screen_size (rows
, cols
);
1382 /* Reinitialize WRAP_BUFFER. */
1387 if (chars_per_line
== 0)
1390 wrap_buffer
.clear ();
1391 filter_initialized
= true;
1395 set_width_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1402 set_height_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1410 set_screen_width_and_height (int width
, int height
)
1412 lines_per_page
= height
;
1413 chars_per_line
= width
;
1419 /* The currently applied style. */
1421 static ui_file_style applied_style
;
1423 /* Emit an ANSI style escape for STYLE. If STREAM is nullptr, emit to
1424 the wrap buffer; otherwise emit to STREAM. */
1427 emit_style_escape (const ui_file_style
&style
,
1428 struct ui_file
*stream
= nullptr)
1430 if (applied_style
!= style
)
1432 applied_style
= style
;
1434 if (stream
== nullptr)
1435 wrap_buffer
.append (style
.to_ansi ());
1437 stream
->puts (style
.to_ansi ().c_str ());
1441 /* Set the current output style. This will affect future uses of the
1442 _filtered output functions. */
1445 set_output_style (struct ui_file
*stream
, const ui_file_style
&style
)
1447 if (!stream
->can_emit_style_escape ())
1450 /* Note that we may not pass STREAM here, when we want to emit to
1451 the wrap buffer, not directly to STREAM. */
1452 if (stream
== gdb_stdout
)
1454 emit_style_escape (style
, stream
);
1460 reset_terminal_style (struct ui_file
*stream
)
1462 if (stream
->can_emit_style_escape ())
1464 /* Force the setting, regardless of what we think the setting
1465 might already be. */
1466 applied_style
= ui_file_style ();
1467 wrap_buffer
.append (applied_style
.to_ansi ());
1471 /* Wait, so the user can read what's on the screen. Prompt the user
1472 to continue by pressing RETURN. 'q' is also provided because
1473 telling users what to do in the prompt is more user-friendly than
1474 expecting them to think of Ctrl-C/SIGINT. */
1477 prompt_for_continue (void)
1479 char cont_prompt
[120];
1480 /* Used to add duration we waited for user to respond to
1481 prompt_for_continue_wait_time. */
1482 using namespace std::chrono
;
1483 steady_clock::time_point prompt_started
= steady_clock::now ();
1484 bool disable_pagination
= pagination_disabled_for_command
;
1486 /* Clear the current styling. */
1487 if (gdb_stdout
->can_emit_style_escape ())
1488 emit_style_escape (ui_file_style (), gdb_stdout
);
1490 if (annotation_level
> 1)
1491 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1493 strcpy (cont_prompt
,
1494 "--Type <RET> for more, q to quit, "
1495 "c to continue without paging--");
1496 if (annotation_level
> 1)
1497 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1499 /* We must do this *before* we call gdb_readline_wrapper, else it
1500 will eventually call us -- thinking that we're trying to print
1501 beyond the end of the screen. */
1502 reinitialize_more_filter ();
1504 scoped_input_handler prepare_input
;
1506 /* Call gdb_readline_wrapper, not readline, in order to keep an
1507 event loop running. */
1508 gdb::unique_xmalloc_ptr
<char> ignore (gdb_readline_wrapper (cont_prompt
));
1510 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1511 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1513 if (annotation_level
> 1)
1514 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1518 char *p
= ignore
.get ();
1520 while (*p
== ' ' || *p
== '\t')
1523 /* Do not call quit here; there is no possibility of SIGINT. */
1524 throw_quit ("Quit");
1526 disable_pagination
= true;
1529 /* Now we have to do this again, so that GDB will know that it doesn't
1530 need to save the ---Type <return>--- line at the top of the screen. */
1531 reinitialize_more_filter ();
1532 pagination_disabled_for_command
= disable_pagination
;
1534 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1537 /* Initialize timer to keep track of how long we waited for the user. */
1540 reset_prompt_for_continue_wait_time (void)
1542 using namespace std::chrono
;
1544 prompt_for_continue_wait_time
= steady_clock::duration::zero ();
1547 /* Fetch the cumulative time spent in prompt_for_continue. */
1549 std::chrono::steady_clock::duration
1550 get_prompt_for_continue_wait_time ()
1552 return prompt_for_continue_wait_time
;
1555 /* Reinitialize filter; ie. tell it to reset to original values. */
1558 reinitialize_more_filter (void)
1562 pagination_disabled_for_command
= false;
1565 /* Flush the wrap buffer to STREAM, if necessary. */
1568 flush_wrap_buffer (struct ui_file
*stream
)
1570 if (stream
== gdb_stdout
&& !wrap_buffer
.empty ())
1572 stream
->puts (wrap_buffer
.c_str ());
1573 wrap_buffer
.clear ();
1580 gdb_flush (struct ui_file
*stream
)
1582 flush_wrap_buffer (stream
);
1589 get_chars_per_line ()
1591 return chars_per_line
;
1594 /* Indicate that if the next sequence of characters overflows the line,
1595 a newline should be inserted here rather than when it hits the end.
1596 If INDENT is non-null, it is a string to be printed to indent the
1597 wrapped part on the next line. INDENT must remain accessible until
1598 the next call to wrap_here() or until a newline is printed through
1601 If the line is already overfull, we immediately print a newline and
1602 the indentation, and disable further wrapping.
1604 If we don't know the width of lines, but we know the page height,
1605 we must not wrap words, but should still keep track of newlines
1606 that were explicitly printed.
1608 INDENT should not contain tabs, as that will mess up the char count
1609 on the next line. FIXME.
1611 This routine is guaranteed to force out any output which has been
1612 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1613 used to force out output from the wrap_buffer. */
1616 wrap_here (const char *indent
)
1618 /* This should have been allocated, but be paranoid anyway. */
1619 gdb_assert (filter_initialized
);
1621 flush_wrap_buffer (gdb_stdout
);
1622 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1626 else if (chars_printed
>= chars_per_line
)
1628 puts_filtered ("\n");
1630 puts_filtered (indent
);
1635 wrap_column
= chars_printed
;
1639 wrap_indent
= indent
;
1640 wrap_style
= applied_style
;
1644 /* Print input string to gdb_stdout, filtered, with wrap,
1645 arranging strings in columns of n chars. String can be
1646 right or left justified in the column. Never prints
1647 trailing spaces. String should never be longer than
1648 width. FIXME: this could be useful for the EXAMINE
1649 command, which currently doesn't tabulate very well. */
1652 puts_filtered_tabular (char *string
, int width
, int right
)
1658 gdb_assert (chars_per_line
> 0);
1659 if (chars_per_line
== UINT_MAX
)
1661 fputs_filtered (string
, gdb_stdout
);
1662 fputs_filtered ("\n", gdb_stdout
);
1666 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1667 fputs_filtered ("\n", gdb_stdout
);
1669 if (width
>= chars_per_line
)
1670 width
= chars_per_line
- 1;
1672 stringlen
= strlen (string
);
1674 if (chars_printed
> 0)
1675 spaces
= width
- (chars_printed
- 1) % width
- 1;
1677 spaces
+= width
- stringlen
;
1679 spacebuf
= (char *) alloca (spaces
+ 1);
1680 spacebuf
[spaces
] = '\0';
1682 spacebuf
[spaces
] = ' ';
1684 fputs_filtered (spacebuf
, gdb_stdout
);
1685 fputs_filtered (string
, gdb_stdout
);
1689 /* Ensure that whatever gets printed next, using the filtered output
1690 commands, starts at the beginning of the line. I.e. if there is
1691 any pending output for the current line, flush it and start a new
1692 line. Otherwise do nothing. */
1697 if (chars_printed
> 0)
1699 puts_filtered ("\n");
1704 /* Like fputs but if FILTER is true, pause after every screenful.
1706 Regardless of FILTER can wrap at points other than the final
1707 character of a line.
1709 Unlike fputs, fputs_maybe_filtered does not return a value.
1710 It is OK for LINEBUFFER to be NULL, in which case just don't print
1713 Note that a longjmp to top level may occur in this routine (only if
1714 FILTER is true) (since prompt_for_continue may do so) so this
1715 routine should not be called when cleanups are not in place. */
1718 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1721 const char *lineptr
;
1723 if (linebuffer
== 0)
1726 /* Don't do any filtering if it is disabled. */
1727 if (stream
!= gdb_stdout
1728 || !pagination_enabled
1729 || pagination_disabled_for_command
1731 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
1732 || top_level_interpreter () == NULL
1733 || top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
1735 flush_wrap_buffer (stream
);
1736 stream
->puts (linebuffer
);
1741 = make_scope_exit ([&] ()
1743 wrap_buffer
.clear ();
1748 /* Go through and output each character. Show line extension
1749 when this is necessary; prompt user for new page when this is
1752 lineptr
= linebuffer
;
1755 /* Possible new page. Note that PAGINATION_DISABLED_FOR_COMMAND
1756 might be set during this loop, so we must continue to check
1758 if (filter
&& (lines_printed
>= lines_per_page
- 1)
1759 && !pagination_disabled_for_command
)
1760 prompt_for_continue ();
1762 while (*lineptr
&& *lineptr
!= '\n')
1766 /* Print a single line. */
1767 if (*lineptr
== '\t')
1769 wrap_buffer
.push_back ('\t');
1770 /* Shifting right by 3 produces the number of tab stops
1771 we have already passed, and then adding one and
1772 shifting left 3 advances to the next tab stop. */
1773 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
1776 else if (*lineptr
== '\033'
1777 && skip_ansi_escape (lineptr
, &skip_bytes
))
1779 wrap_buffer
.append (lineptr
, skip_bytes
);
1780 /* Note that we don't consider this a character, so we
1781 don't increment chars_printed here. */
1782 lineptr
+= skip_bytes
;
1784 else if (*lineptr
== '\r')
1786 wrap_buffer
.push_back (*lineptr
);
1792 wrap_buffer
.push_back (*lineptr
);
1797 if (chars_printed
>= chars_per_line
)
1799 unsigned int save_chars
= chars_printed
;
1801 /* If we change the style, below, we'll want to reset it
1802 before continuing to print. If there is no wrap
1803 column, then we'll only reset the style if the pager
1804 prompt is given; and to avoid emitting style
1805 sequences in the middle of a run of text, we track
1807 ui_file_style save_style
= applied_style
;
1808 bool did_paginate
= false;
1814 /* We are about to insert a newline at an historic
1815 location in the WRAP_BUFFER. Before we do we want to
1816 restore the default style. To know if we actually
1817 need to insert an escape sequence we must restore the
1818 current applied style to how it was at the WRAP_COLUMN
1820 applied_style
= wrap_style
;
1821 if (stream
->can_emit_style_escape ())
1822 emit_style_escape (ui_file_style (), stream
);
1823 /* If we aren't actually wrapping, don't output
1824 newline -- if chars_per_line is right, we
1825 probably just overflowed anyway; if it's wrong,
1826 let us keep going. */
1827 /* XXX: The ideal thing would be to call
1828 'stream->putc' here, but we can't because it
1829 currently calls 'fputc_unfiltered', which ends up
1830 calling us, which generates an infinite
1832 stream
->puts ("\n");
1835 flush_wrap_buffer (stream
);
1837 /* Possible new page. Note that
1838 PAGINATION_DISABLED_FOR_COMMAND might be set during
1839 this loop, so we must continue to check it here. */
1840 if (lines_printed
>= lines_per_page
- 1
1841 && !pagination_disabled_for_command
)
1843 prompt_for_continue ();
1844 did_paginate
= true;
1847 /* Now output indentation and wrapped string. */
1850 stream
->puts (wrap_indent
);
1852 /* Having finished inserting the wrapping we should
1853 restore the style as it was at the WRAP_COLUMN. */
1854 if (stream
->can_emit_style_escape ())
1855 emit_style_escape (wrap_style
, stream
);
1857 /* The WRAP_BUFFER will still contain content, and that
1858 content might set some alternative style. Restore
1859 APPLIED_STYLE as it was before we started wrapping,
1860 this reflects the current style for the last character
1862 applied_style
= save_style
;
1864 /* FIXME, this strlen is what prevents wrap_indent from
1865 containing tabs. However, if we recurse to print it
1866 and count its chars, we risk trouble if wrap_indent is
1867 longer than (the user settable) chars_per_line.
1868 Note also that this can set chars_printed > chars_per_line
1869 if we are printing a long string. */
1870 chars_printed
= strlen (wrap_indent
)
1871 + (save_chars
- wrap_column
);
1872 wrap_column
= 0; /* And disable fancy wrap */
1874 else if (did_paginate
&& stream
->can_emit_style_escape ())
1875 emit_style_escape (save_style
, stream
);
1879 if (*lineptr
== '\n')
1882 wrap_here ((char *) 0); /* Spit out chars, cancel
1885 /* XXX: The ideal thing would be to call
1886 'stream->putc' here, but we can't because it
1887 currently calls 'fputc_unfiltered', which ends up
1888 calling us, which generates an infinite
1890 stream
->puts ("\n");
1895 buffer_clearer
.release ();
1899 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
1901 fputs_maybe_filtered (linebuffer
, stream
, 1);
1905 fputs_unfiltered (const char *linebuffer
, struct ui_file
*stream
)
1907 fputs_maybe_filtered (linebuffer
, stream
, 0);
1913 fputs_styled (const char *linebuffer
, const ui_file_style
&style
,
1914 struct ui_file
*stream
)
1916 set_output_style (stream
, style
);
1917 fputs_maybe_filtered (linebuffer
, stream
, 1);
1918 set_output_style (stream
, ui_file_style ());
1924 fputs_styled_unfiltered (const char *linebuffer
, const ui_file_style
&style
,
1925 struct ui_file
*stream
)
1927 set_output_style (stream
, style
);
1928 fputs_maybe_filtered (linebuffer
, stream
, 0);
1929 set_output_style (stream
, ui_file_style ());
1935 fputs_highlighted (const char *str
, const compiled_regex
&highlight
,
1936 struct ui_file
*stream
)
1940 while (*str
&& highlight
.exec (str
, 1, &pmatch
, 0) == 0)
1942 size_t n_highlight
= pmatch
.rm_eo
- pmatch
.rm_so
;
1944 /* Output the part before pmatch with current style. */
1945 while (pmatch
.rm_so
> 0)
1947 fputc_filtered (*str
, stream
);
1952 /* Output pmatch with the highlight style. */
1953 set_output_style (stream
, highlight_style
.style ());
1954 while (n_highlight
> 0)
1956 fputc_filtered (*str
, stream
);
1960 set_output_style (stream
, ui_file_style ());
1963 /* Output the trailing part of STR not matching HIGHLIGHT. */
1965 fputs_filtered (str
, stream
);
1969 putchar_unfiltered (int c
)
1971 return fputc_unfiltered (c
, gdb_stdout
);
1974 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
1975 May return nonlocally. */
1978 putchar_filtered (int c
)
1980 return fputc_filtered (c
, gdb_stdout
);
1984 fputc_unfiltered (int c
, struct ui_file
*stream
)
1990 fputs_unfiltered (buf
, stream
);
1995 fputc_filtered (int c
, struct ui_file
*stream
)
2001 fputs_filtered (buf
, stream
);
2005 /* puts_debug is like fputs_unfiltered, except it prints special
2006 characters in printable fashion. */
2009 puts_debug (char *prefix
, char *string
, char *suffix
)
2013 /* Print prefix and suffix after each line. */
2014 static int new_line
= 1;
2015 static int return_p
= 0;
2016 static const char *prev_prefix
= "";
2017 static const char *prev_suffix
= "";
2019 if (*string
== '\n')
2022 /* If the prefix is changing, print the previous suffix, a new line,
2023 and the new prefix. */
2024 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
2026 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
2027 fputs_unfiltered ("\n", gdb_stdlog
);
2028 fputs_unfiltered (prefix
, gdb_stdlog
);
2031 /* Print prefix if we printed a newline during the previous call. */
2035 fputs_unfiltered (prefix
, gdb_stdlog
);
2038 prev_prefix
= prefix
;
2039 prev_suffix
= suffix
;
2041 /* Output characters in a printable format. */
2042 while ((ch
= *string
++) != '\0')
2047 if (gdb_isprint (ch
))
2048 fputc_unfiltered (ch
, gdb_stdlog
);
2051 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2055 fputs_unfiltered ("\\\\", gdb_stdlog
);
2058 fputs_unfiltered ("\\b", gdb_stdlog
);
2061 fputs_unfiltered ("\\f", gdb_stdlog
);
2065 fputs_unfiltered ("\\n", gdb_stdlog
);
2068 fputs_unfiltered ("\\r", gdb_stdlog
);
2071 fputs_unfiltered ("\\t", gdb_stdlog
);
2074 fputs_unfiltered ("\\v", gdb_stdlog
);
2078 return_p
= ch
== '\r';
2081 /* Print suffix if we printed a newline. */
2084 fputs_unfiltered (suffix
, gdb_stdlog
);
2085 fputs_unfiltered ("\n", gdb_stdlog
);
2090 /* Print a variable number of ARGS using format FORMAT. If this
2091 information is going to put the amount written (since the last call
2092 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2093 call prompt_for_continue to get the users permission to continue.
2095 Unlike fprintf, this function does not return a value.
2097 We implement three variants, vfprintf (takes a vararg list and stream),
2098 fprintf (takes a stream to write on), and printf (the usual).
2100 Note also that this may throw a quit (since prompt_for_continue may
2104 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2105 va_list args
, bool filter
, bool gdbfmt
)
2109 ui_out_flags flags
= disallow_ui_out_field
;
2111 flags
|= unfiltered_output
;
2112 cli_ui_out (stream
, flags
).vmessage (applied_style
, format
, args
);
2116 std::string str
= string_vprintf (format
, args
);
2117 fputs_maybe_filtered (str
.c_str (), stream
, filter
);
2123 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2125 vfprintf_maybe_filtered (stream
, format
, args
, true, true);
2129 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2131 if (debug_timestamp
&& stream
== gdb_stdlog
)
2133 static bool needs_timestamp
= true;
2135 /* Print timestamp if previous print ended with a \n. */
2136 if (needs_timestamp
)
2138 using namespace std::chrono
;
2140 steady_clock::time_point now
= steady_clock::now ();
2141 seconds s
= duration_cast
<seconds
> (now
.time_since_epoch ());
2142 microseconds us
= duration_cast
<microseconds
> (now
.time_since_epoch () - s
);
2143 std::string timestamp
= string_printf ("%ld.%06ld ",
2145 (long) us
.count ());
2146 fputs_unfiltered (timestamp
.c_str (), stream
);
2149 /* Print the message. */
2151 cli_ui_out (&sfile
, 0).vmessage (ui_file_style (), format
, args
);
2152 std::string linebuffer
= std::move (sfile
.string ());
2153 fputs_unfiltered (linebuffer
.c_str (), stream
);
2155 size_t len
= linebuffer
.length ();
2156 needs_timestamp
= (len
> 0 && linebuffer
[len
- 1] == '\n');
2159 vfprintf_maybe_filtered (stream
, format
, args
, false, true);
2163 vprintf_filtered (const char *format
, va_list args
)
2165 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, true, false);
2169 vprintf_unfiltered (const char *format
, va_list args
)
2171 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2175 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2179 va_start (args
, format
);
2180 vfprintf_filtered (stream
, format
, args
);
2185 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2189 va_start (args
, format
);
2190 vfprintf_unfiltered (stream
, format
, args
);
2197 fprintf_styled (struct ui_file
*stream
, const ui_file_style
&style
,
2198 const char *format
, ...)
2202 set_output_style (stream
, style
);
2203 va_start (args
, format
);
2204 vfprintf_filtered (stream
, format
, args
);
2206 set_output_style (stream
, ui_file_style ());
2212 vfprintf_styled (struct ui_file
*stream
, const ui_file_style
&style
,
2213 const char *format
, va_list args
)
2215 set_output_style (stream
, style
);
2216 vfprintf_filtered (stream
, format
, args
);
2217 set_output_style (stream
, ui_file_style ());
2223 vfprintf_styled_no_gdbfmt (struct ui_file
*stream
, const ui_file_style
&style
,
2224 bool filter
, const char *format
, va_list args
)
2226 std::string str
= string_vprintf (format
, args
);
2229 set_output_style (stream
, style
);
2230 fputs_maybe_filtered (str
.c_str (), stream
, filter
);
2231 set_output_style (stream
, ui_file_style ());
2236 printf_filtered (const char *format
, ...)
2240 va_start (args
, format
);
2241 vfprintf_filtered (gdb_stdout
, format
, args
);
2247 printf_unfiltered (const char *format
, ...)
2251 va_start (args
, format
);
2252 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2256 /* Easy -- but watch out!
2258 This routine is *not* a replacement for puts()! puts() appends a newline.
2259 This one doesn't, and had better not! */
2262 puts_filtered (const char *string
)
2264 fputs_filtered (string
, gdb_stdout
);
2268 puts_unfiltered (const char *string
)
2270 fputs_unfiltered (string
, gdb_stdout
);
2273 /* Return a pointer to N spaces and a null. The pointer is good
2274 until the next call to here. */
2279 static char *spaces
= 0;
2280 static int max_spaces
= -1;
2285 spaces
= (char *) xmalloc (n
+ 1);
2286 for (t
= spaces
+ n
; t
!= spaces
;)
2292 return spaces
+ max_spaces
- n
;
2295 /* Print N spaces. */
2297 print_spaces_filtered (int n
, struct ui_file
*stream
)
2299 fputs_filtered (n_spaces (n
), stream
);
2302 /* C++/ObjC demangler stuff. */
2304 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2305 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2306 If the name is not mangled, or the language for the name is unknown, or
2307 demangling is off, the name is printed in its "raw" form. */
2310 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2311 enum language lang
, int arg_mode
)
2317 /* If user wants to see raw output, no problem. */
2320 fputs_filtered (name
, stream
);
2324 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2325 fputs_filtered (demangled
? demangled
: name
, stream
);
2326 if (demangled
!= NULL
)
2334 /* True if CH is a character that can be part of a symbol name. I.e.,
2335 either a number, a letter, or a '_'. */
2338 valid_identifier_name_char (int ch
)
2340 return (ISALNUM (ch
) || ch
== '_');
2343 /* Skip to end of token, or to END, whatever comes first. Input is
2344 assumed to be a C++ operator name. */
2347 cp_skip_operator_token (const char *token
, const char *end
)
2349 const char *p
= token
;
2350 while (p
!= end
&& !ISSPACE (*p
) && *p
!= '(')
2352 if (valid_identifier_name_char (*p
))
2354 while (p
!= end
&& valid_identifier_name_char (*p
))
2360 /* Note, ordered such that among ops that share a prefix,
2361 longer comes first. This is so that the loop below can
2362 bail on first match. */
2363 static const char *ops
[] =
2369 "-=", "--", "->", "-",
2378 "<<=", "<=", "<<", "<",
2379 ">>=", ">=", ">>", ">",
2383 for (const char *op
: ops
)
2385 size_t oplen
= strlen (op
);
2386 size_t lencmp
= std::min
<size_t> (oplen
, end
- p
);
2388 if (strncmp (p
, op
, lencmp
) == 0)
2391 /* Some unidentified character. Return it. */
2399 /* Advance STRING1/STRING2 past whitespace. */
2402 skip_ws (const char *&string1
, const char *&string2
, const char *end_str2
)
2404 while (ISSPACE (*string1
))
2406 while (string2
< end_str2
&& ISSPACE (*string2
))
2410 /* True if STRING points at the start of a C++ operator name. START
2411 is the start of the string that STRING points to, hence when
2412 reading backwards, we must not read any character before START. */
2415 cp_is_operator (const char *string
, const char *start
)
2417 return ((string
== start
2418 || !valid_identifier_name_char (string
[-1]))
2419 && strncmp (string
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
2420 && !valid_identifier_name_char (string
[CP_OPERATOR_LEN
]));
2423 /* If *NAME points at an ABI tag, skip it and return true. Otherwise
2424 leave *NAME unmodified and return false. (see GCC's abi_tag
2425 attribute), such names are demangled as e.g.,
2426 "function[abi:cxx11]()". */
2429 skip_abi_tag (const char **name
)
2431 const char *p
= *name
;
2433 if (startswith (p
, "[abi:"))
2437 while (valid_identifier_name_char (*p
))
2453 strncmp_iw_with_mode (const char *string1
, const char *string2
,
2454 size_t string2_len
, strncmp_iw_mode mode
,
2455 enum language language
,
2456 completion_match_for_lcd
*match_for_lcd
)
2458 const char *string1_start
= string1
;
2459 const char *end_str2
= string2
+ string2_len
;
2460 bool skip_spaces
= true;
2461 bool have_colon_op
= (language
== language_cplus
2462 || language
== language_rust
2463 || language
== language_fortran
);
2468 || ((ISSPACE (*string1
) && !valid_identifier_name_char (*string2
))
2469 || (ISSPACE (*string2
) && !valid_identifier_name_char (*string1
))))
2471 skip_ws (string1
, string2
, end_str2
);
2472 skip_spaces
= false;
2475 /* Skip [abi:cxx11] tags in the symbol name if the lookup name
2476 doesn't include them. E.g.:
2478 string1: function[abi:cxx1](int)
2481 string1: function[abi:cxx1](int)
2482 string2: function(int)
2484 string1: Struct[abi:cxx1]::function()
2485 string2: Struct::function()
2487 string1: function(Struct[abi:cxx1], int)
2488 string2: function(Struct, int)
2490 if (string2
== end_str2
2491 || (*string2
!= '[' && !valid_identifier_name_char (*string2
)))
2493 const char *abi_start
= string1
;
2495 /* There can be more than one tag. */
2496 while (*string1
== '[' && skip_abi_tag (&string1
))
2499 if (match_for_lcd
!= NULL
&& abi_start
!= string1
)
2500 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2502 while (ISSPACE (*string1
))
2506 if (*string1
== '\0' || string2
== end_str2
)
2509 /* Handle the :: operator. */
2510 if (have_colon_op
&& string1
[0] == ':' && string1
[1] == ':')
2512 if (*string2
!= ':')
2518 if (string2
== end_str2
)
2521 if (*string2
!= ':')
2527 while (ISSPACE (*string1
))
2529 while (string2
< end_str2
&& ISSPACE (*string2
))
2534 /* Handle C++ user-defined operators. */
2535 else if (language
== language_cplus
2538 if (cp_is_operator (string1
, string1_start
))
2540 /* An operator name in STRING1. Check STRING2. */
2542 = std::min
<size_t> (CP_OPERATOR_LEN
, end_str2
- string2
);
2543 if (strncmp (string1
, string2
, cmplen
) != 0)
2549 if (string2
!= end_str2
)
2551 /* Check for "operatorX" in STRING2. */
2552 if (valid_identifier_name_char (*string2
))
2555 skip_ws (string1
, string2
, end_str2
);
2558 /* Handle operator(). */
2559 if (*string1
== '(')
2561 if (string2
== end_str2
)
2563 if (mode
== strncmp_iw_mode::NORMAL
)
2567 /* Don't break for the regular return at the
2568 bottom, because "operator" should not
2569 match "operator()", since this open
2570 parentheses is not the parameter list
2572 return *string1
!= '\0';
2576 if (*string1
!= *string2
)
2585 skip_ws (string1
, string2
, end_str2
);
2587 /* Skip to end of token, or to END, whatever comes
2589 const char *end_str1
= string1
+ strlen (string1
);
2590 const char *p1
= cp_skip_operator_token (string1
, end_str1
);
2591 const char *p2
= cp_skip_operator_token (string2
, end_str2
);
2593 cmplen
= std::min (p1
- string1
, p2
- string2
);
2596 if (strncmp (string1
, string2
, cmplen
) != 0)
2601 if (p1
- string1
!= p2
- string2
)
2603 if (strncmp (string1
, string2
, cmplen
) != 0)
2610 if (*string1
== '\0' || string2
== end_str2
)
2612 if (*string1
== '(' || *string2
== '(')
2620 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2622 if (case_sensitivity
== case_sensitive_off
2623 && (TOLOWER ((unsigned char) *string1
)
2624 != TOLOWER ((unsigned char) *string2
)))
2627 /* If we see any non-whitespace, non-identifier-name character
2628 (any of "()<>*&" etc.), then skip spaces the next time
2630 if (!ISSPACE (*string1
) && !valid_identifier_name_char (*string1
))
2637 if (string2
== end_str2
)
2639 if (mode
== strncmp_iw_mode::NORMAL
)
2641 /* Strip abi tag markers from the matched symbol name.
2642 Usually the ABI marker will be found on function name
2643 (automatically added because the function returns an
2644 object marked with an ABI tag). However, it's also
2645 possible to see a marker in one of the function
2646 parameters, for example.
2648 string2 (lookup name):
2651 function(some_struct[abi:cxx11], int)
2653 and for completion LCD computation we want to say that
2655 function(some_struct, int)
2657 if (match_for_lcd
!= NULL
)
2659 while ((string1
= strstr (string1
, "[abi:")) != NULL
)
2661 const char *abi_start
= string1
;
2663 /* There can be more than one tag. */
2664 while (skip_abi_tag (&string1
) && *string1
== '[')
2667 if (abi_start
!= string1
)
2668 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2675 return (*string1
!= '\0' && *string1
!= '(');
2684 strncmp_iw (const char *string1
, const char *string2
, size_t string2_len
)
2686 return strncmp_iw_with_mode (string1
, string2
, string2_len
,
2687 strncmp_iw_mode::NORMAL
, language_minimal
);
2693 strcmp_iw (const char *string1
, const char *string2
)
2695 return strncmp_iw_with_mode (string1
, string2
, strlen (string2
),
2696 strncmp_iw_mode::MATCH_PARAMS
, language_minimal
);
2699 /* This is like strcmp except that it ignores whitespace and treats
2700 '(' as the first non-NULL character in terms of ordering. Like
2701 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2702 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2703 according to that ordering.
2705 If a list is sorted according to this function and if you want to
2706 find names in the list that match some fixed NAME according to
2707 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2708 where this function would put NAME.
2710 This function must be neutral to the CASE_SENSITIVITY setting as the user
2711 may choose it during later lookup. Therefore this function always sorts
2712 primarily case-insensitively and secondarily case-sensitively.
2714 Here are some examples of why using strcmp to sort is a bad idea:
2718 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2719 we try to do a search for "foo<char*>", strcmp will locate this
2720 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2721 will start looking at strings beginning with "goo", and will never
2722 see the correct match of "foo<char *>".
2724 Parenthesis example:
2726 In practice, this is less like to be an issue, but I'll give it a
2727 shot. Let's assume that '$' is a legitimate character to occur in
2728 symbols. (Which may well even be the case on some systems.) Then
2729 say that the partial symbol table contains "foo$" and "foo(int)".
2730 strcmp will put them in this order, since '$' < '('. Now, if the
2731 user searches for "foo", then strcmp will sort "foo" before "foo$".
2732 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2733 "foo") is false, so it won't proceed to the actual match of
2734 "foo(int)" with "foo". */
2737 strcmp_iw_ordered (const char *string1
, const char *string2
)
2739 const char *saved_string1
= string1
, *saved_string2
= string2
;
2740 enum case_sensitivity case_pass
= case_sensitive_off
;
2744 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2745 Provide stub characters if we are already at the end of one of the
2747 char c1
= 'X', c2
= 'X';
2749 while (*string1
!= '\0' && *string2
!= '\0')
2751 while (ISSPACE (*string1
))
2753 while (ISSPACE (*string2
))
2758 case case_sensitive_off
:
2759 c1
= TOLOWER ((unsigned char) *string1
);
2760 c2
= TOLOWER ((unsigned char) *string2
);
2762 case case_sensitive_on
:
2770 if (*string1
!= '\0')
2779 /* Characters are non-equal unless they're both '\0'; we want to
2780 make sure we get the comparison right according to our
2781 comparison in the cases where one of them is '\0' or '('. */
2783 if (*string2
== '\0')
2788 if (*string2
== '\0')
2793 if (*string2
== '\0' || *string2
== '(')
2802 if (case_pass
== case_sensitive_on
)
2805 /* Otherwise the strings were equal in case insensitive way, make
2806 a more fine grained comparison in a case sensitive way. */
2808 case_pass
= case_sensitive_on
;
2809 string1
= saved_string1
;
2810 string2
= saved_string2
;
2817 streq (const char *lhs
, const char *rhs
)
2819 return !strcmp (lhs
, rhs
);
2826 ** Answer whether string_to_compare is a full or partial match to
2827 ** template_string. The partial match must be in sequence starting
2831 subset_compare (const char *string_to_compare
, const char *template_string
)
2835 if (template_string
!= NULL
&& string_to_compare
!= NULL
2836 && strlen (string_to_compare
) <= strlen (template_string
))
2838 (startswith (template_string
, string_to_compare
));
2845 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2846 struct cmd_list_element
*c
, const char *value
)
2848 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2856 address_significant (gdbarch
*gdbarch
, CORE_ADDR addr
)
2858 /* Clear insignificant bits of a target address and sign extend resulting
2859 address, avoiding shifts larger or equal than the width of a CORE_ADDR.
2860 The local variable ADDR_BIT stops the compiler reporting a shift overflow
2861 when it won't occur. Skip updating of target address if current target
2862 has not set gdbarch significant_addr_bit. */
2863 int addr_bit
= gdbarch_significant_addr_bit (gdbarch
);
2865 if (addr_bit
&& (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
)))
2867 CORE_ADDR sign
= (CORE_ADDR
) 1 << (addr_bit
- 1);
2868 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2869 addr
= (addr
^ sign
) - sign
;
2876 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2878 /* Truncate address to the size of a target address, avoiding shifts
2879 larger or equal than the width of a CORE_ADDR. The local
2880 variable ADDR_BIT stops the compiler reporting a shift overflow
2881 when it won't occur. */
2882 /* NOTE: This assumes that the significant address information is
2883 kept in the least significant bits of ADDR - the upper bits were
2884 either zero or sign extended. Should gdbarch_address_to_pointer or
2885 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2887 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2889 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2890 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2891 return hex_string (addr
);
2894 /* This function is described in "defs.h". */
2897 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2899 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2901 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2902 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2904 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2905 that returns the language localized string formatted to a width
2906 based on gdbarch_addr_bit. */
2908 return hex_string_custom (address
, 8);
2910 return hex_string_custom (address
, 16);
2913 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2916 core_addr_hash (const void *ap
)
2918 const CORE_ADDR
*addrp
= (const CORE_ADDR
*) ap
;
2923 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2926 core_addr_eq (const void *ap
, const void *bp
)
2928 const CORE_ADDR
*addr_ap
= (const CORE_ADDR
*) ap
;
2929 const CORE_ADDR
*addr_bp
= (const CORE_ADDR
*) bp
;
2931 return *addr_ap
== *addr_bp
;
2934 /* Convert a string back into a CORE_ADDR. */
2936 string_to_core_addr (const char *my_string
)
2940 if (my_string
[0] == '0' && TOLOWER (my_string
[1]) == 'x')
2942 /* Assume that it is in hex. */
2945 for (i
= 2; my_string
[i
] != '\0'; i
++)
2947 if (ISDIGIT (my_string
[i
]))
2948 addr
= (my_string
[i
] - '0') + (addr
* 16);
2949 else if (ISXDIGIT (my_string
[i
]))
2950 addr
= (TOLOWER (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2952 error (_("invalid hex \"%s\""), my_string
);
2957 /* Assume that it is in decimal. */
2960 for (i
= 0; my_string
[i
] != '\0'; i
++)
2962 if (ISDIGIT (my_string
[i
]))
2963 addr
= (my_string
[i
] - '0') + (addr
* 10);
2965 error (_("invalid decimal \"%s\""), my_string
);
2975 gdb_realpath_check_trailer (const char *input
, const char *trailer
)
2977 gdb::unique_xmalloc_ptr
<char> result
= gdb_realpath (input
);
2979 size_t len
= strlen (result
.get ());
2980 size_t trail_len
= strlen (trailer
);
2982 SELF_CHECK (len
>= trail_len
2983 && strcmp (result
.get () + len
- trail_len
, trailer
) == 0);
2987 gdb_realpath_tests ()
2989 /* A file which contains a directory prefix. */
2990 gdb_realpath_check_trailer ("./xfullpath.exp", "/xfullpath.exp");
2991 /* A file which contains a directory prefix. */
2992 gdb_realpath_check_trailer ("../../defs.h", "/defs.h");
2993 /* A one-character filename. */
2994 gdb_realpath_check_trailer ("./a", "/a");
2995 /* A file in the root directory. */
2996 gdb_realpath_check_trailer ("/root_file_which_should_exist",
2997 "/root_file_which_should_exist");
2998 /* A file which does not have a directory prefix. */
2999 gdb_realpath_check_trailer ("xfullpath.exp", "xfullpath.exp");
3000 /* A one-char filename without any directory prefix. */
3001 gdb_realpath_check_trailer ("a", "a");
3002 /* An empty filename. */
3003 gdb_realpath_check_trailer ("", "");
3006 /* Test the gdb_argv::as_array_view method. */
3009 gdb_argv_as_array_view_test ()
3014 gdb::array_view
<char *> view
= argv
.as_array_view ();
3016 SELF_CHECK (view
.data () == nullptr);
3017 SELF_CHECK (view
.size () == 0);
3020 gdb_argv
argv ("une bonne 50");
3022 gdb::array_view
<char *> view
= argv
.as_array_view ();
3024 SELF_CHECK (view
.size () == 3);
3025 SELF_CHECK (strcmp (view
[0], "une") == 0);
3026 SELF_CHECK (strcmp (view
[1], "bonne") == 0);
3027 SELF_CHECK (strcmp (view
[2], "50") == 0);
3031 #endif /* GDB_SELF_TEST */
3033 /* Allocation function for the libiberty hash table which uses an
3034 obstack. The obstack is passed as DATA. */
3037 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
3039 size_t total
= size
* count
;
3040 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
3042 memset (ptr
, 0, total
);
3046 /* Trivial deallocation function for the libiberty splay tree and hash
3047 table - don't deallocate anything. Rely on later deletion of the
3048 obstack. DATA will be the obstack, although it is not needed
3052 dummy_obstack_deallocate (void *object
, void *data
)
3057 /* Simple, portable version of dirname that does not modify its
3061 ldirname (const char *filename
)
3063 std::string dirname
;
3064 const char *base
= lbasename (filename
);
3066 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
3069 if (base
== filename
)
3072 dirname
= std::string (filename
, base
- filename
);
3074 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3075 create "d:./bar" later instead of the (different) "d:/bar". */
3076 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3077 && !IS_DIR_SEPARATOR (filename
[0]))
3078 dirname
[base
++ - filename
] = '.';
3086 gdb_argv::reset (const char *s
)
3088 char **argv
= buildargv (s
);
3094 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3095 #define AMBIGUOUS_MESS2 \
3096 ".\nUse \"set gnutarget format-name\" to specify the format."
3099 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3103 /* Check if errmsg just need simple return. */
3104 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3105 return bfd_errmsg (error_tag
);
3107 std::string
ret (bfd_errmsg (error_tag
));
3108 ret
+= AMBIGUOUS_MESS1
;
3110 for (p
= matching
; *p
; p
++)
3115 ret
+= AMBIGUOUS_MESS2
;
3122 /* Return ARGS parsed as a valid pid, or throw an error. */
3125 parse_pid_to_attach (const char *args
)
3131 error_no_arg (_("process-id to attach"));
3133 dummy
= (char *) args
;
3134 pid
= strtoul (args
, &dummy
, 0);
3135 /* Some targets don't set errno on errors, grrr! */
3136 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3137 error (_("Illegal process-id: %s."), args
);
3142 /* Substitute all occurrences of string FROM by string TO in *STRINGP. *STRINGP
3143 must come from xrealloc-compatible allocator and it may be updated. FROM
3144 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3145 located at the start or end of *STRINGP. */
3148 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3150 char *string
= *stringp
, *s
;
3151 const size_t from_len
= strlen (from
);
3152 const size_t to_len
= strlen (to
);
3156 s
= strstr (s
, from
);
3160 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3161 || s
[-1] == DIRNAME_SEPARATOR
)
3162 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3163 || s
[from_len
] == DIRNAME_SEPARATOR
))
3168 = (char *) xrealloc (string
, (strlen (string
) + to_len
+ 1));
3170 /* Relocate the current S pointer. */
3171 s
= s
- string
+ string_new
;
3172 string
= string_new
;
3174 /* Replace from by to. */
3175 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3176 memcpy (s
, to
, to_len
);
3191 /* SIGALRM handler for waitpid_with_timeout. */
3194 sigalrm_handler (int signo
)
3196 /* Nothing to do. */
3201 /* Wrapper to wait for child PID to die with TIMEOUT.
3202 TIMEOUT is the time to stop waiting in seconds.
3203 If TIMEOUT is zero, pass WNOHANG to waitpid.
3204 Returns PID if it was successfully waited for, otherwise -1.
3206 Timeouts are currently implemented with alarm and SIGALRM.
3207 If the host does not support them, this waits "forever".
3208 It would be odd though for a host to have waitpid and not SIGALRM. */
3211 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3213 pid_t waitpid_result
;
3215 gdb_assert (pid
> 0);
3216 gdb_assert (timeout
>= 0);
3221 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3222 struct sigaction sa
, old_sa
;
3224 sa
.sa_handler
= sigalrm_handler
;
3225 sigemptyset (&sa
.sa_mask
);
3227 sigaction (SIGALRM
, &sa
, &old_sa
);
3231 ofunc
= signal (SIGALRM
, sigalrm_handler
);
3237 waitpid_result
= waitpid (pid
, status
, 0);
3241 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3242 sigaction (SIGALRM
, &old_sa
, NULL
);
3244 signal (SIGALRM
, ofunc
);
3249 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3251 if (waitpid_result
== pid
)
3257 #endif /* HAVE_WAITPID */
3259 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3260 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3262 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3263 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3266 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3268 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3270 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3271 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3273 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3275 char *pattern_slash
, *string_slash
;
3277 /* Replace '\' by '/' in both strings. */
3279 pattern_slash
= (char *) alloca (strlen (pattern
) + 1);
3280 strcpy (pattern_slash
, pattern
);
3281 pattern
= pattern_slash
;
3282 for (; *pattern_slash
!= 0; pattern_slash
++)
3283 if (IS_DIR_SEPARATOR (*pattern_slash
))
3284 *pattern_slash
= '/';
3286 string_slash
= (char *) alloca (strlen (string
) + 1);
3287 strcpy (string_slash
, string
);
3288 string
= string_slash
;
3289 for (; *string_slash
!= 0; string_slash
++)
3290 if (IS_DIR_SEPARATOR (*string_slash
))
3291 *string_slash
= '/';
3293 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3295 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3296 flags
|= FNM_CASEFOLD
;
3297 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3299 return fnmatch (pattern
, string
, flags
);
3302 /* Return the number of path elements in PATH.
3310 count_path_elements (const char *path
)
3313 const char *p
= path
;
3315 if (HAS_DRIVE_SPEC (p
))
3317 p
= STRIP_DRIVE_SPEC (p
);
3323 if (IS_DIR_SEPARATOR (*p
))
3328 /* Backup one if last character is /, unless it's the only one. */
3329 if (p
> path
+ 1 && IS_DIR_SEPARATOR (p
[-1]))
3332 /* Add one for the file name, if present. */
3333 if (p
> path
&& !IS_DIR_SEPARATOR (p
[-1]))
3339 /* Remove N leading path elements from PATH.
3340 N must be non-negative.
3341 If PATH has more than N path elements then return NULL.
3342 If PATH has exactly N path elements then return "".
3343 See count_path_elements for a description of how we do the counting. */
3346 strip_leading_path_elements (const char *path
, int n
)
3349 const char *p
= path
;
3351 gdb_assert (n
>= 0);
3356 if (HAS_DRIVE_SPEC (p
))
3358 p
= STRIP_DRIVE_SPEC (p
);
3364 while (*p
!= '\0' && !IS_DIR_SEPARATOR (*p
))
3382 copy_bitwise (gdb_byte
*dest
, ULONGEST dest_offset
,
3383 const gdb_byte
*source
, ULONGEST source_offset
,
3384 ULONGEST nbits
, int bits_big_endian
)
3386 unsigned int buf
, avail
;
3391 if (bits_big_endian
)
3393 /* Start from the end, then work backwards. */
3394 dest_offset
+= nbits
- 1;
3395 dest
+= dest_offset
/ 8;
3396 dest_offset
= 7 - dest_offset
% 8;
3397 source_offset
+= nbits
- 1;
3398 source
+= source_offset
/ 8;
3399 source_offset
= 7 - source_offset
% 8;
3403 dest
+= dest_offset
/ 8;
3405 source
+= source_offset
/ 8;
3409 /* Fill BUF with DEST_OFFSET bits from the destination and 8 -
3410 SOURCE_OFFSET bits from the source. */
3411 buf
= *(bits_big_endian
? source
-- : source
++) >> source_offset
;
3412 buf
<<= dest_offset
;
3413 buf
|= *dest
& ((1 << dest_offset
) - 1);
3415 /* NBITS: bits yet to be written; AVAIL: BUF's fill level. */
3416 nbits
+= dest_offset
;
3417 avail
= dest_offset
+ 8 - source_offset
;
3419 /* Flush 8 bits from BUF, if appropriate. */
3420 if (nbits
>= 8 && avail
>= 8)
3422 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3428 /* Copy the middle part. */
3431 size_t len
= nbits
/ 8;
3433 /* Use a faster method for byte-aligned copies. */
3436 if (bits_big_endian
)
3440 memcpy (dest
+ 1, source
+ 1, len
);
3444 memcpy (dest
, source
, len
);
3453 buf
|= *(bits_big_endian
? source
-- : source
++) << avail
;
3454 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3461 /* Write the last byte. */
3465 buf
|= *source
<< avail
;
3467 buf
&= (1 << nbits
) - 1;
3468 *dest
= (*dest
& (~0U << nbits
)) | buf
;
3472 void _initialize_utils ();
3474 _initialize_utils ()
3476 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
3477 Set number of characters where GDB should wrap lines of its output."), _("\
3478 Show number of characters where GDB should wrap lines of its output."), _("\
3479 This affects where GDB wraps its output to fit the screen width.\n\
3480 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
3482 show_chars_per_line
,
3483 &setlist
, &showlist
);
3485 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
3486 Set number of lines in a page for GDB output pagination."), _("\
3487 Show number of lines in a page for GDB output pagination."), _("\
3488 This affects the number of lines after which GDB will pause\n\
3489 its output and ask you whether to continue.\n\
3490 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
3492 show_lines_per_page
,
3493 &setlist
, &showlist
);
3495 add_setshow_boolean_cmd ("pagination", class_support
,
3496 &pagination_enabled
, _("\
3497 Set state of GDB output pagination."), _("\
3498 Show state of GDB output pagination."), _("\
3499 When pagination is ON, GDB pauses at end of each screenful of\n\
3500 its output and asks you whether to continue.\n\
3501 Turning pagination off is an alternative to \"set height unlimited\"."),
3503 show_pagination_enabled
,
3504 &setlist
, &showlist
);
3506 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
3507 &sevenbit_strings
, _("\
3508 Set printing of 8-bit characters in strings as \\nnn."), _("\
3509 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
3511 show_sevenbit_strings
,
3512 &setprintlist
, &showprintlist
);
3514 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
3515 &debug_timestamp
, _("\
3516 Set timestamping of debugging messages."), _("\
3517 Show timestamping of debugging messages."), _("\
3518 When set, debugging messages will be marked with seconds and microseconds."),
3520 show_debug_timestamp
,
3521 &setdebuglist
, &showdebuglist
);
3523 add_internal_problem_command (&internal_error_problem
);
3524 add_internal_problem_command (&internal_warning_problem
);
3525 add_internal_problem_command (&demangler_warning_problem
);
3528 selftests::register_test ("gdb_realpath", gdb_realpath_tests
);
3529 selftests::register_test ("gdb_argv_array_view", gdb_argv_as_array_view_test
);