1 /* General utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2022 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include "gdbsupport/gdb_wait.h"
23 #include "event-top.h"
24 #include "gdbthread.h"
27 #ifdef HAVE_SYS_RESOURCE_H
28 #include <sys/resource.h>
29 #endif /* HAVE_SYS_RESOURCE_H */
32 #include "tui/tui.h" /* For tui_get_command_dimension. */
44 #include "gdb-demangle.h"
45 #include "expression.h"
49 #include "filenames.h"
51 #include "gdb_obstack.h"
57 #include "inferior.h" /* for signed_pointer_to_address */
59 #include "gdb_curses.h"
61 #include "readline/readline.h"
66 #include "gdb_regex.h"
67 #include "gdbsupport/job-control.h"
68 #include "gdbsupport/selftest.h"
69 #include "gdbsupport/gdb_optional.h"
70 #include "cp-support.h"
72 #include "gdbsupport/pathstuff.h"
73 #include "cli/cli-style.h"
74 #include "gdbsupport/scope-exit.h"
77 #include "gdbsupport/gdb-safe-ctype.h"
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 abort (); /* ARI: abort */
207 /* Check whether GDB will be able to dump core using the dump_core
208 function. Returns zero if GDB cannot or should not dump core.
209 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
210 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
213 can_dump_core (enum resource_limit_kind limit_kind
)
215 #ifdef HAVE_GETRLIMIT
218 /* Be quiet and assume we can dump if an error is returned. */
219 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
225 if (rlim
.rlim_cur
== 0)
230 if (rlim
.rlim_max
== 0)
233 #endif /* HAVE_GETRLIMIT */
238 /* Print a warning that we cannot dump core. */
241 warn_cant_dump_core (const char *reason
)
243 fprintf_unfiltered (gdb_stderr
,
244 _("%s\nUnable to dump core, use `ulimit -c"
245 " unlimited' before executing GDB next time.\n"),
249 /* Check whether GDB will be able to dump core using the dump_core
250 function, and print a warning if we cannot. */
253 can_dump_core_warn (enum resource_limit_kind limit_kind
,
256 int core_dump_allowed
= can_dump_core (limit_kind
);
258 if (!core_dump_allowed
)
259 warn_cant_dump_core (reason
);
261 return core_dump_allowed
;
264 /* Allow the user to configure the debugger behavior with respect to
265 what to do when an internal problem is detected. */
267 const char internal_problem_ask
[] = "ask";
268 const char internal_problem_yes
[] = "yes";
269 const char internal_problem_no
[] = "no";
270 static const char *const internal_problem_modes
[] =
272 internal_problem_ask
,
273 internal_problem_yes
,
278 /* Print a message reporting an internal error/warning. Ask the user
279 if they want to continue, dump core, or just exit. Return
280 something to indicate a quit. */
282 struct internal_problem
285 int user_settable_should_quit
;
286 const char *should_quit
;
287 int user_settable_should_dump_core
;
288 const char *should_dump_core
;
291 /* Report a problem, internal to GDB, to the user. Once the problem
292 has been reported, and assuming GDB didn't quit, the caller can
293 either allow execution to resume or throw an error. */
295 static void ATTRIBUTE_PRINTF (4, 0)
296 internal_vproblem (struct internal_problem
*problem
,
297 const char *file
, int line
, const char *fmt
, va_list ap
)
304 /* Don't allow infinite error/warning recursion. */
306 static const char msg
[] = "Recursive internal problem.\n";
315 abort_with_message (msg
);
318 /* Newer GLIBC versions put the warn_unused_result attribute
319 on write, but this is one of those rare cases where
320 ignoring the return value is correct. Casting to (void)
321 does not fix this problem. This is the solution suggested
322 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
323 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
324 abort (); /* ARI: abort */
329 /* Create a string containing the full error/warning message. Need
330 to call query with this full string, as otherwize the reason
331 (error/warning) and question become separated. Format using a
332 style similar to a compiler error message. Include extra detail
333 so that the user knows that they are living on the edge. */
335 std::string msg
= string_vprintf (fmt
, ap
);
336 reason
= string_printf ("%s:%d: %s: %s\n"
337 "A problem internal to GDB has been detected,\n"
338 "further debugging may prove unreliable.",
339 file
, line
, problem
->name
, msg
.c_str ());
342 /* Fall back to abort_with_message if gdb_stderr is not set up. */
343 if (current_ui
== NULL
)
345 fputs (reason
.c_str (), stderr
);
346 abort_with_message ("\n");
349 /* Try to get the message out and at the start of a new line. */
350 gdb::optional
<target_terminal::scoped_restore_terminal_state
> term_state
;
351 if (target_supports_terminal_ours ())
353 term_state
.emplace ();
354 target_terminal::ours_for_output ();
356 if (filtered_printing_initialized ())
359 /* Emit the message unless query will emit it below. */
360 if (problem
->should_quit
!= internal_problem_ask
362 || !filtered_printing_initialized ())
363 fprintf_unfiltered (gdb_stderr
, "%s\n", reason
.c_str ());
365 if (problem
->should_quit
== internal_problem_ask
)
367 /* Default (yes/batch case) is to quit GDB. When in batch mode
368 this lessens the likelihood of GDB going into an infinite
370 if (!confirm
|| !filtered_printing_initialized ())
373 quit_p
= query (_("%s\nQuit this debugging session? "),
376 else if (problem
->should_quit
== internal_problem_yes
)
378 else if (problem
->should_quit
== internal_problem_no
)
381 internal_error (__FILE__
, __LINE__
, _("bad switch"));
383 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr
);
384 if (REPORT_BUGS_TO
[0])
385 fprintf_unfiltered (gdb_stderr
, _(" For instructions, see:\n%s."),
387 fputs_unfiltered ("\n\n", gdb_stderr
);
389 if (problem
->should_dump_core
== internal_problem_ask
)
391 if (!can_dump_core_warn (LIMIT_MAX
, reason
.c_str ()))
393 else if (!filtered_printing_initialized ())
397 /* Default (yes/batch case) is to dump core. This leaves a GDB
398 `dropping' so that it is easier to see that something went
400 dump_core_p
= query (_("%s\nCreate a core file of GDB? "),
404 else if (problem
->should_dump_core
== internal_problem_yes
)
405 dump_core_p
= can_dump_core_warn (LIMIT_MAX
, reason
.c_str ());
406 else if (problem
->should_dump_core
== internal_problem_no
)
409 internal_error (__FILE__
, __LINE__
, _("bad switch"));
422 #ifdef HAVE_WORKING_FORK
432 static struct internal_problem internal_error_problem
= {
433 "internal-error", 1, internal_problem_ask
, 1, internal_problem_ask
437 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
439 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
440 throw_quit (_("Command aborted."));
443 static struct internal_problem internal_warning_problem
= {
444 "internal-warning", 1, internal_problem_ask
, 1, internal_problem_ask
448 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
450 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
453 static struct internal_problem demangler_warning_problem
= {
454 "demangler-warning", 1, internal_problem_ask
, 0, internal_problem_no
458 demangler_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
460 internal_vproblem (&demangler_warning_problem
, file
, line
, fmt
, ap
);
464 demangler_warning (const char *file
, int line
, const char *string
, ...)
468 va_start (ap
, string
);
469 demangler_vwarning (file
, line
, string
, ap
);
473 /* When GDB reports an internal problem (error or warning) it gives
474 the user the opportunity to quit GDB and/or create a core file of
475 the current debug session. This function registers a few commands
476 that make it possible to specify that GDB should always or never
477 quit or create a core file, without asking. The commands look
480 maint set PROBLEM-NAME quit ask|yes|no
481 maint show PROBLEM-NAME quit
482 maint set PROBLEM-NAME corefile ask|yes|no
483 maint show PROBLEM-NAME corefile
485 Where PROBLEM-NAME is currently "internal-error" or
486 "internal-warning". */
489 add_internal_problem_command (struct internal_problem
*problem
)
491 struct cmd_list_element
**set_cmd_list
;
492 struct cmd_list_element
**show_cmd_list
;
496 set_cmd_list
= XNEW (struct cmd_list_element
*);
497 show_cmd_list
= XNEW (struct cmd_list_element
*);
498 *set_cmd_list
= NULL
;
499 *show_cmd_list
= NULL
;
501 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
504 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
507 add_basic_prefix_cmd (problem
->name
, class_maintenance
, set_doc
,
509 0/*allow-unknown*/, &maintenance_set_cmdlist
);
511 add_show_prefix_cmd (problem
->name
, class_maintenance
, show_doc
,
513 0/*allow-unknown*/, &maintenance_show_cmdlist
);
515 if (problem
->user_settable_should_quit
)
517 set_doc
= xstrprintf (_("Set whether GDB should quit "
518 "when an %s is detected."),
520 show_doc
= xstrprintf (_("Show whether GDB will quit "
521 "when an %s is detected."),
523 add_setshow_enum_cmd ("quit", class_maintenance
,
524 internal_problem_modes
,
525 &problem
->should_quit
,
538 if (problem
->user_settable_should_dump_core
)
540 set_doc
= xstrprintf (_("Set whether GDB should create a core "
541 "file of GDB when %s is detected."),
543 show_doc
= xstrprintf (_("Show whether GDB will create a core "
544 "file of GDB when %s is detected."),
546 add_setshow_enum_cmd ("corefile", class_maintenance
,
547 internal_problem_modes
,
548 &problem
->should_dump_core
,
562 /* Return a newly allocated string, containing the PREFIX followed
563 by the system error message for errno (separated by a colon). */
566 perror_string (const char *prefix
)
568 const char *err
= safe_strerror (errno
);
569 return std::string (prefix
) + ": " + err
;
572 /* Print the system error message for errno, and also mention STRING
573 as the file name for which the error was encountered. Use ERRCODE
574 for the thrown exception. Then return to command level. */
577 throw_perror_with_name (enum errors errcode
, const char *string
)
579 std::string combined
= perror_string (string
);
581 /* I understand setting these is a matter of taste. Still, some people
582 may clear errno but not know about bfd_error. Doing this here is not
584 bfd_set_error (bfd_error_no_error
);
587 throw_error (errcode
, _("%s."), combined
.c_str ());
590 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
593 perror_with_name (const char *string
)
595 throw_perror_with_name (GENERIC_ERROR
, string
);
598 /* Same as perror_with_name except that it prints a warning instead
599 of throwing an error. */
602 perror_warning_with_name (const char *string
)
604 std::string combined
= perror_string (string
);
605 warning (_("%s"), combined
.c_str ());
608 /* Print the system error message for ERRCODE, and also mention STRING
609 as the file name for which the error was encountered. */
612 print_sys_errmsg (const char *string
, int errcode
)
614 const char *err
= safe_strerror (errcode
);
615 /* We want anything which was printed on stdout to come out first, before
617 gdb_flush (gdb_stdout
);
618 fprintf_unfiltered (gdb_stderr
, "%s: %s.\n", string
, err
);
621 /* Control C eventually causes this to be called, at a convenient time. */
626 if (sync_quit_force_run
)
628 sync_quit_force_run
= 0;
629 quit_force (NULL
, 0);
633 /* No steenking SIGINT will ever be coming our way when the
634 program is resumed. Don't lie. */
638 /* If there is no terminal switching for this target, then we can't
639 possibly get screwed by the lack of job control. */
640 || !target_supports_terminal_ours ())
643 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
652 if (sync_quit_force_run
)
659 /* Called when a memory allocation fails, with the number of bytes of
660 memory requested in SIZE. */
663 malloc_failure (long size
)
667 internal_error (__FILE__
, __LINE__
,
668 _("virtual memory exhausted: can't allocate %ld bytes."),
673 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
677 /* See common/errors.h. */
682 gdb_stdout
->flush ();
683 gdb_stderr
->flush ();
686 /* My replacement for the read system call.
687 Used like `read' but keeps going if `read' returns too soon. */
690 myread (int desc
, char *addr
, int len
)
697 val
= read (desc
, addr
, len
);
711 uinteger_pow (ULONGEST v1
, LONGEST v2
)
716 error (_("Attempt to raise 0 to negative power."));
722 /* The Russian Peasant's Algorithm. */
739 print_spaces (int n
, struct ui_file
*file
)
741 fputs_unfiltered (n_spaces (n
), file
);
744 /* Print a host address. */
747 gdb_print_host_address_1 (const void *addr
, struct ui_file
*stream
)
749 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
754 /* An RAII class that sets up to handle input and then tears down
755 during destruction. */
757 class scoped_input_handler
761 scoped_input_handler ()
762 : m_quit_handler (&quit_handler
, default_quit_handler
),
765 target_terminal::ours ();
766 ui_register_input_event_handler (current_ui
);
767 if (current_ui
->prompt_state
== PROMPT_BLOCKED
)
771 ~scoped_input_handler ()
774 ui_unregister_input_event_handler (m_ui
);
777 DISABLE_COPY_AND_ASSIGN (scoped_input_handler
);
781 /* Save and restore the terminal state. */
782 target_terminal::scoped_restore_terminal_state m_term_state
;
784 /* Save and restore the quit handler. */
785 scoped_restore_tmpl
<quit_handler_ftype
*> m_quit_handler
;
787 /* The saved UI, if non-NULL. */
793 /* This function supports the query, nquery, and yquery functions.
794 Ask user a y-or-n question and return 0 if answer is no, 1 if
795 answer is yes, or default the answer to the specified default
796 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
797 default answer, or '\0' for no default.
798 CTLSTR is the control string and should end in "? ". It should
799 not say how to answer, because we do that.
800 ARGS are the arguments passed along with the CTLSTR argument to
803 static int ATTRIBUTE_PRINTF (1, 0)
804 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
808 char def_answer
, not_def_answer
;
809 const char *y_string
, *n_string
;
811 /* Set up according to which answer is the default. */
816 not_def_answer
= 'N';
820 else if (defchar
== 'y')
824 not_def_answer
= 'N';
832 not_def_answer
= 'Y';
837 /* Automatically answer the default value if the user did not want
838 prompts or the command was issued with the server prefix. */
839 if (!confirm
|| server_command
)
842 /* If input isn't coming from the user directly, just say what
843 question we're asking, and then answer the default automatically. This
844 way, important error messages don't get lost when talking to GDB
846 if (current_ui
->instream
!= current_ui
->stdin_stream
847 || !input_interactive_p (current_ui
)
848 /* Restrict queries to the main UI. */
849 || current_ui
!= main_ui
)
851 target_terminal::scoped_restore_terminal_state term_state
;
852 target_terminal::ours_for_output ();
854 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
856 printf_filtered (_("(%s or %s) [answered %c; "
857 "input not from terminal]\n"),
858 y_string
, n_string
, def_answer
);
863 if (deprecated_query_hook
)
865 target_terminal::scoped_restore_terminal_state term_state
;
866 return deprecated_query_hook (ctlstr
, args
);
869 /* Format the question outside of the loop, to avoid reusing args. */
870 std::string question
= string_vprintf (ctlstr
, args
);
872 = string_printf (_("%s%s(%s or %s) %s"),
873 annotation_level
> 1 ? "\n\032\032pre-query\n" : "",
874 question
.c_str (), y_string
, n_string
,
875 annotation_level
> 1 ? "\n\032\032query\n" : "");
877 /* Used to add duration we waited for user to respond to
878 prompt_for_continue_wait_time. */
879 using namespace std::chrono
;
880 steady_clock::time_point prompt_started
= steady_clock::now ();
882 scoped_input_handler prepare_input
;
886 char *response
, answer
;
888 gdb_flush (gdb_stdout
);
889 response
= gdb_readline_wrapper (prompt
.c_str ());
891 if (response
== NULL
) /* C-d */
893 printf_filtered ("EOF [assumed %c]\n", def_answer
);
898 answer
= response
[0];
903 /* Check answer. For the non-default, the user must specify
904 the non-default explicitly. */
905 if (answer
== not_def_answer
)
910 /* Otherwise, if a default was specified, the user may either
911 specify the required input or have it default by entering
913 if (answer
== def_answer
914 || (defchar
!= '\0' && answer
== '\0'))
919 /* Invalid entries are not defaulted and require another selection. */
920 printf_filtered (_("Please answer %s or %s.\n"),
924 /* Add time spend in this routine to prompt_for_continue_wait_time. */
925 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
927 if (annotation_level
> 1)
928 printf_filtered (("\n\032\032post-query\n"));
933 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
934 answer is yes, or 0 if answer is defaulted.
935 Takes three args which are given to printf to print the question.
936 The first, a control string, should end in "? ".
937 It should not say how to answer, because we do that. */
940 nquery (const char *ctlstr
, ...)
945 va_start (args
, ctlstr
);
946 ret
= defaulted_query (ctlstr
, 'n', args
);
951 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
952 answer is yes, or 1 if answer is defaulted.
953 Takes three args which are given to printf to print the question.
954 The first, a control string, should end in "? ".
955 It should not say how to answer, because we do that. */
958 yquery (const char *ctlstr
, ...)
963 va_start (args
, ctlstr
);
964 ret
= defaulted_query (ctlstr
, 'y', args
);
969 /* Ask user a y-or-n question and return 1 iff answer is yes.
970 Takes three args which are given to printf to print the question.
971 The first, a control string, should end in "? ".
972 It should not say how to answer, because we do that. */
975 query (const char *ctlstr
, ...)
980 va_start (args
, ctlstr
);
981 ret
= defaulted_query (ctlstr
, '\0', args
);
986 /* A helper for parse_escape that converts a host character to a
987 target character. C is the host character. If conversion is
988 possible, then the target character is stored in *TARGET_C and the
989 function returns 1. Otherwise, the function returns 0. */
992 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
997 auto_obstack host_data
;
999 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1000 (gdb_byte
*) &the_char
, 1, 1,
1001 &host_data
, translit_none
);
1003 if (obstack_object_size (&host_data
) == 1)
1006 *target_c
= *(char *) obstack_base (&host_data
);
1012 /* Parse a C escape sequence. STRING_PTR points to a variable
1013 containing a pointer to the string to parse. That pointer
1014 should point to the character after the \. That pointer
1015 is updated past the characters we use. The value of the
1016 escape sequence is returned.
1018 A negative value means the sequence \ newline was seen,
1019 which is supposed to be equivalent to nothing at all.
1021 If \ is followed by a null character, we return a negative
1022 value and leave the string pointer pointing at the null character.
1024 If \ is followed by 000, we return 0 and leave the string pointer
1025 after the zeros. A value of 0 does not mean end of string. */
1028 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1030 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1031 int c
= *(*string_ptr
)++;
1050 int i
= host_hex_value (c
);
1055 if (ISDIGIT (c
) && c
!= '8' && c
!= '9')
1059 i
+= host_hex_value (c
);
1095 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1096 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1097 " which has no equivalent\nin the `%s' character set."),
1098 c
, c
, target_charset (gdbarch
));
1102 /* Print the character C on STREAM as part of the contents of a literal
1103 string whose delimiter is QUOTER. Note that this routine should only
1104 be called for printing things which are independent of the language
1105 of the program being debugged.
1107 printchar will normally escape backslashes and instances of QUOTER. If
1108 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1109 As a side effect, if you pass the backslash character as the QUOTER,
1110 printchar will escape backslashes as usual, but not any other quoting
1114 printchar (int c
, do_fputc_ftype do_fputc
, ui_file
*stream
, int quoter
)
1116 c
&= 0xFF; /* Avoid sign bit follies */
1118 if (c
< 0x20 || /* Low control chars */
1119 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1120 (sevenbit_strings
&& c
>= 0x80))
1121 { /* high order bit set */
1122 do_fputc ('\\', stream
);
1127 do_fputc ('n', stream
);
1130 do_fputc ('b', stream
);
1133 do_fputc ('t', stream
);
1136 do_fputc ('f', stream
);
1139 do_fputc ('r', stream
);
1142 do_fputc ('e', stream
);
1145 do_fputc ('a', stream
);
1149 do_fputc ('0' + ((c
>> 6) & 0x7), stream
);
1150 do_fputc ('0' + ((c
>> 3) & 0x7), stream
);
1151 do_fputc ('0' + ((c
>> 0) & 0x7), stream
);
1158 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1159 do_fputc ('\\', stream
);
1160 do_fputc (c
, stream
);
1164 /* Print the character C on STREAM as part of the contents of a
1165 literal string whose delimiter is QUOTER. Note that these routines
1166 should only be call for printing things which are independent of
1167 the language of the program being debugged. */
1170 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1173 printchar (*str
++, fputc_filtered
, stream
, quoter
);
1177 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1180 printchar (*str
++, fputc_unfiltered
, stream
, quoter
);
1184 fputstrn_filtered (const char *str
, int n
, int quoter
,
1185 struct ui_file
*stream
)
1187 for (int i
= 0; i
< n
; i
++)
1188 printchar (str
[i
], fputc_filtered
, stream
, quoter
);
1192 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1193 do_fputc_ftype do_fputc
, struct ui_file
*stream
)
1195 for (int i
= 0; i
< n
; i
++)
1196 printchar (str
[i
], do_fputc
, stream
, quoter
);
1200 /* Number of lines per page or UINT_MAX if paging is disabled. */
1201 static unsigned int lines_per_page
;
1203 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1204 struct cmd_list_element
*c
, const char *value
)
1206 fprintf_filtered (file
,
1207 _("Number of lines gdb thinks are in a page is %s.\n"),
1211 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1212 static unsigned int chars_per_line
;
1214 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1215 struct cmd_list_element
*c
, const char *value
)
1217 fprintf_filtered (file
,
1218 _("Number of characters gdb thinks "
1219 "are in a line is %s.\n"),
1223 /* Current count of lines printed on this page, chars on this line. */
1224 static unsigned int lines_printed
, chars_printed
;
1226 /* True if pagination is disabled for just one command. */
1228 static bool pagination_disabled_for_command
;
1230 /* Buffer and start column of buffered text, for doing smarter word-
1231 wrapping. When someone calls wrap_here(), we start buffering output
1232 that comes through fputs_filtered(). If we see a newline, we just
1233 spit it out and forget about the wrap_here(). If we see another
1234 wrap_here(), we spit it out and remember the newer one. If we see
1235 the end of the line, we spit out a newline, the indent, and then
1236 the buffered output. */
1238 static bool filter_initialized
= false;
1240 /* Contains characters which are waiting to be output (they have
1241 already been counted in chars_printed). */
1242 static std::string wrap_buffer
;
1244 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1246 static const char *wrap_indent
;
1248 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1249 is not in effect. */
1250 static int wrap_column
;
1252 /* The style applied at the time that wrap_here was called. */
1253 static ui_file_style wrap_style
;
1256 /* Initialize the number of lines per page and chars per line. */
1259 init_page_info (void)
1263 lines_per_page
= UINT_MAX
;
1264 chars_per_line
= UINT_MAX
;
1268 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1273 #if defined(__GO32__)
1274 rows
= ScreenRows ();
1275 cols
= ScreenCols ();
1276 lines_per_page
= rows
;
1277 chars_per_line
= cols
;
1279 /* Make sure Readline has initialized its terminal settings. */
1280 rl_reset_terminal (NULL
);
1282 /* Get the screen size from Readline. */
1283 rl_get_screen_size (&rows
, &cols
);
1284 lines_per_page
= rows
;
1285 chars_per_line
= cols
;
1287 /* Readline should have fetched the termcap entry for us.
1288 Only try to use tgetnum function if rl_get_screen_size
1289 did not return a useful value. */
1290 if (((rows
<= 0) && (tgetnum ((char *) "li") < 0))
1291 /* Also disable paging if inside Emacs. $EMACS was used
1292 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1293 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1295 /* The number of lines per page is not mentioned in the terminal
1296 description or EMACS environment variable is set. This probably
1297 means that paging is not useful, so disable paging. */
1298 lines_per_page
= UINT_MAX
;
1301 /* If the output is not a terminal, don't paginate it. */
1302 if (!gdb_stdout
->isatty ())
1303 lines_per_page
= UINT_MAX
;
1307 /* We handle SIGWINCH ourselves. */
1308 rl_catch_sigwinch
= 0;
1314 /* Return nonzero if filtered printing is initialized. */
1316 filtered_printing_initialized (void)
1318 return filter_initialized
;
1321 set_batch_flag_and_restore_page_info::set_batch_flag_and_restore_page_info ()
1322 : m_save_lines_per_page (lines_per_page
),
1323 m_save_chars_per_line (chars_per_line
),
1324 m_save_batch_flag (batch_flag
)
1330 set_batch_flag_and_restore_page_info::~set_batch_flag_and_restore_page_info ()
1332 batch_flag
= m_save_batch_flag
;
1333 chars_per_line
= m_save_chars_per_line
;
1334 lines_per_page
= m_save_lines_per_page
;
1340 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1343 set_screen_size (void)
1345 int rows
= lines_per_page
;
1346 int cols
= chars_per_line
;
1348 /* If we get 0 or negative ROWS or COLS, treat as "infinite" size.
1349 A negative number can be seen here with the "set width/height"
1350 commands and either:
1352 - the user specified "unlimited", which maps to UINT_MAX, or
1353 - the user specified some number between INT_MAX and UINT_MAX.
1355 Cap "infinity" to approximately sqrt(INT_MAX) so that we don't
1356 overflow in rl_set_screen_size, which multiplies rows and columns
1357 to compute the number of characters on the screen. */
1359 const int sqrt_int_max
= INT_MAX
>> (sizeof (int) * 8 / 2);
1361 if (rows
<= 0 || rows
> sqrt_int_max
)
1363 rows
= sqrt_int_max
;
1364 lines_per_page
= UINT_MAX
;
1367 if (cols
<= 0 || cols
> sqrt_int_max
)
1369 cols
= sqrt_int_max
;
1370 chars_per_line
= UINT_MAX
;
1373 /* Update Readline's idea of the terminal size. */
1374 rl_set_screen_size (rows
, cols
);
1377 /* Reinitialize WRAP_BUFFER. */
1382 if (chars_per_line
== 0)
1385 wrap_buffer
.clear ();
1386 filter_initialized
= true;
1390 set_width_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1397 set_height_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1405 set_screen_width_and_height (int width
, int height
)
1407 lines_per_page
= height
;
1408 chars_per_line
= width
;
1414 /* The currently applied style. */
1416 static ui_file_style applied_style
;
1418 /* Emit an ANSI style escape for STYLE. If STREAM is nullptr, emit to
1419 the wrap buffer; otherwise emit to STREAM. */
1422 emit_style_escape (const ui_file_style
&style
,
1423 struct ui_file
*stream
= nullptr)
1425 if (applied_style
!= style
)
1427 applied_style
= style
;
1429 if (stream
== nullptr)
1430 wrap_buffer
.append (style
.to_ansi ());
1432 stream
->puts (style
.to_ansi ().c_str ());
1436 /* Set the current output style. This will affect future uses of the
1437 _filtered output functions. */
1440 set_output_style (struct ui_file
*stream
, const ui_file_style
&style
)
1442 if (!stream
->can_emit_style_escape ())
1445 /* Note that we may not pass STREAM here, when we want to emit to
1446 the wrap buffer, not directly to STREAM. */
1447 if (stream
== gdb_stdout
)
1449 emit_style_escape (style
, stream
);
1455 reset_terminal_style (struct ui_file
*stream
)
1457 if (stream
->can_emit_style_escape ())
1459 /* Force the setting, regardless of what we think the setting
1460 might already be. */
1461 applied_style
= ui_file_style ();
1462 wrap_buffer
.append (applied_style
.to_ansi ());
1466 /* Wait, so the user can read what's on the screen. Prompt the user
1467 to continue by pressing RETURN. 'q' is also provided because
1468 telling users what to do in the prompt is more user-friendly than
1469 expecting them to think of Ctrl-C/SIGINT. */
1472 prompt_for_continue (void)
1474 char cont_prompt
[120];
1475 /* Used to add duration we waited for user to respond to
1476 prompt_for_continue_wait_time. */
1477 using namespace std::chrono
;
1478 steady_clock::time_point prompt_started
= steady_clock::now ();
1479 bool disable_pagination
= pagination_disabled_for_command
;
1481 /* Clear the current styling. */
1482 if (gdb_stdout
->can_emit_style_escape ())
1483 emit_style_escape (ui_file_style (), gdb_stdout
);
1485 if (annotation_level
> 1)
1486 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1488 strcpy (cont_prompt
,
1489 "--Type <RET> for more, q to quit, "
1490 "c to continue without paging--");
1491 if (annotation_level
> 1)
1492 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1494 /* We must do this *before* we call gdb_readline_wrapper, else it
1495 will eventually call us -- thinking that we're trying to print
1496 beyond the end of the screen. */
1497 reinitialize_more_filter ();
1499 scoped_input_handler prepare_input
;
1501 /* Call gdb_readline_wrapper, not readline, in order to keep an
1502 event loop running. */
1503 gdb::unique_xmalloc_ptr
<char> ignore (gdb_readline_wrapper (cont_prompt
));
1505 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1506 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1508 if (annotation_level
> 1)
1509 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1513 char *p
= ignore
.get ();
1515 while (*p
== ' ' || *p
== '\t')
1518 /* Do not call quit here; there is no possibility of SIGINT. */
1519 throw_quit ("Quit");
1521 disable_pagination
= true;
1524 /* Now we have to do this again, so that GDB will know that it doesn't
1525 need to save the ---Type <return>--- line at the top of the screen. */
1526 reinitialize_more_filter ();
1527 pagination_disabled_for_command
= disable_pagination
;
1529 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1532 /* Initialize timer to keep track of how long we waited for the user. */
1535 reset_prompt_for_continue_wait_time (void)
1537 using namespace std::chrono
;
1539 prompt_for_continue_wait_time
= steady_clock::duration::zero ();
1542 /* Fetch the cumulative time spent in prompt_for_continue. */
1544 std::chrono::steady_clock::duration
1545 get_prompt_for_continue_wait_time ()
1547 return prompt_for_continue_wait_time
;
1550 /* Reinitialize filter; ie. tell it to reset to original values. */
1553 reinitialize_more_filter (void)
1557 pagination_disabled_for_command
= false;
1560 /* Flush the wrap buffer to STREAM, if necessary. */
1563 flush_wrap_buffer (struct ui_file
*stream
)
1565 if (stream
== gdb_stdout
&& !wrap_buffer
.empty ())
1567 stream
->puts (wrap_buffer
.c_str ());
1568 wrap_buffer
.clear ();
1575 gdb_flush (struct ui_file
*stream
)
1577 flush_wrap_buffer (stream
);
1584 get_chars_per_line ()
1586 return chars_per_line
;
1589 /* Indicate that if the next sequence of characters overflows the line,
1590 a newline should be inserted here rather than when it hits the end.
1591 If INDENT is non-null, it is a string to be printed to indent the
1592 wrapped part on the next line. INDENT must remain accessible until
1593 the next call to wrap_here() or until a newline is printed through
1596 If the line is already overfull, we immediately print a newline and
1597 the indentation, and disable further wrapping.
1599 If we don't know the width of lines, but we know the page height,
1600 we must not wrap words, but should still keep track of newlines
1601 that were explicitly printed.
1603 INDENT should not contain tabs, as that will mess up the char count
1604 on the next line. FIXME.
1606 This routine is guaranteed to force out any output which has been
1607 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1608 used to force out output from the wrap_buffer. */
1611 wrap_here (const char *indent
)
1613 /* This should have been allocated, but be paranoid anyway. */
1614 gdb_assert (filter_initialized
);
1616 flush_wrap_buffer (gdb_stdout
);
1617 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1621 else if (chars_printed
>= chars_per_line
)
1623 puts_filtered ("\n");
1625 puts_filtered (indent
);
1630 wrap_column
= chars_printed
;
1634 wrap_indent
= indent
;
1635 wrap_style
= applied_style
;
1639 /* Print input string to gdb_stdout, filtered, with wrap,
1640 arranging strings in columns of n chars. String can be
1641 right or left justified in the column. Never prints
1642 trailing spaces. String should never be longer than
1643 width. FIXME: this could be useful for the EXAMINE
1644 command, which currently doesn't tabulate very well. */
1647 puts_filtered_tabular (char *string
, int width
, int right
)
1653 gdb_assert (chars_per_line
> 0);
1654 if (chars_per_line
== UINT_MAX
)
1656 fputs_filtered (string
, gdb_stdout
);
1657 fputs_filtered ("\n", gdb_stdout
);
1661 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1662 fputs_filtered ("\n", gdb_stdout
);
1664 if (width
>= chars_per_line
)
1665 width
= chars_per_line
- 1;
1667 stringlen
= strlen (string
);
1669 if (chars_printed
> 0)
1670 spaces
= width
- (chars_printed
- 1) % width
- 1;
1672 spaces
+= width
- stringlen
;
1674 spacebuf
= (char *) alloca (spaces
+ 1);
1675 spacebuf
[spaces
] = '\0';
1677 spacebuf
[spaces
] = ' ';
1679 fputs_filtered (spacebuf
, gdb_stdout
);
1680 fputs_filtered (string
, gdb_stdout
);
1684 /* Ensure that whatever gets printed next, using the filtered output
1685 commands, starts at the beginning of the line. I.e. if there is
1686 any pending output for the current line, flush it and start a new
1687 line. Otherwise do nothing. */
1692 if (chars_printed
> 0)
1694 puts_filtered ("\n");
1699 /* Like fputs but if FILTER is true, pause after every screenful.
1701 Regardless of FILTER can wrap at points other than the final
1702 character of a line.
1704 Unlike fputs, fputs_maybe_filtered does not return a value.
1705 It is OK for LINEBUFFER to be NULL, in which case just don't print
1708 Note that a longjmp to top level may occur in this routine (only if
1709 FILTER is true) (since prompt_for_continue may do so) so this
1710 routine should not be called when cleanups are not in place. */
1713 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1716 const char *lineptr
;
1718 if (linebuffer
== 0)
1721 /* Don't do any filtering if it is disabled. */
1722 if (stream
!= gdb_stdout
1723 || !pagination_enabled
1724 || pagination_disabled_for_command
1726 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
1727 || top_level_interpreter () == NULL
1728 || top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
1730 flush_wrap_buffer (stream
);
1731 stream
->puts (linebuffer
);
1736 = make_scope_exit ([&] ()
1738 wrap_buffer
.clear ();
1743 /* Go through and output each character. Show line extension
1744 when this is necessary; prompt user for new page when this is
1747 lineptr
= linebuffer
;
1750 /* Possible new page. Note that PAGINATION_DISABLED_FOR_COMMAND
1751 might be set during this loop, so we must continue to check
1753 if (filter
&& (lines_printed
>= lines_per_page
- 1)
1754 && !pagination_disabled_for_command
)
1755 prompt_for_continue ();
1757 while (*lineptr
&& *lineptr
!= '\n')
1761 /* Print a single line. */
1762 if (*lineptr
== '\t')
1764 wrap_buffer
.push_back ('\t');
1765 /* Shifting right by 3 produces the number of tab stops
1766 we have already passed, and then adding one and
1767 shifting left 3 advances to the next tab stop. */
1768 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
1771 else if (*lineptr
== '\033'
1772 && skip_ansi_escape (lineptr
, &skip_bytes
))
1774 wrap_buffer
.append (lineptr
, skip_bytes
);
1775 /* Note that we don't consider this a character, so we
1776 don't increment chars_printed here. */
1777 lineptr
+= skip_bytes
;
1779 else if (*lineptr
== '\r')
1781 wrap_buffer
.push_back (*lineptr
);
1787 wrap_buffer
.push_back (*lineptr
);
1792 if (chars_printed
>= chars_per_line
)
1794 unsigned int save_chars
= chars_printed
;
1796 /* If we change the style, below, we'll want to reset it
1797 before continuing to print. If there is no wrap
1798 column, then we'll only reset the style if the pager
1799 prompt is given; and to avoid emitting style
1800 sequences in the middle of a run of text, we track
1802 ui_file_style save_style
= applied_style
;
1803 bool did_paginate
= false;
1809 /* We are about to insert a newline at an historic
1810 location in the WRAP_BUFFER. Before we do we want to
1811 restore the default style. To know if we actually
1812 need to insert an escape sequence we must restore the
1813 current applied style to how it was at the WRAP_COLUMN
1815 applied_style
= wrap_style
;
1816 if (stream
->can_emit_style_escape ())
1817 emit_style_escape (ui_file_style (), stream
);
1818 /* If we aren't actually wrapping, don't output
1819 newline -- if chars_per_line is right, we
1820 probably just overflowed anyway; if it's wrong,
1821 let us keep going. */
1822 /* XXX: The ideal thing would be to call
1823 'stream->putc' here, but we can't because it
1824 currently calls 'fputc_unfiltered', which ends up
1825 calling us, which generates an infinite
1827 stream
->puts ("\n");
1830 flush_wrap_buffer (stream
);
1832 /* Possible new page. Note that
1833 PAGINATION_DISABLED_FOR_COMMAND might be set during
1834 this loop, so we must continue to check it here. */
1835 if (lines_printed
>= lines_per_page
- 1
1836 && !pagination_disabled_for_command
)
1838 prompt_for_continue ();
1839 did_paginate
= true;
1842 /* Now output indentation and wrapped string. */
1845 stream
->puts (wrap_indent
);
1847 /* Having finished inserting the wrapping we should
1848 restore the style as it was at the WRAP_COLUMN. */
1849 if (stream
->can_emit_style_escape ())
1850 emit_style_escape (wrap_style
, stream
);
1852 /* The WRAP_BUFFER will still contain content, and that
1853 content might set some alternative style. Restore
1854 APPLIED_STYLE as it was before we started wrapping,
1855 this reflects the current style for the last character
1857 applied_style
= save_style
;
1859 /* FIXME, this strlen is what prevents wrap_indent from
1860 containing tabs. However, if we recurse to print it
1861 and count its chars, we risk trouble if wrap_indent is
1862 longer than (the user settable) chars_per_line.
1863 Note also that this can set chars_printed > chars_per_line
1864 if we are printing a long string. */
1865 chars_printed
= strlen (wrap_indent
)
1866 + (save_chars
- wrap_column
);
1867 wrap_column
= 0; /* And disable fancy wrap */
1869 else if (did_paginate
&& stream
->can_emit_style_escape ())
1870 emit_style_escape (save_style
, stream
);
1874 if (*lineptr
== '\n')
1877 wrap_here ((char *) 0); /* Spit out chars, cancel
1880 /* XXX: The ideal thing would be to call
1881 'stream->putc' here, but we can't because it
1882 currently calls 'fputc_unfiltered', which ends up
1883 calling us, which generates an infinite
1885 stream
->puts ("\n");
1890 buffer_clearer
.release ();
1894 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
1896 fputs_maybe_filtered (linebuffer
, stream
, 1);
1900 fputs_unfiltered (const char *linebuffer
, struct ui_file
*stream
)
1902 fputs_maybe_filtered (linebuffer
, stream
, 0);
1908 fputs_styled (const char *linebuffer
, const ui_file_style
&style
,
1909 struct ui_file
*stream
)
1911 set_output_style (stream
, style
);
1912 fputs_maybe_filtered (linebuffer
, stream
, 1);
1913 set_output_style (stream
, ui_file_style ());
1919 fputs_styled_unfiltered (const char *linebuffer
, const ui_file_style
&style
,
1920 struct ui_file
*stream
)
1922 set_output_style (stream
, style
);
1923 fputs_maybe_filtered (linebuffer
, stream
, 0);
1924 set_output_style (stream
, ui_file_style ());
1930 fputs_highlighted (const char *str
, const compiled_regex
&highlight
,
1931 struct ui_file
*stream
)
1935 while (*str
&& highlight
.exec (str
, 1, &pmatch
, 0) == 0)
1937 size_t n_highlight
= pmatch
.rm_eo
- pmatch
.rm_so
;
1939 /* Output the part before pmatch with current style. */
1940 while (pmatch
.rm_so
> 0)
1942 fputc_filtered (*str
, stream
);
1947 /* Output pmatch with the highlight style. */
1948 set_output_style (stream
, highlight_style
.style ());
1949 while (n_highlight
> 0)
1951 fputc_filtered (*str
, stream
);
1955 set_output_style (stream
, ui_file_style ());
1958 /* Output the trailing part of STR not matching HIGHLIGHT. */
1960 fputs_filtered (str
, stream
);
1964 putchar_unfiltered (int c
)
1966 return fputc_unfiltered (c
, gdb_stdout
);
1969 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
1970 May return nonlocally. */
1973 putchar_filtered (int c
)
1975 return fputc_filtered (c
, gdb_stdout
);
1979 fputc_unfiltered (int c
, struct ui_file
*stream
)
1985 fputs_unfiltered (buf
, stream
);
1990 fputc_filtered (int c
, struct ui_file
*stream
)
1996 fputs_filtered (buf
, stream
);
2000 /* puts_debug is like fputs_unfiltered, except it prints special
2001 characters in printable fashion. */
2004 puts_debug (char *prefix
, char *string
, char *suffix
)
2008 /* Print prefix and suffix after each line. */
2009 static int new_line
= 1;
2010 static int return_p
= 0;
2011 static const char *prev_prefix
= "";
2012 static const char *prev_suffix
= "";
2014 if (*string
== '\n')
2017 /* If the prefix is changing, print the previous suffix, a new line,
2018 and the new prefix. */
2019 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
2021 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
2022 fputs_unfiltered ("\n", gdb_stdlog
);
2023 fputs_unfiltered (prefix
, gdb_stdlog
);
2026 /* Print prefix if we printed a newline during the previous call. */
2030 fputs_unfiltered (prefix
, gdb_stdlog
);
2033 prev_prefix
= prefix
;
2034 prev_suffix
= suffix
;
2036 /* Output characters in a printable format. */
2037 while ((ch
= *string
++) != '\0')
2042 if (gdb_isprint (ch
))
2043 fputc_unfiltered (ch
, gdb_stdlog
);
2046 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2050 fputs_unfiltered ("\\\\", gdb_stdlog
);
2053 fputs_unfiltered ("\\b", gdb_stdlog
);
2056 fputs_unfiltered ("\\f", gdb_stdlog
);
2060 fputs_unfiltered ("\\n", gdb_stdlog
);
2063 fputs_unfiltered ("\\r", gdb_stdlog
);
2066 fputs_unfiltered ("\\t", gdb_stdlog
);
2069 fputs_unfiltered ("\\v", gdb_stdlog
);
2073 return_p
= ch
== '\r';
2076 /* Print suffix if we printed a newline. */
2079 fputs_unfiltered (suffix
, gdb_stdlog
);
2080 fputs_unfiltered ("\n", gdb_stdlog
);
2085 /* Print a variable number of ARGS using format FORMAT. If this
2086 information is going to put the amount written (since the last call
2087 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2088 call prompt_for_continue to get the users permission to continue.
2090 Unlike fprintf, this function does not return a value.
2092 We implement three variants, vfprintf (takes a vararg list and stream),
2093 fprintf (takes a stream to write on), and printf (the usual).
2095 Note also that this may throw a quit (since prompt_for_continue may
2099 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2100 va_list args
, bool filter
, bool gdbfmt
)
2104 ui_out_flags flags
= disallow_ui_out_field
;
2106 flags
|= unfiltered_output
;
2107 cli_ui_out (stream
, flags
).vmessage (applied_style
, format
, args
);
2111 std::string str
= string_vprintf (format
, args
);
2112 fputs_maybe_filtered (str
.c_str (), stream
, filter
);
2118 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2120 vfprintf_maybe_filtered (stream
, format
, args
, true, true);
2124 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2126 if (debug_timestamp
&& stream
== gdb_stdlog
)
2128 static bool needs_timestamp
= true;
2130 /* Print timestamp if previous print ended with a \n. */
2131 if (needs_timestamp
)
2133 using namespace std::chrono
;
2135 steady_clock::time_point now
= steady_clock::now ();
2136 seconds s
= duration_cast
<seconds
> (now
.time_since_epoch ());
2137 microseconds us
= duration_cast
<microseconds
> (now
.time_since_epoch () - s
);
2138 std::string timestamp
= string_printf ("%ld.%06ld ",
2140 (long) us
.count ());
2141 fputs_unfiltered (timestamp
.c_str (), stream
);
2144 /* Print the message. */
2146 cli_ui_out (&sfile
, 0).vmessage (ui_file_style (), format
, args
);
2147 std::string linebuffer
= std::move (sfile
.string ());
2148 fputs_unfiltered (linebuffer
.c_str (), stream
);
2150 size_t len
= linebuffer
.length ();
2151 needs_timestamp
= (len
> 0 && linebuffer
[len
- 1] == '\n');
2154 vfprintf_maybe_filtered (stream
, format
, args
, false, true);
2158 vprintf_filtered (const char *format
, va_list args
)
2160 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, true, false);
2164 vprintf_unfiltered (const char *format
, va_list args
)
2166 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2170 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2174 va_start (args
, format
);
2175 vfprintf_filtered (stream
, format
, args
);
2180 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2184 va_start (args
, format
);
2185 vfprintf_unfiltered (stream
, format
, args
);
2192 fprintf_styled (struct ui_file
*stream
, const ui_file_style
&style
,
2193 const char *format
, ...)
2197 set_output_style (stream
, style
);
2198 va_start (args
, format
);
2199 vfprintf_filtered (stream
, format
, args
);
2201 set_output_style (stream
, ui_file_style ());
2207 vfprintf_styled (struct ui_file
*stream
, const ui_file_style
&style
,
2208 const char *format
, va_list args
)
2210 set_output_style (stream
, style
);
2211 vfprintf_filtered (stream
, format
, args
);
2212 set_output_style (stream
, ui_file_style ());
2218 vfprintf_styled_no_gdbfmt (struct ui_file
*stream
, const ui_file_style
&style
,
2219 bool filter
, const char *format
, va_list args
)
2221 std::string str
= string_vprintf (format
, args
);
2224 set_output_style (stream
, style
);
2225 fputs_maybe_filtered (str
.c_str (), stream
, filter
);
2226 set_output_style (stream
, ui_file_style ());
2231 printf_filtered (const char *format
, ...)
2235 va_start (args
, format
);
2236 vfprintf_filtered (gdb_stdout
, format
, args
);
2242 printf_unfiltered (const char *format
, ...)
2246 va_start (args
, format
);
2247 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2251 /* Easy -- but watch out!
2253 This routine is *not* a replacement for puts()! puts() appends a newline.
2254 This one doesn't, and had better not! */
2257 puts_filtered (const char *string
)
2259 fputs_filtered (string
, gdb_stdout
);
2263 puts_unfiltered (const char *string
)
2265 fputs_unfiltered (string
, gdb_stdout
);
2268 /* Return a pointer to N spaces and a null. The pointer is good
2269 until the next call to here. */
2274 static char *spaces
= 0;
2275 static int max_spaces
= -1;
2280 spaces
= (char *) xmalloc (n
+ 1);
2281 for (t
= spaces
+ n
; t
!= spaces
;)
2287 return spaces
+ max_spaces
- n
;
2290 /* Print N spaces. */
2292 print_spaces_filtered (int n
, struct ui_file
*stream
)
2294 fputs_filtered (n_spaces (n
), stream
);
2297 /* C++/ObjC demangler stuff. */
2299 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2300 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2301 If the name is not mangled, or the language for the name is unknown, or
2302 demangling is off, the name is printed in its "raw" form. */
2305 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2306 enum language lang
, int arg_mode
)
2312 /* If user wants to see raw output, no problem. */
2315 fputs_filtered (name
, stream
);
2319 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2320 fputs_filtered (demangled
? demangled
: name
, stream
);
2321 if (demangled
!= NULL
)
2329 /* True if CH is a character that can be part of a symbol name. I.e.,
2330 either a number, a letter, or a '_'. */
2333 valid_identifier_name_char (int ch
)
2335 return (ISALNUM (ch
) || ch
== '_');
2338 /* Skip to end of token, or to END, whatever comes first. Input is
2339 assumed to be a C++ operator name. */
2342 cp_skip_operator_token (const char *token
, const char *end
)
2344 const char *p
= token
;
2345 while (p
!= end
&& !ISSPACE (*p
) && *p
!= '(')
2347 if (valid_identifier_name_char (*p
))
2349 while (p
!= end
&& valid_identifier_name_char (*p
))
2355 /* Note, ordered such that among ops that share a prefix,
2356 longer comes first. This is so that the loop below can
2357 bail on first match. */
2358 static const char *ops
[] =
2364 "-=", "--", "->", "-",
2373 "<<=", "<=", "<<", "<",
2374 ">>=", ">=", ">>", ">",
2378 for (const char *op
: ops
)
2380 size_t oplen
= strlen (op
);
2381 size_t lencmp
= std::min
<size_t> (oplen
, end
- p
);
2383 if (strncmp (p
, op
, lencmp
) == 0)
2386 /* Some unidentified character. Return it. */
2394 /* Advance STRING1/STRING2 past whitespace. */
2397 skip_ws (const char *&string1
, const char *&string2
, const char *end_str2
)
2399 while (ISSPACE (*string1
))
2401 while (string2
< end_str2
&& ISSPACE (*string2
))
2405 /* True if STRING points at the start of a C++ operator name. START
2406 is the start of the string that STRING points to, hence when
2407 reading backwards, we must not read any character before START. */
2410 cp_is_operator (const char *string
, const char *start
)
2412 return ((string
== start
2413 || !valid_identifier_name_char (string
[-1]))
2414 && strncmp (string
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
2415 && !valid_identifier_name_char (string
[CP_OPERATOR_LEN
]));
2418 /* If *NAME points at an ABI tag, skip it and return true. Otherwise
2419 leave *NAME unmodified and return false. (see GCC's abi_tag
2420 attribute), such names are demangled as e.g.,
2421 "function[abi:cxx11]()". */
2424 skip_abi_tag (const char **name
)
2426 const char *p
= *name
;
2428 if (startswith (p
, "[abi:"))
2432 while (valid_identifier_name_char (*p
))
2448 strncmp_iw_with_mode (const char *string1
, const char *string2
,
2449 size_t string2_len
, strncmp_iw_mode mode
,
2450 enum language language
,
2451 completion_match_for_lcd
*match_for_lcd
)
2453 const char *string1_start
= string1
;
2454 const char *end_str2
= string2
+ string2_len
;
2455 bool skip_spaces
= true;
2456 bool have_colon_op
= (language
== language_cplus
2457 || language
== language_rust
2458 || language
== language_fortran
);
2463 || ((ISSPACE (*string1
) && !valid_identifier_name_char (*string2
))
2464 || (ISSPACE (*string2
) && !valid_identifier_name_char (*string1
))))
2466 skip_ws (string1
, string2
, end_str2
);
2467 skip_spaces
= false;
2470 /* Skip [abi:cxx11] tags in the symbol name if the lookup name
2471 doesn't include them. E.g.:
2473 string1: function[abi:cxx1](int)
2476 string1: function[abi:cxx1](int)
2477 string2: function(int)
2479 string1: Struct[abi:cxx1]::function()
2480 string2: Struct::function()
2482 string1: function(Struct[abi:cxx1], int)
2483 string2: function(Struct, int)
2485 if (string2
== end_str2
2486 || (*string2
!= '[' && !valid_identifier_name_char (*string2
)))
2488 const char *abi_start
= string1
;
2490 /* There can be more than one tag. */
2491 while (*string1
== '[' && skip_abi_tag (&string1
))
2494 if (match_for_lcd
!= NULL
&& abi_start
!= string1
)
2495 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2497 while (ISSPACE (*string1
))
2501 if (*string1
== '\0' || string2
== end_str2
)
2504 /* Handle the :: operator. */
2505 if (have_colon_op
&& string1
[0] == ':' && string1
[1] == ':')
2507 if (*string2
!= ':')
2513 if (string2
== end_str2
)
2516 if (*string2
!= ':')
2522 while (ISSPACE (*string1
))
2524 while (string2
< end_str2
&& ISSPACE (*string2
))
2529 /* Handle C++ user-defined operators. */
2530 else if (language
== language_cplus
2533 if (cp_is_operator (string1
, string1_start
))
2535 /* An operator name in STRING1. Check STRING2. */
2537 = std::min
<size_t> (CP_OPERATOR_LEN
, end_str2
- string2
);
2538 if (strncmp (string1
, string2
, cmplen
) != 0)
2544 if (string2
!= end_str2
)
2546 /* Check for "operatorX" in STRING2. */
2547 if (valid_identifier_name_char (*string2
))
2550 skip_ws (string1
, string2
, end_str2
);
2553 /* Handle operator(). */
2554 if (*string1
== '(')
2556 if (string2
== end_str2
)
2558 if (mode
== strncmp_iw_mode::NORMAL
)
2562 /* Don't break for the regular return at the
2563 bottom, because "operator" should not
2564 match "operator()", since this open
2565 parentheses is not the parameter list
2567 return *string1
!= '\0';
2571 if (*string1
!= *string2
)
2580 skip_ws (string1
, string2
, end_str2
);
2582 /* Skip to end of token, or to END, whatever comes
2584 const char *end_str1
= string1
+ strlen (string1
);
2585 const char *p1
= cp_skip_operator_token (string1
, end_str1
);
2586 const char *p2
= cp_skip_operator_token (string2
, end_str2
);
2588 cmplen
= std::min (p1
- string1
, p2
- string2
);
2591 if (strncmp (string1
, string2
, cmplen
) != 0)
2596 if (p1
- string1
!= p2
- string2
)
2598 if (strncmp (string1
, string2
, cmplen
) != 0)
2605 if (*string1
== '\0' || string2
== end_str2
)
2607 if (*string1
== '(' || *string2
== '(')
2615 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2617 if (case_sensitivity
== case_sensitive_off
2618 && (TOLOWER ((unsigned char) *string1
)
2619 != TOLOWER ((unsigned char) *string2
)))
2622 /* If we see any non-whitespace, non-identifier-name character
2623 (any of "()<>*&" etc.), then skip spaces the next time
2625 if (!ISSPACE (*string1
) && !valid_identifier_name_char (*string1
))
2632 if (string2
== end_str2
)
2634 if (mode
== strncmp_iw_mode::NORMAL
)
2636 /* Strip abi tag markers from the matched symbol name.
2637 Usually the ABI marker will be found on function name
2638 (automatically added because the function returns an
2639 object marked with an ABI tag). However, it's also
2640 possible to see a marker in one of the function
2641 parameters, for example.
2643 string2 (lookup name):
2646 function(some_struct[abi:cxx11], int)
2648 and for completion LCD computation we want to say that
2650 function(some_struct, int)
2652 if (match_for_lcd
!= NULL
)
2654 while ((string1
= strstr (string1
, "[abi:")) != NULL
)
2656 const char *abi_start
= string1
;
2658 /* There can be more than one tag. */
2659 while (skip_abi_tag (&string1
) && *string1
== '[')
2662 if (abi_start
!= string1
)
2663 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2670 return (*string1
!= '\0' && *string1
!= '(');
2679 strncmp_iw (const char *string1
, const char *string2
, size_t string2_len
)
2681 return strncmp_iw_with_mode (string1
, string2
, string2_len
,
2682 strncmp_iw_mode::NORMAL
, language_minimal
);
2688 strcmp_iw (const char *string1
, const char *string2
)
2690 return strncmp_iw_with_mode (string1
, string2
, strlen (string2
),
2691 strncmp_iw_mode::MATCH_PARAMS
, language_minimal
);
2694 /* This is like strcmp except that it ignores whitespace and treats
2695 '(' as the first non-NULL character in terms of ordering. Like
2696 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2697 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2698 according to that ordering.
2700 If a list is sorted according to this function and if you want to
2701 find names in the list that match some fixed NAME according to
2702 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2703 where this function would put NAME.
2705 This function must be neutral to the CASE_SENSITIVITY setting as the user
2706 may choose it during later lookup. Therefore this function always sorts
2707 primarily case-insensitively and secondarily case-sensitively.
2709 Here are some examples of why using strcmp to sort is a bad idea:
2713 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2714 we try to do a search for "foo<char*>", strcmp will locate this
2715 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2716 will start looking at strings beginning with "goo", and will never
2717 see the correct match of "foo<char *>".
2719 Parenthesis example:
2721 In practice, this is less like to be an issue, but I'll give it a
2722 shot. Let's assume that '$' is a legitimate character to occur in
2723 symbols. (Which may well even be the case on some systems.) Then
2724 say that the partial symbol table contains "foo$" and "foo(int)".
2725 strcmp will put them in this order, since '$' < '('. Now, if the
2726 user searches for "foo", then strcmp will sort "foo" before "foo$".
2727 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2728 "foo") is false, so it won't proceed to the actual match of
2729 "foo(int)" with "foo". */
2732 strcmp_iw_ordered (const char *string1
, const char *string2
)
2734 const char *saved_string1
= string1
, *saved_string2
= string2
;
2735 enum case_sensitivity case_pass
= case_sensitive_off
;
2739 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2740 Provide stub characters if we are already at the end of one of the
2742 char c1
= 'X', c2
= 'X';
2744 while (*string1
!= '\0' && *string2
!= '\0')
2746 while (ISSPACE (*string1
))
2748 while (ISSPACE (*string2
))
2753 case case_sensitive_off
:
2754 c1
= TOLOWER ((unsigned char) *string1
);
2755 c2
= TOLOWER ((unsigned char) *string2
);
2757 case case_sensitive_on
:
2765 if (*string1
!= '\0')
2774 /* Characters are non-equal unless they're both '\0'; we want to
2775 make sure we get the comparison right according to our
2776 comparison in the cases where one of them is '\0' or '('. */
2778 if (*string2
== '\0')
2783 if (*string2
== '\0')
2788 if (*string2
== '\0' || *string2
== '(')
2797 if (case_pass
== case_sensitive_on
)
2800 /* Otherwise the strings were equal in case insensitive way, make
2801 a more fine grained comparison in a case sensitive way. */
2803 case_pass
= case_sensitive_on
;
2804 string1
= saved_string1
;
2805 string2
= saved_string2
;
2812 streq (const char *lhs
, const char *rhs
)
2814 return !strcmp (lhs
, rhs
);
2821 ** Answer whether string_to_compare is a full or partial match to
2822 ** template_string. The partial match must be in sequence starting
2826 subset_compare (const char *string_to_compare
, const char *template_string
)
2830 if (template_string
!= NULL
&& string_to_compare
!= NULL
2831 && strlen (string_to_compare
) <= strlen (template_string
))
2833 (startswith (template_string
, string_to_compare
));
2840 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2841 struct cmd_list_element
*c
, const char *value
)
2843 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2851 address_significant (gdbarch
*gdbarch
, CORE_ADDR addr
)
2853 /* Clear insignificant bits of a target address and sign extend resulting
2854 address, avoiding shifts larger or equal than the width of a CORE_ADDR.
2855 The local variable ADDR_BIT stops the compiler reporting a shift overflow
2856 when it won't occur. Skip updating of target address if current target
2857 has not set gdbarch significant_addr_bit. */
2858 int addr_bit
= gdbarch_significant_addr_bit (gdbarch
);
2860 if (addr_bit
&& (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
)))
2862 CORE_ADDR sign
= (CORE_ADDR
) 1 << (addr_bit
- 1);
2863 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2864 addr
= (addr
^ sign
) - sign
;
2871 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2873 /* Truncate address to the size of a target address, avoiding shifts
2874 larger or equal than the width of a CORE_ADDR. The local
2875 variable ADDR_BIT stops the compiler reporting a shift overflow
2876 when it won't occur. */
2877 /* NOTE: This assumes that the significant address information is
2878 kept in the least significant bits of ADDR - the upper bits were
2879 either zero or sign extended. Should gdbarch_address_to_pointer or
2880 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2882 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2884 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2885 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2886 return hex_string (addr
);
2889 /* This function is described in "defs.h". */
2892 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2894 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2896 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2897 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2899 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2900 that returns the language localized string formatted to a width
2901 based on gdbarch_addr_bit. */
2903 return hex_string_custom (address
, 8);
2905 return hex_string_custom (address
, 16);
2908 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2911 core_addr_hash (const void *ap
)
2913 const CORE_ADDR
*addrp
= (const CORE_ADDR
*) ap
;
2918 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2921 core_addr_eq (const void *ap
, const void *bp
)
2923 const CORE_ADDR
*addr_ap
= (const CORE_ADDR
*) ap
;
2924 const CORE_ADDR
*addr_bp
= (const CORE_ADDR
*) bp
;
2926 return *addr_ap
== *addr_bp
;
2929 /* Convert a string back into a CORE_ADDR. */
2931 string_to_core_addr (const char *my_string
)
2935 if (my_string
[0] == '0' && TOLOWER (my_string
[1]) == 'x')
2937 /* Assume that it is in hex. */
2940 for (i
= 2; my_string
[i
] != '\0'; i
++)
2942 if (ISDIGIT (my_string
[i
]))
2943 addr
= (my_string
[i
] - '0') + (addr
* 16);
2944 else if (ISXDIGIT (my_string
[i
]))
2945 addr
= (TOLOWER (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2947 error (_("invalid hex \"%s\""), my_string
);
2952 /* Assume that it is in decimal. */
2955 for (i
= 0; my_string
[i
] != '\0'; i
++)
2957 if (ISDIGIT (my_string
[i
]))
2958 addr
= (my_string
[i
] - '0') + (addr
* 10);
2960 error (_("invalid decimal \"%s\""), my_string
);
2970 gdb_realpath_check_trailer (const char *input
, const char *trailer
)
2972 gdb::unique_xmalloc_ptr
<char> result
= gdb_realpath (input
);
2974 size_t len
= strlen (result
.get ());
2975 size_t trail_len
= strlen (trailer
);
2977 SELF_CHECK (len
>= trail_len
2978 && strcmp (result
.get () + len
- trail_len
, trailer
) == 0);
2982 gdb_realpath_tests ()
2984 /* A file which contains a directory prefix. */
2985 gdb_realpath_check_trailer ("./xfullpath.exp", "/xfullpath.exp");
2986 /* A file which contains a directory prefix. */
2987 gdb_realpath_check_trailer ("../../defs.h", "/defs.h");
2988 /* A one-character filename. */
2989 gdb_realpath_check_trailer ("./a", "/a");
2990 /* A file in the root directory. */
2991 gdb_realpath_check_trailer ("/root_file_which_should_exist",
2992 "/root_file_which_should_exist");
2993 /* A file which does not have a directory prefix. */
2994 gdb_realpath_check_trailer ("xfullpath.exp", "xfullpath.exp");
2995 /* A one-char filename without any directory prefix. */
2996 gdb_realpath_check_trailer ("a", "a");
2997 /* An empty filename. */
2998 gdb_realpath_check_trailer ("", "");
3001 /* Test the gdb_argv::as_array_view method. */
3004 gdb_argv_as_array_view_test ()
3009 gdb::array_view
<char *> view
= argv
.as_array_view ();
3011 SELF_CHECK (view
.data () == nullptr);
3012 SELF_CHECK (view
.size () == 0);
3015 gdb_argv
argv ("une bonne 50");
3017 gdb::array_view
<char *> view
= argv
.as_array_view ();
3019 SELF_CHECK (view
.size () == 3);
3020 SELF_CHECK (strcmp (view
[0], "une") == 0);
3021 SELF_CHECK (strcmp (view
[1], "bonne") == 0);
3022 SELF_CHECK (strcmp (view
[2], "50") == 0);
3026 #endif /* GDB_SELF_TEST */
3028 /* Allocation function for the libiberty hash table which uses an
3029 obstack. The obstack is passed as DATA. */
3032 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
3034 size_t total
= size
* count
;
3035 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
3037 memset (ptr
, 0, total
);
3041 /* Trivial deallocation function for the libiberty splay tree and hash
3042 table - don't deallocate anything. Rely on later deletion of the
3043 obstack. DATA will be the obstack, although it is not needed
3047 dummy_obstack_deallocate (void *object
, void *data
)
3052 /* Simple, portable version of dirname that does not modify its
3056 ldirname (const char *filename
)
3058 std::string dirname
;
3059 const char *base
= lbasename (filename
);
3061 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
3064 if (base
== filename
)
3067 dirname
= std::string (filename
, base
- filename
);
3069 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3070 create "d:./bar" later instead of the (different) "d:/bar". */
3071 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3072 && !IS_DIR_SEPARATOR (filename
[0]))
3073 dirname
[base
++ - filename
] = '.';
3081 gdb_argv::reset (const char *s
)
3083 char **argv
= buildargv (s
);
3089 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3090 #define AMBIGUOUS_MESS2 \
3091 ".\nUse \"set gnutarget format-name\" to specify the format."
3094 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3098 /* Check if errmsg just need simple return. */
3099 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3100 return bfd_errmsg (error_tag
);
3102 std::string
ret (bfd_errmsg (error_tag
));
3103 ret
+= AMBIGUOUS_MESS1
;
3105 for (p
= matching
; *p
; p
++)
3110 ret
+= AMBIGUOUS_MESS2
;
3117 /* Return ARGS parsed as a valid pid, or throw an error. */
3120 parse_pid_to_attach (const char *args
)
3126 error_no_arg (_("process-id to attach"));
3128 dummy
= (char *) args
;
3129 pid
= strtoul (args
, &dummy
, 0);
3130 /* Some targets don't set errno on errors, grrr! */
3131 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3132 error (_("Illegal process-id: %s."), args
);
3137 /* Substitute all occurrences of string FROM by string TO in *STRINGP. *STRINGP
3138 must come from xrealloc-compatible allocator and it may be updated. FROM
3139 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3140 located at the start or end of *STRINGP. */
3143 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3145 char *string
= *stringp
, *s
;
3146 const size_t from_len
= strlen (from
);
3147 const size_t to_len
= strlen (to
);
3151 s
= strstr (s
, from
);
3155 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3156 || s
[-1] == DIRNAME_SEPARATOR
)
3157 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3158 || s
[from_len
] == DIRNAME_SEPARATOR
))
3163 = (char *) xrealloc (string
, (strlen (string
) + to_len
+ 1));
3165 /* Relocate the current S pointer. */
3166 s
= s
- string
+ string_new
;
3167 string
= string_new
;
3169 /* Replace from by to. */
3170 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3171 memcpy (s
, to
, to_len
);
3186 /* SIGALRM handler for waitpid_with_timeout. */
3189 sigalrm_handler (int signo
)
3191 /* Nothing to do. */
3196 /* Wrapper to wait for child PID to die with TIMEOUT.
3197 TIMEOUT is the time to stop waiting in seconds.
3198 If TIMEOUT is zero, pass WNOHANG to waitpid.
3199 Returns PID if it was successfully waited for, otherwise -1.
3201 Timeouts are currently implemented with alarm and SIGALRM.
3202 If the host does not support them, this waits "forever".
3203 It would be odd though for a host to have waitpid and not SIGALRM. */
3206 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3208 pid_t waitpid_result
;
3210 gdb_assert (pid
> 0);
3211 gdb_assert (timeout
>= 0);
3216 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3217 struct sigaction sa
, old_sa
;
3219 sa
.sa_handler
= sigalrm_handler
;
3220 sigemptyset (&sa
.sa_mask
);
3222 sigaction (SIGALRM
, &sa
, &old_sa
);
3226 ofunc
= signal (SIGALRM
, sigalrm_handler
);
3232 waitpid_result
= waitpid (pid
, status
, 0);
3236 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3237 sigaction (SIGALRM
, &old_sa
, NULL
);
3239 signal (SIGALRM
, ofunc
);
3244 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3246 if (waitpid_result
== pid
)
3252 #endif /* HAVE_WAITPID */
3254 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3255 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3257 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3258 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3261 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3263 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3265 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3266 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3268 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3270 char *pattern_slash
, *string_slash
;
3272 /* Replace '\' by '/' in both strings. */
3274 pattern_slash
= (char *) alloca (strlen (pattern
) + 1);
3275 strcpy (pattern_slash
, pattern
);
3276 pattern
= pattern_slash
;
3277 for (; *pattern_slash
!= 0; pattern_slash
++)
3278 if (IS_DIR_SEPARATOR (*pattern_slash
))
3279 *pattern_slash
= '/';
3281 string_slash
= (char *) alloca (strlen (string
) + 1);
3282 strcpy (string_slash
, string
);
3283 string
= string_slash
;
3284 for (; *string_slash
!= 0; string_slash
++)
3285 if (IS_DIR_SEPARATOR (*string_slash
))
3286 *string_slash
= '/';
3288 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3290 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3291 flags
|= FNM_CASEFOLD
;
3292 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3294 return fnmatch (pattern
, string
, flags
);
3297 /* Return the number of path elements in PATH.
3305 count_path_elements (const char *path
)
3308 const char *p
= path
;
3310 if (HAS_DRIVE_SPEC (p
))
3312 p
= STRIP_DRIVE_SPEC (p
);
3318 if (IS_DIR_SEPARATOR (*p
))
3323 /* Backup one if last character is /, unless it's the only one. */
3324 if (p
> path
+ 1 && IS_DIR_SEPARATOR (p
[-1]))
3327 /* Add one for the file name, if present. */
3328 if (p
> path
&& !IS_DIR_SEPARATOR (p
[-1]))
3334 /* Remove N leading path elements from PATH.
3335 N must be non-negative.
3336 If PATH has more than N path elements then return NULL.
3337 If PATH has exactly N path elements then return "".
3338 See count_path_elements for a description of how we do the counting. */
3341 strip_leading_path_elements (const char *path
, int n
)
3344 const char *p
= path
;
3346 gdb_assert (n
>= 0);
3351 if (HAS_DRIVE_SPEC (p
))
3353 p
= STRIP_DRIVE_SPEC (p
);
3359 while (*p
!= '\0' && !IS_DIR_SEPARATOR (*p
))
3377 copy_bitwise (gdb_byte
*dest
, ULONGEST dest_offset
,
3378 const gdb_byte
*source
, ULONGEST source_offset
,
3379 ULONGEST nbits
, int bits_big_endian
)
3381 unsigned int buf
, avail
;
3386 if (bits_big_endian
)
3388 /* Start from the end, then work backwards. */
3389 dest_offset
+= nbits
- 1;
3390 dest
+= dest_offset
/ 8;
3391 dest_offset
= 7 - dest_offset
% 8;
3392 source_offset
+= nbits
- 1;
3393 source
+= source_offset
/ 8;
3394 source_offset
= 7 - source_offset
% 8;
3398 dest
+= dest_offset
/ 8;
3400 source
+= source_offset
/ 8;
3404 /* Fill BUF with DEST_OFFSET bits from the destination and 8 -
3405 SOURCE_OFFSET bits from the source. */
3406 buf
= *(bits_big_endian
? source
-- : source
++) >> source_offset
;
3407 buf
<<= dest_offset
;
3408 buf
|= *dest
& ((1 << dest_offset
) - 1);
3410 /* NBITS: bits yet to be written; AVAIL: BUF's fill level. */
3411 nbits
+= dest_offset
;
3412 avail
= dest_offset
+ 8 - source_offset
;
3414 /* Flush 8 bits from BUF, if appropriate. */
3415 if (nbits
>= 8 && avail
>= 8)
3417 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3423 /* Copy the middle part. */
3426 size_t len
= nbits
/ 8;
3428 /* Use a faster method for byte-aligned copies. */
3431 if (bits_big_endian
)
3435 memcpy (dest
+ 1, source
+ 1, len
);
3439 memcpy (dest
, source
, len
);
3448 buf
|= *(bits_big_endian
? source
-- : source
++) << avail
;
3449 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3456 /* Write the last byte. */
3460 buf
|= *source
<< avail
;
3462 buf
&= (1 << nbits
) - 1;
3463 *dest
= (*dest
& (~0U << nbits
)) | buf
;
3467 void _initialize_utils ();
3469 _initialize_utils ()
3471 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
3472 Set number of characters where GDB should wrap lines of its output."), _("\
3473 Show number of characters where GDB should wrap lines of its output."), _("\
3474 This affects where GDB wraps its output to fit the screen width.\n\
3475 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
3477 show_chars_per_line
,
3478 &setlist
, &showlist
);
3480 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
3481 Set number of lines in a page for GDB output pagination."), _("\
3482 Show number of lines in a page for GDB output pagination."), _("\
3483 This affects the number of lines after which GDB will pause\n\
3484 its output and ask you whether to continue.\n\
3485 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
3487 show_lines_per_page
,
3488 &setlist
, &showlist
);
3490 add_setshow_boolean_cmd ("pagination", class_support
,
3491 &pagination_enabled
, _("\
3492 Set state of GDB output pagination."), _("\
3493 Show state of GDB output pagination."), _("\
3494 When pagination is ON, GDB pauses at end of each screenful of\n\
3495 its output and asks you whether to continue.\n\
3496 Turning pagination off is an alternative to \"set height unlimited\"."),
3498 show_pagination_enabled
,
3499 &setlist
, &showlist
);
3501 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
3502 &sevenbit_strings
, _("\
3503 Set printing of 8-bit characters in strings as \\nnn."), _("\
3504 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
3506 show_sevenbit_strings
,
3507 &setprintlist
, &showprintlist
);
3509 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
3510 &debug_timestamp
, _("\
3511 Set timestamping of debugging messages."), _("\
3512 Show timestamping of debugging messages."), _("\
3513 When set, debugging messages will be marked with seconds and microseconds."),
3515 show_debug_timestamp
,
3516 &setdebuglist
, &showdebuglist
);
3518 add_internal_problem_command (&internal_error_problem
);
3519 add_internal_problem_command (&internal_warning_problem
);
3520 add_internal_problem_command (&demangler_warning_problem
);
3523 selftests::register_test ("gdb_realpath", gdb_realpath_tests
);
3524 selftests::register_test ("gdb_argv_array_view", gdb_argv_as_array_view_test
);