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 /* Print the system error message for errno, and also mention STRING
961 as the file name for which the error was encountered. Use ERRCODE
962 for the thrown exception. Then return to command level. */
965 throw_perror_with_name (enum errors errcode
, const char *string
)
970 err
= safe_strerror (errno
);
971 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
972 strcpy (combined
, string
);
973 strcat (combined
, ": ");
974 strcat (combined
, err
);
976 /* I understand setting these is a matter of taste. Still, some people
977 may clear errno but not know about bfd_error. Doing this here is not
979 bfd_set_error (bfd_error_no_error
);
982 throw_error (errcode
, _("%s."), combined
);
985 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
988 perror_with_name (const char *string
)
990 throw_perror_with_name (GENERIC_ERROR
, string
);
993 /* Print the system error message for ERRCODE, and also mention STRING
994 as the file name for which the error was encountered. */
997 print_sys_errmsg (const char *string
, int errcode
)
1002 err
= safe_strerror (errcode
);
1003 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
1004 strcpy (combined
, string
);
1005 strcat (combined
, ": ");
1006 strcat (combined
, err
);
1008 /* We want anything which was printed on stdout to come out first, before
1010 gdb_flush (gdb_stdout
);
1011 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
1014 /* Control C eventually causes this to be called, at a convenient time. */
1020 /* No steenking SIGINT will ever be coming our way when the
1021 program is resumed. Don't lie. */
1025 /* If there is no terminal switching for this target, then we can't
1026 possibly get screwed by the lack of job control. */
1027 || current_target
.to_terminal_ours
== NULL
)
1030 fatal ("Quit (expect signal SIGINT when the program is resumed)");
1035 /* Called when a memory allocation fails, with the number of bytes of
1036 memory requested in SIZE. */
1039 malloc_failure (long size
)
1043 internal_error (__FILE__
, __LINE__
,
1044 _("virtual memory exhausted: can't allocate %ld bytes."),
1049 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
1053 /* My replacement for the read system call.
1054 Used like `read' but keeps going if `read' returns too soon. */
1057 myread (int desc
, char *addr
, int len
)
1064 val
= read (desc
, addr
, len
);
1068 return orglen
- len
;
1076 print_spaces (int n
, struct ui_file
*file
)
1078 fputs_unfiltered (n_spaces (n
), file
);
1081 /* Print a host address. */
1084 gdb_print_host_address (const void *addr
, struct ui_file
*stream
)
1086 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
1090 /* A cleanup function that calls regfree. */
1093 do_regfree_cleanup (void *r
)
1098 /* Create a new cleanup that frees the compiled regular expression R. */
1101 make_regfree_cleanup (regex_t
*r
)
1103 return make_cleanup (do_regfree_cleanup
, r
);
1106 /* Return an xmalloc'd error message resulting from a regular
1107 expression compilation failure. */
1110 get_regcomp_error (int code
, regex_t
*rx
)
1112 size_t length
= regerror (code
, rx
, NULL
, 0);
1113 char *result
= xmalloc (length
);
1115 regerror (code
, rx
, result
, length
);
1119 /* Compile a regexp and throw an exception on error. This returns a
1120 cleanup to free the resulting pattern on success. RX must not be
1124 compile_rx_or_error (regex_t
*pattern
, const char *rx
, const char *message
)
1128 gdb_assert (rx
!= NULL
);
1130 code
= regcomp (pattern
, rx
, REG_NOSUB
);
1133 char *err
= get_regcomp_error (code
, pattern
);
1135 make_cleanup (xfree
, err
);
1136 error (("%s: %s"), message
, err
);
1139 return make_regfree_cleanup (pattern
);
1144 /* This function supports the query, nquery, and yquery functions.
1145 Ask user a y-or-n question and return 0 if answer is no, 1 if
1146 answer is yes, or default the answer to the specified default
1147 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1148 default answer, or '\0' for no default.
1149 CTLSTR is the control string and should end in "? ". It should
1150 not say how to answer, because we do that.
1151 ARGS are the arguments passed along with the CTLSTR argument to
1154 static int ATTRIBUTE_PRINTF (1, 0)
1155 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
1161 char def_answer
, not_def_answer
;
1162 char *y_string
, *n_string
, *question
;
1163 /* Used to add duration we waited for user to respond to
1164 prompt_for_continue_wait_time. */
1165 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1167 /* Set up according to which answer is the default. */
1168 if (defchar
== '\0')
1172 not_def_answer
= 'N';
1176 else if (defchar
== 'y')
1180 not_def_answer
= 'N';
1188 not_def_answer
= 'Y';
1193 /* Automatically answer the default value if the user did not want
1194 prompts or the command was issued with the server prefix. */
1195 if (!confirm
|| server_command
)
1198 /* If input isn't coming from the user directly, just say what
1199 question we're asking, and then answer the default automatically. This
1200 way, important error messages don't get lost when talking to GDB
1202 if (! input_from_terminal_p ())
1205 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
1207 printf_filtered (_("(%s or %s) [answered %c; "
1208 "input not from terminal]\n"),
1209 y_string
, n_string
, def_answer
);
1210 gdb_flush (gdb_stdout
);
1215 if (deprecated_query_hook
)
1217 return deprecated_query_hook (ctlstr
, args
);
1220 /* Format the question outside of the loop, to avoid reusing args. */
1221 question
= xstrvprintf (ctlstr
, args
);
1223 /* Used for calculating time spend waiting for user. */
1224 gettimeofday (&prompt_started
, NULL
);
1228 wrap_here (""); /* Flush any buffered output. */
1229 gdb_flush (gdb_stdout
);
1231 if (annotation_level
> 1)
1232 printf_filtered (("\n\032\032pre-query\n"));
1234 fputs_filtered (question
, gdb_stdout
);
1235 printf_filtered (_("(%s or %s) "), y_string
, n_string
);
1237 if (annotation_level
> 1)
1238 printf_filtered (("\n\032\032query\n"));
1241 gdb_flush (gdb_stdout
);
1243 answer
= fgetc (stdin
);
1245 /* We expect fgetc to block until a character is read. But
1246 this may not be the case if the terminal was opened with
1247 the NONBLOCK flag. In that case, if there is nothing to
1248 read on stdin, fgetc returns EOF, but also sets the error
1249 condition flag on stdin and errno to EAGAIN. With a true
1250 EOF, stdin's error condition flag is not set.
1252 A situation where this behavior was observed is a pseudo
1254 while (answer
== EOF
&& ferror (stdin
) && errno
== EAGAIN
)
1256 /* Not a real EOF. Wait a little while and try again until
1257 we read something. */
1260 answer
= fgetc (stdin
);
1263 clearerr (stdin
); /* in case of C-d */
1264 if (answer
== EOF
) /* C-d */
1266 printf_filtered ("EOF [assumed %c]\n", def_answer
);
1270 /* Eat rest of input line, to EOF or newline. */
1274 ans2
= fgetc (stdin
);
1277 while (ans2
!= EOF
&& ans2
!= '\n' && ans2
!= '\r');
1281 /* Check answer. For the non-default, the user must specify
1282 the non-default explicitly. */
1283 if (answer
== not_def_answer
)
1285 retval
= !def_value
;
1288 /* Otherwise, if a default was specified, the user may either
1289 specify the required input or have it default by entering
1291 if (answer
== def_answer
1292 || (defchar
!= '\0' &&
1293 (answer
== '\n' || answer
== '\r' || answer
== EOF
)))
1298 /* Invalid entries are not defaulted and require another selection. */
1299 printf_filtered (_("Please answer %s or %s.\n"),
1300 y_string
, n_string
);
1303 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1304 gettimeofday (&prompt_ended
, NULL
);
1305 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1306 timeval_add (&prompt_for_continue_wait_time
,
1307 &prompt_for_continue_wait_time
, &prompt_delta
);
1310 if (annotation_level
> 1)
1311 printf_filtered (("\n\032\032post-query\n"));
1316 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1317 answer is yes, or 0 if answer is defaulted.
1318 Takes three args which are given to printf to print the question.
1319 The first, a control string, should end in "? ".
1320 It should not say how to answer, because we do that. */
1323 nquery (const char *ctlstr
, ...)
1328 va_start (args
, ctlstr
);
1329 ret
= defaulted_query (ctlstr
, 'n', args
);
1334 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1335 answer is yes, or 1 if answer is defaulted.
1336 Takes three args which are given to printf to print the question.
1337 The first, a control string, should end in "? ".
1338 It should not say how to answer, because we do that. */
1341 yquery (const char *ctlstr
, ...)
1346 va_start (args
, ctlstr
);
1347 ret
= defaulted_query (ctlstr
, 'y', args
);
1352 /* Ask user a y-or-n question and return 1 iff answer is yes.
1353 Takes three args which are given to printf to print the question.
1354 The first, a control string, should end in "? ".
1355 It should not say how to answer, because we do that. */
1358 query (const char *ctlstr
, ...)
1363 va_start (args
, ctlstr
);
1364 ret
= defaulted_query (ctlstr
, '\0', args
);
1369 /* A helper for parse_escape that converts a host character to a
1370 target character. C is the host character. If conversion is
1371 possible, then the target character is stored in *TARGET_C and the
1372 function returns 1. Otherwise, the function returns 0. */
1375 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1377 struct obstack host_data
;
1379 struct cleanup
*cleanups
;
1382 obstack_init (&host_data
);
1383 cleanups
= make_cleanup_obstack_free (&host_data
);
1385 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1386 (gdb_byte
*) &the_char
, 1, 1,
1387 &host_data
, translit_none
);
1389 if (obstack_object_size (&host_data
) == 1)
1392 *target_c
= *(char *) obstack_base (&host_data
);
1395 do_cleanups (cleanups
);
1399 /* Parse a C escape sequence. STRING_PTR points to a variable
1400 containing a pointer to the string to parse. That pointer
1401 should point to the character after the \. That pointer
1402 is updated past the characters we use. The value of the
1403 escape sequence is returned.
1405 A negative value means the sequence \ newline was seen,
1406 which is supposed to be equivalent to nothing at all.
1408 If \ is followed by a null character, we return a negative
1409 value and leave the string pointer pointing at the null character.
1411 If \ is followed by 000, we return 0 and leave the string pointer
1412 after the zeros. A value of 0 does not mean end of string. */
1415 parse_escape (struct gdbarch
*gdbarch
, char **string_ptr
)
1417 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1418 int c
= *(*string_ptr
)++;
1437 int i
= host_hex_value (c
);
1442 if (isdigit (c
) && c
!= '8' && c
!= '9')
1446 i
+= host_hex_value (c
);
1482 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1483 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1484 " which has no equivalent\nin the `%s' character set."),
1485 c
, c
, target_charset (gdbarch
));
1489 /* Print the character C on STREAM as part of the contents of a literal
1490 string whose delimiter is QUOTER. Note that this routine should only
1491 be call for printing things which are independent of the language
1492 of the program being debugged. */
1495 printchar (int c
, void (*do_fputs
) (const char *, struct ui_file
*),
1496 void (*do_fprintf
) (struct ui_file
*, const char *, ...)
1497 ATTRIBUTE_FPTR_PRINTF_2
, struct ui_file
*stream
, int quoter
)
1499 c
&= 0xFF; /* Avoid sign bit follies */
1501 if (c
< 0x20 || /* Low control chars */
1502 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1503 (sevenbit_strings
&& c
>= 0x80))
1504 { /* high order bit set */
1508 do_fputs ("\\n", stream
);
1511 do_fputs ("\\b", stream
);
1514 do_fputs ("\\t", stream
);
1517 do_fputs ("\\f", stream
);
1520 do_fputs ("\\r", stream
);
1523 do_fputs ("\\e", stream
);
1526 do_fputs ("\\a", stream
);
1529 do_fprintf (stream
, "\\%.3o", (unsigned int) c
);
1535 if (c
== '\\' || c
== quoter
)
1536 do_fputs ("\\", stream
);
1537 do_fprintf (stream
, "%c", c
);
1541 /* Print the character C on STREAM as part of the contents of a
1542 literal string whose delimiter is QUOTER. Note that these routines
1543 should only be call for printing things which are independent of
1544 the language of the program being debugged. */
1547 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1550 printchar (*str
++, fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1554 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1557 printchar (*str
++, fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1561 fputstrn_filtered (const char *str
, int n
, int quoter
,
1562 struct ui_file
*stream
)
1566 for (i
= 0; i
< n
; i
++)
1567 printchar (str
[i
], fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1571 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1572 struct ui_file
*stream
)
1576 for (i
= 0; i
< n
; i
++)
1577 printchar (str
[i
], fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1581 /* Number of lines per page or UINT_MAX if paging is disabled. */
1582 static unsigned int lines_per_page
;
1584 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1585 struct cmd_list_element
*c
, const char *value
)
1587 fprintf_filtered (file
,
1588 _("Number of lines gdb thinks are in a page is %s.\n"),
1592 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1593 static unsigned int chars_per_line
;
1595 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1596 struct cmd_list_element
*c
, const char *value
)
1598 fprintf_filtered (file
,
1599 _("Number of characters gdb thinks "
1600 "are in a line is %s.\n"),
1604 /* Current count of lines printed on this page, chars on this line. */
1605 static unsigned int lines_printed
, chars_printed
;
1607 /* Buffer and start column of buffered text, for doing smarter word-
1608 wrapping. When someone calls wrap_here(), we start buffering output
1609 that comes through fputs_filtered(). If we see a newline, we just
1610 spit it out and forget about the wrap_here(). If we see another
1611 wrap_here(), we spit it out and remember the newer one. If we see
1612 the end of the line, we spit out a newline, the indent, and then
1613 the buffered output. */
1615 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1616 are waiting to be output (they have already been counted in chars_printed).
1617 When wrap_buffer[0] is null, the buffer is empty. */
1618 static char *wrap_buffer
;
1620 /* Pointer in wrap_buffer to the next character to fill. */
1621 static char *wrap_pointer
;
1623 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1625 static char *wrap_indent
;
1627 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1628 is not in effect. */
1629 static int wrap_column
;
1632 /* Inialize the number of lines per page and chars per line. */
1635 init_page_info (void)
1639 lines_per_page
= UINT_MAX
;
1640 chars_per_line
= UINT_MAX
;
1644 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1649 #if defined(__GO32__)
1650 rows
= ScreenRows ();
1651 cols
= ScreenCols ();
1652 lines_per_page
= rows
;
1653 chars_per_line
= cols
;
1655 /* Make sure Readline has initialized its terminal settings. */
1656 rl_reset_terminal (NULL
);
1658 /* Get the screen size from Readline. */
1659 rl_get_screen_size (&rows
, &cols
);
1660 lines_per_page
= rows
;
1661 chars_per_line
= cols
;
1663 /* Readline should have fetched the termcap entry for us. */
1664 if (tgetnum ("li") < 0 || getenv ("EMACS"))
1666 /* The number of lines per page is not mentioned in the
1667 terminal description. This probably means that paging is
1668 not useful (e.g. emacs shell window), so disable paging. */
1669 lines_per_page
= UINT_MAX
;
1672 /* If the output is not a terminal, don't paginate it. */
1673 if (!ui_file_isatty (gdb_stdout
))
1674 lines_per_page
= UINT_MAX
;
1682 /* Helper for make_cleanup_restore_page_info. */
1685 do_restore_page_info_cleanup (void *arg
)
1691 /* Provide cleanup for restoring the terminal size. */
1694 make_cleanup_restore_page_info (void)
1696 struct cleanup
*back_to
;
1698 back_to
= make_cleanup (do_restore_page_info_cleanup
, NULL
);
1699 make_cleanup_restore_uinteger (&lines_per_page
);
1700 make_cleanup_restore_uinteger (&chars_per_line
);
1705 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1706 Provide cleanup for restoring the original state. */
1709 set_batch_flag_and_make_cleanup_restore_page_info (void)
1711 struct cleanup
*back_to
= make_cleanup_restore_page_info ();
1713 make_cleanup_restore_integer (&batch_flag
);
1720 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1723 set_screen_size (void)
1725 int rows
= lines_per_page
;
1726 int cols
= chars_per_line
;
1734 /* Update Readline's idea of the terminal size. */
1735 rl_set_screen_size (rows
, cols
);
1738 /* Reinitialize WRAP_BUFFER according to the current value of
1744 if (chars_per_line
== 0)
1749 wrap_buffer
= (char *) xmalloc (chars_per_line
+ 2);
1750 wrap_buffer
[0] = '\0';
1753 wrap_buffer
= (char *) xrealloc (wrap_buffer
, chars_per_line
+ 2);
1754 wrap_pointer
= wrap_buffer
; /* Start it at the beginning. */
1758 set_width_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1765 set_height_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1770 /* Wait, so the user can read what's on the screen. Prompt the user
1771 to continue by pressing RETURN. */
1774 prompt_for_continue (void)
1777 char cont_prompt
[120];
1778 /* Used to add duration we waited for user to respond to
1779 prompt_for_continue_wait_time. */
1780 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1782 gettimeofday (&prompt_started
, NULL
);
1784 if (annotation_level
> 1)
1785 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1787 strcpy (cont_prompt
,
1788 "---Type <return> to continue, or q <return> to quit---");
1789 if (annotation_level
> 1)
1790 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1792 /* We must do this *before* we call gdb_readline, else it will eventually
1793 call us -- thinking that we're trying to print beyond the end of the
1795 reinitialize_more_filter ();
1799 /* On a real operating system, the user can quit with SIGINT.
1802 'q' is provided on all systems so users don't have to change habits
1803 from system to system, and because telling them what to do in
1804 the prompt is more user-friendly than expecting them to think of
1806 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1807 whereas control-C to gdb_readline will cause the user to get dumped
1809 ignore
= gdb_readline_wrapper (cont_prompt
);
1811 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1812 gettimeofday (&prompt_ended
, NULL
);
1813 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1814 timeval_add (&prompt_for_continue_wait_time
,
1815 &prompt_for_continue_wait_time
, &prompt_delta
);
1817 if (annotation_level
> 1)
1818 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1824 while (*p
== ' ' || *p
== '\t')
1832 /* Now we have to do this again, so that GDB will know that it doesn't
1833 need to save the ---Type <return>--- line at the top of the screen. */
1834 reinitialize_more_filter ();
1836 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1839 /* Initalize timer to keep track of how long we waited for the user. */
1842 reset_prompt_for_continue_wait_time (void)
1844 static const struct timeval zero_timeval
= { 0 };
1846 prompt_for_continue_wait_time
= zero_timeval
;
1849 /* Fetch the cumulative time spent in prompt_for_continue. */
1852 get_prompt_for_continue_wait_time (void)
1854 return prompt_for_continue_wait_time
;
1857 /* Reinitialize filter; ie. tell it to reset to original values. */
1860 reinitialize_more_filter (void)
1866 /* Indicate that if the next sequence of characters overflows the line,
1867 a newline should be inserted here rather than when it hits the end.
1868 If INDENT is non-null, it is a string to be printed to indent the
1869 wrapped part on the next line. INDENT must remain accessible until
1870 the next call to wrap_here() or until a newline is printed through
1873 If the line is already overfull, we immediately print a newline and
1874 the indentation, and disable further wrapping.
1876 If we don't know the width of lines, but we know the page height,
1877 we must not wrap words, but should still keep track of newlines
1878 that were explicitly printed.
1880 INDENT should not contain tabs, as that will mess up the char count
1881 on the next line. FIXME.
1883 This routine is guaranteed to force out any output which has been
1884 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1885 used to force out output from the wrap_buffer. */
1888 wrap_here (char *indent
)
1890 /* This should have been allocated, but be paranoid anyway. */
1892 internal_error (__FILE__
, __LINE__
,
1893 _("failed internal consistency check"));
1897 *wrap_pointer
= '\0';
1898 fputs_unfiltered (wrap_buffer
, gdb_stdout
);
1900 wrap_pointer
= wrap_buffer
;
1901 wrap_buffer
[0] = '\0';
1902 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1906 else if (chars_printed
>= chars_per_line
)
1908 puts_filtered ("\n");
1910 puts_filtered (indent
);
1915 wrap_column
= chars_printed
;
1919 wrap_indent
= indent
;
1923 /* Print input string to gdb_stdout, filtered, with wrap,
1924 arranging strings in columns of n chars. String can be
1925 right or left justified in the column. Never prints
1926 trailing spaces. String should never be longer than
1927 width. FIXME: this could be useful for the EXAMINE
1928 command, which currently doesn't tabulate very well. */
1931 puts_filtered_tabular (char *string
, int width
, int right
)
1937 gdb_assert (chars_per_line
> 0);
1938 if (chars_per_line
== UINT_MAX
)
1940 fputs_filtered (string
, gdb_stdout
);
1941 fputs_filtered ("\n", gdb_stdout
);
1945 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1946 fputs_filtered ("\n", gdb_stdout
);
1948 if (width
>= chars_per_line
)
1949 width
= chars_per_line
- 1;
1951 stringlen
= strlen (string
);
1953 if (chars_printed
> 0)
1954 spaces
= width
- (chars_printed
- 1) % width
- 1;
1956 spaces
+= width
- stringlen
;
1958 spacebuf
= alloca (spaces
+ 1);
1959 spacebuf
[spaces
] = '\0';
1961 spacebuf
[spaces
] = ' ';
1963 fputs_filtered (spacebuf
, gdb_stdout
);
1964 fputs_filtered (string
, gdb_stdout
);
1968 /* Ensure that whatever gets printed next, using the filtered output
1969 commands, starts at the beginning of the line. I.e. if there is
1970 any pending output for the current line, flush it and start a new
1971 line. Otherwise do nothing. */
1976 if (chars_printed
> 0)
1978 puts_filtered ("\n");
1983 /* Like fputs but if FILTER is true, pause after every screenful.
1985 Regardless of FILTER can wrap at points other than the final
1986 character of a line.
1988 Unlike fputs, fputs_maybe_filtered does not return a value.
1989 It is OK for LINEBUFFER to be NULL, in which case just don't print
1992 Note that a longjmp to top level may occur in this routine (only if
1993 FILTER is true) (since prompt_for_continue may do so) so this
1994 routine should not be called when cleanups are not in place. */
1997 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
2000 const char *lineptr
;
2002 if (linebuffer
== 0)
2005 /* Don't do any filtering if it is disabled. */
2006 if (stream
!= gdb_stdout
2007 || !pagination_enabled
2009 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
2010 || top_level_interpreter () == NULL
2011 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2013 fputs_unfiltered (linebuffer
, stream
);
2017 /* Go through and output each character. Show line extension
2018 when this is necessary; prompt user for new page when this is
2021 lineptr
= linebuffer
;
2024 /* Possible new page. */
2025 if (filter
&& (lines_printed
>= lines_per_page
- 1))
2026 prompt_for_continue ();
2028 while (*lineptr
&& *lineptr
!= '\n')
2030 /* Print a single line. */
2031 if (*lineptr
== '\t')
2034 *wrap_pointer
++ = '\t';
2036 fputc_unfiltered ('\t', stream
);
2037 /* Shifting right by 3 produces the number of tab stops
2038 we have already passed, and then adding one and
2039 shifting left 3 advances to the next tab stop. */
2040 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
2046 *wrap_pointer
++ = *lineptr
;
2048 fputc_unfiltered (*lineptr
, stream
);
2053 if (chars_printed
>= chars_per_line
)
2055 unsigned int save_chars
= chars_printed
;
2059 /* If we aren't actually wrapping, don't output newline --
2060 if chars_per_line is right, we probably just overflowed
2061 anyway; if it's wrong, let us keep going. */
2063 fputc_unfiltered ('\n', stream
);
2065 /* Possible new page. */
2066 if (lines_printed
>= lines_per_page
- 1)
2067 prompt_for_continue ();
2069 /* Now output indentation and wrapped string. */
2072 fputs_unfiltered (wrap_indent
, stream
);
2073 *wrap_pointer
= '\0'; /* Null-terminate saved stuff, */
2074 fputs_unfiltered (wrap_buffer
, stream
); /* and eject it. */
2075 /* FIXME, this strlen is what prevents wrap_indent from
2076 containing tabs. However, if we recurse to print it
2077 and count its chars, we risk trouble if wrap_indent is
2078 longer than (the user settable) chars_per_line.
2079 Note also that this can set chars_printed > chars_per_line
2080 if we are printing a long string. */
2081 chars_printed
= strlen (wrap_indent
)
2082 + (save_chars
- wrap_column
);
2083 wrap_pointer
= wrap_buffer
; /* Reset buffer */
2084 wrap_buffer
[0] = '\0';
2085 wrap_column
= 0; /* And disable fancy wrap */
2090 if (*lineptr
== '\n')
2093 wrap_here ((char *) 0); /* Spit out chars, cancel
2096 fputc_unfiltered ('\n', stream
);
2103 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
2105 fputs_maybe_filtered (linebuffer
, stream
, 1);
2109 putchar_unfiltered (int c
)
2113 ui_file_write (gdb_stdout
, &buf
, 1);
2117 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2118 May return nonlocally. */
2121 putchar_filtered (int c
)
2123 return fputc_filtered (c
, gdb_stdout
);
2127 fputc_unfiltered (int c
, struct ui_file
*stream
)
2131 ui_file_write (stream
, &buf
, 1);
2136 fputc_filtered (int c
, struct ui_file
*stream
)
2142 fputs_filtered (buf
, stream
);
2146 /* puts_debug is like fputs_unfiltered, except it prints special
2147 characters in printable fashion. */
2150 puts_debug (char *prefix
, char *string
, char *suffix
)
2154 /* Print prefix and suffix after each line. */
2155 static int new_line
= 1;
2156 static int return_p
= 0;
2157 static char *prev_prefix
= "";
2158 static char *prev_suffix
= "";
2160 if (*string
== '\n')
2163 /* If the prefix is changing, print the previous suffix, a new line,
2164 and the new prefix. */
2165 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
2167 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
2168 fputs_unfiltered ("\n", gdb_stdlog
);
2169 fputs_unfiltered (prefix
, gdb_stdlog
);
2172 /* Print prefix if we printed a newline during the previous call. */
2176 fputs_unfiltered (prefix
, gdb_stdlog
);
2179 prev_prefix
= prefix
;
2180 prev_suffix
= suffix
;
2182 /* Output characters in a printable format. */
2183 while ((ch
= *string
++) != '\0')
2189 fputc_unfiltered (ch
, gdb_stdlog
);
2192 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2196 fputs_unfiltered ("\\\\", gdb_stdlog
);
2199 fputs_unfiltered ("\\b", gdb_stdlog
);
2202 fputs_unfiltered ("\\f", gdb_stdlog
);
2206 fputs_unfiltered ("\\n", gdb_stdlog
);
2209 fputs_unfiltered ("\\r", gdb_stdlog
);
2212 fputs_unfiltered ("\\t", gdb_stdlog
);
2215 fputs_unfiltered ("\\v", gdb_stdlog
);
2219 return_p
= ch
== '\r';
2222 /* Print suffix if we printed a newline. */
2225 fputs_unfiltered (suffix
, gdb_stdlog
);
2226 fputs_unfiltered ("\n", gdb_stdlog
);
2231 /* Print a variable number of ARGS using format FORMAT. If this
2232 information is going to put the amount written (since the last call
2233 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2234 call prompt_for_continue to get the users permision to continue.
2236 Unlike fprintf, this function does not return a value.
2238 We implement three variants, vfprintf (takes a vararg list and stream),
2239 fprintf (takes a stream to write on), and printf (the usual).
2241 Note also that a longjmp to top level may occur in this routine
2242 (since prompt_for_continue may do so) so this routine should not be
2243 called when cleanups are not in place. */
2246 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2247 va_list args
, int filter
)
2250 struct cleanup
*old_cleanups
;
2252 linebuffer
= xstrvprintf (format
, args
);
2253 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2254 fputs_maybe_filtered (linebuffer
, stream
, filter
);
2255 do_cleanups (old_cleanups
);
2260 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2262 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2266 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2269 struct cleanup
*old_cleanups
;
2271 linebuffer
= xstrvprintf (format
, args
);
2272 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2273 if (debug_timestamp
&& stream
== gdb_stdlog
)
2279 gettimeofday (&tm
, NULL
);
2281 len
= strlen (linebuffer
);
2282 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2284 timestamp
= xstrprintf ("%ld:%ld %s%s",
2285 (long) tm
.tv_sec
, (long) tm
.tv_usec
,
2287 need_nl
? "\n": "");
2288 make_cleanup (xfree
, timestamp
);
2289 fputs_unfiltered (timestamp
, stream
);
2292 fputs_unfiltered (linebuffer
, stream
);
2293 do_cleanups (old_cleanups
);
2297 vprintf_filtered (const char *format
, va_list args
)
2299 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2303 vprintf_unfiltered (const char *format
, va_list args
)
2305 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2309 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2313 va_start (args
, format
);
2314 vfprintf_filtered (stream
, format
, args
);
2319 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2323 va_start (args
, format
);
2324 vfprintf_unfiltered (stream
, format
, args
);
2328 /* Like fprintf_filtered, but prints its result indented.
2329 Called as fprintfi_filtered (spaces, stream, format, ...); */
2332 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2337 va_start (args
, format
);
2338 print_spaces_filtered (spaces
, stream
);
2340 vfprintf_filtered (stream
, format
, args
);
2346 printf_filtered (const char *format
, ...)
2350 va_start (args
, format
);
2351 vfprintf_filtered (gdb_stdout
, format
, args
);
2357 printf_unfiltered (const char *format
, ...)
2361 va_start (args
, format
);
2362 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2366 /* Like printf_filtered, but prints it's result indented.
2367 Called as printfi_filtered (spaces, format, ...); */
2370 printfi_filtered (int spaces
, const char *format
, ...)
2374 va_start (args
, format
);
2375 print_spaces_filtered (spaces
, gdb_stdout
);
2376 vfprintf_filtered (gdb_stdout
, format
, args
);
2380 /* Easy -- but watch out!
2382 This routine is *not* a replacement for puts()! puts() appends a newline.
2383 This one doesn't, and had better not! */
2386 puts_filtered (const char *string
)
2388 fputs_filtered (string
, gdb_stdout
);
2392 puts_unfiltered (const char *string
)
2394 fputs_unfiltered (string
, gdb_stdout
);
2397 /* Return a pointer to N spaces and a null. The pointer is good
2398 until the next call to here. */
2403 static char *spaces
= 0;
2404 static int max_spaces
= -1;
2410 spaces
= (char *) xmalloc (n
+ 1);
2411 for (t
= spaces
+ n
; t
!= spaces
;)
2417 return spaces
+ max_spaces
- n
;
2420 /* Print N spaces. */
2422 print_spaces_filtered (int n
, struct ui_file
*stream
)
2424 fputs_filtered (n_spaces (n
), stream
);
2427 /* C++/ObjC demangler stuff. */
2429 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2430 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2431 If the name is not mangled, or the language for the name is unknown, or
2432 demangling is off, the name is printed in its "raw" form. */
2435 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2436 enum language lang
, int arg_mode
)
2442 /* If user wants to see raw output, no problem. */
2445 fputs_filtered (name
, stream
);
2449 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2450 fputs_filtered (demangled
? demangled
: name
, stream
);
2451 if (demangled
!= NULL
)
2459 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2460 differences in whitespace. Returns 0 if they match, non-zero if they
2461 don't (slightly different than strcmp()'s range of return values).
2463 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2464 This "feature" is useful when searching for matching C++ function names
2465 (such as if the user types 'break FOO', where FOO is a mangled C++
2469 strcmp_iw (const char *string1
, const char *string2
)
2471 while ((*string1
!= '\0') && (*string2
!= '\0'))
2473 while (isspace (*string1
))
2477 while (isspace (*string2
))
2481 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2483 if (case_sensitivity
== case_sensitive_off
2484 && (tolower ((unsigned char) *string1
)
2485 != tolower ((unsigned char) *string2
)))
2487 if (*string1
!= '\0')
2493 return (*string1
!= '\0' && *string1
!= '(') || (*string2
!= '\0');
2496 /* This is like strcmp except that it ignores whitespace and treats
2497 '(' as the first non-NULL character in terms of ordering. Like
2498 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2499 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2500 according to that ordering.
2502 If a list is sorted according to this function and if you want to
2503 find names in the list that match some fixed NAME according to
2504 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2505 where this function would put NAME.
2507 This function must be neutral to the CASE_SENSITIVITY setting as the user
2508 may choose it during later lookup. Therefore this function always sorts
2509 primarily case-insensitively and secondarily case-sensitively.
2511 Here are some examples of why using strcmp to sort is a bad idea:
2515 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2516 we try to do a search for "foo<char*>", strcmp will locate this
2517 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2518 will start looking at strings beginning with "goo", and will never
2519 see the correct match of "foo<char *>".
2521 Parenthesis example:
2523 In practice, this is less like to be an issue, but I'll give it a
2524 shot. Let's assume that '$' is a legitimate character to occur in
2525 symbols. (Which may well even be the case on some systems.) Then
2526 say that the partial symbol table contains "foo$" and "foo(int)".
2527 strcmp will put them in this order, since '$' < '('. Now, if the
2528 user searches for "foo", then strcmp will sort "foo" before "foo$".
2529 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2530 "foo") is false, so it won't proceed to the actual match of
2531 "foo(int)" with "foo". */
2534 strcmp_iw_ordered (const char *string1
, const char *string2
)
2536 const char *saved_string1
= string1
, *saved_string2
= string2
;
2537 enum case_sensitivity case_pass
= case_sensitive_off
;
2541 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2542 Provide stub characters if we are already at the end of one of the
2544 char c1
= 'X', c2
= 'X';
2546 while (*string1
!= '\0' && *string2
!= '\0')
2548 while (isspace (*string1
))
2550 while (isspace (*string2
))
2555 case case_sensitive_off
:
2556 c1
= tolower ((unsigned char) *string1
);
2557 c2
= tolower ((unsigned char) *string2
);
2559 case case_sensitive_on
:
2567 if (*string1
!= '\0')
2576 /* Characters are non-equal unless they're both '\0'; we want to
2577 make sure we get the comparison right according to our
2578 comparison in the cases where one of them is '\0' or '('. */
2580 if (*string2
== '\0')
2585 if (*string2
== '\0')
2590 if (*string2
== '\0' || *string2
== '(')
2599 if (case_pass
== case_sensitive_on
)
2602 /* Otherwise the strings were equal in case insensitive way, make
2603 a more fine grained comparison in a case sensitive way. */
2605 case_pass
= case_sensitive_on
;
2606 string1
= saved_string1
;
2607 string2
= saved_string2
;
2611 /* A simple comparison function with opposite semantics to strcmp. */
2614 streq (const char *lhs
, const char *rhs
)
2616 return !strcmp (lhs
, rhs
);
2622 ** Answer whether string_to_compare is a full or partial match to
2623 ** template_string. The partial match must be in sequence starting
2627 subset_compare (char *string_to_compare
, char *template_string
)
2631 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
2632 && strlen (string_to_compare
) <= strlen (template_string
))
2635 (template_string
, string_to_compare
, strlen (string_to_compare
)) == 0);
2642 pagination_on_command (char *arg
, int from_tty
)
2644 pagination_enabled
= 1;
2648 pagination_off_command (char *arg
, int from_tty
)
2650 pagination_enabled
= 0;
2654 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2655 struct cmd_list_element
*c
, const char *value
)
2657 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2663 initialize_utils (void)
2665 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
2666 Set number of characters where GDB should wrap lines of its output."), _("\
2667 Show number of characters where GDB should wrap lines of its output."), _("\
2668 This affects where GDB wraps its output to fit the screen width.\n\
2669 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2671 show_chars_per_line
,
2672 &setlist
, &showlist
);
2674 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
2675 Set number of lines in a page for GDB output pagination."), _("\
2676 Show number of lines in a page for GDB output pagination."), _("\
2677 This affects the number of lines after which GDB will pause\n\
2678 its output and ask you whether to continue.\n\
2679 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2681 show_lines_per_page
,
2682 &setlist
, &showlist
);
2686 add_setshow_boolean_cmd ("pagination", class_support
,
2687 &pagination_enabled
, _("\
2688 Set state of GDB output pagination."), _("\
2689 Show state of GDB output pagination."), _("\
2690 When pagination is ON, GDB pauses at end of each screenful of\n\
2691 its output and asks you whether to continue.\n\
2692 Turning pagination off is an alternative to \"set height unlimited\"."),
2694 show_pagination_enabled
,
2695 &setlist
, &showlist
);
2699 add_com ("am", class_support
, pagination_on_command
,
2700 _("Enable pagination"));
2701 add_com ("sm", class_support
, pagination_off_command
,
2702 _("Disable pagination"));
2705 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
2706 &sevenbit_strings
, _("\
2707 Set printing of 8-bit characters in strings as \\nnn."), _("\
2708 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
2710 show_sevenbit_strings
,
2711 &setprintlist
, &showprintlist
);
2713 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
2714 &debug_timestamp
, _("\
2715 Set timestamping of debugging messages."), _("\
2716 Show timestamping of debugging messages."), _("\
2717 When set, debugging messages will be marked with seconds and microseconds."),
2719 show_debug_timestamp
,
2720 &setdebuglist
, &showdebuglist
);
2723 /* Print routines to handle variable size regs, etc. */
2724 /* Temporary storage using circular buffer. */
2730 static char buf
[NUMCELLS
][CELLSIZE
];
2731 static int cell
= 0;
2733 if (++cell
>= NUMCELLS
)
2739 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2741 /* Truncate address to the size of a target address, avoiding shifts
2742 larger or equal than the width of a CORE_ADDR. The local
2743 variable ADDR_BIT stops the compiler reporting a shift overflow
2744 when it won't occur. */
2745 /* NOTE: This assumes that the significant address information is
2746 kept in the least significant bits of ADDR - the upper bits were
2747 either zero or sign extended. Should gdbarch_address_to_pointer or
2748 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2750 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2752 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2753 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2754 return hex_string (addr
);
2757 /* This function is described in "defs.h". */
2760 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2762 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2764 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2765 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2767 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2768 that returns the language localized string formatted to a width
2769 based on gdbarch_addr_bit. */
2771 return hex_string_custom (address
, 8);
2773 return hex_string_custom (address
, 16);
2776 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2779 core_addr_hash (const void *ap
)
2781 const CORE_ADDR
*addrp
= ap
;
2786 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2789 core_addr_eq (const void *ap
, const void *bp
)
2791 const CORE_ADDR
*addr_ap
= ap
;
2792 const CORE_ADDR
*addr_bp
= bp
;
2794 return *addr_ap
== *addr_bp
;
2798 decimal2str (char *sign
, ULONGEST addr
, int width
)
2800 /* Steal code from valprint.c:print_decimal(). Should this worry
2801 about the real size of addr as the above does? */
2802 unsigned long temp
[3];
2803 char *str
= get_cell ();
2808 temp
[i
] = addr
% (1000 * 1000 * 1000);
2809 addr
/= (1000 * 1000 * 1000);
2813 while (addr
!= 0 && i
< (sizeof (temp
) / sizeof (temp
[0])));
2822 xsnprintf (str
, CELLSIZE
, "%s%0*lu", sign
, width
, temp
[0]);
2825 xsnprintf (str
, CELLSIZE
, "%s%0*lu%09lu", sign
, width
,
2829 xsnprintf (str
, CELLSIZE
, "%s%0*lu%09lu%09lu", sign
, width
,
2830 temp
[2], temp
[1], temp
[0]);
2833 internal_error (__FILE__
, __LINE__
,
2834 _("failed internal consistency check"));
2841 octal2str (ULONGEST addr
, int width
)
2843 unsigned long temp
[3];
2844 char *str
= get_cell ();
2849 temp
[i
] = addr
% (0100000 * 0100000);
2850 addr
/= (0100000 * 0100000);
2854 while (addr
!= 0 && i
< (sizeof (temp
) / sizeof (temp
[0])));
2864 xsnprintf (str
, CELLSIZE
, "%*o", width
, 0);
2866 xsnprintf (str
, CELLSIZE
, "0%0*lo", width
, temp
[0]);
2869 xsnprintf (str
, CELLSIZE
, "0%0*lo%010lo", width
, temp
[1], temp
[0]);
2872 xsnprintf (str
, CELLSIZE
, "0%0*lo%010lo%010lo", width
,
2873 temp
[2], temp
[1], temp
[0]);
2876 internal_error (__FILE__
, __LINE__
,
2877 _("failed internal consistency check"));
2884 pulongest (ULONGEST u
)
2886 return decimal2str ("", u
, 0);
2890 plongest (LONGEST l
)
2893 return decimal2str ("-", -l
, 0);
2895 return decimal2str ("", l
, 0);
2898 /* Eliminate warning from compiler on 32-bit systems. */
2899 static int thirty_two
= 32;
2902 phex (ULONGEST l
, int sizeof_l
)
2910 xsnprintf (str
, CELLSIZE
, "%08lx%08lx",
2911 (unsigned long) (l
>> thirty_two
),
2912 (unsigned long) (l
& 0xffffffff));
2916 xsnprintf (str
, CELLSIZE
, "%08lx", (unsigned long) l
);
2920 xsnprintf (str
, CELLSIZE
, "%04x", (unsigned short) (l
& 0xffff));
2923 str
= phex (l
, sizeof (l
));
2931 phex_nz (ULONGEST l
, int sizeof_l
)
2939 unsigned long high
= (unsigned long) (l
>> thirty_two
);
2943 xsnprintf (str
, CELLSIZE
, "%lx",
2944 (unsigned long) (l
& 0xffffffff));
2946 xsnprintf (str
, CELLSIZE
, "%lx%08lx", high
,
2947 (unsigned long) (l
& 0xffffffff));
2952 xsnprintf (str
, CELLSIZE
, "%lx", (unsigned long) l
);
2956 xsnprintf (str
, CELLSIZE
, "%x", (unsigned short) (l
& 0xffff));
2959 str
= phex_nz (l
, sizeof (l
));
2966 /* Converts a LONGEST to a C-format hexadecimal literal and stores it
2967 in a static string. Returns a pointer to this string. */
2969 hex_string (LONGEST num
)
2971 char *result
= get_cell ();
2973 xsnprintf (result
, CELLSIZE
, "0x%s", phex_nz (num
, sizeof (num
)));
2977 /* Converts a LONGEST number to a C-format hexadecimal literal and
2978 stores it in a static string. Returns a pointer to this string
2979 that is valid until the next call. The number is padded on the
2980 left with 0s to at least WIDTH characters. */
2982 hex_string_custom (LONGEST num
, int width
)
2984 char *result
= get_cell ();
2985 char *result_end
= result
+ CELLSIZE
- 1;
2986 const char *hex
= phex_nz (num
, sizeof (num
));
2987 int hex_len
= strlen (hex
);
2989 if (hex_len
> width
)
2991 if (width
+ 2 >= CELLSIZE
)
2992 internal_error (__FILE__
, __LINE__
, _("\
2993 hex_string_custom: insufficient space to store result"));
2995 strcpy (result_end
- width
- 2, "0x");
2996 memset (result_end
- width
, '0', width
);
2997 strcpy (result_end
- hex_len
, hex
);
2998 return result_end
- width
- 2;
3001 /* Convert VAL to a numeral in the given radix. For
3002 * radix 10, IS_SIGNED may be true, indicating a signed quantity;
3003 * otherwise VAL is interpreted as unsigned. If WIDTH is supplied,
3004 * it is the minimum width (0-padded if needed). USE_C_FORMAT means
3005 * to use C format in all cases. If it is false, then 'x'
3006 * and 'o' formats do not include a prefix (0x or leading 0). */
3009 int_string (LONGEST val
, int radix
, int is_signed
, int width
,
3019 result
= hex_string (val
);
3021 result
= hex_string_custom (val
, width
);
3028 if (is_signed
&& val
< 0)
3029 return decimal2str ("-", -val
, width
);
3031 return decimal2str ("", val
, width
);
3035 char *result
= octal2str (val
, width
);
3037 if (use_c_format
|| val
== 0)
3043 internal_error (__FILE__
, __LINE__
,
3044 _("failed internal consistency check"));
3048 /* Convert a CORE_ADDR into a string. */
3050 core_addr_to_string (const CORE_ADDR addr
)
3052 char *str
= get_cell ();
3055 strcat (str
, phex (addr
, sizeof (addr
)));
3060 core_addr_to_string_nz (const CORE_ADDR addr
)
3062 char *str
= get_cell ();
3065 strcat (str
, phex_nz (addr
, sizeof (addr
)));
3069 /* Convert a string back into a CORE_ADDR. */
3071 string_to_core_addr (const char *my_string
)
3075 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
3077 /* Assume that it is in hex. */
3080 for (i
= 2; my_string
[i
] != '\0'; i
++)
3082 if (isdigit (my_string
[i
]))
3083 addr
= (my_string
[i
] - '0') + (addr
* 16);
3084 else if (isxdigit (my_string
[i
]))
3085 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
3087 error (_("invalid hex \"%s\""), my_string
);
3092 /* Assume that it is in decimal. */
3095 for (i
= 0; my_string
[i
] != '\0'; i
++)
3097 if (isdigit (my_string
[i
]))
3098 addr
= (my_string
[i
] - '0') + (addr
* 10);
3100 error (_("invalid decimal \"%s\""), my_string
);
3108 host_address_to_string (const void *addr
)
3110 char *str
= get_cell ();
3112 xsnprintf (str
, CELLSIZE
, "0x%s", phex_nz ((uintptr_t) addr
, sizeof (addr
)));
3117 gdb_realpath (const char *filename
)
3119 /* Method 1: The system has a compile time upper bound on a filename
3120 path. Use that and realpath() to canonicalize the name. This is
3121 the most common case. Note that, if there isn't a compile time
3122 upper bound, you want to avoid realpath() at all costs. */
3123 #if defined (HAVE_REALPATH) && defined (PATH_MAX)
3126 const char *rp
= realpath (filename
, buf
);
3130 return xstrdup (rp
);
3132 #endif /* HAVE_REALPATH */
3134 /* Method 2: The host system (i.e., GNU) has the function
3135 canonicalize_file_name() which malloc's a chunk of memory and
3136 returns that, use that. */
3137 #if defined(HAVE_CANONICALIZE_FILE_NAME)
3139 char *rp
= canonicalize_file_name (filename
);
3142 return xstrdup (filename
);
3148 /* FIXME: cagney/2002-11-13:
3150 Method 2a: Use realpath() with a NULL buffer. Some systems, due
3151 to the problems described in method 3, have modified their
3152 realpath() implementation so that it will allocate a buffer when
3153 NULL is passed in. Before this can be used, though, some sort of
3154 configure time test would need to be added. Otherwize the code
3155 will likely core dump. */
3157 /* Method 3: Now we're getting desperate! The system doesn't have a
3158 compile time buffer size and no alternative function. Query the
3159 OS, using pathconf(), for the buffer limit. Care is needed
3160 though, some systems do not limit PATH_MAX (return -1 for
3161 pathconf()) making it impossible to pass a correctly sized buffer
3162 to realpath() (it could always overflow). On those systems, we
3164 #if defined (HAVE_REALPATH) && defined (_PC_PATH_MAX) && defined(HAVE_ALLOCA)
3166 /* Find out the max path size. */
3167 long path_max
= pathconf ("/", _PC_PATH_MAX
);
3171 /* PATH_MAX is bounded. */
3172 char *buf
= alloca (path_max
);
3173 char *rp
= realpath (filename
, buf
);
3175 return xstrdup (rp
? rp
: filename
);
3180 /* The MS Windows method. If we don't have realpath, we assume we
3181 don't have symlinks and just canonicalize to a Windows absolute
3182 path. GetFullPath converts ../ and ./ in relative paths to
3183 absolute paths, filling in current drive if one is not given
3184 or using the current directory of a specified drive (eg, "E:foo").
3185 It also converts all forward slashes to back slashes. */
3186 /* The file system is case-insensitive but case-preserving.
3187 So we do not lowercase the path. Otherwise, we might not
3188 be able to display the original casing in a given path. */
3189 #if defined (_WIN32)
3192 DWORD len
= GetFullPathName (filename
, MAX_PATH
, buf
, NULL
);
3194 if (len
> 0 && len
< MAX_PATH
)
3195 return xstrdup (buf
);
3199 /* This system is a lost cause, just dup the buffer. */
3200 return xstrdup (filename
);
3204 align_up (ULONGEST v
, int n
)
3206 /* Check that N is really a power of two. */
3207 gdb_assert (n
&& (n
& (n
-1)) == 0);
3208 return (v
+ n
- 1) & -n
;
3212 align_down (ULONGEST v
, int n
)
3214 /* Check that N is really a power of two. */
3215 gdb_assert (n
&& (n
& (n
-1)) == 0);
3222 gdb_sign_extend (LONGEST value
, int bit
)
3224 gdb_assert (bit
>= 1 && bit
<= 8 * sizeof (LONGEST
));
3226 if (((value
>> (bit
- 1)) & 1) != 0)
3228 LONGEST signbit
= ((LONGEST
) 1) << (bit
- 1);
3230 value
= (value
^ signbit
) - signbit
;
3236 /* Allocation function for the libiberty hash table which uses an
3237 obstack. The obstack is passed as DATA. */
3240 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
3242 unsigned int total
= size
* count
;
3243 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
3245 memset (ptr
, 0, total
);
3249 /* Trivial deallocation function for the libiberty splay tree and hash
3250 table - don't deallocate anything. Rely on later deletion of the
3251 obstack. DATA will be the obstack, although it is not needed
3255 dummy_obstack_deallocate (void *object
, void *data
)
3260 /* The bit offset of the highest byte in a ULONGEST, for overflow
3263 #define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT)
3265 /* True (non-zero) iff DIGIT is a valid digit in radix BASE,
3266 where 2 <= BASE <= 36. */
3269 is_digit_in_base (unsigned char digit
, int base
)
3271 if (!isalnum (digit
))
3274 return (isdigit (digit
) && digit
< base
+ '0');
3276 return (isdigit (digit
) || tolower (digit
) < base
- 10 + 'a');
3280 digit_to_int (unsigned char c
)
3285 return tolower (c
) - 'a' + 10;
3288 /* As for strtoul, but for ULONGEST results. */
3291 strtoulst (const char *num
, const char **trailer
, int base
)
3293 unsigned int high_part
;
3298 /* Skip leading whitespace. */
3299 while (isspace (num
[i
]))
3302 /* Handle prefixes. */
3305 else if (num
[i
] == '-')
3311 if (base
== 0 || base
== 16)
3313 if (num
[i
] == '0' && (num
[i
+ 1] == 'x' || num
[i
+ 1] == 'X'))
3321 if (base
== 0 && num
[i
] == '0')
3327 if (base
< 2 || base
> 36)
3333 result
= high_part
= 0;
3334 for (; is_digit_in_base (num
[i
], base
); i
+= 1)
3336 result
= result
* base
+ digit_to_int (num
[i
]);
3337 high_part
= high_part
* base
+ (unsigned int) (result
>> HIGH_BYTE_POSN
);
3338 result
&= ((ULONGEST
) 1 << HIGH_BYTE_POSN
) - 1;
3339 if (high_part
> 0xff)
3342 result
= ~ (ULONGEST
) 0;
3349 if (trailer
!= NULL
)
3352 result
= result
+ ((ULONGEST
) high_part
<< HIGH_BYTE_POSN
);
3359 /* Simple, portable version of dirname that does not modify its
3363 ldirname (const char *filename
)
3365 const char *base
= lbasename (filename
);
3368 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
3371 if (base
== filename
)
3374 dirname
= xmalloc (base
- filename
+ 2);
3375 memcpy (dirname
, filename
, base
- filename
);
3377 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3378 create "d:./bar" later instead of the (different) "d:/bar". */
3379 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3380 && !IS_DIR_SEPARATOR (filename
[0]))
3381 dirname
[base
++ - filename
] = '.';
3383 dirname
[base
- filename
] = '\0';
3387 /* Call libiberty's buildargv, and return the result.
3388 If buildargv fails due to out-of-memory, call nomem.
3389 Therefore, the returned value is guaranteed to be non-NULL,
3390 unless the parameter itself is NULL. */
3393 gdb_buildargv (const char *s
)
3395 char **argv
= buildargv (s
);
3397 if (s
!= NULL
&& argv
== NULL
)
3403 compare_positive_ints (const void *ap
, const void *bp
)
3405 /* Because we know we're comparing two ints which are positive,
3406 there's no danger of overflow here. */
3407 return * (int *) ap
- * (int *) bp
;
3410 /* String compare function for qsort. */
3413 compare_strings (const void *arg1
, const void *arg2
)
3415 const char **s1
= (const char **) arg1
;
3416 const char **s2
= (const char **) arg2
;
3418 return strcmp (*s1
, *s2
);
3421 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3422 #define AMBIGUOUS_MESS2 \
3423 ".\nUse \"set gnutarget format-name\" to specify the format."
3426 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3432 /* Check if errmsg just need simple return. */
3433 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3434 return bfd_errmsg (error_tag
);
3436 ret_len
= strlen (bfd_errmsg (error_tag
)) + strlen (AMBIGUOUS_MESS1
)
3437 + strlen (AMBIGUOUS_MESS2
);
3438 for (p
= matching
; *p
; p
++)
3439 ret_len
+= strlen (*p
) + 1;
3440 ret
= xmalloc (ret_len
+ 1);
3442 make_cleanup (xfree
, ret
);
3444 strcpy (retp
, bfd_errmsg (error_tag
));
3445 retp
+= strlen (retp
);
3447 strcpy (retp
, AMBIGUOUS_MESS1
);
3448 retp
+= strlen (retp
);
3450 for (p
= matching
; *p
; p
++)
3452 sprintf (retp
, " %s", *p
);
3453 retp
+= strlen (retp
);
3457 strcpy (retp
, AMBIGUOUS_MESS2
);
3462 /* Return ARGS parsed as a valid pid, or throw an error. */
3465 parse_pid_to_attach (char *args
)
3471 error_no_arg (_("process-id to attach"));
3474 pid
= strtoul (args
, &dummy
, 0);
3475 /* Some targets don't set errno on errors, grrr! */
3476 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3477 error (_("Illegal process-id: %s."), args
);
3482 /* Helper for make_bpstat_clear_actions_cleanup. */
3485 do_bpstat_clear_actions_cleanup (void *unused
)
3487 bpstat_clear_actions ();
3490 /* Call bpstat_clear_actions for the case an exception is throw. You should
3491 discard_cleanups if no exception is caught. */
3494 make_bpstat_clear_actions_cleanup (void)
3496 return make_cleanup (do_bpstat_clear_actions_cleanup
, NULL
);
3499 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3500 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3501 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3504 producer_is_gcc_ge_4 (const char *producer
)
3509 if (producer
== NULL
)
3511 /* For unknown compilers expect their behavior is not compliant. For GCC
3512 this case can also happen for -gdwarf-4 type units supported since
3518 /* Skip any identifier after "GNU " - such as "C++" or "Java". */
3520 if (strncmp (producer
, "GNU ", strlen ("GNU ")) != 0)
3522 /* For non-GCC compilers expect their behavior is not compliant. */
3526 cs
= &producer
[strlen ("GNU ")];
3527 while (*cs
&& !isdigit (*cs
))
3529 if (sscanf (cs
, "%d.%d", &major
, &minor
) != 2)
3531 /* Not recognized as GCC. */
3543 /* Helper for make_cleanup_free_char_ptr_vec. */
3546 do_free_char_ptr_vec (void *arg
)
3548 VEC (char_ptr
) *char_ptr_vec
= arg
;
3550 free_char_ptr_vec (char_ptr_vec
);
3553 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3554 final VEC_free for CHAR_PTR_VEC itself.
3556 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3557 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3558 this function does not (cannot) clear the pointer. */
3561 make_cleanup_free_char_ptr_vec (VEC (char_ptr
) *char_ptr_vec
)
3563 return make_cleanup (do_free_char_ptr_vec
, char_ptr_vec
);
3566 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3567 must come from xrealloc-compatible allocator and it may be updated. FROM
3568 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3569 located at the start or end of *STRINGP. */
3572 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3574 char *string
= *stringp
, *s
;
3575 const size_t from_len
= strlen (from
);
3576 const size_t to_len
= strlen (to
);
3580 s
= strstr (s
, from
);
3584 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3585 || s
[-1] == DIRNAME_SEPARATOR
)
3586 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3587 || s
[from_len
] == DIRNAME_SEPARATOR
))
3591 string_new
= xrealloc (string
, (strlen (string
) + to_len
+ 1));
3593 /* Relocate the current S pointer. */
3594 s
= s
- string
+ string_new
;
3595 string
= string_new
;
3597 /* Replace from by to. */
3598 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3599 memcpy (s
, to
, to_len
);
3614 /* SIGALRM handler for waitpid_with_timeout. */
3617 sigalrm_handler (int signo
)
3619 /* Nothing to do. */
3624 /* Wrapper to wait for child PID to die with TIMEOUT.
3625 TIMEOUT is the time to stop waiting in seconds.
3626 If TIMEOUT is zero, pass WNOHANG to waitpid.
3627 Returns PID if it was successfully waited for, otherwise -1.
3629 Timeouts are currently implemented with alarm and SIGALRM.
3630 If the host does not support them, this waits "forever".
3631 It would be odd though for a host to have waitpid and not SIGALRM. */
3634 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3636 pid_t waitpid_result
;
3638 gdb_assert (pid
> 0);
3639 gdb_assert (timeout
>= 0);
3644 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3645 struct sigaction sa
, old_sa
;
3647 sa
.sa_handler
= sigalrm_handler
;
3648 sigemptyset (&sa
.sa_mask
);
3650 sigaction (SIGALRM
, &sa
, &old_sa
);
3654 ofunc
= (void (*)()) signal (SIGALRM
, sigalrm_handler
);
3660 waitpid_result
= waitpid (pid
, status
, 0);
3664 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3665 sigaction (SIGALRM
, &old_sa
, NULL
);
3667 signal (SIGALRM
, ofunc
);
3672 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3674 if (waitpid_result
== pid
)
3680 #endif /* HAVE_WAITPID */
3682 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3683 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3685 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3686 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3689 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3691 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3693 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3694 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3696 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3698 char *pattern_slash
, *string_slash
;
3700 /* Replace '\' by '/' in both strings. */
3702 pattern_slash
= alloca (strlen (pattern
) + 1);
3703 strcpy (pattern_slash
, pattern
);
3704 pattern
= pattern_slash
;
3705 for (; *pattern_slash
!= 0; pattern_slash
++)
3706 if (IS_DIR_SEPARATOR (*pattern_slash
))
3707 *pattern_slash
= '/';
3709 string_slash
= alloca (strlen (string
) + 1);
3710 strcpy (string_slash
, string
);
3711 string
= string_slash
;
3712 for (; *string_slash
!= 0; string_slash
++)
3713 if (IS_DIR_SEPARATOR (*string_slash
))
3714 *string_slash
= '/';
3716 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3718 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3719 flags
|= FNM_CASEFOLD
;
3720 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3722 return fnmatch (pattern
, string
, flags
);
3725 /* Provide a prototype to silence -Wmissing-prototypes. */
3726 extern initialize_file_ftype _initialize_utils
;
3729 _initialize_utils (void)
3731 add_internal_problem_command (&internal_error_problem
);
3732 add_internal_problem_command (&internal_warning_problem
);