1 /* General utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2020 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 concat ("maintenance set ", problem
->name
, " ",
511 0/*allow-unknown*/, &maintenance_set_cmdlist
);
513 add_show_prefix_cmd (problem
->name
, class_maintenance
, show_doc
,
515 concat ("maintenance show ", problem
->name
, " ",
517 0/*allow-unknown*/, &maintenance_show_cmdlist
);
519 if (problem
->user_settable_should_quit
)
521 set_doc
= xstrprintf (_("Set whether GDB should quit "
522 "when an %s is detected."),
524 show_doc
= xstrprintf (_("Show whether GDB will quit "
525 "when an %s is detected."),
527 add_setshow_enum_cmd ("quit", class_maintenance
,
528 internal_problem_modes
,
529 &problem
->should_quit
,
542 if (problem
->user_settable_should_dump_core
)
544 set_doc
= xstrprintf (_("Set whether GDB should create a core "
545 "file of GDB when %s is detected."),
547 show_doc
= xstrprintf (_("Show whether GDB will create a core "
548 "file of GDB when %s is detected."),
550 add_setshow_enum_cmd ("corefile", class_maintenance
,
551 internal_problem_modes
,
552 &problem
->should_dump_core
,
566 /* Return a newly allocated string, containing the PREFIX followed
567 by the system error message for errno (separated by a colon). */
570 perror_string (const char *prefix
)
572 const char *err
= safe_strerror (errno
);
573 return std::string (prefix
) + ": " + err
;
576 /* Print the system error message for errno, and also mention STRING
577 as the file name for which the error was encountered. Use ERRCODE
578 for the thrown exception. Then return to command level. */
581 throw_perror_with_name (enum errors errcode
, const char *string
)
583 std::string combined
= perror_string (string
);
585 /* I understand setting these is a matter of taste. Still, some people
586 may clear errno but not know about bfd_error. Doing this here is not
588 bfd_set_error (bfd_error_no_error
);
591 throw_error (errcode
, _("%s."), combined
.c_str ());
594 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
597 perror_with_name (const char *string
)
599 throw_perror_with_name (GENERIC_ERROR
, string
);
602 /* Same as perror_with_name except that it prints a warning instead
603 of throwing an error. */
606 perror_warning_with_name (const char *string
)
608 std::string combined
= perror_string (string
);
609 warning (_("%s"), combined
.c_str ());
612 /* Print the system error message for ERRCODE, and also mention STRING
613 as the file name for which the error was encountered. */
616 print_sys_errmsg (const char *string
, int errcode
)
618 const char *err
= safe_strerror (errcode
);
619 /* We want anything which was printed on stdout to come out first, before
621 gdb_flush (gdb_stdout
);
622 fprintf_unfiltered (gdb_stderr
, "%s: %s.\n", string
, err
);
625 /* Control C eventually causes this to be called, at a convenient time. */
630 if (sync_quit_force_run
)
632 sync_quit_force_run
= 0;
633 quit_force (NULL
, 0);
637 /* No steenking SIGINT will ever be coming our way when the
638 program is resumed. Don't lie. */
642 /* If there is no terminal switching for this target, then we can't
643 possibly get screwed by the lack of job control. */
644 || !target_supports_terminal_ours ())
647 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
656 if (sync_quit_force_run
)
663 /* Called when a memory allocation fails, with the number of bytes of
664 memory requested in SIZE. */
667 malloc_failure (long size
)
671 internal_error (__FILE__
, __LINE__
,
672 _("virtual memory exhausted: can't allocate %ld bytes."),
677 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
681 /* See common/errors.h. */
686 gdb_stdout
->flush ();
687 gdb_stderr
->flush ();
690 /* My replacement for the read system call.
691 Used like `read' but keeps going if `read' returns too soon. */
694 myread (int desc
, char *addr
, int len
)
701 val
= read (desc
, addr
, len
);
715 uinteger_pow (ULONGEST v1
, LONGEST v2
)
720 error (_("Attempt to raise 0 to negative power."));
726 /* The Russian Peasant's Algorithm. */
743 print_spaces (int n
, struct ui_file
*file
)
745 fputs_unfiltered (n_spaces (n
), file
);
748 /* Print a host address. */
751 gdb_print_host_address_1 (const void *addr
, struct ui_file
*stream
)
753 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
758 /* An RAII class that sets up to handle input and then tears down
759 during destruction. */
761 class scoped_input_handler
765 scoped_input_handler ()
766 : m_quit_handler (&quit_handler
, default_quit_handler
),
769 target_terminal::ours ();
770 ui_register_input_event_handler (current_ui
);
771 if (current_ui
->prompt_state
== PROMPT_BLOCKED
)
775 ~scoped_input_handler ()
778 ui_unregister_input_event_handler (m_ui
);
781 DISABLE_COPY_AND_ASSIGN (scoped_input_handler
);
785 /* Save and restore the terminal state. */
786 target_terminal::scoped_restore_terminal_state m_term_state
;
788 /* Save and restore the quit handler. */
789 scoped_restore_tmpl
<quit_handler_ftype
*> m_quit_handler
;
791 /* The saved UI, if non-NULL. */
797 /* This function supports the query, nquery, and yquery functions.
798 Ask user a y-or-n question and return 0 if answer is no, 1 if
799 answer is yes, or default the answer to the specified default
800 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
801 default answer, or '\0' for no default.
802 CTLSTR is the control string and should end in "? ". It should
803 not say how to answer, because we do that.
804 ARGS are the arguments passed along with the CTLSTR argument to
807 static int ATTRIBUTE_PRINTF (1, 0)
808 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
812 char def_answer
, not_def_answer
;
813 const char *y_string
, *n_string
;
815 /* Set up according to which answer is the default. */
820 not_def_answer
= 'N';
824 else if (defchar
== 'y')
828 not_def_answer
= 'N';
836 not_def_answer
= 'Y';
841 /* Automatically answer the default value if the user did not want
842 prompts or the command was issued with the server prefix. */
843 if (!confirm
|| server_command
)
846 /* If input isn't coming from the user directly, just say what
847 question we're asking, and then answer the default automatically. This
848 way, important error messages don't get lost when talking to GDB
850 if (current_ui
->instream
!= current_ui
->stdin_stream
851 || !input_interactive_p (current_ui
)
852 /* Restrict queries to the main UI. */
853 || current_ui
!= main_ui
)
855 target_terminal::scoped_restore_terminal_state term_state
;
856 target_terminal::ours_for_output ();
858 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
860 printf_filtered (_("(%s or %s) [answered %c; "
861 "input not from terminal]\n"),
862 y_string
, n_string
, def_answer
);
867 if (deprecated_query_hook
)
869 target_terminal::scoped_restore_terminal_state term_state
;
870 return deprecated_query_hook (ctlstr
, args
);
873 /* Format the question outside of the loop, to avoid reusing args. */
874 std::string question
= string_vprintf (ctlstr
, args
);
876 = string_printf (_("%s%s(%s or %s) %s"),
877 annotation_level
> 1 ? "\n\032\032pre-query\n" : "",
878 question
.c_str (), y_string
, n_string
,
879 annotation_level
> 1 ? "\n\032\032query\n" : "");
881 /* Used to add duration we waited for user to respond to
882 prompt_for_continue_wait_time. */
883 using namespace std::chrono
;
884 steady_clock::time_point prompt_started
= steady_clock::now ();
886 scoped_input_handler prepare_input
;
890 char *response
, answer
;
892 gdb_flush (gdb_stdout
);
893 response
= gdb_readline_wrapper (prompt
.c_str ());
895 if (response
== NULL
) /* C-d */
897 printf_filtered ("EOF [assumed %c]\n", def_answer
);
902 answer
= response
[0];
907 /* Check answer. For the non-default, the user must specify
908 the non-default explicitly. */
909 if (answer
== not_def_answer
)
914 /* Otherwise, if a default was specified, the user may either
915 specify the required input or have it default by entering
917 if (answer
== def_answer
918 || (defchar
!= '\0' && answer
== '\0'))
923 /* Invalid entries are not defaulted and require another selection. */
924 printf_filtered (_("Please answer %s or %s.\n"),
928 /* Add time spend in this routine to prompt_for_continue_wait_time. */
929 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
931 if (annotation_level
> 1)
932 printf_filtered (("\n\032\032post-query\n"));
937 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
938 answer is yes, or 0 if answer is defaulted.
939 Takes three args which are given to printf to print the question.
940 The first, a control string, should end in "? ".
941 It should not say how to answer, because we do that. */
944 nquery (const char *ctlstr
, ...)
949 va_start (args
, ctlstr
);
950 ret
= defaulted_query (ctlstr
, 'n', args
);
955 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
956 answer is yes, or 1 if answer is defaulted.
957 Takes three args which are given to printf to print the question.
958 The first, a control string, should end in "? ".
959 It should not say how to answer, because we do that. */
962 yquery (const char *ctlstr
, ...)
967 va_start (args
, ctlstr
);
968 ret
= defaulted_query (ctlstr
, 'y', args
);
973 /* Ask user a y-or-n question and return 1 iff answer is yes.
974 Takes three args which are given to printf to print the question.
975 The first, a control string, should end in "? ".
976 It should not say how to answer, because we do that. */
979 query (const char *ctlstr
, ...)
984 va_start (args
, ctlstr
);
985 ret
= defaulted_query (ctlstr
, '\0', args
);
990 /* A helper for parse_escape that converts a host character to a
991 target character. C is the host character. If conversion is
992 possible, then the target character is stored in *TARGET_C and the
993 function returns 1. Otherwise, the function returns 0. */
996 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1001 auto_obstack host_data
;
1003 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1004 (gdb_byte
*) &the_char
, 1, 1,
1005 &host_data
, translit_none
);
1007 if (obstack_object_size (&host_data
) == 1)
1010 *target_c
= *(char *) obstack_base (&host_data
);
1016 /* Parse a C escape sequence. STRING_PTR points to a variable
1017 containing a pointer to the string to parse. That pointer
1018 should point to the character after the \. That pointer
1019 is updated past the characters we use. The value of the
1020 escape sequence is returned.
1022 A negative value means the sequence \ newline was seen,
1023 which is supposed to be equivalent to nothing at all.
1025 If \ is followed by a null character, we return a negative
1026 value and leave the string pointer pointing at the null character.
1028 If \ is followed by 000, we return 0 and leave the string pointer
1029 after the zeros. A value of 0 does not mean end of string. */
1032 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1034 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1035 int c
= *(*string_ptr
)++;
1054 int i
= host_hex_value (c
);
1059 if (ISDIGIT (c
) && c
!= '8' && c
!= '9')
1063 i
+= host_hex_value (c
);
1099 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1100 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1101 " which has no equivalent\nin the `%s' character set."),
1102 c
, c
, target_charset (gdbarch
));
1106 /* Print the character C on STREAM as part of the contents of a literal
1107 string whose delimiter is QUOTER. Note that this routine should only
1108 be called for printing things which are independent of the language
1109 of the program being debugged.
1111 printchar will normally escape backslashes and instances of QUOTER. If
1112 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1113 As a side effect, if you pass the backslash character as the QUOTER,
1114 printchar will escape backslashes as usual, but not any other quoting
1118 printchar (int c
, do_fputc_ftype do_fputc
, ui_file
*stream
, int quoter
)
1120 c
&= 0xFF; /* Avoid sign bit follies */
1122 if (c
< 0x20 || /* Low control chars */
1123 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1124 (sevenbit_strings
&& c
>= 0x80))
1125 { /* high order bit set */
1126 do_fputc ('\\', stream
);
1131 do_fputc ('n', stream
);
1134 do_fputc ('b', stream
);
1137 do_fputc ('t', stream
);
1140 do_fputc ('f', stream
);
1143 do_fputc ('r', stream
);
1146 do_fputc ('e', stream
);
1149 do_fputc ('a', stream
);
1153 do_fputc ('0' + ((c
>> 6) & 0x7), stream
);
1154 do_fputc ('0' + ((c
>> 3) & 0x7), stream
);
1155 do_fputc ('0' + ((c
>> 0) & 0x7), stream
);
1162 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1163 do_fputc ('\\', stream
);
1164 do_fputc (c
, stream
);
1168 /* Print the character C on STREAM as part of the contents of a
1169 literal string whose delimiter is QUOTER. Note that these routines
1170 should only be call for printing things which are independent of
1171 the language of the program being debugged. */
1174 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1177 printchar (*str
++, fputc_filtered
, stream
, quoter
);
1181 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1184 printchar (*str
++, fputc_unfiltered
, stream
, quoter
);
1188 fputstrn_filtered (const char *str
, int n
, int quoter
,
1189 struct ui_file
*stream
)
1191 for (int i
= 0; i
< n
; i
++)
1192 printchar (str
[i
], fputc_filtered
, stream
, quoter
);
1196 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1197 do_fputc_ftype do_fputc
, struct ui_file
*stream
)
1199 for (int i
= 0; i
< n
; i
++)
1200 printchar (str
[i
], do_fputc
, stream
, quoter
);
1204 /* Number of lines per page or UINT_MAX if paging is disabled. */
1205 static unsigned int lines_per_page
;
1207 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1208 struct cmd_list_element
*c
, const char *value
)
1210 fprintf_filtered (file
,
1211 _("Number of lines gdb thinks are in a page is %s.\n"),
1215 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1216 static unsigned int chars_per_line
;
1218 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1219 struct cmd_list_element
*c
, const char *value
)
1221 fprintf_filtered (file
,
1222 _("Number of characters gdb thinks "
1223 "are in a line is %s.\n"),
1227 /* Current count of lines printed on this page, chars on this line. */
1228 static unsigned int lines_printed
, chars_printed
;
1230 /* True if pagination is disabled for just one command. */
1232 static bool pagination_disabled_for_command
;
1234 /* Buffer and start column of buffered text, for doing smarter word-
1235 wrapping. When someone calls wrap_here(), we start buffering output
1236 that comes through fputs_filtered(). If we see a newline, we just
1237 spit it out and forget about the wrap_here(). If we see another
1238 wrap_here(), we spit it out and remember the newer one. If we see
1239 the end of the line, we spit out a newline, the indent, and then
1240 the buffered output. */
1242 static bool filter_initialized
= false;
1244 /* Contains characters which are waiting to be output (they have
1245 already been counted in chars_printed). */
1246 static std::string wrap_buffer
;
1248 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1250 static const char *wrap_indent
;
1252 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1253 is not in effect. */
1254 static int wrap_column
;
1256 /* The style applied at the time that wrap_here was called. */
1257 static ui_file_style wrap_style
;
1260 /* Initialize the number of lines per page and chars per line. */
1263 init_page_info (void)
1267 lines_per_page
= UINT_MAX
;
1268 chars_per_line
= UINT_MAX
;
1272 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1277 #if defined(__GO32__)
1278 rows
= ScreenRows ();
1279 cols
= ScreenCols ();
1280 lines_per_page
= rows
;
1281 chars_per_line
= cols
;
1283 /* Make sure Readline has initialized its terminal settings. */
1284 rl_reset_terminal (NULL
);
1286 /* Get the screen size from Readline. */
1287 rl_get_screen_size (&rows
, &cols
);
1288 lines_per_page
= rows
;
1289 chars_per_line
= cols
;
1291 /* Readline should have fetched the termcap entry for us.
1292 Only try to use tgetnum function if rl_get_screen_size
1293 did not return a useful value. */
1294 if (((rows
<= 0) && (tgetnum ((char *) "li") < 0))
1295 /* Also disable paging if inside Emacs. $EMACS was used
1296 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1297 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1299 /* The number of lines per page is not mentioned in the terminal
1300 description or EMACS environment variable is set. This probably
1301 means that paging is not useful, so disable paging. */
1302 lines_per_page
= UINT_MAX
;
1305 /* If the output is not a terminal, don't paginate it. */
1306 if (!gdb_stdout
->isatty ())
1307 lines_per_page
= UINT_MAX
;
1311 /* We handle SIGWINCH ourselves. */
1312 rl_catch_sigwinch
= 0;
1318 /* Return nonzero if filtered printing is initialized. */
1320 filtered_printing_initialized (void)
1322 return filter_initialized
;
1325 set_batch_flag_and_restore_page_info::set_batch_flag_and_restore_page_info ()
1326 : m_save_lines_per_page (lines_per_page
),
1327 m_save_chars_per_line (chars_per_line
),
1328 m_save_batch_flag (batch_flag
)
1334 set_batch_flag_and_restore_page_info::~set_batch_flag_and_restore_page_info ()
1336 batch_flag
= m_save_batch_flag
;
1337 chars_per_line
= m_save_chars_per_line
;
1338 lines_per_page
= m_save_lines_per_page
;
1344 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1347 set_screen_size (void)
1349 int rows
= lines_per_page
;
1350 int cols
= chars_per_line
;
1352 /* If we get 0 or negative ROWS or COLS, treat as "infinite" size.
1353 A negative number can be seen here with the "set width/height"
1354 commands and either:
1356 - the user specified "unlimited", which maps to UINT_MAX, or
1357 - the user specified some number between INT_MAX and UINT_MAX.
1359 Cap "infinity" to approximately sqrt(INT_MAX) so that we don't
1360 overflow in rl_set_screen_size, which multiplies rows and columns
1361 to compute the number of characters on the screen. */
1363 const int sqrt_int_max
= INT_MAX
>> (sizeof (int) * 8 / 2);
1365 if (rows
<= 0 || rows
> sqrt_int_max
)
1367 rows
= sqrt_int_max
;
1368 lines_per_page
= UINT_MAX
;
1371 if (cols
<= 0 || cols
> sqrt_int_max
)
1373 cols
= sqrt_int_max
;
1374 chars_per_line
= UINT_MAX
;
1377 /* Update Readline's idea of the terminal size. */
1378 rl_set_screen_size (rows
, cols
);
1381 /* Reinitialize WRAP_BUFFER. */
1386 if (chars_per_line
== 0)
1389 wrap_buffer
.clear ();
1390 filter_initialized
= true;
1394 set_width_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1401 set_height_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1409 set_screen_width_and_height (int width
, int height
)
1411 lines_per_page
= height
;
1412 chars_per_line
= width
;
1418 /* The currently applied style. */
1420 static ui_file_style applied_style
;
1422 /* Emit an ANSI style escape for STYLE. If STREAM is nullptr, emit to
1423 the wrap buffer; otherwise emit to STREAM. */
1426 emit_style_escape (const ui_file_style
&style
,
1427 struct ui_file
*stream
= nullptr)
1429 applied_style
= style
;
1431 if (stream
== nullptr)
1432 wrap_buffer
.append (style
.to_ansi ());
1434 stream
->puts (style
.to_ansi ().c_str ());
1437 /* Set the current output style. This will affect future uses of the
1438 _filtered output functions. */
1441 set_output_style (struct ui_file
*stream
, const ui_file_style
&style
)
1443 if (!stream
->can_emit_style_escape ())
1446 /* Note that we may not pass STREAM here, when we want to emit to
1447 the wrap buffer, not directly to STREAM. */
1448 if (stream
== gdb_stdout
)
1450 emit_style_escape (style
, stream
);
1456 reset_terminal_style (struct ui_file
*stream
)
1458 if (stream
->can_emit_style_escape ())
1460 /* Force the setting, regardless of what we think the setting
1461 might already be. */
1462 applied_style
= ui_file_style ();
1463 wrap_buffer
.append (applied_style
.to_ansi ());
1467 /* Wait, so the user can read what's on the screen. Prompt the user
1468 to continue by pressing RETURN. 'q' is also provided because
1469 telling users what to do in the prompt is more user-friendly than
1470 expecting them to think of Ctrl-C/SIGINT. */
1473 prompt_for_continue (void)
1475 char cont_prompt
[120];
1476 /* Used to add duration we waited for user to respond to
1477 prompt_for_continue_wait_time. */
1478 using namespace std::chrono
;
1479 steady_clock::time_point prompt_started
= steady_clock::now ();
1480 bool disable_pagination
= pagination_disabled_for_command
;
1482 /* Clear the current styling. */
1483 if (gdb_stdout
->can_emit_style_escape ())
1484 emit_style_escape (ui_file_style (), gdb_stdout
);
1486 if (annotation_level
> 1)
1487 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1489 strcpy (cont_prompt
,
1490 "--Type <RET> for more, q to quit, "
1491 "c to continue without paging--");
1492 if (annotation_level
> 1)
1493 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1495 /* We must do this *before* we call gdb_readline_wrapper, else it
1496 will eventually call us -- thinking that we're trying to print
1497 beyond the end of the screen. */
1498 reinitialize_more_filter ();
1500 scoped_input_handler prepare_input
;
1502 /* Call gdb_readline_wrapper, not readline, in order to keep an
1503 event loop running. */
1504 gdb::unique_xmalloc_ptr
<char> ignore (gdb_readline_wrapper (cont_prompt
));
1506 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1507 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1509 if (annotation_level
> 1)
1510 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1514 char *p
= ignore
.get ();
1516 while (*p
== ' ' || *p
== '\t')
1519 /* Do not call quit here; there is no possibility of SIGINT. */
1520 throw_quit ("Quit");
1522 disable_pagination
= true;
1525 /* Now we have to do this again, so that GDB will know that it doesn't
1526 need to save the ---Type <return>--- line at the top of the screen. */
1527 reinitialize_more_filter ();
1528 pagination_disabled_for_command
= disable_pagination
;
1530 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1533 /* Initialize timer to keep track of how long we waited for the user. */
1536 reset_prompt_for_continue_wait_time (void)
1538 using namespace std::chrono
;
1540 prompt_for_continue_wait_time
= steady_clock::duration::zero ();
1543 /* Fetch the cumulative time spent in prompt_for_continue. */
1545 std::chrono::steady_clock::duration
1546 get_prompt_for_continue_wait_time ()
1548 return prompt_for_continue_wait_time
;
1551 /* Reinitialize filter; ie. tell it to reset to original values. */
1554 reinitialize_more_filter (void)
1558 pagination_disabled_for_command
= false;
1561 /* Flush the wrap buffer to STREAM, if necessary. */
1564 flush_wrap_buffer (struct ui_file
*stream
)
1566 if (stream
== gdb_stdout
&& !wrap_buffer
.empty ())
1568 stream
->puts (wrap_buffer
.c_str ());
1569 wrap_buffer
.clear ();
1576 gdb_flush (struct ui_file
*stream
)
1578 flush_wrap_buffer (stream
);
1585 get_chars_per_line ()
1587 return chars_per_line
;
1590 /* Indicate that if the next sequence of characters overflows the line,
1591 a newline should be inserted here rather than when it hits the end.
1592 If INDENT is non-null, it is a string to be printed to indent the
1593 wrapped part on the next line. INDENT must remain accessible until
1594 the next call to wrap_here() or until a newline is printed through
1597 If the line is already overfull, we immediately print a newline and
1598 the indentation, and disable further wrapping.
1600 If we don't know the width of lines, but we know the page height,
1601 we must not wrap words, but should still keep track of newlines
1602 that were explicitly printed.
1604 INDENT should not contain tabs, as that will mess up the char count
1605 on the next line. FIXME.
1607 This routine is guaranteed to force out any output which has been
1608 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1609 used to force out output from the wrap_buffer. */
1612 wrap_here (const char *indent
)
1614 /* This should have been allocated, but be paranoid anyway. */
1615 gdb_assert (filter_initialized
);
1617 flush_wrap_buffer (gdb_stdout
);
1618 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1622 else if (chars_printed
>= chars_per_line
)
1624 puts_filtered ("\n");
1626 puts_filtered (indent
);
1631 wrap_column
= chars_printed
;
1635 wrap_indent
= indent
;
1636 wrap_style
= applied_style
;
1640 /* Print input string to gdb_stdout, filtered, with wrap,
1641 arranging strings in columns of n chars. String can be
1642 right or left justified in the column. Never prints
1643 trailing spaces. String should never be longer than
1644 width. FIXME: this could be useful for the EXAMINE
1645 command, which currently doesn't tabulate very well. */
1648 puts_filtered_tabular (char *string
, int width
, int right
)
1654 gdb_assert (chars_per_line
> 0);
1655 if (chars_per_line
== UINT_MAX
)
1657 fputs_filtered (string
, gdb_stdout
);
1658 fputs_filtered ("\n", gdb_stdout
);
1662 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1663 fputs_filtered ("\n", gdb_stdout
);
1665 if (width
>= chars_per_line
)
1666 width
= chars_per_line
- 1;
1668 stringlen
= strlen (string
);
1670 if (chars_printed
> 0)
1671 spaces
= width
- (chars_printed
- 1) % width
- 1;
1673 spaces
+= width
- stringlen
;
1675 spacebuf
= (char *) alloca (spaces
+ 1);
1676 spacebuf
[spaces
] = '\0';
1678 spacebuf
[spaces
] = ' ';
1680 fputs_filtered (spacebuf
, gdb_stdout
);
1681 fputs_filtered (string
, gdb_stdout
);
1685 /* Ensure that whatever gets printed next, using the filtered output
1686 commands, starts at the beginning of the line. I.e. if there is
1687 any pending output for the current line, flush it and start a new
1688 line. Otherwise do nothing. */
1693 if (chars_printed
> 0)
1695 puts_filtered ("\n");
1700 /* Like fputs but if FILTER is true, pause after every screenful.
1702 Regardless of FILTER can wrap at points other than the final
1703 character of a line.
1705 Unlike fputs, fputs_maybe_filtered does not return a value.
1706 It is OK for LINEBUFFER to be NULL, in which case just don't print
1709 Note that a longjmp to top level may occur in this routine (only if
1710 FILTER is true) (since prompt_for_continue may do so) so this
1711 routine should not be called when cleanups are not in place. */
1714 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1717 const char *lineptr
;
1719 if (linebuffer
== 0)
1722 /* Don't do any filtering if it is disabled. */
1723 if (stream
!= gdb_stdout
1724 || !pagination_enabled
1725 || pagination_disabled_for_command
1727 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
1728 || top_level_interpreter () == NULL
1729 || top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
1731 flush_wrap_buffer (stream
);
1732 stream
->puts (linebuffer
);
1737 = make_scope_exit ([&] ()
1739 wrap_buffer
.clear ();
1744 /* Go through and output each character. Show line extension
1745 when this is necessary; prompt user for new page when this is
1748 lineptr
= linebuffer
;
1751 /* Possible new page. Note that PAGINATION_DISABLED_FOR_COMMAND
1752 might be set during this loop, so we must continue to check
1754 if (filter
&& (lines_printed
>= lines_per_page
- 1)
1755 && !pagination_disabled_for_command
)
1756 prompt_for_continue ();
1758 while (*lineptr
&& *lineptr
!= '\n')
1762 /* Print a single line. */
1763 if (*lineptr
== '\t')
1765 wrap_buffer
.push_back ('\t');
1766 /* Shifting right by 3 produces the number of tab stops
1767 we have already passed, and then adding one and
1768 shifting left 3 advances to the next tab stop. */
1769 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
1772 else if (*lineptr
== '\033'
1773 && skip_ansi_escape (lineptr
, &skip_bytes
))
1775 wrap_buffer
.append (lineptr
, skip_bytes
);
1776 /* Note that we don't consider this a character, so we
1777 don't increment chars_printed here. */
1778 lineptr
+= skip_bytes
;
1780 else if (*lineptr
== '\r')
1782 wrap_buffer
.push_back (*lineptr
);
1788 wrap_buffer
.push_back (*lineptr
);
1793 if (chars_printed
>= chars_per_line
)
1795 unsigned int save_chars
= chars_printed
;
1797 /* If we change the style, below, we'll want to reset it
1798 before continuing to print. If there is no wrap
1799 column, then we'll only reset the style if the pager
1800 prompt is given; and to avoid emitting style
1801 sequences in the middle of a run of text, we track
1803 ui_file_style save_style
;
1804 bool did_paginate
= false;
1810 save_style
= wrap_style
;
1811 if (stream
->can_emit_style_escape ())
1812 emit_style_escape (ui_file_style (), stream
);
1813 /* If we aren't actually wrapping, don't output
1814 newline -- if chars_per_line is right, we
1815 probably just overflowed anyway; if it's wrong,
1816 let us keep going. */
1817 /* XXX: The ideal thing would be to call
1818 'stream->putc' here, but we can't because it
1819 currently calls 'fputc_unfiltered', which ends up
1820 calling us, which generates an infinite
1822 stream
->puts ("\n");
1826 save_style
= applied_style
;
1827 flush_wrap_buffer (stream
);
1830 /* Possible new page. Note that
1831 PAGINATION_DISABLED_FOR_COMMAND might be set during
1832 this loop, so we must continue to check it here. */
1833 if (lines_printed
>= lines_per_page
- 1
1834 && !pagination_disabled_for_command
)
1836 prompt_for_continue ();
1837 did_paginate
= true;
1840 /* Now output indentation and wrapped string. */
1843 stream
->puts (wrap_indent
);
1844 if (stream
->can_emit_style_escape ())
1845 emit_style_escape (save_style
, stream
);
1846 /* FIXME, this strlen is what prevents wrap_indent from
1847 containing tabs. However, if we recurse to print it
1848 and count its chars, we risk trouble if wrap_indent is
1849 longer than (the user settable) chars_per_line.
1850 Note also that this can set chars_printed > chars_per_line
1851 if we are printing a long string. */
1852 chars_printed
= strlen (wrap_indent
)
1853 + (save_chars
- wrap_column
);
1854 wrap_column
= 0; /* And disable fancy wrap */
1856 else if (did_paginate
&& stream
->can_emit_style_escape ())
1857 emit_style_escape (save_style
, stream
);
1861 if (*lineptr
== '\n')
1864 wrap_here ((char *) 0); /* Spit out chars, cancel
1867 /* XXX: The ideal thing would be to call
1868 'stream->putc' here, but we can't because it
1869 currently calls 'fputc_unfiltered', which ends up
1870 calling us, which generates an infinite
1872 stream
->puts ("\n");
1877 buffer_clearer
.release ();
1881 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
1883 fputs_maybe_filtered (linebuffer
, stream
, 1);
1887 fputs_unfiltered (const char *linebuffer
, struct ui_file
*stream
)
1889 fputs_maybe_filtered (linebuffer
, stream
, 0);
1895 fputs_styled (const char *linebuffer
, const ui_file_style
&style
,
1896 struct ui_file
*stream
)
1898 /* This just makes it so we emit somewhat fewer escape
1900 if (style
.is_default ())
1901 fputs_maybe_filtered (linebuffer
, stream
, 1);
1904 set_output_style (stream
, style
);
1905 fputs_maybe_filtered (linebuffer
, stream
, 1);
1906 set_output_style (stream
, ui_file_style ());
1913 fputs_styled_unfiltered (const char *linebuffer
, const ui_file_style
&style
,
1914 struct ui_file
*stream
)
1916 /* This just makes it so we emit somewhat fewer escape
1918 if (style
.is_default ())
1919 fputs_maybe_filtered (linebuffer
, stream
, 0);
1922 set_output_style (stream
, style
);
1923 fputs_maybe_filtered (linebuffer
, stream
, 0);
1924 set_output_style (stream
, ui_file_style ());
1931 fputs_highlighted (const char *str
, const compiled_regex
&highlight
,
1932 struct ui_file
*stream
)
1936 while (*str
&& highlight
.exec (str
, 1, &pmatch
, 0) == 0)
1938 size_t n_highlight
= pmatch
.rm_eo
- pmatch
.rm_so
;
1940 /* Output the part before pmatch with current style. */
1941 while (pmatch
.rm_so
> 0)
1943 fputc_filtered (*str
, stream
);
1948 /* Output pmatch with the highlight style. */
1949 set_output_style (stream
, highlight_style
.style ());
1950 while (n_highlight
> 0)
1952 fputc_filtered (*str
, stream
);
1956 set_output_style (stream
, ui_file_style ());
1959 /* Output the trailing part of STR not matching HIGHLIGHT. */
1961 fputs_filtered (str
, stream
);
1965 putchar_unfiltered (int c
)
1967 return fputc_unfiltered (c
, gdb_stdout
);
1970 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
1971 May return nonlocally. */
1974 putchar_filtered (int c
)
1976 return fputc_filtered (c
, gdb_stdout
);
1980 fputc_unfiltered (int c
, struct ui_file
*stream
)
1986 fputs_unfiltered (buf
, stream
);
1991 fputc_filtered (int c
, struct ui_file
*stream
)
1997 fputs_filtered (buf
, stream
);
2001 /* puts_debug is like fputs_unfiltered, except it prints special
2002 characters in printable fashion. */
2005 puts_debug (char *prefix
, char *string
, char *suffix
)
2009 /* Print prefix and suffix after each line. */
2010 static int new_line
= 1;
2011 static int return_p
= 0;
2012 static const char *prev_prefix
= "";
2013 static const char *prev_suffix
= "";
2015 if (*string
== '\n')
2018 /* If the prefix is changing, print the previous suffix, a new line,
2019 and the new prefix. */
2020 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
2022 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
2023 fputs_unfiltered ("\n", gdb_stdlog
);
2024 fputs_unfiltered (prefix
, gdb_stdlog
);
2027 /* Print prefix if we printed a newline during the previous call. */
2031 fputs_unfiltered (prefix
, gdb_stdlog
);
2034 prev_prefix
= prefix
;
2035 prev_suffix
= suffix
;
2037 /* Output characters in a printable format. */
2038 while ((ch
= *string
++) != '\0')
2043 if (gdb_isprint (ch
))
2044 fputc_unfiltered (ch
, gdb_stdlog
);
2047 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2051 fputs_unfiltered ("\\\\", gdb_stdlog
);
2054 fputs_unfiltered ("\\b", gdb_stdlog
);
2057 fputs_unfiltered ("\\f", gdb_stdlog
);
2061 fputs_unfiltered ("\\n", gdb_stdlog
);
2064 fputs_unfiltered ("\\r", gdb_stdlog
);
2067 fputs_unfiltered ("\\t", gdb_stdlog
);
2070 fputs_unfiltered ("\\v", gdb_stdlog
);
2074 return_p
= ch
== '\r';
2077 /* Print suffix if we printed a newline. */
2080 fputs_unfiltered (suffix
, gdb_stdlog
);
2081 fputs_unfiltered ("\n", gdb_stdlog
);
2086 /* Print a variable number of ARGS using format FORMAT. If this
2087 information is going to put the amount written (since the last call
2088 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2089 call prompt_for_continue to get the users permission to continue.
2091 Unlike fprintf, this function does not return a value.
2093 We implement three variants, vfprintf (takes a vararg list and stream),
2094 fprintf (takes a stream to write on), and printf (the usual).
2096 Note also that this may throw a quit (since prompt_for_continue may
2100 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2101 va_list args
, bool filter
, bool gdbfmt
)
2105 ui_out_flags flags
= disallow_ui_out_field
;
2107 flags
|= unfiltered_output
;
2108 cli_ui_out (stream
, flags
).vmessage (applied_style
, format
, args
);
2112 std::string str
= string_vprintf (format
, args
);
2113 fputs_maybe_filtered (str
.c_str (), stream
, filter
);
2119 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2121 vfprintf_maybe_filtered (stream
, format
, args
, true, true);
2125 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2127 if (debug_timestamp
&& stream
== gdb_stdlog
)
2129 using namespace std::chrono
;
2133 cli_ui_out (&sfile
, 0).vmessage (ui_file_style (), format
, args
);
2134 std::string linebuffer
= std::move (sfile
.string ());
2136 steady_clock::time_point now
= steady_clock::now ();
2137 seconds s
= duration_cast
<seconds
> (now
.time_since_epoch ());
2138 microseconds us
= duration_cast
<microseconds
> (now
.time_since_epoch () - s
);
2140 len
= linebuffer
.size ();
2141 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2143 std::string timestamp
= string_printf ("%ld.%06ld %s%s",
2146 linebuffer
.c_str (),
2147 need_nl
? "\n": "");
2148 fputs_unfiltered (timestamp
.c_str (), stream
);
2151 vfprintf_maybe_filtered (stream
, format
, args
, false, true);
2155 vprintf_filtered (const char *format
, va_list args
)
2157 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, true, false);
2161 vprintf_unfiltered (const char *format
, va_list args
)
2163 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2167 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2171 va_start (args
, format
);
2172 vfprintf_filtered (stream
, format
, args
);
2177 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2181 va_start (args
, format
);
2182 vfprintf_unfiltered (stream
, format
, args
);
2186 /* Like fprintf_filtered, but prints its result indented.
2187 Called as fprintfi_filtered (spaces, stream, format, ...); */
2190 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2195 va_start (args
, format
);
2196 print_spaces_filtered (spaces
, stream
);
2198 vfprintf_filtered (stream
, format
, args
);
2205 fprintf_styled (struct ui_file
*stream
, const ui_file_style
&style
,
2206 const char *format
, ...)
2210 set_output_style (stream
, style
);
2211 va_start (args
, format
);
2212 vfprintf_filtered (stream
, format
, args
);
2214 set_output_style (stream
, ui_file_style ());
2220 vfprintf_styled (struct ui_file
*stream
, const ui_file_style
&style
,
2221 const char *format
, va_list args
)
2223 set_output_style (stream
, style
);
2224 vfprintf_filtered (stream
, format
, args
);
2225 set_output_style (stream
, ui_file_style ());
2231 vfprintf_styled_no_gdbfmt (struct ui_file
*stream
, const ui_file_style
&style
,
2232 bool filter
, const char *format
, va_list args
)
2234 std::string str
= string_vprintf (format
, args
);
2237 if (!style
.is_default ())
2238 set_output_style (stream
, style
);
2239 fputs_maybe_filtered (str
.c_str (), stream
, filter
);
2240 if (!style
.is_default ())
2241 set_output_style (stream
, ui_file_style ());
2246 printf_filtered (const char *format
, ...)
2250 va_start (args
, format
);
2251 vfprintf_filtered (gdb_stdout
, format
, args
);
2257 printf_unfiltered (const char *format
, ...)
2261 va_start (args
, format
);
2262 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2266 /* Like printf_filtered, but prints it's result indented.
2267 Called as printfi_filtered (spaces, format, ...); */
2270 printfi_filtered (int spaces
, const char *format
, ...)
2274 va_start (args
, format
);
2275 print_spaces_filtered (spaces
, gdb_stdout
);
2276 vfprintf_filtered (gdb_stdout
, format
, args
);
2280 /* Easy -- but watch out!
2282 This routine is *not* a replacement for puts()! puts() appends a newline.
2283 This one doesn't, and had better not! */
2286 puts_filtered (const char *string
)
2288 fputs_filtered (string
, gdb_stdout
);
2292 puts_unfiltered (const char *string
)
2294 fputs_unfiltered (string
, gdb_stdout
);
2297 /* Return a pointer to N spaces and a null. The pointer is good
2298 until the next call to here. */
2303 static char *spaces
= 0;
2304 static int max_spaces
= -1;
2309 spaces
= (char *) xmalloc (n
+ 1);
2310 for (t
= spaces
+ n
; t
!= spaces
;)
2316 return spaces
+ max_spaces
- n
;
2319 /* Print N spaces. */
2321 print_spaces_filtered (int n
, struct ui_file
*stream
)
2323 fputs_filtered (n_spaces (n
), stream
);
2326 /* C++/ObjC demangler stuff. */
2328 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2329 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2330 If the name is not mangled, or the language for the name is unknown, or
2331 demangling is off, the name is printed in its "raw" form. */
2334 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2335 enum language lang
, int arg_mode
)
2341 /* If user wants to see raw output, no problem. */
2344 fputs_filtered (name
, stream
);
2348 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2349 fputs_filtered (demangled
? demangled
: name
, stream
);
2350 if (demangled
!= NULL
)
2358 /* True if CH is a character that can be part of a symbol name. I.e.,
2359 either a number, a letter, or a '_'. */
2362 valid_identifier_name_char (int ch
)
2364 return (ISALNUM (ch
) || ch
== '_');
2367 /* Skip to end of token, or to END, whatever comes first. Input is
2368 assumed to be a C++ operator name. */
2371 cp_skip_operator_token (const char *token
, const char *end
)
2373 const char *p
= token
;
2374 while (p
!= end
&& !ISSPACE (*p
) && *p
!= '(')
2376 if (valid_identifier_name_char (*p
))
2378 while (p
!= end
&& valid_identifier_name_char (*p
))
2384 /* Note, ordered such that among ops that share a prefix,
2385 longer comes first. This is so that the loop below can
2386 bail on first match. */
2387 static const char *ops
[] =
2393 "-=", "--", "->", "-",
2402 "<<=", "<=", "<<", "<",
2403 ">>=", ">=", ">>", ">",
2407 for (const char *op
: ops
)
2409 size_t oplen
= strlen (op
);
2410 size_t lencmp
= std::min
<size_t> (oplen
, end
- p
);
2412 if (strncmp (p
, op
, lencmp
) == 0)
2415 /* Some unidentified character. Return it. */
2423 /* Advance STRING1/STRING2 past whitespace. */
2426 skip_ws (const char *&string1
, const char *&string2
, const char *end_str2
)
2428 while (ISSPACE (*string1
))
2430 while (string2
< end_str2
&& ISSPACE (*string2
))
2434 /* True if STRING points at the start of a C++ operator name. START
2435 is the start of the string that STRING points to, hence when
2436 reading backwards, we must not read any character before START. */
2439 cp_is_operator (const char *string
, const char *start
)
2441 return ((string
== start
2442 || !valid_identifier_name_char (string
[-1]))
2443 && strncmp (string
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
2444 && !valid_identifier_name_char (string
[CP_OPERATOR_LEN
]));
2447 /* If *NAME points at an ABI tag, skip it and return true. Otherwise
2448 leave *NAME unmodified and return false. (see GCC's abi_tag
2449 attribute), such names are demangled as e.g.,
2450 "function[abi:cxx11]()". */
2453 skip_abi_tag (const char **name
)
2455 const char *p
= *name
;
2457 if (startswith (p
, "[abi:"))
2461 while (valid_identifier_name_char (*p
))
2477 strncmp_iw_with_mode (const char *string1
, const char *string2
,
2478 size_t string2_len
, strncmp_iw_mode mode
,
2479 enum language language
,
2480 completion_match_for_lcd
*match_for_lcd
)
2482 const char *string1_start
= string1
;
2483 const char *end_str2
= string2
+ string2_len
;
2484 bool skip_spaces
= true;
2485 bool have_colon_op
= (language
== language_cplus
2486 || language
== language_rust
2487 || language
== language_fortran
);
2492 || ((ISSPACE (*string1
) && !valid_identifier_name_char (*string2
))
2493 || (ISSPACE (*string2
) && !valid_identifier_name_char (*string1
))))
2495 skip_ws (string1
, string2
, end_str2
);
2496 skip_spaces
= false;
2499 /* Skip [abi:cxx11] tags in the symbol name if the lookup name
2500 doesn't include them. E.g.:
2502 string1: function[abi:cxx1](int)
2505 string1: function[abi:cxx1](int)
2506 string2: function(int)
2508 string1: Struct[abi:cxx1]::function()
2509 string2: Struct::function()
2511 string1: function(Struct[abi:cxx1], int)
2512 string2: function(Struct, int)
2514 if (string2
== end_str2
2515 || (*string2
!= '[' && !valid_identifier_name_char (*string2
)))
2517 const char *abi_start
= string1
;
2519 /* There can be more than one tag. */
2520 while (*string1
== '[' && skip_abi_tag (&string1
))
2523 if (match_for_lcd
!= NULL
&& abi_start
!= string1
)
2524 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2526 while (ISSPACE (*string1
))
2530 if (*string1
== '\0' || string2
== end_str2
)
2533 /* Handle the :: operator. */
2534 if (have_colon_op
&& string1
[0] == ':' && string1
[1] == ':')
2536 if (*string2
!= ':')
2542 if (string2
== end_str2
)
2545 if (*string2
!= ':')
2551 while (ISSPACE (*string1
))
2553 while (string2
< end_str2
&& ISSPACE (*string2
))
2558 /* Handle C++ user-defined operators. */
2559 else if (language
== language_cplus
2562 if (cp_is_operator (string1
, string1_start
))
2564 /* An operator name in STRING1. Check STRING2. */
2566 = std::min
<size_t> (CP_OPERATOR_LEN
, end_str2
- string2
);
2567 if (strncmp (string1
, string2
, cmplen
) != 0)
2573 if (string2
!= end_str2
)
2575 /* Check for "operatorX" in STRING2. */
2576 if (valid_identifier_name_char (*string2
))
2579 skip_ws (string1
, string2
, end_str2
);
2582 /* Handle operator(). */
2583 if (*string1
== '(')
2585 if (string2
== end_str2
)
2587 if (mode
== strncmp_iw_mode::NORMAL
)
2591 /* Don't break for the regular return at the
2592 bottom, because "operator" should not
2593 match "operator()", since this open
2594 parentheses is not the parameter list
2596 return *string1
!= '\0';
2600 if (*string1
!= *string2
)
2609 skip_ws (string1
, string2
, end_str2
);
2611 /* Skip to end of token, or to END, whatever comes
2613 const char *end_str1
= string1
+ strlen (string1
);
2614 const char *p1
= cp_skip_operator_token (string1
, end_str1
);
2615 const char *p2
= cp_skip_operator_token (string2
, end_str2
);
2617 cmplen
= std::min (p1
- string1
, p2
- string2
);
2620 if (strncmp (string1
, string2
, cmplen
) != 0)
2625 if (p1
- string1
!= p2
- string2
)
2627 if (strncmp (string1
, string2
, cmplen
) != 0)
2634 if (*string1
== '\0' || string2
== end_str2
)
2636 if (*string1
== '(' || *string2
== '(')
2644 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2646 if (case_sensitivity
== case_sensitive_off
2647 && (TOLOWER ((unsigned char) *string1
)
2648 != TOLOWER ((unsigned char) *string2
)))
2651 /* If we see any non-whitespace, non-identifier-name character
2652 (any of "()<>*&" etc.), then skip spaces the next time
2654 if (!ISSPACE (*string1
) && !valid_identifier_name_char (*string1
))
2661 if (string2
== end_str2
)
2663 if (mode
== strncmp_iw_mode::NORMAL
)
2665 /* Strip abi tag markers from the matched symbol name.
2666 Usually the ABI marker will be found on function name
2667 (automatically added because the function returns an
2668 object marked with an ABI tag). However, it's also
2669 possible to see a marker in one of the function
2670 parameters, for example.
2672 string2 (lookup name):
2675 function(some_struct[abi:cxx11], int)
2677 and for completion LCD computation we want to say that
2679 function(some_struct, int)
2681 if (match_for_lcd
!= NULL
)
2683 while ((string1
= strstr (string1
, "[abi:")) != NULL
)
2685 const char *abi_start
= string1
;
2687 /* There can be more than one tag. */
2688 while (skip_abi_tag (&string1
) && *string1
== '[')
2691 if (abi_start
!= string1
)
2692 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2699 return (*string1
!= '\0' && *string1
!= '(');
2708 strncmp_iw (const char *string1
, const char *string2
, size_t string2_len
)
2710 return strncmp_iw_with_mode (string1
, string2
, string2_len
,
2711 strncmp_iw_mode::NORMAL
, language_minimal
);
2717 strcmp_iw (const char *string1
, const char *string2
)
2719 return strncmp_iw_with_mode (string1
, string2
, strlen (string2
),
2720 strncmp_iw_mode::MATCH_PARAMS
, language_minimal
);
2723 /* This is like strcmp except that it ignores whitespace and treats
2724 '(' as the first non-NULL character in terms of ordering. Like
2725 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2726 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2727 according to that ordering.
2729 If a list is sorted according to this function and if you want to
2730 find names in the list that match some fixed NAME according to
2731 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2732 where this function would put NAME.
2734 This function must be neutral to the CASE_SENSITIVITY setting as the user
2735 may choose it during later lookup. Therefore this function always sorts
2736 primarily case-insensitively and secondarily case-sensitively.
2738 Here are some examples of why using strcmp to sort is a bad idea:
2742 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2743 we try to do a search for "foo<char*>", strcmp will locate this
2744 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2745 will start looking at strings beginning with "goo", and will never
2746 see the correct match of "foo<char *>".
2748 Parenthesis example:
2750 In practice, this is less like to be an issue, but I'll give it a
2751 shot. Let's assume that '$' is a legitimate character to occur in
2752 symbols. (Which may well even be the case on some systems.) Then
2753 say that the partial symbol table contains "foo$" and "foo(int)".
2754 strcmp will put them in this order, since '$' < '('. Now, if the
2755 user searches for "foo", then strcmp will sort "foo" before "foo$".
2756 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2757 "foo") is false, so it won't proceed to the actual match of
2758 "foo(int)" with "foo". */
2761 strcmp_iw_ordered (const char *string1
, const char *string2
)
2763 const char *saved_string1
= string1
, *saved_string2
= string2
;
2764 enum case_sensitivity case_pass
= case_sensitive_off
;
2768 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2769 Provide stub characters if we are already at the end of one of the
2771 char c1
= 'X', c2
= 'X';
2773 while (*string1
!= '\0' && *string2
!= '\0')
2775 while (ISSPACE (*string1
))
2777 while (ISSPACE (*string2
))
2782 case case_sensitive_off
:
2783 c1
= TOLOWER ((unsigned char) *string1
);
2784 c2
= TOLOWER ((unsigned char) *string2
);
2786 case case_sensitive_on
:
2794 if (*string1
!= '\0')
2803 /* Characters are non-equal unless they're both '\0'; we want to
2804 make sure we get the comparison right according to our
2805 comparison in the cases where one of them is '\0' or '('. */
2807 if (*string2
== '\0')
2812 if (*string2
== '\0')
2817 if (*string2
== '\0' || *string2
== '(')
2826 if (case_pass
== case_sensitive_on
)
2829 /* Otherwise the strings were equal in case insensitive way, make
2830 a more fine grained comparison in a case sensitive way. */
2832 case_pass
= case_sensitive_on
;
2833 string1
= saved_string1
;
2834 string2
= saved_string2
;
2841 streq (const char *lhs
, const char *rhs
)
2843 return !strcmp (lhs
, rhs
);
2849 streq_hash (const void *lhs
, const void *rhs
)
2851 return streq ((const char *) lhs
, (const char *) rhs
);
2858 ** Answer whether string_to_compare is a full or partial match to
2859 ** template_string. The partial match must be in sequence starting
2863 subset_compare (const char *string_to_compare
, const char *template_string
)
2867 if (template_string
!= NULL
&& string_to_compare
!= NULL
2868 && strlen (string_to_compare
) <= strlen (template_string
))
2870 (startswith (template_string
, string_to_compare
));
2877 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2878 struct cmd_list_element
*c
, const char *value
)
2880 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2888 address_significant (gdbarch
*gdbarch
, CORE_ADDR addr
)
2890 /* Clear insignificant bits of a target address and sign extend resulting
2891 address, avoiding shifts larger or equal than the width of a CORE_ADDR.
2892 The local variable ADDR_BIT stops the compiler reporting a shift overflow
2893 when it won't occur. Skip updating of target address if current target
2894 has not set gdbarch significant_addr_bit. */
2895 int addr_bit
= gdbarch_significant_addr_bit (gdbarch
);
2897 if (addr_bit
&& (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
)))
2899 CORE_ADDR sign
= (CORE_ADDR
) 1 << (addr_bit
- 1);
2900 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2901 addr
= (addr
^ sign
) - sign
;
2908 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2910 /* Truncate address to the size of a target address, avoiding shifts
2911 larger or equal than the width of a CORE_ADDR. The local
2912 variable ADDR_BIT stops the compiler reporting a shift overflow
2913 when it won't occur. */
2914 /* NOTE: This assumes that the significant address information is
2915 kept in the least significant bits of ADDR - the upper bits were
2916 either zero or sign extended. Should gdbarch_address_to_pointer or
2917 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2919 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2921 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2922 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2923 return hex_string (addr
);
2926 /* This function is described in "defs.h". */
2929 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2931 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2933 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2934 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2936 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2937 that returns the language localized string formatted to a width
2938 based on gdbarch_addr_bit. */
2940 return hex_string_custom (address
, 8);
2942 return hex_string_custom (address
, 16);
2945 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2948 core_addr_hash (const void *ap
)
2950 const CORE_ADDR
*addrp
= (const CORE_ADDR
*) ap
;
2955 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2958 core_addr_eq (const void *ap
, const void *bp
)
2960 const CORE_ADDR
*addr_ap
= (const CORE_ADDR
*) ap
;
2961 const CORE_ADDR
*addr_bp
= (const CORE_ADDR
*) bp
;
2963 return *addr_ap
== *addr_bp
;
2966 /* Convert a string back into a CORE_ADDR. */
2968 string_to_core_addr (const char *my_string
)
2972 if (my_string
[0] == '0' && TOLOWER (my_string
[1]) == 'x')
2974 /* Assume that it is in hex. */
2977 for (i
= 2; my_string
[i
] != '\0'; i
++)
2979 if (ISDIGIT (my_string
[i
]))
2980 addr
= (my_string
[i
] - '0') + (addr
* 16);
2981 else if (ISXDIGIT (my_string
[i
]))
2982 addr
= (TOLOWER (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2984 error (_("invalid hex \"%s\""), my_string
);
2989 /* Assume that it is in decimal. */
2992 for (i
= 0; my_string
[i
] != '\0'; i
++)
2994 if (ISDIGIT (my_string
[i
]))
2995 addr
= (my_string
[i
] - '0') + (addr
* 10);
2997 error (_("invalid decimal \"%s\""), my_string
);
3007 gdb_realpath_check_trailer (const char *input
, const char *trailer
)
3009 gdb::unique_xmalloc_ptr
<char> result
= gdb_realpath (input
);
3011 size_t len
= strlen (result
.get ());
3012 size_t trail_len
= strlen (trailer
);
3014 SELF_CHECK (len
>= trail_len
3015 && strcmp (result
.get () + len
- trail_len
, trailer
) == 0);
3019 gdb_realpath_tests ()
3021 /* A file which contains a directory prefix. */
3022 gdb_realpath_check_trailer ("./xfullpath.exp", "/xfullpath.exp");
3023 /* A file which contains a directory prefix. */
3024 gdb_realpath_check_trailer ("../../defs.h", "/defs.h");
3025 /* A one-character filename. */
3026 gdb_realpath_check_trailer ("./a", "/a");
3027 /* A file in the root directory. */
3028 gdb_realpath_check_trailer ("/root_file_which_should_exist",
3029 "/root_file_which_should_exist");
3030 /* A file which does not have a directory prefix. */
3031 gdb_realpath_check_trailer ("xfullpath.exp", "xfullpath.exp");
3032 /* A one-char filename without any directory prefix. */
3033 gdb_realpath_check_trailer ("a", "a");
3034 /* An empty filename. */
3035 gdb_realpath_check_trailer ("", "");
3038 /* Test the gdb_argv::as_array_view method. */
3041 gdb_argv_as_array_view_test ()
3046 gdb::array_view
<char *> view
= argv
.as_array_view ();
3048 SELF_CHECK (view
.data () == nullptr);
3049 SELF_CHECK (view
.size () == 0);
3052 gdb_argv
argv ("une bonne 50");
3054 gdb::array_view
<char *> view
= argv
.as_array_view ();
3056 SELF_CHECK (view
.size () == 3);
3057 SELF_CHECK (strcmp (view
[0], "une") == 0);
3058 SELF_CHECK (strcmp (view
[1], "bonne") == 0);
3059 SELF_CHECK (strcmp (view
[2], "50") == 0);
3063 #endif /* GDB_SELF_TEST */
3065 /* Allocation function for the libiberty hash table which uses an
3066 obstack. The obstack is passed as DATA. */
3069 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
3071 size_t total
= size
* count
;
3072 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
3074 memset (ptr
, 0, total
);
3078 /* Trivial deallocation function for the libiberty splay tree and hash
3079 table - don't deallocate anything. Rely on later deletion of the
3080 obstack. DATA will be the obstack, although it is not needed
3084 dummy_obstack_deallocate (void *object
, void *data
)
3089 /* Simple, portable version of dirname that does not modify its
3093 ldirname (const char *filename
)
3095 std::string dirname
;
3096 const char *base
= lbasename (filename
);
3098 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
3101 if (base
== filename
)
3104 dirname
= std::string (filename
, base
- filename
);
3106 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3107 create "d:./bar" later instead of the (different) "d:/bar". */
3108 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3109 && !IS_DIR_SEPARATOR (filename
[0]))
3110 dirname
[base
++ - filename
] = '.';
3118 gdb_argv::reset (const char *s
)
3120 char **argv
= buildargv (s
);
3126 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3127 #define AMBIGUOUS_MESS2 \
3128 ".\nUse \"set gnutarget format-name\" to specify the format."
3131 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3135 /* Check if errmsg just need simple return. */
3136 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3137 return bfd_errmsg (error_tag
);
3139 std::string
ret (bfd_errmsg (error_tag
));
3140 ret
+= AMBIGUOUS_MESS1
;
3142 for (p
= matching
; *p
; p
++)
3147 ret
+= AMBIGUOUS_MESS2
;
3154 /* Return ARGS parsed as a valid pid, or throw an error. */
3157 parse_pid_to_attach (const char *args
)
3163 error_no_arg (_("process-id to attach"));
3165 dummy
= (char *) args
;
3166 pid
= strtoul (args
, &dummy
, 0);
3167 /* Some targets don't set errno on errors, grrr! */
3168 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3169 error (_("Illegal process-id: %s."), args
);
3174 /* Substitute all occurrences of string FROM by string TO in *STRINGP. *STRINGP
3175 must come from xrealloc-compatible allocator and it may be updated. FROM
3176 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3177 located at the start or end of *STRINGP. */
3180 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3182 char *string
= *stringp
, *s
;
3183 const size_t from_len
= strlen (from
);
3184 const size_t to_len
= strlen (to
);
3188 s
= strstr (s
, from
);
3192 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3193 || s
[-1] == DIRNAME_SEPARATOR
)
3194 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3195 || s
[from_len
] == DIRNAME_SEPARATOR
))
3200 = (char *) xrealloc (string
, (strlen (string
) + to_len
+ 1));
3202 /* Relocate the current S pointer. */
3203 s
= s
- string
+ string_new
;
3204 string
= string_new
;
3206 /* Replace from by to. */
3207 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3208 memcpy (s
, to
, to_len
);
3223 /* SIGALRM handler for waitpid_with_timeout. */
3226 sigalrm_handler (int signo
)
3228 /* Nothing to do. */
3233 /* Wrapper to wait for child PID to die with TIMEOUT.
3234 TIMEOUT is the time to stop waiting in seconds.
3235 If TIMEOUT is zero, pass WNOHANG to waitpid.
3236 Returns PID if it was successfully waited for, otherwise -1.
3238 Timeouts are currently implemented with alarm and SIGALRM.
3239 If the host does not support them, this waits "forever".
3240 It would be odd though for a host to have waitpid and not SIGALRM. */
3243 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3245 pid_t waitpid_result
;
3247 gdb_assert (pid
> 0);
3248 gdb_assert (timeout
>= 0);
3253 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3254 struct sigaction sa
, old_sa
;
3256 sa
.sa_handler
= sigalrm_handler
;
3257 sigemptyset (&sa
.sa_mask
);
3259 sigaction (SIGALRM
, &sa
, &old_sa
);
3263 ofunc
= signal (SIGALRM
, sigalrm_handler
);
3269 waitpid_result
= waitpid (pid
, status
, 0);
3273 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3274 sigaction (SIGALRM
, &old_sa
, NULL
);
3276 signal (SIGALRM
, ofunc
);
3281 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3283 if (waitpid_result
== pid
)
3289 #endif /* HAVE_WAITPID */
3291 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3292 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3294 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3295 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3298 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3300 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3302 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3303 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3305 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3307 char *pattern_slash
, *string_slash
;
3309 /* Replace '\' by '/' in both strings. */
3311 pattern_slash
= (char *) alloca (strlen (pattern
) + 1);
3312 strcpy (pattern_slash
, pattern
);
3313 pattern
= pattern_slash
;
3314 for (; *pattern_slash
!= 0; pattern_slash
++)
3315 if (IS_DIR_SEPARATOR (*pattern_slash
))
3316 *pattern_slash
= '/';
3318 string_slash
= (char *) alloca (strlen (string
) + 1);
3319 strcpy (string_slash
, string
);
3320 string
= string_slash
;
3321 for (; *string_slash
!= 0; string_slash
++)
3322 if (IS_DIR_SEPARATOR (*string_slash
))
3323 *string_slash
= '/';
3325 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3327 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3328 flags
|= FNM_CASEFOLD
;
3329 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3331 return fnmatch (pattern
, string
, flags
);
3334 /* Return the number of path elements in PATH.
3342 count_path_elements (const char *path
)
3345 const char *p
= path
;
3347 if (HAS_DRIVE_SPEC (p
))
3349 p
= STRIP_DRIVE_SPEC (p
);
3355 if (IS_DIR_SEPARATOR (*p
))
3360 /* Backup one if last character is /, unless it's the only one. */
3361 if (p
> path
+ 1 && IS_DIR_SEPARATOR (p
[-1]))
3364 /* Add one for the file name, if present. */
3365 if (p
> path
&& !IS_DIR_SEPARATOR (p
[-1]))
3371 /* Remove N leading path elements from PATH.
3372 N must be non-negative.
3373 If PATH has more than N path elements then return NULL.
3374 If PATH has exactly N path elements then return "".
3375 See count_path_elements for a description of how we do the counting. */
3378 strip_leading_path_elements (const char *path
, int n
)
3381 const char *p
= path
;
3383 gdb_assert (n
>= 0);
3388 if (HAS_DRIVE_SPEC (p
))
3390 p
= STRIP_DRIVE_SPEC (p
);
3396 while (*p
!= '\0' && !IS_DIR_SEPARATOR (*p
))
3414 copy_bitwise (gdb_byte
*dest
, ULONGEST dest_offset
,
3415 const gdb_byte
*source
, ULONGEST source_offset
,
3416 ULONGEST nbits
, int bits_big_endian
)
3418 unsigned int buf
, avail
;
3423 if (bits_big_endian
)
3425 /* Start from the end, then work backwards. */
3426 dest_offset
+= nbits
- 1;
3427 dest
+= dest_offset
/ 8;
3428 dest_offset
= 7 - dest_offset
% 8;
3429 source_offset
+= nbits
- 1;
3430 source
+= source_offset
/ 8;
3431 source_offset
= 7 - source_offset
% 8;
3435 dest
+= dest_offset
/ 8;
3437 source
+= source_offset
/ 8;
3441 /* Fill BUF with DEST_OFFSET bits from the destination and 8 -
3442 SOURCE_OFFSET bits from the source. */
3443 buf
= *(bits_big_endian
? source
-- : source
++) >> source_offset
;
3444 buf
<<= dest_offset
;
3445 buf
|= *dest
& ((1 << dest_offset
) - 1);
3447 /* NBITS: bits yet to be written; AVAIL: BUF's fill level. */
3448 nbits
+= dest_offset
;
3449 avail
= dest_offset
+ 8 - source_offset
;
3451 /* Flush 8 bits from BUF, if appropriate. */
3452 if (nbits
>= 8 && avail
>= 8)
3454 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3460 /* Copy the middle part. */
3463 size_t len
= nbits
/ 8;
3465 /* Use a faster method for byte-aligned copies. */
3468 if (bits_big_endian
)
3472 memcpy (dest
+ 1, source
+ 1, len
);
3476 memcpy (dest
, source
, len
);
3485 buf
|= *(bits_big_endian
? source
-- : source
++) << avail
;
3486 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3493 /* Write the last byte. */
3497 buf
|= *source
<< avail
;
3499 buf
&= (1 << nbits
) - 1;
3500 *dest
= (*dest
& (~0U << nbits
)) | buf
;
3504 void _initialize_utils ();
3506 _initialize_utils ()
3508 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
3509 Set number of characters where GDB should wrap lines of its output."), _("\
3510 Show number of characters where GDB should wrap lines of its output."), _("\
3511 This affects where GDB wraps its output to fit the screen width.\n\
3512 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
3514 show_chars_per_line
,
3515 &setlist
, &showlist
);
3517 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
3518 Set number of lines in a page for GDB output pagination."), _("\
3519 Show number of lines in a page for GDB output pagination."), _("\
3520 This affects the number of lines after which GDB will pause\n\
3521 its output and ask you whether to continue.\n\
3522 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
3524 show_lines_per_page
,
3525 &setlist
, &showlist
);
3527 add_setshow_boolean_cmd ("pagination", class_support
,
3528 &pagination_enabled
, _("\
3529 Set state of GDB output pagination."), _("\
3530 Show state of GDB output pagination."), _("\
3531 When pagination is ON, GDB pauses at end of each screenful of\n\
3532 its output and asks you whether to continue.\n\
3533 Turning pagination off is an alternative to \"set height unlimited\"."),
3535 show_pagination_enabled
,
3536 &setlist
, &showlist
);
3538 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
3539 &sevenbit_strings
, _("\
3540 Set printing of 8-bit characters in strings as \\nnn."), _("\
3541 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
3543 show_sevenbit_strings
,
3544 &setprintlist
, &showprintlist
);
3546 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
3547 &debug_timestamp
, _("\
3548 Set timestamping of debugging messages."), _("\
3549 Show timestamping of debugging messages."), _("\
3550 When set, debugging messages will be marked with seconds and microseconds."),
3552 show_debug_timestamp
,
3553 &setdebuglist
, &showdebuglist
);
3555 add_internal_problem_command (&internal_error_problem
);
3556 add_internal_problem_command (&internal_warning_problem
);
3557 add_internal_problem_command (&demangler_warning_problem
);
3560 selftests::register_test ("gdb_realpath", gdb_realpath_tests
);
3561 selftests::register_test ("gdb_argv_array_view", gdb_argv_as_array_view_test
);