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.
970 Then return to command level. */
973 perror_with_name (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 error (_("%s."), combined
);
993 /* Print the system error message for ERRCODE, and also mention STRING
994 as the file name for which the error was encountered. */
997 print_sys_errmsg (const char *string
, int errcode
)
1002 err
= safe_strerror (errcode
);
1003 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
1004 strcpy (combined
, string
);
1005 strcat (combined
, ": ");
1006 strcat (combined
, err
);
1008 /* We want anything which was printed on stdout to come out first, before
1010 gdb_flush (gdb_stdout
);
1011 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
1014 /* Control C eventually causes this to be called, at a convenient time. */
1020 /* No steenking SIGINT will ever be coming our way when the
1021 program is resumed. Don't lie. */
1025 /* If there is no terminal switching for this target, then we can't
1026 possibly get screwed by the lack of job control. */
1027 || current_target
.to_terminal_ours
== NULL
)
1030 fatal ("Quit (expect signal SIGINT when the program is resumed)");
1035 /* Called when a memory allocation fails, with the number of bytes of
1036 memory requested in SIZE. */
1039 malloc_failure (long size
)
1043 internal_error (__FILE__
, __LINE__
,
1044 _("virtual memory exhausted: can't allocate %ld bytes."),
1049 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
1053 /* My replacement for the read system call.
1054 Used like `read' but keeps going if `read' returns too soon. */
1057 myread (int desc
, char *addr
, int len
)
1064 val
= read (desc
, addr
, len
);
1068 return orglen
- len
;
1076 print_spaces (int n
, struct ui_file
*file
)
1078 fputs_unfiltered (n_spaces (n
), file
);
1081 /* Print a host address. */
1084 gdb_print_host_address (const void *addr
, struct ui_file
*stream
)
1086 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
1090 /* A cleanup function that calls regfree. */
1093 do_regfree_cleanup (void *r
)
1098 /* Create a new cleanup that frees the compiled regular expression R. */
1101 make_regfree_cleanup (regex_t
*r
)
1103 return make_cleanup (do_regfree_cleanup
, r
);
1106 /* Return an xmalloc'd error message resulting from a regular
1107 expression compilation failure. */
1110 get_regcomp_error (int code
, regex_t
*rx
)
1112 size_t length
= regerror (code
, rx
, NULL
, 0);
1113 char *result
= xmalloc (length
);
1115 regerror (code
, rx
, result
, length
);
1121 /* This function supports the query, nquery, and yquery functions.
1122 Ask user a y-or-n question and return 0 if answer is no, 1 if
1123 answer is yes, or default the answer to the specified default
1124 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1125 default answer, or '\0' for no default.
1126 CTLSTR is the control string and should end in "? ". It should
1127 not say how to answer, because we do that.
1128 ARGS are the arguments passed along with the CTLSTR argument to
1131 static int ATTRIBUTE_PRINTF (1, 0)
1132 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
1138 char def_answer
, not_def_answer
;
1139 char *y_string
, *n_string
, *question
;
1140 /* Used to add duration we waited for user to respond to
1141 prompt_for_continue_wait_time. */
1142 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1144 /* Set up according to which answer is the default. */
1145 if (defchar
== '\0')
1149 not_def_answer
= 'N';
1153 else if (defchar
== 'y')
1157 not_def_answer
= 'N';
1165 not_def_answer
= 'Y';
1170 /* Automatically answer the default value if the user did not want
1171 prompts or the command was issued with the server prefix. */
1172 if (!confirm
|| server_command
)
1175 /* If input isn't coming from the user directly, just say what
1176 question we're asking, and then answer the default automatically. This
1177 way, important error messages don't get lost when talking to GDB
1179 if (! input_from_terminal_p ())
1182 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
1184 printf_filtered (_("(%s or %s) [answered %c; "
1185 "input not from terminal]\n"),
1186 y_string
, n_string
, def_answer
);
1187 gdb_flush (gdb_stdout
);
1192 if (deprecated_query_hook
)
1194 return deprecated_query_hook (ctlstr
, args
);
1197 /* Format the question outside of the loop, to avoid reusing args. */
1198 question
= xstrvprintf (ctlstr
, args
);
1200 /* Used for calculating time spend waiting for user. */
1201 gettimeofday (&prompt_started
, NULL
);
1205 wrap_here (""); /* Flush any buffered output. */
1206 gdb_flush (gdb_stdout
);
1208 if (annotation_level
> 1)
1209 printf_filtered (("\n\032\032pre-query\n"));
1211 fputs_filtered (question
, gdb_stdout
);
1212 printf_filtered (_("(%s or %s) "), y_string
, n_string
);
1214 if (annotation_level
> 1)
1215 printf_filtered (("\n\032\032query\n"));
1218 gdb_flush (gdb_stdout
);
1220 answer
= fgetc (stdin
);
1222 /* We expect fgetc to block until a character is read. But
1223 this may not be the case if the terminal was opened with
1224 the NONBLOCK flag. In that case, if there is nothing to
1225 read on stdin, fgetc returns EOF, but also sets the error
1226 condition flag on stdin and errno to EAGAIN. With a true
1227 EOF, stdin's error condition flag is not set.
1229 A situation where this behavior was observed is a pseudo
1231 while (answer
== EOF
&& ferror (stdin
) && errno
== EAGAIN
)
1233 /* Not a real EOF. Wait a little while and try again until
1234 we read something. */
1237 answer
= fgetc (stdin
);
1240 clearerr (stdin
); /* in case of C-d */
1241 if (answer
== EOF
) /* C-d */
1243 printf_filtered ("EOF [assumed %c]\n", def_answer
);
1247 /* Eat rest of input line, to EOF or newline. */
1251 ans2
= fgetc (stdin
);
1254 while (ans2
!= EOF
&& ans2
!= '\n' && ans2
!= '\r');
1258 /* Check answer. For the non-default, the user must specify
1259 the non-default explicitly. */
1260 if (answer
== not_def_answer
)
1262 retval
= !def_value
;
1265 /* Otherwise, if a default was specified, the user may either
1266 specify the required input or have it default by entering
1268 if (answer
== def_answer
1269 || (defchar
!= '\0' &&
1270 (answer
== '\n' || answer
== '\r' || answer
== EOF
)))
1275 /* Invalid entries are not defaulted and require another selection. */
1276 printf_filtered (_("Please answer %s or %s.\n"),
1277 y_string
, n_string
);
1280 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1281 gettimeofday (&prompt_ended
, NULL
);
1282 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1283 timeval_add (&prompt_for_continue_wait_time
,
1284 &prompt_for_continue_wait_time
, &prompt_delta
);
1287 if (annotation_level
> 1)
1288 printf_filtered (("\n\032\032post-query\n"));
1293 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1294 answer is yes, or 0 if answer is defaulted.
1295 Takes three args which are given to printf to print the question.
1296 The first, a control string, should end in "? ".
1297 It should not say how to answer, because we do that. */
1300 nquery (const char *ctlstr
, ...)
1305 va_start (args
, ctlstr
);
1306 ret
= defaulted_query (ctlstr
, 'n', args
);
1311 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1312 answer is yes, or 1 if answer is defaulted.
1313 Takes three args which are given to printf to print the question.
1314 The first, a control string, should end in "? ".
1315 It should not say how to answer, because we do that. */
1318 yquery (const char *ctlstr
, ...)
1323 va_start (args
, ctlstr
);
1324 ret
= defaulted_query (ctlstr
, 'y', args
);
1329 /* Ask user a y-or-n question and return 1 iff answer is yes.
1330 Takes three args which are given to printf to print the question.
1331 The first, a control string, should end in "? ".
1332 It should not say how to answer, because we do that. */
1335 query (const char *ctlstr
, ...)
1340 va_start (args
, ctlstr
);
1341 ret
= defaulted_query (ctlstr
, '\0', args
);
1346 /* A helper for parse_escape that converts a host character to a
1347 target character. C is the host character. If conversion is
1348 possible, then the target character is stored in *TARGET_C and the
1349 function returns 1. Otherwise, the function returns 0. */
1352 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1354 struct obstack host_data
;
1356 struct cleanup
*cleanups
;
1359 obstack_init (&host_data
);
1360 cleanups
= make_cleanup_obstack_free (&host_data
);
1362 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1363 (gdb_byte
*) &the_char
, 1, 1,
1364 &host_data
, translit_none
);
1366 if (obstack_object_size (&host_data
) == 1)
1369 *target_c
= *(char *) obstack_base (&host_data
);
1372 do_cleanups (cleanups
);
1376 /* Parse a C escape sequence. STRING_PTR points to a variable
1377 containing a pointer to the string to parse. That pointer
1378 should point to the character after the \. That pointer
1379 is updated past the characters we use. The value of the
1380 escape sequence is returned.
1382 A negative value means the sequence \ newline was seen,
1383 which is supposed to be equivalent to nothing at all.
1385 If \ is followed by a null character, we return a negative
1386 value and leave the string pointer pointing at the null character.
1388 If \ is followed by 000, we return 0 and leave the string pointer
1389 after the zeros. A value of 0 does not mean end of string. */
1392 parse_escape (struct gdbarch
*gdbarch
, char **string_ptr
)
1394 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1395 int c
= *(*string_ptr
)++;
1414 int i
= host_hex_value (c
);
1419 if (isdigit (c
) && c
!= '8' && c
!= '9')
1423 i
+= host_hex_value (c
);
1459 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1460 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1461 " which has no equivalent\nin the `%s' character set."),
1462 c
, c
, target_charset (gdbarch
));
1466 /* Print the character C on STREAM as part of the contents of a literal
1467 string whose delimiter is QUOTER. Note that this routine should only
1468 be call for printing things which are independent of the language
1469 of the program being debugged. */
1472 printchar (int c
, void (*do_fputs
) (const char *, struct ui_file
*),
1473 void (*do_fprintf
) (struct ui_file
*, const char *, ...)
1474 ATTRIBUTE_FPTR_PRINTF_2
, struct ui_file
*stream
, int quoter
)
1476 c
&= 0xFF; /* Avoid sign bit follies */
1478 if (c
< 0x20 || /* Low control chars */
1479 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1480 (sevenbit_strings
&& c
>= 0x80))
1481 { /* high order bit set */
1485 do_fputs ("\\n", stream
);
1488 do_fputs ("\\b", stream
);
1491 do_fputs ("\\t", stream
);
1494 do_fputs ("\\f", stream
);
1497 do_fputs ("\\r", stream
);
1500 do_fputs ("\\e", stream
);
1503 do_fputs ("\\a", stream
);
1506 do_fprintf (stream
, "\\%.3o", (unsigned int) c
);
1512 if (c
== '\\' || c
== quoter
)
1513 do_fputs ("\\", stream
);
1514 do_fprintf (stream
, "%c", c
);
1518 /* Print the character C on STREAM as part of the contents of a
1519 literal string whose delimiter is QUOTER. Note that these routines
1520 should only be call for printing things which are independent of
1521 the language of the program being debugged. */
1524 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1527 printchar (*str
++, fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1531 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1534 printchar (*str
++, fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1538 fputstrn_filtered (const char *str
, int n
, int quoter
,
1539 struct ui_file
*stream
)
1543 for (i
= 0; i
< n
; i
++)
1544 printchar (str
[i
], fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1548 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1549 struct ui_file
*stream
)
1553 for (i
= 0; i
< n
; i
++)
1554 printchar (str
[i
], fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1558 /* Number of lines per page or UINT_MAX if paging is disabled. */
1559 static unsigned int lines_per_page
;
1561 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1562 struct cmd_list_element
*c
, const char *value
)
1564 fprintf_filtered (file
,
1565 _("Number of lines gdb thinks are in a page is %s.\n"),
1569 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1570 static unsigned int chars_per_line
;
1572 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1573 struct cmd_list_element
*c
, const char *value
)
1575 fprintf_filtered (file
,
1576 _("Number of characters gdb thinks "
1577 "are in a line is %s.\n"),
1581 /* Current count of lines printed on this page, chars on this line. */
1582 static unsigned int lines_printed
, chars_printed
;
1584 /* Buffer and start column of buffered text, for doing smarter word-
1585 wrapping. When someone calls wrap_here(), we start buffering output
1586 that comes through fputs_filtered(). If we see a newline, we just
1587 spit it out and forget about the wrap_here(). If we see another
1588 wrap_here(), we spit it out and remember the newer one. If we see
1589 the end of the line, we spit out a newline, the indent, and then
1590 the buffered output. */
1592 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1593 are waiting to be output (they have already been counted in chars_printed).
1594 When wrap_buffer[0] is null, the buffer is empty. */
1595 static char *wrap_buffer
;
1597 /* Pointer in wrap_buffer to the next character to fill. */
1598 static char *wrap_pointer
;
1600 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1602 static char *wrap_indent
;
1604 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1605 is not in effect. */
1606 static int wrap_column
;
1609 /* Inialize the number of lines per page and chars per line. */
1612 init_page_info (void)
1616 lines_per_page
= UINT_MAX
;
1617 chars_per_line
= UINT_MAX
;
1621 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1626 #if defined(__GO32__)
1627 rows
= ScreenRows ();
1628 cols
= ScreenCols ();
1629 lines_per_page
= rows
;
1630 chars_per_line
= cols
;
1632 /* Make sure Readline has initialized its terminal settings. */
1633 rl_reset_terminal (NULL
);
1635 /* Get the screen size from Readline. */
1636 rl_get_screen_size (&rows
, &cols
);
1637 lines_per_page
= rows
;
1638 chars_per_line
= cols
;
1640 /* Readline should have fetched the termcap entry for us. */
1641 if (tgetnum ("li") < 0 || getenv ("EMACS"))
1643 /* The number of lines per page is not mentioned in the
1644 terminal description. This probably means that paging is
1645 not useful (e.g. emacs shell window), so disable paging. */
1646 lines_per_page
= UINT_MAX
;
1649 /* If the output is not a terminal, don't paginate it. */
1650 if (!ui_file_isatty (gdb_stdout
))
1651 lines_per_page
= UINT_MAX
;
1659 /* Helper for make_cleanup_restore_page_info. */
1662 do_restore_page_info_cleanup (void *arg
)
1668 /* Provide cleanup for restoring the terminal size. */
1671 make_cleanup_restore_page_info (void)
1673 struct cleanup
*back_to
;
1675 back_to
= make_cleanup (do_restore_page_info_cleanup
, NULL
);
1676 make_cleanup_restore_uinteger (&lines_per_page
);
1677 make_cleanup_restore_uinteger (&chars_per_line
);
1682 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1683 Provide cleanup for restoring the original state. */
1686 set_batch_flag_and_make_cleanup_restore_page_info (void)
1688 struct cleanup
*back_to
= make_cleanup_restore_page_info ();
1690 make_cleanup_restore_integer (&batch_flag
);
1697 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1700 set_screen_size (void)
1702 int rows
= lines_per_page
;
1703 int cols
= chars_per_line
;
1711 /* Update Readline's idea of the terminal size. */
1712 rl_set_screen_size (rows
, cols
);
1715 /* Reinitialize WRAP_BUFFER according to the current value of
1721 if (chars_per_line
== 0)
1726 wrap_buffer
= (char *) xmalloc (chars_per_line
+ 2);
1727 wrap_buffer
[0] = '\0';
1730 wrap_buffer
= (char *) xrealloc (wrap_buffer
, chars_per_line
+ 2);
1731 wrap_pointer
= wrap_buffer
; /* Start it at the beginning. */
1735 set_width_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1742 set_height_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1747 /* Wait, so the user can read what's on the screen. Prompt the user
1748 to continue by pressing RETURN. */
1751 prompt_for_continue (void)
1754 char cont_prompt
[120];
1755 /* Used to add duration we waited for user to respond to
1756 prompt_for_continue_wait_time. */
1757 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1759 gettimeofday (&prompt_started
, NULL
);
1761 if (annotation_level
> 1)
1762 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1764 strcpy (cont_prompt
,
1765 "---Type <return> to continue, or q <return> to quit---");
1766 if (annotation_level
> 1)
1767 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1769 /* We must do this *before* we call gdb_readline, else it will eventually
1770 call us -- thinking that we're trying to print beyond the end of the
1772 reinitialize_more_filter ();
1776 /* On a real operating system, the user can quit with SIGINT.
1779 'q' is provided on all systems so users don't have to change habits
1780 from system to system, and because telling them what to do in
1781 the prompt is more user-friendly than expecting them to think of
1783 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1784 whereas control-C to gdb_readline will cause the user to get dumped
1786 ignore
= gdb_readline_wrapper (cont_prompt
);
1788 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1789 gettimeofday (&prompt_ended
, NULL
);
1790 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1791 timeval_add (&prompt_for_continue_wait_time
,
1792 &prompt_for_continue_wait_time
, &prompt_delta
);
1794 if (annotation_level
> 1)
1795 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1801 while (*p
== ' ' || *p
== '\t')
1809 /* Now we have to do this again, so that GDB will know that it doesn't
1810 need to save the ---Type <return>--- line at the top of the screen. */
1811 reinitialize_more_filter ();
1813 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1816 /* Initalize timer to keep track of how long we waited for the user. */
1819 reset_prompt_for_continue_wait_time (void)
1821 static const struct timeval zero_timeval
= { 0 };
1823 prompt_for_continue_wait_time
= zero_timeval
;
1826 /* Fetch the cumulative time spent in prompt_for_continue. */
1829 get_prompt_for_continue_wait_time (void)
1831 return prompt_for_continue_wait_time
;
1834 /* Reinitialize filter; ie. tell it to reset to original values. */
1837 reinitialize_more_filter (void)
1843 /* Indicate that if the next sequence of characters overflows the line,
1844 a newline should be inserted here rather than when it hits the end.
1845 If INDENT is non-null, it is a string to be printed to indent the
1846 wrapped part on the next line. INDENT must remain accessible until
1847 the next call to wrap_here() or until a newline is printed through
1850 If the line is already overfull, we immediately print a newline and
1851 the indentation, and disable further wrapping.
1853 If we don't know the width of lines, but we know the page height,
1854 we must not wrap words, but should still keep track of newlines
1855 that were explicitly printed.
1857 INDENT should not contain tabs, as that will mess up the char count
1858 on the next line. FIXME.
1860 This routine is guaranteed to force out any output which has been
1861 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1862 used to force out output from the wrap_buffer. */
1865 wrap_here (char *indent
)
1867 /* This should have been allocated, but be paranoid anyway. */
1869 internal_error (__FILE__
, __LINE__
,
1870 _("failed internal consistency check"));
1874 *wrap_pointer
= '\0';
1875 fputs_unfiltered (wrap_buffer
, gdb_stdout
);
1877 wrap_pointer
= wrap_buffer
;
1878 wrap_buffer
[0] = '\0';
1879 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1883 else if (chars_printed
>= chars_per_line
)
1885 puts_filtered ("\n");
1887 puts_filtered (indent
);
1892 wrap_column
= chars_printed
;
1896 wrap_indent
= indent
;
1900 /* Print input string to gdb_stdout, filtered, with wrap,
1901 arranging strings in columns of n chars. String can be
1902 right or left justified in the column. Never prints
1903 trailing spaces. String should never be longer than
1904 width. FIXME: this could be useful for the EXAMINE
1905 command, which currently doesn't tabulate very well. */
1908 puts_filtered_tabular (char *string
, int width
, int right
)
1914 gdb_assert (chars_per_line
> 0);
1915 if (chars_per_line
== UINT_MAX
)
1917 fputs_filtered (string
, gdb_stdout
);
1918 fputs_filtered ("\n", gdb_stdout
);
1922 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1923 fputs_filtered ("\n", gdb_stdout
);
1925 if (width
>= chars_per_line
)
1926 width
= chars_per_line
- 1;
1928 stringlen
= strlen (string
);
1930 if (chars_printed
> 0)
1931 spaces
= width
- (chars_printed
- 1) % width
- 1;
1933 spaces
+= width
- stringlen
;
1935 spacebuf
= alloca (spaces
+ 1);
1936 spacebuf
[spaces
] = '\0';
1938 spacebuf
[spaces
] = ' ';
1940 fputs_filtered (spacebuf
, gdb_stdout
);
1941 fputs_filtered (string
, gdb_stdout
);
1945 /* Ensure that whatever gets printed next, using the filtered output
1946 commands, starts at the beginning of the line. I.e. if there is
1947 any pending output for the current line, flush it and start a new
1948 line. Otherwise do nothing. */
1953 if (chars_printed
> 0)
1955 puts_filtered ("\n");
1960 /* Like fputs but if FILTER is true, pause after every screenful.
1962 Regardless of FILTER can wrap at points other than the final
1963 character of a line.
1965 Unlike fputs, fputs_maybe_filtered does not return a value.
1966 It is OK for LINEBUFFER to be NULL, in which case just don't print
1969 Note that a longjmp to top level may occur in this routine (only if
1970 FILTER is true) (since prompt_for_continue may do so) so this
1971 routine should not be called when cleanups are not in place. */
1974 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
1977 const char *lineptr
;
1979 if (linebuffer
== 0)
1982 /* Don't do any filtering if it is disabled. */
1983 if (stream
!= gdb_stdout
1984 || !pagination_enabled
1986 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
1987 || top_level_interpreter () == NULL
1988 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
1990 fputs_unfiltered (linebuffer
, stream
);
1994 /* Go through and output each character. Show line extension
1995 when this is necessary; prompt user for new page when this is
1998 lineptr
= linebuffer
;
2001 /* Possible new page. */
2002 if (filter
&& (lines_printed
>= lines_per_page
- 1))
2003 prompt_for_continue ();
2005 while (*lineptr
&& *lineptr
!= '\n')
2007 /* Print a single line. */
2008 if (*lineptr
== '\t')
2011 *wrap_pointer
++ = '\t';
2013 fputc_unfiltered ('\t', stream
);
2014 /* Shifting right by 3 produces the number of tab stops
2015 we have already passed, and then adding one and
2016 shifting left 3 advances to the next tab stop. */
2017 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
2023 *wrap_pointer
++ = *lineptr
;
2025 fputc_unfiltered (*lineptr
, stream
);
2030 if (chars_printed
>= chars_per_line
)
2032 unsigned int save_chars
= chars_printed
;
2036 /* If we aren't actually wrapping, don't output newline --
2037 if chars_per_line is right, we probably just overflowed
2038 anyway; if it's wrong, let us keep going. */
2040 fputc_unfiltered ('\n', stream
);
2042 /* Possible new page. */
2043 if (lines_printed
>= lines_per_page
- 1)
2044 prompt_for_continue ();
2046 /* Now output indentation and wrapped string. */
2049 fputs_unfiltered (wrap_indent
, stream
);
2050 *wrap_pointer
= '\0'; /* Null-terminate saved stuff, */
2051 fputs_unfiltered (wrap_buffer
, stream
); /* and eject it. */
2052 /* FIXME, this strlen is what prevents wrap_indent from
2053 containing tabs. However, if we recurse to print it
2054 and count its chars, we risk trouble if wrap_indent is
2055 longer than (the user settable) chars_per_line.
2056 Note also that this can set chars_printed > chars_per_line
2057 if we are printing a long string. */
2058 chars_printed
= strlen (wrap_indent
)
2059 + (save_chars
- wrap_column
);
2060 wrap_pointer
= wrap_buffer
; /* Reset buffer */
2061 wrap_buffer
[0] = '\0';
2062 wrap_column
= 0; /* And disable fancy wrap */
2067 if (*lineptr
== '\n')
2070 wrap_here ((char *) 0); /* Spit out chars, cancel
2073 fputc_unfiltered ('\n', stream
);
2080 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
2082 fputs_maybe_filtered (linebuffer
, stream
, 1);
2086 putchar_unfiltered (int c
)
2090 ui_file_write (gdb_stdout
, &buf
, 1);
2094 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2095 May return nonlocally. */
2098 putchar_filtered (int c
)
2100 return fputc_filtered (c
, gdb_stdout
);
2104 fputc_unfiltered (int c
, struct ui_file
*stream
)
2108 ui_file_write (stream
, &buf
, 1);
2113 fputc_filtered (int c
, struct ui_file
*stream
)
2119 fputs_filtered (buf
, stream
);
2123 /* puts_debug is like fputs_unfiltered, except it prints special
2124 characters in printable fashion. */
2127 puts_debug (char *prefix
, char *string
, char *suffix
)
2131 /* Print prefix and suffix after each line. */
2132 static int new_line
= 1;
2133 static int return_p
= 0;
2134 static char *prev_prefix
= "";
2135 static char *prev_suffix
= "";
2137 if (*string
== '\n')
2140 /* If the prefix is changing, print the previous suffix, a new line,
2141 and the new prefix. */
2142 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
2144 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
2145 fputs_unfiltered ("\n", gdb_stdlog
);
2146 fputs_unfiltered (prefix
, gdb_stdlog
);
2149 /* Print prefix if we printed a newline during the previous call. */
2153 fputs_unfiltered (prefix
, gdb_stdlog
);
2156 prev_prefix
= prefix
;
2157 prev_suffix
= suffix
;
2159 /* Output characters in a printable format. */
2160 while ((ch
= *string
++) != '\0')
2166 fputc_unfiltered (ch
, gdb_stdlog
);
2169 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2173 fputs_unfiltered ("\\\\", gdb_stdlog
);
2176 fputs_unfiltered ("\\b", gdb_stdlog
);
2179 fputs_unfiltered ("\\f", gdb_stdlog
);
2183 fputs_unfiltered ("\\n", gdb_stdlog
);
2186 fputs_unfiltered ("\\r", gdb_stdlog
);
2189 fputs_unfiltered ("\\t", gdb_stdlog
);
2192 fputs_unfiltered ("\\v", gdb_stdlog
);
2196 return_p
= ch
== '\r';
2199 /* Print suffix if we printed a newline. */
2202 fputs_unfiltered (suffix
, gdb_stdlog
);
2203 fputs_unfiltered ("\n", gdb_stdlog
);
2208 /* Print a variable number of ARGS using format FORMAT. If this
2209 information is going to put the amount written (since the last call
2210 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2211 call prompt_for_continue to get the users permision to continue.
2213 Unlike fprintf, this function does not return a value.
2215 We implement three variants, vfprintf (takes a vararg list and stream),
2216 fprintf (takes a stream to write on), and printf (the usual).
2218 Note also that a longjmp to top level may occur in this routine
2219 (since prompt_for_continue may do so) so this routine should not be
2220 called when cleanups are not in place. */
2223 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2224 va_list args
, int filter
)
2227 struct cleanup
*old_cleanups
;
2229 linebuffer
= xstrvprintf (format
, args
);
2230 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2231 fputs_maybe_filtered (linebuffer
, stream
, filter
);
2232 do_cleanups (old_cleanups
);
2237 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2239 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2243 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2246 struct cleanup
*old_cleanups
;
2248 linebuffer
= xstrvprintf (format
, args
);
2249 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2250 if (debug_timestamp
&& stream
== gdb_stdlog
)
2256 gettimeofday (&tm
, NULL
);
2258 len
= strlen (linebuffer
);
2259 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2261 timestamp
= xstrprintf ("%ld:%ld %s%s",
2262 (long) tm
.tv_sec
, (long) tm
.tv_usec
,
2264 need_nl
? "\n": "");
2265 make_cleanup (xfree
, timestamp
);
2266 fputs_unfiltered (timestamp
, stream
);
2269 fputs_unfiltered (linebuffer
, stream
);
2270 do_cleanups (old_cleanups
);
2274 vprintf_filtered (const char *format
, va_list args
)
2276 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2280 vprintf_unfiltered (const char *format
, va_list args
)
2282 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2286 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2290 va_start (args
, format
);
2291 vfprintf_filtered (stream
, format
, args
);
2296 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2300 va_start (args
, format
);
2301 vfprintf_unfiltered (stream
, format
, args
);
2305 /* Like fprintf_filtered, but prints its result indented.
2306 Called as fprintfi_filtered (spaces, stream, format, ...); */
2309 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2314 va_start (args
, format
);
2315 print_spaces_filtered (spaces
, stream
);
2317 vfprintf_filtered (stream
, format
, args
);
2323 printf_filtered (const char *format
, ...)
2327 va_start (args
, format
);
2328 vfprintf_filtered (gdb_stdout
, format
, args
);
2334 printf_unfiltered (const char *format
, ...)
2338 va_start (args
, format
);
2339 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2343 /* Like printf_filtered, but prints it's result indented.
2344 Called as printfi_filtered (spaces, format, ...); */
2347 printfi_filtered (int spaces
, const char *format
, ...)
2351 va_start (args
, format
);
2352 print_spaces_filtered (spaces
, gdb_stdout
);
2353 vfprintf_filtered (gdb_stdout
, format
, args
);
2357 /* Easy -- but watch out!
2359 This routine is *not* a replacement for puts()! puts() appends a newline.
2360 This one doesn't, and had better not! */
2363 puts_filtered (const char *string
)
2365 fputs_filtered (string
, gdb_stdout
);
2369 puts_unfiltered (const char *string
)
2371 fputs_unfiltered (string
, gdb_stdout
);
2374 /* Return a pointer to N spaces and a null. The pointer is good
2375 until the next call to here. */
2380 static char *spaces
= 0;
2381 static int max_spaces
= -1;
2387 spaces
= (char *) xmalloc (n
+ 1);
2388 for (t
= spaces
+ n
; t
!= spaces
;)
2394 return spaces
+ max_spaces
- n
;
2397 /* Print N spaces. */
2399 print_spaces_filtered (int n
, struct ui_file
*stream
)
2401 fputs_filtered (n_spaces (n
), stream
);
2404 /* C++/ObjC demangler stuff. */
2406 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2407 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2408 If the name is not mangled, or the language for the name is unknown, or
2409 demangling is off, the name is printed in its "raw" form. */
2412 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2413 enum language lang
, int arg_mode
)
2419 /* If user wants to see raw output, no problem. */
2422 fputs_filtered (name
, stream
);
2426 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2427 fputs_filtered (demangled
? demangled
: name
, stream
);
2428 if (demangled
!= NULL
)
2436 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2437 differences in whitespace. Returns 0 if they match, non-zero if they
2438 don't (slightly different than strcmp()'s range of return values).
2440 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2441 This "feature" is useful when searching for matching C++ function names
2442 (such as if the user types 'break FOO', where FOO is a mangled C++
2446 strcmp_iw (const char *string1
, const char *string2
)
2448 while ((*string1
!= '\0') && (*string2
!= '\0'))
2450 while (isspace (*string1
))
2454 while (isspace (*string2
))
2458 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2460 if (case_sensitivity
== case_sensitive_off
2461 && (tolower ((unsigned char) *string1
)
2462 != tolower ((unsigned char) *string2
)))
2464 if (*string1
!= '\0')
2470 return (*string1
!= '\0' && *string1
!= '(') || (*string2
!= '\0');
2473 /* This is like strcmp except that it ignores whitespace and treats
2474 '(' as the first non-NULL character in terms of ordering. Like
2475 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2476 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2477 according to that ordering.
2479 If a list is sorted according to this function and if you want to
2480 find names in the list that match some fixed NAME according to
2481 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2482 where this function would put NAME.
2484 This function must be neutral to the CASE_SENSITIVITY setting as the user
2485 may choose it during later lookup. Therefore this function always sorts
2486 primarily case-insensitively and secondarily case-sensitively.
2488 Here are some examples of why using strcmp to sort is a bad idea:
2492 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2493 we try to do a search for "foo<char*>", strcmp will locate this
2494 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2495 will start looking at strings beginning with "goo", and will never
2496 see the correct match of "foo<char *>".
2498 Parenthesis example:
2500 In practice, this is less like to be an issue, but I'll give it a
2501 shot. Let's assume that '$' is a legitimate character to occur in
2502 symbols. (Which may well even be the case on some systems.) Then
2503 say that the partial symbol table contains "foo$" and "foo(int)".
2504 strcmp will put them in this order, since '$' < '('. Now, if the
2505 user searches for "foo", then strcmp will sort "foo" before "foo$".
2506 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2507 "foo") is false, so it won't proceed to the actual match of
2508 "foo(int)" with "foo". */
2511 strcmp_iw_ordered (const char *string1
, const char *string2
)
2513 const char *saved_string1
= string1
, *saved_string2
= string2
;
2514 enum case_sensitivity case_pass
= case_sensitive_off
;
2518 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2519 Provide stub characters if we are already at the end of one of the
2521 char c1
= 'X', c2
= 'X';
2523 while (*string1
!= '\0' && *string2
!= '\0')
2525 while (isspace (*string1
))
2527 while (isspace (*string2
))
2532 case case_sensitive_off
:
2533 c1
= tolower ((unsigned char) *string1
);
2534 c2
= tolower ((unsigned char) *string2
);
2536 case case_sensitive_on
:
2544 if (*string1
!= '\0')
2553 /* Characters are non-equal unless they're both '\0'; we want to
2554 make sure we get the comparison right according to our
2555 comparison in the cases where one of them is '\0' or '('. */
2557 if (*string2
== '\0')
2562 if (*string2
== '\0')
2567 if (*string2
== '\0' || *string2
== '(')
2576 if (case_pass
== case_sensitive_on
)
2579 /* Otherwise the strings were equal in case insensitive way, make
2580 a more fine grained comparison in a case sensitive way. */
2582 case_pass
= case_sensitive_on
;
2583 string1
= saved_string1
;
2584 string2
= saved_string2
;
2588 /* A simple comparison function with opposite semantics to strcmp. */
2591 streq (const char *lhs
, const char *rhs
)
2593 return !strcmp (lhs
, rhs
);
2599 ** Answer whether string_to_compare is a full or partial match to
2600 ** template_string. The partial match must be in sequence starting
2604 subset_compare (char *string_to_compare
, char *template_string
)
2608 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
2609 && strlen (string_to_compare
) <= strlen (template_string
))
2612 (template_string
, string_to_compare
, strlen (string_to_compare
)) == 0);
2619 pagination_on_command (char *arg
, int from_tty
)
2621 pagination_enabled
= 1;
2625 pagination_off_command (char *arg
, int from_tty
)
2627 pagination_enabled
= 0;
2631 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2632 struct cmd_list_element
*c
, const char *value
)
2634 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2640 initialize_utils (void)
2642 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
2643 Set number of characters where GDB should wrap lines of its output."), _("\
2644 Show number of characters where GDB should wrap lines of its output."), _("\
2645 This affects where GDB wraps its output to fit the screen width.\n\
2646 Setting this to zero prevents GDB from wrapping its output."),
2648 show_chars_per_line
,
2649 &setlist
, &showlist
);
2651 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
2652 Set number of lines in a page for GDB output pagination."), _("\
2653 Show number of lines in a page for GDB output pagination."), _("\
2654 This affects the number of lines after which GDB will pause\n\
2655 its output and ask you whether to continue.\n\
2656 Setting this to zero causes GDB never pause during output."),
2658 show_lines_per_page
,
2659 &setlist
, &showlist
);
2663 add_setshow_boolean_cmd ("pagination", class_support
,
2664 &pagination_enabled
, _("\
2665 Set state of GDB output pagination."), _("\
2666 Show state of GDB output pagination."), _("\
2667 When pagination is ON, GDB pauses at end of each screenful of\n\
2668 its output and asks you whether to continue.\n\
2669 Turning pagination off is an alternative to \"set height 0\"."),
2671 show_pagination_enabled
,
2672 &setlist
, &showlist
);
2676 add_com ("am", class_support
, pagination_on_command
,
2677 _("Enable pagination"));
2678 add_com ("sm", class_support
, pagination_off_command
,
2679 _("Disable pagination"));
2682 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
2683 &sevenbit_strings
, _("\
2684 Set printing of 8-bit characters in strings as \\nnn."), _("\
2685 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
2687 show_sevenbit_strings
,
2688 &setprintlist
, &showprintlist
);
2690 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
2691 &debug_timestamp
, _("\
2692 Set timestamping of debugging messages."), _("\
2693 Show timestamping of debugging messages."), _("\
2694 When set, debugging messages will be marked with seconds and microseconds."),
2696 show_debug_timestamp
,
2697 &setdebuglist
, &showdebuglist
);
2700 /* Print routines to handle variable size regs, etc. */
2701 /* Temporary storage using circular buffer. */
2707 static char buf
[NUMCELLS
][CELLSIZE
];
2708 static int cell
= 0;
2710 if (++cell
>= NUMCELLS
)
2716 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2718 /* Truncate address to the size of a target address, avoiding shifts
2719 larger or equal than the width of a CORE_ADDR. The local
2720 variable ADDR_BIT stops the compiler reporting a shift overflow
2721 when it won't occur. */
2722 /* NOTE: This assumes that the significant address information is
2723 kept in the least significant bits of ADDR - the upper bits were
2724 either zero or sign extended. Should gdbarch_address_to_pointer or
2725 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2727 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2729 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2730 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2731 return hex_string (addr
);
2734 /* This function is described in "defs.h". */
2737 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2739 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2741 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2742 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2744 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2745 that returns the language localized string formatted to a width
2746 based on gdbarch_addr_bit. */
2748 return hex_string_custom (address
, 8);
2750 return hex_string_custom (address
, 16);
2753 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2756 core_addr_hash (const void *ap
)
2758 const CORE_ADDR
*addrp
= ap
;
2763 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2766 core_addr_eq (const void *ap
, const void *bp
)
2768 const CORE_ADDR
*addr_ap
= ap
;
2769 const CORE_ADDR
*addr_bp
= bp
;
2771 return *addr_ap
== *addr_bp
;
2775 decimal2str (char *sign
, ULONGEST addr
, int width
)
2777 /* Steal code from valprint.c:print_decimal(). Should this worry
2778 about the real size of addr as the above does? */
2779 unsigned long temp
[3];
2780 char *str
= get_cell ();
2785 temp
[i
] = addr
% (1000 * 1000 * 1000);
2786 addr
/= (1000 * 1000 * 1000);
2790 while (addr
!= 0 && i
< (sizeof (temp
) / sizeof (temp
[0])));
2799 xsnprintf (str
, CELLSIZE
, "%s%0*lu", sign
, width
, temp
[0]);
2802 xsnprintf (str
, CELLSIZE
, "%s%0*lu%09lu", sign
, width
,
2806 xsnprintf (str
, CELLSIZE
, "%s%0*lu%09lu%09lu", sign
, width
,
2807 temp
[2], temp
[1], temp
[0]);
2810 internal_error (__FILE__
, __LINE__
,
2811 _("failed internal consistency check"));
2818 octal2str (ULONGEST addr
, int width
)
2820 unsigned long temp
[3];
2821 char *str
= get_cell ();
2826 temp
[i
] = addr
% (0100000 * 0100000);
2827 addr
/= (0100000 * 0100000);
2831 while (addr
!= 0 && i
< (sizeof (temp
) / sizeof (temp
[0])));
2841 xsnprintf (str
, CELLSIZE
, "%*o", width
, 0);
2843 xsnprintf (str
, CELLSIZE
, "0%0*lo", width
, temp
[0]);
2846 xsnprintf (str
, CELLSIZE
, "0%0*lo%010lo", width
, temp
[1], temp
[0]);
2849 xsnprintf (str
, CELLSIZE
, "0%0*lo%010lo%010lo", width
,
2850 temp
[2], temp
[1], temp
[0]);
2853 internal_error (__FILE__
, __LINE__
,
2854 _("failed internal consistency check"));
2861 pulongest (ULONGEST u
)
2863 return decimal2str ("", u
, 0);
2867 plongest (LONGEST l
)
2870 return decimal2str ("-", -l
, 0);
2872 return decimal2str ("", l
, 0);
2875 /* Eliminate warning from compiler on 32-bit systems. */
2876 static int thirty_two
= 32;
2879 phex (ULONGEST l
, int sizeof_l
)
2887 xsnprintf (str
, CELLSIZE
, "%08lx%08lx",
2888 (unsigned long) (l
>> thirty_two
),
2889 (unsigned long) (l
& 0xffffffff));
2893 xsnprintf (str
, CELLSIZE
, "%08lx", (unsigned long) l
);
2897 xsnprintf (str
, CELLSIZE
, "%04x", (unsigned short) (l
& 0xffff));
2900 str
= phex (l
, sizeof (l
));
2908 phex_nz (ULONGEST l
, int sizeof_l
)
2916 unsigned long high
= (unsigned long) (l
>> thirty_two
);
2920 xsnprintf (str
, CELLSIZE
, "%lx",
2921 (unsigned long) (l
& 0xffffffff));
2923 xsnprintf (str
, CELLSIZE
, "%lx%08lx", high
,
2924 (unsigned long) (l
& 0xffffffff));
2929 xsnprintf (str
, CELLSIZE
, "%lx", (unsigned long) l
);
2933 xsnprintf (str
, CELLSIZE
, "%x", (unsigned short) (l
& 0xffff));
2936 str
= phex_nz (l
, sizeof (l
));
2943 /* Converts a LONGEST to a C-format hexadecimal literal and stores it
2944 in a static string. Returns a pointer to this string. */
2946 hex_string (LONGEST num
)
2948 char *result
= get_cell ();
2950 xsnprintf (result
, CELLSIZE
, "0x%s", phex_nz (num
, sizeof (num
)));
2954 /* Converts a LONGEST number to a C-format hexadecimal literal and
2955 stores it in a static string. Returns a pointer to this string
2956 that is valid until the next call. The number is padded on the
2957 left with 0s to at least WIDTH characters. */
2959 hex_string_custom (LONGEST num
, int width
)
2961 char *result
= get_cell ();
2962 char *result_end
= result
+ CELLSIZE
- 1;
2963 const char *hex
= phex_nz (num
, sizeof (num
));
2964 int hex_len
= strlen (hex
);
2966 if (hex_len
> width
)
2968 if (width
+ 2 >= CELLSIZE
)
2969 internal_error (__FILE__
, __LINE__
, _("\
2970 hex_string_custom: insufficient space to store result"));
2972 strcpy (result_end
- width
- 2, "0x");
2973 memset (result_end
- width
, '0', width
);
2974 strcpy (result_end
- hex_len
, hex
);
2975 return result_end
- width
- 2;
2978 /* Convert VAL to a numeral in the given radix. For
2979 * radix 10, IS_SIGNED may be true, indicating a signed quantity;
2980 * otherwise VAL is interpreted as unsigned. If WIDTH is supplied,
2981 * it is the minimum width (0-padded if needed). USE_C_FORMAT means
2982 * to use C format in all cases. If it is false, then 'x'
2983 * and 'o' formats do not include a prefix (0x or leading 0). */
2986 int_string (LONGEST val
, int radix
, int is_signed
, int width
,
2996 result
= hex_string (val
);
2998 result
= hex_string_custom (val
, width
);
3005 if (is_signed
&& val
< 0)
3006 return decimal2str ("-", -val
, width
);
3008 return decimal2str ("", val
, width
);
3012 char *result
= octal2str (val
, width
);
3014 if (use_c_format
|| val
== 0)
3020 internal_error (__FILE__
, __LINE__
,
3021 _("failed internal consistency check"));
3025 /* Convert a CORE_ADDR into a string. */
3027 core_addr_to_string (const CORE_ADDR addr
)
3029 char *str
= get_cell ();
3032 strcat (str
, phex (addr
, sizeof (addr
)));
3037 core_addr_to_string_nz (const CORE_ADDR addr
)
3039 char *str
= get_cell ();
3042 strcat (str
, phex_nz (addr
, sizeof (addr
)));
3046 /* Convert a string back into a CORE_ADDR. */
3048 string_to_core_addr (const char *my_string
)
3052 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
3054 /* Assume that it is in hex. */
3057 for (i
= 2; my_string
[i
] != '\0'; i
++)
3059 if (isdigit (my_string
[i
]))
3060 addr
= (my_string
[i
] - '0') + (addr
* 16);
3061 else if (isxdigit (my_string
[i
]))
3062 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
3064 error (_("invalid hex \"%s\""), my_string
);
3069 /* Assume that it is in decimal. */
3072 for (i
= 0; my_string
[i
] != '\0'; i
++)
3074 if (isdigit (my_string
[i
]))
3075 addr
= (my_string
[i
] - '0') + (addr
* 10);
3077 error (_("invalid decimal \"%s\""), my_string
);
3085 host_address_to_string (const void *addr
)
3087 char *str
= get_cell ();
3089 xsnprintf (str
, CELLSIZE
, "0x%s", phex_nz ((uintptr_t) addr
, sizeof (addr
)));
3094 gdb_realpath (const char *filename
)
3096 /* Method 1: The system has a compile time upper bound on a filename
3097 path. Use that and realpath() to canonicalize the name. This is
3098 the most common case. Note that, if there isn't a compile time
3099 upper bound, you want to avoid realpath() at all costs. */
3100 #if defined(HAVE_REALPATH)
3102 # if defined (PATH_MAX)
3104 # define USE_REALPATH
3105 # elif defined (MAXPATHLEN)
3106 char buf
[MAXPATHLEN
];
3107 # define USE_REALPATH
3109 # if defined (USE_REALPATH)
3110 const char *rp
= realpath (filename
, buf
);
3114 return xstrdup (rp
);
3117 #endif /* HAVE_REALPATH */
3119 /* Method 2: The host system (i.e., GNU) has the function
3120 canonicalize_file_name() which malloc's a chunk of memory and
3121 returns that, use that. */
3122 #if defined(HAVE_CANONICALIZE_FILE_NAME)
3124 char *rp
= canonicalize_file_name (filename
);
3127 return xstrdup (filename
);
3133 /* FIXME: cagney/2002-11-13:
3135 Method 2a: Use realpath() with a NULL buffer. Some systems, due
3136 to the problems described in method 3, have modified their
3137 realpath() implementation so that it will allocate a buffer when
3138 NULL is passed in. Before this can be used, though, some sort of
3139 configure time test would need to be added. Otherwize the code
3140 will likely core dump. */
3142 /* Method 3: Now we're getting desperate! The system doesn't have a
3143 compile time buffer size and no alternative function. Query the
3144 OS, using pathconf(), for the buffer limit. Care is needed
3145 though, some systems do not limit PATH_MAX (return -1 for
3146 pathconf()) making it impossible to pass a correctly sized buffer
3147 to realpath() (it could always overflow). On those systems, we
3149 #if defined (HAVE_REALPATH) && defined (HAVE_UNISTD_H) && defined(HAVE_ALLOCA)
3151 /* Find out the max path size. */
3152 long path_max
= pathconf ("/", _PC_PATH_MAX
);
3156 /* PATH_MAX is bounded. */
3157 char *buf
= alloca (path_max
);
3158 char *rp
= realpath (filename
, buf
);
3160 return xstrdup (rp
? rp
: filename
);
3165 /* The MS Windows method. If we don't have realpath, we assume we
3166 don't have symlinks and just canonicalize to a Windows absolute
3167 path. GetFullPath converts ../ and ./ in relative paths to
3168 absolute paths, filling in current drive if one is not given
3169 or using the current directory of a specified drive (eg, "E:foo").
3170 It also converts all forward slashes to back slashes. */
3171 /* The file system is case-insensitive but case-preserving.
3172 So we do not lowercase the path. Otherwise, we might not
3173 be able to display the original casing in a given path. */
3174 #if defined (_WIN32)
3177 DWORD len
= GetFullPathName (filename
, MAX_PATH
, buf
, NULL
);
3179 if (len
> 0 && len
< MAX_PATH
)
3180 return xstrdup (buf
);
3184 /* This system is a lost cause, just dup the buffer. */
3185 return xstrdup (filename
);
3189 align_up (ULONGEST v
, int n
)
3191 /* Check that N is really a power of two. */
3192 gdb_assert (n
&& (n
& (n
-1)) == 0);
3193 return (v
+ n
- 1) & -n
;
3197 align_down (ULONGEST v
, int n
)
3199 /* Check that N is really a power of two. */
3200 gdb_assert (n
&& (n
& (n
-1)) == 0);
3204 /* Allocation function for the libiberty hash table which uses an
3205 obstack. The obstack is passed as DATA. */
3208 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
3210 unsigned int total
= size
* count
;
3211 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
3213 memset (ptr
, 0, total
);
3217 /* Trivial deallocation function for the libiberty splay tree and hash
3218 table - don't deallocate anything. Rely on later deletion of the
3219 obstack. DATA will be the obstack, although it is not needed
3223 dummy_obstack_deallocate (void *object
, void *data
)
3228 /* The bit offset of the highest byte in a ULONGEST, for overflow
3231 #define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT)
3233 /* True (non-zero) iff DIGIT is a valid digit in radix BASE,
3234 where 2 <= BASE <= 36. */
3237 is_digit_in_base (unsigned char digit
, int base
)
3239 if (!isalnum (digit
))
3242 return (isdigit (digit
) && digit
< base
+ '0');
3244 return (isdigit (digit
) || tolower (digit
) < base
- 10 + 'a');
3248 digit_to_int (unsigned char c
)
3253 return tolower (c
) - 'a' + 10;
3256 /* As for strtoul, but for ULONGEST results. */
3259 strtoulst (const char *num
, const char **trailer
, int base
)
3261 unsigned int high_part
;
3266 /* Skip leading whitespace. */
3267 while (isspace (num
[i
]))
3270 /* Handle prefixes. */
3273 else if (num
[i
] == '-')
3279 if (base
== 0 || base
== 16)
3281 if (num
[i
] == '0' && (num
[i
+ 1] == 'x' || num
[i
+ 1] == 'X'))
3289 if (base
== 0 && num
[i
] == '0')
3295 if (base
< 2 || base
> 36)
3301 result
= high_part
= 0;
3302 for (; is_digit_in_base (num
[i
], base
); i
+= 1)
3304 result
= result
* base
+ digit_to_int (num
[i
]);
3305 high_part
= high_part
* base
+ (unsigned int) (result
>> HIGH_BYTE_POSN
);
3306 result
&= ((ULONGEST
) 1 << HIGH_BYTE_POSN
) - 1;
3307 if (high_part
> 0xff)
3310 result
= ~ (ULONGEST
) 0;
3317 if (trailer
!= NULL
)
3320 result
= result
+ ((ULONGEST
) high_part
<< HIGH_BYTE_POSN
);
3327 /* Simple, portable version of dirname that does not modify its
3331 ldirname (const char *filename
)
3333 const char *base
= lbasename (filename
);
3336 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
3339 if (base
== filename
)
3342 dirname
= xmalloc (base
- filename
+ 2);
3343 memcpy (dirname
, filename
, base
- filename
);
3345 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3346 create "d:./bar" later instead of the (different) "d:/bar". */
3347 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3348 && !IS_DIR_SEPARATOR (filename
[0]))
3349 dirname
[base
++ - filename
] = '.';
3351 dirname
[base
- filename
] = '\0';
3355 /* Call libiberty's buildargv, and return the result.
3356 If buildargv fails due to out-of-memory, call nomem.
3357 Therefore, the returned value is guaranteed to be non-NULL,
3358 unless the parameter itself is NULL. */
3361 gdb_buildargv (const char *s
)
3363 char **argv
= buildargv (s
);
3365 if (s
!= NULL
&& argv
== NULL
)
3371 compare_positive_ints (const void *ap
, const void *bp
)
3373 /* Because we know we're comparing two ints which are positive,
3374 there's no danger of overflow here. */
3375 return * (int *) ap
- * (int *) bp
;
3378 /* String compare function for qsort. */
3381 compare_strings (const void *arg1
, const void *arg2
)
3383 const char **s1
= (const char **) arg1
;
3384 const char **s2
= (const char **) arg2
;
3386 return strcmp (*s1
, *s2
);
3389 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3390 #define AMBIGUOUS_MESS2 \
3391 ".\nUse \"set gnutarget format-name\" to specify the format."
3394 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3400 /* Check if errmsg just need simple return. */
3401 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3402 return bfd_errmsg (error_tag
);
3404 ret_len
= strlen (bfd_errmsg (error_tag
)) + strlen (AMBIGUOUS_MESS1
)
3405 + strlen (AMBIGUOUS_MESS2
);
3406 for (p
= matching
; *p
; p
++)
3407 ret_len
+= strlen (*p
) + 1;
3408 ret
= xmalloc (ret_len
+ 1);
3410 make_cleanup (xfree
, ret
);
3412 strcpy (retp
, bfd_errmsg (error_tag
));
3413 retp
+= strlen (retp
);
3415 strcpy (retp
, AMBIGUOUS_MESS1
);
3416 retp
+= strlen (retp
);
3418 for (p
= matching
; *p
; p
++)
3420 sprintf (retp
, " %s", *p
);
3421 retp
+= strlen (retp
);
3425 strcpy (retp
, AMBIGUOUS_MESS2
);
3430 /* Return ARGS parsed as a valid pid, or throw an error. */
3433 parse_pid_to_attach (char *args
)
3439 error_no_arg (_("process-id to attach"));
3442 pid
= strtoul (args
, &dummy
, 0);
3443 /* Some targets don't set errno on errors, grrr! */
3444 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3445 error (_("Illegal process-id: %s."), args
);
3450 /* Helper for make_bpstat_clear_actions_cleanup. */
3453 do_bpstat_clear_actions_cleanup (void *unused
)
3455 bpstat_clear_actions ();
3458 /* Call bpstat_clear_actions for the case an exception is throw. You should
3459 discard_cleanups if no exception is caught. */
3462 make_bpstat_clear_actions_cleanup (void)
3464 return make_cleanup (do_bpstat_clear_actions_cleanup
, NULL
);
3467 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3468 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3469 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3472 producer_is_gcc_ge_4 (const char *producer
)
3477 if (producer
== NULL
)
3479 /* For unknown compilers expect their behavior is not compliant. For GCC
3480 this case can also happen for -gdwarf-4 type units supported since
3486 /* Skip any identifier after "GNU " - such as "C++" or "Java". */
3488 if (strncmp (producer
, "GNU ", strlen ("GNU ")) != 0)
3490 /* For non-GCC compilers expect their behavior is not compliant. */
3494 cs
= &producer
[strlen ("GNU ")];
3495 while (*cs
&& !isdigit (*cs
))
3497 if (sscanf (cs
, "%d.%d", &major
, &minor
) != 2)
3499 /* Not recognized as GCC. */
3511 /* Helper for make_cleanup_free_char_ptr_vec. */
3514 do_free_char_ptr_vec (void *arg
)
3516 VEC (char_ptr
) *char_ptr_vec
= arg
;
3518 free_char_ptr_vec (char_ptr_vec
);
3521 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3522 final VEC_free for CHAR_PTR_VEC itself.
3524 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3525 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3526 this function does not (cannot) clear the pointer. */
3529 make_cleanup_free_char_ptr_vec (VEC (char_ptr
) *char_ptr_vec
)
3531 return make_cleanup (do_free_char_ptr_vec
, char_ptr_vec
);
3534 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3535 must come from xrealloc-compatible allocator and it may be updated. FROM
3536 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3537 located at the start or end of *STRINGP. */
3540 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3542 char *string
= *stringp
, *s
;
3543 const size_t from_len
= strlen (from
);
3544 const size_t to_len
= strlen (to
);
3548 s
= strstr (s
, from
);
3552 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3553 || s
[-1] == DIRNAME_SEPARATOR
)
3554 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3555 || s
[from_len
] == DIRNAME_SEPARATOR
))
3559 string_new
= xrealloc (string
, (strlen (string
) + to_len
+ 1));
3561 /* Relocate the current S pointer. */
3562 s
= s
- string
+ string_new
;
3563 string
= string_new
;
3565 /* Replace from by to. */
3566 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3567 memcpy (s
, to
, to_len
);
3582 /* SIGALRM handler for waitpid_with_timeout. */
3585 sigalrm_handler (int signo
)
3587 /* Nothing to do. */
3592 /* Wrapper to wait for child PID to die with TIMEOUT.
3593 TIMEOUT is the time to stop waiting in seconds.
3594 If TIMEOUT is zero, pass WNOHANG to waitpid.
3595 Returns PID if it was successfully waited for, otherwise -1.
3597 Timeouts are currently implemented with alarm and SIGALRM.
3598 If the host does not support them, this waits "forever".
3599 It would be odd though for a host to have waitpid and not SIGALRM. */
3602 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3604 pid_t waitpid_result
;
3606 gdb_assert (pid
> 0);
3607 gdb_assert (timeout
>= 0);
3612 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3613 struct sigaction sa
, old_sa
;
3615 sa
.sa_handler
= sigalrm_handler
;
3616 sigemptyset (&sa
.sa_mask
);
3618 sigaction (SIGALRM
, &sa
, &old_sa
);
3622 ofunc
= (void (*)()) signal (SIGALRM
, sigalrm_handler
);
3628 waitpid_result
= waitpid (pid
, status
, 0);
3632 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3633 sigaction (SIGALRM
, &old_sa
, NULL
);
3635 signal (SIGALRM
, ofunc
);
3640 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3642 if (waitpid_result
== pid
)
3648 #endif /* HAVE_WAITPID */
3650 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3651 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3653 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3654 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3657 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3659 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3661 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3662 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3664 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3666 char *pattern_slash
, *string_slash
;
3668 /* Replace '\' by '/' in both strings. */
3670 pattern_slash
= alloca (strlen (pattern
) + 1);
3671 strcpy (pattern_slash
, pattern
);
3672 pattern
= pattern_slash
;
3673 for (; *pattern_slash
!= 0; pattern_slash
++)
3674 if (IS_DIR_SEPARATOR (*pattern_slash
))
3675 *pattern_slash
= '/';
3677 string_slash
= alloca (strlen (string
) + 1);
3678 strcpy (string_slash
, string
);
3679 string
= string_slash
;
3680 for (; *string_slash
!= 0; string_slash
++)
3681 if (IS_DIR_SEPARATOR (*string_slash
))
3682 *string_slash
= '/';
3684 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3686 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3687 flags
|= FNM_CASEFOLD
;
3688 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3690 return fnmatch (pattern
, string
, flags
);
3693 /* Provide a prototype to silence -Wmissing-prototypes. */
3694 extern initialize_file_ftype _initialize_utils
;
3697 _initialize_utils (void)
3699 add_internal_problem_command (&internal_error_problem
);
3700 add_internal_problem_command (&internal_warning_problem
);