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)) : (int)*(a) - (int)*(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 /* Languages represented in the symbol table and elsewhere.
76 This should probably be in language.h, but since enum's can't
77 be forward declared to satisfy opaque references before their
78 actual definition, needs to be here. */
82 language_unknown, /* Language not known */
83 language_auto, /* Placeholder for automatic setting */
85 language_cplus, /* C++ */
86 language_chill, /* Chill */
87 language_m2 /* Modula-2 */
90 /* the cleanup list records things that have to be undone
91 if an error happens (descriptors to be closed, memory to be freed, etc.)
92 Each link in the chain records a function to call and an
95 Use make_cleanup to add an element to the cleanup chain.
96 Use do_cleanups to do all cleanup actions back to a given
97 point in the chain. Use discard_cleanups to remove cleanups
98 from the chain back to a given point, not doing them. */
102 struct cleanup *next;
103 void (*function) PARAMS ((PTR));
107 /* From blockframe.c */
110 inside_entry_func PARAMS ((CORE_ADDR));
113 inside_entry_file PARAMS ((CORE_ADDR addr));
116 inside_main_func PARAMS ((CORE_ADDR pc));
118 /* From ch-lang.c, for the moment. (FIXME) */
121 chill_demangle PARAMS ((const char *));
123 /* From libiberty.a */
126 cplus_demangle PARAMS ((const char *, int));
129 cplus_mangle_opname PARAMS ((char *, int));
131 /* From libmmalloc.a (memory mapped malloc library) */
134 mmalloc_attach PARAMS ((int, PTR));
137 mmalloc_detach PARAMS ((PTR));
140 mmalloc PARAMS ((PTR, long));
143 mrealloc PARAMS ((PTR, PTR, long));
146 mfree PARAMS ((PTR, PTR));
149 mmalloc_setkey PARAMS ((PTR, int, PTR));
152 mmalloc_getkey PARAMS ((PTR, int));
157 strcmp_iw PARAMS ((const char *, const char *));
160 safe_strerror PARAMS ((int));
163 safe_strsignal PARAMS ((int));
166 init_malloc PARAMS ((PTR));
169 request_quit PARAMS ((int));
172 do_cleanups PARAMS ((struct cleanup *));
175 discard_cleanups PARAMS ((struct cleanup *));
177 /* The bare make_cleanup function is one of those rare beasts that
178 takes almost any type of function as the first arg and anything that
179 will fit in a "void *" as the second arg.
181 Should be, once all calls and called-functions are cleaned up:
182 extern struct cleanup *
183 make_cleanup PARAMS ((void (*function) (PTR), PTR));
185 Until then, lint and/or various type-checking compiler options will
186 complain about make_cleanup calls. It'd be wrong to just cast things,
187 since the type actually passed when the function is called would be
190 extern struct cleanup *
193 extern struct cleanup *
194 save_cleanups PARAMS ((void));
197 restore_cleanups PARAMS ((struct cleanup *));
200 free_current_contents PARAMS ((char **));
203 null_cleanup PARAMS ((char **));
206 myread PARAMS ((int, char *, int));
212 begin_line PARAMS ((void));
215 wrap_here PARAMS ((char *));
218 reinitialize_more_filter PARAMS ((void));
221 print_insn PARAMS ((CORE_ADDR, FILE *));
224 fputs_filtered PARAMS ((const char *, FILE *));
227 puts_filtered PARAMS ((char *));
233 vfprintf_filtered ();
239 fprintfi_filtered ();
248 print_spaces PARAMS ((int, FILE *));
251 print_spaces_filtered PARAMS ((int, FILE *));
254 n_spaces PARAMS ((int));
257 gdb_printchar PARAMS ((int, FILE *, int));
260 fprintf_symbol_filtered PARAMS ((FILE *, char *, enum language, int));
263 perror_with_name PARAMS ((char *));
266 print_sys_errmsg PARAMS ((char *, int));
271 re_comp PARAMS ((char *));
276 symbol_file_command PARAMS ((char *, int));
281 skip_quoted PARAMS ((char *));
284 gdb_readline PARAMS ((char *));
287 command_line_input PARAMS ((char *, int));
290 print_prompt PARAMS ((void));
293 batch_mode PARAMS ((void));
296 input_from_terminal_p PARAMS ((void));
299 catch_errors PARAMS ((int (*) (char *), char *, char *));
301 /* From printcmd.c */
304 set_next_address PARAMS ((CORE_ADDR));
307 print_address_symbolic PARAMS ((CORE_ADDR, FILE *, int, char *));
310 print_address PARAMS ((CORE_ADDR, FILE *));
315 openp PARAMS ((char *, int, char *, int, int, char **));
318 mod_path PARAMS ((char *, char **));
321 directory_command PARAMS ((char *, int));
324 init_source_path PARAMS ((void));
329 read_relative_register_raw_bytes PARAMS ((int, char *));
331 /* From readline (but not in any readline .h files). */
334 tilde_expand PARAMS ((char *));
336 /* Structure for saved commands lines
337 (for breakpoints, defined commands, etc). */
341 struct command_line *next;
345 extern struct command_line *
346 read_command_lines PARAMS ((void));
349 free_command_lines PARAMS ((struct command_line **));
351 /* String containing the current directory (what getwd would return). */
353 extern char *current_directory;
355 /* Default radixes for input and output. Only some values supported. */
356 extern unsigned input_radix;
357 extern unsigned output_radix;
359 /* Baud rate specified for communication with serial target systems. */
360 extern char *baud_rate;
362 /* Possibilities for prettyprint parameters to routines which print
363 things. Like enum language, this should be in value.h, but needs
364 to be here for the same reason. FIXME: If we can eliminate this
365 as an arg to LA_VAL_PRINT, then we can probably move it back to
370 Val_no_prettyprint = 0,
372 /* Use the default setting which the user has specified. */
377 /* Host machine definition. This will be a symlink to one of the
378 xm-*.h files, built by the `configure' script. */
382 /* Native machine support. This will be a symlink to one of the
383 nm-*.h files, built by the `configure' script. */
387 /* If the xm.h file did not define the mode string used to open the
388 files, assume that binary files are opened the same way as text
391 #include "fopen-same.h"
395 * Allow things in gdb to be declared "const". If compiling ANSI, it
396 * just works. If compiling with gcc but non-ansi, redefine to __const__.
397 * If non-ansi, non-gcc, then eliminate "const" entirely, making those
398 * objects be read-write rather than read-only.
404 # define const __const__
406 # define const /*nothing*/
414 # define volatile __volatile__
416 # define volatile /*nothing*/
419 #endif /* volatile */
421 /* Some compilers (many AT&T SVR4 compilers for instance), do not accept
422 declarations of functions that never return (exit for instance) as
423 "volatile void". For such compilers "NORETURN" can be defined away
424 to keep them happy */
428 # define NORETURN /*nothing*/
430 # define NORETURN volatile
434 /* Defaults for system-wide constants (if not defined by xm.h, we fake it). */
436 #if !defined (UINT_MAX)
437 #define UINT_MAX 0xffffffff
440 #if !defined (LONG_MAX)
441 #define LONG_MAX 0x7fffffff
444 #if !defined (INT_MAX)
445 #define INT_MAX 0x7fffffff
448 #if !defined (INT_MIN)
449 /* Two's complement, 32 bit. */
450 #define INT_MIN -0x80000000
453 /* Number of bits in a char or unsigned char for the target machine.
454 Just like CHAR_BIT in <limits.h> but describes the target machine. */
455 #if !defined (TARGET_CHAR_BIT)
456 #define TARGET_CHAR_BIT 8
459 /* Number of bits in a short or unsigned short for the target machine. */
460 #if !defined (TARGET_SHORT_BIT)
461 #define TARGET_SHORT_BIT (sizeof (short) * TARGET_CHAR_BIT)
464 /* Number of bits in an int or unsigned int for the target machine. */
465 #if !defined (TARGET_INT_BIT)
466 #define TARGET_INT_BIT (sizeof (int) * TARGET_CHAR_BIT)
469 /* Number of bits in a long or unsigned long for the target machine. */
470 #if !defined (TARGET_LONG_BIT)
471 #define TARGET_LONG_BIT (sizeof (long) * TARGET_CHAR_BIT)
474 /* Number of bits in a long long or unsigned long long for the target machine. */
475 #if !defined (TARGET_LONG_LONG_BIT)
476 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
479 /* Number of bits in a float for the target machine. */
480 #if !defined (TARGET_FLOAT_BIT)
481 #define TARGET_FLOAT_BIT (sizeof (float) * TARGET_CHAR_BIT)
484 /* Number of bits in a double for the target machine. */
485 #if !defined (TARGET_DOUBLE_BIT)
486 #define TARGET_DOUBLE_BIT (sizeof (double) * TARGET_CHAR_BIT)
489 /* Number of bits in a long double for the target machine. */
490 #if !defined (TARGET_LONG_DOUBLE_BIT)
491 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
494 /* Number of bits in a "complex" for the target machine. */
495 #if !defined (TARGET_COMPLEX_BIT)
496 #define TARGET_COMPLEX_BIT (2 * TARGET_FLOAT_BIT)
499 /* Number of bits in a "double complex" for the target machine. */
500 #if !defined (TARGET_DOUBLE_COMPLEX_BIT)
501 #define TARGET_DOUBLE_COMPLEX_BIT (2 * TARGET_DOUBLE_BIT)
504 /* Number of bits in a pointer for the target machine */
505 #if !defined (TARGET_PTR_BIT)
506 #define TARGET_PTR_BIT TARGET_INT_BIT
509 /* Convert a LONGEST to an int. This is used in contexts (e.g. number
510 of arguments to a function, number in a value history, register
511 number, etc.) where the value must not be larger than can fit
513 #if !defined (longest_to_int)
514 #if defined (LONG_LONG)
515 #define longest_to_int(x) (((x) > INT_MAX || (x) < INT_MIN) \
516 ? (error ("Value out of range."),0) : (int) (x))
517 #else /* No LONG_LONG. */
518 /* Assume sizeof (int) == sizeof (long). */
519 #define longest_to_int(x) ((int) (x))
520 #endif /* No LONG_LONG. */
521 #endif /* No longest_to_int. */
523 /* This should not be a typedef, because "unsigned LONGEST" needs
524 to work. LONG_LONG is defined if the host has "long long". */
528 # define LONGEST long long
530 # define LONGEST long
534 /* If we picked up a copy of CHAR_BIT from a configuration file
535 (which may get it by including <limits.h>) then use it to set
536 the number of bits in a host char. If not, use the same size
539 #if defined (CHAR_BIT)
540 #define HOST_CHAR_BIT CHAR_BIT
542 #define HOST_CHAR_BIT TARGET_CHAR_BIT
545 /* Assorted functions we can declare, now that const and volatile are
549 savestring PARAMS ((const char *, int));
552 msavestring PARAMS ((void *, const char *, int));
555 strsave PARAMS ((const char *));
558 mstrsave PARAMS ((void *, const char *));
561 concat PARAMS ((char *, ...));
564 xmalloc PARAMS ((long));
567 xrealloc PARAMS ((PTR, long));
570 xmmalloc PARAMS ((PTR, long));
573 xmrealloc PARAMS ((PTR, PTR, long));
576 mmalloc PARAMS ((PTR, long));
579 mrealloc PARAMS ((PTR, PTR, long));
582 mfree PARAMS ((PTR, PTR));
585 mmcheck PARAMS ((PTR, void (*) (void)));
588 mmtrace PARAMS ((void));
591 parse_escape PARAMS ((char **));
593 extern const char * const reg_names[];
595 extern NORETURN void /* Does not return to the caller. */
598 extern NORETURN void /* Does not return to the caller. */
601 extern NORETURN void /* Not specified as volatile in ... */
602 exit PARAMS ((int)); /* 4.10.4.3 */
604 extern NORETURN void /* Does not return to the caller. */
605 nomem PARAMS ((long));
607 extern NORETURN void /* Does not return to the caller. */
608 return_to_top_level PARAMS ((void));
611 warning_setup PARAMS ((void));
616 /* Global functions from other, non-gdb GNU thingies (libiberty for
620 basename PARAMS ((char *));
623 getenv PARAMS ((const char *));
626 buildargv PARAMS ((char *));
629 freeargv PARAMS ((char **));
632 strerrno PARAMS ((int));
635 strsigno PARAMS ((int));
638 errno_max PARAMS ((void));
641 signo_max PARAMS ((void));
644 strtoerrno PARAMS ((char *));
647 strtosigno PARAMS ((char *));
650 strsignal PARAMS ((int));
652 /* From other system libraries */
654 #ifndef PSIGNAL_IN_SIGNAL_H
656 psignal PARAMS ((unsigned, char *));
659 /* For now, we can't include <stdlib.h> because it conflicts with
660 "../include/getopt.h". (FIXME)
662 However, if a function is defined in the ANSI C standard and a prototype
663 for that function is defined and visible in any header file in an ANSI
664 conforming environment, then that prototype must match the definition in
665 the ANSI standard. So we can just duplicate them here without conflict,
666 since they must be the same in all conforming ANSI environments. If
667 these cause problems, then the environment is not ANSI conformant. */
674 fclose PARAMS ((FILE *stream)); /* 4.9.5.1 */
677 perror PARAMS ((const char *)); /* 4.9.10.4 */
680 atof PARAMS ((const char *nptr)); /* 4.10.1.1 */
683 atoi PARAMS ((const char *)); /* 4.10.1.2 */
685 #ifndef MALLOC_INCOMPATIBLE
688 malloc PARAMS ((size_t size)); /* 4.10.3.3 */
691 realloc PARAMS ((void *ptr, size_t size)); /* 4.10.3.4 */
694 free PARAMS ((void *)); /* 4.10.3.2 */
696 #endif /* MALLOC_INCOMPATIBLE */
699 qsort PARAMS ((void *base, size_t nmemb, /* 4.10.5.2 */
701 int (*comp)(const void *, const void *)));
703 #ifndef MEM_FNS_DECLARED /* Some non-ANSI use void *, not char *. */
705 memcpy PARAMS ((void *, const void *, size_t)); /* 4.11.2.1 */
709 memcmp PARAMS ((const void *, const void *, size_t)); /* 4.11.4.1 */
712 strchr PARAMS ((const char *, int)); /* 4.11.5.2 */
715 strrchr PARAMS ((const char *, int)); /* 4.11.5.5 */
718 strstr PARAMS ((const char *, const char *)); /* 4.11.5.7 */
721 strtok PARAMS ((char *, const char *)); /* 4.11.5.8 */
723 #ifndef MEM_FNS_DECLARED /* Some non-ANSI use void *, not char *. */
725 memset PARAMS ((void *, int, size_t)); /* 4.11.6.1 */
729 strerror PARAMS ((int)); /* 4.11.6.2 */
731 /* Various possibilities for alloca. */
734 # define alloca __builtin_alloca
737 # include <alloca.h> /* NOTE: Doesn't declare alloca() */
740 extern void *alloca (size_t);
741 # else /* __STDC__ */
742 extern char *alloca ();
747 /* TARGET_BYTE_ORDER and HOST_BYTE_ORDER must be defined to one of these. */
749 #if !defined (BIG_ENDIAN)
750 #define BIG_ENDIAN 4321
753 #if !defined (LITTLE_ENDIAN)
754 #define LITTLE_ENDIAN 1234
757 /* Target-system-dependent parameters for GDB.
759 The standard thing is to include defs.h. However, files that are
760 specific to a particular target can define TM_FILE_OVERRIDE before
761 including defs.h, then can include any particular tm-file they desire. */
763 /* Target machine definition. This will be a symlink to one of the
764 tm-*.h files, built by the `configure' script. */
766 #ifndef TM_FILE_OVERRIDE
770 /* The bit byte-order has to do just with numbering of bits in
771 debugging symbols and such. Conceptually, it's quite separate
772 from byte/word byte order. */
774 #if !defined (BITS_BIG_ENDIAN)
775 #if TARGET_BYTE_ORDER == BIG_ENDIAN
776 #define BITS_BIG_ENDIAN 1
777 #endif /* Big endian. */
779 #if TARGET_BYTE_ORDER == LITTLE_ENDIAN
780 #define BITS_BIG_ENDIAN 0
781 #endif /* Little endian. */
782 #endif /* BITS_BIG_ENDIAN not defined. */
784 /* Swap LEN bytes at BUFFER between target and host byte-order. */
785 #if TARGET_BYTE_ORDER == HOST_BYTE_ORDER
786 #define SWAP_TARGET_AND_HOST(buffer,len)
787 #else /* Target and host byte order differ. */
788 #define SWAP_TARGET_AND_HOST(buffer,len) \
791 char *p = (char *)(buffer); \
792 char *q = ((char *)(buffer)) + len - 1; \
793 for (; p < q; p++, q--) \
800 #endif /* Target and host byte order differ. */
802 /* On some machines there are bits in addresses which are not really
803 part of the address, but are used by the kernel, the hardware, etc.
804 for special purposes. ADDR_BITS_REMOVE takes out any such bits
805 so we get a "real" address such as one would find in a symbol
806 table. ADDR_BITS_SET sets those bits the way the system wants
808 #if !defined (ADDR_BITS_REMOVE)
809 #define ADDR_BITS_REMOVE(addr) (addr)
810 #define ADDR_BITS_SET(addr) (addr)
811 #endif /* No ADDR_BITS_REMOVE. */
816 push_bytes PARAMS ((CORE_ADDR, char *, int));
818 /* In some modules, we don't have a definition of REGISTER_TYPE yet, so we
819 must avoid prototyping this function for now. FIXME. Should be:
821 push_word PARAMS ((CORE_ADDR, REGISTER_TYPE));
826 /* Some parts of gdb might be considered optional, in the sense that they
827 are not essential for being able to build a working, usable debugger
828 for a specific environment. For example, the maintenance commands
829 are there for the benefit of gdb maintainers. As another example,
830 some environments really don't need gdb's that are able to read N
831 different object file formats. In order to make it possible (but
832 not necessarily recommended) to build "stripped down" versions of
833 gdb, the following defines control selective compilation of those
834 parts of gdb which can be safely left out when necessary. Note that
835 the default is to include everything. */
837 #ifndef MAINTENANCE_CMDS
838 #define MAINTENANCE_CMDS 1
841 #endif /* !defined (DEFS_H) */