1 /* General utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2013 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 #include "dyn-string.h"
22 #include "gdb_assert.h"
24 #include "gdb_string.h"
26 #include "event-top.h"
27 #include "exceptions.h"
28 #include "gdbthread.h"
31 #ifdef HAVE_SYS_RESOURCE_H
32 #include <sys/resource.h>
33 #endif /* HAVE_SYS_RESOURCE_H */
36 #include "tui/tui.h" /* For tui_get_command_dimension. */
43 /* SunOS's curses.h has a '#define reg register' in it. Thank you Sun. */
49 #include "timeval-utils.h"
54 #include "gdb-demangle.h"
55 #include "expression.h"
59 #include "filenames.h"
61 #include "gdb_obstack.h"
67 #include "inferior.h" /* for signed_pointer_to_address */
69 #include "gdb_curses.h"
71 #include "readline/readline.h"
76 #include "gdb_usleep.h"
78 #include "gdb_regex.h"
81 extern PTR
malloc (); /* ARI: PTR */
83 #if !HAVE_DECL_REALLOC
84 extern PTR
realloc (); /* ARI: PTR */
90 void (*deprecated_error_begin_hook
) (void);
92 /* Prototypes for local functions */
94 static void vfprintf_maybe_filtered (struct ui_file
*, const char *,
95 va_list, int) ATTRIBUTE_PRINTF (2, 0);
97 static void fputs_maybe_filtered (const char *, struct ui_file
*, int);
99 static void prompt_for_continue (void);
101 static void set_screen_size (void);
102 static void set_width (void);
104 /* Time spent in prompt_for_continue in the currently executing command
105 waiting for user to respond.
106 Initialized in make_command_stats_cleanup.
107 Modified in prompt_for_continue and defaulted_query.
108 Used in report_command_stats. */
110 static struct timeval prompt_for_continue_wait_time
;
112 /* A flag indicating whether to timestamp debugging messages. */
114 static int debug_timestamp
= 0;
116 /* Nonzero if we have job control. */
121 /* Nonzero means a quit has been requested. */
124 #endif /* HAVE_PYTHON */
126 /* Nonzero means quit immediately if Control-C is typed now, rather
127 than waiting until QUIT is executed. Be careful in setting this;
128 code which executes with immediate_quit set has to be very careful
129 about being able to deal with being interrupted at any time. It is
130 almost always better to use QUIT; the only exception I can think of
131 is being able to quit out of a system call (using EINTR loses if
132 the SIGINT happens between the previous QUIT and the system call).
133 To immediately quit in the case in which a SIGINT happens between
134 the previous QUIT and setting immediate_quit (desirable anytime we
135 expect to block), call QUIT after setting immediate_quit. */
141 /* Clear the quit flag. */
144 clear_quit_flag (void)
149 /* Set the quit flag. */
157 /* Return true if the quit flag has been set, false otherwise. */
160 check_quit_flag (void)
162 /* This is written in a particular way to avoid races. */
172 #endif /* HAVE_PYTHON */
174 /* Nonzero means that strings with character values >0x7F should be printed
175 as octal escapes. Zero means just print the value (e.g. it's an
176 international character, and the terminal or window can cope.) */
178 int sevenbit_strings
= 0;
180 show_sevenbit_strings (struct ui_file
*file
, int from_tty
,
181 struct cmd_list_element
*c
, const char *value
)
183 fprintf_filtered (file
, _("Printing of 8-bit characters "
184 "in strings as \\nnn is %s.\n"),
188 /* String to be printed before warning messages, if any. */
190 char *warning_pre_print
= "\nwarning: ";
192 int pagination_enabled
= 1;
194 show_pagination_enabled (struct ui_file
*file
, int from_tty
,
195 struct cmd_list_element
*c
, const char *value
)
197 fprintf_filtered (file
, _("State of pagination is %s.\n"), value
);
201 /* Cleanup utilities.
203 These are not defined in cleanups.c (nor declared in cleanups.h)
204 because while they use the "cleanup API" they are not part of the
208 do_freeargv (void *arg
)
210 freeargv ((char **) arg
);
214 make_cleanup_freeargv (char **arg
)
216 return make_cleanup (do_freeargv
, arg
);
220 do_dyn_string_delete (void *arg
)
222 dyn_string_delete ((dyn_string_t
) arg
);
226 make_cleanup_dyn_string_delete (dyn_string_t arg
)
228 return make_cleanup (do_dyn_string_delete
, arg
);
232 do_bfd_close_cleanup (void *arg
)
238 make_cleanup_bfd_unref (bfd
*abfd
)
240 return make_cleanup (do_bfd_close_cleanup
, abfd
);
244 do_close_cleanup (void *arg
)
252 make_cleanup_close (int fd
)
254 int *saved_fd
= xmalloc (sizeof (fd
));
257 return make_cleanup_dtor (do_close_cleanup
, saved_fd
, xfree
);
260 /* Helper function which does the work for make_cleanup_fclose. */
263 do_fclose_cleanup (void *arg
)
270 /* Return a new cleanup that closes FILE. */
273 make_cleanup_fclose (FILE *file
)
275 return make_cleanup (do_fclose_cleanup
, file
);
278 /* Helper function which does the work for make_cleanup_obstack_free. */
281 do_obstack_free (void *arg
)
283 struct obstack
*ob
= arg
;
285 obstack_free (ob
, NULL
);
288 /* Return a new cleanup that frees OBSTACK. */
291 make_cleanup_obstack_free (struct obstack
*obstack
)
293 return make_cleanup (do_obstack_free
, obstack
);
297 do_ui_file_delete (void *arg
)
299 ui_file_delete (arg
);
303 make_cleanup_ui_file_delete (struct ui_file
*arg
)
305 return make_cleanup (do_ui_file_delete
, arg
);
308 /* Helper function for make_cleanup_ui_out_redirect_pop. */
311 do_ui_out_redirect_pop (void *arg
)
313 struct ui_out
*uiout
= arg
;
315 if (ui_out_redirect (uiout
, NULL
) < 0)
316 warning (_("Cannot restore redirection of the current output protocol"));
319 /* Return a new cleanup that pops the last redirection by ui_out_redirect
320 with NULL parameter. */
323 make_cleanup_ui_out_redirect_pop (struct ui_out
*uiout
)
325 return make_cleanup (do_ui_out_redirect_pop
, uiout
);
329 do_free_section_addr_info (void *arg
)
331 free_section_addr_info (arg
);
335 make_cleanup_free_section_addr_info (struct section_addr_info
*addrs
)
337 return make_cleanup (do_free_section_addr_info
, addrs
);
340 struct restore_integer_closure
347 restore_integer (void *p
)
349 struct restore_integer_closure
*closure
= p
;
351 *(closure
->variable
) = closure
->value
;
354 /* Remember the current value of *VARIABLE and make it restored when
355 the cleanup is run. */
358 make_cleanup_restore_integer (int *variable
)
360 struct restore_integer_closure
*c
=
361 xmalloc (sizeof (struct restore_integer_closure
));
363 c
->variable
= variable
;
364 c
->value
= *variable
;
366 return make_cleanup_dtor (restore_integer
, (void *) c
, xfree
);
369 /* Remember the current value of *VARIABLE and make it restored when
370 the cleanup is run. */
373 make_cleanup_restore_uinteger (unsigned int *variable
)
375 return make_cleanup_restore_integer ((int *) variable
);
378 /* Helper for make_cleanup_unpush_target. */
381 do_unpush_target (void *arg
)
383 struct target_ops
*ops
= arg
;
388 /* Return a new cleanup that unpushes OPS. */
391 make_cleanup_unpush_target (struct target_ops
*ops
)
393 return make_cleanup (do_unpush_target
, ops
);
396 /* Helper for make_cleanup_htab_delete compile time checking the types. */
399 do_htab_delete_cleanup (void *htab_voidp
)
401 htab_t htab
= htab_voidp
;
406 /* Return a new cleanup that deletes HTAB. */
409 make_cleanup_htab_delete (htab_t htab
)
411 return make_cleanup (do_htab_delete_cleanup
, htab
);
414 struct restore_ui_file_closure
416 struct ui_file
**variable
;
417 struct ui_file
*value
;
421 do_restore_ui_file (void *p
)
423 struct restore_ui_file_closure
*closure
= p
;
425 *(closure
->variable
) = closure
->value
;
428 /* Remember the current value of *VARIABLE and make it restored when
429 the cleanup is run. */
432 make_cleanup_restore_ui_file (struct ui_file
**variable
)
434 struct restore_ui_file_closure
*c
= XNEW (struct restore_ui_file_closure
);
436 c
->variable
= variable
;
437 c
->value
= *variable
;
439 return make_cleanup_dtor (do_restore_ui_file
, (void *) c
, xfree
);
442 /* Helper for make_cleanup_value_free_to_mark. */
445 do_value_free_to_mark (void *value
)
447 value_free_to_mark ((struct value
*) value
);
450 /* Free all values allocated since MARK was obtained by value_mark
451 (except for those released) when the cleanup is run. */
454 make_cleanup_value_free_to_mark (struct value
*mark
)
456 return make_cleanup (do_value_free_to_mark
, mark
);
459 /* Helper for make_cleanup_value_free. */
462 do_value_free (void *value
)
470 make_cleanup_value_free (struct value
*value
)
472 return make_cleanup (do_value_free
, value
);
475 /* Helper for make_cleanup_free_so. */
478 do_free_so (void *arg
)
480 struct so_list
*so
= arg
;
485 /* Make cleanup handler calling free_so for SO. */
488 make_cleanup_free_so (struct so_list
*so
)
490 return make_cleanup (do_free_so
, so
);
493 /* Helper for make_cleanup_restore_current_language. */
496 do_restore_current_language (void *p
)
498 enum language saved_lang
= (uintptr_t) p
;
500 set_language (saved_lang
);
503 /* Remember the current value of CURRENT_LANGUAGE and make it restored when
504 the cleanup is run. */
507 make_cleanup_restore_current_language (void)
509 enum language saved_lang
= current_language
->la_language
;
511 return make_cleanup (do_restore_current_language
,
512 (void *) (uintptr_t) saved_lang
);
515 /* This function is useful for cleanups.
519 old_chain = make_cleanup (free_current_contents, &foo);
521 to arrange to free the object thus allocated. */
524 free_current_contents (void *ptr
)
526 void **location
= ptr
;
528 if (location
== NULL
)
529 internal_error (__FILE__
, __LINE__
,
530 _("free_current_contents: NULL pointer"));
531 if (*location
!= NULL
)
540 /* Print a warning message. The first argument STRING is the warning
541 message, used as an fprintf format string, the second is the
542 va_list of arguments for that string. A warning is unfiltered (not
543 paginated) so that the user does not need to page through each
544 screen full of warnings when there are lots of them. */
547 vwarning (const char *string
, va_list args
)
549 if (deprecated_warning_hook
)
550 (*deprecated_warning_hook
) (string
, args
);
553 target_terminal_ours ();
554 wrap_here (""); /* Force out any buffered output. */
555 gdb_flush (gdb_stdout
);
556 if (warning_pre_print
)
557 fputs_unfiltered (warning_pre_print
, gdb_stderr
);
558 vfprintf_unfiltered (gdb_stderr
, string
, args
);
559 fprintf_unfiltered (gdb_stderr
, "\n");
564 /* Print a warning message.
565 The first argument STRING is the warning message, used as a fprintf string,
566 and the remaining args are passed as arguments to it.
567 The primary difference between warnings and errors is that a warning
568 does not force the return to command level. */
571 warning (const char *string
, ...)
575 va_start (args
, string
);
576 vwarning (string
, args
);
580 /* Print an error message and return to command level.
581 The first argument STRING is the error message, used as a fprintf string,
582 and the remaining args are passed as arguments to it. */
585 verror (const char *string
, va_list args
)
587 throw_verror (GENERIC_ERROR
, string
, args
);
591 error (const char *string
, ...)
595 va_start (args
, string
);
596 throw_verror (GENERIC_ERROR
, string
, args
);
600 /* Print an error message and quit.
601 The first argument STRING is the error message, used as a fprintf string,
602 and the remaining args are passed as arguments to it. */
605 vfatal (const char *string
, va_list args
)
607 throw_vfatal (string
, args
);
611 fatal (const char *string
, ...)
615 va_start (args
, string
);
616 throw_vfatal (string
, args
);
621 error_stream (struct ui_file
*stream
)
623 char *message
= ui_file_xstrdup (stream
, NULL
);
625 make_cleanup (xfree
, message
);
626 error (("%s"), message
);
629 /* Dump core trying to increase the core soft limit to hard limit first. */
634 #ifdef HAVE_SETRLIMIT
635 struct rlimit rlim
= { RLIM_INFINITY
, RLIM_INFINITY
};
637 setrlimit (RLIMIT_CORE
, &rlim
);
638 #endif /* HAVE_SETRLIMIT */
640 abort (); /* NOTE: GDB has only three calls to abort(). */
643 /* Check whether GDB will be able to dump core using the dump_core
647 can_dump_core (const char *reason
)
649 #ifdef HAVE_GETRLIMIT
652 /* Be quiet and assume we can dump if an error is returned. */
653 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
656 if (rlim
.rlim_max
== 0)
658 fprintf_unfiltered (gdb_stderr
,
659 _("%s\nUnable to dump core, use `ulimit -c"
660 " unlimited' before executing GDB next time.\n"),
664 #endif /* HAVE_GETRLIMIT */
669 /* Allow the user to configure the debugger behavior with respect to
670 what to do when an internal problem is detected. */
672 const char internal_problem_ask
[] = "ask";
673 const char internal_problem_yes
[] = "yes";
674 const char internal_problem_no
[] = "no";
675 static const char *const internal_problem_modes
[] =
677 internal_problem_ask
,
678 internal_problem_yes
,
683 /* Print a message reporting an internal error/warning. Ask the user
684 if they want to continue, dump core, or just exit. Return
685 something to indicate a quit. */
687 struct internal_problem
690 const char *should_quit
;
691 const char *should_dump_core
;
694 /* Report a problem, internal to GDB, to the user. Once the problem
695 has been reported, and assuming GDB didn't quit, the caller can
696 either allow execution to resume or throw an error. */
698 static void ATTRIBUTE_PRINTF (4, 0)
699 internal_vproblem (struct internal_problem
*problem
,
700 const char *file
, int line
, const char *fmt
, va_list ap
)
706 struct cleanup
*cleanup
= make_cleanup (null_cleanup
, NULL
);
708 /* Don't allow infinite error/warning recursion. */
710 static char msg
[] = "Recursive internal problem.\n";
719 fputs_unfiltered (msg
, gdb_stderr
);
720 abort (); /* NOTE: GDB has only three calls to abort(). */
723 /* Newer GLIBC versions put the warn_unused_result attribute
724 on write, but this is one of those rare cases where
725 ignoring the return value is correct. Casting to (void)
726 does not fix this problem. This is the solution suggested
727 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
728 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
729 abort (); /* NOTE: GDB has only three calls to abort(). */
734 /* Try to get the message out and at the start of a new line. */
735 target_terminal_ours ();
738 /* Create a string containing the full error/warning message. Need
739 to call query with this full string, as otherwize the reason
740 (error/warning) and question become separated. Format using a
741 style similar to a compiler error message. Include extra detail
742 so that the user knows that they are living on the edge. */
746 msg
= xstrvprintf (fmt
, ap
);
747 reason
= xstrprintf ("%s:%d: %s: %s\n"
748 "A problem internal to GDB has been detected,\n"
749 "further debugging may prove unreliable.",
750 file
, line
, problem
->name
, msg
);
752 make_cleanup (xfree
, reason
);
755 if (problem
->should_quit
== internal_problem_ask
)
757 /* Default (yes/batch case) is to quit GDB. When in batch mode
758 this lessens the likelihood of GDB going into an infinite
762 /* Emit the message and quit. */
763 fputs_unfiltered (reason
, gdb_stderr
);
764 fputs_unfiltered ("\n", gdb_stderr
);
768 quit_p
= query (_("%s\nQuit this debugging session? "), reason
);
770 else if (problem
->should_quit
== internal_problem_yes
)
772 else if (problem
->should_quit
== internal_problem_no
)
775 internal_error (__FILE__
, __LINE__
, _("bad switch"));
777 if (problem
->should_dump_core
== internal_problem_ask
)
779 if (!can_dump_core (reason
))
783 /* Default (yes/batch case) is to dump core. This leaves a GDB
784 `dropping' so that it is easier to see that something went
786 dump_core_p
= query (_("%s\nCreate a core file of GDB? "), reason
);
789 else if (problem
->should_dump_core
== internal_problem_yes
)
790 dump_core_p
= can_dump_core (reason
);
791 else if (problem
->should_dump_core
== internal_problem_no
)
794 internal_error (__FILE__
, __LINE__
, _("bad switch"));
807 #ifdef HAVE_WORKING_FORK
815 do_cleanups (cleanup
);
818 static struct internal_problem internal_error_problem
= {
819 "internal-error", internal_problem_ask
, internal_problem_ask
823 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
825 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
826 fatal (_("Command aborted."));
830 internal_error (const char *file
, int line
, const char *string
, ...)
834 va_start (ap
, string
);
835 internal_verror (file
, line
, string
, ap
);
839 static struct internal_problem internal_warning_problem
= {
840 "internal-warning", internal_problem_ask
, internal_problem_ask
844 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
846 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
850 internal_warning (const char *file
, int line
, const char *string
, ...)
854 va_start (ap
, string
);
855 internal_vwarning (file
, line
, string
, ap
);
859 /* Dummy functions to keep add_prefix_cmd happy. */
862 set_internal_problem_cmd (char *args
, int from_tty
)
867 show_internal_problem_cmd (char *args
, int from_tty
)
871 /* When GDB reports an internal problem (error or warning) it gives
872 the user the opportunity to quit GDB and/or create a core file of
873 the current debug session. This function registers a few commands
874 that make it possible to specify that GDB should always or never
875 quit or create a core file, without asking. The commands look
878 maint set PROBLEM-NAME quit ask|yes|no
879 maint show PROBLEM-NAME quit
880 maint set PROBLEM-NAME corefile ask|yes|no
881 maint show PROBLEM-NAME corefile
883 Where PROBLEM-NAME is currently "internal-error" or
884 "internal-warning". */
887 add_internal_problem_command (struct internal_problem
*problem
)
889 struct cmd_list_element
**set_cmd_list
;
890 struct cmd_list_element
**show_cmd_list
;
894 set_cmd_list
= xmalloc (sizeof (*set_cmd_list
));
895 show_cmd_list
= xmalloc (sizeof (*set_cmd_list
));
896 *set_cmd_list
= NULL
;
897 *show_cmd_list
= NULL
;
899 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
902 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
905 add_prefix_cmd ((char*) problem
->name
,
906 class_maintenance
, set_internal_problem_cmd
, set_doc
,
908 concat ("maintenance set ", problem
->name
, " ",
910 0/*allow-unknown*/, &maintenance_set_cmdlist
);
912 add_prefix_cmd ((char*) problem
->name
,
913 class_maintenance
, show_internal_problem_cmd
, show_doc
,
915 concat ("maintenance show ", problem
->name
, " ",
917 0/*allow-unknown*/, &maintenance_show_cmdlist
);
919 set_doc
= xstrprintf (_("Set whether GDB should quit "
920 "when an %s is detected"),
922 show_doc
= xstrprintf (_("Show whether GDB will quit "
923 "when an %s is detected"),
925 add_setshow_enum_cmd ("quit", class_maintenance
,
926 internal_problem_modes
,
927 &problem
->should_quit
,
939 set_doc
= xstrprintf (_("Set whether GDB should create a core "
940 "file of GDB when %s is detected"),
942 show_doc
= xstrprintf (_("Show whether GDB will create a core "
943 "file of GDB when %s is detected"),
945 add_setshow_enum_cmd ("corefile", class_maintenance
,
946 internal_problem_modes
,
947 &problem
->should_dump_core
,
960 /* Return a newly allocated string, containing the PREFIX followed
961 by the system error message for errno (separated by a colon).
963 The result must be deallocated after use. */
966 perror_string (const char *prefix
)
971 err
= safe_strerror (errno
);
972 combined
= (char *) xmalloc (strlen (err
) + strlen (prefix
) + 3);
973 strcpy (combined
, prefix
);
974 strcat (combined
, ": ");
975 strcat (combined
, err
);
980 /* Print the system error message for errno, and also mention STRING
981 as the file name for which the error was encountered. Use ERRCODE
982 for the thrown exception. Then return to command level. */
985 throw_perror_with_name (enum errors errcode
, const char *string
)
989 combined
= perror_string (string
);
990 make_cleanup (xfree
, combined
);
992 /* I understand setting these is a matter of taste. Still, some people
993 may clear errno but not know about bfd_error. Doing this here is not
995 bfd_set_error (bfd_error_no_error
);
998 throw_error (errcode
, _("%s."), combined
);
1001 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
1004 perror_with_name (const char *string
)
1006 throw_perror_with_name (GENERIC_ERROR
, string
);
1009 /* Print the system error message for ERRCODE, and also mention STRING
1010 as the file name for which the error was encountered. */
1013 print_sys_errmsg (const char *string
, int errcode
)
1018 err
= safe_strerror (errcode
);
1019 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
1020 strcpy (combined
, string
);
1021 strcat (combined
, ": ");
1022 strcat (combined
, err
);
1024 /* We want anything which was printed on stdout to come out first, before
1026 gdb_flush (gdb_stdout
);
1027 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
1030 /* Control C eventually causes this to be called, at a convenient time. */
1036 /* No steenking SIGINT will ever be coming our way when the
1037 program is resumed. Don't lie. */
1041 /* If there is no terminal switching for this target, then we can't
1042 possibly get screwed by the lack of job control. */
1043 || current_target
.to_terminal_ours
== NULL
)
1046 fatal ("Quit (expect signal SIGINT when the program is resumed)");
1051 /* Called when a memory allocation fails, with the number of bytes of
1052 memory requested in SIZE. */
1055 malloc_failure (long size
)
1059 internal_error (__FILE__
, __LINE__
,
1060 _("virtual memory exhausted: can't allocate %ld bytes."),
1065 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
1069 /* My replacement for the read system call.
1070 Used like `read' but keeps going if `read' returns too soon. */
1073 myread (int desc
, char *addr
, int len
)
1080 val
= read (desc
, addr
, len
);
1084 return orglen
- len
;
1092 print_spaces (int n
, struct ui_file
*file
)
1094 fputs_unfiltered (n_spaces (n
), file
);
1097 /* Print a host address. */
1100 gdb_print_host_address (const void *addr
, struct ui_file
*stream
)
1102 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
1106 /* A cleanup function that calls regfree. */
1109 do_regfree_cleanup (void *r
)
1114 /* Create a new cleanup that frees the compiled regular expression R. */
1117 make_regfree_cleanup (regex_t
*r
)
1119 return make_cleanup (do_regfree_cleanup
, r
);
1122 /* Return an xmalloc'd error message resulting from a regular
1123 expression compilation failure. */
1126 get_regcomp_error (int code
, regex_t
*rx
)
1128 size_t length
= regerror (code
, rx
, NULL
, 0);
1129 char *result
= xmalloc (length
);
1131 regerror (code
, rx
, result
, length
);
1135 /* Compile a regexp and throw an exception on error. This returns a
1136 cleanup to free the resulting pattern on success. RX must not be
1140 compile_rx_or_error (regex_t
*pattern
, const char *rx
, const char *message
)
1144 gdb_assert (rx
!= NULL
);
1146 code
= regcomp (pattern
, rx
, REG_NOSUB
);
1149 char *err
= get_regcomp_error (code
, pattern
);
1151 make_cleanup (xfree
, err
);
1152 error (("%s: %s"), message
, err
);
1155 return make_regfree_cleanup (pattern
);
1160 /* This function supports the query, nquery, and yquery functions.
1161 Ask user a y-or-n question and return 0 if answer is no, 1 if
1162 answer is yes, or default the answer to the specified default
1163 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1164 default answer, or '\0' for no default.
1165 CTLSTR is the control string and should end in "? ". It should
1166 not say how to answer, because we do that.
1167 ARGS are the arguments passed along with the CTLSTR argument to
1170 static int ATTRIBUTE_PRINTF (1, 0)
1171 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
1177 char def_answer
, not_def_answer
;
1178 char *y_string
, *n_string
, *question
;
1179 /* Used to add duration we waited for user to respond to
1180 prompt_for_continue_wait_time. */
1181 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1183 /* Set up according to which answer is the default. */
1184 if (defchar
== '\0')
1188 not_def_answer
= 'N';
1192 else if (defchar
== 'y')
1196 not_def_answer
= 'N';
1204 not_def_answer
= 'Y';
1209 /* Automatically answer the default value if the user did not want
1210 prompts or the command was issued with the server prefix. */
1211 if (!confirm
|| server_command
)
1214 /* If input isn't coming from the user directly, just say what
1215 question we're asking, and then answer the default automatically. This
1216 way, important error messages don't get lost when talking to GDB
1218 if (! input_from_terminal_p ())
1221 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
1223 printf_filtered (_("(%s or %s) [answered %c; "
1224 "input not from terminal]\n"),
1225 y_string
, n_string
, def_answer
);
1226 gdb_flush (gdb_stdout
);
1231 if (deprecated_query_hook
)
1233 return deprecated_query_hook (ctlstr
, args
);
1236 /* Format the question outside of the loop, to avoid reusing args. */
1237 question
= xstrvprintf (ctlstr
, args
);
1239 /* Used for calculating time spend waiting for user. */
1240 gettimeofday (&prompt_started
, NULL
);
1244 wrap_here (""); /* Flush any buffered output. */
1245 gdb_flush (gdb_stdout
);
1247 if (annotation_level
> 1)
1248 printf_filtered (("\n\032\032pre-query\n"));
1250 fputs_filtered (question
, gdb_stdout
);
1251 printf_filtered (_("(%s or %s) "), y_string
, n_string
);
1253 if (annotation_level
> 1)
1254 printf_filtered (("\n\032\032query\n"));
1257 gdb_flush (gdb_stdout
);
1259 answer
= fgetc (stdin
);
1261 /* We expect fgetc to block until a character is read. But
1262 this may not be the case if the terminal was opened with
1263 the NONBLOCK flag. In that case, if there is nothing to
1264 read on stdin, fgetc returns EOF, but also sets the error
1265 condition flag on stdin and errno to EAGAIN. With a true
1266 EOF, stdin's error condition flag is not set.
1268 A situation where this behavior was observed is a pseudo
1270 while (answer
== EOF
&& ferror (stdin
) && errno
== EAGAIN
)
1272 /* Not a real EOF. Wait a little while and try again until
1273 we read something. */
1276 answer
= fgetc (stdin
);
1279 clearerr (stdin
); /* in case of C-d */
1280 if (answer
== EOF
) /* C-d */
1282 printf_filtered ("EOF [assumed %c]\n", def_answer
);
1286 /* Eat rest of input line, to EOF or newline. */
1290 ans2
= fgetc (stdin
);
1293 while (ans2
!= EOF
&& ans2
!= '\n' && ans2
!= '\r');
1297 /* Check answer. For the non-default, the user must specify
1298 the non-default explicitly. */
1299 if (answer
== not_def_answer
)
1301 retval
= !def_value
;
1304 /* Otherwise, if a default was specified, the user may either
1305 specify the required input or have it default by entering
1307 if (answer
== def_answer
1308 || (defchar
!= '\0' &&
1309 (answer
== '\n' || answer
== '\r' || answer
== EOF
)))
1314 /* Invalid entries are not defaulted and require another selection. */
1315 printf_filtered (_("Please answer %s or %s.\n"),
1316 y_string
, n_string
);
1319 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1320 gettimeofday (&prompt_ended
, NULL
);
1321 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1322 timeval_add (&prompt_for_continue_wait_time
,
1323 &prompt_for_continue_wait_time
, &prompt_delta
);
1326 if (annotation_level
> 1)
1327 printf_filtered (("\n\032\032post-query\n"));
1332 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1333 answer is yes, or 0 if answer is defaulted.
1334 Takes three args which are given to printf to print the question.
1335 The first, a control string, should end in "? ".
1336 It should not say how to answer, because we do that. */
1339 nquery (const char *ctlstr
, ...)
1344 va_start (args
, ctlstr
);
1345 ret
= defaulted_query (ctlstr
, 'n', args
);
1350 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1351 answer is yes, or 1 if answer is defaulted.
1352 Takes three args which are given to printf to print the question.
1353 The first, a control string, should end in "? ".
1354 It should not say how to answer, because we do that. */
1357 yquery (const char *ctlstr
, ...)
1362 va_start (args
, ctlstr
);
1363 ret
= defaulted_query (ctlstr
, 'y', args
);
1368 /* Ask user a y-or-n question and return 1 iff answer is yes.
1369 Takes three args which are given to printf to print the question.
1370 The first, a control string, should end in "? ".
1371 It should not say how to answer, because we do that. */
1374 query (const char *ctlstr
, ...)
1379 va_start (args
, ctlstr
);
1380 ret
= defaulted_query (ctlstr
, '\0', args
);
1385 /* A helper for parse_escape that converts a host character to a
1386 target character. C is the host character. If conversion is
1387 possible, then the target character is stored in *TARGET_C and the
1388 function returns 1. Otherwise, the function returns 0. */
1391 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1393 struct obstack host_data
;
1395 struct cleanup
*cleanups
;
1398 obstack_init (&host_data
);
1399 cleanups
= make_cleanup_obstack_free (&host_data
);
1401 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1402 (gdb_byte
*) &the_char
, 1, 1,
1403 &host_data
, translit_none
);
1405 if (obstack_object_size (&host_data
) == 1)
1408 *target_c
= *(char *) obstack_base (&host_data
);
1411 do_cleanups (cleanups
);
1415 /* Parse a C escape sequence. STRING_PTR points to a variable
1416 containing a pointer to the string to parse. That pointer
1417 should point to the character after the \. That pointer
1418 is updated past the characters we use. The value of the
1419 escape sequence is returned.
1421 A negative value means the sequence \ newline was seen,
1422 which is supposed to be equivalent to nothing at all.
1424 If \ is followed by a null character, we return a negative
1425 value and leave the string pointer pointing at the null character.
1427 If \ is followed by 000, we return 0 and leave the string pointer
1428 after the zeros. A value of 0 does not mean end of string. */
1431 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1433 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1434 int c
= *(*string_ptr
)++;
1453 int i
= host_hex_value (c
);
1458 if (isdigit (c
) && c
!= '8' && c
!= '9')
1462 i
+= host_hex_value (c
);
1498 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1499 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1500 " which has no equivalent\nin the `%s' character set."),
1501 c
, c
, target_charset (gdbarch
));
1505 /* Print the character C on STREAM as part of the contents of a literal
1506 string whose delimiter is QUOTER. Note that this routine should only
1507 be call for printing things which are independent of the language
1508 of the program being debugged. */
1511 printchar (int c
, void (*do_fputs
) (const char *, struct ui_file
*),
1512 void (*do_fprintf
) (struct ui_file
*, const char *, ...)
1513 ATTRIBUTE_FPTR_PRINTF_2
, struct ui_file
*stream
, int quoter
)
1515 c
&= 0xFF; /* Avoid sign bit follies */
1517 if (c
< 0x20 || /* Low control chars */
1518 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1519 (sevenbit_strings
&& c
>= 0x80))
1520 { /* high order bit set */
1524 do_fputs ("\\n", stream
);
1527 do_fputs ("\\b", stream
);
1530 do_fputs ("\\t", stream
);
1533 do_fputs ("\\f", stream
);
1536 do_fputs ("\\r", stream
);
1539 do_fputs ("\\e", stream
);
1542 do_fputs ("\\a", stream
);
1545 do_fprintf (stream
, "\\%.3o", (unsigned int) c
);
1551 if (c
== '\\' || c
== quoter
)
1552 do_fputs ("\\", stream
);
1553 do_fprintf (stream
, "%c", c
);
1557 /* Print the character C on STREAM as part of the contents of a
1558 literal string whose delimiter is QUOTER. Note that these routines
1559 should only be call for printing things which are independent of
1560 the language of the program being debugged. */
1563 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1566 printchar (*str
++, fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1570 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1573 printchar (*str
++, fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1577 fputstrn_filtered (const char *str
, int n
, int quoter
,
1578 struct ui_file
*stream
)
1582 for (i
= 0; i
< n
; i
++)
1583 printchar (str
[i
], fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1587 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1588 struct ui_file
*stream
)
1592 for (i
= 0; i
< n
; i
++)
1593 printchar (str
[i
], fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1597 /* Number of lines per page or UINT_MAX if paging is disabled. */
1598 static unsigned int lines_per_page
;
1600 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1601 struct cmd_list_element
*c
, const char *value
)
1603 fprintf_filtered (file
,
1604 _("Number of lines gdb thinks are in a page is %s.\n"),
1608 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1609 static unsigned int chars_per_line
;
1611 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1612 struct cmd_list_element
*c
, const char *value
)
1614 fprintf_filtered (file
,
1615 _("Number of characters gdb thinks "
1616 "are in a line is %s.\n"),
1620 /* Current count of lines printed on this page, chars on this line. */
1621 static unsigned int lines_printed
, chars_printed
;
1623 /* Buffer and start column of buffered text, for doing smarter word-
1624 wrapping. When someone calls wrap_here(), we start buffering output
1625 that comes through fputs_filtered(). If we see a newline, we just
1626 spit it out and forget about the wrap_here(). If we see another
1627 wrap_here(), we spit it out and remember the newer one. If we see
1628 the end of the line, we spit out a newline, the indent, and then
1629 the buffered output. */
1631 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1632 are waiting to be output (they have already been counted in chars_printed).
1633 When wrap_buffer[0] is null, the buffer is empty. */
1634 static char *wrap_buffer
;
1636 /* Pointer in wrap_buffer to the next character to fill. */
1637 static char *wrap_pointer
;
1639 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1641 static char *wrap_indent
;
1643 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1644 is not in effect. */
1645 static int wrap_column
;
1648 /* Inialize the number of lines per page and chars per line. */
1651 init_page_info (void)
1655 lines_per_page
= UINT_MAX
;
1656 chars_per_line
= UINT_MAX
;
1660 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1665 #if defined(__GO32__)
1666 rows
= ScreenRows ();
1667 cols
= ScreenCols ();
1668 lines_per_page
= rows
;
1669 chars_per_line
= cols
;
1671 /* Make sure Readline has initialized its terminal settings. */
1672 rl_reset_terminal (NULL
);
1674 /* Get the screen size from Readline. */
1675 rl_get_screen_size (&rows
, &cols
);
1676 lines_per_page
= rows
;
1677 chars_per_line
= cols
;
1679 /* Readline should have fetched the termcap entry for us.
1680 Only try to use tgetnum function if rl_get_screen_size
1681 did not return a useful value. */
1682 if (((rows
<= 0) && (tgetnum ("li") < 0))
1683 /* Also disable paging if inside EMACS. */
1684 || getenv ("EMACS"))
1686 /* The number of lines per page is not mentioned in the terminal
1687 description or EMACS evironment variable is set. This probably
1688 means that paging is not useful, so disable paging. */
1689 lines_per_page
= UINT_MAX
;
1692 /* If the output is not a terminal, don't paginate it. */
1693 if (!ui_file_isatty (gdb_stdout
))
1694 lines_per_page
= UINT_MAX
;
1702 /* Helper for make_cleanup_restore_page_info. */
1705 do_restore_page_info_cleanup (void *arg
)
1711 /* Provide cleanup for restoring the terminal size. */
1714 make_cleanup_restore_page_info (void)
1716 struct cleanup
*back_to
;
1718 back_to
= make_cleanup (do_restore_page_info_cleanup
, NULL
);
1719 make_cleanup_restore_uinteger (&lines_per_page
);
1720 make_cleanup_restore_uinteger (&chars_per_line
);
1725 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1726 Provide cleanup for restoring the original state. */
1729 set_batch_flag_and_make_cleanup_restore_page_info (void)
1731 struct cleanup
*back_to
= make_cleanup_restore_page_info ();
1733 make_cleanup_restore_integer (&batch_flag
);
1740 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1743 set_screen_size (void)
1745 int rows
= lines_per_page
;
1746 int cols
= chars_per_line
;
1754 /* Update Readline's idea of the terminal size. */
1755 rl_set_screen_size (rows
, cols
);
1758 /* Reinitialize WRAP_BUFFER according to the current value of
1764 if (chars_per_line
== 0)
1769 wrap_buffer
= (char *) xmalloc (chars_per_line
+ 2);
1770 wrap_buffer
[0] = '\0';
1773 wrap_buffer
= (char *) xrealloc (wrap_buffer
, chars_per_line
+ 2);
1774 wrap_pointer
= wrap_buffer
; /* Start it at the beginning. */
1778 set_width_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1785 set_height_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1790 /* Wait, so the user can read what's on the screen. Prompt the user
1791 to continue by pressing RETURN. */
1794 prompt_for_continue (void)
1797 char cont_prompt
[120];
1798 /* Used to add duration we waited for user to respond to
1799 prompt_for_continue_wait_time. */
1800 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1802 gettimeofday (&prompt_started
, NULL
);
1804 if (annotation_level
> 1)
1805 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1807 strcpy (cont_prompt
,
1808 "---Type <return> to continue, or q <return> to quit---");
1809 if (annotation_level
> 1)
1810 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1812 /* We must do this *before* we call gdb_readline, else it will eventually
1813 call us -- thinking that we're trying to print beyond the end of the
1815 reinitialize_more_filter ();
1819 /* On a real operating system, the user can quit with SIGINT.
1822 'q' is provided on all systems so users don't have to change habits
1823 from system to system, and because telling them what to do in
1824 the prompt is more user-friendly than expecting them to think of
1826 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1827 whereas control-C to gdb_readline will cause the user to get dumped
1829 ignore
= gdb_readline_wrapper (cont_prompt
);
1831 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1832 gettimeofday (&prompt_ended
, NULL
);
1833 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1834 timeval_add (&prompt_for_continue_wait_time
,
1835 &prompt_for_continue_wait_time
, &prompt_delta
);
1837 if (annotation_level
> 1)
1838 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1844 while (*p
== ' ' || *p
== '\t')
1852 /* Now we have to do this again, so that GDB will know that it doesn't
1853 need to save the ---Type <return>--- line at the top of the screen. */
1854 reinitialize_more_filter ();
1856 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1859 /* Initalize timer to keep track of how long we waited for the user. */
1862 reset_prompt_for_continue_wait_time (void)
1864 static const struct timeval zero_timeval
= { 0 };
1866 prompt_for_continue_wait_time
= zero_timeval
;
1869 /* Fetch the cumulative time spent in prompt_for_continue. */
1872 get_prompt_for_continue_wait_time (void)
1874 return prompt_for_continue_wait_time
;
1877 /* Reinitialize filter; ie. tell it to reset to original values. */
1880 reinitialize_more_filter (void)
1886 /* Indicate that if the next sequence of characters overflows the line,
1887 a newline should be inserted here rather than when it hits the end.
1888 If INDENT is non-null, it is a string to be printed to indent the
1889 wrapped part on the next line. INDENT must remain accessible until
1890 the next call to wrap_here() or until a newline is printed through
1893 If the line is already overfull, we immediately print a newline and
1894 the indentation, and disable further wrapping.
1896 If we don't know the width of lines, but we know the page height,
1897 we must not wrap words, but should still keep track of newlines
1898 that were explicitly printed.
1900 INDENT should not contain tabs, as that will mess up the char count
1901 on the next line. FIXME.
1903 This routine is guaranteed to force out any output which has been
1904 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1905 used to force out output from the wrap_buffer. */
1908 wrap_here (char *indent
)
1910 /* This should have been allocated, but be paranoid anyway. */
1912 internal_error (__FILE__
, __LINE__
,
1913 _("failed internal consistency check"));
1917 *wrap_pointer
= '\0';
1918 fputs_unfiltered (wrap_buffer
, gdb_stdout
);
1920 wrap_pointer
= wrap_buffer
;
1921 wrap_buffer
[0] = '\0';
1922 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1926 else if (chars_printed
>= chars_per_line
)
1928 puts_filtered ("\n");
1930 puts_filtered (indent
);
1935 wrap_column
= chars_printed
;
1939 wrap_indent
= indent
;
1943 /* Print input string to gdb_stdout, filtered, with wrap,
1944 arranging strings in columns of n chars. String can be
1945 right or left justified in the column. Never prints
1946 trailing spaces. String should never be longer than
1947 width. FIXME: this could be useful for the EXAMINE
1948 command, which currently doesn't tabulate very well. */
1951 puts_filtered_tabular (char *string
, int width
, int right
)
1957 gdb_assert (chars_per_line
> 0);
1958 if (chars_per_line
== UINT_MAX
)
1960 fputs_filtered (string
, gdb_stdout
);
1961 fputs_filtered ("\n", gdb_stdout
);
1965 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1966 fputs_filtered ("\n", gdb_stdout
);
1968 if (width
>= chars_per_line
)
1969 width
= chars_per_line
- 1;
1971 stringlen
= strlen (string
);
1973 if (chars_printed
> 0)
1974 spaces
= width
- (chars_printed
- 1) % width
- 1;
1976 spaces
+= width
- stringlen
;
1978 spacebuf
= alloca (spaces
+ 1);
1979 spacebuf
[spaces
] = '\0';
1981 spacebuf
[spaces
] = ' ';
1983 fputs_filtered (spacebuf
, gdb_stdout
);
1984 fputs_filtered (string
, gdb_stdout
);
1988 /* Ensure that whatever gets printed next, using the filtered output
1989 commands, starts at the beginning of the line. I.e. if there is
1990 any pending output for the current line, flush it and start a new
1991 line. Otherwise do nothing. */
1996 if (chars_printed
> 0)
1998 puts_filtered ("\n");
2003 /* Like fputs but if FILTER is true, pause after every screenful.
2005 Regardless of FILTER can wrap at points other than the final
2006 character of a line.
2008 Unlike fputs, fputs_maybe_filtered does not return a value.
2009 It is OK for LINEBUFFER to be NULL, in which case just don't print
2012 Note that a longjmp to top level may occur in this routine (only if
2013 FILTER is true) (since prompt_for_continue may do so) so this
2014 routine should not be called when cleanups are not in place. */
2017 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
2020 const char *lineptr
;
2022 if (linebuffer
== 0)
2025 /* Don't do any filtering if it is disabled. */
2026 if (stream
!= gdb_stdout
2027 || !pagination_enabled
2029 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
2030 || top_level_interpreter () == NULL
2031 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2033 fputs_unfiltered (linebuffer
, stream
);
2037 /* Go through and output each character. Show line extension
2038 when this is necessary; prompt user for new page when this is
2041 lineptr
= linebuffer
;
2044 /* Possible new page. */
2045 if (filter
&& (lines_printed
>= lines_per_page
- 1))
2046 prompt_for_continue ();
2048 while (*lineptr
&& *lineptr
!= '\n')
2050 /* Print a single line. */
2051 if (*lineptr
== '\t')
2054 *wrap_pointer
++ = '\t';
2056 fputc_unfiltered ('\t', stream
);
2057 /* Shifting right by 3 produces the number of tab stops
2058 we have already passed, and then adding one and
2059 shifting left 3 advances to the next tab stop. */
2060 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
2066 *wrap_pointer
++ = *lineptr
;
2068 fputc_unfiltered (*lineptr
, stream
);
2073 if (chars_printed
>= chars_per_line
)
2075 unsigned int save_chars
= chars_printed
;
2079 /* If we aren't actually wrapping, don't output newline --
2080 if chars_per_line is right, we probably just overflowed
2081 anyway; if it's wrong, let us keep going. */
2083 fputc_unfiltered ('\n', stream
);
2085 /* Possible new page. */
2086 if (lines_printed
>= lines_per_page
- 1)
2087 prompt_for_continue ();
2089 /* Now output indentation and wrapped string. */
2092 fputs_unfiltered (wrap_indent
, stream
);
2093 *wrap_pointer
= '\0'; /* Null-terminate saved stuff, */
2094 fputs_unfiltered (wrap_buffer
, stream
); /* and eject it. */
2095 /* FIXME, this strlen is what prevents wrap_indent from
2096 containing tabs. However, if we recurse to print it
2097 and count its chars, we risk trouble if wrap_indent is
2098 longer than (the user settable) chars_per_line.
2099 Note also that this can set chars_printed > chars_per_line
2100 if we are printing a long string. */
2101 chars_printed
= strlen (wrap_indent
)
2102 + (save_chars
- wrap_column
);
2103 wrap_pointer
= wrap_buffer
; /* Reset buffer */
2104 wrap_buffer
[0] = '\0';
2105 wrap_column
= 0; /* And disable fancy wrap */
2110 if (*lineptr
== '\n')
2113 wrap_here ((char *) 0); /* Spit out chars, cancel
2116 fputc_unfiltered ('\n', stream
);
2123 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
2125 fputs_maybe_filtered (linebuffer
, stream
, 1);
2129 putchar_unfiltered (int c
)
2133 ui_file_write (gdb_stdout
, &buf
, 1);
2137 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2138 May return nonlocally. */
2141 putchar_filtered (int c
)
2143 return fputc_filtered (c
, gdb_stdout
);
2147 fputc_unfiltered (int c
, struct ui_file
*stream
)
2151 ui_file_write (stream
, &buf
, 1);
2156 fputc_filtered (int c
, struct ui_file
*stream
)
2162 fputs_filtered (buf
, stream
);
2166 /* puts_debug is like fputs_unfiltered, except it prints special
2167 characters in printable fashion. */
2170 puts_debug (char *prefix
, char *string
, char *suffix
)
2174 /* Print prefix and suffix after each line. */
2175 static int new_line
= 1;
2176 static int return_p
= 0;
2177 static char *prev_prefix
= "";
2178 static char *prev_suffix
= "";
2180 if (*string
== '\n')
2183 /* If the prefix is changing, print the previous suffix, a new line,
2184 and the new prefix. */
2185 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
2187 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
2188 fputs_unfiltered ("\n", gdb_stdlog
);
2189 fputs_unfiltered (prefix
, gdb_stdlog
);
2192 /* Print prefix if we printed a newline during the previous call. */
2196 fputs_unfiltered (prefix
, gdb_stdlog
);
2199 prev_prefix
= prefix
;
2200 prev_suffix
= suffix
;
2202 /* Output characters in a printable format. */
2203 while ((ch
= *string
++) != '\0')
2209 fputc_unfiltered (ch
, gdb_stdlog
);
2212 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2216 fputs_unfiltered ("\\\\", gdb_stdlog
);
2219 fputs_unfiltered ("\\b", gdb_stdlog
);
2222 fputs_unfiltered ("\\f", gdb_stdlog
);
2226 fputs_unfiltered ("\\n", gdb_stdlog
);
2229 fputs_unfiltered ("\\r", gdb_stdlog
);
2232 fputs_unfiltered ("\\t", gdb_stdlog
);
2235 fputs_unfiltered ("\\v", gdb_stdlog
);
2239 return_p
= ch
== '\r';
2242 /* Print suffix if we printed a newline. */
2245 fputs_unfiltered (suffix
, gdb_stdlog
);
2246 fputs_unfiltered ("\n", gdb_stdlog
);
2251 /* Print a variable number of ARGS using format FORMAT. If this
2252 information is going to put the amount written (since the last call
2253 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2254 call prompt_for_continue to get the users permision to continue.
2256 Unlike fprintf, this function does not return a value.
2258 We implement three variants, vfprintf (takes a vararg list and stream),
2259 fprintf (takes a stream to write on), and printf (the usual).
2261 Note also that a longjmp to top level may occur in this routine
2262 (since prompt_for_continue may do so) so this routine should not be
2263 called when cleanups are not in place. */
2266 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2267 va_list args
, int filter
)
2270 struct cleanup
*old_cleanups
;
2272 linebuffer
= xstrvprintf (format
, args
);
2273 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2274 fputs_maybe_filtered (linebuffer
, stream
, filter
);
2275 do_cleanups (old_cleanups
);
2280 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2282 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2286 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2289 struct cleanup
*old_cleanups
;
2291 linebuffer
= xstrvprintf (format
, args
);
2292 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2293 if (debug_timestamp
&& stream
== gdb_stdlog
)
2299 gettimeofday (&tm
, NULL
);
2301 len
= strlen (linebuffer
);
2302 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2304 timestamp
= xstrprintf ("%ld:%ld %s%s",
2305 (long) tm
.tv_sec
, (long) tm
.tv_usec
,
2307 need_nl
? "\n": "");
2308 make_cleanup (xfree
, timestamp
);
2309 fputs_unfiltered (timestamp
, stream
);
2312 fputs_unfiltered (linebuffer
, stream
);
2313 do_cleanups (old_cleanups
);
2317 vprintf_filtered (const char *format
, va_list args
)
2319 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2323 vprintf_unfiltered (const char *format
, va_list args
)
2325 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2329 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2333 va_start (args
, format
);
2334 vfprintf_filtered (stream
, format
, args
);
2339 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2343 va_start (args
, format
);
2344 vfprintf_unfiltered (stream
, format
, args
);
2348 /* Like fprintf_filtered, but prints its result indented.
2349 Called as fprintfi_filtered (spaces, stream, format, ...); */
2352 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2357 va_start (args
, format
);
2358 print_spaces_filtered (spaces
, stream
);
2360 vfprintf_filtered (stream
, format
, args
);
2366 printf_filtered (const char *format
, ...)
2370 va_start (args
, format
);
2371 vfprintf_filtered (gdb_stdout
, format
, args
);
2377 printf_unfiltered (const char *format
, ...)
2381 va_start (args
, format
);
2382 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2386 /* Like printf_filtered, but prints it's result indented.
2387 Called as printfi_filtered (spaces, format, ...); */
2390 printfi_filtered (int spaces
, const char *format
, ...)
2394 va_start (args
, format
);
2395 print_spaces_filtered (spaces
, gdb_stdout
);
2396 vfprintf_filtered (gdb_stdout
, format
, args
);
2400 /* Easy -- but watch out!
2402 This routine is *not* a replacement for puts()! puts() appends a newline.
2403 This one doesn't, and had better not! */
2406 puts_filtered (const char *string
)
2408 fputs_filtered (string
, gdb_stdout
);
2412 puts_unfiltered (const char *string
)
2414 fputs_unfiltered (string
, gdb_stdout
);
2417 /* Return a pointer to N spaces and a null. The pointer is good
2418 until the next call to here. */
2423 static char *spaces
= 0;
2424 static int max_spaces
= -1;
2430 spaces
= (char *) xmalloc (n
+ 1);
2431 for (t
= spaces
+ n
; t
!= spaces
;)
2437 return spaces
+ max_spaces
- n
;
2440 /* Print N spaces. */
2442 print_spaces_filtered (int n
, struct ui_file
*stream
)
2444 fputs_filtered (n_spaces (n
), stream
);
2447 /* C++/ObjC demangler stuff. */
2449 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2450 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2451 If the name is not mangled, or the language for the name is unknown, or
2452 demangling is off, the name is printed in its "raw" form. */
2455 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2456 enum language lang
, int arg_mode
)
2462 /* If user wants to see raw output, no problem. */
2465 fputs_filtered (name
, stream
);
2469 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2470 fputs_filtered (demangled
? demangled
: name
, stream
);
2471 if (demangled
!= NULL
)
2479 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2480 differences in whitespace. Returns 0 if they match, non-zero if they
2481 don't (slightly different than strcmp()'s range of return values).
2483 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2484 This "feature" is useful when searching for matching C++ function names
2485 (such as if the user types 'break FOO', where FOO is a mangled C++
2489 strcmp_iw (const char *string1
, const char *string2
)
2491 while ((*string1
!= '\0') && (*string2
!= '\0'))
2493 while (isspace (*string1
))
2497 while (isspace (*string2
))
2501 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2503 if (case_sensitivity
== case_sensitive_off
2504 && (tolower ((unsigned char) *string1
)
2505 != tolower ((unsigned char) *string2
)))
2507 if (*string1
!= '\0')
2513 return (*string1
!= '\0' && *string1
!= '(') || (*string2
!= '\0');
2516 /* This is like strcmp except that it ignores whitespace and treats
2517 '(' as the first non-NULL character in terms of ordering. Like
2518 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2519 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2520 according to that ordering.
2522 If a list is sorted according to this function and if you want to
2523 find names in the list that match some fixed NAME according to
2524 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2525 where this function would put NAME.
2527 This function must be neutral to the CASE_SENSITIVITY setting as the user
2528 may choose it during later lookup. Therefore this function always sorts
2529 primarily case-insensitively and secondarily case-sensitively.
2531 Here are some examples of why using strcmp to sort is a bad idea:
2535 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2536 we try to do a search for "foo<char*>", strcmp will locate this
2537 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2538 will start looking at strings beginning with "goo", and will never
2539 see the correct match of "foo<char *>".
2541 Parenthesis example:
2543 In practice, this is less like to be an issue, but I'll give it a
2544 shot. Let's assume that '$' is a legitimate character to occur in
2545 symbols. (Which may well even be the case on some systems.) Then
2546 say that the partial symbol table contains "foo$" and "foo(int)".
2547 strcmp will put them in this order, since '$' < '('. Now, if the
2548 user searches for "foo", then strcmp will sort "foo" before "foo$".
2549 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2550 "foo") is false, so it won't proceed to the actual match of
2551 "foo(int)" with "foo". */
2554 strcmp_iw_ordered (const char *string1
, const char *string2
)
2556 const char *saved_string1
= string1
, *saved_string2
= string2
;
2557 enum case_sensitivity case_pass
= case_sensitive_off
;
2561 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2562 Provide stub characters if we are already at the end of one of the
2564 char c1
= 'X', c2
= 'X';
2566 while (*string1
!= '\0' && *string2
!= '\0')
2568 while (isspace (*string1
))
2570 while (isspace (*string2
))
2575 case case_sensitive_off
:
2576 c1
= tolower ((unsigned char) *string1
);
2577 c2
= tolower ((unsigned char) *string2
);
2579 case case_sensitive_on
:
2587 if (*string1
!= '\0')
2596 /* Characters are non-equal unless they're both '\0'; we want to
2597 make sure we get the comparison right according to our
2598 comparison in the cases where one of them is '\0' or '('. */
2600 if (*string2
== '\0')
2605 if (*string2
== '\0')
2610 if (*string2
== '\0' || *string2
== '(')
2619 if (case_pass
== case_sensitive_on
)
2622 /* Otherwise the strings were equal in case insensitive way, make
2623 a more fine grained comparison in a case sensitive way. */
2625 case_pass
= case_sensitive_on
;
2626 string1
= saved_string1
;
2627 string2
= saved_string2
;
2631 /* A simple comparison function with opposite semantics to strcmp. */
2634 streq (const char *lhs
, const char *rhs
)
2636 return !strcmp (lhs
, rhs
);
2642 ** Answer whether string_to_compare is a full or partial match to
2643 ** template_string. The partial match must be in sequence starting
2647 subset_compare (char *string_to_compare
, char *template_string
)
2651 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
2652 && strlen (string_to_compare
) <= strlen (template_string
))
2655 (template_string
, string_to_compare
, strlen (string_to_compare
)) == 0);
2662 pagination_on_command (char *arg
, int from_tty
)
2664 pagination_enabled
= 1;
2668 pagination_off_command (char *arg
, int from_tty
)
2670 pagination_enabled
= 0;
2674 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2675 struct cmd_list_element
*c
, const char *value
)
2677 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2683 initialize_utils (void)
2685 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
2686 Set number of characters where GDB should wrap lines of its output."), _("\
2687 Show number of characters where GDB should wrap lines of its output."), _("\
2688 This affects where GDB wraps its output to fit the screen width.\n\
2689 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2691 show_chars_per_line
,
2692 &setlist
, &showlist
);
2694 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
2695 Set number of lines in a page for GDB output pagination."), _("\
2696 Show number of lines in a page for GDB output pagination."), _("\
2697 This affects the number of lines after which GDB will pause\n\
2698 its output and ask you whether to continue.\n\
2699 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2701 show_lines_per_page
,
2702 &setlist
, &showlist
);
2706 add_setshow_boolean_cmd ("pagination", class_support
,
2707 &pagination_enabled
, _("\
2708 Set state of GDB output pagination."), _("\
2709 Show state of GDB output pagination."), _("\
2710 When pagination is ON, GDB pauses at end of each screenful of\n\
2711 its output and asks you whether to continue.\n\
2712 Turning pagination off is an alternative to \"set height unlimited\"."),
2714 show_pagination_enabled
,
2715 &setlist
, &showlist
);
2719 add_com ("am", class_support
, pagination_on_command
,
2720 _("Enable pagination"));
2721 add_com ("sm", class_support
, pagination_off_command
,
2722 _("Disable pagination"));
2725 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
2726 &sevenbit_strings
, _("\
2727 Set printing of 8-bit characters in strings as \\nnn."), _("\
2728 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
2730 show_sevenbit_strings
,
2731 &setprintlist
, &showprintlist
);
2733 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
2734 &debug_timestamp
, _("\
2735 Set timestamping of debugging messages."), _("\
2736 Show timestamping of debugging messages."), _("\
2737 When set, debugging messages will be marked with seconds and microseconds."),
2739 show_debug_timestamp
,
2740 &setdebuglist
, &showdebuglist
);
2743 /* Print routines to handle variable size regs, etc. */
2744 /* Temporary storage using circular buffer. */
2750 static char buf
[NUMCELLS
][CELLSIZE
];
2751 static int cell
= 0;
2753 if (++cell
>= NUMCELLS
)
2759 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2761 /* Truncate address to the size of a target address, avoiding shifts
2762 larger or equal than the width of a CORE_ADDR. The local
2763 variable ADDR_BIT stops the compiler reporting a shift overflow
2764 when it won't occur. */
2765 /* NOTE: This assumes that the significant address information is
2766 kept in the least significant bits of ADDR - the upper bits were
2767 either zero or sign extended. Should gdbarch_address_to_pointer or
2768 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2770 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2772 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2773 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2774 return hex_string (addr
);
2777 /* This function is described in "defs.h". */
2780 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2782 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2784 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2785 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2787 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2788 that returns the language localized string formatted to a width
2789 based on gdbarch_addr_bit. */
2791 return hex_string_custom (address
, 8);
2793 return hex_string_custom (address
, 16);
2796 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2799 core_addr_hash (const void *ap
)
2801 const CORE_ADDR
*addrp
= ap
;
2806 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2809 core_addr_eq (const void *ap
, const void *bp
)
2811 const CORE_ADDR
*addr_ap
= ap
;
2812 const CORE_ADDR
*addr_bp
= bp
;
2814 return *addr_ap
== *addr_bp
;
2818 decimal2str (char *sign
, ULONGEST addr
, int width
)
2820 /* Steal code from valprint.c:print_decimal(). Should this worry
2821 about the real size of addr as the above does? */
2822 unsigned long temp
[3];
2823 char *str
= get_cell ();
2828 temp
[i
] = addr
% (1000 * 1000 * 1000);
2829 addr
/= (1000 * 1000 * 1000);
2833 while (addr
!= 0 && i
< (sizeof (temp
) / sizeof (temp
[0])));
2842 xsnprintf (str
, CELLSIZE
, "%s%0*lu", sign
, width
, temp
[0]);
2845 xsnprintf (str
, CELLSIZE
, "%s%0*lu%09lu", sign
, width
,
2849 xsnprintf (str
, CELLSIZE
, "%s%0*lu%09lu%09lu", sign
, width
,
2850 temp
[2], temp
[1], temp
[0]);
2853 internal_error (__FILE__
, __LINE__
,
2854 _("failed internal consistency check"));
2861 octal2str (ULONGEST addr
, int width
)
2863 unsigned long temp
[3];
2864 char *str
= get_cell ();
2869 temp
[i
] = addr
% (0100000 * 0100000);
2870 addr
/= (0100000 * 0100000);
2874 while (addr
!= 0 && i
< (sizeof (temp
) / sizeof (temp
[0])));
2884 xsnprintf (str
, CELLSIZE
, "%*o", width
, 0);
2886 xsnprintf (str
, CELLSIZE
, "0%0*lo", width
, temp
[0]);
2889 xsnprintf (str
, CELLSIZE
, "0%0*lo%010lo", width
, temp
[1], temp
[0]);
2892 xsnprintf (str
, CELLSIZE
, "0%0*lo%010lo%010lo", width
,
2893 temp
[2], temp
[1], temp
[0]);
2896 internal_error (__FILE__
, __LINE__
,
2897 _("failed internal consistency check"));
2904 pulongest (ULONGEST u
)
2906 return decimal2str ("", u
, 0);
2910 plongest (LONGEST l
)
2913 return decimal2str ("-", -l
, 0);
2915 return decimal2str ("", l
, 0);
2918 /* Eliminate warning from compiler on 32-bit systems. */
2919 static int thirty_two
= 32;
2922 phex (ULONGEST l
, int sizeof_l
)
2930 xsnprintf (str
, CELLSIZE
, "%08lx%08lx",
2931 (unsigned long) (l
>> thirty_two
),
2932 (unsigned long) (l
& 0xffffffff));
2936 xsnprintf (str
, CELLSIZE
, "%08lx", (unsigned long) l
);
2940 xsnprintf (str
, CELLSIZE
, "%04x", (unsigned short) (l
& 0xffff));
2943 str
= phex (l
, sizeof (l
));
2951 phex_nz (ULONGEST l
, int sizeof_l
)
2959 unsigned long high
= (unsigned long) (l
>> thirty_two
);
2963 xsnprintf (str
, CELLSIZE
, "%lx",
2964 (unsigned long) (l
& 0xffffffff));
2966 xsnprintf (str
, CELLSIZE
, "%lx%08lx", high
,
2967 (unsigned long) (l
& 0xffffffff));
2972 xsnprintf (str
, CELLSIZE
, "%lx", (unsigned long) l
);
2976 xsnprintf (str
, CELLSIZE
, "%x", (unsigned short) (l
& 0xffff));
2979 str
= phex_nz (l
, sizeof (l
));
2986 /* Converts a LONGEST to a C-format hexadecimal literal and stores it
2987 in a static string. Returns a pointer to this string. */
2989 hex_string (LONGEST num
)
2991 char *result
= get_cell ();
2993 xsnprintf (result
, CELLSIZE
, "0x%s", phex_nz (num
, sizeof (num
)));
2997 /* Converts a LONGEST number to a C-format hexadecimal literal and
2998 stores it in a static string. Returns a pointer to this string
2999 that is valid until the next call. The number is padded on the
3000 left with 0s to at least WIDTH characters. */
3002 hex_string_custom (LONGEST num
, int width
)
3004 char *result
= get_cell ();
3005 char *result_end
= result
+ CELLSIZE
- 1;
3006 const char *hex
= phex_nz (num
, sizeof (num
));
3007 int hex_len
= strlen (hex
);
3009 if (hex_len
> width
)
3011 if (width
+ 2 >= CELLSIZE
)
3012 internal_error (__FILE__
, __LINE__
, _("\
3013 hex_string_custom: insufficient space to store result"));
3015 strcpy (result_end
- width
- 2, "0x");
3016 memset (result_end
- width
, '0', width
);
3017 strcpy (result_end
- hex_len
, hex
);
3018 return result_end
- width
- 2;
3021 /* Convert VAL to a numeral in the given radix. For
3022 * radix 10, IS_SIGNED may be true, indicating a signed quantity;
3023 * otherwise VAL is interpreted as unsigned. If WIDTH is supplied,
3024 * it is the minimum width (0-padded if needed). USE_C_FORMAT means
3025 * to use C format in all cases. If it is false, then 'x'
3026 * and 'o' formats do not include a prefix (0x or leading 0). */
3029 int_string (LONGEST val
, int radix
, int is_signed
, int width
,
3039 result
= hex_string (val
);
3041 result
= hex_string_custom (val
, width
);
3048 if (is_signed
&& val
< 0)
3049 return decimal2str ("-", -val
, width
);
3051 return decimal2str ("", val
, width
);
3055 char *result
= octal2str (val
, width
);
3057 if (use_c_format
|| val
== 0)
3063 internal_error (__FILE__
, __LINE__
,
3064 _("failed internal consistency check"));
3068 /* Convert a CORE_ADDR into a string. */
3070 core_addr_to_string (const CORE_ADDR addr
)
3072 char *str
= get_cell ();
3075 strcat (str
, phex (addr
, sizeof (addr
)));
3080 core_addr_to_string_nz (const CORE_ADDR addr
)
3082 char *str
= get_cell ();
3085 strcat (str
, phex_nz (addr
, sizeof (addr
)));
3089 /* Convert a string back into a CORE_ADDR. */
3091 string_to_core_addr (const char *my_string
)
3095 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
3097 /* Assume that it is in hex. */
3100 for (i
= 2; my_string
[i
] != '\0'; i
++)
3102 if (isdigit (my_string
[i
]))
3103 addr
= (my_string
[i
] - '0') + (addr
* 16);
3104 else if (isxdigit (my_string
[i
]))
3105 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
3107 error (_("invalid hex \"%s\""), my_string
);
3112 /* Assume that it is in decimal. */
3115 for (i
= 0; my_string
[i
] != '\0'; i
++)
3117 if (isdigit (my_string
[i
]))
3118 addr
= (my_string
[i
] - '0') + (addr
* 10);
3120 error (_("invalid decimal \"%s\""), my_string
);
3128 host_address_to_string (const void *addr
)
3130 char *str
= get_cell ();
3132 xsnprintf (str
, CELLSIZE
, "0x%s", phex_nz ((uintptr_t) addr
, sizeof (addr
)));
3137 gdb_realpath (const char *filename
)
3139 /* Method 1: The system has a compile time upper bound on a filename
3140 path. Use that and realpath() to canonicalize the name. This is
3141 the most common case. Note that, if there isn't a compile time
3142 upper bound, you want to avoid realpath() at all costs. */
3143 #if defined (HAVE_REALPATH) && defined (PATH_MAX)
3146 const char *rp
= realpath (filename
, buf
);
3150 return xstrdup (rp
);
3152 #endif /* HAVE_REALPATH */
3154 /* Method 2: The host system (i.e., GNU) has the function
3155 canonicalize_file_name() which malloc's a chunk of memory and
3156 returns that, use that. */
3157 #if defined(HAVE_CANONICALIZE_FILE_NAME)
3159 char *rp
= canonicalize_file_name (filename
);
3162 return xstrdup (filename
);
3168 /* FIXME: cagney/2002-11-13:
3170 Method 2a: Use realpath() with a NULL buffer. Some systems, due
3171 to the problems described in method 3, have modified their
3172 realpath() implementation so that it will allocate a buffer when
3173 NULL is passed in. Before this can be used, though, some sort of
3174 configure time test would need to be added. Otherwize the code
3175 will likely core dump. */
3177 /* Method 3: Now we're getting desperate! The system doesn't have a
3178 compile time buffer size and no alternative function. Query the
3179 OS, using pathconf(), for the buffer limit. Care is needed
3180 though, some systems do not limit PATH_MAX (return -1 for
3181 pathconf()) making it impossible to pass a correctly sized buffer
3182 to realpath() (it could always overflow). On those systems, we
3184 #if defined (HAVE_REALPATH) && defined (_PC_PATH_MAX) && defined(HAVE_ALLOCA)
3186 /* Find out the max path size. */
3187 long path_max
= pathconf ("/", _PC_PATH_MAX
);
3191 /* PATH_MAX is bounded. */
3192 char *buf
= alloca (path_max
);
3193 char *rp
= realpath (filename
, buf
);
3195 return xstrdup (rp
? rp
: filename
);
3200 /* The MS Windows method. If we don't have realpath, we assume we
3201 don't have symlinks and just canonicalize to a Windows absolute
3202 path. GetFullPath converts ../ and ./ in relative paths to
3203 absolute paths, filling in current drive if one is not given
3204 or using the current directory of a specified drive (eg, "E:foo").
3205 It also converts all forward slashes to back slashes. */
3206 /* The file system is case-insensitive but case-preserving.
3207 So we do not lowercase the path. Otherwise, we might not
3208 be able to display the original casing in a given path. */
3209 #if defined (_WIN32)
3212 DWORD len
= GetFullPathName (filename
, MAX_PATH
, buf
, NULL
);
3214 if (len
> 0 && len
< MAX_PATH
)
3215 return xstrdup (buf
);
3219 /* This system is a lost cause, just dup the buffer. */
3220 return xstrdup (filename
);
3224 align_up (ULONGEST v
, int n
)
3226 /* Check that N is really a power of two. */
3227 gdb_assert (n
&& (n
& (n
-1)) == 0);
3228 return (v
+ n
- 1) & -n
;
3232 align_down (ULONGEST v
, int n
)
3234 /* Check that N is really a power of two. */
3235 gdb_assert (n
&& (n
& (n
-1)) == 0);
3242 gdb_sign_extend (LONGEST value
, int bit
)
3244 gdb_assert (bit
>= 1 && bit
<= 8 * sizeof (LONGEST
));
3246 if (((value
>> (bit
- 1)) & 1) != 0)
3248 LONGEST signbit
= ((LONGEST
) 1) << (bit
- 1);
3250 value
= (value
^ signbit
) - signbit
;
3256 /* Allocation function for the libiberty hash table which uses an
3257 obstack. The obstack is passed as DATA. */
3260 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
3262 unsigned int total
= size
* count
;
3263 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
3265 memset (ptr
, 0, total
);
3269 /* Trivial deallocation function for the libiberty splay tree and hash
3270 table - don't deallocate anything. Rely on later deletion of the
3271 obstack. DATA will be the obstack, although it is not needed
3275 dummy_obstack_deallocate (void *object
, void *data
)
3280 /* The bit offset of the highest byte in a ULONGEST, for overflow
3283 #define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT)
3285 /* True (non-zero) iff DIGIT is a valid digit in radix BASE,
3286 where 2 <= BASE <= 36. */
3289 is_digit_in_base (unsigned char digit
, int base
)
3291 if (!isalnum (digit
))
3294 return (isdigit (digit
) && digit
< base
+ '0');
3296 return (isdigit (digit
) || tolower (digit
) < base
- 10 + 'a');
3300 digit_to_int (unsigned char c
)
3305 return tolower (c
) - 'a' + 10;
3308 /* As for strtoul, but for ULONGEST results. */
3311 strtoulst (const char *num
, const char **trailer
, int base
)
3313 unsigned int high_part
;
3318 /* Skip leading whitespace. */
3319 while (isspace (num
[i
]))
3322 /* Handle prefixes. */
3325 else if (num
[i
] == '-')
3331 if (base
== 0 || base
== 16)
3333 if (num
[i
] == '0' && (num
[i
+ 1] == 'x' || num
[i
+ 1] == 'X'))
3341 if (base
== 0 && num
[i
] == '0')
3347 if (base
< 2 || base
> 36)
3353 result
= high_part
= 0;
3354 for (; is_digit_in_base (num
[i
], base
); i
+= 1)
3356 result
= result
* base
+ digit_to_int (num
[i
]);
3357 high_part
= high_part
* base
+ (unsigned int) (result
>> HIGH_BYTE_POSN
);
3358 result
&= ((ULONGEST
) 1 << HIGH_BYTE_POSN
) - 1;
3359 if (high_part
> 0xff)
3362 result
= ~ (ULONGEST
) 0;
3369 if (trailer
!= NULL
)
3372 result
= result
+ ((ULONGEST
) high_part
<< HIGH_BYTE_POSN
);
3379 /* Simple, portable version of dirname that does not modify its
3383 ldirname (const char *filename
)
3385 const char *base
= lbasename (filename
);
3388 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
3391 if (base
== filename
)
3394 dirname
= xmalloc (base
- filename
+ 2);
3395 memcpy (dirname
, filename
, base
- filename
);
3397 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3398 create "d:./bar" later instead of the (different) "d:/bar". */
3399 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3400 && !IS_DIR_SEPARATOR (filename
[0]))
3401 dirname
[base
++ - filename
] = '.';
3403 dirname
[base
- filename
] = '\0';
3407 /* Call libiberty's buildargv, and return the result.
3408 If buildargv fails due to out-of-memory, call nomem.
3409 Therefore, the returned value is guaranteed to be non-NULL,
3410 unless the parameter itself is NULL. */
3413 gdb_buildargv (const char *s
)
3415 char **argv
= buildargv (s
);
3417 if (s
!= NULL
&& argv
== NULL
)
3423 compare_positive_ints (const void *ap
, const void *bp
)
3425 /* Because we know we're comparing two ints which are positive,
3426 there's no danger of overflow here. */
3427 return * (int *) ap
- * (int *) bp
;
3430 /* String compare function for qsort. */
3433 compare_strings (const void *arg1
, const void *arg2
)
3435 const char **s1
= (const char **) arg1
;
3436 const char **s2
= (const char **) arg2
;
3438 return strcmp (*s1
, *s2
);
3441 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3442 #define AMBIGUOUS_MESS2 \
3443 ".\nUse \"set gnutarget format-name\" to specify the format."
3446 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3452 /* Check if errmsg just need simple return. */
3453 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3454 return bfd_errmsg (error_tag
);
3456 ret_len
= strlen (bfd_errmsg (error_tag
)) + strlen (AMBIGUOUS_MESS1
)
3457 + strlen (AMBIGUOUS_MESS2
);
3458 for (p
= matching
; *p
; p
++)
3459 ret_len
+= strlen (*p
) + 1;
3460 ret
= xmalloc (ret_len
+ 1);
3462 make_cleanup (xfree
, ret
);
3464 strcpy (retp
, bfd_errmsg (error_tag
));
3465 retp
+= strlen (retp
);
3467 strcpy (retp
, AMBIGUOUS_MESS1
);
3468 retp
+= strlen (retp
);
3470 for (p
= matching
; *p
; p
++)
3472 sprintf (retp
, " %s", *p
);
3473 retp
+= strlen (retp
);
3477 strcpy (retp
, AMBIGUOUS_MESS2
);
3482 /* Return ARGS parsed as a valid pid, or throw an error. */
3485 parse_pid_to_attach (char *args
)
3491 error_no_arg (_("process-id to attach"));
3494 pid
= strtoul (args
, &dummy
, 0);
3495 /* Some targets don't set errno on errors, grrr! */
3496 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3497 error (_("Illegal process-id: %s."), args
);
3502 /* Helper for make_bpstat_clear_actions_cleanup. */
3505 do_bpstat_clear_actions_cleanup (void *unused
)
3507 bpstat_clear_actions ();
3510 /* Call bpstat_clear_actions for the case an exception is throw. You should
3511 discard_cleanups if no exception is caught. */
3514 make_bpstat_clear_actions_cleanup (void)
3516 return make_cleanup (do_bpstat_clear_actions_cleanup
, NULL
);
3519 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3520 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3521 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3524 producer_is_gcc_ge_4 (const char *producer
)
3529 if (producer
== NULL
)
3531 /* For unknown compilers expect their behavior is not compliant. For GCC
3532 this case can also happen for -gdwarf-4 type units supported since
3538 /* Skip any identifier after "GNU " - such as "C++" or "Java". */
3540 if (strncmp (producer
, "GNU ", strlen ("GNU ")) != 0)
3542 /* For non-GCC compilers expect their behavior is not compliant. */
3546 cs
= &producer
[strlen ("GNU ")];
3547 while (*cs
&& !isdigit (*cs
))
3549 if (sscanf (cs
, "%d.%d", &major
, &minor
) != 2)
3551 /* Not recognized as GCC. */
3563 /* Helper for make_cleanup_free_char_ptr_vec. */
3566 do_free_char_ptr_vec (void *arg
)
3568 VEC (char_ptr
) *char_ptr_vec
= arg
;
3570 free_char_ptr_vec (char_ptr_vec
);
3573 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3574 final VEC_free for CHAR_PTR_VEC itself.
3576 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3577 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3578 this function does not (cannot) clear the pointer. */
3581 make_cleanup_free_char_ptr_vec (VEC (char_ptr
) *char_ptr_vec
)
3583 return make_cleanup (do_free_char_ptr_vec
, char_ptr_vec
);
3586 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3587 must come from xrealloc-compatible allocator and it may be updated. FROM
3588 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3589 located at the start or end of *STRINGP. */
3592 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3594 char *string
= *stringp
, *s
;
3595 const size_t from_len
= strlen (from
);
3596 const size_t to_len
= strlen (to
);
3600 s
= strstr (s
, from
);
3604 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3605 || s
[-1] == DIRNAME_SEPARATOR
)
3606 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3607 || s
[from_len
] == DIRNAME_SEPARATOR
))
3611 string_new
= xrealloc (string
, (strlen (string
) + to_len
+ 1));
3613 /* Relocate the current S pointer. */
3614 s
= s
- string
+ string_new
;
3615 string
= string_new
;
3617 /* Replace from by to. */
3618 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3619 memcpy (s
, to
, to_len
);
3634 /* SIGALRM handler for waitpid_with_timeout. */
3637 sigalrm_handler (int signo
)
3639 /* Nothing to do. */
3644 /* Wrapper to wait for child PID to die with TIMEOUT.
3645 TIMEOUT is the time to stop waiting in seconds.
3646 If TIMEOUT is zero, pass WNOHANG to waitpid.
3647 Returns PID if it was successfully waited for, otherwise -1.
3649 Timeouts are currently implemented with alarm and SIGALRM.
3650 If the host does not support them, this waits "forever".
3651 It would be odd though for a host to have waitpid and not SIGALRM. */
3654 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3656 pid_t waitpid_result
;
3658 gdb_assert (pid
> 0);
3659 gdb_assert (timeout
>= 0);
3664 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3665 struct sigaction sa
, old_sa
;
3667 sa
.sa_handler
= sigalrm_handler
;
3668 sigemptyset (&sa
.sa_mask
);
3670 sigaction (SIGALRM
, &sa
, &old_sa
);
3674 ofunc
= (void (*)()) signal (SIGALRM
, sigalrm_handler
);
3680 waitpid_result
= waitpid (pid
, status
, 0);
3684 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3685 sigaction (SIGALRM
, &old_sa
, NULL
);
3687 signal (SIGALRM
, ofunc
);
3692 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3694 if (waitpid_result
== pid
)
3700 #endif /* HAVE_WAITPID */
3702 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3703 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3705 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3706 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3709 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3711 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3713 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3714 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3716 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3718 char *pattern_slash
, *string_slash
;
3720 /* Replace '\' by '/' in both strings. */
3722 pattern_slash
= alloca (strlen (pattern
) + 1);
3723 strcpy (pattern_slash
, pattern
);
3724 pattern
= pattern_slash
;
3725 for (; *pattern_slash
!= 0; pattern_slash
++)
3726 if (IS_DIR_SEPARATOR (*pattern_slash
))
3727 *pattern_slash
= '/';
3729 string_slash
= alloca (strlen (string
) + 1);
3730 strcpy (string_slash
, string
);
3731 string
= string_slash
;
3732 for (; *string_slash
!= 0; string_slash
++)
3733 if (IS_DIR_SEPARATOR (*string_slash
))
3734 *string_slash
= '/';
3736 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3738 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3739 flags
|= FNM_CASEFOLD
;
3740 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3742 return fnmatch (pattern
, string
, flags
);
3745 /* Provide a prototype to silence -Wmissing-prototypes. */
3746 extern initialize_file_ftype _initialize_utils
;
3749 _initialize_utils (void)
3751 add_internal_problem_command (&internal_error_problem
);
3752 add_internal_problem_command (&internal_warning_problem
);