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/>. */
23 #include "event-top.h"
24 #include "gdbthread.h"
27 #ifdef HAVE_SYS_RESOURCE_H
28 #include <sys/resource.h>
29 #endif /* HAVE_SYS_RESOURCE_H */
32 #include "tui/tui.h" /* For tui_get_command_dimension. */
40 #include "timeval-utils.h"
45 #include "gdb-demangle.h"
46 #include "expression.h"
50 #include "filenames.h"
52 #include "gdb_obstack.h"
58 #include "inferior.h" /* for signed_pointer_to_address */
60 #include "gdb_curses.h"
62 #include "readline/readline.h"
64 #include "gdb_sys_time.h"
67 #include "gdb_usleep.h"
69 #include "gdb_regex.h"
72 extern PTR
malloc (); /* ARI: PTR */
74 #if !HAVE_DECL_REALLOC
75 extern PTR
realloc (); /* ARI: PTR */
81 void (*deprecated_error_begin_hook
) (void);
83 /* Prototypes for local functions */
85 static void vfprintf_maybe_filtered (struct ui_file
*, const char *,
86 va_list, int) ATTRIBUTE_PRINTF (2, 0);
88 static void fputs_maybe_filtered (const char *, struct ui_file
*, int);
90 static void prompt_for_continue (void);
92 static void set_screen_size (void);
93 static void set_width (void);
95 /* Time spent in prompt_for_continue in the currently executing command
96 waiting for user to respond.
97 Initialized in make_command_stats_cleanup.
98 Modified in prompt_for_continue and defaulted_query.
99 Used in report_command_stats. */
101 static struct timeval prompt_for_continue_wait_time
;
103 /* A flag indicating whether to timestamp debugging messages. */
105 static int debug_timestamp
= 0;
107 /* Nonzero if we have job control. */
111 /* Nonzero means that strings with character values >0x7F should be printed
112 as octal escapes. Zero means just print the value (e.g. it's an
113 international character, and the terminal or window can cope.) */
115 int sevenbit_strings
= 0;
117 show_sevenbit_strings (struct ui_file
*file
, int from_tty
,
118 struct cmd_list_element
*c
, const char *value
)
120 fprintf_filtered (file
, _("Printing of 8-bit characters "
121 "in strings as \\nnn is %s.\n"),
125 /* String to be printed before warning messages, if any. */
127 char *warning_pre_print
= "\nwarning: ";
129 int pagination_enabled
= 1;
131 show_pagination_enabled (struct ui_file
*file
, int from_tty
,
132 struct cmd_list_element
*c
, const char *value
)
134 fprintf_filtered (file
, _("State of pagination is %s.\n"), value
);
138 /* Cleanup utilities.
140 These are not defined in cleanups.c (nor declared in cleanups.h)
141 because while they use the "cleanup API" they are not part of the
145 do_freeargv (void *arg
)
147 freeargv ((char **) arg
);
151 make_cleanup_freeargv (char **arg
)
153 return make_cleanup (do_freeargv
, arg
);
157 do_bfd_close_cleanup (void *arg
)
159 gdb_bfd_unref ((bfd
*) arg
);
163 make_cleanup_bfd_unref (bfd
*abfd
)
165 return make_cleanup (do_bfd_close_cleanup
, abfd
);
168 /* Helper function which does the work for make_cleanup_fclose. */
171 do_fclose_cleanup (void *arg
)
173 FILE *file
= (FILE *) arg
;
178 /* Return a new cleanup that closes FILE. */
181 make_cleanup_fclose (FILE *file
)
183 return make_cleanup (do_fclose_cleanup
, file
);
186 /* Helper function which does the work for make_cleanup_obstack_free. */
189 do_obstack_free (void *arg
)
191 struct obstack
*ob
= (struct obstack
*) arg
;
193 obstack_free (ob
, NULL
);
196 /* Return a new cleanup that frees OBSTACK. */
199 make_cleanup_obstack_free (struct obstack
*obstack
)
201 return make_cleanup (do_obstack_free
, obstack
);
205 do_ui_file_delete (void *arg
)
207 ui_file_delete ((struct ui_file
*) arg
);
211 make_cleanup_ui_file_delete (struct ui_file
*arg
)
213 return make_cleanup (do_ui_file_delete
, arg
);
216 /* Helper function for make_cleanup_ui_out_redirect_pop. */
219 do_ui_out_redirect_pop (void *arg
)
221 struct ui_out
*uiout
= (struct ui_out
*) arg
;
223 if (ui_out_redirect (uiout
, NULL
) < 0)
224 warning (_("Cannot restore redirection of the current output protocol"));
227 /* Return a new cleanup that pops the last redirection by ui_out_redirect
228 with NULL parameter. */
231 make_cleanup_ui_out_redirect_pop (struct ui_out
*uiout
)
233 return make_cleanup (do_ui_out_redirect_pop
, uiout
);
237 do_free_section_addr_info (void *arg
)
239 free_section_addr_info ((struct section_addr_info
*) arg
);
243 make_cleanup_free_section_addr_info (struct section_addr_info
*addrs
)
245 return make_cleanup (do_free_section_addr_info
, addrs
);
248 struct restore_integer_closure
255 restore_integer (void *p
)
257 struct restore_integer_closure
*closure
258 = (struct restore_integer_closure
*) p
;
260 *(closure
->variable
) = closure
->value
;
263 /* Remember the current value of *VARIABLE and make it restored when
264 the cleanup is run. */
267 make_cleanup_restore_integer (int *variable
)
269 struct restore_integer_closure
*c
= XNEW (struct restore_integer_closure
);
271 c
->variable
= variable
;
272 c
->value
= *variable
;
274 return make_cleanup_dtor (restore_integer
, (void *) c
, xfree
);
277 /* Remember the current value of *VARIABLE and make it restored when
278 the cleanup is run. */
281 make_cleanup_restore_uinteger (unsigned int *variable
)
283 return make_cleanup_restore_integer ((int *) variable
);
286 /* Helper for make_cleanup_unpush_target. */
289 do_unpush_target (void *arg
)
291 struct target_ops
*ops
= (struct target_ops
*) arg
;
296 /* Return a new cleanup that unpushes OPS. */
299 make_cleanup_unpush_target (struct target_ops
*ops
)
301 return make_cleanup (do_unpush_target
, ops
);
304 /* Helper for make_cleanup_htab_delete compile time checking the types. */
307 do_htab_delete_cleanup (void *htab_voidp
)
309 htab_t htab
= (htab_t
) htab_voidp
;
314 /* Return a new cleanup that deletes HTAB. */
317 make_cleanup_htab_delete (htab_t htab
)
319 return make_cleanup (do_htab_delete_cleanup
, htab
);
322 /* Helper for make_cleanup_value_free_to_mark. */
325 do_value_free_to_mark (void *value
)
327 value_free_to_mark ((struct value
*) value
);
330 /* Free all values allocated since MARK was obtained by value_mark
331 (except for those released) when the cleanup is run. */
334 make_cleanup_value_free_to_mark (struct value
*mark
)
336 return make_cleanup (do_value_free_to_mark
, mark
);
339 /* Helper for make_cleanup_value_free. */
342 do_value_free (void *value
)
344 value_free ((struct value
*) value
);
350 make_cleanup_value_free (struct value
*value
)
352 return make_cleanup (do_value_free
, value
);
355 /* Helper for make_cleanup_free_so. */
358 do_free_so (void *arg
)
360 struct so_list
*so
= (struct so_list
*) arg
;
365 /* Make cleanup handler calling free_so for SO. */
368 make_cleanup_free_so (struct so_list
*so
)
370 return make_cleanup (do_free_so
, so
);
373 /* Helper for make_cleanup_restore_current_language. */
376 do_restore_current_language (void *p
)
378 enum language saved_lang
= (enum language
) (uintptr_t) p
;
380 set_language (saved_lang
);
383 /* Remember the current value of CURRENT_LANGUAGE and make it restored when
384 the cleanup is run. */
387 make_cleanup_restore_current_language (void)
389 enum language saved_lang
= current_language
->la_language
;
391 return make_cleanup (do_restore_current_language
,
392 (void *) (uintptr_t) saved_lang
);
395 /* Helper function for make_cleanup_clear_parser_state. */
398 do_clear_parser_state (void *ptr
)
400 struct parser_state
**p
= (struct parser_state
**) ptr
;
405 /* Clean (i.e., set to NULL) the parser state variable P. */
408 make_cleanup_clear_parser_state (struct parser_state
**p
)
410 return make_cleanup (do_clear_parser_state
, (void *) p
);
413 /* This function is useful for cleanups.
417 old_chain = make_cleanup (free_current_contents, &foo);
419 to arrange to free the object thus allocated. */
422 free_current_contents (void *ptr
)
424 void **location
= (void **) ptr
;
426 if (location
== NULL
)
427 internal_error (__FILE__
, __LINE__
,
428 _("free_current_contents: NULL pointer"));
429 if (*location
!= NULL
)
438 /* Print a warning message. The first argument STRING is the warning
439 message, used as an fprintf format string, the second is the
440 va_list of arguments for that string. A warning is unfiltered (not
441 paginated) so that the user does not need to page through each
442 screen full of warnings when there are lots of them. */
445 vwarning (const char *string
, va_list args
)
447 if (deprecated_warning_hook
)
448 (*deprecated_warning_hook
) (string
, args
);
451 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
453 if (target_supports_terminal_ours ())
455 make_cleanup_restore_target_terminal ();
456 target_terminal_ours_for_output ();
458 if (filtered_printing_initialized ())
459 wrap_here (""); /* Force out any buffered output. */
460 gdb_flush (gdb_stdout
);
461 if (warning_pre_print
)
462 fputs_unfiltered (warning_pre_print
, gdb_stderr
);
463 vfprintf_unfiltered (gdb_stderr
, string
, args
);
464 fprintf_unfiltered (gdb_stderr
, "\n");
466 do_cleanups (old_chain
);
470 /* Print an error message and return to command level.
471 The first argument STRING is the error message, used as a fprintf string,
472 and the remaining args are passed as arguments to it. */
475 verror (const char *string
, va_list args
)
477 throw_verror (GENERIC_ERROR
, string
, args
);
481 error_stream (struct ui_file
*stream
)
483 std::string message
= ui_file_as_string (stream
);
485 error (("%s"), message
.c_str ());
488 /* Emit a message and abort. */
490 static void ATTRIBUTE_NORETURN
491 abort_with_message (const char *msg
)
493 if (gdb_stderr
== NULL
)
496 fputs_unfiltered (msg
, gdb_stderr
);
498 abort (); /* NOTE: GDB has only three calls to abort(). */
501 /* Dump core trying to increase the core soft limit to hard limit first. */
506 #ifdef HAVE_SETRLIMIT
507 struct rlimit rlim
= { RLIM_INFINITY
, RLIM_INFINITY
};
509 setrlimit (RLIMIT_CORE
, &rlim
);
510 #endif /* HAVE_SETRLIMIT */
512 abort (); /* NOTE: GDB has only three calls to abort(). */
515 /* Check whether GDB will be able to dump core using the dump_core
516 function. Returns zero if GDB cannot or should not dump core.
517 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
518 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
521 can_dump_core (enum resource_limit_kind limit_kind
)
523 #ifdef HAVE_GETRLIMIT
526 /* Be quiet and assume we can dump if an error is returned. */
527 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
533 if (rlim
.rlim_cur
== 0)
537 if (rlim
.rlim_max
== 0)
540 #endif /* HAVE_GETRLIMIT */
545 /* Print a warning that we cannot dump core. */
548 warn_cant_dump_core (const char *reason
)
550 fprintf_unfiltered (gdb_stderr
,
551 _("%s\nUnable to dump core, use `ulimit -c"
552 " unlimited' before executing GDB next time.\n"),
556 /* Check whether GDB will be able to dump core using the dump_core
557 function, and print a warning if we cannot. */
560 can_dump_core_warn (enum resource_limit_kind limit_kind
,
563 int core_dump_allowed
= can_dump_core (limit_kind
);
565 if (!core_dump_allowed
)
566 warn_cant_dump_core (reason
);
568 return core_dump_allowed
;
571 /* Allow the user to configure the debugger behavior with respect to
572 what to do when an internal problem is detected. */
574 const char internal_problem_ask
[] = "ask";
575 const char internal_problem_yes
[] = "yes";
576 const char internal_problem_no
[] = "no";
577 static const char *const internal_problem_modes
[] =
579 internal_problem_ask
,
580 internal_problem_yes
,
585 /* Print a message reporting an internal error/warning. Ask the user
586 if they want to continue, dump core, or just exit. Return
587 something to indicate a quit. */
589 struct internal_problem
592 int user_settable_should_quit
;
593 const char *should_quit
;
594 int user_settable_should_dump_core
;
595 const char *should_dump_core
;
598 /* Report a problem, internal to GDB, to the user. Once the problem
599 has been reported, and assuming GDB didn't quit, the caller can
600 either allow execution to resume or throw an error. */
602 static void ATTRIBUTE_PRINTF (4, 0)
603 internal_vproblem (struct internal_problem
*problem
,
604 const char *file
, int line
, const char *fmt
, va_list ap
)
610 struct cleanup
*cleanup
= make_cleanup (null_cleanup
, NULL
);
612 /* Don't allow infinite error/warning recursion. */
614 static char msg
[] = "Recursive internal problem.\n";
623 abort_with_message (msg
);
626 /* Newer GLIBC versions put the warn_unused_result attribute
627 on write, but this is one of those rare cases where
628 ignoring the return value is correct. Casting to (void)
629 does not fix this problem. This is the solution suggested
630 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
631 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
632 abort (); /* NOTE: GDB has only three calls to abort(). */
637 /* Create a string containing the full error/warning message. Need
638 to call query with this full string, as otherwize the reason
639 (error/warning) and question become separated. Format using a
640 style similar to a compiler error message. Include extra detail
641 so that the user knows that they are living on the edge. */
645 msg
= xstrvprintf (fmt
, ap
);
646 reason
= xstrprintf ("%s:%d: %s: %s\n"
647 "A problem internal to GDB has been detected,\n"
648 "further debugging may prove unreliable.",
649 file
, line
, problem
->name
, msg
);
651 make_cleanup (xfree
, reason
);
654 /* Fall back to abort_with_message if gdb_stderr is not set up. */
655 if (gdb_stderr
== NULL
)
657 fputs (reason
, stderr
);
658 abort_with_message ("\n");
661 /* Try to get the message out and at the start of a new line. */
662 if (target_supports_terminal_ours ())
664 make_cleanup_restore_target_terminal ();
665 target_terminal_ours_for_output ();
667 if (filtered_printing_initialized ())
670 /* Emit the message unless query will emit it below. */
671 if (problem
->should_quit
!= internal_problem_ask
673 || !filtered_printing_initialized ())
674 fprintf_unfiltered (gdb_stderr
, "%s\n", reason
);
676 if (problem
->should_quit
== internal_problem_ask
)
678 /* Default (yes/batch case) is to quit GDB. When in batch mode
679 this lessens the likelihood of GDB going into an infinite
681 if (!confirm
|| !filtered_printing_initialized ())
684 quit_p
= query (_("%s\nQuit this debugging session? "), reason
);
686 else if (problem
->should_quit
== internal_problem_yes
)
688 else if (problem
->should_quit
== internal_problem_no
)
691 internal_error (__FILE__
, __LINE__
, _("bad switch"));
693 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr
);
694 if (REPORT_BUGS_TO
[0])
695 fprintf_unfiltered (gdb_stderr
, _(" For instructions, see:\n%s."),
697 fputs_unfiltered ("\n\n", gdb_stderr
);
699 if (problem
->should_dump_core
== internal_problem_ask
)
701 if (!can_dump_core_warn (LIMIT_MAX
, reason
))
703 else if (!filtered_printing_initialized ())
707 /* Default (yes/batch case) is to dump core. This leaves a GDB
708 `dropping' so that it is easier to see that something went
710 dump_core_p
= query (_("%s\nCreate a core file of GDB? "), reason
);
713 else if (problem
->should_dump_core
== internal_problem_yes
)
714 dump_core_p
= can_dump_core_warn (LIMIT_MAX
, reason
);
715 else if (problem
->should_dump_core
== internal_problem_no
)
718 internal_error (__FILE__
, __LINE__
, _("bad switch"));
731 #ifdef HAVE_WORKING_FORK
739 do_cleanups (cleanup
);
742 static struct internal_problem internal_error_problem
= {
743 "internal-error", 1, internal_problem_ask
, 1, internal_problem_ask
747 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
749 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
750 throw_quit (_("Command aborted."));
753 static struct internal_problem internal_warning_problem
= {
754 "internal-warning", 1, internal_problem_ask
, 1, internal_problem_ask
758 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
760 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
763 static struct internal_problem demangler_warning_problem
= {
764 "demangler-warning", 1, internal_problem_ask
, 0, internal_problem_no
768 demangler_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
770 internal_vproblem (&demangler_warning_problem
, file
, line
, fmt
, ap
);
774 demangler_warning (const char *file
, int line
, const char *string
, ...)
778 va_start (ap
, string
);
779 demangler_vwarning (file
, line
, string
, ap
);
783 /* Dummy functions to keep add_prefix_cmd happy. */
786 set_internal_problem_cmd (char *args
, int from_tty
)
791 show_internal_problem_cmd (char *args
, int from_tty
)
795 /* When GDB reports an internal problem (error or warning) it gives
796 the user the opportunity to quit GDB and/or create a core file of
797 the current debug session. This function registers a few commands
798 that make it possible to specify that GDB should always or never
799 quit or create a core file, without asking. The commands look
802 maint set PROBLEM-NAME quit ask|yes|no
803 maint show PROBLEM-NAME quit
804 maint set PROBLEM-NAME corefile ask|yes|no
805 maint show PROBLEM-NAME corefile
807 Where PROBLEM-NAME is currently "internal-error" or
808 "internal-warning". */
811 add_internal_problem_command (struct internal_problem
*problem
)
813 struct cmd_list_element
**set_cmd_list
;
814 struct cmd_list_element
**show_cmd_list
;
818 set_cmd_list
= XNEW (struct cmd_list_element
*);
819 show_cmd_list
= XNEW (struct cmd_list_element
*);
820 *set_cmd_list
= NULL
;
821 *show_cmd_list
= NULL
;
823 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
826 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
829 add_prefix_cmd ((char*) problem
->name
,
830 class_maintenance
, set_internal_problem_cmd
, set_doc
,
832 concat ("maintenance set ", problem
->name
, " ",
834 0/*allow-unknown*/, &maintenance_set_cmdlist
);
836 add_prefix_cmd ((char*) problem
->name
,
837 class_maintenance
, show_internal_problem_cmd
, show_doc
,
839 concat ("maintenance show ", problem
->name
, " ",
841 0/*allow-unknown*/, &maintenance_show_cmdlist
);
843 if (problem
->user_settable_should_quit
)
845 set_doc
= xstrprintf (_("Set whether GDB should quit "
846 "when an %s is detected"),
848 show_doc
= xstrprintf (_("Show whether GDB will quit "
849 "when an %s is detected"),
851 add_setshow_enum_cmd ("quit", class_maintenance
,
852 internal_problem_modes
,
853 &problem
->should_quit
,
866 if (problem
->user_settable_should_dump_core
)
868 set_doc
= xstrprintf (_("Set whether GDB should create a core "
869 "file of GDB when %s is detected"),
871 show_doc
= xstrprintf (_("Show whether GDB will create a core "
872 "file of GDB when %s is detected"),
874 add_setshow_enum_cmd ("corefile", class_maintenance
,
875 internal_problem_modes
,
876 &problem
->should_dump_core
,
890 /* Return a newly allocated string, containing the PREFIX followed
891 by the system error message for errno (separated by a colon).
893 The result must be deallocated after use. */
896 perror_string (const char *prefix
)
901 err
= safe_strerror (errno
);
902 combined
= (char *) xmalloc (strlen (err
) + strlen (prefix
) + 3);
903 strcpy (combined
, prefix
);
904 strcat (combined
, ": ");
905 strcat (combined
, err
);
910 /* Print the system error message for errno, and also mention STRING
911 as the file name for which the error was encountered. Use ERRCODE
912 for the thrown exception. Then return to command level. */
915 throw_perror_with_name (enum errors errcode
, const char *string
)
919 combined
= perror_string (string
);
920 make_cleanup (xfree
, combined
);
922 /* I understand setting these is a matter of taste. Still, some people
923 may clear errno but not know about bfd_error. Doing this here is not
925 bfd_set_error (bfd_error_no_error
);
928 throw_error (errcode
, _("%s."), combined
);
931 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
934 perror_with_name (const char *string
)
936 throw_perror_with_name (GENERIC_ERROR
, string
);
939 /* Same as perror_with_name except that it prints a warning instead
940 of throwing an error. */
943 perror_warning_with_name (const char *string
)
947 combined
= perror_string (string
);
948 warning (_("%s"), combined
);
952 /* Print the system error message for ERRCODE, and also mention STRING
953 as the file name for which the error was encountered. */
956 print_sys_errmsg (const char *string
, int errcode
)
961 err
= safe_strerror (errcode
);
962 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
963 strcpy (combined
, string
);
964 strcat (combined
, ": ");
965 strcat (combined
, err
);
967 /* We want anything which was printed on stdout to come out first, before
969 gdb_flush (gdb_stdout
);
970 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
973 /* Control C eventually causes this to be called, at a convenient time. */
978 struct ui
*ui
= current_ui
;
980 if (sync_quit_force_run
)
982 sync_quit_force_run
= 0;
983 quit_force (NULL
, 0);
987 /* No steenking SIGINT will ever be coming our way when the
988 program is resumed. Don't lie. */
992 /* If there is no terminal switching for this target, then we can't
993 possibly get screwed by the lack of job control. */
994 || !target_supports_terminal_ours ())
997 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
1006 if (sync_quit_force_run
)
1011 if (deprecated_interactive_hook
)
1012 deprecated_interactive_hook ();
1016 /* Called when a memory allocation fails, with the number of bytes of
1017 memory requested in SIZE. */
1020 malloc_failure (long size
)
1024 internal_error (__FILE__
, __LINE__
,
1025 _("virtual memory exhausted: can't allocate %ld bytes."),
1030 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
1034 /* My replacement for the read system call.
1035 Used like `read' but keeps going if `read' returns too soon. */
1038 myread (int desc
, char *addr
, int len
)
1045 val
= read (desc
, addr
, len
);
1049 return orglen
- len
;
1057 print_spaces (int n
, struct ui_file
*file
)
1059 fputs_unfiltered (n_spaces (n
), file
);
1062 /* Print a host address. */
1065 gdb_print_host_address_1 (const void *addr
, struct ui_file
*stream
)
1067 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
1073 make_hex_string (const gdb_byte
*data
, size_t length
)
1075 char *result
= (char *) xmalloc (length
* 2 + 1);
1080 for (i
= 0; i
< length
; ++i
)
1081 p
+= xsnprintf (p
, 3, "%02x", data
[i
]);
1088 /* A cleanup function that calls regfree. */
1091 do_regfree_cleanup (void *r
)
1093 regfree ((regex_t
*) r
);
1096 /* Create a new cleanup that frees the compiled regular expression R. */
1099 make_regfree_cleanup (regex_t
*r
)
1101 return make_cleanup (do_regfree_cleanup
, r
);
1104 /* Return an xmalloc'd error message resulting from a regular
1105 expression compilation failure. */
1108 get_regcomp_error (int code
, regex_t
*rx
)
1110 size_t length
= regerror (code
, rx
, NULL
, 0);
1111 char *result
= (char *) xmalloc (length
);
1113 regerror (code
, rx
, result
, length
);
1117 /* Compile a regexp and throw an exception on error. This returns a
1118 cleanup to free the resulting pattern on success. RX must not be
1122 compile_rx_or_error (regex_t
*pattern
, const char *rx
, const char *message
)
1126 gdb_assert (rx
!= NULL
);
1128 code
= regcomp (pattern
, rx
, REG_NOSUB
);
1131 char *err
= get_regcomp_error (code
, pattern
);
1133 make_cleanup (xfree
, err
);
1134 error (("%s: %s"), message
, err
);
1137 return make_regfree_cleanup (pattern
);
1140 /* A cleanup that simply calls ui_unregister_input_event_handler. */
1143 ui_unregister_input_event_handler_cleanup (void *ui
)
1145 ui_unregister_input_event_handler ((struct ui
*) ui
);
1148 /* Set up to handle input. */
1150 static struct cleanup
*
1151 prepare_to_handle_input (void)
1153 struct cleanup
*old_chain
;
1155 old_chain
= make_cleanup_restore_target_terminal ();
1156 target_terminal_ours ();
1158 ui_register_input_event_handler (current_ui
);
1159 if (current_ui
->prompt_state
== PROMPT_BLOCKED
)
1160 make_cleanup (ui_unregister_input_event_handler_cleanup
, current_ui
);
1162 make_cleanup_override_quit_handler (default_quit_handler
);
1169 /* This function supports the query, nquery, and yquery functions.
1170 Ask user a y-or-n question and return 0 if answer is no, 1 if
1171 answer is yes, or default the answer to the specified default
1172 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1173 default answer, or '\0' for no default.
1174 CTLSTR is the control string and should end in "? ". It should
1175 not say how to answer, because we do that.
1176 ARGS are the arguments passed along with the CTLSTR argument to
1179 static int ATTRIBUTE_PRINTF (1, 0)
1180 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
1185 char def_answer
, not_def_answer
;
1186 char *y_string
, *n_string
, *question
, *prompt
;
1187 /* Used to add duration we waited for user to respond to
1188 prompt_for_continue_wait_time. */
1189 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1190 struct cleanup
*old_chain
;
1192 /* Set up according to which answer is the default. */
1193 if (defchar
== '\0')
1197 not_def_answer
= 'N';
1201 else if (defchar
== 'y')
1205 not_def_answer
= 'N';
1213 not_def_answer
= 'Y';
1218 /* Automatically answer the default value if the user did not want
1219 prompts or the command was issued with the server prefix. */
1220 if (!confirm
|| server_command
)
1223 /* If input isn't coming from the user directly, just say what
1224 question we're asking, and then answer the default automatically. This
1225 way, important error messages don't get lost when talking to GDB
1227 if (current_ui
->instream
!= current_ui
->stdin_stream
1228 || !input_interactive_p (current_ui
))
1230 old_chain
= make_cleanup_restore_target_terminal ();
1232 target_terminal_ours_for_output ();
1234 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
1236 printf_filtered (_("(%s or %s) [answered %c; "
1237 "input not from terminal]\n"),
1238 y_string
, n_string
, def_answer
);
1239 gdb_flush (gdb_stdout
);
1241 do_cleanups (old_chain
);
1245 if (deprecated_query_hook
)
1249 old_chain
= make_cleanup_restore_target_terminal ();
1250 res
= deprecated_query_hook (ctlstr
, args
);
1251 do_cleanups (old_chain
);
1255 /* Format the question outside of the loop, to avoid reusing args. */
1256 question
= xstrvprintf (ctlstr
, args
);
1257 old_chain
= make_cleanup (xfree
, question
);
1258 prompt
= xstrprintf (_("%s%s(%s or %s) %s"),
1259 annotation_level
> 1 ? "\n\032\032pre-query\n" : "",
1260 question
, y_string
, n_string
,
1261 annotation_level
> 1 ? "\n\032\032query\n" : "");
1262 make_cleanup (xfree
, prompt
);
1264 /* Used for calculating time spend waiting for user. */
1265 gettimeofday (&prompt_started
, NULL
);
1267 prepare_to_handle_input ();
1271 char *response
, answer
;
1273 gdb_flush (gdb_stdout
);
1274 response
= gdb_readline_wrapper (prompt
);
1276 if (response
== NULL
) /* C-d */
1278 printf_filtered ("EOF [assumed %c]\n", def_answer
);
1283 answer
= response
[0];
1288 /* Check answer. For the non-default, the user must specify
1289 the non-default explicitly. */
1290 if (answer
== not_def_answer
)
1292 retval
= !def_value
;
1295 /* Otherwise, if a default was specified, the user may either
1296 specify the required input or have it default by entering
1298 if (answer
== def_answer
1299 || (defchar
!= '\0' && answer
== '\0'))
1304 /* Invalid entries are not defaulted and require another selection. */
1305 printf_filtered (_("Please answer %s or %s.\n"),
1306 y_string
, n_string
);
1309 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1310 gettimeofday (&prompt_ended
, NULL
);
1311 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1312 timeval_add (&prompt_for_continue_wait_time
,
1313 &prompt_for_continue_wait_time
, &prompt_delta
);
1315 if (annotation_level
> 1)
1316 printf_filtered (("\n\032\032post-query\n"));
1317 do_cleanups (old_chain
);
1322 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1323 answer is yes, or 0 if answer is defaulted.
1324 Takes three args which are given to printf to print the question.
1325 The first, a control string, should end in "? ".
1326 It should not say how to answer, because we do that. */
1329 nquery (const char *ctlstr
, ...)
1334 va_start (args
, ctlstr
);
1335 ret
= defaulted_query (ctlstr
, 'n', args
);
1340 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1341 answer is yes, or 1 if answer is defaulted.
1342 Takes three args which are given to printf to print the question.
1343 The first, a control string, should end in "? ".
1344 It should not say how to answer, because we do that. */
1347 yquery (const char *ctlstr
, ...)
1352 va_start (args
, ctlstr
);
1353 ret
= defaulted_query (ctlstr
, 'y', args
);
1358 /* Ask user a y-or-n question and return 1 iff answer is yes.
1359 Takes three args which are given to printf to print the question.
1360 The first, a control string, should end in "? ".
1361 It should not say how to answer, because we do that. */
1364 query (const char *ctlstr
, ...)
1369 va_start (args
, ctlstr
);
1370 ret
= defaulted_query (ctlstr
, '\0', args
);
1375 /* A helper for parse_escape that converts a host character to a
1376 target character. C is the host character. If conversion is
1377 possible, then the target character is stored in *TARGET_C and the
1378 function returns 1. Otherwise, the function returns 0. */
1381 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1383 struct obstack host_data
;
1385 struct cleanup
*cleanups
;
1388 obstack_init (&host_data
);
1389 cleanups
= make_cleanup_obstack_free (&host_data
);
1391 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1392 (gdb_byte
*) &the_char
, 1, 1,
1393 &host_data
, translit_none
);
1395 if (obstack_object_size (&host_data
) == 1)
1398 *target_c
= *(char *) obstack_base (&host_data
);
1401 do_cleanups (cleanups
);
1405 /* Parse a C escape sequence. STRING_PTR points to a variable
1406 containing a pointer to the string to parse. That pointer
1407 should point to the character after the \. That pointer
1408 is updated past the characters we use. The value of the
1409 escape sequence is returned.
1411 A negative value means the sequence \ newline was seen,
1412 which is supposed to be equivalent to nothing at all.
1414 If \ is followed by a null character, we return a negative
1415 value and leave the string pointer pointing at the null character.
1417 If \ is followed by 000, we return 0 and leave the string pointer
1418 after the zeros. A value of 0 does not mean end of string. */
1421 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1423 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1424 int c
= *(*string_ptr
)++;
1443 int i
= host_hex_value (c
);
1448 if (isdigit (c
) && c
!= '8' && c
!= '9')
1452 i
+= host_hex_value (c
);
1488 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1489 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1490 " which has no equivalent\nin the `%s' character set."),
1491 c
, c
, target_charset (gdbarch
));
1495 /* Print the character C on STREAM as part of the contents of a literal
1496 string whose delimiter is QUOTER. Note that this routine should only
1497 be called for printing things which are independent of the language
1498 of the program being debugged.
1500 printchar will normally escape backslashes and instances of QUOTER. If
1501 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1502 As a side effect, if you pass the backslash character as the QUOTER,
1503 printchar will escape backslashes as usual, but not any other quoting
1507 printchar (int c
, void (*do_fputs
) (const char *, struct ui_file
*),
1508 void (*do_fprintf
) (struct ui_file
*, const char *, ...)
1509 ATTRIBUTE_FPTR_PRINTF_2
, struct ui_file
*stream
, int quoter
)
1511 c
&= 0xFF; /* Avoid sign bit follies */
1513 if (c
< 0x20 || /* Low control chars */
1514 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1515 (sevenbit_strings
&& c
>= 0x80))
1516 { /* high order bit set */
1520 do_fputs ("\\n", stream
);
1523 do_fputs ("\\b", stream
);
1526 do_fputs ("\\t", stream
);
1529 do_fputs ("\\f", stream
);
1532 do_fputs ("\\r", stream
);
1535 do_fputs ("\\e", stream
);
1538 do_fputs ("\\a", stream
);
1541 do_fprintf (stream
, "\\%.3o", (unsigned int) c
);
1547 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1548 do_fputs ("\\", stream
);
1549 do_fprintf (stream
, "%c", c
);
1553 /* Print the character C on STREAM as part of the contents of a
1554 literal string whose delimiter is QUOTER. Note that these routines
1555 should only be call for printing things which are independent of
1556 the language of the program being debugged. */
1559 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1562 printchar (*str
++, fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1566 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1569 printchar (*str
++, fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1573 fputstrn_filtered (const char *str
, int n
, int quoter
,
1574 struct ui_file
*stream
)
1578 for (i
= 0; i
< n
; i
++)
1579 printchar (str
[i
], fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1583 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1584 struct ui_file
*stream
)
1588 for (i
= 0; i
< n
; i
++)
1589 printchar (str
[i
], fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1593 /* Number of lines per page or UINT_MAX if paging is disabled. */
1594 static unsigned int lines_per_page
;
1596 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1597 struct cmd_list_element
*c
, const char *value
)
1599 fprintf_filtered (file
,
1600 _("Number of lines gdb thinks are in a page is %s.\n"),
1604 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1605 static unsigned int chars_per_line
;
1607 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1608 struct cmd_list_element
*c
, const char *value
)
1610 fprintf_filtered (file
,
1611 _("Number of characters gdb thinks "
1612 "are in a line is %s.\n"),
1616 /* Current count of lines printed on this page, chars on this line. */
1617 static unsigned int lines_printed
, chars_printed
;
1619 /* Buffer and start column of buffered text, for doing smarter word-
1620 wrapping. When someone calls wrap_here(), we start buffering output
1621 that comes through fputs_filtered(). If we see a newline, we just
1622 spit it out and forget about the wrap_here(). If we see another
1623 wrap_here(), we spit it out and remember the newer one. If we see
1624 the end of the line, we spit out a newline, the indent, and then
1625 the buffered output. */
1627 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1628 are waiting to be output (they have already been counted in chars_printed).
1629 When wrap_buffer[0] is null, the buffer is empty. */
1630 static char *wrap_buffer
;
1632 /* Pointer in wrap_buffer to the next character to fill. */
1633 static char *wrap_pointer
;
1635 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1637 static char *wrap_indent
;
1639 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1640 is not in effect. */
1641 static int wrap_column
;
1644 /* Initialize the number of lines per page and chars per line. */
1647 init_page_info (void)
1651 lines_per_page
= UINT_MAX
;
1652 chars_per_line
= UINT_MAX
;
1656 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1661 #if defined(__GO32__)
1662 rows
= ScreenRows ();
1663 cols
= ScreenCols ();
1664 lines_per_page
= rows
;
1665 chars_per_line
= cols
;
1667 /* Make sure Readline has initialized its terminal settings. */
1668 rl_reset_terminal (NULL
);
1670 /* Get the screen size from Readline. */
1671 rl_get_screen_size (&rows
, &cols
);
1672 lines_per_page
= rows
;
1673 chars_per_line
= cols
;
1675 /* Readline should have fetched the termcap entry for us.
1676 Only try to use tgetnum function if rl_get_screen_size
1677 did not return a useful value. */
1678 if (((rows
<= 0) && (tgetnum ("li") < 0))
1679 /* Also disable paging if inside Emacs. $EMACS was used
1680 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1681 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1683 /* The number of lines per page is not mentioned in the terminal
1684 description or EMACS evironment variable is set. This probably
1685 means that paging is not useful, so disable paging. */
1686 lines_per_page
= UINT_MAX
;
1689 /* If the output is not a terminal, don't paginate it. */
1690 if (!ui_file_isatty (gdb_stdout
))
1691 lines_per_page
= UINT_MAX
;
1695 /* We handle SIGWINCH ourselves. */
1696 rl_catch_sigwinch
= 0;
1702 /* Return nonzero if filtered printing is initialized. */
1704 filtered_printing_initialized (void)
1706 return wrap_buffer
!= NULL
;
1709 /* Helper for make_cleanup_restore_page_info. */
1712 do_restore_page_info_cleanup (void *arg
)
1718 /* Provide cleanup for restoring the terminal size. */
1721 make_cleanup_restore_page_info (void)
1723 struct cleanup
*back_to
;
1725 back_to
= make_cleanup (do_restore_page_info_cleanup
, NULL
);
1726 make_cleanup_restore_uinteger (&lines_per_page
);
1727 make_cleanup_restore_uinteger (&chars_per_line
);
1732 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1733 Provide cleanup for restoring the original state. */
1736 set_batch_flag_and_make_cleanup_restore_page_info (void)
1738 struct cleanup
*back_to
= make_cleanup_restore_page_info ();
1740 make_cleanup_restore_integer (&batch_flag
);
1747 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1750 set_screen_size (void)
1752 int rows
= lines_per_page
;
1753 int cols
= chars_per_line
;
1761 /* Update Readline's idea of the terminal size. */
1762 rl_set_screen_size (rows
, cols
);
1765 /* Reinitialize WRAP_BUFFER according to the current value of
1771 if (chars_per_line
== 0)
1776 wrap_buffer
= (char *) xmalloc (chars_per_line
+ 2);
1777 wrap_buffer
[0] = '\0';
1780 wrap_buffer
= (char *) xrealloc (wrap_buffer
, chars_per_line
+ 2);
1781 wrap_pointer
= wrap_buffer
; /* Start it at the beginning. */
1785 set_width_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1792 set_height_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1800 set_screen_width_and_height (int width
, int height
)
1802 lines_per_page
= height
;
1803 chars_per_line
= width
;
1809 /* Wait, so the user can read what's on the screen. Prompt the user
1810 to continue by pressing RETURN. 'q' is also provided because
1811 telling users what to do in the prompt is more user-friendly than
1812 expecting them to think of Ctrl-C/SIGINT. */
1815 prompt_for_continue (void)
1818 char cont_prompt
[120];
1819 /* Used to add duration we waited for user to respond to
1820 prompt_for_continue_wait_time. */
1821 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1822 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
1824 gettimeofday (&prompt_started
, NULL
);
1826 if (annotation_level
> 1)
1827 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1829 strcpy (cont_prompt
,
1830 "---Type <return> to continue, or q <return> to quit---");
1831 if (annotation_level
> 1)
1832 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1834 /* We must do this *before* we call gdb_readline_wrapper, else it
1835 will eventually call us -- thinking that we're trying to print
1836 beyond the end of the screen. */
1837 reinitialize_more_filter ();
1839 prepare_to_handle_input ();
1841 /* Call gdb_readline_wrapper, not readline, in order to keep an
1842 event loop running. */
1843 ignore
= gdb_readline_wrapper (cont_prompt
);
1844 make_cleanup (xfree
, ignore
);
1846 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1847 gettimeofday (&prompt_ended
, NULL
);
1848 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1849 timeval_add (&prompt_for_continue_wait_time
,
1850 &prompt_for_continue_wait_time
, &prompt_delta
);
1852 if (annotation_level
> 1)
1853 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1859 while (*p
== ' ' || *p
== '\t')
1862 /* Do not call quit here; there is no possibility of SIGINT. */
1863 throw_quit ("Quit");
1866 /* Now we have to do this again, so that GDB will know that it doesn't
1867 need to save the ---Type <return>--- line at the top of the screen. */
1868 reinitialize_more_filter ();
1870 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1872 do_cleanups (old_chain
);
1875 /* Initialize timer to keep track of how long we waited for the user. */
1878 reset_prompt_for_continue_wait_time (void)
1880 static const struct timeval zero_timeval
= { 0 };
1882 prompt_for_continue_wait_time
= zero_timeval
;
1885 /* Fetch the cumulative time spent in prompt_for_continue. */
1888 get_prompt_for_continue_wait_time (void)
1890 return prompt_for_continue_wait_time
;
1893 /* Reinitialize filter; ie. tell it to reset to original values. */
1896 reinitialize_more_filter (void)
1902 /* Indicate that if the next sequence of characters overflows the line,
1903 a newline should be inserted here rather than when it hits the end.
1904 If INDENT is non-null, it is a string to be printed to indent the
1905 wrapped part on the next line. INDENT must remain accessible until
1906 the next call to wrap_here() or until a newline is printed through
1909 If the line is already overfull, we immediately print a newline and
1910 the indentation, and disable further wrapping.
1912 If we don't know the width of lines, but we know the page height,
1913 we must not wrap words, but should still keep track of newlines
1914 that were explicitly printed.
1916 INDENT should not contain tabs, as that will mess up the char count
1917 on the next line. FIXME.
1919 This routine is guaranteed to force out any output which has been
1920 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1921 used to force out output from the wrap_buffer. */
1924 wrap_here (char *indent
)
1926 /* This should have been allocated, but be paranoid anyway. */
1928 internal_error (__FILE__
, __LINE__
,
1929 _("failed internal consistency check"));
1933 *wrap_pointer
= '\0';
1934 fputs_unfiltered (wrap_buffer
, gdb_stdout
);
1936 wrap_pointer
= wrap_buffer
;
1937 wrap_buffer
[0] = '\0';
1938 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1942 else if (chars_printed
>= chars_per_line
)
1944 puts_filtered ("\n");
1946 puts_filtered (indent
);
1951 wrap_column
= chars_printed
;
1955 wrap_indent
= indent
;
1959 /* Print input string to gdb_stdout, filtered, with wrap,
1960 arranging strings in columns of n chars. String can be
1961 right or left justified in the column. Never prints
1962 trailing spaces. String should never be longer than
1963 width. FIXME: this could be useful for the EXAMINE
1964 command, which currently doesn't tabulate very well. */
1967 puts_filtered_tabular (char *string
, int width
, int right
)
1973 gdb_assert (chars_per_line
> 0);
1974 if (chars_per_line
== UINT_MAX
)
1976 fputs_filtered (string
, gdb_stdout
);
1977 fputs_filtered ("\n", gdb_stdout
);
1981 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1982 fputs_filtered ("\n", gdb_stdout
);
1984 if (width
>= chars_per_line
)
1985 width
= chars_per_line
- 1;
1987 stringlen
= strlen (string
);
1989 if (chars_printed
> 0)
1990 spaces
= width
- (chars_printed
- 1) % width
- 1;
1992 spaces
+= width
- stringlen
;
1994 spacebuf
= (char *) alloca (spaces
+ 1);
1995 spacebuf
[spaces
] = '\0';
1997 spacebuf
[spaces
] = ' ';
1999 fputs_filtered (spacebuf
, gdb_stdout
);
2000 fputs_filtered (string
, gdb_stdout
);
2004 /* Ensure that whatever gets printed next, using the filtered output
2005 commands, starts at the beginning of the line. I.e. if there is
2006 any pending output for the current line, flush it and start a new
2007 line. Otherwise do nothing. */
2012 if (chars_printed
> 0)
2014 puts_filtered ("\n");
2019 /* Like fputs but if FILTER is true, pause after every screenful.
2021 Regardless of FILTER can wrap at points other than the final
2022 character of a line.
2024 Unlike fputs, fputs_maybe_filtered does not return a value.
2025 It is OK for LINEBUFFER to be NULL, in which case just don't print
2028 Note that a longjmp to top level may occur in this routine (only if
2029 FILTER is true) (since prompt_for_continue may do so) so this
2030 routine should not be called when cleanups are not in place. */
2033 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
2036 const char *lineptr
;
2038 if (linebuffer
== 0)
2041 /* Don't do any filtering if it is disabled. */
2042 if (stream
!= gdb_stdout
2043 || !pagination_enabled
2045 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
2046 || top_level_interpreter () == NULL
2047 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2049 fputs_unfiltered (linebuffer
, stream
);
2053 /* Go through and output each character. Show line extension
2054 when this is necessary; prompt user for new page when this is
2057 lineptr
= linebuffer
;
2060 /* Possible new page. */
2061 if (filter
&& (lines_printed
>= lines_per_page
- 1))
2062 prompt_for_continue ();
2064 while (*lineptr
&& *lineptr
!= '\n')
2066 /* Print a single line. */
2067 if (*lineptr
== '\t')
2070 *wrap_pointer
++ = '\t';
2072 fputc_unfiltered ('\t', stream
);
2073 /* Shifting right by 3 produces the number of tab stops
2074 we have already passed, and then adding one and
2075 shifting left 3 advances to the next tab stop. */
2076 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
2082 *wrap_pointer
++ = *lineptr
;
2084 fputc_unfiltered (*lineptr
, stream
);
2089 if (chars_printed
>= chars_per_line
)
2091 unsigned int save_chars
= chars_printed
;
2095 /* If we aren't actually wrapping, don't output newline --
2096 if chars_per_line is right, we probably just overflowed
2097 anyway; if it's wrong, let us keep going. */
2099 fputc_unfiltered ('\n', stream
);
2101 /* Possible new page. */
2102 if (lines_printed
>= lines_per_page
- 1)
2103 prompt_for_continue ();
2105 /* Now output indentation and wrapped string. */
2108 fputs_unfiltered (wrap_indent
, stream
);
2109 *wrap_pointer
= '\0'; /* Null-terminate saved stuff, */
2110 fputs_unfiltered (wrap_buffer
, stream
); /* and eject it. */
2111 /* FIXME, this strlen is what prevents wrap_indent from
2112 containing tabs. However, if we recurse to print it
2113 and count its chars, we risk trouble if wrap_indent is
2114 longer than (the user settable) chars_per_line.
2115 Note also that this can set chars_printed > chars_per_line
2116 if we are printing a long string. */
2117 chars_printed
= strlen (wrap_indent
)
2118 + (save_chars
- wrap_column
);
2119 wrap_pointer
= wrap_buffer
; /* Reset buffer */
2120 wrap_buffer
[0] = '\0';
2121 wrap_column
= 0; /* And disable fancy wrap */
2126 if (*lineptr
== '\n')
2129 wrap_here ((char *) 0); /* Spit out chars, cancel
2132 fputc_unfiltered ('\n', stream
);
2139 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
2141 fputs_maybe_filtered (linebuffer
, stream
, 1);
2145 putchar_unfiltered (int c
)
2149 ui_file_write (gdb_stdout
, &buf
, 1);
2153 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2154 May return nonlocally. */
2157 putchar_filtered (int c
)
2159 return fputc_filtered (c
, gdb_stdout
);
2163 fputc_unfiltered (int c
, struct ui_file
*stream
)
2167 ui_file_write (stream
, &buf
, 1);
2172 fputc_filtered (int c
, struct ui_file
*stream
)
2178 fputs_filtered (buf
, stream
);
2182 /* puts_debug is like fputs_unfiltered, except it prints special
2183 characters in printable fashion. */
2186 puts_debug (char *prefix
, char *string
, char *suffix
)
2190 /* Print prefix and suffix after each line. */
2191 static int new_line
= 1;
2192 static int return_p
= 0;
2193 static char *prev_prefix
= "";
2194 static char *prev_suffix
= "";
2196 if (*string
== '\n')
2199 /* If the prefix is changing, print the previous suffix, a new line,
2200 and the new prefix. */
2201 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
2203 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
2204 fputs_unfiltered ("\n", gdb_stdlog
);
2205 fputs_unfiltered (prefix
, gdb_stdlog
);
2208 /* Print prefix if we printed a newline during the previous call. */
2212 fputs_unfiltered (prefix
, gdb_stdlog
);
2215 prev_prefix
= prefix
;
2216 prev_suffix
= suffix
;
2218 /* Output characters in a printable format. */
2219 while ((ch
= *string
++) != '\0')
2225 fputc_unfiltered (ch
, gdb_stdlog
);
2228 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2232 fputs_unfiltered ("\\\\", gdb_stdlog
);
2235 fputs_unfiltered ("\\b", gdb_stdlog
);
2238 fputs_unfiltered ("\\f", gdb_stdlog
);
2242 fputs_unfiltered ("\\n", gdb_stdlog
);
2245 fputs_unfiltered ("\\r", gdb_stdlog
);
2248 fputs_unfiltered ("\\t", gdb_stdlog
);
2251 fputs_unfiltered ("\\v", gdb_stdlog
);
2255 return_p
= ch
== '\r';
2258 /* Print suffix if we printed a newline. */
2261 fputs_unfiltered (suffix
, gdb_stdlog
);
2262 fputs_unfiltered ("\n", gdb_stdlog
);
2267 /* Print a variable number of ARGS using format FORMAT. If this
2268 information is going to put the amount written (since the last call
2269 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2270 call prompt_for_continue to get the users permision to continue.
2272 Unlike fprintf, this function does not return a value.
2274 We implement three variants, vfprintf (takes a vararg list and stream),
2275 fprintf (takes a stream to write on), and printf (the usual).
2277 Note also that a longjmp to top level may occur in this routine
2278 (since prompt_for_continue may do so) so this routine should not be
2279 called when cleanups are not in place. */
2282 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2283 va_list args
, int filter
)
2286 struct cleanup
*old_cleanups
;
2288 linebuffer
= xstrvprintf (format
, args
);
2289 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2290 fputs_maybe_filtered (linebuffer
, stream
, filter
);
2291 do_cleanups (old_cleanups
);
2296 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2298 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2302 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2305 struct cleanup
*old_cleanups
;
2307 linebuffer
= xstrvprintf (format
, args
);
2308 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2309 if (debug_timestamp
&& stream
== gdb_stdlog
)
2315 gettimeofday (&tm
, NULL
);
2317 len
= strlen (linebuffer
);
2318 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2320 timestamp
= xstrprintf ("%ld:%ld %s%s",
2321 (long) tm
.tv_sec
, (long) tm
.tv_usec
,
2323 need_nl
? "\n": "");
2324 make_cleanup (xfree
, timestamp
);
2325 fputs_unfiltered (timestamp
, stream
);
2328 fputs_unfiltered (linebuffer
, stream
);
2329 do_cleanups (old_cleanups
);
2333 vprintf_filtered (const char *format
, va_list args
)
2335 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2339 vprintf_unfiltered (const char *format
, va_list args
)
2341 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2345 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2349 va_start (args
, format
);
2350 vfprintf_filtered (stream
, format
, args
);
2355 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2359 va_start (args
, format
);
2360 vfprintf_unfiltered (stream
, format
, args
);
2364 /* Like fprintf_filtered, but prints its result indented.
2365 Called as fprintfi_filtered (spaces, stream, format, ...); */
2368 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2373 va_start (args
, format
);
2374 print_spaces_filtered (spaces
, stream
);
2376 vfprintf_filtered (stream
, format
, args
);
2382 printf_filtered (const char *format
, ...)
2386 va_start (args
, format
);
2387 vfprintf_filtered (gdb_stdout
, format
, args
);
2393 printf_unfiltered (const char *format
, ...)
2397 va_start (args
, format
);
2398 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2402 /* Like printf_filtered, but prints it's result indented.
2403 Called as printfi_filtered (spaces, format, ...); */
2406 printfi_filtered (int spaces
, const char *format
, ...)
2410 va_start (args
, format
);
2411 print_spaces_filtered (spaces
, gdb_stdout
);
2412 vfprintf_filtered (gdb_stdout
, format
, args
);
2416 /* Easy -- but watch out!
2418 This routine is *not* a replacement for puts()! puts() appends a newline.
2419 This one doesn't, and had better not! */
2422 puts_filtered (const char *string
)
2424 fputs_filtered (string
, gdb_stdout
);
2428 puts_unfiltered (const char *string
)
2430 fputs_unfiltered (string
, gdb_stdout
);
2433 /* Return a pointer to N spaces and a null. The pointer is good
2434 until the next call to here. */
2439 static char *spaces
= 0;
2440 static int max_spaces
= -1;
2446 spaces
= (char *) xmalloc (n
+ 1);
2447 for (t
= spaces
+ n
; t
!= spaces
;)
2453 return spaces
+ max_spaces
- n
;
2456 /* Print N spaces. */
2458 print_spaces_filtered (int n
, struct ui_file
*stream
)
2460 fputs_filtered (n_spaces (n
), stream
);
2463 /* C++/ObjC demangler stuff. */
2465 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2466 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2467 If the name is not mangled, or the language for the name is unknown, or
2468 demangling is off, the name is printed in its "raw" form. */
2471 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2472 enum language lang
, int arg_mode
)
2478 /* If user wants to see raw output, no problem. */
2481 fputs_filtered (name
, stream
);
2485 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2486 fputs_filtered (demangled
? demangled
: name
, stream
);
2487 if (demangled
!= NULL
)
2495 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2496 differences in whitespace. Returns 0 if they match, non-zero if they
2497 don't (slightly different than strcmp()'s range of return values).
2499 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2500 This "feature" is useful when searching for matching C++ function names
2501 (such as if the user types 'break FOO', where FOO is a mangled C++
2505 strcmp_iw (const char *string1
, const char *string2
)
2507 while ((*string1
!= '\0') && (*string2
!= '\0'))
2509 while (isspace (*string1
))
2513 while (isspace (*string2
))
2517 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2519 if (case_sensitivity
== case_sensitive_off
2520 && (tolower ((unsigned char) *string1
)
2521 != tolower ((unsigned char) *string2
)))
2523 if (*string1
!= '\0')
2529 return (*string1
!= '\0' && *string1
!= '(') || (*string2
!= '\0');
2532 /* This is like strcmp except that it ignores whitespace and treats
2533 '(' as the first non-NULL character in terms of ordering. Like
2534 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2535 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2536 according to that ordering.
2538 If a list is sorted according to this function and if you want to
2539 find names in the list that match some fixed NAME according to
2540 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2541 where this function would put NAME.
2543 This function must be neutral to the CASE_SENSITIVITY setting as the user
2544 may choose it during later lookup. Therefore this function always sorts
2545 primarily case-insensitively and secondarily case-sensitively.
2547 Here are some examples of why using strcmp to sort is a bad idea:
2551 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2552 we try to do a search for "foo<char*>", strcmp will locate this
2553 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2554 will start looking at strings beginning with "goo", and will never
2555 see the correct match of "foo<char *>".
2557 Parenthesis example:
2559 In practice, this is less like to be an issue, but I'll give it a
2560 shot. Let's assume that '$' is a legitimate character to occur in
2561 symbols. (Which may well even be the case on some systems.) Then
2562 say that the partial symbol table contains "foo$" and "foo(int)".
2563 strcmp will put them in this order, since '$' < '('. Now, if the
2564 user searches for "foo", then strcmp will sort "foo" before "foo$".
2565 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2566 "foo") is false, so it won't proceed to the actual match of
2567 "foo(int)" with "foo". */
2570 strcmp_iw_ordered (const char *string1
, const char *string2
)
2572 const char *saved_string1
= string1
, *saved_string2
= string2
;
2573 enum case_sensitivity case_pass
= case_sensitive_off
;
2577 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2578 Provide stub characters if we are already at the end of one of the
2580 char c1
= 'X', c2
= 'X';
2582 while (*string1
!= '\0' && *string2
!= '\0')
2584 while (isspace (*string1
))
2586 while (isspace (*string2
))
2591 case case_sensitive_off
:
2592 c1
= tolower ((unsigned char) *string1
);
2593 c2
= tolower ((unsigned char) *string2
);
2595 case case_sensitive_on
:
2603 if (*string1
!= '\0')
2612 /* Characters are non-equal unless they're both '\0'; we want to
2613 make sure we get the comparison right according to our
2614 comparison in the cases where one of them is '\0' or '('. */
2616 if (*string2
== '\0')
2621 if (*string2
== '\0')
2626 if (*string2
== '\0' || *string2
== '(')
2635 if (case_pass
== case_sensitive_on
)
2638 /* Otherwise the strings were equal in case insensitive way, make
2639 a more fine grained comparison in a case sensitive way. */
2641 case_pass
= case_sensitive_on
;
2642 string1
= saved_string1
;
2643 string2
= saved_string2
;
2647 /* A simple comparison function with opposite semantics to strcmp. */
2650 streq (const char *lhs
, const char *rhs
)
2652 return !strcmp (lhs
, rhs
);
2658 ** Answer whether string_to_compare is a full or partial match to
2659 ** template_string. The partial match must be in sequence starting
2663 subset_compare (char *string_to_compare
, char *template_string
)
2667 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
2668 && strlen (string_to_compare
) <= strlen (template_string
))
2670 (startswith (template_string
, string_to_compare
));
2677 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2678 struct cmd_list_element
*c
, const char *value
)
2680 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2686 initialize_utils (void)
2688 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
2689 Set number of characters where GDB should wrap lines of its output."), _("\
2690 Show number of characters where GDB should wrap lines of its output."), _("\
2691 This affects where GDB wraps its output to fit the screen width.\n\
2692 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2694 show_chars_per_line
,
2695 &setlist
, &showlist
);
2697 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
2698 Set number of lines in a page for GDB output pagination."), _("\
2699 Show number of lines in a page for GDB output pagination."), _("\
2700 This affects the number of lines after which GDB will pause\n\
2701 its output and ask you whether to continue.\n\
2702 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2704 show_lines_per_page
,
2705 &setlist
, &showlist
);
2707 add_setshow_boolean_cmd ("pagination", class_support
,
2708 &pagination_enabled
, _("\
2709 Set state of GDB output pagination."), _("\
2710 Show state of GDB output pagination."), _("\
2711 When pagination is ON, GDB pauses at end of each screenful of\n\
2712 its output and asks you whether to continue.\n\
2713 Turning pagination off is an alternative to \"set height unlimited\"."),
2715 show_pagination_enabled
,
2716 &setlist
, &showlist
);
2718 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
2719 &sevenbit_strings
, _("\
2720 Set printing of 8-bit characters in strings as \\nnn."), _("\
2721 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
2723 show_sevenbit_strings
,
2724 &setprintlist
, &showprintlist
);
2726 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
2727 &debug_timestamp
, _("\
2728 Set timestamping of debugging messages."), _("\
2729 Show timestamping of debugging messages."), _("\
2730 When set, debugging messages will be marked with seconds and microseconds."),
2732 show_debug_timestamp
,
2733 &setdebuglist
, &showdebuglist
);
2737 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2739 /* Truncate address to the size of a target address, avoiding shifts
2740 larger or equal than the width of a CORE_ADDR. The local
2741 variable ADDR_BIT stops the compiler reporting a shift overflow
2742 when it won't occur. */
2743 /* NOTE: This assumes that the significant address information is
2744 kept in the least significant bits of ADDR - the upper bits were
2745 either zero or sign extended. Should gdbarch_address_to_pointer or
2746 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2748 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2750 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2751 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2752 return hex_string (addr
);
2755 /* This function is described in "defs.h". */
2758 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2760 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2762 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2763 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2765 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2766 that returns the language localized string formatted to a width
2767 based on gdbarch_addr_bit. */
2769 return hex_string_custom (address
, 8);
2771 return hex_string_custom (address
, 16);
2774 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2777 core_addr_hash (const void *ap
)
2779 const CORE_ADDR
*addrp
= (const CORE_ADDR
*) ap
;
2784 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2787 core_addr_eq (const void *ap
, const void *bp
)
2789 const CORE_ADDR
*addr_ap
= (const CORE_ADDR
*) ap
;
2790 const CORE_ADDR
*addr_bp
= (const CORE_ADDR
*) bp
;
2792 return *addr_ap
== *addr_bp
;
2795 /* Convert a string back into a CORE_ADDR. */
2797 string_to_core_addr (const char *my_string
)
2801 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2803 /* Assume that it is in hex. */
2806 for (i
= 2; my_string
[i
] != '\0'; i
++)
2808 if (isdigit (my_string
[i
]))
2809 addr
= (my_string
[i
] - '0') + (addr
* 16);
2810 else if (isxdigit (my_string
[i
]))
2811 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2813 error (_("invalid hex \"%s\""), my_string
);
2818 /* Assume that it is in decimal. */
2821 for (i
= 0; my_string
[i
] != '\0'; i
++)
2823 if (isdigit (my_string
[i
]))
2824 addr
= (my_string
[i
] - '0') + (addr
* 10);
2826 error (_("invalid decimal \"%s\""), my_string
);
2834 gdb_realpath (const char *filename
)
2836 /* On most hosts, we rely on canonicalize_file_name to compute
2837 the FILENAME's realpath.
2839 But the situation is slightly more complex on Windows, due to some
2840 versions of GCC which were reported to generate paths where
2841 backlashes (the directory separator) were doubled. For instance:
2842 c:\\some\\double\\slashes\\dir
2844 c:\some\double\slashes\dir
2845 Those double-slashes were getting in the way when comparing paths,
2846 for instance when trying to insert a breakpoint as follow:
2847 (gdb) b c:/some/double/slashes/dir/foo.c:4
2848 No source file named c:/some/double/slashes/dir/foo.c:4.
2849 (gdb) b c:\some\double\slashes\dir\foo.c:4
2850 No source file named c:\some\double\slashes\dir\foo.c:4.
2851 To prevent this from happening, we need this function to always
2852 strip those extra backslashes. While canonicalize_file_name does
2853 perform this simplification, it only works when the path is valid.
2854 Since the simplification would be useful even if the path is not
2855 valid (one can always set a breakpoint on a file, even if the file
2856 does not exist locally), we rely instead on GetFullPathName to
2857 perform the canonicalization. */
2859 #if defined (_WIN32)
2862 DWORD len
= GetFullPathName (filename
, MAX_PATH
, buf
, NULL
);
2864 /* The file system is case-insensitive but case-preserving.
2865 So it is important we do not lowercase the path. Otherwise,
2866 we might not be able to display the original casing in a given
2868 if (len
> 0 && len
< MAX_PATH
)
2869 return xstrdup (buf
);
2873 char *rp
= canonicalize_file_name (filename
);
2880 /* This system is a lost cause, just dup the buffer. */
2881 return xstrdup (filename
);
2884 /* Return a copy of FILENAME, with its directory prefix canonicalized
2888 gdb_realpath_keepfile (const char *filename
)
2890 const char *base_name
= lbasename (filename
);
2895 /* Extract the basename of filename, and return immediately
2896 a copy of filename if it does not contain any directory prefix. */
2897 if (base_name
== filename
)
2898 return xstrdup (filename
);
2900 dir_name
= (char *) alloca ((size_t) (base_name
- filename
+ 2));
2901 /* Allocate enough space to store the dir_name + plus one extra
2902 character sometimes needed under Windows (see below), and
2903 then the closing \000 character. */
2904 strncpy (dir_name
, filename
, base_name
- filename
);
2905 dir_name
[base_name
- filename
] = '\000';
2907 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
2908 /* We need to be careful when filename is of the form 'd:foo', which
2909 is equivalent of d:./foo, which is totally different from d:/foo. */
2910 if (strlen (dir_name
) == 2 && isalpha (dir_name
[0]) && dir_name
[1] == ':')
2913 dir_name
[3] = '\000';
2917 /* Canonicalize the directory prefix, and build the resulting
2918 filename. If the dirname realpath already contains an ending
2919 directory separator, avoid doubling it. */
2920 real_path
= gdb_realpath (dir_name
);
2921 if (IS_DIR_SEPARATOR (real_path
[strlen (real_path
) - 1]))
2922 result
= concat (real_path
, base_name
, (char *) NULL
);
2924 result
= concat (real_path
, SLASH_STRING
, base_name
, (char *) NULL
);
2930 /* Return PATH in absolute form, performing tilde-expansion if necessary.
2931 PATH cannot be NULL or the empty string.
2932 This does not resolve symlinks however, use gdb_realpath for that.
2933 Space for the result is allocated with malloc.
2934 If the path is already absolute, it is strdup'd.
2935 If there is a problem computing the absolute path, the path is returned
2936 unchanged (still strdup'd). */
2939 gdb_abspath (const char *path
)
2941 gdb_assert (path
!= NULL
&& path
[0] != '\0');
2944 return tilde_expand (path
);
2946 if (IS_ABSOLUTE_PATH (path
))
2947 return xstrdup (path
);
2949 /* Beware the // my son, the Emacs barfs, the botch that catch... */
2950 return concat (current_directory
,
2951 IS_DIR_SEPARATOR (current_directory
[strlen (current_directory
) - 1])
2952 ? "" : SLASH_STRING
,
2953 path
, (char *) NULL
);
2957 align_up (ULONGEST v
, int n
)
2959 /* Check that N is really a power of two. */
2960 gdb_assert (n
&& (n
& (n
-1)) == 0);
2961 return (v
+ n
- 1) & -n
;
2965 align_down (ULONGEST v
, int n
)
2967 /* Check that N is really a power of two. */
2968 gdb_assert (n
&& (n
& (n
-1)) == 0);
2972 /* Allocation function for the libiberty hash table which uses an
2973 obstack. The obstack is passed as DATA. */
2976 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
2978 size_t total
= size
* count
;
2979 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
2981 memset (ptr
, 0, total
);
2985 /* Trivial deallocation function for the libiberty splay tree and hash
2986 table - don't deallocate anything. Rely on later deletion of the
2987 obstack. DATA will be the obstack, although it is not needed
2991 dummy_obstack_deallocate (void *object
, void *data
)
2996 /* Simple, portable version of dirname that does not modify its
3000 ldirname (const char *filename
)
3002 const char *base
= lbasename (filename
);
3005 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
3008 if (base
== filename
)
3011 dirname
= (char *) xmalloc (base
- filename
+ 2);
3012 memcpy (dirname
, filename
, base
- filename
);
3014 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3015 create "d:./bar" later instead of the (different) "d:/bar". */
3016 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3017 && !IS_DIR_SEPARATOR (filename
[0]))
3018 dirname
[base
++ - filename
] = '.';
3020 dirname
[base
- filename
] = '\0';
3024 /* Call libiberty's buildargv, and return the result.
3025 If buildargv fails due to out-of-memory, call nomem.
3026 Therefore, the returned value is guaranteed to be non-NULL,
3027 unless the parameter itself is NULL. */
3030 gdb_buildargv (const char *s
)
3032 char **argv
= buildargv (s
);
3034 if (s
!= NULL
&& argv
== NULL
)
3040 compare_positive_ints (const void *ap
, const void *bp
)
3042 /* Because we know we're comparing two ints which are positive,
3043 there's no danger of overflow here. */
3044 return * (int *) ap
- * (int *) bp
;
3047 /* String compare function for qsort. */
3050 compare_strings (const void *arg1
, const void *arg2
)
3052 const char **s1
= (const char **) arg1
;
3053 const char **s2
= (const char **) arg2
;
3055 return strcmp (*s1
, *s2
);
3058 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3059 #define AMBIGUOUS_MESS2 \
3060 ".\nUse \"set gnutarget format-name\" to specify the format."
3063 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3069 /* Check if errmsg just need simple return. */
3070 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3071 return bfd_errmsg (error_tag
);
3073 ret_len
= strlen (bfd_errmsg (error_tag
)) + strlen (AMBIGUOUS_MESS1
)
3074 + strlen (AMBIGUOUS_MESS2
);
3075 for (p
= matching
; *p
; p
++)
3076 ret_len
+= strlen (*p
) + 1;
3077 ret
= (char *) xmalloc (ret_len
+ 1);
3079 make_cleanup (xfree
, ret
);
3081 strcpy (retp
, bfd_errmsg (error_tag
));
3082 retp
+= strlen (retp
);
3084 strcpy (retp
, AMBIGUOUS_MESS1
);
3085 retp
+= strlen (retp
);
3087 for (p
= matching
; *p
; p
++)
3089 sprintf (retp
, " %s", *p
);
3090 retp
+= strlen (retp
);
3094 strcpy (retp
, AMBIGUOUS_MESS2
);
3099 /* Return ARGS parsed as a valid pid, or throw an error. */
3102 parse_pid_to_attach (const char *args
)
3108 error_no_arg (_("process-id to attach"));
3110 dummy
= (char *) args
;
3111 pid
= strtoul (args
, &dummy
, 0);
3112 /* Some targets don't set errno on errors, grrr! */
3113 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3114 error (_("Illegal process-id: %s."), args
);
3119 /* Helper for make_bpstat_clear_actions_cleanup. */
3122 do_bpstat_clear_actions_cleanup (void *unused
)
3124 bpstat_clear_actions ();
3127 /* Call bpstat_clear_actions for the case an exception is throw. You should
3128 discard_cleanups if no exception is caught. */
3131 make_bpstat_clear_actions_cleanup (void)
3133 return make_cleanup (do_bpstat_clear_actions_cleanup
, NULL
);
3136 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3137 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3138 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3141 producer_is_gcc_ge_4 (const char *producer
)
3145 if (! producer_is_gcc (producer
, &major
, &minor
))
3154 /* Returns nonzero if the given PRODUCER string is GCC and sets the MAJOR
3155 and MINOR versions when not NULL. Returns zero if the given PRODUCER
3156 is NULL or it isn't GCC. */
3159 producer_is_gcc (const char *producer
, int *major
, int *minor
)
3163 if (producer
!= NULL
&& startswith (producer
, "GNU "))
3172 /* Skip any identifier after "GNU " - such as "C11" or "C++".
3173 A full producer string might look like:
3175 "GNU Fortran 4.8.2 20140120 (Red Hat 4.8.2-16) -mtune=generic ..."
3176 "GNU C++14 5.0.0 20150123 (experimental)"
3178 cs
= &producer
[strlen ("GNU ")];
3179 while (*cs
&& !isspace (*cs
))
3181 if (*cs
&& isspace (*cs
))
3183 if (sscanf (cs
, "%d.%d", major
, minor
) == 2)
3187 /* Not recognized as GCC. */
3191 /* Helper for make_cleanup_free_char_ptr_vec. */
3194 do_free_char_ptr_vec (void *arg
)
3196 VEC (char_ptr
) *char_ptr_vec
= (VEC (char_ptr
) *) arg
;
3198 free_char_ptr_vec (char_ptr_vec
);
3201 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3202 final VEC_free for CHAR_PTR_VEC itself.
3204 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3205 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3206 this function does not (cannot) clear the pointer. */
3209 make_cleanup_free_char_ptr_vec (VEC (char_ptr
) *char_ptr_vec
)
3211 return make_cleanup (do_free_char_ptr_vec
, char_ptr_vec
);
3214 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3215 must come from xrealloc-compatible allocator and it may be updated. FROM
3216 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3217 located at the start or end of *STRINGP. */
3220 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3222 char *string
= *stringp
, *s
;
3223 const size_t from_len
= strlen (from
);
3224 const size_t to_len
= strlen (to
);
3228 s
= strstr (s
, from
);
3232 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3233 || s
[-1] == DIRNAME_SEPARATOR
)
3234 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3235 || s
[from_len
] == DIRNAME_SEPARATOR
))
3240 = (char *) xrealloc (string
, (strlen (string
) + to_len
+ 1));
3242 /* Relocate the current S pointer. */
3243 s
= s
- string
+ string_new
;
3244 string
= string_new
;
3246 /* Replace from by to. */
3247 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3248 memcpy (s
, to
, to_len
);
3263 /* SIGALRM handler for waitpid_with_timeout. */
3266 sigalrm_handler (int signo
)
3268 /* Nothing to do. */
3273 /* Wrapper to wait for child PID to die with TIMEOUT.
3274 TIMEOUT is the time to stop waiting in seconds.
3275 If TIMEOUT is zero, pass WNOHANG to waitpid.
3276 Returns PID if it was successfully waited for, otherwise -1.
3278 Timeouts are currently implemented with alarm and SIGALRM.
3279 If the host does not support them, this waits "forever".
3280 It would be odd though for a host to have waitpid and not SIGALRM. */
3283 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3285 pid_t waitpid_result
;
3287 gdb_assert (pid
> 0);
3288 gdb_assert (timeout
>= 0);
3293 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3294 struct sigaction sa
, old_sa
;
3296 sa
.sa_handler
= sigalrm_handler
;
3297 sigemptyset (&sa
.sa_mask
);
3299 sigaction (SIGALRM
, &sa
, &old_sa
);
3303 ofunc
= signal (SIGALRM
, sigalrm_handler
);
3309 waitpid_result
= waitpid (pid
, status
, 0);
3313 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3314 sigaction (SIGALRM
, &old_sa
, NULL
);
3316 signal (SIGALRM
, ofunc
);
3321 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3323 if (waitpid_result
== pid
)
3329 #endif /* HAVE_WAITPID */
3331 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3332 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3334 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3335 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3338 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3340 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3342 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3343 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3345 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3347 char *pattern_slash
, *string_slash
;
3349 /* Replace '\' by '/' in both strings. */
3351 pattern_slash
= (char *) alloca (strlen (pattern
) + 1);
3352 strcpy (pattern_slash
, pattern
);
3353 pattern
= pattern_slash
;
3354 for (; *pattern_slash
!= 0; pattern_slash
++)
3355 if (IS_DIR_SEPARATOR (*pattern_slash
))
3356 *pattern_slash
= '/';
3358 string_slash
= (char *) alloca (strlen (string
) + 1);
3359 strcpy (string_slash
, string
);
3360 string
= string_slash
;
3361 for (; *string_slash
!= 0; string_slash
++)
3362 if (IS_DIR_SEPARATOR (*string_slash
))
3363 *string_slash
= '/';
3365 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3367 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3368 flags
|= FNM_CASEFOLD
;
3369 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3371 return fnmatch (pattern
, string
, flags
);
3374 /* Return the number of path elements in PATH.
3382 count_path_elements (const char *path
)
3385 const char *p
= path
;
3387 if (HAS_DRIVE_SPEC (p
))
3389 p
= STRIP_DRIVE_SPEC (p
);
3395 if (IS_DIR_SEPARATOR (*p
))
3400 /* Backup one if last character is /, unless it's the only one. */
3401 if (p
> path
+ 1 && IS_DIR_SEPARATOR (p
[-1]))
3404 /* Add one for the file name, if present. */
3405 if (p
> path
&& !IS_DIR_SEPARATOR (p
[-1]))
3411 /* Remove N leading path elements from PATH.
3412 N must be non-negative.
3413 If PATH has more than N path elements then return NULL.
3414 If PATH has exactly N path elements then return "".
3415 See count_path_elements for a description of how we do the counting. */
3418 strip_leading_path_elements (const char *path
, int n
)
3421 const char *p
= path
;
3423 gdb_assert (n
>= 0);
3428 if (HAS_DRIVE_SPEC (p
))
3430 p
= STRIP_DRIVE_SPEC (p
);
3436 while (*p
!= '\0' && !IS_DIR_SEPARATOR (*p
))
3451 /* Provide a prototype to silence -Wmissing-prototypes. */
3452 extern initialize_file_ftype _initialize_utils
;
3455 _initialize_utils (void)
3457 add_internal_problem_command (&internal_error_problem
);
3458 add_internal_problem_command (&internal_warning_problem
);
3459 add_internal_problem_command (&demangler_warning_problem
);