1 /* General utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2013 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 #include "dyn-string.h"
22 #include "gdb_assert.h"
24 #include "gdb_string.h"
26 #include "event-top.h"
27 #include "exceptions.h"
28 #include "gdbthread.h"
31 #ifdef HAVE_SYS_RESOURCE_H
32 #include <sys/resource.h>
33 #endif /* HAVE_SYS_RESOURCE_H */
36 #include "tui/tui.h" /* For tui_get_command_dimension. */
43 /* SunOS's curses.h has a '#define reg register' in it. Thank you Sun. */
49 #include "timeval-utils.h"
54 #include "gdb-demangle.h"
55 #include "expression.h"
59 #include "filenames.h"
61 #include "gdb_obstack.h"
67 #include "inferior.h" /* for signed_pointer_to_address */
69 #include <sys/param.h> /* For MAXPATHLEN */
71 #include "gdb_curses.h"
73 #include "readline/readline.h"
78 #include "gdb_usleep.h"
80 #include "gdb_regex.h"
83 extern PTR
malloc (); /* ARI: PTR */
85 #if !HAVE_DECL_REALLOC
86 extern PTR
realloc (); /* ARI: PTR */
92 void (*deprecated_error_begin_hook
) (void);
94 /* Prototypes for local functions */
96 static void vfprintf_maybe_filtered (struct ui_file
*, const char *,
97 va_list, int) ATTRIBUTE_PRINTF (2, 0);
99 static void fputs_maybe_filtered (const char *, struct ui_file
*, int);
101 static void prompt_for_continue (void);
103 static void set_screen_size (void);
104 static void set_width (void);
106 /* Time spent in prompt_for_continue in the currently executing command
107 waiting for user to respond.
108 Initialized in make_command_stats_cleanup.
109 Modified in prompt_for_continue and defaulted_query.
110 Used in report_command_stats. */
112 static struct timeval prompt_for_continue_wait_time
;
114 /* A flag indicating whether to timestamp debugging messages. */
116 static int debug_timestamp
= 0;
118 /* Nonzero if we have job control. */
123 /* Nonzero means a quit has been requested. */
126 #endif /* HAVE_PYTHON */
128 /* Nonzero means quit immediately if Control-C is typed now, rather
129 than waiting until QUIT is executed. Be careful in setting this;
130 code which executes with immediate_quit set has to be very careful
131 about being able to deal with being interrupted at any time. It is
132 almost always better to use QUIT; the only exception I can think of
133 is being able to quit out of a system call (using EINTR loses if
134 the SIGINT happens between the previous QUIT and the system call).
135 To immediately quit in the case in which a SIGINT happens between
136 the previous QUIT and setting immediate_quit (desirable anytime we
137 expect to block), call QUIT after setting immediate_quit. */
143 /* Clear the quit flag. */
146 clear_quit_flag (void)
151 /* Set the quit flag. */
159 /* Return true if the quit flag has been set, false otherwise. */
162 check_quit_flag (void)
164 /* This is written in a particular way to avoid races. */
174 #endif /* HAVE_PYTHON */
176 /* Nonzero means that strings with character values >0x7F should be printed
177 as octal escapes. Zero means just print the value (e.g. it's an
178 international character, and the terminal or window can cope.) */
180 int sevenbit_strings
= 0;
182 show_sevenbit_strings (struct ui_file
*file
, int from_tty
,
183 struct cmd_list_element
*c
, const char *value
)
185 fprintf_filtered (file
, _("Printing of 8-bit characters "
186 "in strings as \\nnn is %s.\n"),
190 /* String to be printed before error messages, if any. */
192 char *error_pre_print
;
194 /* String to be printed before quit messages, if any. */
196 char *quit_pre_print
;
198 /* String to be printed before warning messages, if any. */
200 char *warning_pre_print
= "\nwarning: ";
202 int pagination_enabled
= 1;
204 show_pagination_enabled (struct ui_file
*file
, int from_tty
,
205 struct cmd_list_element
*c
, const char *value
)
207 fprintf_filtered (file
, _("State of pagination is %s.\n"), value
);
211 /* Cleanup utilities.
213 These are not defined in cleanups.c (nor declared in cleanups.h)
214 because while they use the "cleanup API" they are not part of the
218 do_freeargv (void *arg
)
220 freeargv ((char **) arg
);
224 make_cleanup_freeargv (char **arg
)
226 return make_cleanup (do_freeargv
, arg
);
230 do_dyn_string_delete (void *arg
)
232 dyn_string_delete ((dyn_string_t
) arg
);
236 make_cleanup_dyn_string_delete (dyn_string_t arg
)
238 return make_cleanup (do_dyn_string_delete
, arg
);
242 do_bfd_close_cleanup (void *arg
)
248 make_cleanup_bfd_unref (bfd
*abfd
)
250 return make_cleanup (do_bfd_close_cleanup
, abfd
);
254 do_close_cleanup (void *arg
)
262 make_cleanup_close (int fd
)
264 int *saved_fd
= xmalloc (sizeof (fd
));
267 return make_cleanup_dtor (do_close_cleanup
, saved_fd
, xfree
);
270 /* Helper function which does the work for make_cleanup_fclose. */
273 do_fclose_cleanup (void *arg
)
280 /* Return a new cleanup that closes FILE. */
283 make_cleanup_fclose (FILE *file
)
285 return make_cleanup (do_fclose_cleanup
, file
);
288 /* Helper function which does the work for make_cleanup_obstack_free. */
291 do_obstack_free (void *arg
)
293 struct obstack
*ob
= arg
;
295 obstack_free (ob
, NULL
);
298 /* Return a new cleanup that frees OBSTACK. */
301 make_cleanup_obstack_free (struct obstack
*obstack
)
303 return make_cleanup (do_obstack_free
, obstack
);
307 do_ui_file_delete (void *arg
)
309 ui_file_delete (arg
);
313 make_cleanup_ui_file_delete (struct ui_file
*arg
)
315 return make_cleanup (do_ui_file_delete
, arg
);
318 /* Helper function for make_cleanup_ui_out_redirect_pop. */
321 do_ui_out_redirect_pop (void *arg
)
323 struct ui_out
*uiout
= arg
;
325 if (ui_out_redirect (uiout
, NULL
) < 0)
326 warning (_("Cannot restore redirection of the current output protocol"));
329 /* Return a new cleanup that pops the last redirection by ui_out_redirect
330 with NULL parameter. */
333 make_cleanup_ui_out_redirect_pop (struct ui_out
*uiout
)
335 return make_cleanup (do_ui_out_redirect_pop
, uiout
);
339 do_free_section_addr_info (void *arg
)
341 free_section_addr_info (arg
);
345 make_cleanup_free_section_addr_info (struct section_addr_info
*addrs
)
347 return make_cleanup (do_free_section_addr_info
, addrs
);
350 struct restore_integer_closure
357 restore_integer (void *p
)
359 struct restore_integer_closure
*closure
= p
;
361 *(closure
->variable
) = closure
->value
;
364 /* Remember the current value of *VARIABLE and make it restored when
365 the cleanup is run. */
368 make_cleanup_restore_integer (int *variable
)
370 struct restore_integer_closure
*c
=
371 xmalloc (sizeof (struct restore_integer_closure
));
373 c
->variable
= variable
;
374 c
->value
= *variable
;
376 return make_cleanup_dtor (restore_integer
, (void *) c
, xfree
);
379 /* Remember the current value of *VARIABLE and make it restored when
380 the cleanup is run. */
383 make_cleanup_restore_uinteger (unsigned int *variable
)
385 return make_cleanup_restore_integer ((int *) variable
);
388 /* Helper for make_cleanup_unpush_target. */
391 do_unpush_target (void *arg
)
393 struct target_ops
*ops
= arg
;
398 /* Return a new cleanup that unpushes OPS. */
401 make_cleanup_unpush_target (struct target_ops
*ops
)
403 return make_cleanup (do_unpush_target
, ops
);
406 /* Helper for make_cleanup_htab_delete compile time checking the types. */
409 do_htab_delete_cleanup (void *htab_voidp
)
411 htab_t htab
= htab_voidp
;
416 /* Return a new cleanup that deletes HTAB. */
419 make_cleanup_htab_delete (htab_t htab
)
421 return make_cleanup (do_htab_delete_cleanup
, htab
);
424 struct restore_ui_file_closure
426 struct ui_file
**variable
;
427 struct ui_file
*value
;
431 do_restore_ui_file (void *p
)
433 struct restore_ui_file_closure
*closure
= p
;
435 *(closure
->variable
) = closure
->value
;
438 /* Remember the current value of *VARIABLE and make it restored when
439 the cleanup is run. */
442 make_cleanup_restore_ui_file (struct ui_file
**variable
)
444 struct restore_ui_file_closure
*c
= XNEW (struct restore_ui_file_closure
);
446 c
->variable
= variable
;
447 c
->value
= *variable
;
449 return make_cleanup_dtor (do_restore_ui_file
, (void *) c
, xfree
);
452 /* Helper for make_cleanup_value_free_to_mark. */
455 do_value_free_to_mark (void *value
)
457 value_free_to_mark ((struct value
*) value
);
460 /* Free all values allocated since MARK was obtained by value_mark
461 (except for those released) when the cleanup is run. */
464 make_cleanup_value_free_to_mark (struct value
*mark
)
466 return make_cleanup (do_value_free_to_mark
, mark
);
469 /* Helper for make_cleanup_value_free. */
472 do_value_free (void *value
)
480 make_cleanup_value_free (struct value
*value
)
482 return make_cleanup (do_value_free
, value
);
485 /* Helper for make_cleanup_free_so. */
488 do_free_so (void *arg
)
490 struct so_list
*so
= arg
;
495 /* Make cleanup handler calling free_so for SO. */
498 make_cleanup_free_so (struct so_list
*so
)
500 return make_cleanup (do_free_so
, so
);
503 /* Helper for make_cleanup_restore_current_language. */
506 do_restore_current_language (void *p
)
508 enum language saved_lang
= (uintptr_t) p
;
510 set_language (saved_lang
);
513 /* Remember the current value of CURRENT_LANGUAGE and make it restored when
514 the cleanup is run. */
517 make_cleanup_restore_current_language (void)
519 enum language saved_lang
= current_language
->la_language
;
521 return make_cleanup (do_restore_current_language
,
522 (void *) (uintptr_t) saved_lang
);
525 /* This function is useful for cleanups.
529 old_chain = make_cleanup (free_current_contents, &foo);
531 to arrange to free the object thus allocated. */
534 free_current_contents (void *ptr
)
536 void **location
= ptr
;
538 if (location
== NULL
)
539 internal_error (__FILE__
, __LINE__
,
540 _("free_current_contents: NULL pointer"));
541 if (*location
!= NULL
)
550 /* Print a warning message. The first argument STRING is the warning
551 message, used as an fprintf format string, the second is the
552 va_list of arguments for that string. A warning is unfiltered (not
553 paginated) so that the user does not need to page through each
554 screen full of warnings when there are lots of them. */
557 vwarning (const char *string
, va_list args
)
559 if (deprecated_warning_hook
)
560 (*deprecated_warning_hook
) (string
, args
);
563 target_terminal_ours ();
564 wrap_here (""); /* Force out any buffered output. */
565 gdb_flush (gdb_stdout
);
566 if (warning_pre_print
)
567 fputs_unfiltered (warning_pre_print
, gdb_stderr
);
568 vfprintf_unfiltered (gdb_stderr
, string
, args
);
569 fprintf_unfiltered (gdb_stderr
, "\n");
574 /* Print a warning message.
575 The first argument STRING is the warning message, used as a fprintf string,
576 and the remaining args are passed as arguments to it.
577 The primary difference between warnings and errors is that a warning
578 does not force the return to command level. */
581 warning (const char *string
, ...)
585 va_start (args
, string
);
586 vwarning (string
, args
);
590 /* Print an error message and return to command level.
591 The first argument STRING is the error message, used as a fprintf string,
592 and the remaining args are passed as arguments to it. */
595 verror (const char *string
, va_list args
)
597 throw_verror (GENERIC_ERROR
, string
, args
);
601 error (const char *string
, ...)
605 va_start (args
, string
);
606 throw_verror (GENERIC_ERROR
, string
, args
);
610 /* Print an error message and quit.
611 The first argument STRING is the error message, used as a fprintf string,
612 and the remaining args are passed as arguments to it. */
615 vfatal (const char *string
, va_list args
)
617 throw_vfatal (string
, args
);
621 fatal (const char *string
, ...)
625 va_start (args
, string
);
626 throw_vfatal (string
, args
);
631 error_stream (struct ui_file
*stream
)
633 char *message
= ui_file_xstrdup (stream
, NULL
);
635 make_cleanup (xfree
, message
);
636 error (("%s"), message
);
639 /* Dump core trying to increase the core soft limit to hard limit first. */
644 #ifdef HAVE_SETRLIMIT
645 struct rlimit rlim
= { RLIM_INFINITY
, RLIM_INFINITY
};
647 setrlimit (RLIMIT_CORE
, &rlim
);
648 #endif /* HAVE_SETRLIMIT */
650 abort (); /* NOTE: GDB has only three calls to abort(). */
653 /* Check whether GDB will be able to dump core using the dump_core
657 can_dump_core (const char *reason
)
659 #ifdef HAVE_GETRLIMIT
662 /* Be quiet and assume we can dump if an error is returned. */
663 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
666 if (rlim
.rlim_max
== 0)
668 fprintf_unfiltered (gdb_stderr
,
669 _("%s\nUnable to dump core, use `ulimit -c"
670 " unlimited' before executing GDB next time.\n"),
674 #endif /* HAVE_GETRLIMIT */
679 /* Allow the user to configure the debugger behavior with respect to
680 what to do when an internal problem is detected. */
682 const char internal_problem_ask
[] = "ask";
683 const char internal_problem_yes
[] = "yes";
684 const char internal_problem_no
[] = "no";
685 static const char *const internal_problem_modes
[] =
687 internal_problem_ask
,
688 internal_problem_yes
,
693 /* Print a message reporting an internal error/warning. Ask the user
694 if they want to continue, dump core, or just exit. Return
695 something to indicate a quit. */
697 struct internal_problem
700 const char *should_quit
;
701 const char *should_dump_core
;
704 /* Report a problem, internal to GDB, to the user. Once the problem
705 has been reported, and assuming GDB didn't quit, the caller can
706 either allow execution to resume or throw an error. */
708 static void ATTRIBUTE_PRINTF (4, 0)
709 internal_vproblem (struct internal_problem
*problem
,
710 const char *file
, int line
, const char *fmt
, va_list ap
)
717 /* Don't allow infinite error/warning recursion. */
719 static char msg
[] = "Recursive internal problem.\n";
728 fputs_unfiltered (msg
, gdb_stderr
);
729 abort (); /* NOTE: GDB has only three calls to abort(). */
732 /* Newer GLIBC versions put the warn_unused_result attribute
733 on write, but this is one of those rare cases where
734 ignoring the return value is correct. Casting to (void)
735 does not fix this problem. This is the solution suggested
736 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
737 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
738 abort (); /* NOTE: GDB has only three calls to abort(). */
743 /* Try to get the message out and at the start of a new line. */
744 target_terminal_ours ();
747 /* Create a string containing the full error/warning message. Need
748 to call query with this full string, as otherwize the reason
749 (error/warning) and question become separated. Format using a
750 style similar to a compiler error message. Include extra detail
751 so that the user knows that they are living on the edge. */
755 msg
= xstrvprintf (fmt
, ap
);
756 reason
= xstrprintf ("%s:%d: %s: %s\n"
757 "A problem internal to GDB has been detected,\n"
758 "further debugging may prove unreliable.",
759 file
, line
, problem
->name
, msg
);
761 make_cleanup (xfree
, reason
);
764 if (problem
->should_quit
== internal_problem_ask
)
766 /* Default (yes/batch case) is to quit GDB. When in batch mode
767 this lessens the likelihood of GDB going into an infinite
771 /* Emit the message and quit. */
772 fputs_unfiltered (reason
, gdb_stderr
);
773 fputs_unfiltered ("\n", gdb_stderr
);
777 quit_p
= query (_("%s\nQuit this debugging session? "), reason
);
779 else if (problem
->should_quit
== internal_problem_yes
)
781 else if (problem
->should_quit
== internal_problem_no
)
784 internal_error (__FILE__
, __LINE__
, _("bad switch"));
786 if (problem
->should_dump_core
== internal_problem_ask
)
788 if (!can_dump_core (reason
))
792 /* Default (yes/batch case) is to dump core. This leaves a GDB
793 `dropping' so that it is easier to see that something went
795 dump_core_p
= query (_("%s\nCreate a core file of GDB? "), reason
);
798 else if (problem
->should_dump_core
== internal_problem_yes
)
799 dump_core_p
= can_dump_core (reason
);
800 else if (problem
->should_dump_core
== internal_problem_no
)
803 internal_error (__FILE__
, __LINE__
, _("bad switch"));
816 #ifdef HAVE_WORKING_FORK
826 static struct internal_problem internal_error_problem
= {
827 "internal-error", internal_problem_ask
, internal_problem_ask
831 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
833 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
834 deprecated_throw_reason (RETURN_ERROR
);
838 internal_error (const char *file
, int line
, const char *string
, ...)
842 va_start (ap
, string
);
843 internal_verror (file
, line
, string
, ap
);
847 static struct internal_problem internal_warning_problem
= {
848 "internal-warning", internal_problem_ask
, internal_problem_ask
852 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
854 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
858 internal_warning (const char *file
, int line
, const char *string
, ...)
862 va_start (ap
, string
);
863 internal_vwarning (file
, line
, string
, ap
);
867 /* Dummy functions to keep add_prefix_cmd happy. */
870 set_internal_problem_cmd (char *args
, int from_tty
)
875 show_internal_problem_cmd (char *args
, int from_tty
)
879 /* When GDB reports an internal problem (error or warning) it gives
880 the user the opportunity to quit GDB and/or create a core file of
881 the current debug session. This function registers a few commands
882 that make it possible to specify that GDB should always or never
883 quit or create a core file, without asking. The commands look
886 maint set PROBLEM-NAME quit ask|yes|no
887 maint show PROBLEM-NAME quit
888 maint set PROBLEM-NAME corefile ask|yes|no
889 maint show PROBLEM-NAME corefile
891 Where PROBLEM-NAME is currently "internal-error" or
892 "internal-warning". */
895 add_internal_problem_command (struct internal_problem
*problem
)
897 struct cmd_list_element
**set_cmd_list
;
898 struct cmd_list_element
**show_cmd_list
;
902 set_cmd_list
= xmalloc (sizeof (*set_cmd_list
));
903 show_cmd_list
= xmalloc (sizeof (*set_cmd_list
));
904 *set_cmd_list
= NULL
;
905 *show_cmd_list
= NULL
;
907 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
910 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
913 add_prefix_cmd ((char*) problem
->name
,
914 class_maintenance
, set_internal_problem_cmd
, set_doc
,
916 concat ("maintenance set ", problem
->name
, " ",
918 0/*allow-unknown*/, &maintenance_set_cmdlist
);
920 add_prefix_cmd ((char*) problem
->name
,
921 class_maintenance
, show_internal_problem_cmd
, show_doc
,
923 concat ("maintenance show ", problem
->name
, " ",
925 0/*allow-unknown*/, &maintenance_show_cmdlist
);
927 set_doc
= xstrprintf (_("Set whether GDB should quit "
928 "when an %s is detected"),
930 show_doc
= xstrprintf (_("Show whether GDB will quit "
931 "when an %s is detected"),
933 add_setshow_enum_cmd ("quit", class_maintenance
,
934 internal_problem_modes
,
935 &problem
->should_quit
,
947 set_doc
= xstrprintf (_("Set whether GDB should create a core "
948 "file of GDB when %s is detected"),
950 show_doc
= xstrprintf (_("Show whether GDB will create a core "
951 "file of GDB when %s is detected"),
953 add_setshow_enum_cmd ("corefile", class_maintenance
,
954 internal_problem_modes
,
955 &problem
->should_dump_core
,
968 /* Print the system error message for errno, and also mention STRING
969 as the file name for which the error was encountered. Use ERRCODE
970 for the thrown exception. Then return to command level. */
973 throw_perror_with_name (enum errors errcode
, const char *string
)
978 err
= safe_strerror (errno
);
979 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
980 strcpy (combined
, string
);
981 strcat (combined
, ": ");
982 strcat (combined
, err
);
984 /* I understand setting these is a matter of taste. Still, some people
985 may clear errno but not know about bfd_error. Doing this here is not
987 bfd_set_error (bfd_error_no_error
);
990 throw_error (errcode
, _("%s."), combined
);
993 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
996 perror_with_name (const char *string
)
998 throw_perror_with_name (GENERIC_ERROR
, string
);
1001 /* Print the system error message for ERRCODE, and also mention STRING
1002 as the file name for which the error was encountered. */
1005 print_sys_errmsg (const char *string
, int errcode
)
1010 err
= safe_strerror (errcode
);
1011 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
1012 strcpy (combined
, string
);
1013 strcat (combined
, ": ");
1014 strcat (combined
, err
);
1016 /* We want anything which was printed on stdout to come out first, before
1018 gdb_flush (gdb_stdout
);
1019 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
1022 /* Control C eventually causes this to be called, at a convenient time. */
1028 /* No steenking SIGINT will ever be coming our way when the
1029 program is resumed. Don't lie. */
1033 /* If there is no terminal switching for this target, then we can't
1034 possibly get screwed by the lack of job control. */
1035 || current_target
.to_terminal_ours
== NULL
)
1038 fatal ("Quit (expect signal SIGINT when the program is resumed)");
1043 /* Called when a memory allocation fails, with the number of bytes of
1044 memory requested in SIZE. */
1047 malloc_failure (long size
)
1051 internal_error (__FILE__
, __LINE__
,
1052 _("virtual memory exhausted: can't allocate %ld bytes."),
1057 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
1061 /* My replacement for the read system call.
1062 Used like `read' but keeps going if `read' returns too soon. */
1065 myread (int desc
, char *addr
, int len
)
1072 val
= read (desc
, addr
, len
);
1076 return orglen
- len
;
1084 print_spaces (int n
, struct ui_file
*file
)
1086 fputs_unfiltered (n_spaces (n
), file
);
1089 /* Print a host address. */
1092 gdb_print_host_address (const void *addr
, struct ui_file
*stream
)
1094 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
1098 /* A cleanup function that calls regfree. */
1101 do_regfree_cleanup (void *r
)
1106 /* Create a new cleanup that frees the compiled regular expression R. */
1109 make_regfree_cleanup (regex_t
*r
)
1111 return make_cleanup (do_regfree_cleanup
, r
);
1114 /* Return an xmalloc'd error message resulting from a regular
1115 expression compilation failure. */
1118 get_regcomp_error (int code
, regex_t
*rx
)
1120 size_t length
= regerror (code
, rx
, NULL
, 0);
1121 char *result
= xmalloc (length
);
1123 regerror (code
, rx
, result
, length
);
1127 /* Compile a regexp and throw an exception on error. This returns a
1128 cleanup to free the resulting pattern on success. If RX is NULL,
1129 this does nothing and returns NULL. */
1132 compile_rx_or_error (regex_t
*pattern
, const char *rx
, const char *message
)
1139 code
= regcomp (pattern
, rx
, REG_NOSUB
);
1142 char *err
= get_regcomp_error (code
, pattern
);
1144 make_cleanup (xfree
, err
);
1145 error (("%s: %s"), message
, err
);
1148 return make_regfree_cleanup (pattern
);
1153 /* This function supports the query, nquery, and yquery functions.
1154 Ask user a y-or-n question and return 0 if answer is no, 1 if
1155 answer is yes, or default the answer to the specified default
1156 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1157 default answer, or '\0' for no default.
1158 CTLSTR is the control string and should end in "? ". It should
1159 not say how to answer, because we do that.
1160 ARGS are the arguments passed along with the CTLSTR argument to
1163 static int ATTRIBUTE_PRINTF (1, 0)
1164 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
1170 char def_answer
, not_def_answer
;
1171 char *y_string
, *n_string
, *question
;
1172 /* Used to add duration we waited for user to respond to
1173 prompt_for_continue_wait_time. */
1174 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1176 /* Set up according to which answer is the default. */
1177 if (defchar
== '\0')
1181 not_def_answer
= 'N';
1185 else if (defchar
== 'y')
1189 not_def_answer
= 'N';
1197 not_def_answer
= 'Y';
1202 /* Automatically answer the default value if the user did not want
1203 prompts or the command was issued with the server prefix. */
1204 if (!confirm
|| server_command
)
1207 /* If input isn't coming from the user directly, just say what
1208 question we're asking, and then answer the default automatically. This
1209 way, important error messages don't get lost when talking to GDB
1211 if (! input_from_terminal_p ())
1214 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
1216 printf_filtered (_("(%s or %s) [answered %c; "
1217 "input not from terminal]\n"),
1218 y_string
, n_string
, def_answer
);
1219 gdb_flush (gdb_stdout
);
1224 if (deprecated_query_hook
)
1226 return deprecated_query_hook (ctlstr
, args
);
1229 /* Format the question outside of the loop, to avoid reusing args. */
1230 question
= xstrvprintf (ctlstr
, args
);
1232 /* Used for calculating time spend waiting for user. */
1233 gettimeofday (&prompt_started
, NULL
);
1237 wrap_here (""); /* Flush any buffered output. */
1238 gdb_flush (gdb_stdout
);
1240 if (annotation_level
> 1)
1241 printf_filtered (("\n\032\032pre-query\n"));
1243 fputs_filtered (question
, gdb_stdout
);
1244 printf_filtered (_("(%s or %s) "), y_string
, n_string
);
1246 if (annotation_level
> 1)
1247 printf_filtered (("\n\032\032query\n"));
1250 gdb_flush (gdb_stdout
);
1252 answer
= fgetc (stdin
);
1254 /* We expect fgetc to block until a character is read. But
1255 this may not be the case if the terminal was opened with
1256 the NONBLOCK flag. In that case, if there is nothing to
1257 read on stdin, fgetc returns EOF, but also sets the error
1258 condition flag on stdin and errno to EAGAIN. With a true
1259 EOF, stdin's error condition flag is not set.
1261 A situation where this behavior was observed is a pseudo
1263 while (answer
== EOF
&& ferror (stdin
) && errno
== EAGAIN
)
1265 /* Not a real EOF. Wait a little while and try again until
1266 we read something. */
1269 answer
= fgetc (stdin
);
1272 clearerr (stdin
); /* in case of C-d */
1273 if (answer
== EOF
) /* C-d */
1275 printf_filtered ("EOF [assumed %c]\n", def_answer
);
1279 /* Eat rest of input line, to EOF or newline. */
1283 ans2
= fgetc (stdin
);
1286 while (ans2
!= EOF
&& ans2
!= '\n' && ans2
!= '\r');
1290 /* Check answer. For the non-default, the user must specify
1291 the non-default explicitly. */
1292 if (answer
== not_def_answer
)
1294 retval
= !def_value
;
1297 /* Otherwise, if a default was specified, the user may either
1298 specify the required input or have it default by entering
1300 if (answer
== def_answer
1301 || (defchar
!= '\0' &&
1302 (answer
== '\n' || answer
== '\r' || answer
== EOF
)))
1307 /* Invalid entries are not defaulted and require another selection. */
1308 printf_filtered (_("Please answer %s or %s.\n"),
1309 y_string
, n_string
);
1312 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1313 gettimeofday (&prompt_ended
, NULL
);
1314 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1315 timeval_add (&prompt_for_continue_wait_time
,
1316 &prompt_for_continue_wait_time
, &prompt_delta
);
1319 if (annotation_level
> 1)
1320 printf_filtered (("\n\032\032post-query\n"));
1325 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1326 answer is yes, or 0 if answer is defaulted.
1327 Takes three args which are given to printf to print the question.
1328 The first, a control string, should end in "? ".
1329 It should not say how to answer, because we do that. */
1332 nquery (const char *ctlstr
, ...)
1337 va_start (args
, ctlstr
);
1338 ret
= defaulted_query (ctlstr
, 'n', args
);
1343 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1344 answer is yes, or 1 if answer is defaulted.
1345 Takes three args which are given to printf to print the question.
1346 The first, a control string, should end in "? ".
1347 It should not say how to answer, because we do that. */
1350 yquery (const char *ctlstr
, ...)
1355 va_start (args
, ctlstr
);
1356 ret
= defaulted_query (ctlstr
, 'y', args
);
1361 /* Ask user a y-or-n question and return 1 iff answer is yes.
1362 Takes three args which are given to printf to print the question.
1363 The first, a control string, should end in "? ".
1364 It should not say how to answer, because we do that. */
1367 query (const char *ctlstr
, ...)
1372 va_start (args
, ctlstr
);
1373 ret
= defaulted_query (ctlstr
, '\0', args
);
1378 /* A helper for parse_escape that converts a host character to a
1379 target character. C is the host character. If conversion is
1380 possible, then the target character is stored in *TARGET_C and the
1381 function returns 1. Otherwise, the function returns 0. */
1384 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1386 struct obstack host_data
;
1388 struct cleanup
*cleanups
;
1391 obstack_init (&host_data
);
1392 cleanups
= make_cleanup_obstack_free (&host_data
);
1394 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1395 (gdb_byte
*) &the_char
, 1, 1,
1396 &host_data
, translit_none
);
1398 if (obstack_object_size (&host_data
) == 1)
1401 *target_c
= *(char *) obstack_base (&host_data
);
1404 do_cleanups (cleanups
);
1408 /* Parse a C escape sequence. STRING_PTR points to a variable
1409 containing a pointer to the string to parse. That pointer
1410 should point to the character after the \. That pointer
1411 is updated past the characters we use. The value of the
1412 escape sequence is returned.
1414 A negative value means the sequence \ newline was seen,
1415 which is supposed to be equivalent to nothing at all.
1417 If \ is followed by a null character, we return a negative
1418 value and leave the string pointer pointing at the null character.
1420 If \ is followed by 000, we return 0 and leave the string pointer
1421 after the zeros. A value of 0 does not mean end of string. */
1424 parse_escape (struct gdbarch
*gdbarch
, char **string_ptr
)
1426 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1427 int c
= *(*string_ptr
)++;
1446 int i
= host_hex_value (c
);
1451 if (isdigit (c
) && c
!= '8' && c
!= '9')
1455 i
+= host_hex_value (c
);
1491 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1492 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1493 " which has no equivalent\nin the `%s' character set."),
1494 c
, c
, target_charset (gdbarch
));
1498 /* Print the character C on STREAM as part of the contents of a literal
1499 string whose delimiter is QUOTER. Note that this routine should only
1500 be call for printing things which are independent of the language
1501 of the program being debugged. */
1504 printchar (int c
, void (*do_fputs
) (const char *, struct ui_file
*),
1505 void (*do_fprintf
) (struct ui_file
*, const char *, ...)
1506 ATTRIBUTE_FPTR_PRINTF_2
, struct ui_file
*stream
, int quoter
)
1508 c
&= 0xFF; /* Avoid sign bit follies */
1510 if (c
< 0x20 || /* Low control chars */
1511 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1512 (sevenbit_strings
&& c
>= 0x80))
1513 { /* high order bit set */
1517 do_fputs ("\\n", stream
);
1520 do_fputs ("\\b", stream
);
1523 do_fputs ("\\t", stream
);
1526 do_fputs ("\\f", stream
);
1529 do_fputs ("\\r", stream
);
1532 do_fputs ("\\e", stream
);
1535 do_fputs ("\\a", stream
);
1538 do_fprintf (stream
, "\\%.3o", (unsigned int) c
);
1544 if (c
== '\\' || c
== quoter
)
1545 do_fputs ("\\", stream
);
1546 do_fprintf (stream
, "%c", c
);
1550 /* Print the character C on STREAM as part of the contents of a
1551 literal string whose delimiter is QUOTER. Note that these routines
1552 should only be call for printing things which are independent of
1553 the language of the program being debugged. */
1556 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1559 printchar (*str
++, fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1563 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1566 printchar (*str
++, fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1570 fputstrn_filtered (const char *str
, int n
, int quoter
,
1571 struct ui_file
*stream
)
1575 for (i
= 0; i
< n
; i
++)
1576 printchar (str
[i
], fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1580 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1581 struct ui_file
*stream
)
1585 for (i
= 0; i
< n
; i
++)
1586 printchar (str
[i
], fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1590 /* Number of lines per page or UINT_MAX if paging is disabled. */
1591 static unsigned int lines_per_page
;
1593 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1594 struct cmd_list_element
*c
, const char *value
)
1596 fprintf_filtered (file
,
1597 _("Number of lines gdb thinks are in a page is %s.\n"),
1601 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1602 static unsigned int chars_per_line
;
1604 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1605 struct cmd_list_element
*c
, const char *value
)
1607 fprintf_filtered (file
,
1608 _("Number of characters gdb thinks "
1609 "are in a line is %s.\n"),
1613 /* Current count of lines printed on this page, chars on this line. */
1614 static unsigned int lines_printed
, chars_printed
;
1616 /* Buffer and start column of buffered text, for doing smarter word-
1617 wrapping. When someone calls wrap_here(), we start buffering output
1618 that comes through fputs_filtered(). If we see a newline, we just
1619 spit it out and forget about the wrap_here(). If we see another
1620 wrap_here(), we spit it out and remember the newer one. If we see
1621 the end of the line, we spit out a newline, the indent, and then
1622 the buffered output. */
1624 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1625 are waiting to be output (they have already been counted in chars_printed).
1626 When wrap_buffer[0] is null, the buffer is empty. */
1627 static char *wrap_buffer
;
1629 /* Pointer in wrap_buffer to the next character to fill. */
1630 static char *wrap_pointer
;
1632 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1634 static char *wrap_indent
;
1636 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1637 is not in effect. */
1638 static int wrap_column
;
1641 /* Inialize the number of lines per page and chars per line. */
1644 init_page_info (void)
1648 lines_per_page
= UINT_MAX
;
1649 chars_per_line
= UINT_MAX
;
1653 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1658 #if defined(__GO32__)
1659 rows
= ScreenRows ();
1660 cols
= ScreenCols ();
1661 lines_per_page
= rows
;
1662 chars_per_line
= cols
;
1664 /* Make sure Readline has initialized its terminal settings. */
1665 rl_reset_terminal (NULL
);
1667 /* Get the screen size from Readline. */
1668 rl_get_screen_size (&rows
, &cols
);
1669 lines_per_page
= rows
;
1670 chars_per_line
= cols
;
1672 /* Readline should have fetched the termcap entry for us. */
1673 if (tgetnum ("li") < 0 || getenv ("EMACS"))
1675 /* The number of lines per page is not mentioned in the
1676 terminal description. This probably means that paging is
1677 not useful (e.g. emacs shell window), so disable paging. */
1678 lines_per_page
= UINT_MAX
;
1681 /* If the output is not a terminal, don't paginate it. */
1682 if (!ui_file_isatty (gdb_stdout
))
1683 lines_per_page
= UINT_MAX
;
1691 /* Helper for make_cleanup_restore_page_info. */
1694 do_restore_page_info_cleanup (void *arg
)
1700 /* Provide cleanup for restoring the terminal size. */
1703 make_cleanup_restore_page_info (void)
1705 struct cleanup
*back_to
;
1707 back_to
= make_cleanup (do_restore_page_info_cleanup
, NULL
);
1708 make_cleanup_restore_uinteger (&lines_per_page
);
1709 make_cleanup_restore_uinteger (&chars_per_line
);
1714 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1715 Provide cleanup for restoring the original state. */
1718 set_batch_flag_and_make_cleanup_restore_page_info (void)
1720 struct cleanup
*back_to
= make_cleanup_restore_page_info ();
1722 make_cleanup_restore_integer (&batch_flag
);
1729 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1732 set_screen_size (void)
1734 int rows
= lines_per_page
;
1735 int cols
= chars_per_line
;
1743 /* Update Readline's idea of the terminal size. */
1744 rl_set_screen_size (rows
, cols
);
1747 /* Reinitialize WRAP_BUFFER according to the current value of
1753 if (chars_per_line
== 0)
1758 wrap_buffer
= (char *) xmalloc (chars_per_line
+ 2);
1759 wrap_buffer
[0] = '\0';
1762 wrap_buffer
= (char *) xrealloc (wrap_buffer
, chars_per_line
+ 2);
1763 wrap_pointer
= wrap_buffer
; /* Start it at the beginning. */
1767 set_width_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1774 set_height_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1779 /* Wait, so the user can read what's on the screen. Prompt the user
1780 to continue by pressing RETURN. */
1783 prompt_for_continue (void)
1786 char cont_prompt
[120];
1787 /* Used to add duration we waited for user to respond to
1788 prompt_for_continue_wait_time. */
1789 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1791 gettimeofday (&prompt_started
, NULL
);
1793 if (annotation_level
> 1)
1794 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1796 strcpy (cont_prompt
,
1797 "---Type <return> to continue, or q <return> to quit---");
1798 if (annotation_level
> 1)
1799 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1801 /* We must do this *before* we call gdb_readline, else it will eventually
1802 call us -- thinking that we're trying to print beyond the end of the
1804 reinitialize_more_filter ();
1808 /* On a real operating system, the user can quit with SIGINT.
1811 'q' is provided on all systems so users don't have to change habits
1812 from system to system, and because telling them what to do in
1813 the prompt is more user-friendly than expecting them to think of
1815 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1816 whereas control-C to gdb_readline will cause the user to get dumped
1818 ignore
= gdb_readline_wrapper (cont_prompt
);
1820 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1821 gettimeofday (&prompt_ended
, NULL
);
1822 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1823 timeval_add (&prompt_for_continue_wait_time
,
1824 &prompt_for_continue_wait_time
, &prompt_delta
);
1826 if (annotation_level
> 1)
1827 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1833 while (*p
== ' ' || *p
== '\t')
1841 /* Now we have to do this again, so that GDB will know that it doesn't
1842 need to save the ---Type <return>--- line at the top of the screen. */
1843 reinitialize_more_filter ();
1845 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1848 /* Initalize timer to keep track of how long we waited for the user. */
1851 reset_prompt_for_continue_wait_time (void)
1853 static const struct timeval zero_timeval
= { 0 };
1855 prompt_for_continue_wait_time
= zero_timeval
;
1858 /* Fetch the cumulative time spent in prompt_for_continue. */
1861 get_prompt_for_continue_wait_time (void)
1863 return prompt_for_continue_wait_time
;
1866 /* Reinitialize filter; ie. tell it to reset to original values. */
1869 reinitialize_more_filter (void)
1875 /* Indicate that if the next sequence of characters overflows the line,
1876 a newline should be inserted here rather than when it hits the end.
1877 If INDENT is non-null, it is a string to be printed to indent the
1878 wrapped part on the next line. INDENT must remain accessible until
1879 the next call to wrap_here() or until a newline is printed through
1882 If the line is already overfull, we immediately print a newline and
1883 the indentation, and disable further wrapping.
1885 If we don't know the width of lines, but we know the page height,
1886 we must not wrap words, but should still keep track of newlines
1887 that were explicitly printed.
1889 INDENT should not contain tabs, as that will mess up the char count
1890 on the next line. FIXME.
1892 This routine is guaranteed to force out any output which has been
1893 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1894 used to force out output from the wrap_buffer. */
1897 wrap_here (char *indent
)
1899 /* This should have been allocated, but be paranoid anyway. */
1901 internal_error (__FILE__
, __LINE__
,
1902 _("failed internal consistency check"));
1906 *wrap_pointer
= '\0';
1907 fputs_unfiltered (wrap_buffer
, gdb_stdout
);
1909 wrap_pointer
= wrap_buffer
;
1910 wrap_buffer
[0] = '\0';
1911 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1915 else if (chars_printed
>= chars_per_line
)
1917 puts_filtered ("\n");
1919 puts_filtered (indent
);
1924 wrap_column
= chars_printed
;
1928 wrap_indent
= indent
;
1932 /* Print input string to gdb_stdout, filtered, with wrap,
1933 arranging strings in columns of n chars. String can be
1934 right or left justified in the column. Never prints
1935 trailing spaces. String should never be longer than
1936 width. FIXME: this could be useful for the EXAMINE
1937 command, which currently doesn't tabulate very well. */
1940 puts_filtered_tabular (char *string
, int width
, int right
)
1946 gdb_assert (chars_per_line
> 0);
1947 if (chars_per_line
== UINT_MAX
)
1949 fputs_filtered (string
, gdb_stdout
);
1950 fputs_filtered ("\n", gdb_stdout
);
1954 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1955 fputs_filtered ("\n", gdb_stdout
);
1957 if (width
>= chars_per_line
)
1958 width
= chars_per_line
- 1;
1960 stringlen
= strlen (string
);
1962 if (chars_printed
> 0)
1963 spaces
= width
- (chars_printed
- 1) % width
- 1;
1965 spaces
+= width
- stringlen
;
1967 spacebuf
= alloca (spaces
+ 1);
1968 spacebuf
[spaces
] = '\0';
1970 spacebuf
[spaces
] = ' ';
1972 fputs_filtered (spacebuf
, gdb_stdout
);
1973 fputs_filtered (string
, gdb_stdout
);
1977 /* Ensure that whatever gets printed next, using the filtered output
1978 commands, starts at the beginning of the line. I.e. if there is
1979 any pending output for the current line, flush it and start a new
1980 line. Otherwise do nothing. */
1985 if (chars_printed
> 0)
1987 puts_filtered ("\n");
1992 /* Like fputs but if FILTER is true, pause after every screenful.
1994 Regardless of FILTER can wrap at points other than the final
1995 character of a line.
1997 Unlike fputs, fputs_maybe_filtered does not return a value.
1998 It is OK for LINEBUFFER to be NULL, in which case just don't print
2001 Note that a longjmp to top level may occur in this routine (only if
2002 FILTER is true) (since prompt_for_continue may do so) so this
2003 routine should not be called when cleanups are not in place. */
2006 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
2009 const char *lineptr
;
2011 if (linebuffer
== 0)
2014 /* Don't do any filtering if it is disabled. */
2015 if (stream
!= gdb_stdout
2016 || !pagination_enabled
2018 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
2019 || top_level_interpreter () == NULL
2020 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2022 fputs_unfiltered (linebuffer
, stream
);
2026 /* Go through and output each character. Show line extension
2027 when this is necessary; prompt user for new page when this is
2030 lineptr
= linebuffer
;
2033 /* Possible new page. */
2034 if (filter
&& (lines_printed
>= lines_per_page
- 1))
2035 prompt_for_continue ();
2037 while (*lineptr
&& *lineptr
!= '\n')
2039 /* Print a single line. */
2040 if (*lineptr
== '\t')
2043 *wrap_pointer
++ = '\t';
2045 fputc_unfiltered ('\t', stream
);
2046 /* Shifting right by 3 produces the number of tab stops
2047 we have already passed, and then adding one and
2048 shifting left 3 advances to the next tab stop. */
2049 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
2055 *wrap_pointer
++ = *lineptr
;
2057 fputc_unfiltered (*lineptr
, stream
);
2062 if (chars_printed
>= chars_per_line
)
2064 unsigned int save_chars
= chars_printed
;
2068 /* If we aren't actually wrapping, don't output newline --
2069 if chars_per_line is right, we probably just overflowed
2070 anyway; if it's wrong, let us keep going. */
2072 fputc_unfiltered ('\n', stream
);
2074 /* Possible new page. */
2075 if (lines_printed
>= lines_per_page
- 1)
2076 prompt_for_continue ();
2078 /* Now output indentation and wrapped string. */
2081 fputs_unfiltered (wrap_indent
, stream
);
2082 *wrap_pointer
= '\0'; /* Null-terminate saved stuff, */
2083 fputs_unfiltered (wrap_buffer
, stream
); /* and eject it. */
2084 /* FIXME, this strlen is what prevents wrap_indent from
2085 containing tabs. However, if we recurse to print it
2086 and count its chars, we risk trouble if wrap_indent is
2087 longer than (the user settable) chars_per_line.
2088 Note also that this can set chars_printed > chars_per_line
2089 if we are printing a long string. */
2090 chars_printed
= strlen (wrap_indent
)
2091 + (save_chars
- wrap_column
);
2092 wrap_pointer
= wrap_buffer
; /* Reset buffer */
2093 wrap_buffer
[0] = '\0';
2094 wrap_column
= 0; /* And disable fancy wrap */
2099 if (*lineptr
== '\n')
2102 wrap_here ((char *) 0); /* Spit out chars, cancel
2105 fputc_unfiltered ('\n', stream
);
2112 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
2114 fputs_maybe_filtered (linebuffer
, stream
, 1);
2118 putchar_unfiltered (int c
)
2122 ui_file_write (gdb_stdout
, &buf
, 1);
2126 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2127 May return nonlocally. */
2130 putchar_filtered (int c
)
2132 return fputc_filtered (c
, gdb_stdout
);
2136 fputc_unfiltered (int c
, struct ui_file
*stream
)
2140 ui_file_write (stream
, &buf
, 1);
2145 fputc_filtered (int c
, struct ui_file
*stream
)
2151 fputs_filtered (buf
, stream
);
2155 /* puts_debug is like fputs_unfiltered, except it prints special
2156 characters in printable fashion. */
2159 puts_debug (char *prefix
, char *string
, char *suffix
)
2163 /* Print prefix and suffix after each line. */
2164 static int new_line
= 1;
2165 static int return_p
= 0;
2166 static char *prev_prefix
= "";
2167 static char *prev_suffix
= "";
2169 if (*string
== '\n')
2172 /* If the prefix is changing, print the previous suffix, a new line,
2173 and the new prefix. */
2174 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
2176 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
2177 fputs_unfiltered ("\n", gdb_stdlog
);
2178 fputs_unfiltered (prefix
, gdb_stdlog
);
2181 /* Print prefix if we printed a newline during the previous call. */
2185 fputs_unfiltered (prefix
, gdb_stdlog
);
2188 prev_prefix
= prefix
;
2189 prev_suffix
= suffix
;
2191 /* Output characters in a printable format. */
2192 while ((ch
= *string
++) != '\0')
2198 fputc_unfiltered (ch
, gdb_stdlog
);
2201 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2205 fputs_unfiltered ("\\\\", gdb_stdlog
);
2208 fputs_unfiltered ("\\b", gdb_stdlog
);
2211 fputs_unfiltered ("\\f", gdb_stdlog
);
2215 fputs_unfiltered ("\\n", gdb_stdlog
);
2218 fputs_unfiltered ("\\r", gdb_stdlog
);
2221 fputs_unfiltered ("\\t", gdb_stdlog
);
2224 fputs_unfiltered ("\\v", gdb_stdlog
);
2228 return_p
= ch
== '\r';
2231 /* Print suffix if we printed a newline. */
2234 fputs_unfiltered (suffix
, gdb_stdlog
);
2235 fputs_unfiltered ("\n", gdb_stdlog
);
2240 /* Print a variable number of ARGS using format FORMAT. If this
2241 information is going to put the amount written (since the last call
2242 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2243 call prompt_for_continue to get the users permision to continue.
2245 Unlike fprintf, this function does not return a value.
2247 We implement three variants, vfprintf (takes a vararg list and stream),
2248 fprintf (takes a stream to write on), and printf (the usual).
2250 Note also that a longjmp to top level may occur in this routine
2251 (since prompt_for_continue may do so) so this routine should not be
2252 called when cleanups are not in place. */
2255 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2256 va_list args
, int filter
)
2259 struct cleanup
*old_cleanups
;
2261 linebuffer
= xstrvprintf (format
, args
);
2262 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2263 fputs_maybe_filtered (linebuffer
, stream
, filter
);
2264 do_cleanups (old_cleanups
);
2269 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2271 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2275 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2278 struct cleanup
*old_cleanups
;
2280 linebuffer
= xstrvprintf (format
, args
);
2281 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2282 if (debug_timestamp
&& stream
== gdb_stdlog
)
2288 gettimeofday (&tm
, NULL
);
2290 len
= strlen (linebuffer
);
2291 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2293 timestamp
= xstrprintf ("%ld:%ld %s%s",
2294 (long) tm
.tv_sec
, (long) tm
.tv_usec
,
2296 need_nl
? "\n": "");
2297 make_cleanup (xfree
, timestamp
);
2298 fputs_unfiltered (timestamp
, stream
);
2301 fputs_unfiltered (linebuffer
, stream
);
2302 do_cleanups (old_cleanups
);
2306 vprintf_filtered (const char *format
, va_list args
)
2308 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2312 vprintf_unfiltered (const char *format
, va_list args
)
2314 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2318 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2322 va_start (args
, format
);
2323 vfprintf_filtered (stream
, format
, args
);
2328 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2332 va_start (args
, format
);
2333 vfprintf_unfiltered (stream
, format
, args
);
2337 /* Like fprintf_filtered, but prints its result indented.
2338 Called as fprintfi_filtered (spaces, stream, format, ...); */
2341 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2346 va_start (args
, format
);
2347 print_spaces_filtered (spaces
, stream
);
2349 vfprintf_filtered (stream
, format
, args
);
2355 printf_filtered (const char *format
, ...)
2359 va_start (args
, format
);
2360 vfprintf_filtered (gdb_stdout
, format
, args
);
2366 printf_unfiltered (const char *format
, ...)
2370 va_start (args
, format
);
2371 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2375 /* Like printf_filtered, but prints it's result indented.
2376 Called as printfi_filtered (spaces, format, ...); */
2379 printfi_filtered (int spaces
, const char *format
, ...)
2383 va_start (args
, format
);
2384 print_spaces_filtered (spaces
, gdb_stdout
);
2385 vfprintf_filtered (gdb_stdout
, format
, args
);
2389 /* Easy -- but watch out!
2391 This routine is *not* a replacement for puts()! puts() appends a newline.
2392 This one doesn't, and had better not! */
2395 puts_filtered (const char *string
)
2397 fputs_filtered (string
, gdb_stdout
);
2401 puts_unfiltered (const char *string
)
2403 fputs_unfiltered (string
, gdb_stdout
);
2406 /* Return a pointer to N spaces and a null. The pointer is good
2407 until the next call to here. */
2412 static char *spaces
= 0;
2413 static int max_spaces
= -1;
2419 spaces
= (char *) xmalloc (n
+ 1);
2420 for (t
= spaces
+ n
; t
!= spaces
;)
2426 return spaces
+ max_spaces
- n
;
2429 /* Print N spaces. */
2431 print_spaces_filtered (int n
, struct ui_file
*stream
)
2433 fputs_filtered (n_spaces (n
), stream
);
2436 /* C++/ObjC demangler stuff. */
2438 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2439 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2440 If the name is not mangled, or the language for the name is unknown, or
2441 demangling is off, the name is printed in its "raw" form. */
2444 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2445 enum language lang
, int arg_mode
)
2451 /* If user wants to see raw output, no problem. */
2454 fputs_filtered (name
, stream
);
2458 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2459 fputs_filtered (demangled
? demangled
: name
, stream
);
2460 if (demangled
!= NULL
)
2468 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2469 differences in whitespace. Returns 0 if they match, non-zero if they
2470 don't (slightly different than strcmp()'s range of return values).
2472 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2473 This "feature" is useful when searching for matching C++ function names
2474 (such as if the user types 'break FOO', where FOO is a mangled C++
2478 strcmp_iw (const char *string1
, const char *string2
)
2480 while ((*string1
!= '\0') && (*string2
!= '\0'))
2482 while (isspace (*string1
))
2486 while (isspace (*string2
))
2490 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2492 if (case_sensitivity
== case_sensitive_off
2493 && (tolower ((unsigned char) *string1
)
2494 != tolower ((unsigned char) *string2
)))
2496 if (*string1
!= '\0')
2502 return (*string1
!= '\0' && *string1
!= '(') || (*string2
!= '\0');
2505 /* This is like strcmp except that it ignores whitespace and treats
2506 '(' as the first non-NULL character in terms of ordering. Like
2507 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2508 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2509 according to that ordering.
2511 If a list is sorted according to this function and if you want to
2512 find names in the list that match some fixed NAME according to
2513 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2514 where this function would put NAME.
2516 This function must be neutral to the CASE_SENSITIVITY setting as the user
2517 may choose it during later lookup. Therefore this function always sorts
2518 primarily case-insensitively and secondarily case-sensitively.
2520 Here are some examples of why using strcmp to sort is a bad idea:
2524 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2525 we try to do a search for "foo<char*>", strcmp will locate this
2526 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2527 will start looking at strings beginning with "goo", and will never
2528 see the correct match of "foo<char *>".
2530 Parenthesis example:
2532 In practice, this is less like to be an issue, but I'll give it a
2533 shot. Let's assume that '$' is a legitimate character to occur in
2534 symbols. (Which may well even be the case on some systems.) Then
2535 say that the partial symbol table contains "foo$" and "foo(int)".
2536 strcmp will put them in this order, since '$' < '('. Now, if the
2537 user searches for "foo", then strcmp will sort "foo" before "foo$".
2538 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2539 "foo") is false, so it won't proceed to the actual match of
2540 "foo(int)" with "foo". */
2543 strcmp_iw_ordered (const char *string1
, const char *string2
)
2545 const char *saved_string1
= string1
, *saved_string2
= string2
;
2546 enum case_sensitivity case_pass
= case_sensitive_off
;
2550 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2551 Provide stub characters if we are already at the end of one of the
2553 char c1
= 'X', c2
= 'X';
2555 while (*string1
!= '\0' && *string2
!= '\0')
2557 while (isspace (*string1
))
2559 while (isspace (*string2
))
2564 case case_sensitive_off
:
2565 c1
= tolower ((unsigned char) *string1
);
2566 c2
= tolower ((unsigned char) *string2
);
2568 case case_sensitive_on
:
2576 if (*string1
!= '\0')
2585 /* Characters are non-equal unless they're both '\0'; we want to
2586 make sure we get the comparison right according to our
2587 comparison in the cases where one of them is '\0' or '('. */
2589 if (*string2
== '\0')
2594 if (*string2
== '\0')
2599 if (*string2
== '\0' || *string2
== '(')
2608 if (case_pass
== case_sensitive_on
)
2611 /* Otherwise the strings were equal in case insensitive way, make
2612 a more fine grained comparison in a case sensitive way. */
2614 case_pass
= case_sensitive_on
;
2615 string1
= saved_string1
;
2616 string2
= saved_string2
;
2620 /* A simple comparison function with opposite semantics to strcmp. */
2623 streq (const char *lhs
, const char *rhs
)
2625 return !strcmp (lhs
, rhs
);
2631 ** Answer whether string_to_compare is a full or partial match to
2632 ** template_string. The partial match must be in sequence starting
2636 subset_compare (char *string_to_compare
, char *template_string
)
2640 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
2641 && strlen (string_to_compare
) <= strlen (template_string
))
2644 (template_string
, string_to_compare
, strlen (string_to_compare
)) == 0);
2651 pagination_on_command (char *arg
, int from_tty
)
2653 pagination_enabled
= 1;
2657 pagination_off_command (char *arg
, int from_tty
)
2659 pagination_enabled
= 0;
2663 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2664 struct cmd_list_element
*c
, const char *value
)
2666 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2672 initialize_utils (void)
2674 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
2675 Set number of characters where GDB should wrap lines of its output."), _("\
2676 Show number of characters where GDB should wrap lines of its output."), _("\
2677 This affects where GDB wraps its output to fit the screen width.\n\
2678 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2680 show_chars_per_line
,
2681 &setlist
, &showlist
);
2683 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
2684 Set number of lines in a page for GDB output pagination."), _("\
2685 Show number of lines in a page for GDB output pagination."), _("\
2686 This affects the number of lines after which GDB will pause\n\
2687 its output and ask you whether to continue.\n\
2688 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2690 show_lines_per_page
,
2691 &setlist
, &showlist
);
2695 add_setshow_boolean_cmd ("pagination", class_support
,
2696 &pagination_enabled
, _("\
2697 Set state of GDB output pagination."), _("\
2698 Show state of GDB output pagination."), _("\
2699 When pagination is ON, GDB pauses at end of each screenful of\n\
2700 its output and asks you whether to continue.\n\
2701 Turning pagination off is an alternative to \"set height unlimited\"."),
2703 show_pagination_enabled
,
2704 &setlist
, &showlist
);
2708 add_com ("am", class_support
, pagination_on_command
,
2709 _("Enable pagination"));
2710 add_com ("sm", class_support
, pagination_off_command
,
2711 _("Disable pagination"));
2714 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
2715 &sevenbit_strings
, _("\
2716 Set printing of 8-bit characters in strings as \\nnn."), _("\
2717 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
2719 show_sevenbit_strings
,
2720 &setprintlist
, &showprintlist
);
2722 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
2723 &debug_timestamp
, _("\
2724 Set timestamping of debugging messages."), _("\
2725 Show timestamping of debugging messages."), _("\
2726 When set, debugging messages will be marked with seconds and microseconds."),
2728 show_debug_timestamp
,
2729 &setdebuglist
, &showdebuglist
);
2732 /* Print routines to handle variable size regs, etc. */
2733 /* Temporary storage using circular buffer. */
2739 static char buf
[NUMCELLS
][CELLSIZE
];
2740 static int cell
= 0;
2742 if (++cell
>= NUMCELLS
)
2748 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2750 /* Truncate address to the size of a target address, avoiding shifts
2751 larger or equal than the width of a CORE_ADDR. The local
2752 variable ADDR_BIT stops the compiler reporting a shift overflow
2753 when it won't occur. */
2754 /* NOTE: This assumes that the significant address information is
2755 kept in the least significant bits of ADDR - the upper bits were
2756 either zero or sign extended. Should gdbarch_address_to_pointer or
2757 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2759 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2761 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2762 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2763 return hex_string (addr
);
2766 /* This function is described in "defs.h". */
2769 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2771 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2773 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2774 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2776 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2777 that returns the language localized string formatted to a width
2778 based on gdbarch_addr_bit. */
2780 return hex_string_custom (address
, 8);
2782 return hex_string_custom (address
, 16);
2785 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2788 core_addr_hash (const void *ap
)
2790 const CORE_ADDR
*addrp
= ap
;
2795 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2798 core_addr_eq (const void *ap
, const void *bp
)
2800 const CORE_ADDR
*addr_ap
= ap
;
2801 const CORE_ADDR
*addr_bp
= bp
;
2803 return *addr_ap
== *addr_bp
;
2807 decimal2str (char *sign
, ULONGEST addr
, int width
)
2809 /* Steal code from valprint.c:print_decimal(). Should this worry
2810 about the real size of addr as the above does? */
2811 unsigned long temp
[3];
2812 char *str
= get_cell ();
2817 temp
[i
] = addr
% (1000 * 1000 * 1000);
2818 addr
/= (1000 * 1000 * 1000);
2822 while (addr
!= 0 && i
< (sizeof (temp
) / sizeof (temp
[0])));
2831 xsnprintf (str
, CELLSIZE
, "%s%0*lu", sign
, width
, temp
[0]);
2834 xsnprintf (str
, CELLSIZE
, "%s%0*lu%09lu", sign
, width
,
2838 xsnprintf (str
, CELLSIZE
, "%s%0*lu%09lu%09lu", sign
, width
,
2839 temp
[2], temp
[1], temp
[0]);
2842 internal_error (__FILE__
, __LINE__
,
2843 _("failed internal consistency check"));
2850 octal2str (ULONGEST addr
, int width
)
2852 unsigned long temp
[3];
2853 char *str
= get_cell ();
2858 temp
[i
] = addr
% (0100000 * 0100000);
2859 addr
/= (0100000 * 0100000);
2863 while (addr
!= 0 && i
< (sizeof (temp
) / sizeof (temp
[0])));
2873 xsnprintf (str
, CELLSIZE
, "%*o", width
, 0);
2875 xsnprintf (str
, CELLSIZE
, "0%0*lo", width
, temp
[0]);
2878 xsnprintf (str
, CELLSIZE
, "0%0*lo%010lo", width
, temp
[1], temp
[0]);
2881 xsnprintf (str
, CELLSIZE
, "0%0*lo%010lo%010lo", width
,
2882 temp
[2], temp
[1], temp
[0]);
2885 internal_error (__FILE__
, __LINE__
,
2886 _("failed internal consistency check"));
2893 pulongest (ULONGEST u
)
2895 return decimal2str ("", u
, 0);
2899 plongest (LONGEST l
)
2902 return decimal2str ("-", -l
, 0);
2904 return decimal2str ("", l
, 0);
2907 /* Eliminate warning from compiler on 32-bit systems. */
2908 static int thirty_two
= 32;
2911 phex (ULONGEST l
, int sizeof_l
)
2919 xsnprintf (str
, CELLSIZE
, "%08lx%08lx",
2920 (unsigned long) (l
>> thirty_two
),
2921 (unsigned long) (l
& 0xffffffff));
2925 xsnprintf (str
, CELLSIZE
, "%08lx", (unsigned long) l
);
2929 xsnprintf (str
, CELLSIZE
, "%04x", (unsigned short) (l
& 0xffff));
2932 str
= phex (l
, sizeof (l
));
2940 phex_nz (ULONGEST l
, int sizeof_l
)
2948 unsigned long high
= (unsigned long) (l
>> thirty_two
);
2952 xsnprintf (str
, CELLSIZE
, "%lx",
2953 (unsigned long) (l
& 0xffffffff));
2955 xsnprintf (str
, CELLSIZE
, "%lx%08lx", high
,
2956 (unsigned long) (l
& 0xffffffff));
2961 xsnprintf (str
, CELLSIZE
, "%lx", (unsigned long) l
);
2965 xsnprintf (str
, CELLSIZE
, "%x", (unsigned short) (l
& 0xffff));
2968 str
= phex_nz (l
, sizeof (l
));
2975 /* Converts a LONGEST to a C-format hexadecimal literal and stores it
2976 in a static string. Returns a pointer to this string. */
2978 hex_string (LONGEST num
)
2980 char *result
= get_cell ();
2982 xsnprintf (result
, CELLSIZE
, "0x%s", phex_nz (num
, sizeof (num
)));
2986 /* Converts a LONGEST number to a C-format hexadecimal literal and
2987 stores it in a static string. Returns a pointer to this string
2988 that is valid until the next call. The number is padded on the
2989 left with 0s to at least WIDTH characters. */
2991 hex_string_custom (LONGEST num
, int width
)
2993 char *result
= get_cell ();
2994 char *result_end
= result
+ CELLSIZE
- 1;
2995 const char *hex
= phex_nz (num
, sizeof (num
));
2996 int hex_len
= strlen (hex
);
2998 if (hex_len
> width
)
3000 if (width
+ 2 >= CELLSIZE
)
3001 internal_error (__FILE__
, __LINE__
, _("\
3002 hex_string_custom: insufficient space to store result"));
3004 strcpy (result_end
- width
- 2, "0x");
3005 memset (result_end
- width
, '0', width
);
3006 strcpy (result_end
- hex_len
, hex
);
3007 return result_end
- width
- 2;
3010 /* Convert VAL to a numeral in the given radix. For
3011 * radix 10, IS_SIGNED may be true, indicating a signed quantity;
3012 * otherwise VAL is interpreted as unsigned. If WIDTH is supplied,
3013 * it is the minimum width (0-padded if needed). USE_C_FORMAT means
3014 * to use C format in all cases. If it is false, then 'x'
3015 * and 'o' formats do not include a prefix (0x or leading 0). */
3018 int_string (LONGEST val
, int radix
, int is_signed
, int width
,
3028 result
= hex_string (val
);
3030 result
= hex_string_custom (val
, width
);
3037 if (is_signed
&& val
< 0)
3038 return decimal2str ("-", -val
, width
);
3040 return decimal2str ("", val
, width
);
3044 char *result
= octal2str (val
, width
);
3046 if (use_c_format
|| val
== 0)
3052 internal_error (__FILE__
, __LINE__
,
3053 _("failed internal consistency check"));
3057 /* Convert a CORE_ADDR into a string. */
3059 core_addr_to_string (const CORE_ADDR addr
)
3061 char *str
= get_cell ();
3064 strcat (str
, phex (addr
, sizeof (addr
)));
3069 core_addr_to_string_nz (const CORE_ADDR addr
)
3071 char *str
= get_cell ();
3074 strcat (str
, phex_nz (addr
, sizeof (addr
)));
3078 /* Convert a string back into a CORE_ADDR. */
3080 string_to_core_addr (const char *my_string
)
3084 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
3086 /* Assume that it is in hex. */
3089 for (i
= 2; my_string
[i
] != '\0'; i
++)
3091 if (isdigit (my_string
[i
]))
3092 addr
= (my_string
[i
] - '0') + (addr
* 16);
3093 else if (isxdigit (my_string
[i
]))
3094 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
3096 error (_("invalid hex \"%s\""), my_string
);
3101 /* Assume that it is in decimal. */
3104 for (i
= 0; my_string
[i
] != '\0'; i
++)
3106 if (isdigit (my_string
[i
]))
3107 addr
= (my_string
[i
] - '0') + (addr
* 10);
3109 error (_("invalid decimal \"%s\""), my_string
);
3117 host_address_to_string (const void *addr
)
3119 char *str
= get_cell ();
3121 xsnprintf (str
, CELLSIZE
, "0x%s", phex_nz ((uintptr_t) addr
, sizeof (addr
)));
3126 gdb_realpath (const char *filename
)
3128 /* Method 1: The system has a compile time upper bound on a filename
3129 path. Use that and realpath() to canonicalize the name. This is
3130 the most common case. Note that, if there isn't a compile time
3131 upper bound, you want to avoid realpath() at all costs. */
3132 #if defined(HAVE_REALPATH)
3134 # if defined (PATH_MAX)
3136 # define USE_REALPATH
3137 # elif defined (MAXPATHLEN)
3138 char buf
[MAXPATHLEN
];
3139 # define USE_REALPATH
3141 # if defined (USE_REALPATH)
3142 const char *rp
= realpath (filename
, buf
);
3146 return xstrdup (rp
);
3149 #endif /* HAVE_REALPATH */
3151 /* Method 2: The host system (i.e., GNU) has the function
3152 canonicalize_file_name() which malloc's a chunk of memory and
3153 returns that, use that. */
3154 #if defined(HAVE_CANONICALIZE_FILE_NAME)
3156 char *rp
= canonicalize_file_name (filename
);
3159 return xstrdup (filename
);
3165 /* FIXME: cagney/2002-11-13:
3167 Method 2a: Use realpath() with a NULL buffer. Some systems, due
3168 to the problems described in method 3, have modified their
3169 realpath() implementation so that it will allocate a buffer when
3170 NULL is passed in. Before this can be used, though, some sort of
3171 configure time test would need to be added. Otherwize the code
3172 will likely core dump. */
3174 /* Method 3: Now we're getting desperate! The system doesn't have a
3175 compile time buffer size and no alternative function. Query the
3176 OS, using pathconf(), for the buffer limit. Care is needed
3177 though, some systems do not limit PATH_MAX (return -1 for
3178 pathconf()) making it impossible to pass a correctly sized buffer
3179 to realpath() (it could always overflow). On those systems, we
3181 #if defined (HAVE_REALPATH) && defined (HAVE_UNISTD_H) && defined(HAVE_ALLOCA)
3183 /* Find out the max path size. */
3184 long path_max
= pathconf ("/", _PC_PATH_MAX
);
3188 /* PATH_MAX is bounded. */
3189 char *buf
= alloca (path_max
);
3190 char *rp
= realpath (filename
, buf
);
3192 return xstrdup (rp
? rp
: filename
);
3197 /* The MS Windows method. If we don't have realpath, we assume we
3198 don't have symlinks and just canonicalize to a Windows absolute
3199 path. GetFullPath converts ../ and ./ in relative paths to
3200 absolute paths, filling in current drive if one is not given
3201 or using the current directory of a specified drive (eg, "E:foo").
3202 It also converts all forward slashes to back slashes. */
3203 /* The file system is case-insensitive but case-preserving.
3204 So we do not lowercase the path. Otherwise, we might not
3205 be able to display the original casing in a given path. */
3206 #if defined (_WIN32)
3209 DWORD len
= GetFullPathName (filename
, MAX_PATH
, buf
, NULL
);
3211 if (len
> 0 && len
< MAX_PATH
)
3212 return xstrdup (buf
);
3216 /* This system is a lost cause, just dup the buffer. */
3217 return xstrdup (filename
);
3221 align_up (ULONGEST v
, int n
)
3223 /* Check that N is really a power of two. */
3224 gdb_assert (n
&& (n
& (n
-1)) == 0);
3225 return (v
+ n
- 1) & -n
;
3229 align_down (ULONGEST v
, int n
)
3231 /* Check that N is really a power of two. */
3232 gdb_assert (n
&& (n
& (n
-1)) == 0);
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
);