1 /* General utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2016 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/>. */
21 #include "dyn-string.h"
24 #include "event-top.h"
25 #include "gdbthread.h"
28 #ifdef HAVE_SYS_RESOURCE_H
29 #include <sys/resource.h>
30 #endif /* HAVE_SYS_RESOURCE_H */
33 #include "tui/tui.h" /* For tui_get_command_dimension. */
41 #include "timeval-utils.h"
46 #include "gdb-demangle.h"
47 #include "expression.h"
51 #include "filenames.h"
53 #include "gdb_obstack.h"
59 #include "inferior.h" /* for signed_pointer_to_address */
61 #include "gdb_curses.h"
63 #include "readline/readline.h"
65 #include "gdb_sys_time.h"
68 #include "gdb_usleep.h"
70 #include "gdb_regex.h"
73 extern PTR malloc (); /* ARI: PTR */
75 #if !HAVE_DECL_REALLOC
76 extern PTR realloc (); /* ARI: PTR */
82 void (*deprecated_error_begin_hook) (void);
84 /* Prototypes for local functions */
86 static void vfprintf_maybe_filtered (struct ui_file *, const char *,
87 va_list, int) ATTRIBUTE_PRINTF (2, 0);
89 static void fputs_maybe_filtered (const char *, struct ui_file *, int);
91 static void prompt_for_continue (void);
93 static void set_screen_size (void);
94 static void set_width (void);
96 /* Time spent in prompt_for_continue in the currently executing command
97 waiting for user to respond.
98 Initialized in make_command_stats_cleanup.
99 Modified in prompt_for_continue and defaulted_query.
100 Used in report_command_stats. */
102 static struct timeval prompt_for_continue_wait_time;
104 /* A flag indicating whether to timestamp debugging messages. */
106 static int debug_timestamp = 0;
108 /* Nonzero if we have job control. */
112 /* Nonzero means that strings with character values >0x7F should be printed
113 as octal escapes. Zero means just print the value (e.g. it's an
114 international character, and the terminal or window can cope.) */
116 int sevenbit_strings = 0;
118 show_sevenbit_strings (struct ui_file *file, int from_tty,
119 struct cmd_list_element *c, const char *value)
121 fprintf_filtered (file, _("Printing of 8-bit characters "
122 "in strings as \\nnn is %s.\n"),
126 /* String to be printed before warning messages, if any. */
128 char *warning_pre_print = "\nwarning: ";
130 int pagination_enabled = 1;
132 show_pagination_enabled (struct ui_file *file, int from_tty,
133 struct cmd_list_element *c, const char *value)
135 fprintf_filtered (file, _("State of pagination is %s.\n"), value);
139 /* Cleanup utilities.
141 These are not defined in cleanups.c (nor declared in cleanups.h)
142 because while they use the "cleanup API" they are not part of the
146 do_freeargv (void *arg)
148 freeargv ((char **) arg);
152 make_cleanup_freeargv (char **arg)
154 return make_cleanup (do_freeargv, arg);
158 do_dyn_string_delete (void *arg)
160 dyn_string_delete ((dyn_string_t) arg);
164 make_cleanup_dyn_string_delete (dyn_string_t arg)
166 return make_cleanup (do_dyn_string_delete, arg);
170 do_bfd_close_cleanup (void *arg)
172 gdb_bfd_unref ((bfd *) arg);
176 make_cleanup_bfd_unref (bfd *abfd)
178 return make_cleanup (do_bfd_close_cleanup, abfd);
181 /* Helper function which does the work for make_cleanup_fclose. */
184 do_fclose_cleanup (void *arg)
186 FILE *file = (FILE *) arg;
191 /* Return a new cleanup that closes FILE. */
194 make_cleanup_fclose (FILE *file)
196 return make_cleanup (do_fclose_cleanup, file);
199 /* Helper function which does the work for make_cleanup_obstack_free. */
202 do_obstack_free (void *arg)
204 struct obstack *ob = (struct obstack *) arg;
206 obstack_free (ob, NULL);
209 /* Return a new cleanup that frees OBSTACK. */
212 make_cleanup_obstack_free (struct obstack *obstack)
214 return make_cleanup (do_obstack_free, obstack);
218 do_ui_file_delete (void *arg)
220 ui_file_delete ((struct ui_file *) arg);
224 make_cleanup_ui_file_delete (struct ui_file *arg)
226 return make_cleanup (do_ui_file_delete, arg);
229 /* Helper function for make_cleanup_ui_out_redirect_pop. */
232 do_ui_out_redirect_pop (void *arg)
234 struct ui_out *uiout = (struct ui_out *) arg;
236 if (ui_out_redirect (uiout, NULL) < 0)
237 warning (_("Cannot restore redirection of the current output protocol"));
240 /* Return a new cleanup that pops the last redirection by ui_out_redirect
241 with NULL parameter. */
244 make_cleanup_ui_out_redirect_pop (struct ui_out *uiout)
246 return make_cleanup (do_ui_out_redirect_pop, uiout);
250 do_free_section_addr_info (void *arg)
252 free_section_addr_info ((struct section_addr_info *) arg);
256 make_cleanup_free_section_addr_info (struct section_addr_info *addrs)
258 return make_cleanup (do_free_section_addr_info, addrs);
261 struct restore_integer_closure
268 restore_integer (void *p)
270 struct restore_integer_closure *closure
271 = (struct restore_integer_closure *) p;
273 *(closure->variable) = closure->value;
276 /* Remember the current value of *VARIABLE and make it restored when
277 the cleanup is run. */
280 make_cleanup_restore_integer (int *variable)
282 struct restore_integer_closure *c = XNEW (struct restore_integer_closure);
284 c->variable = variable;
285 c->value = *variable;
287 return make_cleanup_dtor (restore_integer, (void *) c, xfree);
290 /* Remember the current value of *VARIABLE and make it restored when
291 the cleanup is run. */
294 make_cleanup_restore_uinteger (unsigned int *variable)
296 return make_cleanup_restore_integer ((int *) variable);
299 /* Helper for make_cleanup_unpush_target. */
302 do_unpush_target (void *arg)
304 struct target_ops *ops = (struct target_ops *) arg;
309 /* Return a new cleanup that unpushes OPS. */
312 make_cleanup_unpush_target (struct target_ops *ops)
314 return make_cleanup (do_unpush_target, ops);
317 /* Helper for make_cleanup_htab_delete compile time checking the types. */
320 do_htab_delete_cleanup (void *htab_voidp)
322 htab_t htab = (htab_t) htab_voidp;
327 /* Return a new cleanup that deletes HTAB. */
330 make_cleanup_htab_delete (htab_t htab)
332 return make_cleanup (do_htab_delete_cleanup, htab);
335 struct restore_ui_out_closure
337 struct ui_out **variable;
338 struct ui_out *value;
342 do_restore_ui_out (void *p)
344 struct restore_ui_out_closure *closure
345 = (struct restore_ui_out_closure *) p;
347 *(closure->variable) = closure->value;
350 /* Remember the current value of *VARIABLE and make it restored when
351 the cleanup is run. */
354 make_cleanup_restore_ui_out (struct ui_out **variable)
356 struct restore_ui_out_closure *c = XNEW (struct restore_ui_out_closure);
358 c->variable = variable;
359 c->value = *variable;
361 return make_cleanup_dtor (do_restore_ui_out, (void *) c, xfree);
364 struct restore_ui_file_closure
366 struct ui_file **variable;
367 struct ui_file *value;
371 do_restore_ui_file (void *p)
373 struct restore_ui_file_closure *closure
374 = (struct restore_ui_file_closure *) p;
376 *(closure->variable) = closure->value;
379 /* Remember the current value of *VARIABLE and make it restored when
380 the cleanup is run. */
383 make_cleanup_restore_ui_file (struct ui_file **variable)
385 struct restore_ui_file_closure *c = XNEW (struct restore_ui_file_closure);
387 c->variable = variable;
388 c->value = *variable;
390 return make_cleanup_dtor (do_restore_ui_file, (void *) c, xfree);
393 /* Helper for make_cleanup_value_free_to_mark. */
396 do_value_free_to_mark (void *value)
398 value_free_to_mark ((struct value *) value);
401 /* Free all values allocated since MARK was obtained by value_mark
402 (except for those released) when the cleanup is run. */
405 make_cleanup_value_free_to_mark (struct value *mark)
407 return make_cleanup (do_value_free_to_mark, mark);
410 /* Helper for make_cleanup_value_free. */
413 do_value_free (void *value)
415 value_free ((struct value *) value);
421 make_cleanup_value_free (struct value *value)
423 return make_cleanup (do_value_free, value);
426 /* Helper for make_cleanup_free_so. */
429 do_free_so (void *arg)
431 struct so_list *so = (struct so_list *) arg;
436 /* Make cleanup handler calling free_so for SO. */
439 make_cleanup_free_so (struct so_list *so)
441 return make_cleanup (do_free_so, so);
444 /* Helper for make_cleanup_restore_current_language. */
447 do_restore_current_language (void *p)
449 enum language saved_lang = (enum language) (uintptr_t) p;
451 set_language (saved_lang);
454 /* Remember the current value of CURRENT_LANGUAGE and make it restored when
455 the cleanup is run. */
458 make_cleanup_restore_current_language (void)
460 enum language saved_lang = current_language->la_language;
462 return make_cleanup (do_restore_current_language,
463 (void *) (uintptr_t) saved_lang);
466 /* Helper function for make_cleanup_clear_parser_state. */
469 do_clear_parser_state (void *ptr)
471 struct parser_state **p = (struct parser_state **) ptr;
476 /* Clean (i.e., set to NULL) the parser state variable P. */
479 make_cleanup_clear_parser_state (struct parser_state **p)
481 return make_cleanup (do_clear_parser_state, (void *) p);
484 /* This function is useful for cleanups.
488 old_chain = make_cleanup (free_current_contents, &foo);
490 to arrange to free the object thus allocated. */
493 free_current_contents (void *ptr)
495 void **location = (void **) ptr;
497 if (location == NULL)
498 internal_error (__FILE__, __LINE__,
499 _("free_current_contents: NULL pointer"));
500 if (*location != NULL)
509 /* Print a warning message. The first argument STRING is the warning
510 message, used as an fprintf format string, the second is the
511 va_list of arguments for that string. A warning is unfiltered (not
512 paginated) so that the user does not need to page through each
513 screen full of warnings when there are lots of them. */
516 vwarning (const char *string, va_list args)
518 if (deprecated_warning_hook)
519 (*deprecated_warning_hook) (string, args);
522 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
524 if (target_supports_terminal_ours ())
526 make_cleanup_restore_target_terminal ();
527 target_terminal_ours_for_output ();
529 if (filtered_printing_initialized ())
530 wrap_here (""); /* Force out any buffered output. */
531 gdb_flush (gdb_stdout);
532 if (warning_pre_print)
533 fputs_unfiltered (warning_pre_print, gdb_stderr);
534 vfprintf_unfiltered (gdb_stderr, string, args);
535 fprintf_unfiltered (gdb_stderr, "\n");
537 do_cleanups (old_chain);
541 /* Print an error message and return to command level.
542 The first argument STRING is the error message, used as a fprintf string,
543 and the remaining args are passed as arguments to it. */
546 verror (const char *string, va_list args)
548 throw_verror (GENERIC_ERROR, string, args);
552 error_stream (struct ui_file *stream)
554 char *message = ui_file_xstrdup (stream, NULL);
556 make_cleanup (xfree, message);
557 error (("%s"), message);
560 /* Emit a message and abort. */
562 static void ATTRIBUTE_NORETURN
563 abort_with_message (const char *msg)
565 if (gdb_stderr == NULL)
568 fputs_unfiltered (msg, gdb_stderr);
570 abort (); /* NOTE: GDB has only three calls to abort(). */
573 /* Dump core trying to increase the core soft limit to hard limit first. */
578 #ifdef HAVE_SETRLIMIT
579 struct rlimit rlim = { RLIM_INFINITY, RLIM_INFINITY };
581 setrlimit (RLIMIT_CORE, &rlim);
582 #endif /* HAVE_SETRLIMIT */
584 abort (); /* NOTE: GDB has only three calls to abort(). */
587 /* Check whether GDB will be able to dump core using the dump_core
588 function. Returns zero if GDB cannot or should not dump core.
589 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
590 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
593 can_dump_core (enum resource_limit_kind limit_kind)
595 #ifdef HAVE_GETRLIMIT
598 /* Be quiet and assume we can dump if an error is returned. */
599 if (getrlimit (RLIMIT_CORE, &rlim) != 0)
605 if (rlim.rlim_cur == 0)
609 if (rlim.rlim_max == 0)
612 #endif /* HAVE_GETRLIMIT */
617 /* Print a warning that we cannot dump core. */
620 warn_cant_dump_core (const char *reason)
622 fprintf_unfiltered (gdb_stderr,
623 _("%s\nUnable to dump core, use `ulimit -c"
624 " unlimited' before executing GDB next time.\n"),
628 /* Check whether GDB will be able to dump core using the dump_core
629 function, and print a warning if we cannot. */
632 can_dump_core_warn (enum resource_limit_kind limit_kind,
635 int core_dump_allowed = can_dump_core (limit_kind);
637 if (!core_dump_allowed)
638 warn_cant_dump_core (reason);
640 return core_dump_allowed;
643 /* Allow the user to configure the debugger behavior with respect to
644 what to do when an internal problem is detected. */
646 const char internal_problem_ask[] = "ask";
647 const char internal_problem_yes[] = "yes";
648 const char internal_problem_no[] = "no";
649 static const char *const internal_problem_modes[] =
651 internal_problem_ask,
652 internal_problem_yes,
657 /* Print a message reporting an internal error/warning. Ask the user
658 if they want to continue, dump core, or just exit. Return
659 something to indicate a quit. */
661 struct internal_problem
664 int user_settable_should_quit;
665 const char *should_quit;
666 int user_settable_should_dump_core;
667 const char *should_dump_core;
670 /* Report a problem, internal to GDB, to the user. Once the problem
671 has been reported, and assuming GDB didn't quit, the caller can
672 either allow execution to resume or throw an error. */
674 static void ATTRIBUTE_PRINTF (4, 0)
675 internal_vproblem (struct internal_problem *problem,
676 const char *file, int line, const char *fmt, va_list ap)
682 struct cleanup *cleanup = make_cleanup (null_cleanup, NULL);
684 /* Don't allow infinite error/warning recursion. */
686 static char msg[] = "Recursive internal problem.\n";
695 abort_with_message (msg);
698 /* Newer GLIBC versions put the warn_unused_result attribute
699 on write, but this is one of those rare cases where
700 ignoring the return value is correct. Casting to (void)
701 does not fix this problem. This is the solution suggested
702 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
703 if (write (STDERR_FILENO, msg, sizeof (msg)) != sizeof (msg))
704 abort (); /* NOTE: GDB has only three calls to abort(). */
709 /* Create a string containing the full error/warning message. Need
710 to call query with this full string, as otherwize the reason
711 (error/warning) and question become separated. Format using a
712 style similar to a compiler error message. Include extra detail
713 so that the user knows that they are living on the edge. */
717 msg = xstrvprintf (fmt, ap);
718 reason = xstrprintf ("%s:%d: %s: %s\n"
719 "A problem internal to GDB has been detected,\n"
720 "further debugging may prove unreliable.",
721 file, line, problem->name, msg);
723 make_cleanup (xfree, reason);
726 /* Fall back to abort_with_message if gdb_stderr is not set up. */
727 if (gdb_stderr == NULL)
729 fputs (reason, stderr);
730 abort_with_message ("\n");
733 /* Try to get the message out and at the start of a new line. */
734 if (target_supports_terminal_ours ())
736 make_cleanup_restore_target_terminal ();
737 target_terminal_ours_for_output ();
739 if (filtered_printing_initialized ())
742 /* Emit the message unless query will emit it below. */
743 if (problem->should_quit != internal_problem_ask
745 || !filtered_printing_initialized ())
746 fprintf_unfiltered (gdb_stderr, "%s\n", reason);
748 if (problem->should_quit == internal_problem_ask)
750 /* Default (yes/batch case) is to quit GDB. When in batch mode
751 this lessens the likelihood of GDB going into an infinite
753 if (!confirm || !filtered_printing_initialized ())
756 quit_p = query (_("%s\nQuit this debugging session? "), reason);
758 else if (problem->should_quit == internal_problem_yes)
760 else if (problem->should_quit == internal_problem_no)
763 internal_error (__FILE__, __LINE__, _("bad switch"));
765 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr);
766 if (REPORT_BUGS_TO[0])
767 fprintf_unfiltered (gdb_stderr, _(" For instructions, see:\n%s."),
769 fputs_unfiltered ("\n\n", gdb_stderr);
771 if (problem->should_dump_core == internal_problem_ask)
773 if (!can_dump_core_warn (LIMIT_MAX, reason))
775 else if (!filtered_printing_initialized ())
779 /* Default (yes/batch case) is to dump core. This leaves a GDB
780 `dropping' so that it is easier to see that something went
782 dump_core_p = query (_("%s\nCreate a core file of GDB? "), reason);
785 else if (problem->should_dump_core == internal_problem_yes)
786 dump_core_p = can_dump_core_warn (LIMIT_MAX, reason);
787 else if (problem->should_dump_core == internal_problem_no)
790 internal_error (__FILE__, __LINE__, _("bad switch"));
803 #ifdef HAVE_WORKING_FORK
811 do_cleanups (cleanup);
814 static struct internal_problem internal_error_problem = {
815 "internal-error", 1, internal_problem_ask, 1, internal_problem_ask
819 internal_verror (const char *file, int line, const char *fmt, va_list ap)
821 internal_vproblem (&internal_error_problem, file, line, fmt, ap);
822 throw_quit (_("Command aborted."));
825 static struct internal_problem internal_warning_problem = {
826 "internal-warning", 1, internal_problem_ask, 1, internal_problem_ask
830 internal_vwarning (const char *file, int line, const char *fmt, va_list ap)
832 internal_vproblem (&internal_warning_problem, file, line, fmt, ap);
835 static struct internal_problem demangler_warning_problem = {
836 "demangler-warning", 1, internal_problem_ask, 0, internal_problem_no
840 demangler_vwarning (const char *file, int line, const char *fmt, va_list ap)
842 internal_vproblem (&demangler_warning_problem, file, line, fmt, ap);
846 demangler_warning (const char *file, int line, const char *string, ...)
850 va_start (ap, string);
851 demangler_vwarning (file, line, string, ap);
855 /* Dummy functions to keep add_prefix_cmd happy. */
858 set_internal_problem_cmd (char *args, int from_tty)
863 show_internal_problem_cmd (char *args, int from_tty)
867 /* When GDB reports an internal problem (error or warning) it gives
868 the user the opportunity to quit GDB and/or create a core file of
869 the current debug session. This function registers a few commands
870 that make it possible to specify that GDB should always or never
871 quit or create a core file, without asking. The commands look
874 maint set PROBLEM-NAME quit ask|yes|no
875 maint show PROBLEM-NAME quit
876 maint set PROBLEM-NAME corefile ask|yes|no
877 maint show PROBLEM-NAME corefile
879 Where PROBLEM-NAME is currently "internal-error" or
880 "internal-warning". */
883 add_internal_problem_command (struct internal_problem *problem)
885 struct cmd_list_element **set_cmd_list;
886 struct cmd_list_element **show_cmd_list;
890 set_cmd_list = XNEW (struct cmd_list_element *);
891 show_cmd_list = XNEW (struct cmd_list_element *);
892 *set_cmd_list = NULL;
893 *show_cmd_list = NULL;
895 set_doc = xstrprintf (_("Configure what GDB does when %s is detected."),
898 show_doc = xstrprintf (_("Show what GDB does when %s is detected."),
901 add_prefix_cmd ((char*) problem->name,
902 class_maintenance, set_internal_problem_cmd, set_doc,
904 concat ("maintenance set ", problem->name, " ",
906 0/*allow-unknown*/, &maintenance_set_cmdlist);
908 add_prefix_cmd ((char*) problem->name,
909 class_maintenance, show_internal_problem_cmd, show_doc,
911 concat ("maintenance show ", problem->name, " ",
913 0/*allow-unknown*/, &maintenance_show_cmdlist);
915 if (problem->user_settable_should_quit)
917 set_doc = xstrprintf (_("Set whether GDB should quit "
918 "when an %s is detected"),
920 show_doc = xstrprintf (_("Show whether GDB will quit "
921 "when an %s is detected"),
923 add_setshow_enum_cmd ("quit", class_maintenance,
924 internal_problem_modes,
925 &problem->should_quit,
938 if (problem->user_settable_should_dump_core)
940 set_doc = xstrprintf (_("Set whether GDB should create a core "
941 "file of GDB when %s is detected"),
943 show_doc = xstrprintf (_("Show whether GDB will create a core "
944 "file of GDB when %s is detected"),
946 add_setshow_enum_cmd ("corefile", class_maintenance,
947 internal_problem_modes,
948 &problem->should_dump_core,
962 /* Return a newly allocated string, containing the PREFIX followed
963 by the system error message for errno (separated by a colon).
965 The result must be deallocated after use. */
968 perror_string (const char *prefix)
973 err = safe_strerror (errno);
974 combined = (char *) xmalloc (strlen (err) + strlen (prefix) + 3);
975 strcpy (combined, prefix);
976 strcat (combined, ": ");
977 strcat (combined, err);
982 /* Print the system error message for errno, and also mention STRING
983 as the file name for which the error was encountered. Use ERRCODE
984 for the thrown exception. Then return to command level. */
987 throw_perror_with_name (enum errors errcode, const char *string)
991 combined = perror_string (string);
992 make_cleanup (xfree, combined);
994 /* I understand setting these is a matter of taste. Still, some people
995 may clear errno but not know about bfd_error. Doing this here is not
997 bfd_set_error (bfd_error_no_error);
1000 throw_error (errcode, _("%s."), combined);
1003 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
1006 perror_with_name (const char *string)
1008 throw_perror_with_name (GENERIC_ERROR, string);
1011 /* Same as perror_with_name except that it prints a warning instead
1012 of throwing an error. */
1015 perror_warning_with_name (const char *string)
1019 combined = perror_string (string);
1020 warning (_("%s"), combined);
1024 /* Print the system error message for ERRCODE, and also mention STRING
1025 as the file name for which the error was encountered. */
1028 print_sys_errmsg (const char *string, int errcode)
1033 err = safe_strerror (errcode);
1034 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
1035 strcpy (combined, string);
1036 strcat (combined, ": ");
1037 strcat (combined, err);
1039 /* We want anything which was printed on stdout to come out first, before
1041 gdb_flush (gdb_stdout);
1042 fprintf_unfiltered (gdb_stderr, "%s.\n", combined);
1045 /* Control C eventually causes this to be called, at a convenient time. */
1050 struct ui *ui = current_ui;
1052 if (sync_quit_force_run)
1054 sync_quit_force_run = 0;
1055 quit_force (NULL, 0);
1059 /* No steenking SIGINT will ever be coming our way when the
1060 program is resumed. Don't lie. */
1061 throw_quit ("Quit");
1064 /* If there is no terminal switching for this target, then we can't
1065 possibly get screwed by the lack of job control. */
1066 || !target_supports_terminal_ours ())
1067 throw_quit ("Quit");
1069 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
1078 if (sync_quit_force_run)
1083 if (deprecated_interactive_hook)
1084 deprecated_interactive_hook ();
1088 /* Called when a memory allocation fails, with the number of bytes of
1089 memory requested in SIZE. */
1092 malloc_failure (long size)
1096 internal_error (__FILE__, __LINE__,
1097 _("virtual memory exhausted: can't allocate %ld bytes."),
1102 internal_error (__FILE__, __LINE__, _("virtual memory exhausted."));
1106 /* My replacement for the read system call.
1107 Used like `read' but keeps going if `read' returns too soon. */
1110 myread (int desc, char *addr, int len)
1117 val = read (desc, addr, len);
1121 return orglen - len;
1129 print_spaces (int n, struct ui_file *file)
1131 fputs_unfiltered (n_spaces (n), file);
1134 /* Print a host address. */
1137 gdb_print_host_address_1 (const void *addr, struct ui_file *stream)
1139 fprintf_filtered (stream, "%s", host_address_to_string (addr));
1145 make_hex_string (const gdb_byte *data, size_t length)
1147 char *result = (char *) xmalloc (length * 2 + 1);
1152 for (i = 0; i < length; ++i)
1153 p += xsnprintf (p, 3, "%02x", data[i]);
1160 /* A cleanup function that calls regfree. */
1163 do_regfree_cleanup (void *r)
1165 regfree ((regex_t *) r);
1168 /* Create a new cleanup that frees the compiled regular expression R. */
1171 make_regfree_cleanup (regex_t *r)
1173 return make_cleanup (do_regfree_cleanup, r);
1176 /* Return an xmalloc'd error message resulting from a regular
1177 expression compilation failure. */
1180 get_regcomp_error (int code, regex_t *rx)
1182 size_t length = regerror (code, rx, NULL, 0);
1183 char *result = (char *) xmalloc (length);
1185 regerror (code, rx, result, length);
1189 /* Compile a regexp and throw an exception on error. This returns a
1190 cleanup to free the resulting pattern on success. RX must not be
1194 compile_rx_or_error (regex_t *pattern, const char *rx, const char *message)
1198 gdb_assert (rx != NULL);
1200 code = regcomp (pattern, rx, REG_NOSUB);
1203 char *err = get_regcomp_error (code, pattern);
1205 make_cleanup (xfree, err);
1206 error (("%s: %s"), message, err);
1209 return make_regfree_cleanup (pattern);
1212 /* A cleanup that simply calls ui_unregister_input_event_handler. */
1215 ui_unregister_input_event_handler_cleanup (void *ui)
1217 ui_unregister_input_event_handler ((struct ui *) ui);
1220 /* Set up to handle input. */
1222 static struct cleanup *
1223 prepare_to_handle_input (void)
1225 struct cleanup *old_chain;
1227 old_chain = make_cleanup_restore_target_terminal ();
1228 target_terminal_ours ();
1230 ui_register_input_event_handler (current_ui);
1231 if (current_ui->prompt_state == PROMPT_BLOCKED)
1232 make_cleanup (ui_unregister_input_event_handler_cleanup, current_ui);
1234 make_cleanup_override_quit_handler (default_quit_handler);
1241 /* This function supports the query, nquery, and yquery functions.
1242 Ask user a y-or-n question and return 0 if answer is no, 1 if
1243 answer is yes, or default the answer to the specified default
1244 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1245 default answer, or '\0' for no default.
1246 CTLSTR is the control string and should end in "? ". It should
1247 not say how to answer, because we do that.
1248 ARGS are the arguments passed along with the CTLSTR argument to
1251 static int ATTRIBUTE_PRINTF (1, 0)
1252 defaulted_query (const char *ctlstr, const char defchar, va_list args)
1257 char def_answer, not_def_answer;
1258 char *y_string, *n_string, *question, *prompt;
1259 /* Used to add duration we waited for user to respond to
1260 prompt_for_continue_wait_time. */
1261 struct timeval prompt_started, prompt_ended, prompt_delta;
1262 struct cleanup *old_chain;
1264 /* Set up according to which answer is the default. */
1265 if (defchar == '\0')
1269 not_def_answer = 'N';
1273 else if (defchar == 'y')
1277 not_def_answer = 'N';
1285 not_def_answer = 'Y';
1290 /* Automatically answer the default value if the user did not want
1291 prompts or the command was issued with the server prefix. */
1292 if (!confirm || server_command)
1295 /* If input isn't coming from the user directly, just say what
1296 question we're asking, and then answer the default automatically. This
1297 way, important error messages don't get lost when talking to GDB
1299 if (current_ui->instream != current_ui->stdin_stream
1300 || !input_interactive_p (current_ui))
1302 old_chain = make_cleanup_restore_target_terminal ();
1304 target_terminal_ours_for_output ();
1306 vfprintf_filtered (gdb_stdout, ctlstr, args);
1308 printf_filtered (_("(%s or %s) [answered %c; "
1309 "input not from terminal]\n"),
1310 y_string, n_string, def_answer);
1311 gdb_flush (gdb_stdout);
1313 do_cleanups (old_chain);
1317 if (deprecated_query_hook)
1321 old_chain = make_cleanup_restore_target_terminal ();
1322 res = deprecated_query_hook (ctlstr, args);
1323 do_cleanups (old_chain);
1327 /* Format the question outside of the loop, to avoid reusing args. */
1328 question = xstrvprintf (ctlstr, args);
1329 old_chain = make_cleanup (xfree, question);
1330 prompt = xstrprintf (_("%s%s(%s or %s) %s"),
1331 annotation_level > 1 ? "\n\032\032pre-query\n" : "",
1332 question, y_string, n_string,
1333 annotation_level > 1 ? "\n\032\032query\n" : "");
1334 make_cleanup (xfree, prompt);
1336 /* Used for calculating time spend waiting for user. */
1337 gettimeofday (&prompt_started, NULL);
1339 prepare_to_handle_input ();
1343 char *response, answer;
1345 gdb_flush (gdb_stdout);
1346 response = gdb_readline_wrapper (prompt);
1348 if (response == NULL) /* C-d */
1350 printf_filtered ("EOF [assumed %c]\n", def_answer);
1355 answer = response[0];
1360 /* Check answer. For the non-default, the user must specify
1361 the non-default explicitly. */
1362 if (answer == not_def_answer)
1364 retval = !def_value;
1367 /* Otherwise, if a default was specified, the user may either
1368 specify the required input or have it default by entering
1370 if (answer == def_answer
1371 || (defchar != '\0' && answer == '\0'))
1376 /* Invalid entries are not defaulted and require another selection. */
1377 printf_filtered (_("Please answer %s or %s.\n"),
1378 y_string, n_string);
1381 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1382 gettimeofday (&prompt_ended, NULL);
1383 timeval_sub (&prompt_delta, &prompt_ended, &prompt_started);
1384 timeval_add (&prompt_for_continue_wait_time,
1385 &prompt_for_continue_wait_time, &prompt_delta);
1387 if (annotation_level > 1)
1388 printf_filtered (("\n\032\032post-query\n"));
1389 do_cleanups (old_chain);
1394 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1395 answer is yes, or 0 if answer is defaulted.
1396 Takes three args which are given to printf to print the question.
1397 The first, a control string, should end in "? ".
1398 It should not say how to answer, because we do that. */
1401 nquery (const char *ctlstr, ...)
1406 va_start (args, ctlstr);
1407 ret = defaulted_query (ctlstr, 'n', args);
1412 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1413 answer is yes, or 1 if answer is defaulted.
1414 Takes three args which are given to printf to print the question.
1415 The first, a control string, should end in "? ".
1416 It should not say how to answer, because we do that. */
1419 yquery (const char *ctlstr, ...)
1424 va_start (args, ctlstr);
1425 ret = defaulted_query (ctlstr, 'y', args);
1430 /* Ask user a y-or-n question and return 1 iff answer is yes.
1431 Takes three args which are given to printf to print the question.
1432 The first, a control string, should end in "? ".
1433 It should not say how to answer, because we do that. */
1436 query (const char *ctlstr, ...)
1441 va_start (args, ctlstr);
1442 ret = defaulted_query (ctlstr, '\0', args);
1447 /* A helper for parse_escape that converts a host character to a
1448 target character. C is the host character. If conversion is
1449 possible, then the target character is stored in *TARGET_C and the
1450 function returns 1. Otherwise, the function returns 0. */
1453 host_char_to_target (struct gdbarch *gdbarch, int c, int *target_c)
1455 struct obstack host_data;
1457 struct cleanup *cleanups;
1460 obstack_init (&host_data);
1461 cleanups = make_cleanup_obstack_free (&host_data);
1463 convert_between_encodings (target_charset (gdbarch), host_charset (),
1464 (gdb_byte *) &the_char, 1, 1,
1465 &host_data, translit_none);
1467 if (obstack_object_size (&host_data) == 1)
1470 *target_c = *(char *) obstack_base (&host_data);
1473 do_cleanups (cleanups);
1477 /* Parse a C escape sequence. STRING_PTR points to a variable
1478 containing a pointer to the string to parse. That pointer
1479 should point to the character after the \. That pointer
1480 is updated past the characters we use. The value of the
1481 escape sequence is returned.
1483 A negative value means the sequence \ newline was seen,
1484 which is supposed to be equivalent to nothing at all.
1486 If \ is followed by a null character, we return a negative
1487 value and leave the string pointer pointing at the null character.
1489 If \ is followed by 000, we return 0 and leave the string pointer
1490 after the zeros. A value of 0 does not mean end of string. */
1493 parse_escape (struct gdbarch *gdbarch, const char **string_ptr)
1495 int target_char = -2; /* Initialize to avoid GCC warnings. */
1496 int c = *(*string_ptr)++;
1515 int i = host_hex_value (c);
1520 if (isdigit (c) && c != '8' && c != '9')
1524 i += host_hex_value (c);
1560 if (!host_char_to_target (gdbarch, c, &target_char))
1561 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1562 " which has no equivalent\nin the `%s' character set."),
1563 c, c, target_charset (gdbarch));
1567 /* Print the character C on STREAM as part of the contents of a literal
1568 string whose delimiter is QUOTER. Note that this routine should only
1569 be called for printing things which are independent of the language
1570 of the program being debugged.
1572 printchar will normally escape backslashes and instances of QUOTER. If
1573 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1574 As a side effect, if you pass the backslash character as the QUOTER,
1575 printchar will escape backslashes as usual, but not any other quoting
1579 printchar (int c, void (*do_fputs) (const char *, struct ui_file *),
1580 void (*do_fprintf) (struct ui_file *, const char *, ...)
1581 ATTRIBUTE_FPTR_PRINTF_2, struct ui_file *stream, int quoter)
1583 c &= 0xFF; /* Avoid sign bit follies */
1585 if (c < 0x20 || /* Low control chars */
1586 (c >= 0x7F && c < 0xA0) || /* DEL, High controls */
1587 (sevenbit_strings && c >= 0x80))
1588 { /* high order bit set */
1592 do_fputs ("\\n", stream);
1595 do_fputs ("\\b", stream);
1598 do_fputs ("\\t", stream);
1601 do_fputs ("\\f", stream);
1604 do_fputs ("\\r", stream);
1607 do_fputs ("\\e", stream);
1610 do_fputs ("\\a", stream);
1613 do_fprintf (stream, "\\%.3o", (unsigned int) c);
1619 if (quoter != 0 && (c == '\\' || c == quoter))
1620 do_fputs ("\\", stream);
1621 do_fprintf (stream, "%c", c);
1625 /* Print the character C on STREAM as part of the contents of a
1626 literal string whose delimiter is QUOTER. Note that these routines
1627 should only be call for printing things which are independent of
1628 the language of the program being debugged. */
1631 fputstr_filtered (const char *str, int quoter, struct ui_file *stream)
1634 printchar (*str++, fputs_filtered, fprintf_filtered, stream, quoter);
1638 fputstr_unfiltered (const char *str, int quoter, struct ui_file *stream)
1641 printchar (*str++, fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1645 fputstrn_filtered (const char *str, int n, int quoter,
1646 struct ui_file *stream)
1650 for (i = 0; i < n; i++)
1651 printchar (str[i], fputs_filtered, fprintf_filtered, stream, quoter);
1655 fputstrn_unfiltered (const char *str, int n, int quoter,
1656 struct ui_file *stream)
1660 for (i = 0; i < n; i++)
1661 printchar (str[i], fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1665 /* Number of lines per page or UINT_MAX if paging is disabled. */
1666 static unsigned int lines_per_page;
1668 show_lines_per_page (struct ui_file *file, int from_tty,
1669 struct cmd_list_element *c, const char *value)
1671 fprintf_filtered (file,
1672 _("Number of lines gdb thinks are in a page is %s.\n"),
1676 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1677 static unsigned int chars_per_line;
1679 show_chars_per_line (struct ui_file *file, int from_tty,
1680 struct cmd_list_element *c, const char *value)
1682 fprintf_filtered (file,
1683 _("Number of characters gdb thinks "
1684 "are in a line is %s.\n"),
1688 /* Current count of lines printed on this page, chars on this line. */
1689 static unsigned int lines_printed, chars_printed;
1691 /* Buffer and start column of buffered text, for doing smarter word-
1692 wrapping. When someone calls wrap_here(), we start buffering output
1693 that comes through fputs_filtered(). If we see a newline, we just
1694 spit it out and forget about the wrap_here(). If we see another
1695 wrap_here(), we spit it out and remember the newer one. If we see
1696 the end of the line, we spit out a newline, the indent, and then
1697 the buffered output. */
1699 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1700 are waiting to be output (they have already been counted in chars_printed).
1701 When wrap_buffer[0] is null, the buffer is empty. */
1702 static char *wrap_buffer;
1704 /* Pointer in wrap_buffer to the next character to fill. */
1705 static char *wrap_pointer;
1707 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1709 static char *wrap_indent;
1711 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1712 is not in effect. */
1713 static int wrap_column;
1716 /* Inialize the number of lines per page and chars per line. */
1719 init_page_info (void)
1723 lines_per_page = UINT_MAX;
1724 chars_per_line = UINT_MAX;
1728 if (!tui_get_command_dimension (&chars_per_line, &lines_per_page))
1733 #if defined(__GO32__)
1734 rows = ScreenRows ();
1735 cols = ScreenCols ();
1736 lines_per_page = rows;
1737 chars_per_line = cols;
1739 /* Make sure Readline has initialized its terminal settings. */
1740 rl_reset_terminal (NULL);
1742 /* Get the screen size from Readline. */
1743 rl_get_screen_size (&rows, &cols);
1744 lines_per_page = rows;
1745 chars_per_line = cols;
1747 /* Readline should have fetched the termcap entry for us.
1748 Only try to use tgetnum function if rl_get_screen_size
1749 did not return a useful value. */
1750 if (((rows <= 0) && (tgetnum ("li") < 0))
1751 /* Also disable paging if inside Emacs. $EMACS was used
1752 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1753 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1755 /* The number of lines per page is not mentioned in the terminal
1756 description or EMACS evironment variable is set. This probably
1757 means that paging is not useful, so disable paging. */
1758 lines_per_page = UINT_MAX;
1761 /* If the output is not a terminal, don't paginate it. */
1762 if (!ui_file_isatty (gdb_stdout))
1763 lines_per_page = UINT_MAX;
1767 /* We handle SIGWINCH ourselves. */
1768 rl_catch_sigwinch = 0;
1774 /* Return nonzero if filtered printing is initialized. */
1776 filtered_printing_initialized (void)
1778 return wrap_buffer != NULL;
1781 /* Helper for make_cleanup_restore_page_info. */
1784 do_restore_page_info_cleanup (void *arg)
1790 /* Provide cleanup for restoring the terminal size. */
1793 make_cleanup_restore_page_info (void)
1795 struct cleanup *back_to;
1797 back_to = make_cleanup (do_restore_page_info_cleanup, NULL);
1798 make_cleanup_restore_uinteger (&lines_per_page);
1799 make_cleanup_restore_uinteger (&chars_per_line);
1804 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1805 Provide cleanup for restoring the original state. */
1808 set_batch_flag_and_make_cleanup_restore_page_info (void)
1810 struct cleanup *back_to = make_cleanup_restore_page_info ();
1812 make_cleanup_restore_integer (&batch_flag);
1819 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1822 set_screen_size (void)
1824 int rows = lines_per_page;
1825 int cols = chars_per_line;
1833 /* Update Readline's idea of the terminal size. */
1834 rl_set_screen_size (rows, cols);
1837 /* Reinitialize WRAP_BUFFER according to the current value of
1843 if (chars_per_line == 0)
1848 wrap_buffer = (char *) xmalloc (chars_per_line + 2);
1849 wrap_buffer[0] = '\0';
1852 wrap_buffer = (char *) xrealloc (wrap_buffer, chars_per_line + 2);
1853 wrap_pointer = wrap_buffer; /* Start it at the beginning. */
1857 set_width_command (char *args, int from_tty, struct cmd_list_element *c)
1864 set_height_command (char *args, int from_tty, struct cmd_list_element *c)
1872 set_screen_width_and_height (int width, int height)
1874 lines_per_page = height;
1875 chars_per_line = width;
1881 /* Wait, so the user can read what's on the screen. Prompt the user
1882 to continue by pressing RETURN. 'q' is also provided because
1883 telling users what to do in the prompt is more user-friendly than
1884 expecting them to think of Ctrl-C/SIGINT. */
1887 prompt_for_continue (void)
1890 char cont_prompt[120];
1891 /* Used to add duration we waited for user to respond to
1892 prompt_for_continue_wait_time. */
1893 struct timeval prompt_started, prompt_ended, prompt_delta;
1894 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
1896 gettimeofday (&prompt_started, NULL);
1898 if (annotation_level > 1)
1899 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1901 strcpy (cont_prompt,
1902 "---Type <return> to continue, or q <return> to quit---");
1903 if (annotation_level > 1)
1904 strcat (cont_prompt, "\n\032\032prompt-for-continue\n");
1906 /* We must do this *before* we call gdb_readline_wrapper, else it
1907 will eventually call us -- thinking that we're trying to print
1908 beyond the end of the screen. */
1909 reinitialize_more_filter ();
1911 prepare_to_handle_input ();
1913 /* Call gdb_readline_wrapper, not readline, in order to keep an
1914 event loop running. */
1915 ignore = gdb_readline_wrapper (cont_prompt);
1916 make_cleanup (xfree, ignore);
1918 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1919 gettimeofday (&prompt_ended, NULL);
1920 timeval_sub (&prompt_delta, &prompt_ended, &prompt_started);
1921 timeval_add (&prompt_for_continue_wait_time,
1922 &prompt_for_continue_wait_time, &prompt_delta);
1924 if (annotation_level > 1)
1925 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1931 while (*p == ' ' || *p == '\t')
1934 /* Do not call quit here; there is no possibility of SIGINT. */
1935 throw_quit ("Quit");
1938 /* Now we have to do this again, so that GDB will know that it doesn't
1939 need to save the ---Type <return>--- line at the top of the screen. */
1940 reinitialize_more_filter ();
1942 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1944 do_cleanups (old_chain);
1947 /* Initalize timer to keep track of how long we waited for the user. */
1950 reset_prompt_for_continue_wait_time (void)
1952 static const struct timeval zero_timeval = { 0 };
1954 prompt_for_continue_wait_time = zero_timeval;
1957 /* Fetch the cumulative time spent in prompt_for_continue. */
1960 get_prompt_for_continue_wait_time (void)
1962 return prompt_for_continue_wait_time;
1965 /* Reinitialize filter; ie. tell it to reset to original values. */
1968 reinitialize_more_filter (void)
1974 /* Indicate that if the next sequence of characters overflows the line,
1975 a newline should be inserted here rather than when it hits the end.
1976 If INDENT is non-null, it is a string to be printed to indent the
1977 wrapped part on the next line. INDENT must remain accessible until
1978 the next call to wrap_here() or until a newline is printed through
1981 If the line is already overfull, we immediately print a newline and
1982 the indentation, and disable further wrapping.
1984 If we don't know the width of lines, but we know the page height,
1985 we must not wrap words, but should still keep track of newlines
1986 that were explicitly printed.
1988 INDENT should not contain tabs, as that will mess up the char count
1989 on the next line. FIXME.
1991 This routine is guaranteed to force out any output which has been
1992 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1993 used to force out output from the wrap_buffer. */
1996 wrap_here (char *indent)
1998 /* This should have been allocated, but be paranoid anyway. */
2000 internal_error (__FILE__, __LINE__,
2001 _("failed internal consistency check"));
2005 *wrap_pointer = '\0';
2006 fputs_unfiltered (wrap_buffer, gdb_stdout);
2008 wrap_pointer = wrap_buffer;
2009 wrap_buffer[0] = '\0';
2010 if (chars_per_line == UINT_MAX) /* No line overflow checking. */
2014 else if (chars_printed >= chars_per_line)
2016 puts_filtered ("\n");
2018 puts_filtered (indent);
2023 wrap_column = chars_printed;
2027 wrap_indent = indent;
2031 /* Print input string to gdb_stdout, filtered, with wrap,
2032 arranging strings in columns of n chars. String can be
2033 right or left justified in the column. Never prints
2034 trailing spaces. String should never be longer than
2035 width. FIXME: this could be useful for the EXAMINE
2036 command, which currently doesn't tabulate very well. */
2039 puts_filtered_tabular (char *string, int width, int right)
2045 gdb_assert (chars_per_line > 0);
2046 if (chars_per_line == UINT_MAX)
2048 fputs_filtered (string, gdb_stdout);
2049 fputs_filtered ("\n", gdb_stdout);
2053 if (((chars_printed - 1) / width + 2) * width >= chars_per_line)
2054 fputs_filtered ("\n", gdb_stdout);
2056 if (width >= chars_per_line)
2057 width = chars_per_line - 1;
2059 stringlen = strlen (string);
2061 if (chars_printed > 0)
2062 spaces = width - (chars_printed - 1) % width - 1;
2064 spaces += width - stringlen;
2066 spacebuf = (char *) alloca (spaces + 1);
2067 spacebuf[spaces] = '\0';
2069 spacebuf[spaces] = ' ';
2071 fputs_filtered (spacebuf, gdb_stdout);
2072 fputs_filtered (string, gdb_stdout);
2076 /* Ensure that whatever gets printed next, using the filtered output
2077 commands, starts at the beginning of the line. I.e. if there is
2078 any pending output for the current line, flush it and start a new
2079 line. Otherwise do nothing. */
2084 if (chars_printed > 0)
2086 puts_filtered ("\n");
2091 /* Like fputs but if FILTER is true, pause after every screenful.
2093 Regardless of FILTER can wrap at points other than the final
2094 character of a line.
2096 Unlike fputs, fputs_maybe_filtered does not return a value.
2097 It is OK for LINEBUFFER to be NULL, in which case just don't print
2100 Note that a longjmp to top level may occur in this routine (only if
2101 FILTER is true) (since prompt_for_continue may do so) so this
2102 routine should not be called when cleanups are not in place. */
2105 fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
2108 const char *lineptr;
2110 if (linebuffer == 0)
2113 /* Don't do any filtering if it is disabled. */
2114 if (stream != gdb_stdout
2115 || !pagination_enabled
2117 || (lines_per_page == UINT_MAX && chars_per_line == UINT_MAX)
2118 || top_level_interpreter () == NULL
2119 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2121 fputs_unfiltered (linebuffer, stream);
2125 /* Go through and output each character. Show line extension
2126 when this is necessary; prompt user for new page when this is
2129 lineptr = linebuffer;
2132 /* Possible new page. */
2133 if (filter && (lines_printed >= lines_per_page - 1))
2134 prompt_for_continue ();
2136 while (*lineptr && *lineptr != '\n')
2138 /* Print a single line. */
2139 if (*lineptr == '\t')
2142 *wrap_pointer++ = '\t';
2144 fputc_unfiltered ('\t', stream);
2145 /* Shifting right by 3 produces the number of tab stops
2146 we have already passed, and then adding one and
2147 shifting left 3 advances to the next tab stop. */
2148 chars_printed = ((chars_printed >> 3) + 1) << 3;
2154 *wrap_pointer++ = *lineptr;
2156 fputc_unfiltered (*lineptr, stream);
2161 if (chars_printed >= chars_per_line)
2163 unsigned int save_chars = chars_printed;
2167 /* If we aren't actually wrapping, don't output newline --
2168 if chars_per_line is right, we probably just overflowed
2169 anyway; if it's wrong, let us keep going. */
2171 fputc_unfiltered ('\n', stream);
2173 /* Possible new page. */
2174 if (lines_printed >= lines_per_page - 1)
2175 prompt_for_continue ();
2177 /* Now output indentation and wrapped string. */
2180 fputs_unfiltered (wrap_indent, stream);
2181 *wrap_pointer = '\0'; /* Null-terminate saved stuff, */
2182 fputs_unfiltered (wrap_buffer, stream); /* and eject it. */
2183 /* FIXME, this strlen is what prevents wrap_indent from
2184 containing tabs. However, if we recurse to print it
2185 and count its chars, we risk trouble if wrap_indent is
2186 longer than (the user settable) chars_per_line.
2187 Note also that this can set chars_printed > chars_per_line
2188 if we are printing a long string. */
2189 chars_printed = strlen (wrap_indent)
2190 + (save_chars - wrap_column);
2191 wrap_pointer = wrap_buffer; /* Reset buffer */
2192 wrap_buffer[0] = '\0';
2193 wrap_column = 0; /* And disable fancy wrap */
2198 if (*lineptr == '\n')
2201 wrap_here ((char *) 0); /* Spit out chars, cancel
2204 fputc_unfiltered ('\n', stream);
2211 fputs_filtered (const char *linebuffer, struct ui_file *stream)
2213 fputs_maybe_filtered (linebuffer, stream, 1);
2217 putchar_unfiltered (int c)
2221 ui_file_write (gdb_stdout, &buf, 1);
2225 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2226 May return nonlocally. */
2229 putchar_filtered (int c)
2231 return fputc_filtered (c, gdb_stdout);
2235 fputc_unfiltered (int c, struct ui_file *stream)
2239 ui_file_write (stream, &buf, 1);
2244 fputc_filtered (int c, struct ui_file *stream)
2250 fputs_filtered (buf, stream);
2254 /* puts_debug is like fputs_unfiltered, except it prints special
2255 characters in printable fashion. */
2258 puts_debug (char *prefix, char *string, char *suffix)
2262 /* Print prefix and suffix after each line. */
2263 static int new_line = 1;
2264 static int return_p = 0;
2265 static char *prev_prefix = "";
2266 static char *prev_suffix = "";
2268 if (*string == '\n')
2271 /* If the prefix is changing, print the previous suffix, a new line,
2272 and the new prefix. */
2273 if ((return_p || (strcmp (prev_prefix, prefix) != 0)) && !new_line)
2275 fputs_unfiltered (prev_suffix, gdb_stdlog);
2276 fputs_unfiltered ("\n", gdb_stdlog);
2277 fputs_unfiltered (prefix, gdb_stdlog);
2280 /* Print prefix if we printed a newline during the previous call. */
2284 fputs_unfiltered (prefix, gdb_stdlog);
2287 prev_prefix = prefix;
2288 prev_suffix = suffix;
2290 /* Output characters in a printable format. */
2291 while ((ch = *string++) != '\0')
2297 fputc_unfiltered (ch, gdb_stdlog);
2300 fprintf_unfiltered (gdb_stdlog, "\\x%02x", ch & 0xff);
2304 fputs_unfiltered ("\\\\", gdb_stdlog);
2307 fputs_unfiltered ("\\b", gdb_stdlog);
2310 fputs_unfiltered ("\\f", gdb_stdlog);
2314 fputs_unfiltered ("\\n", gdb_stdlog);
2317 fputs_unfiltered ("\\r", gdb_stdlog);
2320 fputs_unfiltered ("\\t", gdb_stdlog);
2323 fputs_unfiltered ("\\v", gdb_stdlog);
2327 return_p = ch == '\r';
2330 /* Print suffix if we printed a newline. */
2333 fputs_unfiltered (suffix, gdb_stdlog);
2334 fputs_unfiltered ("\n", gdb_stdlog);
2339 /* Print a variable number of ARGS using format FORMAT. If this
2340 information is going to put the amount written (since the last call
2341 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2342 call prompt_for_continue to get the users permision to continue.
2344 Unlike fprintf, this function does not return a value.
2346 We implement three variants, vfprintf (takes a vararg list and stream),
2347 fprintf (takes a stream to write on), and printf (the usual).
2349 Note also that a longjmp to top level may occur in this routine
2350 (since prompt_for_continue may do so) so this routine should not be
2351 called when cleanups are not in place. */
2354 vfprintf_maybe_filtered (struct ui_file *stream, const char *format,
2355 va_list args, int filter)
2358 struct cleanup *old_cleanups;
2360 linebuffer = xstrvprintf (format, args);
2361 old_cleanups = make_cleanup (xfree, linebuffer);
2362 fputs_maybe_filtered (linebuffer, stream, filter);
2363 do_cleanups (old_cleanups);
2368 vfprintf_filtered (struct ui_file *stream, const char *format, va_list args)
2370 vfprintf_maybe_filtered (stream, format, args, 1);
2374 vfprintf_unfiltered (struct ui_file *stream, const char *format, va_list args)
2377 struct cleanup *old_cleanups;
2379 linebuffer = xstrvprintf (format, args);
2380 old_cleanups = make_cleanup (xfree, linebuffer);
2381 if (debug_timestamp && stream == gdb_stdlog)
2387 gettimeofday (&tm, NULL);
2389 len = strlen (linebuffer);
2390 need_nl = (len > 0 && linebuffer[len - 1] != '\n');
2392 timestamp = xstrprintf ("%ld:%ld %s%s",
2393 (long) tm.tv_sec, (long) tm.tv_usec,
2395 need_nl ? "\n": "");
2396 make_cleanup (xfree, timestamp);
2397 fputs_unfiltered (timestamp, stream);
2400 fputs_unfiltered (linebuffer, stream);
2401 do_cleanups (old_cleanups);
2405 vprintf_filtered (const char *format, va_list args)
2407 vfprintf_maybe_filtered (gdb_stdout, format, args, 1);
2411 vprintf_unfiltered (const char *format, va_list args)
2413 vfprintf_unfiltered (gdb_stdout, format, args);
2417 fprintf_filtered (struct ui_file *stream, const char *format, ...)
2421 va_start (args, format);
2422 vfprintf_filtered (stream, format, args);
2427 fprintf_unfiltered (struct ui_file *stream, const char *format, ...)
2431 va_start (args, format);
2432 vfprintf_unfiltered (stream, format, args);
2436 /* Like fprintf_filtered, but prints its result indented.
2437 Called as fprintfi_filtered (spaces, stream, format, ...); */
2440 fprintfi_filtered (int spaces, struct ui_file *stream, const char *format,
2445 va_start (args, format);
2446 print_spaces_filtered (spaces, stream);
2448 vfprintf_filtered (stream, format, args);
2454 printf_filtered (const char *format, ...)
2458 va_start (args, format);
2459 vfprintf_filtered (gdb_stdout, format, args);
2465 printf_unfiltered (const char *format, ...)
2469 va_start (args, format);
2470 vfprintf_unfiltered (gdb_stdout, format, args);
2474 /* Like printf_filtered, but prints it's result indented.
2475 Called as printfi_filtered (spaces, format, ...); */
2478 printfi_filtered (int spaces, const char *format, ...)
2482 va_start (args, format);
2483 print_spaces_filtered (spaces, gdb_stdout);
2484 vfprintf_filtered (gdb_stdout, format, args);
2488 /* Easy -- but watch out!
2490 This routine is *not* a replacement for puts()! puts() appends a newline.
2491 This one doesn't, and had better not! */
2494 puts_filtered (const char *string)
2496 fputs_filtered (string, gdb_stdout);
2500 puts_unfiltered (const char *string)
2502 fputs_unfiltered (string, gdb_stdout);
2505 /* Return a pointer to N spaces and a null. The pointer is good
2506 until the next call to here. */
2511 static char *spaces = 0;
2512 static int max_spaces = -1;
2518 spaces = (char *) xmalloc (n + 1);
2519 for (t = spaces + n; t != spaces;)
2525 return spaces + max_spaces - n;
2528 /* Print N spaces. */
2530 print_spaces_filtered (int n, struct ui_file *stream)
2532 fputs_filtered (n_spaces (n), stream);
2535 /* C++/ObjC demangler stuff. */
2537 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2538 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2539 If the name is not mangled, or the language for the name is unknown, or
2540 demangling is off, the name is printed in its "raw" form. */
2543 fprintf_symbol_filtered (struct ui_file *stream, const char *name,
2544 enum language lang, int arg_mode)
2550 /* If user wants to see raw output, no problem. */
2553 fputs_filtered (name, stream);
2557 demangled = language_demangle (language_def (lang), name, arg_mode);
2558 fputs_filtered (demangled ? demangled : name, stream);
2559 if (demangled != NULL)
2567 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2568 differences in whitespace. Returns 0 if they match, non-zero if they
2569 don't (slightly different than strcmp()'s range of return values).
2571 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2572 This "feature" is useful when searching for matching C++ function names
2573 (such as if the user types 'break FOO', where FOO is a mangled C++
2577 strcmp_iw (const char *string1, const char *string2)
2579 while ((*string1 != '\0') && (*string2 != '\0'))
2581 while (isspace (*string1))
2585 while (isspace (*string2))
2589 if (case_sensitivity == case_sensitive_on && *string1 != *string2)
2591 if (case_sensitivity == case_sensitive_off
2592 && (tolower ((unsigned char) *string1)
2593 != tolower ((unsigned char) *string2)))
2595 if (*string1 != '\0')
2601 return (*string1 != '\0' && *string1 != '(') || (*string2 != '\0');
2604 /* This is like strcmp except that it ignores whitespace and treats
2605 '(' as the first non-NULL character in terms of ordering. Like
2606 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2607 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2608 according to that ordering.
2610 If a list is sorted according to this function and if you want to
2611 find names in the list that match some fixed NAME according to
2612 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2613 where this function would put NAME.
2615 This function must be neutral to the CASE_SENSITIVITY setting as the user
2616 may choose it during later lookup. Therefore this function always sorts
2617 primarily case-insensitively and secondarily case-sensitively.
2619 Here are some examples of why using strcmp to sort is a bad idea:
2623 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2624 we try to do a search for "foo<char*>", strcmp will locate this
2625 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2626 will start looking at strings beginning with "goo", and will never
2627 see the correct match of "foo<char *>".
2629 Parenthesis example:
2631 In practice, this is less like to be an issue, but I'll give it a
2632 shot. Let's assume that '$' is a legitimate character to occur in
2633 symbols. (Which may well even be the case on some systems.) Then
2634 say that the partial symbol table contains "foo$" and "foo(int)".
2635 strcmp will put them in this order, since '$' < '('. Now, if the
2636 user searches for "foo", then strcmp will sort "foo" before "foo$".
2637 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2638 "foo") is false, so it won't proceed to the actual match of
2639 "foo(int)" with "foo". */
2642 strcmp_iw_ordered (const char *string1, const char *string2)
2644 const char *saved_string1 = string1, *saved_string2 = string2;
2645 enum case_sensitivity case_pass = case_sensitive_off;
2649 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2650 Provide stub characters if we are already at the end of one of the
2652 char c1 = 'X', c2 = 'X';
2654 while (*string1 != '\0' && *string2 != '\0')
2656 while (isspace (*string1))
2658 while (isspace (*string2))
2663 case case_sensitive_off:
2664 c1 = tolower ((unsigned char) *string1);
2665 c2 = tolower ((unsigned char) *string2);
2667 case case_sensitive_on:
2675 if (*string1 != '\0')
2684 /* Characters are non-equal unless they're both '\0'; we want to
2685 make sure we get the comparison right according to our
2686 comparison in the cases where one of them is '\0' or '('. */
2688 if (*string2 == '\0')
2693 if (*string2 == '\0')
2698 if (*string2 == '\0' || *string2 == '(')
2707 if (case_pass == case_sensitive_on)
2710 /* Otherwise the strings were equal in case insensitive way, make
2711 a more fine grained comparison in a case sensitive way. */
2713 case_pass = case_sensitive_on;
2714 string1 = saved_string1;
2715 string2 = saved_string2;
2719 /* A simple comparison function with opposite semantics to strcmp. */
2722 streq (const char *lhs, const char *rhs)
2724 return !strcmp (lhs, rhs);
2730 ** Answer whether string_to_compare is a full or partial match to
2731 ** template_string. The partial match must be in sequence starting
2735 subset_compare (char *string_to_compare, char *template_string)
2739 if (template_string != (char *) NULL && string_to_compare != (char *) NULL
2740 && strlen (string_to_compare) <= strlen (template_string))
2742 (startswith (template_string, string_to_compare));
2749 show_debug_timestamp (struct ui_file *file, int from_tty,
2750 struct cmd_list_element *c, const char *value)
2752 fprintf_filtered (file, _("Timestamping debugging messages is %s.\n"),
2758 initialize_utils (void)
2760 add_setshow_uinteger_cmd ("width", class_support, &chars_per_line, _("\
2761 Set number of characters where GDB should wrap lines of its output."), _("\
2762 Show number of characters where GDB should wrap lines of its output."), _("\
2763 This affects where GDB wraps its output to fit the screen width.\n\
2764 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2766 show_chars_per_line,
2767 &setlist, &showlist);
2769 add_setshow_uinteger_cmd ("height", class_support, &lines_per_page, _("\
2770 Set number of lines in a page for GDB output pagination."), _("\
2771 Show number of lines in a page for GDB output pagination."), _("\
2772 This affects the number of lines after which GDB will pause\n\
2773 its output and ask you whether to continue.\n\
2774 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2776 show_lines_per_page,
2777 &setlist, &showlist);
2779 add_setshow_boolean_cmd ("pagination", class_support,
2780 &pagination_enabled, _("\
2781 Set state of GDB output pagination."), _("\
2782 Show state of GDB output pagination."), _("\
2783 When pagination is ON, GDB pauses at end of each screenful of\n\
2784 its output and asks you whether to continue.\n\
2785 Turning pagination off is an alternative to \"set height unlimited\"."),
2787 show_pagination_enabled,
2788 &setlist, &showlist);
2790 add_setshow_boolean_cmd ("sevenbit-strings", class_support,
2791 &sevenbit_strings, _("\
2792 Set printing of 8-bit characters in strings as \\nnn."), _("\
2793 Show printing of 8-bit characters in strings as \\nnn."), NULL,
2795 show_sevenbit_strings,
2796 &setprintlist, &showprintlist);
2798 add_setshow_boolean_cmd ("timestamp", class_maintenance,
2799 &debug_timestamp, _("\
2800 Set timestamping of debugging messages."), _("\
2801 Show timestamping of debugging messages."), _("\
2802 When set, debugging messages will be marked with seconds and microseconds."),
2804 show_debug_timestamp,
2805 &setdebuglist, &showdebuglist);
2809 paddress (struct gdbarch *gdbarch, CORE_ADDR addr)
2811 /* Truncate address to the size of a target address, avoiding shifts
2812 larger or equal than the width of a CORE_ADDR. The local
2813 variable ADDR_BIT stops the compiler reporting a shift overflow
2814 when it won't occur. */
2815 /* NOTE: This assumes that the significant address information is
2816 kept in the least significant bits of ADDR - the upper bits were
2817 either zero or sign extended. Should gdbarch_address_to_pointer or
2818 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2820 int addr_bit = gdbarch_addr_bit (gdbarch);
2822 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2823 addr &= ((CORE_ADDR) 1 << addr_bit) - 1;
2824 return hex_string (addr);
2827 /* This function is described in "defs.h". */
2830 print_core_address (struct gdbarch *gdbarch, CORE_ADDR address)
2832 int addr_bit = gdbarch_addr_bit (gdbarch);
2834 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2835 address &= ((CORE_ADDR) 1 << addr_bit) - 1;
2837 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2838 that returns the language localized string formatted to a width
2839 based on gdbarch_addr_bit. */
2841 return hex_string_custom (address, 8);
2843 return hex_string_custom (address, 16);
2846 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2849 core_addr_hash (const void *ap)
2851 const CORE_ADDR *addrp = (const CORE_ADDR *) ap;
2856 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2859 core_addr_eq (const void *ap, const void *bp)
2861 const CORE_ADDR *addr_ap = (const CORE_ADDR *) ap;
2862 const CORE_ADDR *addr_bp = (const CORE_ADDR *) bp;
2864 return *addr_ap == *addr_bp;
2867 /* Convert a string back into a CORE_ADDR. */
2869 string_to_core_addr (const char *my_string)
2873 if (my_string[0] == '0' && tolower (my_string[1]) == 'x')
2875 /* Assume that it is in hex. */
2878 for (i = 2; my_string[i] != '\0'; i++)
2880 if (isdigit (my_string[i]))
2881 addr = (my_string[i] - '0') + (addr * 16);
2882 else if (isxdigit (my_string[i]))
2883 addr = (tolower (my_string[i]) - 'a' + 0xa) + (addr * 16);
2885 error (_("invalid hex \"%s\""), my_string);
2890 /* Assume that it is in decimal. */
2893 for (i = 0; my_string[i] != '\0'; i++)
2895 if (isdigit (my_string[i]))
2896 addr = (my_string[i] - '0') + (addr * 10);
2898 error (_("invalid decimal \"%s\""), my_string);
2906 gdb_realpath (const char *filename)
2908 /* On most hosts, we rely on canonicalize_file_name to compute
2909 the FILENAME's realpath.
2911 But the situation is slightly more complex on Windows, due to some
2912 versions of GCC which were reported to generate paths where
2913 backlashes (the directory separator) were doubled. For instance:
2914 c:\\some\\double\\slashes\\dir
2916 c:\some\double\slashes\dir
2917 Those double-slashes were getting in the way when comparing paths,
2918 for instance when trying to insert a breakpoint as follow:
2919 (gdb) b c:/some/double/slashes/dir/foo.c:4
2920 No source file named c:/some/double/slashes/dir/foo.c:4.
2921 (gdb) b c:\some\double\slashes\dir\foo.c:4
2922 No source file named c:\some\double\slashes\dir\foo.c:4.
2923 To prevent this from happening, we need this function to always
2924 strip those extra backslashes. While canonicalize_file_name does
2925 perform this simplification, it only works when the path is valid.
2926 Since the simplification would be useful even if the path is not
2927 valid (one can always set a breakpoint on a file, even if the file
2928 does not exist locally), we rely instead on GetFullPathName to
2929 perform the canonicalization. */
2931 #if defined (_WIN32)
2934 DWORD len = GetFullPathName (filename, MAX_PATH, buf, NULL);
2936 /* The file system is case-insensitive but case-preserving.
2937 So it is important we do not lowercase the path. Otherwise,
2938 we might not be able to display the original casing in a given
2940 if (len > 0 && len < MAX_PATH)
2941 return xstrdup (buf);
2945 char *rp = canonicalize_file_name (filename);
2952 /* This system is a lost cause, just dup the buffer. */
2953 return xstrdup (filename);
2956 /* Return a copy of FILENAME, with its directory prefix canonicalized
2960 gdb_realpath_keepfile (const char *filename)
2962 const char *base_name = lbasename (filename);
2967 /* Extract the basename of filename, and return immediately
2968 a copy of filename if it does not contain any directory prefix. */
2969 if (base_name == filename)
2970 return xstrdup (filename);
2972 dir_name = (char *) alloca ((size_t) (base_name - filename + 2));
2973 /* Allocate enough space to store the dir_name + plus one extra
2974 character sometimes needed under Windows (see below), and
2975 then the closing \000 character. */
2976 strncpy (dir_name, filename, base_name - filename);
2977 dir_name[base_name - filename] = '\000';
2979 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
2980 /* We need to be careful when filename is of the form 'd:foo', which
2981 is equivalent of d:./foo, which is totally different from d:/foo. */
2982 if (strlen (dir_name) == 2 && isalpha (dir_name[0]) && dir_name[1] == ':')
2985 dir_name[3] = '\000';
2989 /* Canonicalize the directory prefix, and build the resulting
2990 filename. If the dirname realpath already contains an ending
2991 directory separator, avoid doubling it. */
2992 real_path = gdb_realpath (dir_name);
2993 if (IS_DIR_SEPARATOR (real_path[strlen (real_path) - 1]))
2994 result = concat (real_path, base_name, (char *) NULL);
2996 result = concat (real_path, SLASH_STRING, base_name, (char *) NULL);
3002 /* Return PATH in absolute form, performing tilde-expansion if necessary.
3003 PATH cannot be NULL or the empty string.
3004 This does not resolve symlinks however, use gdb_realpath for that.
3005 Space for the result is allocated with malloc.
3006 If the path is already absolute, it is strdup'd.
3007 If there is a problem computing the absolute path, the path is returned
3008 unchanged (still strdup'd). */
3011 gdb_abspath (const char *path)
3013 gdb_assert (path != NULL && path[0] != '\0');
3016 return tilde_expand (path);
3018 if (IS_ABSOLUTE_PATH (path))
3019 return xstrdup (path);
3021 /* Beware the // my son, the Emacs barfs, the botch that catch... */
3022 return concat (current_directory,
3023 IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1])
3024 ? "" : SLASH_STRING,
3025 path, (char *) NULL);
3029 align_up (ULONGEST v, int n)
3031 /* Check that N is really a power of two. */
3032 gdb_assert (n && (n & (n-1)) == 0);
3033 return (v + n - 1) & -n;
3037 align_down (ULONGEST v, int n)
3039 /* Check that N is really a power of two. */
3040 gdb_assert (n && (n & (n-1)) == 0);
3044 /* Allocation function for the libiberty hash table which uses an
3045 obstack. The obstack is passed as DATA. */
3048 hashtab_obstack_allocate (void *data, size_t size, size_t count)
3050 size_t total = size * count;
3051 void *ptr = obstack_alloc ((struct obstack *) data, total);
3053 memset (ptr, 0, total);
3057 /* Trivial deallocation function for the libiberty splay tree and hash
3058 table - don't deallocate anything. Rely on later deletion of the
3059 obstack. DATA will be the obstack, although it is not needed
3063 dummy_obstack_deallocate (void *object, void *data)
3068 /* Simple, portable version of dirname that does not modify its
3072 ldirname (const char *filename)
3074 const char *base = lbasename (filename);
3077 while (base > filename && IS_DIR_SEPARATOR (base[-1]))
3080 if (base == filename)
3083 dirname = (char *) xmalloc (base - filename + 2);
3084 memcpy (dirname, filename, base - filename);
3086 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3087 create "d:./bar" later instead of the (different) "d:/bar". */
3088 if (base - filename == 2 && IS_ABSOLUTE_PATH (base)
3089 && !IS_DIR_SEPARATOR (filename[0]))
3090 dirname[base++ - filename] = '.';
3092 dirname[base - filename] = '\0';
3096 /* Call libiberty's buildargv, and return the result.
3097 If buildargv fails due to out-of-memory, call nomem.
3098 Therefore, the returned value is guaranteed to be non-NULL,
3099 unless the parameter itself is NULL. */
3102 gdb_buildargv (const char *s)
3104 char **argv = buildargv (s);
3106 if (s != NULL && argv == NULL)
3112 compare_positive_ints (const void *ap, const void *bp)
3114 /* Because we know we're comparing two ints which are positive,
3115 there's no danger of overflow here. */
3116 return * (int *) ap - * (int *) bp;
3119 /* String compare function for qsort. */
3122 compare_strings (const void *arg1, const void *arg2)
3124 const char **s1 = (const char **) arg1;
3125 const char **s2 = (const char **) arg2;
3127 return strcmp (*s1, *s2);
3130 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3131 #define AMBIGUOUS_MESS2 \
3132 ".\nUse \"set gnutarget format-name\" to specify the format."
3135 gdb_bfd_errmsg (bfd_error_type error_tag, char **matching)
3141 /* Check if errmsg just need simple return. */
3142 if (error_tag != bfd_error_file_ambiguously_recognized || matching == NULL)
3143 return bfd_errmsg (error_tag);
3145 ret_len = strlen (bfd_errmsg (error_tag)) + strlen (AMBIGUOUS_MESS1)
3146 + strlen (AMBIGUOUS_MESS2);
3147 for (p = matching; *p; p++)
3148 ret_len += strlen (*p) + 1;
3149 ret = (char *) xmalloc (ret_len + 1);
3151 make_cleanup (xfree, ret);
3153 strcpy (retp, bfd_errmsg (error_tag));
3154 retp += strlen (retp);
3156 strcpy (retp, AMBIGUOUS_MESS1);
3157 retp += strlen (retp);
3159 for (p = matching; *p; p++)
3161 sprintf (retp, " %s", *p);
3162 retp += strlen (retp);
3166 strcpy (retp, AMBIGUOUS_MESS2);
3171 /* Return ARGS parsed as a valid pid, or throw an error. */
3174 parse_pid_to_attach (const char *args)
3180 error_no_arg (_("process-id to attach"));
3182 dummy = (char *) args;
3183 pid = strtoul (args, &dummy, 0);
3184 /* Some targets don't set errno on errors, grrr! */
3185 if ((pid == 0 && dummy == args) || dummy != &args[strlen (args)])
3186 error (_("Illegal process-id: %s."), args);
3191 /* Helper for make_bpstat_clear_actions_cleanup. */
3194 do_bpstat_clear_actions_cleanup (void *unused)
3196 bpstat_clear_actions ();
3199 /* Call bpstat_clear_actions for the case an exception is throw. You should
3200 discard_cleanups if no exception is caught. */
3203 make_bpstat_clear_actions_cleanup (void)
3205 return make_cleanup (do_bpstat_clear_actions_cleanup, NULL);
3208 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3209 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3210 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3213 producer_is_gcc_ge_4 (const char *producer)
3217 if (! producer_is_gcc (producer, &major, &minor))
3226 /* Returns nonzero if the given PRODUCER string is GCC and sets the MAJOR
3227 and MINOR versions when not NULL. Returns zero if the given PRODUCER
3228 is NULL or it isn't GCC. */
3231 producer_is_gcc (const char *producer, int *major, int *minor)
3235 if (producer != NULL && startswith (producer, "GNU "))
3244 /* Skip any identifier after "GNU " - such as "C11" "C++" or "Java".
3245 A full producer string might look like:
3247 "GNU Fortran 4.8.2 20140120 (Red Hat 4.8.2-16) -mtune=generic ..."
3248 "GNU C++14 5.0.0 20150123 (experimental)"
3250 cs = &producer[strlen ("GNU ")];
3251 while (*cs && !isspace (*cs))
3253 if (*cs && isspace (*cs))
3255 if (sscanf (cs, "%d.%d", major, minor) == 2)
3259 /* Not recognized as GCC. */
3263 /* Helper for make_cleanup_free_char_ptr_vec. */
3266 do_free_char_ptr_vec (void *arg)
3268 VEC (char_ptr) *char_ptr_vec = (VEC (char_ptr) *) arg;
3270 free_char_ptr_vec (char_ptr_vec);
3273 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3274 final VEC_free for CHAR_PTR_VEC itself.
3276 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3277 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3278 this function does not (cannot) clear the pointer. */
3281 make_cleanup_free_char_ptr_vec (VEC (char_ptr) *char_ptr_vec)
3283 return make_cleanup (do_free_char_ptr_vec, char_ptr_vec);
3286 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3287 must come from xrealloc-compatible allocator and it may be updated. FROM
3288 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3289 located at the start or end of *STRINGP. */
3292 substitute_path_component (char **stringp, const char *from, const char *to)
3294 char *string = *stringp, *s;
3295 const size_t from_len = strlen (from);
3296 const size_t to_len = strlen (to);
3300 s = strstr (s, from);
3304 if ((s == string || IS_DIR_SEPARATOR (s[-1])
3305 || s[-1] == DIRNAME_SEPARATOR)
3306 && (s[from_len] == '\0' || IS_DIR_SEPARATOR (s[from_len])
3307 || s[from_len] == DIRNAME_SEPARATOR))
3312 = (char *) xrealloc (string, (strlen (string) + to_len + 1));
3314 /* Relocate the current S pointer. */
3315 s = s - string + string_new;
3316 string = string_new;
3318 /* Replace from by to. */
3319 memmove (&s[to_len], &s[from_len], strlen (&s[from_len]) + 1);
3320 memcpy (s, to, to_len);
3335 /* SIGALRM handler for waitpid_with_timeout. */
3338 sigalrm_handler (int signo)
3340 /* Nothing to do. */
3345 /* Wrapper to wait for child PID to die with TIMEOUT.
3346 TIMEOUT is the time to stop waiting in seconds.
3347 If TIMEOUT is zero, pass WNOHANG to waitpid.
3348 Returns PID if it was successfully waited for, otherwise -1.
3350 Timeouts are currently implemented with alarm and SIGALRM.
3351 If the host does not support them, this waits "forever".
3352 It would be odd though for a host to have waitpid and not SIGALRM. */
3355 wait_to_die_with_timeout (pid_t pid, int *status, int timeout)
3357 pid_t waitpid_result;
3359 gdb_assert (pid > 0);
3360 gdb_assert (timeout >= 0);
3365 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3366 struct sigaction sa, old_sa;
3368 sa.sa_handler = sigalrm_handler;
3369 sigemptyset (&sa.sa_mask);
3371 sigaction (SIGALRM, &sa, &old_sa);
3375 ofunc = signal (SIGALRM, sigalrm_handler);
3381 waitpid_result = waitpid (pid, status, 0);
3385 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3386 sigaction (SIGALRM, &old_sa, NULL);
3388 signal (SIGALRM, ofunc);
3393 waitpid_result = waitpid (pid, status, WNOHANG);
3395 if (waitpid_result == pid)
3401 #endif /* HAVE_WAITPID */
3403 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3404 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3406 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3407 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3410 gdb_filename_fnmatch (const char *pattern, const char *string, int flags)
3412 gdb_assert ((flags & FNM_FILE_NAME) != 0);
3414 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3415 gdb_assert ((flags & FNM_NOESCAPE) != 0);
3417 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3419 char *pattern_slash, *string_slash;
3421 /* Replace '\' by '/' in both strings. */
3423 pattern_slash = (char *) alloca (strlen (pattern) + 1);
3424 strcpy (pattern_slash, pattern);
3425 pattern = pattern_slash;
3426 for (; *pattern_slash != 0; pattern_slash++)
3427 if (IS_DIR_SEPARATOR (*pattern_slash))
3428 *pattern_slash = '/';
3430 string_slash = (char *) alloca (strlen (string) + 1);
3431 strcpy (string_slash, string);
3432 string = string_slash;
3433 for (; *string_slash != 0; string_slash++)
3434 if (IS_DIR_SEPARATOR (*string_slash))
3435 *string_slash = '/';
3437 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3439 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3440 flags |= FNM_CASEFOLD;
3441 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3443 return fnmatch (pattern, string, flags);
3446 /* Return the number of path elements in PATH.
3454 count_path_elements (const char *path)
3457 const char *p = path;
3459 if (HAS_DRIVE_SPEC (p))
3461 p = STRIP_DRIVE_SPEC (p);
3467 if (IS_DIR_SEPARATOR (*p))
3472 /* Backup one if last character is /, unless it's the only one. */
3473 if (p > path + 1 && IS_DIR_SEPARATOR (p[-1]))
3476 /* Add one for the file name, if present. */
3477 if (p > path && !IS_DIR_SEPARATOR (p[-1]))
3483 /* Remove N leading path elements from PATH.
3484 N must be non-negative.
3485 If PATH has more than N path elements then return NULL.
3486 If PATH has exactly N path elements then return "".
3487 See count_path_elements for a description of how we do the counting. */
3490 strip_leading_path_elements (const char *path, int n)
3493 const char *p = path;
3495 gdb_assert (n >= 0);
3500 if (HAS_DRIVE_SPEC (p))
3502 p = STRIP_DRIVE_SPEC (p);
3508 while (*p != '\0' && !IS_DIR_SEPARATOR (*p))
3523 /* Provide a prototype to silence -Wmissing-prototypes. */
3524 extern initialize_file_ftype _initialize_utils;
3527 _initialize_utils (void)
3529 add_internal_problem_command (&internal_error_problem);
3530 add_internal_problem_command (&internal_warning_problem);
3531 add_internal_problem_command (&demangler_warning_problem);