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 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 function that calls regfree. */
1044 do_regfree_cleanup (void *r
)
1046 regfree ((regex_t
*) r
);
1049 /* Create a new cleanup that frees the compiled regular expression R. */
1052 make_regfree_cleanup (regex_t
*r
)
1054 return make_cleanup (do_regfree_cleanup
, r
);
1057 /* Return an xmalloc'd error message resulting from a regular
1058 expression compilation failure. */
1061 get_regcomp_error (int code
, regex_t
*rx
)
1063 size_t length
= regerror (code
, rx
, NULL
, 0);
1064 char *result
= (char *) xmalloc (length
);
1066 regerror (code
, rx
, result
, length
);
1070 /* Compile a regexp and throw an exception on error. This returns a
1071 cleanup to free the resulting pattern on success. RX must not be
1075 compile_rx_or_error (regex_t
*pattern
, const char *rx
, const char *message
)
1079 gdb_assert (rx
!= NULL
);
1081 code
= regcomp (pattern
, rx
, REG_NOSUB
);
1084 char *err
= get_regcomp_error (code
, pattern
);
1086 make_cleanup (xfree
, err
);
1087 error (("%s: %s"), message
, err
);
1090 return make_regfree_cleanup (pattern
);
1093 /* A cleanup that simply calls ui_unregister_input_event_handler. */
1096 ui_unregister_input_event_handler_cleanup (void *ui
)
1098 ui_unregister_input_event_handler ((struct ui
*) ui
);
1101 /* Set up to handle input. */
1103 static struct cleanup
*
1104 prepare_to_handle_input (void)
1106 struct cleanup
*old_chain
;
1108 old_chain
= make_cleanup_restore_target_terminal ();
1109 target_terminal_ours ();
1111 ui_register_input_event_handler (current_ui
);
1112 if (current_ui
->prompt_state
== PROMPT_BLOCKED
)
1113 make_cleanup (ui_unregister_input_event_handler_cleanup
, current_ui
);
1115 make_cleanup_override_quit_handler (default_quit_handler
);
1122 /* This function supports the query, nquery, and yquery functions.
1123 Ask user a y-or-n question and return 0 if answer is no, 1 if
1124 answer is yes, or default the answer to the specified default
1125 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1126 default answer, or '\0' for no default.
1127 CTLSTR is the control string and should end in "? ". It should
1128 not say how to answer, because we do that.
1129 ARGS are the arguments passed along with the CTLSTR argument to
1132 static int ATTRIBUTE_PRINTF (1, 0)
1133 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
1138 char def_answer
, not_def_answer
;
1139 char *y_string
, *n_string
, *question
, *prompt
;
1140 struct cleanup
*old_chain
;
1142 /* Set up according to which answer is the default. */
1143 if (defchar
== '\0')
1147 not_def_answer
= 'N';
1151 else if (defchar
== 'y')
1155 not_def_answer
= 'N';
1163 not_def_answer
= 'Y';
1168 /* Automatically answer the default value if the user did not want
1169 prompts or the command was issued with the server prefix. */
1170 if (!confirm
|| server_command
)
1173 /* If input isn't coming from the user directly, just say what
1174 question we're asking, and then answer the default automatically. This
1175 way, important error messages don't get lost when talking to GDB
1177 if (current_ui
->instream
!= current_ui
->stdin_stream
1178 || !input_interactive_p (current_ui
))
1180 old_chain
= make_cleanup_restore_target_terminal ();
1182 target_terminal_ours_for_output ();
1184 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
1186 printf_filtered (_("(%s or %s) [answered %c; "
1187 "input not from terminal]\n"),
1188 y_string
, n_string
, def_answer
);
1189 gdb_flush (gdb_stdout
);
1191 do_cleanups (old_chain
);
1195 if (deprecated_query_hook
)
1199 old_chain
= make_cleanup_restore_target_terminal ();
1200 res
= deprecated_query_hook (ctlstr
, args
);
1201 do_cleanups (old_chain
);
1205 /* Format the question outside of the loop, to avoid reusing args. */
1206 question
= xstrvprintf (ctlstr
, args
);
1207 old_chain
= make_cleanup (xfree
, question
);
1208 prompt
= xstrprintf (_("%s%s(%s or %s) %s"),
1209 annotation_level
> 1 ? "\n\032\032pre-query\n" : "",
1210 question
, y_string
, n_string
,
1211 annotation_level
> 1 ? "\n\032\032query\n" : "");
1212 make_cleanup (xfree
, prompt
);
1214 /* Used to add duration we waited for user to respond to
1215 prompt_for_continue_wait_time. */
1216 using namespace std::chrono
;
1217 steady_clock::time_point prompt_started
= steady_clock::now ();
1219 prepare_to_handle_input ();
1223 char *response
, answer
;
1225 gdb_flush (gdb_stdout
);
1226 response
= gdb_readline_wrapper (prompt
);
1228 if (response
== NULL
) /* C-d */
1230 printf_filtered ("EOF [assumed %c]\n", def_answer
);
1235 answer
= response
[0];
1240 /* Check answer. For the non-default, the user must specify
1241 the non-default explicitly. */
1242 if (answer
== not_def_answer
)
1244 retval
= !def_value
;
1247 /* Otherwise, if a default was specified, the user may either
1248 specify the required input or have it default by entering
1250 if (answer
== def_answer
1251 || (defchar
!= '\0' && answer
== '\0'))
1256 /* Invalid entries are not defaulted and require another selection. */
1257 printf_filtered (_("Please answer %s or %s.\n"),
1258 y_string
, n_string
);
1261 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1262 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1264 if (annotation_level
> 1)
1265 printf_filtered (("\n\032\032post-query\n"));
1266 do_cleanups (old_chain
);
1271 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1272 answer is yes, or 0 if answer is defaulted.
1273 Takes three args which are given to printf to print the question.
1274 The first, a control string, should end in "? ".
1275 It should not say how to answer, because we do that. */
1278 nquery (const char *ctlstr
, ...)
1283 va_start (args
, ctlstr
);
1284 ret
= defaulted_query (ctlstr
, 'n', args
);
1289 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1290 answer is yes, or 1 if answer is defaulted.
1291 Takes three args which are given to printf to print the question.
1292 The first, a control string, should end in "? ".
1293 It should not say how to answer, because we do that. */
1296 yquery (const char *ctlstr
, ...)
1301 va_start (args
, ctlstr
);
1302 ret
= defaulted_query (ctlstr
, 'y', args
);
1307 /* Ask user a y-or-n question and return 1 iff answer is yes.
1308 Takes three args which are given to printf to print the question.
1309 The first, a control string, should end in "? ".
1310 It should not say how to answer, because we do that. */
1313 query (const char *ctlstr
, ...)
1318 va_start (args
, ctlstr
);
1319 ret
= defaulted_query (ctlstr
, '\0', args
);
1324 /* A helper for parse_escape that converts a host character to a
1325 target character. C is the host character. If conversion is
1326 possible, then the target character is stored in *TARGET_C and the
1327 function returns 1. Otherwise, the function returns 0. */
1330 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1332 struct obstack host_data
;
1334 struct cleanup
*cleanups
;
1337 obstack_init (&host_data
);
1338 cleanups
= make_cleanup_obstack_free (&host_data
);
1340 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1341 (gdb_byte
*) &the_char
, 1, 1,
1342 &host_data
, translit_none
);
1344 if (obstack_object_size (&host_data
) == 1)
1347 *target_c
= *(char *) obstack_base (&host_data
);
1350 do_cleanups (cleanups
);
1354 /* Parse a C escape sequence. STRING_PTR points to a variable
1355 containing a pointer to the string to parse. That pointer
1356 should point to the character after the \. That pointer
1357 is updated past the characters we use. The value of the
1358 escape sequence is returned.
1360 A negative value means the sequence \ newline was seen,
1361 which is supposed to be equivalent to nothing at all.
1363 If \ is followed by a null character, we return a negative
1364 value and leave the string pointer pointing at the null character.
1366 If \ is followed by 000, we return 0 and leave the string pointer
1367 after the zeros. A value of 0 does not mean end of string. */
1370 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1372 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1373 int c
= *(*string_ptr
)++;
1392 int i
= host_hex_value (c
);
1397 if (isdigit (c
) && c
!= '8' && c
!= '9')
1401 i
+= host_hex_value (c
);
1437 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1438 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1439 " which has no equivalent\nin the `%s' character set."),
1440 c
, c
, target_charset (gdbarch
));
1444 /* Print the character C on STREAM as part of the contents of a literal
1445 string whose delimiter is QUOTER. Note that this routine should only
1446 be called for printing things which are independent of the language
1447 of the program being debugged.
1449 printchar will normally escape backslashes and instances of QUOTER. If
1450 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1451 As a side effect, if you pass the backslash character as the QUOTER,
1452 printchar will escape backslashes as usual, but not any other quoting
1456 printchar (int c
, void (*do_fputs
) (const char *, struct ui_file
*),
1457 void (*do_fprintf
) (struct ui_file
*, const char *, ...)
1458 ATTRIBUTE_FPTR_PRINTF_2
, struct ui_file
*stream
, int quoter
)
1460 c
&= 0xFF; /* Avoid sign bit follies */
1462 if (c
< 0x20 || /* Low control chars */
1463 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1464 (sevenbit_strings
&& c
>= 0x80))
1465 { /* high order bit set */
1469 do_fputs ("\\n", stream
);
1472 do_fputs ("\\b", stream
);
1475 do_fputs ("\\t", stream
);
1478 do_fputs ("\\f", stream
);
1481 do_fputs ("\\r", stream
);
1484 do_fputs ("\\e", stream
);
1487 do_fputs ("\\a", stream
);
1490 do_fprintf (stream
, "\\%.3o", (unsigned int) c
);
1496 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1497 do_fputs ("\\", stream
);
1498 do_fprintf (stream
, "%c", c
);
1502 /* Print the character C on STREAM as part of the contents of a
1503 literal string whose delimiter is QUOTER. Note that these routines
1504 should only be call for printing things which are independent of
1505 the language of the program being debugged. */
1508 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1511 printchar (*str
++, fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1515 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1518 printchar (*str
++, fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1522 fputstrn_filtered (const char *str
, int n
, int quoter
,
1523 struct ui_file
*stream
)
1527 for (i
= 0; i
< n
; i
++)
1528 printchar (str
[i
], fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1532 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1533 struct ui_file
*stream
)
1537 for (i
= 0; i
< n
; i
++)
1538 printchar (str
[i
], fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1542 /* Number of lines per page or UINT_MAX if paging is disabled. */
1543 static unsigned int lines_per_page
;
1545 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1546 struct cmd_list_element
*c
, const char *value
)
1548 fprintf_filtered (file
,
1549 _("Number of lines gdb thinks are in a page is %s.\n"),
1553 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1554 static unsigned int chars_per_line
;
1556 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1557 struct cmd_list_element
*c
, const char *value
)
1559 fprintf_filtered (file
,
1560 _("Number of characters gdb thinks "
1561 "are in a line is %s.\n"),
1565 /* Current count of lines printed on this page, chars on this line. */
1566 static unsigned int lines_printed
, chars_printed
;
1568 /* Buffer and start column of buffered text, for doing smarter word-
1569 wrapping. When someone calls wrap_here(), we start buffering output
1570 that comes through fputs_filtered(). If we see a newline, we just
1571 spit it out and forget about the wrap_here(). If we see another
1572 wrap_here(), we spit it out and remember the newer one. If we see
1573 the end of the line, we spit out a newline, the indent, and then
1574 the buffered output. */
1576 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1577 are waiting to be output (they have already been counted in chars_printed).
1578 When wrap_buffer[0] is null, the buffer is empty. */
1579 static char *wrap_buffer
;
1581 /* Pointer in wrap_buffer to the next character to fill. */
1582 static char *wrap_pointer
;
1584 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1586 static const char *wrap_indent
;
1588 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1589 is not in effect. */
1590 static int wrap_column
;
1593 /* Initialize the number of lines per page and chars per line. */
1596 init_page_info (void)
1600 lines_per_page
= UINT_MAX
;
1601 chars_per_line
= UINT_MAX
;
1605 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1610 #if defined(__GO32__)
1611 rows
= ScreenRows ();
1612 cols
= ScreenCols ();
1613 lines_per_page
= rows
;
1614 chars_per_line
= cols
;
1616 /* Make sure Readline has initialized its terminal settings. */
1617 rl_reset_terminal (NULL
);
1619 /* Get the screen size from Readline. */
1620 rl_get_screen_size (&rows
, &cols
);
1621 lines_per_page
= rows
;
1622 chars_per_line
= cols
;
1624 /* Readline should have fetched the termcap entry for us.
1625 Only try to use tgetnum function if rl_get_screen_size
1626 did not return a useful value. */
1627 if (((rows
<= 0) && (tgetnum ("li") < 0))
1628 /* Also disable paging if inside Emacs. $EMACS was used
1629 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1630 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1632 /* The number of lines per page is not mentioned in the terminal
1633 description or EMACS evironment variable is set. This probably
1634 means that paging is not useful, so disable paging. */
1635 lines_per_page
= UINT_MAX
;
1638 /* If the output is not a terminal, don't paginate it. */
1639 if (!ui_file_isatty (gdb_stdout
))
1640 lines_per_page
= UINT_MAX
;
1644 /* We handle SIGWINCH ourselves. */
1645 rl_catch_sigwinch
= 0;
1651 /* Return nonzero if filtered printing is initialized. */
1653 filtered_printing_initialized (void)
1655 return wrap_buffer
!= NULL
;
1658 /* Helper for make_cleanup_restore_page_info. */
1661 do_restore_page_info_cleanup (void *arg
)
1667 /* Provide cleanup for restoring the terminal size. */
1670 make_cleanup_restore_page_info (void)
1672 struct cleanup
*back_to
;
1674 back_to
= make_cleanup (do_restore_page_info_cleanup
, NULL
);
1675 make_cleanup_restore_uinteger (&lines_per_page
);
1676 make_cleanup_restore_uinteger (&chars_per_line
);
1681 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1682 Provide cleanup for restoring the original state. */
1685 set_batch_flag_and_make_cleanup_restore_page_info (void)
1687 struct cleanup
*back_to
= make_cleanup_restore_page_info ();
1689 make_cleanup_restore_integer (&batch_flag
);
1696 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1699 set_screen_size (void)
1701 int rows
= lines_per_page
;
1702 int cols
= chars_per_line
;
1710 /* Update Readline's idea of the terminal size. */
1711 rl_set_screen_size (rows
, cols
);
1714 /* Reinitialize WRAP_BUFFER according to the current value of
1720 if (chars_per_line
== 0)
1725 wrap_buffer
= (char *) xmalloc (chars_per_line
+ 2);
1726 wrap_buffer
[0] = '\0';
1729 wrap_buffer
= (char *) xrealloc (wrap_buffer
, chars_per_line
+ 2);
1730 wrap_pointer
= wrap_buffer
; /* Start it at the beginning. */
1734 set_width_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1741 set_height_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1749 set_screen_width_and_height (int width
, int height
)
1751 lines_per_page
= height
;
1752 chars_per_line
= width
;
1758 /* Wait, so the user can read what's on the screen. Prompt the user
1759 to continue by pressing RETURN. 'q' is also provided because
1760 telling users what to do in the prompt is more user-friendly than
1761 expecting them to think of Ctrl-C/SIGINT. */
1764 prompt_for_continue (void)
1767 char cont_prompt
[120];
1768 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
1769 /* Used to add duration we waited for user to respond to
1770 prompt_for_continue_wait_time. */
1771 using namespace std::chrono
;
1772 steady_clock::time_point prompt_started
= steady_clock::now ();
1774 if (annotation_level
> 1)
1775 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1777 strcpy (cont_prompt
,
1778 "---Type <return> to continue, or q <return> to quit---");
1779 if (annotation_level
> 1)
1780 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1782 /* We must do this *before* we call gdb_readline_wrapper, else it
1783 will eventually call us -- thinking that we're trying to print
1784 beyond the end of the screen. */
1785 reinitialize_more_filter ();
1787 prepare_to_handle_input ();
1789 /* Call gdb_readline_wrapper, not readline, in order to keep an
1790 event loop running. */
1791 ignore
= gdb_readline_wrapper (cont_prompt
);
1792 make_cleanup (xfree
, ignore
);
1794 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1795 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1797 if (annotation_level
> 1)
1798 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1804 while (*p
== ' ' || *p
== '\t')
1807 /* Do not call quit here; there is no possibility of SIGINT. */
1808 throw_quit ("Quit");
1811 /* Now we have to do this again, so that GDB will know that it doesn't
1812 need to save the ---Type <return>--- line at the top of the screen. */
1813 reinitialize_more_filter ();
1815 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1817 do_cleanups (old_chain
);
1820 /* Initialize timer to keep track of how long we waited for the user. */
1823 reset_prompt_for_continue_wait_time (void)
1825 using namespace std::chrono
;
1827 prompt_for_continue_wait_time
= steady_clock::duration::zero ();
1830 /* Fetch the cumulative time spent in prompt_for_continue. */
1832 std::chrono::steady_clock::duration
1833 get_prompt_for_continue_wait_time ()
1835 return prompt_for_continue_wait_time
;
1838 /* Reinitialize filter; ie. tell it to reset to original values. */
1841 reinitialize_more_filter (void)
1847 /* Indicate that if the next sequence of characters overflows the line,
1848 a newline should be inserted here rather than when it hits the end.
1849 If INDENT is non-null, it is a string to be printed to indent the
1850 wrapped part on the next line. INDENT must remain accessible until
1851 the next call to wrap_here() or until a newline is printed through
1854 If the line is already overfull, we immediately print a newline and
1855 the indentation, and disable further wrapping.
1857 If we don't know the width of lines, but we know the page height,
1858 we must not wrap words, but should still keep track of newlines
1859 that were explicitly printed.
1861 INDENT should not contain tabs, as that will mess up the char count
1862 on the next line. FIXME.
1864 This routine is guaranteed to force out any output which has been
1865 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1866 used to force out output from the wrap_buffer. */
1869 wrap_here (const char *indent
)
1871 /* This should have been allocated, but be paranoid anyway. */
1873 internal_error (__FILE__
, __LINE__
,
1874 _("failed internal consistency check"));
1878 *wrap_pointer
= '\0';
1879 fputs_unfiltered (wrap_buffer
, gdb_stdout
);
1881 wrap_pointer
= wrap_buffer
;
1882 wrap_buffer
[0] = '\0';
1883 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1887 else if (chars_printed
>= chars_per_line
)
1889 puts_filtered ("\n");
1891 puts_filtered (indent
);
1896 wrap_column
= chars_printed
;
1900 wrap_indent
= indent
;
1904 /* Print input string to gdb_stdout, filtered, with wrap,
1905 arranging strings in columns of n chars. String can be
1906 right or left justified in the column. Never prints
1907 trailing spaces. String should never be longer than
1908 width. FIXME: this could be useful for the EXAMINE
1909 command, which currently doesn't tabulate very well. */
1912 puts_filtered_tabular (char *string
, int width
, int right
)
1918 gdb_assert (chars_per_line
> 0);
1919 if (chars_per_line
== UINT_MAX
)
1921 fputs_filtered (string
, gdb_stdout
);
1922 fputs_filtered ("\n", gdb_stdout
);
1926 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1927 fputs_filtered ("\n", gdb_stdout
);
1929 if (width
>= chars_per_line
)
1930 width
= chars_per_line
- 1;
1932 stringlen
= strlen (string
);
1934 if (chars_printed
> 0)
1935 spaces
= width
- (chars_printed
- 1) % width
- 1;
1937 spaces
+= width
- stringlen
;
1939 spacebuf
= (char *) alloca (spaces
+ 1);
1940 spacebuf
[spaces
] = '\0';
1942 spacebuf
[spaces
] = ' ';
1944 fputs_filtered (spacebuf
, gdb_stdout
);
1945 fputs_filtered (string
, gdb_stdout
);
1949 /* Ensure that whatever gets printed next, using the filtered output
1950 commands, starts at the beginning of the line. I.e. if there is
1951 any pending output for the current line, flush it and start a new
1952 line. Otherwise do nothing. */
1957 if (chars_printed
> 0)
1959 puts_filtered ("\n");
1964 /* Like fputs but if FILTER is true, pause after every screenful.
1966 Regardless of FILTER can wrap at points other than the final
1967 character of a line.
1969 Unlike fputs, fputs_maybe_filtered does not return a value.
1970 It is OK for LINEBUFFER to be NULL, in which case just don't print
1973 Note that a longjmp to top level may occur in this routine (only if
1974 FILTER is true) (since prompt_for_continue may do so) so this
1975 routine should not be called when cleanups are not in place. */
1978 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1981 const char *lineptr
;
1983 if (linebuffer
== 0)
1986 /* Don't do any filtering if it is disabled. */
1987 if (stream
!= gdb_stdout
1988 || !pagination_enabled
1990 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
1991 || top_level_interpreter () == NULL
1992 || interp_ui_out (top_level_interpreter ())->is_mi_like_p ())
1994 fputs_unfiltered (linebuffer
, stream
);
1998 /* Go through and output each character. Show line extension
1999 when this is necessary; prompt user for new page when this is
2002 lineptr
= linebuffer
;
2005 /* Possible new page. */
2006 if (filter
&& (lines_printed
>= lines_per_page
- 1))
2007 prompt_for_continue ();
2009 while (*lineptr
&& *lineptr
!= '\n')
2011 /* Print a single line. */
2012 if (*lineptr
== '\t')
2015 *wrap_pointer
++ = '\t';
2017 fputc_unfiltered ('\t', stream
);
2018 /* Shifting right by 3 produces the number of tab stops
2019 we have already passed, and then adding one and
2020 shifting left 3 advances to the next tab stop. */
2021 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
2027 *wrap_pointer
++ = *lineptr
;
2029 fputc_unfiltered (*lineptr
, stream
);
2034 if (chars_printed
>= chars_per_line
)
2036 unsigned int save_chars
= chars_printed
;
2040 /* If we aren't actually wrapping, don't output newline --
2041 if chars_per_line is right, we probably just overflowed
2042 anyway; if it's wrong, let us keep going. */
2044 fputc_unfiltered ('\n', stream
);
2046 /* Possible new page. */
2047 if (lines_printed
>= lines_per_page
- 1)
2048 prompt_for_continue ();
2050 /* Now output indentation and wrapped string. */
2053 fputs_unfiltered (wrap_indent
, stream
);
2054 *wrap_pointer
= '\0'; /* Null-terminate saved stuff, */
2055 fputs_unfiltered (wrap_buffer
, stream
); /* and eject it. */
2056 /* FIXME, this strlen is what prevents wrap_indent from
2057 containing tabs. However, if we recurse to print it
2058 and count its chars, we risk trouble if wrap_indent is
2059 longer than (the user settable) chars_per_line.
2060 Note also that this can set chars_printed > chars_per_line
2061 if we are printing a long string. */
2062 chars_printed
= strlen (wrap_indent
)
2063 + (save_chars
- wrap_column
);
2064 wrap_pointer
= wrap_buffer
; /* Reset buffer */
2065 wrap_buffer
[0] = '\0';
2066 wrap_column
= 0; /* And disable fancy wrap */
2071 if (*lineptr
== '\n')
2074 wrap_here ((char *) 0); /* Spit out chars, cancel
2077 fputc_unfiltered ('\n', stream
);
2084 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
2086 fputs_maybe_filtered (linebuffer
, stream
, 1);
2090 putchar_unfiltered (int c
)
2094 ui_file_write (gdb_stdout
, &buf
, 1);
2098 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2099 May return nonlocally. */
2102 putchar_filtered (int c
)
2104 return fputc_filtered (c
, gdb_stdout
);
2108 fputc_unfiltered (int c
, struct ui_file
*stream
)
2112 ui_file_write (stream
, &buf
, 1);
2117 fputc_filtered (int c
, struct ui_file
*stream
)
2123 fputs_filtered (buf
, stream
);
2127 /* puts_debug is like fputs_unfiltered, except it prints special
2128 characters in printable fashion. */
2131 puts_debug (char *prefix
, char *string
, char *suffix
)
2135 /* Print prefix and suffix after each line. */
2136 static int new_line
= 1;
2137 static int return_p
= 0;
2138 static char *prev_prefix
= "";
2139 static char *prev_suffix
= "";
2141 if (*string
== '\n')
2144 /* If the prefix is changing, print the previous suffix, a new line,
2145 and the new prefix. */
2146 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
2148 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
2149 fputs_unfiltered ("\n", gdb_stdlog
);
2150 fputs_unfiltered (prefix
, gdb_stdlog
);
2153 /* Print prefix if we printed a newline during the previous call. */
2157 fputs_unfiltered (prefix
, gdb_stdlog
);
2160 prev_prefix
= prefix
;
2161 prev_suffix
= suffix
;
2163 /* Output characters in a printable format. */
2164 while ((ch
= *string
++) != '\0')
2170 fputc_unfiltered (ch
, gdb_stdlog
);
2173 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2177 fputs_unfiltered ("\\\\", gdb_stdlog
);
2180 fputs_unfiltered ("\\b", gdb_stdlog
);
2183 fputs_unfiltered ("\\f", gdb_stdlog
);
2187 fputs_unfiltered ("\\n", gdb_stdlog
);
2190 fputs_unfiltered ("\\r", gdb_stdlog
);
2193 fputs_unfiltered ("\\t", gdb_stdlog
);
2196 fputs_unfiltered ("\\v", gdb_stdlog
);
2200 return_p
= ch
== '\r';
2203 /* Print suffix if we printed a newline. */
2206 fputs_unfiltered (suffix
, gdb_stdlog
);
2207 fputs_unfiltered ("\n", gdb_stdlog
);
2212 /* Print a variable number of ARGS using format FORMAT. If this
2213 information is going to put the amount written (since the last call
2214 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2215 call prompt_for_continue to get the users permision to continue.
2217 Unlike fprintf, this function does not return a value.
2219 We implement three variants, vfprintf (takes a vararg list and stream),
2220 fprintf (takes a stream to write on), and printf (the usual).
2222 Note also that a longjmp to top level may occur in this routine
2223 (since prompt_for_continue may do so) so this routine should not be
2224 called when cleanups are not in place. */
2227 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2228 va_list args
, int filter
)
2231 struct cleanup
*old_cleanups
;
2233 linebuffer
= xstrvprintf (format
, args
);
2234 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2235 fputs_maybe_filtered (linebuffer
, stream
, filter
);
2236 do_cleanups (old_cleanups
);
2241 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2243 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2247 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2250 struct cleanup
*old_cleanups
;
2252 linebuffer
= xstrvprintf (format
, args
);
2253 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2254 if (debug_timestamp
&& stream
== gdb_stdlog
)
2256 using namespace std::chrono
;
2259 steady_clock::time_point now
= steady_clock::now ();
2260 seconds s
= duration_cast
<seconds
> (now
.time_since_epoch ());
2261 microseconds us
= duration_cast
<microseconds
> (now
.time_since_epoch () - s
);
2263 len
= strlen (linebuffer
);
2264 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2266 std::string timestamp
= string_printf ("%ld.%06ld %s%s",
2269 linebuffer
, need_nl
? "\n": "");
2270 fputs_unfiltered (timestamp
.c_str (), stream
);
2273 fputs_unfiltered (linebuffer
, stream
);
2274 do_cleanups (old_cleanups
);
2278 vprintf_filtered (const char *format
, va_list args
)
2280 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2284 vprintf_unfiltered (const char *format
, va_list args
)
2286 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2290 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2294 va_start (args
, format
);
2295 vfprintf_filtered (stream
, format
, args
);
2300 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2304 va_start (args
, format
);
2305 vfprintf_unfiltered (stream
, format
, args
);
2309 /* Like fprintf_filtered, but prints its result indented.
2310 Called as fprintfi_filtered (spaces, stream, format, ...); */
2313 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2318 va_start (args
, format
);
2319 print_spaces_filtered (spaces
, stream
);
2321 vfprintf_filtered (stream
, format
, args
);
2327 printf_filtered (const char *format
, ...)
2331 va_start (args
, format
);
2332 vfprintf_filtered (gdb_stdout
, format
, args
);
2338 printf_unfiltered (const char *format
, ...)
2342 va_start (args
, format
);
2343 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2347 /* Like printf_filtered, but prints it's result indented.
2348 Called as printfi_filtered (spaces, format, ...); */
2351 printfi_filtered (int spaces
, const char *format
, ...)
2355 va_start (args
, format
);
2356 print_spaces_filtered (spaces
, gdb_stdout
);
2357 vfprintf_filtered (gdb_stdout
, format
, args
);
2361 /* Easy -- but watch out!
2363 This routine is *not* a replacement for puts()! puts() appends a newline.
2364 This one doesn't, and had better not! */
2367 puts_filtered (const char *string
)
2369 fputs_filtered (string
, gdb_stdout
);
2373 puts_unfiltered (const char *string
)
2375 fputs_unfiltered (string
, gdb_stdout
);
2378 /* Return a pointer to N spaces and a null. The pointer is good
2379 until the next call to here. */
2384 static char *spaces
= 0;
2385 static int max_spaces
= -1;
2391 spaces
= (char *) xmalloc (n
+ 1);
2392 for (t
= spaces
+ n
; t
!= spaces
;)
2398 return spaces
+ max_spaces
- n
;
2401 /* Print N spaces. */
2403 print_spaces_filtered (int n
, struct ui_file
*stream
)
2405 fputs_filtered (n_spaces (n
), stream
);
2408 /* C++/ObjC demangler stuff. */
2410 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2411 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2412 If the name is not mangled, or the language for the name is unknown, or
2413 demangling is off, the name is printed in its "raw" form. */
2416 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2417 enum language lang
, int arg_mode
)
2423 /* If user wants to see raw output, no problem. */
2426 fputs_filtered (name
, stream
);
2430 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2431 fputs_filtered (demangled
? demangled
: name
, stream
);
2432 if (demangled
!= NULL
)
2440 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2441 differences in whitespace. Returns 0 if they match, non-zero if they
2442 don't (slightly different than strcmp()'s range of return values).
2444 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2445 This "feature" is useful when searching for matching C++ function names
2446 (such as if the user types 'break FOO', where FOO is a mangled C++
2450 strcmp_iw (const char *string1
, const char *string2
)
2452 while ((*string1
!= '\0') && (*string2
!= '\0'))
2454 while (isspace (*string1
))
2458 while (isspace (*string2
))
2462 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2464 if (case_sensitivity
== case_sensitive_off
2465 && (tolower ((unsigned char) *string1
)
2466 != tolower ((unsigned char) *string2
)))
2468 if (*string1
!= '\0')
2474 return (*string1
!= '\0' && *string1
!= '(') || (*string2
!= '\0');
2477 /* This is like strcmp except that it ignores whitespace and treats
2478 '(' as the first non-NULL character in terms of ordering. Like
2479 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2480 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2481 according to that ordering.
2483 If a list is sorted according to this function and if you want to
2484 find names in the list that match some fixed NAME according to
2485 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2486 where this function would put NAME.
2488 This function must be neutral to the CASE_SENSITIVITY setting as the user
2489 may choose it during later lookup. Therefore this function always sorts
2490 primarily case-insensitively and secondarily case-sensitively.
2492 Here are some examples of why using strcmp to sort is a bad idea:
2496 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2497 we try to do a search for "foo<char*>", strcmp will locate this
2498 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2499 will start looking at strings beginning with "goo", and will never
2500 see the correct match of "foo<char *>".
2502 Parenthesis example:
2504 In practice, this is less like to be an issue, but I'll give it a
2505 shot. Let's assume that '$' is a legitimate character to occur in
2506 symbols. (Which may well even be the case on some systems.) Then
2507 say that the partial symbol table contains "foo$" and "foo(int)".
2508 strcmp will put them in this order, since '$' < '('. Now, if the
2509 user searches for "foo", then strcmp will sort "foo" before "foo$".
2510 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2511 "foo") is false, so it won't proceed to the actual match of
2512 "foo(int)" with "foo". */
2515 strcmp_iw_ordered (const char *string1
, const char *string2
)
2517 const char *saved_string1
= string1
, *saved_string2
= string2
;
2518 enum case_sensitivity case_pass
= case_sensitive_off
;
2522 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2523 Provide stub characters if we are already at the end of one of the
2525 char c1
= 'X', c2
= 'X';
2527 while (*string1
!= '\0' && *string2
!= '\0')
2529 while (isspace (*string1
))
2531 while (isspace (*string2
))
2536 case case_sensitive_off
:
2537 c1
= tolower ((unsigned char) *string1
);
2538 c2
= tolower ((unsigned char) *string2
);
2540 case case_sensitive_on
:
2548 if (*string1
!= '\0')
2557 /* Characters are non-equal unless they're both '\0'; we want to
2558 make sure we get the comparison right according to our
2559 comparison in the cases where one of them is '\0' or '('. */
2561 if (*string2
== '\0')
2566 if (*string2
== '\0')
2571 if (*string2
== '\0' || *string2
== '(')
2580 if (case_pass
== case_sensitive_on
)
2583 /* Otherwise the strings were equal in case insensitive way, make
2584 a more fine grained comparison in a case sensitive way. */
2586 case_pass
= case_sensitive_on
;
2587 string1
= saved_string1
;
2588 string2
= saved_string2
;
2592 /* A simple comparison function with opposite semantics to strcmp. */
2595 streq (const char *lhs
, const char *rhs
)
2597 return !strcmp (lhs
, rhs
);
2603 ** Answer whether string_to_compare is a full or partial match to
2604 ** template_string. The partial match must be in sequence starting
2608 subset_compare (char *string_to_compare
, char *template_string
)
2612 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
2613 && strlen (string_to_compare
) <= strlen (template_string
))
2615 (startswith (template_string
, string_to_compare
));
2622 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2623 struct cmd_list_element
*c
, const char *value
)
2625 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2631 initialize_utils (void)
2633 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
2634 Set number of characters where GDB should wrap lines of its output."), _("\
2635 Show number of characters where GDB should wrap lines of its output."), _("\
2636 This affects where GDB wraps its output to fit the screen width.\n\
2637 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2639 show_chars_per_line
,
2640 &setlist
, &showlist
);
2642 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
2643 Set number of lines in a page for GDB output pagination."), _("\
2644 Show number of lines in a page for GDB output pagination."), _("\
2645 This affects the number of lines after which GDB will pause\n\
2646 its output and ask you whether to continue.\n\
2647 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2649 show_lines_per_page
,
2650 &setlist
, &showlist
);
2652 add_setshow_boolean_cmd ("pagination", class_support
,
2653 &pagination_enabled
, _("\
2654 Set state of GDB output pagination."), _("\
2655 Show state of GDB output pagination."), _("\
2656 When pagination is ON, GDB pauses at end of each screenful of\n\
2657 its output and asks you whether to continue.\n\
2658 Turning pagination off is an alternative to \"set height unlimited\"."),
2660 show_pagination_enabled
,
2661 &setlist
, &showlist
);
2663 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
2664 &sevenbit_strings
, _("\
2665 Set printing of 8-bit characters in strings as \\nnn."), _("\
2666 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
2668 show_sevenbit_strings
,
2669 &setprintlist
, &showprintlist
);
2671 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
2672 &debug_timestamp
, _("\
2673 Set timestamping of debugging messages."), _("\
2674 Show timestamping of debugging messages."), _("\
2675 When set, debugging messages will be marked with seconds and microseconds."),
2677 show_debug_timestamp
,
2678 &setdebuglist
, &showdebuglist
);
2682 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2684 /* Truncate address to the size of a target address, avoiding shifts
2685 larger or equal than the width of a CORE_ADDR. The local
2686 variable ADDR_BIT stops the compiler reporting a shift overflow
2687 when it won't occur. */
2688 /* NOTE: This assumes that the significant address information is
2689 kept in the least significant bits of ADDR - the upper bits were
2690 either zero or sign extended. Should gdbarch_address_to_pointer or
2691 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2693 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2695 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2696 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2697 return hex_string (addr
);
2700 /* This function is described in "defs.h". */
2703 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2705 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2707 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2708 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2710 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2711 that returns the language localized string formatted to a width
2712 based on gdbarch_addr_bit. */
2714 return hex_string_custom (address
, 8);
2716 return hex_string_custom (address
, 16);
2719 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2722 core_addr_hash (const void *ap
)
2724 const CORE_ADDR
*addrp
= (const CORE_ADDR
*) ap
;
2729 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2732 core_addr_eq (const void *ap
, const void *bp
)
2734 const CORE_ADDR
*addr_ap
= (const CORE_ADDR
*) ap
;
2735 const CORE_ADDR
*addr_bp
= (const CORE_ADDR
*) bp
;
2737 return *addr_ap
== *addr_bp
;
2740 /* Convert a string back into a CORE_ADDR. */
2742 string_to_core_addr (const char *my_string
)
2746 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2748 /* Assume that it is in hex. */
2751 for (i
= 2; my_string
[i
] != '\0'; i
++)
2753 if (isdigit (my_string
[i
]))
2754 addr
= (my_string
[i
] - '0') + (addr
* 16);
2755 else if (isxdigit (my_string
[i
]))
2756 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2758 error (_("invalid hex \"%s\""), my_string
);
2763 /* Assume that it is in decimal. */
2766 for (i
= 0; my_string
[i
] != '\0'; i
++)
2768 if (isdigit (my_string
[i
]))
2769 addr
= (my_string
[i
] - '0') + (addr
* 10);
2771 error (_("invalid decimal \"%s\""), my_string
);
2779 gdb_realpath (const char *filename
)
2781 /* On most hosts, we rely on canonicalize_file_name to compute
2782 the FILENAME's realpath.
2784 But the situation is slightly more complex on Windows, due to some
2785 versions of GCC which were reported to generate paths where
2786 backlashes (the directory separator) were doubled. For instance:
2787 c:\\some\\double\\slashes\\dir
2789 c:\some\double\slashes\dir
2790 Those double-slashes were getting in the way when comparing paths,
2791 for instance when trying to insert a breakpoint as follow:
2792 (gdb) b c:/some/double/slashes/dir/foo.c:4
2793 No source file named c:/some/double/slashes/dir/foo.c:4.
2794 (gdb) b c:\some\double\slashes\dir\foo.c:4
2795 No source file named c:\some\double\slashes\dir\foo.c:4.
2796 To prevent this from happening, we need this function to always
2797 strip those extra backslashes. While canonicalize_file_name does
2798 perform this simplification, it only works when the path is valid.
2799 Since the simplification would be useful even if the path is not
2800 valid (one can always set a breakpoint on a file, even if the file
2801 does not exist locally), we rely instead on GetFullPathName to
2802 perform the canonicalization. */
2804 #if defined (_WIN32)
2807 DWORD len
= GetFullPathName (filename
, MAX_PATH
, buf
, NULL
);
2809 /* The file system is case-insensitive but case-preserving.
2810 So it is important we do not lowercase the path. Otherwise,
2811 we might not be able to display the original casing in a given
2813 if (len
> 0 && len
< MAX_PATH
)
2814 return xstrdup (buf
);
2818 char *rp
= canonicalize_file_name (filename
);
2825 /* This system is a lost cause, just dup the buffer. */
2826 return xstrdup (filename
);
2829 /* Return a copy of FILENAME, with its directory prefix canonicalized
2833 gdb_realpath_keepfile (const char *filename
)
2835 const char *base_name
= lbasename (filename
);
2840 /* Extract the basename of filename, and return immediately
2841 a copy of filename if it does not contain any directory prefix. */
2842 if (base_name
== filename
)
2843 return xstrdup (filename
);
2845 dir_name
= (char *) alloca ((size_t) (base_name
- filename
+ 2));
2846 /* Allocate enough space to store the dir_name + plus one extra
2847 character sometimes needed under Windows (see below), and
2848 then the closing \000 character. */
2849 strncpy (dir_name
, filename
, base_name
- filename
);
2850 dir_name
[base_name
- filename
] = '\000';
2852 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
2853 /* We need to be careful when filename is of the form 'd:foo', which
2854 is equivalent of d:./foo, which is totally different from d:/foo. */
2855 if (strlen (dir_name
) == 2 && isalpha (dir_name
[0]) && dir_name
[1] == ':')
2858 dir_name
[3] = '\000';
2862 /* Canonicalize the directory prefix, and build the resulting
2863 filename. If the dirname realpath already contains an ending
2864 directory separator, avoid doubling it. */
2865 real_path
= gdb_realpath (dir_name
);
2866 if (IS_DIR_SEPARATOR (real_path
[strlen (real_path
) - 1]))
2867 result
= concat (real_path
, base_name
, (char *) NULL
);
2869 result
= concat (real_path
, SLASH_STRING
, base_name
, (char *) NULL
);
2875 /* Return PATH in absolute form, performing tilde-expansion if necessary.
2876 PATH cannot be NULL or the empty string.
2877 This does not resolve symlinks however, use gdb_realpath for that.
2878 Space for the result is allocated with malloc.
2879 If the path is already absolute, it is strdup'd.
2880 If there is a problem computing the absolute path, the path is returned
2881 unchanged (still strdup'd). */
2884 gdb_abspath (const char *path
)
2886 gdb_assert (path
!= NULL
&& path
[0] != '\0');
2889 return tilde_expand (path
);
2891 if (IS_ABSOLUTE_PATH (path
))
2892 return xstrdup (path
);
2894 /* Beware the // my son, the Emacs barfs, the botch that catch... */
2895 return concat (current_directory
,
2896 IS_DIR_SEPARATOR (current_directory
[strlen (current_directory
) - 1])
2897 ? "" : SLASH_STRING
,
2898 path
, (char *) NULL
);
2902 align_up (ULONGEST v
, int n
)
2904 /* Check that N is really a power of two. */
2905 gdb_assert (n
&& (n
& (n
-1)) == 0);
2906 return (v
+ n
- 1) & -n
;
2910 align_down (ULONGEST v
, int n
)
2912 /* Check that N is really a power of two. */
2913 gdb_assert (n
&& (n
& (n
-1)) == 0);
2917 /* Allocation function for the libiberty hash table which uses an
2918 obstack. The obstack is passed as DATA. */
2921 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
2923 size_t total
= size
* count
;
2924 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
2926 memset (ptr
, 0, total
);
2930 /* Trivial deallocation function for the libiberty splay tree and hash
2931 table - don't deallocate anything. Rely on later deletion of the
2932 obstack. DATA will be the obstack, although it is not needed
2936 dummy_obstack_deallocate (void *object
, void *data
)
2941 /* Simple, portable version of dirname that does not modify its
2945 ldirname (const char *filename
)
2947 const char *base
= lbasename (filename
);
2950 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
2953 if (base
== filename
)
2956 dirname
= (char *) xmalloc (base
- filename
+ 2);
2957 memcpy (dirname
, filename
, base
- filename
);
2959 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
2960 create "d:./bar" later instead of the (different) "d:/bar". */
2961 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
2962 && !IS_DIR_SEPARATOR (filename
[0]))
2963 dirname
[base
++ - filename
] = '.';
2965 dirname
[base
- filename
] = '\0';
2969 /* Call libiberty's buildargv, and return the result.
2970 If buildargv fails due to out-of-memory, call nomem.
2971 Therefore, the returned value is guaranteed to be non-NULL,
2972 unless the parameter itself is NULL. */
2975 gdb_buildargv (const char *s
)
2977 char **argv
= buildargv (s
);
2979 if (s
!= NULL
&& argv
== NULL
)
2985 compare_positive_ints (const void *ap
, const void *bp
)
2987 /* Because we know we're comparing two ints which are positive,
2988 there's no danger of overflow here. */
2989 return * (int *) ap
- * (int *) bp
;
2992 /* String compare function for qsort. */
2995 compare_strings (const void *arg1
, const void *arg2
)
2997 const char **s1
= (const char **) arg1
;
2998 const char **s2
= (const char **) arg2
;
3000 return strcmp (*s1
, *s2
);
3003 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3004 #define AMBIGUOUS_MESS2 \
3005 ".\nUse \"set gnutarget format-name\" to specify the format."
3008 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3014 /* Check if errmsg just need simple return. */
3015 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3016 return bfd_errmsg (error_tag
);
3018 ret_len
= strlen (bfd_errmsg (error_tag
)) + strlen (AMBIGUOUS_MESS1
)
3019 + strlen (AMBIGUOUS_MESS2
);
3020 for (p
= matching
; *p
; p
++)
3021 ret_len
+= strlen (*p
) + 1;
3022 ret
= (char *) xmalloc (ret_len
+ 1);
3024 make_cleanup (xfree
, ret
);
3026 strcpy (retp
, bfd_errmsg (error_tag
));
3027 retp
+= strlen (retp
);
3029 strcpy (retp
, AMBIGUOUS_MESS1
);
3030 retp
+= strlen (retp
);
3032 for (p
= matching
; *p
; p
++)
3034 sprintf (retp
, " %s", *p
);
3035 retp
+= strlen (retp
);
3039 strcpy (retp
, AMBIGUOUS_MESS2
);
3044 /* Return ARGS parsed as a valid pid, or throw an error. */
3047 parse_pid_to_attach (const char *args
)
3053 error_no_arg (_("process-id to attach"));
3055 dummy
= (char *) args
;
3056 pid
= strtoul (args
, &dummy
, 0);
3057 /* Some targets don't set errno on errors, grrr! */
3058 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3059 error (_("Illegal process-id: %s."), args
);
3064 /* Helper for make_bpstat_clear_actions_cleanup. */
3067 do_bpstat_clear_actions_cleanup (void *unused
)
3069 bpstat_clear_actions ();
3072 /* Call bpstat_clear_actions for the case an exception is throw. You should
3073 discard_cleanups if no exception is caught. */
3076 make_bpstat_clear_actions_cleanup (void)
3078 return make_cleanup (do_bpstat_clear_actions_cleanup
, NULL
);
3081 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3082 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3083 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3086 producer_is_gcc_ge_4 (const char *producer
)
3090 if (! producer_is_gcc (producer
, &major
, &minor
))
3099 /* Returns nonzero if the given PRODUCER string is GCC and sets the MAJOR
3100 and MINOR versions when not NULL. Returns zero if the given PRODUCER
3101 is NULL or it isn't GCC. */
3104 producer_is_gcc (const char *producer
, int *major
, int *minor
)
3108 if (producer
!= NULL
&& startswith (producer
, "GNU "))
3117 /* Skip any identifier after "GNU " - such as "C11" or "C++".
3118 A full producer string might look like:
3120 "GNU Fortran 4.8.2 20140120 (Red Hat 4.8.2-16) -mtune=generic ..."
3121 "GNU C++14 5.0.0 20150123 (experimental)"
3123 cs
= &producer
[strlen ("GNU ")];
3124 while (*cs
&& !isspace (*cs
))
3126 if (*cs
&& isspace (*cs
))
3128 if (sscanf (cs
, "%d.%d", major
, minor
) == 2)
3132 /* Not recognized as GCC. */
3136 /* Helper for make_cleanup_free_char_ptr_vec. */
3139 do_free_char_ptr_vec (void *arg
)
3141 VEC (char_ptr
) *char_ptr_vec
= (VEC (char_ptr
) *) arg
;
3143 free_char_ptr_vec (char_ptr_vec
);
3146 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3147 final VEC_free for CHAR_PTR_VEC itself.
3149 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3150 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3151 this function does not (cannot) clear the pointer. */
3154 make_cleanup_free_char_ptr_vec (VEC (char_ptr
) *char_ptr_vec
)
3156 return make_cleanup (do_free_char_ptr_vec
, char_ptr_vec
);
3159 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3160 must come from xrealloc-compatible allocator and it may be updated. FROM
3161 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3162 located at the start or end of *STRINGP. */
3165 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3167 char *string
= *stringp
, *s
;
3168 const size_t from_len
= strlen (from
);
3169 const size_t to_len
= strlen (to
);
3173 s
= strstr (s
, from
);
3177 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3178 || s
[-1] == DIRNAME_SEPARATOR
)
3179 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3180 || s
[from_len
] == DIRNAME_SEPARATOR
))
3185 = (char *) xrealloc (string
, (strlen (string
) + to_len
+ 1));
3187 /* Relocate the current S pointer. */
3188 s
= s
- string
+ string_new
;
3189 string
= string_new
;
3191 /* Replace from by to. */
3192 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3193 memcpy (s
, to
, to_len
);
3208 /* SIGALRM handler for waitpid_with_timeout. */
3211 sigalrm_handler (int signo
)
3213 /* Nothing to do. */
3218 /* Wrapper to wait for child PID to die with TIMEOUT.
3219 TIMEOUT is the time to stop waiting in seconds.
3220 If TIMEOUT is zero, pass WNOHANG to waitpid.
3221 Returns PID if it was successfully waited for, otherwise -1.
3223 Timeouts are currently implemented with alarm and SIGALRM.
3224 If the host does not support them, this waits "forever".
3225 It would be odd though for a host to have waitpid and not SIGALRM. */
3228 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3230 pid_t waitpid_result
;
3232 gdb_assert (pid
> 0);
3233 gdb_assert (timeout
>= 0);
3238 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3239 struct sigaction sa
, old_sa
;
3241 sa
.sa_handler
= sigalrm_handler
;
3242 sigemptyset (&sa
.sa_mask
);
3244 sigaction (SIGALRM
, &sa
, &old_sa
);
3248 ofunc
= signal (SIGALRM
, sigalrm_handler
);
3254 waitpid_result
= waitpid (pid
, status
, 0);
3258 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3259 sigaction (SIGALRM
, &old_sa
, NULL
);
3261 signal (SIGALRM
, ofunc
);
3266 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3268 if (waitpid_result
== pid
)
3274 #endif /* HAVE_WAITPID */
3276 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3277 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3279 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3280 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3283 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3285 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3287 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3288 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3290 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3292 char *pattern_slash
, *string_slash
;
3294 /* Replace '\' by '/' in both strings. */
3296 pattern_slash
= (char *) alloca (strlen (pattern
) + 1);
3297 strcpy (pattern_slash
, pattern
);
3298 pattern
= pattern_slash
;
3299 for (; *pattern_slash
!= 0; pattern_slash
++)
3300 if (IS_DIR_SEPARATOR (*pattern_slash
))
3301 *pattern_slash
= '/';
3303 string_slash
= (char *) alloca (strlen (string
) + 1);
3304 strcpy (string_slash
, string
);
3305 string
= string_slash
;
3306 for (; *string_slash
!= 0; string_slash
++)
3307 if (IS_DIR_SEPARATOR (*string_slash
))
3308 *string_slash
= '/';
3310 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3312 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3313 flags
|= FNM_CASEFOLD
;
3314 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3316 return fnmatch (pattern
, string
, flags
);
3319 /* Return the number of path elements in PATH.
3327 count_path_elements (const char *path
)
3330 const char *p
= path
;
3332 if (HAS_DRIVE_SPEC (p
))
3334 p
= STRIP_DRIVE_SPEC (p
);
3340 if (IS_DIR_SEPARATOR (*p
))
3345 /* Backup one if last character is /, unless it's the only one. */
3346 if (p
> path
+ 1 && IS_DIR_SEPARATOR (p
[-1]))
3349 /* Add one for the file name, if present. */
3350 if (p
> path
&& !IS_DIR_SEPARATOR (p
[-1]))
3356 /* Remove N leading path elements from PATH.
3357 N must be non-negative.
3358 If PATH has more than N path elements then return NULL.
3359 If PATH has exactly N path elements then return "".
3360 See count_path_elements for a description of how we do the counting. */
3363 strip_leading_path_elements (const char *path
, int n
)
3366 const char *p
= path
;
3368 gdb_assert (n
>= 0);
3373 if (HAS_DRIVE_SPEC (p
))
3375 p
= STRIP_DRIVE_SPEC (p
);
3381 while (*p
!= '\0' && !IS_DIR_SEPARATOR (*p
))
3396 /* Provide a prototype to silence -Wmissing-prototypes. */
3397 extern initialize_file_ftype _initialize_utils
;
3400 _initialize_utils (void)
3402 add_internal_problem_command (&internal_error_problem
);
3403 add_internal_problem_command (&internal_warning_problem
);
3404 add_internal_problem_command (&demangler_warning_problem
);