1 /* Basic, host-specific, and target-specific definitions for GDB.
2 Copyright (C) 1986, 1989, 1991 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
25 /* First include ansidecl.h so we can use the various macro definitions
26 here and in all subsequent file inclusions. */
30 /* For BFD64 and bfd_vma. */
33 /* An address in the program being debugged. Host byte order. Rather
34 than duplicate all the logic in BFD which figures out what type
35 this is (long, long long, etc.) and whether it needs to be 64
36 bits (the host/target interactions are subtle), we just use
39 typedef bfd_vma CORE_ADDR;
41 #define min(a, b) ((a) < (b) ? (a) : (b))
42 #define max(a, b) ((a) > (b) ? (a) : (b))
44 /* Gdb does *lots* of string compares. Use macros to speed them up by
45 avoiding function calls if the first characters are not the same. */
47 #define STRCMP(a,b) (*(a) == *(b) ? strcmp ((a), (b)) : (int)*(a) - (int)*(b))
48 #define STREQ(a,b) (*(a) == *(b) ? !strcmp ((a), (b)) : 0)
49 #define STREQN(a,b,c) (*(a) == *(b) ? !strncmp ((a), (b), (c)) : 0)
51 /* The character GNU C++ uses to build identifiers that must be unique from
52 the program's identifiers (such as $this and $$vptr). */
53 #define CPLUS_MARKER '$' /* May be overridden to '.' for SysV */
55 #include <errno.h> /* System call error return status */
58 extern int immediate_quit;
59 extern int sevenbit_strings;
64 #define QUIT { if (quit_flag) quit (); }
66 /* Command classes are top-level categories into which commands are broken
67 down for "help" purposes.
68 Notes on classes: class_alias is for alias commands which are not
69 abbreviations of the original command. class-pseudo is for commands
70 which are not really commands nor help topics ("stop"). */
74 /* Special args to help_list */
75 all_classes = -2, all_commands = -1,
76 /* Classes of commands */
77 no_class = -1, class_run = 0, class_vars, class_stack,
78 class_files, class_support, class_info, class_breakpoint,
79 class_alias, class_obscure, class_user, class_maintenance,
83 /* Languages represented in the symbol table and elsewhere.
84 This should probably be in language.h, but since enum's can't
85 be forward declared to satisfy opaque references before their
86 actual definition, needs to be here. */
90 language_unknown, /* Language not known */
91 language_auto, /* Placeholder for automatic setting */
93 language_cplus, /* C++ */
94 language_chill, /* Chill */
95 language_m2 /* Modula-2 */
98 /* the cleanup list records things that have to be undone
99 if an error happens (descriptors to be closed, memory to be freed, etc.)
100 Each link in the chain records a function to call and an
103 Use make_cleanup to add an element to the cleanup chain.
104 Use do_cleanups to do all cleanup actions back to a given
105 point in the chain. Use discard_cleanups to remove cleanups
106 from the chain back to a given point, not doing them. */
110 struct cleanup *next;
111 void (*function) PARAMS ((PTR));
115 /* From blockframe.c */
118 inside_entry_func PARAMS ((CORE_ADDR));
121 inside_entry_file PARAMS ((CORE_ADDR addr));
124 inside_main_func PARAMS ((CORE_ADDR pc));
126 /* From ch-lang.c, for the moment. (FIXME) */
129 chill_demangle PARAMS ((const char *));
131 /* From libiberty.a */
134 cplus_demangle PARAMS ((const char *, int));
137 cplus_mangle_opname PARAMS ((char *, int));
139 /* From libmmalloc.a (memory mapped malloc library) */
142 mmalloc_attach PARAMS ((int, PTR));
145 mmalloc_detach PARAMS ((PTR));
148 mmalloc PARAMS ((PTR, long));
151 mrealloc PARAMS ((PTR, PTR, long));
154 mfree PARAMS ((PTR, PTR));
157 mmalloc_setkey PARAMS ((PTR, int, PTR));
160 mmalloc_getkey PARAMS ((PTR, int));
165 strcmp_iw PARAMS ((const char *, const char *));
168 safe_strerror PARAMS ((int));
171 safe_strsignal PARAMS ((int));
174 init_malloc PARAMS ((void *));
177 request_quit PARAMS ((int));
180 do_cleanups PARAMS ((struct cleanup *));
183 discard_cleanups PARAMS ((struct cleanup *));
185 /* The bare make_cleanup function is one of those rare beasts that
186 takes almost any type of function as the first arg and anything that
187 will fit in a "void *" as the second arg.
189 Should be, once all calls and called-functions are cleaned up:
190 extern struct cleanup *
191 make_cleanup PARAMS ((void (*function) (void *), void *));
193 Until then, lint and/or various type-checking compiler options will
194 complain about make_cleanup calls. It'd be wrong to just cast things,
195 since the type actually passed when the function is called would be
198 extern struct cleanup *
201 extern struct cleanup *
202 save_cleanups PARAMS ((void));
205 restore_cleanups PARAMS ((struct cleanup *));
208 free_current_contents PARAMS ((char **));
211 null_cleanup PARAMS ((char **));
214 myread PARAMS ((int, char *, int));
219 /* Annotation stuff. */
221 extern int annotation_level; /* in stack.c */
224 begin_line PARAMS ((void));
227 wrap_here PARAMS ((char *));
230 reinitialize_more_filter PARAMS ((void));
232 typedef FILE GDB_FILE;
233 #define gdb_stdout stdout
234 #define gdb_stderr stderr
237 print_insn PARAMS ((CORE_ADDR, GDB_FILE *));
240 gdb_flush PARAMS ((GDB_FILE *));
243 gdb_fopen PARAMS ((char * name, char * mode));
246 fputs_filtered PARAMS ((const char *, GDB_FILE *));
249 fputs_unfiltered PARAMS ((const char *, GDB_FILE *));
252 fputc_unfiltered PARAMS ((int, GDB_FILE *));
255 putc_unfiltered PARAMS ((int));
257 #define putchar_unfiltered(C) putc_unfiltered(C)
260 puts_filtered PARAMS ((char *));
263 puts_unfiltered PARAMS ((char *));
269 vfprintf_filtered ();
275 fprintfi_filtered ();
284 vprintf_unfiltered ();
287 vfprintf_unfiltered ();
290 fprintf_unfiltered ();
293 printf_unfiltered ();
296 print_spaces PARAMS ((int, GDB_FILE *));
299 print_spaces_filtered PARAMS ((int, GDB_FILE *));
302 n_spaces PARAMS ((int));
305 gdb_printchar PARAMS ((int, GDB_FILE *, int));
307 /* Print a host address. */
308 extern void gdb_print_address PARAMS ((void *, GDB_FILE *));
311 fprintf_symbol_filtered PARAMS ((GDB_FILE *, char *, enum language, int));
314 perror_with_name PARAMS ((char *));
317 print_sys_errmsg PARAMS ((char *, int));
319 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
320 "const char *" in unistd.h, so we can't declare the argument
324 re_comp PARAMS ((const char *));
329 symbol_file_command PARAMS ((char *, int));
334 skip_quoted PARAMS ((char *));
337 gdb_readline PARAMS ((char *));
340 command_line_input PARAMS ((char *, int, char *));
343 print_prompt PARAMS ((void));
346 batch_mode PARAMS ((void));
349 input_from_terminal_p PARAMS ((void));
351 /* From printcmd.c */
354 set_next_address PARAMS ((CORE_ADDR));
357 print_address_symbolic PARAMS ((CORE_ADDR, GDB_FILE *, int, char *));
360 print_address_numeric PARAMS ((CORE_ADDR, GDB_FILE *));
363 print_address PARAMS ((CORE_ADDR, GDB_FILE *));
368 openp PARAMS ((char *, int, char *, int, int, char **));
371 mod_path PARAMS ((char *, char **));
374 directory_command PARAMS ((char *, int));
377 init_source_path PARAMS ((void));
382 read_relative_register_raw_bytes PARAMS ((int, char *));
384 /* From readline (but not in any readline .h files). */
387 tilde_expand PARAMS ((char *));
389 /* Structure for saved commands lines
390 (for breakpoints, defined commands, etc). */
394 struct command_line *next;
398 extern struct command_line *
399 read_command_lines PARAMS ((void));
402 free_command_lines PARAMS ((struct command_line **));
404 /* String containing the current directory (what getwd would return). */
406 extern char *current_directory;
408 /* Default radixes for input and output. Only some values supported. */
409 extern unsigned input_radix;
410 extern unsigned output_radix;
412 /* Possibilities for prettyprint parameters to routines which print
413 things. Like enum language, this should be in value.h, but needs
414 to be here for the same reason. FIXME: If we can eliminate this
415 as an arg to LA_VAL_PRINT, then we can probably move it back to
420 Val_no_prettyprint = 0,
422 /* Use the default setting which the user has specified. */
427 /* Host machine definition. This will be a symlink to one of the
428 xm-*.h files, built by the `configure' script. */
432 /* Native machine support. This will be a symlink to one of the
433 nm-*.h files, built by the `configure' script. */
437 /* If the xm.h file did not define the mode string used to open the
438 files, assume that binary files are opened the same way as text
441 #include "fopen-same.h"
445 * Allow things in gdb to be declared "const". If compiling ANSI, it
446 * just works. If compiling with gcc but non-ansi, redefine to __const__.
447 * If non-ansi, non-gcc, then eliminate "const" entirely, making those
448 * objects be read-write rather than read-only.
454 # define const __const__
456 # define const /*nothing*/
464 # define volatile __volatile__
466 # define volatile /*nothing*/
469 #endif /* volatile */
472 #define NORETURN /*nothing*/
474 /* FIXME: This is bogus. Having "volatile void" mean a function doesn't
475 return is a gcc extension and should be based on #ifdef __GNUC__.
476 Also, as of Sep 93 I'm told gcc is changing the syntax for ansi
477 reasons (so declaring exit here as "volatile void" and as "void" in
478 a system header loses). Using the new "__attributes__ ((noreturn));"
479 syntax would lose for old versions of gcc; using
480 typedef void exit_fn_type PARAMS ((int));
481 volatile exit_fn_type exit;
483 /* Some compilers (many AT&T SVR4 compilers for instance), do not accept
484 declarations of functions that never return (exit for instance) as
485 "volatile void". For such compilers "NORETURN" can be defined away
486 to keep them happy */
490 # define NORETURN /*nothing*/
492 # define NORETURN volatile
497 /* Defaults for system-wide constants (if not defined by xm.h, we fake it). */
499 #if !defined (UINT_MAX)
500 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
503 #if !defined (INT_MAX)
504 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
507 #if !defined (INT_MIN)
508 #define INT_MIN (-INT_MAX - 1) /* 0x80000000 for 32-bits */
511 #if !defined (ULONG_MAX)
512 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
515 #if !defined (LONG_MAX)
516 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
521 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
523 #define LONGEST BFD_HOST_64_BIT
527 /* If all compilers for this host support "long long" and we want to
528 use it for LONGEST (the performance hit is about 10% on a testsuite
529 run based on one DECstation test), then the xm.h file can define
532 Using GCC 1.39 on BSDI with long long causes about 700 new
533 testsuite failures. Using long long for LONGEST on the DECstation
534 causes 3 new FAILs in the testsuite and many heuristic fencepost
535 warnings. These are not investigated, but a first guess would be
536 that the BSDI problems are GCC bugs in long long support and the
537 latter are GDB bugs. */
539 #ifndef CC_HAS_LONG_LONG
540 # if defined (__GNUC__) && defined (FORCE_LONG_LONG)
541 # define CC_HAS_LONG_LONG 1
545 /* LONGEST should not be a typedef, because "unsigned LONGEST" needs to work.
546 CC_HAS_LONG_LONG is defined if the host compiler supports "long long"
547 variables and we wish to make use of that support. */
550 # ifdef CC_HAS_LONG_LONG
551 # define LONGEST long long
553 # define LONGEST long
557 #endif /* No BFD64 */
559 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
560 arguments to a function, number in a value history, register number, etc.)
561 where the value must not be larger than can fit in an int. */
563 extern int longest_to_int PARAMS ((LONGEST));
565 /* Assorted functions we can declare, now that const and volatile are
569 savestring PARAMS ((const char *, int));
572 msavestring PARAMS ((void *, const char *, int));
575 strsave PARAMS ((const char *));
578 mstrsave PARAMS ((void *, const char *));
581 concat PARAMS ((char *, ...));
584 xmalloc PARAMS ((long));
587 xrealloc PARAMS ((PTR, long));
590 xmmalloc PARAMS ((PTR, long));
593 xmrealloc PARAMS ((PTR, PTR, long));
596 mmalloc PARAMS ((PTR, long));
599 mrealloc PARAMS ((PTR, PTR, long));
602 mfree PARAMS ((PTR, PTR));
605 mmcheck PARAMS ((PTR, void (*) (void)));
608 mmtrace PARAMS ((void));
611 parse_escape PARAMS ((char **));
613 extern const char * const reg_names[];
615 /* Message to be printed before the error message, when an error occurs. */
617 extern char *error_pre_print;
619 /* Message to be printed before the warning message, when a warning occurs. */
621 extern char *warning_pre_print;
623 extern NORETURN void /* Does not return to the caller. */
626 extern void error_begin PARAMS ((void));
628 extern NORETURN void /* Does not return to the caller. */
631 extern NORETURN void /* Not specified as volatile in ... */
632 exit PARAMS ((int)); /* 4.10.4.3 */
634 extern NORETURN void /* Does not return to the caller. */
635 nomem PARAMS ((long));
637 /* Reasons for calling return_to_top_level. */
639 /* User interrupt. */
642 /* Any other error. */
646 #define RETURN_MASK_QUIT (1 << (int)RETURN_QUIT)
647 #define RETURN_MASK_ERROR (1 << (int)RETURN_ERROR)
648 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
649 typedef int return_mask;
651 extern NORETURN void /* Does not return to the caller. */
652 return_to_top_level PARAMS ((enum return_reason));
654 extern int catch_errors PARAMS ((int (*) (char *), void *, char *,
658 warning_setup PARAMS ((void));
663 /* Global functions from other, non-gdb GNU thingies (libiberty for
667 basename PARAMS ((char *));
670 getenv PARAMS ((const char *));
673 buildargv PARAMS ((char *));
676 freeargv PARAMS ((char **));
679 strerrno PARAMS ((int));
682 strsigno PARAMS ((int));
685 errno_max PARAMS ((void));
688 signo_max PARAMS ((void));
691 strtoerrno PARAMS ((char *));
694 strtosigno PARAMS ((char *));
697 strsignal PARAMS ((int));
699 /* From other system libraries */
701 #ifndef PSIGNAL_IN_SIGNAL_H
703 psignal PARAMS ((unsigned, const char *));
706 /* For now, we can't include <stdlib.h> because it conflicts with
707 "../include/getopt.h". (FIXME)
709 However, if a function is defined in the ANSI C standard and a prototype
710 for that function is defined and visible in any header file in an ANSI
711 conforming environment, then that prototype must match the definition in
712 the ANSI standard. So we can just duplicate them here without conflict,
713 since they must be the same in all conforming ANSI environments. If
714 these cause problems, then the environment is not ANSI conformant. */
721 fclose PARAMS ((GDB_FILE *stream)); /* 4.9.5.1 */
724 perror PARAMS ((const char *)); /* 4.9.10.4 */
727 atof PARAMS ((const char *nptr)); /* 4.10.1.1 */
730 atoi PARAMS ((const char *)); /* 4.10.1.2 */
732 #ifndef MALLOC_INCOMPATIBLE
735 malloc PARAMS ((size_t size)); /* 4.10.3.3 */
738 realloc PARAMS ((void *ptr, size_t size)); /* 4.10.3.4 */
741 free PARAMS ((void *)); /* 4.10.3.2 */
743 #endif /* MALLOC_INCOMPATIBLE */
746 qsort PARAMS ((void *base, size_t nmemb, /* 4.10.5.2 */
748 int (*compar)(const void *, const void *)));
750 #ifndef MEM_FNS_DECLARED /* Some non-ANSI use void *, not char *. */
752 memcpy PARAMS ((void *, const void *, size_t)); /* 4.11.2.1 */
755 memcmp PARAMS ((const void *, const void *, size_t)); /* 4.11.4.1 */
759 strchr PARAMS ((const char *, int)); /* 4.11.5.2 */
762 strrchr PARAMS ((const char *, int)); /* 4.11.5.5 */
765 strstr PARAMS ((const char *, const char *)); /* 4.11.5.7 */
768 strtok PARAMS ((char *, const char *)); /* 4.11.5.8 */
770 #ifndef MEM_FNS_DECLARED /* Some non-ANSI use void *, not char *. */
772 memset PARAMS ((void *, int, size_t)); /* 4.11.6.1 */
776 strerror PARAMS ((int)); /* 4.11.6.2 */
778 /* Various possibilities for alloca. */
781 # define alloca __builtin_alloca
782 # else /* Not GNU C */
784 # include <alloca.h> /* NOTE: Doesn't declare alloca() */
787 /* We need to be careful not to declare this in a way which conflicts with
788 bison. Bison never declares it as char *, but under various circumstances
789 (like __hpux) we need to use void *. */
790 # if defined (__STDC__) || defined (__hpux)
791 extern void *alloca ();
792 # else /* Don't use void *. */
793 extern char *alloca ();
794 # endif /* Don't use void *. */
795 # endif /* Not GNU C */
796 #endif /* alloca not defined */
798 /* TARGET_BYTE_ORDER and HOST_BYTE_ORDER must be defined to one of these. */
800 #if !defined (BIG_ENDIAN)
801 #define BIG_ENDIAN 4321
804 #if !defined (LITTLE_ENDIAN)
805 #define LITTLE_ENDIAN 1234
808 /* Target-system-dependent parameters for GDB. */
810 /* Target machine definition. This will be a symlink to one of the
811 tm-*.h files, built by the `configure' script. */
815 /* Number of bits in a char or unsigned char for the target machine.
816 Just like CHAR_BIT in <limits.h> but describes the target machine. */
817 #if !defined (TARGET_CHAR_BIT)
818 #define TARGET_CHAR_BIT 8
821 /* Number of bits in a short or unsigned short for the target machine. */
822 #if !defined (TARGET_SHORT_BIT)
823 #define TARGET_SHORT_BIT (2 * TARGET_CHAR_BIT)
826 /* Number of bits in an int or unsigned int for the target machine. */
827 #if !defined (TARGET_INT_BIT)
828 #define TARGET_INT_BIT (4 * TARGET_CHAR_BIT)
831 /* Number of bits in a long or unsigned long for the target machine. */
832 #if !defined (TARGET_LONG_BIT)
833 #define TARGET_LONG_BIT (4 * TARGET_CHAR_BIT)
836 /* Number of bits in a long long or unsigned long long for the target machine. */
837 #if !defined (TARGET_LONG_LONG_BIT)
838 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
841 /* Number of bits in a float for the target machine. */
842 #if !defined (TARGET_FLOAT_BIT)
843 #define TARGET_FLOAT_BIT (4 * TARGET_CHAR_BIT)
846 /* Number of bits in a double for the target machine. */
847 #if !defined (TARGET_DOUBLE_BIT)
848 #define TARGET_DOUBLE_BIT (8 * TARGET_CHAR_BIT)
851 /* Number of bits in a long double for the target machine. */
852 #if !defined (TARGET_LONG_DOUBLE_BIT)
853 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
856 /* Number of bits in a "complex" for the target machine. */
857 #if !defined (TARGET_COMPLEX_BIT)
858 #define TARGET_COMPLEX_BIT (2 * TARGET_FLOAT_BIT)
861 /* Number of bits in a "double complex" for the target machine. */
862 #if !defined (TARGET_DOUBLE_COMPLEX_BIT)
863 #define TARGET_DOUBLE_COMPLEX_BIT (2 * TARGET_DOUBLE_BIT)
866 /* Number of bits in a pointer for the target machine */
867 #if !defined (TARGET_PTR_BIT)
868 #define TARGET_PTR_BIT TARGET_INT_BIT
871 /* If we picked up a copy of CHAR_BIT from a configuration file
872 (which may get it by including <limits.h>) then use it to set
873 the number of bits in a host char. If not, use the same size
876 #if defined (CHAR_BIT)
877 #define HOST_CHAR_BIT CHAR_BIT
879 #define HOST_CHAR_BIT TARGET_CHAR_BIT
882 /* The bit byte-order has to do just with numbering of bits in
883 debugging symbols and such. Conceptually, it's quite separate
884 from byte/word byte order. */
886 #if !defined (BITS_BIG_ENDIAN)
887 #if TARGET_BYTE_ORDER == BIG_ENDIAN
888 #define BITS_BIG_ENDIAN 1
889 #endif /* Big endian. */
891 #if TARGET_BYTE_ORDER == LITTLE_ENDIAN
892 #define BITS_BIG_ENDIAN 0
893 #endif /* Little endian. */
894 #endif /* BITS_BIG_ENDIAN not defined. */
897 LONGEST extract_signed_integer PARAMS ((void *, int));
898 unsigned LONGEST extract_unsigned_integer PARAMS ((void *, int));
899 CORE_ADDR extract_address PARAMS ((void *, int));
901 void store_signed_integer PARAMS ((void *, int, LONGEST));
902 void store_unsigned_integer PARAMS ((void *, int, unsigned LONGEST));
903 void store_address PARAMS ((void *, int, CORE_ADDR));
905 double extract_floating PARAMS ((void *, int));
906 void store_floating PARAMS ((void *, int, double));
908 /* On some machines there are bits in addresses which are not really
909 part of the address, but are used by the kernel, the hardware, etc.
910 for special purposes. ADDR_BITS_REMOVE takes out any such bits
911 so we get a "real" address such as one would find in a symbol
912 table. This is used only for addresses of instructions, and even then
913 I'm not sure it's used in all contexts. It exists to deal with there
914 being a few stray bits in the PC which would mislead us, not as some sort
915 of generic thing to handle alignment or segmentation (it's possible it
916 should be in TARGET_READ_PC instead). */
917 #if !defined (ADDR_BITS_REMOVE)
918 #define ADDR_BITS_REMOVE(addr) (addr)
919 #endif /* No ADDR_BITS_REMOVE. */
924 push_bytes PARAMS ((CORE_ADDR, char *, int));
927 push_word PARAMS ((CORE_ADDR, unsigned LONGEST));
929 /* Some parts of gdb might be considered optional, in the sense that they
930 are not essential for being able to build a working, usable debugger
931 for a specific environment. For example, the maintenance commands
932 are there for the benefit of gdb maintainers. As another example,
933 some environments really don't need gdb's that are able to read N
934 different object file formats. In order to make it possible (but
935 not necessarily recommended) to build "stripped down" versions of
936 gdb, the following defines control selective compilation of those
937 parts of gdb which can be safely left out when necessary. Note that
938 the default is to include everything. */
940 #ifndef MAINTENANCE_CMDS
941 #define MAINTENANCE_CMDS 1
944 #endif /* !defined (DEFS_H) */