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 /* Dump core trying to increase the core soft limit to hard limit first. */
557 #ifdef HAVE_SETRLIMIT
558 struct rlimit rlim
= { RLIM_INFINITY
, RLIM_INFINITY
};
560 setrlimit (RLIMIT_CORE
, &rlim
);
561 #endif /* HAVE_SETRLIMIT */
563 abort (); /* NOTE: GDB has only three calls to abort(). */
566 /* Check whether GDB will be able to dump core using the dump_core
567 function. Returns zero if GDB cannot or should not dump core.
568 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
569 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
572 can_dump_core (enum resource_limit_kind limit_kind
)
574 #ifdef HAVE_GETRLIMIT
577 /* Be quiet and assume we can dump if an error is returned. */
578 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
584 if (rlim
.rlim_cur
== 0)
588 if (rlim
.rlim_max
== 0)
591 #endif /* HAVE_GETRLIMIT */
596 /* Print a warning that we cannot dump core. */
599 warn_cant_dump_core (const char *reason
)
601 fprintf_unfiltered (gdb_stderr
,
602 _("%s\nUnable to dump core, use `ulimit -c"
603 " unlimited' before executing GDB next time.\n"),
607 /* Check whether GDB will be able to dump core using the dump_core
608 function, and print a warning if we cannot. */
611 can_dump_core_warn (enum resource_limit_kind limit_kind
,
614 int core_dump_allowed
= can_dump_core (limit_kind
);
616 if (!core_dump_allowed
)
617 warn_cant_dump_core (reason
);
619 return core_dump_allowed
;
622 /* Allow the user to configure the debugger behavior with respect to
623 what to do when an internal problem is detected. */
625 const char internal_problem_ask
[] = "ask";
626 const char internal_problem_yes
[] = "yes";
627 const char internal_problem_no
[] = "no";
628 static const char *const internal_problem_modes
[] =
630 internal_problem_ask
,
631 internal_problem_yes
,
636 /* Print a message reporting an internal error/warning. Ask the user
637 if they want to continue, dump core, or just exit. Return
638 something to indicate a quit. */
640 struct internal_problem
643 int user_settable_should_quit
;
644 const char *should_quit
;
645 int user_settable_should_dump_core
;
646 const char *should_dump_core
;
649 /* Report a problem, internal to GDB, to the user. Once the problem
650 has been reported, and assuming GDB didn't quit, the caller can
651 either allow execution to resume or throw an error. */
653 static void ATTRIBUTE_PRINTF (4, 0)
654 internal_vproblem (struct internal_problem
*problem
,
655 const char *file
, int line
, const char *fmt
, va_list ap
)
661 struct cleanup
*cleanup
= make_cleanup (null_cleanup
, NULL
);
663 /* Don't allow infinite error/warning recursion. */
665 static char msg
[] = "Recursive internal problem.\n";
674 fputs_unfiltered (msg
, gdb_stderr
);
675 abort (); /* NOTE: GDB has only three calls to abort(). */
678 /* Newer GLIBC versions put the warn_unused_result attribute
679 on write, but this is one of those rare cases where
680 ignoring the return value is correct. Casting to (void)
681 does not fix this problem. This is the solution suggested
682 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
683 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
684 abort (); /* NOTE: GDB has only three calls to abort(). */
689 /* Try to get the message out and at the start of a new line. */
690 target_terminal_ours ();
693 /* Create a string containing the full error/warning message. Need
694 to call query with this full string, as otherwize the reason
695 (error/warning) and question become separated. Format using a
696 style similar to a compiler error message. Include extra detail
697 so that the user knows that they are living on the edge. */
701 msg
= xstrvprintf (fmt
, ap
);
702 reason
= xstrprintf ("%s:%d: %s: %s\n"
703 "A problem internal to GDB has been detected,\n"
704 "further debugging may prove unreliable.",
705 file
, line
, problem
->name
, msg
);
707 make_cleanup (xfree
, reason
);
710 /* Emit the message unless query will emit it below. */
711 if (problem
->should_quit
!= internal_problem_ask
|| !confirm
)
712 fprintf_unfiltered (gdb_stderr
, "%s\n", reason
);
714 if (problem
->should_quit
== internal_problem_ask
)
716 /* Default (yes/batch case) is to quit GDB. When in batch mode
717 this lessens the likelihood of GDB going into an infinite
722 quit_p
= query (_("%s\nQuit this debugging session? "), reason
);
724 else if (problem
->should_quit
== internal_problem_yes
)
726 else if (problem
->should_quit
== internal_problem_no
)
729 internal_error (__FILE__
, __LINE__
, _("bad switch"));
731 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr
);
732 if (REPORT_BUGS_TO
[0])
733 fprintf_unfiltered (gdb_stderr
, _(" For instructions, see:\n%s."),
735 fputs_unfiltered ("\n\n", gdb_stderr
);
737 if (problem
->should_dump_core
== internal_problem_ask
)
739 if (!can_dump_core_warn (LIMIT_MAX
, reason
))
743 /* Default (yes/batch case) is to dump core. This leaves a GDB
744 `dropping' so that it is easier to see that something went
746 dump_core_p
= query (_("%s\nCreate a core file of GDB? "), reason
);
749 else if (problem
->should_dump_core
== internal_problem_yes
)
750 dump_core_p
= can_dump_core_warn (LIMIT_MAX
, reason
);
751 else if (problem
->should_dump_core
== internal_problem_no
)
754 internal_error (__FILE__
, __LINE__
, _("bad switch"));
767 #ifdef HAVE_WORKING_FORK
775 do_cleanups (cleanup
);
778 static struct internal_problem internal_error_problem
= {
779 "internal-error", 1, internal_problem_ask
, 1, internal_problem_ask
783 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
785 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
786 throw_quit (_("Command aborted."));
789 static struct internal_problem internal_warning_problem
= {
790 "internal-warning", 1, internal_problem_ask
, 1, internal_problem_ask
794 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
796 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
800 internal_warning (const char *file
, int line
, const char *string
, ...)
804 va_start (ap
, string
);
805 internal_vwarning (file
, line
, string
, ap
);
809 static struct internal_problem demangler_warning_problem
= {
810 "demangler-warning", 1, internal_problem_ask
, 0, internal_problem_no
814 demangler_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
816 internal_vproblem (&demangler_warning_problem
, file
, line
, fmt
, ap
);
820 demangler_warning (const char *file
, int line
, const char *string
, ...)
824 va_start (ap
, string
);
825 demangler_vwarning (file
, line
, string
, ap
);
829 /* Dummy functions to keep add_prefix_cmd happy. */
832 set_internal_problem_cmd (char *args
, int from_tty
)
837 show_internal_problem_cmd (char *args
, int from_tty
)
841 /* When GDB reports an internal problem (error or warning) it gives
842 the user the opportunity to quit GDB and/or create a core file of
843 the current debug session. This function registers a few commands
844 that make it possible to specify that GDB should always or never
845 quit or create a core file, without asking. The commands look
848 maint set PROBLEM-NAME quit ask|yes|no
849 maint show PROBLEM-NAME quit
850 maint set PROBLEM-NAME corefile ask|yes|no
851 maint show PROBLEM-NAME corefile
853 Where PROBLEM-NAME is currently "internal-error" or
854 "internal-warning". */
857 add_internal_problem_command (struct internal_problem
*problem
)
859 struct cmd_list_element
**set_cmd_list
;
860 struct cmd_list_element
**show_cmd_list
;
864 set_cmd_list
= xmalloc (sizeof (*set_cmd_list
));
865 show_cmd_list
= xmalloc (sizeof (*set_cmd_list
));
866 *set_cmd_list
= NULL
;
867 *show_cmd_list
= NULL
;
869 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
872 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
875 add_prefix_cmd ((char*) problem
->name
,
876 class_maintenance
, set_internal_problem_cmd
, set_doc
,
878 concat ("maintenance set ", problem
->name
, " ",
880 0/*allow-unknown*/, &maintenance_set_cmdlist
);
882 add_prefix_cmd ((char*) problem
->name
,
883 class_maintenance
, show_internal_problem_cmd
, show_doc
,
885 concat ("maintenance show ", problem
->name
, " ",
887 0/*allow-unknown*/, &maintenance_show_cmdlist
);
889 if (problem
->user_settable_should_quit
)
891 set_doc
= xstrprintf (_("Set whether GDB should quit "
892 "when an %s is detected"),
894 show_doc
= xstrprintf (_("Show whether GDB will quit "
895 "when an %s is detected"),
897 add_setshow_enum_cmd ("quit", class_maintenance
,
898 internal_problem_modes
,
899 &problem
->should_quit
,
912 if (problem
->user_settable_should_dump_core
)
914 set_doc
= xstrprintf (_("Set whether GDB should create a core "
915 "file of GDB when %s is detected"),
917 show_doc
= xstrprintf (_("Show whether GDB will create a core "
918 "file of GDB when %s is detected"),
920 add_setshow_enum_cmd ("corefile", class_maintenance
,
921 internal_problem_modes
,
922 &problem
->should_dump_core
,
936 /* Return a newly allocated string, containing the PREFIX followed
937 by the system error message for errno (separated by a colon).
939 The result must be deallocated after use. */
942 perror_string (const char *prefix
)
947 err
= safe_strerror (errno
);
948 combined
= (char *) xmalloc (strlen (err
) + strlen (prefix
) + 3);
949 strcpy (combined
, prefix
);
950 strcat (combined
, ": ");
951 strcat (combined
, err
);
956 /* Print the system error message for errno, and also mention STRING
957 as the file name for which the error was encountered. Use ERRCODE
958 for the thrown exception. Then return to command level. */
961 throw_perror_with_name (enum errors errcode
, const char *string
)
965 combined
= perror_string (string
);
966 make_cleanup (xfree
, combined
);
968 /* I understand setting these is a matter of taste. Still, some people
969 may clear errno but not know about bfd_error. Doing this here is not
971 bfd_set_error (bfd_error_no_error
);
974 throw_error (errcode
, _("%s."), combined
);
977 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
980 perror_with_name (const char *string
)
982 throw_perror_with_name (GENERIC_ERROR
, string
);
985 /* Same as perror_with_name except that it prints a warning instead
986 of throwing an error. */
989 perror_warning_with_name (const char *string
)
993 combined
= perror_string (string
);
994 warning (_("%s"), combined
);
998 /* Print the system error message for ERRCODE, and also mention STRING
999 as the file name for which the error was encountered. */
1002 print_sys_errmsg (const char *string
, int errcode
)
1007 err
= safe_strerror (errcode
);
1008 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
1009 strcpy (combined
, string
);
1010 strcat (combined
, ": ");
1011 strcat (combined
, err
);
1013 /* We want anything which was printed on stdout to come out first, before
1015 gdb_flush (gdb_stdout
);
1016 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
1019 /* Control C eventually causes this to be called, at a convenient time. */
1024 if (sync_quit_force_run
)
1026 sync_quit_force_run
= 0;
1027 quit_force (NULL
, stdin
== instream
);
1031 /* No steenking SIGINT will ever be coming our way when the
1032 program is resumed. Don't lie. */
1033 throw_quit ("Quit");
1036 /* If there is no terminal switching for this target, then we can't
1037 possibly get screwed by the lack of job control. */
1038 || !target_supports_terminal_ours ())
1039 throw_quit ("Quit");
1041 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
1046 /* Called when a memory allocation fails, with the number of bytes of
1047 memory requested in SIZE. */
1050 malloc_failure (long size
)
1054 internal_error (__FILE__
, __LINE__
,
1055 _("virtual memory exhausted: can't allocate %ld bytes."),
1060 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
1064 /* My replacement for the read system call.
1065 Used like `read' but keeps going if `read' returns too soon. */
1068 myread (int desc
, char *addr
, int len
)
1075 val
= read (desc
, addr
, len
);
1079 return orglen
- len
;
1087 print_spaces (int n
, struct ui_file
*file
)
1089 fputs_unfiltered (n_spaces (n
), file
);
1092 /* Print a host address. */
1095 gdb_print_host_address (const void *addr
, struct ui_file
*stream
)
1097 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
1101 /* A cleanup function that calls regfree. */
1104 do_regfree_cleanup (void *r
)
1109 /* Create a new cleanup that frees the compiled regular expression R. */
1112 make_regfree_cleanup (regex_t
*r
)
1114 return make_cleanup (do_regfree_cleanup
, r
);
1117 /* Return an xmalloc'd error message resulting from a regular
1118 expression compilation failure. */
1121 get_regcomp_error (int code
, regex_t
*rx
)
1123 size_t length
= regerror (code
, rx
, NULL
, 0);
1124 char *result
= xmalloc (length
);
1126 regerror (code
, rx
, result
, length
);
1130 /* Compile a regexp and throw an exception on error. This returns a
1131 cleanup to free the resulting pattern on success. RX must not be
1135 compile_rx_or_error (regex_t
*pattern
, const char *rx
, const char *message
)
1139 gdb_assert (rx
!= NULL
);
1141 code
= regcomp (pattern
, rx
, REG_NOSUB
);
1144 char *err
= get_regcomp_error (code
, pattern
);
1146 make_cleanup (xfree
, err
);
1147 error (("%s: %s"), message
, err
);
1150 return make_regfree_cleanup (pattern
);
1155 /* This function supports the query, nquery, and yquery functions.
1156 Ask user a y-or-n question and return 0 if answer is no, 1 if
1157 answer is yes, or default the answer to the specified default
1158 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1159 default answer, or '\0' for no default.
1160 CTLSTR is the control string and should end in "? ". It should
1161 not say how to answer, because we do that.
1162 ARGS are the arguments passed along with the CTLSTR argument to
1165 static int ATTRIBUTE_PRINTF (1, 0)
1166 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
1172 char def_answer
, not_def_answer
;
1173 char *y_string
, *n_string
, *question
;
1174 /* Used to add duration we waited for user to respond to
1175 prompt_for_continue_wait_time. */
1176 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1178 /* Set up according to which answer is the default. */
1179 if (defchar
== '\0')
1183 not_def_answer
= 'N';
1187 else if (defchar
== 'y')
1191 not_def_answer
= 'N';
1199 not_def_answer
= 'Y';
1204 /* Automatically answer the default value if the user did not want
1205 prompts or the command was issued with the server prefix. */
1206 if (!confirm
|| server_command
)
1209 /* If input isn't coming from the user directly, just say what
1210 question we're asking, and then answer the default automatically. This
1211 way, important error messages don't get lost when talking to GDB
1213 if (! input_from_terminal_p ())
1216 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
1218 printf_filtered (_("(%s or %s) [answered %c; "
1219 "input not from terminal]\n"),
1220 y_string
, n_string
, def_answer
);
1221 gdb_flush (gdb_stdout
);
1226 if (deprecated_query_hook
)
1228 return deprecated_query_hook (ctlstr
, args
);
1231 /* Format the question outside of the loop, to avoid reusing args. */
1232 question
= xstrvprintf (ctlstr
, args
);
1234 /* Used for calculating time spend waiting for user. */
1235 gettimeofday (&prompt_started
, NULL
);
1239 wrap_here (""); /* Flush any buffered output. */
1240 gdb_flush (gdb_stdout
);
1242 if (annotation_level
> 1)
1243 printf_filtered (("\n\032\032pre-query\n"));
1245 fputs_filtered (question
, gdb_stdout
);
1246 printf_filtered (_("(%s or %s) "), y_string
, n_string
);
1248 if (annotation_level
> 1)
1249 printf_filtered (("\n\032\032query\n"));
1252 gdb_flush (gdb_stdout
);
1254 answer
= fgetc (stdin
);
1256 /* We expect fgetc to block until a character is read. But
1257 this may not be the case if the terminal was opened with
1258 the NONBLOCK flag. In that case, if there is nothing to
1259 read on stdin, fgetc returns EOF, but also sets the error
1260 condition flag on stdin and errno to EAGAIN. With a true
1261 EOF, stdin's error condition flag is not set.
1263 A situation where this behavior was observed is a pseudo
1265 while (answer
== EOF
&& ferror (stdin
) && errno
== EAGAIN
)
1267 /* Not a real EOF. Wait a little while and try again until
1268 we read something. */
1271 answer
= fgetc (stdin
);
1274 clearerr (stdin
); /* in case of C-d */
1275 if (answer
== EOF
) /* C-d */
1277 printf_filtered ("EOF [assumed %c]\n", def_answer
);
1281 /* Eat rest of input line, to EOF or newline. */
1285 ans2
= fgetc (stdin
);
1288 while (ans2
!= EOF
&& ans2
!= '\n' && ans2
!= '\r');
1292 /* Check answer. For the non-default, the user must specify
1293 the non-default explicitly. */
1294 if (answer
== not_def_answer
)
1296 retval
= !def_value
;
1299 /* Otherwise, if a default was specified, the user may either
1300 specify the required input or have it default by entering
1302 if (answer
== def_answer
1303 || (defchar
!= '\0' &&
1304 (answer
== '\n' || answer
== '\r' || answer
== EOF
)))
1309 /* Invalid entries are not defaulted and require another selection. */
1310 printf_filtered (_("Please answer %s or %s.\n"),
1311 y_string
, n_string
);
1314 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1315 gettimeofday (&prompt_ended
, NULL
);
1316 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1317 timeval_add (&prompt_for_continue_wait_time
,
1318 &prompt_for_continue_wait_time
, &prompt_delta
);
1321 if (annotation_level
> 1)
1322 printf_filtered (("\n\032\032post-query\n"));
1327 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1328 answer is yes, or 0 if answer is defaulted.
1329 Takes three args which are given to printf to print the question.
1330 The first, a control string, should end in "? ".
1331 It should not say how to answer, because we do that. */
1334 nquery (const char *ctlstr
, ...)
1339 va_start (args
, ctlstr
);
1340 ret
= defaulted_query (ctlstr
, 'n', args
);
1345 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1346 answer is yes, or 1 if answer is defaulted.
1347 Takes three args which are given to printf to print the question.
1348 The first, a control string, should end in "? ".
1349 It should not say how to answer, because we do that. */
1352 yquery (const char *ctlstr
, ...)
1357 va_start (args
, ctlstr
);
1358 ret
= defaulted_query (ctlstr
, 'y', args
);
1363 /* Ask user a y-or-n question and return 1 iff answer is yes.
1364 Takes three args which are given to printf to print the question.
1365 The first, a control string, should end in "? ".
1366 It should not say how to answer, because we do that. */
1369 query (const char *ctlstr
, ...)
1374 va_start (args
, ctlstr
);
1375 ret
= defaulted_query (ctlstr
, '\0', args
);
1380 /* A helper for parse_escape that converts a host character to a
1381 target character. C is the host character. If conversion is
1382 possible, then the target character is stored in *TARGET_C and the
1383 function returns 1. Otherwise, the function returns 0. */
1386 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1388 struct obstack host_data
;
1390 struct cleanup
*cleanups
;
1393 obstack_init (&host_data
);
1394 cleanups
= make_cleanup_obstack_free (&host_data
);
1396 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1397 (gdb_byte
*) &the_char
, 1, 1,
1398 &host_data
, translit_none
);
1400 if (obstack_object_size (&host_data
) == 1)
1403 *target_c
= *(char *) obstack_base (&host_data
);
1406 do_cleanups (cleanups
);
1410 /* Parse a C escape sequence. STRING_PTR points to a variable
1411 containing a pointer to the string to parse. That pointer
1412 should point to the character after the \. That pointer
1413 is updated past the characters we use. The value of the
1414 escape sequence is returned.
1416 A negative value means the sequence \ newline was seen,
1417 which is supposed to be equivalent to nothing at all.
1419 If \ is followed by a null character, we return a negative
1420 value and leave the string pointer pointing at the null character.
1422 If \ is followed by 000, we return 0 and leave the string pointer
1423 after the zeros. A value of 0 does not mean end of string. */
1426 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1428 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1429 int c
= *(*string_ptr
)++;
1448 int i
= host_hex_value (c
);
1453 if (isdigit (c
) && c
!= '8' && c
!= '9')
1457 i
+= host_hex_value (c
);
1493 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1494 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1495 " which has no equivalent\nin the `%s' character set."),
1496 c
, c
, target_charset (gdbarch
));
1500 /* Print the character C on STREAM as part of the contents of a literal
1501 string whose delimiter is QUOTER. Note that this routine should only
1502 be call for printing things which are independent of the language
1503 of the program being debugged.
1505 printchar will normally escape backslashes and instances of QUOTER. If
1506 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1507 As a side effect, if you pass the backslash character as the QUOTER,
1508 printchar will escape backslashes as usual, but not any other quoting
1512 printchar (int c
, void (*do_fputs
) (const char *, struct ui_file
*),
1513 void (*do_fprintf
) (struct ui_file
*, const char *, ...)
1514 ATTRIBUTE_FPTR_PRINTF_2
, struct ui_file
*stream
, int quoter
)
1516 c
&= 0xFF; /* Avoid sign bit follies */
1518 if (c
< 0x20 || /* Low control chars */
1519 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1520 (sevenbit_strings
&& c
>= 0x80))
1521 { /* high order bit set */
1525 do_fputs ("\\n", stream
);
1528 do_fputs ("\\b", stream
);
1531 do_fputs ("\\t", stream
);
1534 do_fputs ("\\f", stream
);
1537 do_fputs ("\\r", stream
);
1540 do_fputs ("\\e", stream
);
1543 do_fputs ("\\a", stream
);
1546 do_fprintf (stream
, "\\%.3o", (unsigned int) c
);
1552 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1553 do_fputs ("\\", stream
);
1554 do_fprintf (stream
, "%c", c
);
1558 /* Print the character C on STREAM as part of the contents of a
1559 literal string whose delimiter is QUOTER. Note that these routines
1560 should only be call for printing things which are independent of
1561 the language of the program being debugged. */
1564 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1567 printchar (*str
++, fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1571 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1574 printchar (*str
++, fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1578 fputstrn_filtered (const char *str
, int n
, int quoter
,
1579 struct ui_file
*stream
)
1583 for (i
= 0; i
< n
; i
++)
1584 printchar (str
[i
], fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1588 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1589 struct ui_file
*stream
)
1593 for (i
= 0; i
< n
; i
++)
1594 printchar (str
[i
], fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1598 /* Number of lines per page or UINT_MAX if paging is disabled. */
1599 static unsigned int lines_per_page
;
1601 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1602 struct cmd_list_element
*c
, const char *value
)
1604 fprintf_filtered (file
,
1605 _("Number of lines gdb thinks are in a page is %s.\n"),
1609 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1610 static unsigned int chars_per_line
;
1612 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1613 struct cmd_list_element
*c
, const char *value
)
1615 fprintf_filtered (file
,
1616 _("Number of characters gdb thinks "
1617 "are in a line is %s.\n"),
1621 /* Current count of lines printed on this page, chars on this line. */
1622 static unsigned int lines_printed
, chars_printed
;
1624 /* Buffer and start column of buffered text, for doing smarter word-
1625 wrapping. When someone calls wrap_here(), we start buffering output
1626 that comes through fputs_filtered(). If we see a newline, we just
1627 spit it out and forget about the wrap_here(). If we see another
1628 wrap_here(), we spit it out and remember the newer one. If we see
1629 the end of the line, we spit out a newline, the indent, and then
1630 the buffered output. */
1632 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1633 are waiting to be output (they have already been counted in chars_printed).
1634 When wrap_buffer[0] is null, the buffer is empty. */
1635 static char *wrap_buffer
;
1637 /* Pointer in wrap_buffer to the next character to fill. */
1638 static char *wrap_pointer
;
1640 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1642 static char *wrap_indent
;
1644 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1645 is not in effect. */
1646 static int wrap_column
;
1649 /* Inialize the number of lines per page and chars per line. */
1652 init_page_info (void)
1656 lines_per_page
= UINT_MAX
;
1657 chars_per_line
= UINT_MAX
;
1661 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1666 #if defined(__GO32__)
1667 rows
= ScreenRows ();
1668 cols
= ScreenCols ();
1669 lines_per_page
= rows
;
1670 chars_per_line
= cols
;
1672 /* Make sure Readline has initialized its terminal settings. */
1673 rl_reset_terminal (NULL
);
1675 /* Get the screen size from Readline. */
1676 rl_get_screen_size (&rows
, &cols
);
1677 lines_per_page
= rows
;
1678 chars_per_line
= cols
;
1680 /* Readline should have fetched the termcap entry for us.
1681 Only try to use tgetnum function if rl_get_screen_size
1682 did not return a useful value. */
1683 if (((rows
<= 0) && (tgetnum ("li") < 0))
1684 /* Also disable paging if inside EMACS. */
1685 || getenv ("EMACS"))
1687 /* The number of lines per page is not mentioned in the terminal
1688 description or EMACS evironment variable is set. This probably
1689 means that paging is not useful, so disable paging. */
1690 lines_per_page
= UINT_MAX
;
1693 /* If the output is not a terminal, don't paginate it. */
1694 if (!ui_file_isatty (gdb_stdout
))
1695 lines_per_page
= UINT_MAX
;
1703 /* Helper for make_cleanup_restore_page_info. */
1706 do_restore_page_info_cleanup (void *arg
)
1712 /* Provide cleanup for restoring the terminal size. */
1715 make_cleanup_restore_page_info (void)
1717 struct cleanup
*back_to
;
1719 back_to
= make_cleanup (do_restore_page_info_cleanup
, NULL
);
1720 make_cleanup_restore_uinteger (&lines_per_page
);
1721 make_cleanup_restore_uinteger (&chars_per_line
);
1726 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1727 Provide cleanup for restoring the original state. */
1730 set_batch_flag_and_make_cleanup_restore_page_info (void)
1732 struct cleanup
*back_to
= make_cleanup_restore_page_info ();
1734 make_cleanup_restore_integer (&batch_flag
);
1741 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1744 set_screen_size (void)
1746 int rows
= lines_per_page
;
1747 int cols
= chars_per_line
;
1755 /* Update Readline's idea of the terminal size. */
1756 rl_set_screen_size (rows
, cols
);
1759 /* Reinitialize WRAP_BUFFER according to the current value of
1765 if (chars_per_line
== 0)
1770 wrap_buffer
= (char *) xmalloc (chars_per_line
+ 2);
1771 wrap_buffer
[0] = '\0';
1774 wrap_buffer
= (char *) xrealloc (wrap_buffer
, chars_per_line
+ 2);
1775 wrap_pointer
= wrap_buffer
; /* Start it at the beginning. */
1779 set_width_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1786 set_height_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1791 /* Wait, so the user can read what's on the screen. Prompt the user
1792 to continue by pressing RETURN. */
1795 prompt_for_continue (void)
1798 char cont_prompt
[120];
1799 /* Used to add duration we waited for user to respond to
1800 prompt_for_continue_wait_time. */
1801 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1803 gettimeofday (&prompt_started
, NULL
);
1805 if (annotation_level
> 1)
1806 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1808 strcpy (cont_prompt
,
1809 "---Type <return> to continue, or q <return> to quit---");
1810 if (annotation_level
> 1)
1811 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1813 /* We must do this *before* we call gdb_readline, else it will eventually
1814 call us -- thinking that we're trying to print beyond the end of the
1816 reinitialize_more_filter ();
1821 /* We'll need to handle input. */
1822 target_terminal_ours ();
1824 /* On a real operating system, the user can quit with SIGINT.
1827 'q' is provided on all systems so users don't have to change habits
1828 from system to system, and because telling them what to do in
1829 the prompt is more user-friendly than expecting them to think of
1831 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1832 whereas control-C to gdb_readline will cause the user to get dumped
1834 ignore
= gdb_readline_wrapper (cont_prompt
);
1836 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1837 gettimeofday (&prompt_ended
, NULL
);
1838 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1839 timeval_add (&prompt_for_continue_wait_time
,
1840 &prompt_for_continue_wait_time
, &prompt_delta
);
1842 if (annotation_level
> 1)
1843 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1849 while (*p
== ' ' || *p
== '\t')
1857 /* Now we have to do this again, so that GDB will know that it doesn't
1858 need to save the ---Type <return>--- line at the top of the screen. */
1859 reinitialize_more_filter ();
1861 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1864 /* Initalize timer to keep track of how long we waited for the user. */
1867 reset_prompt_for_continue_wait_time (void)
1869 static const struct timeval zero_timeval
= { 0 };
1871 prompt_for_continue_wait_time
= zero_timeval
;
1874 /* Fetch the cumulative time spent in prompt_for_continue. */
1877 get_prompt_for_continue_wait_time (void)
1879 return prompt_for_continue_wait_time
;
1882 /* Reinitialize filter; ie. tell it to reset to original values. */
1885 reinitialize_more_filter (void)
1891 /* Indicate that if the next sequence of characters overflows the line,
1892 a newline should be inserted here rather than when it hits the end.
1893 If INDENT is non-null, it is a string to be printed to indent the
1894 wrapped part on the next line. INDENT must remain accessible until
1895 the next call to wrap_here() or until a newline is printed through
1898 If the line is already overfull, we immediately print a newline and
1899 the indentation, and disable further wrapping.
1901 If we don't know the width of lines, but we know the page height,
1902 we must not wrap words, but should still keep track of newlines
1903 that were explicitly printed.
1905 INDENT should not contain tabs, as that will mess up the char count
1906 on the next line. FIXME.
1908 This routine is guaranteed to force out any output which has been
1909 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1910 used to force out output from the wrap_buffer. */
1913 wrap_here (char *indent
)
1915 /* This should have been allocated, but be paranoid anyway. */
1917 internal_error (__FILE__
, __LINE__
,
1918 _("failed internal consistency check"));
1922 *wrap_pointer
= '\0';
1923 fputs_unfiltered (wrap_buffer
, gdb_stdout
);
1925 wrap_pointer
= wrap_buffer
;
1926 wrap_buffer
[0] = '\0';
1927 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1931 else if (chars_printed
>= chars_per_line
)
1933 puts_filtered ("\n");
1935 puts_filtered (indent
);
1940 wrap_column
= chars_printed
;
1944 wrap_indent
= indent
;
1948 /* Print input string to gdb_stdout, filtered, with wrap,
1949 arranging strings in columns of n chars. String can be
1950 right or left justified in the column. Never prints
1951 trailing spaces. String should never be longer than
1952 width. FIXME: this could be useful for the EXAMINE
1953 command, which currently doesn't tabulate very well. */
1956 puts_filtered_tabular (char *string
, int width
, int right
)
1962 gdb_assert (chars_per_line
> 0);
1963 if (chars_per_line
== UINT_MAX
)
1965 fputs_filtered (string
, gdb_stdout
);
1966 fputs_filtered ("\n", gdb_stdout
);
1970 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1971 fputs_filtered ("\n", gdb_stdout
);
1973 if (width
>= chars_per_line
)
1974 width
= chars_per_line
- 1;
1976 stringlen
= strlen (string
);
1978 if (chars_printed
> 0)
1979 spaces
= width
- (chars_printed
- 1) % width
- 1;
1981 spaces
+= width
- stringlen
;
1983 spacebuf
= alloca (spaces
+ 1);
1984 spacebuf
[spaces
] = '\0';
1986 spacebuf
[spaces
] = ' ';
1988 fputs_filtered (spacebuf
, gdb_stdout
);
1989 fputs_filtered (string
, gdb_stdout
);
1993 /* Ensure that whatever gets printed next, using the filtered output
1994 commands, starts at the beginning of the line. I.e. if there is
1995 any pending output for the current line, flush it and start a new
1996 line. Otherwise do nothing. */
2001 if (chars_printed
> 0)
2003 puts_filtered ("\n");
2008 /* Like fputs but if FILTER is true, pause after every screenful.
2010 Regardless of FILTER can wrap at points other than the final
2011 character of a line.
2013 Unlike fputs, fputs_maybe_filtered does not return a value.
2014 It is OK for LINEBUFFER to be NULL, in which case just don't print
2017 Note that a longjmp to top level may occur in this routine (only if
2018 FILTER is true) (since prompt_for_continue may do so) so this
2019 routine should not be called when cleanups are not in place. */
2022 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
2025 const char *lineptr
;
2027 if (linebuffer
== 0)
2030 /* Don't do any filtering if it is disabled. */
2031 if (stream
!= gdb_stdout
2032 || !pagination_enabled
2034 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
2035 || top_level_interpreter () == NULL
2036 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2038 fputs_unfiltered (linebuffer
, stream
);
2042 /* Go through and output each character. Show line extension
2043 when this is necessary; prompt user for new page when this is
2046 lineptr
= linebuffer
;
2049 /* Possible new page. */
2050 if (filter
&& (lines_printed
>= lines_per_page
- 1))
2051 prompt_for_continue ();
2053 while (*lineptr
&& *lineptr
!= '\n')
2055 /* Print a single line. */
2056 if (*lineptr
== '\t')
2059 *wrap_pointer
++ = '\t';
2061 fputc_unfiltered ('\t', stream
);
2062 /* Shifting right by 3 produces the number of tab stops
2063 we have already passed, and then adding one and
2064 shifting left 3 advances to the next tab stop. */
2065 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
2071 *wrap_pointer
++ = *lineptr
;
2073 fputc_unfiltered (*lineptr
, stream
);
2078 if (chars_printed
>= chars_per_line
)
2080 unsigned int save_chars
= chars_printed
;
2084 /* If we aren't actually wrapping, don't output newline --
2085 if chars_per_line is right, we probably just overflowed
2086 anyway; if it's wrong, let us keep going. */
2088 fputc_unfiltered ('\n', stream
);
2090 /* Possible new page. */
2091 if (lines_printed
>= lines_per_page
- 1)
2092 prompt_for_continue ();
2094 /* Now output indentation and wrapped string. */
2097 fputs_unfiltered (wrap_indent
, stream
);
2098 *wrap_pointer
= '\0'; /* Null-terminate saved stuff, */
2099 fputs_unfiltered (wrap_buffer
, stream
); /* and eject it. */
2100 /* FIXME, this strlen is what prevents wrap_indent from
2101 containing tabs. However, if we recurse to print it
2102 and count its chars, we risk trouble if wrap_indent is
2103 longer than (the user settable) chars_per_line.
2104 Note also that this can set chars_printed > chars_per_line
2105 if we are printing a long string. */
2106 chars_printed
= strlen (wrap_indent
)
2107 + (save_chars
- wrap_column
);
2108 wrap_pointer
= wrap_buffer
; /* Reset buffer */
2109 wrap_buffer
[0] = '\0';
2110 wrap_column
= 0; /* And disable fancy wrap */
2115 if (*lineptr
== '\n')
2118 wrap_here ((char *) 0); /* Spit out chars, cancel
2121 fputc_unfiltered ('\n', stream
);
2128 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
2130 fputs_maybe_filtered (linebuffer
, stream
, 1);
2134 putchar_unfiltered (int c
)
2138 ui_file_write (gdb_stdout
, &buf
, 1);
2142 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2143 May return nonlocally. */
2146 putchar_filtered (int c
)
2148 return fputc_filtered (c
, gdb_stdout
);
2152 fputc_unfiltered (int c
, struct ui_file
*stream
)
2156 ui_file_write (stream
, &buf
, 1);
2161 fputc_filtered (int c
, struct ui_file
*stream
)
2167 fputs_filtered (buf
, stream
);
2171 /* puts_debug is like fputs_unfiltered, except it prints special
2172 characters in printable fashion. */
2175 puts_debug (char *prefix
, char *string
, char *suffix
)
2179 /* Print prefix and suffix after each line. */
2180 static int new_line
= 1;
2181 static int return_p
= 0;
2182 static char *prev_prefix
= "";
2183 static char *prev_suffix
= "";
2185 if (*string
== '\n')
2188 /* If the prefix is changing, print the previous suffix, a new line,
2189 and the new prefix. */
2190 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
2192 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
2193 fputs_unfiltered ("\n", gdb_stdlog
);
2194 fputs_unfiltered (prefix
, gdb_stdlog
);
2197 /* Print prefix if we printed a newline during the previous call. */
2201 fputs_unfiltered (prefix
, gdb_stdlog
);
2204 prev_prefix
= prefix
;
2205 prev_suffix
= suffix
;
2207 /* Output characters in a printable format. */
2208 while ((ch
= *string
++) != '\0')
2214 fputc_unfiltered (ch
, gdb_stdlog
);
2217 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2221 fputs_unfiltered ("\\\\", gdb_stdlog
);
2224 fputs_unfiltered ("\\b", gdb_stdlog
);
2227 fputs_unfiltered ("\\f", gdb_stdlog
);
2231 fputs_unfiltered ("\\n", gdb_stdlog
);
2234 fputs_unfiltered ("\\r", gdb_stdlog
);
2237 fputs_unfiltered ("\\t", gdb_stdlog
);
2240 fputs_unfiltered ("\\v", gdb_stdlog
);
2244 return_p
= ch
== '\r';
2247 /* Print suffix if we printed a newline. */
2250 fputs_unfiltered (suffix
, gdb_stdlog
);
2251 fputs_unfiltered ("\n", gdb_stdlog
);
2256 /* Print a variable number of ARGS using format FORMAT. If this
2257 information is going to put the amount written (since the last call
2258 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2259 call prompt_for_continue to get the users permision to continue.
2261 Unlike fprintf, this function does not return a value.
2263 We implement three variants, vfprintf (takes a vararg list and stream),
2264 fprintf (takes a stream to write on), and printf (the usual).
2266 Note also that a longjmp to top level may occur in this routine
2267 (since prompt_for_continue may do so) so this routine should not be
2268 called when cleanups are not in place. */
2271 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2272 va_list args
, int filter
)
2275 struct cleanup
*old_cleanups
;
2277 linebuffer
= xstrvprintf (format
, args
);
2278 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2279 fputs_maybe_filtered (linebuffer
, stream
, filter
);
2280 do_cleanups (old_cleanups
);
2285 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2287 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2291 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2294 struct cleanup
*old_cleanups
;
2296 linebuffer
= xstrvprintf (format
, args
);
2297 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2298 if (debug_timestamp
&& stream
== gdb_stdlog
)
2304 gettimeofday (&tm
, NULL
);
2306 len
= strlen (linebuffer
);
2307 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2309 timestamp
= xstrprintf ("%ld:%ld %s%s",
2310 (long) tm
.tv_sec
, (long) tm
.tv_usec
,
2312 need_nl
? "\n": "");
2313 make_cleanup (xfree
, timestamp
);
2314 fputs_unfiltered (timestamp
, stream
);
2317 fputs_unfiltered (linebuffer
, stream
);
2318 do_cleanups (old_cleanups
);
2322 vprintf_filtered (const char *format
, va_list args
)
2324 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2328 vprintf_unfiltered (const char *format
, va_list args
)
2330 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2334 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2338 va_start (args
, format
);
2339 vfprintf_filtered (stream
, format
, args
);
2344 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2348 va_start (args
, format
);
2349 vfprintf_unfiltered (stream
, format
, args
);
2353 /* Like fprintf_filtered, but prints its result indented.
2354 Called as fprintfi_filtered (spaces, stream, format, ...); */
2357 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2362 va_start (args
, format
);
2363 print_spaces_filtered (spaces
, stream
);
2365 vfprintf_filtered (stream
, format
, args
);
2371 printf_filtered (const char *format
, ...)
2375 va_start (args
, format
);
2376 vfprintf_filtered (gdb_stdout
, format
, args
);
2382 printf_unfiltered (const char *format
, ...)
2386 va_start (args
, format
);
2387 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2391 /* Like printf_filtered, but prints it's result indented.
2392 Called as printfi_filtered (spaces, format, ...); */
2395 printfi_filtered (int spaces
, const char *format
, ...)
2399 va_start (args
, format
);
2400 print_spaces_filtered (spaces
, gdb_stdout
);
2401 vfprintf_filtered (gdb_stdout
, format
, args
);
2405 /* Easy -- but watch out!
2407 This routine is *not* a replacement for puts()! puts() appends a newline.
2408 This one doesn't, and had better not! */
2411 puts_filtered (const char *string
)
2413 fputs_filtered (string
, gdb_stdout
);
2417 puts_unfiltered (const char *string
)
2419 fputs_unfiltered (string
, gdb_stdout
);
2422 /* Return a pointer to N spaces and a null. The pointer is good
2423 until the next call to here. */
2428 static char *spaces
= 0;
2429 static int max_spaces
= -1;
2435 spaces
= (char *) xmalloc (n
+ 1);
2436 for (t
= spaces
+ n
; t
!= spaces
;)
2442 return spaces
+ max_spaces
- n
;
2445 /* Print N spaces. */
2447 print_spaces_filtered (int n
, struct ui_file
*stream
)
2449 fputs_filtered (n_spaces (n
), stream
);
2452 /* C++/ObjC demangler stuff. */
2454 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2455 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2456 If the name is not mangled, or the language for the name is unknown, or
2457 demangling is off, the name is printed in its "raw" form. */
2460 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2461 enum language lang
, int arg_mode
)
2467 /* If user wants to see raw output, no problem. */
2470 fputs_filtered (name
, stream
);
2474 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2475 fputs_filtered (demangled
? demangled
: name
, stream
);
2476 if (demangled
!= NULL
)
2484 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2485 differences in whitespace. Returns 0 if they match, non-zero if they
2486 don't (slightly different than strcmp()'s range of return values).
2488 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2489 This "feature" is useful when searching for matching C++ function names
2490 (such as if the user types 'break FOO', where FOO is a mangled C++
2494 strcmp_iw (const char *string1
, const char *string2
)
2496 while ((*string1
!= '\0') && (*string2
!= '\0'))
2498 while (isspace (*string1
))
2502 while (isspace (*string2
))
2506 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2508 if (case_sensitivity
== case_sensitive_off
2509 && (tolower ((unsigned char) *string1
)
2510 != tolower ((unsigned char) *string2
)))
2512 if (*string1
!= '\0')
2518 return (*string1
!= '\0' && *string1
!= '(') || (*string2
!= '\0');
2521 /* This is like strcmp except that it ignores whitespace and treats
2522 '(' as the first non-NULL character in terms of ordering. Like
2523 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2524 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2525 according to that ordering.
2527 If a list is sorted according to this function and if you want to
2528 find names in the list that match some fixed NAME according to
2529 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2530 where this function would put NAME.
2532 This function must be neutral to the CASE_SENSITIVITY setting as the user
2533 may choose it during later lookup. Therefore this function always sorts
2534 primarily case-insensitively and secondarily case-sensitively.
2536 Here are some examples of why using strcmp to sort is a bad idea:
2540 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2541 we try to do a search for "foo<char*>", strcmp will locate this
2542 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2543 will start looking at strings beginning with "goo", and will never
2544 see the correct match of "foo<char *>".
2546 Parenthesis example:
2548 In practice, this is less like to be an issue, but I'll give it a
2549 shot. Let's assume that '$' is a legitimate character to occur in
2550 symbols. (Which may well even be the case on some systems.) Then
2551 say that the partial symbol table contains "foo$" and "foo(int)".
2552 strcmp will put them in this order, since '$' < '('. Now, if the
2553 user searches for "foo", then strcmp will sort "foo" before "foo$".
2554 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2555 "foo") is false, so it won't proceed to the actual match of
2556 "foo(int)" with "foo". */
2559 strcmp_iw_ordered (const char *string1
, const char *string2
)
2561 const char *saved_string1
= string1
, *saved_string2
= string2
;
2562 enum case_sensitivity case_pass
= case_sensitive_off
;
2566 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2567 Provide stub characters if we are already at the end of one of the
2569 char c1
= 'X', c2
= 'X';
2571 while (*string1
!= '\0' && *string2
!= '\0')
2573 while (isspace (*string1
))
2575 while (isspace (*string2
))
2580 case case_sensitive_off
:
2581 c1
= tolower ((unsigned char) *string1
);
2582 c2
= tolower ((unsigned char) *string2
);
2584 case case_sensitive_on
:
2592 if (*string1
!= '\0')
2601 /* Characters are non-equal unless they're both '\0'; we want to
2602 make sure we get the comparison right according to our
2603 comparison in the cases where one of them is '\0' or '('. */
2605 if (*string2
== '\0')
2610 if (*string2
== '\0')
2615 if (*string2
== '\0' || *string2
== '(')
2624 if (case_pass
== case_sensitive_on
)
2627 /* Otherwise the strings were equal in case insensitive way, make
2628 a more fine grained comparison in a case sensitive way. */
2630 case_pass
= case_sensitive_on
;
2631 string1
= saved_string1
;
2632 string2
= saved_string2
;
2636 /* A simple comparison function with opposite semantics to strcmp. */
2639 streq (const char *lhs
, const char *rhs
)
2641 return !strcmp (lhs
, rhs
);
2647 ** Answer whether string_to_compare is a full or partial match to
2648 ** template_string. The partial match must be in sequence starting
2652 subset_compare (char *string_to_compare
, char *template_string
)
2656 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
2657 && strlen (string_to_compare
) <= strlen (template_string
))
2660 (template_string
, string_to_compare
, strlen (string_to_compare
)) == 0);
2667 pagination_on_command (char *arg
, int from_tty
)
2669 pagination_enabled
= 1;
2673 pagination_off_command (char *arg
, int from_tty
)
2675 pagination_enabled
= 0;
2679 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2680 struct cmd_list_element
*c
, const char *value
)
2682 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2688 initialize_utils (void)
2690 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
2691 Set number of characters where GDB should wrap lines of its output."), _("\
2692 Show number of characters where GDB should wrap lines of its output."), _("\
2693 This affects where GDB wraps its output to fit the screen width.\n\
2694 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2696 show_chars_per_line
,
2697 &setlist
, &showlist
);
2699 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
2700 Set number of lines in a page for GDB output pagination."), _("\
2701 Show number of lines in a page for GDB output pagination."), _("\
2702 This affects the number of lines after which GDB will pause\n\
2703 its output and ask you whether to continue.\n\
2704 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2706 show_lines_per_page
,
2707 &setlist
, &showlist
);
2711 add_setshow_boolean_cmd ("pagination", class_support
,
2712 &pagination_enabled
, _("\
2713 Set state of GDB output pagination."), _("\
2714 Show state of GDB output pagination."), _("\
2715 When pagination is ON, GDB pauses at end of each screenful of\n\
2716 its output and asks you whether to continue.\n\
2717 Turning pagination off is an alternative to \"set height unlimited\"."),
2719 show_pagination_enabled
,
2720 &setlist
, &showlist
);
2724 add_com ("am", class_support
, pagination_on_command
,
2725 _("Enable pagination"));
2726 add_com ("sm", class_support
, pagination_off_command
,
2727 _("Disable pagination"));
2730 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
2731 &sevenbit_strings
, _("\
2732 Set printing of 8-bit characters in strings as \\nnn."), _("\
2733 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
2735 show_sevenbit_strings
,
2736 &setprintlist
, &showprintlist
);
2738 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
2739 &debug_timestamp
, _("\
2740 Set timestamping of debugging messages."), _("\
2741 Show timestamping of debugging messages."), _("\
2742 When set, debugging messages will be marked with seconds and microseconds."),
2744 show_debug_timestamp
,
2745 &setdebuglist
, &showdebuglist
);
2749 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2751 /* Truncate address to the size of a target address, avoiding shifts
2752 larger or equal than the width of a CORE_ADDR. The local
2753 variable ADDR_BIT stops the compiler reporting a shift overflow
2754 when it won't occur. */
2755 /* NOTE: This assumes that the significant address information is
2756 kept in the least significant bits of ADDR - the upper bits were
2757 either zero or sign extended. Should gdbarch_address_to_pointer or
2758 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2760 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2762 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2763 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2764 return hex_string (addr
);
2767 /* This function is described in "defs.h". */
2770 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2772 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2774 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2775 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2777 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2778 that returns the language localized string formatted to a width
2779 based on gdbarch_addr_bit. */
2781 return hex_string_custom (address
, 8);
2783 return hex_string_custom (address
, 16);
2786 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2789 core_addr_hash (const void *ap
)
2791 const CORE_ADDR
*addrp
= ap
;
2796 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2799 core_addr_eq (const void *ap
, const void *bp
)
2801 const CORE_ADDR
*addr_ap
= ap
;
2802 const CORE_ADDR
*addr_bp
= bp
;
2804 return *addr_ap
== *addr_bp
;
2807 /* Convert a string back into a CORE_ADDR. */
2809 string_to_core_addr (const char *my_string
)
2813 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2815 /* Assume that it is in hex. */
2818 for (i
= 2; my_string
[i
] != '\0'; i
++)
2820 if (isdigit (my_string
[i
]))
2821 addr
= (my_string
[i
] - '0') + (addr
* 16);
2822 else if (isxdigit (my_string
[i
]))
2823 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2825 error (_("invalid hex \"%s\""), my_string
);
2830 /* Assume that it is in decimal. */
2833 for (i
= 0; my_string
[i
] != '\0'; i
++)
2835 if (isdigit (my_string
[i
]))
2836 addr
= (my_string
[i
] - '0') + (addr
* 10);
2838 error (_("invalid decimal \"%s\""), my_string
);
2846 gdb_realpath (const char *filename
)
2848 /* Method 1: The system has a compile time upper bound on a filename
2849 path. Use that and realpath() to canonicalize the name. This is
2850 the most common case. Note that, if there isn't a compile time
2851 upper bound, you want to avoid realpath() at all costs. */
2852 #if defined (HAVE_REALPATH) && defined (PATH_MAX)
2855 const char *rp
= realpath (filename
, buf
);
2859 return xstrdup (rp
);
2861 #endif /* HAVE_REALPATH */
2863 /* Method 2: The host system (i.e., GNU) has the function
2864 canonicalize_file_name() which malloc's a chunk of memory and
2865 returns that, use that. */
2866 #if defined(HAVE_CANONICALIZE_FILE_NAME)
2868 char *rp
= canonicalize_file_name (filename
);
2871 return xstrdup (filename
);
2877 /* FIXME: cagney/2002-11-13:
2879 Method 2a: Use realpath() with a NULL buffer. Some systems, due
2880 to the problems described in method 3, have modified their
2881 realpath() implementation so that it will allocate a buffer when
2882 NULL is passed in. Before this can be used, though, some sort of
2883 configure time test would need to be added. Otherwize the code
2884 will likely core dump. */
2886 /* Method 3: Now we're getting desperate! The system doesn't have a
2887 compile time buffer size and no alternative function. Query the
2888 OS, using pathconf(), for the buffer limit. Care is needed
2889 though, some systems do not limit PATH_MAX (return -1 for
2890 pathconf()) making it impossible to pass a correctly sized buffer
2891 to realpath() (it could always overflow). On those systems, we
2893 #if defined (HAVE_REALPATH) && defined (_PC_PATH_MAX) && defined(HAVE_ALLOCA)
2895 /* Find out the max path size. */
2896 long path_max
= pathconf ("/", _PC_PATH_MAX
);
2900 /* PATH_MAX is bounded. */
2901 char *buf
= alloca (path_max
);
2902 char *rp
= realpath (filename
, buf
);
2904 return xstrdup (rp
? rp
: filename
);
2909 /* The MS Windows method. If we don't have realpath, we assume we
2910 don't have symlinks and just canonicalize to a Windows absolute
2911 path. GetFullPath converts ../ and ./ in relative paths to
2912 absolute paths, filling in current drive if one is not given
2913 or using the current directory of a specified drive (eg, "E:foo").
2914 It also converts all forward slashes to back slashes. */
2915 /* The file system is case-insensitive but case-preserving.
2916 So we do not lowercase the path. Otherwise, we might not
2917 be able to display the original casing in a given path. */
2918 #if defined (_WIN32)
2921 DWORD len
= GetFullPathName (filename
, MAX_PATH
, buf
, NULL
);
2923 if (len
> 0 && len
< MAX_PATH
)
2924 return xstrdup (buf
);
2928 /* This system is a lost cause, just dup the buffer. */
2929 return xstrdup (filename
);
2932 /* Return a copy of FILENAME, with its directory prefix canonicalized
2936 gdb_realpath_keepfile (const char *filename
)
2938 const char *base_name
= lbasename (filename
);
2943 /* Extract the basename of filename, and return immediately
2944 a copy of filename if it does not contain any directory prefix. */
2945 if (base_name
== filename
)
2946 return xstrdup (filename
);
2948 dir_name
= alloca ((size_t) (base_name
- filename
+ 2));
2949 /* Allocate enough space to store the dir_name + plus one extra
2950 character sometimes needed under Windows (see below), and
2951 then the closing \000 character. */
2952 strncpy (dir_name
, filename
, base_name
- filename
);
2953 dir_name
[base_name
- filename
] = '\000';
2955 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
2956 /* We need to be careful when filename is of the form 'd:foo', which
2957 is equivalent of d:./foo, which is totally different from d:/foo. */
2958 if (strlen (dir_name
) == 2 && isalpha (dir_name
[0]) && dir_name
[1] == ':')
2961 dir_name
[3] = '\000';
2965 /* Canonicalize the directory prefix, and build the resulting
2966 filename. If the dirname realpath already contains an ending
2967 directory separator, avoid doubling it. */
2968 real_path
= gdb_realpath (dir_name
);
2969 if (IS_DIR_SEPARATOR (real_path
[strlen (real_path
) - 1]))
2970 result
= concat (real_path
, base_name
, (char *) NULL
);
2972 result
= concat (real_path
, SLASH_STRING
, base_name
, (char *) NULL
);
2978 /* Return PATH in absolute form, performing tilde-expansion if necessary.
2979 PATH cannot be NULL or the empty string.
2980 This does not resolve symlinks however, use gdb_realpath for that.
2981 Space for the result is allocated with malloc.
2982 If the path is already absolute, it is strdup'd.
2983 If there is a problem computing the absolute path, the path is returned
2984 unchanged (still strdup'd). */
2987 gdb_abspath (const char *path
)
2989 gdb_assert (path
!= NULL
&& path
[0] != '\0');
2992 return tilde_expand (path
);
2994 if (IS_ABSOLUTE_PATH (path
))
2995 return xstrdup (path
);
2997 /* Beware the // my son, the Emacs barfs, the botch that catch... */
2998 return concat (current_directory
,
2999 IS_DIR_SEPARATOR (current_directory
[strlen (current_directory
) - 1])
3000 ? "" : SLASH_STRING
,
3001 path
, (char *) NULL
);
3005 align_up (ULONGEST v
, int n
)
3007 /* Check that N is really a power of two. */
3008 gdb_assert (n
&& (n
& (n
-1)) == 0);
3009 return (v
+ n
- 1) & -n
;
3013 align_down (ULONGEST v
, int n
)
3015 /* Check that N is really a power of two. */
3016 gdb_assert (n
&& (n
& (n
-1)) == 0);
3023 gdb_sign_extend (LONGEST value
, int bit
)
3025 gdb_assert (bit
>= 1 && bit
<= 8 * sizeof (LONGEST
));
3027 if (((value
>> (bit
- 1)) & 1) != 0)
3029 LONGEST signbit
= ((LONGEST
) 1) << (bit
- 1);
3031 value
= (value
^ signbit
) - signbit
;
3037 /* Allocation function for the libiberty hash table which uses an
3038 obstack. The obstack is passed as DATA. */
3041 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
3043 size_t total
= size
* count
;
3044 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
3046 memset (ptr
, 0, total
);
3050 /* Trivial deallocation function for the libiberty splay tree and hash
3051 table - don't deallocate anything. Rely on later deletion of the
3052 obstack. DATA will be the obstack, although it is not needed
3056 dummy_obstack_deallocate (void *object
, void *data
)
3061 /* The bit offset of the highest byte in a ULONGEST, for overflow
3064 #define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT)
3066 /* True (non-zero) iff DIGIT is a valid digit in radix BASE,
3067 where 2 <= BASE <= 36. */
3070 is_digit_in_base (unsigned char digit
, int base
)
3072 if (!isalnum (digit
))
3075 return (isdigit (digit
) && digit
< base
+ '0');
3077 return (isdigit (digit
) || tolower (digit
) < base
- 10 + 'a');
3081 digit_to_int (unsigned char c
)
3086 return tolower (c
) - 'a' + 10;
3089 /* As for strtoul, but for ULONGEST results. */
3092 strtoulst (const char *num
, const char **trailer
, int base
)
3094 unsigned int high_part
;
3099 /* Skip leading whitespace. */
3100 while (isspace (num
[i
]))
3103 /* Handle prefixes. */
3106 else if (num
[i
] == '-')
3112 if (base
== 0 || base
== 16)
3114 if (num
[i
] == '0' && (num
[i
+ 1] == 'x' || num
[i
+ 1] == 'X'))
3122 if (base
== 0 && num
[i
] == '0')
3128 if (base
< 2 || base
> 36)
3134 result
= high_part
= 0;
3135 for (; is_digit_in_base (num
[i
], base
); i
+= 1)
3137 result
= result
* base
+ digit_to_int (num
[i
]);
3138 high_part
= high_part
* base
+ (unsigned int) (result
>> HIGH_BYTE_POSN
);
3139 result
&= ((ULONGEST
) 1 << HIGH_BYTE_POSN
) - 1;
3140 if (high_part
> 0xff)
3143 result
= ~ (ULONGEST
) 0;
3150 if (trailer
!= NULL
)
3153 result
= result
+ ((ULONGEST
) high_part
<< HIGH_BYTE_POSN
);
3160 /* Simple, portable version of dirname that does not modify its
3164 ldirname (const char *filename
)
3166 const char *base
= lbasename (filename
);
3169 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
3172 if (base
== filename
)
3175 dirname
= xmalloc (base
- filename
+ 2);
3176 memcpy (dirname
, filename
, base
- filename
);
3178 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3179 create "d:./bar" later instead of the (different) "d:/bar". */
3180 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3181 && !IS_DIR_SEPARATOR (filename
[0]))
3182 dirname
[base
++ - filename
] = '.';
3184 dirname
[base
- filename
] = '\0';
3188 /* Call libiberty's buildargv, and return the result.
3189 If buildargv fails due to out-of-memory, call nomem.
3190 Therefore, the returned value is guaranteed to be non-NULL,
3191 unless the parameter itself is NULL. */
3194 gdb_buildargv (const char *s
)
3196 char **argv
= buildargv (s
);
3198 if (s
!= NULL
&& argv
== NULL
)
3204 compare_positive_ints (const void *ap
, const void *bp
)
3206 /* Because we know we're comparing two ints which are positive,
3207 there's no danger of overflow here. */
3208 return * (int *) ap
- * (int *) bp
;
3211 /* String compare function for qsort. */
3214 compare_strings (const void *arg1
, const void *arg2
)
3216 const char **s1
= (const char **) arg1
;
3217 const char **s2
= (const char **) arg2
;
3219 return strcmp (*s1
, *s2
);
3222 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3223 #define AMBIGUOUS_MESS2 \
3224 ".\nUse \"set gnutarget format-name\" to specify the format."
3227 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3233 /* Check if errmsg just need simple return. */
3234 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3235 return bfd_errmsg (error_tag
);
3237 ret_len
= strlen (bfd_errmsg (error_tag
)) + strlen (AMBIGUOUS_MESS1
)
3238 + strlen (AMBIGUOUS_MESS2
);
3239 for (p
= matching
; *p
; p
++)
3240 ret_len
+= strlen (*p
) + 1;
3241 ret
= xmalloc (ret_len
+ 1);
3243 make_cleanup (xfree
, ret
);
3245 strcpy (retp
, bfd_errmsg (error_tag
));
3246 retp
+= strlen (retp
);
3248 strcpy (retp
, AMBIGUOUS_MESS1
);
3249 retp
+= strlen (retp
);
3251 for (p
= matching
; *p
; p
++)
3253 sprintf (retp
, " %s", *p
);
3254 retp
+= strlen (retp
);
3258 strcpy (retp
, AMBIGUOUS_MESS2
);
3263 /* Return ARGS parsed as a valid pid, or throw an error. */
3266 parse_pid_to_attach (const char *args
)
3272 error_no_arg (_("process-id to attach"));
3274 dummy
= (char *) args
;
3275 pid
= strtoul (args
, &dummy
, 0);
3276 /* Some targets don't set errno on errors, grrr! */
3277 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3278 error (_("Illegal process-id: %s."), args
);
3283 /* Helper for make_bpstat_clear_actions_cleanup. */
3286 do_bpstat_clear_actions_cleanup (void *unused
)
3288 bpstat_clear_actions ();
3291 /* Call bpstat_clear_actions for the case an exception is throw. You should
3292 discard_cleanups if no exception is caught. */
3295 make_bpstat_clear_actions_cleanup (void)
3297 return make_cleanup (do_bpstat_clear_actions_cleanup
, NULL
);
3300 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3301 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3302 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3305 producer_is_gcc_ge_4 (const char *producer
)
3310 if (producer
== NULL
)
3312 /* For unknown compilers expect their behavior is not compliant. For GCC
3313 this case can also happen for -gdwarf-4 type units supported since
3319 /* Skip any identifier after "GNU " - such as "C++" or "Java". */
3321 if (strncmp (producer
, "GNU ", strlen ("GNU ")) != 0)
3323 /* For non-GCC compilers expect their behavior is not compliant. */
3327 cs
= &producer
[strlen ("GNU ")];
3328 while (*cs
&& !isdigit (*cs
))
3330 if (sscanf (cs
, "%d.%d", &major
, &minor
) != 2)
3332 /* Not recognized as GCC. */
3344 /* Helper for make_cleanup_free_char_ptr_vec. */
3347 do_free_char_ptr_vec (void *arg
)
3349 VEC (char_ptr
) *char_ptr_vec
= arg
;
3351 free_char_ptr_vec (char_ptr_vec
);
3354 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3355 final VEC_free for CHAR_PTR_VEC itself.
3357 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3358 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3359 this function does not (cannot) clear the pointer. */
3362 make_cleanup_free_char_ptr_vec (VEC (char_ptr
) *char_ptr_vec
)
3364 return make_cleanup (do_free_char_ptr_vec
, char_ptr_vec
);
3367 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3368 must come from xrealloc-compatible allocator and it may be updated. FROM
3369 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3370 located at the start or end of *STRINGP. */
3373 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3375 char *string
= *stringp
, *s
;
3376 const size_t from_len
= strlen (from
);
3377 const size_t to_len
= strlen (to
);
3381 s
= strstr (s
, from
);
3385 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3386 || s
[-1] == DIRNAME_SEPARATOR
)
3387 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3388 || s
[from_len
] == DIRNAME_SEPARATOR
))
3392 string_new
= xrealloc (string
, (strlen (string
) + to_len
+ 1));
3394 /* Relocate the current S pointer. */
3395 s
= s
- string
+ string_new
;
3396 string
= string_new
;
3398 /* Replace from by to. */
3399 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3400 memcpy (s
, to
, to_len
);
3415 /* SIGALRM handler for waitpid_with_timeout. */
3418 sigalrm_handler (int signo
)
3420 /* Nothing to do. */
3425 /* Wrapper to wait for child PID to die with TIMEOUT.
3426 TIMEOUT is the time to stop waiting in seconds.
3427 If TIMEOUT is zero, pass WNOHANG to waitpid.
3428 Returns PID if it was successfully waited for, otherwise -1.
3430 Timeouts are currently implemented with alarm and SIGALRM.
3431 If the host does not support them, this waits "forever".
3432 It would be odd though for a host to have waitpid and not SIGALRM. */
3435 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3437 pid_t waitpid_result
;
3439 gdb_assert (pid
> 0);
3440 gdb_assert (timeout
>= 0);
3445 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3446 struct sigaction sa
, old_sa
;
3448 sa
.sa_handler
= sigalrm_handler
;
3449 sigemptyset (&sa
.sa_mask
);
3451 sigaction (SIGALRM
, &sa
, &old_sa
);
3455 ofunc
= (void (*)()) signal (SIGALRM
, sigalrm_handler
);
3461 waitpid_result
= waitpid (pid
, status
, 0);
3465 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3466 sigaction (SIGALRM
, &old_sa
, NULL
);
3468 signal (SIGALRM
, ofunc
);
3473 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3475 if (waitpid_result
== pid
)
3481 #endif /* HAVE_WAITPID */
3483 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3484 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3486 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3487 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3490 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3492 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3494 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3495 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3497 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3499 char *pattern_slash
, *string_slash
;
3501 /* Replace '\' by '/' in both strings. */
3503 pattern_slash
= alloca (strlen (pattern
) + 1);
3504 strcpy (pattern_slash
, pattern
);
3505 pattern
= pattern_slash
;
3506 for (; *pattern_slash
!= 0; pattern_slash
++)
3507 if (IS_DIR_SEPARATOR (*pattern_slash
))
3508 *pattern_slash
= '/';
3510 string_slash
= alloca (strlen (string
) + 1);
3511 strcpy (string_slash
, string
);
3512 string
= string_slash
;
3513 for (; *string_slash
!= 0; string_slash
++)
3514 if (IS_DIR_SEPARATOR (*string_slash
))
3515 *string_slash
= '/';
3517 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3519 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3520 flags
|= FNM_CASEFOLD
;
3521 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3523 return fnmatch (pattern
, string
, flags
);
3526 /* Provide a prototype to silence -Wmissing-prototypes. */
3527 extern initialize_file_ftype _initialize_utils
;
3530 _initialize_utils (void)
3532 add_internal_problem_command (&internal_error_problem
);
3533 add_internal_problem_command (&internal_warning_problem
);
3534 add_internal_problem_command (&demangler_warning_problem
);