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 fputs_unfiltered (_("\nThis is a bug, please report it."), gdb_stderr
);
750 if (REPORT_BUGS_TO
[0])
751 fprintf_unfiltered (gdb_stderr
, _(" For instructions, see:\n%s."),
753 fputs_unfiltered ("\n\n", gdb_stderr
);
755 if (problem
->should_dump_core
== internal_problem_ask
)
757 if (!can_dump_core (reason
))
761 /* Default (yes/batch case) is to dump core. This leaves a GDB
762 `dropping' so that it is easier to see that something went
764 dump_core_p
= query (_("%s\nCreate a core file of GDB? "), reason
);
767 else if (problem
->should_dump_core
== internal_problem_yes
)
768 dump_core_p
= can_dump_core (reason
);
769 else if (problem
->should_dump_core
== internal_problem_no
)
772 internal_error (__FILE__
, __LINE__
, _("bad switch"));
785 #ifdef HAVE_WORKING_FORK
793 do_cleanups (cleanup
);
796 static struct internal_problem internal_error_problem
= {
797 "internal-error", internal_problem_ask
, internal_problem_ask
801 internal_verror (const char *file
, int line
, const char *fmt
, va_list ap
)
803 internal_vproblem (&internal_error_problem
, file
, line
, fmt
, ap
);
804 fatal (_("Command aborted."));
808 internal_error (const char *file
, int line
, const char *string
, ...)
812 va_start (ap
, string
);
813 internal_verror (file
, line
, string
, ap
);
817 static struct internal_problem internal_warning_problem
= {
818 "internal-warning", internal_problem_ask
, internal_problem_ask
822 internal_vwarning (const char *file
, int line
, const char *fmt
, va_list ap
)
824 internal_vproblem (&internal_warning_problem
, file
, line
, fmt
, ap
);
828 internal_warning (const char *file
, int line
, const char *string
, ...)
832 va_start (ap
, string
);
833 internal_vwarning (file
, line
, string
, ap
);
837 /* Dummy functions to keep add_prefix_cmd happy. */
840 set_internal_problem_cmd (char *args
, int from_tty
)
845 show_internal_problem_cmd (char *args
, int from_tty
)
849 /* When GDB reports an internal problem (error or warning) it gives
850 the user the opportunity to quit GDB and/or create a core file of
851 the current debug session. This function registers a few commands
852 that make it possible to specify that GDB should always or never
853 quit or create a core file, without asking. The commands look
856 maint set PROBLEM-NAME quit ask|yes|no
857 maint show PROBLEM-NAME quit
858 maint set PROBLEM-NAME corefile ask|yes|no
859 maint show PROBLEM-NAME corefile
861 Where PROBLEM-NAME is currently "internal-error" or
862 "internal-warning". */
865 add_internal_problem_command (struct internal_problem
*problem
)
867 struct cmd_list_element
**set_cmd_list
;
868 struct cmd_list_element
**show_cmd_list
;
872 set_cmd_list
= xmalloc (sizeof (*set_cmd_list
));
873 show_cmd_list
= xmalloc (sizeof (*set_cmd_list
));
874 *set_cmd_list
= NULL
;
875 *show_cmd_list
= NULL
;
877 set_doc
= xstrprintf (_("Configure what GDB does when %s is detected."),
880 show_doc
= xstrprintf (_("Show what GDB does when %s is detected."),
883 add_prefix_cmd ((char*) problem
->name
,
884 class_maintenance
, set_internal_problem_cmd
, set_doc
,
886 concat ("maintenance set ", problem
->name
, " ",
888 0/*allow-unknown*/, &maintenance_set_cmdlist
);
890 add_prefix_cmd ((char*) problem
->name
,
891 class_maintenance
, show_internal_problem_cmd
, show_doc
,
893 concat ("maintenance show ", problem
->name
, " ",
895 0/*allow-unknown*/, &maintenance_show_cmdlist
);
897 set_doc
= xstrprintf (_("Set whether GDB should quit "
898 "when an %s is detected"),
900 show_doc
= xstrprintf (_("Show whether GDB will quit "
901 "when an %s is detected"),
903 add_setshow_enum_cmd ("quit", class_maintenance
,
904 internal_problem_modes
,
905 &problem
->should_quit
,
917 set_doc
= xstrprintf (_("Set whether GDB should create a core "
918 "file of GDB when %s is detected"),
920 show_doc
= xstrprintf (_("Show whether GDB will create a core "
921 "file of GDB when %s is detected"),
923 add_setshow_enum_cmd ("corefile", class_maintenance
,
924 internal_problem_modes
,
925 &problem
->should_dump_core
,
938 /* Return a newly allocated string, containing the PREFIX followed
939 by the system error message for errno (separated by a colon).
941 The result must be deallocated after use. */
944 perror_string (const char *prefix
)
949 err
= safe_strerror (errno
);
950 combined
= (char *) xmalloc (strlen (err
) + strlen (prefix
) + 3);
951 strcpy (combined
, prefix
);
952 strcat (combined
, ": ");
953 strcat (combined
, err
);
958 /* Print the system error message for errno, and also mention STRING
959 as the file name for which the error was encountered. Use ERRCODE
960 for the thrown exception. Then return to command level. */
963 throw_perror_with_name (enum errors errcode
, const char *string
)
967 combined
= perror_string (string
);
968 make_cleanup (xfree
, combined
);
970 /* I understand setting these is a matter of taste. Still, some people
971 may clear errno but not know about bfd_error. Doing this here is not
973 bfd_set_error (bfd_error_no_error
);
976 throw_error (errcode
, _("%s."), combined
);
979 /* See throw_perror_with_name, ERRCODE defaults here to GENERIC_ERROR. */
982 perror_with_name (const char *string
)
984 throw_perror_with_name (GENERIC_ERROR
, string
);
987 /* Same as perror_with_name except that it prints a warning instead
988 of throwing an error. */
991 perror_warning_with_name (const char *string
)
995 combined
= perror_string (string
);
996 warning (_("%s"), combined
);
1000 /* Print the system error message for ERRCODE, and also mention STRING
1001 as the file name for which the error was encountered. */
1004 print_sys_errmsg (const char *string
, int errcode
)
1009 err
= safe_strerror (errcode
);
1010 combined
= (char *) alloca (strlen (err
) + strlen (string
) + 3);
1011 strcpy (combined
, string
);
1012 strcat (combined
, ": ");
1013 strcat (combined
, err
);
1015 /* We want anything which was printed on stdout to come out first, before
1017 gdb_flush (gdb_stdout
);
1018 fprintf_unfiltered (gdb_stderr
, "%s.\n", combined
);
1021 /* Control C eventually causes this to be called, at a convenient time. */
1026 if (sync_quit_force_run
)
1028 sync_quit_force_run
= 0;
1029 quit_force (NULL
, stdin
== instream
);
1033 /* No steenking SIGINT will ever be coming our way when the
1034 program is resumed. Don't lie. */
1038 /* If there is no terminal switching for this target, then we can't
1039 possibly get screwed by the lack of job control. */
1040 || current_target
.to_terminal_ours
== NULL
)
1043 fatal ("Quit (expect signal SIGINT when the program is resumed)");
1048 /* Called when a memory allocation fails, with the number of bytes of
1049 memory requested in SIZE. */
1052 malloc_failure (long size
)
1056 internal_error (__FILE__
, __LINE__
,
1057 _("virtual memory exhausted: can't allocate %ld bytes."),
1062 internal_error (__FILE__
, __LINE__
, _("virtual memory exhausted."));
1066 /* My replacement for the read system call.
1067 Used like `read' but keeps going if `read' returns too soon. */
1070 myread (int desc
, char *addr
, int len
)
1077 val
= read (desc
, addr
, len
);
1081 return orglen
- len
;
1089 print_spaces (int n
, struct ui_file
*file
)
1091 fputs_unfiltered (n_spaces (n
), file
);
1094 /* Print a host address. */
1097 gdb_print_host_address (const void *addr
, struct ui_file
*stream
)
1099 fprintf_filtered (stream
, "%s", host_address_to_string (addr
));
1103 /* A cleanup function that calls regfree. */
1106 do_regfree_cleanup (void *r
)
1111 /* Create a new cleanup that frees the compiled regular expression R. */
1114 make_regfree_cleanup (regex_t
*r
)
1116 return make_cleanup (do_regfree_cleanup
, r
);
1119 /* Return an xmalloc'd error message resulting from a regular
1120 expression compilation failure. */
1123 get_regcomp_error (int code
, regex_t
*rx
)
1125 size_t length
= regerror (code
, rx
, NULL
, 0);
1126 char *result
= xmalloc (length
);
1128 regerror (code
, rx
, result
, length
);
1132 /* Compile a regexp and throw an exception on error. This returns a
1133 cleanup to free the resulting pattern on success. RX must not be
1137 compile_rx_or_error (regex_t
*pattern
, const char *rx
, const char *message
)
1141 gdb_assert (rx
!= NULL
);
1143 code
= regcomp (pattern
, rx
, REG_NOSUB
);
1146 char *err
= get_regcomp_error (code
, pattern
);
1148 make_cleanup (xfree
, err
);
1149 error (("%s: %s"), message
, err
);
1152 return make_regfree_cleanup (pattern
);
1157 /* This function supports the query, nquery, and yquery functions.
1158 Ask user a y-or-n question and return 0 if answer is no, 1 if
1159 answer is yes, or default the answer to the specified default
1160 (for yquery or nquery). DEFCHAR may be 'y' or 'n' to provide a
1161 default answer, or '\0' for no default.
1162 CTLSTR is the control string and should end in "? ". It should
1163 not say how to answer, because we do that.
1164 ARGS are the arguments passed along with the CTLSTR argument to
1167 static int ATTRIBUTE_PRINTF (1, 0)
1168 defaulted_query (const char *ctlstr
, const char defchar
, va_list args
)
1174 char def_answer
, not_def_answer
;
1175 char *y_string
, *n_string
, *question
;
1176 /* Used to add duration we waited for user to respond to
1177 prompt_for_continue_wait_time. */
1178 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1180 /* Set up according to which answer is the default. */
1181 if (defchar
== '\0')
1185 not_def_answer
= 'N';
1189 else if (defchar
== 'y')
1193 not_def_answer
= 'N';
1201 not_def_answer
= 'Y';
1206 /* Automatically answer the default value if the user did not want
1207 prompts or the command was issued with the server prefix. */
1208 if (!confirm
|| server_command
)
1211 /* If input isn't coming from the user directly, just say what
1212 question we're asking, and then answer the default automatically. This
1213 way, important error messages don't get lost when talking to GDB
1215 if (! input_from_terminal_p ())
1218 vfprintf_filtered (gdb_stdout
, ctlstr
, args
);
1220 printf_filtered (_("(%s or %s) [answered %c; "
1221 "input not from terminal]\n"),
1222 y_string
, n_string
, def_answer
);
1223 gdb_flush (gdb_stdout
);
1228 if (deprecated_query_hook
)
1230 return deprecated_query_hook (ctlstr
, args
);
1233 /* Format the question outside of the loop, to avoid reusing args. */
1234 question
= xstrvprintf (ctlstr
, args
);
1236 /* Used for calculating time spend waiting for user. */
1237 gettimeofday (&prompt_started
, NULL
);
1241 wrap_here (""); /* Flush any buffered output. */
1242 gdb_flush (gdb_stdout
);
1244 if (annotation_level
> 1)
1245 printf_filtered (("\n\032\032pre-query\n"));
1247 fputs_filtered (question
, gdb_stdout
);
1248 printf_filtered (_("(%s or %s) "), y_string
, n_string
);
1250 if (annotation_level
> 1)
1251 printf_filtered (("\n\032\032query\n"));
1254 gdb_flush (gdb_stdout
);
1256 answer
= fgetc (stdin
);
1258 /* We expect fgetc to block until a character is read. But
1259 this may not be the case if the terminal was opened with
1260 the NONBLOCK flag. In that case, if there is nothing to
1261 read on stdin, fgetc returns EOF, but also sets the error
1262 condition flag on stdin and errno to EAGAIN. With a true
1263 EOF, stdin's error condition flag is not set.
1265 A situation where this behavior was observed is a pseudo
1267 while (answer
== EOF
&& ferror (stdin
) && errno
== EAGAIN
)
1269 /* Not a real EOF. Wait a little while and try again until
1270 we read something. */
1273 answer
= fgetc (stdin
);
1276 clearerr (stdin
); /* in case of C-d */
1277 if (answer
== EOF
) /* C-d */
1279 printf_filtered ("EOF [assumed %c]\n", def_answer
);
1283 /* Eat rest of input line, to EOF or newline. */
1287 ans2
= fgetc (stdin
);
1290 while (ans2
!= EOF
&& ans2
!= '\n' && ans2
!= '\r');
1294 /* Check answer. For the non-default, the user must specify
1295 the non-default explicitly. */
1296 if (answer
== not_def_answer
)
1298 retval
= !def_value
;
1301 /* Otherwise, if a default was specified, the user may either
1302 specify the required input or have it default by entering
1304 if (answer
== def_answer
1305 || (defchar
!= '\0' &&
1306 (answer
== '\n' || answer
== '\r' || answer
== EOF
)))
1311 /* Invalid entries are not defaulted and require another selection. */
1312 printf_filtered (_("Please answer %s or %s.\n"),
1313 y_string
, n_string
);
1316 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1317 gettimeofday (&prompt_ended
, NULL
);
1318 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1319 timeval_add (&prompt_for_continue_wait_time
,
1320 &prompt_for_continue_wait_time
, &prompt_delta
);
1323 if (annotation_level
> 1)
1324 printf_filtered (("\n\032\032post-query\n"));
1329 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1330 answer is yes, or 0 if answer is defaulted.
1331 Takes three args which are given to printf to print the question.
1332 The first, a control string, should end in "? ".
1333 It should not say how to answer, because we do that. */
1336 nquery (const char *ctlstr
, ...)
1341 va_start (args
, ctlstr
);
1342 ret
= defaulted_query (ctlstr
, 'n', args
);
1347 /* Ask user a y-or-n question and return 0 if answer is no, 1 if
1348 answer is yes, or 1 if answer is defaulted.
1349 Takes three args which are given to printf to print the question.
1350 The first, a control string, should end in "? ".
1351 It should not say how to answer, because we do that. */
1354 yquery (const char *ctlstr
, ...)
1359 va_start (args
, ctlstr
);
1360 ret
= defaulted_query (ctlstr
, 'y', args
);
1365 /* Ask user a y-or-n question and return 1 iff answer is yes.
1366 Takes three args which are given to printf to print the question.
1367 The first, a control string, should end in "? ".
1368 It should not say how to answer, because we do that. */
1371 query (const char *ctlstr
, ...)
1376 va_start (args
, ctlstr
);
1377 ret
= defaulted_query (ctlstr
, '\0', args
);
1382 /* A helper for parse_escape that converts a host character to a
1383 target character. C is the host character. If conversion is
1384 possible, then the target character is stored in *TARGET_C and the
1385 function returns 1. Otherwise, the function returns 0. */
1388 host_char_to_target (struct gdbarch
*gdbarch
, int c
, int *target_c
)
1390 struct obstack host_data
;
1392 struct cleanup
*cleanups
;
1395 obstack_init (&host_data
);
1396 cleanups
= make_cleanup_obstack_free (&host_data
);
1398 convert_between_encodings (target_charset (gdbarch
), host_charset (),
1399 (gdb_byte
*) &the_char
, 1, 1,
1400 &host_data
, translit_none
);
1402 if (obstack_object_size (&host_data
) == 1)
1405 *target_c
= *(char *) obstack_base (&host_data
);
1408 do_cleanups (cleanups
);
1412 /* Parse a C escape sequence. STRING_PTR points to a variable
1413 containing a pointer to the string to parse. That pointer
1414 should point to the character after the \. That pointer
1415 is updated past the characters we use. The value of the
1416 escape sequence is returned.
1418 A negative value means the sequence \ newline was seen,
1419 which is supposed to be equivalent to nothing at all.
1421 If \ is followed by a null character, we return a negative
1422 value and leave the string pointer pointing at the null character.
1424 If \ is followed by 000, we return 0 and leave the string pointer
1425 after the zeros. A value of 0 does not mean end of string. */
1428 parse_escape (struct gdbarch
*gdbarch
, const char **string_ptr
)
1430 int target_char
= -2; /* Initialize to avoid GCC warnings. */
1431 int c
= *(*string_ptr
)++;
1450 int i
= host_hex_value (c
);
1455 if (isdigit (c
) && c
!= '8' && c
!= '9')
1459 i
+= host_hex_value (c
);
1495 if (!host_char_to_target (gdbarch
, c
, &target_char
))
1496 error (_("The escape sequence `\\%c' is equivalent to plain `%c',"
1497 " which has no equivalent\nin the `%s' character set."),
1498 c
, c
, target_charset (gdbarch
));
1502 /* Print the character C on STREAM as part of the contents of a literal
1503 string whose delimiter is QUOTER. Note that this routine should only
1504 be call for printing things which are independent of the language
1505 of the program being debugged.
1507 printchar will normally escape backslashes and instances of QUOTER. If
1508 QUOTER is 0, printchar won't escape backslashes or any quoting character.
1509 As a side effect, if you pass the backslash character as the QUOTER,
1510 printchar will escape backslashes as usual, but not any other quoting
1514 printchar (int c
, void (*do_fputs
) (const char *, struct ui_file
*),
1515 void (*do_fprintf
) (struct ui_file
*, const char *, ...)
1516 ATTRIBUTE_FPTR_PRINTF_2
, struct ui_file
*stream
, int quoter
)
1518 c
&= 0xFF; /* Avoid sign bit follies */
1520 if (c
< 0x20 || /* Low control chars */
1521 (c
>= 0x7F && c
< 0xA0) || /* DEL, High controls */
1522 (sevenbit_strings
&& c
>= 0x80))
1523 { /* high order bit set */
1527 do_fputs ("\\n", stream
);
1530 do_fputs ("\\b", stream
);
1533 do_fputs ("\\t", stream
);
1536 do_fputs ("\\f", stream
);
1539 do_fputs ("\\r", stream
);
1542 do_fputs ("\\e", stream
);
1545 do_fputs ("\\a", stream
);
1548 do_fprintf (stream
, "\\%.3o", (unsigned int) c
);
1554 if (quoter
!= 0 && (c
== '\\' || c
== quoter
))
1555 do_fputs ("\\", stream
);
1556 do_fprintf (stream
, "%c", c
);
1560 /* Print the character C on STREAM as part of the contents of a
1561 literal string whose delimiter is QUOTER. Note that these routines
1562 should only be call for printing things which are independent of
1563 the language of the program being debugged. */
1566 fputstr_filtered (const char *str
, int quoter
, struct ui_file
*stream
)
1569 printchar (*str
++, fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1573 fputstr_unfiltered (const char *str
, int quoter
, struct ui_file
*stream
)
1576 printchar (*str
++, fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1580 fputstrn_filtered (const char *str
, int n
, int quoter
,
1581 struct ui_file
*stream
)
1585 for (i
= 0; i
< n
; i
++)
1586 printchar (str
[i
], fputs_filtered
, fprintf_filtered
, stream
, quoter
);
1590 fputstrn_unfiltered (const char *str
, int n
, int quoter
,
1591 struct ui_file
*stream
)
1595 for (i
= 0; i
< n
; i
++)
1596 printchar (str
[i
], fputs_unfiltered
, fprintf_unfiltered
, stream
, quoter
);
1600 /* Number of lines per page or UINT_MAX if paging is disabled. */
1601 static unsigned int lines_per_page
;
1603 show_lines_per_page (struct ui_file
*file
, int from_tty
,
1604 struct cmd_list_element
*c
, const char *value
)
1606 fprintf_filtered (file
,
1607 _("Number of lines gdb thinks are in a page is %s.\n"),
1611 /* Number of chars per line or UINT_MAX if line folding is disabled. */
1612 static unsigned int chars_per_line
;
1614 show_chars_per_line (struct ui_file
*file
, int from_tty
,
1615 struct cmd_list_element
*c
, const char *value
)
1617 fprintf_filtered (file
,
1618 _("Number of characters gdb thinks "
1619 "are in a line is %s.\n"),
1623 /* Current count of lines printed on this page, chars on this line. */
1624 static unsigned int lines_printed
, chars_printed
;
1626 /* Buffer and start column of buffered text, for doing smarter word-
1627 wrapping. When someone calls wrap_here(), we start buffering output
1628 that comes through fputs_filtered(). If we see a newline, we just
1629 spit it out and forget about the wrap_here(). If we see another
1630 wrap_here(), we spit it out and remember the newer one. If we see
1631 the end of the line, we spit out a newline, the indent, and then
1632 the buffered output. */
1634 /* Malloc'd buffer with chars_per_line+2 bytes. Contains characters which
1635 are waiting to be output (they have already been counted in chars_printed).
1636 When wrap_buffer[0] is null, the buffer is empty. */
1637 static char *wrap_buffer
;
1639 /* Pointer in wrap_buffer to the next character to fill. */
1640 static char *wrap_pointer
;
1642 /* String to indent by if the wrap occurs. Must not be NULL if wrap_column
1644 static char *wrap_indent
;
1646 /* Column number on the screen where wrap_buffer begins, or 0 if wrapping
1647 is not in effect. */
1648 static int wrap_column
;
1651 /* Inialize the number of lines per page and chars per line. */
1654 init_page_info (void)
1658 lines_per_page
= UINT_MAX
;
1659 chars_per_line
= UINT_MAX
;
1663 if (!tui_get_command_dimension (&chars_per_line
, &lines_per_page
))
1668 #if defined(__GO32__)
1669 rows
= ScreenRows ();
1670 cols
= ScreenCols ();
1671 lines_per_page
= rows
;
1672 chars_per_line
= cols
;
1674 /* Make sure Readline has initialized its terminal settings. */
1675 rl_reset_terminal (NULL
);
1677 /* Get the screen size from Readline. */
1678 rl_get_screen_size (&rows
, &cols
);
1679 lines_per_page
= rows
;
1680 chars_per_line
= cols
;
1682 /* Readline should have fetched the termcap entry for us.
1683 Only try to use tgetnum function if rl_get_screen_size
1684 did not return a useful value. */
1685 if (((rows
<= 0) && (tgetnum ("li") < 0))
1686 /* Also disable paging if inside EMACS. */
1687 || getenv ("EMACS"))
1689 /* The number of lines per page is not mentioned in the terminal
1690 description or EMACS evironment variable is set. This probably
1691 means that paging is not useful, so disable paging. */
1692 lines_per_page
= UINT_MAX
;
1695 /* If the output is not a terminal, don't paginate it. */
1696 if (!ui_file_isatty (gdb_stdout
))
1697 lines_per_page
= UINT_MAX
;
1705 /* Helper for make_cleanup_restore_page_info. */
1708 do_restore_page_info_cleanup (void *arg
)
1714 /* Provide cleanup for restoring the terminal size. */
1717 make_cleanup_restore_page_info (void)
1719 struct cleanup
*back_to
;
1721 back_to
= make_cleanup (do_restore_page_info_cleanup
, NULL
);
1722 make_cleanup_restore_uinteger (&lines_per_page
);
1723 make_cleanup_restore_uinteger (&chars_per_line
);
1728 /* Temporarily set BATCH_FLAG and the associated unlimited terminal size.
1729 Provide cleanup for restoring the original state. */
1732 set_batch_flag_and_make_cleanup_restore_page_info (void)
1734 struct cleanup
*back_to
= make_cleanup_restore_page_info ();
1736 make_cleanup_restore_integer (&batch_flag
);
1743 /* Set the screen size based on LINES_PER_PAGE and CHARS_PER_LINE. */
1746 set_screen_size (void)
1748 int rows
= lines_per_page
;
1749 int cols
= chars_per_line
;
1757 /* Update Readline's idea of the terminal size. */
1758 rl_set_screen_size (rows
, cols
);
1761 /* Reinitialize WRAP_BUFFER according to the current value of
1767 if (chars_per_line
== 0)
1772 wrap_buffer
= (char *) xmalloc (chars_per_line
+ 2);
1773 wrap_buffer
[0] = '\0';
1776 wrap_buffer
= (char *) xrealloc (wrap_buffer
, chars_per_line
+ 2);
1777 wrap_pointer
= wrap_buffer
; /* Start it at the beginning. */
1781 set_width_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1788 set_height_command (char *args
, int from_tty
, struct cmd_list_element
*c
)
1793 /* Wait, so the user can read what's on the screen. Prompt the user
1794 to continue by pressing RETURN. */
1797 prompt_for_continue (void)
1800 char cont_prompt
[120];
1801 /* Used to add duration we waited for user to respond to
1802 prompt_for_continue_wait_time. */
1803 struct timeval prompt_started
, prompt_ended
, prompt_delta
;
1805 gettimeofday (&prompt_started
, NULL
);
1807 if (annotation_level
> 1)
1808 printf_unfiltered (("\n\032\032pre-prompt-for-continue\n"));
1810 strcpy (cont_prompt
,
1811 "---Type <return> to continue, or q <return> to quit---");
1812 if (annotation_level
> 1)
1813 strcat (cont_prompt
, "\n\032\032prompt-for-continue\n");
1815 /* We must do this *before* we call gdb_readline, else it will eventually
1816 call us -- thinking that we're trying to print beyond the end of the
1818 reinitialize_more_filter ();
1822 /* On a real operating system, the user can quit with SIGINT.
1825 'q' is provided on all systems so users don't have to change habits
1826 from system to system, and because telling them what to do in
1827 the prompt is more user-friendly than expecting them to think of
1829 /* Call readline, not gdb_readline, because GO32 readline handles control-C
1830 whereas control-C to gdb_readline will cause the user to get dumped
1832 ignore
= gdb_readline_wrapper (cont_prompt
);
1834 /* Add time spend in this routine to prompt_for_continue_wait_time. */
1835 gettimeofday (&prompt_ended
, NULL
);
1836 timeval_sub (&prompt_delta
, &prompt_ended
, &prompt_started
);
1837 timeval_add (&prompt_for_continue_wait_time
,
1838 &prompt_for_continue_wait_time
, &prompt_delta
);
1840 if (annotation_level
> 1)
1841 printf_unfiltered (("\n\032\032post-prompt-for-continue\n"));
1847 while (*p
== ' ' || *p
== '\t')
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. */
1862 /* Initalize timer to keep track of how long we waited for the user. */
1865 reset_prompt_for_continue_wait_time (void)
1867 static const struct timeval zero_timeval
= { 0 };
1869 prompt_for_continue_wait_time
= zero_timeval
;
1872 /* Fetch the cumulative time spent in prompt_for_continue. */
1875 get_prompt_for_continue_wait_time (void)
1877 return prompt_for_continue_wait_time
;
1880 /* Reinitialize filter; ie. tell it to reset to original values. */
1883 reinitialize_more_filter (void)
1889 /* Indicate that if the next sequence of characters overflows the line,
1890 a newline should be inserted here rather than when it hits the end.
1891 If INDENT is non-null, it is a string to be printed to indent the
1892 wrapped part on the next line. INDENT must remain accessible until
1893 the next call to wrap_here() or until a newline is printed through
1896 If the line is already overfull, we immediately print a newline and
1897 the indentation, and disable further wrapping.
1899 If we don't know the width of lines, but we know the page height,
1900 we must not wrap words, but should still keep track of newlines
1901 that were explicitly printed.
1903 INDENT should not contain tabs, as that will mess up the char count
1904 on the next line. FIXME.
1906 This routine is guaranteed to force out any output which has been
1907 squirreled away in the wrap_buffer, so wrap_here ((char *)0) can be
1908 used to force out output from the wrap_buffer. */
1911 wrap_here (char *indent
)
1913 /* This should have been allocated, but be paranoid anyway. */
1915 internal_error (__FILE__
, __LINE__
,
1916 _("failed internal consistency check"));
1920 *wrap_pointer
= '\0';
1921 fputs_unfiltered (wrap_buffer
, gdb_stdout
);
1923 wrap_pointer
= wrap_buffer
;
1924 wrap_buffer
[0] = '\0';
1925 if (chars_per_line
== UINT_MAX
) /* No line overflow checking. */
1929 else if (chars_printed
>= chars_per_line
)
1931 puts_filtered ("\n");
1933 puts_filtered (indent
);
1938 wrap_column
= chars_printed
;
1942 wrap_indent
= indent
;
1946 /* Print input string to gdb_stdout, filtered, with wrap,
1947 arranging strings in columns of n chars. String can be
1948 right or left justified in the column. Never prints
1949 trailing spaces. String should never be longer than
1950 width. FIXME: this could be useful for the EXAMINE
1951 command, which currently doesn't tabulate very well. */
1954 puts_filtered_tabular (char *string
, int width
, int right
)
1960 gdb_assert (chars_per_line
> 0);
1961 if (chars_per_line
== UINT_MAX
)
1963 fputs_filtered (string
, gdb_stdout
);
1964 fputs_filtered ("\n", gdb_stdout
);
1968 if (((chars_printed
- 1) / width
+ 2) * width
>= chars_per_line
)
1969 fputs_filtered ("\n", gdb_stdout
);
1971 if (width
>= chars_per_line
)
1972 width
= chars_per_line
- 1;
1974 stringlen
= strlen (string
);
1976 if (chars_printed
> 0)
1977 spaces
= width
- (chars_printed
- 1) % width
- 1;
1979 spaces
+= width
- stringlen
;
1981 spacebuf
= alloca (spaces
+ 1);
1982 spacebuf
[spaces
] = '\0';
1984 spacebuf
[spaces
] = ' ';
1986 fputs_filtered (spacebuf
, gdb_stdout
);
1987 fputs_filtered (string
, gdb_stdout
);
1991 /* Ensure that whatever gets printed next, using the filtered output
1992 commands, starts at the beginning of the line. I.e. if there is
1993 any pending output for the current line, flush it and start a new
1994 line. Otherwise do nothing. */
1999 if (chars_printed
> 0)
2001 puts_filtered ("\n");
2006 /* Like fputs but if FILTER is true, pause after every screenful.
2008 Regardless of FILTER can wrap at points other than the final
2009 character of a line.
2011 Unlike fputs, fputs_maybe_filtered does not return a value.
2012 It is OK for LINEBUFFER to be NULL, in which case just don't print
2015 Note that a longjmp to top level may occur in this routine (only if
2016 FILTER is true) (since prompt_for_continue may do so) so this
2017 routine should not be called when cleanups are not in place. */
2020 fputs_maybe_filtered (const char *linebuffer
, struct ui_file
*stream
,
2023 const char *lineptr
;
2025 if (linebuffer
== 0)
2028 /* Don't do any filtering if it is disabled. */
2029 if (stream
!= gdb_stdout
2030 || !pagination_enabled
2032 || (lines_per_page
== UINT_MAX
&& chars_per_line
== UINT_MAX
)
2033 || top_level_interpreter () == NULL
2034 || ui_out_is_mi_like_p (interp_ui_out (top_level_interpreter ())))
2036 fputs_unfiltered (linebuffer
, stream
);
2040 /* Go through and output each character. Show line extension
2041 when this is necessary; prompt user for new page when this is
2044 lineptr
= linebuffer
;
2047 /* Possible new page. */
2048 if (filter
&& (lines_printed
>= lines_per_page
- 1))
2049 prompt_for_continue ();
2051 while (*lineptr
&& *lineptr
!= '\n')
2053 /* Print a single line. */
2054 if (*lineptr
== '\t')
2057 *wrap_pointer
++ = '\t';
2059 fputc_unfiltered ('\t', stream
);
2060 /* Shifting right by 3 produces the number of tab stops
2061 we have already passed, and then adding one and
2062 shifting left 3 advances to the next tab stop. */
2063 chars_printed
= ((chars_printed
>> 3) + 1) << 3;
2069 *wrap_pointer
++ = *lineptr
;
2071 fputc_unfiltered (*lineptr
, stream
);
2076 if (chars_printed
>= chars_per_line
)
2078 unsigned int save_chars
= chars_printed
;
2082 /* If we aren't actually wrapping, don't output newline --
2083 if chars_per_line is right, we probably just overflowed
2084 anyway; if it's wrong, let us keep going. */
2086 fputc_unfiltered ('\n', stream
);
2088 /* Possible new page. */
2089 if (lines_printed
>= lines_per_page
- 1)
2090 prompt_for_continue ();
2092 /* Now output indentation and wrapped string. */
2095 fputs_unfiltered (wrap_indent
, stream
);
2096 *wrap_pointer
= '\0'; /* Null-terminate saved stuff, */
2097 fputs_unfiltered (wrap_buffer
, stream
); /* and eject it. */
2098 /* FIXME, this strlen is what prevents wrap_indent from
2099 containing tabs. However, if we recurse to print it
2100 and count its chars, we risk trouble if wrap_indent is
2101 longer than (the user settable) chars_per_line.
2102 Note also that this can set chars_printed > chars_per_line
2103 if we are printing a long string. */
2104 chars_printed
= strlen (wrap_indent
)
2105 + (save_chars
- wrap_column
);
2106 wrap_pointer
= wrap_buffer
; /* Reset buffer */
2107 wrap_buffer
[0] = '\0';
2108 wrap_column
= 0; /* And disable fancy wrap */
2113 if (*lineptr
== '\n')
2116 wrap_here ((char *) 0); /* Spit out chars, cancel
2119 fputc_unfiltered ('\n', stream
);
2126 fputs_filtered (const char *linebuffer
, struct ui_file
*stream
)
2128 fputs_maybe_filtered (linebuffer
, stream
, 1);
2132 putchar_unfiltered (int c
)
2136 ui_file_write (gdb_stdout
, &buf
, 1);
2140 /* Write character C to gdb_stdout using GDB's paging mechanism and return C.
2141 May return nonlocally. */
2144 putchar_filtered (int c
)
2146 return fputc_filtered (c
, gdb_stdout
);
2150 fputc_unfiltered (int c
, struct ui_file
*stream
)
2154 ui_file_write (stream
, &buf
, 1);
2159 fputc_filtered (int c
, struct ui_file
*stream
)
2165 fputs_filtered (buf
, stream
);
2169 /* puts_debug is like fputs_unfiltered, except it prints special
2170 characters in printable fashion. */
2173 puts_debug (char *prefix
, char *string
, char *suffix
)
2177 /* Print prefix and suffix after each line. */
2178 static int new_line
= 1;
2179 static int return_p
= 0;
2180 static char *prev_prefix
= "";
2181 static char *prev_suffix
= "";
2183 if (*string
== '\n')
2186 /* If the prefix is changing, print the previous suffix, a new line,
2187 and the new prefix. */
2188 if ((return_p
|| (strcmp (prev_prefix
, prefix
) != 0)) && !new_line
)
2190 fputs_unfiltered (prev_suffix
, gdb_stdlog
);
2191 fputs_unfiltered ("\n", gdb_stdlog
);
2192 fputs_unfiltered (prefix
, gdb_stdlog
);
2195 /* Print prefix if we printed a newline during the previous call. */
2199 fputs_unfiltered (prefix
, gdb_stdlog
);
2202 prev_prefix
= prefix
;
2203 prev_suffix
= suffix
;
2205 /* Output characters in a printable format. */
2206 while ((ch
= *string
++) != '\0')
2212 fputc_unfiltered (ch
, gdb_stdlog
);
2215 fprintf_unfiltered (gdb_stdlog
, "\\x%02x", ch
& 0xff);
2219 fputs_unfiltered ("\\\\", gdb_stdlog
);
2222 fputs_unfiltered ("\\b", gdb_stdlog
);
2225 fputs_unfiltered ("\\f", gdb_stdlog
);
2229 fputs_unfiltered ("\\n", gdb_stdlog
);
2232 fputs_unfiltered ("\\r", gdb_stdlog
);
2235 fputs_unfiltered ("\\t", gdb_stdlog
);
2238 fputs_unfiltered ("\\v", gdb_stdlog
);
2242 return_p
= ch
== '\r';
2245 /* Print suffix if we printed a newline. */
2248 fputs_unfiltered (suffix
, gdb_stdlog
);
2249 fputs_unfiltered ("\n", gdb_stdlog
);
2254 /* Print a variable number of ARGS using format FORMAT. If this
2255 information is going to put the amount written (since the last call
2256 to REINITIALIZE_MORE_FILTER or the last page break) over the page size,
2257 call prompt_for_continue to get the users permision to continue.
2259 Unlike fprintf, this function does not return a value.
2261 We implement three variants, vfprintf (takes a vararg list and stream),
2262 fprintf (takes a stream to write on), and printf (the usual).
2264 Note also that a longjmp to top level may occur in this routine
2265 (since prompt_for_continue may do so) so this routine should not be
2266 called when cleanups are not in place. */
2269 vfprintf_maybe_filtered (struct ui_file
*stream
, const char *format
,
2270 va_list args
, int filter
)
2273 struct cleanup
*old_cleanups
;
2275 linebuffer
= xstrvprintf (format
, args
);
2276 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2277 fputs_maybe_filtered (linebuffer
, stream
, filter
);
2278 do_cleanups (old_cleanups
);
2283 vfprintf_filtered (struct ui_file
*stream
, const char *format
, va_list args
)
2285 vfprintf_maybe_filtered (stream
, format
, args
, 1);
2289 vfprintf_unfiltered (struct ui_file
*stream
, const char *format
, va_list args
)
2292 struct cleanup
*old_cleanups
;
2294 linebuffer
= xstrvprintf (format
, args
);
2295 old_cleanups
= make_cleanup (xfree
, linebuffer
);
2296 if (debug_timestamp
&& stream
== gdb_stdlog
)
2302 gettimeofday (&tm
, NULL
);
2304 len
= strlen (linebuffer
);
2305 need_nl
= (len
> 0 && linebuffer
[len
- 1] != '\n');
2307 timestamp
= xstrprintf ("%ld:%ld %s%s",
2308 (long) tm
.tv_sec
, (long) tm
.tv_usec
,
2310 need_nl
? "\n": "");
2311 make_cleanup (xfree
, timestamp
);
2312 fputs_unfiltered (timestamp
, stream
);
2315 fputs_unfiltered (linebuffer
, stream
);
2316 do_cleanups (old_cleanups
);
2320 vprintf_filtered (const char *format
, va_list args
)
2322 vfprintf_maybe_filtered (gdb_stdout
, format
, args
, 1);
2326 vprintf_unfiltered (const char *format
, va_list args
)
2328 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2332 fprintf_filtered (struct ui_file
*stream
, const char *format
, ...)
2336 va_start (args
, format
);
2337 vfprintf_filtered (stream
, format
, args
);
2342 fprintf_unfiltered (struct ui_file
*stream
, const char *format
, ...)
2346 va_start (args
, format
);
2347 vfprintf_unfiltered (stream
, format
, args
);
2351 /* Like fprintf_filtered, but prints its result indented.
2352 Called as fprintfi_filtered (spaces, stream, format, ...); */
2355 fprintfi_filtered (int spaces
, struct ui_file
*stream
, const char *format
,
2360 va_start (args
, format
);
2361 print_spaces_filtered (spaces
, stream
);
2363 vfprintf_filtered (stream
, format
, args
);
2369 printf_filtered (const char *format
, ...)
2373 va_start (args
, format
);
2374 vfprintf_filtered (gdb_stdout
, format
, args
);
2380 printf_unfiltered (const char *format
, ...)
2384 va_start (args
, format
);
2385 vfprintf_unfiltered (gdb_stdout
, format
, args
);
2389 /* Like printf_filtered, but prints it's result indented.
2390 Called as printfi_filtered (spaces, format, ...); */
2393 printfi_filtered (int spaces
, const char *format
, ...)
2397 va_start (args
, format
);
2398 print_spaces_filtered (spaces
, gdb_stdout
);
2399 vfprintf_filtered (gdb_stdout
, format
, args
);
2403 /* Easy -- but watch out!
2405 This routine is *not* a replacement for puts()! puts() appends a newline.
2406 This one doesn't, and had better not! */
2409 puts_filtered (const char *string
)
2411 fputs_filtered (string
, gdb_stdout
);
2415 puts_unfiltered (const char *string
)
2417 fputs_unfiltered (string
, gdb_stdout
);
2420 /* Return a pointer to N spaces and a null. The pointer is good
2421 until the next call to here. */
2426 static char *spaces
= 0;
2427 static int max_spaces
= -1;
2433 spaces
= (char *) xmalloc (n
+ 1);
2434 for (t
= spaces
+ n
; t
!= spaces
;)
2440 return spaces
+ max_spaces
- n
;
2443 /* Print N spaces. */
2445 print_spaces_filtered (int n
, struct ui_file
*stream
)
2447 fputs_filtered (n_spaces (n
), stream
);
2450 /* C++/ObjC demangler stuff. */
2452 /* fprintf_symbol_filtered attempts to demangle NAME, a symbol in language
2453 LANG, using demangling args ARG_MODE, and print it filtered to STREAM.
2454 If the name is not mangled, or the language for the name is unknown, or
2455 demangling is off, the name is printed in its "raw" form. */
2458 fprintf_symbol_filtered (struct ui_file
*stream
, const char *name
,
2459 enum language lang
, int arg_mode
)
2465 /* If user wants to see raw output, no problem. */
2468 fputs_filtered (name
, stream
);
2472 demangled
= language_demangle (language_def (lang
), name
, arg_mode
);
2473 fputs_filtered (demangled
? demangled
: name
, stream
);
2474 if (demangled
!= NULL
)
2482 /* Do a strcmp() type operation on STRING1 and STRING2, ignoring any
2483 differences in whitespace. Returns 0 if they match, non-zero if they
2484 don't (slightly different than strcmp()'s range of return values).
2486 As an extra hack, string1=="FOO(ARGS)" matches string2=="FOO".
2487 This "feature" is useful when searching for matching C++ function names
2488 (such as if the user types 'break FOO', where FOO is a mangled C++
2492 strcmp_iw (const char *string1
, const char *string2
)
2494 while ((*string1
!= '\0') && (*string2
!= '\0'))
2496 while (isspace (*string1
))
2500 while (isspace (*string2
))
2504 if (case_sensitivity
== case_sensitive_on
&& *string1
!= *string2
)
2506 if (case_sensitivity
== case_sensitive_off
2507 && (tolower ((unsigned char) *string1
)
2508 != tolower ((unsigned char) *string2
)))
2510 if (*string1
!= '\0')
2516 return (*string1
!= '\0' && *string1
!= '(') || (*string2
!= '\0');
2519 /* This is like strcmp except that it ignores whitespace and treats
2520 '(' as the first non-NULL character in terms of ordering. Like
2521 strcmp (and unlike strcmp_iw), it returns negative if STRING1 <
2522 STRING2, 0 if STRING2 = STRING2, and positive if STRING1 > STRING2
2523 according to that ordering.
2525 If a list is sorted according to this function and if you want to
2526 find names in the list that match some fixed NAME according to
2527 strcmp_iw(LIST_ELT, NAME), then the place to start looking is right
2528 where this function would put NAME.
2530 This function must be neutral to the CASE_SENSITIVITY setting as the user
2531 may choose it during later lookup. Therefore this function always sorts
2532 primarily case-insensitively and secondarily case-sensitively.
2534 Here are some examples of why using strcmp to sort is a bad idea:
2538 Say your partial symtab contains: "foo<char *>", "goo". Then, if
2539 we try to do a search for "foo<char*>", strcmp will locate this
2540 after "foo<char *>" and before "goo". Then lookup_partial_symbol
2541 will start looking at strings beginning with "goo", and will never
2542 see the correct match of "foo<char *>".
2544 Parenthesis example:
2546 In practice, this is less like to be an issue, but I'll give it a
2547 shot. Let's assume that '$' is a legitimate character to occur in
2548 symbols. (Which may well even be the case on some systems.) Then
2549 say that the partial symbol table contains "foo$" and "foo(int)".
2550 strcmp will put them in this order, since '$' < '('. Now, if the
2551 user searches for "foo", then strcmp will sort "foo" before "foo$".
2552 Then lookup_partial_symbol will notice that strcmp_iw("foo$",
2553 "foo") is false, so it won't proceed to the actual match of
2554 "foo(int)" with "foo". */
2557 strcmp_iw_ordered (const char *string1
, const char *string2
)
2559 const char *saved_string1
= string1
, *saved_string2
= string2
;
2560 enum case_sensitivity case_pass
= case_sensitive_off
;
2564 /* C1 and C2 are valid only if *string1 != '\0' && *string2 != '\0'.
2565 Provide stub characters if we are already at the end of one of the
2567 char c1
= 'X', c2
= 'X';
2569 while (*string1
!= '\0' && *string2
!= '\0')
2571 while (isspace (*string1
))
2573 while (isspace (*string2
))
2578 case case_sensitive_off
:
2579 c1
= tolower ((unsigned char) *string1
);
2580 c2
= tolower ((unsigned char) *string2
);
2582 case case_sensitive_on
:
2590 if (*string1
!= '\0')
2599 /* Characters are non-equal unless they're both '\0'; we want to
2600 make sure we get the comparison right according to our
2601 comparison in the cases where one of them is '\0' or '('. */
2603 if (*string2
== '\0')
2608 if (*string2
== '\0')
2613 if (*string2
== '\0' || *string2
== '(')
2622 if (case_pass
== case_sensitive_on
)
2625 /* Otherwise the strings were equal in case insensitive way, make
2626 a more fine grained comparison in a case sensitive way. */
2628 case_pass
= case_sensitive_on
;
2629 string1
= saved_string1
;
2630 string2
= saved_string2
;
2634 /* A simple comparison function with opposite semantics to strcmp. */
2637 streq (const char *lhs
, const char *rhs
)
2639 return !strcmp (lhs
, rhs
);
2645 ** Answer whether string_to_compare is a full or partial match to
2646 ** template_string. The partial match must be in sequence starting
2650 subset_compare (char *string_to_compare
, char *template_string
)
2654 if (template_string
!= (char *) NULL
&& string_to_compare
!= (char *) NULL
2655 && strlen (string_to_compare
) <= strlen (template_string
))
2658 (template_string
, string_to_compare
, strlen (string_to_compare
)) == 0);
2665 pagination_on_command (char *arg
, int from_tty
)
2667 pagination_enabled
= 1;
2671 pagination_off_command (char *arg
, int from_tty
)
2673 pagination_enabled
= 0;
2677 show_debug_timestamp (struct ui_file
*file
, int from_tty
,
2678 struct cmd_list_element
*c
, const char *value
)
2680 fprintf_filtered (file
, _("Timestamping debugging messages is %s.\n"),
2686 initialize_utils (void)
2688 add_setshow_uinteger_cmd ("width", class_support
, &chars_per_line
, _("\
2689 Set number of characters where GDB should wrap lines of its output."), _("\
2690 Show number of characters where GDB should wrap lines of its output."), _("\
2691 This affects where GDB wraps its output to fit the screen width.\n\
2692 Setting this to \"unlimited\" or zero prevents GDB from wrapping its output."),
2694 show_chars_per_line
,
2695 &setlist
, &showlist
);
2697 add_setshow_uinteger_cmd ("height", class_support
, &lines_per_page
, _("\
2698 Set number of lines in a page for GDB output pagination."), _("\
2699 Show number of lines in a page for GDB output pagination."), _("\
2700 This affects the number of lines after which GDB will pause\n\
2701 its output and ask you whether to continue.\n\
2702 Setting this to \"unlimited\" or zero causes GDB never pause during output."),
2704 show_lines_per_page
,
2705 &setlist
, &showlist
);
2709 add_setshow_boolean_cmd ("pagination", class_support
,
2710 &pagination_enabled
, _("\
2711 Set state of GDB output pagination."), _("\
2712 Show state of GDB output pagination."), _("\
2713 When pagination is ON, GDB pauses at end of each screenful of\n\
2714 its output and asks you whether to continue.\n\
2715 Turning pagination off is an alternative to \"set height unlimited\"."),
2717 show_pagination_enabled
,
2718 &setlist
, &showlist
);
2722 add_com ("am", class_support
, pagination_on_command
,
2723 _("Enable pagination"));
2724 add_com ("sm", class_support
, pagination_off_command
,
2725 _("Disable pagination"));
2728 add_setshow_boolean_cmd ("sevenbit-strings", class_support
,
2729 &sevenbit_strings
, _("\
2730 Set printing of 8-bit characters in strings as \\nnn."), _("\
2731 Show printing of 8-bit characters in strings as \\nnn."), NULL
,
2733 show_sevenbit_strings
,
2734 &setprintlist
, &showprintlist
);
2736 add_setshow_boolean_cmd ("timestamp", class_maintenance
,
2737 &debug_timestamp
, _("\
2738 Set timestamping of debugging messages."), _("\
2739 Show timestamping of debugging messages."), _("\
2740 When set, debugging messages will be marked with seconds and microseconds."),
2742 show_debug_timestamp
,
2743 &setdebuglist
, &showdebuglist
);
2747 paddress (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
2749 /* Truncate address to the size of a target address, avoiding shifts
2750 larger or equal than the width of a CORE_ADDR. The local
2751 variable ADDR_BIT stops the compiler reporting a shift overflow
2752 when it won't occur. */
2753 /* NOTE: This assumes that the significant address information is
2754 kept in the least significant bits of ADDR - the upper bits were
2755 either zero or sign extended. Should gdbarch_address_to_pointer or
2756 some ADDRESS_TO_PRINTABLE() be used to do the conversion? */
2758 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2760 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2761 addr
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2762 return hex_string (addr
);
2765 /* This function is described in "defs.h". */
2768 print_core_address (struct gdbarch
*gdbarch
, CORE_ADDR address
)
2770 int addr_bit
= gdbarch_addr_bit (gdbarch
);
2772 if (addr_bit
< (sizeof (CORE_ADDR
) * HOST_CHAR_BIT
))
2773 address
&= ((CORE_ADDR
) 1 << addr_bit
) - 1;
2775 /* FIXME: cagney/2002-05-03: Need local_address_string() function
2776 that returns the language localized string formatted to a width
2777 based on gdbarch_addr_bit. */
2779 return hex_string_custom (address
, 8);
2781 return hex_string_custom (address
, 16);
2784 /* Callback hash_f for htab_create_alloc or htab_create_alloc_ex. */
2787 core_addr_hash (const void *ap
)
2789 const CORE_ADDR
*addrp
= ap
;
2794 /* Callback eq_f for htab_create_alloc or htab_create_alloc_ex. */
2797 core_addr_eq (const void *ap
, const void *bp
)
2799 const CORE_ADDR
*addr_ap
= ap
;
2800 const CORE_ADDR
*addr_bp
= bp
;
2802 return *addr_ap
== *addr_bp
;
2805 /* Convert a string back into a CORE_ADDR. */
2807 string_to_core_addr (const char *my_string
)
2811 if (my_string
[0] == '0' && tolower (my_string
[1]) == 'x')
2813 /* Assume that it is in hex. */
2816 for (i
= 2; my_string
[i
] != '\0'; i
++)
2818 if (isdigit (my_string
[i
]))
2819 addr
= (my_string
[i
] - '0') + (addr
* 16);
2820 else if (isxdigit (my_string
[i
]))
2821 addr
= (tolower (my_string
[i
]) - 'a' + 0xa) + (addr
* 16);
2823 error (_("invalid hex \"%s\""), my_string
);
2828 /* Assume that it is in decimal. */
2831 for (i
= 0; my_string
[i
] != '\0'; i
++)
2833 if (isdigit (my_string
[i
]))
2834 addr
= (my_string
[i
] - '0') + (addr
* 10);
2836 error (_("invalid decimal \"%s\""), my_string
);
2844 gdb_realpath (const char *filename
)
2846 /* Method 1: The system has a compile time upper bound on a filename
2847 path. Use that and realpath() to canonicalize the name. This is
2848 the most common case. Note that, if there isn't a compile time
2849 upper bound, you want to avoid realpath() at all costs. */
2850 #if defined (HAVE_REALPATH) && defined (PATH_MAX)
2853 const char *rp
= realpath (filename
, buf
);
2857 return xstrdup (rp
);
2859 #endif /* HAVE_REALPATH */
2861 /* Method 2: The host system (i.e., GNU) has the function
2862 canonicalize_file_name() which malloc's a chunk of memory and
2863 returns that, use that. */
2864 #if defined(HAVE_CANONICALIZE_FILE_NAME)
2866 char *rp
= canonicalize_file_name (filename
);
2869 return xstrdup (filename
);
2875 /* FIXME: cagney/2002-11-13:
2877 Method 2a: Use realpath() with a NULL buffer. Some systems, due
2878 to the problems described in method 3, have modified their
2879 realpath() implementation so that it will allocate a buffer when
2880 NULL is passed in. Before this can be used, though, some sort of
2881 configure time test would need to be added. Otherwize the code
2882 will likely core dump. */
2884 /* Method 3: Now we're getting desperate! The system doesn't have a
2885 compile time buffer size and no alternative function. Query the
2886 OS, using pathconf(), for the buffer limit. Care is needed
2887 though, some systems do not limit PATH_MAX (return -1 for
2888 pathconf()) making it impossible to pass a correctly sized buffer
2889 to realpath() (it could always overflow). On those systems, we
2891 #if defined (HAVE_REALPATH) && defined (_PC_PATH_MAX) && defined(HAVE_ALLOCA)
2893 /* Find out the max path size. */
2894 long path_max
= pathconf ("/", _PC_PATH_MAX
);
2898 /* PATH_MAX is bounded. */
2899 char *buf
= alloca (path_max
);
2900 char *rp
= realpath (filename
, buf
);
2902 return xstrdup (rp
? rp
: filename
);
2907 /* The MS Windows method. If we don't have realpath, we assume we
2908 don't have symlinks and just canonicalize to a Windows absolute
2909 path. GetFullPath converts ../ and ./ in relative paths to
2910 absolute paths, filling in current drive if one is not given
2911 or using the current directory of a specified drive (eg, "E:foo").
2912 It also converts all forward slashes to back slashes. */
2913 /* The file system is case-insensitive but case-preserving.
2914 So we do not lowercase the path. Otherwise, we might not
2915 be able to display the original casing in a given path. */
2916 #if defined (_WIN32)
2919 DWORD len
= GetFullPathName (filename
, MAX_PATH
, buf
, NULL
);
2921 if (len
> 0 && len
< MAX_PATH
)
2922 return xstrdup (buf
);
2926 /* This system is a lost cause, just dup the buffer. */
2927 return xstrdup (filename
);
2930 /* Return a copy of FILENAME, with its directory prefix canonicalized
2934 gdb_realpath_keepfile (const char *filename
)
2936 const char *base_name
= lbasename (filename
);
2941 /* Extract the basename of filename, and return immediately
2942 a copy of filename if it does not contain any directory prefix. */
2943 if (base_name
== filename
)
2944 return xstrdup (filename
);
2946 dir_name
= alloca ((size_t) (base_name
- filename
+ 2));
2947 /* Allocate enough space to store the dir_name + plus one extra
2948 character sometimes needed under Windows (see below), and
2949 then the closing \000 character. */
2950 strncpy (dir_name
, filename
, base_name
- filename
);
2951 dir_name
[base_name
- filename
] = '\000';
2953 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
2954 /* We need to be careful when filename is of the form 'd:foo', which
2955 is equivalent of d:./foo, which is totally different from d:/foo. */
2956 if (strlen (dir_name
) == 2 && isalpha (dir_name
[0]) && dir_name
[1] == ':')
2959 dir_name
[3] = '\000';
2963 /* Canonicalize the directory prefix, and build the resulting
2964 filename. If the dirname realpath already contains an ending
2965 directory separator, avoid doubling it. */
2966 real_path
= gdb_realpath (dir_name
);
2967 if (IS_DIR_SEPARATOR (real_path
[strlen (real_path
) - 1]))
2968 result
= concat (real_path
, base_name
, (char *) NULL
);
2970 result
= concat (real_path
, SLASH_STRING
, base_name
, (char *) NULL
);
2976 /* Return PATH in absolute form, performing tilde-expansion if necessary.
2977 PATH cannot be NULL or the empty string.
2978 This does not resolve symlinks however, use gdb_realpath for that.
2979 Space for the result is allocated with malloc.
2980 If the path is already absolute, it is strdup'd.
2981 If there is a problem computing the absolute path, the path is returned
2982 unchanged (still strdup'd). */
2985 gdb_abspath (const char *path
)
2987 gdb_assert (path
!= NULL
&& path
[0] != '\0');
2990 return tilde_expand (path
);
2992 if (IS_ABSOLUTE_PATH (path
))
2993 return xstrdup (path
);
2995 /* Beware the // my son, the Emacs barfs, the botch that catch... */
2996 return concat (current_directory
,
2997 IS_DIR_SEPARATOR (current_directory
[strlen (current_directory
) - 1])
2998 ? "" : SLASH_STRING
,
2999 path
, (char *) NULL
);
3003 align_up (ULONGEST v
, int n
)
3005 /* Check that N is really a power of two. */
3006 gdb_assert (n
&& (n
& (n
-1)) == 0);
3007 return (v
+ n
- 1) & -n
;
3011 align_down (ULONGEST v
, int n
)
3013 /* Check that N is really a power of two. */
3014 gdb_assert (n
&& (n
& (n
-1)) == 0);
3021 gdb_sign_extend (LONGEST value
, int bit
)
3023 gdb_assert (bit
>= 1 && bit
<= 8 * sizeof (LONGEST
));
3025 if (((value
>> (bit
- 1)) & 1) != 0)
3027 LONGEST signbit
= ((LONGEST
) 1) << (bit
- 1);
3029 value
= (value
^ signbit
) - signbit
;
3035 /* Allocation function for the libiberty hash table which uses an
3036 obstack. The obstack is passed as DATA. */
3039 hashtab_obstack_allocate (void *data
, size_t size
, size_t count
)
3041 unsigned int total
= size
* count
;
3042 void *ptr
= obstack_alloc ((struct obstack
*) data
, total
);
3044 memset (ptr
, 0, total
);
3048 /* Trivial deallocation function for the libiberty splay tree and hash
3049 table - don't deallocate anything. Rely on later deletion of the
3050 obstack. DATA will be the obstack, although it is not needed
3054 dummy_obstack_deallocate (void *object
, void *data
)
3059 /* The bit offset of the highest byte in a ULONGEST, for overflow
3062 #define HIGH_BYTE_POSN ((sizeof (ULONGEST) - 1) * HOST_CHAR_BIT)
3064 /* True (non-zero) iff DIGIT is a valid digit in radix BASE,
3065 where 2 <= BASE <= 36. */
3068 is_digit_in_base (unsigned char digit
, int base
)
3070 if (!isalnum (digit
))
3073 return (isdigit (digit
) && digit
< base
+ '0');
3075 return (isdigit (digit
) || tolower (digit
) < base
- 10 + 'a');
3079 digit_to_int (unsigned char c
)
3084 return tolower (c
) - 'a' + 10;
3087 /* As for strtoul, but for ULONGEST results. */
3090 strtoulst (const char *num
, const char **trailer
, int base
)
3092 unsigned int high_part
;
3097 /* Skip leading whitespace. */
3098 while (isspace (num
[i
]))
3101 /* Handle prefixes. */
3104 else if (num
[i
] == '-')
3110 if (base
== 0 || base
== 16)
3112 if (num
[i
] == '0' && (num
[i
+ 1] == 'x' || num
[i
+ 1] == 'X'))
3120 if (base
== 0 && num
[i
] == '0')
3126 if (base
< 2 || base
> 36)
3132 result
= high_part
= 0;
3133 for (; is_digit_in_base (num
[i
], base
); i
+= 1)
3135 result
= result
* base
+ digit_to_int (num
[i
]);
3136 high_part
= high_part
* base
+ (unsigned int) (result
>> HIGH_BYTE_POSN
);
3137 result
&= ((ULONGEST
) 1 << HIGH_BYTE_POSN
) - 1;
3138 if (high_part
> 0xff)
3141 result
= ~ (ULONGEST
) 0;
3148 if (trailer
!= NULL
)
3151 result
= result
+ ((ULONGEST
) high_part
<< HIGH_BYTE_POSN
);
3158 /* Simple, portable version of dirname that does not modify its
3162 ldirname (const char *filename
)
3164 const char *base
= lbasename (filename
);
3167 while (base
> filename
&& IS_DIR_SEPARATOR (base
[-1]))
3170 if (base
== filename
)
3173 dirname
= xmalloc (base
- filename
+ 2);
3174 memcpy (dirname
, filename
, base
- filename
);
3176 /* On DOS based file systems, convert "d:foo" to "d:.", so that we
3177 create "d:./bar" later instead of the (different) "d:/bar". */
3178 if (base
- filename
== 2 && IS_ABSOLUTE_PATH (base
)
3179 && !IS_DIR_SEPARATOR (filename
[0]))
3180 dirname
[base
++ - filename
] = '.';
3182 dirname
[base
- filename
] = '\0';
3186 /* Call libiberty's buildargv, and return the result.
3187 If buildargv fails due to out-of-memory, call nomem.
3188 Therefore, the returned value is guaranteed to be non-NULL,
3189 unless the parameter itself is NULL. */
3192 gdb_buildargv (const char *s
)
3194 char **argv
= buildargv (s
);
3196 if (s
!= NULL
&& argv
== NULL
)
3202 compare_positive_ints (const void *ap
, const void *bp
)
3204 /* Because we know we're comparing two ints which are positive,
3205 there's no danger of overflow here. */
3206 return * (int *) ap
- * (int *) bp
;
3209 /* String compare function for qsort. */
3212 compare_strings (const void *arg1
, const void *arg2
)
3214 const char **s1
= (const char **) arg1
;
3215 const char **s2
= (const char **) arg2
;
3217 return strcmp (*s1
, *s2
);
3220 #define AMBIGUOUS_MESS1 ".\nMatching formats:"
3221 #define AMBIGUOUS_MESS2 \
3222 ".\nUse \"set gnutarget format-name\" to specify the format."
3225 gdb_bfd_errmsg (bfd_error_type error_tag
, char **matching
)
3231 /* Check if errmsg just need simple return. */
3232 if (error_tag
!= bfd_error_file_ambiguously_recognized
|| matching
== NULL
)
3233 return bfd_errmsg (error_tag
);
3235 ret_len
= strlen (bfd_errmsg (error_tag
)) + strlen (AMBIGUOUS_MESS1
)
3236 + strlen (AMBIGUOUS_MESS2
);
3237 for (p
= matching
; *p
; p
++)
3238 ret_len
+= strlen (*p
) + 1;
3239 ret
= xmalloc (ret_len
+ 1);
3241 make_cleanup (xfree
, ret
);
3243 strcpy (retp
, bfd_errmsg (error_tag
));
3244 retp
+= strlen (retp
);
3246 strcpy (retp
, AMBIGUOUS_MESS1
);
3247 retp
+= strlen (retp
);
3249 for (p
= matching
; *p
; p
++)
3251 sprintf (retp
, " %s", *p
);
3252 retp
+= strlen (retp
);
3256 strcpy (retp
, AMBIGUOUS_MESS2
);
3261 /* Return ARGS parsed as a valid pid, or throw an error. */
3264 parse_pid_to_attach (const char *args
)
3270 error_no_arg (_("process-id to attach"));
3272 dummy
= (char *) args
;
3273 pid
= strtoul (args
, &dummy
, 0);
3274 /* Some targets don't set errno on errors, grrr! */
3275 if ((pid
== 0 && dummy
== args
) || dummy
!= &args
[strlen (args
)])
3276 error (_("Illegal process-id: %s."), args
);
3281 /* Helper for make_bpstat_clear_actions_cleanup. */
3284 do_bpstat_clear_actions_cleanup (void *unused
)
3286 bpstat_clear_actions ();
3289 /* Call bpstat_clear_actions for the case an exception is throw. You should
3290 discard_cleanups if no exception is caught. */
3293 make_bpstat_clear_actions_cleanup (void)
3295 return make_cleanup (do_bpstat_clear_actions_cleanup
, NULL
);
3298 /* Check for GCC >= 4.x according to the symtab->producer string. Return minor
3299 version (x) of 4.x in such case. If it is not GCC or it is GCC older than
3300 4.x return -1. If it is GCC 5.x or higher return INT_MAX. */
3303 producer_is_gcc_ge_4 (const char *producer
)
3308 if (producer
== NULL
)
3310 /* For unknown compilers expect their behavior is not compliant. For GCC
3311 this case can also happen for -gdwarf-4 type units supported since
3317 /* Skip any identifier after "GNU " - such as "C++" or "Java". */
3319 if (strncmp (producer
, "GNU ", strlen ("GNU ")) != 0)
3321 /* For non-GCC compilers expect their behavior is not compliant. */
3325 cs
= &producer
[strlen ("GNU ")];
3326 while (*cs
&& !isdigit (*cs
))
3328 if (sscanf (cs
, "%d.%d", &major
, &minor
) != 2)
3330 /* Not recognized as GCC. */
3342 /* Helper for make_cleanup_free_char_ptr_vec. */
3345 do_free_char_ptr_vec (void *arg
)
3347 VEC (char_ptr
) *char_ptr_vec
= arg
;
3349 free_char_ptr_vec (char_ptr_vec
);
3352 /* Make cleanup handler calling xfree for each element of CHAR_PTR_VEC and
3353 final VEC_free for CHAR_PTR_VEC itself.
3355 You must not modify CHAR_PTR_VEC after this cleanup registration as the
3356 CHAR_PTR_VEC base address may change on its updates. Contrary to VEC_free
3357 this function does not (cannot) clear the pointer. */
3360 make_cleanup_free_char_ptr_vec (VEC (char_ptr
) *char_ptr_vec
)
3362 return make_cleanup (do_free_char_ptr_vec
, char_ptr_vec
);
3365 /* Substitute all occurences of string FROM by string TO in *STRINGP. *STRINGP
3366 must come from xrealloc-compatible allocator and it may be updated. FROM
3367 needs to be delimited by IS_DIR_SEPARATOR or DIRNAME_SEPARATOR (or be
3368 located at the start or end of *STRINGP. */
3371 substitute_path_component (char **stringp
, const char *from
, const char *to
)
3373 char *string
= *stringp
, *s
;
3374 const size_t from_len
= strlen (from
);
3375 const size_t to_len
= strlen (to
);
3379 s
= strstr (s
, from
);
3383 if ((s
== string
|| IS_DIR_SEPARATOR (s
[-1])
3384 || s
[-1] == DIRNAME_SEPARATOR
)
3385 && (s
[from_len
] == '\0' || IS_DIR_SEPARATOR (s
[from_len
])
3386 || s
[from_len
] == DIRNAME_SEPARATOR
))
3390 string_new
= xrealloc (string
, (strlen (string
) + to_len
+ 1));
3392 /* Relocate the current S pointer. */
3393 s
= s
- string
+ string_new
;
3394 string
= string_new
;
3396 /* Replace from by to. */
3397 memmove (&s
[to_len
], &s
[from_len
], strlen (&s
[from_len
]) + 1);
3398 memcpy (s
, to
, to_len
);
3413 /* SIGALRM handler for waitpid_with_timeout. */
3416 sigalrm_handler (int signo
)
3418 /* Nothing to do. */
3423 /* Wrapper to wait for child PID to die with TIMEOUT.
3424 TIMEOUT is the time to stop waiting in seconds.
3425 If TIMEOUT is zero, pass WNOHANG to waitpid.
3426 Returns PID if it was successfully waited for, otherwise -1.
3428 Timeouts are currently implemented with alarm and SIGALRM.
3429 If the host does not support them, this waits "forever".
3430 It would be odd though for a host to have waitpid and not SIGALRM. */
3433 wait_to_die_with_timeout (pid_t pid
, int *status
, int timeout
)
3435 pid_t waitpid_result
;
3437 gdb_assert (pid
> 0);
3438 gdb_assert (timeout
>= 0);
3443 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3444 struct sigaction sa
, old_sa
;
3446 sa
.sa_handler
= sigalrm_handler
;
3447 sigemptyset (&sa
.sa_mask
);
3449 sigaction (SIGALRM
, &sa
, &old_sa
);
3453 ofunc
= (void (*)()) signal (SIGALRM
, sigalrm_handler
);
3459 waitpid_result
= waitpid (pid
, status
, 0);
3463 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
3464 sigaction (SIGALRM
, &old_sa
, NULL
);
3466 signal (SIGALRM
, ofunc
);
3471 waitpid_result
= waitpid (pid
, status
, WNOHANG
);
3473 if (waitpid_result
== pid
)
3479 #endif /* HAVE_WAITPID */
3481 /* Provide fnmatch compatible function for FNM_FILE_NAME matching of host files.
3482 Both FNM_FILE_NAME and FNM_NOESCAPE must be set in FLAGS.
3484 It handles correctly HAVE_DOS_BASED_FILE_SYSTEM and
3485 HAVE_CASE_INSENSITIVE_FILE_SYSTEM. */
3488 gdb_filename_fnmatch (const char *pattern
, const char *string
, int flags
)
3490 gdb_assert ((flags
& FNM_FILE_NAME
) != 0);
3492 /* It is unclear how '\' escaping vs. directory separator should coexist. */
3493 gdb_assert ((flags
& FNM_NOESCAPE
) != 0);
3495 #ifdef HAVE_DOS_BASED_FILE_SYSTEM
3497 char *pattern_slash
, *string_slash
;
3499 /* Replace '\' by '/' in both strings. */
3501 pattern_slash
= alloca (strlen (pattern
) + 1);
3502 strcpy (pattern_slash
, pattern
);
3503 pattern
= pattern_slash
;
3504 for (; *pattern_slash
!= 0; pattern_slash
++)
3505 if (IS_DIR_SEPARATOR (*pattern_slash
))
3506 *pattern_slash
= '/';
3508 string_slash
= alloca (strlen (string
) + 1);
3509 strcpy (string_slash
, string
);
3510 string
= string_slash
;
3511 for (; *string_slash
!= 0; string_slash
++)
3512 if (IS_DIR_SEPARATOR (*string_slash
))
3513 *string_slash
= '/';
3515 #endif /* HAVE_DOS_BASED_FILE_SYSTEM */
3517 #ifdef HAVE_CASE_INSENSITIVE_FILE_SYSTEM
3518 flags
|= FNM_CASEFOLD
;
3519 #endif /* HAVE_CASE_INSENSITIVE_FILE_SYSTEM */
3521 return fnmatch (pattern
, string
, flags
);
3524 /* Provide a prototype to silence -Wmissing-prototypes. */
3525 extern initialize_file_ftype _initialize_utils
;
3528 _initialize_utils (void)
3530 add_internal_problem_command (&internal_error_problem
);
3531 add_internal_problem_command (&internal_warning_problem
);