1 /* General utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2019 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include "gdbsupport/gdb_wait.h"
23 #include "event-top.h"
24 #include "gdbthread.h"
27 #ifdef HAVE_SYS_RESOURCE_H
28 #include <sys/resource.h>
29 #endif /* HAVE_SYS_RESOURCE_H */
32 #include "tui/tui.h" /* For tui_get_command_dimension. */
44 #include "gdb-demangle.h"
45 #include "expression.h"
49 #include "filenames.h"
51 #include "gdb_obstack.h"
57 #include "inferior.h" /* for signed_pointer_to_address */
59 #include "gdb_curses.h"
61 #include "readline/readline.h"
66 #include "gdb_regex.h"
67 #include "gdbsupport/job-control.h"
68 #include "gdbsupport/selftest.h"
69 #include "gdbsupport/gdb_optional.h"
70 #include "cp-support.h"
72 #include "gdbsupport/pathstuff.h"
73 #include "cli/cli-style.h"
74 #include "gdbsupport/scope-exit.h"
77 void (*deprecated_error_begin_hook
) (void);
79 /* Prototypes for local functions */
81 static void vfprintf_maybe_filtered (struct ui_file
*, const char *,
82 va_list, int) ATTRIBUTE_PRINTF (2, 0);
84 static void fputs_maybe_filtered (const char *, struct ui_file
*, int);
86 static void prompt_for_continue (void);
88 static void set_screen_size (void);
89 static void set_width (void);
91 /* Time spent in prompt_for_continue in the currently executing command
92 waiting for user to respond.
93 Initialized in make_command_stats_cleanup.
94 Modified in prompt_for_continue and defaulted_query.
95 Used in report_command_stats. */
97 static std::chrono::steady_clock::duration prompt_for_continue_wait_time
;
99 /* A flag indicating whether to timestamp debugging messages. */
101 static bool debug_timestamp
= false;
103 /* True means that strings with character values >0x7F should be printed
104 as octal escapes. False means just print the value (e.g. it's an
105 international character, and the terminal or window can cope.) */
107 bool sevenbit_strings
= false;
109 show_sevenbit_strings (struct ui_file
*file
, int from_tty
,
110 struct cmd_list_element
*c
, const char *value
)
112 fprintf_filtered (file
, _("Printing of 8-bit characters "
113 "in strings as \\nnn is %s.\n"),
117 /* String to be printed before warning messages, if any. */
119 const char *warning_pre_print
= "\nwarning: ";
121 bool pagination_enabled
= true;
123 show_pagination_enabled (struct ui_file
*file
, int from_tty
,
124 struct cmd_list_element
*c
, const char *value
)
126 fprintf_filtered (file
, _("State of pagination is %s.\n"), value
);
132 /* Print a warning message. The first argument STRING is the warning
133 message, used as an fprintf format string, the second is the
134 va_list of arguments for that string. A warning is unfiltered (not
135 paginated) so that the user does not need to page through each
136 screen full of warnings when there are lots of them. */
139 vwarning (const char *string
, va_list args
)
141 if (deprecated_warning_hook
)
142 (*deprecated_warning_hook
) (string
, args
);
145 gdb::optional
<target_terminal::scoped_restore_terminal_state
> term_state
;
146 if (target_supports_terminal_ours ())
148 term_state
.emplace ();
149 target_terminal::ours_for_output ();
151 if (filtered_printing_initialized ())
152 wrap_here (""); /* Force out any buffered output. */
153 gdb_flush (gdb_stdout
);
154 if (warning_pre_print
)
155 fputs_unfiltered (warning_pre_print
, gdb_stderr
);
156 vfprintf_unfiltered (gdb_stderr
, string
, args
);
157 fprintf_unfiltered (gdb_stderr
, "\n");
161 /* Print an error message and return to command level.
162 The first argument STRING is the error message, used as a fprintf string,
163 and the remaining args are passed as arguments to it. */
166 verror (const char *string
, va_list args
)
168 throw_verror (GENERIC_ERROR
, string
, args
);
172 error_stream (const string_file
&stream
)
174 error (("%s"), stream
.c_str ());
177 /* Emit a message and abort. */
179 static void ATTRIBUTE_NORETURN
180 abort_with_message (const char *msg
)
182 if (current_ui
== NULL
)
185 fputs_unfiltered (msg
, gdb_stderr
);
187 abort (); /* NOTE: GDB has only three calls to abort(). */
190 /* Dump core trying to increase the core soft limit to hard limit first. */
195 #ifdef HAVE_SETRLIMIT
196 struct rlimit rlim
= { (rlim_t
) RLIM_INFINITY
, (rlim_t
) RLIM_INFINITY
};
198 setrlimit (RLIMIT_CORE
, &rlim
);
199 #endif /* HAVE_SETRLIMIT */
201 abort (); /* NOTE: GDB has only three calls to abort(). */
204 /* Check whether GDB will be able to dump core using the dump_core
205 function. Returns zero if GDB cannot or should not dump core.
206 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
207 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
210 can_dump_core (enum resource_limit_kind limit_kind
)
212 #ifdef HAVE_GETRLIMIT
215 /* Be quiet and assume we can dump if an error is returned. */
216 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
222 if (rlim
.rlim_cur
== 0)
227 if (rlim
.rlim_max
== 0)
230 #endif /* HAVE_GETRLIMIT */
235 /* Print a warning that we cannot dump core. */
238 warn_cant_dump_core (const char *reason
)
240 fprintf_unfiltered (gdb_stderr
,
241 _("%s\nUnable to dump core, use `ulimit -c"
242 " unlimited' before executing GDB next time.\n"),
246 /* Check whether GDB will be able to dump core using the dump_core
247 function, and print a warning if we cannot. */
250 can_dump_core_warn (enum resource_limit_kind limit_kind
,
253 int core_dump_allowed
= can_dump_core (limit_kind
);
255 if (!core_dump_allowed
)
256 warn_cant_dump_core (reason
);
258 return core_dump_allowed
;
261 /* Allow the user to configure the debugger behavior with respect to
262 what to do when an internal problem is detected. */
264 const char internal_problem_ask
[] = "ask";
265 const char internal_problem_yes
[] = "yes";
266 const char internal_problem_no
[] = "no";
267 static const char *const internal_problem_modes
[] =
269 internal_problem_ask
,
270 internal_problem_yes
,
275 /* Print a message reporting an internal error/warning. Ask the user
276 if they want to continue, dump core, or just exit. Return
277 something to indicate a quit. */
279 struct internal_problem
282 int user_settable_should_quit
;
283 const char *should_quit
;
284 int user_settable_should_dump_core
;
285 const char *should_dump_core
;
288 /* Report a problem, internal to GDB, to the user. Once the problem
289 has been reported, and assuming GDB didn't quit, the caller can
290 either allow execution to resume or throw an error. */
292 static void ATTRIBUTE_PRINTF (4, 0)
293 internal_vproblem (struct internal_problem
*problem
,
294 const char *file
, int line
, const char *fmt
, va_list ap
)
301 /* Don't allow infinite error/warning recursion. */
303 static const char msg
[] = "Recursive internal problem.\n";
312 abort_with_message (msg
);
315 /* Newer GLIBC versions put the warn_unused_result attribute
316 on write, but this is one of those rare cases where
317 ignoring the return value is correct. Casting to (void)
318 does not fix this problem. This is the solution suggested
319 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
320 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
321 abort (); /* NOTE: GDB has only three calls to abort(). */
326 /* Create a string containing the full error/warning message. Need
327 to call query with this full string, as otherwize the reason
328 (error/warning) and question become separated. Format using a
329 style similar to a compiler error message. Include extra detail
330 so that the user knows that they are living on the edge. */
332 std::string msg
= string_vprintf (fmt
, ap
);
333 reason
= string_printf ("%s:%d: %s: %s\n"
334 "A problem internal to GDB has been detected,\n"
335 "further debugging may prove unreliable.",
336 file
, line
, problem
->name
, msg
.c_str ());
339 /* Fall back to abort_with_message if gdb_stderr is not set up. */
340 if (current_ui
== NULL
)
342 fputs (reason
.c_str (), stderr
);
343 abort_with_message ("\n");
346 /* Try to get the message out and at the start of a new line. */
347 gdb::optional
<target_terminal::scoped_restore_terminal_state
> term_state
;
348 if (target_supports_terminal_ours ())
350 term_state
.emplace ();
351 target_terminal::ours_for_output ();
353 if (filtered_printing_initialized ())
356 /* Emit the message unless query will emit it below. */
357 if (problem
->should_quit
!= internal_problem_ask
359 || !filtered_printing_initialized ())
360 fprintf_unfiltered (gdb_stderr
, "%s\n", reason
.c_str ());
362 if (problem
->should_quit
== internal_problem_ask
)
364 /* Default (yes/batch case) is to quit GDB. When in batch mode
365 this lessens the likelihood of GDB going into an infinite
367 if (!confirm
|| !filtered_printing_initialized ())
370 quit_p
= query (_("%s\nQuit this debugging session? "),
373 else if (problem
->should_quit
== internal_problem_yes
)
375 else if (problem
->should_quit
== internal_problem_no
)
378 internal_error (__FILE__
, __LINE__
, _("bad switch"));
380 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr
);
381 if (REPORT_BUGS_TO
[0])
382 fprintf_unfiltered (gdb_stderr
, _(" For instructions, see:\n%s."),
384 fputs_unfiltered ("\n\n", gdb_stderr
);
386 if (problem
->should_dump_core
== internal_problem_ask
)
388 if (!can_dump_core_warn (LIMIT_MAX
, reason
.c_str ()))
390 else if (!filtered_printing_initialized ())
394 /* Default (yes/batch case) is to dump core. This leaves a GDB
395 `dropping' so that it is easier to see that something went
397 dump_core_p
= query (_("%s\nCreate a core file of GDB? "),
401 else if (problem
->should_dump_core
== internal_problem_yes
)
402 dump_core_p
= can_dump_core_warn (LIMIT_MAX
, reason
.c_str ());
403 else if (problem
->should_dump_core
== internal_problem_no
)
406 internal_error (__FILE__
, __LINE__
, _("bad switch"));
419 #ifdef HAVE_WORKING_FORK
429 static struct internal_problem internal_error_problem
= {
430 "internal-error", 1, internal_problem_ask
, 1, internal_problem_ask
434 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
436 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
437 throw_quit (_("Command aborted."));
440 static struct internal_problem internal_warning_problem
= {
441 "internal-warning", 1, internal_problem_ask
, 1, internal_problem_ask
445 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
447 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
450 static struct internal_problem demangler_warning_problem
= {
451 "demangler-warning", 1, internal_problem_ask
, 0, internal_problem_no
455 demangler_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
457 internal_vproblem (&demangler_warning_problem
, file
, line
, fmt
, ap
);
461 demangler_warning (const char *file
, int line
, const char *string
, ...)
465 va_start (ap
, string
);
466 demangler_vwarning (file
, line
, string
, ap
);
470 /* Dummy functions to keep add_prefix_cmd happy. */
473 set_internal_problem_cmd (const char *args
, int from_tty
)
478 show_internal_problem_cmd (const char *args
, int from_tty
)
482 /* When GDB reports an internal problem (error or warning) it gives
483 the user the opportunity to quit GDB and/or create a core file of
484 the current debug session. This function registers a few commands
485 that make it possible to specify that GDB should always or never
486 quit or create a core file, without asking. The commands look
489 maint set PROBLEM-NAME quit ask|yes|no
490 maint show PROBLEM-NAME quit
491 maint set PROBLEM-NAME corefile ask|yes|no
492 maint show PROBLEM-NAME corefile
494 Where PROBLEM-NAME is currently "internal-error" or
495 "internal-warning". */
498 add_internal_problem_command (struct internal_problem
*problem
)
500 struct cmd_list_element
**set_cmd_list
;
501 struct cmd_list_element
**show_cmd_list
;
505 set_cmd_list
= XNEW (struct cmd_list_element
*);
506 show_cmd_list
= XNEW (struct cmd_list_element
*);
507 *set_cmd_list
= NULL
;
508 *show_cmd_list
= NULL
;
510 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
513 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
516 add_prefix_cmd (problem
->name
,
517 class_maintenance
, set_internal_problem_cmd
, set_doc
,
519 concat ("maintenance set ", problem
->name
, " ",
521 0/*allow-unknown*/, &maintenance_set_cmdlist
);
523 add_prefix_cmd (problem
->name
,
524 class_maintenance
, show_internal_problem_cmd
, show_doc
,
526 concat ("maintenance show ", problem
->name
, " ",
528 0/*allow-unknown*/, &maintenance_show_cmdlist
);
530 if (problem
->user_settable_should_quit
)
532 set_doc
= xstrprintf (_("Set whether GDB should quit "
533 "when an %s is detected."),
535 show_doc
= xstrprintf (_("Show whether GDB will quit "
536 "when an %s is detected."),
538 add_setshow_enum_cmd ("quit", class_maintenance
,
539 internal_problem_modes
,
540 &problem
->should_quit
,
553 if (problem
->user_settable_should_dump_core
)
555 set_doc
= xstrprintf (_("Set whether GDB should create a core "
556 "file of GDB when %s is detected."),
558 show_doc
= xstrprintf (_("Show whether GDB will create a core "
559 "file of GDB when %s is detected."),
561 add_setshow_enum_cmd ("corefile", class_maintenance
,
562 internal_problem_modes
,
563 &problem
->should_dump_core
,
577 /* Return a newly allocated string, containing the PREFIX followed
578 by the system error message for errno (separated by a colon). */
581 perror_string (const char *prefix
)
585 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
)
634 err
= safe_strerror (errcode
);
635 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
636 strcpy (combined
, string
);
637 strcat (combined
, ": ");
638 strcat (combined
, err
);
640 /* We want anything which was printed on stdout to come out first, before
642 gdb_flush (gdb_stdout
);
643 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
646 /* Control C eventually causes this to be called, at a convenient time. */
651 if (sync_quit_force_run
)
653 sync_quit_force_run
= 0;
654 quit_force (NULL
, 0);
658 /* No steenking SIGINT will ever be coming our way when the
659 program is resumed. Don't lie. */
663 /* If there is no terminal switching for this target, then we can't
664 possibly get screwed by the lack of job control. */
665 || !target_supports_terminal_ours ())
668 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
677 if (sync_quit_force_run
)
684 /* Called when a memory allocation fails, with the number of bytes of
685 memory requested in SIZE. */
688 malloc_failure (long size
)
692 internal_error (__FILE__
, __LINE__
,
693 _("virtual memory exhausted: can't allocate %ld bytes."),
698 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
702 /* My replacement for the read system call.
703 Used like `read' but keeps going if `read' returns too soon. */
706 myread (int desc
, char *addr
, int len
)
713 val
= read (desc
, addr
, len
);
725 print_spaces (int n
, struct ui_file
*file
)
727 fputs_unfiltered (n_spaces (n
), file
);
730 /* Print a host address. */
733 gdb_print_host_address_1 (const void *addr
, struct ui_file
*stream
)
735 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
740 /* An RAII class that sets up to handle input and then tears down
741 during destruction. */
743 class scoped_input_handler
747 scoped_input_handler ()
748 : m_quit_handler (&quit_handler
, default_quit_handler
),
751 target_terminal::ours ();
752 ui_register_input_event_handler (current_ui
);
753 if (current_ui
->prompt_state
== PROMPT_BLOCKED
)
757 ~scoped_input_handler ()
760 ui_unregister_input_event_handler (m_ui
);
763 DISABLE_COPY_AND_ASSIGN (scoped_input_handler
);
767 /* Save and restore the terminal state. */
768 target_terminal::scoped_restore_terminal_state m_term_state
;
770 /* Save and restore the quit handler. */
771 scoped_restore_tmpl
<quit_handler_ftype
*> m_quit_handler
;
773 /* The saved UI, if non-NULL. */
779 /* This function supports the query, nquery, and yquery functions.
780 Ask user a y-or-n question and return 0 if answer is no, 1 if
781 answer is yes, or default the answer to the specified default
782 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
783 default answer, or '\0' for no default.
784 CTLSTR is the control string and should end in "? ". It should
785 not say how to answer, because we do that.
786 ARGS are the arguments passed along with the CTLSTR argument to
789 static int ATTRIBUTE_PRINTF (1, 0)
790 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
794 char def_answer
, not_def_answer
;
795 const char *y_string
, *n_string
;
797 /* Set up according to which answer is the default. */
802 not_def_answer
= 'N';
806 else if (defchar
== 'y')
810 not_def_answer
= 'N';
818 not_def_answer
= 'Y';
823 /* Automatically answer the default value if the user did not want
824 prompts or the command was issued with the server prefix. */
825 if (!confirm
|| server_command
)
828 /* If input isn't coming from the user directly, just say what
829 question we're asking, and then answer the default automatically. This
830 way, important error messages don't get lost when talking to GDB
832 if (current_ui
->instream
!= current_ui
->stdin_stream
833 || !input_interactive_p (current_ui
)
834 /* Restrict queries to the main UI. */
835 || current_ui
!= main_ui
)
837 target_terminal::scoped_restore_terminal_state term_state
;
838 target_terminal::ours_for_output ();
840 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
842 printf_filtered (_("(%s or %s) [answered %c; "
843 "input not from terminal]\n"),
844 y_string
, n_string
, def_answer
);
849 if (deprecated_query_hook
)
851 target_terminal::scoped_restore_terminal_state term_state
;
852 return deprecated_query_hook (ctlstr
, args
);
855 /* Format the question outside of the loop, to avoid reusing args. */
856 std::string question
= string_vprintf (ctlstr
, args
);
858 = string_printf (_("%s%s(%s or %s) %s"),
859 annotation_level
> 1 ? "\n\032\032pre-query\n" : "",
860 question
.c_str (), y_string
, n_string
,
861 annotation_level
> 1 ? "\n\032\032query\n" : "");
863 /* Used to add duration we waited for user to respond to
864 prompt_for_continue_wait_time. */
865 using namespace std::chrono
;
866 steady_clock::time_point prompt_started
= steady_clock::now ();
868 scoped_input_handler prepare_input
;
872 char *response
, answer
;
874 gdb_flush (gdb_stdout
);
875 response
= gdb_readline_wrapper (prompt
.c_str ());
877 if (response
== NULL
) /* C-d */
879 printf_filtered ("EOF [assumed %c]\n", def_answer
);
884 answer
= response
[0];
889 /* Check answer. For the non-default, the user must specify
890 the non-default explicitly. */
891 if (answer
== not_def_answer
)
896 /* Otherwise, if a default was specified, the user may either
897 specify the required input or have it default by entering
899 if (answer
== def_answer
900 || (defchar
!= '\0' && answer
== '\0'))
905 /* Invalid entries are not defaulted and require another selection. */
906 printf_filtered (_("Please answer %s or %s.\n"),
910 /* Add time spend in this routine to prompt_for_continue_wait_time. */
911 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
913 if (annotation_level
> 1)
914 printf_filtered (("\n\032\032post-query\n"));
919 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
920 answer is yes, or 0 if answer is defaulted.
921 Takes three args which are given to printf to print the question.
922 The first, a control string, should end in "? ".
923 It should not say how to answer, because we do that. */
926 nquery (const char *ctlstr
, ...)
931 va_start (args
, ctlstr
);
932 ret
= defaulted_query (ctlstr
, 'n', args
);
937 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
938 answer is yes, or 1 if answer is defaulted.
939 Takes three args which are given to printf to print the question.
940 The first, a control string, should end in "? ".
941 It should not say how to answer, because we do that. */
944 yquery (const char *ctlstr
, ...)
949 va_start (args
, ctlstr
);
950 ret
= defaulted_query (ctlstr
, 'y', args
);
955 /* Ask user a y-or-n question and return 1 iff answer is yes.
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 query (const char *ctlstr
, ...)
966 va_start (args
, ctlstr
);
967 ret
= defaulted_query (ctlstr
, '\0', args
);
972 /* A helper for parse_escape that converts a host character to a
973 target character. C is the host character. If conversion is
974 possible, then the target character is stored in *TARGET_C and the
975 function returns 1. Otherwise, the function returns 0. */
978 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
983 auto_obstack host_data
;
985 convert_between_encodings (target_charset (gdbarch
), host_charset (),
986 (gdb_byte
*) &the_char
, 1, 1,
987 &host_data
, translit_none
);
989 if (obstack_object_size (&host_data
) == 1)
992 *target_c
= *(char *) obstack_base (&host_data
);
998 /* Parse a C escape sequence. STRING_PTR points to a variable
999 containing a pointer to the string to parse. That pointer
1000 should point to the character after the \. That pointer
1001 is updated past the characters we use. The value of the
1002 escape sequence is returned.
1004 A negative value means the sequence \ newline was seen,
1005 which is supposed to be equivalent to nothing at all.
1007 If \ is followed by a null character, we return a negative
1008 value and leave the string pointer pointing at the null character.
1010 If \ is followed by 000, we return 0 and leave the string pointer
1011 after the zeros. A value of 0 does not mean end of string. */
1014 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1016 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1017 int c
= *(*string_ptr
)++;
1036 int i
= host_hex_value (c
);
1041 if (isdigit (c
) && c
!= '8' && c
!= '9')
1045 i
+= host_hex_value (c
);
1081 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1082 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1083 " which has no equivalent\nin the `%s' character set."),
1084 c
, c
, target_charset (gdbarch
));
1088 /* Print the character C on STREAM as part of the contents of a literal
1089 string whose delimiter is QUOTER. Note that this routine should only
1090 be called for printing things which are independent of the language
1091 of the program being debugged.
1093 printchar will normally escape backslashes and instances of QUOTER. If
1094 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1095 As a side effect, if you pass the backslash character as the QUOTER,
1096 printchar will escape backslashes as usual, but not any other quoting
1100 printchar (int c
, do_fputc_ftype do_fputc
, ui_file
*stream
, int quoter
)
1102 c
&= 0xFF; /* Avoid sign bit follies */
1104 if (c
< 0x20 || /* Low control chars */
1105 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1106 (sevenbit_strings
&& c
>= 0x80))
1107 { /* high order bit set */
1108 do_fputc ('\\', stream
);
1113 do_fputc ('n', stream
);
1116 do_fputc ('b', stream
);
1119 do_fputc ('t', stream
);
1122 do_fputc ('f', stream
);
1125 do_fputc ('r', stream
);
1128 do_fputc ('e', stream
);
1131 do_fputc ('a', stream
);
1135 do_fputc ('0' + ((c
>> 6) & 0x7), stream
);
1136 do_fputc ('0' + ((c
>> 3) & 0x7), stream
);
1137 do_fputc ('0' + ((c
>> 0) & 0x7), stream
);
1144 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1145 do_fputc ('\\', stream
);
1146 do_fputc (c
, stream
);
1150 /* Print the character C on STREAM as part of the contents of a
1151 literal string whose delimiter is QUOTER. Note that these routines
1152 should only be call for printing things which are independent of
1153 the language of the program being debugged. */
1156 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1159 printchar (*str
++, fputc_filtered
, stream
, quoter
);
1163 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1166 printchar (*str
++, fputc_unfiltered
, stream
, quoter
);
1170 fputstrn_filtered (const char *str
, int n
, int quoter
,
1171 struct ui_file
*stream
)
1173 for (int i
= 0; i
< n
; i
++)
1174 printchar (str
[i
], fputc_filtered
, stream
, quoter
);
1178 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1179 do_fputc_ftype do_fputc
, struct ui_file
*stream
)
1181 for (int i
= 0; i
< n
; i
++)
1182 printchar (str
[i
], do_fputc
, stream
, quoter
);
1186 /* Number of lines per page or UINT_MAX if paging is disabled. */
1187 static unsigned int lines_per_page
;
1189 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1190 struct cmd_list_element
*c
, const char *value
)
1192 fprintf_filtered (file
,
1193 _("Number of lines gdb thinks are in a page is %s.\n"),
1197 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1198 static unsigned int chars_per_line
;
1200 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1201 struct cmd_list_element
*c
, const char *value
)
1203 fprintf_filtered (file
,
1204 _("Number of characters gdb thinks "
1205 "are in a line is %s.\n"),
1209 /* Current count of lines printed on this page, chars on this line. */
1210 static unsigned int lines_printed
, chars_printed
;
1212 /* True if pagination is disabled for just one command. */
1214 static bool pagination_disabled_for_command
;
1216 /* Buffer and start column of buffered text, for doing smarter word-
1217 wrapping. When someone calls wrap_here(), we start buffering output
1218 that comes through fputs_filtered(). If we see a newline, we just
1219 spit it out and forget about the wrap_here(). If we see another
1220 wrap_here(), we spit it out and remember the newer one. If we see
1221 the end of the line, we spit out a newline, the indent, and then
1222 the buffered output. */
1224 static bool filter_initialized
= false;
1226 /* Contains characters which are waiting to be output (they have
1227 already been counted in chars_printed). */
1228 static std::string wrap_buffer
;
1230 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1232 static const char *wrap_indent
;
1234 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1235 is not in effect. */
1236 static int wrap_column
;
1238 /* The style applied at the time that wrap_here was called. */
1239 static ui_file_style wrap_style
;
1242 /* Initialize the number of lines per page and chars per line. */
1245 init_page_info (void)
1249 lines_per_page
= UINT_MAX
;
1250 chars_per_line
= UINT_MAX
;
1254 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1259 #if defined(__GO32__)
1260 rows
= ScreenRows ();
1261 cols
= ScreenCols ();
1262 lines_per_page
= rows
;
1263 chars_per_line
= cols
;
1265 /* Make sure Readline has initialized its terminal settings. */
1266 rl_reset_terminal (NULL
);
1268 /* Get the screen size from Readline. */
1269 rl_get_screen_size (&rows
, &cols
);
1270 lines_per_page
= rows
;
1271 chars_per_line
= cols
;
1273 /* Readline should have fetched the termcap entry for us.
1274 Only try to use tgetnum function if rl_get_screen_size
1275 did not return a useful value. */
1276 if (((rows
<= 0) && (tgetnum ((char *) "li") < 0))
1277 /* Also disable paging if inside Emacs. $EMACS was used
1278 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1279 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1281 /* The number of lines per page is not mentioned in the terminal
1282 description or EMACS evironment variable is set. This probably
1283 means that paging is not useful, so disable paging. */
1284 lines_per_page
= UINT_MAX
;
1287 /* If the output is not a terminal, don't paginate it. */
1288 if (!ui_file_isatty (gdb_stdout
))
1289 lines_per_page
= UINT_MAX
;
1293 /* We handle SIGWINCH ourselves. */
1294 rl_catch_sigwinch
= 0;
1300 /* Return nonzero if filtered printing is initialized. */
1302 filtered_printing_initialized (void)
1304 return filter_initialized
;
1307 set_batch_flag_and_restore_page_info::set_batch_flag_and_restore_page_info ()
1308 : m_save_lines_per_page (lines_per_page
),
1309 m_save_chars_per_line (chars_per_line
),
1310 m_save_batch_flag (batch_flag
)
1316 set_batch_flag_and_restore_page_info::~set_batch_flag_and_restore_page_info ()
1318 batch_flag
= m_save_batch_flag
;
1319 chars_per_line
= m_save_chars_per_line
;
1320 lines_per_page
= m_save_lines_per_page
;
1326 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1329 set_screen_size (void)
1331 int rows
= lines_per_page
;
1332 int cols
= chars_per_line
;
1334 /* If we get 0 or negative ROWS or COLS, treat as "infinite" size.
1335 A negative number can be seen here with the "set width/height"
1336 commands and either:
1338 - the user specified "unlimited", which maps to UINT_MAX, or
1339 - the user spedified some number between INT_MAX and UINT_MAX.
1341 Cap "infinity" to approximately sqrt(INT_MAX) so that we don't
1342 overflow in rl_set_screen_size, which multiplies rows and columns
1343 to compute the number of characters on the screen. */
1345 const int sqrt_int_max
= INT_MAX
>> (sizeof (int) * 8 / 2);
1347 if (rows
<= 0 || rows
> sqrt_int_max
)
1349 rows
= sqrt_int_max
;
1350 lines_per_page
= UINT_MAX
;
1353 if (cols
<= 0 || cols
> sqrt_int_max
)
1355 cols
= sqrt_int_max
;
1356 chars_per_line
= UINT_MAX
;
1359 /* Update Readline's idea of the terminal size. */
1360 rl_set_screen_size (rows
, cols
);
1363 /* Reinitialize WRAP_BUFFER. */
1368 if (chars_per_line
== 0)
1371 wrap_buffer
.clear ();
1372 filter_initialized
= true;
1376 set_width_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1383 set_height_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1391 set_screen_width_and_height (int width
, int height
)
1393 lines_per_page
= height
;
1394 chars_per_line
= width
;
1400 /* The currently applied style. */
1402 static ui_file_style applied_style
;
1404 /* Emit an ANSI style escape for STYLE. If STREAM is nullptr, emit to
1405 the wrap buffer; otherwise emit to STREAM. */
1408 emit_style_escape (const ui_file_style
&style
,
1409 struct ui_file
*stream
= nullptr)
1411 applied_style
= style
;
1413 if (stream
== nullptr)
1414 wrap_buffer
.append (style
.to_ansi ());
1416 fputs_unfiltered (style
.to_ansi ().c_str (), stream
);
1419 /* Set the current output style. This will affect future uses of the
1420 _filtered output functions. */
1423 set_output_style (struct ui_file
*stream
, const ui_file_style
&style
)
1425 if (!stream
->can_emit_style_escape ())
1428 /* Note that we may not pass STREAM here, when we want to emit to
1429 the wrap buffer, not directly to STREAM. */
1430 if (stream
== gdb_stdout
)
1432 emit_style_escape (style
, stream
);
1438 reset_terminal_style (struct ui_file
*stream
)
1440 if (stream
->can_emit_style_escape ())
1442 /* Force the setting, regardless of what we think the setting
1443 might already be. */
1444 applied_style
= ui_file_style ();
1445 wrap_buffer
.append (applied_style
.to_ansi ());
1449 /* Wait, so the user can read what's on the screen. Prompt the user
1450 to continue by pressing RETURN. 'q' is also provided because
1451 telling users what to do in the prompt is more user-friendly than
1452 expecting them to think of Ctrl-C/SIGINT. */
1455 prompt_for_continue (void)
1457 char cont_prompt
[120];
1458 /* Used to add duration we waited for user to respond to
1459 prompt_for_continue_wait_time. */
1460 using namespace std::chrono
;
1461 steady_clock::time_point prompt_started
= steady_clock::now ();
1462 bool disable_pagination
= pagination_disabled_for_command
;
1464 /* Clear the current styling. */
1465 if (gdb_stdout
->can_emit_style_escape ())
1466 emit_style_escape (ui_file_style (), gdb_stdout
);
1468 if (annotation_level
> 1)
1469 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1471 strcpy (cont_prompt
,
1472 "--Type <RET> for more, q to quit, "
1473 "c to continue without paging--");
1474 if (annotation_level
> 1)
1475 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1477 /* We must do this *before* we call gdb_readline_wrapper, else it
1478 will eventually call us -- thinking that we're trying to print
1479 beyond the end of the screen. */
1480 reinitialize_more_filter ();
1482 scoped_input_handler prepare_input
;
1484 /* Call gdb_readline_wrapper, not readline, in order to keep an
1485 event loop running. */
1486 gdb::unique_xmalloc_ptr
<char> ignore (gdb_readline_wrapper (cont_prompt
));
1488 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1489 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1491 if (annotation_level
> 1)
1492 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1496 char *p
= ignore
.get ();
1498 while (*p
== ' ' || *p
== '\t')
1501 /* Do not call quit here; there is no possibility of SIGINT. */
1502 throw_quit ("Quit");
1504 disable_pagination
= true;
1507 /* Now we have to do this again, so that GDB will know that it doesn't
1508 need to save the ---Type <return>--- line at the top of the screen. */
1509 reinitialize_more_filter ();
1510 pagination_disabled_for_command
= disable_pagination
;
1512 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1515 /* Initialize timer to keep track of how long we waited for the user. */
1518 reset_prompt_for_continue_wait_time (void)
1520 using namespace std::chrono
;
1522 prompt_for_continue_wait_time
= steady_clock::duration::zero ();
1525 /* Fetch the cumulative time spent in prompt_for_continue. */
1527 std::chrono::steady_clock::duration
1528 get_prompt_for_continue_wait_time ()
1530 return prompt_for_continue_wait_time
;
1533 /* Reinitialize filter; ie. tell it to reset to original values. */
1536 reinitialize_more_filter (void)
1540 pagination_disabled_for_command
= false;
1543 /* Flush the wrap buffer to STREAM, if necessary. */
1546 flush_wrap_buffer (struct ui_file
*stream
)
1548 if (stream
== gdb_stdout
&& !wrap_buffer
.empty ())
1550 fputs_unfiltered (wrap_buffer
.c_str (), stream
);
1551 wrap_buffer
.clear ();
1555 /* Indicate that if the next sequence of characters overflows the line,
1556 a newline should be inserted here rather than when it hits the end.
1557 If INDENT is non-null, it is a string to be printed to indent the
1558 wrapped part on the next line. INDENT must remain accessible until
1559 the next call to wrap_here() or until a newline is printed through
1562 If the line is already overfull, we immediately print a newline and
1563 the indentation, and disable further wrapping.
1565 If we don't know the width of lines, but we know the page height,
1566 we must not wrap words, but should still keep track of newlines
1567 that were explicitly printed.
1569 INDENT should not contain tabs, as that will mess up the char count
1570 on the next line. FIXME.
1572 This routine is guaranteed to force out any output which has been
1573 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1574 used to force out output from the wrap_buffer. */
1577 wrap_here (const char *indent
)
1579 /* This should have been allocated, but be paranoid anyway. */
1580 if (!filter_initialized
)
1581 internal_error (__FILE__
, __LINE__
,
1582 _("failed internal consistency check"));
1584 flush_wrap_buffer (gdb_stdout
);
1585 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1589 else if (chars_printed
>= chars_per_line
)
1591 puts_filtered ("\n");
1593 puts_filtered (indent
);
1598 wrap_column
= chars_printed
;
1602 wrap_indent
= indent
;
1603 wrap_style
= applied_style
;
1607 /* Print input string to gdb_stdout, filtered, with wrap,
1608 arranging strings in columns of n chars. String can be
1609 right or left justified in the column. Never prints
1610 trailing spaces. String should never be longer than
1611 width. FIXME: this could be useful for the EXAMINE
1612 command, which currently doesn't tabulate very well. */
1615 puts_filtered_tabular (char *string
, int width
, int right
)
1621 gdb_assert (chars_per_line
> 0);
1622 if (chars_per_line
== UINT_MAX
)
1624 fputs_filtered (string
, gdb_stdout
);
1625 fputs_filtered ("\n", gdb_stdout
);
1629 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1630 fputs_filtered ("\n", gdb_stdout
);
1632 if (width
>= chars_per_line
)
1633 width
= chars_per_line
- 1;
1635 stringlen
= strlen (string
);
1637 if (chars_printed
> 0)
1638 spaces
= width
- (chars_printed
- 1) % width
- 1;
1640 spaces
+= width
- stringlen
;
1642 spacebuf
= (char *) alloca (spaces
+ 1);
1643 spacebuf
[spaces
] = '\0';
1645 spacebuf
[spaces
] = ' ';
1647 fputs_filtered (spacebuf
, gdb_stdout
);
1648 fputs_filtered (string
, gdb_stdout
);
1652 /* Ensure that whatever gets printed next, using the filtered output
1653 commands, starts at the beginning of the line. I.e. if there is
1654 any pending output for the current line, flush it and start a new
1655 line. Otherwise do nothing. */
1660 if (chars_printed
> 0)
1662 puts_filtered ("\n");
1667 /* Like fputs but if FILTER is true, pause after every screenful.
1669 Regardless of FILTER can wrap at points other than the final
1670 character of a line.
1672 Unlike fputs, fputs_maybe_filtered does not return a value.
1673 It is OK for LINEBUFFER to be NULL, in which case just don't print
1676 Note that a longjmp to top level may occur in this routine (only if
1677 FILTER is true) (since prompt_for_continue may do so) so this
1678 routine should not be called when cleanups are not in place. */
1681 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1684 const char *lineptr
;
1686 if (linebuffer
== 0)
1689 /* Don't do any filtering if it is disabled. */
1690 if (stream
!= gdb_stdout
1691 || !pagination_enabled
1692 || pagination_disabled_for_command
1694 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
1695 || top_level_interpreter () == NULL
1696 || top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
1698 flush_wrap_buffer (stream
);
1699 fputs_unfiltered (linebuffer
, stream
);
1704 = make_scope_exit ([&] ()
1706 wrap_buffer
.clear ();
1711 /* Go through and output each character. Show line extension
1712 when this is necessary; prompt user for new page when this is
1715 lineptr
= linebuffer
;
1718 /* Possible new page. Note that PAGINATION_DISABLED_FOR_COMMAND
1719 might be set during this loop, so we must continue to check
1721 if (filter
&& (lines_printed
>= lines_per_page
- 1)
1722 && !pagination_disabled_for_command
)
1723 prompt_for_continue ();
1725 while (*lineptr
&& *lineptr
!= '\n')
1729 /* Print a single line. */
1730 if (*lineptr
== '\t')
1732 wrap_buffer
.push_back ('\t');
1733 /* Shifting right by 3 produces the number of tab stops
1734 we have already passed, and then adding one and
1735 shifting left 3 advances to the next tab stop. */
1736 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
1739 else if (*lineptr
== '\033'
1740 && skip_ansi_escape (lineptr
, &skip_bytes
))
1742 wrap_buffer
.append (lineptr
, skip_bytes
);
1743 /* Note that we don't consider this a character, so we
1744 don't increment chars_printed here. */
1745 lineptr
+= skip_bytes
;
1749 wrap_buffer
.push_back (*lineptr
);
1754 if (chars_printed
>= chars_per_line
)
1756 unsigned int save_chars
= chars_printed
;
1758 /* If we change the style, below, we'll want to reset it
1759 before continuing to print. If there is no wrap
1760 column, then we'll only reset the style if the pager
1761 prompt is given; and to avoid emitting style
1762 sequences in the middle of a run of text, we track
1764 ui_file_style save_style
;
1765 bool did_paginate
= false;
1771 save_style
= wrap_style
;
1772 if (stream
->can_emit_style_escape ())
1773 emit_style_escape (ui_file_style (), stream
);
1774 /* If we aren't actually wrapping, don't output
1775 newline -- if chars_per_line is right, we
1776 probably just overflowed anyway; if it's wrong,
1777 let us keep going. */
1778 fputc_unfiltered ('\n', stream
);
1782 save_style
= applied_style
;
1783 flush_wrap_buffer (stream
);
1786 /* Possible new page. Note that
1787 PAGINATION_DISABLED_FOR_COMMAND might be set during
1788 this loop, so we must continue to check it here. */
1789 if (lines_printed
>= lines_per_page
- 1
1790 && !pagination_disabled_for_command
)
1792 prompt_for_continue ();
1793 did_paginate
= true;
1796 /* Now output indentation and wrapped string. */
1799 fputs_unfiltered (wrap_indent
, stream
);
1800 if (stream
->can_emit_style_escape ())
1801 emit_style_escape (save_style
, stream
);
1802 /* FIXME, this strlen is what prevents wrap_indent from
1803 containing tabs. However, if we recurse to print it
1804 and count its chars, we risk trouble if wrap_indent is
1805 longer than (the user settable) chars_per_line.
1806 Note also that this can set chars_printed > chars_per_line
1807 if we are printing a long string. */
1808 chars_printed
= strlen (wrap_indent
)
1809 + (save_chars
- wrap_column
);
1810 wrap_column
= 0; /* And disable fancy wrap */
1812 else if (did_paginate
&& stream
->can_emit_style_escape ())
1813 emit_style_escape (save_style
, stream
);
1817 if (*lineptr
== '\n')
1820 wrap_here ((char *) 0); /* Spit out chars, cancel
1823 fputc_unfiltered ('\n', stream
);
1828 buffer_clearer
.release ();
1832 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
1834 fputs_maybe_filtered (linebuffer
, stream
, 1);
1840 fputs_styled (const char *linebuffer
, const ui_file_style
&style
,
1841 struct ui_file
*stream
)
1843 /* This just makes it so we emit somewhat fewer escape
1845 if (style
.is_default ())
1846 fputs_maybe_filtered (linebuffer
, stream
, 1);
1849 set_output_style (stream
, style
);
1850 fputs_maybe_filtered (linebuffer
, stream
, 1);
1851 set_output_style (stream
, ui_file_style ());
1858 fputs_highlighted (const char *str
, const compiled_regex
&highlight
,
1859 struct ui_file
*stream
)
1863 while (*str
&& highlight
.exec (str
, 1, &pmatch
, 0) == 0)
1865 size_t n_highlight
= pmatch
.rm_eo
- pmatch
.rm_so
;
1867 /* Output the part before pmatch with current style. */
1868 while (pmatch
.rm_so
> 0)
1870 fputc_filtered (*str
, stream
);
1875 /* Output pmatch with the highlight style. */
1876 set_output_style (stream
, highlight_style
.style ());
1877 while (n_highlight
> 0)
1879 fputc_filtered (*str
, stream
);
1883 set_output_style (stream
, ui_file_style ());
1886 /* Output the trailing part of STR not matching HIGHLIGHT. */
1888 fputs_filtered (str
, stream
);
1892 putchar_unfiltered (int c
)
1896 ui_file_write (gdb_stdout
, &buf
, 1);
1900 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
1901 May return nonlocally. */
1904 putchar_filtered (int c
)
1906 return fputc_filtered (c
, gdb_stdout
);
1910 fputc_unfiltered (int c
, struct ui_file
*stream
)
1914 ui_file_write (stream
, &buf
, 1);
1919 fputc_filtered (int c
, struct ui_file
*stream
)
1925 fputs_filtered (buf
, stream
);
1929 /* puts_debug is like fputs_unfiltered, except it prints special
1930 characters in printable fashion. */
1933 puts_debug (char *prefix
, char *string
, char *suffix
)
1937 /* Print prefix and suffix after each line. */
1938 static int new_line
= 1;
1939 static int return_p
= 0;
1940 static const char *prev_prefix
= "";
1941 static const char *prev_suffix
= "";
1943 if (*string
== '\n')
1946 /* If the prefix is changing, print the previous suffix, a new line,
1947 and the new prefix. */
1948 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
1950 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
1951 fputs_unfiltered ("\n", gdb_stdlog
);
1952 fputs_unfiltered (prefix
, gdb_stdlog
);
1955 /* Print prefix if we printed a newline during the previous call. */
1959 fputs_unfiltered (prefix
, gdb_stdlog
);
1962 prev_prefix
= prefix
;
1963 prev_suffix
= suffix
;
1965 /* Output characters in a printable format. */
1966 while ((ch
= *string
++) != '\0')
1972 fputc_unfiltered (ch
, gdb_stdlog
);
1975 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
1979 fputs_unfiltered ("\\\\", gdb_stdlog
);
1982 fputs_unfiltered ("\\b", gdb_stdlog
);
1985 fputs_unfiltered ("\\f", gdb_stdlog
);
1989 fputs_unfiltered ("\\n", gdb_stdlog
);
1992 fputs_unfiltered ("\\r", gdb_stdlog
);
1995 fputs_unfiltered ("\\t", gdb_stdlog
);
1998 fputs_unfiltered ("\\v", gdb_stdlog
);
2002 return_p
= ch
== '\r';
2005 /* Print suffix if we printed a newline. */
2008 fputs_unfiltered (suffix
, gdb_stdlog
);
2009 fputs_unfiltered ("\n", gdb_stdlog
);
2014 /* Print a variable number of ARGS using format FORMAT. If this
2015 information is going to put the amount written (since the last call
2016 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2017 call prompt_for_continue to get the users permision to continue.
2019 Unlike fprintf, this function does not return a value.
2021 We implement three variants, vfprintf (takes a vararg list and stream),
2022 fprintf (takes a stream to write on), and printf (the usual).
2024 Note also that a longjmp to top level may occur in this routine
2025 (since prompt_for_continue may do so) so this routine should not be
2026 called when cleanups are not in place. */
2029 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2030 va_list args
, int filter
)
2032 std::string linebuffer
= string_vprintf (format
, args
);
2033 fputs_maybe_filtered (linebuffer
.c_str (), stream
, filter
);
2038 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2040 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2044 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2046 std::string linebuffer
= string_vprintf (format
, args
);
2047 if (debug_timestamp
&& stream
== gdb_stdlog
)
2049 using namespace std::chrono
;
2052 steady_clock::time_point now
= steady_clock::now ();
2053 seconds s
= duration_cast
<seconds
> (now
.time_since_epoch ());
2054 microseconds us
= duration_cast
<microseconds
> (now
.time_since_epoch () - s
);
2056 len
= linebuffer
.size ();
2057 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2059 std::string timestamp
= string_printf ("%ld.%06ld %s%s",
2062 linebuffer
.c_str (),
2063 need_nl
? "\n": "");
2064 fputs_unfiltered (timestamp
.c_str (), stream
);
2067 fputs_unfiltered (linebuffer
.c_str (), stream
);
2071 vprintf_filtered (const char *format
, va_list args
)
2073 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2077 vprintf_unfiltered (const char *format
, va_list args
)
2079 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2083 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2087 va_start (args
, format
);
2088 vfprintf_filtered (stream
, format
, args
);
2093 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2097 va_start (args
, format
);
2098 vfprintf_unfiltered (stream
, format
, args
);
2102 /* Like fprintf_filtered, but prints its result indented.
2103 Called as fprintfi_filtered (spaces, stream, format, ...); */
2106 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2111 va_start (args
, format
);
2112 print_spaces_filtered (spaces
, stream
);
2114 vfprintf_filtered (stream
, format
, args
);
2121 fprintf_styled (struct ui_file
*stream
, const ui_file_style
&style
,
2122 const char *format
, ...)
2126 set_output_style (stream
, style
);
2127 va_start (args
, format
);
2128 vfprintf_filtered (stream
, format
, args
);
2130 set_output_style (stream
, ui_file_style ());
2135 printf_filtered (const char *format
, ...)
2139 va_start (args
, format
);
2140 vfprintf_filtered (gdb_stdout
, format
, args
);
2146 printf_unfiltered (const char *format
, ...)
2150 va_start (args
, format
);
2151 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2155 /* Like printf_filtered, but prints it's result indented.
2156 Called as printfi_filtered (spaces, format, ...); */
2159 printfi_filtered (int spaces
, const char *format
, ...)
2163 va_start (args
, format
);
2164 print_spaces_filtered (spaces
, gdb_stdout
);
2165 vfprintf_filtered (gdb_stdout
, format
, args
);
2169 /* Easy -- but watch out!
2171 This routine is *not* a replacement for puts()! puts() appends a newline.
2172 This one doesn't, and had better not! */
2175 puts_filtered (const char *string
)
2177 fputs_filtered (string
, gdb_stdout
);
2181 puts_unfiltered (const char *string
)
2183 fputs_unfiltered (string
, gdb_stdout
);
2186 /* Return a pointer to N spaces and a null. The pointer is good
2187 until the next call to here. */
2192 static char *spaces
= 0;
2193 static int max_spaces
= -1;
2199 spaces
= (char *) xmalloc (n
+ 1);
2200 for (t
= spaces
+ n
; t
!= spaces
;)
2206 return spaces
+ max_spaces
- n
;
2209 /* Print N spaces. */
2211 print_spaces_filtered (int n
, struct ui_file
*stream
)
2213 fputs_filtered (n_spaces (n
), stream
);
2216 /* C++/ObjC demangler stuff. */
2218 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2219 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2220 If the name is not mangled, or the language for the name is unknown, or
2221 demangling is off, the name is printed in its "raw" form. */
2224 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2225 enum language lang
, int arg_mode
)
2231 /* If user wants to see raw output, no problem. */
2234 fputs_filtered (name
, stream
);
2238 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2239 fputs_filtered (demangled
? demangled
: name
, stream
);
2240 if (demangled
!= NULL
)
2248 /* True if CH is a character that can be part of a symbol name. I.e.,
2249 either a number, a letter, or a '_'. */
2252 valid_identifier_name_char (int ch
)
2254 return (isalnum (ch
) || ch
== '_');
2257 /* Skip to end of token, or to END, whatever comes first. Input is
2258 assumed to be a C++ operator name. */
2261 cp_skip_operator_token (const char *token
, const char *end
)
2263 const char *p
= token
;
2264 while (p
!= end
&& !isspace (*p
) && *p
!= '(')
2266 if (valid_identifier_name_char (*p
))
2268 while (p
!= end
&& valid_identifier_name_char (*p
))
2274 /* Note, ordered such that among ops that share a prefix,
2275 longer comes first. This is so that the loop below can
2276 bail on first match. */
2277 static const char *ops
[] =
2283 "-=", "--", "->", "-",
2292 "<<=", "<=", "<<", "<",
2293 ">>=", ">=", ">>", ">",
2297 for (const char *op
: ops
)
2299 size_t oplen
= strlen (op
);
2300 size_t lencmp
= std::min
<size_t> (oplen
, end
- p
);
2302 if (strncmp (p
, op
, lencmp
) == 0)
2305 /* Some unidentified character. Return it. */
2313 /* Advance STRING1/STRING2 past whitespace. */
2316 skip_ws (const char *&string1
, const char *&string2
, const char *end_str2
)
2318 while (isspace (*string1
))
2320 while (string2
< end_str2
&& isspace (*string2
))
2324 /* True if STRING points at the start of a C++ operator name. START
2325 is the start of the string that STRING points to, hence when
2326 reading backwards, we must not read any character before START. */
2329 cp_is_operator (const char *string
, const char *start
)
2331 return ((string
== start
2332 || !valid_identifier_name_char (string
[-1]))
2333 && strncmp (string
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
2334 && !valid_identifier_name_char (string
[CP_OPERATOR_LEN
]));
2337 /* If *NAME points at an ABI tag, skip it and return true. Otherwise
2338 leave *NAME unmodified and return false. (see GCC's abi_tag
2339 attribute), such names are demangled as e.g.,
2340 "function[abi:cxx11]()". */
2343 skip_abi_tag (const char **name
)
2345 const char *p
= *name
;
2347 if (startswith (p
, "[abi:"))
2351 while (valid_identifier_name_char (*p
))
2367 strncmp_iw_with_mode (const char *string1
, const char *string2
,
2368 size_t string2_len
, strncmp_iw_mode mode
,
2369 enum language language
,
2370 completion_match_for_lcd
*match_for_lcd
)
2372 const char *string1_start
= string1
;
2373 const char *end_str2
= string2
+ string2_len
;
2374 bool skip_spaces
= true;
2375 bool have_colon_op
= (language
== language_cplus
2376 || language
== language_rust
2377 || language
== language_fortran
);
2382 || ((isspace (*string1
) && !valid_identifier_name_char (*string2
))
2383 || (isspace (*string2
) && !valid_identifier_name_char (*string1
))))
2385 skip_ws (string1
, string2
, end_str2
);
2386 skip_spaces
= false;
2389 /* Skip [abi:cxx11] tags in the symbol name if the lookup name
2390 doesn't include them. E.g.:
2392 string1: function[abi:cxx1](int)
2395 string1: function[abi:cxx1](int)
2396 string2: function(int)
2398 string1: Struct[abi:cxx1]::function()
2399 string2: Struct::function()
2401 string1: function(Struct[abi:cxx1], int)
2402 string2: function(Struct, int)
2404 if (string2
== end_str2
2405 || (*string2
!= '[' && !valid_identifier_name_char (*string2
)))
2407 const char *abi_start
= string1
;
2409 /* There can be more than one tag. */
2410 while (*string1
== '[' && skip_abi_tag (&string1
))
2413 if (match_for_lcd
!= NULL
&& abi_start
!= string1
)
2414 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2416 while (isspace (*string1
))
2420 if (*string1
== '\0' || string2
== end_str2
)
2423 /* Handle the :: operator. */
2424 if (have_colon_op
&& string1
[0] == ':' && string1
[1] == ':')
2426 if (*string2
!= ':')
2432 if (string2
== end_str2
)
2435 if (*string2
!= ':')
2441 while (isspace (*string1
))
2443 while (string2
< end_str2
&& isspace (*string2
))
2448 /* Handle C++ user-defined operators. */
2449 else if (language
== language_cplus
2452 if (cp_is_operator (string1
, string1_start
))
2454 /* An operator name in STRING1. Check STRING2. */
2456 = std::min
<size_t> (CP_OPERATOR_LEN
, end_str2
- string2
);
2457 if (strncmp (string1
, string2
, cmplen
) != 0)
2463 if (string2
!= end_str2
)
2465 /* Check for "operatorX" in STRING2. */
2466 if (valid_identifier_name_char (*string2
))
2469 skip_ws (string1
, string2
, end_str2
);
2472 /* Handle operator(). */
2473 if (*string1
== '(')
2475 if (string2
== end_str2
)
2477 if (mode
== strncmp_iw_mode::NORMAL
)
2481 /* Don't break for the regular return at the
2482 bottom, because "operator" should not
2483 match "operator()", since this open
2484 parentheses is not the parameter list
2486 return *string1
!= '\0';
2490 if (*string1
!= *string2
)
2499 skip_ws (string1
, string2
, end_str2
);
2501 /* Skip to end of token, or to END, whatever comes
2503 const char *end_str1
= string1
+ strlen (string1
);
2504 const char *p1
= cp_skip_operator_token (string1
, end_str1
);
2505 const char *p2
= cp_skip_operator_token (string2
, end_str2
);
2507 cmplen
= std::min (p1
- string1
, p2
- string2
);
2510 if (strncmp (string1
, string2
, cmplen
) != 0)
2515 if (p1
- string1
!= p2
- string2
)
2517 if (strncmp (string1
, string2
, cmplen
) != 0)
2524 if (*string1
== '\0' || string2
== end_str2
)
2526 if (*string1
== '(' || *string2
== '(')
2534 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2536 if (case_sensitivity
== case_sensitive_off
2537 && (tolower ((unsigned char) *string1
)
2538 != tolower ((unsigned char) *string2
)))
2541 /* If we see any non-whitespace, non-identifier-name character
2542 (any of "()<>*&" etc.), then skip spaces the next time
2544 if (!isspace (*string1
) && !valid_identifier_name_char (*string1
))
2551 if (string2
== end_str2
)
2553 if (mode
== strncmp_iw_mode::NORMAL
)
2555 /* Strip abi tag markers from the matched symbol name.
2556 Usually the ABI marker will be found on function name
2557 (automatically added because the function returns an
2558 object marked with an ABI tag). However, it's also
2559 possible to see a marker in one of the function
2560 parameters, for example.
2562 string2 (lookup name):
2565 function(some_struct[abi:cxx11], int)
2567 and for completion LCD computation we want to say that
2569 function(some_struct, int)
2571 if (match_for_lcd
!= NULL
)
2573 while ((string1
= strstr (string1
, "[abi:")) != NULL
)
2575 const char *abi_start
= string1
;
2577 /* There can be more than one tag. */
2578 while (skip_abi_tag (&string1
) && *string1
== '[')
2581 if (abi_start
!= string1
)
2582 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2589 return (*string1
!= '\0' && *string1
!= '(');
2598 strncmp_iw (const char *string1
, const char *string2
, size_t string2_len
)
2600 return strncmp_iw_with_mode (string1
, string2
, string2_len
,
2601 strncmp_iw_mode::NORMAL
, language_minimal
);
2607 strcmp_iw (const char *string1
, const char *string2
)
2609 return strncmp_iw_with_mode (string1
, string2
, strlen (string2
),
2610 strncmp_iw_mode::MATCH_PARAMS
, language_minimal
);
2613 /* This is like strcmp except that it ignores whitespace and treats
2614 '(' as the first non-NULL character in terms of ordering. Like
2615 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2616 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2617 according to that ordering.
2619 If a list is sorted according to this function and if you want to
2620 find names in the list that match some fixed NAME according to
2621 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2622 where this function would put NAME.
2624 This function must be neutral to the CASE_SENSITIVITY setting as the user
2625 may choose it during later lookup. Therefore this function always sorts
2626 primarily case-insensitively and secondarily case-sensitively.
2628 Here are some examples of why using strcmp to sort is a bad idea:
2632 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2633 we try to do a search for "foo<char*>", strcmp will locate this
2634 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2635 will start looking at strings beginning with "goo", and will never
2636 see the correct match of "foo<char *>".
2638 Parenthesis example:
2640 In practice, this is less like to be an issue, but I'll give it a
2641 shot. Let's assume that '$' is a legitimate character to occur in
2642 symbols. (Which may well even be the case on some systems.) Then
2643 say that the partial symbol table contains "foo$" and "foo(int)".
2644 strcmp will put them in this order, since '$' < '('. Now, if the
2645 user searches for "foo", then strcmp will sort "foo" before "foo$".
2646 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2647 "foo") is false, so it won't proceed to the actual match of
2648 "foo(int)" with "foo". */
2651 strcmp_iw_ordered (const char *string1
, const char *string2
)
2653 const char *saved_string1
= string1
, *saved_string2
= string2
;
2654 enum case_sensitivity case_pass
= case_sensitive_off
;
2658 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2659 Provide stub characters if we are already at the end of one of the
2661 char c1
= 'X', c2
= 'X';
2663 while (*string1
!= '\0' && *string2
!= '\0')
2665 while (isspace (*string1
))
2667 while (isspace (*string2
))
2672 case case_sensitive_off
:
2673 c1
= tolower ((unsigned char) *string1
);
2674 c2
= tolower ((unsigned char) *string2
);
2676 case case_sensitive_on
:
2684 if (*string1
!= '\0')
2693 /* Characters are non-equal unless they're both '\0'; we want to
2694 make sure we get the comparison right according to our
2695 comparison in the cases where one of them is '\0' or '('. */
2697 if (*string2
== '\0')
2702 if (*string2
== '\0')
2707 if (*string2
== '\0' || *string2
== '(')
2716 if (case_pass
== case_sensitive_on
)
2719 /* Otherwise the strings were equal in case insensitive way, make
2720 a more fine grained comparison in a case sensitive way. */
2722 case_pass
= case_sensitive_on
;
2723 string1
= saved_string1
;
2724 string2
= saved_string2
;
2731 streq (const char *lhs
, const char *rhs
)
2733 return !strcmp (lhs
, rhs
);
2739 streq_hash (const void *lhs
, const void *rhs
)
2741 return streq ((const char *) lhs
, (const char *) rhs
);
2748 ** Answer whether string_to_compare is a full or partial match to
2749 ** template_string. The partial match must be in sequence starting
2753 subset_compare (const char *string_to_compare
, const char *template_string
)
2757 if (template_string
!= NULL
&& string_to_compare
!= NULL
2758 && strlen (string_to_compare
) <= strlen (template_string
))
2760 (startswith (template_string
, string_to_compare
));
2767 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2768 struct cmd_list_element
*c
, const char *value
)
2770 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2778 address_significant (gdbarch
*gdbarch
, CORE_ADDR addr
)
2780 /* Clear insignificant bits of a target address and sign extend resulting
2781 address, avoiding shifts larger or equal than the width of a CORE_ADDR.
2782 The local variable ADDR_BIT stops the compiler reporting a shift overflow
2783 when it won't occur. Skip updating of target address if current target
2784 has not set gdbarch significant_addr_bit. */
2785 int addr_bit
= gdbarch_significant_addr_bit (gdbarch
);
2787 if (addr_bit
&& (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
)))
2789 CORE_ADDR sign
= (CORE_ADDR
) 1 << (addr_bit
- 1);
2790 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2791 addr
= (addr
^ sign
) - sign
;
2798 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2800 /* Truncate address to the size of a target address, avoiding shifts
2801 larger or equal than the width of a CORE_ADDR. The local
2802 variable ADDR_BIT stops the compiler reporting a shift overflow
2803 when it won't occur. */
2804 /* NOTE: This assumes that the significant address information is
2805 kept in the least significant bits of ADDR - the upper bits were
2806 either zero or sign extended. Should gdbarch_address_to_pointer or
2807 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2809 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2811 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2812 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2813 return hex_string (addr
);
2816 /* This function is described in "defs.h". */
2819 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2821 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2823 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2824 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2826 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2827 that returns the language localized string formatted to a width
2828 based on gdbarch_addr_bit. */
2830 return hex_string_custom (address
, 8);
2832 return hex_string_custom (address
, 16);
2835 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2838 core_addr_hash (const void *ap
)
2840 const CORE_ADDR
*addrp
= (const CORE_ADDR
*) ap
;
2845 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2848 core_addr_eq (const void *ap
, const void *bp
)
2850 const CORE_ADDR
*addr_ap
= (const CORE_ADDR
*) ap
;
2851 const CORE_ADDR
*addr_bp
= (const CORE_ADDR
*) bp
;
2853 return *addr_ap
== *addr_bp
;
2856 /* Convert a string back into a CORE_ADDR. */
2858 string_to_core_addr (const char *my_string
)
2862 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2864 /* Assume that it is in hex. */
2867 for (i
= 2; my_string
[i
] != '\0'; i
++)
2869 if (isdigit (my_string
[i
]))
2870 addr
= (my_string
[i
] - '0') + (addr
* 16);
2871 else if (isxdigit (my_string
[i
]))
2872 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2874 error (_("invalid hex \"%s\""), my_string
);
2879 /* Assume that it is in decimal. */
2882 for (i
= 0; my_string
[i
] != '\0'; i
++)
2884 if (isdigit (my_string
[i
]))
2885 addr
= (my_string
[i
] - '0') + (addr
* 10);
2887 error (_("invalid decimal \"%s\""), my_string
);
2897 gdb_realpath_check_trailer (const char *input
, const char *trailer
)
2899 gdb::unique_xmalloc_ptr
<char> result
= gdb_realpath (input
);
2901 size_t len
= strlen (result
.get ());
2902 size_t trail_len
= strlen (trailer
);
2904 SELF_CHECK (len
>= trail_len
2905 && strcmp (result
.get () + len
- trail_len
, trailer
) == 0);
2909 gdb_realpath_tests ()
2911 /* A file which contains a directory prefix. */
2912 gdb_realpath_check_trailer ("./xfullpath.exp", "/xfullpath.exp");
2913 /* A file which contains a directory prefix. */
2914 gdb_realpath_check_trailer ("../../defs.h", "/defs.h");
2915 /* A one-character filename. */
2916 gdb_realpath_check_trailer ("./a", "/a");
2917 /* A file in the root directory. */
2918 gdb_realpath_check_trailer ("/root_file_which_should_exist",
2919 "/root_file_which_should_exist");
2920 /* A file which does not have a directory prefix. */
2921 gdb_realpath_check_trailer ("xfullpath.exp", "xfullpath.exp");
2922 /* A one-char filename without any directory prefix. */
2923 gdb_realpath_check_trailer ("a", "a");
2924 /* An empty filename. */
2925 gdb_realpath_check_trailer ("", "");
2928 #endif /* GDB_SELF_TEST */
2930 /* Allocation function for the libiberty hash table which uses an
2931 obstack. The obstack is passed as DATA. */
2934 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
2936 size_t total
= size
* count
;
2937 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
2939 memset (ptr
, 0, total
);
2943 /* Trivial deallocation function for the libiberty splay tree and hash
2944 table - don't deallocate anything. Rely on later deletion of the
2945 obstack. DATA will be the obstack, although it is not needed
2949 dummy_obstack_deallocate (void *object
, void *data
)
2954 /* Simple, portable version of dirname that does not modify its
2958 ldirname (const char *filename
)
2960 std::string dirname
;
2961 const char *base
= lbasename (filename
);
2963 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
2966 if (base
== filename
)
2969 dirname
= std::string (filename
, base
- filename
);
2971 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
2972 create "d:./bar" later instead of the (different) "d:/bar". */
2973 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
2974 && !IS_DIR_SEPARATOR (filename
[0]))
2975 dirname
[base
++ - filename
] = '.';
2983 gdb_argv::reset (const char *s
)
2985 char **argv
= buildargv (s
);
2987 if (s
!= NULL
&& argv
== NULL
)
2995 compare_positive_ints (const void *ap
, const void *bp
)
2997 /* Because we know we're comparing two ints which are positive,
2998 there's no danger of overflow here. */
2999 return * (int *) ap
- * (int *) bp
;
3002 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3003 #define AMBIGUOUS_MESS2 \
3004 ".\nUse \"set gnutarget format-name\" to specify the format."
3007 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3011 /* Check if errmsg just need simple return. */
3012 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3013 return bfd_errmsg (error_tag
);
3015 std::string
ret (bfd_errmsg (error_tag
));
3016 ret
+= AMBIGUOUS_MESS1
;
3018 for (p
= matching
; *p
; p
++)
3023 ret
+= AMBIGUOUS_MESS2
;
3030 /* Return ARGS parsed as a valid pid, or throw an error. */
3033 parse_pid_to_attach (const char *args
)
3039 error_no_arg (_("process-id to attach"));
3041 dummy
= (char *) args
;
3042 pid
= strtoul (args
, &dummy
, 0);
3043 /* Some targets don't set errno on errors, grrr! */
3044 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3045 error (_("Illegal process-id: %s."), args
);
3050 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3051 must come from xrealloc-compatible allocator and it may be updated. FROM
3052 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3053 located at the start or end of *STRINGP. */
3056 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3058 char *string
= *stringp
, *s
;
3059 const size_t from_len
= strlen (from
);
3060 const size_t to_len
= strlen (to
);
3064 s
= strstr (s
, from
);
3068 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3069 || s
[-1] == DIRNAME_SEPARATOR
)
3070 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3071 || s
[from_len
] == DIRNAME_SEPARATOR
))
3076 = (char *) xrealloc (string
, (strlen (string
) + to_len
+ 1));
3078 /* Relocate the current S pointer. */
3079 s
= s
- string
+ string_new
;
3080 string
= string_new
;
3082 /* Replace from by to. */
3083 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3084 memcpy (s
, to
, to_len
);
3099 /* SIGALRM handler for waitpid_with_timeout. */
3102 sigalrm_handler (int signo
)
3104 /* Nothing to do. */
3109 /* Wrapper to wait for child PID to die with TIMEOUT.
3110 TIMEOUT is the time to stop waiting in seconds.
3111 If TIMEOUT is zero, pass WNOHANG to waitpid.
3112 Returns PID if it was successfully waited for, otherwise -1.
3114 Timeouts are currently implemented with alarm and SIGALRM.
3115 If the host does not support them, this waits "forever".
3116 It would be odd though for a host to have waitpid and not SIGALRM. */
3119 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3121 pid_t waitpid_result
;
3123 gdb_assert (pid
> 0);
3124 gdb_assert (timeout
>= 0);
3129 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3130 struct sigaction sa
, old_sa
;
3132 sa
.sa_handler
= sigalrm_handler
;
3133 sigemptyset (&sa
.sa_mask
);
3135 sigaction (SIGALRM
, &sa
, &old_sa
);
3139 ofunc
= signal (SIGALRM
, sigalrm_handler
);
3145 waitpid_result
= waitpid (pid
, status
, 0);
3149 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3150 sigaction (SIGALRM
, &old_sa
, NULL
);
3152 signal (SIGALRM
, ofunc
);
3157 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3159 if (waitpid_result
== pid
)
3165 #endif /* HAVE_WAITPID */
3167 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3168 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3170 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3171 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3174 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3176 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3178 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3179 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3181 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3183 char *pattern_slash
, *string_slash
;
3185 /* Replace '\' by '/' in both strings. */
3187 pattern_slash
= (char *) alloca (strlen (pattern
) + 1);
3188 strcpy (pattern_slash
, pattern
);
3189 pattern
= pattern_slash
;
3190 for (; *pattern_slash
!= 0; pattern_slash
++)
3191 if (IS_DIR_SEPARATOR (*pattern_slash
))
3192 *pattern_slash
= '/';
3194 string_slash
= (char *) alloca (strlen (string
) + 1);
3195 strcpy (string_slash
, string
);
3196 string
= string_slash
;
3197 for (; *string_slash
!= 0; string_slash
++)
3198 if (IS_DIR_SEPARATOR (*string_slash
))
3199 *string_slash
= '/';
3201 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3203 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3204 flags
|= FNM_CASEFOLD
;
3205 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3207 return fnmatch (pattern
, string
, flags
);
3210 /* Return the number of path elements in PATH.
3218 count_path_elements (const char *path
)
3221 const char *p
= path
;
3223 if (HAS_DRIVE_SPEC (p
))
3225 p
= STRIP_DRIVE_SPEC (p
);
3231 if (IS_DIR_SEPARATOR (*p
))
3236 /* Backup one if last character is /, unless it's the only one. */
3237 if (p
> path
+ 1 && IS_DIR_SEPARATOR (p
[-1]))
3240 /* Add one for the file name, if present. */
3241 if (p
> path
&& !IS_DIR_SEPARATOR (p
[-1]))
3247 /* Remove N leading path elements from PATH.
3248 N must be non-negative.
3249 If PATH has more than N path elements then return NULL.
3250 If PATH has exactly N path elements then return "".
3251 See count_path_elements for a description of how we do the counting. */
3254 strip_leading_path_elements (const char *path
, int n
)
3257 const char *p
= path
;
3259 gdb_assert (n
>= 0);
3264 if (HAS_DRIVE_SPEC (p
))
3266 p
= STRIP_DRIVE_SPEC (p
);
3272 while (*p
!= '\0' && !IS_DIR_SEPARATOR (*p
))
3290 copy_bitwise (gdb_byte
*dest
, ULONGEST dest_offset
,
3291 const gdb_byte
*source
, ULONGEST source_offset
,
3292 ULONGEST nbits
, int bits_big_endian
)
3294 unsigned int buf
, avail
;
3299 if (bits_big_endian
)
3301 /* Start from the end, then work backwards. */
3302 dest_offset
+= nbits
- 1;
3303 dest
+= dest_offset
/ 8;
3304 dest_offset
= 7 - dest_offset
% 8;
3305 source_offset
+= nbits
- 1;
3306 source
+= source_offset
/ 8;
3307 source_offset
= 7 - source_offset
% 8;
3311 dest
+= dest_offset
/ 8;
3313 source
+= source_offset
/ 8;
3317 /* Fill BUF with DEST_OFFSET bits from the destination and 8 -
3318 SOURCE_OFFSET bits from the source. */
3319 buf
= *(bits_big_endian
? source
-- : source
++) >> source_offset
;
3320 buf
<<= dest_offset
;
3321 buf
|= *dest
& ((1 << dest_offset
) - 1);
3323 /* NBITS: bits yet to be written; AVAIL: BUF's fill level. */
3324 nbits
+= dest_offset
;
3325 avail
= dest_offset
+ 8 - source_offset
;
3327 /* Flush 8 bits from BUF, if appropriate. */
3328 if (nbits
>= 8 && avail
>= 8)
3330 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3336 /* Copy the middle part. */
3339 size_t len
= nbits
/ 8;
3341 /* Use a faster method for byte-aligned copies. */
3344 if (bits_big_endian
)
3348 memcpy (dest
+ 1, source
+ 1, len
);
3352 memcpy (dest
, source
, len
);
3361 buf
|= *(bits_big_endian
? source
-- : source
++) << avail
;
3362 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3369 /* Write the last byte. */
3373 buf
|= *source
<< avail
;
3375 buf
&= (1 << nbits
) - 1;
3376 *dest
= (*dest
& (~0 << nbits
)) | buf
;
3381 _initialize_utils (void)
3383 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
3384 Set number of characters where GDB should wrap lines of its output."), _("\
3385 Show number of characters where GDB should wrap lines of its output."), _("\
3386 This affects where GDB wraps its output to fit the screen width.\n\
3387 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
3389 show_chars_per_line
,
3390 &setlist
, &showlist
);
3392 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
3393 Set number of lines in a page for GDB output pagination."), _("\
3394 Show number of lines in a page for GDB output pagination."), _("\
3395 This affects the number of lines after which GDB will pause\n\
3396 its output and ask you whether to continue.\n\
3397 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
3399 show_lines_per_page
,
3400 &setlist
, &showlist
);
3402 add_setshow_boolean_cmd ("pagination", class_support
,
3403 &pagination_enabled
, _("\
3404 Set state of GDB output pagination."), _("\
3405 Show state of GDB output pagination."), _("\
3406 When pagination is ON, GDB pauses at end of each screenful of\n\
3407 its output and asks you whether to continue.\n\
3408 Turning pagination off is an alternative to \"set height unlimited\"."),
3410 show_pagination_enabled
,
3411 &setlist
, &showlist
);
3413 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
3414 &sevenbit_strings
, _("\
3415 Set printing of 8-bit characters in strings as \\nnn."), _("\
3416 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
3418 show_sevenbit_strings
,
3419 &setprintlist
, &showprintlist
);
3421 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
3422 &debug_timestamp
, _("\
3423 Set timestamping of debugging messages."), _("\
3424 Show timestamping of debugging messages."), _("\
3425 When set, debugging messages will be marked with seconds and microseconds."),
3427 show_debug_timestamp
,
3428 &setdebuglist
, &showdebuglist
);
3430 add_internal_problem_command (&internal_error_problem
);
3431 add_internal_problem_command (&internal_warning_problem
);
3432 add_internal_problem_command (&demangler_warning_problem
);
3435 selftests::register_test ("gdb_realpath", gdb_realpath_tests
);