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
;
48 #define QUIT { if (quit_flag) quit (); }
50 /* Command classes are top-level categories into which commands are broken
51 down for "help" purposes.
52 Notes on classes: class_alias is for alias commands which are not
53 abbreviations of the original command. class-pseudo is for commands
54 which are not really commands nor help topics ("stop"). */
58 /* Special args to help_list */
59 all_classes
= -2, all_commands
= -1,
60 /* Classes of commands */
61 no_class
= -1, class_run
= 0, class_vars
, class_stack
,
62 class_files
, class_support
, class_info
, class_breakpoint
,
63 class_alias
, class_obscure
, class_user
, class_maintenance
,
67 /* the cleanup list records things that have to be undone
68 if an error happens (descriptors to be closed, memory to be freed, etc.)
69 Each link in the chain records a function to call and an
72 Use make_cleanup to add an element to the cleanup chain.
73 Use do_cleanups to do all cleanup actions back to a given
74 point in the chain. Use discard_cleanups to remove cleanups
75 from the chain back to a given point, not doing them. */
80 void (*function
) PARAMS ((PTR
));
84 /* From blockframe.c */
87 inside_entry_func
PARAMS ((CORE_ADDR
));
90 inside_entry_file
PARAMS ((CORE_ADDR addr
));
93 inside_main_func
PARAMS ((CORE_ADDR pc
));
95 /* From cplus-dem.c */
98 cplus_demangle
PARAMS ((const char *, int));
101 cplus_mangle_opname
PARAMS ((char *, int));
103 /* From libmmalloc.a (memory mapped malloc library) */
106 mmalloc_attach
PARAMS ((int, PTR
));
109 mmalloc_detach
PARAMS ((PTR
));
112 mmalloc
PARAMS ((PTR
, long));
115 mrealloc
PARAMS ((PTR
, PTR
, long));
118 mfree
PARAMS ((PTR
, PTR
));
121 mmalloc_setkey
PARAMS ((PTR
, int, PTR
));
124 mmalloc_getkey
PARAMS ((PTR
, int));
129 demangle_and_match
PARAMS ((const char *, const char *, int));
132 strcmp_iw
PARAMS ((const char *, const char *));
135 safe_strerror
PARAMS ((int));
138 safe_strsignal
PARAMS ((int));
141 init_malloc
PARAMS ((PTR
));
144 request_quit
PARAMS ((int));
147 do_cleanups
PARAMS ((struct cleanup
*));
150 discard_cleanups
PARAMS ((struct cleanup
*));
152 /* The bare make_cleanup function is one of those rare beasts that
153 takes almost any type of function as the first arg and anything that
154 will fit in a "void *" as the second arg.
156 Should be, once all calls and called-functions are cleaned up:
157 extern struct cleanup *
158 make_cleanup PARAMS ((void (*function) (PTR), PTR));
160 Until then, lint and/or various type-checking compiler options will
161 complain about make_cleanup calls. It'd be wrong to just cast things,
162 since the type actually passed when the function is called would be
165 extern struct cleanup
*
168 extern struct cleanup
*
169 save_cleanups
PARAMS ((void));
172 restore_cleanups
PARAMS ((struct cleanup
*));
175 free_current_contents
PARAMS ((char **));
178 null_cleanup
PARAMS ((char **));
181 myread
PARAMS ((int, char *, int));
187 wrap_here
PARAMS ((char *));
190 reinitialize_more_filter
PARAMS ((void));
193 print_insn
PARAMS ((CORE_ADDR
, CORE_ADDR
, FILE *, int));
196 fputs_filtered
PARAMS ((const char *, FILE *));
199 puts_filtered
PARAMS ((char *));
202 vfprintf_filtered ();
208 fprintfi_filtered ();
217 print_spaces
PARAMS ((int, FILE *));
220 print_spaces_filtered
PARAMS ((int, FILE *));
223 n_spaces
PARAMS ((int));
226 printchar
PARAMS ((int, FILE *, int));
229 strdup_demangled
PARAMS ((const char *));
232 fprint_symbol
PARAMS ((FILE *, char *));
235 fputs_demangled
PARAMS ((char *, FILE *, int));
238 perror_with_name
PARAMS ((char *));
241 print_sys_errmsg
PARAMS ((char *, int));
246 re_comp
PARAMS ((char *));
251 symbol_file_command
PARAMS ((char *, int));
256 skip_quoted
PARAMS ((char *));
259 gdb_readline
PARAMS ((char *));
262 command_line_input
PARAMS ((char *, int));
265 print_prompt
PARAMS ((void));
268 batch_mode
PARAMS ((void));
271 input_from_terminal_p
PARAMS ((void));
274 catch_errors
PARAMS ((int (*) (char *), char *, char *));
276 /* From printcmd.c */
279 set_next_address
PARAMS ((CORE_ADDR
));
282 print_address_symbolic
PARAMS ((CORE_ADDR
, FILE *, int, char *));
285 print_address
PARAMS ((CORE_ADDR
, FILE *));
290 openp
PARAMS ((char *, int, char *, int, int, char **));
293 mod_path
PARAMS ((char *, char **));
296 directory_command
PARAMS ((char *, int));
299 init_source_path
PARAMS ((void));
304 read_relative_register_raw_bytes
PARAMS ((int, char *));
306 /* From readline (but not in any readline .h files). */
309 tilde_expand
PARAMS ((char *));
311 /* Structure for saved commands lines
312 (for breakpoints, defined commands, etc). */
316 struct command_line
*next
;
320 extern struct command_line
*
321 read_command_lines
PARAMS ((void));
324 free_command_lines
PARAMS ((struct command_line
**));
326 /* String containing the current directory (what getwd would return). */
328 extern char *current_directory
;
330 /* Default radixes for input and output. Only some values supported. */
331 extern unsigned input_radix
;
332 extern unsigned output_radix
;
334 /* Baud rate specified for communication with serial target systems. */
335 extern char *baud_rate
;
337 /* Languages represented in the symbol table and elsewhere. */
341 language_unknown
, /* Language not known */
342 language_auto
, /* Placeholder for automatic setting */
344 language_cplus
, /* C++ */
345 language_m2
/* Modula-2 */
348 /* Return a format string for printf that will print a number in the local
349 (language-specific) hexadecimal format. Result is static and is
350 overwritten by the next call. local_hex_format_custom takes printf
351 options like "08" or "l" (to produce e.g. %08x or %lx). */
353 #define local_hex_format() (current_language->la_hex_format)
356 local_hex_format_custom
PARAMS ((char *)); /* language.c */
358 /* Return a string that contains a number formatted in the local
359 (language-specific) hexadecimal format. Result is static and is
360 overwritten by the next call. local_hex_string_custom takes printf
361 options like "08" or "l". */
364 local_hex_string
PARAMS ((int)); /* language.c */
367 local_hex_string_custom
PARAMS ((int, char *)); /* language.c */
370 /* Host machine definition. This will be a symlink to one of the
371 xm-*.h files, built by the `configure' script. */
375 /* If the xm.h file did not define the mode string used to open the
376 files, assume that binary files are opened the same way as text
379 #include "fopen-same.h"
383 * Allow things in gdb to be declared "const". If compiling ANSI, it
384 * just works. If compiling with gcc but non-ansi, redefine to __const__.
385 * If non-ansi, non-gcc, then eliminate "const" entirely, making those
386 * objects be read-write rather than read-only.
392 # define const __const__
394 # define const /*nothing*/
402 # define volatile __volatile__
404 # define volatile /*nothing*/
407 #endif /* volatile */
409 /* Some compilers (many AT&T SVR4 compilers for instance), do not accept
410 declarations of functions that never return (exit for instance) as
411 "volatile void". For such compilers "NORETURN" can be defined away
412 to keep them happy */
416 # define NORETURN /*nothing*/
418 # define NORETURN volatile
422 /* Defaults for system-wide constants (if not defined by xm.h, we fake it). */
424 #if !defined (UINT_MAX)
425 #define UINT_MAX 0xffffffff
428 #if !defined (LONG_MAX)
429 #define LONG_MAX 0x7fffffff
432 #if !defined (INT_MAX)
433 #define INT_MAX 0x7fffffff
436 #if !defined (INT_MIN)
437 /* Two's complement, 32 bit. */
438 #define INT_MIN -0x80000000
441 /* Number of bits in a char or unsigned char for the target machine.
442 Just like CHAR_BIT in <limits.h> but describes the target machine. */
443 #if !defined (TARGET_CHAR_BIT)
444 #define TARGET_CHAR_BIT 8
447 /* Number of bits in a short or unsigned short for the target machine. */
448 #if !defined (TARGET_SHORT_BIT)
449 #define TARGET_SHORT_BIT (sizeof (short) * TARGET_CHAR_BIT)
452 /* Number of bits in an int or unsigned int for the target machine. */
453 #if !defined (TARGET_INT_BIT)
454 #define TARGET_INT_BIT (sizeof (int) * TARGET_CHAR_BIT)
457 /* Number of bits in a long or unsigned long for the target machine. */
458 #if !defined (TARGET_LONG_BIT)
459 #define TARGET_LONG_BIT (sizeof (long) * TARGET_CHAR_BIT)
462 /* Number of bits in a long long or unsigned long long for the target machine. */
463 #if !defined (TARGET_LONG_LONG_BIT)
464 #define TARGET_LONG_LONG_BIT (2 * TARGET_LONG_BIT)
467 /* Number of bits in a float for the target machine. */
468 #if !defined (TARGET_FLOAT_BIT)
469 #define TARGET_FLOAT_BIT (sizeof (float) * TARGET_CHAR_BIT)
472 /* Number of bits in a double for the target machine. */
473 #if !defined (TARGET_DOUBLE_BIT)
474 #define TARGET_DOUBLE_BIT (sizeof (double) * TARGET_CHAR_BIT)
477 /* Number of bits in a long double for the target machine. */
478 #if !defined (TARGET_LONG_DOUBLE_BIT)
479 #define TARGET_LONG_DOUBLE_BIT (2 * TARGET_DOUBLE_BIT)
482 /* Number of bits in a "complex" for the target machine. */
483 #if !defined (TARGET_COMPLEX_BIT)
484 #define TARGET_COMPLEX_BIT (2 * TARGET_FLOAT_BIT)
487 /* Number of bits in a "double complex" for the target machine. */
488 #if !defined (TARGET_DOUBLE_COMPLEX_BIT)
489 #define TARGET_DOUBLE_COMPLEX_BIT (2 * TARGET_DOUBLE_BIT)
492 /* Number of bits in a pointer for the target machine */
493 #if !defined (TARGET_PTR_BIT)
494 #define TARGET_PTR_BIT TARGET_INT_BIT
497 /* Convert a LONGEST to an int. This is used in contexts (e.g. number
498 of arguments to a function, number in a value history, register
499 number, etc.) where the value must not be larger than can fit
501 #if !defined (longest_to_int)
502 #if defined (LONG_LONG)
503 #define longest_to_int(x) (((x) > INT_MAX || (x) < INT_MIN) \
504 ? (error ("Value out of range."),0) : (int) (x))
505 #else /* No LONG_LONG. */
506 /* Assume sizeof (int) == sizeof (long). */
507 #define longest_to_int(x) ((int) (x))
508 #endif /* No LONG_LONG. */
509 #endif /* No longest_to_int. */
511 /* This should not be a typedef, because "unsigned LONGEST" needs
512 to work. LONG_LONG is defined if the host has "long long". */
516 # define LONGEST long long
518 # define LONGEST long
522 /* Assorted functions we can declare, now that const and volatile are
526 savestring
PARAMS ((const char *, int));
529 msavestring
PARAMS ((void *, const char *, int));
532 strsave
PARAMS ((const char *));
535 mstrsave
PARAMS ((void *, const char *));
538 concat
PARAMS ((char *, ...));
541 xmalloc
PARAMS ((long));
544 xrealloc
PARAMS ((PTR
, long));
547 xmmalloc
PARAMS ((PTR
, long));
550 xmrealloc
PARAMS ((PTR
, PTR
, long));
553 mmalloc
PARAMS ((PTR
, long));
556 mrealloc
PARAMS ((PTR
, PTR
, long));
559 mfree
PARAMS ((PTR
, PTR
));
562 mmcheck
PARAMS ((PTR
, void (*) (void)));
565 mmtrace
PARAMS ((void));
568 parse_escape
PARAMS ((char **));
570 extern const char * const reg_names
[];
572 extern NORETURN
void /* Does not return to the caller. */
575 extern NORETURN
void /* Does not return to the caller. */
578 extern NORETURN
void /* Not specified as volatile in ... */
579 exit
PARAMS ((int)); /* 4.10.4.3 */
581 extern NORETURN
void /* Does not return to the caller. */
582 nomem
PARAMS ((long));
584 extern NORETURN
void /* Does not return to the caller. */
585 return_to_top_level
PARAMS ((void));
588 warning_setup
PARAMS ((void));
593 /* Global functions from other, non-gdb GNU thingies (libiberty for
597 basename
PARAMS ((char *));
600 getenv
PARAMS ((const char *));
603 buildargv
PARAMS ((char *));
606 freeargv
PARAMS ((char **));
609 strerrno
PARAMS ((int));
612 strsigno
PARAMS ((int));
615 errno_max
PARAMS ((void));
618 signo_max
PARAMS ((void));
621 strtoerrno
PARAMS ((char *));
624 strtosigno
PARAMS ((char *));
627 strsignal
PARAMS ((int));
629 /* From other system libraries */
631 #ifndef PSIGNAL_IN_SIGNAL_H
633 psignal
PARAMS ((unsigned, char *));
636 /* For now, we can't include <stdlib.h> because it conflicts with
637 "../include/getopt.h". (FIXME)
639 However, if a function is defined in the ANSI C standard and a prototype
640 for that function is defined and visible in any header file in an ANSI
641 conforming environment, then that prototype must match the definition in
642 the ANSI standard. So we can just duplicate them here without conflict,
643 since they must be the same in all conforming ANSI environments. If
644 these cause problems, then the environment is not ANSI conformant. */
651 fclose
PARAMS ((FILE *stream
)); /* 4.9.5.1 */
654 perror
PARAMS ((const char *)); /* 4.9.10.4 */
657 atof
PARAMS ((const char *nptr
)); /* 4.10.1.1 */
660 atoi
PARAMS ((const char *)); /* 4.10.1.2 */
662 #ifndef MALLOC_INCOMPATIBLE
665 malloc
PARAMS ((size_t size
)); /* 4.10.3.3 */
668 realloc
PARAMS ((void *ptr
, size_t size
)); /* 4.10.3.4 */
671 free
PARAMS ((void *)); /* 4.10.3.2 */
673 #endif /* MALLOC_INCOMPATIBLE */
676 qsort
PARAMS ((void *base
, size_t nmemb
, /* 4.10.5.2 */
678 int (*comp
)(const void *, const void *)));
680 #ifndef MEM_FNS_DECLARED /* Some non-ANSI use void *, not char *. */
682 memcpy
PARAMS ((void *, const void *, size_t)); /* 4.11.2.1 */
686 memcmp
PARAMS ((const void *, const void *, size_t)); /* 4.11.4.1 */
689 strchr
PARAMS ((const char *, int)); /* 4.11.5.2 */
692 strrchr
PARAMS ((const char *, int)); /* 4.11.5.5 */
695 strstr
PARAMS ((const char *, const char *)); /* 4.11.5.7 */
698 strtok
PARAMS ((char *, const char *)); /* 4.11.5.8 */
700 #ifndef MEM_FNS_DECLARED /* Some non-ANSI use void *, not char *. */
702 memset
PARAMS ((void *, int, size_t)); /* 4.11.6.1 */
706 strerror
PARAMS ((int)); /* 4.11.6.2 */
708 /* Various possibilities for alloca. */
711 # define alloca __builtin_alloca
714 # include <alloca.h> /* NOTE: Doesn't declare alloca() */
717 extern void *alloca (size_t);
718 # else /* __STDC__ */
719 extern char *alloca ();
724 /* TARGET_BYTE_ORDER and HOST_BYTE_ORDER must be defined to one of these. */
726 #if !defined (BIG_ENDIAN)
727 #define BIG_ENDIAN 4321
730 #if !defined (LITTLE_ENDIAN)
731 #define LITTLE_ENDIAN 1234
734 /* Target-system-dependent parameters for GDB.
736 The standard thing is to include defs.h. However, files that are
737 specific to a particular target can define TM_FILE_OVERRIDE before
738 including defs.h, then can include any particular tm-file they desire. */
740 /* Target machine definition. This will be a symlink to one of the
741 tm-*.h files, built by the `configure' script. */
743 #ifndef TM_FILE_OVERRIDE
747 /* The bit byte-order has to do just with numbering of bits in
748 debugging symbols and such. Conceptually, it's quite separate
749 from byte/word byte order. */
751 #if !defined (BITS_BIG_ENDIAN)
752 #if TARGET_BYTE_ORDER == BIG_ENDIAN
753 #define BITS_BIG_ENDIAN 1
754 #endif /* Big endian. */
756 #if TARGET_BYTE_ORDER == LITTLE_ENDIAN
757 #define BITS_BIG_ENDIAN 0
758 #endif /* Little endian. */
759 #endif /* BITS_BIG_ENDIAN not defined. */
761 /* Swap LEN bytes at BUFFER between target and host byte-order. */
762 #if TARGET_BYTE_ORDER == HOST_BYTE_ORDER
763 #define SWAP_TARGET_AND_HOST(buffer,len)
764 #else /* Target and host byte order differ. */
765 #define SWAP_TARGET_AND_HOST(buffer,len) \
768 char *p = (char *)(buffer); \
769 char *q = ((char *)(buffer)) + len - 1; \
770 for (; p < q; p++, q--) \
777 #endif /* Target and host byte order differ. */
779 /* On some machines there are bits in addresses which are not really
780 part of the address, but are used by the kernel, the hardware, etc.
781 for special purposes. ADDR_BITS_REMOVE takes out any such bits
782 so we get a "real" address such as one would find in a symbol
783 table. ADDR_BITS_SET sets those bits the way the system wants
785 #if !defined (ADDR_BITS_REMOVE)
786 #define ADDR_BITS_REMOVE(addr) (addr)
787 #define ADDR_BITS_SET(addr) (addr)
788 #endif /* No ADDR_BITS_REMOVE. */
793 push_bytes
PARAMS ((CORE_ADDR
, char *, int));
795 /* In some modules, we don't have a definition of REGISTER_TYPE yet, so we
796 must avoid prototyping this function for now. FIXME. Should be:
798 push_word PARAMS ((CORE_ADDR, REGISTER_TYPE));
803 /* Some parts of gdb might be considered optional, in the sense that they
804 are not essential for being able to build a working, usable debugger
805 for a specific environment. For example, the maintenance commands
806 are there for the benefit of gdb maintainers. As another example,
807 some environments really don't need gdb's that are able to read N
808 different object file formats. In order to make it possible (but
809 not necessarily recommended) to build "stripped down" versions of
810 gdb, the following defines control selective compilation of those
811 parts of gdb which can be safely left out when necessary. Note that
812 the default is to include everything. */
814 #ifndef MAINTENANCE_CMDS
815 #define MAINTENANCE_CMDS 1
818 #endif /* !defined (DEFS_H) */