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"
70 extern PTR
malloc (); /* ARI: PTR */
72 #if !HAVE_DECL_REALLOC
73 extern PTR
realloc (); /* ARI: PTR */
79 void (*deprecated_error_begin_hook
) (void);
81 /* Prototypes for local functions */
83 static void vfprintf_maybe_filtered (struct ui_file
*, const char *,
84 va_list, int) ATTRIBUTE_PRINTF (2, 0);
86 static void fputs_maybe_filtered (const char *, struct ui_file
*, int);
88 static void prompt_for_continue (void);
90 static void set_screen_size (void);
91 static void set_width (void);
93 /* Time spent in prompt_for_continue in the currently executing command
94 waiting for user to respond.
95 Initialized in make_command_stats_cleanup.
96 Modified in prompt_for_continue and defaulted_query.
97 Used in report_command_stats. */
99 static std::chrono::steady_clock::duration prompt_for_continue_wait_time
;
101 /* A flag indicating whether to timestamp debugging messages. */
103 static int debug_timestamp
= 0;
105 /* Nonzero if we have job control. */
109 /* Nonzero means that strings with character values >0x7F should be printed
110 as octal escapes. Zero means just print the value (e.g. it's an
111 international character, and the terminal or window can cope.) */
113 int sevenbit_strings
= 0;
115 show_sevenbit_strings (struct ui_file
*file
, int from_tty
,
116 struct cmd_list_element
*c
, const char *value
)
118 fprintf_filtered (file
, _("Printing of 8-bit characters "
119 "in strings as \\nnn is %s.\n"),
123 /* String to be printed before warning messages, if any. */
125 const char *warning_pre_print
= "\nwarning: ";
127 int pagination_enabled
= 1;
129 show_pagination_enabled (struct ui_file
*file
, int from_tty
,
130 struct cmd_list_element
*c
, const char *value
)
132 fprintf_filtered (file
, _("State of pagination is %s.\n"), value
);
136 /* Cleanup utilities.
138 These are not defined in cleanups.c (nor declared in cleanups.h)
139 because while they use the "cleanup API" they are not part of the
143 do_freeargv (void *arg
)
145 freeargv ((char **) arg
);
149 make_cleanup_freeargv (char **arg
)
151 return make_cleanup (do_freeargv
, arg
);
154 /* Helper function which does the work for make_cleanup_fclose. */
157 do_fclose_cleanup (void *arg
)
159 FILE *file
= (FILE *) arg
;
164 /* Return a new cleanup that closes FILE. */
167 make_cleanup_fclose (FILE *file
)
169 return make_cleanup (do_fclose_cleanup
, file
);
172 /* Helper function which does the work for make_cleanup_obstack_free. */
175 do_obstack_free (void *arg
)
177 struct obstack
*ob
= (struct obstack
*) arg
;
179 obstack_free (ob
, NULL
);
182 /* Return a new cleanup that frees OBSTACK. */
185 make_cleanup_obstack_free (struct obstack
*obstack
)
187 return make_cleanup (do_obstack_free
, obstack
);
190 /* Helper function for make_cleanup_ui_out_redirect_pop. */
193 do_ui_out_redirect_pop (void *arg
)
195 struct ui_out
*uiout
= (struct ui_out
*) arg
;
197 uiout
->redirect (NULL
);
200 /* Return a new cleanup that pops the last redirection by ui_out_redirect
201 with NULL parameter. */
204 make_cleanup_ui_out_redirect_pop (struct ui_out
*uiout
)
206 return make_cleanup (do_ui_out_redirect_pop
, uiout
);
210 do_free_section_addr_info (void *arg
)
212 free_section_addr_info ((struct section_addr_info
*) arg
);
216 make_cleanup_free_section_addr_info (struct section_addr_info
*addrs
)
218 return make_cleanup (do_free_section_addr_info
, addrs
);
221 struct restore_integer_closure
228 restore_integer (void *p
)
230 struct restore_integer_closure
*closure
231 = (struct restore_integer_closure
*) p
;
233 *(closure
->variable
) = closure
->value
;
236 /* Remember the current value of *VARIABLE and make it restored when
237 the cleanup is run. */
240 make_cleanup_restore_integer (int *variable
)
242 struct restore_integer_closure
*c
= XNEW (struct restore_integer_closure
);
244 c
->variable
= variable
;
245 c
->value
= *variable
;
247 return make_cleanup_dtor (restore_integer
, (void *) c
, xfree
);
250 /* Remember the current value of *VARIABLE and make it restored when
251 the cleanup is run. */
254 make_cleanup_restore_uinteger (unsigned int *variable
)
256 return make_cleanup_restore_integer ((int *) variable
);
259 /* Helper for make_cleanup_unpush_target. */
262 do_unpush_target (void *arg
)
264 struct target_ops
*ops
= (struct target_ops
*) arg
;
269 /* Return a new cleanup that unpushes OPS. */
272 make_cleanup_unpush_target (struct target_ops
*ops
)
274 return make_cleanup (do_unpush_target
, ops
);
277 /* Helper for make_cleanup_value_free_to_mark. */
280 do_value_free_to_mark (void *value
)
282 value_free_to_mark ((struct value
*) value
);
285 /* Free all values allocated since MARK was obtained by value_mark
286 (except for those released) when the cleanup is run. */
289 make_cleanup_value_free_to_mark (struct value
*mark
)
291 return make_cleanup (do_value_free_to_mark
, mark
);
294 /* Helper for make_cleanup_value_free. */
297 do_value_free (void *value
)
299 value_free ((struct value
*) value
);
305 make_cleanup_value_free (struct value
*value
)
307 return make_cleanup (do_value_free
, value
);
310 /* Helper for make_cleanup_free_so. */
313 do_free_so (void *arg
)
315 struct so_list
*so
= (struct so_list
*) arg
;
320 /* Make cleanup handler calling free_so for SO. */
323 make_cleanup_free_so (struct so_list
*so
)
325 return make_cleanup (do_free_so
, so
);
328 /* Helper for make_cleanup_restore_current_language. */
331 do_restore_current_language (void *p
)
333 enum language saved_lang
= (enum language
) (uintptr_t) p
;
335 set_language (saved_lang
);
338 /* Remember the current value of CURRENT_LANGUAGE and make it restored when
339 the cleanup is run. */
342 make_cleanup_restore_current_language (void)
344 enum language saved_lang
= current_language
->la_language
;
346 return make_cleanup (do_restore_current_language
,
347 (void *) (uintptr_t) saved_lang
);
350 /* Helper function for make_cleanup_clear_parser_state. */
353 do_clear_parser_state (void *ptr
)
355 struct parser_state
**p
= (struct parser_state
**) ptr
;
360 /* Clean (i.e., set to NULL) the parser state variable P. */
363 make_cleanup_clear_parser_state (struct parser_state
**p
)
365 return make_cleanup (do_clear_parser_state
, (void *) p
);
368 /* This function is useful for cleanups.
372 old_chain = make_cleanup (free_current_contents, &foo);
374 to arrange to free the object thus allocated. */
377 free_current_contents (void *ptr
)
379 void **location
= (void **) ptr
;
381 if (location
== NULL
)
382 internal_error (__FILE__
, __LINE__
,
383 _("free_current_contents: NULL pointer"));
384 if (*location
!= NULL
)
393 /* Print a warning message. The first argument STRING is the warning
394 message, used as an fprintf format string, the second is the
395 va_list of arguments for that string. A warning is unfiltered (not
396 paginated) so that the user does not need to page through each
397 screen full of warnings when there are lots of them. */
400 vwarning (const char *string
, va_list args
)
402 if (deprecated_warning_hook
)
403 (*deprecated_warning_hook
) (string
, args
);
406 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
408 if (target_supports_terminal_ours ())
410 make_cleanup_restore_target_terminal ();
411 target_terminal_ours_for_output ();
413 if (filtered_printing_initialized ())
414 wrap_here (""); /* Force out any buffered output. */
415 gdb_flush (gdb_stdout
);
416 if (warning_pre_print
)
417 fputs_unfiltered (warning_pre_print
, gdb_stderr
);
418 vfprintf_unfiltered (gdb_stderr
, string
, args
);
419 fprintf_unfiltered (gdb_stderr
, "\n");
421 do_cleanups (old_chain
);
425 /* Print an error message and return to command level.
426 The first argument STRING is the error message, used as a fprintf string,
427 and the remaining args are passed as arguments to it. */
430 verror (const char *string
, va_list args
)
432 throw_verror (GENERIC_ERROR
, string
, args
);
436 error_stream (const string_file
&stream
)
438 error (("%s"), stream
.c_str ());
441 /* Emit a message and abort. */
443 static void ATTRIBUTE_NORETURN
444 abort_with_message (const char *msg
)
446 if (gdb_stderr
== NULL
)
449 fputs_unfiltered (msg
, gdb_stderr
);
451 abort (); /* NOTE: GDB has only three calls to abort(). */
454 /* Dump core trying to increase the core soft limit to hard limit first. */
459 #ifdef HAVE_SETRLIMIT
460 struct rlimit rlim
= { RLIM_INFINITY
, RLIM_INFINITY
};
462 setrlimit (RLIMIT_CORE
, &rlim
);
463 #endif /* HAVE_SETRLIMIT */
465 abort (); /* NOTE: GDB has only three calls to abort(). */
468 /* Check whether GDB will be able to dump core using the dump_core
469 function. Returns zero if GDB cannot or should not dump core.
470 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
471 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
474 can_dump_core (enum resource_limit_kind limit_kind
)
476 #ifdef HAVE_GETRLIMIT
479 /* Be quiet and assume we can dump if an error is returned. */
480 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
486 if (rlim
.rlim_cur
== 0)
490 if (rlim
.rlim_max
== 0)
493 #endif /* HAVE_GETRLIMIT */
498 /* Print a warning that we cannot dump core. */
501 warn_cant_dump_core (const char *reason
)
503 fprintf_unfiltered (gdb_stderr
,
504 _("%s\nUnable to dump core, use `ulimit -c"
505 " unlimited' before executing GDB next time.\n"),
509 /* Check whether GDB will be able to dump core using the dump_core
510 function, and print a warning if we cannot. */
513 can_dump_core_warn (enum resource_limit_kind limit_kind
,
516 int core_dump_allowed
= can_dump_core (limit_kind
);
518 if (!core_dump_allowed
)
519 warn_cant_dump_core (reason
);
521 return core_dump_allowed
;
524 /* Allow the user to configure the debugger behavior with respect to
525 what to do when an internal problem is detected. */
527 const char internal_problem_ask
[] = "ask";
528 const char internal_problem_yes
[] = "yes";
529 const char internal_problem_no
[] = "no";
530 static const char *const internal_problem_modes
[] =
532 internal_problem_ask
,
533 internal_problem_yes
,
538 /* Print a message reporting an internal error/warning. Ask the user
539 if they want to continue, dump core, or just exit. Return
540 something to indicate a quit. */
542 struct internal_problem
545 int user_settable_should_quit
;
546 const char *should_quit
;
547 int user_settable_should_dump_core
;
548 const char *should_dump_core
;
551 /* Report a problem, internal to GDB, to the user. Once the problem
552 has been reported, and assuming GDB didn't quit, the caller can
553 either allow execution to resume or throw an error. */
555 static void ATTRIBUTE_PRINTF (4, 0)
556 internal_vproblem (struct internal_problem
*problem
,
557 const char *file
, int line
, const char *fmt
, va_list ap
)
563 struct cleanup
*cleanup
= make_cleanup (null_cleanup
, NULL
);
565 /* Don't allow infinite error/warning recursion. */
567 static char msg
[] = "Recursive internal problem.\n";
576 abort_with_message (msg
);
579 /* Newer GLIBC versions put the warn_unused_result attribute
580 on write, but this is one of those rare cases where
581 ignoring the return value is correct. Casting to (void)
582 does not fix this problem. This is the solution suggested
583 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
584 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
585 abort (); /* NOTE: GDB has only three calls to abort(). */
590 /* Create a string containing the full error/warning message. Need
591 to call query with this full string, as otherwize the reason
592 (error/warning) and question become separated. Format using a
593 style similar to a compiler error message. Include extra detail
594 so that the user knows that they are living on the edge. */
598 msg
= xstrvprintf (fmt
, ap
);
599 reason
= xstrprintf ("%s:%d: %s: %s\n"
600 "A problem internal to GDB has been detected,\n"
601 "further debugging may prove unreliable.",
602 file
, line
, problem
->name
, msg
);
604 make_cleanup (xfree
, reason
);
607 /* Fall back to abort_with_message if gdb_stderr is not set up. */
608 if (gdb_stderr
== NULL
)
610 fputs (reason
, stderr
);
611 abort_with_message ("\n");
614 /* Try to get the message out and at the start of a new line. */
615 if (target_supports_terminal_ours ())
617 make_cleanup_restore_target_terminal ();
618 target_terminal_ours_for_output ();
620 if (filtered_printing_initialized ())
623 /* Emit the message unless query will emit it below. */
624 if (problem
->should_quit
!= internal_problem_ask
626 || !filtered_printing_initialized ())
627 fprintf_unfiltered (gdb_stderr
, "%s\n", reason
);
629 if (problem
->should_quit
== internal_problem_ask
)
631 /* Default (yes/batch case) is to quit GDB. When in batch mode
632 this lessens the likelihood of GDB going into an infinite
634 if (!confirm
|| !filtered_printing_initialized ())
637 quit_p
= query (_("%s\nQuit this debugging session? "), reason
);
639 else if (problem
->should_quit
== internal_problem_yes
)
641 else if (problem
->should_quit
== internal_problem_no
)
644 internal_error (__FILE__
, __LINE__
, _("bad switch"));
646 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr
);
647 if (REPORT_BUGS_TO
[0])
648 fprintf_unfiltered (gdb_stderr
, _(" For instructions, see:\n%s."),
650 fputs_unfiltered ("\n\n", gdb_stderr
);
652 if (problem
->should_dump_core
== internal_problem_ask
)
654 if (!can_dump_core_warn (LIMIT_MAX
, reason
))
656 else if (!filtered_printing_initialized ())
660 /* Default (yes/batch case) is to dump core. This leaves a GDB
661 `dropping' so that it is easier to see that something went
663 dump_core_p
= query (_("%s\nCreate a core file of GDB? "), reason
);
666 else if (problem
->should_dump_core
== internal_problem_yes
)
667 dump_core_p
= can_dump_core_warn (LIMIT_MAX
, reason
);
668 else if (problem
->should_dump_core
== internal_problem_no
)
671 internal_error (__FILE__
, __LINE__
, _("bad switch"));
684 #ifdef HAVE_WORKING_FORK
692 do_cleanups (cleanup
);
695 static struct internal_problem internal_error_problem
= {
696 "internal-error", 1, internal_problem_ask
, 1, internal_problem_ask
700 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
702 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
703 throw_quit (_("Command aborted."));
706 static struct internal_problem internal_warning_problem
= {
707 "internal-warning", 1, internal_problem_ask
, 1, internal_problem_ask
711 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
713 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
716 static struct internal_problem demangler_warning_problem
= {
717 "demangler-warning", 1, internal_problem_ask
, 0, internal_problem_no
721 demangler_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
723 internal_vproblem (&demangler_warning_problem
, file
, line
, fmt
, ap
);
727 demangler_warning (const char *file
, int line
, const char *string
, ...)
731 va_start (ap
, string
);
732 demangler_vwarning (file
, line
, string
, ap
);
736 /* Dummy functions to keep add_prefix_cmd happy. */
739 set_internal_problem_cmd (char *args
, int from_tty
)
744 show_internal_problem_cmd (char *args
, int from_tty
)
748 /* When GDB reports an internal problem (error or warning) it gives
749 the user the opportunity to quit GDB and/or create a core file of
750 the current debug session. This function registers a few commands
751 that make it possible to specify that GDB should always or never
752 quit or create a core file, without asking. The commands look
755 maint set PROBLEM-NAME quit ask|yes|no
756 maint show PROBLEM-NAME quit
757 maint set PROBLEM-NAME corefile ask|yes|no
758 maint show PROBLEM-NAME corefile
760 Where PROBLEM-NAME is currently "internal-error" or
761 "internal-warning". */
764 add_internal_problem_command (struct internal_problem
*problem
)
766 struct cmd_list_element
**set_cmd_list
;
767 struct cmd_list_element
**show_cmd_list
;
771 set_cmd_list
= XNEW (struct cmd_list_element
*);
772 show_cmd_list
= XNEW (struct cmd_list_element
*);
773 *set_cmd_list
= NULL
;
774 *show_cmd_list
= NULL
;
776 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
779 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
782 add_prefix_cmd ((char*) problem
->name
,
783 class_maintenance
, set_internal_problem_cmd
, set_doc
,
785 concat ("maintenance set ", problem
->name
, " ",
787 0/*allow-unknown*/, &maintenance_set_cmdlist
);
789 add_prefix_cmd ((char*) problem
->name
,
790 class_maintenance
, show_internal_problem_cmd
, show_doc
,
792 concat ("maintenance show ", problem
->name
, " ",
794 0/*allow-unknown*/, &maintenance_show_cmdlist
);
796 if (problem
->user_settable_should_quit
)
798 set_doc
= xstrprintf (_("Set whether GDB should quit "
799 "when an %s is detected"),
801 show_doc
= xstrprintf (_("Show whether GDB will quit "
802 "when an %s is detected"),
804 add_setshow_enum_cmd ("quit", class_maintenance
,
805 internal_problem_modes
,
806 &problem
->should_quit
,
819 if (problem
->user_settable_should_dump_core
)
821 set_doc
= xstrprintf (_("Set whether GDB should create a core "
822 "file of GDB when %s is detected"),
824 show_doc
= xstrprintf (_("Show whether GDB will create a core "
825 "file of GDB when %s is detected"),
827 add_setshow_enum_cmd ("corefile", class_maintenance
,
828 internal_problem_modes
,
829 &problem
->should_dump_core
,
843 /* Return a newly allocated string, containing the PREFIX followed
844 by the system error message for errno (separated by a colon).
846 The result must be deallocated after use. */
849 perror_string (const char *prefix
)
854 err
= safe_strerror (errno
);
855 combined
= (char *) xmalloc (strlen (err
) + strlen (prefix
) + 3);
856 strcpy (combined
, prefix
);
857 strcat (combined
, ": ");
858 strcat (combined
, err
);
863 /* Print the system error message for errno, and also mention STRING
864 as the file name for which the error was encountered. Use ERRCODE
865 for the thrown exception. Then return to command level. */
868 throw_perror_with_name (enum errors errcode
, const char *string
)
872 combined
= perror_string (string
);
873 make_cleanup (xfree
, combined
);
875 /* I understand setting these is a matter of taste. Still, some people
876 may clear errno but not know about bfd_error. Doing this here is not
878 bfd_set_error (bfd_error_no_error
);
881 throw_error (errcode
, _("%s."), combined
);
884 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
887 perror_with_name (const char *string
)
889 throw_perror_with_name (GENERIC_ERROR
, string
);
892 /* Same as perror_with_name except that it prints a warning instead
893 of throwing an error. */
896 perror_warning_with_name (const char *string
)
900 combined
= perror_string (string
);
901 warning (_("%s"), combined
);
905 /* Print the system error message for ERRCODE, and also mention STRING
906 as the file name for which the error was encountered. */
909 print_sys_errmsg (const char *string
, int errcode
)
914 err
= safe_strerror (errcode
);
915 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
916 strcpy (combined
, string
);
917 strcat (combined
, ": ");
918 strcat (combined
, err
);
920 /* We want anything which was printed on stdout to come out first, before
922 gdb_flush (gdb_stdout
);
923 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
926 /* Control C eventually causes this to be called, at a convenient time. */
931 struct ui
*ui
= current_ui
;
933 if (sync_quit_force_run
)
935 sync_quit_force_run
= 0;
936 quit_force (NULL
, 0);
940 /* No steenking SIGINT will ever be coming our way when the
941 program is resumed. Don't lie. */
945 /* If there is no terminal switching for this target, then we can't
946 possibly get screwed by the lack of job control. */
947 || !target_supports_terminal_ours ())
950 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
959 if (sync_quit_force_run
)
964 if (deprecated_interactive_hook
)
965 deprecated_interactive_hook ();
969 /* Called when a memory allocation fails, with the number of bytes of
970 memory requested in SIZE. */
973 malloc_failure (long size
)
977 internal_error (__FILE__
, __LINE__
,
978 _("virtual memory exhausted: can't allocate %ld bytes."),
983 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
987 /* My replacement for the read system call.
988 Used like `read' but keeps going if `read' returns too soon. */
991 myread (int desc
, char *addr
, int len
)
998 val
= read (desc
, addr
, len
);
1002 return orglen
- len
;
1010 print_spaces (int n
, struct ui_file
*file
)
1012 fputs_unfiltered (n_spaces (n
), file
);
1015 /* Print a host address. */
1018 gdb_print_host_address_1 (const void *addr
, struct ui_file
*stream
)
1020 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
1026 make_hex_string (const gdb_byte
*data
, size_t length
)
1028 char *result
= (char *) xmalloc (length
* 2 + 1);
1033 for (i
= 0; i
< length
; ++i
)
1034 p
+= xsnprintf (p
, 3, "%02x", data
[i
]);
1041 /* A cleanup that simply calls ui_unregister_input_event_handler. */
1044 ui_unregister_input_event_handler_cleanup (void *ui
)
1046 ui_unregister_input_event_handler ((struct ui
*) ui
);
1049 /* Set up to handle input. */
1051 static struct cleanup
*
1052 prepare_to_handle_input (void)
1054 struct cleanup
*old_chain
;
1056 old_chain
= make_cleanup_restore_target_terminal ();
1057 target_terminal_ours ();
1059 ui_register_input_event_handler (current_ui
);
1060 if (current_ui
->prompt_state
== PROMPT_BLOCKED
)
1061 make_cleanup (ui_unregister_input_event_handler_cleanup
, current_ui
);
1063 make_cleanup_override_quit_handler (default_quit_handler
);
1070 /* This function supports the query, nquery, and yquery functions.
1071 Ask user a y-or-n question and return 0 if answer is no, 1 if
1072 answer is yes, or default the answer to the specified default
1073 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1074 default answer, or '\0' for no default.
1075 CTLSTR is the control string and should end in "? ". It should
1076 not say how to answer, because we do that.
1077 ARGS are the arguments passed along with the CTLSTR argument to
1080 static int ATTRIBUTE_PRINTF (1, 0)
1081 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
1086 char def_answer
, not_def_answer
;
1087 const char *y_string
, *n_string
;
1088 char *question
, *prompt
;
1089 struct cleanup
*old_chain
;
1091 /* Set up according to which answer is the default. */
1092 if (defchar
== '\0')
1096 not_def_answer
= 'N';
1100 else if (defchar
== 'y')
1104 not_def_answer
= 'N';
1112 not_def_answer
= 'Y';
1117 /* Automatically answer the default value if the user did not want
1118 prompts or the command was issued with the server prefix. */
1119 if (!confirm
|| server_command
)
1122 /* If input isn't coming from the user directly, just say what
1123 question we're asking, and then answer the default automatically. This
1124 way, important error messages don't get lost when talking to GDB
1126 if (current_ui
->instream
!= current_ui
->stdin_stream
1127 || !input_interactive_p (current_ui
)
1128 /* Restrict queries to the main UI. */
1129 || current_ui
!= main_ui
)
1131 old_chain
= make_cleanup_restore_target_terminal ();
1133 target_terminal_ours_for_output ();
1135 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
1137 printf_filtered (_("(%s or %s) [answered %c; "
1138 "input not from terminal]\n"),
1139 y_string
, n_string
, def_answer
);
1140 gdb_flush (gdb_stdout
);
1142 do_cleanups (old_chain
);
1146 if (deprecated_query_hook
)
1150 old_chain
= make_cleanup_restore_target_terminal ();
1151 res
= deprecated_query_hook (ctlstr
, args
);
1152 do_cleanups (old_chain
);
1156 /* Format the question outside of the loop, to avoid reusing args. */
1157 question
= xstrvprintf (ctlstr
, args
);
1158 old_chain
= make_cleanup (xfree
, question
);
1159 prompt
= xstrprintf (_("%s%s(%s or %s) %s"),
1160 annotation_level
> 1 ? "\n\032\032pre-query\n" : "",
1161 question
, y_string
, n_string
,
1162 annotation_level
> 1 ? "\n\032\032query\n" : "");
1163 make_cleanup (xfree
, prompt
);
1165 /* Used to add duration we waited for user to respond to
1166 prompt_for_continue_wait_time. */
1167 using namespace std::chrono
;
1168 steady_clock::time_point prompt_started
= steady_clock::now ();
1170 prepare_to_handle_input ();
1174 char *response
, answer
;
1176 gdb_flush (gdb_stdout
);
1177 response
= gdb_readline_wrapper (prompt
);
1179 if (response
== NULL
) /* C-d */
1181 printf_filtered ("EOF [assumed %c]\n", def_answer
);
1186 answer
= response
[0];
1191 /* Check answer. For the non-default, the user must specify
1192 the non-default explicitly. */
1193 if (answer
== not_def_answer
)
1195 retval
= !def_value
;
1198 /* Otherwise, if a default was specified, the user may either
1199 specify the required input or have it default by entering
1201 if (answer
== def_answer
1202 || (defchar
!= '\0' && answer
== '\0'))
1207 /* Invalid entries are not defaulted and require another selection. */
1208 printf_filtered (_("Please answer %s or %s.\n"),
1209 y_string
, n_string
);
1212 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1213 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1215 if (annotation_level
> 1)
1216 printf_filtered (("\n\032\032post-query\n"));
1217 do_cleanups (old_chain
);
1222 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1223 answer is yes, or 0 if answer is defaulted.
1224 Takes three args which are given to printf to print the question.
1225 The first, a control string, should end in "? ".
1226 It should not say how to answer, because we do that. */
1229 nquery (const char *ctlstr
, ...)
1234 va_start (args
, ctlstr
);
1235 ret
= defaulted_query (ctlstr
, 'n', args
);
1240 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1241 answer is yes, or 1 if answer is defaulted.
1242 Takes three args which are given to printf to print the question.
1243 The first, a control string, should end in "? ".
1244 It should not say how to answer, because we do that. */
1247 yquery (const char *ctlstr
, ...)
1252 va_start (args
, ctlstr
);
1253 ret
= defaulted_query (ctlstr
, 'y', args
);
1258 /* Ask user a y-or-n question and return 1 iff answer is yes.
1259 Takes three args which are given to printf to print the question.
1260 The first, a control string, should end in "? ".
1261 It should not say how to answer, because we do that. */
1264 query (const char *ctlstr
, ...)
1269 va_start (args
, ctlstr
);
1270 ret
= defaulted_query (ctlstr
, '\0', args
);
1275 /* A helper for parse_escape that converts a host character to a
1276 target character. C is the host character. If conversion is
1277 possible, then the target character is stored in *TARGET_C and the
1278 function returns 1. Otherwise, the function returns 0. */
1281 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1283 struct obstack host_data
;
1285 struct cleanup
*cleanups
;
1288 obstack_init (&host_data
);
1289 cleanups
= make_cleanup_obstack_free (&host_data
);
1291 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1292 (gdb_byte
*) &the_char
, 1, 1,
1293 &host_data
, translit_none
);
1295 if (obstack_object_size (&host_data
) == 1)
1298 *target_c
= *(char *) obstack_base (&host_data
);
1301 do_cleanups (cleanups
);
1305 /* Parse a C escape sequence. STRING_PTR points to a variable
1306 containing a pointer to the string to parse. That pointer
1307 should point to the character after the \. That pointer
1308 is updated past the characters we use. The value of the
1309 escape sequence is returned.
1311 A negative value means the sequence \ newline was seen,
1312 which is supposed to be equivalent to nothing at all.
1314 If \ is followed by a null character, we return a negative
1315 value and leave the string pointer pointing at the null character.
1317 If \ is followed by 000, we return 0 and leave the string pointer
1318 after the zeros. A value of 0 does not mean end of string. */
1321 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1323 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1324 int c
= *(*string_ptr
)++;
1343 int i
= host_hex_value (c
);
1348 if (isdigit (c
) && c
!= '8' && c
!= '9')
1352 i
+= host_hex_value (c
);
1388 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1389 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1390 " which has no equivalent\nin the `%s' character set."),
1391 c
, c
, target_charset (gdbarch
));
1395 /* Print the character C on STREAM as part of the contents of a literal
1396 string whose delimiter is QUOTER. Note that this routine should only
1397 be called for printing things which are independent of the language
1398 of the program being debugged.
1400 printchar will normally escape backslashes and instances of QUOTER. If
1401 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1402 As a side effect, if you pass the backslash character as the QUOTER,
1403 printchar will escape backslashes as usual, but not any other quoting
1407 printchar (int c
, void (*do_fputs
) (const char *, struct ui_file
*),
1408 void (*do_fprintf
) (struct ui_file
*, const char *, ...)
1409 ATTRIBUTE_FPTR_PRINTF_2
, struct ui_file
*stream
, int quoter
)
1411 c
&= 0xFF; /* Avoid sign bit follies */
1413 if (c
< 0x20 || /* Low control chars */
1414 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1415 (sevenbit_strings
&& c
>= 0x80))
1416 { /* high order bit set */
1420 do_fputs ("\\n", stream
);
1423 do_fputs ("\\b", stream
);
1426 do_fputs ("\\t", stream
);
1429 do_fputs ("\\f", stream
);
1432 do_fputs ("\\r", stream
);
1435 do_fputs ("\\e", stream
);
1438 do_fputs ("\\a", stream
);
1441 do_fprintf (stream
, "\\%.3o", (unsigned int) c
);
1447 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1448 do_fputs ("\\", stream
);
1449 do_fprintf (stream
, "%c", c
);
1453 /* Print the character C on STREAM as part of the contents of a
1454 literal string whose delimiter is QUOTER. Note that these routines
1455 should only be call for printing things which are independent of
1456 the language of the program being debugged. */
1459 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1462 printchar (*str
++, fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1466 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1469 printchar (*str
++, fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1473 fputstrn_filtered (const char *str
, int n
, int quoter
,
1474 struct ui_file
*stream
)
1478 for (i
= 0; i
< n
; i
++)
1479 printchar (str
[i
], fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1483 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1484 struct ui_file
*stream
)
1488 for (i
= 0; i
< n
; i
++)
1489 printchar (str
[i
], fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1493 /* Number of lines per page or UINT_MAX if paging is disabled. */
1494 static unsigned int lines_per_page
;
1496 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1497 struct cmd_list_element
*c
, const char *value
)
1499 fprintf_filtered (file
,
1500 _("Number of lines gdb thinks are in a page is %s.\n"),
1504 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1505 static unsigned int chars_per_line
;
1507 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1508 struct cmd_list_element
*c
, const char *value
)
1510 fprintf_filtered (file
,
1511 _("Number of characters gdb thinks "
1512 "are in a line is %s.\n"),
1516 /* Current count of lines printed on this page, chars on this line. */
1517 static unsigned int lines_printed
, chars_printed
;
1519 /* Buffer and start column of buffered text, for doing smarter word-
1520 wrapping. When someone calls wrap_here(), we start buffering output
1521 that comes through fputs_filtered(). If we see a newline, we just
1522 spit it out and forget about the wrap_here(). If we see another
1523 wrap_here(), we spit it out and remember the newer one. If we see
1524 the end of the line, we spit out a newline, the indent, and then
1525 the buffered output. */
1527 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1528 are waiting to be output (they have already been counted in chars_printed).
1529 When wrap_buffer[0] is null, the buffer is empty. */
1530 static char *wrap_buffer
;
1532 /* Pointer in wrap_buffer to the next character to fill. */
1533 static char *wrap_pointer
;
1535 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1537 static const char *wrap_indent
;
1539 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1540 is not in effect. */
1541 static int wrap_column
;
1544 /* Initialize the number of lines per page and chars per line. */
1547 init_page_info (void)
1551 lines_per_page
= UINT_MAX
;
1552 chars_per_line
= UINT_MAX
;
1556 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1561 #if defined(__GO32__)
1562 rows
= ScreenRows ();
1563 cols
= ScreenCols ();
1564 lines_per_page
= rows
;
1565 chars_per_line
= cols
;
1567 /* Make sure Readline has initialized its terminal settings. */
1568 rl_reset_terminal (NULL
);
1570 /* Get the screen size from Readline. */
1571 rl_get_screen_size (&rows
, &cols
);
1572 lines_per_page
= rows
;
1573 chars_per_line
= cols
;
1575 /* Readline should have fetched the termcap entry for us.
1576 Only try to use tgetnum function if rl_get_screen_size
1577 did not return a useful value. */
1578 if (((rows
<= 0) && (tgetnum ((char *) "li") < 0))
1579 /* Also disable paging if inside Emacs. $EMACS was used
1580 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1581 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1583 /* The number of lines per page is not mentioned in the terminal
1584 description or EMACS evironment variable is set. This probably
1585 means that paging is not useful, so disable paging. */
1586 lines_per_page
= UINT_MAX
;
1589 /* If the output is not a terminal, don't paginate it. */
1590 if (!ui_file_isatty (gdb_stdout
))
1591 lines_per_page
= UINT_MAX
;
1595 /* We handle SIGWINCH ourselves. */
1596 rl_catch_sigwinch
= 0;
1602 /* Return nonzero if filtered printing is initialized. */
1604 filtered_printing_initialized (void)
1606 return wrap_buffer
!= NULL
;
1609 /* Helper for make_cleanup_restore_page_info. */
1612 do_restore_page_info_cleanup (void *arg
)
1618 /* Provide cleanup for restoring the terminal size. */
1621 make_cleanup_restore_page_info (void)
1623 struct cleanup
*back_to
;
1625 back_to
= make_cleanup (do_restore_page_info_cleanup
, NULL
);
1626 make_cleanup_restore_uinteger (&lines_per_page
);
1627 make_cleanup_restore_uinteger (&chars_per_line
);
1632 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1633 Provide cleanup for restoring the original state. */
1636 set_batch_flag_and_make_cleanup_restore_page_info (void)
1638 struct cleanup
*back_to
= make_cleanup_restore_page_info ();
1640 make_cleanup_restore_integer (&batch_flag
);
1647 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1650 set_screen_size (void)
1652 int rows
= lines_per_page
;
1653 int cols
= chars_per_line
;
1661 /* Update Readline's idea of the terminal size. */
1662 rl_set_screen_size (rows
, cols
);
1665 /* Reinitialize WRAP_BUFFER according to the current value of
1671 if (chars_per_line
== 0)
1676 wrap_buffer
= (char *) xmalloc (chars_per_line
+ 2);
1677 wrap_buffer
[0] = '\0';
1680 wrap_buffer
= (char *) xrealloc (wrap_buffer
, chars_per_line
+ 2);
1681 wrap_pointer
= wrap_buffer
; /* Start it at the beginning. */
1685 set_width_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1692 set_height_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1700 set_screen_width_and_height (int width
, int height
)
1702 lines_per_page
= height
;
1703 chars_per_line
= width
;
1709 /* Wait, so the user can read what's on the screen. Prompt the user
1710 to continue by pressing RETURN. 'q' is also provided because
1711 telling users what to do in the prompt is more user-friendly than
1712 expecting them to think of Ctrl-C/SIGINT. */
1715 prompt_for_continue (void)
1718 char cont_prompt
[120];
1719 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
1720 /* Used to add duration we waited for user to respond to
1721 prompt_for_continue_wait_time. */
1722 using namespace std::chrono
;
1723 steady_clock::time_point prompt_started
= steady_clock::now ();
1725 if (annotation_level
> 1)
1726 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1728 strcpy (cont_prompt
,
1729 "---Type <return> to continue, or q <return> to quit---");
1730 if (annotation_level
> 1)
1731 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1733 /* We must do this *before* we call gdb_readline_wrapper, else it
1734 will eventually call us -- thinking that we're trying to print
1735 beyond the end of the screen. */
1736 reinitialize_more_filter ();
1738 prepare_to_handle_input ();
1740 /* Call gdb_readline_wrapper, not readline, in order to keep an
1741 event loop running. */
1742 ignore
= gdb_readline_wrapper (cont_prompt
);
1743 make_cleanup (xfree
, ignore
);
1745 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1746 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1748 if (annotation_level
> 1)
1749 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1755 while (*p
== ' ' || *p
== '\t')
1758 /* Do not call quit here; there is no possibility of SIGINT. */
1759 throw_quit ("Quit");
1762 /* Now we have to do this again, so that GDB will know that it doesn't
1763 need to save the ---Type <return>--- line at the top of the screen. */
1764 reinitialize_more_filter ();
1766 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1768 do_cleanups (old_chain
);
1771 /* Initialize timer to keep track of how long we waited for the user. */
1774 reset_prompt_for_continue_wait_time (void)
1776 using namespace std::chrono
;
1778 prompt_for_continue_wait_time
= steady_clock::duration::zero ();
1781 /* Fetch the cumulative time spent in prompt_for_continue. */
1783 std::chrono::steady_clock::duration
1784 get_prompt_for_continue_wait_time ()
1786 return prompt_for_continue_wait_time
;
1789 /* Reinitialize filter; ie. tell it to reset to original values. */
1792 reinitialize_more_filter (void)
1798 /* Indicate that if the next sequence of characters overflows the line,
1799 a newline should be inserted here rather than when it hits the end.
1800 If INDENT is non-null, it is a string to be printed to indent the
1801 wrapped part on the next line. INDENT must remain accessible until
1802 the next call to wrap_here() or until a newline is printed through
1805 If the line is already overfull, we immediately print a newline and
1806 the indentation, and disable further wrapping.
1808 If we don't know the width of lines, but we know the page height,
1809 we must not wrap words, but should still keep track of newlines
1810 that were explicitly printed.
1812 INDENT should not contain tabs, as that will mess up the char count
1813 on the next line. FIXME.
1815 This routine is guaranteed to force out any output which has been
1816 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1817 used to force out output from the wrap_buffer. */
1820 wrap_here (const char *indent
)
1822 /* This should have been allocated, but be paranoid anyway. */
1824 internal_error (__FILE__
, __LINE__
,
1825 _("failed internal consistency check"));
1829 *wrap_pointer
= '\0';
1830 fputs_unfiltered (wrap_buffer
, gdb_stdout
);
1832 wrap_pointer
= wrap_buffer
;
1833 wrap_buffer
[0] = '\0';
1834 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1838 else if (chars_printed
>= chars_per_line
)
1840 puts_filtered ("\n");
1842 puts_filtered (indent
);
1847 wrap_column
= chars_printed
;
1851 wrap_indent
= indent
;
1855 /* Print input string to gdb_stdout, filtered, with wrap,
1856 arranging strings in columns of n chars. String can be
1857 right or left justified in the column. Never prints
1858 trailing spaces. String should never be longer than
1859 width. FIXME: this could be useful for the EXAMINE
1860 command, which currently doesn't tabulate very well. */
1863 puts_filtered_tabular (char *string
, int width
, int right
)
1869 gdb_assert (chars_per_line
> 0);
1870 if (chars_per_line
== UINT_MAX
)
1872 fputs_filtered (string
, gdb_stdout
);
1873 fputs_filtered ("\n", gdb_stdout
);
1877 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1878 fputs_filtered ("\n", gdb_stdout
);
1880 if (width
>= chars_per_line
)
1881 width
= chars_per_line
- 1;
1883 stringlen
= strlen (string
);
1885 if (chars_printed
> 0)
1886 spaces
= width
- (chars_printed
- 1) % width
- 1;
1888 spaces
+= width
- stringlen
;
1890 spacebuf
= (char *) alloca (spaces
+ 1);
1891 spacebuf
[spaces
] = '\0';
1893 spacebuf
[spaces
] = ' ';
1895 fputs_filtered (spacebuf
, gdb_stdout
);
1896 fputs_filtered (string
, gdb_stdout
);
1900 /* Ensure that whatever gets printed next, using the filtered output
1901 commands, starts at the beginning of the line. I.e. if there is
1902 any pending output for the current line, flush it and start a new
1903 line. Otherwise do nothing. */
1908 if (chars_printed
> 0)
1910 puts_filtered ("\n");
1915 /* Like fputs but if FILTER is true, pause after every screenful.
1917 Regardless of FILTER can wrap at points other than the final
1918 character of a line.
1920 Unlike fputs, fputs_maybe_filtered does not return a value.
1921 It is OK for LINEBUFFER to be NULL, in which case just don't print
1924 Note that a longjmp to top level may occur in this routine (only if
1925 FILTER is true) (since prompt_for_continue may do so) so this
1926 routine should not be called when cleanups are not in place. */
1929 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1932 const char *lineptr
;
1934 if (linebuffer
== 0)
1937 /* Don't do any filtering if it is disabled. */
1938 if (stream
!= gdb_stdout
1939 || !pagination_enabled
1941 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
1942 || top_level_interpreter () == NULL
1943 || interp_ui_out (top_level_interpreter ())->is_mi_like_p ())
1945 fputs_unfiltered (linebuffer
, stream
);
1949 /* Go through and output each character. Show line extension
1950 when this is necessary; prompt user for new page when this is
1953 lineptr
= linebuffer
;
1956 /* Possible new page. */
1957 if (filter
&& (lines_printed
>= lines_per_page
- 1))
1958 prompt_for_continue ();
1960 while (*lineptr
&& *lineptr
!= '\n')
1962 /* Print a single line. */
1963 if (*lineptr
== '\t')
1966 *wrap_pointer
++ = '\t';
1968 fputc_unfiltered ('\t', stream
);
1969 /* Shifting right by 3 produces the number of tab stops
1970 we have already passed, and then adding one and
1971 shifting left 3 advances to the next tab stop. */
1972 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
1978 *wrap_pointer
++ = *lineptr
;
1980 fputc_unfiltered (*lineptr
, stream
);
1985 if (chars_printed
>= chars_per_line
)
1987 unsigned int save_chars
= chars_printed
;
1991 /* If we aren't actually wrapping, don't output newline --
1992 if chars_per_line is right, we probably just overflowed
1993 anyway; if it's wrong, let us keep going. */
1995 fputc_unfiltered ('\n', stream
);
1997 /* Possible new page. */
1998 if (lines_printed
>= lines_per_page
- 1)
1999 prompt_for_continue ();
2001 /* Now output indentation and wrapped string. */
2004 fputs_unfiltered (wrap_indent
, stream
);
2005 *wrap_pointer
= '\0'; /* Null-terminate saved stuff, */
2006 fputs_unfiltered (wrap_buffer
, stream
); /* and eject it. */
2007 /* FIXME, this strlen is what prevents wrap_indent from
2008 containing tabs. However, if we recurse to print it
2009 and count its chars, we risk trouble if wrap_indent is
2010 longer than (the user settable) chars_per_line.
2011 Note also that this can set chars_printed > chars_per_line
2012 if we are printing a long string. */
2013 chars_printed
= strlen (wrap_indent
)
2014 + (save_chars
- wrap_column
);
2015 wrap_pointer
= wrap_buffer
; /* Reset buffer */
2016 wrap_buffer
[0] = '\0';
2017 wrap_column
= 0; /* And disable fancy wrap */
2022 if (*lineptr
== '\n')
2025 wrap_here ((char *) 0); /* Spit out chars, cancel
2028 fputc_unfiltered ('\n', stream
);
2035 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
2037 fputs_maybe_filtered (linebuffer
, stream
, 1);
2041 putchar_unfiltered (int c
)
2045 ui_file_write (gdb_stdout
, &buf
, 1);
2049 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2050 May return nonlocally. */
2053 putchar_filtered (int c
)
2055 return fputc_filtered (c
, gdb_stdout
);
2059 fputc_unfiltered (int c
, struct ui_file
*stream
)
2063 ui_file_write (stream
, &buf
, 1);
2068 fputc_filtered (int c
, struct ui_file
*stream
)
2074 fputs_filtered (buf
, stream
);
2078 /* puts_debug is like fputs_unfiltered, except it prints special
2079 characters in printable fashion. */
2082 puts_debug (char *prefix
, char *string
, char *suffix
)
2086 /* Print prefix and suffix after each line. */
2087 static int new_line
= 1;
2088 static int return_p
= 0;
2089 static const char *prev_prefix
= "";
2090 static const char *prev_suffix
= "";
2092 if (*string
== '\n')
2095 /* If the prefix is changing, print the previous suffix, a new line,
2096 and the new prefix. */
2097 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
2099 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
2100 fputs_unfiltered ("\n", gdb_stdlog
);
2101 fputs_unfiltered (prefix
, gdb_stdlog
);
2104 /* Print prefix if we printed a newline during the previous call. */
2108 fputs_unfiltered (prefix
, gdb_stdlog
);
2111 prev_prefix
= prefix
;
2112 prev_suffix
= suffix
;
2114 /* Output characters in a printable format. */
2115 while ((ch
= *string
++) != '\0')
2121 fputc_unfiltered (ch
, gdb_stdlog
);
2124 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2128 fputs_unfiltered ("\\\\", gdb_stdlog
);
2131 fputs_unfiltered ("\\b", gdb_stdlog
);
2134 fputs_unfiltered ("\\f", gdb_stdlog
);
2138 fputs_unfiltered ("\\n", gdb_stdlog
);
2141 fputs_unfiltered ("\\r", gdb_stdlog
);
2144 fputs_unfiltered ("\\t", gdb_stdlog
);
2147 fputs_unfiltered ("\\v", gdb_stdlog
);
2151 return_p
= ch
== '\r';
2154 /* Print suffix if we printed a newline. */
2157 fputs_unfiltered (suffix
, gdb_stdlog
);
2158 fputs_unfiltered ("\n", gdb_stdlog
);
2163 /* Print a variable number of ARGS using format FORMAT. If this
2164 information is going to put the amount written (since the last call
2165 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2166 call prompt_for_continue to get the users permision to continue.
2168 Unlike fprintf, this function does not return a value.
2170 We implement three variants, vfprintf (takes a vararg list and stream),
2171 fprintf (takes a stream to write on), and printf (the usual).
2173 Note also that a longjmp to top level may occur in this routine
2174 (since prompt_for_continue may do so) so this routine should not be
2175 called when cleanups are not in place. */
2178 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2179 va_list args
, int filter
)
2182 struct cleanup
*old_cleanups
;
2184 linebuffer
= xstrvprintf (format
, args
);
2185 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2186 fputs_maybe_filtered (linebuffer
, stream
, filter
);
2187 do_cleanups (old_cleanups
);
2192 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2194 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2198 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2201 struct cleanup
*old_cleanups
;
2203 linebuffer
= xstrvprintf (format
, args
);
2204 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2205 if (debug_timestamp
&& stream
== gdb_stdlog
)
2207 using namespace std::chrono
;
2210 steady_clock::time_point now
= steady_clock::now ();
2211 seconds s
= duration_cast
<seconds
> (now
.time_since_epoch ());
2212 microseconds us
= duration_cast
<microseconds
> (now
.time_since_epoch () - s
);
2214 len
= strlen (linebuffer
);
2215 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2217 std::string timestamp
= string_printf ("%ld.%06ld %s%s",
2220 linebuffer
, need_nl
? "\n": "");
2221 fputs_unfiltered (timestamp
.c_str (), stream
);
2224 fputs_unfiltered (linebuffer
, stream
);
2225 do_cleanups (old_cleanups
);
2229 vprintf_filtered (const char *format
, va_list args
)
2231 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2235 vprintf_unfiltered (const char *format
, va_list args
)
2237 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2241 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2245 va_start (args
, format
);
2246 vfprintf_filtered (stream
, format
, args
);
2251 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2255 va_start (args
, format
);
2256 vfprintf_unfiltered (stream
, format
, args
);
2260 /* Like fprintf_filtered, but prints its result indented.
2261 Called as fprintfi_filtered (spaces, stream, format, ...); */
2264 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2269 va_start (args
, format
);
2270 print_spaces_filtered (spaces
, stream
);
2272 vfprintf_filtered (stream
, format
, args
);
2278 printf_filtered (const char *format
, ...)
2282 va_start (args
, format
);
2283 vfprintf_filtered (gdb_stdout
, format
, args
);
2289 printf_unfiltered (const char *format
, ...)
2293 va_start (args
, format
);
2294 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2298 /* Like printf_filtered, but prints it's result indented.
2299 Called as printfi_filtered (spaces, format, ...); */
2302 printfi_filtered (int spaces
, const char *format
, ...)
2306 va_start (args
, format
);
2307 print_spaces_filtered (spaces
, gdb_stdout
);
2308 vfprintf_filtered (gdb_stdout
, format
, args
);
2312 /* Easy -- but watch out!
2314 This routine is *not* a replacement for puts()! puts() appends a newline.
2315 This one doesn't, and had better not! */
2318 puts_filtered (const char *string
)
2320 fputs_filtered (string
, gdb_stdout
);
2324 puts_unfiltered (const char *string
)
2326 fputs_unfiltered (string
, gdb_stdout
);
2329 /* Return a pointer to N spaces and a null. The pointer is good
2330 until the next call to here. */
2335 static char *spaces
= 0;
2336 static int max_spaces
= -1;
2342 spaces
= (char *) xmalloc (n
+ 1);
2343 for (t
= spaces
+ n
; t
!= spaces
;)
2349 return spaces
+ max_spaces
- n
;
2352 /* Print N spaces. */
2354 print_spaces_filtered (int n
, struct ui_file
*stream
)
2356 fputs_filtered (n_spaces (n
), stream
);
2359 /* C++/ObjC demangler stuff. */
2361 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2362 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2363 If the name is not mangled, or the language for the name is unknown, or
2364 demangling is off, the name is printed in its "raw" form. */
2367 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2368 enum language lang
, int arg_mode
)
2374 /* If user wants to see raw output, no problem. */
2377 fputs_filtered (name
, stream
);
2381 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2382 fputs_filtered (demangled
? demangled
: name
, stream
);
2383 if (demangled
!= NULL
)
2391 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2392 differences in whitespace. Returns 0 if they match, non-zero if they
2393 don't (slightly different than strcmp()'s range of return values).
2395 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2396 This "feature" is useful when searching for matching C++ function names
2397 (such as if the user types 'break FOO', where FOO is a mangled C++
2401 strcmp_iw (const char *string1
, const char *string2
)
2403 while ((*string1
!= '\0') && (*string2
!= '\0'))
2405 while (isspace (*string1
))
2409 while (isspace (*string2
))
2413 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2415 if (case_sensitivity
== case_sensitive_off
2416 && (tolower ((unsigned char) *string1
)
2417 != tolower ((unsigned char) *string2
)))
2419 if (*string1
!= '\0')
2425 return (*string1
!= '\0' && *string1
!= '(') || (*string2
!= '\0');
2428 /* This is like strcmp except that it ignores whitespace and treats
2429 '(' as the first non-NULL character in terms of ordering. Like
2430 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2431 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2432 according to that ordering.
2434 If a list is sorted according to this function and if you want to
2435 find names in the list that match some fixed NAME according to
2436 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2437 where this function would put NAME.
2439 This function must be neutral to the CASE_SENSITIVITY setting as the user
2440 may choose it during later lookup. Therefore this function always sorts
2441 primarily case-insensitively and secondarily case-sensitively.
2443 Here are some examples of why using strcmp to sort is a bad idea:
2447 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2448 we try to do a search for "foo<char*>", strcmp will locate this
2449 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2450 will start looking at strings beginning with "goo", and will never
2451 see the correct match of "foo<char *>".
2453 Parenthesis example:
2455 In practice, this is less like to be an issue, but I'll give it a
2456 shot. Let's assume that '$' is a legitimate character to occur in
2457 symbols. (Which may well even be the case on some systems.) Then
2458 say that the partial symbol table contains "foo$" and "foo(int)".
2459 strcmp will put them in this order, since '$' < '('. Now, if the
2460 user searches for "foo", then strcmp will sort "foo" before "foo$".
2461 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2462 "foo") is false, so it won't proceed to the actual match of
2463 "foo(int)" with "foo". */
2466 strcmp_iw_ordered (const char *string1
, const char *string2
)
2468 const char *saved_string1
= string1
, *saved_string2
= string2
;
2469 enum case_sensitivity case_pass
= case_sensitive_off
;
2473 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2474 Provide stub characters if we are already at the end of one of the
2476 char c1
= 'X', c2
= 'X';
2478 while (*string1
!= '\0' && *string2
!= '\0')
2480 while (isspace (*string1
))
2482 while (isspace (*string2
))
2487 case case_sensitive_off
:
2488 c1
= tolower ((unsigned char) *string1
);
2489 c2
= tolower ((unsigned char) *string2
);
2491 case case_sensitive_on
:
2499 if (*string1
!= '\0')
2508 /* Characters are non-equal unless they're both '\0'; we want to
2509 make sure we get the comparison right according to our
2510 comparison in the cases where one of them is '\0' or '('. */
2512 if (*string2
== '\0')
2517 if (*string2
== '\0')
2522 if (*string2
== '\0' || *string2
== '(')
2531 if (case_pass
== case_sensitive_on
)
2534 /* Otherwise the strings were equal in case insensitive way, make
2535 a more fine grained comparison in a case sensitive way. */
2537 case_pass
= case_sensitive_on
;
2538 string1
= saved_string1
;
2539 string2
= saved_string2
;
2543 /* A simple comparison function with opposite semantics to strcmp. */
2546 streq (const char *lhs
, const char *rhs
)
2548 return !strcmp (lhs
, rhs
);
2554 ** Answer whether string_to_compare is a full or partial match to
2555 ** template_string. The partial match must be in sequence starting
2559 subset_compare (const char *string_to_compare
, const char *template_string
)
2563 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
2564 && strlen (string_to_compare
) <= strlen (template_string
))
2566 (startswith (template_string
, string_to_compare
));
2573 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2574 struct cmd_list_element
*c
, const char *value
)
2576 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2582 initialize_utils (void)
2584 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
2585 Set number of characters where GDB should wrap lines of its output."), _("\
2586 Show number of characters where GDB should wrap lines of its output."), _("\
2587 This affects where GDB wraps its output to fit the screen width.\n\
2588 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2590 show_chars_per_line
,
2591 &setlist
, &showlist
);
2593 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
2594 Set number of lines in a page for GDB output pagination."), _("\
2595 Show number of lines in a page for GDB output pagination."), _("\
2596 This affects the number of lines after which GDB will pause\n\
2597 its output and ask you whether to continue.\n\
2598 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2600 show_lines_per_page
,
2601 &setlist
, &showlist
);
2603 add_setshow_boolean_cmd ("pagination", class_support
,
2604 &pagination_enabled
, _("\
2605 Set state of GDB output pagination."), _("\
2606 Show state of GDB output pagination."), _("\
2607 When pagination is ON, GDB pauses at end of each screenful of\n\
2608 its output and asks you whether to continue.\n\
2609 Turning pagination off is an alternative to \"set height unlimited\"."),
2611 show_pagination_enabled
,
2612 &setlist
, &showlist
);
2614 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
2615 &sevenbit_strings
, _("\
2616 Set printing of 8-bit characters in strings as \\nnn."), _("\
2617 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
2619 show_sevenbit_strings
,
2620 &setprintlist
, &showprintlist
);
2622 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
2623 &debug_timestamp
, _("\
2624 Set timestamping of debugging messages."), _("\
2625 Show timestamping of debugging messages."), _("\
2626 When set, debugging messages will be marked with seconds and microseconds."),
2628 show_debug_timestamp
,
2629 &setdebuglist
, &showdebuglist
);
2633 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2635 /* Truncate address to the size of a target address, avoiding shifts
2636 larger or equal than the width of a CORE_ADDR. The local
2637 variable ADDR_BIT stops the compiler reporting a shift overflow
2638 when it won't occur. */
2639 /* NOTE: This assumes that the significant address information is
2640 kept in the least significant bits of ADDR - the upper bits were
2641 either zero or sign extended. Should gdbarch_address_to_pointer or
2642 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2644 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2646 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2647 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2648 return hex_string (addr
);
2651 /* This function is described in "defs.h". */
2654 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2656 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2658 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2659 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2661 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2662 that returns the language localized string formatted to a width
2663 based on gdbarch_addr_bit. */
2665 return hex_string_custom (address
, 8);
2667 return hex_string_custom (address
, 16);
2670 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2673 core_addr_hash (const void *ap
)
2675 const CORE_ADDR
*addrp
= (const CORE_ADDR
*) ap
;
2680 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2683 core_addr_eq (const void *ap
, const void *bp
)
2685 const CORE_ADDR
*addr_ap
= (const CORE_ADDR
*) ap
;
2686 const CORE_ADDR
*addr_bp
= (const CORE_ADDR
*) bp
;
2688 return *addr_ap
== *addr_bp
;
2691 /* Convert a string back into a CORE_ADDR. */
2693 string_to_core_addr (const char *my_string
)
2697 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2699 /* Assume that it is in hex. */
2702 for (i
= 2; my_string
[i
] != '\0'; i
++)
2704 if (isdigit (my_string
[i
]))
2705 addr
= (my_string
[i
] - '0') + (addr
* 16);
2706 else if (isxdigit (my_string
[i
]))
2707 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2709 error (_("invalid hex \"%s\""), my_string
);
2714 /* Assume that it is in decimal. */
2717 for (i
= 0; my_string
[i
] != '\0'; i
++)
2719 if (isdigit (my_string
[i
]))
2720 addr
= (my_string
[i
] - '0') + (addr
* 10);
2722 error (_("invalid decimal \"%s\""), my_string
);
2730 gdb_realpath (const char *filename
)
2732 /* On most hosts, we rely on canonicalize_file_name to compute
2733 the FILENAME's realpath.
2735 But the situation is slightly more complex on Windows, due to some
2736 versions of GCC which were reported to generate paths where
2737 backlashes (the directory separator) were doubled. For instance:
2738 c:\\some\\double\\slashes\\dir
2740 c:\some\double\slashes\dir
2741 Those double-slashes were getting in the way when comparing paths,
2742 for instance when trying to insert a breakpoint as follow:
2743 (gdb) b c:/some/double/slashes/dir/foo.c:4
2744 No source file named c:/some/double/slashes/dir/foo.c:4.
2745 (gdb) b c:\some\double\slashes\dir\foo.c:4
2746 No source file named c:\some\double\slashes\dir\foo.c:4.
2747 To prevent this from happening, we need this function to always
2748 strip those extra backslashes. While canonicalize_file_name does
2749 perform this simplification, it only works when the path is valid.
2750 Since the simplification would be useful even if the path is not
2751 valid (one can always set a breakpoint on a file, even if the file
2752 does not exist locally), we rely instead on GetFullPathName to
2753 perform the canonicalization. */
2755 #if defined (_WIN32)
2758 DWORD len
= GetFullPathName (filename
, MAX_PATH
, buf
, NULL
);
2760 /* The file system is case-insensitive but case-preserving.
2761 So it is important we do not lowercase the path. Otherwise,
2762 we might not be able to display the original casing in a given
2764 if (len
> 0 && len
< MAX_PATH
)
2765 return xstrdup (buf
);
2769 char *rp
= canonicalize_file_name (filename
);
2776 /* This system is a lost cause, just dup the buffer. */
2777 return xstrdup (filename
);
2780 /* Return a copy of FILENAME, with its directory prefix canonicalized
2784 gdb_realpath_keepfile (const char *filename
)
2786 const char *base_name
= lbasename (filename
);
2791 /* Extract the basename of filename, and return immediately
2792 a copy of filename if it does not contain any directory prefix. */
2793 if (base_name
== filename
)
2794 return xstrdup (filename
);
2796 dir_name
= (char *) alloca ((size_t) (base_name
- filename
+ 2));
2797 /* Allocate enough space to store the dir_name + plus one extra
2798 character sometimes needed under Windows (see below), and
2799 then the closing \000 character. */
2800 strncpy (dir_name
, filename
, base_name
- filename
);
2801 dir_name
[base_name
- filename
] = '\000';
2803 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
2804 /* We need to be careful when filename is of the form 'd:foo', which
2805 is equivalent of d:./foo, which is totally different from d:/foo. */
2806 if (strlen (dir_name
) == 2 && isalpha (dir_name
[0]) && dir_name
[1] == ':')
2809 dir_name
[3] = '\000';
2813 /* Canonicalize the directory prefix, and build the resulting
2814 filename. If the dirname realpath already contains an ending
2815 directory separator, avoid doubling it. */
2816 real_path
= gdb_realpath (dir_name
);
2817 if (IS_DIR_SEPARATOR (real_path
[strlen (real_path
) - 1]))
2818 result
= concat (real_path
, base_name
, (char *) NULL
);
2820 result
= concat (real_path
, SLASH_STRING
, base_name
, (char *) NULL
);
2826 /* Return PATH in absolute form, performing tilde-expansion if necessary.
2827 PATH cannot be NULL or the empty string.
2828 This does not resolve symlinks however, use gdb_realpath for that.
2829 Space for the result is allocated with malloc.
2830 If the path is already absolute, it is strdup'd.
2831 If there is a problem computing the absolute path, the path is returned
2832 unchanged (still strdup'd). */
2835 gdb_abspath (const char *path
)
2837 gdb_assert (path
!= NULL
&& path
[0] != '\0');
2840 return tilde_expand (path
);
2842 if (IS_ABSOLUTE_PATH (path
))
2843 return xstrdup (path
);
2845 /* Beware the // my son, the Emacs barfs, the botch that catch... */
2846 return concat (current_directory
,
2847 IS_DIR_SEPARATOR (current_directory
[strlen (current_directory
) - 1])
2848 ? "" : SLASH_STRING
,
2849 path
, (char *) NULL
);
2853 align_up (ULONGEST v
, int n
)
2855 /* Check that N is really a power of two. */
2856 gdb_assert (n
&& (n
& (n
-1)) == 0);
2857 return (v
+ n
- 1) & -n
;
2861 align_down (ULONGEST v
, int n
)
2863 /* Check that N is really a power of two. */
2864 gdb_assert (n
&& (n
& (n
-1)) == 0);
2868 /* Allocation function for the libiberty hash table which uses an
2869 obstack. The obstack is passed as DATA. */
2872 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
2874 size_t total
= size
* count
;
2875 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
2877 memset (ptr
, 0, total
);
2881 /* Trivial deallocation function for the libiberty splay tree and hash
2882 table - don't deallocate anything. Rely on later deletion of the
2883 obstack. DATA will be the obstack, although it is not needed
2887 dummy_obstack_deallocate (void *object
, void *data
)
2892 /* Simple, portable version of dirname that does not modify its
2896 ldirname (const char *filename
)
2898 std::string dirname
;
2899 const char *base
= lbasename (filename
);
2901 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
2904 if (base
== filename
)
2907 dirname
= std::string (filename
, base
- filename
);
2909 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
2910 create "d:./bar" later instead of the (different) "d:/bar". */
2911 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
2912 && !IS_DIR_SEPARATOR (filename
[0]))
2913 dirname
[base
++ - filename
] = '.';
2918 /* Call libiberty's buildargv, and return the result.
2919 If buildargv fails due to out-of-memory, call nomem.
2920 Therefore, the returned value is guaranteed to be non-NULL,
2921 unless the parameter itself is NULL. */
2924 gdb_buildargv (const char *s
)
2926 char **argv
= buildargv (s
);
2928 if (s
!= NULL
&& argv
== NULL
)
2934 compare_positive_ints (const void *ap
, const void *bp
)
2936 /* Because we know we're comparing two ints which are positive,
2937 there's no danger of overflow here. */
2938 return * (int *) ap
- * (int *) bp
;
2941 /* String compare function for qsort. */
2944 compare_strings (const void *arg1
, const void *arg2
)
2946 const char **s1
= (const char **) arg1
;
2947 const char **s2
= (const char **) arg2
;
2949 return strcmp (*s1
, *s2
);
2952 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
2953 #define AMBIGUOUS_MESS2 \
2954 ".\nUse \"set gnutarget format-name\" to specify the format."
2957 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
2963 /* Check if errmsg just need simple return. */
2964 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
2965 return bfd_errmsg (error_tag
);
2967 ret_len
= strlen (bfd_errmsg (error_tag
)) + strlen (AMBIGUOUS_MESS1
)
2968 + strlen (AMBIGUOUS_MESS2
);
2969 for (p
= matching
; *p
; p
++)
2970 ret_len
+= strlen (*p
) + 1;
2971 ret
= (char *) xmalloc (ret_len
+ 1);
2973 make_cleanup (xfree
, ret
);
2975 strcpy (retp
, bfd_errmsg (error_tag
));
2976 retp
+= strlen (retp
);
2978 strcpy (retp
, AMBIGUOUS_MESS1
);
2979 retp
+= strlen (retp
);
2981 for (p
= matching
; *p
; p
++)
2983 sprintf (retp
, " %s", *p
);
2984 retp
+= strlen (retp
);
2988 strcpy (retp
, AMBIGUOUS_MESS2
);
2993 /* Return ARGS parsed as a valid pid, or throw an error. */
2996 parse_pid_to_attach (const char *args
)
3002 error_no_arg (_("process-id to attach"));
3004 dummy
= (char *) args
;
3005 pid
= strtoul (args
, &dummy
, 0);
3006 /* Some targets don't set errno on errors, grrr! */
3007 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3008 error (_("Illegal process-id: %s."), args
);
3013 /* Helper for make_bpstat_clear_actions_cleanup. */
3016 do_bpstat_clear_actions_cleanup (void *unused
)
3018 bpstat_clear_actions ();
3021 /* Call bpstat_clear_actions for the case an exception is throw. You should
3022 discard_cleanups if no exception is caught. */
3025 make_bpstat_clear_actions_cleanup (void)
3027 return make_cleanup (do_bpstat_clear_actions_cleanup
, NULL
);
3030 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3031 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3032 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3035 producer_is_gcc_ge_4 (const char *producer
)
3039 if (! producer_is_gcc (producer
, &major
, &minor
))
3048 /* Returns nonzero if the given PRODUCER string is GCC and sets the MAJOR
3049 and MINOR versions when not NULL. Returns zero if the given PRODUCER
3050 is NULL or it isn't GCC. */
3053 producer_is_gcc (const char *producer
, int *major
, int *minor
)
3057 if (producer
!= NULL
&& startswith (producer
, "GNU "))
3066 /* Skip any identifier after "GNU " - such as "C11" or "C++".
3067 A full producer string might look like:
3069 "GNU Fortran 4.8.2 20140120 (Red Hat 4.8.2-16) -mtune=generic ..."
3070 "GNU C++14 5.0.0 20150123 (experimental)"
3072 cs
= &producer
[strlen ("GNU ")];
3073 while (*cs
&& !isspace (*cs
))
3075 if (*cs
&& isspace (*cs
))
3077 if (sscanf (cs
, "%d.%d", major
, minor
) == 2)
3081 /* Not recognized as GCC. */
3085 /* Helper for make_cleanup_free_char_ptr_vec. */
3088 do_free_char_ptr_vec (void *arg
)
3090 VEC (char_ptr
) *char_ptr_vec
= (VEC (char_ptr
) *) arg
;
3092 free_char_ptr_vec (char_ptr_vec
);
3095 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3096 final VEC_free for CHAR_PTR_VEC itself.
3098 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3099 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3100 this function does not (cannot) clear the pointer. */
3103 make_cleanup_free_char_ptr_vec (VEC (char_ptr
) *char_ptr_vec
)
3105 return make_cleanup (do_free_char_ptr_vec
, char_ptr_vec
);
3108 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3109 must come from xrealloc-compatible allocator and it may be updated. FROM
3110 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3111 located at the start or end of *STRINGP. */
3114 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3116 char *string
= *stringp
, *s
;
3117 const size_t from_len
= strlen (from
);
3118 const size_t to_len
= strlen (to
);
3122 s
= strstr (s
, from
);
3126 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3127 || s
[-1] == DIRNAME_SEPARATOR
)
3128 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3129 || s
[from_len
] == DIRNAME_SEPARATOR
))
3134 = (char *) xrealloc (string
, (strlen (string
) + to_len
+ 1));
3136 /* Relocate the current S pointer. */
3137 s
= s
- string
+ string_new
;
3138 string
= string_new
;
3140 /* Replace from by to. */
3141 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3142 memcpy (s
, to
, to_len
);
3157 /* SIGALRM handler for waitpid_with_timeout. */
3160 sigalrm_handler (int signo
)
3162 /* Nothing to do. */
3167 /* Wrapper to wait for child PID to die with TIMEOUT.
3168 TIMEOUT is the time to stop waiting in seconds.
3169 If TIMEOUT is zero, pass WNOHANG to waitpid.
3170 Returns PID if it was successfully waited for, otherwise -1.
3172 Timeouts are currently implemented with alarm and SIGALRM.
3173 If the host does not support them, this waits "forever".
3174 It would be odd though for a host to have waitpid and not SIGALRM. */
3177 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3179 pid_t waitpid_result
;
3181 gdb_assert (pid
> 0);
3182 gdb_assert (timeout
>= 0);
3187 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3188 struct sigaction sa
, old_sa
;
3190 sa
.sa_handler
= sigalrm_handler
;
3191 sigemptyset (&sa
.sa_mask
);
3193 sigaction (SIGALRM
, &sa
, &old_sa
);
3197 ofunc
= signal (SIGALRM
, sigalrm_handler
);
3203 waitpid_result
= waitpid (pid
, status
, 0);
3207 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3208 sigaction (SIGALRM
, &old_sa
, NULL
);
3210 signal (SIGALRM
, ofunc
);
3215 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3217 if (waitpid_result
== pid
)
3223 #endif /* HAVE_WAITPID */
3225 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3226 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3228 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3229 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3232 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3234 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3236 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3237 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3239 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3241 char *pattern_slash
, *string_slash
;
3243 /* Replace '\' by '/' in both strings. */
3245 pattern_slash
= (char *) alloca (strlen (pattern
) + 1);
3246 strcpy (pattern_slash
, pattern
);
3247 pattern
= pattern_slash
;
3248 for (; *pattern_slash
!= 0; pattern_slash
++)
3249 if (IS_DIR_SEPARATOR (*pattern_slash
))
3250 *pattern_slash
= '/';
3252 string_slash
= (char *) alloca (strlen (string
) + 1);
3253 strcpy (string_slash
, string
);
3254 string
= string_slash
;
3255 for (; *string_slash
!= 0; string_slash
++)
3256 if (IS_DIR_SEPARATOR (*string_slash
))
3257 *string_slash
= '/';
3259 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3261 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3262 flags
|= FNM_CASEFOLD
;
3263 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3265 return fnmatch (pattern
, string
, flags
);
3268 /* Return the number of path elements in PATH.
3276 count_path_elements (const char *path
)
3279 const char *p
= path
;
3281 if (HAS_DRIVE_SPEC (p
))
3283 p
= STRIP_DRIVE_SPEC (p
);
3289 if (IS_DIR_SEPARATOR (*p
))
3294 /* Backup one if last character is /, unless it's the only one. */
3295 if (p
> path
+ 1 && IS_DIR_SEPARATOR (p
[-1]))
3298 /* Add one for the file name, if present. */
3299 if (p
> path
&& !IS_DIR_SEPARATOR (p
[-1]))
3305 /* Remove N leading path elements from PATH.
3306 N must be non-negative.
3307 If PATH has more than N path elements then return NULL.
3308 If PATH has exactly N path elements then return "".
3309 See count_path_elements for a description of how we do the counting. */
3312 strip_leading_path_elements (const char *path
, int n
)
3315 const char *p
= path
;
3317 gdb_assert (n
>= 0);
3322 if (HAS_DRIVE_SPEC (p
))
3324 p
= STRIP_DRIVE_SPEC (p
);
3330 while (*p
!= '\0' && !IS_DIR_SEPARATOR (*p
))
3345 /* Provide a prototype to silence -Wmissing-prototypes. */
3346 extern initialize_file_ftype _initialize_utils
;
3349 _initialize_utils (void)
3351 add_internal_problem_command (&internal_error_problem
);
3352 add_internal_problem_command (&internal_warning_problem
);
3353 add_internal_problem_command (&demangler_warning_problem
);