1 /* General utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2014 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"
24 #include "event-top.h"
25 #include "exceptions.h"
26 #include "gdbthread.h"
29 #ifdef HAVE_SYS_RESOURCE_H
30 #include <sys/resource.h>
31 #endif /* HAVE_SYS_RESOURCE_H */
34 #include "tui/tui.h" /* For tui_get_command_dimension. */
42 #include "timeval-utils.h"
47 #include "gdb-demangle.h"
48 #include "expression.h"
52 #include "filenames.h"
54 #include "gdb_obstack.h"
60 #include "inferior.h" /* for signed_pointer_to_address */
62 #include "gdb_curses.h"
64 #include "readline/readline.h"
69 #include "gdb_usleep.h"
71 #include "gdb_regex.h"
74 extern PTR
malloc (); /* ARI: PTR */
76 #if !HAVE_DECL_REALLOC
77 extern PTR
realloc (); /* ARI: PTR */
83 void (*deprecated_error_begin_hook
) (void);
85 /* Prototypes for local functions */
87 static void vfprintf_maybe_filtered (struct ui_file
*, const char *,
88 va_list, int) ATTRIBUTE_PRINTF (2, 0);
90 static void fputs_maybe_filtered (const char *, struct ui_file
*, int);
92 static void prompt_for_continue (void);
94 static void set_screen_size (void);
95 static void set_width (void);
97 /* Time spent in prompt_for_continue in the currently executing command
98 waiting for user to respond.
99 Initialized in make_command_stats_cleanup.
100 Modified in prompt_for_continue and defaulted_query.
101 Used in report_command_stats. */
103 static struct timeval prompt_for_continue_wait_time
;
105 /* A flag indicating whether to timestamp debugging messages. */
107 static int debug_timestamp
= 0;
109 /* Nonzero if we have job control. */
113 /* Nonzero means quit immediately if Control-C is typed now, rather
114 than waiting until QUIT is executed. Be careful in setting this;
115 code which executes with immediate_quit set has to be very careful
116 about being able to deal with being interrupted at any time. It is
117 almost always better to use QUIT; the only exception I can think of
118 is being able to quit out of a system call (using EINTR loses if
119 the SIGINT happens between the previous QUIT and the system call).
120 To immediately quit in the case in which a SIGINT happens between
121 the previous QUIT and setting immediate_quit (desirable anytime we
122 expect to block), call QUIT after setting immediate_quit. */
126 /* Nonzero means that strings with character values >0x7F should be printed
127 as octal escapes. Zero means just print the value (e.g. it's an
128 international character, and the terminal or window can cope.) */
130 int sevenbit_strings
= 0;
132 show_sevenbit_strings (struct ui_file
*file
, int from_tty
,
133 struct cmd_list_element
*c
, const char *value
)
135 fprintf_filtered (file
, _("Printing of 8-bit characters "
136 "in strings as \\nnn is %s.\n"),
140 /* String to be printed before warning messages, if any. */
142 char *warning_pre_print
= "\nwarning: ";
144 int pagination_enabled
= 1;
146 show_pagination_enabled (struct ui_file
*file
, int from_tty
,
147 struct cmd_list_element
*c
, const char *value
)
149 fprintf_filtered (file
, _("State of pagination is %s.\n"), value
);
153 /* Cleanup utilities.
155 These are not defined in cleanups.c (nor declared in cleanups.h)
156 because while they use the "cleanup API" they are not part of the
160 do_freeargv (void *arg
)
162 freeargv ((char **) arg
);
166 make_cleanup_freeargv (char **arg
)
168 return make_cleanup (do_freeargv
, arg
);
172 do_dyn_string_delete (void *arg
)
174 dyn_string_delete ((dyn_string_t
) arg
);
178 make_cleanup_dyn_string_delete (dyn_string_t arg
)
180 return make_cleanup (do_dyn_string_delete
, arg
);
184 do_bfd_close_cleanup (void *arg
)
190 make_cleanup_bfd_unref (bfd
*abfd
)
192 return make_cleanup (do_bfd_close_cleanup
, abfd
);
196 do_close_cleanup (void *arg
)
204 make_cleanup_close (int fd
)
206 int *saved_fd
= xmalloc (sizeof (fd
));
209 return make_cleanup_dtor (do_close_cleanup
, saved_fd
, xfree
);
212 /* Helper function which does the work for make_cleanup_fclose. */
215 do_fclose_cleanup (void *arg
)
222 /* Return a new cleanup that closes FILE. */
225 make_cleanup_fclose (FILE *file
)
227 return make_cleanup (do_fclose_cleanup
, file
);
230 /* Helper function which does the work for make_cleanup_obstack_free. */
233 do_obstack_free (void *arg
)
235 struct obstack
*ob
= arg
;
237 obstack_free (ob
, NULL
);
240 /* Return a new cleanup that frees OBSTACK. */
243 make_cleanup_obstack_free (struct obstack
*obstack
)
245 return make_cleanup (do_obstack_free
, obstack
);
249 do_ui_file_delete (void *arg
)
251 ui_file_delete (arg
);
255 make_cleanup_ui_file_delete (struct ui_file
*arg
)
257 return make_cleanup (do_ui_file_delete
, arg
);
260 /* Helper function for make_cleanup_ui_out_redirect_pop. */
263 do_ui_out_redirect_pop (void *arg
)
265 struct ui_out
*uiout
= arg
;
267 if (ui_out_redirect (uiout
, NULL
) < 0)
268 warning (_("Cannot restore redirection of the current output protocol"));
271 /* Return a new cleanup that pops the last redirection by ui_out_redirect
272 with NULL parameter. */
275 make_cleanup_ui_out_redirect_pop (struct ui_out
*uiout
)
277 return make_cleanup (do_ui_out_redirect_pop
, uiout
);
281 do_free_section_addr_info (void *arg
)
283 free_section_addr_info (arg
);
287 make_cleanup_free_section_addr_info (struct section_addr_info
*addrs
)
289 return make_cleanup (do_free_section_addr_info
, addrs
);
292 struct restore_integer_closure
299 restore_integer (void *p
)
301 struct restore_integer_closure
*closure
= p
;
303 *(closure
->variable
) = closure
->value
;
306 /* Remember the current value of *VARIABLE and make it restored when
307 the cleanup is run. */
310 make_cleanup_restore_integer (int *variable
)
312 struct restore_integer_closure
*c
=
313 xmalloc (sizeof (struct restore_integer_closure
));
315 c
->variable
= variable
;
316 c
->value
= *variable
;
318 return make_cleanup_dtor (restore_integer
, (void *) c
, xfree
);
321 /* Remember the current value of *VARIABLE and make it restored when
322 the cleanup is run. */
325 make_cleanup_restore_uinteger (unsigned int *variable
)
327 return make_cleanup_restore_integer ((int *) variable
);
330 /* Helper for make_cleanup_unpush_target. */
333 do_unpush_target (void *arg
)
335 struct target_ops
*ops
= arg
;
340 /* Return a new cleanup that unpushes OPS. */
343 make_cleanup_unpush_target (struct target_ops
*ops
)
345 return make_cleanup (do_unpush_target
, ops
);
348 /* Helper for make_cleanup_htab_delete compile time checking the types. */
351 do_htab_delete_cleanup (void *htab_voidp
)
353 htab_t htab
= htab_voidp
;
358 /* Return a new cleanup that deletes HTAB. */
361 make_cleanup_htab_delete (htab_t htab
)
363 return make_cleanup (do_htab_delete_cleanup
, htab
);
366 struct restore_ui_file_closure
368 struct ui_file
**variable
;
369 struct ui_file
*value
;
373 do_restore_ui_file (void *p
)
375 struct restore_ui_file_closure
*closure
= p
;
377 *(closure
->variable
) = closure
->value
;
380 /* Remember the current value of *VARIABLE and make it restored when
381 the cleanup is run. */
384 make_cleanup_restore_ui_file (struct ui_file
**variable
)
386 struct restore_ui_file_closure
*c
= XNEW (struct restore_ui_file_closure
);
388 c
->variable
= variable
;
389 c
->value
= *variable
;
391 return make_cleanup_dtor (do_restore_ui_file
, (void *) c
, xfree
);
394 /* Helper for make_cleanup_value_free_to_mark. */
397 do_value_free_to_mark (void *value
)
399 value_free_to_mark ((struct value
*) value
);
402 /* Free all values allocated since MARK was obtained by value_mark
403 (except for those released) when the cleanup is run. */
406 make_cleanup_value_free_to_mark (struct value
*mark
)
408 return make_cleanup (do_value_free_to_mark
, mark
);
411 /* Helper for make_cleanup_value_free. */
414 do_value_free (void *value
)
422 make_cleanup_value_free (struct value
*value
)
424 return make_cleanup (do_value_free
, value
);
427 /* Helper for make_cleanup_free_so. */
430 do_free_so (void *arg
)
432 struct so_list
*so
= arg
;
437 /* Make cleanup handler calling free_so for SO. */
440 make_cleanup_free_so (struct so_list
*so
)
442 return make_cleanup (do_free_so
, so
);
445 /* Helper for make_cleanup_restore_current_language. */
448 do_restore_current_language (void *p
)
450 enum language saved_lang
= (uintptr_t) p
;
452 set_language (saved_lang
);
455 /* Remember the current value of CURRENT_LANGUAGE and make it restored when
456 the cleanup is run. */
459 make_cleanup_restore_current_language (void)
461 enum language saved_lang
= current_language
->la_language
;
463 return make_cleanup (do_restore_current_language
,
464 (void *) (uintptr_t) saved_lang
);
467 /* Helper function for make_cleanup_clear_parser_state. */
470 do_clear_parser_state (void *ptr
)
472 struct parser_state
**p
= (struct parser_state
**) ptr
;
477 /* Clean (i.e., set to NULL) the parser state variable P. */
480 make_cleanup_clear_parser_state (struct parser_state
**p
)
482 return make_cleanup (do_clear_parser_state
, (void *) p
);
485 /* This function is useful for cleanups.
489 old_chain = make_cleanup (free_current_contents, &foo);
491 to arrange to free the object thus allocated. */
494 free_current_contents (void *ptr
)
496 void **location
= ptr
;
498 if (location
== NULL
)
499 internal_error (__FILE__
, __LINE__
,
500 _("free_current_contents: NULL pointer"));
501 if (*location
!= NULL
)
510 /* Print a warning message. The first argument STRING is the warning
511 message, used as an fprintf format string, the second is the
512 va_list of arguments for that string. A warning is unfiltered (not
513 paginated) so that the user does not need to page through each
514 screen full of warnings when there are lots of them. */
517 vwarning (const char *string
, va_list args
)
519 if (deprecated_warning_hook
)
520 (*deprecated_warning_hook
) (string
, args
);
523 target_terminal_ours ();
524 wrap_here (""); /* Force out any buffered output. */
525 gdb_flush (gdb_stdout
);
526 if (warning_pre_print
)
527 fputs_unfiltered (warning_pre_print
, gdb_stderr
);
528 vfprintf_unfiltered (gdb_stderr
, string
, args
);
529 fprintf_unfiltered (gdb_stderr
, "\n");
533 /* Print a warning message.
534 The first argument STRING is the warning message, used as a fprintf string,
535 and the remaining args are passed as arguments to it.
536 The primary difference between warnings and errors is that a warning
537 does not force the return to command level. */
540 warning (const char *string
, ...)
544 va_start (args
, string
);
545 vwarning (string
, args
);
549 /* Print an error message and return to command level.
550 The first argument STRING is the error message, used as a fprintf string,
551 and the remaining args are passed as arguments to it. */
554 verror (const char *string
, va_list args
)
556 throw_verror (GENERIC_ERROR
, string
, args
);
560 error (const char *string
, ...)
564 va_start (args
, string
);
565 throw_verror (GENERIC_ERROR
, string
, args
);
570 error_stream (struct ui_file
*stream
)
572 char *message
= ui_file_xstrdup (stream
, NULL
);
574 make_cleanup (xfree
, message
);
575 error (("%s"), message
);
578 /* Dump core trying to increase the core soft limit to hard limit first. */
583 #ifdef HAVE_SETRLIMIT
584 struct rlimit rlim
= { RLIM_INFINITY
, RLIM_INFINITY
};
586 setrlimit (RLIMIT_CORE
, &rlim
);
587 #endif /* HAVE_SETRLIMIT */
589 abort (); /* NOTE: GDB has only three calls to abort(). */
592 /* Check whether GDB will be able to dump core using the dump_core
593 function. Returns zero if GDB cannot or should not dump core.
594 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
595 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
598 can_dump_core (enum resource_limit_kind limit_kind
)
600 #ifdef HAVE_GETRLIMIT
603 /* Be quiet and assume we can dump if an error is returned. */
604 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
610 if (rlim
.rlim_cur
== 0)
614 if (rlim
.rlim_max
== 0)
617 #endif /* HAVE_GETRLIMIT */
622 /* Print a warning that we cannot dump core. */
625 warn_cant_dump_core (const char *reason
)
627 fprintf_unfiltered (gdb_stderr
,
628 _("%s\nUnable to dump core, use `ulimit -c"
629 " unlimited' before executing GDB next time.\n"),
633 /* Check whether GDB will be able to dump core using the dump_core
634 function, and print a warning if we cannot. */
637 can_dump_core_warn (enum resource_limit_kind limit_kind
,
640 int core_dump_allowed
= can_dump_core (limit_kind
);
642 if (!core_dump_allowed
)
643 warn_cant_dump_core (reason
);
645 return core_dump_allowed
;
648 /* Allow the user to configure the debugger behavior with respect to
649 what to do when an internal problem is detected. */
651 const char internal_problem_ask
[] = "ask";
652 const char internal_problem_yes
[] = "yes";
653 const char internal_problem_no
[] = "no";
654 static const char *const internal_problem_modes
[] =
656 internal_problem_ask
,
657 internal_problem_yes
,
662 /* Print a message reporting an internal error/warning. Ask the user
663 if they want to continue, dump core, or just exit. Return
664 something to indicate a quit. */
666 struct internal_problem
669 int user_settable_should_quit
;
670 const char *should_quit
;
671 int user_settable_should_dump_core
;
672 const char *should_dump_core
;
675 /* Report a problem, internal to GDB, to the user. Once the problem
676 has been reported, and assuming GDB didn't quit, the caller can
677 either allow execution to resume or throw an error. */
679 static void ATTRIBUTE_PRINTF (4, 0)
680 internal_vproblem (struct internal_problem
*problem
,
681 const char *file
, int line
, const char *fmt
, va_list ap
)
687 struct cleanup
*cleanup
= make_cleanup (null_cleanup
, NULL
);
689 /* Don't allow infinite error/warning recursion. */
691 static char msg
[] = "Recursive internal problem.\n";
700 fputs_unfiltered (msg
, gdb_stderr
);
701 abort (); /* NOTE: GDB has only three calls to abort(). */
704 /* Newer GLIBC versions put the warn_unused_result attribute
705 on write, but this is one of those rare cases where
706 ignoring the return value is correct. Casting to (void)
707 does not fix this problem. This is the solution suggested
708 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
709 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
710 abort (); /* NOTE: GDB has only three calls to abort(). */
715 /* Try to get the message out and at the start of a new line. */
716 target_terminal_ours ();
719 /* Create a string containing the full error/warning message. Need
720 to call query with this full string, as otherwize the reason
721 (error/warning) and question become separated. Format using a
722 style similar to a compiler error message. Include extra detail
723 so that the user knows that they are living on the edge. */
727 msg
= xstrvprintf (fmt
, ap
);
728 reason
= xstrprintf ("%s:%d: %s: %s\n"
729 "A problem internal to GDB has been detected,\n"
730 "further debugging may prove unreliable.",
731 file
, line
, problem
->name
, msg
);
733 make_cleanup (xfree
, reason
);
736 /* Emit the message unless query will emit it below. */
737 if (problem
->should_quit
!= internal_problem_ask
|| !confirm
)
738 fprintf_unfiltered (gdb_stderr
, "%s\n", reason
);
740 if (problem
->should_quit
== internal_problem_ask
)
742 /* Default (yes/batch case) is to quit GDB. When in batch mode
743 this lessens the likelihood of GDB going into an infinite
748 quit_p
= query (_("%s\nQuit this debugging session? "), reason
);
750 else if (problem
->should_quit
== internal_problem_yes
)
752 else if (problem
->should_quit
== internal_problem_no
)
755 internal_error (__FILE__
, __LINE__
, _("bad switch"));
757 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr
);
758 if (REPORT_BUGS_TO
[0])
759 fprintf_unfiltered (gdb_stderr
, _(" For instructions, see:\n%s."),
761 fputs_unfiltered ("\n\n", gdb_stderr
);
763 if (problem
->should_dump_core
== internal_problem_ask
)
765 if (!can_dump_core_warn (LIMIT_MAX
, reason
))
769 /* Default (yes/batch case) is to dump core. This leaves a GDB
770 `dropping' so that it is easier to see that something went
772 dump_core_p
= query (_("%s\nCreate a core file of GDB? "), reason
);
775 else if (problem
->should_dump_core
== internal_problem_yes
)
776 dump_core_p
= can_dump_core_warn (LIMIT_MAX
, reason
);
777 else if (problem
->should_dump_core
== internal_problem_no
)
780 internal_error (__FILE__
, __LINE__
, _("bad switch"));
793 #ifdef HAVE_WORKING_FORK
801 do_cleanups (cleanup
);
804 static struct internal_problem internal_error_problem
= {
805 "internal-error", 1, internal_problem_ask
, 1, internal_problem_ask
809 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
811 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
812 throw_quit (_("Command aborted."));
816 internal_error (const char *file
, int line
, const char *string
, ...)
820 va_start (ap
, string
);
821 internal_verror (file
, line
, string
, ap
);
825 static struct internal_problem internal_warning_problem
= {
826 "internal-warning", 1, internal_problem_ask
, 1, internal_problem_ask
830 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
832 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
836 internal_warning (const char *file
, int line
, const char *string
, ...)
840 va_start (ap
, string
);
841 internal_vwarning (file
, line
, string
, ap
);
845 static struct internal_problem demangler_warning_problem
= {
846 "demangler-warning", 1, internal_problem_ask
, 0, internal_problem_no
850 demangler_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
852 internal_vproblem (&demangler_warning_problem
, file
, line
, fmt
, ap
);
856 demangler_warning (const char *file
, int line
, const char *string
, ...)
860 va_start (ap
, string
);
861 demangler_vwarning (file
, line
, string
, ap
);
865 /* Dummy functions to keep add_prefix_cmd happy. */
868 set_internal_problem_cmd (char *args
, int from_tty
)
873 show_internal_problem_cmd (char *args
, int from_tty
)
877 /* When GDB reports an internal problem (error or warning) it gives
878 the user the opportunity to quit GDB and/or create a core file of
879 the current debug session. This function registers a few commands
880 that make it possible to specify that GDB should always or never
881 quit or create a core file, without asking. The commands look
884 maint set PROBLEM-NAME quit ask|yes|no
885 maint show PROBLEM-NAME quit
886 maint set PROBLEM-NAME corefile ask|yes|no
887 maint show PROBLEM-NAME corefile
889 Where PROBLEM-NAME is currently "internal-error" or
890 "internal-warning". */
893 add_internal_problem_command (struct internal_problem
*problem
)
895 struct cmd_list_element
**set_cmd_list
;
896 struct cmd_list_element
**show_cmd_list
;
900 set_cmd_list
= xmalloc (sizeof (*set_cmd_list
));
901 show_cmd_list
= xmalloc (sizeof (*set_cmd_list
));
902 *set_cmd_list
= NULL
;
903 *show_cmd_list
= NULL
;
905 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
908 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
911 add_prefix_cmd ((char*) problem
->name
,
912 class_maintenance
, set_internal_problem_cmd
, set_doc
,
914 concat ("maintenance set ", problem
->name
, " ",
916 0/*allow-unknown*/, &maintenance_set_cmdlist
);
918 add_prefix_cmd ((char*) problem
->name
,
919 class_maintenance
, show_internal_problem_cmd
, show_doc
,
921 concat ("maintenance show ", problem
->name
, " ",
923 0/*allow-unknown*/, &maintenance_show_cmdlist
);
925 if (problem
->user_settable_should_quit
)
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
,
948 if (problem
->user_settable_should_dump_core
)
950 set_doc
= xstrprintf (_("Set whether GDB should create a core "
951 "file of GDB when %s is detected"),
953 show_doc
= xstrprintf (_("Show whether GDB will create a core "
954 "file of GDB when %s is detected"),
956 add_setshow_enum_cmd ("corefile", class_maintenance
,
957 internal_problem_modes
,
958 &problem
->should_dump_core
,
972 /* Return a newly allocated string, containing the PREFIX followed
973 by the system error message for errno (separated by a colon).
975 The result must be deallocated after use. */
978 perror_string (const char *prefix
)
983 err
= safe_strerror (errno
);
984 combined
= (char *) xmalloc (strlen (err
) + strlen (prefix
) + 3);
985 strcpy (combined
, prefix
);
986 strcat (combined
, ": ");
987 strcat (combined
, err
);
992 /* Print the system error message for errno, and also mention STRING
993 as the file name for which the error was encountered. Use ERRCODE
994 for the thrown exception. Then return to command level. */
997 throw_perror_with_name (enum errors errcode
, const char *string
)
1001 combined
= perror_string (string
);
1002 make_cleanup (xfree
, combined
);
1004 /* I understand setting these is a matter of taste. Still, some people
1005 may clear errno but not know about bfd_error. Doing this here is not
1007 bfd_set_error (bfd_error_no_error
);
1010 throw_error (errcode
, _("%s."), combined
);
1013 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
1016 perror_with_name (const char *string
)
1018 throw_perror_with_name (GENERIC_ERROR
, string
);
1021 /* Same as perror_with_name except that it prints a warning instead
1022 of throwing an error. */
1025 perror_warning_with_name (const char *string
)
1029 combined
= perror_string (string
);
1030 warning (_("%s"), combined
);
1034 /* Print the system error message for ERRCODE, and also mention STRING
1035 as the file name for which the error was encountered. */
1038 print_sys_errmsg (const char *string
, int errcode
)
1043 err
= safe_strerror (errcode
);
1044 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
1045 strcpy (combined
, string
);
1046 strcat (combined
, ": ");
1047 strcat (combined
, err
);
1049 /* We want anything which was printed on stdout to come out first, before
1051 gdb_flush (gdb_stdout
);
1052 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
1055 /* Control C eventually causes this to be called, at a convenient time. */
1060 if (sync_quit_force_run
)
1062 sync_quit_force_run
= 0;
1063 quit_force (NULL
, stdin
== instream
);
1067 /* No steenking SIGINT will ever be coming our way when the
1068 program is resumed. Don't lie. */
1069 throw_quit ("Quit");
1072 /* If there is no terminal switching for this target, then we can't
1073 possibly get screwed by the lack of job control. */
1074 || !target_supports_terminal_ours ())
1075 throw_quit ("Quit");
1077 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
1082 /* Called when a memory allocation fails, with the number of bytes of
1083 memory requested in SIZE. */
1086 malloc_failure (long size
)
1090 internal_error (__FILE__
, __LINE__
,
1091 _("virtual memory exhausted: can't allocate %ld bytes."),
1096 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
1100 /* My replacement for the read system call.
1101 Used like `read' but keeps going if `read' returns too soon. */
1104 myread (int desc
, char *addr
, int len
)
1111 val
= read (desc
, addr
, len
);
1115 return orglen
- len
;
1123 print_spaces (int n
, struct ui_file
*file
)
1125 fputs_unfiltered (n_spaces (n
), file
);
1128 /* Print a host address. */
1131 gdb_print_host_address (const void *addr
, struct ui_file
*stream
)
1133 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
1137 /* A cleanup function that calls regfree. */
1140 do_regfree_cleanup (void *r
)
1145 /* Create a new cleanup that frees the compiled regular expression R. */
1148 make_regfree_cleanup (regex_t
*r
)
1150 return make_cleanup (do_regfree_cleanup
, r
);
1153 /* Return an xmalloc'd error message resulting from a regular
1154 expression compilation failure. */
1157 get_regcomp_error (int code
, regex_t
*rx
)
1159 size_t length
= regerror (code
, rx
, NULL
, 0);
1160 char *result
= xmalloc (length
);
1162 regerror (code
, rx
, result
, length
);
1166 /* Compile a regexp and throw an exception on error. This returns a
1167 cleanup to free the resulting pattern on success. RX must not be
1171 compile_rx_or_error (regex_t
*pattern
, const char *rx
, const char *message
)
1175 gdb_assert (rx
!= NULL
);
1177 code
= regcomp (pattern
, rx
, REG_NOSUB
);
1180 char *err
= get_regcomp_error (code
, pattern
);
1182 make_cleanup (xfree
, err
);
1183 error (("%s: %s"), message
, err
);
1186 return make_regfree_cleanup (pattern
);
1191 /* This function supports the query, nquery, and yquery functions.
1192 Ask user a y-or-n question and return 0 if answer is no, 1 if
1193 answer is yes, or default the answer to the specified default
1194 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1195 default answer, or '\0' for no default.
1196 CTLSTR is the control string and should end in "? ". It should
1197 not say how to answer, because we do that.
1198 ARGS are the arguments passed along with the CTLSTR argument to
1201 static int ATTRIBUTE_PRINTF (1, 0)
1202 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
1208 char def_answer
, not_def_answer
;
1209 char *y_string
, *n_string
, *question
;
1210 /* Used to add duration we waited for user to respond to
1211 prompt_for_continue_wait_time. */
1212 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1214 /* Set up according to which answer is the default. */
1215 if (defchar
== '\0')
1219 not_def_answer
= 'N';
1223 else if (defchar
== 'y')
1227 not_def_answer
= 'N';
1235 not_def_answer
= 'Y';
1240 /* Automatically answer the default value if the user did not want
1241 prompts or the command was issued with the server prefix. */
1242 if (!confirm
|| server_command
)
1245 /* If input isn't coming from the user directly, just say what
1246 question we're asking, and then answer the default automatically. This
1247 way, important error messages don't get lost when talking to GDB
1249 if (! input_from_terminal_p ())
1252 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
1254 printf_filtered (_("(%s or %s) [answered %c; "
1255 "input not from terminal]\n"),
1256 y_string
, n_string
, def_answer
);
1257 gdb_flush (gdb_stdout
);
1262 if (deprecated_query_hook
)
1264 return deprecated_query_hook (ctlstr
, args
);
1267 /* Format the question outside of the loop, to avoid reusing args. */
1268 question
= xstrvprintf (ctlstr
, args
);
1270 /* Used for calculating time spend waiting for user. */
1271 gettimeofday (&prompt_started
, NULL
);
1275 wrap_here (""); /* Flush any buffered output. */
1276 gdb_flush (gdb_stdout
);
1278 if (annotation_level
> 1)
1279 printf_filtered (("\n\032\032pre-query\n"));
1281 fputs_filtered (question
, gdb_stdout
);
1282 printf_filtered (_("(%s or %s) "), y_string
, n_string
);
1284 if (annotation_level
> 1)
1285 printf_filtered (("\n\032\032query\n"));
1288 gdb_flush (gdb_stdout
);
1290 answer
= fgetc (stdin
);
1292 /* We expect fgetc to block until a character is read. But
1293 this may not be the case if the terminal was opened with
1294 the NONBLOCK flag. In that case, if there is nothing to
1295 read on stdin, fgetc returns EOF, but also sets the error
1296 condition flag on stdin and errno to EAGAIN. With a true
1297 EOF, stdin's error condition flag is not set.
1299 A situation where this behavior was observed is a pseudo
1301 while (answer
== EOF
&& ferror (stdin
) && errno
== EAGAIN
)
1303 /* Not a real EOF. Wait a little while and try again until
1304 we read something. */
1307 answer
= fgetc (stdin
);
1310 clearerr (stdin
); /* in case of C-d */
1311 if (answer
== EOF
) /* C-d */
1313 printf_filtered ("EOF [assumed %c]\n", def_answer
);
1317 /* Eat rest of input line, to EOF or newline. */
1321 ans2
= fgetc (stdin
);
1324 while (ans2
!= EOF
&& ans2
!= '\n' && ans2
!= '\r');
1328 /* Check answer. For the non-default, the user must specify
1329 the non-default explicitly. */
1330 if (answer
== not_def_answer
)
1332 retval
= !def_value
;
1335 /* Otherwise, if a default was specified, the user may either
1336 specify the required input or have it default by entering
1338 if (answer
== def_answer
1339 || (defchar
!= '\0' &&
1340 (answer
== '\n' || answer
== '\r' || answer
== EOF
)))
1345 /* Invalid entries are not defaulted and require another selection. */
1346 printf_filtered (_("Please answer %s or %s.\n"),
1347 y_string
, n_string
);
1350 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1351 gettimeofday (&prompt_ended
, NULL
);
1352 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1353 timeval_add (&prompt_for_continue_wait_time
,
1354 &prompt_for_continue_wait_time
, &prompt_delta
);
1357 if (annotation_level
> 1)
1358 printf_filtered (("\n\032\032post-query\n"));
1363 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1364 answer is yes, or 0 if answer is defaulted.
1365 Takes three args which are given to printf to print the question.
1366 The first, a control string, should end in "? ".
1367 It should not say how to answer, because we do that. */
1370 nquery (const char *ctlstr
, ...)
1375 va_start (args
, ctlstr
);
1376 ret
= defaulted_query (ctlstr
, 'n', args
);
1381 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1382 answer is yes, or 1 if answer is defaulted.
1383 Takes three args which are given to printf to print the question.
1384 The first, a control string, should end in "? ".
1385 It should not say how to answer, because we do that. */
1388 yquery (const char *ctlstr
, ...)
1393 va_start (args
, ctlstr
);
1394 ret
= defaulted_query (ctlstr
, 'y', args
);
1399 /* Ask user a y-or-n question and return 1 iff answer is yes.
1400 Takes three args which are given to printf to print the question.
1401 The first, a control string, should end in "? ".
1402 It should not say how to answer, because we do that. */
1405 query (const char *ctlstr
, ...)
1410 va_start (args
, ctlstr
);
1411 ret
= defaulted_query (ctlstr
, '\0', args
);
1416 /* A helper for parse_escape that converts a host character to a
1417 target character. C is the host character. If conversion is
1418 possible, then the target character is stored in *TARGET_C and the
1419 function returns 1. Otherwise, the function returns 0. */
1422 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1424 struct obstack host_data
;
1426 struct cleanup
*cleanups
;
1429 obstack_init (&host_data
);
1430 cleanups
= make_cleanup_obstack_free (&host_data
);
1432 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1433 (gdb_byte
*) &the_char
, 1, 1,
1434 &host_data
, translit_none
);
1436 if (obstack_object_size (&host_data
) == 1)
1439 *target_c
= *(char *) obstack_base (&host_data
);
1442 do_cleanups (cleanups
);
1446 /* Parse a C escape sequence. STRING_PTR points to a variable
1447 containing a pointer to the string to parse. That pointer
1448 should point to the character after the \. That pointer
1449 is updated past the characters we use. The value of the
1450 escape sequence is returned.
1452 A negative value means the sequence \ newline was seen,
1453 which is supposed to be equivalent to nothing at all.
1455 If \ is followed by a null character, we return a negative
1456 value and leave the string pointer pointing at the null character.
1458 If \ is followed by 000, we return 0 and leave the string pointer
1459 after the zeros. A value of 0 does not mean end of string. */
1462 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1464 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1465 int c
= *(*string_ptr
)++;
1484 int i
= host_hex_value (c
);
1489 if (isdigit (c
) && c
!= '8' && c
!= '9')
1493 i
+= host_hex_value (c
);
1529 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1530 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1531 " which has no equivalent\nin the `%s' character set."),
1532 c
, c
, target_charset (gdbarch
));
1536 /* Print the character C on STREAM as part of the contents of a literal
1537 string whose delimiter is QUOTER. Note that this routine should only
1538 be call for printing things which are independent of the language
1539 of the program being debugged.
1541 printchar will normally escape backslashes and instances of QUOTER. If
1542 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1543 As a side effect, if you pass the backslash character as the QUOTER,
1544 printchar will escape backslashes as usual, but not any other quoting
1548 printchar (int c
, void (*do_fputs
) (const char *, struct ui_file
*),
1549 void (*do_fprintf
) (struct ui_file
*, const char *, ...)
1550 ATTRIBUTE_FPTR_PRINTF_2
, struct ui_file
*stream
, int quoter
)
1552 c
&= 0xFF; /* Avoid sign bit follies */
1554 if (c
< 0x20 || /* Low control chars */
1555 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1556 (sevenbit_strings
&& c
>= 0x80))
1557 { /* high order bit set */
1561 do_fputs ("\\n", stream
);
1564 do_fputs ("\\b", stream
);
1567 do_fputs ("\\t", stream
);
1570 do_fputs ("\\f", stream
);
1573 do_fputs ("\\r", stream
);
1576 do_fputs ("\\e", stream
);
1579 do_fputs ("\\a", stream
);
1582 do_fprintf (stream
, "\\%.3o", (unsigned int) c
);
1588 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1589 do_fputs ("\\", stream
);
1590 do_fprintf (stream
, "%c", c
);
1594 /* Print the character C on STREAM as part of the contents of a
1595 literal string whose delimiter is QUOTER. Note that these routines
1596 should only be call for printing things which are independent of
1597 the language of the program being debugged. */
1600 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1603 printchar (*str
++, fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1607 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1610 printchar (*str
++, fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1614 fputstrn_filtered (const char *str
, int n
, int quoter
,
1615 struct ui_file
*stream
)
1619 for (i
= 0; i
< n
; i
++)
1620 printchar (str
[i
], fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1624 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1625 struct ui_file
*stream
)
1629 for (i
= 0; i
< n
; i
++)
1630 printchar (str
[i
], fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1634 /* Number of lines per page or UINT_MAX if paging is disabled. */
1635 static unsigned int lines_per_page
;
1637 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1638 struct cmd_list_element
*c
, const char *value
)
1640 fprintf_filtered (file
,
1641 _("Number of lines gdb thinks are in a page is %s.\n"),
1645 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1646 static unsigned int chars_per_line
;
1648 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1649 struct cmd_list_element
*c
, const char *value
)
1651 fprintf_filtered (file
,
1652 _("Number of characters gdb thinks "
1653 "are in a line is %s.\n"),
1657 /* Current count of lines printed on this page, chars on this line. */
1658 static unsigned int lines_printed
, chars_printed
;
1660 /* Buffer and start column of buffered text, for doing smarter word-
1661 wrapping. When someone calls wrap_here(), we start buffering output
1662 that comes through fputs_filtered(). If we see a newline, we just
1663 spit it out and forget about the wrap_here(). If we see another
1664 wrap_here(), we spit it out and remember the newer one. If we see
1665 the end of the line, we spit out a newline, the indent, and then
1666 the buffered output. */
1668 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1669 are waiting to be output (they have already been counted in chars_printed).
1670 When wrap_buffer[0] is null, the buffer is empty. */
1671 static char *wrap_buffer
;
1673 /* Pointer in wrap_buffer to the next character to fill. */
1674 static char *wrap_pointer
;
1676 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1678 static char *wrap_indent
;
1680 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1681 is not in effect. */
1682 static int wrap_column
;
1685 /* Inialize the number of lines per page and chars per line. */
1688 init_page_info (void)
1692 lines_per_page
= UINT_MAX
;
1693 chars_per_line
= UINT_MAX
;
1697 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1702 #if defined(__GO32__)
1703 rows
= ScreenRows ();
1704 cols
= ScreenCols ();
1705 lines_per_page
= rows
;
1706 chars_per_line
= cols
;
1708 /* Make sure Readline has initialized its terminal settings. */
1709 rl_reset_terminal (NULL
);
1711 /* Get the screen size from Readline. */
1712 rl_get_screen_size (&rows
, &cols
);
1713 lines_per_page
= rows
;
1714 chars_per_line
= cols
;
1716 /* Readline should have fetched the termcap entry for us.
1717 Only try to use tgetnum function if rl_get_screen_size
1718 did not return a useful value. */
1719 if (((rows
<= 0) && (tgetnum ("li") < 0))
1720 /* Also disable paging if inside EMACS. */
1721 || getenv ("EMACS"))
1723 /* The number of lines per page is not mentioned in the terminal
1724 description or EMACS evironment variable is set. This probably
1725 means that paging is not useful, so disable paging. */
1726 lines_per_page
= UINT_MAX
;
1729 /* If the output is not a terminal, don't paginate it. */
1730 if (!ui_file_isatty (gdb_stdout
))
1731 lines_per_page
= UINT_MAX
;
1739 /* Helper for make_cleanup_restore_page_info. */
1742 do_restore_page_info_cleanup (void *arg
)
1748 /* Provide cleanup for restoring the terminal size. */
1751 make_cleanup_restore_page_info (void)
1753 struct cleanup
*back_to
;
1755 back_to
= make_cleanup (do_restore_page_info_cleanup
, NULL
);
1756 make_cleanup_restore_uinteger (&lines_per_page
);
1757 make_cleanup_restore_uinteger (&chars_per_line
);
1762 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1763 Provide cleanup for restoring the original state. */
1766 set_batch_flag_and_make_cleanup_restore_page_info (void)
1768 struct cleanup
*back_to
= make_cleanup_restore_page_info ();
1770 make_cleanup_restore_integer (&batch_flag
);
1777 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1780 set_screen_size (void)
1782 int rows
= lines_per_page
;
1783 int cols
= chars_per_line
;
1791 /* Update Readline's idea of the terminal size. */
1792 rl_set_screen_size (rows
, cols
);
1795 /* Reinitialize WRAP_BUFFER according to the current value of
1801 if (chars_per_line
== 0)
1806 wrap_buffer
= (char *) xmalloc (chars_per_line
+ 2);
1807 wrap_buffer
[0] = '\0';
1810 wrap_buffer
= (char *) xrealloc (wrap_buffer
, chars_per_line
+ 2);
1811 wrap_pointer
= wrap_buffer
; /* Start it at the beginning. */
1815 set_width_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1822 set_height_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1827 /* Wait, so the user can read what's on the screen. Prompt the user
1828 to continue by pressing RETURN. */
1831 prompt_for_continue (void)
1834 char cont_prompt
[120];
1835 /* Used to add duration we waited for user to respond to
1836 prompt_for_continue_wait_time. */
1837 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1839 gettimeofday (&prompt_started
, NULL
);
1841 if (annotation_level
> 1)
1842 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1844 strcpy (cont_prompt
,
1845 "---Type <return> to continue, or q <return> to quit---");
1846 if (annotation_level
> 1)
1847 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1849 /* We must do this *before* we call gdb_readline, else it will eventually
1850 call us -- thinking that we're trying to print beyond the end of the
1852 reinitialize_more_filter ();
1857 /* We'll need to handle input. */
1858 target_terminal_ours ();
1860 /* On a real operating system, the user can quit with SIGINT.
1863 'q' is provided on all systems so users don't have to change habits
1864 from system to system, and because telling them what to do in
1865 the prompt is more user-friendly than expecting them to think of
1867 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1868 whereas control-C to gdb_readline will cause the user to get dumped
1870 ignore
= gdb_readline_wrapper (cont_prompt
);
1872 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1873 gettimeofday (&prompt_ended
, NULL
);
1874 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1875 timeval_add (&prompt_for_continue_wait_time
,
1876 &prompt_for_continue_wait_time
, &prompt_delta
);
1878 if (annotation_level
> 1)
1879 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1885 while (*p
== ' ' || *p
== '\t')
1893 /* Now we have to do this again, so that GDB will know that it doesn't
1894 need to save the ---Type <return>--- line at the top of the screen. */
1895 reinitialize_more_filter ();
1897 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1900 /* Initalize timer to keep track of how long we waited for the user. */
1903 reset_prompt_for_continue_wait_time (void)
1905 static const struct timeval zero_timeval
= { 0 };
1907 prompt_for_continue_wait_time
= zero_timeval
;
1910 /* Fetch the cumulative time spent in prompt_for_continue. */
1913 get_prompt_for_continue_wait_time (void)
1915 return prompt_for_continue_wait_time
;
1918 /* Reinitialize filter; ie. tell it to reset to original values. */
1921 reinitialize_more_filter (void)
1927 /* Indicate that if the next sequence of characters overflows the line,
1928 a newline should be inserted here rather than when it hits the end.
1929 If INDENT is non-null, it is a string to be printed to indent the
1930 wrapped part on the next line. INDENT must remain accessible until
1931 the next call to wrap_here() or until a newline is printed through
1934 If the line is already overfull, we immediately print a newline and
1935 the indentation, and disable further wrapping.
1937 If we don't know the width of lines, but we know the page height,
1938 we must not wrap words, but should still keep track of newlines
1939 that were explicitly printed.
1941 INDENT should not contain tabs, as that will mess up the char count
1942 on the next line. FIXME.
1944 This routine is guaranteed to force out any output which has been
1945 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1946 used to force out output from the wrap_buffer. */
1949 wrap_here (char *indent
)
1951 /* This should have been allocated, but be paranoid anyway. */
1953 internal_error (__FILE__
, __LINE__
,
1954 _("failed internal consistency check"));
1958 *wrap_pointer
= '\0';
1959 fputs_unfiltered (wrap_buffer
, gdb_stdout
);
1961 wrap_pointer
= wrap_buffer
;
1962 wrap_buffer
[0] = '\0';
1963 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1967 else if (chars_printed
>= chars_per_line
)
1969 puts_filtered ("\n");
1971 puts_filtered (indent
);
1976 wrap_column
= chars_printed
;
1980 wrap_indent
= indent
;
1984 /* Print input string to gdb_stdout, filtered, with wrap,
1985 arranging strings in columns of n chars. String can be
1986 right or left justified in the column. Never prints
1987 trailing spaces. String should never be longer than
1988 width. FIXME: this could be useful for the EXAMINE
1989 command, which currently doesn't tabulate very well. */
1992 puts_filtered_tabular (char *string
, int width
, int right
)
1998 gdb_assert (chars_per_line
> 0);
1999 if (chars_per_line
== UINT_MAX
)
2001 fputs_filtered (string
, gdb_stdout
);
2002 fputs_filtered ("\n", gdb_stdout
);
2006 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
2007 fputs_filtered ("\n", gdb_stdout
);
2009 if (width
>= chars_per_line
)
2010 width
= chars_per_line
- 1;
2012 stringlen
= strlen (string
);
2014 if (chars_printed
> 0)
2015 spaces
= width
- (chars_printed
- 1) % width
- 1;
2017 spaces
+= width
- stringlen
;
2019 spacebuf
= alloca (spaces
+ 1);
2020 spacebuf
[spaces
] = '\0';
2022 spacebuf
[spaces
] = ' ';
2024 fputs_filtered (spacebuf
, gdb_stdout
);
2025 fputs_filtered (string
, gdb_stdout
);
2029 /* Ensure that whatever gets printed next, using the filtered output
2030 commands, starts at the beginning of the line. I.e. if there is
2031 any pending output for the current line, flush it and start a new
2032 line. Otherwise do nothing. */
2037 if (chars_printed
> 0)
2039 puts_filtered ("\n");
2044 /* Like fputs but if FILTER is true, pause after every screenful.
2046 Regardless of FILTER can wrap at points other than the final
2047 character of a line.
2049 Unlike fputs, fputs_maybe_filtered does not return a value.
2050 It is OK for LINEBUFFER to be NULL, in which case just don't print
2053 Note that a longjmp to top level may occur in this routine (only if
2054 FILTER is true) (since prompt_for_continue may do so) so this
2055 routine should not be called when cleanups are not in place. */
2058 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
2061 const char *lineptr
;
2063 if (linebuffer
== 0)
2066 /* Don't do any filtering if it is disabled. */
2067 if (stream
!= gdb_stdout
2068 || !pagination_enabled
2070 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
2071 || top_level_interpreter () == NULL
2072 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2074 fputs_unfiltered (linebuffer
, stream
);
2078 /* Go through and output each character. Show line extension
2079 when this is necessary; prompt user for new page when this is
2082 lineptr
= linebuffer
;
2085 /* Possible new page. */
2086 if (filter
&& (lines_printed
>= lines_per_page
- 1))
2087 prompt_for_continue ();
2089 while (*lineptr
&& *lineptr
!= '\n')
2091 /* Print a single line. */
2092 if (*lineptr
== '\t')
2095 *wrap_pointer
++ = '\t';
2097 fputc_unfiltered ('\t', stream
);
2098 /* Shifting right by 3 produces the number of tab stops
2099 we have already passed, and then adding one and
2100 shifting left 3 advances to the next tab stop. */
2101 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
2107 *wrap_pointer
++ = *lineptr
;
2109 fputc_unfiltered (*lineptr
, stream
);
2114 if (chars_printed
>= chars_per_line
)
2116 unsigned int save_chars
= chars_printed
;
2120 /* If we aren't actually wrapping, don't output newline --
2121 if chars_per_line is right, we probably just overflowed
2122 anyway; if it's wrong, let us keep going. */
2124 fputc_unfiltered ('\n', stream
);
2126 /* Possible new page. */
2127 if (lines_printed
>= lines_per_page
- 1)
2128 prompt_for_continue ();
2130 /* Now output indentation and wrapped string. */
2133 fputs_unfiltered (wrap_indent
, stream
);
2134 *wrap_pointer
= '\0'; /* Null-terminate saved stuff, */
2135 fputs_unfiltered (wrap_buffer
, stream
); /* and eject it. */
2136 /* FIXME, this strlen is what prevents wrap_indent from
2137 containing tabs. However, if we recurse to print it
2138 and count its chars, we risk trouble if wrap_indent is
2139 longer than (the user settable) chars_per_line.
2140 Note also that this can set chars_printed > chars_per_line
2141 if we are printing a long string. */
2142 chars_printed
= strlen (wrap_indent
)
2143 + (save_chars
- wrap_column
);
2144 wrap_pointer
= wrap_buffer
; /* Reset buffer */
2145 wrap_buffer
[0] = '\0';
2146 wrap_column
= 0; /* And disable fancy wrap */
2151 if (*lineptr
== '\n')
2154 wrap_here ((char *) 0); /* Spit out chars, cancel
2157 fputc_unfiltered ('\n', stream
);
2164 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
2166 fputs_maybe_filtered (linebuffer
, stream
, 1);
2170 putchar_unfiltered (int c
)
2174 ui_file_write (gdb_stdout
, &buf
, 1);
2178 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2179 May return nonlocally. */
2182 putchar_filtered (int c
)
2184 return fputc_filtered (c
, gdb_stdout
);
2188 fputc_unfiltered (int c
, struct ui_file
*stream
)
2192 ui_file_write (stream
, &buf
, 1);
2197 fputc_filtered (int c
, struct ui_file
*stream
)
2203 fputs_filtered (buf
, stream
);
2207 /* puts_debug is like fputs_unfiltered, except it prints special
2208 characters in printable fashion. */
2211 puts_debug (char *prefix
, char *string
, char *suffix
)
2215 /* Print prefix and suffix after each line. */
2216 static int new_line
= 1;
2217 static int return_p
= 0;
2218 static char *prev_prefix
= "";
2219 static char *prev_suffix
= "";
2221 if (*string
== '\n')
2224 /* If the prefix is changing, print the previous suffix, a new line,
2225 and the new prefix. */
2226 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
2228 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
2229 fputs_unfiltered ("\n", gdb_stdlog
);
2230 fputs_unfiltered (prefix
, gdb_stdlog
);
2233 /* Print prefix if we printed a newline during the previous call. */
2237 fputs_unfiltered (prefix
, gdb_stdlog
);
2240 prev_prefix
= prefix
;
2241 prev_suffix
= suffix
;
2243 /* Output characters in a printable format. */
2244 while ((ch
= *string
++) != '\0')
2250 fputc_unfiltered (ch
, gdb_stdlog
);
2253 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2257 fputs_unfiltered ("\\\\", gdb_stdlog
);
2260 fputs_unfiltered ("\\b", gdb_stdlog
);
2263 fputs_unfiltered ("\\f", gdb_stdlog
);
2267 fputs_unfiltered ("\\n", gdb_stdlog
);
2270 fputs_unfiltered ("\\r", gdb_stdlog
);
2273 fputs_unfiltered ("\\t", gdb_stdlog
);
2276 fputs_unfiltered ("\\v", gdb_stdlog
);
2280 return_p
= ch
== '\r';
2283 /* Print suffix if we printed a newline. */
2286 fputs_unfiltered (suffix
, gdb_stdlog
);
2287 fputs_unfiltered ("\n", gdb_stdlog
);
2292 /* Print a variable number of ARGS using format FORMAT. If this
2293 information is going to put the amount written (since the last call
2294 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2295 call prompt_for_continue to get the users permision to continue.
2297 Unlike fprintf, this function does not return a value.
2299 We implement three variants, vfprintf (takes a vararg list and stream),
2300 fprintf (takes a stream to write on), and printf (the usual).
2302 Note also that a longjmp to top level may occur in this routine
2303 (since prompt_for_continue may do so) so this routine should not be
2304 called when cleanups are not in place. */
2307 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2308 va_list args
, int filter
)
2311 struct cleanup
*old_cleanups
;
2313 linebuffer
= xstrvprintf (format
, args
);
2314 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2315 fputs_maybe_filtered (linebuffer
, stream
, filter
);
2316 do_cleanups (old_cleanups
);
2321 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2323 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2327 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2330 struct cleanup
*old_cleanups
;
2332 linebuffer
= xstrvprintf (format
, args
);
2333 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2334 if (debug_timestamp
&& stream
== gdb_stdlog
)
2340 gettimeofday (&tm
, NULL
);
2342 len
= strlen (linebuffer
);
2343 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2345 timestamp
= xstrprintf ("%ld:%ld %s%s",
2346 (long) tm
.tv_sec
, (long) tm
.tv_usec
,
2348 need_nl
? "\n": "");
2349 make_cleanup (xfree
, timestamp
);
2350 fputs_unfiltered (timestamp
, stream
);
2353 fputs_unfiltered (linebuffer
, stream
);
2354 do_cleanups (old_cleanups
);
2358 vprintf_filtered (const char *format
, va_list args
)
2360 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2364 vprintf_unfiltered (const char *format
, va_list args
)
2366 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2370 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2374 va_start (args
, format
);
2375 vfprintf_filtered (stream
, format
, args
);
2380 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2384 va_start (args
, format
);
2385 vfprintf_unfiltered (stream
, format
, args
);
2389 /* Like fprintf_filtered, but prints its result indented.
2390 Called as fprintfi_filtered (spaces, stream, format, ...); */
2393 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2398 va_start (args
, format
);
2399 print_spaces_filtered (spaces
, stream
);
2401 vfprintf_filtered (stream
, format
, args
);
2407 printf_filtered (const char *format
, ...)
2411 va_start (args
, format
);
2412 vfprintf_filtered (gdb_stdout
, format
, args
);
2418 printf_unfiltered (const char *format
, ...)
2422 va_start (args
, format
);
2423 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2427 /* Like printf_filtered, but prints it's result indented.
2428 Called as printfi_filtered (spaces, format, ...); */
2431 printfi_filtered (int spaces
, const char *format
, ...)
2435 va_start (args
, format
);
2436 print_spaces_filtered (spaces
, gdb_stdout
);
2437 vfprintf_filtered (gdb_stdout
, format
, args
);
2441 /* Easy -- but watch out!
2443 This routine is *not* a replacement for puts()! puts() appends a newline.
2444 This one doesn't, and had better not! */
2447 puts_filtered (const char *string
)
2449 fputs_filtered (string
, gdb_stdout
);
2453 puts_unfiltered (const char *string
)
2455 fputs_unfiltered (string
, gdb_stdout
);
2458 /* Return a pointer to N spaces and a null. The pointer is good
2459 until the next call to here. */
2464 static char *spaces
= 0;
2465 static int max_spaces
= -1;
2471 spaces
= (char *) xmalloc (n
+ 1);
2472 for (t
= spaces
+ n
; t
!= spaces
;)
2478 return spaces
+ max_spaces
- n
;
2481 /* Print N spaces. */
2483 print_spaces_filtered (int n
, struct ui_file
*stream
)
2485 fputs_filtered (n_spaces (n
), stream
);
2488 /* C++/ObjC demangler stuff. */
2490 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2491 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2492 If the name is not mangled, or the language for the name is unknown, or
2493 demangling is off, the name is printed in its "raw" form. */
2496 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2497 enum language lang
, int arg_mode
)
2503 /* If user wants to see raw output, no problem. */
2506 fputs_filtered (name
, stream
);
2510 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2511 fputs_filtered (demangled
? demangled
: name
, stream
);
2512 if (demangled
!= NULL
)
2520 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2521 differences in whitespace. Returns 0 if they match, non-zero if they
2522 don't (slightly different than strcmp()'s range of return values).
2524 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2525 This "feature" is useful when searching for matching C++ function names
2526 (such as if the user types 'break FOO', where FOO is a mangled C++
2530 strcmp_iw (const char *string1
, const char *string2
)
2532 while ((*string1
!= '\0') && (*string2
!= '\0'))
2534 while (isspace (*string1
))
2538 while (isspace (*string2
))
2542 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2544 if (case_sensitivity
== case_sensitive_off
2545 && (tolower ((unsigned char) *string1
)
2546 != tolower ((unsigned char) *string2
)))
2548 if (*string1
!= '\0')
2554 return (*string1
!= '\0' && *string1
!= '(') || (*string2
!= '\0');
2557 /* This is like strcmp except that it ignores whitespace and treats
2558 '(' as the first non-NULL character in terms of ordering. Like
2559 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2560 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2561 according to that ordering.
2563 If a list is sorted according to this function and if you want to
2564 find names in the list that match some fixed NAME according to
2565 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2566 where this function would put NAME.
2568 This function must be neutral to the CASE_SENSITIVITY setting as the user
2569 may choose it during later lookup. Therefore this function always sorts
2570 primarily case-insensitively and secondarily case-sensitively.
2572 Here are some examples of why using strcmp to sort is a bad idea:
2576 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2577 we try to do a search for "foo<char*>", strcmp will locate this
2578 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2579 will start looking at strings beginning with "goo", and will never
2580 see the correct match of "foo<char *>".
2582 Parenthesis example:
2584 In practice, this is less like to be an issue, but I'll give it a
2585 shot. Let's assume that '$' is a legitimate character to occur in
2586 symbols. (Which may well even be the case on some systems.) Then
2587 say that the partial symbol table contains "foo$" and "foo(int)".
2588 strcmp will put them in this order, since '$' < '('. Now, if the
2589 user searches for "foo", then strcmp will sort "foo" before "foo$".
2590 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2591 "foo") is false, so it won't proceed to the actual match of
2592 "foo(int)" with "foo". */
2595 strcmp_iw_ordered (const char *string1
, const char *string2
)
2597 const char *saved_string1
= string1
, *saved_string2
= string2
;
2598 enum case_sensitivity case_pass
= case_sensitive_off
;
2602 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2603 Provide stub characters if we are already at the end of one of the
2605 char c1
= 'X', c2
= 'X';
2607 while (*string1
!= '\0' && *string2
!= '\0')
2609 while (isspace (*string1
))
2611 while (isspace (*string2
))
2616 case case_sensitive_off
:
2617 c1
= tolower ((unsigned char) *string1
);
2618 c2
= tolower ((unsigned char) *string2
);
2620 case case_sensitive_on
:
2628 if (*string1
!= '\0')
2637 /* Characters are non-equal unless they're both '\0'; we want to
2638 make sure we get the comparison right according to our
2639 comparison in the cases where one of them is '\0' or '('. */
2641 if (*string2
== '\0')
2646 if (*string2
== '\0')
2651 if (*string2
== '\0' || *string2
== '(')
2660 if (case_pass
== case_sensitive_on
)
2663 /* Otherwise the strings were equal in case insensitive way, make
2664 a more fine grained comparison in a case sensitive way. */
2666 case_pass
= case_sensitive_on
;
2667 string1
= saved_string1
;
2668 string2
= saved_string2
;
2672 /* A simple comparison function with opposite semantics to strcmp. */
2675 streq (const char *lhs
, const char *rhs
)
2677 return !strcmp (lhs
, rhs
);
2683 ** Answer whether string_to_compare is a full or partial match to
2684 ** template_string. The partial match must be in sequence starting
2688 subset_compare (char *string_to_compare
, char *template_string
)
2692 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
2693 && strlen (string_to_compare
) <= strlen (template_string
))
2696 (template_string
, string_to_compare
, strlen (string_to_compare
)) == 0);
2703 pagination_on_command (char *arg
, int from_tty
)
2705 pagination_enabled
= 1;
2709 pagination_off_command (char *arg
, int from_tty
)
2711 pagination_enabled
= 0;
2715 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2716 struct cmd_list_element
*c
, const char *value
)
2718 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2724 initialize_utils (void)
2726 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
2727 Set number of characters where GDB should wrap lines of its output."), _("\
2728 Show number of characters where GDB should wrap lines of its output."), _("\
2729 This affects where GDB wraps its output to fit the screen width.\n\
2730 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2732 show_chars_per_line
,
2733 &setlist
, &showlist
);
2735 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
2736 Set number of lines in a page for GDB output pagination."), _("\
2737 Show number of lines in a page for GDB output pagination."), _("\
2738 This affects the number of lines after which GDB will pause\n\
2739 its output and ask you whether to continue.\n\
2740 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2742 show_lines_per_page
,
2743 &setlist
, &showlist
);
2747 add_setshow_boolean_cmd ("pagination", class_support
,
2748 &pagination_enabled
, _("\
2749 Set state of GDB output pagination."), _("\
2750 Show state of GDB output pagination."), _("\
2751 When pagination is ON, GDB pauses at end of each screenful of\n\
2752 its output and asks you whether to continue.\n\
2753 Turning pagination off is an alternative to \"set height unlimited\"."),
2755 show_pagination_enabled
,
2756 &setlist
, &showlist
);
2760 add_com ("am", class_support
, pagination_on_command
,
2761 _("Enable pagination"));
2762 add_com ("sm", class_support
, pagination_off_command
,
2763 _("Disable pagination"));
2766 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
2767 &sevenbit_strings
, _("\
2768 Set printing of 8-bit characters in strings as \\nnn."), _("\
2769 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
2771 show_sevenbit_strings
,
2772 &setprintlist
, &showprintlist
);
2774 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
2775 &debug_timestamp
, _("\
2776 Set timestamping of debugging messages."), _("\
2777 Show timestamping of debugging messages."), _("\
2778 When set, debugging messages will be marked with seconds and microseconds."),
2780 show_debug_timestamp
,
2781 &setdebuglist
, &showdebuglist
);
2785 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2787 /* Truncate address to the size of a target address, avoiding shifts
2788 larger or equal than the width of a CORE_ADDR. The local
2789 variable ADDR_BIT stops the compiler reporting a shift overflow
2790 when it won't occur. */
2791 /* NOTE: This assumes that the significant address information is
2792 kept in the least significant bits of ADDR - the upper bits were
2793 either zero or sign extended. Should gdbarch_address_to_pointer or
2794 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2796 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2798 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2799 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2800 return hex_string (addr
);
2803 /* This function is described in "defs.h". */
2806 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2808 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2810 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2811 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2813 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2814 that returns the language localized string formatted to a width
2815 based on gdbarch_addr_bit. */
2817 return hex_string_custom (address
, 8);
2819 return hex_string_custom (address
, 16);
2822 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2825 core_addr_hash (const void *ap
)
2827 const CORE_ADDR
*addrp
= ap
;
2832 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2835 core_addr_eq (const void *ap
, const void *bp
)
2837 const CORE_ADDR
*addr_ap
= ap
;
2838 const CORE_ADDR
*addr_bp
= bp
;
2840 return *addr_ap
== *addr_bp
;
2843 /* Convert a string back into a CORE_ADDR. */
2845 string_to_core_addr (const char *my_string
)
2849 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2851 /* Assume that it is in hex. */
2854 for (i
= 2; my_string
[i
] != '\0'; i
++)
2856 if (isdigit (my_string
[i
]))
2857 addr
= (my_string
[i
] - '0') + (addr
* 16);
2858 else if (isxdigit (my_string
[i
]))
2859 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2861 error (_("invalid hex \"%s\""), my_string
);
2866 /* Assume that it is in decimal. */
2869 for (i
= 0; my_string
[i
] != '\0'; i
++)
2871 if (isdigit (my_string
[i
]))
2872 addr
= (my_string
[i
] - '0') + (addr
* 10);
2874 error (_("invalid decimal \"%s\""), my_string
);
2882 gdb_realpath (const char *filename
)
2884 /* Method 1: The system has a compile time upper bound on a filename
2885 path. Use that and realpath() to canonicalize the name. This is
2886 the most common case. Note that, if there isn't a compile time
2887 upper bound, you want to avoid realpath() at all costs. */
2888 #if defined (HAVE_REALPATH) && defined (PATH_MAX)
2891 const char *rp
= realpath (filename
, buf
);
2895 return xstrdup (rp
);
2897 #endif /* HAVE_REALPATH */
2899 /* Method 2: The host system (i.e., GNU) has the function
2900 canonicalize_file_name() which malloc's a chunk of memory and
2901 returns that, use that. */
2902 #if defined(HAVE_CANONICALIZE_FILE_NAME)
2904 char *rp
= canonicalize_file_name (filename
);
2907 return xstrdup (filename
);
2913 /* FIXME: cagney/2002-11-13:
2915 Method 2a: Use realpath() with a NULL buffer. Some systems, due
2916 to the problems described in method 3, have modified their
2917 realpath() implementation so that it will allocate a buffer when
2918 NULL is passed in. Before this can be used, though, some sort of
2919 configure time test would need to be added. Otherwize the code
2920 will likely core dump. */
2922 /* Method 3: Now we're getting desperate! The system doesn't have a
2923 compile time buffer size and no alternative function. Query the
2924 OS, using pathconf(), for the buffer limit. Care is needed
2925 though, some systems do not limit PATH_MAX (return -1 for
2926 pathconf()) making it impossible to pass a correctly sized buffer
2927 to realpath() (it could always overflow). On those systems, we
2929 #if defined (HAVE_REALPATH) && defined (_PC_PATH_MAX) && defined(HAVE_ALLOCA)
2931 /* Find out the max path size. */
2932 long path_max
= pathconf ("/", _PC_PATH_MAX
);
2936 /* PATH_MAX is bounded. */
2937 char *buf
= alloca (path_max
);
2938 char *rp
= realpath (filename
, buf
);
2940 return xstrdup (rp
? rp
: filename
);
2945 /* The MS Windows method. If we don't have realpath, we assume we
2946 don't have symlinks and just canonicalize to a Windows absolute
2947 path. GetFullPath converts ../ and ./ in relative paths to
2948 absolute paths, filling in current drive if one is not given
2949 or using the current directory of a specified drive (eg, "E:foo").
2950 It also converts all forward slashes to back slashes. */
2951 /* The file system is case-insensitive but case-preserving.
2952 So we do not lowercase the path. Otherwise, we might not
2953 be able to display the original casing in a given path. */
2954 #if defined (_WIN32)
2957 DWORD len
= GetFullPathName (filename
, MAX_PATH
, buf
, NULL
);
2959 if (len
> 0 && len
< MAX_PATH
)
2960 return xstrdup (buf
);
2964 /* This system is a lost cause, just dup the buffer. */
2965 return xstrdup (filename
);
2968 /* Return a copy of FILENAME, with its directory prefix canonicalized
2972 gdb_realpath_keepfile (const char *filename
)
2974 const char *base_name
= lbasename (filename
);
2979 /* Extract the basename of filename, and return immediately
2980 a copy of filename if it does not contain any directory prefix. */
2981 if (base_name
== filename
)
2982 return xstrdup (filename
);
2984 dir_name
= alloca ((size_t) (base_name
- filename
+ 2));
2985 /* Allocate enough space to store the dir_name + plus one extra
2986 character sometimes needed under Windows (see below), and
2987 then the closing \000 character. */
2988 strncpy (dir_name
, filename
, base_name
- filename
);
2989 dir_name
[base_name
- filename
] = '\000';
2991 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
2992 /* We need to be careful when filename is of the form 'd:foo', which
2993 is equivalent of d:./foo, which is totally different from d:/foo. */
2994 if (strlen (dir_name
) == 2 && isalpha (dir_name
[0]) && dir_name
[1] == ':')
2997 dir_name
[3] = '\000';
3001 /* Canonicalize the directory prefix, and build the resulting
3002 filename. If the dirname realpath already contains an ending
3003 directory separator, avoid doubling it. */
3004 real_path
= gdb_realpath (dir_name
);
3005 if (IS_DIR_SEPARATOR (real_path
[strlen (real_path
) - 1]))
3006 result
= concat (real_path
, base_name
, (char *) NULL
);
3008 result
= concat (real_path
, SLASH_STRING
, base_name
, (char *) NULL
);
3014 /* Return PATH in absolute form, performing tilde-expansion if necessary.
3015 PATH cannot be NULL or the empty string.
3016 This does not resolve symlinks however, use gdb_realpath for that.
3017 Space for the result is allocated with malloc.
3018 If the path is already absolute, it is strdup'd.
3019 If there is a problem computing the absolute path, the path is returned
3020 unchanged (still strdup'd). */
3023 gdb_abspath (const char *path
)
3025 gdb_assert (path
!= NULL
&& path
[0] != '\0');
3028 return tilde_expand (path
);
3030 if (IS_ABSOLUTE_PATH (path
))
3031 return xstrdup (path
);
3033 /* Beware the // my son, the Emacs barfs, the botch that catch... */
3034 return concat (current_directory
,
3035 IS_DIR_SEPARATOR (current_directory
[strlen (current_directory
) - 1])
3036 ? "" : SLASH_STRING
,
3037 path
, (char *) NULL
);
3041 align_up (ULONGEST v
, int n
)
3043 /* Check that N is really a power of two. */
3044 gdb_assert (n
&& (n
& (n
-1)) == 0);
3045 return (v
+ n
- 1) & -n
;
3049 align_down (ULONGEST v
, int n
)
3051 /* Check that N is really a power of two. */
3052 gdb_assert (n
&& (n
& (n
-1)) == 0);
3059 gdb_sign_extend (LONGEST value
, int bit
)
3061 gdb_assert (bit
>= 1 && bit
<= 8 * sizeof (LONGEST
));
3063 if (((value
>> (bit
- 1)) & 1) != 0)
3065 LONGEST signbit
= ((LONGEST
) 1) << (bit
- 1);
3067 value
= (value
^ signbit
) - signbit
;
3073 /* Allocation function for the libiberty hash table which uses an
3074 obstack. The obstack is passed as DATA. */
3077 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
3079 size_t total
= size
* count
;
3080 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
3082 memset (ptr
, 0, total
);
3086 /* Trivial deallocation function for the libiberty splay tree and hash
3087 table - don't deallocate anything. Rely on later deletion of the
3088 obstack. DATA will be the obstack, although it is not needed
3092 dummy_obstack_deallocate (void *object
, void *data
)
3097 /* The bit offset of the highest byte in a ULONGEST, for overflow
3100 #define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT)
3102 /* True (non-zero) iff DIGIT is a valid digit in radix BASE,
3103 where 2 <= BASE <= 36. */
3106 is_digit_in_base (unsigned char digit
, int base
)
3108 if (!isalnum (digit
))
3111 return (isdigit (digit
) && digit
< base
+ '0');
3113 return (isdigit (digit
) || tolower (digit
) < base
- 10 + 'a');
3117 digit_to_int (unsigned char c
)
3122 return tolower (c
) - 'a' + 10;
3125 /* As for strtoul, but for ULONGEST results. */
3128 strtoulst (const char *num
, const char **trailer
, int base
)
3130 unsigned int high_part
;
3135 /* Skip leading whitespace. */
3136 while (isspace (num
[i
]))
3139 /* Handle prefixes. */
3142 else if (num
[i
] == '-')
3148 if (base
== 0 || base
== 16)
3150 if (num
[i
] == '0' && (num
[i
+ 1] == 'x' || num
[i
+ 1] == 'X'))
3158 if (base
== 0 && num
[i
] == '0')
3164 if (base
< 2 || base
> 36)
3170 result
= high_part
= 0;
3171 for (; is_digit_in_base (num
[i
], base
); i
+= 1)
3173 result
= result
* base
+ digit_to_int (num
[i
]);
3174 high_part
= high_part
* base
+ (unsigned int) (result
>> HIGH_BYTE_POSN
);
3175 result
&= ((ULONGEST
) 1 << HIGH_BYTE_POSN
) - 1;
3176 if (high_part
> 0xff)
3179 result
= ~ (ULONGEST
) 0;
3186 if (trailer
!= NULL
)
3189 result
= result
+ ((ULONGEST
) high_part
<< HIGH_BYTE_POSN
);
3196 /* Simple, portable version of dirname that does not modify its
3200 ldirname (const char *filename
)
3202 const char *base
= lbasename (filename
);
3205 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
3208 if (base
== filename
)
3211 dirname
= xmalloc (base
- filename
+ 2);
3212 memcpy (dirname
, filename
, base
- filename
);
3214 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3215 create "d:./bar" later instead of the (different) "d:/bar". */
3216 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3217 && !IS_DIR_SEPARATOR (filename
[0]))
3218 dirname
[base
++ - filename
] = '.';
3220 dirname
[base
- filename
] = '\0';
3224 /* Call libiberty's buildargv, and return the result.
3225 If buildargv fails due to out-of-memory, call nomem.
3226 Therefore, the returned value is guaranteed to be non-NULL,
3227 unless the parameter itself is NULL. */
3230 gdb_buildargv (const char *s
)
3232 char **argv
= buildargv (s
);
3234 if (s
!= NULL
&& argv
== NULL
)
3240 compare_positive_ints (const void *ap
, const void *bp
)
3242 /* Because we know we're comparing two ints which are positive,
3243 there's no danger of overflow here. */
3244 return * (int *) ap
- * (int *) bp
;
3247 /* String compare function for qsort. */
3250 compare_strings (const void *arg1
, const void *arg2
)
3252 const char **s1
= (const char **) arg1
;
3253 const char **s2
= (const char **) arg2
;
3255 return strcmp (*s1
, *s2
);
3258 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3259 #define AMBIGUOUS_MESS2 \
3260 ".\nUse \"set gnutarget format-name\" to specify the format."
3263 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3269 /* Check if errmsg just need simple return. */
3270 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3271 return bfd_errmsg (error_tag
);
3273 ret_len
= strlen (bfd_errmsg (error_tag
)) + strlen (AMBIGUOUS_MESS1
)
3274 + strlen (AMBIGUOUS_MESS2
);
3275 for (p
= matching
; *p
; p
++)
3276 ret_len
+= strlen (*p
) + 1;
3277 ret
= xmalloc (ret_len
+ 1);
3279 make_cleanup (xfree
, ret
);
3281 strcpy (retp
, bfd_errmsg (error_tag
));
3282 retp
+= strlen (retp
);
3284 strcpy (retp
, AMBIGUOUS_MESS1
);
3285 retp
+= strlen (retp
);
3287 for (p
= matching
; *p
; p
++)
3289 sprintf (retp
, " %s", *p
);
3290 retp
+= strlen (retp
);
3294 strcpy (retp
, AMBIGUOUS_MESS2
);
3299 /* Return ARGS parsed as a valid pid, or throw an error. */
3302 parse_pid_to_attach (const char *args
)
3308 error_no_arg (_("process-id to attach"));
3310 dummy
= (char *) args
;
3311 pid
= strtoul (args
, &dummy
, 0);
3312 /* Some targets don't set errno on errors, grrr! */
3313 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3314 error (_("Illegal process-id: %s."), args
);
3319 /* Helper for make_bpstat_clear_actions_cleanup. */
3322 do_bpstat_clear_actions_cleanup (void *unused
)
3324 bpstat_clear_actions ();
3327 /* Call bpstat_clear_actions for the case an exception is throw. You should
3328 discard_cleanups if no exception is caught. */
3331 make_bpstat_clear_actions_cleanup (void)
3333 return make_cleanup (do_bpstat_clear_actions_cleanup
, NULL
);
3336 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3337 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3338 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3341 producer_is_gcc_ge_4 (const char *producer
)
3346 if (producer
== NULL
)
3348 /* For unknown compilers expect their behavior is not compliant. For GCC
3349 this case can also happen for -gdwarf-4 type units supported since
3355 /* Skip any identifier after "GNU " - such as "C++" or "Java". */
3357 if (strncmp (producer
, "GNU ", strlen ("GNU ")) != 0)
3359 /* For non-GCC compilers expect their behavior is not compliant. */
3363 cs
= &producer
[strlen ("GNU ")];
3364 while (*cs
&& !isdigit (*cs
))
3366 if (sscanf (cs
, "%d.%d", &major
, &minor
) != 2)
3368 /* Not recognized as GCC. */
3380 /* Helper for make_cleanup_free_char_ptr_vec. */
3383 do_free_char_ptr_vec (void *arg
)
3385 VEC (char_ptr
) *char_ptr_vec
= arg
;
3387 free_char_ptr_vec (char_ptr_vec
);
3390 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3391 final VEC_free for CHAR_PTR_VEC itself.
3393 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3394 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3395 this function does not (cannot) clear the pointer. */
3398 make_cleanup_free_char_ptr_vec (VEC (char_ptr
) *char_ptr_vec
)
3400 return make_cleanup (do_free_char_ptr_vec
, char_ptr_vec
);
3403 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3404 must come from xrealloc-compatible allocator and it may be updated. FROM
3405 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3406 located at the start or end of *STRINGP. */
3409 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3411 char *string
= *stringp
, *s
;
3412 const size_t from_len
= strlen (from
);
3413 const size_t to_len
= strlen (to
);
3417 s
= strstr (s
, from
);
3421 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3422 || s
[-1] == DIRNAME_SEPARATOR
)
3423 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3424 || s
[from_len
] == DIRNAME_SEPARATOR
))
3428 string_new
= xrealloc (string
, (strlen (string
) + to_len
+ 1));
3430 /* Relocate the current S pointer. */
3431 s
= s
- string
+ string_new
;
3432 string
= string_new
;
3434 /* Replace from by to. */
3435 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3436 memcpy (s
, to
, to_len
);
3451 /* SIGALRM handler for waitpid_with_timeout. */
3454 sigalrm_handler (int signo
)
3456 /* Nothing to do. */
3461 /* Wrapper to wait for child PID to die with TIMEOUT.
3462 TIMEOUT is the time to stop waiting in seconds.
3463 If TIMEOUT is zero, pass WNOHANG to waitpid.
3464 Returns PID if it was successfully waited for, otherwise -1.
3466 Timeouts are currently implemented with alarm and SIGALRM.
3467 If the host does not support them, this waits "forever".
3468 It would be odd though for a host to have waitpid and not SIGALRM. */
3471 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3473 pid_t waitpid_result
;
3475 gdb_assert (pid
> 0);
3476 gdb_assert (timeout
>= 0);
3481 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3482 struct sigaction sa
, old_sa
;
3484 sa
.sa_handler
= sigalrm_handler
;
3485 sigemptyset (&sa
.sa_mask
);
3487 sigaction (SIGALRM
, &sa
, &old_sa
);
3491 ofunc
= (void (*)()) signal (SIGALRM
, sigalrm_handler
);
3497 waitpid_result
= waitpid (pid
, status
, 0);
3501 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3502 sigaction (SIGALRM
, &old_sa
, NULL
);
3504 signal (SIGALRM
, ofunc
);
3509 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3511 if (waitpid_result
== pid
)
3517 #endif /* HAVE_WAITPID */
3519 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3520 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3522 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3523 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3526 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3528 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3530 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3531 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3533 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3535 char *pattern_slash
, *string_slash
;
3537 /* Replace '\' by '/' in both strings. */
3539 pattern_slash
= alloca (strlen (pattern
) + 1);
3540 strcpy (pattern_slash
, pattern
);
3541 pattern
= pattern_slash
;
3542 for (; *pattern_slash
!= 0; pattern_slash
++)
3543 if (IS_DIR_SEPARATOR (*pattern_slash
))
3544 *pattern_slash
= '/';
3546 string_slash
= alloca (strlen (string
) + 1);
3547 strcpy (string_slash
, string
);
3548 string
= string_slash
;
3549 for (; *string_slash
!= 0; string_slash
++)
3550 if (IS_DIR_SEPARATOR (*string_slash
))
3551 *string_slash
= '/';
3553 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3555 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3556 flags
|= FNM_CASEFOLD
;
3557 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3559 return fnmatch (pattern
, string
, flags
);
3562 /* Provide a prototype to silence -Wmissing-prototypes. */
3563 extern initialize_file_ftype _initialize_utils
;
3566 _initialize_utils (void)
3568 add_internal_problem_command (&internal_error_problem
);
3569 add_internal_problem_command (&internal_warning_problem
);
3570 add_internal_problem_command (&demangler_warning_problem
);