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"
78 void (*deprecated_error_begin_hook
) (void);
80 /* Prototypes for local functions */
82 static void vfprintf_maybe_filtered (struct ui_file
*, const char *,
84 ATTRIBUTE_PRINTF (2, 0);
86 static void fputs_maybe_filtered (const char *, struct ui_file
*, int);
88 static void prompt_for_continue (void);
90 static void set_screen_size (void);
91 static void set_width (void);
93 /* Time spent in prompt_for_continue in the currently executing command
94 waiting for user to respond.
95 Initialized in make_command_stats_cleanup.
96 Modified in prompt_for_continue and defaulted_query.
97 Used in report_command_stats. */
99 static std::chrono::steady_clock::duration prompt_for_continue_wait_time
;
101 /* A flag indicating whether to timestamp debugging messages. */
103 static bool debug_timestamp
= false;
105 /* True means that strings with character values >0x7F should be printed
106 as octal escapes. False means just print the value (e.g. it's an
107 international character, and the terminal or window can cope.) */
109 bool sevenbit_strings
= false;
111 show_sevenbit_strings (struct ui_file
*file
, int from_tty
,
112 struct cmd_list_element
*c
, const char *value
)
114 fprintf_filtered (file
, _("Printing of 8-bit characters "
115 "in strings as \\nnn is %s.\n"),
119 /* String to be printed before warning messages, if any. */
121 const char *warning_pre_print
= "\nwarning: ";
123 bool pagination_enabled
= true;
125 show_pagination_enabled (struct ui_file
*file
, int from_tty
,
126 struct cmd_list_element
*c
, const char *value
)
128 fprintf_filtered (file
, _("State of pagination is %s.\n"), value
);
134 /* Print a warning message. The first argument STRING is the warning
135 message, used as an fprintf format string, the second is the
136 va_list of arguments for that string. A warning is unfiltered (not
137 paginated) so that the user does not need to page through each
138 screen full of warnings when there are lots of them. */
141 vwarning (const char *string
, va_list args
)
143 if (deprecated_warning_hook
)
144 (*deprecated_warning_hook
) (string
, args
);
147 gdb::optional
<target_terminal::scoped_restore_terminal_state
> term_state
;
148 if (target_supports_terminal_ours ())
150 term_state
.emplace ();
151 target_terminal::ours_for_output ();
153 if (filtered_printing_initialized ())
154 wrap_here (""); /* Force out any buffered output. */
155 gdb_flush (gdb_stdout
);
156 if (warning_pre_print
)
157 fputs_unfiltered (warning_pre_print
, gdb_stderr
);
158 vfprintf_unfiltered (gdb_stderr
, string
, args
);
159 fprintf_unfiltered (gdb_stderr
, "\n");
163 /* Print an error message and return to command level.
164 The first argument STRING is the error message, used as a fprintf string,
165 and the remaining args are passed as arguments to it. */
168 verror (const char *string
, va_list args
)
170 throw_verror (GENERIC_ERROR
, string
, args
);
174 error_stream (const string_file
&stream
)
176 error (("%s"), stream
.c_str ());
179 /* Emit a message and abort. */
181 static void ATTRIBUTE_NORETURN
182 abort_with_message (const char *msg
)
184 if (current_ui
== NULL
)
187 fputs_unfiltered (msg
, gdb_stderr
);
189 abort (); /* ARI: abort */
192 /* Dump core trying to increase the core soft limit to hard limit first. */
197 #ifdef HAVE_SETRLIMIT
198 struct rlimit rlim
= { (rlim_t
) RLIM_INFINITY
, (rlim_t
) RLIM_INFINITY
};
200 setrlimit (RLIMIT_CORE
, &rlim
);
201 #endif /* HAVE_SETRLIMIT */
203 abort (); /* ARI: abort */
206 /* Check whether GDB will be able to dump core using the dump_core
207 function. Returns zero if GDB cannot or should not dump core.
208 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
209 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
212 can_dump_core (enum resource_limit_kind limit_kind
)
214 #ifdef HAVE_GETRLIMIT
217 /* Be quiet and assume we can dump if an error is returned. */
218 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
224 if (rlim
.rlim_cur
== 0)
229 if (rlim
.rlim_max
== 0)
232 #endif /* HAVE_GETRLIMIT */
237 /* Print a warning that we cannot dump core. */
240 warn_cant_dump_core (const char *reason
)
242 fprintf_unfiltered (gdb_stderr
,
243 _("%s\nUnable to dump core, use `ulimit -c"
244 " unlimited' before executing GDB next time.\n"),
248 /* Check whether GDB will be able to dump core using the dump_core
249 function, and print a warning if we cannot. */
252 can_dump_core_warn (enum resource_limit_kind limit_kind
,
255 int core_dump_allowed
= can_dump_core (limit_kind
);
257 if (!core_dump_allowed
)
258 warn_cant_dump_core (reason
);
260 return core_dump_allowed
;
263 /* Allow the user to configure the debugger behavior with respect to
264 what to do when an internal problem is detected. */
266 const char internal_problem_ask
[] = "ask";
267 const char internal_problem_yes
[] = "yes";
268 const char internal_problem_no
[] = "no";
269 static const char *const internal_problem_modes
[] =
271 internal_problem_ask
,
272 internal_problem_yes
,
277 /* Print a message reporting an internal error/warning. Ask the user
278 if they want to continue, dump core, or just exit. Return
279 something to indicate a quit. */
281 struct internal_problem
284 int user_settable_should_quit
;
285 const char *should_quit
;
286 int user_settable_should_dump_core
;
287 const char *should_dump_core
;
290 /* Report a problem, internal to GDB, to the user. Once the problem
291 has been reported, and assuming GDB didn't quit, the caller can
292 either allow execution to resume or throw an error. */
294 static void ATTRIBUTE_PRINTF (4, 0)
295 internal_vproblem (struct internal_problem
*problem
,
296 const char *file
, int line
, const char *fmt
, va_list ap
)
303 /* Don't allow infinite error/warning recursion. */
305 static const char msg
[] = "Recursive internal problem.\n";
314 abort_with_message (msg
);
317 /* Newer GLIBC versions put the warn_unused_result attribute
318 on write, but this is one of those rare cases where
319 ignoring the return value is correct. Casting to (void)
320 does not fix this problem. This is the solution suggested
321 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
322 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
323 abort (); /* ARI: abort */
328 /* Create a string containing the full error/warning message. Need
329 to call query with this full string, as otherwize the reason
330 (error/warning) and question become separated. Format using a
331 style similar to a compiler error message. Include extra detail
332 so that the user knows that they are living on the edge. */
334 std::string msg
= string_vprintf (fmt
, ap
);
335 reason
= string_printf ("%s:%d: %s: %s\n"
336 "A problem internal to GDB has been detected,\n"
337 "further debugging may prove unreliable.",
338 file
, line
, problem
->name
, msg
.c_str ());
341 /* Fall back to abort_with_message if gdb_stderr is not set up. */
342 if (current_ui
== NULL
)
344 fputs (reason
.c_str (), stderr
);
345 abort_with_message ("\n");
348 /* Try to get the message out and at the start of a new line. */
349 gdb::optional
<target_terminal::scoped_restore_terminal_state
> term_state
;
350 if (target_supports_terminal_ours ())
352 term_state
.emplace ();
353 target_terminal::ours_for_output ();
355 if (filtered_printing_initialized ())
358 /* Emit the message unless query will emit it below. */
359 if (problem
->should_quit
!= internal_problem_ask
361 || !filtered_printing_initialized ())
362 fprintf_unfiltered (gdb_stderr
, "%s\n", reason
.c_str ());
364 if (problem
->should_quit
== internal_problem_ask
)
366 /* Default (yes/batch case) is to quit GDB. When in batch mode
367 this lessens the likelihood of GDB going into an infinite
369 if (!confirm
|| !filtered_printing_initialized ())
372 quit_p
= query (_("%s\nQuit this debugging session? "),
375 else if (problem
->should_quit
== internal_problem_yes
)
377 else if (problem
->should_quit
== internal_problem_no
)
380 internal_error (__FILE__
, __LINE__
, _("bad switch"));
382 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr
);
383 if (REPORT_BUGS_TO
[0])
384 fprintf_unfiltered (gdb_stderr
, _(" For instructions, see:\n%s."),
386 fputs_unfiltered ("\n\n", gdb_stderr
);
388 if (problem
->should_dump_core
== internal_problem_ask
)
390 if (!can_dump_core_warn (LIMIT_MAX
, reason
.c_str ()))
392 else if (!filtered_printing_initialized ())
396 /* Default (yes/batch case) is to dump core. This leaves a GDB
397 `dropping' so that it is easier to see that something went
399 dump_core_p
= query (_("%s\nCreate a core file of GDB? "),
403 else if (problem
->should_dump_core
== internal_problem_yes
)
404 dump_core_p
= can_dump_core_warn (LIMIT_MAX
, reason
.c_str ());
405 else if (problem
->should_dump_core
== internal_problem_no
)
408 internal_error (__FILE__
, __LINE__
, _("bad switch"));
421 #ifdef HAVE_WORKING_FORK
431 static struct internal_problem internal_error_problem
= {
432 "internal-error", 1, internal_problem_ask
, 1, internal_problem_ask
436 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
438 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
439 throw_quit (_("Command aborted."));
442 static struct internal_problem internal_warning_problem
= {
443 "internal-warning", 1, internal_problem_ask
, 1, internal_problem_ask
447 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
449 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
452 static struct internal_problem demangler_warning_problem
= {
453 "demangler-warning", 1, internal_problem_ask
, 0, internal_problem_no
457 demangler_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
459 internal_vproblem (&demangler_warning_problem
, file
, line
, fmt
, ap
);
463 demangler_warning (const char *file
, int line
, const char *string
, ...)
467 va_start (ap
, string
);
468 demangler_vwarning (file
, line
, string
, ap
);
472 /* When GDB reports an internal problem (error or warning) it gives
473 the user the opportunity to quit GDB and/or create a core file of
474 the current debug session. This function registers a few commands
475 that make it possible to specify that GDB should always or never
476 quit or create a core file, without asking. The commands look
479 maint set PROBLEM-NAME quit ask|yes|no
480 maint show PROBLEM-NAME quit
481 maint set PROBLEM-NAME corefile ask|yes|no
482 maint show PROBLEM-NAME corefile
484 Where PROBLEM-NAME is currently "internal-error" or
485 "internal-warning". */
488 add_internal_problem_command (struct internal_problem
*problem
)
490 struct cmd_list_element
**set_cmd_list
;
491 struct cmd_list_element
**show_cmd_list
;
495 set_cmd_list
= XNEW (struct cmd_list_element
*);
496 show_cmd_list
= XNEW (struct cmd_list_element
*);
497 *set_cmd_list
= NULL
;
498 *show_cmd_list
= NULL
;
500 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
503 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
506 add_basic_prefix_cmd (problem
->name
, class_maintenance
, set_doc
,
508 concat ("maintenance set ", problem
->name
, " ",
510 0/*allow-unknown*/, &maintenance_set_cmdlist
);
512 add_show_prefix_cmd (problem
->name
, class_maintenance
, show_doc
,
514 concat ("maintenance show ", problem
->name
, " ",
516 0/*allow-unknown*/, &maintenance_show_cmdlist
);
518 if (problem
->user_settable_should_quit
)
520 set_doc
= xstrprintf (_("Set whether GDB should quit "
521 "when an %s is detected."),
523 show_doc
= xstrprintf (_("Show whether GDB will quit "
524 "when an %s is detected."),
526 add_setshow_enum_cmd ("quit", class_maintenance
,
527 internal_problem_modes
,
528 &problem
->should_quit
,
541 if (problem
->user_settable_should_dump_core
)
543 set_doc
= xstrprintf (_("Set whether GDB should create a core "
544 "file of GDB when %s is detected."),
546 show_doc
= xstrprintf (_("Show whether GDB will create a core "
547 "file of GDB when %s is detected."),
549 add_setshow_enum_cmd ("corefile", class_maintenance
,
550 internal_problem_modes
,
551 &problem
->should_dump_core
,
565 /* Return a newly allocated string, containing the PREFIX followed
566 by the system error message for errno (separated by a colon). */
569 perror_string (const char *prefix
)
571 const char *err
= safe_strerror (errno
);
572 return std::string (prefix
) + ": " + err
;
575 /* Print the system error message for errno, and also mention STRING
576 as the file name for which the error was encountered. Use ERRCODE
577 for the thrown exception. Then return to command level. */
580 throw_perror_with_name (enum errors errcode
, const char *string
)
582 std::string combined
= perror_string (string
);
584 /* I understand setting these is a matter of taste. Still, some people
585 may clear errno but not know about bfd_error. Doing this here is not
587 bfd_set_error (bfd_error_no_error
);
590 throw_error (errcode
, _("%s."), combined
.c_str ());
593 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
596 perror_with_name (const char *string
)
598 throw_perror_with_name (GENERIC_ERROR
, string
);
601 /* Same as perror_with_name except that it prints a warning instead
602 of throwing an error. */
605 perror_warning_with_name (const char *string
)
607 std::string combined
= perror_string (string
);
608 warning (_("%s"), combined
.c_str ());
611 /* Print the system error message for ERRCODE, and also mention STRING
612 as the file name for which the error was encountered. */
615 print_sys_errmsg (const char *string
, int errcode
)
617 const char *err
= safe_strerror (errcode
);
618 /* We want anything which was printed on stdout to come out first, before
620 gdb_flush (gdb_stdout
);
621 fprintf_unfiltered (gdb_stderr
, "%s: %s.\n", string
, err
);
624 /* Control C eventually causes this to be called, at a convenient time. */
629 if (sync_quit_force_run
)
631 sync_quit_force_run
= 0;
632 quit_force (NULL
, 0);
636 /* No steenking SIGINT will ever be coming our way when the
637 program is resumed. Don't lie. */
641 /* If there is no terminal switching for this target, then we can't
642 possibly get screwed by the lack of job control. */
643 || !target_supports_terminal_ours ())
646 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
655 if (sync_quit_force_run
)
662 /* Called when a memory allocation fails, with the number of bytes of
663 memory requested in SIZE. */
666 malloc_failure (long size
)
670 internal_error (__FILE__
, __LINE__
,
671 _("virtual memory exhausted: can't allocate %ld bytes."),
676 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
680 /* See common/errors.h. */
685 gdb_stdout
->flush ();
686 gdb_stderr
->flush ();
689 /* My replacement for the read system call.
690 Used like `read' but keeps going if `read' returns too soon. */
693 myread (int desc
, char *addr
, int len
)
700 val
= read (desc
, addr
, len
);
712 print_spaces (int n
, struct ui_file
*file
)
714 fputs_unfiltered (n_spaces (n
), file
);
717 /* Print a host address. */
720 gdb_print_host_address_1 (const void *addr
, struct ui_file
*stream
)
722 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
727 /* An RAII class that sets up to handle input and then tears down
728 during destruction. */
730 class scoped_input_handler
734 scoped_input_handler ()
735 : m_quit_handler (&quit_handler
, default_quit_handler
),
738 target_terminal::ours ();
739 ui_register_input_event_handler (current_ui
);
740 if (current_ui
->prompt_state
== PROMPT_BLOCKED
)
744 ~scoped_input_handler ()
747 ui_unregister_input_event_handler (m_ui
);
750 DISABLE_COPY_AND_ASSIGN (scoped_input_handler
);
754 /* Save and restore the terminal state. */
755 target_terminal::scoped_restore_terminal_state m_term_state
;
757 /* Save and restore the quit handler. */
758 scoped_restore_tmpl
<quit_handler_ftype
*> m_quit_handler
;
760 /* The saved UI, if non-NULL. */
766 /* This function supports the query, nquery, and yquery functions.
767 Ask user a y-or-n question and return 0 if answer is no, 1 if
768 answer is yes, or default the answer to the specified default
769 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
770 default answer, or '\0' for no default.
771 CTLSTR is the control string and should end in "? ". It should
772 not say how to answer, because we do that.
773 ARGS are the arguments passed along with the CTLSTR argument to
776 static int ATTRIBUTE_PRINTF (1, 0)
777 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
781 char def_answer
, not_def_answer
;
782 const char *y_string
, *n_string
;
784 /* Set up according to which answer is the default. */
789 not_def_answer
= 'N';
793 else if (defchar
== 'y')
797 not_def_answer
= 'N';
805 not_def_answer
= 'Y';
810 /* Automatically answer the default value if the user did not want
811 prompts or the command was issued with the server prefix. */
812 if (!confirm
|| server_command
)
815 /* If input isn't coming from the user directly, just say what
816 question we're asking, and then answer the default automatically. This
817 way, important error messages don't get lost when talking to GDB
819 if (current_ui
->instream
!= current_ui
->stdin_stream
820 || !input_interactive_p (current_ui
)
821 /* Restrict queries to the main UI. */
822 || current_ui
!= main_ui
)
824 target_terminal::scoped_restore_terminal_state term_state
;
825 target_terminal::ours_for_output ();
827 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
829 printf_filtered (_("(%s or %s) [answered %c; "
830 "input not from terminal]\n"),
831 y_string
, n_string
, def_answer
);
836 if (deprecated_query_hook
)
838 target_terminal::scoped_restore_terminal_state term_state
;
839 return deprecated_query_hook (ctlstr
, args
);
842 /* Format the question outside of the loop, to avoid reusing args. */
843 std::string question
= string_vprintf (ctlstr
, args
);
845 = string_printf (_("%s%s(%s or %s) %s"),
846 annotation_level
> 1 ? "\n\032\032pre-query\n" : "",
847 question
.c_str (), y_string
, n_string
,
848 annotation_level
> 1 ? "\n\032\032query\n" : "");
850 /* Used to add duration we waited for user to respond to
851 prompt_for_continue_wait_time. */
852 using namespace std::chrono
;
853 steady_clock::time_point prompt_started
= steady_clock::now ();
855 scoped_input_handler prepare_input
;
859 char *response
, answer
;
861 gdb_flush (gdb_stdout
);
862 response
= gdb_readline_wrapper (prompt
.c_str ());
864 if (response
== NULL
) /* C-d */
866 printf_filtered ("EOF [assumed %c]\n", def_answer
);
871 answer
= response
[0];
876 /* Check answer. For the non-default, the user must specify
877 the non-default explicitly. */
878 if (answer
== not_def_answer
)
883 /* Otherwise, if a default was specified, the user may either
884 specify the required input or have it default by entering
886 if (answer
== def_answer
887 || (defchar
!= '\0' && answer
== '\0'))
892 /* Invalid entries are not defaulted and require another selection. */
893 printf_filtered (_("Please answer %s or %s.\n"),
897 /* Add time spend in this routine to prompt_for_continue_wait_time. */
898 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
900 if (annotation_level
> 1)
901 printf_filtered (("\n\032\032post-query\n"));
906 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
907 answer is yes, or 0 if answer is defaulted.
908 Takes three args which are given to printf to print the question.
909 The first, a control string, should end in "? ".
910 It should not say how to answer, because we do that. */
913 nquery (const char *ctlstr
, ...)
918 va_start (args
, ctlstr
);
919 ret
= defaulted_query (ctlstr
, 'n', args
);
924 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
925 answer is yes, or 1 if answer is defaulted.
926 Takes three args which are given to printf to print the question.
927 The first, a control string, should end in "? ".
928 It should not say how to answer, because we do that. */
931 yquery (const char *ctlstr
, ...)
936 va_start (args
, ctlstr
);
937 ret
= defaulted_query (ctlstr
, 'y', args
);
942 /* Ask user a y-or-n question and return 1 iff answer is yes.
943 Takes three args which are given to printf to print the question.
944 The first, a control string, should end in "? ".
945 It should not say how to answer, because we do that. */
948 query (const char *ctlstr
, ...)
953 va_start (args
, ctlstr
);
954 ret
= defaulted_query (ctlstr
, '\0', args
);
959 /* A helper for parse_escape that converts a host character to a
960 target character. C is the host character. If conversion is
961 possible, then the target character is stored in *TARGET_C and the
962 function returns 1. Otherwise, the function returns 0. */
965 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
970 auto_obstack host_data
;
972 convert_between_encodings (target_charset (gdbarch
), host_charset (),
973 (gdb_byte
*) &the_char
, 1, 1,
974 &host_data
, translit_none
);
976 if (obstack_object_size (&host_data
) == 1)
979 *target_c
= *(char *) obstack_base (&host_data
);
985 /* Parse a C escape sequence. STRING_PTR points to a variable
986 containing a pointer to the string to parse. That pointer
987 should point to the character after the \. That pointer
988 is updated past the characters we use. The value of the
989 escape sequence is returned.
991 A negative value means the sequence \ newline was seen,
992 which is supposed to be equivalent to nothing at all.
994 If \ is followed by a null character, we return a negative
995 value and leave the string pointer pointing at the null character.
997 If \ is followed by 000, we return 0 and leave the string pointer
998 after the zeros. A value of 0 does not mean end of string. */
1001 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1003 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1004 int c
= *(*string_ptr
)++;
1023 int i
= host_hex_value (c
);
1028 if (isdigit (c
) && c
!= '8' && c
!= '9')
1032 i
+= host_hex_value (c
);
1068 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1069 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1070 " which has no equivalent\nin the `%s' character set."),
1071 c
, c
, target_charset (gdbarch
));
1075 /* Print the character C on STREAM as part of the contents of a literal
1076 string whose delimiter is QUOTER. Note that this routine should only
1077 be called for printing things which are independent of the language
1078 of the program being debugged.
1080 printchar will normally escape backslashes and instances of QUOTER. If
1081 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1082 As a side effect, if you pass the backslash character as the QUOTER,
1083 printchar will escape backslashes as usual, but not any other quoting
1087 printchar (int c
, do_fputc_ftype do_fputc
, ui_file
*stream
, int quoter
)
1089 c
&= 0xFF; /* Avoid sign bit follies */
1091 if (c
< 0x20 || /* Low control chars */
1092 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1093 (sevenbit_strings
&& c
>= 0x80))
1094 { /* high order bit set */
1095 do_fputc ('\\', stream
);
1100 do_fputc ('n', stream
);
1103 do_fputc ('b', stream
);
1106 do_fputc ('t', stream
);
1109 do_fputc ('f', stream
);
1112 do_fputc ('r', stream
);
1115 do_fputc ('e', stream
);
1118 do_fputc ('a', stream
);
1122 do_fputc ('0' + ((c
>> 6) & 0x7), stream
);
1123 do_fputc ('0' + ((c
>> 3) & 0x7), stream
);
1124 do_fputc ('0' + ((c
>> 0) & 0x7), stream
);
1131 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1132 do_fputc ('\\', stream
);
1133 do_fputc (c
, stream
);
1137 /* Print the character C on STREAM as part of the contents of a
1138 literal string whose delimiter is QUOTER. Note that these routines
1139 should only be call for printing things which are independent of
1140 the language of the program being debugged. */
1143 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1146 printchar (*str
++, fputc_filtered
, stream
, quoter
);
1150 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1153 printchar (*str
++, fputc_unfiltered
, stream
, quoter
);
1157 fputstrn_filtered (const char *str
, int n
, int quoter
,
1158 struct ui_file
*stream
)
1160 for (int i
= 0; i
< n
; i
++)
1161 printchar (str
[i
], fputc_filtered
, stream
, quoter
);
1165 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1166 do_fputc_ftype do_fputc
, struct ui_file
*stream
)
1168 for (int i
= 0; i
< n
; i
++)
1169 printchar (str
[i
], do_fputc
, stream
, quoter
);
1173 /* Number of lines per page or UINT_MAX if paging is disabled. */
1174 static unsigned int lines_per_page
;
1176 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1177 struct cmd_list_element
*c
, const char *value
)
1179 fprintf_filtered (file
,
1180 _("Number of lines gdb thinks are in a page is %s.\n"),
1184 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1185 static unsigned int chars_per_line
;
1187 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1188 struct cmd_list_element
*c
, const char *value
)
1190 fprintf_filtered (file
,
1191 _("Number of characters gdb thinks "
1192 "are in a line is %s.\n"),
1196 /* Current count of lines printed on this page, chars on this line. */
1197 static unsigned int lines_printed
, chars_printed
;
1199 /* True if pagination is disabled for just one command. */
1201 static bool pagination_disabled_for_command
;
1203 /* Buffer and start column of buffered text, for doing smarter word-
1204 wrapping. When someone calls wrap_here(), we start buffering output
1205 that comes through fputs_filtered(). If we see a newline, we just
1206 spit it out and forget about the wrap_here(). If we see another
1207 wrap_here(), we spit it out and remember the newer one. If we see
1208 the end of the line, we spit out a newline, the indent, and then
1209 the buffered output. */
1211 static bool filter_initialized
= false;
1213 /* Contains characters which are waiting to be output (they have
1214 already been counted in chars_printed). */
1215 static std::string wrap_buffer
;
1217 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1219 static const char *wrap_indent
;
1221 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1222 is not in effect. */
1223 static int wrap_column
;
1225 /* The style applied at the time that wrap_here was called. */
1226 static ui_file_style wrap_style
;
1229 /* Initialize the number of lines per page and chars per line. */
1232 init_page_info (void)
1236 lines_per_page
= UINT_MAX
;
1237 chars_per_line
= UINT_MAX
;
1241 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1246 #if defined(__GO32__)
1247 rows
= ScreenRows ();
1248 cols
= ScreenCols ();
1249 lines_per_page
= rows
;
1250 chars_per_line
= cols
;
1252 /* Make sure Readline has initialized its terminal settings. */
1253 rl_reset_terminal (NULL
);
1255 /* Get the screen size from Readline. */
1256 rl_get_screen_size (&rows
, &cols
);
1257 lines_per_page
= rows
;
1258 chars_per_line
= cols
;
1260 /* Readline should have fetched the termcap entry for us.
1261 Only try to use tgetnum function if rl_get_screen_size
1262 did not return a useful value. */
1263 if (((rows
<= 0) && (tgetnum ((char *) "li") < 0))
1264 /* Also disable paging if inside Emacs. $EMACS was used
1265 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1266 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1268 /* The number of lines per page is not mentioned in the terminal
1269 description or EMACS environment variable is set. This probably
1270 means that paging is not useful, so disable paging. */
1271 lines_per_page
= UINT_MAX
;
1274 /* If the output is not a terminal, don't paginate it. */
1275 if (!gdb_stdout
->isatty ())
1276 lines_per_page
= UINT_MAX
;
1280 /* We handle SIGWINCH ourselves. */
1281 rl_catch_sigwinch
= 0;
1287 /* Return nonzero if filtered printing is initialized. */
1289 filtered_printing_initialized (void)
1291 return filter_initialized
;
1294 set_batch_flag_and_restore_page_info::set_batch_flag_and_restore_page_info ()
1295 : m_save_lines_per_page (lines_per_page
),
1296 m_save_chars_per_line (chars_per_line
),
1297 m_save_batch_flag (batch_flag
)
1303 set_batch_flag_and_restore_page_info::~set_batch_flag_and_restore_page_info ()
1305 batch_flag
= m_save_batch_flag
;
1306 chars_per_line
= m_save_chars_per_line
;
1307 lines_per_page
= m_save_lines_per_page
;
1313 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1316 set_screen_size (void)
1318 int rows
= lines_per_page
;
1319 int cols
= chars_per_line
;
1321 /* If we get 0 or negative ROWS or COLS, treat as "infinite" size.
1322 A negative number can be seen here with the "set width/height"
1323 commands and either:
1325 - the user specified "unlimited", which maps to UINT_MAX, or
1326 - the user specified some number between INT_MAX and UINT_MAX.
1328 Cap "infinity" to approximately sqrt(INT_MAX) so that we don't
1329 overflow in rl_set_screen_size, which multiplies rows and columns
1330 to compute the number of characters on the screen. */
1332 const int sqrt_int_max
= INT_MAX
>> (sizeof (int) * 8 / 2);
1334 if (rows
<= 0 || rows
> sqrt_int_max
)
1336 rows
= sqrt_int_max
;
1337 lines_per_page
= UINT_MAX
;
1340 if (cols
<= 0 || cols
> sqrt_int_max
)
1342 cols
= sqrt_int_max
;
1343 chars_per_line
= UINT_MAX
;
1346 /* Update Readline's idea of the terminal size. */
1347 rl_set_screen_size (rows
, cols
);
1350 /* Reinitialize WRAP_BUFFER. */
1355 if (chars_per_line
== 0)
1358 wrap_buffer
.clear ();
1359 filter_initialized
= true;
1363 set_width_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1370 set_height_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1378 set_screen_width_and_height (int width
, int height
)
1380 lines_per_page
= height
;
1381 chars_per_line
= width
;
1387 /* The currently applied style. */
1389 static ui_file_style applied_style
;
1391 /* Emit an ANSI style escape for STYLE. If STREAM is nullptr, emit to
1392 the wrap buffer; otherwise emit to STREAM. */
1395 emit_style_escape (const ui_file_style
&style
,
1396 struct ui_file
*stream
= nullptr)
1398 applied_style
= style
;
1400 if (stream
== nullptr)
1401 wrap_buffer
.append (style
.to_ansi ());
1403 stream
->puts (style
.to_ansi ().c_str ());
1406 /* Set the current output style. This will affect future uses of the
1407 _filtered output functions. */
1410 set_output_style (struct ui_file
*stream
, const ui_file_style
&style
)
1412 if (!stream
->can_emit_style_escape ())
1415 /* Note that we may not pass STREAM here, when we want to emit to
1416 the wrap buffer, not directly to STREAM. */
1417 if (stream
== gdb_stdout
)
1419 emit_style_escape (style
, stream
);
1425 reset_terminal_style (struct ui_file
*stream
)
1427 if (stream
->can_emit_style_escape ())
1429 /* Force the setting, regardless of what we think the setting
1430 might already be. */
1431 applied_style
= ui_file_style ();
1432 wrap_buffer
.append (applied_style
.to_ansi ());
1436 /* Wait, so the user can read what's on the screen. Prompt the user
1437 to continue by pressing RETURN. 'q' is also provided because
1438 telling users what to do in the prompt is more user-friendly than
1439 expecting them to think of Ctrl-C/SIGINT. */
1442 prompt_for_continue (void)
1444 char cont_prompt
[120];
1445 /* Used to add duration we waited for user to respond to
1446 prompt_for_continue_wait_time. */
1447 using namespace std::chrono
;
1448 steady_clock::time_point prompt_started
= steady_clock::now ();
1449 bool disable_pagination
= pagination_disabled_for_command
;
1451 /* Clear the current styling. */
1452 if (gdb_stdout
->can_emit_style_escape ())
1453 emit_style_escape (ui_file_style (), gdb_stdout
);
1455 if (annotation_level
> 1)
1456 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1458 strcpy (cont_prompt
,
1459 "--Type <RET> for more, q to quit, "
1460 "c to continue without paging--");
1461 if (annotation_level
> 1)
1462 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1464 /* We must do this *before* we call gdb_readline_wrapper, else it
1465 will eventually call us -- thinking that we're trying to print
1466 beyond the end of the screen. */
1467 reinitialize_more_filter ();
1469 scoped_input_handler prepare_input
;
1471 /* Call gdb_readline_wrapper, not readline, in order to keep an
1472 event loop running. */
1473 gdb::unique_xmalloc_ptr
<char> ignore (gdb_readline_wrapper (cont_prompt
));
1475 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1476 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1478 if (annotation_level
> 1)
1479 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1483 char *p
= ignore
.get ();
1485 while (*p
== ' ' || *p
== '\t')
1488 /* Do not call quit here; there is no possibility of SIGINT. */
1489 throw_quit ("Quit");
1491 disable_pagination
= true;
1494 /* Now we have to do this again, so that GDB will know that it doesn't
1495 need to save the ---Type <return>--- line at the top of the screen. */
1496 reinitialize_more_filter ();
1497 pagination_disabled_for_command
= disable_pagination
;
1499 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1502 /* Initialize timer to keep track of how long we waited for the user. */
1505 reset_prompt_for_continue_wait_time (void)
1507 using namespace std::chrono
;
1509 prompt_for_continue_wait_time
= steady_clock::duration::zero ();
1512 /* Fetch the cumulative time spent in prompt_for_continue. */
1514 std::chrono::steady_clock::duration
1515 get_prompt_for_continue_wait_time ()
1517 return prompt_for_continue_wait_time
;
1520 /* Reinitialize filter; ie. tell it to reset to original values. */
1523 reinitialize_more_filter (void)
1527 pagination_disabled_for_command
= false;
1530 /* Flush the wrap buffer to STREAM, if necessary. */
1533 flush_wrap_buffer (struct ui_file
*stream
)
1535 if (stream
== gdb_stdout
&& !wrap_buffer
.empty ())
1537 stream
->puts (wrap_buffer
.c_str ());
1538 wrap_buffer
.clear ();
1545 gdb_flush (struct ui_file
*stream
)
1547 flush_wrap_buffer (stream
);
1551 /* Indicate that if the next sequence of characters overflows the line,
1552 a newline should be inserted here rather than when it hits the end.
1553 If INDENT is non-null, it is a string to be printed to indent the
1554 wrapped part on the next line. INDENT must remain accessible until
1555 the next call to wrap_here() or until a newline is printed through
1558 If the line is already overfull, we immediately print a newline and
1559 the indentation, and disable further wrapping.
1561 If we don't know the width of lines, but we know the page height,
1562 we must not wrap words, but should still keep track of newlines
1563 that were explicitly printed.
1565 INDENT should not contain tabs, as that will mess up the char count
1566 on the next line. FIXME.
1568 This routine is guaranteed to force out any output which has been
1569 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1570 used to force out output from the wrap_buffer. */
1573 wrap_here (const char *indent
)
1575 /* This should have been allocated, but be paranoid anyway. */
1576 gdb_assert (filter_initialized
);
1578 flush_wrap_buffer (gdb_stdout
);
1579 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1583 else if (chars_printed
>= chars_per_line
)
1585 puts_filtered ("\n");
1587 puts_filtered (indent
);
1592 wrap_column
= chars_printed
;
1596 wrap_indent
= indent
;
1597 wrap_style
= applied_style
;
1601 /* Print input string to gdb_stdout, filtered, with wrap,
1602 arranging strings in columns of n chars. String can be
1603 right or left justified in the column. Never prints
1604 trailing spaces. String should never be longer than
1605 width. FIXME: this could be useful for the EXAMINE
1606 command, which currently doesn't tabulate very well. */
1609 puts_filtered_tabular (char *string
, int width
, int right
)
1615 gdb_assert (chars_per_line
> 0);
1616 if (chars_per_line
== UINT_MAX
)
1618 fputs_filtered (string
, gdb_stdout
);
1619 fputs_filtered ("\n", gdb_stdout
);
1623 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1624 fputs_filtered ("\n", gdb_stdout
);
1626 if (width
>= chars_per_line
)
1627 width
= chars_per_line
- 1;
1629 stringlen
= strlen (string
);
1631 if (chars_printed
> 0)
1632 spaces
= width
- (chars_printed
- 1) % width
- 1;
1634 spaces
+= width
- stringlen
;
1636 spacebuf
= (char *) alloca (spaces
+ 1);
1637 spacebuf
[spaces
] = '\0';
1639 spacebuf
[spaces
] = ' ';
1641 fputs_filtered (spacebuf
, gdb_stdout
);
1642 fputs_filtered (string
, gdb_stdout
);
1646 /* Ensure that whatever gets printed next, using the filtered output
1647 commands, starts at the beginning of the line. I.e. if there is
1648 any pending output for the current line, flush it and start a new
1649 line. Otherwise do nothing. */
1654 if (chars_printed
> 0)
1656 puts_filtered ("\n");
1661 /* Like fputs but if FILTER is true, pause after every screenful.
1663 Regardless of FILTER can wrap at points other than the final
1664 character of a line.
1666 Unlike fputs, fputs_maybe_filtered does not return a value.
1667 It is OK for LINEBUFFER to be NULL, in which case just don't print
1670 Note that a longjmp to top level may occur in this routine (only if
1671 FILTER is true) (since prompt_for_continue may do so) so this
1672 routine should not be called when cleanups are not in place. */
1675 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1678 const char *lineptr
;
1680 if (linebuffer
== 0)
1683 /* Don't do any filtering if it is disabled. */
1684 if (stream
!= gdb_stdout
1685 || !pagination_enabled
1686 || pagination_disabled_for_command
1688 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
1689 || top_level_interpreter () == NULL
1690 || top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
1692 flush_wrap_buffer (stream
);
1693 stream
->puts (linebuffer
);
1698 = make_scope_exit ([&] ()
1700 wrap_buffer
.clear ();
1705 /* Go through and output each character. Show line extension
1706 when this is necessary; prompt user for new page when this is
1709 lineptr
= linebuffer
;
1712 /* Possible new page. Note that PAGINATION_DISABLED_FOR_COMMAND
1713 might be set during this loop, so we must continue to check
1715 if (filter
&& (lines_printed
>= lines_per_page
- 1)
1716 && !pagination_disabled_for_command
)
1717 prompt_for_continue ();
1719 while (*lineptr
&& *lineptr
!= '\n')
1723 /* Print a single line. */
1724 if (*lineptr
== '\t')
1726 wrap_buffer
.push_back ('\t');
1727 /* Shifting right by 3 produces the number of tab stops
1728 we have already passed, and then adding one and
1729 shifting left 3 advances to the next tab stop. */
1730 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
1733 else if (*lineptr
== '\033'
1734 && skip_ansi_escape (lineptr
, &skip_bytes
))
1736 wrap_buffer
.append (lineptr
, skip_bytes
);
1737 /* Note that we don't consider this a character, so we
1738 don't increment chars_printed here. */
1739 lineptr
+= skip_bytes
;
1743 wrap_buffer
.push_back (*lineptr
);
1748 if (chars_printed
>= chars_per_line
)
1750 unsigned int save_chars
= chars_printed
;
1752 /* If we change the style, below, we'll want to reset it
1753 before continuing to print. If there is no wrap
1754 column, then we'll only reset the style if the pager
1755 prompt is given; and to avoid emitting style
1756 sequences in the middle of a run of text, we track
1758 ui_file_style save_style
;
1759 bool did_paginate
= false;
1765 save_style
= wrap_style
;
1766 if (stream
->can_emit_style_escape ())
1767 emit_style_escape (ui_file_style (), stream
);
1768 /* If we aren't actually wrapping, don't output
1769 newline -- if chars_per_line is right, we
1770 probably just overflowed anyway; if it's wrong,
1771 let us keep going. */
1772 /* XXX: The ideal thing would be to call
1773 'stream->putc' here, but we can't because it
1774 currently calls 'fputc_unfiltered', which ends up
1775 calling us, which generates an infinite
1777 stream
->puts ("\n");
1781 save_style
= applied_style
;
1782 flush_wrap_buffer (stream
);
1785 /* Possible new page. Note that
1786 PAGINATION_DISABLED_FOR_COMMAND might be set during
1787 this loop, so we must continue to check it here. */
1788 if (lines_printed
>= lines_per_page
- 1
1789 && !pagination_disabled_for_command
)
1791 prompt_for_continue ();
1792 did_paginate
= true;
1795 /* Now output indentation and wrapped string. */
1798 stream
->puts (wrap_indent
);
1799 if (stream
->can_emit_style_escape ())
1800 emit_style_escape (save_style
, stream
);
1801 /* FIXME, this strlen is what prevents wrap_indent from
1802 containing tabs. However, if we recurse to print it
1803 and count its chars, we risk trouble if wrap_indent is
1804 longer than (the user settable) chars_per_line.
1805 Note also that this can set chars_printed > chars_per_line
1806 if we are printing a long string. */
1807 chars_printed
= strlen (wrap_indent
)
1808 + (save_chars
- wrap_column
);
1809 wrap_column
= 0; /* And disable fancy wrap */
1811 else if (did_paginate
&& stream
->can_emit_style_escape ())
1812 emit_style_escape (save_style
, stream
);
1816 if (*lineptr
== '\n')
1819 wrap_here ((char *) 0); /* Spit out chars, cancel
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");
1832 buffer_clearer
.release ();
1836 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
1838 fputs_maybe_filtered (linebuffer
, stream
, 1);
1842 fputs_unfiltered (const char *linebuffer
, struct ui_file
*stream
)
1844 fputs_maybe_filtered (linebuffer
, stream
, 0);
1850 fputs_styled (const char *linebuffer
, const ui_file_style
&style
,
1851 struct ui_file
*stream
)
1853 /* This just makes it so we emit somewhat fewer escape
1855 if (style
.is_default ())
1856 fputs_maybe_filtered (linebuffer
, stream
, 1);
1859 set_output_style (stream
, style
);
1860 fputs_maybe_filtered (linebuffer
, stream
, 1);
1861 set_output_style (stream
, ui_file_style ());
1868 fputs_styled_unfiltered (const char *linebuffer
, const ui_file_style
&style
,
1869 struct ui_file
*stream
)
1871 /* This just makes it so we emit somewhat fewer escape
1873 if (style
.is_default ())
1874 fputs_maybe_filtered (linebuffer
, stream
, 0);
1877 set_output_style (stream
, style
);
1878 fputs_maybe_filtered (linebuffer
, stream
, 0);
1879 set_output_style (stream
, ui_file_style ());
1886 fputs_highlighted (const char *str
, const compiled_regex
&highlight
,
1887 struct ui_file
*stream
)
1891 while (*str
&& highlight
.exec (str
, 1, &pmatch
, 0) == 0)
1893 size_t n_highlight
= pmatch
.rm_eo
- pmatch
.rm_so
;
1895 /* Output the part before pmatch with current style. */
1896 while (pmatch
.rm_so
> 0)
1898 fputc_filtered (*str
, stream
);
1903 /* Output pmatch with the highlight style. */
1904 set_output_style (stream
, highlight_style
.style ());
1905 while (n_highlight
> 0)
1907 fputc_filtered (*str
, stream
);
1911 set_output_style (stream
, ui_file_style ());
1914 /* Output the trailing part of STR not matching HIGHLIGHT. */
1916 fputs_filtered (str
, stream
);
1920 putchar_unfiltered (int c
)
1922 return fputc_unfiltered (c
, gdb_stdout
);
1925 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
1926 May return nonlocally. */
1929 putchar_filtered (int c
)
1931 return fputc_filtered (c
, gdb_stdout
);
1935 fputc_unfiltered (int c
, struct ui_file
*stream
)
1941 fputs_unfiltered (buf
, stream
);
1946 fputc_filtered (int c
, struct ui_file
*stream
)
1952 fputs_filtered (buf
, stream
);
1956 /* puts_debug is like fputs_unfiltered, except it prints special
1957 characters in printable fashion. */
1960 puts_debug (char *prefix
, char *string
, char *suffix
)
1964 /* Print prefix and suffix after each line. */
1965 static int new_line
= 1;
1966 static int return_p
= 0;
1967 static const char *prev_prefix
= "";
1968 static const char *prev_suffix
= "";
1970 if (*string
== '\n')
1973 /* If the prefix is changing, print the previous suffix, a new line,
1974 and the new prefix. */
1975 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
1977 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
1978 fputs_unfiltered ("\n", gdb_stdlog
);
1979 fputs_unfiltered (prefix
, gdb_stdlog
);
1982 /* Print prefix if we printed a newline during the previous call. */
1986 fputs_unfiltered (prefix
, gdb_stdlog
);
1989 prev_prefix
= prefix
;
1990 prev_suffix
= suffix
;
1992 /* Output characters in a printable format. */
1993 while ((ch
= *string
++) != '\0')
1999 fputc_unfiltered (ch
, gdb_stdlog
);
2002 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2006 fputs_unfiltered ("\\\\", gdb_stdlog
);
2009 fputs_unfiltered ("\\b", gdb_stdlog
);
2012 fputs_unfiltered ("\\f", gdb_stdlog
);
2016 fputs_unfiltered ("\\n", gdb_stdlog
);
2019 fputs_unfiltered ("\\r", gdb_stdlog
);
2022 fputs_unfiltered ("\\t", gdb_stdlog
);
2025 fputs_unfiltered ("\\v", gdb_stdlog
);
2029 return_p
= ch
== '\r';
2032 /* Print suffix if we printed a newline. */
2035 fputs_unfiltered (suffix
, gdb_stdlog
);
2036 fputs_unfiltered ("\n", gdb_stdlog
);
2041 /* Print a variable number of ARGS using format FORMAT. If this
2042 information is going to put the amount written (since the last call
2043 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2044 call prompt_for_continue to get the users permission to continue.
2046 Unlike fprintf, this function does not return a value.
2048 We implement three variants, vfprintf (takes a vararg list and stream),
2049 fprintf (takes a stream to write on), and printf (the usual).
2051 Note also that this may throw a quit (since prompt_for_continue may
2055 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2056 va_list args
, bool filter
, bool gdbfmt
)
2060 ui_out_flags flags
= disallow_ui_out_field
;
2062 flags
|= unfiltered_output
;
2063 cli_ui_out (stream
, flags
).vmessage (applied_style
, format
, args
);
2067 std::string str
= string_vprintf (format
, args
);
2068 fputs_maybe_filtered (str
.c_str (), stream
, filter
);
2074 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2076 vfprintf_maybe_filtered (stream
, format
, args
, true, true);
2080 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2082 if (debug_timestamp
&& stream
== gdb_stdlog
)
2084 using namespace std::chrono
;
2088 cli_ui_out (&sfile
, 0).vmessage (ui_file_style (), format
, args
);
2089 std::string linebuffer
= std::move (sfile
.string ());
2091 steady_clock::time_point now
= steady_clock::now ();
2092 seconds s
= duration_cast
<seconds
> (now
.time_since_epoch ());
2093 microseconds us
= duration_cast
<microseconds
> (now
.time_since_epoch () - s
);
2095 len
= linebuffer
.size ();
2096 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2098 std::string timestamp
= string_printf ("%ld.%06ld %s%s",
2101 linebuffer
.c_str (),
2102 need_nl
? "\n": "");
2103 fputs_unfiltered (timestamp
.c_str (), stream
);
2106 vfprintf_maybe_filtered (stream
, format
, args
, false, true);
2110 vprintf_filtered (const char *format
, va_list args
)
2112 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, true, false);
2116 vprintf_unfiltered (const char *format
, va_list args
)
2118 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2122 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2126 va_start (args
, format
);
2127 vfprintf_filtered (stream
, format
, args
);
2132 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2136 va_start (args
, format
);
2137 vfprintf_unfiltered (stream
, format
, args
);
2141 /* Like fprintf_filtered, but prints its result indented.
2142 Called as fprintfi_filtered (spaces, stream, format, ...); */
2145 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2150 va_start (args
, format
);
2151 print_spaces_filtered (spaces
, stream
);
2153 vfprintf_filtered (stream
, format
, args
);
2160 fprintf_styled (struct ui_file
*stream
, const ui_file_style
&style
,
2161 const char *format
, ...)
2165 set_output_style (stream
, style
);
2166 va_start (args
, format
);
2167 vfprintf_filtered (stream
, format
, args
);
2169 set_output_style (stream
, ui_file_style ());
2175 vfprintf_styled (struct ui_file
*stream
, const ui_file_style
&style
,
2176 const char *format
, va_list args
)
2178 set_output_style (stream
, style
);
2179 vfprintf_filtered (stream
, format
, args
);
2180 set_output_style (stream
, ui_file_style ());
2186 vfprintf_styled_no_gdbfmt (struct ui_file
*stream
, const ui_file_style
&style
,
2187 bool filter
, const char *format
, va_list args
)
2189 std::string str
= string_vprintf (format
, args
);
2192 if (!style
.is_default ())
2193 set_output_style (stream
, style
);
2194 fputs_maybe_filtered (str
.c_str (), stream
, filter
);
2195 if (!style
.is_default ())
2196 set_output_style (stream
, ui_file_style ());
2201 printf_filtered (const char *format
, ...)
2205 va_start (args
, format
);
2206 vfprintf_filtered (gdb_stdout
, format
, args
);
2212 printf_unfiltered (const char *format
, ...)
2216 va_start (args
, format
);
2217 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2221 /* Like printf_filtered, but prints it's result indented.
2222 Called as printfi_filtered (spaces, format, ...); */
2225 printfi_filtered (int spaces
, const char *format
, ...)
2229 va_start (args
, format
);
2230 print_spaces_filtered (spaces
, gdb_stdout
);
2231 vfprintf_filtered (gdb_stdout
, format
, args
);
2235 /* Easy -- but watch out!
2237 This routine is *not* a replacement for puts()! puts() appends a newline.
2238 This one doesn't, and had better not! */
2241 puts_filtered (const char *string
)
2243 fputs_filtered (string
, gdb_stdout
);
2247 puts_unfiltered (const char *string
)
2249 fputs_unfiltered (string
, gdb_stdout
);
2252 /* Return a pointer to N spaces and a null. The pointer is good
2253 until the next call to here. */
2258 static char *spaces
= 0;
2259 static int max_spaces
= -1;
2265 spaces
= (char *) xmalloc (n
+ 1);
2266 for (t
= spaces
+ n
; t
!= spaces
;)
2272 return spaces
+ max_spaces
- n
;
2275 /* Print N spaces. */
2277 print_spaces_filtered (int n
, struct ui_file
*stream
)
2279 fputs_filtered (n_spaces (n
), stream
);
2282 /* C++/ObjC demangler stuff. */
2284 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2285 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2286 If the name is not mangled, or the language for the name is unknown, or
2287 demangling is off, the name is printed in its "raw" form. */
2290 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2291 enum language lang
, int arg_mode
)
2297 /* If user wants to see raw output, no problem. */
2300 fputs_filtered (name
, stream
);
2304 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2305 fputs_filtered (demangled
? demangled
: name
, stream
);
2306 if (demangled
!= NULL
)
2314 /* True if CH is a character that can be part of a symbol name. I.e.,
2315 either a number, a letter, or a '_'. */
2318 valid_identifier_name_char (int ch
)
2320 return (isalnum (ch
) || ch
== '_');
2323 /* Skip to end of token, or to END, whatever comes first. Input is
2324 assumed to be a C++ operator name. */
2327 cp_skip_operator_token (const char *token
, const char *end
)
2329 const char *p
= token
;
2330 while (p
!= end
&& !isspace (*p
) && *p
!= '(')
2332 if (valid_identifier_name_char (*p
))
2334 while (p
!= end
&& valid_identifier_name_char (*p
))
2340 /* Note, ordered such that among ops that share a prefix,
2341 longer comes first. This is so that the loop below can
2342 bail on first match. */
2343 static const char *ops
[] =
2349 "-=", "--", "->", "-",
2358 "<<=", "<=", "<<", "<",
2359 ">>=", ">=", ">>", ">",
2363 for (const char *op
: ops
)
2365 size_t oplen
= strlen (op
);
2366 size_t lencmp
= std::min
<size_t> (oplen
, end
- p
);
2368 if (strncmp (p
, op
, lencmp
) == 0)
2371 /* Some unidentified character. Return it. */
2379 /* Advance STRING1/STRING2 past whitespace. */
2382 skip_ws (const char *&string1
, const char *&string2
, const char *end_str2
)
2384 while (isspace (*string1
))
2386 while (string2
< end_str2
&& isspace (*string2
))
2390 /* True if STRING points at the start of a C++ operator name. START
2391 is the start of the string that STRING points to, hence when
2392 reading backwards, we must not read any character before START. */
2395 cp_is_operator (const char *string
, const char *start
)
2397 return ((string
== start
2398 || !valid_identifier_name_char (string
[-1]))
2399 && strncmp (string
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
2400 && !valid_identifier_name_char (string
[CP_OPERATOR_LEN
]));
2403 /* If *NAME points at an ABI tag, skip it and return true. Otherwise
2404 leave *NAME unmodified and return false. (see GCC's abi_tag
2405 attribute), such names are demangled as e.g.,
2406 "function[abi:cxx11]()". */
2409 skip_abi_tag (const char **name
)
2411 const char *p
= *name
;
2413 if (startswith (p
, "[abi:"))
2417 while (valid_identifier_name_char (*p
))
2433 strncmp_iw_with_mode (const char *string1
, const char *string2
,
2434 size_t string2_len
, strncmp_iw_mode mode
,
2435 enum language language
,
2436 completion_match_for_lcd
*match_for_lcd
)
2438 const char *string1_start
= string1
;
2439 const char *end_str2
= string2
+ string2_len
;
2440 bool skip_spaces
= true;
2441 bool have_colon_op
= (language
== language_cplus
2442 || language
== language_rust
2443 || language
== language_fortran
);
2448 || ((isspace (*string1
) && !valid_identifier_name_char (*string2
))
2449 || (isspace (*string2
) && !valid_identifier_name_char (*string1
))))
2451 skip_ws (string1
, string2
, end_str2
);
2452 skip_spaces
= false;
2455 /* Skip [abi:cxx11] tags in the symbol name if the lookup name
2456 doesn't include them. E.g.:
2458 string1: function[abi:cxx1](int)
2461 string1: function[abi:cxx1](int)
2462 string2: function(int)
2464 string1: Struct[abi:cxx1]::function()
2465 string2: Struct::function()
2467 string1: function(Struct[abi:cxx1], int)
2468 string2: function(Struct, int)
2470 if (string2
== end_str2
2471 || (*string2
!= '[' && !valid_identifier_name_char (*string2
)))
2473 const char *abi_start
= string1
;
2475 /* There can be more than one tag. */
2476 while (*string1
== '[' && skip_abi_tag (&string1
))
2479 if (match_for_lcd
!= NULL
&& abi_start
!= string1
)
2480 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2482 while (isspace (*string1
))
2486 if (*string1
== '\0' || string2
== end_str2
)
2489 /* Handle the :: operator. */
2490 if (have_colon_op
&& string1
[0] == ':' && string1
[1] == ':')
2492 if (*string2
!= ':')
2498 if (string2
== end_str2
)
2501 if (*string2
!= ':')
2507 while (isspace (*string1
))
2509 while (string2
< end_str2
&& isspace (*string2
))
2514 /* Handle C++ user-defined operators. */
2515 else if (language
== language_cplus
2518 if (cp_is_operator (string1
, string1_start
))
2520 /* An operator name in STRING1. Check STRING2. */
2522 = std::min
<size_t> (CP_OPERATOR_LEN
, end_str2
- string2
);
2523 if (strncmp (string1
, string2
, cmplen
) != 0)
2529 if (string2
!= end_str2
)
2531 /* Check for "operatorX" in STRING2. */
2532 if (valid_identifier_name_char (*string2
))
2535 skip_ws (string1
, string2
, end_str2
);
2538 /* Handle operator(). */
2539 if (*string1
== '(')
2541 if (string2
== end_str2
)
2543 if (mode
== strncmp_iw_mode::NORMAL
)
2547 /* Don't break for the regular return at the
2548 bottom, because "operator" should not
2549 match "operator()", since this open
2550 parentheses is not the parameter list
2552 return *string1
!= '\0';
2556 if (*string1
!= *string2
)
2565 skip_ws (string1
, string2
, end_str2
);
2567 /* Skip to end of token, or to END, whatever comes
2569 const char *end_str1
= string1
+ strlen (string1
);
2570 const char *p1
= cp_skip_operator_token (string1
, end_str1
);
2571 const char *p2
= cp_skip_operator_token (string2
, end_str2
);
2573 cmplen
= std::min (p1
- string1
, p2
- string2
);
2576 if (strncmp (string1
, string2
, cmplen
) != 0)
2581 if (p1
- string1
!= p2
- string2
)
2583 if (strncmp (string1
, string2
, cmplen
) != 0)
2590 if (*string1
== '\0' || string2
== end_str2
)
2592 if (*string1
== '(' || *string2
== '(')
2600 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2602 if (case_sensitivity
== case_sensitive_off
2603 && (tolower ((unsigned char) *string1
)
2604 != tolower ((unsigned char) *string2
)))
2607 /* If we see any non-whitespace, non-identifier-name character
2608 (any of "()<>*&" etc.), then skip spaces the next time
2610 if (!isspace (*string1
) && !valid_identifier_name_char (*string1
))
2617 if (string2
== end_str2
)
2619 if (mode
== strncmp_iw_mode::NORMAL
)
2621 /* Strip abi tag markers from the matched symbol name.
2622 Usually the ABI marker will be found on function name
2623 (automatically added because the function returns an
2624 object marked with an ABI tag). However, it's also
2625 possible to see a marker in one of the function
2626 parameters, for example.
2628 string2 (lookup name):
2631 function(some_struct[abi:cxx11], int)
2633 and for completion LCD computation we want to say that
2635 function(some_struct, int)
2637 if (match_for_lcd
!= NULL
)
2639 while ((string1
= strstr (string1
, "[abi:")) != NULL
)
2641 const char *abi_start
= string1
;
2643 /* There can be more than one tag. */
2644 while (skip_abi_tag (&string1
) && *string1
== '[')
2647 if (abi_start
!= string1
)
2648 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2655 return (*string1
!= '\0' && *string1
!= '(');
2664 strncmp_iw (const char *string1
, const char *string2
, size_t string2_len
)
2666 return strncmp_iw_with_mode (string1
, string2
, string2_len
,
2667 strncmp_iw_mode::NORMAL
, language_minimal
);
2673 strcmp_iw (const char *string1
, const char *string2
)
2675 return strncmp_iw_with_mode (string1
, string2
, strlen (string2
),
2676 strncmp_iw_mode::MATCH_PARAMS
, language_minimal
);
2679 /* This is like strcmp except that it ignores whitespace and treats
2680 '(' as the first non-NULL character in terms of ordering. Like
2681 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2682 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2683 according to that ordering.
2685 If a list is sorted according to this function and if you want to
2686 find names in the list that match some fixed NAME according to
2687 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2688 where this function would put NAME.
2690 This function must be neutral to the CASE_SENSITIVITY setting as the user
2691 may choose it during later lookup. Therefore this function always sorts
2692 primarily case-insensitively and secondarily case-sensitively.
2694 Here are some examples of why using strcmp to sort is a bad idea:
2698 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2699 we try to do a search for "foo<char*>", strcmp will locate this
2700 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2701 will start looking at strings beginning with "goo", and will never
2702 see the correct match of "foo<char *>".
2704 Parenthesis example:
2706 In practice, this is less like to be an issue, but I'll give it a
2707 shot. Let's assume that '$' is a legitimate character to occur in
2708 symbols. (Which may well even be the case on some systems.) Then
2709 say that the partial symbol table contains "foo$" and "foo(int)".
2710 strcmp will put them in this order, since '$' < '('. Now, if the
2711 user searches for "foo", then strcmp will sort "foo" before "foo$".
2712 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2713 "foo") is false, so it won't proceed to the actual match of
2714 "foo(int)" with "foo". */
2717 strcmp_iw_ordered (const char *string1
, const char *string2
)
2719 const char *saved_string1
= string1
, *saved_string2
= string2
;
2720 enum case_sensitivity case_pass
= case_sensitive_off
;
2724 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2725 Provide stub characters if we are already at the end of one of the
2727 char c1
= 'X', c2
= 'X';
2729 while (*string1
!= '\0' && *string2
!= '\0')
2731 while (isspace (*string1
))
2733 while (isspace (*string2
))
2738 case case_sensitive_off
:
2739 c1
= tolower ((unsigned char) *string1
);
2740 c2
= tolower ((unsigned char) *string2
);
2742 case case_sensitive_on
:
2750 if (*string1
!= '\0')
2759 /* Characters are non-equal unless they're both '\0'; we want to
2760 make sure we get the comparison right according to our
2761 comparison in the cases where one of them is '\0' or '('. */
2763 if (*string2
== '\0')
2768 if (*string2
== '\0')
2773 if (*string2
== '\0' || *string2
== '(')
2782 if (case_pass
== case_sensitive_on
)
2785 /* Otherwise the strings were equal in case insensitive way, make
2786 a more fine grained comparison in a case sensitive way. */
2788 case_pass
= case_sensitive_on
;
2789 string1
= saved_string1
;
2790 string2
= saved_string2
;
2797 streq (const char *lhs
, const char *rhs
)
2799 return !strcmp (lhs
, rhs
);
2805 streq_hash (const void *lhs
, const void *rhs
)
2807 return streq ((const char *) lhs
, (const char *) rhs
);
2814 ** Answer whether string_to_compare is a full or partial match to
2815 ** template_string. The partial match must be in sequence starting
2819 subset_compare (const char *string_to_compare
, const char *template_string
)
2823 if (template_string
!= NULL
&& string_to_compare
!= NULL
2824 && strlen (string_to_compare
) <= strlen (template_string
))
2826 (startswith (template_string
, string_to_compare
));
2833 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2834 struct cmd_list_element
*c
, const char *value
)
2836 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2844 address_significant (gdbarch
*gdbarch
, CORE_ADDR addr
)
2846 /* Clear insignificant bits of a target address and sign extend resulting
2847 address, avoiding shifts larger or equal than the width of a CORE_ADDR.
2848 The local variable ADDR_BIT stops the compiler reporting a shift overflow
2849 when it won't occur. Skip updating of target address if current target
2850 has not set gdbarch significant_addr_bit. */
2851 int addr_bit
= gdbarch_significant_addr_bit (gdbarch
);
2853 if (addr_bit
&& (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
)))
2855 CORE_ADDR sign
= (CORE_ADDR
) 1 << (addr_bit
- 1);
2856 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2857 addr
= (addr
^ sign
) - sign
;
2864 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2866 /* Truncate address to the size of a target address, avoiding shifts
2867 larger or equal than the width of a CORE_ADDR. The local
2868 variable ADDR_BIT stops the compiler reporting a shift overflow
2869 when it won't occur. */
2870 /* NOTE: This assumes that the significant address information is
2871 kept in the least significant bits of ADDR - the upper bits were
2872 either zero or sign extended. Should gdbarch_address_to_pointer or
2873 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2875 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2877 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2878 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2879 return hex_string (addr
);
2882 /* This function is described in "defs.h". */
2885 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2887 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2889 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2890 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2892 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2893 that returns the language localized string formatted to a width
2894 based on gdbarch_addr_bit. */
2896 return hex_string_custom (address
, 8);
2898 return hex_string_custom (address
, 16);
2901 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2904 core_addr_hash (const void *ap
)
2906 const CORE_ADDR
*addrp
= (const CORE_ADDR
*) ap
;
2911 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2914 core_addr_eq (const void *ap
, const void *bp
)
2916 const CORE_ADDR
*addr_ap
= (const CORE_ADDR
*) ap
;
2917 const CORE_ADDR
*addr_bp
= (const CORE_ADDR
*) bp
;
2919 return *addr_ap
== *addr_bp
;
2922 /* Convert a string back into a CORE_ADDR. */
2924 string_to_core_addr (const char *my_string
)
2928 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2930 /* Assume that it is in hex. */
2933 for (i
= 2; my_string
[i
] != '\0'; i
++)
2935 if (isdigit (my_string
[i
]))
2936 addr
= (my_string
[i
] - '0') + (addr
* 16);
2937 else if (isxdigit (my_string
[i
]))
2938 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2940 error (_("invalid hex \"%s\""), my_string
);
2945 /* Assume that it is in decimal. */
2948 for (i
= 0; my_string
[i
] != '\0'; i
++)
2950 if (isdigit (my_string
[i
]))
2951 addr
= (my_string
[i
] - '0') + (addr
* 10);
2953 error (_("invalid decimal \"%s\""), my_string
);
2963 gdb_realpath_check_trailer (const char *input
, const char *trailer
)
2965 gdb::unique_xmalloc_ptr
<char> result
= gdb_realpath (input
);
2967 size_t len
= strlen (result
.get ());
2968 size_t trail_len
= strlen (trailer
);
2970 SELF_CHECK (len
>= trail_len
2971 && strcmp (result
.get () + len
- trail_len
, trailer
) == 0);
2975 gdb_realpath_tests ()
2977 /* A file which contains a directory prefix. */
2978 gdb_realpath_check_trailer ("./xfullpath.exp", "/xfullpath.exp");
2979 /* A file which contains a directory prefix. */
2980 gdb_realpath_check_trailer ("../../defs.h", "/defs.h");
2981 /* A one-character filename. */
2982 gdb_realpath_check_trailer ("./a", "/a");
2983 /* A file in the root directory. */
2984 gdb_realpath_check_trailer ("/root_file_which_should_exist",
2985 "/root_file_which_should_exist");
2986 /* A file which does not have a directory prefix. */
2987 gdb_realpath_check_trailer ("xfullpath.exp", "xfullpath.exp");
2988 /* A one-char filename without any directory prefix. */
2989 gdb_realpath_check_trailer ("a", "a");
2990 /* An empty filename. */
2991 gdb_realpath_check_trailer ("", "");
2994 #endif /* GDB_SELF_TEST */
2996 /* Allocation function for the libiberty hash table which uses an
2997 obstack. The obstack is passed as DATA. */
3000 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
3002 size_t total
= size
* count
;
3003 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
3005 memset (ptr
, 0, total
);
3009 /* Trivial deallocation function for the libiberty splay tree and hash
3010 table - don't deallocate anything. Rely on later deletion of the
3011 obstack. DATA will be the obstack, although it is not needed
3015 dummy_obstack_deallocate (void *object
, void *data
)
3020 /* Simple, portable version of dirname that does not modify its
3024 ldirname (const char *filename
)
3026 std::string dirname
;
3027 const char *base
= lbasename (filename
);
3029 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
3032 if (base
== filename
)
3035 dirname
= std::string (filename
, base
- filename
);
3037 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3038 create "d:./bar" later instead of the (different) "d:/bar". */
3039 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3040 && !IS_DIR_SEPARATOR (filename
[0]))
3041 dirname
[base
++ - filename
] = '.';
3049 gdb_argv::reset (const char *s
)
3051 char **argv
= buildargv (s
);
3057 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3058 #define AMBIGUOUS_MESS2 \
3059 ".\nUse \"set gnutarget format-name\" to specify the format."
3062 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3066 /* Check if errmsg just need simple return. */
3067 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3068 return bfd_errmsg (error_tag
);
3070 std::string
ret (bfd_errmsg (error_tag
));
3071 ret
+= AMBIGUOUS_MESS1
;
3073 for (p
= matching
; *p
; p
++)
3078 ret
+= AMBIGUOUS_MESS2
;
3085 /* Return ARGS parsed as a valid pid, or throw an error. */
3088 parse_pid_to_attach (const char *args
)
3094 error_no_arg (_("process-id to attach"));
3096 dummy
= (char *) args
;
3097 pid
= strtoul (args
, &dummy
, 0);
3098 /* Some targets don't set errno on errors, grrr! */
3099 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3100 error (_("Illegal process-id: %s."), args
);
3105 /* Substitute all occurrences of string FROM by string TO in *STRINGP. *STRINGP
3106 must come from xrealloc-compatible allocator and it may be updated. FROM
3107 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3108 located at the start or end of *STRINGP. */
3111 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3113 char *string
= *stringp
, *s
;
3114 const size_t from_len
= strlen (from
);
3115 const size_t to_len
= strlen (to
);
3119 s
= strstr (s
, from
);
3123 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3124 || s
[-1] == DIRNAME_SEPARATOR
)
3125 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3126 || s
[from_len
] == DIRNAME_SEPARATOR
))
3131 = (char *) xrealloc (string
, (strlen (string
) + to_len
+ 1));
3133 /* Relocate the current S pointer. */
3134 s
= s
- string
+ string_new
;
3135 string
= string_new
;
3137 /* Replace from by to. */
3138 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3139 memcpy (s
, to
, to_len
);
3154 /* SIGALRM handler for waitpid_with_timeout. */
3157 sigalrm_handler (int signo
)
3159 /* Nothing to do. */
3164 /* Wrapper to wait for child PID to die with TIMEOUT.
3165 TIMEOUT is the time to stop waiting in seconds.
3166 If TIMEOUT is zero, pass WNOHANG to waitpid.
3167 Returns PID if it was successfully waited for, otherwise -1.
3169 Timeouts are currently implemented with alarm and SIGALRM.
3170 If the host does not support them, this waits "forever".
3171 It would be odd though for a host to have waitpid and not SIGALRM. */
3174 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3176 pid_t waitpid_result
;
3178 gdb_assert (pid
> 0);
3179 gdb_assert (timeout
>= 0);
3184 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3185 struct sigaction sa
, old_sa
;
3187 sa
.sa_handler
= sigalrm_handler
;
3188 sigemptyset (&sa
.sa_mask
);
3190 sigaction (SIGALRM
, &sa
, &old_sa
);
3194 ofunc
= signal (SIGALRM
, sigalrm_handler
);
3200 waitpid_result
= waitpid (pid
, status
, 0);
3204 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3205 sigaction (SIGALRM
, &old_sa
, NULL
);
3207 signal (SIGALRM
, ofunc
);
3212 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3214 if (waitpid_result
== pid
)
3220 #endif /* HAVE_WAITPID */
3222 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3223 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3225 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3226 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3229 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3231 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3233 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3234 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3236 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3238 char *pattern_slash
, *string_slash
;
3240 /* Replace '\' by '/' in both strings. */
3242 pattern_slash
= (char *) alloca (strlen (pattern
) + 1);
3243 strcpy (pattern_slash
, pattern
);
3244 pattern
= pattern_slash
;
3245 for (; *pattern_slash
!= 0; pattern_slash
++)
3246 if (IS_DIR_SEPARATOR (*pattern_slash
))
3247 *pattern_slash
= '/';
3249 string_slash
= (char *) alloca (strlen (string
) + 1);
3250 strcpy (string_slash
, string
);
3251 string
= string_slash
;
3252 for (; *string_slash
!= 0; string_slash
++)
3253 if (IS_DIR_SEPARATOR (*string_slash
))
3254 *string_slash
= '/';
3256 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3258 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3259 flags
|= FNM_CASEFOLD
;
3260 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3262 return fnmatch (pattern
, string
, flags
);
3265 /* Return the number of path elements in PATH.
3273 count_path_elements (const char *path
)
3276 const char *p
= path
;
3278 if (HAS_DRIVE_SPEC (p
))
3280 p
= STRIP_DRIVE_SPEC (p
);
3286 if (IS_DIR_SEPARATOR (*p
))
3291 /* Backup one if last character is /, unless it's the only one. */
3292 if (p
> path
+ 1 && IS_DIR_SEPARATOR (p
[-1]))
3295 /* Add one for the file name, if present. */
3296 if (p
> path
&& !IS_DIR_SEPARATOR (p
[-1]))
3302 /* Remove N leading path elements from PATH.
3303 N must be non-negative.
3304 If PATH has more than N path elements then return NULL.
3305 If PATH has exactly N path elements then return "".
3306 See count_path_elements for a description of how we do the counting. */
3309 strip_leading_path_elements (const char *path
, int n
)
3312 const char *p
= path
;
3314 gdb_assert (n
>= 0);
3319 if (HAS_DRIVE_SPEC (p
))
3321 p
= STRIP_DRIVE_SPEC (p
);
3327 while (*p
!= '\0' && !IS_DIR_SEPARATOR (*p
))
3345 copy_bitwise (gdb_byte
*dest
, ULONGEST dest_offset
,
3346 const gdb_byte
*source
, ULONGEST source_offset
,
3347 ULONGEST nbits
, int bits_big_endian
)
3349 unsigned int buf
, avail
;
3354 if (bits_big_endian
)
3356 /* Start from the end, then work backwards. */
3357 dest_offset
+= nbits
- 1;
3358 dest
+= dest_offset
/ 8;
3359 dest_offset
= 7 - dest_offset
% 8;
3360 source_offset
+= nbits
- 1;
3361 source
+= source_offset
/ 8;
3362 source_offset
= 7 - source_offset
% 8;
3366 dest
+= dest_offset
/ 8;
3368 source
+= source_offset
/ 8;
3372 /* Fill BUF with DEST_OFFSET bits from the destination and 8 -
3373 SOURCE_OFFSET bits from the source. */
3374 buf
= *(bits_big_endian
? source
-- : source
++) >> source_offset
;
3375 buf
<<= dest_offset
;
3376 buf
|= *dest
& ((1 << dest_offset
) - 1);
3378 /* NBITS: bits yet to be written; AVAIL: BUF's fill level. */
3379 nbits
+= dest_offset
;
3380 avail
= dest_offset
+ 8 - source_offset
;
3382 /* Flush 8 bits from BUF, if appropriate. */
3383 if (nbits
>= 8 && avail
>= 8)
3385 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3391 /* Copy the middle part. */
3394 size_t len
= nbits
/ 8;
3396 /* Use a faster method for byte-aligned copies. */
3399 if (bits_big_endian
)
3403 memcpy (dest
+ 1, source
+ 1, len
);
3407 memcpy (dest
, source
, len
);
3416 buf
|= *(bits_big_endian
? source
-- : source
++) << avail
;
3417 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3424 /* Write the last byte. */
3428 buf
|= *source
<< avail
;
3430 buf
&= (1 << nbits
) - 1;
3431 *dest
= (*dest
& (~0U << nbits
)) | buf
;
3435 void _initialize_utils ();
3437 _initialize_utils ()
3439 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
3440 Set number of characters where GDB should wrap lines of its output."), _("\
3441 Show number of characters where GDB should wrap lines of its output."), _("\
3442 This affects where GDB wraps its output to fit the screen width.\n\
3443 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
3445 show_chars_per_line
,
3446 &setlist
, &showlist
);
3448 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
3449 Set number of lines in a page for GDB output pagination."), _("\
3450 Show number of lines in a page for GDB output pagination."), _("\
3451 This affects the number of lines after which GDB will pause\n\
3452 its output and ask you whether to continue.\n\
3453 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
3455 show_lines_per_page
,
3456 &setlist
, &showlist
);
3458 add_setshow_boolean_cmd ("pagination", class_support
,
3459 &pagination_enabled
, _("\
3460 Set state of GDB output pagination."), _("\
3461 Show state of GDB output pagination."), _("\
3462 When pagination is ON, GDB pauses at end of each screenful of\n\
3463 its output and asks you whether to continue.\n\
3464 Turning pagination off is an alternative to \"set height unlimited\"."),
3466 show_pagination_enabled
,
3467 &setlist
, &showlist
);
3469 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
3470 &sevenbit_strings
, _("\
3471 Set printing of 8-bit characters in strings as \\nnn."), _("\
3472 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
3474 show_sevenbit_strings
,
3475 &setprintlist
, &showprintlist
);
3477 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
3478 &debug_timestamp
, _("\
3479 Set timestamping of debugging messages."), _("\
3480 Show timestamping of debugging messages."), _("\
3481 When set, debugging messages will be marked with seconds and microseconds."),
3483 show_debug_timestamp
,
3484 &setdebuglist
, &showdebuglist
);
3486 add_internal_problem_command (&internal_error_problem
);
3487 add_internal_problem_command (&internal_warning_problem
);
3488 add_internal_problem_command (&demangler_warning_problem
);
3491 selftests::register_test ("gdb_realpath", gdb_realpath_tests
);