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 that strings with character values >0x7F should be printed
113 as octal escapes. Zero means just print the value (e.g. it's an
114 international character, and the terminal or window can cope.) */
116 int sevenbit_strings = 0;
118 show_sevenbit_strings (struct ui_file *file, int from_tty,
119 struct cmd_list_element *c, const char *value)
121 fprintf_filtered (file, _("Printing of 8-bit characters "
122 "in strings as \\nnn is %s.\n"),
126 /* String to be printed before warning messages, if any. */
128 char *warning_pre_print = "\nwarning: ";
130 int pagination_enabled = 1;
132 show_pagination_enabled (struct ui_file *file, int from_tty,
133 struct cmd_list_element *c, const char *value)
135 fprintf_filtered (file, _("State of pagination is %s.\n"), value);
139 /* Cleanup utilities.
141 These are not defined in cleanups.c (nor declared in cleanups.h)
142 because while they use the "cleanup API" they are not part of the
146 do_freeargv (void *arg)
148 freeargv ((char **) arg);
152 make_cleanup_freeargv (char **arg)
154 return make_cleanup (do_freeargv, arg);
158 do_dyn_string_delete (void *arg)
160 dyn_string_delete ((dyn_string_t) arg);
164 make_cleanup_dyn_string_delete (dyn_string_t arg)
166 return make_cleanup (do_dyn_string_delete, arg);
170 do_bfd_close_cleanup (void *arg)
172 gdb_bfd_unref ((bfd *) arg);
176 make_cleanup_bfd_unref (bfd *abfd)
178 return make_cleanup (do_bfd_close_cleanup, abfd);
181 /* Helper function which does the work for make_cleanup_fclose. */
184 do_fclose_cleanup (void *arg)
186 FILE *file = (FILE *) arg;
191 /* Return a new cleanup that closes FILE. */
194 make_cleanup_fclose (FILE *file)
196 return make_cleanup (do_fclose_cleanup, file);
199 /* Helper function which does the work for make_cleanup_obstack_free. */
202 do_obstack_free (void *arg)
204 struct obstack *ob = (struct obstack *) arg;
206 obstack_free (ob, NULL);
209 /* Return a new cleanup that frees OBSTACK. */
212 make_cleanup_obstack_free (struct obstack *obstack)
214 return make_cleanup (do_obstack_free, obstack);
218 do_ui_file_delete (void *arg)
220 ui_file_delete ((struct ui_file *) arg);
224 make_cleanup_ui_file_delete (struct ui_file *arg)
226 return make_cleanup (do_ui_file_delete, arg);
229 /* Helper function for make_cleanup_ui_out_redirect_pop. */
232 do_ui_out_redirect_pop (void *arg)
234 struct ui_out *uiout = (struct ui_out *) arg;
236 if (ui_out_redirect (uiout, NULL) < 0)
237 warning (_("Cannot restore redirection of the current output protocol"));
240 /* Return a new cleanup that pops the last redirection by ui_out_redirect
241 with NULL parameter. */
244 make_cleanup_ui_out_redirect_pop (struct ui_out *uiout)
246 return make_cleanup (do_ui_out_redirect_pop, uiout);
250 do_free_section_addr_info (void *arg)
252 free_section_addr_info ((struct section_addr_info *) arg);
256 make_cleanup_free_section_addr_info (struct section_addr_info *addrs)
258 return make_cleanup (do_free_section_addr_info, addrs);
261 struct restore_integer_closure
268 restore_integer (void *p)
270 struct restore_integer_closure *closure
271 = (struct restore_integer_closure *) p;
273 *(closure->variable) = closure->value;
276 /* Remember the current value of *VARIABLE and make it restored when
277 the cleanup is run. */
280 make_cleanup_restore_integer (int *variable)
282 struct restore_integer_closure *c = XNEW (struct restore_integer_closure);
284 c->variable = variable;
285 c->value = *variable;
287 return make_cleanup_dtor (restore_integer, (void *) c, xfree);
290 /* Remember the current value of *VARIABLE and make it restored when
291 the cleanup is run. */
294 make_cleanup_restore_uinteger (unsigned int *variable)
296 return make_cleanup_restore_integer ((int *) variable);
299 /* Helper for make_cleanup_unpush_target. */
302 do_unpush_target (void *arg)
304 struct target_ops *ops = (struct target_ops *) arg;
309 /* Return a new cleanup that unpushes OPS. */
312 make_cleanup_unpush_target (struct target_ops *ops)
314 return make_cleanup (do_unpush_target, ops);
317 /* Helper for make_cleanup_htab_delete compile time checking the types. */
320 do_htab_delete_cleanup (void *htab_voidp)
322 htab_t htab = (htab_t) htab_voidp;
327 /* Return a new cleanup that deletes HTAB. */
330 make_cleanup_htab_delete (htab_t htab)
332 return make_cleanup (do_htab_delete_cleanup, htab);
335 struct restore_ui_out_closure
337 struct ui_out **variable;
338 struct ui_out *value;
341 struct restore_ui_file_closure
343 struct ui_file **variable;
344 struct ui_file *value;
348 do_restore_ui_file (void *p)
350 struct restore_ui_file_closure *closure
351 = (struct restore_ui_file_closure *) p;
353 *(closure->variable) = closure->value;
356 /* Remember the current value of *VARIABLE and make it restored when
357 the cleanup is run. */
360 make_cleanup_restore_ui_file (struct ui_file **variable)
362 struct restore_ui_file_closure *c = XNEW (struct restore_ui_file_closure);
364 c->variable = variable;
365 c->value = *variable;
367 return make_cleanup_dtor (do_restore_ui_file, (void *) c, xfree);
370 /* Helper for make_cleanup_value_free_to_mark. */
373 do_value_free_to_mark (void *value)
375 value_free_to_mark ((struct value *) value);
378 /* Free all values allocated since MARK was obtained by value_mark
379 (except for those released) when the cleanup is run. */
382 make_cleanup_value_free_to_mark (struct value *mark)
384 return make_cleanup (do_value_free_to_mark, mark);
387 /* Helper for make_cleanup_value_free. */
390 do_value_free (void *value)
392 value_free ((struct value *) value);
398 make_cleanup_value_free (struct value *value)
400 return make_cleanup (do_value_free, value);
403 /* Helper for make_cleanup_free_so. */
406 do_free_so (void *arg)
408 struct so_list *so = (struct so_list *) arg;
413 /* Make cleanup handler calling free_so for SO. */
416 make_cleanup_free_so (struct so_list *so)
418 return make_cleanup (do_free_so, so);
421 /* Helper for make_cleanup_restore_current_language. */
424 do_restore_current_language (void *p)
426 enum language saved_lang = (enum language) (uintptr_t) p;
428 set_language (saved_lang);
431 /* Remember the current value of CURRENT_LANGUAGE and make it restored when
432 the cleanup is run. */
435 make_cleanup_restore_current_language (void)
437 enum language saved_lang = current_language->la_language;
439 return make_cleanup (do_restore_current_language,
440 (void *) (uintptr_t) saved_lang);
443 /* Helper function for make_cleanup_clear_parser_state. */
446 do_clear_parser_state (void *ptr)
448 struct parser_state **p = (struct parser_state **) ptr;
453 /* Clean (i.e., set to NULL) the parser state variable P. */
456 make_cleanup_clear_parser_state (struct parser_state **p)
458 return make_cleanup (do_clear_parser_state, (void *) p);
461 /* This function is useful for cleanups.
465 old_chain = make_cleanup (free_current_contents, &foo);
467 to arrange to free the object thus allocated. */
470 free_current_contents (void *ptr)
472 void **location = (void **) ptr;
474 if (location == NULL)
475 internal_error (__FILE__, __LINE__,
476 _("free_current_contents: NULL pointer"));
477 if (*location != NULL)
486 /* Print a warning message. The first argument STRING is the warning
487 message, used as an fprintf format string, the second is the
488 va_list of arguments for that string. A warning is unfiltered (not
489 paginated) so that the user does not need to page through each
490 screen full of warnings when there are lots of them. */
493 vwarning (const char *string, va_list args)
495 if (deprecated_warning_hook)
496 (*deprecated_warning_hook) (string, args);
499 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
501 if (target_supports_terminal_ours ())
503 make_cleanup_restore_target_terminal ();
504 target_terminal_ours_for_output ();
506 if (filtered_printing_initialized ())
507 wrap_here (""); /* Force out any buffered output. */
508 gdb_flush (gdb_stdout);
509 if (warning_pre_print)
510 fputs_unfiltered (warning_pre_print, gdb_stderr);
511 vfprintf_unfiltered (gdb_stderr, string, args);
512 fprintf_unfiltered (gdb_stderr, "\n");
514 do_cleanups (old_chain);
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 ())
713 make_cleanup_restore_target_terminal ();
714 target_terminal_ours_for_output ();
716 if (filtered_printing_initialized ())
719 /* Emit the message unless query will emit it below. */
720 if (problem->should_quit != internal_problem_ask
722 || !filtered_printing_initialized ())
723 fprintf_unfiltered (gdb_stderr, "%s\n", reason);
725 if (problem->should_quit == internal_problem_ask)
727 /* Default (yes/batch case) is to quit GDB. When in batch mode
728 this lessens the likelihood of GDB going into an infinite
730 if (!confirm || !filtered_printing_initialized ())
733 quit_p = query (_("%s\nQuit this debugging session? "), reason);
735 else if (problem->should_quit == internal_problem_yes)
737 else if (problem->should_quit == internal_problem_no)
740 internal_error (__FILE__, __LINE__, _("bad switch"));
742 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr);
743 if (REPORT_BUGS_TO[0])
744 fprintf_unfiltered (gdb_stderr, _(" For instructions, see:\n%s."),
746 fputs_unfiltered ("\n\n", gdb_stderr);
748 if (problem->should_dump_core == internal_problem_ask)
750 if (!can_dump_core_warn (LIMIT_MAX, reason))
752 else if (!filtered_printing_initialized ())
756 /* Default (yes/batch case) is to dump core. This leaves a GDB
757 `dropping' so that it is easier to see that something went
759 dump_core_p = query (_("%s\nCreate a core file of GDB? "), reason);
762 else if (problem->should_dump_core == internal_problem_yes)
763 dump_core_p = can_dump_core_warn (LIMIT_MAX, reason);
764 else if (problem->should_dump_core == internal_problem_no)
767 internal_error (__FILE__, __LINE__, _("bad switch"));
780 #ifdef HAVE_WORKING_FORK
788 do_cleanups (cleanup);
791 static struct internal_problem internal_error_problem = {
792 "internal-error", 1, internal_problem_ask, 1, internal_problem_ask
796 internal_verror (const char *file, int line, const char *fmt, va_list ap)
798 internal_vproblem (&internal_error_problem, file, line, fmt, ap);
799 throw_quit (_("Command aborted."));
802 static struct internal_problem internal_warning_problem = {
803 "internal-warning", 1, internal_problem_ask, 1, internal_problem_ask
807 internal_vwarning (const char *file, int line, const char *fmt, va_list ap)
809 internal_vproblem (&internal_warning_problem, file, line, fmt, ap);
812 static struct internal_problem demangler_warning_problem = {
813 "demangler-warning", 1, internal_problem_ask, 0, internal_problem_no
817 demangler_vwarning (const char *file, int line, const char *fmt, va_list ap)
819 internal_vproblem (&demangler_warning_problem, file, line, fmt, ap);
823 demangler_warning (const char *file, int line, const char *string, ...)
827 va_start (ap, string);
828 demangler_vwarning (file, line, string, ap);
832 /* Dummy functions to keep add_prefix_cmd happy. */
835 set_internal_problem_cmd (char *args, int from_tty)
840 show_internal_problem_cmd (char *args, int from_tty)
844 /* When GDB reports an internal problem (error or warning) it gives
845 the user the opportunity to quit GDB and/or create a core file of
846 the current debug session. This function registers a few commands
847 that make it possible to specify that GDB should always or never
848 quit or create a core file, without asking. The commands look
851 maint set PROBLEM-NAME quit ask|yes|no
852 maint show PROBLEM-NAME quit
853 maint set PROBLEM-NAME corefile ask|yes|no
854 maint show PROBLEM-NAME corefile
856 Where PROBLEM-NAME is currently "internal-error" or
857 "internal-warning". */
860 add_internal_problem_command (struct internal_problem *problem)
862 struct cmd_list_element **set_cmd_list;
863 struct cmd_list_element **show_cmd_list;
867 set_cmd_list = XNEW (struct cmd_list_element *);
868 show_cmd_list = XNEW (struct cmd_list_element *);
869 *set_cmd_list = NULL;
870 *show_cmd_list = NULL;
872 set_doc = xstrprintf (_("Configure what GDB does when %s is detected."),
875 show_doc = xstrprintf (_("Show what GDB does when %s is detected."),
878 add_prefix_cmd ((char*) problem->name,
879 class_maintenance, set_internal_problem_cmd, set_doc,
881 concat ("maintenance set ", problem->name, " ",
883 0/*allow-unknown*/, &maintenance_set_cmdlist);
885 add_prefix_cmd ((char*) problem->name,
886 class_maintenance, show_internal_problem_cmd, show_doc,
888 concat ("maintenance show ", problem->name, " ",
890 0/*allow-unknown*/, &maintenance_show_cmdlist);
892 if (problem->user_settable_should_quit)
894 set_doc = xstrprintf (_("Set whether GDB should quit "
895 "when an %s is detected"),
897 show_doc = xstrprintf (_("Show whether GDB will quit "
898 "when an %s is detected"),
900 add_setshow_enum_cmd ("quit", class_maintenance,
901 internal_problem_modes,
902 &problem->should_quit,
915 if (problem->user_settable_should_dump_core)
917 set_doc = xstrprintf (_("Set whether GDB should create a core "
918 "file of GDB when %s is detected"),
920 show_doc = xstrprintf (_("Show whether GDB will create a core "
921 "file of GDB when %s is detected"),
923 add_setshow_enum_cmd ("corefile", class_maintenance,
924 internal_problem_modes,
925 &problem->should_dump_core,
939 /* Return a newly allocated string, containing the PREFIX followed
940 by the system error message for errno (separated by a colon).
942 The result must be deallocated after use. */
945 perror_string (const char *prefix)
950 err = safe_strerror (errno);
951 combined = (char *) xmalloc (strlen (err) + strlen (prefix) + 3);
952 strcpy (combined, prefix);
953 strcat (combined, ": ");
954 strcat (combined, err);
959 /* Print the system error message for errno, and also mention STRING
960 as the file name for which the error was encountered. Use ERRCODE
961 for the thrown exception. Then return to command level. */
964 throw_perror_with_name (enum errors errcode, const char *string)
968 combined = perror_string (string);
969 make_cleanup (xfree, combined);
971 /* I understand setting these is a matter of taste. Still, some people
972 may clear errno but not know about bfd_error. Doing this here is not
974 bfd_set_error (bfd_error_no_error);
977 throw_error (errcode, _("%s."), combined);
980 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
983 perror_with_name (const char *string)
985 throw_perror_with_name (GENERIC_ERROR, string);
988 /* Same as perror_with_name except that it prints a warning instead
989 of throwing an error. */
992 perror_warning_with_name (const char *string)
996 combined = perror_string (string);
997 warning (_("%s"), combined);
1001 /* Print the system error message for ERRCODE, and also mention STRING
1002 as the file name for which the error was encountered. */
1005 print_sys_errmsg (const char *string, int errcode)
1010 err = safe_strerror (errcode);
1011 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
1012 strcpy (combined, string);
1013 strcat (combined, ": ");
1014 strcat (combined, err);
1016 /* We want anything which was printed on stdout to come out first, before
1018 gdb_flush (gdb_stdout);
1019 fprintf_unfiltered (gdb_stderr, "%s.\n", combined);
1022 /* Control C eventually causes this to be called, at a convenient time. */
1027 struct ui *ui = current_ui;
1029 if (sync_quit_force_run)
1031 sync_quit_force_run = 0;
1032 quit_force (NULL, 0);
1036 /* No steenking SIGINT will ever be coming our way when the
1037 program is resumed. Don't lie. */
1038 throw_quit ("Quit");
1041 /* If there is no terminal switching for this target, then we can't
1042 possibly get screwed by the lack of job control. */
1043 || !target_supports_terminal_ours ())
1044 throw_quit ("Quit");
1046 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
1055 if (sync_quit_force_run)
1060 if (deprecated_interactive_hook)
1061 deprecated_interactive_hook ();
1065 /* Called when a memory allocation fails, with the number of bytes of
1066 memory requested in SIZE. */
1069 malloc_failure (long size)
1073 internal_error (__FILE__, __LINE__,
1074 _("virtual memory exhausted: can't allocate %ld bytes."),
1079 internal_error (__FILE__, __LINE__, _("virtual memory exhausted."));
1083 /* My replacement for the read system call.
1084 Used like `read' but keeps going if `read' returns too soon. */
1087 myread (int desc, char *addr, int len)
1094 val = read (desc, addr, len);
1098 return orglen - len;
1106 print_spaces (int n, struct ui_file *file)
1108 fputs_unfiltered (n_spaces (n), file);
1111 /* Print a host address. */
1114 gdb_print_host_address_1 (const void *addr, struct ui_file *stream)
1116 fprintf_filtered (stream, "%s", host_address_to_string (addr));
1122 make_hex_string (const gdb_byte *data, size_t length)
1124 char *result = (char *) xmalloc (length * 2 + 1);
1129 for (i = 0; i < length; ++i)
1130 p += xsnprintf (p, 3, "%02x", data[i]);
1137 /* A cleanup function that calls regfree. */
1140 do_regfree_cleanup (void *r)
1142 regfree ((regex_t *) r);
1145 /* Create a new cleanup that frees the compiled regular expression R. */
1148 make_regfree_cleanup (regex_t *r)
1150 return make_cleanup (do_regfree_cleanup, r);
1153 /* Return an xmalloc'd error message resulting from a regular
1154 expression compilation failure. */
1157 get_regcomp_error (int code, regex_t *rx)
1159 size_t length = regerror (code, rx, NULL, 0);
1160 char *result = (char *) xmalloc (length);
1162 regerror (code, rx, result, length);
1166 /* Compile a regexp and throw an exception on error. This returns a
1167 cleanup to free the resulting pattern on success. RX must not be
1171 compile_rx_or_error (regex_t *pattern, const char *rx, const char *message)
1175 gdb_assert (rx != NULL);
1177 code = regcomp (pattern, rx, REG_NOSUB);
1180 char *err = get_regcomp_error (code, pattern);
1182 make_cleanup (xfree, err);
1183 error (("%s: %s"), message, err);
1186 return make_regfree_cleanup (pattern);
1189 /* A cleanup that simply calls ui_unregister_input_event_handler. */
1192 ui_unregister_input_event_handler_cleanup (void *ui)
1194 ui_unregister_input_event_handler ((struct ui *) ui);
1197 /* Set up to handle input. */
1199 static struct cleanup *
1200 prepare_to_handle_input (void)
1202 struct cleanup *old_chain;
1204 old_chain = make_cleanup_restore_target_terminal ();
1205 target_terminal_ours ();
1207 ui_register_input_event_handler (current_ui);
1208 if (current_ui->prompt_state == PROMPT_BLOCKED)
1209 make_cleanup (ui_unregister_input_event_handler_cleanup, current_ui);
1211 make_cleanup_override_quit_handler (default_quit_handler);
1218 /* This function supports the query, nquery, and yquery functions.
1219 Ask user a y-or-n question and return 0 if answer is no, 1 if
1220 answer is yes, or default the answer to the specified default
1221 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1222 default answer, or '\0' for no default.
1223 CTLSTR is the control string and should end in "? ". It should
1224 not say how to answer, because we do that.
1225 ARGS are the arguments passed along with the CTLSTR argument to
1228 static int ATTRIBUTE_PRINTF (1, 0)
1229 defaulted_query (const char *ctlstr, const char defchar, va_list args)
1234 char def_answer, not_def_answer;
1235 char *y_string, *n_string, *question, *prompt;
1236 /* Used to add duration we waited for user to respond to
1237 prompt_for_continue_wait_time. */
1238 struct timeval prompt_started, prompt_ended, prompt_delta;
1239 struct cleanup *old_chain;
1241 /* Set up according to which answer is the default. */
1242 if (defchar == '\0')
1246 not_def_answer = 'N';
1250 else if (defchar == 'y')
1254 not_def_answer = 'N';
1262 not_def_answer = 'Y';
1267 /* Automatically answer the default value if the user did not want
1268 prompts or the command was issued with the server prefix. */
1269 if (!confirm || server_command)
1272 /* If input isn't coming from the user directly, just say what
1273 question we're asking, and then answer the default automatically. This
1274 way, important error messages don't get lost when talking to GDB
1276 if (current_ui->instream != current_ui->stdin_stream
1277 || !input_interactive_p (current_ui))
1279 old_chain = make_cleanup_restore_target_terminal ();
1281 target_terminal_ours_for_output ();
1283 vfprintf_filtered (gdb_stdout, ctlstr, args);
1285 printf_filtered (_("(%s or %s) [answered %c; "
1286 "input not from terminal]\n"),
1287 y_string, n_string, def_answer);
1288 gdb_flush (gdb_stdout);
1290 do_cleanups (old_chain);
1294 if (deprecated_query_hook)
1298 old_chain = make_cleanup_restore_target_terminal ();
1299 res = deprecated_query_hook (ctlstr, args);
1300 do_cleanups (old_chain);
1304 /* Format the question outside of the loop, to avoid reusing args. */
1305 question = xstrvprintf (ctlstr, args);
1306 old_chain = make_cleanup (xfree, question);
1307 prompt = xstrprintf (_("%s%s(%s or %s) %s"),
1308 annotation_level > 1 ? "\n\032\032pre-query\n" : "",
1309 question, y_string, n_string,
1310 annotation_level > 1 ? "\n\032\032query\n" : "");
1311 make_cleanup (xfree, prompt);
1313 /* Used for calculating time spend waiting for user. */
1314 gettimeofday (&prompt_started, NULL);
1316 prepare_to_handle_input ();
1320 char *response, answer;
1322 gdb_flush (gdb_stdout);
1323 response = gdb_readline_wrapper (prompt);
1325 if (response == NULL) /* C-d */
1327 printf_filtered ("EOF [assumed %c]\n", def_answer);
1332 answer = response[0];
1337 /* Check answer. For the non-default, the user must specify
1338 the non-default explicitly. */
1339 if (answer == not_def_answer)
1341 retval = !def_value;
1344 /* Otherwise, if a default was specified, the user may either
1345 specify the required input or have it default by entering
1347 if (answer == def_answer
1348 || (defchar != '\0' && answer == '\0'))
1353 /* Invalid entries are not defaulted and require another selection. */
1354 printf_filtered (_("Please answer %s or %s.\n"),
1355 y_string, n_string);
1358 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1359 gettimeofday (&prompt_ended, NULL);
1360 timeval_sub (&prompt_delta, &prompt_ended, &prompt_started);
1361 timeval_add (&prompt_for_continue_wait_time,
1362 &prompt_for_continue_wait_time, &prompt_delta);
1364 if (annotation_level > 1)
1365 printf_filtered (("\n\032\032post-query\n"));
1366 do_cleanups (old_chain);
1371 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1372 answer is yes, or 0 if answer is defaulted.
1373 Takes three args which are given to printf to print the question.
1374 The first, a control string, should end in "? ".
1375 It should not say how to answer, because we do that. */
1378 nquery (const char *ctlstr, ...)
1383 va_start (args, ctlstr);
1384 ret = defaulted_query (ctlstr, 'n', args);
1389 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1390 answer is yes, or 1 if answer is defaulted.
1391 Takes three args which are given to printf to print the question.
1392 The first, a control string, should end in "? ".
1393 It should not say how to answer, because we do that. */
1396 yquery (const char *ctlstr, ...)
1401 va_start (args, ctlstr);
1402 ret = defaulted_query (ctlstr, 'y', args);
1407 /* Ask user a y-or-n question and return 1 iff answer is yes.
1408 Takes three args which are given to printf to print the question.
1409 The first, a control string, should end in "? ".
1410 It should not say how to answer, because we do that. */
1413 query (const char *ctlstr, ...)
1418 va_start (args, ctlstr);
1419 ret = defaulted_query (ctlstr, '\0', args);
1424 /* A helper for parse_escape that converts a host character to a
1425 target character. C is the host character. If conversion is
1426 possible, then the target character is stored in *TARGET_C and the
1427 function returns 1. Otherwise, the function returns 0. */
1430 host_char_to_target (struct gdbarch *gdbarch, int c, int *target_c)
1432 struct obstack host_data;
1434 struct cleanup *cleanups;
1437 obstack_init (&host_data);
1438 cleanups = make_cleanup_obstack_free (&host_data);
1440 convert_between_encodings (target_charset (gdbarch), host_charset (),
1441 (gdb_byte *) &the_char, 1, 1,
1442 &host_data, translit_none);
1444 if (obstack_object_size (&host_data) == 1)
1447 *target_c = *(char *) obstack_base (&host_data);
1450 do_cleanups (cleanups);
1454 /* Parse a C escape sequence. STRING_PTR points to a variable
1455 containing a pointer to the string to parse. That pointer
1456 should point to the character after the \. That pointer
1457 is updated past the characters we use. The value of the
1458 escape sequence is returned.
1460 A negative value means the sequence \ newline was seen,
1461 which is supposed to be equivalent to nothing at all.
1463 If \ is followed by a null character, we return a negative
1464 value and leave the string pointer pointing at the null character.
1466 If \ is followed by 000, we return 0 and leave the string pointer
1467 after the zeros. A value of 0 does not mean end of string. */
1470 parse_escape (struct gdbarch *gdbarch, const char **string_ptr)
1472 int target_char = -2; /* Initialize to avoid GCC warnings. */
1473 int c = *(*string_ptr)++;
1492 int i = host_hex_value (c);
1497 if (isdigit (c) && c != '8' && c != '9')
1501 i += host_hex_value (c);
1537 if (!host_char_to_target (gdbarch, c, &target_char))
1538 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1539 " which has no equivalent\nin the `%s' character set."),
1540 c, c, target_charset (gdbarch));
1544 /* Print the character C on STREAM as part of the contents of a literal
1545 string whose delimiter is QUOTER. Note that this routine should only
1546 be called for printing things which are independent of the language
1547 of the program being debugged.
1549 printchar will normally escape backslashes and instances of QUOTER. If
1550 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1551 As a side effect, if you pass the backslash character as the QUOTER,
1552 printchar will escape backslashes as usual, but not any other quoting
1556 printchar (int c, void (*do_fputs) (const char *, struct ui_file *),
1557 void (*do_fprintf) (struct ui_file *, const char *, ...)
1558 ATTRIBUTE_FPTR_PRINTF_2, struct ui_file *stream, int quoter)
1560 c &= 0xFF; /* Avoid sign bit follies */
1562 if (c < 0x20 || /* Low control chars */
1563 (c >= 0x7F && c < 0xA0) || /* DEL, High controls */
1564 (sevenbit_strings && c >= 0x80))
1565 { /* high order bit set */
1569 do_fputs ("\\n", stream);
1572 do_fputs ("\\b", stream);
1575 do_fputs ("\\t", stream);
1578 do_fputs ("\\f", stream);
1581 do_fputs ("\\r", stream);
1584 do_fputs ("\\e", stream);
1587 do_fputs ("\\a", stream);
1590 do_fprintf (stream, "\\%.3o", (unsigned int) c);
1596 if (quoter != 0 && (c == '\\' || c == quoter))
1597 do_fputs ("\\", stream);
1598 do_fprintf (stream, "%c", c);
1602 /* Print the character C on STREAM as part of the contents of a
1603 literal string whose delimiter is QUOTER. Note that these routines
1604 should only be call for printing things which are independent of
1605 the language of the program being debugged. */
1608 fputstr_filtered (const char *str, int quoter, struct ui_file *stream)
1611 printchar (*str++, fputs_filtered, fprintf_filtered, stream, quoter);
1615 fputstr_unfiltered (const char *str, int quoter, struct ui_file *stream)
1618 printchar (*str++, fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1622 fputstrn_filtered (const char *str, int n, int quoter,
1623 struct ui_file *stream)
1627 for (i = 0; i < n; i++)
1628 printchar (str[i], fputs_filtered, fprintf_filtered, stream, quoter);
1632 fputstrn_unfiltered (const char *str, int n, int quoter,
1633 struct ui_file *stream)
1637 for (i = 0; i < n; i++)
1638 printchar (str[i], fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1642 /* Number of lines per page or UINT_MAX if paging is disabled. */
1643 static unsigned int lines_per_page;
1645 show_lines_per_page (struct ui_file *file, int from_tty,
1646 struct cmd_list_element *c, const char *value)
1648 fprintf_filtered (file,
1649 _("Number of lines gdb thinks are in a page is %s.\n"),
1653 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1654 static unsigned int chars_per_line;
1656 show_chars_per_line (struct ui_file *file, int from_tty,
1657 struct cmd_list_element *c, const char *value)
1659 fprintf_filtered (file,
1660 _("Number of characters gdb thinks "
1661 "are in a line is %s.\n"),
1665 /* Current count of lines printed on this page, chars on this line. */
1666 static unsigned int lines_printed, chars_printed;
1668 /* Buffer and start column of buffered text, for doing smarter word-
1669 wrapping. When someone calls wrap_here(), we start buffering output
1670 that comes through fputs_filtered(). If we see a newline, we just
1671 spit it out and forget about the wrap_here(). If we see another
1672 wrap_here(), we spit it out and remember the newer one. If we see
1673 the end of the line, we spit out a newline, the indent, and then
1674 the buffered output. */
1676 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1677 are waiting to be output (they have already been counted in chars_printed).
1678 When wrap_buffer[0] is null, the buffer is empty. */
1679 static char *wrap_buffer;
1681 /* Pointer in wrap_buffer to the next character to fill. */
1682 static char *wrap_pointer;
1684 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1686 static char *wrap_indent;
1688 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1689 is not in effect. */
1690 static int wrap_column;
1693 /* Inialize the number of lines per page and chars per line. */
1696 init_page_info (void)
1700 lines_per_page = UINT_MAX;
1701 chars_per_line = UINT_MAX;
1705 if (!tui_get_command_dimension (&chars_per_line, &lines_per_page))
1710 #if defined(__GO32__)
1711 rows = ScreenRows ();
1712 cols = ScreenCols ();
1713 lines_per_page = rows;
1714 chars_per_line = cols;
1716 /* Make sure Readline has initialized its terminal settings. */
1717 rl_reset_terminal (NULL);
1719 /* Get the screen size from Readline. */
1720 rl_get_screen_size (&rows, &cols);
1721 lines_per_page = rows;
1722 chars_per_line = cols;
1724 /* Readline should have fetched the termcap entry for us.
1725 Only try to use tgetnum function if rl_get_screen_size
1726 did not return a useful value. */
1727 if (((rows <= 0) && (tgetnum ("li") < 0))
1728 /* Also disable paging if inside Emacs. $EMACS was used
1729 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1730 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1732 /* The number of lines per page is not mentioned in the terminal
1733 description or EMACS evironment variable is set. This probably
1734 means that paging is not useful, so disable paging. */
1735 lines_per_page = UINT_MAX;
1738 /* If the output is not a terminal, don't paginate it. */
1739 if (!ui_file_isatty (gdb_stdout))
1740 lines_per_page = UINT_MAX;
1744 /* We handle SIGWINCH ourselves. */
1745 rl_catch_sigwinch = 0;
1751 /* Return nonzero if filtered printing is initialized. */
1753 filtered_printing_initialized (void)
1755 return wrap_buffer != NULL;
1758 /* Helper for make_cleanup_restore_page_info. */
1761 do_restore_page_info_cleanup (void *arg)
1767 /* Provide cleanup for restoring the terminal size. */
1770 make_cleanup_restore_page_info (void)
1772 struct cleanup *back_to;
1774 back_to = make_cleanup (do_restore_page_info_cleanup, NULL);
1775 make_cleanup_restore_uinteger (&lines_per_page);
1776 make_cleanup_restore_uinteger (&chars_per_line);
1781 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1782 Provide cleanup for restoring the original state. */
1785 set_batch_flag_and_make_cleanup_restore_page_info (void)
1787 struct cleanup *back_to = make_cleanup_restore_page_info ();
1789 make_cleanup_restore_integer (&batch_flag);
1796 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1799 set_screen_size (void)
1801 int rows = lines_per_page;
1802 int cols = chars_per_line;
1810 /* Update Readline's idea of the terminal size. */
1811 rl_set_screen_size (rows, cols);
1814 /* Reinitialize WRAP_BUFFER according to the current value of
1820 if (chars_per_line == 0)
1825 wrap_buffer = (char *) xmalloc (chars_per_line + 2);
1826 wrap_buffer[0] = '\0';
1829 wrap_buffer = (char *) xrealloc (wrap_buffer, chars_per_line + 2);
1830 wrap_pointer = wrap_buffer; /* Start it at the beginning. */
1834 set_width_command (char *args, int from_tty, struct cmd_list_element *c)
1841 set_height_command (char *args, int from_tty, struct cmd_list_element *c)
1849 set_screen_width_and_height (int width, int height)
1851 lines_per_page = height;
1852 chars_per_line = width;
1858 /* Wait, so the user can read what's on the screen. Prompt the user
1859 to continue by pressing RETURN. 'q' is also provided because
1860 telling users what to do in the prompt is more user-friendly than
1861 expecting them to think of Ctrl-C/SIGINT. */
1864 prompt_for_continue (void)
1867 char cont_prompt[120];
1868 /* Used to add duration we waited for user to respond to
1869 prompt_for_continue_wait_time. */
1870 struct timeval prompt_started, prompt_ended, prompt_delta;
1871 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
1873 gettimeofday (&prompt_started, NULL);
1875 if (annotation_level > 1)
1876 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1878 strcpy (cont_prompt,
1879 "---Type <return> to continue, or q <return> to quit---");
1880 if (annotation_level > 1)
1881 strcat (cont_prompt, "\n\032\032prompt-for-continue\n");
1883 /* We must do this *before* we call gdb_readline_wrapper, else it
1884 will eventually call us -- thinking that we're trying to print
1885 beyond the end of the screen. */
1886 reinitialize_more_filter ();
1888 prepare_to_handle_input ();
1890 /* Call gdb_readline_wrapper, not readline, in order to keep an
1891 event loop running. */
1892 ignore = gdb_readline_wrapper (cont_prompt);
1893 make_cleanup (xfree, ignore);
1895 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1896 gettimeofday (&prompt_ended, NULL);
1897 timeval_sub (&prompt_delta, &prompt_ended, &prompt_started);
1898 timeval_add (&prompt_for_continue_wait_time,
1899 &prompt_for_continue_wait_time, &prompt_delta);
1901 if (annotation_level > 1)
1902 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1908 while (*p == ' ' || *p == '\t')
1911 /* Do not call quit here; there is no possibility of SIGINT. */
1912 throw_quit ("Quit");
1915 /* Now we have to do this again, so that GDB will know that it doesn't
1916 need to save the ---Type <return>--- line at the top of the screen. */
1917 reinitialize_more_filter ();
1919 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1921 do_cleanups (old_chain);
1924 /* Initalize timer to keep track of how long we waited for the user. */
1927 reset_prompt_for_continue_wait_time (void)
1929 static const struct timeval zero_timeval = { 0 };
1931 prompt_for_continue_wait_time = zero_timeval;
1934 /* Fetch the cumulative time spent in prompt_for_continue. */
1937 get_prompt_for_continue_wait_time (void)
1939 return prompt_for_continue_wait_time;
1942 /* Reinitialize filter; ie. tell it to reset to original values. */
1945 reinitialize_more_filter (void)
1951 /* Indicate that if the next sequence of characters overflows the line,
1952 a newline should be inserted here rather than when it hits the end.
1953 If INDENT is non-null, it is a string to be printed to indent the
1954 wrapped part on the next line. INDENT must remain accessible until
1955 the next call to wrap_here() or until a newline is printed through
1958 If the line is already overfull, we immediately print a newline and
1959 the indentation, and disable further wrapping.
1961 If we don't know the width of lines, but we know the page height,
1962 we must not wrap words, but should still keep track of newlines
1963 that were explicitly printed.
1965 INDENT should not contain tabs, as that will mess up the char count
1966 on the next line. FIXME.
1968 This routine is guaranteed to force out any output which has been
1969 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1970 used to force out output from the wrap_buffer. */
1973 wrap_here (char *indent)
1975 /* This should have been allocated, but be paranoid anyway. */
1977 internal_error (__FILE__, __LINE__,
1978 _("failed internal consistency check"));
1982 *wrap_pointer = '\0';
1983 fputs_unfiltered (wrap_buffer, gdb_stdout);
1985 wrap_pointer = wrap_buffer;
1986 wrap_buffer[0] = '\0';
1987 if (chars_per_line == UINT_MAX) /* No line overflow checking. */
1991 else if (chars_printed >= chars_per_line)
1993 puts_filtered ("\n");
1995 puts_filtered (indent);
2000 wrap_column = chars_printed;
2004 wrap_indent = indent;
2008 /* Print input string to gdb_stdout, filtered, with wrap,
2009 arranging strings in columns of n chars. String can be
2010 right or left justified in the column. Never prints
2011 trailing spaces. String should never be longer than
2012 width. FIXME: this could be useful for the EXAMINE
2013 command, which currently doesn't tabulate very well. */
2016 puts_filtered_tabular (char *string, int width, int right)
2022 gdb_assert (chars_per_line > 0);
2023 if (chars_per_line == UINT_MAX)
2025 fputs_filtered (string, gdb_stdout);
2026 fputs_filtered ("\n", gdb_stdout);
2030 if (((chars_printed - 1) / width + 2) * width >= chars_per_line)
2031 fputs_filtered ("\n", gdb_stdout);
2033 if (width >= chars_per_line)
2034 width = chars_per_line - 1;
2036 stringlen = strlen (string);
2038 if (chars_printed > 0)
2039 spaces = width - (chars_printed - 1) % width - 1;
2041 spaces += width - stringlen;
2043 spacebuf = (char *) alloca (spaces + 1);
2044 spacebuf[spaces] = '\0';
2046 spacebuf[spaces] = ' ';
2048 fputs_filtered (spacebuf, gdb_stdout);
2049 fputs_filtered (string, gdb_stdout);
2053 /* Ensure that whatever gets printed next, using the filtered output
2054 commands, starts at the beginning of the line. I.e. if there is
2055 any pending output for the current line, flush it and start a new
2056 line. Otherwise do nothing. */
2061 if (chars_printed > 0)
2063 puts_filtered ("\n");
2068 /* Like fputs but if FILTER is true, pause after every screenful.
2070 Regardless of FILTER can wrap at points other than the final
2071 character of a line.
2073 Unlike fputs, fputs_maybe_filtered does not return a value.
2074 It is OK for LINEBUFFER to be NULL, in which case just don't print
2077 Note that a longjmp to top level may occur in this routine (only if
2078 FILTER is true) (since prompt_for_continue may do so) so this
2079 routine should not be called when cleanups are not in place. */
2082 fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
2085 const char *lineptr;
2087 if (linebuffer == 0)
2090 /* Don't do any filtering if it is disabled. */
2091 if (stream != gdb_stdout
2092 || !pagination_enabled
2094 || (lines_per_page == UINT_MAX && chars_per_line == UINT_MAX)
2095 || top_level_interpreter () == NULL
2096 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2098 fputs_unfiltered (linebuffer, stream);
2102 /* Go through and output each character. Show line extension
2103 when this is necessary; prompt user for new page when this is
2106 lineptr = linebuffer;
2109 /* Possible new page. */
2110 if (filter && (lines_printed >= lines_per_page - 1))
2111 prompt_for_continue ();
2113 while (*lineptr && *lineptr != '\n')
2115 /* Print a single line. */
2116 if (*lineptr == '\t')
2119 *wrap_pointer++ = '\t';
2121 fputc_unfiltered ('\t', stream);
2122 /* Shifting right by 3 produces the number of tab stops
2123 we have already passed, and then adding one and
2124 shifting left 3 advances to the next tab stop. */
2125 chars_printed = ((chars_printed >> 3) + 1) << 3;
2131 *wrap_pointer++ = *lineptr;
2133 fputc_unfiltered (*lineptr, stream);
2138 if (chars_printed >= chars_per_line)
2140 unsigned int save_chars = chars_printed;
2144 /* If we aren't actually wrapping, don't output newline --
2145 if chars_per_line is right, we probably just overflowed
2146 anyway; if it's wrong, let us keep going. */
2148 fputc_unfiltered ('\n', stream);
2150 /* Possible new page. */
2151 if (lines_printed >= lines_per_page - 1)
2152 prompt_for_continue ();
2154 /* Now output indentation and wrapped string. */
2157 fputs_unfiltered (wrap_indent, stream);
2158 *wrap_pointer = '\0'; /* Null-terminate saved stuff, */
2159 fputs_unfiltered (wrap_buffer, stream); /* and eject it. */
2160 /* FIXME, this strlen is what prevents wrap_indent from
2161 containing tabs. However, if we recurse to print it
2162 and count its chars, we risk trouble if wrap_indent is
2163 longer than (the user settable) chars_per_line.
2164 Note also that this can set chars_printed > chars_per_line
2165 if we are printing a long string. */
2166 chars_printed = strlen (wrap_indent)
2167 + (save_chars - wrap_column);
2168 wrap_pointer = wrap_buffer; /* Reset buffer */
2169 wrap_buffer[0] = '\0';
2170 wrap_column = 0; /* And disable fancy wrap */
2175 if (*lineptr == '\n')
2178 wrap_here ((char *) 0); /* Spit out chars, cancel
2181 fputc_unfiltered ('\n', stream);
2188 fputs_filtered (const char *linebuffer, struct ui_file *stream)
2190 fputs_maybe_filtered (linebuffer, stream, 1);
2194 putchar_unfiltered (int c)
2198 ui_file_write (gdb_stdout, &buf, 1);
2202 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2203 May return nonlocally. */
2206 putchar_filtered (int c)
2208 return fputc_filtered (c, gdb_stdout);
2212 fputc_unfiltered (int c, struct ui_file *stream)
2216 ui_file_write (stream, &buf, 1);
2221 fputc_filtered (int c, struct ui_file *stream)
2227 fputs_filtered (buf, stream);
2231 /* puts_debug is like fputs_unfiltered, except it prints special
2232 characters in printable fashion. */
2235 puts_debug (char *prefix, char *string, char *suffix)
2239 /* Print prefix and suffix after each line. */
2240 static int new_line = 1;
2241 static int return_p = 0;
2242 static char *prev_prefix = "";
2243 static char *prev_suffix = "";
2245 if (*string == '\n')
2248 /* If the prefix is changing, print the previous suffix, a new line,
2249 and the new prefix. */
2250 if ((return_p || (strcmp (prev_prefix, prefix) != 0)) && !new_line)
2252 fputs_unfiltered (prev_suffix, gdb_stdlog);
2253 fputs_unfiltered ("\n", gdb_stdlog);
2254 fputs_unfiltered (prefix, gdb_stdlog);
2257 /* Print prefix if we printed a newline during the previous call. */
2261 fputs_unfiltered (prefix, gdb_stdlog);
2264 prev_prefix = prefix;
2265 prev_suffix = suffix;
2267 /* Output characters in a printable format. */
2268 while ((ch = *string++) != '\0')
2274 fputc_unfiltered (ch, gdb_stdlog);
2277 fprintf_unfiltered (gdb_stdlog, "\\x%02x", ch & 0xff);
2281 fputs_unfiltered ("\\\\", gdb_stdlog);
2284 fputs_unfiltered ("\\b", gdb_stdlog);
2287 fputs_unfiltered ("\\f", gdb_stdlog);
2291 fputs_unfiltered ("\\n", gdb_stdlog);
2294 fputs_unfiltered ("\\r", gdb_stdlog);
2297 fputs_unfiltered ("\\t", gdb_stdlog);
2300 fputs_unfiltered ("\\v", gdb_stdlog);
2304 return_p = ch == '\r';
2307 /* Print suffix if we printed a newline. */
2310 fputs_unfiltered (suffix, gdb_stdlog);
2311 fputs_unfiltered ("\n", gdb_stdlog);
2316 /* Print a variable number of ARGS using format FORMAT. If this
2317 information is going to put the amount written (since the last call
2318 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2319 call prompt_for_continue to get the users permision to continue.
2321 Unlike fprintf, this function does not return a value.
2323 We implement three variants, vfprintf (takes a vararg list and stream),
2324 fprintf (takes a stream to write on), and printf (the usual).
2326 Note also that a longjmp to top level may occur in this routine
2327 (since prompt_for_continue may do so) so this routine should not be
2328 called when cleanups are not in place. */
2331 vfprintf_maybe_filtered (struct ui_file *stream, const char *format,
2332 va_list args, int filter)
2335 struct cleanup *old_cleanups;
2337 linebuffer = xstrvprintf (format, args);
2338 old_cleanups = make_cleanup (xfree, linebuffer);
2339 fputs_maybe_filtered (linebuffer, stream, filter);
2340 do_cleanups (old_cleanups);
2345 vfprintf_filtered (struct ui_file *stream, const char *format, va_list args)
2347 vfprintf_maybe_filtered (stream, format, args, 1);
2351 vfprintf_unfiltered (struct ui_file *stream, const char *format, va_list args)
2354 struct cleanup *old_cleanups;
2356 linebuffer = xstrvprintf (format, args);
2357 old_cleanups = make_cleanup (xfree, linebuffer);
2358 if (debug_timestamp && stream == gdb_stdlog)
2364 gettimeofday (&tm, NULL);
2366 len = strlen (linebuffer);
2367 need_nl = (len > 0 && linebuffer[len - 1] != '\n');
2369 timestamp = xstrprintf ("%ld:%ld %s%s",
2370 (long) tm.tv_sec, (long) tm.tv_usec,
2372 need_nl ? "\n": "");
2373 make_cleanup (xfree, timestamp);
2374 fputs_unfiltered (timestamp, stream);
2377 fputs_unfiltered (linebuffer, stream);
2378 do_cleanups (old_cleanups);
2382 vprintf_filtered (const char *format, va_list args)
2384 vfprintf_maybe_filtered (gdb_stdout, format, args, 1);
2388 vprintf_unfiltered (const char *format, va_list args)
2390 vfprintf_unfiltered (gdb_stdout, format, args);
2394 fprintf_filtered (struct ui_file *stream, const char *format, ...)
2398 va_start (args, format);
2399 vfprintf_filtered (stream, format, args);
2404 fprintf_unfiltered (struct ui_file *stream, const char *format, ...)
2408 va_start (args, format);
2409 vfprintf_unfiltered (stream, format, args);
2413 /* Like fprintf_filtered, but prints its result indented.
2414 Called as fprintfi_filtered (spaces, stream, format, ...); */
2417 fprintfi_filtered (int spaces, struct ui_file *stream, const char *format,
2422 va_start (args, format);
2423 print_spaces_filtered (spaces, stream);
2425 vfprintf_filtered (stream, format, args);
2431 printf_filtered (const char *format, ...)
2435 va_start (args, format);
2436 vfprintf_filtered (gdb_stdout, format, args);
2442 printf_unfiltered (const char *format, ...)
2446 va_start (args, format);
2447 vfprintf_unfiltered (gdb_stdout, format, args);
2451 /* Like printf_filtered, but prints it's result indented.
2452 Called as printfi_filtered (spaces, format, ...); */
2455 printfi_filtered (int spaces, const char *format, ...)
2459 va_start (args, format);
2460 print_spaces_filtered (spaces, gdb_stdout);
2461 vfprintf_filtered (gdb_stdout, format, args);
2465 /* Easy -- but watch out!
2467 This routine is *not* a replacement for puts()! puts() appends a newline.
2468 This one doesn't, and had better not! */
2471 puts_filtered (const char *string)
2473 fputs_filtered (string, gdb_stdout);
2477 puts_unfiltered (const char *string)
2479 fputs_unfiltered (string, gdb_stdout);
2482 /* Return a pointer to N spaces and a null. The pointer is good
2483 until the next call to here. */
2488 static char *spaces = 0;
2489 static int max_spaces = -1;
2495 spaces = (char *) xmalloc (n + 1);
2496 for (t = spaces + n; t != spaces;)
2502 return spaces + max_spaces - n;
2505 /* Print N spaces. */
2507 print_spaces_filtered (int n, struct ui_file *stream)
2509 fputs_filtered (n_spaces (n), stream);
2512 /* C++/ObjC demangler stuff. */
2514 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2515 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2516 If the name is not mangled, or the language for the name is unknown, or
2517 demangling is off, the name is printed in its "raw" form. */
2520 fprintf_symbol_filtered (struct ui_file *stream, const char *name,
2521 enum language lang, int arg_mode)
2527 /* If user wants to see raw output, no problem. */
2530 fputs_filtered (name, stream);
2534 demangled = language_demangle (language_def (lang), name, arg_mode);
2535 fputs_filtered (demangled ? demangled : name, stream);
2536 if (demangled != NULL)
2544 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2545 differences in whitespace. Returns 0 if they match, non-zero if they
2546 don't (slightly different than strcmp()'s range of return values).
2548 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2549 This "feature" is useful when searching for matching C++ function names
2550 (such as if the user types 'break FOO', where FOO is a mangled C++
2554 strcmp_iw (const char *string1, const char *string2)
2556 while ((*string1 != '\0') && (*string2 != '\0'))
2558 while (isspace (*string1))
2562 while (isspace (*string2))
2566 if (case_sensitivity == case_sensitive_on && *string1 != *string2)
2568 if (case_sensitivity == case_sensitive_off
2569 && (tolower ((unsigned char) *string1)
2570 != tolower ((unsigned char) *string2)))
2572 if (*string1 != '\0')
2578 return (*string1 != '\0' && *string1 != '(') || (*string2 != '\0');
2581 /* This is like strcmp except that it ignores whitespace and treats
2582 '(' as the first non-NULL character in terms of ordering. Like
2583 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2584 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2585 according to that ordering.
2587 If a list is sorted according to this function and if you want to
2588 find names in the list that match some fixed NAME according to
2589 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2590 where this function would put NAME.
2592 This function must be neutral to the CASE_SENSITIVITY setting as the user
2593 may choose it during later lookup. Therefore this function always sorts
2594 primarily case-insensitively and secondarily case-sensitively.
2596 Here are some examples of why using strcmp to sort is a bad idea:
2600 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2601 we try to do a search for "foo<char*>", strcmp will locate this
2602 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2603 will start looking at strings beginning with "goo", and will never
2604 see the correct match of "foo<char *>".
2606 Parenthesis example:
2608 In practice, this is less like to be an issue, but I'll give it a
2609 shot. Let's assume that '$' is a legitimate character to occur in
2610 symbols. (Which may well even be the case on some systems.) Then
2611 say that the partial symbol table contains "foo$" and "foo(int)".
2612 strcmp will put them in this order, since '$' < '('. Now, if the
2613 user searches for "foo", then strcmp will sort "foo" before "foo$".
2614 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2615 "foo") is false, so it won't proceed to the actual match of
2616 "foo(int)" with "foo". */
2619 strcmp_iw_ordered (const char *string1, const char *string2)
2621 const char *saved_string1 = string1, *saved_string2 = string2;
2622 enum case_sensitivity case_pass = case_sensitive_off;
2626 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2627 Provide stub characters if we are already at the end of one of the
2629 char c1 = 'X', c2 = 'X';
2631 while (*string1 != '\0' && *string2 != '\0')
2633 while (isspace (*string1))
2635 while (isspace (*string2))
2640 case case_sensitive_off:
2641 c1 = tolower ((unsigned char) *string1);
2642 c2 = tolower ((unsigned char) *string2);
2644 case case_sensitive_on:
2652 if (*string1 != '\0')
2661 /* Characters are non-equal unless they're both '\0'; we want to
2662 make sure we get the comparison right according to our
2663 comparison in the cases where one of them is '\0' or '('. */
2665 if (*string2 == '\0')
2670 if (*string2 == '\0')
2675 if (*string2 == '\0' || *string2 == '(')
2684 if (case_pass == case_sensitive_on)
2687 /* Otherwise the strings were equal in case insensitive way, make
2688 a more fine grained comparison in a case sensitive way. */
2690 case_pass = case_sensitive_on;
2691 string1 = saved_string1;
2692 string2 = saved_string2;
2696 /* A simple comparison function with opposite semantics to strcmp. */
2699 streq (const char *lhs, const char *rhs)
2701 return !strcmp (lhs, rhs);
2707 ** Answer whether string_to_compare is a full or partial match to
2708 ** template_string. The partial match must be in sequence starting
2712 subset_compare (char *string_to_compare, char *template_string)
2716 if (template_string != (char *) NULL && string_to_compare != (char *) NULL
2717 && strlen (string_to_compare) <= strlen (template_string))
2719 (startswith (template_string, string_to_compare));
2726 show_debug_timestamp (struct ui_file *file, int from_tty,
2727 struct cmd_list_element *c, const char *value)
2729 fprintf_filtered (file, _("Timestamping debugging messages is %s.\n"),
2735 initialize_utils (void)
2737 add_setshow_uinteger_cmd ("width", class_support, &chars_per_line, _("\
2738 Set number of characters where GDB should wrap lines of its output."), _("\
2739 Show number of characters where GDB should wrap lines of its output."), _("\
2740 This affects where GDB wraps its output to fit the screen width.\n\
2741 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2743 show_chars_per_line,
2744 &setlist, &showlist);
2746 add_setshow_uinteger_cmd ("height", class_support, &lines_per_page, _("\
2747 Set number of lines in a page for GDB output pagination."), _("\
2748 Show number of lines in a page for GDB output pagination."), _("\
2749 This affects the number of lines after which GDB will pause\n\
2750 its output and ask you whether to continue.\n\
2751 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2753 show_lines_per_page,
2754 &setlist, &showlist);
2756 add_setshow_boolean_cmd ("pagination", class_support,
2757 &pagination_enabled, _("\
2758 Set state of GDB output pagination."), _("\
2759 Show state of GDB output pagination."), _("\
2760 When pagination is ON, GDB pauses at end of each screenful of\n\
2761 its output and asks you whether to continue.\n\
2762 Turning pagination off is an alternative to \"set height unlimited\"."),
2764 show_pagination_enabled,
2765 &setlist, &showlist);
2767 add_setshow_boolean_cmd ("sevenbit-strings", class_support,
2768 &sevenbit_strings, _("\
2769 Set printing of 8-bit characters in strings as \\nnn."), _("\
2770 Show printing of 8-bit characters in strings as \\nnn."), NULL,
2772 show_sevenbit_strings,
2773 &setprintlist, &showprintlist);
2775 add_setshow_boolean_cmd ("timestamp", class_maintenance,
2776 &debug_timestamp, _("\
2777 Set timestamping of debugging messages."), _("\
2778 Show timestamping of debugging messages."), _("\
2779 When set, debugging messages will be marked with seconds and microseconds."),
2781 show_debug_timestamp,
2782 &setdebuglist, &showdebuglist);
2786 paddress (struct gdbarch *gdbarch, CORE_ADDR addr)
2788 /* Truncate address to the size of a target address, avoiding shifts
2789 larger or equal than the width of a CORE_ADDR. The local
2790 variable ADDR_BIT stops the compiler reporting a shift overflow
2791 when it won't occur. */
2792 /* NOTE: This assumes that the significant address information is
2793 kept in the least significant bits of ADDR - the upper bits were
2794 either zero or sign extended. Should gdbarch_address_to_pointer or
2795 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2797 int addr_bit = gdbarch_addr_bit (gdbarch);
2799 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2800 addr &= ((CORE_ADDR) 1 << addr_bit) - 1;
2801 return hex_string (addr);
2804 /* This function is described in "defs.h". */
2807 print_core_address (struct gdbarch *gdbarch, CORE_ADDR address)
2809 int addr_bit = gdbarch_addr_bit (gdbarch);
2811 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2812 address &= ((CORE_ADDR) 1 << addr_bit) - 1;
2814 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2815 that returns the language localized string formatted to a width
2816 based on gdbarch_addr_bit. */
2818 return hex_string_custom (address, 8);
2820 return hex_string_custom (address, 16);
2823 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2826 core_addr_hash (const void *ap)
2828 const CORE_ADDR *addrp = (const CORE_ADDR *) ap;
2833 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2836 core_addr_eq (const void *ap, const void *bp)
2838 const CORE_ADDR *addr_ap = (const CORE_ADDR *) ap;
2839 const CORE_ADDR *addr_bp = (const CORE_ADDR *) bp;
2841 return *addr_ap == *addr_bp;
2844 /* Convert a string back into a CORE_ADDR. */
2846 string_to_core_addr (const char *my_string)
2850 if (my_string[0] == '0' && tolower (my_string[1]) == 'x')
2852 /* Assume that it is in hex. */
2855 for (i = 2; my_string[i] != '\0'; i++)
2857 if (isdigit (my_string[i]))
2858 addr = (my_string[i] - '0') + (addr * 16);
2859 else if (isxdigit (my_string[i]))
2860 addr = (tolower (my_string[i]) - 'a' + 0xa) + (addr * 16);
2862 error (_("invalid hex \"%s\""), my_string);
2867 /* Assume that it is in decimal. */
2870 for (i = 0; my_string[i] != '\0'; i++)
2872 if (isdigit (my_string[i]))
2873 addr = (my_string[i] - '0') + (addr * 10);
2875 error (_("invalid decimal \"%s\""), my_string);
2883 gdb_realpath (const char *filename)
2885 /* On most hosts, we rely on canonicalize_file_name to compute
2886 the FILENAME's realpath.
2888 But the situation is slightly more complex on Windows, due to some
2889 versions of GCC which were reported to generate paths where
2890 backlashes (the directory separator) were doubled. For instance:
2891 c:\\some\\double\\slashes\\dir
2893 c:\some\double\slashes\dir
2894 Those double-slashes were getting in the way when comparing paths,
2895 for instance when trying to insert a breakpoint as follow:
2896 (gdb) b c:/some/double/slashes/dir/foo.c:4
2897 No source file named c:/some/double/slashes/dir/foo.c:4.
2898 (gdb) b c:\some\double\slashes\dir\foo.c:4
2899 No source file named c:\some\double\slashes\dir\foo.c:4.
2900 To prevent this from happening, we need this function to always
2901 strip those extra backslashes. While canonicalize_file_name does
2902 perform this simplification, it only works when the path is valid.
2903 Since the simplification would be useful even if the path is not
2904 valid (one can always set a breakpoint on a file, even if the file
2905 does not exist locally), we rely instead on GetFullPathName to
2906 perform the canonicalization. */
2908 #if defined (_WIN32)
2911 DWORD len = GetFullPathName (filename, MAX_PATH, buf, NULL);
2913 /* The file system is case-insensitive but case-preserving.
2914 So it is important we do not lowercase the path. Otherwise,
2915 we might not be able to display the original casing in a given
2917 if (len > 0 && len < MAX_PATH)
2918 return xstrdup (buf);
2922 char *rp = canonicalize_file_name (filename);
2929 /* This system is a lost cause, just dup the buffer. */
2930 return xstrdup (filename);
2933 /* Return a copy of FILENAME, with its directory prefix canonicalized
2937 gdb_realpath_keepfile (const char *filename)
2939 const char *base_name = lbasename (filename);
2944 /* Extract the basename of filename, and return immediately
2945 a copy of filename if it does not contain any directory prefix. */
2946 if (base_name == filename)
2947 return xstrdup (filename);
2949 dir_name = (char *) alloca ((size_t) (base_name - filename + 2));
2950 /* Allocate enough space to store the dir_name + plus one extra
2951 character sometimes needed under Windows (see below), and
2952 then the closing \000 character. */
2953 strncpy (dir_name, filename, base_name - filename);
2954 dir_name[base_name - filename] = '\000';
2956 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
2957 /* We need to be careful when filename is of the form 'd:foo', which
2958 is equivalent of d:./foo, which is totally different from d:/foo. */
2959 if (strlen (dir_name) == 2 && isalpha (dir_name[0]) && dir_name[1] == ':')
2962 dir_name[3] = '\000';
2966 /* Canonicalize the directory prefix, and build the resulting
2967 filename. If the dirname realpath already contains an ending
2968 directory separator, avoid doubling it. */
2969 real_path = gdb_realpath (dir_name);
2970 if (IS_DIR_SEPARATOR (real_path[strlen (real_path) - 1]))
2971 result = concat (real_path, base_name, (char *) NULL);
2973 result = concat (real_path, SLASH_STRING, base_name, (char *) NULL);
2979 /* Return PATH in absolute form, performing tilde-expansion if necessary.
2980 PATH cannot be NULL or the empty string.
2981 This does not resolve symlinks however, use gdb_realpath for that.
2982 Space for the result is allocated with malloc.
2983 If the path is already absolute, it is strdup'd.
2984 If there is a problem computing the absolute path, the path is returned
2985 unchanged (still strdup'd). */
2988 gdb_abspath (const char *path)
2990 gdb_assert (path != NULL && path[0] != '\0');
2993 return tilde_expand (path);
2995 if (IS_ABSOLUTE_PATH (path))
2996 return xstrdup (path);
2998 /* Beware the // my son, the Emacs barfs, the botch that catch... */
2999 return concat (current_directory,
3000 IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1])
3001 ? "" : SLASH_STRING,
3002 path, (char *) NULL);
3006 align_up (ULONGEST v, int n)
3008 /* Check that N is really a power of two. */
3009 gdb_assert (n && (n & (n-1)) == 0);
3010 return (v + n - 1) & -n;
3014 align_down (ULONGEST v, int n)
3016 /* Check that N is really a power of two. */
3017 gdb_assert (n && (n & (n-1)) == 0);
3021 /* Allocation function for the libiberty hash table which uses an
3022 obstack. The obstack is passed as DATA. */
3025 hashtab_obstack_allocate (void *data, size_t size, size_t count)
3027 size_t total = size * count;
3028 void *ptr = obstack_alloc ((struct obstack *) data, total);
3030 memset (ptr, 0, total);
3034 /* Trivial deallocation function for the libiberty splay tree and hash
3035 table - don't deallocate anything. Rely on later deletion of the
3036 obstack. DATA will be the obstack, although it is not needed
3040 dummy_obstack_deallocate (void *object, void *data)
3045 /* Simple, portable version of dirname that does not modify its
3049 ldirname (const char *filename)
3051 const char *base = lbasename (filename);
3054 while (base > filename && IS_DIR_SEPARATOR (base[-1]))
3057 if (base == filename)
3060 dirname = (char *) xmalloc (base - filename + 2);
3061 memcpy (dirname, filename, base - filename);
3063 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3064 create "d:./bar" later instead of the (different) "d:/bar". */
3065 if (base - filename == 2 && IS_ABSOLUTE_PATH (base)
3066 && !IS_DIR_SEPARATOR (filename[0]))
3067 dirname[base++ - filename] = '.';
3069 dirname[base - filename] = '\0';
3073 /* Call libiberty's buildargv, and return the result.
3074 If buildargv fails due to out-of-memory, call nomem.
3075 Therefore, the returned value is guaranteed to be non-NULL,
3076 unless the parameter itself is NULL. */
3079 gdb_buildargv (const char *s)
3081 char **argv = buildargv (s);
3083 if (s != NULL && argv == NULL)
3089 compare_positive_ints (const void *ap, const void *bp)
3091 /* Because we know we're comparing two ints which are positive,
3092 there's no danger of overflow here. */
3093 return * (int *) ap - * (int *) bp;
3096 /* String compare function for qsort. */
3099 compare_strings (const void *arg1, const void *arg2)
3101 const char **s1 = (const char **) arg1;
3102 const char **s2 = (const char **) arg2;
3104 return strcmp (*s1, *s2);
3107 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3108 #define AMBIGUOUS_MESS2 \
3109 ".\nUse \"set gnutarget format-name\" to specify the format."
3112 gdb_bfd_errmsg (bfd_error_type error_tag, char **matching)
3118 /* Check if errmsg just need simple return. */
3119 if (error_tag != bfd_error_file_ambiguously_recognized || matching == NULL)
3120 return bfd_errmsg (error_tag);
3122 ret_len = strlen (bfd_errmsg (error_tag)) + strlen (AMBIGUOUS_MESS1)
3123 + strlen (AMBIGUOUS_MESS2);
3124 for (p = matching; *p; p++)
3125 ret_len += strlen (*p) + 1;
3126 ret = (char *) xmalloc (ret_len + 1);
3128 make_cleanup (xfree, ret);
3130 strcpy (retp, bfd_errmsg (error_tag));
3131 retp += strlen (retp);
3133 strcpy (retp, AMBIGUOUS_MESS1);
3134 retp += strlen (retp);
3136 for (p = matching; *p; p++)
3138 sprintf (retp, " %s", *p);
3139 retp += strlen (retp);
3143 strcpy (retp, AMBIGUOUS_MESS2);
3148 /* Return ARGS parsed as a valid pid, or throw an error. */
3151 parse_pid_to_attach (const char *args)
3157 error_no_arg (_("process-id to attach"));
3159 dummy = (char *) args;
3160 pid = strtoul (args, &dummy, 0);
3161 /* Some targets don't set errno on errors, grrr! */
3162 if ((pid == 0 && dummy == args) || dummy != &args[strlen (args)])
3163 error (_("Illegal process-id: %s."), args);
3168 /* Helper for make_bpstat_clear_actions_cleanup. */
3171 do_bpstat_clear_actions_cleanup (void *unused)
3173 bpstat_clear_actions ();
3176 /* Call bpstat_clear_actions for the case an exception is throw. You should
3177 discard_cleanups if no exception is caught. */
3180 make_bpstat_clear_actions_cleanup (void)
3182 return make_cleanup (do_bpstat_clear_actions_cleanup, NULL);
3185 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3186 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3187 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3190 producer_is_gcc_ge_4 (const char *producer)
3194 if (! producer_is_gcc (producer, &major, &minor))
3203 /* Returns nonzero if the given PRODUCER string is GCC and sets the MAJOR
3204 and MINOR versions when not NULL. Returns zero if the given PRODUCER
3205 is NULL or it isn't GCC. */
3208 producer_is_gcc (const char *producer, int *major, int *minor)
3212 if (producer != NULL && startswith (producer, "GNU "))
3221 /* Skip any identifier after "GNU " - such as "C11" "C++" or "Java".
3222 A full producer string might look like:
3224 "GNU Fortran 4.8.2 20140120 (Red Hat 4.8.2-16) -mtune=generic ..."
3225 "GNU C++14 5.0.0 20150123 (experimental)"
3227 cs = &producer[strlen ("GNU ")];
3228 while (*cs && !isspace (*cs))
3230 if (*cs && isspace (*cs))
3232 if (sscanf (cs, "%d.%d", major, minor) == 2)
3236 /* Not recognized as GCC. */
3240 /* Helper for make_cleanup_free_char_ptr_vec. */
3243 do_free_char_ptr_vec (void *arg)
3245 VEC (char_ptr) *char_ptr_vec = (VEC (char_ptr) *) arg;
3247 free_char_ptr_vec (char_ptr_vec);
3250 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3251 final VEC_free for CHAR_PTR_VEC itself.
3253 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3254 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3255 this function does not (cannot) clear the pointer. */
3258 make_cleanup_free_char_ptr_vec (VEC (char_ptr) *char_ptr_vec)
3260 return make_cleanup (do_free_char_ptr_vec, char_ptr_vec);
3263 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3264 must come from xrealloc-compatible allocator and it may be updated. FROM
3265 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3266 located at the start or end of *STRINGP. */
3269 substitute_path_component (char **stringp, const char *from, const char *to)
3271 char *string = *stringp, *s;
3272 const size_t from_len = strlen (from);
3273 const size_t to_len = strlen (to);
3277 s = strstr (s, from);
3281 if ((s == string || IS_DIR_SEPARATOR (s[-1])
3282 || s[-1] == DIRNAME_SEPARATOR)
3283 && (s[from_len] == '\0' || IS_DIR_SEPARATOR (s[from_len])
3284 || s[from_len] == DIRNAME_SEPARATOR))
3289 = (char *) xrealloc (string, (strlen (string) + to_len + 1));
3291 /* Relocate the current S pointer. */
3292 s = s - string + string_new;
3293 string = string_new;
3295 /* Replace from by to. */
3296 memmove (&s[to_len], &s[from_len], strlen (&s[from_len]) + 1);
3297 memcpy (s, to, to_len);
3312 /* SIGALRM handler for waitpid_with_timeout. */
3315 sigalrm_handler (int signo)
3317 /* Nothing to do. */
3322 /* Wrapper to wait for child PID to die with TIMEOUT.
3323 TIMEOUT is the time to stop waiting in seconds.
3324 If TIMEOUT is zero, pass WNOHANG to waitpid.
3325 Returns PID if it was successfully waited for, otherwise -1.
3327 Timeouts are currently implemented with alarm and SIGALRM.
3328 If the host does not support them, this waits "forever".
3329 It would be odd though for a host to have waitpid and not SIGALRM. */
3332 wait_to_die_with_timeout (pid_t pid, int *status, int timeout)
3334 pid_t waitpid_result;
3336 gdb_assert (pid > 0);
3337 gdb_assert (timeout >= 0);
3342 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3343 struct sigaction sa, old_sa;
3345 sa.sa_handler = sigalrm_handler;
3346 sigemptyset (&sa.sa_mask);
3348 sigaction (SIGALRM, &sa, &old_sa);
3352 ofunc = signal (SIGALRM, sigalrm_handler);
3358 waitpid_result = waitpid (pid, status, 0);
3362 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3363 sigaction (SIGALRM, &old_sa, NULL);
3365 signal (SIGALRM, ofunc);
3370 waitpid_result = waitpid (pid, status, WNOHANG);
3372 if (waitpid_result == pid)
3378 #endif /* HAVE_WAITPID */
3380 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3381 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3383 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3384 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3387 gdb_filename_fnmatch (const char *pattern, const char *string, int flags)
3389 gdb_assert ((flags & FNM_FILE_NAME) != 0);
3391 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3392 gdb_assert ((flags & FNM_NOESCAPE) != 0);
3394 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3396 char *pattern_slash, *string_slash;
3398 /* Replace '\' by '/' in both strings. */
3400 pattern_slash = (char *) alloca (strlen (pattern) + 1);
3401 strcpy (pattern_slash, pattern);
3402 pattern = pattern_slash;
3403 for (; *pattern_slash != 0; pattern_slash++)
3404 if (IS_DIR_SEPARATOR (*pattern_slash))
3405 *pattern_slash = '/';
3407 string_slash = (char *) alloca (strlen (string) + 1);
3408 strcpy (string_slash, string);
3409 string = string_slash;
3410 for (; *string_slash != 0; string_slash++)
3411 if (IS_DIR_SEPARATOR (*string_slash))
3412 *string_slash = '/';
3414 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3416 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3417 flags |= FNM_CASEFOLD;
3418 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3420 return fnmatch (pattern, string, flags);
3423 /* Return the number of path elements in PATH.
3431 count_path_elements (const char *path)
3434 const char *p = path;
3436 if (HAS_DRIVE_SPEC (p))
3438 p = STRIP_DRIVE_SPEC (p);
3444 if (IS_DIR_SEPARATOR (*p))
3449 /* Backup one if last character is /, unless it's the only one. */
3450 if (p > path + 1 && IS_DIR_SEPARATOR (p[-1]))
3453 /* Add one for the file name, if present. */
3454 if (p > path && !IS_DIR_SEPARATOR (p[-1]))
3460 /* Remove N leading path elements from PATH.
3461 N must be non-negative.
3462 If PATH has more than N path elements then return NULL.
3463 If PATH has exactly N path elements then return "".
3464 See count_path_elements for a description of how we do the counting. */
3467 strip_leading_path_elements (const char *path, int n)
3470 const char *p = path;
3472 gdb_assert (n >= 0);
3477 if (HAS_DRIVE_SPEC (p))
3479 p = STRIP_DRIVE_SPEC (p);
3485 while (*p != '\0' && !IS_DIR_SEPARATOR (*p))
3500 /* Provide a prototype to silence -Wmissing-prototypes. */
3501 extern initialize_file_ftype _initialize_utils;
3504 _initialize_utils (void)
3506 add_internal_problem_command (&internal_error_problem);
3507 add_internal_problem_command (&internal_warning_problem);
3508 add_internal_problem_command (&demangler_warning_problem);