1 /* General utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2014 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 "exceptions.h"
26 #include "gdbthread.h"
29 #ifdef HAVE_SYS_RESOURCE_H
30 #include <sys/resource.h>
31 #endif /* HAVE_SYS_RESOURCE_H */
34 #include "tui/tui.h" /* For tui_get_command_dimension. */
42 #include "timeval-utils.h"
47 #include "gdb-demangle.h"
48 #include "expression.h"
52 #include "filenames.h"
54 #include "gdb_obstack.h"
60 #include "inferior.h" /* for signed_pointer_to_address */
62 #include "gdb_curses.h"
64 #include "readline/readline.h"
69 #include "gdb_usleep.h"
71 #include "gdb_regex.h"
74 extern PTR malloc (); /* ARI: PTR */
76 #if !HAVE_DECL_REALLOC
77 extern PTR realloc (); /* ARI: PTR */
83 void (*deprecated_error_begin_hook) (void);
85 /* Prototypes for local functions */
87 static void vfprintf_maybe_filtered (struct ui_file *, const char *,
88 va_list, int) ATTRIBUTE_PRINTF (2, 0);
90 static void fputs_maybe_filtered (const char *, struct ui_file *, int);
92 static void prompt_for_continue (void);
94 static void set_screen_size (void);
95 static void set_width (void);
97 /* Time spent in prompt_for_continue in the currently executing command
98 waiting for user to respond.
99 Initialized in make_command_stats_cleanup.
100 Modified in prompt_for_continue and defaulted_query.
101 Used in report_command_stats. */
103 static struct timeval prompt_for_continue_wait_time;
105 /* A flag indicating whether to timestamp debugging messages. */
107 static int debug_timestamp = 0;
109 /* Nonzero if we have job control. */
113 /* Nonzero means quit immediately if Control-C is typed now, rather
114 than waiting until QUIT is executed. Be careful in setting this;
115 code which executes with immediate_quit set has to be very careful
116 about being able to deal with being interrupted at any time. It is
117 almost always better to use QUIT; the only exception I can think of
118 is being able to quit out of a system call (using EINTR loses if
119 the SIGINT happens between the previous QUIT and the system call).
120 To immediately quit in the case in which a SIGINT happens between
121 the previous QUIT and setting immediate_quit (desirable anytime we
122 expect to block), call QUIT after setting immediate_quit. */
126 /* Nonzero means that strings with character values >0x7F should be printed
127 as octal escapes. Zero means just print the value (e.g. it's an
128 international character, and the terminal or window can cope.) */
130 int sevenbit_strings = 0;
132 show_sevenbit_strings (struct ui_file *file, int from_tty,
133 struct cmd_list_element *c, const char *value)
135 fprintf_filtered (file, _("Printing of 8-bit characters "
136 "in strings as \\nnn is %s.\n"),
140 /* String to be printed before warning messages, if any. */
142 char *warning_pre_print = "\nwarning: ";
144 int pagination_enabled = 1;
146 show_pagination_enabled (struct ui_file *file, int from_tty,
147 struct cmd_list_element *c, const char *value)
149 fprintf_filtered (file, _("State of pagination is %s.\n"), value);
153 /* Cleanup utilities.
155 These are not defined in cleanups.c (nor declared in cleanups.h)
156 because while they use the "cleanup API" they are not part of the
160 do_freeargv (void *arg)
162 freeargv ((char **) arg);
166 make_cleanup_freeargv (char **arg)
168 return make_cleanup (do_freeargv, arg);
172 do_dyn_string_delete (void *arg)
174 dyn_string_delete ((dyn_string_t) arg);
178 make_cleanup_dyn_string_delete (dyn_string_t arg)
180 return make_cleanup (do_dyn_string_delete, arg);
184 do_bfd_close_cleanup (void *arg)
190 make_cleanup_bfd_unref (bfd *abfd)
192 return make_cleanup (do_bfd_close_cleanup, abfd);
196 do_close_cleanup (void *arg)
204 make_cleanup_close (int fd)
206 int *saved_fd = xmalloc (sizeof (fd));
209 return make_cleanup_dtor (do_close_cleanup, saved_fd, xfree);
212 /* Helper function which does the work for make_cleanup_fclose. */
215 do_fclose_cleanup (void *arg)
222 /* Return a new cleanup that closes FILE. */
225 make_cleanup_fclose (FILE *file)
227 return make_cleanup (do_fclose_cleanup, file);
230 /* Helper function which does the work for make_cleanup_obstack_free. */
233 do_obstack_free (void *arg)
235 struct obstack *ob = arg;
237 obstack_free (ob, NULL);
240 /* Return a new cleanup that frees OBSTACK. */
243 make_cleanup_obstack_free (struct obstack *obstack)
245 return make_cleanup (do_obstack_free, obstack);
249 do_ui_file_delete (void *arg)
251 ui_file_delete (arg);
255 make_cleanup_ui_file_delete (struct ui_file *arg)
257 return make_cleanup (do_ui_file_delete, arg);
260 /* Helper function for make_cleanup_ui_out_redirect_pop. */
263 do_ui_out_redirect_pop (void *arg)
265 struct ui_out *uiout = arg;
267 if (ui_out_redirect (uiout, NULL) < 0)
268 warning (_("Cannot restore redirection of the current output protocol"));
271 /* Return a new cleanup that pops the last redirection by ui_out_redirect
272 with NULL parameter. */
275 make_cleanup_ui_out_redirect_pop (struct ui_out *uiout)
277 return make_cleanup (do_ui_out_redirect_pop, uiout);
281 do_free_section_addr_info (void *arg)
283 free_section_addr_info (arg);
287 make_cleanup_free_section_addr_info (struct section_addr_info *addrs)
289 return make_cleanup (do_free_section_addr_info, addrs);
292 struct restore_integer_closure
299 restore_integer (void *p)
301 struct restore_integer_closure *closure = p;
303 *(closure->variable) = closure->value;
306 /* Remember the current value of *VARIABLE and make it restored when
307 the cleanup is run. */
310 make_cleanup_restore_integer (int *variable)
312 struct restore_integer_closure *c =
313 xmalloc (sizeof (struct restore_integer_closure));
315 c->variable = variable;
316 c->value = *variable;
318 return make_cleanup_dtor (restore_integer, (void *) c, xfree);
321 /* Remember the current value of *VARIABLE and make it restored when
322 the cleanup is run. */
325 make_cleanup_restore_uinteger (unsigned int *variable)
327 return make_cleanup_restore_integer ((int *) variable);
330 /* Helper for make_cleanup_unpush_target. */
333 do_unpush_target (void *arg)
335 struct target_ops *ops = arg;
340 /* Return a new cleanup that unpushes OPS. */
343 make_cleanup_unpush_target (struct target_ops *ops)
345 return make_cleanup (do_unpush_target, ops);
348 /* Helper for make_cleanup_htab_delete compile time checking the types. */
351 do_htab_delete_cleanup (void *htab_voidp)
353 htab_t htab = htab_voidp;
358 /* Return a new cleanup that deletes HTAB. */
361 make_cleanup_htab_delete (htab_t htab)
363 return make_cleanup (do_htab_delete_cleanup, htab);
366 struct restore_ui_file_closure
368 struct ui_file **variable;
369 struct ui_file *value;
373 do_restore_ui_file (void *p)
375 struct restore_ui_file_closure *closure = p;
377 *(closure->variable) = closure->value;
380 /* Remember the current value of *VARIABLE and make it restored when
381 the cleanup is run. */
384 make_cleanup_restore_ui_file (struct ui_file **variable)
386 struct restore_ui_file_closure *c = XNEW (struct restore_ui_file_closure);
388 c->variable = variable;
389 c->value = *variable;
391 return make_cleanup_dtor (do_restore_ui_file, (void *) c, xfree);
394 /* Helper for make_cleanup_value_free_to_mark. */
397 do_value_free_to_mark (void *value)
399 value_free_to_mark ((struct value *) value);
402 /* Free all values allocated since MARK was obtained by value_mark
403 (except for those released) when the cleanup is run. */
406 make_cleanup_value_free_to_mark (struct value *mark)
408 return make_cleanup (do_value_free_to_mark, mark);
411 /* Helper for make_cleanup_value_free. */
414 do_value_free (void *value)
422 make_cleanup_value_free (struct value *value)
424 return make_cleanup (do_value_free, value);
427 /* Helper for make_cleanup_free_so. */
430 do_free_so (void *arg)
432 struct so_list *so = arg;
437 /* Make cleanup handler calling free_so for SO. */
440 make_cleanup_free_so (struct so_list *so)
442 return make_cleanup (do_free_so, so);
445 /* Helper for make_cleanup_restore_current_language. */
448 do_restore_current_language (void *p)
450 enum language saved_lang = (uintptr_t) p;
452 set_language (saved_lang);
455 /* Remember the current value of CURRENT_LANGUAGE and make it restored when
456 the cleanup is run. */
459 make_cleanup_restore_current_language (void)
461 enum language saved_lang = current_language->la_language;
463 return make_cleanup (do_restore_current_language,
464 (void *) (uintptr_t) saved_lang);
467 /* Helper function for make_cleanup_clear_parser_state. */
470 do_clear_parser_state (void *ptr)
472 struct parser_state **p = (struct parser_state **) ptr;
477 /* Clean (i.e., set to NULL) the parser state variable P. */
480 make_cleanup_clear_parser_state (struct parser_state **p)
482 return make_cleanup (do_clear_parser_state, (void *) p);
485 /* This function is useful for cleanups.
489 old_chain = make_cleanup (free_current_contents, &foo);
491 to arrange to free the object thus allocated. */
494 free_current_contents (void *ptr)
496 void **location = ptr;
498 if (location == NULL)
499 internal_error (__FILE__, __LINE__,
500 _("free_current_contents: NULL pointer"));
501 if (*location != NULL)
510 /* Print a warning message. The first argument STRING is the warning
511 message, used as an fprintf format string, the second is the
512 va_list of arguments for that string. A warning is unfiltered (not
513 paginated) so that the user does not need to page through each
514 screen full of warnings when there are lots of them. */
517 vwarning (const char *string, va_list args)
519 if (deprecated_warning_hook)
520 (*deprecated_warning_hook) (string, args);
523 if (target_supports_terminal_ours ())
524 target_terminal_ours ();
525 if (filtered_printing_initialized ())
526 wrap_here (""); /* Force out any buffered output. */
527 gdb_flush (gdb_stdout);
528 if (warning_pre_print)
529 fputs_unfiltered (warning_pre_print, gdb_stderr);
530 vfprintf_unfiltered (gdb_stderr, string, args);
531 fprintf_unfiltered (gdb_stderr, "\n");
535 /* Print an error message and return to command level.
536 The first argument STRING is the error message, used as a fprintf string,
537 and the remaining args are passed as arguments to it. */
540 verror (const char *string, va_list args)
542 throw_verror (GENERIC_ERROR, string, args);
546 error_stream (struct ui_file *stream)
548 char *message = ui_file_xstrdup (stream, NULL);
550 make_cleanup (xfree, message);
551 error (("%s"), message);
554 /* Emit a message and abort. */
556 static void ATTRIBUTE_NORETURN
557 abort_with_message (const char *msg)
559 if (gdb_stderr == NULL)
562 fputs_unfiltered (msg, gdb_stderr);
564 abort (); /* NOTE: GDB has only three calls to abort(). */
567 /* Dump core trying to increase the core soft limit to hard limit first. */
572 #ifdef HAVE_SETRLIMIT
573 struct rlimit rlim = { RLIM_INFINITY, RLIM_INFINITY };
575 setrlimit (RLIMIT_CORE, &rlim);
576 #endif /* HAVE_SETRLIMIT */
578 abort (); /* NOTE: GDB has only three calls to abort(). */
581 /* Check whether GDB will be able to dump core using the dump_core
582 function. Returns zero if GDB cannot or should not dump core.
583 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
584 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
587 can_dump_core (enum resource_limit_kind limit_kind)
589 #ifdef HAVE_GETRLIMIT
592 /* Be quiet and assume we can dump if an error is returned. */
593 if (getrlimit (RLIMIT_CORE, &rlim) != 0)
599 if (rlim.rlim_cur == 0)
603 if (rlim.rlim_max == 0)
606 #endif /* HAVE_GETRLIMIT */
611 /* Print a warning that we cannot dump core. */
614 warn_cant_dump_core (const char *reason)
616 fprintf_unfiltered (gdb_stderr,
617 _("%s\nUnable to dump core, use `ulimit -c"
618 " unlimited' before executing GDB next time.\n"),
622 /* Check whether GDB will be able to dump core using the dump_core
623 function, and print a warning if we cannot. */
626 can_dump_core_warn (enum resource_limit_kind limit_kind,
629 int core_dump_allowed = can_dump_core (limit_kind);
631 if (!core_dump_allowed)
632 warn_cant_dump_core (reason);
634 return core_dump_allowed;
637 /* Allow the user to configure the debugger behavior with respect to
638 what to do when an internal problem is detected. */
640 const char internal_problem_ask[] = "ask";
641 const char internal_problem_yes[] = "yes";
642 const char internal_problem_no[] = "no";
643 static const char *const internal_problem_modes[] =
645 internal_problem_ask,
646 internal_problem_yes,
651 /* Print a message reporting an internal error/warning. Ask the user
652 if they want to continue, dump core, or just exit. Return
653 something to indicate a quit. */
655 struct internal_problem
658 int user_settable_should_quit;
659 const char *should_quit;
660 int user_settable_should_dump_core;
661 const char *should_dump_core;
664 /* Report a problem, internal to GDB, to the user. Once the problem
665 has been reported, and assuming GDB didn't quit, the caller can
666 either allow execution to resume or throw an error. */
668 static void ATTRIBUTE_PRINTF (4, 0)
669 internal_vproblem (struct internal_problem *problem,
670 const char *file, int line, const char *fmt, va_list ap)
676 struct cleanup *cleanup = make_cleanup (null_cleanup, NULL);
678 /* Don't allow infinite error/warning recursion. */
680 static char msg[] = "Recursive internal problem.\n";
689 abort_with_message (msg);
692 /* Newer GLIBC versions put the warn_unused_result attribute
693 on write, but this is one of those rare cases where
694 ignoring the return value is correct. Casting to (void)
695 does not fix this problem. This is the solution suggested
696 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
697 if (write (STDERR_FILENO, msg, sizeof (msg)) != sizeof (msg))
698 abort (); /* NOTE: GDB has only three calls to abort(). */
703 /* Create a string containing the full error/warning message. Need
704 to call query with this full string, as otherwize the reason
705 (error/warning) and question become separated. Format using a
706 style similar to a compiler error message. Include extra detail
707 so that the user knows that they are living on the edge. */
711 msg = xstrvprintf (fmt, ap);
712 reason = xstrprintf ("%s:%d: %s: %s\n"
713 "A problem internal to GDB has been detected,\n"
714 "further debugging may prove unreliable.",
715 file, line, problem->name, msg);
717 make_cleanup (xfree, reason);
720 /* Fall back to abort_with_message if gdb_stderr is not set up. */
721 if (gdb_stderr == NULL)
723 fputs (reason, stderr);
724 abort_with_message ("\n");
727 /* Try to get the message out and at the start of a new line. */
728 if (target_supports_terminal_ours ())
729 target_terminal_ours ();
730 if (filtered_printing_initialized ())
733 /* Emit the message unless query will emit it below. */
734 if (problem->should_quit != internal_problem_ask
736 || !filtered_printing_initialized ())
737 fprintf_unfiltered (gdb_stderr, "%s\n", reason);
739 if (problem->should_quit == internal_problem_ask)
741 /* Default (yes/batch case) is to quit GDB. When in batch mode
742 this lessens the likelihood of GDB going into an infinite
744 if (!confirm || !filtered_printing_initialized ())
747 quit_p = query (_("%s\nQuit this debugging session? "), reason);
749 else if (problem->should_quit == internal_problem_yes)
751 else if (problem->should_quit == internal_problem_no)
754 internal_error (__FILE__, __LINE__, _("bad switch"));
756 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr);
757 if (REPORT_BUGS_TO[0])
758 fprintf_unfiltered (gdb_stderr, _(" For instructions, see:\n%s."),
760 fputs_unfiltered ("\n\n", gdb_stderr);
762 if (problem->should_dump_core == internal_problem_ask)
764 if (!can_dump_core_warn (LIMIT_MAX, reason))
766 else if (!filtered_printing_initialized ())
770 /* Default (yes/batch case) is to dump core. This leaves a GDB
771 `dropping' so that it is easier to see that something went
773 dump_core_p = query (_("%s\nCreate a core file of GDB? "), reason);
776 else if (problem->should_dump_core == internal_problem_yes)
777 dump_core_p = can_dump_core_warn (LIMIT_MAX, reason);
778 else if (problem->should_dump_core == internal_problem_no)
781 internal_error (__FILE__, __LINE__, _("bad switch"));
794 #ifdef HAVE_WORKING_FORK
802 do_cleanups (cleanup);
805 static struct internal_problem internal_error_problem = {
806 "internal-error", 1, internal_problem_ask, 1, internal_problem_ask
810 internal_verror (const char *file, int line, const char *fmt, va_list ap)
812 internal_vproblem (&internal_error_problem, file, line, fmt, ap);
813 throw_quit (_("Command aborted."));
816 static struct internal_problem internal_warning_problem = {
817 "internal-warning", 1, internal_problem_ask, 1, internal_problem_ask
821 internal_vwarning (const char *file, int line, const char *fmt, va_list ap)
823 internal_vproblem (&internal_warning_problem, file, line, fmt, ap);
826 static struct internal_problem demangler_warning_problem = {
827 "demangler-warning", 1, internal_problem_ask, 0, internal_problem_no
831 demangler_vwarning (const char *file, int line, const char *fmt, va_list ap)
833 internal_vproblem (&demangler_warning_problem, file, line, fmt, ap);
837 demangler_warning (const char *file, int line, const char *string, ...)
841 va_start (ap, string);
842 demangler_vwarning (file, line, string, ap);
846 /* Dummy functions to keep add_prefix_cmd happy. */
849 set_internal_problem_cmd (char *args, int from_tty)
854 show_internal_problem_cmd (char *args, int from_tty)
858 /* When GDB reports an internal problem (error or warning) it gives
859 the user the opportunity to quit GDB and/or create a core file of
860 the current debug session. This function registers a few commands
861 that make it possible to specify that GDB should always or never
862 quit or create a core file, without asking. The commands look
865 maint set PROBLEM-NAME quit ask|yes|no
866 maint show PROBLEM-NAME quit
867 maint set PROBLEM-NAME corefile ask|yes|no
868 maint show PROBLEM-NAME corefile
870 Where PROBLEM-NAME is currently "internal-error" or
871 "internal-warning". */
874 add_internal_problem_command (struct internal_problem *problem)
876 struct cmd_list_element **set_cmd_list;
877 struct cmd_list_element **show_cmd_list;
881 set_cmd_list = xmalloc (sizeof (*set_cmd_list));
882 show_cmd_list = xmalloc (sizeof (*set_cmd_list));
883 *set_cmd_list = NULL;
884 *show_cmd_list = NULL;
886 set_doc = xstrprintf (_("Configure what GDB does when %s is detected."),
889 show_doc = xstrprintf (_("Show what GDB does when %s is detected."),
892 add_prefix_cmd ((char*) problem->name,
893 class_maintenance, set_internal_problem_cmd, set_doc,
895 concat ("maintenance set ", problem->name, " ",
897 0/*allow-unknown*/, &maintenance_set_cmdlist);
899 add_prefix_cmd ((char*) problem->name,
900 class_maintenance, show_internal_problem_cmd, show_doc,
902 concat ("maintenance show ", problem->name, " ",
904 0/*allow-unknown*/, &maintenance_show_cmdlist);
906 if (problem->user_settable_should_quit)
908 set_doc = xstrprintf (_("Set whether GDB should quit "
909 "when an %s is detected"),
911 show_doc = xstrprintf (_("Show whether GDB will quit "
912 "when an %s is detected"),
914 add_setshow_enum_cmd ("quit", class_maintenance,
915 internal_problem_modes,
916 &problem->should_quit,
929 if (problem->user_settable_should_dump_core)
931 set_doc = xstrprintf (_("Set whether GDB should create a core "
932 "file of GDB when %s is detected"),
934 show_doc = xstrprintf (_("Show whether GDB will create a core "
935 "file of GDB when %s is detected"),
937 add_setshow_enum_cmd ("corefile", class_maintenance,
938 internal_problem_modes,
939 &problem->should_dump_core,
953 /* Return a newly allocated string, containing the PREFIX followed
954 by the system error message for errno (separated by a colon).
956 The result must be deallocated after use. */
959 perror_string (const char *prefix)
964 err = safe_strerror (errno);
965 combined = (char *) xmalloc (strlen (err) + strlen (prefix) + 3);
966 strcpy (combined, prefix);
967 strcat (combined, ": ");
968 strcat (combined, err);
973 /* Print the system error message for errno, and also mention STRING
974 as the file name for which the error was encountered. Use ERRCODE
975 for the thrown exception. Then return to command level. */
978 throw_perror_with_name (enum errors errcode, const char *string)
982 combined = perror_string (string);
983 make_cleanup (xfree, combined);
985 /* I understand setting these is a matter of taste. Still, some people
986 may clear errno but not know about bfd_error. Doing this here is not
988 bfd_set_error (bfd_error_no_error);
991 throw_error (errcode, _("%s."), combined);
994 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
997 perror_with_name (const char *string)
999 throw_perror_with_name (GENERIC_ERROR, string);
1002 /* Same as perror_with_name except that it prints a warning instead
1003 of throwing an error. */
1006 perror_warning_with_name (const char *string)
1010 combined = perror_string (string);
1011 warning (_("%s"), combined);
1015 /* Print the system error message for ERRCODE, and also mention STRING
1016 as the file name for which the error was encountered. */
1019 print_sys_errmsg (const char *string, int errcode)
1024 err = safe_strerror (errcode);
1025 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
1026 strcpy (combined, string);
1027 strcat (combined, ": ");
1028 strcat (combined, err);
1030 /* We want anything which was printed on stdout to come out first, before
1032 gdb_flush (gdb_stdout);
1033 fprintf_unfiltered (gdb_stderr, "%s.\n", combined);
1036 /* Control C eventually causes this to be called, at a convenient time. */
1041 if (sync_quit_force_run)
1043 sync_quit_force_run = 0;
1044 quit_force (NULL, stdin == instream);
1048 /* No steenking SIGINT will ever be coming our way when the
1049 program is resumed. Don't lie. */
1050 throw_quit ("Quit");
1053 /* If there is no terminal switching for this target, then we can't
1054 possibly get screwed by the lack of job control. */
1055 || !target_supports_terminal_ours ())
1056 throw_quit ("Quit");
1058 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
1063 /* Called when a memory allocation fails, with the number of bytes of
1064 memory requested in SIZE. */
1067 malloc_failure (long size)
1071 internal_error (__FILE__, __LINE__,
1072 _("virtual memory exhausted: can't allocate %ld bytes."),
1077 internal_error (__FILE__, __LINE__, _("virtual memory exhausted."));
1081 /* My replacement for the read system call.
1082 Used like `read' but keeps going if `read' returns too soon. */
1085 myread (int desc, char *addr, int len)
1092 val = read (desc, addr, len);
1096 return orglen - len;
1104 print_spaces (int n, struct ui_file *file)
1106 fputs_unfiltered (n_spaces (n), file);
1109 /* Print a host address. */
1112 gdb_print_host_address (const void *addr, struct ui_file *stream)
1114 fprintf_filtered (stream, "%s", host_address_to_string (addr));
1118 /* A cleanup function that calls regfree. */
1121 do_regfree_cleanup (void *r)
1126 /* Create a new cleanup that frees the compiled regular expression R. */
1129 make_regfree_cleanup (regex_t *r)
1131 return make_cleanup (do_regfree_cleanup, r);
1134 /* Return an xmalloc'd error message resulting from a regular
1135 expression compilation failure. */
1138 get_regcomp_error (int code, regex_t *rx)
1140 size_t length = regerror (code, rx, NULL, 0);
1141 char *result = xmalloc (length);
1143 regerror (code, rx, result, length);
1147 /* Compile a regexp and throw an exception on error. This returns a
1148 cleanup to free the resulting pattern on success. RX must not be
1152 compile_rx_or_error (regex_t *pattern, const char *rx, const char *message)
1156 gdb_assert (rx != NULL);
1158 code = regcomp (pattern, rx, REG_NOSUB);
1161 char *err = get_regcomp_error (code, pattern);
1163 make_cleanup (xfree, err);
1164 error (("%s: %s"), message, err);
1167 return make_regfree_cleanup (pattern);
1172 /* This function supports the query, nquery, and yquery functions.
1173 Ask user a y-or-n question and return 0 if answer is no, 1 if
1174 answer is yes, or default the answer to the specified default
1175 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1176 default answer, or '\0' for no default.
1177 CTLSTR is the control string and should end in "? ". It should
1178 not say how to answer, because we do that.
1179 ARGS are the arguments passed along with the CTLSTR argument to
1182 static int ATTRIBUTE_PRINTF (1, 0)
1183 defaulted_query (const char *ctlstr, const char defchar, va_list args)
1189 char def_answer, not_def_answer;
1190 char *y_string, *n_string, *question;
1191 /* Used to add duration we waited for user to respond to
1192 prompt_for_continue_wait_time. */
1193 struct timeval prompt_started, prompt_ended, prompt_delta;
1195 /* Set up according to which answer is the default. */
1196 if (defchar == '\0')
1200 not_def_answer = 'N';
1204 else if (defchar == 'y')
1208 not_def_answer = 'N';
1216 not_def_answer = 'Y';
1221 /* Automatically answer the default value if the user did not want
1222 prompts or the command was issued with the server prefix. */
1223 if (!confirm || server_command)
1226 /* If input isn't coming from the user directly, just say what
1227 question we're asking, and then answer the default automatically. This
1228 way, important error messages don't get lost when talking to GDB
1230 if (! input_from_terminal_p ())
1233 vfprintf_filtered (gdb_stdout, ctlstr, args);
1235 printf_filtered (_("(%s or %s) [answered %c; "
1236 "input not from terminal]\n"),
1237 y_string, n_string, def_answer);
1238 gdb_flush (gdb_stdout);
1243 if (deprecated_query_hook)
1245 return deprecated_query_hook (ctlstr, args);
1248 /* Format the question outside of the loop, to avoid reusing args. */
1249 question = xstrvprintf (ctlstr, args);
1251 /* Used for calculating time spend waiting for user. */
1252 gettimeofday (&prompt_started, NULL);
1256 wrap_here (""); /* Flush any buffered output. */
1257 gdb_flush (gdb_stdout);
1259 if (annotation_level > 1)
1260 printf_filtered (("\n\032\032pre-query\n"));
1262 fputs_filtered (question, gdb_stdout);
1263 printf_filtered (_("(%s or %s) "), y_string, n_string);
1265 if (annotation_level > 1)
1266 printf_filtered (("\n\032\032query\n"));
1269 gdb_flush (gdb_stdout);
1271 answer = fgetc (stdin);
1273 /* We expect fgetc to block until a character is read. But
1274 this may not be the case if the terminal was opened with
1275 the NONBLOCK flag. In that case, if there is nothing to
1276 read on stdin, fgetc returns EOF, but also sets the error
1277 condition flag on stdin and errno to EAGAIN. With a true
1278 EOF, stdin's error condition flag is not set.
1280 A situation where this behavior was observed is a pseudo
1282 while (answer == EOF && ferror (stdin) && errno == EAGAIN)
1284 /* Not a real EOF. Wait a little while and try again until
1285 we read something. */
1288 answer = fgetc (stdin);
1291 clearerr (stdin); /* in case of C-d */
1292 if (answer == EOF) /* C-d */
1294 printf_filtered ("EOF [assumed %c]\n", def_answer);
1298 /* Eat rest of input line, to EOF or newline. */
1302 ans2 = fgetc (stdin);
1305 while (ans2 != EOF && ans2 != '\n' && ans2 != '\r');
1309 /* Check answer. For the non-default, the user must specify
1310 the non-default explicitly. */
1311 if (answer == not_def_answer)
1313 retval = !def_value;
1316 /* Otherwise, if a default was specified, the user may either
1317 specify the required input or have it default by entering
1319 if (answer == def_answer
1320 || (defchar != '\0' &&
1321 (answer == '\n' || answer == '\r' || answer == EOF)))
1326 /* Invalid entries are not defaulted and require another selection. */
1327 printf_filtered (_("Please answer %s or %s.\n"),
1328 y_string, n_string);
1331 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1332 gettimeofday (&prompt_ended, NULL);
1333 timeval_sub (&prompt_delta, &prompt_ended, &prompt_started);
1334 timeval_add (&prompt_for_continue_wait_time,
1335 &prompt_for_continue_wait_time, &prompt_delta);
1338 if (annotation_level > 1)
1339 printf_filtered (("\n\032\032post-query\n"));
1344 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1345 answer is yes, or 0 if answer is defaulted.
1346 Takes three args which are given to printf to print the question.
1347 The first, a control string, should end in "? ".
1348 It should not say how to answer, because we do that. */
1351 nquery (const char *ctlstr, ...)
1356 va_start (args, ctlstr);
1357 ret = defaulted_query (ctlstr, 'n', args);
1362 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1363 answer is yes, or 1 if answer is defaulted.
1364 Takes three args which are given to printf to print the question.
1365 The first, a control string, should end in "? ".
1366 It should not say how to answer, because we do that. */
1369 yquery (const char *ctlstr, ...)
1374 va_start (args, ctlstr);
1375 ret = defaulted_query (ctlstr, 'y', args);
1380 /* Ask user a y-or-n question and return 1 iff answer is yes.
1381 Takes three args which are given to printf to print the question.
1382 The first, a control string, should end in "? ".
1383 It should not say how to answer, because we do that. */
1386 query (const char *ctlstr, ...)
1391 va_start (args, ctlstr);
1392 ret = defaulted_query (ctlstr, '\0', args);
1397 /* A helper for parse_escape that converts a host character to a
1398 target character. C is the host character. If conversion is
1399 possible, then the target character is stored in *TARGET_C and the
1400 function returns 1. Otherwise, the function returns 0. */
1403 host_char_to_target (struct gdbarch *gdbarch, int c, int *target_c)
1405 struct obstack host_data;
1407 struct cleanup *cleanups;
1410 obstack_init (&host_data);
1411 cleanups = make_cleanup_obstack_free (&host_data);
1413 convert_between_encodings (target_charset (gdbarch), host_charset (),
1414 (gdb_byte *) &the_char, 1, 1,
1415 &host_data, translit_none);
1417 if (obstack_object_size (&host_data) == 1)
1420 *target_c = *(char *) obstack_base (&host_data);
1423 do_cleanups (cleanups);
1427 /* Parse a C escape sequence. STRING_PTR points to a variable
1428 containing a pointer to the string to parse. That pointer
1429 should point to the character after the \. That pointer
1430 is updated past the characters we use. The value of the
1431 escape sequence is returned.
1433 A negative value means the sequence \ newline was seen,
1434 which is supposed to be equivalent to nothing at all.
1436 If \ is followed by a null character, we return a negative
1437 value and leave the string pointer pointing at the null character.
1439 If \ is followed by 000, we return 0 and leave the string pointer
1440 after the zeros. A value of 0 does not mean end of string. */
1443 parse_escape (struct gdbarch *gdbarch, const char **string_ptr)
1445 int target_char = -2; /* Initialize to avoid GCC warnings. */
1446 int c = *(*string_ptr)++;
1465 int i = host_hex_value (c);
1470 if (isdigit (c) && c != '8' && c != '9')
1474 i += host_hex_value (c);
1510 if (!host_char_to_target (gdbarch, c, &target_char))
1511 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1512 " which has no equivalent\nin the `%s' character set."),
1513 c, c, target_charset (gdbarch));
1517 /* Print the character C on STREAM as part of the contents of a literal
1518 string whose delimiter is QUOTER. Note that this routine should only
1519 be call for printing things which are independent of the language
1520 of the program being debugged.
1522 printchar will normally escape backslashes and instances of QUOTER. If
1523 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1524 As a side effect, if you pass the backslash character as the QUOTER,
1525 printchar will escape backslashes as usual, but not any other quoting
1529 printchar (int c, void (*do_fputs) (const char *, struct ui_file *),
1530 void (*do_fprintf) (struct ui_file *, const char *, ...)
1531 ATTRIBUTE_FPTR_PRINTF_2, struct ui_file *stream, int quoter)
1533 c &= 0xFF; /* Avoid sign bit follies */
1535 if (c < 0x20 || /* Low control chars */
1536 (c >= 0x7F && c < 0xA0) || /* DEL, High controls */
1537 (sevenbit_strings && c >= 0x80))
1538 { /* high order bit set */
1542 do_fputs ("\\n", stream);
1545 do_fputs ("\\b", stream);
1548 do_fputs ("\\t", stream);
1551 do_fputs ("\\f", stream);
1554 do_fputs ("\\r", stream);
1557 do_fputs ("\\e", stream);
1560 do_fputs ("\\a", stream);
1563 do_fprintf (stream, "\\%.3o", (unsigned int) c);
1569 if (quoter != 0 && (c == '\\' || c == quoter))
1570 do_fputs ("\\", stream);
1571 do_fprintf (stream, "%c", c);
1575 /* Print the character C on STREAM as part of the contents of a
1576 literal string whose delimiter is QUOTER. Note that these routines
1577 should only be call for printing things which are independent of
1578 the language of the program being debugged. */
1581 fputstr_filtered (const char *str, int quoter, struct ui_file *stream)
1584 printchar (*str++, fputs_filtered, fprintf_filtered, stream, quoter);
1588 fputstr_unfiltered (const char *str, int quoter, struct ui_file *stream)
1591 printchar (*str++, fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1595 fputstrn_filtered (const char *str, int n, int quoter,
1596 struct ui_file *stream)
1600 for (i = 0; i < n; i++)
1601 printchar (str[i], fputs_filtered, fprintf_filtered, stream, quoter);
1605 fputstrn_unfiltered (const char *str, int n, int quoter,
1606 struct ui_file *stream)
1610 for (i = 0; i < n; i++)
1611 printchar (str[i], fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1615 /* Number of lines per page or UINT_MAX if paging is disabled. */
1616 static unsigned int lines_per_page;
1618 show_lines_per_page (struct ui_file *file, int from_tty,
1619 struct cmd_list_element *c, const char *value)
1621 fprintf_filtered (file,
1622 _("Number of lines gdb thinks are in a page is %s.\n"),
1626 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1627 static unsigned int chars_per_line;
1629 show_chars_per_line (struct ui_file *file, int from_tty,
1630 struct cmd_list_element *c, const char *value)
1632 fprintf_filtered (file,
1633 _("Number of characters gdb thinks "
1634 "are in a line is %s.\n"),
1638 /* Current count of lines printed on this page, chars on this line. */
1639 static unsigned int lines_printed, chars_printed;
1641 /* Buffer and start column of buffered text, for doing smarter word-
1642 wrapping. When someone calls wrap_here(), we start buffering output
1643 that comes through fputs_filtered(). If we see a newline, we just
1644 spit it out and forget about the wrap_here(). If we see another
1645 wrap_here(), we spit it out and remember the newer one. If we see
1646 the end of the line, we spit out a newline, the indent, and then
1647 the buffered output. */
1649 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1650 are waiting to be output (they have already been counted in chars_printed).
1651 When wrap_buffer[0] is null, the buffer is empty. */
1652 static char *wrap_buffer;
1654 /* Pointer in wrap_buffer to the next character to fill. */
1655 static char *wrap_pointer;
1657 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1659 static char *wrap_indent;
1661 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1662 is not in effect. */
1663 static int wrap_column;
1666 /* Inialize the number of lines per page and chars per line. */
1669 init_page_info (void)
1673 lines_per_page = UINT_MAX;
1674 chars_per_line = UINT_MAX;
1678 if (!tui_get_command_dimension (&chars_per_line, &lines_per_page))
1683 #if defined(__GO32__)
1684 rows = ScreenRows ();
1685 cols = ScreenCols ();
1686 lines_per_page = rows;
1687 chars_per_line = cols;
1689 /* Make sure Readline has initialized its terminal settings. */
1690 rl_reset_terminal (NULL);
1692 /* Get the screen size from Readline. */
1693 rl_get_screen_size (&rows, &cols);
1694 lines_per_page = rows;
1695 chars_per_line = cols;
1697 /* Readline should have fetched the termcap entry for us.
1698 Only try to use tgetnum function if rl_get_screen_size
1699 did not return a useful value. */
1700 if (((rows <= 0) && (tgetnum ("li") < 0))
1701 /* Also disable paging if inside EMACS. */
1702 || getenv ("EMACS"))
1704 /* The number of lines per page is not mentioned in the terminal
1705 description or EMACS evironment variable is set. This probably
1706 means that paging is not useful, so disable paging. */
1707 lines_per_page = UINT_MAX;
1710 /* If the output is not a terminal, don't paginate it. */
1711 if (!ui_file_isatty (gdb_stdout))
1712 lines_per_page = UINT_MAX;
1720 /* Return nonzero if filtered printing is initialized. */
1722 filtered_printing_initialized (void)
1724 return wrap_buffer != NULL;
1727 /* Helper for make_cleanup_restore_page_info. */
1730 do_restore_page_info_cleanup (void *arg)
1736 /* Provide cleanup for restoring the terminal size. */
1739 make_cleanup_restore_page_info (void)
1741 struct cleanup *back_to;
1743 back_to = make_cleanup (do_restore_page_info_cleanup, NULL);
1744 make_cleanup_restore_uinteger (&lines_per_page);
1745 make_cleanup_restore_uinteger (&chars_per_line);
1750 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1751 Provide cleanup for restoring the original state. */
1754 set_batch_flag_and_make_cleanup_restore_page_info (void)
1756 struct cleanup *back_to = make_cleanup_restore_page_info ();
1758 make_cleanup_restore_integer (&batch_flag);
1765 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1768 set_screen_size (void)
1770 int rows = lines_per_page;
1771 int cols = chars_per_line;
1779 /* Update Readline's idea of the terminal size. */
1780 rl_set_screen_size (rows, cols);
1783 /* Reinitialize WRAP_BUFFER according to the current value of
1789 if (chars_per_line == 0)
1794 wrap_buffer = (char *) xmalloc (chars_per_line + 2);
1795 wrap_buffer[0] = '\0';
1798 wrap_buffer = (char *) xrealloc (wrap_buffer, chars_per_line + 2);
1799 wrap_pointer = wrap_buffer; /* Start it at the beginning. */
1803 set_width_command (char *args, int from_tty, struct cmd_list_element *c)
1810 set_height_command (char *args, int from_tty, struct cmd_list_element *c)
1815 /* Wait, so the user can read what's on the screen. Prompt the user
1816 to continue by pressing RETURN. */
1819 prompt_for_continue (void)
1822 char cont_prompt[120];
1823 /* Used to add duration we waited for user to respond to
1824 prompt_for_continue_wait_time. */
1825 struct timeval prompt_started, prompt_ended, prompt_delta;
1827 gettimeofday (&prompt_started, NULL);
1829 if (annotation_level > 1)
1830 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1832 strcpy (cont_prompt,
1833 "---Type <return> to continue, or q <return> to quit---");
1834 if (annotation_level > 1)
1835 strcat (cont_prompt, "\n\032\032prompt-for-continue\n");
1837 /* We must do this *before* we call gdb_readline, else it will eventually
1838 call us -- thinking that we're trying to print beyond the end of the
1840 reinitialize_more_filter ();
1845 /* We'll need to handle input. */
1846 target_terminal_ours ();
1848 /* On a real operating system, the user can quit with SIGINT.
1851 'q' is provided on all systems so users don't have to change habits
1852 from system to system, and because telling them what to do in
1853 the prompt is more user-friendly than expecting them to think of
1855 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1856 whereas control-C to gdb_readline will cause the user to get dumped
1858 ignore = gdb_readline_wrapper (cont_prompt);
1860 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1861 gettimeofday (&prompt_ended, NULL);
1862 timeval_sub (&prompt_delta, &prompt_ended, &prompt_started);
1863 timeval_add (&prompt_for_continue_wait_time,
1864 &prompt_for_continue_wait_time, &prompt_delta);
1866 if (annotation_level > 1)
1867 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1873 while (*p == ' ' || *p == '\t')
1881 /* Now we have to do this again, so that GDB will know that it doesn't
1882 need to save the ---Type <return>--- line at the top of the screen. */
1883 reinitialize_more_filter ();
1885 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1888 /* Initalize timer to keep track of how long we waited for the user. */
1891 reset_prompt_for_continue_wait_time (void)
1893 static const struct timeval zero_timeval = { 0 };
1895 prompt_for_continue_wait_time = zero_timeval;
1898 /* Fetch the cumulative time spent in prompt_for_continue. */
1901 get_prompt_for_continue_wait_time (void)
1903 return prompt_for_continue_wait_time;
1906 /* Reinitialize filter; ie. tell it to reset to original values. */
1909 reinitialize_more_filter (void)
1915 /* Indicate that if the next sequence of characters overflows the line,
1916 a newline should be inserted here rather than when it hits the end.
1917 If INDENT is non-null, it is a string to be printed to indent the
1918 wrapped part on the next line. INDENT must remain accessible until
1919 the next call to wrap_here() or until a newline is printed through
1922 If the line is already overfull, we immediately print a newline and
1923 the indentation, and disable further wrapping.
1925 If we don't know the width of lines, but we know the page height,
1926 we must not wrap words, but should still keep track of newlines
1927 that were explicitly printed.
1929 INDENT should not contain tabs, as that will mess up the char count
1930 on the next line. FIXME.
1932 This routine is guaranteed to force out any output which has been
1933 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1934 used to force out output from the wrap_buffer. */
1937 wrap_here (char *indent)
1939 /* This should have been allocated, but be paranoid anyway. */
1941 internal_error (__FILE__, __LINE__,
1942 _("failed internal consistency check"));
1946 *wrap_pointer = '\0';
1947 fputs_unfiltered (wrap_buffer, gdb_stdout);
1949 wrap_pointer = wrap_buffer;
1950 wrap_buffer[0] = '\0';
1951 if (chars_per_line == UINT_MAX) /* No line overflow checking. */
1955 else if (chars_printed >= chars_per_line)
1957 puts_filtered ("\n");
1959 puts_filtered (indent);
1964 wrap_column = chars_printed;
1968 wrap_indent = indent;
1972 /* Print input string to gdb_stdout, filtered, with wrap,
1973 arranging strings in columns of n chars. String can be
1974 right or left justified in the column. Never prints
1975 trailing spaces. String should never be longer than
1976 width. FIXME: this could be useful for the EXAMINE
1977 command, which currently doesn't tabulate very well. */
1980 puts_filtered_tabular (char *string, int width, int right)
1986 gdb_assert (chars_per_line > 0);
1987 if (chars_per_line == UINT_MAX)
1989 fputs_filtered (string, gdb_stdout);
1990 fputs_filtered ("\n", gdb_stdout);
1994 if (((chars_printed - 1) / width + 2) * width >= chars_per_line)
1995 fputs_filtered ("\n", gdb_stdout);
1997 if (width >= chars_per_line)
1998 width = chars_per_line - 1;
2000 stringlen = strlen (string);
2002 if (chars_printed > 0)
2003 spaces = width - (chars_printed - 1) % width - 1;
2005 spaces += width - stringlen;
2007 spacebuf = alloca (spaces + 1);
2008 spacebuf[spaces] = '\0';
2010 spacebuf[spaces] = ' ';
2012 fputs_filtered (spacebuf, gdb_stdout);
2013 fputs_filtered (string, gdb_stdout);
2017 /* Ensure that whatever gets printed next, using the filtered output
2018 commands, starts at the beginning of the line. I.e. if there is
2019 any pending output for the current line, flush it and start a new
2020 line. Otherwise do nothing. */
2025 if (chars_printed > 0)
2027 puts_filtered ("\n");
2032 /* Like fputs but if FILTER is true, pause after every screenful.
2034 Regardless of FILTER can wrap at points other than the final
2035 character of a line.
2037 Unlike fputs, fputs_maybe_filtered does not return a value.
2038 It is OK for LINEBUFFER to be NULL, in which case just don't print
2041 Note that a longjmp to top level may occur in this routine (only if
2042 FILTER is true) (since prompt_for_continue may do so) so this
2043 routine should not be called when cleanups are not in place. */
2046 fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
2049 const char *lineptr;
2051 if (linebuffer == 0)
2054 /* Don't do any filtering if it is disabled. */
2055 if (stream != gdb_stdout
2056 || !pagination_enabled
2058 || (lines_per_page == UINT_MAX && chars_per_line == UINT_MAX)
2059 || top_level_interpreter () == NULL
2060 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2062 fputs_unfiltered (linebuffer, stream);
2066 /* Go through and output each character. Show line extension
2067 when this is necessary; prompt user for new page when this is
2070 lineptr = linebuffer;
2073 /* Possible new page. */
2074 if (filter && (lines_printed >= lines_per_page - 1))
2075 prompt_for_continue ();
2077 while (*lineptr && *lineptr != '\n')
2079 /* Print a single line. */
2080 if (*lineptr == '\t')
2083 *wrap_pointer++ = '\t';
2085 fputc_unfiltered ('\t', stream);
2086 /* Shifting right by 3 produces the number of tab stops
2087 we have already passed, and then adding one and
2088 shifting left 3 advances to the next tab stop. */
2089 chars_printed = ((chars_printed >> 3) + 1) << 3;
2095 *wrap_pointer++ = *lineptr;
2097 fputc_unfiltered (*lineptr, stream);
2102 if (chars_printed >= chars_per_line)
2104 unsigned int save_chars = chars_printed;
2108 /* If we aren't actually wrapping, don't output newline --
2109 if chars_per_line is right, we probably just overflowed
2110 anyway; if it's wrong, let us keep going. */
2112 fputc_unfiltered ('\n', stream);
2114 /* Possible new page. */
2115 if (lines_printed >= lines_per_page - 1)
2116 prompt_for_continue ();
2118 /* Now output indentation and wrapped string. */
2121 fputs_unfiltered (wrap_indent, stream);
2122 *wrap_pointer = '\0'; /* Null-terminate saved stuff, */
2123 fputs_unfiltered (wrap_buffer, stream); /* and eject it. */
2124 /* FIXME, this strlen is what prevents wrap_indent from
2125 containing tabs. However, if we recurse to print it
2126 and count its chars, we risk trouble if wrap_indent is
2127 longer than (the user settable) chars_per_line.
2128 Note also that this can set chars_printed > chars_per_line
2129 if we are printing a long string. */
2130 chars_printed = strlen (wrap_indent)
2131 + (save_chars - wrap_column);
2132 wrap_pointer = wrap_buffer; /* Reset buffer */
2133 wrap_buffer[0] = '\0';
2134 wrap_column = 0; /* And disable fancy wrap */
2139 if (*lineptr == '\n')
2142 wrap_here ((char *) 0); /* Spit out chars, cancel
2145 fputc_unfiltered ('\n', stream);
2152 fputs_filtered (const char *linebuffer, struct ui_file *stream)
2154 fputs_maybe_filtered (linebuffer, stream, 1);
2158 putchar_unfiltered (int c)
2162 ui_file_write (gdb_stdout, &buf, 1);
2166 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2167 May return nonlocally. */
2170 putchar_filtered (int c)
2172 return fputc_filtered (c, gdb_stdout);
2176 fputc_unfiltered (int c, struct ui_file *stream)
2180 ui_file_write (stream, &buf, 1);
2185 fputc_filtered (int c, struct ui_file *stream)
2191 fputs_filtered (buf, stream);
2195 /* puts_debug is like fputs_unfiltered, except it prints special
2196 characters in printable fashion. */
2199 puts_debug (char *prefix, char *string, char *suffix)
2203 /* Print prefix and suffix after each line. */
2204 static int new_line = 1;
2205 static int return_p = 0;
2206 static char *prev_prefix = "";
2207 static char *prev_suffix = "";
2209 if (*string == '\n')
2212 /* If the prefix is changing, print the previous suffix, a new line,
2213 and the new prefix. */
2214 if ((return_p || (strcmp (prev_prefix, prefix) != 0)) && !new_line)
2216 fputs_unfiltered (prev_suffix, gdb_stdlog);
2217 fputs_unfiltered ("\n", gdb_stdlog);
2218 fputs_unfiltered (prefix, gdb_stdlog);
2221 /* Print prefix if we printed a newline during the previous call. */
2225 fputs_unfiltered (prefix, gdb_stdlog);
2228 prev_prefix = prefix;
2229 prev_suffix = suffix;
2231 /* Output characters in a printable format. */
2232 while ((ch = *string++) != '\0')
2238 fputc_unfiltered (ch, gdb_stdlog);
2241 fprintf_unfiltered (gdb_stdlog, "\\x%02x", ch & 0xff);
2245 fputs_unfiltered ("\\\\", gdb_stdlog);
2248 fputs_unfiltered ("\\b", gdb_stdlog);
2251 fputs_unfiltered ("\\f", gdb_stdlog);
2255 fputs_unfiltered ("\\n", gdb_stdlog);
2258 fputs_unfiltered ("\\r", gdb_stdlog);
2261 fputs_unfiltered ("\\t", gdb_stdlog);
2264 fputs_unfiltered ("\\v", gdb_stdlog);
2268 return_p = ch == '\r';
2271 /* Print suffix if we printed a newline. */
2274 fputs_unfiltered (suffix, gdb_stdlog);
2275 fputs_unfiltered ("\n", gdb_stdlog);
2280 /* Print a variable number of ARGS using format FORMAT. If this
2281 information is going to put the amount written (since the last call
2282 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2283 call prompt_for_continue to get the users permision to continue.
2285 Unlike fprintf, this function does not return a value.
2287 We implement three variants, vfprintf (takes a vararg list and stream),
2288 fprintf (takes a stream to write on), and printf (the usual).
2290 Note also that a longjmp to top level may occur in this routine
2291 (since prompt_for_continue may do so) so this routine should not be
2292 called when cleanups are not in place. */
2295 vfprintf_maybe_filtered (struct ui_file *stream, const char *format,
2296 va_list args, int filter)
2299 struct cleanup *old_cleanups;
2301 linebuffer = xstrvprintf (format, args);
2302 old_cleanups = make_cleanup (xfree, linebuffer);
2303 fputs_maybe_filtered (linebuffer, stream, filter);
2304 do_cleanups (old_cleanups);
2309 vfprintf_filtered (struct ui_file *stream, const char *format, va_list args)
2311 vfprintf_maybe_filtered (stream, format, args, 1);
2315 vfprintf_unfiltered (struct ui_file *stream, const char *format, va_list args)
2318 struct cleanup *old_cleanups;
2320 linebuffer = xstrvprintf (format, args);
2321 old_cleanups = make_cleanup (xfree, linebuffer);
2322 if (debug_timestamp && stream == gdb_stdlog)
2328 gettimeofday (&tm, NULL);
2330 len = strlen (linebuffer);
2331 need_nl = (len > 0 && linebuffer[len - 1] != '\n');
2333 timestamp = xstrprintf ("%ld:%ld %s%s",
2334 (long) tm.tv_sec, (long) tm.tv_usec,
2336 need_nl ? "\n": "");
2337 make_cleanup (xfree, timestamp);
2338 fputs_unfiltered (timestamp, stream);
2341 fputs_unfiltered (linebuffer, stream);
2342 do_cleanups (old_cleanups);
2346 vprintf_filtered (const char *format, va_list args)
2348 vfprintf_maybe_filtered (gdb_stdout, format, args, 1);
2352 vprintf_unfiltered (const char *format, va_list args)
2354 vfprintf_unfiltered (gdb_stdout, format, args);
2358 fprintf_filtered (struct ui_file *stream, const char *format, ...)
2362 va_start (args, format);
2363 vfprintf_filtered (stream, format, args);
2368 fprintf_unfiltered (struct ui_file *stream, const char *format, ...)
2372 va_start (args, format);
2373 vfprintf_unfiltered (stream, format, args);
2377 /* Like fprintf_filtered, but prints its result indented.
2378 Called as fprintfi_filtered (spaces, stream, format, ...); */
2381 fprintfi_filtered (int spaces, struct ui_file *stream, const char *format,
2386 va_start (args, format);
2387 print_spaces_filtered (spaces, stream);
2389 vfprintf_filtered (stream, format, args);
2395 printf_filtered (const char *format, ...)
2399 va_start (args, format);
2400 vfprintf_filtered (gdb_stdout, format, args);
2406 printf_unfiltered (const char *format, ...)
2410 va_start (args, format);
2411 vfprintf_unfiltered (gdb_stdout, format, args);
2415 /* Like printf_filtered, but prints it's result indented.
2416 Called as printfi_filtered (spaces, format, ...); */
2419 printfi_filtered (int spaces, const char *format, ...)
2423 va_start (args, format);
2424 print_spaces_filtered (spaces, gdb_stdout);
2425 vfprintf_filtered (gdb_stdout, format, args);
2429 /* Easy -- but watch out!
2431 This routine is *not* a replacement for puts()! puts() appends a newline.
2432 This one doesn't, and had better not! */
2435 puts_filtered (const char *string)
2437 fputs_filtered (string, gdb_stdout);
2441 puts_unfiltered (const char *string)
2443 fputs_unfiltered (string, gdb_stdout);
2446 /* Return a pointer to N spaces and a null. The pointer is good
2447 until the next call to here. */
2452 static char *spaces = 0;
2453 static int max_spaces = -1;
2459 spaces = (char *) xmalloc (n + 1);
2460 for (t = spaces + n; t != spaces;)
2466 return spaces + max_spaces - n;
2469 /* Print N spaces. */
2471 print_spaces_filtered (int n, struct ui_file *stream)
2473 fputs_filtered (n_spaces (n), stream);
2476 /* C++/ObjC demangler stuff. */
2478 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2479 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2480 If the name is not mangled, or the language for the name is unknown, or
2481 demangling is off, the name is printed in its "raw" form. */
2484 fprintf_symbol_filtered (struct ui_file *stream, const char *name,
2485 enum language lang, int arg_mode)
2491 /* If user wants to see raw output, no problem. */
2494 fputs_filtered (name, stream);
2498 demangled = language_demangle (language_def (lang), name, arg_mode);
2499 fputs_filtered (demangled ? demangled : name, stream);
2500 if (demangled != NULL)
2508 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2509 differences in whitespace. Returns 0 if they match, non-zero if they
2510 don't (slightly different than strcmp()'s range of return values).
2512 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2513 This "feature" is useful when searching for matching C++ function names
2514 (such as if the user types 'break FOO', where FOO is a mangled C++
2518 strcmp_iw (const char *string1, const char *string2)
2520 while ((*string1 != '\0') && (*string2 != '\0'))
2522 while (isspace (*string1))
2526 while (isspace (*string2))
2530 if (case_sensitivity == case_sensitive_on && *string1 != *string2)
2532 if (case_sensitivity == case_sensitive_off
2533 && (tolower ((unsigned char) *string1)
2534 != tolower ((unsigned char) *string2)))
2536 if (*string1 != '\0')
2542 return (*string1 != '\0' && *string1 != '(') || (*string2 != '\0');
2545 /* This is like strcmp except that it ignores whitespace and treats
2546 '(' as the first non-NULL character in terms of ordering. Like
2547 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2548 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2549 according to that ordering.
2551 If a list is sorted according to this function and if you want to
2552 find names in the list that match some fixed NAME according to
2553 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2554 where this function would put NAME.
2556 This function must be neutral to the CASE_SENSITIVITY setting as the user
2557 may choose it during later lookup. Therefore this function always sorts
2558 primarily case-insensitively and secondarily case-sensitively.
2560 Here are some examples of why using strcmp to sort is a bad idea:
2564 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2565 we try to do a search for "foo<char*>", strcmp will locate this
2566 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2567 will start looking at strings beginning with "goo", and will never
2568 see the correct match of "foo<char *>".
2570 Parenthesis example:
2572 In practice, this is less like to be an issue, but I'll give it a
2573 shot. Let's assume that '$' is a legitimate character to occur in
2574 symbols. (Which may well even be the case on some systems.) Then
2575 say that the partial symbol table contains "foo$" and "foo(int)".
2576 strcmp will put them in this order, since '$' < '('. Now, if the
2577 user searches for "foo", then strcmp will sort "foo" before "foo$".
2578 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2579 "foo") is false, so it won't proceed to the actual match of
2580 "foo(int)" with "foo". */
2583 strcmp_iw_ordered (const char *string1, const char *string2)
2585 const char *saved_string1 = string1, *saved_string2 = string2;
2586 enum case_sensitivity case_pass = case_sensitive_off;
2590 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2591 Provide stub characters if we are already at the end of one of the
2593 char c1 = 'X', c2 = 'X';
2595 while (*string1 != '\0' && *string2 != '\0')
2597 while (isspace (*string1))
2599 while (isspace (*string2))
2604 case case_sensitive_off:
2605 c1 = tolower ((unsigned char) *string1);
2606 c2 = tolower ((unsigned char) *string2);
2608 case case_sensitive_on:
2616 if (*string1 != '\0')
2625 /* Characters are non-equal unless they're both '\0'; we want to
2626 make sure we get the comparison right according to our
2627 comparison in the cases where one of them is '\0' or '('. */
2629 if (*string2 == '\0')
2634 if (*string2 == '\0')
2639 if (*string2 == '\0' || *string2 == '(')
2648 if (case_pass == case_sensitive_on)
2651 /* Otherwise the strings were equal in case insensitive way, make
2652 a more fine grained comparison in a case sensitive way. */
2654 case_pass = case_sensitive_on;
2655 string1 = saved_string1;
2656 string2 = saved_string2;
2660 /* A simple comparison function with opposite semantics to strcmp. */
2663 streq (const char *lhs, const char *rhs)
2665 return !strcmp (lhs, rhs);
2671 ** Answer whether string_to_compare is a full or partial match to
2672 ** template_string. The partial match must be in sequence starting
2676 subset_compare (char *string_to_compare, char *template_string)
2680 if (template_string != (char *) NULL && string_to_compare != (char *) NULL
2681 && strlen (string_to_compare) <= strlen (template_string))
2684 (template_string, string_to_compare, strlen (string_to_compare)) == 0);
2691 pagination_on_command (char *arg, int from_tty)
2693 pagination_enabled = 1;
2697 pagination_off_command (char *arg, int from_tty)
2699 pagination_enabled = 0;
2703 show_debug_timestamp (struct ui_file *file, int from_tty,
2704 struct cmd_list_element *c, const char *value)
2706 fprintf_filtered (file, _("Timestamping debugging messages is %s.\n"),
2712 initialize_utils (void)
2714 add_setshow_uinteger_cmd ("width", class_support, &chars_per_line, _("\
2715 Set number of characters where GDB should wrap lines of its output."), _("\
2716 Show number of characters where GDB should wrap lines of its output."), _("\
2717 This affects where GDB wraps its output to fit the screen width.\n\
2718 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2720 show_chars_per_line,
2721 &setlist, &showlist);
2723 add_setshow_uinteger_cmd ("height", class_support, &lines_per_page, _("\
2724 Set number of lines in a page for GDB output pagination."), _("\
2725 Show number of lines in a page for GDB output pagination."), _("\
2726 This affects the number of lines after which GDB will pause\n\
2727 its output and ask you whether to continue.\n\
2728 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2730 show_lines_per_page,
2731 &setlist, &showlist);
2735 add_setshow_boolean_cmd ("pagination", class_support,
2736 &pagination_enabled, _("\
2737 Set state of GDB output pagination."), _("\
2738 Show state of GDB output pagination."), _("\
2739 When pagination is ON, GDB pauses at end of each screenful of\n\
2740 its output and asks you whether to continue.\n\
2741 Turning pagination off is an alternative to \"set height unlimited\"."),
2743 show_pagination_enabled,
2744 &setlist, &showlist);
2748 add_com ("am", class_support, pagination_on_command,
2749 _("Enable pagination"));
2750 add_com ("sm", class_support, pagination_off_command,
2751 _("Disable pagination"));
2754 add_setshow_boolean_cmd ("sevenbit-strings", class_support,
2755 &sevenbit_strings, _("\
2756 Set printing of 8-bit characters in strings as \\nnn."), _("\
2757 Show printing of 8-bit characters in strings as \\nnn."), NULL,
2759 show_sevenbit_strings,
2760 &setprintlist, &showprintlist);
2762 add_setshow_boolean_cmd ("timestamp", class_maintenance,
2763 &debug_timestamp, _("\
2764 Set timestamping of debugging messages."), _("\
2765 Show timestamping of debugging messages."), _("\
2766 When set, debugging messages will be marked with seconds and microseconds."),
2768 show_debug_timestamp,
2769 &setdebuglist, &showdebuglist);
2773 paddress (struct gdbarch *gdbarch, CORE_ADDR addr)
2775 /* Truncate address to the size of a target address, avoiding shifts
2776 larger or equal than the width of a CORE_ADDR. The local
2777 variable ADDR_BIT stops the compiler reporting a shift overflow
2778 when it won't occur. */
2779 /* NOTE: This assumes that the significant address information is
2780 kept in the least significant bits of ADDR - the upper bits were
2781 either zero or sign extended. Should gdbarch_address_to_pointer or
2782 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2784 int addr_bit = gdbarch_addr_bit (gdbarch);
2786 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2787 addr &= ((CORE_ADDR) 1 << addr_bit) - 1;
2788 return hex_string (addr);
2791 /* This function is described in "defs.h". */
2794 print_core_address (struct gdbarch *gdbarch, CORE_ADDR address)
2796 int addr_bit = gdbarch_addr_bit (gdbarch);
2798 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2799 address &= ((CORE_ADDR) 1 << addr_bit) - 1;
2801 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2802 that returns the language localized string formatted to a width
2803 based on gdbarch_addr_bit. */
2805 return hex_string_custom (address, 8);
2807 return hex_string_custom (address, 16);
2810 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2813 core_addr_hash (const void *ap)
2815 const CORE_ADDR *addrp = ap;
2820 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2823 core_addr_eq (const void *ap, const void *bp)
2825 const CORE_ADDR *addr_ap = ap;
2826 const CORE_ADDR *addr_bp = bp;
2828 return *addr_ap == *addr_bp;
2831 /* Convert a string back into a CORE_ADDR. */
2833 string_to_core_addr (const char *my_string)
2837 if (my_string[0] == '0' && tolower (my_string[1]) == 'x')
2839 /* Assume that it is in hex. */
2842 for (i = 2; my_string[i] != '\0'; i++)
2844 if (isdigit (my_string[i]))
2845 addr = (my_string[i] - '0') + (addr * 16);
2846 else if (isxdigit (my_string[i]))
2847 addr = (tolower (my_string[i]) - 'a' + 0xa) + (addr * 16);
2849 error (_("invalid hex \"%s\""), my_string);
2854 /* Assume that it is in decimal. */
2857 for (i = 0; my_string[i] != '\0'; i++)
2859 if (isdigit (my_string[i]))
2860 addr = (my_string[i] - '0') + (addr * 10);
2862 error (_("invalid decimal \"%s\""), my_string);
2870 gdb_realpath (const char *filename)
2872 /* Method 1: The system has a compile time upper bound on a filename
2873 path. Use that and realpath() to canonicalize the name. This is
2874 the most common case. Note that, if there isn't a compile time
2875 upper bound, you want to avoid realpath() at all costs. */
2876 #if defined (HAVE_REALPATH) && defined (PATH_MAX)
2879 const char *rp = realpath (filename, buf);
2883 return xstrdup (rp);
2885 #endif /* HAVE_REALPATH */
2887 /* Method 2: The host system (i.e., GNU) has the function
2888 canonicalize_file_name() which malloc's a chunk of memory and
2889 returns that, use that. */
2890 #if defined(HAVE_CANONICALIZE_FILE_NAME)
2892 char *rp = canonicalize_file_name (filename);
2895 return xstrdup (filename);
2901 /* FIXME: cagney/2002-11-13:
2903 Method 2a: Use realpath() with a NULL buffer. Some systems, due
2904 to the problems described in method 3, have modified their
2905 realpath() implementation so that it will allocate a buffer when
2906 NULL is passed in. Before this can be used, though, some sort of
2907 configure time test would need to be added. Otherwize the code
2908 will likely core dump. */
2910 /* Method 3: Now we're getting desperate! The system doesn't have a
2911 compile time buffer size and no alternative function. Query the
2912 OS, using pathconf(), for the buffer limit. Care is needed
2913 though, some systems do not limit PATH_MAX (return -1 for
2914 pathconf()) making it impossible to pass a correctly sized buffer
2915 to realpath() (it could always overflow). On those systems, we
2917 #if defined (HAVE_REALPATH) && defined (_PC_PATH_MAX) && defined(HAVE_ALLOCA)
2919 /* Find out the max path size. */
2920 long path_max = pathconf ("/", _PC_PATH_MAX);
2924 /* PATH_MAX is bounded. */
2925 char *buf = alloca (path_max);
2926 char *rp = realpath (filename, buf);
2928 return xstrdup (rp ? rp : filename);
2933 /* The MS Windows method. If we don't have realpath, we assume we
2934 don't have symlinks and just canonicalize to a Windows absolute
2935 path. GetFullPath converts ../ and ./ in relative paths to
2936 absolute paths, filling in current drive if one is not given
2937 or using the current directory of a specified drive (eg, "E:foo").
2938 It also converts all forward slashes to back slashes. */
2939 /* The file system is case-insensitive but case-preserving.
2940 So we do not lowercase the path. Otherwise, we might not
2941 be able to display the original casing in a given path. */
2942 #if defined (_WIN32)
2945 DWORD len = GetFullPathName (filename, MAX_PATH, buf, NULL);
2947 if (len > 0 && len < MAX_PATH)
2948 return xstrdup (buf);
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 = 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);
3047 gdb_sign_extend (LONGEST value, int bit)
3049 gdb_assert (bit >= 1 && bit <= 8 * sizeof (LONGEST));
3051 if (((value >> (bit - 1)) & 1) != 0)
3053 LONGEST signbit = ((LONGEST) 1) << (bit - 1);
3055 value = (value ^ signbit) - signbit;
3061 /* Allocation function for the libiberty hash table which uses an
3062 obstack. The obstack is passed as DATA. */
3065 hashtab_obstack_allocate (void *data, size_t size, size_t count)
3067 size_t total = size * count;
3068 void *ptr = obstack_alloc ((struct obstack *) data, total);
3070 memset (ptr, 0, total);
3074 /* Trivial deallocation function for the libiberty splay tree and hash
3075 table - don't deallocate anything. Rely on later deletion of the
3076 obstack. DATA will be the obstack, although it is not needed
3080 dummy_obstack_deallocate (void *object, void *data)
3085 /* The bit offset of the highest byte in a ULONGEST, for overflow
3088 #define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT)
3090 /* True (non-zero) iff DIGIT is a valid digit in radix BASE,
3091 where 2 <= BASE <= 36. */
3094 is_digit_in_base (unsigned char digit, int base)
3096 if (!isalnum (digit))
3099 return (isdigit (digit) && digit < base + '0');
3101 return (isdigit (digit) || tolower (digit) < base - 10 + 'a');
3105 digit_to_int (unsigned char c)
3110 return tolower (c) - 'a' + 10;
3113 /* As for strtoul, but for ULONGEST results. */
3116 strtoulst (const char *num, const char **trailer, int base)
3118 unsigned int high_part;
3123 /* Skip leading whitespace. */
3124 while (isspace (num[i]))
3127 /* Handle prefixes. */
3130 else if (num[i] == '-')
3136 if (base == 0 || base == 16)
3138 if (num[i] == '0' && (num[i + 1] == 'x' || num[i + 1] == 'X'))
3146 if (base == 0 && num[i] == '0')
3152 if (base < 2 || base > 36)
3158 result = high_part = 0;
3159 for (; is_digit_in_base (num[i], base); i += 1)
3161 result = result * base + digit_to_int (num[i]);
3162 high_part = high_part * base + (unsigned int) (result >> HIGH_BYTE_POSN);
3163 result &= ((ULONGEST) 1 << HIGH_BYTE_POSN) - 1;
3164 if (high_part > 0xff)
3167 result = ~ (ULONGEST) 0;
3174 if (trailer != NULL)
3177 result = result + ((ULONGEST) high_part << HIGH_BYTE_POSN);
3184 /* Simple, portable version of dirname that does not modify its
3188 ldirname (const char *filename)
3190 const char *base = lbasename (filename);
3193 while (base > filename && IS_DIR_SEPARATOR (base[-1]))
3196 if (base == filename)
3199 dirname = xmalloc (base - filename + 2);
3200 memcpy (dirname, filename, base - filename);
3202 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3203 create "d:./bar" later instead of the (different) "d:/bar". */
3204 if (base - filename == 2 && IS_ABSOLUTE_PATH (base)
3205 && !IS_DIR_SEPARATOR (filename[0]))
3206 dirname[base++ - filename] = '.';
3208 dirname[base - filename] = '\0';
3212 /* Call libiberty's buildargv, and return the result.
3213 If buildargv fails due to out-of-memory, call nomem.
3214 Therefore, the returned value is guaranteed to be non-NULL,
3215 unless the parameter itself is NULL. */
3218 gdb_buildargv (const char *s)
3220 char **argv = buildargv (s);
3222 if (s != NULL && argv == NULL)
3228 compare_positive_ints (const void *ap, const void *bp)
3230 /* Because we know we're comparing two ints which are positive,
3231 there's no danger of overflow here. */
3232 return * (int *) ap - * (int *) bp;
3235 /* String compare function for qsort. */
3238 compare_strings (const void *arg1, const void *arg2)
3240 const char **s1 = (const char **) arg1;
3241 const char **s2 = (const char **) arg2;
3243 return strcmp (*s1, *s2);
3246 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3247 #define AMBIGUOUS_MESS2 \
3248 ".\nUse \"set gnutarget format-name\" to specify the format."
3251 gdb_bfd_errmsg (bfd_error_type error_tag, char **matching)
3257 /* Check if errmsg just need simple return. */
3258 if (error_tag != bfd_error_file_ambiguously_recognized || matching == NULL)
3259 return bfd_errmsg (error_tag);
3261 ret_len = strlen (bfd_errmsg (error_tag)) + strlen (AMBIGUOUS_MESS1)
3262 + strlen (AMBIGUOUS_MESS2);
3263 for (p = matching; *p; p++)
3264 ret_len += strlen (*p) + 1;
3265 ret = xmalloc (ret_len + 1);
3267 make_cleanup (xfree, ret);
3269 strcpy (retp, bfd_errmsg (error_tag));
3270 retp += strlen (retp);
3272 strcpy (retp, AMBIGUOUS_MESS1);
3273 retp += strlen (retp);
3275 for (p = matching; *p; p++)
3277 sprintf (retp, " %s", *p);
3278 retp += strlen (retp);
3282 strcpy (retp, AMBIGUOUS_MESS2);
3287 /* Return ARGS parsed as a valid pid, or throw an error. */
3290 parse_pid_to_attach (const char *args)
3296 error_no_arg (_("process-id to attach"));
3298 dummy = (char *) args;
3299 pid = strtoul (args, &dummy, 0);
3300 /* Some targets don't set errno on errors, grrr! */
3301 if ((pid == 0 && dummy == args) || dummy != &args[strlen (args)])
3302 error (_("Illegal process-id: %s."), args);
3307 /* Helper for make_bpstat_clear_actions_cleanup. */
3310 do_bpstat_clear_actions_cleanup (void *unused)
3312 bpstat_clear_actions ();
3315 /* Call bpstat_clear_actions for the case an exception is throw. You should
3316 discard_cleanups if no exception is caught. */
3319 make_bpstat_clear_actions_cleanup (void)
3321 return make_cleanup (do_bpstat_clear_actions_cleanup, NULL);
3324 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3325 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3326 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3329 producer_is_gcc_ge_4 (const char *producer)
3334 if (producer == NULL)
3336 /* For unknown compilers expect their behavior is not compliant. For GCC
3337 this case can also happen for -gdwarf-4 type units supported since
3343 /* Skip any identifier after "GNU " - such as "C++" or "Java". */
3345 if (strncmp (producer, "GNU ", strlen ("GNU ")) != 0)
3347 /* For non-GCC compilers expect their behavior is not compliant. */
3351 cs = &producer[strlen ("GNU ")];
3352 while (*cs && !isdigit (*cs))
3354 if (sscanf (cs, "%d.%d", &major, &minor) != 2)
3356 /* Not recognized as GCC. */
3368 /* Helper for make_cleanup_free_char_ptr_vec. */
3371 do_free_char_ptr_vec (void *arg)
3373 VEC (char_ptr) *char_ptr_vec = arg;
3375 free_char_ptr_vec (char_ptr_vec);
3378 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3379 final VEC_free for CHAR_PTR_VEC itself.
3381 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3382 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3383 this function does not (cannot) clear the pointer. */
3386 make_cleanup_free_char_ptr_vec (VEC (char_ptr) *char_ptr_vec)
3388 return make_cleanup (do_free_char_ptr_vec, char_ptr_vec);
3391 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3392 must come from xrealloc-compatible allocator and it may be updated. FROM
3393 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3394 located at the start or end of *STRINGP. */
3397 substitute_path_component (char **stringp, const char *from, const char *to)
3399 char *string = *stringp, *s;
3400 const size_t from_len = strlen (from);
3401 const size_t to_len = strlen (to);
3405 s = strstr (s, from);
3409 if ((s == string || IS_DIR_SEPARATOR (s[-1])
3410 || s[-1] == DIRNAME_SEPARATOR)
3411 && (s[from_len] == '\0' || IS_DIR_SEPARATOR (s[from_len])
3412 || s[from_len] == DIRNAME_SEPARATOR))
3416 string_new = xrealloc (string, (strlen (string) + to_len + 1));
3418 /* Relocate the current S pointer. */
3419 s = s - string + string_new;
3420 string = string_new;
3422 /* Replace from by to. */
3423 memmove (&s[to_len], &s[from_len], strlen (&s[from_len]) + 1);
3424 memcpy (s, to, to_len);
3439 /* SIGALRM handler for waitpid_with_timeout. */
3442 sigalrm_handler (int signo)
3444 /* Nothing to do. */
3449 /* Wrapper to wait for child PID to die with TIMEOUT.
3450 TIMEOUT is the time to stop waiting in seconds.
3451 If TIMEOUT is zero, pass WNOHANG to waitpid.
3452 Returns PID if it was successfully waited for, otherwise -1.
3454 Timeouts are currently implemented with alarm and SIGALRM.
3455 If the host does not support them, this waits "forever".
3456 It would be odd though for a host to have waitpid and not SIGALRM. */
3459 wait_to_die_with_timeout (pid_t pid, int *status, int timeout)
3461 pid_t waitpid_result;
3463 gdb_assert (pid > 0);
3464 gdb_assert (timeout >= 0);
3469 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3470 struct sigaction sa, old_sa;
3472 sa.sa_handler = sigalrm_handler;
3473 sigemptyset (&sa.sa_mask);
3475 sigaction (SIGALRM, &sa, &old_sa);
3479 ofunc = (void (*)()) signal (SIGALRM, sigalrm_handler);
3485 waitpid_result = waitpid (pid, status, 0);
3489 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3490 sigaction (SIGALRM, &old_sa, NULL);
3492 signal (SIGALRM, ofunc);
3497 waitpid_result = waitpid (pid, status, WNOHANG);
3499 if (waitpid_result == pid)
3505 #endif /* HAVE_WAITPID */
3507 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3508 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3510 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3511 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3514 gdb_filename_fnmatch (const char *pattern, const char *string, int flags)
3516 gdb_assert ((flags & FNM_FILE_NAME) != 0);
3518 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3519 gdb_assert ((flags & FNM_NOESCAPE) != 0);
3521 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3523 char *pattern_slash, *string_slash;
3525 /* Replace '\' by '/' in both strings. */
3527 pattern_slash = alloca (strlen (pattern) + 1);
3528 strcpy (pattern_slash, pattern);
3529 pattern = pattern_slash;
3530 for (; *pattern_slash != 0; pattern_slash++)
3531 if (IS_DIR_SEPARATOR (*pattern_slash))
3532 *pattern_slash = '/';
3534 string_slash = alloca (strlen (string) + 1);
3535 strcpy (string_slash, string);
3536 string = string_slash;
3537 for (; *string_slash != 0; string_slash++)
3538 if (IS_DIR_SEPARATOR (*string_slash))
3539 *string_slash = '/';
3541 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3543 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3544 flags |= FNM_CASEFOLD;
3545 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3547 return fnmatch (pattern, string, flags);
3550 /* Provide a prototype to silence -Wmissing-prototypes. */
3551 extern initialize_file_ftype _initialize_utils;
3554 _initialize_utils (void)
3556 add_internal_problem_command (&internal_error_problem);
3557 add_internal_problem_command (&internal_warning_problem);
3558 add_internal_problem_command (&demangler_warning_problem);