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
);
897 if (deprecated_query_hook
)
899 target_terminal::scoped_restore_terminal_state term_state
;
900 return deprecated_query_hook (ctlstr
, args
);
903 /* Format the question outside of the loop, to avoid reusing args. */
904 std::string question
= string_vprintf (ctlstr
, args
);
906 = string_printf (_("%s%s(%s or %s) %s"),
907 annotation_level
> 1 ? "\n\032\032pre-query\n" : "",
908 question
.c_str (), y_string
, n_string
,
909 annotation_level
> 1 ? "\n\032\032query\n" : "");
911 /* Used to add duration we waited for user to respond to
912 prompt_for_continue_wait_time. */
913 using namespace std::chrono
;
914 steady_clock::time_point prompt_started
= steady_clock::now ();
916 scoped_input_handler prepare_input
;
920 char *response
, answer
;
922 gdb_flush (gdb_stdout
);
923 response
= gdb_readline_wrapper (prompt
.c_str ());
925 if (response
== NULL
) /* C-d */
927 printf_filtered ("EOF [assumed %c]\n", def_answer
);
932 answer
= response
[0];
937 /* Check answer. For the non-default, the user must specify
938 the non-default explicitly. */
939 if (answer
== not_def_answer
)
944 /* Otherwise, if a default was specified, the user may either
945 specify the required input or have it default by entering
947 if (answer
== def_answer
948 || (defchar
!= '\0' && answer
== '\0'))
953 /* Invalid entries are not defaulted and require another selection. */
954 printf_filtered (_("Please answer %s or %s.\n"),
958 /* Add time spend in this routine to prompt_for_continue_wait_time. */
959 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
961 if (annotation_level
> 1)
962 printf_filtered (("\n\032\032post-query\n"));
967 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
968 answer is yes, or 0 if answer is defaulted.
969 Takes three args which are given to printf to print the question.
970 The first, a control string, should end in "? ".
971 It should not say how to answer, because we do that. */
974 nquery (const char *ctlstr
, ...)
979 va_start (args
, ctlstr
);
980 ret
= defaulted_query (ctlstr
, 'n', args
);
985 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
986 answer is yes, or 1 if answer is defaulted.
987 Takes three args which are given to printf to print the question.
988 The first, a control string, should end in "? ".
989 It should not say how to answer, because we do that. */
992 yquery (const char *ctlstr
, ...)
997 va_start (args
, ctlstr
);
998 ret
= defaulted_query (ctlstr
, 'y', args
);
1003 /* Ask user a y-or-n question and return 1 iff answer is yes.
1004 Takes three args which are given to printf to print the question.
1005 The first, a control string, should end in "? ".
1006 It should not say how to answer, because we do that. */
1009 query (const char *ctlstr
, ...)
1014 va_start (args
, ctlstr
);
1015 ret
= defaulted_query (ctlstr
, '\0', args
);
1020 /* A helper for parse_escape that converts a host character to a
1021 target character. C is the host character. If conversion is
1022 possible, then the target character is stored in *TARGET_C and the
1023 function returns 1. Otherwise, the function returns 0. */
1026 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1031 auto_obstack host_data
;
1033 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1034 (gdb_byte
*) &the_char
, 1, 1,
1035 &host_data
, translit_none
);
1037 if (obstack_object_size (&host_data
) == 1)
1040 *target_c
= *(char *) obstack_base (&host_data
);
1046 /* Parse a C escape sequence. STRING_PTR points to a variable
1047 containing a pointer to the string to parse. That pointer
1048 should point to the character after the \. That pointer
1049 is updated past the characters we use. The value of the
1050 escape sequence is returned.
1052 A negative value means the sequence \ newline was seen,
1053 which is supposed to be equivalent to nothing at all.
1055 If \ is followed by a null character, we return a negative
1056 value and leave the string pointer pointing at the null character.
1058 If \ is followed by 000, we return 0 and leave the string pointer
1059 after the zeros. A value of 0 does not mean end of string. */
1062 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1064 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1065 int c
= *(*string_ptr
)++;
1084 int i
= host_hex_value (c
);
1089 if (isdigit (c
) && c
!= '8' && c
!= '9')
1093 i
+= host_hex_value (c
);
1129 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1130 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1131 " which has no equivalent\nin the `%s' character set."),
1132 c
, c
, target_charset (gdbarch
));
1136 /* Print the character C on STREAM as part of the contents of a literal
1137 string whose delimiter is QUOTER. Note that this routine should only
1138 be called for printing things which are independent of the language
1139 of the program being debugged.
1141 printchar will normally escape backslashes and instances of QUOTER. If
1142 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1143 As a side effect, if you pass the backslash character as the QUOTER,
1144 printchar will escape backslashes as usual, but not any other quoting
1148 printchar (int c
, do_fputc_ftype do_fputc
, ui_file
*stream
, int quoter
)
1150 c
&= 0xFF; /* Avoid sign bit follies */
1152 if (c
< 0x20 || /* Low control chars */
1153 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1154 (sevenbit_strings
&& c
>= 0x80))
1155 { /* high order bit set */
1156 do_fputc ('\\', stream
);
1161 do_fputc ('n', stream
);
1164 do_fputc ('b', stream
);
1167 do_fputc ('t', stream
);
1170 do_fputc ('f', stream
);
1173 do_fputc ('r', stream
);
1176 do_fputc ('e', stream
);
1179 do_fputc ('a', stream
);
1183 do_fputc ('0' + ((c
>> 6) & 0x7), stream
);
1184 do_fputc ('0' + ((c
>> 3) & 0x7), stream
);
1185 do_fputc ('0' + ((c
>> 0) & 0x7), stream
);
1192 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1193 do_fputc ('\\', stream
);
1194 do_fputc (c
, stream
);
1198 /* Print the character C on STREAM as part of the contents of a
1199 literal string whose delimiter is QUOTER. Note that these routines
1200 should only be call for printing things which are independent of
1201 the language of the program being debugged. */
1204 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1207 printchar (*str
++, fputc_filtered
, stream
, quoter
);
1211 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1214 printchar (*str
++, fputc_unfiltered
, stream
, quoter
);
1218 fputstrn_filtered (const char *str
, int n
, int quoter
,
1219 struct ui_file
*stream
)
1221 for (int i
= 0; i
< n
; i
++)
1222 printchar (str
[i
], fputc_filtered
, stream
, quoter
);
1226 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1227 do_fputc_ftype do_fputc
, struct ui_file
*stream
)
1229 for (int i
= 0; i
< n
; i
++)
1230 printchar (str
[i
], do_fputc
, stream
, quoter
);
1234 /* Number of lines per page or UINT_MAX if paging is disabled. */
1235 static unsigned int lines_per_page
;
1237 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1238 struct cmd_list_element
*c
, const char *value
)
1240 fprintf_filtered (file
,
1241 _("Number of lines gdb thinks are in a page is %s.\n"),
1245 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1246 static unsigned int chars_per_line
;
1248 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1249 struct cmd_list_element
*c
, const char *value
)
1251 fprintf_filtered (file
,
1252 _("Number of characters gdb thinks "
1253 "are in a line is %s.\n"),
1257 /* Current count of lines printed on this page, chars on this line. */
1258 static unsigned int lines_printed
, chars_printed
;
1260 /* True if pagination is disabled for just one command. */
1262 static bool pagination_disabled_for_command
;
1264 /* Buffer and start column of buffered text, for doing smarter word-
1265 wrapping. When someone calls wrap_here(), we start buffering output
1266 that comes through fputs_filtered(). If we see a newline, we just
1267 spit it out and forget about the wrap_here(). If we see another
1268 wrap_here(), we spit it out and remember the newer one. If we see
1269 the end of the line, we spit out a newline, the indent, and then
1270 the buffered output. */
1272 static bool filter_initialized
= false;
1274 /* Contains characters which are waiting to be output (they have
1275 already been counted in chars_printed). */
1276 static std::string wrap_buffer
;
1278 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1280 static const char *wrap_indent
;
1282 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1283 is not in effect. */
1284 static int wrap_column
;
1286 /* The style applied at the time that wrap_here was called. */
1287 static ui_file_style wrap_style
;
1290 /* Initialize the number of lines per page and chars per line. */
1293 init_page_info (void)
1297 lines_per_page
= UINT_MAX
;
1298 chars_per_line
= UINT_MAX
;
1302 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1307 #if defined(__GO32__)
1308 rows
= ScreenRows ();
1309 cols
= ScreenCols ();
1310 lines_per_page
= rows
;
1311 chars_per_line
= cols
;
1313 /* Make sure Readline has initialized its terminal settings. */
1314 rl_reset_terminal (NULL
);
1316 /* Get the screen size from Readline. */
1317 rl_get_screen_size (&rows
, &cols
);
1318 lines_per_page
= rows
;
1319 chars_per_line
= cols
;
1321 /* Readline should have fetched the termcap entry for us.
1322 Only try to use tgetnum function if rl_get_screen_size
1323 did not return a useful value. */
1324 if (((rows
<= 0) && (tgetnum ((char *) "li") < 0))
1325 /* Also disable paging if inside Emacs. $EMACS was used
1326 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1327 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1329 /* The number of lines per page is not mentioned in the terminal
1330 description or EMACS evironment variable is set. This probably
1331 means that paging is not useful, so disable paging. */
1332 lines_per_page
= UINT_MAX
;
1335 /* If the output is not a terminal, don't paginate it. */
1336 if (!ui_file_isatty (gdb_stdout
))
1337 lines_per_page
= UINT_MAX
;
1341 /* We handle SIGWINCH ourselves. */
1342 rl_catch_sigwinch
= 0;
1348 /* Return nonzero if filtered printing is initialized. */
1350 filtered_printing_initialized (void)
1352 return filter_initialized
;
1355 set_batch_flag_and_restore_page_info::set_batch_flag_and_restore_page_info ()
1356 : m_save_lines_per_page (lines_per_page
),
1357 m_save_chars_per_line (chars_per_line
),
1358 m_save_batch_flag (batch_flag
)
1364 set_batch_flag_and_restore_page_info::~set_batch_flag_and_restore_page_info ()
1366 batch_flag
= m_save_batch_flag
;
1367 chars_per_line
= m_save_chars_per_line
;
1368 lines_per_page
= m_save_lines_per_page
;
1374 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1377 set_screen_size (void)
1379 int rows
= lines_per_page
;
1380 int cols
= chars_per_line
;
1382 /* If we get 0 or negative ROWS or COLS, treat as "infinite" size.
1383 A negative number can be seen here with the "set width/height"
1384 commands and either:
1386 - the user specified "unlimited", which maps to UINT_MAX, or
1387 - the user spedified some number between INT_MAX and UINT_MAX.
1389 Cap "infinity" to approximately sqrt(INT_MAX) so that we don't
1390 overflow in rl_set_screen_size, which multiplies rows and columns
1391 to compute the number of characters on the screen. */
1393 const int sqrt_int_max
= INT_MAX
>> (sizeof (int) * 8 / 2);
1395 if (rows
<= 0 || rows
> sqrt_int_max
)
1397 rows
= sqrt_int_max
;
1398 lines_per_page
= UINT_MAX
;
1401 if (cols
<= 0 || cols
> sqrt_int_max
)
1403 cols
= sqrt_int_max
;
1404 chars_per_line
= UINT_MAX
;
1407 /* Update Readline's idea of the terminal size. */
1408 rl_set_screen_size (rows
, cols
);
1411 /* Reinitialize WRAP_BUFFER. */
1416 if (chars_per_line
== 0)
1419 wrap_buffer
.clear ();
1420 filter_initialized
= true;
1424 set_width_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1431 set_height_command (const char *args
, int from_tty
, struct cmd_list_element
*c
)
1439 set_screen_width_and_height (int width
, int height
)
1441 lines_per_page
= height
;
1442 chars_per_line
= width
;
1448 /* The currently applied style. */
1450 static ui_file_style applied_style
;
1452 /* Emit an ANSI style escape for STYLE. If STREAM is nullptr, emit to
1453 the wrap buffer; otherwise emit to STREAM. */
1456 emit_style_escape (const ui_file_style
&style
,
1457 struct ui_file
*stream
= nullptr)
1459 applied_style
= style
;
1461 if (stream
== nullptr)
1462 wrap_buffer
.append (style
.to_ansi ());
1464 fputs_unfiltered (style
.to_ansi ().c_str (), stream
);
1470 can_emit_style_escape (struct ui_file
*stream
)
1472 if (stream
!= gdb_stdout
1474 || !ui_file_isatty (stream
))
1476 const char *term
= getenv ("TERM");
1477 if (term
== nullptr || !strcmp (term
, "dumb"))
1482 /* Set the current output style. This will affect future uses of the
1483 _filtered output functions. */
1486 set_output_style (struct ui_file
*stream
, const ui_file_style
&style
)
1488 if (!can_emit_style_escape (stream
))
1491 /* Note that we don't pass STREAM here, because we want to emit to
1492 the wrap buffer, not directly to STREAM. */
1493 emit_style_escape (style
);
1499 reset_terminal_style (struct ui_file
*stream
)
1501 if (can_emit_style_escape (stream
))
1503 /* Force the setting, regardless of what we think the setting
1504 might already be. */
1505 applied_style
= ui_file_style ();
1506 wrap_buffer
.append (applied_style
.to_ansi ());
1510 /* Wait, so the user can read what's on the screen. Prompt the user
1511 to continue by pressing RETURN. 'q' is also provided because
1512 telling users what to do in the prompt is more user-friendly than
1513 expecting them to think of Ctrl-C/SIGINT. */
1516 prompt_for_continue (void)
1518 char cont_prompt
[120];
1519 /* Used to add duration we waited for user to respond to
1520 prompt_for_continue_wait_time. */
1521 using namespace std::chrono
;
1522 steady_clock::time_point prompt_started
= steady_clock::now ();
1523 bool disable_pagination
= pagination_disabled_for_command
;
1525 /* Clear the current styling. */
1526 if (can_emit_style_escape (gdb_stdout
))
1527 emit_style_escape (ui_file_style (), gdb_stdout
);
1529 if (annotation_level
> 1)
1530 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1532 strcpy (cont_prompt
,
1533 "--Type <RET> for more, q to quit, "
1534 "c to continue without paging--");
1535 if (annotation_level
> 1)
1536 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1538 /* We must do this *before* we call gdb_readline_wrapper, else it
1539 will eventually call us -- thinking that we're trying to print
1540 beyond the end of the screen. */
1541 reinitialize_more_filter ();
1543 scoped_input_handler prepare_input
;
1545 /* Call gdb_readline_wrapper, not readline, in order to keep an
1546 event loop running. */
1547 gdb::unique_xmalloc_ptr
<char> ignore (gdb_readline_wrapper (cont_prompt
));
1549 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1550 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1552 if (annotation_level
> 1)
1553 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1557 char *p
= ignore
.get ();
1559 while (*p
== ' ' || *p
== '\t')
1562 /* Do not call quit here; there is no possibility of SIGINT. */
1563 throw_quit ("Quit");
1565 disable_pagination
= true;
1568 /* Now we have to do this again, so that GDB will know that it doesn't
1569 need to save the ---Type <return>--- line at the top of the screen. */
1570 reinitialize_more_filter ();
1571 pagination_disabled_for_command
= disable_pagination
;
1573 /* Restore the current styling. */
1574 if (can_emit_style_escape (gdb_stdout
))
1575 emit_style_escape (applied_style
);
1577 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1580 /* Initialize timer to keep track of how long we waited for the user. */
1583 reset_prompt_for_continue_wait_time (void)
1585 using namespace std::chrono
;
1587 prompt_for_continue_wait_time
= steady_clock::duration::zero ();
1590 /* Fetch the cumulative time spent in prompt_for_continue. */
1592 std::chrono::steady_clock::duration
1593 get_prompt_for_continue_wait_time ()
1595 return prompt_for_continue_wait_time
;
1598 /* Reinitialize filter; ie. tell it to reset to original values. */
1601 reinitialize_more_filter (void)
1605 pagination_disabled_for_command
= false;
1608 /* Flush the wrap buffer to STREAM, if necessary. */
1611 flush_wrap_buffer (struct ui_file
*stream
)
1613 if (stream
== gdb_stdout
&& !wrap_buffer
.empty ())
1615 fputs_unfiltered (wrap_buffer
.c_str (), stream
);
1616 wrap_buffer
.clear ();
1620 /* Indicate that if the next sequence of characters overflows the line,
1621 a newline should be inserted here rather than when it hits the end.
1622 If INDENT is non-null, it is a string to be printed to indent the
1623 wrapped part on the next line. INDENT must remain accessible until
1624 the next call to wrap_here() or until a newline is printed through
1627 If the line is already overfull, we immediately print a newline and
1628 the indentation, and disable further wrapping.
1630 If we don't know the width of lines, but we know the page height,
1631 we must not wrap words, but should still keep track of newlines
1632 that were explicitly printed.
1634 INDENT should not contain tabs, as that will mess up the char count
1635 on the next line. FIXME.
1637 This routine is guaranteed to force out any output which has been
1638 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1639 used to force out output from the wrap_buffer. */
1642 wrap_here (const char *indent
)
1644 /* This should have been allocated, but be paranoid anyway. */
1645 if (!filter_initialized
)
1646 internal_error (__FILE__
, __LINE__
,
1647 _("failed internal consistency check"));
1649 flush_wrap_buffer (gdb_stdout
);
1650 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1654 else if (chars_printed
>= chars_per_line
)
1656 puts_filtered ("\n");
1658 puts_filtered (indent
);
1663 wrap_column
= chars_printed
;
1667 wrap_indent
= indent
;
1668 wrap_style
= applied_style
;
1672 /* Print input string to gdb_stdout, filtered, with wrap,
1673 arranging strings in columns of n chars. String can be
1674 right or left justified in the column. Never prints
1675 trailing spaces. String should never be longer than
1676 width. FIXME: this could be useful for the EXAMINE
1677 command, which currently doesn't tabulate very well. */
1680 puts_filtered_tabular (char *string
, int width
, int right
)
1686 gdb_assert (chars_per_line
> 0);
1687 if (chars_per_line
== UINT_MAX
)
1689 fputs_filtered (string
, gdb_stdout
);
1690 fputs_filtered ("\n", gdb_stdout
);
1694 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1695 fputs_filtered ("\n", gdb_stdout
);
1697 if (width
>= chars_per_line
)
1698 width
= chars_per_line
- 1;
1700 stringlen
= strlen (string
);
1702 if (chars_printed
> 0)
1703 spaces
= width
- (chars_printed
- 1) % width
- 1;
1705 spaces
+= width
- stringlen
;
1707 spacebuf
= (char *) alloca (spaces
+ 1);
1708 spacebuf
[spaces
] = '\0';
1710 spacebuf
[spaces
] = ' ';
1712 fputs_filtered (spacebuf
, gdb_stdout
);
1713 fputs_filtered (string
, gdb_stdout
);
1717 /* Ensure that whatever gets printed next, using the filtered output
1718 commands, starts at the beginning of the line. I.e. if there is
1719 any pending output for the current line, flush it and start a new
1720 line. Otherwise do nothing. */
1725 if (chars_printed
> 0)
1727 puts_filtered ("\n");
1732 /* Like fputs but if FILTER is true, pause after every screenful.
1734 Regardless of FILTER can wrap at points other than the final
1735 character of a line.
1737 Unlike fputs, fputs_maybe_filtered does not return a value.
1738 It is OK for LINEBUFFER to be NULL, in which case just don't print
1741 Note that a longjmp to top level may occur in this routine (only if
1742 FILTER is true) (since prompt_for_continue may do so) so this
1743 routine should not be called when cleanups are not in place. */
1746 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1749 const char *lineptr
;
1751 if (linebuffer
== 0)
1754 /* Don't do any filtering if it is disabled. */
1755 if (stream
!= gdb_stdout
1756 || !pagination_enabled
1757 || pagination_disabled_for_command
1759 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
1760 || top_level_interpreter () == NULL
1761 || top_level_interpreter ()->interp_ui_out ()->is_mi_like_p ())
1763 flush_wrap_buffer (stream
);
1764 fputs_unfiltered (linebuffer
, stream
);
1769 = make_scope_exit ([&] ()
1771 wrap_buffer
.clear ();
1776 /* Go through and output each character. Show line extension
1777 when this is necessary; prompt user for new page when this is
1780 lineptr
= linebuffer
;
1783 /* Possible new page. Note that PAGINATION_DISABLED_FOR_COMMAND
1784 might be set during this loop, so we must continue to check
1786 if (filter
&& (lines_printed
>= lines_per_page
- 1)
1787 && !pagination_disabled_for_command
)
1788 prompt_for_continue ();
1790 while (*lineptr
&& *lineptr
!= '\n')
1794 /* Print a single line. */
1795 if (*lineptr
== '\t')
1797 wrap_buffer
.push_back ('\t');
1798 /* Shifting right by 3 produces the number of tab stops
1799 we have already passed, and then adding one and
1800 shifting left 3 advances to the next tab stop. */
1801 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
1804 else if (*lineptr
== '\033'
1805 && skip_ansi_escape (lineptr
, &skip_bytes
))
1807 wrap_buffer
.append (lineptr
, skip_bytes
);
1808 /* Note that we don't consider this a character, so we
1809 don't increment chars_printed here. */
1810 lineptr
+= skip_bytes
;
1814 wrap_buffer
.push_back (*lineptr
);
1819 if (chars_printed
>= chars_per_line
)
1821 unsigned int save_chars
= chars_printed
;
1827 if (can_emit_style_escape (stream
))
1828 emit_style_escape (ui_file_style (), stream
);
1829 /* If we aren't actually wrapping, don't output
1830 newline -- if chars_per_line is right, we
1831 probably just overflowed anyway; if it's wrong,
1832 let us keep going. */
1833 fputc_unfiltered ('\n', stream
);
1836 flush_wrap_buffer (stream
);
1838 /* Possible new page. Note that
1839 PAGINATION_DISABLED_FOR_COMMAND might be set during
1840 this loop, so we must continue to check it here. */
1841 if (lines_printed
>= lines_per_page
- 1
1842 && !pagination_disabled_for_command
)
1843 prompt_for_continue ();
1845 /* Now output indentation and wrapped string. */
1848 fputs_unfiltered (wrap_indent
, stream
);
1849 if (can_emit_style_escape (stream
))
1850 emit_style_escape (wrap_style
, stream
);
1851 /* FIXME, this strlen is what prevents wrap_indent from
1852 containing tabs. However, if we recurse to print it
1853 and count its chars, we risk trouble if wrap_indent is
1854 longer than (the user settable) chars_per_line.
1855 Note also that this can set chars_printed > chars_per_line
1856 if we are printing a long string. */
1857 chars_printed
= strlen (wrap_indent
)
1858 + (save_chars
- wrap_column
);
1859 wrap_column
= 0; /* And disable fancy wrap */
1864 if (*lineptr
== '\n')
1867 wrap_here ((char *) 0); /* Spit out chars, cancel
1870 fputc_unfiltered ('\n', stream
);
1875 buffer_clearer
.release ();
1879 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
1881 fputs_maybe_filtered (linebuffer
, stream
, 1);
1887 fputs_styled (const char *linebuffer
, const ui_file_style
&style
,
1888 struct ui_file
*stream
)
1890 /* This just makes it so we emit somewhat fewer escape
1892 if (style
.is_default ())
1893 fputs_maybe_filtered (linebuffer
, stream
, 1);
1896 set_output_style (stream
, style
);
1897 fputs_maybe_filtered (linebuffer
, stream
, 1);
1898 set_output_style (stream
, ui_file_style ());
1903 putchar_unfiltered (int c
)
1907 ui_file_write (gdb_stdout
, &buf
, 1);
1911 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
1912 May return nonlocally. */
1915 putchar_filtered (int c
)
1917 return fputc_filtered (c
, gdb_stdout
);
1921 fputc_unfiltered (int c
, struct ui_file
*stream
)
1925 ui_file_write (stream
, &buf
, 1);
1930 fputc_filtered (int c
, struct ui_file
*stream
)
1936 fputs_filtered (buf
, stream
);
1940 /* puts_debug is like fputs_unfiltered, except it prints special
1941 characters in printable fashion. */
1944 puts_debug (char *prefix
, char *string
, char *suffix
)
1948 /* Print prefix and suffix after each line. */
1949 static int new_line
= 1;
1950 static int return_p
= 0;
1951 static const char *prev_prefix
= "";
1952 static const char *prev_suffix
= "";
1954 if (*string
== '\n')
1957 /* If the prefix is changing, print the previous suffix, a new line,
1958 and the new prefix. */
1959 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
1961 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
1962 fputs_unfiltered ("\n", gdb_stdlog
);
1963 fputs_unfiltered (prefix
, gdb_stdlog
);
1966 /* Print prefix if we printed a newline during the previous call. */
1970 fputs_unfiltered (prefix
, gdb_stdlog
);
1973 prev_prefix
= prefix
;
1974 prev_suffix
= suffix
;
1976 /* Output characters in a printable format. */
1977 while ((ch
= *string
++) != '\0')
1983 fputc_unfiltered (ch
, gdb_stdlog
);
1986 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
1990 fputs_unfiltered ("\\\\", gdb_stdlog
);
1993 fputs_unfiltered ("\\b", gdb_stdlog
);
1996 fputs_unfiltered ("\\f", gdb_stdlog
);
2000 fputs_unfiltered ("\\n", gdb_stdlog
);
2003 fputs_unfiltered ("\\r", gdb_stdlog
);
2006 fputs_unfiltered ("\\t", gdb_stdlog
);
2009 fputs_unfiltered ("\\v", gdb_stdlog
);
2013 return_p
= ch
== '\r';
2016 /* Print suffix if we printed a newline. */
2019 fputs_unfiltered (suffix
, gdb_stdlog
);
2020 fputs_unfiltered ("\n", gdb_stdlog
);
2025 /* Print a variable number of ARGS using format FORMAT. If this
2026 information is going to put the amount written (since the last call
2027 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2028 call prompt_for_continue to get the users permision to continue.
2030 Unlike fprintf, this function does not return a value.
2032 We implement three variants, vfprintf (takes a vararg list and stream),
2033 fprintf (takes a stream to write on), and printf (the usual).
2035 Note also that a longjmp to top level may occur in this routine
2036 (since prompt_for_continue may do so) so this routine should not be
2037 called when cleanups are not in place. */
2040 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2041 va_list args
, int filter
)
2043 std::string linebuffer
= string_vprintf (format
, args
);
2044 fputs_maybe_filtered (linebuffer
.c_str (), stream
, filter
);
2049 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2051 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2055 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2057 std::string linebuffer
= string_vprintf (format
, args
);
2058 if (debug_timestamp
&& stream
== gdb_stdlog
)
2060 using namespace std::chrono
;
2063 steady_clock::time_point now
= steady_clock::now ();
2064 seconds s
= duration_cast
<seconds
> (now
.time_since_epoch ());
2065 microseconds us
= duration_cast
<microseconds
> (now
.time_since_epoch () - s
);
2067 len
= linebuffer
.size ();
2068 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2070 std::string timestamp
= string_printf ("%ld.%06ld %s%s",
2073 linebuffer
.c_str (),
2074 need_nl
? "\n": "");
2075 fputs_unfiltered (timestamp
.c_str (), stream
);
2078 fputs_unfiltered (linebuffer
.c_str (), stream
);
2082 vprintf_filtered (const char *format
, va_list args
)
2084 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2088 vprintf_unfiltered (const char *format
, va_list args
)
2090 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2094 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2098 va_start (args
, format
);
2099 vfprintf_filtered (stream
, format
, args
);
2104 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2108 va_start (args
, format
);
2109 vfprintf_unfiltered (stream
, format
, args
);
2113 /* Like fprintf_filtered, but prints its result indented.
2114 Called as fprintfi_filtered (spaces, stream, format, ...); */
2117 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2122 va_start (args
, format
);
2123 print_spaces_filtered (spaces
, stream
);
2125 vfprintf_filtered (stream
, format
, args
);
2132 fprintf_styled (struct ui_file
*stream
, const ui_file_style
&style
,
2133 const char *format
, ...)
2137 set_output_style (stream
, style
);
2138 va_start (args
, format
);
2139 vfprintf_filtered (stream
, format
, args
);
2141 set_output_style (stream
, ui_file_style ());
2146 printf_filtered (const char *format
, ...)
2150 va_start (args
, format
);
2151 vfprintf_filtered (gdb_stdout
, format
, args
);
2157 printf_unfiltered (const char *format
, ...)
2161 va_start (args
, format
);
2162 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2166 /* Like printf_filtered, but prints it's result indented.
2167 Called as printfi_filtered (spaces, format, ...); */
2170 printfi_filtered (int spaces
, const char *format
, ...)
2174 va_start (args
, format
);
2175 print_spaces_filtered (spaces
, gdb_stdout
);
2176 vfprintf_filtered (gdb_stdout
, format
, args
);
2180 /* Easy -- but watch out!
2182 This routine is *not* a replacement for puts()! puts() appends a newline.
2183 This one doesn't, and had better not! */
2186 puts_filtered (const char *string
)
2188 fputs_filtered (string
, gdb_stdout
);
2192 puts_unfiltered (const char *string
)
2194 fputs_unfiltered (string
, gdb_stdout
);
2197 /* Return a pointer to N spaces and a null. The pointer is good
2198 until the next call to here. */
2203 static char *spaces
= 0;
2204 static int max_spaces
= -1;
2210 spaces
= (char *) xmalloc (n
+ 1);
2211 for (t
= spaces
+ n
; t
!= spaces
;)
2217 return spaces
+ max_spaces
- n
;
2220 /* Print N spaces. */
2222 print_spaces_filtered (int n
, struct ui_file
*stream
)
2224 fputs_filtered (n_spaces (n
), stream
);
2227 /* C++/ObjC demangler stuff. */
2229 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2230 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2231 If the name is not mangled, or the language for the name is unknown, or
2232 demangling is off, the name is printed in its "raw" form. */
2235 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2236 enum language lang
, int arg_mode
)
2242 /* If user wants to see raw output, no problem. */
2245 fputs_filtered (name
, stream
);
2249 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2250 fputs_filtered (demangled
? demangled
: name
, stream
);
2251 if (demangled
!= NULL
)
2259 /* True if CH is a character that can be part of a symbol name. I.e.,
2260 either a number, a letter, or a '_'. */
2263 valid_identifier_name_char (int ch
)
2265 return (isalnum (ch
) || ch
== '_');
2268 /* Skip to end of token, or to END, whatever comes first. Input is
2269 assumed to be a C++ operator name. */
2272 cp_skip_operator_token (const char *token
, const char *end
)
2274 const char *p
= token
;
2275 while (p
!= end
&& !isspace (*p
) && *p
!= '(')
2277 if (valid_identifier_name_char (*p
))
2279 while (p
!= end
&& valid_identifier_name_char (*p
))
2285 /* Note, ordered such that among ops that share a prefix,
2286 longer comes first. This is so that the loop below can
2287 bail on first match. */
2288 static const char *ops
[] =
2294 "-=", "--", "->", "-",
2303 "<<=", "<=", "<<", "<",
2304 ">>=", ">=", ">>", ">",
2308 for (const char *op
: ops
)
2310 size_t oplen
= strlen (op
);
2311 size_t lencmp
= std::min
<size_t> (oplen
, end
- p
);
2313 if (strncmp (p
, op
, lencmp
) == 0)
2316 /* Some unidentified character. Return it. */
2324 /* Advance STRING1/STRING2 past whitespace. */
2327 skip_ws (const char *&string1
, const char *&string2
, const char *end_str2
)
2329 while (isspace (*string1
))
2331 while (string2
< end_str2
&& isspace (*string2
))
2335 /* True if STRING points at the start of a C++ operator name. START
2336 is the start of the string that STRING points to, hence when
2337 reading backwards, we must not read any character before START. */
2340 cp_is_operator (const char *string
, const char *start
)
2342 return ((string
== start
2343 || !valid_identifier_name_char (string
[-1]))
2344 && strncmp (string
, CP_OPERATOR_STR
, CP_OPERATOR_LEN
) == 0
2345 && !valid_identifier_name_char (string
[CP_OPERATOR_LEN
]));
2348 /* If *NAME points at an ABI tag, skip it and return true. Otherwise
2349 leave *NAME unmodified and return false. (see GCC's abi_tag
2350 attribute), such names are demangled as e.g.,
2351 "function[abi:cxx11]()". */
2354 skip_abi_tag (const char **name
)
2356 const char *p
= *name
;
2358 if (startswith (p
, "[abi:"))
2362 while (valid_identifier_name_char (*p
))
2378 strncmp_iw_with_mode (const char *string1
, const char *string2
,
2379 size_t string2_len
, strncmp_iw_mode mode
,
2380 enum language language
,
2381 completion_match_for_lcd
*match_for_lcd
)
2383 const char *string1_start
= string1
;
2384 const char *end_str2
= string2
+ string2_len
;
2385 bool skip_spaces
= true;
2386 bool have_colon_op
= (language
== language_cplus
2387 || language
== language_rust
2388 || language
== language_fortran
);
2393 || ((isspace (*string1
) && !valid_identifier_name_char (*string2
))
2394 || (isspace (*string2
) && !valid_identifier_name_char (*string1
))))
2396 skip_ws (string1
, string2
, end_str2
);
2397 skip_spaces
= false;
2400 /* Skip [abi:cxx11] tags in the symbol name if the lookup name
2401 doesn't include them. E.g.:
2403 string1: function[abi:cxx1](int)
2406 string1: function[abi:cxx1](int)
2407 string2: function(int)
2409 string1: Struct[abi:cxx1]::function()
2410 string2: Struct::function()
2412 string1: function(Struct[abi:cxx1], int)
2413 string2: function(Struct, int)
2415 if (string2
== end_str2
2416 || (*string2
!= '[' && !valid_identifier_name_char (*string2
)))
2418 const char *abi_start
= string1
;
2420 /* There can be more than one tag. */
2421 while (*string1
== '[' && skip_abi_tag (&string1
))
2424 if (match_for_lcd
!= NULL
&& abi_start
!= string1
)
2425 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2427 while (isspace (*string1
))
2431 if (*string1
== '\0' || string2
== end_str2
)
2434 /* Handle the :: operator. */
2435 if (have_colon_op
&& string1
[0] == ':' && string1
[1] == ':')
2437 if (*string2
!= ':')
2443 if (string2
== end_str2
)
2446 if (*string2
!= ':')
2452 while (isspace (*string1
))
2454 while (string2
< end_str2
&& isspace (*string2
))
2459 /* Handle C++ user-defined operators. */
2460 else if (language
== language_cplus
2463 if (cp_is_operator (string1
, string1_start
))
2465 /* An operator name in STRING1. Check STRING2. */
2467 = std::min
<size_t> (CP_OPERATOR_LEN
, end_str2
- string2
);
2468 if (strncmp (string1
, string2
, cmplen
) != 0)
2474 if (string2
!= end_str2
)
2476 /* Check for "operatorX" in STRING2. */
2477 if (valid_identifier_name_char (*string2
))
2480 skip_ws (string1
, string2
, end_str2
);
2483 /* Handle operator(). */
2484 if (*string1
== '(')
2486 if (string2
== end_str2
)
2488 if (mode
== strncmp_iw_mode::NORMAL
)
2492 /* Don't break for the regular return at the
2493 bottom, because "operator" should not
2494 match "operator()", since this open
2495 parentheses is not the parameter list
2497 return *string1
!= '\0';
2501 if (*string1
!= *string2
)
2510 skip_ws (string1
, string2
, end_str2
);
2512 /* Skip to end of token, or to END, whatever comes
2514 const char *end_str1
= string1
+ strlen (string1
);
2515 const char *p1
= cp_skip_operator_token (string1
, end_str1
);
2516 const char *p2
= cp_skip_operator_token (string2
, end_str2
);
2518 cmplen
= std::min (p1
- string1
, p2
- string2
);
2521 if (strncmp (string1
, string2
, cmplen
) != 0)
2526 if (p1
- string1
!= p2
- string2
)
2528 if (strncmp (string1
, string2
, cmplen
) != 0)
2535 if (*string1
== '\0' || string2
== end_str2
)
2537 if (*string1
== '(' || *string2
== '(')
2545 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2547 if (case_sensitivity
== case_sensitive_off
2548 && (tolower ((unsigned char) *string1
)
2549 != tolower ((unsigned char) *string2
)))
2552 /* If we see any non-whitespace, non-identifier-name character
2553 (any of "()<>*&" etc.), then skip spaces the next time
2555 if (!isspace (*string1
) && !valid_identifier_name_char (*string1
))
2562 if (string2
== end_str2
)
2564 if (mode
== strncmp_iw_mode::NORMAL
)
2566 /* Strip abi tag markers from the matched symbol name.
2567 Usually the ABI marker will be found on function name
2568 (automatically added because the function returns an
2569 object marked with an ABI tag). However, it's also
2570 possible to see a marker in one of the function
2571 parameters, for example.
2573 string2 (lookup name):
2576 function(some_struct[abi:cxx11], int)
2578 and for completion LCD computation we want to say that
2580 function(some_struct, int)
2582 if (match_for_lcd
!= NULL
)
2584 while ((string1
= strstr (string1
, "[abi:")) != NULL
)
2586 const char *abi_start
= string1
;
2588 /* There can be more than one tag. */
2589 while (skip_abi_tag (&string1
) && *string1
== '[')
2592 if (abi_start
!= string1
)
2593 match_for_lcd
->mark_ignored_range (abi_start
, string1
);
2600 return (*string1
!= '\0' && *string1
!= '(');
2609 strncmp_iw (const char *string1
, const char *string2
, size_t string2_len
)
2611 return strncmp_iw_with_mode (string1
, string2
, string2_len
,
2612 strncmp_iw_mode::NORMAL
, language_minimal
);
2618 strcmp_iw (const char *string1
, const char *string2
)
2620 return strncmp_iw_with_mode (string1
, string2
, strlen (string2
),
2621 strncmp_iw_mode::MATCH_PARAMS
, language_minimal
);
2624 /* This is like strcmp except that it ignores whitespace and treats
2625 '(' as the first non-NULL character in terms of ordering. Like
2626 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2627 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2628 according to that ordering.
2630 If a list is sorted according to this function and if you want to
2631 find names in the list that match some fixed NAME according to
2632 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2633 where this function would put NAME.
2635 This function must be neutral to the CASE_SENSITIVITY setting as the user
2636 may choose it during later lookup. Therefore this function always sorts
2637 primarily case-insensitively and secondarily case-sensitively.
2639 Here are some examples of why using strcmp to sort is a bad idea:
2643 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2644 we try to do a search for "foo<char*>", strcmp will locate this
2645 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2646 will start looking at strings beginning with "goo", and will never
2647 see the correct match of "foo<char *>".
2649 Parenthesis example:
2651 In practice, this is less like to be an issue, but I'll give it a
2652 shot. Let's assume that '$' is a legitimate character to occur in
2653 symbols. (Which may well even be the case on some systems.) Then
2654 say that the partial symbol table contains "foo$" and "foo(int)".
2655 strcmp will put them in this order, since '$' < '('. Now, if the
2656 user searches for "foo", then strcmp will sort "foo" before "foo$".
2657 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2658 "foo") is false, so it won't proceed to the actual match of
2659 "foo(int)" with "foo". */
2662 strcmp_iw_ordered (const char *string1
, const char *string2
)
2664 const char *saved_string1
= string1
, *saved_string2
= string2
;
2665 enum case_sensitivity case_pass
= case_sensitive_off
;
2669 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2670 Provide stub characters if we are already at the end of one of the
2672 char c1
= 'X', c2
= 'X';
2674 while (*string1
!= '\0' && *string2
!= '\0')
2676 while (isspace (*string1
))
2678 while (isspace (*string2
))
2683 case case_sensitive_off
:
2684 c1
= tolower ((unsigned char) *string1
);
2685 c2
= tolower ((unsigned char) *string2
);
2687 case case_sensitive_on
:
2695 if (*string1
!= '\0')
2704 /* Characters are non-equal unless they're both '\0'; we want to
2705 make sure we get the comparison right according to our
2706 comparison in the cases where one of them is '\0' or '('. */
2708 if (*string2
== '\0')
2713 if (*string2
== '\0')
2718 if (*string2
== '\0' || *string2
== '(')
2727 if (case_pass
== case_sensitive_on
)
2730 /* Otherwise the strings were equal in case insensitive way, make
2731 a more fine grained comparison in a case sensitive way. */
2733 case_pass
= case_sensitive_on
;
2734 string1
= saved_string1
;
2735 string2
= saved_string2
;
2742 streq (const char *lhs
, const char *rhs
)
2744 return !strcmp (lhs
, rhs
);
2750 streq_hash (const void *lhs
, const void *rhs
)
2752 return streq ((const char *) lhs
, (const char *) rhs
);
2759 ** Answer whether string_to_compare is a full or partial match to
2760 ** template_string. The partial match must be in sequence starting
2764 subset_compare (const char *string_to_compare
, const char *template_string
)
2768 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
2769 && strlen (string_to_compare
) <= strlen (template_string
))
2771 (startswith (template_string
, string_to_compare
));
2778 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2779 struct cmd_list_element
*c
, const char *value
)
2781 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2787 initialize_utils (void)
2789 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
2790 Set number of characters where GDB should wrap lines of its output."), _("\
2791 Show number of characters where GDB should wrap lines of its output."), _("\
2792 This affects where GDB wraps its output to fit the screen width.\n\
2793 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2795 show_chars_per_line
,
2796 &setlist
, &showlist
);
2798 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
2799 Set number of lines in a page for GDB output pagination."), _("\
2800 Show number of lines in a page for GDB output pagination."), _("\
2801 This affects the number of lines after which GDB will pause\n\
2802 its output and ask you whether to continue.\n\
2803 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2805 show_lines_per_page
,
2806 &setlist
, &showlist
);
2808 add_setshow_boolean_cmd ("pagination", class_support
,
2809 &pagination_enabled
, _("\
2810 Set state of GDB output pagination."), _("\
2811 Show state of GDB output pagination."), _("\
2812 When pagination is ON, GDB pauses at end of each screenful of\n\
2813 its output and asks you whether to continue.\n\
2814 Turning pagination off is an alternative to \"set height unlimited\"."),
2816 show_pagination_enabled
,
2817 &setlist
, &showlist
);
2819 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
2820 &sevenbit_strings
, _("\
2821 Set printing of 8-bit characters in strings as \\nnn."), _("\
2822 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
2824 show_sevenbit_strings
,
2825 &setprintlist
, &showprintlist
);
2827 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
2828 &debug_timestamp
, _("\
2829 Set timestamping of debugging messages."), _("\
2830 Show timestamping of debugging messages."), _("\
2831 When set, debugging messages will be marked with seconds and microseconds."),
2833 show_debug_timestamp
,
2834 &setdebuglist
, &showdebuglist
);
2840 address_significant (gdbarch
*gdbarch
, CORE_ADDR addr
)
2842 /* Clear insignificant bits of a target address and sign extend resulting
2843 address, avoiding shifts larger or equal than the width of a CORE_ADDR.
2844 The local variable ADDR_BIT stops the compiler reporting a shift overflow
2845 when it won't occur. Skip updating of target address if current target
2846 has not set gdbarch significant_addr_bit. */
2847 int addr_bit
= gdbarch_significant_addr_bit (gdbarch
);
2849 if (addr_bit
&& (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
)))
2851 CORE_ADDR sign
= (CORE_ADDR
) 1 << (addr_bit
- 1);
2852 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2853 addr
= (addr
^ sign
) - sign
;
2860 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2862 /* Truncate address to the size of a target address, avoiding shifts
2863 larger or equal than the width of a CORE_ADDR. The local
2864 variable ADDR_BIT stops the compiler reporting a shift overflow
2865 when it won't occur. */
2866 /* NOTE: This assumes that the significant address information is
2867 kept in the least significant bits of ADDR - the upper bits were
2868 either zero or sign extended. Should gdbarch_address_to_pointer or
2869 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2871 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2873 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2874 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2875 return hex_string (addr
);
2878 /* This function is described in "defs.h". */
2881 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2883 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2885 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2886 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2888 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2889 that returns the language localized string formatted to a width
2890 based on gdbarch_addr_bit. */
2892 return hex_string_custom (address
, 8);
2894 return hex_string_custom (address
, 16);
2897 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2900 core_addr_hash (const void *ap
)
2902 const CORE_ADDR
*addrp
= (const CORE_ADDR
*) ap
;
2907 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2910 core_addr_eq (const void *ap
, const void *bp
)
2912 const CORE_ADDR
*addr_ap
= (const CORE_ADDR
*) ap
;
2913 const CORE_ADDR
*addr_bp
= (const CORE_ADDR
*) bp
;
2915 return *addr_ap
== *addr_bp
;
2918 /* Convert a string back into a CORE_ADDR. */
2920 string_to_core_addr (const char *my_string
)
2924 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2926 /* Assume that it is in hex. */
2929 for (i
= 2; my_string
[i
] != '\0'; i
++)
2931 if (isdigit (my_string
[i
]))
2932 addr
= (my_string
[i
] - '0') + (addr
* 16);
2933 else if (isxdigit (my_string
[i
]))
2934 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2936 error (_("invalid hex \"%s\""), my_string
);
2941 /* Assume that it is in decimal. */
2944 for (i
= 0; my_string
[i
] != '\0'; i
++)
2946 if (isdigit (my_string
[i
]))
2947 addr
= (my_string
[i
] - '0') + (addr
* 10);
2949 error (_("invalid decimal \"%s\""), my_string
);
2959 gdb_realpath_check_trailer (const char *input
, const char *trailer
)
2961 gdb::unique_xmalloc_ptr
<char> result
= gdb_realpath (input
);
2963 size_t len
= strlen (result
.get ());
2964 size_t trail_len
= strlen (trailer
);
2966 SELF_CHECK (len
>= trail_len
2967 && strcmp (result
.get () + len
- trail_len
, trailer
) == 0);
2971 gdb_realpath_tests ()
2973 /* A file which contains a directory prefix. */
2974 gdb_realpath_check_trailer ("./xfullpath.exp", "/xfullpath.exp");
2975 /* A file which contains a directory prefix. */
2976 gdb_realpath_check_trailer ("../../defs.h", "/defs.h");
2977 /* A one-character filename. */
2978 gdb_realpath_check_trailer ("./a", "/a");
2979 /* A file in the root directory. */
2980 gdb_realpath_check_trailer ("/root_file_which_should_exist",
2981 "/root_file_which_should_exist");
2982 /* A file which does not have a directory prefix. */
2983 gdb_realpath_check_trailer ("xfullpath.exp", "xfullpath.exp");
2984 /* A one-char filename without any directory prefix. */
2985 gdb_realpath_check_trailer ("a", "a");
2986 /* An empty filename. */
2987 gdb_realpath_check_trailer ("", "");
2990 #endif /* GDB_SELF_TEST */
2992 /* Allocation function for the libiberty hash table which uses an
2993 obstack. The obstack is passed as DATA. */
2996 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
2998 size_t total
= size
* count
;
2999 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
3001 memset (ptr
, 0, total
);
3005 /* Trivial deallocation function for the libiberty splay tree and hash
3006 table - don't deallocate anything. Rely on later deletion of the
3007 obstack. DATA will be the obstack, although it is not needed
3011 dummy_obstack_deallocate (void *object
, void *data
)
3016 /* Simple, portable version of dirname that does not modify its
3020 ldirname (const char *filename
)
3022 std::string dirname
;
3023 const char *base
= lbasename (filename
);
3025 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
3028 if (base
== filename
)
3031 dirname
= std::string (filename
, base
- filename
);
3033 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3034 create "d:./bar" later instead of the (different) "d:/bar". */
3035 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3036 && !IS_DIR_SEPARATOR (filename
[0]))
3037 dirname
[base
++ - filename
] = '.';
3045 gdb_argv::reset (const char *s
)
3047 char **argv
= buildargv (s
);
3049 if (s
!= NULL
&& argv
== NULL
)
3057 compare_positive_ints (const void *ap
, const void *bp
)
3059 /* Because we know we're comparing two ints which are positive,
3060 there's no danger of overflow here. */
3061 return * (int *) ap
- * (int *) bp
;
3064 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3065 #define AMBIGUOUS_MESS2 \
3066 ".\nUse \"set gnutarget format-name\" to specify the format."
3069 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3073 /* Check if errmsg just need simple return. */
3074 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3075 return bfd_errmsg (error_tag
);
3077 std::string
ret (bfd_errmsg (error_tag
));
3078 ret
+= AMBIGUOUS_MESS1
;
3080 for (p
= matching
; *p
; p
++)
3085 ret
+= AMBIGUOUS_MESS2
;
3092 /* Return ARGS parsed as a valid pid, or throw an error. */
3095 parse_pid_to_attach (const char *args
)
3101 error_no_arg (_("process-id to attach"));
3103 dummy
= (char *) args
;
3104 pid
= strtoul (args
, &dummy
, 0);
3105 /* Some targets don't set errno on errors, grrr! */
3106 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3107 error (_("Illegal process-id: %s."), args
);
3112 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3113 must come from xrealloc-compatible allocator and it may be updated. FROM
3114 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3115 located at the start or end of *STRINGP. */
3118 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3120 char *string
= *stringp
, *s
;
3121 const size_t from_len
= strlen (from
);
3122 const size_t to_len
= strlen (to
);
3126 s
= strstr (s
, from
);
3130 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3131 || s
[-1] == DIRNAME_SEPARATOR
)
3132 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3133 || s
[from_len
] == DIRNAME_SEPARATOR
))
3138 = (char *) xrealloc (string
, (strlen (string
) + to_len
+ 1));
3140 /* Relocate the current S pointer. */
3141 s
= s
- string
+ string_new
;
3142 string
= string_new
;
3144 /* Replace from by to. */
3145 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3146 memcpy (s
, to
, to_len
);
3161 /* SIGALRM handler for waitpid_with_timeout. */
3164 sigalrm_handler (int signo
)
3166 /* Nothing to do. */
3171 /* Wrapper to wait for child PID to die with TIMEOUT.
3172 TIMEOUT is the time to stop waiting in seconds.
3173 If TIMEOUT is zero, pass WNOHANG to waitpid.
3174 Returns PID if it was successfully waited for, otherwise -1.
3176 Timeouts are currently implemented with alarm and SIGALRM.
3177 If the host does not support them, this waits "forever".
3178 It would be odd though for a host to have waitpid and not SIGALRM. */
3181 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3183 pid_t waitpid_result
;
3185 gdb_assert (pid
> 0);
3186 gdb_assert (timeout
>= 0);
3191 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3192 struct sigaction sa
, old_sa
;
3194 sa
.sa_handler
= sigalrm_handler
;
3195 sigemptyset (&sa
.sa_mask
);
3197 sigaction (SIGALRM
, &sa
, &old_sa
);
3201 ofunc
= signal (SIGALRM
, sigalrm_handler
);
3207 waitpid_result
= waitpid (pid
, status
, 0);
3211 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3212 sigaction (SIGALRM
, &old_sa
, NULL
);
3214 signal (SIGALRM
, ofunc
);
3219 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3221 if (waitpid_result
== pid
)
3227 #endif /* HAVE_WAITPID */
3229 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3230 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3232 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3233 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3236 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3238 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3240 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3241 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3243 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3245 char *pattern_slash
, *string_slash
;
3247 /* Replace '\' by '/' in both strings. */
3249 pattern_slash
= (char *) alloca (strlen (pattern
) + 1);
3250 strcpy (pattern_slash
, pattern
);
3251 pattern
= pattern_slash
;
3252 for (; *pattern_slash
!= 0; pattern_slash
++)
3253 if (IS_DIR_SEPARATOR (*pattern_slash
))
3254 *pattern_slash
= '/';
3256 string_slash
= (char *) alloca (strlen (string
) + 1);
3257 strcpy (string_slash
, string
);
3258 string
= string_slash
;
3259 for (; *string_slash
!= 0; string_slash
++)
3260 if (IS_DIR_SEPARATOR (*string_slash
))
3261 *string_slash
= '/';
3263 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3265 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3266 flags
|= FNM_CASEFOLD
;
3267 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3269 return fnmatch (pattern
, string
, flags
);
3272 /* Return the number of path elements in PATH.
3280 count_path_elements (const char *path
)
3283 const char *p
= path
;
3285 if (HAS_DRIVE_SPEC (p
))
3287 p
= STRIP_DRIVE_SPEC (p
);
3293 if (IS_DIR_SEPARATOR (*p
))
3298 /* Backup one if last character is /, unless it's the only one. */
3299 if (p
> path
+ 1 && IS_DIR_SEPARATOR (p
[-1]))
3302 /* Add one for the file name, if present. */
3303 if (p
> path
&& !IS_DIR_SEPARATOR (p
[-1]))
3309 /* Remove N leading path elements from PATH.
3310 N must be non-negative.
3311 If PATH has more than N path elements then return NULL.
3312 If PATH has exactly N path elements then return "".
3313 See count_path_elements for a description of how we do the counting. */
3316 strip_leading_path_elements (const char *path
, int n
)
3319 const char *p
= path
;
3321 gdb_assert (n
>= 0);
3326 if (HAS_DRIVE_SPEC (p
))
3328 p
= STRIP_DRIVE_SPEC (p
);
3334 while (*p
!= '\0' && !IS_DIR_SEPARATOR (*p
))
3352 copy_bitwise (gdb_byte
*dest
, ULONGEST dest_offset
,
3353 const gdb_byte
*source
, ULONGEST source_offset
,
3354 ULONGEST nbits
, int bits_big_endian
)
3356 unsigned int buf
, avail
;
3361 if (bits_big_endian
)
3363 /* Start from the end, then work backwards. */
3364 dest_offset
+= nbits
- 1;
3365 dest
+= dest_offset
/ 8;
3366 dest_offset
= 7 - dest_offset
% 8;
3367 source_offset
+= nbits
- 1;
3368 source
+= source_offset
/ 8;
3369 source_offset
= 7 - source_offset
% 8;
3373 dest
+= dest_offset
/ 8;
3375 source
+= source_offset
/ 8;
3379 /* Fill BUF with DEST_OFFSET bits from the destination and 8 -
3380 SOURCE_OFFSET bits from the source. */
3381 buf
= *(bits_big_endian
? source
-- : source
++) >> source_offset
;
3382 buf
<<= dest_offset
;
3383 buf
|= *dest
& ((1 << dest_offset
) - 1);
3385 /* NBITS: bits yet to be written; AVAIL: BUF's fill level. */
3386 nbits
+= dest_offset
;
3387 avail
= dest_offset
+ 8 - source_offset
;
3389 /* Flush 8 bits from BUF, if appropriate. */
3390 if (nbits
>= 8 && avail
>= 8)
3392 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3398 /* Copy the middle part. */
3401 size_t len
= nbits
/ 8;
3403 /* Use a faster method for byte-aligned copies. */
3406 if (bits_big_endian
)
3410 memcpy (dest
+ 1, source
+ 1, len
);
3414 memcpy (dest
, source
, len
);
3423 buf
|= *(bits_big_endian
? source
-- : source
++) << avail
;
3424 *(bits_big_endian
? dest
-- : dest
++) = buf
;
3431 /* Write the last byte. */
3435 buf
|= *source
<< avail
;
3437 buf
&= (1 << nbits
) - 1;
3438 *dest
= (*dest
& (~0 << nbits
)) | buf
;
3443 _initialize_utils (void)
3445 add_internal_problem_command (&internal_error_problem
);
3446 add_internal_problem_command (&internal_warning_problem
);
3447 add_internal_problem_command (&demangler_warning_problem
);
3450 selftests::register_test ("gdb_realpath", gdb_realpath_tests
);