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"
72 extern PTR
malloc (); /* ARI: PTR */
74 #if !HAVE_DECL_REALLOC
75 extern PTR
realloc (); /* ARI: PTR */
81 void (*deprecated_error_begin_hook
) (void);
83 /* Prototypes for local functions */
85 static void vfprintf_maybe_filtered (struct ui_file
*, const char *,
86 va_list, int) ATTRIBUTE_PRINTF (2, 0);
88 static void fputs_maybe_filtered (const char *, struct ui_file
*, int);
90 static void prompt_for_continue (void);
92 static void set_screen_size (void);
93 static void set_width (void);
95 /* Time spent in prompt_for_continue in the currently executing command
96 waiting for user to respond.
97 Initialized in make_command_stats_cleanup.
98 Modified in prompt_for_continue and defaulted_query.
99 Used in report_command_stats. */
101 static std::chrono::steady_clock::duration prompt_for_continue_wait_time
;
103 /* A flag indicating whether to timestamp debugging messages. */
105 static int debug_timestamp
= 0;
107 /* Nonzero means that strings with character values >0x7F should be printed
108 as octal escapes. Zero means just print the value (e.g. it's an
109 international character, and the terminal or window can cope.) */
111 int sevenbit_strings
= 0;
113 show_sevenbit_strings (struct ui_file
*file
, int from_tty
,
114 struct cmd_list_element
*c
, const char *value
)
116 fprintf_filtered (file
, _("Printing of 8-bit characters "
117 "in strings as \\nnn is %s.\n"),
121 /* String to be printed before warning messages, if any. */
123 const char *warning_pre_print
= "\nwarning: ";
125 int pagination_enabled
= 1;
127 show_pagination_enabled (struct ui_file
*file
, int from_tty
,
128 struct cmd_list_element
*c
, const char *value
)
130 fprintf_filtered (file
, _("State of pagination is %s.\n"), value
);
134 /* Cleanup utilities.
136 These are not defined in cleanups.c (nor declared in cleanups.h)
137 because while they use the "cleanup API" they are not part of the
140 /* Helper function for make_cleanup_ui_out_redirect_pop. */
143 do_ui_out_redirect_pop (void *arg
)
145 struct ui_out
*uiout
= (struct ui_out
*) arg
;
147 uiout
->redirect (NULL
);
150 /* Return a new cleanup that pops the last redirection by ui_out_redirect
151 with NULL parameter. */
154 make_cleanup_ui_out_redirect_pop (struct ui_out
*uiout
)
156 return make_cleanup (do_ui_out_redirect_pop
, uiout
);
160 do_free_section_addr_info (void *arg
)
162 free_section_addr_info ((struct section_addr_info
*) arg
);
166 make_cleanup_free_section_addr_info (struct section_addr_info
*addrs
)
168 return make_cleanup (do_free_section_addr_info
, addrs
);
171 struct restore_integer_closure
178 restore_integer (void *p
)
180 struct restore_integer_closure
*closure
181 = (struct restore_integer_closure
*) p
;
183 *(closure
->variable
) = closure
->value
;
186 /* Remember the current value of *VARIABLE and make it restored when
187 the cleanup is run. */
190 make_cleanup_restore_integer (int *variable
)
192 struct restore_integer_closure
*c
= XNEW (struct restore_integer_closure
);
194 c
->variable
= variable
;
195 c
->value
= *variable
;
197 return make_cleanup_dtor (restore_integer
, (void *) c
, xfree
);
200 /* Remember the current value of *VARIABLE and make it restored when
201 the cleanup is run. */
204 make_cleanup_restore_uinteger (unsigned int *variable
)
206 return make_cleanup_restore_integer ((int *) variable
);
209 /* Helper for make_cleanup_unpush_target. */
212 do_unpush_target (void *arg
)
214 struct target_ops
*ops
= (struct target_ops
*) arg
;
219 /* Return a new cleanup that unpushes OPS. */
222 make_cleanup_unpush_target (struct target_ops
*ops
)
224 return make_cleanup (do_unpush_target
, ops
);
227 /* Helper for make_cleanup_value_free_to_mark. */
230 do_value_free_to_mark (void *value
)
232 value_free_to_mark ((struct value
*) value
);
235 /* Free all values allocated since MARK was obtained by value_mark
236 (except for those released) when the cleanup is run. */
239 make_cleanup_value_free_to_mark (struct value
*mark
)
241 return make_cleanup (do_value_free_to_mark
, mark
);
244 /* Helper for make_cleanup_value_free. */
247 do_value_free (void *value
)
249 value_free ((struct value
*) value
);
255 make_cleanup_value_free (struct value
*value
)
257 return make_cleanup (do_value_free
, value
);
260 /* Helper function for make_cleanup_clear_parser_state. */
263 do_clear_parser_state (void *ptr
)
265 struct parser_state
**p
= (struct parser_state
**) ptr
;
270 /* Clean (i.e., set to NULL) the parser state variable P. */
273 make_cleanup_clear_parser_state (struct parser_state
**p
)
275 return make_cleanup (do_clear_parser_state
, (void *) p
);
278 /* This function is useful for cleanups.
282 old_chain = make_cleanup (free_current_contents, &foo);
284 to arrange to free the object thus allocated. */
287 free_current_contents (void *ptr
)
289 void **location
= (void **) ptr
;
291 if (location
== NULL
)
292 internal_error (__FILE__
, __LINE__
,
293 _("free_current_contents: NULL pointer"));
294 if (*location
!= NULL
)
303 /* Print a warning message. The first argument STRING is the warning
304 message, used as an fprintf format string, the second is the
305 va_list of arguments for that string. A warning is unfiltered (not
306 paginated) so that the user does not need to page through each
307 screen full of warnings when there are lots of them. */
310 vwarning (const char *string
, va_list args
)
312 if (deprecated_warning_hook
)
313 (*deprecated_warning_hook
) (string
, args
);
316 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
318 if (target_supports_terminal_ours ())
320 make_cleanup_restore_target_terminal ();
321 target_terminal_ours_for_output ();
323 if (filtered_printing_initialized ())
324 wrap_here (""); /* Force out any buffered output. */
325 gdb_flush (gdb_stdout
);
326 if (warning_pre_print
)
327 fputs_unfiltered (warning_pre_print
, gdb_stderr
);
328 vfprintf_unfiltered (gdb_stderr
, string
, args
);
329 fprintf_unfiltered (gdb_stderr
, "\n");
331 do_cleanups (old_chain
);
335 /* Print an error message and return to command level.
336 The first argument STRING is the error message, used as a fprintf string,
337 and the remaining args are passed as arguments to it. */
340 verror (const char *string
, va_list args
)
342 throw_verror (GENERIC_ERROR
, string
, args
);
346 error_stream (const string_file
&stream
)
348 error (("%s"), stream
.c_str ());
351 /* Emit a message and abort. */
353 static void ATTRIBUTE_NORETURN
354 abort_with_message (const char *msg
)
356 if (gdb_stderr
== NULL
)
359 fputs_unfiltered (msg
, gdb_stderr
);
361 abort (); /* NOTE: GDB has only three calls to abort(). */
364 /* Dump core trying to increase the core soft limit to hard limit first. */
369 #ifdef HAVE_SETRLIMIT
370 struct rlimit rlim
= { RLIM_INFINITY
, RLIM_INFINITY
};
372 setrlimit (RLIMIT_CORE
, &rlim
);
373 #endif /* HAVE_SETRLIMIT */
375 abort (); /* NOTE: GDB has only three calls to abort(). */
378 /* Check whether GDB will be able to dump core using the dump_core
379 function. Returns zero if GDB cannot or should not dump core.
380 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
381 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
384 can_dump_core (enum resource_limit_kind limit_kind
)
386 #ifdef HAVE_GETRLIMIT
389 /* Be quiet and assume we can dump if an error is returned. */
390 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
396 if (rlim
.rlim_cur
== 0)
400 if (rlim
.rlim_max
== 0)
403 #endif /* HAVE_GETRLIMIT */
408 /* Print a warning that we cannot dump core. */
411 warn_cant_dump_core (const char *reason
)
413 fprintf_unfiltered (gdb_stderr
,
414 _("%s\nUnable to dump core, use `ulimit -c"
415 " unlimited' before executing GDB next time.\n"),
419 /* Check whether GDB will be able to dump core using the dump_core
420 function, and print a warning if we cannot. */
423 can_dump_core_warn (enum resource_limit_kind limit_kind
,
426 int core_dump_allowed
= can_dump_core (limit_kind
);
428 if (!core_dump_allowed
)
429 warn_cant_dump_core (reason
);
431 return core_dump_allowed
;
434 /* Allow the user to configure the debugger behavior with respect to
435 what to do when an internal problem is detected. */
437 const char internal_problem_ask
[] = "ask";
438 const char internal_problem_yes
[] = "yes";
439 const char internal_problem_no
[] = "no";
440 static const char *const internal_problem_modes
[] =
442 internal_problem_ask
,
443 internal_problem_yes
,
448 /* Print a message reporting an internal error/warning. Ask the user
449 if they want to continue, dump core, or just exit. Return
450 something to indicate a quit. */
452 struct internal_problem
455 int user_settable_should_quit
;
456 const char *should_quit
;
457 int user_settable_should_dump_core
;
458 const char *should_dump_core
;
461 /* Report a problem, internal to GDB, to the user. Once the problem
462 has been reported, and assuming GDB didn't quit, the caller can
463 either allow execution to resume or throw an error. */
465 static void ATTRIBUTE_PRINTF (4, 0)
466 internal_vproblem (struct internal_problem
*problem
,
467 const char *file
, int line
, const char *fmt
, va_list ap
)
473 struct cleanup
*cleanup
= make_cleanup (null_cleanup
, NULL
);
475 /* Don't allow infinite error/warning recursion. */
477 static char msg
[] = "Recursive internal problem.\n";
486 abort_with_message (msg
);
489 /* Newer GLIBC versions put the warn_unused_result attribute
490 on write, but this is one of those rare cases where
491 ignoring the return value is correct. Casting to (void)
492 does not fix this problem. This is the solution suggested
493 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
494 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
495 abort (); /* NOTE: GDB has only three calls to abort(). */
500 /* Create a string containing the full error/warning message. Need
501 to call query with this full string, as otherwize the reason
502 (error/warning) and question become separated. Format using a
503 style similar to a compiler error message. Include extra detail
504 so that the user knows that they are living on the edge. */
508 msg
= xstrvprintf (fmt
, ap
);
509 reason
= xstrprintf ("%s:%d: %s: %s\n"
510 "A problem internal to GDB has been detected,\n"
511 "further debugging may prove unreliable.",
512 file
, line
, problem
->name
, msg
);
514 make_cleanup (xfree
, reason
);
517 /* Fall back to abort_with_message if gdb_stderr is not set up. */
518 if (gdb_stderr
== NULL
)
520 fputs (reason
, stderr
);
521 abort_with_message ("\n");
524 /* Try to get the message out and at the start of a new line. */
525 if (target_supports_terminal_ours ())
527 make_cleanup_restore_target_terminal ();
528 target_terminal_ours_for_output ();
530 if (filtered_printing_initialized ())
533 /* Emit the message unless query will emit it below. */
534 if (problem
->should_quit
!= internal_problem_ask
536 || !filtered_printing_initialized ())
537 fprintf_unfiltered (gdb_stderr
, "%s\n", reason
);
539 if (problem
->should_quit
== internal_problem_ask
)
541 /* Default (yes/batch case) is to quit GDB. When in batch mode
542 this lessens the likelihood of GDB going into an infinite
544 if (!confirm
|| !filtered_printing_initialized ())
547 quit_p
= query (_("%s\nQuit this debugging session? "), reason
);
549 else if (problem
->should_quit
== internal_problem_yes
)
551 else if (problem
->should_quit
== internal_problem_no
)
554 internal_error (__FILE__
, __LINE__
, _("bad switch"));
556 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr
);
557 if (REPORT_BUGS_TO
[0])
558 fprintf_unfiltered (gdb_stderr
, _(" For instructions, see:\n%s."),
560 fputs_unfiltered ("\n\n", gdb_stderr
);
562 if (problem
->should_dump_core
== internal_problem_ask
)
564 if (!can_dump_core_warn (LIMIT_MAX
, reason
))
566 else if (!filtered_printing_initialized ())
570 /* Default (yes/batch case) is to dump core. This leaves a GDB
571 `dropping' so that it is easier to see that something went
573 dump_core_p
= query (_("%s\nCreate a core file of GDB? "), reason
);
576 else if (problem
->should_dump_core
== internal_problem_yes
)
577 dump_core_p
= can_dump_core_warn (LIMIT_MAX
, reason
);
578 else if (problem
->should_dump_core
== internal_problem_no
)
581 internal_error (__FILE__
, __LINE__
, _("bad switch"));
594 #ifdef HAVE_WORKING_FORK
602 do_cleanups (cleanup
);
605 static struct internal_problem internal_error_problem
= {
606 "internal-error", 1, internal_problem_ask
, 1, internal_problem_ask
610 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
612 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
613 throw_quit (_("Command aborted."));
616 static struct internal_problem internal_warning_problem
= {
617 "internal-warning", 1, internal_problem_ask
, 1, internal_problem_ask
621 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
623 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
626 static struct internal_problem demangler_warning_problem
= {
627 "demangler-warning", 1, internal_problem_ask
, 0, internal_problem_no
631 demangler_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
633 internal_vproblem (&demangler_warning_problem
, file
, line
, fmt
, ap
);
637 demangler_warning (const char *file
, int line
, const char *string
, ...)
641 va_start (ap
, string
);
642 demangler_vwarning (file
, line
, string
, ap
);
646 /* Dummy functions to keep add_prefix_cmd happy. */
649 set_internal_problem_cmd (char *args
, int from_tty
)
654 show_internal_problem_cmd (char *args
, int from_tty
)
658 /* When GDB reports an internal problem (error or warning) it gives
659 the user the opportunity to quit GDB and/or create a core file of
660 the current debug session. This function registers a few commands
661 that make it possible to specify that GDB should always or never
662 quit or create a core file, without asking. The commands look
665 maint set PROBLEM-NAME quit ask|yes|no
666 maint show PROBLEM-NAME quit
667 maint set PROBLEM-NAME corefile ask|yes|no
668 maint show PROBLEM-NAME corefile
670 Where PROBLEM-NAME is currently "internal-error" or
671 "internal-warning". */
674 add_internal_problem_command (struct internal_problem
*problem
)
676 struct cmd_list_element
**set_cmd_list
;
677 struct cmd_list_element
**show_cmd_list
;
681 set_cmd_list
= XNEW (struct cmd_list_element
*);
682 show_cmd_list
= XNEW (struct cmd_list_element
*);
683 *set_cmd_list
= NULL
;
684 *show_cmd_list
= NULL
;
686 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
689 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
692 add_prefix_cmd ((char*) problem
->name
,
693 class_maintenance
, set_internal_problem_cmd
, set_doc
,
695 concat ("maintenance set ", problem
->name
, " ",
697 0/*allow-unknown*/, &maintenance_set_cmdlist
);
699 add_prefix_cmd ((char*) problem
->name
,
700 class_maintenance
, show_internal_problem_cmd
, show_doc
,
702 concat ("maintenance show ", problem
->name
, " ",
704 0/*allow-unknown*/, &maintenance_show_cmdlist
);
706 if (problem
->user_settable_should_quit
)
708 set_doc
= xstrprintf (_("Set whether GDB should quit "
709 "when an %s is detected"),
711 show_doc
= xstrprintf (_("Show whether GDB will quit "
712 "when an %s is detected"),
714 add_setshow_enum_cmd ("quit", class_maintenance
,
715 internal_problem_modes
,
716 &problem
->should_quit
,
729 if (problem
->user_settable_should_dump_core
)
731 set_doc
= xstrprintf (_("Set whether GDB should create a core "
732 "file of GDB when %s is detected"),
734 show_doc
= xstrprintf (_("Show whether GDB will create a core "
735 "file of GDB when %s is detected"),
737 add_setshow_enum_cmd ("corefile", class_maintenance
,
738 internal_problem_modes
,
739 &problem
->should_dump_core
,
753 /* Return a newly allocated string, containing the PREFIX followed
754 by the system error message for errno (separated by a colon). */
757 perror_string (const char *prefix
)
761 err
= safe_strerror (errno
);
762 return std::string (prefix
) + ": " + err
;
765 /* Print the system error message for errno, and also mention STRING
766 as the file name for which the error was encountered. Use ERRCODE
767 for the thrown exception. Then return to command level. */
770 throw_perror_with_name (enum errors errcode
, const char *string
)
772 std::string combined
= perror_string (string
);
774 /* I understand setting these is a matter of taste. Still, some people
775 may clear errno but not know about bfd_error. Doing this here is not
777 bfd_set_error (bfd_error_no_error
);
780 throw_error (errcode
, _("%s."), combined
.c_str ());
783 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
786 perror_with_name (const char *string
)
788 throw_perror_with_name (GENERIC_ERROR
, string
);
791 /* Same as perror_with_name except that it prints a warning instead
792 of throwing an error. */
795 perror_warning_with_name (const char *string
)
797 std::string combined
= perror_string (string
);
798 warning (_("%s"), combined
.c_str ());
801 /* Print the system error message for ERRCODE, and also mention STRING
802 as the file name for which the error was encountered. */
805 print_sys_errmsg (const char *string
, int errcode
)
810 err
= safe_strerror (errcode
);
811 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
812 strcpy (combined
, string
);
813 strcat (combined
, ": ");
814 strcat (combined
, err
);
816 /* We want anything which was printed on stdout to come out first, before
818 gdb_flush (gdb_stdout
);
819 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
822 /* Control C eventually causes this to be called, at a convenient time. */
827 struct ui
*ui
= current_ui
;
829 if (sync_quit_force_run
)
831 sync_quit_force_run
= 0;
832 quit_force (NULL
, 0);
836 /* No steenking SIGINT will ever be coming our way when the
837 program is resumed. Don't lie. */
841 /* If there is no terminal switching for this target, then we can't
842 possibly get screwed by the lack of job control. */
843 || !target_supports_terminal_ours ())
846 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
855 if (sync_quit_force_run
)
860 if (deprecated_interactive_hook
)
861 deprecated_interactive_hook ();
865 /* Called when a memory allocation fails, with the number of bytes of
866 memory requested in SIZE. */
869 malloc_failure (long size
)
873 internal_error (__FILE__
, __LINE__
,
874 _("virtual memory exhausted: can't allocate %ld bytes."),
879 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
883 /* My replacement for the read system call.
884 Used like `read' but keeps going if `read' returns too soon. */
887 myread (int desc
, char *addr
, int len
)
894 val
= read (desc
, addr
, len
);
906 print_spaces (int n
, struct ui_file
*file
)
908 fputs_unfiltered (n_spaces (n
), file
);
911 /* Print a host address. */
914 gdb_print_host_address_1 (const void *addr
, struct ui_file
*stream
)
916 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
922 make_hex_string (const gdb_byte
*data
, size_t length
)
924 char *result
= (char *) xmalloc (length
* 2 + 1);
929 for (i
= 0; i
< length
; ++i
)
930 p
+= xsnprintf (p
, 3, "%02x", data
[i
]);
937 /* A cleanup that simply calls ui_unregister_input_event_handler. */
940 ui_unregister_input_event_handler_cleanup (void *ui
)
942 ui_unregister_input_event_handler ((struct ui
*) ui
);
945 /* Set up to handle input. */
947 static struct cleanup
*
948 prepare_to_handle_input (void)
950 struct cleanup
*old_chain
;
952 old_chain
= make_cleanup_restore_target_terminal ();
953 target_terminal_ours ();
955 ui_register_input_event_handler (current_ui
);
956 if (current_ui
->prompt_state
== PROMPT_BLOCKED
)
957 make_cleanup (ui_unregister_input_event_handler_cleanup
, current_ui
);
959 make_cleanup_override_quit_handler (default_quit_handler
);
966 /* This function supports the query, nquery, and yquery functions.
967 Ask user a y-or-n question and return 0 if answer is no, 1 if
968 answer is yes, or default the answer to the specified default
969 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
970 default answer, or '\0' for no default.
971 CTLSTR is the control string and should end in "? ". It should
972 not say how to answer, because we do that.
973 ARGS are the arguments passed along with the CTLSTR argument to
976 static int ATTRIBUTE_PRINTF (1, 0)
977 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
982 char def_answer
, not_def_answer
;
983 const char *y_string
, *n_string
;
984 char *question
, *prompt
;
985 struct cleanup
*old_chain
;
987 /* Set up according to which answer is the default. */
992 not_def_answer
= 'N';
996 else if (defchar
== 'y')
1000 not_def_answer
= 'N';
1008 not_def_answer
= 'Y';
1013 /* Automatically answer the default value if the user did not want
1014 prompts or the command was issued with the server prefix. */
1015 if (!confirm
|| server_command
)
1018 /* If input isn't coming from the user directly, just say what
1019 question we're asking, and then answer the default automatically. This
1020 way, important error messages don't get lost when talking to GDB
1022 if (current_ui
->instream
!= current_ui
->stdin_stream
1023 || !input_interactive_p (current_ui
)
1024 /* Restrict queries to the main UI. */
1025 || current_ui
!= main_ui
)
1027 old_chain
= make_cleanup_restore_target_terminal ();
1029 target_terminal_ours_for_output ();
1031 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
1033 printf_filtered (_("(%s or %s) [answered %c; "
1034 "input not from terminal]\n"),
1035 y_string
, n_string
, def_answer
);
1036 gdb_flush (gdb_stdout
);
1038 do_cleanups (old_chain
);
1042 if (deprecated_query_hook
)
1046 old_chain
= make_cleanup_restore_target_terminal ();
1047 res
= deprecated_query_hook (ctlstr
, args
);
1048 do_cleanups (old_chain
);
1052 /* Format the question outside of the loop, to avoid reusing args. */
1053 question
= xstrvprintf (ctlstr
, args
);
1054 old_chain
= make_cleanup (xfree
, question
);
1055 prompt
= xstrprintf (_("%s%s(%s or %s) %s"),
1056 annotation_level
> 1 ? "\n\032\032pre-query\n" : "",
1057 question
, y_string
, n_string
,
1058 annotation_level
> 1 ? "\n\032\032query\n" : "");
1059 make_cleanup (xfree
, prompt
);
1061 /* Used to add duration we waited for user to respond to
1062 prompt_for_continue_wait_time. */
1063 using namespace std::chrono
;
1064 steady_clock::time_point prompt_started
= steady_clock::now ();
1066 prepare_to_handle_input ();
1070 char *response
, answer
;
1072 gdb_flush (gdb_stdout
);
1073 response
= gdb_readline_wrapper (prompt
);
1075 if (response
== NULL
) /* C-d */
1077 printf_filtered ("EOF [assumed %c]\n", def_answer
);
1082 answer
= response
[0];
1087 /* Check answer. For the non-default, the user must specify
1088 the non-default explicitly. */
1089 if (answer
== not_def_answer
)
1091 retval
= !def_value
;
1094 /* Otherwise, if a default was specified, the user may either
1095 specify the required input or have it default by entering
1097 if (answer
== def_answer
1098 || (defchar
!= '\0' && answer
== '\0'))
1103 /* Invalid entries are not defaulted and require another selection. */
1104 printf_filtered (_("Please answer %s or %s.\n"),
1105 y_string
, n_string
);
1108 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1109 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1111 if (annotation_level
> 1)
1112 printf_filtered (("\n\032\032post-query\n"));
1113 do_cleanups (old_chain
);
1118 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1119 answer is yes, or 0 if answer is defaulted.
1120 Takes three args which are given to printf to print the question.
1121 The first, a control string, should end in "? ".
1122 It should not say how to answer, because we do that. */
1125 nquery (const char *ctlstr
, ...)
1130 va_start (args
, ctlstr
);
1131 ret
= defaulted_query (ctlstr
, 'n', args
);
1136 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1137 answer is yes, or 1 if answer is defaulted.
1138 Takes three args which are given to printf to print the question.
1139 The first, a control string, should end in "? ".
1140 It should not say how to answer, because we do that. */
1143 yquery (const char *ctlstr
, ...)
1148 va_start (args
, ctlstr
);
1149 ret
= defaulted_query (ctlstr
, 'y', args
);
1154 /* Ask user a y-or-n question and return 1 iff answer is yes.
1155 Takes three args which are given to printf to print the question.
1156 The first, a control string, should end in "? ".
1157 It should not say how to answer, because we do that. */
1160 query (const char *ctlstr
, ...)
1165 va_start (args
, ctlstr
);
1166 ret
= defaulted_query (ctlstr
, '\0', args
);
1171 /* A helper for parse_escape that converts a host character to a
1172 target character. C is the host character. If conversion is
1173 possible, then the target character is stored in *TARGET_C and the
1174 function returns 1. Otherwise, the function returns 0. */
1177 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1182 auto_obstack host_data
;
1184 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1185 (gdb_byte
*) &the_char
, 1, 1,
1186 &host_data
, translit_none
);
1188 if (obstack_object_size (&host_data
) == 1)
1191 *target_c
= *(char *) obstack_base (&host_data
);
1197 /* Parse a C escape sequence. STRING_PTR points to a variable
1198 containing a pointer to the string to parse. That pointer
1199 should point to the character after the \. That pointer
1200 is updated past the characters we use. The value of the
1201 escape sequence is returned.
1203 A negative value means the sequence \ newline was seen,
1204 which is supposed to be equivalent to nothing at all.
1206 If \ is followed by a null character, we return a negative
1207 value and leave the string pointer pointing at the null character.
1209 If \ is followed by 000, we return 0 and leave the string pointer
1210 after the zeros. A value of 0 does not mean end of string. */
1213 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1215 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1216 int c
= *(*string_ptr
)++;
1235 int i
= host_hex_value (c
);
1240 if (isdigit (c
) && c
!= '8' && c
!= '9')
1244 i
+= host_hex_value (c
);
1280 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1281 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1282 " which has no equivalent\nin the `%s' character set."),
1283 c
, c
, target_charset (gdbarch
));
1287 /* Print the character C on STREAM as part of the contents of a literal
1288 string whose delimiter is QUOTER. Note that this routine should only
1289 be called for printing things which are independent of the language
1290 of the program being debugged.
1292 printchar will normally escape backslashes and instances of QUOTER. If
1293 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1294 As a side effect, if you pass the backslash character as the QUOTER,
1295 printchar will escape backslashes as usual, but not any other quoting
1299 printchar (int c
, void (*do_fputs
) (const char *, struct ui_file
*),
1300 void (*do_fprintf
) (struct ui_file
*, const char *, ...)
1301 ATTRIBUTE_FPTR_PRINTF_2
, struct ui_file
*stream
, int quoter
)
1303 c
&= 0xFF; /* Avoid sign bit follies */
1305 if (c
< 0x20 || /* Low control chars */
1306 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1307 (sevenbit_strings
&& c
>= 0x80))
1308 { /* high order bit set */
1312 do_fputs ("\\n", stream
);
1315 do_fputs ("\\b", stream
);
1318 do_fputs ("\\t", stream
);
1321 do_fputs ("\\f", stream
);
1324 do_fputs ("\\r", stream
);
1327 do_fputs ("\\e", stream
);
1330 do_fputs ("\\a", stream
);
1333 do_fprintf (stream
, "\\%.3o", (unsigned int) c
);
1339 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1340 do_fputs ("\\", stream
);
1341 do_fprintf (stream
, "%c", c
);
1345 /* Print the character C on STREAM as part of the contents of a
1346 literal string whose delimiter is QUOTER. Note that these routines
1347 should only be call for printing things which are independent of
1348 the language of the program being debugged. */
1351 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1354 printchar (*str
++, fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1358 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1361 printchar (*str
++, fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1365 fputstrn_filtered (const char *str
, int n
, int quoter
,
1366 struct ui_file
*stream
)
1370 for (i
= 0; i
< n
; i
++)
1371 printchar (str
[i
], fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1375 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1376 struct ui_file
*stream
)
1380 for (i
= 0; i
< n
; i
++)
1381 printchar (str
[i
], fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1385 /* Number of lines per page or UINT_MAX if paging is disabled. */
1386 static unsigned int lines_per_page
;
1388 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1389 struct cmd_list_element
*c
, const char *value
)
1391 fprintf_filtered (file
,
1392 _("Number of lines gdb thinks are in a page is %s.\n"),
1396 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1397 static unsigned int chars_per_line
;
1399 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1400 struct cmd_list_element
*c
, const char *value
)
1402 fprintf_filtered (file
,
1403 _("Number of characters gdb thinks "
1404 "are in a line is %s.\n"),
1408 /* Current count of lines printed on this page, chars on this line. */
1409 static unsigned int lines_printed
, chars_printed
;
1411 /* Buffer and start column of buffered text, for doing smarter word-
1412 wrapping. When someone calls wrap_here(), we start buffering output
1413 that comes through fputs_filtered(). If we see a newline, we just
1414 spit it out and forget about the wrap_here(). If we see another
1415 wrap_here(), we spit it out and remember the newer one. If we see
1416 the end of the line, we spit out a newline, the indent, and then
1417 the buffered output. */
1419 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1420 are waiting to be output (they have already been counted in chars_printed).
1421 When wrap_buffer[0] is null, the buffer is empty. */
1422 static char *wrap_buffer
;
1424 /* Pointer in wrap_buffer to the next character to fill. */
1425 static char *wrap_pointer
;
1427 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1429 static const char *wrap_indent
;
1431 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1432 is not in effect. */
1433 static int wrap_column
;
1436 /* Initialize the number of lines per page and chars per line. */
1439 init_page_info (void)
1443 lines_per_page
= UINT_MAX
;
1444 chars_per_line
= UINT_MAX
;
1448 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1453 #if defined(__GO32__)
1454 rows
= ScreenRows ();
1455 cols
= ScreenCols ();
1456 lines_per_page
= rows
;
1457 chars_per_line
= cols
;
1459 /* Make sure Readline has initialized its terminal settings. */
1460 rl_reset_terminal (NULL
);
1462 /* Get the screen size from Readline. */
1463 rl_get_screen_size (&rows
, &cols
);
1464 lines_per_page
= rows
;
1465 chars_per_line
= cols
;
1467 /* Readline should have fetched the termcap entry for us.
1468 Only try to use tgetnum function if rl_get_screen_size
1469 did not return a useful value. */
1470 if (((rows
<= 0) && (tgetnum ((char *) "li") < 0))
1471 /* Also disable paging if inside Emacs. $EMACS was used
1472 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1473 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1475 /* The number of lines per page is not mentioned in the terminal
1476 description or EMACS evironment variable is set. This probably
1477 means that paging is not useful, so disable paging. */
1478 lines_per_page
= UINT_MAX
;
1481 /* If the output is not a terminal, don't paginate it. */
1482 if (!ui_file_isatty (gdb_stdout
))
1483 lines_per_page
= UINT_MAX
;
1487 /* We handle SIGWINCH ourselves. */
1488 rl_catch_sigwinch
= 0;
1494 /* Return nonzero if filtered printing is initialized. */
1496 filtered_printing_initialized (void)
1498 return wrap_buffer
!= NULL
;
1501 /* Helper for make_cleanup_restore_page_info. */
1504 do_restore_page_info_cleanup (void *arg
)
1510 /* Provide cleanup for restoring the terminal size. */
1513 make_cleanup_restore_page_info (void)
1515 struct cleanup
*back_to
;
1517 back_to
= make_cleanup (do_restore_page_info_cleanup
, NULL
);
1518 make_cleanup_restore_uinteger (&lines_per_page
);
1519 make_cleanup_restore_uinteger (&chars_per_line
);
1524 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1525 Provide cleanup for restoring the original state. */
1528 set_batch_flag_and_make_cleanup_restore_page_info (void)
1530 struct cleanup
*back_to
= make_cleanup_restore_page_info ();
1532 make_cleanup_restore_integer (&batch_flag
);
1539 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1542 set_screen_size (void)
1544 int rows
= lines_per_page
;
1545 int cols
= chars_per_line
;
1553 /* Update Readline's idea of the terminal size. */
1554 rl_set_screen_size (rows
, cols
);
1557 /* Reinitialize WRAP_BUFFER according to the current value of
1563 if (chars_per_line
== 0)
1568 wrap_buffer
= (char *) xmalloc (chars_per_line
+ 2);
1569 wrap_buffer
[0] = '\0';
1572 wrap_buffer
= (char *) xrealloc (wrap_buffer
, chars_per_line
+ 2);
1573 wrap_pointer
= wrap_buffer
; /* Start it at the beginning. */
1577 set_width_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1584 set_height_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1592 set_screen_width_and_height (int width
, int height
)
1594 lines_per_page
= height
;
1595 chars_per_line
= width
;
1601 /* Wait, so the user can read what's on the screen. Prompt the user
1602 to continue by pressing RETURN. 'q' is also provided because
1603 telling users what to do in the prompt is more user-friendly than
1604 expecting them to think of Ctrl-C/SIGINT. */
1607 prompt_for_continue (void)
1610 char cont_prompt
[120];
1611 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
1612 /* Used to add duration we waited for user to respond to
1613 prompt_for_continue_wait_time. */
1614 using namespace std::chrono
;
1615 steady_clock::time_point prompt_started
= steady_clock::now ();
1617 if (annotation_level
> 1)
1618 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1620 strcpy (cont_prompt
,
1621 "---Type <return> to continue, or q <return> to quit---");
1622 if (annotation_level
> 1)
1623 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1625 /* We must do this *before* we call gdb_readline_wrapper, else it
1626 will eventually call us -- thinking that we're trying to print
1627 beyond the end of the screen. */
1628 reinitialize_more_filter ();
1630 prepare_to_handle_input ();
1632 /* Call gdb_readline_wrapper, not readline, in order to keep an
1633 event loop running. */
1634 ignore
= gdb_readline_wrapper (cont_prompt
);
1635 make_cleanup (xfree
, ignore
);
1637 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1638 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1640 if (annotation_level
> 1)
1641 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1647 while (*p
== ' ' || *p
== '\t')
1650 /* Do not call quit here; there is no possibility of SIGINT. */
1651 throw_quit ("Quit");
1654 /* Now we have to do this again, so that GDB will know that it doesn't
1655 need to save the ---Type <return>--- line at the top of the screen. */
1656 reinitialize_more_filter ();
1658 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1660 do_cleanups (old_chain
);
1663 /* Initialize timer to keep track of how long we waited for the user. */
1666 reset_prompt_for_continue_wait_time (void)
1668 using namespace std::chrono
;
1670 prompt_for_continue_wait_time
= steady_clock::duration::zero ();
1673 /* Fetch the cumulative time spent in prompt_for_continue. */
1675 std::chrono::steady_clock::duration
1676 get_prompt_for_continue_wait_time ()
1678 return prompt_for_continue_wait_time
;
1681 /* Reinitialize filter; ie. tell it to reset to original values. */
1684 reinitialize_more_filter (void)
1690 /* Indicate that if the next sequence of characters overflows the line,
1691 a newline should be inserted here rather than when it hits the end.
1692 If INDENT is non-null, it is a string to be printed to indent the
1693 wrapped part on the next line. INDENT must remain accessible until
1694 the next call to wrap_here() or until a newline is printed through
1697 If the line is already overfull, we immediately print a newline and
1698 the indentation, and disable further wrapping.
1700 If we don't know the width of lines, but we know the page height,
1701 we must not wrap words, but should still keep track of newlines
1702 that were explicitly printed.
1704 INDENT should not contain tabs, as that will mess up the char count
1705 on the next line. FIXME.
1707 This routine is guaranteed to force out any output which has been
1708 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1709 used to force out output from the wrap_buffer. */
1712 wrap_here (const char *indent
)
1714 /* This should have been allocated, but be paranoid anyway. */
1716 internal_error (__FILE__
, __LINE__
,
1717 _("failed internal consistency check"));
1721 *wrap_pointer
= '\0';
1722 fputs_unfiltered (wrap_buffer
, gdb_stdout
);
1724 wrap_pointer
= wrap_buffer
;
1725 wrap_buffer
[0] = '\0';
1726 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1730 else if (chars_printed
>= chars_per_line
)
1732 puts_filtered ("\n");
1734 puts_filtered (indent
);
1739 wrap_column
= chars_printed
;
1743 wrap_indent
= indent
;
1747 /* Print input string to gdb_stdout, filtered, with wrap,
1748 arranging strings in columns of n chars. String can be
1749 right or left justified in the column. Never prints
1750 trailing spaces. String should never be longer than
1751 width. FIXME: this could be useful for the EXAMINE
1752 command, which currently doesn't tabulate very well. */
1755 puts_filtered_tabular (char *string
, int width
, int right
)
1761 gdb_assert (chars_per_line
> 0);
1762 if (chars_per_line
== UINT_MAX
)
1764 fputs_filtered (string
, gdb_stdout
);
1765 fputs_filtered ("\n", gdb_stdout
);
1769 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1770 fputs_filtered ("\n", gdb_stdout
);
1772 if (width
>= chars_per_line
)
1773 width
= chars_per_line
- 1;
1775 stringlen
= strlen (string
);
1777 if (chars_printed
> 0)
1778 spaces
= width
- (chars_printed
- 1) % width
- 1;
1780 spaces
+= width
- stringlen
;
1782 spacebuf
= (char *) alloca (spaces
+ 1);
1783 spacebuf
[spaces
] = '\0';
1785 spacebuf
[spaces
] = ' ';
1787 fputs_filtered (spacebuf
, gdb_stdout
);
1788 fputs_filtered (string
, gdb_stdout
);
1792 /* Ensure that whatever gets printed next, using the filtered output
1793 commands, starts at the beginning of the line. I.e. if there is
1794 any pending output for the current line, flush it and start a new
1795 line. Otherwise do nothing. */
1800 if (chars_printed
> 0)
1802 puts_filtered ("\n");
1807 /* Like fputs but if FILTER is true, pause after every screenful.
1809 Regardless of FILTER can wrap at points other than the final
1810 character of a line.
1812 Unlike fputs, fputs_maybe_filtered does not return a value.
1813 It is OK for LINEBUFFER to be NULL, in which case just don't print
1816 Note that a longjmp to top level may occur in this routine (only if
1817 FILTER is true) (since prompt_for_continue may do so) so this
1818 routine should not be called when cleanups are not in place. */
1821 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1824 const char *lineptr
;
1826 if (linebuffer
== 0)
1829 /* Don't do any filtering if it is disabled. */
1830 if (stream
!= gdb_stdout
1831 || !pagination_enabled
1833 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
1834 || top_level_interpreter () == NULL
1835 || interp_ui_out (top_level_interpreter ())->is_mi_like_p ())
1837 fputs_unfiltered (linebuffer
, stream
);
1841 /* Go through and output each character. Show line extension
1842 when this is necessary; prompt user for new page when this is
1845 lineptr
= linebuffer
;
1848 /* Possible new page. */
1849 if (filter
&& (lines_printed
>= lines_per_page
- 1))
1850 prompt_for_continue ();
1852 while (*lineptr
&& *lineptr
!= '\n')
1854 /* Print a single line. */
1855 if (*lineptr
== '\t')
1858 *wrap_pointer
++ = '\t';
1860 fputc_unfiltered ('\t', stream
);
1861 /* Shifting right by 3 produces the number of tab stops
1862 we have already passed, and then adding one and
1863 shifting left 3 advances to the next tab stop. */
1864 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
1870 *wrap_pointer
++ = *lineptr
;
1872 fputc_unfiltered (*lineptr
, stream
);
1877 if (chars_printed
>= chars_per_line
)
1879 unsigned int save_chars
= chars_printed
;
1883 /* If we aren't actually wrapping, don't output newline --
1884 if chars_per_line is right, we probably just overflowed
1885 anyway; if it's wrong, let us keep going. */
1887 fputc_unfiltered ('\n', stream
);
1889 /* Possible new page. */
1890 if (lines_printed
>= lines_per_page
- 1)
1891 prompt_for_continue ();
1893 /* Now output indentation and wrapped string. */
1896 fputs_unfiltered (wrap_indent
, stream
);
1897 *wrap_pointer
= '\0'; /* Null-terminate saved stuff, */
1898 fputs_unfiltered (wrap_buffer
, stream
); /* and eject it. */
1899 /* FIXME, this strlen is what prevents wrap_indent from
1900 containing tabs. However, if we recurse to print it
1901 and count its chars, we risk trouble if wrap_indent is
1902 longer than (the user settable) chars_per_line.
1903 Note also that this can set chars_printed > chars_per_line
1904 if we are printing a long string. */
1905 chars_printed
= strlen (wrap_indent
)
1906 + (save_chars
- wrap_column
);
1907 wrap_pointer
= wrap_buffer
; /* Reset buffer */
1908 wrap_buffer
[0] = '\0';
1909 wrap_column
= 0; /* And disable fancy wrap */
1914 if (*lineptr
== '\n')
1917 wrap_here ((char *) 0); /* Spit out chars, cancel
1920 fputc_unfiltered ('\n', stream
);
1927 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
1929 fputs_maybe_filtered (linebuffer
, stream
, 1);
1933 putchar_unfiltered (int c
)
1937 ui_file_write (gdb_stdout
, &buf
, 1);
1941 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
1942 May return nonlocally. */
1945 putchar_filtered (int c
)
1947 return fputc_filtered (c
, gdb_stdout
);
1951 fputc_unfiltered (int c
, struct ui_file
*stream
)
1955 ui_file_write (stream
, &buf
, 1);
1960 fputc_filtered (int c
, struct ui_file
*stream
)
1966 fputs_filtered (buf
, stream
);
1970 /* puts_debug is like fputs_unfiltered, except it prints special
1971 characters in printable fashion. */
1974 puts_debug (char *prefix
, char *string
, char *suffix
)
1978 /* Print prefix and suffix after each line. */
1979 static int new_line
= 1;
1980 static int return_p
= 0;
1981 static const char *prev_prefix
= "";
1982 static const char *prev_suffix
= "";
1984 if (*string
== '\n')
1987 /* If the prefix is changing, print the previous suffix, a new line,
1988 and the new prefix. */
1989 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
1991 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
1992 fputs_unfiltered ("\n", gdb_stdlog
);
1993 fputs_unfiltered (prefix
, gdb_stdlog
);
1996 /* Print prefix if we printed a newline during the previous call. */
2000 fputs_unfiltered (prefix
, gdb_stdlog
);
2003 prev_prefix
= prefix
;
2004 prev_suffix
= suffix
;
2006 /* Output characters in a printable format. */
2007 while ((ch
= *string
++) != '\0')
2013 fputc_unfiltered (ch
, gdb_stdlog
);
2016 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2020 fputs_unfiltered ("\\\\", gdb_stdlog
);
2023 fputs_unfiltered ("\\b", gdb_stdlog
);
2026 fputs_unfiltered ("\\f", gdb_stdlog
);
2030 fputs_unfiltered ("\\n", gdb_stdlog
);
2033 fputs_unfiltered ("\\r", gdb_stdlog
);
2036 fputs_unfiltered ("\\t", gdb_stdlog
);
2039 fputs_unfiltered ("\\v", gdb_stdlog
);
2043 return_p
= ch
== '\r';
2046 /* Print suffix if we printed a newline. */
2049 fputs_unfiltered (suffix
, gdb_stdlog
);
2050 fputs_unfiltered ("\n", gdb_stdlog
);
2055 /* Print a variable number of ARGS using format FORMAT. If this
2056 information is going to put the amount written (since the last call
2057 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2058 call prompt_for_continue to get the users permision to continue.
2060 Unlike fprintf, this function does not return a value.
2062 We implement three variants, vfprintf (takes a vararg list and stream),
2063 fprintf (takes a stream to write on), and printf (the usual).
2065 Note also that a longjmp to top level may occur in this routine
2066 (since prompt_for_continue may do so) so this routine should not be
2067 called when cleanups are not in place. */
2070 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2071 va_list args
, int filter
)
2074 struct cleanup
*old_cleanups
;
2076 linebuffer
= xstrvprintf (format
, args
);
2077 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2078 fputs_maybe_filtered (linebuffer
, stream
, filter
);
2079 do_cleanups (old_cleanups
);
2084 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2086 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2090 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2093 struct cleanup
*old_cleanups
;
2095 linebuffer
= xstrvprintf (format
, args
);
2096 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2097 if (debug_timestamp
&& stream
== gdb_stdlog
)
2099 using namespace std::chrono
;
2102 steady_clock::time_point now
= steady_clock::now ();
2103 seconds s
= duration_cast
<seconds
> (now
.time_since_epoch ());
2104 microseconds us
= duration_cast
<microseconds
> (now
.time_since_epoch () - s
);
2106 len
= strlen (linebuffer
);
2107 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2109 std::string timestamp
= string_printf ("%ld.%06ld %s%s",
2112 linebuffer
, need_nl
? "\n": "");
2113 fputs_unfiltered (timestamp
.c_str (), stream
);
2116 fputs_unfiltered (linebuffer
, stream
);
2117 do_cleanups (old_cleanups
);
2121 vprintf_filtered (const char *format
, va_list args
)
2123 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2127 vprintf_unfiltered (const char *format
, va_list args
)
2129 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2133 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2137 va_start (args
, format
);
2138 vfprintf_filtered (stream
, format
, args
);
2143 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2147 va_start (args
, format
);
2148 vfprintf_unfiltered (stream
, format
, args
);
2152 /* Like fprintf_filtered, but prints its result indented.
2153 Called as fprintfi_filtered (spaces, stream, format, ...); */
2156 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2161 va_start (args
, format
);
2162 print_spaces_filtered (spaces
, stream
);
2164 vfprintf_filtered (stream
, format
, args
);
2170 printf_filtered (const char *format
, ...)
2174 va_start (args
, format
);
2175 vfprintf_filtered (gdb_stdout
, format
, args
);
2181 printf_unfiltered (const char *format
, ...)
2185 va_start (args
, format
);
2186 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2190 /* Like printf_filtered, but prints it's result indented.
2191 Called as printfi_filtered (spaces, format, ...); */
2194 printfi_filtered (int spaces
, const char *format
, ...)
2198 va_start (args
, format
);
2199 print_spaces_filtered (spaces
, gdb_stdout
);
2200 vfprintf_filtered (gdb_stdout
, format
, args
);
2204 /* Easy -- but watch out!
2206 This routine is *not* a replacement for puts()! puts() appends a newline.
2207 This one doesn't, and had better not! */
2210 puts_filtered (const char *string
)
2212 fputs_filtered (string
, gdb_stdout
);
2216 puts_unfiltered (const char *string
)
2218 fputs_unfiltered (string
, gdb_stdout
);
2221 /* Return a pointer to N spaces and a null. The pointer is good
2222 until the next call to here. */
2227 static char *spaces
= 0;
2228 static int max_spaces
= -1;
2234 spaces
= (char *) xmalloc (n
+ 1);
2235 for (t
= spaces
+ n
; t
!= spaces
;)
2241 return spaces
+ max_spaces
- n
;
2244 /* Print N spaces. */
2246 print_spaces_filtered (int n
, struct ui_file
*stream
)
2248 fputs_filtered (n_spaces (n
), stream
);
2251 /* C++/ObjC demangler stuff. */
2253 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2254 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2255 If the name is not mangled, or the language for the name is unknown, or
2256 demangling is off, the name is printed in its "raw" form. */
2259 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2260 enum language lang
, int arg_mode
)
2266 /* If user wants to see raw output, no problem. */
2269 fputs_filtered (name
, stream
);
2273 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2274 fputs_filtered (demangled
? demangled
: name
, stream
);
2275 if (demangled
!= NULL
)
2283 /* Modes of operation for strncmp_iw_with_mode. */
2285 enum class strncmp_iw_mode
2287 /* Work like strncmp, while ignoring whitespace. */
2290 /* Like NORMAL, but also apply the strcmp_iw hack. I.e.,
2291 string1=="FOO(PARAMS)" matches string2=="FOO". */
2295 /* Helper for strncmp_iw and strcmp_iw. */
2298 strncmp_iw_with_mode (const char *string1
, const char *string2
,
2299 size_t string2_len
, strncmp_iw_mode mode
)
2301 const char *end_str2
= string2
+ string2_len
;
2305 while (isspace (*string1
))
2307 while (string2
< end_str2
&& isspace (*string2
))
2309 if (*string1
== '\0' || string2
== end_str2
)
2311 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2313 if (case_sensitivity
== case_sensitive_off
2314 && (tolower ((unsigned char) *string1
)
2315 != tolower ((unsigned char) *string2
)))
2322 if (string2
== end_str2
)
2324 if (mode
== strncmp_iw_mode::NORMAL
)
2327 return (*string1
!= '\0' && *string1
!= '(');
2336 strncmp_iw (const char *string1
, const char *string2
, size_t string2_len
)
2338 return strncmp_iw_with_mode (string1
, string2
, string2_len
,
2339 strncmp_iw_mode::NORMAL
);
2345 strcmp_iw (const char *string1
, const char *string2
)
2347 return strncmp_iw_with_mode (string1
, string2
, strlen (string2
),
2348 strncmp_iw_mode::MATCH_PARAMS
);
2351 /* This is like strcmp except that it ignores whitespace and treats
2352 '(' as the first non-NULL character in terms of ordering. Like
2353 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2354 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2355 according to that ordering.
2357 If a list is sorted according to this function and if you want to
2358 find names in the list that match some fixed NAME according to
2359 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2360 where this function would put NAME.
2362 This function must be neutral to the CASE_SENSITIVITY setting as the user
2363 may choose it during later lookup. Therefore this function always sorts
2364 primarily case-insensitively and secondarily case-sensitively.
2366 Here are some examples of why using strcmp to sort is a bad idea:
2370 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2371 we try to do a search for "foo<char*>", strcmp will locate this
2372 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2373 will start looking at strings beginning with "goo", and will never
2374 see the correct match of "foo<char *>".
2376 Parenthesis example:
2378 In practice, this is less like to be an issue, but I'll give it a
2379 shot. Let's assume that '$' is a legitimate character to occur in
2380 symbols. (Which may well even be the case on some systems.) Then
2381 say that the partial symbol table contains "foo$" and "foo(int)".
2382 strcmp will put them in this order, since '$' < '('. Now, if the
2383 user searches for "foo", then strcmp will sort "foo" before "foo$".
2384 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2385 "foo") is false, so it won't proceed to the actual match of
2386 "foo(int)" with "foo". */
2389 strcmp_iw_ordered (const char *string1
, const char *string2
)
2391 const char *saved_string1
= string1
, *saved_string2
= string2
;
2392 enum case_sensitivity case_pass
= case_sensitive_off
;
2396 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2397 Provide stub characters if we are already at the end of one of the
2399 char c1
= 'X', c2
= 'X';
2401 while (*string1
!= '\0' && *string2
!= '\0')
2403 while (isspace (*string1
))
2405 while (isspace (*string2
))
2410 case case_sensitive_off
:
2411 c1
= tolower ((unsigned char) *string1
);
2412 c2
= tolower ((unsigned char) *string2
);
2414 case case_sensitive_on
:
2422 if (*string1
!= '\0')
2431 /* Characters are non-equal unless they're both '\0'; we want to
2432 make sure we get the comparison right according to our
2433 comparison in the cases where one of them is '\0' or '('. */
2435 if (*string2
== '\0')
2440 if (*string2
== '\0')
2445 if (*string2
== '\0' || *string2
== '(')
2454 if (case_pass
== case_sensitive_on
)
2457 /* Otherwise the strings were equal in case insensitive way, make
2458 a more fine grained comparison in a case sensitive way. */
2460 case_pass
= case_sensitive_on
;
2461 string1
= saved_string1
;
2462 string2
= saved_string2
;
2466 /* A simple comparison function with opposite semantics to strcmp. */
2469 streq (const char *lhs
, const char *rhs
)
2471 return !strcmp (lhs
, rhs
);
2477 ** Answer whether string_to_compare is a full or partial match to
2478 ** template_string. The partial match must be in sequence starting
2482 subset_compare (const char *string_to_compare
, const char *template_string
)
2486 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
2487 && strlen (string_to_compare
) <= strlen (template_string
))
2489 (startswith (template_string
, string_to_compare
));
2496 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2497 struct cmd_list_element
*c
, const char *value
)
2499 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2505 initialize_utils (void)
2507 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
2508 Set number of characters where GDB should wrap lines of its output."), _("\
2509 Show number of characters where GDB should wrap lines of its output."), _("\
2510 This affects where GDB wraps its output to fit the screen width.\n\
2511 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2513 show_chars_per_line
,
2514 &setlist
, &showlist
);
2516 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
2517 Set number of lines in a page for GDB output pagination."), _("\
2518 Show number of lines in a page for GDB output pagination."), _("\
2519 This affects the number of lines after which GDB will pause\n\
2520 its output and ask you whether to continue.\n\
2521 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2523 show_lines_per_page
,
2524 &setlist
, &showlist
);
2526 add_setshow_boolean_cmd ("pagination", class_support
,
2527 &pagination_enabled
, _("\
2528 Set state of GDB output pagination."), _("\
2529 Show state of GDB output pagination."), _("\
2530 When pagination is ON, GDB pauses at end of each screenful of\n\
2531 its output and asks you whether to continue.\n\
2532 Turning pagination off is an alternative to \"set height unlimited\"."),
2534 show_pagination_enabled
,
2535 &setlist
, &showlist
);
2537 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
2538 &sevenbit_strings
, _("\
2539 Set printing of 8-bit characters in strings as \\nnn."), _("\
2540 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
2542 show_sevenbit_strings
,
2543 &setprintlist
, &showprintlist
);
2545 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
2546 &debug_timestamp
, _("\
2547 Set timestamping of debugging messages."), _("\
2548 Show timestamping of debugging messages."), _("\
2549 When set, debugging messages will be marked with seconds and microseconds."),
2551 show_debug_timestamp
,
2552 &setdebuglist
, &showdebuglist
);
2556 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2558 /* Truncate address to the size of a target address, avoiding shifts
2559 larger or equal than the width of a CORE_ADDR. The local
2560 variable ADDR_BIT stops the compiler reporting a shift overflow
2561 when it won't occur. */
2562 /* NOTE: This assumes that the significant address information is
2563 kept in the least significant bits of ADDR - the upper bits were
2564 either zero or sign extended. Should gdbarch_address_to_pointer or
2565 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2567 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2569 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2570 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2571 return hex_string (addr
);
2574 /* This function is described in "defs.h". */
2577 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2579 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2581 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2582 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2584 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2585 that returns the language localized string formatted to a width
2586 based on gdbarch_addr_bit. */
2588 return hex_string_custom (address
, 8);
2590 return hex_string_custom (address
, 16);
2593 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2596 core_addr_hash (const void *ap
)
2598 const CORE_ADDR
*addrp
= (const CORE_ADDR
*) ap
;
2603 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2606 core_addr_eq (const void *ap
, const void *bp
)
2608 const CORE_ADDR
*addr_ap
= (const CORE_ADDR
*) ap
;
2609 const CORE_ADDR
*addr_bp
= (const CORE_ADDR
*) bp
;
2611 return *addr_ap
== *addr_bp
;
2614 /* Convert a string back into a CORE_ADDR. */
2616 string_to_core_addr (const char *my_string
)
2620 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2622 /* Assume that it is in hex. */
2625 for (i
= 2; my_string
[i
] != '\0'; i
++)
2627 if (isdigit (my_string
[i
]))
2628 addr
= (my_string
[i
] - '0') + (addr
* 16);
2629 else if (isxdigit (my_string
[i
]))
2630 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2632 error (_("invalid hex \"%s\""), my_string
);
2637 /* Assume that it is in decimal. */
2640 for (i
= 0; my_string
[i
] != '\0'; i
++)
2642 if (isdigit (my_string
[i
]))
2643 addr
= (my_string
[i
] - '0') + (addr
* 10);
2645 error (_("invalid decimal \"%s\""), my_string
);
2652 gdb::unique_xmalloc_ptr
<char>
2653 gdb_realpath (const char *filename
)
2655 /* On most hosts, we rely on canonicalize_file_name to compute
2656 the FILENAME's realpath.
2658 But the situation is slightly more complex on Windows, due to some
2659 versions of GCC which were reported to generate paths where
2660 backlashes (the directory separator) were doubled. For instance:
2661 c:\\some\\double\\slashes\\dir
2663 c:\some\double\slashes\dir
2664 Those double-slashes were getting in the way when comparing paths,
2665 for instance when trying to insert a breakpoint as follow:
2666 (gdb) b c:/some/double/slashes/dir/foo.c:4
2667 No source file named c:/some/double/slashes/dir/foo.c:4.
2668 (gdb) b c:\some\double\slashes\dir\foo.c:4
2669 No source file named c:\some\double\slashes\dir\foo.c:4.
2670 To prevent this from happening, we need this function to always
2671 strip those extra backslashes. While canonicalize_file_name does
2672 perform this simplification, it only works when the path is valid.
2673 Since the simplification would be useful even if the path is not
2674 valid (one can always set a breakpoint on a file, even if the file
2675 does not exist locally), we rely instead on GetFullPathName to
2676 perform the canonicalization. */
2678 #if defined (_WIN32)
2681 DWORD len
= GetFullPathName (filename
, MAX_PATH
, buf
, NULL
);
2683 /* The file system is case-insensitive but case-preserving.
2684 So it is important we do not lowercase the path. Otherwise,
2685 we might not be able to display the original casing in a given
2687 if (len
> 0 && len
< MAX_PATH
)
2688 return gdb::unique_xmalloc_ptr
<char> (xstrdup (buf
));
2692 char *rp
= canonicalize_file_name (filename
);
2695 return gdb::unique_xmalloc_ptr
<char> (rp
);
2699 /* This system is a lost cause, just dup the buffer. */
2700 return gdb::unique_xmalloc_ptr
<char> (xstrdup (filename
));
2706 gdb_realpath_check_trailer (const char *input
, const char *trailer
)
2708 gdb::unique_xmalloc_ptr
<char> result
= gdb_realpath (input
);
2710 size_t len
= strlen (result
.get ());
2711 size_t trail_len
= strlen (trailer
);
2713 SELF_CHECK (len
>= trail_len
2714 && strcmp (result
.get () + len
- trail_len
, trailer
) == 0);
2718 gdb_realpath_tests ()
2720 /* A file which contains a directory prefix. */
2721 gdb_realpath_check_trailer ("./xfullpath.exp", "/xfullpath.exp");
2722 /* A file which contains a directory prefix. */
2723 gdb_realpath_check_trailer ("../../defs.h", "/defs.h");
2724 /* A one-character filename. */
2725 gdb_realpath_check_trailer ("./a", "/a");
2726 /* A file in the root directory. */
2727 gdb_realpath_check_trailer ("/root_file_which_should_exist",
2728 "/root_file_which_should_exist");
2729 /* A file which does not have a directory prefix. */
2730 gdb_realpath_check_trailer ("xfullpath.exp", "xfullpath.exp");
2731 /* A one-char filename without any directory prefix. */
2732 gdb_realpath_check_trailer ("a", "a");
2733 /* An empty filename. */
2734 gdb_realpath_check_trailer ("", "");
2737 #endif /* GDB_SELF_TEST */
2739 /* Return a copy of FILENAME, with its directory prefix canonicalized
2742 gdb::unique_xmalloc_ptr
<char>
2743 gdb_realpath_keepfile (const char *filename
)
2745 const char *base_name
= lbasename (filename
);
2749 /* Extract the basename of filename, and return immediately
2750 a copy of filename if it does not contain any directory prefix. */
2751 if (base_name
== filename
)
2752 return gdb::unique_xmalloc_ptr
<char> (xstrdup (filename
));
2754 dir_name
= (char *) alloca ((size_t) (base_name
- filename
+ 2));
2755 /* Allocate enough space to store the dir_name + plus one extra
2756 character sometimes needed under Windows (see below), and
2757 then the closing \000 character. */
2758 strncpy (dir_name
, filename
, base_name
- filename
);
2759 dir_name
[base_name
- filename
] = '\000';
2761 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
2762 /* We need to be careful when filename is of the form 'd:foo', which
2763 is equivalent of d:./foo, which is totally different from d:/foo. */
2764 if (strlen (dir_name
) == 2 && isalpha (dir_name
[0]) && dir_name
[1] == ':')
2767 dir_name
[3] = '\000';
2771 /* Canonicalize the directory prefix, and build the resulting
2772 filename. If the dirname realpath already contains an ending
2773 directory separator, avoid doubling it. */
2774 gdb::unique_xmalloc_ptr
<char> path_storage
= gdb_realpath (dir_name
);
2775 const char *real_path
= path_storage
.get ();
2776 if (IS_DIR_SEPARATOR (real_path
[strlen (real_path
) - 1]))
2777 result
= concat (real_path
, base_name
, (char *) NULL
);
2779 result
= concat (real_path
, SLASH_STRING
, base_name
, (char *) NULL
);
2781 return gdb::unique_xmalloc_ptr
<char> (result
);
2784 /* Return PATH in absolute form, performing tilde-expansion if necessary.
2785 PATH cannot be NULL or the empty string.
2786 This does not resolve symlinks however, use gdb_realpath for that. */
2788 gdb::unique_xmalloc_ptr
<char>
2789 gdb_abspath (const char *path
)
2791 gdb_assert (path
!= NULL
&& path
[0] != '\0');
2794 return gdb::unique_xmalloc_ptr
<char> (tilde_expand (path
));
2796 if (IS_ABSOLUTE_PATH (path
))
2797 return gdb::unique_xmalloc_ptr
<char> (xstrdup (path
));
2799 /* Beware the // my son, the Emacs barfs, the botch that catch... */
2800 return gdb::unique_xmalloc_ptr
<char>
2801 (concat (current_directory
,
2802 IS_DIR_SEPARATOR (current_directory
[strlen (current_directory
) - 1])
2803 ? "" : SLASH_STRING
,
2804 path
, (char *) NULL
));
2808 align_up (ULONGEST v
, int n
)
2810 /* Check that N is really a power of two. */
2811 gdb_assert (n
&& (n
& (n
-1)) == 0);
2812 return (v
+ n
- 1) & -n
;
2816 align_down (ULONGEST v
, int n
)
2818 /* Check that N is really a power of two. */
2819 gdb_assert (n
&& (n
& (n
-1)) == 0);
2823 /* Allocation function for the libiberty hash table which uses an
2824 obstack. The obstack is passed as DATA. */
2827 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
2829 size_t total
= size
* count
;
2830 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
2832 memset (ptr
, 0, total
);
2836 /* Trivial deallocation function for the libiberty splay tree and hash
2837 table - don't deallocate anything. Rely on later deletion of the
2838 obstack. DATA will be the obstack, although it is not needed
2842 dummy_obstack_deallocate (void *object
, void *data
)
2847 /* Simple, portable version of dirname that does not modify its
2851 ldirname (const char *filename
)
2853 std::string dirname
;
2854 const char *base
= lbasename (filename
);
2856 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
2859 if (base
== filename
)
2862 dirname
= std::string (filename
, base
- filename
);
2864 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
2865 create "d:./bar" later instead of the (different) "d:/bar". */
2866 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
2867 && !IS_DIR_SEPARATOR (filename
[0]))
2868 dirname
[base
++ - filename
] = '.';
2876 gdb_argv::reset (const char *s
)
2878 char **argv
= buildargv (s
);
2880 if (s
!= NULL
&& argv
== NULL
)
2888 compare_positive_ints (const void *ap
, const void *bp
)
2890 /* Because we know we're comparing two ints which are positive,
2891 there's no danger of overflow here. */
2892 return * (int *) ap
- * (int *) bp
;
2895 /* String compare function for qsort. */
2898 compare_strings (const void *arg1
, const void *arg2
)
2900 const char **s1
= (const char **) arg1
;
2901 const char **s2
= (const char **) arg2
;
2903 return strcmp (*s1
, *s2
);
2906 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
2907 #define AMBIGUOUS_MESS2 \
2908 ".\nUse \"set gnutarget format-name\" to specify the format."
2911 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
2917 /* Check if errmsg just need simple return. */
2918 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
2919 return bfd_errmsg (error_tag
);
2921 ret_len
= strlen (bfd_errmsg (error_tag
)) + strlen (AMBIGUOUS_MESS1
)
2922 + strlen (AMBIGUOUS_MESS2
);
2923 for (p
= matching
; *p
; p
++)
2924 ret_len
+= strlen (*p
) + 1;
2925 ret
= (char *) xmalloc (ret_len
+ 1);
2927 make_cleanup (xfree
, ret
);
2929 strcpy (retp
, bfd_errmsg (error_tag
));
2930 retp
+= strlen (retp
);
2932 strcpy (retp
, AMBIGUOUS_MESS1
);
2933 retp
+= strlen (retp
);
2935 for (p
= matching
; *p
; p
++)
2937 sprintf (retp
, " %s", *p
);
2938 retp
+= strlen (retp
);
2942 strcpy (retp
, AMBIGUOUS_MESS2
);
2947 /* Return ARGS parsed as a valid pid, or throw an error. */
2950 parse_pid_to_attach (const char *args
)
2956 error_no_arg (_("process-id to attach"));
2958 dummy
= (char *) args
;
2959 pid
= strtoul (args
, &dummy
, 0);
2960 /* Some targets don't set errno on errors, grrr! */
2961 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
2962 error (_("Illegal process-id: %s."), args
);
2967 /* Helper for make_bpstat_clear_actions_cleanup. */
2970 do_bpstat_clear_actions_cleanup (void *unused
)
2972 bpstat_clear_actions ();
2975 /* Call bpstat_clear_actions for the case an exception is throw. You should
2976 discard_cleanups if no exception is caught. */
2979 make_bpstat_clear_actions_cleanup (void)
2981 return make_cleanup (do_bpstat_clear_actions_cleanup
, NULL
);
2984 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
2985 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
2986 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
2989 producer_is_gcc_ge_4 (const char *producer
)
2993 if (! producer_is_gcc (producer
, &major
, &minor
))
3002 /* Returns nonzero if the given PRODUCER string is GCC and sets the MAJOR
3003 and MINOR versions when not NULL. Returns zero if the given PRODUCER
3004 is NULL or it isn't GCC. */
3007 producer_is_gcc (const char *producer
, int *major
, int *minor
)
3011 if (producer
!= NULL
&& startswith (producer
, "GNU "))
3020 /* Skip any identifier after "GNU " - such as "C11" or "C++".
3021 A full producer string might look like:
3023 "GNU Fortran 4.8.2 20140120 (Red Hat 4.8.2-16) -mtune=generic ..."
3024 "GNU C++14 5.0.0 20150123 (experimental)"
3026 cs
= &producer
[strlen ("GNU ")];
3027 while (*cs
&& !isspace (*cs
))
3029 if (*cs
&& isspace (*cs
))
3031 if (sscanf (cs
, "%d.%d", major
, minor
) == 2)
3035 /* Not recognized as GCC. */
3039 /* Helper for make_cleanup_free_char_ptr_vec. */
3042 do_free_char_ptr_vec (void *arg
)
3044 VEC (char_ptr
) *char_ptr_vec
= (VEC (char_ptr
) *) arg
;
3046 free_char_ptr_vec (char_ptr_vec
);
3049 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3050 final VEC_free for CHAR_PTR_VEC itself.
3052 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3053 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3054 this function does not (cannot) clear the pointer. */
3057 make_cleanup_free_char_ptr_vec (VEC (char_ptr
) *char_ptr_vec
)
3059 return make_cleanup (do_free_char_ptr_vec
, char_ptr_vec
);
3062 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3063 must come from xrealloc-compatible allocator and it may be updated. FROM
3064 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3065 located at the start or end of *STRINGP. */
3068 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3070 char *string
= *stringp
, *s
;
3071 const size_t from_len
= strlen (from
);
3072 const size_t to_len
= strlen (to
);
3076 s
= strstr (s
, from
);
3080 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3081 || s
[-1] == DIRNAME_SEPARATOR
)
3082 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3083 || s
[from_len
] == DIRNAME_SEPARATOR
))
3088 = (char *) xrealloc (string
, (strlen (string
) + to_len
+ 1));
3090 /* Relocate the current S pointer. */
3091 s
= s
- string
+ string_new
;
3092 string
= string_new
;
3094 /* Replace from by to. */
3095 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3096 memcpy (s
, to
, to_len
);
3111 /* SIGALRM handler for waitpid_with_timeout. */
3114 sigalrm_handler (int signo
)
3116 /* Nothing to do. */
3121 /* Wrapper to wait for child PID to die with TIMEOUT.
3122 TIMEOUT is the time to stop waiting in seconds.
3123 If TIMEOUT is zero, pass WNOHANG to waitpid.
3124 Returns PID if it was successfully waited for, otherwise -1.
3126 Timeouts are currently implemented with alarm and SIGALRM.
3127 If the host does not support them, this waits "forever".
3128 It would be odd though for a host to have waitpid and not SIGALRM. */
3131 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3133 pid_t waitpid_result
;
3135 gdb_assert (pid
> 0);
3136 gdb_assert (timeout
>= 0);
3141 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3142 struct sigaction sa
, old_sa
;
3144 sa
.sa_handler
= sigalrm_handler
;
3145 sigemptyset (&sa
.sa_mask
);
3147 sigaction (SIGALRM
, &sa
, &old_sa
);
3151 ofunc
= signal (SIGALRM
, sigalrm_handler
);
3157 waitpid_result
= waitpid (pid
, status
, 0);
3161 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3162 sigaction (SIGALRM
, &old_sa
, NULL
);
3164 signal (SIGALRM
, ofunc
);
3169 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3171 if (waitpid_result
== pid
)
3177 #endif /* HAVE_WAITPID */
3179 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3180 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3182 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3183 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3186 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3188 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3190 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3191 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3193 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3195 char *pattern_slash
, *string_slash
;
3197 /* Replace '\' by '/' in both strings. */
3199 pattern_slash
= (char *) alloca (strlen (pattern
) + 1);
3200 strcpy (pattern_slash
, pattern
);
3201 pattern
= pattern_slash
;
3202 for (; *pattern_slash
!= 0; pattern_slash
++)
3203 if (IS_DIR_SEPARATOR (*pattern_slash
))
3204 *pattern_slash
= '/';
3206 string_slash
= (char *) alloca (strlen (string
) + 1);
3207 strcpy (string_slash
, string
);
3208 string
= string_slash
;
3209 for (; *string_slash
!= 0; string_slash
++)
3210 if (IS_DIR_SEPARATOR (*string_slash
))
3211 *string_slash
= '/';
3213 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3215 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3216 flags
|= FNM_CASEFOLD
;
3217 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3219 return fnmatch (pattern
, string
, flags
);
3222 /* Return the number of path elements in PATH.
3230 count_path_elements (const char *path
)
3233 const char *p
= path
;
3235 if (HAS_DRIVE_SPEC (p
))
3237 p
= STRIP_DRIVE_SPEC (p
);
3243 if (IS_DIR_SEPARATOR (*p
))
3248 /* Backup one if last character is /, unless it's the only one. */
3249 if (p
> path
+ 1 && IS_DIR_SEPARATOR (p
[-1]))
3252 /* Add one for the file name, if present. */
3253 if (p
> path
&& !IS_DIR_SEPARATOR (p
[-1]))
3259 /* Remove N leading path elements from PATH.
3260 N must be non-negative.
3261 If PATH has more than N path elements then return NULL.
3262 If PATH has exactly N path elements then return "".
3263 See count_path_elements for a description of how we do the counting. */
3266 strip_leading_path_elements (const char *path
, int n
)
3269 const char *p
= path
;
3271 gdb_assert (n
>= 0);
3276 if (HAS_DRIVE_SPEC (p
))
3278 p
= STRIP_DRIVE_SPEC (p
);
3284 while (*p
!= '\0' && !IS_DIR_SEPARATOR (*p
))
3299 /* Provide a prototype to silence -Wmissing-prototypes. */
3300 extern initialize_file_ftype _initialize_utils
;
3303 _initialize_utils (void)
3305 add_internal_problem_command (&internal_error_problem
);
3306 add_internal_problem_command (&internal_warning_problem
);
3307 add_internal_problem_command (&demangler_warning_problem
);
3310 selftests::register_test (gdb_realpath_tests
);