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_file_closure
337 struct ui_file **variable;
338 struct ui_file *value;
342 do_restore_ui_file (void *p)
344 struct restore_ui_file_closure *closure
345 = (struct restore_ui_file_closure *) p;
347 *(closure->variable) = closure->value;
350 /* Remember the current value of *VARIABLE and make it restored when
351 the cleanup is run. */
354 make_cleanup_restore_ui_file (struct ui_file **variable)
356 struct restore_ui_file_closure *c = XNEW (struct restore_ui_file_closure);
358 c->variable = variable;
359 c->value = *variable;
361 return make_cleanup_dtor (do_restore_ui_file, (void *) c, xfree);
364 /* Helper for make_cleanup_value_free_to_mark. */
367 do_value_free_to_mark (void *value)
369 value_free_to_mark ((struct value *) value);
372 /* Free all values allocated since MARK was obtained by value_mark
373 (except for those released) when the cleanup is run. */
376 make_cleanup_value_free_to_mark (struct value *mark)
378 return make_cleanup (do_value_free_to_mark, mark);
381 /* Helper for make_cleanup_value_free. */
384 do_value_free (void *value)
386 value_free ((struct value *) value);
392 make_cleanup_value_free (struct value *value)
394 return make_cleanup (do_value_free, value);
397 /* Helper for make_cleanup_free_so. */
400 do_free_so (void *arg)
402 struct so_list *so = (struct so_list *) arg;
407 /* Make cleanup handler calling free_so for SO. */
410 make_cleanup_free_so (struct so_list *so)
412 return make_cleanup (do_free_so, so);
415 /* Helper for make_cleanup_restore_current_language. */
418 do_restore_current_language (void *p)
420 enum language saved_lang = (enum language) (uintptr_t) p;
422 set_language (saved_lang);
425 /* Remember the current value of CURRENT_LANGUAGE and make it restored when
426 the cleanup is run. */
429 make_cleanup_restore_current_language (void)
431 enum language saved_lang = current_language->la_language;
433 return make_cleanup (do_restore_current_language,
434 (void *) (uintptr_t) saved_lang);
437 /* Helper function for make_cleanup_clear_parser_state. */
440 do_clear_parser_state (void *ptr)
442 struct parser_state **p = (struct parser_state **) ptr;
447 /* Clean (i.e., set to NULL) the parser state variable P. */
450 make_cleanup_clear_parser_state (struct parser_state **p)
452 return make_cleanup (do_clear_parser_state, (void *) p);
455 /* This function is useful for cleanups.
459 old_chain = make_cleanup (free_current_contents, &foo);
461 to arrange to free the object thus allocated. */
464 free_current_contents (void *ptr)
466 void **location = (void **) ptr;
468 if (location == NULL)
469 internal_error (__FILE__, __LINE__,
470 _("free_current_contents: NULL pointer"));
471 if (*location != NULL)
480 /* Print a warning message. The first argument STRING is the warning
481 message, used as an fprintf format string, the second is the
482 va_list of arguments for that string. A warning is unfiltered (not
483 paginated) so that the user does not need to page through each
484 screen full of warnings when there are lots of them. */
487 vwarning (const char *string, va_list args)
489 if (deprecated_warning_hook)
490 (*deprecated_warning_hook) (string, args);
493 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
495 if (target_supports_terminal_ours ())
497 make_cleanup_restore_target_terminal ();
498 target_terminal_ours_for_output ();
500 if (filtered_printing_initialized ())
501 wrap_here (""); /* Force out any buffered output. */
502 gdb_flush (gdb_stdout);
503 if (warning_pre_print)
504 fputs_unfiltered (warning_pre_print, gdb_stderr);
505 vfprintf_unfiltered (gdb_stderr, string, args);
506 fprintf_unfiltered (gdb_stderr, "\n");
508 do_cleanups (old_chain);
512 /* Print an error message and return to command level.
513 The first argument STRING is the error message, used as a fprintf string,
514 and the remaining args are passed as arguments to it. */
517 verror (const char *string, va_list args)
519 throw_verror (GENERIC_ERROR, string, args);
523 error_stream (struct ui_file *stream)
525 char *message = ui_file_xstrdup (stream, NULL);
527 make_cleanup (xfree, message);
528 error (("%s"), message);
531 /* Emit a message and abort. */
533 static void ATTRIBUTE_NORETURN
534 abort_with_message (const char *msg)
536 if (gdb_stderr == NULL)
539 fputs_unfiltered (msg, gdb_stderr);
541 abort (); /* NOTE: GDB has only three calls to abort(). */
544 /* Dump core trying to increase the core soft limit to hard limit first. */
549 #ifdef HAVE_SETRLIMIT
550 struct rlimit rlim = { RLIM_INFINITY, RLIM_INFINITY };
552 setrlimit (RLIMIT_CORE, &rlim);
553 #endif /* HAVE_SETRLIMIT */
555 abort (); /* NOTE: GDB has only three calls to abort(). */
558 /* Check whether GDB will be able to dump core using the dump_core
559 function. Returns zero if GDB cannot or should not dump core.
560 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
561 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
564 can_dump_core (enum resource_limit_kind limit_kind)
566 #ifdef HAVE_GETRLIMIT
569 /* Be quiet and assume we can dump if an error is returned. */
570 if (getrlimit (RLIMIT_CORE, &rlim) != 0)
576 if (rlim.rlim_cur == 0)
580 if (rlim.rlim_max == 0)
583 #endif /* HAVE_GETRLIMIT */
588 /* Print a warning that we cannot dump core. */
591 warn_cant_dump_core (const char *reason)
593 fprintf_unfiltered (gdb_stderr,
594 _("%s\nUnable to dump core, use `ulimit -c"
595 " unlimited' before executing GDB next time.\n"),
599 /* Check whether GDB will be able to dump core using the dump_core
600 function, and print a warning if we cannot. */
603 can_dump_core_warn (enum resource_limit_kind limit_kind,
606 int core_dump_allowed = can_dump_core (limit_kind);
608 if (!core_dump_allowed)
609 warn_cant_dump_core (reason);
611 return core_dump_allowed;
614 /* Allow the user to configure the debugger behavior with respect to
615 what to do when an internal problem is detected. */
617 const char internal_problem_ask[] = "ask";
618 const char internal_problem_yes[] = "yes";
619 const char internal_problem_no[] = "no";
620 static const char *const internal_problem_modes[] =
622 internal_problem_ask,
623 internal_problem_yes,
628 /* Print a message reporting an internal error/warning. Ask the user
629 if they want to continue, dump core, or just exit. Return
630 something to indicate a quit. */
632 struct internal_problem
635 int user_settable_should_quit;
636 const char *should_quit;
637 int user_settable_should_dump_core;
638 const char *should_dump_core;
641 /* Report a problem, internal to GDB, to the user. Once the problem
642 has been reported, and assuming GDB didn't quit, the caller can
643 either allow execution to resume or throw an error. */
645 static void ATTRIBUTE_PRINTF (4, 0)
646 internal_vproblem (struct internal_problem *problem,
647 const char *file, int line, const char *fmt, va_list ap)
653 struct cleanup *cleanup = make_cleanup (null_cleanup, NULL);
655 /* Don't allow infinite error/warning recursion. */
657 static char msg[] = "Recursive internal problem.\n";
666 abort_with_message (msg);
669 /* Newer GLIBC versions put the warn_unused_result attribute
670 on write, but this is one of those rare cases where
671 ignoring the return value is correct. Casting to (void)
672 does not fix this problem. This is the solution suggested
673 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
674 if (write (STDERR_FILENO, msg, sizeof (msg)) != sizeof (msg))
675 abort (); /* NOTE: GDB has only three calls to abort(). */
680 /* Create a string containing the full error/warning message. Need
681 to call query with this full string, as otherwize the reason
682 (error/warning) and question become separated. Format using a
683 style similar to a compiler error message. Include extra detail
684 so that the user knows that they are living on the edge. */
688 msg = xstrvprintf (fmt, ap);
689 reason = xstrprintf ("%s:%d: %s: %s\n"
690 "A problem internal to GDB has been detected,\n"
691 "further debugging may prove unreliable.",
692 file, line, problem->name, msg);
694 make_cleanup (xfree, reason);
697 /* Fall back to abort_with_message if gdb_stderr is not set up. */
698 if (gdb_stderr == NULL)
700 fputs (reason, stderr);
701 abort_with_message ("\n");
704 /* Try to get the message out and at the start of a new line. */
705 if (target_supports_terminal_ours ())
707 make_cleanup_restore_target_terminal ();
708 target_terminal_ours_for_output ();
710 if (filtered_printing_initialized ())
713 /* Emit the message unless query will emit it below. */
714 if (problem->should_quit != internal_problem_ask
716 || !filtered_printing_initialized ())
717 fprintf_unfiltered (gdb_stderr, "%s\n", reason);
719 if (problem->should_quit == internal_problem_ask)
721 /* Default (yes/batch case) is to quit GDB. When in batch mode
722 this lessens the likelihood of GDB going into an infinite
724 if (!confirm || !filtered_printing_initialized ())
727 quit_p = query (_("%s\nQuit this debugging session? "), reason);
729 else if (problem->should_quit == internal_problem_yes)
731 else if (problem->should_quit == internal_problem_no)
734 internal_error (__FILE__, __LINE__, _("bad switch"));
736 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr);
737 if (REPORT_BUGS_TO[0])
738 fprintf_unfiltered (gdb_stderr, _(" For instructions, see:\n%s."),
740 fputs_unfiltered ("\n\n", gdb_stderr);
742 if (problem->should_dump_core == internal_problem_ask)
744 if (!can_dump_core_warn (LIMIT_MAX, reason))
746 else if (!filtered_printing_initialized ())
750 /* Default (yes/batch case) is to dump core. This leaves a GDB
751 `dropping' so that it is easier to see that something went
753 dump_core_p = query (_("%s\nCreate a core file of GDB? "), reason);
756 else if (problem->should_dump_core == internal_problem_yes)
757 dump_core_p = can_dump_core_warn (LIMIT_MAX, reason);
758 else if (problem->should_dump_core == internal_problem_no)
761 internal_error (__FILE__, __LINE__, _("bad switch"));
774 #ifdef HAVE_WORKING_FORK
782 do_cleanups (cleanup);
785 static struct internal_problem internal_error_problem = {
786 "internal-error", 1, internal_problem_ask, 1, internal_problem_ask
790 internal_verror (const char *file, int line, const char *fmt, va_list ap)
792 internal_vproblem (&internal_error_problem, file, line, fmt, ap);
793 throw_quit (_("Command aborted."));
796 static struct internal_problem internal_warning_problem = {
797 "internal-warning", 1, internal_problem_ask, 1, internal_problem_ask
801 internal_vwarning (const char *file, int line, const char *fmt, va_list ap)
803 internal_vproblem (&internal_warning_problem, file, line, fmt, ap);
806 static struct internal_problem demangler_warning_problem = {
807 "demangler-warning", 1, internal_problem_ask, 0, internal_problem_no
811 demangler_vwarning (const char *file, int line, const char *fmt, va_list ap)
813 internal_vproblem (&demangler_warning_problem, file, line, fmt, ap);
817 demangler_warning (const char *file, int line, const char *string, ...)
821 va_start (ap, string);
822 demangler_vwarning (file, line, string, ap);
826 /* Dummy functions to keep add_prefix_cmd happy. */
829 set_internal_problem_cmd (char *args, int from_tty)
834 show_internal_problem_cmd (char *args, int from_tty)
838 /* When GDB reports an internal problem (error or warning) it gives
839 the user the opportunity to quit GDB and/or create a core file of
840 the current debug session. This function registers a few commands
841 that make it possible to specify that GDB should always or never
842 quit or create a core file, without asking. The commands look
845 maint set PROBLEM-NAME quit ask|yes|no
846 maint show PROBLEM-NAME quit
847 maint set PROBLEM-NAME corefile ask|yes|no
848 maint show PROBLEM-NAME corefile
850 Where PROBLEM-NAME is currently "internal-error" or
851 "internal-warning". */
854 add_internal_problem_command (struct internal_problem *problem)
856 struct cmd_list_element **set_cmd_list;
857 struct cmd_list_element **show_cmd_list;
861 set_cmd_list = XNEW (struct cmd_list_element *);
862 show_cmd_list = XNEW (struct cmd_list_element *);
863 *set_cmd_list = NULL;
864 *show_cmd_list = NULL;
866 set_doc = xstrprintf (_("Configure what GDB does when %s is detected."),
869 show_doc = xstrprintf (_("Show what GDB does when %s is detected."),
872 add_prefix_cmd ((char*) problem->name,
873 class_maintenance, set_internal_problem_cmd, set_doc,
875 concat ("maintenance set ", problem->name, " ",
877 0/*allow-unknown*/, &maintenance_set_cmdlist);
879 add_prefix_cmd ((char*) problem->name,
880 class_maintenance, show_internal_problem_cmd, show_doc,
882 concat ("maintenance show ", problem->name, " ",
884 0/*allow-unknown*/, &maintenance_show_cmdlist);
886 if (problem->user_settable_should_quit)
888 set_doc = xstrprintf (_("Set whether GDB should quit "
889 "when an %s is detected"),
891 show_doc = xstrprintf (_("Show whether GDB will quit "
892 "when an %s is detected"),
894 add_setshow_enum_cmd ("quit", class_maintenance,
895 internal_problem_modes,
896 &problem->should_quit,
909 if (problem->user_settable_should_dump_core)
911 set_doc = xstrprintf (_("Set whether GDB should create a core "
912 "file of GDB when %s is detected"),
914 show_doc = xstrprintf (_("Show whether GDB will create a core "
915 "file of GDB when %s is detected"),
917 add_setshow_enum_cmd ("corefile", class_maintenance,
918 internal_problem_modes,
919 &problem->should_dump_core,
933 /* Return a newly allocated string, containing the PREFIX followed
934 by the system error message for errno (separated by a colon).
936 The result must be deallocated after use. */
939 perror_string (const char *prefix)
944 err = safe_strerror (errno);
945 combined = (char *) xmalloc (strlen (err) + strlen (prefix) + 3);
946 strcpy (combined, prefix);
947 strcat (combined, ": ");
948 strcat (combined, err);
953 /* Print the system error message for errno, and also mention STRING
954 as the file name for which the error was encountered. Use ERRCODE
955 for the thrown exception. Then return to command level. */
958 throw_perror_with_name (enum errors errcode, const char *string)
962 combined = perror_string (string);
963 make_cleanup (xfree, combined);
965 /* I understand setting these is a matter of taste. Still, some people
966 may clear errno but not know about bfd_error. Doing this here is not
968 bfd_set_error (bfd_error_no_error);
971 throw_error (errcode, _("%s."), combined);
974 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
977 perror_with_name (const char *string)
979 throw_perror_with_name (GENERIC_ERROR, string);
982 /* Same as perror_with_name except that it prints a warning instead
983 of throwing an error. */
986 perror_warning_with_name (const char *string)
990 combined = perror_string (string);
991 warning (_("%s"), combined);
995 /* Print the system error message for ERRCODE, and also mention STRING
996 as the file name for which the error was encountered. */
999 print_sys_errmsg (const char *string, int errcode)
1004 err = safe_strerror (errcode);
1005 combined = (char *) alloca (strlen (err) + strlen (string) + 3);
1006 strcpy (combined, string);
1007 strcat (combined, ": ");
1008 strcat (combined, err);
1010 /* We want anything which was printed on stdout to come out first, before
1012 gdb_flush (gdb_stdout);
1013 fprintf_unfiltered (gdb_stderr, "%s.\n", combined);
1016 /* Control C eventually causes this to be called, at a convenient time. */
1021 struct ui *ui = current_ui;
1023 if (sync_quit_force_run)
1025 sync_quit_force_run = 0;
1026 quit_force (NULL, 0);
1030 /* No steenking SIGINT will ever be coming our way when the
1031 program is resumed. Don't lie. */
1032 throw_quit ("Quit");
1035 /* If there is no terminal switching for this target, then we can't
1036 possibly get screwed by the lack of job control. */
1037 || !target_supports_terminal_ours ())
1038 throw_quit ("Quit");
1040 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
1049 if (sync_quit_force_run)
1054 if (deprecated_interactive_hook)
1055 deprecated_interactive_hook ();
1059 /* Called when a memory allocation fails, with the number of bytes of
1060 memory requested in SIZE. */
1063 malloc_failure (long size)
1067 internal_error (__FILE__, __LINE__,
1068 _("virtual memory exhausted: can't allocate %ld bytes."),
1073 internal_error (__FILE__, __LINE__, _("virtual memory exhausted."));
1077 /* My replacement for the read system call.
1078 Used like `read' but keeps going if `read' returns too soon. */
1081 myread (int desc, char *addr, int len)
1088 val = read (desc, addr, len);
1092 return orglen - len;
1100 print_spaces (int n, struct ui_file *file)
1102 fputs_unfiltered (n_spaces (n), file);
1105 /* Print a host address. */
1108 gdb_print_host_address_1 (const void *addr, struct ui_file *stream)
1110 fprintf_filtered (stream, "%s", host_address_to_string (addr));
1116 make_hex_string (const gdb_byte *data, size_t length)
1118 char *result = (char *) xmalloc (length * 2 + 1);
1123 for (i = 0; i < length; ++i)
1124 p += xsnprintf (p, 3, "%02x", data[i]);
1131 /* A cleanup function that calls regfree. */
1134 do_regfree_cleanup (void *r)
1136 regfree ((regex_t *) r);
1139 /* Create a new cleanup that frees the compiled regular expression R. */
1142 make_regfree_cleanup (regex_t *r)
1144 return make_cleanup (do_regfree_cleanup, r);
1147 /* Return an xmalloc'd error message resulting from a regular
1148 expression compilation failure. */
1151 get_regcomp_error (int code, regex_t *rx)
1153 size_t length = regerror (code, rx, NULL, 0);
1154 char *result = (char *) xmalloc (length);
1156 regerror (code, rx, result, length);
1160 /* Compile a regexp and throw an exception on error. This returns a
1161 cleanup to free the resulting pattern on success. RX must not be
1165 compile_rx_or_error (regex_t *pattern, const char *rx, const char *message)
1169 gdb_assert (rx != NULL);
1171 code = regcomp (pattern, rx, REG_NOSUB);
1174 char *err = get_regcomp_error (code, pattern);
1176 make_cleanup (xfree, err);
1177 error (("%s: %s"), message, err);
1180 return make_regfree_cleanup (pattern);
1183 /* A cleanup that simply calls ui_unregister_input_event_handler. */
1186 ui_unregister_input_event_handler_cleanup (void *ui)
1188 ui_unregister_input_event_handler ((struct ui *) ui);
1191 /* Set up to handle input. */
1193 static struct cleanup *
1194 prepare_to_handle_input (void)
1196 struct cleanup *old_chain;
1198 old_chain = make_cleanup_restore_target_terminal ();
1199 target_terminal_ours ();
1201 ui_register_input_event_handler (current_ui);
1202 if (current_ui->prompt_state == PROMPT_BLOCKED)
1203 make_cleanup (ui_unregister_input_event_handler_cleanup, current_ui);
1205 make_cleanup_override_quit_handler (default_quit_handler);
1212 /* This function supports the query, nquery, and yquery functions.
1213 Ask user a y-or-n question and return 0 if answer is no, 1 if
1214 answer is yes, or default the answer to the specified default
1215 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1216 default answer, or '\0' for no default.
1217 CTLSTR is the control string and should end in "? ". It should
1218 not say how to answer, because we do that.
1219 ARGS are the arguments passed along with the CTLSTR argument to
1222 static int ATTRIBUTE_PRINTF (1, 0)
1223 defaulted_query (const char *ctlstr, const char defchar, va_list args)
1228 char def_answer, not_def_answer;
1229 char *y_string, *n_string, *question, *prompt;
1230 /* Used to add duration we waited for user to respond to
1231 prompt_for_continue_wait_time. */
1232 struct timeval prompt_started, prompt_ended, prompt_delta;
1233 struct cleanup *old_chain;
1235 /* Set up according to which answer is the default. */
1236 if (defchar == '\0')
1240 not_def_answer = 'N';
1244 else if (defchar == 'y')
1248 not_def_answer = 'N';
1256 not_def_answer = 'Y';
1261 /* Automatically answer the default value if the user did not want
1262 prompts or the command was issued with the server prefix. */
1263 if (!confirm || server_command)
1266 /* If input isn't coming from the user directly, just say what
1267 question we're asking, and then answer the default automatically. This
1268 way, important error messages don't get lost when talking to GDB
1270 if (current_ui->instream != current_ui->stdin_stream
1271 || !input_interactive_p (current_ui))
1273 old_chain = make_cleanup_restore_target_terminal ();
1275 target_terminal_ours_for_output ();
1277 vfprintf_filtered (gdb_stdout, ctlstr, args);
1279 printf_filtered (_("(%s or %s) [answered %c; "
1280 "input not from terminal]\n"),
1281 y_string, n_string, def_answer);
1282 gdb_flush (gdb_stdout);
1284 do_cleanups (old_chain);
1288 if (deprecated_query_hook)
1292 old_chain = make_cleanup_restore_target_terminal ();
1293 res = deprecated_query_hook (ctlstr, args);
1294 do_cleanups (old_chain);
1298 /* Format the question outside of the loop, to avoid reusing args. */
1299 question = xstrvprintf (ctlstr, args);
1300 old_chain = make_cleanup (xfree, question);
1301 prompt = xstrprintf (_("%s%s(%s or %s) %s"),
1302 annotation_level > 1 ? "\n\032\032pre-query\n" : "",
1303 question, y_string, n_string,
1304 annotation_level > 1 ? "\n\032\032query\n" : "");
1305 make_cleanup (xfree, prompt);
1307 /* Used for calculating time spend waiting for user. */
1308 gettimeofday (&prompt_started, NULL);
1310 prepare_to_handle_input ();
1314 char *response, answer;
1316 gdb_flush (gdb_stdout);
1317 response = gdb_readline_wrapper (prompt);
1319 if (response == NULL) /* C-d */
1321 printf_filtered ("EOF [assumed %c]\n", def_answer);
1326 answer = response[0];
1331 /* Check answer. For the non-default, the user must specify
1332 the non-default explicitly. */
1333 if (answer == not_def_answer)
1335 retval = !def_value;
1338 /* Otherwise, if a default was specified, the user may either
1339 specify the required input or have it default by entering
1341 if (answer == def_answer
1342 || (defchar != '\0' && answer == '\0'))
1347 /* Invalid entries are not defaulted and require another selection. */
1348 printf_filtered (_("Please answer %s or %s.\n"),
1349 y_string, n_string);
1352 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1353 gettimeofday (&prompt_ended, NULL);
1354 timeval_sub (&prompt_delta, &prompt_ended, &prompt_started);
1355 timeval_add (&prompt_for_continue_wait_time,
1356 &prompt_for_continue_wait_time, &prompt_delta);
1358 if (annotation_level > 1)
1359 printf_filtered (("\n\032\032post-query\n"));
1360 do_cleanups (old_chain);
1365 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1366 answer is yes, or 0 if answer is defaulted.
1367 Takes three args which are given to printf to print the question.
1368 The first, a control string, should end in "? ".
1369 It should not say how to answer, because we do that. */
1372 nquery (const char *ctlstr, ...)
1377 va_start (args, ctlstr);
1378 ret = defaulted_query (ctlstr, 'n', args);
1383 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1384 answer is yes, or 1 if answer is defaulted.
1385 Takes three args which are given to printf to print the question.
1386 The first, a control string, should end in "? ".
1387 It should not say how to answer, because we do that. */
1390 yquery (const char *ctlstr, ...)
1395 va_start (args, ctlstr);
1396 ret = defaulted_query (ctlstr, 'y', args);
1401 /* Ask user a y-or-n question and return 1 iff answer is yes.
1402 Takes three args which are given to printf to print the question.
1403 The first, a control string, should end in "? ".
1404 It should not say how to answer, because we do that. */
1407 query (const char *ctlstr, ...)
1412 va_start (args, ctlstr);
1413 ret = defaulted_query (ctlstr, '\0', args);
1418 /* A helper for parse_escape that converts a host character to a
1419 target character. C is the host character. If conversion is
1420 possible, then the target character is stored in *TARGET_C and the
1421 function returns 1. Otherwise, the function returns 0. */
1424 host_char_to_target (struct gdbarch *gdbarch, int c, int *target_c)
1426 struct obstack host_data;
1428 struct cleanup *cleanups;
1431 obstack_init (&host_data);
1432 cleanups = make_cleanup_obstack_free (&host_data);
1434 convert_between_encodings (target_charset (gdbarch), host_charset (),
1435 (gdb_byte *) &the_char, 1, 1,
1436 &host_data, translit_none);
1438 if (obstack_object_size (&host_data) == 1)
1441 *target_c = *(char *) obstack_base (&host_data);
1444 do_cleanups (cleanups);
1448 /* Parse a C escape sequence. STRING_PTR points to a variable
1449 containing a pointer to the string to parse. That pointer
1450 should point to the character after the \. That pointer
1451 is updated past the characters we use. The value of the
1452 escape sequence is returned.
1454 A negative value means the sequence \ newline was seen,
1455 which is supposed to be equivalent to nothing at all.
1457 If \ is followed by a null character, we return a negative
1458 value and leave the string pointer pointing at the null character.
1460 If \ is followed by 000, we return 0 and leave the string pointer
1461 after the zeros. A value of 0 does not mean end of string. */
1464 parse_escape (struct gdbarch *gdbarch, const char **string_ptr)
1466 int target_char = -2; /* Initialize to avoid GCC warnings. */
1467 int c = *(*string_ptr)++;
1486 int i = host_hex_value (c);
1491 if (isdigit (c) && c != '8' && c != '9')
1495 i += host_hex_value (c);
1531 if (!host_char_to_target (gdbarch, c, &target_char))
1532 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1533 " which has no equivalent\nin the `%s' character set."),
1534 c, c, target_charset (gdbarch));
1538 /* Print the character C on STREAM as part of the contents of a literal
1539 string whose delimiter is QUOTER. Note that this routine should only
1540 be called for printing things which are independent of the language
1541 of the program being debugged.
1543 printchar will normally escape backslashes and instances of QUOTER. If
1544 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1545 As a side effect, if you pass the backslash character as the QUOTER,
1546 printchar will escape backslashes as usual, but not any other quoting
1550 printchar (int c, void (*do_fputs) (const char *, struct ui_file *),
1551 void (*do_fprintf) (struct ui_file *, const char *, ...)
1552 ATTRIBUTE_FPTR_PRINTF_2, struct ui_file *stream, int quoter)
1554 c &= 0xFF; /* Avoid sign bit follies */
1556 if (c < 0x20 || /* Low control chars */
1557 (c >= 0x7F && c < 0xA0) || /* DEL, High controls */
1558 (sevenbit_strings && c >= 0x80))
1559 { /* high order bit set */
1563 do_fputs ("\\n", stream);
1566 do_fputs ("\\b", stream);
1569 do_fputs ("\\t", stream);
1572 do_fputs ("\\f", stream);
1575 do_fputs ("\\r", stream);
1578 do_fputs ("\\e", stream);
1581 do_fputs ("\\a", stream);
1584 do_fprintf (stream, "\\%.3o", (unsigned int) c);
1590 if (quoter != 0 && (c == '\\' || c == quoter))
1591 do_fputs ("\\", stream);
1592 do_fprintf (stream, "%c", c);
1596 /* Print the character C on STREAM as part of the contents of a
1597 literal string whose delimiter is QUOTER. Note that these routines
1598 should only be call for printing things which are independent of
1599 the language of the program being debugged. */
1602 fputstr_filtered (const char *str, int quoter, struct ui_file *stream)
1605 printchar (*str++, fputs_filtered, fprintf_filtered, stream, quoter);
1609 fputstr_unfiltered (const char *str, int quoter, struct ui_file *stream)
1612 printchar (*str++, fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1616 fputstrn_filtered (const char *str, int n, int quoter,
1617 struct ui_file *stream)
1621 for (i = 0; i < n; i++)
1622 printchar (str[i], fputs_filtered, fprintf_filtered, stream, quoter);
1626 fputstrn_unfiltered (const char *str, int n, int quoter,
1627 struct ui_file *stream)
1631 for (i = 0; i < n; i++)
1632 printchar (str[i], fputs_unfiltered, fprintf_unfiltered, stream, quoter);
1636 /* Number of lines per page or UINT_MAX if paging is disabled. */
1637 static unsigned int lines_per_page;
1639 show_lines_per_page (struct ui_file *file, int from_tty,
1640 struct cmd_list_element *c, const char *value)
1642 fprintf_filtered (file,
1643 _("Number of lines gdb thinks are in a page is %s.\n"),
1647 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1648 static unsigned int chars_per_line;
1650 show_chars_per_line (struct ui_file *file, int from_tty,
1651 struct cmd_list_element *c, const char *value)
1653 fprintf_filtered (file,
1654 _("Number of characters gdb thinks "
1655 "are in a line is %s.\n"),
1659 /* Current count of lines printed on this page, chars on this line. */
1660 static unsigned int lines_printed, chars_printed;
1662 /* Buffer and start column of buffered text, for doing smarter word-
1663 wrapping. When someone calls wrap_here(), we start buffering output
1664 that comes through fputs_filtered(). If we see a newline, we just
1665 spit it out and forget about the wrap_here(). If we see another
1666 wrap_here(), we spit it out and remember the newer one. If we see
1667 the end of the line, we spit out a newline, the indent, and then
1668 the buffered output. */
1670 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1671 are waiting to be output (they have already been counted in chars_printed).
1672 When wrap_buffer[0] is null, the buffer is empty. */
1673 static char *wrap_buffer;
1675 /* Pointer in wrap_buffer to the next character to fill. */
1676 static char *wrap_pointer;
1678 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1680 static char *wrap_indent;
1682 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1683 is not in effect. */
1684 static int wrap_column;
1687 /* Inialize the number of lines per page and chars per line. */
1690 init_page_info (void)
1694 lines_per_page = UINT_MAX;
1695 chars_per_line = UINT_MAX;
1699 if (!tui_get_command_dimension (&chars_per_line, &lines_per_page))
1704 #if defined(__GO32__)
1705 rows = ScreenRows ();
1706 cols = ScreenCols ();
1707 lines_per_page = rows;
1708 chars_per_line = cols;
1710 /* Make sure Readline has initialized its terminal settings. */
1711 rl_reset_terminal (NULL);
1713 /* Get the screen size from Readline. */
1714 rl_get_screen_size (&rows, &cols);
1715 lines_per_page = rows;
1716 chars_per_line = cols;
1718 /* Readline should have fetched the termcap entry for us.
1719 Only try to use tgetnum function if rl_get_screen_size
1720 did not return a useful value. */
1721 if (((rows <= 0) && (tgetnum ("li") < 0))
1722 /* Also disable paging if inside Emacs. $EMACS was used
1723 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1724 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1726 /* The number of lines per page is not mentioned in the terminal
1727 description or EMACS evironment variable is set. This probably
1728 means that paging is not useful, so disable paging. */
1729 lines_per_page = UINT_MAX;
1732 /* If the output is not a terminal, don't paginate it. */
1733 if (!ui_file_isatty (gdb_stdout))
1734 lines_per_page = UINT_MAX;
1738 /* We handle SIGWINCH ourselves. */
1739 rl_catch_sigwinch = 0;
1745 /* Return nonzero if filtered printing is initialized. */
1747 filtered_printing_initialized (void)
1749 return wrap_buffer != NULL;
1752 /* Helper for make_cleanup_restore_page_info. */
1755 do_restore_page_info_cleanup (void *arg)
1761 /* Provide cleanup for restoring the terminal size. */
1764 make_cleanup_restore_page_info (void)
1766 struct cleanup *back_to;
1768 back_to = make_cleanup (do_restore_page_info_cleanup, NULL);
1769 make_cleanup_restore_uinteger (&lines_per_page);
1770 make_cleanup_restore_uinteger (&chars_per_line);
1775 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1776 Provide cleanup for restoring the original state. */
1779 set_batch_flag_and_make_cleanup_restore_page_info (void)
1781 struct cleanup *back_to = make_cleanup_restore_page_info ();
1783 make_cleanup_restore_integer (&batch_flag);
1790 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1793 set_screen_size (void)
1795 int rows = lines_per_page;
1796 int cols = chars_per_line;
1804 /* Update Readline's idea of the terminal size. */
1805 rl_set_screen_size (rows, cols);
1808 /* Reinitialize WRAP_BUFFER according to the current value of
1814 if (chars_per_line == 0)
1819 wrap_buffer = (char *) xmalloc (chars_per_line + 2);
1820 wrap_buffer[0] = '\0';
1823 wrap_buffer = (char *) xrealloc (wrap_buffer, chars_per_line + 2);
1824 wrap_pointer = wrap_buffer; /* Start it at the beginning. */
1828 set_width_command (char *args, int from_tty, struct cmd_list_element *c)
1835 set_height_command (char *args, int from_tty, struct cmd_list_element *c)
1843 set_screen_width_and_height (int width, int height)
1845 lines_per_page = height;
1846 chars_per_line = width;
1852 /* Wait, so the user can read what's on the screen. Prompt the user
1853 to continue by pressing RETURN. 'q' is also provided because
1854 telling users what to do in the prompt is more user-friendly than
1855 expecting them to think of Ctrl-C/SIGINT. */
1858 prompt_for_continue (void)
1861 char cont_prompt[120];
1862 /* Used to add duration we waited for user to respond to
1863 prompt_for_continue_wait_time. */
1864 struct timeval prompt_started, prompt_ended, prompt_delta;
1865 struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
1867 gettimeofday (&prompt_started, NULL);
1869 if (annotation_level > 1)
1870 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1872 strcpy (cont_prompt,
1873 "---Type <return> to continue, or q <return> to quit---");
1874 if (annotation_level > 1)
1875 strcat (cont_prompt, "\n\032\032prompt-for-continue\n");
1877 /* We must do this *before* we call gdb_readline_wrapper, else it
1878 will eventually call us -- thinking that we're trying to print
1879 beyond the end of the screen. */
1880 reinitialize_more_filter ();
1882 prepare_to_handle_input ();
1884 /* Call gdb_readline_wrapper, not readline, in order to keep an
1885 event loop running. */
1886 ignore = gdb_readline_wrapper (cont_prompt);
1887 make_cleanup (xfree, ignore);
1889 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1890 gettimeofday (&prompt_ended, NULL);
1891 timeval_sub (&prompt_delta, &prompt_ended, &prompt_started);
1892 timeval_add (&prompt_for_continue_wait_time,
1893 &prompt_for_continue_wait_time, &prompt_delta);
1895 if (annotation_level > 1)
1896 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1902 while (*p == ' ' || *p == '\t')
1905 /* Do not call quit here; there is no possibility of SIGINT. */
1906 throw_quit ("Quit");
1909 /* Now we have to do this again, so that GDB will know that it doesn't
1910 need to save the ---Type <return>--- line at the top of the screen. */
1911 reinitialize_more_filter ();
1913 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1915 do_cleanups (old_chain);
1918 /* Initalize timer to keep track of how long we waited for the user. */
1921 reset_prompt_for_continue_wait_time (void)
1923 static const struct timeval zero_timeval = { 0 };
1925 prompt_for_continue_wait_time = zero_timeval;
1928 /* Fetch the cumulative time spent in prompt_for_continue. */
1931 get_prompt_for_continue_wait_time (void)
1933 return prompt_for_continue_wait_time;
1936 /* Reinitialize filter; ie. tell it to reset to original values. */
1939 reinitialize_more_filter (void)
1945 /* Indicate that if the next sequence of characters overflows the line,
1946 a newline should be inserted here rather than when it hits the end.
1947 If INDENT is non-null, it is a string to be printed to indent the
1948 wrapped part on the next line. INDENT must remain accessible until
1949 the next call to wrap_here() or until a newline is printed through
1952 If the line is already overfull, we immediately print a newline and
1953 the indentation, and disable further wrapping.
1955 If we don't know the width of lines, but we know the page height,
1956 we must not wrap words, but should still keep track of newlines
1957 that were explicitly printed.
1959 INDENT should not contain tabs, as that will mess up the char count
1960 on the next line. FIXME.
1962 This routine is guaranteed to force out any output which has been
1963 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1964 used to force out output from the wrap_buffer. */
1967 wrap_here (char *indent)
1969 /* This should have been allocated, but be paranoid anyway. */
1971 internal_error (__FILE__, __LINE__,
1972 _("failed internal consistency check"));
1976 *wrap_pointer = '\0';
1977 fputs_unfiltered (wrap_buffer, gdb_stdout);
1979 wrap_pointer = wrap_buffer;
1980 wrap_buffer[0] = '\0';
1981 if (chars_per_line == UINT_MAX) /* No line overflow checking. */
1985 else if (chars_printed >= chars_per_line)
1987 puts_filtered ("\n");
1989 puts_filtered (indent);
1994 wrap_column = chars_printed;
1998 wrap_indent = indent;
2002 /* Print input string to gdb_stdout, filtered, with wrap,
2003 arranging strings in columns of n chars. String can be
2004 right or left justified in the column. Never prints
2005 trailing spaces. String should never be longer than
2006 width. FIXME: this could be useful for the EXAMINE
2007 command, which currently doesn't tabulate very well. */
2010 puts_filtered_tabular (char *string, int width, int right)
2016 gdb_assert (chars_per_line > 0);
2017 if (chars_per_line == UINT_MAX)
2019 fputs_filtered (string, gdb_stdout);
2020 fputs_filtered ("\n", gdb_stdout);
2024 if (((chars_printed - 1) / width + 2) * width >= chars_per_line)
2025 fputs_filtered ("\n", gdb_stdout);
2027 if (width >= chars_per_line)
2028 width = chars_per_line - 1;
2030 stringlen = strlen (string);
2032 if (chars_printed > 0)
2033 spaces = width - (chars_printed - 1) % width - 1;
2035 spaces += width - stringlen;
2037 spacebuf = (char *) alloca (spaces + 1);
2038 spacebuf[spaces] = '\0';
2040 spacebuf[spaces] = ' ';
2042 fputs_filtered (spacebuf, gdb_stdout);
2043 fputs_filtered (string, gdb_stdout);
2047 /* Ensure that whatever gets printed next, using the filtered output
2048 commands, starts at the beginning of the line. I.e. if there is
2049 any pending output for the current line, flush it and start a new
2050 line. Otherwise do nothing. */
2055 if (chars_printed > 0)
2057 puts_filtered ("\n");
2062 /* Like fputs but if FILTER is true, pause after every screenful.
2064 Regardless of FILTER can wrap at points other than the final
2065 character of a line.
2067 Unlike fputs, fputs_maybe_filtered does not return a value.
2068 It is OK for LINEBUFFER to be NULL, in which case just don't print
2071 Note that a longjmp to top level may occur in this routine (only if
2072 FILTER is true) (since prompt_for_continue may do so) so this
2073 routine should not be called when cleanups are not in place. */
2076 fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream,
2079 const char *lineptr;
2081 if (linebuffer == 0)
2084 /* Don't do any filtering if it is disabled. */
2085 if (stream != gdb_stdout
2086 || !pagination_enabled
2088 || (lines_per_page == UINT_MAX && chars_per_line == UINT_MAX)
2089 || top_level_interpreter () == NULL
2090 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2092 fputs_unfiltered (linebuffer, stream);
2096 /* Go through and output each character. Show line extension
2097 when this is necessary; prompt user for new page when this is
2100 lineptr = linebuffer;
2103 /* Possible new page. */
2104 if (filter && (lines_printed >= lines_per_page - 1))
2105 prompt_for_continue ();
2107 while (*lineptr && *lineptr != '\n')
2109 /* Print a single line. */
2110 if (*lineptr == '\t')
2113 *wrap_pointer++ = '\t';
2115 fputc_unfiltered ('\t', stream);
2116 /* Shifting right by 3 produces the number of tab stops
2117 we have already passed, and then adding one and
2118 shifting left 3 advances to the next tab stop. */
2119 chars_printed = ((chars_printed >> 3) + 1) << 3;
2125 *wrap_pointer++ = *lineptr;
2127 fputc_unfiltered (*lineptr, stream);
2132 if (chars_printed >= chars_per_line)
2134 unsigned int save_chars = chars_printed;
2138 /* If we aren't actually wrapping, don't output newline --
2139 if chars_per_line is right, we probably just overflowed
2140 anyway; if it's wrong, let us keep going. */
2142 fputc_unfiltered ('\n', stream);
2144 /* Possible new page. */
2145 if (lines_printed >= lines_per_page - 1)
2146 prompt_for_continue ();
2148 /* Now output indentation and wrapped string. */
2151 fputs_unfiltered (wrap_indent, stream);
2152 *wrap_pointer = '\0'; /* Null-terminate saved stuff, */
2153 fputs_unfiltered (wrap_buffer, stream); /* and eject it. */
2154 /* FIXME, this strlen is what prevents wrap_indent from
2155 containing tabs. However, if we recurse to print it
2156 and count its chars, we risk trouble if wrap_indent is
2157 longer than (the user settable) chars_per_line.
2158 Note also that this can set chars_printed > chars_per_line
2159 if we are printing a long string. */
2160 chars_printed = strlen (wrap_indent)
2161 + (save_chars - wrap_column);
2162 wrap_pointer = wrap_buffer; /* Reset buffer */
2163 wrap_buffer[0] = '\0';
2164 wrap_column = 0; /* And disable fancy wrap */
2169 if (*lineptr == '\n')
2172 wrap_here ((char *) 0); /* Spit out chars, cancel
2175 fputc_unfiltered ('\n', stream);
2182 fputs_filtered (const char *linebuffer, struct ui_file *stream)
2184 fputs_maybe_filtered (linebuffer, stream, 1);
2188 putchar_unfiltered (int c)
2192 ui_file_write (gdb_stdout, &buf, 1);
2196 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2197 May return nonlocally. */
2200 putchar_filtered (int c)
2202 return fputc_filtered (c, gdb_stdout);
2206 fputc_unfiltered (int c, struct ui_file *stream)
2210 ui_file_write (stream, &buf, 1);
2215 fputc_filtered (int c, struct ui_file *stream)
2221 fputs_filtered (buf, stream);
2225 /* puts_debug is like fputs_unfiltered, except it prints special
2226 characters in printable fashion. */
2229 puts_debug (char *prefix, char *string, char *suffix)
2233 /* Print prefix and suffix after each line. */
2234 static int new_line = 1;
2235 static int return_p = 0;
2236 static char *prev_prefix = "";
2237 static char *prev_suffix = "";
2239 if (*string == '\n')
2242 /* If the prefix is changing, print the previous suffix, a new line,
2243 and the new prefix. */
2244 if ((return_p || (strcmp (prev_prefix, prefix) != 0)) && !new_line)
2246 fputs_unfiltered (prev_suffix, gdb_stdlog);
2247 fputs_unfiltered ("\n", gdb_stdlog);
2248 fputs_unfiltered (prefix, gdb_stdlog);
2251 /* Print prefix if we printed a newline during the previous call. */
2255 fputs_unfiltered (prefix, gdb_stdlog);
2258 prev_prefix = prefix;
2259 prev_suffix = suffix;
2261 /* Output characters in a printable format. */
2262 while ((ch = *string++) != '\0')
2268 fputc_unfiltered (ch, gdb_stdlog);
2271 fprintf_unfiltered (gdb_stdlog, "\\x%02x", ch & 0xff);
2275 fputs_unfiltered ("\\\\", gdb_stdlog);
2278 fputs_unfiltered ("\\b", gdb_stdlog);
2281 fputs_unfiltered ("\\f", gdb_stdlog);
2285 fputs_unfiltered ("\\n", gdb_stdlog);
2288 fputs_unfiltered ("\\r", gdb_stdlog);
2291 fputs_unfiltered ("\\t", gdb_stdlog);
2294 fputs_unfiltered ("\\v", gdb_stdlog);
2298 return_p = ch == '\r';
2301 /* Print suffix if we printed a newline. */
2304 fputs_unfiltered (suffix, gdb_stdlog);
2305 fputs_unfiltered ("\n", gdb_stdlog);
2310 /* Print a variable number of ARGS using format FORMAT. If this
2311 information is going to put the amount written (since the last call
2312 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2313 call prompt_for_continue to get the users permision to continue.
2315 Unlike fprintf, this function does not return a value.
2317 We implement three variants, vfprintf (takes a vararg list and stream),
2318 fprintf (takes a stream to write on), and printf (the usual).
2320 Note also that a longjmp to top level may occur in this routine
2321 (since prompt_for_continue may do so) so this routine should not be
2322 called when cleanups are not in place. */
2325 vfprintf_maybe_filtered (struct ui_file *stream, const char *format,
2326 va_list args, int filter)
2329 struct cleanup *old_cleanups;
2331 linebuffer = xstrvprintf (format, args);
2332 old_cleanups = make_cleanup (xfree, linebuffer);
2333 fputs_maybe_filtered (linebuffer, stream, filter);
2334 do_cleanups (old_cleanups);
2339 vfprintf_filtered (struct ui_file *stream, const char *format, va_list args)
2341 vfprintf_maybe_filtered (stream, format, args, 1);
2345 vfprintf_unfiltered (struct ui_file *stream, const char *format, va_list args)
2348 struct cleanup *old_cleanups;
2350 linebuffer = xstrvprintf (format, args);
2351 old_cleanups = make_cleanup (xfree, linebuffer);
2352 if (debug_timestamp && stream == gdb_stdlog)
2358 gettimeofday (&tm, NULL);
2360 len = strlen (linebuffer);
2361 need_nl = (len > 0 && linebuffer[len - 1] != '\n');
2363 timestamp = xstrprintf ("%ld:%ld %s%s",
2364 (long) tm.tv_sec, (long) tm.tv_usec,
2366 need_nl ? "\n": "");
2367 make_cleanup (xfree, timestamp);
2368 fputs_unfiltered (timestamp, stream);
2371 fputs_unfiltered (linebuffer, stream);
2372 do_cleanups (old_cleanups);
2376 vprintf_filtered (const char *format, va_list args)
2378 vfprintf_maybe_filtered (gdb_stdout, format, args, 1);
2382 vprintf_unfiltered (const char *format, va_list args)
2384 vfprintf_unfiltered (gdb_stdout, format, args);
2388 fprintf_filtered (struct ui_file *stream, const char *format, ...)
2392 va_start (args, format);
2393 vfprintf_filtered (stream, format, args);
2398 fprintf_unfiltered (struct ui_file *stream, const char *format, ...)
2402 va_start (args, format);
2403 vfprintf_unfiltered (stream, format, args);
2407 /* Like fprintf_filtered, but prints its result indented.
2408 Called as fprintfi_filtered (spaces, stream, format, ...); */
2411 fprintfi_filtered (int spaces, struct ui_file *stream, const char *format,
2416 va_start (args, format);
2417 print_spaces_filtered (spaces, stream);
2419 vfprintf_filtered (stream, format, args);
2425 printf_filtered (const char *format, ...)
2429 va_start (args, format);
2430 vfprintf_filtered (gdb_stdout, format, args);
2436 printf_unfiltered (const char *format, ...)
2440 va_start (args, format);
2441 vfprintf_unfiltered (gdb_stdout, format, args);
2445 /* Like printf_filtered, but prints it's result indented.
2446 Called as printfi_filtered (spaces, format, ...); */
2449 printfi_filtered (int spaces, const char *format, ...)
2453 va_start (args, format);
2454 print_spaces_filtered (spaces, gdb_stdout);
2455 vfprintf_filtered (gdb_stdout, format, args);
2459 /* Easy -- but watch out!
2461 This routine is *not* a replacement for puts()! puts() appends a newline.
2462 This one doesn't, and had better not! */
2465 puts_filtered (const char *string)
2467 fputs_filtered (string, gdb_stdout);
2471 puts_unfiltered (const char *string)
2473 fputs_unfiltered (string, gdb_stdout);
2476 /* Return a pointer to N spaces and a null. The pointer is good
2477 until the next call to here. */
2482 static char *spaces = 0;
2483 static int max_spaces = -1;
2489 spaces = (char *) xmalloc (n + 1);
2490 for (t = spaces + n; t != spaces;)
2496 return spaces + max_spaces - n;
2499 /* Print N spaces. */
2501 print_spaces_filtered (int n, struct ui_file *stream)
2503 fputs_filtered (n_spaces (n), stream);
2506 /* C++/ObjC demangler stuff. */
2508 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2509 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2510 If the name is not mangled, or the language for the name is unknown, or
2511 demangling is off, the name is printed in its "raw" form. */
2514 fprintf_symbol_filtered (struct ui_file *stream, const char *name,
2515 enum language lang, int arg_mode)
2521 /* If user wants to see raw output, no problem. */
2524 fputs_filtered (name, stream);
2528 demangled = language_demangle (language_def (lang), name, arg_mode);
2529 fputs_filtered (demangled ? demangled : name, stream);
2530 if (demangled != NULL)
2538 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2539 differences in whitespace. Returns 0 if they match, non-zero if they
2540 don't (slightly different than strcmp()'s range of return values).
2542 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2543 This "feature" is useful when searching for matching C++ function names
2544 (such as if the user types 'break FOO', where FOO is a mangled C++
2548 strcmp_iw (const char *string1, const char *string2)
2550 while ((*string1 != '\0') && (*string2 != '\0'))
2552 while (isspace (*string1))
2556 while (isspace (*string2))
2560 if (case_sensitivity == case_sensitive_on && *string1 != *string2)
2562 if (case_sensitivity == case_sensitive_off
2563 && (tolower ((unsigned char) *string1)
2564 != tolower ((unsigned char) *string2)))
2566 if (*string1 != '\0')
2572 return (*string1 != '\0' && *string1 != '(') || (*string2 != '\0');
2575 /* This is like strcmp except that it ignores whitespace and treats
2576 '(' as the first non-NULL character in terms of ordering. Like
2577 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2578 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2579 according to that ordering.
2581 If a list is sorted according to this function and if you want to
2582 find names in the list that match some fixed NAME according to
2583 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2584 where this function would put NAME.
2586 This function must be neutral to the CASE_SENSITIVITY setting as the user
2587 may choose it during later lookup. Therefore this function always sorts
2588 primarily case-insensitively and secondarily case-sensitively.
2590 Here are some examples of why using strcmp to sort is a bad idea:
2594 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2595 we try to do a search for "foo<char*>", strcmp will locate this
2596 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2597 will start looking at strings beginning with "goo", and will never
2598 see the correct match of "foo<char *>".
2600 Parenthesis example:
2602 In practice, this is less like to be an issue, but I'll give it a
2603 shot. Let's assume that '$' is a legitimate character to occur in
2604 symbols. (Which may well even be the case on some systems.) Then
2605 say that the partial symbol table contains "foo$" and "foo(int)".
2606 strcmp will put them in this order, since '$' < '('. Now, if the
2607 user searches for "foo", then strcmp will sort "foo" before "foo$".
2608 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2609 "foo") is false, so it won't proceed to the actual match of
2610 "foo(int)" with "foo". */
2613 strcmp_iw_ordered (const char *string1, const char *string2)
2615 const char *saved_string1 = string1, *saved_string2 = string2;
2616 enum case_sensitivity case_pass = case_sensitive_off;
2620 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2621 Provide stub characters if we are already at the end of one of the
2623 char c1 = 'X', c2 = 'X';
2625 while (*string1 != '\0' && *string2 != '\0')
2627 while (isspace (*string1))
2629 while (isspace (*string2))
2634 case case_sensitive_off:
2635 c1 = tolower ((unsigned char) *string1);
2636 c2 = tolower ((unsigned char) *string2);
2638 case case_sensitive_on:
2646 if (*string1 != '\0')
2655 /* Characters are non-equal unless they're both '\0'; we want to
2656 make sure we get the comparison right according to our
2657 comparison in the cases where one of them is '\0' or '('. */
2659 if (*string2 == '\0')
2664 if (*string2 == '\0')
2669 if (*string2 == '\0' || *string2 == '(')
2678 if (case_pass == case_sensitive_on)
2681 /* Otherwise the strings were equal in case insensitive way, make
2682 a more fine grained comparison in a case sensitive way. */
2684 case_pass = case_sensitive_on;
2685 string1 = saved_string1;
2686 string2 = saved_string2;
2690 /* A simple comparison function with opposite semantics to strcmp. */
2693 streq (const char *lhs, const char *rhs)
2695 return !strcmp (lhs, rhs);
2701 ** Answer whether string_to_compare is a full or partial match to
2702 ** template_string. The partial match must be in sequence starting
2706 subset_compare (char *string_to_compare, char *template_string)
2710 if (template_string != (char *) NULL && string_to_compare != (char *) NULL
2711 && strlen (string_to_compare) <= strlen (template_string))
2713 (startswith (template_string, string_to_compare));
2720 show_debug_timestamp (struct ui_file *file, int from_tty,
2721 struct cmd_list_element *c, const char *value)
2723 fprintf_filtered (file, _("Timestamping debugging messages is %s.\n"),
2729 initialize_utils (void)
2731 add_setshow_uinteger_cmd ("width", class_support, &chars_per_line, _("\
2732 Set number of characters where GDB should wrap lines of its output."), _("\
2733 Show number of characters where GDB should wrap lines of its output."), _("\
2734 This affects where GDB wraps its output to fit the screen width.\n\
2735 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2737 show_chars_per_line,
2738 &setlist, &showlist);
2740 add_setshow_uinteger_cmd ("height", class_support, &lines_per_page, _("\
2741 Set number of lines in a page for GDB output pagination."), _("\
2742 Show number of lines in a page for GDB output pagination."), _("\
2743 This affects the number of lines after which GDB will pause\n\
2744 its output and ask you whether to continue.\n\
2745 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2747 show_lines_per_page,
2748 &setlist, &showlist);
2750 add_setshow_boolean_cmd ("pagination", class_support,
2751 &pagination_enabled, _("\
2752 Set state of GDB output pagination."), _("\
2753 Show state of GDB output pagination."), _("\
2754 When pagination is ON, GDB pauses at end of each screenful of\n\
2755 its output and asks you whether to continue.\n\
2756 Turning pagination off is an alternative to \"set height unlimited\"."),
2758 show_pagination_enabled,
2759 &setlist, &showlist);
2761 add_setshow_boolean_cmd ("sevenbit-strings", class_support,
2762 &sevenbit_strings, _("\
2763 Set printing of 8-bit characters in strings as \\nnn."), _("\
2764 Show printing of 8-bit characters in strings as \\nnn."), NULL,
2766 show_sevenbit_strings,
2767 &setprintlist, &showprintlist);
2769 add_setshow_boolean_cmd ("timestamp", class_maintenance,
2770 &debug_timestamp, _("\
2771 Set timestamping of debugging messages."), _("\
2772 Show timestamping of debugging messages."), _("\
2773 When set, debugging messages will be marked with seconds and microseconds."),
2775 show_debug_timestamp,
2776 &setdebuglist, &showdebuglist);
2780 paddress (struct gdbarch *gdbarch, CORE_ADDR addr)
2782 /* Truncate address to the size of a target address, avoiding shifts
2783 larger or equal than the width of a CORE_ADDR. The local
2784 variable ADDR_BIT stops the compiler reporting a shift overflow
2785 when it won't occur. */
2786 /* NOTE: This assumes that the significant address information is
2787 kept in the least significant bits of ADDR - the upper bits were
2788 either zero or sign extended. Should gdbarch_address_to_pointer or
2789 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2791 int addr_bit = gdbarch_addr_bit (gdbarch);
2793 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2794 addr &= ((CORE_ADDR) 1 << addr_bit) - 1;
2795 return hex_string (addr);
2798 /* This function is described in "defs.h". */
2801 print_core_address (struct gdbarch *gdbarch, CORE_ADDR address)
2803 int addr_bit = gdbarch_addr_bit (gdbarch);
2805 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
2806 address &= ((CORE_ADDR) 1 << addr_bit) - 1;
2808 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2809 that returns the language localized string formatted to a width
2810 based on gdbarch_addr_bit. */
2812 return hex_string_custom (address, 8);
2814 return hex_string_custom (address, 16);
2817 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2820 core_addr_hash (const void *ap)
2822 const CORE_ADDR *addrp = (const CORE_ADDR *) ap;
2827 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2830 core_addr_eq (const void *ap, const void *bp)
2832 const CORE_ADDR *addr_ap = (const CORE_ADDR *) ap;
2833 const CORE_ADDR *addr_bp = (const CORE_ADDR *) bp;
2835 return *addr_ap == *addr_bp;
2838 /* Convert a string back into a CORE_ADDR. */
2840 string_to_core_addr (const char *my_string)
2844 if (my_string[0] == '0' && tolower (my_string[1]) == 'x')
2846 /* Assume that it is in hex. */
2849 for (i = 2; my_string[i] != '\0'; i++)
2851 if (isdigit (my_string[i]))
2852 addr = (my_string[i] - '0') + (addr * 16);
2853 else if (isxdigit (my_string[i]))
2854 addr = (tolower (my_string[i]) - 'a' + 0xa) + (addr * 16);
2856 error (_("invalid hex \"%s\""), my_string);
2861 /* Assume that it is in decimal. */
2864 for (i = 0; my_string[i] != '\0'; i++)
2866 if (isdigit (my_string[i]))
2867 addr = (my_string[i] - '0') + (addr * 10);
2869 error (_("invalid decimal \"%s\""), my_string);
2877 gdb_realpath (const char *filename)
2879 /* On most hosts, we rely on canonicalize_file_name to compute
2880 the FILENAME's realpath.
2882 But the situation is slightly more complex on Windows, due to some
2883 versions of GCC which were reported to generate paths where
2884 backlashes (the directory separator) were doubled. For instance:
2885 c:\\some\\double\\slashes\\dir
2887 c:\some\double\slashes\dir
2888 Those double-slashes were getting in the way when comparing paths,
2889 for instance when trying to insert a breakpoint as follow:
2890 (gdb) b c:/some/double/slashes/dir/foo.c:4
2891 No source file named c:/some/double/slashes/dir/foo.c:4.
2892 (gdb) b c:\some\double\slashes\dir\foo.c:4
2893 No source file named c:\some\double\slashes\dir\foo.c:4.
2894 To prevent this from happening, we need this function to always
2895 strip those extra backslashes. While canonicalize_file_name does
2896 perform this simplification, it only works when the path is valid.
2897 Since the simplification would be useful even if the path is not
2898 valid (one can always set a breakpoint on a file, even if the file
2899 does not exist locally), we rely instead on GetFullPathName to
2900 perform the canonicalization. */
2902 #if defined (_WIN32)
2905 DWORD len = GetFullPathName (filename, MAX_PATH, buf, NULL);
2907 /* The file system is case-insensitive but case-preserving.
2908 So it is important we do not lowercase the path. Otherwise,
2909 we might not be able to display the original casing in a given
2911 if (len > 0 && len < MAX_PATH)
2912 return xstrdup (buf);
2916 char *rp = canonicalize_file_name (filename);
2923 /* This system is a lost cause, just dup the buffer. */
2924 return xstrdup (filename);
2927 /* Return a copy of FILENAME, with its directory prefix canonicalized
2931 gdb_realpath_keepfile (const char *filename)
2933 const char *base_name = lbasename (filename);
2938 /* Extract the basename of filename, and return immediately
2939 a copy of filename if it does not contain any directory prefix. */
2940 if (base_name == filename)
2941 return xstrdup (filename);
2943 dir_name = (char *) alloca ((size_t) (base_name - filename + 2));
2944 /* Allocate enough space to store the dir_name + plus one extra
2945 character sometimes needed under Windows (see below), and
2946 then the closing \000 character. */
2947 strncpy (dir_name, filename, base_name - filename);
2948 dir_name[base_name - filename] = '\000';
2950 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
2951 /* We need to be careful when filename is of the form 'd:foo', which
2952 is equivalent of d:./foo, which is totally different from d:/foo. */
2953 if (strlen (dir_name) == 2 && isalpha (dir_name[0]) && dir_name[1] == ':')
2956 dir_name[3] = '\000';
2960 /* Canonicalize the directory prefix, and build the resulting
2961 filename. If the dirname realpath already contains an ending
2962 directory separator, avoid doubling it. */
2963 real_path = gdb_realpath (dir_name);
2964 if (IS_DIR_SEPARATOR (real_path[strlen (real_path) - 1]))
2965 result = concat (real_path, base_name, (char *) NULL);
2967 result = concat (real_path, SLASH_STRING, base_name, (char *) NULL);
2973 /* Return PATH in absolute form, performing tilde-expansion if necessary.
2974 PATH cannot be NULL or the empty string.
2975 This does not resolve symlinks however, use gdb_realpath for that.
2976 Space for the result is allocated with malloc.
2977 If the path is already absolute, it is strdup'd.
2978 If there is a problem computing the absolute path, the path is returned
2979 unchanged (still strdup'd). */
2982 gdb_abspath (const char *path)
2984 gdb_assert (path != NULL && path[0] != '\0');
2987 return tilde_expand (path);
2989 if (IS_ABSOLUTE_PATH (path))
2990 return xstrdup (path);
2992 /* Beware the // my son, the Emacs barfs, the botch that catch... */
2993 return concat (current_directory,
2994 IS_DIR_SEPARATOR (current_directory[strlen (current_directory) - 1])
2995 ? "" : SLASH_STRING,
2996 path, (char *) NULL);
3000 align_up (ULONGEST v, int n)
3002 /* Check that N is really a power of two. */
3003 gdb_assert (n && (n & (n-1)) == 0);
3004 return (v + n - 1) & -n;
3008 align_down (ULONGEST v, int n)
3010 /* Check that N is really a power of two. */
3011 gdb_assert (n && (n & (n-1)) == 0);
3015 /* Allocation function for the libiberty hash table which uses an
3016 obstack. The obstack is passed as DATA. */
3019 hashtab_obstack_allocate (void *data, size_t size, size_t count)
3021 size_t total = size * count;
3022 void *ptr = obstack_alloc ((struct obstack *) data, total);
3024 memset (ptr, 0, total);
3028 /* Trivial deallocation function for the libiberty splay tree and hash
3029 table - don't deallocate anything. Rely on later deletion of the
3030 obstack. DATA will be the obstack, although it is not needed
3034 dummy_obstack_deallocate (void *object, void *data)
3039 /* Simple, portable version of dirname that does not modify its
3043 ldirname (const char *filename)
3045 const char *base = lbasename (filename);
3048 while (base > filename && IS_DIR_SEPARATOR (base[-1]))
3051 if (base == filename)
3054 dirname = (char *) xmalloc (base - filename + 2);
3055 memcpy (dirname, filename, base - filename);
3057 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3058 create "d:./bar" later instead of the (different) "d:/bar". */
3059 if (base - filename == 2 && IS_ABSOLUTE_PATH (base)
3060 && !IS_DIR_SEPARATOR (filename[0]))
3061 dirname[base++ - filename] = '.';
3063 dirname[base - filename] = '\0';
3067 /* Call libiberty's buildargv, and return the result.
3068 If buildargv fails due to out-of-memory, call nomem.
3069 Therefore, the returned value is guaranteed to be non-NULL,
3070 unless the parameter itself is NULL. */
3073 gdb_buildargv (const char *s)
3075 char **argv = buildargv (s);
3077 if (s != NULL && argv == NULL)
3083 compare_positive_ints (const void *ap, const void *bp)
3085 /* Because we know we're comparing two ints which are positive,
3086 there's no danger of overflow here. */
3087 return * (int *) ap - * (int *) bp;
3090 /* String compare function for qsort. */
3093 compare_strings (const void *arg1, const void *arg2)
3095 const char **s1 = (const char **) arg1;
3096 const char **s2 = (const char **) arg2;
3098 return strcmp (*s1, *s2);
3101 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3102 #define AMBIGUOUS_MESS2 \
3103 ".\nUse \"set gnutarget format-name\" to specify the format."
3106 gdb_bfd_errmsg (bfd_error_type error_tag, char **matching)
3112 /* Check if errmsg just need simple return. */
3113 if (error_tag != bfd_error_file_ambiguously_recognized || matching == NULL)
3114 return bfd_errmsg (error_tag);
3116 ret_len = strlen (bfd_errmsg (error_tag)) + strlen (AMBIGUOUS_MESS1)
3117 + strlen (AMBIGUOUS_MESS2);
3118 for (p = matching; *p; p++)
3119 ret_len += strlen (*p) + 1;
3120 ret = (char *) xmalloc (ret_len + 1);
3122 make_cleanup (xfree, ret);
3124 strcpy (retp, bfd_errmsg (error_tag));
3125 retp += strlen (retp);
3127 strcpy (retp, AMBIGUOUS_MESS1);
3128 retp += strlen (retp);
3130 for (p = matching; *p; p++)
3132 sprintf (retp, " %s", *p);
3133 retp += strlen (retp);
3137 strcpy (retp, AMBIGUOUS_MESS2);
3142 /* Return ARGS parsed as a valid pid, or throw an error. */
3145 parse_pid_to_attach (const char *args)
3151 error_no_arg (_("process-id to attach"));
3153 dummy = (char *) args;
3154 pid = strtoul (args, &dummy, 0);
3155 /* Some targets don't set errno on errors, grrr! */
3156 if ((pid == 0 && dummy == args) || dummy != &args[strlen (args)])
3157 error (_("Illegal process-id: %s."), args);
3162 /* Helper for make_bpstat_clear_actions_cleanup. */
3165 do_bpstat_clear_actions_cleanup (void *unused)
3167 bpstat_clear_actions ();
3170 /* Call bpstat_clear_actions for the case an exception is throw. You should
3171 discard_cleanups if no exception is caught. */
3174 make_bpstat_clear_actions_cleanup (void)
3176 return make_cleanup (do_bpstat_clear_actions_cleanup, NULL);
3179 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3180 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3181 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3184 producer_is_gcc_ge_4 (const char *producer)
3188 if (! producer_is_gcc (producer, &major, &minor))
3197 /* Returns nonzero if the given PRODUCER string is GCC and sets the MAJOR
3198 and MINOR versions when not NULL. Returns zero if the given PRODUCER
3199 is NULL or it isn't GCC. */
3202 producer_is_gcc (const char *producer, int *major, int *minor)
3206 if (producer != NULL && startswith (producer, "GNU "))
3215 /* Skip any identifier after "GNU " - such as "C11" "C++" or "Java".
3216 A full producer string might look like:
3218 "GNU Fortran 4.8.2 20140120 (Red Hat 4.8.2-16) -mtune=generic ..."
3219 "GNU C++14 5.0.0 20150123 (experimental)"
3221 cs = &producer[strlen ("GNU ")];
3222 while (*cs && !isspace (*cs))
3224 if (*cs && isspace (*cs))
3226 if (sscanf (cs, "%d.%d", major, minor) == 2)
3230 /* Not recognized as GCC. */
3234 /* Helper for make_cleanup_free_char_ptr_vec. */
3237 do_free_char_ptr_vec (void *arg)
3239 VEC (char_ptr) *char_ptr_vec = (VEC (char_ptr) *) arg;
3241 free_char_ptr_vec (char_ptr_vec);
3244 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3245 final VEC_free for CHAR_PTR_VEC itself.
3247 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3248 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3249 this function does not (cannot) clear the pointer. */
3252 make_cleanup_free_char_ptr_vec (VEC (char_ptr) *char_ptr_vec)
3254 return make_cleanup (do_free_char_ptr_vec, char_ptr_vec);
3257 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3258 must come from xrealloc-compatible allocator and it may be updated. FROM
3259 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3260 located at the start or end of *STRINGP. */
3263 substitute_path_component (char **stringp, const char *from, const char *to)
3265 char *string = *stringp, *s;
3266 const size_t from_len = strlen (from);
3267 const size_t to_len = strlen (to);
3271 s = strstr (s, from);
3275 if ((s == string || IS_DIR_SEPARATOR (s[-1])
3276 || s[-1] == DIRNAME_SEPARATOR)
3277 && (s[from_len] == '\0' || IS_DIR_SEPARATOR (s[from_len])
3278 || s[from_len] == DIRNAME_SEPARATOR))
3283 = (char *) xrealloc (string, (strlen (string) + to_len + 1));
3285 /* Relocate the current S pointer. */
3286 s = s - string + string_new;
3287 string = string_new;
3289 /* Replace from by to. */
3290 memmove (&s[to_len], &s[from_len], strlen (&s[from_len]) + 1);
3291 memcpy (s, to, to_len);
3306 /* SIGALRM handler for waitpid_with_timeout. */
3309 sigalrm_handler (int signo)
3311 /* Nothing to do. */
3316 /* Wrapper to wait for child PID to die with TIMEOUT.
3317 TIMEOUT is the time to stop waiting in seconds.
3318 If TIMEOUT is zero, pass WNOHANG to waitpid.
3319 Returns PID if it was successfully waited for, otherwise -1.
3321 Timeouts are currently implemented with alarm and SIGALRM.
3322 If the host does not support them, this waits "forever".
3323 It would be odd though for a host to have waitpid and not SIGALRM. */
3326 wait_to_die_with_timeout (pid_t pid, int *status, int timeout)
3328 pid_t waitpid_result;
3330 gdb_assert (pid > 0);
3331 gdb_assert (timeout >= 0);
3336 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3337 struct sigaction sa, old_sa;
3339 sa.sa_handler = sigalrm_handler;
3340 sigemptyset (&sa.sa_mask);
3342 sigaction (SIGALRM, &sa, &old_sa);
3346 ofunc = signal (SIGALRM, sigalrm_handler);
3352 waitpid_result = waitpid (pid, status, 0);
3356 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3357 sigaction (SIGALRM, &old_sa, NULL);
3359 signal (SIGALRM, ofunc);
3364 waitpid_result = waitpid (pid, status, WNOHANG);
3366 if (waitpid_result == pid)
3372 #endif /* HAVE_WAITPID */
3374 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3375 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3377 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3378 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3381 gdb_filename_fnmatch (const char *pattern, const char *string, int flags)
3383 gdb_assert ((flags & FNM_FILE_NAME) != 0);
3385 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3386 gdb_assert ((flags & FNM_NOESCAPE) != 0);
3388 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3390 char *pattern_slash, *string_slash;
3392 /* Replace '\' by '/' in both strings. */
3394 pattern_slash = (char *) alloca (strlen (pattern) + 1);
3395 strcpy (pattern_slash, pattern);
3396 pattern = pattern_slash;
3397 for (; *pattern_slash != 0; pattern_slash++)
3398 if (IS_DIR_SEPARATOR (*pattern_slash))
3399 *pattern_slash = '/';
3401 string_slash = (char *) alloca (strlen (string) + 1);
3402 strcpy (string_slash, string);
3403 string = string_slash;
3404 for (; *string_slash != 0; string_slash++)
3405 if (IS_DIR_SEPARATOR (*string_slash))
3406 *string_slash = '/';
3408 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3410 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3411 flags |= FNM_CASEFOLD;
3412 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3414 return fnmatch (pattern, string, flags);
3417 /* Return the number of path elements in PATH.
3425 count_path_elements (const char *path)
3428 const char *p = path;
3430 if (HAS_DRIVE_SPEC (p))
3432 p = STRIP_DRIVE_SPEC (p);
3438 if (IS_DIR_SEPARATOR (*p))
3443 /* Backup one if last character is /, unless it's the only one. */
3444 if (p > path + 1 && IS_DIR_SEPARATOR (p[-1]))
3447 /* Add one for the file name, if present. */
3448 if (p > path && !IS_DIR_SEPARATOR (p[-1]))
3454 /* Remove N leading path elements from PATH.
3455 N must be non-negative.
3456 If PATH has more than N path elements then return NULL.
3457 If PATH has exactly N path elements then return "".
3458 See count_path_elements for a description of how we do the counting. */
3461 strip_leading_path_elements (const char *path, int n)
3464 const char *p = path;
3466 gdb_assert (n >= 0);
3471 if (HAS_DRIVE_SPEC (p))
3473 p = STRIP_DRIVE_SPEC (p);
3479 while (*p != '\0' && !IS_DIR_SEPARATOR (*p))
3494 /* Provide a prototype to silence -Wmissing-prototypes. */
3495 extern initialize_file_ftype _initialize_utils;
3498 _initialize_utils (void)
3500 add_internal_problem_command (&internal_error_problem);
3501 add_internal_problem_command (&internal_warning_problem);
3502 add_internal_problem_command (&demangler_warning_problem);