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 */
362 /* Host machine definition. This will be a symlink to one of the
363 xm-*.h files, built by the `configure' script. */
367 /* Native machine support. This will be a symlink to one of the
368 nm-*.h files, built by the `configure' script. */
372 /* If the xm.h file did not define the mode string used to open the
373 files, assume that binary files are opened the same way as text
376 #include "fopen-same.h"
380 * Allow things in gdb to be declared "const". If compiling ANSI, it
381 * just works. If compiling with gcc but non-ansi, redefine to __const__.
382 * If non-ansi, non-gcc, then eliminate "const" entirely, making those
383 * objects be read-write rather than read-only.
389 # define const __const__
391 # define const /*nothing*/
399 # define volatile __volatile__
401 # define volatile /*nothing*/
404 #endif /* volatile */
406 /* Some compilers (many AT&T SVR4 compilers for instance), do not accept
407 declarations of functions that never return (exit for instance) as
408 "volatile void". For such compilers "NORETURN" can be defined away
409 to keep them happy */
413 # define NORETURN /*nothing*/
415 # define NORETURN volatile
419 /* Defaults for system-wide constants (if not defined by xm.h, we fake it). */
421 #if !defined (UINT_MAX)
422 #define UINT_MAX 0xffffffff
425 #if !defined (LONG_MAX)
426 #define LONG_MAX 0x7fffffff
429 #if !defined (INT_MAX)
430 #define INT_MAX 0x7fffffff
433 #if !defined (INT_MIN)
434 /* Two's complement, 32 bit. */
435 #define INT_MIN -0x80000000
438 /* Number of bits in a char or unsigned char for the target machine.
439 Just like CHAR_BIT in <limits.h> but describes the target machine. */
440 #if !defined (TARGET_CHAR_BIT)
441 #define TARGET_CHAR_BIT 8
444 /* Number of bits in a short or unsigned short for the target machine. */
445 #if !defined (TARGET_SHORT_BIT)
446 #define TARGET_SHORT_BIT (sizeof (short) * TARGET_CHAR_BIT)
449 /* Number of bits in an int or unsigned int for the target machine. */
450 #if !defined (TARGET_INT_BIT)
451 #define TARGET_INT_BIT (sizeof (int) * TARGET_CHAR_BIT)
454 /* Number of bits in a long or unsigned long for the target machine. */
455 #if !defined (TARGET_LONG_BIT)
456 #define TARGET_LONG_BIT (sizeof (long) * TARGET_CHAR_BIT)
459 /* Number of bits in a long long or unsigned long long for the target machine. */
460 #if !defined (TARGET_LONG_LONG_BIT)
461 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
464 /* Number of bits in a float for the target machine. */
465 #if !defined (TARGET_FLOAT_BIT)
466 #define TARGET_FLOAT_BIT (sizeof (float) * TARGET_CHAR_BIT)
469 /* Number of bits in a double for the target machine. */
470 #if !defined (TARGET_DOUBLE_BIT)
471 #define TARGET_DOUBLE_BIT (sizeof (double) * TARGET_CHAR_BIT)
474 /* Number of bits in a long double for the target machine. */
475 #if !defined (TARGET_LONG_DOUBLE_BIT)
476 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
479 /* Number of bits in a "complex" for the target machine. */
480 #if !defined (TARGET_COMPLEX_BIT)
481 #define TARGET_COMPLEX_BIT (2 * TARGET_FLOAT_BIT)
484 /* Number of bits in a "double complex" for the target machine. */
485 #if !defined (TARGET_DOUBLE_COMPLEX_BIT)
486 #define TARGET_DOUBLE_COMPLEX_BIT (2 * TARGET_DOUBLE_BIT)
489 /* Number of bits in a pointer for the target machine */
490 #if !defined (TARGET_PTR_BIT)
491 #define TARGET_PTR_BIT TARGET_INT_BIT
494 /* Convert a LONGEST to an int. This is used in contexts (e.g. number
495 of arguments to a function, number in a value history, register
496 number, etc.) where the value must not be larger than can fit
498 #if !defined (longest_to_int)
499 #if defined (LONG_LONG)
500 #define longest_to_int(x) (((x) > INT_MAX || (x) < INT_MIN) \
501 ? (error ("Value out of range."),0) : (int) (x))
502 #else /* No LONG_LONG. */
503 /* Assume sizeof (int) == sizeof (long). */
504 #define longest_to_int(x) ((int) (x))
505 #endif /* No LONG_LONG. */
506 #endif /* No longest_to_int. */
508 /* This should not be a typedef, because "unsigned LONGEST" needs
509 to work. LONG_LONG is defined if the host has "long long". */
513 # define LONGEST long long
515 # define LONGEST long
519 /* Assorted functions we can declare, now that const and volatile are
523 savestring
PARAMS ((const char *, int));
526 msavestring
PARAMS ((void *, const char *, int));
529 strsave
PARAMS ((const char *));
532 mstrsave
PARAMS ((void *, const char *));
535 concat
PARAMS ((char *, ...));
538 xmalloc
PARAMS ((long));
541 xrealloc
PARAMS ((PTR
, long));
544 xmmalloc
PARAMS ((PTR
, long));
547 xmrealloc
PARAMS ((PTR
, PTR
, long));
550 mmalloc
PARAMS ((PTR
, long));
553 mrealloc
PARAMS ((PTR
, PTR
, long));
556 mfree
PARAMS ((PTR
, PTR
));
559 mmcheck
PARAMS ((PTR
, void (*) (void)));
562 mmtrace
PARAMS ((void));
565 parse_escape
PARAMS ((char **));
567 extern const char * const reg_names
[];
569 extern NORETURN
void /* Does not return to the caller. */
572 extern NORETURN
void /* Does not return to the caller. */
575 extern NORETURN
void /* Not specified as volatile in ... */
576 exit
PARAMS ((int)); /* 4.10.4.3 */
578 extern NORETURN
void /* Does not return to the caller. */
579 nomem
PARAMS ((long));
581 extern NORETURN
void /* Does not return to the caller. */
582 return_to_top_level
PARAMS ((void));
585 warning_setup
PARAMS ((void));
590 /* Global functions from other, non-gdb GNU thingies (libiberty for
594 basename
PARAMS ((char *));
597 getenv
PARAMS ((const char *));
600 buildargv
PARAMS ((char *));
603 freeargv
PARAMS ((char **));
606 strerrno
PARAMS ((int));
609 strsigno
PARAMS ((int));
612 errno_max
PARAMS ((void));
615 signo_max
PARAMS ((void));
618 strtoerrno
PARAMS ((char *));
621 strtosigno
PARAMS ((char *));
624 strsignal
PARAMS ((int));
626 /* From other system libraries */
628 #ifndef PSIGNAL_IN_SIGNAL_H
630 psignal
PARAMS ((unsigned, char *));
633 /* For now, we can't include <stdlib.h> because it conflicts with
634 "../include/getopt.h". (FIXME)
636 However, if a function is defined in the ANSI C standard and a prototype
637 for that function is defined and visible in any header file in an ANSI
638 conforming environment, then that prototype must match the definition in
639 the ANSI standard. So we can just duplicate them here without conflict,
640 since they must be the same in all conforming ANSI environments. If
641 these cause problems, then the environment is not ANSI conformant. */
648 fclose
PARAMS ((FILE *stream
)); /* 4.9.5.1 */
651 perror
PARAMS ((const char *)); /* 4.9.10.4 */
654 atof
PARAMS ((const char *nptr
)); /* 4.10.1.1 */
657 atoi
PARAMS ((const char *)); /* 4.10.1.2 */
659 #ifndef MALLOC_INCOMPATIBLE
662 malloc
PARAMS ((size_t size
)); /* 4.10.3.3 */
665 realloc
PARAMS ((void *ptr
, size_t size
)); /* 4.10.3.4 */
668 free
PARAMS ((void *)); /* 4.10.3.2 */
670 #endif /* MALLOC_INCOMPATIBLE */
673 qsort
PARAMS ((void *base
, size_t nmemb
, /* 4.10.5.2 */
675 int (*comp
)(const void *, const void *)));
677 #ifndef MEM_FNS_DECLARED /* Some non-ANSI use void *, not char *. */
679 memcpy
PARAMS ((void *, const void *, size_t)); /* 4.11.2.1 */
683 memcmp
PARAMS ((const void *, const void *, size_t)); /* 4.11.4.1 */
686 strchr
PARAMS ((const char *, int)); /* 4.11.5.2 */
689 strrchr
PARAMS ((const char *, int)); /* 4.11.5.5 */
692 strstr
PARAMS ((const char *, const char *)); /* 4.11.5.7 */
695 strtok
PARAMS ((char *, const char *)); /* 4.11.5.8 */
697 #ifndef MEM_FNS_DECLARED /* Some non-ANSI use void *, not char *. */
699 memset
PARAMS ((void *, int, size_t)); /* 4.11.6.1 */
703 strerror
PARAMS ((int)); /* 4.11.6.2 */
705 /* Various possibilities for alloca. */
708 # define alloca __builtin_alloca
711 # include <alloca.h> /* NOTE: Doesn't declare alloca() */
714 extern void *alloca (size_t);
715 # else /* __STDC__ */
716 extern char *alloca ();
721 /* TARGET_BYTE_ORDER and HOST_BYTE_ORDER must be defined to one of these. */
723 #if !defined (BIG_ENDIAN)
724 #define BIG_ENDIAN 4321
727 #if !defined (LITTLE_ENDIAN)
728 #define LITTLE_ENDIAN 1234
731 /* Target-system-dependent parameters for GDB.
733 The standard thing is to include defs.h. However, files that are
734 specific to a particular target can define TM_FILE_OVERRIDE before
735 including defs.h, then can include any particular tm-file they desire. */
737 /* Target machine definition. This will be a symlink to one of the
738 tm-*.h files, built by the `configure' script. */
740 #ifndef TM_FILE_OVERRIDE
744 /* The bit byte-order has to do just with numbering of bits in
745 debugging symbols and such. Conceptually, it's quite separate
746 from byte/word byte order. */
748 #if !defined (BITS_BIG_ENDIAN)
749 #if TARGET_BYTE_ORDER == BIG_ENDIAN
750 #define BITS_BIG_ENDIAN 1
751 #endif /* Big endian. */
753 #if TARGET_BYTE_ORDER == LITTLE_ENDIAN
754 #define BITS_BIG_ENDIAN 0
755 #endif /* Little endian. */
756 #endif /* BITS_BIG_ENDIAN not defined. */
758 /* Swap LEN bytes at BUFFER between target and host byte-order. */
759 #if TARGET_BYTE_ORDER == HOST_BYTE_ORDER
760 #define SWAP_TARGET_AND_HOST(buffer,len)
761 #else /* Target and host byte order differ. */
762 #define SWAP_TARGET_AND_HOST(buffer,len) \
765 char *p = (char *)(buffer); \
766 char *q = ((char *)(buffer)) + len - 1; \
767 for (; p < q; p++, q--) \
774 #endif /* Target and host byte order differ. */
776 /* On some machines there are bits in addresses which are not really
777 part of the address, but are used by the kernel, the hardware, etc.
778 for special purposes. ADDR_BITS_REMOVE takes out any such bits
779 so we get a "real" address such as one would find in a symbol
780 table. ADDR_BITS_SET sets those bits the way the system wants
782 #if !defined (ADDR_BITS_REMOVE)
783 #define ADDR_BITS_REMOVE(addr) (addr)
784 #define ADDR_BITS_SET(addr) (addr)
785 #endif /* No ADDR_BITS_REMOVE. */
790 push_bytes
PARAMS ((CORE_ADDR
, char *, int));
792 /* In some modules, we don't have a definition of REGISTER_TYPE yet, so we
793 must avoid prototyping this function for now. FIXME. Should be:
795 push_word PARAMS ((CORE_ADDR, REGISTER_TYPE));
800 /* Some parts of gdb might be considered optional, in the sense that they
801 are not essential for being able to build a working, usable debugger
802 for a specific environment. For example, the maintenance commands
803 are there for the benefit of gdb maintainers. As another example,
804 some environments really don't need gdb's that are able to read N
805 different object file formats. In order to make it possible (but
806 not necessarily recommended) to build "stripped down" versions of
807 gdb, the following defines control selective compilation of those
808 parts of gdb which can be safely left out when necessary. Note that
809 the default is to include everything. */
811 #ifndef MAINTENANCE_CMDS
812 #define MAINTENANCE_CMDS 1
815 #endif /* !defined (DEFS_H) */