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
)
587 err
= safe_strerror (errno
);
588 return std::string (prefix
) + ": " + err
;
591 /* Print the system error message for errno, and also mention STRING
592 as the file name for which the error was encountered. Use ERRCODE
593 for the thrown exception. Then return to command level. */
596 throw_perror_with_name (enum errors errcode
, const char *string
)
598 std::string combined
= perror_string (string
);
600 /* I understand setting these is a matter of taste. Still, some people
601 may clear errno but not know about bfd_error. Doing this here is not
603 bfd_set_error (bfd_error_no_error
);
606 throw_error (errcode
, _("%s."), combined
.c_str ());
609 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
612 perror_with_name (const char *string
)
614 throw_perror_with_name (GENERIC_ERROR
, string
);
617 /* Same as perror_with_name except that it prints a warning instead
618 of throwing an error. */
621 perror_warning_with_name (const char *string
)
623 std::string combined
= perror_string (string
);
624 warning (_("%s"), combined
.c_str ());
627 /* Print the system error message for ERRCODE, and also mention STRING
628 as the file name for which the error was encountered. */
631 print_sys_errmsg (const char *string
, int errcode
)
636 err
= safe_strerror (errcode
);
637 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
638 strcpy (combined
, string
);
639 strcat (combined
, ": ");
640 strcat (combined
, err
);
642 /* We want anything which was printed on stdout to come out first, before
644 gdb_flush (gdb_stdout
);
645 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
648 /* Control C eventually causes this to be called, at a convenient time. */
653 if (sync_quit_force_run
)
655 sync_quit_force_run
= 0;
656 quit_force (NULL
, 0);
660 /* No steenking SIGINT will ever be coming our way when the
661 program is resumed. Don't lie. */
665 /* If there is no terminal switching for this target, then we can't
666 possibly get screwed by the lack of job control. */
667 || !target_supports_terminal_ours ())
670 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
679 if (sync_quit_force_run
)
686 /* Called when a memory allocation fails, with the number of bytes of
687 memory requested in SIZE. */
690 malloc_failure (long size
)
694 internal_error (__FILE__
, __LINE__
,
695 _("virtual memory exhausted: can't allocate %ld bytes."),
700 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
704 /* My replacement for the read system call.
705 Used like `read' but keeps going if `read' returns too soon. */
708 myread (int desc
, char *addr
, int len
)
715 val
= read (desc
, addr
, len
);
727 print_spaces (int n
, struct ui_file
*file
)
729 fputs_unfiltered (n_spaces (n
), file
);
732 /* Print a host address. */
735 gdb_print_host_address_1 (const void *addr
, struct ui_file
*stream
)
737 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
742 /* An RAII class that sets up to handle input and then tears down
743 during destruction. */
745 class scoped_input_handler
749 scoped_input_handler ()
750 : m_quit_handler (&quit_handler
, default_quit_handler
),
753 target_terminal::ours ();
754 ui_register_input_event_handler (current_ui
);
755 if (current_ui
->prompt_state
== PROMPT_BLOCKED
)
759 ~scoped_input_handler ()
762 ui_unregister_input_event_handler (m_ui
);
765 DISABLE_COPY_AND_ASSIGN (scoped_input_handler
);
769 /* Save and restore the terminal state. */
770 target_terminal::scoped_restore_terminal_state m_term_state
;
772 /* Save and restore the quit handler. */
773 scoped_restore_tmpl
<quit_handler_ftype
*> m_quit_handler
;
775 /* The saved UI, if non-NULL. */
781 /* This function supports the query, nquery, and yquery functions.
782 Ask user a y-or-n question and return 0 if answer is no, 1 if
783 answer is yes, or default the answer to the specified default
784 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
785 default answer, or '\0' for no default.
786 CTLSTR is the control string and should end in "? ". It should
787 not say how to answer, because we do that.
788 ARGS are the arguments passed along with the CTLSTR argument to
791 static int ATTRIBUTE_PRINTF (1, 0)
792 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
796 char def_answer
, not_def_answer
;
797 const char *y_string
, *n_string
;
799 /* Set up according to which answer is the default. */
804 not_def_answer
= 'N';
808 else if (defchar
== 'y')
812 not_def_answer
= 'N';
820 not_def_answer
= 'Y';
825 /* Automatically answer the default value if the user did not want
826 prompts or the command was issued with the server prefix. */
827 if (!confirm
|| server_command
)
830 /* If input isn't coming from the user directly, just say what
831 question we're asking, and then answer the default automatically. This
832 way, important error messages don't get lost when talking to GDB
834 if (current_ui
->instream
!= current_ui
->stdin_stream
835 || !input_interactive_p (current_ui
)
836 /* Restrict queries to the main UI. */
837 || current_ui
!= main_ui
)
839 target_terminal::scoped_restore_terminal_state term_state
;
840 target_terminal::ours_for_output ();
842 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
844 printf_filtered (_("(%s or %s) [answered %c; "
845 "input not from terminal]\n"),
846 y_string
, n_string
, def_answer
);
851 if (deprecated_query_hook
)
853 target_terminal::scoped_restore_terminal_state term_state
;
854 return deprecated_query_hook (ctlstr
, args
);
857 /* Format the question outside of the loop, to avoid reusing args. */
858 std::string question
= string_vprintf (ctlstr
, args
);
860 = string_printf (_("%s%s(%s or %s) %s"),
861 annotation_level
> 1 ? "\n\032\032pre-query\n" : "",
862 question
.c_str (), y_string
, n_string
,
863 annotation_level
> 1 ? "\n\032\032query\n" : "");
865 /* Used to add duration we waited for user to respond to
866 prompt_for_continue_wait_time. */
867 using namespace std::chrono
;
868 steady_clock::time_point prompt_started
= steady_clock::now ();
870 scoped_input_handler prepare_input
;
874 char *response
, answer
;
876 gdb_flush (gdb_stdout
);
877 response
= gdb_readline_wrapper (prompt
.c_str ());
879 if (response
== NULL
) /* C-d */
881 printf_filtered ("EOF [assumed %c]\n", def_answer
);
886 answer
= response
[0];
891 /* Check answer. For the non-default, the user must specify
892 the non-default explicitly. */
893 if (answer
== not_def_answer
)
898 /* Otherwise, if a default was specified, the user may either
899 specify the required input or have it default by entering
901 if (answer
== def_answer
902 || (defchar
!= '\0' && answer
== '\0'))
907 /* Invalid entries are not defaulted and require another selection. */
908 printf_filtered (_("Please answer %s or %s.\n"),
912 /* Add time spend in this routine to prompt_for_continue_wait_time. */
913 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
915 if (annotation_level
> 1)
916 printf_filtered (("\n\032\032post-query\n"));
921 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
922 answer is yes, or 0 if answer is defaulted.
923 Takes three args which are given to printf to print the question.
924 The first, a control string, should end in "? ".
925 It should not say how to answer, because we do that. */
928 nquery (const char *ctlstr
, ...)
933 va_start (args
, ctlstr
);
934 ret
= defaulted_query (ctlstr
, 'n', args
);
939 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
940 answer is yes, or 1 if answer is defaulted.
941 Takes three args which are given to printf to print the question.
942 The first, a control string, should end in "? ".
943 It should not say how to answer, because we do that. */
946 yquery (const char *ctlstr
, ...)
951 va_start (args
, ctlstr
);
952 ret
= defaulted_query (ctlstr
, 'y', args
);
957 /* Ask user a y-or-n question and return 1 iff answer is yes.
958 Takes three args which are given to printf to print the question.
959 The first, a control string, should end in "? ".
960 It should not say how to answer, because we do that. */
963 query (const char *ctlstr
, ...)
968 va_start (args
, ctlstr
);
969 ret
= defaulted_query (ctlstr
, '\0', args
);
974 /* A helper for parse_escape that converts a host character to a
975 target character. C is the host character. If conversion is
976 possible, then the target character is stored in *TARGET_C and the
977 function returns 1. Otherwise, the function returns 0. */
980 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
985 auto_obstack host_data
;
987 convert_between_encodings (target_charset (gdbarch
), host_charset (),
988 (gdb_byte
*) &the_char
, 1, 1,
989 &host_data
, translit_none
);
991 if (obstack_object_size (&host_data
) == 1)
994 *target_c
= *(char *) obstack_base (&host_data
);
1000 /* Parse a C escape sequence. STRING_PTR points to a variable
1001 containing a pointer to the string to parse. That pointer
1002 should point to the character after the \. That pointer
1003 is updated past the characters we use. The value of the
1004 escape sequence is returned.
1006 A negative value means the sequence \ newline was seen,
1007 which is supposed to be equivalent to nothing at all.
1009 If \ is followed by a null character, we return a negative
1010 value and leave the string pointer pointing at the null character.
1012 If \ is followed by 000, we return 0 and leave the string pointer
1013 after the zeros. A value of 0 does not mean end of string. */
1016 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1018 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1019 int c
= *(*string_ptr
)++;
1038 int i
= host_hex_value (c
);
1043 if (isdigit (c
) && c
!= '8' && c
!= '9')
1047 i
+= host_hex_value (c
);
1083 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1084 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1085 " which has no equivalent\nin the `%s' character set."),
1086 c
, c
, target_charset (gdbarch
));
1090 /* Print the character C on STREAM as part of the contents of a literal
1091 string whose delimiter is QUOTER. Note that this routine should only
1092 be called for printing things which are independent of the language
1093 of the program being debugged.
1095 printchar will normally escape backslashes and instances of QUOTER. If
1096 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1097 As a side effect, if you pass the backslash character as the QUOTER,
1098 printchar will escape backslashes as usual, but not any other quoting
1102 printchar (int c
, do_fputc_ftype do_fputc
, ui_file
*stream
, int quoter
)
1104 c
&= 0xFF; /* Avoid sign bit follies */
1106 if (c
< 0x20 || /* Low control chars */
1107 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1108 (sevenbit_strings
&& c
>= 0x80))
1109 { /* high order bit set */
1110 do_fputc ('\\', stream
);
1115 do_fputc ('n', stream
);
1118 do_fputc ('b', stream
);
1121 do_fputc ('t', stream
);
1124 do_fputc ('f', stream
);
1127 do_fputc ('r', stream
);
1130 do_fputc ('e', stream
);
1133 do_fputc ('a', stream
);
1137 do_fputc ('0' + ((c
>> 6) & 0x7), stream
);
1138 do_fputc ('0' + ((c
>> 3) & 0x7), stream
);
1139 do_fputc ('0' + ((c
>> 0) & 0x7), stream
);
1146 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1147 do_fputc ('\\', stream
);
1148 do_fputc (c
, stream
);
1152 /* Print the character C on STREAM as part of the contents of a
1153 literal string whose delimiter is QUOTER. Note that these routines
1154 should only be call for printing things which are independent of
1155 the language of the program being debugged. */
1158 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1161 printchar (*str
++, fputc_filtered
, stream
, quoter
);
1165 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1168 printchar (*str
++, fputc_unfiltered
, stream
, quoter
);
1172 fputstrn_filtered (const char *str
, int n
, int quoter
,
1173 struct ui_file
*stream
)
1175 for (int i
= 0; i
< n
; i
++)
1176 printchar (str
[i
], fputc_filtered
, stream
, quoter
);
1180 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1181 do_fputc_ftype do_fputc
, struct ui_file
*stream
)
1183 for (int i
= 0; i
< n
; i
++)
1184 printchar (str
[i
], do_fputc
, stream
, quoter
);
1188 /* Number of lines per page or UINT_MAX if paging is disabled. */
1189 static unsigned int lines_per_page
;
1191 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1192 struct cmd_list_element
*c
, const char *value
)
1194 fprintf_filtered (file
,
1195 _("Number of lines gdb thinks are in a page is %s.\n"),
1199 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1200 static unsigned int chars_per_line
;
1202 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1203 struct cmd_list_element
*c
, const char *value
)
1205 fprintf_filtered (file
,
1206 _("Number of characters gdb thinks "
1207 "are in a line is %s.\n"),
1211 /* Current count of lines printed on this page, chars on this line. */
1212 static unsigned int lines_printed
, chars_printed
;
1214 /* True if pagination is disabled for just one command. */
1216 static bool pagination_disabled_for_command
;
1218 /* Buffer and start column of buffered text, for doing smarter word-
1219 wrapping. When someone calls wrap_here(), we start buffering output
1220 that comes through fputs_filtered(). If we see a newline, we just
1221 spit it out and forget about the wrap_here(). If we see another
1222 wrap_here(), we spit it out and remember the newer one. If we see
1223 the end of the line, we spit out a newline, the indent, and then
1224 the buffered output. */
1226 static bool filter_initialized
= false;
1228 /* Contains characters which are waiting to be output (they have
1229 already been counted in chars_printed). */
1230 static std::string wrap_buffer
;
1232 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1234 static const char *wrap_indent
;
1236 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1237 is not in effect. */
1238 static int wrap_column
;
1240 /* The style applied at the time that wrap_here was called. */
1241 static ui_file_style wrap_style
;
1244 /* Initialize the number of lines per page and chars per line. */
1247 init_page_info (void)
1251 lines_per_page
= UINT_MAX
;
1252 chars_per_line
= UINT_MAX
;
1256 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1261 #if defined(__GO32__)
1262 rows
= ScreenRows ();
1263 cols
= ScreenCols ();
1264 lines_per_page
= rows
;
1265 chars_per_line
= cols
;
1267 /* Make sure Readline has initialized its terminal settings. */
1268 rl_reset_terminal (NULL
);
1270 /* Get the screen size from Readline. */
1271 rl_get_screen_size (&rows
, &cols
);
1272 lines_per_page
= rows
;
1273 chars_per_line
= cols
;
1275 /* Readline should have fetched the termcap entry for us.
1276 Only try to use tgetnum function if rl_get_screen_size
1277 did not return a useful value. */
1278 if (((rows
<= 0) && (tgetnum ((char *) "li") < 0))
1279 /* Also disable paging if inside Emacs. $EMACS was used
1280 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1281 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1283 /* The number of lines per page is not mentioned in the terminal
1284 description or EMACS evironment variable is set. This probably
1285 means that paging is not useful, so disable paging. */
1286 lines_per_page
= UINT_MAX
;
1289 /* If the output is not a terminal, don't paginate it. */
1290 if (!ui_file_isatty (gdb_stdout
))
1291 lines_per_page
= UINT_MAX
;
1295 /* We handle SIGWINCH ourselves. */
1296 rl_catch_sigwinch
= 0;
1302 /* Return nonzero if filtered printing is initialized. */
1304 filtered_printing_initialized (void)
1306 return filter_initialized
;
1309 set_batch_flag_and_restore_page_info::set_batch_flag_and_restore_page_info ()
1310 : m_save_lines_per_page (lines_per_page
),
1311 m_save_chars_per_line (chars_per_line
),
1312 m_save_batch_flag (batch_flag
)
1318 set_batch_flag_and_restore_page_info::~set_batch_flag_and_restore_page_info ()
1320 batch_flag
= m_save_batch_flag
;
1321 chars_per_line
= m_save_chars_per_line
;
1322 lines_per_page
= m_save_lines_per_page
;
1328 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1331 set_screen_size (void)
1333 int rows
= lines_per_page
;
1334 int cols
= chars_per_line
;
1336 /* If we get 0 or negative ROWS or COLS, treat as "infinite" size.
1337 A negative number can be seen here with the "set width/height"
1338 commands and either:
1340 - the user specified "unlimited", which maps to UINT_MAX, or
1341 - the user specified some number between INT_MAX and UINT_MAX.
1343 Cap "infinity" to approximately sqrt(INT_MAX) so that we don't
1344 overflow in rl_set_screen_size, which multiplies rows and columns
1345 to compute the number of characters on the screen. */
1347 const int sqrt_int_max
= INT_MAX
>> (sizeof (int) * 8 / 2);
1349 if (rows
<= 0 || rows
> sqrt_int_max
)
1351 rows
= sqrt_int_max
;
1352 lines_per_page
= UINT_MAX
;
1355 if (cols
<= 0 || cols
> sqrt_int_max
)
1357 cols
= sqrt_int_max
;
1358 chars_per_line
= UINT_MAX
;
1361 /* Update Readline's idea of the terminal size. */
1362 rl_set_screen_size (rows
, cols
);
1365 /* Reinitialize WRAP_BUFFER. */
1370 if (chars_per_line
== 0)
1373 wrap_buffer
.clear ();
1374 filter_initialized
= true;
1378 set_width_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1385 set_height_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1393 set_screen_width_and_height (int width
, int height
)
1395 lines_per_page
= height
;
1396 chars_per_line
= width
;
1402 /* The currently applied style. */
1404 static ui_file_style applied_style
;
1406 /* Emit an ANSI style escape for STYLE. If STREAM is nullptr, emit to
1407 the wrap buffer; otherwise emit to STREAM. */
1410 emit_style_escape (const ui_file_style
&style
,
1411 struct ui_file
*stream
= nullptr)
1413 applied_style
= style
;
1415 if (stream
== nullptr)
1416 wrap_buffer
.append (style
.to_ansi ());
1418 fputs_unfiltered (style
.to_ansi ().c_str (), stream
);
1421 /* Set the current output style. This will affect future uses of the
1422 _filtered output functions. */
1425 set_output_style (struct ui_file
*stream
, const ui_file_style
&style
)
1427 if (!stream
->can_emit_style_escape ())
1430 /* Note that we may not pass STREAM here, when we want to emit to
1431 the wrap buffer, not directly to STREAM. */
1432 if (stream
== gdb_stdout
)
1434 emit_style_escape (style
, stream
);
1440 reset_terminal_style (struct ui_file
*stream
)
1442 if (stream
->can_emit_style_escape ())
1444 /* Force the setting, regardless of what we think the setting
1445 might already be. */
1446 applied_style
= ui_file_style ();
1447 wrap_buffer
.append (applied_style
.to_ansi ());
1451 /* Wait, so the user can read what's on the screen. Prompt the user
1452 to continue by pressing RETURN. 'q' is also provided because
1453 telling users what to do in the prompt is more user-friendly than
1454 expecting them to think of Ctrl-C/SIGINT. */
1457 prompt_for_continue (void)
1459 char cont_prompt
[120];
1460 /* Used to add duration we waited for user to respond to
1461 prompt_for_continue_wait_time. */
1462 using namespace std::chrono
;
1463 steady_clock::time_point prompt_started
= steady_clock::now ();
1464 bool disable_pagination
= pagination_disabled_for_command
;
1466 /* Clear the current styling. */
1467 if (gdb_stdout
->can_emit_style_escape ())
1468 emit_style_escape (ui_file_style (), gdb_stdout
);
1470 if (annotation_level
> 1)
1471 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1473 strcpy (cont_prompt
,
1474 "--Type <RET> for more, q to quit, "
1475 "c to continue without paging--");
1476 if (annotation_level
> 1)
1477 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1479 /* We must do this *before* we call gdb_readline_wrapper, else it
1480 will eventually call us -- thinking that we're trying to print
1481 beyond the end of the screen. */
1482 reinitialize_more_filter ();
1484 scoped_input_handler prepare_input
;
1486 /* Call gdb_readline_wrapper, not readline, in order to keep an
1487 event loop running. */
1488 gdb::unique_xmalloc_ptr
<char> ignore (gdb_readline_wrapper (cont_prompt
));
1490 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1491 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1493 if (annotation_level
> 1)
1494 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1498 char *p
= ignore
.get ();
1500 while (*p
== ' ' || *p
== '\t')
1503 /* Do not call quit here; there is no possibility of SIGINT. */
1504 throw_quit ("Quit");
1506 disable_pagination
= true;
1509 /* Now we have to do this again, so that GDB will know that it doesn't
1510 need to save the ---Type <return>--- line at the top of the screen. */
1511 reinitialize_more_filter ();
1512 pagination_disabled_for_command
= disable_pagination
;
1514 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1517 /* Initialize timer to keep track of how long we waited for the user. */
1520 reset_prompt_for_continue_wait_time (void)
1522 using namespace std::chrono
;
1524 prompt_for_continue_wait_time
= steady_clock::duration::zero ();
1527 /* Fetch the cumulative time spent in prompt_for_continue. */
1529 std::chrono::steady_clock::duration
1530 get_prompt_for_continue_wait_time ()
1532 return prompt_for_continue_wait_time
;
1535 /* Reinitialize filter; ie. tell it to reset to original values. */
1538 reinitialize_more_filter (void)
1542 pagination_disabled_for_command
= false;
1545 /* Flush the wrap buffer to STREAM, if necessary. */
1548 flush_wrap_buffer (struct ui_file
*stream
)
1550 if (stream
== gdb_stdout
&& !wrap_buffer
.empty ())
1552 fputs_unfiltered (wrap_buffer
.c_str (), stream
);
1553 wrap_buffer
.clear ();
1557 /* Indicate that if the next sequence of characters overflows the line,
1558 a newline should be inserted here rather than when it hits the end.
1559 If INDENT is non-null, it is a string to be printed to indent the
1560 wrapped part on the next line. INDENT must remain accessible until
1561 the next call to wrap_here() or until a newline is printed through
1564 If the line is already overfull, we immediately print a newline and
1565 the indentation, and disable further wrapping.
1567 If we don't know the width of lines, but we know the page height,
1568 we must not wrap words, but should still keep track of newlines
1569 that were explicitly printed.
1571 INDENT should not contain tabs, as that will mess up the char count
1572 on the next line. FIXME.
1574 This routine is guaranteed to force out any output which has been
1575 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1576 used to force out output from the wrap_buffer. */
1579 wrap_here (const char *indent
)
1581 /* This should have been allocated, but be paranoid anyway. */
1582 if (!filter_initialized
)
1583 internal_error (__FILE__
, __LINE__
,
1584 _("failed internal consistency check"));
1586 flush_wrap_buffer (gdb_stdout
);
1587 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1591 else if (chars_printed
>= chars_per_line
)
1593 puts_filtered ("\n");
1595 puts_filtered (indent
);
1600 wrap_column
= chars_printed
;
1604 wrap_indent
= indent
;
1605 wrap_style
= applied_style
;
1609 /* Print input string to gdb_stdout, filtered, with wrap,
1610 arranging strings in columns of n chars. String can be
1611 right or left justified in the column. Never prints
1612 trailing spaces. String should never be longer than
1613 width. FIXME: this could be useful for the EXAMINE
1614 command, which currently doesn't tabulate very well. */
1617 puts_filtered_tabular (char *string
, int width
, int right
)
1623 gdb_assert (chars_per_line
> 0);
1624 if (chars_per_line
== UINT_MAX
)
1626 fputs_filtered (string
, gdb_stdout
);
1627 fputs_filtered ("\n", gdb_stdout
);
1631 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1632 fputs_filtered ("\n", gdb_stdout
);
1634 if (width
>= chars_per_line
)
1635 width
= chars_per_line
- 1;
1637 stringlen
= strlen (string
);
1639 if (chars_printed
> 0)
1640 spaces
= width
- (chars_printed
- 1) % width
- 1;
1642 spaces
+= width
- stringlen
;
1644 spacebuf
= (char *) alloca (spaces
+ 1);
1645 spacebuf
[spaces
] = '\0';
1647 spacebuf
[spaces
] = ' ';
1649 fputs_filtered (spacebuf
, gdb_stdout
);
1650 fputs_filtered (string
, gdb_stdout
);
1654 /* Ensure that whatever gets printed next, using the filtered output
1655 commands, starts at the beginning of the line. I.e. if there is
1656 any pending output for the current line, flush it and start a new
1657 line. Otherwise do nothing. */
1662 if (chars_printed
> 0)
1664 puts_filtered ("\n");
1669 /* Like fputs but if FILTER is true, pause after every screenful.
1671 Regardless of FILTER can wrap at points other than the final
1672 character of a line.
1674 Unlike fputs, fputs_maybe_filtered does not return a value.
1675 It is OK for LINEBUFFER to be NULL, in which case just don't print
1678 Note that a longjmp to top level may occur in this routine (only if
1679 FILTER is true) (since prompt_for_continue may do so) so this
1680 routine should not be called when cleanups are not in place. */
1683 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1686 const char *lineptr
;
1688 if (linebuffer
== 0)
1691 /* Don't do any filtering if it is disabled. */
1692 if (stream
!= gdb_stdout
1693 || !pagination_enabled
1694 || pagination_disabled_for_command
1696 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
1697 || top_level_interpreter () == NULL
1698 || top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
1700 flush_wrap_buffer (stream
);
1701 fputs_unfiltered (linebuffer
, stream
);
1706 = make_scope_exit ([&] ()
1708 wrap_buffer
.clear ();
1713 /* Go through and output each character. Show line extension
1714 when this is necessary; prompt user for new page when this is
1717 lineptr
= linebuffer
;
1720 /* Possible new page. Note that PAGINATION_DISABLED_FOR_COMMAND
1721 might be set during this loop, so we must continue to check
1723 if (filter
&& (lines_printed
>= lines_per_page
- 1)
1724 && !pagination_disabled_for_command
)
1725 prompt_for_continue ();
1727 while (*lineptr
&& *lineptr
!= '\n')
1731 /* Print a single line. */
1732 if (*lineptr
== '\t')
1734 wrap_buffer
.push_back ('\t');
1735 /* Shifting right by 3 produces the number of tab stops
1736 we have already passed, and then adding one and
1737 shifting left 3 advances to the next tab stop. */
1738 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
1741 else if (*lineptr
== '\033'
1742 && skip_ansi_escape (lineptr
, &skip_bytes
))
1744 wrap_buffer
.append (lineptr
, skip_bytes
);
1745 /* Note that we don't consider this a character, so we
1746 don't increment chars_printed here. */
1747 lineptr
+= skip_bytes
;
1751 wrap_buffer
.push_back (*lineptr
);
1756 if (chars_printed
>= chars_per_line
)
1758 unsigned int save_chars
= chars_printed
;
1760 /* If we change the style, below, we'll want to reset it
1761 before continuing to print. If there is no wrap
1762 column, then we'll only reset the style if the pager
1763 prompt is given; and to avoid emitting style
1764 sequences in the middle of a run of text, we track
1766 ui_file_style save_style
;
1767 bool did_paginate
= false;
1773 save_style
= wrap_style
;
1774 if (stream
->can_emit_style_escape ())
1775 emit_style_escape (ui_file_style (), stream
);
1776 /* If we aren't actually wrapping, don't output
1777 newline -- if chars_per_line is right, we
1778 probably just overflowed anyway; if it's wrong,
1779 let us keep going. */
1780 fputc_unfiltered ('\n', stream
);
1784 save_style
= applied_style
;
1785 flush_wrap_buffer (stream
);
1788 /* Possible new page. Note that
1789 PAGINATION_DISABLED_FOR_COMMAND might be set during
1790 this loop, so we must continue to check it here. */
1791 if (lines_printed
>= lines_per_page
- 1
1792 && !pagination_disabled_for_command
)
1794 prompt_for_continue ();
1795 did_paginate
= true;
1798 /* Now output indentation and wrapped string. */
1801 fputs_unfiltered (wrap_indent
, stream
);
1802 if (stream
->can_emit_style_escape ())
1803 emit_style_escape (save_style
, stream
);
1804 /* FIXME, this strlen is what prevents wrap_indent from
1805 containing tabs. However, if we recurse to print it
1806 and count its chars, we risk trouble if wrap_indent is
1807 longer than (the user settable) chars_per_line.
1808 Note also that this can set chars_printed > chars_per_line
1809 if we are printing a long string. */
1810 chars_printed
= strlen (wrap_indent
)
1811 + (save_chars
- wrap_column
);
1812 wrap_column
= 0; /* And disable fancy wrap */
1814 else if (did_paginate
&& stream
->can_emit_style_escape ())
1815 emit_style_escape (save_style
, stream
);
1819 if (*lineptr
== '\n')
1822 wrap_here ((char *) 0); /* Spit out chars, cancel
1825 fputc_unfiltered ('\n', stream
);
1830 buffer_clearer
.release ();
1834 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
1836 fputs_maybe_filtered (linebuffer
, stream
, 1);
1842 fputs_styled (const char *linebuffer
, const ui_file_style
&style
,
1843 struct ui_file
*stream
)
1845 /* This just makes it so we emit somewhat fewer escape
1847 if (style
.is_default ())
1848 fputs_maybe_filtered (linebuffer
, stream
, 1);
1851 set_output_style (stream
, style
);
1852 fputs_maybe_filtered (linebuffer
, stream
, 1);
1853 set_output_style (stream
, ui_file_style ());
1860 fputs_styled_unfiltered (const char *linebuffer
, const ui_file_style
&style
,
1861 struct ui_file
*stream
)
1863 /* This just makes it so we emit somewhat fewer escape
1865 if (style
.is_default ())
1866 fputs_maybe_filtered (linebuffer
, stream
, 0);
1869 set_output_style (stream
, style
);
1870 fputs_maybe_filtered (linebuffer
, stream
, 0);
1871 set_output_style (stream
, ui_file_style ());
1878 fputs_highlighted (const char *str
, const compiled_regex
&highlight
,
1879 struct ui_file
*stream
)
1883 while (*str
&& highlight
.exec (str
, 1, &pmatch
, 0) == 0)
1885 size_t n_highlight
= pmatch
.rm_eo
- pmatch
.rm_so
;
1887 /* Output the part before pmatch with current style. */
1888 while (pmatch
.rm_so
> 0)
1890 fputc_filtered (*str
, stream
);
1895 /* Output pmatch with the highlight style. */
1896 set_output_style (stream
, highlight_style
.style ());
1897 while (n_highlight
> 0)
1899 fputc_filtered (*str
, stream
);
1903 set_output_style (stream
, ui_file_style ());
1906 /* Output the trailing part of STR not matching HIGHLIGHT. */
1908 fputs_filtered (str
, stream
);
1912 putchar_unfiltered (int c
)
1916 ui_file_write (gdb_stdout
, &buf
, 1);
1920 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
1921 May return nonlocally. */
1924 putchar_filtered (int c
)
1926 return fputc_filtered (c
, gdb_stdout
);
1930 fputc_unfiltered (int c
, struct ui_file
*stream
)
1934 ui_file_write (stream
, &buf
, 1);
1939 fputc_filtered (int c
, struct ui_file
*stream
)
1945 fputs_filtered (buf
, stream
);
1949 /* puts_debug is like fputs_unfiltered, except it prints special
1950 characters in printable fashion. */
1953 puts_debug (char *prefix
, char *string
, char *suffix
)
1957 /* Print prefix and suffix after each line. */
1958 static int new_line
= 1;
1959 static int return_p
= 0;
1960 static const char *prev_prefix
= "";
1961 static const char *prev_suffix
= "";
1963 if (*string
== '\n')
1966 /* If the prefix is changing, print the previous suffix, a new line,
1967 and the new prefix. */
1968 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
1970 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
1971 fputs_unfiltered ("\n", gdb_stdlog
);
1972 fputs_unfiltered (prefix
, gdb_stdlog
);
1975 /* Print prefix if we printed a newline during the previous call. */
1979 fputs_unfiltered (prefix
, gdb_stdlog
);
1982 prev_prefix
= prefix
;
1983 prev_suffix
= suffix
;
1985 /* Output characters in a printable format. */
1986 while ((ch
= *string
++) != '\0')
1992 fputc_unfiltered (ch
, gdb_stdlog
);
1995 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
1999 fputs_unfiltered ("\\\\", gdb_stdlog
);
2002 fputs_unfiltered ("\\b", gdb_stdlog
);
2005 fputs_unfiltered ("\\f", gdb_stdlog
);
2009 fputs_unfiltered ("\\n", gdb_stdlog
);
2012 fputs_unfiltered ("\\r", gdb_stdlog
);
2015 fputs_unfiltered ("\\t", gdb_stdlog
);
2018 fputs_unfiltered ("\\v", gdb_stdlog
);
2022 return_p
= ch
== '\r';
2025 /* Print suffix if we printed a newline. */
2028 fputs_unfiltered (suffix
, gdb_stdlog
);
2029 fputs_unfiltered ("\n", gdb_stdlog
);
2034 /* Print a variable number of ARGS using format FORMAT. If this
2035 information is going to put the amount written (since the last call
2036 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2037 call prompt_for_continue to get the users permission to continue.
2039 Unlike fprintf, this function does not return a value.
2041 We implement three variants, vfprintf (takes a vararg list and stream),
2042 fprintf (takes a stream to write on), and printf (the usual).
2044 Note also that this may throw a quit (since prompt_for_continue may
2048 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2049 va_list args
, bool filter
, bool gdbfmt
)
2053 ui_out_flags flags
= disallow_ui_out_field
;
2055 flags
|= unfiltered_output
;
2056 cli_ui_out (stream
, flags
).vmessage (applied_style
, format
, args
);
2060 std::string str
= string_vprintf (format
, args
);
2061 fputs_maybe_filtered (str
.c_str (), stream
, filter
);
2067 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2069 vfprintf_maybe_filtered (stream
, format
, args
, true, true);
2073 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2075 if (debug_timestamp
&& stream
== gdb_stdlog
)
2077 using namespace std::chrono
;
2081 cli_ui_out (&sfile
, 0).vmessage (ui_file_style (), format
, args
);
2082 std::string linebuffer
= std::move (sfile
.string ());
2084 steady_clock::time_point now
= steady_clock::now ();
2085 seconds s
= duration_cast
<seconds
> (now
.time_since_epoch ());
2086 microseconds us
= duration_cast
<microseconds
> (now
.time_since_epoch () - s
);
2088 len
= linebuffer
.size ();
2089 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2091 std::string timestamp
= string_printf ("%ld.%06ld %s%s",
2094 linebuffer
.c_str (),
2095 need_nl
? "\n": "");
2096 fputs_unfiltered (timestamp
.c_str (), stream
);
2099 vfprintf_maybe_filtered (stream
, format
, args
, false, true);
2103 vprintf_filtered (const char *format
, va_list args
)
2105 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, true, false);
2109 vprintf_unfiltered (const char *format
, va_list args
)
2111 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2115 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2119 va_start (args
, format
);
2120 vfprintf_filtered (stream
, format
, args
);
2125 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2129 va_start (args
, format
);
2130 vfprintf_unfiltered (stream
, format
, args
);
2134 /* Like fprintf_filtered, but prints its result indented.
2135 Called as fprintfi_filtered (spaces, stream, format, ...); */
2138 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2143 va_start (args
, format
);
2144 print_spaces_filtered (spaces
, stream
);
2146 vfprintf_filtered (stream
, format
, args
);
2153 fprintf_styled (struct ui_file
*stream
, const ui_file_style
&style
,
2154 const char *format
, ...)
2158 set_output_style (stream
, style
);
2159 va_start (args
, format
);
2160 vfprintf_filtered (stream
, format
, args
);
2162 set_output_style (stream
, ui_file_style ());
2168 vfprintf_styled (struct ui_file
*stream
, const ui_file_style
&style
,
2169 const char *format
, va_list args
)
2171 set_output_style (stream
, style
);
2172 vfprintf_filtered (stream
, format
, args
);
2173 set_output_style (stream
, ui_file_style ());
2179 vfprintf_styled_no_gdbfmt (struct ui_file
*stream
, const ui_file_style
&style
,
2180 bool filter
, const char *format
, va_list args
)
2182 std::string str
= string_vprintf (format
, args
);
2185 if (!style
.is_default ())
2186 set_output_style (stream
, style
);
2187 fputs_maybe_filtered (str
.c_str (), stream
, filter
);
2188 if (!style
.is_default ())
2189 set_output_style (stream
, ui_file_style ());
2194 printf_filtered (const char *format
, ...)
2198 va_start (args
, format
);
2199 vfprintf_filtered (gdb_stdout
, format
, args
);
2205 printf_unfiltered (const char *format
, ...)
2209 va_start (args
, format
);
2210 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2214 /* Like printf_filtered, but prints it's result indented.
2215 Called as printfi_filtered (spaces, format, ...); */
2218 printfi_filtered (int spaces
, const char *format
, ...)
2222 va_start (args
, format
);
2223 print_spaces_filtered (spaces
, gdb_stdout
);
2224 vfprintf_filtered (gdb_stdout
, format
, args
);
2228 /* Easy -- but watch out!
2230 This routine is *not* a replacement for puts()! puts() appends a newline.
2231 This one doesn't, and had better not! */
2234 puts_filtered (const char *string
)
2236 fputs_filtered (string
, gdb_stdout
);
2240 puts_unfiltered (const char *string
)
2242 fputs_unfiltered (string
, gdb_stdout
);
2245 /* Return a pointer to N spaces and a null. The pointer is good
2246 until the next call to here. */
2251 static char *spaces
= 0;
2252 static int max_spaces
= -1;
2258 spaces
= (char *) xmalloc (n
+ 1);
2259 for (t
= spaces
+ n
; t
!= spaces
;)
2265 return spaces
+ max_spaces
- n
;
2268 /* Print N spaces. */
2270 print_spaces_filtered (int n
, struct ui_file
*stream
)
2272 fputs_filtered (n_spaces (n
), stream
);
2275 /* C++/ObjC demangler stuff. */
2277 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2278 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2279 If the name is not mangled, or the language for the name is unknown, or
2280 demangling is off, the name is printed in its "raw" form. */
2283 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2284 enum language lang
, int arg_mode
)
2290 /* If user wants to see raw output, no problem. */
2293 fputs_filtered (name
, stream
);
2297 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2298 fputs_filtered (demangled
? demangled
: name
, stream
);
2299 if (demangled
!= NULL
)
2307 /* True if CH is a character that can be part of a symbol name. I.e.,
2308 either a number, a letter, or a '_'. */
2311 valid_identifier_name_char (int ch
)
2313 return (isalnum (ch
) || ch
== '_');
2316 /* Skip to end of token, or to END, whatever comes first. Input is
2317 assumed to be a C++ operator name. */
2320 cp_skip_operator_token (const char *token
, const char *end
)
2322 const char *p
= token
;
2323 while (p
!= end
&& !isspace (*p
) && *p
!= '(')
2325 if (valid_identifier_name_char (*p
))
2327 while (p
!= end
&& valid_identifier_name_char (*p
))
2333 /* Note, ordered such that among ops that share a prefix,
2334 longer comes first. This is so that the loop below can
2335 bail on first match. */
2336 static const char *ops
[] =
2342 "-=", "--", "->", "-",
2351 "<<=", "<=", "<<", "<",
2352 ">>=", ">=", ">>", ">",
2356 for (const char *op
: ops
)
2358 size_t oplen
= strlen (op
);
2359 size_t lencmp
= std::min
<size_t> (oplen
, end
- p
);
2361 if (strncmp (p
, op
, lencmp
) == 0)
2364 /* Some unidentified character. Return it. */
2372 /* Advance STRING1/STRING2 past whitespace. */
2375 skip_ws (const char *&string1
, const char *&string2
, const char *end_str2
)
2377 while (isspace (*string1
))
2379 while (string2
< end_str2
&& isspace (*string2
))
2383 /* True if STRING points at the start of a C++ operator name. START
2384 is the start of the string that STRING points to, hence when
2385 reading backwards, we must not read any character before START. */
2388 cp_is_operator (const char *string
, const char *start
)
2390 return ((string
== start
2391 || !valid_identifier_name_char (string
[-1]))
2392 && strncmp (string
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
2393 && !valid_identifier_name_char (string
[CP_OPERATOR_LEN
]));
2396 /* If *NAME points at an ABI tag, skip it and return true. Otherwise
2397 leave *NAME unmodified and return false. (see GCC's abi_tag
2398 attribute), such names are demangled as e.g.,
2399 "function[abi:cxx11]()". */
2402 skip_abi_tag (const char **name
)
2404 const char *p
= *name
;
2406 if (startswith (p
, "[abi:"))
2410 while (valid_identifier_name_char (*p
))
2426 strncmp_iw_with_mode (const char *string1
, const char *string2
,
2427 size_t string2_len
, strncmp_iw_mode mode
,
2428 enum language language
,
2429 completion_match_for_lcd
*match_for_lcd
)
2431 const char *string1_start
= string1
;
2432 const char *end_str2
= string2
+ string2_len
;
2433 bool skip_spaces
= true;
2434 bool have_colon_op
= (language
== language_cplus
2435 || language
== language_rust
2436 || language
== language_fortran
);
2441 || ((isspace (*string1
) && !valid_identifier_name_char (*string2
))
2442 || (isspace (*string2
) && !valid_identifier_name_char (*string1
))))
2444 skip_ws (string1
, string2
, end_str2
);
2445 skip_spaces
= false;
2448 /* Skip [abi:cxx11] tags in the symbol name if the lookup name
2449 doesn't include them. E.g.:
2451 string1: function[abi:cxx1](int)
2454 string1: function[abi:cxx1](int)
2455 string2: function(int)
2457 string1: Struct[abi:cxx1]::function()
2458 string2: Struct::function()
2460 string1: function(Struct[abi:cxx1], int)
2461 string2: function(Struct, int)
2463 if (string2
== end_str2
2464 || (*string2
!= '[' && !valid_identifier_name_char (*string2
)))
2466 const char *abi_start
= string1
;
2468 /* There can be more than one tag. */
2469 while (*string1
== '[' && skip_abi_tag (&string1
))
2472 if (match_for_lcd
!= NULL
&& abi_start
!= string1
)
2473 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2475 while (isspace (*string1
))
2479 if (*string1
== '\0' || string2
== end_str2
)
2482 /* Handle the :: operator. */
2483 if (have_colon_op
&& string1
[0] == ':' && string1
[1] == ':')
2485 if (*string2
!= ':')
2491 if (string2
== end_str2
)
2494 if (*string2
!= ':')
2500 while (isspace (*string1
))
2502 while (string2
< end_str2
&& isspace (*string2
))
2507 /* Handle C++ user-defined operators. */
2508 else if (language
== language_cplus
2511 if (cp_is_operator (string1
, string1_start
))
2513 /* An operator name in STRING1. Check STRING2. */
2515 = std::min
<size_t> (CP_OPERATOR_LEN
, end_str2
- string2
);
2516 if (strncmp (string1
, string2
, cmplen
) != 0)
2522 if (string2
!= end_str2
)
2524 /* Check for "operatorX" in STRING2. */
2525 if (valid_identifier_name_char (*string2
))
2528 skip_ws (string1
, string2
, end_str2
);
2531 /* Handle operator(). */
2532 if (*string1
== '(')
2534 if (string2
== end_str2
)
2536 if (mode
== strncmp_iw_mode::NORMAL
)
2540 /* Don't break for the regular return at the
2541 bottom, because "operator" should not
2542 match "operator()", since this open
2543 parentheses is not the parameter list
2545 return *string1
!= '\0';
2549 if (*string1
!= *string2
)
2558 skip_ws (string1
, string2
, end_str2
);
2560 /* Skip to end of token, or to END, whatever comes
2562 const char *end_str1
= string1
+ strlen (string1
);
2563 const char *p1
= cp_skip_operator_token (string1
, end_str1
);
2564 const char *p2
= cp_skip_operator_token (string2
, end_str2
);
2566 cmplen
= std::min (p1
- string1
, p2
- string2
);
2569 if (strncmp (string1
, string2
, cmplen
) != 0)
2574 if (p1
- string1
!= p2
- string2
)
2576 if (strncmp (string1
, string2
, cmplen
) != 0)
2583 if (*string1
== '\0' || string2
== end_str2
)
2585 if (*string1
== '(' || *string2
== '(')
2593 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2595 if (case_sensitivity
== case_sensitive_off
2596 && (tolower ((unsigned char) *string1
)
2597 != tolower ((unsigned char) *string2
)))
2600 /* If we see any non-whitespace, non-identifier-name character
2601 (any of "()<>*&" etc.), then skip spaces the next time
2603 if (!isspace (*string1
) && !valid_identifier_name_char (*string1
))
2610 if (string2
== end_str2
)
2612 if (mode
== strncmp_iw_mode::NORMAL
)
2614 /* Strip abi tag markers from the matched symbol name.
2615 Usually the ABI marker will be found on function name
2616 (automatically added because the function returns an
2617 object marked with an ABI tag). However, it's also
2618 possible to see a marker in one of the function
2619 parameters, for example.
2621 string2 (lookup name):
2624 function(some_struct[abi:cxx11], int)
2626 and for completion LCD computation we want to say that
2628 function(some_struct, int)
2630 if (match_for_lcd
!= NULL
)
2632 while ((string1
= strstr (string1
, "[abi:")) != NULL
)
2634 const char *abi_start
= string1
;
2636 /* There can be more than one tag. */
2637 while (skip_abi_tag (&string1
) && *string1
== '[')
2640 if (abi_start
!= string1
)
2641 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2648 return (*string1
!= '\0' && *string1
!= '(');
2657 strncmp_iw (const char *string1
, const char *string2
, size_t string2_len
)
2659 return strncmp_iw_with_mode (string1
, string2
, string2_len
,
2660 strncmp_iw_mode::NORMAL
, language_minimal
);
2666 strcmp_iw (const char *string1
, const char *string2
)
2668 return strncmp_iw_with_mode (string1
, string2
, strlen (string2
),
2669 strncmp_iw_mode::MATCH_PARAMS
, language_minimal
);
2672 /* This is like strcmp except that it ignores whitespace and treats
2673 '(' as the first non-NULL character in terms of ordering. Like
2674 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2675 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2676 according to that ordering.
2678 If a list is sorted according to this function and if you want to
2679 find names in the list that match some fixed NAME according to
2680 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2681 where this function would put NAME.
2683 This function must be neutral to the CASE_SENSITIVITY setting as the user
2684 may choose it during later lookup. Therefore this function always sorts
2685 primarily case-insensitively and secondarily case-sensitively.
2687 Here are some examples of why using strcmp to sort is a bad idea:
2691 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2692 we try to do a search for "foo<char*>", strcmp will locate this
2693 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2694 will start looking at strings beginning with "goo", and will never
2695 see the correct match of "foo<char *>".
2697 Parenthesis example:
2699 In practice, this is less like to be an issue, but I'll give it a
2700 shot. Let's assume that '$' is a legitimate character to occur in
2701 symbols. (Which may well even be the case on some systems.) Then
2702 say that the partial symbol table contains "foo$" and "foo(int)".
2703 strcmp will put them in this order, since '$' < '('. Now, if the
2704 user searches for "foo", then strcmp will sort "foo" before "foo$".
2705 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2706 "foo") is false, so it won't proceed to the actual match of
2707 "foo(int)" with "foo". */
2710 strcmp_iw_ordered (const char *string1
, const char *string2
)
2712 const char *saved_string1
= string1
, *saved_string2
= string2
;
2713 enum case_sensitivity case_pass
= case_sensitive_off
;
2717 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2718 Provide stub characters if we are already at the end of one of the
2720 char c1
= 'X', c2
= 'X';
2722 while (*string1
!= '\0' && *string2
!= '\0')
2724 while (isspace (*string1
))
2726 while (isspace (*string2
))
2731 case case_sensitive_off
:
2732 c1
= tolower ((unsigned char) *string1
);
2733 c2
= tolower ((unsigned char) *string2
);
2735 case case_sensitive_on
:
2743 if (*string1
!= '\0')
2752 /* Characters are non-equal unless they're both '\0'; we want to
2753 make sure we get the comparison right according to our
2754 comparison in the cases where one of them is '\0' or '('. */
2756 if (*string2
== '\0')
2761 if (*string2
== '\0')
2766 if (*string2
== '\0' || *string2
== '(')
2775 if (case_pass
== case_sensitive_on
)
2778 /* Otherwise the strings were equal in case insensitive way, make
2779 a more fine grained comparison in a case sensitive way. */
2781 case_pass
= case_sensitive_on
;
2782 string1
= saved_string1
;
2783 string2
= saved_string2
;
2790 streq (const char *lhs
, const char *rhs
)
2792 return !strcmp (lhs
, rhs
);
2798 streq_hash (const void *lhs
, const void *rhs
)
2800 return streq ((const char *) lhs
, (const char *) rhs
);
2807 ** Answer whether string_to_compare is a full or partial match to
2808 ** template_string. The partial match must be in sequence starting
2812 subset_compare (const char *string_to_compare
, const char *template_string
)
2816 if (template_string
!= NULL
&& string_to_compare
!= NULL
2817 && strlen (string_to_compare
) <= strlen (template_string
))
2819 (startswith (template_string
, string_to_compare
));
2826 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2827 struct cmd_list_element
*c
, const char *value
)
2829 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2837 address_significant (gdbarch
*gdbarch
, CORE_ADDR addr
)
2839 /* Clear insignificant bits of a target address and sign extend resulting
2840 address, avoiding shifts larger or equal than the width of a CORE_ADDR.
2841 The local variable ADDR_BIT stops the compiler reporting a shift overflow
2842 when it won't occur. Skip updating of target address if current target
2843 has not set gdbarch significant_addr_bit. */
2844 int addr_bit
= gdbarch_significant_addr_bit (gdbarch
);
2846 if (addr_bit
&& (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
)))
2848 CORE_ADDR sign
= (CORE_ADDR
) 1 << (addr_bit
- 1);
2849 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2850 addr
= (addr
^ sign
) - sign
;
2857 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2859 /* Truncate address to the size of a target address, avoiding shifts
2860 larger or equal than the width of a CORE_ADDR. The local
2861 variable ADDR_BIT stops the compiler reporting a shift overflow
2862 when it won't occur. */
2863 /* NOTE: This assumes that the significant address information is
2864 kept in the least significant bits of ADDR - the upper bits were
2865 either zero or sign extended. Should gdbarch_address_to_pointer or
2866 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2868 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2870 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2871 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2872 return hex_string (addr
);
2875 /* This function is described in "defs.h". */
2878 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2880 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2882 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2883 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2885 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2886 that returns the language localized string formatted to a width
2887 based on gdbarch_addr_bit. */
2889 return hex_string_custom (address
, 8);
2891 return hex_string_custom (address
, 16);
2894 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2897 core_addr_hash (const void *ap
)
2899 const CORE_ADDR
*addrp
= (const CORE_ADDR
*) ap
;
2904 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2907 core_addr_eq (const void *ap
, const void *bp
)
2909 const CORE_ADDR
*addr_ap
= (const CORE_ADDR
*) ap
;
2910 const CORE_ADDR
*addr_bp
= (const CORE_ADDR
*) bp
;
2912 return *addr_ap
== *addr_bp
;
2915 /* Convert a string back into a CORE_ADDR. */
2917 string_to_core_addr (const char *my_string
)
2921 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2923 /* Assume that it is in hex. */
2926 for (i
= 2; my_string
[i
] != '\0'; i
++)
2928 if (isdigit (my_string
[i
]))
2929 addr
= (my_string
[i
] - '0') + (addr
* 16);
2930 else if (isxdigit (my_string
[i
]))
2931 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2933 error (_("invalid hex \"%s\""), my_string
);
2938 /* Assume that it is in decimal. */
2941 for (i
= 0; my_string
[i
] != '\0'; i
++)
2943 if (isdigit (my_string
[i
]))
2944 addr
= (my_string
[i
] - '0') + (addr
* 10);
2946 error (_("invalid decimal \"%s\""), my_string
);
2956 gdb_realpath_check_trailer (const char *input
, const char *trailer
)
2958 gdb::unique_xmalloc_ptr
<char> result
= gdb_realpath (input
);
2960 size_t len
= strlen (result
.get ());
2961 size_t trail_len
= strlen (trailer
);
2963 SELF_CHECK (len
>= trail_len
2964 && strcmp (result
.get () + len
- trail_len
, trailer
) == 0);
2968 gdb_realpath_tests ()
2970 /* A file which contains a directory prefix. */
2971 gdb_realpath_check_trailer ("./xfullpath.exp", "/xfullpath.exp");
2972 /* A file which contains a directory prefix. */
2973 gdb_realpath_check_trailer ("../../defs.h", "/defs.h");
2974 /* A one-character filename. */
2975 gdb_realpath_check_trailer ("./a", "/a");
2976 /* A file in the root directory. */
2977 gdb_realpath_check_trailer ("/root_file_which_should_exist",
2978 "/root_file_which_should_exist");
2979 /* A file which does not have a directory prefix. */
2980 gdb_realpath_check_trailer ("xfullpath.exp", "xfullpath.exp");
2981 /* A one-char filename without any directory prefix. */
2982 gdb_realpath_check_trailer ("a", "a");
2983 /* An empty filename. */
2984 gdb_realpath_check_trailer ("", "");
2987 #endif /* GDB_SELF_TEST */
2989 /* Allocation function for the libiberty hash table which uses an
2990 obstack. The obstack is passed as DATA. */
2993 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
2995 size_t total
= size
* count
;
2996 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
2998 memset (ptr
, 0, total
);
3002 /* Trivial deallocation function for the libiberty splay tree and hash
3003 table - don't deallocate anything. Rely on later deletion of the
3004 obstack. DATA will be the obstack, although it is not needed
3008 dummy_obstack_deallocate (void *object
, void *data
)
3013 /* Simple, portable version of dirname that does not modify its
3017 ldirname (const char *filename
)
3019 std::string dirname
;
3020 const char *base
= lbasename (filename
);
3022 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
3025 if (base
== filename
)
3028 dirname
= std::string (filename
, base
- filename
);
3030 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3031 create "d:./bar" later instead of the (different) "d:/bar". */
3032 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3033 && !IS_DIR_SEPARATOR (filename
[0]))
3034 dirname
[base
++ - filename
] = '.';
3042 gdb_argv::reset (const char *s
)
3044 char **argv
= buildargv (s
);
3046 if (s
!= NULL
&& argv
== NULL
)
3053 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3054 #define AMBIGUOUS_MESS2 \
3055 ".\nUse \"set gnutarget format-name\" to specify the format."
3058 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3062 /* Check if errmsg just need simple return. */
3063 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3064 return bfd_errmsg (error_tag
);
3066 std::string
ret (bfd_errmsg (error_tag
));
3067 ret
+= AMBIGUOUS_MESS1
;
3069 for (p
= matching
; *p
; p
++)
3074 ret
+= AMBIGUOUS_MESS2
;
3081 /* Return ARGS parsed as a valid pid, or throw an error. */
3084 parse_pid_to_attach (const char *args
)
3090 error_no_arg (_("process-id to attach"));
3092 dummy
= (char *) args
;
3093 pid
= strtoul (args
, &dummy
, 0);
3094 /* Some targets don't set errno on errors, grrr! */
3095 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3096 error (_("Illegal process-id: %s."), args
);
3101 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3102 must come from xrealloc-compatible allocator and it may be updated. FROM
3103 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3104 located at the start or end of *STRINGP. */
3107 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3109 char *string
= *stringp
, *s
;
3110 const size_t from_len
= strlen (from
);
3111 const size_t to_len
= strlen (to
);
3115 s
= strstr (s
, from
);
3119 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3120 || s
[-1] == DIRNAME_SEPARATOR
)
3121 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3122 || s
[from_len
] == DIRNAME_SEPARATOR
))
3127 = (char *) xrealloc (string
, (strlen (string
) + to_len
+ 1));
3129 /* Relocate the current S pointer. */
3130 s
= s
- string
+ string_new
;
3131 string
= string_new
;
3133 /* Replace from by to. */
3134 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3135 memcpy (s
, to
, to_len
);
3150 /* SIGALRM handler for waitpid_with_timeout. */
3153 sigalrm_handler (int signo
)
3155 /* Nothing to do. */
3160 /* Wrapper to wait for child PID to die with TIMEOUT.
3161 TIMEOUT is the time to stop waiting in seconds.
3162 If TIMEOUT is zero, pass WNOHANG to waitpid.
3163 Returns PID if it was successfully waited for, otherwise -1.
3165 Timeouts are currently implemented with alarm and SIGALRM.
3166 If the host does not support them, this waits "forever".
3167 It would be odd though for a host to have waitpid and not SIGALRM. */
3170 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3172 pid_t waitpid_result
;
3174 gdb_assert (pid
> 0);
3175 gdb_assert (timeout
>= 0);
3180 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3181 struct sigaction sa
, old_sa
;
3183 sa
.sa_handler
= sigalrm_handler
;
3184 sigemptyset (&sa
.sa_mask
);
3186 sigaction (SIGALRM
, &sa
, &old_sa
);
3190 ofunc
= signal (SIGALRM
, sigalrm_handler
);
3196 waitpid_result
= waitpid (pid
, status
, 0);
3200 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3201 sigaction (SIGALRM
, &old_sa
, NULL
);
3203 signal (SIGALRM
, ofunc
);
3208 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3210 if (waitpid_result
== pid
)
3216 #endif /* HAVE_WAITPID */
3218 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3219 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3221 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3222 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3225 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3227 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3229 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3230 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3232 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3234 char *pattern_slash
, *string_slash
;
3236 /* Replace '\' by '/' in both strings. */
3238 pattern_slash
= (char *) alloca (strlen (pattern
) + 1);
3239 strcpy (pattern_slash
, pattern
);
3240 pattern
= pattern_slash
;
3241 for (; *pattern_slash
!= 0; pattern_slash
++)
3242 if (IS_DIR_SEPARATOR (*pattern_slash
))
3243 *pattern_slash
= '/';
3245 string_slash
= (char *) alloca (strlen (string
) + 1);
3246 strcpy (string_slash
, string
);
3247 string
= string_slash
;
3248 for (; *string_slash
!= 0; string_slash
++)
3249 if (IS_DIR_SEPARATOR (*string_slash
))
3250 *string_slash
= '/';
3252 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3254 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3255 flags
|= FNM_CASEFOLD
;
3256 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3258 return fnmatch (pattern
, string
, flags
);
3261 /* Return the number of path elements in PATH.
3269 count_path_elements (const char *path
)
3272 const char *p
= path
;
3274 if (HAS_DRIVE_SPEC (p
))
3276 p
= STRIP_DRIVE_SPEC (p
);
3282 if (IS_DIR_SEPARATOR (*p
))
3287 /* Backup one if last character is /, unless it's the only one. */
3288 if (p
> path
+ 1 && IS_DIR_SEPARATOR (p
[-1]))
3291 /* Add one for the file name, if present. */
3292 if (p
> path
&& !IS_DIR_SEPARATOR (p
[-1]))
3298 /* Remove N leading path elements from PATH.
3299 N must be non-negative.
3300 If PATH has more than N path elements then return NULL.
3301 If PATH has exactly N path elements then return "".
3302 See count_path_elements for a description of how we do the counting. */
3305 strip_leading_path_elements (const char *path
, int n
)
3308 const char *p
= path
;
3310 gdb_assert (n
>= 0);
3315 if (HAS_DRIVE_SPEC (p
))
3317 p
= STRIP_DRIVE_SPEC (p
);
3323 while (*p
!= '\0' && !IS_DIR_SEPARATOR (*p
))
3341 copy_bitwise (gdb_byte
*dest
, ULONGEST dest_offset
,
3342 const gdb_byte
*source
, ULONGEST source_offset
,
3343 ULONGEST nbits
, int bits_big_endian
)
3345 unsigned int buf
, avail
;
3350 if (bits_big_endian
)
3352 /* Start from the end, then work backwards. */
3353 dest_offset
+= nbits
- 1;
3354 dest
+= dest_offset
/ 8;
3355 dest_offset
= 7 - dest_offset
% 8;
3356 source_offset
+= nbits
- 1;
3357 source
+= source_offset
/ 8;
3358 source_offset
= 7 - source_offset
% 8;
3362 dest
+= dest_offset
/ 8;
3364 source
+= source_offset
/ 8;
3368 /* Fill BUF with DEST_OFFSET bits from the destination and 8 -
3369 SOURCE_OFFSET bits from the source. */
3370 buf
= *(bits_big_endian
? source
-- : source
++) >> source_offset
;
3371 buf
<<= dest_offset
;
3372 buf
|= *dest
& ((1 << dest_offset
) - 1);
3374 /* NBITS: bits yet to be written; AVAIL: BUF's fill level. */
3375 nbits
+= dest_offset
;
3376 avail
= dest_offset
+ 8 - source_offset
;
3378 /* Flush 8 bits from BUF, if appropriate. */
3379 if (nbits
>= 8 && avail
>= 8)
3381 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3387 /* Copy the middle part. */
3390 size_t len
= nbits
/ 8;
3392 /* Use a faster method for byte-aligned copies. */
3395 if (bits_big_endian
)
3399 memcpy (dest
+ 1, source
+ 1, len
);
3403 memcpy (dest
, source
, len
);
3412 buf
|= *(bits_big_endian
? source
-- : source
++) << avail
;
3413 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3420 /* Write the last byte. */
3424 buf
|= *source
<< avail
;
3426 buf
&= (1 << nbits
) - 1;
3427 *dest
= (*dest
& (~0 << nbits
)) | buf
;
3432 _initialize_utils (void)
3434 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
3435 Set number of characters where GDB should wrap lines of its output."), _("\
3436 Show number of characters where GDB should wrap lines of its output."), _("\
3437 This affects where GDB wraps its output to fit the screen width.\n\
3438 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
3440 show_chars_per_line
,
3441 &setlist
, &showlist
);
3443 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
3444 Set number of lines in a page for GDB output pagination."), _("\
3445 Show number of lines in a page for GDB output pagination."), _("\
3446 This affects the number of lines after which GDB will pause\n\
3447 its output and ask you whether to continue.\n\
3448 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
3450 show_lines_per_page
,
3451 &setlist
, &showlist
);
3453 add_setshow_boolean_cmd ("pagination", class_support
,
3454 &pagination_enabled
, _("\
3455 Set state of GDB output pagination."), _("\
3456 Show state of GDB output pagination."), _("\
3457 When pagination is ON, GDB pauses at end of each screenful of\n\
3458 its output and asks you whether to continue.\n\
3459 Turning pagination off is an alternative to \"set height unlimited\"."),
3461 show_pagination_enabled
,
3462 &setlist
, &showlist
);
3464 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
3465 &sevenbit_strings
, _("\
3466 Set printing of 8-bit characters in strings as \\nnn."), _("\
3467 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
3469 show_sevenbit_strings
,
3470 &setprintlist
, &showprintlist
);
3472 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
3473 &debug_timestamp
, _("\
3474 Set timestamping of debugging messages."), _("\
3475 Show timestamping of debugging messages."), _("\
3476 When set, debugging messages will be marked with seconds and microseconds."),
3478 show_debug_timestamp
,
3479 &setdebuglist
, &showdebuglist
);
3481 add_internal_problem_command (&internal_error_problem
);
3482 add_internal_problem_command (&internal_warning_problem
);
3483 add_internal_problem_command (&demangler_warning_problem
);
3486 selftests::register_test ("gdb_realpath", gdb_realpath_tests
);