1 /* General utility routines for GDB, the GNU debugger.
3 Copyright (C) 1986-2014 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 #include "dyn-string.h"
22 #include "gdb_assert.h"
26 #include "event-top.h"
27 #include "exceptions.h"
28 #include "gdbthread.h"
31 #ifdef HAVE_SYS_RESOURCE_H
32 #include <sys/resource.h>
33 #endif /* HAVE_SYS_RESOURCE_H */
36 #include "tui/tui.h" /* For tui_get_command_dimension. */
44 #include "timeval-utils.h"
49 #include "gdb-demangle.h"
50 #include "expression.h"
54 #include "filenames.h"
56 #include "gdb_obstack.h"
62 #include "inferior.h" /* for signed_pointer_to_address */
64 #include "gdb_curses.h"
66 #include "readline/readline.h"
71 #include "gdb_usleep.h"
73 #include "gdb_regex.h"
76 extern PTR
malloc (); /* ARI: PTR */
78 #if !HAVE_DECL_REALLOC
79 extern PTR
realloc (); /* ARI: PTR */
85 void (*deprecated_error_begin_hook
) (void);
87 /* Prototypes for local functions */
89 static void vfprintf_maybe_filtered (struct ui_file
*, const char *,
90 va_list, int) ATTRIBUTE_PRINTF (2, 0);
92 static void fputs_maybe_filtered (const char *, struct ui_file
*, int);
94 static void prompt_for_continue (void);
96 static void set_screen_size (void);
97 static void set_width (void);
99 /* Time spent in prompt_for_continue in the currently executing command
100 waiting for user to respond.
101 Initialized in make_command_stats_cleanup.
102 Modified in prompt_for_continue and defaulted_query.
103 Used in report_command_stats. */
105 static struct timeval prompt_for_continue_wait_time
;
107 /* A flag indicating whether to timestamp debugging messages. */
109 static int debug_timestamp
= 0;
111 /* Nonzero if we have job control. */
115 /* Nonzero means quit immediately if Control-C is typed now, rather
116 than waiting until QUIT is executed. Be careful in setting this;
117 code which executes with immediate_quit set has to be very careful
118 about being able to deal with being interrupted at any time. It is
119 almost always better to use QUIT; the only exception I can think of
120 is being able to quit out of a system call (using EINTR loses if
121 the SIGINT happens between the previous QUIT and the system call).
122 To immediately quit in the case in which a SIGINT happens between
123 the previous QUIT and setting immediate_quit (desirable anytime we
124 expect to block), call QUIT after setting immediate_quit. */
128 /* Nonzero means that strings with character values >0x7F should be printed
129 as octal escapes. Zero means just print the value (e.g. it's an
130 international character, and the terminal or window can cope.) */
132 int sevenbit_strings
= 0;
134 show_sevenbit_strings (struct ui_file
*file
, int from_tty
,
135 struct cmd_list_element
*c
, const char *value
)
137 fprintf_filtered (file
, _("Printing of 8-bit characters "
138 "in strings as \\nnn is %s.\n"),
142 /* String to be printed before warning messages, if any. */
144 char *warning_pre_print
= "\nwarning: ";
146 int pagination_enabled
= 1;
148 show_pagination_enabled (struct ui_file
*file
, int from_tty
,
149 struct cmd_list_element
*c
, const char *value
)
151 fprintf_filtered (file
, _("State of pagination is %s.\n"), value
);
155 /* Cleanup utilities.
157 These are not defined in cleanups.c (nor declared in cleanups.h)
158 because while they use the "cleanup API" they are not part of the
162 do_freeargv (void *arg
)
164 freeargv ((char **) arg
);
168 make_cleanup_freeargv (char **arg
)
170 return make_cleanup (do_freeargv
, arg
);
174 do_dyn_string_delete (void *arg
)
176 dyn_string_delete ((dyn_string_t
) arg
);
180 make_cleanup_dyn_string_delete (dyn_string_t arg
)
182 return make_cleanup (do_dyn_string_delete
, arg
);
186 do_bfd_close_cleanup (void *arg
)
192 make_cleanup_bfd_unref (bfd
*abfd
)
194 return make_cleanup (do_bfd_close_cleanup
, abfd
);
198 do_close_cleanup (void *arg
)
206 make_cleanup_close (int fd
)
208 int *saved_fd
= xmalloc (sizeof (fd
));
211 return make_cleanup_dtor (do_close_cleanup
, saved_fd
, xfree
);
214 /* Helper function which does the work for make_cleanup_fclose. */
217 do_fclose_cleanup (void *arg
)
224 /* Return a new cleanup that closes FILE. */
227 make_cleanup_fclose (FILE *file
)
229 return make_cleanup (do_fclose_cleanup
, file
);
232 /* Helper function which does the work for make_cleanup_obstack_free. */
235 do_obstack_free (void *arg
)
237 struct obstack
*ob
= arg
;
239 obstack_free (ob
, NULL
);
242 /* Return a new cleanup that frees OBSTACK. */
245 make_cleanup_obstack_free (struct obstack
*obstack
)
247 return make_cleanup (do_obstack_free
, obstack
);
251 do_ui_file_delete (void *arg
)
253 ui_file_delete (arg
);
257 make_cleanup_ui_file_delete (struct ui_file
*arg
)
259 return make_cleanup (do_ui_file_delete
, arg
);
262 /* Helper function for make_cleanup_ui_out_redirect_pop. */
265 do_ui_out_redirect_pop (void *arg
)
267 struct ui_out
*uiout
= arg
;
269 if (ui_out_redirect (uiout
, NULL
) < 0)
270 warning (_("Cannot restore redirection of the current output protocol"));
273 /* Return a new cleanup that pops the last redirection by ui_out_redirect
274 with NULL parameter. */
277 make_cleanup_ui_out_redirect_pop (struct ui_out
*uiout
)
279 return make_cleanup (do_ui_out_redirect_pop
, uiout
);
283 do_free_section_addr_info (void *arg
)
285 free_section_addr_info (arg
);
289 make_cleanup_free_section_addr_info (struct section_addr_info
*addrs
)
291 return make_cleanup (do_free_section_addr_info
, addrs
);
294 struct restore_integer_closure
301 restore_integer (void *p
)
303 struct restore_integer_closure
*closure
= p
;
305 *(closure
->variable
) = closure
->value
;
308 /* Remember the current value of *VARIABLE and make it restored when
309 the cleanup is run. */
312 make_cleanup_restore_integer (int *variable
)
314 struct restore_integer_closure
*c
=
315 xmalloc (sizeof (struct restore_integer_closure
));
317 c
->variable
= variable
;
318 c
->value
= *variable
;
320 return make_cleanup_dtor (restore_integer
, (void *) c
, xfree
);
323 /* Remember the current value of *VARIABLE and make it restored when
324 the cleanup is run. */
327 make_cleanup_restore_uinteger (unsigned int *variable
)
329 return make_cleanup_restore_integer ((int *) variable
);
332 /* Helper for make_cleanup_unpush_target. */
335 do_unpush_target (void *arg
)
337 struct target_ops
*ops
= arg
;
342 /* Return a new cleanup that unpushes OPS. */
345 make_cleanup_unpush_target (struct target_ops
*ops
)
347 return make_cleanup (do_unpush_target
, ops
);
350 /* Helper for make_cleanup_htab_delete compile time checking the types. */
353 do_htab_delete_cleanup (void *htab_voidp
)
355 htab_t htab
= htab_voidp
;
360 /* Return a new cleanup that deletes HTAB. */
363 make_cleanup_htab_delete (htab_t htab
)
365 return make_cleanup (do_htab_delete_cleanup
, htab
);
368 struct restore_ui_file_closure
370 struct ui_file
**variable
;
371 struct ui_file
*value
;
375 do_restore_ui_file (void *p
)
377 struct restore_ui_file_closure
*closure
= p
;
379 *(closure
->variable
) = closure
->value
;
382 /* Remember the current value of *VARIABLE and make it restored when
383 the cleanup is run. */
386 make_cleanup_restore_ui_file (struct ui_file
**variable
)
388 struct restore_ui_file_closure
*c
= XNEW (struct restore_ui_file_closure
);
390 c
->variable
= variable
;
391 c
->value
= *variable
;
393 return make_cleanup_dtor (do_restore_ui_file
, (void *) c
, xfree
);
396 /* Helper for make_cleanup_value_free_to_mark. */
399 do_value_free_to_mark (void *value
)
401 value_free_to_mark ((struct value
*) value
);
404 /* Free all values allocated since MARK was obtained by value_mark
405 (except for those released) when the cleanup is run. */
408 make_cleanup_value_free_to_mark (struct value
*mark
)
410 return make_cleanup (do_value_free_to_mark
, mark
);
413 /* Helper for make_cleanup_value_free. */
416 do_value_free (void *value
)
424 make_cleanup_value_free (struct value
*value
)
426 return make_cleanup (do_value_free
, value
);
429 /* Helper for make_cleanup_free_so. */
432 do_free_so (void *arg
)
434 struct so_list
*so
= arg
;
439 /* Make cleanup handler calling free_so for SO. */
442 make_cleanup_free_so (struct so_list
*so
)
444 return make_cleanup (do_free_so
, so
);
447 /* Helper for make_cleanup_restore_current_language. */
450 do_restore_current_language (void *p
)
452 enum language saved_lang
= (uintptr_t) p
;
454 set_language (saved_lang
);
457 /* Remember the current value of CURRENT_LANGUAGE and make it restored when
458 the cleanup is run. */
461 make_cleanup_restore_current_language (void)
463 enum language saved_lang
= current_language
->la_language
;
465 return make_cleanup (do_restore_current_language
,
466 (void *) (uintptr_t) saved_lang
);
469 /* Helper function for make_cleanup_clear_parser_state. */
472 do_clear_parser_state (void *ptr
)
474 struct parser_state
**p
= (struct parser_state
**) ptr
;
479 /* Clean (i.e., set to NULL) the parser state variable P. */
482 make_cleanup_clear_parser_state (struct parser_state
**p
)
484 return make_cleanup (do_clear_parser_state
, (void *) p
);
487 /* This function is useful for cleanups.
491 old_chain = make_cleanup (free_current_contents, &foo);
493 to arrange to free the object thus allocated. */
496 free_current_contents (void *ptr
)
498 void **location
= ptr
;
500 if (location
== NULL
)
501 internal_error (__FILE__
, __LINE__
,
502 _("free_current_contents: NULL pointer"));
503 if (*location
!= NULL
)
512 /* Print a warning message. The first argument STRING is the warning
513 message, used as an fprintf format string, the second is the
514 va_list of arguments for that string. A warning is unfiltered (not
515 paginated) so that the user does not need to page through each
516 screen full of warnings when there are lots of them. */
519 vwarning (const char *string
, va_list args
)
521 if (deprecated_warning_hook
)
522 (*deprecated_warning_hook
) (string
, args
);
525 target_terminal_ours ();
526 wrap_here (""); /* Force out any buffered output. */
527 gdb_flush (gdb_stdout
);
528 if (warning_pre_print
)
529 fputs_unfiltered (warning_pre_print
, gdb_stderr
);
530 vfprintf_unfiltered (gdb_stderr
, string
, args
);
531 fprintf_unfiltered (gdb_stderr
, "\n");
536 /* Print a warning message.
537 The first argument STRING is the warning message, used as a fprintf string,
538 and the remaining args are passed as arguments to it.
539 The primary difference between warnings and errors is that a warning
540 does not force the return to command level. */
543 warning (const char *string
, ...)
547 va_start (args
, string
);
548 vwarning (string
, args
);
552 /* Print an error message and return to command level.
553 The first argument STRING is the error message, used as a fprintf string,
554 and the remaining args are passed as arguments to it. */
557 verror (const char *string
, va_list args
)
559 throw_verror (GENERIC_ERROR
, string
, args
);
563 error (const char *string
, ...)
567 va_start (args
, string
);
568 throw_verror (GENERIC_ERROR
, string
, args
);
572 /* Print an error message and quit.
573 The first argument STRING is the error message, used as a fprintf string,
574 and the remaining args are passed as arguments to it. */
577 vfatal (const char *string
, va_list args
)
579 throw_vfatal (string
, args
);
583 fatal (const char *string
, ...)
587 va_start (args
, string
);
588 throw_vfatal (string
, args
);
593 error_stream (struct ui_file
*stream
)
595 char *message
= ui_file_xstrdup (stream
, NULL
);
597 make_cleanup (xfree
, message
);
598 error (("%s"), message
);
601 /* Dump core trying to increase the core soft limit to hard limit first. */
606 #ifdef HAVE_SETRLIMIT
607 struct rlimit rlim
= { RLIM_INFINITY
, RLIM_INFINITY
};
609 setrlimit (RLIMIT_CORE
, &rlim
);
610 #endif /* HAVE_SETRLIMIT */
612 abort (); /* NOTE: GDB has only three calls to abort(). */
615 /* Check whether GDB will be able to dump core using the dump_core
619 can_dump_core (const char *reason
)
621 #ifdef HAVE_GETRLIMIT
624 /* Be quiet and assume we can dump if an error is returned. */
625 if (getrlimit (RLIMIT_CORE
, &rlim
) != 0)
628 if (rlim
.rlim_max
== 0)
630 fprintf_unfiltered (gdb_stderr
,
631 _("%s\nUnable to dump core, use `ulimit -c"
632 " unlimited' before executing GDB next time.\n"),
636 #endif /* HAVE_GETRLIMIT */
641 /* Allow the user to configure the debugger behavior with respect to
642 what to do when an internal problem is detected. */
644 const char internal_problem_ask
[] = "ask";
645 const char internal_problem_yes
[] = "yes";
646 const char internal_problem_no
[] = "no";
647 static const char *const internal_problem_modes
[] =
649 internal_problem_ask
,
650 internal_problem_yes
,
655 /* Print a message reporting an internal error/warning. Ask the user
656 if they want to continue, dump core, or just exit. Return
657 something to indicate a quit. */
659 struct internal_problem
662 const char *should_quit
;
663 const char *should_dump_core
;
666 /* Report a problem, internal to GDB, to the user. Once the problem
667 has been reported, and assuming GDB didn't quit, the caller can
668 either allow execution to resume or throw an error. */
670 static void ATTRIBUTE_PRINTF (4, 0)
671 internal_vproblem (struct internal_problem
*problem
,
672 const char *file
, int line
, const char *fmt
, va_list ap
)
678 struct cleanup
*cleanup
= make_cleanup (null_cleanup
, NULL
);
680 /* Don't allow infinite error/warning recursion. */
682 static char msg
[] = "Recursive internal problem.\n";
691 fputs_unfiltered (msg
, gdb_stderr
);
692 abort (); /* NOTE: GDB has only three calls to abort(). */
695 /* Newer GLIBC versions put the warn_unused_result attribute
696 on write, but this is one of those rare cases where
697 ignoring the return value is correct. Casting to (void)
698 does not fix this problem. This is the solution suggested
699 at http://gcc.gnu.org/bugzilla/show_bug.cgi?id=25509. */
700 if (write (STDERR_FILENO
, msg
, sizeof (msg
)) != sizeof (msg
))
701 abort (); /* NOTE: GDB has only three calls to abort(). */
706 /* Try to get the message out and at the start of a new line. */
707 target_terminal_ours ();
710 /* Create a string containing the full error/warning message. Need
711 to call query with this full string, as otherwize the reason
712 (error/warning) and question become separated. Format using a
713 style similar to a compiler error message. Include extra detail
714 so that the user knows that they are living on the edge. */
718 msg
= xstrvprintf (fmt
, ap
);
719 reason
= xstrprintf ("%s:%d: %s: %s\n"
720 "A problem internal to GDB has been detected,\n"
721 "further debugging may prove unreliable.",
722 file
, line
, problem
->name
, msg
);
724 make_cleanup (xfree
, reason
);
727 if (problem
->should_quit
== internal_problem_ask
)
729 /* Default (yes/batch case) is to quit GDB. When in batch mode
730 this lessens the likelihood of GDB going into an infinite
734 /* Emit the message and quit. */
735 fputs_unfiltered (reason
, gdb_stderr
);
736 fputs_unfiltered ("\n", gdb_stderr
);
740 quit_p
= query (_("%s\nQuit this debugging session? "), reason
);
742 else if (problem
->should_quit
== internal_problem_yes
)
744 else if (problem
->should_quit
== internal_problem_no
)
747 internal_error (__FILE__
, __LINE__
, _("bad switch"));
749 if (problem
->should_dump_core
== internal_problem_ask
)
751 if (!can_dump_core (reason
))
755 /* Default (yes/batch case) is to dump core. This leaves a GDB
756 `dropping' so that it is easier to see that something went
758 dump_core_p
= query (_("%s\nCreate a core file of GDB? "), reason
);
761 else if (problem
->should_dump_core
== internal_problem_yes
)
762 dump_core_p
= can_dump_core (reason
);
763 else if (problem
->should_dump_core
== internal_problem_no
)
766 internal_error (__FILE__
, __LINE__
, _("bad switch"));
779 #ifdef HAVE_WORKING_FORK
787 do_cleanups (cleanup
);
790 static struct internal_problem internal_error_problem
= {
791 "internal-error", internal_problem_ask
, internal_problem_ask
795 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
797 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
798 fatal (_("Command aborted."));
802 internal_error (const char *file
, int line
, const char *string
, ...)
806 va_start (ap
, string
);
807 internal_verror (file
, line
, string
, ap
);
811 static struct internal_problem internal_warning_problem
= {
812 "internal-warning", internal_problem_ask
, internal_problem_ask
816 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
818 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
822 internal_warning (const char *file
, int line
, const char *string
, ...)
826 va_start (ap
, string
);
827 internal_vwarning (file
, line
, string
, ap
);
831 /* Dummy functions to keep add_prefix_cmd happy. */
834 set_internal_problem_cmd (char *args
, int from_tty
)
839 show_internal_problem_cmd (char *args
, int from_tty
)
843 /* When GDB reports an internal problem (error or warning) it gives
844 the user the opportunity to quit GDB and/or create a core file of
845 the current debug session. This function registers a few commands
846 that make it possible to specify that GDB should always or never
847 quit or create a core file, without asking. The commands look
850 maint set PROBLEM-NAME quit ask|yes|no
851 maint show PROBLEM-NAME quit
852 maint set PROBLEM-NAME corefile ask|yes|no
853 maint show PROBLEM-NAME corefile
855 Where PROBLEM-NAME is currently "internal-error" or
856 "internal-warning". */
859 add_internal_problem_command (struct internal_problem
*problem
)
861 struct cmd_list_element
**set_cmd_list
;
862 struct cmd_list_element
**show_cmd_list
;
866 set_cmd_list
= xmalloc (sizeof (*set_cmd_list
));
867 show_cmd_list
= xmalloc (sizeof (*set_cmd_list
));
868 *set_cmd_list
= NULL
;
869 *show_cmd_list
= NULL
;
871 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
874 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
877 add_prefix_cmd ((char*) problem
->name
,
878 class_maintenance
, set_internal_problem_cmd
, set_doc
,
880 concat ("maintenance set ", problem
->name
, " ",
882 0/*allow-unknown*/, &maintenance_set_cmdlist
);
884 add_prefix_cmd ((char*) problem
->name
,
885 class_maintenance
, show_internal_problem_cmd
, show_doc
,
887 concat ("maintenance show ", problem
->name
, " ",
889 0/*allow-unknown*/, &maintenance_show_cmdlist
);
891 set_doc
= xstrprintf (_("Set whether GDB should quit "
892 "when an %s is detected"),
894 show_doc
= xstrprintf (_("Show whether GDB will quit "
895 "when an %s is detected"),
897 add_setshow_enum_cmd ("quit", class_maintenance
,
898 internal_problem_modes
,
899 &problem
->should_quit
,
911 set_doc
= xstrprintf (_("Set whether GDB should create a core "
912 "file of GDB when %s is detected"),
914 show_doc
= xstrprintf (_("Show whether GDB will create a core "
915 "file of GDB when %s is detected"),
917 add_setshow_enum_cmd ("corefile", class_maintenance
,
918 internal_problem_modes
,
919 &problem
->should_dump_core
,
932 /* Return a newly allocated string, containing the PREFIX followed
933 by the system error message for errno (separated by a colon).
935 The result must be deallocated after use. */
938 perror_string (const char *prefix
)
943 err
= safe_strerror (errno
);
944 combined
= (char *) xmalloc (strlen (err
) + strlen (prefix
) + 3);
945 strcpy (combined
, prefix
);
946 strcat (combined
, ": ");
947 strcat (combined
, err
);
952 /* Print the system error message for errno, and also mention STRING
953 as the file name for which the error was encountered. Use ERRCODE
954 for the thrown exception. Then return to command level. */
957 throw_perror_with_name (enum errors errcode
, const char *string
)
961 combined
= perror_string (string
);
962 make_cleanup (xfree
, combined
);
964 /* I understand setting these is a matter of taste. Still, some people
965 may clear errno but not know about bfd_error. Doing this here is not
967 bfd_set_error (bfd_error_no_error
);
970 throw_error (errcode
, _("%s."), combined
);
973 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
976 perror_with_name (const char *string
)
978 throw_perror_with_name (GENERIC_ERROR
, string
);
981 /* Same as perror_with_name except that it prints a warning instead
982 of throwing an error. */
985 perror_warning_with_name (const char *string
)
989 combined
= perror_string (string
);
990 warning (_("%s"), combined
);
994 /* Print the system error message for ERRCODE, and also mention STRING
995 as the file name for which the error was encountered. */
998 print_sys_errmsg (const char *string
, int errcode
)
1003 err
= safe_strerror (errcode
);
1004 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
1005 strcpy (combined
, string
);
1006 strcat (combined
, ": ");
1007 strcat (combined
, err
);
1009 /* We want anything which was printed on stdout to come out first, before
1011 gdb_flush (gdb_stdout
);
1012 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
1015 /* Control C eventually causes this to be called, at a convenient time. */
1020 if (sync_quit_force_run
)
1022 sync_quit_force_run
= 0;
1023 quit_force (NULL
, stdin
== instream
);
1027 /* No steenking SIGINT will ever be coming our way when the
1028 program is resumed. Don't lie. */
1032 /* If there is no terminal switching for this target, then we can't
1033 possibly get screwed by the lack of job control. */
1034 || current_target
.to_terminal_ours
== NULL
)
1037 fatal ("Quit (expect signal SIGINT when the program is resumed)");
1042 /* Called when a memory allocation fails, with the number of bytes of
1043 memory requested in SIZE. */
1046 malloc_failure (long size
)
1050 internal_error (__FILE__
, __LINE__
,
1051 _("virtual memory exhausted: can't allocate %ld bytes."),
1056 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
1060 /* My replacement for the read system call.
1061 Used like `read' but keeps going if `read' returns too soon. */
1064 myread (int desc
, char *addr
, int len
)
1071 val
= read (desc
, addr
, len
);
1075 return orglen
- len
;
1083 print_spaces (int n
, struct ui_file
*file
)
1085 fputs_unfiltered (n_spaces (n
), file
);
1088 /* Print a host address. */
1091 gdb_print_host_address (const void *addr
, struct ui_file
*stream
)
1093 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
1097 /* A cleanup function that calls regfree. */
1100 do_regfree_cleanup (void *r
)
1105 /* Create a new cleanup that frees the compiled regular expression R. */
1108 make_regfree_cleanup (regex_t
*r
)
1110 return make_cleanup (do_regfree_cleanup
, r
);
1113 /* Return an xmalloc'd error message resulting from a regular
1114 expression compilation failure. */
1117 get_regcomp_error (int code
, regex_t
*rx
)
1119 size_t length
= regerror (code
, rx
, NULL
, 0);
1120 char *result
= xmalloc (length
);
1122 regerror (code
, rx
, result
, length
);
1126 /* Compile a regexp and throw an exception on error. This returns a
1127 cleanup to free the resulting pattern on success. RX must not be
1131 compile_rx_or_error (regex_t
*pattern
, const char *rx
, const char *message
)
1135 gdb_assert (rx
!= NULL
);
1137 code
= regcomp (pattern
, rx
, REG_NOSUB
);
1140 char *err
= get_regcomp_error (code
, pattern
);
1142 make_cleanup (xfree
, err
);
1143 error (("%s: %s"), message
, err
);
1146 return make_regfree_cleanup (pattern
);
1151 /* This function supports the query, nquery, and yquery functions.
1152 Ask user a y-or-n question and return 0 if answer is no, 1 if
1153 answer is yes, or default the answer to the specified default
1154 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1155 default answer, or '\0' for no default.
1156 CTLSTR is the control string and should end in "? ". It should
1157 not say how to answer, because we do that.
1158 ARGS are the arguments passed along with the CTLSTR argument to
1161 static int ATTRIBUTE_PRINTF (1, 0)
1162 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
1168 char def_answer
, not_def_answer
;
1169 char *y_string
, *n_string
, *question
;
1170 /* Used to add duration we waited for user to respond to
1171 prompt_for_continue_wait_time. */
1172 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1174 /* Set up according to which answer is the default. */
1175 if (defchar
== '\0')
1179 not_def_answer
= 'N';
1183 else if (defchar
== 'y')
1187 not_def_answer
= 'N';
1195 not_def_answer
= 'Y';
1200 /* Automatically answer the default value if the user did not want
1201 prompts or the command was issued with the server prefix. */
1202 if (!confirm
|| server_command
)
1205 /* If input isn't coming from the user directly, just say what
1206 question we're asking, and then answer the default automatically. This
1207 way, important error messages don't get lost when talking to GDB
1209 if (! input_from_terminal_p ())
1212 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
1214 printf_filtered (_("(%s or %s) [answered %c; "
1215 "input not from terminal]\n"),
1216 y_string
, n_string
, def_answer
);
1217 gdb_flush (gdb_stdout
);
1222 if (deprecated_query_hook
)
1224 return deprecated_query_hook (ctlstr
, args
);
1227 /* Format the question outside of the loop, to avoid reusing args. */
1228 question
= xstrvprintf (ctlstr
, args
);
1230 /* Used for calculating time spend waiting for user. */
1231 gettimeofday (&prompt_started
, NULL
);
1235 wrap_here (""); /* Flush any buffered output. */
1236 gdb_flush (gdb_stdout
);
1238 if (annotation_level
> 1)
1239 printf_filtered (("\n\032\032pre-query\n"));
1241 fputs_filtered (question
, gdb_stdout
);
1242 printf_filtered (_("(%s or %s) "), y_string
, n_string
);
1244 if (annotation_level
> 1)
1245 printf_filtered (("\n\032\032query\n"));
1248 gdb_flush (gdb_stdout
);
1250 answer
= fgetc (stdin
);
1252 /* We expect fgetc to block until a character is read. But
1253 this may not be the case if the terminal was opened with
1254 the NONBLOCK flag. In that case, if there is nothing to
1255 read on stdin, fgetc returns EOF, but also sets the error
1256 condition flag on stdin and errno to EAGAIN. With a true
1257 EOF, stdin's error condition flag is not set.
1259 A situation where this behavior was observed is a pseudo
1261 while (answer
== EOF
&& ferror (stdin
) && errno
== EAGAIN
)
1263 /* Not a real EOF. Wait a little while and try again until
1264 we read something. */
1267 answer
= fgetc (stdin
);
1270 clearerr (stdin
); /* in case of C-d */
1271 if (answer
== EOF
) /* C-d */
1273 printf_filtered ("EOF [assumed %c]\n", def_answer
);
1277 /* Eat rest of input line, to EOF or newline. */
1281 ans2
= fgetc (stdin
);
1284 while (ans2
!= EOF
&& ans2
!= '\n' && ans2
!= '\r');
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' &&
1300 (answer
== '\n' || answer
== '\r' || answer
== EOF
)))
1305 /* Invalid entries are not defaulted and require another selection. */
1306 printf_filtered (_("Please answer %s or %s.\n"),
1307 y_string
, n_string
);
1310 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1311 gettimeofday (&prompt_ended
, NULL
);
1312 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1313 timeval_add (&prompt_for_continue_wait_time
,
1314 &prompt_for_continue_wait_time
, &prompt_delta
);
1317 if (annotation_level
> 1)
1318 printf_filtered (("\n\032\032post-query\n"));
1323 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1324 answer is yes, or 0 if answer is defaulted.
1325 Takes three args which are given to printf to print the question.
1326 The first, a control string, should end in "? ".
1327 It should not say how to answer, because we do that. */
1330 nquery (const char *ctlstr
, ...)
1335 va_start (args
, ctlstr
);
1336 ret
= defaulted_query (ctlstr
, 'n', args
);
1341 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1342 answer is yes, or 1 if answer is defaulted.
1343 Takes three args which are given to printf to print the question.
1344 The first, a control string, should end in "? ".
1345 It should not say how to answer, because we do that. */
1348 yquery (const char *ctlstr
, ...)
1353 va_start (args
, ctlstr
);
1354 ret
= defaulted_query (ctlstr
, 'y', args
);
1359 /* Ask user a y-or-n question and return 1 iff answer is yes.
1360 Takes three args which are given to printf to print the question.
1361 The first, a control string, should end in "? ".
1362 It should not say how to answer, because we do that. */
1365 query (const char *ctlstr
, ...)
1370 va_start (args
, ctlstr
);
1371 ret
= defaulted_query (ctlstr
, '\0', args
);
1376 /* A helper for parse_escape that converts a host character to a
1377 target character. C is the host character. If conversion is
1378 possible, then the target character is stored in *TARGET_C and the
1379 function returns 1. Otherwise, the function returns 0. */
1382 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1384 struct obstack host_data
;
1386 struct cleanup
*cleanups
;
1389 obstack_init (&host_data
);
1390 cleanups
= make_cleanup_obstack_free (&host_data
);
1392 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1393 (gdb_byte
*) &the_char
, 1, 1,
1394 &host_data
, translit_none
);
1396 if (obstack_object_size (&host_data
) == 1)
1399 *target_c
= *(char *) obstack_base (&host_data
);
1402 do_cleanups (cleanups
);
1406 /* Parse a C escape sequence. STRING_PTR points to a variable
1407 containing a pointer to the string to parse. That pointer
1408 should point to the character after the \. That pointer
1409 is updated past the characters we use. The value of the
1410 escape sequence is returned.
1412 A negative value means the sequence \ newline was seen,
1413 which is supposed to be equivalent to nothing at all.
1415 If \ is followed by a null character, we return a negative
1416 value and leave the string pointer pointing at the null character.
1418 If \ is followed by 000, we return 0 and leave the string pointer
1419 after the zeros. A value of 0 does not mean end of string. */
1422 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1424 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1425 int c
= *(*string_ptr
)++;
1444 int i
= host_hex_value (c
);
1449 if (isdigit (c
) && c
!= '8' && c
!= '9')
1453 i
+= host_hex_value (c
);
1489 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1490 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1491 " which has no equivalent\nin the `%s' character set."),
1492 c
, c
, target_charset (gdbarch
));
1496 /* Print the character C on STREAM as part of the contents of a literal
1497 string whose delimiter is QUOTER. Note that this routine should only
1498 be call for printing things which are independent of the language
1499 of the program being debugged. */
1502 printchar (int c
, void (*do_fputs
) (const char *, struct ui_file
*),
1503 void (*do_fprintf
) (struct ui_file
*, const char *, ...)
1504 ATTRIBUTE_FPTR_PRINTF_2
, struct ui_file
*stream
, int quoter
)
1506 c
&= 0xFF; /* Avoid sign bit follies */
1508 if (c
< 0x20 || /* Low control chars */
1509 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1510 (sevenbit_strings
&& c
>= 0x80))
1511 { /* high order bit set */
1515 do_fputs ("\\n", stream
);
1518 do_fputs ("\\b", stream
);
1521 do_fputs ("\\t", stream
);
1524 do_fputs ("\\f", stream
);
1527 do_fputs ("\\r", stream
);
1530 do_fputs ("\\e", stream
);
1533 do_fputs ("\\a", stream
);
1536 do_fprintf (stream
, "\\%.3o", (unsigned int) c
);
1542 if (c
== '\\' || c
== quoter
)
1543 do_fputs ("\\", stream
);
1544 do_fprintf (stream
, "%c", c
);
1548 /* Print the character C on STREAM as part of the contents of a
1549 literal string whose delimiter is QUOTER. Note that these routines
1550 should only be call for printing things which are independent of
1551 the language of the program being debugged. */
1554 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1557 printchar (*str
++, fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1561 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1564 printchar (*str
++, fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1568 fputstrn_filtered (const char *str
, int n
, int quoter
,
1569 struct ui_file
*stream
)
1573 for (i
= 0; i
< n
; i
++)
1574 printchar (str
[i
], fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1578 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1579 struct ui_file
*stream
)
1583 for (i
= 0; i
< n
; i
++)
1584 printchar (str
[i
], fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1588 /* Number of lines per page or UINT_MAX if paging is disabled. */
1589 static unsigned int lines_per_page
;
1591 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1592 struct cmd_list_element
*c
, const char *value
)
1594 fprintf_filtered (file
,
1595 _("Number of lines gdb thinks are in a page is %s.\n"),
1599 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1600 static unsigned int chars_per_line
;
1602 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1603 struct cmd_list_element
*c
, const char *value
)
1605 fprintf_filtered (file
,
1606 _("Number of characters gdb thinks "
1607 "are in a line is %s.\n"),
1611 /* Current count of lines printed on this page, chars on this line. */
1612 static unsigned int lines_printed
, chars_printed
;
1614 /* Buffer and start column of buffered text, for doing smarter word-
1615 wrapping. When someone calls wrap_here(), we start buffering output
1616 that comes through fputs_filtered(). If we see a newline, we just
1617 spit it out and forget about the wrap_here(). If we see another
1618 wrap_here(), we spit it out and remember the newer one. If we see
1619 the end of the line, we spit out a newline, the indent, and then
1620 the buffered output. */
1622 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1623 are waiting to be output (they have already been counted in chars_printed).
1624 When wrap_buffer[0] is null, the buffer is empty. */
1625 static char *wrap_buffer
;
1627 /* Pointer in wrap_buffer to the next character to fill. */
1628 static char *wrap_pointer
;
1630 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1632 static char *wrap_indent
;
1634 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1635 is not in effect. */
1636 static int wrap_column
;
1639 /* Inialize the number of lines per page and chars per line. */
1642 init_page_info (void)
1646 lines_per_page
= UINT_MAX
;
1647 chars_per_line
= UINT_MAX
;
1651 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1656 #if defined(__GO32__)
1657 rows
= ScreenRows ();
1658 cols
= ScreenCols ();
1659 lines_per_page
= rows
;
1660 chars_per_line
= cols
;
1662 /* Make sure Readline has initialized its terminal settings. */
1663 rl_reset_terminal (NULL
);
1665 /* Get the screen size from Readline. */
1666 rl_get_screen_size (&rows
, &cols
);
1667 lines_per_page
= rows
;
1668 chars_per_line
= cols
;
1670 /* Readline should have fetched the termcap entry for us.
1671 Only try to use tgetnum function if rl_get_screen_size
1672 did not return a useful value. */
1673 if (((rows
<= 0) && (tgetnum ("li") < 0))
1674 /* Also disable paging if inside EMACS. */
1675 || getenv ("EMACS"))
1677 /* The number of lines per page is not mentioned in the terminal
1678 description or EMACS evironment variable is set. This probably
1679 means that paging is not useful, so disable paging. */
1680 lines_per_page
= UINT_MAX
;
1683 /* If the output is not a terminal, don't paginate it. */
1684 if (!ui_file_isatty (gdb_stdout
))
1685 lines_per_page
= UINT_MAX
;
1693 /* Helper for make_cleanup_restore_page_info. */
1696 do_restore_page_info_cleanup (void *arg
)
1702 /* Provide cleanup for restoring the terminal size. */
1705 make_cleanup_restore_page_info (void)
1707 struct cleanup
*back_to
;
1709 back_to
= make_cleanup (do_restore_page_info_cleanup
, NULL
);
1710 make_cleanup_restore_uinteger (&lines_per_page
);
1711 make_cleanup_restore_uinteger (&chars_per_line
);
1716 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1717 Provide cleanup for restoring the original state. */
1720 set_batch_flag_and_make_cleanup_restore_page_info (void)
1722 struct cleanup
*back_to
= make_cleanup_restore_page_info ();
1724 make_cleanup_restore_integer (&batch_flag
);
1731 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1734 set_screen_size (void)
1736 int rows
= lines_per_page
;
1737 int cols
= chars_per_line
;
1745 /* Update Readline's idea of the terminal size. */
1746 rl_set_screen_size (rows
, cols
);
1749 /* Reinitialize WRAP_BUFFER according to the current value of
1755 if (chars_per_line
== 0)
1760 wrap_buffer
= (char *) xmalloc (chars_per_line
+ 2);
1761 wrap_buffer
[0] = '\0';
1764 wrap_buffer
= (char *) xrealloc (wrap_buffer
, chars_per_line
+ 2);
1765 wrap_pointer
= wrap_buffer
; /* Start it at the beginning. */
1769 set_width_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1776 set_height_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1781 /* Wait, so the user can read what's on the screen. Prompt the user
1782 to continue by pressing RETURN. */
1785 prompt_for_continue (void)
1788 char cont_prompt
[120];
1789 /* Used to add duration we waited for user to respond to
1790 prompt_for_continue_wait_time. */
1791 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1793 gettimeofday (&prompt_started
, NULL
);
1795 if (annotation_level
> 1)
1796 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1798 strcpy (cont_prompt
,
1799 "---Type <return> to continue, or q <return> to quit---");
1800 if (annotation_level
> 1)
1801 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1803 /* We must do this *before* we call gdb_readline, else it will eventually
1804 call us -- thinking that we're trying to print beyond the end of the
1806 reinitialize_more_filter ();
1810 /* On a real operating system, the user can quit with SIGINT.
1813 'q' is provided on all systems so users don't have to change habits
1814 from system to system, and because telling them what to do in
1815 the prompt is more user-friendly than expecting them to think of
1817 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1818 whereas control-C to gdb_readline will cause the user to get dumped
1820 ignore
= gdb_readline_wrapper (cont_prompt
);
1822 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1823 gettimeofday (&prompt_ended
, NULL
);
1824 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1825 timeval_add (&prompt_for_continue_wait_time
,
1826 &prompt_for_continue_wait_time
, &prompt_delta
);
1828 if (annotation_level
> 1)
1829 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1835 while (*p
== ' ' || *p
== '\t')
1843 /* Now we have to do this again, so that GDB will know that it doesn't
1844 need to save the ---Type <return>--- line at the top of the screen. */
1845 reinitialize_more_filter ();
1847 dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */
1850 /* Initalize timer to keep track of how long we waited for the user. */
1853 reset_prompt_for_continue_wait_time (void)
1855 static const struct timeval zero_timeval
= { 0 };
1857 prompt_for_continue_wait_time
= zero_timeval
;
1860 /* Fetch the cumulative time spent in prompt_for_continue. */
1863 get_prompt_for_continue_wait_time (void)
1865 return prompt_for_continue_wait_time
;
1868 /* Reinitialize filter; ie. tell it to reset to original values. */
1871 reinitialize_more_filter (void)
1877 /* Indicate that if the next sequence of characters overflows the line,
1878 a newline should be inserted here rather than when it hits the end.
1879 If INDENT is non-null, it is a string to be printed to indent the
1880 wrapped part on the next line. INDENT must remain accessible until
1881 the next call to wrap_here() or until a newline is printed through
1884 If the line is already overfull, we immediately print a newline and
1885 the indentation, and disable further wrapping.
1887 If we don't know the width of lines, but we know the page height,
1888 we must not wrap words, but should still keep track of newlines
1889 that were explicitly printed.
1891 INDENT should not contain tabs, as that will mess up the char count
1892 on the next line. FIXME.
1894 This routine is guaranteed to force out any output which has been
1895 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1896 used to force out output from the wrap_buffer. */
1899 wrap_here (char *indent
)
1901 /* This should have been allocated, but be paranoid anyway. */
1903 internal_error (__FILE__
, __LINE__
,
1904 _("failed internal consistency check"));
1908 *wrap_pointer
= '\0';
1909 fputs_unfiltered (wrap_buffer
, gdb_stdout
);
1911 wrap_pointer
= wrap_buffer
;
1912 wrap_buffer
[0] = '\0';
1913 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1917 else if (chars_printed
>= chars_per_line
)
1919 puts_filtered ("\n");
1921 puts_filtered (indent
);
1926 wrap_column
= chars_printed
;
1930 wrap_indent
= indent
;
1934 /* Print input string to gdb_stdout, filtered, with wrap,
1935 arranging strings in columns of n chars. String can be
1936 right or left justified in the column. Never prints
1937 trailing spaces. String should never be longer than
1938 width. FIXME: this could be useful for the EXAMINE
1939 command, which currently doesn't tabulate very well. */
1942 puts_filtered_tabular (char *string
, int width
, int right
)
1948 gdb_assert (chars_per_line
> 0);
1949 if (chars_per_line
== UINT_MAX
)
1951 fputs_filtered (string
, gdb_stdout
);
1952 fputs_filtered ("\n", gdb_stdout
);
1956 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1957 fputs_filtered ("\n", gdb_stdout
);
1959 if (width
>= chars_per_line
)
1960 width
= chars_per_line
- 1;
1962 stringlen
= strlen (string
);
1964 if (chars_printed
> 0)
1965 spaces
= width
- (chars_printed
- 1) % width
- 1;
1967 spaces
+= width
- stringlen
;
1969 spacebuf
= alloca (spaces
+ 1);
1970 spacebuf
[spaces
] = '\0';
1972 spacebuf
[spaces
] = ' ';
1974 fputs_filtered (spacebuf
, gdb_stdout
);
1975 fputs_filtered (string
, gdb_stdout
);
1979 /* Ensure that whatever gets printed next, using the filtered output
1980 commands, starts at the beginning of the line. I.e. if there is
1981 any pending output for the current line, flush it and start a new
1982 line. Otherwise do nothing. */
1987 if (chars_printed
> 0)
1989 puts_filtered ("\n");
1994 /* Like fputs but if FILTER is true, pause after every screenful.
1996 Regardless of FILTER can wrap at points other than the final
1997 character of a line.
1999 Unlike fputs, fputs_maybe_filtered does not return a value.
2000 It is OK for LINEBUFFER to be NULL, in which case just don't print
2003 Note that a longjmp to top level may occur in this routine (only if
2004 FILTER is true) (since prompt_for_continue may do so) so this
2005 routine should not be called when cleanups are not in place. */
2008 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
2011 const char *lineptr
;
2013 if (linebuffer
== 0)
2016 /* Don't do any filtering if it is disabled. */
2017 if (stream
!= gdb_stdout
2018 || !pagination_enabled
2020 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
2021 || top_level_interpreter () == NULL
2022 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2024 fputs_unfiltered (linebuffer
, stream
);
2028 /* Go through and output each character. Show line extension
2029 when this is necessary; prompt user for new page when this is
2032 lineptr
= linebuffer
;
2035 /* Possible new page. */
2036 if (filter
&& (lines_printed
>= lines_per_page
- 1))
2037 prompt_for_continue ();
2039 while (*lineptr
&& *lineptr
!= '\n')
2041 /* Print a single line. */
2042 if (*lineptr
== '\t')
2045 *wrap_pointer
++ = '\t';
2047 fputc_unfiltered ('\t', stream
);
2048 /* Shifting right by 3 produces the number of tab stops
2049 we have already passed, and then adding one and
2050 shifting left 3 advances to the next tab stop. */
2051 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
2057 *wrap_pointer
++ = *lineptr
;
2059 fputc_unfiltered (*lineptr
, stream
);
2064 if (chars_printed
>= chars_per_line
)
2066 unsigned int save_chars
= chars_printed
;
2070 /* If we aren't actually wrapping, don't output newline --
2071 if chars_per_line is right, we probably just overflowed
2072 anyway; if it's wrong, let us keep going. */
2074 fputc_unfiltered ('\n', stream
);
2076 /* Possible new page. */
2077 if (lines_printed
>= lines_per_page
- 1)
2078 prompt_for_continue ();
2080 /* Now output indentation and wrapped string. */
2083 fputs_unfiltered (wrap_indent
, stream
);
2084 *wrap_pointer
= '\0'; /* Null-terminate saved stuff, */
2085 fputs_unfiltered (wrap_buffer
, stream
); /* and eject it. */
2086 /* FIXME, this strlen is what prevents wrap_indent from
2087 containing tabs. However, if we recurse to print it
2088 and count its chars, we risk trouble if wrap_indent is
2089 longer than (the user settable) chars_per_line.
2090 Note also that this can set chars_printed > chars_per_line
2091 if we are printing a long string. */
2092 chars_printed
= strlen (wrap_indent
)
2093 + (save_chars
- wrap_column
);
2094 wrap_pointer
= wrap_buffer
; /* Reset buffer */
2095 wrap_buffer
[0] = '\0';
2096 wrap_column
= 0; /* And disable fancy wrap */
2101 if (*lineptr
== '\n')
2104 wrap_here ((char *) 0); /* Spit out chars, cancel
2107 fputc_unfiltered ('\n', stream
);
2114 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
2116 fputs_maybe_filtered (linebuffer
, stream
, 1);
2120 putchar_unfiltered (int c
)
2124 ui_file_write (gdb_stdout
, &buf
, 1);
2128 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2129 May return nonlocally. */
2132 putchar_filtered (int c
)
2134 return fputc_filtered (c
, gdb_stdout
);
2138 fputc_unfiltered (int c
, struct ui_file
*stream
)
2142 ui_file_write (stream
, &buf
, 1);
2147 fputc_filtered (int c
, struct ui_file
*stream
)
2153 fputs_filtered (buf
, stream
);
2157 /* puts_debug is like fputs_unfiltered, except it prints special
2158 characters in printable fashion. */
2161 puts_debug (char *prefix
, char *string
, char *suffix
)
2165 /* Print prefix and suffix after each line. */
2166 static int new_line
= 1;
2167 static int return_p
= 0;
2168 static char *prev_prefix
= "";
2169 static char *prev_suffix
= "";
2171 if (*string
== '\n')
2174 /* If the prefix is changing, print the previous suffix, a new line,
2175 and the new prefix. */
2176 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
2178 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
2179 fputs_unfiltered ("\n", gdb_stdlog
);
2180 fputs_unfiltered (prefix
, gdb_stdlog
);
2183 /* Print prefix if we printed a newline during the previous call. */
2187 fputs_unfiltered (prefix
, gdb_stdlog
);
2190 prev_prefix
= prefix
;
2191 prev_suffix
= suffix
;
2193 /* Output characters in a printable format. */
2194 while ((ch
= *string
++) != '\0')
2200 fputc_unfiltered (ch
, gdb_stdlog
);
2203 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2207 fputs_unfiltered ("\\\\", gdb_stdlog
);
2210 fputs_unfiltered ("\\b", gdb_stdlog
);
2213 fputs_unfiltered ("\\f", gdb_stdlog
);
2217 fputs_unfiltered ("\\n", gdb_stdlog
);
2220 fputs_unfiltered ("\\r", gdb_stdlog
);
2223 fputs_unfiltered ("\\t", gdb_stdlog
);
2226 fputs_unfiltered ("\\v", gdb_stdlog
);
2230 return_p
= ch
== '\r';
2233 /* Print suffix if we printed a newline. */
2236 fputs_unfiltered (suffix
, gdb_stdlog
);
2237 fputs_unfiltered ("\n", gdb_stdlog
);
2242 /* Print a variable number of ARGS using format FORMAT. If this
2243 information is going to put the amount written (since the last call
2244 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2245 call prompt_for_continue to get the users permision to continue.
2247 Unlike fprintf, this function does not return a value.
2249 We implement three variants, vfprintf (takes a vararg list and stream),
2250 fprintf (takes a stream to write on), and printf (the usual).
2252 Note also that a longjmp to top level may occur in this routine
2253 (since prompt_for_continue may do so) so this routine should not be
2254 called when cleanups are not in place. */
2257 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2258 va_list args
, int filter
)
2261 struct cleanup
*old_cleanups
;
2263 linebuffer
= xstrvprintf (format
, args
);
2264 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2265 fputs_maybe_filtered (linebuffer
, stream
, filter
);
2266 do_cleanups (old_cleanups
);
2271 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2273 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2277 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2280 struct cleanup
*old_cleanups
;
2282 linebuffer
= xstrvprintf (format
, args
);
2283 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2284 if (debug_timestamp
&& stream
== gdb_stdlog
)
2290 gettimeofday (&tm
, NULL
);
2292 len
= strlen (linebuffer
);
2293 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2295 timestamp
= xstrprintf ("%ld:%ld %s%s",
2296 (long) tm
.tv_sec
, (long) tm
.tv_usec
,
2298 need_nl
? "\n": "");
2299 make_cleanup (xfree
, timestamp
);
2300 fputs_unfiltered (timestamp
, stream
);
2303 fputs_unfiltered (linebuffer
, stream
);
2304 do_cleanups (old_cleanups
);
2308 vprintf_filtered (const char *format
, va_list args
)
2310 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2314 vprintf_unfiltered (const char *format
, va_list args
)
2316 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2320 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2324 va_start (args
, format
);
2325 vfprintf_filtered (stream
, format
, args
);
2330 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2334 va_start (args
, format
);
2335 vfprintf_unfiltered (stream
, format
, args
);
2339 /* Like fprintf_filtered, but prints its result indented.
2340 Called as fprintfi_filtered (spaces, stream, format, ...); */
2343 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2348 va_start (args
, format
);
2349 print_spaces_filtered (spaces
, stream
);
2351 vfprintf_filtered (stream
, format
, args
);
2357 printf_filtered (const char *format
, ...)
2361 va_start (args
, format
);
2362 vfprintf_filtered (gdb_stdout
, format
, args
);
2368 printf_unfiltered (const char *format
, ...)
2372 va_start (args
, format
);
2373 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2377 /* Like printf_filtered, but prints it's result indented.
2378 Called as printfi_filtered (spaces, format, ...); */
2381 printfi_filtered (int spaces
, const char *format
, ...)
2385 va_start (args
, format
);
2386 print_spaces_filtered (spaces
, gdb_stdout
);
2387 vfprintf_filtered (gdb_stdout
, format
, args
);
2391 /* Easy -- but watch out!
2393 This routine is *not* a replacement for puts()! puts() appends a newline.
2394 This one doesn't, and had better not! */
2397 puts_filtered (const char *string
)
2399 fputs_filtered (string
, gdb_stdout
);
2403 puts_unfiltered (const char *string
)
2405 fputs_unfiltered (string
, gdb_stdout
);
2408 /* Return a pointer to N spaces and a null. The pointer is good
2409 until the next call to here. */
2414 static char *spaces
= 0;
2415 static int max_spaces
= -1;
2421 spaces
= (char *) xmalloc (n
+ 1);
2422 for (t
= spaces
+ n
; t
!= spaces
;)
2428 return spaces
+ max_spaces
- n
;
2431 /* Print N spaces. */
2433 print_spaces_filtered (int n
, struct ui_file
*stream
)
2435 fputs_filtered (n_spaces (n
), stream
);
2438 /* C++/ObjC demangler stuff. */
2440 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2441 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2442 If the name is not mangled, or the language for the name is unknown, or
2443 demangling is off, the name is printed in its "raw" form. */
2446 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2447 enum language lang
, int arg_mode
)
2453 /* If user wants to see raw output, no problem. */
2456 fputs_filtered (name
, stream
);
2460 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2461 fputs_filtered (demangled
? demangled
: name
, stream
);
2462 if (demangled
!= NULL
)
2470 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2471 differences in whitespace. Returns 0 if they match, non-zero if they
2472 don't (slightly different than strcmp()'s range of return values).
2474 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2475 This "feature" is useful when searching for matching C++ function names
2476 (such as if the user types 'break FOO', where FOO is a mangled C++
2480 strcmp_iw (const char *string1
, const char *string2
)
2482 while ((*string1
!= '\0') && (*string2
!= '\0'))
2484 while (isspace (*string1
))
2488 while (isspace (*string2
))
2492 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2494 if (case_sensitivity
== case_sensitive_off
2495 && (tolower ((unsigned char) *string1
)
2496 != tolower ((unsigned char) *string2
)))
2498 if (*string1
!= '\0')
2504 return (*string1
!= '\0' && *string1
!= '(') || (*string2
!= '\0');
2507 /* This is like strcmp except that it ignores whitespace and treats
2508 '(' as the first non-NULL character in terms of ordering. Like
2509 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2510 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2511 according to that ordering.
2513 If a list is sorted according to this function and if you want to
2514 find names in the list that match some fixed NAME according to
2515 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2516 where this function would put NAME.
2518 This function must be neutral to the CASE_SENSITIVITY setting as the user
2519 may choose it during later lookup. Therefore this function always sorts
2520 primarily case-insensitively and secondarily case-sensitively.
2522 Here are some examples of why using strcmp to sort is a bad idea:
2526 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2527 we try to do a search for "foo<char*>", strcmp will locate this
2528 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2529 will start looking at strings beginning with "goo", and will never
2530 see the correct match of "foo<char *>".
2532 Parenthesis example:
2534 In practice, this is less like to be an issue, but I'll give it a
2535 shot. Let's assume that '$' is a legitimate character to occur in
2536 symbols. (Which may well even be the case on some systems.) Then
2537 say that the partial symbol table contains "foo$" and "foo(int)".
2538 strcmp will put them in this order, since '$' < '('. Now, if the
2539 user searches for "foo", then strcmp will sort "foo" before "foo$".
2540 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2541 "foo") is false, so it won't proceed to the actual match of
2542 "foo(int)" with "foo". */
2545 strcmp_iw_ordered (const char *string1
, const char *string2
)
2547 const char *saved_string1
= string1
, *saved_string2
= string2
;
2548 enum case_sensitivity case_pass
= case_sensitive_off
;
2552 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2553 Provide stub characters if we are already at the end of one of the
2555 char c1
= 'X', c2
= 'X';
2557 while (*string1
!= '\0' && *string2
!= '\0')
2559 while (isspace (*string1
))
2561 while (isspace (*string2
))
2566 case case_sensitive_off
:
2567 c1
= tolower ((unsigned char) *string1
);
2568 c2
= tolower ((unsigned char) *string2
);
2570 case case_sensitive_on
:
2578 if (*string1
!= '\0')
2587 /* Characters are non-equal unless they're both '\0'; we want to
2588 make sure we get the comparison right according to our
2589 comparison in the cases where one of them is '\0' or '('. */
2591 if (*string2
== '\0')
2596 if (*string2
== '\0')
2601 if (*string2
== '\0' || *string2
== '(')
2610 if (case_pass
== case_sensitive_on
)
2613 /* Otherwise the strings were equal in case insensitive way, make
2614 a more fine grained comparison in a case sensitive way. */
2616 case_pass
= case_sensitive_on
;
2617 string1
= saved_string1
;
2618 string2
= saved_string2
;
2622 /* A simple comparison function with opposite semantics to strcmp. */
2625 streq (const char *lhs
, const char *rhs
)
2627 return !strcmp (lhs
, rhs
);
2633 ** Answer whether string_to_compare is a full or partial match to
2634 ** template_string. The partial match must be in sequence starting
2638 subset_compare (char *string_to_compare
, char *template_string
)
2642 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
2643 && strlen (string_to_compare
) <= strlen (template_string
))
2646 (template_string
, string_to_compare
, strlen (string_to_compare
)) == 0);
2653 pagination_on_command (char *arg
, int from_tty
)
2655 pagination_enabled
= 1;
2659 pagination_off_command (char *arg
, int from_tty
)
2661 pagination_enabled
= 0;
2665 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2666 struct cmd_list_element
*c
, const char *value
)
2668 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2674 initialize_utils (void)
2676 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
2677 Set number of characters where GDB should wrap lines of its output."), _("\
2678 Show number of characters where GDB should wrap lines of its output."), _("\
2679 This affects where GDB wraps its output to fit the screen width.\n\
2680 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2682 show_chars_per_line
,
2683 &setlist
, &showlist
);
2685 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
2686 Set number of lines in a page for GDB output pagination."), _("\
2687 Show number of lines in a page for GDB output pagination."), _("\
2688 This affects the number of lines after which GDB will pause\n\
2689 its output and ask you whether to continue.\n\
2690 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2692 show_lines_per_page
,
2693 &setlist
, &showlist
);
2697 add_setshow_boolean_cmd ("pagination", class_support
,
2698 &pagination_enabled
, _("\
2699 Set state of GDB output pagination."), _("\
2700 Show state of GDB output pagination."), _("\
2701 When pagination is ON, GDB pauses at end of each screenful of\n\
2702 its output and asks you whether to continue.\n\
2703 Turning pagination off is an alternative to \"set height unlimited\"."),
2705 show_pagination_enabled
,
2706 &setlist
, &showlist
);
2710 add_com ("am", class_support
, pagination_on_command
,
2711 _("Enable pagination"));
2712 add_com ("sm", class_support
, pagination_off_command
,
2713 _("Disable pagination"));
2716 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
2717 &sevenbit_strings
, _("\
2718 Set printing of 8-bit characters in strings as \\nnn."), _("\
2719 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
2721 show_sevenbit_strings
,
2722 &setprintlist
, &showprintlist
);
2724 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
2725 &debug_timestamp
, _("\
2726 Set timestamping of debugging messages."), _("\
2727 Show timestamping of debugging messages."), _("\
2728 When set, debugging messages will be marked with seconds and microseconds."),
2730 show_debug_timestamp
,
2731 &setdebuglist
, &showdebuglist
);
2735 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2737 /* Truncate address to the size of a target address, avoiding shifts
2738 larger or equal than the width of a CORE_ADDR. The local
2739 variable ADDR_BIT stops the compiler reporting a shift overflow
2740 when it won't occur. */
2741 /* NOTE: This assumes that the significant address information is
2742 kept in the least significant bits of ADDR - the upper bits were
2743 either zero or sign extended. Should gdbarch_address_to_pointer or
2744 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2746 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2748 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2749 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2750 return hex_string (addr
);
2753 /* This function is described in "defs.h". */
2756 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2758 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2760 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2761 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2763 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2764 that returns the language localized string formatted to a width
2765 based on gdbarch_addr_bit. */
2767 return hex_string_custom (address
, 8);
2769 return hex_string_custom (address
, 16);
2772 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2775 core_addr_hash (const void *ap
)
2777 const CORE_ADDR
*addrp
= ap
;
2782 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2785 core_addr_eq (const void *ap
, const void *bp
)
2787 const CORE_ADDR
*addr_ap
= ap
;
2788 const CORE_ADDR
*addr_bp
= bp
;
2790 return *addr_ap
== *addr_bp
;
2793 /* Convert a string back into a CORE_ADDR. */
2795 string_to_core_addr (const char *my_string
)
2799 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2801 /* Assume that it is in hex. */
2804 for (i
= 2; my_string
[i
] != '\0'; i
++)
2806 if (isdigit (my_string
[i
]))
2807 addr
= (my_string
[i
] - '0') + (addr
* 16);
2808 else if (isxdigit (my_string
[i
]))
2809 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2811 error (_("invalid hex \"%s\""), my_string
);
2816 /* Assume that it is in decimal. */
2819 for (i
= 0; my_string
[i
] != '\0'; i
++)
2821 if (isdigit (my_string
[i
]))
2822 addr
= (my_string
[i
] - '0') + (addr
* 10);
2824 error (_("invalid decimal \"%s\""), my_string
);
2832 gdb_realpath (const char *filename
)
2834 /* Method 1: The system has a compile time upper bound on a filename
2835 path. Use that and realpath() to canonicalize the name. This is
2836 the most common case. Note that, if there isn't a compile time
2837 upper bound, you want to avoid realpath() at all costs. */
2838 #if defined (HAVE_REALPATH) && defined (PATH_MAX)
2841 const char *rp
= realpath (filename
, buf
);
2845 return xstrdup (rp
);
2847 #endif /* HAVE_REALPATH */
2849 /* Method 2: The host system (i.e., GNU) has the function
2850 canonicalize_file_name() which malloc's a chunk of memory and
2851 returns that, use that. */
2852 #if defined(HAVE_CANONICALIZE_FILE_NAME)
2854 char *rp
= canonicalize_file_name (filename
);
2857 return xstrdup (filename
);
2863 /* FIXME: cagney/2002-11-13:
2865 Method 2a: Use realpath() with a NULL buffer. Some systems, due
2866 to the problems described in method 3, have modified their
2867 realpath() implementation so that it will allocate a buffer when
2868 NULL is passed in. Before this can be used, though, some sort of
2869 configure time test would need to be added. Otherwize the code
2870 will likely core dump. */
2872 /* Method 3: Now we're getting desperate! The system doesn't have a
2873 compile time buffer size and no alternative function. Query the
2874 OS, using pathconf(), for the buffer limit. Care is needed
2875 though, some systems do not limit PATH_MAX (return -1 for
2876 pathconf()) making it impossible to pass a correctly sized buffer
2877 to realpath() (it could always overflow). On those systems, we
2879 #if defined (HAVE_REALPATH) && defined (_PC_PATH_MAX) && defined(HAVE_ALLOCA)
2881 /* Find out the max path size. */
2882 long path_max
= pathconf ("/", _PC_PATH_MAX
);
2886 /* PATH_MAX is bounded. */
2887 char *buf
= alloca (path_max
);
2888 char *rp
= realpath (filename
, buf
);
2890 return xstrdup (rp
? rp
: filename
);
2895 /* The MS Windows method. If we don't have realpath, we assume we
2896 don't have symlinks and just canonicalize to a Windows absolute
2897 path. GetFullPath converts ../ and ./ in relative paths to
2898 absolute paths, filling in current drive if one is not given
2899 or using the current directory of a specified drive (eg, "E:foo").
2900 It also converts all forward slashes to back slashes. */
2901 /* The file system is case-insensitive but case-preserving.
2902 So we do not lowercase the path. Otherwise, we might not
2903 be able to display the original casing in a given path. */
2904 #if defined (_WIN32)
2907 DWORD len
= GetFullPathName (filename
, MAX_PATH
, buf
, NULL
);
2909 if (len
> 0 && len
< MAX_PATH
)
2910 return xstrdup (buf
);
2914 /* This system is a lost cause, just dup the buffer. */
2915 return xstrdup (filename
);
2918 /* Return a copy of FILENAME, with its directory prefix canonicalized
2922 gdb_realpath_keepfile (const char *filename
)
2924 const char *base_name
= lbasename (filename
);
2929 /* Extract the basename of filename, and return immediately
2930 a copy of filename if it does not contain any directory prefix. */
2931 if (base_name
== filename
)
2932 return xstrdup (filename
);
2934 dir_name
= alloca ((size_t) (base_name
- filename
+ 2));
2935 /* Allocate enough space to store the dir_name + plus one extra
2936 character sometimes needed under Windows (see below), and
2937 then the closing \000 character. */
2938 strncpy (dir_name
, filename
, base_name
- filename
);
2939 dir_name
[base_name
- filename
] = '\000';
2941 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
2942 /* We need to be careful when filename is of the form 'd:foo', which
2943 is equivalent of d:./foo, which is totally different from d:/foo. */
2944 if (strlen (dir_name
) == 2 && isalpha (dir_name
[0]) && dir_name
[1] == ':')
2947 dir_name
[3] = '\000';
2951 /* Canonicalize the directory prefix, and build the resulting
2952 filename. If the dirname realpath already contains an ending
2953 directory separator, avoid doubling it. */
2954 real_path
= gdb_realpath (dir_name
);
2955 if (IS_DIR_SEPARATOR (real_path
[strlen (real_path
) - 1]))
2956 result
= concat (real_path
, base_name
, (char *) NULL
);
2958 result
= concat (real_path
, SLASH_STRING
, base_name
, (char *) NULL
);
2964 /* Return PATH in absolute form, performing tilde-expansion if necessary.
2965 PATH cannot be NULL or the empty string.
2966 This does not resolve symlinks however, use gdb_realpath for that.
2967 Space for the result is allocated with malloc.
2968 If the path is already absolute, it is strdup'd.
2969 If there is a problem computing the absolute path, the path is returned
2970 unchanged (still strdup'd). */
2973 gdb_abspath (const char *path
)
2975 gdb_assert (path
!= NULL
&& path
[0] != '\0');
2978 return tilde_expand (path
);
2980 if (IS_ABSOLUTE_PATH (path
))
2981 return xstrdup (path
);
2983 /* Beware the // my son, the Emacs barfs, the botch that catch... */
2984 return concat (current_directory
,
2985 IS_DIR_SEPARATOR (current_directory
[strlen (current_directory
) - 1])
2986 ? "" : SLASH_STRING
,
2987 path
, (char *) NULL
);
2991 align_up (ULONGEST v
, int n
)
2993 /* Check that N is really a power of two. */
2994 gdb_assert (n
&& (n
& (n
-1)) == 0);
2995 return (v
+ n
- 1) & -n
;
2999 align_down (ULONGEST v
, int n
)
3001 /* Check that N is really a power of two. */
3002 gdb_assert (n
&& (n
& (n
-1)) == 0);
3009 gdb_sign_extend (LONGEST value
, int bit
)
3011 gdb_assert (bit
>= 1 && bit
<= 8 * sizeof (LONGEST
));
3013 if (((value
>> (bit
- 1)) & 1) != 0)
3015 LONGEST signbit
= ((LONGEST
) 1) << (bit
- 1);
3017 value
= (value
^ signbit
) - signbit
;
3023 /* Allocation function for the libiberty hash table which uses an
3024 obstack. The obstack is passed as DATA. */
3027 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
3029 unsigned int total
= size
* count
;
3030 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
3032 memset (ptr
, 0, total
);
3036 /* Trivial deallocation function for the libiberty splay tree and hash
3037 table - don't deallocate anything. Rely on later deletion of the
3038 obstack. DATA will be the obstack, although it is not needed
3042 dummy_obstack_deallocate (void *object
, void *data
)
3047 /* The bit offset of the highest byte in a ULONGEST, for overflow
3050 #define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT)
3052 /* True (non-zero) iff DIGIT is a valid digit in radix BASE,
3053 where 2 <= BASE <= 36. */
3056 is_digit_in_base (unsigned char digit
, int base
)
3058 if (!isalnum (digit
))
3061 return (isdigit (digit
) && digit
< base
+ '0');
3063 return (isdigit (digit
) || tolower (digit
) < base
- 10 + 'a');
3067 digit_to_int (unsigned char c
)
3072 return tolower (c
) - 'a' + 10;
3075 /* As for strtoul, but for ULONGEST results. */
3078 strtoulst (const char *num
, const char **trailer
, int base
)
3080 unsigned int high_part
;
3085 /* Skip leading whitespace. */
3086 while (isspace (num
[i
]))
3089 /* Handle prefixes. */
3092 else if (num
[i
] == '-')
3098 if (base
== 0 || base
== 16)
3100 if (num
[i
] == '0' && (num
[i
+ 1] == 'x' || num
[i
+ 1] == 'X'))
3108 if (base
== 0 && num
[i
] == '0')
3114 if (base
< 2 || base
> 36)
3120 result
= high_part
= 0;
3121 for (; is_digit_in_base (num
[i
], base
); i
+= 1)
3123 result
= result
* base
+ digit_to_int (num
[i
]);
3124 high_part
= high_part
* base
+ (unsigned int) (result
>> HIGH_BYTE_POSN
);
3125 result
&= ((ULONGEST
) 1 << HIGH_BYTE_POSN
) - 1;
3126 if (high_part
> 0xff)
3129 result
= ~ (ULONGEST
) 0;
3136 if (trailer
!= NULL
)
3139 result
= result
+ ((ULONGEST
) high_part
<< HIGH_BYTE_POSN
);
3146 /* Simple, portable version of dirname that does not modify its
3150 ldirname (const char *filename
)
3152 const char *base
= lbasename (filename
);
3155 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
3158 if (base
== filename
)
3161 dirname
= xmalloc (base
- filename
+ 2);
3162 memcpy (dirname
, filename
, base
- filename
);
3164 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3165 create "d:./bar" later instead of the (different) "d:/bar". */
3166 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3167 && !IS_DIR_SEPARATOR (filename
[0]))
3168 dirname
[base
++ - filename
] = '.';
3170 dirname
[base
- filename
] = '\0';
3174 /* Call libiberty's buildargv, and return the result.
3175 If buildargv fails due to out-of-memory, call nomem.
3176 Therefore, the returned value is guaranteed to be non-NULL,
3177 unless the parameter itself is NULL. */
3180 gdb_buildargv (const char *s
)
3182 char **argv
= buildargv (s
);
3184 if (s
!= NULL
&& argv
== NULL
)
3190 compare_positive_ints (const void *ap
, const void *bp
)
3192 /* Because we know we're comparing two ints which are positive,
3193 there's no danger of overflow here. */
3194 return * (int *) ap
- * (int *) bp
;
3197 /* String compare function for qsort. */
3200 compare_strings (const void *arg1
, const void *arg2
)
3202 const char **s1
= (const char **) arg1
;
3203 const char **s2
= (const char **) arg2
;
3205 return strcmp (*s1
, *s2
);
3208 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3209 #define AMBIGUOUS_MESS2 \
3210 ".\nUse \"set gnutarget format-name\" to specify the format."
3213 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3219 /* Check if errmsg just need simple return. */
3220 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3221 return bfd_errmsg (error_tag
);
3223 ret_len
= strlen (bfd_errmsg (error_tag
)) + strlen (AMBIGUOUS_MESS1
)
3224 + strlen (AMBIGUOUS_MESS2
);
3225 for (p
= matching
; *p
; p
++)
3226 ret_len
+= strlen (*p
) + 1;
3227 ret
= xmalloc (ret_len
+ 1);
3229 make_cleanup (xfree
, ret
);
3231 strcpy (retp
, bfd_errmsg (error_tag
));
3232 retp
+= strlen (retp
);
3234 strcpy (retp
, AMBIGUOUS_MESS1
);
3235 retp
+= strlen (retp
);
3237 for (p
= matching
; *p
; p
++)
3239 sprintf (retp
, " %s", *p
);
3240 retp
+= strlen (retp
);
3244 strcpy (retp
, AMBIGUOUS_MESS2
);
3249 /* Return ARGS parsed as a valid pid, or throw an error. */
3252 parse_pid_to_attach (char *args
)
3258 error_no_arg (_("process-id to attach"));
3261 pid
= strtoul (args
, &dummy
, 0);
3262 /* Some targets don't set errno on errors, grrr! */
3263 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3264 error (_("Illegal process-id: %s."), args
);
3269 /* Helper for make_bpstat_clear_actions_cleanup. */
3272 do_bpstat_clear_actions_cleanup (void *unused
)
3274 bpstat_clear_actions ();
3277 /* Call bpstat_clear_actions for the case an exception is throw. You should
3278 discard_cleanups if no exception is caught. */
3281 make_bpstat_clear_actions_cleanup (void)
3283 return make_cleanup (do_bpstat_clear_actions_cleanup
, NULL
);
3286 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3287 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3288 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3291 producer_is_gcc_ge_4 (const char *producer
)
3296 if (producer
== NULL
)
3298 /* For unknown compilers expect their behavior is not compliant. For GCC
3299 this case can also happen for -gdwarf-4 type units supported since
3305 /* Skip any identifier after "GNU " - such as "C++" or "Java". */
3307 if (strncmp (producer
, "GNU ", strlen ("GNU ")) != 0)
3309 /* For non-GCC compilers expect their behavior is not compliant. */
3313 cs
= &producer
[strlen ("GNU ")];
3314 while (*cs
&& !isdigit (*cs
))
3316 if (sscanf (cs
, "%d.%d", &major
, &minor
) != 2)
3318 /* Not recognized as GCC. */
3330 /* Helper for make_cleanup_free_char_ptr_vec. */
3333 do_free_char_ptr_vec (void *arg
)
3335 VEC (char_ptr
) *char_ptr_vec
= arg
;
3337 free_char_ptr_vec (char_ptr_vec
);
3340 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3341 final VEC_free for CHAR_PTR_VEC itself.
3343 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3344 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3345 this function does not (cannot) clear the pointer. */
3348 make_cleanup_free_char_ptr_vec (VEC (char_ptr
) *char_ptr_vec
)
3350 return make_cleanup (do_free_char_ptr_vec
, char_ptr_vec
);
3353 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3354 must come from xrealloc-compatible allocator and it may be updated. FROM
3355 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3356 located at the start or end of *STRINGP. */
3359 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3361 char *string
= *stringp
, *s
;
3362 const size_t from_len
= strlen (from
);
3363 const size_t to_len
= strlen (to
);
3367 s
= strstr (s
, from
);
3371 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3372 || s
[-1] == DIRNAME_SEPARATOR
)
3373 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3374 || s
[from_len
] == DIRNAME_SEPARATOR
))
3378 string_new
= xrealloc (string
, (strlen (string
) + to_len
+ 1));
3380 /* Relocate the current S pointer. */
3381 s
= s
- string
+ string_new
;
3382 string
= string_new
;
3384 /* Replace from by to. */
3385 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3386 memcpy (s
, to
, to_len
);
3401 /* SIGALRM handler for waitpid_with_timeout. */
3404 sigalrm_handler (int signo
)
3406 /* Nothing to do. */
3411 /* Wrapper to wait for child PID to die with TIMEOUT.
3412 TIMEOUT is the time to stop waiting in seconds.
3413 If TIMEOUT is zero, pass WNOHANG to waitpid.
3414 Returns PID if it was successfully waited for, otherwise -1.
3416 Timeouts are currently implemented with alarm and SIGALRM.
3417 If the host does not support them, this waits "forever".
3418 It would be odd though for a host to have waitpid and not SIGALRM. */
3421 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3423 pid_t waitpid_result
;
3425 gdb_assert (pid
> 0);
3426 gdb_assert (timeout
>= 0);
3431 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3432 struct sigaction sa
, old_sa
;
3434 sa
.sa_handler
= sigalrm_handler
;
3435 sigemptyset (&sa
.sa_mask
);
3437 sigaction (SIGALRM
, &sa
, &old_sa
);
3441 ofunc
= (void (*)()) signal (SIGALRM
, sigalrm_handler
);
3447 waitpid_result
= waitpid (pid
, status
, 0);
3451 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3452 sigaction (SIGALRM
, &old_sa
, NULL
);
3454 signal (SIGALRM
, ofunc
);
3459 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3461 if (waitpid_result
== pid
)
3467 #endif /* HAVE_WAITPID */
3469 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3470 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3472 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3473 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3476 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3478 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3480 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3481 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3483 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3485 char *pattern_slash
, *string_slash
;
3487 /* Replace '\' by '/' in both strings. */
3489 pattern_slash
= alloca (strlen (pattern
) + 1);
3490 strcpy (pattern_slash
, pattern
);
3491 pattern
= pattern_slash
;
3492 for (; *pattern_slash
!= 0; pattern_slash
++)
3493 if (IS_DIR_SEPARATOR (*pattern_slash
))
3494 *pattern_slash
= '/';
3496 string_slash
= alloca (strlen (string
) + 1);
3497 strcpy (string_slash
, string
);
3498 string
= string_slash
;
3499 for (; *string_slash
!= 0; string_slash
++)
3500 if (IS_DIR_SEPARATOR (*string_slash
))
3501 *string_slash
= '/';
3503 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3505 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3506 flags
|= FNM_CASEFOLD
;
3507 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3509 return fnmatch (pattern
, string
, flags
);
3512 /* Provide a prototype to silence -Wmissing-prototypes. */
3513 extern initialize_file_ftype _initialize_utils
;
3516 _initialize_utils (void)
3518 add_internal_problem_command (&internal_error_problem
);
3519 add_internal_problem_command (&internal_warning_problem
);