1 /* General utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2017 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. */
44 #include "gdb-demangle.h"
45 #include "expression.h"
49 #include "filenames.h"
51 #include "gdb_obstack.h"
57 #include "inferior.h" /* for signed_pointer_to_address */
59 #include "gdb_curses.h"
61 #include "readline/readline.h"
65 #include "gdb_usleep.h"
67 #include "gdb_regex.h"
70 extern PTR
malloc (); /* ARI: PTR */
72 #if !HAVE_DECL_REALLOC
73 extern PTR
realloc (); /* ARI: PTR */
79 void (*deprecated_error_begin_hook
) (void);
81 /* Prototypes for local functions */
83 static void vfprintf_maybe_filtered (struct ui_file
*, const char *,
84 va_list, int) ATTRIBUTE_PRINTF (2, 0);
86 static void fputs_maybe_filtered (const char *, struct ui_file
*, int);
88 static void prompt_for_continue (void);
90 static void set_screen_size (void);
91 static void set_width (void);
93 /* Time spent in prompt_for_continue in the currently executing command
94 waiting for user to respond.
95 Initialized in make_command_stats_cleanup.
96 Modified in prompt_for_continue and defaulted_query.
97 Used in report_command_stats. */
99 static std::chrono::steady_clock::duration prompt_for_continue_wait_time
;
101 /* A flag indicating whether to timestamp debugging messages. */
103 static int debug_timestamp
= 0;
105 /* Nonzero if we have job control. */
109 /* Nonzero means that strings with character values >0x7F should be printed
110 as octal escapes. Zero means just print the value (e.g. it's an
111 international character, and the terminal or window can cope.) */
113 int sevenbit_strings
= 0;
115 show_sevenbit_strings (struct ui_file
*file
, int from_tty
,
116 struct cmd_list_element
*c
, const char *value
)
118 fprintf_filtered (file
, _("Printing of 8-bit characters "
119 "in strings as \\nnn is %s.\n"),
123 /* String to be printed before warning messages, if any. */
125 char *warning_pre_print
= "\nwarning: ";
127 int pagination_enabled
= 1;
129 show_pagination_enabled (struct ui_file
*file
, int from_tty
,
130 struct cmd_list_element
*c
, const char *value
)
132 fprintf_filtered (file
, _("State of pagination is %s.\n"), value
);
136 /* Cleanup utilities.
138 These are not defined in cleanups.c (nor declared in cleanups.h)
139 because while they use the "cleanup API" they are not part of the
143 do_freeargv (void *arg
)
145 freeargv ((char **) arg
);
149 make_cleanup_freeargv (char **arg
)
151 return make_cleanup (do_freeargv
, arg
);
155 do_bfd_close_cleanup (void *arg
)
157 gdb_bfd_unref ((bfd
*) arg
);
161 make_cleanup_bfd_unref (bfd
*abfd
)
163 return make_cleanup (do_bfd_close_cleanup
, abfd
);
166 /* Helper function which does the work for make_cleanup_fclose. */
169 do_fclose_cleanup (void *arg
)
171 FILE *file
= (FILE *) arg
;
176 /* Return a new cleanup that closes FILE. */
179 make_cleanup_fclose (FILE *file
)
181 return make_cleanup (do_fclose_cleanup
, file
);
184 /* Helper function which does the work for make_cleanup_obstack_free. */
187 do_obstack_free (void *arg
)
189 struct obstack
*ob
= (struct obstack
*) arg
;
191 obstack_free (ob
, NULL
);
194 /* Return a new cleanup that frees OBSTACK. */
197 make_cleanup_obstack_free (struct obstack
*obstack
)
199 return make_cleanup (do_obstack_free
, obstack
);
203 do_ui_file_delete (void *arg
)
205 ui_file_delete ((struct ui_file
*) arg
);
209 make_cleanup_ui_file_delete (struct ui_file
*arg
)
211 return make_cleanup (do_ui_file_delete
, arg
);
214 /* Helper function for make_cleanup_ui_out_redirect_pop. */
217 do_ui_out_redirect_pop (void *arg
)
219 struct ui_out
*uiout
= (struct ui_out
*) arg
;
221 uiout
->redirect (NULL
);
224 /* Return a new cleanup that pops the last redirection by ui_out_redirect
225 with NULL parameter. */
228 make_cleanup_ui_out_redirect_pop (struct ui_out
*uiout
)
230 return make_cleanup (do_ui_out_redirect_pop
, uiout
);
234 do_free_section_addr_info (void *arg
)
236 free_section_addr_info ((struct section_addr_info
*) arg
);
240 make_cleanup_free_section_addr_info (struct section_addr_info
*addrs
)
242 return make_cleanup (do_free_section_addr_info
, addrs
);
245 struct restore_integer_closure
252 restore_integer (void *p
)
254 struct restore_integer_closure
*closure
255 = (struct restore_integer_closure
*) p
;
257 *(closure
->variable
) = closure
->value
;
260 /* Remember the current value of *VARIABLE and make it restored when
261 the cleanup is run. */
264 make_cleanup_restore_integer (int *variable
)
266 struct restore_integer_closure
*c
= XNEW (struct restore_integer_closure
);
268 c
->variable
= variable
;
269 c
->value
= *variable
;
271 return make_cleanup_dtor (restore_integer
, (void *) c
, xfree
);
274 /* Remember the current value of *VARIABLE and make it restored when
275 the cleanup is run. */
278 make_cleanup_restore_uinteger (unsigned int *variable
)
280 return make_cleanup_restore_integer ((int *) variable
);
283 /* Helper for make_cleanup_unpush_target. */
286 do_unpush_target (void *arg
)
288 struct target_ops
*ops
= (struct target_ops
*) arg
;
293 /* Return a new cleanup that unpushes OPS. */
296 make_cleanup_unpush_target (struct target_ops
*ops
)
298 return make_cleanup (do_unpush_target
, ops
);
301 /* Helper for make_cleanup_htab_delete compile time checking the types. */
304 do_htab_delete_cleanup (void *htab_voidp
)
306 htab_t htab
= (htab_t
) htab_voidp
;
311 /* Return a new cleanup that deletes HTAB. */
314 make_cleanup_htab_delete (htab_t htab
)
316 return make_cleanup (do_htab_delete_cleanup
, htab
);
319 /* Helper for make_cleanup_value_free_to_mark. */
322 do_value_free_to_mark (void *value
)
324 value_free_to_mark ((struct value
*) value
);
327 /* Free all values allocated since MARK was obtained by value_mark
328 (except for those released) when the cleanup is run. */
331 make_cleanup_value_free_to_mark (struct value
*mark
)
333 return make_cleanup (do_value_free_to_mark
, mark
);
336 /* Helper for make_cleanup_value_free. */
339 do_value_free (void *value
)
341 value_free ((struct value
*) value
);
347 make_cleanup_value_free (struct value
*value
)
349 return make_cleanup (do_value_free
, value
);
352 /* Helper for make_cleanup_free_so. */
355 do_free_so (void *arg
)
357 struct so_list
*so
= (struct so_list
*) arg
;
362 /* Make cleanup handler calling free_so for SO. */
365 make_cleanup_free_so (struct so_list
*so
)
367 return make_cleanup (do_free_so
, so
);
370 /* Helper for make_cleanup_restore_current_language. */
373 do_restore_current_language (void *p
)
375 enum language saved_lang
= (enum language
) (uintptr_t) p
;
377 set_language (saved_lang
);
380 /* Remember the current value of CURRENT_LANGUAGE and make it restored when
381 the cleanup is run. */
384 make_cleanup_restore_current_language (void)
386 enum language saved_lang
= current_language
->la_language
;
388 return make_cleanup (do_restore_current_language
,
389 (void *) (uintptr_t) saved_lang
);
392 /* Helper function for make_cleanup_clear_parser_state. */
395 do_clear_parser_state (void *ptr
)
397 struct parser_state
**p
= (struct parser_state
**) ptr
;
402 /* Clean (i.e., set to NULL) the parser state variable P. */
405 make_cleanup_clear_parser_state (struct parser_state
**p
)
407 return make_cleanup (do_clear_parser_state
, (void *) p
);
410 /* This function is useful for cleanups.
414 old_chain = make_cleanup (free_current_contents, &foo);
416 to arrange to free the object thus allocated. */
419 free_current_contents (void *ptr
)
421 void **location
= (void **) ptr
;
423 if (location
== NULL
)
424 internal_error (__FILE__
, __LINE__
,
425 _("free_current_contents: NULL pointer"));
426 if (*location
!= NULL
)
435 /* Print a warning message. The first argument STRING is the warning
436 message, used as an fprintf format string, the second is the
437 va_list of arguments for that string. A warning is unfiltered (not
438 paginated) so that the user does not need to page through each
439 screen full of warnings when there are lots of them. */
442 vwarning (const char *string
, va_list args
)
444 if (deprecated_warning_hook
)
445 (*deprecated_warning_hook
) (string
, args
);
448 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
450 if (target_supports_terminal_ours ())
452 make_cleanup_restore_target_terminal ();
453 target_terminal_ours_for_output ();
455 if (filtered_printing_initialized ())
456 wrap_here (""); /* Force out any buffered output. */
457 gdb_flush (gdb_stdout
);
458 if (warning_pre_print
)
459 fputs_unfiltered (warning_pre_print
, gdb_stderr
);
460 vfprintf_unfiltered (gdb_stderr
, string
, args
);
461 fprintf_unfiltered (gdb_stderr
, "\n");
463 do_cleanups (old_chain
);
467 /* Print an error message and return to command level.
468 The first argument STRING is the error message, used as a fprintf string,
469 and the remaining args are passed as arguments to it. */
472 verror (const char *string
, va_list args
)
474 throw_verror (GENERIC_ERROR
, string
, args
);
478 error_stream (struct ui_file
*stream
)
480 std::string message
= ui_file_as_string (stream
);
482 error (("%s"), message
.c_str ());
485 /* Emit a message and abort. */
487 static void ATTRIBUTE_NORETURN
488 abort_with_message (const char *msg
)
490 if (gdb_stderr
== NULL
)
493 fputs_unfiltered (msg
, gdb_stderr
);
495 abort (); /* NOTE: GDB has only three calls to abort(). */
498 /* Dump core trying to increase the core soft limit to hard limit first. */
503 #ifdef HAVE_SETRLIMIT
504 struct rlimit rlim
= { RLIM_INFINITY
, RLIM_INFINITY
};
506 setrlimit (RLIMIT_CORE
, &rlim
);
507 #endif /* HAVE_SETRLIMIT */
509 abort (); /* NOTE: GDB has only three calls to abort(). */
512 /* Check whether GDB will be able to dump core using the dump_core
513 function. Returns zero if GDB cannot or should not dump core.
514 If LIMIT_KIND is LIMIT_CUR the user's soft limit will be respected.
515 If LIMIT_KIND is LIMIT_MAX only the hard limit will be respected. */
518 can_dump_core (enum resource_limit_kind limit_kind
)
520 #ifdef HAVE_GETRLIMIT
523 /* Be quiet and assume we can dump if an error is returned. */
524 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
530 if (rlim
.rlim_cur
== 0)
534 if (rlim
.rlim_max
== 0)
537 #endif /* HAVE_GETRLIMIT */
542 /* Print a warning that we cannot dump core. */
545 warn_cant_dump_core (const char *reason
)
547 fprintf_unfiltered (gdb_stderr
,
548 _("%s\nUnable to dump core, use `ulimit -c"
549 " unlimited' before executing GDB next time.\n"),
553 /* Check whether GDB will be able to dump core using the dump_core
554 function, and print a warning if we cannot. */
557 can_dump_core_warn (enum resource_limit_kind limit_kind
,
560 int core_dump_allowed
= can_dump_core (limit_kind
);
562 if (!core_dump_allowed
)
563 warn_cant_dump_core (reason
);
565 return core_dump_allowed
;
568 /* Allow the user to configure the debugger behavior with respect to
569 what to do when an internal problem is detected. */
571 const char internal_problem_ask
[] = "ask";
572 const char internal_problem_yes
[] = "yes";
573 const char internal_problem_no
[] = "no";
574 static const char *const internal_problem_modes
[] =
576 internal_problem_ask
,
577 internal_problem_yes
,
582 /* Print a message reporting an internal error/warning. Ask the user
583 if they want to continue, dump core, or just exit. Return
584 something to indicate a quit. */
586 struct internal_problem
589 int user_settable_should_quit
;
590 const char *should_quit
;
591 int user_settable_should_dump_core
;
592 const char *should_dump_core
;
595 /* Report a problem, internal to GDB, to the user. Once the problem
596 has been reported, and assuming GDB didn't quit, the caller can
597 either allow execution to resume or throw an error. */
599 static void ATTRIBUTE_PRINTF (4, 0)
600 internal_vproblem (struct internal_problem
*problem
,
601 const char *file
, int line
, const char *fmt
, va_list ap
)
607 struct cleanup
*cleanup
= make_cleanup (null_cleanup
, NULL
);
609 /* Don't allow infinite error/warning recursion. */
611 static char msg
[] = "Recursive internal problem.\n";
620 abort_with_message (msg
);
623 /* Newer GLIBC versions put the warn_unused_result attribute
624 on write, but this is one of those rare cases where
625 ignoring the return value is correct. Casting to (void)
626 does not fix this problem. This is the solution suggested
627 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
628 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
629 abort (); /* NOTE: GDB has only three calls to abort(). */
634 /* Create a string containing the full error/warning message. Need
635 to call query with this full string, as otherwize the reason
636 (error/warning) and question become separated. Format using a
637 style similar to a compiler error message. Include extra detail
638 so that the user knows that they are living on the edge. */
642 msg
= xstrvprintf (fmt
, ap
);
643 reason
= xstrprintf ("%s:%d: %s: %s\n"
644 "A problem internal to GDB has been detected,\n"
645 "further debugging may prove unreliable.",
646 file
, line
, problem
->name
, msg
);
648 make_cleanup (xfree
, reason
);
651 /* Fall back to abort_with_message if gdb_stderr is not set up. */
652 if (gdb_stderr
== NULL
)
654 fputs (reason
, stderr
);
655 abort_with_message ("\n");
658 /* Try to get the message out and at the start of a new line. */
659 if (target_supports_terminal_ours ())
661 make_cleanup_restore_target_terminal ();
662 target_terminal_ours_for_output ();
664 if (filtered_printing_initialized ())
667 /* Emit the message unless query will emit it below. */
668 if (problem
->should_quit
!= internal_problem_ask
670 || !filtered_printing_initialized ())
671 fprintf_unfiltered (gdb_stderr
, "%s\n", reason
);
673 if (problem
->should_quit
== internal_problem_ask
)
675 /* Default (yes/batch case) is to quit GDB. When in batch mode
676 this lessens the likelihood of GDB going into an infinite
678 if (!confirm
|| !filtered_printing_initialized ())
681 quit_p
= query (_("%s\nQuit this debugging session? "), reason
);
683 else if (problem
->should_quit
== internal_problem_yes
)
685 else if (problem
->should_quit
== internal_problem_no
)
688 internal_error (__FILE__
, __LINE__
, _("bad switch"));
690 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr
);
691 if (REPORT_BUGS_TO
[0])
692 fprintf_unfiltered (gdb_stderr
, _(" For instructions, see:\n%s."),
694 fputs_unfiltered ("\n\n", gdb_stderr
);
696 if (problem
->should_dump_core
== internal_problem_ask
)
698 if (!can_dump_core_warn (LIMIT_MAX
, reason
))
700 else if (!filtered_printing_initialized ())
704 /* Default (yes/batch case) is to dump core. This leaves a GDB
705 `dropping' so that it is easier to see that something went
707 dump_core_p
= query (_("%s\nCreate a core file of GDB? "), reason
);
710 else if (problem
->should_dump_core
== internal_problem_yes
)
711 dump_core_p
= can_dump_core_warn (LIMIT_MAX
, reason
);
712 else if (problem
->should_dump_core
== internal_problem_no
)
715 internal_error (__FILE__
, __LINE__
, _("bad switch"));
728 #ifdef HAVE_WORKING_FORK
736 do_cleanups (cleanup
);
739 static struct internal_problem internal_error_problem
= {
740 "internal-error", 1, internal_problem_ask
, 1, internal_problem_ask
744 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
746 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
747 throw_quit (_("Command aborted."));
750 static struct internal_problem internal_warning_problem
= {
751 "internal-warning", 1, internal_problem_ask
, 1, internal_problem_ask
755 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
757 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
760 static struct internal_problem demangler_warning_problem
= {
761 "demangler-warning", 1, internal_problem_ask
, 0, internal_problem_no
765 demangler_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
767 internal_vproblem (&demangler_warning_problem
, file
, line
, fmt
, ap
);
771 demangler_warning (const char *file
, int line
, const char *string
, ...)
775 va_start (ap
, string
);
776 demangler_vwarning (file
, line
, string
, ap
);
780 /* Dummy functions to keep add_prefix_cmd happy. */
783 set_internal_problem_cmd (char *args
, int from_tty
)
788 show_internal_problem_cmd (char *args
, int from_tty
)
792 /* When GDB reports an internal problem (error or warning) it gives
793 the user the opportunity to quit GDB and/or create a core file of
794 the current debug session. This function registers a few commands
795 that make it possible to specify that GDB should always or never
796 quit or create a core file, without asking. The commands look
799 maint set PROBLEM-NAME quit ask|yes|no
800 maint show PROBLEM-NAME quit
801 maint set PROBLEM-NAME corefile ask|yes|no
802 maint show PROBLEM-NAME corefile
804 Where PROBLEM-NAME is currently "internal-error" or
805 "internal-warning". */
808 add_internal_problem_command (struct internal_problem
*problem
)
810 struct cmd_list_element
**set_cmd_list
;
811 struct cmd_list_element
**show_cmd_list
;
815 set_cmd_list
= XNEW (struct cmd_list_element
*);
816 show_cmd_list
= XNEW (struct cmd_list_element
*);
817 *set_cmd_list
= NULL
;
818 *show_cmd_list
= NULL
;
820 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
823 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
826 add_prefix_cmd ((char*) problem
->name
,
827 class_maintenance
, set_internal_problem_cmd
, set_doc
,
829 concat ("maintenance set ", problem
->name
, " ",
831 0/*allow-unknown*/, &maintenance_set_cmdlist
);
833 add_prefix_cmd ((char*) problem
->name
,
834 class_maintenance
, show_internal_problem_cmd
, show_doc
,
836 concat ("maintenance show ", problem
->name
, " ",
838 0/*allow-unknown*/, &maintenance_show_cmdlist
);
840 if (problem
->user_settable_should_quit
)
842 set_doc
= xstrprintf (_("Set whether GDB should quit "
843 "when an %s is detected"),
845 show_doc
= xstrprintf (_("Show whether GDB will quit "
846 "when an %s is detected"),
848 add_setshow_enum_cmd ("quit", class_maintenance
,
849 internal_problem_modes
,
850 &problem
->should_quit
,
863 if (problem
->user_settable_should_dump_core
)
865 set_doc
= xstrprintf (_("Set whether GDB should create a core "
866 "file of GDB when %s is detected"),
868 show_doc
= xstrprintf (_("Show whether GDB will create a core "
869 "file of GDB when %s is detected"),
871 add_setshow_enum_cmd ("corefile", class_maintenance
,
872 internal_problem_modes
,
873 &problem
->should_dump_core
,
887 /* Return a newly allocated string, containing the PREFIX followed
888 by the system error message for errno (separated by a colon).
890 The result must be deallocated after use. */
893 perror_string (const char *prefix
)
898 err
= safe_strerror (errno
);
899 combined
= (char *) xmalloc (strlen (err
) + strlen (prefix
) + 3);
900 strcpy (combined
, prefix
);
901 strcat (combined
, ": ");
902 strcat (combined
, err
);
907 /* Print the system error message for errno, and also mention STRING
908 as the file name for which the error was encountered. Use ERRCODE
909 for the thrown exception. Then return to command level. */
912 throw_perror_with_name (enum errors errcode
, const char *string
)
916 combined
= perror_string (string
);
917 make_cleanup (xfree
, combined
);
919 /* I understand setting these is a matter of taste. Still, some people
920 may clear errno but not know about bfd_error. Doing this here is not
922 bfd_set_error (bfd_error_no_error
);
925 throw_error (errcode
, _("%s."), combined
);
928 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
931 perror_with_name (const char *string
)
933 throw_perror_with_name (GENERIC_ERROR
, string
);
936 /* Same as perror_with_name except that it prints a warning instead
937 of throwing an error. */
940 perror_warning_with_name (const char *string
)
944 combined
= perror_string (string
);
945 warning (_("%s"), combined
);
949 /* Print the system error message for ERRCODE, and also mention STRING
950 as the file name for which the error was encountered. */
953 print_sys_errmsg (const char *string
, int errcode
)
958 err
= safe_strerror (errcode
);
959 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
960 strcpy (combined
, string
);
961 strcat (combined
, ": ");
962 strcat (combined
, err
);
964 /* We want anything which was printed on stdout to come out first, before
966 gdb_flush (gdb_stdout
);
967 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
970 /* Control C eventually causes this to be called, at a convenient time. */
975 struct ui
*ui
= current_ui
;
977 if (sync_quit_force_run
)
979 sync_quit_force_run
= 0;
980 quit_force (NULL
, 0);
984 /* No steenking SIGINT will ever be coming our way when the
985 program is resumed. Don't lie. */
989 /* If there is no terminal switching for this target, then we can't
990 possibly get screwed by the lack of job control. */
991 || !target_supports_terminal_ours ())
994 throw_quit ("Quit (expect signal SIGINT when the program is resumed)");
1003 if (sync_quit_force_run
)
1008 if (deprecated_interactive_hook
)
1009 deprecated_interactive_hook ();
1013 /* Called when a memory allocation fails, with the number of bytes of
1014 memory requested in SIZE. */
1017 malloc_failure (long size
)
1021 internal_error (__FILE__
, __LINE__
,
1022 _("virtual memory exhausted: can't allocate %ld bytes."),
1027 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
1031 /* My replacement for the read system call.
1032 Used like `read' but keeps going if `read' returns too soon. */
1035 myread (int desc
, char *addr
, int len
)
1042 val
= read (desc
, addr
, len
);
1046 return orglen
- len
;
1054 print_spaces (int n
, struct ui_file
*file
)
1056 fputs_unfiltered (n_spaces (n
), file
);
1059 /* Print a host address. */
1062 gdb_print_host_address_1 (const void *addr
, struct ui_file
*stream
)
1064 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
1070 make_hex_string (const gdb_byte
*data
, size_t length
)
1072 char *result
= (char *) xmalloc (length
* 2 + 1);
1077 for (i
= 0; i
< length
; ++i
)
1078 p
+= xsnprintf (p
, 3, "%02x", data
[i
]);
1085 /* A cleanup function that calls regfree. */
1088 do_regfree_cleanup (void *r
)
1090 regfree ((regex_t
*) r
);
1093 /* Create a new cleanup that frees the compiled regular expression R. */
1096 make_regfree_cleanup (regex_t
*r
)
1098 return make_cleanup (do_regfree_cleanup
, r
);
1101 /* Return an xmalloc'd error message resulting from a regular
1102 expression compilation failure. */
1105 get_regcomp_error (int code
, regex_t
*rx
)
1107 size_t length
= regerror (code
, rx
, NULL
, 0);
1108 char *result
= (char *) xmalloc (length
);
1110 regerror (code
, rx
, result
, length
);
1114 /* Compile a regexp and throw an exception on error. This returns a
1115 cleanup to free the resulting pattern on success. RX must not be
1119 compile_rx_or_error (regex_t
*pattern
, const char *rx
, const char *message
)
1123 gdb_assert (rx
!= NULL
);
1125 code
= regcomp (pattern
, rx
, REG_NOSUB
);
1128 char *err
= get_regcomp_error (code
, pattern
);
1130 make_cleanup (xfree
, err
);
1131 error (("%s: %s"), message
, err
);
1134 return make_regfree_cleanup (pattern
);
1137 /* A cleanup that simply calls ui_unregister_input_event_handler. */
1140 ui_unregister_input_event_handler_cleanup (void *ui
)
1142 ui_unregister_input_event_handler ((struct ui
*) ui
);
1145 /* Set up to handle input. */
1147 static struct cleanup
*
1148 prepare_to_handle_input (void)
1150 struct cleanup
*old_chain
;
1152 old_chain
= make_cleanup_restore_target_terminal ();
1153 target_terminal_ours ();
1155 ui_register_input_event_handler (current_ui
);
1156 if (current_ui
->prompt_state
== PROMPT_BLOCKED
)
1157 make_cleanup (ui_unregister_input_event_handler_cleanup
, current_ui
);
1159 make_cleanup_override_quit_handler (default_quit_handler
);
1166 /* This function supports the query, nquery, and yquery functions.
1167 Ask user a y-or-n question and return 0 if answer is no, 1 if
1168 answer is yes, or default the answer to the specified default
1169 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1170 default answer, or '\0' for no default.
1171 CTLSTR is the control string and should end in "? ". It should
1172 not say how to answer, because we do that.
1173 ARGS are the arguments passed along with the CTLSTR argument to
1176 static int ATTRIBUTE_PRINTF (1, 0)
1177 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
1182 char def_answer
, not_def_answer
;
1183 char *y_string
, *n_string
, *question
, *prompt
;
1184 struct cleanup
*old_chain
;
1186 /* Set up according to which answer is the default. */
1187 if (defchar
== '\0')
1191 not_def_answer
= 'N';
1195 else if (defchar
== 'y')
1199 not_def_answer
= 'N';
1207 not_def_answer
= 'Y';
1212 /* Automatically answer the default value if the user did not want
1213 prompts or the command was issued with the server prefix. */
1214 if (!confirm
|| server_command
)
1217 /* If input isn't coming from the user directly, just say what
1218 question we're asking, and then answer the default automatically. This
1219 way, important error messages don't get lost when talking to GDB
1221 if (current_ui
->instream
!= current_ui
->stdin_stream
1222 || !input_interactive_p (current_ui
))
1224 old_chain
= make_cleanup_restore_target_terminal ();
1226 target_terminal_ours_for_output ();
1228 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
1230 printf_filtered (_("(%s or %s) [answered %c; "
1231 "input not from terminal]\n"),
1232 y_string
, n_string
, def_answer
);
1233 gdb_flush (gdb_stdout
);
1235 do_cleanups (old_chain
);
1239 if (deprecated_query_hook
)
1243 old_chain
= make_cleanup_restore_target_terminal ();
1244 res
= deprecated_query_hook (ctlstr
, args
);
1245 do_cleanups (old_chain
);
1249 /* Format the question outside of the loop, to avoid reusing args. */
1250 question
= xstrvprintf (ctlstr
, args
);
1251 old_chain
= make_cleanup (xfree
, question
);
1252 prompt
= xstrprintf (_("%s%s(%s or %s) %s"),
1253 annotation_level
> 1 ? "\n\032\032pre-query\n" : "",
1254 question
, y_string
, n_string
,
1255 annotation_level
> 1 ? "\n\032\032query\n" : "");
1256 make_cleanup (xfree
, prompt
);
1258 /* Used to add duration we waited for user to respond to
1259 prompt_for_continue_wait_time. */
1260 using namespace std::chrono
;
1261 steady_clock::time_point prompt_started
= steady_clock::now ();
1263 prepare_to_handle_input ();
1267 char *response
, answer
;
1269 gdb_flush (gdb_stdout
);
1270 response
= gdb_readline_wrapper (prompt
);
1272 if (response
== NULL
) /* C-d */
1274 printf_filtered ("EOF [assumed %c]\n", def_answer
);
1279 answer
= response
[0];
1284 /* Check answer. For the non-default, the user must specify
1285 the non-default explicitly. */
1286 if (answer
== not_def_answer
)
1288 retval
= !def_value
;
1291 /* Otherwise, if a default was specified, the user may either
1292 specify the required input or have it default by entering
1294 if (answer
== def_answer
1295 || (defchar
!= '\0' && answer
== '\0'))
1300 /* Invalid entries are not defaulted and require another selection. */
1301 printf_filtered (_("Please answer %s or %s.\n"),
1302 y_string
, n_string
);
1305 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1306 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1308 if (annotation_level
> 1)
1309 printf_filtered (("\n\032\032post-query\n"));
1310 do_cleanups (old_chain
);
1315 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1316 answer is yes, or 0 if answer is defaulted.
1317 Takes three args which are given to printf to print the question.
1318 The first, a control string, should end in "? ".
1319 It should not say how to answer, because we do that. */
1322 nquery (const char *ctlstr
, ...)
1327 va_start (args
, ctlstr
);
1328 ret
= defaulted_query (ctlstr
, 'n', args
);
1333 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1334 answer is yes, or 1 if answer is defaulted.
1335 Takes three args which are given to printf to print the question.
1336 The first, a control string, should end in "? ".
1337 It should not say how to answer, because we do that. */
1340 yquery (const char *ctlstr
, ...)
1345 va_start (args
, ctlstr
);
1346 ret
= defaulted_query (ctlstr
, 'y', args
);
1351 /* Ask user a y-or-n question and return 1 iff answer is yes.
1352 Takes three args which are given to printf to print the question.
1353 The first, a control string, should end in "? ".
1354 It should not say how to answer, because we do that. */
1357 query (const char *ctlstr
, ...)
1362 va_start (args
, ctlstr
);
1363 ret
= defaulted_query (ctlstr
, '\0', args
);
1368 /* A helper for parse_escape that converts a host character to a
1369 target character. C is the host character. If conversion is
1370 possible, then the target character is stored in *TARGET_C and the
1371 function returns 1. Otherwise, the function returns 0. */
1374 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1376 struct obstack host_data
;
1378 struct cleanup
*cleanups
;
1381 obstack_init (&host_data
);
1382 cleanups
= make_cleanup_obstack_free (&host_data
);
1384 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1385 (gdb_byte
*) &the_char
, 1, 1,
1386 &host_data
, translit_none
);
1388 if (obstack_object_size (&host_data
) == 1)
1391 *target_c
= *(char *) obstack_base (&host_data
);
1394 do_cleanups (cleanups
);
1398 /* Parse a C escape sequence. STRING_PTR points to a variable
1399 containing a pointer to the string to parse. That pointer
1400 should point to the character after the \. That pointer
1401 is updated past the characters we use. The value of the
1402 escape sequence is returned.
1404 A negative value means the sequence \ newline was seen,
1405 which is supposed to be equivalent to nothing at all.
1407 If \ is followed by a null character, we return a negative
1408 value and leave the string pointer pointing at the null character.
1410 If \ is followed by 000, we return 0 and leave the string pointer
1411 after the zeros. A value of 0 does not mean end of string. */
1414 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1416 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1417 int c
= *(*string_ptr
)++;
1436 int i
= host_hex_value (c
);
1441 if (isdigit (c
) && c
!= '8' && c
!= '9')
1445 i
+= host_hex_value (c
);
1481 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1482 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1483 " which has no equivalent\nin the `%s' character set."),
1484 c
, c
, target_charset (gdbarch
));
1488 /* Print the character C on STREAM as part of the contents of a literal
1489 string whose delimiter is QUOTER. Note that this routine should only
1490 be called for printing things which are independent of the language
1491 of the program being debugged.
1493 printchar will normally escape backslashes and instances of QUOTER. If
1494 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1495 As a side effect, if you pass the backslash character as the QUOTER,
1496 printchar will escape backslashes as usual, but not any other quoting
1500 printchar (int c
, void (*do_fputs
) (const char *, struct ui_file
*),
1501 void (*do_fprintf
) (struct ui_file
*, const char *, ...)
1502 ATTRIBUTE_FPTR_PRINTF_2
, struct ui_file
*stream
, int quoter
)
1504 c
&= 0xFF; /* Avoid sign bit follies */
1506 if (c
< 0x20 || /* Low control chars */
1507 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1508 (sevenbit_strings
&& c
>= 0x80))
1509 { /* high order bit set */
1513 do_fputs ("\\n", stream
);
1516 do_fputs ("\\b", stream
);
1519 do_fputs ("\\t", stream
);
1522 do_fputs ("\\f", stream
);
1525 do_fputs ("\\r", stream
);
1528 do_fputs ("\\e", stream
);
1531 do_fputs ("\\a", stream
);
1534 do_fprintf (stream
, "\\%.3o", (unsigned int) c
);
1540 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1541 do_fputs ("\\", stream
);
1542 do_fprintf (stream
, "%c", c
);
1546 /* Print the character C on STREAM as part of the contents of a
1547 literal string whose delimiter is QUOTER. Note that these routines
1548 should only be call for printing things which are independent of
1549 the language of the program being debugged. */
1552 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1555 printchar (*str
++, fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1559 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1562 printchar (*str
++, fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1566 fputstrn_filtered (const char *str
, int n
, int quoter
,
1567 struct ui_file
*stream
)
1571 for (i
= 0; i
< n
; i
++)
1572 printchar (str
[i
], fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1576 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1577 struct ui_file
*stream
)
1581 for (i
= 0; i
< n
; i
++)
1582 printchar (str
[i
], fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1586 /* Number of lines per page or UINT_MAX if paging is disabled. */
1587 static unsigned int lines_per_page
;
1589 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1590 struct cmd_list_element
*c
, const char *value
)
1592 fprintf_filtered (file
,
1593 _("Number of lines gdb thinks are in a page is %s.\n"),
1597 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1598 static unsigned int chars_per_line
;
1600 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1601 struct cmd_list_element
*c
, const char *value
)
1603 fprintf_filtered (file
,
1604 _("Number of characters gdb thinks "
1605 "are in a line is %s.\n"),
1609 /* Current count of lines printed on this page, chars on this line. */
1610 static unsigned int lines_printed
, chars_printed
;
1612 /* Buffer and start column of buffered text, for doing smarter word-
1613 wrapping. When someone calls wrap_here(), we start buffering output
1614 that comes through fputs_filtered(). If we see a newline, we just
1615 spit it out and forget about the wrap_here(). If we see another
1616 wrap_here(), we spit it out and remember the newer one. If we see
1617 the end of the line, we spit out a newline, the indent, and then
1618 the buffered output. */
1620 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1621 are waiting to be output (they have already been counted in chars_printed).
1622 When wrap_buffer[0] is null, the buffer is empty. */
1623 static char *wrap_buffer
;
1625 /* Pointer in wrap_buffer to the next character to fill. */
1626 static char *wrap_pointer
;
1628 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1630 static const char *wrap_indent
;
1632 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1633 is not in effect. */
1634 static int wrap_column
;
1637 /* Initialize the number of lines per page and chars per line. */
1640 init_page_info (void)
1644 lines_per_page
= UINT_MAX
;
1645 chars_per_line
= UINT_MAX
;
1649 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1654 #if defined(__GO32__)
1655 rows
= ScreenRows ();
1656 cols
= ScreenCols ();
1657 lines_per_page
= rows
;
1658 chars_per_line
= cols
;
1660 /* Make sure Readline has initialized its terminal settings. */
1661 rl_reset_terminal (NULL
);
1663 /* Get the screen size from Readline. */
1664 rl_get_screen_size (&rows
, &cols
);
1665 lines_per_page
= rows
;
1666 chars_per_line
= cols
;
1668 /* Readline should have fetched the termcap entry for us.
1669 Only try to use tgetnum function if rl_get_screen_size
1670 did not return a useful value. */
1671 if (((rows
<= 0) && (tgetnum ("li") < 0))
1672 /* Also disable paging if inside Emacs. $EMACS was used
1673 before Emacs v25.1, $INSIDE_EMACS is used since then. */
1674 || getenv ("EMACS") || getenv ("INSIDE_EMACS"))
1676 /* The number of lines per page is not mentioned in the terminal
1677 description or EMACS evironment variable is set. This probably
1678 means that paging is not useful, so disable paging. */
1679 lines_per_page
= UINT_MAX
;
1682 /* If the output is not a terminal, don't paginate it. */
1683 if (!ui_file_isatty (gdb_stdout
))
1684 lines_per_page
= UINT_MAX
;
1688 /* We handle SIGWINCH ourselves. */
1689 rl_catch_sigwinch
= 0;
1695 /* Return nonzero if filtered printing is initialized. */
1697 filtered_printing_initialized (void)
1699 return wrap_buffer
!= NULL
;
1702 /* Helper for make_cleanup_restore_page_info. */
1705 do_restore_page_info_cleanup (void *arg
)
1711 /* Provide cleanup for restoring the terminal size. */
1714 make_cleanup_restore_page_info (void)
1716 struct cleanup
*back_to
;
1718 back_to
= make_cleanup (do_restore_page_info_cleanup
, NULL
);
1719 make_cleanup_restore_uinteger (&lines_per_page
);
1720 make_cleanup_restore_uinteger (&chars_per_line
);
1725 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1726 Provide cleanup for restoring the original state. */
1729 set_batch_flag_and_make_cleanup_restore_page_info (void)
1731 struct cleanup
*back_to
= make_cleanup_restore_page_info ();
1733 make_cleanup_restore_integer (&batch_flag
);
1740 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1743 set_screen_size (void)
1745 int rows
= lines_per_page
;
1746 int cols
= chars_per_line
;
1754 /* Update Readline's idea of the terminal size. */
1755 rl_set_screen_size (rows
, cols
);
1758 /* Reinitialize WRAP_BUFFER according to the current value of
1764 if (chars_per_line
== 0)
1769 wrap_buffer
= (char *) xmalloc (chars_per_line
+ 2);
1770 wrap_buffer
[0] = '\0';
1773 wrap_buffer
= (char *) xrealloc (wrap_buffer
, chars_per_line
+ 2);
1774 wrap_pointer
= wrap_buffer
; /* Start it at the beginning. */
1778 set_width_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1785 set_height_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1793 set_screen_width_and_height (int width
, int height
)
1795 lines_per_page
= height
;
1796 chars_per_line
= width
;
1802 /* Wait, so the user can read what's on the screen. Prompt the user
1803 to continue by pressing RETURN. 'q' is also provided because
1804 telling users what to do in the prompt is more user-friendly than
1805 expecting them to think of Ctrl-C/SIGINT. */
1808 prompt_for_continue (void)
1811 char cont_prompt
[120];
1812 struct cleanup
*old_chain
= make_cleanup (null_cleanup
, NULL
);
1813 /* Used to add duration we waited for user to respond to
1814 prompt_for_continue_wait_time. */
1815 using namespace std::chrono
;
1816 steady_clock::time_point prompt_started
= steady_clock::now ();
1818 if (annotation_level
> 1)
1819 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1821 strcpy (cont_prompt
,
1822 "---Type <return> to continue, or q <return> to quit---");
1823 if (annotation_level
> 1)
1824 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1826 /* We must do this *before* we call gdb_readline_wrapper, else it
1827 will eventually call us -- thinking that we're trying to print
1828 beyond the end of the screen. */
1829 reinitialize_more_filter ();
1831 prepare_to_handle_input ();
1833 /* Call gdb_readline_wrapper, not readline, in order to keep an
1834 event loop running. */
1835 ignore
= gdb_readline_wrapper (cont_prompt
);
1836 make_cleanup (xfree
, ignore
);
1838 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1839 prompt_for_continue_wait_time
+= steady_clock::now () - prompt_started
;
1841 if (annotation_level
> 1)
1842 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1848 while (*p
== ' ' || *p
== '\t')
1851 /* Do not call quit here; there is no possibility of SIGINT. */
1852 throw_quit ("Quit");
1855 /* Now we have to do this again, so that GDB will know that it doesn't
1856 need to save the ---Type <return>--- line at the top of the screen. */
1857 reinitialize_more_filter ();
1859 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1861 do_cleanups (old_chain
);
1864 /* Initialize timer to keep track of how long we waited for the user. */
1867 reset_prompt_for_continue_wait_time (void)
1869 using namespace std::chrono
;
1871 prompt_for_continue_wait_time
= steady_clock::duration::zero ();
1874 /* Fetch the cumulative time spent in prompt_for_continue. */
1876 std::chrono::steady_clock::duration
1877 get_prompt_for_continue_wait_time ()
1879 return prompt_for_continue_wait_time
;
1882 /* Reinitialize filter; ie. tell it to reset to original values. */
1885 reinitialize_more_filter (void)
1891 /* Indicate that if the next sequence of characters overflows the line,
1892 a newline should be inserted here rather than when it hits the end.
1893 If INDENT is non-null, it is a string to be printed to indent the
1894 wrapped part on the next line. INDENT must remain accessible until
1895 the next call to wrap_here() or until a newline is printed through
1898 If the line is already overfull, we immediately print a newline and
1899 the indentation, and disable further wrapping.
1901 If we don't know the width of lines, but we know the page height,
1902 we must not wrap words, but should still keep track of newlines
1903 that were explicitly printed.
1905 INDENT should not contain tabs, as that will mess up the char count
1906 on the next line. FIXME.
1908 This routine is guaranteed to force out any output which has been
1909 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1910 used to force out output from the wrap_buffer. */
1913 wrap_here (const char *indent
)
1915 /* This should have been allocated, but be paranoid anyway. */
1917 internal_error (__FILE__
, __LINE__
,
1918 _("failed internal consistency check"));
1922 *wrap_pointer
= '\0';
1923 fputs_unfiltered (wrap_buffer
, gdb_stdout
);
1925 wrap_pointer
= wrap_buffer
;
1926 wrap_buffer
[0] = '\0';
1927 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1931 else if (chars_printed
>= chars_per_line
)
1933 puts_filtered ("\n");
1935 puts_filtered (indent
);
1940 wrap_column
= chars_printed
;
1944 wrap_indent
= indent
;
1948 /* Print input string to gdb_stdout, filtered, with wrap,
1949 arranging strings in columns of n chars. String can be
1950 right or left justified in the column. Never prints
1951 trailing spaces. String should never be longer than
1952 width. FIXME: this could be useful for the EXAMINE
1953 command, which currently doesn't tabulate very well. */
1956 puts_filtered_tabular (char *string
, int width
, int right
)
1962 gdb_assert (chars_per_line
> 0);
1963 if (chars_per_line
== UINT_MAX
)
1965 fputs_filtered (string
, gdb_stdout
);
1966 fputs_filtered ("\n", gdb_stdout
);
1970 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1971 fputs_filtered ("\n", gdb_stdout
);
1973 if (width
>= chars_per_line
)
1974 width
= chars_per_line
- 1;
1976 stringlen
= strlen (string
);
1978 if (chars_printed
> 0)
1979 spaces
= width
- (chars_printed
- 1) % width
- 1;
1981 spaces
+= width
- stringlen
;
1983 spacebuf
= (char *) alloca (spaces
+ 1);
1984 spacebuf
[spaces
] = '\0';
1986 spacebuf
[spaces
] = ' ';
1988 fputs_filtered (spacebuf
, gdb_stdout
);
1989 fputs_filtered (string
, gdb_stdout
);
1993 /* Ensure that whatever gets printed next, using the filtered output
1994 commands, starts at the beginning of the line. I.e. if there is
1995 any pending output for the current line, flush it and start a new
1996 line. Otherwise do nothing. */
2001 if (chars_printed
> 0)
2003 puts_filtered ("\n");
2008 /* Like fputs but if FILTER is true, pause after every screenful.
2010 Regardless of FILTER can wrap at points other than the final
2011 character of a line.
2013 Unlike fputs, fputs_maybe_filtered does not return a value.
2014 It is OK for LINEBUFFER to be NULL, in which case just don't print
2017 Note that a longjmp to top level may occur in this routine (only if
2018 FILTER is true) (since prompt_for_continue may do so) so this
2019 routine should not be called when cleanups are not in place. */
2022 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
2025 const char *lineptr
;
2027 if (linebuffer
== 0)
2030 /* Don't do any filtering if it is disabled. */
2031 if (stream
!= gdb_stdout
2032 || !pagination_enabled
2034 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
2035 || top_level_interpreter () == NULL
2036 || interp_ui_out (top_level_interpreter ())->is_mi_like_p ())
2038 fputs_unfiltered (linebuffer
, stream
);
2042 /* Go through and output each character. Show line extension
2043 when this is necessary; prompt user for new page when this is
2046 lineptr
= linebuffer
;
2049 /* Possible new page. */
2050 if (filter
&& (lines_printed
>= lines_per_page
- 1))
2051 prompt_for_continue ();
2053 while (*lineptr
&& *lineptr
!= '\n')
2055 /* Print a single line. */
2056 if (*lineptr
== '\t')
2059 *wrap_pointer
++ = '\t';
2061 fputc_unfiltered ('\t', stream
);
2062 /* Shifting right by 3 produces the number of tab stops
2063 we have already passed, and then adding one and
2064 shifting left 3 advances to the next tab stop. */
2065 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
2071 *wrap_pointer
++ = *lineptr
;
2073 fputc_unfiltered (*lineptr
, stream
);
2078 if (chars_printed
>= chars_per_line
)
2080 unsigned int save_chars
= chars_printed
;
2084 /* If we aren't actually wrapping, don't output newline --
2085 if chars_per_line is right, we probably just overflowed
2086 anyway; if it's wrong, let us keep going. */
2088 fputc_unfiltered ('\n', stream
);
2090 /* Possible new page. */
2091 if (lines_printed
>= lines_per_page
- 1)
2092 prompt_for_continue ();
2094 /* Now output indentation and wrapped string. */
2097 fputs_unfiltered (wrap_indent
, stream
);
2098 *wrap_pointer
= '\0'; /* Null-terminate saved stuff, */
2099 fputs_unfiltered (wrap_buffer
, stream
); /* and eject it. */
2100 /* FIXME, this strlen is what prevents wrap_indent from
2101 containing tabs. However, if we recurse to print it
2102 and count its chars, we risk trouble if wrap_indent is
2103 longer than (the user settable) chars_per_line.
2104 Note also that this can set chars_printed > chars_per_line
2105 if we are printing a long string. */
2106 chars_printed
= strlen (wrap_indent
)
2107 + (save_chars
- wrap_column
);
2108 wrap_pointer
= wrap_buffer
; /* Reset buffer */
2109 wrap_buffer
[0] = '\0';
2110 wrap_column
= 0; /* And disable fancy wrap */
2115 if (*lineptr
== '\n')
2118 wrap_here ((char *) 0); /* Spit out chars, cancel
2121 fputc_unfiltered ('\n', stream
);
2128 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
2130 fputs_maybe_filtered (linebuffer
, stream
, 1);
2134 putchar_unfiltered (int c
)
2138 ui_file_write (gdb_stdout
, &buf
, 1);
2142 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2143 May return nonlocally. */
2146 putchar_filtered (int c
)
2148 return fputc_filtered (c
, gdb_stdout
);
2152 fputc_unfiltered (int c
, struct ui_file
*stream
)
2156 ui_file_write (stream
, &buf
, 1);
2161 fputc_filtered (int c
, struct ui_file
*stream
)
2167 fputs_filtered (buf
, stream
);
2171 /* puts_debug is like fputs_unfiltered, except it prints special
2172 characters in printable fashion. */
2175 puts_debug (char *prefix
, char *string
, char *suffix
)
2179 /* Print prefix and suffix after each line. */
2180 static int new_line
= 1;
2181 static int return_p
= 0;
2182 static char *prev_prefix
= "";
2183 static char *prev_suffix
= "";
2185 if (*string
== '\n')
2188 /* If the prefix is changing, print the previous suffix, a new line,
2189 and the new prefix. */
2190 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
2192 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
2193 fputs_unfiltered ("\n", gdb_stdlog
);
2194 fputs_unfiltered (prefix
, gdb_stdlog
);
2197 /* Print prefix if we printed a newline during the previous call. */
2201 fputs_unfiltered (prefix
, gdb_stdlog
);
2204 prev_prefix
= prefix
;
2205 prev_suffix
= suffix
;
2207 /* Output characters in a printable format. */
2208 while ((ch
= *string
++) != '\0')
2214 fputc_unfiltered (ch
, gdb_stdlog
);
2217 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2221 fputs_unfiltered ("\\\\", gdb_stdlog
);
2224 fputs_unfiltered ("\\b", gdb_stdlog
);
2227 fputs_unfiltered ("\\f", gdb_stdlog
);
2231 fputs_unfiltered ("\\n", gdb_stdlog
);
2234 fputs_unfiltered ("\\r", gdb_stdlog
);
2237 fputs_unfiltered ("\\t", gdb_stdlog
);
2240 fputs_unfiltered ("\\v", gdb_stdlog
);
2244 return_p
= ch
== '\r';
2247 /* Print suffix if we printed a newline. */
2250 fputs_unfiltered (suffix
, gdb_stdlog
);
2251 fputs_unfiltered ("\n", gdb_stdlog
);
2256 /* Print a variable number of ARGS using format FORMAT. If this
2257 information is going to put the amount written (since the last call
2258 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2259 call prompt_for_continue to get the users permision to continue.
2261 Unlike fprintf, this function does not return a value.
2263 We implement three variants, vfprintf (takes a vararg list and stream),
2264 fprintf (takes a stream to write on), and printf (the usual).
2266 Note also that a longjmp to top level may occur in this routine
2267 (since prompt_for_continue may do so) so this routine should not be
2268 called when cleanups are not in place. */
2271 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2272 va_list args
, int filter
)
2275 struct cleanup
*old_cleanups
;
2277 linebuffer
= xstrvprintf (format
, args
);
2278 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2279 fputs_maybe_filtered (linebuffer
, stream
, filter
);
2280 do_cleanups (old_cleanups
);
2285 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2287 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2291 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2294 struct cleanup
*old_cleanups
;
2296 linebuffer
= xstrvprintf (format
, args
);
2297 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2298 if (debug_timestamp
&& stream
== gdb_stdlog
)
2300 using namespace std::chrono
;
2303 steady_clock::time_point now
= steady_clock::now ();
2304 seconds s
= duration_cast
<seconds
> (now
.time_since_epoch ());
2305 microseconds us
= duration_cast
<microseconds
> (now
.time_since_epoch () - s
);
2307 len
= strlen (linebuffer
);
2308 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2310 std::string timestamp
= string_printf ("%ld.%06ld %s%s",
2313 linebuffer
, need_nl
? "\n": "");
2314 fputs_unfiltered (timestamp
.c_str (), stream
);
2317 fputs_unfiltered (linebuffer
, stream
);
2318 do_cleanups (old_cleanups
);
2322 vprintf_filtered (const char *format
, va_list args
)
2324 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2328 vprintf_unfiltered (const char *format
, va_list args
)
2330 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2334 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2338 va_start (args
, format
);
2339 vfprintf_filtered (stream
, format
, args
);
2344 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2348 va_start (args
, format
);
2349 vfprintf_unfiltered (stream
, format
, args
);
2353 /* Like fprintf_filtered, but prints its result indented.
2354 Called as fprintfi_filtered (spaces, stream, format, ...); */
2357 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2362 va_start (args
, format
);
2363 print_spaces_filtered (spaces
, stream
);
2365 vfprintf_filtered (stream
, format
, args
);
2371 printf_filtered (const char *format
, ...)
2375 va_start (args
, format
);
2376 vfprintf_filtered (gdb_stdout
, format
, args
);
2382 printf_unfiltered (const char *format
, ...)
2386 va_start (args
, format
);
2387 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2391 /* Like printf_filtered, but prints it's result indented.
2392 Called as printfi_filtered (spaces, format, ...); */
2395 printfi_filtered (int spaces
, const char *format
, ...)
2399 va_start (args
, format
);
2400 print_spaces_filtered (spaces
, gdb_stdout
);
2401 vfprintf_filtered (gdb_stdout
, format
, args
);
2405 /* Easy -- but watch out!
2407 This routine is *not* a replacement for puts()! puts() appends a newline.
2408 This one doesn't, and had better not! */
2411 puts_filtered (const char *string
)
2413 fputs_filtered (string
, gdb_stdout
);
2417 puts_unfiltered (const char *string
)
2419 fputs_unfiltered (string
, gdb_stdout
);
2422 /* Return a pointer to N spaces and a null. The pointer is good
2423 until the next call to here. */
2428 static char *spaces
= 0;
2429 static int max_spaces
= -1;
2435 spaces
= (char *) xmalloc (n
+ 1);
2436 for (t
= spaces
+ n
; t
!= spaces
;)
2442 return spaces
+ max_spaces
- n
;
2445 /* Print N spaces. */
2447 print_spaces_filtered (int n
, struct ui_file
*stream
)
2449 fputs_filtered (n_spaces (n
), stream
);
2452 /* C++/ObjC demangler stuff. */
2454 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2455 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2456 If the name is not mangled, or the language for the name is unknown, or
2457 demangling is off, the name is printed in its "raw" form. */
2460 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2461 enum language lang
, int arg_mode
)
2467 /* If user wants to see raw output, no problem. */
2470 fputs_filtered (name
, stream
);
2474 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2475 fputs_filtered (demangled
? demangled
: name
, stream
);
2476 if (demangled
!= NULL
)
2484 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2485 differences in whitespace. Returns 0 if they match, non-zero if they
2486 don't (slightly different than strcmp()'s range of return values).
2488 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2489 This "feature" is useful when searching for matching C++ function names
2490 (such as if the user types 'break FOO', where FOO is a mangled C++
2494 strcmp_iw (const char *string1
, const char *string2
)
2496 while ((*string1
!= '\0') && (*string2
!= '\0'))
2498 while (isspace (*string1
))
2502 while (isspace (*string2
))
2506 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2508 if (case_sensitivity
== case_sensitive_off
2509 && (tolower ((unsigned char) *string1
)
2510 != tolower ((unsigned char) *string2
)))
2512 if (*string1
!= '\0')
2518 return (*string1
!= '\0' && *string1
!= '(') || (*string2
!= '\0');
2521 /* This is like strcmp except that it ignores whitespace and treats
2522 '(' as the first non-NULL character in terms of ordering. Like
2523 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2524 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2525 according to that ordering.
2527 If a list is sorted according to this function and if you want to
2528 find names in the list that match some fixed NAME according to
2529 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2530 where this function would put NAME.
2532 This function must be neutral to the CASE_SENSITIVITY setting as the user
2533 may choose it during later lookup. Therefore this function always sorts
2534 primarily case-insensitively and secondarily case-sensitively.
2536 Here are some examples of why using strcmp to sort is a bad idea:
2540 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2541 we try to do a search for "foo<char*>", strcmp will locate this
2542 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2543 will start looking at strings beginning with "goo", and will never
2544 see the correct match of "foo<char *>".
2546 Parenthesis example:
2548 In practice, this is less like to be an issue, but I'll give it a
2549 shot. Let's assume that '$' is a legitimate character to occur in
2550 symbols. (Which may well even be the case on some systems.) Then
2551 say that the partial symbol table contains "foo$" and "foo(int)".
2552 strcmp will put them in this order, since '$' < '('. Now, if the
2553 user searches for "foo", then strcmp will sort "foo" before "foo$".
2554 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2555 "foo") is false, so it won't proceed to the actual match of
2556 "foo(int)" with "foo". */
2559 strcmp_iw_ordered (const char *string1
, const char *string2
)
2561 const char *saved_string1
= string1
, *saved_string2
= string2
;
2562 enum case_sensitivity case_pass
= case_sensitive_off
;
2566 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2567 Provide stub characters if we are already at the end of one of the
2569 char c1
= 'X', c2
= 'X';
2571 while (*string1
!= '\0' && *string2
!= '\0')
2573 while (isspace (*string1
))
2575 while (isspace (*string2
))
2580 case case_sensitive_off
:
2581 c1
= tolower ((unsigned char) *string1
);
2582 c2
= tolower ((unsigned char) *string2
);
2584 case case_sensitive_on
:
2592 if (*string1
!= '\0')
2601 /* Characters are non-equal unless they're both '\0'; we want to
2602 make sure we get the comparison right according to our
2603 comparison in the cases where one of them is '\0' or '('. */
2605 if (*string2
== '\0')
2610 if (*string2
== '\0')
2615 if (*string2
== '\0' || *string2
== '(')
2624 if (case_pass
== case_sensitive_on
)
2627 /* Otherwise the strings were equal in case insensitive way, make
2628 a more fine grained comparison in a case sensitive way. */
2630 case_pass
= case_sensitive_on
;
2631 string1
= saved_string1
;
2632 string2
= saved_string2
;
2636 /* A simple comparison function with opposite semantics to strcmp. */
2639 streq (const char *lhs
, const char *rhs
)
2641 return !strcmp (lhs
, rhs
);
2647 ** Answer whether string_to_compare is a full or partial match to
2648 ** template_string. The partial match must be in sequence starting
2652 subset_compare (char *string_to_compare
, char *template_string
)
2656 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
2657 && strlen (string_to_compare
) <= strlen (template_string
))
2659 (startswith (template_string
, string_to_compare
));
2666 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2667 struct cmd_list_element
*c
, const char *value
)
2669 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2675 initialize_utils (void)
2677 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
2678 Set number of characters where GDB should wrap lines of its output."), _("\
2679 Show number of characters where GDB should wrap lines of its output."), _("\
2680 This affects where GDB wraps its output to fit the screen width.\n\
2681 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2683 show_chars_per_line
,
2684 &setlist
, &showlist
);
2686 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
2687 Set number of lines in a page for GDB output pagination."), _("\
2688 Show number of lines in a page for GDB output pagination."), _("\
2689 This affects the number of lines after which GDB will pause\n\
2690 its output and ask you whether to continue.\n\
2691 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2693 show_lines_per_page
,
2694 &setlist
, &showlist
);
2696 add_setshow_boolean_cmd ("pagination", class_support
,
2697 &pagination_enabled
, _("\
2698 Set state of GDB output pagination."), _("\
2699 Show state of GDB output pagination."), _("\
2700 When pagination is ON, GDB pauses at end of each screenful of\n\
2701 its output and asks you whether to continue.\n\
2702 Turning pagination off is an alternative to \"set height unlimited\"."),
2704 show_pagination_enabled
,
2705 &setlist
, &showlist
);
2707 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
2708 &sevenbit_strings
, _("\
2709 Set printing of 8-bit characters in strings as \\nnn."), _("\
2710 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
2712 show_sevenbit_strings
,
2713 &setprintlist
, &showprintlist
);
2715 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
2716 &debug_timestamp
, _("\
2717 Set timestamping of debugging messages."), _("\
2718 Show timestamping of debugging messages."), _("\
2719 When set, debugging messages will be marked with seconds and microseconds."),
2721 show_debug_timestamp
,
2722 &setdebuglist
, &showdebuglist
);
2726 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2728 /* Truncate address to the size of a target address, avoiding shifts
2729 larger or equal than the width of a CORE_ADDR. The local
2730 variable ADDR_BIT stops the compiler reporting a shift overflow
2731 when it won't occur. */
2732 /* NOTE: This assumes that the significant address information is
2733 kept in the least significant bits of ADDR - the upper bits were
2734 either zero or sign extended. Should gdbarch_address_to_pointer or
2735 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2737 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2739 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2740 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2741 return hex_string (addr
);
2744 /* This function is described in "defs.h". */
2747 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2749 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2751 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2752 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2754 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2755 that returns the language localized string formatted to a width
2756 based on gdbarch_addr_bit. */
2758 return hex_string_custom (address
, 8);
2760 return hex_string_custom (address
, 16);
2763 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2766 core_addr_hash (const void *ap
)
2768 const CORE_ADDR
*addrp
= (const CORE_ADDR
*) ap
;
2773 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2776 core_addr_eq (const void *ap
, const void *bp
)
2778 const CORE_ADDR
*addr_ap
= (const CORE_ADDR
*) ap
;
2779 const CORE_ADDR
*addr_bp
= (const CORE_ADDR
*) bp
;
2781 return *addr_ap
== *addr_bp
;
2784 /* Convert a string back into a CORE_ADDR. */
2786 string_to_core_addr (const char *my_string
)
2790 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2792 /* Assume that it is in hex. */
2795 for (i
= 2; my_string
[i
] != '\0'; i
++)
2797 if (isdigit (my_string
[i
]))
2798 addr
= (my_string
[i
] - '0') + (addr
* 16);
2799 else if (isxdigit (my_string
[i
]))
2800 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2802 error (_("invalid hex \"%s\""), my_string
);
2807 /* Assume that it is in decimal. */
2810 for (i
= 0; my_string
[i
] != '\0'; i
++)
2812 if (isdigit (my_string
[i
]))
2813 addr
= (my_string
[i
] - '0') + (addr
* 10);
2815 error (_("invalid decimal \"%s\""), my_string
);
2823 gdb_realpath (const char *filename
)
2825 /* On most hosts, we rely on canonicalize_file_name to compute
2826 the FILENAME's realpath.
2828 But the situation is slightly more complex on Windows, due to some
2829 versions of GCC which were reported to generate paths where
2830 backlashes (the directory separator) were doubled. For instance:
2831 c:\\some\\double\\slashes\\dir
2833 c:\some\double\slashes\dir
2834 Those double-slashes were getting in the way when comparing paths,
2835 for instance when trying to insert a breakpoint as follow:
2836 (gdb) b c:/some/double/slashes/dir/foo.c:4
2837 No source file named c:/some/double/slashes/dir/foo.c:4.
2838 (gdb) b c:\some\double\slashes\dir\foo.c:4
2839 No source file named c:\some\double\slashes\dir\foo.c:4.
2840 To prevent this from happening, we need this function to always
2841 strip those extra backslashes. While canonicalize_file_name does
2842 perform this simplification, it only works when the path is valid.
2843 Since the simplification would be useful even if the path is not
2844 valid (one can always set a breakpoint on a file, even if the file
2845 does not exist locally), we rely instead on GetFullPathName to
2846 perform the canonicalization. */
2848 #if defined (_WIN32)
2851 DWORD len
= GetFullPathName (filename
, MAX_PATH
, buf
, NULL
);
2853 /* The file system is case-insensitive but case-preserving.
2854 So it is important we do not lowercase the path. Otherwise,
2855 we might not be able to display the original casing in a given
2857 if (len
> 0 && len
< MAX_PATH
)
2858 return xstrdup (buf
);
2862 char *rp
= canonicalize_file_name (filename
);
2869 /* This system is a lost cause, just dup the buffer. */
2870 return xstrdup (filename
);
2873 /* Return a copy of FILENAME, with its directory prefix canonicalized
2877 gdb_realpath_keepfile (const char *filename
)
2879 const char *base_name
= lbasename (filename
);
2884 /* Extract the basename of filename, and return immediately
2885 a copy of filename if it does not contain any directory prefix. */
2886 if (base_name
== filename
)
2887 return xstrdup (filename
);
2889 dir_name
= (char *) alloca ((size_t) (base_name
- filename
+ 2));
2890 /* Allocate enough space to store the dir_name + plus one extra
2891 character sometimes needed under Windows (see below), and
2892 then the closing \000 character. */
2893 strncpy (dir_name
, filename
, base_name
- filename
);
2894 dir_name
[base_name
- filename
] = '\000';
2896 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
2897 /* We need to be careful when filename is of the form 'd:foo', which
2898 is equivalent of d:./foo, which is totally different from d:/foo. */
2899 if (strlen (dir_name
) == 2 && isalpha (dir_name
[0]) && dir_name
[1] == ':')
2902 dir_name
[3] = '\000';
2906 /* Canonicalize the directory prefix, and build the resulting
2907 filename. If the dirname realpath already contains an ending
2908 directory separator, avoid doubling it. */
2909 real_path
= gdb_realpath (dir_name
);
2910 if (IS_DIR_SEPARATOR (real_path
[strlen (real_path
) - 1]))
2911 result
= concat (real_path
, base_name
, (char *) NULL
);
2913 result
= concat (real_path
, SLASH_STRING
, base_name
, (char *) NULL
);
2919 /* Return PATH in absolute form, performing tilde-expansion if necessary.
2920 PATH cannot be NULL or the empty string.
2921 This does not resolve symlinks however, use gdb_realpath for that.
2922 Space for the result is allocated with malloc.
2923 If the path is already absolute, it is strdup'd.
2924 If there is a problem computing the absolute path, the path is returned
2925 unchanged (still strdup'd). */
2928 gdb_abspath (const char *path
)
2930 gdb_assert (path
!= NULL
&& path
[0] != '\0');
2933 return tilde_expand (path
);
2935 if (IS_ABSOLUTE_PATH (path
))
2936 return xstrdup (path
);
2938 /* Beware the // my son, the Emacs barfs, the botch that catch... */
2939 return concat (current_directory
,
2940 IS_DIR_SEPARATOR (current_directory
[strlen (current_directory
) - 1])
2941 ? "" : SLASH_STRING
,
2942 path
, (char *) NULL
);
2946 align_up (ULONGEST v
, int n
)
2948 /* Check that N is really a power of two. */
2949 gdb_assert (n
&& (n
& (n
-1)) == 0);
2950 return (v
+ n
- 1) & -n
;
2954 align_down (ULONGEST v
, int n
)
2956 /* Check that N is really a power of two. */
2957 gdb_assert (n
&& (n
& (n
-1)) == 0);
2961 /* Allocation function for the libiberty hash table which uses an
2962 obstack. The obstack is passed as DATA. */
2965 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
2967 size_t total
= size
* count
;
2968 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
2970 memset (ptr
, 0, total
);
2974 /* Trivial deallocation function for the libiberty splay tree and hash
2975 table - don't deallocate anything. Rely on later deletion of the
2976 obstack. DATA will be the obstack, although it is not needed
2980 dummy_obstack_deallocate (void *object
, void *data
)
2985 /* Simple, portable version of dirname that does not modify its
2989 ldirname (const char *filename
)
2991 const char *base
= lbasename (filename
);
2994 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
2997 if (base
== filename
)
3000 dirname
= (char *) xmalloc (base
- filename
+ 2);
3001 memcpy (dirname
, filename
, base
- filename
);
3003 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3004 create "d:./bar" later instead of the (different) "d:/bar". */
3005 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3006 && !IS_DIR_SEPARATOR (filename
[0]))
3007 dirname
[base
++ - filename
] = '.';
3009 dirname
[base
- filename
] = '\0';
3013 /* Call libiberty's buildargv, and return the result.
3014 If buildargv fails due to out-of-memory, call nomem.
3015 Therefore, the returned value is guaranteed to be non-NULL,
3016 unless the parameter itself is NULL. */
3019 gdb_buildargv (const char *s
)
3021 char **argv
= buildargv (s
);
3023 if (s
!= NULL
&& argv
== NULL
)
3029 compare_positive_ints (const void *ap
, const void *bp
)
3031 /* Because we know we're comparing two ints which are positive,
3032 there's no danger of overflow here. */
3033 return * (int *) ap
- * (int *) bp
;
3036 /* String compare function for qsort. */
3039 compare_strings (const void *arg1
, const void *arg2
)
3041 const char **s1
= (const char **) arg1
;
3042 const char **s2
= (const char **) arg2
;
3044 return strcmp (*s1
, *s2
);
3047 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3048 #define AMBIGUOUS_MESS2 \
3049 ".\nUse \"set gnutarget format-name\" to specify the format."
3052 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3058 /* Check if errmsg just need simple return. */
3059 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3060 return bfd_errmsg (error_tag
);
3062 ret_len
= strlen (bfd_errmsg (error_tag
)) + strlen (AMBIGUOUS_MESS1
)
3063 + strlen (AMBIGUOUS_MESS2
);
3064 for (p
= matching
; *p
; p
++)
3065 ret_len
+= strlen (*p
) + 1;
3066 ret
= (char *) xmalloc (ret_len
+ 1);
3068 make_cleanup (xfree
, ret
);
3070 strcpy (retp
, bfd_errmsg (error_tag
));
3071 retp
+= strlen (retp
);
3073 strcpy (retp
, AMBIGUOUS_MESS1
);
3074 retp
+= strlen (retp
);
3076 for (p
= matching
; *p
; p
++)
3078 sprintf (retp
, " %s", *p
);
3079 retp
+= strlen (retp
);
3083 strcpy (retp
, AMBIGUOUS_MESS2
);
3088 /* Return ARGS parsed as a valid pid, or throw an error. */
3091 parse_pid_to_attach (const char *args
)
3097 error_no_arg (_("process-id to attach"));
3099 dummy
= (char *) args
;
3100 pid
= strtoul (args
, &dummy
, 0);
3101 /* Some targets don't set errno on errors, grrr! */
3102 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3103 error (_("Illegal process-id: %s."), args
);
3108 /* Helper for make_bpstat_clear_actions_cleanup. */
3111 do_bpstat_clear_actions_cleanup (void *unused
)
3113 bpstat_clear_actions ();
3116 /* Call bpstat_clear_actions for the case an exception is throw. You should
3117 discard_cleanups if no exception is caught. */
3120 make_bpstat_clear_actions_cleanup (void)
3122 return make_cleanup (do_bpstat_clear_actions_cleanup
, NULL
);
3125 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3126 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3127 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3130 producer_is_gcc_ge_4 (const char *producer
)
3134 if (! producer_is_gcc (producer
, &major
, &minor
))
3143 /* Returns nonzero if the given PRODUCER string is GCC and sets the MAJOR
3144 and MINOR versions when not NULL. Returns zero if the given PRODUCER
3145 is NULL or it isn't GCC. */
3148 producer_is_gcc (const char *producer
, int *major
, int *minor
)
3152 if (producer
!= NULL
&& startswith (producer
, "GNU "))
3161 /* Skip any identifier after "GNU " - such as "C11" or "C++".
3162 A full producer string might look like:
3164 "GNU Fortran 4.8.2 20140120 (Red Hat 4.8.2-16) -mtune=generic ..."
3165 "GNU C++14 5.0.0 20150123 (experimental)"
3167 cs
= &producer
[strlen ("GNU ")];
3168 while (*cs
&& !isspace (*cs
))
3170 if (*cs
&& isspace (*cs
))
3172 if (sscanf (cs
, "%d.%d", major
, minor
) == 2)
3176 /* Not recognized as GCC. */
3180 /* Helper for make_cleanup_free_char_ptr_vec. */
3183 do_free_char_ptr_vec (void *arg
)
3185 VEC (char_ptr
) *char_ptr_vec
= (VEC (char_ptr
) *) arg
;
3187 free_char_ptr_vec (char_ptr_vec
);
3190 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3191 final VEC_free for CHAR_PTR_VEC itself.
3193 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3194 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3195 this function does not (cannot) clear the pointer. */
3198 make_cleanup_free_char_ptr_vec (VEC (char_ptr
) *char_ptr_vec
)
3200 return make_cleanup (do_free_char_ptr_vec
, char_ptr_vec
);
3203 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3204 must come from xrealloc-compatible allocator and it may be updated. FROM
3205 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3206 located at the start or end of *STRINGP. */
3209 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3211 char *string
= *stringp
, *s
;
3212 const size_t from_len
= strlen (from
);
3213 const size_t to_len
= strlen (to
);
3217 s
= strstr (s
, from
);
3221 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3222 || s
[-1] == DIRNAME_SEPARATOR
)
3223 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3224 || s
[from_len
] == DIRNAME_SEPARATOR
))
3229 = (char *) xrealloc (string
, (strlen (string
) + to_len
+ 1));
3231 /* Relocate the current S pointer. */
3232 s
= s
- string
+ string_new
;
3233 string
= string_new
;
3235 /* Replace from by to. */
3236 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3237 memcpy (s
, to
, to_len
);
3252 /* SIGALRM handler for waitpid_with_timeout. */
3255 sigalrm_handler (int signo
)
3257 /* Nothing to do. */
3262 /* Wrapper to wait for child PID to die with TIMEOUT.
3263 TIMEOUT is the time to stop waiting in seconds.
3264 If TIMEOUT is zero, pass WNOHANG to waitpid.
3265 Returns PID if it was successfully waited for, otherwise -1.
3267 Timeouts are currently implemented with alarm and SIGALRM.
3268 If the host does not support them, this waits "forever".
3269 It would be odd though for a host to have waitpid and not SIGALRM. */
3272 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3274 pid_t waitpid_result
;
3276 gdb_assert (pid
> 0);
3277 gdb_assert (timeout
>= 0);
3282 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3283 struct sigaction sa
, old_sa
;
3285 sa
.sa_handler
= sigalrm_handler
;
3286 sigemptyset (&sa
.sa_mask
);
3288 sigaction (SIGALRM
, &sa
, &old_sa
);
3292 ofunc
= signal (SIGALRM
, sigalrm_handler
);
3298 waitpid_result
= waitpid (pid
, status
, 0);
3302 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3303 sigaction (SIGALRM
, &old_sa
, NULL
);
3305 signal (SIGALRM
, ofunc
);
3310 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3312 if (waitpid_result
== pid
)
3318 #endif /* HAVE_WAITPID */
3320 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3321 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3323 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3324 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3327 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3329 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3331 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3332 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3334 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3336 char *pattern_slash
, *string_slash
;
3338 /* Replace '\' by '/' in both strings. */
3340 pattern_slash
= (char *) alloca (strlen (pattern
) + 1);
3341 strcpy (pattern_slash
, pattern
);
3342 pattern
= pattern_slash
;
3343 for (; *pattern_slash
!= 0; pattern_slash
++)
3344 if (IS_DIR_SEPARATOR (*pattern_slash
))
3345 *pattern_slash
= '/';
3347 string_slash
= (char *) alloca (strlen (string
) + 1);
3348 strcpy (string_slash
, string
);
3349 string
= string_slash
;
3350 for (; *string_slash
!= 0; string_slash
++)
3351 if (IS_DIR_SEPARATOR (*string_slash
))
3352 *string_slash
= '/';
3354 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3356 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3357 flags
|= FNM_CASEFOLD
;
3358 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3360 return fnmatch (pattern
, string
, flags
);
3363 /* Return the number of path elements in PATH.
3371 count_path_elements (const char *path
)
3374 const char *p
= path
;
3376 if (HAS_DRIVE_SPEC (p
))
3378 p
= STRIP_DRIVE_SPEC (p
);
3384 if (IS_DIR_SEPARATOR (*p
))
3389 /* Backup one if last character is /, unless it's the only one. */
3390 if (p
> path
+ 1 && IS_DIR_SEPARATOR (p
[-1]))
3393 /* Add one for the file name, if present. */
3394 if (p
> path
&& !IS_DIR_SEPARATOR (p
[-1]))
3400 /* Remove N leading path elements from PATH.
3401 N must be non-negative.
3402 If PATH has more than N path elements then return NULL.
3403 If PATH has exactly N path elements then return "".
3404 See count_path_elements for a description of how we do the counting. */
3407 strip_leading_path_elements (const char *path
, int n
)
3410 const char *p
= path
;
3412 gdb_assert (n
>= 0);
3417 if (HAS_DRIVE_SPEC (p
))
3419 p
= STRIP_DRIVE_SPEC (p
);
3425 while (*p
!= '\0' && !IS_DIR_SEPARATOR (*p
))
3440 /* Provide a prototype to silence -Wmissing-prototypes. */
3441 extern initialize_file_ftype _initialize_utils
;
3444 _initialize_utils (void)
3446 add_internal_problem_command (&internal_error_problem
);
3447 add_internal_problem_command (&internal_warning_problem
);
3448 add_internal_problem_command (&demangler_warning_problem
);