1 /* *INDENT-OFF* */ /* ATTR_FORMAT confuses indent, avoid running it for now */
2 /* Basic, host-specific, and target-specific definitions for GDB.
3 Copyright 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
4 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
5 Free Software Foundation, Inc.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place - Suite 330,
22 Boston, MA 02111-1307, USA. */
27 #include "config.h" /* Generated by configure. */
30 #include <errno.h> /* System call error return status. */
36 #include <sys/types.h> /* For size_t. */
43 /* First include ansidecl.h so we can use the various macro definitions
44 here and in all subsequent file inclusions. */
48 #include "gdb_locale.h"
50 /* For ``enum target_signal''. */
51 #include "gdb/signals.h"
53 /* Just in case they're not defined in stdio.h. */
62 #include <stdarg.h> /* For va_list. */
64 #include "libiberty.h"
66 /* For BFD64 and bfd_vma. */
70 /* The target is partially multi-arched. Both "tm.h" and the
71 multi-arch vector provide definitions. "tm.h" normally overrides
72 the multi-arch vector (but there are a few exceptions). */
74 #define GDB_MULTI_ARCH_PARTIAL 1
76 /* The target is partially multi-arched. Both the multi-arch vector
77 and "tm.h" provide definitions. "tm.h" cannot override a definition
78 provided by the multi-arch vector. It is detected as a compilation
81 This setting is only useful during a multi-arch conversion. */
83 #define GDB_MULTI_ARCH_TM 2
85 /* The target is pure multi-arch. The MULTI-ARCH vector provides all
86 definitions. "tm.h" is linked to an empty file. */
88 #define GDB_MULTI_ARCH_PURE 3
92 /* An address in the program being debugged. Host byte order. Rather
93 than duplicate all the logic in BFD which figures out what type
94 this is (long, long long, etc.) and whether it needs to be 64
95 bits (the host/target interactions are subtle), we just use
98 typedef bfd_vma CORE_ADDR;
100 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
106 #define LONGEST BFD_HOST_64_BIT
107 #define ULONGEST BFD_HOST_U_64_BIT
111 #ifdef CC_HAS_LONG_LONG
112 #define LONGEST long long
113 #define ULONGEST unsigned long long
115 #ifdef BFD_HOST_64_BIT
116 /* BFD_HOST_64_BIT is defined for some hosts that don't have long long
117 (e.g. i386-windows) so try it. */
118 #define LONGEST BFD_HOST_64_BIT
119 #define ULONGEST BFD_HOST_U_64_BIT
122 #define ULONGEST unsigned long
126 #endif /* No BFD64 */
128 #endif /* ! LONGEST */
131 #define min(a, b) ((a) < (b) ? (a) : (b))
134 #define max(a, b) ((a) > (b) ? (a) : (b))
137 /* Macros to do string compares.
139 NOTE: cagney/2000-03-14:
141 While old code can continue to refer to these macros, new code is
142 probably better off using strcmp() directly vis: ``strcmp() == 0''
143 and ``strcmp() != 0''.
145 This is because modern compilers can directly inline strcmp()
146 making the original justification for these macros - avoid function
147 call overhead by pre-testing the first characters
148 (``*X==*Y?...:0'') - redundant.
150 ``Even if [...] testing the first character does have a modest
151 performance improvement, I'd rather that whenever a performance
152 issue is found that we spend the effort on algorithmic
153 optimizations than micro-optimizing.'' J.T. */
155 /* NOTE: cagney/2003-11-23: All instances of STREQ[N] covered by
156 testing GDB on a stabs system have been replaced by equivalent
157 str[n]cmp calls. To avoid the possability of introducing bugs when
158 making untested changes, the remaining references were deprecated
159 rather than replaced. */
161 /* DISCLAIMER: cagney/2003-11-23: Simplified definition of these
162 macros so that they just map directly onto strcmp equivalent. I'm
163 not responsible for any breakage due to code that relied on the old
164 underlying implementation. */
166 #define DEPRECATED_STREQ(a,b) (strcmp ((a), (b)) == 0)
167 #define DEPRECATED_STREQN(a,b,c) (strncmp ((a), (b), (c)) == 0)
169 /* Check if a character is one of the commonly used C++ marker characters. */
170 extern int is_cplus_marker (int);
172 /* enable xdb commands if set */
173 extern int xdb_commands;
175 /* enable dbx commands if set */
176 extern int dbx_commands;
178 /* System root path, used to find libraries etc. */
179 extern char *gdb_sysroot;
181 extern int quit_flag;
182 extern int immediate_quit;
183 extern int sevenbit_strings;
185 extern void quit (void);
187 /* FIXME: cagney/2000-03-13: It has been suggested that the peformance
188 benefits of having a ``QUIT'' macro rather than a function are
189 marginal. If the overhead of a QUIT function call is proving
190 significant then its calling frequency should probably be reduced
191 [kingdon]. A profile analyzing the current situtation is
195 /* do twice to force compiler warning */
196 #define QUIT_FIXME "FIXME"
197 #define QUIT_FIXME "ignoring redefinition of QUIT"
200 if (quit_flag) quit (); \
201 if (deprecated_interactive_hook) deprecated_interactive_hook (); \
205 /* Languages represented in the symbol table and elsewhere.
206 This should probably be in language.h, but since enum's can't
207 be forward declared to satisfy opaque references before their
208 actual definition, needs to be here. */
212 language_unknown, /* Language not known */
213 language_auto, /* Placeholder for automatic setting */
215 language_cplus, /* C++ */
216 language_objc, /* Objective-C */
217 language_java, /* Java */
218 language_fortran, /* Fortran */
219 language_m2, /* Modula-2 */
220 language_asm, /* Assembly language */
221 language_scm, /* Scheme / Guile */
222 language_pascal, /* Pascal */
223 language_minimal, /* All other languages, minimal support only */
231 unspecified_precision
234 /* A generic, not quite boolean, enumeration. */
242 /* Potential ways that a function can return a value of a given type. */
243 enum return_value_convention
245 /* Where the return value has been squeezed into one or more
247 RETURN_VALUE_REGISTER_CONVENTION,
248 /* Commonly known as the "struct return convention". The caller
249 passes an additional hidden first parameter to the caller. That
250 parameter contains the address at which the value being returned
251 should be stored. While typically, and historically, used for
252 large structs, this is convention is applied to values of many
254 RETURN_VALUE_STRUCT_CONVENTION,
255 /* Like the "struct return convention" above, but where the ABI
256 guarantees that the called function stores the address at which
257 the value being returned is stored in a well-defined location,
258 such as a register or memory slot in the stack frame. Don't use
259 this if the ABI doesn't explicitly guarantees this. */
260 RETURN_VALUE_ABI_RETURNS_ADDRESS,
261 /* Like the "struct return convention" above, but where the ABI
262 guarantees that the address at which the value being returned is
263 stored will be available in a well-defined location, such as a
264 register or memory slot in the stack frame. Don't use this if
265 the ABI doesn't explicitly guarantees this. */
266 RETURN_VALUE_ABI_PRESERVES_ADDRESS,
269 /* the cleanup list records things that have to be undone
270 if an error happens (descriptors to be closed, memory to be freed, etc.)
271 Each link in the chain records a function to call and an
274 Use make_cleanup to add an element to the cleanup chain.
275 Use do_cleanups to do all cleanup actions back to a given
276 point in the chain. Use discard_cleanups to remove cleanups
277 from the chain back to a given point, not doing them. */
281 struct cleanup *next;
282 void (*function) (void *);
287 /* The ability to declare that a function never returns is useful, but
288 not really required to compile GDB successfully, so the NORETURN and
289 ATTR_NORETURN macros normally expand into nothing. */
291 /* If compiling with older versions of GCC, a function may be declared
292 "volatile" to indicate that it does not return. */
295 #if defined(__GNUC__) \
296 && (__GNUC__ == 1 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7))
297 #define NORETURN volatile
299 #define NORETURN /* nothing */
303 /* GCC 2.5 and later versions define a function attribute "noreturn",
304 which is the preferred way to declare that a function never returns.
305 However GCC 2.7 appears to be the first version in which this fully
306 works everywhere we use it. */
308 #ifndef ATTR_NORETURN
309 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7))
310 #define ATTR_NORETURN __attribute__ ((noreturn))
312 #define ATTR_NORETURN /* nothing */
317 #if defined(__GNUC__) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 4))
318 #define ATTR_FORMAT(type, x, y) __attribute__ ((format(type, x, y)))
320 #define ATTR_FORMAT(type, x, y) /* nothing */
324 /* Be conservative and use enum bitfields only with GCC.
325 This is copied from gcc 3.3.1, system.h. */
327 #if defined(__GNUC__) && (__GNUC__ >= 2)
328 #define ENUM_BITFIELD(TYPE) enum TYPE
330 #define ENUM_BITFIELD(TYPE) unsigned int
333 /* Needed for various prototypes */
339 /* From blockframe.c */
341 extern int inside_entry_func (struct frame_info *this_frame);
343 extern int inside_main_func (CORE_ADDR pc);
347 extern void initialize_utils (void);
349 extern void notice_quit (void);
351 extern int strcmp_iw (const char *, const char *);
353 extern int strcmp_iw_ordered (const char *, const char *);
355 extern int streq (const char *, const char *);
357 extern int subset_compare (char *, char *);
359 extern char *safe_strerror (int);
361 extern void init_malloc (void *);
363 extern void request_quit (int);
365 extern void do_cleanups (struct cleanup *);
366 extern void do_final_cleanups (struct cleanup *);
367 extern void do_run_cleanups (struct cleanup *);
368 extern void do_exec_cleanups (struct cleanup *);
369 extern void do_exec_error_cleanups (struct cleanup *);
371 extern void discard_cleanups (struct cleanup *);
372 extern void discard_final_cleanups (struct cleanup *);
373 extern void discard_exec_error_cleanups (struct cleanup *);
374 extern void discard_my_cleanups (struct cleanup **, struct cleanup *);
376 /* NOTE: cagney/2000-03-04: This typedef is strictly for the
377 make_cleanup function declarations below. Do not use this typedef
378 as a cast when passing functions into the make_cleanup() code.
379 Instead either use a bounce function or add a wrapper function.
380 Calling a f(char*) function with f(void*) is non-portable. */
381 typedef void (make_cleanup_ftype) (void *);
383 extern struct cleanup *make_cleanup (make_cleanup_ftype *, void *);
385 extern struct cleanup *make_cleanup_freeargv (char **);
388 extern struct cleanup *make_cleanup_ui_file_delete (struct ui_file *);
390 extern struct cleanup *make_cleanup_close (int fd);
392 extern struct cleanup *make_cleanup_bfd_close (bfd *abfd);
394 extern struct cleanup *make_final_cleanup (make_cleanup_ftype *, void *);
396 extern struct cleanup *make_my_cleanup (struct cleanup **,
397 make_cleanup_ftype *, void *);
399 extern struct cleanup *make_run_cleanup (make_cleanup_ftype *, void *);
401 extern struct cleanup *make_exec_cleanup (make_cleanup_ftype *, void *);
402 extern struct cleanup *make_exec_error_cleanup (make_cleanup_ftype *, void *);
404 extern struct cleanup *save_cleanups (void);
405 extern struct cleanup *save_final_cleanups (void);
406 extern struct cleanup *save_my_cleanups (struct cleanup **);
408 extern void restore_cleanups (struct cleanup *);
409 extern void restore_final_cleanups (struct cleanup *);
410 extern void restore_my_cleanups (struct cleanup **, struct cleanup *);
412 extern void free_current_contents (void *);
414 extern void null_cleanup (void *);
416 extern int myread (int, char *, int);
418 extern int query (const char *, ...) ATTR_FORMAT (printf, 1, 2);
419 extern int nquery (const char *, ...) ATTR_FORMAT (printf, 1, 2);
420 extern int yquery (const char *, ...) ATTR_FORMAT (printf, 1, 2);
422 extern void init_page_info (void);
424 extern char *gdb_realpath (const char *);
425 extern char *xfullpath (const char *);
427 extern unsigned long gnu_debuglink_crc32 (unsigned long crc,
428 unsigned char *buf, size_t len);
430 /* From demangle.c */
432 extern void set_demangling_style (char *);
437 typedef int (use_struct_convention_fn) (int gcc_p, struct type * value_type);
438 extern use_struct_convention_fn generic_use_struct_convention;
441 /* Annotation stuff. */
443 extern int annotation_level; /* in stack.c */
445 extern void begin_line (void);
447 extern void wrap_here (char *);
449 extern void reinitialize_more_filter (void);
452 extern struct ui_file *gdb_stdout;
454 extern struct ui_file *gdb_stdin;
455 /* Serious error notifications */
456 extern struct ui_file *gdb_stderr;
457 /* Log/debug/trace messages that should bypass normal stdout/stderr
458 filtering. For moment, always call this stream using
459 *_unfiltered. In the very near future that restriction shall be
460 removed - either call shall be unfiltered. (cagney 1999-06-13). */
461 extern struct ui_file *gdb_stdlog;
462 /* Target output that should bypass normal stdout/stderr filtering.
463 For moment, always call this stream using *_unfiltered. In the
464 very near future that restriction shall be removed - either call
465 shall be unfiltered. (cagney 1999-07-02). */
466 extern struct ui_file *gdb_stdtarg;
467 extern struct ui_file *gdb_stdtargerr;
468 extern struct ui_file *gdb_stdtargin;
472 /* More generic printf like operations. Filtered versions may return
473 non-locally on error. */
475 extern void fputs_filtered (const char *, struct ui_file *);
477 extern void fputs_unfiltered (const char *, struct ui_file *);
479 extern int fputc_filtered (int c, struct ui_file *);
481 extern int fputc_unfiltered (int c, struct ui_file *);
483 extern int putchar_filtered (int c);
485 extern int putchar_unfiltered (int c);
487 extern void puts_filtered (const char *);
489 extern void puts_unfiltered (const char *);
491 extern void puts_filtered_tabular (char *string, int width, int right);
493 extern void puts_debug (char *prefix, char *string, char *suffix);
495 extern void vprintf_filtered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
497 extern void vfprintf_filtered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
499 extern void fprintf_filtered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
501 extern void fprintfi_filtered (int, struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 3, 4);
503 extern void printf_filtered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
505 extern void printfi_filtered (int, const char *, ...) ATTR_FORMAT (printf, 2, 3);
507 extern void vprintf_unfiltered (const char *, va_list) ATTR_FORMAT (printf, 1, 0);
509 extern void vfprintf_unfiltered (struct ui_file *, const char *, va_list) ATTR_FORMAT (printf, 2, 0);
511 extern void fprintf_unfiltered (struct ui_file *, const char *, ...) ATTR_FORMAT (printf, 2, 3);
513 extern void printf_unfiltered (const char *, ...) ATTR_FORMAT (printf, 1, 2);
515 extern void print_spaces (int, struct ui_file *);
517 extern void print_spaces_filtered (int, struct ui_file *);
519 extern char *n_spaces (int);
521 extern void fputstr_filtered (const char *str, int quotr, struct ui_file * stream);
523 extern void fputstr_unfiltered (const char *str, int quotr, struct ui_file * stream);
525 extern void fputstrn_unfiltered (const char *str, int n, int quotr, struct ui_file * stream);
527 /* Display the host ADDR on STREAM formatted as ``0x%x''. */
528 extern void gdb_print_host_address (const void *addr, struct ui_file *stream);
530 /* Convert a CORE_ADDR into a HEX string. paddr() is like %08lx.
531 paddr_nz() is like %lx. paddr_u() is like %lu. paddr_width() is
533 extern int strlen_paddr (void);
534 extern char *paddr (CORE_ADDR addr);
535 extern char *paddr_nz (CORE_ADDR addr);
536 extern char *paddr_u (CORE_ADDR addr);
537 extern char *paddr_d (LONGEST addr);
539 extern char *phex (ULONGEST l, int sizeof_l);
540 extern char *phex_nz (ULONGEST l, int sizeof_l);
542 /* Like paddr() only print/scan raw CORE_ADDR. The output from
543 core_addr_to_string() can be passed direct to
544 string_to_core_addr(). */
545 extern const char *core_addr_to_string (const CORE_ADDR addr);
546 extern const char *core_addr_to_string_nz (const CORE_ADDR addr);
547 extern CORE_ADDR string_to_core_addr (const char *my_string);
549 extern void fprintf_symbol_filtered (struct ui_file *, char *,
552 extern NORETURN void perror_with_name (const char *) ATTR_NORETURN;
554 extern void print_sys_errmsg (const char *, int);
556 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
557 "const char *" in unistd.h, so we can't declare the argument
560 extern char *re_comp (const char *);
564 extern void symbol_file_command (char *, int);
566 /* Remote targets may wish to use this as their load function. */
567 extern void generic_load (char *name, int from_tty);
569 /* Summarise a download */
570 extern void print_transfer_performance (struct ui_file *stream,
571 unsigned long data_count,
572 unsigned long write_count,
573 unsigned long time_count);
577 typedef void initialize_file_ftype (void);
579 extern char *skip_quoted (char *);
581 extern char *gdb_readline (char *);
583 extern char *gdb_readline_wrapper (char *);
585 extern char *command_line_input (char *, int, char *);
587 extern void print_prompt (void);
589 extern int input_from_terminal_p (void);
591 extern int info_verbose;
593 /* From printcmd.c */
595 extern void set_next_address (CORE_ADDR);
597 extern void print_address_symbolic (CORE_ADDR, struct ui_file *, int,
600 extern int build_address_symbolic (CORE_ADDR addr,
608 extern void print_address_numeric (CORE_ADDR, int, struct ui_file *);
610 extern void print_address (CORE_ADDR, struct ui_file *);
614 extern int openp (const char *, int, const char *, int, int, char **);
616 extern int source_full_path_of (char *, char **);
618 extern void mod_path (char *, char **);
620 extern void add_path (char *, char **, int);
622 extern void directory_command (char *, int);
624 extern char *source_path;
626 extern void init_source_path (void);
628 extern void init_last_source_visited (void);
632 extern void exec_set_section_offsets (bfd_signed_vma text_off,
633 bfd_signed_vma data_off,
634 bfd_signed_vma bss_off);
636 /* Take over the 'find_mapped_memory' vector from exec.c. */
637 extern void exec_set_find_memory_regions (int (*) (int (*) (CORE_ADDR,
643 /* Possible lvalue types. Like enum language, this should be in
644 value.h, but needs to be here for the same reason. */
650 /* In memory. Could be a saved register. */
654 /* In a gdb internal variable. */
656 /* Part of a gdb internal variable (structure field). */
657 lval_internalvar_component,
658 /* In a register series in a frame not the current one, which may have been
659 partially saved or saved in different places (otherwise would be
660 lval_register or lval_memory). */
661 lval_reg_frame_relative
664 /* Control types for commands */
666 enum misc_command_type
674 enum command_control_type
684 /* Structure for saved commands lines
685 (for breakpoints, defined commands, etc). */
689 struct command_line *next;
691 enum command_control_type control_type;
693 struct command_line **body_list;
696 extern struct command_line *read_command_lines (char *, int);
698 extern void free_command_lines (struct command_line **);
700 /* To continue the execution commands when running gdb asynchronously.
701 A continuation structure contains a pointer to a function to be called
702 to finish the command, once the target has stopped. Such mechanism is
703 used bt the finish and until commands, and in the remote protocol
704 when opening an extended-remote connection. */
706 struct continuation_arg
708 struct continuation_arg *next;
709 union continuation_data {
718 void (*continuation_hook) (struct continuation_arg *);
719 struct continuation_arg *arg_list;
720 struct continuation *next;
724 extern struct continuation *cmd_continuation;
725 /* Used only by the step_1 function. */
726 extern struct continuation *intermediate_continuation;
729 extern void add_continuation (void (*)(struct continuation_arg *),
730 struct continuation_arg *);
731 extern void do_all_continuations (void);
732 extern void discard_all_continuations (void);
734 extern void add_intermediate_continuation (void (*)(struct continuation_arg *),
735 struct continuation_arg *);
736 extern void do_all_intermediate_continuations (void);
737 extern void discard_all_intermediate_continuations (void);
739 /* String containing the current directory (what getwd would return). */
741 extern char *current_directory;
743 /* Default radixes for input and output. Only some values supported. */
744 extern unsigned input_radix;
745 extern unsigned output_radix;
747 /* Possibilities for prettyprint parameters to routines which print
748 things. Like enum language, this should be in value.h, but needs
749 to be here for the same reason. FIXME: If we can eliminate this
750 as an arg to LA_VAL_PRINT, then we can probably move it back to
755 Val_no_prettyprint = 0,
757 /* Use the default setting which the user has specified. */
761 /* The ptid struct is a collection of the various "ids" necessary
762 for identifying the inferior. This consists of the process id
763 (pid), thread id (tid), and other fields necessary for uniquely
764 identifying the inferior process/thread being debugged. When
765 manipulating ptids, the constructors, accessors, and predicate
766 declared in inferior.h should be used. These are as follows:
768 ptid_build - Make a new ptid from a pid, lwp, and tid.
769 pid_to_ptid - Make a new ptid from just a pid.
770 ptid_get_pid - Fetch the pid component of a ptid.
771 ptid_get_lwp - Fetch the lwp component of a ptid.
772 ptid_get_tid - Fetch the tid component of a ptid.
773 ptid_equal - Test to see if two ptids are equal.
775 Please do NOT access the struct ptid members directly (except, of
776 course, in the implementation of the above ptid manipulation
784 /* Lightweight process id */
791 typedef struct ptid ptid_t;
795 /* Optional host machine definition. Pure autoconf targets will not
796 need a "xm.h" file. This will be a symlink to one of the xm-*.h
797 files, built by the `configure' script. */
803 /* Optional native machine support. Non-native (and possibly pure
804 multi-arch) targets do not need a "nm.h" file. This will be a
805 symlink to one of the nm-*.h files, built by the `configure'
812 /* Optional target machine definition. Pure multi-arch configurations
813 do not need a "tm.h" file. This will be a symlink to one of the
814 tm-*.h files, built by the `configure' script. */
820 /* If the xm.h file did not define the mode string used to open the
821 files, assume that binary files are opened the same way as text
824 #include "fopen-same.h"
827 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).
828 FIXME: Assumes 2's complement arithmetic */
830 #if !defined (UINT_MAX)
831 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
834 #if !defined (INT_MAX)
835 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
838 #if !defined (INT_MIN)
839 #define INT_MIN ((int)((int) ~0 ^ INT_MAX)) /* 0x80000000 for 32-bits */
842 #if !defined (ULONG_MAX)
843 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
846 #if !defined (LONG_MAX)
847 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
850 #if !defined (ULONGEST_MAX)
851 #define ULONGEST_MAX (~(ULONGEST)0) /* 0xFFFFFFFFFFFFFFFF for 64-bits */
854 #if !defined (LONGEST_MAX) /* 0x7FFFFFFFFFFFFFFF for 64-bits */
855 #define LONGEST_MAX ((LONGEST)(ULONGEST_MAX >> 1))
858 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
859 arguments to a function, number in a value history, register number, etc.)
860 where the value must not be larger than can fit in an int. */
862 extern int longest_to_int (LONGEST);
864 /* Assorted functions we can declare, now that const and volatile are
867 extern char *savestring (const char *, size_t);
869 extern char *msavestring (void *, const char *, size_t);
871 extern char *mstrsave (void *, const char *);
873 /* Robust versions of same. Throw an internal error when no memory,
874 guard against stray NULL arguments. */
875 extern void *xmmalloc (void *md, size_t size);
876 extern void *xmrealloc (void *md, void *ptr, size_t size);
877 extern void *xmcalloc (void *md, size_t number, size_t size);
878 extern void xmfree (void *md, void *ptr);
880 /* xmalloc(), xrealloc() and xcalloc() have already been declared in
882 extern void xfree (void *);
884 /* Utility macros to allocate typed memory. Avoids errors like:
885 struct foo *foo = xmalloc (sizeof struct bar); and memset (foo,
886 sizeof (struct foo), 0). */
887 #define XZALLOC(TYPE) ((TYPE*) memset (xmalloc (sizeof (TYPE)), 0, sizeof (TYPE)))
888 #define XMALLOC(TYPE) ((TYPE*) xmalloc (sizeof (TYPE)))
889 #define XCALLOC(NMEMB, TYPE) ((TYPE*) xcalloc ((NMEMB), sizeof (TYPE)))
891 /* Like asprintf/vasprintf but get an internal_error if the call
893 extern void xasprintf (char **ret, const char *format, ...) ATTR_FORMAT (printf, 2, 3);
894 extern void xvasprintf (char **ret, const char *format, va_list ap);
896 /* Like asprintf and vasprintf, but return the string, throw an error
898 extern char *xstrprintf (const char *format, ...) ATTR_FORMAT (printf, 1, 2);
899 extern char *xstrvprintf (const char *format, va_list ap);
901 extern int parse_escape (char **);
903 /* Message to be printed before the error message, when an error occurs. */
905 extern char *error_pre_print;
907 /* Message to be printed before the error message, when an error occurs. */
909 extern char *quit_pre_print;
911 /* Message to be printed before the warning message, when a warning occurs. */
913 extern char *warning_pre_print;
915 extern NORETURN void verror (const char *fmt, va_list ap) ATTR_NORETURN;
917 extern NORETURN void error (const char *fmt, ...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
919 extern NORETURN void error_silent (const char *fmt, ...) ATTR_NORETURN ATTR_FORMAT (printf, 1, 2);
921 extern NORETURN void error_stream (struct ui_file *) ATTR_NORETURN;
923 /* Initialize the error buffer. */
924 extern void error_init (void);
926 /* Returns a freshly allocate buffer containing the last error
928 extern char *error_last_message (void);
930 /* Output arbitrary error message. */
931 extern void error_output_message (char *pre_print, char *msg);
933 extern NORETURN void internal_verror (const char *file, int line,
934 const char *, va_list ap) ATTR_NORETURN;
936 extern NORETURN void internal_error (const char *file, int line,
937 const char *, ...) ATTR_NORETURN ATTR_FORMAT (printf, 3, 4);
939 extern void internal_vwarning (const char *file, int line,
940 const char *, va_list ap);
942 extern void internal_warning (const char *file, int line,
943 const char *, ...) ATTR_FORMAT (printf, 3, 4);
945 extern NORETURN void nomem (long) ATTR_NORETURN;
947 /* Reasons for calling throw_exception(). NOTE: all reason values
948 must be less than zero. enum value 0 is reserved for internal use
949 as the return value from an initial setjmp(). The function
950 catch_exceptions() reserves values >= 0 as legal results from its
955 /* User interrupt. */
957 /* Any other error. */
961 #define ALL_CLEANUPS ((struct cleanup *)0)
963 #define RETURN_MASK(reason) (1 << (int)(-reason))
964 #define RETURN_MASK_QUIT RETURN_MASK (RETURN_QUIT)
965 #define RETURN_MASK_ERROR RETURN_MASK (RETURN_ERROR)
966 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
967 typedef int return_mask;
969 /* Throw an exception of type RETURN_REASON. Will execute a LONG JUMP
970 to the inner most containing exception handler established using
971 catch_exceptions() (or the legacy catch_errors()).
973 Code normally throws an exception using error() et.al. For various
974 reaons, GDB also contains code that throws an exception directly.
975 For instance, the remote*.c targets contain CNTRL-C signal handlers
976 that propogate the QUIT event up the exception chain. ``This could
977 be a good thing or a dangerous thing.'' -- the Existential Wombat. */
979 extern NORETURN void throw_exception (enum return_reason) ATTR_NORETURN;
981 /* Call FUNC(UIOUT, FUNC_ARGS) but wrapped within an exception
982 handler. If an exception (enum return_reason) is thrown using
983 throw_exception() than all cleanups installed since
984 catch_exceptions() was entered are invoked, the (-ve) exception
985 value is then returned by catch_exceptions. If FUNC() returns
986 normally (with a postive or zero return value) then that value is
987 returned by catch_exceptions(). It is an internal_error() for
988 FUNC() to return a negative value.
990 For the period of the FUNC() call: UIOUT is installed as the output
991 builder; ERRSTRING is installed as the error/quit message; and a
992 new cleanup_chain is established. The old values are restored
993 before catch_exceptions() returns.
995 The variant catch_exceptions_with_msg() is the same as
996 catch_exceptions() but adds the ability to return an allocated
997 copy of the gdb error message. This is used when a silent error is
998 issued and the caller wants to manually issue the error message.
1000 FIXME; cagney/2001-08-13: The need to override the global UIOUT
1001 builder variable should just go away.
1003 This function superseeds catch_errors().
1005 This function uses SETJMP() and LONGJUMP(). */
1008 typedef int (catch_exceptions_ftype) (struct ui_out *ui_out, void *args);
1009 extern int catch_exceptions (struct ui_out *uiout,
1010 catch_exceptions_ftype *func, void *func_args,
1011 char *errstring, return_mask mask);
1012 extern int catch_exceptions_with_msg (struct ui_out *uiout,
1013 catch_exceptions_ftype *func,
1015 char *errstring, char **gdberrmsg,
1018 /* If CATCH_ERRORS_FTYPE throws an error, catch_errors() returns zero
1019 otherwize the result from CATCH_ERRORS_FTYPE is returned. It is
1020 probably useful for CATCH_ERRORS_FTYPE to always return a non-zero
1021 value. It's unfortunate that, catch_errors() does not return an
1022 indication of the exact exception that it caught - quit_flag might
1025 This function is superseeded by catch_exceptions(). */
1027 typedef int (catch_errors_ftype) (void *);
1028 extern int catch_errors (catch_errors_ftype *, void *, char *, return_mask);
1030 /* Template to catch_errors() that wraps calls to command
1033 typedef void (catch_command_errors_ftype) (char *, int);
1034 extern int catch_command_errors (catch_command_errors_ftype *func, char *command, int from_tty, return_mask);
1036 extern void warning (const char *, ...) ATTR_FORMAT (printf, 1, 2);
1038 extern void vwarning (const char *, va_list args);
1040 /* List of known OS ABIs. If you change this, make sure to update the
1041 table in osabi.c. */
1044 GDB_OSABI_UNINITIALIZED = -1, /* For struct gdbarch_info. */
1046 GDB_OSABI_UNKNOWN = 0, /* keep this zero */
1053 GDB_OSABI_FREEBSD_AOUT,
1054 GDB_OSABI_FREEBSD_ELF,
1055 GDB_OSABI_NETBSD_AOUT,
1056 GDB_OSABI_NETBSD_ELF,
1057 GDB_OSABI_OPENBSD_ELF,
1067 GDB_OSABI_ARM_EABI_V1,
1068 GDB_OSABI_ARM_EABI_V2,
1074 GDB_OSABI_INVALID /* keep this last */
1077 /* Global functions from other, non-gdb GNU thingies.
1078 Libiberty thingies are no longer declared here. We include libiberty.h
1081 #ifndef GETENV_PROVIDED
1082 extern char *getenv (const char *);
1085 /* From other system libraries */
1087 #ifdef HAVE_STDDEF_H
1091 #ifdef HAVE_STDLIB_H
1095 #define min(a, b) ((a) < (b) ? (a) : (b))
1098 #define max(a, b) ((a) > (b) ? (a) : (b))
1102 /* We take the address of fclose later, but some stdio's forget
1103 to declare this. We can't always declare it since there's
1104 no way to declare the parameters without upsetting some compiler
1107 #ifndef FCLOSE_PROVIDED
1108 extern int fclose (FILE *);
1112 extern double atof (const char *); /* X3.159-1989 4.10.1.1 */
1115 /* Various possibilities for alloca. */
1118 #define alloca __builtin_alloca
1119 #else /* Not GNU C */
1120 #ifdef HAVE_ALLOCA_H
1127 /* We need to be careful not to declare this in a way which conflicts with
1128 bison. Bison never declares it as char *, but under various circumstances
1129 (like __hpux) we need to use void *. */
1130 extern void *alloca ();
1131 #endif /* Not _AIX */
1132 #endif /* Not HAVE_ALLOCA_H */
1133 #endif /* Not GNU C */
1134 #endif /* alloca not defined */
1136 /* Is GDB multi-arch? If there's a "tm.h" file, it is not. */
1137 #ifndef GDB_MULTI_ARCH
1139 #define GDB_MULTI_ARCH GDB_MULTI_ARCH_PARTIAL
1141 #define GDB_MULTI_ARCH GDB_MULTI_ARCH_PURE
1145 /* Dynamic target-system-dependent parameters for GDB. */
1146 #include "gdbarch.h"
1148 /* Maximum size of a register. Something small, but large enough for
1149 all known ISAs. If it turns out to be too small, make it bigger. */
1151 enum { MAX_REGISTER_SIZE = 16 };
1153 /* Static target-system-dependent parameters for GDB. */
1155 /* Number of bits in a char or unsigned char for the target machine.
1156 Just like CHAR_BIT in <limits.h> but describes the target machine. */
1157 #if !defined (TARGET_CHAR_BIT)
1158 #define TARGET_CHAR_BIT 8
1161 /* If we picked up a copy of CHAR_BIT from a configuration file
1162 (which may get it by including <limits.h>) then use it to set
1163 the number of bits in a host char. If not, use the same size
1166 #if defined (CHAR_BIT)
1167 #define HOST_CHAR_BIT CHAR_BIT
1169 #define HOST_CHAR_BIT TARGET_CHAR_BIT
1172 /* The bit byte-order has to do just with numbering of bits in
1173 debugging symbols and such. Conceptually, it's quite separate
1174 from byte/word byte order. */
1176 #if !defined (BITS_BIG_ENDIAN)
1177 #define BITS_BIG_ENDIAN (TARGET_BYTE_ORDER == BFD_ENDIAN_BIG)
1182 extern LONGEST extract_signed_integer (const void *, int);
1184 extern ULONGEST extract_unsigned_integer (const void *, int);
1186 extern int extract_long_unsigned_integer (const void *, int, LONGEST *);
1188 extern CORE_ADDR extract_typed_address (const void *buf, struct type *type);
1190 extern void store_signed_integer (void *, int, LONGEST);
1192 extern void store_unsigned_integer (void *, int, ULONGEST);
1194 extern void store_typed_address (void *buf, struct type *type, CORE_ADDR addr);
1199 extern CORE_ADDR push_bytes (CORE_ADDR, char *, int);
1201 extern CORE_ADDR push_word (CORE_ADDR, ULONGEST);
1203 extern int watchdog;
1205 /* Hooks for alternate command interfaces. */
1207 /* The name of the interpreter if specified on the command line. */
1208 extern char *interpreter_p;
1210 /* If a given interpreter matches INTERPRETER_P then it should update
1211 deprecated_command_loop_hook and deprecated_init_ui_hook with the
1212 per-interpreter implementation. */
1213 /* FIXME: deprecated_command_loop_hook and deprecated_init_ui_hook
1214 should be moved here. */
1216 struct target_waitstatus;
1217 struct cmd_list_element;
1219 /* Should the asynchronous variant of the interpreter (using the
1220 event-loop) be enabled? */
1221 /* NOTE: cagney/2004-06-10: GDB changed to always uses the event-loop.
1222 A follow-on cleanup is to eliminate references to
1224 #define event_loop_p 1
1226 extern void (*deprecated_pre_add_symbol_hook) (const char *);
1227 extern void (*deprecated_post_add_symbol_hook) (void);
1228 extern void (*selected_frame_level_changed_hook) (int);
1229 extern int (*deprecated_ui_loop_hook) (int signo);
1230 extern void (*deprecated_init_ui_hook) (char *argv0);
1231 extern void (*deprecated_command_loop_hook) (void);
1232 extern void (*deprecated_show_load_progress) (const char *section,
1233 unsigned long section_sent,
1234 unsigned long section_size,
1235 unsigned long total_sent,
1236 unsigned long total_size);
1237 extern void (*deprecated_print_frame_info_listing_hook) (struct symtab * s,
1238 int line, int stopline,
1240 extern struct frame_info *parse_frame_specification (char *frame_exp);
1241 extern int (*deprecated_query_hook) (const char *, va_list);
1242 extern void (*deprecated_warning_hook) (const char *, va_list);
1243 extern void (*deprecated_flush_hook) (struct ui_file * stream);
1244 extern void (*deprecated_create_breakpoint_hook) (struct breakpoint * b);
1245 extern void (*deprecated_delete_breakpoint_hook) (struct breakpoint * bpt);
1246 extern void (*deprecated_modify_breakpoint_hook) (struct breakpoint * bpt);
1247 extern void (*deprecated_interactive_hook) (void);
1248 extern void (*deprecated_registers_changed_hook) (void);
1249 extern void (*deprecated_readline_begin_hook) (char *,...);
1250 extern char *(*deprecated_readline_hook) (char *);
1251 extern void (*deprecated_readline_end_hook) (void);
1252 extern void (*deprecated_register_changed_hook) (int regno);
1253 extern void (*deprecated_memory_changed_hook) (CORE_ADDR addr, int len);
1254 extern void (*deprecated_context_hook) (int);
1255 extern ptid_t (*deprecated_target_wait_hook) (ptid_t ptid,
1256 struct target_waitstatus * status);
1258 extern void (*deprecated_attach_hook) (void);
1259 extern void (*deprecated_detach_hook) (void);
1260 extern void (*deprecated_call_command_hook) (struct cmd_list_element * c,
1261 char *cmd, int from_tty);
1263 extern void (*deprecated_set_hook) (struct cmd_list_element * c);
1265 extern NORETURN void (*deprecated_error_hook) (void) ATTR_NORETURN;
1267 extern void (*deprecated_error_begin_hook) (void);
1269 extern int (*deprecated_ui_load_progress_hook) (const char *section,
1273 /* Inhibit window interface if non-zero. */
1275 extern int use_windows;
1277 /* Symbolic definitions of filename-related things. */
1278 /* FIXME, this doesn't work very well if host and executable
1279 filesystems conventions are different. */
1281 #ifndef DIRNAME_SEPARATOR
1282 #define DIRNAME_SEPARATOR ':'
1285 #ifndef SLASH_STRING
1286 #define SLASH_STRING "/"
1291 # define GLOBAL_CURDIR
1294 /* Provide default definitions of PIDGET, TIDGET, and MERGEPID.
1295 The name ``TIDGET'' is a historical accident. Many uses of TIDGET
1296 in the code actually refer to a lightweight process id, i.e,
1297 something that can be considered a process id in its own right for
1298 certain purposes. */
1301 #define PIDGET(PTID) (ptid_get_pid (PTID))
1302 #define TIDGET(PTID) (ptid_get_lwp (PTID))
1303 #define MERGEPID(PID, TID) ptid_build (PID, TID, 0)
1306 /* Define well known filenos if the system does not define them. */
1307 #ifndef STDIN_FILENO
1308 #define STDIN_FILENO 0
1310 #ifndef STDOUT_FILENO
1311 #define STDOUT_FILENO 1
1313 #ifndef STDERR_FILENO
1314 #define STDERR_FILENO 2
1317 /* If this definition isn't overridden by the header files, assume
1318 that isatty and fileno exist on this system. */
1320 #define ISATTY(FP) (isatty (fileno (FP)))
1323 /* Ensure that V is aligned to an N byte boundary (B's assumed to be a
1324 power of 2). Round up/down when necessary. Examples of correct
1327 addr = align_up (addr, 8); -- VALUE needs 8 byte alignment
1328 write_memory (addr, value, len);
1333 sp = align_down (sp - len, 16); -- Keep SP 16 byte aligned
1334 write_memory (sp, value, len);
1336 Note that uses such as:
1338 write_memory (addr, value, len);
1339 addr += align_up (len, 8);
1343 sp -= align_up (len, 8);
1344 write_memory (sp, value, len);
1346 are typically not correct as they don't ensure that the address (SP
1347 or ADDR) is correctly aligned (relying on previous alignment to
1348 keep things right). This is also why the methods are called
1349 "align_..." instead of "round_..." as the latter reads better with
1350 this incorrect coding style. */
1352 extern ULONGEST align_up (ULONGEST v, int n);
1353 extern ULONGEST align_down (ULONGEST v, int n);
1355 #endif /* #ifndef DEFS_H */