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));
220 begin_line PARAMS ((void));
223 wrap_here PARAMS ((char *));
226 reinitialize_more_filter PARAMS ((void));
228 typedef FILE GDB_FILE;
229 #define gdb_stdout stdout
230 #define gdb_stderr stderr
233 print_insn PARAMS ((CORE_ADDR, GDB_FILE *));
236 gdb_flush PARAMS ((GDB_FILE *));
239 gdb_fopen PARAMS ((char * name, char * mode));
242 fputs_filtered PARAMS ((const char *, GDB_FILE *));
245 fputs_unfiltered PARAMS ((const char *, GDB_FILE *));
248 fputc_unfiltered PARAMS ((int, GDB_FILE *));
251 putc_unfiltered PARAMS ((int));
253 #define putchar_unfiltered(C) putc_unfiltered(C)
256 puts_filtered PARAMS ((char *));
259 puts_unfiltered PARAMS ((char *));
265 vfprintf_filtered ();
271 fprintfi_filtered ();
280 vprintf_unfiltered ();
283 vfprintf_unfiltered ();
286 fprintf_unfiltered ();
289 printf_unfiltered ();
292 print_spaces PARAMS ((int, GDB_FILE *));
295 print_spaces_filtered PARAMS ((int, GDB_FILE *));
298 n_spaces PARAMS ((int));
301 gdb_printchar PARAMS ((int, GDB_FILE *, int));
303 /* Print a host address. */
304 extern void gdb_print_address PARAMS ((void *, GDB_FILE *));
307 fprintf_symbol_filtered PARAMS ((GDB_FILE *, char *, enum language, int));
310 perror_with_name PARAMS ((char *));
313 print_sys_errmsg PARAMS ((char *, int));
315 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
316 "const char *" in unistd.h, so we can't declare the argument
320 re_comp PARAMS ((const char *));
325 symbol_file_command PARAMS ((char *, int));
330 skip_quoted PARAMS ((char *));
333 gdb_readline PARAMS ((char *));
336 command_line_input PARAMS ((char *, int));
339 print_prompt PARAMS ((void));
342 batch_mode PARAMS ((void));
345 input_from_terminal_p PARAMS ((void));
347 /* From printcmd.c */
350 set_next_address PARAMS ((CORE_ADDR));
353 print_address_symbolic PARAMS ((CORE_ADDR, GDB_FILE *, int, char *));
356 print_address_numeric PARAMS ((CORE_ADDR, GDB_FILE *));
359 print_address PARAMS ((CORE_ADDR, GDB_FILE *));
364 openp PARAMS ((char *, int, char *, int, int, char **));
367 mod_path PARAMS ((char *, char **));
370 directory_command PARAMS ((char *, int));
373 init_source_path PARAMS ((void));
378 read_relative_register_raw_bytes PARAMS ((int, char *));
380 /* From readline (but not in any readline .h files). */
383 tilde_expand PARAMS ((char *));
385 /* Structure for saved commands lines
386 (for breakpoints, defined commands, etc). */
390 struct command_line *next;
394 extern struct command_line *
395 read_command_lines PARAMS ((void));
398 free_command_lines PARAMS ((struct command_line **));
400 /* String containing the current directory (what getwd would return). */
402 extern char *current_directory;
404 /* Default radixes for input and output. Only some values supported. */
405 extern unsigned input_radix;
406 extern unsigned output_radix;
408 /* Possibilities for prettyprint parameters to routines which print
409 things. Like enum language, this should be in value.h, but needs
410 to be here for the same reason. FIXME: If we can eliminate this
411 as an arg to LA_VAL_PRINT, then we can probably move it back to
416 Val_no_prettyprint = 0,
418 /* Use the default setting which the user has specified. */
423 /* Host machine definition. This will be a symlink to one of the
424 xm-*.h files, built by the `configure' script. */
428 /* Native machine support. This will be a symlink to one of the
429 nm-*.h files, built by the `configure' script. */
433 /* If the xm.h file did not define the mode string used to open the
434 files, assume that binary files are opened the same way as text
437 #include "fopen-same.h"
441 * Allow things in gdb to be declared "const". If compiling ANSI, it
442 * just works. If compiling with gcc but non-ansi, redefine to __const__.
443 * If non-ansi, non-gcc, then eliminate "const" entirely, making those
444 * objects be read-write rather than read-only.
450 # define const __const__
452 # define const /*nothing*/
460 # define volatile __volatile__
462 # define volatile /*nothing*/
465 #endif /* volatile */
468 #define NORETURN /*nothing*/
470 /* FIXME: This is bogus. Having "volatile void" mean a function doesn't
471 return is a gcc extension and should be based on #ifdef __GNUC__.
472 Also, as of Sep 93 I'm told gcc is changing the syntax for ansi
473 reasons (so declaring exit here as "volatile void" and as "void" in
474 a system header loses). Using the new "__attributes__ ((noreturn));"
475 syntax would lose for old versions of gcc; using
476 typedef void exit_fn_type PARAMS ((int));
477 volatile exit_fn_type exit;
479 /* Some compilers (many AT&T SVR4 compilers for instance), do not accept
480 declarations of functions that never return (exit for instance) as
481 "volatile void". For such compilers "NORETURN" can be defined away
482 to keep them happy */
486 # define NORETURN /*nothing*/
488 # define NORETURN volatile
493 /* Defaults for system-wide constants (if not defined by xm.h, we fake it). */
495 #if !defined (UINT_MAX)
496 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
499 #if !defined (INT_MAX)
500 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
503 #if !defined (INT_MIN)
504 #define INT_MIN (-INT_MAX - 1) /* 0x80000000 for 32-bits */
507 #if !defined (ULONG_MAX)
508 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
511 #if !defined (LONG_MAX)
512 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
517 /* This is to make sure that LONGEST is at least as big as CORE_ADDR. */
519 #define LONGEST BFD_HOST_64_BIT
523 /* Default to support for "long long" if the host compiler being used is gcc.
524 Config files must define CC_HAS_LONG_LONG to use other host compilers
525 that are capable of supporting "long long", and to cause gdb to use that
526 support. Not defining CC_HAS_LONG_LONG will suppress use of "long long"
527 regardless of what compiler is used.
529 FIXME: For now, automatic selection of "long long" as the default when
530 gcc is used is disabled, pending further testing. Concerns include the
531 impact on gdb performance and the universality of bugfree long long
532 support on platforms that do have gcc. Compiling with FORCE_LONG_LONG
533 will select "long long" use for testing purposes. -fnf */
535 #ifndef CC_HAS_LONG_LONG
536 # if defined (__GNUC__) /*&& defined (FORCE_LONG_LONG)*/ /* See FIXME above */
537 # define CC_HAS_LONG_LONG 1
541 /* LONGEST should not be a typedef, because "unsigned LONGEST" needs to work.
542 CC_HAS_LONG_LONG is defined if the host compiler supports "long long"
543 variables and we wish to make use of that support. */
546 # ifdef CC_HAS_LONG_LONG
547 # define LONGEST long long
549 # define LONGEST long
553 #endif /* No BFD64 */
555 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
556 arguments to a function, number in a value history, register number, etc.)
557 where the value must not be larger than can fit in an int. */
559 extern int longest_to_int PARAMS ((LONGEST));
561 /* Assorted functions we can declare, now that const and volatile are
565 savestring PARAMS ((const char *, int));
568 msavestring PARAMS ((void *, const char *, int));
571 strsave PARAMS ((const char *));
574 mstrsave PARAMS ((void *, const char *));
577 concat PARAMS ((char *, ...));
580 xmalloc PARAMS ((long));
583 xrealloc PARAMS ((PTR, long));
586 xmmalloc PARAMS ((PTR, long));
589 xmrealloc PARAMS ((PTR, PTR, long));
592 mmalloc PARAMS ((PTR, long));
595 mrealloc PARAMS ((PTR, PTR, long));
598 mfree PARAMS ((PTR, PTR));
601 mmcheck PARAMS ((PTR, void (*) (void)));
604 mmtrace PARAMS ((void));
607 parse_escape PARAMS ((char **));
609 extern const char * const reg_names[];
611 /* Message to be printed before the error message, when an error occurs. */
613 extern char *error_pre_print;
615 /* Message to be printed before the warning message, when a warning occurs. */
617 extern char *warning_pre_print;
619 extern NORETURN void /* Does not return to the caller. */
622 extern NORETURN void /* Does not return to the caller. */
625 extern NORETURN void /* Not specified as volatile in ... */
626 exit PARAMS ((int)); /* 4.10.4.3 */
628 extern NORETURN void /* Does not return to the caller. */
629 nomem PARAMS ((long));
631 /* Reasons for calling return_to_top_level. */
633 /* User interrupt. */
636 /* Any other error. */
640 #define RETURN_MASK_QUIT (1 << (int)RETURN_QUIT)
641 #define RETURN_MASK_ERROR (1 << (int)RETURN_ERROR)
642 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
643 typedef int return_mask;
645 extern NORETURN void /* Does not return to the caller. */
646 return_to_top_level PARAMS ((enum return_reason));
648 extern int catch_errors PARAMS ((int (*) (char *), void *, char *,
652 warning_setup PARAMS ((void));
657 /* Global functions from other, non-gdb GNU thingies (libiberty for
661 basename PARAMS ((char *));
664 getenv PARAMS ((const char *));
667 buildargv PARAMS ((char *));
670 freeargv PARAMS ((char **));
673 strerrno PARAMS ((int));
676 strsigno PARAMS ((int));
679 errno_max PARAMS ((void));
682 signo_max PARAMS ((void));
685 strtoerrno PARAMS ((char *));
688 strtosigno PARAMS ((char *));
691 strsignal PARAMS ((int));
693 /* From other system libraries */
695 #ifndef PSIGNAL_IN_SIGNAL_H
697 psignal PARAMS ((unsigned, const char *));
700 /* For now, we can't include <stdlib.h> because it conflicts with
701 "../include/getopt.h". (FIXME)
703 However, if a function is defined in the ANSI C standard and a prototype
704 for that function is defined and visible in any header file in an ANSI
705 conforming environment, then that prototype must match the definition in
706 the ANSI standard. So we can just duplicate them here without conflict,
707 since they must be the same in all conforming ANSI environments. If
708 these cause problems, then the environment is not ANSI conformant. */
715 fclose PARAMS ((GDB_FILE *stream)); /* 4.9.5.1 */
718 perror PARAMS ((const char *)); /* 4.9.10.4 */
721 atof PARAMS ((const char *nptr)); /* 4.10.1.1 */
724 atoi PARAMS ((const char *)); /* 4.10.1.2 */
726 #ifndef MALLOC_INCOMPATIBLE
729 malloc PARAMS ((size_t size)); /* 4.10.3.3 */
732 realloc PARAMS ((void *ptr, size_t size)); /* 4.10.3.4 */
735 free PARAMS ((void *)); /* 4.10.3.2 */
737 #endif /* MALLOC_INCOMPATIBLE */
740 qsort PARAMS ((void *base, size_t nmemb, /* 4.10.5.2 */
742 int (*comp)(const void *, const void *)));
744 #ifndef MEM_FNS_DECLARED /* Some non-ANSI use void *, not char *. */
746 memcpy PARAMS ((void *, const void *, size_t)); /* 4.11.2.1 */
749 memcmp PARAMS ((const void *, const void *, size_t)); /* 4.11.4.1 */
753 strchr PARAMS ((const char *, int)); /* 4.11.5.2 */
756 strrchr PARAMS ((const char *, int)); /* 4.11.5.5 */
759 strstr PARAMS ((const char *, const char *)); /* 4.11.5.7 */
762 strtok PARAMS ((char *, const char *)); /* 4.11.5.8 */
764 #ifndef MEM_FNS_DECLARED /* Some non-ANSI use void *, not char *. */
766 memset PARAMS ((void *, int, size_t)); /* 4.11.6.1 */
770 strerror PARAMS ((int)); /* 4.11.6.2 */
772 /* Various possibilities for alloca. */
775 # define alloca __builtin_alloca
776 # else /* Not GNU C */
778 # include <alloca.h> /* NOTE: Doesn't declare alloca() */
781 /* We need to be careful not to declare this in a way which conflicts with
782 bison. Bison never declares it as char *, but under various circumstances
783 (like __hpux) we need to use void *. */
784 # if defined (__STDC__) || defined (__hpux)
785 extern void *alloca ();
786 # else /* Don't use void *. */
787 extern char *alloca ();
788 # endif /* Don't use void *. */
789 # endif /* Not GNU C */
790 #endif /* alloca not defined */
792 /* TARGET_BYTE_ORDER and HOST_BYTE_ORDER must be defined to one of these. */
794 #if !defined (BIG_ENDIAN)
795 #define BIG_ENDIAN 4321
798 #if !defined (LITTLE_ENDIAN)
799 #define LITTLE_ENDIAN 1234
802 /* Target-system-dependent parameters for GDB. */
804 /* Target machine definition. This will be a symlink to one of the
805 tm-*.h files, built by the `configure' script. */
809 /* Number of bits in a char or unsigned char for the target machine.
810 Just like CHAR_BIT in <limits.h> but describes the target machine. */
811 #if !defined (TARGET_CHAR_BIT)
812 #define TARGET_CHAR_BIT 8
815 /* Number of bits in a short or unsigned short for the target machine. */
816 #if !defined (TARGET_SHORT_BIT)
817 #define TARGET_SHORT_BIT (2 * TARGET_CHAR_BIT)
820 /* Number of bits in an int or unsigned int for the target machine. */
821 #if !defined (TARGET_INT_BIT)
822 #define TARGET_INT_BIT (4 * TARGET_CHAR_BIT)
825 /* Number of bits in a long or unsigned long for the target machine. */
826 #if !defined (TARGET_LONG_BIT)
827 #define TARGET_LONG_BIT (4 * TARGET_CHAR_BIT)
830 /* Number of bits in a long long or unsigned long long for the target machine. */
831 #if !defined (TARGET_LONG_LONG_BIT)
832 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
835 /* Number of bits in a float for the target machine. */
836 #if !defined (TARGET_FLOAT_BIT)
837 #define TARGET_FLOAT_BIT (4 * TARGET_CHAR_BIT)
840 /* Number of bits in a double for the target machine. */
841 #if !defined (TARGET_DOUBLE_BIT)
842 #define TARGET_DOUBLE_BIT (8 * TARGET_CHAR_BIT)
845 /* Number of bits in a long double for the target machine. */
846 #if !defined (TARGET_LONG_DOUBLE_BIT)
847 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
850 /* Number of bits in a "complex" for the target machine. */
851 #if !defined (TARGET_COMPLEX_BIT)
852 #define TARGET_COMPLEX_BIT (2 * TARGET_FLOAT_BIT)
855 /* Number of bits in a "double complex" for the target machine. */
856 #if !defined (TARGET_DOUBLE_COMPLEX_BIT)
857 #define TARGET_DOUBLE_COMPLEX_BIT (2 * TARGET_DOUBLE_BIT)
860 /* Number of bits in a pointer for the target machine */
861 #if !defined (TARGET_PTR_BIT)
862 #define TARGET_PTR_BIT TARGET_INT_BIT
865 /* If we picked up a copy of CHAR_BIT from a configuration file
866 (which may get it by including <limits.h>) then use it to set
867 the number of bits in a host char. If not, use the same size
870 #if defined (CHAR_BIT)
871 #define HOST_CHAR_BIT CHAR_BIT
873 #define HOST_CHAR_BIT TARGET_CHAR_BIT
876 /* The bit byte-order has to do just with numbering of bits in
877 debugging symbols and such. Conceptually, it's quite separate
878 from byte/word byte order. */
880 #if !defined (BITS_BIG_ENDIAN)
881 #if TARGET_BYTE_ORDER == BIG_ENDIAN
882 #define BITS_BIG_ENDIAN 1
883 #endif /* Big endian. */
885 #if TARGET_BYTE_ORDER == LITTLE_ENDIAN
886 #define BITS_BIG_ENDIAN 0
887 #endif /* Little endian. */
888 #endif /* BITS_BIG_ENDIAN not defined. */
891 LONGEST extract_signed_integer PARAMS ((void *, int));
892 unsigned LONGEST extract_unsigned_integer PARAMS ((void *, int));
893 CORE_ADDR extract_address PARAMS ((void *, int));
895 void store_signed_integer PARAMS ((void *, int, LONGEST));
896 void store_unsigned_integer PARAMS ((void *, int, unsigned LONGEST));
897 void store_address PARAMS ((void *, int, CORE_ADDR));
899 double extract_floating PARAMS ((void *, int));
900 void store_floating PARAMS ((void *, int, double));
902 /* On some machines there are bits in addresses which are not really
903 part of the address, but are used by the kernel, the hardware, etc.
904 for special purposes. ADDR_BITS_REMOVE takes out any such bits
905 so we get a "real" address such as one would find in a symbol
906 table. This is used only for addresses of instructions, and even then
907 I'm not sure it's used in all contexts. It exists to deal with there
908 being a few stray bits in the PC which would mislead us, not as some sort
909 of generic thing to handle alignment or segmentation (it's possible it
910 should be in TARGET_READ_PC instead). */
911 #if !defined (ADDR_BITS_REMOVE)
912 #define ADDR_BITS_REMOVE(addr) (addr)
913 #endif /* No ADDR_BITS_REMOVE. */
918 push_bytes PARAMS ((CORE_ADDR, char *, int));
921 push_word PARAMS ((CORE_ADDR, unsigned LONGEST));
923 /* Some parts of gdb might be considered optional, in the sense that they
924 are not essential for being able to build a working, usable debugger
925 for a specific environment. For example, the maintenance commands
926 are there for the benefit of gdb maintainers. As another example,
927 some environments really don't need gdb's that are able to read N
928 different object file formats. In order to make it possible (but
929 not necessarily recommended) to build "stripped down" versions of
930 gdb, the following defines control selective compilation of those
931 parts of gdb which can be safely left out when necessary. Note that
932 the default is to include everything. */
934 #ifndef MAINTENANCE_CMDS
935 #define MAINTENANCE_CMDS 1
938 #endif /* !defined (DEFS_H) */