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 typedef unsigned int CORE_ADDR
;
33 #define min(a, b) ((a) < (b) ? (a) : (b))
34 #define max(a, b) ((a) > (b) ? (a) : (b))
36 /* Gdb does *lots* of string compares. Use macros to speed them up by
37 avoiding function calls if the first characters are not the same. */
39 #define STRCMP(a,b) (*(a) == *(b) ? strcmp ((a), (b)) : *(a) - *(b))
40 #define STREQ(a,b) (*(a) == *(b) ? !strcmp ((a), (b)) : 0)
41 #define STREQN(a,b,c) (*(a) == *(b) ? !strncmp ((a), (b), (c)) : 0)
43 /* The character C++ uses to build identifiers that must be unique from
44 the program's identifiers (such as $this and $$vptr). */
45 #define CPLUS_MARKER '$' /* May be overridden to '.' for SysV */
47 #include <errno.h> /* System call error return status */
50 extern int immediate_quit
;
51 extern int sevenbit_strings
;
56 #define QUIT { if (quit_flag) quit (); }
58 /* Command classes are top-level categories into which commands are broken
59 down for "help" purposes.
60 Notes on classes: class_alias is for alias commands which are not
61 abbreviations of the original command. class-pseudo is for commands
62 which are not really commands nor help topics ("stop"). */
66 /* Special args to help_list */
67 all_classes
= -2, all_commands
= -1,
68 /* Classes of commands */
69 no_class
= -1, class_run
= 0, class_vars
, class_stack
,
70 class_files
, class_support
, class_info
, class_breakpoint
,
71 class_alias
, class_obscure
, class_user
, class_maintenance
,
75 /* the cleanup list records things that have to be undone
76 if an error happens (descriptors to be closed, memory to be freed, etc.)
77 Each link in the chain records a function to call and an
80 Use make_cleanup to add an element to the cleanup chain.
81 Use do_cleanups to do all cleanup actions back to a given
82 point in the chain. Use discard_cleanups to remove cleanups
83 from the chain back to a given point, not doing them. */
88 void (*function
) PARAMS ((PTR
));
92 /* From blockframe.c */
95 inside_entry_func
PARAMS ((CORE_ADDR
));
98 inside_entry_file
PARAMS ((CORE_ADDR addr
));
101 inside_main_func
PARAMS ((CORE_ADDR pc
));
103 /* start-sanitize-chill */
104 /* From ch-lang.c, for the moment. (FIXME) */
107 chill_demangle
PARAMS ((const char *));
108 /* end-sanitize-chill */
110 /* From libiberty.a */
113 cplus_demangle
PARAMS ((const char *, int));
116 cplus_mangle_opname
PARAMS ((char *, int));
118 /* From libmmalloc.a (memory mapped malloc library) */
121 mmalloc_attach
PARAMS ((int, PTR
));
124 mmalloc_detach
PARAMS ((PTR
));
127 mmalloc
PARAMS ((PTR
, long));
130 mrealloc
PARAMS ((PTR
, PTR
, long));
133 mfree
PARAMS ((PTR
, PTR
));
136 mmalloc_setkey
PARAMS ((PTR
, int, PTR
));
139 mmalloc_getkey
PARAMS ((PTR
, int));
144 strcmp_iw
PARAMS ((const char *, const char *));
147 safe_strerror
PARAMS ((int));
150 safe_strsignal
PARAMS ((int));
153 init_malloc
PARAMS ((PTR
));
156 request_quit
PARAMS ((int));
159 do_cleanups
PARAMS ((struct cleanup
*));
162 discard_cleanups
PARAMS ((struct cleanup
*));
164 /* The bare make_cleanup function is one of those rare beasts that
165 takes almost any type of function as the first arg and anything that
166 will fit in a "void *" as the second arg.
168 Should be, once all calls and called-functions are cleaned up:
169 extern struct cleanup *
170 make_cleanup PARAMS ((void (*function) (PTR), PTR));
172 Until then, lint and/or various type-checking compiler options will
173 complain about make_cleanup calls. It'd be wrong to just cast things,
174 since the type actually passed when the function is called would be
177 extern struct cleanup
*
180 extern struct cleanup
*
181 save_cleanups
PARAMS ((void));
184 restore_cleanups
PARAMS ((struct cleanup
*));
187 free_current_contents
PARAMS ((char **));
190 null_cleanup
PARAMS ((char **));
193 myread
PARAMS ((int, char *, int));
199 begin_line
PARAMS ((void));
202 wrap_here
PARAMS ((char *));
205 reinitialize_more_filter
PARAMS ((void));
208 print_insn
PARAMS ((CORE_ADDR
, FILE *));
211 fputs_filtered
PARAMS ((const char *, FILE *));
214 puts_filtered
PARAMS ((char *));
220 vfprintf_filtered ();
226 fprintfi_filtered ();
235 print_spaces
PARAMS ((int, FILE *));
238 print_spaces_filtered
PARAMS ((int, FILE *));
241 n_spaces
PARAMS ((int));
244 gdb_printchar
PARAMS ((int, FILE *, int));
247 fprint_symbol
PARAMS ((FILE *, char *));
250 fputs_demangled
PARAMS ((char *, FILE *, int));
253 perror_with_name
PARAMS ((char *));
256 print_sys_errmsg
PARAMS ((char *, int));
261 re_comp
PARAMS ((char *));
266 symbol_file_command
PARAMS ((char *, int));
271 skip_quoted
PARAMS ((char *));
274 gdb_readline
PARAMS ((char *));
277 command_line_input
PARAMS ((char *, int));
280 print_prompt
PARAMS ((void));
283 batch_mode
PARAMS ((void));
286 input_from_terminal_p
PARAMS ((void));
289 catch_errors
PARAMS ((int (*) (char *), char *, char *));
291 /* From printcmd.c */
294 set_next_address
PARAMS ((CORE_ADDR
));
297 print_address_symbolic
PARAMS ((CORE_ADDR
, FILE *, int, char *));
300 print_address
PARAMS ((CORE_ADDR
, FILE *));
305 openp
PARAMS ((char *, int, char *, int, int, char **));
308 mod_path
PARAMS ((char *, char **));
311 directory_command
PARAMS ((char *, int));
314 init_source_path
PARAMS ((void));
319 read_relative_register_raw_bytes
PARAMS ((int, char *));
321 /* From readline (but not in any readline .h files). */
324 tilde_expand
PARAMS ((char *));
326 /* Structure for saved commands lines
327 (for breakpoints, defined commands, etc). */
331 struct command_line
*next
;
335 extern struct command_line
*
336 read_command_lines
PARAMS ((void));
339 free_command_lines
PARAMS ((struct command_line
**));
341 /* String containing the current directory (what getwd would return). */
343 extern char *current_directory
;
345 /* Default radixes for input and output. Only some values supported. */
346 extern unsigned input_radix
;
347 extern unsigned output_radix
;
349 /* Baud rate specified for communication with serial target systems. */
350 extern char *baud_rate
;
352 /* Languages represented in the symbol table and elsewhere.
353 This should probably be in language.h, but since enum's can't
354 be forward declared to satisfy opaque references before their
355 actual definition, needs to be here. */
359 language_unknown
, /* Language not known */
360 language_auto
, /* Placeholder for automatic setting */
362 language_cplus
, /* C++ */
363 /* start-sanitize-chill */
364 language_chill
, /* Chill */
365 /* end-sanitize-chill */
366 language_m2
/* Modula-2 */
369 /* Possibilities for prettyprint parameters to routines which print
370 things. Like enum language, this should be in value.h, but needs
371 to be here for the same reason. FIXME: If we can eliminate this
372 as an arg to LA_VAL_PRINT, then we can probably move it back to
377 Val_no_prettyprint
= 0,
379 /* Use the default setting which the user has specified. */
384 /* Host machine definition. This will be a symlink to one of the
385 xm-*.h files, built by the `configure' script. */
389 /* Native machine support. This will be a symlink to one of the
390 nm-*.h files, built by the `configure' script. */
394 /* If the xm.h file did not define the mode string used to open the
395 files, assume that binary files are opened the same way as text
398 #include "fopen-same.h"
402 * Allow things in gdb to be declared "const". If compiling ANSI, it
403 * just works. If compiling with gcc but non-ansi, redefine to __const__.
404 * If non-ansi, non-gcc, then eliminate "const" entirely, making those
405 * objects be read-write rather than read-only.
411 # define const __const__
413 # define const /*nothing*/
421 # define volatile __volatile__
423 # define volatile /*nothing*/
426 #endif /* volatile */
428 /* Some compilers (many AT&T SVR4 compilers for instance), do not accept
429 declarations of functions that never return (exit for instance) as
430 "volatile void". For such compilers "NORETURN" can be defined away
431 to keep them happy */
435 # define NORETURN /*nothing*/
437 # define NORETURN volatile
441 /* Defaults for system-wide constants (if not defined by xm.h, we fake it). */
443 #if !defined (UINT_MAX)
444 #define UINT_MAX 0xffffffff
447 #if !defined (LONG_MAX)
448 #define LONG_MAX 0x7fffffff
451 #if !defined (INT_MAX)
452 #define INT_MAX 0x7fffffff
455 #if !defined (INT_MIN)
456 /* Two's complement, 32 bit. */
457 #define INT_MIN -0x80000000
460 /* Number of bits in a char or unsigned char for the target machine.
461 Just like CHAR_BIT in <limits.h> but describes the target machine. */
462 #if !defined (TARGET_CHAR_BIT)
463 #define TARGET_CHAR_BIT 8
466 /* Number of bits in a short or unsigned short for the target machine. */
467 #if !defined (TARGET_SHORT_BIT)
468 #define TARGET_SHORT_BIT (sizeof (short) * TARGET_CHAR_BIT)
471 /* Number of bits in an int or unsigned int for the target machine. */
472 #if !defined (TARGET_INT_BIT)
473 #define TARGET_INT_BIT (sizeof (int) * TARGET_CHAR_BIT)
476 /* Number of bits in a long or unsigned long for the target machine. */
477 #if !defined (TARGET_LONG_BIT)
478 #define TARGET_LONG_BIT (sizeof (long) * TARGET_CHAR_BIT)
481 /* Number of bits in a long long or unsigned long long for the target machine. */
482 #if !defined (TARGET_LONG_LONG_BIT)
483 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
486 /* Number of bits in a float for the target machine. */
487 #if !defined (TARGET_FLOAT_BIT)
488 #define TARGET_FLOAT_BIT (sizeof (float) * TARGET_CHAR_BIT)
491 /* Number of bits in a double for the target machine. */
492 #if !defined (TARGET_DOUBLE_BIT)
493 #define TARGET_DOUBLE_BIT (sizeof (double) * TARGET_CHAR_BIT)
496 /* Number of bits in a long double for the target machine. */
497 #if !defined (TARGET_LONG_DOUBLE_BIT)
498 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
501 /* Number of bits in a "complex" for the target machine. */
502 #if !defined (TARGET_COMPLEX_BIT)
503 #define TARGET_COMPLEX_BIT (2 * TARGET_FLOAT_BIT)
506 /* Number of bits in a "double complex" for the target machine. */
507 #if !defined (TARGET_DOUBLE_COMPLEX_BIT)
508 #define TARGET_DOUBLE_COMPLEX_BIT (2 * TARGET_DOUBLE_BIT)
511 /* Number of bits in a pointer for the target machine */
512 #if !defined (TARGET_PTR_BIT)
513 #define TARGET_PTR_BIT TARGET_INT_BIT
516 /* Convert a LONGEST to an int. This is used in contexts (e.g. number
517 of arguments to a function, number in a value history, register
518 number, etc.) where the value must not be larger than can fit
520 #if !defined (longest_to_int)
521 #if defined (LONG_LONG)
522 #define longest_to_int(x) (((x) > INT_MAX || (x) < INT_MIN) \
523 ? (error ("Value out of range."),0) : (int) (x))
524 #else /* No LONG_LONG. */
525 /* Assume sizeof (int) == sizeof (long). */
526 #define longest_to_int(x) ((int) (x))
527 #endif /* No LONG_LONG. */
528 #endif /* No longest_to_int. */
530 /* This should not be a typedef, because "unsigned LONGEST" needs
531 to work. LONG_LONG is defined if the host has "long long". */
535 # define LONGEST long long
537 # define LONGEST long
541 /* Assorted functions we can declare, now that const and volatile are
545 savestring
PARAMS ((const char *, int));
548 msavestring
PARAMS ((void *, const char *, int));
551 strsave
PARAMS ((const char *));
554 mstrsave
PARAMS ((void *, const char *));
557 concat
PARAMS ((char *, ...));
560 xmalloc
PARAMS ((long));
563 xrealloc
PARAMS ((PTR
, long));
566 xmmalloc
PARAMS ((PTR
, long));
569 xmrealloc
PARAMS ((PTR
, PTR
, long));
572 mmalloc
PARAMS ((PTR
, long));
575 mrealloc
PARAMS ((PTR
, PTR
, long));
578 mfree
PARAMS ((PTR
, PTR
));
581 mmcheck
PARAMS ((PTR
, void (*) (void)));
584 mmtrace
PARAMS ((void));
587 parse_escape
PARAMS ((char **));
589 extern const char * const reg_names
[];
591 extern NORETURN
void /* Does not return to the caller. */
594 extern NORETURN
void /* Does not return to the caller. */
597 extern NORETURN
void /* Not specified as volatile in ... */
598 exit
PARAMS ((int)); /* 4.10.4.3 */
600 extern NORETURN
void /* Does not return to the caller. */
601 nomem
PARAMS ((long));
603 extern NORETURN
void /* Does not return to the caller. */
604 return_to_top_level
PARAMS ((void));
607 warning_setup
PARAMS ((void));
612 /* Global functions from other, non-gdb GNU thingies (libiberty for
616 basename
PARAMS ((char *));
619 getenv
PARAMS ((const char *));
622 buildargv
PARAMS ((char *));
625 freeargv
PARAMS ((char **));
628 strerrno
PARAMS ((int));
631 strsigno
PARAMS ((int));
634 errno_max
PARAMS ((void));
637 signo_max
PARAMS ((void));
640 strtoerrno
PARAMS ((char *));
643 strtosigno
PARAMS ((char *));
646 strsignal
PARAMS ((int));
648 /* From other system libraries */
650 #ifndef PSIGNAL_IN_SIGNAL_H
652 psignal
PARAMS ((unsigned, char *));
655 /* For now, we can't include <stdlib.h> because it conflicts with
656 "../include/getopt.h". (FIXME)
658 However, if a function is defined in the ANSI C standard and a prototype
659 for that function is defined and visible in any header file in an ANSI
660 conforming environment, then that prototype must match the definition in
661 the ANSI standard. So we can just duplicate them here without conflict,
662 since they must be the same in all conforming ANSI environments. If
663 these cause problems, then the environment is not ANSI conformant. */
670 fclose
PARAMS ((FILE *stream
)); /* 4.9.5.1 */
673 perror
PARAMS ((const char *)); /* 4.9.10.4 */
676 atof
PARAMS ((const char *nptr
)); /* 4.10.1.1 */
679 atoi
PARAMS ((const char *)); /* 4.10.1.2 */
681 #ifndef MALLOC_INCOMPATIBLE
684 malloc
PARAMS ((size_t size
)); /* 4.10.3.3 */
687 realloc
PARAMS ((void *ptr
, size_t size
)); /* 4.10.3.4 */
690 free
PARAMS ((void *)); /* 4.10.3.2 */
692 #endif /* MALLOC_INCOMPATIBLE */
695 qsort
PARAMS ((void *base
, size_t nmemb
, /* 4.10.5.2 */
697 int (*comp
)(const void *, const void *)));
699 #ifndef MEM_FNS_DECLARED /* Some non-ANSI use void *, not char *. */
701 memcpy
PARAMS ((void *, const void *, size_t)); /* 4.11.2.1 */
705 memcmp
PARAMS ((const void *, const void *, size_t)); /* 4.11.4.1 */
708 strchr
PARAMS ((const char *, int)); /* 4.11.5.2 */
711 strrchr
PARAMS ((const char *, int)); /* 4.11.5.5 */
714 strstr
PARAMS ((const char *, const char *)); /* 4.11.5.7 */
717 strtok
PARAMS ((char *, const char *)); /* 4.11.5.8 */
719 #ifndef MEM_FNS_DECLARED /* Some non-ANSI use void *, not char *. */
721 memset
PARAMS ((void *, int, size_t)); /* 4.11.6.1 */
725 strerror
PARAMS ((int)); /* 4.11.6.2 */
727 /* Various possibilities for alloca. */
730 # define alloca __builtin_alloca
733 # include <alloca.h> /* NOTE: Doesn't declare alloca() */
736 extern void *alloca (size_t);
737 # else /* __STDC__ */
738 extern char *alloca ();
743 /* TARGET_BYTE_ORDER and HOST_BYTE_ORDER must be defined to one of these. */
745 #if !defined (BIG_ENDIAN)
746 #define BIG_ENDIAN 4321
749 #if !defined (LITTLE_ENDIAN)
750 #define LITTLE_ENDIAN 1234
753 /* Target-system-dependent parameters for GDB.
755 The standard thing is to include defs.h. However, files that are
756 specific to a particular target can define TM_FILE_OVERRIDE before
757 including defs.h, then can include any particular tm-file they desire. */
759 /* Target machine definition. This will be a symlink to one of the
760 tm-*.h files, built by the `configure' script. */
762 #ifndef TM_FILE_OVERRIDE
766 /* The bit byte-order has to do just with numbering of bits in
767 debugging symbols and such. Conceptually, it's quite separate
768 from byte/word byte order. */
770 #if !defined (BITS_BIG_ENDIAN)
771 #if TARGET_BYTE_ORDER == BIG_ENDIAN
772 #define BITS_BIG_ENDIAN 1
773 #endif /* Big endian. */
775 #if TARGET_BYTE_ORDER == LITTLE_ENDIAN
776 #define BITS_BIG_ENDIAN 0
777 #endif /* Little endian. */
778 #endif /* BITS_BIG_ENDIAN not defined. */
780 /* Swap LEN bytes at BUFFER between target and host byte-order. */
781 #if TARGET_BYTE_ORDER == HOST_BYTE_ORDER
782 #define SWAP_TARGET_AND_HOST(buffer,len)
783 #else /* Target and host byte order differ. */
784 #define SWAP_TARGET_AND_HOST(buffer,len) \
787 char *p = (char *)(buffer); \
788 char *q = ((char *)(buffer)) + len - 1; \
789 for (; p < q; p++, q--) \
796 #endif /* Target and host byte order differ. */
798 /* On some machines there are bits in addresses which are not really
799 part of the address, but are used by the kernel, the hardware, etc.
800 for special purposes. ADDR_BITS_REMOVE takes out any such bits
801 so we get a "real" address such as one would find in a symbol
802 table. ADDR_BITS_SET sets those bits the way the system wants
804 #if !defined (ADDR_BITS_REMOVE)
805 #define ADDR_BITS_REMOVE(addr) (addr)
806 #define ADDR_BITS_SET(addr) (addr)
807 #endif /* No ADDR_BITS_REMOVE. */
812 push_bytes
PARAMS ((CORE_ADDR
, char *, int));
814 /* In some modules, we don't have a definition of REGISTER_TYPE yet, so we
815 must avoid prototyping this function for now. FIXME. Should be:
817 push_word PARAMS ((CORE_ADDR, REGISTER_TYPE));
822 /* Some parts of gdb might be considered optional, in the sense that they
823 are not essential for being able to build a working, usable debugger
824 for a specific environment. For example, the maintenance commands
825 are there for the benefit of gdb maintainers. As another example,
826 some environments really don't need gdb's that are able to read N
827 different object file formats. In order to make it possible (but
828 not necessarily recommended) to build "stripped down" versions of
829 gdb, the following defines control selective compilation of those
830 parts of gdb which can be safely left out when necessary. Note that
831 the default is to include everything. */
833 #ifndef MAINTENANCE_CMDS
834 #define MAINTENANCE_CMDS 1
837 #endif /* !defined (DEFS_H) */