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 /* An address in the program being debugged. Host byte order. */
31 #ifndef CORE_ADDR_TYPE
32 typedef unsigned int CORE_ADDR
;
34 typedef CORE_ADDR_TYPE CORE_ADDR
;
37 #define min(a, b) ((a) < (b) ? (a) : (b))
38 #define max(a, b) ((a) > (b) ? (a) : (b))
40 /* Gdb does *lots* of string compares. Use macros to speed them up by
41 avoiding function calls if the first characters are not the same. */
43 #define STRCMP(a,b) (*(a) == *(b) ? strcmp ((a), (b)) : (int)*(a) - (int)*(b))
44 #define STREQ(a,b) (*(a) == *(b) ? !strcmp ((a), (b)) : 0)
45 #define STREQN(a,b,c) (*(a) == *(b) ? !strncmp ((a), (b), (c)) : 0)
47 /* The character GNU C++ uses to build identifiers that must be unique from
48 the program's identifiers (such as $this and $$vptr). */
49 #define CPLUS_MARKER '$' /* May be overridden to '.' for SysV */
51 #include <errno.h> /* System call error return status */
54 extern int immediate_quit
;
55 extern int sevenbit_strings
;
60 #define QUIT { if (quit_flag) quit (); }
62 /* Command classes are top-level categories into which commands are broken
63 down for "help" purposes.
64 Notes on classes: class_alias is for alias commands which are not
65 abbreviations of the original command. class-pseudo is for commands
66 which are not really commands nor help topics ("stop"). */
70 /* Special args to help_list */
71 all_classes
= -2, all_commands
= -1,
72 /* Classes of commands */
73 no_class
= -1, class_run
= 0, class_vars
, class_stack
,
74 class_files
, class_support
, class_info
, class_breakpoint
,
75 class_alias
, class_obscure
, class_user
, class_maintenance
,
79 /* Languages represented in the symbol table and elsewhere.
80 This should probably be in language.h, but since enum's can't
81 be forward declared to satisfy opaque references before their
82 actual definition, needs to be here. */
86 language_unknown
, /* Language not known */
87 language_auto
, /* Placeholder for automatic setting */
89 language_cplus
, /* C++ */
90 language_chill
, /* Chill */
91 language_m2
/* Modula-2 */
94 /* the cleanup list records things that have to be undone
95 if an error happens (descriptors to be closed, memory to be freed, etc.)
96 Each link in the chain records a function to call and an
99 Use make_cleanup to add an element to the cleanup chain.
100 Use do_cleanups to do all cleanup actions back to a given
101 point in the chain. Use discard_cleanups to remove cleanups
102 from the chain back to a given point, not doing them. */
106 struct cleanup
*next
;
107 void (*function
) PARAMS ((PTR
));
111 /* From blockframe.c */
114 inside_entry_func
PARAMS ((CORE_ADDR
));
117 inside_entry_file
PARAMS ((CORE_ADDR addr
));
120 inside_main_func
PARAMS ((CORE_ADDR pc
));
122 /* From ch-lang.c, for the moment. (FIXME) */
125 chill_demangle
PARAMS ((const char *));
127 /* From libiberty.a */
130 cplus_demangle
PARAMS ((const char *, int));
133 cplus_mangle_opname
PARAMS ((char *, int));
135 /* From libmmalloc.a (memory mapped malloc library) */
138 mmalloc_attach
PARAMS ((int, PTR
));
141 mmalloc_detach
PARAMS ((PTR
));
144 mmalloc
PARAMS ((PTR
, long));
147 mrealloc
PARAMS ((PTR
, PTR
, long));
150 mfree
PARAMS ((PTR
, PTR
));
153 mmalloc_setkey
PARAMS ((PTR
, int, PTR
));
156 mmalloc_getkey
PARAMS ((PTR
, int));
161 strcmp_iw
PARAMS ((const char *, const char *));
164 safe_strerror
PARAMS ((int));
167 safe_strsignal
PARAMS ((int));
170 init_malloc
PARAMS ((void *));
173 request_quit
PARAMS ((int));
176 do_cleanups
PARAMS ((struct cleanup
*));
179 discard_cleanups
PARAMS ((struct cleanup
*));
181 /* The bare make_cleanup function is one of those rare beasts that
182 takes almost any type of function as the first arg and anything that
183 will fit in a "void *" as the second arg.
185 Should be, once all calls and called-functions are cleaned up:
186 extern struct cleanup *
187 make_cleanup PARAMS ((void (*function) (void *), void *));
189 Until then, lint and/or various type-checking compiler options will
190 complain about make_cleanup calls. It'd be wrong to just cast things,
191 since the type actually passed when the function is called would be
194 extern struct cleanup
*
197 extern struct cleanup
*
198 save_cleanups
PARAMS ((void));
201 restore_cleanups
PARAMS ((struct cleanup
*));
204 free_current_contents
PARAMS ((char **));
207 null_cleanup
PARAMS ((char **));
210 myread
PARAMS ((int, char *, int));
216 begin_line
PARAMS ((void));
219 wrap_here
PARAMS ((char *));
222 reinitialize_more_filter
PARAMS ((void));
224 typedef FILE GDB_FILE
;
225 #define gdb_stdout stdout
226 #define gdb_stderr stderr
229 print_insn
PARAMS ((CORE_ADDR
, GDB_FILE
*));
232 gdb_flush
PARAMS ((GDB_FILE
*));
235 gdb_fopen
PARAMS ((char * name
, char * mode
));
238 fputs_filtered
PARAMS ((const char *, GDB_FILE
*));
241 fputs_unfiltered
PARAMS ((const char *, GDB_FILE
*));
244 fputc_unfiltered
PARAMS ((int, GDB_FILE
*));
247 putc_unfiltered
PARAMS ((int));
249 #define putchar_unfiltered(C) putc_unfiltered(C)
252 puts_filtered
PARAMS ((char *));
255 puts_unfiltered
PARAMS ((char *));
261 vfprintf_filtered ();
267 fprintfi_filtered ();
276 vprintf_unfiltered ();
279 vfprintf_unfiltered ();
282 fprintf_unfiltered ();
285 printf_unfiltered ();
288 print_spaces
PARAMS ((int, GDB_FILE
*));
291 print_spaces_filtered
PARAMS ((int, GDB_FILE
*));
294 n_spaces
PARAMS ((int));
297 gdb_printchar
PARAMS ((int, GDB_FILE
*, int));
299 /* Print a host address. */
300 extern void gdb_print_address
PARAMS ((void *, GDB_FILE
*));
303 fprintf_symbol_filtered
PARAMS ((GDB_FILE
*, char *, enum language
, int));
306 perror_with_name
PARAMS ((char *));
309 print_sys_errmsg
PARAMS ((char *, int));
311 /* From regex.c or libc. BSD 4.4 declares this with the argument type as
312 "const char *" in unistd.h, so we can't declare the argument
316 re_comp
PARAMS ((const char *));
321 symbol_file_command
PARAMS ((char *, int));
326 skip_quoted
PARAMS ((char *));
329 gdb_readline
PARAMS ((char *));
332 command_line_input
PARAMS ((char *, int));
335 print_prompt
PARAMS ((void));
338 batch_mode
PARAMS ((void));
341 input_from_terminal_p
PARAMS ((void));
343 /* From printcmd.c */
346 set_next_address
PARAMS ((CORE_ADDR
));
349 print_address_symbolic
PARAMS ((CORE_ADDR
, GDB_FILE
*, int, char *));
352 print_address_numeric
PARAMS ((CORE_ADDR
, GDB_FILE
*));
355 print_address
PARAMS ((CORE_ADDR
, GDB_FILE
*));
360 openp
PARAMS ((char *, int, char *, int, int, char **));
363 mod_path
PARAMS ((char *, char **));
366 directory_command
PARAMS ((char *, int));
369 init_source_path
PARAMS ((void));
374 read_relative_register_raw_bytes
PARAMS ((int, char *));
376 /* From readline (but not in any readline .h files). */
379 tilde_expand
PARAMS ((char *));
381 /* Structure for saved commands lines
382 (for breakpoints, defined commands, etc). */
386 struct command_line
*next
;
390 extern struct command_line
*
391 read_command_lines
PARAMS ((void));
394 free_command_lines
PARAMS ((struct command_line
**));
396 /* String containing the current directory (what getwd would return). */
398 extern char *current_directory
;
400 /* Default radixes for input and output. Only some values supported. */
401 extern unsigned input_radix
;
402 extern unsigned output_radix
;
404 /* Possibilities for prettyprint parameters to routines which print
405 things. Like enum language, this should be in value.h, but needs
406 to be here for the same reason. FIXME: If we can eliminate this
407 as an arg to LA_VAL_PRINT, then we can probably move it back to
412 Val_no_prettyprint
= 0,
414 /* Use the default setting which the user has specified. */
419 /* Host machine definition. This will be a symlink to one of the
420 xm-*.h files, built by the `configure' script. */
424 /* Native machine support. This will be a symlink to one of the
425 nm-*.h files, built by the `configure' script. */
429 /* If the xm.h file did not define the mode string used to open the
430 files, assume that binary files are opened the same way as text
433 #include "fopen-same.h"
437 * Allow things in gdb to be declared "const". If compiling ANSI, it
438 * just works. If compiling with gcc but non-ansi, redefine to __const__.
439 * If non-ansi, non-gcc, then eliminate "const" entirely, making those
440 * objects be read-write rather than read-only.
446 # define const __const__
448 # define const /*nothing*/
456 # define volatile __volatile__
458 # define volatile /*nothing*/
461 #endif /* volatile */
464 #define NORETURN /*nothing*/
466 /* FIXME: This is bogus. Having "volatile void" mean a function doesn't
467 return is a gcc extension and should be based on #ifdef __GNUC__.
468 Also, as of Sep 93 I'm told gcc is changing the syntax for ansi
469 reasons (so declaring exit here as "volatile void" and as "void" in
470 a system header loses). Using the new "__attributes__ ((noreturn));"
471 syntax would lose for old versions of gcc; using
472 typedef void exit_fn_type PARAMS ((int));
473 volatile exit_fn_type exit;
475 /* Some compilers (many AT&T SVR4 compilers for instance), do not accept
476 declarations of functions that never return (exit for instance) as
477 "volatile void". For such compilers "NORETURN" can be defined away
478 to keep them happy */
482 # define NORETURN /*nothing*/
484 # define NORETURN volatile
489 /* Defaults for system-wide constants (if not defined by xm.h, we fake it). */
491 #if !defined (UINT_MAX)
492 #define UINT_MAX ((unsigned int)(~0)) /* 0xFFFFFFFF for 32-bits */
495 #if !defined (INT_MAX)
496 #define INT_MAX ((int)(UINT_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
499 #if !defined (INT_MIN)
500 #define INT_MIN (-INT_MAX - 1) /* 0x80000000 for 32-bits */
503 #if !defined (ULONG_MAX)
504 #define ULONG_MAX ((unsigned long)(~0L)) /* 0xFFFFFFFF for 32-bits */
507 #if !defined (LONG_MAX)
508 #define LONG_MAX ((long)(ULONG_MAX >> 1)) /* 0x7FFFFFFF for 32-bits */
511 /* Default to support for "long long" if the host compiler being used is gcc.
512 Config files must define CC_HAS_LONG_LONG to use other host compilers
513 that are capable of supporting "long long", and to cause gdb to use that
514 support. Not defining CC_HAS_LONG_LONG will suppress use of "long long"
515 regardless of what compiler is used.
517 FIXME: For now, automatic selection of "long long" as the default when
518 gcc is used is disabled, pending further testing. Concerns include the
519 impact on gdb performance and the universality of bugfree long long
520 support on platforms that do have gcc. Compiling with FORCE_LONG_LONG
521 will select "long long" use for testing purposes. -fnf */
523 #ifndef CC_HAS_LONG_LONG
524 # if defined (__GNUC__) && defined (FORCE_LONG_LONG) /* See FIXME above */
525 # define CC_HAS_LONG_LONG 1
529 /* LONGEST should not be a typedef, because "unsigned LONGEST" needs to work.
530 CC_HAS_LONG_LONG is defined if the host compiler supports "long long"
531 variables and we wish to make use of that support. */
534 # ifdef CC_HAS_LONG_LONG
535 # define LONGEST long long
537 # define LONGEST long
541 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
542 arguments to a function, number in a value history, register number, etc.)
543 where the value must not be larger than can fit in an int. */
545 #ifndef longest_to_int
546 # ifdef CC_HAS_LONG_LONG
547 # define longest_to_int(x) (((x) > INT_MAX || (x) < INT_MIN) \
548 ? (error ("Value out of range."),0) : (int) (x))
550 /* Assume sizeof (int) == sizeof (long). */
551 # define longest_to_int(x) ((int) (x))
555 /* Assorted functions we can declare, now that const and volatile are
559 savestring
PARAMS ((const char *, int));
562 msavestring
PARAMS ((void *, const char *, int));
565 strsave
PARAMS ((const char *));
568 mstrsave
PARAMS ((void *, const char *));
571 concat
PARAMS ((char *, ...));
574 xmalloc
PARAMS ((long));
577 xrealloc
PARAMS ((PTR
, long));
580 xmmalloc
PARAMS ((PTR
, long));
583 xmrealloc
PARAMS ((PTR
, PTR
, long));
586 mmalloc
PARAMS ((PTR
, long));
589 mrealloc
PARAMS ((PTR
, PTR
, long));
592 mfree
PARAMS ((PTR
, PTR
));
595 mmcheck
PARAMS ((PTR
, void (*) (void)));
598 mmtrace
PARAMS ((void));
601 parse_escape
PARAMS ((char **));
603 extern const char * const reg_names
[];
605 /* Message to be printed before the error message, when an error occurs. */
607 extern char *error_pre_print
;
609 /* Message to be printed before the warning message, when a warning occurs. */
611 extern char *warning_pre_print
;
613 extern NORETURN
void /* Does not return to the caller. */
616 extern NORETURN
void /* Does not return to the caller. */
619 extern NORETURN
void /* Not specified as volatile in ... */
620 exit
PARAMS ((int)); /* 4.10.4.3 */
622 extern NORETURN
void /* Does not return to the caller. */
623 nomem
PARAMS ((long));
625 /* Reasons for calling return_to_top_level. */
627 /* User interrupt. */
630 /* Any other error. */
634 #define RETURN_MASK_QUIT (1 << (int)RETURN_QUIT)
635 #define RETURN_MASK_ERROR (1 << (int)RETURN_ERROR)
636 #define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
637 typedef int return_mask
;
639 extern NORETURN
void /* Does not return to the caller. */
640 return_to_top_level
PARAMS ((enum return_reason
));
642 extern int catch_errors
PARAMS ((int (*) (char *), void *, char *,
646 warning_setup
PARAMS ((void));
651 /* Global functions from other, non-gdb GNU thingies (libiberty for
655 basename
PARAMS ((char *));
658 getenv
PARAMS ((const char *));
661 buildargv
PARAMS ((char *));
664 freeargv
PARAMS ((char **));
667 strerrno
PARAMS ((int));
670 strsigno
PARAMS ((int));
673 errno_max
PARAMS ((void));
676 signo_max
PARAMS ((void));
679 strtoerrno
PARAMS ((char *));
682 strtosigno
PARAMS ((char *));
685 strsignal
PARAMS ((int));
687 /* From other system libraries */
689 #ifndef PSIGNAL_IN_SIGNAL_H
691 psignal
PARAMS ((unsigned, const char *));
694 /* For now, we can't include <stdlib.h> because it conflicts with
695 "../include/getopt.h". (FIXME)
697 However, if a function is defined in the ANSI C standard and a prototype
698 for that function is defined and visible in any header file in an ANSI
699 conforming environment, then that prototype must match the definition in
700 the ANSI standard. So we can just duplicate them here without conflict,
701 since they must be the same in all conforming ANSI environments. If
702 these cause problems, then the environment is not ANSI conformant. */
709 fclose
PARAMS ((GDB_FILE
*stream
)); /* 4.9.5.1 */
712 perror
PARAMS ((const char *)); /* 4.9.10.4 */
715 atof
PARAMS ((const char *nptr
)); /* 4.10.1.1 */
718 atoi
PARAMS ((const char *)); /* 4.10.1.2 */
720 #ifndef MALLOC_INCOMPATIBLE
723 malloc
PARAMS ((size_t size
)); /* 4.10.3.3 */
726 realloc
PARAMS ((void *ptr
, size_t size
)); /* 4.10.3.4 */
729 free
PARAMS ((void *)); /* 4.10.3.2 */
731 #endif /* MALLOC_INCOMPATIBLE */
734 qsort
PARAMS ((void *base
, size_t nmemb
, /* 4.10.5.2 */
736 int (*comp
)(const void *, const void *)));
738 #ifndef MEM_FNS_DECLARED /* Some non-ANSI use void *, not char *. */
740 memcpy
PARAMS ((void *, const void *, size_t)); /* 4.11.2.1 */
743 memcmp
PARAMS ((const void *, const void *, size_t)); /* 4.11.4.1 */
747 strchr
PARAMS ((const char *, int)); /* 4.11.5.2 */
750 strrchr
PARAMS ((const char *, int)); /* 4.11.5.5 */
753 strstr
PARAMS ((const char *, const char *)); /* 4.11.5.7 */
756 strtok
PARAMS ((char *, const char *)); /* 4.11.5.8 */
758 #ifndef MEM_FNS_DECLARED /* Some non-ANSI use void *, not char *. */
760 memset
PARAMS ((void *, int, size_t)); /* 4.11.6.1 */
764 strerror
PARAMS ((int)); /* 4.11.6.2 */
766 /* Various possibilities for alloca. */
769 # define alloca __builtin_alloca
772 # include <alloca.h> /* NOTE: Doesn't declare alloca() */
775 extern void *alloca (size_t);
776 # else /* __STDC__ */
777 extern char *alloca ();
782 /* TARGET_BYTE_ORDER and HOST_BYTE_ORDER must be defined to one of these. */
784 #if !defined (BIG_ENDIAN)
785 #define BIG_ENDIAN 4321
788 #if !defined (LITTLE_ENDIAN)
789 #define LITTLE_ENDIAN 1234
792 /* Target-system-dependent parameters for GDB. */
794 /* Target machine definition. This will be a symlink to one of the
795 tm-*.h files, built by the `configure' script. */
799 /* Number of bits in a char or unsigned char for the target machine.
800 Just like CHAR_BIT in <limits.h> but describes the target machine. */
801 #if !defined (TARGET_CHAR_BIT)
802 #define TARGET_CHAR_BIT 8
805 /* Number of bits in a short or unsigned short for the target machine. */
806 #if !defined (TARGET_SHORT_BIT)
807 #define TARGET_SHORT_BIT (2 * TARGET_CHAR_BIT)
810 /* Number of bits in an int or unsigned int for the target machine. */
811 #if !defined (TARGET_INT_BIT)
812 #define TARGET_INT_BIT (4 * TARGET_CHAR_BIT)
815 /* Number of bits in a long or unsigned long for the target machine. */
816 #if !defined (TARGET_LONG_BIT)
817 #define TARGET_LONG_BIT (4 * TARGET_CHAR_BIT)
820 /* Number of bits in a long long or unsigned long long for the target machine. */
821 #if !defined (TARGET_LONG_LONG_BIT)
822 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
825 /* Number of bits in a float for the target machine. */
826 #if !defined (TARGET_FLOAT_BIT)
827 #define TARGET_FLOAT_BIT (4 * TARGET_CHAR_BIT)
830 /* Number of bits in a double for the target machine. */
831 #if !defined (TARGET_DOUBLE_BIT)
832 #define TARGET_DOUBLE_BIT (8 * TARGET_CHAR_BIT)
835 /* Number of bits in a long double for the target machine. */
836 #if !defined (TARGET_LONG_DOUBLE_BIT)
837 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
840 /* Number of bits in a "complex" for the target machine. */
841 #if !defined (TARGET_COMPLEX_BIT)
842 #define TARGET_COMPLEX_BIT (2 * TARGET_FLOAT_BIT)
845 /* Number of bits in a "double complex" for the target machine. */
846 #if !defined (TARGET_DOUBLE_COMPLEX_BIT)
847 #define TARGET_DOUBLE_COMPLEX_BIT (2 * TARGET_DOUBLE_BIT)
850 /* Number of bits in a pointer for the target machine */
851 #if !defined (TARGET_PTR_BIT)
852 #define TARGET_PTR_BIT TARGET_INT_BIT
855 /* If we picked up a copy of CHAR_BIT from a configuration file
856 (which may get it by including <limits.h>) then use it to set
857 the number of bits in a host char. If not, use the same size
860 #if defined (CHAR_BIT)
861 #define HOST_CHAR_BIT CHAR_BIT
863 #define HOST_CHAR_BIT TARGET_CHAR_BIT
866 /* The bit byte-order has to do just with numbering of bits in
867 debugging symbols and such. Conceptually, it's quite separate
868 from byte/word byte order. */
870 #if !defined (BITS_BIG_ENDIAN)
871 #if TARGET_BYTE_ORDER == BIG_ENDIAN
872 #define BITS_BIG_ENDIAN 1
873 #endif /* Big endian. */
875 #if TARGET_BYTE_ORDER == LITTLE_ENDIAN
876 #define BITS_BIG_ENDIAN 0
877 #endif /* Little endian. */
878 #endif /* BITS_BIG_ENDIAN not defined. */
881 LONGEST extract_signed_integer
PARAMS ((void *, int));
882 unsigned LONGEST extract_unsigned_integer
PARAMS ((void *, int));
883 CORE_ADDR extract_address
PARAMS ((void *, int));
885 void store_signed_integer
PARAMS ((void *, int, LONGEST
));
886 void store_unsigned_integer
PARAMS ((void *, int, unsigned LONGEST
));
887 void store_address
PARAMS ((void *, int, CORE_ADDR
));
889 double extract_floating
PARAMS ((void *, int));
890 void store_floating
PARAMS ((void *, int, double));
892 /* On some machines there are bits in addresses which are not really
893 part of the address, but are used by the kernel, the hardware, etc.
894 for special purposes. ADDR_BITS_REMOVE takes out any such bits
895 so we get a "real" address such as one would find in a symbol
896 table. This is used only for addresses of instructions, and even then
897 I'm not sure it's used in all contexts. It exists to deal with there
898 being a few stray bits in the PC which would mislead us, not as some sort
899 of generic thing to handle alignment or segmentation (it's possible it
900 should be in TARGET_READ_PC instead). */
901 #if !defined (ADDR_BITS_REMOVE)
902 #define ADDR_BITS_REMOVE(addr) (addr)
903 #endif /* No ADDR_BITS_REMOVE. */
908 push_bytes
PARAMS ((CORE_ADDR
, char *, int));
911 push_word
PARAMS ((CORE_ADDR
, unsigned LONGEST
));
913 /* Some parts of gdb might be considered optional, in the sense that they
914 are not essential for being able to build a working, usable debugger
915 for a specific environment. For example, the maintenance commands
916 are there for the benefit of gdb maintainers. As another example,
917 some environments really don't need gdb's that are able to read N
918 different object file formats. In order to make it possible (but
919 not necessarily recommended) to build "stripped down" versions of
920 gdb, the following defines control selective compilation of those
921 parts of gdb which can be safely left out when necessary. Note that
922 the default is to include everything. */
924 #ifndef MAINTENANCE_CMDS
925 #define MAINTENANCE_CMDS 1
928 #endif /* !defined (DEFS_H) */