1 /* General utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2019 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 (); /* NOTE: GDB has only three calls to 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 (); /* NOTE: GDB has only three calls to 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 (); /* NOTE: GDB has only three calls to 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 /* Dummy functions to keep add_prefix_cmd happy. */
475 set_internal_problem_cmd (const char *args
, int from_tty
)
480 show_internal_problem_cmd (const char *args
, int from_tty
)
484 /* When GDB reports an internal problem (error or warning) it gives
485 the user the opportunity to quit GDB and/or create a core file of
486 the current debug session. This function registers a few commands
487 that make it possible to specify that GDB should always or never
488 quit or create a core file, without asking. The commands look
491 maint set PROBLEM-NAME quit ask|yes|no
492 maint show PROBLEM-NAME quit
493 maint set PROBLEM-NAME corefile ask|yes|no
494 maint show PROBLEM-NAME corefile
496 Where PROBLEM-NAME is currently "internal-error" or
497 "internal-warning". */
500 add_internal_problem_command (struct internal_problem
*problem
)
502 struct cmd_list_element
**set_cmd_list
;
503 struct cmd_list_element
**show_cmd_list
;
507 set_cmd_list
= XNEW (struct cmd_list_element
*);
508 show_cmd_list
= XNEW (struct cmd_list_element
*);
509 *set_cmd_list
= NULL
;
510 *show_cmd_list
= NULL
;
512 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
515 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
518 add_prefix_cmd (problem
->name
,
519 class_maintenance
, set_internal_problem_cmd
, set_doc
,
521 concat ("maintenance set ", problem
->name
, " ",
523 0/*allow-unknown*/, &maintenance_set_cmdlist
);
525 add_prefix_cmd (problem
->name
,
526 class_maintenance
, show_internal_problem_cmd
, show_doc
,
528 concat ("maintenance show ", problem
->name
, " ",
530 0/*allow-unknown*/, &maintenance_show_cmdlist
);
532 if (problem
->user_settable_should_quit
)
534 set_doc
= xstrprintf (_("Set whether GDB should quit "
535 "when an %s is detected."),
537 show_doc
= xstrprintf (_("Show whether GDB will quit "
538 "when an %s is detected."),
540 add_setshow_enum_cmd ("quit", class_maintenance
,
541 internal_problem_modes
,
542 &problem
->should_quit
,
555 if (problem
->user_settable_should_dump_core
)
557 set_doc
= xstrprintf (_("Set whether GDB should create a core "
558 "file of GDB when %s is detected."),
560 show_doc
= xstrprintf (_("Show whether GDB will create a core "
561 "file of GDB when %s is detected."),
563 add_setshow_enum_cmd ("corefile", class_maintenance
,
564 internal_problem_modes
,
565 &problem
->should_dump_core
,
579 /* Return a newly allocated string, containing the PREFIX followed
580 by the system error message for errno (separated by a colon). */
583 perror_string (const char *prefix
)
585 const char *err
= safe_strerror (errno
);
586 return std::string (prefix
) + ": " + err
;
589 /* Print the system error message for errno, and also mention STRING
590 as the file name for which the error was encountered. Use ERRCODE
591 for the thrown exception. Then return to command level. */
594 throw_perror_with_name (enum errors errcode
, const char *string
)
596 std::string combined
= perror_string (string
);
598 /* I understand setting these is a matter of taste. Still, some people
599 may clear errno but not know about bfd_error. Doing this here is not
601 bfd_set_error (bfd_error_no_error
);
604 throw_error (errcode
, _("%s."), combined
.c_str ());
607 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
610 perror_with_name (const char *string
)
612 throw_perror_with_name (GENERIC_ERROR
, string
);
615 /* Same as perror_with_name except that it prints a warning instead
616 of throwing an error. */
619 perror_warning_with_name (const char *string
)
621 std::string combined
= perror_string (string
);
622 warning (_("%s"), combined
.c_str ());
625 /* Print the system error message for ERRCODE, and also mention STRING
626 as the file name for which the error was encountered. */
629 print_sys_errmsg (const char *string
, int errcode
)
631 const char *err
= safe_strerror (errcode
);
632 char *combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
633 strcpy (combined
, string
);
634 strcat (combined
, ": ");
635 strcat (combined
, err
);
637 /* We want anything which was printed on stdout to come out first, before
639 gdb_flush (gdb_stdout
);
640 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
643 /* Control C eventually causes this to be called, at a convenient time. */
648 if (sync_quit_force_run
)
650 sync_quit_force_run
= 0;
651 quit_force (NULL
, 0);
655 /* No steenking SIGINT will ever be coming our way when the
656 program is resumed. Don't lie. */
660 /* If there is no terminal switching for this target, then we can't
661 possibly get screwed by the lack of job control. */
662 || !target_supports_terminal_ours ())
665 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
674 if (sync_quit_force_run
)
681 /* Called when a memory allocation fails, with the number of bytes of
682 memory requested in SIZE. */
685 malloc_failure (long size
)
689 internal_error (__FILE__
, __LINE__
,
690 _("virtual memory exhausted: can't allocate %ld bytes."),
695 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
699 /* My replacement for the read system call.
700 Used like `read' but keeps going if `read' returns too soon. */
703 myread (int desc
, char *addr
, int len
)
710 val
= read (desc
, addr
, len
);
722 print_spaces (int n
, struct ui_file
*file
)
724 fputs_unfiltered (n_spaces (n
), file
);
727 /* Print a host address. */
730 gdb_print_host_address_1 (const void *addr
, struct ui_file
*stream
)
732 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
737 /* An RAII class that sets up to handle input and then tears down
738 during destruction. */
740 class scoped_input_handler
744 scoped_input_handler ()
745 : m_quit_handler (&quit_handler
, default_quit_handler
),
748 target_terminal::ours ();
749 ui_register_input_event_handler (current_ui
);
750 if (current_ui
->prompt_state
== PROMPT_BLOCKED
)
754 ~scoped_input_handler ()
757 ui_unregister_input_event_handler (m_ui
);
760 DISABLE_COPY_AND_ASSIGN (scoped_input_handler
);
764 /* Save and restore the terminal state. */
765 target_terminal::scoped_restore_terminal_state m_term_state
;
767 /* Save and restore the quit handler. */
768 scoped_restore_tmpl
<quit_handler_ftype
*> m_quit_handler
;
770 /* The saved UI, if non-NULL. */
776 /* This function supports the query, nquery, and yquery functions.
777 Ask user a y-or-n question and return 0 if answer is no, 1 if
778 answer is yes, or default the answer to the specified default
779 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
780 default answer, or '\0' for no default.
781 CTLSTR is the control string and should end in "? ". It should
782 not say how to answer, because we do that.
783 ARGS are the arguments passed along with the CTLSTR argument to
786 static int ATTRIBUTE_PRINTF (1, 0)
787 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
791 char def_answer
, not_def_answer
;
792 const char *y_string
, *n_string
;
794 /* Set up according to which answer is the default. */
799 not_def_answer
= 'N';
803 else if (defchar
== 'y')
807 not_def_answer
= 'N';
815 not_def_answer
= 'Y';
820 /* Automatically answer the default value if the user did not want
821 prompts or the command was issued with the server prefix. */
822 if (!confirm
|| server_command
)
825 /* If input isn't coming from the user directly, just say what
826 question we're asking, and then answer the default automatically. This
827 way, important error messages don't get lost when talking to GDB
829 if (current_ui
->instream
!= current_ui
->stdin_stream
830 || !input_interactive_p (current_ui
)
831 /* Restrict queries to the main UI. */
832 || current_ui
!= main_ui
)
834 target_terminal::scoped_restore_terminal_state term_state
;
835 target_terminal::ours_for_output ();
837 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
839 printf_filtered (_("(%s or %s) [answered %c; "
840 "input not from terminal]\n"),
841 y_string
, n_string
, def_answer
);
846 if (deprecated_query_hook
)
848 target_terminal::scoped_restore_terminal_state term_state
;
849 return deprecated_query_hook (ctlstr
, args
);
852 /* Format the question outside of the loop, to avoid reusing args. */
853 std::string question
= string_vprintf (ctlstr
, args
);
855 = string_printf (_("%s%s(%s or %s) %s"),
856 annotation_level
> 1 ? "\n\032\032pre-query\n" : "",
857 question
.c_str (), y_string
, n_string
,
858 annotation_level
> 1 ? "\n\032\032query\n" : "");
860 /* Used to add duration we waited for user to respond to
861 prompt_for_continue_wait_time. */
862 using namespace std::chrono
;
863 steady_clock::time_point prompt_started
= steady_clock::now ();
865 scoped_input_handler prepare_input
;
869 char *response
, answer
;
871 gdb_flush (gdb_stdout
);
872 response
= gdb_readline_wrapper (prompt
.c_str ());
874 if (response
== NULL
) /* C-d */
876 printf_filtered ("EOF [assumed %c]\n", def_answer
);
881 answer
= response
[0];
886 /* Check answer. For the non-default, the user must specify
887 the non-default explicitly. */
888 if (answer
== not_def_answer
)
893 /* Otherwise, if a default was specified, the user may either
894 specify the required input or have it default by entering
896 if (answer
== def_answer
897 || (defchar
!= '\0' && answer
== '\0'))
902 /* Invalid entries are not defaulted and require another selection. */
903 printf_filtered (_("Please answer %s or %s.\n"),
907 /* Add time spend in this routine to prompt_for_continue_wait_time. */
908 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
910 if (annotation_level
> 1)
911 printf_filtered (("\n\032\032post-query\n"));
916 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
917 answer is yes, or 0 if answer is defaulted.
918 Takes three args which are given to printf to print the question.
919 The first, a control string, should end in "? ".
920 It should not say how to answer, because we do that. */
923 nquery (const char *ctlstr
, ...)
928 va_start (args
, ctlstr
);
929 ret
= defaulted_query (ctlstr
, 'n', args
);
934 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
935 answer is yes, or 1 if answer is defaulted.
936 Takes three args which are given to printf to print the question.
937 The first, a control string, should end in "? ".
938 It should not say how to answer, because we do that. */
941 yquery (const char *ctlstr
, ...)
946 va_start (args
, ctlstr
);
947 ret
= defaulted_query (ctlstr
, 'y', args
);
952 /* Ask user a y-or-n question and return 1 iff answer is yes.
953 Takes three args which are given to printf to print the question.
954 The first, a control string, should end in "? ".
955 It should not say how to answer, because we do that. */
958 query (const char *ctlstr
, ...)
963 va_start (args
, ctlstr
);
964 ret
= defaulted_query (ctlstr
, '\0', args
);
969 /* A helper for parse_escape that converts a host character to a
970 target character. C is the host character. If conversion is
971 possible, then the target character is stored in *TARGET_C and the
972 function returns 1. Otherwise, the function returns 0. */
975 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
980 auto_obstack host_data
;
982 convert_between_encodings (target_charset (gdbarch
), host_charset (),
983 (gdb_byte
*) &the_char
, 1, 1,
984 &host_data
, translit_none
);
986 if (obstack_object_size (&host_data
) == 1)
989 *target_c
= *(char *) obstack_base (&host_data
);
995 /* Parse a C escape sequence. STRING_PTR points to a variable
996 containing a pointer to the string to parse. That pointer
997 should point to the character after the \. That pointer
998 is updated past the characters we use. The value of the
999 escape sequence is returned.
1001 A negative value means the sequence \ newline was seen,
1002 which is supposed to be equivalent to nothing at all.
1004 If \ is followed by a null character, we return a negative
1005 value and leave the string pointer pointing at the null character.
1007 If \ is followed by 000, we return 0 and leave the string pointer
1008 after the zeros. A value of 0 does not mean end of string. */
1011 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1013 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1014 int c
= *(*string_ptr
)++;
1033 int i
= host_hex_value (c
);
1038 if (isdigit (c
) && c
!= '8' && c
!= '9')
1042 i
+= host_hex_value (c
);
1078 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1079 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1080 " which has no equivalent\nin the `%s' character set."),
1081 c
, c
, target_charset (gdbarch
));
1085 /* Print the character C on STREAM as part of the contents of a literal
1086 string whose delimiter is QUOTER. Note that this routine should only
1087 be called for printing things which are independent of the language
1088 of the program being debugged.
1090 printchar will normally escape backslashes and instances of QUOTER. If
1091 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1092 As a side effect, if you pass the backslash character as the QUOTER,
1093 printchar will escape backslashes as usual, but not any other quoting
1097 printchar (int c
, do_fputc_ftype do_fputc
, ui_file
*stream
, int quoter
)
1099 c
&= 0xFF; /* Avoid sign bit follies */
1101 if (c
< 0x20 || /* Low control chars */
1102 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1103 (sevenbit_strings
&& c
>= 0x80))
1104 { /* high order bit set */
1105 do_fputc ('\\', stream
);
1110 do_fputc ('n', stream
);
1113 do_fputc ('b', stream
);
1116 do_fputc ('t', stream
);
1119 do_fputc ('f', stream
);
1122 do_fputc ('r', stream
);
1125 do_fputc ('e', stream
);
1128 do_fputc ('a', stream
);
1132 do_fputc ('0' + ((c
>> 6) & 0x7), stream
);
1133 do_fputc ('0' + ((c
>> 3) & 0x7), stream
);
1134 do_fputc ('0' + ((c
>> 0) & 0x7), stream
);
1141 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1142 do_fputc ('\\', stream
);
1143 do_fputc (c
, stream
);
1147 /* Print the character C on STREAM as part of the contents of a
1148 literal string whose delimiter is QUOTER. Note that these routines
1149 should only be call for printing things which are independent of
1150 the language of the program being debugged. */
1153 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1156 printchar (*str
++, fputc_filtered
, stream
, quoter
);
1160 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1163 printchar (*str
++, fputc_unfiltered
, stream
, quoter
);
1167 fputstrn_filtered (const char *str
, int n
, int quoter
,
1168 struct ui_file
*stream
)
1170 for (int i
= 0; i
< n
; i
++)
1171 printchar (str
[i
], fputc_filtered
, stream
, quoter
);
1175 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1176 do_fputc_ftype do_fputc
, struct ui_file
*stream
)
1178 for (int i
= 0; i
< n
; i
++)
1179 printchar (str
[i
], do_fputc
, stream
, quoter
);
1183 /* Number of lines per page or UINT_MAX if paging is disabled. */
1184 static unsigned int lines_per_page
;
1186 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1187 struct cmd_list_element
*c
, const char *value
)
1189 fprintf_filtered (file
,
1190 _("Number of lines gdb thinks are in a page is %s.\n"),
1194 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1195 static unsigned int chars_per_line
;
1197 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1198 struct cmd_list_element
*c
, const char *value
)
1200 fprintf_filtered (file
,
1201 _("Number of characters gdb thinks "
1202 "are in a line is %s.\n"),
1206 /* Current count of lines printed on this page, chars on this line. */
1207 static unsigned int lines_printed
, chars_printed
;
1209 /* True if pagination is disabled for just one command. */
1211 static bool pagination_disabled_for_command
;
1213 /* Buffer and start column of buffered text, for doing smarter word-
1214 wrapping. When someone calls wrap_here(), we start buffering output
1215 that comes through fputs_filtered(). If we see a newline, we just
1216 spit it out and forget about the wrap_here(). If we see another
1217 wrap_here(), we spit it out and remember the newer one. If we see
1218 the end of the line, we spit out a newline, the indent, and then
1219 the buffered output. */
1221 static bool filter_initialized
= false;
1223 /* Contains characters which are waiting to be output (they have
1224 already been counted in chars_printed). */
1225 static std::string wrap_buffer
;
1227 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1229 static const char *wrap_indent
;
1231 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1232 is not in effect. */
1233 static int wrap_column
;
1235 /* The style applied at the time that wrap_here was called. */
1236 static ui_file_style wrap_style
;
1239 /* Initialize the number of lines per page and chars per line. */
1242 init_page_info (void)
1246 lines_per_page
= UINT_MAX
;
1247 chars_per_line
= UINT_MAX
;
1251 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1256 #if defined(__GO32__)
1257 rows
= ScreenRows ();
1258 cols
= ScreenCols ();
1259 lines_per_page
= rows
;
1260 chars_per_line
= cols
;
1262 /* Make sure Readline has initialized its terminal settings. */
1263 rl_reset_terminal (NULL
);
1265 /* Get the screen size from Readline. */
1266 rl_get_screen_size (&rows
, &cols
);
1267 lines_per_page
= rows
;
1268 chars_per_line
= cols
;
1270 /* Readline should have fetched the termcap entry for us.
1271 Only try to use tgetnum function if rl_get_screen_size
1272 did not return a useful value. */
1273 if (((rows
<= 0) && (tgetnum ((char *) "li") < 0))
1274 /* Also disable paging if inside Emacs. $EMACS was used
1275 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1276 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1278 /* The number of lines per page is not mentioned in the terminal
1279 description or EMACS environment variable is set. This probably
1280 means that paging is not useful, so disable paging. */
1281 lines_per_page
= UINT_MAX
;
1284 /* If the output is not a terminal, don't paginate it. */
1285 if (!ui_file_isatty (gdb_stdout
))
1286 lines_per_page
= UINT_MAX
;
1290 /* We handle SIGWINCH ourselves. */
1291 rl_catch_sigwinch
= 0;
1297 /* Return nonzero if filtered printing is initialized. */
1299 filtered_printing_initialized (void)
1301 return filter_initialized
;
1304 set_batch_flag_and_restore_page_info::set_batch_flag_and_restore_page_info ()
1305 : m_save_lines_per_page (lines_per_page
),
1306 m_save_chars_per_line (chars_per_line
),
1307 m_save_batch_flag (batch_flag
)
1313 set_batch_flag_and_restore_page_info::~set_batch_flag_and_restore_page_info ()
1315 batch_flag
= m_save_batch_flag
;
1316 chars_per_line
= m_save_chars_per_line
;
1317 lines_per_page
= m_save_lines_per_page
;
1323 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1326 set_screen_size (void)
1328 int rows
= lines_per_page
;
1329 int cols
= chars_per_line
;
1331 /* If we get 0 or negative ROWS or COLS, treat as "infinite" size.
1332 A negative number can be seen here with the "set width/height"
1333 commands and either:
1335 - the user specified "unlimited", which maps to UINT_MAX, or
1336 - the user specified some number between INT_MAX and UINT_MAX.
1338 Cap "infinity" to approximately sqrt(INT_MAX) so that we don't
1339 overflow in rl_set_screen_size, which multiplies rows and columns
1340 to compute the number of characters on the screen. */
1342 const int sqrt_int_max
= INT_MAX
>> (sizeof (int) * 8 / 2);
1344 if (rows
<= 0 || rows
> sqrt_int_max
)
1346 rows
= sqrt_int_max
;
1347 lines_per_page
= UINT_MAX
;
1350 if (cols
<= 0 || cols
> sqrt_int_max
)
1352 cols
= sqrt_int_max
;
1353 chars_per_line
= UINT_MAX
;
1356 /* Update Readline's idea of the terminal size. */
1357 rl_set_screen_size (rows
, cols
);
1360 /* Reinitialize WRAP_BUFFER. */
1365 if (chars_per_line
== 0)
1368 wrap_buffer
.clear ();
1369 filter_initialized
= true;
1373 set_width_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1380 set_height_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1388 set_screen_width_and_height (int width
, int height
)
1390 lines_per_page
= height
;
1391 chars_per_line
= width
;
1397 /* The currently applied style. */
1399 static ui_file_style applied_style
;
1401 /* Emit an ANSI style escape for STYLE. If STREAM is nullptr, emit to
1402 the wrap buffer; otherwise emit to STREAM. */
1405 emit_style_escape (const ui_file_style
&style
,
1406 struct ui_file
*stream
= nullptr)
1408 applied_style
= style
;
1410 if (stream
== nullptr)
1411 wrap_buffer
.append (style
.to_ansi ());
1413 fputs_unfiltered (style
.to_ansi ().c_str (), stream
);
1416 /* Set the current output style. This will affect future uses of the
1417 _filtered output functions. */
1420 set_output_style (struct ui_file
*stream
, const ui_file_style
&style
)
1422 if (!stream
->can_emit_style_escape ())
1425 /* Note that we may not pass STREAM here, when we want to emit to
1426 the wrap buffer, not directly to STREAM. */
1427 if (stream
== gdb_stdout
)
1429 emit_style_escape (style
, stream
);
1435 reset_terminal_style (struct ui_file
*stream
)
1437 if (stream
->can_emit_style_escape ())
1439 /* Force the setting, regardless of what we think the setting
1440 might already be. */
1441 applied_style
= ui_file_style ();
1442 wrap_buffer
.append (applied_style
.to_ansi ());
1446 /* Wait, so the user can read what's on the screen. Prompt the user
1447 to continue by pressing RETURN. 'q' is also provided because
1448 telling users what to do in the prompt is more user-friendly than
1449 expecting them to think of Ctrl-C/SIGINT. */
1452 prompt_for_continue (void)
1454 char cont_prompt
[120];
1455 /* Used to add duration we waited for user to respond to
1456 prompt_for_continue_wait_time. */
1457 using namespace std::chrono
;
1458 steady_clock::time_point prompt_started
= steady_clock::now ();
1459 bool disable_pagination
= pagination_disabled_for_command
;
1461 /* Clear the current styling. */
1462 if (gdb_stdout
->can_emit_style_escape ())
1463 emit_style_escape (ui_file_style (), gdb_stdout
);
1465 if (annotation_level
> 1)
1466 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1468 strcpy (cont_prompt
,
1469 "--Type <RET> for more, q to quit, "
1470 "c to continue without paging--");
1471 if (annotation_level
> 1)
1472 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1474 /* We must do this *before* we call gdb_readline_wrapper, else it
1475 will eventually call us -- thinking that we're trying to print
1476 beyond the end of the screen. */
1477 reinitialize_more_filter ();
1479 scoped_input_handler prepare_input
;
1481 /* Call gdb_readline_wrapper, not readline, in order to keep an
1482 event loop running. */
1483 gdb::unique_xmalloc_ptr
<char> ignore (gdb_readline_wrapper (cont_prompt
));
1485 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1486 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1488 if (annotation_level
> 1)
1489 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1493 char *p
= ignore
.get ();
1495 while (*p
== ' ' || *p
== '\t')
1498 /* Do not call quit here; there is no possibility of SIGINT. */
1499 throw_quit ("Quit");
1501 disable_pagination
= true;
1504 /* Now we have to do this again, so that GDB will know that it doesn't
1505 need to save the ---Type <return>--- line at the top of the screen. */
1506 reinitialize_more_filter ();
1507 pagination_disabled_for_command
= disable_pagination
;
1509 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1512 /* Initialize timer to keep track of how long we waited for the user. */
1515 reset_prompt_for_continue_wait_time (void)
1517 using namespace std::chrono
;
1519 prompt_for_continue_wait_time
= steady_clock::duration::zero ();
1522 /* Fetch the cumulative time spent in prompt_for_continue. */
1524 std::chrono::steady_clock::duration
1525 get_prompt_for_continue_wait_time ()
1527 return prompt_for_continue_wait_time
;
1530 /* Reinitialize filter; ie. tell it to reset to original values. */
1533 reinitialize_more_filter (void)
1537 pagination_disabled_for_command
= false;
1540 /* Flush the wrap buffer to STREAM, if necessary. */
1543 flush_wrap_buffer (struct ui_file
*stream
)
1545 if (stream
== gdb_stdout
&& !wrap_buffer
.empty ())
1547 fputs_unfiltered (wrap_buffer
.c_str (), stream
);
1548 wrap_buffer
.clear ();
1552 /* Indicate that if the next sequence of characters overflows the line,
1553 a newline should be inserted here rather than when it hits the end.
1554 If INDENT is non-null, it is a string to be printed to indent the
1555 wrapped part on the next line. INDENT must remain accessible until
1556 the next call to wrap_here() or until a newline is printed through
1559 If the line is already overfull, we immediately print a newline and
1560 the indentation, and disable further wrapping.
1562 If we don't know the width of lines, but we know the page height,
1563 we must not wrap words, but should still keep track of newlines
1564 that were explicitly printed.
1566 INDENT should not contain tabs, as that will mess up the char count
1567 on the next line. FIXME.
1569 This routine is guaranteed to force out any output which has been
1570 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1571 used to force out output from the wrap_buffer. */
1574 wrap_here (const char *indent
)
1576 /* This should have been allocated, but be paranoid anyway. */
1577 if (!filter_initialized
)
1578 internal_error (__FILE__
, __LINE__
,
1579 _("failed internal consistency check"));
1581 flush_wrap_buffer (gdb_stdout
);
1582 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1586 else if (chars_printed
>= chars_per_line
)
1588 puts_filtered ("\n");
1590 puts_filtered (indent
);
1595 wrap_column
= chars_printed
;
1599 wrap_indent
= indent
;
1600 wrap_style
= applied_style
;
1604 /* Print input string to gdb_stdout, filtered, with wrap,
1605 arranging strings in columns of n chars. String can be
1606 right or left justified in the column. Never prints
1607 trailing spaces. String should never be longer than
1608 width. FIXME: this could be useful for the EXAMINE
1609 command, which currently doesn't tabulate very well. */
1612 puts_filtered_tabular (char *string
, int width
, int right
)
1618 gdb_assert (chars_per_line
> 0);
1619 if (chars_per_line
== UINT_MAX
)
1621 fputs_filtered (string
, gdb_stdout
);
1622 fputs_filtered ("\n", gdb_stdout
);
1626 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1627 fputs_filtered ("\n", gdb_stdout
);
1629 if (width
>= chars_per_line
)
1630 width
= chars_per_line
- 1;
1632 stringlen
= strlen (string
);
1634 if (chars_printed
> 0)
1635 spaces
= width
- (chars_printed
- 1) % width
- 1;
1637 spaces
+= width
- stringlen
;
1639 spacebuf
= (char *) alloca (spaces
+ 1);
1640 spacebuf
[spaces
] = '\0';
1642 spacebuf
[spaces
] = ' ';
1644 fputs_filtered (spacebuf
, gdb_stdout
);
1645 fputs_filtered (string
, gdb_stdout
);
1649 /* Ensure that whatever gets printed next, using the filtered output
1650 commands, starts at the beginning of the line. I.e. if there is
1651 any pending output for the current line, flush it and start a new
1652 line. Otherwise do nothing. */
1657 if (chars_printed
> 0)
1659 puts_filtered ("\n");
1664 /* Like fputs but if FILTER is true, pause after every screenful.
1666 Regardless of FILTER can wrap at points other than the final
1667 character of a line.
1669 Unlike fputs, fputs_maybe_filtered does not return a value.
1670 It is OK for LINEBUFFER to be NULL, in which case just don't print
1673 Note that a longjmp to top level may occur in this routine (only if
1674 FILTER is true) (since prompt_for_continue may do so) so this
1675 routine should not be called when cleanups are not in place. */
1678 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1681 const char *lineptr
;
1683 if (linebuffer
== 0)
1686 /* Don't do any filtering if it is disabled. */
1687 if (stream
!= gdb_stdout
1688 || !pagination_enabled
1689 || pagination_disabled_for_command
1691 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
1692 || top_level_interpreter () == NULL
1693 || top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
1695 flush_wrap_buffer (stream
);
1696 fputs_unfiltered (linebuffer
, stream
);
1701 = make_scope_exit ([&] ()
1703 wrap_buffer
.clear ();
1708 /* Go through and output each character. Show line extension
1709 when this is necessary; prompt user for new page when this is
1712 lineptr
= linebuffer
;
1715 /* Possible new page. Note that PAGINATION_DISABLED_FOR_COMMAND
1716 might be set during this loop, so we must continue to check
1718 if (filter
&& (lines_printed
>= lines_per_page
- 1)
1719 && !pagination_disabled_for_command
)
1720 prompt_for_continue ();
1722 while (*lineptr
&& *lineptr
!= '\n')
1726 /* Print a single line. */
1727 if (*lineptr
== '\t')
1729 wrap_buffer
.push_back ('\t');
1730 /* Shifting right by 3 produces the number of tab stops
1731 we have already passed, and then adding one and
1732 shifting left 3 advances to the next tab stop. */
1733 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
1736 else if (*lineptr
== '\033'
1737 && skip_ansi_escape (lineptr
, &skip_bytes
))
1739 wrap_buffer
.append (lineptr
, skip_bytes
);
1740 /* Note that we don't consider this a character, so we
1741 don't increment chars_printed here. */
1742 lineptr
+= skip_bytes
;
1746 wrap_buffer
.push_back (*lineptr
);
1751 if (chars_printed
>= chars_per_line
)
1753 unsigned int save_chars
= chars_printed
;
1755 /* If we change the style, below, we'll want to reset it
1756 before continuing to print. If there is no wrap
1757 column, then we'll only reset the style if the pager
1758 prompt is given; and to avoid emitting style
1759 sequences in the middle of a run of text, we track
1761 ui_file_style save_style
;
1762 bool did_paginate
= false;
1768 save_style
= wrap_style
;
1769 if (stream
->can_emit_style_escape ())
1770 emit_style_escape (ui_file_style (), stream
);
1771 /* If we aren't actually wrapping, don't output
1772 newline -- if chars_per_line is right, we
1773 probably just overflowed anyway; if it's wrong,
1774 let us keep going. */
1775 fputc_unfiltered ('\n', stream
);
1779 save_style
= applied_style
;
1780 flush_wrap_buffer (stream
);
1783 /* Possible new page. Note that
1784 PAGINATION_DISABLED_FOR_COMMAND might be set during
1785 this loop, so we must continue to check it here. */
1786 if (lines_printed
>= lines_per_page
- 1
1787 && !pagination_disabled_for_command
)
1789 prompt_for_continue ();
1790 did_paginate
= true;
1793 /* Now output indentation and wrapped string. */
1796 fputs_unfiltered (wrap_indent
, stream
);
1797 if (stream
->can_emit_style_escape ())
1798 emit_style_escape (save_style
, stream
);
1799 /* FIXME, this strlen is what prevents wrap_indent from
1800 containing tabs. However, if we recurse to print it
1801 and count its chars, we risk trouble if wrap_indent is
1802 longer than (the user settable) chars_per_line.
1803 Note also that this can set chars_printed > chars_per_line
1804 if we are printing a long string. */
1805 chars_printed
= strlen (wrap_indent
)
1806 + (save_chars
- wrap_column
);
1807 wrap_column
= 0; /* And disable fancy wrap */
1809 else if (did_paginate
&& stream
->can_emit_style_escape ())
1810 emit_style_escape (save_style
, stream
);
1814 if (*lineptr
== '\n')
1817 wrap_here ((char *) 0); /* Spit out chars, cancel
1820 fputc_unfiltered ('\n', stream
);
1825 buffer_clearer
.release ();
1829 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
1831 fputs_maybe_filtered (linebuffer
, stream
, 1);
1837 fputs_styled (const char *linebuffer
, const ui_file_style
&style
,
1838 struct ui_file
*stream
)
1840 /* This just makes it so we emit somewhat fewer escape
1842 if (style
.is_default ())
1843 fputs_maybe_filtered (linebuffer
, stream
, 1);
1846 set_output_style (stream
, style
);
1847 fputs_maybe_filtered (linebuffer
, stream
, 1);
1848 set_output_style (stream
, ui_file_style ());
1855 fputs_styled_unfiltered (const char *linebuffer
, const ui_file_style
&style
,
1856 struct ui_file
*stream
)
1858 /* This just makes it so we emit somewhat fewer escape
1860 if (style
.is_default ())
1861 fputs_maybe_filtered (linebuffer
, stream
, 0);
1864 set_output_style (stream
, style
);
1865 fputs_maybe_filtered (linebuffer
, stream
, 0);
1866 set_output_style (stream
, ui_file_style ());
1873 fputs_highlighted (const char *str
, const compiled_regex
&highlight
,
1874 struct ui_file
*stream
)
1878 while (*str
&& highlight
.exec (str
, 1, &pmatch
, 0) == 0)
1880 size_t n_highlight
= pmatch
.rm_eo
- pmatch
.rm_so
;
1882 /* Output the part before pmatch with current style. */
1883 while (pmatch
.rm_so
> 0)
1885 fputc_filtered (*str
, stream
);
1890 /* Output pmatch with the highlight style. */
1891 set_output_style (stream
, highlight_style
.style ());
1892 while (n_highlight
> 0)
1894 fputc_filtered (*str
, stream
);
1898 set_output_style (stream
, ui_file_style ());
1901 /* Output the trailing part of STR not matching HIGHLIGHT. */
1903 fputs_filtered (str
, stream
);
1907 putchar_unfiltered (int c
)
1911 ui_file_write (gdb_stdout
, &buf
, 1);
1915 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
1916 May return nonlocally. */
1919 putchar_filtered (int c
)
1921 return fputc_filtered (c
, gdb_stdout
);
1925 fputc_unfiltered (int c
, struct ui_file
*stream
)
1929 ui_file_write (stream
, &buf
, 1);
1934 fputc_filtered (int c
, struct ui_file
*stream
)
1940 fputs_filtered (buf
, stream
);
1944 /* puts_debug is like fputs_unfiltered, except it prints special
1945 characters in printable fashion. */
1948 puts_debug (char *prefix
, char *string
, char *suffix
)
1952 /* Print prefix and suffix after each line. */
1953 static int new_line
= 1;
1954 static int return_p
= 0;
1955 static const char *prev_prefix
= "";
1956 static const char *prev_suffix
= "";
1958 if (*string
== '\n')
1961 /* If the prefix is changing, print the previous suffix, a new line,
1962 and the new prefix. */
1963 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
1965 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
1966 fputs_unfiltered ("\n", gdb_stdlog
);
1967 fputs_unfiltered (prefix
, gdb_stdlog
);
1970 /* Print prefix if we printed a newline during the previous call. */
1974 fputs_unfiltered (prefix
, gdb_stdlog
);
1977 prev_prefix
= prefix
;
1978 prev_suffix
= suffix
;
1980 /* Output characters in a printable format. */
1981 while ((ch
= *string
++) != '\0')
1987 fputc_unfiltered (ch
, gdb_stdlog
);
1990 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
1994 fputs_unfiltered ("\\\\", gdb_stdlog
);
1997 fputs_unfiltered ("\\b", gdb_stdlog
);
2000 fputs_unfiltered ("\\f", gdb_stdlog
);
2004 fputs_unfiltered ("\\n", gdb_stdlog
);
2007 fputs_unfiltered ("\\r", gdb_stdlog
);
2010 fputs_unfiltered ("\\t", gdb_stdlog
);
2013 fputs_unfiltered ("\\v", gdb_stdlog
);
2017 return_p
= ch
== '\r';
2020 /* Print suffix if we printed a newline. */
2023 fputs_unfiltered (suffix
, gdb_stdlog
);
2024 fputs_unfiltered ("\n", gdb_stdlog
);
2029 /* Print a variable number of ARGS using format FORMAT. If this
2030 information is going to put the amount written (since the last call
2031 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2032 call prompt_for_continue to get the users permission to continue.
2034 Unlike fprintf, this function does not return a value.
2036 We implement three variants, vfprintf (takes a vararg list and stream),
2037 fprintf (takes a stream to write on), and printf (the usual).
2039 Note also that this may throw a quit (since prompt_for_continue may
2043 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2044 va_list args
, bool filter
, bool gdbfmt
)
2048 ui_out_flags flags
= disallow_ui_out_field
;
2050 flags
|= unfiltered_output
;
2051 cli_ui_out (stream
, flags
).vmessage (applied_style
, format
, args
);
2055 std::string str
= string_vprintf (format
, args
);
2056 fputs_maybe_filtered (str
.c_str (), stream
, filter
);
2062 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2064 vfprintf_maybe_filtered (stream
, format
, args
, true, true);
2068 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2070 if (debug_timestamp
&& stream
== gdb_stdlog
)
2072 using namespace std::chrono
;
2076 cli_ui_out (&sfile
, 0).vmessage (ui_file_style (), format
, args
);
2077 std::string linebuffer
= std::move (sfile
.string ());
2079 steady_clock::time_point now
= steady_clock::now ();
2080 seconds s
= duration_cast
<seconds
> (now
.time_since_epoch ());
2081 microseconds us
= duration_cast
<microseconds
> (now
.time_since_epoch () - s
);
2083 len
= linebuffer
.size ();
2084 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2086 std::string timestamp
= string_printf ("%ld.%06ld %s%s",
2089 linebuffer
.c_str (),
2090 need_nl
? "\n": "");
2091 fputs_unfiltered (timestamp
.c_str (), stream
);
2094 vfprintf_maybe_filtered (stream
, format
, args
, false, true);
2098 vprintf_filtered (const char *format
, va_list args
)
2100 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, true, false);
2104 vprintf_unfiltered (const char *format
, va_list args
)
2106 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2110 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2114 va_start (args
, format
);
2115 vfprintf_filtered (stream
, format
, args
);
2120 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2124 va_start (args
, format
);
2125 vfprintf_unfiltered (stream
, format
, args
);
2129 /* Like fprintf_filtered, but prints its result indented.
2130 Called as fprintfi_filtered (spaces, stream, format, ...); */
2133 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2138 va_start (args
, format
);
2139 print_spaces_filtered (spaces
, stream
);
2141 vfprintf_filtered (stream
, format
, args
);
2148 fprintf_styled (struct ui_file
*stream
, const ui_file_style
&style
,
2149 const char *format
, ...)
2153 set_output_style (stream
, style
);
2154 va_start (args
, format
);
2155 vfprintf_filtered (stream
, format
, args
);
2157 set_output_style (stream
, ui_file_style ());
2163 vfprintf_styled (struct ui_file
*stream
, const ui_file_style
&style
,
2164 const char *format
, va_list args
)
2166 set_output_style (stream
, style
);
2167 vfprintf_filtered (stream
, format
, args
);
2168 set_output_style (stream
, ui_file_style ());
2174 vfprintf_styled_no_gdbfmt (struct ui_file
*stream
, const ui_file_style
&style
,
2175 bool filter
, const char *format
, va_list args
)
2177 std::string str
= string_vprintf (format
, args
);
2180 if (!style
.is_default ())
2181 set_output_style (stream
, style
);
2182 fputs_maybe_filtered (str
.c_str (), stream
, filter
);
2183 if (!style
.is_default ())
2184 set_output_style (stream
, ui_file_style ());
2189 printf_filtered (const char *format
, ...)
2193 va_start (args
, format
);
2194 vfprintf_filtered (gdb_stdout
, format
, args
);
2200 printf_unfiltered (const char *format
, ...)
2204 va_start (args
, format
);
2205 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2209 /* Like printf_filtered, but prints it's result indented.
2210 Called as printfi_filtered (spaces, format, ...); */
2213 printfi_filtered (int spaces
, const char *format
, ...)
2217 va_start (args
, format
);
2218 print_spaces_filtered (spaces
, gdb_stdout
);
2219 vfprintf_filtered (gdb_stdout
, format
, args
);
2223 /* Easy -- but watch out!
2225 This routine is *not* a replacement for puts()! puts() appends a newline.
2226 This one doesn't, and had better not! */
2229 puts_filtered (const char *string
)
2231 fputs_filtered (string
, gdb_stdout
);
2235 puts_unfiltered (const char *string
)
2237 fputs_unfiltered (string
, gdb_stdout
);
2240 /* Return a pointer to N spaces and a null. The pointer is good
2241 until the next call to here. */
2246 static char *spaces
= 0;
2247 static int max_spaces
= -1;
2253 spaces
= (char *) xmalloc (n
+ 1);
2254 for (t
= spaces
+ n
; t
!= spaces
;)
2260 return spaces
+ max_spaces
- n
;
2263 /* Print N spaces. */
2265 print_spaces_filtered (int n
, struct ui_file
*stream
)
2267 fputs_filtered (n_spaces (n
), stream
);
2270 /* C++/ObjC demangler stuff. */
2272 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2273 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2274 If the name is not mangled, or the language for the name is unknown, or
2275 demangling is off, the name is printed in its "raw" form. */
2278 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2279 enum language lang
, int arg_mode
)
2285 /* If user wants to see raw output, no problem. */
2288 fputs_filtered (name
, stream
);
2292 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2293 fputs_filtered (demangled
? demangled
: name
, stream
);
2294 if (demangled
!= NULL
)
2302 /* True if CH is a character that can be part of a symbol name. I.e.,
2303 either a number, a letter, or a '_'. */
2306 valid_identifier_name_char (int ch
)
2308 return (isalnum (ch
) || ch
== '_');
2311 /* Skip to end of token, or to END, whatever comes first. Input is
2312 assumed to be a C++ operator name. */
2315 cp_skip_operator_token (const char *token
, const char *end
)
2317 const char *p
= token
;
2318 while (p
!= end
&& !isspace (*p
) && *p
!= '(')
2320 if (valid_identifier_name_char (*p
))
2322 while (p
!= end
&& valid_identifier_name_char (*p
))
2328 /* Note, ordered such that among ops that share a prefix,
2329 longer comes first. This is so that the loop below can
2330 bail on first match. */
2331 static const char *ops
[] =
2337 "-=", "--", "->", "-",
2346 "<<=", "<=", "<<", "<",
2347 ">>=", ">=", ">>", ">",
2351 for (const char *op
: ops
)
2353 size_t oplen
= strlen (op
);
2354 size_t lencmp
= std::min
<size_t> (oplen
, end
- p
);
2356 if (strncmp (p
, op
, lencmp
) == 0)
2359 /* Some unidentified character. Return it. */
2367 /* Advance STRING1/STRING2 past whitespace. */
2370 skip_ws (const char *&string1
, const char *&string2
, const char *end_str2
)
2372 while (isspace (*string1
))
2374 while (string2
< end_str2
&& isspace (*string2
))
2378 /* True if STRING points at the start of a C++ operator name. START
2379 is the start of the string that STRING points to, hence when
2380 reading backwards, we must not read any character before START. */
2383 cp_is_operator (const char *string
, const char *start
)
2385 return ((string
== start
2386 || !valid_identifier_name_char (string
[-1]))
2387 && strncmp (string
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
2388 && !valid_identifier_name_char (string
[CP_OPERATOR_LEN
]));
2391 /* If *NAME points at an ABI tag, skip it and return true. Otherwise
2392 leave *NAME unmodified and return false. (see GCC's abi_tag
2393 attribute), such names are demangled as e.g.,
2394 "function[abi:cxx11]()". */
2397 skip_abi_tag (const char **name
)
2399 const char *p
= *name
;
2401 if (startswith (p
, "[abi:"))
2405 while (valid_identifier_name_char (*p
))
2421 strncmp_iw_with_mode (const char *string1
, const char *string2
,
2422 size_t string2_len
, strncmp_iw_mode mode
,
2423 enum language language
,
2424 completion_match_for_lcd
*match_for_lcd
)
2426 const char *string1_start
= string1
;
2427 const char *end_str2
= string2
+ string2_len
;
2428 bool skip_spaces
= true;
2429 bool have_colon_op
= (language
== language_cplus
2430 || language
== language_rust
2431 || language
== language_fortran
);
2436 || ((isspace (*string1
) && !valid_identifier_name_char (*string2
))
2437 || (isspace (*string2
) && !valid_identifier_name_char (*string1
))))
2439 skip_ws (string1
, string2
, end_str2
);
2440 skip_spaces
= false;
2443 /* Skip [abi:cxx11] tags in the symbol name if the lookup name
2444 doesn't include them. E.g.:
2446 string1: function[abi:cxx1](int)
2449 string1: function[abi:cxx1](int)
2450 string2: function(int)
2452 string1: Struct[abi:cxx1]::function()
2453 string2: Struct::function()
2455 string1: function(Struct[abi:cxx1], int)
2456 string2: function(Struct, int)
2458 if (string2
== end_str2
2459 || (*string2
!= '[' && !valid_identifier_name_char (*string2
)))
2461 const char *abi_start
= string1
;
2463 /* There can be more than one tag. */
2464 while (*string1
== '[' && skip_abi_tag (&string1
))
2467 if (match_for_lcd
!= NULL
&& abi_start
!= string1
)
2468 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2470 while (isspace (*string1
))
2474 if (*string1
== '\0' || string2
== end_str2
)
2477 /* Handle the :: operator. */
2478 if (have_colon_op
&& string1
[0] == ':' && string1
[1] == ':')
2480 if (*string2
!= ':')
2486 if (string2
== end_str2
)
2489 if (*string2
!= ':')
2495 while (isspace (*string1
))
2497 while (string2
< end_str2
&& isspace (*string2
))
2502 /* Handle C++ user-defined operators. */
2503 else if (language
== language_cplus
2506 if (cp_is_operator (string1
, string1_start
))
2508 /* An operator name in STRING1. Check STRING2. */
2510 = std::min
<size_t> (CP_OPERATOR_LEN
, end_str2
- string2
);
2511 if (strncmp (string1
, string2
, cmplen
) != 0)
2517 if (string2
!= end_str2
)
2519 /* Check for "operatorX" in STRING2. */
2520 if (valid_identifier_name_char (*string2
))
2523 skip_ws (string1
, string2
, end_str2
);
2526 /* Handle operator(). */
2527 if (*string1
== '(')
2529 if (string2
== end_str2
)
2531 if (mode
== strncmp_iw_mode::NORMAL
)
2535 /* Don't break for the regular return at the
2536 bottom, because "operator" should not
2537 match "operator()", since this open
2538 parentheses is not the parameter list
2540 return *string1
!= '\0';
2544 if (*string1
!= *string2
)
2553 skip_ws (string1
, string2
, end_str2
);
2555 /* Skip to end of token, or to END, whatever comes
2557 const char *end_str1
= string1
+ strlen (string1
);
2558 const char *p1
= cp_skip_operator_token (string1
, end_str1
);
2559 const char *p2
= cp_skip_operator_token (string2
, end_str2
);
2561 cmplen
= std::min (p1
- string1
, p2
- string2
);
2564 if (strncmp (string1
, string2
, cmplen
) != 0)
2569 if (p1
- string1
!= p2
- string2
)
2571 if (strncmp (string1
, string2
, cmplen
) != 0)
2578 if (*string1
== '\0' || string2
== end_str2
)
2580 if (*string1
== '(' || *string2
== '(')
2588 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2590 if (case_sensitivity
== case_sensitive_off
2591 && (tolower ((unsigned char) *string1
)
2592 != tolower ((unsigned char) *string2
)))
2595 /* If we see any non-whitespace, non-identifier-name character
2596 (any of "()<>*&" etc.), then skip spaces the next time
2598 if (!isspace (*string1
) && !valid_identifier_name_char (*string1
))
2605 if (string2
== end_str2
)
2607 if (mode
== strncmp_iw_mode::NORMAL
)
2609 /* Strip abi tag markers from the matched symbol name.
2610 Usually the ABI marker will be found on function name
2611 (automatically added because the function returns an
2612 object marked with an ABI tag). However, it's also
2613 possible to see a marker in one of the function
2614 parameters, for example.
2616 string2 (lookup name):
2619 function(some_struct[abi:cxx11], int)
2621 and for completion LCD computation we want to say that
2623 function(some_struct, int)
2625 if (match_for_lcd
!= NULL
)
2627 while ((string1
= strstr (string1
, "[abi:")) != NULL
)
2629 const char *abi_start
= string1
;
2631 /* There can be more than one tag. */
2632 while (skip_abi_tag (&string1
) && *string1
== '[')
2635 if (abi_start
!= string1
)
2636 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2643 return (*string1
!= '\0' && *string1
!= '(');
2652 strncmp_iw (const char *string1
, const char *string2
, size_t string2_len
)
2654 return strncmp_iw_with_mode (string1
, string2
, string2_len
,
2655 strncmp_iw_mode::NORMAL
, language_minimal
);
2661 strcmp_iw (const char *string1
, const char *string2
)
2663 return strncmp_iw_with_mode (string1
, string2
, strlen (string2
),
2664 strncmp_iw_mode::MATCH_PARAMS
, language_minimal
);
2667 /* This is like strcmp except that it ignores whitespace and treats
2668 '(' as the first non-NULL character in terms of ordering. Like
2669 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2670 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2671 according to that ordering.
2673 If a list is sorted according to this function and if you want to
2674 find names in the list that match some fixed NAME according to
2675 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2676 where this function would put NAME.
2678 This function must be neutral to the CASE_SENSITIVITY setting as the user
2679 may choose it during later lookup. Therefore this function always sorts
2680 primarily case-insensitively and secondarily case-sensitively.
2682 Here are some examples of why using strcmp to sort is a bad idea:
2686 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2687 we try to do a search for "foo<char*>", strcmp will locate this
2688 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2689 will start looking at strings beginning with "goo", and will never
2690 see the correct match of "foo<char *>".
2692 Parenthesis example:
2694 In practice, this is less like to be an issue, but I'll give it a
2695 shot. Let's assume that '$' is a legitimate character to occur in
2696 symbols. (Which may well even be the case on some systems.) Then
2697 say that the partial symbol table contains "foo$" and "foo(int)".
2698 strcmp will put them in this order, since '$' < '('. Now, if the
2699 user searches for "foo", then strcmp will sort "foo" before "foo$".
2700 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2701 "foo") is false, so it won't proceed to the actual match of
2702 "foo(int)" with "foo". */
2705 strcmp_iw_ordered (const char *string1
, const char *string2
)
2707 const char *saved_string1
= string1
, *saved_string2
= string2
;
2708 enum case_sensitivity case_pass
= case_sensitive_off
;
2712 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2713 Provide stub characters if we are already at the end of one of the
2715 char c1
= 'X', c2
= 'X';
2717 while (*string1
!= '\0' && *string2
!= '\0')
2719 while (isspace (*string1
))
2721 while (isspace (*string2
))
2726 case case_sensitive_off
:
2727 c1
= tolower ((unsigned char) *string1
);
2728 c2
= tolower ((unsigned char) *string2
);
2730 case case_sensitive_on
:
2738 if (*string1
!= '\0')
2747 /* Characters are non-equal unless they're both '\0'; we want to
2748 make sure we get the comparison right according to our
2749 comparison in the cases where one of them is '\0' or '('. */
2751 if (*string2
== '\0')
2756 if (*string2
== '\0')
2761 if (*string2
== '\0' || *string2
== '(')
2770 if (case_pass
== case_sensitive_on
)
2773 /* Otherwise the strings were equal in case insensitive way, make
2774 a more fine grained comparison in a case sensitive way. */
2776 case_pass
= case_sensitive_on
;
2777 string1
= saved_string1
;
2778 string2
= saved_string2
;
2785 streq (const char *lhs
, const char *rhs
)
2787 return !strcmp (lhs
, rhs
);
2793 streq_hash (const void *lhs
, const void *rhs
)
2795 return streq ((const char *) lhs
, (const char *) rhs
);
2802 ** Answer whether string_to_compare is a full or partial match to
2803 ** template_string. The partial match must be in sequence starting
2807 subset_compare (const char *string_to_compare
, const char *template_string
)
2811 if (template_string
!= NULL
&& string_to_compare
!= NULL
2812 && strlen (string_to_compare
) <= strlen (template_string
))
2814 (startswith (template_string
, string_to_compare
));
2821 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2822 struct cmd_list_element
*c
, const char *value
)
2824 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2832 address_significant (gdbarch
*gdbarch
, CORE_ADDR addr
)
2834 /* Clear insignificant bits of a target address and sign extend resulting
2835 address, avoiding shifts larger or equal than the width of a CORE_ADDR.
2836 The local variable ADDR_BIT stops the compiler reporting a shift overflow
2837 when it won't occur. Skip updating of target address if current target
2838 has not set gdbarch significant_addr_bit. */
2839 int addr_bit
= gdbarch_significant_addr_bit (gdbarch
);
2841 if (addr_bit
&& (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
)))
2843 CORE_ADDR sign
= (CORE_ADDR
) 1 << (addr_bit
- 1);
2844 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2845 addr
= (addr
^ sign
) - sign
;
2852 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2854 /* Truncate address to the size of a target address, avoiding shifts
2855 larger or equal than the width of a CORE_ADDR. The local
2856 variable ADDR_BIT stops the compiler reporting a shift overflow
2857 when it won't occur. */
2858 /* NOTE: This assumes that the significant address information is
2859 kept in the least significant bits of ADDR - the upper bits were
2860 either zero or sign extended. Should gdbarch_address_to_pointer or
2861 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2863 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2865 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2866 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2867 return hex_string (addr
);
2870 /* This function is described in "defs.h". */
2873 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2875 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2877 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2878 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2880 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2881 that returns the language localized string formatted to a width
2882 based on gdbarch_addr_bit. */
2884 return hex_string_custom (address
, 8);
2886 return hex_string_custom (address
, 16);
2889 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2892 core_addr_hash (const void *ap
)
2894 const CORE_ADDR
*addrp
= (const CORE_ADDR
*) ap
;
2899 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2902 core_addr_eq (const void *ap
, const void *bp
)
2904 const CORE_ADDR
*addr_ap
= (const CORE_ADDR
*) ap
;
2905 const CORE_ADDR
*addr_bp
= (const CORE_ADDR
*) bp
;
2907 return *addr_ap
== *addr_bp
;
2910 /* Convert a string back into a CORE_ADDR. */
2912 string_to_core_addr (const char *my_string
)
2916 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2918 /* Assume that it is in hex. */
2921 for (i
= 2; my_string
[i
] != '\0'; i
++)
2923 if (isdigit (my_string
[i
]))
2924 addr
= (my_string
[i
] - '0') + (addr
* 16);
2925 else if (isxdigit (my_string
[i
]))
2926 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2928 error (_("invalid hex \"%s\""), my_string
);
2933 /* Assume that it is in decimal. */
2936 for (i
= 0; my_string
[i
] != '\0'; i
++)
2938 if (isdigit (my_string
[i
]))
2939 addr
= (my_string
[i
] - '0') + (addr
* 10);
2941 error (_("invalid decimal \"%s\""), my_string
);
2951 gdb_realpath_check_trailer (const char *input
, const char *trailer
)
2953 gdb::unique_xmalloc_ptr
<char> result
= gdb_realpath (input
);
2955 size_t len
= strlen (result
.get ());
2956 size_t trail_len
= strlen (trailer
);
2958 SELF_CHECK (len
>= trail_len
2959 && strcmp (result
.get () + len
- trail_len
, trailer
) == 0);
2963 gdb_realpath_tests ()
2965 /* A file which contains a directory prefix. */
2966 gdb_realpath_check_trailer ("./xfullpath.exp", "/xfullpath.exp");
2967 /* A file which contains a directory prefix. */
2968 gdb_realpath_check_trailer ("../../defs.h", "/defs.h");
2969 /* A one-character filename. */
2970 gdb_realpath_check_trailer ("./a", "/a");
2971 /* A file in the root directory. */
2972 gdb_realpath_check_trailer ("/root_file_which_should_exist",
2973 "/root_file_which_should_exist");
2974 /* A file which does not have a directory prefix. */
2975 gdb_realpath_check_trailer ("xfullpath.exp", "xfullpath.exp");
2976 /* A one-char filename without any directory prefix. */
2977 gdb_realpath_check_trailer ("a", "a");
2978 /* An empty filename. */
2979 gdb_realpath_check_trailer ("", "");
2982 #endif /* GDB_SELF_TEST */
2984 /* Allocation function for the libiberty hash table which uses an
2985 obstack. The obstack is passed as DATA. */
2988 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
2990 size_t total
= size
* count
;
2991 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
2993 memset (ptr
, 0, total
);
2997 /* Trivial deallocation function for the libiberty splay tree and hash
2998 table - don't deallocate anything. Rely on later deletion of the
2999 obstack. DATA will be the obstack, although it is not needed
3003 dummy_obstack_deallocate (void *object
, void *data
)
3008 /* Simple, portable version of dirname that does not modify its
3012 ldirname (const char *filename
)
3014 std::string dirname
;
3015 const char *base
= lbasename (filename
);
3017 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
3020 if (base
== filename
)
3023 dirname
= std::string (filename
, base
- filename
);
3025 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3026 create "d:./bar" later instead of the (different) "d:/bar". */
3027 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3028 && !IS_DIR_SEPARATOR (filename
[0]))
3029 dirname
[base
++ - filename
] = '.';
3037 gdb_argv::reset (const char *s
)
3039 char **argv
= buildargv (s
);
3041 if (s
!= NULL
&& argv
== NULL
)
3048 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3049 #define AMBIGUOUS_MESS2 \
3050 ".\nUse \"set gnutarget format-name\" to specify the format."
3053 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3057 /* Check if errmsg just need simple return. */
3058 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3059 return bfd_errmsg (error_tag
);
3061 std::string
ret (bfd_errmsg (error_tag
));
3062 ret
+= AMBIGUOUS_MESS1
;
3064 for (p
= matching
; *p
; p
++)
3069 ret
+= AMBIGUOUS_MESS2
;
3076 /* Return ARGS parsed as a valid pid, or throw an error. */
3079 parse_pid_to_attach (const char *args
)
3085 error_no_arg (_("process-id to attach"));
3087 dummy
= (char *) args
;
3088 pid
= strtoul (args
, &dummy
, 0);
3089 /* Some targets don't set errno on errors, grrr! */
3090 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3091 error (_("Illegal process-id: %s."), args
);
3096 /* Substitute all occurrences of string FROM by string TO in *STRINGP. *STRINGP
3097 must come from xrealloc-compatible allocator and it may be updated. FROM
3098 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3099 located at the start or end of *STRINGP. */
3102 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3104 char *string
= *stringp
, *s
;
3105 const size_t from_len
= strlen (from
);
3106 const size_t to_len
= strlen (to
);
3110 s
= strstr (s
, from
);
3114 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3115 || s
[-1] == DIRNAME_SEPARATOR
)
3116 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3117 || s
[from_len
] == DIRNAME_SEPARATOR
))
3122 = (char *) xrealloc (string
, (strlen (string
) + to_len
+ 1));
3124 /* Relocate the current S pointer. */
3125 s
= s
- string
+ string_new
;
3126 string
= string_new
;
3128 /* Replace from by to. */
3129 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3130 memcpy (s
, to
, to_len
);
3145 /* SIGALRM handler for waitpid_with_timeout. */
3148 sigalrm_handler (int signo
)
3150 /* Nothing to do. */
3155 /* Wrapper to wait for child PID to die with TIMEOUT.
3156 TIMEOUT is the time to stop waiting in seconds.
3157 If TIMEOUT is zero, pass WNOHANG to waitpid.
3158 Returns PID if it was successfully waited for, otherwise -1.
3160 Timeouts are currently implemented with alarm and SIGALRM.
3161 If the host does not support them, this waits "forever".
3162 It would be odd though for a host to have waitpid and not SIGALRM. */
3165 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3167 pid_t waitpid_result
;
3169 gdb_assert (pid
> 0);
3170 gdb_assert (timeout
>= 0);
3175 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3176 struct sigaction sa
, old_sa
;
3178 sa
.sa_handler
= sigalrm_handler
;
3179 sigemptyset (&sa
.sa_mask
);
3181 sigaction (SIGALRM
, &sa
, &old_sa
);
3185 ofunc
= signal (SIGALRM
, sigalrm_handler
);
3191 waitpid_result
= waitpid (pid
, status
, 0);
3195 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3196 sigaction (SIGALRM
, &old_sa
, NULL
);
3198 signal (SIGALRM
, ofunc
);
3203 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3205 if (waitpid_result
== pid
)
3211 #endif /* HAVE_WAITPID */
3213 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3214 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3216 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3217 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3220 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3222 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3224 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3225 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3227 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3229 char *pattern_slash
, *string_slash
;
3231 /* Replace '\' by '/' in both strings. */
3233 pattern_slash
= (char *) alloca (strlen (pattern
) + 1);
3234 strcpy (pattern_slash
, pattern
);
3235 pattern
= pattern_slash
;
3236 for (; *pattern_slash
!= 0; pattern_slash
++)
3237 if (IS_DIR_SEPARATOR (*pattern_slash
))
3238 *pattern_slash
= '/';
3240 string_slash
= (char *) alloca (strlen (string
) + 1);
3241 strcpy (string_slash
, string
);
3242 string
= string_slash
;
3243 for (; *string_slash
!= 0; string_slash
++)
3244 if (IS_DIR_SEPARATOR (*string_slash
))
3245 *string_slash
= '/';
3247 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3249 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3250 flags
|= FNM_CASEFOLD
;
3251 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3253 return fnmatch (pattern
, string
, flags
);
3256 /* Return the number of path elements in PATH.
3264 count_path_elements (const char *path
)
3267 const char *p
= path
;
3269 if (HAS_DRIVE_SPEC (p
))
3271 p
= STRIP_DRIVE_SPEC (p
);
3277 if (IS_DIR_SEPARATOR (*p
))
3282 /* Backup one if last character is /, unless it's the only one. */
3283 if (p
> path
+ 1 && IS_DIR_SEPARATOR (p
[-1]))
3286 /* Add one for the file name, if present. */
3287 if (p
> path
&& !IS_DIR_SEPARATOR (p
[-1]))
3293 /* Remove N leading path elements from PATH.
3294 N must be non-negative.
3295 If PATH has more than N path elements then return NULL.
3296 If PATH has exactly N path elements then return "".
3297 See count_path_elements for a description of how we do the counting. */
3300 strip_leading_path_elements (const char *path
, int n
)
3303 const char *p
= path
;
3305 gdb_assert (n
>= 0);
3310 if (HAS_DRIVE_SPEC (p
))
3312 p
= STRIP_DRIVE_SPEC (p
);
3318 while (*p
!= '\0' && !IS_DIR_SEPARATOR (*p
))
3336 copy_bitwise (gdb_byte
*dest
, ULONGEST dest_offset
,
3337 const gdb_byte
*source
, ULONGEST source_offset
,
3338 ULONGEST nbits
, int bits_big_endian
)
3340 unsigned int buf
, avail
;
3345 if (bits_big_endian
)
3347 /* Start from the end, then work backwards. */
3348 dest_offset
+= nbits
- 1;
3349 dest
+= dest_offset
/ 8;
3350 dest_offset
= 7 - dest_offset
% 8;
3351 source_offset
+= nbits
- 1;
3352 source
+= source_offset
/ 8;
3353 source_offset
= 7 - source_offset
% 8;
3357 dest
+= dest_offset
/ 8;
3359 source
+= source_offset
/ 8;
3363 /* Fill BUF with DEST_OFFSET bits from the destination and 8 -
3364 SOURCE_OFFSET bits from the source. */
3365 buf
= *(bits_big_endian
? source
-- : source
++) >> source_offset
;
3366 buf
<<= dest_offset
;
3367 buf
|= *dest
& ((1 << dest_offset
) - 1);
3369 /* NBITS: bits yet to be written; AVAIL: BUF's fill level. */
3370 nbits
+= dest_offset
;
3371 avail
= dest_offset
+ 8 - source_offset
;
3373 /* Flush 8 bits from BUF, if appropriate. */
3374 if (nbits
>= 8 && avail
>= 8)
3376 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3382 /* Copy the middle part. */
3385 size_t len
= nbits
/ 8;
3387 /* Use a faster method for byte-aligned copies. */
3390 if (bits_big_endian
)
3394 memcpy (dest
+ 1, source
+ 1, len
);
3398 memcpy (dest
, source
, len
);
3407 buf
|= *(bits_big_endian
? source
-- : source
++) << avail
;
3408 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3415 /* Write the last byte. */
3419 buf
|= *source
<< avail
;
3421 buf
&= (1 << nbits
) - 1;
3422 *dest
= (*dest
& (~0 << nbits
)) | buf
;
3427 _initialize_utils (void)
3429 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
3430 Set number of characters where GDB should wrap lines of its output."), _("\
3431 Show number of characters where GDB should wrap lines of its output."), _("\
3432 This affects where GDB wraps its output to fit the screen width.\n\
3433 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
3435 show_chars_per_line
,
3436 &setlist
, &showlist
);
3438 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
3439 Set number of lines in a page for GDB output pagination."), _("\
3440 Show number of lines in a page for GDB output pagination."), _("\
3441 This affects the number of lines after which GDB will pause\n\
3442 its output and ask you whether to continue.\n\
3443 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
3445 show_lines_per_page
,
3446 &setlist
, &showlist
);
3448 add_setshow_boolean_cmd ("pagination", class_support
,
3449 &pagination_enabled
, _("\
3450 Set state of GDB output pagination."), _("\
3451 Show state of GDB output pagination."), _("\
3452 When pagination is ON, GDB pauses at end of each screenful of\n\
3453 its output and asks you whether to continue.\n\
3454 Turning pagination off is an alternative to \"set height unlimited\"."),
3456 show_pagination_enabled
,
3457 &setlist
, &showlist
);
3459 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
3460 &sevenbit_strings
, _("\
3461 Set printing of 8-bit characters in strings as \\nnn."), _("\
3462 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
3464 show_sevenbit_strings
,
3465 &setprintlist
, &showprintlist
);
3467 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
3468 &debug_timestamp
, _("\
3469 Set timestamping of debugging messages."), _("\
3470 Show timestamping of debugging messages."), _("\
3471 When set, debugging messages will be marked with seconds and microseconds."),
3473 show_debug_timestamp
,
3474 &setdebuglist
, &showdebuglist
);
3476 add_internal_problem_command (&internal_error_problem
);
3477 add_internal_problem_command (&internal_warning_problem
);
3478 add_internal_problem_command (&demangler_warning_problem
);
3481 selftests::register_test ("gdb_realpath", gdb_realpath_tests
);