1 /* General utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2015 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_file_closure
350 struct ui_file **variable;
351 struct ui_file *value;
355 do_restore_ui_file (void *p)
357 struct restore_ui_file_closure *closure
358 = (struct restore_ui_file_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_file (struct ui_file **variable)
369 struct restore_ui_file_closure *c = XNEW (struct restore_ui_file_closure);
371 c->variable = variable;
372 c->value = *variable;
374 return make_cleanup_dtor (do_restore_ui_file, (void *) c, xfree);
377 /* Helper for make_cleanup_value_free_to_mark. */
380 do_value_free_to_mark (void *value)
382 value_free_to_mark ((struct value *) value);
385 /* Free all values allocated since MARK was obtained by value_mark
386 (except for those released) when the cleanup is run. */
389 make_cleanup_value_free_to_mark (struct value *mark)
391 return make_cleanup (do_value_free_to_mark, mark);
394 /* Helper for make_cleanup_value_free. */
397 do_value_free (void *value)
399 value_free ((struct value *) value);
405 make_cleanup_value_free (struct value *value)
407 return make_cleanup (do_value_free, value);
410 /* Helper for make_cleanup_free_so. */
413 do_free_so (void *arg)
415 struct so_list *so = (struct so_list *) arg;
420 /* Make cleanup handler calling free_so for SO. */
423 make_cleanup_free_so (struct so_list *so)
425 return make_cleanup (do_free_so, so);
428 /* Helper for make_cleanup_restore_current_language. */
431 do_restore_current_language (void *p)
433 enum language saved_lang = (enum language) (uintptr_t) p;
435 set_language (saved_lang);
438 /* Remember the current value of CURRENT_LANGUAGE and make it restored when
439 the cleanup is run. */
442 make_cleanup_restore_current_language (void)
444 enum language saved_lang = current_language->la_language;
446 return make_cleanup (do_restore_current_language,
447 (void *) (uintptr_t) saved_lang);
450 /* Helper function for make_cleanup_clear_parser_state. */
453 do_clear_parser_state (void *ptr)
455 struct parser_state **p = (struct parser_state **) ptr;
460 /* Clean (i.e., set to NULL) the parser state variable P. */
463 make_cleanup_clear_parser_state (struct parser_state **p)
465 return make_cleanup (do_clear_parser_state, (void *) p);
468 /* This function is useful for cleanups.
472 old_chain = make_cleanup (free_current_contents, &foo);
474 to arrange to free the object thus allocated. */
477 free_current_contents (void *ptr)
479 void **location = (void **) ptr;
481 if (location == NULL)
482 internal_error (__FILE__, __LINE__,
483 _("free_current_contents: NULL pointer"));
484 if (*location != NULL)
493 /* Print a warning message. The first argument STRING is the warning
494 message, used as an fprintf format string, the second is the
495 va_list of arguments for that string. A warning is unfiltered (not
496 paginated) so that the user does not need to page through each
497 screen full of warnings when there are lots of them. */
500 vwarning (const char *string, va_list args)
502 if (deprecated_warning_hook)
503 (*deprecated_warning_hook) (string, args);
506 if (target_supports_terminal_ours ())
507 target_terminal_ours ();
508 if (filtered_printing_initialized ())
509 wrap_here (""); /* Force out any buffered output. */
510 gdb_flush (gdb_stdout);
511 if (warning_pre_print)
512 fputs_unfiltered (warning_pre_print, gdb_stderr);
513 vfprintf_unfiltered (gdb_stderr, string, args);
514 fprintf_unfiltered (gdb_stderr, "\n");
518 /* Print an error message and return to command level.
519 The first argument STRING is the error message, used as a fprintf string,
520 and the remaining args are passed as arguments to it. */
523 verror (const char *string, va_list args)
525 throw_verror (GENERIC_ERROR, string, args);
529 error_stream (struct ui_file *stream)
531 char *message = ui_file_xstrdup (stream, NULL);
533 make_cleanup (xfree, message);
534 error (("%s"), message);
537 /* Emit a message and abort. */
539 static void ATTRIBUTE_NORETURN
540 abort_with_message (const char *msg)
542 if (gdb_stderr == NULL)
545 fputs_unfiltered (msg, gdb_stderr);
547 abort (); /* NOTE: GDB has only three calls to abort(). */
550 /* Dump core trying to increase the core soft limit to hard limit first. */
555 #ifdef HAVE_SETRLIMIT
556 struct rlimit rlim = { RLIM_INFINITY, RLIM_INFINITY };
558 setrlimit (RLIMIT_CORE, &rlim);
559 #endif /* HAVE_SETRLIMIT */
561 abort (); /* NOTE: GDB has only three calls to abort(). */
564 /* Check whether GDB will be able to dump core using the dump_core
565 function. Returns zero if GDB cannot or should not dump core.
566 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
567 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
570 can_dump_core (enum resource_limit_kind limit_kind)
572 #ifdef HAVE_GETRLIMIT
575 /* Be quiet and assume we can dump if an error is returned. */
576 if (getrlimit (RLIMIT_CORE, &rlim) != 0)
582 if (rlim.rlim_cur == 0)
586 if (rlim.rlim_max == 0)
589 #endif /* HAVE_GETRLIMIT */
594 /* Print a warning that we cannot dump core. */
597 warn_cant_dump_core (const char *reason)
599 fprintf_unfiltered (gdb_stderr,
600 _("%s\nUnable to dump core, use `ulimit -c"
601 " unlimited' before executing GDB next time.\n"),
605 /* Check whether GDB will be able to dump core using the dump_core
606 function, and print a warning if we cannot. */
609 can_dump_core_warn (enum resource_limit_kind limit_kind,
612 int core_dump_allowed = can_dump_core (limit_kind);
614 if (!core_dump_allowed)
615 warn_cant_dump_core (reason);
617 return core_dump_allowed;
620 /* Allow the user to configure the debugger behavior with respect to
621 what to do when an internal problem is detected. */
623 const char internal_problem_ask[] = "ask";
624 const char internal_problem_yes[] = "yes";
625 const char internal_problem_no[] = "no";
626 static const char *const internal_problem_modes[] =
628 internal_problem_ask,
629 internal_problem_yes,
634 /* Print a message reporting an internal error/warning. Ask the user
635 if they want to continue, dump core, or just exit. Return
636 something to indicate a quit. */
638 struct internal_problem
641 int user_settable_should_quit;
642 const char *should_quit;
643 int user_settable_should_dump_core;
644 const char *should_dump_core;
647 /* Report a problem, internal to GDB, to the user. Once the problem
648 has been reported, and assuming GDB didn't quit, the caller can
649 either allow execution to resume or throw an error. */
651 static void ATTRIBUTE_PRINTF (4, 0)
652 internal_vproblem (struct internal_problem *problem,
653 const char *file, int line, const char *fmt, va_list ap)
659 struct cleanup *cleanup = make_cleanup (null_cleanup, NULL);
661 /* Don't allow infinite error/warning recursion. */
663 static char msg[] = "Recursive internal problem.\n";
672 abort_with_message (msg);
675 /* Newer GLIBC versions put the warn_unused_result attribute
676 on write, but this is one of those rare cases where
677 ignoring the return value is correct. Casting to (void)
678 does not fix this problem. This is the solution suggested
679 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
680 if (write (STDERR_FILENO, msg, sizeof (msg)) != sizeof (msg))
681 abort (); /* NOTE: GDB has only three calls to abort(). */
686 /* Create a string containing the full error/warning message. Need
687 to call query with this full string, as otherwize the reason
688 (error/warning) and question become separated. Format using a
689 style similar to a compiler error message. Include extra detail
690 so that the user knows that they are living on the edge. */
694 msg = xstrvprintf (fmt, ap);
695 reason = xstrprintf ("%s:%d: %s: %s\n"
696 "A problem internal to GDB has been detected,\n"
697 "further debugging may prove unreliable.",
698 file, line, problem->name, msg);
700 make_cleanup (xfree, reason);
703 /* Fall back to abort_with_message if gdb_stderr is not set up. */
704 if (gdb_stderr == NULL)
706 fputs (reason, stderr);
707 abort_with_message ("\n");
710 /* Try to get the message out and at the start of a new line. */
711 if (target_supports_terminal_ours ())
712 target_terminal_ours ();
713 if (filtered_printing_initialized ())
716 /* Emit the message unless query will emit it below. */
717 if (problem->should_quit != internal_problem_ask
719 || !filtered_printing_initialized ())
720 fprintf_unfiltered (gdb_stderr, "%s\n", reason);
722 if (problem->should_quit == internal_problem_ask)
724 /* Default (yes/batch case) is to quit GDB. When in batch mode
725 this lessens the likelihood of GDB going into an infinite
727 if (!confirm || !filtered_printing_initialized ())
730 quit_p = query (_("%s\nQuit this debugging session? "), reason);
732 else if (problem->should_quit == internal_problem_yes)
734 else if (problem->should_quit == internal_problem_no)
737 internal_error (__FILE__, __LINE__, _("bad switch"));
739 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr);
740 if (REPORT_BUGS_TO[0])
741 fprintf_unfiltered (gdb_stderr, _(" For instructions, see:\n%s."),
743 fputs_unfiltered ("\n\n", gdb_stderr);
745 if (problem->should_dump_core == internal_problem_ask)
747 if (!can_dump_core_warn (LIMIT_MAX, reason))
749 else if (!filtered_printing_initialized ())
753 /* Default (yes/batch case) is to dump core. This leaves a GDB
754 `dropping' so that it is easier to see that something went
756 dump_core_p = query (_("%s\nCreate a core file of GDB? "), reason);
759 else if (problem->should_dump_core == internal_problem_yes)
760 dump_core_p = can_dump_core_warn (LIMIT_MAX, reason);
761 else if (problem->should_dump_core == internal_problem_no)
764 internal_error (__FILE__, __LINE__, _("bad switch"));
777 #ifdef HAVE_WORKING_FORK
785 do_cleanups (cleanup);
788 static struct internal_problem internal_error_problem = {
789 "internal-error", 1, internal_problem_ask, 1, internal_problem_ask
793 internal_verror (const char *file, int line, const char *fmt, va_list ap)
795 internal_vproblem (&internal_error_problem, file, line, fmt, ap);
796 throw_quit (_("Command aborted."));
799 static struct internal_problem internal_warning_problem = {
800 "internal-warning", 1, internal_problem_ask, 1, internal_problem_ask
804 internal_vwarning (const char *file, int line, const char *fmt, va_list ap)
806 internal_vproblem (&internal_warning_problem, file, line, fmt, 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 = XNEW (struct cmd_list_element *);
865 show_cmd_list = XNEW (struct cmd_list_element *);
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)");
1050 if (check_quit_flag () || sync_quit_force_run)
1052 if (deprecated_interactive_hook)
1053 deprecated_interactive_hook ();
1054 target_check_pending_interrupt ();
1058 /* Called when a memory allocation fails, with the number of bytes of
1059 memory requested in SIZE. */
1062 malloc_failure (long size)
1066 internal_error (__FILE__, __LINE__,
1067 _("virtual memory exhausted: can't allocate %ld bytes."),
1072 internal_error (__FILE__, __LINE__, _("virtual memory exhausted."));
1076 /* My replacement for the read system call.
1077 Used like `read' but keeps going if `read' returns too soon. */
1080 myread (int desc, char *addr, int len)
1087 val = read (desc, addr, len);
1091 return orglen - len;
1099 print_spaces (int n, struct ui_file *file)
1101 fputs_unfiltered (n_spaces (n), file);
1104 /* Print a host address. */
1107 gdb_print_host_address_1 (const void *addr, struct ui_file *stream)
1109 fprintf_filtered (stream, "%s", host_address_to_string (addr));
1115 make_hex_string (const gdb_byte *data, size_t length)
1117 char *result = (char *) xmalloc (length * 2 + 1);
1122 for (i = 0; i < length; ++i)
1123 p += xsnprintf (p, 3, "%02x", data[i]);
1130 /* A cleanup function that calls regfree. */
1133 do_regfree_cleanup (void *r)
1135 regfree ((regex_t *) r);
1138 /* Create a new cleanup that frees the compiled regular expression R. */
1141 make_regfree_cleanup (regex_t *r)
1143 return make_cleanup (do_regfree_cleanup, r);
1146 /* Return an xmalloc'd error message resulting from a regular
1147 expression compilation failure. */
1150 get_regcomp_error (int code, regex_t *rx)
1152 size_t length = regerror (code, rx, NULL, 0);
1153 char *result = (char *) xmalloc (length);
1155 regerror (code, rx, result, length);
1159 /* Compile a regexp and throw an exception on error. This returns a
1160 cleanup to free the resulting pattern on success. RX must not be
1164 compile_rx_or_error (regex_t *pattern, const char *rx, const char *message)
1168 gdb_assert (rx != NULL);
1170 code = regcomp (pattern, rx, REG_NOSUB);
1173 char *err = get_regcomp_error (code, pattern);
1175 make_cleanup (xfree, err);
1176 error (("%s: %s"), message, err);
1179 return make_regfree_cleanup (pattern);
1184 /* This function supports the query, nquery, and yquery functions.
1185 Ask user a y-or-n question and return 0 if answer is no, 1 if
1186 answer is yes, or default the answer to the specified default
1187 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1188 default answer, or '\0' for no default.
1189 CTLSTR is the control string and should end in "? ". It should
1190 not say how to answer, because we do that.
1191 ARGS are the arguments passed along with the CTLSTR argument to
1194 static int ATTRIBUTE_PRINTF (1, 0)
1195 defaulted_query (const char *ctlstr, const char defchar, va_list args)
1200 char def_answer, not_def_answer;
1201 char *y_string, *n_string, *question, *prompt;
1202 /* Used to add duration we waited for user to respond to
1203 prompt_for_continue_wait_time. */
1204 struct timeval prompt_started, prompt_ended, prompt_delta;
1206 /* Set up according to which answer is the default. */
1207 if (defchar == '\0')
1211 not_def_answer = 'N';
1215 else if (defchar == 'y')
1219 not_def_answer = 'N';
1227 not_def_answer = 'Y';
1232 /* Automatically answer the default value if the user did not want
1233 prompts or the command was issued with the server prefix. */
1234 if (!confirm || server_command)
1237 /* If input isn't coming from the user directly, just say what
1238 question we're asking, and then answer the default automatically. This
1239 way, important error messages don't get lost when talking to GDB
1241 if (! input_from_terminal_p ())
1244 vfprintf_filtered (gdb_stdout, ctlstr, args);
1246 printf_filtered (_("(%s or %s) [answered %c; "
1247 "input not from terminal]\n"),
1248 y_string, n_string, def_answer);
1249 gdb_flush (gdb_stdout);
1254 if (deprecated_query_hook)
1256 return deprecated_query_hook (ctlstr, args);
1259 /* Format the question outside of the loop, to avoid reusing args. */
1260 question = xstrvprintf (ctlstr, args);
1261 prompt = xstrprintf (_("%s%s(%s or %s) %s"),
1262 annotation_level > 1 ? "\n\032\032pre-query\n" : "",
1263 question, y_string, n_string,
1264 annotation_level > 1 ? "\n\032\032query\n" : "");
1267 /* Used for calculating time spend waiting for user. */
1268 gettimeofday (&prompt_started, NULL);
1272 char *response, answer;
1274 gdb_flush (gdb_stdout);
1275 response = gdb_readline_wrapper (prompt);
1277 if (response == NULL) /* C-d */
1279 printf_filtered ("EOF [assumed %c]\n", def_answer);
1284 answer = response[0];
1289 /* Check answer. For the non-default, the user must specify
1290 the non-default explicitly. */
1291 if (answer == not_def_answer)
1293 retval = !def_value;
1296 /* Otherwise, if a default was specified, the user may either
1297 specify the required input or have it default by entering
1299 if (answer == def_answer
1300 || (defchar != '\0' && answer == '\0'))
1305 /* Invalid entries are not defaulted and require another selection. */
1306 printf_filtered (_("Please answer %s or %s.\n"),
1307 y_string, n_string);
1310 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1311 gettimeofday (&prompt_ended, NULL);
1312 timeval_sub (&prompt_delta, &prompt_ended, &prompt_started);
1313 timeval_add (&prompt_for_continue_wait_time,
1314 &prompt_for_continue_wait_time, &prompt_delta);
1317 if (annotation_level > 1)
1318 printf_filtered (("\n\032\032post-query\n"));
1323 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1324 answer is yes, or 0 if answer is defaulted.
1325 Takes three args which are given to printf to print the question.
1326 The first, a control string, should end in "? ".
1327 It should not say how to answer, because we do that. */
1330 nquery (const char *ctlstr, ...)
1335 va_start (args, ctlstr);
1336 ret = defaulted_query (ctlstr, 'n', args);
1341 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1342 answer is yes, or 1 if answer is defaulted.
1343 Takes three args which are given to printf to print the question.
1344 The first, a control string, should end in "? ".
1345 It should not say how to answer, because we do that. */
1348 yquery (const char *ctlstr, ...)
1353 va_start (args, ctlstr);
1354 ret = defaulted_query (ctlstr, 'y', args);
1359 /* Ask user a y-or-n question and return 1 iff answer is yes.
1360 Takes three args which are given to printf to print the question.
1361 The first, a control string, should end in "? ".
1362 It should not say how to answer, because we do that. */
1365 query (const char *ctlstr, ...)
1370 va_start (args, ctlstr);
1371 ret = defaulted_query (ctlstr, '\0', args);
1376 /* A helper for parse_escape that converts a host character to a
1377 target character. C is the host character. If conversion is
1378 possible, then the target character is stored in *TARGET_C and the
1379 function returns 1. Otherwise, the function returns 0. */
1382 host_char_to_target (struct gdbarch *gdbarch, int c, int *target_c)
1384 struct obstack host_data;
1386 struct cleanup *cleanups;
1389 obstack_init (&host_data);
1390 cleanups = make_cleanup_obstack_free (&host_data);
1392 convert_between_encodings (target_charset (gdbarch), host_charset (),
1393 (gdb_byte *) &the_char, 1, 1,
1394 &host_data, translit_none);
1396 if (obstack_object_size (&host_data) == 1)
1399 *target_c = *(char *) obstack_base (&host_data);
1402 do_cleanups (cleanups);
1406 /* Parse a C escape sequence. STRING_PTR points to a variable
1407 containing a pointer to the string to parse. That pointer
1408 should point to the character after the \. That pointer
1409 is updated past the characters we use. The value of the
1410 escape sequence is returned.
1412 A negative value means the sequence \ newline was seen,
1413 which is supposed to be equivalent to nothing at all.
1415 If \ is followed by a null character, we return a negative
1416 value and leave the string pointer pointing at the null character.
1418 If \ is followed by 000, we return 0 and leave the string pointer
1419 after the zeros. A value of 0 does not mean end of string. */
1422 parse_escape (struct gdbarch *gdbarch, const char **string_ptr)
1424 int target_char = -2; /* Initialize to avoid GCC warnings. */
1425 int c = *(*string_ptr)++;
1444 int i = host_hex_value (c);
1449 if (isdigit (c) && c != '8' && c != '9')
1453 i += host_hex_value (c);
1489 if (!host_char_to_target (gdbarch, c, &target_char))
1490 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1491 " which has no equivalent\nin the `%s' character set."),
1492 c, c, target_charset (gdbarch));
1496 /* Print the character C on STREAM as part of the contents of a literal
1497 string whose delimiter is QUOTER. Note that this routine should only
1498 be called for printing things which are independent of the language
1499 of the program being debugged.
1501 printchar will normally escape backslashes and instances of QUOTER. If
1502 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1503 As a side effect, if you pass the backslash character as the QUOTER,
1504 printchar will escape backslashes as usual, but not any other quoting
1508 printchar (int c, void (*do_fputs) (const char *, struct ui_file *),
1509 void (*do_fprintf) (struct ui_file *, const char *, ...)
1510 ATTRIBUTE_FPTR_PRINTF_2, struct ui_file *stream, int quoter)
1512 c &= 0xFF; /* Avoid sign bit follies */
1514 if (c < 0x20 || /* Low control chars */
1515 (c >= 0x7F && c < 0xA0) || /* DEL, High controls */
1516 (sevenbit_strings && c >= 0x80))
1517 { /* high order bit set */
1521 do_fputs ("\\n", stream);
1524 do_fputs ("\\b", stream);
1527 do_fputs ("\\t", stream);
1530 do_fputs ("\\f", stream);
1533 do_fputs ("\\r", stream);
1536 do_fputs ("\\e", stream);
1539 do_fputs ("\\a", stream);
1542 do_fprintf (stream, "\\%.3o", (unsigned int) c);
1548 if (quoter != 0 && (c == '\\' || c == quoter))
1549 do_fputs ("\\", stream);
1550 do_fprintf (stream, "%c", c);
1554 /* Print the character C on STREAM as part of the contents of a
1555 literal string whose delimiter is QUOTER. Note that these routines
1556 should only be call for printing things which are independent of
1557 the language of the program being debugged. */
1560 fputstr_filtered (const char *str, int quoter, struct ui_file *stream)
1563 printchar (*str++, fputs_filtered, fprintf_filtered, stream, quoter);
1567 fputstr_unfiltered (const char *str, int quoter, struct ui_file *stream)
1570 printchar (*str++, fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1574 fputstrn_filtered (const char *str, int n, int quoter,
1575 struct ui_file *stream)
1579 for (i = 0; i < n; i++)
1580 printchar (str[i], fputs_filtered, fprintf_filtered, stream, quoter);
1584 fputstrn_unfiltered (const char *str, int n, int quoter,
1585 struct ui_file *stream)
1589 for (i = 0; i < n; i++)
1590 printchar (str[i], fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1594 /* Number of lines per page or UINT_MAX if paging is disabled. */
1595 static unsigned int lines_per_page;
1597 show_lines_per_page (struct ui_file *file, int from_tty,
1598 struct cmd_list_element *c, const char *value)
1600 fprintf_filtered (file,
1601 _("Number of lines gdb thinks are in a page is %s.\n"),
1605 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1606 static unsigned int chars_per_line;
1608 show_chars_per_line (struct ui_file *file, int from_tty,
1609 struct cmd_list_element *c, const char *value)
1611 fprintf_filtered (file,
1612 _("Number of characters gdb thinks "
1613 "are in a line is %s.\n"),
1617 /* Current count of lines printed on this page, chars on this line. */
1618 static unsigned int lines_printed, chars_printed;
1620 /* Buffer and start column of buffered text, for doing smarter word-
1621 wrapping. When someone calls wrap_here(), we start buffering output
1622 that comes through fputs_filtered(). If we see a newline, we just
1623 spit it out and forget about the wrap_here(). If we see another
1624 wrap_here(), we spit it out and remember the newer one. If we see
1625 the end of the line, we spit out a newline, the indent, and then
1626 the buffered output. */
1628 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1629 are waiting to be output (they have already been counted in chars_printed).
1630 When wrap_buffer[0] is null, the buffer is empty. */
1631 static char *wrap_buffer;
1633 /* Pointer in wrap_buffer to the next character to fill. */
1634 static char *wrap_pointer;
1636 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1638 static char *wrap_indent;
1640 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1641 is not in effect. */
1642 static int wrap_column;
1645 /* Inialize the number of lines per page and chars per line. */
1648 init_page_info (void)
1652 lines_per_page = UINT_MAX;
1653 chars_per_line = UINT_MAX;
1657 if (!tui_get_command_dimension (&chars_per_line, &lines_per_page))
1662 #if defined(__GO32__)
1663 rows = ScreenRows ();
1664 cols = ScreenCols ();
1665 lines_per_page = rows;
1666 chars_per_line = cols;
1668 /* Make sure Readline has initialized its terminal settings. */
1669 rl_reset_terminal (NULL);
1671 /* Get the screen size from Readline. */
1672 rl_get_screen_size (&rows, &cols);
1673 lines_per_page = rows;
1674 chars_per_line = cols;
1676 /* Readline should have fetched the termcap entry for us.
1677 Only try to use tgetnum function if rl_get_screen_size
1678 did not return a useful value. */
1679 if (((rows <= 0) && (tgetnum ("li") < 0))
1680 /* Also disable paging if inside Emacs. $EMACS was used
1681 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1682 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1684 /* The number of lines per page is not mentioned in the terminal
1685 description or EMACS evironment variable is set. This probably
1686 means that paging is not useful, so disable paging. */
1687 lines_per_page = UINT_MAX;
1690 /* If the output is not a terminal, don't paginate it. */
1691 if (!ui_file_isatty (gdb_stdout))
1692 lines_per_page = UINT_MAX;
1696 /* We handle SIGWINCH ourselves. */
1697 rl_catch_sigwinch = 0;
1703 /* Return nonzero if filtered printing is initialized. */
1705 filtered_printing_initialized (void)
1707 return wrap_buffer != NULL;
1710 /* Helper for make_cleanup_restore_page_info. */
1713 do_restore_page_info_cleanup (void *arg)
1719 /* Provide cleanup for restoring the terminal size. */
1722 make_cleanup_restore_page_info (void)
1724 struct cleanup *back_to;
1726 back_to = make_cleanup (do_restore_page_info_cleanup, NULL);
1727 make_cleanup_restore_uinteger (&lines_per_page);
1728 make_cleanup_restore_uinteger (&chars_per_line);
1733 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1734 Provide cleanup for restoring the original state. */
1737 set_batch_flag_and_make_cleanup_restore_page_info (void)
1739 struct cleanup *back_to = make_cleanup_restore_page_info ();
1741 make_cleanup_restore_integer (&batch_flag);
1748 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1751 set_screen_size (void)
1753 int rows = lines_per_page;
1754 int cols = chars_per_line;
1762 /* Update Readline's idea of the terminal size. */
1763 rl_set_screen_size (rows, cols);
1766 /* Reinitialize WRAP_BUFFER according to the current value of
1772 if (chars_per_line == 0)
1777 wrap_buffer = (char *) xmalloc (chars_per_line + 2);
1778 wrap_buffer[0] = '\0';
1781 wrap_buffer = (char *) xrealloc (wrap_buffer, chars_per_line + 2);
1782 wrap_pointer = wrap_buffer; /* Start it at the beginning. */
1786 set_width_command (char *args, int from_tty, struct cmd_list_element *c)
1793 set_height_command (char *args, int from_tty, struct cmd_list_element *c)
1801 set_screen_width_and_height (int width, int height)
1803 lines_per_page = height;
1804 chars_per_line = width;
1810 /* Wait, so the user can read what's on the screen. Prompt the user
1811 to continue by pressing RETURN. */
1814 prompt_for_continue (void)
1817 char cont_prompt[120];
1818 /* Used to add duration we waited for user to respond to
1819 prompt_for_continue_wait_time. */
1820 struct timeval prompt_started, prompt_ended, prompt_delta;
1822 gettimeofday (&prompt_started, NULL);
1824 if (annotation_level > 1)
1825 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1827 strcpy (cont_prompt,
1828 "---Type <return> to continue, or q <return> to quit---");
1829 if (annotation_level > 1)
1830 strcat (cont_prompt, "\n\032\032prompt-for-continue\n");
1832 /* We must do this *before* we call gdb_readline, else it will eventually
1833 call us -- thinking that we're trying to print beyond the end of the
1835 reinitialize_more_filter ();
1840 /* We'll need to handle input. */
1841 target_terminal_ours ();
1843 /* On a real operating system, the user can quit with SIGINT.
1846 'q' is provided on all systems so users don't have to change habits
1847 from system to system, and because telling them what to do in
1848 the prompt is more user-friendly than expecting them to think of
1850 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1851 whereas control-C to gdb_readline will cause the user to get dumped
1853 ignore = gdb_readline_wrapper (cont_prompt);
1855 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1856 gettimeofday (&prompt_ended, NULL);
1857 timeval_sub (&prompt_delta, &prompt_ended, &prompt_started);
1858 timeval_add (&prompt_for_continue_wait_time,
1859 &prompt_for_continue_wait_time, &prompt_delta);
1861 if (annotation_level > 1)
1862 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1868 while (*p == ' ' || *p == '\t')
1876 /* Now we have to do this again, so that GDB will know that it doesn't
1877 need to save the ---Type <return>--- line at the top of the screen. */
1878 reinitialize_more_filter ();
1880 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1883 /* Initalize timer to keep track of how long we waited for the user. */
1886 reset_prompt_for_continue_wait_time (void)
1888 static const struct timeval zero_timeval = { 0 };
1890 prompt_for_continue_wait_time = zero_timeval;
1893 /* Fetch the cumulative time spent in prompt_for_continue. */
1896 get_prompt_for_continue_wait_time (void)
1898 return prompt_for_continue_wait_time;
1901 /* Reinitialize filter; ie. tell it to reset to original values. */
1904 reinitialize_more_filter (void)
1910 /* Indicate that if the next sequence of characters overflows the line,
1911 a newline should be inserted here rather than when it hits the end.
1912 If INDENT is non-null, it is a string to be printed to indent the
1913 wrapped part on the next line. INDENT must remain accessible until
1914 the next call to wrap_here() or until a newline is printed through
1917 If the line is already overfull, we immediately print a newline and
1918 the indentation, and disable further wrapping.
1920 If we don't know the width of lines, but we know the page height,
1921 we must not wrap words, but should still keep track of newlines
1922 that were explicitly printed.
1924 INDENT should not contain tabs, as that will mess up the char count
1925 on the next line. FIXME.
1927 This routine is guaranteed to force out any output which has been
1928 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1929 used to force out output from the wrap_buffer. */
1932 wrap_here (char *indent)
1934 /* This should have been allocated, but be paranoid anyway. */
1936 internal_error (__FILE__, __LINE__,
1937 _("failed internal consistency check"));
1941 *wrap_pointer = '\0';
1942 fputs_unfiltered (wrap_buffer, gdb_stdout);
1944 wrap_pointer = wrap_buffer;
1945 wrap_buffer[0] = '\0';
1946 if (chars_per_line == UINT_MAX) /* No line overflow checking. */
1950 else if (chars_printed >= chars_per_line)
1952 puts_filtered ("\n");
1954 puts_filtered (indent);
1959 wrap_column = chars_printed;
1963 wrap_indent = indent;
1967 /* Print input string to gdb_stdout, filtered, with wrap,
1968 arranging strings in columns of n chars. String can be
1969 right or left justified in the column. Never prints
1970 trailing spaces. String should never be longer than
1971 width. FIXME: this could be useful for the EXAMINE
1972 command, which currently doesn't tabulate very well. */
1975 puts_filtered_tabular (char *string, int width, int right)
1981 gdb_assert (chars_per_line > 0);
1982 if (chars_per_line == UINT_MAX)
1984 fputs_filtered (string, gdb_stdout);
1985 fputs_filtered ("\n", gdb_stdout);
1989 if (((chars_printed - 1) / width + 2) * width >= chars_per_line)
1990 fputs_filtered ("\n", gdb_stdout);
1992 if (width >= chars_per_line)
1993 width = chars_per_line - 1;
1995 stringlen = strlen (string);
1997 if (chars_printed > 0)
1998 spaces = width - (chars_printed - 1) % width - 1;
2000 spaces += width - stringlen;
2002 spacebuf = (char *) alloca (spaces + 1);
2003 spacebuf[spaces] = '\0';
2005 spacebuf[spaces] = ' ';
2007 fputs_filtered (spacebuf, gdb_stdout);
2008 fputs_filtered (string, gdb_stdout);
2012 /* Ensure that whatever gets printed next, using the filtered output
2013 commands, starts at the beginning of the line. I.e. if there is
2014 any pending output for the current line, flush it and start a new
2015 line. Otherwise do nothing. */
2020 if (chars_printed > 0)
2022 puts_filtered ("\n");
2027 /* Like fputs but if FILTER is true, pause after every screenful.
2029 Regardless of FILTER can wrap at points other than the final
2030 character of a line.
2032 Unlike fputs, fputs_maybe_filtered does not return a value.
2033 It is OK for LINEBUFFER to be NULL, in which case just don't print
2036 Note that a longjmp to top level may occur in this routine (only if
2037 FILTER is true) (since prompt_for_continue may do so) so this
2038 routine should not be called when cleanups are not in place. */
2041 fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
2044 const char *lineptr;
2046 if (linebuffer == 0)
2049 /* Don't do any filtering if it is disabled. */
2050 if (stream != gdb_stdout
2051 || !pagination_enabled
2053 || (lines_per_page == UINT_MAX && chars_per_line == UINT_MAX)
2054 || top_level_interpreter () == NULL
2055 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2057 fputs_unfiltered (linebuffer, stream);
2061 /* Go through and output each character. Show line extension
2062 when this is necessary; prompt user for new page when this is
2065 lineptr = linebuffer;
2068 /* Possible new page. */
2069 if (filter && (lines_printed >= lines_per_page - 1))
2070 prompt_for_continue ();
2072 while (*lineptr && *lineptr != '\n')
2074 /* Print a single line. */
2075 if (*lineptr == '\t')
2078 *wrap_pointer++ = '\t';
2080 fputc_unfiltered ('\t', stream);
2081 /* Shifting right by 3 produces the number of tab stops
2082 we have already passed, and then adding one and
2083 shifting left 3 advances to the next tab stop. */
2084 chars_printed = ((chars_printed >> 3) + 1) << 3;
2090 *wrap_pointer++ = *lineptr;
2092 fputc_unfiltered (*lineptr, stream);
2097 if (chars_printed >= chars_per_line)
2099 unsigned int save_chars = chars_printed;
2103 /* If we aren't actually wrapping, don't output newline --
2104 if chars_per_line is right, we probably just overflowed
2105 anyway; if it's wrong, let us keep going. */
2107 fputc_unfiltered ('\n', stream);
2109 /* Possible new page. */
2110 if (lines_printed >= lines_per_page - 1)
2111 prompt_for_continue ();
2113 /* Now output indentation and wrapped string. */
2116 fputs_unfiltered (wrap_indent, stream);
2117 *wrap_pointer = '\0'; /* Null-terminate saved stuff, */
2118 fputs_unfiltered (wrap_buffer, stream); /* and eject it. */
2119 /* FIXME, this strlen is what prevents wrap_indent from
2120 containing tabs. However, if we recurse to print it
2121 and count its chars, we risk trouble if wrap_indent is
2122 longer than (the user settable) chars_per_line.
2123 Note also that this can set chars_printed > chars_per_line
2124 if we are printing a long string. */
2125 chars_printed = strlen (wrap_indent)
2126 + (save_chars - wrap_column);
2127 wrap_pointer = wrap_buffer; /* Reset buffer */
2128 wrap_buffer[0] = '\0';
2129 wrap_column = 0; /* And disable fancy wrap */
2134 if (*lineptr == '\n')
2137 wrap_here ((char *) 0); /* Spit out chars, cancel
2140 fputc_unfiltered ('\n', stream);
2147 fputs_filtered (const char *linebuffer, struct ui_file *stream)
2149 fputs_maybe_filtered (linebuffer, stream, 1);
2153 putchar_unfiltered (int c)
2157 ui_file_write (gdb_stdout, &buf, 1);
2161 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2162 May return nonlocally. */
2165 putchar_filtered (int c)
2167 return fputc_filtered (c, gdb_stdout);
2171 fputc_unfiltered (int c, struct ui_file *stream)
2175 ui_file_write (stream, &buf, 1);
2180 fputc_filtered (int c, struct ui_file *stream)
2186 fputs_filtered (buf, stream);
2190 /* puts_debug is like fputs_unfiltered, except it prints special
2191 characters in printable fashion. */
2194 puts_debug (char *prefix, char *string, char *suffix)
2198 /* Print prefix and suffix after each line. */
2199 static int new_line = 1;
2200 static int return_p = 0;
2201 static char *prev_prefix = "";
2202 static char *prev_suffix = "";
2204 if (*string == '\n')
2207 /* If the prefix is changing, print the previous suffix, a new line,
2208 and the new prefix. */
2209 if ((return_p || (strcmp (prev_prefix, prefix) != 0)) && !new_line)
2211 fputs_unfiltered (prev_suffix, gdb_stdlog);
2212 fputs_unfiltered ("\n", gdb_stdlog);
2213 fputs_unfiltered (prefix, gdb_stdlog);
2216 /* Print prefix if we printed a newline during the previous call. */
2220 fputs_unfiltered (prefix, gdb_stdlog);
2223 prev_prefix = prefix;
2224 prev_suffix = suffix;
2226 /* Output characters in a printable format. */
2227 while ((ch = *string++) != '\0')
2233 fputc_unfiltered (ch, gdb_stdlog);
2236 fprintf_unfiltered (gdb_stdlog, "\\x%02x", ch & 0xff);
2240 fputs_unfiltered ("\\\\", gdb_stdlog);
2243 fputs_unfiltered ("\\b", gdb_stdlog);
2246 fputs_unfiltered ("\\f", gdb_stdlog);
2250 fputs_unfiltered ("\\n", gdb_stdlog);
2253 fputs_unfiltered ("\\r", gdb_stdlog);
2256 fputs_unfiltered ("\\t", gdb_stdlog);
2259 fputs_unfiltered ("\\v", gdb_stdlog);
2263 return_p = ch == '\r';
2266 /* Print suffix if we printed a newline. */
2269 fputs_unfiltered (suffix, gdb_stdlog);
2270 fputs_unfiltered ("\n", gdb_stdlog);
2275 /* Print a variable number of ARGS using format FORMAT. If this
2276 information is going to put the amount written (since the last call
2277 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2278 call prompt_for_continue to get the users permision to continue.
2280 Unlike fprintf, this function does not return a value.
2282 We implement three variants, vfprintf (takes a vararg list and stream),
2283 fprintf (takes a stream to write on), and printf (the usual).
2285 Note also that a longjmp to top level may occur in this routine
2286 (since prompt_for_continue may do so) so this routine should not be
2287 called when cleanups are not in place. */
2290 vfprintf_maybe_filtered (struct ui_file *stream, const char *format,
2291 va_list args, int filter)
2294 struct cleanup *old_cleanups;
2296 linebuffer = xstrvprintf (format, args);
2297 old_cleanups = make_cleanup (xfree, linebuffer);
2298 fputs_maybe_filtered (linebuffer, stream, filter);
2299 do_cleanups (old_cleanups);
2304 vfprintf_filtered (struct ui_file *stream, const char *format, va_list args)
2306 vfprintf_maybe_filtered (stream, format, args, 1);
2310 vfprintf_unfiltered (struct ui_file *stream, const char *format, va_list args)
2313 struct cleanup *old_cleanups;
2315 linebuffer = xstrvprintf (format, args);
2316 old_cleanups = make_cleanup (xfree, linebuffer);
2317 if (debug_timestamp && stream == gdb_stdlog)
2323 gettimeofday (&tm, NULL);
2325 len = strlen (linebuffer);
2326 need_nl = (len > 0 && linebuffer[len - 1] != '\n');
2328 timestamp = xstrprintf ("%ld:%ld %s%s",
2329 (long) tm.tv_sec, (long) tm.tv_usec,
2331 need_nl ? "\n": "");
2332 make_cleanup (xfree, timestamp);
2333 fputs_unfiltered (timestamp, stream);
2336 fputs_unfiltered (linebuffer, stream);
2337 do_cleanups (old_cleanups);
2341 vprintf_filtered (const char *format, va_list args)
2343 vfprintf_maybe_filtered (gdb_stdout, format, args, 1);
2347 vprintf_unfiltered (const char *format, va_list args)
2349 vfprintf_unfiltered (gdb_stdout, format, args);
2353 fprintf_filtered (struct ui_file *stream, const char *format, ...)
2357 va_start (args, format);
2358 vfprintf_filtered (stream, format, args);
2363 fprintf_unfiltered (struct ui_file *stream, const char *format, ...)
2367 va_start (args, format);
2368 vfprintf_unfiltered (stream, format, args);
2372 /* Like fprintf_filtered, but prints its result indented.
2373 Called as fprintfi_filtered (spaces, stream, format, ...); */
2376 fprintfi_filtered (int spaces, struct ui_file *stream, const char *format,
2381 va_start (args, format);
2382 print_spaces_filtered (spaces, stream);
2384 vfprintf_filtered (stream, format, args);
2390 printf_filtered (const char *format, ...)
2394 va_start (args, format);
2395 vfprintf_filtered (gdb_stdout, format, args);
2401 printf_unfiltered (const char *format, ...)
2405 va_start (args, format);
2406 vfprintf_unfiltered (gdb_stdout, format, args);
2410 /* Like printf_filtered, but prints it's result indented.
2411 Called as printfi_filtered (spaces, format, ...); */
2414 printfi_filtered (int spaces, const char *format, ...)
2418 va_start (args, format);
2419 print_spaces_filtered (spaces, gdb_stdout);
2420 vfprintf_filtered (gdb_stdout, format, args);
2424 /* Easy -- but watch out!
2426 This routine is *not* a replacement for puts()! puts() appends a newline.
2427 This one doesn't, and had better not! */
2430 puts_filtered (const char *string)
2432 fputs_filtered (string, gdb_stdout);
2436 puts_unfiltered (const char *string)
2438 fputs_unfiltered (string, gdb_stdout);
2441 /* Return a pointer to N spaces and a null. The pointer is good
2442 until the next call to here. */
2447 static char *spaces = 0;
2448 static int max_spaces = -1;
2454 spaces = (char *) xmalloc (n + 1);
2455 for (t = spaces + n; t != spaces;)
2461 return spaces + max_spaces - n;
2464 /* Print N spaces. */
2466 print_spaces_filtered (int n, struct ui_file *stream)
2468 fputs_filtered (n_spaces (n), stream);
2471 /* C++/ObjC demangler stuff. */
2473 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2474 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2475 If the name is not mangled, or the language for the name is unknown, or
2476 demangling is off, the name is printed in its "raw" form. */
2479 fprintf_symbol_filtered (struct ui_file *stream, const char *name,
2480 enum language lang, int arg_mode)
2486 /* If user wants to see raw output, no problem. */
2489 fputs_filtered (name, stream);
2493 demangled = language_demangle (language_def (lang), name, arg_mode);
2494 fputs_filtered (demangled ? demangled : name, stream);
2495 if (demangled != NULL)
2503 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2504 differences in whitespace. Returns 0 if they match, non-zero if they
2505 don't (slightly different than strcmp()'s range of return values).
2507 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2508 This "feature" is useful when searching for matching C++ function names
2509 (such as if the user types 'break FOO', where FOO is a mangled C++
2513 strcmp_iw (const char *string1, const char *string2)
2515 while ((*string1 != '\0') && (*string2 != '\0'))
2517 while (isspace (*string1))
2521 while (isspace (*string2))
2525 if (case_sensitivity == case_sensitive_on && *string1 != *string2)
2527 if (case_sensitivity == case_sensitive_off
2528 && (tolower ((unsigned char) *string1)
2529 != tolower ((unsigned char) *string2)))
2531 if (*string1 != '\0')
2537 return (*string1 != '\0' && *string1 != '(') || (*string2 != '\0');
2540 /* This is like strcmp except that it ignores whitespace and treats
2541 '(' as the first non-NULL character in terms of ordering. Like
2542 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2543 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2544 according to that ordering.
2546 If a list is sorted according to this function and if you want to
2547 find names in the list that match some fixed NAME according to
2548 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2549 where this function would put NAME.
2551 This function must be neutral to the CASE_SENSITIVITY setting as the user
2552 may choose it during later lookup. Therefore this function always sorts
2553 primarily case-insensitively and secondarily case-sensitively.
2555 Here are some examples of why using strcmp to sort is a bad idea:
2559 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2560 we try to do a search for "foo<char*>", strcmp will locate this
2561 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2562 will start looking at strings beginning with "goo", and will never
2563 see the correct match of "foo<char *>".
2565 Parenthesis example:
2567 In practice, this is less like to be an issue, but I'll give it a
2568 shot. Let's assume that '$' is a legitimate character to occur in
2569 symbols. (Which may well even be the case on some systems.) Then
2570 say that the partial symbol table contains "foo$" and "foo(int)".
2571 strcmp will put them in this order, since '$' < '('. Now, if the
2572 user searches for "foo", then strcmp will sort "foo" before "foo$".
2573 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2574 "foo") is false, so it won't proceed to the actual match of
2575 "foo(int)" with "foo". */
2578 strcmp_iw_ordered (const char *string1, const char *string2)
2580 const char *saved_string1 = string1, *saved_string2 = string2;
2581 enum case_sensitivity case_pass = case_sensitive_off;
2585 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2586 Provide stub characters if we are already at the end of one of the
2588 char c1 = 'X', c2 = 'X';
2590 while (*string1 != '\0' && *string2 != '\0')
2592 while (isspace (*string1))
2594 while (isspace (*string2))
2599 case case_sensitive_off:
2600 c1 = tolower ((unsigned char) *string1);
2601 c2 = tolower ((unsigned char) *string2);
2603 case case_sensitive_on:
2611 if (*string1 != '\0')
2620 /* Characters are non-equal unless they're both '\0'; we want to
2621 make sure we get the comparison right according to our
2622 comparison in the cases where one of them is '\0' or '('. */
2624 if (*string2 == '\0')
2629 if (*string2 == '\0')
2634 if (*string2 == '\0' || *string2 == '(')
2643 if (case_pass == case_sensitive_on)
2646 /* Otherwise the strings were equal in case insensitive way, make
2647 a more fine grained comparison in a case sensitive way. */
2649 case_pass = case_sensitive_on;
2650 string1 = saved_string1;
2651 string2 = saved_string2;
2655 /* A simple comparison function with opposite semantics to strcmp. */
2658 streq (const char *lhs, const char *rhs)
2660 return !strcmp (lhs, rhs);
2666 ** Answer whether string_to_compare is a full or partial match to
2667 ** template_string. The partial match must be in sequence starting
2671 subset_compare (char *string_to_compare, char *template_string)
2675 if (template_string != (char *) NULL && string_to_compare != (char *) NULL
2676 && strlen (string_to_compare) <= strlen (template_string))
2678 (startswith (template_string, string_to_compare));
2685 show_debug_timestamp (struct ui_file *file, int from_tty,
2686 struct cmd_list_element *c, const char *value)
2688 fprintf_filtered (file, _("Timestamping debugging messages is %s.\n"),
2694 initialize_utils (void)
2696 add_setshow_uinteger_cmd ("width", class_support, &chars_per_line, _("\
2697 Set number of characters where GDB should wrap lines of its output."), _("\
2698 Show number of characters where GDB should wrap lines of its output."), _("\
2699 This affects where GDB wraps its output to fit the screen width.\n\
2700 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2702 show_chars_per_line,
2703 &setlist, &showlist);
2705 add_setshow_uinteger_cmd ("height", class_support, &lines_per_page, _("\
2706 Set number of lines in a page for GDB output pagination."), _("\
2707 Show number of lines in a page for GDB output pagination."), _("\
2708 This affects the number of lines after which GDB will pause\n\
2709 its output and ask you whether to continue.\n\
2710 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2712 show_lines_per_page,
2713 &setlist, &showlist);
2715 add_setshow_boolean_cmd ("pagination", class_support,
2716 &pagination_enabled, _("\
2717 Set state of GDB output pagination."), _("\
2718 Show state of GDB output pagination."), _("\
2719 When pagination is ON, GDB pauses at end of each screenful of\n\
2720 its output and asks you whether to continue.\n\
2721 Turning pagination off is an alternative to \"set height unlimited\"."),
2723 show_pagination_enabled,
2724 &setlist, &showlist);
2726 add_setshow_boolean_cmd ("sevenbit-strings", class_support,
2727 &sevenbit_strings, _("\
2728 Set printing of 8-bit characters in strings as \\nnn."), _("\
2729 Show printing of 8-bit characters in strings as \\nnn."), NULL,
2731 show_sevenbit_strings,
2732 &setprintlist, &showprintlist);
2734 add_setshow_boolean_cmd ("timestamp", class_maintenance,
2735 &debug_timestamp, _("\
2736 Set timestamping of debugging messages."), _("\
2737 Show timestamping of debugging messages."), _("\
2738 When set, debugging messages will be marked with seconds and microseconds."),
2740 show_debug_timestamp,
2741 &setdebuglist, &showdebuglist);
2745 paddress (struct gdbarch *gdbarch, CORE_ADDR addr)
2747 /* Truncate address to the size of a target address, avoiding shifts
2748 larger or equal than the width of a CORE_ADDR. The local
2749 variable ADDR_BIT stops the compiler reporting a shift overflow
2750 when it won't occur. */
2751 /* NOTE: This assumes that the significant address information is
2752 kept in the least significant bits of ADDR - the upper bits were
2753 either zero or sign extended. Should gdbarch_address_to_pointer or
2754 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2756 int addr_bit = gdbarch_addr_bit (gdbarch);
2758 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2759 addr &= ((CORE_ADDR) 1 << addr_bit) - 1;
2760 return hex_string (addr);
2763 /* This function is described in "defs.h". */
2766 print_core_address (struct gdbarch *gdbarch, CORE_ADDR address)
2768 int addr_bit = gdbarch_addr_bit (gdbarch);
2770 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2771 address &= ((CORE_ADDR) 1 << addr_bit) - 1;
2773 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2774 that returns the language localized string formatted to a width
2775 based on gdbarch_addr_bit. */
2777 return hex_string_custom (address, 8);
2779 return hex_string_custom (address, 16);
2782 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2785 core_addr_hash (const void *ap)
2787 const CORE_ADDR *addrp = (const CORE_ADDR *) ap;
2792 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2795 core_addr_eq (const void *ap, const void *bp)
2797 const CORE_ADDR *addr_ap = (const CORE_ADDR *) ap;
2798 const CORE_ADDR *addr_bp = (const CORE_ADDR *) bp;
2800 return *addr_ap == *addr_bp;
2803 /* Convert a string back into a CORE_ADDR. */
2805 string_to_core_addr (const char *my_string)
2809 if (my_string[0] == '0' && tolower (my_string[1]) == 'x')
2811 /* Assume that it is in hex. */
2814 for (i = 2; my_string[i] != '\0'; i++)
2816 if (isdigit (my_string[i]))
2817 addr = (my_string[i] - '0') + (addr * 16);
2818 else if (isxdigit (my_string[i]))
2819 addr = (tolower (my_string[i]) - 'a' + 0xa) + (addr * 16);
2821 error (_("invalid hex \"%s\""), my_string);
2826 /* Assume that it is in decimal. */
2829 for (i = 0; my_string[i] != '\0'; i++)
2831 if (isdigit (my_string[i]))
2832 addr = (my_string[i] - '0') + (addr * 10);
2834 error (_("invalid decimal \"%s\""), my_string);
2842 gdb_realpath (const char *filename)
2844 /* On most hosts, we rely on canonicalize_file_name to compute
2845 the FILENAME's realpath.
2847 But the situation is slightly more complex on Windows, due to some
2848 versions of GCC which were reported to generate paths where
2849 backlashes (the directory separator) were doubled. For instance:
2850 c:\\some\\double\\slashes\\dir
2852 c:\some\double\slashes\dir
2853 Those double-slashes were getting in the way when comparing paths,
2854 for instance when trying to insert a breakpoint as follow:
2855 (gdb) b c:/some/double/slashes/dir/foo.c:4
2856 No source file named c:/some/double/slashes/dir/foo.c:4.
2857 (gdb) b c:\some\double\slashes\dir\foo.c:4
2858 No source file named c:\some\double\slashes\dir\foo.c:4.
2859 To prevent this from happening, we need this function to always
2860 strip those extra backslashes. While canonicalize_file_name does
2861 perform this simplification, it only works when the path is valid.
2862 Since the simplification would be useful even if the path is not
2863 valid (one can always set a breakpoint on a file, even if the file
2864 does not exist locally), we rely instead on GetFullPathName to
2865 perform the canonicalization. */
2867 #if defined (_WIN32)
2870 DWORD len = GetFullPathName (filename, MAX_PATH, buf, NULL);
2872 /* The file system is case-insensitive but case-preserving.
2873 So it is important we do not lowercase the path. Otherwise,
2874 we might not be able to display the original casing in a given
2876 if (len > 0 && len < MAX_PATH)
2877 return xstrdup (buf);
2881 char *rp = canonicalize_file_name (filename);
2888 /* This system is a lost cause, just dup the buffer. */
2889 return xstrdup (filename);
2892 /* Return a copy of FILENAME, with its directory prefix canonicalized
2896 gdb_realpath_keepfile (const char *filename)
2898 const char *base_name = lbasename (filename);
2903 /* Extract the basename of filename, and return immediately
2904 a copy of filename if it does not contain any directory prefix. */
2905 if (base_name == filename)
2906 return xstrdup (filename);
2908 dir_name = (char *) alloca ((size_t) (base_name - filename + 2));
2909 /* Allocate enough space to store the dir_name + plus one extra
2910 character sometimes needed under Windows (see below), and
2911 then the closing \000 character. */
2912 strncpy (dir_name, filename, base_name - filename);
2913 dir_name[base_name - filename] = '\000';
2915 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
2916 /* We need to be careful when filename is of the form 'd:foo', which
2917 is equivalent of d:./foo, which is totally different from d:/foo. */
2918 if (strlen (dir_name) == 2 && isalpha (dir_name[0]) && dir_name[1] == ':')
2921 dir_name[3] = '\000';
2925 /* Canonicalize the directory prefix, and build the resulting
2926 filename. If the dirname realpath already contains an ending
2927 directory separator, avoid doubling it. */
2928 real_path = gdb_realpath (dir_name);
2929 if (IS_DIR_SEPARATOR (real_path[strlen (real_path) - 1]))
2930 result = concat (real_path, base_name, (char *) NULL);
2932 result = concat (real_path, SLASH_STRING, base_name, (char *) NULL);
2938 /* Return PATH in absolute form, performing tilde-expansion if necessary.
2939 PATH cannot be NULL or the empty string.
2940 This does not resolve symlinks however, use gdb_realpath for that.
2941 Space for the result is allocated with malloc.
2942 If the path is already absolute, it is strdup'd.
2943 If there is a problem computing the absolute path, the path is returned
2944 unchanged (still strdup'd). */
2947 gdb_abspath (const char *path)
2949 gdb_assert (path != NULL && path[0] != '\0');
2952 return tilde_expand (path);
2954 if (IS_ABSOLUTE_PATH (path))
2955 return xstrdup (path);
2957 /* Beware the // my son, the Emacs barfs, the botch that catch... */
2958 return concat (current_directory,
2959 IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1])
2960 ? "" : SLASH_STRING,
2961 path, (char *) NULL);
2965 align_up (ULONGEST v, int n)
2967 /* Check that N is really a power of two. */
2968 gdb_assert (n && (n & (n-1)) == 0);
2969 return (v + n - 1) & -n;
2973 align_down (ULONGEST v, int n)
2975 /* Check that N is really a power of two. */
2976 gdb_assert (n && (n & (n-1)) == 0);
2980 /* Allocation function for the libiberty hash table which uses an
2981 obstack. The obstack is passed as DATA. */
2984 hashtab_obstack_allocate (void *data, size_t size, size_t count)
2986 size_t total = size * count;
2987 void *ptr = obstack_alloc ((struct obstack *) data, total);
2989 memset (ptr, 0, total);
2993 /* Trivial deallocation function for the libiberty splay tree and hash
2994 table - don't deallocate anything. Rely on later deletion of the
2995 obstack. DATA will be the obstack, although it is not needed
2999 dummy_obstack_deallocate (void *object, void *data)
3004 /* Simple, portable version of dirname that does not modify its
3008 ldirname (const char *filename)
3010 const char *base = lbasename (filename);
3013 while (base > filename && IS_DIR_SEPARATOR (base[-1]))
3016 if (base == filename)
3019 dirname = (char *) xmalloc (base - filename + 2);
3020 memcpy (dirname, filename, base - filename);
3022 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3023 create "d:./bar" later instead of the (different) "d:/bar". */
3024 if (base - filename == 2 && IS_ABSOLUTE_PATH (base)
3025 && !IS_DIR_SEPARATOR (filename[0]))
3026 dirname[base++ - filename] = '.';
3028 dirname[base - filename] = '\0';
3032 /* Call libiberty's buildargv, and return the result.
3033 If buildargv fails due to out-of-memory, call nomem.
3034 Therefore, the returned value is guaranteed to be non-NULL,
3035 unless the parameter itself is NULL. */
3038 gdb_buildargv (const char *s)
3040 char **argv = buildargv (s);
3042 if (s != NULL && argv == NULL)
3048 compare_positive_ints (const void *ap, const void *bp)
3050 /* Because we know we're comparing two ints which are positive,
3051 there's no danger of overflow here. */
3052 return * (int *) ap - * (int *) bp;
3055 /* String compare function for qsort. */
3058 compare_strings (const void *arg1, const void *arg2)
3060 const char **s1 = (const char **) arg1;
3061 const char **s2 = (const char **) arg2;
3063 return strcmp (*s1, *s2);
3066 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3067 #define AMBIGUOUS_MESS2 \
3068 ".\nUse \"set gnutarget format-name\" to specify the format."
3071 gdb_bfd_errmsg (bfd_error_type error_tag, char **matching)
3077 /* Check if errmsg just need simple return. */
3078 if (error_tag != bfd_error_file_ambiguously_recognized || matching == NULL)
3079 return bfd_errmsg (error_tag);
3081 ret_len = strlen (bfd_errmsg (error_tag)) + strlen (AMBIGUOUS_MESS1)
3082 + strlen (AMBIGUOUS_MESS2);
3083 for (p = matching; *p; p++)
3084 ret_len += strlen (*p) + 1;
3085 ret = (char *) xmalloc (ret_len + 1);
3087 make_cleanup (xfree, ret);
3089 strcpy (retp, bfd_errmsg (error_tag));
3090 retp += strlen (retp);
3092 strcpy (retp, AMBIGUOUS_MESS1);
3093 retp += strlen (retp);
3095 for (p = matching; *p; p++)
3097 sprintf (retp, " %s", *p);
3098 retp += strlen (retp);
3102 strcpy (retp, AMBIGUOUS_MESS2);
3107 /* Return ARGS parsed as a valid pid, or throw an error. */
3110 parse_pid_to_attach (const char *args)
3116 error_no_arg (_("process-id to attach"));
3118 dummy = (char *) args;
3119 pid = strtoul (args, &dummy, 0);
3120 /* Some targets don't set errno on errors, grrr! */
3121 if ((pid == 0 && dummy == args) || dummy != &args[strlen (args)])
3122 error (_("Illegal process-id: %s."), args);
3127 /* Helper for make_bpstat_clear_actions_cleanup. */
3130 do_bpstat_clear_actions_cleanup (void *unused)
3132 bpstat_clear_actions ();
3135 /* Call bpstat_clear_actions for the case an exception is throw. You should
3136 discard_cleanups if no exception is caught. */
3139 make_bpstat_clear_actions_cleanup (void)
3141 return make_cleanup (do_bpstat_clear_actions_cleanup, NULL);
3144 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3145 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3146 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3149 producer_is_gcc_ge_4 (const char *producer)
3153 if (! producer_is_gcc (producer, &major, &minor))
3162 /* Returns nonzero if the given PRODUCER string is GCC and sets the MAJOR
3163 and MINOR versions when not NULL. Returns zero if the given PRODUCER
3164 is NULL or it isn't GCC. */
3167 producer_is_gcc (const char *producer, int *major, int *minor)
3171 if (producer != NULL && startswith (producer, "GNU "))
3180 /* Skip any identifier after "GNU " - such as "C11" "C++" or "Java".
3181 A full producer string might look like:
3183 "GNU Fortran 4.8.2 20140120 (Red Hat 4.8.2-16) -mtune=generic ..."
3184 "GNU C++14 5.0.0 20150123 (experimental)"
3186 cs = &producer[strlen ("GNU ")];
3187 while (*cs && !isspace (*cs))
3189 if (*cs && isspace (*cs))
3191 if (sscanf (cs, "%d.%d", major, minor) == 2)
3195 /* Not recognized as GCC. */
3199 /* Helper for make_cleanup_free_char_ptr_vec. */
3202 do_free_char_ptr_vec (void *arg)
3204 VEC (char_ptr) *char_ptr_vec = (VEC (char_ptr) *) arg;
3206 free_char_ptr_vec (char_ptr_vec);
3209 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3210 final VEC_free for CHAR_PTR_VEC itself.
3212 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3213 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3214 this function does not (cannot) clear the pointer. */
3217 make_cleanup_free_char_ptr_vec (VEC (char_ptr) *char_ptr_vec)
3219 return make_cleanup (do_free_char_ptr_vec, char_ptr_vec);
3222 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3223 must come from xrealloc-compatible allocator and it may be updated. FROM
3224 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3225 located at the start or end of *STRINGP. */
3228 substitute_path_component (char **stringp, const char *from, const char *to)
3230 char *string = *stringp, *s;
3231 const size_t from_len = strlen (from);
3232 const size_t to_len = strlen (to);
3236 s = strstr (s, from);
3240 if ((s == string || IS_DIR_SEPARATOR (s[-1])
3241 || s[-1] == DIRNAME_SEPARATOR)
3242 && (s[from_len] == '\0' || IS_DIR_SEPARATOR (s[from_len])
3243 || s[from_len] == DIRNAME_SEPARATOR))
3248 = (char *) xrealloc (string, (strlen (string) + to_len + 1));
3250 /* Relocate the current S pointer. */
3251 s = s - string + string_new;
3252 string = string_new;
3254 /* Replace from by to. */
3255 memmove (&s[to_len], &s[from_len], strlen (&s[from_len]) + 1);
3256 memcpy (s, to, to_len);
3271 /* SIGALRM handler for waitpid_with_timeout. */
3274 sigalrm_handler (int signo)
3276 /* Nothing to do. */
3281 /* Wrapper to wait for child PID to die with TIMEOUT.
3282 TIMEOUT is the time to stop waiting in seconds.
3283 If TIMEOUT is zero, pass WNOHANG to waitpid.
3284 Returns PID if it was successfully waited for, otherwise -1.
3286 Timeouts are currently implemented with alarm and SIGALRM.
3287 If the host does not support them, this waits "forever".
3288 It would be odd though for a host to have waitpid and not SIGALRM. */
3291 wait_to_die_with_timeout (pid_t pid, int *status, int timeout)
3293 pid_t waitpid_result;
3295 gdb_assert (pid > 0);
3296 gdb_assert (timeout >= 0);
3301 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3302 struct sigaction sa, old_sa;
3304 sa.sa_handler = sigalrm_handler;
3305 sigemptyset (&sa.sa_mask);
3307 sigaction (SIGALRM, &sa, &old_sa);
3311 ofunc = signal (SIGALRM, sigalrm_handler);
3317 waitpid_result = waitpid (pid, status, 0);
3321 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3322 sigaction (SIGALRM, &old_sa, NULL);
3324 signal (SIGALRM, ofunc);
3329 waitpid_result = waitpid (pid, status, WNOHANG);
3331 if (waitpid_result == pid)
3337 #endif /* HAVE_WAITPID */
3339 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3340 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3342 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3343 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3346 gdb_filename_fnmatch (const char *pattern, const char *string, int flags)
3348 gdb_assert ((flags & FNM_FILE_NAME) != 0);
3350 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3351 gdb_assert ((flags & FNM_NOESCAPE) != 0);
3353 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3355 char *pattern_slash, *string_slash;
3357 /* Replace '\' by '/' in both strings. */
3359 pattern_slash = (char *) alloca (strlen (pattern) + 1);
3360 strcpy (pattern_slash, pattern);
3361 pattern = pattern_slash;
3362 for (; *pattern_slash != 0; pattern_slash++)
3363 if (IS_DIR_SEPARATOR (*pattern_slash))
3364 *pattern_slash = '/';
3366 string_slash = (char *) alloca (strlen (string) + 1);
3367 strcpy (string_slash, string);
3368 string = string_slash;
3369 for (; *string_slash != 0; string_slash++)
3370 if (IS_DIR_SEPARATOR (*string_slash))
3371 *string_slash = '/';
3373 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3375 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3376 flags |= FNM_CASEFOLD;
3377 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3379 return fnmatch (pattern, string, flags);
3382 /* Provide a prototype to silence -Wmissing-prototypes. */
3383 extern initialize_file_ftype _initialize_utils;
3386 _initialize_utils (void)
3388 add_internal_problem_command (&internal_error_problem);
3389 add_internal_problem_command (&internal_warning_problem);
3390 add_internal_problem_command (&demangler_warning_problem);