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"
65 #include "gdb_usleep.h"
67 #include "gdb_regex.h"
68 #include "gdbsupport/job-control.h"
69 #include "gdbsupport/selftest.h"
70 #include "gdbsupport/gdb_optional.h"
71 #include "cp-support.h"
73 #include "gdbsupport/pathstuff.h"
74 #include "cli/cli-style.h"
75 #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 *,
83 va_list, int) ATTRIBUTE_PRINTF (2, 0);
85 static void fputs_maybe_filtered (const char *, struct ui_file
*, int);
87 static void prompt_for_continue (void);
89 static void set_screen_size (void);
90 static void set_width (void);
92 /* Time spent in prompt_for_continue in the currently executing command
93 waiting for user to respond.
94 Initialized in make_command_stats_cleanup.
95 Modified in prompt_for_continue and defaulted_query.
96 Used in report_command_stats. */
98 static std::chrono::steady_clock::duration prompt_for_continue_wait_time
;
100 /* A flag indicating whether to timestamp debugging messages. */
102 static int debug_timestamp
= 0;
104 /* Nonzero means that strings with character values >0x7F should be printed
105 as octal escapes. Zero means just print the value (e.g. it's an
106 international character, and the terminal or window can cope.) */
108 int sevenbit_strings
= 0;
110 show_sevenbit_strings (struct ui_file
*file
, int from_tty
,
111 struct cmd_list_element
*c
, const char *value
)
113 fprintf_filtered (file
, _("Printing of 8-bit characters "
114 "in strings as \\nnn is %s.\n"),
118 /* String to be printed before warning messages, if any. */
120 const char *warning_pre_print
= "\nwarning: ";
122 int pagination_enabled
= 1;
124 show_pagination_enabled (struct ui_file
*file
, int from_tty
,
125 struct cmd_list_element
*c
, const char *value
)
127 fprintf_filtered (file
, _("State of pagination is %s.\n"), value
);
133 /* Print a warning message. The first argument STRING is the warning
134 message, used as an fprintf format string, the second is the
135 va_list of arguments for that string. A warning is unfiltered (not
136 paginated) so that the user does not need to page through each
137 screen full of warnings when there are lots of them. */
140 vwarning (const char *string
, va_list args
)
142 if (deprecated_warning_hook
)
143 (*deprecated_warning_hook
) (string
, args
);
146 gdb::optional
<target_terminal::scoped_restore_terminal_state
> term_state
;
147 if (target_supports_terminal_ours ())
149 term_state
.emplace ();
150 target_terminal::ours_for_output ();
152 if (filtered_printing_initialized ())
153 wrap_here (""); /* Force out any buffered output. */
154 gdb_flush (gdb_stdout
);
155 if (warning_pre_print
)
156 fputs_unfiltered (warning_pre_print
, gdb_stderr
);
157 vfprintf_unfiltered (gdb_stderr
, string
, args
);
158 fprintf_unfiltered (gdb_stderr
, "\n");
162 /* Print an error message and return to command level.
163 The first argument STRING is the error message, used as a fprintf string,
164 and the remaining args are passed as arguments to it. */
167 verror (const char *string
, va_list args
)
169 throw_verror (GENERIC_ERROR
, string
, args
);
173 error_stream (const string_file
&stream
)
175 error (("%s"), stream
.c_str ());
178 /* Emit a message and abort. */
180 static void ATTRIBUTE_NORETURN
181 abort_with_message (const char *msg
)
183 if (current_ui
== NULL
)
186 fputs_unfiltered (msg
, gdb_stderr
);
188 abort (); /* NOTE: GDB has only three calls to abort(). */
191 /* Dump core trying to increase the core soft limit to hard limit first. */
196 #ifdef HAVE_SETRLIMIT
197 struct rlimit rlim
= { (rlim_t
) RLIM_INFINITY
, (rlim_t
) RLIM_INFINITY
};
199 setrlimit (RLIMIT_CORE
, &rlim
);
200 #endif /* HAVE_SETRLIMIT */
202 abort (); /* NOTE: GDB has only three calls to abort(). */
205 /* Check whether GDB will be able to dump core using the dump_core
206 function. Returns zero if GDB cannot or should not dump core.
207 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
208 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
211 can_dump_core (enum resource_limit_kind limit_kind
)
213 #ifdef HAVE_GETRLIMIT
216 /* Be quiet and assume we can dump if an error is returned. */
217 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
223 if (rlim
.rlim_cur
== 0)
228 if (rlim
.rlim_max
== 0)
231 #endif /* HAVE_GETRLIMIT */
236 /* Print a warning that we cannot dump core. */
239 warn_cant_dump_core (const char *reason
)
241 fprintf_unfiltered (gdb_stderr
,
242 _("%s\nUnable to dump core, use `ulimit -c"
243 " unlimited' before executing GDB next time.\n"),
247 /* Check whether GDB will be able to dump core using the dump_core
248 function, and print a warning if we cannot. */
251 can_dump_core_warn (enum resource_limit_kind limit_kind
,
254 int core_dump_allowed
= can_dump_core (limit_kind
);
256 if (!core_dump_allowed
)
257 warn_cant_dump_core (reason
);
259 return core_dump_allowed
;
262 /* Allow the user to configure the debugger behavior with respect to
263 what to do when an internal problem is detected. */
265 const char internal_problem_ask
[] = "ask";
266 const char internal_problem_yes
[] = "yes";
267 const char internal_problem_no
[] = "no";
268 static const char *const internal_problem_modes
[] =
270 internal_problem_ask
,
271 internal_problem_yes
,
276 /* Print a message reporting an internal error/warning. Ask the user
277 if they want to continue, dump core, or just exit. Return
278 something to indicate a quit. */
280 struct internal_problem
283 int user_settable_should_quit
;
284 const char *should_quit
;
285 int user_settable_should_dump_core
;
286 const char *should_dump_core
;
289 /* Report a problem, internal to GDB, to the user. Once the problem
290 has been reported, and assuming GDB didn't quit, the caller can
291 either allow execution to resume or throw an error. */
293 static void ATTRIBUTE_PRINTF (4, 0)
294 internal_vproblem (struct internal_problem
*problem
,
295 const char *file
, int line
, const char *fmt
, va_list ap
)
302 /* Don't allow infinite error/warning recursion. */
304 static const char msg
[] = "Recursive internal problem.\n";
313 abort_with_message (msg
);
316 /* Newer GLIBC versions put the warn_unused_result attribute
317 on write, but this is one of those rare cases where
318 ignoring the return value is correct. Casting to (void)
319 does not fix this problem. This is the solution suggested
320 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
321 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
322 abort (); /* NOTE: GDB has only three calls to abort(). */
327 /* Create a string containing the full error/warning message. Need
328 to call query with this full string, as otherwize the reason
329 (error/warning) and question become separated. Format using a
330 style similar to a compiler error message. Include extra detail
331 so that the user knows that they are living on the edge. */
333 std::string msg
= string_vprintf (fmt
, ap
);
334 reason
= string_printf ("%s:%d: %s: %s\n"
335 "A problem internal to GDB has been detected,\n"
336 "further debugging may prove unreliable.",
337 file
, line
, problem
->name
, msg
.c_str ());
340 /* Fall back to abort_with_message if gdb_stderr is not set up. */
341 if (current_ui
== NULL
)
343 fputs (reason
.c_str (), stderr
);
344 abort_with_message ("\n");
347 /* Try to get the message out and at the start of a new line. */
348 gdb::optional
<target_terminal::scoped_restore_terminal_state
> term_state
;
349 if (target_supports_terminal_ours ())
351 term_state
.emplace ();
352 target_terminal::ours_for_output ();
354 if (filtered_printing_initialized ())
357 /* Emit the message unless query will emit it below. */
358 if (problem
->should_quit
!= internal_problem_ask
360 || !filtered_printing_initialized ())
361 fprintf_unfiltered (gdb_stderr
, "%s\n", reason
.c_str ());
363 if (problem
->should_quit
== internal_problem_ask
)
365 /* Default (yes/batch case) is to quit GDB. When in batch mode
366 this lessens the likelihood of GDB going into an infinite
368 if (!confirm
|| !filtered_printing_initialized ())
371 quit_p
= query (_("%s\nQuit this debugging session? "),
374 else if (problem
->should_quit
== internal_problem_yes
)
376 else if (problem
->should_quit
== internal_problem_no
)
379 internal_error (__FILE__
, __LINE__
, _("bad switch"));
381 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr
);
382 if (REPORT_BUGS_TO
[0])
383 fprintf_unfiltered (gdb_stderr
, _(" For instructions, see:\n%s."),
385 fputs_unfiltered ("\n\n", gdb_stderr
);
387 if (problem
->should_dump_core
== internal_problem_ask
)
389 if (!can_dump_core_warn (LIMIT_MAX
, reason
.c_str ()))
391 else if (!filtered_printing_initialized ())
395 /* Default (yes/batch case) is to dump core. This leaves a GDB
396 `dropping' so that it is easier to see that something went
398 dump_core_p
= query (_("%s\nCreate a core file of GDB? "),
402 else if (problem
->should_dump_core
== internal_problem_yes
)
403 dump_core_p
= can_dump_core_warn (LIMIT_MAX
, reason
.c_str ());
404 else if (problem
->should_dump_core
== internal_problem_no
)
407 internal_error (__FILE__
, __LINE__
, _("bad switch"));
420 #ifdef HAVE_WORKING_FORK
430 static struct internal_problem internal_error_problem
= {
431 "internal-error", 1, internal_problem_ask
, 1, internal_problem_ask
435 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
437 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
438 throw_quit (_("Command aborted."));
441 static struct internal_problem internal_warning_problem
= {
442 "internal-warning", 1, internal_problem_ask
, 1, internal_problem_ask
446 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
448 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
451 static struct internal_problem demangler_warning_problem
= {
452 "demangler-warning", 1, internal_problem_ask
, 0, internal_problem_no
456 demangler_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
458 internal_vproblem (&demangler_warning_problem
, file
, line
, fmt
, ap
);
462 demangler_warning (const char *file
, int line
, const char *string
, ...)
466 va_start (ap
, string
);
467 demangler_vwarning (file
, line
, string
, ap
);
471 /* Dummy functions to keep add_prefix_cmd happy. */
474 set_internal_problem_cmd (const char *args
, int from_tty
)
479 show_internal_problem_cmd (const char *args
, int from_tty
)
483 /* When GDB reports an internal problem (error or warning) it gives
484 the user the opportunity to quit GDB and/or create a core file of
485 the current debug session. This function registers a few commands
486 that make it possible to specify that GDB should always or never
487 quit or create a core file, without asking. The commands look
490 maint set PROBLEM-NAME quit ask|yes|no
491 maint show PROBLEM-NAME quit
492 maint set PROBLEM-NAME corefile ask|yes|no
493 maint show PROBLEM-NAME corefile
495 Where PROBLEM-NAME is currently "internal-error" or
496 "internal-warning". */
499 add_internal_problem_command (struct internal_problem
*problem
)
501 struct cmd_list_element
**set_cmd_list
;
502 struct cmd_list_element
**show_cmd_list
;
506 set_cmd_list
= XNEW (struct cmd_list_element
*);
507 show_cmd_list
= XNEW (struct cmd_list_element
*);
508 *set_cmd_list
= NULL
;
509 *show_cmd_list
= NULL
;
511 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
514 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
517 add_prefix_cmd (problem
->name
,
518 class_maintenance
, set_internal_problem_cmd
, set_doc
,
520 concat ("maintenance set ", problem
->name
, " ",
522 0/*allow-unknown*/, &maintenance_set_cmdlist
);
524 add_prefix_cmd (problem
->name
,
525 class_maintenance
, show_internal_problem_cmd
, show_doc
,
527 concat ("maintenance show ", problem
->name
, " ",
529 0/*allow-unknown*/, &maintenance_show_cmdlist
);
531 if (problem
->user_settable_should_quit
)
533 set_doc
= xstrprintf (_("Set whether GDB should quit "
534 "when an %s is detected"),
536 show_doc
= xstrprintf (_("Show whether GDB will quit "
537 "when an %s is detected"),
539 add_setshow_enum_cmd ("quit", class_maintenance
,
540 internal_problem_modes
,
541 &problem
->should_quit
,
554 if (problem
->user_settable_should_dump_core
)
556 set_doc
= xstrprintf (_("Set whether GDB should create a core "
557 "file of GDB when %s is detected"),
559 show_doc
= xstrprintf (_("Show whether GDB will create a core "
560 "file of GDB when %s is detected"),
562 add_setshow_enum_cmd ("corefile", class_maintenance
,
563 internal_problem_modes
,
564 &problem
->should_dump_core
,
578 /* Return a newly allocated string, containing the PREFIX followed
579 by the system error message for errno (separated by a colon). */
582 perror_string (const char *prefix
)
586 err
= safe_strerror (errno
);
587 return std::string (prefix
) + ": " + err
;
590 /* Print the system error message for errno, and also mention STRING
591 as the file name for which the error was encountered. Use ERRCODE
592 for the thrown exception. Then return to command level. */
595 throw_perror_with_name (enum errors errcode
, const char *string
)
597 std::string combined
= perror_string (string
);
599 /* I understand setting these is a matter of taste. Still, some people
600 may clear errno but not know about bfd_error. Doing this here is not
602 bfd_set_error (bfd_error_no_error
);
605 throw_error (errcode
, _("%s."), combined
.c_str ());
608 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
611 perror_with_name (const char *string
)
613 throw_perror_with_name (GENERIC_ERROR
, string
);
616 /* Same as perror_with_name except that it prints a warning instead
617 of throwing an error. */
620 perror_warning_with_name (const char *string
)
622 std::string combined
= perror_string (string
);
623 warning (_("%s"), combined
.c_str ());
626 /* Print the system error message for ERRCODE, and also mention STRING
627 as the file name for which the error was encountered. */
630 print_sys_errmsg (const char *string
, int errcode
)
635 err
= safe_strerror (errcode
);
636 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
637 strcpy (combined
, string
);
638 strcat (combined
, ": ");
639 strcat (combined
, err
);
641 /* We want anything which was printed on stdout to come out first, before
643 gdb_flush (gdb_stdout
);
644 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
647 /* Control C eventually causes this to be called, at a convenient time. */
652 if (sync_quit_force_run
)
654 sync_quit_force_run
= 0;
655 quit_force (NULL
, 0);
659 /* No steenking SIGINT will ever be coming our way when the
660 program is resumed. Don't lie. */
664 /* If there is no terminal switching for this target, then we can't
665 possibly get screwed by the lack of job control. */
666 || !target_supports_terminal_ours ())
669 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
678 if (sync_quit_force_run
)
685 /* Called when a memory allocation fails, with the number of bytes of
686 memory requested in SIZE. */
689 malloc_failure (long size
)
693 internal_error (__FILE__
, __LINE__
,
694 _("virtual memory exhausted: can't allocate %ld bytes."),
699 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
703 /* My replacement for the read system call.
704 Used like `read' but keeps going if `read' returns too soon. */
707 myread (int desc
, char *addr
, int len
)
714 val
= read (desc
, addr
, len
);
726 print_spaces (int n
, struct ui_file
*file
)
728 fputs_unfiltered (n_spaces (n
), file
);
731 /* Print a host address. */
734 gdb_print_host_address_1 (const void *addr
, struct ui_file
*stream
)
736 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
742 make_hex_string (const gdb_byte
*data
, size_t length
)
744 char *result
= (char *) xmalloc (length
* 2 + 1);
749 for (i
= 0; i
< length
; ++i
)
750 p
+= xsnprintf (p
, 3, "%02x", data
[i
]);
757 /* An RAII class that sets up to handle input and then tears down
758 during destruction. */
760 class scoped_input_handler
764 scoped_input_handler ()
765 : m_quit_handler (&quit_handler
, default_quit_handler
),
768 target_terminal::ours ();
769 ui_register_input_event_handler (current_ui
);
770 if (current_ui
->prompt_state
== PROMPT_BLOCKED
)
774 ~scoped_input_handler ()
777 ui_unregister_input_event_handler (m_ui
);
780 DISABLE_COPY_AND_ASSIGN (scoped_input_handler
);
784 /* Save and restore the terminal state. */
785 target_terminal::scoped_restore_terminal_state m_term_state
;
787 /* Save and restore the quit handler. */
788 scoped_restore_tmpl
<quit_handler_ftype
*> m_quit_handler
;
790 /* The saved UI, if non-NULL. */
796 /* This function supports the query, nquery, and yquery functions.
797 Ask user a y-or-n question and return 0 if answer is no, 1 if
798 answer is yes, or default the answer to the specified default
799 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
800 default answer, or '\0' for no default.
801 CTLSTR is the control string and should end in "? ". It should
802 not say how to answer, because we do that.
803 ARGS are the arguments passed along with the CTLSTR argument to
806 static int ATTRIBUTE_PRINTF (1, 0)
807 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
811 char def_answer
, not_def_answer
;
812 const char *y_string
, *n_string
;
814 /* Set up according to which answer is the default. */
819 not_def_answer
= 'N';
823 else if (defchar
== 'y')
827 not_def_answer
= 'N';
835 not_def_answer
= 'Y';
840 /* Automatically answer the default value if the user did not want
841 prompts or the command was issued with the server prefix. */
842 if (!confirm
|| server_command
)
845 /* If input isn't coming from the user directly, just say what
846 question we're asking, and then answer the default automatically. This
847 way, important error messages don't get lost when talking to GDB
849 if (current_ui
->instream
!= current_ui
->stdin_stream
850 || !input_interactive_p (current_ui
)
851 /* Restrict queries to the main UI. */
852 || current_ui
!= main_ui
)
854 target_terminal::scoped_restore_terminal_state term_state
;
855 target_terminal::ours_for_output ();
857 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
859 printf_filtered (_("(%s or %s) [answered %c; "
860 "input not from terminal]\n"),
861 y_string
, n_string
, def_answer
);
866 if (deprecated_query_hook
)
868 target_terminal::scoped_restore_terminal_state term_state
;
869 return deprecated_query_hook (ctlstr
, args
);
872 /* Format the question outside of the loop, to avoid reusing args. */
873 std::string question
= string_vprintf (ctlstr
, args
);
875 = string_printf (_("%s%s(%s or %s) %s"),
876 annotation_level
> 1 ? "\n\032\032pre-query\n" : "",
877 question
.c_str (), y_string
, n_string
,
878 annotation_level
> 1 ? "\n\032\032query\n" : "");
880 /* Used to add duration we waited for user to respond to
881 prompt_for_continue_wait_time. */
882 using namespace std::chrono
;
883 steady_clock::time_point prompt_started
= steady_clock::now ();
885 scoped_input_handler prepare_input
;
889 char *response
, answer
;
891 gdb_flush (gdb_stdout
);
892 response
= gdb_readline_wrapper (prompt
.c_str ());
894 if (response
== NULL
) /* C-d */
896 printf_filtered ("EOF [assumed %c]\n", def_answer
);
901 answer
= response
[0];
906 /* Check answer. For the non-default, the user must specify
907 the non-default explicitly. */
908 if (answer
== not_def_answer
)
913 /* Otherwise, if a default was specified, the user may either
914 specify the required input or have it default by entering
916 if (answer
== def_answer
917 || (defchar
!= '\0' && answer
== '\0'))
922 /* Invalid entries are not defaulted and require another selection. */
923 printf_filtered (_("Please answer %s or %s.\n"),
927 /* Add time spend in this routine to prompt_for_continue_wait_time. */
928 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
930 if (annotation_level
> 1)
931 printf_filtered (("\n\032\032post-query\n"));
936 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
937 answer is yes, or 0 if answer is defaulted.
938 Takes three args which are given to printf to print the question.
939 The first, a control string, should end in "? ".
940 It should not say how to answer, because we do that. */
943 nquery (const char *ctlstr
, ...)
948 va_start (args
, ctlstr
);
949 ret
= defaulted_query (ctlstr
, 'n', args
);
954 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
955 answer is yes, or 1 if answer is defaulted.
956 Takes three args which are given to printf to print the question.
957 The first, a control string, should end in "? ".
958 It should not say how to answer, because we do that. */
961 yquery (const char *ctlstr
, ...)
966 va_start (args
, ctlstr
);
967 ret
= defaulted_query (ctlstr
, 'y', args
);
972 /* Ask user a y-or-n question and return 1 iff answer is yes.
973 Takes three args which are given to printf to print the question.
974 The first, a control string, should end in "? ".
975 It should not say how to answer, because we do that. */
978 query (const char *ctlstr
, ...)
983 va_start (args
, ctlstr
);
984 ret
= defaulted_query (ctlstr
, '\0', args
);
989 /* A helper for parse_escape that converts a host character to a
990 target character. C is the host character. If conversion is
991 possible, then the target character is stored in *TARGET_C and the
992 function returns 1. Otherwise, the function returns 0. */
995 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1000 auto_obstack host_data
;
1002 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1003 (gdb_byte
*) &the_char
, 1, 1,
1004 &host_data
, translit_none
);
1006 if (obstack_object_size (&host_data
) == 1)
1009 *target_c
= *(char *) obstack_base (&host_data
);
1015 /* Parse a C escape sequence. STRING_PTR points to a variable
1016 containing a pointer to the string to parse. That pointer
1017 should point to the character after the \. That pointer
1018 is updated past the characters we use. The value of the
1019 escape sequence is returned.
1021 A negative value means the sequence \ newline was seen,
1022 which is supposed to be equivalent to nothing at all.
1024 If \ is followed by a null character, we return a negative
1025 value and leave the string pointer pointing at the null character.
1027 If \ is followed by 000, we return 0 and leave the string pointer
1028 after the zeros. A value of 0 does not mean end of string. */
1031 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1033 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1034 int c
= *(*string_ptr
)++;
1053 int i
= host_hex_value (c
);
1058 if (isdigit (c
) && c
!= '8' && c
!= '9')
1062 i
+= host_hex_value (c
);
1098 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1099 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1100 " which has no equivalent\nin the `%s' character set."),
1101 c
, c
, target_charset (gdbarch
));
1105 /* Print the character C on STREAM as part of the contents of a literal
1106 string whose delimiter is QUOTER. Note that this routine should only
1107 be called for printing things which are independent of the language
1108 of the program being debugged.
1110 printchar will normally escape backslashes and instances of QUOTER. If
1111 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1112 As a side effect, if you pass the backslash character as the QUOTER,
1113 printchar will escape backslashes as usual, but not any other quoting
1117 printchar (int c
, do_fputc_ftype do_fputc
, ui_file
*stream
, int quoter
)
1119 c
&= 0xFF; /* Avoid sign bit follies */
1121 if (c
< 0x20 || /* Low control chars */
1122 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1123 (sevenbit_strings
&& c
>= 0x80))
1124 { /* high order bit set */
1125 do_fputc ('\\', stream
);
1130 do_fputc ('n', stream
);
1133 do_fputc ('b', stream
);
1136 do_fputc ('t', stream
);
1139 do_fputc ('f', stream
);
1142 do_fputc ('r', stream
);
1145 do_fputc ('e', stream
);
1148 do_fputc ('a', stream
);
1152 do_fputc ('0' + ((c
>> 6) & 0x7), stream
);
1153 do_fputc ('0' + ((c
>> 3) & 0x7), stream
);
1154 do_fputc ('0' + ((c
>> 0) & 0x7), stream
);
1161 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1162 do_fputc ('\\', stream
);
1163 do_fputc (c
, stream
);
1167 /* Print the character C on STREAM as part of the contents of a
1168 literal string whose delimiter is QUOTER. Note that these routines
1169 should only be call for printing things which are independent of
1170 the language of the program being debugged. */
1173 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1176 printchar (*str
++, fputc_filtered
, stream
, quoter
);
1180 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1183 printchar (*str
++, fputc_unfiltered
, stream
, quoter
);
1187 fputstrn_filtered (const char *str
, int n
, int quoter
,
1188 struct ui_file
*stream
)
1190 for (int i
= 0; i
< n
; i
++)
1191 printchar (str
[i
], fputc_filtered
, stream
, quoter
);
1195 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1196 do_fputc_ftype do_fputc
, struct ui_file
*stream
)
1198 for (int i
= 0; i
< n
; i
++)
1199 printchar (str
[i
], do_fputc
, stream
, quoter
);
1203 /* Number of lines per page or UINT_MAX if paging is disabled. */
1204 static unsigned int lines_per_page
;
1206 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1207 struct cmd_list_element
*c
, const char *value
)
1209 fprintf_filtered (file
,
1210 _("Number of lines gdb thinks are in a page is %s.\n"),
1214 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1215 static unsigned int chars_per_line
;
1217 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1218 struct cmd_list_element
*c
, const char *value
)
1220 fprintf_filtered (file
,
1221 _("Number of characters gdb thinks "
1222 "are in a line is %s.\n"),
1226 /* Current count of lines printed on this page, chars on this line. */
1227 static unsigned int lines_printed
, chars_printed
;
1229 /* True if pagination is disabled for just one command. */
1231 static bool pagination_disabled_for_command
;
1233 /* Buffer and start column of buffered text, for doing smarter word-
1234 wrapping. When someone calls wrap_here(), we start buffering output
1235 that comes through fputs_filtered(). If we see a newline, we just
1236 spit it out and forget about the wrap_here(). If we see another
1237 wrap_here(), we spit it out and remember the newer one. If we see
1238 the end of the line, we spit out a newline, the indent, and then
1239 the buffered output. */
1241 static bool filter_initialized
= false;
1243 /* Contains characters which are waiting to be output (they have
1244 already been counted in chars_printed). */
1245 static std::string wrap_buffer
;
1247 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1249 static const char *wrap_indent
;
1251 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1252 is not in effect. */
1253 static int wrap_column
;
1255 /* The style applied at the time that wrap_here was called. */
1256 static ui_file_style wrap_style
;
1259 /* Initialize the number of lines per page and chars per line. */
1262 init_page_info (void)
1266 lines_per_page
= UINT_MAX
;
1267 chars_per_line
= UINT_MAX
;
1271 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1276 #if defined(__GO32__)
1277 rows
= ScreenRows ();
1278 cols
= ScreenCols ();
1279 lines_per_page
= rows
;
1280 chars_per_line
= cols
;
1282 /* Make sure Readline has initialized its terminal settings. */
1283 rl_reset_terminal (NULL
);
1285 /* Get the screen size from Readline. */
1286 rl_get_screen_size (&rows
, &cols
);
1287 lines_per_page
= rows
;
1288 chars_per_line
= cols
;
1290 /* Readline should have fetched the termcap entry for us.
1291 Only try to use tgetnum function if rl_get_screen_size
1292 did not return a useful value. */
1293 if (((rows
<= 0) && (tgetnum ((char *) "li") < 0))
1294 /* Also disable paging if inside Emacs. $EMACS was used
1295 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1296 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1298 /* The number of lines per page is not mentioned in the terminal
1299 description or EMACS evironment variable is set. This probably
1300 means that paging is not useful, so disable paging. */
1301 lines_per_page
= UINT_MAX
;
1304 /* If the output is not a terminal, don't paginate it. */
1305 if (!ui_file_isatty (gdb_stdout
))
1306 lines_per_page
= UINT_MAX
;
1310 /* We handle SIGWINCH ourselves. */
1311 rl_catch_sigwinch
= 0;
1317 /* Return nonzero if filtered printing is initialized. */
1319 filtered_printing_initialized (void)
1321 return filter_initialized
;
1324 set_batch_flag_and_restore_page_info::set_batch_flag_and_restore_page_info ()
1325 : m_save_lines_per_page (lines_per_page
),
1326 m_save_chars_per_line (chars_per_line
),
1327 m_save_batch_flag (batch_flag
)
1333 set_batch_flag_and_restore_page_info::~set_batch_flag_and_restore_page_info ()
1335 batch_flag
= m_save_batch_flag
;
1336 chars_per_line
= m_save_chars_per_line
;
1337 lines_per_page
= m_save_lines_per_page
;
1343 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1346 set_screen_size (void)
1348 int rows
= lines_per_page
;
1349 int cols
= chars_per_line
;
1351 /* If we get 0 or negative ROWS or COLS, treat as "infinite" size.
1352 A negative number can be seen here with the "set width/height"
1353 commands and either:
1355 - the user specified "unlimited", which maps to UINT_MAX, or
1356 - the user spedified some number between INT_MAX and UINT_MAX.
1358 Cap "infinity" to approximately sqrt(INT_MAX) so that we don't
1359 overflow in rl_set_screen_size, which multiplies rows and columns
1360 to compute the number of characters on the screen. */
1362 const int sqrt_int_max
= INT_MAX
>> (sizeof (int) * 8 / 2);
1364 if (rows
<= 0 || rows
> sqrt_int_max
)
1366 rows
= sqrt_int_max
;
1367 lines_per_page
= UINT_MAX
;
1370 if (cols
<= 0 || cols
> sqrt_int_max
)
1372 cols
= sqrt_int_max
;
1373 chars_per_line
= UINT_MAX
;
1376 /* Update Readline's idea of the terminal size. */
1377 rl_set_screen_size (rows
, cols
);
1380 /* Reinitialize WRAP_BUFFER. */
1385 if (chars_per_line
== 0)
1388 wrap_buffer
.clear ();
1389 filter_initialized
= true;
1393 set_width_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1400 set_height_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1408 set_screen_width_and_height (int width
, int height
)
1410 lines_per_page
= height
;
1411 chars_per_line
= width
;
1417 /* The currently applied style. */
1419 static ui_file_style applied_style
;
1421 /* Emit an ANSI style escape for STYLE. If STREAM is nullptr, emit to
1422 the wrap buffer; otherwise emit to STREAM. */
1425 emit_style_escape (const ui_file_style
&style
,
1426 struct ui_file
*stream
= nullptr)
1428 applied_style
= style
;
1430 if (stream
== nullptr)
1431 wrap_buffer
.append (style
.to_ansi ());
1433 fputs_unfiltered (style
.to_ansi ().c_str (), stream
);
1436 /* Set the current output style. This will affect future uses of the
1437 _filtered output functions. */
1440 set_output_style (struct ui_file
*stream
, const ui_file_style
&style
)
1442 if (!stream
->can_emit_style_escape ())
1445 /* Note that we don't pass STREAM here, because we want to emit to
1446 the wrap buffer, not directly to STREAM. */
1447 emit_style_escape (style
);
1453 reset_terminal_style (struct ui_file
*stream
)
1455 if (stream
->can_emit_style_escape ())
1457 /* Force the setting, regardless of what we think the setting
1458 might already be. */
1459 applied_style
= ui_file_style ();
1460 wrap_buffer
.append (applied_style
.to_ansi ());
1464 /* Wait, so the user can read what's on the screen. Prompt the user
1465 to continue by pressing RETURN. 'q' is also provided because
1466 telling users what to do in the prompt is more user-friendly than
1467 expecting them to think of Ctrl-C/SIGINT. */
1470 prompt_for_continue (void)
1472 char cont_prompt
[120];
1473 /* Used to add duration we waited for user to respond to
1474 prompt_for_continue_wait_time. */
1475 using namespace std::chrono
;
1476 steady_clock::time_point prompt_started
= steady_clock::now ();
1477 bool disable_pagination
= pagination_disabled_for_command
;
1479 /* Clear the current styling. */
1480 if (gdb_stdout
->can_emit_style_escape ())
1481 emit_style_escape (ui_file_style (), gdb_stdout
);
1483 if (annotation_level
> 1)
1484 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1486 strcpy (cont_prompt
,
1487 "--Type <RET> for more, q to quit, "
1488 "c to continue without paging--");
1489 if (annotation_level
> 1)
1490 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1492 /* We must do this *before* we call gdb_readline_wrapper, else it
1493 will eventually call us -- thinking that we're trying to print
1494 beyond the end of the screen. */
1495 reinitialize_more_filter ();
1497 scoped_input_handler prepare_input
;
1499 /* Call gdb_readline_wrapper, not readline, in order to keep an
1500 event loop running. */
1501 gdb::unique_xmalloc_ptr
<char> ignore (gdb_readline_wrapper (cont_prompt
));
1503 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1504 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1506 if (annotation_level
> 1)
1507 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1511 char *p
= ignore
.get ();
1513 while (*p
== ' ' || *p
== '\t')
1516 /* Do not call quit here; there is no possibility of SIGINT. */
1517 throw_quit ("Quit");
1519 disable_pagination
= true;
1522 /* Now we have to do this again, so that GDB will know that it doesn't
1523 need to save the ---Type <return>--- line at the top of the screen. */
1524 reinitialize_more_filter ();
1525 pagination_disabled_for_command
= disable_pagination
;
1527 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1530 /* Initialize timer to keep track of how long we waited for the user. */
1533 reset_prompt_for_continue_wait_time (void)
1535 using namespace std::chrono
;
1537 prompt_for_continue_wait_time
= steady_clock::duration::zero ();
1540 /* Fetch the cumulative time spent in prompt_for_continue. */
1542 std::chrono::steady_clock::duration
1543 get_prompt_for_continue_wait_time ()
1545 return prompt_for_continue_wait_time
;
1548 /* Reinitialize filter; ie. tell it to reset to original values. */
1551 reinitialize_more_filter (void)
1555 pagination_disabled_for_command
= false;
1558 /* Flush the wrap buffer to STREAM, if necessary. */
1561 flush_wrap_buffer (struct ui_file
*stream
)
1563 if (stream
== gdb_stdout
&& !wrap_buffer
.empty ())
1565 fputs_unfiltered (wrap_buffer
.c_str (), stream
);
1566 wrap_buffer
.clear ();
1570 /* Indicate that if the next sequence of characters overflows the line,
1571 a newline should be inserted here rather than when it hits the end.
1572 If INDENT is non-null, it is a string to be printed to indent the
1573 wrapped part on the next line. INDENT must remain accessible until
1574 the next call to wrap_here() or until a newline is printed through
1577 If the line is already overfull, we immediately print a newline and
1578 the indentation, and disable further wrapping.
1580 If we don't know the width of lines, but we know the page height,
1581 we must not wrap words, but should still keep track of newlines
1582 that were explicitly printed.
1584 INDENT should not contain tabs, as that will mess up the char count
1585 on the next line. FIXME.
1587 This routine is guaranteed to force out any output which has been
1588 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1589 used to force out output from the wrap_buffer. */
1592 wrap_here (const char *indent
)
1594 /* This should have been allocated, but be paranoid anyway. */
1595 if (!filter_initialized
)
1596 internal_error (__FILE__
, __LINE__
,
1597 _("failed internal consistency check"));
1599 flush_wrap_buffer (gdb_stdout
);
1600 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1604 else if (chars_printed
>= chars_per_line
)
1606 puts_filtered ("\n");
1608 puts_filtered (indent
);
1613 wrap_column
= chars_printed
;
1617 wrap_indent
= indent
;
1618 wrap_style
= applied_style
;
1622 /* Print input string to gdb_stdout, filtered, with wrap,
1623 arranging strings in columns of n chars. String can be
1624 right or left justified in the column. Never prints
1625 trailing spaces. String should never be longer than
1626 width. FIXME: this could be useful for the EXAMINE
1627 command, which currently doesn't tabulate very well. */
1630 puts_filtered_tabular (char *string
, int width
, int right
)
1636 gdb_assert (chars_per_line
> 0);
1637 if (chars_per_line
== UINT_MAX
)
1639 fputs_filtered (string
, gdb_stdout
);
1640 fputs_filtered ("\n", gdb_stdout
);
1644 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1645 fputs_filtered ("\n", gdb_stdout
);
1647 if (width
>= chars_per_line
)
1648 width
= chars_per_line
- 1;
1650 stringlen
= strlen (string
);
1652 if (chars_printed
> 0)
1653 spaces
= width
- (chars_printed
- 1) % width
- 1;
1655 spaces
+= width
- stringlen
;
1657 spacebuf
= (char *) alloca (spaces
+ 1);
1658 spacebuf
[spaces
] = '\0';
1660 spacebuf
[spaces
] = ' ';
1662 fputs_filtered (spacebuf
, gdb_stdout
);
1663 fputs_filtered (string
, gdb_stdout
);
1667 /* Ensure that whatever gets printed next, using the filtered output
1668 commands, starts at the beginning of the line. I.e. if there is
1669 any pending output for the current line, flush it and start a new
1670 line. Otherwise do nothing. */
1675 if (chars_printed
> 0)
1677 puts_filtered ("\n");
1682 /* Like fputs but if FILTER is true, pause after every screenful.
1684 Regardless of FILTER can wrap at points other than the final
1685 character of a line.
1687 Unlike fputs, fputs_maybe_filtered does not return a value.
1688 It is OK for LINEBUFFER to be NULL, in which case just don't print
1691 Note that a longjmp to top level may occur in this routine (only if
1692 FILTER is true) (since prompt_for_continue may do so) so this
1693 routine should not be called when cleanups are not in place. */
1696 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1699 const char *lineptr
;
1701 if (linebuffer
== 0)
1704 /* Don't do any filtering if it is disabled. */
1705 if (stream
!= gdb_stdout
1706 || !pagination_enabled
1707 || pagination_disabled_for_command
1709 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
1710 || top_level_interpreter () == NULL
1711 || top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
1713 flush_wrap_buffer (stream
);
1714 fputs_unfiltered (linebuffer
, stream
);
1719 = make_scope_exit ([&] ()
1721 wrap_buffer
.clear ();
1726 /* Go through and output each character. Show line extension
1727 when this is necessary; prompt user for new page when this is
1730 lineptr
= linebuffer
;
1733 /* Possible new page. Note that PAGINATION_DISABLED_FOR_COMMAND
1734 might be set during this loop, so we must continue to check
1736 if (filter
&& (lines_printed
>= lines_per_page
- 1)
1737 && !pagination_disabled_for_command
)
1738 prompt_for_continue ();
1740 while (*lineptr
&& *lineptr
!= '\n')
1744 /* Print a single line. */
1745 if (*lineptr
== '\t')
1747 wrap_buffer
.push_back ('\t');
1748 /* Shifting right by 3 produces the number of tab stops
1749 we have already passed, and then adding one and
1750 shifting left 3 advances to the next tab stop. */
1751 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
1754 else if (*lineptr
== '\033'
1755 && skip_ansi_escape (lineptr
, &skip_bytes
))
1757 wrap_buffer
.append (lineptr
, skip_bytes
);
1758 /* Note that we don't consider this a character, so we
1759 don't increment chars_printed here. */
1760 lineptr
+= skip_bytes
;
1764 wrap_buffer
.push_back (*lineptr
);
1769 if (chars_printed
>= chars_per_line
)
1771 unsigned int save_chars
= chars_printed
;
1773 /* If we change the style, below, we'll want to reset it
1774 before continuing to print. If there is no wrap
1775 column, then we'll only reset the style if the pager
1776 prompt is given; and to avoid emitting style
1777 sequences in the middle of a run of text, we track
1779 ui_file_style save_style
;
1780 bool did_paginate
= false;
1786 save_style
= wrap_style
;
1787 if (stream
->can_emit_style_escape ())
1788 emit_style_escape (ui_file_style (), stream
);
1789 /* If we aren't actually wrapping, don't output
1790 newline -- if chars_per_line is right, we
1791 probably just overflowed anyway; if it's wrong,
1792 let us keep going. */
1793 fputc_unfiltered ('\n', stream
);
1797 save_style
= applied_style
;
1798 flush_wrap_buffer (stream
);
1801 /* Possible new page. Note that
1802 PAGINATION_DISABLED_FOR_COMMAND might be set during
1803 this loop, so we must continue to check it here. */
1804 if (lines_printed
>= lines_per_page
- 1
1805 && !pagination_disabled_for_command
)
1807 prompt_for_continue ();
1808 did_paginate
= true;
1811 /* Now output indentation and wrapped string. */
1814 fputs_unfiltered (wrap_indent
, stream
);
1815 if (stream
->can_emit_style_escape ())
1816 emit_style_escape (save_style
, stream
);
1817 /* FIXME, this strlen is what prevents wrap_indent from
1818 containing tabs. However, if we recurse to print it
1819 and count its chars, we risk trouble if wrap_indent is
1820 longer than (the user settable) chars_per_line.
1821 Note also that this can set chars_printed > chars_per_line
1822 if we are printing a long string. */
1823 chars_printed
= strlen (wrap_indent
)
1824 + (save_chars
- wrap_column
);
1825 wrap_column
= 0; /* And disable fancy wrap */
1827 else if (did_paginate
&& stream
->can_emit_style_escape ())
1828 emit_style_escape (save_style
, stream
);
1832 if (*lineptr
== '\n')
1835 wrap_here ((char *) 0); /* Spit out chars, cancel
1838 fputc_unfiltered ('\n', stream
);
1843 buffer_clearer
.release ();
1847 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
1849 fputs_maybe_filtered (linebuffer
, stream
, 1);
1855 fputs_styled (const char *linebuffer
, const ui_file_style
&style
,
1856 struct ui_file
*stream
)
1858 /* This just makes it so we emit somewhat fewer escape
1860 if (style
.is_default ())
1861 fputs_maybe_filtered (linebuffer
, stream
, 1);
1864 set_output_style (stream
, style
);
1865 fputs_maybe_filtered (linebuffer
, stream
, 1);
1866 set_output_style (stream
, ui_file_style ());
1873 fputs_highlighted (const char *str
, const compiled_regex
&highlight
,
1874 struct ui_file
*stream
)
1878 while (*str
&& highlight
.exec (str
, 1, &pmatch
, 0) == 0)
1880 size_t n_highlight
= pmatch
.rm_eo
- pmatch
.rm_so
;
1882 /* Output the part before pmatch with current style. */
1883 while (pmatch
.rm_so
> 0)
1885 fputc_filtered (*str
, stream
);
1890 /* Output pmatch with the highlight style. */
1891 set_output_style (stream
, highlight_style
.style ());
1892 while (n_highlight
> 0)
1894 fputc_filtered (*str
, stream
);
1898 set_output_style (stream
, ui_file_style ());
1901 /* Output the trailing part of STR not matching HIGHLIGHT. */
1903 fputs_filtered (str
, stream
);
1907 putchar_unfiltered (int c
)
1911 ui_file_write (gdb_stdout
, &buf
, 1);
1915 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
1916 May return nonlocally. */
1919 putchar_filtered (int c
)
1921 return fputc_filtered (c
, gdb_stdout
);
1925 fputc_unfiltered (int c
, struct ui_file
*stream
)
1929 ui_file_write (stream
, &buf
, 1);
1934 fputc_filtered (int c
, struct ui_file
*stream
)
1940 fputs_filtered (buf
, stream
);
1944 /* puts_debug is like fputs_unfiltered, except it prints special
1945 characters in printable fashion. */
1948 puts_debug (char *prefix
, char *string
, char *suffix
)
1952 /* Print prefix and suffix after each line. */
1953 static int new_line
= 1;
1954 static int return_p
= 0;
1955 static const char *prev_prefix
= "";
1956 static const char *prev_suffix
= "";
1958 if (*string
== '\n')
1961 /* If the prefix is changing, print the previous suffix, a new line,
1962 and the new prefix. */
1963 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
1965 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
1966 fputs_unfiltered ("\n", gdb_stdlog
);
1967 fputs_unfiltered (prefix
, gdb_stdlog
);
1970 /* Print prefix if we printed a newline during the previous call. */
1974 fputs_unfiltered (prefix
, gdb_stdlog
);
1977 prev_prefix
= prefix
;
1978 prev_suffix
= suffix
;
1980 /* Output characters in a printable format. */
1981 while ((ch
= *string
++) != '\0')
1987 fputc_unfiltered (ch
, gdb_stdlog
);
1990 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
1994 fputs_unfiltered ("\\\\", gdb_stdlog
);
1997 fputs_unfiltered ("\\b", gdb_stdlog
);
2000 fputs_unfiltered ("\\f", gdb_stdlog
);
2004 fputs_unfiltered ("\\n", gdb_stdlog
);
2007 fputs_unfiltered ("\\r", gdb_stdlog
);
2010 fputs_unfiltered ("\\t", gdb_stdlog
);
2013 fputs_unfiltered ("\\v", gdb_stdlog
);
2017 return_p
= ch
== '\r';
2020 /* Print suffix if we printed a newline. */
2023 fputs_unfiltered (suffix
, gdb_stdlog
);
2024 fputs_unfiltered ("\n", gdb_stdlog
);
2029 /* Print a variable number of ARGS using format FORMAT. If this
2030 information is going to put the amount written (since the last call
2031 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2032 call prompt_for_continue to get the users permision to continue.
2034 Unlike fprintf, this function does not return a value.
2036 We implement three variants, vfprintf (takes a vararg list and stream),
2037 fprintf (takes a stream to write on), and printf (the usual).
2039 Note also that a longjmp to top level may occur in this routine
2040 (since prompt_for_continue may do so) so this routine should not be
2041 called when cleanups are not in place. */
2044 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2045 va_list args
, int filter
)
2047 std::string linebuffer
= string_vprintf (format
, args
);
2048 fputs_maybe_filtered (linebuffer
.c_str (), stream
, filter
);
2053 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2055 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2059 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2061 std::string linebuffer
= string_vprintf (format
, args
);
2062 if (debug_timestamp
&& stream
== gdb_stdlog
)
2064 using namespace std::chrono
;
2067 steady_clock::time_point now
= steady_clock::now ();
2068 seconds s
= duration_cast
<seconds
> (now
.time_since_epoch ());
2069 microseconds us
= duration_cast
<microseconds
> (now
.time_since_epoch () - s
);
2071 len
= linebuffer
.size ();
2072 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2074 std::string timestamp
= string_printf ("%ld.%06ld %s%s",
2077 linebuffer
.c_str (),
2078 need_nl
? "\n": "");
2079 fputs_unfiltered (timestamp
.c_str (), stream
);
2082 fputs_unfiltered (linebuffer
.c_str (), stream
);
2086 vprintf_filtered (const char *format
, va_list args
)
2088 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2092 vprintf_unfiltered (const char *format
, va_list args
)
2094 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2098 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2102 va_start (args
, format
);
2103 vfprintf_filtered (stream
, format
, args
);
2108 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2112 va_start (args
, format
);
2113 vfprintf_unfiltered (stream
, format
, args
);
2117 /* Like fprintf_filtered, but prints its result indented.
2118 Called as fprintfi_filtered (spaces, stream, format, ...); */
2121 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2126 va_start (args
, format
);
2127 print_spaces_filtered (spaces
, stream
);
2129 vfprintf_filtered (stream
, format
, args
);
2136 fprintf_styled (struct ui_file
*stream
, const ui_file_style
&style
,
2137 const char *format
, ...)
2141 set_output_style (stream
, style
);
2142 va_start (args
, format
);
2143 vfprintf_filtered (stream
, format
, args
);
2145 set_output_style (stream
, ui_file_style ());
2150 printf_filtered (const char *format
, ...)
2154 va_start (args
, format
);
2155 vfprintf_filtered (gdb_stdout
, format
, args
);
2161 printf_unfiltered (const char *format
, ...)
2165 va_start (args
, format
);
2166 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2170 /* Like printf_filtered, but prints it's result indented.
2171 Called as printfi_filtered (spaces, format, ...); */
2174 printfi_filtered (int spaces
, const char *format
, ...)
2178 va_start (args
, format
);
2179 print_spaces_filtered (spaces
, gdb_stdout
);
2180 vfprintf_filtered (gdb_stdout
, format
, args
);
2184 /* Easy -- but watch out!
2186 This routine is *not* a replacement for puts()! puts() appends a newline.
2187 This one doesn't, and had better not! */
2190 puts_filtered (const char *string
)
2192 fputs_filtered (string
, gdb_stdout
);
2196 puts_unfiltered (const char *string
)
2198 fputs_unfiltered (string
, gdb_stdout
);
2201 /* Return a pointer to N spaces and a null. The pointer is good
2202 until the next call to here. */
2207 static char *spaces
= 0;
2208 static int max_spaces
= -1;
2214 spaces
= (char *) xmalloc (n
+ 1);
2215 for (t
= spaces
+ n
; t
!= spaces
;)
2221 return spaces
+ max_spaces
- n
;
2224 /* Print N spaces. */
2226 print_spaces_filtered (int n
, struct ui_file
*stream
)
2228 fputs_filtered (n_spaces (n
), stream
);
2231 /* C++/ObjC demangler stuff. */
2233 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2234 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2235 If the name is not mangled, or the language for the name is unknown, or
2236 demangling is off, the name is printed in its "raw" form. */
2239 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2240 enum language lang
, int arg_mode
)
2246 /* If user wants to see raw output, no problem. */
2249 fputs_filtered (name
, stream
);
2253 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2254 fputs_filtered (demangled
? demangled
: name
, stream
);
2255 if (demangled
!= NULL
)
2263 /* True if CH is a character that can be part of a symbol name. I.e.,
2264 either a number, a letter, or a '_'. */
2267 valid_identifier_name_char (int ch
)
2269 return (isalnum (ch
) || ch
== '_');
2272 /* Skip to end of token, or to END, whatever comes first. Input is
2273 assumed to be a C++ operator name. */
2276 cp_skip_operator_token (const char *token
, const char *end
)
2278 const char *p
= token
;
2279 while (p
!= end
&& !isspace (*p
) && *p
!= '(')
2281 if (valid_identifier_name_char (*p
))
2283 while (p
!= end
&& valid_identifier_name_char (*p
))
2289 /* Note, ordered such that among ops that share a prefix,
2290 longer comes first. This is so that the loop below can
2291 bail on first match. */
2292 static const char *ops
[] =
2298 "-=", "--", "->", "-",
2307 "<<=", "<=", "<<", "<",
2308 ">>=", ">=", ">>", ">",
2312 for (const char *op
: ops
)
2314 size_t oplen
= strlen (op
);
2315 size_t lencmp
= std::min
<size_t> (oplen
, end
- p
);
2317 if (strncmp (p
, op
, lencmp
) == 0)
2320 /* Some unidentified character. Return it. */
2328 /* Advance STRING1/STRING2 past whitespace. */
2331 skip_ws (const char *&string1
, const char *&string2
, const char *end_str2
)
2333 while (isspace (*string1
))
2335 while (string2
< end_str2
&& isspace (*string2
))
2339 /* True if STRING points at the start of a C++ operator name. START
2340 is the start of the string that STRING points to, hence when
2341 reading backwards, we must not read any character before START. */
2344 cp_is_operator (const char *string
, const char *start
)
2346 return ((string
== start
2347 || !valid_identifier_name_char (string
[-1]))
2348 && strncmp (string
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
2349 && !valid_identifier_name_char (string
[CP_OPERATOR_LEN
]));
2352 /* If *NAME points at an ABI tag, skip it and return true. Otherwise
2353 leave *NAME unmodified and return false. (see GCC's abi_tag
2354 attribute), such names are demangled as e.g.,
2355 "function[abi:cxx11]()". */
2358 skip_abi_tag (const char **name
)
2360 const char *p
= *name
;
2362 if (startswith (p
, "[abi:"))
2366 while (valid_identifier_name_char (*p
))
2382 strncmp_iw_with_mode (const char *string1
, const char *string2
,
2383 size_t string2_len
, strncmp_iw_mode mode
,
2384 enum language language
,
2385 completion_match_for_lcd
*match_for_lcd
)
2387 const char *string1_start
= string1
;
2388 const char *end_str2
= string2
+ string2_len
;
2389 bool skip_spaces
= true;
2390 bool have_colon_op
= (language
== language_cplus
2391 || language
== language_rust
2392 || language
== language_fortran
);
2397 || ((isspace (*string1
) && !valid_identifier_name_char (*string2
))
2398 || (isspace (*string2
) && !valid_identifier_name_char (*string1
))))
2400 skip_ws (string1
, string2
, end_str2
);
2401 skip_spaces
= false;
2404 /* Skip [abi:cxx11] tags in the symbol name if the lookup name
2405 doesn't include them. E.g.:
2407 string1: function[abi:cxx1](int)
2410 string1: function[abi:cxx1](int)
2411 string2: function(int)
2413 string1: Struct[abi:cxx1]::function()
2414 string2: Struct::function()
2416 string1: function(Struct[abi:cxx1], int)
2417 string2: function(Struct, int)
2419 if (string2
== end_str2
2420 || (*string2
!= '[' && !valid_identifier_name_char (*string2
)))
2422 const char *abi_start
= string1
;
2424 /* There can be more than one tag. */
2425 while (*string1
== '[' && skip_abi_tag (&string1
))
2428 if (match_for_lcd
!= NULL
&& abi_start
!= string1
)
2429 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2431 while (isspace (*string1
))
2435 if (*string1
== '\0' || string2
== end_str2
)
2438 /* Handle the :: operator. */
2439 if (have_colon_op
&& string1
[0] == ':' && string1
[1] == ':')
2441 if (*string2
!= ':')
2447 if (string2
== end_str2
)
2450 if (*string2
!= ':')
2456 while (isspace (*string1
))
2458 while (string2
< end_str2
&& isspace (*string2
))
2463 /* Handle C++ user-defined operators. */
2464 else if (language
== language_cplus
2467 if (cp_is_operator (string1
, string1_start
))
2469 /* An operator name in STRING1. Check STRING2. */
2471 = std::min
<size_t> (CP_OPERATOR_LEN
, end_str2
- string2
);
2472 if (strncmp (string1
, string2
, cmplen
) != 0)
2478 if (string2
!= end_str2
)
2480 /* Check for "operatorX" in STRING2. */
2481 if (valid_identifier_name_char (*string2
))
2484 skip_ws (string1
, string2
, end_str2
);
2487 /* Handle operator(). */
2488 if (*string1
== '(')
2490 if (string2
== end_str2
)
2492 if (mode
== strncmp_iw_mode::NORMAL
)
2496 /* Don't break for the regular return at the
2497 bottom, because "operator" should not
2498 match "operator()", since this open
2499 parentheses is not the parameter list
2501 return *string1
!= '\0';
2505 if (*string1
!= *string2
)
2514 skip_ws (string1
, string2
, end_str2
);
2516 /* Skip to end of token, or to END, whatever comes
2518 const char *end_str1
= string1
+ strlen (string1
);
2519 const char *p1
= cp_skip_operator_token (string1
, end_str1
);
2520 const char *p2
= cp_skip_operator_token (string2
, end_str2
);
2522 cmplen
= std::min (p1
- string1
, p2
- string2
);
2525 if (strncmp (string1
, string2
, cmplen
) != 0)
2530 if (p1
- string1
!= p2
- string2
)
2532 if (strncmp (string1
, string2
, cmplen
) != 0)
2539 if (*string1
== '\0' || string2
== end_str2
)
2541 if (*string1
== '(' || *string2
== '(')
2549 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2551 if (case_sensitivity
== case_sensitive_off
2552 && (tolower ((unsigned char) *string1
)
2553 != tolower ((unsigned char) *string2
)))
2556 /* If we see any non-whitespace, non-identifier-name character
2557 (any of "()<>*&" etc.), then skip spaces the next time
2559 if (!isspace (*string1
) && !valid_identifier_name_char (*string1
))
2566 if (string2
== end_str2
)
2568 if (mode
== strncmp_iw_mode::NORMAL
)
2570 /* Strip abi tag markers from the matched symbol name.
2571 Usually the ABI marker will be found on function name
2572 (automatically added because the function returns an
2573 object marked with an ABI tag). However, it's also
2574 possible to see a marker in one of the function
2575 parameters, for example.
2577 string2 (lookup name):
2580 function(some_struct[abi:cxx11], int)
2582 and for completion LCD computation we want to say that
2584 function(some_struct, int)
2586 if (match_for_lcd
!= NULL
)
2588 while ((string1
= strstr (string1
, "[abi:")) != NULL
)
2590 const char *abi_start
= string1
;
2592 /* There can be more than one tag. */
2593 while (skip_abi_tag (&string1
) && *string1
== '[')
2596 if (abi_start
!= string1
)
2597 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2604 return (*string1
!= '\0' && *string1
!= '(');
2613 strncmp_iw (const char *string1
, const char *string2
, size_t string2_len
)
2615 return strncmp_iw_with_mode (string1
, string2
, string2_len
,
2616 strncmp_iw_mode::NORMAL
, language_minimal
);
2622 strcmp_iw (const char *string1
, const char *string2
)
2624 return strncmp_iw_with_mode (string1
, string2
, strlen (string2
),
2625 strncmp_iw_mode::MATCH_PARAMS
, language_minimal
);
2628 /* This is like strcmp except that it ignores whitespace and treats
2629 '(' as the first non-NULL character in terms of ordering. Like
2630 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2631 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2632 according to that ordering.
2634 If a list is sorted according to this function and if you want to
2635 find names in the list that match some fixed NAME according to
2636 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2637 where this function would put NAME.
2639 This function must be neutral to the CASE_SENSITIVITY setting as the user
2640 may choose it during later lookup. Therefore this function always sorts
2641 primarily case-insensitively and secondarily case-sensitively.
2643 Here are some examples of why using strcmp to sort is a bad idea:
2647 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2648 we try to do a search for "foo<char*>", strcmp will locate this
2649 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2650 will start looking at strings beginning with "goo", and will never
2651 see the correct match of "foo<char *>".
2653 Parenthesis example:
2655 In practice, this is less like to be an issue, but I'll give it a
2656 shot. Let's assume that '$' is a legitimate character to occur in
2657 symbols. (Which may well even be the case on some systems.) Then
2658 say that the partial symbol table contains "foo$" and "foo(int)".
2659 strcmp will put them in this order, since '$' < '('. Now, if the
2660 user searches for "foo", then strcmp will sort "foo" before "foo$".
2661 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2662 "foo") is false, so it won't proceed to the actual match of
2663 "foo(int)" with "foo". */
2666 strcmp_iw_ordered (const char *string1
, const char *string2
)
2668 const char *saved_string1
= string1
, *saved_string2
= string2
;
2669 enum case_sensitivity case_pass
= case_sensitive_off
;
2673 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2674 Provide stub characters if we are already at the end of one of the
2676 char c1
= 'X', c2
= 'X';
2678 while (*string1
!= '\0' && *string2
!= '\0')
2680 while (isspace (*string1
))
2682 while (isspace (*string2
))
2687 case case_sensitive_off
:
2688 c1
= tolower ((unsigned char) *string1
);
2689 c2
= tolower ((unsigned char) *string2
);
2691 case case_sensitive_on
:
2699 if (*string1
!= '\0')
2708 /* Characters are non-equal unless they're both '\0'; we want to
2709 make sure we get the comparison right according to our
2710 comparison in the cases where one of them is '\0' or '('. */
2712 if (*string2
== '\0')
2717 if (*string2
== '\0')
2722 if (*string2
== '\0' || *string2
== '(')
2731 if (case_pass
== case_sensitive_on
)
2734 /* Otherwise the strings were equal in case insensitive way, make
2735 a more fine grained comparison in a case sensitive way. */
2737 case_pass
= case_sensitive_on
;
2738 string1
= saved_string1
;
2739 string2
= saved_string2
;
2746 streq (const char *lhs
, const char *rhs
)
2748 return !strcmp (lhs
, rhs
);
2754 streq_hash (const void *lhs
, const void *rhs
)
2756 return streq ((const char *) lhs
, (const char *) rhs
);
2763 ** Answer whether string_to_compare is a full or partial match to
2764 ** template_string. The partial match must be in sequence starting
2768 subset_compare (const char *string_to_compare
, const char *template_string
)
2772 if (template_string
!= NULL
&& string_to_compare
!= NULL
2773 && strlen (string_to_compare
) <= strlen (template_string
))
2775 (startswith (template_string
, string_to_compare
));
2782 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2783 struct cmd_list_element
*c
, const char *value
)
2785 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2791 initialize_utils (void)
2793 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
2794 Set number of characters where GDB should wrap lines of its output."), _("\
2795 Show number of characters where GDB should wrap lines of its output."), _("\
2796 This affects where GDB wraps its output to fit the screen width.\n\
2797 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2799 show_chars_per_line
,
2800 &setlist
, &showlist
);
2802 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
2803 Set number of lines in a page for GDB output pagination."), _("\
2804 Show number of lines in a page for GDB output pagination."), _("\
2805 This affects the number of lines after which GDB will pause\n\
2806 its output and ask you whether to continue.\n\
2807 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2809 show_lines_per_page
,
2810 &setlist
, &showlist
);
2812 add_setshow_boolean_cmd ("pagination", class_support
,
2813 &pagination_enabled
, _("\
2814 Set state of GDB output pagination."), _("\
2815 Show state of GDB output pagination."), _("\
2816 When pagination is ON, GDB pauses at end of each screenful of\n\
2817 its output and asks you whether to continue.\n\
2818 Turning pagination off is an alternative to \"set height unlimited\"."),
2820 show_pagination_enabled
,
2821 &setlist
, &showlist
);
2823 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
2824 &sevenbit_strings
, _("\
2825 Set printing of 8-bit characters in strings as \\nnn."), _("\
2826 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
2828 show_sevenbit_strings
,
2829 &setprintlist
, &showprintlist
);
2831 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
2832 &debug_timestamp
, _("\
2833 Set timestamping of debugging messages."), _("\
2834 Show timestamping of debugging messages."), _("\
2835 When set, debugging messages will be marked with seconds and microseconds."),
2837 show_debug_timestamp
,
2838 &setdebuglist
, &showdebuglist
);
2844 address_significant (gdbarch
*gdbarch
, CORE_ADDR addr
)
2846 /* Clear insignificant bits of a target address and sign extend resulting
2847 address, avoiding shifts larger or equal than the width of a CORE_ADDR.
2848 The local variable ADDR_BIT stops the compiler reporting a shift overflow
2849 when it won't occur. Skip updating of target address if current target
2850 has not set gdbarch significant_addr_bit. */
2851 int addr_bit
= gdbarch_significant_addr_bit (gdbarch
);
2853 if (addr_bit
&& (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
)))
2855 CORE_ADDR sign
= (CORE_ADDR
) 1 << (addr_bit
- 1);
2856 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2857 addr
= (addr
^ sign
) - sign
;
2864 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2866 /* Truncate address to the size of a target address, avoiding shifts
2867 larger or equal than the width of a CORE_ADDR. The local
2868 variable ADDR_BIT stops the compiler reporting a shift overflow
2869 when it won't occur. */
2870 /* NOTE: This assumes that the significant address information is
2871 kept in the least significant bits of ADDR - the upper bits were
2872 either zero or sign extended. Should gdbarch_address_to_pointer or
2873 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2875 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2877 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2878 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2879 return hex_string (addr
);
2882 /* This function is described in "defs.h". */
2885 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2887 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2889 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2890 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2892 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2893 that returns the language localized string formatted to a width
2894 based on gdbarch_addr_bit. */
2896 return hex_string_custom (address
, 8);
2898 return hex_string_custom (address
, 16);
2901 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2904 core_addr_hash (const void *ap
)
2906 const CORE_ADDR
*addrp
= (const CORE_ADDR
*) ap
;
2911 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2914 core_addr_eq (const void *ap
, const void *bp
)
2916 const CORE_ADDR
*addr_ap
= (const CORE_ADDR
*) ap
;
2917 const CORE_ADDR
*addr_bp
= (const CORE_ADDR
*) bp
;
2919 return *addr_ap
== *addr_bp
;
2922 /* Convert a string back into a CORE_ADDR. */
2924 string_to_core_addr (const char *my_string
)
2928 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2930 /* Assume that it is in hex. */
2933 for (i
= 2; my_string
[i
] != '\0'; i
++)
2935 if (isdigit (my_string
[i
]))
2936 addr
= (my_string
[i
] - '0') + (addr
* 16);
2937 else if (isxdigit (my_string
[i
]))
2938 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2940 error (_("invalid hex \"%s\""), my_string
);
2945 /* Assume that it is in decimal. */
2948 for (i
= 0; my_string
[i
] != '\0'; i
++)
2950 if (isdigit (my_string
[i
]))
2951 addr
= (my_string
[i
] - '0') + (addr
* 10);
2953 error (_("invalid decimal \"%s\""), my_string
);
2963 gdb_realpath_check_trailer (const char *input
, const char *trailer
)
2965 gdb::unique_xmalloc_ptr
<char> result
= gdb_realpath (input
);
2967 size_t len
= strlen (result
.get ());
2968 size_t trail_len
= strlen (trailer
);
2970 SELF_CHECK (len
>= trail_len
2971 && strcmp (result
.get () + len
- trail_len
, trailer
) == 0);
2975 gdb_realpath_tests ()
2977 /* A file which contains a directory prefix. */
2978 gdb_realpath_check_trailer ("./xfullpath.exp", "/xfullpath.exp");
2979 /* A file which contains a directory prefix. */
2980 gdb_realpath_check_trailer ("../../defs.h", "/defs.h");
2981 /* A one-character filename. */
2982 gdb_realpath_check_trailer ("./a", "/a");
2983 /* A file in the root directory. */
2984 gdb_realpath_check_trailer ("/root_file_which_should_exist",
2985 "/root_file_which_should_exist");
2986 /* A file which does not have a directory prefix. */
2987 gdb_realpath_check_trailer ("xfullpath.exp", "xfullpath.exp");
2988 /* A one-char filename without any directory prefix. */
2989 gdb_realpath_check_trailer ("a", "a");
2990 /* An empty filename. */
2991 gdb_realpath_check_trailer ("", "");
2994 #endif /* GDB_SELF_TEST */
2996 /* Allocation function for the libiberty hash table which uses an
2997 obstack. The obstack is passed as DATA. */
3000 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
3002 size_t total
= size
* count
;
3003 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
3005 memset (ptr
, 0, total
);
3009 /* Trivial deallocation function for the libiberty splay tree and hash
3010 table - don't deallocate anything. Rely on later deletion of the
3011 obstack. DATA will be the obstack, although it is not needed
3015 dummy_obstack_deallocate (void *object
, void *data
)
3020 /* Simple, portable version of dirname that does not modify its
3024 ldirname (const char *filename
)
3026 std::string dirname
;
3027 const char *base
= lbasename (filename
);
3029 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
3032 if (base
== filename
)
3035 dirname
= std::string (filename
, base
- filename
);
3037 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3038 create "d:./bar" later instead of the (different) "d:/bar". */
3039 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3040 && !IS_DIR_SEPARATOR (filename
[0]))
3041 dirname
[base
++ - filename
] = '.';
3049 gdb_argv::reset (const char *s
)
3051 char **argv
= buildargv (s
);
3053 if (s
!= NULL
&& argv
== NULL
)
3061 compare_positive_ints (const void *ap
, const void *bp
)
3063 /* Because we know we're comparing two ints which are positive,
3064 there's no danger of overflow here. */
3065 return * (int *) ap
- * (int *) bp
;
3068 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3069 #define AMBIGUOUS_MESS2 \
3070 ".\nUse \"set gnutarget format-name\" to specify the format."
3073 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3077 /* Check if errmsg just need simple return. */
3078 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3079 return bfd_errmsg (error_tag
);
3081 std::string
ret (bfd_errmsg (error_tag
));
3082 ret
+= AMBIGUOUS_MESS1
;
3084 for (p
= matching
; *p
; p
++)
3089 ret
+= AMBIGUOUS_MESS2
;
3096 /* Return ARGS parsed as a valid pid, or throw an error. */
3099 parse_pid_to_attach (const char *args
)
3105 error_no_arg (_("process-id to attach"));
3107 dummy
= (char *) args
;
3108 pid
= strtoul (args
, &dummy
, 0);
3109 /* Some targets don't set errno on errors, grrr! */
3110 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3111 error (_("Illegal process-id: %s."), args
);
3116 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3117 must come from xrealloc-compatible allocator and it may be updated. FROM
3118 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3119 located at the start or end of *STRINGP. */
3122 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3124 char *string
= *stringp
, *s
;
3125 const size_t from_len
= strlen (from
);
3126 const size_t to_len
= strlen (to
);
3130 s
= strstr (s
, from
);
3134 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3135 || s
[-1] == DIRNAME_SEPARATOR
)
3136 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3137 || s
[from_len
] == DIRNAME_SEPARATOR
))
3142 = (char *) xrealloc (string
, (strlen (string
) + to_len
+ 1));
3144 /* Relocate the current S pointer. */
3145 s
= s
- string
+ string_new
;
3146 string
= string_new
;
3148 /* Replace from by to. */
3149 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3150 memcpy (s
, to
, to_len
);
3165 /* SIGALRM handler for waitpid_with_timeout. */
3168 sigalrm_handler (int signo
)
3170 /* Nothing to do. */
3175 /* Wrapper to wait for child PID to die with TIMEOUT.
3176 TIMEOUT is the time to stop waiting in seconds.
3177 If TIMEOUT is zero, pass WNOHANG to waitpid.
3178 Returns PID if it was successfully waited for, otherwise -1.
3180 Timeouts are currently implemented with alarm and SIGALRM.
3181 If the host does not support them, this waits "forever".
3182 It would be odd though for a host to have waitpid and not SIGALRM. */
3185 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3187 pid_t waitpid_result
;
3189 gdb_assert (pid
> 0);
3190 gdb_assert (timeout
>= 0);
3195 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3196 struct sigaction sa
, old_sa
;
3198 sa
.sa_handler
= sigalrm_handler
;
3199 sigemptyset (&sa
.sa_mask
);
3201 sigaction (SIGALRM
, &sa
, &old_sa
);
3205 ofunc
= signal (SIGALRM
, sigalrm_handler
);
3211 waitpid_result
= waitpid (pid
, status
, 0);
3215 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3216 sigaction (SIGALRM
, &old_sa
, NULL
);
3218 signal (SIGALRM
, ofunc
);
3223 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3225 if (waitpid_result
== pid
)
3231 #endif /* HAVE_WAITPID */
3233 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3234 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3236 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3237 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3240 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3242 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3244 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3245 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3247 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3249 char *pattern_slash
, *string_slash
;
3251 /* Replace '\' by '/' in both strings. */
3253 pattern_slash
= (char *) alloca (strlen (pattern
) + 1);
3254 strcpy (pattern_slash
, pattern
);
3255 pattern
= pattern_slash
;
3256 for (; *pattern_slash
!= 0; pattern_slash
++)
3257 if (IS_DIR_SEPARATOR (*pattern_slash
))
3258 *pattern_slash
= '/';
3260 string_slash
= (char *) alloca (strlen (string
) + 1);
3261 strcpy (string_slash
, string
);
3262 string
= string_slash
;
3263 for (; *string_slash
!= 0; string_slash
++)
3264 if (IS_DIR_SEPARATOR (*string_slash
))
3265 *string_slash
= '/';
3267 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3269 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3270 flags
|= FNM_CASEFOLD
;
3271 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3273 return fnmatch (pattern
, string
, flags
);
3276 /* Return the number of path elements in PATH.
3284 count_path_elements (const char *path
)
3287 const char *p
= path
;
3289 if (HAS_DRIVE_SPEC (p
))
3291 p
= STRIP_DRIVE_SPEC (p
);
3297 if (IS_DIR_SEPARATOR (*p
))
3302 /* Backup one if last character is /, unless it's the only one. */
3303 if (p
> path
+ 1 && IS_DIR_SEPARATOR (p
[-1]))
3306 /* Add one for the file name, if present. */
3307 if (p
> path
&& !IS_DIR_SEPARATOR (p
[-1]))
3313 /* Remove N leading path elements from PATH.
3314 N must be non-negative.
3315 If PATH has more than N path elements then return NULL.
3316 If PATH has exactly N path elements then return "".
3317 See count_path_elements for a description of how we do the counting. */
3320 strip_leading_path_elements (const char *path
, int n
)
3323 const char *p
= path
;
3325 gdb_assert (n
>= 0);
3330 if (HAS_DRIVE_SPEC (p
))
3332 p
= STRIP_DRIVE_SPEC (p
);
3338 while (*p
!= '\0' && !IS_DIR_SEPARATOR (*p
))
3356 copy_bitwise (gdb_byte
*dest
, ULONGEST dest_offset
,
3357 const gdb_byte
*source
, ULONGEST source_offset
,
3358 ULONGEST nbits
, int bits_big_endian
)
3360 unsigned int buf
, avail
;
3365 if (bits_big_endian
)
3367 /* Start from the end, then work backwards. */
3368 dest_offset
+= nbits
- 1;
3369 dest
+= dest_offset
/ 8;
3370 dest_offset
= 7 - dest_offset
% 8;
3371 source_offset
+= nbits
- 1;
3372 source
+= source_offset
/ 8;
3373 source_offset
= 7 - source_offset
% 8;
3377 dest
+= dest_offset
/ 8;
3379 source
+= source_offset
/ 8;
3383 /* Fill BUF with DEST_OFFSET bits from the destination and 8 -
3384 SOURCE_OFFSET bits from the source. */
3385 buf
= *(bits_big_endian
? source
-- : source
++) >> source_offset
;
3386 buf
<<= dest_offset
;
3387 buf
|= *dest
& ((1 << dest_offset
) - 1);
3389 /* NBITS: bits yet to be written; AVAIL: BUF's fill level. */
3390 nbits
+= dest_offset
;
3391 avail
= dest_offset
+ 8 - source_offset
;
3393 /* Flush 8 bits from BUF, if appropriate. */
3394 if (nbits
>= 8 && avail
>= 8)
3396 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3402 /* Copy the middle part. */
3405 size_t len
= nbits
/ 8;
3407 /* Use a faster method for byte-aligned copies. */
3410 if (bits_big_endian
)
3414 memcpy (dest
+ 1, source
+ 1, len
);
3418 memcpy (dest
, source
, len
);
3427 buf
|= *(bits_big_endian
? source
-- : source
++) << avail
;
3428 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3435 /* Write the last byte. */
3439 buf
|= *source
<< avail
;
3441 buf
&= (1 << nbits
) - 1;
3442 *dest
= (*dest
& (~0 << nbits
)) | buf
;
3447 _initialize_utils (void)
3449 add_internal_problem_command (&internal_error_problem
);
3450 add_internal_problem_command (&internal_warning_problem
);
3451 add_internal_problem_command (&demangler_warning_problem
);
3454 selftests::register_test ("gdb_realpath", gdb_realpath_tests
);