1 /* General utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2017 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/>. */
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 "job-control.h"
69 #include "common/selftest.h"
70 #include "common/gdb_optional.h"
73 extern PTR
malloc (); /* ARI: PTR */
75 #if !HAVE_DECL_REALLOC
76 extern PTR
realloc (); /* ARI: PTR */
82 void (*deprecated_error_begin_hook
) (void);
84 /* Prototypes for local functions */
86 static void vfprintf_maybe_filtered (struct ui_file
*, const char *,
87 va_list, int) ATTRIBUTE_PRINTF (2, 0);
89 static void fputs_maybe_filtered (const char *, struct ui_file
*, int);
91 static void prompt_for_continue (void);
93 static void set_screen_size (void);
94 static void set_width (void);
96 /* Time spent in prompt_for_continue in the currently executing command
97 waiting for user to respond.
98 Initialized in make_command_stats_cleanup.
99 Modified in prompt_for_continue and defaulted_query.
100 Used in report_command_stats. */
102 static std::chrono::steady_clock::duration prompt_for_continue_wait_time
;
104 /* A flag indicating whether to timestamp debugging messages. */
106 static int debug_timestamp
= 0;
108 /* Nonzero means that strings with character values >0x7F should be printed
109 as octal escapes. Zero means just print the value (e.g. it's an
110 international character, and the terminal or window can cope.) */
112 int sevenbit_strings
= 0;
114 show_sevenbit_strings (struct ui_file
*file
, int from_tty
,
115 struct cmd_list_element
*c
, const char *value
)
117 fprintf_filtered (file
, _("Printing of 8-bit characters "
118 "in strings as \\nnn is %s.\n"),
122 /* String to be printed before warning messages, if any. */
124 const char *warning_pre_print
= "\nwarning: ";
126 int pagination_enabled
= 1;
128 show_pagination_enabled (struct ui_file
*file
, int from_tty
,
129 struct cmd_list_element
*c
, const char *value
)
131 fprintf_filtered (file
, _("State of pagination is %s.\n"), value
);
135 /* Cleanup utilities.
137 These are not defined in cleanups.c (nor declared in cleanups.h)
138 because while they use the "cleanup API" they are not part of the
142 do_free_section_addr_info (void *arg
)
144 free_section_addr_info ((struct section_addr_info
*) arg
);
148 make_cleanup_free_section_addr_info (struct section_addr_info
*addrs
)
150 return make_cleanup (do_free_section_addr_info
, addrs
);
153 struct restore_integer_closure
160 restore_integer (void *p
)
162 struct restore_integer_closure
*closure
163 = (struct restore_integer_closure
*) p
;
165 *(closure
->variable
) = closure
->value
;
168 /* Remember the current value of *VARIABLE and make it restored when
169 the cleanup is run. */
172 make_cleanup_restore_integer (int *variable
)
174 struct restore_integer_closure
*c
= XNEW (struct restore_integer_closure
);
176 c
->variable
= variable
;
177 c
->value
= *variable
;
179 return make_cleanup_dtor (restore_integer
, (void *) c
, xfree
);
182 /* Remember the current value of *VARIABLE and make it restored when
183 the cleanup is run. */
186 make_cleanup_restore_uinteger (unsigned int *variable
)
188 return make_cleanup_restore_integer ((int *) variable
);
191 /* Helper for make_cleanup_unpush_target. */
194 do_unpush_target (void *arg
)
196 struct target_ops
*ops
= (struct target_ops
*) arg
;
201 /* Return a new cleanup that unpushes OPS. */
204 make_cleanup_unpush_target (struct target_ops
*ops
)
206 return make_cleanup (do_unpush_target
, ops
);
209 /* Helper for make_cleanup_value_free_to_mark. */
212 do_value_free_to_mark (void *value
)
214 value_free_to_mark ((struct value
*) value
);
217 /* Free all values allocated since MARK was obtained by value_mark
218 (except for those released) when the cleanup is run. */
221 make_cleanup_value_free_to_mark (struct value
*mark
)
223 return make_cleanup (do_value_free_to_mark
, mark
);
226 /* Helper for make_cleanup_value_free. */
229 do_value_free (void *value
)
231 value_free ((struct value
*) value
);
237 make_cleanup_value_free (struct value
*value
)
239 return make_cleanup (do_value_free
, value
);
242 /* This function is useful for cleanups.
246 old_chain = make_cleanup (free_current_contents, &foo);
248 to arrange to free the object thus allocated. */
251 free_current_contents (void *ptr
)
253 void **location
= (void **) ptr
;
255 if (location
== NULL
)
256 internal_error (__FILE__
, __LINE__
,
257 _("free_current_contents: NULL pointer"));
258 if (*location
!= NULL
)
267 /* Print a warning message. The first argument STRING is the warning
268 message, used as an fprintf format string, the second is the
269 va_list of arguments for that string. A warning is unfiltered (not
270 paginated) so that the user does not need to page through each
271 screen full of warnings when there are lots of them. */
274 vwarning (const char *string
, va_list args
)
276 if (deprecated_warning_hook
)
277 (*deprecated_warning_hook
) (string
, args
);
280 gdb::optional
<target_terminal::scoped_restore_terminal_state
> term_state
;
281 if (target_supports_terminal_ours ())
283 term_state
.emplace ();
284 target_terminal::ours_for_output ();
286 if (filtered_printing_initialized ())
287 wrap_here (""); /* Force out any buffered output. */
288 gdb_flush (gdb_stdout
);
289 if (warning_pre_print
)
290 fputs_unfiltered (warning_pre_print
, gdb_stderr
);
291 vfprintf_unfiltered (gdb_stderr
, string
, args
);
292 fprintf_unfiltered (gdb_stderr
, "\n");
296 /* Print an error message and return to command level.
297 The first argument STRING is the error message, used as a fprintf string,
298 and the remaining args are passed as arguments to it. */
301 verror (const char *string
, va_list args
)
303 throw_verror (GENERIC_ERROR
, string
, args
);
307 error_stream (const string_file
&stream
)
309 error (("%s"), stream
.c_str ());
312 /* Emit a message and abort. */
314 static void ATTRIBUTE_NORETURN
315 abort_with_message (const char *msg
)
317 if (current_ui
== NULL
)
320 fputs_unfiltered (msg
, gdb_stderr
);
322 abort (); /* NOTE: GDB has only three calls to abort(). */
325 /* Dump core trying to increase the core soft limit to hard limit first. */
330 #ifdef HAVE_SETRLIMIT
331 struct rlimit rlim
= { RLIM_INFINITY
, RLIM_INFINITY
};
333 setrlimit (RLIMIT_CORE
, &rlim
);
334 #endif /* HAVE_SETRLIMIT */
336 abort (); /* NOTE: GDB has only three calls to abort(). */
339 /* Check whether GDB will be able to dump core using the dump_core
340 function. Returns zero if GDB cannot or should not dump core.
341 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
342 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
345 can_dump_core (enum resource_limit_kind limit_kind
)
347 #ifdef HAVE_GETRLIMIT
350 /* Be quiet and assume we can dump if an error is returned. */
351 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
357 if (rlim
.rlim_cur
== 0)
361 if (rlim
.rlim_max
== 0)
364 #endif /* HAVE_GETRLIMIT */
369 /* Print a warning that we cannot dump core. */
372 warn_cant_dump_core (const char *reason
)
374 fprintf_unfiltered (gdb_stderr
,
375 _("%s\nUnable to dump core, use `ulimit -c"
376 " unlimited' before executing GDB next time.\n"),
380 /* Check whether GDB will be able to dump core using the dump_core
381 function, and print a warning if we cannot. */
384 can_dump_core_warn (enum resource_limit_kind limit_kind
,
387 int core_dump_allowed
= can_dump_core (limit_kind
);
389 if (!core_dump_allowed
)
390 warn_cant_dump_core (reason
);
392 return core_dump_allowed
;
395 /* Allow the user to configure the debugger behavior with respect to
396 what to do when an internal problem is detected. */
398 const char internal_problem_ask
[] = "ask";
399 const char internal_problem_yes
[] = "yes";
400 const char internal_problem_no
[] = "no";
401 static const char *const internal_problem_modes
[] =
403 internal_problem_ask
,
404 internal_problem_yes
,
409 /* Print a message reporting an internal error/warning. Ask the user
410 if they want to continue, dump core, or just exit. Return
411 something to indicate a quit. */
413 struct internal_problem
416 int user_settable_should_quit
;
417 const char *should_quit
;
418 int user_settable_should_dump_core
;
419 const char *should_dump_core
;
422 /* Report a problem, internal to GDB, to the user. Once the problem
423 has been reported, and assuming GDB didn't quit, the caller can
424 either allow execution to resume or throw an error. */
426 static void ATTRIBUTE_PRINTF (4, 0)
427 internal_vproblem (struct internal_problem
*problem
,
428 const char *file
, int line
, const char *fmt
, va_list ap
)
434 struct cleanup
*cleanup
= make_cleanup (null_cleanup
, NULL
);
436 /* Don't allow infinite error/warning recursion. */
438 static char msg
[] = "Recursive internal problem.\n";
447 abort_with_message (msg
);
450 /* Newer GLIBC versions put the warn_unused_result attribute
451 on write, but this is one of those rare cases where
452 ignoring the return value is correct. Casting to (void)
453 does not fix this problem. This is the solution suggested
454 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
455 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
456 abort (); /* NOTE: GDB has only three calls to abort(). */
461 /* Create a string containing the full error/warning message. Need
462 to call query with this full string, as otherwize the reason
463 (error/warning) and question become separated. Format using a
464 style similar to a compiler error message. Include extra detail
465 so that the user knows that they are living on the edge. */
469 msg
= xstrvprintf (fmt
, ap
);
470 reason
= xstrprintf ("%s:%d: %s: %s\n"
471 "A problem internal to GDB has been detected,\n"
472 "further debugging may prove unreliable.",
473 file
, line
, problem
->name
, msg
);
475 make_cleanup (xfree
, reason
);
478 /* Fall back to abort_with_message if gdb_stderr is not set up. */
479 if (current_ui
== NULL
)
481 fputs (reason
, stderr
);
482 abort_with_message ("\n");
485 /* Try to get the message out and at the start of a new line. */
486 gdb::optional
<target_terminal::scoped_restore_terminal_state
> term_state
;
487 if (target_supports_terminal_ours ())
489 term_state
.emplace ();
490 target_terminal::ours_for_output ();
492 if (filtered_printing_initialized ())
495 /* Emit the message unless query will emit it below. */
496 if (problem
->should_quit
!= internal_problem_ask
498 || !filtered_printing_initialized ())
499 fprintf_unfiltered (gdb_stderr
, "%s\n", reason
);
501 if (problem
->should_quit
== internal_problem_ask
)
503 /* Default (yes/batch case) is to quit GDB. When in batch mode
504 this lessens the likelihood of GDB going into an infinite
506 if (!confirm
|| !filtered_printing_initialized ())
509 quit_p
= query (_("%s\nQuit this debugging session? "), reason
);
511 else if (problem
->should_quit
== internal_problem_yes
)
513 else if (problem
->should_quit
== internal_problem_no
)
516 internal_error (__FILE__
, __LINE__
, _("bad switch"));
518 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr
);
519 if (REPORT_BUGS_TO
[0])
520 fprintf_unfiltered (gdb_stderr
, _(" For instructions, see:\n%s."),
522 fputs_unfiltered ("\n\n", gdb_stderr
);
524 if (problem
->should_dump_core
== internal_problem_ask
)
526 if (!can_dump_core_warn (LIMIT_MAX
, reason
))
528 else if (!filtered_printing_initialized ())
532 /* Default (yes/batch case) is to dump core. This leaves a GDB
533 `dropping' so that it is easier to see that something went
535 dump_core_p
= query (_("%s\nCreate a core file of GDB? "), reason
);
538 else if (problem
->should_dump_core
== internal_problem_yes
)
539 dump_core_p
= can_dump_core_warn (LIMIT_MAX
, reason
);
540 else if (problem
->should_dump_core
== internal_problem_no
)
543 internal_error (__FILE__
, __LINE__
, _("bad switch"));
556 #ifdef HAVE_WORKING_FORK
564 do_cleanups (cleanup
);
567 static struct internal_problem internal_error_problem
= {
568 "internal-error", 1, internal_problem_ask
, 1, internal_problem_ask
572 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
574 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
575 throw_quit (_("Command aborted."));
578 static struct internal_problem internal_warning_problem
= {
579 "internal-warning", 1, internal_problem_ask
, 1, internal_problem_ask
583 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
585 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
588 static struct internal_problem demangler_warning_problem
= {
589 "demangler-warning", 1, internal_problem_ask
, 0, internal_problem_no
593 demangler_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
595 internal_vproblem (&demangler_warning_problem
, file
, line
, fmt
, ap
);
599 demangler_warning (const char *file
, int line
, const char *string
, ...)
603 va_start (ap
, string
);
604 demangler_vwarning (file
, line
, string
, ap
);
608 /* Dummy functions to keep add_prefix_cmd happy. */
611 set_internal_problem_cmd (char *args
, int from_tty
)
616 show_internal_problem_cmd (char *args
, int from_tty
)
620 /* When GDB reports an internal problem (error or warning) it gives
621 the user the opportunity to quit GDB and/or create a core file of
622 the current debug session. This function registers a few commands
623 that make it possible to specify that GDB should always or never
624 quit or create a core file, without asking. The commands look
627 maint set PROBLEM-NAME quit ask|yes|no
628 maint show PROBLEM-NAME quit
629 maint set PROBLEM-NAME corefile ask|yes|no
630 maint show PROBLEM-NAME corefile
632 Where PROBLEM-NAME is currently "internal-error" or
633 "internal-warning". */
636 add_internal_problem_command (struct internal_problem
*problem
)
638 struct cmd_list_element
**set_cmd_list
;
639 struct cmd_list_element
**show_cmd_list
;
643 set_cmd_list
= XNEW (struct cmd_list_element
*);
644 show_cmd_list
= XNEW (struct cmd_list_element
*);
645 *set_cmd_list
= NULL
;
646 *show_cmd_list
= NULL
;
648 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
651 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
654 add_prefix_cmd ((char*) problem
->name
,
655 class_maintenance
, set_internal_problem_cmd
, set_doc
,
657 concat ("maintenance set ", problem
->name
, " ",
659 0/*allow-unknown*/, &maintenance_set_cmdlist
);
661 add_prefix_cmd ((char*) problem
->name
,
662 class_maintenance
, show_internal_problem_cmd
, show_doc
,
664 concat ("maintenance show ", problem
->name
, " ",
666 0/*allow-unknown*/, &maintenance_show_cmdlist
);
668 if (problem
->user_settable_should_quit
)
670 set_doc
= xstrprintf (_("Set whether GDB should quit "
671 "when an %s is detected"),
673 show_doc
= xstrprintf (_("Show whether GDB will quit "
674 "when an %s is detected"),
676 add_setshow_enum_cmd ("quit", class_maintenance
,
677 internal_problem_modes
,
678 &problem
->should_quit
,
691 if (problem
->user_settable_should_dump_core
)
693 set_doc
= xstrprintf (_("Set whether GDB should create a core "
694 "file of GDB when %s is detected"),
696 show_doc
= xstrprintf (_("Show whether GDB will create a core "
697 "file of GDB when %s is detected"),
699 add_setshow_enum_cmd ("corefile", class_maintenance
,
700 internal_problem_modes
,
701 &problem
->should_dump_core
,
715 /* Return a newly allocated string, containing the PREFIX followed
716 by the system error message for errno (separated by a colon). */
719 perror_string (const char *prefix
)
723 err
= safe_strerror (errno
);
724 return std::string (prefix
) + ": " + err
;
727 /* Print the system error message for errno, and also mention STRING
728 as the file name for which the error was encountered. Use ERRCODE
729 for the thrown exception. Then return to command level. */
732 throw_perror_with_name (enum errors errcode
, const char *string
)
734 std::string combined
= perror_string (string
);
736 /* I understand setting these is a matter of taste. Still, some people
737 may clear errno but not know about bfd_error. Doing this here is not
739 bfd_set_error (bfd_error_no_error
);
742 throw_error (errcode
, _("%s."), combined
.c_str ());
745 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
748 perror_with_name (const char *string
)
750 throw_perror_with_name (GENERIC_ERROR
, string
);
753 /* Same as perror_with_name except that it prints a warning instead
754 of throwing an error. */
757 perror_warning_with_name (const char *string
)
759 std::string combined
= perror_string (string
);
760 warning (_("%s"), combined
.c_str ());
763 /* Print the system error message for ERRCODE, and also mention STRING
764 as the file name for which the error was encountered. */
767 print_sys_errmsg (const char *string
, int errcode
)
772 err
= safe_strerror (errcode
);
773 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
774 strcpy (combined
, string
);
775 strcat (combined
, ": ");
776 strcat (combined
, err
);
778 /* We want anything which was printed on stdout to come out first, before
780 gdb_flush (gdb_stdout
);
781 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
784 /* Control C eventually causes this to be called, at a convenient time. */
789 struct ui
*ui
= current_ui
;
791 if (sync_quit_force_run
)
793 sync_quit_force_run
= 0;
794 quit_force (NULL
, 0);
798 /* No steenking SIGINT will ever be coming our way when the
799 program is resumed. Don't lie. */
803 /* If there is no terminal switching for this target, then we can't
804 possibly get screwed by the lack of job control. */
805 || !target_supports_terminal_ours ())
808 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
817 if (sync_quit_force_run
)
822 if (deprecated_interactive_hook
)
823 deprecated_interactive_hook ();
827 /* Called when a memory allocation fails, with the number of bytes of
828 memory requested in SIZE. */
831 malloc_failure (long size
)
835 internal_error (__FILE__
, __LINE__
,
836 _("virtual memory exhausted: can't allocate %ld bytes."),
841 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
845 /* My replacement for the read system call.
846 Used like `read' but keeps going if `read' returns too soon. */
849 myread (int desc
, char *addr
, int len
)
856 val
= read (desc
, addr
, len
);
868 print_spaces (int n
, struct ui_file
*file
)
870 fputs_unfiltered (n_spaces (n
), file
);
873 /* Print a host address. */
876 gdb_print_host_address_1 (const void *addr
, struct ui_file
*stream
)
878 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
884 make_hex_string (const gdb_byte
*data
, size_t length
)
886 char *result
= (char *) xmalloc (length
* 2 + 1);
891 for (i
= 0; i
< length
; ++i
)
892 p
+= xsnprintf (p
, 3, "%02x", data
[i
]);
899 /* An RAII class that sets up to handle input and then tears down
900 during destruction. */
902 class scoped_input_handler
906 scoped_input_handler ()
907 : m_quit_handler (&quit_handler
, default_quit_handler
),
910 target_terminal::ours ();
911 ui_register_input_event_handler (current_ui
);
912 if (current_ui
->prompt_state
== PROMPT_BLOCKED
)
916 ~scoped_input_handler ()
919 ui_unregister_input_event_handler (m_ui
);
922 DISABLE_COPY_AND_ASSIGN (scoped_input_handler
);
926 /* Save and restore the terminal state. */
927 target_terminal::scoped_restore_terminal_state m_term_state
;
929 /* Save and restore the quit handler. */
930 scoped_restore_tmpl
<quit_handler_ftype
*> m_quit_handler
;
932 /* The saved UI, if non-NULL. */
938 /* This function supports the query, nquery, and yquery functions.
939 Ask user a y-or-n question and return 0 if answer is no, 1 if
940 answer is yes, or default the answer to the specified default
941 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
942 default answer, or '\0' for no default.
943 CTLSTR is the control string and should end in "? ". It should
944 not say how to answer, because we do that.
945 ARGS are the arguments passed along with the CTLSTR argument to
948 static int ATTRIBUTE_PRINTF (1, 0)
949 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
954 char def_answer
, not_def_answer
;
955 const char *y_string
, *n_string
;
956 char *question
, *prompt
;
957 struct cleanup
*old_chain
;
959 /* Set up according to which answer is the default. */
964 not_def_answer
= 'N';
968 else if (defchar
== 'y')
972 not_def_answer
= 'N';
980 not_def_answer
= 'Y';
985 /* Automatically answer the default value if the user did not want
986 prompts or the command was issued with the server prefix. */
987 if (!confirm
|| server_command
)
990 /* If input isn't coming from the user directly, just say what
991 question we're asking, and then answer the default automatically. This
992 way, important error messages don't get lost when talking to GDB
994 if (current_ui
->instream
!= current_ui
->stdin_stream
995 || !input_interactive_p (current_ui
)
996 /* Restrict queries to the main UI. */
997 || current_ui
!= main_ui
)
999 target_terminal::scoped_restore_terminal_state term_state
;
1000 target_terminal::ours_for_output ();
1002 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
1004 printf_filtered (_("(%s or %s) [answered %c; "
1005 "input not from terminal]\n"),
1006 y_string
, n_string
, def_answer
);
1007 gdb_flush (gdb_stdout
);
1012 if (deprecated_query_hook
)
1014 target_terminal::scoped_restore_terminal_state term_state
;
1015 return deprecated_query_hook (ctlstr
, args
);
1018 /* Format the question outside of the loop, to avoid reusing args. */
1019 question
= xstrvprintf (ctlstr
, args
);
1020 old_chain
= make_cleanup (xfree
, question
);
1021 prompt
= xstrprintf (_("%s%s(%s or %s) %s"),
1022 annotation_level
> 1 ? "\n\032\032pre-query\n" : "",
1023 question
, y_string
, n_string
,
1024 annotation_level
> 1 ? "\n\032\032query\n" : "");
1025 make_cleanup (xfree
, prompt
);
1027 /* Used to add duration we waited for user to respond to
1028 prompt_for_continue_wait_time. */
1029 using namespace std::chrono
;
1030 steady_clock::time_point prompt_started
= steady_clock::now ();
1032 scoped_input_handler prepare_input
;
1036 char *response
, answer
;
1038 gdb_flush (gdb_stdout
);
1039 response
= gdb_readline_wrapper (prompt
);
1041 if (response
== NULL
) /* C-d */
1043 printf_filtered ("EOF [assumed %c]\n", def_answer
);
1048 answer
= response
[0];
1053 /* Check answer. For the non-default, the user must specify
1054 the non-default explicitly. */
1055 if (answer
== not_def_answer
)
1057 retval
= !def_value
;
1060 /* Otherwise, if a default was specified, the user may either
1061 specify the required input or have it default by entering
1063 if (answer
== def_answer
1064 || (defchar
!= '\0' && answer
== '\0'))
1069 /* Invalid entries are not defaulted and require another selection. */
1070 printf_filtered (_("Please answer %s or %s.\n"),
1071 y_string
, n_string
);
1074 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1075 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1077 if (annotation_level
> 1)
1078 printf_filtered (("\n\032\032post-query\n"));
1079 do_cleanups (old_chain
);
1084 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1085 answer is yes, or 0 if answer is defaulted.
1086 Takes three args which are given to printf to print the question.
1087 The first, a control string, should end in "? ".
1088 It should not say how to answer, because we do that. */
1091 nquery (const char *ctlstr
, ...)
1096 va_start (args
, ctlstr
);
1097 ret
= defaulted_query (ctlstr
, 'n', args
);
1102 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1103 answer is yes, or 1 if answer is defaulted.
1104 Takes three args which are given to printf to print the question.
1105 The first, a control string, should end in "? ".
1106 It should not say how to answer, because we do that. */
1109 yquery (const char *ctlstr
, ...)
1114 va_start (args
, ctlstr
);
1115 ret
= defaulted_query (ctlstr
, 'y', args
);
1120 /* Ask user a y-or-n question and return 1 iff answer is yes.
1121 Takes three args which are given to printf to print the question.
1122 The first, a control string, should end in "? ".
1123 It should not say how to answer, because we do that. */
1126 query (const char *ctlstr
, ...)
1131 va_start (args
, ctlstr
);
1132 ret
= defaulted_query (ctlstr
, '\0', args
);
1137 /* A helper for parse_escape that converts a host character to a
1138 target character. C is the host character. If conversion is
1139 possible, then the target character is stored in *TARGET_C and the
1140 function returns 1. Otherwise, the function returns 0. */
1143 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1148 auto_obstack host_data
;
1150 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1151 (gdb_byte
*) &the_char
, 1, 1,
1152 &host_data
, translit_none
);
1154 if (obstack_object_size (&host_data
) == 1)
1157 *target_c
= *(char *) obstack_base (&host_data
);
1163 /* Parse a C escape sequence. STRING_PTR points to a variable
1164 containing a pointer to the string to parse. That pointer
1165 should point to the character after the \. That pointer
1166 is updated past the characters we use. The value of the
1167 escape sequence is returned.
1169 A negative value means the sequence \ newline was seen,
1170 which is supposed to be equivalent to nothing at all.
1172 If \ is followed by a null character, we return a negative
1173 value and leave the string pointer pointing at the null character.
1175 If \ is followed by 000, we return 0 and leave the string pointer
1176 after the zeros. A value of 0 does not mean end of string. */
1179 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1181 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1182 int c
= *(*string_ptr
)++;
1201 int i
= host_hex_value (c
);
1206 if (isdigit (c
) && c
!= '8' && c
!= '9')
1210 i
+= host_hex_value (c
);
1246 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1247 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1248 " which has no equivalent\nin the `%s' character set."),
1249 c
, c
, target_charset (gdbarch
));
1253 /* Print the character C on STREAM as part of the contents of a literal
1254 string whose delimiter is QUOTER. Note that this routine should only
1255 be called for printing things which are independent of the language
1256 of the program being debugged.
1258 printchar will normally escape backslashes and instances of QUOTER. If
1259 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1260 As a side effect, if you pass the backslash character as the QUOTER,
1261 printchar will escape backslashes as usual, but not any other quoting
1265 printchar (int c
, void (*do_fputs
) (const char *, struct ui_file
*),
1266 void (*do_fprintf
) (struct ui_file
*, const char *, ...)
1267 ATTRIBUTE_FPTR_PRINTF_2
, struct ui_file
*stream
, int quoter
)
1269 c
&= 0xFF; /* Avoid sign bit follies */
1271 if (c
< 0x20 || /* Low control chars */
1272 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1273 (sevenbit_strings
&& c
>= 0x80))
1274 { /* high order bit set */
1278 do_fputs ("\\n", stream
);
1281 do_fputs ("\\b", stream
);
1284 do_fputs ("\\t", stream
);
1287 do_fputs ("\\f", stream
);
1290 do_fputs ("\\r", stream
);
1293 do_fputs ("\\e", stream
);
1296 do_fputs ("\\a", stream
);
1299 do_fprintf (stream
, "\\%.3o", (unsigned int) c
);
1305 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1306 do_fputs ("\\", stream
);
1307 do_fprintf (stream
, "%c", c
);
1311 /* Print the character C on STREAM as part of the contents of a
1312 literal string whose delimiter is QUOTER. Note that these routines
1313 should only be call for printing things which are independent of
1314 the language of the program being debugged. */
1317 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1320 printchar (*str
++, fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1324 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1327 printchar (*str
++, fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1331 fputstrn_filtered (const char *str
, int n
, int quoter
,
1332 struct ui_file
*stream
)
1336 for (i
= 0; i
< n
; i
++)
1337 printchar (str
[i
], fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1341 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1342 struct ui_file
*stream
)
1346 for (i
= 0; i
< n
; i
++)
1347 printchar (str
[i
], fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1351 /* Number of lines per page or UINT_MAX if paging is disabled. */
1352 static unsigned int lines_per_page
;
1354 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1355 struct cmd_list_element
*c
, const char *value
)
1357 fprintf_filtered (file
,
1358 _("Number of lines gdb thinks are in a page is %s.\n"),
1362 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1363 static unsigned int chars_per_line
;
1365 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1366 struct cmd_list_element
*c
, const char *value
)
1368 fprintf_filtered (file
,
1369 _("Number of characters gdb thinks "
1370 "are in a line is %s.\n"),
1374 /* Current count of lines printed on this page, chars on this line. */
1375 static unsigned int lines_printed
, chars_printed
;
1377 /* Buffer and start column of buffered text, for doing smarter word-
1378 wrapping. When someone calls wrap_here(), we start buffering output
1379 that comes through fputs_filtered(). If we see a newline, we just
1380 spit it out and forget about the wrap_here(). If we see another
1381 wrap_here(), we spit it out and remember the newer one. If we see
1382 the end of the line, we spit out a newline, the indent, and then
1383 the buffered output. */
1385 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1386 are waiting to be output (they have already been counted in chars_printed).
1387 When wrap_buffer[0] is null, the buffer is empty. */
1388 static char *wrap_buffer
;
1390 /* Pointer in wrap_buffer to the next character to fill. */
1391 static char *wrap_pointer
;
1393 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1395 static const char *wrap_indent
;
1397 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1398 is not in effect. */
1399 static int wrap_column
;
1402 /* Initialize the number of lines per page and chars per line. */
1405 init_page_info (void)
1409 lines_per_page
= UINT_MAX
;
1410 chars_per_line
= UINT_MAX
;
1414 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1419 #if defined(__GO32__)
1420 rows
= ScreenRows ();
1421 cols
= ScreenCols ();
1422 lines_per_page
= rows
;
1423 chars_per_line
= cols
;
1425 /* Make sure Readline has initialized its terminal settings. */
1426 rl_reset_terminal (NULL
);
1428 /* Get the screen size from Readline. */
1429 rl_get_screen_size (&rows
, &cols
);
1430 lines_per_page
= rows
;
1431 chars_per_line
= cols
;
1433 /* Readline should have fetched the termcap entry for us.
1434 Only try to use tgetnum function if rl_get_screen_size
1435 did not return a useful value. */
1436 if (((rows
<= 0) && (tgetnum ((char *) "li") < 0))
1437 /* Also disable paging if inside Emacs. $EMACS was used
1438 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1439 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1441 /* The number of lines per page is not mentioned in the terminal
1442 description or EMACS evironment variable is set. This probably
1443 means that paging is not useful, so disable paging. */
1444 lines_per_page
= UINT_MAX
;
1447 /* If the output is not a terminal, don't paginate it. */
1448 if (!ui_file_isatty (gdb_stdout
))
1449 lines_per_page
= UINT_MAX
;
1453 /* We handle SIGWINCH ourselves. */
1454 rl_catch_sigwinch
= 0;
1460 /* Return nonzero if filtered printing is initialized. */
1462 filtered_printing_initialized (void)
1464 return wrap_buffer
!= NULL
;
1467 /* Helper for make_cleanup_restore_page_info. */
1470 do_restore_page_info_cleanup (void *arg
)
1476 /* Provide cleanup for restoring the terminal size. */
1479 make_cleanup_restore_page_info (void)
1481 struct cleanup
*back_to
;
1483 back_to
= make_cleanup (do_restore_page_info_cleanup
, NULL
);
1484 make_cleanup_restore_uinteger (&lines_per_page
);
1485 make_cleanup_restore_uinteger (&chars_per_line
);
1490 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1491 Provide cleanup for restoring the original state. */
1494 set_batch_flag_and_make_cleanup_restore_page_info (void)
1496 struct cleanup
*back_to
= make_cleanup_restore_page_info ();
1498 make_cleanup_restore_integer (&batch_flag
);
1505 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1508 set_screen_size (void)
1510 int rows
= lines_per_page
;
1511 int cols
= chars_per_line
;
1519 /* Update Readline's idea of the terminal size. */
1520 rl_set_screen_size (rows
, cols
);
1523 /* Reinitialize WRAP_BUFFER according to the current value of
1529 if (chars_per_line
== 0)
1534 wrap_buffer
= (char *) xmalloc (chars_per_line
+ 2);
1535 wrap_buffer
[0] = '\0';
1538 wrap_buffer
= (char *) xrealloc (wrap_buffer
, chars_per_line
+ 2);
1539 wrap_pointer
= wrap_buffer
; /* Start it at the beginning. */
1543 set_width_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1550 set_height_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1558 set_screen_width_and_height (int width
, int height
)
1560 lines_per_page
= height
;
1561 chars_per_line
= width
;
1567 /* Wait, so the user can read what's on the screen. Prompt the user
1568 to continue by pressing RETURN. 'q' is also provided because
1569 telling users what to do in the prompt is more user-friendly than
1570 expecting them to think of Ctrl-C/SIGINT. */
1573 prompt_for_continue (void)
1576 char cont_prompt
[120];
1577 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
1578 /* Used to add duration we waited for user to respond to
1579 prompt_for_continue_wait_time. */
1580 using namespace std::chrono
;
1581 steady_clock::time_point prompt_started
= steady_clock::now ();
1583 if (annotation_level
> 1)
1584 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1586 strcpy (cont_prompt
,
1587 "---Type <return> to continue, or q <return> to quit---");
1588 if (annotation_level
> 1)
1589 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1591 /* We must do this *before* we call gdb_readline_wrapper, else it
1592 will eventually call us -- thinking that we're trying to print
1593 beyond the end of the screen. */
1594 reinitialize_more_filter ();
1596 scoped_input_handler prepare_input
;
1598 /* Call gdb_readline_wrapper, not readline, in order to keep an
1599 event loop running. */
1600 ignore
= gdb_readline_wrapper (cont_prompt
);
1601 make_cleanup (xfree
, ignore
);
1603 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1604 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1606 if (annotation_level
> 1)
1607 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1613 while (*p
== ' ' || *p
== '\t')
1616 /* Do not call quit here; there is no possibility of SIGINT. */
1617 throw_quit ("Quit");
1620 /* Now we have to do this again, so that GDB will know that it doesn't
1621 need to save the ---Type <return>--- line at the top of the screen. */
1622 reinitialize_more_filter ();
1624 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1626 do_cleanups (old_chain
);
1629 /* Initialize timer to keep track of how long we waited for the user. */
1632 reset_prompt_for_continue_wait_time (void)
1634 using namespace std::chrono
;
1636 prompt_for_continue_wait_time
= steady_clock::duration::zero ();
1639 /* Fetch the cumulative time spent in prompt_for_continue. */
1641 std::chrono::steady_clock::duration
1642 get_prompt_for_continue_wait_time ()
1644 return prompt_for_continue_wait_time
;
1647 /* Reinitialize filter; ie. tell it to reset to original values. */
1650 reinitialize_more_filter (void)
1656 /* Indicate that if the next sequence of characters overflows the line,
1657 a newline should be inserted here rather than when it hits the end.
1658 If INDENT is non-null, it is a string to be printed to indent the
1659 wrapped part on the next line. INDENT must remain accessible until
1660 the next call to wrap_here() or until a newline is printed through
1663 If the line is already overfull, we immediately print a newline and
1664 the indentation, and disable further wrapping.
1666 If we don't know the width of lines, but we know the page height,
1667 we must not wrap words, but should still keep track of newlines
1668 that were explicitly printed.
1670 INDENT should not contain tabs, as that will mess up the char count
1671 on the next line. FIXME.
1673 This routine is guaranteed to force out any output which has been
1674 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1675 used to force out output from the wrap_buffer. */
1678 wrap_here (const char *indent
)
1680 /* This should have been allocated, but be paranoid anyway. */
1682 internal_error (__FILE__
, __LINE__
,
1683 _("failed internal consistency check"));
1687 *wrap_pointer
= '\0';
1688 fputs_unfiltered (wrap_buffer
, gdb_stdout
);
1690 wrap_pointer
= wrap_buffer
;
1691 wrap_buffer
[0] = '\0';
1692 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1696 else if (chars_printed
>= chars_per_line
)
1698 puts_filtered ("\n");
1700 puts_filtered (indent
);
1705 wrap_column
= chars_printed
;
1709 wrap_indent
= indent
;
1713 /* Print input string to gdb_stdout, filtered, with wrap,
1714 arranging strings in columns of n chars. String can be
1715 right or left justified in the column. Never prints
1716 trailing spaces. String should never be longer than
1717 width. FIXME: this could be useful for the EXAMINE
1718 command, which currently doesn't tabulate very well. */
1721 puts_filtered_tabular (char *string
, int width
, int right
)
1727 gdb_assert (chars_per_line
> 0);
1728 if (chars_per_line
== UINT_MAX
)
1730 fputs_filtered (string
, gdb_stdout
);
1731 fputs_filtered ("\n", gdb_stdout
);
1735 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1736 fputs_filtered ("\n", gdb_stdout
);
1738 if (width
>= chars_per_line
)
1739 width
= chars_per_line
- 1;
1741 stringlen
= strlen (string
);
1743 if (chars_printed
> 0)
1744 spaces
= width
- (chars_printed
- 1) % width
- 1;
1746 spaces
+= width
- stringlen
;
1748 spacebuf
= (char *) alloca (spaces
+ 1);
1749 spacebuf
[spaces
] = '\0';
1751 spacebuf
[spaces
] = ' ';
1753 fputs_filtered (spacebuf
, gdb_stdout
);
1754 fputs_filtered (string
, gdb_stdout
);
1758 /* Ensure that whatever gets printed next, using the filtered output
1759 commands, starts at the beginning of the line. I.e. if there is
1760 any pending output for the current line, flush it and start a new
1761 line. Otherwise do nothing. */
1766 if (chars_printed
> 0)
1768 puts_filtered ("\n");
1773 /* Like fputs but if FILTER is true, pause after every screenful.
1775 Regardless of FILTER can wrap at points other than the final
1776 character of a line.
1778 Unlike fputs, fputs_maybe_filtered does not return a value.
1779 It is OK for LINEBUFFER to be NULL, in which case just don't print
1782 Note that a longjmp to top level may occur in this routine (only if
1783 FILTER is true) (since prompt_for_continue may do so) so this
1784 routine should not be called when cleanups are not in place. */
1787 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1790 const char *lineptr
;
1792 if (linebuffer
== 0)
1795 /* Don't do any filtering if it is disabled. */
1796 if (stream
!= gdb_stdout
1797 || !pagination_enabled
1799 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
1800 || top_level_interpreter () == NULL
1801 || interp_ui_out (top_level_interpreter ())->is_mi_like_p ())
1803 fputs_unfiltered (linebuffer
, stream
);
1807 /* Go through and output each character. Show line extension
1808 when this is necessary; prompt user for new page when this is
1811 lineptr
= linebuffer
;
1814 /* Possible new page. */
1815 if (filter
&& (lines_printed
>= lines_per_page
- 1))
1816 prompt_for_continue ();
1818 while (*lineptr
&& *lineptr
!= '\n')
1820 /* Print a single line. */
1821 if (*lineptr
== '\t')
1824 *wrap_pointer
++ = '\t';
1826 fputc_unfiltered ('\t', stream
);
1827 /* Shifting right by 3 produces the number of tab stops
1828 we have already passed, and then adding one and
1829 shifting left 3 advances to the next tab stop. */
1830 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
1836 *wrap_pointer
++ = *lineptr
;
1838 fputc_unfiltered (*lineptr
, stream
);
1843 if (chars_printed
>= chars_per_line
)
1845 unsigned int save_chars
= chars_printed
;
1849 /* If we aren't actually wrapping, don't output newline --
1850 if chars_per_line is right, we probably just overflowed
1851 anyway; if it's wrong, let us keep going. */
1853 fputc_unfiltered ('\n', stream
);
1855 /* Possible new page. */
1856 if (lines_printed
>= lines_per_page
- 1)
1857 prompt_for_continue ();
1859 /* Now output indentation and wrapped string. */
1862 fputs_unfiltered (wrap_indent
, stream
);
1863 *wrap_pointer
= '\0'; /* Null-terminate saved stuff, */
1864 fputs_unfiltered (wrap_buffer
, stream
); /* and eject it. */
1865 /* FIXME, this strlen is what prevents wrap_indent from
1866 containing tabs. However, if we recurse to print it
1867 and count its chars, we risk trouble if wrap_indent is
1868 longer than (the user settable) chars_per_line.
1869 Note also that this can set chars_printed > chars_per_line
1870 if we are printing a long string. */
1871 chars_printed
= strlen (wrap_indent
)
1872 + (save_chars
- wrap_column
);
1873 wrap_pointer
= wrap_buffer
; /* Reset buffer */
1874 wrap_buffer
[0] = '\0';
1875 wrap_column
= 0; /* And disable fancy wrap */
1880 if (*lineptr
== '\n')
1883 wrap_here ((char *) 0); /* Spit out chars, cancel
1886 fputc_unfiltered ('\n', stream
);
1893 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
1895 fputs_maybe_filtered (linebuffer
, stream
, 1);
1899 putchar_unfiltered (int c
)
1903 ui_file_write (gdb_stdout
, &buf
, 1);
1907 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
1908 May return nonlocally. */
1911 putchar_filtered (int c
)
1913 return fputc_filtered (c
, gdb_stdout
);
1917 fputc_unfiltered (int c
, struct ui_file
*stream
)
1921 ui_file_write (stream
, &buf
, 1);
1926 fputc_filtered (int c
, struct ui_file
*stream
)
1932 fputs_filtered (buf
, stream
);
1936 /* puts_debug is like fputs_unfiltered, except it prints special
1937 characters in printable fashion. */
1940 puts_debug (char *prefix
, char *string
, char *suffix
)
1944 /* Print prefix and suffix after each line. */
1945 static int new_line
= 1;
1946 static int return_p
= 0;
1947 static const char *prev_prefix
= "";
1948 static const char *prev_suffix
= "";
1950 if (*string
== '\n')
1953 /* If the prefix is changing, print the previous suffix, a new line,
1954 and the new prefix. */
1955 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
1957 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
1958 fputs_unfiltered ("\n", gdb_stdlog
);
1959 fputs_unfiltered (prefix
, gdb_stdlog
);
1962 /* Print prefix if we printed a newline during the previous call. */
1966 fputs_unfiltered (prefix
, gdb_stdlog
);
1969 prev_prefix
= prefix
;
1970 prev_suffix
= suffix
;
1972 /* Output characters in a printable format. */
1973 while ((ch
= *string
++) != '\0')
1979 fputc_unfiltered (ch
, gdb_stdlog
);
1982 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
1986 fputs_unfiltered ("\\\\", gdb_stdlog
);
1989 fputs_unfiltered ("\\b", gdb_stdlog
);
1992 fputs_unfiltered ("\\f", gdb_stdlog
);
1996 fputs_unfiltered ("\\n", gdb_stdlog
);
1999 fputs_unfiltered ("\\r", gdb_stdlog
);
2002 fputs_unfiltered ("\\t", gdb_stdlog
);
2005 fputs_unfiltered ("\\v", gdb_stdlog
);
2009 return_p
= ch
== '\r';
2012 /* Print suffix if we printed a newline. */
2015 fputs_unfiltered (suffix
, gdb_stdlog
);
2016 fputs_unfiltered ("\n", gdb_stdlog
);
2021 /* Print a variable number of ARGS using format FORMAT. If this
2022 information is going to put the amount written (since the last call
2023 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2024 call prompt_for_continue to get the users permision to continue.
2026 Unlike fprintf, this function does not return a value.
2028 We implement three variants, vfprintf (takes a vararg list and stream),
2029 fprintf (takes a stream to write on), and printf (the usual).
2031 Note also that a longjmp to top level may occur in this routine
2032 (since prompt_for_continue may do so) so this routine should not be
2033 called when cleanups are not in place. */
2036 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2037 va_list args
, int filter
)
2040 struct cleanup
*old_cleanups
;
2042 linebuffer
= xstrvprintf (format
, args
);
2043 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2044 fputs_maybe_filtered (linebuffer
, stream
, filter
);
2045 do_cleanups (old_cleanups
);
2050 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2052 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2056 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2059 struct cleanup
*old_cleanups
;
2061 linebuffer
= xstrvprintf (format
, args
);
2062 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2063 if (debug_timestamp
&& stream
== gdb_stdlog
)
2065 using namespace std::chrono
;
2068 steady_clock::time_point now
= steady_clock::now ();
2069 seconds s
= duration_cast
<seconds
> (now
.time_since_epoch ());
2070 microseconds us
= duration_cast
<microseconds
> (now
.time_since_epoch () - s
);
2072 len
= strlen (linebuffer
);
2073 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2075 std::string timestamp
= string_printf ("%ld.%06ld %s%s",
2078 linebuffer
, need_nl
? "\n": "");
2079 fputs_unfiltered (timestamp
.c_str (), stream
);
2082 fputs_unfiltered (linebuffer
, stream
);
2083 do_cleanups (old_cleanups
);
2087 vprintf_filtered (const char *format
, va_list args
)
2089 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2093 vprintf_unfiltered (const char *format
, va_list args
)
2095 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2099 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2103 va_start (args
, format
);
2104 vfprintf_filtered (stream
, format
, args
);
2109 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2113 va_start (args
, format
);
2114 vfprintf_unfiltered (stream
, format
, args
);
2118 /* Like fprintf_filtered, but prints its result indented.
2119 Called as fprintfi_filtered (spaces, stream, format, ...); */
2122 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2127 va_start (args
, format
);
2128 print_spaces_filtered (spaces
, stream
);
2130 vfprintf_filtered (stream
, format
, args
);
2136 printf_filtered (const char *format
, ...)
2140 va_start (args
, format
);
2141 vfprintf_filtered (gdb_stdout
, format
, args
);
2147 printf_unfiltered (const char *format
, ...)
2151 va_start (args
, format
);
2152 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2156 /* Like printf_filtered, but prints it's result indented.
2157 Called as printfi_filtered (spaces, format, ...); */
2160 printfi_filtered (int spaces
, const char *format
, ...)
2164 va_start (args
, format
);
2165 print_spaces_filtered (spaces
, gdb_stdout
);
2166 vfprintf_filtered (gdb_stdout
, format
, args
);
2170 /* Easy -- but watch out!
2172 This routine is *not* a replacement for puts()! puts() appends a newline.
2173 This one doesn't, and had better not! */
2176 puts_filtered (const char *string
)
2178 fputs_filtered (string
, gdb_stdout
);
2182 puts_unfiltered (const char *string
)
2184 fputs_unfiltered (string
, gdb_stdout
);
2187 /* Return a pointer to N spaces and a null. The pointer is good
2188 until the next call to here. */
2193 static char *spaces
= 0;
2194 static int max_spaces
= -1;
2200 spaces
= (char *) xmalloc (n
+ 1);
2201 for (t
= spaces
+ n
; t
!= spaces
;)
2207 return spaces
+ max_spaces
- n
;
2210 /* Print N spaces. */
2212 print_spaces_filtered (int n
, struct ui_file
*stream
)
2214 fputs_filtered (n_spaces (n
), stream
);
2217 /* C++/ObjC demangler stuff. */
2219 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2220 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2221 If the name is not mangled, or the language for the name is unknown, or
2222 demangling is off, the name is printed in its "raw" form. */
2225 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2226 enum language lang
, int arg_mode
)
2232 /* If user wants to see raw output, no problem. */
2235 fputs_filtered (name
, stream
);
2239 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2240 fputs_filtered (demangled
? demangled
: name
, stream
);
2241 if (demangled
!= NULL
)
2249 /* Modes of operation for strncmp_iw_with_mode. */
2251 enum class strncmp_iw_mode
2253 /* Work like strncmp, while ignoring whitespace. */
2256 /* Like NORMAL, but also apply the strcmp_iw hack. I.e.,
2257 string1=="FOO(PARAMS)" matches string2=="FOO". */
2261 /* Helper for strncmp_iw and strcmp_iw. */
2264 strncmp_iw_with_mode (const char *string1
, const char *string2
,
2265 size_t string2_len
, strncmp_iw_mode mode
)
2267 const char *end_str2
= string2
+ string2_len
;
2271 while (isspace (*string1
))
2273 while (string2
< end_str2
&& isspace (*string2
))
2275 if (*string1
== '\0' || string2
== end_str2
)
2277 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2279 if (case_sensitivity
== case_sensitive_off
2280 && (tolower ((unsigned char) *string1
)
2281 != tolower ((unsigned char) *string2
)))
2288 if (string2
== end_str2
)
2290 if (mode
== strncmp_iw_mode::NORMAL
)
2293 return (*string1
!= '\0' && *string1
!= '(');
2302 strncmp_iw (const char *string1
, const char *string2
, size_t string2_len
)
2304 return strncmp_iw_with_mode (string1
, string2
, string2_len
,
2305 strncmp_iw_mode::NORMAL
);
2311 strcmp_iw (const char *string1
, const char *string2
)
2313 return strncmp_iw_with_mode (string1
, string2
, strlen (string2
),
2314 strncmp_iw_mode::MATCH_PARAMS
);
2317 /* This is like strcmp except that it ignores whitespace and treats
2318 '(' as the first non-NULL character in terms of ordering. Like
2319 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2320 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2321 according to that ordering.
2323 If a list is sorted according to this function and if you want to
2324 find names in the list that match some fixed NAME according to
2325 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2326 where this function would put NAME.
2328 This function must be neutral to the CASE_SENSITIVITY setting as the user
2329 may choose it during later lookup. Therefore this function always sorts
2330 primarily case-insensitively and secondarily case-sensitively.
2332 Here are some examples of why using strcmp to sort is a bad idea:
2336 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2337 we try to do a search for "foo<char*>", strcmp will locate this
2338 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2339 will start looking at strings beginning with "goo", and will never
2340 see the correct match of "foo<char *>".
2342 Parenthesis example:
2344 In practice, this is less like to be an issue, but I'll give it a
2345 shot. Let's assume that '$' is a legitimate character to occur in
2346 symbols. (Which may well even be the case on some systems.) Then
2347 say that the partial symbol table contains "foo$" and "foo(int)".
2348 strcmp will put them in this order, since '$' < '('. Now, if the
2349 user searches for "foo", then strcmp will sort "foo" before "foo$".
2350 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2351 "foo") is false, so it won't proceed to the actual match of
2352 "foo(int)" with "foo". */
2355 strcmp_iw_ordered (const char *string1
, const char *string2
)
2357 const char *saved_string1
= string1
, *saved_string2
= string2
;
2358 enum case_sensitivity case_pass
= case_sensitive_off
;
2362 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2363 Provide stub characters if we are already at the end of one of the
2365 char c1
= 'X', c2
= 'X';
2367 while (*string1
!= '\0' && *string2
!= '\0')
2369 while (isspace (*string1
))
2371 while (isspace (*string2
))
2376 case case_sensitive_off
:
2377 c1
= tolower ((unsigned char) *string1
);
2378 c2
= tolower ((unsigned char) *string2
);
2380 case case_sensitive_on
:
2388 if (*string1
!= '\0')
2397 /* Characters are non-equal unless they're both '\0'; we want to
2398 make sure we get the comparison right according to our
2399 comparison in the cases where one of them is '\0' or '('. */
2401 if (*string2
== '\0')
2406 if (*string2
== '\0')
2411 if (*string2
== '\0' || *string2
== '(')
2420 if (case_pass
== case_sensitive_on
)
2423 /* Otherwise the strings were equal in case insensitive way, make
2424 a more fine grained comparison in a case sensitive way. */
2426 case_pass
= case_sensitive_on
;
2427 string1
= saved_string1
;
2428 string2
= saved_string2
;
2432 /* A simple comparison function with opposite semantics to strcmp. */
2435 streq (const char *lhs
, const char *rhs
)
2437 return !strcmp (lhs
, rhs
);
2443 ** Answer whether string_to_compare is a full or partial match to
2444 ** template_string. The partial match must be in sequence starting
2448 subset_compare (const char *string_to_compare
, const char *template_string
)
2452 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
2453 && strlen (string_to_compare
) <= strlen (template_string
))
2455 (startswith (template_string
, string_to_compare
));
2462 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2463 struct cmd_list_element
*c
, const char *value
)
2465 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2471 initialize_utils (void)
2473 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
2474 Set number of characters where GDB should wrap lines of its output."), _("\
2475 Show number of characters where GDB should wrap lines of its output."), _("\
2476 This affects where GDB wraps its output to fit the screen width.\n\
2477 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2479 show_chars_per_line
,
2480 &setlist
, &showlist
);
2482 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
2483 Set number of lines in a page for GDB output pagination."), _("\
2484 Show number of lines in a page for GDB output pagination."), _("\
2485 This affects the number of lines after which GDB will pause\n\
2486 its output and ask you whether to continue.\n\
2487 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2489 show_lines_per_page
,
2490 &setlist
, &showlist
);
2492 add_setshow_boolean_cmd ("pagination", class_support
,
2493 &pagination_enabled
, _("\
2494 Set state of GDB output pagination."), _("\
2495 Show state of GDB output pagination."), _("\
2496 When pagination is ON, GDB pauses at end of each screenful of\n\
2497 its output and asks you whether to continue.\n\
2498 Turning pagination off is an alternative to \"set height unlimited\"."),
2500 show_pagination_enabled
,
2501 &setlist
, &showlist
);
2503 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
2504 &sevenbit_strings
, _("\
2505 Set printing of 8-bit characters in strings as \\nnn."), _("\
2506 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
2508 show_sevenbit_strings
,
2509 &setprintlist
, &showprintlist
);
2511 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
2512 &debug_timestamp
, _("\
2513 Set timestamping of debugging messages."), _("\
2514 Show timestamping of debugging messages."), _("\
2515 When set, debugging messages will be marked with seconds and microseconds."),
2517 show_debug_timestamp
,
2518 &setdebuglist
, &showdebuglist
);
2522 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2524 /* Truncate address to the size of a target address, avoiding shifts
2525 larger or equal than the width of a CORE_ADDR. The local
2526 variable ADDR_BIT stops the compiler reporting a shift overflow
2527 when it won't occur. */
2528 /* NOTE: This assumes that the significant address information is
2529 kept in the least significant bits of ADDR - the upper bits were
2530 either zero or sign extended. Should gdbarch_address_to_pointer or
2531 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2533 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2535 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2536 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2537 return hex_string (addr
);
2540 /* This function is described in "defs.h". */
2543 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2545 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2547 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2548 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2550 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2551 that returns the language localized string formatted to a width
2552 based on gdbarch_addr_bit. */
2554 return hex_string_custom (address
, 8);
2556 return hex_string_custom (address
, 16);
2559 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2562 core_addr_hash (const void *ap
)
2564 const CORE_ADDR
*addrp
= (const CORE_ADDR
*) ap
;
2569 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2572 core_addr_eq (const void *ap
, const void *bp
)
2574 const CORE_ADDR
*addr_ap
= (const CORE_ADDR
*) ap
;
2575 const CORE_ADDR
*addr_bp
= (const CORE_ADDR
*) bp
;
2577 return *addr_ap
== *addr_bp
;
2580 /* Convert a string back into a CORE_ADDR. */
2582 string_to_core_addr (const char *my_string
)
2586 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2588 /* Assume that it is in hex. */
2591 for (i
= 2; my_string
[i
] != '\0'; i
++)
2593 if (isdigit (my_string
[i
]))
2594 addr
= (my_string
[i
] - '0') + (addr
* 16);
2595 else if (isxdigit (my_string
[i
]))
2596 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2598 error (_("invalid hex \"%s\""), my_string
);
2603 /* Assume that it is in decimal. */
2606 for (i
= 0; my_string
[i
] != '\0'; i
++)
2608 if (isdigit (my_string
[i
]))
2609 addr
= (my_string
[i
] - '0') + (addr
* 10);
2611 error (_("invalid decimal \"%s\""), my_string
);
2618 gdb::unique_xmalloc_ptr
<char>
2619 gdb_realpath (const char *filename
)
2621 /* On most hosts, we rely on canonicalize_file_name to compute
2622 the FILENAME's realpath.
2624 But the situation is slightly more complex on Windows, due to some
2625 versions of GCC which were reported to generate paths where
2626 backlashes (the directory separator) were doubled. For instance:
2627 c:\\some\\double\\slashes\\dir
2629 c:\some\double\slashes\dir
2630 Those double-slashes were getting in the way when comparing paths,
2631 for instance when trying to insert a breakpoint as follow:
2632 (gdb) b c:/some/double/slashes/dir/foo.c:4
2633 No source file named c:/some/double/slashes/dir/foo.c:4.
2634 (gdb) b c:\some\double\slashes\dir\foo.c:4
2635 No source file named c:\some\double\slashes\dir\foo.c:4.
2636 To prevent this from happening, we need this function to always
2637 strip those extra backslashes. While canonicalize_file_name does
2638 perform this simplification, it only works when the path is valid.
2639 Since the simplification would be useful even if the path is not
2640 valid (one can always set a breakpoint on a file, even if the file
2641 does not exist locally), we rely instead on GetFullPathName to
2642 perform the canonicalization. */
2644 #if defined (_WIN32)
2647 DWORD len
= GetFullPathName (filename
, MAX_PATH
, buf
, NULL
);
2649 /* The file system is case-insensitive but case-preserving.
2650 So it is important we do not lowercase the path. Otherwise,
2651 we might not be able to display the original casing in a given
2653 if (len
> 0 && len
< MAX_PATH
)
2654 return gdb::unique_xmalloc_ptr
<char> (xstrdup (buf
));
2658 char *rp
= canonicalize_file_name (filename
);
2661 return gdb::unique_xmalloc_ptr
<char> (rp
);
2665 /* This system is a lost cause, just dup the buffer. */
2666 return gdb::unique_xmalloc_ptr
<char> (xstrdup (filename
));
2672 gdb_realpath_check_trailer (const char *input
, const char *trailer
)
2674 gdb::unique_xmalloc_ptr
<char> result
= gdb_realpath (input
);
2676 size_t len
= strlen (result
.get ());
2677 size_t trail_len
= strlen (trailer
);
2679 SELF_CHECK (len
>= trail_len
2680 && strcmp (result
.get () + len
- trail_len
, trailer
) == 0);
2684 gdb_realpath_tests ()
2686 /* A file which contains a directory prefix. */
2687 gdb_realpath_check_trailer ("./xfullpath.exp", "/xfullpath.exp");
2688 /* A file which contains a directory prefix. */
2689 gdb_realpath_check_trailer ("../../defs.h", "/defs.h");
2690 /* A one-character filename. */
2691 gdb_realpath_check_trailer ("./a", "/a");
2692 /* A file in the root directory. */
2693 gdb_realpath_check_trailer ("/root_file_which_should_exist",
2694 "/root_file_which_should_exist");
2695 /* A file which does not have a directory prefix. */
2696 gdb_realpath_check_trailer ("xfullpath.exp", "xfullpath.exp");
2697 /* A one-char filename without any directory prefix. */
2698 gdb_realpath_check_trailer ("a", "a");
2699 /* An empty filename. */
2700 gdb_realpath_check_trailer ("", "");
2703 #endif /* GDB_SELF_TEST */
2705 /* Return a copy of FILENAME, with its directory prefix canonicalized
2708 gdb::unique_xmalloc_ptr
<char>
2709 gdb_realpath_keepfile (const char *filename
)
2711 const char *base_name
= lbasename (filename
);
2715 /* Extract the basename of filename, and return immediately
2716 a copy of filename if it does not contain any directory prefix. */
2717 if (base_name
== filename
)
2718 return gdb::unique_xmalloc_ptr
<char> (xstrdup (filename
));
2720 dir_name
= (char *) alloca ((size_t) (base_name
- filename
+ 2));
2721 /* Allocate enough space to store the dir_name + plus one extra
2722 character sometimes needed under Windows (see below), and
2723 then the closing \000 character. */
2724 strncpy (dir_name
, filename
, base_name
- filename
);
2725 dir_name
[base_name
- filename
] = '\000';
2727 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
2728 /* We need to be careful when filename is of the form 'd:foo', which
2729 is equivalent of d:./foo, which is totally different from d:/foo. */
2730 if (strlen (dir_name
) == 2 && isalpha (dir_name
[0]) && dir_name
[1] == ':')
2733 dir_name
[3] = '\000';
2737 /* Canonicalize the directory prefix, and build the resulting
2738 filename. If the dirname realpath already contains an ending
2739 directory separator, avoid doubling it. */
2740 gdb::unique_xmalloc_ptr
<char> path_storage
= gdb_realpath (dir_name
);
2741 const char *real_path
= path_storage
.get ();
2742 if (IS_DIR_SEPARATOR (real_path
[strlen (real_path
) - 1]))
2743 result
= concat (real_path
, base_name
, (char *) NULL
);
2745 result
= concat (real_path
, SLASH_STRING
, base_name
, (char *) NULL
);
2747 return gdb::unique_xmalloc_ptr
<char> (result
);
2750 /* Return PATH in absolute form, performing tilde-expansion if necessary.
2751 PATH cannot be NULL or the empty string.
2752 This does not resolve symlinks however, use gdb_realpath for that. */
2754 gdb::unique_xmalloc_ptr
<char>
2755 gdb_abspath (const char *path
)
2757 gdb_assert (path
!= NULL
&& path
[0] != '\0');
2760 return gdb::unique_xmalloc_ptr
<char> (tilde_expand (path
));
2762 if (IS_ABSOLUTE_PATH (path
))
2763 return gdb::unique_xmalloc_ptr
<char> (xstrdup (path
));
2765 /* Beware the // my son, the Emacs barfs, the botch that catch... */
2766 return gdb::unique_xmalloc_ptr
<char>
2767 (concat (current_directory
,
2768 IS_DIR_SEPARATOR (current_directory
[strlen (current_directory
) - 1])
2769 ? "" : SLASH_STRING
,
2770 path
, (char *) NULL
));
2774 align_up (ULONGEST v
, int n
)
2776 /* Check that N is really a power of two. */
2777 gdb_assert (n
&& (n
& (n
-1)) == 0);
2778 return (v
+ n
- 1) & -n
;
2782 align_down (ULONGEST v
, int n
)
2784 /* Check that N is really a power of two. */
2785 gdb_assert (n
&& (n
& (n
-1)) == 0);
2789 /* Allocation function for the libiberty hash table which uses an
2790 obstack. The obstack is passed as DATA. */
2793 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
2795 size_t total
= size
* count
;
2796 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
2798 memset (ptr
, 0, total
);
2802 /* Trivial deallocation function for the libiberty splay tree and hash
2803 table - don't deallocate anything. Rely on later deletion of the
2804 obstack. DATA will be the obstack, although it is not needed
2808 dummy_obstack_deallocate (void *object
, void *data
)
2813 /* Simple, portable version of dirname that does not modify its
2817 ldirname (const char *filename
)
2819 std::string dirname
;
2820 const char *base
= lbasename (filename
);
2822 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
2825 if (base
== filename
)
2828 dirname
= std::string (filename
, base
- filename
);
2830 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
2831 create "d:./bar" later instead of the (different) "d:/bar". */
2832 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
2833 && !IS_DIR_SEPARATOR (filename
[0]))
2834 dirname
[base
++ - filename
] = '.';
2842 gdb_argv::reset (const char *s
)
2844 char **argv
= buildargv (s
);
2846 if (s
!= NULL
&& argv
== NULL
)
2854 compare_positive_ints (const void *ap
, const void *bp
)
2856 /* Because we know we're comparing two ints which are positive,
2857 there's no danger of overflow here. */
2858 return * (int *) ap
- * (int *) bp
;
2861 /* String compare function for qsort. */
2864 compare_strings (const void *arg1
, const void *arg2
)
2866 const char **s1
= (const char **) arg1
;
2867 const char **s2
= (const char **) arg2
;
2869 return strcmp (*s1
, *s2
);
2872 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
2873 #define AMBIGUOUS_MESS2 \
2874 ".\nUse \"set gnutarget format-name\" to specify the format."
2877 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
2883 /* Check if errmsg just need simple return. */
2884 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
2885 return bfd_errmsg (error_tag
);
2887 ret_len
= strlen (bfd_errmsg (error_tag
)) + strlen (AMBIGUOUS_MESS1
)
2888 + strlen (AMBIGUOUS_MESS2
);
2889 for (p
= matching
; *p
; p
++)
2890 ret_len
+= strlen (*p
) + 1;
2891 ret
= (char *) xmalloc (ret_len
+ 1);
2893 make_cleanup (xfree
, ret
);
2895 strcpy (retp
, bfd_errmsg (error_tag
));
2896 retp
+= strlen (retp
);
2898 strcpy (retp
, AMBIGUOUS_MESS1
);
2899 retp
+= strlen (retp
);
2901 for (p
= matching
; *p
; p
++)
2903 sprintf (retp
, " %s", *p
);
2904 retp
+= strlen (retp
);
2908 strcpy (retp
, AMBIGUOUS_MESS2
);
2913 /* Return ARGS parsed as a valid pid, or throw an error. */
2916 parse_pid_to_attach (const char *args
)
2922 error_no_arg (_("process-id to attach"));
2924 dummy
= (char *) args
;
2925 pid
= strtoul (args
, &dummy
, 0);
2926 /* Some targets don't set errno on errors, grrr! */
2927 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
2928 error (_("Illegal process-id: %s."), args
);
2933 /* Helper for make_bpstat_clear_actions_cleanup. */
2936 do_bpstat_clear_actions_cleanup (void *unused
)
2938 bpstat_clear_actions ();
2941 /* Call bpstat_clear_actions for the case an exception is throw. You should
2942 discard_cleanups if no exception is caught. */
2945 make_bpstat_clear_actions_cleanup (void)
2947 return make_cleanup (do_bpstat_clear_actions_cleanup
, NULL
);
2951 /* Helper for make_cleanup_free_char_ptr_vec. */
2954 do_free_char_ptr_vec (void *arg
)
2956 VEC (char_ptr
) *char_ptr_vec
= (VEC (char_ptr
) *) arg
;
2958 free_char_ptr_vec (char_ptr_vec
);
2961 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
2962 final VEC_free for CHAR_PTR_VEC itself.
2964 You must not modify CHAR_PTR_VEC after this cleanup registration as the
2965 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
2966 this function does not (cannot) clear the pointer. */
2969 make_cleanup_free_char_ptr_vec (VEC (char_ptr
) *char_ptr_vec
)
2971 return make_cleanup (do_free_char_ptr_vec
, char_ptr_vec
);
2974 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
2975 must come from xrealloc-compatible allocator and it may be updated. FROM
2976 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
2977 located at the start or end of *STRINGP. */
2980 substitute_path_component (char **stringp
, const char *from
, const char *to
)
2982 char *string
= *stringp
, *s
;
2983 const size_t from_len
= strlen (from
);
2984 const size_t to_len
= strlen (to
);
2988 s
= strstr (s
, from
);
2992 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
2993 || s
[-1] == DIRNAME_SEPARATOR
)
2994 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
2995 || s
[from_len
] == DIRNAME_SEPARATOR
))
3000 = (char *) xrealloc (string
, (strlen (string
) + to_len
+ 1));
3002 /* Relocate the current S pointer. */
3003 s
= s
- string
+ string_new
;
3004 string
= string_new
;
3006 /* Replace from by to. */
3007 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3008 memcpy (s
, to
, to_len
);
3023 /* SIGALRM handler for waitpid_with_timeout. */
3026 sigalrm_handler (int signo
)
3028 /* Nothing to do. */
3033 /* Wrapper to wait for child PID to die with TIMEOUT.
3034 TIMEOUT is the time to stop waiting in seconds.
3035 If TIMEOUT is zero, pass WNOHANG to waitpid.
3036 Returns PID if it was successfully waited for, otherwise -1.
3038 Timeouts are currently implemented with alarm and SIGALRM.
3039 If the host does not support them, this waits "forever".
3040 It would be odd though for a host to have waitpid and not SIGALRM. */
3043 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3045 pid_t waitpid_result
;
3047 gdb_assert (pid
> 0);
3048 gdb_assert (timeout
>= 0);
3053 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3054 struct sigaction sa
, old_sa
;
3056 sa
.sa_handler
= sigalrm_handler
;
3057 sigemptyset (&sa
.sa_mask
);
3059 sigaction (SIGALRM
, &sa
, &old_sa
);
3063 ofunc
= signal (SIGALRM
, sigalrm_handler
);
3069 waitpid_result
= waitpid (pid
, status
, 0);
3073 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3074 sigaction (SIGALRM
, &old_sa
, NULL
);
3076 signal (SIGALRM
, ofunc
);
3081 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3083 if (waitpid_result
== pid
)
3089 #endif /* HAVE_WAITPID */
3091 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3092 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3094 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3095 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3098 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3100 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3102 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3103 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3105 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3107 char *pattern_slash
, *string_slash
;
3109 /* Replace '\' by '/' in both strings. */
3111 pattern_slash
= (char *) alloca (strlen (pattern
) + 1);
3112 strcpy (pattern_slash
, pattern
);
3113 pattern
= pattern_slash
;
3114 for (; *pattern_slash
!= 0; pattern_slash
++)
3115 if (IS_DIR_SEPARATOR (*pattern_slash
))
3116 *pattern_slash
= '/';
3118 string_slash
= (char *) alloca (strlen (string
) + 1);
3119 strcpy (string_slash
, string
);
3120 string
= string_slash
;
3121 for (; *string_slash
!= 0; string_slash
++)
3122 if (IS_DIR_SEPARATOR (*string_slash
))
3123 *string_slash
= '/';
3125 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3127 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3128 flags
|= FNM_CASEFOLD
;
3129 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3131 return fnmatch (pattern
, string
, flags
);
3134 /* Return the number of path elements in PATH.
3142 count_path_elements (const char *path
)
3145 const char *p
= path
;
3147 if (HAS_DRIVE_SPEC (p
))
3149 p
= STRIP_DRIVE_SPEC (p
);
3155 if (IS_DIR_SEPARATOR (*p
))
3160 /* Backup one if last character is /, unless it's the only one. */
3161 if (p
> path
+ 1 && IS_DIR_SEPARATOR (p
[-1]))
3164 /* Add one for the file name, if present. */
3165 if (p
> path
&& !IS_DIR_SEPARATOR (p
[-1]))
3171 /* Remove N leading path elements from PATH.
3172 N must be non-negative.
3173 If PATH has more than N path elements then return NULL.
3174 If PATH has exactly N path elements then return "".
3175 See count_path_elements for a description of how we do the counting. */
3178 strip_leading_path_elements (const char *path
, int n
)
3181 const char *p
= path
;
3183 gdb_assert (n
>= 0);
3188 if (HAS_DRIVE_SPEC (p
))
3190 p
= STRIP_DRIVE_SPEC (p
);
3196 while (*p
!= '\0' && !IS_DIR_SEPARATOR (*p
))
3212 _initialize_utils (void)
3214 add_internal_problem_command (&internal_error_problem
);
3215 add_internal_problem_command (&internal_warning_problem
);
3216 add_internal_problem_command (&demangler_warning_problem
);
3219 selftests::register_test ("gdb_realpath", gdb_realpath_tests
);