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 an error message and return to command level.
534 The first argument STRING is the error message, used as a fprintf string,
535 and the remaining args are passed as arguments to it. */
538 verror (const char *string
, va_list args
)
540 throw_verror (GENERIC_ERROR
, string
, args
);
544 error_stream (struct ui_file
*stream
)
546 char *message
= ui_file_xstrdup (stream
, NULL
);
548 make_cleanup (xfree
, message
);
549 error (("%s"), message
);
552 /* Emit a message and abort. */
554 static void ATTRIBUTE_NORETURN
555 abort_with_message (const char *msg
)
557 if (gdb_stderr
== NULL
)
560 fputs_unfiltered (msg
, gdb_stderr
);
562 abort (); /* NOTE: GDB has only three calls to abort(). */
565 /* Dump core trying to increase the core soft limit to hard limit first. */
570 #ifdef HAVE_SETRLIMIT
571 struct rlimit rlim
= { RLIM_INFINITY
, RLIM_INFINITY
};
573 setrlimit (RLIMIT_CORE
, &rlim
);
574 #endif /* HAVE_SETRLIMIT */
576 abort (); /* NOTE: GDB has only three calls to abort(). */
579 /* Check whether GDB will be able to dump core using the dump_core
580 function. Returns zero if GDB cannot or should not dump core.
581 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
582 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
585 can_dump_core (enum resource_limit_kind limit_kind
)
587 #ifdef HAVE_GETRLIMIT
590 /* Be quiet and assume we can dump if an error is returned. */
591 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
597 if (rlim
.rlim_cur
== 0)
601 if (rlim
.rlim_max
== 0)
604 #endif /* HAVE_GETRLIMIT */
609 /* Print a warning that we cannot dump core. */
612 warn_cant_dump_core (const char *reason
)
614 fprintf_unfiltered (gdb_stderr
,
615 _("%s\nUnable to dump core, use `ulimit -c"
616 " unlimited' before executing GDB next time.\n"),
620 /* Check whether GDB will be able to dump core using the dump_core
621 function, and print a warning if we cannot. */
624 can_dump_core_warn (enum resource_limit_kind limit_kind
,
627 int core_dump_allowed
= can_dump_core (limit_kind
);
629 if (!core_dump_allowed
)
630 warn_cant_dump_core (reason
);
632 return core_dump_allowed
;
635 /* Allow the user to configure the debugger behavior with respect to
636 what to do when an internal problem is detected. */
638 const char internal_problem_ask
[] = "ask";
639 const char internal_problem_yes
[] = "yes";
640 const char internal_problem_no
[] = "no";
641 static const char *const internal_problem_modes
[] =
643 internal_problem_ask
,
644 internal_problem_yes
,
649 /* Print a message reporting an internal error/warning. Ask the user
650 if they want to continue, dump core, or just exit. Return
651 something to indicate a quit. */
653 struct internal_problem
656 int user_settable_should_quit
;
657 const char *should_quit
;
658 int user_settable_should_dump_core
;
659 const char *should_dump_core
;
662 /* Report a problem, internal to GDB, to the user. Once the problem
663 has been reported, and assuming GDB didn't quit, the caller can
664 either allow execution to resume or throw an error. */
666 static void ATTRIBUTE_PRINTF (4, 0)
667 internal_vproblem (struct internal_problem
*problem
,
668 const char *file
, int line
, const char *fmt
, va_list ap
)
674 struct cleanup
*cleanup
= make_cleanup (null_cleanup
, NULL
);
676 /* Don't allow infinite error/warning recursion. */
678 static char msg
[] = "Recursive internal problem.\n";
687 abort_with_message (msg
);
690 /* Newer GLIBC versions put the warn_unused_result attribute
691 on write, but this is one of those rare cases where
692 ignoring the return value is correct. Casting to (void)
693 does not fix this problem. This is the solution suggested
694 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
695 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
696 abort (); /* NOTE: GDB has only three calls to abort(). */
701 /* Create a string containing the full error/warning message. Need
702 to call query with this full string, as otherwize the reason
703 (error/warning) and question become separated. Format using a
704 style similar to a compiler error message. Include extra detail
705 so that the user knows that they are living on the edge. */
709 msg
= xstrvprintf (fmt
, ap
);
710 reason
= xstrprintf ("%s:%d: %s: %s\n"
711 "A problem internal to GDB has been detected,\n"
712 "further debugging may prove unreliable.",
713 file
, line
, problem
->name
, msg
);
715 make_cleanup (xfree
, reason
);
718 /* Fall back to abort_with_message if gdb_stderr is not set up. */
719 if (gdb_stderr
== NULL
)
721 fputs (reason
, stderr
);
722 abort_with_message ("\n");
725 /* Try to get the message out and at the start of a new line. */
726 if (target_supports_terminal_ours ())
727 target_terminal_ours ();
728 if (filtered_printing_initialized ())
731 /* Emit the message unless query will emit it below. */
732 if (problem
->should_quit
!= internal_problem_ask
734 || !filtered_printing_initialized ())
735 fprintf_unfiltered (gdb_stderr
, "%s\n", reason
);
737 if (problem
->should_quit
== internal_problem_ask
)
739 /* Default (yes/batch case) is to quit GDB. When in batch mode
740 this lessens the likelihood of GDB going into an infinite
742 if (!confirm
|| !filtered_printing_initialized ())
745 quit_p
= query (_("%s\nQuit this debugging session? "), reason
);
747 else if (problem
->should_quit
== internal_problem_yes
)
749 else if (problem
->should_quit
== internal_problem_no
)
752 internal_error (__FILE__
, __LINE__
, _("bad switch"));
754 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr
);
755 if (REPORT_BUGS_TO
[0])
756 fprintf_unfiltered (gdb_stderr
, _(" For instructions, see:\n%s."),
758 fputs_unfiltered ("\n\n", gdb_stderr
);
760 if (problem
->should_dump_core
== internal_problem_ask
)
762 if (!can_dump_core_warn (LIMIT_MAX
, reason
))
764 else if (!filtered_printing_initialized ())
768 /* Default (yes/batch case) is to dump core. This leaves a GDB
769 `dropping' so that it is easier to see that something went
771 dump_core_p
= query (_("%s\nCreate a core file of GDB? "), reason
);
774 else if (problem
->should_dump_core
== internal_problem_yes
)
775 dump_core_p
= can_dump_core_warn (LIMIT_MAX
, reason
);
776 else if (problem
->should_dump_core
== internal_problem_no
)
779 internal_error (__FILE__
, __LINE__
, _("bad switch"));
792 #ifdef HAVE_WORKING_FORK
800 do_cleanups (cleanup
);
803 static struct internal_problem internal_error_problem
= {
804 "internal-error", 1, internal_problem_ask
, 1, internal_problem_ask
808 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
810 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
811 throw_quit (_("Command aborted."));
814 static struct internal_problem internal_warning_problem
= {
815 "internal-warning", 1, internal_problem_ask
, 1, internal_problem_ask
819 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
821 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
825 internal_warning (const char *file
, int line
, const char *string
, ...)
829 va_start (ap
, string
);
830 internal_vwarning (file
, line
, string
, ap
);
834 static struct internal_problem demangler_warning_problem
= {
835 "demangler-warning", 1, internal_problem_ask
, 0, internal_problem_no
839 demangler_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
841 internal_vproblem (&demangler_warning_problem
, file
, line
, fmt
, ap
);
845 demangler_warning (const char *file
, int line
, const char *string
, ...)
849 va_start (ap
, string
);
850 demangler_vwarning (file
, line
, string
, ap
);
854 /* Dummy functions to keep add_prefix_cmd happy. */
857 set_internal_problem_cmd (char *args
, int from_tty
)
862 show_internal_problem_cmd (char *args
, int from_tty
)
866 /* When GDB reports an internal problem (error or warning) it gives
867 the user the opportunity to quit GDB and/or create a core file of
868 the current debug session. This function registers a few commands
869 that make it possible to specify that GDB should always or never
870 quit or create a core file, without asking. The commands look
873 maint set PROBLEM-NAME quit ask|yes|no
874 maint show PROBLEM-NAME quit
875 maint set PROBLEM-NAME corefile ask|yes|no
876 maint show PROBLEM-NAME corefile
878 Where PROBLEM-NAME is currently "internal-error" or
879 "internal-warning". */
882 add_internal_problem_command (struct internal_problem
*problem
)
884 struct cmd_list_element
**set_cmd_list
;
885 struct cmd_list_element
**show_cmd_list
;
889 set_cmd_list
= xmalloc (sizeof (*set_cmd_list
));
890 show_cmd_list
= xmalloc (sizeof (*set_cmd_list
));
891 *set_cmd_list
= NULL
;
892 *show_cmd_list
= NULL
;
894 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
897 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
900 add_prefix_cmd ((char*) problem
->name
,
901 class_maintenance
, set_internal_problem_cmd
, set_doc
,
903 concat ("maintenance set ", problem
->name
, " ",
905 0/*allow-unknown*/, &maintenance_set_cmdlist
);
907 add_prefix_cmd ((char*) problem
->name
,
908 class_maintenance
, show_internal_problem_cmd
, show_doc
,
910 concat ("maintenance show ", problem
->name
, " ",
912 0/*allow-unknown*/, &maintenance_show_cmdlist
);
914 if (problem
->user_settable_should_quit
)
916 set_doc
= xstrprintf (_("Set whether GDB should quit "
917 "when an %s is detected"),
919 show_doc
= xstrprintf (_("Show whether GDB will quit "
920 "when an %s is detected"),
922 add_setshow_enum_cmd ("quit", class_maintenance
,
923 internal_problem_modes
,
924 &problem
->should_quit
,
937 if (problem
->user_settable_should_dump_core
)
939 set_doc
= xstrprintf (_("Set whether GDB should create a core "
940 "file of GDB when %s is detected"),
942 show_doc
= xstrprintf (_("Show whether GDB will create a core "
943 "file of GDB when %s is detected"),
945 add_setshow_enum_cmd ("corefile", class_maintenance
,
946 internal_problem_modes
,
947 &problem
->should_dump_core
,
961 /* Return a newly allocated string, containing the PREFIX followed
962 by the system error message for errno (separated by a colon).
964 The result must be deallocated after use. */
967 perror_string (const char *prefix
)
972 err
= safe_strerror (errno
);
973 combined
= (char *) xmalloc (strlen (err
) + strlen (prefix
) + 3);
974 strcpy (combined
, prefix
);
975 strcat (combined
, ": ");
976 strcat (combined
, err
);
981 /* Print the system error message for errno, and also mention STRING
982 as the file name for which the error was encountered. Use ERRCODE
983 for the thrown exception. Then return to command level. */
986 throw_perror_with_name (enum errors errcode
, const char *string
)
990 combined
= perror_string (string
);
991 make_cleanup (xfree
, combined
);
993 /* I understand setting these is a matter of taste. Still, some people
994 may clear errno but not know about bfd_error. Doing this here is not
996 bfd_set_error (bfd_error_no_error
);
999 throw_error (errcode
, _("%s."), combined
);
1002 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
1005 perror_with_name (const char *string
)
1007 throw_perror_with_name (GENERIC_ERROR
, string
);
1010 /* Same as perror_with_name except that it prints a warning instead
1011 of throwing an error. */
1014 perror_warning_with_name (const char *string
)
1018 combined
= perror_string (string
);
1019 warning (_("%s"), combined
);
1023 /* Print the system error message for ERRCODE, and also mention STRING
1024 as the file name for which the error was encountered. */
1027 print_sys_errmsg (const char *string
, int errcode
)
1032 err
= safe_strerror (errcode
);
1033 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
1034 strcpy (combined
, string
);
1035 strcat (combined
, ": ");
1036 strcat (combined
, err
);
1038 /* We want anything which was printed on stdout to come out first, before
1040 gdb_flush (gdb_stdout
);
1041 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
1044 /* Control C eventually causes this to be called, at a convenient time. */
1049 if (sync_quit_force_run
)
1051 sync_quit_force_run
= 0;
1052 quit_force (NULL
, stdin
== instream
);
1056 /* No steenking SIGINT will ever be coming our way when the
1057 program is resumed. Don't lie. */
1058 throw_quit ("Quit");
1061 /* If there is no terminal switching for this target, then we can't
1062 possibly get screwed by the lack of job control. */
1063 || !target_supports_terminal_ours ())
1064 throw_quit ("Quit");
1066 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
1071 /* Called when a memory allocation fails, with the number of bytes of
1072 memory requested in SIZE. */
1075 malloc_failure (long size
)
1079 internal_error (__FILE__
, __LINE__
,
1080 _("virtual memory exhausted: can't allocate %ld bytes."),
1085 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
1089 /* My replacement for the read system call.
1090 Used like `read' but keeps going if `read' returns too soon. */
1093 myread (int desc
, char *addr
, int len
)
1100 val
= read (desc
, addr
, len
);
1104 return orglen
- len
;
1112 print_spaces (int n
, struct ui_file
*file
)
1114 fputs_unfiltered (n_spaces (n
), file
);
1117 /* Print a host address. */
1120 gdb_print_host_address (const void *addr
, struct ui_file
*stream
)
1122 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
1126 /* A cleanup function that calls regfree. */
1129 do_regfree_cleanup (void *r
)
1134 /* Create a new cleanup that frees the compiled regular expression R. */
1137 make_regfree_cleanup (regex_t
*r
)
1139 return make_cleanup (do_regfree_cleanup
, r
);
1142 /* Return an xmalloc'd error message resulting from a regular
1143 expression compilation failure. */
1146 get_regcomp_error (int code
, regex_t
*rx
)
1148 size_t length
= regerror (code
, rx
, NULL
, 0);
1149 char *result
= xmalloc (length
);
1151 regerror (code
, rx
, result
, length
);
1155 /* Compile a regexp and throw an exception on error. This returns a
1156 cleanup to free the resulting pattern on success. RX must not be
1160 compile_rx_or_error (regex_t
*pattern
, const char *rx
, const char *message
)
1164 gdb_assert (rx
!= NULL
);
1166 code
= regcomp (pattern
, rx
, REG_NOSUB
);
1169 char *err
= get_regcomp_error (code
, pattern
);
1171 make_cleanup (xfree
, err
);
1172 error (("%s: %s"), message
, err
);
1175 return make_regfree_cleanup (pattern
);
1180 /* This function supports the query, nquery, and yquery functions.
1181 Ask user a y-or-n question and return 0 if answer is no, 1 if
1182 answer is yes, or default the answer to the specified default
1183 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1184 default answer, or '\0' for no default.
1185 CTLSTR is the control string and should end in "? ". It should
1186 not say how to answer, because we do that.
1187 ARGS are the arguments passed along with the CTLSTR argument to
1190 static int ATTRIBUTE_PRINTF (1, 0)
1191 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
1197 char def_answer
, not_def_answer
;
1198 char *y_string
, *n_string
, *question
;
1199 /* Used to add duration we waited for user to respond to
1200 prompt_for_continue_wait_time. */
1201 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1203 /* Set up according to which answer is the default. */
1204 if (defchar
== '\0')
1208 not_def_answer
= 'N';
1212 else if (defchar
== 'y')
1216 not_def_answer
= 'N';
1224 not_def_answer
= 'Y';
1229 /* Automatically answer the default value if the user did not want
1230 prompts or the command was issued with the server prefix. */
1231 if (!confirm
|| server_command
)
1234 /* If input isn't coming from the user directly, just say what
1235 question we're asking, and then answer the default automatically. This
1236 way, important error messages don't get lost when talking to GDB
1238 if (! input_from_terminal_p ())
1241 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
1243 printf_filtered (_("(%s or %s) [answered %c; "
1244 "input not from terminal]\n"),
1245 y_string
, n_string
, def_answer
);
1246 gdb_flush (gdb_stdout
);
1251 if (deprecated_query_hook
)
1253 return deprecated_query_hook (ctlstr
, args
);
1256 /* Format the question outside of the loop, to avoid reusing args. */
1257 question
= xstrvprintf (ctlstr
, args
);
1259 /* Used for calculating time spend waiting for user. */
1260 gettimeofday (&prompt_started
, NULL
);
1264 wrap_here (""); /* Flush any buffered output. */
1265 gdb_flush (gdb_stdout
);
1267 if (annotation_level
> 1)
1268 printf_filtered (("\n\032\032pre-query\n"));
1270 fputs_filtered (question
, gdb_stdout
);
1271 printf_filtered (_("(%s or %s) "), y_string
, n_string
);
1273 if (annotation_level
> 1)
1274 printf_filtered (("\n\032\032query\n"));
1277 gdb_flush (gdb_stdout
);
1279 answer
= fgetc (stdin
);
1281 /* We expect fgetc to block until a character is read. But
1282 this may not be the case if the terminal was opened with
1283 the NONBLOCK flag. In that case, if there is nothing to
1284 read on stdin, fgetc returns EOF, but also sets the error
1285 condition flag on stdin and errno to EAGAIN. With a true
1286 EOF, stdin's error condition flag is not set.
1288 A situation where this behavior was observed is a pseudo
1290 while (answer
== EOF
&& ferror (stdin
) && errno
== EAGAIN
)
1292 /* Not a real EOF. Wait a little while and try again until
1293 we read something. */
1296 answer
= fgetc (stdin
);
1299 clearerr (stdin
); /* in case of C-d */
1300 if (answer
== EOF
) /* C-d */
1302 printf_filtered ("EOF [assumed %c]\n", def_answer
);
1306 /* Eat rest of input line, to EOF or newline. */
1310 ans2
= fgetc (stdin
);
1313 while (ans2
!= EOF
&& ans2
!= '\n' && ans2
!= '\r');
1317 /* Check answer. For the non-default, the user must specify
1318 the non-default explicitly. */
1319 if (answer
== not_def_answer
)
1321 retval
= !def_value
;
1324 /* Otherwise, if a default was specified, the user may either
1325 specify the required input or have it default by entering
1327 if (answer
== def_answer
1328 || (defchar
!= '\0' &&
1329 (answer
== '\n' || answer
== '\r' || answer
== EOF
)))
1334 /* Invalid entries are not defaulted and require another selection. */
1335 printf_filtered (_("Please answer %s or %s.\n"),
1336 y_string
, n_string
);
1339 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1340 gettimeofday (&prompt_ended
, NULL
);
1341 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1342 timeval_add (&prompt_for_continue_wait_time
,
1343 &prompt_for_continue_wait_time
, &prompt_delta
);
1346 if (annotation_level
> 1)
1347 printf_filtered (("\n\032\032post-query\n"));
1352 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1353 answer is yes, or 0 if answer is defaulted.
1354 Takes three args which are given to printf to print the question.
1355 The first, a control string, should end in "? ".
1356 It should not say how to answer, because we do that. */
1359 nquery (const char *ctlstr
, ...)
1364 va_start (args
, ctlstr
);
1365 ret
= defaulted_query (ctlstr
, 'n', args
);
1370 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1371 answer is yes, or 1 if answer is defaulted.
1372 Takes three args which are given to printf to print the question.
1373 The first, a control string, should end in "? ".
1374 It should not say how to answer, because we do that. */
1377 yquery (const char *ctlstr
, ...)
1382 va_start (args
, ctlstr
);
1383 ret
= defaulted_query (ctlstr
, 'y', args
);
1388 /* Ask user a y-or-n question and return 1 iff answer is yes.
1389 Takes three args which are given to printf to print the question.
1390 The first, a control string, should end in "? ".
1391 It should not say how to answer, because we do that. */
1394 query (const char *ctlstr
, ...)
1399 va_start (args
, ctlstr
);
1400 ret
= defaulted_query (ctlstr
, '\0', args
);
1405 /* A helper for parse_escape that converts a host character to a
1406 target character. C is the host character. If conversion is
1407 possible, then the target character is stored in *TARGET_C and the
1408 function returns 1. Otherwise, the function returns 0. */
1411 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1413 struct obstack host_data
;
1415 struct cleanup
*cleanups
;
1418 obstack_init (&host_data
);
1419 cleanups
= make_cleanup_obstack_free (&host_data
);
1421 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1422 (gdb_byte
*) &the_char
, 1, 1,
1423 &host_data
, translit_none
);
1425 if (obstack_object_size (&host_data
) == 1)
1428 *target_c
= *(char *) obstack_base (&host_data
);
1431 do_cleanups (cleanups
);
1435 /* Parse a C escape sequence. STRING_PTR points to a variable
1436 containing a pointer to the string to parse. That pointer
1437 should point to the character after the \. That pointer
1438 is updated past the characters we use. The value of the
1439 escape sequence is returned.
1441 A negative value means the sequence \ newline was seen,
1442 which is supposed to be equivalent to nothing at all.
1444 If \ is followed by a null character, we return a negative
1445 value and leave the string pointer pointing at the null character.
1447 If \ is followed by 000, we return 0 and leave the string pointer
1448 after the zeros. A value of 0 does not mean end of string. */
1451 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1453 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1454 int c
= *(*string_ptr
)++;
1473 int i
= host_hex_value (c
);
1478 if (isdigit (c
) && c
!= '8' && c
!= '9')
1482 i
+= host_hex_value (c
);
1518 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1519 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1520 " which has no equivalent\nin the `%s' character set."),
1521 c
, c
, target_charset (gdbarch
));
1525 /* Print the character C on STREAM as part of the contents of a literal
1526 string whose delimiter is QUOTER. Note that this routine should only
1527 be call for printing things which are independent of the language
1528 of the program being debugged.
1530 printchar will normally escape backslashes and instances of QUOTER. If
1531 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1532 As a side effect, if you pass the backslash character as the QUOTER,
1533 printchar will escape backslashes as usual, but not any other quoting
1537 printchar (int c
, void (*do_fputs
) (const char *, struct ui_file
*),
1538 void (*do_fprintf
) (struct ui_file
*, const char *, ...)
1539 ATTRIBUTE_FPTR_PRINTF_2
, struct ui_file
*stream
, int quoter
)
1541 c
&= 0xFF; /* Avoid sign bit follies */
1543 if (c
< 0x20 || /* Low control chars */
1544 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1545 (sevenbit_strings
&& c
>= 0x80))
1546 { /* high order bit set */
1550 do_fputs ("\\n", stream
);
1553 do_fputs ("\\b", stream
);
1556 do_fputs ("\\t", stream
);
1559 do_fputs ("\\f", stream
);
1562 do_fputs ("\\r", stream
);
1565 do_fputs ("\\e", stream
);
1568 do_fputs ("\\a", stream
);
1571 do_fprintf (stream
, "\\%.3o", (unsigned int) c
);
1577 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1578 do_fputs ("\\", stream
);
1579 do_fprintf (stream
, "%c", c
);
1583 /* Print the character C on STREAM as part of the contents of a
1584 literal string whose delimiter is QUOTER. Note that these routines
1585 should only be call for printing things which are independent of
1586 the language of the program being debugged. */
1589 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1592 printchar (*str
++, fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1596 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1599 printchar (*str
++, fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1603 fputstrn_filtered (const char *str
, int n
, int quoter
,
1604 struct ui_file
*stream
)
1608 for (i
= 0; i
< n
; i
++)
1609 printchar (str
[i
], fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1613 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1614 struct ui_file
*stream
)
1618 for (i
= 0; i
< n
; i
++)
1619 printchar (str
[i
], fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1623 /* Number of lines per page or UINT_MAX if paging is disabled. */
1624 static unsigned int lines_per_page
;
1626 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1627 struct cmd_list_element
*c
, const char *value
)
1629 fprintf_filtered (file
,
1630 _("Number of lines gdb thinks are in a page is %s.\n"),
1634 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1635 static unsigned int chars_per_line
;
1637 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1638 struct cmd_list_element
*c
, const char *value
)
1640 fprintf_filtered (file
,
1641 _("Number of characters gdb thinks "
1642 "are in a line is %s.\n"),
1646 /* Current count of lines printed on this page, chars on this line. */
1647 static unsigned int lines_printed
, chars_printed
;
1649 /* Buffer and start column of buffered text, for doing smarter word-
1650 wrapping. When someone calls wrap_here(), we start buffering output
1651 that comes through fputs_filtered(). If we see a newline, we just
1652 spit it out and forget about the wrap_here(). If we see another
1653 wrap_here(), we spit it out and remember the newer one. If we see
1654 the end of the line, we spit out a newline, the indent, and then
1655 the buffered output. */
1657 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1658 are waiting to be output (they have already been counted in chars_printed).
1659 When wrap_buffer[0] is null, the buffer is empty. */
1660 static char *wrap_buffer
;
1662 /* Pointer in wrap_buffer to the next character to fill. */
1663 static char *wrap_pointer
;
1665 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1667 static char *wrap_indent
;
1669 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1670 is not in effect. */
1671 static int wrap_column
;
1674 /* Inialize the number of lines per page and chars per line. */
1677 init_page_info (void)
1681 lines_per_page
= UINT_MAX
;
1682 chars_per_line
= UINT_MAX
;
1686 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1691 #if defined(__GO32__)
1692 rows
= ScreenRows ();
1693 cols
= ScreenCols ();
1694 lines_per_page
= rows
;
1695 chars_per_line
= cols
;
1697 /* Make sure Readline has initialized its terminal settings. */
1698 rl_reset_terminal (NULL
);
1700 /* Get the screen size from Readline. */
1701 rl_get_screen_size (&rows
, &cols
);
1702 lines_per_page
= rows
;
1703 chars_per_line
= cols
;
1705 /* Readline should have fetched the termcap entry for us.
1706 Only try to use tgetnum function if rl_get_screen_size
1707 did not return a useful value. */
1708 if (((rows
<= 0) && (tgetnum ("li") < 0))
1709 /* Also disable paging if inside EMACS. */
1710 || getenv ("EMACS"))
1712 /* The number of lines per page is not mentioned in the terminal
1713 description or EMACS evironment variable is set. This probably
1714 means that paging is not useful, so disable paging. */
1715 lines_per_page
= UINT_MAX
;
1718 /* If the output is not a terminal, don't paginate it. */
1719 if (!ui_file_isatty (gdb_stdout
))
1720 lines_per_page
= UINT_MAX
;
1728 /* Return nonzero if filtered printing is initialized. */
1730 filtered_printing_initialized (void)
1732 return wrap_buffer
!= NULL
;
1735 /* Helper for make_cleanup_restore_page_info. */
1738 do_restore_page_info_cleanup (void *arg
)
1744 /* Provide cleanup for restoring the terminal size. */
1747 make_cleanup_restore_page_info (void)
1749 struct cleanup
*back_to
;
1751 back_to
= make_cleanup (do_restore_page_info_cleanup
, NULL
);
1752 make_cleanup_restore_uinteger (&lines_per_page
);
1753 make_cleanup_restore_uinteger (&chars_per_line
);
1758 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1759 Provide cleanup for restoring the original state. */
1762 set_batch_flag_and_make_cleanup_restore_page_info (void)
1764 struct cleanup
*back_to
= make_cleanup_restore_page_info ();
1766 make_cleanup_restore_integer (&batch_flag
);
1773 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1776 set_screen_size (void)
1778 int rows
= lines_per_page
;
1779 int cols
= chars_per_line
;
1787 /* Update Readline's idea of the terminal size. */
1788 rl_set_screen_size (rows
, cols
);
1791 /* Reinitialize WRAP_BUFFER according to the current value of
1797 if (chars_per_line
== 0)
1802 wrap_buffer
= (char *) xmalloc (chars_per_line
+ 2);
1803 wrap_buffer
[0] = '\0';
1806 wrap_buffer
= (char *) xrealloc (wrap_buffer
, chars_per_line
+ 2);
1807 wrap_pointer
= wrap_buffer
; /* Start it at the beginning. */
1811 set_width_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1818 set_height_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1823 /* Wait, so the user can read what's on the screen. Prompt the user
1824 to continue by pressing RETURN. */
1827 prompt_for_continue (void)
1830 char cont_prompt
[120];
1831 /* Used to add duration we waited for user to respond to
1832 prompt_for_continue_wait_time. */
1833 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1835 gettimeofday (&prompt_started
, NULL
);
1837 if (annotation_level
> 1)
1838 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1840 strcpy (cont_prompt
,
1841 "---Type <return> to continue, or q <return> to quit---");
1842 if (annotation_level
> 1)
1843 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1845 /* We must do this *before* we call gdb_readline, else it will eventually
1846 call us -- thinking that we're trying to print beyond the end of the
1848 reinitialize_more_filter ();
1853 /* We'll need to handle input. */
1854 target_terminal_ours ();
1856 /* On a real operating system, the user can quit with SIGINT.
1859 'q' is provided on all systems so users don't have to change habits
1860 from system to system, and because telling them what to do in
1861 the prompt is more user-friendly than expecting them to think of
1863 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1864 whereas control-C to gdb_readline will cause the user to get dumped
1866 ignore
= gdb_readline_wrapper (cont_prompt
);
1868 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1869 gettimeofday (&prompt_ended
, NULL
);
1870 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1871 timeval_add (&prompt_for_continue_wait_time
,
1872 &prompt_for_continue_wait_time
, &prompt_delta
);
1874 if (annotation_level
> 1)
1875 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1881 while (*p
== ' ' || *p
== '\t')
1889 /* Now we have to do this again, so that GDB will know that it doesn't
1890 need to save the ---Type <return>--- line at the top of the screen. */
1891 reinitialize_more_filter ();
1893 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1896 /* Initalize timer to keep track of how long we waited for the user. */
1899 reset_prompt_for_continue_wait_time (void)
1901 static const struct timeval zero_timeval
= { 0 };
1903 prompt_for_continue_wait_time
= zero_timeval
;
1906 /* Fetch the cumulative time spent in prompt_for_continue. */
1909 get_prompt_for_continue_wait_time (void)
1911 return prompt_for_continue_wait_time
;
1914 /* Reinitialize filter; ie. tell it to reset to original values. */
1917 reinitialize_more_filter (void)
1923 /* Indicate that if the next sequence of characters overflows the line,
1924 a newline should be inserted here rather than when it hits the end.
1925 If INDENT is non-null, it is a string to be printed to indent the
1926 wrapped part on the next line. INDENT must remain accessible until
1927 the next call to wrap_here() or until a newline is printed through
1930 If the line is already overfull, we immediately print a newline and
1931 the indentation, and disable further wrapping.
1933 If we don't know the width of lines, but we know the page height,
1934 we must not wrap words, but should still keep track of newlines
1935 that were explicitly printed.
1937 INDENT should not contain tabs, as that will mess up the char count
1938 on the next line. FIXME.
1940 This routine is guaranteed to force out any output which has been
1941 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1942 used to force out output from the wrap_buffer. */
1945 wrap_here (char *indent
)
1947 /* This should have been allocated, but be paranoid anyway. */
1949 internal_error (__FILE__
, __LINE__
,
1950 _("failed internal consistency check"));
1954 *wrap_pointer
= '\0';
1955 fputs_unfiltered (wrap_buffer
, gdb_stdout
);
1957 wrap_pointer
= wrap_buffer
;
1958 wrap_buffer
[0] = '\0';
1959 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1963 else if (chars_printed
>= chars_per_line
)
1965 puts_filtered ("\n");
1967 puts_filtered (indent
);
1972 wrap_column
= chars_printed
;
1976 wrap_indent
= indent
;
1980 /* Print input string to gdb_stdout, filtered, with wrap,
1981 arranging strings in columns of n chars. String can be
1982 right or left justified in the column. Never prints
1983 trailing spaces. String should never be longer than
1984 width. FIXME: this could be useful for the EXAMINE
1985 command, which currently doesn't tabulate very well. */
1988 puts_filtered_tabular (char *string
, int width
, int right
)
1994 gdb_assert (chars_per_line
> 0);
1995 if (chars_per_line
== UINT_MAX
)
1997 fputs_filtered (string
, gdb_stdout
);
1998 fputs_filtered ("\n", gdb_stdout
);
2002 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
2003 fputs_filtered ("\n", gdb_stdout
);
2005 if (width
>= chars_per_line
)
2006 width
= chars_per_line
- 1;
2008 stringlen
= strlen (string
);
2010 if (chars_printed
> 0)
2011 spaces
= width
- (chars_printed
- 1) % width
- 1;
2013 spaces
+= width
- stringlen
;
2015 spacebuf
= alloca (spaces
+ 1);
2016 spacebuf
[spaces
] = '\0';
2018 spacebuf
[spaces
] = ' ';
2020 fputs_filtered (spacebuf
, gdb_stdout
);
2021 fputs_filtered (string
, gdb_stdout
);
2025 /* Ensure that whatever gets printed next, using the filtered output
2026 commands, starts at the beginning of the line. I.e. if there is
2027 any pending output for the current line, flush it and start a new
2028 line. Otherwise do nothing. */
2033 if (chars_printed
> 0)
2035 puts_filtered ("\n");
2040 /* Like fputs but if FILTER is true, pause after every screenful.
2042 Regardless of FILTER can wrap at points other than the final
2043 character of a line.
2045 Unlike fputs, fputs_maybe_filtered does not return a value.
2046 It is OK for LINEBUFFER to be NULL, in which case just don't print
2049 Note that a longjmp to top level may occur in this routine (only if
2050 FILTER is true) (since prompt_for_continue may do so) so this
2051 routine should not be called when cleanups are not in place. */
2054 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
2057 const char *lineptr
;
2059 if (linebuffer
== 0)
2062 /* Don't do any filtering if it is disabled. */
2063 if (stream
!= gdb_stdout
2064 || !pagination_enabled
2066 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
2067 || top_level_interpreter () == NULL
2068 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2070 fputs_unfiltered (linebuffer
, stream
);
2074 /* Go through and output each character. Show line extension
2075 when this is necessary; prompt user for new page when this is
2078 lineptr
= linebuffer
;
2081 /* Possible new page. */
2082 if (filter
&& (lines_printed
>= lines_per_page
- 1))
2083 prompt_for_continue ();
2085 while (*lineptr
&& *lineptr
!= '\n')
2087 /* Print a single line. */
2088 if (*lineptr
== '\t')
2091 *wrap_pointer
++ = '\t';
2093 fputc_unfiltered ('\t', stream
);
2094 /* Shifting right by 3 produces the number of tab stops
2095 we have already passed, and then adding one and
2096 shifting left 3 advances to the next tab stop. */
2097 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
2103 *wrap_pointer
++ = *lineptr
;
2105 fputc_unfiltered (*lineptr
, stream
);
2110 if (chars_printed
>= chars_per_line
)
2112 unsigned int save_chars
= chars_printed
;
2116 /* If we aren't actually wrapping, don't output newline --
2117 if chars_per_line is right, we probably just overflowed
2118 anyway; if it's wrong, let us keep going. */
2120 fputc_unfiltered ('\n', stream
);
2122 /* Possible new page. */
2123 if (lines_printed
>= lines_per_page
- 1)
2124 prompt_for_continue ();
2126 /* Now output indentation and wrapped string. */
2129 fputs_unfiltered (wrap_indent
, stream
);
2130 *wrap_pointer
= '\0'; /* Null-terminate saved stuff, */
2131 fputs_unfiltered (wrap_buffer
, stream
); /* and eject it. */
2132 /* FIXME, this strlen is what prevents wrap_indent from
2133 containing tabs. However, if we recurse to print it
2134 and count its chars, we risk trouble if wrap_indent is
2135 longer than (the user settable) chars_per_line.
2136 Note also that this can set chars_printed > chars_per_line
2137 if we are printing a long string. */
2138 chars_printed
= strlen (wrap_indent
)
2139 + (save_chars
- wrap_column
);
2140 wrap_pointer
= wrap_buffer
; /* Reset buffer */
2141 wrap_buffer
[0] = '\0';
2142 wrap_column
= 0; /* And disable fancy wrap */
2147 if (*lineptr
== '\n')
2150 wrap_here ((char *) 0); /* Spit out chars, cancel
2153 fputc_unfiltered ('\n', stream
);
2160 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
2162 fputs_maybe_filtered (linebuffer
, stream
, 1);
2166 putchar_unfiltered (int c
)
2170 ui_file_write (gdb_stdout
, &buf
, 1);
2174 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2175 May return nonlocally. */
2178 putchar_filtered (int c
)
2180 return fputc_filtered (c
, gdb_stdout
);
2184 fputc_unfiltered (int c
, struct ui_file
*stream
)
2188 ui_file_write (stream
, &buf
, 1);
2193 fputc_filtered (int c
, struct ui_file
*stream
)
2199 fputs_filtered (buf
, stream
);
2203 /* puts_debug is like fputs_unfiltered, except it prints special
2204 characters in printable fashion. */
2207 puts_debug (char *prefix
, char *string
, char *suffix
)
2211 /* Print prefix and suffix after each line. */
2212 static int new_line
= 1;
2213 static int return_p
= 0;
2214 static char *prev_prefix
= "";
2215 static char *prev_suffix
= "";
2217 if (*string
== '\n')
2220 /* If the prefix is changing, print the previous suffix, a new line,
2221 and the new prefix. */
2222 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
2224 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
2225 fputs_unfiltered ("\n", gdb_stdlog
);
2226 fputs_unfiltered (prefix
, gdb_stdlog
);
2229 /* Print prefix if we printed a newline during the previous call. */
2233 fputs_unfiltered (prefix
, gdb_stdlog
);
2236 prev_prefix
= prefix
;
2237 prev_suffix
= suffix
;
2239 /* Output characters in a printable format. */
2240 while ((ch
= *string
++) != '\0')
2246 fputc_unfiltered (ch
, gdb_stdlog
);
2249 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2253 fputs_unfiltered ("\\\\", gdb_stdlog
);
2256 fputs_unfiltered ("\\b", gdb_stdlog
);
2259 fputs_unfiltered ("\\f", gdb_stdlog
);
2263 fputs_unfiltered ("\\n", gdb_stdlog
);
2266 fputs_unfiltered ("\\r", gdb_stdlog
);
2269 fputs_unfiltered ("\\t", gdb_stdlog
);
2272 fputs_unfiltered ("\\v", gdb_stdlog
);
2276 return_p
= ch
== '\r';
2279 /* Print suffix if we printed a newline. */
2282 fputs_unfiltered (suffix
, gdb_stdlog
);
2283 fputs_unfiltered ("\n", gdb_stdlog
);
2288 /* Print a variable number of ARGS using format FORMAT. If this
2289 information is going to put the amount written (since the last call
2290 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2291 call prompt_for_continue to get the users permision to continue.
2293 Unlike fprintf, this function does not return a value.
2295 We implement three variants, vfprintf (takes a vararg list and stream),
2296 fprintf (takes a stream to write on), and printf (the usual).
2298 Note also that a longjmp to top level may occur in this routine
2299 (since prompt_for_continue may do so) so this routine should not be
2300 called when cleanups are not in place. */
2303 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2304 va_list args
, int filter
)
2307 struct cleanup
*old_cleanups
;
2309 linebuffer
= xstrvprintf (format
, args
);
2310 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2311 fputs_maybe_filtered (linebuffer
, stream
, filter
);
2312 do_cleanups (old_cleanups
);
2317 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2319 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2323 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2326 struct cleanup
*old_cleanups
;
2328 linebuffer
= xstrvprintf (format
, args
);
2329 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2330 if (debug_timestamp
&& stream
== gdb_stdlog
)
2336 gettimeofday (&tm
, NULL
);
2338 len
= strlen (linebuffer
);
2339 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2341 timestamp
= xstrprintf ("%ld:%ld %s%s",
2342 (long) tm
.tv_sec
, (long) tm
.tv_usec
,
2344 need_nl
? "\n": "");
2345 make_cleanup (xfree
, timestamp
);
2346 fputs_unfiltered (timestamp
, stream
);
2349 fputs_unfiltered (linebuffer
, stream
);
2350 do_cleanups (old_cleanups
);
2354 vprintf_filtered (const char *format
, va_list args
)
2356 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2360 vprintf_unfiltered (const char *format
, va_list args
)
2362 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2366 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2370 va_start (args
, format
);
2371 vfprintf_filtered (stream
, format
, args
);
2376 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2380 va_start (args
, format
);
2381 vfprintf_unfiltered (stream
, format
, args
);
2385 /* Like fprintf_filtered, but prints its result indented.
2386 Called as fprintfi_filtered (spaces, stream, format, ...); */
2389 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2394 va_start (args
, format
);
2395 print_spaces_filtered (spaces
, stream
);
2397 vfprintf_filtered (stream
, format
, args
);
2403 printf_filtered (const char *format
, ...)
2407 va_start (args
, format
);
2408 vfprintf_filtered (gdb_stdout
, format
, args
);
2414 printf_unfiltered (const char *format
, ...)
2418 va_start (args
, format
);
2419 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2423 /* Like printf_filtered, but prints it's result indented.
2424 Called as printfi_filtered (spaces, format, ...); */
2427 printfi_filtered (int spaces
, const char *format
, ...)
2431 va_start (args
, format
);
2432 print_spaces_filtered (spaces
, gdb_stdout
);
2433 vfprintf_filtered (gdb_stdout
, format
, args
);
2437 /* Easy -- but watch out!
2439 This routine is *not* a replacement for puts()! puts() appends a newline.
2440 This one doesn't, and had better not! */
2443 puts_filtered (const char *string
)
2445 fputs_filtered (string
, gdb_stdout
);
2449 puts_unfiltered (const char *string
)
2451 fputs_unfiltered (string
, gdb_stdout
);
2454 /* Return a pointer to N spaces and a null. The pointer is good
2455 until the next call to here. */
2460 static char *spaces
= 0;
2461 static int max_spaces
= -1;
2467 spaces
= (char *) xmalloc (n
+ 1);
2468 for (t
= spaces
+ n
; t
!= spaces
;)
2474 return spaces
+ max_spaces
- n
;
2477 /* Print N spaces. */
2479 print_spaces_filtered (int n
, struct ui_file
*stream
)
2481 fputs_filtered (n_spaces (n
), stream
);
2484 /* C++/ObjC demangler stuff. */
2486 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2487 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2488 If the name is not mangled, or the language for the name is unknown, or
2489 demangling is off, the name is printed in its "raw" form. */
2492 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2493 enum language lang
, int arg_mode
)
2499 /* If user wants to see raw output, no problem. */
2502 fputs_filtered (name
, stream
);
2506 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2507 fputs_filtered (demangled
? demangled
: name
, stream
);
2508 if (demangled
!= NULL
)
2516 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2517 differences in whitespace. Returns 0 if they match, non-zero if they
2518 don't (slightly different than strcmp()'s range of return values).
2520 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2521 This "feature" is useful when searching for matching C++ function names
2522 (such as if the user types 'break FOO', where FOO is a mangled C++
2526 strcmp_iw (const char *string1
, const char *string2
)
2528 while ((*string1
!= '\0') && (*string2
!= '\0'))
2530 while (isspace (*string1
))
2534 while (isspace (*string2
))
2538 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2540 if (case_sensitivity
== case_sensitive_off
2541 && (tolower ((unsigned char) *string1
)
2542 != tolower ((unsigned char) *string2
)))
2544 if (*string1
!= '\0')
2550 return (*string1
!= '\0' && *string1
!= '(') || (*string2
!= '\0');
2553 /* This is like strcmp except that it ignores whitespace and treats
2554 '(' as the first non-NULL character in terms of ordering. Like
2555 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2556 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2557 according to that ordering.
2559 If a list is sorted according to this function and if you want to
2560 find names in the list that match some fixed NAME according to
2561 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2562 where this function would put NAME.
2564 This function must be neutral to the CASE_SENSITIVITY setting as the user
2565 may choose it during later lookup. Therefore this function always sorts
2566 primarily case-insensitively and secondarily case-sensitively.
2568 Here are some examples of why using strcmp to sort is a bad idea:
2572 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2573 we try to do a search for "foo<char*>", strcmp will locate this
2574 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2575 will start looking at strings beginning with "goo", and will never
2576 see the correct match of "foo<char *>".
2578 Parenthesis example:
2580 In practice, this is less like to be an issue, but I'll give it a
2581 shot. Let's assume that '$' is a legitimate character to occur in
2582 symbols. (Which may well even be the case on some systems.) Then
2583 say that the partial symbol table contains "foo$" and "foo(int)".
2584 strcmp will put them in this order, since '$' < '('. Now, if the
2585 user searches for "foo", then strcmp will sort "foo" before "foo$".
2586 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2587 "foo") is false, so it won't proceed to the actual match of
2588 "foo(int)" with "foo". */
2591 strcmp_iw_ordered (const char *string1
, const char *string2
)
2593 const char *saved_string1
= string1
, *saved_string2
= string2
;
2594 enum case_sensitivity case_pass
= case_sensitive_off
;
2598 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2599 Provide stub characters if we are already at the end of one of the
2601 char c1
= 'X', c2
= 'X';
2603 while (*string1
!= '\0' && *string2
!= '\0')
2605 while (isspace (*string1
))
2607 while (isspace (*string2
))
2612 case case_sensitive_off
:
2613 c1
= tolower ((unsigned char) *string1
);
2614 c2
= tolower ((unsigned char) *string2
);
2616 case case_sensitive_on
:
2624 if (*string1
!= '\0')
2633 /* Characters are non-equal unless they're both '\0'; we want to
2634 make sure we get the comparison right according to our
2635 comparison in the cases where one of them is '\0' or '('. */
2637 if (*string2
== '\0')
2642 if (*string2
== '\0')
2647 if (*string2
== '\0' || *string2
== '(')
2656 if (case_pass
== case_sensitive_on
)
2659 /* Otherwise the strings were equal in case insensitive way, make
2660 a more fine grained comparison in a case sensitive way. */
2662 case_pass
= case_sensitive_on
;
2663 string1
= saved_string1
;
2664 string2
= saved_string2
;
2668 /* A simple comparison function with opposite semantics to strcmp. */
2671 streq (const char *lhs
, const char *rhs
)
2673 return !strcmp (lhs
, rhs
);
2679 ** Answer whether string_to_compare is a full or partial match to
2680 ** template_string. The partial match must be in sequence starting
2684 subset_compare (char *string_to_compare
, char *template_string
)
2688 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
2689 && strlen (string_to_compare
) <= strlen (template_string
))
2692 (template_string
, string_to_compare
, strlen (string_to_compare
)) == 0);
2699 pagination_on_command (char *arg
, int from_tty
)
2701 pagination_enabled
= 1;
2705 pagination_off_command (char *arg
, int from_tty
)
2707 pagination_enabled
= 0;
2711 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2712 struct cmd_list_element
*c
, const char *value
)
2714 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2720 initialize_utils (void)
2722 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
2723 Set number of characters where GDB should wrap lines of its output."), _("\
2724 Show number of characters where GDB should wrap lines of its output."), _("\
2725 This affects where GDB wraps its output to fit the screen width.\n\
2726 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2728 show_chars_per_line
,
2729 &setlist
, &showlist
);
2731 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
2732 Set number of lines in a page for GDB output pagination."), _("\
2733 Show number of lines in a page for GDB output pagination."), _("\
2734 This affects the number of lines after which GDB will pause\n\
2735 its output and ask you whether to continue.\n\
2736 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2738 show_lines_per_page
,
2739 &setlist
, &showlist
);
2743 add_setshow_boolean_cmd ("pagination", class_support
,
2744 &pagination_enabled
, _("\
2745 Set state of GDB output pagination."), _("\
2746 Show state of GDB output pagination."), _("\
2747 When pagination is ON, GDB pauses at end of each screenful of\n\
2748 its output and asks you whether to continue.\n\
2749 Turning pagination off is an alternative to \"set height unlimited\"."),
2751 show_pagination_enabled
,
2752 &setlist
, &showlist
);
2756 add_com ("am", class_support
, pagination_on_command
,
2757 _("Enable pagination"));
2758 add_com ("sm", class_support
, pagination_off_command
,
2759 _("Disable pagination"));
2762 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
2763 &sevenbit_strings
, _("\
2764 Set printing of 8-bit characters in strings as \\nnn."), _("\
2765 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
2767 show_sevenbit_strings
,
2768 &setprintlist
, &showprintlist
);
2770 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
2771 &debug_timestamp
, _("\
2772 Set timestamping of debugging messages."), _("\
2773 Show timestamping of debugging messages."), _("\
2774 When set, debugging messages will be marked with seconds and microseconds."),
2776 show_debug_timestamp
,
2777 &setdebuglist
, &showdebuglist
);
2781 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2783 /* Truncate address to the size of a target address, avoiding shifts
2784 larger or equal than the width of a CORE_ADDR. The local
2785 variable ADDR_BIT stops the compiler reporting a shift overflow
2786 when it won't occur. */
2787 /* NOTE: This assumes that the significant address information is
2788 kept in the least significant bits of ADDR - the upper bits were
2789 either zero or sign extended. Should gdbarch_address_to_pointer or
2790 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2792 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2794 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2795 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2796 return hex_string (addr
);
2799 /* This function is described in "defs.h". */
2802 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2804 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2806 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2807 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2809 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2810 that returns the language localized string formatted to a width
2811 based on gdbarch_addr_bit. */
2813 return hex_string_custom (address
, 8);
2815 return hex_string_custom (address
, 16);
2818 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2821 core_addr_hash (const void *ap
)
2823 const CORE_ADDR
*addrp
= ap
;
2828 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2831 core_addr_eq (const void *ap
, const void *bp
)
2833 const CORE_ADDR
*addr_ap
= ap
;
2834 const CORE_ADDR
*addr_bp
= bp
;
2836 return *addr_ap
== *addr_bp
;
2839 /* Convert a string back into a CORE_ADDR. */
2841 string_to_core_addr (const char *my_string
)
2845 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2847 /* Assume that it is in hex. */
2850 for (i
= 2; my_string
[i
] != '\0'; i
++)
2852 if (isdigit (my_string
[i
]))
2853 addr
= (my_string
[i
] - '0') + (addr
* 16);
2854 else if (isxdigit (my_string
[i
]))
2855 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2857 error (_("invalid hex \"%s\""), my_string
);
2862 /* Assume that it is in decimal. */
2865 for (i
= 0; my_string
[i
] != '\0'; i
++)
2867 if (isdigit (my_string
[i
]))
2868 addr
= (my_string
[i
] - '0') + (addr
* 10);
2870 error (_("invalid decimal \"%s\""), my_string
);
2878 gdb_realpath (const char *filename
)
2880 /* Method 1: The system has a compile time upper bound on a filename
2881 path. Use that and realpath() to canonicalize the name. This is
2882 the most common case. Note that, if there isn't a compile time
2883 upper bound, you want to avoid realpath() at all costs. */
2884 #if defined (HAVE_REALPATH) && defined (PATH_MAX)
2887 const char *rp
= realpath (filename
, buf
);
2891 return xstrdup (rp
);
2893 #endif /* HAVE_REALPATH */
2895 /* Method 2: The host system (i.e., GNU) has the function
2896 canonicalize_file_name() which malloc's a chunk of memory and
2897 returns that, use that. */
2898 #if defined(HAVE_CANONICALIZE_FILE_NAME)
2900 char *rp
= canonicalize_file_name (filename
);
2903 return xstrdup (filename
);
2909 /* FIXME: cagney/2002-11-13:
2911 Method 2a: Use realpath() with a NULL buffer. Some systems, due
2912 to the problems described in method 3, have modified their
2913 realpath() implementation so that it will allocate a buffer when
2914 NULL is passed in. Before this can be used, though, some sort of
2915 configure time test would need to be added. Otherwize the code
2916 will likely core dump. */
2918 /* Method 3: Now we're getting desperate! The system doesn't have a
2919 compile time buffer size and no alternative function. Query the
2920 OS, using pathconf(), for the buffer limit. Care is needed
2921 though, some systems do not limit PATH_MAX (return -1 for
2922 pathconf()) making it impossible to pass a correctly sized buffer
2923 to realpath() (it could always overflow). On those systems, we
2925 #if defined (HAVE_REALPATH) && defined (_PC_PATH_MAX) && defined(HAVE_ALLOCA)
2927 /* Find out the max path size. */
2928 long path_max
= pathconf ("/", _PC_PATH_MAX
);
2932 /* PATH_MAX is bounded. */
2933 char *buf
= alloca (path_max
);
2934 char *rp
= realpath (filename
, buf
);
2936 return xstrdup (rp
? rp
: filename
);
2941 /* The MS Windows method. If we don't have realpath, we assume we
2942 don't have symlinks and just canonicalize to a Windows absolute
2943 path. GetFullPath converts ../ and ./ in relative paths to
2944 absolute paths, filling in current drive if one is not given
2945 or using the current directory of a specified drive (eg, "E:foo").
2946 It also converts all forward slashes to back slashes. */
2947 /* The file system is case-insensitive but case-preserving.
2948 So we do not lowercase the path. Otherwise, we might not
2949 be able to display the original casing in a given path. */
2950 #if defined (_WIN32)
2953 DWORD len
= GetFullPathName (filename
, MAX_PATH
, buf
, NULL
);
2955 if (len
> 0 && len
< MAX_PATH
)
2956 return xstrdup (buf
);
2960 /* This system is a lost cause, just dup the buffer. */
2961 return xstrdup (filename
);
2964 /* Return a copy of FILENAME, with its directory prefix canonicalized
2968 gdb_realpath_keepfile (const char *filename
)
2970 const char *base_name
= lbasename (filename
);
2975 /* Extract the basename of filename, and return immediately
2976 a copy of filename if it does not contain any directory prefix. */
2977 if (base_name
== filename
)
2978 return xstrdup (filename
);
2980 dir_name
= alloca ((size_t) (base_name
- filename
+ 2));
2981 /* Allocate enough space to store the dir_name + plus one extra
2982 character sometimes needed under Windows (see below), and
2983 then the closing \000 character. */
2984 strncpy (dir_name
, filename
, base_name
- filename
);
2985 dir_name
[base_name
- filename
] = '\000';
2987 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
2988 /* We need to be careful when filename is of the form 'd:foo', which
2989 is equivalent of d:./foo, which is totally different from d:/foo. */
2990 if (strlen (dir_name
) == 2 && isalpha (dir_name
[0]) && dir_name
[1] == ':')
2993 dir_name
[3] = '\000';
2997 /* Canonicalize the directory prefix, and build the resulting
2998 filename. If the dirname realpath already contains an ending
2999 directory separator, avoid doubling it. */
3000 real_path
= gdb_realpath (dir_name
);
3001 if (IS_DIR_SEPARATOR (real_path
[strlen (real_path
) - 1]))
3002 result
= concat (real_path
, base_name
, (char *) NULL
);
3004 result
= concat (real_path
, SLASH_STRING
, base_name
, (char *) NULL
);
3010 /* Return PATH in absolute form, performing tilde-expansion if necessary.
3011 PATH cannot be NULL or the empty string.
3012 This does not resolve symlinks however, use gdb_realpath for that.
3013 Space for the result is allocated with malloc.
3014 If the path is already absolute, it is strdup'd.
3015 If there is a problem computing the absolute path, the path is returned
3016 unchanged (still strdup'd). */
3019 gdb_abspath (const char *path
)
3021 gdb_assert (path
!= NULL
&& path
[0] != '\0');
3024 return tilde_expand (path
);
3026 if (IS_ABSOLUTE_PATH (path
))
3027 return xstrdup (path
);
3029 /* Beware the // my son, the Emacs barfs, the botch that catch... */
3030 return concat (current_directory
,
3031 IS_DIR_SEPARATOR (current_directory
[strlen (current_directory
) - 1])
3032 ? "" : SLASH_STRING
,
3033 path
, (char *) NULL
);
3037 align_up (ULONGEST v
, int n
)
3039 /* Check that N is really a power of two. */
3040 gdb_assert (n
&& (n
& (n
-1)) == 0);
3041 return (v
+ n
- 1) & -n
;
3045 align_down (ULONGEST v
, int n
)
3047 /* Check that N is really a power of two. */
3048 gdb_assert (n
&& (n
& (n
-1)) == 0);
3055 gdb_sign_extend (LONGEST value
, int bit
)
3057 gdb_assert (bit
>= 1 && bit
<= 8 * sizeof (LONGEST
));
3059 if (((value
>> (bit
- 1)) & 1) != 0)
3061 LONGEST signbit
= ((LONGEST
) 1) << (bit
- 1);
3063 value
= (value
^ signbit
) - signbit
;
3069 /* Allocation function for the libiberty hash table which uses an
3070 obstack. The obstack is passed as DATA. */
3073 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
3075 size_t total
= size
* count
;
3076 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
3078 memset (ptr
, 0, total
);
3082 /* Trivial deallocation function for the libiberty splay tree and hash
3083 table - don't deallocate anything. Rely on later deletion of the
3084 obstack. DATA will be the obstack, although it is not needed
3088 dummy_obstack_deallocate (void *object
, void *data
)
3093 /* The bit offset of the highest byte in a ULONGEST, for overflow
3096 #define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT)
3098 /* True (non-zero) iff DIGIT is a valid digit in radix BASE,
3099 where 2 <= BASE <= 36. */
3102 is_digit_in_base (unsigned char digit
, int base
)
3104 if (!isalnum (digit
))
3107 return (isdigit (digit
) && digit
< base
+ '0');
3109 return (isdigit (digit
) || tolower (digit
) < base
- 10 + 'a');
3113 digit_to_int (unsigned char c
)
3118 return tolower (c
) - 'a' + 10;
3121 /* As for strtoul, but for ULONGEST results. */
3124 strtoulst (const char *num
, const char **trailer
, int base
)
3126 unsigned int high_part
;
3131 /* Skip leading whitespace. */
3132 while (isspace (num
[i
]))
3135 /* Handle prefixes. */
3138 else if (num
[i
] == '-')
3144 if (base
== 0 || base
== 16)
3146 if (num
[i
] == '0' && (num
[i
+ 1] == 'x' || num
[i
+ 1] == 'X'))
3154 if (base
== 0 && num
[i
] == '0')
3160 if (base
< 2 || base
> 36)
3166 result
= high_part
= 0;
3167 for (; is_digit_in_base (num
[i
], base
); i
+= 1)
3169 result
= result
* base
+ digit_to_int (num
[i
]);
3170 high_part
= high_part
* base
+ (unsigned int) (result
>> HIGH_BYTE_POSN
);
3171 result
&= ((ULONGEST
) 1 << HIGH_BYTE_POSN
) - 1;
3172 if (high_part
> 0xff)
3175 result
= ~ (ULONGEST
) 0;
3182 if (trailer
!= NULL
)
3185 result
= result
+ ((ULONGEST
) high_part
<< HIGH_BYTE_POSN
);
3192 /* Simple, portable version of dirname that does not modify its
3196 ldirname (const char *filename
)
3198 const char *base
= lbasename (filename
);
3201 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
3204 if (base
== filename
)
3207 dirname
= xmalloc (base
- filename
+ 2);
3208 memcpy (dirname
, filename
, base
- filename
);
3210 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3211 create "d:./bar" later instead of the (different) "d:/bar". */
3212 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3213 && !IS_DIR_SEPARATOR (filename
[0]))
3214 dirname
[base
++ - filename
] = '.';
3216 dirname
[base
- filename
] = '\0';
3220 /* Call libiberty's buildargv, and return the result.
3221 If buildargv fails due to out-of-memory, call nomem.
3222 Therefore, the returned value is guaranteed to be non-NULL,
3223 unless the parameter itself is NULL. */
3226 gdb_buildargv (const char *s
)
3228 char **argv
= buildargv (s
);
3230 if (s
!= NULL
&& argv
== NULL
)
3236 compare_positive_ints (const void *ap
, const void *bp
)
3238 /* Because we know we're comparing two ints which are positive,
3239 there's no danger of overflow here. */
3240 return * (int *) ap
- * (int *) bp
;
3243 /* String compare function for qsort. */
3246 compare_strings (const void *arg1
, const void *arg2
)
3248 const char **s1
= (const char **) arg1
;
3249 const char **s2
= (const char **) arg2
;
3251 return strcmp (*s1
, *s2
);
3254 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3255 #define AMBIGUOUS_MESS2 \
3256 ".\nUse \"set gnutarget format-name\" to specify the format."
3259 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3265 /* Check if errmsg just need simple return. */
3266 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3267 return bfd_errmsg (error_tag
);
3269 ret_len
= strlen (bfd_errmsg (error_tag
)) + strlen (AMBIGUOUS_MESS1
)
3270 + strlen (AMBIGUOUS_MESS2
);
3271 for (p
= matching
; *p
; p
++)
3272 ret_len
+= strlen (*p
) + 1;
3273 ret
= xmalloc (ret_len
+ 1);
3275 make_cleanup (xfree
, ret
);
3277 strcpy (retp
, bfd_errmsg (error_tag
));
3278 retp
+= strlen (retp
);
3280 strcpy (retp
, AMBIGUOUS_MESS1
);
3281 retp
+= strlen (retp
);
3283 for (p
= matching
; *p
; p
++)
3285 sprintf (retp
, " %s", *p
);
3286 retp
+= strlen (retp
);
3290 strcpy (retp
, AMBIGUOUS_MESS2
);
3295 /* Return ARGS parsed as a valid pid, or throw an error. */
3298 parse_pid_to_attach (const char *args
)
3304 error_no_arg (_("process-id to attach"));
3306 dummy
= (char *) args
;
3307 pid
= strtoul (args
, &dummy
, 0);
3308 /* Some targets don't set errno on errors, grrr! */
3309 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3310 error (_("Illegal process-id: %s."), args
);
3315 /* Helper for make_bpstat_clear_actions_cleanup. */
3318 do_bpstat_clear_actions_cleanup (void *unused
)
3320 bpstat_clear_actions ();
3323 /* Call bpstat_clear_actions for the case an exception is throw. You should
3324 discard_cleanups if no exception is caught. */
3327 make_bpstat_clear_actions_cleanup (void)
3329 return make_cleanup (do_bpstat_clear_actions_cleanup
, NULL
);
3332 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3333 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3334 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3337 producer_is_gcc_ge_4 (const char *producer
)
3342 if (producer
== NULL
)
3344 /* For unknown compilers expect their behavior is not compliant. For GCC
3345 this case can also happen for -gdwarf-4 type units supported since
3351 /* Skip any identifier after "GNU " - such as "C++" or "Java". */
3353 if (strncmp (producer
, "GNU ", strlen ("GNU ")) != 0)
3355 /* For non-GCC compilers expect their behavior is not compliant. */
3359 cs
= &producer
[strlen ("GNU ")];
3360 while (*cs
&& !isdigit (*cs
))
3362 if (sscanf (cs
, "%d.%d", &major
, &minor
) != 2)
3364 /* Not recognized as GCC. */
3376 /* Helper for make_cleanup_free_char_ptr_vec. */
3379 do_free_char_ptr_vec (void *arg
)
3381 VEC (char_ptr
) *char_ptr_vec
= arg
;
3383 free_char_ptr_vec (char_ptr_vec
);
3386 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3387 final VEC_free for CHAR_PTR_VEC itself.
3389 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3390 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3391 this function does not (cannot) clear the pointer. */
3394 make_cleanup_free_char_ptr_vec (VEC (char_ptr
) *char_ptr_vec
)
3396 return make_cleanup (do_free_char_ptr_vec
, char_ptr_vec
);
3399 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3400 must come from xrealloc-compatible allocator and it may be updated. FROM
3401 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3402 located at the start or end of *STRINGP. */
3405 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3407 char *string
= *stringp
, *s
;
3408 const size_t from_len
= strlen (from
);
3409 const size_t to_len
= strlen (to
);
3413 s
= strstr (s
, from
);
3417 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3418 || s
[-1] == DIRNAME_SEPARATOR
)
3419 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3420 || s
[from_len
] == DIRNAME_SEPARATOR
))
3424 string_new
= xrealloc (string
, (strlen (string
) + to_len
+ 1));
3426 /* Relocate the current S pointer. */
3427 s
= s
- string
+ string_new
;
3428 string
= string_new
;
3430 /* Replace from by to. */
3431 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3432 memcpy (s
, to
, to_len
);
3447 /* SIGALRM handler for waitpid_with_timeout. */
3450 sigalrm_handler (int signo
)
3452 /* Nothing to do. */
3457 /* Wrapper to wait for child PID to die with TIMEOUT.
3458 TIMEOUT is the time to stop waiting in seconds.
3459 If TIMEOUT is zero, pass WNOHANG to waitpid.
3460 Returns PID if it was successfully waited for, otherwise -1.
3462 Timeouts are currently implemented with alarm and SIGALRM.
3463 If the host does not support them, this waits "forever".
3464 It would be odd though for a host to have waitpid and not SIGALRM. */
3467 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3469 pid_t waitpid_result
;
3471 gdb_assert (pid
> 0);
3472 gdb_assert (timeout
>= 0);
3477 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3478 struct sigaction sa
, old_sa
;
3480 sa
.sa_handler
= sigalrm_handler
;
3481 sigemptyset (&sa
.sa_mask
);
3483 sigaction (SIGALRM
, &sa
, &old_sa
);
3487 ofunc
= (void (*)()) signal (SIGALRM
, sigalrm_handler
);
3493 waitpid_result
= waitpid (pid
, status
, 0);
3497 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3498 sigaction (SIGALRM
, &old_sa
, NULL
);
3500 signal (SIGALRM
, ofunc
);
3505 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3507 if (waitpid_result
== pid
)
3513 #endif /* HAVE_WAITPID */
3515 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3516 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3518 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3519 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3522 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3524 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3526 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3527 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3529 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3531 char *pattern_slash
, *string_slash
;
3533 /* Replace '\' by '/' in both strings. */
3535 pattern_slash
= alloca (strlen (pattern
) + 1);
3536 strcpy (pattern_slash
, pattern
);
3537 pattern
= pattern_slash
;
3538 for (; *pattern_slash
!= 0; pattern_slash
++)
3539 if (IS_DIR_SEPARATOR (*pattern_slash
))
3540 *pattern_slash
= '/';
3542 string_slash
= alloca (strlen (string
) + 1);
3543 strcpy (string_slash
, string
);
3544 string
= string_slash
;
3545 for (; *string_slash
!= 0; string_slash
++)
3546 if (IS_DIR_SEPARATOR (*string_slash
))
3547 *string_slash
= '/';
3549 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3551 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3552 flags
|= FNM_CASEFOLD
;
3553 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3555 return fnmatch (pattern
, string
, flags
);
3558 /* Provide a prototype to silence -Wmissing-prototypes. */
3559 extern initialize_file_ftype _initialize_utils
;
3562 _initialize_utils (void)
3564 add_internal_problem_command (&internal_error_problem
);
3565 add_internal_problem_command (&internal_warning_problem
);
3566 add_internal_problem_command (&demangler_warning_problem
);