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"
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. */
44 #include "timeval-utils.h"
49 #include "gdb-demangle.h"
50 #include "expression.h"
54 #include "filenames.h"
56 #include "gdb_obstack.h"
62 #include "inferior.h" /* for signed_pointer_to_address */
64 #include "gdb_curses.h"
66 #include "readline/readline.h"
71 #include "gdb_usleep.h"
73 #include "gdb_regex.h"
76 extern PTR malloc (); /* ARI: PTR */
78 #if !HAVE_DECL_REALLOC
79 extern PTR realloc (); /* ARI: PTR */
85 void (*deprecated_error_begin_hook) (void);
87 /* Prototypes for local functions */
89 static void vfprintf_maybe_filtered (struct ui_file *, const char *,
90 va_list, int) ATTRIBUTE_PRINTF (2, 0);
92 static void fputs_maybe_filtered (const char *, struct ui_file *, int);
94 static void prompt_for_continue (void);
96 static void set_screen_size (void);
97 static void set_width (void);
99 /* Time spent in prompt_for_continue in the currently executing command
100 waiting for user to respond.
101 Initialized in make_command_stats_cleanup.
102 Modified in prompt_for_continue and defaulted_query.
103 Used in report_command_stats. */
105 static struct timeval prompt_for_continue_wait_time;
107 /* A flag indicating whether to timestamp debugging messages. */
109 static int debug_timestamp = 0;
111 /* Nonzero if we have job control. */
116 /* Nonzero means a quit has been requested. */
119 #endif /* HAVE_PYTHON */
121 /* Nonzero means quit immediately if Control-C is typed now, rather
122 than waiting until QUIT is executed. Be careful in setting this;
123 code which executes with immediate_quit set has to be very careful
124 about being able to deal with being interrupted at any time. It is
125 almost always better to use QUIT; the only exception I can think of
126 is being able to quit out of a system call (using EINTR loses if
127 the SIGINT happens between the previous QUIT and the system call).
128 To immediately quit in the case in which a SIGINT happens between
129 the previous QUIT and setting immediate_quit (desirable anytime we
130 expect to block), call QUIT after setting immediate_quit. */
136 /* Clear the quit flag. */
139 clear_quit_flag (void)
144 /* Set the quit flag. */
152 /* Return true if the quit flag has been set, false otherwise. */
155 check_quit_flag (void)
157 /* This is written in a particular way to avoid races. */
167 #endif /* HAVE_PYTHON */
169 /* Nonzero means that strings with character values >0x7F should be printed
170 as octal escapes. Zero means just print the value (e.g. it's an
171 international character, and the terminal or window can cope.) */
173 int sevenbit_strings = 0;
175 show_sevenbit_strings (struct ui_file *file, int from_tty,
176 struct cmd_list_element *c, const char *value)
178 fprintf_filtered (file, _("Printing of 8-bit characters "
179 "in strings as \\nnn is %s.\n"),
183 /* String to be printed before warning messages, if any. */
185 char *warning_pre_print = "\nwarning: ";
187 int pagination_enabled = 1;
189 show_pagination_enabled (struct ui_file *file, int from_tty,
190 struct cmd_list_element *c, const char *value)
192 fprintf_filtered (file, _("State of pagination is %s.\n"), value);
196 /* Cleanup utilities.
198 These are not defined in cleanups.c (nor declared in cleanups.h)
199 because while they use the "cleanup API" they are not part of the
203 do_freeargv (void *arg)
205 freeargv ((char **) arg);
209 make_cleanup_freeargv (char **arg)
211 return make_cleanup (do_freeargv, arg);
215 do_dyn_string_delete (void *arg)
217 dyn_string_delete ((dyn_string_t) arg);
221 make_cleanup_dyn_string_delete (dyn_string_t arg)
223 return make_cleanup (do_dyn_string_delete, arg);
227 do_bfd_close_cleanup (void *arg)
233 make_cleanup_bfd_unref (bfd *abfd)
235 return make_cleanup (do_bfd_close_cleanup, abfd);
239 do_close_cleanup (void *arg)
247 make_cleanup_close (int fd)
249 int *saved_fd = xmalloc (sizeof (fd));
252 return make_cleanup_dtor (do_close_cleanup, saved_fd, xfree);
255 /* Helper function which does the work for make_cleanup_fclose. */
258 do_fclose_cleanup (void *arg)
265 /* Return a new cleanup that closes FILE. */
268 make_cleanup_fclose (FILE *file)
270 return make_cleanup (do_fclose_cleanup, file);
273 /* Helper function which does the work for make_cleanup_obstack_free. */
276 do_obstack_free (void *arg)
278 struct obstack *ob = arg;
280 obstack_free (ob, NULL);
283 /* Return a new cleanup that frees OBSTACK. */
286 make_cleanup_obstack_free (struct obstack *obstack)
288 return make_cleanup (do_obstack_free, obstack);
292 do_ui_file_delete (void *arg)
294 ui_file_delete (arg);
298 make_cleanup_ui_file_delete (struct ui_file *arg)
300 return make_cleanup (do_ui_file_delete, arg);
303 /* Helper function for make_cleanup_ui_out_redirect_pop. */
306 do_ui_out_redirect_pop (void *arg)
308 struct ui_out *uiout = arg;
310 if (ui_out_redirect (uiout, NULL) < 0)
311 warning (_("Cannot restore redirection of the current output protocol"));
314 /* Return a new cleanup that pops the last redirection by ui_out_redirect
315 with NULL parameter. */
318 make_cleanup_ui_out_redirect_pop (struct ui_out *uiout)
320 return make_cleanup (do_ui_out_redirect_pop, uiout);
324 do_free_section_addr_info (void *arg)
326 free_section_addr_info (arg);
330 make_cleanup_free_section_addr_info (struct section_addr_info *addrs)
332 return make_cleanup (do_free_section_addr_info, addrs);
335 struct restore_integer_closure
342 restore_integer (void *p)
344 struct restore_integer_closure *closure = p;
346 *(closure->variable) = closure->value;
349 /* Remember the current value of *VARIABLE and make it restored when
350 the cleanup is run. */
353 make_cleanup_restore_integer (int *variable)
355 struct restore_integer_closure *c =
356 xmalloc (sizeof (struct restore_integer_closure));
358 c->variable = variable;
359 c->value = *variable;
361 return make_cleanup_dtor (restore_integer, (void *) c, xfree);
364 /* Remember the current value of *VARIABLE and make it restored when
365 the cleanup is run. */
368 make_cleanup_restore_uinteger (unsigned int *variable)
370 return make_cleanup_restore_integer ((int *) variable);
373 /* Helper for make_cleanup_unpush_target. */
376 do_unpush_target (void *arg)
378 struct target_ops *ops = arg;
383 /* Return a new cleanup that unpushes OPS. */
386 make_cleanup_unpush_target (struct target_ops *ops)
388 return make_cleanup (do_unpush_target, ops);
391 /* Helper for make_cleanup_htab_delete compile time checking the types. */
394 do_htab_delete_cleanup (void *htab_voidp)
396 htab_t htab = htab_voidp;
401 /* Return a new cleanup that deletes HTAB. */
404 make_cleanup_htab_delete (htab_t htab)
406 return make_cleanup (do_htab_delete_cleanup, htab);
409 struct restore_ui_file_closure
411 struct ui_file **variable;
412 struct ui_file *value;
416 do_restore_ui_file (void *p)
418 struct restore_ui_file_closure *closure = p;
420 *(closure->variable) = closure->value;
423 /* Remember the current value of *VARIABLE and make it restored when
424 the cleanup is run. */
427 make_cleanup_restore_ui_file (struct ui_file **variable)
429 struct restore_ui_file_closure *c = XNEW (struct restore_ui_file_closure);
431 c->variable = variable;
432 c->value = *variable;
434 return make_cleanup_dtor (do_restore_ui_file, (void *) c, xfree);
437 /* Helper for make_cleanup_value_free_to_mark. */
440 do_value_free_to_mark (void *value)
442 value_free_to_mark ((struct value *) value);
445 /* Free all values allocated since MARK was obtained by value_mark
446 (except for those released) when the cleanup is run. */
449 make_cleanup_value_free_to_mark (struct value *mark)
451 return make_cleanup (do_value_free_to_mark, mark);
454 /* Helper for make_cleanup_value_free. */
457 do_value_free (void *value)
465 make_cleanup_value_free (struct value *value)
467 return make_cleanup (do_value_free, value);
470 /* Helper for make_cleanup_free_so. */
473 do_free_so (void *arg)
475 struct so_list *so = arg;
480 /* Make cleanup handler calling free_so for SO. */
483 make_cleanup_free_so (struct so_list *so)
485 return make_cleanup (do_free_so, so);
488 /* Helper for make_cleanup_restore_current_language. */
491 do_restore_current_language (void *p)
493 enum language saved_lang = (uintptr_t) p;
495 set_language (saved_lang);
498 /* Remember the current value of CURRENT_LANGUAGE and make it restored when
499 the cleanup is run. */
502 make_cleanup_restore_current_language (void)
504 enum language saved_lang = current_language->la_language;
506 return make_cleanup (do_restore_current_language,
507 (void *) (uintptr_t) saved_lang);
510 /* This function is useful for cleanups.
514 old_chain = make_cleanup (free_current_contents, &foo);
516 to arrange to free the object thus allocated. */
519 free_current_contents (void *ptr)
521 void **location = ptr;
523 if (location == NULL)
524 internal_error (__FILE__, __LINE__,
525 _("free_current_contents: NULL pointer"));
526 if (*location != NULL)
535 /* Print a warning message. The first argument STRING is the warning
536 message, used as an fprintf format string, the second is the
537 va_list of arguments for that string. A warning is unfiltered (not
538 paginated) so that the user does not need to page through each
539 screen full of warnings when there are lots of them. */
542 vwarning (const char *string, va_list args)
544 if (deprecated_warning_hook)
545 (*deprecated_warning_hook) (string, args);
548 target_terminal_ours ();
549 wrap_here (""); /* Force out any buffered output. */
550 gdb_flush (gdb_stdout);
551 if (warning_pre_print)
552 fputs_unfiltered (warning_pre_print, gdb_stderr);
553 vfprintf_unfiltered (gdb_stderr, string, args);
554 fprintf_unfiltered (gdb_stderr, "\n");
559 /* Print a warning message.
560 The first argument STRING is the warning message, used as a fprintf string,
561 and the remaining args are passed as arguments to it.
562 The primary difference between warnings and errors is that a warning
563 does not force the return to command level. */
566 warning (const char *string, ...)
570 va_start (args, string);
571 vwarning (string, args);
575 /* Print an error message and return to command level.
576 The first argument STRING is the error message, used as a fprintf string,
577 and the remaining args are passed as arguments to it. */
580 verror (const char *string, va_list args)
582 throw_verror (GENERIC_ERROR, string, args);
586 error (const char *string, ...)
590 va_start (args, string);
591 throw_verror (GENERIC_ERROR, string, args);
595 /* Print an error message and quit.
596 The first argument STRING is the error message, used as a fprintf string,
597 and the remaining args are passed as arguments to it. */
600 vfatal (const char *string, va_list args)
602 throw_vfatal (string, args);
606 fatal (const char *string, ...)
610 va_start (args, string);
611 throw_vfatal (string, args);
616 error_stream (struct ui_file *stream)
618 char *message = ui_file_xstrdup (stream, NULL);
620 make_cleanup (xfree, message);
621 error (("%s"), message);
624 /* Dump core trying to increase the core soft limit to hard limit first. */
629 #ifdef HAVE_SETRLIMIT
630 struct rlimit rlim = { RLIM_INFINITY, RLIM_INFINITY };
632 setrlimit (RLIMIT_CORE, &rlim);
633 #endif /* HAVE_SETRLIMIT */
635 abort (); /* NOTE: GDB has only three calls to abort(). */
638 /* Check whether GDB will be able to dump core using the dump_core
642 can_dump_core (const char *reason)
644 #ifdef HAVE_GETRLIMIT
647 /* Be quiet and assume we can dump if an error is returned. */
648 if (getrlimit (RLIMIT_CORE, &rlim) != 0)
651 if (rlim.rlim_max == 0)
653 fprintf_unfiltered (gdb_stderr,
654 _("%s\nUnable to dump core, use `ulimit -c"
655 " unlimited' before executing GDB next time.\n"),
659 #endif /* HAVE_GETRLIMIT */
664 /* Allow the user to configure the debugger behavior with respect to
665 what to do when an internal problem is detected. */
667 const char internal_problem_ask[] = "ask";
668 const char internal_problem_yes[] = "yes";
669 const char internal_problem_no[] = "no";
670 static const char *const internal_problem_modes[] =
672 internal_problem_ask,
673 internal_problem_yes,
678 /* Print a message reporting an internal error/warning. Ask the user
679 if they want to continue, dump core, or just exit. Return
680 something to indicate a quit. */
682 struct internal_problem
685 const char *should_quit;
686 const char *should_dump_core;
689 /* Report a problem, internal to GDB, to the user. Once the problem
690 has been reported, and assuming GDB didn't quit, the caller can
691 either allow execution to resume or throw an error. */
693 static void ATTRIBUTE_PRINTF (4, 0)
694 internal_vproblem (struct internal_problem *problem,
695 const char *file, int line, const char *fmt, va_list ap)
701 struct cleanup *cleanup = make_cleanup (null_cleanup, NULL);
703 /* Don't allow infinite error/warning recursion. */
705 static char msg[] = "Recursive internal problem.\n";
714 fputs_unfiltered (msg, gdb_stderr);
715 abort (); /* NOTE: GDB has only three calls to abort(). */
718 /* Newer GLIBC versions put the warn_unused_result attribute
719 on write, but this is one of those rare cases where
720 ignoring the return value is correct. Casting to (void)
721 does not fix this problem. This is the solution suggested
722 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
723 if (write (STDERR_FILENO, msg, sizeof (msg)) != sizeof (msg))
724 abort (); /* NOTE: GDB has only three calls to abort(). */
729 /* Try to get the message out and at the start of a new line. */
730 target_terminal_ours ();
733 /* Create a string containing the full error/warning message. Need
734 to call query with this full string, as otherwize the reason
735 (error/warning) and question become separated. Format using a
736 style similar to a compiler error message. Include extra detail
737 so that the user knows that they are living on the edge. */
741 msg = xstrvprintf (fmt, ap);
742 reason = xstrprintf ("%s:%d: %s: %s\n"
743 "A problem internal to GDB has been detected,\n"
744 "further debugging may prove unreliable.",
745 file, line, problem->name, msg);
747 make_cleanup (xfree, reason);
750 if (problem->should_quit == internal_problem_ask)
752 /* Default (yes/batch case) is to quit GDB. When in batch mode
753 this lessens the likelihood of GDB going into an infinite
757 /* Emit the message and quit. */
758 fputs_unfiltered (reason, gdb_stderr);
759 fputs_unfiltered ("\n", gdb_stderr);
763 quit_p = query (_("%s\nQuit this debugging session? "), reason);
765 else if (problem->should_quit == internal_problem_yes)
767 else if (problem->should_quit == internal_problem_no)
770 internal_error (__FILE__, __LINE__, _("bad switch"));
772 if (problem->should_dump_core == internal_problem_ask)
774 if (!can_dump_core (reason))
778 /* Default (yes/batch case) is to dump core. This leaves a GDB
779 `dropping' so that it is easier to see that something went
781 dump_core_p = query (_("%s\nCreate a core file of GDB? "), reason);
784 else if (problem->should_dump_core == internal_problem_yes)
785 dump_core_p = can_dump_core (reason);
786 else if (problem->should_dump_core == internal_problem_no)
789 internal_error (__FILE__, __LINE__, _("bad switch"));
802 #ifdef HAVE_WORKING_FORK
810 do_cleanups (cleanup);
813 static struct internal_problem internal_error_problem = {
814 "internal-error", internal_problem_ask, internal_problem_ask
818 internal_verror (const char *file, int line, const char *fmt, va_list ap)
820 internal_vproblem (&internal_error_problem, file, line, fmt, ap);
821 fatal (_("Command aborted."));
825 internal_error (const char *file, int line, const char *string, ...)
829 va_start (ap, string);
830 internal_verror (file, line, string, ap);
834 static struct internal_problem internal_warning_problem = {
835 "internal-warning", internal_problem_ask, internal_problem_ask
839 internal_vwarning (const char *file, int line, const char *fmt, va_list ap)
841 internal_vproblem (&internal_warning_problem, file, line, fmt, ap);
845 internal_warning (const char *file, int line, const char *string, ...)
849 va_start (ap, string);
850 internal_vwarning (file, line, string, ap);
854 /* Dummy functions to keep add_prefix_cmd happy. */
857 set_internal_problem_cmd (char *args, int from_tty)
862 show_internal_problem_cmd (char *args, int from_tty)
866 /* When GDB reports an internal problem (error or warning) it gives
867 the user the opportunity to quit GDB and/or create a core file of
868 the current debug session. This function registers a few commands
869 that make it possible to specify that GDB should always or never
870 quit or create a core file, without asking. The commands look
873 maint set PROBLEM-NAME quit ask|yes|no
874 maint show PROBLEM-NAME quit
875 maint set PROBLEM-NAME corefile ask|yes|no
876 maint show PROBLEM-NAME corefile
878 Where PROBLEM-NAME is currently "internal-error" or
879 "internal-warning". */
882 add_internal_problem_command (struct internal_problem *problem)
884 struct cmd_list_element **set_cmd_list;
885 struct cmd_list_element **show_cmd_list;
889 set_cmd_list = xmalloc (sizeof (*set_cmd_list));
890 show_cmd_list = xmalloc (sizeof (*set_cmd_list));
891 *set_cmd_list = NULL;
892 *show_cmd_list = NULL;
894 set_doc = xstrprintf (_("Configure what GDB does when %s is detected."),
897 show_doc = xstrprintf (_("Show what GDB does when %s is detected."),
900 add_prefix_cmd ((char*) problem->name,
901 class_maintenance, set_internal_problem_cmd, set_doc,
903 concat ("maintenance set ", problem->name, " ",
905 0/*allow-unknown*/, &maintenance_set_cmdlist);
907 add_prefix_cmd ((char*) problem->name,
908 class_maintenance, show_internal_problem_cmd, show_doc,
910 concat ("maintenance show ", problem->name, " ",
912 0/*allow-unknown*/, &maintenance_show_cmdlist);
914 set_doc = xstrprintf (_("Set whether GDB should quit "
915 "when an %s is detected"),
917 show_doc = xstrprintf (_("Show whether GDB will quit "
918 "when an %s is detected"),
920 add_setshow_enum_cmd ("quit", class_maintenance,
921 internal_problem_modes,
922 &problem->should_quit,
934 set_doc = xstrprintf (_("Set whether GDB should create a core "
935 "file of GDB when %s is detected"),
937 show_doc = xstrprintf (_("Show whether GDB will create a core "
938 "file of GDB when %s is detected"),
940 add_setshow_enum_cmd ("corefile", class_maintenance,
941 internal_problem_modes,
942 &problem->should_dump_core,
955 /* Return a newly allocated string, containing the PREFIX followed
956 by the system error message for errno (separated by a colon).
958 The result must be deallocated after use. */
961 perror_string (const char *prefix)
966 err = safe_strerror (errno);
967 combined = (char *) xmalloc (strlen (err) + strlen (prefix) + 3);
968 strcpy (combined, prefix);
969 strcat (combined, ": ");
970 strcat (combined, err);
975 /* Print the system error message for errno, and also mention STRING
976 as the file name for which the error was encountered. Use ERRCODE
977 for the thrown exception. Then return to command level. */
980 throw_perror_with_name (enum errors errcode, const char *string)
984 combined = perror_string (string);
985 make_cleanup (xfree, combined);
987 /* I understand setting these is a matter of taste. Still, some people
988 may clear errno but not know about bfd_error. Doing this here is not
990 bfd_set_error (bfd_error_no_error);
993 throw_error (errcode, _("%s."), combined);
996 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
999 perror_with_name (const char *string)
1001 throw_perror_with_name (GENERIC_ERROR, string);
1004 /* Same as perror_with_name except that it prints a warning instead
1005 of throwing an error. */
1008 perror_warning_with_name (const char *string)
1012 combined = perror_string (string);
1013 warning (_("%s"), combined);
1017 /* Print the system error message for ERRCODE, and also mention STRING
1018 as the file name for which the error was encountered. */
1021 print_sys_errmsg (const char *string, int errcode)
1026 err = safe_strerror (errcode);
1027 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
1028 strcpy (combined, string);
1029 strcat (combined, ": ");
1030 strcat (combined, err);
1032 /* We want anything which was printed on stdout to come out first, before
1034 gdb_flush (gdb_stdout);
1035 fprintf_unfiltered (gdb_stderr, "%s.\n", combined);
1038 /* Control C eventually causes this to be called, at a convenient time. */
1044 /* No steenking SIGINT will ever be coming our way when the
1045 program is resumed. Don't lie. */
1049 /* If there is no terminal switching for this target, then we can't
1050 possibly get screwed by the lack of job control. */
1051 || current_target.to_terminal_ours == NULL)
1054 fatal ("Quit (expect signal SIGINT when the program is resumed)");
1059 /* Called when a memory allocation fails, with the number of bytes of
1060 memory requested in SIZE. */
1063 malloc_failure (long size)
1067 internal_error (__FILE__, __LINE__,
1068 _("virtual memory exhausted: can't allocate %ld bytes."),
1073 internal_error (__FILE__, __LINE__, _("virtual memory exhausted."));
1077 /* My replacement for the read system call.
1078 Used like `read' but keeps going if `read' returns too soon. */
1081 myread (int desc, char *addr, int len)
1088 val = read (desc, addr, len);
1092 return orglen - len;
1100 print_spaces (int n, struct ui_file *file)
1102 fputs_unfiltered (n_spaces (n), file);
1105 /* Print a host address. */
1108 gdb_print_host_address (const void *addr, struct ui_file *stream)
1110 fprintf_filtered (stream, "%s", host_address_to_string (addr));
1114 /* A cleanup function that calls regfree. */
1117 do_regfree_cleanup (void *r)
1122 /* Create a new cleanup that frees the compiled regular expression R. */
1125 make_regfree_cleanup (regex_t *r)
1127 return make_cleanup (do_regfree_cleanup, r);
1130 /* Return an xmalloc'd error message resulting from a regular
1131 expression compilation failure. */
1134 get_regcomp_error (int code, regex_t *rx)
1136 size_t length = regerror (code, rx, NULL, 0);
1137 char *result = xmalloc (length);
1139 regerror (code, rx, result, length);
1143 /* Compile a regexp and throw an exception on error. This returns a
1144 cleanup to free the resulting pattern on success. RX must not be
1148 compile_rx_or_error (regex_t *pattern, const char *rx, const char *message)
1152 gdb_assert (rx != NULL);
1154 code = regcomp (pattern, rx, REG_NOSUB);
1157 char *err = get_regcomp_error (code, pattern);
1159 make_cleanup (xfree, err);
1160 error (("%s: %s"), message, err);
1163 return make_regfree_cleanup (pattern);
1168 /* This function supports the query, nquery, and yquery functions.
1169 Ask user a y-or-n question and return 0 if answer is no, 1 if
1170 answer is yes, or default the answer to the specified default
1171 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1172 default answer, or '\0' for no default.
1173 CTLSTR is the control string and should end in "? ". It should
1174 not say how to answer, because we do that.
1175 ARGS are the arguments passed along with the CTLSTR argument to
1178 static int ATTRIBUTE_PRINTF (1, 0)
1179 defaulted_query (const char *ctlstr, const char defchar, va_list args)
1185 char def_answer, not_def_answer;
1186 char *y_string, *n_string, *question;
1187 /* Used to add duration we waited for user to respond to
1188 prompt_for_continue_wait_time. */
1189 struct timeval prompt_started, prompt_ended, prompt_delta;
1191 /* Set up according to which answer is the default. */
1192 if (defchar == '\0')
1196 not_def_answer = 'N';
1200 else if (defchar == 'y')
1204 not_def_answer = 'N';
1212 not_def_answer = 'Y';
1217 /* Automatically answer the default value if the user did not want
1218 prompts or the command was issued with the server prefix. */
1219 if (!confirm || server_command)
1222 /* If input isn't coming from the user directly, just say what
1223 question we're asking, and then answer the default automatically. This
1224 way, important error messages don't get lost when talking to GDB
1226 if (! input_from_terminal_p ())
1229 vfprintf_filtered (gdb_stdout, ctlstr, args);
1231 printf_filtered (_("(%s or %s) [answered %c; "
1232 "input not from terminal]\n"),
1233 y_string, n_string, def_answer);
1234 gdb_flush (gdb_stdout);
1239 if (deprecated_query_hook)
1241 return deprecated_query_hook (ctlstr, args);
1244 /* Format the question outside of the loop, to avoid reusing args. */
1245 question = xstrvprintf (ctlstr, args);
1247 /* Used for calculating time spend waiting for user. */
1248 gettimeofday (&prompt_started, NULL);
1252 wrap_here (""); /* Flush any buffered output. */
1253 gdb_flush (gdb_stdout);
1255 if (annotation_level > 1)
1256 printf_filtered (("\n\032\032pre-query\n"));
1258 fputs_filtered (question, gdb_stdout);
1259 printf_filtered (_("(%s or %s) "), y_string, n_string);
1261 if (annotation_level > 1)
1262 printf_filtered (("\n\032\032query\n"));
1265 gdb_flush (gdb_stdout);
1267 answer = fgetc (stdin);
1269 /* We expect fgetc to block until a character is read. But
1270 this may not be the case if the terminal was opened with
1271 the NONBLOCK flag. In that case, if there is nothing to
1272 read on stdin, fgetc returns EOF, but also sets the error
1273 condition flag on stdin and errno to EAGAIN. With a true
1274 EOF, stdin's error condition flag is not set.
1276 A situation where this behavior was observed is a pseudo
1278 while (answer == EOF && ferror (stdin) && errno == EAGAIN)
1280 /* Not a real EOF. Wait a little while and try again until
1281 we read something. */
1284 answer = fgetc (stdin);
1287 clearerr (stdin); /* in case of C-d */
1288 if (answer == EOF) /* C-d */
1290 printf_filtered ("EOF [assumed %c]\n", def_answer);
1294 /* Eat rest of input line, to EOF or newline. */
1298 ans2 = fgetc (stdin);
1301 while (ans2 != EOF && ans2 != '\n' && ans2 != '\r');
1305 /* Check answer. For the non-default, the user must specify
1306 the non-default explicitly. */
1307 if (answer == not_def_answer)
1309 retval = !def_value;
1312 /* Otherwise, if a default was specified, the user may either
1313 specify the required input or have it default by entering
1315 if (answer == def_answer
1316 || (defchar != '\0' &&
1317 (answer == '\n' || answer == '\r' || answer == EOF)))
1322 /* Invalid entries are not defaulted and require another selection. */
1323 printf_filtered (_("Please answer %s or %s.\n"),
1324 y_string, n_string);
1327 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1328 gettimeofday (&prompt_ended, NULL);
1329 timeval_sub (&prompt_delta, &prompt_ended, &prompt_started);
1330 timeval_add (&prompt_for_continue_wait_time,
1331 &prompt_for_continue_wait_time, &prompt_delta);
1334 if (annotation_level > 1)
1335 printf_filtered (("\n\032\032post-query\n"));
1340 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1341 answer is yes, or 0 if answer is defaulted.
1342 Takes three args which are given to printf to print the question.
1343 The first, a control string, should end in "? ".
1344 It should not say how to answer, because we do that. */
1347 nquery (const char *ctlstr, ...)
1352 va_start (args, ctlstr);
1353 ret = defaulted_query (ctlstr, 'n', args);
1358 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1359 answer is yes, or 1 if answer is defaulted.
1360 Takes three args which are given to printf to print the question.
1361 The first, a control string, should end in "? ".
1362 It should not say how to answer, because we do that. */
1365 yquery (const char *ctlstr, ...)
1370 va_start (args, ctlstr);
1371 ret = defaulted_query (ctlstr, 'y', args);
1376 /* Ask user a y-or-n question and return 1 iff answer is yes.
1377 Takes three args which are given to printf to print the question.
1378 The first, a control string, should end in "? ".
1379 It should not say how to answer, because we do that. */
1382 query (const char *ctlstr, ...)
1387 va_start (args, ctlstr);
1388 ret = defaulted_query (ctlstr, '\0', args);
1393 /* A helper for parse_escape that converts a host character to a
1394 target character. C is the host character. If conversion is
1395 possible, then the target character is stored in *TARGET_C and the
1396 function returns 1. Otherwise, the function returns 0. */
1399 host_char_to_target (struct gdbarch *gdbarch, int c, int *target_c)
1401 struct obstack host_data;
1403 struct cleanup *cleanups;
1406 obstack_init (&host_data);
1407 cleanups = make_cleanup_obstack_free (&host_data);
1409 convert_between_encodings (target_charset (gdbarch), host_charset (),
1410 (gdb_byte *) &the_char, 1, 1,
1411 &host_data, translit_none);
1413 if (obstack_object_size (&host_data) == 1)
1416 *target_c = *(char *) obstack_base (&host_data);
1419 do_cleanups (cleanups);
1423 /* Parse a C escape sequence. STRING_PTR points to a variable
1424 containing a pointer to the string to parse. That pointer
1425 should point to the character after the \. That pointer
1426 is updated past the characters we use. The value of the
1427 escape sequence is returned.
1429 A negative value means the sequence \ newline was seen,
1430 which is supposed to be equivalent to nothing at all.
1432 If \ is followed by a null character, we return a negative
1433 value and leave the string pointer pointing at the null character.
1435 If \ is followed by 000, we return 0 and leave the string pointer
1436 after the zeros. A value of 0 does not mean end of string. */
1439 parse_escape (struct gdbarch *gdbarch, const char **string_ptr)
1441 int target_char = -2; /* Initialize to avoid GCC warnings. */
1442 int c = *(*string_ptr)++;
1461 int i = host_hex_value (c);
1466 if (isdigit (c) && c != '8' && c != '9')
1470 i += host_hex_value (c);
1506 if (!host_char_to_target (gdbarch, c, &target_char))
1507 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1508 " which has no equivalent\nin the `%s' character set."),
1509 c, c, target_charset (gdbarch));
1513 /* Print the character C on STREAM as part of the contents of a literal
1514 string whose delimiter is QUOTER. Note that this routine should only
1515 be call for printing things which are independent of the language
1516 of the program being debugged. */
1519 printchar (int c, void (*do_fputs) (const char *, struct ui_file *),
1520 void (*do_fprintf) (struct ui_file *, const char *, ...)
1521 ATTRIBUTE_FPTR_PRINTF_2, struct ui_file *stream, int quoter)
1523 c &= 0xFF; /* Avoid sign bit follies */
1525 if (c < 0x20 || /* Low control chars */
1526 (c >= 0x7F && c < 0xA0) || /* DEL, High controls */
1527 (sevenbit_strings && c >= 0x80))
1528 { /* high order bit set */
1532 do_fputs ("\\n", stream);
1535 do_fputs ("\\b", stream);
1538 do_fputs ("\\t", stream);
1541 do_fputs ("\\f", stream);
1544 do_fputs ("\\r", stream);
1547 do_fputs ("\\e", stream);
1550 do_fputs ("\\a", stream);
1553 do_fprintf (stream, "\\%.3o", (unsigned int) c);
1559 if (c == '\\' || c == quoter)
1560 do_fputs ("\\", stream);
1561 do_fprintf (stream, "%c", c);
1565 /* Print the character C on STREAM as part of the contents of a
1566 literal string whose delimiter is QUOTER. Note that these routines
1567 should only be call for printing things which are independent of
1568 the language of the program being debugged. */
1571 fputstr_filtered (const char *str, int quoter, struct ui_file *stream)
1574 printchar (*str++, fputs_filtered, fprintf_filtered, stream, quoter);
1578 fputstr_unfiltered (const char *str, int quoter, struct ui_file *stream)
1581 printchar (*str++, fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1585 fputstrn_filtered (const char *str, int n, int quoter,
1586 struct ui_file *stream)
1590 for (i = 0; i < n; i++)
1591 printchar (str[i], fputs_filtered, fprintf_filtered, stream, quoter);
1595 fputstrn_unfiltered (const char *str, int n, int quoter,
1596 struct ui_file *stream)
1600 for (i = 0; i < n; i++)
1601 printchar (str[i], fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1605 /* Number of lines per page or UINT_MAX if paging is disabled. */
1606 static unsigned int lines_per_page;
1608 show_lines_per_page (struct ui_file *file, int from_tty,
1609 struct cmd_list_element *c, const char *value)
1611 fprintf_filtered (file,
1612 _("Number of lines gdb thinks are in a page is %s.\n"),
1616 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1617 static unsigned int chars_per_line;
1619 show_chars_per_line (struct ui_file *file, int from_tty,
1620 struct cmd_list_element *c, const char *value)
1622 fprintf_filtered (file,
1623 _("Number of characters gdb thinks "
1624 "are in a line is %s.\n"),
1628 /* Current count of lines printed on this page, chars on this line. */
1629 static unsigned int lines_printed, chars_printed;
1631 /* Buffer and start column of buffered text, for doing smarter word-
1632 wrapping. When someone calls wrap_here(), we start buffering output
1633 that comes through fputs_filtered(). If we see a newline, we just
1634 spit it out and forget about the wrap_here(). If we see another
1635 wrap_here(), we spit it out and remember the newer one. If we see
1636 the end of the line, we spit out a newline, the indent, and then
1637 the buffered output. */
1639 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1640 are waiting to be output (they have already been counted in chars_printed).
1641 When wrap_buffer[0] is null, the buffer is empty. */
1642 static char *wrap_buffer;
1644 /* Pointer in wrap_buffer to the next character to fill. */
1645 static char *wrap_pointer;
1647 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1649 static char *wrap_indent;
1651 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1652 is not in effect. */
1653 static int wrap_column;
1656 /* Inialize the number of lines per page and chars per line. */
1659 init_page_info (void)
1663 lines_per_page = UINT_MAX;
1664 chars_per_line = UINT_MAX;
1668 if (!tui_get_command_dimension (&chars_per_line, &lines_per_page))
1673 #if defined(__GO32__)
1674 rows = ScreenRows ();
1675 cols = ScreenCols ();
1676 lines_per_page = rows;
1677 chars_per_line = cols;
1679 /* Make sure Readline has initialized its terminal settings. */
1680 rl_reset_terminal (NULL);
1682 /* Get the screen size from Readline. */
1683 rl_get_screen_size (&rows, &cols);
1684 lines_per_page = rows;
1685 chars_per_line = cols;
1687 /* Readline should have fetched the termcap entry for us.
1688 Only try to use tgetnum function if rl_get_screen_size
1689 did not return a useful value. */
1690 if (((rows <= 0) && (tgetnum ("li") < 0))
1691 /* Also disable paging if inside EMACS. */
1692 || getenv ("EMACS"))
1694 /* The number of lines per page is not mentioned in the terminal
1695 description or EMACS evironment variable is set. This probably
1696 means that paging is not useful, so disable paging. */
1697 lines_per_page = UINT_MAX;
1700 /* If the output is not a terminal, don't paginate it. */
1701 if (!ui_file_isatty (gdb_stdout))
1702 lines_per_page = UINT_MAX;
1710 /* Helper for make_cleanup_restore_page_info. */
1713 do_restore_page_info_cleanup (void *arg)
1719 /* Provide cleanup for restoring the terminal size. */
1722 make_cleanup_restore_page_info (void)
1724 struct cleanup *back_to;
1726 back_to = make_cleanup (do_restore_page_info_cleanup, NULL);
1727 make_cleanup_restore_uinteger (&lines_per_page);
1728 make_cleanup_restore_uinteger (&chars_per_line);
1733 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1734 Provide cleanup for restoring the original state. */
1737 set_batch_flag_and_make_cleanup_restore_page_info (void)
1739 struct cleanup *back_to = make_cleanup_restore_page_info ();
1741 make_cleanup_restore_integer (&batch_flag);
1748 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1751 set_screen_size (void)
1753 int rows = lines_per_page;
1754 int cols = chars_per_line;
1762 /* Update Readline's idea of the terminal size. */
1763 rl_set_screen_size (rows, cols);
1766 /* Reinitialize WRAP_BUFFER according to the current value of
1772 if (chars_per_line == 0)
1777 wrap_buffer = (char *) xmalloc (chars_per_line + 2);
1778 wrap_buffer[0] = '\0';
1781 wrap_buffer = (char *) xrealloc (wrap_buffer, chars_per_line + 2);
1782 wrap_pointer = wrap_buffer; /* Start it at the beginning. */
1786 set_width_command (char *args, int from_tty, struct cmd_list_element *c)
1793 set_height_command (char *args, int from_tty, struct cmd_list_element *c)
1798 /* Wait, so the user can read what's on the screen. Prompt the user
1799 to continue by pressing RETURN. */
1802 prompt_for_continue (void)
1805 char cont_prompt[120];
1806 /* Used to add duration we waited for user to respond to
1807 prompt_for_continue_wait_time. */
1808 struct timeval prompt_started, prompt_ended, prompt_delta;
1810 gettimeofday (&prompt_started, NULL);
1812 if (annotation_level > 1)
1813 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1815 strcpy (cont_prompt,
1816 "---Type <return> to continue, or q <return> to quit---");
1817 if (annotation_level > 1)
1818 strcat (cont_prompt, "\n\032\032prompt-for-continue\n");
1820 /* We must do this *before* we call gdb_readline, else it will eventually
1821 call us -- thinking that we're trying to print beyond the end of the
1823 reinitialize_more_filter ();
1827 /* On a real operating system, the user can quit with SIGINT.
1830 'q' is provided on all systems so users don't have to change habits
1831 from system to system, and because telling them what to do in
1832 the prompt is more user-friendly than expecting them to think of
1834 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1835 whereas control-C to gdb_readline will cause the user to get dumped
1837 ignore = gdb_readline_wrapper (cont_prompt);
1839 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1840 gettimeofday (&prompt_ended, NULL);
1841 timeval_sub (&prompt_delta, &prompt_ended, &prompt_started);
1842 timeval_add (&prompt_for_continue_wait_time,
1843 &prompt_for_continue_wait_time, &prompt_delta);
1845 if (annotation_level > 1)
1846 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1852 while (*p == ' ' || *p == '\t')
1860 /* Now we have to do this again, so that GDB will know that it doesn't
1861 need to save the ---Type <return>--- line at the top of the screen. */
1862 reinitialize_more_filter ();
1864 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1867 /* Initalize timer to keep track of how long we waited for the user. */
1870 reset_prompt_for_continue_wait_time (void)
1872 static const struct timeval zero_timeval = { 0 };
1874 prompt_for_continue_wait_time = zero_timeval;
1877 /* Fetch the cumulative time spent in prompt_for_continue. */
1880 get_prompt_for_continue_wait_time (void)
1882 return prompt_for_continue_wait_time;
1885 /* Reinitialize filter; ie. tell it to reset to original values. */
1888 reinitialize_more_filter (void)
1894 /* Indicate that if the next sequence of characters overflows the line,
1895 a newline should be inserted here rather than when it hits the end.
1896 If INDENT is non-null, it is a string to be printed to indent the
1897 wrapped part on the next line. INDENT must remain accessible until
1898 the next call to wrap_here() or until a newline is printed through
1901 If the line is already overfull, we immediately print a newline and
1902 the indentation, and disable further wrapping.
1904 If we don't know the width of lines, but we know the page height,
1905 we must not wrap words, but should still keep track of newlines
1906 that were explicitly printed.
1908 INDENT should not contain tabs, as that will mess up the char count
1909 on the next line. FIXME.
1911 This routine is guaranteed to force out any output which has been
1912 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1913 used to force out output from the wrap_buffer. */
1916 wrap_here (char *indent)
1918 /* This should have been allocated, but be paranoid anyway. */
1920 internal_error (__FILE__, __LINE__,
1921 _("failed internal consistency check"));
1925 *wrap_pointer = '\0';
1926 fputs_unfiltered (wrap_buffer, gdb_stdout);
1928 wrap_pointer = wrap_buffer;
1929 wrap_buffer[0] = '\0';
1930 if (chars_per_line == UINT_MAX) /* No line overflow checking. */
1934 else if (chars_printed >= chars_per_line)
1936 puts_filtered ("\n");
1938 puts_filtered (indent);
1943 wrap_column = chars_printed;
1947 wrap_indent = indent;
1951 /* Print input string to gdb_stdout, filtered, with wrap,
1952 arranging strings in columns of n chars. String can be
1953 right or left justified in the column. Never prints
1954 trailing spaces. String should never be longer than
1955 width. FIXME: this could be useful for the EXAMINE
1956 command, which currently doesn't tabulate very well. */
1959 puts_filtered_tabular (char *string, int width, int right)
1965 gdb_assert (chars_per_line > 0);
1966 if (chars_per_line == UINT_MAX)
1968 fputs_filtered (string, gdb_stdout);
1969 fputs_filtered ("\n", gdb_stdout);
1973 if (((chars_printed - 1) / width + 2) * width >= chars_per_line)
1974 fputs_filtered ("\n", gdb_stdout);
1976 if (width >= chars_per_line)
1977 width = chars_per_line - 1;
1979 stringlen = strlen (string);
1981 if (chars_printed > 0)
1982 spaces = width - (chars_printed - 1) % width - 1;
1984 spaces += width - stringlen;
1986 spacebuf = alloca (spaces + 1);
1987 spacebuf[spaces] = '\0';
1989 spacebuf[spaces] = ' ';
1991 fputs_filtered (spacebuf, gdb_stdout);
1992 fputs_filtered (string, gdb_stdout);
1996 /* Ensure that whatever gets printed next, using the filtered output
1997 commands, starts at the beginning of the line. I.e. if there is
1998 any pending output for the current line, flush it and start a new
1999 line. Otherwise do nothing. */
2004 if (chars_printed > 0)
2006 puts_filtered ("\n");
2011 /* Like fputs but if FILTER is true, pause after every screenful.
2013 Regardless of FILTER can wrap at points other than the final
2014 character of a line.
2016 Unlike fputs, fputs_maybe_filtered does not return a value.
2017 It is OK for LINEBUFFER to be NULL, in which case just don't print
2020 Note that a longjmp to top level may occur in this routine (only if
2021 FILTER is true) (since prompt_for_continue may do so) so this
2022 routine should not be called when cleanups are not in place. */
2025 fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
2028 const char *lineptr;
2030 if (linebuffer == 0)
2033 /* Don't do any filtering if it is disabled. */
2034 if (stream != gdb_stdout
2035 || !pagination_enabled
2037 || (lines_per_page == UINT_MAX && chars_per_line == UINT_MAX)
2038 || top_level_interpreter () == NULL
2039 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2041 fputs_unfiltered (linebuffer, stream);
2045 /* Go through and output each character. Show line extension
2046 when this is necessary; prompt user for new page when this is
2049 lineptr = linebuffer;
2052 /* Possible new page. */
2053 if (filter && (lines_printed >= lines_per_page - 1))
2054 prompt_for_continue ();
2056 while (*lineptr && *lineptr != '\n')
2058 /* Print a single line. */
2059 if (*lineptr == '\t')
2062 *wrap_pointer++ = '\t';
2064 fputc_unfiltered ('\t', stream);
2065 /* Shifting right by 3 produces the number of tab stops
2066 we have already passed, and then adding one and
2067 shifting left 3 advances to the next tab stop. */
2068 chars_printed = ((chars_printed >> 3) + 1) << 3;
2074 *wrap_pointer++ = *lineptr;
2076 fputc_unfiltered (*lineptr, stream);
2081 if (chars_printed >= chars_per_line)
2083 unsigned int save_chars = chars_printed;
2087 /* If we aren't actually wrapping, don't output newline --
2088 if chars_per_line is right, we probably just overflowed
2089 anyway; if it's wrong, let us keep going. */
2091 fputc_unfiltered ('\n', stream);
2093 /* Possible new page. */
2094 if (lines_printed >= lines_per_page - 1)
2095 prompt_for_continue ();
2097 /* Now output indentation and wrapped string. */
2100 fputs_unfiltered (wrap_indent, stream);
2101 *wrap_pointer = '\0'; /* Null-terminate saved stuff, */
2102 fputs_unfiltered (wrap_buffer, stream); /* and eject it. */
2103 /* FIXME, this strlen is what prevents wrap_indent from
2104 containing tabs. However, if we recurse to print it
2105 and count its chars, we risk trouble if wrap_indent is
2106 longer than (the user settable) chars_per_line.
2107 Note also that this can set chars_printed > chars_per_line
2108 if we are printing a long string. */
2109 chars_printed = strlen (wrap_indent)
2110 + (save_chars - wrap_column);
2111 wrap_pointer = wrap_buffer; /* Reset buffer */
2112 wrap_buffer[0] = '\0';
2113 wrap_column = 0; /* And disable fancy wrap */
2118 if (*lineptr == '\n')
2121 wrap_here ((char *) 0); /* Spit out chars, cancel
2124 fputc_unfiltered ('\n', stream);
2131 fputs_filtered (const char *linebuffer, struct ui_file *stream)
2133 fputs_maybe_filtered (linebuffer, stream, 1);
2137 putchar_unfiltered (int c)
2141 ui_file_write (gdb_stdout, &buf, 1);
2145 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2146 May return nonlocally. */
2149 putchar_filtered (int c)
2151 return fputc_filtered (c, gdb_stdout);
2155 fputc_unfiltered (int c, struct ui_file *stream)
2159 ui_file_write (stream, &buf, 1);
2164 fputc_filtered (int c, struct ui_file *stream)
2170 fputs_filtered (buf, stream);
2174 /* puts_debug is like fputs_unfiltered, except it prints special
2175 characters in printable fashion. */
2178 puts_debug (char *prefix, char *string, char *suffix)
2182 /* Print prefix and suffix after each line. */
2183 static int new_line = 1;
2184 static int return_p = 0;
2185 static char *prev_prefix = "";
2186 static char *prev_suffix = "";
2188 if (*string == '\n')
2191 /* If the prefix is changing, print the previous suffix, a new line,
2192 and the new prefix. */
2193 if ((return_p || (strcmp (prev_prefix, prefix) != 0)) && !new_line)
2195 fputs_unfiltered (prev_suffix, gdb_stdlog);
2196 fputs_unfiltered ("\n", gdb_stdlog);
2197 fputs_unfiltered (prefix, gdb_stdlog);
2200 /* Print prefix if we printed a newline during the previous call. */
2204 fputs_unfiltered (prefix, gdb_stdlog);
2207 prev_prefix = prefix;
2208 prev_suffix = suffix;
2210 /* Output characters in a printable format. */
2211 while ((ch = *string++) != '\0')
2217 fputc_unfiltered (ch, gdb_stdlog);
2220 fprintf_unfiltered (gdb_stdlog, "\\x%02x", ch & 0xff);
2224 fputs_unfiltered ("\\\\", gdb_stdlog);
2227 fputs_unfiltered ("\\b", gdb_stdlog);
2230 fputs_unfiltered ("\\f", gdb_stdlog);
2234 fputs_unfiltered ("\\n", gdb_stdlog);
2237 fputs_unfiltered ("\\r", gdb_stdlog);
2240 fputs_unfiltered ("\\t", gdb_stdlog);
2243 fputs_unfiltered ("\\v", gdb_stdlog);
2247 return_p = ch == '\r';
2250 /* Print suffix if we printed a newline. */
2253 fputs_unfiltered (suffix, gdb_stdlog);
2254 fputs_unfiltered ("\n", gdb_stdlog);
2259 /* Print a variable number of ARGS using format FORMAT. If this
2260 information is going to put the amount written (since the last call
2261 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2262 call prompt_for_continue to get the users permision to continue.
2264 Unlike fprintf, this function does not return a value.
2266 We implement three variants, vfprintf (takes a vararg list and stream),
2267 fprintf (takes a stream to write on), and printf (the usual).
2269 Note also that a longjmp to top level may occur in this routine
2270 (since prompt_for_continue may do so) so this routine should not be
2271 called when cleanups are not in place. */
2274 vfprintf_maybe_filtered (struct ui_file *stream, const char *format,
2275 va_list args, int filter)
2278 struct cleanup *old_cleanups;
2280 linebuffer = xstrvprintf (format, args);
2281 old_cleanups = make_cleanup (xfree, linebuffer);
2282 fputs_maybe_filtered (linebuffer, stream, filter);
2283 do_cleanups (old_cleanups);
2288 vfprintf_filtered (struct ui_file *stream, const char *format, va_list args)
2290 vfprintf_maybe_filtered (stream, format, args, 1);
2294 vfprintf_unfiltered (struct ui_file *stream, const char *format, va_list args)
2297 struct cleanup *old_cleanups;
2299 linebuffer = xstrvprintf (format, args);
2300 old_cleanups = make_cleanup (xfree, linebuffer);
2301 if (debug_timestamp && stream == gdb_stdlog)
2307 gettimeofday (&tm, NULL);
2309 len = strlen (linebuffer);
2310 need_nl = (len > 0 && linebuffer[len - 1] != '\n');
2312 timestamp = xstrprintf ("%ld:%ld %s%s",
2313 (long) tm.tv_sec, (long) tm.tv_usec,
2315 need_nl ? "\n": "");
2316 make_cleanup (xfree, timestamp);
2317 fputs_unfiltered (timestamp, stream);
2320 fputs_unfiltered (linebuffer, stream);
2321 do_cleanups (old_cleanups);
2325 vprintf_filtered (const char *format, va_list args)
2327 vfprintf_maybe_filtered (gdb_stdout, format, args, 1);
2331 vprintf_unfiltered (const char *format, va_list args)
2333 vfprintf_unfiltered (gdb_stdout, format, args);
2337 fprintf_filtered (struct ui_file *stream, const char *format, ...)
2341 va_start (args, format);
2342 vfprintf_filtered (stream, format, args);
2347 fprintf_unfiltered (struct ui_file *stream, const char *format, ...)
2351 va_start (args, format);
2352 vfprintf_unfiltered (stream, format, args);
2356 /* Like fprintf_filtered, but prints its result indented.
2357 Called as fprintfi_filtered (spaces, stream, format, ...); */
2360 fprintfi_filtered (int spaces, struct ui_file *stream, const char *format,
2365 va_start (args, format);
2366 print_spaces_filtered (spaces, stream);
2368 vfprintf_filtered (stream, format, args);
2374 printf_filtered (const char *format, ...)
2378 va_start (args, format);
2379 vfprintf_filtered (gdb_stdout, format, args);
2385 printf_unfiltered (const char *format, ...)
2389 va_start (args, format);
2390 vfprintf_unfiltered (gdb_stdout, format, args);
2394 /* Like printf_filtered, but prints it's result indented.
2395 Called as printfi_filtered (spaces, format, ...); */
2398 printfi_filtered (int spaces, const char *format, ...)
2402 va_start (args, format);
2403 print_spaces_filtered (spaces, gdb_stdout);
2404 vfprintf_filtered (gdb_stdout, format, args);
2408 /* Easy -- but watch out!
2410 This routine is *not* a replacement for puts()! puts() appends a newline.
2411 This one doesn't, and had better not! */
2414 puts_filtered (const char *string)
2416 fputs_filtered (string, gdb_stdout);
2420 puts_unfiltered (const char *string)
2422 fputs_unfiltered (string, gdb_stdout);
2425 /* Return a pointer to N spaces and a null. The pointer is good
2426 until the next call to here. */
2431 static char *spaces = 0;
2432 static int max_spaces = -1;
2438 spaces = (char *) xmalloc (n + 1);
2439 for (t = spaces + n; t != spaces;)
2445 return spaces + max_spaces - n;
2448 /* Print N spaces. */
2450 print_spaces_filtered (int n, struct ui_file *stream)
2452 fputs_filtered (n_spaces (n), stream);
2455 /* C++/ObjC demangler stuff. */
2457 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2458 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2459 If the name is not mangled, or the language for the name is unknown, or
2460 demangling is off, the name is printed in its "raw" form. */
2463 fprintf_symbol_filtered (struct ui_file *stream, const char *name,
2464 enum language lang, int arg_mode)
2470 /* If user wants to see raw output, no problem. */
2473 fputs_filtered (name, stream);
2477 demangled = language_demangle (language_def (lang), name, arg_mode);
2478 fputs_filtered (demangled ? demangled : name, stream);
2479 if (demangled != NULL)
2487 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2488 differences in whitespace. Returns 0 if they match, non-zero if they
2489 don't (slightly different than strcmp()'s range of return values).
2491 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2492 This "feature" is useful when searching for matching C++ function names
2493 (such as if the user types 'break FOO', where FOO is a mangled C++
2497 strcmp_iw (const char *string1, const char *string2)
2499 while ((*string1 != '\0') && (*string2 != '\0'))
2501 while (isspace (*string1))
2505 while (isspace (*string2))
2509 if (case_sensitivity == case_sensitive_on && *string1 != *string2)
2511 if (case_sensitivity == case_sensitive_off
2512 && (tolower ((unsigned char) *string1)
2513 != tolower ((unsigned char) *string2)))
2515 if (*string1 != '\0')
2521 return (*string1 != '\0' && *string1 != '(') || (*string2 != '\0');
2524 /* This is like strcmp except that it ignores whitespace and treats
2525 '(' as the first non-NULL character in terms of ordering. Like
2526 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2527 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2528 according to that ordering.
2530 If a list is sorted according to this function and if you want to
2531 find names in the list that match some fixed NAME according to
2532 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2533 where this function would put NAME.
2535 This function must be neutral to the CASE_SENSITIVITY setting as the user
2536 may choose it during later lookup. Therefore this function always sorts
2537 primarily case-insensitively and secondarily case-sensitively.
2539 Here are some examples of why using strcmp to sort is a bad idea:
2543 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2544 we try to do a search for "foo<char*>", strcmp will locate this
2545 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2546 will start looking at strings beginning with "goo", and will never
2547 see the correct match of "foo<char *>".
2549 Parenthesis example:
2551 In practice, this is less like to be an issue, but I'll give it a
2552 shot. Let's assume that '$' is a legitimate character to occur in
2553 symbols. (Which may well even be the case on some systems.) Then
2554 say that the partial symbol table contains "foo$" and "foo(int)".
2555 strcmp will put them in this order, since '$' < '('. Now, if the
2556 user searches for "foo", then strcmp will sort "foo" before "foo$".
2557 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2558 "foo") is false, so it won't proceed to the actual match of
2559 "foo(int)" with "foo". */
2562 strcmp_iw_ordered (const char *string1, const char *string2)
2564 const char *saved_string1 = string1, *saved_string2 = string2;
2565 enum case_sensitivity case_pass = case_sensitive_off;
2569 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2570 Provide stub characters if we are already at the end of one of the
2572 char c1 = 'X', c2 = 'X';
2574 while (*string1 != '\0' && *string2 != '\0')
2576 while (isspace (*string1))
2578 while (isspace (*string2))
2583 case case_sensitive_off:
2584 c1 = tolower ((unsigned char) *string1);
2585 c2 = tolower ((unsigned char) *string2);
2587 case case_sensitive_on:
2595 if (*string1 != '\0')
2604 /* Characters are non-equal unless they're both '\0'; we want to
2605 make sure we get the comparison right according to our
2606 comparison in the cases where one of them is '\0' or '('. */
2608 if (*string2 == '\0')
2613 if (*string2 == '\0')
2618 if (*string2 == '\0' || *string2 == '(')
2627 if (case_pass == case_sensitive_on)
2630 /* Otherwise the strings were equal in case insensitive way, make
2631 a more fine grained comparison in a case sensitive way. */
2633 case_pass = case_sensitive_on;
2634 string1 = saved_string1;
2635 string2 = saved_string2;
2639 /* A simple comparison function with opposite semantics to strcmp. */
2642 streq (const char *lhs, const char *rhs)
2644 return !strcmp (lhs, rhs);
2650 ** Answer whether string_to_compare is a full or partial match to
2651 ** template_string. The partial match must be in sequence starting
2655 subset_compare (char *string_to_compare, char *template_string)
2659 if (template_string != (char *) NULL && string_to_compare != (char *) NULL
2660 && strlen (string_to_compare) <= strlen (template_string))
2663 (template_string, string_to_compare, strlen (string_to_compare)) == 0);
2670 pagination_on_command (char *arg, int from_tty)
2672 pagination_enabled = 1;
2676 pagination_off_command (char *arg, int from_tty)
2678 pagination_enabled = 0;
2682 show_debug_timestamp (struct ui_file *file, int from_tty,
2683 struct cmd_list_element *c, const char *value)
2685 fprintf_filtered (file, _("Timestamping debugging messages is %s.\n"),
2691 initialize_utils (void)
2693 add_setshow_uinteger_cmd ("width", class_support, &chars_per_line, _("\
2694 Set number of characters where GDB should wrap lines of its output."), _("\
2695 Show number of characters where GDB should wrap lines of its output."), _("\
2696 This affects where GDB wraps its output to fit the screen width.\n\
2697 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2699 show_chars_per_line,
2700 &setlist, &showlist);
2702 add_setshow_uinteger_cmd ("height", class_support, &lines_per_page, _("\
2703 Set number of lines in a page for GDB output pagination."), _("\
2704 Show number of lines in a page for GDB output pagination."), _("\
2705 This affects the number of lines after which GDB will pause\n\
2706 its output and ask you whether to continue.\n\
2707 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2709 show_lines_per_page,
2710 &setlist, &showlist);
2714 add_setshow_boolean_cmd ("pagination", class_support,
2715 &pagination_enabled, _("\
2716 Set state of GDB output pagination."), _("\
2717 Show state of GDB output pagination."), _("\
2718 When pagination is ON, GDB pauses at end of each screenful of\n\
2719 its output and asks you whether to continue.\n\
2720 Turning pagination off is an alternative to \"set height unlimited\"."),
2722 show_pagination_enabled,
2723 &setlist, &showlist);
2727 add_com ("am", class_support, pagination_on_command,
2728 _("Enable pagination"));
2729 add_com ("sm", class_support, pagination_off_command,
2730 _("Disable pagination"));
2733 add_setshow_boolean_cmd ("sevenbit-strings", class_support,
2734 &sevenbit_strings, _("\
2735 Set printing of 8-bit characters in strings as \\nnn."), _("\
2736 Show printing of 8-bit characters in strings as \\nnn."), NULL,
2738 show_sevenbit_strings,
2739 &setprintlist, &showprintlist);
2741 add_setshow_boolean_cmd ("timestamp", class_maintenance,
2742 &debug_timestamp, _("\
2743 Set timestamping of debugging messages."), _("\
2744 Show timestamping of debugging messages."), _("\
2745 When set, debugging messages will be marked with seconds and microseconds."),
2747 show_debug_timestamp,
2748 &setdebuglist, &showdebuglist);
2751 /* Print routines to handle variable size regs, etc. */
2752 /* Temporary storage using circular buffer. */
2758 static char buf[NUMCELLS][CELLSIZE];
2759 static int cell = 0;
2761 if (++cell >= NUMCELLS)
2767 paddress (struct gdbarch *gdbarch, CORE_ADDR addr)
2769 /* Truncate address to the size of a target address, avoiding shifts
2770 larger or equal than the width of a CORE_ADDR. The local
2771 variable ADDR_BIT stops the compiler reporting a shift overflow
2772 when it won't occur. */
2773 /* NOTE: This assumes that the significant address information is
2774 kept in the least significant bits of ADDR - the upper bits were
2775 either zero or sign extended. Should gdbarch_address_to_pointer or
2776 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2778 int addr_bit = gdbarch_addr_bit (gdbarch);
2780 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2781 addr &= ((CORE_ADDR) 1 << addr_bit) - 1;
2782 return hex_string (addr);
2785 /* This function is described in "defs.h". */
2788 print_core_address (struct gdbarch *gdbarch, CORE_ADDR address)
2790 int addr_bit = gdbarch_addr_bit (gdbarch);
2792 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2793 address &= ((CORE_ADDR) 1 << addr_bit) - 1;
2795 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2796 that returns the language localized string formatted to a width
2797 based on gdbarch_addr_bit. */
2799 return hex_string_custom (address, 8);
2801 return hex_string_custom (address, 16);
2804 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2807 core_addr_hash (const void *ap)
2809 const CORE_ADDR *addrp = ap;
2814 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2817 core_addr_eq (const void *ap, const void *bp)
2819 const CORE_ADDR *addr_ap = ap;
2820 const CORE_ADDR *addr_bp = bp;
2822 return *addr_ap == *addr_bp;
2826 decimal2str (char *sign, ULONGEST addr, int width)
2828 /* Steal code from valprint.c:print_decimal(). Should this worry
2829 about the real size of addr as the above does? */
2830 unsigned long temp[3];
2831 char *str = get_cell ();
2836 temp[i] = addr % (1000 * 1000 * 1000);
2837 addr /= (1000 * 1000 * 1000);
2841 while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0])));
2850 xsnprintf (str, CELLSIZE, "%s%0*lu", sign, width, temp[0]);
2853 xsnprintf (str, CELLSIZE, "%s%0*lu%09lu", sign, width,
2857 xsnprintf (str, CELLSIZE, "%s%0*lu%09lu%09lu", sign, width,
2858 temp[2], temp[1], temp[0]);
2861 internal_error (__FILE__, __LINE__,
2862 _("failed internal consistency check"));
2869 octal2str (ULONGEST addr, int width)
2871 unsigned long temp[3];
2872 char *str = get_cell ();
2877 temp[i] = addr % (0100000 * 0100000);
2878 addr /= (0100000 * 0100000);
2882 while (addr != 0 && i < (sizeof (temp) / sizeof (temp[0])));
2892 xsnprintf (str, CELLSIZE, "%*o", width, 0);
2894 xsnprintf (str, CELLSIZE, "0%0*lo", width, temp[0]);
2897 xsnprintf (str, CELLSIZE, "0%0*lo%010lo", width, temp[1], temp[0]);
2900 xsnprintf (str, CELLSIZE, "0%0*lo%010lo%010lo", width,
2901 temp[2], temp[1], temp[0]);
2904 internal_error (__FILE__, __LINE__,
2905 _("failed internal consistency check"));
2912 pulongest (ULONGEST u)
2914 return decimal2str ("", u, 0);
2918 plongest (LONGEST l)
2921 return decimal2str ("-", -l, 0);
2923 return decimal2str ("", l, 0);
2926 /* Eliminate warning from compiler on 32-bit systems. */
2927 static int thirty_two = 32;
2930 phex (ULONGEST l, int sizeof_l)
2938 xsnprintf (str, CELLSIZE, "%08lx%08lx",
2939 (unsigned long) (l >> thirty_two),
2940 (unsigned long) (l & 0xffffffff));
2944 xsnprintf (str, CELLSIZE, "%08lx", (unsigned long) l);
2948 xsnprintf (str, CELLSIZE, "%04x", (unsigned short) (l & 0xffff));
2951 str = phex (l, sizeof (l));
2959 phex_nz (ULONGEST l, int sizeof_l)
2967 unsigned long high = (unsigned long) (l >> thirty_two);
2971 xsnprintf (str, CELLSIZE, "%lx",
2972 (unsigned long) (l & 0xffffffff));
2974 xsnprintf (str, CELLSIZE, "%lx%08lx", high,
2975 (unsigned long) (l & 0xffffffff));
2980 xsnprintf (str, CELLSIZE, "%lx", (unsigned long) l);
2984 xsnprintf (str, CELLSIZE, "%x", (unsigned short) (l & 0xffff));
2987 str = phex_nz (l, sizeof (l));
2994 /* Converts a LONGEST to a C-format hexadecimal literal and stores it
2995 in a static string. Returns a pointer to this string. */
2997 hex_string (LONGEST num)
2999 char *result = get_cell ();
3001 xsnprintf (result, CELLSIZE, "0x%s", phex_nz (num, sizeof (num)));
3005 /* Converts a LONGEST number to a C-format hexadecimal literal and
3006 stores it in a static string. Returns a pointer to this string
3007 that is valid until the next call. The number is padded on the
3008 left with 0s to at least WIDTH characters. */
3010 hex_string_custom (LONGEST num, int width)
3012 char *result = get_cell ();
3013 char *result_end = result + CELLSIZE - 1;
3014 const char *hex = phex_nz (num, sizeof (num));
3015 int hex_len = strlen (hex);
3017 if (hex_len > width)
3019 if (width + 2 >= CELLSIZE)
3020 internal_error (__FILE__, __LINE__, _("\
3021 hex_string_custom: insufficient space to store result"));
3023 strcpy (result_end - width - 2, "0x");
3024 memset (result_end - width, '0', width);
3025 strcpy (result_end - hex_len, hex);
3026 return result_end - width - 2;
3029 /* Convert VAL to a numeral in the given radix. For
3030 * radix 10, IS_SIGNED may be true, indicating a signed quantity;
3031 * otherwise VAL is interpreted as unsigned. If WIDTH is supplied,
3032 * it is the minimum width (0-padded if needed). USE_C_FORMAT means
3033 * to use C format in all cases. If it is false, then 'x'
3034 * and 'o' formats do not include a prefix (0x or leading 0). */
3037 int_string (LONGEST val, int radix, int is_signed, int width,
3047 result = hex_string (val);
3049 result = hex_string_custom (val, width);
3056 if (is_signed && val < 0)
3057 return decimal2str ("-", -val, width);
3059 return decimal2str ("", val, width);
3063 char *result = octal2str (val, width);
3065 if (use_c_format || val == 0)
3071 internal_error (__FILE__, __LINE__,
3072 _("failed internal consistency check"));
3076 /* Convert a CORE_ADDR into a string. */
3078 core_addr_to_string (const CORE_ADDR addr)
3080 char *str = get_cell ();
3083 strcat (str, phex (addr, sizeof (addr)));
3088 core_addr_to_string_nz (const CORE_ADDR addr)
3090 char *str = get_cell ();
3093 strcat (str, phex_nz (addr, sizeof (addr)));
3097 /* Convert a string back into a CORE_ADDR. */
3099 string_to_core_addr (const char *my_string)
3103 if (my_string[0] == '0' && tolower (my_string[1]) == 'x')
3105 /* Assume that it is in hex. */
3108 for (i = 2; my_string[i] != '\0'; i++)
3110 if (isdigit (my_string[i]))
3111 addr = (my_string[i] - '0') + (addr * 16);
3112 else if (isxdigit (my_string[i]))
3113 addr = (tolower (my_string[i]) - 'a' + 0xa) + (addr * 16);
3115 error (_("invalid hex \"%s\""), my_string);
3120 /* Assume that it is in decimal. */
3123 for (i = 0; my_string[i] != '\0'; i++)
3125 if (isdigit (my_string[i]))
3126 addr = (my_string[i] - '0') + (addr * 10);
3128 error (_("invalid decimal \"%s\""), my_string);
3136 host_address_to_string (const void *addr)
3138 char *str = get_cell ();
3140 xsnprintf (str, CELLSIZE, "0x%s", phex_nz ((uintptr_t) addr, sizeof (addr)));
3145 gdb_realpath (const char *filename)
3147 /* Method 1: The system has a compile time upper bound on a filename
3148 path. Use that and realpath() to canonicalize the name. This is
3149 the most common case. Note that, if there isn't a compile time
3150 upper bound, you want to avoid realpath() at all costs. */
3151 #if defined (HAVE_REALPATH) && defined (PATH_MAX)
3154 const char *rp = realpath (filename, buf);
3158 return xstrdup (rp);
3160 #endif /* HAVE_REALPATH */
3162 /* Method 2: The host system (i.e., GNU) has the function
3163 canonicalize_file_name() which malloc's a chunk of memory and
3164 returns that, use that. */
3165 #if defined(HAVE_CANONICALIZE_FILE_NAME)
3167 char *rp = canonicalize_file_name (filename);
3170 return xstrdup (filename);
3176 /* FIXME: cagney/2002-11-13:
3178 Method 2a: Use realpath() with a NULL buffer. Some systems, due
3179 to the problems described in method 3, have modified their
3180 realpath() implementation so that it will allocate a buffer when
3181 NULL is passed in. Before this can be used, though, some sort of
3182 configure time test would need to be added. Otherwize the code
3183 will likely core dump. */
3185 /* Method 3: Now we're getting desperate! The system doesn't have a
3186 compile time buffer size and no alternative function. Query the
3187 OS, using pathconf(), for the buffer limit. Care is needed
3188 though, some systems do not limit PATH_MAX (return -1 for
3189 pathconf()) making it impossible to pass a correctly sized buffer
3190 to realpath() (it could always overflow). On those systems, we
3192 #if defined (HAVE_REALPATH) && defined (_PC_PATH_MAX) && defined(HAVE_ALLOCA)
3194 /* Find out the max path size. */
3195 long path_max = pathconf ("/", _PC_PATH_MAX);
3199 /* PATH_MAX is bounded. */
3200 char *buf = alloca (path_max);
3201 char *rp = realpath (filename, buf);
3203 return xstrdup (rp ? rp : filename);
3208 /* The MS Windows method. If we don't have realpath, we assume we
3209 don't have symlinks and just canonicalize to a Windows absolute
3210 path. GetFullPath converts ../ and ./ in relative paths to
3211 absolute paths, filling in current drive if one is not given
3212 or using the current directory of a specified drive (eg, "E:foo").
3213 It also converts all forward slashes to back slashes. */
3214 /* The file system is case-insensitive but case-preserving.
3215 So we do not lowercase the path. Otherwise, we might not
3216 be able to display the original casing in a given path. */
3217 #if defined (_WIN32)
3220 DWORD len = GetFullPathName (filename, MAX_PATH, buf, NULL);
3222 if (len > 0 && len < MAX_PATH)
3223 return xstrdup (buf);
3227 /* This system is a lost cause, just dup the buffer. */
3228 return xstrdup (filename);
3231 /* Return a copy of FILENAME, with its directory prefix canonicalized
3235 gdb_realpath_keepfile (const char *filename)
3237 const char *base_name = lbasename (filename);
3242 /* Extract the basename of filename, and return immediately
3243 a copy of filename if it does not contain any directory prefix. */
3244 if (base_name == filename)
3245 return xstrdup (filename);
3247 dir_name = alloca ((size_t) (base_name - filename + 2));
3248 /* Allocate enough space to store the dir_name + plus one extra
3249 character sometimes needed under Windows (see below), and
3250 then the closing \000 character. */
3251 strncpy (dir_name, filename, base_name - filename);
3252 dir_name[base_name - filename] = '\000';
3254 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3255 /* We need to be careful when filename is of the form 'd:foo', which
3256 is equivalent of d:./foo, which is totally different from d:/foo. */
3257 if (strlen (dir_name) == 2 && isalpha (dir_name[0]) && dir_name[1] == ':')
3260 dir_name[3] = '\000';
3264 /* Canonicalize the directory prefix, and build the resulting
3265 filename. If the dirname realpath already contains an ending
3266 directory separator, avoid doubling it. */
3267 real_path = gdb_realpath (dir_name);
3268 if (IS_DIR_SEPARATOR (real_path[strlen (real_path) - 1]))
3269 result = concat (real_path, base_name, (char *) NULL);
3271 result = concat (real_path, SLASH_STRING, base_name, (char *) NULL);
3277 /* Return PATH in absolute form, performing tilde-expansion if necessary.
3278 PATH cannot be NULL or the empty string.
3279 This does not resolve symlinks however, use gdb_realpath for that.
3280 Space for the result is allocated with malloc.
3281 If the path is already absolute, it is strdup'd.
3282 If there is a problem computing the absolute path, the path is returned
3283 unchanged (still strdup'd). */
3286 gdb_abspath (const char *path)
3288 gdb_assert (path != NULL && path[0] != '\0');
3291 return tilde_expand (path);
3293 if (IS_ABSOLUTE_PATH (path))
3294 return xstrdup (path);
3296 /* Beware the // my son, the Emacs barfs, the botch that catch... */
3297 return concat (current_directory,
3298 IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1])
3299 ? "" : SLASH_STRING,
3300 path, (char *) NULL);
3304 align_up (ULONGEST v, int n)
3306 /* Check that N is really a power of two. */
3307 gdb_assert (n && (n & (n-1)) == 0);
3308 return (v + n - 1) & -n;
3312 align_down (ULONGEST v, int n)
3314 /* Check that N is really a power of two. */
3315 gdb_assert (n && (n & (n-1)) == 0);
3322 gdb_sign_extend (LONGEST value, int bit)
3324 gdb_assert (bit >= 1 && bit <= 8 * sizeof (LONGEST));
3326 if (((value >> (bit - 1)) & 1) != 0)
3328 LONGEST signbit = ((LONGEST) 1) << (bit - 1);
3330 value = (value ^ signbit) - signbit;
3336 /* Allocation function for the libiberty hash table which uses an
3337 obstack. The obstack is passed as DATA. */
3340 hashtab_obstack_allocate (void *data, size_t size, size_t count)
3342 unsigned int total = size * count;
3343 void *ptr = obstack_alloc ((struct obstack *) data, total);
3345 memset (ptr, 0, total);
3349 /* Trivial deallocation function for the libiberty splay tree and hash
3350 table - don't deallocate anything. Rely on later deletion of the
3351 obstack. DATA will be the obstack, although it is not needed
3355 dummy_obstack_deallocate (void *object, void *data)
3360 /* The bit offset of the highest byte in a ULONGEST, for overflow
3363 #define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT)
3365 /* True (non-zero) iff DIGIT is a valid digit in radix BASE,
3366 where 2 <= BASE <= 36. */
3369 is_digit_in_base (unsigned char digit, int base)
3371 if (!isalnum (digit))
3374 return (isdigit (digit) && digit < base + '0');
3376 return (isdigit (digit) || tolower (digit) < base - 10 + 'a');
3380 digit_to_int (unsigned char c)
3385 return tolower (c) - 'a' + 10;
3388 /* As for strtoul, but for ULONGEST results. */
3391 strtoulst (const char *num, const char **trailer, int base)
3393 unsigned int high_part;
3398 /* Skip leading whitespace. */
3399 while (isspace (num[i]))
3402 /* Handle prefixes. */
3405 else if (num[i] == '-')
3411 if (base == 0 || base == 16)
3413 if (num[i] == '0' && (num[i + 1] == 'x' || num[i + 1] == 'X'))
3421 if (base == 0 && num[i] == '0')
3427 if (base < 2 || base > 36)
3433 result = high_part = 0;
3434 for (; is_digit_in_base (num[i], base); i += 1)
3436 result = result * base + digit_to_int (num[i]);
3437 high_part = high_part * base + (unsigned int) (result >> HIGH_BYTE_POSN);
3438 result &= ((ULONGEST) 1 << HIGH_BYTE_POSN) - 1;
3439 if (high_part > 0xff)
3442 result = ~ (ULONGEST) 0;
3449 if (trailer != NULL)
3452 result = result + ((ULONGEST) high_part << HIGH_BYTE_POSN);
3459 /* Simple, portable version of dirname that does not modify its
3463 ldirname (const char *filename)
3465 const char *base = lbasename (filename);
3468 while (base > filename && IS_DIR_SEPARATOR (base[-1]))
3471 if (base == filename)
3474 dirname = xmalloc (base - filename + 2);
3475 memcpy (dirname, filename, base - filename);
3477 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3478 create "d:./bar" later instead of the (different) "d:/bar". */
3479 if (base - filename == 2 && IS_ABSOLUTE_PATH (base)
3480 && !IS_DIR_SEPARATOR (filename[0]))
3481 dirname[base++ - filename] = '.';
3483 dirname[base - filename] = '\0';
3487 /* Call libiberty's buildargv, and return the result.
3488 If buildargv fails due to out-of-memory, call nomem.
3489 Therefore, the returned value is guaranteed to be non-NULL,
3490 unless the parameter itself is NULL. */
3493 gdb_buildargv (const char *s)
3495 char **argv = buildargv (s);
3497 if (s != NULL && argv == NULL)
3503 compare_positive_ints (const void *ap, const void *bp)
3505 /* Because we know we're comparing two ints which are positive,
3506 there's no danger of overflow here. */
3507 return * (int *) ap - * (int *) bp;
3510 /* String compare function for qsort. */
3513 compare_strings (const void *arg1, const void *arg2)
3515 const char **s1 = (const char **) arg1;
3516 const char **s2 = (const char **) arg2;
3518 return strcmp (*s1, *s2);
3521 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3522 #define AMBIGUOUS_MESS2 \
3523 ".\nUse \"set gnutarget format-name\" to specify the format."
3526 gdb_bfd_errmsg (bfd_error_type error_tag, char **matching)
3532 /* Check if errmsg just need simple return. */
3533 if (error_tag != bfd_error_file_ambiguously_recognized || matching == NULL)
3534 return bfd_errmsg (error_tag);
3536 ret_len = strlen (bfd_errmsg (error_tag)) + strlen (AMBIGUOUS_MESS1)
3537 + strlen (AMBIGUOUS_MESS2);
3538 for (p = matching; *p; p++)
3539 ret_len += strlen (*p) + 1;
3540 ret = xmalloc (ret_len + 1);
3542 make_cleanup (xfree, ret);
3544 strcpy (retp, bfd_errmsg (error_tag));
3545 retp += strlen (retp);
3547 strcpy (retp, AMBIGUOUS_MESS1);
3548 retp += strlen (retp);
3550 for (p = matching; *p; p++)
3552 sprintf (retp, " %s", *p);
3553 retp += strlen (retp);
3557 strcpy (retp, AMBIGUOUS_MESS2);
3562 /* Return ARGS parsed as a valid pid, or throw an error. */
3565 parse_pid_to_attach (char *args)
3571 error_no_arg (_("process-id to attach"));
3574 pid = strtoul (args, &dummy, 0);
3575 /* Some targets don't set errno on errors, grrr! */
3576 if ((pid == 0 && dummy == args) || dummy != &args[strlen (args)])
3577 error (_("Illegal process-id: %s."), args);
3582 /* Helper for make_bpstat_clear_actions_cleanup. */
3585 do_bpstat_clear_actions_cleanup (void *unused)
3587 bpstat_clear_actions ();
3590 /* Call bpstat_clear_actions for the case an exception is throw. You should
3591 discard_cleanups if no exception is caught. */
3594 make_bpstat_clear_actions_cleanup (void)
3596 return make_cleanup (do_bpstat_clear_actions_cleanup, NULL);
3599 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3600 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3601 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3604 producer_is_gcc_ge_4 (const char *producer)
3609 if (producer == NULL)
3611 /* For unknown compilers expect their behavior is not compliant. For GCC
3612 this case can also happen for -gdwarf-4 type units supported since
3618 /* Skip any identifier after "GNU " - such as "C++" or "Java". */
3620 if (strncmp (producer, "GNU ", strlen ("GNU ")) != 0)
3622 /* For non-GCC compilers expect their behavior is not compliant. */
3626 cs = &producer[strlen ("GNU ")];
3627 while (*cs && !isdigit (*cs))
3629 if (sscanf (cs, "%d.%d", &major, &minor) != 2)
3631 /* Not recognized as GCC. */
3643 /* Helper for make_cleanup_free_char_ptr_vec. */
3646 do_free_char_ptr_vec (void *arg)
3648 VEC (char_ptr) *char_ptr_vec = arg;
3650 free_char_ptr_vec (char_ptr_vec);
3653 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3654 final VEC_free for CHAR_PTR_VEC itself.
3656 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3657 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3658 this function does not (cannot) clear the pointer. */
3661 make_cleanup_free_char_ptr_vec (VEC (char_ptr) *char_ptr_vec)
3663 return make_cleanup (do_free_char_ptr_vec, char_ptr_vec);
3666 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3667 must come from xrealloc-compatible allocator and it may be updated. FROM
3668 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3669 located at the start or end of *STRINGP. */
3672 substitute_path_component (char **stringp, const char *from, const char *to)
3674 char *string = *stringp, *s;
3675 const size_t from_len = strlen (from);
3676 const size_t to_len = strlen (to);
3680 s = strstr (s, from);
3684 if ((s == string || IS_DIR_SEPARATOR (s[-1])
3685 || s[-1] == DIRNAME_SEPARATOR)
3686 && (s[from_len] == '\0' || IS_DIR_SEPARATOR (s[from_len])
3687 || s[from_len] == DIRNAME_SEPARATOR))
3691 string_new = xrealloc (string, (strlen (string) + to_len + 1));
3693 /* Relocate the current S pointer. */
3694 s = s - string + string_new;
3695 string = string_new;
3697 /* Replace from by to. */
3698 memmove (&s[to_len], &s[from_len], strlen (&s[from_len]) + 1);
3699 memcpy (s, to, to_len);
3714 /* SIGALRM handler for waitpid_with_timeout. */
3717 sigalrm_handler (int signo)
3719 /* Nothing to do. */
3724 /* Wrapper to wait for child PID to die with TIMEOUT.
3725 TIMEOUT is the time to stop waiting in seconds.
3726 If TIMEOUT is zero, pass WNOHANG to waitpid.
3727 Returns PID if it was successfully waited for, otherwise -1.
3729 Timeouts are currently implemented with alarm and SIGALRM.
3730 If the host does not support them, this waits "forever".
3731 It would be odd though for a host to have waitpid and not SIGALRM. */
3734 wait_to_die_with_timeout (pid_t pid, int *status, int timeout)
3736 pid_t waitpid_result;
3738 gdb_assert (pid > 0);
3739 gdb_assert (timeout >= 0);
3744 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3745 struct sigaction sa, old_sa;
3747 sa.sa_handler = sigalrm_handler;
3748 sigemptyset (&sa.sa_mask);
3750 sigaction (SIGALRM, &sa, &old_sa);
3754 ofunc = (void (*)()) signal (SIGALRM, sigalrm_handler);
3760 waitpid_result = waitpid (pid, status, 0);
3764 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3765 sigaction (SIGALRM, &old_sa, NULL);
3767 signal (SIGALRM, ofunc);
3772 waitpid_result = waitpid (pid, status, WNOHANG);
3774 if (waitpid_result == pid)
3780 #endif /* HAVE_WAITPID */
3782 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3783 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3785 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3786 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3789 gdb_filename_fnmatch (const char *pattern, const char *string, int flags)
3791 gdb_assert ((flags & FNM_FILE_NAME) != 0);
3793 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3794 gdb_assert ((flags & FNM_NOESCAPE) != 0);
3796 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3798 char *pattern_slash, *string_slash;
3800 /* Replace '\' by '/' in both strings. */
3802 pattern_slash = alloca (strlen (pattern) + 1);
3803 strcpy (pattern_slash, pattern);
3804 pattern = pattern_slash;
3805 for (; *pattern_slash != 0; pattern_slash++)
3806 if (IS_DIR_SEPARATOR (*pattern_slash))
3807 *pattern_slash = '/';
3809 string_slash = alloca (strlen (string) + 1);
3810 strcpy (string_slash, string);
3811 string = string_slash;
3812 for (; *string_slash != 0; string_slash++)
3813 if (IS_DIR_SEPARATOR (*string_slash))
3814 *string_slash = '/';
3816 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3818 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3819 flags |= FNM_CASEFOLD;
3820 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3822 return fnmatch (pattern, string, flags);
3825 /* Provide a prototype to silence -Wmissing-prototypes. */
3826 extern initialize_file_ftype _initialize_utils;
3829 _initialize_utils (void)
3831 add_internal_problem_command (&internal_error_problem);
3832 add_internal_problem_command (&internal_warning_problem);