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 if (target_supports_terminal_ours ())
524 target_terminal_ours ();
525 if (filtered_printing_initialized ())
526 wrap_here (""); /* Force out any buffered output. */
527 gdb_flush (gdb_stdout
);
528 if (warning_pre_print
)
529 fputs_unfiltered (warning_pre_print
, gdb_stderr
);
530 vfprintf_unfiltered (gdb_stderr
, string
, args
);
531 fprintf_unfiltered (gdb_stderr
, "\n");
535 /* Print an error message and return to command level.
536 The first argument STRING is the error message, used as a fprintf string,
537 and the remaining args are passed as arguments to it. */
540 verror (const char *string
, va_list args
)
542 throw_verror (GENERIC_ERROR
, string
, args
);
546 error_stream (struct ui_file
*stream
)
548 char *message
= ui_file_xstrdup (stream
, NULL
);
550 make_cleanup (xfree
, message
);
551 error (("%s"), message
);
554 /* Emit a message and abort. */
556 static void ATTRIBUTE_NORETURN
557 abort_with_message (const char *msg
)
559 if (gdb_stderr
== NULL
)
562 fputs_unfiltered (msg
, gdb_stderr
);
564 abort (); /* NOTE: GDB has only three calls to abort(). */
567 /* Dump core trying to increase the core soft limit to hard limit first. */
572 #ifdef HAVE_SETRLIMIT
573 struct rlimit rlim
= { RLIM_INFINITY
, RLIM_INFINITY
};
575 setrlimit (RLIMIT_CORE
, &rlim
);
576 #endif /* HAVE_SETRLIMIT */
578 abort (); /* NOTE: GDB has only three calls to abort(). */
581 /* Check whether GDB will be able to dump core using the dump_core
582 function. Returns zero if GDB cannot or should not dump core.
583 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
584 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
587 can_dump_core (enum resource_limit_kind limit_kind
)
589 #ifdef HAVE_GETRLIMIT
592 /* Be quiet and assume we can dump if an error is returned. */
593 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
599 if (rlim
.rlim_cur
== 0)
603 if (rlim
.rlim_max
== 0)
606 #endif /* HAVE_GETRLIMIT */
611 /* Print a warning that we cannot dump core. */
614 warn_cant_dump_core (const char *reason
)
616 fprintf_unfiltered (gdb_stderr
,
617 _("%s\nUnable to dump core, use `ulimit -c"
618 " unlimited' before executing GDB next time.\n"),
622 /* Check whether GDB will be able to dump core using the dump_core
623 function, and print a warning if we cannot. */
626 can_dump_core_warn (enum resource_limit_kind limit_kind
,
629 int core_dump_allowed
= can_dump_core (limit_kind
);
631 if (!core_dump_allowed
)
632 warn_cant_dump_core (reason
);
634 return core_dump_allowed
;
637 /* Allow the user to configure the debugger behavior with respect to
638 what to do when an internal problem is detected. */
640 const char internal_problem_ask
[] = "ask";
641 const char internal_problem_yes
[] = "yes";
642 const char internal_problem_no
[] = "no";
643 static const char *const internal_problem_modes
[] =
645 internal_problem_ask
,
646 internal_problem_yes
,
651 /* Print a message reporting an internal error/warning. Ask the user
652 if they want to continue, dump core, or just exit. Return
653 something to indicate a quit. */
655 struct internal_problem
658 int user_settable_should_quit
;
659 const char *should_quit
;
660 int user_settable_should_dump_core
;
661 const char *should_dump_core
;
664 /* Report a problem, internal to GDB, to the user. Once the problem
665 has been reported, and assuming GDB didn't quit, the caller can
666 either allow execution to resume or throw an error. */
668 static void ATTRIBUTE_PRINTF (4, 0)
669 internal_vproblem (struct internal_problem
*problem
,
670 const char *file
, int line
, const char *fmt
, va_list ap
)
676 struct cleanup
*cleanup
= make_cleanup (null_cleanup
, NULL
);
678 /* Don't allow infinite error/warning recursion. */
680 static char msg
[] = "Recursive internal problem.\n";
689 abort_with_message (msg
);
692 /* Newer GLIBC versions put the warn_unused_result attribute
693 on write, but this is one of those rare cases where
694 ignoring the return value is correct. Casting to (void)
695 does not fix this problem. This is the solution suggested
696 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
697 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
698 abort (); /* NOTE: GDB has only three calls to abort(). */
703 /* Create a string containing the full error/warning message. Need
704 to call query with this full string, as otherwize the reason
705 (error/warning) and question become separated. Format using a
706 style similar to a compiler error message. Include extra detail
707 so that the user knows that they are living on the edge. */
711 msg
= xstrvprintf (fmt
, ap
);
712 reason
= xstrprintf ("%s:%d: %s: %s\n"
713 "A problem internal to GDB has been detected,\n"
714 "further debugging may prove unreliable.",
715 file
, line
, problem
->name
, msg
);
717 make_cleanup (xfree
, reason
);
720 /* Fall back to abort_with_message if gdb_stderr is not set up. */
721 if (gdb_stderr
== NULL
)
723 fputs (reason
, stderr
);
724 abort_with_message ("\n");
727 /* Try to get the message out and at the start of a new line. */
728 if (target_supports_terminal_ours ())
729 target_terminal_ours ();
730 if (filtered_printing_initialized ())
733 /* Emit the message unless query will emit it below. */
734 if (problem
->should_quit
!= internal_problem_ask
736 || !filtered_printing_initialized ())
737 fprintf_unfiltered (gdb_stderr
, "%s\n", reason
);
739 if (problem
->should_quit
== internal_problem_ask
)
741 /* Default (yes/batch case) is to quit GDB. When in batch mode
742 this lessens the likelihood of GDB going into an infinite
744 if (!confirm
|| !filtered_printing_initialized ())
747 quit_p
= query (_("%s\nQuit this debugging session? "), reason
);
749 else if (problem
->should_quit
== internal_problem_yes
)
751 else if (problem
->should_quit
== internal_problem_no
)
754 internal_error (__FILE__
, __LINE__
, _("bad switch"));
756 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr
);
757 if (REPORT_BUGS_TO
[0])
758 fprintf_unfiltered (gdb_stderr
, _(" For instructions, see:\n%s."),
760 fputs_unfiltered ("\n\n", gdb_stderr
);
762 if (problem
->should_dump_core
== internal_problem_ask
)
764 if (!can_dump_core_warn (LIMIT_MAX
, reason
))
766 else if (!filtered_printing_initialized ())
770 /* Default (yes/batch case) is to dump core. This leaves a GDB
771 `dropping' so that it is easier to see that something went
773 dump_core_p
= query (_("%s\nCreate a core file of GDB? "), reason
);
776 else if (problem
->should_dump_core
== internal_problem_yes
)
777 dump_core_p
= can_dump_core_warn (LIMIT_MAX
, reason
);
778 else if (problem
->should_dump_core
== internal_problem_no
)
781 internal_error (__FILE__
, __LINE__
, _("bad switch"));
794 #ifdef HAVE_WORKING_FORK
802 do_cleanups (cleanup
);
805 static struct internal_problem internal_error_problem
= {
806 "internal-error", 1, internal_problem_ask
, 1, internal_problem_ask
810 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
812 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
813 throw_quit (_("Command aborted."));
816 static struct internal_problem internal_warning_problem
= {
817 "internal-warning", 1, internal_problem_ask
, 1, internal_problem_ask
821 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
823 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
827 internal_warning (const char *file
, int line
, const char *string
, ...)
831 va_start (ap
, string
);
832 internal_vwarning (file
, line
, string
, ap
);
836 static struct internal_problem demangler_warning_problem
= {
837 "demangler-warning", 1, internal_problem_ask
, 0, internal_problem_no
841 demangler_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
843 internal_vproblem (&demangler_warning_problem
, file
, line
, fmt
, ap
);
847 demangler_warning (const char *file
, int line
, const char *string
, ...)
851 va_start (ap
, string
);
852 demangler_vwarning (file
, line
, string
, ap
);
856 /* Dummy functions to keep add_prefix_cmd happy. */
859 set_internal_problem_cmd (char *args
, int from_tty
)
864 show_internal_problem_cmd (char *args
, int from_tty
)
868 /* When GDB reports an internal problem (error or warning) it gives
869 the user the opportunity to quit GDB and/or create a core file of
870 the current debug session. This function registers a few commands
871 that make it possible to specify that GDB should always or never
872 quit or create a core file, without asking. The commands look
875 maint set PROBLEM-NAME quit ask|yes|no
876 maint show PROBLEM-NAME quit
877 maint set PROBLEM-NAME corefile ask|yes|no
878 maint show PROBLEM-NAME corefile
880 Where PROBLEM-NAME is currently "internal-error" or
881 "internal-warning". */
884 add_internal_problem_command (struct internal_problem
*problem
)
886 struct cmd_list_element
**set_cmd_list
;
887 struct cmd_list_element
**show_cmd_list
;
891 set_cmd_list
= xmalloc (sizeof (*set_cmd_list
));
892 show_cmd_list
= xmalloc (sizeof (*set_cmd_list
));
893 *set_cmd_list
= NULL
;
894 *show_cmd_list
= NULL
;
896 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
899 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
902 add_prefix_cmd ((char*) problem
->name
,
903 class_maintenance
, set_internal_problem_cmd
, set_doc
,
905 concat ("maintenance set ", problem
->name
, " ",
907 0/*allow-unknown*/, &maintenance_set_cmdlist
);
909 add_prefix_cmd ((char*) problem
->name
,
910 class_maintenance
, show_internal_problem_cmd
, show_doc
,
912 concat ("maintenance show ", problem
->name
, " ",
914 0/*allow-unknown*/, &maintenance_show_cmdlist
);
916 if (problem
->user_settable_should_quit
)
918 set_doc
= xstrprintf (_("Set whether GDB should quit "
919 "when an %s is detected"),
921 show_doc
= xstrprintf (_("Show whether GDB will quit "
922 "when an %s is detected"),
924 add_setshow_enum_cmd ("quit", class_maintenance
,
925 internal_problem_modes
,
926 &problem
->should_quit
,
939 if (problem
->user_settable_should_dump_core
)
941 set_doc
= xstrprintf (_("Set whether GDB should create a core "
942 "file of GDB when %s is detected"),
944 show_doc
= xstrprintf (_("Show whether GDB will create a core "
945 "file of GDB when %s is detected"),
947 add_setshow_enum_cmd ("corefile", class_maintenance
,
948 internal_problem_modes
,
949 &problem
->should_dump_core
,
963 /* Return a newly allocated string, containing the PREFIX followed
964 by the system error message for errno (separated by a colon).
966 The result must be deallocated after use. */
969 perror_string (const char *prefix
)
974 err
= safe_strerror (errno
);
975 combined
= (char *) xmalloc (strlen (err
) + strlen (prefix
) + 3);
976 strcpy (combined
, prefix
);
977 strcat (combined
, ": ");
978 strcat (combined
, err
);
983 /* Print the system error message for errno, and also mention STRING
984 as the file name for which the error was encountered. Use ERRCODE
985 for the thrown exception. Then return to command level. */
988 throw_perror_with_name (enum errors errcode
, const char *string
)
992 combined
= perror_string (string
);
993 make_cleanup (xfree
, combined
);
995 /* I understand setting these is a matter of taste. Still, some people
996 may clear errno but not know about bfd_error. Doing this here is not
998 bfd_set_error (bfd_error_no_error
);
1001 throw_error (errcode
, _("%s."), combined
);
1004 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
1007 perror_with_name (const char *string
)
1009 throw_perror_with_name (GENERIC_ERROR
, string
);
1012 /* Same as perror_with_name except that it prints a warning instead
1013 of throwing an error. */
1016 perror_warning_with_name (const char *string
)
1020 combined
= perror_string (string
);
1021 warning (_("%s"), combined
);
1025 /* Print the system error message for ERRCODE, and also mention STRING
1026 as the file name for which the error was encountered. */
1029 print_sys_errmsg (const char *string
, int errcode
)
1034 err
= safe_strerror (errcode
);
1035 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
1036 strcpy (combined
, string
);
1037 strcat (combined
, ": ");
1038 strcat (combined
, err
);
1040 /* We want anything which was printed on stdout to come out first, before
1042 gdb_flush (gdb_stdout
);
1043 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
1046 /* Control C eventually causes this to be called, at a convenient time. */
1051 if (sync_quit_force_run
)
1053 sync_quit_force_run
= 0;
1054 quit_force (NULL
, stdin
== instream
);
1058 /* No steenking SIGINT will ever be coming our way when the
1059 program is resumed. Don't lie. */
1060 throw_quit ("Quit");
1063 /* If there is no terminal switching for this target, then we can't
1064 possibly get screwed by the lack of job control. */
1065 || !target_supports_terminal_ours ())
1066 throw_quit ("Quit");
1068 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
1073 /* Called when a memory allocation fails, with the number of bytes of
1074 memory requested in SIZE. */
1077 malloc_failure (long size
)
1081 internal_error (__FILE__
, __LINE__
,
1082 _("virtual memory exhausted: can't allocate %ld bytes."),
1087 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
1091 /* My replacement for the read system call.
1092 Used like `read' but keeps going if `read' returns too soon. */
1095 myread (int desc
, char *addr
, int len
)
1102 val
= read (desc
, addr
, len
);
1106 return orglen
- len
;
1114 print_spaces (int n
, struct ui_file
*file
)
1116 fputs_unfiltered (n_spaces (n
), file
);
1119 /* Print a host address. */
1122 gdb_print_host_address (const void *addr
, struct ui_file
*stream
)
1124 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
1128 /* A cleanup function that calls regfree. */
1131 do_regfree_cleanup (void *r
)
1136 /* Create a new cleanup that frees the compiled regular expression R. */
1139 make_regfree_cleanup (regex_t
*r
)
1141 return make_cleanup (do_regfree_cleanup
, r
);
1144 /* Return an xmalloc'd error message resulting from a regular
1145 expression compilation failure. */
1148 get_regcomp_error (int code
, regex_t
*rx
)
1150 size_t length
= regerror (code
, rx
, NULL
, 0);
1151 char *result
= xmalloc (length
);
1153 regerror (code
, rx
, result
, length
);
1157 /* Compile a regexp and throw an exception on error. This returns a
1158 cleanup to free the resulting pattern on success. RX must not be
1162 compile_rx_or_error (regex_t
*pattern
, const char *rx
, const char *message
)
1166 gdb_assert (rx
!= NULL
);
1168 code
= regcomp (pattern
, rx
, REG_NOSUB
);
1171 char *err
= get_regcomp_error (code
, pattern
);
1173 make_cleanup (xfree
, err
);
1174 error (("%s: %s"), message
, err
);
1177 return make_regfree_cleanup (pattern
);
1182 /* This function supports the query, nquery, and yquery functions.
1183 Ask user a y-or-n question and return 0 if answer is no, 1 if
1184 answer is yes, or default the answer to the specified default
1185 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1186 default answer, or '\0' for no default.
1187 CTLSTR is the control string and should end in "? ". It should
1188 not say how to answer, because we do that.
1189 ARGS are the arguments passed along with the CTLSTR argument to
1192 static int ATTRIBUTE_PRINTF (1, 0)
1193 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
1199 char def_answer
, not_def_answer
;
1200 char *y_string
, *n_string
, *question
;
1201 /* Used to add duration we waited for user to respond to
1202 prompt_for_continue_wait_time. */
1203 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1205 /* Set up according to which answer is the default. */
1206 if (defchar
== '\0')
1210 not_def_answer
= 'N';
1214 else if (defchar
== 'y')
1218 not_def_answer
= 'N';
1226 not_def_answer
= 'Y';
1231 /* Automatically answer the default value if the user did not want
1232 prompts or the command was issued with the server prefix. */
1233 if (!confirm
|| server_command
)
1236 /* If input isn't coming from the user directly, just say what
1237 question we're asking, and then answer the default automatically. This
1238 way, important error messages don't get lost when talking to GDB
1240 if (! input_from_terminal_p ())
1243 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
1245 printf_filtered (_("(%s or %s) [answered %c; "
1246 "input not from terminal]\n"),
1247 y_string
, n_string
, def_answer
);
1248 gdb_flush (gdb_stdout
);
1253 if (deprecated_query_hook
)
1255 return deprecated_query_hook (ctlstr
, args
);
1258 /* Format the question outside of the loop, to avoid reusing args. */
1259 question
= xstrvprintf (ctlstr
, args
);
1261 /* Used for calculating time spend waiting for user. */
1262 gettimeofday (&prompt_started
, NULL
);
1266 wrap_here (""); /* Flush any buffered output. */
1267 gdb_flush (gdb_stdout
);
1269 if (annotation_level
> 1)
1270 printf_filtered (("\n\032\032pre-query\n"));
1272 fputs_filtered (question
, gdb_stdout
);
1273 printf_filtered (_("(%s or %s) "), y_string
, n_string
);
1275 if (annotation_level
> 1)
1276 printf_filtered (("\n\032\032query\n"));
1279 gdb_flush (gdb_stdout
);
1281 answer
= fgetc (stdin
);
1283 /* We expect fgetc to block until a character is read. But
1284 this may not be the case if the terminal was opened with
1285 the NONBLOCK flag. In that case, if there is nothing to
1286 read on stdin, fgetc returns EOF, but also sets the error
1287 condition flag on stdin and errno to EAGAIN. With a true
1288 EOF, stdin's error condition flag is not set.
1290 A situation where this behavior was observed is a pseudo
1292 while (answer
== EOF
&& ferror (stdin
) && errno
== EAGAIN
)
1294 /* Not a real EOF. Wait a little while and try again until
1295 we read something. */
1298 answer
= fgetc (stdin
);
1301 clearerr (stdin
); /* in case of C-d */
1302 if (answer
== EOF
) /* C-d */
1304 printf_filtered ("EOF [assumed %c]\n", def_answer
);
1308 /* Eat rest of input line, to EOF or newline. */
1312 ans2
= fgetc (stdin
);
1315 while (ans2
!= EOF
&& ans2
!= '\n' && ans2
!= '\r');
1319 /* Check answer. For the non-default, the user must specify
1320 the non-default explicitly. */
1321 if (answer
== not_def_answer
)
1323 retval
= !def_value
;
1326 /* Otherwise, if a default was specified, the user may either
1327 specify the required input or have it default by entering
1329 if (answer
== def_answer
1330 || (defchar
!= '\0' &&
1331 (answer
== '\n' || answer
== '\r' || answer
== EOF
)))
1336 /* Invalid entries are not defaulted and require another selection. */
1337 printf_filtered (_("Please answer %s or %s.\n"),
1338 y_string
, n_string
);
1341 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1342 gettimeofday (&prompt_ended
, NULL
);
1343 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1344 timeval_add (&prompt_for_continue_wait_time
,
1345 &prompt_for_continue_wait_time
, &prompt_delta
);
1348 if (annotation_level
> 1)
1349 printf_filtered (("\n\032\032post-query\n"));
1354 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1355 answer is yes, or 0 if answer is defaulted.
1356 Takes three args which are given to printf to print the question.
1357 The first, a control string, should end in "? ".
1358 It should not say how to answer, because we do that. */
1361 nquery (const char *ctlstr
, ...)
1366 va_start (args
, ctlstr
);
1367 ret
= defaulted_query (ctlstr
, 'n', args
);
1372 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1373 answer is yes, or 1 if answer is defaulted.
1374 Takes three args which are given to printf to print the question.
1375 The first, a control string, should end in "? ".
1376 It should not say how to answer, because we do that. */
1379 yquery (const char *ctlstr
, ...)
1384 va_start (args
, ctlstr
);
1385 ret
= defaulted_query (ctlstr
, 'y', args
);
1390 /* Ask user a y-or-n question and return 1 iff answer is yes.
1391 Takes three args which are given to printf to print the question.
1392 The first, a control string, should end in "? ".
1393 It should not say how to answer, because we do that. */
1396 query (const char *ctlstr
, ...)
1401 va_start (args
, ctlstr
);
1402 ret
= defaulted_query (ctlstr
, '\0', args
);
1407 /* A helper for parse_escape that converts a host character to a
1408 target character. C is the host character. If conversion is
1409 possible, then the target character is stored in *TARGET_C and the
1410 function returns 1. Otherwise, the function returns 0. */
1413 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1415 struct obstack host_data
;
1417 struct cleanup
*cleanups
;
1420 obstack_init (&host_data
);
1421 cleanups
= make_cleanup_obstack_free (&host_data
);
1423 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1424 (gdb_byte
*) &the_char
, 1, 1,
1425 &host_data
, translit_none
);
1427 if (obstack_object_size (&host_data
) == 1)
1430 *target_c
= *(char *) obstack_base (&host_data
);
1433 do_cleanups (cleanups
);
1437 /* Parse a C escape sequence. STRING_PTR points to a variable
1438 containing a pointer to the string to parse. That pointer
1439 should point to the character after the \. That pointer
1440 is updated past the characters we use. The value of the
1441 escape sequence is returned.
1443 A negative value means the sequence \ newline was seen,
1444 which is supposed to be equivalent to nothing at all.
1446 If \ is followed by a null character, we return a negative
1447 value and leave the string pointer pointing at the null character.
1449 If \ is followed by 000, we return 0 and leave the string pointer
1450 after the zeros. A value of 0 does not mean end of string. */
1453 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1455 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1456 int c
= *(*string_ptr
)++;
1475 int i
= host_hex_value (c
);
1480 if (isdigit (c
) && c
!= '8' && c
!= '9')
1484 i
+= host_hex_value (c
);
1520 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1521 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1522 " which has no equivalent\nin the `%s' character set."),
1523 c
, c
, target_charset (gdbarch
));
1527 /* Print the character C on STREAM as part of the contents of a literal
1528 string whose delimiter is QUOTER. Note that this routine should only
1529 be call for printing things which are independent of the language
1530 of the program being debugged.
1532 printchar will normally escape backslashes and instances of QUOTER. If
1533 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1534 As a side effect, if you pass the backslash character as the QUOTER,
1535 printchar will escape backslashes as usual, but not any other quoting
1539 printchar (int c
, void (*do_fputs
) (const char *, struct ui_file
*),
1540 void (*do_fprintf
) (struct ui_file
*, const char *, ...)
1541 ATTRIBUTE_FPTR_PRINTF_2
, struct ui_file
*stream
, int quoter
)
1543 c
&= 0xFF; /* Avoid sign bit follies */
1545 if (c
< 0x20 || /* Low control chars */
1546 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1547 (sevenbit_strings
&& c
>= 0x80))
1548 { /* high order bit set */
1552 do_fputs ("\\n", stream
);
1555 do_fputs ("\\b", stream
);
1558 do_fputs ("\\t", stream
);
1561 do_fputs ("\\f", stream
);
1564 do_fputs ("\\r", stream
);
1567 do_fputs ("\\e", stream
);
1570 do_fputs ("\\a", stream
);
1573 do_fprintf (stream
, "\\%.3o", (unsigned int) c
);
1579 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1580 do_fputs ("\\", stream
);
1581 do_fprintf (stream
, "%c", c
);
1585 /* Print the character C on STREAM as part of the contents of a
1586 literal string whose delimiter is QUOTER. Note that these routines
1587 should only be call for printing things which are independent of
1588 the language of the program being debugged. */
1591 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1594 printchar (*str
++, fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1598 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1601 printchar (*str
++, fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1605 fputstrn_filtered (const char *str
, int n
, int quoter
,
1606 struct ui_file
*stream
)
1610 for (i
= 0; i
< n
; i
++)
1611 printchar (str
[i
], fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1615 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1616 struct ui_file
*stream
)
1620 for (i
= 0; i
< n
; i
++)
1621 printchar (str
[i
], fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1625 /* Number of lines per page or UINT_MAX if paging is disabled. */
1626 static unsigned int lines_per_page
;
1628 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1629 struct cmd_list_element
*c
, const char *value
)
1631 fprintf_filtered (file
,
1632 _("Number of lines gdb thinks are in a page is %s.\n"),
1636 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1637 static unsigned int chars_per_line
;
1639 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1640 struct cmd_list_element
*c
, const char *value
)
1642 fprintf_filtered (file
,
1643 _("Number of characters gdb thinks "
1644 "are in a line is %s.\n"),
1648 /* Current count of lines printed on this page, chars on this line. */
1649 static unsigned int lines_printed
, chars_printed
;
1651 /* Buffer and start column of buffered text, for doing smarter word-
1652 wrapping. When someone calls wrap_here(), we start buffering output
1653 that comes through fputs_filtered(). If we see a newline, we just
1654 spit it out and forget about the wrap_here(). If we see another
1655 wrap_here(), we spit it out and remember the newer one. If we see
1656 the end of the line, we spit out a newline, the indent, and then
1657 the buffered output. */
1659 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1660 are waiting to be output (they have already been counted in chars_printed).
1661 When wrap_buffer[0] is null, the buffer is empty. */
1662 static char *wrap_buffer
;
1664 /* Pointer in wrap_buffer to the next character to fill. */
1665 static char *wrap_pointer
;
1667 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1669 static char *wrap_indent
;
1671 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1672 is not in effect. */
1673 static int wrap_column
;
1676 /* Inialize the number of lines per page and chars per line. */
1679 init_page_info (void)
1683 lines_per_page
= UINT_MAX
;
1684 chars_per_line
= UINT_MAX
;
1688 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1693 #if defined(__GO32__)
1694 rows
= ScreenRows ();
1695 cols
= ScreenCols ();
1696 lines_per_page
= rows
;
1697 chars_per_line
= cols
;
1699 /* Make sure Readline has initialized its terminal settings. */
1700 rl_reset_terminal (NULL
);
1702 /* Get the screen size from Readline. */
1703 rl_get_screen_size (&rows
, &cols
);
1704 lines_per_page
= rows
;
1705 chars_per_line
= cols
;
1707 /* Readline should have fetched the termcap entry for us.
1708 Only try to use tgetnum function if rl_get_screen_size
1709 did not return a useful value. */
1710 if (((rows
<= 0) && (tgetnum ("li") < 0))
1711 /* Also disable paging if inside EMACS. */
1712 || getenv ("EMACS"))
1714 /* The number of lines per page is not mentioned in the terminal
1715 description or EMACS evironment variable is set. This probably
1716 means that paging is not useful, so disable paging. */
1717 lines_per_page
= UINT_MAX
;
1720 /* If the output is not a terminal, don't paginate it. */
1721 if (!ui_file_isatty (gdb_stdout
))
1722 lines_per_page
= UINT_MAX
;
1730 /* Return nonzero if filtered printing is initialized. */
1732 filtered_printing_initialized (void)
1734 return wrap_buffer
!= NULL
;
1737 /* Helper for make_cleanup_restore_page_info. */
1740 do_restore_page_info_cleanup (void *arg
)
1746 /* Provide cleanup for restoring the terminal size. */
1749 make_cleanup_restore_page_info (void)
1751 struct cleanup
*back_to
;
1753 back_to
= make_cleanup (do_restore_page_info_cleanup
, NULL
);
1754 make_cleanup_restore_uinteger (&lines_per_page
);
1755 make_cleanup_restore_uinteger (&chars_per_line
);
1760 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1761 Provide cleanup for restoring the original state. */
1764 set_batch_flag_and_make_cleanup_restore_page_info (void)
1766 struct cleanup
*back_to
= make_cleanup_restore_page_info ();
1768 make_cleanup_restore_integer (&batch_flag
);
1775 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1778 set_screen_size (void)
1780 int rows
= lines_per_page
;
1781 int cols
= chars_per_line
;
1789 /* Update Readline's idea of the terminal size. */
1790 rl_set_screen_size (rows
, cols
);
1793 /* Reinitialize WRAP_BUFFER according to the current value of
1799 if (chars_per_line
== 0)
1804 wrap_buffer
= (char *) xmalloc (chars_per_line
+ 2);
1805 wrap_buffer
[0] = '\0';
1808 wrap_buffer
= (char *) xrealloc (wrap_buffer
, chars_per_line
+ 2);
1809 wrap_pointer
= wrap_buffer
; /* Start it at the beginning. */
1813 set_width_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1820 set_height_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1825 /* Wait, so the user can read what's on the screen. Prompt the user
1826 to continue by pressing RETURN. */
1829 prompt_for_continue (void)
1832 char cont_prompt
[120];
1833 /* Used to add duration we waited for user to respond to
1834 prompt_for_continue_wait_time. */
1835 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1837 gettimeofday (&prompt_started
, NULL
);
1839 if (annotation_level
> 1)
1840 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1842 strcpy (cont_prompt
,
1843 "---Type <return> to continue, or q <return> to quit---");
1844 if (annotation_level
> 1)
1845 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1847 /* We must do this *before* we call gdb_readline, else it will eventually
1848 call us -- thinking that we're trying to print beyond the end of the
1850 reinitialize_more_filter ();
1855 /* We'll need to handle input. */
1856 target_terminal_ours ();
1858 /* On a real operating system, the user can quit with SIGINT.
1861 'q' is provided on all systems so users don't have to change habits
1862 from system to system, and because telling them what to do in
1863 the prompt is more user-friendly than expecting them to think of
1865 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1866 whereas control-C to gdb_readline will cause the user to get dumped
1868 ignore
= gdb_readline_wrapper (cont_prompt
);
1870 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1871 gettimeofday (&prompt_ended
, NULL
);
1872 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1873 timeval_add (&prompt_for_continue_wait_time
,
1874 &prompt_for_continue_wait_time
, &prompt_delta
);
1876 if (annotation_level
> 1)
1877 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1883 while (*p
== ' ' || *p
== '\t')
1891 /* Now we have to do this again, so that GDB will know that it doesn't
1892 need to save the ---Type <return>--- line at the top of the screen. */
1893 reinitialize_more_filter ();
1895 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1898 /* Initalize timer to keep track of how long we waited for the user. */
1901 reset_prompt_for_continue_wait_time (void)
1903 static const struct timeval zero_timeval
= { 0 };
1905 prompt_for_continue_wait_time
= zero_timeval
;
1908 /* Fetch the cumulative time spent in prompt_for_continue. */
1911 get_prompt_for_continue_wait_time (void)
1913 return prompt_for_continue_wait_time
;
1916 /* Reinitialize filter; ie. tell it to reset to original values. */
1919 reinitialize_more_filter (void)
1925 /* Indicate that if the next sequence of characters overflows the line,
1926 a newline should be inserted here rather than when it hits the end.
1927 If INDENT is non-null, it is a string to be printed to indent the
1928 wrapped part on the next line. INDENT must remain accessible until
1929 the next call to wrap_here() or until a newline is printed through
1932 If the line is already overfull, we immediately print a newline and
1933 the indentation, and disable further wrapping.
1935 If we don't know the width of lines, but we know the page height,
1936 we must not wrap words, but should still keep track of newlines
1937 that were explicitly printed.
1939 INDENT should not contain tabs, as that will mess up the char count
1940 on the next line. FIXME.
1942 This routine is guaranteed to force out any output which has been
1943 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1944 used to force out output from the wrap_buffer. */
1947 wrap_here (char *indent
)
1949 /* This should have been allocated, but be paranoid anyway. */
1951 internal_error (__FILE__
, __LINE__
,
1952 _("failed internal consistency check"));
1956 *wrap_pointer
= '\0';
1957 fputs_unfiltered (wrap_buffer
, gdb_stdout
);
1959 wrap_pointer
= wrap_buffer
;
1960 wrap_buffer
[0] = '\0';
1961 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1965 else if (chars_printed
>= chars_per_line
)
1967 puts_filtered ("\n");
1969 puts_filtered (indent
);
1974 wrap_column
= chars_printed
;
1978 wrap_indent
= indent
;
1982 /* Print input string to gdb_stdout, filtered, with wrap,
1983 arranging strings in columns of n chars. String can be
1984 right or left justified in the column. Never prints
1985 trailing spaces. String should never be longer than
1986 width. FIXME: this could be useful for the EXAMINE
1987 command, which currently doesn't tabulate very well. */
1990 puts_filtered_tabular (char *string
, int width
, int right
)
1996 gdb_assert (chars_per_line
> 0);
1997 if (chars_per_line
== UINT_MAX
)
1999 fputs_filtered (string
, gdb_stdout
);
2000 fputs_filtered ("\n", gdb_stdout
);
2004 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
2005 fputs_filtered ("\n", gdb_stdout
);
2007 if (width
>= chars_per_line
)
2008 width
= chars_per_line
- 1;
2010 stringlen
= strlen (string
);
2012 if (chars_printed
> 0)
2013 spaces
= width
- (chars_printed
- 1) % width
- 1;
2015 spaces
+= width
- stringlen
;
2017 spacebuf
= alloca (spaces
+ 1);
2018 spacebuf
[spaces
] = '\0';
2020 spacebuf
[spaces
] = ' ';
2022 fputs_filtered (spacebuf
, gdb_stdout
);
2023 fputs_filtered (string
, gdb_stdout
);
2027 /* Ensure that whatever gets printed next, using the filtered output
2028 commands, starts at the beginning of the line. I.e. if there is
2029 any pending output for the current line, flush it and start a new
2030 line. Otherwise do nothing. */
2035 if (chars_printed
> 0)
2037 puts_filtered ("\n");
2042 /* Like fputs but if FILTER is true, pause after every screenful.
2044 Regardless of FILTER can wrap at points other than the final
2045 character of a line.
2047 Unlike fputs, fputs_maybe_filtered does not return a value.
2048 It is OK for LINEBUFFER to be NULL, in which case just don't print
2051 Note that a longjmp to top level may occur in this routine (only if
2052 FILTER is true) (since prompt_for_continue may do so) so this
2053 routine should not be called when cleanups are not in place. */
2056 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
2059 const char *lineptr
;
2061 if (linebuffer
== 0)
2064 /* Don't do any filtering if it is disabled. */
2065 if (stream
!= gdb_stdout
2066 || !pagination_enabled
2068 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
2069 || top_level_interpreter () == NULL
2070 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2072 fputs_unfiltered (linebuffer
, stream
);
2076 /* Go through and output each character. Show line extension
2077 when this is necessary; prompt user for new page when this is
2080 lineptr
= linebuffer
;
2083 /* Possible new page. */
2084 if (filter
&& (lines_printed
>= lines_per_page
- 1))
2085 prompt_for_continue ();
2087 while (*lineptr
&& *lineptr
!= '\n')
2089 /* Print a single line. */
2090 if (*lineptr
== '\t')
2093 *wrap_pointer
++ = '\t';
2095 fputc_unfiltered ('\t', stream
);
2096 /* Shifting right by 3 produces the number of tab stops
2097 we have already passed, and then adding one and
2098 shifting left 3 advances to the next tab stop. */
2099 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
2105 *wrap_pointer
++ = *lineptr
;
2107 fputc_unfiltered (*lineptr
, stream
);
2112 if (chars_printed
>= chars_per_line
)
2114 unsigned int save_chars
= chars_printed
;
2118 /* If we aren't actually wrapping, don't output newline --
2119 if chars_per_line is right, we probably just overflowed
2120 anyway; if it's wrong, let us keep going. */
2122 fputc_unfiltered ('\n', stream
);
2124 /* Possible new page. */
2125 if (lines_printed
>= lines_per_page
- 1)
2126 prompt_for_continue ();
2128 /* Now output indentation and wrapped string. */
2131 fputs_unfiltered (wrap_indent
, stream
);
2132 *wrap_pointer
= '\0'; /* Null-terminate saved stuff, */
2133 fputs_unfiltered (wrap_buffer
, stream
); /* and eject it. */
2134 /* FIXME, this strlen is what prevents wrap_indent from
2135 containing tabs. However, if we recurse to print it
2136 and count its chars, we risk trouble if wrap_indent is
2137 longer than (the user settable) chars_per_line.
2138 Note also that this can set chars_printed > chars_per_line
2139 if we are printing a long string. */
2140 chars_printed
= strlen (wrap_indent
)
2141 + (save_chars
- wrap_column
);
2142 wrap_pointer
= wrap_buffer
; /* Reset buffer */
2143 wrap_buffer
[0] = '\0';
2144 wrap_column
= 0; /* And disable fancy wrap */
2149 if (*lineptr
== '\n')
2152 wrap_here ((char *) 0); /* Spit out chars, cancel
2155 fputc_unfiltered ('\n', stream
);
2162 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
2164 fputs_maybe_filtered (linebuffer
, stream
, 1);
2168 putchar_unfiltered (int c
)
2172 ui_file_write (gdb_stdout
, &buf
, 1);
2176 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2177 May return nonlocally. */
2180 putchar_filtered (int c
)
2182 return fputc_filtered (c
, gdb_stdout
);
2186 fputc_unfiltered (int c
, struct ui_file
*stream
)
2190 ui_file_write (stream
, &buf
, 1);
2195 fputc_filtered (int c
, struct ui_file
*stream
)
2201 fputs_filtered (buf
, stream
);
2205 /* puts_debug is like fputs_unfiltered, except it prints special
2206 characters in printable fashion. */
2209 puts_debug (char *prefix
, char *string
, char *suffix
)
2213 /* Print prefix and suffix after each line. */
2214 static int new_line
= 1;
2215 static int return_p
= 0;
2216 static char *prev_prefix
= "";
2217 static char *prev_suffix
= "";
2219 if (*string
== '\n')
2222 /* If the prefix is changing, print the previous suffix, a new line,
2223 and the new prefix. */
2224 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
2226 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
2227 fputs_unfiltered ("\n", gdb_stdlog
);
2228 fputs_unfiltered (prefix
, gdb_stdlog
);
2231 /* Print prefix if we printed a newline during the previous call. */
2235 fputs_unfiltered (prefix
, gdb_stdlog
);
2238 prev_prefix
= prefix
;
2239 prev_suffix
= suffix
;
2241 /* Output characters in a printable format. */
2242 while ((ch
= *string
++) != '\0')
2248 fputc_unfiltered (ch
, gdb_stdlog
);
2251 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2255 fputs_unfiltered ("\\\\", gdb_stdlog
);
2258 fputs_unfiltered ("\\b", gdb_stdlog
);
2261 fputs_unfiltered ("\\f", gdb_stdlog
);
2265 fputs_unfiltered ("\\n", gdb_stdlog
);
2268 fputs_unfiltered ("\\r", gdb_stdlog
);
2271 fputs_unfiltered ("\\t", gdb_stdlog
);
2274 fputs_unfiltered ("\\v", gdb_stdlog
);
2278 return_p
= ch
== '\r';
2281 /* Print suffix if we printed a newline. */
2284 fputs_unfiltered (suffix
, gdb_stdlog
);
2285 fputs_unfiltered ("\n", gdb_stdlog
);
2290 /* Print a variable number of ARGS using format FORMAT. If this
2291 information is going to put the amount written (since the last call
2292 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2293 call prompt_for_continue to get the users permision to continue.
2295 Unlike fprintf, this function does not return a value.
2297 We implement three variants, vfprintf (takes a vararg list and stream),
2298 fprintf (takes a stream to write on), and printf (the usual).
2300 Note also that a longjmp to top level may occur in this routine
2301 (since prompt_for_continue may do so) so this routine should not be
2302 called when cleanups are not in place. */
2305 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2306 va_list args
, int filter
)
2309 struct cleanup
*old_cleanups
;
2311 linebuffer
= xstrvprintf (format
, args
);
2312 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2313 fputs_maybe_filtered (linebuffer
, stream
, filter
);
2314 do_cleanups (old_cleanups
);
2319 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2321 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2325 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2328 struct cleanup
*old_cleanups
;
2330 linebuffer
= xstrvprintf (format
, args
);
2331 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2332 if (debug_timestamp
&& stream
== gdb_stdlog
)
2338 gettimeofday (&tm
, NULL
);
2340 len
= strlen (linebuffer
);
2341 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2343 timestamp
= xstrprintf ("%ld:%ld %s%s",
2344 (long) tm
.tv_sec
, (long) tm
.tv_usec
,
2346 need_nl
? "\n": "");
2347 make_cleanup (xfree
, timestamp
);
2348 fputs_unfiltered (timestamp
, stream
);
2351 fputs_unfiltered (linebuffer
, stream
);
2352 do_cleanups (old_cleanups
);
2356 vprintf_filtered (const char *format
, va_list args
)
2358 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2362 vprintf_unfiltered (const char *format
, va_list args
)
2364 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2368 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2372 va_start (args
, format
);
2373 vfprintf_filtered (stream
, format
, args
);
2378 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2382 va_start (args
, format
);
2383 vfprintf_unfiltered (stream
, format
, args
);
2387 /* Like fprintf_filtered, but prints its result indented.
2388 Called as fprintfi_filtered (spaces, stream, format, ...); */
2391 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2396 va_start (args
, format
);
2397 print_spaces_filtered (spaces
, stream
);
2399 vfprintf_filtered (stream
, format
, args
);
2405 printf_filtered (const char *format
, ...)
2409 va_start (args
, format
);
2410 vfprintf_filtered (gdb_stdout
, format
, args
);
2416 printf_unfiltered (const char *format
, ...)
2420 va_start (args
, format
);
2421 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2425 /* Like printf_filtered, but prints it's result indented.
2426 Called as printfi_filtered (spaces, format, ...); */
2429 printfi_filtered (int spaces
, const char *format
, ...)
2433 va_start (args
, format
);
2434 print_spaces_filtered (spaces
, gdb_stdout
);
2435 vfprintf_filtered (gdb_stdout
, format
, args
);
2439 /* Easy -- but watch out!
2441 This routine is *not* a replacement for puts()! puts() appends a newline.
2442 This one doesn't, and had better not! */
2445 puts_filtered (const char *string
)
2447 fputs_filtered (string
, gdb_stdout
);
2451 puts_unfiltered (const char *string
)
2453 fputs_unfiltered (string
, gdb_stdout
);
2456 /* Return a pointer to N spaces and a null. The pointer is good
2457 until the next call to here. */
2462 static char *spaces
= 0;
2463 static int max_spaces
= -1;
2469 spaces
= (char *) xmalloc (n
+ 1);
2470 for (t
= spaces
+ n
; t
!= spaces
;)
2476 return spaces
+ max_spaces
- n
;
2479 /* Print N spaces. */
2481 print_spaces_filtered (int n
, struct ui_file
*stream
)
2483 fputs_filtered (n_spaces (n
), stream
);
2486 /* C++/ObjC demangler stuff. */
2488 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2489 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2490 If the name is not mangled, or the language for the name is unknown, or
2491 demangling is off, the name is printed in its "raw" form. */
2494 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2495 enum language lang
, int arg_mode
)
2501 /* If user wants to see raw output, no problem. */
2504 fputs_filtered (name
, stream
);
2508 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2509 fputs_filtered (demangled
? demangled
: name
, stream
);
2510 if (demangled
!= NULL
)
2518 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2519 differences in whitespace. Returns 0 if they match, non-zero if they
2520 don't (slightly different than strcmp()'s range of return values).
2522 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2523 This "feature" is useful when searching for matching C++ function names
2524 (such as if the user types 'break FOO', where FOO is a mangled C++
2528 strcmp_iw (const char *string1
, const char *string2
)
2530 while ((*string1
!= '\0') && (*string2
!= '\0'))
2532 while (isspace (*string1
))
2536 while (isspace (*string2
))
2540 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2542 if (case_sensitivity
== case_sensitive_off
2543 && (tolower ((unsigned char) *string1
)
2544 != tolower ((unsigned char) *string2
)))
2546 if (*string1
!= '\0')
2552 return (*string1
!= '\0' && *string1
!= '(') || (*string2
!= '\0');
2555 /* This is like strcmp except that it ignores whitespace and treats
2556 '(' as the first non-NULL character in terms of ordering. Like
2557 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2558 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2559 according to that ordering.
2561 If a list is sorted according to this function and if you want to
2562 find names in the list that match some fixed NAME according to
2563 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2564 where this function would put NAME.
2566 This function must be neutral to the CASE_SENSITIVITY setting as the user
2567 may choose it during later lookup. Therefore this function always sorts
2568 primarily case-insensitively and secondarily case-sensitively.
2570 Here are some examples of why using strcmp to sort is a bad idea:
2574 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2575 we try to do a search for "foo<char*>", strcmp will locate this
2576 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2577 will start looking at strings beginning with "goo", and will never
2578 see the correct match of "foo<char *>".
2580 Parenthesis example:
2582 In practice, this is less like to be an issue, but I'll give it a
2583 shot. Let's assume that '$' is a legitimate character to occur in
2584 symbols. (Which may well even be the case on some systems.) Then
2585 say that the partial symbol table contains "foo$" and "foo(int)".
2586 strcmp will put them in this order, since '$' < '('. Now, if the
2587 user searches for "foo", then strcmp will sort "foo" before "foo$".
2588 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2589 "foo") is false, so it won't proceed to the actual match of
2590 "foo(int)" with "foo". */
2593 strcmp_iw_ordered (const char *string1
, const char *string2
)
2595 const char *saved_string1
= string1
, *saved_string2
= string2
;
2596 enum case_sensitivity case_pass
= case_sensitive_off
;
2600 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2601 Provide stub characters if we are already at the end of one of the
2603 char c1
= 'X', c2
= 'X';
2605 while (*string1
!= '\0' && *string2
!= '\0')
2607 while (isspace (*string1
))
2609 while (isspace (*string2
))
2614 case case_sensitive_off
:
2615 c1
= tolower ((unsigned char) *string1
);
2616 c2
= tolower ((unsigned char) *string2
);
2618 case case_sensitive_on
:
2626 if (*string1
!= '\0')
2635 /* Characters are non-equal unless they're both '\0'; we want to
2636 make sure we get the comparison right according to our
2637 comparison in the cases where one of them is '\0' or '('. */
2639 if (*string2
== '\0')
2644 if (*string2
== '\0')
2649 if (*string2
== '\0' || *string2
== '(')
2658 if (case_pass
== case_sensitive_on
)
2661 /* Otherwise the strings were equal in case insensitive way, make
2662 a more fine grained comparison in a case sensitive way. */
2664 case_pass
= case_sensitive_on
;
2665 string1
= saved_string1
;
2666 string2
= saved_string2
;
2670 /* A simple comparison function with opposite semantics to strcmp. */
2673 streq (const char *lhs
, const char *rhs
)
2675 return !strcmp (lhs
, rhs
);
2681 ** Answer whether string_to_compare is a full or partial match to
2682 ** template_string. The partial match must be in sequence starting
2686 subset_compare (char *string_to_compare
, char *template_string
)
2690 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
2691 && strlen (string_to_compare
) <= strlen (template_string
))
2694 (template_string
, string_to_compare
, strlen (string_to_compare
)) == 0);
2701 pagination_on_command (char *arg
, int from_tty
)
2703 pagination_enabled
= 1;
2707 pagination_off_command (char *arg
, int from_tty
)
2709 pagination_enabled
= 0;
2713 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2714 struct cmd_list_element
*c
, const char *value
)
2716 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2722 initialize_utils (void)
2724 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
2725 Set number of characters where GDB should wrap lines of its output."), _("\
2726 Show number of characters where GDB should wrap lines of its output."), _("\
2727 This affects where GDB wraps its output to fit the screen width.\n\
2728 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2730 show_chars_per_line
,
2731 &setlist
, &showlist
);
2733 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
2734 Set number of lines in a page for GDB output pagination."), _("\
2735 Show number of lines in a page for GDB output pagination."), _("\
2736 This affects the number of lines after which GDB will pause\n\
2737 its output and ask you whether to continue.\n\
2738 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2740 show_lines_per_page
,
2741 &setlist
, &showlist
);
2745 add_setshow_boolean_cmd ("pagination", class_support
,
2746 &pagination_enabled
, _("\
2747 Set state of GDB output pagination."), _("\
2748 Show state of GDB output pagination."), _("\
2749 When pagination is ON, GDB pauses at end of each screenful of\n\
2750 its output and asks you whether to continue.\n\
2751 Turning pagination off is an alternative to \"set height unlimited\"."),
2753 show_pagination_enabled
,
2754 &setlist
, &showlist
);
2758 add_com ("am", class_support
, pagination_on_command
,
2759 _("Enable pagination"));
2760 add_com ("sm", class_support
, pagination_off_command
,
2761 _("Disable pagination"));
2764 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
2765 &sevenbit_strings
, _("\
2766 Set printing of 8-bit characters in strings as \\nnn."), _("\
2767 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
2769 show_sevenbit_strings
,
2770 &setprintlist
, &showprintlist
);
2772 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
2773 &debug_timestamp
, _("\
2774 Set timestamping of debugging messages."), _("\
2775 Show timestamping of debugging messages."), _("\
2776 When set, debugging messages will be marked with seconds and microseconds."),
2778 show_debug_timestamp
,
2779 &setdebuglist
, &showdebuglist
);
2783 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2785 /* Truncate address to the size of a target address, avoiding shifts
2786 larger or equal than the width of a CORE_ADDR. The local
2787 variable ADDR_BIT stops the compiler reporting a shift overflow
2788 when it won't occur. */
2789 /* NOTE: This assumes that the significant address information is
2790 kept in the least significant bits of ADDR - the upper bits were
2791 either zero or sign extended. Should gdbarch_address_to_pointer or
2792 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2794 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2796 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2797 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2798 return hex_string (addr
);
2801 /* This function is described in "defs.h". */
2804 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2806 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2808 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2809 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2811 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2812 that returns the language localized string formatted to a width
2813 based on gdbarch_addr_bit. */
2815 return hex_string_custom (address
, 8);
2817 return hex_string_custom (address
, 16);
2820 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2823 core_addr_hash (const void *ap
)
2825 const CORE_ADDR
*addrp
= ap
;
2830 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2833 core_addr_eq (const void *ap
, const void *bp
)
2835 const CORE_ADDR
*addr_ap
= ap
;
2836 const CORE_ADDR
*addr_bp
= bp
;
2838 return *addr_ap
== *addr_bp
;
2841 /* Convert a string back into a CORE_ADDR. */
2843 string_to_core_addr (const char *my_string
)
2847 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2849 /* Assume that it is in hex. */
2852 for (i
= 2; my_string
[i
] != '\0'; i
++)
2854 if (isdigit (my_string
[i
]))
2855 addr
= (my_string
[i
] - '0') + (addr
* 16);
2856 else if (isxdigit (my_string
[i
]))
2857 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2859 error (_("invalid hex \"%s\""), my_string
);
2864 /* Assume that it is in decimal. */
2867 for (i
= 0; my_string
[i
] != '\0'; i
++)
2869 if (isdigit (my_string
[i
]))
2870 addr
= (my_string
[i
] - '0') + (addr
* 10);
2872 error (_("invalid decimal \"%s\""), my_string
);
2880 gdb_realpath (const char *filename
)
2882 /* Method 1: The system has a compile time upper bound on a filename
2883 path. Use that and realpath() to canonicalize the name. This is
2884 the most common case. Note that, if there isn't a compile time
2885 upper bound, you want to avoid realpath() at all costs. */
2886 #if defined (HAVE_REALPATH) && defined (PATH_MAX)
2889 const char *rp
= realpath (filename
, buf
);
2893 return xstrdup (rp
);
2895 #endif /* HAVE_REALPATH */
2897 /* Method 2: The host system (i.e., GNU) has the function
2898 canonicalize_file_name() which malloc's a chunk of memory and
2899 returns that, use that. */
2900 #if defined(HAVE_CANONICALIZE_FILE_NAME)
2902 char *rp
= canonicalize_file_name (filename
);
2905 return xstrdup (filename
);
2911 /* FIXME: cagney/2002-11-13:
2913 Method 2a: Use realpath() with a NULL buffer. Some systems, due
2914 to the problems described in method 3, have modified their
2915 realpath() implementation so that it will allocate a buffer when
2916 NULL is passed in. Before this can be used, though, some sort of
2917 configure time test would need to be added. Otherwize the code
2918 will likely core dump. */
2920 /* Method 3: Now we're getting desperate! The system doesn't have a
2921 compile time buffer size and no alternative function. Query the
2922 OS, using pathconf(), for the buffer limit. Care is needed
2923 though, some systems do not limit PATH_MAX (return -1 for
2924 pathconf()) making it impossible to pass a correctly sized buffer
2925 to realpath() (it could always overflow). On those systems, we
2927 #if defined (HAVE_REALPATH) && defined (_PC_PATH_MAX) && defined(HAVE_ALLOCA)
2929 /* Find out the max path size. */
2930 long path_max
= pathconf ("/", _PC_PATH_MAX
);
2934 /* PATH_MAX is bounded. */
2935 char *buf
= alloca (path_max
);
2936 char *rp
= realpath (filename
, buf
);
2938 return xstrdup (rp
? rp
: filename
);
2943 /* The MS Windows method. If we don't have realpath, we assume we
2944 don't have symlinks and just canonicalize to a Windows absolute
2945 path. GetFullPath converts ../ and ./ in relative paths to
2946 absolute paths, filling in current drive if one is not given
2947 or using the current directory of a specified drive (eg, "E:foo").
2948 It also converts all forward slashes to back slashes. */
2949 /* The file system is case-insensitive but case-preserving.
2950 So we do not lowercase the path. Otherwise, we might not
2951 be able to display the original casing in a given path. */
2952 #if defined (_WIN32)
2955 DWORD len
= GetFullPathName (filename
, MAX_PATH
, buf
, NULL
);
2957 if (len
> 0 && len
< MAX_PATH
)
2958 return xstrdup (buf
);
2962 /* This system is a lost cause, just dup the buffer. */
2963 return xstrdup (filename
);
2966 /* Return a copy of FILENAME, with its directory prefix canonicalized
2970 gdb_realpath_keepfile (const char *filename
)
2972 const char *base_name
= lbasename (filename
);
2977 /* Extract the basename of filename, and return immediately
2978 a copy of filename if it does not contain any directory prefix. */
2979 if (base_name
== filename
)
2980 return xstrdup (filename
);
2982 dir_name
= alloca ((size_t) (base_name
- filename
+ 2));
2983 /* Allocate enough space to store the dir_name + plus one extra
2984 character sometimes needed under Windows (see below), and
2985 then the closing \000 character. */
2986 strncpy (dir_name
, filename
, base_name
- filename
);
2987 dir_name
[base_name
- filename
] = '\000';
2989 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
2990 /* We need to be careful when filename is of the form 'd:foo', which
2991 is equivalent of d:./foo, which is totally different from d:/foo. */
2992 if (strlen (dir_name
) == 2 && isalpha (dir_name
[0]) && dir_name
[1] == ':')
2995 dir_name
[3] = '\000';
2999 /* Canonicalize the directory prefix, and build the resulting
3000 filename. If the dirname realpath already contains an ending
3001 directory separator, avoid doubling it. */
3002 real_path
= gdb_realpath (dir_name
);
3003 if (IS_DIR_SEPARATOR (real_path
[strlen (real_path
) - 1]))
3004 result
= concat (real_path
, base_name
, (char *) NULL
);
3006 result
= concat (real_path
, SLASH_STRING
, base_name
, (char *) NULL
);
3012 /* Return PATH in absolute form, performing tilde-expansion if necessary.
3013 PATH cannot be NULL or the empty string.
3014 This does not resolve symlinks however, use gdb_realpath for that.
3015 Space for the result is allocated with malloc.
3016 If the path is already absolute, it is strdup'd.
3017 If there is a problem computing the absolute path, the path is returned
3018 unchanged (still strdup'd). */
3021 gdb_abspath (const char *path
)
3023 gdb_assert (path
!= NULL
&& path
[0] != '\0');
3026 return tilde_expand (path
);
3028 if (IS_ABSOLUTE_PATH (path
))
3029 return xstrdup (path
);
3031 /* Beware the // my son, the Emacs barfs, the botch that catch... */
3032 return concat (current_directory
,
3033 IS_DIR_SEPARATOR (current_directory
[strlen (current_directory
) - 1])
3034 ? "" : SLASH_STRING
,
3035 path
, (char *) NULL
);
3039 align_up (ULONGEST v
, int n
)
3041 /* Check that N is really a power of two. */
3042 gdb_assert (n
&& (n
& (n
-1)) == 0);
3043 return (v
+ n
- 1) & -n
;
3047 align_down (ULONGEST v
, int n
)
3049 /* Check that N is really a power of two. */
3050 gdb_assert (n
&& (n
& (n
-1)) == 0);
3057 gdb_sign_extend (LONGEST value
, int bit
)
3059 gdb_assert (bit
>= 1 && bit
<= 8 * sizeof (LONGEST
));
3061 if (((value
>> (bit
- 1)) & 1) != 0)
3063 LONGEST signbit
= ((LONGEST
) 1) << (bit
- 1);
3065 value
= (value
^ signbit
) - signbit
;
3071 /* Allocation function for the libiberty hash table which uses an
3072 obstack. The obstack is passed as DATA. */
3075 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
3077 size_t total
= size
* count
;
3078 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
3080 memset (ptr
, 0, total
);
3084 /* Trivial deallocation function for the libiberty splay tree and hash
3085 table - don't deallocate anything. Rely on later deletion of the
3086 obstack. DATA will be the obstack, although it is not needed
3090 dummy_obstack_deallocate (void *object
, void *data
)
3095 /* The bit offset of the highest byte in a ULONGEST, for overflow
3098 #define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT)
3100 /* True (non-zero) iff DIGIT is a valid digit in radix BASE,
3101 where 2 <= BASE <= 36. */
3104 is_digit_in_base (unsigned char digit
, int base
)
3106 if (!isalnum (digit
))
3109 return (isdigit (digit
) && digit
< base
+ '0');
3111 return (isdigit (digit
) || tolower (digit
) < base
- 10 + 'a');
3115 digit_to_int (unsigned char c
)
3120 return tolower (c
) - 'a' + 10;
3123 /* As for strtoul, but for ULONGEST results. */
3126 strtoulst (const char *num
, const char **trailer
, int base
)
3128 unsigned int high_part
;
3133 /* Skip leading whitespace. */
3134 while (isspace (num
[i
]))
3137 /* Handle prefixes. */
3140 else if (num
[i
] == '-')
3146 if (base
== 0 || base
== 16)
3148 if (num
[i
] == '0' && (num
[i
+ 1] == 'x' || num
[i
+ 1] == 'X'))
3156 if (base
== 0 && num
[i
] == '0')
3162 if (base
< 2 || base
> 36)
3168 result
= high_part
= 0;
3169 for (; is_digit_in_base (num
[i
], base
); i
+= 1)
3171 result
= result
* base
+ digit_to_int (num
[i
]);
3172 high_part
= high_part
* base
+ (unsigned int) (result
>> HIGH_BYTE_POSN
);
3173 result
&= ((ULONGEST
) 1 << HIGH_BYTE_POSN
) - 1;
3174 if (high_part
> 0xff)
3177 result
= ~ (ULONGEST
) 0;
3184 if (trailer
!= NULL
)
3187 result
= result
+ ((ULONGEST
) high_part
<< HIGH_BYTE_POSN
);
3194 /* Simple, portable version of dirname that does not modify its
3198 ldirname (const char *filename
)
3200 const char *base
= lbasename (filename
);
3203 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
3206 if (base
== filename
)
3209 dirname
= xmalloc (base
- filename
+ 2);
3210 memcpy (dirname
, filename
, base
- filename
);
3212 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3213 create "d:./bar" later instead of the (different) "d:/bar". */
3214 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3215 && !IS_DIR_SEPARATOR (filename
[0]))
3216 dirname
[base
++ - filename
] = '.';
3218 dirname
[base
- filename
] = '\0';
3222 /* Call libiberty's buildargv, and return the result.
3223 If buildargv fails due to out-of-memory, call nomem.
3224 Therefore, the returned value is guaranteed to be non-NULL,
3225 unless the parameter itself is NULL. */
3228 gdb_buildargv (const char *s
)
3230 char **argv
= buildargv (s
);
3232 if (s
!= NULL
&& argv
== NULL
)
3238 compare_positive_ints (const void *ap
, const void *bp
)
3240 /* Because we know we're comparing two ints which are positive,
3241 there's no danger of overflow here. */
3242 return * (int *) ap
- * (int *) bp
;
3245 /* String compare function for qsort. */
3248 compare_strings (const void *arg1
, const void *arg2
)
3250 const char **s1
= (const char **) arg1
;
3251 const char **s2
= (const char **) arg2
;
3253 return strcmp (*s1
, *s2
);
3256 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3257 #define AMBIGUOUS_MESS2 \
3258 ".\nUse \"set gnutarget format-name\" to specify the format."
3261 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3267 /* Check if errmsg just need simple return. */
3268 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3269 return bfd_errmsg (error_tag
);
3271 ret_len
= strlen (bfd_errmsg (error_tag
)) + strlen (AMBIGUOUS_MESS1
)
3272 + strlen (AMBIGUOUS_MESS2
);
3273 for (p
= matching
; *p
; p
++)
3274 ret_len
+= strlen (*p
) + 1;
3275 ret
= xmalloc (ret_len
+ 1);
3277 make_cleanup (xfree
, ret
);
3279 strcpy (retp
, bfd_errmsg (error_tag
));
3280 retp
+= strlen (retp
);
3282 strcpy (retp
, AMBIGUOUS_MESS1
);
3283 retp
+= strlen (retp
);
3285 for (p
= matching
; *p
; p
++)
3287 sprintf (retp
, " %s", *p
);
3288 retp
+= strlen (retp
);
3292 strcpy (retp
, AMBIGUOUS_MESS2
);
3297 /* Return ARGS parsed as a valid pid, or throw an error. */
3300 parse_pid_to_attach (const char *args
)
3306 error_no_arg (_("process-id to attach"));
3308 dummy
= (char *) args
;
3309 pid
= strtoul (args
, &dummy
, 0);
3310 /* Some targets don't set errno on errors, grrr! */
3311 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3312 error (_("Illegal process-id: %s."), args
);
3317 /* Helper for make_bpstat_clear_actions_cleanup. */
3320 do_bpstat_clear_actions_cleanup (void *unused
)
3322 bpstat_clear_actions ();
3325 /* Call bpstat_clear_actions for the case an exception is throw. You should
3326 discard_cleanups if no exception is caught. */
3329 make_bpstat_clear_actions_cleanup (void)
3331 return make_cleanup (do_bpstat_clear_actions_cleanup
, NULL
);
3334 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3335 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3336 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3339 producer_is_gcc_ge_4 (const char *producer
)
3344 if (producer
== NULL
)
3346 /* For unknown compilers expect their behavior is not compliant. For GCC
3347 this case can also happen for -gdwarf-4 type units supported since
3353 /* Skip any identifier after "GNU " - such as "C++" or "Java". */
3355 if (strncmp (producer
, "GNU ", strlen ("GNU ")) != 0)
3357 /* For non-GCC compilers expect their behavior is not compliant. */
3361 cs
= &producer
[strlen ("GNU ")];
3362 while (*cs
&& !isdigit (*cs
))
3364 if (sscanf (cs
, "%d.%d", &major
, &minor
) != 2)
3366 /* Not recognized as GCC. */
3378 /* Helper for make_cleanup_free_char_ptr_vec. */
3381 do_free_char_ptr_vec (void *arg
)
3383 VEC (char_ptr
) *char_ptr_vec
= arg
;
3385 free_char_ptr_vec (char_ptr_vec
);
3388 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3389 final VEC_free for CHAR_PTR_VEC itself.
3391 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3392 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3393 this function does not (cannot) clear the pointer. */
3396 make_cleanup_free_char_ptr_vec (VEC (char_ptr
) *char_ptr_vec
)
3398 return make_cleanup (do_free_char_ptr_vec
, char_ptr_vec
);
3401 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3402 must come from xrealloc-compatible allocator and it may be updated. FROM
3403 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3404 located at the start or end of *STRINGP. */
3407 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3409 char *string
= *stringp
, *s
;
3410 const size_t from_len
= strlen (from
);
3411 const size_t to_len
= strlen (to
);
3415 s
= strstr (s
, from
);
3419 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3420 || s
[-1] == DIRNAME_SEPARATOR
)
3421 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3422 || s
[from_len
] == DIRNAME_SEPARATOR
))
3426 string_new
= xrealloc (string
, (strlen (string
) + to_len
+ 1));
3428 /* Relocate the current S pointer. */
3429 s
= s
- string
+ string_new
;
3430 string
= string_new
;
3432 /* Replace from by to. */
3433 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3434 memcpy (s
, to
, to_len
);
3449 /* SIGALRM handler for waitpid_with_timeout. */
3452 sigalrm_handler (int signo
)
3454 /* Nothing to do. */
3459 /* Wrapper to wait for child PID to die with TIMEOUT.
3460 TIMEOUT is the time to stop waiting in seconds.
3461 If TIMEOUT is zero, pass WNOHANG to waitpid.
3462 Returns PID if it was successfully waited for, otherwise -1.
3464 Timeouts are currently implemented with alarm and SIGALRM.
3465 If the host does not support them, this waits "forever".
3466 It would be odd though for a host to have waitpid and not SIGALRM. */
3469 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3471 pid_t waitpid_result
;
3473 gdb_assert (pid
> 0);
3474 gdb_assert (timeout
>= 0);
3479 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3480 struct sigaction sa
, old_sa
;
3482 sa
.sa_handler
= sigalrm_handler
;
3483 sigemptyset (&sa
.sa_mask
);
3485 sigaction (SIGALRM
, &sa
, &old_sa
);
3489 ofunc
= (void (*)()) signal (SIGALRM
, sigalrm_handler
);
3495 waitpid_result
= waitpid (pid
, status
, 0);
3499 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3500 sigaction (SIGALRM
, &old_sa
, NULL
);
3502 signal (SIGALRM
, ofunc
);
3507 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3509 if (waitpid_result
== pid
)
3515 #endif /* HAVE_WAITPID */
3517 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3518 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3520 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3521 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3524 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3526 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3528 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3529 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3531 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3533 char *pattern_slash
, *string_slash
;
3535 /* Replace '\' by '/' in both strings. */
3537 pattern_slash
= alloca (strlen (pattern
) + 1);
3538 strcpy (pattern_slash
, pattern
);
3539 pattern
= pattern_slash
;
3540 for (; *pattern_slash
!= 0; pattern_slash
++)
3541 if (IS_DIR_SEPARATOR (*pattern_slash
))
3542 *pattern_slash
= '/';
3544 string_slash
= alloca (strlen (string
) + 1);
3545 strcpy (string_slash
, string
);
3546 string
= string_slash
;
3547 for (; *string_slash
!= 0; string_slash
++)
3548 if (IS_DIR_SEPARATOR (*string_slash
))
3549 *string_slash
= '/';
3551 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3553 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3554 flags
|= FNM_CASEFOLD
;
3555 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3557 return fnmatch (pattern
, string
, flags
);
3560 /* Provide a prototype to silence -Wmissing-prototypes. */
3561 extern initialize_file_ftype _initialize_utils
;
3564 _initialize_utils (void)
3566 add_internal_problem_command (&internal_error_problem
);
3567 add_internal_problem_command (&internal_warning_problem
);
3568 add_internal_problem_command (&demangler_warning_problem
);