1 /* General utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2016 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 "gdbthread.h"
28 #ifdef HAVE_SYS_RESOURCE_H
29 #include <sys/resource.h>
30 #endif /* HAVE_SYS_RESOURCE_H */
33 #include "tui/tui.h" /* For tui_get_command_dimension. */
41 #include "timeval-utils.h"
46 #include "gdb-demangle.h"
47 #include "expression.h"
51 #include "filenames.h"
53 #include "gdb_obstack.h"
59 #include "inferior.h" /* for signed_pointer_to_address */
61 #include "gdb_curses.h"
63 #include "readline/readline.h"
65 #include "gdb_sys_time.h"
68 #include "gdb_usleep.h"
70 #include "gdb_regex.h"
73 extern PTR
malloc (); /* ARI: PTR */
75 #if !HAVE_DECL_REALLOC
76 extern PTR
realloc (); /* ARI: PTR */
82 void (*deprecated_error_begin_hook
) (void);
84 /* Prototypes for local functions */
86 static void vfprintf_maybe_filtered (struct ui_file
*, const char *,
87 va_list, int) ATTRIBUTE_PRINTF (2, 0);
89 static void fputs_maybe_filtered (const char *, struct ui_file
*, int);
91 static void prompt_for_continue (void);
93 static void set_screen_size (void);
94 static void set_width (void);
96 /* Time spent in prompt_for_continue in the currently executing command
97 waiting for user to respond.
98 Initialized in make_command_stats_cleanup.
99 Modified in prompt_for_continue and defaulted_query.
100 Used in report_command_stats. */
102 static struct timeval prompt_for_continue_wait_time
;
104 /* A flag indicating whether to timestamp debugging messages. */
106 static int debug_timestamp
= 0;
108 /* Nonzero if we have job control. */
112 /* Nonzero means quit immediately if Control-C is typed now, rather
113 than waiting until QUIT is executed. Be careful in setting this;
114 code which executes with immediate_quit set has to be very careful
115 about being able to deal with being interrupted at any time. It is
116 almost always better to use QUIT; the only exception I can think of
117 is being able to quit out of a system call (using EINTR loses if
118 the SIGINT happens between the previous QUIT and the system call).
119 To immediately quit in the case in which a SIGINT happens between
120 the previous QUIT and setting immediate_quit (desirable anytime we
121 expect to block), call QUIT after setting immediate_quit. */
125 /* Nonzero means that strings with character values >0x7F should be printed
126 as octal escapes. Zero means just print the value (e.g. it's an
127 international character, and the terminal or window can cope.) */
129 int sevenbit_strings
= 0;
131 show_sevenbit_strings (struct ui_file
*file
, int from_tty
,
132 struct cmd_list_element
*c
, const char *value
)
134 fprintf_filtered (file
, _("Printing of 8-bit characters "
135 "in strings as \\nnn is %s.\n"),
139 /* String to be printed before warning messages, if any. */
141 char *warning_pre_print
= "\nwarning: ";
143 int pagination_enabled
= 1;
145 show_pagination_enabled (struct ui_file
*file
, int from_tty
,
146 struct cmd_list_element
*c
, const char *value
)
148 fprintf_filtered (file
, _("State of pagination is %s.\n"), value
);
152 /* Cleanup utilities.
154 These are not defined in cleanups.c (nor declared in cleanups.h)
155 because while they use the "cleanup API" they are not part of the
159 do_freeargv (void *arg
)
161 freeargv ((char **) arg
);
165 make_cleanup_freeargv (char **arg
)
167 return make_cleanup (do_freeargv
, arg
);
171 do_dyn_string_delete (void *arg
)
173 dyn_string_delete ((dyn_string_t
) arg
);
177 make_cleanup_dyn_string_delete (dyn_string_t arg
)
179 return make_cleanup (do_dyn_string_delete
, arg
);
183 do_bfd_close_cleanup (void *arg
)
185 gdb_bfd_unref ((bfd
*) arg
);
189 make_cleanup_bfd_unref (bfd
*abfd
)
191 return make_cleanup (do_bfd_close_cleanup
, abfd
);
194 /* Helper function which does the work for make_cleanup_fclose. */
197 do_fclose_cleanup (void *arg
)
199 FILE *file
= (FILE *) arg
;
204 /* Return a new cleanup that closes FILE. */
207 make_cleanup_fclose (FILE *file
)
209 return make_cleanup (do_fclose_cleanup
, file
);
212 /* Helper function which does the work for make_cleanup_obstack_free. */
215 do_obstack_free (void *arg
)
217 struct obstack
*ob
= (struct obstack
*) arg
;
219 obstack_free (ob
, NULL
);
222 /* Return a new cleanup that frees OBSTACK. */
225 make_cleanup_obstack_free (struct obstack
*obstack
)
227 return make_cleanup (do_obstack_free
, obstack
);
231 do_ui_file_delete (void *arg
)
233 ui_file_delete ((struct ui_file
*) arg
);
237 make_cleanup_ui_file_delete (struct ui_file
*arg
)
239 return make_cleanup (do_ui_file_delete
, arg
);
242 /* Helper function for make_cleanup_ui_out_redirect_pop. */
245 do_ui_out_redirect_pop (void *arg
)
247 struct ui_out
*uiout
= (struct ui_out
*) arg
;
249 if (ui_out_redirect (uiout
, NULL
) < 0)
250 warning (_("Cannot restore redirection of the current output protocol"));
253 /* Return a new cleanup that pops the last redirection by ui_out_redirect
254 with NULL parameter. */
257 make_cleanup_ui_out_redirect_pop (struct ui_out
*uiout
)
259 return make_cleanup (do_ui_out_redirect_pop
, uiout
);
263 do_free_section_addr_info (void *arg
)
265 free_section_addr_info ((struct section_addr_info
*) arg
);
269 make_cleanup_free_section_addr_info (struct section_addr_info
*addrs
)
271 return make_cleanup (do_free_section_addr_info
, addrs
);
274 struct restore_integer_closure
281 restore_integer (void *p
)
283 struct restore_integer_closure
*closure
284 = (struct restore_integer_closure
*) p
;
286 *(closure
->variable
) = closure
->value
;
289 /* Remember the current value of *VARIABLE and make it restored when
290 the cleanup is run. */
293 make_cleanup_restore_integer (int *variable
)
295 struct restore_integer_closure
*c
= XNEW (struct restore_integer_closure
);
297 c
->variable
= variable
;
298 c
->value
= *variable
;
300 return make_cleanup_dtor (restore_integer
, (void *) c
, xfree
);
303 /* Remember the current value of *VARIABLE and make it restored when
304 the cleanup is run. */
307 make_cleanup_restore_uinteger (unsigned int *variable
)
309 return make_cleanup_restore_integer ((int *) variable
);
312 /* Helper for make_cleanup_unpush_target. */
315 do_unpush_target (void *arg
)
317 struct target_ops
*ops
= (struct target_ops
*) arg
;
322 /* Return a new cleanup that unpushes OPS. */
325 make_cleanup_unpush_target (struct target_ops
*ops
)
327 return make_cleanup (do_unpush_target
, ops
);
330 /* Helper for make_cleanup_htab_delete compile time checking the types. */
333 do_htab_delete_cleanup (void *htab_voidp
)
335 htab_t htab
= (htab_t
) htab_voidp
;
340 /* Return a new cleanup that deletes HTAB. */
343 make_cleanup_htab_delete (htab_t htab
)
345 return make_cleanup (do_htab_delete_cleanup
, htab
);
348 struct restore_ui_out_closure
350 struct ui_out
**variable
;
351 struct ui_out
*value
;
355 do_restore_ui_out (void *p
)
357 struct restore_ui_out_closure
*closure
358 = (struct restore_ui_out_closure
*) p
;
360 *(closure
->variable
) = closure
->value
;
363 /* Remember the current value of *VARIABLE and make it restored when
364 the cleanup is run. */
367 make_cleanup_restore_ui_out (struct ui_out
**variable
)
369 struct restore_ui_out_closure
*c
= XNEW (struct restore_ui_out_closure
);
371 c
->variable
= variable
;
372 c
->value
= *variable
;
374 return make_cleanup_dtor (do_restore_ui_out
, (void *) c
, xfree
);
377 struct restore_ui_file_closure
379 struct ui_file
**variable
;
380 struct ui_file
*value
;
384 do_restore_ui_file (void *p
)
386 struct restore_ui_file_closure
*closure
387 = (struct restore_ui_file_closure
*) p
;
389 *(closure
->variable
) = closure
->value
;
392 /* Remember the current value of *VARIABLE and make it restored when
393 the cleanup is run. */
396 make_cleanup_restore_ui_file (struct ui_file
**variable
)
398 struct restore_ui_file_closure
*c
= XNEW (struct restore_ui_file_closure
);
400 c
->variable
= variable
;
401 c
->value
= *variable
;
403 return make_cleanup_dtor (do_restore_ui_file
, (void *) c
, xfree
);
406 /* Helper for make_cleanup_value_free_to_mark. */
409 do_value_free_to_mark (void *value
)
411 value_free_to_mark ((struct value
*) value
);
414 /* Free all values allocated since MARK was obtained by value_mark
415 (except for those released) when the cleanup is run. */
418 make_cleanup_value_free_to_mark (struct value
*mark
)
420 return make_cleanup (do_value_free_to_mark
, mark
);
423 /* Helper for make_cleanup_value_free. */
426 do_value_free (void *value
)
428 value_free ((struct value
*) value
);
434 make_cleanup_value_free (struct value
*value
)
436 return make_cleanup (do_value_free
, value
);
439 /* Helper for make_cleanup_free_so. */
442 do_free_so (void *arg
)
444 struct so_list
*so
= (struct so_list
*) arg
;
449 /* Make cleanup handler calling free_so for SO. */
452 make_cleanup_free_so (struct so_list
*so
)
454 return make_cleanup (do_free_so
, so
);
457 /* Helper for make_cleanup_restore_current_language. */
460 do_restore_current_language (void *p
)
462 enum language saved_lang
= (enum language
) (uintptr_t) p
;
464 set_language (saved_lang
);
467 /* Remember the current value of CURRENT_LANGUAGE and make it restored when
468 the cleanup is run. */
471 make_cleanup_restore_current_language (void)
473 enum language saved_lang
= current_language
->la_language
;
475 return make_cleanup (do_restore_current_language
,
476 (void *) (uintptr_t) saved_lang
);
479 /* Helper function for make_cleanup_clear_parser_state. */
482 do_clear_parser_state (void *ptr
)
484 struct parser_state
**p
= (struct parser_state
**) ptr
;
489 /* Clean (i.e., set to NULL) the parser state variable P. */
492 make_cleanup_clear_parser_state (struct parser_state
**p
)
494 return make_cleanup (do_clear_parser_state
, (void *) p
);
497 /* This function is useful for cleanups.
501 old_chain = make_cleanup (free_current_contents, &foo);
503 to arrange to free the object thus allocated. */
506 free_current_contents (void *ptr
)
508 void **location
= (void **) ptr
;
510 if (location
== NULL
)
511 internal_error (__FILE__
, __LINE__
,
512 _("free_current_contents: NULL pointer"));
513 if (*location
!= NULL
)
522 /* Print a warning message. The first argument STRING is the warning
523 message, used as an fprintf format string, the second is the
524 va_list of arguments for that string. A warning is unfiltered (not
525 paginated) so that the user does not need to page through each
526 screen full of warnings when there are lots of them. */
529 vwarning (const char *string
, va_list args
)
531 if (deprecated_warning_hook
)
532 (*deprecated_warning_hook
) (string
, args
);
535 if (target_supports_terminal_ours ())
536 target_terminal_ours ();
537 if (filtered_printing_initialized ())
538 wrap_here (""); /* Force out any buffered output. */
539 gdb_flush (gdb_stdout
);
540 if (warning_pre_print
)
541 fputs_unfiltered (warning_pre_print
, gdb_stderr
);
542 vfprintf_unfiltered (gdb_stderr
, string
, args
);
543 fprintf_unfiltered (gdb_stderr
, "\n");
547 /* Print an error message and return to command level.
548 The first argument STRING is the error message, used as a fprintf string,
549 and the remaining args are passed as arguments to it. */
552 verror (const char *string
, va_list args
)
554 throw_verror (GENERIC_ERROR
, string
, args
);
558 error_stream (struct ui_file
*stream
)
560 char *message
= ui_file_xstrdup (stream
, NULL
);
562 make_cleanup (xfree
, message
);
563 error (("%s"), message
);
566 /* Emit a message and abort. */
568 static void ATTRIBUTE_NORETURN
569 abort_with_message (const char *msg
)
571 if (gdb_stderr
== NULL
)
574 fputs_unfiltered (msg
, gdb_stderr
);
576 abort (); /* NOTE: GDB has only three calls to abort(). */
579 /* Dump core trying to increase the core soft limit to hard limit first. */
584 #ifdef HAVE_SETRLIMIT
585 struct rlimit rlim
= { RLIM_INFINITY
, RLIM_INFINITY
};
587 setrlimit (RLIMIT_CORE
, &rlim
);
588 #endif /* HAVE_SETRLIMIT */
590 abort (); /* NOTE: GDB has only three calls to abort(). */
593 /* Check whether GDB will be able to dump core using the dump_core
594 function. Returns zero if GDB cannot or should not dump core.
595 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
596 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
599 can_dump_core (enum resource_limit_kind limit_kind
)
601 #ifdef HAVE_GETRLIMIT
604 /* Be quiet and assume we can dump if an error is returned. */
605 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
611 if (rlim
.rlim_cur
== 0)
615 if (rlim
.rlim_max
== 0)
618 #endif /* HAVE_GETRLIMIT */
623 /* Print a warning that we cannot dump core. */
626 warn_cant_dump_core (const char *reason
)
628 fprintf_unfiltered (gdb_stderr
,
629 _("%s\nUnable to dump core, use `ulimit -c"
630 " unlimited' before executing GDB next time.\n"),
634 /* Check whether GDB will be able to dump core using the dump_core
635 function, and print a warning if we cannot. */
638 can_dump_core_warn (enum resource_limit_kind limit_kind
,
641 int core_dump_allowed
= can_dump_core (limit_kind
);
643 if (!core_dump_allowed
)
644 warn_cant_dump_core (reason
);
646 return core_dump_allowed
;
649 /* Allow the user to configure the debugger behavior with respect to
650 what to do when an internal problem is detected. */
652 const char internal_problem_ask
[] = "ask";
653 const char internal_problem_yes
[] = "yes";
654 const char internal_problem_no
[] = "no";
655 static const char *const internal_problem_modes
[] =
657 internal_problem_ask
,
658 internal_problem_yes
,
663 /* Print a message reporting an internal error/warning. Ask the user
664 if they want to continue, dump core, or just exit. Return
665 something to indicate a quit. */
667 struct internal_problem
670 int user_settable_should_quit
;
671 const char *should_quit
;
672 int user_settable_should_dump_core
;
673 const char *should_dump_core
;
676 /* Report a problem, internal to GDB, to the user. Once the problem
677 has been reported, and assuming GDB didn't quit, the caller can
678 either allow execution to resume or throw an error. */
680 static void ATTRIBUTE_PRINTF (4, 0)
681 internal_vproblem (struct internal_problem
*problem
,
682 const char *file
, int line
, const char *fmt
, va_list ap
)
688 struct cleanup
*cleanup
= make_cleanup (null_cleanup
, NULL
);
690 /* Don't allow infinite error/warning recursion. */
692 static char msg
[] = "Recursive internal problem.\n";
701 abort_with_message (msg
);
704 /* Newer GLIBC versions put the warn_unused_result attribute
705 on write, but this is one of those rare cases where
706 ignoring the return value is correct. Casting to (void)
707 does not fix this problem. This is the solution suggested
708 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
709 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
710 abort (); /* NOTE: GDB has only three calls to abort(). */
715 /* Create a string containing the full error/warning message. Need
716 to call query with this full string, as otherwize the reason
717 (error/warning) and question become separated. Format using a
718 style similar to a compiler error message. Include extra detail
719 so that the user knows that they are living on the edge. */
723 msg
= xstrvprintf (fmt
, ap
);
724 reason
= xstrprintf ("%s:%d: %s: %s\n"
725 "A problem internal to GDB has been detected,\n"
726 "further debugging may prove unreliable.",
727 file
, line
, problem
->name
, msg
);
729 make_cleanup (xfree
, reason
);
732 /* Fall back to abort_with_message if gdb_stderr is not set up. */
733 if (gdb_stderr
== NULL
)
735 fputs (reason
, stderr
);
736 abort_with_message ("\n");
739 /* Try to get the message out and at the start of a new line. */
740 if (target_supports_terminal_ours ())
741 target_terminal_ours ();
742 if (filtered_printing_initialized ())
745 /* Emit the message unless query will emit it below. */
746 if (problem
->should_quit
!= internal_problem_ask
748 || !filtered_printing_initialized ())
749 fprintf_unfiltered (gdb_stderr
, "%s\n", reason
);
751 if (problem
->should_quit
== internal_problem_ask
)
753 /* Default (yes/batch case) is to quit GDB. When in batch mode
754 this lessens the likelihood of GDB going into an infinite
756 if (!confirm
|| !filtered_printing_initialized ())
759 quit_p
= query (_("%s\nQuit this debugging session? "), reason
);
761 else if (problem
->should_quit
== internal_problem_yes
)
763 else if (problem
->should_quit
== internal_problem_no
)
766 internal_error (__FILE__
, __LINE__
, _("bad switch"));
768 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr
);
769 if (REPORT_BUGS_TO
[0])
770 fprintf_unfiltered (gdb_stderr
, _(" For instructions, see:\n%s."),
772 fputs_unfiltered ("\n\n", gdb_stderr
);
774 if (problem
->should_dump_core
== internal_problem_ask
)
776 if (!can_dump_core_warn (LIMIT_MAX
, reason
))
778 else if (!filtered_printing_initialized ())
782 /* Default (yes/batch case) is to dump core. This leaves a GDB
783 `dropping' so that it is easier to see that something went
785 dump_core_p
= query (_("%s\nCreate a core file of GDB? "), reason
);
788 else if (problem
->should_dump_core
== internal_problem_yes
)
789 dump_core_p
= can_dump_core_warn (LIMIT_MAX
, reason
);
790 else if (problem
->should_dump_core
== internal_problem_no
)
793 internal_error (__FILE__
, __LINE__
, _("bad switch"));
806 #ifdef HAVE_WORKING_FORK
814 do_cleanups (cleanup
);
817 static struct internal_problem internal_error_problem
= {
818 "internal-error", 1, internal_problem_ask
, 1, internal_problem_ask
822 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
824 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
825 throw_quit (_("Command aborted."));
828 static struct internal_problem internal_warning_problem
= {
829 "internal-warning", 1, internal_problem_ask
, 1, internal_problem_ask
833 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
835 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
838 static struct internal_problem demangler_warning_problem
= {
839 "demangler-warning", 1, internal_problem_ask
, 0, internal_problem_no
843 demangler_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
845 internal_vproblem (&demangler_warning_problem
, file
, line
, fmt
, ap
);
849 demangler_warning (const char *file
, int line
, const char *string
, ...)
853 va_start (ap
, string
);
854 demangler_vwarning (file
, line
, string
, ap
);
858 /* Dummy functions to keep add_prefix_cmd happy. */
861 set_internal_problem_cmd (char *args
, int from_tty
)
866 show_internal_problem_cmd (char *args
, int from_tty
)
870 /* When GDB reports an internal problem (error or warning) it gives
871 the user the opportunity to quit GDB and/or create a core file of
872 the current debug session. This function registers a few commands
873 that make it possible to specify that GDB should always or never
874 quit or create a core file, without asking. The commands look
877 maint set PROBLEM-NAME quit ask|yes|no
878 maint show PROBLEM-NAME quit
879 maint set PROBLEM-NAME corefile ask|yes|no
880 maint show PROBLEM-NAME corefile
882 Where PROBLEM-NAME is currently "internal-error" or
883 "internal-warning". */
886 add_internal_problem_command (struct internal_problem
*problem
)
888 struct cmd_list_element
**set_cmd_list
;
889 struct cmd_list_element
**show_cmd_list
;
893 set_cmd_list
= XNEW (struct cmd_list_element
*);
894 show_cmd_list
= XNEW (struct cmd_list_element
*);
895 *set_cmd_list
= NULL
;
896 *show_cmd_list
= NULL
;
898 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
901 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
904 add_prefix_cmd ((char*) problem
->name
,
905 class_maintenance
, set_internal_problem_cmd
, set_doc
,
907 concat ("maintenance set ", problem
->name
, " ",
909 0/*allow-unknown*/, &maintenance_set_cmdlist
);
911 add_prefix_cmd ((char*) problem
->name
,
912 class_maintenance
, show_internal_problem_cmd
, show_doc
,
914 concat ("maintenance show ", problem
->name
, " ",
916 0/*allow-unknown*/, &maintenance_show_cmdlist
);
918 if (problem
->user_settable_should_quit
)
920 set_doc
= xstrprintf (_("Set whether GDB should quit "
921 "when an %s is detected"),
923 show_doc
= xstrprintf (_("Show whether GDB will quit "
924 "when an %s is detected"),
926 add_setshow_enum_cmd ("quit", class_maintenance
,
927 internal_problem_modes
,
928 &problem
->should_quit
,
941 if (problem
->user_settable_should_dump_core
)
943 set_doc
= xstrprintf (_("Set whether GDB should create a core "
944 "file of GDB when %s is detected"),
946 show_doc
= xstrprintf (_("Show whether GDB will create a core "
947 "file of GDB when %s is detected"),
949 add_setshow_enum_cmd ("corefile", class_maintenance
,
950 internal_problem_modes
,
951 &problem
->should_dump_core
,
965 /* Return a newly allocated string, containing the PREFIX followed
966 by the system error message for errno (separated by a colon).
968 The result must be deallocated after use. */
971 perror_string (const char *prefix
)
976 err
= safe_strerror (errno
);
977 combined
= (char *) xmalloc (strlen (err
) + strlen (prefix
) + 3);
978 strcpy (combined
, prefix
);
979 strcat (combined
, ": ");
980 strcat (combined
, err
);
985 /* Print the system error message for errno, and also mention STRING
986 as the file name for which the error was encountered. Use ERRCODE
987 for the thrown exception. Then return to command level. */
990 throw_perror_with_name (enum errors errcode
, const char *string
)
994 combined
= perror_string (string
);
995 make_cleanup (xfree
, combined
);
997 /* I understand setting these is a matter of taste. Still, some people
998 may clear errno but not know about bfd_error. Doing this here is not
1000 bfd_set_error (bfd_error_no_error
);
1003 throw_error (errcode
, _("%s."), combined
);
1006 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
1009 perror_with_name (const char *string
)
1011 throw_perror_with_name (GENERIC_ERROR
, string
);
1014 /* Same as perror_with_name except that it prints a warning instead
1015 of throwing an error. */
1018 perror_warning_with_name (const char *string
)
1022 combined
= perror_string (string
);
1023 warning (_("%s"), combined
);
1027 /* Print the system error message for ERRCODE, and also mention STRING
1028 as the file name for which the error was encountered. */
1031 print_sys_errmsg (const char *string
, int errcode
)
1036 err
= safe_strerror (errcode
);
1037 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
1038 strcpy (combined
, string
);
1039 strcat (combined
, ": ");
1040 strcat (combined
, err
);
1042 /* We want anything which was printed on stdout to come out first, before
1044 gdb_flush (gdb_stdout
);
1045 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
1048 /* Control C eventually causes this to be called, at a convenient time. */
1053 if (sync_quit_force_run
)
1055 sync_quit_force_run
= 0;
1056 quit_force (NULL
, stdin
== instream
);
1060 /* No steenking SIGINT will ever be coming our way when the
1061 program is resumed. Don't lie. */
1062 throw_quit ("Quit");
1065 /* If there is no terminal switching for this target, then we can't
1066 possibly get screwed by the lack of job control. */
1067 || !target_supports_terminal_ours ())
1068 throw_quit ("Quit");
1070 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
1079 if (check_quit_flag () || sync_quit_force_run
)
1081 if (deprecated_interactive_hook
)
1082 deprecated_interactive_hook ();
1083 target_check_pending_interrupt ();
1087 /* Called when a memory allocation fails, with the number of bytes of
1088 memory requested in SIZE. */
1091 malloc_failure (long size
)
1095 internal_error (__FILE__
, __LINE__
,
1096 _("virtual memory exhausted: can't allocate %ld bytes."),
1101 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
1105 /* My replacement for the read system call.
1106 Used like `read' but keeps going if `read' returns too soon. */
1109 myread (int desc
, char *addr
, int len
)
1116 val
= read (desc
, addr
, len
);
1120 return orglen
- len
;
1128 print_spaces (int n
, struct ui_file
*file
)
1130 fputs_unfiltered (n_spaces (n
), file
);
1133 /* Print a host address. */
1136 gdb_print_host_address_1 (const void *addr
, struct ui_file
*stream
)
1138 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
1144 make_hex_string (const gdb_byte
*data
, size_t length
)
1146 char *result
= (char *) xmalloc (length
* 2 + 1);
1151 for (i
= 0; i
< length
; ++i
)
1152 p
+= xsnprintf (p
, 3, "%02x", data
[i
]);
1159 /* A cleanup function that calls regfree. */
1162 do_regfree_cleanup (void *r
)
1164 regfree ((regex_t
*) r
);
1167 /* Create a new cleanup that frees the compiled regular expression R. */
1170 make_regfree_cleanup (regex_t
*r
)
1172 return make_cleanup (do_regfree_cleanup
, r
);
1175 /* Return an xmalloc'd error message resulting from a regular
1176 expression compilation failure. */
1179 get_regcomp_error (int code
, regex_t
*rx
)
1181 size_t length
= regerror (code
, rx
, NULL
, 0);
1182 char *result
= (char *) xmalloc (length
);
1184 regerror (code
, rx
, result
, length
);
1188 /* Compile a regexp and throw an exception on error. This returns a
1189 cleanup to free the resulting pattern on success. RX must not be
1193 compile_rx_or_error (regex_t
*pattern
, const char *rx
, const char *message
)
1197 gdb_assert (rx
!= NULL
);
1199 code
= regcomp (pattern
, rx
, REG_NOSUB
);
1202 char *err
= get_regcomp_error (code
, pattern
);
1204 make_cleanup (xfree
, err
);
1205 error (("%s: %s"), message
, err
);
1208 return make_regfree_cleanup (pattern
);
1213 /* This function supports the query, nquery, and yquery functions.
1214 Ask user a y-or-n question and return 0 if answer is no, 1 if
1215 answer is yes, or default the answer to the specified default
1216 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1217 default answer, or '\0' for no default.
1218 CTLSTR is the control string and should end in "? ". It should
1219 not say how to answer, because we do that.
1220 ARGS are the arguments passed along with the CTLSTR argument to
1223 static int ATTRIBUTE_PRINTF (1, 0)
1224 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
1229 char def_answer
, not_def_answer
;
1230 char *y_string
, *n_string
, *question
, *prompt
;
1231 /* Used to add duration we waited for user to respond to
1232 prompt_for_continue_wait_time. */
1233 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1235 /* Set up according to which answer is the default. */
1236 if (defchar
== '\0')
1240 not_def_answer
= 'N';
1244 else if (defchar
== 'y')
1248 not_def_answer
= 'N';
1256 not_def_answer
= 'Y';
1261 /* Automatically answer the default value if the user did not want
1262 prompts or the command was issued with the server prefix. */
1263 if (!confirm
|| server_command
)
1266 /* If input isn't coming from the user directly, just say what
1267 question we're asking, and then answer the default automatically. This
1268 way, important error messages don't get lost when talking to GDB
1270 if (! input_from_terminal_p ())
1273 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
1275 printf_filtered (_("(%s or %s) [answered %c; "
1276 "input not from terminal]\n"),
1277 y_string
, n_string
, def_answer
);
1278 gdb_flush (gdb_stdout
);
1283 if (deprecated_query_hook
)
1285 return deprecated_query_hook (ctlstr
, args
);
1288 /* Format the question outside of the loop, to avoid reusing args. */
1289 question
= xstrvprintf (ctlstr
, args
);
1290 prompt
= xstrprintf (_("%s%s(%s or %s) %s"),
1291 annotation_level
> 1 ? "\n\032\032pre-query\n" : "",
1292 question
, y_string
, n_string
,
1293 annotation_level
> 1 ? "\n\032\032query\n" : "");
1296 /* Used for calculating time spend waiting for user. */
1297 gettimeofday (&prompt_started
, NULL
);
1301 char *response
, answer
;
1303 gdb_flush (gdb_stdout
);
1304 response
= gdb_readline_wrapper (prompt
);
1306 if (response
== NULL
) /* C-d */
1308 printf_filtered ("EOF [assumed %c]\n", def_answer
);
1313 answer
= response
[0];
1318 /* Check answer. For the non-default, the user must specify
1319 the non-default explicitly. */
1320 if (answer
== not_def_answer
)
1322 retval
= !def_value
;
1325 /* Otherwise, if a default was specified, the user may either
1326 specify the required input or have it default by entering
1328 if (answer
== def_answer
1329 || (defchar
!= '\0' && answer
== '\0'))
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 called 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. $EMACS was used
1710 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1711 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1713 /* The number of lines per page is not mentioned in the terminal
1714 description or EMACS evironment variable is set. This probably
1715 means that paging is not useful, so disable paging. */
1716 lines_per_page
= UINT_MAX
;
1719 /* If the output is not a terminal, don't paginate it. */
1720 if (!ui_file_isatty (gdb_stdout
))
1721 lines_per_page
= UINT_MAX
;
1725 /* We handle SIGWINCH ourselves. */
1726 rl_catch_sigwinch
= 0;
1732 /* Return nonzero if filtered printing is initialized. */
1734 filtered_printing_initialized (void)
1736 return wrap_buffer
!= NULL
;
1739 /* Helper for make_cleanup_restore_page_info. */
1742 do_restore_page_info_cleanup (void *arg
)
1748 /* Provide cleanup for restoring the terminal size. */
1751 make_cleanup_restore_page_info (void)
1753 struct cleanup
*back_to
;
1755 back_to
= make_cleanup (do_restore_page_info_cleanup
, NULL
);
1756 make_cleanup_restore_uinteger (&lines_per_page
);
1757 make_cleanup_restore_uinteger (&chars_per_line
);
1762 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1763 Provide cleanup for restoring the original state. */
1766 set_batch_flag_and_make_cleanup_restore_page_info (void)
1768 struct cleanup
*back_to
= make_cleanup_restore_page_info ();
1770 make_cleanup_restore_integer (&batch_flag
);
1777 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1780 set_screen_size (void)
1782 int rows
= lines_per_page
;
1783 int cols
= chars_per_line
;
1791 /* Update Readline's idea of the terminal size. */
1792 rl_set_screen_size (rows
, cols
);
1795 /* Reinitialize WRAP_BUFFER according to the current value of
1801 if (chars_per_line
== 0)
1806 wrap_buffer
= (char *) xmalloc (chars_per_line
+ 2);
1807 wrap_buffer
[0] = '\0';
1810 wrap_buffer
= (char *) xrealloc (wrap_buffer
, chars_per_line
+ 2);
1811 wrap_pointer
= wrap_buffer
; /* Start it at the beginning. */
1815 set_width_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1822 set_height_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1830 set_screen_width_and_height (int width
, int height
)
1832 lines_per_page
= height
;
1833 chars_per_line
= width
;
1839 /* Wait, so the user can read what's on the screen. Prompt the user
1840 to continue by pressing RETURN. 'q' is also provided because
1841 telling users what to do in the prompt is more user-friendly than
1842 expecting them to think of Ctrl-C/SIGINT. */
1845 prompt_for_continue (void)
1848 char cont_prompt
[120];
1849 /* Used to add duration we waited for user to respond to
1850 prompt_for_continue_wait_time. */
1851 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1853 gettimeofday (&prompt_started
, NULL
);
1855 if (annotation_level
> 1)
1856 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1858 strcpy (cont_prompt
,
1859 "---Type <return> to continue, or q <return> to quit---");
1860 if (annotation_level
> 1)
1861 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1863 /* We must do this *before* we call gdb_readline_wrapper, else it
1864 will eventually call us -- thinking that we're trying to print
1865 beyond the end of the screen. */
1866 reinitialize_more_filter ();
1868 /* We'll need to handle input. */
1869 target_terminal_ours ();
1871 /* Call gdb_readline_wrapper, not readline, in order to keep an
1872 event loop running. */
1873 ignore
= gdb_readline_wrapper (cont_prompt
);
1875 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1876 gettimeofday (&prompt_ended
, NULL
);
1877 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1878 timeval_add (&prompt_for_continue_wait_time
,
1879 &prompt_for_continue_wait_time
, &prompt_delta
);
1881 if (annotation_level
> 1)
1882 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1888 while (*p
== ' ' || *p
== '\t')
1891 /* Do not call quit here; there is no possibility of SIGINT. */
1892 throw_quit ("Quit");
1896 /* Now we have to do this again, so that GDB will know that it doesn't
1897 need to save the ---Type <return>--- line at the top of the screen. */
1898 reinitialize_more_filter ();
1900 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1903 /* Initalize timer to keep track of how long we waited for the user. */
1906 reset_prompt_for_continue_wait_time (void)
1908 static const struct timeval zero_timeval
= { 0 };
1910 prompt_for_continue_wait_time
= zero_timeval
;
1913 /* Fetch the cumulative time spent in prompt_for_continue. */
1916 get_prompt_for_continue_wait_time (void)
1918 return prompt_for_continue_wait_time
;
1921 /* Reinitialize filter; ie. tell it to reset to original values. */
1924 reinitialize_more_filter (void)
1930 /* Indicate that if the next sequence of characters overflows the line,
1931 a newline should be inserted here rather than when it hits the end.
1932 If INDENT is non-null, it is a string to be printed to indent the
1933 wrapped part on the next line. INDENT must remain accessible until
1934 the next call to wrap_here() or until a newline is printed through
1937 If the line is already overfull, we immediately print a newline and
1938 the indentation, and disable further wrapping.
1940 If we don't know the width of lines, but we know the page height,
1941 we must not wrap words, but should still keep track of newlines
1942 that were explicitly printed.
1944 INDENT should not contain tabs, as that will mess up the char count
1945 on the next line. FIXME.
1947 This routine is guaranteed to force out any output which has been
1948 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1949 used to force out output from the wrap_buffer. */
1952 wrap_here (char *indent
)
1954 /* This should have been allocated, but be paranoid anyway. */
1956 internal_error (__FILE__
, __LINE__
,
1957 _("failed internal consistency check"));
1961 *wrap_pointer
= '\0';
1962 fputs_unfiltered (wrap_buffer
, gdb_stdout
);
1964 wrap_pointer
= wrap_buffer
;
1965 wrap_buffer
[0] = '\0';
1966 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1970 else if (chars_printed
>= chars_per_line
)
1972 puts_filtered ("\n");
1974 puts_filtered (indent
);
1979 wrap_column
= chars_printed
;
1983 wrap_indent
= indent
;
1987 /* Print input string to gdb_stdout, filtered, with wrap,
1988 arranging strings in columns of n chars. String can be
1989 right or left justified in the column. Never prints
1990 trailing spaces. String should never be longer than
1991 width. FIXME: this could be useful for the EXAMINE
1992 command, which currently doesn't tabulate very well. */
1995 puts_filtered_tabular (char *string
, int width
, int right
)
2001 gdb_assert (chars_per_line
> 0);
2002 if (chars_per_line
== UINT_MAX
)
2004 fputs_filtered (string
, gdb_stdout
);
2005 fputs_filtered ("\n", gdb_stdout
);
2009 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
2010 fputs_filtered ("\n", gdb_stdout
);
2012 if (width
>= chars_per_line
)
2013 width
= chars_per_line
- 1;
2015 stringlen
= strlen (string
);
2017 if (chars_printed
> 0)
2018 spaces
= width
- (chars_printed
- 1) % width
- 1;
2020 spaces
+= width
- stringlen
;
2022 spacebuf
= (char *) alloca (spaces
+ 1);
2023 spacebuf
[spaces
] = '\0';
2025 spacebuf
[spaces
] = ' ';
2027 fputs_filtered (spacebuf
, gdb_stdout
);
2028 fputs_filtered (string
, gdb_stdout
);
2032 /* Ensure that whatever gets printed next, using the filtered output
2033 commands, starts at the beginning of the line. I.e. if there is
2034 any pending output for the current line, flush it and start a new
2035 line. Otherwise do nothing. */
2040 if (chars_printed
> 0)
2042 puts_filtered ("\n");
2047 /* Like fputs but if FILTER is true, pause after every screenful.
2049 Regardless of FILTER can wrap at points other than the final
2050 character of a line.
2052 Unlike fputs, fputs_maybe_filtered does not return a value.
2053 It is OK for LINEBUFFER to be NULL, in which case just don't print
2056 Note that a longjmp to top level may occur in this routine (only if
2057 FILTER is true) (since prompt_for_continue may do so) so this
2058 routine should not be called when cleanups are not in place. */
2061 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
2064 const char *lineptr
;
2066 if (linebuffer
== 0)
2069 /* Don't do any filtering if it is disabled. */
2070 if (stream
!= gdb_stdout
2071 || !pagination_enabled
2073 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
2074 || top_level_interpreter () == NULL
2075 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2077 fputs_unfiltered (linebuffer
, stream
);
2081 /* Go through and output each character. Show line extension
2082 when this is necessary; prompt user for new page when this is
2085 lineptr
= linebuffer
;
2088 /* Possible new page. */
2089 if (filter
&& (lines_printed
>= lines_per_page
- 1))
2090 prompt_for_continue ();
2092 while (*lineptr
&& *lineptr
!= '\n')
2094 /* Print a single line. */
2095 if (*lineptr
== '\t')
2098 *wrap_pointer
++ = '\t';
2100 fputc_unfiltered ('\t', stream
);
2101 /* Shifting right by 3 produces the number of tab stops
2102 we have already passed, and then adding one and
2103 shifting left 3 advances to the next tab stop. */
2104 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
2110 *wrap_pointer
++ = *lineptr
;
2112 fputc_unfiltered (*lineptr
, stream
);
2117 if (chars_printed
>= chars_per_line
)
2119 unsigned int save_chars
= chars_printed
;
2123 /* If we aren't actually wrapping, don't output newline --
2124 if chars_per_line is right, we probably just overflowed
2125 anyway; if it's wrong, let us keep going. */
2127 fputc_unfiltered ('\n', stream
);
2129 /* Possible new page. */
2130 if (lines_printed
>= lines_per_page
- 1)
2131 prompt_for_continue ();
2133 /* Now output indentation and wrapped string. */
2136 fputs_unfiltered (wrap_indent
, stream
);
2137 *wrap_pointer
= '\0'; /* Null-terminate saved stuff, */
2138 fputs_unfiltered (wrap_buffer
, stream
); /* and eject it. */
2139 /* FIXME, this strlen is what prevents wrap_indent from
2140 containing tabs. However, if we recurse to print it
2141 and count its chars, we risk trouble if wrap_indent is
2142 longer than (the user settable) chars_per_line.
2143 Note also that this can set chars_printed > chars_per_line
2144 if we are printing a long string. */
2145 chars_printed
= strlen (wrap_indent
)
2146 + (save_chars
- wrap_column
);
2147 wrap_pointer
= wrap_buffer
; /* Reset buffer */
2148 wrap_buffer
[0] = '\0';
2149 wrap_column
= 0; /* And disable fancy wrap */
2154 if (*lineptr
== '\n')
2157 wrap_here ((char *) 0); /* Spit out chars, cancel
2160 fputc_unfiltered ('\n', stream
);
2167 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
2169 fputs_maybe_filtered (linebuffer
, stream
, 1);
2173 putchar_unfiltered (int c
)
2177 ui_file_write (gdb_stdout
, &buf
, 1);
2181 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2182 May return nonlocally. */
2185 putchar_filtered (int c
)
2187 return fputc_filtered (c
, gdb_stdout
);
2191 fputc_unfiltered (int c
, struct ui_file
*stream
)
2195 ui_file_write (stream
, &buf
, 1);
2200 fputc_filtered (int c
, struct ui_file
*stream
)
2206 fputs_filtered (buf
, stream
);
2210 /* puts_debug is like fputs_unfiltered, except it prints special
2211 characters in printable fashion. */
2214 puts_debug (char *prefix
, char *string
, char *suffix
)
2218 /* Print prefix and suffix after each line. */
2219 static int new_line
= 1;
2220 static int return_p
= 0;
2221 static char *prev_prefix
= "";
2222 static char *prev_suffix
= "";
2224 if (*string
== '\n')
2227 /* If the prefix is changing, print the previous suffix, a new line,
2228 and the new prefix. */
2229 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
2231 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
2232 fputs_unfiltered ("\n", gdb_stdlog
);
2233 fputs_unfiltered (prefix
, gdb_stdlog
);
2236 /* Print prefix if we printed a newline during the previous call. */
2240 fputs_unfiltered (prefix
, gdb_stdlog
);
2243 prev_prefix
= prefix
;
2244 prev_suffix
= suffix
;
2246 /* Output characters in a printable format. */
2247 while ((ch
= *string
++) != '\0')
2253 fputc_unfiltered (ch
, gdb_stdlog
);
2256 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2260 fputs_unfiltered ("\\\\", gdb_stdlog
);
2263 fputs_unfiltered ("\\b", gdb_stdlog
);
2266 fputs_unfiltered ("\\f", gdb_stdlog
);
2270 fputs_unfiltered ("\\n", gdb_stdlog
);
2273 fputs_unfiltered ("\\r", gdb_stdlog
);
2276 fputs_unfiltered ("\\t", gdb_stdlog
);
2279 fputs_unfiltered ("\\v", gdb_stdlog
);
2283 return_p
= ch
== '\r';
2286 /* Print suffix if we printed a newline. */
2289 fputs_unfiltered (suffix
, gdb_stdlog
);
2290 fputs_unfiltered ("\n", gdb_stdlog
);
2295 /* Print a variable number of ARGS using format FORMAT. If this
2296 information is going to put the amount written (since the last call
2297 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2298 call prompt_for_continue to get the users permision to continue.
2300 Unlike fprintf, this function does not return a value.
2302 We implement three variants, vfprintf (takes a vararg list and stream),
2303 fprintf (takes a stream to write on), and printf (the usual).
2305 Note also that a longjmp to top level may occur in this routine
2306 (since prompt_for_continue may do so) so this routine should not be
2307 called when cleanups are not in place. */
2310 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2311 va_list args
, int filter
)
2314 struct cleanup
*old_cleanups
;
2316 linebuffer
= xstrvprintf (format
, args
);
2317 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2318 fputs_maybe_filtered (linebuffer
, stream
, filter
);
2319 do_cleanups (old_cleanups
);
2324 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2326 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2330 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2333 struct cleanup
*old_cleanups
;
2335 linebuffer
= xstrvprintf (format
, args
);
2336 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2337 if (debug_timestamp
&& stream
== gdb_stdlog
)
2343 gettimeofday (&tm
, NULL
);
2345 len
= strlen (linebuffer
);
2346 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2348 timestamp
= xstrprintf ("%ld:%ld %s%s",
2349 (long) tm
.tv_sec
, (long) tm
.tv_usec
,
2351 need_nl
? "\n": "");
2352 make_cleanup (xfree
, timestamp
);
2353 fputs_unfiltered (timestamp
, stream
);
2356 fputs_unfiltered (linebuffer
, stream
);
2357 do_cleanups (old_cleanups
);
2361 vprintf_filtered (const char *format
, va_list args
)
2363 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2367 vprintf_unfiltered (const char *format
, va_list args
)
2369 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2373 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2377 va_start (args
, format
);
2378 vfprintf_filtered (stream
, format
, args
);
2383 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2387 va_start (args
, format
);
2388 vfprintf_unfiltered (stream
, format
, args
);
2392 /* Like fprintf_filtered, but prints its result indented.
2393 Called as fprintfi_filtered (spaces, stream, format, ...); */
2396 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2401 va_start (args
, format
);
2402 print_spaces_filtered (spaces
, stream
);
2404 vfprintf_filtered (stream
, format
, args
);
2410 printf_filtered (const char *format
, ...)
2414 va_start (args
, format
);
2415 vfprintf_filtered (gdb_stdout
, format
, args
);
2421 printf_unfiltered (const char *format
, ...)
2425 va_start (args
, format
);
2426 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2430 /* Like printf_filtered, but prints it's result indented.
2431 Called as printfi_filtered (spaces, format, ...); */
2434 printfi_filtered (int spaces
, const char *format
, ...)
2438 va_start (args
, format
);
2439 print_spaces_filtered (spaces
, gdb_stdout
);
2440 vfprintf_filtered (gdb_stdout
, format
, args
);
2444 /* Easy -- but watch out!
2446 This routine is *not* a replacement for puts()! puts() appends a newline.
2447 This one doesn't, and had better not! */
2450 puts_filtered (const char *string
)
2452 fputs_filtered (string
, gdb_stdout
);
2456 puts_unfiltered (const char *string
)
2458 fputs_unfiltered (string
, gdb_stdout
);
2461 /* Return a pointer to N spaces and a null. The pointer is good
2462 until the next call to here. */
2467 static char *spaces
= 0;
2468 static int max_spaces
= -1;
2474 spaces
= (char *) xmalloc (n
+ 1);
2475 for (t
= spaces
+ n
; t
!= spaces
;)
2481 return spaces
+ max_spaces
- n
;
2484 /* Print N spaces. */
2486 print_spaces_filtered (int n
, struct ui_file
*stream
)
2488 fputs_filtered (n_spaces (n
), stream
);
2491 /* C++/ObjC demangler stuff. */
2493 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2494 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2495 If the name is not mangled, or the language for the name is unknown, or
2496 demangling is off, the name is printed in its "raw" form. */
2499 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2500 enum language lang
, int arg_mode
)
2506 /* If user wants to see raw output, no problem. */
2509 fputs_filtered (name
, stream
);
2513 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2514 fputs_filtered (demangled
? demangled
: name
, stream
);
2515 if (demangled
!= NULL
)
2523 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2524 differences in whitespace. Returns 0 if they match, non-zero if they
2525 don't (slightly different than strcmp()'s range of return values).
2527 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2528 This "feature" is useful when searching for matching C++ function names
2529 (such as if the user types 'break FOO', where FOO is a mangled C++
2533 strcmp_iw (const char *string1
, const char *string2
)
2535 while ((*string1
!= '\0') && (*string2
!= '\0'))
2537 while (isspace (*string1
))
2541 while (isspace (*string2
))
2545 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2547 if (case_sensitivity
== case_sensitive_off
2548 && (tolower ((unsigned char) *string1
)
2549 != tolower ((unsigned char) *string2
)))
2551 if (*string1
!= '\0')
2557 return (*string1
!= '\0' && *string1
!= '(') || (*string2
!= '\0');
2560 /* This is like strcmp except that it ignores whitespace and treats
2561 '(' as the first non-NULL character in terms of ordering. Like
2562 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2563 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2564 according to that ordering.
2566 If a list is sorted according to this function and if you want to
2567 find names in the list that match some fixed NAME according to
2568 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2569 where this function would put NAME.
2571 This function must be neutral to the CASE_SENSITIVITY setting as the user
2572 may choose it during later lookup. Therefore this function always sorts
2573 primarily case-insensitively and secondarily case-sensitively.
2575 Here are some examples of why using strcmp to sort is a bad idea:
2579 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2580 we try to do a search for "foo<char*>", strcmp will locate this
2581 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2582 will start looking at strings beginning with "goo", and will never
2583 see the correct match of "foo<char *>".
2585 Parenthesis example:
2587 In practice, this is less like to be an issue, but I'll give it a
2588 shot. Let's assume that '$' is a legitimate character to occur in
2589 symbols. (Which may well even be the case on some systems.) Then
2590 say that the partial symbol table contains "foo$" and "foo(int)".
2591 strcmp will put them in this order, since '$' < '('. Now, if the
2592 user searches for "foo", then strcmp will sort "foo" before "foo$".
2593 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2594 "foo") is false, so it won't proceed to the actual match of
2595 "foo(int)" with "foo". */
2598 strcmp_iw_ordered (const char *string1
, const char *string2
)
2600 const char *saved_string1
= string1
, *saved_string2
= string2
;
2601 enum case_sensitivity case_pass
= case_sensitive_off
;
2605 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2606 Provide stub characters if we are already at the end of one of the
2608 char c1
= 'X', c2
= 'X';
2610 while (*string1
!= '\0' && *string2
!= '\0')
2612 while (isspace (*string1
))
2614 while (isspace (*string2
))
2619 case case_sensitive_off
:
2620 c1
= tolower ((unsigned char) *string1
);
2621 c2
= tolower ((unsigned char) *string2
);
2623 case case_sensitive_on
:
2631 if (*string1
!= '\0')
2640 /* Characters are non-equal unless they're both '\0'; we want to
2641 make sure we get the comparison right according to our
2642 comparison in the cases where one of them is '\0' or '('. */
2644 if (*string2
== '\0')
2649 if (*string2
== '\0')
2654 if (*string2
== '\0' || *string2
== '(')
2663 if (case_pass
== case_sensitive_on
)
2666 /* Otherwise the strings were equal in case insensitive way, make
2667 a more fine grained comparison in a case sensitive way. */
2669 case_pass
= case_sensitive_on
;
2670 string1
= saved_string1
;
2671 string2
= saved_string2
;
2675 /* A simple comparison function with opposite semantics to strcmp. */
2678 streq (const char *lhs
, const char *rhs
)
2680 return !strcmp (lhs
, rhs
);
2686 ** Answer whether string_to_compare is a full or partial match to
2687 ** template_string. The partial match must be in sequence starting
2691 subset_compare (char *string_to_compare
, char *template_string
)
2695 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
2696 && strlen (string_to_compare
) <= strlen (template_string
))
2698 (startswith (template_string
, string_to_compare
));
2705 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2706 struct cmd_list_element
*c
, const char *value
)
2708 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2714 initialize_utils (void)
2716 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
2717 Set number of characters where GDB should wrap lines of its output."), _("\
2718 Show number of characters where GDB should wrap lines of its output."), _("\
2719 This affects where GDB wraps its output to fit the screen width.\n\
2720 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2722 show_chars_per_line
,
2723 &setlist
, &showlist
);
2725 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
2726 Set number of lines in a page for GDB output pagination."), _("\
2727 Show number of lines in a page for GDB output pagination."), _("\
2728 This affects the number of lines after which GDB will pause\n\
2729 its output and ask you whether to continue.\n\
2730 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2732 show_lines_per_page
,
2733 &setlist
, &showlist
);
2735 add_setshow_boolean_cmd ("pagination", class_support
,
2736 &pagination_enabled
, _("\
2737 Set state of GDB output pagination."), _("\
2738 Show state of GDB output pagination."), _("\
2739 When pagination is ON, GDB pauses at end of each screenful of\n\
2740 its output and asks you whether to continue.\n\
2741 Turning pagination off is an alternative to \"set height unlimited\"."),
2743 show_pagination_enabled
,
2744 &setlist
, &showlist
);
2746 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
2747 &sevenbit_strings
, _("\
2748 Set printing of 8-bit characters in strings as \\nnn."), _("\
2749 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
2751 show_sevenbit_strings
,
2752 &setprintlist
, &showprintlist
);
2754 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
2755 &debug_timestamp
, _("\
2756 Set timestamping of debugging messages."), _("\
2757 Show timestamping of debugging messages."), _("\
2758 When set, debugging messages will be marked with seconds and microseconds."),
2760 show_debug_timestamp
,
2761 &setdebuglist
, &showdebuglist
);
2765 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2767 /* Truncate address to the size of a target address, avoiding shifts
2768 larger or equal than the width of a CORE_ADDR. The local
2769 variable ADDR_BIT stops the compiler reporting a shift overflow
2770 when it won't occur. */
2771 /* NOTE: This assumes that the significant address information is
2772 kept in the least significant bits of ADDR - the upper bits were
2773 either zero or sign extended. Should gdbarch_address_to_pointer or
2774 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2776 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2778 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2779 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2780 return hex_string (addr
);
2783 /* This function is described in "defs.h". */
2786 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2788 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2790 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2791 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2793 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2794 that returns the language localized string formatted to a width
2795 based on gdbarch_addr_bit. */
2797 return hex_string_custom (address
, 8);
2799 return hex_string_custom (address
, 16);
2802 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2805 core_addr_hash (const void *ap
)
2807 const CORE_ADDR
*addrp
= (const CORE_ADDR
*) ap
;
2812 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2815 core_addr_eq (const void *ap
, const void *bp
)
2817 const CORE_ADDR
*addr_ap
= (const CORE_ADDR
*) ap
;
2818 const CORE_ADDR
*addr_bp
= (const CORE_ADDR
*) bp
;
2820 return *addr_ap
== *addr_bp
;
2823 /* Convert a string back into a CORE_ADDR. */
2825 string_to_core_addr (const char *my_string
)
2829 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2831 /* Assume that it is in hex. */
2834 for (i
= 2; my_string
[i
] != '\0'; i
++)
2836 if (isdigit (my_string
[i
]))
2837 addr
= (my_string
[i
] - '0') + (addr
* 16);
2838 else if (isxdigit (my_string
[i
]))
2839 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2841 error (_("invalid hex \"%s\""), my_string
);
2846 /* Assume that it is in decimal. */
2849 for (i
= 0; my_string
[i
] != '\0'; i
++)
2851 if (isdigit (my_string
[i
]))
2852 addr
= (my_string
[i
] - '0') + (addr
* 10);
2854 error (_("invalid decimal \"%s\""), my_string
);
2862 gdb_realpath (const char *filename
)
2864 /* On most hosts, we rely on canonicalize_file_name to compute
2865 the FILENAME's realpath.
2867 But the situation is slightly more complex on Windows, due to some
2868 versions of GCC which were reported to generate paths where
2869 backlashes (the directory separator) were doubled. For instance:
2870 c:\\some\\double\\slashes\\dir
2872 c:\some\double\slashes\dir
2873 Those double-slashes were getting in the way when comparing paths,
2874 for instance when trying to insert a breakpoint as follow:
2875 (gdb) b c:/some/double/slashes/dir/foo.c:4
2876 No source file named c:/some/double/slashes/dir/foo.c:4.
2877 (gdb) b c:\some\double\slashes\dir\foo.c:4
2878 No source file named c:\some\double\slashes\dir\foo.c:4.
2879 To prevent this from happening, we need this function to always
2880 strip those extra backslashes. While canonicalize_file_name does
2881 perform this simplification, it only works when the path is valid.
2882 Since the simplification would be useful even if the path is not
2883 valid (one can always set a breakpoint on a file, even if the file
2884 does not exist locally), we rely instead on GetFullPathName to
2885 perform the canonicalization. */
2887 #if defined (_WIN32)
2890 DWORD len
= GetFullPathName (filename
, MAX_PATH
, buf
, NULL
);
2892 /* The file system is case-insensitive but case-preserving.
2893 So it is important we do not lowercase the path. Otherwise,
2894 we might not be able to display the original casing in a given
2896 if (len
> 0 && len
< MAX_PATH
)
2897 return xstrdup (buf
);
2901 char *rp
= canonicalize_file_name (filename
);
2908 /* This system is a lost cause, just dup the buffer. */
2909 return xstrdup (filename
);
2912 /* Return a copy of FILENAME, with its directory prefix canonicalized
2916 gdb_realpath_keepfile (const char *filename
)
2918 const char *base_name
= lbasename (filename
);
2923 /* Extract the basename of filename, and return immediately
2924 a copy of filename if it does not contain any directory prefix. */
2925 if (base_name
== filename
)
2926 return xstrdup (filename
);
2928 dir_name
= (char *) alloca ((size_t) (base_name
- filename
+ 2));
2929 /* Allocate enough space to store the dir_name + plus one extra
2930 character sometimes needed under Windows (see below), and
2931 then the closing \000 character. */
2932 strncpy (dir_name
, filename
, base_name
- filename
);
2933 dir_name
[base_name
- filename
] = '\000';
2935 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
2936 /* We need to be careful when filename is of the form 'd:foo', which
2937 is equivalent of d:./foo, which is totally different from d:/foo. */
2938 if (strlen (dir_name
) == 2 && isalpha (dir_name
[0]) && dir_name
[1] == ':')
2941 dir_name
[3] = '\000';
2945 /* Canonicalize the directory prefix, and build the resulting
2946 filename. If the dirname realpath already contains an ending
2947 directory separator, avoid doubling it. */
2948 real_path
= gdb_realpath (dir_name
);
2949 if (IS_DIR_SEPARATOR (real_path
[strlen (real_path
) - 1]))
2950 result
= concat (real_path
, base_name
, (char *) NULL
);
2952 result
= concat (real_path
, SLASH_STRING
, base_name
, (char *) NULL
);
2958 /* Return PATH in absolute form, performing tilde-expansion if necessary.
2959 PATH cannot be NULL or the empty string.
2960 This does not resolve symlinks however, use gdb_realpath for that.
2961 Space for the result is allocated with malloc.
2962 If the path is already absolute, it is strdup'd.
2963 If there is a problem computing the absolute path, the path is returned
2964 unchanged (still strdup'd). */
2967 gdb_abspath (const char *path
)
2969 gdb_assert (path
!= NULL
&& path
[0] != '\0');
2972 return tilde_expand (path
);
2974 if (IS_ABSOLUTE_PATH (path
))
2975 return xstrdup (path
);
2977 /* Beware the // my son, the Emacs barfs, the botch that catch... */
2978 return concat (current_directory
,
2979 IS_DIR_SEPARATOR (current_directory
[strlen (current_directory
) - 1])
2980 ? "" : SLASH_STRING
,
2981 path
, (char *) NULL
);
2985 align_up (ULONGEST v
, int n
)
2987 /* Check that N is really a power of two. */
2988 gdb_assert (n
&& (n
& (n
-1)) == 0);
2989 return (v
+ n
- 1) & -n
;
2993 align_down (ULONGEST v
, int n
)
2995 /* Check that N is really a power of two. */
2996 gdb_assert (n
&& (n
& (n
-1)) == 0);
3000 /* Allocation function for the libiberty hash table which uses an
3001 obstack. The obstack is passed as DATA. */
3004 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
3006 size_t total
= size
* count
;
3007 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
3009 memset (ptr
, 0, total
);
3013 /* Trivial deallocation function for the libiberty splay tree and hash
3014 table - don't deallocate anything. Rely on later deletion of the
3015 obstack. DATA will be the obstack, although it is not needed
3019 dummy_obstack_deallocate (void *object
, void *data
)
3024 /* Simple, portable version of dirname that does not modify its
3028 ldirname (const char *filename
)
3030 const char *base
= lbasename (filename
);
3033 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
3036 if (base
== filename
)
3039 dirname
= (char *) xmalloc (base
- filename
+ 2);
3040 memcpy (dirname
, filename
, base
- filename
);
3042 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3043 create "d:./bar" later instead of the (different) "d:/bar". */
3044 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3045 && !IS_DIR_SEPARATOR (filename
[0]))
3046 dirname
[base
++ - filename
] = '.';
3048 dirname
[base
- filename
] = '\0';
3052 /* Call libiberty's buildargv, and return the result.
3053 If buildargv fails due to out-of-memory, call nomem.
3054 Therefore, the returned value is guaranteed to be non-NULL,
3055 unless the parameter itself is NULL. */
3058 gdb_buildargv (const char *s
)
3060 char **argv
= buildargv (s
);
3062 if (s
!= NULL
&& argv
== NULL
)
3068 compare_positive_ints (const void *ap
, const void *bp
)
3070 /* Because we know we're comparing two ints which are positive,
3071 there's no danger of overflow here. */
3072 return * (int *) ap
- * (int *) bp
;
3075 /* String compare function for qsort. */
3078 compare_strings (const void *arg1
, const void *arg2
)
3080 const char **s1
= (const char **) arg1
;
3081 const char **s2
= (const char **) arg2
;
3083 return strcmp (*s1
, *s2
);
3086 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3087 #define AMBIGUOUS_MESS2 \
3088 ".\nUse \"set gnutarget format-name\" to specify the format."
3091 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3097 /* Check if errmsg just need simple return. */
3098 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3099 return bfd_errmsg (error_tag
);
3101 ret_len
= strlen (bfd_errmsg (error_tag
)) + strlen (AMBIGUOUS_MESS1
)
3102 + strlen (AMBIGUOUS_MESS2
);
3103 for (p
= matching
; *p
; p
++)
3104 ret_len
+= strlen (*p
) + 1;
3105 ret
= (char *) xmalloc (ret_len
+ 1);
3107 make_cleanup (xfree
, ret
);
3109 strcpy (retp
, bfd_errmsg (error_tag
));
3110 retp
+= strlen (retp
);
3112 strcpy (retp
, AMBIGUOUS_MESS1
);
3113 retp
+= strlen (retp
);
3115 for (p
= matching
; *p
; p
++)
3117 sprintf (retp
, " %s", *p
);
3118 retp
+= strlen (retp
);
3122 strcpy (retp
, AMBIGUOUS_MESS2
);
3127 /* Return ARGS parsed as a valid pid, or throw an error. */
3130 parse_pid_to_attach (const char *args
)
3136 error_no_arg (_("process-id to attach"));
3138 dummy
= (char *) args
;
3139 pid
= strtoul (args
, &dummy
, 0);
3140 /* Some targets don't set errno on errors, grrr! */
3141 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3142 error (_("Illegal process-id: %s."), args
);
3147 /* Helper for make_bpstat_clear_actions_cleanup. */
3150 do_bpstat_clear_actions_cleanup (void *unused
)
3152 bpstat_clear_actions ();
3155 /* Call bpstat_clear_actions for the case an exception is throw. You should
3156 discard_cleanups if no exception is caught. */
3159 make_bpstat_clear_actions_cleanup (void)
3161 return make_cleanup (do_bpstat_clear_actions_cleanup
, NULL
);
3164 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3165 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3166 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3169 producer_is_gcc_ge_4 (const char *producer
)
3173 if (! producer_is_gcc (producer
, &major
, &minor
))
3182 /* Returns nonzero if the given PRODUCER string is GCC and sets the MAJOR
3183 and MINOR versions when not NULL. Returns zero if the given PRODUCER
3184 is NULL or it isn't GCC. */
3187 producer_is_gcc (const char *producer
, int *major
, int *minor
)
3191 if (producer
!= NULL
&& startswith (producer
, "GNU "))
3200 /* Skip any identifier after "GNU " - such as "C11" "C++" or "Java".
3201 A full producer string might look like:
3203 "GNU Fortran 4.8.2 20140120 (Red Hat 4.8.2-16) -mtune=generic ..."
3204 "GNU C++14 5.0.0 20150123 (experimental)"
3206 cs
= &producer
[strlen ("GNU ")];
3207 while (*cs
&& !isspace (*cs
))
3209 if (*cs
&& isspace (*cs
))
3211 if (sscanf (cs
, "%d.%d", major
, minor
) == 2)
3215 /* Not recognized as GCC. */
3219 /* Helper for make_cleanup_free_char_ptr_vec. */
3222 do_free_char_ptr_vec (void *arg
)
3224 VEC (char_ptr
) *char_ptr_vec
= (VEC (char_ptr
) *) arg
;
3226 free_char_ptr_vec (char_ptr_vec
);
3229 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3230 final VEC_free for CHAR_PTR_VEC itself.
3232 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3233 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3234 this function does not (cannot) clear the pointer. */
3237 make_cleanup_free_char_ptr_vec (VEC (char_ptr
) *char_ptr_vec
)
3239 return make_cleanup (do_free_char_ptr_vec
, char_ptr_vec
);
3242 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3243 must come from xrealloc-compatible allocator and it may be updated. FROM
3244 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3245 located at the start or end of *STRINGP. */
3248 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3250 char *string
= *stringp
, *s
;
3251 const size_t from_len
= strlen (from
);
3252 const size_t to_len
= strlen (to
);
3256 s
= strstr (s
, from
);
3260 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3261 || s
[-1] == DIRNAME_SEPARATOR
)
3262 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3263 || s
[from_len
] == DIRNAME_SEPARATOR
))
3268 = (char *) xrealloc (string
, (strlen (string
) + to_len
+ 1));
3270 /* Relocate the current S pointer. */
3271 s
= s
- string
+ string_new
;
3272 string
= string_new
;
3274 /* Replace from by to. */
3275 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3276 memcpy (s
, to
, to_len
);
3291 /* SIGALRM handler for waitpid_with_timeout. */
3294 sigalrm_handler (int signo
)
3296 /* Nothing to do. */
3301 /* Wrapper to wait for child PID to die with TIMEOUT.
3302 TIMEOUT is the time to stop waiting in seconds.
3303 If TIMEOUT is zero, pass WNOHANG to waitpid.
3304 Returns PID if it was successfully waited for, otherwise -1.
3306 Timeouts are currently implemented with alarm and SIGALRM.
3307 If the host does not support them, this waits "forever".
3308 It would be odd though for a host to have waitpid and not SIGALRM. */
3311 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3313 pid_t waitpid_result
;
3315 gdb_assert (pid
> 0);
3316 gdb_assert (timeout
>= 0);
3321 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3322 struct sigaction sa
, old_sa
;
3324 sa
.sa_handler
= sigalrm_handler
;
3325 sigemptyset (&sa
.sa_mask
);
3327 sigaction (SIGALRM
, &sa
, &old_sa
);
3331 ofunc
= signal (SIGALRM
, sigalrm_handler
);
3337 waitpid_result
= waitpid (pid
, status
, 0);
3341 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3342 sigaction (SIGALRM
, &old_sa
, NULL
);
3344 signal (SIGALRM
, ofunc
);
3349 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3351 if (waitpid_result
== pid
)
3357 #endif /* HAVE_WAITPID */
3359 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3360 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3362 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3363 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3366 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3368 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3370 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3371 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3373 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3375 char *pattern_slash
, *string_slash
;
3377 /* Replace '\' by '/' in both strings. */
3379 pattern_slash
= (char *) alloca (strlen (pattern
) + 1);
3380 strcpy (pattern_slash
, pattern
);
3381 pattern
= pattern_slash
;
3382 for (; *pattern_slash
!= 0; pattern_slash
++)
3383 if (IS_DIR_SEPARATOR (*pattern_slash
))
3384 *pattern_slash
= '/';
3386 string_slash
= (char *) alloca (strlen (string
) + 1);
3387 strcpy (string_slash
, string
);
3388 string
= string_slash
;
3389 for (; *string_slash
!= 0; string_slash
++)
3390 if (IS_DIR_SEPARATOR (*string_slash
))
3391 *string_slash
= '/';
3393 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3395 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3396 flags
|= FNM_CASEFOLD
;
3397 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3399 return fnmatch (pattern
, string
, flags
);
3402 /* Return the number of path elements in PATH.
3410 count_path_elements (const char *path
)
3413 const char *p
= path
;
3415 if (HAS_DRIVE_SPEC (p
))
3417 p
= STRIP_DRIVE_SPEC (p
);
3423 if (IS_DIR_SEPARATOR (*p
))
3428 /* Backup one if last character is /, unless it's the only one. */
3429 if (p
> path
+ 1 && IS_DIR_SEPARATOR (p
[-1]))
3432 /* Add one for the file name, if present. */
3433 if (p
> path
&& !IS_DIR_SEPARATOR (p
[-1]))
3439 /* Remove N leading path elements from PATH.
3440 N must be non-negative.
3441 If PATH has more than N path elements then return NULL.
3442 If PATH has exactly N path elements then return "".
3443 See count_path_elements for a description of how we do the counting. */
3446 strip_leading_path_elements (const char *path
, int n
)
3449 const char *p
= path
;
3451 gdb_assert (n
>= 0);
3456 if (HAS_DRIVE_SPEC (p
))
3458 p
= STRIP_DRIVE_SPEC (p
);
3464 while (*p
!= '\0' && !IS_DIR_SEPARATOR (*p
))
3479 /* Provide a prototype to silence -Wmissing-prototypes. */
3480 extern initialize_file_ftype _initialize_utils
;
3483 _initialize_utils (void)
3485 add_internal_problem_command (&internal_error_problem
);
3486 add_internal_problem_command (&internal_warning_problem
);
3487 add_internal_problem_command (&demangler_warning_problem
);