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 "common/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 "common/job-control.h"
69 #include "common/selftest.h"
70 #include "common/gdb_optional.h"
71 #include "cp-support.h"
73 #include "common/pathstuff.h"
74 #include "cli/cli-style.h"
75 #include "common/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 int debug_timestamp
= 0;
103 /* Nonzero means that strings with character values >0x7F should be printed
104 as octal escapes. Zero means just print the value (e.g. it's an
105 international character, and the terminal or window can cope.) */
107 int sevenbit_strings
= 0;
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 int pagination_enabled
= 1;
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
);
130 /* Cleanup utilities.
132 These are not defined in cleanups.c (nor declared in cleanups.h)
133 because while they use the "cleanup API" they are not part of the
136 /* This function is useful for cleanups.
140 old_chain = make_cleanup (free_current_contents, &foo);
142 to arrange to free the object thus allocated. */
145 free_current_contents (void *ptr
)
147 void **location
= (void **) ptr
;
149 if (location
== NULL
)
150 internal_error (__FILE__
, __LINE__
,
151 _("free_current_contents: NULL pointer"));
152 if (*location
!= NULL
)
161 /* Print a warning message. The first argument STRING is the warning
162 message, used as an fprintf format string, the second is the
163 va_list of arguments for that string. A warning is unfiltered (not
164 paginated) so that the user does not need to page through each
165 screen full of warnings when there are lots of them. */
168 vwarning (const char *string
, va_list args
)
170 if (deprecated_warning_hook
)
171 (*deprecated_warning_hook
) (string
, args
);
174 gdb::optional
<target_terminal::scoped_restore_terminal_state
> term_state
;
175 if (target_supports_terminal_ours ())
177 term_state
.emplace ();
178 target_terminal::ours_for_output ();
180 if (filtered_printing_initialized ())
181 wrap_here (""); /* Force out any buffered output. */
182 gdb_flush (gdb_stdout
);
183 if (warning_pre_print
)
184 fputs_unfiltered (warning_pre_print
, gdb_stderr
);
185 vfprintf_unfiltered (gdb_stderr
, string
, args
);
186 fprintf_unfiltered (gdb_stderr
, "\n");
190 /* Print an error message and return to command level.
191 The first argument STRING is the error message, used as a fprintf string,
192 and the remaining args are passed as arguments to it. */
195 verror (const char *string
, va_list args
)
197 throw_verror (GENERIC_ERROR
, string
, args
);
201 error_stream (const string_file
&stream
)
203 error (("%s"), stream
.c_str ());
206 /* Emit a message and abort. */
208 static void ATTRIBUTE_NORETURN
209 abort_with_message (const char *msg
)
211 if (current_ui
== NULL
)
214 fputs_unfiltered (msg
, gdb_stderr
);
216 abort (); /* NOTE: GDB has only three calls to abort(). */
219 /* Dump core trying to increase the core soft limit to hard limit first. */
224 #ifdef HAVE_SETRLIMIT
225 struct rlimit rlim
= { (rlim_t
) RLIM_INFINITY
, (rlim_t
) RLIM_INFINITY
};
227 setrlimit (RLIMIT_CORE
, &rlim
);
228 #endif /* HAVE_SETRLIMIT */
230 abort (); /* NOTE: GDB has only three calls to abort(). */
233 /* Check whether GDB will be able to dump core using the dump_core
234 function. Returns zero if GDB cannot or should not dump core.
235 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
236 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
239 can_dump_core (enum resource_limit_kind limit_kind
)
241 #ifdef HAVE_GETRLIMIT
244 /* Be quiet and assume we can dump if an error is returned. */
245 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
251 if (rlim
.rlim_cur
== 0)
256 if (rlim
.rlim_max
== 0)
259 #endif /* HAVE_GETRLIMIT */
264 /* Print a warning that we cannot dump core. */
267 warn_cant_dump_core (const char *reason
)
269 fprintf_unfiltered (gdb_stderr
,
270 _("%s\nUnable to dump core, use `ulimit -c"
271 " unlimited' before executing GDB next time.\n"),
275 /* Check whether GDB will be able to dump core using the dump_core
276 function, and print a warning if we cannot. */
279 can_dump_core_warn (enum resource_limit_kind limit_kind
,
282 int core_dump_allowed
= can_dump_core (limit_kind
);
284 if (!core_dump_allowed
)
285 warn_cant_dump_core (reason
);
287 return core_dump_allowed
;
290 /* Allow the user to configure the debugger behavior with respect to
291 what to do when an internal problem is detected. */
293 const char internal_problem_ask
[] = "ask";
294 const char internal_problem_yes
[] = "yes";
295 const char internal_problem_no
[] = "no";
296 static const char *const internal_problem_modes
[] =
298 internal_problem_ask
,
299 internal_problem_yes
,
304 /* Print a message reporting an internal error/warning. Ask the user
305 if they want to continue, dump core, or just exit. Return
306 something to indicate a quit. */
308 struct internal_problem
311 int user_settable_should_quit
;
312 const char *should_quit
;
313 int user_settable_should_dump_core
;
314 const char *should_dump_core
;
317 /* Report a problem, internal to GDB, to the user. Once the problem
318 has been reported, and assuming GDB didn't quit, the caller can
319 either allow execution to resume or throw an error. */
321 static void ATTRIBUTE_PRINTF (4, 0)
322 internal_vproblem (struct internal_problem
*problem
,
323 const char *file
, int line
, const char *fmt
, va_list ap
)
330 /* Don't allow infinite error/warning recursion. */
332 static char msg
[] = "Recursive internal problem.\n";
341 abort_with_message (msg
);
344 /* Newer GLIBC versions put the warn_unused_result attribute
345 on write, but this is one of those rare cases where
346 ignoring the return value is correct. Casting to (void)
347 does not fix this problem. This is the solution suggested
348 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
349 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
350 abort (); /* NOTE: GDB has only three calls to abort(). */
355 /* Create a string containing the full error/warning message. Need
356 to call query with this full string, as otherwize the reason
357 (error/warning) and question become separated. Format using a
358 style similar to a compiler error message. Include extra detail
359 so that the user knows that they are living on the edge. */
361 std::string msg
= string_vprintf (fmt
, ap
);
362 reason
= string_printf ("%s:%d: %s: %s\n"
363 "A problem internal to GDB has been detected,\n"
364 "further debugging may prove unreliable.",
365 file
, line
, problem
->name
, msg
.c_str ());
368 /* Fall back to abort_with_message if gdb_stderr is not set up. */
369 if (current_ui
== NULL
)
371 fputs (reason
.c_str (), stderr
);
372 abort_with_message ("\n");
375 /* Try to get the message out and at the start of a new line. */
376 gdb::optional
<target_terminal::scoped_restore_terminal_state
> term_state
;
377 if (target_supports_terminal_ours ())
379 term_state
.emplace ();
380 target_terminal::ours_for_output ();
382 if (filtered_printing_initialized ())
385 /* Emit the message unless query will emit it below. */
386 if (problem
->should_quit
!= internal_problem_ask
388 || !filtered_printing_initialized ())
389 fprintf_unfiltered (gdb_stderr
, "%s\n", reason
.c_str ());
391 if (problem
->should_quit
== internal_problem_ask
)
393 /* Default (yes/batch case) is to quit GDB. When in batch mode
394 this lessens the likelihood of GDB going into an infinite
396 if (!confirm
|| !filtered_printing_initialized ())
399 quit_p
= query (_("%s\nQuit this debugging session? "),
402 else if (problem
->should_quit
== internal_problem_yes
)
404 else if (problem
->should_quit
== internal_problem_no
)
407 internal_error (__FILE__
, __LINE__
, _("bad switch"));
409 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr
);
410 if (REPORT_BUGS_TO
[0])
411 fprintf_unfiltered (gdb_stderr
, _(" For instructions, see:\n%s."),
413 fputs_unfiltered ("\n\n", gdb_stderr
);
415 if (problem
->should_dump_core
== internal_problem_ask
)
417 if (!can_dump_core_warn (LIMIT_MAX
, reason
.c_str ()))
419 else if (!filtered_printing_initialized ())
423 /* Default (yes/batch case) is to dump core. This leaves a GDB
424 `dropping' so that it is easier to see that something went
426 dump_core_p
= query (_("%s\nCreate a core file of GDB? "),
430 else if (problem
->should_dump_core
== internal_problem_yes
)
431 dump_core_p
= can_dump_core_warn (LIMIT_MAX
, reason
.c_str ());
432 else if (problem
->should_dump_core
== internal_problem_no
)
435 internal_error (__FILE__
, __LINE__
, _("bad switch"));
448 #ifdef HAVE_WORKING_FORK
458 static struct internal_problem internal_error_problem
= {
459 "internal-error", 1, internal_problem_ask
, 1, internal_problem_ask
463 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
465 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
466 throw_quit (_("Command aborted."));
469 static struct internal_problem internal_warning_problem
= {
470 "internal-warning", 1, internal_problem_ask
, 1, internal_problem_ask
474 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
476 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
479 static struct internal_problem demangler_warning_problem
= {
480 "demangler-warning", 1, internal_problem_ask
, 0, internal_problem_no
484 demangler_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
486 internal_vproblem (&demangler_warning_problem
, file
, line
, fmt
, ap
);
490 demangler_warning (const char *file
, int line
, const char *string
, ...)
494 va_start (ap
, string
);
495 demangler_vwarning (file
, line
, string
, ap
);
499 /* Dummy functions to keep add_prefix_cmd happy. */
502 set_internal_problem_cmd (const char *args
, int from_tty
)
507 show_internal_problem_cmd (const char *args
, int from_tty
)
511 /* When GDB reports an internal problem (error or warning) it gives
512 the user the opportunity to quit GDB and/or create a core file of
513 the current debug session. This function registers a few commands
514 that make it possible to specify that GDB should always or never
515 quit or create a core file, without asking. The commands look
518 maint set PROBLEM-NAME quit ask|yes|no
519 maint show PROBLEM-NAME quit
520 maint set PROBLEM-NAME corefile ask|yes|no
521 maint show PROBLEM-NAME corefile
523 Where PROBLEM-NAME is currently "internal-error" or
524 "internal-warning". */
527 add_internal_problem_command (struct internal_problem
*problem
)
529 struct cmd_list_element
**set_cmd_list
;
530 struct cmd_list_element
**show_cmd_list
;
534 set_cmd_list
= XNEW (struct cmd_list_element
*);
535 show_cmd_list
= XNEW (struct cmd_list_element
*);
536 *set_cmd_list
= NULL
;
537 *show_cmd_list
= NULL
;
539 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
542 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
545 add_prefix_cmd (problem
->name
,
546 class_maintenance
, set_internal_problem_cmd
, set_doc
,
548 concat ("maintenance set ", problem
->name
, " ",
550 0/*allow-unknown*/, &maintenance_set_cmdlist
);
552 add_prefix_cmd (problem
->name
,
553 class_maintenance
, show_internal_problem_cmd
, show_doc
,
555 concat ("maintenance show ", problem
->name
, " ",
557 0/*allow-unknown*/, &maintenance_show_cmdlist
);
559 if (problem
->user_settable_should_quit
)
561 set_doc
= xstrprintf (_("Set whether GDB should quit "
562 "when an %s is detected"),
564 show_doc
= xstrprintf (_("Show whether GDB will quit "
565 "when an %s is detected"),
567 add_setshow_enum_cmd ("quit", class_maintenance
,
568 internal_problem_modes
,
569 &problem
->should_quit
,
582 if (problem
->user_settable_should_dump_core
)
584 set_doc
= xstrprintf (_("Set whether GDB should create a core "
585 "file of GDB when %s is detected"),
587 show_doc
= xstrprintf (_("Show whether GDB will create a core "
588 "file of GDB when %s is detected"),
590 add_setshow_enum_cmd ("corefile", class_maintenance
,
591 internal_problem_modes
,
592 &problem
->should_dump_core
,
606 /* Return a newly allocated string, containing the PREFIX followed
607 by the system error message for errno (separated by a colon). */
610 perror_string (const char *prefix
)
614 err
= safe_strerror (errno
);
615 return std::string (prefix
) + ": " + err
;
618 /* Print the system error message for errno, and also mention STRING
619 as the file name for which the error was encountered. Use ERRCODE
620 for the thrown exception. Then return to command level. */
623 throw_perror_with_name (enum errors errcode
, const char *string
)
625 std::string combined
= perror_string (string
);
627 /* I understand setting these is a matter of taste. Still, some people
628 may clear errno but not know about bfd_error. Doing this here is not
630 bfd_set_error (bfd_error_no_error
);
633 throw_error (errcode
, _("%s."), combined
.c_str ());
636 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
639 perror_with_name (const char *string
)
641 throw_perror_with_name (GENERIC_ERROR
, string
);
644 /* Same as perror_with_name except that it prints a warning instead
645 of throwing an error. */
648 perror_warning_with_name (const char *string
)
650 std::string combined
= perror_string (string
);
651 warning (_("%s"), combined
.c_str ());
654 /* Print the system error message for ERRCODE, and also mention STRING
655 as the file name for which the error was encountered. */
658 print_sys_errmsg (const char *string
, int errcode
)
663 err
= safe_strerror (errcode
);
664 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
665 strcpy (combined
, string
);
666 strcat (combined
, ": ");
667 strcat (combined
, err
);
669 /* We want anything which was printed on stdout to come out first, before
671 gdb_flush (gdb_stdout
);
672 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
675 /* Control C eventually causes this to be called, at a convenient time. */
680 if (sync_quit_force_run
)
682 sync_quit_force_run
= 0;
683 quit_force (NULL
, 0);
687 /* No steenking SIGINT will ever be coming our way when the
688 program is resumed. Don't lie. */
692 /* If there is no terminal switching for this target, then we can't
693 possibly get screwed by the lack of job control. */
694 || !target_supports_terminal_ours ())
697 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
706 if (sync_quit_force_run
)
711 if (deprecated_interactive_hook
)
712 deprecated_interactive_hook ();
716 /* Called when a memory allocation fails, with the number of bytes of
717 memory requested in SIZE. */
720 malloc_failure (long size
)
724 internal_error (__FILE__
, __LINE__
,
725 _("virtual memory exhausted: can't allocate %ld bytes."),
730 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
734 /* My replacement for the read system call.
735 Used like `read' but keeps going if `read' returns too soon. */
738 myread (int desc
, char *addr
, int len
)
745 val
= read (desc
, addr
, len
);
757 print_spaces (int n
, struct ui_file
*file
)
759 fputs_unfiltered (n_spaces (n
), file
);
762 /* Print a host address. */
765 gdb_print_host_address_1 (const void *addr
, struct ui_file
*stream
)
767 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
773 make_hex_string (const gdb_byte
*data
, size_t length
)
775 char *result
= (char *) xmalloc (length
* 2 + 1);
780 for (i
= 0; i
< length
; ++i
)
781 p
+= xsnprintf (p
, 3, "%02x", data
[i
]);
788 /* An RAII class that sets up to handle input and then tears down
789 during destruction. */
791 class scoped_input_handler
795 scoped_input_handler ()
796 : m_quit_handler (&quit_handler
, default_quit_handler
),
799 target_terminal::ours ();
800 ui_register_input_event_handler (current_ui
);
801 if (current_ui
->prompt_state
== PROMPT_BLOCKED
)
805 ~scoped_input_handler ()
808 ui_unregister_input_event_handler (m_ui
);
811 DISABLE_COPY_AND_ASSIGN (scoped_input_handler
);
815 /* Save and restore the terminal state. */
816 target_terminal::scoped_restore_terminal_state m_term_state
;
818 /* Save and restore the quit handler. */
819 scoped_restore_tmpl
<quit_handler_ftype
*> m_quit_handler
;
821 /* The saved UI, if non-NULL. */
827 /* This function supports the query, nquery, and yquery functions.
828 Ask user a y-or-n question and return 0 if answer is no, 1 if
829 answer is yes, or default the answer to the specified default
830 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
831 default answer, or '\0' for no default.
832 CTLSTR is the control string and should end in "? ". It should
833 not say how to answer, because we do that.
834 ARGS are the arguments passed along with the CTLSTR argument to
837 static int ATTRIBUTE_PRINTF (1, 0)
838 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
842 char def_answer
, not_def_answer
;
843 const char *y_string
, *n_string
;
845 /* Set up according to which answer is the default. */
850 not_def_answer
= 'N';
854 else if (defchar
== 'y')
858 not_def_answer
= 'N';
866 not_def_answer
= 'Y';
871 /* Automatically answer the default value if the user did not want
872 prompts or the command was issued with the server prefix. */
873 if (!confirm
|| server_command
)
876 /* If input isn't coming from the user directly, just say what
877 question we're asking, and then answer the default automatically. This
878 way, important error messages don't get lost when talking to GDB
880 if (current_ui
->instream
!= current_ui
->stdin_stream
881 || !input_interactive_p (current_ui
)
882 /* Restrict queries to the main UI. */
883 || current_ui
!= main_ui
)
885 target_terminal::scoped_restore_terminal_state term_state
;
886 target_terminal::ours_for_output ();
888 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
890 printf_filtered (_("(%s or %s) [answered %c; "
891 "input not from terminal]\n"),
892 y_string
, n_string
, def_answer
);
893 gdb_flush (gdb_stdout
);
898 if (deprecated_query_hook
)
900 target_terminal::scoped_restore_terminal_state term_state
;
901 return deprecated_query_hook (ctlstr
, args
);
904 /* Format the question outside of the loop, to avoid reusing args. */
905 std::string question
= string_vprintf (ctlstr
, args
);
907 = string_printf (_("%s%s(%s or %s) %s"),
908 annotation_level
> 1 ? "\n\032\032pre-query\n" : "",
909 question
.c_str (), y_string
, n_string
,
910 annotation_level
> 1 ? "\n\032\032query\n" : "");
912 /* Used to add duration we waited for user to respond to
913 prompt_for_continue_wait_time. */
914 using namespace std::chrono
;
915 steady_clock::time_point prompt_started
= steady_clock::now ();
917 scoped_input_handler prepare_input
;
921 char *response
, answer
;
923 gdb_flush (gdb_stdout
);
924 response
= gdb_readline_wrapper (prompt
.c_str ());
926 if (response
== NULL
) /* C-d */
928 printf_filtered ("EOF [assumed %c]\n", def_answer
);
933 answer
= response
[0];
938 /* Check answer. For the non-default, the user must specify
939 the non-default explicitly. */
940 if (answer
== not_def_answer
)
945 /* Otherwise, if a default was specified, the user may either
946 specify the required input or have it default by entering
948 if (answer
== def_answer
949 || (defchar
!= '\0' && answer
== '\0'))
954 /* Invalid entries are not defaulted and require another selection. */
955 printf_filtered (_("Please answer %s or %s.\n"),
959 /* Add time spend in this routine to prompt_for_continue_wait_time. */
960 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
962 if (annotation_level
> 1)
963 printf_filtered (("\n\032\032post-query\n"));
968 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
969 answer is yes, or 0 if answer is defaulted.
970 Takes three args which are given to printf to print the question.
971 The first, a control string, should end in "? ".
972 It should not say how to answer, because we do that. */
975 nquery (const char *ctlstr
, ...)
980 va_start (args
, ctlstr
);
981 ret
= defaulted_query (ctlstr
, 'n', args
);
986 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
987 answer is yes, or 1 if answer is defaulted.
988 Takes three args which are given to printf to print the question.
989 The first, a control string, should end in "? ".
990 It should not say how to answer, because we do that. */
993 yquery (const char *ctlstr
, ...)
998 va_start (args
, ctlstr
);
999 ret
= defaulted_query (ctlstr
, 'y', args
);
1004 /* Ask user a y-or-n question and return 1 iff answer is yes.
1005 Takes three args which are given to printf to print the question.
1006 The first, a control string, should end in "? ".
1007 It should not say how to answer, because we do that. */
1010 query (const char *ctlstr
, ...)
1015 va_start (args
, ctlstr
);
1016 ret
= defaulted_query (ctlstr
, '\0', args
);
1021 /* A helper for parse_escape that converts a host character to a
1022 target character. C is the host character. If conversion is
1023 possible, then the target character is stored in *TARGET_C and the
1024 function returns 1. Otherwise, the function returns 0. */
1027 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1032 auto_obstack host_data
;
1034 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1035 (gdb_byte
*) &the_char
, 1, 1,
1036 &host_data
, translit_none
);
1038 if (obstack_object_size (&host_data
) == 1)
1041 *target_c
= *(char *) obstack_base (&host_data
);
1047 /* Parse a C escape sequence. STRING_PTR points to a variable
1048 containing a pointer to the string to parse. That pointer
1049 should point to the character after the \. That pointer
1050 is updated past the characters we use. The value of the
1051 escape sequence is returned.
1053 A negative value means the sequence \ newline was seen,
1054 which is supposed to be equivalent to nothing at all.
1056 If \ is followed by a null character, we return a negative
1057 value and leave the string pointer pointing at the null character.
1059 If \ is followed by 000, we return 0 and leave the string pointer
1060 after the zeros. A value of 0 does not mean end of string. */
1063 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1065 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1066 int c
= *(*string_ptr
)++;
1085 int i
= host_hex_value (c
);
1090 if (isdigit (c
) && c
!= '8' && c
!= '9')
1094 i
+= host_hex_value (c
);
1130 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1131 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1132 " which has no equivalent\nin the `%s' character set."),
1133 c
, c
, target_charset (gdbarch
));
1137 /* Print the character C on STREAM as part of the contents of a literal
1138 string whose delimiter is QUOTER. Note that this routine should only
1139 be called for printing things which are independent of the language
1140 of the program being debugged.
1142 printchar will normally escape backslashes and instances of QUOTER. If
1143 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1144 As a side effect, if you pass the backslash character as the QUOTER,
1145 printchar will escape backslashes as usual, but not any other quoting
1149 printchar (int c
, do_fputc_ftype do_fputc
, ui_file
*stream
, int quoter
)
1151 c
&= 0xFF; /* Avoid sign bit follies */
1153 if (c
< 0x20 || /* Low control chars */
1154 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1155 (sevenbit_strings
&& c
>= 0x80))
1156 { /* high order bit set */
1157 do_fputc ('\\', stream
);
1162 do_fputc ('n', stream
);
1165 do_fputc ('b', stream
);
1168 do_fputc ('t', stream
);
1171 do_fputc ('f', stream
);
1174 do_fputc ('r', stream
);
1177 do_fputc ('e', stream
);
1180 do_fputc ('a', stream
);
1184 do_fputc ('0' + ((c
>> 6) & 0x7), stream
);
1185 do_fputc ('0' + ((c
>> 3) & 0x7), stream
);
1186 do_fputc ('0' + ((c
>> 0) & 0x7), stream
);
1193 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1194 do_fputc ('\\', stream
);
1195 do_fputc (c
, stream
);
1199 /* Print the character C on STREAM as part of the contents of a
1200 literal string whose delimiter is QUOTER. Note that these routines
1201 should only be call for printing things which are independent of
1202 the language of the program being debugged. */
1205 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1208 printchar (*str
++, fputc_filtered
, stream
, quoter
);
1212 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1215 printchar (*str
++, fputc_unfiltered
, stream
, quoter
);
1219 fputstrn_filtered (const char *str
, int n
, int quoter
,
1220 struct ui_file
*stream
)
1222 for (int i
= 0; i
< n
; i
++)
1223 printchar (str
[i
], fputc_filtered
, stream
, quoter
);
1227 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1228 do_fputc_ftype do_fputc
, struct ui_file
*stream
)
1230 for (int i
= 0; i
< n
; i
++)
1231 printchar (str
[i
], do_fputc
, stream
, quoter
);
1235 /* Number of lines per page or UINT_MAX if paging is disabled. */
1236 static unsigned int lines_per_page
;
1238 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1239 struct cmd_list_element
*c
, const char *value
)
1241 fprintf_filtered (file
,
1242 _("Number of lines gdb thinks are in a page is %s.\n"),
1246 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1247 static unsigned int chars_per_line
;
1249 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1250 struct cmd_list_element
*c
, const char *value
)
1252 fprintf_filtered (file
,
1253 _("Number of characters gdb thinks "
1254 "are in a line is %s.\n"),
1258 /* Current count of lines printed on this page, chars on this line. */
1259 static unsigned int lines_printed
, chars_printed
;
1261 /* True if pagination is disabled for just one command. */
1263 static bool pagination_disabled_for_command
;
1265 /* Buffer and start column of buffered text, for doing smarter word-
1266 wrapping. When someone calls wrap_here(), we start buffering output
1267 that comes through fputs_filtered(). If we see a newline, we just
1268 spit it out and forget about the wrap_here(). If we see another
1269 wrap_here(), we spit it out and remember the newer one. If we see
1270 the end of the line, we spit out a newline, the indent, and then
1271 the buffered output. */
1273 static bool filter_initialized
= false;
1275 /* Contains characters which are waiting to be output (they have
1276 already been counted in chars_printed). */
1277 static std::string wrap_buffer
;
1279 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1281 static const char *wrap_indent
;
1283 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1284 is not in effect. */
1285 static int wrap_column
;
1287 /* The style applied at the time that wrap_here was called. */
1288 static ui_file_style wrap_style
;
1291 /* Initialize the number of lines per page and chars per line. */
1294 init_page_info (void)
1298 lines_per_page
= UINT_MAX
;
1299 chars_per_line
= UINT_MAX
;
1303 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1308 #if defined(__GO32__)
1309 rows
= ScreenRows ();
1310 cols
= ScreenCols ();
1311 lines_per_page
= rows
;
1312 chars_per_line
= cols
;
1314 /* Make sure Readline has initialized its terminal settings. */
1315 rl_reset_terminal (NULL
);
1317 /* Get the screen size from Readline. */
1318 rl_get_screen_size (&rows
, &cols
);
1319 lines_per_page
= rows
;
1320 chars_per_line
= cols
;
1322 /* Readline should have fetched the termcap entry for us.
1323 Only try to use tgetnum function if rl_get_screen_size
1324 did not return a useful value. */
1325 if (((rows
<= 0) && (tgetnum ((char *) "li") < 0))
1326 /* Also disable paging if inside Emacs. $EMACS was used
1327 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1328 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1330 /* The number of lines per page is not mentioned in the terminal
1331 description or EMACS evironment variable is set. This probably
1332 means that paging is not useful, so disable paging. */
1333 lines_per_page
= UINT_MAX
;
1336 /* If the output is not a terminal, don't paginate it. */
1337 if (!ui_file_isatty (gdb_stdout
))
1338 lines_per_page
= UINT_MAX
;
1342 /* We handle SIGWINCH ourselves. */
1343 rl_catch_sigwinch
= 0;
1349 /* Return nonzero if filtered printing is initialized. */
1351 filtered_printing_initialized (void)
1353 return filter_initialized
;
1356 set_batch_flag_and_restore_page_info::set_batch_flag_and_restore_page_info ()
1357 : m_save_lines_per_page (lines_per_page
),
1358 m_save_chars_per_line (chars_per_line
),
1359 m_save_batch_flag (batch_flag
)
1365 set_batch_flag_and_restore_page_info::~set_batch_flag_and_restore_page_info ()
1367 batch_flag
= m_save_batch_flag
;
1368 chars_per_line
= m_save_chars_per_line
;
1369 lines_per_page
= m_save_lines_per_page
;
1375 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1378 set_screen_size (void)
1380 int rows
= lines_per_page
;
1381 int cols
= chars_per_line
;
1383 /* If we get 0 or negative ROWS or COLS, treat as "infinite" size.
1384 A negative number can be seen here with the "set width/height"
1385 commands and either:
1387 - the user specified "unlimited", which maps to UINT_MAX, or
1388 - the user spedified some number between INT_MAX and UINT_MAX.
1390 Cap "infinity" to approximately sqrt(INT_MAX) so that we don't
1391 overflow in rl_set_screen_size, which multiplies rows and columns
1392 to compute the number of characters on the screen. */
1394 const int sqrt_int_max
= INT_MAX
>> (sizeof (int) * 8 / 2);
1396 if (rows
<= 0 || rows
> sqrt_int_max
)
1397 rows
= sqrt_int_max
;
1399 if (cols
<= 0 || cols
> sqrt_int_max
)
1400 cols
= sqrt_int_max
;
1402 /* Update Readline's idea of the terminal size. */
1403 rl_set_screen_size (rows
, cols
);
1406 /* Reinitialize WRAP_BUFFER. */
1411 if (chars_per_line
== 0)
1414 wrap_buffer
.clear ();
1415 filter_initialized
= true;
1419 set_width_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1426 set_height_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1434 set_screen_width_and_height (int width
, int height
)
1436 lines_per_page
= height
;
1437 chars_per_line
= width
;
1443 /* The currently applied style. */
1445 static ui_file_style applied_style
;
1447 /* Emit an ANSI style escape for STYLE. If STREAM is nullptr, emit to
1448 the wrap buffer; otherwise emit to STREAM. */
1451 emit_style_escape (const ui_file_style
&style
,
1452 struct ui_file
*stream
= nullptr)
1454 applied_style
= style
;
1456 if (stream
== nullptr)
1457 wrap_buffer
.append (style
.to_ansi ());
1459 fputs_unfiltered (style
.to_ansi ().c_str (), stream
);
1465 can_emit_style_escape (struct ui_file
*stream
)
1467 if (stream
!= gdb_stdout
1469 || !ui_file_isatty (stream
))
1471 const char *term
= getenv ("TERM");
1472 if (term
== nullptr || !strcmp (term
, "dumb"))
1477 /* Set the current output style. This will affect future uses of the
1478 _filtered output functions. */
1481 set_output_style (struct ui_file
*stream
, const ui_file_style
&style
)
1483 if (!can_emit_style_escape (stream
))
1486 /* Note that we don't pass STREAM here, because we want to emit to
1487 the wrap buffer, not directly to STREAM. */
1488 emit_style_escape (style
);
1494 reset_terminal_style (struct ui_file
*stream
)
1496 if (can_emit_style_escape (stream
))
1498 /* Force the setting, regardless of what we think the setting
1499 might already be. */
1500 applied_style
= ui_file_style ();
1501 wrap_buffer
.append (applied_style
.to_ansi ());
1505 /* Wait, so the user can read what's on the screen. Prompt the user
1506 to continue by pressing RETURN. 'q' is also provided because
1507 telling users what to do in the prompt is more user-friendly than
1508 expecting them to think of Ctrl-C/SIGINT. */
1511 prompt_for_continue (void)
1513 char cont_prompt
[120];
1514 /* Used to add duration we waited for user to respond to
1515 prompt_for_continue_wait_time. */
1516 using namespace std::chrono
;
1517 steady_clock::time_point prompt_started
= steady_clock::now ();
1518 bool disable_pagination
= pagination_disabled_for_command
;
1520 /* Clear the current styling. */
1521 if (can_emit_style_escape (gdb_stdout
))
1522 emit_style_escape (ui_file_style (), gdb_stdout
);
1524 if (annotation_level
> 1)
1525 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1527 strcpy (cont_prompt
,
1528 "--Type <RET> for more, q to quit, "
1529 "c to continue without paging--");
1530 if (annotation_level
> 1)
1531 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1533 /* We must do this *before* we call gdb_readline_wrapper, else it
1534 will eventually call us -- thinking that we're trying to print
1535 beyond the end of the screen. */
1536 reinitialize_more_filter ();
1538 scoped_input_handler prepare_input
;
1540 /* Call gdb_readline_wrapper, not readline, in order to keep an
1541 event loop running. */
1542 gdb::unique_xmalloc_ptr
<char> ignore (gdb_readline_wrapper (cont_prompt
));
1544 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1545 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1547 if (annotation_level
> 1)
1548 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1552 char *p
= ignore
.get ();
1554 while (*p
== ' ' || *p
== '\t')
1557 /* Do not call quit here; there is no possibility of SIGINT. */
1558 throw_quit ("Quit");
1560 disable_pagination
= true;
1563 /* Now we have to do this again, so that GDB will know that it doesn't
1564 need to save the ---Type <return>--- line at the top of the screen. */
1565 reinitialize_more_filter ();
1566 pagination_disabled_for_command
= disable_pagination
;
1568 /* Restore the current styling. */
1569 if (can_emit_style_escape (gdb_stdout
))
1570 emit_style_escape (applied_style
);
1572 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1575 /* Initialize timer to keep track of how long we waited for the user. */
1578 reset_prompt_for_continue_wait_time (void)
1580 using namespace std::chrono
;
1582 prompt_for_continue_wait_time
= steady_clock::duration::zero ();
1585 /* Fetch the cumulative time spent in prompt_for_continue. */
1587 std::chrono::steady_clock::duration
1588 get_prompt_for_continue_wait_time ()
1590 return prompt_for_continue_wait_time
;
1593 /* Reinitialize filter; ie. tell it to reset to original values. */
1596 reinitialize_more_filter (void)
1600 pagination_disabled_for_command
= false;
1603 /* Flush the wrap buffer to STREAM, if necessary. */
1606 flush_wrap_buffer (struct ui_file
*stream
)
1608 if (stream
== gdb_stdout
&& !wrap_buffer
.empty ())
1610 fputs_unfiltered (wrap_buffer
.c_str (), stream
);
1611 wrap_buffer
.clear ();
1615 /* Indicate that if the next sequence of characters overflows the line,
1616 a newline should be inserted here rather than when it hits the end.
1617 If INDENT is non-null, it is a string to be printed to indent the
1618 wrapped part on the next line. INDENT must remain accessible until
1619 the next call to wrap_here() or until a newline is printed through
1622 If the line is already overfull, we immediately print a newline and
1623 the indentation, and disable further wrapping.
1625 If we don't know the width of lines, but we know the page height,
1626 we must not wrap words, but should still keep track of newlines
1627 that were explicitly printed.
1629 INDENT should not contain tabs, as that will mess up the char count
1630 on the next line. FIXME.
1632 This routine is guaranteed to force out any output which has been
1633 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1634 used to force out output from the wrap_buffer. */
1637 wrap_here (const char *indent
)
1639 /* This should have been allocated, but be paranoid anyway. */
1640 if (!filter_initialized
)
1641 internal_error (__FILE__
, __LINE__
,
1642 _("failed internal consistency check"));
1644 flush_wrap_buffer (gdb_stdout
);
1645 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1649 else if (chars_printed
>= chars_per_line
)
1651 puts_filtered ("\n");
1653 puts_filtered (indent
);
1658 wrap_column
= chars_printed
;
1662 wrap_indent
= indent
;
1663 wrap_style
= applied_style
;
1667 /* Print input string to gdb_stdout, filtered, with wrap,
1668 arranging strings in columns of n chars. String can be
1669 right or left justified in the column. Never prints
1670 trailing spaces. String should never be longer than
1671 width. FIXME: this could be useful for the EXAMINE
1672 command, which currently doesn't tabulate very well. */
1675 puts_filtered_tabular (char *string
, int width
, int right
)
1681 gdb_assert (chars_per_line
> 0);
1682 if (chars_per_line
== UINT_MAX
)
1684 fputs_filtered (string
, gdb_stdout
);
1685 fputs_filtered ("\n", gdb_stdout
);
1689 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1690 fputs_filtered ("\n", gdb_stdout
);
1692 if (width
>= chars_per_line
)
1693 width
= chars_per_line
- 1;
1695 stringlen
= strlen (string
);
1697 if (chars_printed
> 0)
1698 spaces
= width
- (chars_printed
- 1) % width
- 1;
1700 spaces
+= width
- stringlen
;
1702 spacebuf
= (char *) alloca (spaces
+ 1);
1703 spacebuf
[spaces
] = '\0';
1705 spacebuf
[spaces
] = ' ';
1707 fputs_filtered (spacebuf
, gdb_stdout
);
1708 fputs_filtered (string
, gdb_stdout
);
1712 /* Ensure that whatever gets printed next, using the filtered output
1713 commands, starts at the beginning of the line. I.e. if there is
1714 any pending output for the current line, flush it and start a new
1715 line. Otherwise do nothing. */
1720 if (chars_printed
> 0)
1722 puts_filtered ("\n");
1727 /* Like fputs but if FILTER is true, pause after every screenful.
1729 Regardless of FILTER can wrap at points other than the final
1730 character of a line.
1732 Unlike fputs, fputs_maybe_filtered does not return a value.
1733 It is OK for LINEBUFFER to be NULL, in which case just don't print
1736 Note that a longjmp to top level may occur in this routine (only if
1737 FILTER is true) (since prompt_for_continue may do so) so this
1738 routine should not be called when cleanups are not in place. */
1741 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1744 const char *lineptr
;
1746 if (linebuffer
== 0)
1749 /* Don't do any filtering if it is disabled. */
1750 if (stream
!= gdb_stdout
1751 || !pagination_enabled
1752 || pagination_disabled_for_command
1754 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
1755 || top_level_interpreter () == NULL
1756 || top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
1758 flush_wrap_buffer (stream
);
1759 fputs_unfiltered (linebuffer
, stream
);
1764 = make_scope_exit ([&] ()
1766 wrap_buffer
.clear ();
1771 /* Go through and output each character. Show line extension
1772 when this is necessary; prompt user for new page when this is
1775 lineptr
= linebuffer
;
1778 /* Possible new page. Note that PAGINATION_DISABLED_FOR_COMMAND
1779 might be set during this loop, so we must continue to check
1781 if (filter
&& (lines_printed
>= lines_per_page
- 1)
1782 && !pagination_disabled_for_command
)
1783 prompt_for_continue ();
1785 while (*lineptr
&& *lineptr
!= '\n')
1789 /* Print a single line. */
1790 if (*lineptr
== '\t')
1792 wrap_buffer
.push_back ('\t');
1793 /* Shifting right by 3 produces the number of tab stops
1794 we have already passed, and then adding one and
1795 shifting left 3 advances to the next tab stop. */
1796 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
1799 else if (*lineptr
== '\033'
1800 && skip_ansi_escape (lineptr
, &skip_bytes
))
1802 wrap_buffer
.append (lineptr
, skip_bytes
);
1803 /* Note that we don't consider this a character, so we
1804 don't increment chars_printed here. */
1805 lineptr
+= skip_bytes
;
1809 wrap_buffer
.push_back (*lineptr
);
1814 if (chars_printed
>= chars_per_line
)
1816 unsigned int save_chars
= chars_printed
;
1822 if (can_emit_style_escape (stream
))
1823 emit_style_escape (ui_file_style (), stream
);
1824 /* If we aren't actually wrapping, don't output
1825 newline -- if chars_per_line is right, we
1826 probably just overflowed anyway; if it's wrong,
1827 let us keep going. */
1828 fputc_unfiltered ('\n', stream
);
1831 flush_wrap_buffer (stream
);
1833 /* Possible new page. Note that
1834 PAGINATION_DISABLED_FOR_COMMAND might be set during
1835 this loop, so we must continue to check it here. */
1836 if (lines_printed
>= lines_per_page
- 1
1837 && !pagination_disabled_for_command
)
1838 prompt_for_continue ();
1840 /* Now output indentation and wrapped string. */
1843 fputs_unfiltered (wrap_indent
, stream
);
1844 if (can_emit_style_escape (stream
))
1845 emit_style_escape (wrap_style
, stream
);
1846 /* FIXME, this strlen is what prevents wrap_indent from
1847 containing tabs. However, if we recurse to print it
1848 and count its chars, we risk trouble if wrap_indent is
1849 longer than (the user settable) chars_per_line.
1850 Note also that this can set chars_printed > chars_per_line
1851 if we are printing a long string. */
1852 chars_printed
= strlen (wrap_indent
)
1853 + (save_chars
- wrap_column
);
1854 wrap_column
= 0; /* And disable fancy wrap */
1859 if (*lineptr
== '\n')
1862 wrap_here ((char *) 0); /* Spit out chars, cancel
1865 fputc_unfiltered ('\n', stream
);
1870 buffer_clearer
.release ();
1874 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
1876 fputs_maybe_filtered (linebuffer
, stream
, 1);
1882 fputs_styled (const char *linebuffer
, const ui_file_style
&style
,
1883 struct ui_file
*stream
)
1885 /* This just makes it so we emit somewhat fewer escape
1887 if (style
.is_default ())
1888 fputs_maybe_filtered (linebuffer
, stream
, 1);
1891 set_output_style (stream
, style
);
1892 fputs_maybe_filtered (linebuffer
, stream
, 1);
1893 set_output_style (stream
, ui_file_style ());
1898 putchar_unfiltered (int c
)
1902 ui_file_write (gdb_stdout
, &buf
, 1);
1906 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
1907 May return nonlocally. */
1910 putchar_filtered (int c
)
1912 return fputc_filtered (c
, gdb_stdout
);
1916 fputc_unfiltered (int c
, struct ui_file
*stream
)
1920 ui_file_write (stream
, &buf
, 1);
1925 fputc_filtered (int c
, struct ui_file
*stream
)
1931 fputs_filtered (buf
, stream
);
1935 /* puts_debug is like fputs_unfiltered, except it prints special
1936 characters in printable fashion. */
1939 puts_debug (char *prefix
, char *string
, char *suffix
)
1943 /* Print prefix and suffix after each line. */
1944 static int new_line
= 1;
1945 static int return_p
= 0;
1946 static const char *prev_prefix
= "";
1947 static const char *prev_suffix
= "";
1949 if (*string
== '\n')
1952 /* If the prefix is changing, print the previous suffix, a new line,
1953 and the new prefix. */
1954 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
1956 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
1957 fputs_unfiltered ("\n", gdb_stdlog
);
1958 fputs_unfiltered (prefix
, gdb_stdlog
);
1961 /* Print prefix if we printed a newline during the previous call. */
1965 fputs_unfiltered (prefix
, gdb_stdlog
);
1968 prev_prefix
= prefix
;
1969 prev_suffix
= suffix
;
1971 /* Output characters in a printable format. */
1972 while ((ch
= *string
++) != '\0')
1978 fputc_unfiltered (ch
, gdb_stdlog
);
1981 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
1985 fputs_unfiltered ("\\\\", gdb_stdlog
);
1988 fputs_unfiltered ("\\b", gdb_stdlog
);
1991 fputs_unfiltered ("\\f", gdb_stdlog
);
1995 fputs_unfiltered ("\\n", gdb_stdlog
);
1998 fputs_unfiltered ("\\r", gdb_stdlog
);
2001 fputs_unfiltered ("\\t", gdb_stdlog
);
2004 fputs_unfiltered ("\\v", gdb_stdlog
);
2008 return_p
= ch
== '\r';
2011 /* Print suffix if we printed a newline. */
2014 fputs_unfiltered (suffix
, gdb_stdlog
);
2015 fputs_unfiltered ("\n", gdb_stdlog
);
2020 /* Print a variable number of ARGS using format FORMAT. If this
2021 information is going to put the amount written (since the last call
2022 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2023 call prompt_for_continue to get the users permision to continue.
2025 Unlike fprintf, this function does not return a value.
2027 We implement three variants, vfprintf (takes a vararg list and stream),
2028 fprintf (takes a stream to write on), and printf (the usual).
2030 Note also that a longjmp to top level may occur in this routine
2031 (since prompt_for_continue may do so) so this routine should not be
2032 called when cleanups are not in place. */
2035 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2036 va_list args
, int filter
)
2038 std::string linebuffer
= string_vprintf (format
, args
);
2039 fputs_maybe_filtered (linebuffer
.c_str (), stream
, filter
);
2044 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2046 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2050 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2052 std::string linebuffer
= string_vprintf (format
, args
);
2053 if (debug_timestamp
&& stream
== gdb_stdlog
)
2055 using namespace std::chrono
;
2058 steady_clock::time_point now
= steady_clock::now ();
2059 seconds s
= duration_cast
<seconds
> (now
.time_since_epoch ());
2060 microseconds us
= duration_cast
<microseconds
> (now
.time_since_epoch () - s
);
2062 len
= linebuffer
.size ();
2063 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2065 std::string timestamp
= string_printf ("%ld.%06ld %s%s",
2068 linebuffer
.c_str (),
2069 need_nl
? "\n": "");
2070 fputs_unfiltered (timestamp
.c_str (), stream
);
2073 fputs_unfiltered (linebuffer
.c_str (), stream
);
2077 vprintf_filtered (const char *format
, va_list args
)
2079 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2083 vprintf_unfiltered (const char *format
, va_list args
)
2085 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2089 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2093 va_start (args
, format
);
2094 vfprintf_filtered (stream
, format
, args
);
2099 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2103 va_start (args
, format
);
2104 vfprintf_unfiltered (stream
, format
, args
);
2108 /* Like fprintf_filtered, but prints its result indented.
2109 Called as fprintfi_filtered (spaces, stream, format, ...); */
2112 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2117 va_start (args
, format
);
2118 print_spaces_filtered (spaces
, stream
);
2120 vfprintf_filtered (stream
, format
, args
);
2127 fprintf_styled (struct ui_file
*stream
, const ui_file_style
&style
,
2128 const char *format
, ...)
2132 set_output_style (stream
, style
);
2133 va_start (args
, format
);
2134 vfprintf_filtered (stream
, format
, args
);
2136 set_output_style (stream
, ui_file_style ());
2141 printf_filtered (const char *format
, ...)
2145 va_start (args
, format
);
2146 vfprintf_filtered (gdb_stdout
, format
, args
);
2152 printf_unfiltered (const char *format
, ...)
2156 va_start (args
, format
);
2157 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2161 /* Like printf_filtered, but prints it's result indented.
2162 Called as printfi_filtered (spaces, format, ...); */
2165 printfi_filtered (int spaces
, const char *format
, ...)
2169 va_start (args
, format
);
2170 print_spaces_filtered (spaces
, gdb_stdout
);
2171 vfprintf_filtered (gdb_stdout
, format
, args
);
2175 /* Easy -- but watch out!
2177 This routine is *not* a replacement for puts()! puts() appends a newline.
2178 This one doesn't, and had better not! */
2181 puts_filtered (const char *string
)
2183 fputs_filtered (string
, gdb_stdout
);
2187 puts_unfiltered (const char *string
)
2189 fputs_unfiltered (string
, gdb_stdout
);
2192 /* Return a pointer to N spaces and a null. The pointer is good
2193 until the next call to here. */
2198 static char *spaces
= 0;
2199 static int max_spaces
= -1;
2205 spaces
= (char *) xmalloc (n
+ 1);
2206 for (t
= spaces
+ n
; t
!= spaces
;)
2212 return spaces
+ max_spaces
- n
;
2215 /* Print N spaces. */
2217 print_spaces_filtered (int n
, struct ui_file
*stream
)
2219 fputs_filtered (n_spaces (n
), stream
);
2222 /* C++/ObjC demangler stuff. */
2224 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2225 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2226 If the name is not mangled, or the language for the name is unknown, or
2227 demangling is off, the name is printed in its "raw" form. */
2230 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2231 enum language lang
, int arg_mode
)
2237 /* If user wants to see raw output, no problem. */
2240 fputs_filtered (name
, stream
);
2244 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2245 fputs_filtered (demangled
? demangled
: name
, stream
);
2246 if (demangled
!= NULL
)
2254 /* True if CH is a character that can be part of a symbol name. I.e.,
2255 either a number, a letter, or a '_'. */
2258 valid_identifier_name_char (int ch
)
2260 return (isalnum (ch
) || ch
== '_');
2263 /* Skip to end of token, or to END, whatever comes first. Input is
2264 assumed to be a C++ operator name. */
2267 cp_skip_operator_token (const char *token
, const char *end
)
2269 const char *p
= token
;
2270 while (p
!= end
&& !isspace (*p
) && *p
!= '(')
2272 if (valid_identifier_name_char (*p
))
2274 while (p
!= end
&& valid_identifier_name_char (*p
))
2280 /* Note, ordered such that among ops that share a prefix,
2281 longer comes first. This is so that the loop below can
2282 bail on first match. */
2283 static const char *ops
[] =
2289 "-=", "--", "->", "-",
2298 "<<=", "<=", "<<", "<",
2299 ">>=", ">=", ">>", ">",
2303 for (const char *op
: ops
)
2305 size_t oplen
= strlen (op
);
2306 size_t lencmp
= std::min
<size_t> (oplen
, end
- p
);
2308 if (strncmp (p
, op
, lencmp
) == 0)
2311 /* Some unidentified character. Return it. */
2319 /* Advance STRING1/STRING2 past whitespace. */
2322 skip_ws (const char *&string1
, const char *&string2
, const char *end_str2
)
2324 while (isspace (*string1
))
2326 while (string2
< end_str2
&& isspace (*string2
))
2330 /* True if STRING points at the start of a C++ operator name. START
2331 is the start of the string that STRING points to, hence when
2332 reading backwards, we must not read any character before START. */
2335 cp_is_operator (const char *string
, const char *start
)
2337 return ((string
== start
2338 || !valid_identifier_name_char (string
[-1]))
2339 && strncmp (string
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
2340 && !valid_identifier_name_char (string
[CP_OPERATOR_LEN
]));
2343 /* If *NAME points at an ABI tag, skip it and return true. Otherwise
2344 leave *NAME unmodified and return false. (see GCC's abi_tag
2345 attribute), such names are demangled as e.g.,
2346 "function[abi:cxx11]()". */
2349 skip_abi_tag (const char **name
)
2351 const char *p
= *name
;
2353 if (startswith (p
, "[abi:"))
2357 while (valid_identifier_name_char (*p
))
2373 strncmp_iw_with_mode (const char *string1
, const char *string2
,
2374 size_t string2_len
, strncmp_iw_mode mode
,
2375 enum language language
,
2376 completion_match_for_lcd
*match_for_lcd
)
2378 const char *string1_start
= string1
;
2379 const char *end_str2
= string2
+ string2_len
;
2380 bool skip_spaces
= true;
2381 bool have_colon_op
= (language
== language_cplus
2382 || language
== language_rust
2383 || language
== language_fortran
);
2388 || ((isspace (*string1
) && !valid_identifier_name_char (*string2
))
2389 || (isspace (*string2
) && !valid_identifier_name_char (*string1
))))
2391 skip_ws (string1
, string2
, end_str2
);
2392 skip_spaces
= false;
2395 /* Skip [abi:cxx11] tags in the symbol name if the lookup name
2396 doesn't include them. E.g.:
2398 string1: function[abi:cxx1](int)
2401 string1: function[abi:cxx1](int)
2402 string2: function(int)
2404 string1: Struct[abi:cxx1]::function()
2405 string2: Struct::function()
2407 string1: function(Struct[abi:cxx1], int)
2408 string2: function(Struct, int)
2410 if (string2
== end_str2
2411 || (*string2
!= '[' && !valid_identifier_name_char (*string2
)))
2413 const char *abi_start
= string1
;
2415 /* There can be more than one tag. */
2416 while (*string1
== '[' && skip_abi_tag (&string1
))
2419 if (match_for_lcd
!= NULL
&& abi_start
!= string1
)
2420 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2422 while (isspace (*string1
))
2426 if (*string1
== '\0' || string2
== end_str2
)
2429 /* Handle the :: operator. */
2430 if (have_colon_op
&& string1
[0] == ':' && string1
[1] == ':')
2432 if (*string2
!= ':')
2438 if (string2
== end_str2
)
2441 if (*string2
!= ':')
2447 while (isspace (*string1
))
2449 while (string2
< end_str2
&& isspace (*string2
))
2454 /* Handle C++ user-defined operators. */
2455 else if (language
== language_cplus
2458 if (cp_is_operator (string1
, string1_start
))
2460 /* An operator name in STRING1. Check STRING2. */
2462 = std::min
<size_t> (CP_OPERATOR_LEN
, end_str2
- string2
);
2463 if (strncmp (string1
, string2
, cmplen
) != 0)
2469 if (string2
!= end_str2
)
2471 /* Check for "operatorX" in STRING2. */
2472 if (valid_identifier_name_char (*string2
))
2475 skip_ws (string1
, string2
, end_str2
);
2478 /* Handle operator(). */
2479 if (*string1
== '(')
2481 if (string2
== end_str2
)
2483 if (mode
== strncmp_iw_mode::NORMAL
)
2487 /* Don't break for the regular return at the
2488 bottom, because "operator" should not
2489 match "operator()", since this open
2490 parentheses is not the parameter list
2492 return *string1
!= '\0';
2496 if (*string1
!= *string2
)
2505 skip_ws (string1
, string2
, end_str2
);
2507 /* Skip to end of token, or to END, whatever comes
2509 const char *end_str1
= string1
+ strlen (string1
);
2510 const char *p1
= cp_skip_operator_token (string1
, end_str1
);
2511 const char *p2
= cp_skip_operator_token (string2
, end_str2
);
2513 cmplen
= std::min (p1
- string1
, p2
- string2
);
2516 if (strncmp (string1
, string2
, cmplen
) != 0)
2521 if (p1
- string1
!= p2
- string2
)
2523 if (strncmp (string1
, string2
, cmplen
) != 0)
2530 if (*string1
== '\0' || string2
== end_str2
)
2532 if (*string1
== '(' || *string2
== '(')
2540 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2542 if (case_sensitivity
== case_sensitive_off
2543 && (tolower ((unsigned char) *string1
)
2544 != tolower ((unsigned char) *string2
)))
2547 /* If we see any non-whitespace, non-identifier-name character
2548 (any of "()<>*&" etc.), then skip spaces the next time
2550 if (!isspace (*string1
) && !valid_identifier_name_char (*string1
))
2557 if (string2
== end_str2
)
2559 if (mode
== strncmp_iw_mode::NORMAL
)
2561 /* Strip abi tag markers from the matched symbol name.
2562 Usually the ABI marker will be found on function name
2563 (automatically added because the function returns an
2564 object marked with an ABI tag). However, it's also
2565 possible to see a marker in one of the function
2566 parameters, for example.
2568 string2 (lookup name):
2571 function(some_struct[abi:cxx11], int)
2573 and for completion LCD computation we want to say that
2575 function(some_struct, int)
2577 if (match_for_lcd
!= NULL
)
2579 while ((string1
= strstr (string1
, "[abi:")) != NULL
)
2581 const char *abi_start
= string1
;
2583 /* There can be more than one tag. */
2584 while (skip_abi_tag (&string1
) && *string1
== '[')
2587 if (abi_start
!= string1
)
2588 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2595 return (*string1
!= '\0' && *string1
!= '(');
2604 strncmp_iw (const char *string1
, const char *string2
, size_t string2_len
)
2606 return strncmp_iw_with_mode (string1
, string2
, string2_len
,
2607 strncmp_iw_mode::NORMAL
, language_minimal
);
2613 strcmp_iw (const char *string1
, const char *string2
)
2615 return strncmp_iw_with_mode (string1
, string2
, strlen (string2
),
2616 strncmp_iw_mode::MATCH_PARAMS
, language_minimal
);
2619 /* This is like strcmp except that it ignores whitespace and treats
2620 '(' as the first non-NULL character in terms of ordering. Like
2621 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2622 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2623 according to that ordering.
2625 If a list is sorted according to this function and if you want to
2626 find names in the list that match some fixed NAME according to
2627 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2628 where this function would put NAME.
2630 This function must be neutral to the CASE_SENSITIVITY setting as the user
2631 may choose it during later lookup. Therefore this function always sorts
2632 primarily case-insensitively and secondarily case-sensitively.
2634 Here are some examples of why using strcmp to sort is a bad idea:
2638 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2639 we try to do a search for "foo<char*>", strcmp will locate this
2640 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2641 will start looking at strings beginning with "goo", and will never
2642 see the correct match of "foo<char *>".
2644 Parenthesis example:
2646 In practice, this is less like to be an issue, but I'll give it a
2647 shot. Let's assume that '$' is a legitimate character to occur in
2648 symbols. (Which may well even be the case on some systems.) Then
2649 say that the partial symbol table contains "foo$" and "foo(int)".
2650 strcmp will put them in this order, since '$' < '('. Now, if the
2651 user searches for "foo", then strcmp will sort "foo" before "foo$".
2652 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2653 "foo") is false, so it won't proceed to the actual match of
2654 "foo(int)" with "foo". */
2657 strcmp_iw_ordered (const char *string1
, const char *string2
)
2659 const char *saved_string1
= string1
, *saved_string2
= string2
;
2660 enum case_sensitivity case_pass
= case_sensitive_off
;
2664 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2665 Provide stub characters if we are already at the end of one of the
2667 char c1
= 'X', c2
= 'X';
2669 while (*string1
!= '\0' && *string2
!= '\0')
2671 while (isspace (*string1
))
2673 while (isspace (*string2
))
2678 case case_sensitive_off
:
2679 c1
= tolower ((unsigned char) *string1
);
2680 c2
= tolower ((unsigned char) *string2
);
2682 case case_sensitive_on
:
2690 if (*string1
!= '\0')
2699 /* Characters are non-equal unless they're both '\0'; we want to
2700 make sure we get the comparison right according to our
2701 comparison in the cases where one of them is '\0' or '('. */
2703 if (*string2
== '\0')
2708 if (*string2
== '\0')
2713 if (*string2
== '\0' || *string2
== '(')
2722 if (case_pass
== case_sensitive_on
)
2725 /* Otherwise the strings were equal in case insensitive way, make
2726 a more fine grained comparison in a case sensitive way. */
2728 case_pass
= case_sensitive_on
;
2729 string1
= saved_string1
;
2730 string2
= saved_string2
;
2737 streq (const char *lhs
, const char *rhs
)
2739 return !strcmp (lhs
, rhs
);
2745 streq_hash (const void *lhs
, const void *rhs
)
2747 return streq ((const char *) lhs
, (const char *) rhs
);
2754 ** Answer whether string_to_compare is a full or partial match to
2755 ** template_string. The partial match must be in sequence starting
2759 subset_compare (const char *string_to_compare
, const char *template_string
)
2763 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
2764 && strlen (string_to_compare
) <= strlen (template_string
))
2766 (startswith (template_string
, string_to_compare
));
2773 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2774 struct cmd_list_element
*c
, const char *value
)
2776 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2782 initialize_utils (void)
2784 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
2785 Set number of characters where GDB should wrap lines of its output."), _("\
2786 Show number of characters where GDB should wrap lines of its output."), _("\
2787 This affects where GDB wraps its output to fit the screen width.\n\
2788 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2790 show_chars_per_line
,
2791 &setlist
, &showlist
);
2793 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
2794 Set number of lines in a page for GDB output pagination."), _("\
2795 Show number of lines in a page for GDB output pagination."), _("\
2796 This affects the number of lines after which GDB will pause\n\
2797 its output and ask you whether to continue.\n\
2798 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2800 show_lines_per_page
,
2801 &setlist
, &showlist
);
2803 add_setshow_boolean_cmd ("pagination", class_support
,
2804 &pagination_enabled
, _("\
2805 Set state of GDB output pagination."), _("\
2806 Show state of GDB output pagination."), _("\
2807 When pagination is ON, GDB pauses at end of each screenful of\n\
2808 its output and asks you whether to continue.\n\
2809 Turning pagination off is an alternative to \"set height unlimited\"."),
2811 show_pagination_enabled
,
2812 &setlist
, &showlist
);
2814 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
2815 &sevenbit_strings
, _("\
2816 Set printing of 8-bit characters in strings as \\nnn."), _("\
2817 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
2819 show_sevenbit_strings
,
2820 &setprintlist
, &showprintlist
);
2822 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
2823 &debug_timestamp
, _("\
2824 Set timestamping of debugging messages."), _("\
2825 Show timestamping of debugging messages."), _("\
2826 When set, debugging messages will be marked with seconds and microseconds."),
2828 show_debug_timestamp
,
2829 &setdebuglist
, &showdebuglist
);
2835 address_significant (gdbarch
*gdbarch
, CORE_ADDR addr
)
2837 /* Clear insignificant bits of a target address and sign extend resulting
2838 address, avoiding shifts larger or equal than the width of a CORE_ADDR.
2839 The local variable ADDR_BIT stops the compiler reporting a shift overflow
2840 when it won't occur. Skip updating of target address if current target
2841 has not set gdbarch significant_addr_bit. */
2842 int addr_bit
= gdbarch_significant_addr_bit (gdbarch
);
2844 if (addr_bit
&& (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
)))
2846 CORE_ADDR sign
= (CORE_ADDR
) 1 << (addr_bit
- 1);
2847 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2848 addr
= (addr
^ sign
) - sign
;
2855 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2857 /* Truncate address to the size of a target address, avoiding shifts
2858 larger or equal than the width of a CORE_ADDR. The local
2859 variable ADDR_BIT stops the compiler reporting a shift overflow
2860 when it won't occur. */
2861 /* NOTE: This assumes that the significant address information is
2862 kept in the least significant bits of ADDR - the upper bits were
2863 either zero or sign extended. Should gdbarch_address_to_pointer or
2864 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2866 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2868 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2869 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2870 return hex_string (addr
);
2873 /* This function is described in "defs.h". */
2876 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2878 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2880 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2881 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2883 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2884 that returns the language localized string formatted to a width
2885 based on gdbarch_addr_bit. */
2887 return hex_string_custom (address
, 8);
2889 return hex_string_custom (address
, 16);
2892 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2895 core_addr_hash (const void *ap
)
2897 const CORE_ADDR
*addrp
= (const CORE_ADDR
*) ap
;
2902 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2905 core_addr_eq (const void *ap
, const void *bp
)
2907 const CORE_ADDR
*addr_ap
= (const CORE_ADDR
*) ap
;
2908 const CORE_ADDR
*addr_bp
= (const CORE_ADDR
*) bp
;
2910 return *addr_ap
== *addr_bp
;
2913 /* Convert a string back into a CORE_ADDR. */
2915 string_to_core_addr (const char *my_string
)
2919 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2921 /* Assume that it is in hex. */
2924 for (i
= 2; my_string
[i
] != '\0'; i
++)
2926 if (isdigit (my_string
[i
]))
2927 addr
= (my_string
[i
] - '0') + (addr
* 16);
2928 else if (isxdigit (my_string
[i
]))
2929 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2931 error (_("invalid hex \"%s\""), my_string
);
2936 /* Assume that it is in decimal. */
2939 for (i
= 0; my_string
[i
] != '\0'; i
++)
2941 if (isdigit (my_string
[i
]))
2942 addr
= (my_string
[i
] - '0') + (addr
* 10);
2944 error (_("invalid decimal \"%s\""), my_string
);
2954 gdb_realpath_check_trailer (const char *input
, const char *trailer
)
2956 gdb::unique_xmalloc_ptr
<char> result
= gdb_realpath (input
);
2958 size_t len
= strlen (result
.get ());
2959 size_t trail_len
= strlen (trailer
);
2961 SELF_CHECK (len
>= trail_len
2962 && strcmp (result
.get () + len
- trail_len
, trailer
) == 0);
2966 gdb_realpath_tests ()
2968 /* A file which contains a directory prefix. */
2969 gdb_realpath_check_trailer ("./xfullpath.exp", "/xfullpath.exp");
2970 /* A file which contains a directory prefix. */
2971 gdb_realpath_check_trailer ("../../defs.h", "/defs.h");
2972 /* A one-character filename. */
2973 gdb_realpath_check_trailer ("./a", "/a");
2974 /* A file in the root directory. */
2975 gdb_realpath_check_trailer ("/root_file_which_should_exist",
2976 "/root_file_which_should_exist");
2977 /* A file which does not have a directory prefix. */
2978 gdb_realpath_check_trailer ("xfullpath.exp", "xfullpath.exp");
2979 /* A one-char filename without any directory prefix. */
2980 gdb_realpath_check_trailer ("a", "a");
2981 /* An empty filename. */
2982 gdb_realpath_check_trailer ("", "");
2985 #endif /* GDB_SELF_TEST */
2987 /* Allocation function for the libiberty hash table which uses an
2988 obstack. The obstack is passed as DATA. */
2991 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
2993 size_t total
= size
* count
;
2994 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
2996 memset (ptr
, 0, total
);
3000 /* Trivial deallocation function for the libiberty splay tree and hash
3001 table - don't deallocate anything. Rely on later deletion of the
3002 obstack. DATA will be the obstack, although it is not needed
3006 dummy_obstack_deallocate (void *object
, void *data
)
3011 /* Simple, portable version of dirname that does not modify its
3015 ldirname (const char *filename
)
3017 std::string dirname
;
3018 const char *base
= lbasename (filename
);
3020 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
3023 if (base
== filename
)
3026 dirname
= std::string (filename
, base
- filename
);
3028 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3029 create "d:./bar" later instead of the (different) "d:/bar". */
3030 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3031 && !IS_DIR_SEPARATOR (filename
[0]))
3032 dirname
[base
++ - filename
] = '.';
3040 gdb_argv::reset (const char *s
)
3042 char **argv
= buildargv (s
);
3044 if (s
!= NULL
&& argv
== NULL
)
3052 compare_positive_ints (const void *ap
, const void *bp
)
3054 /* Because we know we're comparing two ints which are positive,
3055 there's no danger of overflow here. */
3056 return * (int *) ap
- * (int *) bp
;
3059 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3060 #define AMBIGUOUS_MESS2 \
3061 ".\nUse \"set gnutarget format-name\" to specify the format."
3064 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3068 /* Check if errmsg just need simple return. */
3069 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3070 return bfd_errmsg (error_tag
);
3072 std::string
ret (bfd_errmsg (error_tag
));
3073 ret
+= AMBIGUOUS_MESS1
;
3075 for (p
= matching
; *p
; p
++)
3080 ret
+= AMBIGUOUS_MESS2
;
3087 /* Return ARGS parsed as a valid pid, or throw an error. */
3090 parse_pid_to_attach (const char *args
)
3096 error_no_arg (_("process-id to attach"));
3098 dummy
= (char *) args
;
3099 pid
= strtoul (args
, &dummy
, 0);
3100 /* Some targets don't set errno on errors, grrr! */
3101 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3102 error (_("Illegal process-id: %s."), args
);
3107 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3108 must come from xrealloc-compatible allocator and it may be updated. FROM
3109 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3110 located at the start or end of *STRINGP. */
3113 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3115 char *string
= *stringp
, *s
;
3116 const size_t from_len
= strlen (from
);
3117 const size_t to_len
= strlen (to
);
3121 s
= strstr (s
, from
);
3125 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3126 || s
[-1] == DIRNAME_SEPARATOR
)
3127 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3128 || s
[from_len
] == DIRNAME_SEPARATOR
))
3133 = (char *) xrealloc (string
, (strlen (string
) + to_len
+ 1));
3135 /* Relocate the current S pointer. */
3136 s
= s
- string
+ string_new
;
3137 string
= string_new
;
3139 /* Replace from by to. */
3140 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3141 memcpy (s
, to
, to_len
);
3156 /* SIGALRM handler for waitpid_with_timeout. */
3159 sigalrm_handler (int signo
)
3161 /* Nothing to do. */
3166 /* Wrapper to wait for child PID to die with TIMEOUT.
3167 TIMEOUT is the time to stop waiting in seconds.
3168 If TIMEOUT is zero, pass WNOHANG to waitpid.
3169 Returns PID if it was successfully waited for, otherwise -1.
3171 Timeouts are currently implemented with alarm and SIGALRM.
3172 If the host does not support them, this waits "forever".
3173 It would be odd though for a host to have waitpid and not SIGALRM. */
3176 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3178 pid_t waitpid_result
;
3180 gdb_assert (pid
> 0);
3181 gdb_assert (timeout
>= 0);
3186 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3187 struct sigaction sa
, old_sa
;
3189 sa
.sa_handler
= sigalrm_handler
;
3190 sigemptyset (&sa
.sa_mask
);
3192 sigaction (SIGALRM
, &sa
, &old_sa
);
3196 ofunc
= signal (SIGALRM
, sigalrm_handler
);
3202 waitpid_result
= waitpid (pid
, status
, 0);
3206 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3207 sigaction (SIGALRM
, &old_sa
, NULL
);
3209 signal (SIGALRM
, ofunc
);
3214 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3216 if (waitpid_result
== pid
)
3222 #endif /* HAVE_WAITPID */
3224 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3225 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3227 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3228 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3231 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3233 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3235 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3236 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3238 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3240 char *pattern_slash
, *string_slash
;
3242 /* Replace '\' by '/' in both strings. */
3244 pattern_slash
= (char *) alloca (strlen (pattern
) + 1);
3245 strcpy (pattern_slash
, pattern
);
3246 pattern
= pattern_slash
;
3247 for (; *pattern_slash
!= 0; pattern_slash
++)
3248 if (IS_DIR_SEPARATOR (*pattern_slash
))
3249 *pattern_slash
= '/';
3251 string_slash
= (char *) alloca (strlen (string
) + 1);
3252 strcpy (string_slash
, string
);
3253 string
= string_slash
;
3254 for (; *string_slash
!= 0; string_slash
++)
3255 if (IS_DIR_SEPARATOR (*string_slash
))
3256 *string_slash
= '/';
3258 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3260 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3261 flags
|= FNM_CASEFOLD
;
3262 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3264 return fnmatch (pattern
, string
, flags
);
3267 /* Return the number of path elements in PATH.
3275 count_path_elements (const char *path
)
3278 const char *p
= path
;
3280 if (HAS_DRIVE_SPEC (p
))
3282 p
= STRIP_DRIVE_SPEC (p
);
3288 if (IS_DIR_SEPARATOR (*p
))
3293 /* Backup one if last character is /, unless it's the only one. */
3294 if (p
> path
+ 1 && IS_DIR_SEPARATOR (p
[-1]))
3297 /* Add one for the file name, if present. */
3298 if (p
> path
&& !IS_DIR_SEPARATOR (p
[-1]))
3304 /* Remove N leading path elements from PATH.
3305 N must be non-negative.
3306 If PATH has more than N path elements then return NULL.
3307 If PATH has exactly N path elements then return "".
3308 See count_path_elements for a description of how we do the counting. */
3311 strip_leading_path_elements (const char *path
, int n
)
3314 const char *p
= path
;
3316 gdb_assert (n
>= 0);
3321 if (HAS_DRIVE_SPEC (p
))
3323 p
= STRIP_DRIVE_SPEC (p
);
3329 while (*p
!= '\0' && !IS_DIR_SEPARATOR (*p
))
3347 copy_bitwise (gdb_byte
*dest
, ULONGEST dest_offset
,
3348 const gdb_byte
*source
, ULONGEST source_offset
,
3349 ULONGEST nbits
, int bits_big_endian
)
3351 unsigned int buf
, avail
;
3356 if (bits_big_endian
)
3358 /* Start from the end, then work backwards. */
3359 dest_offset
+= nbits
- 1;
3360 dest
+= dest_offset
/ 8;
3361 dest_offset
= 7 - dest_offset
% 8;
3362 source_offset
+= nbits
- 1;
3363 source
+= source_offset
/ 8;
3364 source_offset
= 7 - source_offset
% 8;
3368 dest
+= dest_offset
/ 8;
3370 source
+= source_offset
/ 8;
3374 /* Fill BUF with DEST_OFFSET bits from the destination and 8 -
3375 SOURCE_OFFSET bits from the source. */
3376 buf
= *(bits_big_endian
? source
-- : source
++) >> source_offset
;
3377 buf
<<= dest_offset
;
3378 buf
|= *dest
& ((1 << dest_offset
) - 1);
3380 /* NBITS: bits yet to be written; AVAIL: BUF's fill level. */
3381 nbits
+= dest_offset
;
3382 avail
= dest_offset
+ 8 - source_offset
;
3384 /* Flush 8 bits from BUF, if appropriate. */
3385 if (nbits
>= 8 && avail
>= 8)
3387 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3393 /* Copy the middle part. */
3396 size_t len
= nbits
/ 8;
3398 /* Use a faster method for byte-aligned copies. */
3401 if (bits_big_endian
)
3405 memcpy (dest
+ 1, source
+ 1, len
);
3409 memcpy (dest
, source
, len
);
3418 buf
|= *(bits_big_endian
? source
-- : source
++) << avail
;
3419 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3426 /* Write the last byte. */
3430 buf
|= *source
<< avail
;
3432 buf
&= (1 << nbits
) - 1;
3433 *dest
= (*dest
& (~0 << nbits
)) | buf
;
3438 _initialize_utils (void)
3440 add_internal_problem_command (&internal_error_problem
);
3441 add_internal_problem_command (&internal_warning_problem
);
3442 add_internal_problem_command (&demangler_warning_problem
);
3445 selftests::register_test ("gdb_realpath", gdb_realpath_tests
);