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 /* The character C++ uses to build identifiers that must be unique from
37 the program's identifiers (such as $this and $$vptr). */
38 #define CPLUS_MARKER '$' /* May be overridden to '.' for SysV */
40 #include <errno.h> /* System call error return status */
43 extern int immediate_quit
;
44 extern int sevenbit_strings
;
49 #define QUIT { if (quit_flag) quit (); }
51 /* Command classes are top-level categories into which commands are broken
52 down for "help" purposes.
53 Notes on classes: class_alias is for alias commands which are not
54 abbreviations of the original command. class-pseudo is for commands
55 which are not really commands nor help topics ("stop"). */
59 /* Special args to help_list */
60 all_classes
= -2, all_commands
= -1,
61 /* Classes of commands */
62 no_class
= -1, class_run
= 0, class_vars
, class_stack
,
63 class_files
, class_support
, class_info
, class_breakpoint
,
64 class_alias
, class_obscure
, class_user
, class_maintenance
,
68 /* the cleanup list records things that have to be undone
69 if an error happens (descriptors to be closed, memory to be freed, etc.)
70 Each link in the chain records a function to call and an
73 Use make_cleanup to add an element to the cleanup chain.
74 Use do_cleanups to do all cleanup actions back to a given
75 point in the chain. Use discard_cleanups to remove cleanups
76 from the chain back to a given point, not doing them. */
81 void (*function
) PARAMS ((PTR
));
85 /* From blockframe.c */
88 inside_entry_func
PARAMS ((CORE_ADDR
));
91 inside_entry_file
PARAMS ((CORE_ADDR addr
));
94 inside_main_func
PARAMS ((CORE_ADDR pc
));
96 /* From cplus-dem.c */
99 cplus_demangle
PARAMS ((const char *, int));
102 cplus_mangle_opname
PARAMS ((char *, int));
104 /* From libmmalloc.a (memory mapped malloc library) */
107 mmalloc_attach
PARAMS ((int, PTR
));
110 mmalloc_detach
PARAMS ((PTR
));
113 mmalloc
PARAMS ((PTR
, long));
116 mrealloc
PARAMS ((PTR
, PTR
, long));
119 mfree
PARAMS ((PTR
, PTR
));
122 mmalloc_setkey
PARAMS ((PTR
, int, PTR
));
125 mmalloc_getkey
PARAMS ((PTR
, int));
130 demangle_and_match
PARAMS ((const char *, const char *, int));
133 strcmp_iw
PARAMS ((const char *, const char *));
136 safe_strerror
PARAMS ((int));
139 safe_strsignal
PARAMS ((int));
142 init_malloc
PARAMS ((PTR
));
145 request_quit
PARAMS ((int));
148 do_cleanups
PARAMS ((struct cleanup
*));
151 discard_cleanups
PARAMS ((struct cleanup
*));
153 /* The bare make_cleanup function is one of those rare beasts that
154 takes almost any type of function as the first arg and anything that
155 will fit in a "void *" as the second arg.
157 Should be, once all calls and called-functions are cleaned up:
158 extern struct cleanup *
159 make_cleanup PARAMS ((void (*function) (PTR), PTR));
161 Until then, lint and/or various type-checking compiler options will
162 complain about make_cleanup calls. It'd be wrong to just cast things,
163 since the type actually passed when the function is called would be
166 extern struct cleanup
*
169 extern struct cleanup
*
170 save_cleanups
PARAMS ((void));
173 restore_cleanups
PARAMS ((struct cleanup
*));
176 free_current_contents
PARAMS ((char **));
179 null_cleanup
PARAMS ((char **));
182 myread
PARAMS ((int, char *, int));
188 begin_line
PARAMS ((void));
191 wrap_here
PARAMS ((char *));
194 reinitialize_more_filter
PARAMS ((void));
197 print_insn
PARAMS ((CORE_ADDR
, FILE *));
200 fputs_filtered
PARAMS ((const char *, FILE *));
203 puts_filtered
PARAMS ((char *));
209 vfprintf_filtered ();
215 fprintfi_filtered ();
224 print_spaces
PARAMS ((int, FILE *));
227 print_spaces_filtered
PARAMS ((int, FILE *));
230 n_spaces
PARAMS ((int));
233 gdb_printchar
PARAMS ((int, FILE *, int));
236 strdup_demangled
PARAMS ((const char *));
239 fprint_symbol
PARAMS ((FILE *, char *));
242 fputs_demangled
PARAMS ((char *, FILE *, int));
245 perror_with_name
PARAMS ((char *));
248 print_sys_errmsg
PARAMS ((char *, int));
253 re_comp
PARAMS ((char *));
258 symbol_file_command
PARAMS ((char *, int));
263 skip_quoted
PARAMS ((char *));
266 gdb_readline
PARAMS ((char *));
269 command_line_input
PARAMS ((char *, int));
272 print_prompt
PARAMS ((void));
275 batch_mode
PARAMS ((void));
278 input_from_terminal_p
PARAMS ((void));
281 catch_errors
PARAMS ((int (*) (char *), char *, char *));
283 /* From printcmd.c */
286 set_next_address
PARAMS ((CORE_ADDR
));
289 print_address_symbolic
PARAMS ((CORE_ADDR
, FILE *, int, char *));
292 print_address
PARAMS ((CORE_ADDR
, FILE *));
297 openp
PARAMS ((char *, int, char *, int, int, char **));
300 mod_path
PARAMS ((char *, char **));
303 directory_command
PARAMS ((char *, int));
306 init_source_path
PARAMS ((void));
311 read_relative_register_raw_bytes
PARAMS ((int, char *));
313 /* From readline (but not in any readline .h files). */
316 tilde_expand
PARAMS ((char *));
318 /* Structure for saved commands lines
319 (for breakpoints, defined commands, etc). */
323 struct command_line
*next
;
327 extern struct command_line
*
328 read_command_lines
PARAMS ((void));
331 free_command_lines
PARAMS ((struct command_line
**));
333 /* String containing the current directory (what getwd would return). */
335 extern char *current_directory
;
337 /* Default radixes for input and output. Only some values supported. */
338 extern unsigned input_radix
;
339 extern unsigned output_radix
;
341 /* Baud rate specified for communication with serial target systems. */
342 extern char *baud_rate
;
344 /* Languages represented in the symbol table and elsewhere.
345 This should probably be in language.h, but since enum's can't
346 be forward declared to satisfy opaque references before their
347 actual definition, needs to be here. */
351 language_unknown
, /* Language not known */
352 language_auto
, /* Placeholder for automatic setting */
354 language_cplus
, /* C++ */
355 /* start-sanitize-chill */
356 language_chill
, /* Chill */
357 /* end-sanitize-chill */
358 language_m2
/* Modula-2 */
361 /* Possibilities for prettyprint parameters to routines which print
362 things. Like enum language, this should be in value.h, but needs
363 to be here for the same reason. FIXME: If we can eliminate this
364 as an arg to LA_VAL_PRINT, then we can probably move it back to
369 Val_no_prettyprint
= 0,
371 /* Use the default setting which the user has specified. */
376 /* Host machine definition. This will be a symlink to one of the
377 xm-*.h files, built by the `configure' script. */
381 /* Native machine support. This will be a symlink to one of the
382 nm-*.h files, built by the `configure' script. */
386 /* If the xm.h file did not define the mode string used to open the
387 files, assume that binary files are opened the same way as text
390 #include "fopen-same.h"
394 * Allow things in gdb to be declared "const". If compiling ANSI, it
395 * just works. If compiling with gcc but non-ansi, redefine to __const__.
396 * If non-ansi, non-gcc, then eliminate "const" entirely, making those
397 * objects be read-write rather than read-only.
403 # define const __const__
405 # define const /*nothing*/
413 # define volatile __volatile__
415 # define volatile /*nothing*/
418 #endif /* volatile */
420 /* Some compilers (many AT&T SVR4 compilers for instance), do not accept
421 declarations of functions that never return (exit for instance) as
422 "volatile void". For such compilers "NORETURN" can be defined away
423 to keep them happy */
427 # define NORETURN /*nothing*/
429 # define NORETURN volatile
433 /* Defaults for system-wide constants (if not defined by xm.h, we fake it). */
435 #if !defined (UINT_MAX)
436 #define UINT_MAX 0xffffffff
439 #if !defined (LONG_MAX)
440 #define LONG_MAX 0x7fffffff
443 #if !defined (INT_MAX)
444 #define INT_MAX 0x7fffffff
447 #if !defined (INT_MIN)
448 /* Two's complement, 32 bit. */
449 #define INT_MIN -0x80000000
452 /* Number of bits in a char or unsigned char for the target machine.
453 Just like CHAR_BIT in <limits.h> but describes the target machine. */
454 #if !defined (TARGET_CHAR_BIT)
455 #define TARGET_CHAR_BIT 8
458 /* Number of bits in a short or unsigned short for the target machine. */
459 #if !defined (TARGET_SHORT_BIT)
460 #define TARGET_SHORT_BIT (sizeof (short) * TARGET_CHAR_BIT)
463 /* Number of bits in an int or unsigned int for the target machine. */
464 #if !defined (TARGET_INT_BIT)
465 #define TARGET_INT_BIT (sizeof (int) * TARGET_CHAR_BIT)
468 /* Number of bits in a long or unsigned long for the target machine. */
469 #if !defined (TARGET_LONG_BIT)
470 #define TARGET_LONG_BIT (sizeof (long) * TARGET_CHAR_BIT)
473 /* Number of bits in a long long or unsigned long long for the target machine. */
474 #if !defined (TARGET_LONG_LONG_BIT)
475 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
478 /* Number of bits in a float for the target machine. */
479 #if !defined (TARGET_FLOAT_BIT)
480 #define TARGET_FLOAT_BIT (sizeof (float) * TARGET_CHAR_BIT)
483 /* Number of bits in a double for the target machine. */
484 #if !defined (TARGET_DOUBLE_BIT)
485 #define TARGET_DOUBLE_BIT (sizeof (double) * TARGET_CHAR_BIT)
488 /* Number of bits in a long double for the target machine. */
489 #if !defined (TARGET_LONG_DOUBLE_BIT)
490 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
493 /* Number of bits in a "complex" for the target machine. */
494 #if !defined (TARGET_COMPLEX_BIT)
495 #define TARGET_COMPLEX_BIT (2 * TARGET_FLOAT_BIT)
498 /* Number of bits in a "double complex" for the target machine. */
499 #if !defined (TARGET_DOUBLE_COMPLEX_BIT)
500 #define TARGET_DOUBLE_COMPLEX_BIT (2 * TARGET_DOUBLE_BIT)
503 /* Number of bits in a pointer for the target machine */
504 #if !defined (TARGET_PTR_BIT)
505 #define TARGET_PTR_BIT TARGET_INT_BIT
508 /* Convert a LONGEST to an int. This is used in contexts (e.g. number
509 of arguments to a function, number in a value history, register
510 number, etc.) where the value must not be larger than can fit
512 #if !defined (longest_to_int)
513 #if defined (LONG_LONG)
514 #define longest_to_int(x) (((x) > INT_MAX || (x) < INT_MIN) \
515 ? (error ("Value out of range."),0) : (int) (x))
516 #else /* No LONG_LONG. */
517 /* Assume sizeof (int) == sizeof (long). */
518 #define longest_to_int(x) ((int) (x))
519 #endif /* No LONG_LONG. */
520 #endif /* No longest_to_int. */
522 /* This should not be a typedef, because "unsigned LONGEST" needs
523 to work. LONG_LONG is defined if the host has "long long". */
527 # define LONGEST long long
529 # define LONGEST long
533 /* Assorted functions we can declare, now that const and volatile are
537 savestring
PARAMS ((const char *, int));
540 msavestring
PARAMS ((void *, const char *, int));
543 strsave
PARAMS ((const char *));
546 mstrsave
PARAMS ((void *, const char *));
549 concat
PARAMS ((char *, ...));
552 xmalloc
PARAMS ((long));
555 xrealloc
PARAMS ((PTR
, long));
558 xmmalloc
PARAMS ((PTR
, long));
561 xmrealloc
PARAMS ((PTR
, PTR
, long));
564 mmalloc
PARAMS ((PTR
, long));
567 mrealloc
PARAMS ((PTR
, PTR
, long));
570 mfree
PARAMS ((PTR
, PTR
));
573 mmcheck
PARAMS ((PTR
, void (*) (void)));
576 mmtrace
PARAMS ((void));
579 parse_escape
PARAMS ((char **));
581 extern const char * const reg_names
[];
583 extern NORETURN
void /* Does not return to the caller. */
586 extern NORETURN
void /* Does not return to the caller. */
589 extern NORETURN
void /* Not specified as volatile in ... */
590 exit
PARAMS ((int)); /* 4.10.4.3 */
592 extern NORETURN
void /* Does not return to the caller. */
593 nomem
PARAMS ((long));
595 extern NORETURN
void /* Does not return to the caller. */
596 return_to_top_level
PARAMS ((void));
599 warning_setup
PARAMS ((void));
604 /* Global functions from other, non-gdb GNU thingies (libiberty for
608 basename
PARAMS ((char *));
611 getenv
PARAMS ((const char *));
614 buildargv
PARAMS ((char *));
617 freeargv
PARAMS ((char **));
620 strerrno
PARAMS ((int));
623 strsigno
PARAMS ((int));
626 errno_max
PARAMS ((void));
629 signo_max
PARAMS ((void));
632 strtoerrno
PARAMS ((char *));
635 strtosigno
PARAMS ((char *));
638 strsignal
PARAMS ((int));
640 /* From other system libraries */
642 #ifndef PSIGNAL_IN_SIGNAL_H
644 psignal
PARAMS ((unsigned, char *));
647 /* For now, we can't include <stdlib.h> because it conflicts with
648 "../include/getopt.h". (FIXME)
650 However, if a function is defined in the ANSI C standard and a prototype
651 for that function is defined and visible in any header file in an ANSI
652 conforming environment, then that prototype must match the definition in
653 the ANSI standard. So we can just duplicate them here without conflict,
654 since they must be the same in all conforming ANSI environments. If
655 these cause problems, then the environment is not ANSI conformant. */
662 fclose
PARAMS ((FILE *stream
)); /* 4.9.5.1 */
665 perror
PARAMS ((const char *)); /* 4.9.10.4 */
668 atof
PARAMS ((const char *nptr
)); /* 4.10.1.1 */
671 atoi
PARAMS ((const char *)); /* 4.10.1.2 */
673 #ifndef MALLOC_INCOMPATIBLE
676 malloc
PARAMS ((size_t size
)); /* 4.10.3.3 */
679 realloc
PARAMS ((void *ptr
, size_t size
)); /* 4.10.3.4 */
682 free
PARAMS ((void *)); /* 4.10.3.2 */
684 #endif /* MALLOC_INCOMPATIBLE */
687 qsort
PARAMS ((void *base
, size_t nmemb
, /* 4.10.5.2 */
689 int (*comp
)(const void *, const void *)));
691 #ifndef MEM_FNS_DECLARED /* Some non-ANSI use void *, not char *. */
693 memcpy
PARAMS ((void *, const void *, size_t)); /* 4.11.2.1 */
697 memcmp
PARAMS ((const void *, const void *, size_t)); /* 4.11.4.1 */
700 strchr
PARAMS ((const char *, int)); /* 4.11.5.2 */
703 strrchr
PARAMS ((const char *, int)); /* 4.11.5.5 */
706 strstr
PARAMS ((const char *, const char *)); /* 4.11.5.7 */
709 strtok
PARAMS ((char *, const char *)); /* 4.11.5.8 */
711 #ifndef MEM_FNS_DECLARED /* Some non-ANSI use void *, not char *. */
713 memset
PARAMS ((void *, int, size_t)); /* 4.11.6.1 */
717 strerror
PARAMS ((int)); /* 4.11.6.2 */
719 /* Various possibilities for alloca. */
722 # define alloca __builtin_alloca
725 # include <alloca.h> /* NOTE: Doesn't declare alloca() */
728 extern void *alloca (size_t);
729 # else /* __STDC__ */
730 extern char *alloca ();
735 /* TARGET_BYTE_ORDER and HOST_BYTE_ORDER must be defined to one of these. */
737 #if !defined (BIG_ENDIAN)
738 #define BIG_ENDIAN 4321
741 #if !defined (LITTLE_ENDIAN)
742 #define LITTLE_ENDIAN 1234
745 /* Target-system-dependent parameters for GDB.
747 The standard thing is to include defs.h. However, files that are
748 specific to a particular target can define TM_FILE_OVERRIDE before
749 including defs.h, then can include any particular tm-file they desire. */
751 /* Target machine definition. This will be a symlink to one of the
752 tm-*.h files, built by the `configure' script. */
754 #ifndef TM_FILE_OVERRIDE
758 /* The bit byte-order has to do just with numbering of bits in
759 debugging symbols and such. Conceptually, it's quite separate
760 from byte/word byte order. */
762 #if !defined (BITS_BIG_ENDIAN)
763 #if TARGET_BYTE_ORDER == BIG_ENDIAN
764 #define BITS_BIG_ENDIAN 1
765 #endif /* Big endian. */
767 #if TARGET_BYTE_ORDER == LITTLE_ENDIAN
768 #define BITS_BIG_ENDIAN 0
769 #endif /* Little endian. */
770 #endif /* BITS_BIG_ENDIAN not defined. */
772 /* Swap LEN bytes at BUFFER between target and host byte-order. */
773 #if TARGET_BYTE_ORDER == HOST_BYTE_ORDER
774 #define SWAP_TARGET_AND_HOST(buffer,len)
775 #else /* Target and host byte order differ. */
776 #define SWAP_TARGET_AND_HOST(buffer,len) \
779 char *p = (char *)(buffer); \
780 char *q = ((char *)(buffer)) + len - 1; \
781 for (; p < q; p++, q--) \
788 #endif /* Target and host byte order differ. */
790 /* On some machines there are bits in addresses which are not really
791 part of the address, but are used by the kernel, the hardware, etc.
792 for special purposes. ADDR_BITS_REMOVE takes out any such bits
793 so we get a "real" address such as one would find in a symbol
794 table. ADDR_BITS_SET sets those bits the way the system wants
796 #if !defined (ADDR_BITS_REMOVE)
797 #define ADDR_BITS_REMOVE(addr) (addr)
798 #define ADDR_BITS_SET(addr) (addr)
799 #endif /* No ADDR_BITS_REMOVE. */
804 push_bytes
PARAMS ((CORE_ADDR
, char *, int));
806 /* In some modules, we don't have a definition of REGISTER_TYPE yet, so we
807 must avoid prototyping this function for now. FIXME. Should be:
809 push_word PARAMS ((CORE_ADDR, REGISTER_TYPE));
814 /* Some parts of gdb might be considered optional, in the sense that they
815 are not essential for being able to build a working, usable debugger
816 for a specific environment. For example, the maintenance commands
817 are there for the benefit of gdb maintainers. As another example,
818 some environments really don't need gdb's that are able to read N
819 different object file formats. In order to make it possible (but
820 not necessarily recommended) to build "stripped down" versions of
821 gdb, the following defines control selective compilation of those
822 parts of gdb which can be safely left out when necessary. Note that
823 the default is to include everything. */
825 #ifndef MAINTENANCE_CMDS
826 #define MAINTENANCE_CMDS 1
829 #endif /* !defined (DEFS_H) */