1 /* General utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2013 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"
22 #include "gdb_assert.h"
24 #include "gdb_string.h"
26 #include "event-top.h"
27 #include "exceptions.h"
28 #include "gdbthread.h"
31 #ifdef HAVE_SYS_RESOURCE_H
32 #include <sys/resource.h>
33 #endif /* HAVE_SYS_RESOURCE_H */
36 #include "tui/tui.h" /* For tui_get_command_dimension. */
43 /* SunOS's curses.h has a '#define reg register' in it. Thank you Sun. */
49 #include "timeval-utils.h"
54 #include "gdb-demangle.h"
55 #include "expression.h"
59 #include "filenames.h"
61 #include "gdb_obstack.h"
67 #include "inferior.h" /* for signed_pointer_to_address */
69 #include <sys/param.h> /* For MAXPATHLEN */
71 #include "gdb_curses.h"
73 #include "readline/readline.h"
78 #include "gdb_usleep.h"
80 #include "gdb_regex.h"
83 extern PTR malloc (); /* ARI: PTR */
85 #if !HAVE_DECL_REALLOC
86 extern PTR realloc (); /* ARI: PTR */
92 void (*deprecated_error_begin_hook) (void);
94 /* Prototypes for local functions */
96 static void vfprintf_maybe_filtered (struct ui_file *, const char *,
97 va_list, int) ATTRIBUTE_PRINTF (2, 0);
99 static void fputs_maybe_filtered (const char *, struct ui_file *, int);
101 static void prompt_for_continue (void);
103 static void set_screen_size (void);
104 static void set_width (void);
106 /* Time spent in prompt_for_continue in the currently executing command
107 waiting for user to respond.
108 Initialized in make_command_stats_cleanup.
109 Modified in prompt_for_continue and defaulted_query.
110 Used in report_command_stats. */
112 static struct timeval prompt_for_continue_wait_time;
114 /* A flag indicating whether to timestamp debugging messages. */
116 static int debug_timestamp = 0;
118 /* Nonzero if we have job control. */
123 /* Nonzero means a quit has been requested. */
126 #endif /* HAVE_PYTHON */
128 /* Nonzero means quit immediately if Control-C is typed now, rather
129 than waiting until QUIT is executed. Be careful in setting this;
130 code which executes with immediate_quit set has to be very careful
131 about being able to deal with being interrupted at any time. It is
132 almost always better to use QUIT; the only exception I can think of
133 is being able to quit out of a system call (using EINTR loses if
134 the SIGINT happens between the previous QUIT and the system call).
135 To immediately quit in the case in which a SIGINT happens between
136 the previous QUIT and setting immediate_quit (desirable anytime we
137 expect to block), call QUIT after setting immediate_quit. */
143 /* Clear the quit flag. */
146 clear_quit_flag (void)
151 /* Set the quit flag. */
159 /* Return true if the quit flag has been set, false otherwise. */
162 check_quit_flag (void)
164 /* This is written in a particular way to avoid races. */
174 #endif /* HAVE_PYTHON */
176 /* Nonzero means that strings with character values >0x7F should be printed
177 as octal escapes. Zero means just print the value (e.g. it's an
178 international character, and the terminal or window can cope.) */
180 int sevenbit_strings = 0;
182 show_sevenbit_strings (struct ui_file *file, int from_tty,
183 struct cmd_list_element *c, const char *value)
185 fprintf_filtered (file, _("Printing of 8-bit characters "
186 "in strings as \\nnn is %s.\n"),
190 /* String to be printed before error messages, if any. */
192 char *error_pre_print;
194 /* String to be printed before quit messages, if any. */
196 char *quit_pre_print;
198 /* String to be printed before warning messages, if any. */
200 char *warning_pre_print = "\nwarning: ";
202 int pagination_enabled = 1;
204 show_pagination_enabled (struct ui_file *file, int from_tty,
205 struct cmd_list_element *c, const char *value)
207 fprintf_filtered (file, _("State of pagination is %s.\n"), value);
211 /* Cleanup utilities.
213 These are not defined in cleanups.c (nor declared in cleanups.h)
214 because while they use the "cleanup API" they are not part of the
218 do_freeargv (void *arg)
220 freeargv ((char **) arg);
224 make_cleanup_freeargv (char **arg)
226 return make_cleanup (do_freeargv, arg);
230 do_dyn_string_delete (void *arg)
232 dyn_string_delete ((dyn_string_t) arg);
236 make_cleanup_dyn_string_delete (dyn_string_t arg)
238 return make_cleanup (do_dyn_string_delete, arg);
242 do_bfd_close_cleanup (void *arg)
248 make_cleanup_bfd_unref (bfd *abfd)
250 return make_cleanup (do_bfd_close_cleanup, abfd);
254 do_close_cleanup (void *arg)
262 make_cleanup_close (int fd)
264 int *saved_fd = xmalloc (sizeof (fd));
267 return make_cleanup_dtor (do_close_cleanup, saved_fd, xfree);
270 /* Helper function which does the work for make_cleanup_fclose. */
273 do_fclose_cleanup (void *arg)
280 /* Return a new cleanup that closes FILE. */
283 make_cleanup_fclose (FILE *file)
285 return make_cleanup (do_fclose_cleanup, file);
288 /* Helper function which does the work for make_cleanup_obstack_free. */
291 do_obstack_free (void *arg)
293 struct obstack *ob = arg;
295 obstack_free (ob, NULL);
298 /* Return a new cleanup that frees OBSTACK. */
301 make_cleanup_obstack_free (struct obstack *obstack)
303 return make_cleanup (do_obstack_free, obstack);
307 do_ui_file_delete (void *arg)
309 ui_file_delete (arg);
313 make_cleanup_ui_file_delete (struct ui_file *arg)
315 return make_cleanup (do_ui_file_delete, arg);
318 /* Helper function for make_cleanup_ui_out_redirect_pop. */
321 do_ui_out_redirect_pop (void *arg)
323 struct ui_out *uiout = arg;
325 if (ui_out_redirect (uiout, NULL) < 0)
326 warning (_("Cannot restore redirection of the current output protocol"));
329 /* Return a new cleanup that pops the last redirection by ui_out_redirect
330 with NULL parameter. */
333 make_cleanup_ui_out_redirect_pop (struct ui_out *uiout)
335 return make_cleanup (do_ui_out_redirect_pop, uiout);
339 do_free_section_addr_info (void *arg)
341 free_section_addr_info (arg);
345 make_cleanup_free_section_addr_info (struct section_addr_info *addrs)
347 return make_cleanup (do_free_section_addr_info, addrs);
350 struct restore_integer_closure
357 restore_integer (void *p)
359 struct restore_integer_closure *closure = p;
361 *(closure->variable) = closure->value;
364 /* Remember the current value of *VARIABLE and make it restored when
365 the cleanup is run. */
368 make_cleanup_restore_integer (int *variable)
370 struct restore_integer_closure *c =
371 xmalloc (sizeof (struct restore_integer_closure));
373 c->variable = variable;
374 c->value = *variable;
376 return make_cleanup_dtor (restore_integer, (void *) c, xfree);
379 /* Remember the current value of *VARIABLE and make it restored when
380 the cleanup is run. */
383 make_cleanup_restore_uinteger (unsigned int *variable)
385 return make_cleanup_restore_integer ((int *) variable);
388 /* Helper for make_cleanup_unpush_target. */
391 do_unpush_target (void *arg)
393 struct target_ops *ops = arg;
398 /* Return a new cleanup that unpushes OPS. */
401 make_cleanup_unpush_target (struct target_ops *ops)
403 return make_cleanup (do_unpush_target, ops);
406 /* Helper for make_cleanup_htab_delete compile time checking the types. */
409 do_htab_delete_cleanup (void *htab_voidp)
411 htab_t htab = htab_voidp;
416 /* Return a new cleanup that deletes HTAB. */
419 make_cleanup_htab_delete (htab_t htab)
421 return make_cleanup (do_htab_delete_cleanup, htab);
424 struct restore_ui_file_closure
426 struct ui_file **variable;
427 struct ui_file *value;
431 do_restore_ui_file (void *p)
433 struct restore_ui_file_closure *closure = p;
435 *(closure->variable) = closure->value;
438 /* Remember the current value of *VARIABLE and make it restored when
439 the cleanup is run. */
442 make_cleanup_restore_ui_file (struct ui_file **variable)
444 struct restore_ui_file_closure *c = XNEW (struct restore_ui_file_closure);
446 c->variable = variable;
447 c->value = *variable;
449 return make_cleanup_dtor (do_restore_ui_file, (void *) c, xfree);
452 /* Helper for make_cleanup_value_free_to_mark. */
455 do_value_free_to_mark (void *value)
457 value_free_to_mark ((struct value *) value);
460 /* Free all values allocated since MARK was obtained by value_mark
461 (except for those released) when the cleanup is run. */
464 make_cleanup_value_free_to_mark (struct value *mark)
466 return make_cleanup (do_value_free_to_mark, mark);
469 /* Helper for make_cleanup_value_free. */
472 do_value_free (void *value)
480 make_cleanup_value_free (struct value *value)
482 return make_cleanup (do_value_free, value);
485 /* Helper for make_cleanup_free_so. */
488 do_free_so (void *arg)
490 struct so_list *so = arg;
495 /* Make cleanup handler calling free_so for SO. */
498 make_cleanup_free_so (struct so_list *so)
500 return make_cleanup (do_free_so, so);
503 /* Helper for make_cleanup_restore_current_language. */
506 do_restore_current_language (void *p)
508 enum language saved_lang = (uintptr_t) p;
510 set_language (saved_lang);
513 /* Remember the current value of CURRENT_LANGUAGE and make it restored when
514 the cleanup is run. */
517 make_cleanup_restore_current_language (void)
519 enum language saved_lang = current_language->la_language;
521 return make_cleanup (do_restore_current_language,
522 (void *) (uintptr_t) saved_lang);
525 /* This function is useful for cleanups.
529 old_chain = make_cleanup (free_current_contents, &foo);
531 to arrange to free the object thus allocated. */
534 free_current_contents (void *ptr)
536 void **location = ptr;
538 if (location == NULL)
539 internal_error (__FILE__, __LINE__,
540 _("free_current_contents: NULL pointer"));
541 if (*location != NULL)
550 /* Print a warning message. The first argument STRING is the warning
551 message, used as an fprintf format string, the second is the
552 va_list of arguments for that string. A warning is unfiltered (not
553 paginated) so that the user does not need to page through each
554 screen full of warnings when there are lots of them. */
557 vwarning (const char *string, va_list args)
559 if (deprecated_warning_hook)
560 (*deprecated_warning_hook) (string, args);
563 target_terminal_ours ();
564 wrap_here (""); /* Force out any buffered output. */
565 gdb_flush (gdb_stdout);
566 if (warning_pre_print)
567 fputs_unfiltered (warning_pre_print, gdb_stderr);
568 vfprintf_unfiltered (gdb_stderr, string, args);
569 fprintf_unfiltered (gdb_stderr, "\n");
574 /* Print a warning message.
575 The first argument STRING is the warning message, used as a fprintf string,
576 and the remaining args are passed as arguments to it.
577 The primary difference between warnings and errors is that a warning
578 does not force the return to command level. */
581 warning (const char *string, ...)
585 va_start (args, string);
586 vwarning (string, args);
590 /* Print an error message and return to command level.
591 The first argument STRING is the error message, used as a fprintf string,
592 and the remaining args are passed as arguments to it. */
595 verror (const char *string, va_list args)
597 throw_verror (GENERIC_ERROR, string, args);
601 error (const char *string, ...)
605 va_start (args, string);
606 throw_verror (GENERIC_ERROR, string, args);
610 /* Print an error message and quit.
611 The first argument STRING is the error message, used as a fprintf string,
612 and the remaining args are passed as arguments to it. */
615 vfatal (const char *string, va_list args)
617 throw_vfatal (string, args);
621 fatal (const char *string, ...)
625 va_start (args, string);
626 throw_vfatal (string, args);
631 error_stream (struct ui_file *stream)
633 char *message = ui_file_xstrdup (stream, NULL);
635 make_cleanup (xfree, message);
636 error (("%s"), message);
639 /* Dump core trying to increase the core soft limit to hard limit first. */
644 #ifdef HAVE_SETRLIMIT
645 struct rlimit rlim = { RLIM_INFINITY, RLIM_INFINITY };
647 setrlimit (RLIMIT_CORE, &rlim);
648 #endif /* HAVE_SETRLIMIT */
650 abort (); /* NOTE: GDB has only three calls to abort(). */
653 /* Check whether GDB will be able to dump core using the dump_core
657 can_dump_core (const char *reason)
659 #ifdef HAVE_GETRLIMIT
662 /* Be quiet and assume we can dump if an error is returned. */
663 if (getrlimit (RLIMIT_CORE, &rlim) != 0)
666 if (rlim.rlim_max == 0)
668 fprintf_unfiltered (gdb_stderr,
669 _("%s\nUnable to dump core, use `ulimit -c"
670 " unlimited' before executing GDB next time.\n"),
674 #endif /* HAVE_GETRLIMIT */
679 /* Allow the user to configure the debugger behavior with respect to
680 what to do when an internal problem is detected. */
682 const char internal_problem_ask[] = "ask";
683 const char internal_problem_yes[] = "yes";
684 const char internal_problem_no[] = "no";
685 static const char *const internal_problem_modes[] =
687 internal_problem_ask,
688 internal_problem_yes,
693 /* Print a message reporting an internal error/warning. Ask the user
694 if they want to continue, dump core, or just exit. Return
695 something to indicate a quit. */
697 struct internal_problem
700 const char *should_quit;
701 const char *should_dump_core;
704 /* Report a problem, internal to GDB, to the user. Once the problem
705 has been reported, and assuming GDB didn't quit, the caller can
706 either allow execution to resume or throw an error. */
708 static void ATTRIBUTE_PRINTF (4, 0)
709 internal_vproblem (struct internal_problem *problem,
710 const char *file, int line, const char *fmt, va_list ap)
716 struct cleanup *cleanup = make_cleanup (null_cleanup, NULL);
718 /* Don't allow infinite error/warning recursion. */
720 static char msg[] = "Recursive internal problem.\n";
729 fputs_unfiltered (msg, gdb_stderr);
730 abort (); /* NOTE: GDB has only three calls to abort(). */
733 /* Newer GLIBC versions put the warn_unused_result attribute
734 on write, but this is one of those rare cases where
735 ignoring the return value is correct. Casting to (void)
736 does not fix this problem. This is the solution suggested
737 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
738 if (write (STDERR_FILENO, msg, sizeof (msg)) != sizeof (msg))
739 abort (); /* NOTE: GDB has only three calls to abort(). */
744 /* Try to get the message out and at the start of a new line. */
745 target_terminal_ours ();
748 /* Create a string containing the full error/warning message. Need
749 to call query with this full string, as otherwize the reason
750 (error/warning) and question become separated. Format using a
751 style similar to a compiler error message. Include extra detail
752 so that the user knows that they are living on the edge. */
756 msg = xstrvprintf (fmt, ap);
757 reason = xstrprintf ("%s:%d: %s: %s\n"
758 "A problem internal to GDB has been detected,\n"
759 "further debugging may prove unreliable.",
760 file, line, problem->name, msg);
762 make_cleanup (xfree, reason);
765 if (problem->should_quit == internal_problem_ask)
767 /* Default (yes/batch case) is to quit GDB. When in batch mode
768 this lessens the likelihood of GDB going into an infinite
772 /* Emit the message and quit. */
773 fputs_unfiltered (reason, gdb_stderr);
774 fputs_unfiltered ("\n", gdb_stderr);
778 quit_p = query (_("%s\nQuit this debugging session? "), reason);
780 else if (problem->should_quit == internal_problem_yes)
782 else if (problem->should_quit == internal_problem_no)
785 internal_error (__FILE__, __LINE__, _("bad switch"));
787 if (problem->should_dump_core == internal_problem_ask)
789 if (!can_dump_core (reason))
793 /* Default (yes/batch case) is to dump core. This leaves a GDB
794 `dropping' so that it is easier to see that something went
796 dump_core_p = query (_("%s\nCreate a core file of GDB? "), reason);
799 else if (problem->should_dump_core == internal_problem_yes)
800 dump_core_p = can_dump_core (reason);
801 else if (problem->should_dump_core == internal_problem_no)
804 internal_error (__FILE__, __LINE__, _("bad switch"));
817 #ifdef HAVE_WORKING_FORK
825 do_cleanups (cleanup);
828 static struct internal_problem internal_error_problem = {
829 "internal-error", internal_problem_ask, internal_problem_ask
833 internal_verror (const char *file, int line, const char *fmt, va_list ap)
835 internal_vproblem (&internal_error_problem, file, line, fmt, ap);
836 deprecated_throw_reason (RETURN_ERROR);
840 internal_error (const char *file, int line, const char *string, ...)
844 va_start (ap, string);
845 internal_verror (file, line, string, ap);
849 static struct internal_problem internal_warning_problem = {
850 "internal-warning", internal_problem_ask, internal_problem_ask
854 internal_vwarning (const char *file, int line, const char *fmt, va_list ap)
856 internal_vproblem (&internal_warning_problem, file, line, fmt, ap);
860 internal_warning (const char *file, int line, const char *string, ...)
864 va_start (ap, string);
865 internal_vwarning (file, line, string, ap);
869 /* Dummy functions to keep add_prefix_cmd happy. */
872 set_internal_problem_cmd (char *args, int from_tty)
877 show_internal_problem_cmd (char *args, int from_tty)
881 /* When GDB reports an internal problem (error or warning) it gives
882 the user the opportunity to quit GDB and/or create a core file of
883 the current debug session. This function registers a few commands
884 that make it possible to specify that GDB should always or never
885 quit or create a core file, without asking. The commands look
888 maint set PROBLEM-NAME quit ask|yes|no
889 maint show PROBLEM-NAME quit
890 maint set PROBLEM-NAME corefile ask|yes|no
891 maint show PROBLEM-NAME corefile
893 Where PROBLEM-NAME is currently "internal-error" or
894 "internal-warning". */
897 add_internal_problem_command (struct internal_problem *problem)
899 struct cmd_list_element **set_cmd_list;
900 struct cmd_list_element **show_cmd_list;
904 set_cmd_list = xmalloc (sizeof (*set_cmd_list));
905 show_cmd_list = xmalloc (sizeof (*set_cmd_list));
906 *set_cmd_list = NULL;
907 *show_cmd_list = NULL;
909 set_doc = xstrprintf (_("Configure what GDB does when %s is detected."),
912 show_doc = xstrprintf (_("Show what GDB does when %s is detected."),
915 add_prefix_cmd ((char*) problem->name,
916 class_maintenance, set_internal_problem_cmd, set_doc,
918 concat ("maintenance set ", problem->name, " ",
920 0/*allow-unknown*/, &maintenance_set_cmdlist);
922 add_prefix_cmd ((char*) problem->name,
923 class_maintenance, show_internal_problem_cmd, show_doc,
925 concat ("maintenance show ", problem->name, " ",
927 0/*allow-unknown*/, &maintenance_show_cmdlist);
929 set_doc = xstrprintf (_("Set whether GDB should quit "
930 "when an %s is detected"),
932 show_doc = xstrprintf (_("Show whether GDB will quit "
933 "when an %s is detected"),
935 add_setshow_enum_cmd ("quit", class_maintenance,
936 internal_problem_modes,
937 &problem->should_quit,
949 set_doc = xstrprintf (_("Set whether GDB should create a core "
950 "file of GDB when %s is detected"),
952 show_doc = xstrprintf (_("Show whether GDB will create a core "
953 "file of GDB when %s is detected"),
955 add_setshow_enum_cmd ("corefile", class_maintenance,
956 internal_problem_modes,
957 &problem->should_dump_core,
970 /* Print the system error message for errno, and also mention STRING
971 as the file name for which the error was encountered. Use ERRCODE
972 for the thrown exception. Then return to command level. */
975 throw_perror_with_name (enum errors errcode, const char *string)
980 err = safe_strerror (errno);
981 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
982 strcpy (combined, string);
983 strcat (combined, ": ");
984 strcat (combined, err);
986 /* I understand setting these is a matter of taste. Still, some people
987 may clear errno but not know about bfd_error. Doing this here is not
989 bfd_set_error (bfd_error_no_error);
992 throw_error (errcode, _("%s."), combined);
995 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
998 perror_with_name (const char *string)
1000 throw_perror_with_name (GENERIC_ERROR, string);
1003 /* Print the system error message for ERRCODE, and also mention STRING
1004 as the file name for which the error was encountered. */
1007 print_sys_errmsg (const char *string, int errcode)
1012 err = safe_strerror (errcode);
1013 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
1014 strcpy (combined, string);
1015 strcat (combined, ": ");
1016 strcat (combined, err);
1018 /* We want anything which was printed on stdout to come out first, before
1020 gdb_flush (gdb_stdout);
1021 fprintf_unfiltered (gdb_stderr, "%s.\n", combined);
1024 /* Control C eventually causes this to be called, at a convenient time. */
1030 /* No steenking SIGINT will ever be coming our way when the
1031 program is resumed. Don't lie. */
1035 /* If there is no terminal switching for this target, then we can't
1036 possibly get screwed by the lack of job control. */
1037 || current_target.to_terminal_ours == NULL)
1040 fatal ("Quit (expect signal SIGINT when the program is resumed)");
1045 /* Called when a memory allocation fails, with the number of bytes of
1046 memory requested in SIZE. */
1049 malloc_failure (long size)
1053 internal_error (__FILE__, __LINE__,
1054 _("virtual memory exhausted: can't allocate %ld bytes."),
1059 internal_error (__FILE__, __LINE__, _("virtual memory exhausted."));
1063 /* My replacement for the read system call.
1064 Used like `read' but keeps going if `read' returns too soon. */
1067 myread (int desc, char *addr, int len)
1074 val = read (desc, addr, len);
1078 return orglen - len;
1086 print_spaces (int n, struct ui_file *file)
1088 fputs_unfiltered (n_spaces (n), file);
1091 /* Print a host address. */
1094 gdb_print_host_address (const void *addr, struct ui_file *stream)
1096 fprintf_filtered (stream, "%s", host_address_to_string (addr));
1100 /* A cleanup function that calls regfree. */
1103 do_regfree_cleanup (void *r)
1108 /* Create a new cleanup that frees the compiled regular expression R. */
1111 make_regfree_cleanup (regex_t *r)
1113 return make_cleanup (do_regfree_cleanup, r);
1116 /* Return an xmalloc'd error message resulting from a regular
1117 expression compilation failure. */
1120 get_regcomp_error (int code, regex_t *rx)
1122 size_t length = regerror (code, rx, NULL, 0);
1123 char *result = xmalloc (length);
1125 regerror (code, rx, result, length);
1129 /* Compile a regexp and throw an exception on error. This returns a
1130 cleanup to free the resulting pattern on success. If RX is NULL,
1131 this does nothing and returns NULL. */
1134 compile_rx_or_error (regex_t *pattern, const char *rx, const char *message)
1141 code = regcomp (pattern, rx, REG_NOSUB);
1144 char *err = get_regcomp_error (code, pattern);
1146 make_cleanup (xfree, err);
1147 error (("%s: %s"), message, err);
1150 return make_regfree_cleanup (pattern);
1155 /* This function supports the query, nquery, and yquery functions.
1156 Ask user a y-or-n question and return 0 if answer is no, 1 if
1157 answer is yes, or default the answer to the specified default
1158 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1159 default answer, or '\0' for no default.
1160 CTLSTR is the control string and should end in "? ". It should
1161 not say how to answer, because we do that.
1162 ARGS are the arguments passed along with the CTLSTR argument to
1165 static int ATTRIBUTE_PRINTF (1, 0)
1166 defaulted_query (const char *ctlstr, const char defchar, va_list args)
1172 char def_answer, not_def_answer;
1173 char *y_string, *n_string, *question;
1174 /* Used to add duration we waited for user to respond to
1175 prompt_for_continue_wait_time. */
1176 struct timeval prompt_started, prompt_ended, prompt_delta;
1178 /* Set up according to which answer is the default. */
1179 if (defchar == '\0')
1183 not_def_answer = 'N';
1187 else if (defchar == 'y')
1191 not_def_answer = 'N';
1199 not_def_answer = 'Y';
1204 /* Automatically answer the default value if the user did not want
1205 prompts or the command was issued with the server prefix. */
1206 if (!confirm || server_command)
1209 /* If input isn't coming from the user directly, just say what
1210 question we're asking, and then answer the default automatically. This
1211 way, important error messages don't get lost when talking to GDB
1213 if (! input_from_terminal_p ())
1216 vfprintf_filtered (gdb_stdout, ctlstr, args);
1218 printf_filtered (_("(%s or %s) [answered %c; "
1219 "input not from terminal]\n"),
1220 y_string, n_string, def_answer);
1221 gdb_flush (gdb_stdout);
1226 if (deprecated_query_hook)
1228 return deprecated_query_hook (ctlstr, args);
1231 /* Format the question outside of the loop, to avoid reusing args. */
1232 question = xstrvprintf (ctlstr, args);
1234 /* Used for calculating time spend waiting for user. */
1235 gettimeofday (&prompt_started, NULL);
1239 wrap_here (""); /* Flush any buffered output. */
1240 gdb_flush (gdb_stdout);
1242 if (annotation_level > 1)
1243 printf_filtered (("\n\032\032pre-query\n"));
1245 fputs_filtered (question, gdb_stdout);
1246 printf_filtered (_("(%s or %s) "), y_string, n_string);
1248 if (annotation_level > 1)
1249 printf_filtered (("\n\032\032query\n"));
1252 gdb_flush (gdb_stdout);
1254 answer = fgetc (stdin);
1256 /* We expect fgetc to block until a character is read. But
1257 this may not be the case if the terminal was opened with
1258 the NONBLOCK flag. In that case, if there is nothing to
1259 read on stdin, fgetc returns EOF, but also sets the error
1260 condition flag on stdin and errno to EAGAIN. With a true
1261 EOF, stdin's error condition flag is not set.
1263 A situation where this behavior was observed is a pseudo
1265 while (answer == EOF && ferror (stdin) && errno == EAGAIN)
1267 /* Not a real EOF. Wait a little while and try again until
1268 we read something. */
1271 answer = fgetc (stdin);
1274 clearerr (stdin); /* in case of C-d */
1275 if (answer == EOF) /* C-d */
1277 printf_filtered ("EOF [assumed %c]\n", def_answer);
1281 /* Eat rest of input line, to EOF or newline. */
1285 ans2 = fgetc (stdin);
1288 while (ans2 != EOF && ans2 != '\n' && ans2 != '\r');
1292 /* Check answer. For the non-default, the user must specify
1293 the non-default explicitly. */
1294 if (answer == not_def_answer)
1296 retval = !def_value;
1299 /* Otherwise, if a default was specified, the user may either
1300 specify the required input or have it default by entering
1302 if (answer == def_answer
1303 || (defchar != '\0' &&
1304 (answer == '\n' || answer == '\r' || answer == EOF)))
1309 /* Invalid entries are not defaulted and require another selection. */
1310 printf_filtered (_("Please answer %s or %s.\n"),
1311 y_string, n_string);
1314 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1315 gettimeofday (&prompt_ended, NULL);
1316 timeval_sub (&prompt_delta, &prompt_ended, &prompt_started);
1317 timeval_add (&prompt_for_continue_wait_time,
1318 &prompt_for_continue_wait_time, &prompt_delta);
1321 if (annotation_level > 1)
1322 printf_filtered (("\n\032\032post-query\n"));
1327 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1328 answer is yes, or 0 if answer is defaulted.
1329 Takes three args which are given to printf to print the question.
1330 The first, a control string, should end in "? ".
1331 It should not say how to answer, because we do that. */
1334 nquery (const char *ctlstr, ...)
1339 va_start (args, ctlstr);
1340 ret = defaulted_query (ctlstr, 'n', args);
1345 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1346 answer is yes, or 1 if answer is defaulted.
1347 Takes three args which are given to printf to print the question.
1348 The first, a control string, should end in "? ".
1349 It should not say how to answer, because we do that. */
1352 yquery (const char *ctlstr, ...)
1357 va_start (args, ctlstr);
1358 ret = defaulted_query (ctlstr, 'y', args);
1363 /* Ask user a y-or-n question and return 1 iff answer is yes.
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 query (const char *ctlstr, ...)
1374 va_start (args, ctlstr);
1375 ret = defaulted_query (ctlstr, '\0', args);
1380 /* A helper for parse_escape that converts a host character to a
1381 target character. C is the host character. If conversion is
1382 possible, then the target character is stored in *TARGET_C and the
1383 function returns 1. Otherwise, the function returns 0. */
1386 host_char_to_target (struct gdbarch *gdbarch, int c, int *target_c)
1388 struct obstack host_data;
1390 struct cleanup *cleanups;
1393 obstack_init (&host_data);
1394 cleanups = make_cleanup_obstack_free (&host_data);
1396 convert_between_encodings (target_charset (gdbarch), host_charset (),
1397 (gdb_byte *) &the_char, 1, 1,
1398 &host_data, translit_none);
1400 if (obstack_object_size (&host_data) == 1)
1403 *target_c = *(char *) obstack_base (&host_data);
1406 do_cleanups (cleanups);
1410 /* Parse a C escape sequence. STRING_PTR points to a variable
1411 containing a pointer to the string to parse. That pointer
1412 should point to the character after the \. That pointer
1413 is updated past the characters we use. The value of the
1414 escape sequence is returned.
1416 A negative value means the sequence \ newline was seen,
1417 which is supposed to be equivalent to nothing at all.
1419 If \ is followed by a null character, we return a negative
1420 value and leave the string pointer pointing at the null character.
1422 If \ is followed by 000, we return 0 and leave the string pointer
1423 after the zeros. A value of 0 does not mean end of string. */
1426 parse_escape (struct gdbarch *gdbarch, char **string_ptr)
1428 int target_char = -2; /* Initialize to avoid GCC warnings. */
1429 int c = *(*string_ptr)++;
1448 int i = host_hex_value (c);
1453 if (isdigit (c) && c != '8' && c != '9')
1457 i += host_hex_value (c);
1493 if (!host_char_to_target (gdbarch, c, &target_char))
1494 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1495 " which has no equivalent\nin the `%s' character set."),
1496 c, c, target_charset (gdbarch));
1500 /* Print the character C on STREAM as part of the contents of a literal
1501 string whose delimiter is QUOTER. Note that this routine should only
1502 be call for printing things which are independent of the language
1503 of the program being debugged. */
1506 printchar (int c, void (*do_fputs) (const char *, struct ui_file *),
1507 void (*do_fprintf) (struct ui_file *, const char *, ...)
1508 ATTRIBUTE_FPTR_PRINTF_2, struct ui_file *stream, int quoter)
1510 c &= 0xFF; /* Avoid sign bit follies */
1512 if (c < 0x20 || /* Low control chars */
1513 (c >= 0x7F && c < 0xA0) || /* DEL, High controls */
1514 (sevenbit_strings && c >= 0x80))
1515 { /* high order bit set */
1519 do_fputs ("\\n", stream);
1522 do_fputs ("\\b", stream);
1525 do_fputs ("\\t", stream);
1528 do_fputs ("\\f", stream);
1531 do_fputs ("\\r", stream);
1534 do_fputs ("\\e", stream);
1537 do_fputs ("\\a", stream);
1540 do_fprintf (stream, "\\%.3o", (unsigned int) c);
1546 if (c == '\\' || c == quoter)
1547 do_fputs ("\\", stream);
1548 do_fprintf (stream, "%c", c);
1552 /* Print the character C on STREAM as part of the contents of a
1553 literal string whose delimiter is QUOTER. Note that these routines
1554 should only be call for printing things which are independent of
1555 the language of the program being debugged. */
1558 fputstr_filtered (const char *str, int quoter, struct ui_file *stream)
1561 printchar (*str++, fputs_filtered, fprintf_filtered, stream, quoter);
1565 fputstr_unfiltered (const char *str, int quoter, struct ui_file *stream)
1568 printchar (*str++, fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1572 fputstrn_filtered (const char *str, int n, int quoter,
1573 struct ui_file *stream)
1577 for (i = 0; i < n; i++)
1578 printchar (str[i], fputs_filtered, fprintf_filtered, stream, quoter);
1582 fputstrn_unfiltered (const char *str, int n, int quoter,
1583 struct ui_file *stream)
1587 for (i = 0; i < n; i++)
1588 printchar (str[i], fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1592 /* Number of lines per page or UINT_MAX if paging is disabled. */
1593 static unsigned int lines_per_page;
1595 show_lines_per_page (struct ui_file *file, int from_tty,
1596 struct cmd_list_element *c, const char *value)
1598 fprintf_filtered (file,
1599 _("Number of lines gdb thinks are in a page is %s.\n"),
1603 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1604 static unsigned int chars_per_line;
1606 show_chars_per_line (struct ui_file *file, int from_tty,
1607 struct cmd_list_element *c, const char *value)
1609 fprintf_filtered (file,
1610 _("Number of characters gdb thinks "
1611 "are in a line is %s.\n"),
1615 /* Current count of lines printed on this page, chars on this line. */
1616 static unsigned int lines_printed, chars_printed;
1618 /* Buffer and start column of buffered text, for doing smarter word-
1619 wrapping. When someone calls wrap_here(), we start buffering output
1620 that comes through fputs_filtered(). If we see a newline, we just
1621 spit it out and forget about the wrap_here(). If we see another
1622 wrap_here(), we spit it out and remember the newer one. If we see
1623 the end of the line, we spit out a newline, the indent, and then
1624 the buffered output. */
1626 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1627 are waiting to be output (they have already been counted in chars_printed).
1628 When wrap_buffer[0] is null, the buffer is empty. */
1629 static char *wrap_buffer;
1631 /* Pointer in wrap_buffer to the next character to fill. */
1632 static char *wrap_pointer;
1634 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1636 static char *wrap_indent;
1638 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1639 is not in effect. */
1640 static int wrap_column;
1643 /* Inialize the number of lines per page and chars per line. */
1646 init_page_info (void)
1650 lines_per_page = UINT_MAX;
1651 chars_per_line = UINT_MAX;
1655 if (!tui_get_command_dimension (&chars_per_line, &lines_per_page))
1660 #if defined(__GO32__)
1661 rows = ScreenRows ();
1662 cols = ScreenCols ();
1663 lines_per_page = rows;
1664 chars_per_line = cols;
1666 /* Make sure Readline has initialized its terminal settings. */
1667 rl_reset_terminal (NULL);
1669 /* Get the screen size from Readline. */
1670 rl_get_screen_size (&rows, &cols);
1671 lines_per_page = rows;
1672 chars_per_line = cols;
1674 /* Readline should have fetched the termcap entry for us. */
1675 if (tgetnum ("li") < 0 || getenv ("EMACS"))
1677 /* The number of lines per page is not mentioned in the
1678 terminal description. This probably means that paging is
1679 not useful (e.g. emacs shell window), so disable paging. */
1680 lines_per_page = UINT_MAX;
1683 /* If the output is not a terminal, don't paginate it. */
1684 if (!ui_file_isatty (gdb_stdout))
1685 lines_per_page = UINT_MAX;
1693 /* Helper for make_cleanup_restore_page_info. */
1696 do_restore_page_info_cleanup (void *arg)
1702 /* Provide cleanup for restoring the terminal size. */
1705 make_cleanup_restore_page_info (void)
1707 struct cleanup *back_to;
1709 back_to = make_cleanup (do_restore_page_info_cleanup, NULL);
1710 make_cleanup_restore_uinteger (&lines_per_page);
1711 make_cleanup_restore_uinteger (&chars_per_line);
1716 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1717 Provide cleanup for restoring the original state. */
1720 set_batch_flag_and_make_cleanup_restore_page_info (void)
1722 struct cleanup *back_to = make_cleanup_restore_page_info ();
1724 make_cleanup_restore_integer (&batch_flag);
1731 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1734 set_screen_size (void)
1736 int rows = lines_per_page;
1737 int cols = chars_per_line;
1745 /* Update Readline's idea of the terminal size. */
1746 rl_set_screen_size (rows, cols);
1749 /* Reinitialize WRAP_BUFFER according to the current value of
1755 if (chars_per_line == 0)
1760 wrap_buffer = (char *) xmalloc (chars_per_line + 2);
1761 wrap_buffer[0] = '\0';
1764 wrap_buffer = (char *) xrealloc (wrap_buffer, chars_per_line + 2);
1765 wrap_pointer = wrap_buffer; /* Start it at the beginning. */
1769 set_width_command (char *args, int from_tty, struct cmd_list_element *c)
1776 set_height_command (char *args, int from_tty, struct cmd_list_element *c)
1781 /* Wait, so the user can read what's on the screen. Prompt the user
1782 to continue by pressing RETURN. */
1785 prompt_for_continue (void)
1788 char cont_prompt[120];
1789 /* Used to add duration we waited for user to respond to
1790 prompt_for_continue_wait_time. */
1791 struct timeval prompt_started, prompt_ended, prompt_delta;
1793 gettimeofday (&prompt_started, NULL);
1795 if (annotation_level > 1)
1796 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1798 strcpy (cont_prompt,
1799 "---Type <return> to continue, or q <return> to quit---");
1800 if (annotation_level > 1)
1801 strcat (cont_prompt, "\n\032\032prompt-for-continue\n");
1803 /* We must do this *before* we call gdb_readline, else it will eventually
1804 call us -- thinking that we're trying to print beyond the end of the
1806 reinitialize_more_filter ();
1810 /* On a real operating system, the user can quit with SIGINT.
1813 'q' is provided on all systems so users don't have to change habits
1814 from system to system, and because telling them what to do in
1815 the prompt is more user-friendly than expecting them to think of
1817 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1818 whereas control-C to gdb_readline will cause the user to get dumped
1820 ignore = gdb_readline_wrapper (cont_prompt);
1822 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1823 gettimeofday (&prompt_ended, NULL);
1824 timeval_sub (&prompt_delta, &prompt_ended, &prompt_started);
1825 timeval_add (&prompt_for_continue_wait_time,
1826 &prompt_for_continue_wait_time, &prompt_delta);
1828 if (annotation_level > 1)
1829 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1835 while (*p == ' ' || *p == '\t')
1843 /* Now we have to do this again, so that GDB will know that it doesn't
1844 need to save the ---Type <return>--- line at the top of the screen. */
1845 reinitialize_more_filter ();
1847 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1850 /* Initalize timer to keep track of how long we waited for the user. */
1853 reset_prompt_for_continue_wait_time (void)
1855 static const struct timeval zero_timeval = { 0 };
1857 prompt_for_continue_wait_time = zero_timeval;
1860 /* Fetch the cumulative time spent in prompt_for_continue. */
1863 get_prompt_for_continue_wait_time (void)
1865 return prompt_for_continue_wait_time;
1868 /* Reinitialize filter; ie. tell it to reset to original values. */
1871 reinitialize_more_filter (void)
1877 /* Indicate that if the next sequence of characters overflows the line,
1878 a newline should be inserted here rather than when it hits the end.
1879 If INDENT is non-null, it is a string to be printed to indent the
1880 wrapped part on the next line. INDENT must remain accessible until
1881 the next call to wrap_here() or until a newline is printed through
1884 If the line is already overfull, we immediately print a newline and
1885 the indentation, and disable further wrapping.
1887 If we don't know the width of lines, but we know the page height,
1888 we must not wrap words, but should still keep track of newlines
1889 that were explicitly printed.
1891 INDENT should not contain tabs, as that will mess up the char count
1892 on the next line. FIXME.
1894 This routine is guaranteed to force out any output which has been
1895 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1896 used to force out output from the wrap_buffer. */
1899 wrap_here (char *indent)
1901 /* This should have been allocated, but be paranoid anyway. */
1903 internal_error (__FILE__, __LINE__,
1904 _("failed internal consistency check"));
1908 *wrap_pointer = '\0';
1909 fputs_unfiltered (wrap_buffer, gdb_stdout);
1911 wrap_pointer = wrap_buffer;
1912 wrap_buffer[0] = '\0';
1913 if (chars_per_line == UINT_MAX) /* No line overflow checking. */
1917 else if (chars_printed >= chars_per_line)
1919 puts_filtered ("\n");
1921 puts_filtered (indent);
1926 wrap_column = chars_printed;
1930 wrap_indent = indent;
1934 /* Print input string to gdb_stdout, filtered, with wrap,
1935 arranging strings in columns of n chars. String can be
1936 right or left justified in the column. Never prints
1937 trailing spaces. String should never be longer than
1938 width. FIXME: this could be useful for the EXAMINE
1939 command, which currently doesn't tabulate very well. */
1942 puts_filtered_tabular (char *string, int width, int right)
1948 gdb_assert (chars_per_line > 0);
1949 if (chars_per_line == UINT_MAX)
1951 fputs_filtered (string, gdb_stdout);
1952 fputs_filtered ("\n", gdb_stdout);
1956 if (((chars_printed - 1) / width + 2) * width >= chars_per_line)
1957 fputs_filtered ("\n", gdb_stdout);
1959 if (width >= chars_per_line)
1960 width = chars_per_line - 1;
1962 stringlen = strlen (string);
1964 if (chars_printed > 0)
1965 spaces = width - (chars_printed - 1) % width - 1;
1967 spaces += width - stringlen;
1969 spacebuf = alloca (spaces + 1);
1970 spacebuf[spaces] = '\0';
1972 spacebuf[spaces] = ' ';
1974 fputs_filtered (spacebuf, gdb_stdout);
1975 fputs_filtered (string, gdb_stdout);
1979 /* Ensure that whatever gets printed next, using the filtered output
1980 commands, starts at the beginning of the line. I.e. if there is
1981 any pending output for the current line, flush it and start a new
1982 line. Otherwise do nothing. */
1987 if (chars_printed > 0)
1989 puts_filtered ("\n");
1994 /* Like fputs but if FILTER is true, pause after every screenful.
1996 Regardless of FILTER can wrap at points other than the final
1997 character of a line.
1999 Unlike fputs, fputs_maybe_filtered does not return a value.
2000 It is OK for LINEBUFFER to be NULL, in which case just don't print
2003 Note that a longjmp to top level may occur in this routine (only if
2004 FILTER is true) (since prompt_for_continue may do so) so this
2005 routine should not be called when cleanups are not in place. */
2008 fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
2011 const char *lineptr;
2013 if (linebuffer == 0)
2016 /* Don't do any filtering if it is disabled. */
2017 if (stream != gdb_stdout
2018 || !pagination_enabled
2020 || (lines_per_page == UINT_MAX && chars_per_line == UINT_MAX)
2021 || top_level_interpreter () == NULL
2022 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2024 fputs_unfiltered (linebuffer, stream);
2028 /* Go through and output each character. Show line extension
2029 when this is necessary; prompt user for new page when this is
2032 lineptr = linebuffer;
2035 /* Possible new page. */
2036 if (filter && (lines_printed >= lines_per_page - 1))
2037 prompt_for_continue ();
2039 while (*lineptr && *lineptr != '\n')
2041 /* Print a single line. */
2042 if (*lineptr == '\t')
2045 *wrap_pointer++ = '\t';
2047 fputc_unfiltered ('\t', stream);
2048 /* Shifting right by 3 produces the number of tab stops
2049 we have already passed, and then adding one and
2050 shifting left 3 advances to the next tab stop. */
2051 chars_printed = ((chars_printed >> 3) + 1) << 3;
2057 *wrap_pointer++ = *lineptr;
2059 fputc_unfiltered (*lineptr, stream);
2064 if (chars_printed >= chars_per_line)
2066 unsigned int save_chars = chars_printed;
2070 /* If we aren't actually wrapping, don't output newline --
2071 if chars_per_line is right, we probably just overflowed
2072 anyway; if it's wrong, let us keep going. */
2074 fputc_unfiltered ('\n', stream);
2076 /* Possible new page. */
2077 if (lines_printed >= lines_per_page - 1)
2078 prompt_for_continue ();
2080 /* Now output indentation and wrapped string. */
2083 fputs_unfiltered (wrap_indent, stream);
2084 *wrap_pointer = '\0'; /* Null-terminate saved stuff, */
2085 fputs_unfiltered (wrap_buffer, stream); /* and eject it. */
2086 /* FIXME, this strlen is what prevents wrap_indent from
2087 containing tabs. However, if we recurse to print it
2088 and count its chars, we risk trouble if wrap_indent is
2089 longer than (the user settable) chars_per_line.
2090 Note also that this can set chars_printed > chars_per_line
2091 if we are printing a long string. */
2092 chars_printed = strlen (wrap_indent)
2093 + (save_chars - wrap_column);
2094 wrap_pointer = wrap_buffer; /* Reset buffer */
2095 wrap_buffer[0] = '\0';
2096 wrap_column = 0; /* And disable fancy wrap */
2101 if (*lineptr == '\n')
2104 wrap_here ((char *) 0); /* Spit out chars, cancel
2107 fputc_unfiltered ('\n', stream);
2114 fputs_filtered (const char *linebuffer, struct ui_file *stream)
2116 fputs_maybe_filtered (linebuffer, stream, 1);
2120 putchar_unfiltered (int c)
2124 ui_file_write (gdb_stdout, &buf, 1);
2128 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2129 May return nonlocally. */
2132 putchar_filtered (int c)
2134 return fputc_filtered (c, gdb_stdout);
2138 fputc_unfiltered (int c, struct ui_file *stream)
2142 ui_file_write (stream, &buf, 1);
2147 fputc_filtered (int c, struct ui_file *stream)
2153 fputs_filtered (buf, stream);
2157 /* puts_debug is like fputs_unfiltered, except it prints special
2158 characters in printable fashion. */
2161 puts_debug (char *prefix, char *string, char *suffix)
2165 /* Print prefix and suffix after each line. */
2166 static int new_line = 1;
2167 static int return_p = 0;
2168 static char *prev_prefix = "";
2169 static char *prev_suffix = "";
2171 if (*string == '\n')
2174 /* If the prefix is changing, print the previous suffix, a new line,
2175 and the new prefix. */
2176 if ((return_p || (strcmp (prev_prefix, prefix) != 0)) && !new_line)
2178 fputs_unfiltered (prev_suffix, gdb_stdlog);
2179 fputs_unfiltered ("\n", gdb_stdlog);
2180 fputs_unfiltered (prefix, gdb_stdlog);
2183 /* Print prefix if we printed a newline during the previous call. */
2187 fputs_unfiltered (prefix, gdb_stdlog);
2190 prev_prefix = prefix;
2191 prev_suffix = suffix;
2193 /* Output characters in a printable format. */
2194 while ((ch = *string++) != '\0')
2200 fputc_unfiltered (ch, gdb_stdlog);
2203 fprintf_unfiltered (gdb_stdlog, "\\x%02x", ch & 0xff);
2207 fputs_unfiltered ("\\\\", gdb_stdlog);
2210 fputs_unfiltered ("\\b", gdb_stdlog);
2213 fputs_unfiltered ("\\f", gdb_stdlog);
2217 fputs_unfiltered ("\\n", gdb_stdlog);
2220 fputs_unfiltered ("\\r", gdb_stdlog);
2223 fputs_unfiltered ("\\t", gdb_stdlog);
2226 fputs_unfiltered ("\\v", gdb_stdlog);
2230 return_p = ch == '\r';
2233 /* Print suffix if we printed a newline. */
2236 fputs_unfiltered (suffix, gdb_stdlog);
2237 fputs_unfiltered ("\n", gdb_stdlog);
2242 /* Print a variable number of ARGS using format FORMAT. If this
2243 information is going to put the amount written (since the last call
2244 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2245 call prompt_for_continue to get the users permision to continue.
2247 Unlike fprintf, this function does not return a value.
2249 We implement three variants, vfprintf (takes a vararg list and stream),
2250 fprintf (takes a stream to write on), and printf (the usual).
2252 Note also that a longjmp to top level may occur in this routine
2253 (since prompt_for_continue may do so) so this routine should not be
2254 called when cleanups are not in place. */
2257 vfprintf_maybe_filtered (struct ui_file *stream, const char *format,
2258 va_list args, int filter)
2261 struct cleanup *old_cleanups;
2263 linebuffer = xstrvprintf (format, args);
2264 old_cleanups = make_cleanup (xfree, linebuffer);
2265 fputs_maybe_filtered (linebuffer, stream, filter);
2266 do_cleanups (old_cleanups);
2271 vfprintf_filtered (struct ui_file *stream, const char *format, va_list args)
2273 vfprintf_maybe_filtered (stream, format, args, 1);
2277 vfprintf_unfiltered (struct ui_file *stream, const char *format, va_list args)
2280 struct cleanup *old_cleanups;
2282 linebuffer = xstrvprintf (format, args);
2283 old_cleanups = make_cleanup (xfree, linebuffer);
2284 if (debug_timestamp && stream == gdb_stdlog)
2290 gettimeofday (&tm, NULL);
2292 len = strlen (linebuffer);
2293 need_nl = (len > 0 && linebuffer[len - 1] != '\n');
2295 timestamp = xstrprintf ("%ld:%ld %s%s",
2296 (long) tm.tv_sec, (long) tm.tv_usec,
2298 need_nl ? "\n": "");
2299 make_cleanup (xfree, timestamp);
2300 fputs_unfiltered (timestamp, stream);
2303 fputs_unfiltered (linebuffer, stream);
2304 do_cleanups (old_cleanups);
2308 vprintf_filtered (const char *format, va_list args)
2310 vfprintf_maybe_filtered (gdb_stdout, format, args, 1);
2314 vprintf_unfiltered (const char *format, va_list args)
2316 vfprintf_unfiltered (gdb_stdout, format, args);
2320 fprintf_filtered (struct ui_file *stream, const char *format, ...)
2324 va_start (args, format);
2325 vfprintf_filtered (stream, format, args);
2330 fprintf_unfiltered (struct ui_file *stream, const char *format, ...)
2334 va_start (args, format);
2335 vfprintf_unfiltered (stream, format, args);
2339 /* Like fprintf_filtered, but prints its result indented.
2340 Called as fprintfi_filtered (spaces, stream, format, ...); */
2343 fprintfi_filtered (int spaces, struct ui_file *stream, const char *format,
2348 va_start (args, format);
2349 print_spaces_filtered (spaces, stream);
2351 vfprintf_filtered (stream, format, args);
2357 printf_filtered (const char *format, ...)
2361 va_start (args, format);
2362 vfprintf_filtered (gdb_stdout, format, args);
2368 printf_unfiltered (const char *format, ...)
2372 va_start (args, format);
2373 vfprintf_unfiltered (gdb_stdout, format, args);
2377 /* Like printf_filtered, but prints it's result indented.
2378 Called as printfi_filtered (spaces, format, ...); */
2381 printfi_filtered (int spaces, const char *format, ...)
2385 va_start (args, format);
2386 print_spaces_filtered (spaces, gdb_stdout);
2387 vfprintf_filtered (gdb_stdout, format, args);
2391 /* Easy -- but watch out!
2393 This routine is *not* a replacement for puts()! puts() appends a newline.
2394 This one doesn't, and had better not! */
2397 puts_filtered (const char *string)
2399 fputs_filtered (string, gdb_stdout);
2403 puts_unfiltered (const char *string)
2405 fputs_unfiltered (string, gdb_stdout);
2408 /* Return a pointer to N spaces and a null. The pointer is good
2409 until the next call to here. */
2414 static char *spaces = 0;
2415 static int max_spaces = -1;
2421 spaces = (char *) xmalloc (n + 1);
2422 for (t = spaces + n; t != spaces;)
2428 return spaces + max_spaces - n;
2431 /* Print N spaces. */
2433 print_spaces_filtered (int n, struct ui_file *stream)
2435 fputs_filtered (n_spaces (n), stream);
2438 /* C++/ObjC demangler stuff. */
2440 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2441 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2442 If the name is not mangled, or the language for the name is unknown, or
2443 demangling is off, the name is printed in its "raw" form. */
2446 fprintf_symbol_filtered (struct ui_file *stream, const char *name,
2447 enum language lang, int arg_mode)
2453 /* If user wants to see raw output, no problem. */
2456 fputs_filtered (name, stream);
2460 demangled = language_demangle (language_def (lang), name, arg_mode);
2461 fputs_filtered (demangled ? demangled : name, stream);
2462 if (demangled != NULL)
2470 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2471 differences in whitespace. Returns 0 if they match, non-zero if they
2472 don't (slightly different than strcmp()'s range of return values).
2474 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2475 This "feature" is useful when searching for matching C++ function names
2476 (such as if the user types 'break FOO', where FOO is a mangled C++
2480 strcmp_iw (const char *string1, const char *string2)
2482 while ((*string1 != '\0') && (*string2 != '\0'))
2484 while (isspace (*string1))
2488 while (isspace (*string2))
2492 if (case_sensitivity == case_sensitive_on && *string1 != *string2)
2494 if (case_sensitivity == case_sensitive_off
2495 && (tolower ((unsigned char) *string1)
2496 != tolower ((unsigned char) *string2)))
2498 if (*string1 != '\0')
2504 return (*string1 != '\0' && *string1 != '(') || (*string2 != '\0');
2507 /* This is like strcmp except that it ignores whitespace and treats
2508 '(' as the first non-NULL character in terms of ordering. Like
2509 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2510 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2511 according to that ordering.
2513 If a list is sorted according to this function and if you want to
2514 find names in the list that match some fixed NAME according to
2515 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2516 where this function would put NAME.
2518 This function must be neutral to the CASE_SENSITIVITY setting as the user
2519 may choose it during later lookup. Therefore this function always sorts
2520 primarily case-insensitively and secondarily case-sensitively.
2522 Here are some examples of why using strcmp to sort is a bad idea:
2526 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2527 we try to do a search for "foo<char*>", strcmp will locate this
2528 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2529 will start looking at strings beginning with "goo", and will never
2530 see the correct match of "foo<char *>".
2532 Parenthesis example:
2534 In practice, this is less like to be an issue, but I'll give it a
2535 shot. Let's assume that '$' is a legitimate character to occur in
2536 symbols. (Which may well even be the case on some systems.) Then
2537 say that the partial symbol table contains "foo$" and "foo(int)".
2538 strcmp will put them in this order, since '$' < '('. Now, if the
2539 user searches for "foo", then strcmp will sort "foo" before "foo$".
2540 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2541 "foo") is false, so it won't proceed to the actual match of
2542 "foo(int)" with "foo". */
2545 strcmp_iw_ordered (const char *string1, const char *string2)
2547 const char *saved_string1 = string1, *saved_string2 = string2;
2548 enum case_sensitivity case_pass = case_sensitive_off;
2552 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2553 Provide stub characters if we are already at the end of one of the
2555 char c1 = 'X', c2 = 'X';
2557 while (*string1 != '\0' && *string2 != '\0')
2559 while (isspace (*string1))
2561 while (isspace (*string2))
2566 case case_sensitive_off:
2567 c1 = tolower ((unsigned char) *string1);
2568 c2 = tolower ((unsigned char) *string2);
2570 case case_sensitive_on:
2578 if (*string1 != '\0')
2587 /* Characters are non-equal unless they're both '\0'; we want to
2588 make sure we get the comparison right according to our
2589 comparison in the cases where one of them is '\0' or '('. */
2591 if (*string2 == '\0')
2596 if (*string2 == '\0')
2601 if (*string2 == '\0' || *string2 == '(')
2610 if (case_pass == case_sensitive_on)
2613 /* Otherwise the strings were equal in case insensitive way, make
2614 a more fine grained comparison in a case sensitive way. */
2616 case_pass = case_sensitive_on;
2617 string1 = saved_string1;
2618 string2 = saved_string2;
2622 /* A simple comparison function with opposite semantics to strcmp. */
2625 streq (const char *lhs, const char *rhs)
2627 return !strcmp (lhs, rhs);
2633 ** Answer whether string_to_compare is a full or partial match to
2634 ** template_string. The partial match must be in sequence starting
2638 subset_compare (char *string_to_compare, char *template_string)
2642 if (template_string != (char *) NULL && string_to_compare != (char *) NULL
2643 && strlen (string_to_compare) <= strlen (template_string))
2646 (template_string, string_to_compare, strlen (string_to_compare)) == 0);
2653 pagination_on_command (char *arg, int from_tty)
2655 pagination_enabled = 1;
2659 pagination_off_command (char *arg, int from_tty)
2661 pagination_enabled = 0;
2665 show_debug_timestamp (struct ui_file *file, int from_tty,
2666 struct cmd_list_element *c, const char *value)
2668 fprintf_filtered (file, _("Timestamping debugging messages is %s.\n"),
2674 initialize_utils (void)
2676 add_setshow_uinteger_cmd ("width", class_support, &chars_per_line, _("\
2677 Set number of characters where GDB should wrap lines of its output."), _("\
2678 Show number of characters where GDB should wrap lines of its output."), _("\
2679 This affects where GDB wraps its output to fit the screen width.\n\
2680 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2682 show_chars_per_line,
2683 &setlist, &showlist);
2685 add_setshow_uinteger_cmd ("height", class_support, &lines_per_page, _("\
2686 Set number of lines in a page for GDB output pagination."), _("\
2687 Show number of lines in a page for GDB output pagination."), _("\
2688 This affects the number of lines after which GDB will pause\n\
2689 its output and ask you whether to continue.\n\
2690 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2692 show_lines_per_page,
2693 &setlist, &showlist);
2697 add_setshow_boolean_cmd ("pagination", class_support,
2698 &pagination_enabled, _("\
2699 Set state of GDB output pagination."), _("\
2700 Show state of GDB output pagination."), _("\
2701 When pagination is ON, GDB pauses at end of each screenful of\n\
2702 its output and asks you whether to continue.\n\
2703 Turning pagination off is an alternative to \"set height unlimited\"."),
2705 show_pagination_enabled,
2706 &setlist, &showlist);
2710 add_com ("am", class_support, pagination_on_command,
2711 _("Enable pagination"));
2712 add_com ("sm", class_support, pagination_off_command,
2713 _("Disable pagination"));
2716 add_setshow_boolean_cmd ("sevenbit-strings", class_support,
2717 &sevenbit_strings, _("\
2718 Set printing of 8-bit characters in strings as \\nnn."), _("\
2719 Show printing of 8-bit characters in strings as \\nnn."), NULL,
2721 show_sevenbit_strings,
2722 &setprintlist, &showprintlist);
2724 add_setshow_boolean_cmd ("timestamp", class_maintenance,
2725 &debug_timestamp, _("\
2726 Set timestamping of debugging messages."), _("\
2727 Show timestamping of debugging messages."), _("\
2728 When set, debugging messages will be marked with seconds and microseconds."),
2730 show_debug_timestamp,
2731 &setdebuglist, &showdebuglist);
2734 /* Print routines to handle variable size regs, etc. */
2735 /* Temporary storage using circular buffer. */
2741 static char buf[NUMCELLS][CELLSIZE];
2742 static int cell = 0;
2744 if (++cell >= NUMCELLS)
2750 paddress (struct gdbarch *gdbarch, CORE_ADDR addr)
2752 /* Truncate address to the size of a target address, avoiding shifts
2753 larger or equal than the width of a CORE_ADDR. The local
2754 variable ADDR_BIT stops the compiler reporting a shift overflow
2755 when it won't occur. */
2756 /* NOTE: This assumes that the significant address information is
2757 kept in the least significant bits of ADDR - the upper bits were
2758 either zero or sign extended. Should gdbarch_address_to_pointer or
2759 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2761 int addr_bit = gdbarch_addr_bit (gdbarch);
2763 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2764 addr &= ((CORE_ADDR) 1 << addr_bit) - 1;
2765 return hex_string (addr);
2768 /* This function is described in "defs.h". */
2771 print_core_address (struct gdbarch *gdbarch, CORE_ADDR address)
2773 int addr_bit = gdbarch_addr_bit (gdbarch);
2775 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2776 address &= ((CORE_ADDR) 1 << addr_bit) - 1;
2778 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2779 that returns the language localized string formatted to a width
2780 based on gdbarch_addr_bit. */
2782 return hex_string_custom (address, 8);
2784 return hex_string_custom (address, 16);
2787 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2790 core_addr_hash (const void *ap)
2792 const CORE_ADDR *addrp = ap;
2797 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2800 core_addr_eq (const void *ap, const void *bp)
2802 const CORE_ADDR *addr_ap = ap;
2803 const CORE_ADDR *addr_bp = bp;
2805 return *addr_ap == *addr_bp;
2809 decimal2str (char *sign, ULONGEST addr, int width)
2811 /* Steal code from valprint.c:print_decimal(). Should this worry
2812 about the real size of addr as the above does? */
2813 unsigned long temp[3];
2814 char *str = get_cell ();
2819 temp[i] = addr % (1000 * 1000 * 1000);
2820 addr /= (1000 * 1000 * 1000);
2824 while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0])));
2833 xsnprintf (str, CELLSIZE, "%s%0*lu", sign, width, temp[0]);
2836 xsnprintf (str, CELLSIZE, "%s%0*lu%09lu", sign, width,
2840 xsnprintf (str, CELLSIZE, "%s%0*lu%09lu%09lu", sign, width,
2841 temp[2], temp[1], temp[0]);
2844 internal_error (__FILE__, __LINE__,
2845 _("failed internal consistency check"));
2852 octal2str (ULONGEST addr, int width)
2854 unsigned long temp[3];
2855 char *str = get_cell ();
2860 temp[i] = addr % (0100000 * 0100000);
2861 addr /= (0100000 * 0100000);
2865 while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0])));
2875 xsnprintf (str, CELLSIZE, "%*o", width, 0);
2877 xsnprintf (str, CELLSIZE, "0%0*lo", width, temp[0]);
2880 xsnprintf (str, CELLSIZE, "0%0*lo%010lo", width, temp[1], temp[0]);
2883 xsnprintf (str, CELLSIZE, "0%0*lo%010lo%010lo", width,
2884 temp[2], temp[1], temp[0]);
2887 internal_error (__FILE__, __LINE__,
2888 _("failed internal consistency check"));
2895 pulongest (ULONGEST u)
2897 return decimal2str ("", u, 0);
2901 plongest (LONGEST l)
2904 return decimal2str ("-", -l, 0);
2906 return decimal2str ("", l, 0);
2909 /* Eliminate warning from compiler on 32-bit systems. */
2910 static int thirty_two = 32;
2913 phex (ULONGEST l, int sizeof_l)
2921 xsnprintf (str, CELLSIZE, "%08lx%08lx",
2922 (unsigned long) (l >> thirty_two),
2923 (unsigned long) (l & 0xffffffff));
2927 xsnprintf (str, CELLSIZE, "%08lx", (unsigned long) l);
2931 xsnprintf (str, CELLSIZE, "%04x", (unsigned short) (l & 0xffff));
2934 str = phex (l, sizeof (l));
2942 phex_nz (ULONGEST l, int sizeof_l)
2950 unsigned long high = (unsigned long) (l >> thirty_two);
2954 xsnprintf (str, CELLSIZE, "%lx",
2955 (unsigned long) (l & 0xffffffff));
2957 xsnprintf (str, CELLSIZE, "%lx%08lx", high,
2958 (unsigned long) (l & 0xffffffff));
2963 xsnprintf (str, CELLSIZE, "%lx", (unsigned long) l);
2967 xsnprintf (str, CELLSIZE, "%x", (unsigned short) (l & 0xffff));
2970 str = phex_nz (l, sizeof (l));
2977 /* Converts a LONGEST to a C-format hexadecimal literal and stores it
2978 in a static string. Returns a pointer to this string. */
2980 hex_string (LONGEST num)
2982 char *result = get_cell ();
2984 xsnprintf (result, CELLSIZE, "0x%s", phex_nz (num, sizeof (num)));
2988 /* Converts a LONGEST number to a C-format hexadecimal literal and
2989 stores it in a static string. Returns a pointer to this string
2990 that is valid until the next call. The number is padded on the
2991 left with 0s to at least WIDTH characters. */
2993 hex_string_custom (LONGEST num, int width)
2995 char *result = get_cell ();
2996 char *result_end = result + CELLSIZE - 1;
2997 const char *hex = phex_nz (num, sizeof (num));
2998 int hex_len = strlen (hex);
3000 if (hex_len > width)
3002 if (width + 2 >= CELLSIZE)
3003 internal_error (__FILE__, __LINE__, _("\
3004 hex_string_custom: insufficient space to store result"));
3006 strcpy (result_end - width - 2, "0x");
3007 memset (result_end - width, '0', width);
3008 strcpy (result_end - hex_len, hex);
3009 return result_end - width - 2;
3012 /* Convert VAL to a numeral in the given radix. For
3013 * radix 10, IS_SIGNED may be true, indicating a signed quantity;
3014 * otherwise VAL is interpreted as unsigned. If WIDTH is supplied,
3015 * it is the minimum width (0-padded if needed). USE_C_FORMAT means
3016 * to use C format in all cases. If it is false, then 'x'
3017 * and 'o' formats do not include a prefix (0x or leading 0). */
3020 int_string (LONGEST val, int radix, int is_signed, int width,
3030 result = hex_string (val);
3032 result = hex_string_custom (val, width);
3039 if (is_signed && val < 0)
3040 return decimal2str ("-", -val, width);
3042 return decimal2str ("", val, width);
3046 char *result = octal2str (val, width);
3048 if (use_c_format || val == 0)
3054 internal_error (__FILE__, __LINE__,
3055 _("failed internal consistency check"));
3059 /* Convert a CORE_ADDR into a string. */
3061 core_addr_to_string (const CORE_ADDR addr)
3063 char *str = get_cell ();
3066 strcat (str, phex (addr, sizeof (addr)));
3071 core_addr_to_string_nz (const CORE_ADDR addr)
3073 char *str = get_cell ();
3076 strcat (str, phex_nz (addr, sizeof (addr)));
3080 /* Convert a string back into a CORE_ADDR. */
3082 string_to_core_addr (const char *my_string)
3086 if (my_string[0] == '0' && tolower (my_string[1]) == 'x')
3088 /* Assume that it is in hex. */
3091 for (i = 2; my_string[i] != '\0'; i++)
3093 if (isdigit (my_string[i]))
3094 addr = (my_string[i] - '0') + (addr * 16);
3095 else if (isxdigit (my_string[i]))
3096 addr = (tolower (my_string[i]) - 'a' + 0xa) + (addr * 16);
3098 error (_("invalid hex \"%s\""), my_string);
3103 /* Assume that it is in decimal. */
3106 for (i = 0; my_string[i] != '\0'; i++)
3108 if (isdigit (my_string[i]))
3109 addr = (my_string[i] - '0') + (addr * 10);
3111 error (_("invalid decimal \"%s\""), my_string);
3119 host_address_to_string (const void *addr)
3121 char *str = get_cell ();
3123 xsnprintf (str, CELLSIZE, "0x%s", phex_nz ((uintptr_t) addr, sizeof (addr)));
3128 gdb_realpath (const char *filename)
3130 /* Method 1: The system has a compile time upper bound on a filename
3131 path. Use that and realpath() to canonicalize the name. This is
3132 the most common case. Note that, if there isn't a compile time
3133 upper bound, you want to avoid realpath() at all costs. */
3134 #if defined(HAVE_REALPATH)
3136 # if defined (PATH_MAX)
3138 # define USE_REALPATH
3139 # elif defined (MAXPATHLEN)
3140 char buf[MAXPATHLEN];
3141 # define USE_REALPATH
3143 # if defined (USE_REALPATH)
3144 const char *rp = realpath (filename, buf);
3148 return xstrdup (rp);
3151 #endif /* HAVE_REALPATH */
3153 /* Method 2: The host system (i.e., GNU) has the function
3154 canonicalize_file_name() which malloc's a chunk of memory and
3155 returns that, use that. */
3156 #if defined(HAVE_CANONICALIZE_FILE_NAME)
3158 char *rp = canonicalize_file_name (filename);
3161 return xstrdup (filename);
3167 /* FIXME: cagney/2002-11-13:
3169 Method 2a: Use realpath() with a NULL buffer. Some systems, due
3170 to the problems described in method 3, have modified their
3171 realpath() implementation so that it will allocate a buffer when
3172 NULL is passed in. Before this can be used, though, some sort of
3173 configure time test would need to be added. Otherwize the code
3174 will likely core dump. */
3176 /* Method 3: Now we're getting desperate! The system doesn't have a
3177 compile time buffer size and no alternative function. Query the
3178 OS, using pathconf(), for the buffer limit. Care is needed
3179 though, some systems do not limit PATH_MAX (return -1 for
3180 pathconf()) making it impossible to pass a correctly sized buffer
3181 to realpath() (it could always overflow). On those systems, we
3183 #if defined (HAVE_REALPATH) && defined (HAVE_UNISTD_H) && defined(HAVE_ALLOCA)
3185 /* Find out the max path size. */
3186 long path_max = pathconf ("/", _PC_PATH_MAX);
3190 /* PATH_MAX is bounded. */
3191 char *buf = alloca (path_max);
3192 char *rp = realpath (filename, buf);
3194 return xstrdup (rp ? rp : filename);
3199 /* The MS Windows method. If we don't have realpath, we assume we
3200 don't have symlinks and just canonicalize to a Windows absolute
3201 path. GetFullPath converts ../ and ./ in relative paths to
3202 absolute paths, filling in current drive if one is not given
3203 or using the current directory of a specified drive (eg, "E:foo").
3204 It also converts all forward slashes to back slashes. */
3205 /* The file system is case-insensitive but case-preserving.
3206 So we do not lowercase the path. Otherwise, we might not
3207 be able to display the original casing in a given path. */
3208 #if defined (_WIN32)
3211 DWORD len = GetFullPathName (filename, MAX_PATH, buf, NULL);
3213 if (len > 0 && len < MAX_PATH)
3214 return xstrdup (buf);
3218 /* This system is a lost cause, just dup the buffer. */
3219 return xstrdup (filename);
3223 align_up (ULONGEST v, int n)
3225 /* Check that N is really a power of two. */
3226 gdb_assert (n && (n & (n-1)) == 0);
3227 return (v + n - 1) & -n;
3231 align_down (ULONGEST v, int n)
3233 /* Check that N is really a power of two. */
3234 gdb_assert (n && (n & (n-1)) == 0);
3238 /* Allocation function for the libiberty hash table which uses an
3239 obstack. The obstack is passed as DATA. */
3242 hashtab_obstack_allocate (void *data, size_t size, size_t count)
3244 unsigned int total = size * count;
3245 void *ptr = obstack_alloc ((struct obstack *) data, total);
3247 memset (ptr, 0, total);
3251 /* Trivial deallocation function for the libiberty splay tree and hash
3252 table - don't deallocate anything. Rely on later deletion of the
3253 obstack. DATA will be the obstack, although it is not needed
3257 dummy_obstack_deallocate (void *object, void *data)
3262 /* The bit offset of the highest byte in a ULONGEST, for overflow
3265 #define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT)
3267 /* True (non-zero) iff DIGIT is a valid digit in radix BASE,
3268 where 2 <= BASE <= 36. */
3271 is_digit_in_base (unsigned char digit, int base)
3273 if (!isalnum (digit))
3276 return (isdigit (digit) && digit < base + '0');
3278 return (isdigit (digit) || tolower (digit) < base - 10 + 'a');
3282 digit_to_int (unsigned char c)
3287 return tolower (c) - 'a' + 10;
3290 /* As for strtoul, but for ULONGEST results. */
3293 strtoulst (const char *num, const char **trailer, int base)
3295 unsigned int high_part;
3300 /* Skip leading whitespace. */
3301 while (isspace (num[i]))
3304 /* Handle prefixes. */
3307 else if (num[i] == '-')
3313 if (base == 0 || base == 16)
3315 if (num[i] == '0' && (num[i + 1] == 'x' || num[i + 1] == 'X'))
3323 if (base == 0 && num[i] == '0')
3329 if (base < 2 || base > 36)
3335 result = high_part = 0;
3336 for (; is_digit_in_base (num[i], base); i += 1)
3338 result = result * base + digit_to_int (num[i]);
3339 high_part = high_part * base + (unsigned int) (result >> HIGH_BYTE_POSN);
3340 result &= ((ULONGEST) 1 << HIGH_BYTE_POSN) - 1;
3341 if (high_part > 0xff)
3344 result = ~ (ULONGEST) 0;
3351 if (trailer != NULL)
3354 result = result + ((ULONGEST) high_part << HIGH_BYTE_POSN);
3361 /* Simple, portable version of dirname that does not modify its
3365 ldirname (const char *filename)
3367 const char *base = lbasename (filename);
3370 while (base > filename && IS_DIR_SEPARATOR (base[-1]))
3373 if (base == filename)
3376 dirname = xmalloc (base - filename + 2);
3377 memcpy (dirname, filename, base - filename);
3379 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3380 create "d:./bar" later instead of the (different) "d:/bar". */
3381 if (base - filename == 2 && IS_ABSOLUTE_PATH (base)
3382 && !IS_DIR_SEPARATOR (filename[0]))
3383 dirname[base++ - filename] = '.';
3385 dirname[base - filename] = '\0';
3389 /* Call libiberty's buildargv, and return the result.
3390 If buildargv fails due to out-of-memory, call nomem.
3391 Therefore, the returned value is guaranteed to be non-NULL,
3392 unless the parameter itself is NULL. */
3395 gdb_buildargv (const char *s)
3397 char **argv = buildargv (s);
3399 if (s != NULL && argv == NULL)
3405 compare_positive_ints (const void *ap, const void *bp)
3407 /* Because we know we're comparing two ints which are positive,
3408 there's no danger of overflow here. */
3409 return * (int *) ap - * (int *) bp;
3412 /* String compare function for qsort. */
3415 compare_strings (const void *arg1, const void *arg2)
3417 const char **s1 = (const char **) arg1;
3418 const char **s2 = (const char **) arg2;
3420 return strcmp (*s1, *s2);
3423 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3424 #define AMBIGUOUS_MESS2 \
3425 ".\nUse \"set gnutarget format-name\" to specify the format."
3428 gdb_bfd_errmsg (bfd_error_type error_tag, char **matching)
3434 /* Check if errmsg just need simple return. */
3435 if (error_tag != bfd_error_file_ambiguously_recognized || matching == NULL)
3436 return bfd_errmsg (error_tag);
3438 ret_len = strlen (bfd_errmsg (error_tag)) + strlen (AMBIGUOUS_MESS1)
3439 + strlen (AMBIGUOUS_MESS2);
3440 for (p = matching; *p; p++)
3441 ret_len += strlen (*p) + 1;
3442 ret = xmalloc (ret_len + 1);
3444 make_cleanup (xfree, ret);
3446 strcpy (retp, bfd_errmsg (error_tag));
3447 retp += strlen (retp);
3449 strcpy (retp, AMBIGUOUS_MESS1);
3450 retp += strlen (retp);
3452 for (p = matching; *p; p++)
3454 sprintf (retp, " %s", *p);
3455 retp += strlen (retp);
3459 strcpy (retp, AMBIGUOUS_MESS2);
3464 /* Return ARGS parsed as a valid pid, or throw an error. */
3467 parse_pid_to_attach (char *args)
3473 error_no_arg (_("process-id to attach"));
3476 pid = strtoul (args, &dummy, 0);
3477 /* Some targets don't set errno on errors, grrr! */
3478 if ((pid == 0 && dummy == args) || dummy != &args[strlen (args)])
3479 error (_("Illegal process-id: %s."), args);
3484 /* Helper for make_bpstat_clear_actions_cleanup. */
3487 do_bpstat_clear_actions_cleanup (void *unused)
3489 bpstat_clear_actions ();
3492 /* Call bpstat_clear_actions for the case an exception is throw. You should
3493 discard_cleanups if no exception is caught. */
3496 make_bpstat_clear_actions_cleanup (void)
3498 return make_cleanup (do_bpstat_clear_actions_cleanup, NULL);
3501 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3502 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3503 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3506 producer_is_gcc_ge_4 (const char *producer)
3511 if (producer == NULL)
3513 /* For unknown compilers expect their behavior is not compliant. For GCC
3514 this case can also happen for -gdwarf-4 type units supported since
3520 /* Skip any identifier after "GNU " - such as "C++" or "Java". */
3522 if (strncmp (producer, "GNU ", strlen ("GNU ")) != 0)
3524 /* For non-GCC compilers expect their behavior is not compliant. */
3528 cs = &producer[strlen ("GNU ")];
3529 while (*cs && !isdigit (*cs))
3531 if (sscanf (cs, "%d.%d", &major, &minor) != 2)
3533 /* Not recognized as GCC. */
3545 /* Helper for make_cleanup_free_char_ptr_vec. */
3548 do_free_char_ptr_vec (void *arg)
3550 VEC (char_ptr) *char_ptr_vec = arg;
3552 free_char_ptr_vec (char_ptr_vec);
3555 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3556 final VEC_free for CHAR_PTR_VEC itself.
3558 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3559 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3560 this function does not (cannot) clear the pointer. */
3563 make_cleanup_free_char_ptr_vec (VEC (char_ptr) *char_ptr_vec)
3565 return make_cleanup (do_free_char_ptr_vec, char_ptr_vec);
3568 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3569 must come from xrealloc-compatible allocator and it may be updated. FROM
3570 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3571 located at the start or end of *STRINGP. */
3574 substitute_path_component (char **stringp, const char *from, const char *to)
3576 char *string = *stringp, *s;
3577 const size_t from_len = strlen (from);
3578 const size_t to_len = strlen (to);
3582 s = strstr (s, from);
3586 if ((s == string || IS_DIR_SEPARATOR (s[-1])
3587 || s[-1] == DIRNAME_SEPARATOR)
3588 && (s[from_len] == '\0' || IS_DIR_SEPARATOR (s[from_len])
3589 || s[from_len] == DIRNAME_SEPARATOR))
3593 string_new = xrealloc (string, (strlen (string) + to_len + 1));
3595 /* Relocate the current S pointer. */
3596 s = s - string + string_new;
3597 string = string_new;
3599 /* Replace from by to. */
3600 memmove (&s[to_len], &s[from_len], strlen (&s[from_len]) + 1);
3601 memcpy (s, to, to_len);
3616 /* SIGALRM handler for waitpid_with_timeout. */
3619 sigalrm_handler (int signo)
3621 /* Nothing to do. */
3626 /* Wrapper to wait for child PID to die with TIMEOUT.
3627 TIMEOUT is the time to stop waiting in seconds.
3628 If TIMEOUT is zero, pass WNOHANG to waitpid.
3629 Returns PID if it was successfully waited for, otherwise -1.
3631 Timeouts are currently implemented with alarm and SIGALRM.
3632 If the host does not support them, this waits "forever".
3633 It would be odd though for a host to have waitpid and not SIGALRM. */
3636 wait_to_die_with_timeout (pid_t pid, int *status, int timeout)
3638 pid_t waitpid_result;
3640 gdb_assert (pid > 0);
3641 gdb_assert (timeout >= 0);
3646 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3647 struct sigaction sa, old_sa;
3649 sa.sa_handler = sigalrm_handler;
3650 sigemptyset (&sa.sa_mask);
3652 sigaction (SIGALRM, &sa, &old_sa);
3656 ofunc = (void (*)()) signal (SIGALRM, sigalrm_handler);
3662 waitpid_result = waitpid (pid, status, 0);
3666 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3667 sigaction (SIGALRM, &old_sa, NULL);
3669 signal (SIGALRM, ofunc);
3674 waitpid_result = waitpid (pid, status, WNOHANG);
3676 if (waitpid_result == pid)
3682 #endif /* HAVE_WAITPID */
3684 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3685 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3687 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3688 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3691 gdb_filename_fnmatch (const char *pattern, const char *string, int flags)
3693 gdb_assert ((flags & FNM_FILE_NAME) != 0);
3695 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3696 gdb_assert ((flags & FNM_NOESCAPE) != 0);
3698 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3700 char *pattern_slash, *string_slash;
3702 /* Replace '\' by '/' in both strings. */
3704 pattern_slash = alloca (strlen (pattern) + 1);
3705 strcpy (pattern_slash, pattern);
3706 pattern = pattern_slash;
3707 for (; *pattern_slash != 0; pattern_slash++)
3708 if (IS_DIR_SEPARATOR (*pattern_slash))
3709 *pattern_slash = '/';
3711 string_slash = alloca (strlen (string) + 1);
3712 strcpy (string_slash, string);
3713 string = string_slash;
3714 for (; *string_slash != 0; string_slash++)
3715 if (IS_DIR_SEPARATOR (*string_slash))
3716 *string_slash = '/';
3718 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3720 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3721 flags |= FNM_CASEFOLD;
3722 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3724 return fnmatch (pattern, string, flags);
3727 /* Provide a prototype to silence -Wmissing-prototypes. */
3728 extern initialize_file_ftype _initialize_utils;
3731 _initialize_utils (void)
3733 add_internal_problem_command (&internal_error_problem);
3734 add_internal_problem_command (&internal_warning_problem);