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 "gdb_curses.h"
71 #include "readline/readline.h"
76 #include "gdb_usleep.h"
78 #include "gdb_regex.h"
81 extern PTR malloc (); /* ARI: PTR */
83 #if !HAVE_DECL_REALLOC
84 extern PTR realloc (); /* ARI: PTR */
90 void (*deprecated_error_begin_hook) (void);
92 /* Prototypes for local functions */
94 static void vfprintf_maybe_filtered (struct ui_file *, const char *,
95 va_list, int) ATTRIBUTE_PRINTF (2, 0);
97 static void fputs_maybe_filtered (const char *, struct ui_file *, int);
99 static void prompt_for_continue (void);
101 static void set_screen_size (void);
102 static void set_width (void);
104 /* Time spent in prompt_for_continue in the currently executing command
105 waiting for user to respond.
106 Initialized in make_command_stats_cleanup.
107 Modified in prompt_for_continue and defaulted_query.
108 Used in report_command_stats. */
110 static struct timeval prompt_for_continue_wait_time;
112 /* A flag indicating whether to timestamp debugging messages. */
114 static int debug_timestamp = 0;
116 /* Nonzero if we have job control. */
121 /* Nonzero means a quit has been requested. */
124 #endif /* HAVE_PYTHON */
126 /* Nonzero means quit immediately if Control-C is typed now, rather
127 than waiting until QUIT is executed. Be careful in setting this;
128 code which executes with immediate_quit set has to be very careful
129 about being able to deal with being interrupted at any time. It is
130 almost always better to use QUIT; the only exception I can think of
131 is being able to quit out of a system call (using EINTR loses if
132 the SIGINT happens between the previous QUIT and the system call).
133 To immediately quit in the case in which a SIGINT happens between
134 the previous QUIT and setting immediate_quit (desirable anytime we
135 expect to block), call QUIT after setting immediate_quit. */
141 /* Clear the quit flag. */
144 clear_quit_flag (void)
149 /* Set the quit flag. */
157 /* Return true if the quit flag has been set, false otherwise. */
160 check_quit_flag (void)
162 /* This is written in a particular way to avoid races. */
172 #endif /* HAVE_PYTHON */
174 /* Nonzero means that strings with character values >0x7F should be printed
175 as octal escapes. Zero means just print the value (e.g. it's an
176 international character, and the terminal or window can cope.) */
178 int sevenbit_strings = 0;
180 show_sevenbit_strings (struct ui_file *file, int from_tty,
181 struct cmd_list_element *c, const char *value)
183 fprintf_filtered (file, _("Printing of 8-bit characters "
184 "in strings as \\nnn is %s.\n"),
188 /* String to be printed before warning messages, if any. */
190 char *warning_pre_print = "\nwarning: ";
192 int pagination_enabled = 1;
194 show_pagination_enabled (struct ui_file *file, int from_tty,
195 struct cmd_list_element *c, const char *value)
197 fprintf_filtered (file, _("State of pagination is %s.\n"), value);
201 /* Cleanup utilities.
203 These are not defined in cleanups.c (nor declared in cleanups.h)
204 because while they use the "cleanup API" they are not part of the
208 do_freeargv (void *arg)
210 freeargv ((char **) arg);
214 make_cleanup_freeargv (char **arg)
216 return make_cleanup (do_freeargv, arg);
220 do_dyn_string_delete (void *arg)
222 dyn_string_delete ((dyn_string_t) arg);
226 make_cleanup_dyn_string_delete (dyn_string_t arg)
228 return make_cleanup (do_dyn_string_delete, arg);
232 do_bfd_close_cleanup (void *arg)
238 make_cleanup_bfd_unref (bfd *abfd)
240 return make_cleanup (do_bfd_close_cleanup, abfd);
244 do_close_cleanup (void *arg)
252 make_cleanup_close (int fd)
254 int *saved_fd = xmalloc (sizeof (fd));
257 return make_cleanup_dtor (do_close_cleanup, saved_fd, xfree);
260 /* Helper function which does the work for make_cleanup_fclose. */
263 do_fclose_cleanup (void *arg)
270 /* Return a new cleanup that closes FILE. */
273 make_cleanup_fclose (FILE *file)
275 return make_cleanup (do_fclose_cleanup, file);
278 /* Helper function which does the work for make_cleanup_obstack_free. */
281 do_obstack_free (void *arg)
283 struct obstack *ob = arg;
285 obstack_free (ob, NULL);
288 /* Return a new cleanup that frees OBSTACK. */
291 make_cleanup_obstack_free (struct obstack *obstack)
293 return make_cleanup (do_obstack_free, obstack);
297 do_ui_file_delete (void *arg)
299 ui_file_delete (arg);
303 make_cleanup_ui_file_delete (struct ui_file *arg)
305 return make_cleanup (do_ui_file_delete, arg);
308 /* Helper function for make_cleanup_ui_out_redirect_pop. */
311 do_ui_out_redirect_pop (void *arg)
313 struct ui_out *uiout = arg;
315 if (ui_out_redirect (uiout, NULL) < 0)
316 warning (_("Cannot restore redirection of the current output protocol"));
319 /* Return a new cleanup that pops the last redirection by ui_out_redirect
320 with NULL parameter. */
323 make_cleanup_ui_out_redirect_pop (struct ui_out *uiout)
325 return make_cleanup (do_ui_out_redirect_pop, uiout);
329 do_free_section_addr_info (void *arg)
331 free_section_addr_info (arg);
335 make_cleanup_free_section_addr_info (struct section_addr_info *addrs)
337 return make_cleanup (do_free_section_addr_info, addrs);
340 struct restore_integer_closure
347 restore_integer (void *p)
349 struct restore_integer_closure *closure = p;
351 *(closure->variable) = closure->value;
354 /* Remember the current value of *VARIABLE and make it restored when
355 the cleanup is run. */
358 make_cleanup_restore_integer (int *variable)
360 struct restore_integer_closure *c =
361 xmalloc (sizeof (struct restore_integer_closure));
363 c->variable = variable;
364 c->value = *variable;
366 return make_cleanup_dtor (restore_integer, (void *) c, xfree);
369 /* Remember the current value of *VARIABLE and make it restored when
370 the cleanup is run. */
373 make_cleanup_restore_uinteger (unsigned int *variable)
375 return make_cleanup_restore_integer ((int *) variable);
378 /* Helper for make_cleanup_unpush_target. */
381 do_unpush_target (void *arg)
383 struct target_ops *ops = arg;
388 /* Return a new cleanup that unpushes OPS. */
391 make_cleanup_unpush_target (struct target_ops *ops)
393 return make_cleanup (do_unpush_target, ops);
396 /* Helper for make_cleanup_htab_delete compile time checking the types. */
399 do_htab_delete_cleanup (void *htab_voidp)
401 htab_t htab = htab_voidp;
406 /* Return a new cleanup that deletes HTAB. */
409 make_cleanup_htab_delete (htab_t htab)
411 return make_cleanup (do_htab_delete_cleanup, htab);
414 struct restore_ui_file_closure
416 struct ui_file **variable;
417 struct ui_file *value;
421 do_restore_ui_file (void *p)
423 struct restore_ui_file_closure *closure = p;
425 *(closure->variable) = closure->value;
428 /* Remember the current value of *VARIABLE and make it restored when
429 the cleanup is run. */
432 make_cleanup_restore_ui_file (struct ui_file **variable)
434 struct restore_ui_file_closure *c = XNEW (struct restore_ui_file_closure);
436 c->variable = variable;
437 c->value = *variable;
439 return make_cleanup_dtor (do_restore_ui_file, (void *) c, xfree);
442 /* Helper for make_cleanup_value_free_to_mark. */
445 do_value_free_to_mark (void *value)
447 value_free_to_mark ((struct value *) value);
450 /* Free all values allocated since MARK was obtained by value_mark
451 (except for those released) when the cleanup is run. */
454 make_cleanup_value_free_to_mark (struct value *mark)
456 return make_cleanup (do_value_free_to_mark, mark);
459 /* Helper for make_cleanup_value_free. */
462 do_value_free (void *value)
470 make_cleanup_value_free (struct value *value)
472 return make_cleanup (do_value_free, value);
475 /* Helper for make_cleanup_free_so. */
478 do_free_so (void *arg)
480 struct so_list *so = arg;
485 /* Make cleanup handler calling free_so for SO. */
488 make_cleanup_free_so (struct so_list *so)
490 return make_cleanup (do_free_so, so);
493 /* Helper for make_cleanup_restore_current_language. */
496 do_restore_current_language (void *p)
498 enum language saved_lang = (uintptr_t) p;
500 set_language (saved_lang);
503 /* Remember the current value of CURRENT_LANGUAGE and make it restored when
504 the cleanup is run. */
507 make_cleanup_restore_current_language (void)
509 enum language saved_lang = current_language->la_language;
511 return make_cleanup (do_restore_current_language,
512 (void *) (uintptr_t) saved_lang);
515 /* This function is useful for cleanups.
519 old_chain = make_cleanup (free_current_contents, &foo);
521 to arrange to free the object thus allocated. */
524 free_current_contents (void *ptr)
526 void **location = ptr;
528 if (location == NULL)
529 internal_error (__FILE__, __LINE__,
530 _("free_current_contents: NULL pointer"));
531 if (*location != NULL)
540 /* Print a warning message. The first argument STRING is the warning
541 message, used as an fprintf format string, the second is the
542 va_list of arguments for that string. A warning is unfiltered (not
543 paginated) so that the user does not need to page through each
544 screen full of warnings when there are lots of them. */
547 vwarning (const char *string, va_list args)
549 if (deprecated_warning_hook)
550 (*deprecated_warning_hook) (string, args);
553 target_terminal_ours ();
554 wrap_here (""); /* Force out any buffered output. */
555 gdb_flush (gdb_stdout);
556 if (warning_pre_print)
557 fputs_unfiltered (warning_pre_print, gdb_stderr);
558 vfprintf_unfiltered (gdb_stderr, string, args);
559 fprintf_unfiltered (gdb_stderr, "\n");
564 /* Print a warning message.
565 The first argument STRING is the warning message, used as a fprintf string,
566 and the remaining args are passed as arguments to it.
567 The primary difference between warnings and errors is that a warning
568 does not force the return to command level. */
571 warning (const char *string, ...)
575 va_start (args, string);
576 vwarning (string, args);
580 /* Print an error message and return to command level.
581 The first argument STRING is the error message, used as a fprintf string,
582 and the remaining args are passed as arguments to it. */
585 verror (const char *string, va_list args)
587 throw_verror (GENERIC_ERROR, string, args);
591 error (const char *string, ...)
595 va_start (args, string);
596 throw_verror (GENERIC_ERROR, string, args);
600 /* Print an error message and quit.
601 The first argument STRING is the error message, used as a fprintf string,
602 and the remaining args are passed as arguments to it. */
605 vfatal (const char *string, va_list args)
607 throw_vfatal (string, args);
611 fatal (const char *string, ...)
615 va_start (args, string);
616 throw_vfatal (string, args);
621 error_stream (struct ui_file *stream)
623 char *message = ui_file_xstrdup (stream, NULL);
625 make_cleanup (xfree, message);
626 error (("%s"), message);
629 /* Dump core trying to increase the core soft limit to hard limit first. */
634 #ifdef HAVE_SETRLIMIT
635 struct rlimit rlim = { RLIM_INFINITY, RLIM_INFINITY };
637 setrlimit (RLIMIT_CORE, &rlim);
638 #endif /* HAVE_SETRLIMIT */
640 abort (); /* NOTE: GDB has only three calls to abort(). */
643 /* Check whether GDB will be able to dump core using the dump_core
647 can_dump_core (const char *reason)
649 #ifdef HAVE_GETRLIMIT
652 /* Be quiet and assume we can dump if an error is returned. */
653 if (getrlimit (RLIMIT_CORE, &rlim) != 0)
656 if (rlim.rlim_max == 0)
658 fprintf_unfiltered (gdb_stderr,
659 _("%s\nUnable to dump core, use `ulimit -c"
660 " unlimited' before executing GDB next time.\n"),
664 #endif /* HAVE_GETRLIMIT */
669 /* Allow the user to configure the debugger behavior with respect to
670 what to do when an internal problem is detected. */
672 const char internal_problem_ask[] = "ask";
673 const char internal_problem_yes[] = "yes";
674 const char internal_problem_no[] = "no";
675 static const char *const internal_problem_modes[] =
677 internal_problem_ask,
678 internal_problem_yes,
683 /* Print a message reporting an internal error/warning. Ask the user
684 if they want to continue, dump core, or just exit. Return
685 something to indicate a quit. */
687 struct internal_problem
690 const char *should_quit;
691 const char *should_dump_core;
694 /* Report a problem, internal to GDB, to the user. Once the problem
695 has been reported, and assuming GDB didn't quit, the caller can
696 either allow execution to resume or throw an error. */
698 static void ATTRIBUTE_PRINTF (4, 0)
699 internal_vproblem (struct internal_problem *problem,
700 const char *file, int line, const char *fmt, va_list ap)
706 struct cleanup *cleanup = make_cleanup (null_cleanup, NULL);
708 /* Don't allow infinite error/warning recursion. */
710 static char msg[] = "Recursive internal problem.\n";
719 fputs_unfiltered (msg, gdb_stderr);
720 abort (); /* NOTE: GDB has only three calls to abort(). */
723 /* Newer GLIBC versions put the warn_unused_result attribute
724 on write, but this is one of those rare cases where
725 ignoring the return value is correct. Casting to (void)
726 does not fix this problem. This is the solution suggested
727 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
728 if (write (STDERR_FILENO, msg, sizeof (msg)) != sizeof (msg))
729 abort (); /* NOTE: GDB has only three calls to abort(). */
734 /* Try to get the message out and at the start of a new line. */
735 target_terminal_ours ();
738 /* Create a string containing the full error/warning message. Need
739 to call query with this full string, as otherwize the reason
740 (error/warning) and question become separated. Format using a
741 style similar to a compiler error message. Include extra detail
742 so that the user knows that they are living on the edge. */
746 msg = xstrvprintf (fmt, ap);
747 reason = xstrprintf ("%s:%d: %s: %s\n"
748 "A problem internal to GDB has been detected,\n"
749 "further debugging may prove unreliable.",
750 file, line, problem->name, msg);
752 make_cleanup (xfree, reason);
755 if (problem->should_quit == internal_problem_ask)
757 /* Default (yes/batch case) is to quit GDB. When in batch mode
758 this lessens the likelihood of GDB going into an infinite
762 /* Emit the message and quit. */
763 fputs_unfiltered (reason, gdb_stderr);
764 fputs_unfiltered ("\n", gdb_stderr);
768 quit_p = query (_("%s\nQuit this debugging session? "), reason);
770 else if (problem->should_quit == internal_problem_yes)
772 else if (problem->should_quit == internal_problem_no)
775 internal_error (__FILE__, __LINE__, _("bad switch"));
777 if (problem->should_dump_core == internal_problem_ask)
779 if (!can_dump_core (reason))
783 /* Default (yes/batch case) is to dump core. This leaves a GDB
784 `dropping' so that it is easier to see that something went
786 dump_core_p = query (_("%s\nCreate a core file of GDB? "), reason);
789 else if (problem->should_dump_core == internal_problem_yes)
790 dump_core_p = can_dump_core (reason);
791 else if (problem->should_dump_core == internal_problem_no)
794 internal_error (__FILE__, __LINE__, _("bad switch"));
807 #ifdef HAVE_WORKING_FORK
815 do_cleanups (cleanup);
818 static struct internal_problem internal_error_problem = {
819 "internal-error", internal_problem_ask, internal_problem_ask
823 internal_verror (const char *file, int line, const char *fmt, va_list ap)
825 internal_vproblem (&internal_error_problem, file, line, fmt, ap);
826 fatal (_("Command aborted."));
830 internal_error (const char *file, int line, const char *string, ...)
834 va_start (ap, string);
835 internal_verror (file, line, string, ap);
839 static struct internal_problem internal_warning_problem = {
840 "internal-warning", internal_problem_ask, internal_problem_ask
844 internal_vwarning (const char *file, int line, const char *fmt, va_list ap)
846 internal_vproblem (&internal_warning_problem, file, line, fmt, ap);
850 internal_warning (const char *file, int line, const char *string, ...)
854 va_start (ap, string);
855 internal_vwarning (file, line, string, ap);
859 /* Dummy functions to keep add_prefix_cmd happy. */
862 set_internal_problem_cmd (char *args, int from_tty)
867 show_internal_problem_cmd (char *args, int from_tty)
871 /* When GDB reports an internal problem (error or warning) it gives
872 the user the opportunity to quit GDB and/or create a core file of
873 the current debug session. This function registers a few commands
874 that make it possible to specify that GDB should always or never
875 quit or create a core file, without asking. The commands look
878 maint set PROBLEM-NAME quit ask|yes|no
879 maint show PROBLEM-NAME quit
880 maint set PROBLEM-NAME corefile ask|yes|no
881 maint show PROBLEM-NAME corefile
883 Where PROBLEM-NAME is currently "internal-error" or
884 "internal-warning". */
887 add_internal_problem_command (struct internal_problem *problem)
889 struct cmd_list_element **set_cmd_list;
890 struct cmd_list_element **show_cmd_list;
894 set_cmd_list = xmalloc (sizeof (*set_cmd_list));
895 show_cmd_list = xmalloc (sizeof (*set_cmd_list));
896 *set_cmd_list = NULL;
897 *show_cmd_list = NULL;
899 set_doc = xstrprintf (_("Configure what GDB does when %s is detected."),
902 show_doc = xstrprintf (_("Show what GDB does when %s is detected."),
905 add_prefix_cmd ((char*) problem->name,
906 class_maintenance, set_internal_problem_cmd, set_doc,
908 concat ("maintenance set ", problem->name, " ",
910 0/*allow-unknown*/, &maintenance_set_cmdlist);
912 add_prefix_cmd ((char*) problem->name,
913 class_maintenance, show_internal_problem_cmd, show_doc,
915 concat ("maintenance show ", problem->name, " ",
917 0/*allow-unknown*/, &maintenance_show_cmdlist);
919 set_doc = xstrprintf (_("Set whether GDB should quit "
920 "when an %s is detected"),
922 show_doc = xstrprintf (_("Show whether GDB will quit "
923 "when an %s is detected"),
925 add_setshow_enum_cmd ("quit", class_maintenance,
926 internal_problem_modes,
927 &problem->should_quit,
939 set_doc = xstrprintf (_("Set whether GDB should create a core "
940 "file of GDB when %s is detected"),
942 show_doc = xstrprintf (_("Show whether GDB will create a core "
943 "file of GDB when %s is detected"),
945 add_setshow_enum_cmd ("corefile", class_maintenance,
946 internal_problem_modes,
947 &problem->should_dump_core,
960 /* Return a newly allocated string, containing the PREFIX followed
961 by the system error message for errno (separated by a colon).
963 The result must be deallocated after use. */
966 perror_string (const char *prefix)
971 err = safe_strerror (errno);
972 combined = (char *) xmalloc (strlen (err) + strlen (prefix) + 3);
973 strcpy (combined, prefix);
974 strcat (combined, ": ");
975 strcat (combined, err);
980 /* Print the system error message for errno, and also mention STRING
981 as the file name for which the error was encountered. Use ERRCODE
982 for the thrown exception. Then return to command level. */
985 throw_perror_with_name (enum errors errcode, const char *string)
989 combined = perror_string (string);
990 make_cleanup (xfree, combined);
992 /* I understand setting these is a matter of taste. Still, some people
993 may clear errno but not know about bfd_error. Doing this here is not
995 bfd_set_error (bfd_error_no_error);
998 throw_error (errcode, _("%s."), combined);
1001 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
1004 perror_with_name (const char *string)
1006 throw_perror_with_name (GENERIC_ERROR, string);
1009 /* Same as perror_with_name except that it prints a warning instead
1010 of throwing an error. */
1013 perror_warning_with_name (const char *string)
1017 combined = perror_string (string);
1018 warning (_("%s"), combined);
1022 /* Print the system error message for ERRCODE, and also mention STRING
1023 as the file name for which the error was encountered. */
1026 print_sys_errmsg (const char *string, int errcode)
1031 err = safe_strerror (errcode);
1032 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
1033 strcpy (combined, string);
1034 strcat (combined, ": ");
1035 strcat (combined, err);
1037 /* We want anything which was printed on stdout to come out first, before
1039 gdb_flush (gdb_stdout);
1040 fprintf_unfiltered (gdb_stderr, "%s.\n", combined);
1043 /* Control C eventually causes this to be called, at a convenient time. */
1049 /* No steenking SIGINT will ever be coming our way when the
1050 program is resumed. Don't lie. */
1054 /* If there is no terminal switching for this target, then we can't
1055 possibly get screwed by the lack of job control. */
1056 || current_target.to_terminal_ours == NULL)
1059 fatal ("Quit (expect signal SIGINT when the program is resumed)");
1064 /* Called when a memory allocation fails, with the number of bytes of
1065 memory requested in SIZE. */
1068 malloc_failure (long size)
1072 internal_error (__FILE__, __LINE__,
1073 _("virtual memory exhausted: can't allocate %ld bytes."),
1078 internal_error (__FILE__, __LINE__, _("virtual memory exhausted."));
1082 /* My replacement for the read system call.
1083 Used like `read' but keeps going if `read' returns too soon. */
1086 myread (int desc, char *addr, int len)
1093 val = read (desc, addr, len);
1097 return orglen - len;
1105 print_spaces (int n, struct ui_file *file)
1107 fputs_unfiltered (n_spaces (n), file);
1110 /* Print a host address. */
1113 gdb_print_host_address (const void *addr, struct ui_file *stream)
1115 fprintf_filtered (stream, "%s", host_address_to_string (addr));
1119 /* A cleanup function that calls regfree. */
1122 do_regfree_cleanup (void *r)
1127 /* Create a new cleanup that frees the compiled regular expression R. */
1130 make_regfree_cleanup (regex_t *r)
1132 return make_cleanup (do_regfree_cleanup, r);
1135 /* Return an xmalloc'd error message resulting from a regular
1136 expression compilation failure. */
1139 get_regcomp_error (int code, regex_t *rx)
1141 size_t length = regerror (code, rx, NULL, 0);
1142 char *result = xmalloc (length);
1144 regerror (code, rx, result, length);
1148 /* Compile a regexp and throw an exception on error. This returns a
1149 cleanup to free the resulting pattern on success. RX must not be
1153 compile_rx_or_error (regex_t *pattern, const char *rx, const char *message)
1157 gdb_assert (rx != NULL);
1159 code = regcomp (pattern, rx, REG_NOSUB);
1162 char *err = get_regcomp_error (code, pattern);
1164 make_cleanup (xfree, err);
1165 error (("%s: %s"), message, err);
1168 return make_regfree_cleanup (pattern);
1173 /* This function supports the query, nquery, and yquery functions.
1174 Ask user a y-or-n question and return 0 if answer is no, 1 if
1175 answer is yes, or default the answer to the specified default
1176 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1177 default answer, or '\0' for no default.
1178 CTLSTR is the control string and should end in "? ". It should
1179 not say how to answer, because we do that.
1180 ARGS are the arguments passed along with the CTLSTR argument to
1183 static int ATTRIBUTE_PRINTF (1, 0)
1184 defaulted_query (const char *ctlstr, const char defchar, va_list args)
1190 char def_answer, not_def_answer;
1191 char *y_string, *n_string, *question;
1192 /* Used to add duration we waited for user to respond to
1193 prompt_for_continue_wait_time. */
1194 struct timeval prompt_started, prompt_ended, prompt_delta;
1196 /* Set up according to which answer is the default. */
1197 if (defchar == '\0')
1201 not_def_answer = 'N';
1205 else if (defchar == 'y')
1209 not_def_answer = 'N';
1217 not_def_answer = 'Y';
1222 /* Automatically answer the default value if the user did not want
1223 prompts or the command was issued with the server prefix. */
1224 if (!confirm || server_command)
1227 /* If input isn't coming from the user directly, just say what
1228 question we're asking, and then answer the default automatically. This
1229 way, important error messages don't get lost when talking to GDB
1231 if (! input_from_terminal_p ())
1234 vfprintf_filtered (gdb_stdout, ctlstr, args);
1236 printf_filtered (_("(%s or %s) [answered %c; "
1237 "input not from terminal]\n"),
1238 y_string, n_string, def_answer);
1239 gdb_flush (gdb_stdout);
1244 if (deprecated_query_hook)
1246 return deprecated_query_hook (ctlstr, args);
1249 /* Format the question outside of the loop, to avoid reusing args. */
1250 question = xstrvprintf (ctlstr, args);
1252 /* Used for calculating time spend waiting for user. */
1253 gettimeofday (&prompt_started, NULL);
1257 wrap_here (""); /* Flush any buffered output. */
1258 gdb_flush (gdb_stdout);
1260 if (annotation_level > 1)
1261 printf_filtered (("\n\032\032pre-query\n"));
1263 fputs_filtered (question, gdb_stdout);
1264 printf_filtered (_("(%s or %s) "), y_string, n_string);
1266 if (annotation_level > 1)
1267 printf_filtered (("\n\032\032query\n"));
1270 gdb_flush (gdb_stdout);
1272 answer = fgetc (stdin);
1274 /* We expect fgetc to block until a character is read. But
1275 this may not be the case if the terminal was opened with
1276 the NONBLOCK flag. In that case, if there is nothing to
1277 read on stdin, fgetc returns EOF, but also sets the error
1278 condition flag on stdin and errno to EAGAIN. With a true
1279 EOF, stdin's error condition flag is not set.
1281 A situation where this behavior was observed is a pseudo
1283 while (answer == EOF && ferror (stdin) && errno == EAGAIN)
1285 /* Not a real EOF. Wait a little while and try again until
1286 we read something. */
1289 answer = fgetc (stdin);
1292 clearerr (stdin); /* in case of C-d */
1293 if (answer == EOF) /* C-d */
1295 printf_filtered ("EOF [assumed %c]\n", def_answer);
1299 /* Eat rest of input line, to EOF or newline. */
1303 ans2 = fgetc (stdin);
1306 while (ans2 != EOF && ans2 != '\n' && ans2 != '\r');
1310 /* Check answer. For the non-default, the user must specify
1311 the non-default explicitly. */
1312 if (answer == not_def_answer)
1314 retval = !def_value;
1317 /* Otherwise, if a default was specified, the user may either
1318 specify the required input or have it default by entering
1320 if (answer == def_answer
1321 || (defchar != '\0' &&
1322 (answer == '\n' || answer == '\r' || answer == EOF)))
1327 /* Invalid entries are not defaulted and require another selection. */
1328 printf_filtered (_("Please answer %s or %s.\n"),
1329 y_string, n_string);
1332 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1333 gettimeofday (&prompt_ended, NULL);
1334 timeval_sub (&prompt_delta, &prompt_ended, &prompt_started);
1335 timeval_add (&prompt_for_continue_wait_time,
1336 &prompt_for_continue_wait_time, &prompt_delta);
1339 if (annotation_level > 1)
1340 printf_filtered (("\n\032\032post-query\n"));
1345 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1346 answer is yes, or 0 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 nquery (const char *ctlstr, ...)
1357 va_start (args, ctlstr);
1358 ret = defaulted_query (ctlstr, 'n', args);
1363 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1364 answer is yes, or 1 if answer is defaulted.
1365 Takes three args which are given to printf to print the question.
1366 The first, a control string, should end in "? ".
1367 It should not say how to answer, because we do that. */
1370 yquery (const char *ctlstr, ...)
1375 va_start (args, ctlstr);
1376 ret = defaulted_query (ctlstr, 'y', args);
1381 /* Ask user a y-or-n question and return 1 iff answer is yes.
1382 Takes three args which are given to printf to print the question.
1383 The first, a control string, should end in "? ".
1384 It should not say how to answer, because we do that. */
1387 query (const char *ctlstr, ...)
1392 va_start (args, ctlstr);
1393 ret = defaulted_query (ctlstr, '\0', args);
1398 /* A helper for parse_escape that converts a host character to a
1399 target character. C is the host character. If conversion is
1400 possible, then the target character is stored in *TARGET_C and the
1401 function returns 1. Otherwise, the function returns 0. */
1404 host_char_to_target (struct gdbarch *gdbarch, int c, int *target_c)
1406 struct obstack host_data;
1408 struct cleanup *cleanups;
1411 obstack_init (&host_data);
1412 cleanups = make_cleanup_obstack_free (&host_data);
1414 convert_between_encodings (target_charset (gdbarch), host_charset (),
1415 (gdb_byte *) &the_char, 1, 1,
1416 &host_data, translit_none);
1418 if (obstack_object_size (&host_data) == 1)
1421 *target_c = *(char *) obstack_base (&host_data);
1424 do_cleanups (cleanups);
1428 /* Parse a C escape sequence. STRING_PTR points to a variable
1429 containing a pointer to the string to parse. That pointer
1430 should point to the character after the \. That pointer
1431 is updated past the characters we use. The value of the
1432 escape sequence is returned.
1434 A negative value means the sequence \ newline was seen,
1435 which is supposed to be equivalent to nothing at all.
1437 If \ is followed by a null character, we return a negative
1438 value and leave the string pointer pointing at the null character.
1440 If \ is followed by 000, we return 0 and leave the string pointer
1441 after the zeros. A value of 0 does not mean end of string. */
1444 parse_escape (struct gdbarch *gdbarch, const char **string_ptr)
1446 int target_char = -2; /* Initialize to avoid GCC warnings. */
1447 int c = *(*string_ptr)++;
1466 int i = host_hex_value (c);
1471 if (isdigit (c) && c != '8' && c != '9')
1475 i += host_hex_value (c);
1511 if (!host_char_to_target (gdbarch, c, &target_char))
1512 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1513 " which has no equivalent\nin the `%s' character set."),
1514 c, c, target_charset (gdbarch));
1518 /* Print the character C on STREAM as part of the contents of a literal
1519 string whose delimiter is QUOTER. Note that this routine should only
1520 be call for printing things which are independent of the language
1521 of the program being debugged. */
1524 printchar (int c, void (*do_fputs) (const char *, struct ui_file *),
1525 void (*do_fprintf) (struct ui_file *, const char *, ...)
1526 ATTRIBUTE_FPTR_PRINTF_2, struct ui_file *stream, int quoter)
1528 c &= 0xFF; /* Avoid sign bit follies */
1530 if (c < 0x20 || /* Low control chars */
1531 (c >= 0x7F && c < 0xA0) || /* DEL, High controls */
1532 (sevenbit_strings && c >= 0x80))
1533 { /* high order bit set */
1537 do_fputs ("\\n", stream);
1540 do_fputs ("\\b", stream);
1543 do_fputs ("\\t", stream);
1546 do_fputs ("\\f", stream);
1549 do_fputs ("\\r", stream);
1552 do_fputs ("\\e", stream);
1555 do_fputs ("\\a", stream);
1558 do_fprintf (stream, "\\%.3o", (unsigned int) c);
1564 if (c == '\\' || c == quoter)
1565 do_fputs ("\\", stream);
1566 do_fprintf (stream, "%c", c);
1570 /* Print the character C on STREAM as part of the contents of a
1571 literal string whose delimiter is QUOTER. Note that these routines
1572 should only be call for printing things which are independent of
1573 the language of the program being debugged. */
1576 fputstr_filtered (const char *str, int quoter, struct ui_file *stream)
1579 printchar (*str++, fputs_filtered, fprintf_filtered, stream, quoter);
1583 fputstr_unfiltered (const char *str, int quoter, struct ui_file *stream)
1586 printchar (*str++, fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1590 fputstrn_filtered (const char *str, int n, int quoter,
1591 struct ui_file *stream)
1595 for (i = 0; i < n; i++)
1596 printchar (str[i], fputs_filtered, fprintf_filtered, stream, quoter);
1600 fputstrn_unfiltered (const char *str, int n, int quoter,
1601 struct ui_file *stream)
1605 for (i = 0; i < n; i++)
1606 printchar (str[i], fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1610 /* Number of lines per page or UINT_MAX if paging is disabled. */
1611 static unsigned int lines_per_page;
1613 show_lines_per_page (struct ui_file *file, int from_tty,
1614 struct cmd_list_element *c, const char *value)
1616 fprintf_filtered (file,
1617 _("Number of lines gdb thinks are in a page is %s.\n"),
1621 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1622 static unsigned int chars_per_line;
1624 show_chars_per_line (struct ui_file *file, int from_tty,
1625 struct cmd_list_element *c, const char *value)
1627 fprintf_filtered (file,
1628 _("Number of characters gdb thinks "
1629 "are in a line is %s.\n"),
1633 /* Current count of lines printed on this page, chars on this line. */
1634 static unsigned int lines_printed, chars_printed;
1636 /* Buffer and start column of buffered text, for doing smarter word-
1637 wrapping. When someone calls wrap_here(), we start buffering output
1638 that comes through fputs_filtered(). If we see a newline, we just
1639 spit it out and forget about the wrap_here(). If we see another
1640 wrap_here(), we spit it out and remember the newer one. If we see
1641 the end of the line, we spit out a newline, the indent, and then
1642 the buffered output. */
1644 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1645 are waiting to be output (they have already been counted in chars_printed).
1646 When wrap_buffer[0] is null, the buffer is empty. */
1647 static char *wrap_buffer;
1649 /* Pointer in wrap_buffer to the next character to fill. */
1650 static char *wrap_pointer;
1652 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1654 static char *wrap_indent;
1656 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1657 is not in effect. */
1658 static int wrap_column;
1661 /* Inialize the number of lines per page and chars per line. */
1664 init_page_info (void)
1668 lines_per_page = UINT_MAX;
1669 chars_per_line = UINT_MAX;
1673 if (!tui_get_command_dimension (&chars_per_line, &lines_per_page))
1678 #if defined(__GO32__)
1679 rows = ScreenRows ();
1680 cols = ScreenCols ();
1681 lines_per_page = rows;
1682 chars_per_line = cols;
1684 /* Make sure Readline has initialized its terminal settings. */
1685 rl_reset_terminal (NULL);
1687 /* Get the screen size from Readline. */
1688 rl_get_screen_size (&rows, &cols);
1689 lines_per_page = rows;
1690 chars_per_line = cols;
1692 /* Readline should have fetched the termcap entry for us.
1693 Only try to use tgetnum function if rl_get_screen_size
1694 did not return a useful value. */
1695 if (((rows <= 0) && (tgetnum ("li") < 0))
1696 /* Also disable paging if inside EMACS. */
1697 || getenv ("EMACS"))
1699 /* The number of lines per page is not mentioned in the terminal
1700 description or EMACS evironment variable is set. This probably
1701 means that paging is not useful, so disable paging. */
1702 lines_per_page = UINT_MAX;
1705 /* If the output is not a terminal, don't paginate it. */
1706 if (!ui_file_isatty (gdb_stdout))
1707 lines_per_page = UINT_MAX;
1715 /* Helper for make_cleanup_restore_page_info. */
1718 do_restore_page_info_cleanup (void *arg)
1724 /* Provide cleanup for restoring the terminal size. */
1727 make_cleanup_restore_page_info (void)
1729 struct cleanup *back_to;
1731 back_to = make_cleanup (do_restore_page_info_cleanup, NULL);
1732 make_cleanup_restore_uinteger (&lines_per_page);
1733 make_cleanup_restore_uinteger (&chars_per_line);
1738 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1739 Provide cleanup for restoring the original state. */
1742 set_batch_flag_and_make_cleanup_restore_page_info (void)
1744 struct cleanup *back_to = make_cleanup_restore_page_info ();
1746 make_cleanup_restore_integer (&batch_flag);
1753 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1756 set_screen_size (void)
1758 int rows = lines_per_page;
1759 int cols = chars_per_line;
1767 /* Update Readline's idea of the terminal size. */
1768 rl_set_screen_size (rows, cols);
1771 /* Reinitialize WRAP_BUFFER according to the current value of
1777 if (chars_per_line == 0)
1782 wrap_buffer = (char *) xmalloc (chars_per_line + 2);
1783 wrap_buffer[0] = '\0';
1786 wrap_buffer = (char *) xrealloc (wrap_buffer, chars_per_line + 2);
1787 wrap_pointer = wrap_buffer; /* Start it at the beginning. */
1791 set_width_command (char *args, int from_tty, struct cmd_list_element *c)
1798 set_height_command (char *args, int from_tty, struct cmd_list_element *c)
1803 /* Wait, so the user can read what's on the screen. Prompt the user
1804 to continue by pressing RETURN. */
1807 prompt_for_continue (void)
1810 char cont_prompt[120];
1811 /* Used to add duration we waited for user to respond to
1812 prompt_for_continue_wait_time. */
1813 struct timeval prompt_started, prompt_ended, prompt_delta;
1815 gettimeofday (&prompt_started, NULL);
1817 if (annotation_level > 1)
1818 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1820 strcpy (cont_prompt,
1821 "---Type <return> to continue, or q <return> to quit---");
1822 if (annotation_level > 1)
1823 strcat (cont_prompt, "\n\032\032prompt-for-continue\n");
1825 /* We must do this *before* we call gdb_readline, else it will eventually
1826 call us -- thinking that we're trying to print beyond the end of the
1828 reinitialize_more_filter ();
1832 /* On a real operating system, the user can quit with SIGINT.
1835 'q' is provided on all systems so users don't have to change habits
1836 from system to system, and because telling them what to do in
1837 the prompt is more user-friendly than expecting them to think of
1839 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1840 whereas control-C to gdb_readline will cause the user to get dumped
1842 ignore = gdb_readline_wrapper (cont_prompt);
1844 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1845 gettimeofday (&prompt_ended, NULL);
1846 timeval_sub (&prompt_delta, &prompt_ended, &prompt_started);
1847 timeval_add (&prompt_for_continue_wait_time,
1848 &prompt_for_continue_wait_time, &prompt_delta);
1850 if (annotation_level > 1)
1851 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1857 while (*p == ' ' || *p == '\t')
1865 /* Now we have to do this again, so that GDB will know that it doesn't
1866 need to save the ---Type <return>--- line at the top of the screen. */
1867 reinitialize_more_filter ();
1869 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1872 /* Initalize timer to keep track of how long we waited for the user. */
1875 reset_prompt_for_continue_wait_time (void)
1877 static const struct timeval zero_timeval = { 0 };
1879 prompt_for_continue_wait_time = zero_timeval;
1882 /* Fetch the cumulative time spent in prompt_for_continue. */
1885 get_prompt_for_continue_wait_time (void)
1887 return prompt_for_continue_wait_time;
1890 /* Reinitialize filter; ie. tell it to reset to original values. */
1893 reinitialize_more_filter (void)
1899 /* Indicate that if the next sequence of characters overflows the line,
1900 a newline should be inserted here rather than when it hits the end.
1901 If INDENT is non-null, it is a string to be printed to indent the
1902 wrapped part on the next line. INDENT must remain accessible until
1903 the next call to wrap_here() or until a newline is printed through
1906 If the line is already overfull, we immediately print a newline and
1907 the indentation, and disable further wrapping.
1909 If we don't know the width of lines, but we know the page height,
1910 we must not wrap words, but should still keep track of newlines
1911 that were explicitly printed.
1913 INDENT should not contain tabs, as that will mess up the char count
1914 on the next line. FIXME.
1916 This routine is guaranteed to force out any output which has been
1917 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1918 used to force out output from the wrap_buffer. */
1921 wrap_here (char *indent)
1923 /* This should have been allocated, but be paranoid anyway. */
1925 internal_error (__FILE__, __LINE__,
1926 _("failed internal consistency check"));
1930 *wrap_pointer = '\0';
1931 fputs_unfiltered (wrap_buffer, gdb_stdout);
1933 wrap_pointer = wrap_buffer;
1934 wrap_buffer[0] = '\0';
1935 if (chars_per_line == UINT_MAX) /* No line overflow checking. */
1939 else if (chars_printed >= chars_per_line)
1941 puts_filtered ("\n");
1943 puts_filtered (indent);
1948 wrap_column = chars_printed;
1952 wrap_indent = indent;
1956 /* Print input string to gdb_stdout, filtered, with wrap,
1957 arranging strings in columns of n chars. String can be
1958 right or left justified in the column. Never prints
1959 trailing spaces. String should never be longer than
1960 width. FIXME: this could be useful for the EXAMINE
1961 command, which currently doesn't tabulate very well. */
1964 puts_filtered_tabular (char *string, int width, int right)
1970 gdb_assert (chars_per_line > 0);
1971 if (chars_per_line == UINT_MAX)
1973 fputs_filtered (string, gdb_stdout);
1974 fputs_filtered ("\n", gdb_stdout);
1978 if (((chars_printed - 1) / width + 2) * width >= chars_per_line)
1979 fputs_filtered ("\n", gdb_stdout);
1981 if (width >= chars_per_line)
1982 width = chars_per_line - 1;
1984 stringlen = strlen (string);
1986 if (chars_printed > 0)
1987 spaces = width - (chars_printed - 1) % width - 1;
1989 spaces += width - stringlen;
1991 spacebuf = alloca (spaces + 1);
1992 spacebuf[spaces] = '\0';
1994 spacebuf[spaces] = ' ';
1996 fputs_filtered (spacebuf, gdb_stdout);
1997 fputs_filtered (string, gdb_stdout);
2001 /* Ensure that whatever gets printed next, using the filtered output
2002 commands, starts at the beginning of the line. I.e. if there is
2003 any pending output for the current line, flush it and start a new
2004 line. Otherwise do nothing. */
2009 if (chars_printed > 0)
2011 puts_filtered ("\n");
2016 /* Like fputs but if FILTER is true, pause after every screenful.
2018 Regardless of FILTER can wrap at points other than the final
2019 character of a line.
2021 Unlike fputs, fputs_maybe_filtered does not return a value.
2022 It is OK for LINEBUFFER to be NULL, in which case just don't print
2025 Note that a longjmp to top level may occur in this routine (only if
2026 FILTER is true) (since prompt_for_continue may do so) so this
2027 routine should not be called when cleanups are not in place. */
2030 fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
2033 const char *lineptr;
2035 if (linebuffer == 0)
2038 /* Don't do any filtering if it is disabled. */
2039 if (stream != gdb_stdout
2040 || !pagination_enabled
2042 || (lines_per_page == UINT_MAX && chars_per_line == UINT_MAX)
2043 || top_level_interpreter () == NULL
2044 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2046 fputs_unfiltered (linebuffer, stream);
2050 /* Go through and output each character. Show line extension
2051 when this is necessary; prompt user for new page when this is
2054 lineptr = linebuffer;
2057 /* Possible new page. */
2058 if (filter && (lines_printed >= lines_per_page - 1))
2059 prompt_for_continue ();
2061 while (*lineptr && *lineptr != '\n')
2063 /* Print a single line. */
2064 if (*lineptr == '\t')
2067 *wrap_pointer++ = '\t';
2069 fputc_unfiltered ('\t', stream);
2070 /* Shifting right by 3 produces the number of tab stops
2071 we have already passed, and then adding one and
2072 shifting left 3 advances to the next tab stop. */
2073 chars_printed = ((chars_printed >> 3) + 1) << 3;
2079 *wrap_pointer++ = *lineptr;
2081 fputc_unfiltered (*lineptr, stream);
2086 if (chars_printed >= chars_per_line)
2088 unsigned int save_chars = chars_printed;
2092 /* If we aren't actually wrapping, don't output newline --
2093 if chars_per_line is right, we probably just overflowed
2094 anyway; if it's wrong, let us keep going. */
2096 fputc_unfiltered ('\n', stream);
2098 /* Possible new page. */
2099 if (lines_printed >= lines_per_page - 1)
2100 prompt_for_continue ();
2102 /* Now output indentation and wrapped string. */
2105 fputs_unfiltered (wrap_indent, stream);
2106 *wrap_pointer = '\0'; /* Null-terminate saved stuff, */
2107 fputs_unfiltered (wrap_buffer, stream); /* and eject it. */
2108 /* FIXME, this strlen is what prevents wrap_indent from
2109 containing tabs. However, if we recurse to print it
2110 and count its chars, we risk trouble if wrap_indent is
2111 longer than (the user settable) chars_per_line.
2112 Note also that this can set chars_printed > chars_per_line
2113 if we are printing a long string. */
2114 chars_printed = strlen (wrap_indent)
2115 + (save_chars - wrap_column);
2116 wrap_pointer = wrap_buffer; /* Reset buffer */
2117 wrap_buffer[0] = '\0';
2118 wrap_column = 0; /* And disable fancy wrap */
2123 if (*lineptr == '\n')
2126 wrap_here ((char *) 0); /* Spit out chars, cancel
2129 fputc_unfiltered ('\n', stream);
2136 fputs_filtered (const char *linebuffer, struct ui_file *stream)
2138 fputs_maybe_filtered (linebuffer, stream, 1);
2142 putchar_unfiltered (int c)
2146 ui_file_write (gdb_stdout, &buf, 1);
2150 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2151 May return nonlocally. */
2154 putchar_filtered (int c)
2156 return fputc_filtered (c, gdb_stdout);
2160 fputc_unfiltered (int c, struct ui_file *stream)
2164 ui_file_write (stream, &buf, 1);
2169 fputc_filtered (int c, struct ui_file *stream)
2175 fputs_filtered (buf, stream);
2179 /* puts_debug is like fputs_unfiltered, except it prints special
2180 characters in printable fashion. */
2183 puts_debug (char *prefix, char *string, char *suffix)
2187 /* Print prefix and suffix after each line. */
2188 static int new_line = 1;
2189 static int return_p = 0;
2190 static char *prev_prefix = "";
2191 static char *prev_suffix = "";
2193 if (*string == '\n')
2196 /* If the prefix is changing, print the previous suffix, a new line,
2197 and the new prefix. */
2198 if ((return_p || (strcmp (prev_prefix, prefix) != 0)) && !new_line)
2200 fputs_unfiltered (prev_suffix, gdb_stdlog);
2201 fputs_unfiltered ("\n", gdb_stdlog);
2202 fputs_unfiltered (prefix, gdb_stdlog);
2205 /* Print prefix if we printed a newline during the previous call. */
2209 fputs_unfiltered (prefix, gdb_stdlog);
2212 prev_prefix = prefix;
2213 prev_suffix = suffix;
2215 /* Output characters in a printable format. */
2216 while ((ch = *string++) != '\0')
2222 fputc_unfiltered (ch, gdb_stdlog);
2225 fprintf_unfiltered (gdb_stdlog, "\\x%02x", ch & 0xff);
2229 fputs_unfiltered ("\\\\", gdb_stdlog);
2232 fputs_unfiltered ("\\b", gdb_stdlog);
2235 fputs_unfiltered ("\\f", gdb_stdlog);
2239 fputs_unfiltered ("\\n", gdb_stdlog);
2242 fputs_unfiltered ("\\r", gdb_stdlog);
2245 fputs_unfiltered ("\\t", gdb_stdlog);
2248 fputs_unfiltered ("\\v", gdb_stdlog);
2252 return_p = ch == '\r';
2255 /* Print suffix if we printed a newline. */
2258 fputs_unfiltered (suffix, gdb_stdlog);
2259 fputs_unfiltered ("\n", gdb_stdlog);
2264 /* Print a variable number of ARGS using format FORMAT. If this
2265 information is going to put the amount written (since the last call
2266 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2267 call prompt_for_continue to get the users permision to continue.
2269 Unlike fprintf, this function does not return a value.
2271 We implement three variants, vfprintf (takes a vararg list and stream),
2272 fprintf (takes a stream to write on), and printf (the usual).
2274 Note also that a longjmp to top level may occur in this routine
2275 (since prompt_for_continue may do so) so this routine should not be
2276 called when cleanups are not in place. */
2279 vfprintf_maybe_filtered (struct ui_file *stream, const char *format,
2280 va_list args, int filter)
2283 struct cleanup *old_cleanups;
2285 linebuffer = xstrvprintf (format, args);
2286 old_cleanups = make_cleanup (xfree, linebuffer);
2287 fputs_maybe_filtered (linebuffer, stream, filter);
2288 do_cleanups (old_cleanups);
2293 vfprintf_filtered (struct ui_file *stream, const char *format, va_list args)
2295 vfprintf_maybe_filtered (stream, format, args, 1);
2299 vfprintf_unfiltered (struct ui_file *stream, const char *format, va_list args)
2302 struct cleanup *old_cleanups;
2304 linebuffer = xstrvprintf (format, args);
2305 old_cleanups = make_cleanup (xfree, linebuffer);
2306 if (debug_timestamp && stream == gdb_stdlog)
2312 gettimeofday (&tm, NULL);
2314 len = strlen (linebuffer);
2315 need_nl = (len > 0 && linebuffer[len - 1] != '\n');
2317 timestamp = xstrprintf ("%ld:%ld %s%s",
2318 (long) tm.tv_sec, (long) tm.tv_usec,
2320 need_nl ? "\n": "");
2321 make_cleanup (xfree, timestamp);
2322 fputs_unfiltered (timestamp, stream);
2325 fputs_unfiltered (linebuffer, stream);
2326 do_cleanups (old_cleanups);
2330 vprintf_filtered (const char *format, va_list args)
2332 vfprintf_maybe_filtered (gdb_stdout, format, args, 1);
2336 vprintf_unfiltered (const char *format, va_list args)
2338 vfprintf_unfiltered (gdb_stdout, format, args);
2342 fprintf_filtered (struct ui_file *stream, const char *format, ...)
2346 va_start (args, format);
2347 vfprintf_filtered (stream, format, args);
2352 fprintf_unfiltered (struct ui_file *stream, const char *format, ...)
2356 va_start (args, format);
2357 vfprintf_unfiltered (stream, format, args);
2361 /* Like fprintf_filtered, but prints its result indented.
2362 Called as fprintfi_filtered (spaces, stream, format, ...); */
2365 fprintfi_filtered (int spaces, struct ui_file *stream, const char *format,
2370 va_start (args, format);
2371 print_spaces_filtered (spaces, stream);
2373 vfprintf_filtered (stream, format, args);
2379 printf_filtered (const char *format, ...)
2383 va_start (args, format);
2384 vfprintf_filtered (gdb_stdout, format, args);
2390 printf_unfiltered (const char *format, ...)
2394 va_start (args, format);
2395 vfprintf_unfiltered (gdb_stdout, format, args);
2399 /* Like printf_filtered, but prints it's result indented.
2400 Called as printfi_filtered (spaces, format, ...); */
2403 printfi_filtered (int spaces, const char *format, ...)
2407 va_start (args, format);
2408 print_spaces_filtered (spaces, gdb_stdout);
2409 vfprintf_filtered (gdb_stdout, format, args);
2413 /* Easy -- but watch out!
2415 This routine is *not* a replacement for puts()! puts() appends a newline.
2416 This one doesn't, and had better not! */
2419 puts_filtered (const char *string)
2421 fputs_filtered (string, gdb_stdout);
2425 puts_unfiltered (const char *string)
2427 fputs_unfiltered (string, gdb_stdout);
2430 /* Return a pointer to N spaces and a null. The pointer is good
2431 until the next call to here. */
2436 static char *spaces = 0;
2437 static int max_spaces = -1;
2443 spaces = (char *) xmalloc (n + 1);
2444 for (t = spaces + n; t != spaces;)
2450 return spaces + max_spaces - n;
2453 /* Print N spaces. */
2455 print_spaces_filtered (int n, struct ui_file *stream)
2457 fputs_filtered (n_spaces (n), stream);
2460 /* C++/ObjC demangler stuff. */
2462 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2463 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2464 If the name is not mangled, or the language for the name is unknown, or
2465 demangling is off, the name is printed in its "raw" form. */
2468 fprintf_symbol_filtered (struct ui_file *stream, const char *name,
2469 enum language lang, int arg_mode)
2475 /* If user wants to see raw output, no problem. */
2478 fputs_filtered (name, stream);
2482 demangled = language_demangle (language_def (lang), name, arg_mode);
2483 fputs_filtered (demangled ? demangled : name, stream);
2484 if (demangled != NULL)
2492 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2493 differences in whitespace. Returns 0 if they match, non-zero if they
2494 don't (slightly different than strcmp()'s range of return values).
2496 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2497 This "feature" is useful when searching for matching C++ function names
2498 (such as if the user types 'break FOO', where FOO is a mangled C++
2502 strcmp_iw (const char *string1, const char *string2)
2504 while ((*string1 != '\0') && (*string2 != '\0'))
2506 while (isspace (*string1))
2510 while (isspace (*string2))
2514 if (case_sensitivity == case_sensitive_on && *string1 != *string2)
2516 if (case_sensitivity == case_sensitive_off
2517 && (tolower ((unsigned char) *string1)
2518 != tolower ((unsigned char) *string2)))
2520 if (*string1 != '\0')
2526 return (*string1 != '\0' && *string1 != '(') || (*string2 != '\0');
2529 /* This is like strcmp except that it ignores whitespace and treats
2530 '(' as the first non-NULL character in terms of ordering. Like
2531 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2532 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2533 according to that ordering.
2535 If a list is sorted according to this function and if you want to
2536 find names in the list that match some fixed NAME according to
2537 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2538 where this function would put NAME.
2540 This function must be neutral to the CASE_SENSITIVITY setting as the user
2541 may choose it during later lookup. Therefore this function always sorts
2542 primarily case-insensitively and secondarily case-sensitively.
2544 Here are some examples of why using strcmp to sort is a bad idea:
2548 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2549 we try to do a search for "foo<char*>", strcmp will locate this
2550 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2551 will start looking at strings beginning with "goo", and will never
2552 see the correct match of "foo<char *>".
2554 Parenthesis example:
2556 In practice, this is less like to be an issue, but I'll give it a
2557 shot. Let's assume that '$' is a legitimate character to occur in
2558 symbols. (Which may well even be the case on some systems.) Then
2559 say that the partial symbol table contains "foo$" and "foo(int)".
2560 strcmp will put them in this order, since '$' < '('. Now, if the
2561 user searches for "foo", then strcmp will sort "foo" before "foo$".
2562 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2563 "foo") is false, so it won't proceed to the actual match of
2564 "foo(int)" with "foo". */
2567 strcmp_iw_ordered (const char *string1, const char *string2)
2569 const char *saved_string1 = string1, *saved_string2 = string2;
2570 enum case_sensitivity case_pass = case_sensitive_off;
2574 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2575 Provide stub characters if we are already at the end of one of the
2577 char c1 = 'X', c2 = 'X';
2579 while (*string1 != '\0' && *string2 != '\0')
2581 while (isspace (*string1))
2583 while (isspace (*string2))
2588 case case_sensitive_off:
2589 c1 = tolower ((unsigned char) *string1);
2590 c2 = tolower ((unsigned char) *string2);
2592 case case_sensitive_on:
2600 if (*string1 != '\0')
2609 /* Characters are non-equal unless they're both '\0'; we want to
2610 make sure we get the comparison right according to our
2611 comparison in the cases where one of them is '\0' or '('. */
2613 if (*string2 == '\0')
2618 if (*string2 == '\0')
2623 if (*string2 == '\0' || *string2 == '(')
2632 if (case_pass == case_sensitive_on)
2635 /* Otherwise the strings were equal in case insensitive way, make
2636 a more fine grained comparison in a case sensitive way. */
2638 case_pass = case_sensitive_on;
2639 string1 = saved_string1;
2640 string2 = saved_string2;
2644 /* A simple comparison function with opposite semantics to strcmp. */
2647 streq (const char *lhs, const char *rhs)
2649 return !strcmp (lhs, rhs);
2655 ** Answer whether string_to_compare is a full or partial match to
2656 ** template_string. The partial match must be in sequence starting
2660 subset_compare (char *string_to_compare, char *template_string)
2664 if (template_string != (char *) NULL && string_to_compare != (char *) NULL
2665 && strlen (string_to_compare) <= strlen (template_string))
2668 (template_string, string_to_compare, strlen (string_to_compare)) == 0);
2675 pagination_on_command (char *arg, int from_tty)
2677 pagination_enabled = 1;
2681 pagination_off_command (char *arg, int from_tty)
2683 pagination_enabled = 0;
2687 show_debug_timestamp (struct ui_file *file, int from_tty,
2688 struct cmd_list_element *c, const char *value)
2690 fprintf_filtered (file, _("Timestamping debugging messages is %s.\n"),
2696 initialize_utils (void)
2698 add_setshow_uinteger_cmd ("width", class_support, &chars_per_line, _("\
2699 Set number of characters where GDB should wrap lines of its output."), _("\
2700 Show number of characters where GDB should wrap lines of its output."), _("\
2701 This affects where GDB wraps its output to fit the screen width.\n\
2702 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2704 show_chars_per_line,
2705 &setlist, &showlist);
2707 add_setshow_uinteger_cmd ("height", class_support, &lines_per_page, _("\
2708 Set number of lines in a page for GDB output pagination."), _("\
2709 Show number of lines in a page for GDB output pagination."), _("\
2710 This affects the number of lines after which GDB will pause\n\
2711 its output and ask you whether to continue.\n\
2712 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2714 show_lines_per_page,
2715 &setlist, &showlist);
2719 add_setshow_boolean_cmd ("pagination", class_support,
2720 &pagination_enabled, _("\
2721 Set state of GDB output pagination."), _("\
2722 Show state of GDB output pagination."), _("\
2723 When pagination is ON, GDB pauses at end of each screenful of\n\
2724 its output and asks you whether to continue.\n\
2725 Turning pagination off is an alternative to \"set height unlimited\"."),
2727 show_pagination_enabled,
2728 &setlist, &showlist);
2732 add_com ("am", class_support, pagination_on_command,
2733 _("Enable pagination"));
2734 add_com ("sm", class_support, pagination_off_command,
2735 _("Disable pagination"));
2738 add_setshow_boolean_cmd ("sevenbit-strings", class_support,
2739 &sevenbit_strings, _("\
2740 Set printing of 8-bit characters in strings as \\nnn."), _("\
2741 Show printing of 8-bit characters in strings as \\nnn."), NULL,
2743 show_sevenbit_strings,
2744 &setprintlist, &showprintlist);
2746 add_setshow_boolean_cmd ("timestamp", class_maintenance,
2747 &debug_timestamp, _("\
2748 Set timestamping of debugging messages."), _("\
2749 Show timestamping of debugging messages."), _("\
2750 When set, debugging messages will be marked with seconds and microseconds."),
2752 show_debug_timestamp,
2753 &setdebuglist, &showdebuglist);
2756 /* Print routines to handle variable size regs, etc. */
2757 /* Temporary storage using circular buffer. */
2763 static char buf[NUMCELLS][CELLSIZE];
2764 static int cell = 0;
2766 if (++cell >= NUMCELLS)
2772 paddress (struct gdbarch *gdbarch, CORE_ADDR addr)
2774 /* Truncate address to the size of a target address, avoiding shifts
2775 larger or equal than the width of a CORE_ADDR. The local
2776 variable ADDR_BIT stops the compiler reporting a shift overflow
2777 when it won't occur. */
2778 /* NOTE: This assumes that the significant address information is
2779 kept in the least significant bits of ADDR - the upper bits were
2780 either zero or sign extended. Should gdbarch_address_to_pointer or
2781 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2783 int addr_bit = gdbarch_addr_bit (gdbarch);
2785 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2786 addr &= ((CORE_ADDR) 1 << addr_bit) - 1;
2787 return hex_string (addr);
2790 /* This function is described in "defs.h". */
2793 print_core_address (struct gdbarch *gdbarch, CORE_ADDR address)
2795 int addr_bit = gdbarch_addr_bit (gdbarch);
2797 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2798 address &= ((CORE_ADDR) 1 << addr_bit) - 1;
2800 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2801 that returns the language localized string formatted to a width
2802 based on gdbarch_addr_bit. */
2804 return hex_string_custom (address, 8);
2806 return hex_string_custom (address, 16);
2809 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2812 core_addr_hash (const void *ap)
2814 const CORE_ADDR *addrp = ap;
2819 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2822 core_addr_eq (const void *ap, const void *bp)
2824 const CORE_ADDR *addr_ap = ap;
2825 const CORE_ADDR *addr_bp = bp;
2827 return *addr_ap == *addr_bp;
2831 decimal2str (char *sign, ULONGEST addr, int width)
2833 /* Steal code from valprint.c:print_decimal(). Should this worry
2834 about the real size of addr as the above does? */
2835 unsigned long temp[3];
2836 char *str = get_cell ();
2841 temp[i] = addr % (1000 * 1000 * 1000);
2842 addr /= (1000 * 1000 * 1000);
2846 while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0])));
2855 xsnprintf (str, CELLSIZE, "%s%0*lu", sign, width, temp[0]);
2858 xsnprintf (str, CELLSIZE, "%s%0*lu%09lu", sign, width,
2862 xsnprintf (str, CELLSIZE, "%s%0*lu%09lu%09lu", sign, width,
2863 temp[2], temp[1], temp[0]);
2866 internal_error (__FILE__, __LINE__,
2867 _("failed internal consistency check"));
2874 octal2str (ULONGEST addr, int width)
2876 unsigned long temp[3];
2877 char *str = get_cell ();
2882 temp[i] = addr % (0100000 * 0100000);
2883 addr /= (0100000 * 0100000);
2887 while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0])));
2897 xsnprintf (str, CELLSIZE, "%*o", width, 0);
2899 xsnprintf (str, CELLSIZE, "0%0*lo", width, temp[0]);
2902 xsnprintf (str, CELLSIZE, "0%0*lo%010lo", width, temp[1], temp[0]);
2905 xsnprintf (str, CELLSIZE, "0%0*lo%010lo%010lo", width,
2906 temp[2], temp[1], temp[0]);
2909 internal_error (__FILE__, __LINE__,
2910 _("failed internal consistency check"));
2917 pulongest (ULONGEST u)
2919 return decimal2str ("", u, 0);
2923 plongest (LONGEST l)
2926 return decimal2str ("-", -l, 0);
2928 return decimal2str ("", l, 0);
2931 /* Eliminate warning from compiler on 32-bit systems. */
2932 static int thirty_two = 32;
2935 phex (ULONGEST l, int sizeof_l)
2943 xsnprintf (str, CELLSIZE, "%08lx%08lx",
2944 (unsigned long) (l >> thirty_two),
2945 (unsigned long) (l & 0xffffffff));
2949 xsnprintf (str, CELLSIZE, "%08lx", (unsigned long) l);
2953 xsnprintf (str, CELLSIZE, "%04x", (unsigned short) (l & 0xffff));
2956 str = phex (l, sizeof (l));
2964 phex_nz (ULONGEST l, int sizeof_l)
2972 unsigned long high = (unsigned long) (l >> thirty_two);
2976 xsnprintf (str, CELLSIZE, "%lx",
2977 (unsigned long) (l & 0xffffffff));
2979 xsnprintf (str, CELLSIZE, "%lx%08lx", high,
2980 (unsigned long) (l & 0xffffffff));
2985 xsnprintf (str, CELLSIZE, "%lx", (unsigned long) l);
2989 xsnprintf (str, CELLSIZE, "%x", (unsigned short) (l & 0xffff));
2992 str = phex_nz (l, sizeof (l));
2999 /* Converts a LONGEST to a C-format hexadecimal literal and stores it
3000 in a static string. Returns a pointer to this string. */
3002 hex_string (LONGEST num)
3004 char *result = get_cell ();
3006 xsnprintf (result, CELLSIZE, "0x%s", phex_nz (num, sizeof (num)));
3010 /* Converts a LONGEST number to a C-format hexadecimal literal and
3011 stores it in a static string. Returns a pointer to this string
3012 that is valid until the next call. The number is padded on the
3013 left with 0s to at least WIDTH characters. */
3015 hex_string_custom (LONGEST num, int width)
3017 char *result = get_cell ();
3018 char *result_end = result + CELLSIZE - 1;
3019 const char *hex = phex_nz (num, sizeof (num));
3020 int hex_len = strlen (hex);
3022 if (hex_len > width)
3024 if (width + 2 >= CELLSIZE)
3025 internal_error (__FILE__, __LINE__, _("\
3026 hex_string_custom: insufficient space to store result"));
3028 strcpy (result_end - width - 2, "0x");
3029 memset (result_end - width, '0', width);
3030 strcpy (result_end - hex_len, hex);
3031 return result_end - width - 2;
3034 /* Convert VAL to a numeral in the given radix. For
3035 * radix 10, IS_SIGNED may be true, indicating a signed quantity;
3036 * otherwise VAL is interpreted as unsigned. If WIDTH is supplied,
3037 * it is the minimum width (0-padded if needed). USE_C_FORMAT means
3038 * to use C format in all cases. If it is false, then 'x'
3039 * and 'o' formats do not include a prefix (0x or leading 0). */
3042 int_string (LONGEST val, int radix, int is_signed, int width,
3052 result = hex_string (val);
3054 result = hex_string_custom (val, width);
3061 if (is_signed && val < 0)
3062 return decimal2str ("-", -val, width);
3064 return decimal2str ("", val, width);
3068 char *result = octal2str (val, width);
3070 if (use_c_format || val == 0)
3076 internal_error (__FILE__, __LINE__,
3077 _("failed internal consistency check"));
3081 /* Convert a CORE_ADDR into a string. */
3083 core_addr_to_string (const CORE_ADDR addr)
3085 char *str = get_cell ();
3088 strcat (str, phex (addr, sizeof (addr)));
3093 core_addr_to_string_nz (const CORE_ADDR addr)
3095 char *str = get_cell ();
3098 strcat (str, phex_nz (addr, sizeof (addr)));
3102 /* Convert a string back into a CORE_ADDR. */
3104 string_to_core_addr (const char *my_string)
3108 if (my_string[0] == '0' && tolower (my_string[1]) == 'x')
3110 /* Assume that it is in hex. */
3113 for (i = 2; my_string[i] != '\0'; i++)
3115 if (isdigit (my_string[i]))
3116 addr = (my_string[i] - '0') + (addr * 16);
3117 else if (isxdigit (my_string[i]))
3118 addr = (tolower (my_string[i]) - 'a' + 0xa) + (addr * 16);
3120 error (_("invalid hex \"%s\""), my_string);
3125 /* Assume that it is in decimal. */
3128 for (i = 0; my_string[i] != '\0'; i++)
3130 if (isdigit (my_string[i]))
3131 addr = (my_string[i] - '0') + (addr * 10);
3133 error (_("invalid decimal \"%s\""), my_string);
3141 host_address_to_string (const void *addr)
3143 char *str = get_cell ();
3145 xsnprintf (str, CELLSIZE, "0x%s", phex_nz ((uintptr_t) addr, sizeof (addr)));
3150 gdb_realpath (const char *filename)
3152 /* Method 1: The system has a compile time upper bound on a filename
3153 path. Use that and realpath() to canonicalize the name. This is
3154 the most common case. Note that, if there isn't a compile time
3155 upper bound, you want to avoid realpath() at all costs. */
3156 #if defined (HAVE_REALPATH) && defined (PATH_MAX)
3159 const char *rp = realpath (filename, buf);
3163 return xstrdup (rp);
3165 #endif /* HAVE_REALPATH */
3167 /* Method 2: The host system (i.e., GNU) has the function
3168 canonicalize_file_name() which malloc's a chunk of memory and
3169 returns that, use that. */
3170 #if defined(HAVE_CANONICALIZE_FILE_NAME)
3172 char *rp = canonicalize_file_name (filename);
3175 return xstrdup (filename);
3181 /* FIXME: cagney/2002-11-13:
3183 Method 2a: Use realpath() with a NULL buffer. Some systems, due
3184 to the problems described in method 3, have modified their
3185 realpath() implementation so that it will allocate a buffer when
3186 NULL is passed in. Before this can be used, though, some sort of
3187 configure time test would need to be added. Otherwize the code
3188 will likely core dump. */
3190 /* Method 3: Now we're getting desperate! The system doesn't have a
3191 compile time buffer size and no alternative function. Query the
3192 OS, using pathconf(), for the buffer limit. Care is needed
3193 though, some systems do not limit PATH_MAX (return -1 for
3194 pathconf()) making it impossible to pass a correctly sized buffer
3195 to realpath() (it could always overflow). On those systems, we
3197 #if defined (HAVE_REALPATH) && defined (_PC_PATH_MAX) && defined(HAVE_ALLOCA)
3199 /* Find out the max path size. */
3200 long path_max = pathconf ("/", _PC_PATH_MAX);
3204 /* PATH_MAX is bounded. */
3205 char *buf = alloca (path_max);
3206 char *rp = realpath (filename, buf);
3208 return xstrdup (rp ? rp : filename);
3213 /* The MS Windows method. If we don't have realpath, we assume we
3214 don't have symlinks and just canonicalize to a Windows absolute
3215 path. GetFullPath converts ../ and ./ in relative paths to
3216 absolute paths, filling in current drive if one is not given
3217 or using the current directory of a specified drive (eg, "E:foo").
3218 It also converts all forward slashes to back slashes. */
3219 /* The file system is case-insensitive but case-preserving.
3220 So we do not lowercase the path. Otherwise, we might not
3221 be able to display the original casing in a given path. */
3222 #if defined (_WIN32)
3225 DWORD len = GetFullPathName (filename, MAX_PATH, buf, NULL);
3227 if (len > 0 && len < MAX_PATH)
3228 return xstrdup (buf);
3232 /* This system is a lost cause, just dup the buffer. */
3233 return xstrdup (filename);
3237 align_up (ULONGEST v, int n)
3239 /* Check that N is really a power of two. */
3240 gdb_assert (n && (n & (n-1)) == 0);
3241 return (v + n - 1) & -n;
3245 align_down (ULONGEST v, int n)
3247 /* Check that N is really a power of two. */
3248 gdb_assert (n && (n & (n-1)) == 0);
3255 gdb_sign_extend (LONGEST value, int bit)
3257 gdb_assert (bit >= 1 && bit <= 8 * sizeof (LONGEST));
3259 if (((value >> (bit - 1)) & 1) != 0)
3261 LONGEST signbit = ((LONGEST) 1) << (bit - 1);
3263 value = (value ^ signbit) - signbit;
3269 /* Allocation function for the libiberty hash table which uses an
3270 obstack. The obstack is passed as DATA. */
3273 hashtab_obstack_allocate (void *data, size_t size, size_t count)
3275 unsigned int total = size * count;
3276 void *ptr = obstack_alloc ((struct obstack *) data, total);
3278 memset (ptr, 0, total);
3282 /* Trivial deallocation function for the libiberty splay tree and hash
3283 table - don't deallocate anything. Rely on later deletion of the
3284 obstack. DATA will be the obstack, although it is not needed
3288 dummy_obstack_deallocate (void *object, void *data)
3293 /* The bit offset of the highest byte in a ULONGEST, for overflow
3296 #define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT)
3298 /* True (non-zero) iff DIGIT is a valid digit in radix BASE,
3299 where 2 <= BASE <= 36. */
3302 is_digit_in_base (unsigned char digit, int base)
3304 if (!isalnum (digit))
3307 return (isdigit (digit) && digit < base + '0');
3309 return (isdigit (digit) || tolower (digit) < base - 10 + 'a');
3313 digit_to_int (unsigned char c)
3318 return tolower (c) - 'a' + 10;
3321 /* As for strtoul, but for ULONGEST results. */
3324 strtoulst (const char *num, const char **trailer, int base)
3326 unsigned int high_part;
3331 /* Skip leading whitespace. */
3332 while (isspace (num[i]))
3335 /* Handle prefixes. */
3338 else if (num[i] == '-')
3344 if (base == 0 || base == 16)
3346 if (num[i] == '0' && (num[i + 1] == 'x' || num[i + 1] == 'X'))
3354 if (base == 0 && num[i] == '0')
3360 if (base < 2 || base > 36)
3366 result = high_part = 0;
3367 for (; is_digit_in_base (num[i], base); i += 1)
3369 result = result * base + digit_to_int (num[i]);
3370 high_part = high_part * base + (unsigned int) (result >> HIGH_BYTE_POSN);
3371 result &= ((ULONGEST) 1 << HIGH_BYTE_POSN) - 1;
3372 if (high_part > 0xff)
3375 result = ~ (ULONGEST) 0;
3382 if (trailer != NULL)
3385 result = result + ((ULONGEST) high_part << HIGH_BYTE_POSN);
3392 /* Simple, portable version of dirname that does not modify its
3396 ldirname (const char *filename)
3398 const char *base = lbasename (filename);
3401 while (base > filename && IS_DIR_SEPARATOR (base[-1]))
3404 if (base == filename)
3407 dirname = xmalloc (base - filename + 2);
3408 memcpy (dirname, filename, base - filename);
3410 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3411 create "d:./bar" later instead of the (different) "d:/bar". */
3412 if (base - filename == 2 && IS_ABSOLUTE_PATH (base)
3413 && !IS_DIR_SEPARATOR (filename[0]))
3414 dirname[base++ - filename] = '.';
3416 dirname[base - filename] = '\0';
3420 /* Call libiberty's buildargv, and return the result.
3421 If buildargv fails due to out-of-memory, call nomem.
3422 Therefore, the returned value is guaranteed to be non-NULL,
3423 unless the parameter itself is NULL. */
3426 gdb_buildargv (const char *s)
3428 char **argv = buildargv (s);
3430 if (s != NULL && argv == NULL)
3436 compare_positive_ints (const void *ap, const void *bp)
3438 /* Because we know we're comparing two ints which are positive,
3439 there's no danger of overflow here. */
3440 return * (int *) ap - * (int *) bp;
3443 /* String compare function for qsort. */
3446 compare_strings (const void *arg1, const void *arg2)
3448 const char **s1 = (const char **) arg1;
3449 const char **s2 = (const char **) arg2;
3451 return strcmp (*s1, *s2);
3454 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3455 #define AMBIGUOUS_MESS2 \
3456 ".\nUse \"set gnutarget format-name\" to specify the format."
3459 gdb_bfd_errmsg (bfd_error_type error_tag, char **matching)
3465 /* Check if errmsg just need simple return. */
3466 if (error_tag != bfd_error_file_ambiguously_recognized || matching == NULL)
3467 return bfd_errmsg (error_tag);
3469 ret_len = strlen (bfd_errmsg (error_tag)) + strlen (AMBIGUOUS_MESS1)
3470 + strlen (AMBIGUOUS_MESS2);
3471 for (p = matching; *p; p++)
3472 ret_len += strlen (*p) + 1;
3473 ret = xmalloc (ret_len + 1);
3475 make_cleanup (xfree, ret);
3477 strcpy (retp, bfd_errmsg (error_tag));
3478 retp += strlen (retp);
3480 strcpy (retp, AMBIGUOUS_MESS1);
3481 retp += strlen (retp);
3483 for (p = matching; *p; p++)
3485 sprintf (retp, " %s", *p);
3486 retp += strlen (retp);
3490 strcpy (retp, AMBIGUOUS_MESS2);
3495 /* Return ARGS parsed as a valid pid, or throw an error. */
3498 parse_pid_to_attach (char *args)
3504 error_no_arg (_("process-id to attach"));
3507 pid = strtoul (args, &dummy, 0);
3508 /* Some targets don't set errno on errors, grrr! */
3509 if ((pid == 0 && dummy == args) || dummy != &args[strlen (args)])
3510 error (_("Illegal process-id: %s."), args);
3515 /* Helper for make_bpstat_clear_actions_cleanup. */
3518 do_bpstat_clear_actions_cleanup (void *unused)
3520 bpstat_clear_actions ();
3523 /* Call bpstat_clear_actions for the case an exception is throw. You should
3524 discard_cleanups if no exception is caught. */
3527 make_bpstat_clear_actions_cleanup (void)
3529 return make_cleanup (do_bpstat_clear_actions_cleanup, NULL);
3532 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3533 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3534 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3537 producer_is_gcc_ge_4 (const char *producer)
3542 if (producer == NULL)
3544 /* For unknown compilers expect their behavior is not compliant. For GCC
3545 this case can also happen for -gdwarf-4 type units supported since
3551 /* Skip any identifier after "GNU " - such as "C++" or "Java". */
3553 if (strncmp (producer, "GNU ", strlen ("GNU ")) != 0)
3555 /* For non-GCC compilers expect their behavior is not compliant. */
3559 cs = &producer[strlen ("GNU ")];
3560 while (*cs && !isdigit (*cs))
3562 if (sscanf (cs, "%d.%d", &major, &minor) != 2)
3564 /* Not recognized as GCC. */
3576 /* Helper for make_cleanup_free_char_ptr_vec. */
3579 do_free_char_ptr_vec (void *arg)
3581 VEC (char_ptr) *char_ptr_vec = arg;
3583 free_char_ptr_vec (char_ptr_vec);
3586 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3587 final VEC_free for CHAR_PTR_VEC itself.
3589 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3590 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3591 this function does not (cannot) clear the pointer. */
3594 make_cleanup_free_char_ptr_vec (VEC (char_ptr) *char_ptr_vec)
3596 return make_cleanup (do_free_char_ptr_vec, char_ptr_vec);
3599 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3600 must come from xrealloc-compatible allocator and it may be updated. FROM
3601 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3602 located at the start or end of *STRINGP. */
3605 substitute_path_component (char **stringp, const char *from, const char *to)
3607 char *string = *stringp, *s;
3608 const size_t from_len = strlen (from);
3609 const size_t to_len = strlen (to);
3613 s = strstr (s, from);
3617 if ((s == string || IS_DIR_SEPARATOR (s[-1])
3618 || s[-1] == DIRNAME_SEPARATOR)
3619 && (s[from_len] == '\0' || IS_DIR_SEPARATOR (s[from_len])
3620 || s[from_len] == DIRNAME_SEPARATOR))
3624 string_new = xrealloc (string, (strlen (string) + to_len + 1));
3626 /* Relocate the current S pointer. */
3627 s = s - string + string_new;
3628 string = string_new;
3630 /* Replace from by to. */
3631 memmove (&s[to_len], &s[from_len], strlen (&s[from_len]) + 1);
3632 memcpy (s, to, to_len);
3647 /* SIGALRM handler for waitpid_with_timeout. */
3650 sigalrm_handler (int signo)
3652 /* Nothing to do. */
3657 /* Wrapper to wait for child PID to die with TIMEOUT.
3658 TIMEOUT is the time to stop waiting in seconds.
3659 If TIMEOUT is zero, pass WNOHANG to waitpid.
3660 Returns PID if it was successfully waited for, otherwise -1.
3662 Timeouts are currently implemented with alarm and SIGALRM.
3663 If the host does not support them, this waits "forever".
3664 It would be odd though for a host to have waitpid and not SIGALRM. */
3667 wait_to_die_with_timeout (pid_t pid, int *status, int timeout)
3669 pid_t waitpid_result;
3671 gdb_assert (pid > 0);
3672 gdb_assert (timeout >= 0);
3677 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3678 struct sigaction sa, old_sa;
3680 sa.sa_handler = sigalrm_handler;
3681 sigemptyset (&sa.sa_mask);
3683 sigaction (SIGALRM, &sa, &old_sa);
3687 ofunc = (void (*)()) signal (SIGALRM, sigalrm_handler);
3693 waitpid_result = waitpid (pid, status, 0);
3697 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3698 sigaction (SIGALRM, &old_sa, NULL);
3700 signal (SIGALRM, ofunc);
3705 waitpid_result = waitpid (pid, status, WNOHANG);
3707 if (waitpid_result == pid)
3713 #endif /* HAVE_WAITPID */
3715 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3716 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3718 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3719 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3722 gdb_filename_fnmatch (const char *pattern, const char *string, int flags)
3724 gdb_assert ((flags & FNM_FILE_NAME) != 0);
3726 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3727 gdb_assert ((flags & FNM_NOESCAPE) != 0);
3729 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3731 char *pattern_slash, *string_slash;
3733 /* Replace '\' by '/' in both strings. */
3735 pattern_slash = alloca (strlen (pattern) + 1);
3736 strcpy (pattern_slash, pattern);
3737 pattern = pattern_slash;
3738 for (; *pattern_slash != 0; pattern_slash++)
3739 if (IS_DIR_SEPARATOR (*pattern_slash))
3740 *pattern_slash = '/';
3742 string_slash = alloca (strlen (string) + 1);
3743 strcpy (string_slash, string);
3744 string = string_slash;
3745 for (; *string_slash != 0; string_slash++)
3746 if (IS_DIR_SEPARATOR (*string_slash))
3747 *string_slash = '/';
3749 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3751 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3752 flags |= FNM_CASEFOLD;
3753 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3755 return fnmatch (pattern, string, flags);
3758 /* Provide a prototype to silence -Wmissing-prototypes. */
3759 extern initialize_file_ftype _initialize_utils;
3762 _initialize_utils (void)
3764 add_internal_problem_command (&internal_error_problem);
3765 add_internal_problem_command (&internal_warning_problem);