1 /* General utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2020 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include "gdbsupport/gdb_wait.h"
23 #include "event-top.h"
24 #include "gdbthread.h"
27 #ifdef HAVE_SYS_RESOURCE_H
28 #include <sys/resource.h>
29 #endif /* HAVE_SYS_RESOURCE_H */
32 #include "tui/tui.h" /* For tui_get_command_dimension. */
44 #include "gdb-demangle.h"
45 #include "expression.h"
49 #include "filenames.h"
51 #include "gdb_obstack.h"
57 #include "inferior.h" /* for signed_pointer_to_address */
59 #include "gdb_curses.h"
61 #include "readline/readline.h"
66 #include "gdb_regex.h"
67 #include "gdbsupport/job-control.h"
68 #include "gdbsupport/selftest.h"
69 #include "gdbsupport/gdb_optional.h"
70 #include "cp-support.h"
72 #include "gdbsupport/pathstuff.h"
73 #include "cli/cli-style.h"
74 #include "gdbsupport/scope-exit.h"
78 void (*deprecated_error_begin_hook
) (void);
80 /* Prototypes for local functions */
82 static void vfprintf_maybe_filtered (struct ui_file
*, const char *,
84 ATTRIBUTE_PRINTF (2, 0);
86 static void fputs_maybe_filtered (const char *, struct ui_file
*, int);
88 static void prompt_for_continue (void);
90 static void set_screen_size (void);
91 static void set_width (void);
93 /* Time spent in prompt_for_continue in the currently executing command
94 waiting for user to respond.
95 Initialized in make_command_stats_cleanup.
96 Modified in prompt_for_continue and defaulted_query.
97 Used in report_command_stats. */
99 static std::chrono::steady_clock::duration prompt_for_continue_wait_time
;
101 /* A flag indicating whether to timestamp debugging messages. */
103 static bool debug_timestamp
= false;
105 /* True means that strings with character values >0x7F should be printed
106 as octal escapes. False means just print the value (e.g. it's an
107 international character, and the terminal or window can cope.) */
109 bool sevenbit_strings
= false;
111 show_sevenbit_strings (struct ui_file
*file
, int from_tty
,
112 struct cmd_list_element
*c
, const char *value
)
114 fprintf_filtered (file
, _("Printing of 8-bit characters "
115 "in strings as \\nnn is %s.\n"),
119 /* String to be printed before warning messages, if any. */
121 const char *warning_pre_print
= "\nwarning: ";
123 bool pagination_enabled
= true;
125 show_pagination_enabled (struct ui_file
*file
, int from_tty
,
126 struct cmd_list_element
*c
, const char *value
)
128 fprintf_filtered (file
, _("State of pagination is %s.\n"), value
);
134 /* Print a warning message. The first argument STRING is the warning
135 message, used as an fprintf format string, the second is the
136 va_list of arguments for that string. A warning is unfiltered (not
137 paginated) so that the user does not need to page through each
138 screen full of warnings when there are lots of them. */
141 vwarning (const char *string
, va_list args
)
143 if (deprecated_warning_hook
)
144 (*deprecated_warning_hook
) (string
, args
);
147 gdb::optional
<target_terminal::scoped_restore_terminal_state
> term_state
;
148 if (target_supports_terminal_ours ())
150 term_state
.emplace ();
151 target_terminal::ours_for_output ();
153 if (filtered_printing_initialized ())
154 wrap_here (""); /* Force out any buffered output. */
155 gdb_flush (gdb_stdout
);
156 if (warning_pre_print
)
157 fputs_unfiltered (warning_pre_print
, gdb_stderr
);
158 vfprintf_unfiltered (gdb_stderr
, string
, args
);
159 fprintf_unfiltered (gdb_stderr
, "\n");
163 /* Print an error message and return to command level.
164 The first argument STRING is the error message, used as a fprintf string,
165 and the remaining args are passed as arguments to it. */
168 verror (const char *string
, va_list args
)
170 throw_verror (GENERIC_ERROR
, string
, args
);
174 error_stream (const string_file
&stream
)
176 error (("%s"), stream
.c_str ());
179 /* Emit a message and abort. */
181 static void ATTRIBUTE_NORETURN
182 abort_with_message (const char *msg
)
184 if (current_ui
== NULL
)
187 fputs_unfiltered (msg
, gdb_stderr
);
189 abort (); /* ARI: abort */
192 /* Dump core trying to increase the core soft limit to hard limit first. */
197 #ifdef HAVE_SETRLIMIT
198 struct rlimit rlim
= { (rlim_t
) RLIM_INFINITY
, (rlim_t
) RLIM_INFINITY
};
200 setrlimit (RLIMIT_CORE
, &rlim
);
201 #endif /* HAVE_SETRLIMIT */
203 abort (); /* ARI: abort */
206 /* Check whether GDB will be able to dump core using the dump_core
207 function. Returns zero if GDB cannot or should not dump core.
208 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
209 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
212 can_dump_core (enum resource_limit_kind limit_kind
)
214 #ifdef HAVE_GETRLIMIT
217 /* Be quiet and assume we can dump if an error is returned. */
218 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
224 if (rlim
.rlim_cur
== 0)
229 if (rlim
.rlim_max
== 0)
232 #endif /* HAVE_GETRLIMIT */
237 /* Print a warning that we cannot dump core. */
240 warn_cant_dump_core (const char *reason
)
242 fprintf_unfiltered (gdb_stderr
,
243 _("%s\nUnable to dump core, use `ulimit -c"
244 " unlimited' before executing GDB next time.\n"),
248 /* Check whether GDB will be able to dump core using the dump_core
249 function, and print a warning if we cannot. */
252 can_dump_core_warn (enum resource_limit_kind limit_kind
,
255 int core_dump_allowed
= can_dump_core (limit_kind
);
257 if (!core_dump_allowed
)
258 warn_cant_dump_core (reason
);
260 return core_dump_allowed
;
263 /* Allow the user to configure the debugger behavior with respect to
264 what to do when an internal problem is detected. */
266 const char internal_problem_ask
[] = "ask";
267 const char internal_problem_yes
[] = "yes";
268 const char internal_problem_no
[] = "no";
269 static const char *const internal_problem_modes
[] =
271 internal_problem_ask
,
272 internal_problem_yes
,
277 /* Print a message reporting an internal error/warning. Ask the user
278 if they want to continue, dump core, or just exit. Return
279 something to indicate a quit. */
281 struct internal_problem
284 int user_settable_should_quit
;
285 const char *should_quit
;
286 int user_settable_should_dump_core
;
287 const char *should_dump_core
;
290 /* Report a problem, internal to GDB, to the user. Once the problem
291 has been reported, and assuming GDB didn't quit, the caller can
292 either allow execution to resume or throw an error. */
294 static void ATTRIBUTE_PRINTF (4, 0)
295 internal_vproblem (struct internal_problem
*problem
,
296 const char *file
, int line
, const char *fmt
, va_list ap
)
303 /* Don't allow infinite error/warning recursion. */
305 static const char msg
[] = "Recursive internal problem.\n";
314 abort_with_message (msg
);
317 /* Newer GLIBC versions put the warn_unused_result attribute
318 on write, but this is one of those rare cases where
319 ignoring the return value is correct. Casting to (void)
320 does not fix this problem. This is the solution suggested
321 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
322 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
323 abort (); /* ARI: abort */
328 /* Create a string containing the full error/warning message. Need
329 to call query with this full string, as otherwize the reason
330 (error/warning) and question become separated. Format using a
331 style similar to a compiler error message. Include extra detail
332 so that the user knows that they are living on the edge. */
334 std::string msg
= string_vprintf (fmt
, ap
);
335 reason
= string_printf ("%s:%d: %s: %s\n"
336 "A problem internal to GDB has been detected,\n"
337 "further debugging may prove unreliable.",
338 file
, line
, problem
->name
, msg
.c_str ());
341 /* Fall back to abort_with_message if gdb_stderr is not set up. */
342 if (current_ui
== NULL
)
344 fputs (reason
.c_str (), stderr
);
345 abort_with_message ("\n");
348 /* Try to get the message out and at the start of a new line. */
349 gdb::optional
<target_terminal::scoped_restore_terminal_state
> term_state
;
350 if (target_supports_terminal_ours ())
352 term_state
.emplace ();
353 target_terminal::ours_for_output ();
355 if (filtered_printing_initialized ())
358 /* Emit the message unless query will emit it below. */
359 if (problem
->should_quit
!= internal_problem_ask
361 || !filtered_printing_initialized ())
362 fprintf_unfiltered (gdb_stderr
, "%s\n", reason
.c_str ());
364 if (problem
->should_quit
== internal_problem_ask
)
366 /* Default (yes/batch case) is to quit GDB. When in batch mode
367 this lessens the likelihood of GDB going into an infinite
369 if (!confirm
|| !filtered_printing_initialized ())
372 quit_p
= query (_("%s\nQuit this debugging session? "),
375 else if (problem
->should_quit
== internal_problem_yes
)
377 else if (problem
->should_quit
== internal_problem_no
)
380 internal_error (__FILE__
, __LINE__
, _("bad switch"));
382 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr
);
383 if (REPORT_BUGS_TO
[0])
384 fprintf_unfiltered (gdb_stderr
, _(" For instructions, see:\n%s."),
386 fputs_unfiltered ("\n\n", gdb_stderr
);
388 if (problem
->should_dump_core
== internal_problem_ask
)
390 if (!can_dump_core_warn (LIMIT_MAX
, reason
.c_str ()))
392 else if (!filtered_printing_initialized ())
396 /* Default (yes/batch case) is to dump core. This leaves a GDB
397 `dropping' so that it is easier to see that something went
399 dump_core_p
= query (_("%s\nCreate a core file of GDB? "),
403 else if (problem
->should_dump_core
== internal_problem_yes
)
404 dump_core_p
= can_dump_core_warn (LIMIT_MAX
, reason
.c_str ());
405 else if (problem
->should_dump_core
== internal_problem_no
)
408 internal_error (__FILE__
, __LINE__
, _("bad switch"));
421 #ifdef HAVE_WORKING_FORK
431 static struct internal_problem internal_error_problem
= {
432 "internal-error", 1, internal_problem_ask
, 1, internal_problem_ask
436 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
438 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
439 throw_quit (_("Command aborted."));
442 static struct internal_problem internal_warning_problem
= {
443 "internal-warning", 1, internal_problem_ask
, 1, internal_problem_ask
447 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
449 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
452 static struct internal_problem demangler_warning_problem
= {
453 "demangler-warning", 1, internal_problem_ask
, 0, internal_problem_no
457 demangler_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
459 internal_vproblem (&demangler_warning_problem
, file
, line
, fmt
, ap
);
463 demangler_warning (const char *file
, int line
, const char *string
, ...)
467 va_start (ap
, string
);
468 demangler_vwarning (file
, line
, string
, ap
);
472 /* 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 /* We want anything which was printed on stdout to come out first, before
634 gdb_flush (gdb_stdout
);
635 fprintf_unfiltered (gdb_stderr
, "%s: %s.\n", string
, err
);
638 /* Control C eventually causes this to be called, at a convenient time. */
643 if (sync_quit_force_run
)
645 sync_quit_force_run
= 0;
646 quit_force (NULL
, 0);
650 /* No steenking SIGINT will ever be coming our way when the
651 program is resumed. Don't lie. */
655 /* If there is no terminal switching for this target, then we can't
656 possibly get screwed by the lack of job control. */
657 || !target_supports_terminal_ours ())
660 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
669 if (sync_quit_force_run
)
676 /* Called when a memory allocation fails, with the number of bytes of
677 memory requested in SIZE. */
680 malloc_failure (long size
)
684 internal_error (__FILE__
, __LINE__
,
685 _("virtual memory exhausted: can't allocate %ld bytes."),
690 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
694 /* My replacement for the read system call.
695 Used like `read' but keeps going if `read' returns too soon. */
698 myread (int desc
, char *addr
, int len
)
705 val
= read (desc
, addr
, len
);
717 print_spaces (int n
, struct ui_file
*file
)
719 fputs_unfiltered (n_spaces (n
), file
);
722 /* Print a host address. */
725 gdb_print_host_address_1 (const void *addr
, struct ui_file
*stream
)
727 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
732 /* An RAII class that sets up to handle input and then tears down
733 during destruction. */
735 class scoped_input_handler
739 scoped_input_handler ()
740 : m_quit_handler (&quit_handler
, default_quit_handler
),
743 target_terminal::ours ();
744 ui_register_input_event_handler (current_ui
);
745 if (current_ui
->prompt_state
== PROMPT_BLOCKED
)
749 ~scoped_input_handler ()
752 ui_unregister_input_event_handler (m_ui
);
755 DISABLE_COPY_AND_ASSIGN (scoped_input_handler
);
759 /* Save and restore the terminal state. */
760 target_terminal::scoped_restore_terminal_state m_term_state
;
762 /* Save and restore the quit handler. */
763 scoped_restore_tmpl
<quit_handler_ftype
*> m_quit_handler
;
765 /* The saved UI, if non-NULL. */
771 /* This function supports the query, nquery, and yquery functions.
772 Ask user a y-or-n question and return 0 if answer is no, 1 if
773 answer is yes, or default the answer to the specified default
774 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
775 default answer, or '\0' for no default.
776 CTLSTR is the control string and should end in "? ". It should
777 not say how to answer, because we do that.
778 ARGS are the arguments passed along with the CTLSTR argument to
781 static int ATTRIBUTE_PRINTF (1, 0)
782 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
786 char def_answer
, not_def_answer
;
787 const char *y_string
, *n_string
;
789 /* Set up according to which answer is the default. */
794 not_def_answer
= 'N';
798 else if (defchar
== 'y')
802 not_def_answer
= 'N';
810 not_def_answer
= 'Y';
815 /* Automatically answer the default value if the user did not want
816 prompts or the command was issued with the server prefix. */
817 if (!confirm
|| server_command
)
820 /* If input isn't coming from the user directly, just say what
821 question we're asking, and then answer the default automatically. This
822 way, important error messages don't get lost when talking to GDB
824 if (current_ui
->instream
!= current_ui
->stdin_stream
825 || !input_interactive_p (current_ui
)
826 /* Restrict queries to the main UI. */
827 || current_ui
!= main_ui
)
829 target_terminal::scoped_restore_terminal_state term_state
;
830 target_terminal::ours_for_output ();
832 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
834 printf_filtered (_("(%s or %s) [answered %c; "
835 "input not from terminal]\n"),
836 y_string
, n_string
, def_answer
);
841 if (deprecated_query_hook
)
843 target_terminal::scoped_restore_terminal_state term_state
;
844 return deprecated_query_hook (ctlstr
, args
);
847 /* Format the question outside of the loop, to avoid reusing args. */
848 std::string question
= string_vprintf (ctlstr
, args
);
850 = string_printf (_("%s%s(%s or %s) %s"),
851 annotation_level
> 1 ? "\n\032\032pre-query\n" : "",
852 question
.c_str (), y_string
, n_string
,
853 annotation_level
> 1 ? "\n\032\032query\n" : "");
855 /* Used to add duration we waited for user to respond to
856 prompt_for_continue_wait_time. */
857 using namespace std::chrono
;
858 steady_clock::time_point prompt_started
= steady_clock::now ();
860 scoped_input_handler prepare_input
;
864 char *response
, answer
;
866 gdb_flush (gdb_stdout
);
867 response
= gdb_readline_wrapper (prompt
.c_str ());
869 if (response
== NULL
) /* C-d */
871 printf_filtered ("EOF [assumed %c]\n", def_answer
);
876 answer
= response
[0];
881 /* Check answer. For the non-default, the user must specify
882 the non-default explicitly. */
883 if (answer
== not_def_answer
)
888 /* Otherwise, if a default was specified, the user may either
889 specify the required input or have it default by entering
891 if (answer
== def_answer
892 || (defchar
!= '\0' && answer
== '\0'))
897 /* Invalid entries are not defaulted and require another selection. */
898 printf_filtered (_("Please answer %s or %s.\n"),
902 /* Add time spend in this routine to prompt_for_continue_wait_time. */
903 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
905 if (annotation_level
> 1)
906 printf_filtered (("\n\032\032post-query\n"));
911 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
912 answer is yes, or 0 if answer is defaulted.
913 Takes three args which are given to printf to print the question.
914 The first, a control string, should end in "? ".
915 It should not say how to answer, because we do that. */
918 nquery (const char *ctlstr
, ...)
923 va_start (args
, ctlstr
);
924 ret
= defaulted_query (ctlstr
, 'n', args
);
929 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
930 answer is yes, or 1 if answer is defaulted.
931 Takes three args which are given to printf to print the question.
932 The first, a control string, should end in "? ".
933 It should not say how to answer, because we do that. */
936 yquery (const char *ctlstr
, ...)
941 va_start (args
, ctlstr
);
942 ret
= defaulted_query (ctlstr
, 'y', args
);
947 /* Ask user a y-or-n question and return 1 iff answer is yes.
948 Takes three args which are given to printf to print the question.
949 The first, a control string, should end in "? ".
950 It should not say how to answer, because we do that. */
953 query (const char *ctlstr
, ...)
958 va_start (args
, ctlstr
);
959 ret
= defaulted_query (ctlstr
, '\0', args
);
964 /* A helper for parse_escape that converts a host character to a
965 target character. C is the host character. If conversion is
966 possible, then the target character is stored in *TARGET_C and the
967 function returns 1. Otherwise, the function returns 0. */
970 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
975 auto_obstack host_data
;
977 convert_between_encodings (target_charset (gdbarch
), host_charset (),
978 (gdb_byte
*) &the_char
, 1, 1,
979 &host_data
, translit_none
);
981 if (obstack_object_size (&host_data
) == 1)
984 *target_c
= *(char *) obstack_base (&host_data
);
990 /* Parse a C escape sequence. STRING_PTR points to a variable
991 containing a pointer to the string to parse. That pointer
992 should point to the character after the \. That pointer
993 is updated past the characters we use. The value of the
994 escape sequence is returned.
996 A negative value means the sequence \ newline was seen,
997 which is supposed to be equivalent to nothing at all.
999 If \ is followed by a null character, we return a negative
1000 value and leave the string pointer pointing at the null character.
1002 If \ is followed by 000, we return 0 and leave the string pointer
1003 after the zeros. A value of 0 does not mean end of string. */
1006 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1008 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1009 int c
= *(*string_ptr
)++;
1028 int i
= host_hex_value (c
);
1033 if (isdigit (c
) && c
!= '8' && c
!= '9')
1037 i
+= host_hex_value (c
);
1073 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1074 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1075 " which has no equivalent\nin the `%s' character set."),
1076 c
, c
, target_charset (gdbarch
));
1080 /* Print the character C on STREAM as part of the contents of a literal
1081 string whose delimiter is QUOTER. Note that this routine should only
1082 be called for printing things which are independent of the language
1083 of the program being debugged.
1085 printchar will normally escape backslashes and instances of QUOTER. If
1086 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1087 As a side effect, if you pass the backslash character as the QUOTER,
1088 printchar will escape backslashes as usual, but not any other quoting
1092 printchar (int c
, do_fputc_ftype do_fputc
, ui_file
*stream
, int quoter
)
1094 c
&= 0xFF; /* Avoid sign bit follies */
1096 if (c
< 0x20 || /* Low control chars */
1097 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1098 (sevenbit_strings
&& c
>= 0x80))
1099 { /* high order bit set */
1100 do_fputc ('\\', stream
);
1105 do_fputc ('n', stream
);
1108 do_fputc ('b', stream
);
1111 do_fputc ('t', stream
);
1114 do_fputc ('f', stream
);
1117 do_fputc ('r', stream
);
1120 do_fputc ('e', stream
);
1123 do_fputc ('a', stream
);
1127 do_fputc ('0' + ((c
>> 6) & 0x7), stream
);
1128 do_fputc ('0' + ((c
>> 3) & 0x7), stream
);
1129 do_fputc ('0' + ((c
>> 0) & 0x7), stream
);
1136 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1137 do_fputc ('\\', stream
);
1138 do_fputc (c
, stream
);
1142 /* Print the character C on STREAM as part of the contents of a
1143 literal string whose delimiter is QUOTER. Note that these routines
1144 should only be call for printing things which are independent of
1145 the language of the program being debugged. */
1148 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1151 printchar (*str
++, fputc_filtered
, stream
, quoter
);
1155 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1158 printchar (*str
++, fputc_unfiltered
, stream
, quoter
);
1162 fputstrn_filtered (const char *str
, int n
, int quoter
,
1163 struct ui_file
*stream
)
1165 for (int i
= 0; i
< n
; i
++)
1166 printchar (str
[i
], fputc_filtered
, stream
, quoter
);
1170 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1171 do_fputc_ftype do_fputc
, struct ui_file
*stream
)
1173 for (int i
= 0; i
< n
; i
++)
1174 printchar (str
[i
], do_fputc
, stream
, quoter
);
1178 /* Number of lines per page or UINT_MAX if paging is disabled. */
1179 static unsigned int lines_per_page
;
1181 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1182 struct cmd_list_element
*c
, const char *value
)
1184 fprintf_filtered (file
,
1185 _("Number of lines gdb thinks are in a page is %s.\n"),
1189 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1190 static unsigned int chars_per_line
;
1192 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1193 struct cmd_list_element
*c
, const char *value
)
1195 fprintf_filtered (file
,
1196 _("Number of characters gdb thinks "
1197 "are in a line is %s.\n"),
1201 /* Current count of lines printed on this page, chars on this line. */
1202 static unsigned int lines_printed
, chars_printed
;
1204 /* True if pagination is disabled for just one command. */
1206 static bool pagination_disabled_for_command
;
1208 /* Buffer and start column of buffered text, for doing smarter word-
1209 wrapping. When someone calls wrap_here(), we start buffering output
1210 that comes through fputs_filtered(). If we see a newline, we just
1211 spit it out and forget about the wrap_here(). If we see another
1212 wrap_here(), we spit it out and remember the newer one. If we see
1213 the end of the line, we spit out a newline, the indent, and then
1214 the buffered output. */
1216 static bool filter_initialized
= false;
1218 /* Contains characters which are waiting to be output (they have
1219 already been counted in chars_printed). */
1220 static std::string wrap_buffer
;
1222 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1224 static const char *wrap_indent
;
1226 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1227 is not in effect. */
1228 static int wrap_column
;
1230 /* The style applied at the time that wrap_here was called. */
1231 static ui_file_style wrap_style
;
1234 /* Initialize the number of lines per page and chars per line. */
1237 init_page_info (void)
1241 lines_per_page
= UINT_MAX
;
1242 chars_per_line
= UINT_MAX
;
1246 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1251 #if defined(__GO32__)
1252 rows
= ScreenRows ();
1253 cols
= ScreenCols ();
1254 lines_per_page
= rows
;
1255 chars_per_line
= cols
;
1257 /* Make sure Readline has initialized its terminal settings. */
1258 rl_reset_terminal (NULL
);
1260 /* Get the screen size from Readline. */
1261 rl_get_screen_size (&rows
, &cols
);
1262 lines_per_page
= rows
;
1263 chars_per_line
= cols
;
1265 /* Readline should have fetched the termcap entry for us.
1266 Only try to use tgetnum function if rl_get_screen_size
1267 did not return a useful value. */
1268 if (((rows
<= 0) && (tgetnum ((char *) "li") < 0))
1269 /* Also disable paging if inside Emacs. $EMACS was used
1270 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1271 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1273 /* The number of lines per page is not mentioned in the terminal
1274 description or EMACS environment variable is set. This probably
1275 means that paging is not useful, so disable paging. */
1276 lines_per_page
= UINT_MAX
;
1279 /* If the output is not a terminal, don't paginate it. */
1280 if (!ui_file_isatty (gdb_stdout
))
1281 lines_per_page
= UINT_MAX
;
1285 /* We handle SIGWINCH ourselves. */
1286 rl_catch_sigwinch
= 0;
1292 /* Return nonzero if filtered printing is initialized. */
1294 filtered_printing_initialized (void)
1296 return filter_initialized
;
1299 set_batch_flag_and_restore_page_info::set_batch_flag_and_restore_page_info ()
1300 : m_save_lines_per_page (lines_per_page
),
1301 m_save_chars_per_line (chars_per_line
),
1302 m_save_batch_flag (batch_flag
)
1308 set_batch_flag_and_restore_page_info::~set_batch_flag_and_restore_page_info ()
1310 batch_flag
= m_save_batch_flag
;
1311 chars_per_line
= m_save_chars_per_line
;
1312 lines_per_page
= m_save_lines_per_page
;
1318 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1321 set_screen_size (void)
1323 int rows
= lines_per_page
;
1324 int cols
= chars_per_line
;
1326 /* If we get 0 or negative ROWS or COLS, treat as "infinite" size.
1327 A negative number can be seen here with the "set width/height"
1328 commands and either:
1330 - the user specified "unlimited", which maps to UINT_MAX, or
1331 - the user specified some number between INT_MAX and UINT_MAX.
1333 Cap "infinity" to approximately sqrt(INT_MAX) so that we don't
1334 overflow in rl_set_screen_size, which multiplies rows and columns
1335 to compute the number of characters on the screen. */
1337 const int sqrt_int_max
= INT_MAX
>> (sizeof (int) * 8 / 2);
1339 if (rows
<= 0 || rows
> sqrt_int_max
)
1341 rows
= sqrt_int_max
;
1342 lines_per_page
= UINT_MAX
;
1345 if (cols
<= 0 || cols
> sqrt_int_max
)
1347 cols
= sqrt_int_max
;
1348 chars_per_line
= UINT_MAX
;
1351 /* Update Readline's idea of the terminal size. */
1352 rl_set_screen_size (rows
, cols
);
1355 /* Reinitialize WRAP_BUFFER. */
1360 if (chars_per_line
== 0)
1363 wrap_buffer
.clear ();
1364 filter_initialized
= true;
1368 set_width_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1375 set_height_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1383 set_screen_width_and_height (int width
, int height
)
1385 lines_per_page
= height
;
1386 chars_per_line
= width
;
1392 /* The currently applied style. */
1394 static ui_file_style applied_style
;
1396 /* Emit an ANSI style escape for STYLE. If STREAM is nullptr, emit to
1397 the wrap buffer; otherwise emit to STREAM. */
1400 emit_style_escape (const ui_file_style
&style
,
1401 struct ui_file
*stream
= nullptr)
1403 applied_style
= style
;
1405 if (stream
== nullptr)
1406 wrap_buffer
.append (style
.to_ansi ());
1408 fputs_unfiltered (style
.to_ansi ().c_str (), stream
);
1411 /* Set the current output style. This will affect future uses of the
1412 _filtered output functions. */
1415 set_output_style (struct ui_file
*stream
, const ui_file_style
&style
)
1417 if (!stream
->can_emit_style_escape ())
1420 /* Note that we may not pass STREAM here, when we want to emit to
1421 the wrap buffer, not directly to STREAM. */
1422 if (stream
== gdb_stdout
)
1424 emit_style_escape (style
, stream
);
1430 reset_terminal_style (struct ui_file
*stream
)
1432 if (stream
->can_emit_style_escape ())
1434 /* Force the setting, regardless of what we think the setting
1435 might already be. */
1436 applied_style
= ui_file_style ();
1437 wrap_buffer
.append (applied_style
.to_ansi ());
1441 /* Wait, so the user can read what's on the screen. Prompt the user
1442 to continue by pressing RETURN. 'q' is also provided because
1443 telling users what to do in the prompt is more user-friendly than
1444 expecting them to think of Ctrl-C/SIGINT. */
1447 prompt_for_continue (void)
1449 char cont_prompt
[120];
1450 /* Used to add duration we waited for user to respond to
1451 prompt_for_continue_wait_time. */
1452 using namespace std::chrono
;
1453 steady_clock::time_point prompt_started
= steady_clock::now ();
1454 bool disable_pagination
= pagination_disabled_for_command
;
1456 /* Clear the current styling. */
1457 if (gdb_stdout
->can_emit_style_escape ())
1458 emit_style_escape (ui_file_style (), gdb_stdout
);
1460 if (annotation_level
> 1)
1461 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1463 strcpy (cont_prompt
,
1464 "--Type <RET> for more, q to quit, "
1465 "c to continue without paging--");
1466 if (annotation_level
> 1)
1467 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1469 /* We must do this *before* we call gdb_readline_wrapper, else it
1470 will eventually call us -- thinking that we're trying to print
1471 beyond the end of the screen. */
1472 reinitialize_more_filter ();
1474 scoped_input_handler prepare_input
;
1476 /* Call gdb_readline_wrapper, not readline, in order to keep an
1477 event loop running. */
1478 gdb::unique_xmalloc_ptr
<char> ignore (gdb_readline_wrapper (cont_prompt
));
1480 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1481 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1483 if (annotation_level
> 1)
1484 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1488 char *p
= ignore
.get ();
1490 while (*p
== ' ' || *p
== '\t')
1493 /* Do not call quit here; there is no possibility of SIGINT. */
1494 throw_quit ("Quit");
1496 disable_pagination
= true;
1499 /* Now we have to do this again, so that GDB will know that it doesn't
1500 need to save the ---Type <return>--- line at the top of the screen. */
1501 reinitialize_more_filter ();
1502 pagination_disabled_for_command
= disable_pagination
;
1504 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1507 /* Initialize timer to keep track of how long we waited for the user. */
1510 reset_prompt_for_continue_wait_time (void)
1512 using namespace std::chrono
;
1514 prompt_for_continue_wait_time
= steady_clock::duration::zero ();
1517 /* Fetch the cumulative time spent in prompt_for_continue. */
1519 std::chrono::steady_clock::duration
1520 get_prompt_for_continue_wait_time ()
1522 return prompt_for_continue_wait_time
;
1525 /* Reinitialize filter; ie. tell it to reset to original values. */
1528 reinitialize_more_filter (void)
1532 pagination_disabled_for_command
= false;
1535 /* Flush the wrap buffer to STREAM, if necessary. */
1538 flush_wrap_buffer (struct ui_file
*stream
)
1540 if (stream
== gdb_stdout
&& !wrap_buffer
.empty ())
1542 fputs_unfiltered (wrap_buffer
.c_str (), stream
);
1543 wrap_buffer
.clear ();
1550 gdb_flush (struct ui_file
*stream
)
1552 flush_wrap_buffer (stream
);
1553 ui_file_flush (stream
);
1556 /* Indicate that if the next sequence of characters overflows the line,
1557 a newline should be inserted here rather than when it hits the end.
1558 If INDENT is non-null, it is a string to be printed to indent the
1559 wrapped part on the next line. INDENT must remain accessible until
1560 the next call to wrap_here() or until a newline is printed through
1563 If the line is already overfull, we immediately print a newline and
1564 the indentation, and disable further wrapping.
1566 If we don't know the width of lines, but we know the page height,
1567 we must not wrap words, but should still keep track of newlines
1568 that were explicitly printed.
1570 INDENT should not contain tabs, as that will mess up the char count
1571 on the next line. FIXME.
1573 This routine is guaranteed to force out any output which has been
1574 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1575 used to force out output from the wrap_buffer. */
1578 wrap_here (const char *indent
)
1580 /* This should have been allocated, but be paranoid anyway. */
1581 if (!filter_initialized
)
1582 internal_error (__FILE__
, __LINE__
,
1583 _("failed internal consistency check"));
1585 flush_wrap_buffer (gdb_stdout
);
1586 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1590 else if (chars_printed
>= chars_per_line
)
1592 puts_filtered ("\n");
1594 puts_filtered (indent
);
1599 wrap_column
= chars_printed
;
1603 wrap_indent
= indent
;
1604 wrap_style
= applied_style
;
1608 /* Print input string to gdb_stdout, filtered, with wrap,
1609 arranging strings in columns of n chars. String can be
1610 right or left justified in the column. Never prints
1611 trailing spaces. String should never be longer than
1612 width. FIXME: this could be useful for the EXAMINE
1613 command, which currently doesn't tabulate very well. */
1616 puts_filtered_tabular (char *string
, int width
, int right
)
1622 gdb_assert (chars_per_line
> 0);
1623 if (chars_per_line
== UINT_MAX
)
1625 fputs_filtered (string
, gdb_stdout
);
1626 fputs_filtered ("\n", gdb_stdout
);
1630 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1631 fputs_filtered ("\n", gdb_stdout
);
1633 if (width
>= chars_per_line
)
1634 width
= chars_per_line
- 1;
1636 stringlen
= strlen (string
);
1638 if (chars_printed
> 0)
1639 spaces
= width
- (chars_printed
- 1) % width
- 1;
1641 spaces
+= width
- stringlen
;
1643 spacebuf
= (char *) alloca (spaces
+ 1);
1644 spacebuf
[spaces
] = '\0';
1646 spacebuf
[spaces
] = ' ';
1648 fputs_filtered (spacebuf
, gdb_stdout
);
1649 fputs_filtered (string
, gdb_stdout
);
1653 /* Ensure that whatever gets printed next, using the filtered output
1654 commands, starts at the beginning of the line. I.e. if there is
1655 any pending output for the current line, flush it and start a new
1656 line. Otherwise do nothing. */
1661 if (chars_printed
> 0)
1663 puts_filtered ("\n");
1668 /* Like fputs but if FILTER is true, pause after every screenful.
1670 Regardless of FILTER can wrap at points other than the final
1671 character of a line.
1673 Unlike fputs, fputs_maybe_filtered does not return a value.
1674 It is OK for LINEBUFFER to be NULL, in which case just don't print
1677 Note that a longjmp to top level may occur in this routine (only if
1678 FILTER is true) (since prompt_for_continue may do so) so this
1679 routine should not be called when cleanups are not in place. */
1682 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1685 const char *lineptr
;
1687 if (linebuffer
== 0)
1690 /* Don't do any filtering if it is disabled. */
1691 if (stream
!= gdb_stdout
1692 || !pagination_enabled
1693 || pagination_disabled_for_command
1695 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
1696 || top_level_interpreter () == NULL
1697 || top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
1699 flush_wrap_buffer (stream
);
1700 fputs_unfiltered (linebuffer
, stream
);
1705 = make_scope_exit ([&] ()
1707 wrap_buffer
.clear ();
1712 /* Go through and output each character. Show line extension
1713 when this is necessary; prompt user for new page when this is
1716 lineptr
= linebuffer
;
1719 /* Possible new page. Note that PAGINATION_DISABLED_FOR_COMMAND
1720 might be set during this loop, so we must continue to check
1722 if (filter
&& (lines_printed
>= lines_per_page
- 1)
1723 && !pagination_disabled_for_command
)
1724 prompt_for_continue ();
1726 while (*lineptr
&& *lineptr
!= '\n')
1730 /* Print a single line. */
1731 if (*lineptr
== '\t')
1733 wrap_buffer
.push_back ('\t');
1734 /* Shifting right by 3 produces the number of tab stops
1735 we have already passed, and then adding one and
1736 shifting left 3 advances to the next tab stop. */
1737 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
1740 else if (*lineptr
== '\033'
1741 && skip_ansi_escape (lineptr
, &skip_bytes
))
1743 wrap_buffer
.append (lineptr
, skip_bytes
);
1744 /* Note that we don't consider this a character, so we
1745 don't increment chars_printed here. */
1746 lineptr
+= skip_bytes
;
1750 wrap_buffer
.push_back (*lineptr
);
1755 if (chars_printed
>= chars_per_line
)
1757 unsigned int save_chars
= chars_printed
;
1759 /* If we change the style, below, we'll want to reset it
1760 before continuing to print. If there is no wrap
1761 column, then we'll only reset the style if the pager
1762 prompt is given; and to avoid emitting style
1763 sequences in the middle of a run of text, we track
1765 ui_file_style save_style
;
1766 bool did_paginate
= false;
1772 save_style
= wrap_style
;
1773 if (stream
->can_emit_style_escape ())
1774 emit_style_escape (ui_file_style (), stream
);
1775 /* If we aren't actually wrapping, don't output
1776 newline -- if chars_per_line is right, we
1777 probably just overflowed anyway; if it's wrong,
1778 let us keep going. */
1779 fputc_unfiltered ('\n', stream
);
1783 save_style
= applied_style
;
1784 flush_wrap_buffer (stream
);
1787 /* Possible new page. Note that
1788 PAGINATION_DISABLED_FOR_COMMAND might be set during
1789 this loop, so we must continue to check it here. */
1790 if (lines_printed
>= lines_per_page
- 1
1791 && !pagination_disabled_for_command
)
1793 prompt_for_continue ();
1794 did_paginate
= true;
1797 /* Now output indentation and wrapped string. */
1800 fputs_unfiltered (wrap_indent
, stream
);
1801 if (stream
->can_emit_style_escape ())
1802 emit_style_escape (save_style
, stream
);
1803 /* FIXME, this strlen is what prevents wrap_indent from
1804 containing tabs. However, if we recurse to print it
1805 and count its chars, we risk trouble if wrap_indent is
1806 longer than (the user settable) chars_per_line.
1807 Note also that this can set chars_printed > chars_per_line
1808 if we are printing a long string. */
1809 chars_printed
= strlen (wrap_indent
)
1810 + (save_chars
- wrap_column
);
1811 wrap_column
= 0; /* And disable fancy wrap */
1813 else if (did_paginate
&& stream
->can_emit_style_escape ())
1814 emit_style_escape (save_style
, stream
);
1818 if (*lineptr
== '\n')
1821 wrap_here ((char *) 0); /* Spit out chars, cancel
1824 fputc_unfiltered ('\n', stream
);
1829 buffer_clearer
.release ();
1833 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
1835 fputs_maybe_filtered (linebuffer
, stream
, 1);
1841 fputs_styled (const char *linebuffer
, const ui_file_style
&style
,
1842 struct ui_file
*stream
)
1844 /* This just makes it so we emit somewhat fewer escape
1846 if (style
.is_default ())
1847 fputs_maybe_filtered (linebuffer
, stream
, 1);
1850 set_output_style (stream
, style
);
1851 fputs_maybe_filtered (linebuffer
, stream
, 1);
1852 set_output_style (stream
, ui_file_style ());
1859 fputs_styled_unfiltered (const char *linebuffer
, const ui_file_style
&style
,
1860 struct ui_file
*stream
)
1862 /* This just makes it so we emit somewhat fewer escape
1864 if (style
.is_default ())
1865 fputs_maybe_filtered (linebuffer
, stream
, 0);
1868 set_output_style (stream
, style
);
1869 fputs_maybe_filtered (linebuffer
, stream
, 0);
1870 set_output_style (stream
, ui_file_style ());
1877 fputs_highlighted (const char *str
, const compiled_regex
&highlight
,
1878 struct ui_file
*stream
)
1882 while (*str
&& highlight
.exec (str
, 1, &pmatch
, 0) == 0)
1884 size_t n_highlight
= pmatch
.rm_eo
- pmatch
.rm_so
;
1886 /* Output the part before pmatch with current style. */
1887 while (pmatch
.rm_so
> 0)
1889 fputc_filtered (*str
, stream
);
1894 /* Output pmatch with the highlight style. */
1895 set_output_style (stream
, highlight_style
.style ());
1896 while (n_highlight
> 0)
1898 fputc_filtered (*str
, stream
);
1902 set_output_style (stream
, ui_file_style ());
1905 /* Output the trailing part of STR not matching HIGHLIGHT. */
1907 fputs_filtered (str
, stream
);
1911 putchar_unfiltered (int c
)
1915 ui_file_write (gdb_stdout
, &buf
, 1);
1919 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
1920 May return nonlocally. */
1923 putchar_filtered (int c
)
1925 return fputc_filtered (c
, gdb_stdout
);
1929 fputc_unfiltered (int c
, struct ui_file
*stream
)
1933 ui_file_write (stream
, &buf
, 1);
1938 fputc_filtered (int c
, struct ui_file
*stream
)
1944 fputs_filtered (buf
, stream
);
1948 /* puts_debug is like fputs_unfiltered, except it prints special
1949 characters in printable fashion. */
1952 puts_debug (char *prefix
, char *string
, char *suffix
)
1956 /* Print prefix and suffix after each line. */
1957 static int new_line
= 1;
1958 static int return_p
= 0;
1959 static const char *prev_prefix
= "";
1960 static const char *prev_suffix
= "";
1962 if (*string
== '\n')
1965 /* If the prefix is changing, print the previous suffix, a new line,
1966 and the new prefix. */
1967 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
1969 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
1970 fputs_unfiltered ("\n", gdb_stdlog
);
1971 fputs_unfiltered (prefix
, gdb_stdlog
);
1974 /* Print prefix if we printed a newline during the previous call. */
1978 fputs_unfiltered (prefix
, gdb_stdlog
);
1981 prev_prefix
= prefix
;
1982 prev_suffix
= suffix
;
1984 /* Output characters in a printable format. */
1985 while ((ch
= *string
++) != '\0')
1991 fputc_unfiltered (ch
, gdb_stdlog
);
1994 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
1998 fputs_unfiltered ("\\\\", gdb_stdlog
);
2001 fputs_unfiltered ("\\b", gdb_stdlog
);
2004 fputs_unfiltered ("\\f", gdb_stdlog
);
2008 fputs_unfiltered ("\\n", gdb_stdlog
);
2011 fputs_unfiltered ("\\r", gdb_stdlog
);
2014 fputs_unfiltered ("\\t", gdb_stdlog
);
2017 fputs_unfiltered ("\\v", gdb_stdlog
);
2021 return_p
= ch
== '\r';
2024 /* Print suffix if we printed a newline. */
2027 fputs_unfiltered (suffix
, gdb_stdlog
);
2028 fputs_unfiltered ("\n", gdb_stdlog
);
2033 /* Print a variable number of ARGS using format FORMAT. If this
2034 information is going to put the amount written (since the last call
2035 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2036 call prompt_for_continue to get the users permission to continue.
2038 Unlike fprintf, this function does not return a value.
2040 We implement three variants, vfprintf (takes a vararg list and stream),
2041 fprintf (takes a stream to write on), and printf (the usual).
2043 Note also that this may throw a quit (since prompt_for_continue may
2047 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2048 va_list args
, bool filter
, bool gdbfmt
)
2052 ui_out_flags flags
= disallow_ui_out_field
;
2054 flags
|= unfiltered_output
;
2055 cli_ui_out (stream
, flags
).vmessage (applied_style
, format
, args
);
2059 std::string str
= string_vprintf (format
, args
);
2060 fputs_maybe_filtered (str
.c_str (), stream
, filter
);
2066 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2068 vfprintf_maybe_filtered (stream
, format
, args
, true, true);
2072 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2074 if (debug_timestamp
&& stream
== gdb_stdlog
)
2076 using namespace std::chrono
;
2080 cli_ui_out (&sfile
, 0).vmessage (ui_file_style (), format
, args
);
2081 std::string linebuffer
= std::move (sfile
.string ());
2083 steady_clock::time_point now
= steady_clock::now ();
2084 seconds s
= duration_cast
<seconds
> (now
.time_since_epoch ());
2085 microseconds us
= duration_cast
<microseconds
> (now
.time_since_epoch () - s
);
2087 len
= linebuffer
.size ();
2088 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2090 std::string timestamp
= string_printf ("%ld.%06ld %s%s",
2093 linebuffer
.c_str (),
2094 need_nl
? "\n": "");
2095 fputs_unfiltered (timestamp
.c_str (), stream
);
2098 vfprintf_maybe_filtered (stream
, format
, args
, false, true);
2102 vprintf_filtered (const char *format
, va_list args
)
2104 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, true, false);
2108 vprintf_unfiltered (const char *format
, va_list args
)
2110 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2114 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2118 va_start (args
, format
);
2119 vfprintf_filtered (stream
, format
, args
);
2124 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2128 va_start (args
, format
);
2129 vfprintf_unfiltered (stream
, format
, args
);
2133 /* Like fprintf_filtered, but prints its result indented.
2134 Called as fprintfi_filtered (spaces, stream, format, ...); */
2137 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2142 va_start (args
, format
);
2143 print_spaces_filtered (spaces
, stream
);
2145 vfprintf_filtered (stream
, format
, args
);
2152 fprintf_styled (struct ui_file
*stream
, const ui_file_style
&style
,
2153 const char *format
, ...)
2157 set_output_style (stream
, style
);
2158 va_start (args
, format
);
2159 vfprintf_filtered (stream
, format
, args
);
2161 set_output_style (stream
, ui_file_style ());
2167 vfprintf_styled (struct ui_file
*stream
, const ui_file_style
&style
,
2168 const char *format
, va_list args
)
2170 set_output_style (stream
, style
);
2171 vfprintf_filtered (stream
, format
, args
);
2172 set_output_style (stream
, ui_file_style ());
2178 vfprintf_styled_no_gdbfmt (struct ui_file
*stream
, const ui_file_style
&style
,
2179 bool filter
, const char *format
, va_list args
)
2181 std::string str
= string_vprintf (format
, args
);
2184 if (!style
.is_default ())
2185 set_output_style (stream
, style
);
2186 fputs_maybe_filtered (str
.c_str (), stream
, filter
);
2187 if (!style
.is_default ())
2188 set_output_style (stream
, ui_file_style ());
2193 printf_filtered (const char *format
, ...)
2197 va_start (args
, format
);
2198 vfprintf_filtered (gdb_stdout
, format
, args
);
2204 printf_unfiltered (const char *format
, ...)
2208 va_start (args
, format
);
2209 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2213 /* Like printf_filtered, but prints it's result indented.
2214 Called as printfi_filtered (spaces, format, ...); */
2217 printfi_filtered (int spaces
, const char *format
, ...)
2221 va_start (args
, format
);
2222 print_spaces_filtered (spaces
, gdb_stdout
);
2223 vfprintf_filtered (gdb_stdout
, format
, args
);
2227 /* Easy -- but watch out!
2229 This routine is *not* a replacement for puts()! puts() appends a newline.
2230 This one doesn't, and had better not! */
2233 puts_filtered (const char *string
)
2235 fputs_filtered (string
, gdb_stdout
);
2239 puts_unfiltered (const char *string
)
2241 fputs_unfiltered (string
, gdb_stdout
);
2244 /* Return a pointer to N spaces and a null. The pointer is good
2245 until the next call to here. */
2250 static char *spaces
= 0;
2251 static int max_spaces
= -1;
2257 spaces
= (char *) xmalloc (n
+ 1);
2258 for (t
= spaces
+ n
; t
!= spaces
;)
2264 return spaces
+ max_spaces
- n
;
2267 /* Print N spaces. */
2269 print_spaces_filtered (int n
, struct ui_file
*stream
)
2271 fputs_filtered (n_spaces (n
), stream
);
2274 /* C++/ObjC demangler stuff. */
2276 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2277 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2278 If the name is not mangled, or the language for the name is unknown, or
2279 demangling is off, the name is printed in its "raw" form. */
2282 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2283 enum language lang
, int arg_mode
)
2289 /* If user wants to see raw output, no problem. */
2292 fputs_filtered (name
, stream
);
2296 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2297 fputs_filtered (demangled
? demangled
: name
, stream
);
2298 if (demangled
!= NULL
)
2306 /* True if CH is a character that can be part of a symbol name. I.e.,
2307 either a number, a letter, or a '_'. */
2310 valid_identifier_name_char (int ch
)
2312 return (isalnum (ch
) || ch
== '_');
2315 /* Skip to end of token, or to END, whatever comes first. Input is
2316 assumed to be a C++ operator name. */
2319 cp_skip_operator_token (const char *token
, const char *end
)
2321 const char *p
= token
;
2322 while (p
!= end
&& !isspace (*p
) && *p
!= '(')
2324 if (valid_identifier_name_char (*p
))
2326 while (p
!= end
&& valid_identifier_name_char (*p
))
2332 /* Note, ordered such that among ops that share a prefix,
2333 longer comes first. This is so that the loop below can
2334 bail on first match. */
2335 static const char *ops
[] =
2341 "-=", "--", "->", "-",
2350 "<<=", "<=", "<<", "<",
2351 ">>=", ">=", ">>", ">",
2355 for (const char *op
: ops
)
2357 size_t oplen
= strlen (op
);
2358 size_t lencmp
= std::min
<size_t> (oplen
, end
- p
);
2360 if (strncmp (p
, op
, lencmp
) == 0)
2363 /* Some unidentified character. Return it. */
2371 /* Advance STRING1/STRING2 past whitespace. */
2374 skip_ws (const char *&string1
, const char *&string2
, const char *end_str2
)
2376 while (isspace (*string1
))
2378 while (string2
< end_str2
&& isspace (*string2
))
2382 /* True if STRING points at the start of a C++ operator name. START
2383 is the start of the string that STRING points to, hence when
2384 reading backwards, we must not read any character before START. */
2387 cp_is_operator (const char *string
, const char *start
)
2389 return ((string
== start
2390 || !valid_identifier_name_char (string
[-1]))
2391 && strncmp (string
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
2392 && !valid_identifier_name_char (string
[CP_OPERATOR_LEN
]));
2395 /* If *NAME points at an ABI tag, skip it and return true. Otherwise
2396 leave *NAME unmodified and return false. (see GCC's abi_tag
2397 attribute), such names are demangled as e.g.,
2398 "function[abi:cxx11]()". */
2401 skip_abi_tag (const char **name
)
2403 const char *p
= *name
;
2405 if (startswith (p
, "[abi:"))
2409 while (valid_identifier_name_char (*p
))
2425 strncmp_iw_with_mode (const char *string1
, const char *string2
,
2426 size_t string2_len
, strncmp_iw_mode mode
,
2427 enum language language
,
2428 completion_match_for_lcd
*match_for_lcd
)
2430 const char *string1_start
= string1
;
2431 const char *end_str2
= string2
+ string2_len
;
2432 bool skip_spaces
= true;
2433 bool have_colon_op
= (language
== language_cplus
2434 || language
== language_rust
2435 || language
== language_fortran
);
2440 || ((isspace (*string1
) && !valid_identifier_name_char (*string2
))
2441 || (isspace (*string2
) && !valid_identifier_name_char (*string1
))))
2443 skip_ws (string1
, string2
, end_str2
);
2444 skip_spaces
= false;
2447 /* Skip [abi:cxx11] tags in the symbol name if the lookup name
2448 doesn't include them. E.g.:
2450 string1: function[abi:cxx1](int)
2453 string1: function[abi:cxx1](int)
2454 string2: function(int)
2456 string1: Struct[abi:cxx1]::function()
2457 string2: Struct::function()
2459 string1: function(Struct[abi:cxx1], int)
2460 string2: function(Struct, int)
2462 if (string2
== end_str2
2463 || (*string2
!= '[' && !valid_identifier_name_char (*string2
)))
2465 const char *abi_start
= string1
;
2467 /* There can be more than one tag. */
2468 while (*string1
== '[' && skip_abi_tag (&string1
))
2471 if (match_for_lcd
!= NULL
&& abi_start
!= string1
)
2472 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2474 while (isspace (*string1
))
2478 if (*string1
== '\0' || string2
== end_str2
)
2481 /* Handle the :: operator. */
2482 if (have_colon_op
&& string1
[0] == ':' && string1
[1] == ':')
2484 if (*string2
!= ':')
2490 if (string2
== end_str2
)
2493 if (*string2
!= ':')
2499 while (isspace (*string1
))
2501 while (string2
< end_str2
&& isspace (*string2
))
2506 /* Handle C++ user-defined operators. */
2507 else if (language
== language_cplus
2510 if (cp_is_operator (string1
, string1_start
))
2512 /* An operator name in STRING1. Check STRING2. */
2514 = std::min
<size_t> (CP_OPERATOR_LEN
, end_str2
- string2
);
2515 if (strncmp (string1
, string2
, cmplen
) != 0)
2521 if (string2
!= end_str2
)
2523 /* Check for "operatorX" in STRING2. */
2524 if (valid_identifier_name_char (*string2
))
2527 skip_ws (string1
, string2
, end_str2
);
2530 /* Handle operator(). */
2531 if (*string1
== '(')
2533 if (string2
== end_str2
)
2535 if (mode
== strncmp_iw_mode::NORMAL
)
2539 /* Don't break for the regular return at the
2540 bottom, because "operator" should not
2541 match "operator()", since this open
2542 parentheses is not the parameter list
2544 return *string1
!= '\0';
2548 if (*string1
!= *string2
)
2557 skip_ws (string1
, string2
, end_str2
);
2559 /* Skip to end of token, or to END, whatever comes
2561 const char *end_str1
= string1
+ strlen (string1
);
2562 const char *p1
= cp_skip_operator_token (string1
, end_str1
);
2563 const char *p2
= cp_skip_operator_token (string2
, end_str2
);
2565 cmplen
= std::min (p1
- string1
, p2
- string2
);
2568 if (strncmp (string1
, string2
, cmplen
) != 0)
2573 if (p1
- string1
!= p2
- string2
)
2575 if (strncmp (string1
, string2
, cmplen
) != 0)
2582 if (*string1
== '\0' || string2
== end_str2
)
2584 if (*string1
== '(' || *string2
== '(')
2592 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2594 if (case_sensitivity
== case_sensitive_off
2595 && (tolower ((unsigned char) *string1
)
2596 != tolower ((unsigned char) *string2
)))
2599 /* If we see any non-whitespace, non-identifier-name character
2600 (any of "()<>*&" etc.), then skip spaces the next time
2602 if (!isspace (*string1
) && !valid_identifier_name_char (*string1
))
2609 if (string2
== end_str2
)
2611 if (mode
== strncmp_iw_mode::NORMAL
)
2613 /* Strip abi tag markers from the matched symbol name.
2614 Usually the ABI marker will be found on function name
2615 (automatically added because the function returns an
2616 object marked with an ABI tag). However, it's also
2617 possible to see a marker in one of the function
2618 parameters, for example.
2620 string2 (lookup name):
2623 function(some_struct[abi:cxx11], int)
2625 and for completion LCD computation we want to say that
2627 function(some_struct, int)
2629 if (match_for_lcd
!= NULL
)
2631 while ((string1
= strstr (string1
, "[abi:")) != NULL
)
2633 const char *abi_start
= string1
;
2635 /* There can be more than one tag. */
2636 while (skip_abi_tag (&string1
) && *string1
== '[')
2639 if (abi_start
!= string1
)
2640 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2647 return (*string1
!= '\0' && *string1
!= '(');
2656 strncmp_iw (const char *string1
, const char *string2
, size_t string2_len
)
2658 return strncmp_iw_with_mode (string1
, string2
, string2_len
,
2659 strncmp_iw_mode::NORMAL
, language_minimal
);
2665 strcmp_iw (const char *string1
, const char *string2
)
2667 return strncmp_iw_with_mode (string1
, string2
, strlen (string2
),
2668 strncmp_iw_mode::MATCH_PARAMS
, language_minimal
);
2671 /* This is like strcmp except that it ignores whitespace and treats
2672 '(' as the first non-NULL character in terms of ordering. Like
2673 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2674 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2675 according to that ordering.
2677 If a list is sorted according to this function and if you want to
2678 find names in the list that match some fixed NAME according to
2679 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2680 where this function would put NAME.
2682 This function must be neutral to the CASE_SENSITIVITY setting as the user
2683 may choose it during later lookup. Therefore this function always sorts
2684 primarily case-insensitively and secondarily case-sensitively.
2686 Here are some examples of why using strcmp to sort is a bad idea:
2690 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2691 we try to do a search for "foo<char*>", strcmp will locate this
2692 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2693 will start looking at strings beginning with "goo", and will never
2694 see the correct match of "foo<char *>".
2696 Parenthesis example:
2698 In practice, this is less like to be an issue, but I'll give it a
2699 shot. Let's assume that '$' is a legitimate character to occur in
2700 symbols. (Which may well even be the case on some systems.) Then
2701 say that the partial symbol table contains "foo$" and "foo(int)".
2702 strcmp will put them in this order, since '$' < '('. Now, if the
2703 user searches for "foo", then strcmp will sort "foo" before "foo$".
2704 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2705 "foo") is false, so it won't proceed to the actual match of
2706 "foo(int)" with "foo". */
2709 strcmp_iw_ordered (const char *string1
, const char *string2
)
2711 const char *saved_string1
= string1
, *saved_string2
= string2
;
2712 enum case_sensitivity case_pass
= case_sensitive_off
;
2716 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2717 Provide stub characters if we are already at the end of one of the
2719 char c1
= 'X', c2
= 'X';
2721 while (*string1
!= '\0' && *string2
!= '\0')
2723 while (isspace (*string1
))
2725 while (isspace (*string2
))
2730 case case_sensitive_off
:
2731 c1
= tolower ((unsigned char) *string1
);
2732 c2
= tolower ((unsigned char) *string2
);
2734 case case_sensitive_on
:
2742 if (*string1
!= '\0')
2751 /* Characters are non-equal unless they're both '\0'; we want to
2752 make sure we get the comparison right according to our
2753 comparison in the cases where one of them is '\0' or '('. */
2755 if (*string2
== '\0')
2760 if (*string2
== '\0')
2765 if (*string2
== '\0' || *string2
== '(')
2774 if (case_pass
== case_sensitive_on
)
2777 /* Otherwise the strings were equal in case insensitive way, make
2778 a more fine grained comparison in a case sensitive way. */
2780 case_pass
= case_sensitive_on
;
2781 string1
= saved_string1
;
2782 string2
= saved_string2
;
2789 streq (const char *lhs
, const char *rhs
)
2791 return !strcmp (lhs
, rhs
);
2797 streq_hash (const void *lhs
, const void *rhs
)
2799 return streq ((const char *) lhs
, (const char *) rhs
);
2806 ** Answer whether string_to_compare is a full or partial match to
2807 ** template_string. The partial match must be in sequence starting
2811 subset_compare (const char *string_to_compare
, const char *template_string
)
2815 if (template_string
!= NULL
&& string_to_compare
!= NULL
2816 && strlen (string_to_compare
) <= strlen (template_string
))
2818 (startswith (template_string
, string_to_compare
));
2825 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2826 struct cmd_list_element
*c
, const char *value
)
2828 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2836 address_significant (gdbarch
*gdbarch
, CORE_ADDR addr
)
2838 /* Clear insignificant bits of a target address and sign extend resulting
2839 address, avoiding shifts larger or equal than the width of a CORE_ADDR.
2840 The local variable ADDR_BIT stops the compiler reporting a shift overflow
2841 when it won't occur. Skip updating of target address if current target
2842 has not set gdbarch significant_addr_bit. */
2843 int addr_bit
= gdbarch_significant_addr_bit (gdbarch
);
2845 if (addr_bit
&& (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
)))
2847 CORE_ADDR sign
= (CORE_ADDR
) 1 << (addr_bit
- 1);
2848 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2849 addr
= (addr
^ sign
) - sign
;
2856 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2858 /* Truncate address to the size of a target address, avoiding shifts
2859 larger or equal than the width of a CORE_ADDR. The local
2860 variable ADDR_BIT stops the compiler reporting a shift overflow
2861 when it won't occur. */
2862 /* NOTE: This assumes that the significant address information is
2863 kept in the least significant bits of ADDR - the upper bits were
2864 either zero or sign extended. Should gdbarch_address_to_pointer or
2865 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2867 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2869 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2870 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2871 return hex_string (addr
);
2874 /* This function is described in "defs.h". */
2877 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2879 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2881 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2882 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2884 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2885 that returns the language localized string formatted to a width
2886 based on gdbarch_addr_bit. */
2888 return hex_string_custom (address
, 8);
2890 return hex_string_custom (address
, 16);
2893 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2896 core_addr_hash (const void *ap
)
2898 const CORE_ADDR
*addrp
= (const CORE_ADDR
*) ap
;
2903 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2906 core_addr_eq (const void *ap
, const void *bp
)
2908 const CORE_ADDR
*addr_ap
= (const CORE_ADDR
*) ap
;
2909 const CORE_ADDR
*addr_bp
= (const CORE_ADDR
*) bp
;
2911 return *addr_ap
== *addr_bp
;
2914 /* Convert a string back into a CORE_ADDR. */
2916 string_to_core_addr (const char *my_string
)
2920 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2922 /* Assume that it is in hex. */
2925 for (i
= 2; my_string
[i
] != '\0'; i
++)
2927 if (isdigit (my_string
[i
]))
2928 addr
= (my_string
[i
] - '0') + (addr
* 16);
2929 else if (isxdigit (my_string
[i
]))
2930 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2932 error (_("invalid hex \"%s\""), my_string
);
2937 /* Assume that it is in decimal. */
2940 for (i
= 0; my_string
[i
] != '\0'; i
++)
2942 if (isdigit (my_string
[i
]))
2943 addr
= (my_string
[i
] - '0') + (addr
* 10);
2945 error (_("invalid decimal \"%s\""), my_string
);
2955 gdb_realpath_check_trailer (const char *input
, const char *trailer
)
2957 gdb::unique_xmalloc_ptr
<char> result
= gdb_realpath (input
);
2959 size_t len
= strlen (result
.get ());
2960 size_t trail_len
= strlen (trailer
);
2962 SELF_CHECK (len
>= trail_len
2963 && strcmp (result
.get () + len
- trail_len
, trailer
) == 0);
2967 gdb_realpath_tests ()
2969 /* A file which contains a directory prefix. */
2970 gdb_realpath_check_trailer ("./xfullpath.exp", "/xfullpath.exp");
2971 /* A file which contains a directory prefix. */
2972 gdb_realpath_check_trailer ("../../defs.h", "/defs.h");
2973 /* A one-character filename. */
2974 gdb_realpath_check_trailer ("./a", "/a");
2975 /* A file in the root directory. */
2976 gdb_realpath_check_trailer ("/root_file_which_should_exist",
2977 "/root_file_which_should_exist");
2978 /* A file which does not have a directory prefix. */
2979 gdb_realpath_check_trailer ("xfullpath.exp", "xfullpath.exp");
2980 /* A one-char filename without any directory prefix. */
2981 gdb_realpath_check_trailer ("a", "a");
2982 /* An empty filename. */
2983 gdb_realpath_check_trailer ("", "");
2986 #endif /* GDB_SELF_TEST */
2988 /* Allocation function for the libiberty hash table which uses an
2989 obstack. The obstack is passed as DATA. */
2992 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
2994 size_t total
= size
* count
;
2995 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
2997 memset (ptr
, 0, total
);
3001 /* Trivial deallocation function for the libiberty splay tree and hash
3002 table - don't deallocate anything. Rely on later deletion of the
3003 obstack. DATA will be the obstack, although it is not needed
3007 dummy_obstack_deallocate (void *object
, void *data
)
3012 /* Simple, portable version of dirname that does not modify its
3016 ldirname (const char *filename
)
3018 std::string dirname
;
3019 const char *base
= lbasename (filename
);
3021 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
3024 if (base
== filename
)
3027 dirname
= std::string (filename
, base
- filename
);
3029 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3030 create "d:./bar" later instead of the (different) "d:/bar". */
3031 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3032 && !IS_DIR_SEPARATOR (filename
[0]))
3033 dirname
[base
++ - filename
] = '.';
3041 gdb_argv::reset (const char *s
)
3043 char **argv
= buildargv (s
);
3049 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3050 #define AMBIGUOUS_MESS2 \
3051 ".\nUse \"set gnutarget format-name\" to specify the format."
3054 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3058 /* Check if errmsg just need simple return. */
3059 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3060 return bfd_errmsg (error_tag
);
3062 std::string
ret (bfd_errmsg (error_tag
));
3063 ret
+= AMBIGUOUS_MESS1
;
3065 for (p
= matching
; *p
; p
++)
3070 ret
+= AMBIGUOUS_MESS2
;
3077 /* Return ARGS parsed as a valid pid, or throw an error. */
3080 parse_pid_to_attach (const char *args
)
3086 error_no_arg (_("process-id to attach"));
3088 dummy
= (char *) args
;
3089 pid
= strtoul (args
, &dummy
, 0);
3090 /* Some targets don't set errno on errors, grrr! */
3091 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3092 error (_("Illegal process-id: %s."), args
);
3097 /* Substitute all occurrences of string FROM by string TO in *STRINGP. *STRINGP
3098 must come from xrealloc-compatible allocator and it may be updated. FROM
3099 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3100 located at the start or end of *STRINGP. */
3103 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3105 char *string
= *stringp
, *s
;
3106 const size_t from_len
= strlen (from
);
3107 const size_t to_len
= strlen (to
);
3111 s
= strstr (s
, from
);
3115 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3116 || s
[-1] == DIRNAME_SEPARATOR
)
3117 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3118 || s
[from_len
] == DIRNAME_SEPARATOR
))
3123 = (char *) xrealloc (string
, (strlen (string
) + to_len
+ 1));
3125 /* Relocate the current S pointer. */
3126 s
= s
- string
+ string_new
;
3127 string
= string_new
;
3129 /* Replace from by to. */
3130 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3131 memcpy (s
, to
, to_len
);
3146 /* SIGALRM handler for waitpid_with_timeout. */
3149 sigalrm_handler (int signo
)
3151 /* Nothing to do. */
3156 /* Wrapper to wait for child PID to die with TIMEOUT.
3157 TIMEOUT is the time to stop waiting in seconds.
3158 If TIMEOUT is zero, pass WNOHANG to waitpid.
3159 Returns PID if it was successfully waited for, otherwise -1.
3161 Timeouts are currently implemented with alarm and SIGALRM.
3162 If the host does not support them, this waits "forever".
3163 It would be odd though for a host to have waitpid and not SIGALRM. */
3166 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3168 pid_t waitpid_result
;
3170 gdb_assert (pid
> 0);
3171 gdb_assert (timeout
>= 0);
3176 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3177 struct sigaction sa
, old_sa
;
3179 sa
.sa_handler
= sigalrm_handler
;
3180 sigemptyset (&sa
.sa_mask
);
3182 sigaction (SIGALRM
, &sa
, &old_sa
);
3186 ofunc
= signal (SIGALRM
, sigalrm_handler
);
3192 waitpid_result
= waitpid (pid
, status
, 0);
3196 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3197 sigaction (SIGALRM
, &old_sa
, NULL
);
3199 signal (SIGALRM
, ofunc
);
3204 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3206 if (waitpid_result
== pid
)
3212 #endif /* HAVE_WAITPID */
3214 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3215 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3217 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3218 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3221 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3223 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3225 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3226 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3228 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3230 char *pattern_slash
, *string_slash
;
3232 /* Replace '\' by '/' in both strings. */
3234 pattern_slash
= (char *) alloca (strlen (pattern
) + 1);
3235 strcpy (pattern_slash
, pattern
);
3236 pattern
= pattern_slash
;
3237 for (; *pattern_slash
!= 0; pattern_slash
++)
3238 if (IS_DIR_SEPARATOR (*pattern_slash
))
3239 *pattern_slash
= '/';
3241 string_slash
= (char *) alloca (strlen (string
) + 1);
3242 strcpy (string_slash
, string
);
3243 string
= string_slash
;
3244 for (; *string_slash
!= 0; string_slash
++)
3245 if (IS_DIR_SEPARATOR (*string_slash
))
3246 *string_slash
= '/';
3248 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3250 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3251 flags
|= FNM_CASEFOLD
;
3252 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3254 return fnmatch (pattern
, string
, flags
);
3257 /* Return the number of path elements in PATH.
3265 count_path_elements (const char *path
)
3268 const char *p
= path
;
3270 if (HAS_DRIVE_SPEC (p
))
3272 p
= STRIP_DRIVE_SPEC (p
);
3278 if (IS_DIR_SEPARATOR (*p
))
3283 /* Backup one if last character is /, unless it's the only one. */
3284 if (p
> path
+ 1 && IS_DIR_SEPARATOR (p
[-1]))
3287 /* Add one for the file name, if present. */
3288 if (p
> path
&& !IS_DIR_SEPARATOR (p
[-1]))
3294 /* Remove N leading path elements from PATH.
3295 N must be non-negative.
3296 If PATH has more than N path elements then return NULL.
3297 If PATH has exactly N path elements then return "".
3298 See count_path_elements for a description of how we do the counting. */
3301 strip_leading_path_elements (const char *path
, int n
)
3304 const char *p
= path
;
3306 gdb_assert (n
>= 0);
3311 if (HAS_DRIVE_SPEC (p
))
3313 p
= STRIP_DRIVE_SPEC (p
);
3319 while (*p
!= '\0' && !IS_DIR_SEPARATOR (*p
))
3337 copy_bitwise (gdb_byte
*dest
, ULONGEST dest_offset
,
3338 const gdb_byte
*source
, ULONGEST source_offset
,
3339 ULONGEST nbits
, int bits_big_endian
)
3341 unsigned int buf
, avail
;
3346 if (bits_big_endian
)
3348 /* Start from the end, then work backwards. */
3349 dest_offset
+= nbits
- 1;
3350 dest
+= dest_offset
/ 8;
3351 dest_offset
= 7 - dest_offset
% 8;
3352 source_offset
+= nbits
- 1;
3353 source
+= source_offset
/ 8;
3354 source_offset
= 7 - source_offset
% 8;
3358 dest
+= dest_offset
/ 8;
3360 source
+= source_offset
/ 8;
3364 /* Fill BUF with DEST_OFFSET bits from the destination and 8 -
3365 SOURCE_OFFSET bits from the source. */
3366 buf
= *(bits_big_endian
? source
-- : source
++) >> source_offset
;
3367 buf
<<= dest_offset
;
3368 buf
|= *dest
& ((1 << dest_offset
) - 1);
3370 /* NBITS: bits yet to be written; AVAIL: BUF's fill level. */
3371 nbits
+= dest_offset
;
3372 avail
= dest_offset
+ 8 - source_offset
;
3374 /* Flush 8 bits from BUF, if appropriate. */
3375 if (nbits
>= 8 && avail
>= 8)
3377 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3383 /* Copy the middle part. */
3386 size_t len
= nbits
/ 8;
3388 /* Use a faster method for byte-aligned copies. */
3391 if (bits_big_endian
)
3395 memcpy (dest
+ 1, source
+ 1, len
);
3399 memcpy (dest
, source
, len
);
3408 buf
|= *(bits_big_endian
? source
-- : source
++) << avail
;
3409 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3416 /* Write the last byte. */
3420 buf
|= *source
<< avail
;
3422 buf
&= (1 << nbits
) - 1;
3423 *dest
= (*dest
& (~0 << nbits
)) | buf
;
3427 void _initialize_utils ();
3429 _initialize_utils ()
3431 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
3432 Set number of characters where GDB should wrap lines of its output."), _("\
3433 Show number of characters where GDB should wrap lines of its output."), _("\
3434 This affects where GDB wraps its output to fit the screen width.\n\
3435 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
3437 show_chars_per_line
,
3438 &setlist
, &showlist
);
3440 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
3441 Set number of lines in a page for GDB output pagination."), _("\
3442 Show number of lines in a page for GDB output pagination."), _("\
3443 This affects the number of lines after which GDB will pause\n\
3444 its output and ask you whether to continue.\n\
3445 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
3447 show_lines_per_page
,
3448 &setlist
, &showlist
);
3450 add_setshow_boolean_cmd ("pagination", class_support
,
3451 &pagination_enabled
, _("\
3452 Set state of GDB output pagination."), _("\
3453 Show state of GDB output pagination."), _("\
3454 When pagination is ON, GDB pauses at end of each screenful of\n\
3455 its output and asks you whether to continue.\n\
3456 Turning pagination off is an alternative to \"set height unlimited\"."),
3458 show_pagination_enabled
,
3459 &setlist
, &showlist
);
3461 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
3462 &sevenbit_strings
, _("\
3463 Set printing of 8-bit characters in strings as \\nnn."), _("\
3464 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
3466 show_sevenbit_strings
,
3467 &setprintlist
, &showprintlist
);
3469 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
3470 &debug_timestamp
, _("\
3471 Set timestamping of debugging messages."), _("\
3472 Show timestamping of debugging messages."), _("\
3473 When set, debugging messages will be marked with seconds and microseconds."),
3475 show_debug_timestamp
,
3476 &setdebuglist
, &showdebuglist
);
3478 add_internal_problem_command (&internal_error_problem
);
3479 add_internal_problem_command (&internal_warning_problem
);
3480 add_internal_problem_command (&demangler_warning_problem
);
3483 selftests::register_test ("gdb_realpath", gdb_realpath_tests
);